diff --git a/.gitattributes b/.gitattributes index 379a6bbdb..2a92ef017 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,8 @@ .github/workflows/*.lock.yml linguist-generated=true merge=ours +# Cross-platform tools rewrite these files, so keep their output deterministic. +java/**/*.java text eol=lf + # Generated files — keep LF line endings so codegen output is deterministic across platforms. nodejs/src/generated/* eol=lf linguist-generated=true dotnet/src/Generated/* eol=lf linguist-generated=true diff --git a/.githooks/pre-commit b/.githooks/pre-commit index 389bcda90..eb77167ce 100755 --- a/.githooks/pre-commit +++ b/.githooks/pre-commit @@ -1,14 +1,14 @@ #!/bin/sh # # Pre-commit hook that runs Spotless check on the Java SDK when Java source -# files are staged. Only triggers if changes exist under java/src/. +# files are staged. Only triggers if changes exist under java/sdk/src/. # # To install this hook, run from the repository root: # git config core.hooksPath .githooks # -# Only run Spotless if staged changes include Java source files under java/src/ -if ! git diff --cached --name-only | grep -q '^java/src/'; then +# Only run Spotless if staged changes include Java source files under java/sdk/src/ +if ! git diff --cached --name-only | grep -q '^java/sdk/src/'; then exit 0 fi diff --git a/.github/actions/java-test-report/action.yml b/.github/actions/java-test-report/action.yml index e826628a0..eedf05372 100644 --- a/.github/actions/java-test-report/action.yml +++ b/.github/actions/java-test-report/action.yml @@ -4,15 +4,15 @@ inputs: report-path: description: "Path to the test report XML files (glob pattern)" required: false - default: "java/target/{surefire-reports*,failsafe-reports}/TEST-*.xml" + default: "java/sdk/target/{surefire-reports*,failsafe-reports}/TEST-*.xml" jacoco-path: description: "Path to the JaCoCo XML report" required: false - default: "java/target/site/jacoco-coverage/jacoco.xml" + default: "java/sdk/target/site/jacoco-coverage/jacoco.xml" jacoco-csv-path: description: "Path to the JaCoCo CSV report" required: false - default: "java/target/site/jacoco-coverage/jacoco.csv" + default: "java/sdk/target/site/jacoco-coverage/jacoco.csv" check-name: description: "Name for the check run" required: false diff --git a/.github/actions/setup-copilot/action.yml b/.github/actions/setup-copilot/action.yml index 4b5ef0ef8..3769bc375 100644 --- a/.github/actions/setup-copilot/action.yml +++ b/.github/actions/setup-copilot/action.yml @@ -22,7 +22,16 @@ runs: shell: bash - name: Set CLI path id: cli-path - run: echo "path=$(pwd)/nodejs/node_modules/@github/copilot/index.js" >> $GITHUB_OUTPUT + run: | + # As of CLI 1.0.64-1 the @github/copilot package is a thin loader; the + # runnable index.js ships in the installed platform package + # (e.g. @github/copilot-linux-x64). Exactly one is installed. + cli_path=$(ls "$(pwd)"/nodejs/node_modules/@github/copilot-*/index.js 2>/dev/null | head -n1) + if [ -z "$cli_path" ]; then + echo "Could not find @github/copilot platform package (index.js) under nodejs/node_modules" >&2 + exit 1 + fi + echo "path=$cli_path" >> $GITHUB_OUTPUT shell: bash - name: Verify CLI works run: node ${{ steps.cli-path.outputs.path }} --version diff --git a/.github/agents/agentic-workflows.agent.md b/.github/agents/agentic-workflows.agent.md deleted file mode 100644 index 7ed300e00..000000000 --- a/.github/agents/agentic-workflows.agent.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing -disable-model-invocation: true ---- - -# GitHub Agentic Workflows Agent - -This agent helps you work with **GitHub Agentic Workflows (gh-aw)**, a CLI extension for creating AI-powered workflows in natural language using markdown files. - -## What This Agent Does - -This is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task: - -- **Creating new workflows**: Routes to `create` prompt -- **Updating existing workflows**: Routes to `update` prompt -- **Debugging workflows**: Routes to `debug` prompt -- **Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt -- **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 -- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt -- **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 -- **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 - -Workflows may optionally include: - -- **Project tracking / monitoring** (GitHub Projects updates, status reporting) -- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows) - -## Files This Applies To - -- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md` -- Workflow lock files: `.github/workflows/*.lock.yml` -- Shared components: `.github/workflows/shared/*.md` -- Configuration: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/github-agentic-workflows.md - -## Problems This Solves - -- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions -- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues -- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes -- **Component Design**: Create reusable shared workflow components that wrap MCP servers - -## How to Use - -When you interact with this agent, it will: - -1. **Understand your intent** - Determine what kind of task you're trying to accomplish -2. **Route to the right prompt** - Load the specialized prompt file for your task -3. **Execute the task** - Follow the detailed instructions in the loaded prompt - -## Available Prompts - -### Create New Workflow -**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/create-agentic-workflow.md - -**Use cases**: -- "Create a workflow that triages issues" -- "I need a workflow to label pull requests" -- "Design a weekly research automation" - -### Update Existing Workflow -**Load when**: User wants to modify, improve, or refactor an existing workflow - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/update-agentic-workflow.md - -**Use cases**: -- "Add web-fetch tool to the issue-classifier workflow" -- "Update the PR reviewer to use discussions instead of issues" -- "Improve the prompt for the weekly-research workflow" - -### Debug Workflow -**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/debug-agentic-workflow.md - -**Use cases**: -- "Why is this workflow failing?" -- "Analyze the logs for workflow X" -- "Investigate missing tool calls in run #12345" - -### Upgrade Agentic Workflows -**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/upgrade-agentic-workflows.md - -**Use cases**: -- "Upgrade all workflows to the latest version" -- "Fix deprecated fields in workflows" -- "Apply breaking changes from the new release" - -### Create a Report-Generating Workflow -**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 - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/report.md - -**Use cases**: -- "Create a weekly CI health report" -- "Post a daily security audit to Discussions" -- "Add a status update comment to open PRs" - -### Create Shared Agentic Workflow -**Load when**: User wants to create a reusable workflow component or wrap an MCP server - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/create-shared-agentic-workflow.md - -**Use cases**: -- "Create a shared component for Notion integration" -- "Wrap the Slack MCP server as a reusable component" -- "Design a shared workflow for database queries" - -### Fix Dependabot PRs -**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`) - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/dependabot.md - -**Use cases**: -- "Fix the open Dependabot PRs for npm dependencies" -- "Bundle and close the Dependabot PRs for workflow dependencies" -- "Update @playwright/test to fix the Dependabot PR" - -### Analyze Test Coverage -**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. - -**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/test-coverage.md - -**Use cases**: -- "Create a workflow that comments coverage on PRs" -- "Analyze coverage trends over time" -- "Add a coverage gate that blocks PRs below a threshold" - -## Instructions - -When a user interacts with you: - -1. **Identify the task type** from the user's request -2. **Load the appropriate prompt** from the GitHub repository URLs listed above -3. **Follow the loaded prompt's instructions** exactly -4. **If uncertain**, ask clarifying questions to determine the right prompt - -## Quick Reference - -```bash -# Initialize repository for agentic workflows -gh aw init - -# Generate the lock file for a workflow -gh aw compile [workflow-name] - -# Debug workflow runs -gh aw logs [workflow-name] -gh aw audit - -# Upgrade workflows -gh aw fix --write -gh aw compile --validate -``` - -## Key Features of gh-aw - -- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter -- **AI Engine Support**: Copilot, Claude, Codex, or custom engines -- **MCP Server Integration**: Connect to Model Context Protocol servers for tools -- **Safe Outputs**: Structured communication between AI and GitHub API -- **Strict Mode**: Security-first validation and sandboxing -- **Shared Components**: Reusable workflow building blocks -- **Repo Memory**: Persistent git-backed storage for agents -- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default - -## Important Notes - -- 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 -- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud -- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions -- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF -- Follow security best practices: minimal permissions, explicit network access, no template injection -- **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. -- **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. diff --git a/.github/agents/agentic-workflows.md b/.github/agents/agentic-workflows.md new file mode 100644 index 000000000..08c6d9a24 --- /dev/null +++ b/.github/agents/agentic-workflows.md @@ -0,0 +1,233 @@ +--- +name: Agentic Workflows +description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing. +disable-model-invocation: true +--- + +# GitHub Agentic Workflows Agent + +This agent helps you work with **GitHub Agentic Workflows (gh-aw)**, a CLI extension for creating AI-powered workflows in natural language using markdown files. + +## Repository Instructions Overlay + +If `.github/aw/instructions.md` exists, load it with: +@.github/aw/instructions.md + +Precedence: repository overlay instructions override defaults in this agent when they conflict. + +## What This Agent Does + +This is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task: + +- **Creating new workflows**: Routes to `create` prompt +- **Updating existing workflows**: Routes to `update` prompt +- **Debugging workflows**: Routes to `debug` prompt +- **Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt +- **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 +- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt +- **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 +- **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 +- **Rendering ASCII charts in markdown**: Routes to `asciicharts` guide — consult this whenever the workflow needs compact charts that render reliably in GitHub issues, comments, or discussions +- **CLI commands and triggering workflows**: Routes to `cli-commands` guide — consult this whenever the user asks how to run, compile, debug, or manage workflows from the command line, or when they need the MCP tool equivalent of a `gh aw` command +- **Reducing token consumption / cost optimization**: Routes to `token-optimization` guide — consult this whenever the user asks how to reduce token usage, lower costs, speed up workflows, or measure the impact of prompt changes with experiments +- **Choosing workflow architectures and design patterns**: Routes to `patterns` guide — consult this whenever the user asks for strategy, architecture, operating models, or pattern selection for agentic workflows + +Workflows may optionally include: + +- **Project tracking / monitoring** (GitHub Projects updates, status reporting) +- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows) + +## Files This Applies To + +- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md` +- Workflow lock files: `.github/workflows/*.lock.yml` +- Shared components: `.github/workflows/shared/*.md` +- Configuration: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md` + +## Problems This Solves + +- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions +- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues +- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes +- **Component Design**: Create reusable shared workflow components that wrap MCP servers + +## How to Use + +When you interact with this agent, it will: + +1. **Understand your intent** - Determine what kind of task you're trying to accomplish +2. **Route to the right prompt** - Load the specialized prompt file for your task +3. **Execute the task** - Follow the detailed instructions in the loaded prompt + +## Available Prompts + +> **Note**: The prompt and reference files listed below are located in the [`github/gh-aw`](https://github.com/github/gh-aw) repository and are **not available locally** in this repository. Load them from their public URLs. + +### Create New Workflow +**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/create-agentic-workflow.md` + +**Use cases**: +- "Create a workflow that triages issues" +- "I need a workflow to label pull requests" +- "Design a weekly research automation" + +### Update Existing Workflow +**Load when**: User wants to modify, improve, or refactor an existing workflow + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/update-agentic-workflow.md` + +**Use cases**: +- "Add web-fetch tool to the issue-classifier workflow" +- "Update the PR reviewer to use discussions instead of issues" +- "Improve the prompt for the weekly-research workflow" + +### Debug Workflow +**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/debug-agentic-workflow.md` + +**Use cases**: +- "Why is this workflow failing?" +- "Analyze the logs for workflow X" +- "Investigate missing tool calls in run #12345" + +### Upgrade Agentic Workflows +**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/upgrade-agentic-workflows.md` + +**Use cases**: +- "Upgrade all workflows to the latest version" +- "Fix deprecated fields in workflows" +- "Apply breaking changes from the new release" + +### Create a Report-Generating Workflow +**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 + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/report.md` + +**Use cases**: +- "Create a weekly CI health report" +- "Post a daily security audit to Discussions" +- "Add a status update comment to open PRs" + +### Create Shared Agentic Workflow +**Load when**: User wants to create a reusable workflow component or wrap an MCP server + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/create-shared-agentic-workflow.md` + +**Use cases**: +- "Create a shared component for Notion integration" +- "Wrap the Slack MCP server as a reusable component" +- "Design a shared workflow for database queries" + +### Fix Dependabot PRs +**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`) + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/dependabot.md` + +**Use cases**: +- "Fix the open Dependabot PRs for npm dependencies" +- "Bundle and close the Dependabot PRs for workflow dependencies" +- "Update @playwright/test to fix the Dependabot PR" + +### Analyze Test Coverage +**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. + +**Prompt file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/test-coverage.md` + +**Use cases**: +- "Create a workflow that comments coverage on PRs" +- "Analyze coverage trends over time" +- "Add a coverage gate that blocks PRs below a threshold" + +### CLI Commands Reference +**Load when**: The user asks how to run, compile, debug, or manage workflows from the command line; needs the MCP tool equivalent of a `gh aw` command; or is in a restricted environment (e.g., Copilot Cloud) without direct CLI access. + +**Reference file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/cli-commands.md` + +**Use cases**: +- "How do I trigger workflow X on the main branch?" +- "What's the MCP equivalent of `gh aw logs`?" +- "I'm in Copilot Cloud — how do I compile a workflow?" +- "Show me all available gh aw commands" + +### Token Consumption Optimization +**Load when**: The user asks how to reduce token usage, lower workflow costs, make a workflow faster or cheaper, or measure the impact of prompt or configuration changes. + +**Reference file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/token-optimization.md` + +**Use cases**: +- "How do I reduce the token cost of this workflow?" +- "My workflow is too expensive — how do I optimize it?" +- "How do I compare token usage between two runs?" +- "Should I use gh-proxy or the MCP server?" +- "How do I use sub-agents to reduce costs?" +- "How do I measure the impact of a prompt change?" + +### Workflow Pattern Selection +**Load when**: The user asks for architecture, strategy, operating model selection, or pattern recommendations for building agentic workflows. + +**Reference file**: `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/patterns.md` + +**Use cases**: +- "Which pattern should I use for multi-repo rollout?" +- "How should I structure this workflow architecture?" +- "What pattern fits slash-command triage?" +- "Should this be DispatchOps or DailyOps?" + +## Instructions + +When a user interacts with you: + +1. **Identify the task type** from the user's request +2. **Load the appropriate prompt** from the URLs listed above +3. **Follow the loaded prompt's instructions** exactly +4. **If uncertain**, ask clarifying questions to determine the right prompt + +## Quick Reference + +```bash +# Initialize repository for agentic workflows +gh aw init + +# Generate the lock file for a workflow +gh aw compile [workflow-name] + +# Trigger a workflow on demand (preferred over gh workflow run) +gh aw run # interactive input collection +gh aw run --ref main # run on a specific branch + +# Debug workflow runs +gh aw logs [workflow-name] +gh aw audit + +# Upgrade workflows +gh aw fix --write +gh aw compile --validate +``` + +## Key Features of gh-aw + +- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter +- **AI Engine Support**: Copilot, Claude, Codex, or custom engines +- **MCP Server Integration**: Connect to Model Context Protocol servers for tools +- **Safe Outputs**: Structured communication between AI and GitHub API +- **Strict Mode**: Security-first validation and sandboxing +- **Shared Components**: Reusable workflow building blocks +- **Repo Memory**: Persistent git-backed storage for agents +- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default + +## Important Notes + +- Always reference the instructions file at `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md` for complete documentation +- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud +- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions +- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF +- Follow security best practices: minimal permissions, explicit network access, no template injection +- **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://raw.githubusercontent.com/github/gh-aw/main/.github/aw/network.md` for the full list of valid ecosystem identifiers and domain patterns. +- **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. +- **Triggering runs**: Always use `gh aw run ` to trigger a workflow on demand — not `gh workflow run .lock.yml`. `gh aw run` handles workflow resolution by short name, input parsing and validation, and correct run-tracking for agentic workflows. Use `--ref ` to run on a specific branch. +- **CLI commands reference**: For a complete guide on all `gh aw` commands and their MCP tool equivalents (for restricted environments), see `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/cli-commands.md` diff --git a/.github/agents/docs-maintenance.agent.md b/.github/agents/docs-maintenance.agent.md index b1bf95ae8..bf7fa8518 100644 --- a/.github/agents/docs-maintenance.agent.md +++ b/.github/agents/docs-maintenance.agent.md @@ -377,7 +377,7 @@ cat go/types.go | grep -A 15 "type SessionHooks struct" ``` **Must match (PascalCase for exported):** -- `ClientOptions` fields: `CLIPath`, `CLIUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Env`, `GithubToken`, `UseLoggedInUser` +- `ClientOptions` fields: `CLIPath`, `CLIUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Env`, `GitHubToken`, `UseLoggedInUser` - `SessionConfig` fields: `Model`, `Tools`, `Hooks`, `SystemMessage`, `MCPServers`, `AvailableTools`, `ExcludedTools`, `Streaming`, `ReasoningEffort`, `Provider`, `InfiniteSessions`, `CustomAgents`, `WorkingDirectory` - `Session` methods: `Send()`, `SendAndWait()`, `GetMessages()`, `Disconnect()`, `Abort()`, `ExportSession()` - Hook fields: `OnPreToolUse`, `OnPostToolUse`, `OnPostToolUseFailure`, `OnUserPromptSubmitted`, `OnSessionStart`, `OnSessionEnd`, `OnErrorOccurred` @@ -395,7 +395,7 @@ cat dotnet/src/Types.cs | grep -A 15 "public class SessionHooks" ``` **Must match (PascalCase):** -- `CopilotClientOptions` properties: `CliPath`, `CliUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Environment`, `GithubToken`, `UseLoggedInUser` +- `CopilotClientOptions` properties: `CliPath`, `CliUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Environment`, `GitHubToken`, `UseLoggedInUser` - `SessionConfig` properties: `Model`, `Tools`, `Hooks`, `SystemMessage`, `McpServers`, `AvailableTools`, `ExcludedTools`, `Streaming`, `ReasoningEffort`, `Provider`, `InfiniteSessions`, `CustomAgents`, `WorkingDirectory` - `CopilotSession` methods: `SendAsync()`, `SendAndWaitAsync()`, `GetMessagesAsync()`, `DisposeAsync()`, `AbortAsync()`, `ExportSessionAsync()` - Hook properties: `OnPreToolUse`, `OnPostToolUse`, `OnPostToolUseFailure`, `OnUserPromptSubmitted`, `OnSessionStart`, `OnSessionEnd`, `OnErrorOccurred` diff --git a/.github/aw/actions-lock.json b/.github/aw/actions-lock.json index 64a9e8923..4be7dfbd5 100644 --- a/.github/aw/actions-lock.json +++ b/.github/aw/actions-lock.json @@ -1,39 +1,34 @@ { "entries": { - "actions/checkout@v6.0.2": { + "actions/checkout@v7": { "repo": "actions/checkout", - "version": "v6.0.2", - "sha": "de0fac2e4500dabe0009e67214ff5f5447ce83dd" + "version": "v7", + "sha": "9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0" }, - "actions/download-artifact@v8.0.0": { + "actions/download-artifact@v8.0.1": { "repo": "actions/download-artifact", - "version": "v8.0.0", - "sha": "70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3" + "version": "v8.0.1", + "sha": "3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c" }, - "actions/github-script@v8": { + "actions/github-script@v9": { "repo": "actions/github-script", - "version": "v8", - "sha": "ed597411d8f924073f98dfc5c65a23a2325f34cd" + "version": "v9", + "sha": "373c709c69115d41ff229c7e5df9f8788daa9553" }, - "actions/github-script@v9.0.0": { - "repo": "actions/github-script", - "version": "v9.0.0", - "sha": "3a2844b7e9c422d3c10d287c895573f7108da1b3" - }, - "actions/upload-artifact@v7.0.0": { + "actions/upload-artifact@v7.0.1": { "repo": "actions/upload-artifact", - "version": "v7.0.0", - "sha": "bbbca2ddaa5d8feaa63e36b76fdaad77386f024f" + "version": "v7.0.1", + "sha": "043fb46d1a93c77aae656e7c1c64a875d1fc6a0a" }, - "github/gh-aw-actions/setup@v0.74.4": { - "repo": "github/gh-aw-actions/setup", - "version": "v0.74.4", - "sha": "d3abfe96a194bce3a523ed2093ddedd5704cdf62" + "github/gh-aw-actions/setup-cli@v0.83.1": { + "repo": "github/gh-aw-actions/setup-cli", + "version": "v0.83.1", + "sha": "8bdba8075360648fe6802302a5b4e016361dc6ac" }, - "github/gh-aw/actions/setup@v0.52.1": { - "repo": "github/gh-aw/actions/setup", - "version": "v0.52.1", - "sha": "a86e657586e4ac5f549a790628971ec02f6a4a8f" + "github/gh-aw-actions/setup@v0.83.1": { + "repo": "github/gh-aw-actions/setup", + "version": "v0.83.1", + "sha": "8bdba8075360648fe6802302a5b4e016361dc6ac" } } } diff --git a/.github/badges/jacoco-generated.svg b/.github/badges/jacoco-generated.svg deleted file mode 100644 index efa97570f..000000000 --- a/.github/badges/jacoco-generated.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - coverage generated - coverage generated - 46.4% - 46.4% - - diff --git a/.github/badges/jacoco-handwritten.svg b/.github/badges/jacoco-handwritten.svg deleted file mode 100644 index ee070afa7..000000000 --- a/.github/badges/jacoco-handwritten.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - coverage handwritten - coverage handwritten - 79.9% - 79.9% - - diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index b946eb962..a9bc22d0e 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -11,10 +11,11 @@ - Top-level: `README.md` (architecture + quick start) - Language entry points: `nodejs/src/client.ts`, `python/README.md`, `go/README.md`, `dotnet/README.md` -- Java: `java/README.md`, `java/pom.xml` +- Java: `java/README.md`, `java/pom.xml`, `java/sdk/pom.xml`, `java/copilot-native/pom.xml` - Test harness & E2E: `test/harness/*`, Python harness wrapper `python/e2e/testharness/proxy.py` - Schemas & type generation: `nodejs/scripts/generate-session-types.ts` - Session snapshots used by E2E: `test/snapshots/` (used by the replay proxy) +- Docs style guide: `.github/instructions/docs-style.instructions.md` (used for `docs/**`) ## Developer workflows (commands you’ll use often) ▶️ @@ -23,7 +24,7 @@ - Format all: `just format` | Lint all: `just lint` | Test all: `just test` - Per-language: - Node: `cd nodejs && npm ci` → `npm test` (Vitest), `npm run generate:session-types` to regenerate session-event types - - Python: `cd python && uv pip install -e ".[dev]"` → `uv run pytest` (E2E tests use the test harness) + - Python: `cd python && uv pip install -e . --group dev` → `uv run pytest` (E2E tests use the test harness) - Go: `cd go && go test ./...` - .NET: `cd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj` - **.NET testing note:** Never add `InternalsVisibleTo` to any project file when writing tests. Tests must only access public APIs. @@ -38,7 +39,7 @@ - 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`). - Tests rely on YAML snapshot exchanges under `test/snapshots/` — to add test scenarios, add or edit the appropriate YAML files and update tests. - The harness prints `Listening: http://...` — tests parse this URL to configure CLI or proxy. -- Java E2E tests use `E2ETestContext` which manages a `CapiProxy` (Node.js replaying proxy). The harness is cloned during Maven's `generate-test-resources` phase to `java/target/copilot-sdk/`. +- Java E2E tests use `E2ETestContext` which manages a `CapiProxy` (Node.js replaying proxy). The harness is cloned during Maven's `generate-test-resources` phase to `java/sdk/target/copilot-sdk/`. - Java test method names are converted to lowercase snake_case for snapshot filenames (avoids case collisions on macOS/Windows). ## Project-specific conventions & patterns ✅ @@ -60,13 +61,13 @@ ## Where to add new code or tests 🧭 -- SDK code: `nodejs/src`, `python/copilot`, `go`, `dotnet/src`, `rust/src`, `java/src/main/java` -- Unit tests: `nodejs/test`, `python/*`, `go/*`, `dotnet/test`, `rust/tests`, `java/src/test/java` -- E2E tests: `*/e2e/` folders that use the shared replay proxy and `test/snapshots/`, `java/src/test/java/**/e2e/` -- 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. Java generated types: `java/src/generated/java` +- SDK code: `nodejs/src`, `python/copilot`, `go`, `dotnet/src`, `rust/src`, `java/sdk/src/main/java` +- Unit tests: `nodejs/test`, `python/*`, `go/*`, `dotnet/test`, `rust/tests`, `java/sdk/src/test/java` +- E2E tests: `*/e2e/` folders that use the shared replay proxy and `test/snapshots/`, `java/sdk/src/test/java/**/e2e/` +- 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. Java generated types: `java/sdk/src/generated/java` ## Boundaries — files you must NOT hand-edit ⛔ -- `java/src/generated/java/` — auto-generated by `scripts/codegen/java.ts`; regenerate with `cd java && mvn generate-sources -Pcodegen`. +- `java/sdk/src/generated/java/` — auto-generated by `scripts/codegen/java.ts`; regenerate with `cd java && mvn generate-sources -Pcodegen`. - `nodejs/src/generated/` — auto-generated by `npm run generate:session-types`. - `test/snapshots/` — authoritative test fixtures; add/edit YAML here to change E2E behavior, but don't delete without understanding downstream impact. diff --git a/.github/instructions/docs-style.instructions.md b/.github/instructions/docs-style.instructions.md new file mode 100644 index 000000000..16dbe2709 --- /dev/null +++ b/.github/instructions/docs-style.instructions.md @@ -0,0 +1,226 @@ +--- +applyTo: "docs/**" +--- + +# Copilot SDK docs style guide + +This style guide applies to all documentation in the `docs/` directory. These docs are synced to `github/docs-internal` via a normalization pipeline, so they must follow the conventions below to be compatible with docs.github.com. + +## Headings + +Use **sentence case** for all headings. Capitalize only the first word and proper nouns. + +* `## Quick start: Microsoft Foundry` — not `## Quick Start: Microsoft Foundry` +* `# Custom agents and sub-agent orchestration` — not `# Custom Agents & Sub-Agent Orchestration` + +Use `and` instead of `&` in headings. + +Do not use `**bold**` or `*italic*` markers inside headings. The heading level provides emphasis. + +### Proper nouns to always capitalize + +* Products/companies: GitHub, Copilot, Azure, OpenAI, Anthropic, Microsoft, Ollama, Slack, Foundry, Kubernetes, Docker +* Languages/frameworks: TypeScript, JavaScript, Python, Java, Node.js, OpenTelemetry, Express +* Platforms: macOS, Linux, Windows +* Protocols/formats: OAuth, JSON-RPC, JSON, YAML, HTTP, TCP, SSE, REST +* Acronyms: MCP, BYOK, MAF, SDK, CLI, API, HMAC, CI/CD, SaaS, ISV, FAQ, LLM, AI, EMU, ID, UI, PNG +* Tools (keep canonical casing): npm, npx, stdio +* Code identifiers in headings: SessionConfig, MessageOptions, TelemetryConfig, ProviderConfig, CopilotClient +* Multi-word proper names: GitHub App, GitHub Actions, GitHub OAuth, Foundry Local, Managed Identity, Container Instances + +## Callouts + +Use GitHub-flavored alert syntax: + +```markdown +> [!NOTE] +> This is a note. + +> [!TIP] +> This is a tip. + +> [!WARNING] +> This is a warning. +``` + +Never use `> **Note:**` or `> **Tip:**` style callouts. + +When a callout applies to a specific language, put the qualifier as bold text in the body: + +```markdown +> [!TIP] +> **(Python / Go)** These SDKs use separate, per-event data types. +``` + +## Lists + +### Unordered lists + +Use `*` (asterisks) for unordered list markers, not `-` (hyphens). + +### Ordered lists + +Use `1.` for every item in ordered lists, not sequential numbering. This makes reordering easier. + +```markdown +1. First step +1. Second step +1. Third step +``` + +### List item formatting + +* Capitalize the first letter of each list item. +* Use periods only if the item is a complete sentence. +* Introduce lists with a descriptive sentence, not vague phrases like "the following" in isolation. + +## Em dashes + +For list items with a **label and description**, use a colon: + +```markdown +* **Ephemeral**: not persisted to disk, not replayed on session resume +``` + +For em dashes used mid-sentence, use no spaces: + +```markdown +The SDK is a transport layer—it sends your prompt to the CLI over JSON-RPC. +``` + +## Horizontal rules + +Do not use `---` as a horizontal rule to visually separate sections in the body of an article. Use headings to separate sections instead. This does not apply to YAML frontmatter delimiters. + +## Index.md files + +In the docs pipeline, `index.md` files become YAML-only category pages. Rich content (prose, code samples, diagrams) must live in standalone files. + +If you are writing a new section with substantive content, create a named file (for example, `choosing-a-setup-path.md`) rather than putting the content in `index.md`. + +## Code snippets + +* Only modify code block contents when necessary. Keep all examples passing the SDK team's `docs-validate` workflow, rerun validation after changes, and use `docs-validate: skip` or `docs-validate: hidden` markers when appropriate. + +## Voice and tone + +* Use clear, simple language approachable for a wide range of readers. +* Use active voice whenever possible. +* Avoid idioms, slang, and region-specific phrases. +* Avoid ambiguous modal verbs ("may", "might", "should", "could") when an action is required. Use definitive verbs instead. +* Refer to people as "people" or "users", not "customers." + +## Emphasis + +* Use **bold** for UI elements and for emphasis, sparingly (no more than five contiguous words). +* Do not bold text that already has other formatting (for example, all-caps placeholders). + +## Word choice + +| Use | Avoid | +|---|---| +| terminal | shell | +| sign in | log in, login | +| sign up | signup | +| email | e-mail | +| press (a key) | hit, tap | +| repository | repo | +| administrator | admin | +| for example | e.g. | +| and similar | etc. | + +## What the pipeline handles + +Authors do not need to worry about these — the normalization pipeline handles them automatically: + +* YAML frontmatter (added to files for docs.github.com) +* Mermaid diagram → PNG conversion +* Link rewriting for docs.github.com cross-references +* Liquid variable substitution (product names) +* `[AUTOTITLE]` link conversion + +## New article template + +When creating a new docs article, use this structure: + +```markdown +# Article title in sentence case + +A one- or two-sentence intro explaining what the reader will learn or accomplish. + +## First section + +Body text here. + +## Second section + +Body text here. + +## Further reading + +* [Link text](./relative-path.md): short description +``` + +## Multi-language code examples + +When showing the same concept in multiple programming languages, use consecutive `
` blocks. The docs-internal normalization pipeline converts these into tabbed language switchers on docs.github.com. + +### Rules + +* **Only code inside `
` blocks.** Shared prose, headings, and explanations must go outside the blocks. Each block should contain only a code fence (and optionally a `` comment). +* **Blocks must be consecutive.** No content (headings, paragraphs) between `
` blocks in the same group. Blank lines between blocks are fine. +* **Use the exact `` format:** `LANGUAGE`. Supported labels: `.NET`, `Python`, `TypeScript`, `Go`, `Java`, `Rust`, `Node.js`, `Shell`. +* **Need 2+ blocks to form a group.** A single `
` block won't be converted and renders as raw HTML on docs.github.com. +* **Equal content across tabs.** Each tab should show the same concept in a different language. Language-specific extras should be a separate section outside the tabs. + +### Correct + +Shared prose goes above the group, then each `
` block contains only code: + +```markdown +Install the SDK: + +
+.NET + + + +```bash +dotnet add package GitHub.Copilot.SDK +``` + +
+
+Python + + + +```bash +pip install github-copilot-sdk +``` + +
+``` + +### Incorrect + +Do not put headings, prose, or multiple sections inside a `
` block: + +```markdown +
+Python + +### Prerequisites ← breaks TOC/anchors +Install the packages: ← prose belongs outside + +```bash +pip install github-copilot-sdk +``` + +### Basic usage ← multiple sections in one tab +```python +[code] +``` + +
+``` diff --git a/.github/instructions/dotnet-e2e.instructions.md b/.github/instructions/dotnet-e2e.instructions.md new file mode 100644 index 000000000..8dcf7d533 --- /dev/null +++ b/.github/instructions/dotnet-e2e.instructions.md @@ -0,0 +1,9 @@ +--- +applyTo: "dotnet/test/E2E/**/*.cs" +--- + +# .NET E2E test instructions + +- Create and resume sessions through `E2ETestContext` using `Ctx.CreateSessionAsync` and `Ctx.ResumeSessionAsync`. Do not call these methods directly on `CopilotClient`; the context applies the backend selected by the E2E matrix while preserving providers explicitly configured by the test. +- Create clients with `Ctx.CreateClient` so they receive the harness environment, CLI path, authentication defaults, transport handling, and lifecycle tracking. +- Instantiate `CopilotClient` directly only when client construction, startup, shutdown, or disposal is the behavior under test. Keep cleanup explicit in those tests, and still create any sessions through `Ctx` so they participate in backend coverage. diff --git a/.github/lsp.json b/.github/lsp.json index 753521284..e58456ac4 100644 --- a/.github/lsp.json +++ b/.github/lsp.json @@ -21,24 +21,6 @@ ".go": "go" }, "rootUri": "go" - }, - "rust-analyzer": { - "command": "rust-analyzer", - "fileExtensions": { - ".rs": "rust" - }, - "initializationOptions": { - "cargo": { - "buildScripts": { - "enable": true - }, - "allFeatures": true - }, - "checkOnSave": true, - "check": { - "command": "clippy" - } - } } } } diff --git a/.github/scripts/generate-java-coverage-badge.sh b/.github/scripts/generate-java-coverage-badge.sh deleted file mode 100755 index 3c68d830d..000000000 --- a/.github/scripts/generate-java-coverage-badge.sh +++ /dev/null @@ -1,104 +0,0 @@ -#!/usr/bin/env bash -# Generates SVG coverage badges from a JaCoCo CSV report. -# -# Usage: generate-coverage-badge.sh [jacoco.csv] [output-dir] -# jacoco.csv - Path to JaCoCo CSV report (default: target/site/jacoco-coverage/jacoco.csv) -# output-dir - Directory for the badge SVG (default: .github/badges) -set -euo pipefail - -CSV="${1:-target/site/jacoco-coverage/jacoco.csv}" -BADGES_DIR="${2:-.github/badges}" -GENERATED_PREFIX="com.github.copilot.generated" - -if [ ! -f "$CSV" ]; then - echo "⚠️ No JaCoCo CSV report found at $CSV" - exit 0 -fi - -calc_totals() { - local scope=$1 - awk -F',' -v scope="$scope" -v generated_prefix="$GENERATED_PREFIX" ' - NR > 1 { - is_generated = index($2, generated_prefix) == 1 - if (scope == "overall" || - (scope == "generated" && is_generated) || - (scope == "handwritten" && !is_generated)) { - missed += $4 - covered += $5 - } - } - END { print missed + 0, covered + 0 } - ' "$CSV" -} - -format_pct() { - local missed=$1 - local covered=$2 - local total=$((missed + covered)) - if [ "$total" -eq 0 ]; then - echo "0" - else - awk "BEGIN { printf \"%.1f\", ($covered / $total) * 100 }" | sed 's/\.0$//' - fi -} - -pick_color() { - local pct=$1 - local color="#e05d44" # red <60 - if awk "BEGIN{exit!($pct>=100)}"; then color="#4c1" # bright green - elif awk "BEGIN{exit!($pct>=90)}"; then color="#97ca00" # green - elif awk "BEGIN{exit!($pct>=80)}"; then color="#a4a61d" # yellow-green - elif awk "BEGIN{exit!($pct>=70)}"; then color="#dfb317" # yellow - elif awk "BEGIN{exit!($pct>=60)}"; then color="#fe7d37" # orange - fi - echo "$color" -} - -generate_badge() { - local label=$1 - local value=$2 - local output=$3 - local pct=${value%\%} - local color - color=$(pick_color "$pct") - local lw=$(( ${#label} * 7 + 12 )) - local vw=$(( ${#value} * 7 + 16 )) - local tw=$((lw + vw)) - - cat > "$output" < - - - - - - - - - - - - ${label} - ${label} - ${value} - ${value} - - -EOF -} - -mkdir -p "$BADGES_DIR" - -read -r handwritten_missed handwritten_covered <<< "$(calc_totals handwritten)" -read -r generated_missed generated_covered <<< "$(calc_totals generated)" - -handwritten_pct=$(format_pct "$handwritten_missed" "$handwritten_covered") -generated_pct=$(format_pct "$generated_missed" "$generated_covered") - -echo "Handwritten coverage: ${handwritten_pct}%" -echo "Generated coverage: ${generated_pct}%" - -generate_badge "coverage handwritten" "${handwritten_pct}%" "${BADGES_DIR}/jacoco-handwritten.svg" -generate_badge "coverage generated" "${generated_pct}%" "${BADGES_DIR}/jacoco-generated.svg" - -echo "Badges generated in ${BADGES_DIR}" diff --git a/.github/skills/agentic-workflows/SKILL.md b/.github/skills/agentic-workflows/SKILL.md new file mode 100644 index 000000000..acec3f146 --- /dev/null +++ b/.github/skills/agentic-workflows/SKILL.md @@ -0,0 +1,94 @@ +--- +name: agentic-workflows +description: Route gh-aw workflow design/create/debug/upgrade requests to the right prompts. +--- + +# Agentic Workflows Router + +Use this skill when a user asks to design, create, update, debug, or upgrade GitHub Agentic Workflows in this repository. + +This skill is a dispatcher: identify the task type, load the matching workflow prompt/skill file, and follow it directly. Keep responses concise and ask a clarifying question if the correct prompt is unclear. + +Repository overlay (optional): +- If `.github/aw/instructions.md` exists, load it with `@.github/aw/instructions.md` after loading the matched prompt/skill. +- Precedence: repository overlay instructions override upstream defaults when they conflict. + +Read only the files you need: +Load these files from `github/gh-aw` (they are not available locally). +- `.github/aw/agentic-chat.md` +- `.github/aw/agentic-workflows-mcp.md` +- `.github/aw/asciicharts.md` +- `.github/aw/campaign.md` +- `.github/aw/charts-trending.md` +- `.github/aw/charts.md` +- `.github/aw/cli-commands.md` +- `.github/aw/configure-agentic-engine.md` +- `.github/aw/context.md` +- `.github/aw/create-agentic-workflow-trigger-details.md` +- `.github/aw/create-agentic-workflow.md` +- `.github/aw/create-shared-agentic-workflow.md` +- `.github/aw/debug-agentic-workflow.md` +- `.github/aw/dependabot.md` +- `.github/aw/deployment-status.md` +- `.github/aw/designer.md` +- `.github/aw/evals.md` +- `.github/aw/experiments.md` +- `.github/aw/github-agentic-workflows.md` +- `.github/aw/github-mcp-server.md` +- `.github/aw/instructions.md` +- `.github/aw/llms.md` +- `.github/aw/loop.md` +- `.github/aw/lsp.md` +- `.github/aw/mcp-clis.md` +- `.github/aw/memory-stateful-patterns.md` +- `.github/aw/memory.md` +- `.github/aw/messages.md` +- `.github/aw/multi-agent-research.md` +- `.github/aw/network.md` +- `.github/aw/optimize-agentic-workflow.md` +- `.github/aw/patterns.md` +- `.github/aw/pr-reviewer.md` +- `.github/aw/report.md` +- `.github/aw/reuse.md` +- `.github/aw/safe-outputs-automation.md` +- `.github/aw/safe-outputs-content.md` +- `.github/aw/safe-outputs-management.md` +- `.github/aw/safe-outputs-runtime.md` +- `.github/aw/safe-outputs.md` +- `.github/aw/serena-tool.md` +- `.github/aw/shared-safe-jobs.md` +- `.github/aw/skills.md` +- `.github/aw/subagents.md` +- `.github/aw/syntax-agentic.md` +- `.github/aw/syntax-core.md` +- `.github/aw/syntax-tools-imports.md` +- `.github/aw/syntax.md` +- `.github/aw/test-coverage.md` +- `.github/aw/test-expression.md` +- `.github/aw/token-optimization.md` +- `.github/aw/triggers.md` +- `.github/aw/update-agentic-workflow.md` +- `.github/aw/upgrade-agentic-workflows.md` +- `.github/aw/visual-regression.md` +- `.github/aw/workflow-constraints.md` +- `.github/aw/workflow-editing.md` +- `.github/aw/workflow-patterns.md` + +After loading the matching workflow prompt or skill, follow it directly: +- Design workflows from scratch via interview: `.github/aw/designer.md` +- Create new workflows: `.github/aw/create-agentic-workflow.md` +- Configure or add declarative engines: `.github/aw/configure-agentic-engine.md` +- Update existing workflows: `.github/aw/update-agentic-workflow.md` +- Debug, audit, or investigate workflows: `.github/aw/debug-agentic-workflow.md` +- Upgrade workflows and fix deprecations: `.github/aw/upgrade-agentic-workflows.md` +- Create shared components or MCP wrappers: `.github/aw/create-shared-agentic-workflow.md` +- Create report-generating workflows: `.github/aw/report.md` +- Fix Dependabot manifest PRs: `.github/aw/dependabot.md` +- Analyze coverage workflows: `.github/aw/test-coverage.md` +- Render compact markdown charts: `.github/aw/asciicharts.md` +- Map CLI commands to MCP usage: `.github/aw/cli-commands.md` +- Choose workflow architecture and patterns: `.github/aw/patterns.md` +- Optimize token usage and cost: `.github/aw/token-optimization.md` +- Design long-running multi-agent research workflows: `.github/aw/multi-agent-research.md` + +When the task involves OTEL, OTLP, traces, observability backends, or telemetry-driven analysis, also read and follow `skills/otel-queries/SKILL.md` after loading the matching workflow prompt or skill. diff --git a/.github/skills/java-coding-skill/SKILL.md b/.github/skills/java-coding-skill/SKILL.md index e48ad00ed..c7d51ba6f 100644 --- a/.github/skills/java-coding-skill/SKILL.md +++ b/.github/skills/java-coding-skill/SKILL.md @@ -1,17 +1,17 @@ --- name: java-coding-skill -description: "Use this skill whenever editing `*.java` files in the `java/` SDK in order to write idiomatic, well-structured Java code for the Copilot SDK" +description: "Use this skill whenever editing `*.java` files in the `java/` directore of the SDK in order to write idiomatic, well-structured Java code for the Copilot SDK" --- # Java Coding Skill ## Core Principles -- The SDK is in public preview and may have breaking changes -- Requires Java 17 or later -- Requires GitHub Copilot CLI installed and in PATH -- Uses `CompletableFuture` for all async operations -- Implements `AutoCloseable` for resource cleanup (try-with-resources) +- Requires Java 25 or later for building the jar artifact for Copilot SDK for java. +- Uses the Multi-Relase jar feature JEP 238 https://openjdk.org/jeps/238 with `maven.compiler.release` 17 so that uses running JDK 17 can use the jar. +- Requires GitHub Copilot CLI installed and in PATH. +- Uses `CompletableFuture` for all async operations. +- Implements `AutoCloseable` for resource cleanup (try-with-resources). ## Installation @@ -655,6 +655,7 @@ try { 10. **Provide descriptive tool names and descriptions** for better model understanding 11. **Handle both delta and final events** when streaming is enabled 12. **Use `getArgumentsAs()`** for type-safe tool argument deserialization +13. **Run Spotless before committing:** CI will fail if `mvn spotless:check` fails. Before committing Java changes, run `cd java && mvn spotless:apply` and include the resulting changes in the commit. ## Common Patterns diff --git a/.github/skills/new-java-e2e-test-yaml-and-test/SKILL.md b/.github/skills/new-java-e2e-test-yaml-and-test/SKILL.md new file mode 100644 index 000000000..d034b2037 --- /dev/null +++ b/.github/skills/new-java-e2e-test-yaml-and-test/SKILL.md @@ -0,0 +1,222 @@ +--- +name: new-java-e2e-test-yaml-and-test +description: "Use this skill when creating a new Java E2E integration test (failsafe IT) that requires a new replay proxy YAML snapshot file in test/snapshots/" +--- + +# Creating a New Java E2E Test with a Replay Proxy YAML Snapshot + +This skill covers the complete workflow for adding a new Java failsafe +integration test backed by a handcrafted YAML snapshot for the replay proxy. + +## Overview + +The Java E2E tests use a **replay proxy** (`test/harness/replayingCapiProxy.ts`) +that intercepts HTTP calls to the Copilot API and returns pre-recorded responses +from YAML snapshot files. This avoids needing real authentication in CI. + +**Key constraint:** Java's `CapiProxy.java` always sets `GITHUB_ACTIONS=true` +(line 104), which forces the replay proxy into read-only mode. You **cannot** +record snapshots by running Java tests — you must handcraft the YAML. + +## Step-by-Step Workflow + +### Step 1: Choose a snapshot category and snapshot base name + +- Category = a directory under `test/snapshots/` (e.g., `system_message_sections`) +- Snapshot base name = the exact filename stem to use (already lowercase/underscore-separated), + e.g., `should_use_replaced_identity_section_in_response` +- Resulting file: `test/snapshots//.yaml` + +### Step 2: Create the YAML snapshot file + +The format is: + +```yaml +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: + - role: assistant + content: +``` + +**Rules:** +- `${system}` is a placeholder that matches ANY system message content +- `${workdir}` in tool arguments is substituted with the actual temp workDir +- Each conversation entry represents one request-response exchange +- For multi-turn, add multiple conversation entries +- For tool calls, include `tool_calls` on assistant messages and `role: tool` for results +- The user content must **exactly match** what your test sends (after normalization) + +### Step 3: Create the Java IT test class + +Place it in `java/sdk/src/test/java/com/github/copilot/` with an `IT` suffix +(e.g., `MyFeatureIT.java`). The failsafe plugin picks up `*IT.java` files. + +**Template:** + +```java +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; +// ... other imports as needed + +class MyFeatureIT { + + private static E2ETestContext ctx; + + @BeforeAll + static void setUp() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void tearDown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void myTestMethod() throws Exception { + // 1. Configure the proxy to use your snapshot + ctx.configureForTest("my_category", "my_test_method"); + + // 2. Create a client (uses fake token + proxy automatically) + try (CopilotClient client = ctx.createClient()) { + + // 3. Create a session with desired config + CopilotSession session = client.createSession(new SessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS); + + try { + // 4. Send the prompt (must match YAML exactly) + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Your prompt here"), 60_000) + .get(90, TimeUnit.SECONDS); + + // 5. Assert on the response + assertNotNull(response); + String content = response.getData().content(); + assertTrue(content.contains("expected text")); + } finally { + session.close(); + } + } + } +} +``` + +### Step 4: Verify + +```sh +cd java +mvn spotless:apply +mvn failsafe:integration-test -Dit.test="MyFeatureIT#myTestMethod" -Denforcer.skip=true +``` + +Then run the full build to confirm no regressions: + +```sh +mvn clean verify +``` + +## Key Classes and Files + +| What | Where | +|------|-------| +| Test context (manages proxy, workDir, CLI) | `java/sdk/src/test/java/com/github/copilot/E2ETestContext.java` | +| Java proxy wrapper | `java/sdk/src/test/java/com/github/copilot/CapiProxy.java` | +| Replay proxy (TypeScript) | `test/harness/replayingCapiProxy.ts` | +| Proxy server entry point | `test/harness/server.ts` | +| Snapshot files | `test/snapshots//.yaml` | +| Existing IT tests for reference | `java/sdk/src/test/java/com/github/copilot/*IT.java` | + +## How the Proxy Matches Requests + +1. The proxy normalizes the incoming request's messages +2. It compares against each conversation in the YAML: + - System message matches if YAML has `${system}` (wildcard) + - User messages are compared by content (exact text match) + - Tool results are compared after normalizing `${workdir}` paths +3. If a match is found, the proxy returns the **next assistant message after the matched request prefix** +4. If no match, in CI mode (`GITHUB_ACTIONS=true`) it errors with "No cached response found" + +## YAML Format for Tool Calls + +If your test involves tool use: + +```yaml +conversations: + # First exchange: model wants to call a tool + - messages: + - role: system + content: ${system} + - role: user + content: Read the file test.txt + - role: assistant + content: I'll read that file. + tool_calls: + - id: toolcall_0 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + # Second exchange: after tool result is provided, model gives final answer + - messages: + - role: system + content: ${system} + - role: user + content: Read the file test.txt + - role: assistant + content: I'll read that file. + tool_calls: + - id: toolcall_0 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + - role: tool + tool_call_id: toolcall_0 + content: "1. Hello world!" + - role: assistant + content: The file test.txt contains "Hello world!" +``` + +**Important:** When the model calls tools like `view`, the CLI actually executes +them locally. The file must exist in the test's workDir. Create it in your test +before sending the prompt: + +```java +Files.writeString(ctx.getWorkDir().resolve("test.txt"), "Hello world!\n"); +``` + +## Common Pitfalls + +1. **Prompt mismatch** — The user content in YAML must exactly match what + `session.sendAndWait(new MessageOptions().setPrompt("..."))` sends. +2. **Forgetting `${system}`** — Always use `${system}` for the system role content + unless testing a specific system message matching scenario. +3. **Tool execution** — If the snapshot has the model calling `view` or other + built-in tools, the CLI will actually execute those tools. Files must exist. +4. **Snapshot name parameter** — pass the explicit snapshot base name to + `configureForTest`, e.g., `configureForTest("category", "my_method_name")`. + Do not rely on camelCase-to-snake_case conversion. +5. **Cannot record via Java** — `CapiProxy.java` forces `GITHUB_ACTIONS=true`. + Always handcraft snapshots or use the Node.js proxy directly for recording. diff --git a/.github/skills/new-java-e2e-test-yaml-and-test/examples.md b/.github/skills/new-java-e2e-test-yaml-and-test/examples.md new file mode 100644 index 000000000..af82ef4db --- /dev/null +++ b/.github/skills/new-java-e2e-test-yaml-and-test/examples.md @@ -0,0 +1,177 @@ +# Examples: New Java E2E Test with YAML Snapshot + +## Example 1: Simple single-turn conversation (no tool calls) + +### Snapshot YAML + +File: `test/snapshots/system_message_sections/should_use_replaced_identity_section_in_response.yaml` + +```yaml +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Who are you? + - role: assistant + content: >- + I'm Botanica, your helpful gardening assistant! I'm here to help you + with all things related to plants and gardening. Whether you have + questions about plant care, garden design, soil preparation, pest + management, or anything else in the world of gardening, I'm happy to + help. What would you like to know about plants or gardening today? +``` + +### Corresponding Java test method + +```java +@Test +void shouldUseReplacedIdentitySectionInResponse() throws Exception { + ctx.configureForTest("system_message_sections", "should_use_replaced_identity_section_in_response"); + + var systemMessage = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE) + .setSections(Map.of(SystemMessageSections.IDENTITY, + new SectionOverride().setAction(SectionOverrideAction.REPLACE) + .setContent("You are a helpful gardening assistant called Botanica. " + + "You only answer questions about plants and gardening."))); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(new SessionConfig().setSystemMessage(systemMessage) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Who are you?"), 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("botanica") || content.contains("garden") || content.contains("plant"), + "Expected response to reflect the replaced identity section, but got: " + + response.getData().content()); + } finally { + session.close(); + } + } +} +``` + +**Key points:** +- `configureForTest("system_message_sections", "should_use_replaced_identity_section_in_response")` + maps to `test/snapshots/system_message_sections/should_use_replaced_identity_section_in_response.yaml` +- The prompt `"Who are you?"` exactly matches the YAML's user content +- `ctx.createClient()` uses `fake-token-for-e2e-tests` — works in CI + +--- + +## Example 2: Multi-turn with tool calls (from existing tests) + +### Snapshot YAML + +File: `test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml` + +```yaml +models: + - claude-sonnet-4.5 +conversations: + # First exchange: model decides to call tools + - messages: + - role: system + content: ${system} + - role: user + content: Read the contents of test.txt and tell me what it says + - role: assistant + content: I'll read the test.txt file for you. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Reading test.txt file"}' + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + # Second exchange: after tool results come back, model gives final answer + - messages: + - role: system + content: ${system} + - role: user + content: Read the contents of test.txt and tell me what it says + - role: assistant + content: I'll read the test.txt file for you. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Reading test.txt file"}' + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + - role: tool + tool_call_id: toolcall_0 + content: Intent logged + - role: tool + tool_call_id: toolcall_1 + content: 1. Hello transform! + - role: assistant + content: |- + The file test.txt contains: + ``` + Hello transform! + ``` +``` + +### Corresponding Java test method + +```java +@Test +void transformOnIdentitySectionReceivesNonEmptyContent() throws Exception { + ctx.configureForTest("system_message_transform", "should_invoke_transform_callbacks_with_section_content"); + + ConcurrentHashMap capturedContent = new ConcurrentHashMap<>(); + + var systemMessage = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE) + .setSections(Map.of(SystemMessageSections.IDENTITY, new SectionOverride().setTransform(content -> { + capturedContent.put("identity", content); + return CompletableFuture.completedFuture(content); + }), SystemMessageSections.TONE, new SectionOverride().setTransform(content -> { + capturedContent.put("tone", content); + return CompletableFuture.completedFuture(content); + }))); + + try (CopilotClient client = ctx.createClient()) { + // Create the file the snapshot expects the CLI view tool to read + Path testFile = ctx.getWorkDir().resolve("test.txt"); + Files.writeString(testFile, "Hello transform!"); + + CopilotSession session = client.createSession(new SessionConfig().setSystemMessage(systemMessage) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions() + .setPrompt("Read the contents of test.txt and tell me what it says"), 60_000) + .get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + + String identityContent = capturedContent.get("identity"); + assertNotNull(identityContent, "Expected identity transform callback to be invoked"); + assertTrue(!identityContent.isBlank(), "Expected identity section content to be non-empty"); + } finally { + session.close(); + } + } +} +``` + +**Key points:** +- The file `test.txt` must be created in `ctx.getWorkDir()` **before** sending the prompt +- The CLI's `view` tool will actually read that file; the YAML's tool result `"1. Hello transform!"` must match what `view` returns for that file content +- Two conversation entries: first for the tool-call decision, second for the final response after tool results diff --git a/.github/workflows/agentics-maintenance.yml b/.github/workflows/agentics-maintenance.yml new file mode 100644 index 000000000..28c4e67ca --- /dev/null +++ b/.github/workflows/agentics-maintenance.yml @@ -0,0 +1,633 @@ +# This file was automatically generated by pkg/workflow/maintenance_workflow.go (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ +# | _ |/ _` |/ _ \ '_ \| __| |/ __| +# | | | | (_| | __/ | | | |_| | (__ +# \_| |_/\__, |\___|_| |_|\__|_|\___| +# __/ | +# _ _ |___/ +# | | | | / _| | +# | | | | ___ _ __ _ __| |_| | _____ ____ +# | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| +# \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ +# \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ +# +# +# To regenerate this workflow, run: +# gh aw compile +# Not all edits will cause changes to this file. +# +# For more information: https://github.github.com/gh-aw/introduction/overview/ +# +# This file defines the generated agentic maintenance workflow for this repository. +# It runs scheduled cleanup for expiring safe outputs and supports manual maintenance operations. +# +# This workflow is generated automatically when workflows use expiring safe outputs +# or when repository maintenance features are enabled in .github/workflows/aw.json. +# +# To disable maintenance workflow generation, set in .github/workflows/aw.json: +# {"maintenance": false} +# +# Agentic maintenance docs: +# https://github.github.com/gh-aw/reference/ephemerals/#manual-maintenance-operations +# +name: Agentic Maintenance + +on: + schedule: + - cron: "37 0 * * *" # Daily (based on minimum expires: 30 days) + workflow_dispatch: + inputs: + operation: + description: 'Optional maintenance operation to run' + required: false + type: choice + default: '' + options: + - '' + - 'disable' + - 'enable' + - 'update' + - 'upgrade' + - 'safe_outputs' + - 'create_labels' + - 'activity_report' + - 'close_agentic_workflows_issues' + - 'clean_cache_memories' + - 'update_pull_request_branches' + - 'validate' + - 'forecast' + run_url: + description: 'Run URL or run ID to replay safe outputs from (e.g. https://github.com/owner/repo/actions/runs/12345 or 12345). Required when operation is safe_outputs.' + required: false + type: string + default: '' + workflow_call: + inputs: + operation: + description: 'Optional maintenance operation to run (disable, enable, update, upgrade, safe_outputs, create_labels, activity_report, close_agentic_workflows_issues, clean_cache_memories, update_pull_request_branches, validate, forecast)' + required: false + type: string + default: '' + run_url: + description: 'Run URL or run ID to replay safe outputs from (e.g. https://github.com/owner/repo/actions/runs/12345 or 12345). Required when operation is safe_outputs.' + required: false + type: string + default: '' + outputs: + operation_completed: + description: 'The maintenance operation that was completed (empty when none ran or a scheduled job ran)' + value: ${{ jobs.run_operation.outputs.operation || inputs.operation }} + applied_run_url: + description: 'The run URL that safe outputs were applied from' + value: ${{ jobs.apply_safe_outputs.outputs.run_url }} + +permissions: {} + +jobs: + close-expired-discussions: + if: ${{ (!(github.event.repository.fork)) && github.event_name != 'push' && (github.event_name != 'workflow_dispatch' && github.event_name != 'workflow_call' || inputs.operation == '') }} + runs-on: ubuntu-slim + permissions: + discussions: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Close expired discussions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/close_expired_discussions.cjs'); + await main(); + close-expired-issues: + if: ${{ (!(github.event.repository.fork)) && github.event_name != 'push' && (github.event_name != 'workflow_dispatch' && github.event_name != 'workflow_call' || inputs.operation == '') }} + runs-on: ubuntu-slim + permissions: + issues: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Close expired issues + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/close_expired_issues.cjs'); + await main(); + close-expired-pull-requests: + if: ${{ (!(github.event.repository.fork)) && github.event_name != 'push' && (github.event_name != 'workflow_dispatch' && github.event_name != 'workflow_call' || inputs.operation == '') }} + runs-on: ubuntu-slim + permissions: + pull-requests: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Close expired pull requests + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/close_expired_pull_requests.cjs'); + await main(); + + cleanup-cache-memory: + if: ${{ (!(github.event.repository.fork)) && github.event_name != 'push' && (github.event_name != 'workflow_dispatch' && github.event_name != 'workflow_call' || inputs.operation == '' || inputs.operation == 'clean_cache_memories') }} + runs-on: ubuntu-slim + permissions: + actions: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Cleanup outdated cache-memory entries + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/cleanup_cache_memory.cjs'); + await main(); + + run_operation: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation != '' && inputs.operation != 'safe_outputs' && inputs.operation != 'create_labels' && inputs.operation != 'activity_report' && inputs.operation != 'close_agentic_workflows_issues' && inputs.operation != 'clean_cache_memories' && inputs.operation != 'update_pull_request_branches' && inputs.operation != 'validate' && inputs.operation != 'forecast' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + permissions: + actions: write + contents: write + pull-requests: write + outputs: + operation: ${{ steps.record.outputs.operation }} + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Install gh-aw + uses: github/gh-aw-actions/setup-cli@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + version: v0.83.1 + + - name: Run operation + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_OPERATION: ${{ inputs.operation }} + GH_AW_CMD_PREFIX: gh aw + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/run_operation_update_upgrade.cjs'); + await main(); + + - name: Record outputs + id: record + env: + GH_AW_OPERATION: ${{ inputs.operation }} + run: echo "operation=$GH_AW_OPERATION" >> "$GITHUB_OUTPUT" + + update_pull_request_branches: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'update_pull_request_branches' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + permissions: + contents: write + pull-requests: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Update pull request branches + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/update_pull_request_branches.cjs'); + await main(); + + apply_safe_outputs: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'safe_outputs' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + permissions: + actions: read + contents: write + discussions: write + issues: write + pull-requests: write + outputs: + run_url: ${{ steps.record.outputs.run_url }} + steps: + - name: Checkout actions folder + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + sparse-checkout: | + actions + clean: false + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Apply Safe Outputs + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_RUN_URL: ${{ inputs.run_url }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/apply_safe_outputs_replay.cjs'); + await main(); + + - name: Record outputs + id: record + env: + GH_AW_RUN_URL: ${{ inputs.run_url }} + run: echo "run_url=$GH_AW_RUN_URL" >> "$GITHUB_OUTPUT" + + create_labels: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'create_labels' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + permissions: + contents: read + issues: write + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Install gh-aw + uses: github/gh-aw-actions/setup-cli@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + version: v0.83.1 + + - name: Create missing labels + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_CMD_PREFIX: gh aw + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/create_labels.cjs'); + await main(); + + activity_report: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'activity_report' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + timeout-minutes: 120 + permissions: + actions: read + contents: read + issues: write + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Install gh-aw + uses: github/gh-aw-actions/setup-cli@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + version: v0.83.1 + + - name: Restore activity report logs cache + id: activity_report_logs_cache + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ./.cache/gh-aw/activity-report-logs + key: ${{ runner.os }}-activity-report-logs-${{ github.repository }}-${{ github.ref_name }}-${{ github.run_id }} + restore-keys: | + ${{ runner.os }}-activity-report-logs-${{ github.repository }}- + ${{ runner.os }}-activity-report-logs- + - name: Download activity report logs + timeout-minutes: 20 + shell: bash + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_CMD_PREFIX: gh aw + run: | + ${GH_AW_CMD_PREFIX} logs \ + --repo "$GITHUB_REPOSITORY" \ + --start-date -1w \ + --count 500 \ + --output ./.cache/gh-aw/activity-report-logs \ + --format markdown \ + --report-file ./.cache/gh-aw/activity-report-logs/report.md + + - name: Save activity report logs cache + if: ${{ always() }} + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ./.cache/gh-aw/activity-report-logs + key: ${{ steps.activity_report_logs_cache.outputs.cache-primary-key }} + + - name: Generate activity report issue + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const fs = require('node:fs'); + const reportPath = './.cache/gh-aw/activity-report-logs/report.md'; + if (!fs.existsSync(reportPath)) { + core.warning('Activity report markdown not found at ' + reportPath + '; skipping issue creation.'); + return; + } + let reportBody = ''; + try { + reportBody = fs.readFileSync(reportPath, 'utf8').trim(); + } catch (error) { + core.warning('Failed to read activity report markdown at ' + reportPath + ': ' + error.message); + return; + } + if (!reportBody) { + core.warning('Activity report markdown is empty at ' + reportPath + '; skipping issue creation.'); + return; + } + const repoSlug = context.repo.owner + '/' + context.repo.repo; + const body = [ + '### Agentic workflow activity report', + '', + 'Repository: ' + repoSlug, + 'Generated at: ' + new Date().toISOString(), + '', + reportBody, + ].join('\n'); + const createdIssue = await github.rest.issues.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: '[aw] agentic status report', + body, + labels: ['agentic-workflows'], + }); + core.info('Created issue #' + createdIssue.data.number + ': ' + createdIssue.data.html_url); + + forecast_report: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'forecast' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + timeout-minutes: 60 + permissions: + actions: read + contents: read + issues: write + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Install gh-aw + uses: github/gh-aw-actions/setup-cli@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + version: v0.83.1 + + - name: Restore forecast report logs cache + id: forecast_report_logs_cache + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ./.github/aw/logs + key: ${{ runner.os }}-forecast-report-logs-${{ github.repository }}-${{ github.ref_name }}-${{ github.run_id }} + restore-keys: | + ${{ runner.os }}-forecast-report-logs-${{ github.repository }}- + ${{ runner.os }}-forecast-report-logs- + + - name: Generate forecast report + id: generate_forecast_report + timeout-minutes: 30 + shell: bash + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DEBUG: "*" + GH_AW_CMD_PREFIX: gh aw + run: | + mkdir -p ./.cache/gh-aw/forecast + set +e + ${GH_AW_CMD_PREFIX} forecast --repo "$GITHUB_REPOSITORY" --timeout 30 --verbose --json > ./.cache/gh-aw/forecast/report.json + forecast_exit_code=$? + set -e + if [ "${forecast_exit_code}" -eq 124 ]; then + echo '{"outcome":"timeout","message":"Forecast computation timed out after 30 minutes."}' > ./.cache/gh-aw/forecast/error.json + echo "::error::Forecast computation timed out after 30 minutes." + exit 1 + fi + if [ "${forecast_exit_code}" -ne 0 ]; then + echo '{"outcome":"error","message":"Forecast computation failed before producing a report."}' > ./.cache/gh-aw/forecast/error.json + echo "::error::Forecast computation failed with exit code ${forecast_exit_code}." + exit 1 + fi + + - name: Debug forecast logs folder + if: ${{ always() }} + shell: bash + run: | + if [ ! -d ./.github/aw/logs ]; then + echo "Logs directory not found: ./.github/aw/logs" + exit 0 + fi + echo "Files under ./.github/aw/logs:" + find ./.github/aw/logs -type f | sort + + - name: Save forecast report logs cache + if: ${{ always() }} + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: ./.github/aw/logs + key: ${{ runner.os }}-forecast-report-logs-${{ github.repository }}-${{ github.ref_name }}-${{ github.run_id }} + + - name: Generate forecast issue + if: ${{ always() }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + FORECAST_STEP_OUTCOME: ${{ steps.generate_forecast_report.outcome }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/create_forecast_issue.cjs'); + await main(); + + close_agentic_workflows_issues: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'close_agentic_workflows_issues' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-slim + permissions: + issues: write + steps: + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Close no-repro agentic-workflows issues + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/close_agentic_workflows_issues.cjs'); + await main(); + + validate_workflows: + if: ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.operation == 'validate' && (!(github.event.repository.fork)) }} + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + + - name: Setup Scripts + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + + - name: Check admin/maintainer permissions + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_team_member.cjs'); + await main(); + + - name: Install gh-aw + uses: github/gh-aw-actions/setup-cli@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + version: v0.83.1 + + - name: Validate workflows and file issue on findings + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_CMD_PREFIX: gh aw + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/run_validate_workflows.cjs'); + await main(); diff --git a/.github/workflows/block-remove-before-merge.yml b/.github/workflows/block-remove-before-merge.yml new file mode 100644 index 000000000..0b491ea81 --- /dev/null +++ b/.github/workflows/block-remove-before-merge.yml @@ -0,0 +1,32 @@ +name: "Block remove-before-merge paths" + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + merge_group: + +permissions: + pull-requests: read + +jobs: + check-paths: + name: "No remove-before-merge directories" + if: github.event_name == 'pull_request' && github.base_ref == 'main' + runs-on: ubuntu-latest + steps: + - name: Check for remove-before-merge paths in PR + env: + GH_TOKEN: ${{ github.token }} + PR_NUMBER: ${{ github.event.pull_request.number }} + REPO: ${{ github.repository }} + run: | + FILES=$(gh api repos/$REPO/pulls/$PR_NUMBER/files --paginate --jq '.[].filename') + BLOCKED=$(echo "$FILES" | grep -E '(^|/)[-a-zA-Z0-9_]+-remove-before-merge(/|$)' || true) + if [ -n "$BLOCKED" ]; then + echo "::error::This PR contains files under a 'remove-before-merge' directory. Remove them before merging." + echo "" + echo "Offending paths:" + echo "$BLOCKED" + exit 1 + fi + echo "No remove-before-merge paths found. ✅" diff --git a/.github/workflows/codegen-check.yml b/.github/workflows/codegen-check.yml index 78927f160..f37a71e45 100644 --- a/.github/workflows/codegen-check.yml +++ b/.github/workflows/codegen-check.yml @@ -15,7 +15,7 @@ on: - 'go/rpc/**' - 'rust/src/generated/**' - 'sdk-protocol-version.json' - - 'java/src/main/java/com/github/copilot/SdkProtocolVersion.java' + - 'java/sdk/src/main/java/com/github/copilot/SdkProtocolVersion.java' - '.github/workflows/codegen-check.yml' workflow_dispatch: @@ -84,7 +84,7 @@ jobs: - name: Verify Java protocol version matches run: | EXPECTED=$(jq -r '.version' sdk-protocol-version.json) - ACTUAL=$(grep -oP 'LATEST\(\K[0-9]+' java/src/main/java/com/github/copilot/SdkProtocolVersion.java) + ACTUAL=$(grep -oP 'LATEST\(\K[0-9]+' java/sdk/src/main/java/com/github/copilot/SdkProtocolVersion.java) if [ "$EXPECTED" != "$ACTUAL" ]; then echo "::error::Java SDK protocol version ($ACTUAL) does not match sdk-protocol-version.json ($EXPECTED). Java manages its own SdkProtocolVersion.java via java/scripts/codegen/. Update it to match." exit 1 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index dcb971f0d..e7d5bf4f3 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -23,15 +23,18 @@ jobs: matrix: ${{ steps.build-matrix.outputs.matrix }} skipped-matrix: ${{ steps.build-matrix.outputs.skipped-matrix }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 - - uses: dorny/paths-filter@v3 + - uses: dorny/paths-filter@6852f92c20ea7fd3b0c25de3b5112db3a98da050 # v3 id: filter if: github.event_name == 'pull_request' with: filters: | java: - 'java/**' + - '!java/docs/**' + - '!java/*.txt' + - '!java/*.md' js: - 'nodejs/**' - 'scripts/**' @@ -106,18 +109,19 @@ jobs: matrix: ${{ fromJson(needs.changes.outputs.matrix) }} steps: - name: Checkout repository - uses: actions/checkout@v4 + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 - name: Initialize CodeQL - uses: github/codeql-action/init@v3 + uses: github/codeql-action/init@a6fd1787519fd23e68309fad43738e41a6ff2a9d # v4 with: languages: ${{ matrix.language }} + queries: security-and-quality - name: Autobuild - uses: github/codeql-action/autobuild@v3 + uses: github/codeql-action/autobuild@a6fd1787519fd23e68309fad43738e41a6ff2a9d # v4 - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v3 + uses: github/codeql-action/analyze@a6fd1787519fd23e68309fad43738e41a6ff2a9d # v4 with: category: "/language:${{ matrix.language }}" @@ -149,7 +153,7 @@ jobs: EOF - name: Upload empty SARIF - uses: github/codeql-action/upload-sarif@v3 + uses: github/codeql-action/upload-sarif@a6fd1787519fd23e68309fad43738e41a6ff2a9d # v4 with: sarif_file: ${{ runner.temp }}/empty.sarif category: "/language:${{ matrix.language }}" diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 7b6d73867..d25689b3b 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -76,9 +76,9 @@ jobs: # Install gh-aw extension for advanced GitHub CLI features - name: Install gh-aw extension - uses: github/gh-aw/actions/setup-cli@0feed75a980b06f247abbbf80127f8eb2c19e2c5 # v0.74.8 + uses: github/gh-aw-actions/setup-cli@05205436a78512d71a2d842e46586ed05f4fa058 # v0.82.10 with: - version: v0.74.4 + version: v0.82.10 # Enable repository pre-commit hooks (Spotless checks for Java source changes) - name: Enable pre-commit hooks diff --git a/.github/workflows/cross-repo-issue-analysis.lock.yml b/.github/workflows/cross-repo-issue-analysis.lock.yml index a16753799..510618f04 100644 --- a/.github/workflows/cross-repo-issue-analysis.lock.yml +++ b/.github/workflows/cross-repo-issue-analysis.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"97b961391ad56ae223a93f2ff91267fed96ce49805bdd921de7549138893d637","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN","RUNTIME_TRIAGE_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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"16de319b1db6be0d409d3055ca8fa9f619f2c0120dad678248a45dce07b880b4","body_hash":"653dfb46c89df98eca22ddfb802149d6ade32e9a7ad40dbdc51bfb6b0ba1c4a3","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN","RUNTIME_TRIAGE_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -32,32 +33,35 @@ # - RUNTIME_TRIAGE_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "SDK Runtime Triage" on: issues: types: - - labeled + - labeled workflow_dispatch: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -81,14 +85,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: body: ${{ steps.sanitized.outputs.body }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -98,33 +108,35 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} trace-id: ${{ needs.pre_activation.outputs.setup-trace-id }} parent-span-id: ${{ needs.pre_activation.outputs.setup-parent-span-id || needs.pre_activation.outputs.setup-span-id }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -135,21 +147,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-crossrepoissueanalysis-${{ github.run_id }} + restore-keys: agentic-workflow-usage-crossrepoissueanalysis- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_ID: "cross-repo-issue-analysis" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -157,8 +215,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -176,7 +234,7 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -194,6 +252,9 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -208,24 +269,25 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} # poutine:ignore untrusted_checkout_exec run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_38cbf088966d11e6_EOF' + cat << 'GH_AW_PROMPT_41a978c1ce3777a8_EOF' - GH_AW_PROMPT_38cbf088966d11e6_EOF + GH_AW_PROMPT_41a978c1ce3777a8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_38cbf088966d11e6_EOF' + cat << 'GH_AW_PROMPT_41a978c1ce3777a8_EOF' Tools: create_issue, add_labels(max:3), missing_tool, missing_data, noop - GH_AW_PROMPT_38cbf088966d11e6_EOF + GH_AW_PROMPT_41a978c1ce3777a8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_38cbf088966d11e6_EOF' + cat << 'GH_AW_PROMPT_41a978c1ce3777a8_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -253,13 +315,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_38cbf088966d11e6_EOF + + GH_AW_PROMPT_41a978c1ce3777a8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_38cbf088966d11e6_EOF' + cat << 'GH_AW_PROMPT_41a978c1ce3777a8_EOF' {{#runtime-import .github/workflows/cross-repo-issue-analysis.md}} - GH_AW_PROMPT_38cbf088966d11e6_EOF + GH_AW_PROMPT_41a978c1ce3777a8_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -269,6 +331,7 @@ jobs: GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }} GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }} GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -289,15 +352,16 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED: ${{ needs.pre_activation.outputs.activated }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -312,6 +376,7 @@ jobs: GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY, GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID, GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE, + GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER, GH_AW_MCP_CLI_SERVERS_LIST: process.env.GH_AW_MCP_CLI_SERVERS_LIST, GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED: process.env.GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED } @@ -334,20 +399,24 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read env: @@ -356,26 +425,32 @@ jobs: GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: crossrepoissueanalysis outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -384,7 +459,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -395,7 +471,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -404,6 +480,11 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - env: GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} RUNTIME_TRIAGE_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} @@ -412,21 +493,14 @@ jobs: - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} @@ -438,14 +512,14 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless - name: Determine automatic lockdown mode for GitHub MCP Server id: determine-automatic-lockdown - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 env: GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} @@ -453,32 +527,31 @@ jobs: script: | const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_873b138e05029386_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_f9dc8569c195ba44_EOF' {"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] "},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"true"},"report_incomplete":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_873b138e05029386_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_f9dc8569c195ba44_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -500,10 +573,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -518,7 +588,8 @@ jobs: "required": true, "type": "string", "sanitize": true, - "maxLength": 65000 + "maxLength": 65000, + "minLength": 20 }, "fields": { "type": "array" @@ -628,62 +699,24 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -692,29 +725,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_fc7eecb5bcf8a5c8_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -726,16 +755,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -744,10 +792,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_fc7eecb5bcf8a5c8_EOF + GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -779,6 +828,7 @@ jobs: # --allow-tool shell(date) # --allow-tool shell(echo) # --allow-tool shell(find:*) + # --allow-tool shell(github:*) # --allow-tool shell(grep) # --allow-tool shell(grep:*) # --allow-tool shell(head) @@ -800,29 +850,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --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(printf)'\'' --allow-tool '\''shell(pwd)'\'' --allow-tool '\''shell(safeoutputs:*)'\'' --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-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --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(github:*)'\'' --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(printf)'\'' --allow-tool '\''shell(pwd)'\'' --allow-tool '\''shell(safeoutputs:*)'\'' --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-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -836,25 +908,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -878,10 +945,10 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,RUNTIME_TRIAGE_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN,RUNTIME_TRIAGE_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} SECRET_RUNTIME_TRIAGE_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} - name: Append agent step summary if: always() @@ -914,6 +981,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -935,16 +1003,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -1005,7 +1064,8 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read @@ -1015,6 +1075,8 @@ jobs: group: "gh-aw-conclusion-cross-repo-issue-analysis" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1023,7 +1085,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1032,7 +1094,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1048,6 +1111,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-crossrepoissueanalysis-${{ github.run_id }} + restore-keys: agentic-workflow-usage-crossrepoissueanalysis- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-crossrepoissueanalysis-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1055,9 +1210,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "cross-repo-issue-analysis" with: github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} script: | @@ -1071,6 +1231,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1088,6 +1249,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" with: github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} script: | @@ -1102,6 +1264,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" with: github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} script: | @@ -1116,28 +1279,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "cross-repo-issue-analysis" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "20" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }} script: | @@ -1150,19 +1321,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1171,7 +1345,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1189,7 +1364,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1198,7 +1373,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1217,13 +1392,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1252,16 +1431,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1271,27 +1450,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1304,7 +1507,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1348,6 +1566,8 @@ jobs: pre_activation: if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'runtime triage' runs-on: ubuntu-slim + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: activated: ${{ steps.check_membership.outputs.is_team_member == 'true' }} matched_command: '' @@ -1357,14 +1577,15 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Check team membership for workflow id: check_membership @@ -1390,17 +1611,23 @@ jobs: contents: read issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/cross-repo-issue-analysis" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "cross-repo-issue-analysis" GH_AW_WORKFLOW_NAME: "SDK Runtime Triage" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/cross-repo-issue-analysis.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1413,7 +1640,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1422,7 +1649,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Runtime Triage" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/cross-repo-issue-analysis.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1441,7 +1669,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1452,6 +1680,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1472,4 +1701,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/cross-repo-issue-analysis.md b/.github/workflows/cross-repo-issue-analysis.md index 171994988..58e07156b 100644 --- a/.github/workflows/cross-repo-issue-analysis.md +++ b/.github/workflows/cross-repo-issue-analysis.md @@ -14,6 +14,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write steps: - name: Clone copilot-agent-runtime env: diff --git a/.github/workflows/docs-validation.yml b/.github/workflows/docs-validation.yml index 4f53b71e4..dff02f0d2 100644 --- a/.github/workflows/docs-validation.yml +++ b/.github/workflows/docs-validation.yml @@ -9,8 +9,9 @@ on: - 'python/copilot/**' - 'go/**/*.go' - 'dotnet/src/**' - - 'java/src/**' + - 'java/sdk/src/**' - 'java/pom.xml' + - 'java/sdk/pom.xml' - 'scripts/docs-validation/**' - '.github/workflows/docs-validation.yml' workflow_dispatch: diff --git a/.github/workflows/dotnet-sdk-tests.yml b/.github/workflows/dotnet-sdk-tests.yml index d3b2ef162..fa2e2dc75 100644 --- a/.github/workflows/dotnet-sdk-tests.yml +++ b/.github/workflows/dotnet-sdk-tests.yml @@ -4,38 +4,62 @@ on: push: branches: - main - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - 'dotnet/**' - - 'test/**' - - 'nodejs/package.json' - - '.github/workflows/dotnet-sdk-tests.yml' - - '!**/*.md' - - '!**/LICENSE*' - - '!**/.gitignore' - - '!**/.editorconfig' - - '!**/*.png' - - '!**/*.jpg' - - '!**/*.jpeg' - - '!**/*.gif' - - '!**/*.svg' workflow_dispatch: - merge_group: + workflow_call: permissions: contents: read jobs: test: - name: ".NET SDK Tests" + name: ".NET SDK Tests (${{ matrix.os }}, ${{ matrix.transport }}, ${{ matrix.backend }}, ${{ matrix.shard }})" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off + COPILOT_SDK_E2E_BACKEND: ${{ matrix.backend }} + DOTNET_TEST_FILTER: ${{ matrix.test-filter }} strategy: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] + transport: ["default", "inprocess"] + backend: [capi] + shard: [full] + # TODO: Re-enable after fixing in-process sqlite file locking on shutdown on Windows. + exclude: + - os: windows-latest + transport: "inprocess" + - os: windows-latest + transport: default + shard: full + include: + # Keep xUnit serial within each process, but split the slow Windows + # default-transport suite across two isolated test hosts. Keep both + # target frameworks in each shard: separate framework jobs did not + # shorten the critical path and doubled the Windows job count. + - os: windows-latest + transport: default + backend: capi + shard: "1" + - os: windows-latest + transport: default + backend: capi + shard: "2" + - os: ubuntu-latest + transport: inprocess + backend: anthropic-messages + shard: full + test-filter: "FullyQualifiedName~GitHub.Copilot.Test.E2E&E2EBackend!=SelfConfiguredBackend&E2EBackend!=CapiOnly" + - os: ubuntu-latest + transport: inprocess + backend: openai-responses + shard: full + test-filter: "FullyQualifiedName~GitHub.Copilot.Test.E2E&E2EBackend!=SelfConfiguredBackend&E2EBackend!=CapiOnly" + - os: ubuntu-latest + transport: inprocess + backend: openai-completions + shard: full + test-filter: "FullyQualifiedName~GitHub.Copilot.Test.E2E&E2EBackend!=SelfConfiguredBackend&E2EBackend!=CapiOnly" runs-on: ${{ matrix.os }} defaults: run: @@ -80,7 +104,37 @@ jobs: if: runner.os == 'Windows' run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + - name: Select inprocess transport + if: matrix.transport == 'inprocess' + run: echo "COPILOT_SDK_DEFAULT_CONNECTION=inprocess" >> "$GITHUB_ENV" + - name: Run .NET SDK tests env: COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} - run: dotnet test --no-build -v n + DOTNET_TEST_SHARD: ${{ matrix.shard }} + run: | + args=(--no-build -v n) + + filter="$DOTNET_TEST_FILTER" + if [[ "$DOTNET_TEST_SHARD" != "full" ]]; then + if [[ "$DOTNET_TEST_SHARD" == "1" ]]; then + initials=(A C D H I J K L N Q S U W Y) + shard_filter="FullyQualifiedName~GitHub.Copilot.Test.ConnectionToken" + else + initials=(B E F G M O P R T V X Z) + shard_filter="" + fi + + for namespace in E2E Unit; do + for initial in "${initials[@]}"; do + clause="FullyQualifiedName~GitHub.Copilot.Test.${namespace}.${initial}" + shard_filter="${shard_filter:+${shard_filter}|}${clause}" + done + done + filter="${filter:+(${filter})&}(${shard_filter})" + fi + + if [[ -n "$filter" ]]; then + args+=(--filter "$filter") + fi + dotnet test "${args[@]}" diff --git a/.github/workflows/go-sdk-tests.yml b/.github/workflows/go-sdk-tests.yml index e26296109..61d74d257 100644 --- a/.github/workflows/go-sdk-tests.yml +++ b/.github/workflows/go-sdk-tests.yml @@ -4,32 +4,15 @@ on: push: branches: - main - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - 'go/**' - - 'test/**' - - 'nodejs/package.json' - - '.github/workflows/go-sdk-tests.yml' - - '.github/actions/setup-copilot/**' - - '!**/*.md' - - '!**/LICENSE*' - - '!**/.gitignore' - - '!**/.editorconfig' - - '!**/*.png' - - '!**/*.jpg' - - '!**/*.jpeg' - - '!**/*.gif' - - '!**/*.svg' workflow_dispatch: - merge_group: + workflow_call: permissions: contents: read jobs: test: - name: "Go SDK Tests" + name: "Go SDK Tests (${{ matrix.os }}, ${{ matrix.transport }})" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off @@ -37,6 +20,7 @@ jobs: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] + transport: ["default", "inprocess"] runs-on: ${{ matrix.os }} defaults: run: @@ -78,6 +62,12 @@ jobs: if: runner.os == 'Windows' run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + - name: Select inprocess transport + if: matrix.transport == 'inprocess' + run: | + echo "COPILOT_SDK_DEFAULT_CONNECTION=inprocess" >> "$GITHUB_ENV" + echo "GOFLAGS=-tags=copilot_inprocess" >> "$GITHUB_ENV" + - name: Run Go SDK tests env: COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} diff --git a/.github/workflows/handle-bug.lock.yml b/.github/workflows/handle-bug.lock.yml index 038b965d6..153e882c4 100644 --- a/.github/workflows/handle-bug.lock.yml +++ b/.github/workflows/handle-bug.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"a473a22cd67feb7f8f5225639fd989cf71705f78c9fe11c3fc757168e1672b0e","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"df4e7ec5b346a28c7de5353cbfb15d329d03eb7092f2ded784ee6602108461e6","body_hash":"376c982b907760113954510ef1aff70d22dcb172c7bb851b2fa3d82121bdbc1c","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,20 +32,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Bug Handler" on: @@ -52,7 +57,7 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -79,7 +84,7 @@ on: permissions: {} concurrency: - group: "gh-aw-${{ github.workflow }}" + group: "gh-aw-handle-bug-${{ github.run_id }}" run-name: "Bug Handler" @@ -89,14 +94,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -108,14 +119,16 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Bug Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-bug.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Resolve host repo for activation checkout @@ -142,17 +155,17 @@ jobs: env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Bug Handler" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -164,11 +177,57 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlebug-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handlebug- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_ID: "handle-bug" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Print cross-repo setup guidance if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository run: | @@ -177,7 +236,7 @@ jobs: echo "::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup" - name: Checkout .github and .agents folders if: steps.resolve-host-repo.outputs.target_repo == github.repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false repository: ${{ steps.resolve-host-repo.outputs.target_repo }} @@ -185,9 +244,9 @@ jobs: sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -195,8 +254,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -214,13 +273,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -238,20 +300,20 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF' + cat << 'GH_AW_PROMPT_04d69bd6df5739b0_EOF' - GH_AW_PROMPT_3df18ed0421fc8c1_EOF + GH_AW_PROMPT_04d69bd6df5739b0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF' + cat << 'GH_AW_PROMPT_04d69bd6df5739b0_EOF' Tools: add_comment, add_labels, missing_tool, missing_data, noop - GH_AW_PROMPT_3df18ed0421fc8c1_EOF + GH_AW_PROMPT_04d69bd6df5739b0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF' + cat << 'GH_AW_PROMPT_04d69bd6df5739b0_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -279,13 +341,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_3df18ed0421fc8c1_EOF + + GH_AW_PROMPT_04d69bd6df5739b0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF' + cat << 'GH_AW_PROMPT_04d69bd6df5739b0_EOF' {{#runtime-import .github/workflows/handle-bug.md}} - GH_AW_PROMPT_3df18ed0421fc8c1_EOF + GH_AW_PROMPT_04d69bd6df5739b0_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -312,14 +374,14 @@ jobs: GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -354,51 +416,62 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read concurrency: - group: "gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}" + group: "gh-aw-copilot-handle-bug-${{ inputs.issue_number }}" + queue: max env: DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} GH_AW_ASSETS_ALLOWED_EXTS: "" GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: handlebug outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -407,7 +480,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Bug Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-bug.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Set runtime paths @@ -419,7 +493,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -428,23 +502,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -456,11 +528,22 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + GH_AW_GITHUB_MIN_INTEGRITY: 'none' + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); - name: Parse integrity filter lists id: parse-guard-vars env: @@ -468,32 +551,31 @@ jobs: GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }} GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }} run: bash "${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh" - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: ${{ needs.activation.outputs.artifact_prefix }}activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_788bfbc2e8cbcb67_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_18a2d1564ec59c01_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_788bfbc2e8cbcb67_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_18a2d1564ec59c01_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -537,10 +619,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -629,60 +708,22 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -691,29 +732,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_5cf2254bdcfe4a71_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -728,16 +765,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -746,10 +802,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_5cf2254bdcfe4a71_EOF + GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -778,29 +835,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -814,25 +893,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -856,8 +930,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -891,6 +964,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -912,16 +986,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -984,17 +1049,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-handle-bug-${{ inputs.issue_number }}" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1003,7 +1070,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1012,7 +1079,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Bug Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-bug.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1029,6 +1097,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlebug-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handlebug- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlebug-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1036,9 +1196,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "handle-bug" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1052,6 +1217,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1069,6 +1235,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1083,6 +1250,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1097,28 +1265,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "handle-bug" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "20" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1131,19 +1307,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1152,7 +1331,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Bug Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-bug.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1171,7 +1351,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1180,7 +1360,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1199,13 +1379,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1234,16 +1418,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1253,27 +1437,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1286,7 +1494,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1336,20 +1559,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/handle-bug" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "handle-bug" GH_AW_WORKFLOW_NAME: "Bug Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-bug.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1362,7 +1590,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1371,7 +1599,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Bug Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-bug.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1391,7 +1620,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1402,6 +1631,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1422,4 +1652,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/handle-bug.md b/.github/workflows/handle-bug.md index 7edb33a4f..8d426ce5d 100644 --- a/.github/workflows/handle-bug.md +++ b/.github/workflows/handle-bug.md @@ -16,6 +16,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] diff --git a/.github/workflows/handle-documentation.lock.yml b/.github/workflows/handle-documentation.lock.yml index 3d8c9e05e..0a5e68efe 100644 --- a/.github/workflows/handle-documentation.lock.yml +++ b/.github/workflows/handle-documentation.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"258058e9a5e3bb707bbcfc9157b7b69f64c06547642da2526a1ff441e3a358dd","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"6c3b9dc8d0f7b54d44175db209cda34e37ea8c635d01ee0a5cba13675053f6cd","body_hash":"81c8287f5691cdc10ae8f60c004bb671d9b4942740d73fcc9646e28fbcd8790e","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,20 +32,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Documentation Handler" on: @@ -52,7 +57,7 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -79,7 +84,7 @@ on: permissions: {} concurrency: - group: "gh-aw-${{ github.workflow }}" + group: "gh-aw-handle-documentation-${{ github.run_id }}" run-name: "Documentation Handler" @@ -89,14 +94,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -108,14 +119,16 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Documentation Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-documentation.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Resolve host repo for activation checkout @@ -142,17 +155,17 @@ jobs: env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Documentation Handler" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -164,11 +177,57 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handledocumentation-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handledocumentation- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_ID: "handle-documentation" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Print cross-repo setup guidance if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository run: | @@ -177,7 +236,7 @@ jobs: echo "::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup" - name: Checkout .github and .agents folders if: steps.resolve-host-repo.outputs.target_repo == github.repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false repository: ${{ steps.resolve-host-repo.outputs.target_repo }} @@ -185,9 +244,9 @@ jobs: sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -195,8 +254,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -214,13 +273,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -238,20 +300,20 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF' + cat << 'GH_AW_PROMPT_b3d8e6ce75517df8_EOF' - GH_AW_PROMPT_c1995fcb77e4eb7d_EOF + GH_AW_PROMPT_b3d8e6ce75517df8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF' + cat << 'GH_AW_PROMPT_b3d8e6ce75517df8_EOF' Tools: add_comment, add_labels, missing_tool, missing_data, noop - GH_AW_PROMPT_c1995fcb77e4eb7d_EOF + GH_AW_PROMPT_b3d8e6ce75517df8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF' + cat << 'GH_AW_PROMPT_b3d8e6ce75517df8_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -279,13 +341,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_c1995fcb77e4eb7d_EOF + + GH_AW_PROMPT_b3d8e6ce75517df8_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF' + cat << 'GH_AW_PROMPT_b3d8e6ce75517df8_EOF' {{#runtime-import .github/workflows/handle-documentation.md}} - GH_AW_PROMPT_c1995fcb77e4eb7d_EOF + GH_AW_PROMPT_b3d8e6ce75517df8_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -312,14 +374,14 @@ jobs: GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -354,51 +416,62 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read concurrency: - group: "gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}" + group: "gh-aw-copilot-handle-documentation-${{ inputs.issue_number }}" + queue: max env: DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} GH_AW_ASSETS_ALLOWED_EXTS: "" GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: handledocumentation outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -407,7 +480,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Documentation Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-documentation.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Set runtime paths @@ -419,7 +493,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -428,23 +502,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -456,11 +528,22 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + GH_AW_GITHUB_MIN_INTEGRITY: 'none' + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); - name: Parse integrity filter lists id: parse-guard-vars env: @@ -468,32 +551,31 @@ jobs: GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }} GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }} run: bash "${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh" - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: ${{ needs.activation.outputs.artifact_prefix }}activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_f287fa0f078c345e_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_6c1b251bac7b1edb_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_f287fa0f078c345e_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_6c1b251bac7b1edb_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -537,10 +619,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -629,60 +708,22 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -691,29 +732,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_728828b4ea6e4249_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -728,16 +765,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -746,10 +802,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_728828b4ea6e4249_EOF + GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -778,29 +835,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 5 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -814,25 +893,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -856,8 +930,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -891,6 +964,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -912,16 +986,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -984,17 +1049,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-handle-documentation-${{ inputs.issue_number }}" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1003,7 +1070,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1012,7 +1079,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Documentation Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-documentation.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1029,6 +1097,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handledocumentation-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handledocumentation- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handledocumentation-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1036,9 +1196,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "handle-documentation" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1052,6 +1217,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1069,6 +1235,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1083,6 +1250,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1097,28 +1265,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "handle-documentation" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "5" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1131,19 +1307,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1152,7 +1331,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Documentation Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-documentation.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1171,7 +1351,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1180,7 +1360,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1199,13 +1379,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1234,16 +1418,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1253,27 +1437,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1286,7 +1494,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1336,20 +1559,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/handle-documentation" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "handle-documentation" GH_AW_WORKFLOW_NAME: "Documentation Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-documentation.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1362,7 +1590,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1371,7 +1599,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Documentation Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-documentation.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1391,7 +1620,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1402,6 +1631,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1422,4 +1652,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/handle-documentation.md b/.github/workflows/handle-documentation.md index 45c21adb1..12449a85c 100644 --- a/.github/workflows/handle-documentation.md +++ b/.github/workflows/handle-documentation.md @@ -16,6 +16,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] diff --git a/.github/workflows/handle-enhancement.lock.yml b/.github/workflows/handle-enhancement.lock.yml index 1255d9369..594320387 100644 --- a/.github/workflows/handle-enhancement.lock.yml +++ b/.github/workflows/handle-enhancement.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"0a1cd53da97b1be36f489e58d1153583dc96c9b436fab3392437a8d498d4d8fb","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"f194730258943dec72121a119dba066ff5fee588d79f69fddddd4ca29b56ffd4","body_hash":"624219976b9b7078c6bb11c4177925478cfd8316fe8de535a581bdd176eda825","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,20 +32,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Enhancement Handler" on: @@ -52,7 +57,7 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -79,7 +84,7 @@ on: permissions: {} concurrency: - group: "gh-aw-${{ github.workflow }}" + group: "gh-aw-handle-enhancement-${{ github.run_id }}" run-name: "Enhancement Handler" @@ -89,14 +94,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -108,14 +119,16 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Enhancement Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-enhancement.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Resolve host repo for activation checkout @@ -142,17 +155,17 @@ jobs: env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Enhancement Handler" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -164,11 +177,57 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handleenhancement-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handleenhancement- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_ID: "handle-enhancement" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Print cross-repo setup guidance if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository run: | @@ -177,7 +236,7 @@ jobs: echo "::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup" - name: Checkout .github and .agents folders if: steps.resolve-host-repo.outputs.target_repo == github.repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false repository: ${{ steps.resolve-host-repo.outputs.target_repo }} @@ -185,9 +244,9 @@ jobs: sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -195,8 +254,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -214,13 +273,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -238,20 +300,20 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_192f9f111edce454_EOF' + cat << 'GH_AW_PROMPT_e59da2f8e25b61b4_EOF' - GH_AW_PROMPT_192f9f111edce454_EOF + GH_AW_PROMPT_e59da2f8e25b61b4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_192f9f111edce454_EOF' + cat << 'GH_AW_PROMPT_e59da2f8e25b61b4_EOF' Tools: add_comment, add_labels, missing_tool, missing_data, noop - GH_AW_PROMPT_192f9f111edce454_EOF + GH_AW_PROMPT_e59da2f8e25b61b4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_192f9f111edce454_EOF' + cat << 'GH_AW_PROMPT_e59da2f8e25b61b4_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -279,13 +341,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_192f9f111edce454_EOF + + GH_AW_PROMPT_e59da2f8e25b61b4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_192f9f111edce454_EOF' + cat << 'GH_AW_PROMPT_e59da2f8e25b61b4_EOF' {{#runtime-import .github/workflows/handle-enhancement.md}} - GH_AW_PROMPT_192f9f111edce454_EOF + GH_AW_PROMPT_e59da2f8e25b61b4_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -312,14 +374,14 @@ jobs: GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -354,51 +416,62 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read concurrency: - group: "gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}" + group: "gh-aw-copilot-handle-enhancement-${{ inputs.issue_number }}" + queue: max env: DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} GH_AW_ASSETS_ALLOWED_EXTS: "" GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: handleenhancement outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -407,7 +480,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Enhancement Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-enhancement.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Set runtime paths @@ -419,7 +493,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -428,23 +502,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -456,11 +528,22 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + GH_AW_GITHUB_MIN_INTEGRITY: 'none' + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); - name: Parse integrity filter lists id: parse-guard-vars env: @@ -468,32 +551,31 @@ jobs: GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }} GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }} run: bash "${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh" - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: ${{ needs.activation.outputs.artifact_prefix }}activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_7a0b9826ce5c2de6_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_a36bb21781ffc2fb_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_7a0b9826ce5c2de6_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_a36bb21781ffc2fb_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -537,10 +619,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -629,60 +708,22 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -691,29 +732,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_fc710c56a8354bbf_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -728,16 +765,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -746,10 +802,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_fc710c56a8354bbf_EOF + GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -778,29 +835,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 5 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -814,25 +893,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -856,8 +930,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -891,6 +964,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -912,16 +986,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -984,17 +1049,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-handle-enhancement-${{ inputs.issue_number }}" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1003,7 +1070,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1012,7 +1079,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Enhancement Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-enhancement.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1029,6 +1097,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handleenhancement-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handleenhancement- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handleenhancement-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1036,9 +1196,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "handle-enhancement" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1052,6 +1217,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1069,6 +1235,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1083,6 +1250,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1097,28 +1265,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "handle-enhancement" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "5" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1131,19 +1307,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1152,7 +1331,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Enhancement Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-enhancement.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1171,7 +1351,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1180,7 +1360,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1199,13 +1379,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1234,16 +1418,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1253,27 +1437,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1286,7 +1494,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1336,20 +1559,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/handle-enhancement" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "handle-enhancement" GH_AW_WORKFLOW_NAME: "Enhancement Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-enhancement.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1362,7 +1590,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1371,7 +1599,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Enhancement Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-enhancement.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1391,7 +1620,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1402,6 +1631,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1422,4 +1652,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/handle-enhancement.md b/.github/workflows/handle-enhancement.md index 6dcb2aa0f..9043c181c 100644 --- a/.github/workflows/handle-enhancement.md +++ b/.github/workflows/handle-enhancement.md @@ -16,6 +16,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] diff --git a/.github/workflows/handle-question.lock.yml b/.github/workflows/handle-question.lock.yml index af8052999..0093edce0 100644 --- a/.github/workflows/handle-question.lock.yml +++ b/.github/workflows/handle-question.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"fb6cc48845814496ea0da474d3030f9e02e7d38b5bb346b70ca525c06c271cb1","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"92158ba4f7e373cb65457b060c7645569b32c756c13c025837491f6809cf694f","body_hash":"1bdd19aae2095beb6e3fcf7af755cd102d424de3a8727ef6e4674815950c7e8b","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,20 +32,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Question Handler" on: @@ -52,7 +57,7 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -79,7 +84,7 @@ on: permissions: {} concurrency: - group: "gh-aw-${{ github.workflow }}" + group: "gh-aw-handle-question-${{ github.run_id }}" run-name: "Question Handler" @@ -89,14 +94,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -108,14 +119,16 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Question Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-question.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Resolve host repo for activation checkout @@ -142,17 +155,17 @@ jobs: env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Question Handler" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -164,11 +177,57 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlequestion-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handlequestion- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_ID: "handle-question" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Print cross-repo setup guidance if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository run: | @@ -177,7 +236,7 @@ jobs: echo "::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup" - name: Checkout .github and .agents folders if: steps.resolve-host-repo.outputs.target_repo == github.repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false repository: ${{ steps.resolve-host-repo.outputs.target_repo }} @@ -185,9 +244,9 @@ jobs: sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -195,8 +254,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -214,13 +273,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -238,20 +300,20 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF' + cat << 'GH_AW_PROMPT_a6cfd5b92b97c528_EOF' - GH_AW_PROMPT_0e4131663d1691aa_EOF + GH_AW_PROMPT_a6cfd5b92b97c528_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF' + cat << 'GH_AW_PROMPT_a6cfd5b92b97c528_EOF' Tools: add_comment, add_labels, missing_tool, missing_data, noop - GH_AW_PROMPT_0e4131663d1691aa_EOF + GH_AW_PROMPT_a6cfd5b92b97c528_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF' + cat << 'GH_AW_PROMPT_a6cfd5b92b97c528_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -279,13 +341,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_0e4131663d1691aa_EOF + + GH_AW_PROMPT_a6cfd5b92b97c528_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF' + cat << 'GH_AW_PROMPT_a6cfd5b92b97c528_EOF' {{#runtime-import .github/workflows/handle-question.md}} - GH_AW_PROMPT_0e4131663d1691aa_EOF + GH_AW_PROMPT_a6cfd5b92b97c528_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -312,14 +374,14 @@ jobs: GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -354,51 +416,62 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read concurrency: - group: "gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}" + group: "gh-aw-copilot-handle-question-${{ inputs.issue_number }}" + queue: max env: DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} GH_AW_ASSETS_ALLOWED_EXTS: "" GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: handlequestion outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -407,7 +480,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Question Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-question.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Set runtime paths @@ -419,7 +493,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -428,23 +502,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -456,11 +528,22 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + GH_AW_GITHUB_MIN_INTEGRITY: 'none' + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); - name: Parse integrity filter lists id: parse-guard-vars env: @@ -468,32 +551,31 @@ jobs: GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }} GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }} run: bash "${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh" - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: ${{ needs.activation.outputs.artifact_prefix }}activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_f18ff0beb4e2bc07_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_564a988b74c338ef_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_f18ff0beb4e2bc07_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_564a988b74c338ef_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -537,10 +619,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -629,60 +708,22 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -691,29 +732,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_878c9f46d6eeb406_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -728,16 +765,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -746,10 +802,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_878c9f46d6eeb406_EOF + GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -778,29 +835,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 5 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -814,25 +893,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -856,8 +930,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -891,6 +964,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -912,16 +986,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -984,17 +1049,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-handle-question-${{ inputs.issue_number }}" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1003,7 +1070,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1012,7 +1079,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Question Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-question.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1029,6 +1097,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: ${{ needs.activation.outputs.artifact_prefix }}usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlequestion-${{ github.run_id }} + restore-keys: agentic-workflow-usage-handlequestion- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-handlequestion-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1036,9 +1196,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "handle-question" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1052,6 +1217,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1069,6 +1235,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1083,6 +1250,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1097,28 +1265,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "handle-question" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "5" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1131,19 +1307,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1152,7 +1331,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Question Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-question.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1171,7 +1351,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1180,7 +1360,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1199,13 +1379,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1234,16 +1418,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1253,27 +1437,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1286,7 +1494,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1336,20 +1559,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/handle-question" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "handle-question" GH_AW_WORKFLOW_NAME: "Question Handler" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/handle-question.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1362,7 +1590,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1371,7 +1599,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Question Handler" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/handle-question.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_SETUP_AW_CONTEXT: ${{ inputs.aw_context }} - name: Download agent output artifact @@ -1391,7 +1620,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1402,6 +1631,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1422,4 +1652,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/handle-question.md b/.github/workflows/handle-question.md index 2bf3a6523..21a10d468 100644 --- a/.github/workflows/handle-question.md +++ b/.github/workflows/handle-question.md @@ -16,6 +16,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] diff --git a/.github/workflows/issue-classification.lock.yml b/.github/workflows/issue-classification.lock.yml index 45c944c7b..041fb94b7 100644 --- a/.github/workflows/issue-classification.lock.yml +++ b/.github/workflows/issue-classification.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"1c9f9a62a510a7796b96187fbe0537fd05da1c082d8fab86cd7b99bf001aee01","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"797f7487a67c2fa4465cb3fd31e17c9f0620bb232b2a4fb693c62cb76d5d5a36","body_hash":"8e7ac9b7bb6ab07630a10a4a016108ba59f70feadf82a7391ca0ba5504e14bff","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,32 +32,36 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Issue Classification Agent" on: issues: types: - - opened + - opened # roles: all # Roles processed as role check in pre-activation job workflow_dispatch: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -77,14 +82,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: body: ${{ steps.sanitized.outputs.body }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -94,31 +105,33 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-classification.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -129,21 +142,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issueclassification-${{ github.run_id }} + restore-keys: agentic-workflow-usage-issueclassification- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_ID: "issue-classification" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -151,8 +210,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -170,7 +229,7 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -188,6 +247,9 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -202,24 +264,25 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} # poutine:ignore untrusted_checkout_exec run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF' + cat << 'GH_AW_PROMPT_2b9644ded951c90e_EOF' - GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF + GH_AW_PROMPT_2b9644ded951c90e_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF' + cat << 'GH_AW_PROMPT_2b9644ded951c90e_EOF' Tools: add_comment, call_workflow, missing_tool, missing_data, noop - GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF + GH_AW_PROMPT_2b9644ded951c90e_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF' + cat << 'GH_AW_PROMPT_2b9644ded951c90e_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -247,13 +310,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF + + GH_AW_PROMPT_2b9644ded951c90e_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF' + cat << 'GH_AW_PROMPT_2b9644ded951c90e_EOF' {{#runtime-import .github/workflows/issue-classification.md}} - GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF + GH_AW_PROMPT_2b9644ded951c90e_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -263,6 +326,7 @@ jobs: GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }} GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }} GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -283,14 +347,15 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -305,6 +370,7 @@ jobs: GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY, GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID, GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE, + GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER, GH_AW_MCP_CLI_SERVERS_LIST: process.env.GH_AW_MCP_CLI_SERVERS_LIST } }); @@ -326,20 +392,24 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read env: @@ -348,26 +418,32 @@ jobs: GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: issueclassification outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -376,7 +452,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-classification.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -387,7 +464,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -396,23 +473,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -424,11 +499,22 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + GH_AW_GITHUB_MIN_INTEGRITY: 'none' + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); - name: Parse integrity filter lists id: parse-guard-vars env: @@ -436,32 +522,31 @@ jobs: GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }} GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }} run: bash "${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh" - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_0e1d49da13fc6a56_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_3e3303377640f8c6_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_0e1d49da13fc6a56_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_3e3303377640f8c6_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -686,60 +771,22 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -748,29 +795,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_5ad084c2b5bc2d53_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -785,16 +828,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -803,10 +865,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_5ad084c2b5bc2d53_EOF + GH_AW_MCP_CONFIG_9424afbf8aa8e8ef_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -835,29 +898,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 10 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -871,25 +956,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -913,8 +993,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -948,6 +1027,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -969,16 +1049,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -1036,10 +1107,12 @@ jobs: call-handle-bug: needs: safe_outputs if: needs.safe_outputs.outputs.call_workflow_name == 'handle-bug' + # Imported from called workflow "handle-bug" because GitHub requires the caller job to grant permissions requested by reusable workflow jobs. + # Review the called workflow's job-level permissions in ./.github/workflows/handle-bug.lock.yml. permissions: actions: read contents: read - discussions: write + copilot-requests: write issues: write pull-requests: write uses: ./.github/workflows/handle-bug.lock.yml @@ -1055,10 +1128,12 @@ jobs: call-handle-documentation: needs: safe_outputs if: needs.safe_outputs.outputs.call_workflow_name == 'handle-documentation' + # Imported from called workflow "handle-documentation" because GitHub requires the caller job to grant permissions requested by reusable workflow jobs. + # Review the called workflow's job-level permissions in ./.github/workflows/handle-documentation.lock.yml. permissions: actions: read contents: read - discussions: write + copilot-requests: write issues: write pull-requests: write uses: ./.github/workflows/handle-documentation.lock.yml @@ -1074,10 +1149,12 @@ jobs: call-handle-enhancement: needs: safe_outputs if: needs.safe_outputs.outputs.call_workflow_name == 'handle-enhancement' + # Imported from called workflow "handle-enhancement" because GitHub requires the caller job to grant permissions requested by reusable workflow jobs. + # Review the called workflow's job-level permissions in ./.github/workflows/handle-enhancement.lock.yml. permissions: actions: read contents: read - discussions: write + copilot-requests: write issues: write pull-requests: write uses: ./.github/workflows/handle-enhancement.lock.yml @@ -1093,10 +1170,12 @@ jobs: call-handle-question: needs: safe_outputs if: needs.safe_outputs.outputs.call_workflow_name == 'handle-question' + # Imported from called workflow "handle-question" because GitHub requires the caller job to grant permissions requested by reusable workflow jobs. + # Review the called workflow's job-level permissions in ./.github/workflows/handle-question.lock.yml. permissions: actions: read contents: read - discussions: write + copilot-requests: write issues: write pull-requests: write uses: ./.github/workflows/handle-question.lock.yml @@ -1121,17 +1200,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-issue-classification" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1140,7 +1221,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1149,7 +1230,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-classification.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1165,6 +1247,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issueclassification-${{ github.run_id }} + restore-keys: agentic-workflow-usage-issueclassification- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issueclassification-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1172,9 +1346,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "issue-classification" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1188,6 +1367,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1205,6 +1385,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1219,6 +1400,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1233,28 +1415,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "issue-classification" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "10" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1267,19 +1457,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1288,7 +1481,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-classification.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1306,7 +1500,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1315,7 +1509,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1334,13 +1528,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1369,16 +1567,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1388,27 +1586,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1421,7 +1643,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1471,20 +1708,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/issue-classification" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "issue-classification" GH_AW_WORKFLOW_NAME: "Issue Classification Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-classification.md" outputs: call_workflow_name: ${{ steps.process_safe_outputs.outputs.call_workflow_name }} call_workflow_payload: ${{ steps.process_safe_outputs.outputs.call_workflow_payload }} @@ -1499,7 +1741,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1508,7 +1750,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Classification Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-classification.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1527,7 +1770,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1538,6 +1781,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1558,4 +1802,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/issue-classification.md b/.github/workflows/issue-classification.md index af682461f..b1e3345f9 100644 --- a/.github/workflows/issue-classification.md +++ b/.github/workflows/issue-classification.md @@ -14,6 +14,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] diff --git a/.github/workflows/issue-triage.lock.yml b/.github/workflows/issue-triage.lock.yml index 6e08aa042..e24584f26 100644 --- a/.github/workflows/issue-triage.lock.yml +++ b/.github/workflows/issue-triage.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"22ed351fca21814391eea23a7470028e8321a9e2fe21fb95e31b13d0353aee4b","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b343e48e59d56a2461bafa8c08f4f37d4242a56fa662b83c2f0cad16262682e5","body_hash":"30994be7c5c23b102c12a56a325ac313e413a2507dff11d0dc695899379bfbd0","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,33 +32,36 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Issue Triage Agent" on: issues: types: - - opened + - opened # roles: all # Roles processed as role check in pre-activation job workflow_dispatch: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string issue_number: @@ -78,14 +82,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: body: ${{ steps.sanitized.outputs.body }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -95,31 +105,33 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-triage.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -130,21 +142,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issuetriage-${{ github.run_id }} + restore-keys: agentic-workflow-usage-issuetriage- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_ID: "issue-triage" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -152,8 +210,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -171,7 +229,7 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -189,6 +247,9 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -203,24 +264,25 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} # poutine:ignore untrusted_checkout_exec run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF' + cat << 'GH_AW_PROMPT_39930e94844c6d8f_EOF' - GH_AW_PROMPT_e74a3944dc48d8ab_EOF + GH_AW_PROMPT_39930e94844c6d8f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF' + cat << 'GH_AW_PROMPT_39930e94844c6d8f_EOF' Tools: add_comment(max:2), close_issue, update_issue, add_labels(max:10), missing_tool, missing_data, noop - GH_AW_PROMPT_e74a3944dc48d8ab_EOF + GH_AW_PROMPT_39930e94844c6d8f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF' + cat << 'GH_AW_PROMPT_39930e94844c6d8f_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -248,13 +310,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_e74a3944dc48d8ab_EOF + + GH_AW_PROMPT_39930e94844c6d8f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF' + cat << 'GH_AW_PROMPT_39930e94844c6d8f_EOF' {{#runtime-import .github/workflows/issue-triage.md}} - GH_AW_PROMPT_e74a3944dc48d8ab_EOF + GH_AW_PROMPT_39930e94844c6d8f_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -264,6 +326,7 @@ jobs: GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }} GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }} GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -284,14 +347,15 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }} + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -306,6 +370,7 @@ jobs: GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY, GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID, GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE, + GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER, GH_AW_MCP_CLI_SERVERS_LIST: process.env.GH_AW_MCP_CLI_SERVERS_LIST } }); @@ -327,20 +392,24 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read env: @@ -349,26 +418,32 @@ jobs: GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: issuetriage outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -377,7 +452,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-triage.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -388,7 +464,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -397,23 +473,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -425,14 +499,14 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless - name: Determine automatic lockdown mode for GitHub MCP Server id: determine-automatic-lockdown - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 env: GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} @@ -440,44 +514,62 @@ jobs: script: | const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_6607c9cdef4a0243_EOF' - {"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"}} - GH_AW_SAFE_OUTPUTS_CONFIG_6607c9cdef4a0243_EOF + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_ee19492f88e4cc0b_EOF' + {"add_comment":{"max":2},"add_labels":{"allowed":["bug","enhancement","question","documentation","sdk/dotnet","sdk/go","sdk/java","sdk/nodejs","sdk/python","priority/high","priority/low","testing","security","needs-info","duplicate"],"issue_intent":true,"max":10,"target":"triggering"},"close_issue":{"issue_intent":true,"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"}} + GH_AW_SAFE_OUTPUTS_CONFIG_ee19492f88e4cc0b_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | { "description_suffixes": { "add_comment": " CONSTRAINTS: Maximum 2 comment(s) can be added. Supports reply_to_id for discussion threading.", - "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.", + "add_labels": " CONSTRAINTS: Maximum 10 label(s) can be added. Only these labels are allowed: [\"bug\" \"enhancement\" \"question\" \"documentation\" \"sdk/dotnet\" \"sdk/go\" \"sdk/java\" \"sdk/nodejs\" \"sdk/python\" \"priority/high\" \"priority/low\" \"testing\" \"security\" \"needs-info\" \"duplicate\"]. Target: triggering.", "close_issue": " CONSTRAINTS: Maximum 1 issue(s) can be closed. Target: triggering.", "update_issue": " CONSTRAINTS: Maximum 1 issue(s) can be updated. Target: triggering." }, "repo_params": {}, - "dynamic_tools": [] + "dynamic_tools": [], + "required_field_additions": { + "close_issue": [ + "rationale", + "confidence" + ] + }, + "property_injections": { + "close_issue": { + "state_reason": { + "description": "Optional closing state reason. Omit to use the configured default. Select 'duplicate' together with 'duplicate_of' to mark a native duplicate relationship.", + "enum": [ + "completed", + "not_planned", + "duplicate" + ], + "type": "string" + } + } + } } GH_AW_VALIDATION_JSON: | { @@ -511,10 +603,7 @@ jobs: }, "labels": { "required": true, - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "repo": { "type": "string", @@ -526,17 +615,34 @@ jobs: "defaultMax": 1, "fields": { "body": { - "required": true, "type": "string", "sanitize": true, "maxLength": 65000 }, + "confidence": { + "type": "string", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "x-strip-on-error": true + }, "issue_number": { "optionalPositiveInteger": true }, + "rationale": { + "type": "string", + "sanitize": true, + "maxLength": 280, + "x-strip-on-error": true + }, "repo": { "type": "string", "maxLength": 256 + }, + "suggest": { + "type": "boolean" } } }, @@ -631,10 +737,7 @@ jobs: "issueOrPRNumber": true }, "labels": { - "type": "array", - "itemType": "string", - "itemSanitize": true, - "itemMaxLength": 128 + "type": "array" }, "milestone": { "optionalPositiveInteger": true @@ -665,7 +768,7 @@ jobs: "maxLength": 128 } }, - "customValidation": "requiresOneOf:status,title,body" + "customValidation": "requiresOneOf:status,title,body,labels,assignees,milestone" } } uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -675,62 +778,24 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -739,29 +804,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_b6b29985f1ee0a9c_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -773,16 +834,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -791,10 +871,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_b6b29985f1ee0a9c_EOF + GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -823,29 +904,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 10 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -859,25 +962,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -901,8 +999,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -936,6 +1033,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -957,16 +1055,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -1027,17 +1116,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-issue-triage" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -1046,7 +1137,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1055,7 +1146,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-triage.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1071,6 +1163,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issuetriage-${{ github.run_id }} + restore-keys: agentic-workflow-usage-issuetriage- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-issuetriage-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1078,9 +1262,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "issue-triage" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1094,6 +1283,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1111,6 +1301,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1125,6 +1316,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1139,28 +1331,36 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "issue-triage" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "10" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1173,19 +1373,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1194,7 +1397,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-triage.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1212,7 +1416,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1221,7 +1425,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1240,13 +1444,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1275,16 +1483,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1294,27 +1502,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_DOCKER_HOST="${DOCKER_HOST}" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1327,7 +1559,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1377,20 +1624,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/issue-triage" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "issue-triage" GH_AW_WORKFLOW_NAME: "Issue Triage Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/issue-triage.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1403,7 +1655,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1412,7 +1664,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Issue Triage Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/issue-triage.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1431,7 +1684,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1442,10 +1695,11 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} - 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\"}}" + GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"add_comment\":{\"max\":2},\"add_labels\":{\"allowed\":[\"bug\",\"enhancement\",\"question\",\"documentation\",\"sdk/dotnet\",\"sdk/go\",\"sdk/java\",\"sdk/nodejs\",\"sdk/python\",\"priority/high\",\"priority/low\",\"testing\",\"security\",\"needs-info\",\"duplicate\"],\"issue_intent\":true,\"max\":10,\"target\":\"triggering\"},\"close_issue\":{\"issue_intent\":true,\"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\"}}" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1462,4 +1716,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/issue-triage.md b/.github/workflows/issue-triage.md index 006b8a644..3f5803b56 100644 --- a/.github/workflows/issue-triage.md +++ b/.github/workflows/issue-triage.md @@ -14,6 +14,7 @@ permissions: contents: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] @@ -21,19 +22,21 @@ safe-outputs: 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] + allowed: [bug, enhancement, question, documentation, sdk/dotnet, sdk/go, sdk/java, sdk/nodejs, sdk/python, priority/high, priority/low, testing, security, needs-info, duplicate] max: 10 target: triggering + issue-intent: true update-issue: target: triggering close-issue: target: triggering + issue-intent: true timeout-minutes: 10 --- # Issue Triage Agent -You 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. +You are an AI agent that triages newly opened issues in the copilot-sdk repository — a multi-language SDK with implementations in .NET, Go, Java, Node.js, and Python. ## Your Task @@ -48,7 +51,8 @@ When a new issue is opened, analyze it and perform the following actions: ### SDK/Language Labels (apply one or more if the issue relates to specific SDKs): - `sdk/dotnet` — .NET SDK issues -- `sdk/go` — Go SDK issues +- `sdk/go` — Go SDK issues +- `sdk/java` — Java SDK issues - `sdk/nodejs` — Node.js SDK issues - `sdk/python` — Python SDK issues diff --git a/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml new file mode 100644 index 000000000..e94e0775c --- /dev/null +++ b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml @@ -0,0 +1,1623 @@ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"a5f19a89f89b0693f86ca89ea90e3a633fe19c17bf4d27214fa9124429cdc156","body_hash":"8db09798070cbcba22c42c50a316ae45c8e8c650eeb23c556b44fde8d519550a","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ +# | _ |/ _` |/ _ \ '_ \| __| |/ __| +# | | | | (_| | __/ | | | |_| | (__ +# \_| |_/\__, |\___|_| |_|\__|_|\___| +# __/ | +# _ _ |___/ +# | | | | / _| | +# | | | | ___ _ __ _ __| |_| | _____ ____ +# | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| +# \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ +# \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ +# +# +# To update this file, edit the corresponding .md file and run: +# gh aw compile +# Not all edits will cause changes to this file. +# +# For more information: https://github.github.com/gh-aw/introduction/overview/ +# +# Adapt handwritten Java SDK code to work with regenerated types after a +# @github/copilot version bump. Assumes codegen succeeded and generated code +# compiles. Fixes handwritten source and tests only. +# +# Secrets used: +# - COPILOT_GITHUB_TOKEN +# - GH_AW_CI_TRIGGER_TOKEN +# - GH_AW_GITHUB_MCP_SERVER_TOKEN +# - GH_AW_GITHUB_TOKEN +# - GITHUB_TOKEN +# +# Custom actions used: +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 +# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 +# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 +# - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 +# +# Container images used: +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 + +name: "Java Handwritten Code Adaptation After CLI Upgrade" +on: + workflow_dispatch: + inputs: + aw_context: + default: "" + description: "Agent caller context (used internally by Agentic Workflows)." + required: false + type: string + branch: + description: Branch containing the upgrade PR + required: true + type: string + pr_number: + description: PR number to push fixes to + required: true + type: string + +permissions: {} + +concurrency: + group: "gh-aw-${{ github.workflow }}-${{ github.ref || github.run_id }}" + +run-name: "Java Handwritten Code Adaptation After CLI Upgrade" + +jobs: + activation: + runs-on: ubuntu-slim + permissions: + actions: read + contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + outputs: + comment_id: "" + comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} + engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} + lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} + model: ${{ steps.generate_aw_info.outputs.model }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} + setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} + setup-span-id: ${{ steps.setup.outputs.span-id }} + setup-trace-id: ${{ steps.setup.outputs.trace-id }} + stale_lock_file_failed: ${{ steps.check-lock-file.outputs.stale_lock_file_failed == 'true' }} + steps: + - name: Setup Scripts + id: setup + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + env: + GH_AW_SETUP_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml@${{ github.ref }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_ENGINE_ID: "copilot" + - name: Generate agentic run info + id: generate_aw_info + env: + GH_AW_INFO_ENGINE_ID: "copilot" + GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" + GH_AW_INFO_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_INFO_EXPERIMENTAL: "false" + GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" + GH_AW_INFO_STAGED: "false" + GH_AW_INFO_ALLOWED_DOMAINS: '["defaults","github"]' + GH_AW_INFO_FIREWALL_ENABLED: "true" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_AWMG_VERSION: "" + GH_AW_INFO_FIREWALL_TYPE: "squid" + GH_AW_COMPILED_STRICT: "true" + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); + await main(core, context); + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javaadapthandwrittencodetoacceptupgradechanges-${{ github.run_id }} + restore-keys: agentic-workflow-usage-javaadapthandwrittencodetoacceptupgradechanges- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_ID: "java-adapt-handwritten-code-to-accept-upgrade-changes" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" + env: + COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + - name: Checkout .github and .agents folders + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 + with: + persist-credentials: false + sparse-checkout: | + .github + .agents + .antigravity + .claude + .codex + .gemini + .opencode + .pi + sparse-checkout-cone-mode: true + fetch-depth: 1 + - name: Save agent config folders for base branch restoration + env: + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + # poutine:ignore untrusted_checkout_exec + run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" + - name: Check workflow lock file + id: check-lock-file + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_FILE: "java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml" + GH_AW_CONTEXT_WORKFLOW_REF: "${{ github.workflow_ref }}" + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs'); + await main(); + - name: Check compile-agentic version + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_COMPILED_VERSION: "v0.83.1" + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); + await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" + - name: Create prompt with built-in context + env: + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl + GH_AW_EXPR_1A3A194A: ${{ github.event.discussion.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'discussion' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_463A214A: ${{ github.event.pull_request.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'pull_request' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_802A9F6A: ${{ github.event.issue.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'issue' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_FF1D34CE: ${{ github.event.comment.id || fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').comment_id }} + GH_AW_GITHUB_ACTOR: ${{ github.actor }} + GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} + GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_BRANCH: ${{ inputs.branch }} + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} + # poutine:ignore untrusted_checkout_exec + run: | + bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" + { + cat << 'GH_AW_PROMPT_67432b380d9d8ebb_EOF' + + GH_AW_PROMPT_67432b380d9d8ebb_EOF + cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" + cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" + cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" + cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" + cat << 'GH_AW_PROMPT_67432b380d9d8ebb_EOF' + + Tools: add_comment(max:10), push_to_pull_request_branch, missing_tool, missing_data, noop + GH_AW_PROMPT_67432b380d9d8ebb_EOF + cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_push_to_pr_branch.md" + cat << 'GH_AW_PROMPT_67432b380d9d8ebb_EOF' + + GH_AW_PROMPT_67432b380d9d8ebb_EOF + cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" + cat << 'GH_AW_PROMPT_67432b380d9d8ebb_EOF' + + The following GitHub context information is available for this workflow: + {{#if github.actor}} + - **actor**: __GH_AW_GITHUB_ACTOR__ + {{/if}} + {{#if github.repository}} + - **repository**: __GH_AW_GITHUB_REPOSITORY__ + {{/if}} + {{#if github.workspace}} + - **workspace**: __GH_AW_GITHUB_WORKSPACE__ + {{/if}} + {{#if github.event.issue.number || (github.aw.context.item_type == 'issue' && github.aw.context.item_number)}} + - **issue-number**: #__GH_AW_EXPR_802A9F6A__ + {{/if}} + {{#if github.event.discussion.number || (github.aw.context.item_type == 'discussion' && github.aw.context.item_number)}} + - **discussion-number**: #__GH_AW_EXPR_1A3A194A__ + {{/if}} + {{#if github.event.pull_request.number || (github.aw.context.item_type == 'pull_request' && github.aw.context.item_number)}} + - **pull-request-number**: #__GH_AW_EXPR_463A214A__ + {{/if}} + {{#if github.event.comment.id || github.aw.context.comment_id}} + - **comment-id**: __GH_AW_EXPR_FF1D34CE__ + {{/if}} + {{#if github.run_id}} + - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ + {{/if}} + + + GH_AW_PROMPT_67432b380d9d8ebb_EOF + cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" + cat << 'GH_AW_PROMPT_67432b380d9d8ebb_EOF' + + {{#runtime-import .github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md}} + GH_AW_PROMPT_67432b380d9d8ebb_EOF + } > "$GH_AW_PROMPT" + - name: Interpolate variables and render templates + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + GH_AW_ENGINE_ID: "copilot" + GH_AW_INPUTS_BRANCH: ${{ inputs.branch }} + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs'); + await main(); + - name: Substitute placeholders + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + GH_AW_EXPR_1A3A194A: ${{ github.event.discussion.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'discussion' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_463A214A: ${{ github.event.pull_request.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'pull_request' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_802A9F6A: ${{ github.event.issue.number || (fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_type == 'issue' && fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').item_number) }} + GH_AW_EXPR_FF1D34CE: ${{ github.event.comment.id || fromJSON(github.event.inputs.aw_context || github.event.client_payload.aw_context || '{}').comment_id }} + GH_AW_GITHUB_ACTOR: ${{ github.actor }} + GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} + GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_BRANCH: ${{ inputs.branch }} + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); + + // Call the substitution function + return await substitutePlaceholders({ + file: process.env.GH_AW_PROMPT, + substitutions: { + GH_AW_EXPR_1A3A194A: process.env.GH_AW_EXPR_1A3A194A, + GH_AW_EXPR_463A214A: process.env.GH_AW_EXPR_463A214A, + GH_AW_EXPR_802A9F6A: process.env.GH_AW_EXPR_802A9F6A, + GH_AW_EXPR_FF1D34CE: process.env.GH_AW_EXPR_FF1D34CE, + GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR, + GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY, + GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID, + GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE, + GH_AW_INPUTS_BRANCH: process.env.GH_AW_INPUTS_BRANCH, + GH_AW_INPUTS_PR_NUMBER: process.env.GH_AW_INPUTS_PR_NUMBER, + GH_AW_MCP_CLI_SERVERS_LIST: process.env.GH_AW_MCP_CLI_SERVERS_LIST + } + }); + - name: Validate prompt placeholders + env: + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + # poutine:ignore untrusted_checkout_exec + run: bash "${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh" + - name: Print prompt + env: + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + # poutine:ignore untrusted_checkout_exec + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh" + - name: Upload activation artifact + if: success() + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: activation + include-hidden-files: true + path: | + /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json + /tmp/gh-aw/aw-prompts/prompt.txt + /tmp/gh-aw/aw-prompts/prompt-template.txt + /tmp/gh-aw/aw-prompts/prompt-import-tree.json + /tmp/gh-aw/github_rate_limits.jsonl + /tmp/gh-aw/base + /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills + if-no-files-found: ignore + retention-days: 1 + + agent: + needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + copilot-requests: write + env: + DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} + GH_AW_ASSETS_ALLOWED_EXTS: "" + GH_AW_ASSETS_BRANCH: "" + GH_AW_ASSETS_MAX_SIZE_KB: 0 + GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_WORKFLOW_ID_SANITIZED: javaadapthandwrittencodetoacceptupgradechanges + outputs: + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} + checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} + effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} + has_patch: ${{ steps.collect_output.outputs.has_patch }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} + model: ${{ needs.activation.outputs.model }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} + output: ${{ steps.collect_output.outputs.output }} + output_types: ${{ steps.collect_output.outputs.output_types }} + setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} + setup-span-id: ${{ steps.setup.outputs.span-id }} + setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} + steps: + - name: Setup Scripts + id: setup + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + job-name: ${{ github.job }} + trace-id: ${{ needs.activation.outputs.setup-trace-id }} + parent-span-id: ${{ needs.activation.outputs.setup-parent-span-id || needs.activation.outputs.setup-span-id }} + env: + GH_AW_SETUP_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml@${{ github.ref }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_ENGINE_ID: "copilot" + - name: Set runtime paths + id: set-runtime-paths + run: | + { + echo "GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl" + echo "GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" + echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" + } >> "$GITHUB_OUTPUT" + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 + with: + persist-credentials: false + - name: Create gh-aw temp directory + run: bash "${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh" + - name: Configure gh CLI for GitHub Enterprise + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" + env: + GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw + - name: Configure Git credentials + env: + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_TOKEN: ${{ github.token }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" + - name: Checkout PR branch + id: checkout-pr + if: | + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + with: + github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); + await main(); + - name: Install GitHub Copilot CLI + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 + env: + GH_HOST: github.com + - name: Install AWF binary + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless + - name: Determine automatic lockdown mode for GitHub MCP Server + id: determine-automatic-lockdown + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + env: + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + with: + script: | + const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); + await determineAutomaticLockdown(github, context, core); + - name: Restore agent config folders from base branch + if: steps.checkout-pr.outcome == 'success' + env: + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" + - name: Restore inline sub-agents from activation artifact + env: + GH_AW_SUB_AGENT_DIR: ".github/agents" + GH_AW_SUB_AGENT_EXT: ".agent.md" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" + - name: Download container images + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 + - name: Generate Safe Outputs Config + run: | + mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" + mkdir -p /tmp/gh-aw/safeoutputs + mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_fcd407b1cd819e9a_EOF' + {"add_comment":{"max":10,"target":"*"},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"false"},"push_to_pull_request_branch":{"if_no_changes":"warn","max_patch_size":4096,"protect_top_level_dot_folders":true,"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","DESIGN.md","README.md","CONTRIBUTING.md","CHANGELOG.md","SECURITY.md","CODE_OF_CONDUCT.md","AGENTS.md","CLAUDE.md","GEMINI.md"],"required_labels":["dependencies","sdk/java"],"target":"*"},"report_incomplete":{}} + GH_AW_SAFE_OUTPUTS_CONFIG_fcd407b1cd819e9a_EOF + - name: Generate Safe Outputs Tools + env: + GH_AW_TOOLS_META_JSON: | + { + "description_suffixes": { + "add_comment": " CONSTRAINTS: Maximum 10 comment(s) can be added. Target: *. Supports reply_to_id for discussion threading." + }, + "repo_params": {}, + "dynamic_tools": [] + } + GH_AW_VALIDATION_JSON: | + { + "add_comment": { + "defaultMax": 1, + "fields": { + "body": { + "required": true, + "type": "string", + "sanitize": true, + "maxLength": 65000 + }, + "item_number": { + "issueOrPRNumber": true + }, + "reply_to_id": { + "type": "string", + "maxLength": 256 + }, + "repo": { + "type": "string", + "maxLength": 256 + } + } + }, + "missing_data": { + "defaultMax": 20, + "fields": { + "alternatives": { + "type": "string", + "sanitize": true, + "maxLength": 256 + }, + "context": { + "type": "string", + "sanitize": true, + "maxLength": 256 + }, + "data_type": { + "type": "string", + "sanitize": true, + "maxLength": 128 + }, + "reason": { + "type": "string", + "sanitize": true, + "maxLength": 256 + } + } + }, + "missing_tool": { + "defaultMax": 20, + "fields": { + "alternatives": { + "type": "string", + "sanitize": true, + "maxLength": 512 + }, + "reason": { + "required": true, + "type": "string", + "sanitize": true, + "maxLength": 256 + }, + "tool": { + "type": "string", + "sanitize": true, + "maxLength": 128 + } + } + }, + "noop": { + "defaultMax": 1, + "fields": { + "message": { + "required": true, + "type": "string", + "sanitize": true, + "maxLength": 65000 + } + } + }, + "push_to_pull_request_branch": { + "defaultMax": 1, + "fields": { + "branch": { + "type": "string", + "sanitize": true, + "maxLength": 256 + }, + "message": { + "required": true, + "type": "string", + "sanitize": true, + "maxLength": 65000 + }, + "pull_request_number": { + "issueOrPRNumber": true + } + } + }, + "report_incomplete": { + "defaultMax": 5, + "fields": { + "details": { + "type": "string", + "sanitize": true, + "maxLength": 65000 + }, + "reason": { + "required": true, + "type": "string", + "sanitize": true, + "maxLength": 1024 + } + } + } + } + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); + await main(); + - name: Start MCP Gateway + id: start-mcp-gateway + env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} + GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} + GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} + GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + set -eo pipefail + mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" + + # Export gateway environment variables for MCP config and gateway script + export MCP_GATEWAY_PORT="8080" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" + export MCP_GATEWAY_HOST_DOMAIN="localhost" + MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') + echo "::add-mask::${MCP_GATEWAY_API_KEY}" + export MCP_GATEWAY_API_KEY + export MCP_GATEWAY_PAYLOAD_DIR="/tmp/gh-aw/mcp-payloads" + mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" + export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" + export DEBUG="*" + + export GH_AW_ENGINE="copilot" + MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') + MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" + GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) + cat << GH_AW_MCP_CONFIG_58d53a00b5a25078_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + { + "mcpServers": { + "github": { + "type": "stdio", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", + "env": { + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_READ_ONLY": "1", + "GITHUB_TOOLSETS": "context,repos" + }, + "guard-policies": { + "allow-only": { + "min-integrity": "$GITHUB_MCP_GUARD_MIN_INTEGRITY", + "repos": "$GITHUB_MCP_GUARD_REPOS" + } + } + }, + "safeoutputs": { + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" + }, + "guard-policies": { + "write-sink": { + "accept": [ + "*" + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} + } + } + } + }, + "gateway": { + "port": $MCP_GATEWAY_PORT, + "domain": "${MCP_GATEWAY_DOMAIN}", + "apiKey": "${MCP_GATEWAY_API_KEY}", + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 + } + } + GH_AW_MCP_CONFIG_58d53a00b5a25078_EOF + - name: Mount MCP servers as CLIs + id: mount-mcp-clis + continue-on-error: true + env: + MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }} + MCP_GATEWAY_DOMAIN: ${{ steps.start-mcp-gateway.outputs.gateway-domain }} + MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io); + const { main } = require('${{ runner.temp }}/gh-aw/actions/mount_mcp_as_cli.cjs'); + await main(); + - name: Clean credentials + continue-on-error: true + run: bash "${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh" + - name: Audit pre-agent workspace + id: pre_agent_audit + continue-on-error: true + run: bash "${RUNNER_TEMP}/gh-aw/actions/audit_pre_agent_workspace.sh" + - name: Execute GitHub Copilot CLI + id: agentic_execution + # Copilot CLI tool arguments (sorted): + timeout-minutes: 60 + run: | + set -o pipefail + printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" + touch /tmp/gh-aw/agent-step-summary.md + GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) + export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" + (umask 177 && touch /tmp/gh-aw/agent-stdio.log) + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"*.githubusercontent.com\",\"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\",\"codeload.github.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\",\"docs.github.com\",\"github-cloud.githubusercontent.com\",\"github-cloud.s3.amazonaws.com\",\"github.blog\",\"github.com\",\"github.githubassets.com\",\"host.docker.internal\",\"json-schema.org\",\"json.schemastore.org\",\"keyserver.ubuntu.com\",\"lfs.github.com\",\"objects.githubusercontent.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\",\"patch-diff.githubusercontent.com\",\"patchdiff.githubusercontent.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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + env: + AWF_REFLECT_ENABLED: 1 + COPILOT_AGENT_RUNNER_TYPE: STANDALONE + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} + GH_AW_PHASE: agent + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} + GH_AW_TIMEOUT_MINUTES: 60 + GH_AW_VERSION: v0.83.1 + GITHUB_API_URL: ${{ github.api_url }} + GITHUB_AW: true + GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows + GITHUB_HEAD_REF: ${{ github.head_ref }} + GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_REF_NAME: ${{ github.ref_name }} + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md + GITHUB_WORKSPACE: ${{ github.workspace }} + GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com + GIT_AUTHOR_NAME: github-actions[bot] + GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com + GIT_COMMITTER_NAME: github-actions[bot] + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors + if: always() + id: detect-agent-errors + continue-on-error: true + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" + - name: Configure Git credentials + env: + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_TOKEN: ${{ github.token }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" + - name: Copy Copilot session state files to logs + if: always() + continue-on-error: true + run: bash "${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh" + - name: Stop MCP Gateway + if: always() + continue-on-error: true + env: + MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }} + MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }} + GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }} + run: | + bash "${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh" "$GATEWAY_PID" + - name: Redact secrets in logs + if: always() + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); + await main(); + env: + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' + SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} + SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Append agent step summary + if: always() + run: bash "${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh" + - name: Copy Safe Outputs + if: always() + env: + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} + run: | + mkdir -p /tmp/gh-aw + cp "$GH_AW_SAFE_OUTPUTS" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true + - name: Ingest agent output + id: collect_output + if: always() + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} + GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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,patch-diff.githubusercontent.com,patchdiff.githubusercontent.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" + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_API_URL: ${{ github.api_url }} + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs'); + await main(); + - name: Parse agent logs for step summary + if: always() + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs'); + await main(); + - name: Parse MCP Gateway logs for step summary + if: always() + id: parse-mcp-gateway + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs'); + await main(); + - name: Print firewall logs + if: always() + continue-on-error: true + env: + AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless + - name: Parse token usage for step summary + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); + - name: Print AWF reflect summary + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/awf_reflect_summary.cjs'); + await main(); + - name: Write agent output placeholder if missing + if: always() + run: | + if [ ! -f /tmp/gh-aw/agent_output.json ]; then + echo '{"items":[]}' > /tmp/gh-aw/agent_output.json + fi + - name: Upload agent artifacts + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: agent + path: | + /tmp/gh-aw/aw-prompts/prompt.txt + /tmp/gh-aw/sandbox/agent/logs/ + /tmp/gh-aw/redacted-urls.log + /tmp/gh-aw/mcp-logs/ + /tmp/gh-aw/agent_usage.json + /tmp/gh-aw/agent-stdio.log + /tmp/gh-aw/pre-agent-audit.txt + /tmp/gh-aw/agent/ + /tmp/gh-aw/github_rate_limits.jsonl + /tmp/gh-aw/safeoutputs.jsonl + /tmp/gh-aw/agent_output.json + /tmp/gh-aw/aw-*.patch + /tmp/gh-aw/aw-*.bundle + /tmp/gh-aw/awf-config.json + /tmp/gh-aw/sandbox/firewall/logs/ + /tmp/gh-aw/sandbox/firewall/audit/ + /tmp/gh-aw/sandbox/firewall/awf-reflect.json + if-no-files-found: ignore + + conclusion: + needs: + - activation + - agent + - detection + - safe_outputs + if: > + always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') + runs-on: ubuntu-slim + permissions: + contents: write + issues: write + pull-requests: write + concurrency: + group: "gh-aw-conclusion-java-adapt-handwritten-code-to-accept-upgrade-changes" + cancel-in-progress: false + queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + outputs: + incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} + noop_message: ${{ steps.noop.outputs.noop_message }} + tools_reported: ${{ steps.missing_tool.outputs.tools_reported }} + total_count: ${{ steps.missing_tool.outputs.total_count }} + steps: + - name: Setup Scripts + id: setup + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + job-name: ${{ github.job }} + trace-id: ${{ needs.activation.outputs.setup-trace-id }} + parent-span-id: ${{ needs.activation.outputs.setup-parent-span-id || needs.activation.outputs.setup-span-id }} + env: + GH_AW_SETUP_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml@${{ github.ref }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_ENGINE_ID: "copilot" + - name: Download agent output artifact + id: download-agent-output + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: agent + path: /tmp/gh-aw/ + - name: Setup agent output environment variable + id: setup-agent-output-env + if: steps.download-agent-output.outcome == 'success' + run: | + mkdir -p /tmp/gh-aw/ + find "/tmp/gh-aw/" -type f -print + echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javaadapthandwrittencodetoacceptupgradechanges-${{ github.run_id }} + restore-keys: agentic-workflow-usage-javaadapthandwrittencodetoacceptupgradechanges- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javaadapthandwrittencodetoacceptupgradechanges-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 + - name: Process no-op messages + id: noop + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_NOOP_MAX: "1" + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} + GH_AW_NOOP_REPORT_AS_ISSUE: "false" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "java-adapt-handwritten-code-to-accept-upgrade-changes" + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs'); + await main(); + - name: Log detection run + id: detection_runs + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} + GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_detection_runs.cjs'); + await main(); + - name: Record missing tool + id: missing_tool + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs'); + await main(); + - name: Record incomplete + id: report_incomplete + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs'); + await main(); + - name: Handle agent failure + id: handle_agent_failure + if: always() + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} + GH_AW_WORKFLOW_ID: "java-adapt-handwritten-code-to-accept-upgrade-changes" + GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" + GH_AW_ENGINE_ID: "copilot" + GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} + GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} + GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} + GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} + GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} + GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" + GH_AW_CODE_PUSH_FAILURE_ERRORS: ${{ needs.safe_outputs.outputs.code_push_failure_errors }} + GH_AW_CODE_PUSH_FAILURE_COUNT: ${{ needs.safe_outputs.outputs.code_push_failure_count }} + GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} + GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} + GH_AW_GROUP_REPORTS: "false" + GH_AW_FAILURE_REPORT_AS_ISSUE: "true" + GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" + GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" + GH_AW_TIMEOUT_MINUTES: "60" + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs'); + await main(); + + detection: + needs: + - activation + - agent + if: always() && needs.agent.result != 'skipped' + runs-on: ubuntu-latest + permissions: + contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} + detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} + detection_reason: ${{ steps.detection_conclusion.outputs.reason }} + detection_success: ${{ steps.detection_conclusion.outputs.success }} + steps: + - name: Setup Scripts + id: setup + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + job-name: ${{ github.job }} + trace-id: ${{ needs.activation.outputs.setup-trace-id }} + parent-span-id: ${{ needs.activation.outputs.setup-parent-span-id || needs.activation.outputs.setup-span-id }} + env: + GH_AW_SETUP_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml@${{ github.ref }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_ENGINE_ID: "copilot" + - name: Download agent output artifact + id: download-agent-output + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: agent + path: /tmp/gh-aw/ + - name: Setup agent output environment variable + id: setup-agent-output-env + if: steps.download-agent-output.outcome == 'success' + run: | + mkdir -p /tmp/gh-aw/ + find "/tmp/gh-aw/" -type f -print + echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Checkout repository for patch context + if: needs.agent.outputs.has_patch == 'true' + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + # --- Threat Detection --- + - name: Clean stale firewall files from agent artifact + run: | + rm -rf /tmp/gh-aw/sandbox/firewall/logs + rm -rf /tmp/gh-aw/sandbox/firewall/audit + - name: Download container images + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 + - name: Check if detection needed + id: detection_guard + if: always() + env: + OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }} + HAS_PATCH: ${{ needs.agent.outputs.has_patch }} + run: | + if [[ -n "$OUTPUT_TYPES" || "$HAS_PATCH" == "true" ]]; then + echo "run_detection=true" >> "$GITHUB_OUTPUT" + echo "Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH" + else + echo "run_detection=false" >> "$GITHUB_OUTPUT" + echo "Detection skipped: no agent outputs or patches to analyze" + fi + - name: Clear MCP Config for detection + if: always() && steps.detection_guard.outputs.run_detection == 'true' + run: | + rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" + rm -f "$HOME/.copilot/mcp-config.json" + rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" + - name: Prepare threat detection files + if: always() && steps.detection_guard.outputs.run_detection == 'true' + run: | + mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json + cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi + cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true + for f in /tmp/gh-aw/aw-*.patch; do + [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true + done + for f in /tmp/gh-aw/aw-*.bundle; do + [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true + done + echo "Prepared threat detection files:" + ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true + - name: Setup threat detection + if: always() && steps.detection_guard.outputs.run_detection == 'true' + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + WORKFLOW_DESCRIPTION: "Adapt handwritten Java SDK code to work with regenerated types after a\n@github/copilot version bump. Assumes codegen succeeded and generated code\ncompiles. Fixes handwritten source and tests only." + HAS_PATCH: ${{ needs.agent.outputs.has_patch }} + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs'); + await main(); + - name: Ensure threat-detection directory and log + if: always() && steps.detection_guard.outputs.run_detection == 'true' + run: | + mkdir -p /tmp/gh-aw/threat-detection + touch /tmp/gh-aw/threat-detection/detection.log + - name: Setup Node.js + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 + with: + node-version: '24' + package-manager-cache: false + - name: Install GitHub Copilot CLI + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 + env: + GH_HOST: github.com + - name: Install AWF binary + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 + - name: Execute GitHub Copilot CLI + if: always() && steps.detection_guard.outputs.run_detection == 'true' + continue-on-error: true + id: detection_agentic_execution + # Copilot CLI tool arguments (sorted): + timeout-minutes: 20 + run: | + set -o pipefail + printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + touch /tmp/gh-aw/agent-step-summary.md + GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) + export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" + (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + env: + AWF_REFLECT_ENABLED: 1 + COPILOT_AGENT_RUNNER_TYPE: STANDALONE + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} + GH_AW_PHASE: detection + GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 + GITHUB_API_URL: ${{ github.api_url }} + GITHUB_AW: true + GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows + GITHUB_HEAD_REF: ${{ github.head_ref }} + GITHUB_REF_NAME: ${{ github.ref_name }} + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md + GITHUB_WORKSPACE: ${{ github.workspace }} + GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com + GIT_AUTHOR_NAME: github-actions[bot] + GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com + GIT_COMMITTER_NAME: github-actions[bot] + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); + - name: Upload threat detection log + if: always() && steps.detection_guard.outputs.run_detection == 'true' + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: detection + path: /tmp/gh-aw/threat-detection/detection.log + if-no-files-found: ignore + - name: Parse and conclude threat detection + id: detection_conclusion + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }} + DETECTION_AGENTIC_EXECUTION_OUTCOME: ${{ steps.detection_agentic_execution.outcome }} + GH_AW_DETECTION_CONTINUE_ON_ERROR: "true" + with: + script: | + try { + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs'); + await main(); + } catch (loadErr) { + const continueOnError = process.env.GH_AW_DETECTION_CONTINUE_ON_ERROR !== 'false'; + const detectionExecutionFailed = process.env.DETECTION_AGENTIC_EXECUTION_OUTCOME === 'failure'; + const msg = 'ERR_SYSTEM: \u274C Unexpected error loading threat detection module: ' + (loadErr && loadErr.message ? loadErr.message : String(loadErr)); + core.error(msg); + core.setOutput('reason', 'parse_error'); + if (continueOnError && !detectionExecutionFailed) { + core.warning('\u26A0\uFE0F ' + msg); + core.setOutput('conclusion', 'warning'); + core.setOutput('success', 'false'); + } else { + core.setOutput('conclusion', 'failure'); + core.setOutput('success', 'false'); + core.setFailed(msg); + } + } + + safe_outputs: + needs: + - activation + - agent + - detection + if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success' + runs-on: ubuntu-slim + permissions: + contents: write + issues: write + pull-requests: write + timeout-minutes: 45 + env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/java-adapt-handwritten-code-to-accept-upgrade-changes" + GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} + GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} + GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} + GH_AW_ENGINE_ID: "copilot" + GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_WORKFLOW_ID: "java-adapt-handwritten-code-to-accept-upgrade-changes" + GH_AW_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md" + outputs: + code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} + code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} + comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }} + comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }} + create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }} + create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }} + process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }} + process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }} + push_commit_sha: ${{ steps.process_safe_outputs.outputs.push_commit_sha }} + push_commit_url: ${{ steps.process_safe_outputs.outputs.push_commit_url }} + steps: + - name: Setup Scripts + id: setup + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 + with: + destination: ${{ runner.temp }}/gh-aw/actions + job-name: ${{ github.job }} + trace-id: ${{ needs.activation.outputs.setup-trace-id }} + parent-span-id: ${{ needs.activation.outputs.setup-parent-span-id || needs.activation.outputs.setup-span-id }} + env: + GH_AW_SETUP_WORKFLOW_NAME: "Java Handwritten Code Adaptation After CLI Upgrade" + GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml@${{ github.ref }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" + GH_AW_INFO_ENGINE_ID: "copilot" + - name: Download agent output artifact + id: download-agent-output + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: agent + path: /tmp/gh-aw/ + - name: Setup agent output environment variable + id: setup-agent-output-env + if: steps.download-agent-output.outcome == 'success' + run: | + mkdir -p /tmp/gh-aw/ + find "/tmp/gh-aw/" -type f -print + echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download patch artifact + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: agent + path: /tmp/gh-aw/ + - name: Checkout repository + if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'push_to_pull_request_branch') + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 + with: + persist-credentials: true + token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + - name: Configure Git credentials + if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'push_to_pull_request_branch') + env: + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} + GIT_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" + - name: Configure GH_HOST for enterprise compatibility + id: ghes-host-config + shell: bash + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. + # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct + # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. + GH_HOST="${GITHUB_SERVER_URL#https://}" + GH_HOST="${GH_HOST#http://}" + echo "GH_HOST=${GH_HOST}" >> "$GITHUB_ENV" + - name: Process Safe Outputs + id: process_safe_outputs + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} + GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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,patch-diff.githubusercontent.com,patchdiff.githubusercontent.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" + GITHUB_SERVER_URL: ${{ github.server_url }} + GITHUB_API_URL: ${{ github.api_url }} + GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"add_comment\":{\"max\":10,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"false\"},\"push_to_pull_request_branch\":{\"if_no_changes\":\"warn\",\"max_patch_size\":4096,\"protect_top_level_dot_folders\":true,\"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\",\"DESIGN.md\",\"README.md\",\"CONTRIBUTING.md\",\"CHANGELOG.md\",\"SECURITY.md\",\"CODE_OF_CONDUCT.md\",\"AGENTS.md\",\"CLAUDE.md\",\"GEMINI.md\"],\"required_labels\":[\"dependencies\",\"sdk/java\"],\"target\":\"*\"},\"report_incomplete\":{}}" + GH_AW_CI_TRIGGER_TOKEN: ${{ secrets.GH_AW_CI_TRIGGER_TOKEN }} + with: + github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs'); + await main(); + - name: Upload Safe Outputs Items + if: always() + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: safe-outputs-items + path: | + /tmp/gh-aw/safe-output-items.jsonl + /tmp/gh-aw/temporary-id-map.json + if-no-files-found: ignore diff --git a/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md new file mode 100644 index 000000000..dd1bfe2bb --- /dev/null +++ b/.github/workflows/java-adapt-handwritten-code-to-accept-upgrade-changes.md @@ -0,0 +1,159 @@ +--- +description: | + Adapt handwritten Java SDK code to work with regenerated types after a + @github/copilot version bump. Assumes codegen succeeded and generated code + compiles. Fixes handwritten source and tests only. + +on: + workflow_dispatch: + inputs: + branch: + description: "Branch containing the upgrade PR" + required: true + type: string + pr_number: + description: "PR number to push fixes to" + required: true + type: string + +permissions: + contents: read + actions: read + + copilot-requests: write +timeout-minutes: 60 + +network: + allowed: + - defaults + - github + +tools: + github: + toolsets: [context, repos] + +safe-outputs: + push-to-pull-request-branch: + target: "*" + required-labels: [dependencies, sdk/java] + add-comment: + target: "*" + max: 10 + noop: + report-as-issue: false +--- + +# Java Handwritten Code Adaptation After CLI Upgrade + +You are an automation agent that fixes handwritten Java SDK source and test code after a `@github/copilot` version bump has regenerated the typed schemas. + +## Assumptions + +- The branch `${{ inputs.branch }}` already has: + - Updated `java/scripts/codegen/package.json` with the new version + - Regenerated `java/sdk/src/generated/java/` code that compiles successfully + - Updated the Java POM CLI/version pin property +- Your job is ONLY to fix **handwritten** code, NOT generated code. + +## Boundaries + +- ❌ Do NOT edit anything under `java/sdk/src/generated/java/` +- ❌ Do NOT edit `java/scripts/codegen/java.ts` +- ❌ Do NOT create or modify tests in the `com.github.copilot.generated` test package (`java/sdk/src/test/java/com/github/copilot/sdk/generated/`) +- ✅ DO edit `java/sdk/src/main/java/com/github/copilot/sdk/**` +- ✅ DO edit `java/sdk/src/test/java/com/github/copilot/sdk/**` (excluding the `generated` subpackage) +- ✅ DO add new test methods or test classes if new user-facing API surface is introduced + +## Instructions + +### Step 0: Setup + +```bash +git checkout "${{ inputs.branch }}" +git pull origin "${{ inputs.branch }}" +``` + +Verify Java environment: + +```bash +java -version +mvn --version +node --version +``` + +### Step 1: Reproduce failures + +```bash +cd java +mvn clean test-compile jar:jar +mvn verify -Dskip.test.harness=true 2>&1 | tee /tmp/mvn-verify.log +``` + +If `mvn verify` succeeds (exit code 0), call `noop` with message "All tests pass on branch ${{ inputs.branch }}. No handwritten fixes needed." and stop. + +### Step 2: Analyze compilation errors + +Read the build output. Common patterns after a schema bump: + +1. **Constructor arity mismatch** — A generated Java record gained new fields, changing its constructor signature. Fix: add `null` (or appropriate default) for new parameters at every call site. +2. **Missing enum constants** — A generated enum gained new values that existing switch/if-else does not cover. Fix: add cases or ensure default handling. +3. **Type changes** — A field type changed (e.g., `String` → enum, `double` → `Long`). Fix: update usages. +4. **New event types** — New session event classes were generated. If `CopilotSession.java` or event handlers reference events by explicit type listing, add the new types. + +### Step 3: Fix compilation errors + +Apply minimal targeted fixes: + +- Search for compilation errors referencing generated type names. +- Update constructor calls to match new arity. +- Update type references if renamed/moved. +- Do NOT over-engineer — just make it compile. + +After each fix round, verify: + +```bash +cd java && mvn compile -Pskip-test-harness +``` + +### Step 4: Fix test failures + +Once compilation passes, run tests: + +```bash +cd java && mvn verify -Dskip.test.harness=true 2>&1 | tee /tmp/mvn-test.log +``` + +Fix failing assertions: + +- Update expected constructor arg counts in test utility calls. +- Update expected enum values in assertions. +- Add coverage for new public API if introduced (new getters, new config options). + +### Step 5: Format + +```bash +cd java && mvn spotless:apply +``` + +### Step 6: Final validation + +```bash +cd java +mvn clean test-compile jar:jar +mvn verify -Dskip.test.harness=true +``` + +If this passes, commit and push: + +```bash +git add java/sdk/src/main/java java/sdk/src/test/java +git commit -m "Fix handwritten Java code for @github/copilot schema changes + +Adapt constructor calls, enum references, and test assertions to match +regenerated types after CLI version bump." +git push origin "${{ inputs.branch }}" +``` + +Then add a comment to PR #${{ inputs.pr_number }} summarizing what was fixed. + +If after 3 full fix-compile-test cycles the build still fails, add a comment to the PR describing the remaining failures and stop. \ No newline at end of file diff --git a/.github/workflows/java-codegen-check.yml b/.github/workflows/java-codegen-check.yml index e1c11cd6d..f2f452796 100644 --- a/.github/workflows/java-codegen-check.yml +++ b/.github/workflows/java-codegen-check.yml @@ -6,12 +6,12 @@ on: - main paths: - 'java/scripts/codegen/**' - - 'java/src/generated/**' + - 'java/sdk/src/generated/**' - '.github/workflows/java-codegen-check.yml' pull_request: paths: - 'java/scripts/codegen/**' - - 'java/src/generated/**' + - 'java/sdk/src/generated/**' - '.github/workflows/java-codegen-check.yml' workflow_dispatch: diff --git a/.github/workflows/java-codegen-fix.lock.yml b/.github/workflows/java-codegen-fix.lock.yml index 8c650044f..1d8d28c43 100644 --- a/.github/workflows/java-codegen-fix.lock.yml +++ b/.github/workflows/java-codegen-fix.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"af13eefc935af6393de806a9a4307707d3b51a8c0d96992a84383cd9be790d52","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b0390c9ab9beb0d7e106314299e89e486269ab7f64d8489d5021132d79aa6b9b","body_hash":"63d6ce13a5131b158ddffb10a469aa59e0fdc2278eec4d8de7f6763e0b6f2ea2","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -33,21 +34,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Java Codegen Agentic Fix" on: @@ -55,7 +59,7 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string branch: @@ -84,13 +88,19 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -98,31 +108,33 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-codegen-fix.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults","github"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -133,21 +145,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javacodegenfix-${{ github.run_id }} + restore-keys: agentic-workflow-usage-javacodegenfix- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_ID: "java-codegen-fix" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -155,8 +213,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -174,13 +232,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -200,23 +261,23 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_1b89baae00b47687_EOF' + cat << 'GH_AW_PROMPT_7834a0b5f08e9149_EOF' - GH_AW_PROMPT_1b89baae00b47687_EOF + GH_AW_PROMPT_7834a0b5f08e9149_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_1b89baae00b47687_EOF' + cat << 'GH_AW_PROMPT_7834a0b5f08e9149_EOF' Tools: add_comment(max:5), push_to_pull_request_branch, missing_tool, missing_data, noop - GH_AW_PROMPT_1b89baae00b47687_EOF + GH_AW_PROMPT_7834a0b5f08e9149_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_push_to_pr_branch.md" - cat << 'GH_AW_PROMPT_1b89baae00b47687_EOF' + cat << 'GH_AW_PROMPT_7834a0b5f08e9149_EOF' - GH_AW_PROMPT_1b89baae00b47687_EOF + GH_AW_PROMPT_7834a0b5f08e9149_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_1b89baae00b47687_EOF' + cat << 'GH_AW_PROMPT_7834a0b5f08e9149_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -244,13 +305,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_1b89baae00b47687_EOF + + GH_AW_PROMPT_7834a0b5f08e9149_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_1b89baae00b47687_EOF' + cat << 'GH_AW_PROMPT_7834a0b5f08e9149_EOF' {{#runtime-import .github/workflows/java-codegen-fix.md}} - GH_AW_PROMPT_1b89baae00b47687_EOF + GH_AW_PROMPT_7834a0b5f08e9149_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -281,14 +342,14 @@ jobs: GH_AW_INPUTS_BRANCH: ${{ inputs.branch }} GH_AW_INPUTS_ERROR_SUMMARY: ${{ inputs.error_summary }} GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -325,47 +386,57 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: actions: read contents: read + copilot-requests: write env: DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} GH_AW_ASSETS_ALLOWED_EXTS: "" GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: javacodegenfix outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -374,7 +445,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-codegen-fix.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -385,7 +457,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -394,23 +466,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -422,14 +492,14 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless - name: Determine automatic lockdown mode for GitHub MCP Server id: determine-automatic-lockdown - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 env: GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} @@ -437,32 +507,31 @@ jobs: script: | const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_9547b36a6c2ad8b6_EOF' - {"add_comment":{"max":5,"target":"*"},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"false"},"push_to_pull_request_branch":{"if_no_changes":"warn","labels":["dependencies"],"max_patch_size":1024,"protect_top_level_dot_folders":true,"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","DESIGN.md","README.md","CONTRIBUTING.md","CHANGELOG.md","SECURITY.md","CODE_OF_CONDUCT.md","AGENTS.md","CLAUDE.md","GEMINI.md"],"target":"*"},"report_incomplete":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_9547b36a6c2ad8b6_EOF + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_cf285131e299ca5f_EOF' + {"add_comment":{"max":5,"target":"*"},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"false"},"push_to_pull_request_branch":{"if_no_changes":"warn","max_patch_size":4096,"protect_top_level_dot_folders":true,"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","DESIGN.md","README.md","CONTRIBUTING.md","CHANGELOG.md","SECURITY.md","CODE_OF_CONDUCT.md","AGENTS.md","CLAUDE.md","GEMINI.md"],"required_labels":["dependencies"],"target":"*"},"report_incomplete":{}} + GH_AW_SAFE_OUTPUTS_CONFIG_cf285131e299ca5f_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -558,7 +627,6 @@ jobs: "defaultMax": 1, "fields": { "branch": { - "required": true, "type": "string", "sanitize": true, "maxLength": 256 @@ -598,62 +666,24 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -662,29 +692,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_209c8aba9155ceb2_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_58d53a00b5a25078_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos" }, @@ -696,16 +722,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -714,10 +759,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_209c8aba9155ceb2_EOF + GH_AW_MCP_CONFIG_58d53a00b5a25078_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -746,29 +792,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["*.githubusercontent.com","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","codeload.github.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","docs.github.com","github-cloud.githubusercontent.com","github-cloud.s3.amazonaws.com","github.blog","github.com","github.githubassets.com","host.docker.internal","json-schema.org","json.schemastore.org","keyserver.ubuntu.com","lfs.github.com","objects.githubusercontent.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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"*.githubusercontent.com\",\"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\",\"codeload.github.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\",\"docs.github.com\",\"github-cloud.githubusercontent.com\",\"github-cloud.s3.amazonaws.com\",\"github.blog\",\"github.com\",\"github.githubassets.com\",\"host.docker.internal\",\"json-schema.org\",\"json.schemastore.org\",\"keyserver.ubuntu.com\",\"lfs.github.com\",\"objects.githubusercontent.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\",\"patch-diff.githubusercontent.com\",\"patchdiff.githubusercontent.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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 60 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -782,25 +850,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -824,8 +887,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -845,7 +907,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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" + GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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,patch-diff.githubusercontent.com,patchdiff.githubusercontent.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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} with: @@ -859,6 +921,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -880,16 +943,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -950,17 +1004,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: write - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-java-codegen-fix" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -969,7 +1025,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -978,7 +1034,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-codegen-fix.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -994,6 +1051,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javacodegenfix-${{ github.run_id }} + restore-keys: agentic-workflow-usage-javacodegenfix- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-javacodegenfix-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1001,9 +1150,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "false" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "java-codegen-fix" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1017,6 +1171,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1034,6 +1189,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1048,6 +1204,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1062,30 +1219,38 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "java-codegen-fix" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_CODE_PUSH_FAILURE_ERRORS: ${{ needs.safe_outputs.outputs.code_push_failure_errors }} GH_AW_CODE_PUSH_FAILURE_COUNT: ${{ needs.safe_outputs.outputs.code_push_failure_count }} GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "60" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1098,19 +1263,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1119,7 +1287,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-codegen-fix.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1137,7 +1306,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1146,7 +1315,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1165,13 +1334,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1200,16 +1373,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1219,27 +1392,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1252,7 +1449,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1302,20 +1514,25 @@ jobs: runs-on: ubuntu-slim permissions: contents: write - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/java-codegen-fix" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "java-codegen-fix" GH_AW_WORKFLOW_NAME: "Java Codegen Agentic Fix" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/java-codegen-fix.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1330,7 +1547,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1339,7 +1556,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Java Codegen Agentic Fix" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/java-codegen-fix.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1361,55 +1579,23 @@ jobs: with: name: agent path: /tmp/gh-aw/ - - name: Extract base branch from agent output - id: extract-base-branch - if: steps.download-agent-output.outcome == 'success' - shell: bash - run: | - if [ -f "/tmp/gh-aw/agent_output.json" ]; then - GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - BASE_BRANCH=$("$GH_AW_NODE" -e " - try { - const data = JSON.parse(require('fs').readFileSync('/tmp/gh-aw/agent_output.json', 'utf8')); - const item = (data.items || []).find(i => - (i.type === 'create_pull_request' || i.type === 'push_to_pull_request_branch') && - i.base_branch - ); - if (item) process.stdout.write(item.base_branch); - } catch(e) {} - " 2>/dev/null || true) - # Validate: only allow safe git branch name characters - if [[ "$BASE_BRANCH" =~ ^[a-zA-Z0-9/_.-]+$ ]] && [ ${#BASE_BRANCH} -le 255 ]; then - printf 'base-branch=%s\n' "$BASE_BRANCH" >> "$GITHUB_OUTPUT" - echo "Extracted base branch from safe output: $BASE_BRANCH" - fi - fi - name: Checkout repository if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'push_to_pull_request_branch') - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: - ref: ${{ steps.extract-base-branch.outputs.base-branch || github.base_ref || github.event.pull_request.base.ref || github.ref_name || github.event.repository.default_branch }} + persist-credentials: true token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} - persist-credentials: false - fetch-depth: 1 - name: Configure Git credentials if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'push_to_pull_request_branch') env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GIT_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GIT_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1420,10 +1606,11 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} - GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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" + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} + GH_AW_ALLOWED_DOMAINS: "*.githubusercontent.com,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,codeload.github.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,docs.github.com,github-cloud.githubusercontent.com,github-cloud.s3.amazonaws.com,github.blog,github.com,github.githubassets.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,lfs.github.com,objects.githubusercontent.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,patch-diff.githubusercontent.com,patchdiff.githubusercontent.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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} - GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"add_comment\":{\"max\":5,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"false\"},\"push_to_pull_request_branch\":{\"if_no_changes\":\"warn\",\"labels\":[\"dependencies\"],\"max_patch_size\":1024,\"protect_top_level_dot_folders\":true,\"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\",\"DESIGN.md\",\"README.md\",\"CONTRIBUTING.md\",\"CHANGELOG.md\",\"SECURITY.md\",\"CODE_OF_CONDUCT.md\",\"AGENTS.md\",\"CLAUDE.md\",\"GEMINI.md\"],\"target\":\"*\"},\"report_incomplete\":{}}" + GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"add_comment\":{\"max\":5,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"false\"},\"push_to_pull_request_branch\":{\"if_no_changes\":\"warn\",\"max_patch_size\":4096,\"protect_top_level_dot_folders\":true,\"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\",\"DESIGN.md\",\"README.md\",\"CONTRIBUTING.md\",\"CHANGELOG.md\",\"SECURITY.md\",\"CODE_OF_CONDUCT.md\",\"AGENTS.md\",\"CLAUDE.md\",\"GEMINI.md\"],\"required_labels\":[\"dependencies\"],\"target\":\"*\"},\"report_incomplete\":{}}" GH_AW_CI_TRIGGER_TOKEN: ${{ secrets.GH_AW_CI_TRIGGER_TOKEN }} with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -1441,4 +1628,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/java-codegen-fix.md b/.github/workflows/java-codegen-fix.md index 882df1d4a..b1dcb1f63 100644 --- a/.github/workflows/java-codegen-fix.md +++ b/.github/workflows/java-codegen-fix.md @@ -23,6 +23,7 @@ permissions: contents: read actions: read + copilot-requests: write timeout-minutes: 60 network: @@ -37,13 +38,14 @@ tools: safe-outputs: push-to-pull-request-branch: target: "*" - labels: [dependencies] + required-labels: [dependencies] add-comment: target: "*" max: 5 noop: report-as-issue: false --- + # Java Codegen Agentic Fix You are an automation agent that fixes Java compilation and test failures caused by code generation changes in the `copilot-sdk` monorepo. @@ -52,7 +54,7 @@ You are an automation agent that fixes Java compilation and test failures caused A Dependabot PR bumped the `@github/copilot` npm dependency in `java/scripts/codegen/package.json`. The `java-codegen-check` workflow ran the code generator (`java/scripts/codegen/java.ts`) against the new schemas and `mvn verify` subsequently failed. Your job is to fix **both** the code generator script (if needed) and the handwritten SDK/test source code so the build passes. -**❌❌❌ YOU MUST NEVER EDIT any of the java source code in `java/src/generated/` directly.** ✅✅Rather, the way to affect changes in these files is to change the code generator script and re-generate the classes in `java/src/generated`. +**❌❌❌ YOU MUST NEVER EDIT any of the java source code in `java/sdk/src/generated/` directly.** ✅✅Rather, the way to affect changes in these files is to change the code generator script and re-generate the classes in `java/sdk/src/generated`. The branch to fix is: `${{ inputs.branch }}` The PR number is: `${{ inputs.pr_number }}` @@ -64,7 +66,7 @@ ${{ inputs.error_summary }} ## Architecture overview -The code generator (`java/scripts/codegen/java.ts`) reads JSON schemas from `node_modules/@github/copilot/schemas/` and produces Java source files under `java/src/generated/java/`. These generated types are consumed by handwritten code in `java/src/main/java/` (primarily `CopilotSession.java`) and tested by handwritten tests in `java/src/test/java/`. +The code generator (`java/scripts/codegen/java.ts`) reads JSON schemas from `node_modules/@github/copilot/schemas/` and produces Java source files under `java/sdk/src/generated/java/`. These generated types are consumed by handwritten code in `java/sdk/src/main/java/` (primarily `CopilotSession.java`) and tested by handwritten tests in `java/sdk/src/test/java/`. When `@github/copilot` is bumped, the schemas may change in ways the code generator does not yet handle. Common schema changes include: @@ -124,7 +126,7 @@ Before making fixes, determine whether the failure is caused by: - New schemas exist but no corresponding Java types were generated **(B) Handwritten code referencing old generated type names/shapes.** Signs: -- Compilation errors in `java/src/main/java/` or `java/src/test/java/` referencing types that no longer exist +- Compilation errors in `java/sdk/src/main/java/` or `java/sdk/src/test/java/` referencing types that no longer exist - Test data using old JSON field names Often **both** (A) and (B) apply: the codegen needs fixing first, then handwritten code needs updating. @@ -160,7 +162,7 @@ If the diagnosis shows the code generator does not handle the new schema format: 4. **Verify the generated output** looks reasonable: ```bash - git diff --stat java/src/generated/java/ + git diff --stat java/sdk/src/generated/java/ ``` **You may ONLY modify `java/scripts/codegen/java.ts`.** Do not modify `package.json`, `package-lock.json`, or any other file under `java/scripts/codegen/`. @@ -177,12 +179,12 @@ For each attempt: 2. **Read the generated types** to understand what changed. Check the generated files that the handwritten code references: ```bash # Example: check what a generated type looks like now - cat java/src/generated/java/com/github/copilot/generated/rpc/.java + cat java/sdk/src/generated/java/com/github/copilot/generated/rpc/.java ``` 3. **Fix the affected source files.** You may modify files under: - - `java/src/main/java/` — handwritten SDK source code - - `java/src/test/java/` — handwritten test code + - `java/sdk/src/main/java/` — handwritten SDK source code + - `java/sdk/src/test/java/` — handwritten test code Common fixes: - Update type references from old nested types to new standalone types (e.g. `SessionMcpListResultServersItem` → `McpServer`) @@ -234,12 +236,12 @@ Do **NOT** push broken code. ## Important constraints -- **NEVER** hand-edit files under `java/src/generated/java/` — these are auto-generated. They are updated by running `cd java/scripts/codegen && npx tsx java.ts`. -- **NEVER** modify `java/pom.xml` — build config is not in scope +- **NEVER** hand-edit files under `java/sdk/src/generated/java/` — these are auto-generated. They are updated by running `cd java/scripts/codegen && npx tsx java.ts`. +- **NEVER** modify `java/sdk/pom.xml` — build config is not in scope - **NEVER** modify `java/scripts/codegen/package.json` or `java/scripts/codegen/package-lock.json` — dependency versions are not in scope - **NEVER** modify files under `.github/` — workflow files are not in scope - You **MAY** modify `java/scripts/codegen/java.ts` to fix the code generator -- You **MAY** modify files under `java/src/main/java/` and `java/src/test/java/` to fix handwritten code +- You **MAY** modify files under `java/sdk/src/main/java/` and `java/sdk/src/test/java/` to fix handwritten code - Always run `cd java && mvn spotless:apply` before committing to ensure code formatting - Maximum 3 fix attempts before reporting failure via `noop` -- Only push if `mvn verify` passes +- Only push if `mvn verify` passes \ No newline at end of file diff --git a/.github/workflows/java-publish-maven.yml b/.github/workflows/java-publish-maven.yml index 60bed91b0..1744a697e 100644 --- a/.github/workflows/java-publish-maven.yml +++ b/.github/workflows/java-publish-maven.yml @@ -22,6 +22,38 @@ on: type: boolean required: false default: false + workflow_call: + inputs: + releaseVersion: + description: "Release version (e.g., 1.0.0). If empty, derives from pom.xml by removing -SNAPSHOT" + required: false + type: string + developmentVersion: + description: "Next development version (e.g., 1.0.1-SNAPSHOT). If empty, increments patch version" + required: false + type: string + prerelease: + description: "Is this a prerelease?" + type: boolean + required: false + default: false + outputs: + mavenPublished: + description: "Whether the Java package was published to Maven Central" + value: ${{ jobs.publish-maven.outputs.published }} + secrets: + JAVA_RELEASE_TOKEN: + required: true + JAVA_RELEASE_GITHUB_TOKEN: + required: true + JAVA_MAVEN_CENTRAL_USERNAME: + required: true + JAVA_MAVEN_CENTRAL_PASSWORD: + required: true + JAVA_GPG_SECRET_KEY: + required: true + JAVA_GPG_PASSPHRASE: + required: true permissions: contents: write @@ -52,39 +84,6 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.JAVA_RELEASE_TOKEN }} - - name: Verify JAVA_RELEASE_GITHUB_TOKEN can trigger workflows - run: | - # JAVA_RELEASE_GITHUB_TOKEN is used for: - # - gh workflow run release-changelog.lock.yml (requires actions:write) - # Check the token's OAuth scopes for 'workflow' (classic PAT) or - # attempt a workflow dispatch with a non-existent ref to verify write access - # (fine-grained PAT — these don't expose scopes via X-OAuth-Scopes). - SCOPES=$(gh api -i user 2>&1 | grep -i '^x-oauth-scopes:' | tr '[:upper:]' '[:lower:]' || true) - if echo "$SCOPES" | grep -q 'workflow'; then - echo "JAVA_RELEASE_GITHUB_TOKEN has 'workflow' scope (classic PAT)" - elif [ -z "$SCOPES" ]; then - # Fine-grained PAT: no X-OAuth-Scopes header returned. - # Attempt a workflow dispatch against a non-existent ref. If the token - # has actions:write, the API returns 422 (validation failed on ref). - # If it lacks the permission, the API returns 403. - HTTP_CODE=$(gh api -X POST \ - "repos/${{ github.repository }}/actions/workflows/release-changelog.lock.yml/dispatches" \ - -f ref="preflight-check-nonexistent-ref" \ - -f 'inputs[tag]=preflight-check' \ - --silent -i 2>&1 | head -1 | grep -oE '[0-9]{3}' || echo "000") - if [ "$HTTP_CODE" = "403" ] || [ "$HTTP_CODE" = "000" ]; then - echo "::error::JAVA_RELEASE_GITHUB_TOKEN lacks actions:write permission on ${{ github.repository }}. It cannot trigger the changelog generation workflow." - exit 1 - fi - # 422 = has write access but ref doesn't exist (expected), 204 would mean it dispatched (shouldn't happen with fake ref) - echo "JAVA_RELEASE_GITHUB_TOKEN actions:write access OK (fine-grained PAT, dispatch returned HTTP ${HTTP_CODE})" - else - echo "::error::JAVA_RELEASE_GITHUB_TOKEN lacks 'workflow' scope. Found scopes: ${SCOPES}. It needs this scope to trigger changelog generation via gh workflow run." - exit 1 - fi - env: - GITHUB_TOKEN: ${{ secrets.JAVA_RELEASE_GITHUB_TOKEN }} - publish-maven: name: Publish Java SDK to Maven Central needs: preflight @@ -95,6 +94,7 @@ jobs: working-directory: ./java outputs: version: ${{ steps.versions.outputs.release_version }} + published: ${{ steps.publish-maven.outcome == 'success' }} steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: @@ -144,10 +144,10 @@ jobs: exit 1 fi else - # Split version: supports "0.1.32", "0.1.32-java.0", and "0.1.32-java-preview.0" formats + # Split version: supports "0.1.32", "0.1.32-preview.0", "0.1.32-java.0", and "0.1.32-java-preview.0" formats # Validate RELEASE_VERSION format explicitly to provide clear errors - if ! echo "$RELEASE_VERSION" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+(-(beta-)?java(-preview)?\.[0-9]+)?$'; then - echo "Error: RELEASE_VERSION '$RELEASE_VERSION' is invalid. Expected format: M.M.P, M.M.P-java.N, M.M.P-java-preview.N, M.M.P-beta-java.N, or M.M.P-beta-java-preview.N (e.g., 1.2.3, 1.2.3-java.0, 1.2.3-java-preview.0, 1.2.3-beta-java.0, or 1.2.3-beta-java-preview.0)." >&2 + if ! echo "$RELEASE_VERSION" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+(-(preview|(beta-)?java(-preview)?)\.[0-9]+)?$'; then + echo "Error: RELEASE_VERSION '$RELEASE_VERSION' is invalid. Expected format: M.M.P, M.M.P-preview.N, M.M.P-java.N, M.M.P-java-preview.N, M.M.P-beta-java.N, or M.M.P-beta-java-preview.N (e.g., 1.2.3, 1.2.3-preview.0, 1.2.3-java.0, 1.2.3-java-preview.0, 1.2.3-beta-java.0, or 1.2.3-beta-java-preview.0)." >&2 exit 1 fi # Extract the base M.M.P portion (before any qualifier) @@ -171,21 +171,12 @@ jobs: working-directory: ./java run: | VERSION="${{ steps.versions.outputs.release_version }}" - - # Update version in README.md (supports any version qualifier like -java.N, -java-preview.N, -beta-java.N) - sed -i "s|[0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\(-[a-z][a-z0-9-]*\.[0-9][0-9]*\)*|${VERSION}|g" README.md - sed -i "s|copilot-sdk-java:[0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\(-[a-z][a-z0-9-]*\.[0-9][0-9]*\)*|copilot-sdk-java:${VERSION}|g" README.md - - # Update snapshot version in README.md DEV_VERSION="${{ steps.versions.outputs.dev_version }}" - sed -i "s|[0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\(-[a-z][a-z0-9-]*\.[0-9][0-9]*\)*-SNAPSHOT|${DEV_VERSION}|g" README.md - - # Update version in jbang-example.java - sed -i "s|copilot-sdk-java:[0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\(-[a-z][a-z0-9-]*\.[0-9][0-9]*\)*|copilot-sdk-java:${VERSION}|g" jbang-example.java - sed -i 's|copilot-sdk-java:${project\.version}|copilot-sdk-java:'"${VERSION}"'|g' jbang-example.java + ./scripts/test-update-documentation-versions.sh + ./scripts/update-documentation-versions.sh "$VERSION" "$DEV_VERSION" README.md sdk/jbang-example.java # Commit the documentation changes before release:prepare (requires clean working directory) - git add README.md jbang-example.java + git add README.md sdk/jbang-example.java git commit -m "docs: update version references to ${VERSION}" # Save the commit SHA for potential rollback @@ -208,6 +199,7 @@ jobs: JAVA_GPG_PASSPHRASE: ${{ secrets.JAVA_GPG_PASSPHRASE }} - name: Perform Release and Deploy to Maven Central + id: publish-maven working-directory: ./java run: | mvn -B release:perform \ @@ -229,61 +221,27 @@ jobs: # Also run Maven release:rollback to clean up any partial release state mvn -B release:rollback || true - github-release: - name: Create GitHub Release + deploy-site: + name: Deploy Documentation Site needs: [preflight, publish-maven] if: github.ref == 'refs/heads/main' runs-on: ubuntu-latest - defaults: - run: - shell: bash - working-directory: ./java steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - with: - fetch-depth: 0 - - name: Create GitHub Release + - name: Trigger site deployment on standalone repo run: | VERSION="${{ needs.publish-maven.outputs.version }}" - GROUP_ID="com.github" - ARTIFACT_ID="copilot-sdk-java" - CURRENT_TAG="java/v${VERSION}" - - if gh release view "${CURRENT_TAG}" >/dev/null 2>&1; then - echo "Release ${CURRENT_TAG} already exists. Skipping creation." - exit 0 + TAG="java/v${VERSION}" + PUBLISH_AS_LATEST=true + if [ "${{ inputs.prerelease }}" = "true" ]; then + PUBLISH_AS_LATEST=false fi - - # Generate release notes from template - export VERSION GROUP_ID ARTIFACT_ID - RELEASE_NOTES=$(envsubst < $GITHUB_WORKSPACE/.github/workflows/java.notes.template) - - # Get the previous tag for generating notes - # grep returns exit 1 when no lines match (first release), so - # append "|| true" to prevent pipefail from aborting the script. - PREV_TAG=$(git tag --list 'java/v*' --sort=-version:refname \ - | grep -Fxv "${CURRENT_TAG}" \ - | head -n 1 || true) - - echo "Current tag: ${CURRENT_TAG}" - echo "Previous tag: ${PREV_TAG}" - - # Build the gh release command - GH_ARGS=("${CURRENT_TAG}") - GH_ARGS+=("--title" "GitHub Copilot SDK for Java ${VERSION}") - GH_ARGS+=("--notes" "${RELEASE_NOTES}") - GH_ARGS+=("--generate-notes") - - if [ -n "$PREV_TAG" ]; then - GH_ARGS+=("--notes-start-tag" "$PREV_TAG") - fi - - ${{ inputs.prerelease == true && 'GH_ARGS+=("--prerelease")' || '' }} - - gh release create "${GH_ARGS[@]}" - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Trigger changelog generation - run: gh workflow run release-changelog.lock.yml -f tag="java/v${{ needs.publish-maven.outputs.version }}" + echo "Triggering site deployment for version ${VERSION} (tag: ${TAG})" + gh workflow run deploy-site.yml \ + --repo github/copilot-sdk-java \ + -f version="${VERSION}" \ + -f publish_as_latest="${PUBLISH_AS_LATEST}" \ + -f monorepo_tag="${TAG}" + echo "### Site Deployment" >> $GITHUB_STEP_SUMMARY + echo "Triggered deploy-site.yml on github/copilot-sdk-java for version ${VERSION}" >> $GITHUB_STEP_SUMMARY env: GITHUB_TOKEN: ${{ secrets.JAVA_RELEASE_GITHUB_TOKEN }} diff --git a/.github/workflows/java-sdk-tests.yml b/.github/workflows/java-sdk-tests.yml index 20e66b41c..bd0a34bd2 100644 --- a/.github/workflows/java-sdk-tests.yml +++ b/.github/workflows/java-sdk-tests.yml @@ -10,32 +10,58 @@ on: - ".github/workflows/java-sdk-tests.yml" - ".github/actions/setup-copilot/**" - ".github/actions/java-test-report/**" - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - "java/**" - - "test/**" - - ".github/workflows/java-sdk-tests.yml" - - ".github/actions/setup-copilot/**" - - ".github/actions/java-test-report/**" - - "!**/*.md" - - "!**/LICENSE*" - - "!**/.gitignore" - - "!**/.editorconfig" - - "!**/*.png" - - "!**/*.jpg" - - "!**/*.jpeg" - - "!**/*.gif" - - "!**/*.svg" workflow_dispatch: - merge_group: + workflow_call: permissions: - contents: write - checks: write - pull-requests: write + contents: read jobs: + java-sdk-inprocess: + name: "Java SDK InProcess Tests" + if: github.event.repository.fork == false + runs-on: ubuntu-latest + defaults: + run: + shell: bash + working-directory: ./java + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false + + - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5 + with: + java-version: "25" + distribution: "microsoft" + cache: "maven" + + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 + with: + node-version: 22 + + - name: Run Java SDK tests (InProcess) + env: + CI: "true" + run: mvn clean verify -Pinprocess + + - name: Generate Test Report Summary + if: always() + uses: ./.github/actions/java-test-report + with: + title: "Copilot Java SDK :: Test Results InProcess" + + - name: Upload test results on failure + if: failure() + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: java-test-results-inprocess + path: | + java/sdk/target/surefire-reports/ + java/sdk/target/surefire-reports-isolated/ + java/sdk/target/failsafe-reports/ + retention-days: 7 + java-sdk: name: "Java SDK Tests (JDK ${{ matrix.test-jdk }})" if: github.event.repository.fork == false @@ -64,6 +90,10 @@ jobs: with: node-version: 22 + - name: Test documentation version updater + if: matrix.test-jdk == '25' + run: ./scripts/test-update-documentation-versions.sh + - name: Build SDK and set up test harness run: mvn test-compile jar:jar @@ -72,17 +102,24 @@ jobs: run: mvn javadoc:javadoc -q - name: Verify CLI works - run: node target/copilot-sdk/nodejs/node_modules/@github/copilot/index.js --version + run: node ../nodejs/node_modules/@github/copilot/npm-loader.js --version - name: Run spotless check if: matrix.test-jdk == '25' run: | - mvn spotless:check - if [ $? -ne 0 ]; then - echo "❌ spotless:check failed. Please run 'mvn spotless:apply' in java" - exit 1 - fi - echo "✅ spotless:check passed" + max_attempts=3 + for ((attempt=1; attempt<=max_attempts; attempt++)); do + if mvn spotless:check; then + echo "✅ spotless:check passed" + exit 0 + fi + if [ "$attempt" -lt "$max_attempts" ]; then + echo "⚠️ spotless:check failed (attempt $attempt/$max_attempts), retrying in 10s..." + sleep 10 + fi + done + echo "❌ spotless:check failed after $max_attempts attempts. Please run 'mvn spotless:apply' in java/" + exit 1 - name: Run Java SDK tests (JDK 25) if: matrix.test-jdk == '25' @@ -104,7 +141,7 @@ jobs: run: | echo "Running tests against JDK 25-built classes using JDK 17 runtime..." java -version - mvn jacoco:prepare-agent@wire-up-coverage-instrumentation antrun:run@print-test-jdk-banner surefire:test failsafe:integration-test failsafe:verify jacoco:report@build-coverage-report-from-tests -Denforcer.skip=true + mvn -pl sdk jacoco:prepare-agent@wire-up-coverage-instrumentation antrun:run@print-test-jdk-banner surefire:test failsafe:integration-test failsafe:verify jacoco:report@build-coverage-report-from-tests -Denforcer.skip=true - name: Upload test results for site generation if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25' @@ -112,27 +149,11 @@ jobs: with: name: test-results-for-site path: | - java/target/jacoco-test-results/sdk-tests.exec - java/target/surefire-reports/ - java/target/surefire-reports-isolated/ + java/sdk/target/jacoco-test-results/sdk-tests.exec + java/sdk/target/surefire-reports/ + java/sdk/target/surefire-reports-isolated/ retention-days: 1 - - name: Generate JaCoCo badge - if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25' - working-directory: . - run: bash .github/scripts/generate-java-coverage-badge.sh java/target/site/jacoco-coverage/jacoco.csv .github/badges - - - name: Create PR for JaCoCo badge update - if: success() && github.ref == 'refs/heads/main' && matrix.test-jdk == '25' - uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v7 - with: - commit-message: "Update Java JaCoCo coverage badge" - title: "Update Java JaCoCo coverage badge" - body: "Automated Java JaCoCo coverage badge update from CI." - branch: auto/update-java-jacoco-badge - add-paths: .github/badges/ - delete-branch: true - - name: Generate Test Report Summary if: always() uses: ./.github/actions/java-test-report @@ -145,7 +166,7 @@ jobs: with: name: java-test-results-jdk-${{ matrix.test-jdk }} path: | - java/target/surefire-reports/ - java/target/surefire-reports-isolated/ - java/target/failsafe-reports/ + java/sdk/target/surefire-reports/ + java/sdk/target/surefire-reports-isolated/ + java/sdk/target/failsafe-reports/ retention-days: 7 diff --git a/.github/workflows/java-smoke-test.yml b/.github/workflows/java-smoke-test.yml index cffef0a35..e7e9a417d 100644 --- a/.github/workflows/java-smoke-test.yml +++ b/.github/workflows/java-smoke-test.yml @@ -63,7 +63,7 @@ jobs: The SDK has already been built and installed into the local Maven repository. JDK 17 and Maven are already installed and on PATH. - Execute the prompt at `src/test/prompts/PROMPT-smoke-test.md` with the following critical overrides: + Execute the prompt at `sdk/src/test/prompts/PROMPT-smoke-test.md` with the following critical overrides: **Critical override — disable SNAPSHOT updates (but allow downloads):** The goal of this workflow is to validate the SDK SNAPSHOT that was just built and installed locally, not any newer SNAPSHOT that might exist in a remote repository. To ensure Maven does not download a newer timestamped SNAPSHOT of the SDK while still allowing it to download any missing plugins or dependencies, you must run the smoke-test Maven build without `-U` and with `--no-snapshot-updates`, so that it uses the locally installed SDK artifact. Use `mvn --no-snapshot-updates clean package` instead of `mvn -U clean package` or `mvn -o clean package`. @@ -136,7 +136,7 @@ jobs: The SDK has already been built and installed into the local Maven repository. JDK 25 and Maven are already installed and on PATH. - Execute the prompt at `src/test/prompts/PROMPT-smoke-test.md` with the following critical overrides: + Execute the prompt at `sdk/src/test/prompts/PROMPT-smoke-test.md` with the following critical overrides: **Critical override — disable SNAPSHOT updates (but allow downloads):** The goal of this workflow is to validate the SDK SNAPSHOT that was just built and installed locally, not any newer SNAPSHOT that might exist in a remote repository. To ensure Maven does not download a newer timestamped SNAPSHOT of the SDK while still allowing it to download any missing plugins or dependencies, you must run the smoke-test Maven build without `-U` and with `--no-snapshot-updates`, so that it uses the locally installed SDK artifact. Use `mvn --no-snapshot-updates clean package` instead of `mvn -U clean package` or `mvn -o clean package`. diff --git a/.github/workflows/java.notes.template b/.github/workflows/java.notes.template deleted file mode 100644 index d34d39c62..000000000 --- a/.github/workflows/java.notes.template +++ /dev/null @@ -1,27 +0,0 @@ - - -# Installation - -⚠️ **Artifact versioning plan:** Releases of this implementation track releases of the reference implementation. For each release of the reference implementation, there may follow a corresponding release of this implementation with the same number as the reference implementation. Release identifiers of the reference implementation are in the form `vMaj.Min.Micro`. For example v0.1.32. The corresponding maven version for the release will be `Maj.Min.Micro-java.N`, where `Maj`, `Min` and `Micro` are the corresponding numbers for the reference implementation release, and `N` is a monotonically increasing sequence number starting with 0 for each release. See the corresponding architectural decision record for more information in the `docs/adr` directory of the source code. - -📦 [View on Maven Central](https://central.sonatype.com/artifact/${GROUP_ID}/${ARTIFACT_ID}/${VERSION}) - - -## Maven -```xml - - ${GROUP_ID} - ${ARTIFACT_ID} - ${VERSION} - -``` - -## Gradle (Kotlin DSL) -```kotlin -implementation("${GROUP_ID}:${ARTIFACT_ID}:${VERSION}") -``` - -## Gradle (Groovy DSL) -```groovy -implementation '${GROUP_ID}:${ARTIFACT_ID}:${VERSION}' -``` diff --git a/.github/workflows/nodejs-sdk-tests.yml b/.github/workflows/nodejs-sdk-tests.yml index 8880cadfa..4c31f79cc 100644 --- a/.github/workflows/nodejs-sdk-tests.yml +++ b/.github/workflows/nodejs-sdk-tests.yml @@ -7,31 +7,15 @@ on: push: branches: - main - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - 'nodejs/**' - - 'test/**' - - '.github/workflows/nodejs-sdk-tests.yml' - - '!nodejs/scripts/**' - - '!**/*.md' - - '!**/LICENSE*' - - '!**/.gitignore' - - '!**/.editorconfig' - - '!**/*.png' - - '!**/*.jpg' - - '!**/*.jpeg' - - '!**/*.gif' - - '!**/*.svg' workflow_dispatch: - merge_group: + workflow_call: permissions: contents: read jobs: test: - name: "Node.js SDK Tests" + name: "Node.js SDK Tests (${{ matrix.os }}, ${{ matrix.transport }})" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off @@ -39,6 +23,7 @@ jobs: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] + transport: ["default", "inprocess"] runs-on: ${{ matrix.os }} defaults: run: @@ -75,6 +60,11 @@ jobs: if: runner.os == 'Windows' run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + - name: Select inprocess transport + if: matrix.transport == 'inprocess' + run: | + echo "COPILOT_SDK_DEFAULT_CONNECTION=inprocess" >> "$GITHUB_ENV" + - name: Run Node.js SDK tests env: COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a93bec32f..98bf23690 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -21,9 +21,7 @@ on: required: false permissions: - contents: write - id-token: write # Required for OIDC - actions: write # Required to trigger changelog workflow + contents: read concurrency: group: publish @@ -59,10 +57,13 @@ jobs: if [ -n "${{ github.event.inputs.version }}" ]; then VERSION="${{ github.event.inputs.version }}" # Validate version format matches dist-tag - # TEMPORARY: skips validation for "latest" so prerelease versions - # can be published under that tag. To ship stable 1.0.0, revert the - # commit that introduced this temporary change. - if [ "${{ github.event.inputs.dist-tag }}" != "latest" ]; then + if [ "${{ github.event.inputs.dist-tag }}" = "latest" ]; then + if [[ "$VERSION" == *-* ]]; then + echo "❌ Error: Version '$VERSION' has a prerelease suffix but dist-tag is 'latest'" >> $GITHUB_STEP_SUMMARY + echo "Use a version without suffix (e.g., '1.0.0') for latest releases" + exit 1 + fi + else if [[ "$VERSION" != *-* ]]; then echo "❌ Error: Version '$VERSION' has no prerelease suffix but dist-tag is '${{ github.event.inputs.dist-tag }}'" >> $GITHUB_STEP_SUMMARY echo "Use a version with suffix (e.g., '1.0.0-preview.0') for prerelease/unstable" @@ -75,11 +76,21 @@ jobs: echo "Auto-incremented version: $VERSION" >> $GITHUB_STEP_SUMMARY fi echo "VERSION=$VERSION" >> $GITHUB_OUTPUT + - name: Verify version is available on public npm + env: + VERSION: ${{ steps.version.outputs.VERSION }} + run: | + node scripts/npm-release.js preflight \ + @github/copilot-sdk \ + "$VERSION" \ + https://registry.npmjs.org - publish-nodejs: - name: Publish Node.js SDK + package-nodejs: + name: Package Node.js SDK needs: version runs-on: ubuntu-latest + permissions: + contents: read defaults: run: working-directory: ./nodejs @@ -88,8 +99,6 @@ jobs: - uses: actions/setup-node@v6 with: node-version: "22.x" - - name: Update npm for OIDC support - run: npm i -g "npm@11.6.3" - run: npm ci --ignore-scripts - name: Set version run: node scripts/set-version.js @@ -98,21 +107,126 @@ jobs: - name: Build run: npm run build - name: Pack - run: npm pack + id: pack + run: | + TARBALL="$(npm pack . --json | jq -r '.[0].filename')" + if [ -z "$TARBALL" ] || [ ! -f "$TARBALL" ]; then + echo "::error::npm pack did not produce a tarball." + exit 1 + fi + echo "tarball=$TARBALL" >> "$GITHUB_OUTPUT" - name: Upload artifact uses: actions/upload-artifact@v7.0.0 with: name: nodejs-package - path: nodejs/*.tgz - - name: Publish to npm - if: github.ref == 'refs/heads/main' || github.event.inputs.dist-tag == 'unstable' - run: npm publish --tag ${{ github.event.inputs.dist-tag }} --access public --registry https://registry.npmjs.org + path: nodejs/${{ steps.pack.outputs.tarball }} + if-no-files-found: error + + publish-nodejs: + name: Publish Node.js SDK + needs: package-nodejs + if: github.ref == 'refs/heads/main' || github.event.inputs.dist-tag == 'unstable' + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + id-token: write + steps: + - uses: actions/checkout@v6.0.2 + - uses: actions/setup-node@v6 + with: + node-version: "22.x" + - name: Update npm for OIDC support + run: npm i -g "npm@11.6.3" + - name: Download Node.js package + uses: actions/download-artifact@v8.0.0 + with: + name: nodejs-package + path: ./dist + - name: Publish tarball to public npm + env: + DIST_TAG: ${{ github.event.inputs.dist-tag }} + run: | + set -euo pipefail + shopt -s nullglob + TARBALLS=(./dist/*.tgz) + if [ "${#TARBALLS[@]}" -ne 1 ]; then + echo "::error::Expected exactly one Node.js package tarball, found ${#TARBALLS[@]}." + exit 1 + fi + node nodejs/scripts/npm-release.js publish \ + "${TARBALLS[0]}" \ + "$DIST_TAG" \ + https://registry.npmjs.org \ + public + + publish-nodejs-internal: + name: Publish Node.js SDK to internal feed + needs: publish-nodejs + environment: cicd + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + id-token: write + env: + ADO_RESOURCE: 499b84ac-1321-427f-aa17-267ca6975798 + FEED_URL: https://pkgs.dev.azure.com/devdiv/_packaging/copilot-canary/npm/registry/ + steps: + - uses: actions/checkout@v6.0.2 + - uses: actions/setup-node@v6 + with: + node-version: "22.x" + - name: Download Node.js package + uses: actions/download-artifact@v8.0.0 + with: + name: nodejs-package + path: ./dist + - name: Azure Login (OIDC -> id-cpd-ci) + uses: azure/login@532459ea530d8321f2fb9bb10d1e0bcf23869a43 # v3.0.0 + with: + client-id: "${{ vars.CPD_ID_CLIENT_ID }}" # id-cpd-ci + tenant-id: "${{ vars.CPD_ID_TENANT_ID }}" + allow-no-subscriptions: true + - name: Configure feed auth + run: | + set -euo pipefail + TOKEN="$(az account get-access-token --resource "$ADO_RESOURCE" --query accessToken -o tsv)" + echo "::add-mask::$TOKEN" + FEED_AUTH_REGISTRY="${FEED_URL#https:}" + FEED_AUTH_BASE="${FEED_AUTH_REGISTRY%registry/}" + printf '%s\n' \ + "${FEED_AUTH_REGISTRY}:_authToken=${TOKEN}" \ + "${FEED_AUTH_BASE}:_authToken=${TOKEN}" > "$HOME/.npmrc" + - name: Publish tarball to internal feed + env: + DIST_TAG: ${{ github.event.inputs.dist-tag }} + run: | + set -euo pipefail + if [ "$FEED_URL" != "https://pkgs.dev.azure.com/devdiv/_packaging/copilot-canary/npm/registry/" ]; then + echo "::error::FEED_URL ('$FEED_URL') is not the expected internal feed. Refusing to publish." + exit 1 + fi + shopt -s nullglob + TARBALLS=(./dist/*.tgz) + if [ "${#TARBALLS[@]}" -ne 1 ]; then + echo "::error::Expected exactly one Node.js package tarball, found ${#TARBALLS[@]}." + exit 1 + fi + node nodejs/scripts/npm-release.js publish \ + "${TARBALLS[0]}" \ + "$DIST_TAG" \ + "$FEED_URL" \ + azure publish-dotnet: name: Publish .NET SDK if: github.event.inputs.dist-tag != 'unstable' needs: version runs-on: ubuntu-latest + permissions: + contents: read + id-token: write defaults: run: working-directory: ./dotnet @@ -168,13 +282,17 @@ jobs: - name: Set version run: sed -i -E 's/^version = ".*"$/version = "${{ needs.version.outputs.version }}"/' Cargo.toml - name: Snapshot CLI version + hashes for build.rs - run: bash scripts/snapshot-bundled-cli-version.sh - - name: Verify cli-version.txt exists run: | - if [[ ! -f cli-version.txt ]]; then - echo "::error::cli-version.txt was not generated. The Snapshot step must run before packaging." - exit 1 - fi + bash scripts/snapshot-bundled-cli-version.sh + bash scripts/snapshot-bundled-in-process-version.sh + - name: Verify CLI version snapshots exist + run: | + for snapshot in cli-version.txt cli-version-in-process.txt; do + if [[ ! -f "${snapshot}" ]]; then + echo "::error::${snapshot} was not generated. The Snapshot step must run before packaging." + exit 1 + fi + done - name: Package (dry run) run: cargo publish --dry-run --allow-dirty - name: Upload artifact @@ -193,6 +311,9 @@ jobs: if: github.event.inputs.dist-tag != 'unstable' needs: version runs-on: ubuntu-latest + permissions: + contents: read + id-token: write defaults: run: working-directory: ./python @@ -211,8 +332,10 @@ jobs: run: npm ci --ignore-scripts - name: Set version run: sed -i "s/^version = .*/version = \"${{ needs.version.outputs.version }}\"/" pyproject.toml - - name: Build platform wheels - run: node scripts/build-wheels.mjs --output-dir dist + - name: Inject CLI version + run: node scripts/inject-cli-version.mjs + - name: Build wheel + run: uv build --wheel --out-dir dist - name: Upload artifact uses: actions/upload-artifact@v7.0.0 with: @@ -224,18 +347,61 @@ jobs: with: packages-dir: python/dist/ + publish-java: + name: Publish Java SDK + if: github.event.inputs.dist-tag != 'unstable' && github.ref == 'refs/heads/main' + needs: version + permissions: + contents: write + id-token: write + uses: ./.github/workflows/java-publish-maven.yml + with: + releaseVersion: ${{ needs.version.outputs.version }} + prerelease: ${{ github.event.inputs.dist-tag == 'prerelease' }} + secrets: inherit + github-release: name: Create GitHub Release - needs: [version, publish-nodejs, publish-dotnet, publish-python, publish-rust] - if: github.ref == 'refs/heads/main' && github.event.inputs.dist-tag != 'unstable' + needs: + [ + version, + publish-nodejs, + publish-dotnet, + publish-python, + publish-rust, + publish-java, + ] + if: | + always() && + github.ref == 'refs/heads/main' && + github.event.inputs.dist-tag != 'unstable' && + needs.version.result == 'success' && + needs.publish-nodejs.result == 'success' && + needs.publish-dotnet.result == 'success' && + needs.publish-python.result == 'success' && + needs.publish-rust.result == 'success' && + needs.publish-java.outputs.mavenPublished == 'true' runs-on: ubuntu-latest + permissions: + actions: write + contents: write steps: - uses: actions/checkout@v6.0.2 - # TEMPORARY: both "latest" and "prerelease" create GitHub pre-releases - # since "latest" publishes beta versions. To ship stable 1.0.0, revert - # the commit that introduced this temporary change. - name: Create GitHub Release - if: github.event.inputs.dist-tag == 'latest' || github.event.inputs.dist-tag == 'prerelease' + if: github.event.inputs.dist-tag == 'latest' + run: | + NOTES_FLAG="" + if git rev-parse "v${{ needs.version.outputs.current }}" >/dev/null 2>&1; then + NOTES_FLAG="--notes-start-tag v${{ needs.version.outputs.current }}" + fi + gh release create "v${{ needs.version.outputs.version }}" \ + --title "v${{ needs.version.outputs.version }}" \ + --generate-notes $NOTES_FLAG \ + --target ${{ github.sha }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Create GitHub Pre-Release + if: github.event.inputs.dist-tag == 'prerelease' run: | NOTES_FLAG="" if git rev-parse "v${{ needs.version.outputs.current-prerelease }}" >/dev/null 2>&1; then @@ -269,11 +435,9 @@ jobs: fi env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Tag Rust SDK and create Rust GitHub Release - # Rust gets its own version-scoped GitHub Release with notes - # derived from PR titles since the previous Rust tag. The - # cross-language `vX.Y.Z` release above still exists; this one - # is the canonical reference for Rust users. + - name: Tag Rust SDK + # Keep a language-scoped source tag for traceability. Rust is + # included in the cross-language `vX.Y.Z` GitHub Release. if: github.event.inputs.dist-tag == 'latest' || github.event.inputs.dist-tag == 'prerelease' run: | set -e @@ -288,26 +452,5 @@ jobs: else echo "Tag $TAG_NAME already exists, skipping tag push" fi - # Find the previous Rust tag for note generation. Prefer rust/v*, - # fall back to the historical rust-v* tags from the release-plz era. - PREV_TAG=$(git tag --list 'rust/v*' --sort=-v:refname | grep -vFx "$TAG_NAME" | head -n1) - if [ -z "$PREV_TAG" ]; then - PREV_TAG=$(git tag --list 'rust-v*' --sort=-v:refname | head -n1) - fi - NOTES_FLAG="" - if [ -n "$PREV_TAG" ]; then - NOTES_FLAG="--notes-start-tag $PREV_TAG" - echo "Generating notes from $PREV_TAG..$TAG_NAME" - else - echo "No previous Rust tag found; generating notes from full history" - fi - PRERELEASE_FLAG="" - if [ "${{ github.event.inputs.dist-tag }}" = "prerelease" ]; then - PRERELEASE_FLAG="--prerelease" - fi - gh release create "$TAG_NAME" \ - --title "$TAG_NAME" \ - --generate-notes $NOTES_FLAG $PRERELEASE_FLAG \ - --target ${{ github.sha }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/python-sdk-tests.yml b/.github/workflows/python-sdk-tests.yml index e6260dd0b..1ea973975 100644 --- a/.github/workflows/python-sdk-tests.yml +++ b/.github/workflows/python-sdk-tests.yml @@ -7,31 +7,15 @@ on: push: branches: - main - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - 'python/**' - - 'test/**' - - 'nodejs/package.json' - - '.github/workflows/python-sdk-tests.yml' - - '!**/*.md' - - '!**/LICENSE*' - - '!**/.gitignore' - - '!**/.editorconfig' - - '!**/*.png' - - '!**/*.jpg' - - '!**/*.jpeg' - - '!**/*.gif' - - '!**/*.svg' workflow_dispatch: - merge_group: + workflow_call: permissions: contents: read jobs: test: - name: "Python SDK Tests" + name: "Python SDK Tests (${{ matrix.os }}, ${{ matrix.transport }})" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off @@ -41,6 +25,7 @@ jobs: os: [ubuntu-latest, macos-latest, windows-latest] # Test the oldest supported Python version to make sure compatibility is maintained. python-version: ["3.11"] + transport: ["default", "inprocess"] runs-on: ${{ matrix.os }} defaults: run: @@ -86,7 +71,14 @@ jobs: if: runner.os == 'Windows' run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + - name: Select inprocess transport + if: matrix.transport == 'inprocess' + run: | + echo "COPILOT_SDK_DEFAULT_CONNECTION=inprocess" >> "$GITHUB_ENV" + - name: Run Python SDK tests env: COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} - run: uv run pytest -v -s + # Keep each module's shared E2E client and proxy on one process while + # running independent modules concurrently in isolated workers. + run: uv run pytest -v -s -n 2 --dist=loadfile diff --git a/.github/workflows/release-changelog.lock.yml b/.github/workflows/release-changelog.lock.yml index 98cf18dc3..23b19d9b8 100644 --- a/.github/workflows/release-changelog.lock.yml +++ b/.github/workflows/release-changelog.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"f56148e477b1349cf894dd5ee148dae8af3a90ab64cf708a41697d2c13b2da4b","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"a4a0859e0103be270433c7fe1926a346c46271b4b530b2c08fa5d606d0ab75c4","body_hash":"490b25b529910b1b087df624fd59eaef52e142e84b9503ca1cf87631f4c36b53","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# 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/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -32,21 +33,24 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "Release Changelog Generator" on: @@ -54,11 +58,11 @@ on: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string tag: - description: Release tag to generate changelog for (e.g., v0.1.30, /v1.0.0) + description: Release tag to generate changelog for (e.g., v1.0.0) required: true type: string @@ -75,13 +79,19 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -89,31 +99,33 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/release-changelog.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -124,21 +136,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-releasechangelog-${{ github.run_id }} + restore-keys: agentic-workflow-usage-releasechangelog- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_ID: "release-changelog" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -146,8 +204,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -165,13 +223,16 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -189,23 +250,23 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF' + cat << 'GH_AW_PROMPT_c642707f673b9ac4_EOF' - GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF + GH_AW_PROMPT_c642707f673b9ac4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF' + cat << 'GH_AW_PROMPT_c642707f673b9ac4_EOF' Tools: create_pull_request, update_release, missing_tool, missing_data, noop - GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF + GH_AW_PROMPT_c642707f673b9ac4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_create_pull_request.md" - cat << 'GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF' + cat << 'GH_AW_PROMPT_c642707f673b9ac4_EOF' - GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF + GH_AW_PROMPT_c642707f673b9ac4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF' + cat << 'GH_AW_PROMPT_c642707f673b9ac4_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -233,13 +294,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF + + GH_AW_PROMPT_c642707f673b9ac4_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF' + cat << 'GH_AW_PROMPT_c642707f673b9ac4_EOF' {{#runtime-import .github/workflows/release-changelog.md}} - GH_AW_PROMPT_8ca4e2fb6c3e0923_EOF + GH_AW_PROMPT_c642707f673b9ac4_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -267,14 +328,14 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -309,21 +370,25 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: actions: read contents: read + copilot-requests: write issues: read pull-requests: read env: @@ -332,26 +397,32 @@ jobs: GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: releasechangelog outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -360,7 +431,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/release-changelog.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -371,7 +443,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -380,23 +452,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -408,14 +478,14 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless - name: Determine automatic lockdown mode for GitHub MCP Server id: determine-automatic-lockdown - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 env: GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} @@ -423,32 +493,31 @@ jobs: script: | const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_6e92a7a47fdc567f_EOF' - {"create_pull_request":{"draft":false,"labels":["automation","changelog"],"max":1,"max_patch_files":100,"max_patch_size":1024,"protect_top_level_dot_folders":true,"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","DESIGN.md","README.md","CONTRIBUTING.md","CHANGELOG.md","SECURITY.md","CODE_OF_CONDUCT.md","AGENTS.md","CLAUDE.md","GEMINI.md"],"title_prefix":"[changelog] "},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"true"},"report_incomplete":{},"update_release":{"max":1}} - GH_AW_SAFE_OUTPUTS_CONFIG_6e92a7a47fdc567f_EOF + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_269226b895ff9733_EOF' + {"create_pull_request":{"draft":false,"labels":["automation","changelog"],"max":1,"max_patch_files":100,"max_patch_size":4096,"protect_top_level_dot_folders":true,"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","DESIGN.md","README.md","CONTRIBUTING.md","CHANGELOG.md","SECURITY.md","CODE_OF_CONDUCT.md","AGENTS.md","CLAUDE.md","GEMINI.md"],"protected_files_policy":"request_review","title_prefix":"[changelog] "},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"true"},"report_incomplete":{},"update_release":{"max":1}} + GH_AW_SAFE_OUTPUTS_CONFIG_269226b895ff9733_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -583,7 +652,8 @@ jobs: "required": true, "type": "string", "sanitize": true, - "maxLength": 65000 + "maxLength": 65000, + "minLength": 20 }, "operation": { "required": true, @@ -609,62 +679,24 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -673,29 +705,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_432de5cac6e63f96_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -707,16 +735,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -725,10 +772,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_432de5cac6e63f96_EOF + GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -757,29 +805,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 15 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -793,25 +863,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -835,8 +900,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -870,6 +934,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -891,16 +956,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -961,7 +1017,8 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: write @@ -971,6 +1028,8 @@ jobs: group: "gh-aw-conclusion-release-changelog" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -979,7 +1038,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -988,7 +1047,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/release-changelog.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1004,6 +1064,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-releasechangelog-${{ github.run_id }} + restore-keys: agentic-workflow-usage-releasechangelog- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-releasechangelog-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1011,9 +1163,14 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "release-changelog" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1027,6 +1184,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} @@ -1044,6 +1202,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1058,6 +1217,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1072,30 +1232,38 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "release-changelog" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_CODE_PUSH_FAILURE_ERRORS: ${{ needs.safe_outputs.outputs.code_push_failure_errors }} GH_AW_CODE_PUSH_FAILURE_COUNT: ${{ needs.safe_outputs.outputs.code_push_failure_count }} GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "15" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1108,19 +1276,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1129,7 +1300,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/release-changelog.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1147,7 +1319,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1156,7 +1328,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1175,13 +1347,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1210,16 +1386,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1229,27 +1405,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1262,7 +1462,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1314,17 +1529,23 @@ jobs: contents: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/release-changelog" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_WORKFLOW_ID: "release-changelog" GH_AW_WORKFLOW_NAME: "Release Changelog Generator" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/release-changelog.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1337,7 +1558,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1346,7 +1567,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "Release Changelog Generator" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/release-changelog.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1368,55 +1590,23 @@ jobs: with: name: agent path: /tmp/gh-aw/ - - name: Extract base branch from agent output - id: extract-base-branch - if: steps.download-agent-output.outcome == 'success' - shell: bash - run: | - if [ -f "/tmp/gh-aw/agent_output.json" ]; then - GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - BASE_BRANCH=$("$GH_AW_NODE" -e " - try { - const data = JSON.parse(require('fs').readFileSync('/tmp/gh-aw/agent_output.json', 'utf8')); - const item = (data.items || []).find(i => - (i.type === 'create_pull_request' || i.type === 'push_to_pull_request_branch') && - i.base_branch - ); - if (item) process.stdout.write(item.base_branch); - } catch(e) {} - " 2>/dev/null || true) - # Validate: only allow safe git branch name characters - if [[ "$BASE_BRANCH" =~ ^[a-zA-Z0-9/_.-]+$ ]] && [ ${#BASE_BRANCH} -le 255 ]; then - printf 'base-branch=%s\n' "$BASE_BRANCH" >> "$GITHUB_OUTPUT" - echo "Extracted base branch from safe output: $BASE_BRANCH" - fi - fi - name: Checkout repository if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'create_pull_request') - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: - ref: ${{ steps.extract-base-branch.outputs.base-branch || github.base_ref || github.event.pull_request.base.ref || github.ref_name || github.event.repository.default_branch }} + persist-credentials: true token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} - persist-credentials: false - fetch-depth: 1 - name: Configure Git credentials if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'create_pull_request') env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GIT_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GIT_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1427,10 +1617,11 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} - GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"create_pull_request\":{\"draft\":false,\"labels\":[\"automation\",\"changelog\"],\"max\":1,\"max_patch_files\":100,\"max_patch_size\":1024,\"protect_top_level_dot_folders\":true,\"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\",\"DESIGN.md\",\"README.md\",\"CONTRIBUTING.md\",\"CHANGELOG.md\",\"SECURITY.md\",\"CODE_OF_CONDUCT.md\",\"AGENTS.md\",\"CLAUDE.md\",\"GEMINI.md\"],\"title_prefix\":\"[changelog] \"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{},\"update_release\":{\"max\":1}}" + GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"create_pull_request\":{\"draft\":false,\"labels\":[\"automation\",\"changelog\"],\"max\":1,\"max_patch_files\":100,\"max_patch_size\":4096,\"protect_top_level_dot_folders\":true,\"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\",\"DESIGN.md\",\"README.md\",\"CONTRIBUTING.md\",\"CHANGELOG.md\",\"SECURITY.md\",\"CODE_OF_CONDUCT.md\",\"AGENTS.md\",\"CLAUDE.md\",\"GEMINI.md\"],\"protected_files_policy\":\"request_review\",\"title_prefix\":\"[changelog] \"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{},\"update_release\":{\"max\":1}}" GH_AW_CI_TRIGGER_TOKEN: ${{ secrets.GH_AW_CI_TRIGGER_TOKEN }} with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -1448,4 +1639,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/release-changelog.md b/.github/workflows/release-changelog.md index 52af777cd..c846b0dd3 100644 --- a/.github/workflows/release-changelog.md +++ b/.github/workflows/release-changelog.md @@ -4,7 +4,7 @@ on: workflow_dispatch: inputs: tag: - description: "Release tag to generate changelog for (e.g., v0.1.30, /v1.0.0)" + description: "Release tag to generate changelog for (e.g., v1.0.0)" required: true type: string permissions: @@ -12,6 +12,7 @@ permissions: actions: read issues: read pull-requests: read + copilot-requests: write tools: github: toolsets: [default] @@ -54,9 +55,8 @@ Use the GitHub API to fetch the release corresponding to `${{ github.event.input 2. The **new version** is the release tag: `${{ github.event.inputs.tag }}` 3. Fetch the release metadata to determine if this is a **stable** or **prerelease** release. 4. Determine the **previous version** to diff against: - - **Scoped tags**: If the tag has a language prefix (e.g., `java/v1.0.0` or `rust/v0.2.0`), the previous tag must use the **same prefix**. List tags matching that prefix (e.g., `java/v*` or `rust/v*`) sorted by version and pick the one immediately before the current tag. Only compare within the same scope. - - **For stable releases**: find the previous **stable** release (skip prereleases). Check `CHANGELOG.md` for the most recent version heading matching this scope (`## [vX.Y.Z](...)` for unscoped, `## [java/vX.Y.Z](...)` for Java, `## [rust/vX.Y.Z](...)` for Rust), 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. - - **For prerelease releases**: find the most recent release of **any kind** (stable or prerelease) that precedes this one within the same tag scope. This way prerelease notes only cover what's new since the last release. + - **For stable releases**: find the previous **stable** release (skip prereleases). Check `CHANGELOG.md` for the most recent `## [vX.Y.Z](...)` heading, 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. + - **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. 5. If no previous release exists at all, use the first commit in the repo as the starting point. 6. 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. @@ -67,8 +67,7 @@ Use the GitHub API to fetch the release corresponding to `${{ github.event.input - PR number and title - The PR author - Which SDK(s) were affected (look for prefixes like `[C#]`, `[Python]`, `[Go]`, `[Node]`, `[Java]`, `[Rust]` in the title, or infer from changed files) -3. **For scoped tags** (e.g., `java/v*`, `rust/v*`): only include changes that touch the corresponding language directory (`java/`, `rust/`). Ignore changes to other languages unless they directly affect the scoped SDK. -4. Ignore: +3. Ignore: - Dependabot/bot PRs that only bump internal dependencies (like `Update @github/copilot to ...`) unless they bring user-facing changes - Merge commits with no meaningful content - Preview/prerelease-only changes that were already documented @@ -80,6 +79,10 @@ Separate the changes into two groups: 1. **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. 2. **Other changes**: Bug fixes, minor improvements, and smaller features that can be summarized in a single bullet each. +**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). Cover all six SDKs—TypeScript, C#, Go, Python, Java, and Rust—in the combined release notes. Show code examples in the languages whose APIs best illustrate the change, and ensure every user-visible language-specific change appears either as a highlighted feature or under other changes. + +**Format for other changes** — use 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.** + Only 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. Additionally, 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. @@ -89,11 +92,7 @@ Additionally, identify **new contributors** — anyone whose first merged PR to **Skip this step entirely for prerelease releases.** 1. Read the current `CHANGELOG.md` file. -2. Add the new version entry **at the top** of the file, right after the title/header. Use the **full tag** as the version in the heading — e.g., `## [v0.2.3](...)` for unscoped tags, `## [java/v1.0.0](...)` for Java-scoped tags, `## [rust/v0.2.3](...)` for Rust-scoped tags. - -**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). For unscoped releases, 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. For **scoped releases** (e.g., `java/v*`), show code snippets in the scoped language only (e.g., Java for `java/v*`, Rust for `rust/v*`). - -**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. +2. Add the new version entry **at the top** of the file, right after the title/header. Use the full tag as the version in the heading, for example `## [v1.0.0](...)`. 3. 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. 4. If there are new contributors, add a `### New contributors` section at the end listing each with a link to their first PR: @@ -117,11 +116,6 @@ Use the `create-pull-request` output to submit your changes. The PR should: Use 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. -**IMPORTANT — Preserving the Installation section:** -The release body may contain an Installation section delimited by `` and `` HTML comments. In the case of Java, this section includes Maven/Gradle dependency snippets and a "View on Maven Central" link. You **MUST** preserve this entire section (from the opening comment through the closing comment, inclusive) exactly as it appears in the existing release body. Place your generated changelog content **after** the Installation section. - -**URL reconstruction:** If the Maven Central URL in the Installation section appears corrupted or contains the word "redacted", reconstruct it. Extract the version from the release tag (e.g., `java/v1.0.0` → `1.0.0`), and rebuild the URL as: `https://central.sonatype.com/artifact/com.github/copilot-sdk-java/{VERSION}`. The `` HTML comment in the section contains the intended URL pattern. - ## Example Output Here is an example of what a changelog entry should look like, based on real commits from this repo. **Follow this style exactly.** @@ -153,6 +147,8 @@ While `session.rpc.models.setModel()` already worked, there is now a convenience - C#: `session.SetModel("gpt-4o")` - Python: `session.set_model("gpt-4o")` - Go: `session.SetModel("gpt-4o")` +- Java: `session.setModel("gpt-4o").get()` +- Rust: `session.set_model("gpt-4o", None).await?` ### Other changes @@ -170,7 +166,7 @@ While `session.rpc.models.setModel()` already worked, there is now a convenience **Key rules visible in the example:** - Highlighted features get their own `### Feature:` heading, a short description, and code snippets -- Code snippets are TypeScript and C# primarily; Go/Python only when listing one-liner equivalents or when meaningfully different +- Code snippets use whichever of TypeScript, C#, Go, Python, Java, and Rust best illustrate the change; list all affected languages when showing equivalents - The `### Other changes` section is a flat bulleted list with lowercase `bugfix:` / `feature:` / `improvement:` prefixes - PR numbers are linked inline, not at the end with author attribution (keep it clean) diff --git a/.github/workflows/required-checks.yml b/.github/workflows/required-checks.yml new file mode 100644 index 000000000..dbd79fd4c --- /dev/null +++ b/.github/workflows/required-checks.yml @@ -0,0 +1,181 @@ +name: "SDK" + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + merge_group: + workflow_dispatch: + +permissions: + contents: read + pull-requests: read + +jobs: + changes: + name: Select SDK workflows + runs-on: ubuntu-latest + outputs: + nodejs: ${{ steps.select.outputs.nodejs }} + python: ${{ steps.select.outputs.python }} + go: ${{ steps.select.outputs.go }} + dotnet: ${{ steps.select.outputs.dotnet }} + java: ${{ steps.select.outputs.java }} + rust: ${{ steps.select.outputs.rust }} + steps: + - name: Detect changed paths + id: filter + if: github.event_name == 'pull_request' + uses: dorny/paths-filter@6852f92c20ea7fd3b0c25de3b5112db3a98da050 # v3 + with: + predicate-quantifier: every + filters: | + orchestrator: + - '.github/workflows/required-checks.yml' + nodejs: + - '{nodejs/**,test/**,.github/workflows/nodejs-sdk-tests.yml}' + - '!nodejs/scripts/**' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + python: + - '{python/**,test/**,nodejs/package.json,.github/workflows/python-sdk-tests.yml}' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + go: + - '{go/**,test/**,nodejs/package.json,.github/workflows/go-sdk-tests.yml,.github/actions/setup-copilot/**}' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + dotnet: + - '{dotnet/**,test/**,nodejs/package.json,.github/workflows/dotnet-sdk-tests.yml}' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + java: + - '{java/**,test/**,.github/workflows/java-sdk-tests.yml,.github/actions/setup-copilot/**,.github/actions/java-test-report/**}' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + rust: + - '{rust/**,test/**,nodejs/package.json,.github/workflows/rust-sdk-tests.yml,.github/actions/setup-copilot/**}' + - '!**/*.md' + - '!**/LICENSE*' + - '!**/.gitignore' + - '!**/.editorconfig' + - '!**/*.{png,jpg,jpeg,gif,svg}' + + - name: Select workflows + id: select + env: + EVENT_NAME: ${{ github.event_name }} + ORCHESTRATOR_CHANGED: ${{ steps.filter.outputs.orchestrator }} + NODEJS_CHANGED: ${{ steps.filter.outputs.nodejs }} + PYTHON_CHANGED: ${{ steps.filter.outputs.python }} + GO_CHANGED: ${{ steps.filter.outputs.go }} + DOTNET_CHANGED: ${{ steps.filter.outputs.dotnet }} + JAVA_CHANGED: ${{ steps.filter.outputs.java }} + RUST_CHANGED: ${{ steps.filter.outputs.rust }} + run: | + if [[ "$EVENT_NAME" != "pull_request" || "$ORCHESTRATOR_CHANGED" == "true" ]]; then + for workflow in nodejs python go dotnet java rust; do + echo "$workflow=true" >> "$GITHUB_OUTPUT" + done + exit 0 + fi + + echo "nodejs=${NODEJS_CHANGED:-false}" >> "$GITHUB_OUTPUT" + echo "python=${PYTHON_CHANGED:-false}" >> "$GITHUB_OUTPUT" + echo "go=${GO_CHANGED:-false}" >> "$GITHUB_OUTPUT" + echo "dotnet=${DOTNET_CHANGED:-false}" >> "$GITHUB_OUTPUT" + echo "java=${JAVA_CHANGED:-false}" >> "$GITHUB_OUTPUT" + echo "rust=${RUST_CHANGED:-false}" >> "$GITHUB_OUTPUT" + + nodejs: + needs: changes + if: needs.changes.outputs.nodejs == 'true' + uses: ./.github/workflows/nodejs-sdk-tests.yml + secrets: inherit + + python: + needs: changes + if: needs.changes.outputs.python == 'true' + uses: ./.github/workflows/python-sdk-tests.yml + secrets: inherit + + go: + needs: changes + if: needs.changes.outputs.go == 'true' + uses: ./.github/workflows/go-sdk-tests.yml + secrets: inherit + + dotnet: + needs: changes + if: needs.changes.outputs.dotnet == 'true' + uses: ./.github/workflows/dotnet-sdk-tests.yml + secrets: inherit + + java: + needs: changes + if: needs.changes.outputs.java == 'true' + uses: ./.github/workflows/java-sdk-tests.yml + + rust: + needs: changes + if: needs.changes.outputs.rust == 'true' + uses: ./.github/workflows/rust-sdk-tests.yml + secrets: inherit + + required: + name: "${{ matrix.name }} required" + if: always() + needs: [changes, nodejs, python, go, dotnet, java, rust] + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - key: nodejs + name: Node.js + - key: python + name: Python + - key: go + name: Go + - key: dotnet + name: .NET + - key: java + name: Java + - key: rust + name: Rust + steps: + - name: Verify SDK workflow + env: + KEY: ${{ matrix.key }} + SELECTIONS: ${{ toJSON(needs.changes.outputs) }} + RESULTS: ${{ toJSON(needs) }} + run: | + selected=$(jq -r --arg key "$KEY" '.[$key]' <<< "$SELECTIONS") + result=$(jq -r --arg key "$KEY" '.[$key].result' <<< "$RESULTS") + + if [[ "$selected" == "true" && "$result" == "success" ]]; then + echo "$KEY SDK checks succeeded." + exit 0 + fi + + if [[ "$selected" == "false" && "$result" == "skipped" ]]; then + echo "$KEY SDK checks were not required." + exit 0 + fi + + echo "::error::$KEY SDK checks were selected=$selected with result=$result." + exit 1 diff --git a/.github/workflows/rust-sdk-tests.yml b/.github/workflows/rust-sdk-tests.yml index 23e686eb7..7fdac3b81 100644 --- a/.github/workflows/rust-sdk-tests.yml +++ b/.github/workflows/rust-sdk-tests.yml @@ -4,32 +4,15 @@ on: push: branches: - main - pull_request: - types: [opened, synchronize, reopened, ready_for_review] - paths: - - 'rust/**' - - 'test/**' - - 'nodejs/package.json' - - '.github/workflows/rust-sdk-tests.yml' - - '.github/actions/setup-copilot/**' - - '!**/*.md' - - '!**/LICENSE*' - - '!**/.gitignore' - - '!**/.editorconfig' - - '!**/*.png' - - '!**/*.jpg' - - '!**/*.jpeg' - - '!**/*.gif' - - '!**/*.svg' workflow_dispatch: - merge_group: + workflow_call: permissions: contents: read jobs: test: - name: "Rust SDK Tests" + name: "Rust SDK Tests (${{ matrix.os }}, default)" if: github.event.repository.fork == false env: POWERSHELL_UPDATECHECK: Off @@ -84,7 +67,7 @@ jobs: # Share the bundled-CLI archive cache with the `bundle` job: build.rs # now downloads in both modes (embed for `bundle`, extract-to-cache # for this `test` job's `--no-default-features` build). - - name: Cache bundled CLI tarball + - name: Cache bundled CLI archives uses: actions/cache@v4 with: path: ./rust/.bundled-cli-cache @@ -98,7 +81,7 @@ jobs: if: runner.os == 'Linux' env: BUNDLED_CLI_CACHE_DIR: ${{ github.workspace }}/rust/.bundled-cli-cache - run: cargo clippy --all-targets --features test-support -- --no-deps -D warnings -D clippy::unwrap_used -D clippy::disallowed_macros -D clippy::await_holding_invalid_type + run: cargo clippy --all-targets --features test-support,bundled-in-process -- --no-deps -D warnings -D clippy::unwrap_used -D clippy::disallowed_macros -D clippy::await_holding_invalid_type - name: cargo doc if: runner.os == 'Linux' @@ -129,6 +112,84 @@ jobs: # The dedicated `bundle` job below exercises the embed pipeline. run: cargo test --no-default-features --features test-support -- --test-threads=4 --nocapture + # Exercises the in-process FFI transport (`Transport::InProcess`, the Rust + # analogue of the .NET `RuntimeConnection.ForInProcess()`), mirroring the + # `inprocess` transport cell in dotnet-sdk-tests.yml. Sets + # COPILOT_SDK_DEFAULT_CONNECTION=inprocess so the client hosts the runtime + # cdylib in-process instead of spawning a stdio child, then runs the whole + # E2E suite over the in-process transport. The suite runs serially in-process + # (the harness forces concurrency to 1) because it mirrors each test's + # environment onto the shared process environment the in-process worker inherits. + # Runs the whole E2E suite over the in-process transport on supported hosts. + test-inprocess: + name: "Rust SDK Tests (${{ matrix.os }}, inprocess)" + if: github.event.repository.fork == false + env: + CARGO_TERM_COLOR: always + RUST_BACKTRACE: 1 + strategy: + fail-fast: false + matrix: + # TODO: Re-enable Windows after fixing the napi-oop peer shutdown crash. + os: [ubuntu-latest, macos-latest] + runs-on: ${{ matrix.os }} + defaults: + run: + shell: bash + working-directory: ./rust + steps: + - uses: actions/checkout@v6.0.2 + + - uses: ./.github/actions/setup-copilot + id: setup-copilot + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30 # stable + with: + toolchain: "1.94.0" + + - uses: Swatinem/rust-cache@42dc69e1aa15d09112580998cf2ef0119e2e91ae # v2 + with: + workspaces: "rust" + prefix-key: v1-rust-no-bin + cache-bin: false + + - name: Read pinned @github/copilot CLI version + id: cli-version + working-directory: ./nodejs + run: | + version=$(node -p "require('./package-lock.json').packages['node_modules/@github/copilot'].version") + echo "version=$version" >> "$GITHUB_OUTPUT" + echo "Pinned CLI version: $version" + + - name: Cache bundled CLI archives + uses: actions/cache@v4 + with: + path: ./rust/.bundled-cli-cache + key: bundled-cli-${{ matrix.os }}-${{ steps.cli-version.outputs.version }} + + - name: Install test harness dependencies + working-directory: ./test/harness + run: npm ci --ignore-scripts + + - name: Warm up PowerShell + if: runner.os == 'Windows' + run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + + - name: Select in-process transport + run: echo "COPILOT_SDK_DEFAULT_CONNECTION=inprocess" >> "$GITHUB_ENV" + + - name: cargo test (in-process transport, full E2E suite) + timeout-minutes: 60 + env: + COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} + COPILOT_CLI_PATH: ${{ steps.setup-copilot.outputs.cli-path }} + BUNDLED_CLI_CACHE_DIR: ${{ github.workspace }}/rust/.bundled-cli-cache + # The harness forces serial execution in-process (both the async semaphore and + # libtest via --test-threads=1) because it mirrors each test's environment onto + # the shared process environment, so RUST_E2E_CONCURRENCY is not set here. + run: cargo test --no-default-features --features test-support,bundled-in-process --test e2e -- --test-threads=1 --nocapture + # Validates the bundled-CLI build path on all three supported # platforms. While the regular `cargo test` job above also exercises # build.rs (bundling is on by default now), this matrix job is the @@ -136,7 +197,7 @@ jobs: # extract / embed pipeline. Catches regressions before they ship to # crates.io and before bundling consumers hit them downstream. bundle: - name: "Rust SDK Bundled CLI Build" + name: "Rust SDK Bundled CLI Build (${{ matrix.os }})" if: github.event.repository.fork == false env: CARGO_TERM_COLOR: always @@ -159,6 +220,9 @@ jobs: toolchain: "1.94.0" - uses: Swatinem/rust-cache@v2 + # Cache is only an optimization; the Windows bundled smoke test should + # not fail when rust-cache's post-job save flakes after a successful build. + continue-on-error: ${{ runner.os == 'Windows' }} with: workspaces: "rust" key: bundled-cli @@ -177,13 +241,15 @@ jobs: # ~130 MB on every CI invocation. Keyed by OS + CLI version so old # archives drop out when the pinned version bumps, keeping the # cache bounded. - - name: Cache bundled CLI tarball + - name: Cache bundled CLI archives uses: actions/cache@v4 with: path: ./rust/.bundled-cli-cache key: bundled-cli-${{ matrix.os }}-${{ steps.cli-version.outputs.version }} - - name: cargo build (bundled-cli is the default feature) + - name: Test bundled CLI build paths env: BUNDLED_CLI_CACHE_DIR: ${{ github.workspace }}/rust/.bundled-cli-cache - run: cargo build + run: | + cargo build + cargo test --features bundled-in-process --lib embedded_archive_contains_only_expected_files diff --git a/.github/workflows/sdk-canary.yml b/.github/workflows/sdk-canary.yml new file mode 100644 index 000000000..95f8b1c92 --- /dev/null +++ b/.github/workflows/sdk-canary.yml @@ -0,0 +1,391 @@ +name: "SDK Canary Test/Publish" + +# Nightly-style canary pipeline. First installs an explicit version of the +# @github/copilot runtime, builds the Node SDK, and runs the Node e2e suite +# against it to prove runtime <-> SDK compatibility. When that gate passes (and +# mode allows), publishes an SDK canary pinned to the tested runtime to the +# internal Azure Artifacts feed only (never public npm). + +env: + HUSKY: 0 + # Internal org-scoped Azure Artifacts feed — single source of truth so the + # feed name isn't repeated across steps. The SDK canary publishes here and + # (when runtime_source=internal) installs the runtime from here; it must NEVER + # reach public npm (@github/copilot-sdk is a live public package). + FEED_URL: https://pkgs.dev.azure.com/devdiv/_packaging/copilot-canary/npm/registry/ + # Azure DevOps resource ID used to mint an ADO access token for the feed. + ADO_RESOURCE: 499b84ac-1321-427f-aa17-267ca6975798 + +on: + workflow_dispatch: + inputs: + runtime_version: + description: "Exact @github/copilot version to test (e.g. 1.0.69 or 1.0.70-canary.)" + required: true + type: string + runtime_source: + description: "Where to install the runtime from" + required: true + type: choice + options: + - public + - internal + default: public + mode: + description: "publish (tests must pass), publish-force (publish even if tests fail), or tests-only (run gate, never publish)" + required: false + type: choice + default: publish + options: + - publish + - publish-force + - tests-only + repository_dispatch: + types: [runtime-canary] + +permissions: + contents: read + id-token: write + +# Serialize runs per ref so two overlapping canary runs can't race the feed +# publish. cancel-in-progress: false — never kill an in-flight publish. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: false + +jobs: + resolve: + name: "Resolve runtime inputs" + if: github.event.repository.fork == false + runs-on: ubuntu-latest + permissions: {} + outputs: + RUNTIME_VERSION: ${{ steps.normalize.outputs.RUNTIME_VERSION }} + RUNTIME_SOURCE: ${{ steps.normalize.outputs.RUNTIME_SOURCE }} + PUBLISH_MODE: ${{ steps.normalize.outputs.PUBLISH_MODE }} + steps: + # Normalize whichever trigger fired into a single (RUNTIME_VERSION, + # RUNTIME_SOURCE, PUBLISH_MODE) triple that every downstream step + # references. workflow_dispatch reads the human-supplied inputs; + # repository_dispatch reads client_payload and forces source=internal + # (a runtime canary only exists on the feed), defaulting mode to publish. + - name: Normalize inputs + id: normalize + env: + EVENT_NAME: ${{ github.event_name }} + INPUT_VERSION: ${{ inputs.runtime_version }} + INPUT_SOURCE: ${{ inputs.runtime_source }} + INPUT_MODE: ${{ inputs.mode }} + PAYLOAD_VERSION: ${{ github.event.client_payload.runtime_version }} + PAYLOAD_SOURCE: ${{ github.event.client_payload.runtime_source }} + PAYLOAD_MODE: ${{ github.event.client_payload.mode }} + run: | + set -euo pipefail + case "$EVENT_NAME" in + workflow_dispatch) + VERSION="$INPUT_VERSION" + SOURCE="$INPUT_SOURCE" + MODE="$INPUT_MODE" + ;; + repository_dispatch) + VERSION="$PAYLOAD_VERSION" + # A runtime canary only ever exists on the internal feed. + SOURCE="${PAYLOAD_SOURCE:-internal}" + MODE="${PAYLOAD_MODE:-publish}" + ;; + *) + echo "::error::Unsupported event '$EVENT_NAME'." + exit 1 + ;; + esac + if [ -z "$VERSION" ]; then echo "::error::Could not determine runtime version."; exit 1; fi + if [ -z "$SOURCE" ]; then SOURCE="public"; fi + case "$SOURCE" in + public|internal) ;; + *) echo "::error::Invalid runtime source '$SOURCE'. Expected one of: public, internal."; exit 1 ;; + esac + if [ -z "$MODE" ]; then MODE="publish"; fi + case "$MODE" in + publish|publish-force|tests-only) ;; + *) echo "::error::Invalid publish mode '$MODE'. Expected one of: publish, publish-force, tests-only."; exit 1 ;; + esac + echo "Resolved RUNTIME_VERSION=$VERSION RUNTIME_SOURCE=$SOURCE PUBLISH_MODE=$MODE" + echo "RUNTIME_VERSION=$VERSION" >> "$GITHUB_OUTPUT" + echo "RUNTIME_SOURCE=$SOURCE" >> "$GITHUB_OUTPUT" + echo "PUBLISH_MODE=$MODE" >> "$GITHUB_OUTPUT" + + - name: Validate runtime version (semver) + env: + RUNTIME_VERSION: ${{ steps.normalize.outputs.RUNTIME_VERSION }} + run: | + if [[ ! "$RUNTIME_VERSION" =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ ]]; then + echo "::error::Invalid runtime version '$RUNTIME_VERSION'. Expected semver (e.g. 1.0.69 or 1.0.70-canary.abc123)." + exit 1 + fi + + test: + name: "E2E tests (${{ matrix.os }})" + needs: resolve + if: github.event.repository.fork == false + environment: cicd + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + runs-on: ${{ matrix.os }} + env: + POWERSHELL_UPDATECHECK: Off + RUNTIME_VERSION: ${{ needs.resolve.outputs.RUNTIME_VERSION }} + RUNTIME_SOURCE: ${{ needs.resolve.outputs.RUNTIME_SOURCE }} + defaults: + run: + shell: bash + working-directory: ./nodejs + steps: + - uses: actions/checkout@v6.0.2 + + - uses: actions/setup-node@v6 + with: + cache: "npm" + cache-dependency-path: "./nodejs/package-lock.json" + node-version: 22 + + - name: Install SDK dependencies + run: npm ci --ignore-scripts + + - name: Install test harness dependencies + working-directory: ./test/harness + run: npm ci --ignore-scripts + + - name: Azure Login (OIDC -> id-cpd-ci) + if: env.RUNTIME_SOURCE == 'internal' + uses: azure/login@532459ea530d8321f2fb9bb10d1e0bcf23869a43 # v3.0.0 + with: + client-id: "${{ vars.CPD_ID_CLIENT_ID }}" # id-cpd-ci + tenant-id: "${{ vars.CPD_ID_TENANT_ID }}" + allow-no-subscriptions: true + + # Route ONLY @github/* (the runtime + its 8 platform packages) to the + # internal feed via a scoped registry. All other deps (e.g. detect-libc) + # still resolve from public npm. A global --registry would break because + # detect-libc is not on the feed. + - name: Configure canary feed (.npmrc) + if: env.RUNTIME_SOURCE == 'internal' + run: | + set -euo pipefail + TOKEN="$(az account get-access-token --resource "$ADO_RESOURCE" --query accessToken -o tsv)" + echo "::add-mask::$TOKEN" + # Derive the protocol-relative auth scopes from FEED_URL so the feed + # name lives in exactly one place (the workflow-level env). + FEED_AUTH_REGISTRY="${FEED_URL#https:}" + FEED_AUTH_BASE="${FEED_AUTH_REGISTRY%registry/}" + NPMRC="$(printf '%s\n' \ + "@github:registry=${FEED_URL}" \ + "${FEED_AUTH_REGISTRY}:_authToken=${TOKEN}" \ + "${FEED_AUTH_BASE}:_authToken=${TOKEN}")" + printf '%s\n' "$NPMRC" > .npmrc + echo "Wrote scoped @github registry .npmrc to ./nodejs" + + - name: Override runtime version + run: | + set -euo pipefail + echo "Installing @github/copilot@${RUNTIME_VERSION} (source: ${RUNTIME_SOURCE})" + npm install "@github/copilot@${RUNTIME_VERSION}" --save-exact --ignore-scripts + + - name: Verify installed runtime + run: | + set -euo pipefail + node -e ' + const fs = require("fs"); + const expected = process.env.RUNTIME_VERSION; + const pkg = require("./node_modules/@github/copilot/package.json"); + if (pkg.version !== expected) { + console.error(`::error::Installed @github/copilot version ${pkg.version} does not match requested ${expected}`); + process.exit(1); + } + const dir = "./node_modules/@github"; + const entries = fs.readdirSync(dir).filter((d) => d.startsWith("copilot-")); + const plat = process.platform === "win32" ? "win32" : process.platform === "darwin" ? "darwin" : "linux"; + const arch = process.arch; + const match = entries.find((d) => d.includes(plat) && d.includes(arch)); + if (!match) { + console.error(`::error::No @github/copilot platform optional dep for ${plat}-${arch}. Present: ${entries.join(", ") || "(none)"}`); + process.exit(1); + } + const platPkg = require(`${dir}/${match}/package.json`); + if (platPkg.version !== expected) { + console.error(`::error::Platform package @github/${match} version ${platPkg.version} does not match requested ${expected}`); + process.exit(1); + } + console.log(`Verified @github/copilot@${pkg.version} with platform package @github/${match}@${platPkg.version}`); + ' + + - name: Build SDK + run: npm run build + + - name: Warm up PowerShell + if: runner.os == 'Windows' + run: pwsh.exe -Command "Write-Host 'PowerShell ready'" + + - name: Run Node.js SDK e2e tests + env: + COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }} + run: npm test + + publish: + name: "Publish SDK canary (internal feed)" + needs: [resolve, test] + # Publish runs only when the gate permits it. Mode governs behavior: + # - tests-only: never publish (skips this job entirely). + # - publish: publish only when the e2e gate is green (the default for both + # the human and automated triggers). + # - publish-force: publish even on a non-green gate — a human-acknowledged + # flake override, audited via the ::warning:: step below and the run actor. + # publish-force only skips the e2e *signal* — the publish job still runs the + # build (so a broken build can't publish) and enforces the feed-only guards. + if: > + !cancelled() && + github.event.repository.fork == false && + needs.resolve.result == 'success' && + needs.resolve.outputs.PUBLISH_MODE != 'tests-only' && + (needs.test.result == 'success' || + needs.resolve.outputs.PUBLISH_MODE == 'publish-force') + environment: cicd + runs-on: ubuntu-latest + permissions: + contents: read + id-token: write + env: + RUNTIME_VERSION: ${{ needs.resolve.outputs.RUNTIME_VERSION }} + defaults: + run: + shell: bash + working-directory: ./nodejs + steps: + - name: Warn — publishing despite failed e2e gate (publish-force) + # always() so this audit is never skipped by prior-step status; it fires + # specifically when publish proceeded on a non-green gate via publish-force. + # Runs at the workspace root because it executes before checkout, so the + # job's default working-directory (./nodejs) does not exist yet. + if: always() && needs.test.result != 'success' && needs.resolve.outputs.PUBLISH_MODE == 'publish-force' + working-directory: ${{ github.workspace }} + run: | + echo "::warning title=e2e gate bypassed::Publishing SDK canary despite a non-passing e2e gate (test job result: ${{ needs.test.result }}) via publish-force. Triggered by '${{ github.actor }}' through '${{ github.event_name }}'. The e2e signal was bypassed; build + feed-only guards still apply." + + - uses: actions/checkout@v6.0.2 + + - uses: actions/setup-node@v6 + with: + node-version: 22 + + # Default public registry: installs build deps and the currently pinned + # runtime. Do NOT write any feed .npmrc or scoped @github:registry line + # here, or npm ci would try to fetch the runtime from the upstream-less + # feed and 404. + - name: Install SDK dependencies + run: npm ci --ignore-scripts + + - name: Compute SDK canary version + id: sdkver + env: + RUN_NUMBER: ${{ github.run_number }} + SHA: ${{ github.sha }} + run: | + set -euo pipefail + SHORT_SHA="${SHA:0:7}" + # Base the canary on the NEXT patch of the public SDK latest so canaries + # correlate with public releases: they sort ABOVE the current public + # latest and BELOW the eventual real release of that next patch (a + # prerelease of X.Y.Z always sorts below X.Y.Z), so a canary can never + # shadow the real release when it ships. + # Reuse the repo's own version helper (scripts/get-version.js) so this + # stays consistent with publish.yml: `current` returns the latest public + # dist-tag version, read-only from public npm (never the feed), then + # we bump the patch ourselves to keep strict patch+1 semantics. + PUBLIC_LATEST="$(node scripts/get-version.js current || true)" + BASE="${PUBLIC_LATEST%%-*}"; BASE="${BASE%%+*}" + if [[ "$BASE" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then + NEXT="${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.$(( BASH_REMATCH[3] + 1 ))" + else + echo "::error::Could not resolve public SDK latest version (got '$PUBLIC_LATEST'); refusing to publish a canary with an unknown base." + exit 1 + fi + SDK_VERSION="${NEXT}-canary.${RUN_NUMBER}.g${SHORT_SHA}" + if [[ ! "$SDK_VERSION" =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ ]]; then + echo "::error::Computed SDK canary version '$SDK_VERSION' is not valid semver." + exit 1 + fi + echo "SDK canary version: $SDK_VERSION" + echo "SDK_VERSION=$SDK_VERSION" >> "$GITHUB_OUTPUT" + + - name: Set package version and pin runtime dependency + env: + SDK_VERSION: ${{ steps.sdkver.outputs.SDK_VERSION }} + run: | + set -euo pipefail + npm version "$SDK_VERSION" --no-git-tag-version --allow-same-version + # Exact pin (no caret) so the published SDK canary depends on precisely + # the runtime version that was just tested by the e2e gate. + npm pkg set "dependencies.@github/copilot=$RUNTIME_VERSION" + echo "Pinned @github/copilot to $(npm pkg get dependencies.@github/copilot)" + + - name: Build SDK + run: npm run build + + - name: Azure Login (OIDC -> id-cpd-ci) + uses: azure/login@532459ea530d8321f2fb9bb10d1e0bcf23869a43 # v3.0.0 + with: + client-id: "${{ vars.CPD_ID_CLIENT_ID }}" # id-cpd-ci + tenant-id: "${{ vars.CPD_ID_TENANT_ID }}" + allow-no-subscriptions: true + + # Auth-only .npmrc: just the two token lines, NO scoped registry line. + # The publish target is supplied explicitly via publishConfig + --registry. + - name: Configure feed auth (.npmrc) + run: | + set -euo pipefail + TOKEN="$(az account get-access-token --resource "$ADO_RESOURCE" --query accessToken -o tsv)" + echo "::add-mask::$TOKEN" + # Derive the protocol-relative auth scopes from FEED_URL (single source + # of truth). NO scoped @github:registry line here — publish target is + # supplied explicitly via publishConfig + --registry. + FEED_AUTH_REGISTRY="${FEED_URL#https:}" + FEED_AUTH_BASE="${FEED_AUTH_REGISTRY%registry/}" + printf '%s\n' \ + "${FEED_AUTH_REGISTRY}:_authToken=${TOKEN}" \ + "${FEED_AUTH_BASE}:_authToken=${TOKEN}" > .npmrc + echo "Wrote auth-only .npmrc to ./nodejs" + + # Belt and suspenders (2 of 3): pin the publish target in the package too. + - name: Set publishConfig registry + run: npm pkg set "publishConfig.registry=$FEED_URL" + + # Belt and suspenders (3 of 3): fail loudly unless the effective publish + # target is the internal feed. Guards against ever reaching public npm. + - name: Assert publish target is the internal feed + run: | + set -euo pipefail + EFFECTIVE="$(npm pkg get publishConfig.registry | tr -d '"')" + echo "Effective publishConfig.registry: $EFFECTIVE" + if [ "$EFFECTIVE" != "$FEED_URL" ]; then + echo "::error::publishConfig.registry ('$EFFECTIVE') is not the internal feed ('$FEED_URL'). Refusing to publish." + exit 1 + fi + + - name: Publish SDK canary to internal feed + run: npm publish --registry "$FEED_URL" + + - name: Summarize published canary + env: + SDK_VERSION: ${{ steps.sdkver.outputs.SDK_VERSION }} + run: | + set -euo pipefail + { + echo "## SDK canary published" + echo "" + echo "| | |" + echo "| --- | --- |" + echo "| Runtime consumed | \`@github/copilot@${RUNTIME_VERSION}\` |" + echo "| Canary SDK produced | \`@github/copilot-sdk@${SDK_VERSION}\` |" + echo "| Feed | ${FEED_URL} |" + } >> "$GITHUB_STEP_SUMMARY" diff --git a/.github/workflows/sdk-consistency-review.lock.yml b/.github/workflows/sdk-consistency-review.lock.yml index 4aebf32ed..bc33be9ad 100644 --- a/.github/workflows/sdk-consistency-review.lock.yml +++ b/.github/workflows/sdk-consistency-review.lock.yml @@ -1,20 +1,21 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"b1f707a5df4bab2e9be118c097a5767ac0b909cf3ee1547f71895c5b33ca342d","compiler_version":"v0.74.4","strict":true,"agent_id":"copilot"} -# 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":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"d3abfe96a194bce3a523ed2093ddedd5704cdf62","version":"v0.74.4"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.25.46"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.9","digest":"sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388"},{"image":"ghcr.io/github/github-mcp-server:v1.0.4"},{"image":"node:lts-alpine","digest":"sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f","pinned_image":"node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f"}]} -# ___ _ _ -# / _ \ | | (_) -# | |_| | __ _ ___ _ __ | |_ _ ___ +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"fb73d13f101fc375308576a64180f63934cc9e8306cb6ef6303f1b9788d9df28","body_hash":"cc60c817de34cdb662ae4c091203c67a5ef240ca0165b0cd26a842f03b22614f","compiler_version":"v0.83.1","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"373c709c69115d41ff229c7e5df9f8788daa9553","version":"v9"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"8bdba8075360648fe6802302a5b4e016361dc6ac","version":"v0.83.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38","digest":"sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38","digest":"sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38","digest":"sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}],"has_pull_request":true} +# This file was automatically generated by gh-aw (v0.83.1). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md +# +# ___ _ _ +# / _ \ | | (_) +# | |_| | __ _ ___ _ __ | |_ _ ___ # | _ |/ _` |/ _ \ '_ \| __| |/ __| -# | | | | (_| | __/ | | | |_| | (__ +# | | | | (_| | __/ | | | |_| | (__ # \_| |_/\__, |\___|_| |_|\__|_|\___| # __/ | -# _ _ |___/ +# _ _ |___/ # | | | | / _| | # | | | | ___ _ __ _ __| |_| | _____ ____ # | |/\| |/ _ \ '__| |/ /| _| |/ _ \ \ /\ / / ___| # \ /\ / (_) | | | | ( | | | | (_) \ V V /\__ \ # \/ \/ \___/|_| |_|\_\|_| |_|\___/ \_/\_/ |___/ # -# This file was automatically generated by gh-aw (v0.74.4). DO NOT EDIT. # # To update this file, edit the corresponding .md file and run: # gh aw compile @@ -31,40 +32,47 @@ # - GITHUB_TOKEN # # Custom actions used: -# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 +# - actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 +# - actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 # - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 +# - actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 # - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 -# - actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) -# - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 +# - actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 # - actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 -# - github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 +# - github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 # # Container images used: -# - ghcr.io/github/gh-aw-firewall/agent:0.25.46 -# - ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 -# - ghcr.io/github/gh-aw-firewall/squid:0.25.46 -# - ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 -# - ghcr.io/github/github-mcp-server:v1.0.4 -# - node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f +# - ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 +# - ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c +# - ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 +# - ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 +# - ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b +# - ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 name: "SDK Consistency Review Agent" on: pull_request: paths: - - nodejs/** - - python/** - - go/** - - dotnet/** + - nodejs/** + - python/** + - go/** + - dotnet/** + - java/** + - "!java/docs/**" + - "!java/*.txt" + - "!java/*.md" types: - - opened - - synchronize - - reopened + - opened + - synchronize + - reopened # roles: all # Roles processed as role check in pre-activation job workflow_dispatch: inputs: aw_context: default: "" - description: Agent caller context (used internally by Agentic Workflows). + description: "Agent caller context (used internally by Agentic Workflows)." required: false type: string pr_number: @@ -87,14 +95,20 @@ jobs: permissions: actions: read contents: read + env: + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: body: ${{ steps.sanitized.outputs.body }} comment_id: "" comment_repo: "" + daily_ai_credits_exceeded: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_exceeded == 'true' }} + daily_ai_credits_threshold: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_threshold || '' }} + daily_ai_credits_total_effective_tokens: ${{ steps.daily-effective-workflow-guardrail.outputs.daily_ai_credits_total_effective_tokens || '' }} engine_id: ${{ steps.generate_aw_info.outputs.engine_id }} lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }} model: ${{ steps.generate_aw_info.outputs.model }} - secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }} + oauth_token_check_failed: ${{ steps.check-oauth-tokens.outputs.oauth_token_check_failed == 'true' }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} @@ -104,31 +118,33 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} + safe-output-artifact-client: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/sdk-consistency-review.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Generate agentic run info id: generate_aw_info env: GH_AW_INFO_ENGINE_ID: "copilot" GH_AW_INFO_ENGINE_NAME: "GitHub Copilot CLI" - GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_INFO_VERSION: "1.0.48" - GH_AW_INFO_AGENT_VERSION: "1.0.48" - GH_AW_INFO_CLI_VERSION: "v0.74.4" + GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AGENT_VERSION: "1.0.73" + GH_AW_INFO_CLI_VERSION: "v0.83.1" GH_AW_INFO_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_INFO_EXPERIMENTAL: "false" GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: "true" GH_AW_INFO_STAGED: "false" GH_AW_INFO_ALLOWED_DOMAINS: '["defaults"]' GH_AW_INFO_FIREWALL_ENABLED: "true" - GH_AW_INFO_AWF_VERSION: "v0.25.46" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_AWMG_VERSION: "" GH_AW_INFO_FIREWALL_TYPE: "squid" GH_AW_COMPILED_STRICT: "true" @@ -139,21 +155,67 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs'); await main(core, context); - - name: Validate COPILOT_GITHUB_TOKEN secret - id: validate-secret - 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 + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-sdkconsistencyreview-${{ github.run_id }} + restore-keys: agentic-workflow-usage-sdkconsistencyreview- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Restore daily AIC usage cache (artifact fallback) + id: restore-daily-aic-cache-fallback + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_RESTORE_DAILY_AIC_CACHE_HIT: ${{ steps.restore-daily-aic-cache.outputs.cache-hit }} + GH_AW_RESTORE_DAILY_AIC_CACHE_MATCHED_KEY: ${{ steps.restore-daily-aic-cache.outputs.cache-matched-key }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/restore_aic_usage_cache_fallback.cjs'); + await main(); + - name: Check daily workflow token guardrail + id: daily-effective-workflow-guardrail + if: ${{ env.GH_AW_MAX_DAILY_AI_CREDITS != '' }} + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_ID: "sdk-consistency-review" + GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + GH_AW_WORKFLOW_DISPATCH_AW_CONTEXT: ${{ github.event.inputs.aw_context || '' }} + GH_AW_HAS_SLASH_COMMAND: "false" + GH_AW_HAS_LABEL_COMMAND: "false" + GH_AW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_AW_MAX_DAILY_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS || '5000' }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/check_daily_aic_workflow_guardrail.cjs'); + await main(); + - name: Check for OAuth tokens + id: check-oauth-tokens + run: bash "${RUNNER_TEMP}/gh-aw/actions/check_oauth_tokens.sh" env: COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} + GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} - name: Checkout .github and .agents folders - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false sparse-checkout: | .github .agents + .antigravity .claude .codex - .crush .gemini .opencode .pi @@ -161,8 +223,8 @@ jobs: fetch-depth: 1 - name: Save agent config folders for base branch restoration env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" # poutine:ignore untrusted_checkout_exec run: bash "${RUNNER_TEMP}/gh-aw/actions/save_base_github_folders.sh" - name: Check workflow lock file @@ -180,7 +242,7 @@ jobs: - name: Check compile-agentic version uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: - GH_AW_COMPILED_VERSION: "v0.74.4" + GH_AW_COMPILED_VERSION: "v0.83.1" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -198,6 +260,9 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs'); await main(); + - name: Log runtime features + if: ${{ contains(toJSON(vars), '"GH_AW_RUNTIME_FEATURES":') }} + run: bash "${RUNNER_TEMP}/gh-aw/actions/log_runtime_features_summary.sh" - name: Create prompt with built-in context env: GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt @@ -211,24 +276,25 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} # poutine:ignore untrusted_checkout_exec run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF' + cat << 'GH_AW_PROMPT_96d45caa4ffc7593_EOF' - GH_AW_PROMPT_ba8cce6b4497d40e_EOF + GH_AW_PROMPT_96d45caa4ffc7593_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF' + cat << 'GH_AW_PROMPT_96d45caa4ffc7593_EOF' Tools: add_comment, create_pull_request_review_comment(max:10), missing_tool, missing_data, noop - GH_AW_PROMPT_ba8cce6b4497d40e_EOF + GH_AW_PROMPT_96d45caa4ffc7593_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF' + cat << 'GH_AW_PROMPT_96d45caa4ffc7593_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -256,13 +322,13 @@ jobs: - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__ {{/if}} - - GH_AW_PROMPT_ba8cce6b4497d40e_EOF + + GH_AW_PROMPT_96d45caa4ffc7593_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF' + cat << 'GH_AW_PROMPT_96d45caa4ffc7593_EOF' {{#runtime-import .github/workflows/sdk-consistency-review.md}} - GH_AW_PROMPT_ba8cce6b4497d40e_EOF + GH_AW_PROMPT_96d45caa4ffc7593_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -271,6 +337,7 @@ jobs: GH_AW_ENGINE_ID: "copilot" GH_AW_EXPR_A0E5D436: ${{ github.event.pull_request.number || inputs.pr_number }} GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -290,14 +357,15 @@ jobs: GH_AW_GITHUB_REPOSITORY: ${{ github.repository }} GH_AW_GITHUB_RUN_ID: ${{ github.run_id }} GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }} - GH_AW_MCP_CLI_SERVERS_LIST: '- `safeoutputs` — run `safeoutputs --help` to see available tools' + GH_AW_INPUTS_PR_NUMBER: ${{ inputs.pr_number }} + GH_AW_MCP_CLI_SERVERS_LIST: "- `github` — run `github --help` to see available tools\n- `safeoutputs` — run `safeoutputs --help` to see available tools" with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); setupGlobals(core, github, context, exec, io, getOctokit); - + const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs'); - + // Call the substitution function return await substitutePlaceholders({ file: process.env.GH_AW_PROMPT, @@ -311,6 +379,7 @@ jobs: GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY, GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID, GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE, + GH_AW_INPUTS_PR_NUMBER: process.env.GH_AW_INPUTS_PR_NUMBER, GH_AW_MCP_CLI_SERVERS_LIST: process.env.GH_AW_MCP_CLI_SERVERS_LIST } }); @@ -332,20 +401,24 @@ jobs: include-hidden-files: true path: | /tmp/gh-aw/aw_info.json + /tmp/gh-aw/models.json /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/aw-prompts/prompt-template.txt /tmp/gh-aw/aw-prompts/prompt-import-tree.json /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/base /tmp/gh-aw/.github/agents + /tmp/gh-aw/.github/skills if-no-files-found: ignore retention-days: 1 agent: needs: activation + if: needs.activation.outputs.daily_ai_credits_exceeded != 'true' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write issues: read pull-requests: read env: @@ -354,26 +427,32 @@ jobs: GH_AW_ASSETS_BRANCH: "" GH_AW_ASSETS_MAX_SIZE_KB: 0 GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} GH_AW_WORKFLOW_ID_SANITIZED: sdkconsistencyreview outputs: - agentic_engine_timeout: ${{ steps.detect-copilot-errors.outputs.agentic_engine_timeout || 'false' }} + agentic_engine_timeout: ${{ steps.detect-agent-errors.outputs.agentic_engine_timeout || 'false' }} + ai_credits_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.ai_credits_rate_limit_error || 'false' }} + aic: ${{ steps.parse-mcp-gateway.outputs.aic }} + ambient_context: ${{ steps.parse-mcp-gateway.outputs.ambient_context }} checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }} effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }} - effective_tokens_rate_limit_error: ${{ steps.parse-mcp-gateway.outputs.effective_tokens_rate_limit_error || 'false' }} has_patch: ${{ steps.collect_output.outputs.has_patch }} - inference_access_error: ${{ steps.detect-copilot-errors.outputs.inference_access_error || 'false' }} - mcp_policy_error: ${{ steps.detect-copilot-errors.outputs.mcp_policy_error || 'false' }} + http_400_response_error: ${{ steps.detect-agent-errors.outputs.http_400_response_error || 'false' }} + inference_access_error: ${{ steps.detect-agent-errors.outputs.inference_access_error || 'false' }} + invocation_cap_exceeded: ${{ steps.detect-agent-errors.outputs.invocation_cap_exceeded || 'false' }} + mcp_policy_error: ${{ steps.detect-agent-errors.outputs.mcp_policy_error || 'false' }} model: ${{ needs.activation.outputs.model }} - model_not_supported_error: ${{ steps.detect-copilot-errors.outputs.model_not_supported_error || 'false' }} + model_not_supported_error: ${{ steps.detect-agent-errors.outputs.model_not_supported_error || 'false' }} output: ${{ steps.collect_output.outputs.output }} output_types: ${{ steps.collect_output.outputs.output_types }} setup-parent-span-id: ${{ steps.setup.outputs.parent-span-id || steps.setup.outputs.span-id }} setup-span-id: ${{ steps.setup.outputs.span-id }} setup-trace-id: ${{ steps.setup.outputs.trace-id }} + unknown_model_ai_credits: ${{ steps.parse-mcp-gateway.outputs.unknown_model_ai_credits || 'false' }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -382,7 +461,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/sdk-consistency-review.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Set runtime paths id: set-runtime-paths @@ -393,7 +473,7 @@ jobs: echo "GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json" } >> "$GITHUB_OUTPUT" - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: persist-credentials: false - name: Create gh-aw temp directory @@ -402,23 +482,21 @@ jobs: run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh" env: GH_TOKEN: ${{ github.token }} + - name: Download activation artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: activation + path: /tmp/gh-aw - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Checkout PR branch id: checkout-pr if: | - github.event.pull_request || github.event.issue.pull_request + github.event.pull_request || github.event.issue.pull_request || github.event_name == 'workflow_dispatch' && fromJSON(github.event.inputs.aw_context || '{}').item_type == 'pull_request' uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -430,14 +508,14 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs'); await main(); - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 --rootless - name: Determine automatic lockdown mode for GitHub MCP Server id: determine-automatic-lockdown - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 (source v9) + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 env: GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} @@ -445,32 +523,31 @@ jobs: script: | const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - - name: Download activation artifact - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 - with: - name: activation - path: /tmp/gh-aw - name: Restore agent config folders from base branch if: steps.checkout-pr.outcome == 'success' env: - GH_AW_AGENT_FOLDERS: ".agents .claude .codex .crush .gemini .github .opencode .pi" - GH_AW_AGENT_FILES: ".crush.json AGENTS.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" + GH_AW_AGENT_FOLDERS: ".agents .antigravity .claude .codex .gemini .github .opencode .pi" + GH_AW_AGENT_FILES: "AGENTS.md ANTIGRAVITY.md CLAUDE.md GEMINI.md PI.md opencode.jsonc" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_base_github_folders.sh" - name: Restore inline sub-agents from activation artifact env: GH_AW_SUB_AGENT_DIR: ".github/agents" GH_AW_SUB_AGENT_EXT: ".agent.md" run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_sub_agents.sh" + - name: Restore inline skills from activation artifact + env: + GH_AW_SKILL_DIR: ".github/skills" + run: bash "${RUNNER_TEMP}/gh-aw/actions/restore_inline_skills.sh" - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 ghcr.io/github/gh-aw-mcpg:v0.3.9@sha256:64828b42a4482f58fab16509d7f8f495a6d97c972a98a68aff20543531ac0388 ghcr.io/github/github-mcp-server:v1.0.4 node:lts-alpine@sha256:d1b3b4da11eefd5941e7f0b9cf17783fc99d9c6fc34884a665f40a06dbdfc94f + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83 ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3 - name: Generate Safe Outputs Config run: | mkdir -p "${RUNNER_TEMP}/gh-aw/safeoutputs" mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_8507857a3b512809_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_05b64a640c1d5c26_EOF' {"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":{}} - GH_AW_SAFE_OUTPUTS_CONFIG_8507857a3b512809_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_05b64a640c1d5c26_EOF - name: Generate Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -624,62 +701,24 @@ jobs: setupGlobals(core, github, context, exec, io, getOctokit); const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs'); await main(); - - name: Generate Safe Outputs MCP Server Config - id: safe-outputs-config - run: | - # Generate a secure random API key (360 bits of entropy, 40+ chars) - # Mask immediately to prevent timing vulnerabilities - API_KEY=$(openssl rand -base64 45 | tr -d '/+=') - echo "::add-mask::${API_KEY}" - - PORT=3001 - - # Set outputs for next steps - { - echo "safe_outputs_api_key=${API_KEY}" - echo "safe_outputs_port=${PORT}" - } >> "$GITHUB_OUTPUT" - - echo "Safe Outputs MCP server will run on port ${PORT}" - - - name: Start Safe Outputs MCP HTTP Server - id: safe-outputs-start - env: - DEBUG: '*' - GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }} - GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json - GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json - GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs - run: | - # Environment variables are set above to prevent template injection - export DEBUG - export GH_AW_SAFE_OUTPUTS - export GH_AW_SAFE_OUTPUTS_PORT - export GH_AW_SAFE_OUTPUTS_API_KEY - export GH_AW_SAFE_OUTPUTS_TOOLS_PATH - export GH_AW_SAFE_OUTPUTS_CONFIG_PATH - export GH_AW_MCP_LOG_DIR - - bash "${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh" - - name: Start MCP Gateway id: start-mcp-gateway env: + GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST: ${{ vars.GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST || 'true' }} GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }} - GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }} + GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_CONFIG_PATH }} + GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS_TOOLS_PATH }} GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }} GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }} GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | set -eo pipefail mkdir -p "${RUNNER_TEMP}/gh-aw/mcp-config" - + # Export gateway environment variables for MCP config and gateway script export MCP_GATEWAY_PORT="8080" - export MCP_GATEWAY_DOMAIN="host.docker.internal" + export MCP_GATEWAY_DOMAIN="awmg-mcpg" export MCP_GATEWAY_HOST_DOMAIN="localhost" MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=') echo "::add-mask::${MCP_GATEWAY_API_KEY}" @@ -688,29 +727,25 @@ jobs: mkdir -p "${MCP_GATEWAY_PAYLOAD_DIR}" export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD="524288" export DEBUG="*" - + export GH_AW_ENGINE="copilot" MCP_GATEWAY_UID=$(id -u 2>/dev/null || echo '0') MCP_GATEWAY_GID=$(id -g 2>/dev/null || echo '0') - case "${DOCKER_HOST:-}" in - unix://* ) DOCKER_SOCK_PATH="${DOCKER_HOST#unix://}" ;; - /* ) DOCKER_SOCK_PATH="$DOCKER_HOST" ;; - * ) DOCKER_SOCK_PATH=/var/run/docker.sock ;; - esac - DOCKER_SOCK_GID=$(stat -c '%g' "$DOCKER_SOCK_PATH" 2>/dev/null || echo '0') - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host --add-host host.docker.internal:127.0.0.1 --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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.3.9' - - mkdir -p /home/runner/.copilot + source "${RUNNER_TEMP}/gh-aw/actions/resolve_docker_socket_gid.sh" + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network bridge -p 127.0.0.1:'"${MCP_GATEWAY_PORT}"':'"${MCP_GATEWAY_PORT}"' --name awmg-mcpg --add-host host.docker.internal:host-gateway --user '"${MCP_GATEWAY_UID}"':'"${MCP_GATEWAY_GID}"' --group-add '"${DOCKER_SOCK_GID}"' -v '"${DOCKER_SOCK_PATH}"':/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 DOCKER_HOST=unix:///var/run/docker.sock -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_POLICY_ALLOW_CREATE_PULL_REQUEST -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 RUNNER_TEMP -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 -v '"${RUNNER_TEMP}"'/gh-aw/safeoutputs:'"${RUNNER_TEMP}"'/gh-aw/safeoutputs:rw ghcr.io/github/gh-aw-mcpg:v0.4.3' + + mkdir -p "$HOME/.copilot" GH_AW_NODE=$(which node 2>/dev/null || command -v node 2>/dev/null || echo node) - cat << GH_AW_MCP_CONFIG_73099b6c804f5a74_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" + cat << GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF | "$GH_AW_NODE" "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.cjs" { "mcpServers": { "github": { "type": "stdio", - "container": "ghcr.io/github/github-mcp-server:v1.0.4", + "container": "ghcr.io/github/github-mcp-server:v1.6.0", "env": { - "GITHUB_HOST": "\${GITHUB_SERVER_URL}", - "GITHUB_PERSONAL_ACCESS_TOKEN": "\${GITHUB_MCP_SERVER_TOKEN}", + "GITHUB_FEATURES": "fields_param", + "GITHUB_HOST": "${GITHUB_SERVER_URL}", + "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_MCP_SERVER_TOKEN}", "GITHUB_READ_ONLY": "1", "GITHUB_TOOLSETS": "context,repos,issues,pull_requests" }, @@ -722,16 +757,35 @@ jobs: } }, "safeoutputs": { - "type": "http", - "url": "http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT", - "headers": { - "Authorization": "\${GH_AW_SAFE_OUTPUTS_API_KEY}" + "type": "stdio", + "container": "ghcr.io/github/gh-aw-node", + "mounts": ["\${GITHUB_WORKSPACE}:\${GITHUB_WORKSPACE}:rw", "${RUNNER_TEMP}/gh-aw/safeoutputs:${RUNNER_TEMP}/gh-aw/safeoutputs:rw", "/tmp/gh-aw:/tmp/gh-aw:rw"], + "args": ["-w", "\${GITHUB_WORKSPACE}"], + "entrypoint": "sh", + "entrypointArgs": ["-c", "sh ${RUNNER_TEMP}/gh-aw/safeoutputs/start_safe_outputs_mcp.sh"], + "env": { + "DEBUG": "*", + "DEFAULT_BRANCH": "\${DEFAULT_BRANCH}", + "GH_AW_ASSETS_ALLOWED_EXTS": "\${GH_AW_ASSETS_ALLOWED_EXTS}", + "GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}", + "GH_AW_ASSETS_MAX_SIZE_KB": "\${GH_AW_ASSETS_MAX_SIZE_KB}", + "GH_AW_MCP_LOG_DIR": "\${GH_AW_MCP_LOG_DIR}", + "GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}", + "GH_AW_SAFE_OUTPUTS_CONFIG_PATH": "\${GH_AW_SAFE_OUTPUTS_CONFIG_PATH}", + "GH_AW_SAFE_OUTPUTS_TOOLS_PATH": "\${GH_AW_SAFE_OUTPUTS_TOOLS_PATH}", + "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST": "\${GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST}", + "GITHUB_REPOSITORY": "\${GITHUB_REPOSITORY}", + "GITHUB_SHA": "\${GITHUB_SHA}", + "GITHUB_TOKEN": "\${GITHUB_TOKEN}", + "GITHUB_WORKSPACE": "\${GITHUB_WORKSPACE}", + "RUNNER_TEMP": "\${RUNNER_TEMP}" }, "guard-policies": { "write-sink": { "accept": [ "*" - ] + ], + "sink-visibility": ${{ toJSON(steps.determine-automatic-lockdown.outputs.visibility) }} } } } @@ -740,10 +794,11 @@ jobs: "port": $MCP_GATEWAY_PORT, "domain": "${MCP_GATEWAY_DOMAIN}", "apiKey": "${MCP_GATEWAY_API_KEY}", - "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" + "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}", + "startupTimeout": 120 } } - GH_AW_MCP_CONFIG_73099b6c804f5a74_EOF + GH_AW_MCP_CONFIG_4d6f106ca28cda70_EOF - name: Mount MCP servers as CLIs id: mount-mcp-clis continue-on-error: true @@ -772,29 +827,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" + export GH_AW_MCP_CONFIG="$HOME/.copilot/mcp-config.json" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/agent-stdio.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000,"models":{"auto":["large"],"coding":["copilot/gpt-5*codex*","openai/gpt-5*codex*","gpt-5-codex"],"deep-research":["copilot/deep-research*","copilot/o3-deep-research*","copilot/o4-mini-deep-research*","google/deep-research*","gemini/deep-research*","openai/o3-deep-research*","openai/o4-mini-deep-research*"],"gemini-flash":["copilot/gemini-*flash*","google/gemini-*flash*","gemini/gemini-*flash*"],"gemini-flash-lite":["copilot/gemini-*flash*lite*","google/gemini-*flash*lite*","gemini/gemini-*flash*lite*"],"gemini-pro":["copilot/gemini-*pro*","google/gemini-*pro*","gemini/gemini-*pro*"],"gemma":["copilot/gemma*","google/gemma*","gemini/gemma*"],"gpt-4.1":["copilot/gpt-4.1*","openai/gpt-4.1*"],"gpt-5":["copilot/gpt-5*","openai/gpt-5*"],"gpt-5-codex":["copilot/gpt-5*codex*","openai/gpt-5*codex*"],"gpt-5-mini":["copilot/gpt-5*mini*","openai/gpt-5*mini*"],"gpt-5-nano":["copilot/gpt-5*nano*","openai/gpt-5*nano*"],"gpt-5-pro":["copilot/gpt-5*pro*","openai/gpt-5*pro*"],"haiku":["copilot/*haiku*","anthropic/*haiku*"],"large":["sonnet","gpt-5-pro","gpt-5","gemini-pro"],"mini":["haiku","gpt-5-mini","gpt-5-nano","gemini-flash-lite"],"opus":["copilot/*opus*","anthropic/*opus*"],"reasoning":["copilot/o1*","copilot/o3*","copilot/o4*","openai/o1*","openai/o3*","openai/o4*"],"small":["mini"],"sonnet":["copilot/*sonnet*","anthropic/*sonnet*"],"vision":["copilot/gemini-*image*","gemini/gemini-*image*","copilot/gemini-*flash*","gemini/gemini-*flash*"]}},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-1000}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"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\"],\"isolation\":true,\"topologyAttach\":[\"awmg-mcpg\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + GH_AW_CHROOT_BINARIES_SOURCE_PATH="${RUNNER_TEMP}/gh-aw" GH_AW_CHROOT_IDENTITY_HOME="${RUNNER_TEMP}/gh-aw/home" node "${RUNNER_TEMP}/gh-aw/actions/patch_awf_chroot_config.cjs" + fi + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; export PATH="${RUNNER_TEMP}/gh-aw/mcp-cli/bin:$PATH" && : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --allow-all-paths --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }} - GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: agent GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 15 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -808,25 +885,20 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner - - name: Detect Copilot errors - id: detect-copilot-errors + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Detect agent errors if: always() + id: detect-agent-errors continue-on-error: true - run: node "${RUNNER_TEMP}/gh-aw/actions/detect_copilot_errors.cjs" + run: node "${RUNNER_TEMP}/gh-aw/actions/detect_agent_errors.cjs" - name: Configure Git credentials env: - REPO_NAME: ${{ github.repository }} - SERVER_URL: ${{ github.server_url }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_TOKEN: ${{ github.token }} - run: | - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git config --global user.name "github-actions[bot]" - git config --global am.keepcr true - # Re-authenticate git with GitHub token - SERVER_URL_STRIPPED="${SERVER_URL#https://}" - git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git" - echo "Git configured with standard GitHub Actions identity" + run: bash "${RUNNER_TEMP}/gh-aw/actions/configure_git_credentials.sh" - name: Copy Copilot session state files to logs if: always() continue-on-error: true @@ -850,8 +922,7 @@ jobs: const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs'); await main(); env: - GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' - SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} + GH_AW_SECRET_NAMES: 'GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN' SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }} SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }} SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -885,6 +956,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/ + GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} with: script: | const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); @@ -906,16 +978,7 @@ jobs: continue-on-error: true env: AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs - run: | - # Fix permissions on firewall logs/audit dirs so they can be uploaded as artifacts - # AWF runs with sudo, creating files owned by root - sudo chmod -R a+rX /tmp/gh-aw/sandbox/firewall 2>/dev/null || true - # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step) - if command -v awf &> /dev/null; then - awf logs summary | tee -a "$GITHUB_STEP_SUMMARY" - else - echo 'AWF binary not installed, skipping firewall log summary' - fi + run: bash "${RUNNER_TEMP}/gh-aw/actions/print_firewall_logs.sh" --rootless - name: Parse token usage for step summary if: always() continue-on-error: true @@ -976,17 +1039,19 @@ jobs: - safe_outputs if: > always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true' || - needs.activation.outputs.stale_lock_file_failed == 'true') + needs.activation.outputs.oauth_token_check_failed == 'true' || needs.activation.outputs.stale_lock_file_failed == 'true' || + needs.activation.outputs.secret_verification_result == 'failed' || needs.activation.outputs.daily_ai_credits_exceeded == 'true') runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write concurrency: group: "gh-aw-conclusion-sdk-consistency-review" cancel-in-progress: false queue: max + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }} noop_message: ${{ steps.noop.outputs.noop_message }} @@ -995,7 +1060,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1004,7 +1069,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/sdk-consistency-review.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1020,6 +1086,98 @@ jobs: mkdir -p /tmp/gh-aw/ find "/tmp/gh-aw/" -type f -print echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" + - name: Download safe outputs items manifest + id: download-safe-outputs-manifest + if: always() + continue-on-error: true + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: safe-outputs-items + path: /tmp/gh-aw/ + - name: Collect usage artifact files + if: always() + continue-on-error: true + run: | + mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection + echo "Usage artifact source file status:" + for file in /tmp/gh-aw/aw_info.json /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/agent_usage.json /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do + [ -f "$file" ] && echo "FOUND: $file" || echo "MISSING: $file" + done + [ -f /tmp/gh-aw/aw_info.json ] && cp /tmp/gh-aw/aw_info.json /tmp/gh-aw/usage/aw_info.json || true + [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true + [ -f /tmp/gh-aw/agent_usage.json ] && cp /tmp/gh-aw/agent_usage.json /tmp/gh-aw/usage/agent_usage.json || true + [ -f /tmp/gh-aw/agent_usage.jsonl ] && cp /tmp/gh-aw/agent_usage.jsonl /tmp/gh-aw/usage/agent_usage.jsonl || true + [ -f /tmp/gh-aw/detection_usage.jsonl ] && cp /tmp/gh-aw/detection_usage.jsonl /tmp/gh-aw/usage/detection_usage.jsonl || true + [ -f /tmp/gh-aw/evals/evals.jsonl ] && cp /tmp/gh-aw/evals/evals.jsonl /tmp/gh-aw/usage/evals.jsonl || true + [ -f /tmp/gh-aw/github_rate_limits.jsonl ] && cp /tmp/gh-aw/github_rate_limits.jsonl /tmp/gh-aw/usage/github_rate_limits.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -s /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/detection/token_usage.jsonl || true + [ -f /tmp/gh-aw/usage/agent/token_usage.jsonl ] || : > /tmp/gh-aw/usage/agent/token_usage.jsonl + [ -f /tmp/gh-aw/usage/detection/token_usage.jsonl ] || : > /tmp/gh-aw/usage/detection/token_usage.jsonl + mkdir -p /tmp/gh-aw/usage/activity + node "${RUNNER_TEMP}/gh-aw/actions/generate_usage_activity_summary.cjs" + find /tmp/gh-aw/usage -type f -print | sort + - name: Upload usage artifact + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: usage + path: | + /tmp/gh-aw/usage/aw_info.json + /tmp/gh-aw/usage/aw-info.jsonl + /tmp/gh-aw/usage/agent_usage.json + /tmp/gh-aw/usage/agent_usage.jsonl + /tmp/gh-aw/usage/detection_usage.jsonl + /tmp/gh-aw/usage/evals.jsonl + /tmp/gh-aw/usage/github_rate_limits.jsonl + /tmp/gh-aw/usage/agent/token_usage.jsonl + /tmp/gh-aw/usage/detection/token_usage.jsonl + /tmp/gh-aw/usage/activity/summary.json + if-no-files-found: ignore + - name: Restore daily AIC usage cache + id: restore-daily-aic-cache-conclusion + if: always() + continue-on-error: true + uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-sdkconsistencyreview-${{ github.run_id }} + restore-keys: agentic-workflow-usage-sdkconsistencyreview- + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Write daily AIC usage cache entry + id: write-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/github-script@373c709c69115d41ff229c7e5df9f8788daa9553 # v9 + with: + github-token: ${{ github.token }} + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context); + const { main } = require('${{ runner.temp }}/gh-aw/actions/write_daily_aic_usage_cache.cjs'); + await main(); + - name: Save daily AIC usage cache + id: save-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + key: agentic-workflow-usage-sdkconsistencyreview-${{ github.run_id }} + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + - name: Upload daily AIC usage cache artifact + id: upload-daily-aic-cache + if: always() + continue-on-error: true + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: aic-usage-cache + path: /tmp/gh-aw/agentic-workflow-usage-cache.jsonl + if-no-files-found: ignore + retention-days: 7 - name: Process no-op messages id: noop uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 @@ -1027,10 +1185,15 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_NOOP_MAX: "1" GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" GH_AW_TRACKER_ID: "sdk-consistency-review" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_NOOP_REPORT_AS_ISSUE: "true" + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} + GH_AW_WORKFLOW_ID: "sdk-consistency-review" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1044,6 +1207,7 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" GH_AW_TRACKER_ID: "sdk-consistency-review" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} @@ -1062,6 +1226,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_MISSING_TOOL_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" GH_AW_TRACKER_ID: "sdk-consistency-review" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -1077,6 +1242,7 @@ jobs: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: "true" GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" GH_AW_TRACKER_ID: "sdk-consistency-review" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} @@ -1092,29 +1258,37 @@ jobs: env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" GH_AW_TRACKER_ID: "sdk-consistency-review" GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }} GH_AW_WORKFLOW_ID: "sdk-consistency-review" GH_AW_ACTION_FAILURE_ISSUE_EXPIRES_HOURS: "168" GH_AW_ENGINE_ID: "copilot" - GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }} GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens || '' }} - GH_AW_EFFECTIVE_TOKENS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.effective_tokens_rate_limit_error || 'false' }} + GH_AW_AI_CREDITS_RATE_LIMIT_ERROR: ${{ needs.agent.outputs.ai_credits_rate_limit_error || 'false' }} + GH_AW_UNKNOWN_MODEL_AI_CREDITS: ${{ needs.agent.outputs.unknown_model_ai_credits || 'false' }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_MAX_AI_CREDITS || '1000' }} GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }} GH_AW_MCP_POLICY_ERROR: ${{ needs.agent.outputs.mcp_policy_error }} GH_AW_AGENTIC_ENGINE_TIMEOUT: ${{ needs.agent.outputs.agentic_engine_timeout }} GH_AW_MODEL_NOT_SUPPORTED_ERROR: ${{ needs.agent.outputs.model_not_supported_error }} + GH_AW_HTTP_400_RESPONSE_ERROR: ${{ needs.agent.outputs.http_400_response_error }} GH_AW_ENGINE_API_HOSTS: "api.enterprise.githubcopilot.com,api.githubcopilot.com,api.business.githubcopilot.com,api.individual.githubcopilot.com" GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} + GH_AW_OAUTH_TOKEN_CHECK_FAILED: ${{ needs.activation.outputs.oauth_token_check_failed }} GH_AW_STALE_LOCK_FILE_FAILED: ${{ needs.activation.outputs.stale_lock_file_failed }} + GH_AW_DAILY_AI_CREDITS_EXCEEDED: ${{ needs.activation.outputs.daily_ai_credits_exceeded }} + GH_AW_DAILY_AI_CREDITS_TOTAL_EFFECTIVE_TOKENS: ${{ needs.activation.outputs.daily_ai_credits_total_effective_tokens }} + GH_AW_DAILY_AI_CREDITS_THRESHOLD: ${{ needs.activation.outputs.daily_ai_credits_threshold }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" GH_AW_MISSING_TOOL_REPORT_AS_FAILURE: "true" GH_AW_MISSING_DATA_REPORT_AS_FAILURE: "true" GH_AW_TIMEOUT_MINUTES: "15" - GH_AW_MAX_EFFECTIVE_TOKENS: "25000000" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | @@ -1127,19 +1301,22 @@ jobs: needs: - activation - agent - if: > - always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true') + if: always() && needs.agent.result != 'skipped' runs-on: ubuntu-latest permissions: contents: read + copilot-requests: write + env: + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} outputs: + aic: ${{ steps.parse_detection_token_usage.outputs.aic }} detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }} detection_reason: ${{ steps.detection_conclusion.outputs.reason }} detection_success: ${{ steps.detection_conclusion.outputs.success }} steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1148,7 +1325,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/sdk-consistency-review.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1166,7 +1344,7 @@ jobs: echo "GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json" >> "$GITHUB_OUTPUT" - name: Checkout repository for patch context if: needs.agent.outputs.has_patch == 'true' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # --- Threat Detection --- @@ -1175,7 +1353,7 @@ jobs: rm -rf /tmp/gh-aw/sandbox/firewall/logs rm -rf /tmp/gh-aw/sandbox/firewall/audit - name: Download container images - run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.25.46 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.46 ghcr.io/github/gh-aw-firewall/squid:0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh" ghcr.io/github/gh-aw-firewall/agent:0.27.38@sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243 ghcr.io/github/gh-aw-firewall/api-proxy:0.27.38@sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c ghcr.io/github/gh-aw-firewall/squid:0.27.38@sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917 - name: Check if detection needed id: detection_guard if: always() @@ -1194,13 +1372,17 @@ jobs: if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | rm -f "${RUNNER_TEMP}/gh-aw/mcp-config/mcp-servers.json" - rm -f /home/runner/.copilot/mcp-config.json + rm -f "$HOME/.copilot/mcp-config.json" rm -f "$GITHUB_WORKSPACE/.gemini/settings.json" - name: Prepare threat detection files if: always() && steps.detection_guard.outputs.run_detection == 'true' run: | mkdir -p /tmp/gh-aw/threat-detection/aw-prompts + rm -f /tmp/gh-aw/agent_usage.json cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true + if [ ! -s /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt ]; then + echo "::warning::ERR_VALIDATION: Missing or empty detection context prompt at /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt. Ensure the agent artifact includes /tmp/gh-aw/aw-prompts/prompt.txt. Detection will continue with fallback workflow context." + fi cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true for f in /tmp/gh-aw/aw-*.patch; do [ -f "$f" ] && cp "$f" /tmp/gh-aw/threat-detection/ 2>/dev/null || true @@ -1229,16 +1411,16 @@ jobs: mkdir -p /tmp/gh-aw/threat-detection touch /tmp/gh-aw/threat-detection/detection.log - name: Setup Node.js - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 with: node-version: '24' package-manager-cache: false - name: Install GitHub Copilot CLI - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.48 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh" 1.0.73 env: GH_HOST: github.com - name: Install AWF binary - run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.25.46 + run: bash "${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh" v0.27.38 - name: Execute GitHub Copilot CLI if: always() && steps.detection_guard.outputs.run_detection == 'true' continue-on-error: true @@ -1248,27 +1430,51 @@ jobs: run: | set -o pipefail printf '%s' "$(date +%s%3N)" > /tmp/gh-aw/agent_cli_start_ms.txt + trap 'gh_aw_exit_code=$?; mkdir -p /tmp/gh-aw >/dev/null 2>&1 || true; printf "%s" "$gh_aw_exit_code" > /tmp/gh-aw/agent_execution_exit_code.txt || true; rm -f "$HOME/.copilot/settings.json"' EXIT + mkdir -p "$HOME/.copilot" + printf '%s' '{"builtInAgents":{"rubberDuck":false}}' > "$HOME/.copilot/settings.json" + export XDG_CONFIG_HOME="$HOME" touch /tmp/gh-aw/agent-step-summary.md GH_AW_NODE_BIN=$(command -v node 2>/dev/null || true) export GH_AW_NODE_BIN + export COPILOT_API_KEY="$COPILOT_DUMMY_BYOK" (umask 177 && touch /tmp/gh-aw/threat-detection/detection.log) - printf '%s\n' '{"$schema":"https://github.com/github/gh-aw-firewall/releases/download/v0.25.46/awf-config.schema.json","network":{"allowDomains":["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"]},"apiProxy":{"enabled":true,"enableTokenSteering":true,"maxRuns":500,"maxEffectiveTokens":25000000},"container":{"imageTag":"0.25.46"}}' > "${RUNNER_TEMP}/gh-aw/awf-config.json" && cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="" + GH_AW_MAX_AI_CREDITS="${GH_AW_MAX_AI_CREDITS:-400}" + printf '%s\n' "{\"\$schema\":\"https://github.com/github/gh-aw-firewall/releases/download/v0.27.38/awf-config.schema.json\",\"network\":{\"allowDomains\":[\"api.business.githubcopilot.com\",\"api.enterprise.githubcopilot.com\",\"api.github.com\",\"api.githubcopilot.com\",\"api.individual.githubcopilot.com\",\"github.com\",\"host.docker.internal\",\"registry.npmjs.org\",\"telemetry.enterprise.githubcopilot.com\"]},\"apiProxy\":{\"enabled\":true,\"enableTokenSteering\":true,\"maxRuns\":500,\"maxAiCredits\":${GH_AW_MAX_AI_CREDITS},\"maxCacheMisses\":5,\"models\":{\"agent\":[\"sonnet-6x\",\"gpt-5.4\",\"gpt-5.3\",\"gemini-pro\",\"any\"],\"antigravity\":[\"copilot/antigravity*\",\"google/antigravity*\",\"gemini/antigravity*\"],\"any\":[\"copilot/*\",\"anthropic/*\",\"openai/*\",\"google/*\",\"gemini/*\"],\"claude\":[\"agent\"],\"codex\":[\"agent\"],\"coding\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\",\"gpt-5-codex\",\"kimi\"],\"computer-use\":[\"copilot/*computer-use*\",\"google/*computer-use*\",\"gemini/*computer-use*\",\"openai/*computer-use*\"],\"copilot\":[\"agent\"],\"deep-research\":[\"copilot/deep-research*\",\"copilot/o3-deep-research*\",\"copilot/o4-mini-deep-research*\",\"google/deep-research*\",\"gemini/deep-research*\",\"openai/o3-deep-research*\",\"openai/o4-mini-deep-research*\"],\"fable\":[\"copilot/*fable*\",\"anthropic/*fable*\"],\"gemini\":[\"agent\"],\"gemini-3-flash\":[\"copilot/gemini-3*flash*\",\"google/gemini-3*flash*\",\"gemini/gemini-3*flash*\"],\"gemini-3-pro\":[\"copilot/gemini-3*pro*\",\"google/gemini-3*pro*\",\"google/nano-banana*\",\"gemini/gemini-3*pro*\"],\"gemini-3.1-flash\":[\"copilot/gemini-3.1*flash*\",\"google/gemini-3.1*flash*\",\"gemini/gemini-3.1*flash*\"],\"gemini-3.1-pro\":[\"copilot/gemini-3.1*pro*\",\"google/gemini-3.1*pro*\",\"gemini/gemini-3.1*pro*\"],\"gemini-3.5-flash\":[\"copilot/gemini-3.5*flash*\",\"google/gemini-3.5*flash*\",\"gemini/gemini-3.5*flash*\"],\"gemini-flash\":[\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"],\"gemini-flash-lite\":[\"copilot/gemini-*flash*lite*\",\"google/gemini-*flash*lite*\",\"gemini/gemini-*flash*lite*\"],\"gemini-omni\":[\"copilot/gemini-omni*\",\"google/gemini-omni*\",\"gemini/gemini-omni*\"],\"gemini-pro\":[\"copilot/gemini-*pro*\",\"google/gemini-*pro*\",\"gemini/gemini-*pro*\"],\"gemma\":[\"copilot/gemma*\",\"google/gemma*\",\"gemini/gemma*\"],\"gpt-5\":[\"copilot/gpt-5*\",\"openai/gpt-5*\"],\"gpt-5-codex\":[\"copilot/gpt-5*codex*\",\"openai/gpt-5*codex*\"],\"gpt-5-mini\":[\"copilot/gpt-5*mini*\",\"openai/gpt-5*mini*\"],\"gpt-5-nano\":[\"copilot/gpt-5*nano*\",\"openai/gpt-5*nano*\"],\"gpt-5-pro\":[\"copilot/gpt-5*pro*\",\"openai/gpt-5*pro*\"],\"gpt-5.1\":[\"copilot/gpt-5.1*\",\"openai/gpt-5.1*\"],\"gpt-5.2\":[\"copilot/gpt-5.2*\",\"openai/gpt-5.2*\"],\"gpt-5.3\":[\"copilot/gpt-5.3*\",\"openai/gpt-5.3*\"],\"gpt-5.4\":[\"copilot/gpt-5.4*\",\"openai/gpt-5.4*\"],\"gpt-5.5\":[\"copilot/gpt-5.5*\",\"openai/gpt-5.5*\"],\"gpt-5.6\":[\"copilot/gpt-5.6*\",\"openai/gpt-5.6*\"],\"haiku\":[\"copilot/*haiku*\",\"anthropic/*haiku*\"],\"image-generation\":[\"copilot/gpt-image*\",\"openai/gpt-image*\",\"openai/chatgpt-image*\",\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"google/imagen*\"],\"kimi\":[\"copilot/kimi*\",\"openai/kimi*\"],\"kiwi\":[\"copilot/kiwi*\",\"openai/kiwi*\"],\"large\":[\"fable\",\"sonnet\",\"gpt-5-pro\",\"gpt-5\",\"gemini-pro\"],\"lyria\":[\"google/lyria*\",\"gemini/lyria*\",\"copilot/lyria*\"],\"mai-code\":[\"copilot/MAI-Code*\",\"copilot/mai-code*\",\"openai/MAI-Code*\"],\"mai-code-1-flash-picker\":[\"copilot/MAI-Code-1-Flash-picker*\",\"copilot/mai-code-1-flash-picker*\",\"openai/MAI-Code-1-Flash-picker*\"],\"mini\":[\"haiku\",\"gpt-5-mini\",\"gpt-5-nano\",\"gemini-flash-lite\"],\"nano-banana\":[\"copilot/nano-banana*\",\"google/nano-banana*\",\"gemini/nano-banana*\"],\"opus\":[\"copilot/*opus*\",\"anthropic/*opus*\"],\"opusplan\":[\"opus?effort=high\"],\"raptor-mini\":[\"copilot/raptor*\",\"openai/raptor*\"],\"reasoning\":[\"copilot/o1*\",\"copilot/o3*\",\"copilot/o4*\",\"openai/o1*\",\"openai/o3*\",\"openai/o4*\"],\"robotics\":[\"copilot/*robotics*\",\"google/*robotics*\",\"gemini/*robotics*\"],\"small\":[\"mini\"],\"small-agent\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash\"],\"sonnet\":[\"copilot/*sonnet*\",\"anthropic/*sonnet*\"],\"sonnet-6x\":[\"copilot/*sonnet-4.5*\",\"copilot/*sonnet-4.6*\",\"copilot/*sonnet-5*\",\"copilot/*sonnet-4-5-*\",\"anthropic/*sonnet-4-5-*\",\"copilot/*sonnet-4-6*\",\"anthropic/*sonnet-4-6*\",\"anthropic/*sonnet-5*\"],\"summarization\":[\"haiku\",\"gpt-5-mini\",\"gemini-flash-lite\",\"mini\"],\"veo\":[\"google/veo*\",\"gemini/veo*\"],\"vision\":[\"copilot/gemini-*image*\",\"google/gemini-*image*\",\"gemini/gemini-*image*\",\"copilot/gemini-*flash*\",\"google/gemini-*flash*\",\"gemini/gemini-*flash*\"]}},\"container\":{\"imageTag\":\"0.27.38,squid=sha256:6c19094d95aad5f9f128ad5e583f0f2b894b158aa66c3b86dd9bcc90970a2917,agent=sha256:cb928eb62d9139a013c2d278dab19af232d35a2d83dca71a3d98eb431f786243,api-proxy=sha256:cd6145620d96acee46e1ede25180a13aa36002467e663db0caa453a8bc8eb60c,cli-proxy=sha256:c30c5319da37505d42f95cb3faa2cfa55e794ccb5cc805dbd9201410d1ac2a3e\"},\"logging\":{\"proxyLogsDir\":\"/tmp/gh-aw/sandbox/firewall/logs\",\"auditDir\":\"/tmp/gh-aw/sandbox/firewall/audit\"}}" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + cp "${RUNNER_TEMP}/gh-aw/awf-config.json" /tmp/gh-aw/awf-config.json + export GH_AW_MODELS_JSON_PATH="/tmp/gh-aw/models.json" + GH_AW_DOCKER_HOST="" + if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then + GH_AW_DOCKER_HOST="${DOCKER_HOST}" + fi if [[ "${DOCKER_HOST:-}" =~ ^tcp:// ]]; then - GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS="--docker-host-path-prefix /tmp/gh-aw" + _GH_AW_CHROOT_JSON=$(jq -c --arg src "${RUNNER_TEMP}/gh-aw" --arg user "$(id -un)" --argjson uid "$(id -u)" --argjson gid "$(id -g)" --arg home "${RUNNER_TEMP}/gh-aw/home" '.chroot={"binariesSourcePath":$src,"identity":{"user":$user,"uid":$uid,"gid":$gid,"home":$home}}' "${RUNNER_TEMP}/gh-aw/awf-config.json") || { echo "chroot config patch failed" >&2; exit 1; } + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" + printf '%s\n' "$_GH_AW_CHROOT_JSON" > "${RUNNER_TEMP}/gh-aw/awf-config.json" fi - # shellcheck disable=SC1003 - sudo -E awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_DOCKER_HOST_PATH_PREFIX_ARGS} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --allow-host-ports 80,443,8080 --skip-pull \ - -- /bin/bash -c 'export PATH="$(find /opt/hostedtoolcache /home/runner/work/_tool -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log + GH_AW_TOOL_CACHE_MOUNT="" + GH_AW_TOOL_CACHE="${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}" + if [ -d "$GH_AW_TOOL_CACHE" ]; then + if [[ "$GH_AW_TOOL_CACHE" != /opt/* ]]; then + GH_AW_TOOL_CACHE_MOUNT="$GH_AW_TOOL_CACHE:$GH_AW_TOOL_CACHE:ro" + fi + fi + # shellcheck disable=SC1003,SC2016,SC2086 + awf --config "${RUNNER_TEMP}/gh-aw/awf-config.json" --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" ${GH_AW_TOOL_CACHE_MOUNT:+--mount "$GH_AW_TOOL_CACHE_MOUNT"} ${GH_AW_DOCKER_HOST:+--docker-host "$GH_AW_DOCKER_HOST"} --env-all --exclude-env COPILOT_GITHUB_TOKEN --log-level info --skip-pull \ + -- /bin/bash -c 'set +o histexpand; : "${RUNNER_TOOL_CACHE:?RUNNER_TOOL_CACHE must be set}"; GH_AW_TOOL_CACHE="$RUNNER_TOOL_CACHE"; export PATH="$(find "$GH_AW_TOOL_CACHE" -maxdepth 5 -type d -name bin 2>/dev/null | tr '\''\n'\'' '\'':'\'')$PATH"; [ -n "$GOROOT" ] && export PATH="$GOROOT/bin:$PATH" || true; [ -n "$ERLANG_HOME" ] && export PATH="$ERLANG_HOME/bin:$PATH" || true && GH_AW_NODE_EXEC="${GH_AW_NODE_BIN:-}"; if [ -z "$GH_AW_NODE_EXEC" ] || [ ! -x "$GH_AW_NODE_EXEC" ]; then GH_AW_NODE_EXEC="$(command -v node 2>/dev/null || true)"; fi; if [ -z "$GH_AW_NODE_EXEC" ]; then echo "node runtime missing on this runner — check runtimes.node in workflow YAML" >&2; exit 127; fi; GH_AW_NPM_GLOBAL_ROOT="$(npm root -g 2>/dev/null || true)"; if [ -n "$GH_AW_NPM_GLOBAL_ROOT" ]; then export NODE_PATH="${GH_AW_NPM_GLOBAL_ROOT}${NODE_PATH:+:${NODE_PATH}}"; fi; "$GH_AW_NODE_EXEC" ${RUNNER_TEMP}/gh-aw/actions/copilot_harness.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --no-ask-user --allow-all-tools --add-dir "${GITHUB_WORKSPACE}" --prompt-file /tmp/gh-aw/aw-prompts/prompt.txt' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log env: AWF_REFLECT_ENABLED: 1 COPILOT_AGENT_RUNNER_TYPE: STANDALONE - COPILOT_API_KEY: dummy-byok-key-for-offline-mode - COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }} - COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || 'claude-sonnet-4.6' }} + COPILOT_DUMMY_BYOK: dummy-byok-key-for-offline-mode + COPILOT_GITHUB_TOKEN: ${{ github.token }} + COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || vars.GH_AW_DEFAULT_MODEL_COPILOT || 'claude-sonnet-4.6' }} + GH_AW_LLM_PROVIDER: github + GH_AW_MAX_AI_CREDITS: ${{ vars.GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS || '400' }} + GH_AW_MAX_TURNS: ${{ vars.GH_AW_DEFAULT_MAX_TURNS || '' }} GH_AW_PHASE: detection GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt - GH_AW_VERSION: v0.74.4 + GH_AW_TIMEOUT_MINUTES: 20 + GH_AW_VERSION: v0.83.1 GITHUB_API_URL: ${{ github.api_url }} GITHUB_AW: true GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows @@ -1281,7 +1487,22 @@ jobs: GIT_AUTHOR_NAME: github-actions[bot] GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com GIT_COMMITTER_NAME: github-actions[bot] - XDG_CONFIG_HOME: /home/runner + RUNNER_TEMP: ${{ runner.temp }} + S2STOKENS: true + TRACEPARENT: ${{ env.GITHUB_AW_OTEL_TRACE_ID != '' && env.GITHUB_AW_OTEL_PARENT_SPAN_ID != '' && format('00-{0}-{1}-01', env.GITHUB_AW_OTEL_TRACE_ID, env.GITHUB_AW_OTEL_PARENT_SPAN_ID) || '' }} + - name: Parse threat detection token usage for step summary + id: parse_detection_token_usage + if: always() + continue-on-error: true + uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 + env: + GH_AW_TOKEN_USAGE_SUMMARY_TITLE: Threat Detection Token Usage + with: + script: | + const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs'); + setupGlobals(core, github, context, exec, io, getOctokit); + const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs'); + await main(); - name: Upload threat detection log if: always() && steps.detection_guard.outputs.run_detection == 'true' uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 @@ -1331,21 +1552,26 @@ jobs: runs-on: ubuntu-slim permissions: contents: read - discussions: write issues: write pull-requests: write - timeout-minutes: 15 + timeout-minutes: 45 env: + GH_AW_AGENT_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AIC: ${{ needs.agent.outputs.aic }} + GH_AW_AMBIENT_CONTEXT: ${{ needs.agent.outputs.ambient_context }} GH_AW_CALLER_WORKFLOW_ID: "${{ github.repository }}/sdk-consistency-review" GH_AW_DETECTION_CONCLUSION: ${{ needs.detection.outputs.detection_conclusion }} GH_AW_DETECTION_REASON: ${{ needs.detection.outputs.detection_reason }} GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }} GH_AW_ENGINE_ID: "copilot" GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }} - GH_AW_ENGINE_VERSION: "1.0.48" + GH_AW_ENGINE_VERSION: "1.0.73" + GH_AW_RUNTIME_FEATURES: ${{ vars.GH_AW_RUNTIME_FEATURES }} + GH_AW_THREAT_DETECTION_AIC: ${{ needs.detection.outputs.aic }} GH_AW_TRACKER_ID: "sdk-consistency-review" GH_AW_WORKFLOW_ID: "sdk-consistency-review" GH_AW_WORKFLOW_NAME: "SDK Consistency Review Agent" + GH_AW_WORKFLOW_SOURCE_URL: "${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref_name }}/.github/workflows/sdk-consistency-review.md" outputs: code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} @@ -1358,7 +1584,7 @@ jobs: steps: - name: Setup Scripts id: setup - uses: github/gh-aw-actions/setup@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4 + uses: github/gh-aw-actions/setup@8bdba8075360648fe6802302a5b4e016361dc6ac # v0.83.1 with: destination: ${{ runner.temp }}/gh-aw/actions job-name: ${{ github.job }} @@ -1367,7 +1593,8 @@ jobs: env: GH_AW_SETUP_WORKFLOW_NAME: "SDK Consistency Review Agent" GH_AW_CURRENT_WORKFLOW_REF: ${{ github.repository }}/.github/workflows/sdk-consistency-review.lock.yml@${{ github.ref }} - GH_AW_INFO_VERSION: "1.0.48" + GH_AW_INFO_VERSION: "1.0.73" + GH_AW_INFO_AWF_VERSION: "v0.27.38" GH_AW_INFO_ENGINE_ID: "copilot" - name: Download agent output artifact id: download-agent-output @@ -1386,7 +1613,7 @@ jobs: - name: Configure GH_HOST for enterprise compatibility id: ghes-host-config shell: bash - run: | + run: | # zizmor: ignore[github-env] - GITHUB_SERVER_URL is set by GitHub Actions, not user input. # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op. GH_HOST="${GITHUB_SERVER_URL#https://}" @@ -1397,6 +1624,7 @@ jobs: uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 env: GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }} + GH_AW_COMMENT_ID: ${{ needs.activation.outputs.comment_id }} 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" GITHUB_SERVER_URL: ${{ github.server_url }} GITHUB_API_URL: ${{ github.api_url }} @@ -1417,4 +1645,3 @@ jobs: /tmp/gh-aw/safe-output-items.jsonl /tmp/gh-aw/temporary-id-map.json if-no-files-found: ignore - diff --git a/.github/workflows/sdk-consistency-review.md b/.github/workflows/sdk-consistency-review.md index bff588f38..550d9349d 100644 --- a/.github/workflows/sdk-consistency-review.md +++ b/.github/workflows/sdk-consistency-review.md @@ -10,6 +10,10 @@ on: - 'python/**' - 'go/**' - 'dotnet/**' + - 'java/**' + - '!java/docs/**' + - '!java/*.txt' + - '!java/*.md' workflow_dispatch: inputs: pr_number: @@ -20,6 +24,7 @@ permissions: contents: read pull-requests: read issues: read + copilot-requests: write tools: github: toolsets: [default] @@ -35,7 +40,7 @@ timeout-minutes: 15 # SDK Consistency Review Agent -You 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. +You are an AI code reviewer specialized in ensuring consistency across multi-language SDK implementations. This repository contains six SDK implementations (Node.js/TypeScript, Python, Go, .NET, Java, and Rust) that should maintain feature parity and consistent API design. ## Your Task @@ -69,15 +74,24 @@ When a pull request modifies any SDK client code, review it to ensure: - **Python**: `python/copilot/` - **Go**: `go/` - **.NET**: `dotnet/src/` +- **Java**: `java/sdk/src/main/java/` +- **Rust**: `rust/src/` ## Review Process -1. **Identify the changed SDK(s)**: Determine which language implementation(s) are modified in this PR -2. **Analyze the changes**: Understand what feature/fix is being implemented -3. **Cross-reference other SDKs**: Check if the equivalent functionality exists in other language implementations: +1. **Get the authoritative PR delta**: + - Call `pull_request_read` with `method: get_files` for the PR, paginating until all changed files are retrieved + - Call `pull_request_read` with `method: get_diff` for the PR + - Treat these GitHub API responses as the only authoritative source of which changes belong to the PR, including when the PR head is a merge commit + - Base every claim about what the PR adds or modifies on the API diff; use the local checkout only for surrounding context and cross-SDK comparison + - Never infer the PR base from `HEAD^`, merge-parent ordering, recent commits, or local branch refs + - If the API file list or diff cannot be retrieved, call `missing_data` and stop; do not substitute an inferred local `git diff` range +2. **Identify the changed SDK(s)**: Determine which language implementation(s) are modified in the authoritative PR delta +3. **Analyze the changes**: Understand what feature/fix is being implemented from the authoritative PR delta +4. **Cross-reference other SDKs**: Check if the equivalent functionality exists in other language implementations: - Read the corresponding files in other SDK directories - Compare method signatures, behavior, and documentation -4. **Report findings**: If inconsistencies are found: +5. **Report findings**: If inconsistencies are found: - Use `create-pull-request-review-comment` to add inline comments on specific lines where changes should be made - Use `add-comment` to provide a summary of cross-SDK consistency findings - Be specific about which SDKs need updates and what changes would bring them into alignment @@ -90,6 +104,8 @@ When a pull request modifies any SDK client code, review it to ensure: - Python uses snake_case (e.g., `create_session`) - Go uses PascalCase for exported/public functions (e.g., `CreateSession`) and camelCase for unexported/private functions - .NET uses PascalCase (e.g., `CreateSession`) + - Java uses camelCase for methods (e.g., `createSession`) and PascalCase for classes + - Rust uses snake_case for functions and methods (e.g., `create_session`) and PascalCase for types - Focus on public API methods when comparing across languages 3. **Focus on API surface**: Prioritize public APIs over internal implementation details 4. **Distinguish between bugs and features**: @@ -102,7 +118,7 @@ When a pull request modifies any SDK client code, review it to ensure: ## Example Scenarios ### Good: Consistent feature addition -If 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. +If a PR adds a new `setTimeout` option to the Node.js SDK and the equivalent feature already exists or is added to Python, Go, .NET, Java, and Rust in the same PR. ### Bad: Inconsistent feature If 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. diff --git a/.github/workflows/update-copilot-dependency.yml b/.github/workflows/update-copilot-dependency.yml index 05833bf73..9646366ad 100644 --- a/.github/workflows/update-copilot-dependency.yml +++ b/.github/workflows/update-copilot-dependency.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: inputs: version: - description: 'Target version of @github/copilot (e.g. 0.0.420)' + description: "Target version of @github/copilot (e.g. 0.0.420)" required: true type: string @@ -34,7 +34,7 @@ jobs: - uses: actions/setup-go@v5 with: - go-version: '1.22' + go-version: "1.22" - uses: actions/setup-dotnet@v5 with: @@ -86,6 +86,34 @@ jobs: cd ../dotnet && dotnet format src/GitHub.Copilot.SDK.csproj cd ../rust && cargo +nightly-2026-04-14 fmt --all -- --config-path .rustfmt.nightly.toml + - uses: actions/setup-java@v5 + with: + java-version: "25" + distribution: "microsoft" + + - name: Update @github/copilot in Java codegen + env: + VERSION: ${{ inputs.version }} + working-directory: ./java/scripts/codegen + run: npm install "@github/copilot@$VERSION" + + - name: Update Java POM CLI version property + env: + VERSION: ${{ inputs.version }} + working-directory: ./java + run: | + PROP="readonly-copilot-sdk-ref-impl-version-from-lastmerge-file-updated-by-reference-impl-sync" + sed -i -E "s|(<${PROP}>)[^<]*()|\1^${VERSION}\2|" pom.xml + # Use fixed-string matching (-F) because npm versions contain regex + # metacharacters: '^' (caret ranges) and '.' (dots in semver) would + # otherwise be interpreted as start-of-line and any-char respectively, + # causing false negatives or spurious matches. + grep -qF "<${PROP}>^${VERSION}" pom.xml + + - name: Run Java codegen + working-directory: ./java + run: mvn generate-sources -Pcodegen + - name: Create pull request env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -95,10 +123,37 @@ jobs: git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + # Fetch the PR branch if it exists remotely (shallow clones may not have it) + git fetch origin "$BRANCH" 2>/dev/null || true + if git rev-parse --verify "origin/$BRANCH" >/dev/null 2>&1; then - git fetch origin "$BRANCH" + # We need to switch to the existing PR branch, but earlier workflow + # steps (dependency bumps, codegen) may have left uncommitted changes + # in the working tree. We must stash those changes before checkout, + # then re-apply them on the PR branch. + # + # HOWEVER: `git stash` is a no-op when the working tree is clean — + # it exits 0 but creates NO refs/stash entry. If we then blindly run + # `git stash pop`, it fails with "No stash entries found" and, under + # the shell's `set -e` (GitHub Actions default), aborts the entire + # step. This happens when the requested version is already current or + # earlier steps produced no file changes. + # + # Fix: only stash/pop when there are actual uncommitted changes. + STASHED=false + if ! git diff --quiet || ! git diff --cached --quiet; then + git stash --include-untracked + STASHED=true + fi + git checkout "$BRANCH" git reset --hard "origin/$BRANCH" + + # Re-apply the dependency/codegen changes on top of the PR branch, + # but only if we actually stashed something above. + if [ "$STASHED" = "true" ]; then + git stash pop + fi else git checkout -b "$BRANCH" fi @@ -115,8 +170,49 @@ jobs: - Updated nodejs and test harness dependencies - Re-ran code generators - Formatted generated code" + git push origin "$BRANCH" --force-with-lease + PR_BODY=$(cat <<'BODY_EOF' + Automated update of `@github/copilot` to version `PLACEHOLDER_VERSION`. + + ### Changes + - Updated `@github/copilot` in `nodejs/package.json` and `test/harness/package.json` + - Re-ran all code generators (`scripts/codegen`) + - Formatted generated output + - Updated Java codegen dependency, POM property, and regenerated Java types + + ### Java Handwritten Code Adaptation Plan + + If `java-sdk-tests` CI fails on this PR, follow these steps: + + 1. **Identify failures**: Run `mvn clean`, `mvn verify` from `java/` locally or check the `java-sdk-tests` workflow run logs. + 2. **Categorize errors**: + - Constructor signature changes (new fields added to generated records) + - Enum value additions/renames in generated types + - New event types requiring handler registration + - Removed or renamed generated types + 3. **Fix handwritten source** (`java/sdk/src/main/java/com/github/copilot/sdk/`): + - Update call sites passing positional constructor args to include new fields (typically `null` for optional new fields). + - Update switch/if-else over enum values to handle new cases. + - Register handlers for new event types in `CopilotSession.java` if applicable. + 4. **Fix handwritten tests** (`java/sdk/src/test/java/com/github/copilot/sdk/`): + - Same constructor/enum fixes as above. + - Add new test methods for new functionality if the change adds user-facing API surface. + 5. **Validate**: `cd java && mvn clean test-compile jar:jar && mvn verify -Dskip.test.harness=true` + 6. **Format**: `cd java && mvn spotless:apply` + 7. Push fixes to this PR branch. + + > To automate this, trigger the `java-adapt-handwritten-code-to-accept-upgrade-changes` agentic workflow instead. + + ### Next steps + When ready, click **Ready for review** to trigger CI checks. + + > Created by the **Update @github/copilot Dependency** workflow. + BODY_EOF + ) + PR_BODY="${PR_BODY//PLACEHOLDER_VERSION/$VERSION}" + PR_STATE="$(gh pr view "$BRANCH" --json state --jq '.state' 2>/dev/null || echo "")" if [ "$PR_STATE" = "OPEN" ]; then if [ "$(gh pr view "$BRANCH" --json isDraft --jq '.isDraft')" = "false" ]; then @@ -129,17 +225,7 @@ jobs: gh pr create \ --draft \ --title "Update @github/copilot to $VERSION" \ - --body "Automated update of \`@github/copilot\` to version \`$VERSION\`. - - ### Changes - - Updated \`@github/copilot\` in \`nodejs/package.json\` and \`test/harness/package.json\` - - Re-ran all code generators (\`scripts/codegen\`) - - Formatted generated output - - ### Next steps - When ready, click **Ready for review** to trigger CI checks. - - > Created by the **Update @github/copilot Dependency** workflow." \ + --body "$PR_BODY" \ --base main \ --head "$BRANCH" fi diff --git a/.github/workflows/verify-compiled.yml b/.github/workflows/verify-compiled.yml index 7e5ba0ee4..1a3dbb96f 100644 --- a/.github/workflows/verify-compiled.yml +++ b/.github/workflows/verify-compiled.yml @@ -17,10 +17,11 @@ jobs: steps: - uses: actions/checkout@v4 - name: Install gh-aw CLI - uses: github/gh-aw/actions/setup-cli@main + uses: github/gh-aw-actions/setup-cli@05205436a78512d71a2d842e46586ed05f4fa058 # v0.82.10 with: - version: v0.74.4 + version: v0.83.1 - name: Recompile workflows + # Full-repository compile so the diff check below covers all workflows. run: gh aw compile - name: Check for uncommitted changes run: | diff --git a/.gitignore b/.gitignore index 1485d3a9c..c1e983376 100644 --- a/.gitignore +++ b/.gitignore @@ -7,13 +7,17 @@ docs/.validation/ # Visual Studio .vs/ +# Intellij IDEA +.idea/ + # C# Dev Kit *.csproj.lscache # Java -java/target +java/**/target/ java/smoke-test java/.classpath java/.project java/.settings java/scripts/codegen/node_modules/ +.flattened-pom.xml diff --git a/.vscode/settings.json b/.vscode/settings.json index c4ae9c761..049330d2a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -25,6 +25,7 @@ "[go]": { "editor.defaultFormatter": "golang.go" }, + "java.autobuild.enabled": false, "java.configuration.updateBuildConfiguration": "automatic", "java.compile.nullAnalysis.mode": "automatic" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 369c599be..e9f22a3df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,308 @@ All notable changes to the Copilot SDK are documented in this file. This changelog is automatically generated by an AI agent when stable releases are published. See [GitHub Releases](https://github.com/github/copilot-sdk/releases) for the full list. +## [Unreleased] + +### Feature: host-injected managed settings permissions + +Session create and resume accept a new optional `managedSettings` option that injects an enterprise permissions policy at session startup, alongside the existing `enableManagedSettings` self-fetch flag. The current contract is permissions-only: `disableBypassPermissionsMode` (the literal `"disable"`), plus `deny`, `ask`, and `allow` rule lists. The layer composes restrictively with any server- or device-level managed settings (deny/ask are unioned, every present allow list must admit a tool, and `disableBypassPermissionsMode` is deny-wins). + +This layer is startup-only and is not persisted with the session, so it must be re-supplied on resume to remain in effect; omitting it on resume clears the previously injected layer. It can be combined with `enableManagedSettings`. Host injection requires Copilot CLI `1.0.79-5` or later and does not require an SDK protocol version bump. + +The generated session-event types also expose truthful injected-policy provenance: `session.managed_settings_resolved` can report `source` as `client` or `mixed`, with optional `clientManaged` metadata. + +```ts +const session = await client.createSession({ + managedSettings: { + permissions: { + disableBypassPermissionsMode: "disable", + deny: ["shell(rm*)"], + ask: ["write"], + }, + }, +}); +``` + +```cs +var session = await client.CreateSessionAsync(new SessionConfig +{ + ManagedSettings = new ManagedSettings + { + Permissions = new ManagedSettingsPermissions + { + DisableBypassPermissionsMode = DisableBypassPermissionsMode.Disable, + Deny = ["shell(rm*)"], + Ask = ["write"], + }, + }, +}); +``` + +## [v1.0.7](https://github.com/github/copilot-sdk/releases/tag/v1.0.7) (2026-07-16) + +### Feature: in-process (FFI) transport + +The SDK can now host the Copilot runtime in-process by loading the native runtime library via its C ABI (FFI), eliminating the overhead of spawning a child process. This experimental transport is available for Node.js, Rust, Python, and Go. ([#1953](https://github.com/github/copilot-sdk/pull/1953), [#1915](https://github.com/github/copilot-sdk/pull/1915), [#1975](https://github.com/github/copilot-sdk/pull/1975), [#1976](https://github.com/github/copilot-sdk/pull/1976)) + +```ts +const client = new CopilotClient({ connection: RuntimeConnection.forInProcess() }); +``` + +```cs +var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForInProcess() }); +``` + +### Feature: tool search configuration + +A new `toolSearch` session option controls how the SDK defers tools when the total tool count exceeds a threshold. When enabled (the default), excess MCP and external tools are surfaced on demand through the built-in `tool_search_tool` rather than pre-loaded into every prompt. Tool results can also include `toolReferences` to link cited sources back to the tool that produced them. ([#1933](https://github.com/github/copilot-sdk/pull/1933)) + +```ts +const session = await client.createSession({ + toolSearch: { defer: "auto" }, +}); +``` + +```cs +var session = await client.CreateSessionAsync(new SessionConfig +{ + ToolSearch = new ToolSearchConfig { Defer = "auto" }, +}); +``` + +### Feature: opaque metadata passthrough on tool definitions + +Tool definitions now accept an optional `metadata` bag that is forwarded verbatim in `session.create` and `session.resume` RPC calls. This lets hosts attach namespaced, implementation-specific metadata to tools without expanding the typed public contract; unknown keys are preserved and round-tripped untouched. ([#1864](https://github.com/github/copilot-sdk/pull/1864)) + +```ts +session.defineTool("my-tool", { metadata: { "myapp:priority": 1 } }, handler); +``` + +```cs +session.DefineTool("my-tool", new ToolOptions { Metadata = new() { ["myapp:priority"] = 1 } }, handler); +``` + +### Other changes + +- feature: **[All SDKs]** add `canvasProvider` field to session create/resume config so hosts can supply a stable canvas-provider identity that survives cold resume ([#1847](https://github.com/github/copilot-sdk/pull/1847)) +- feature: **[All SDKs]** forward `enableManagedSettings` flag in session create/resume for enterprise managed-settings enforcement ([#1925](https://github.com/github/copilot-sdk/pull/1925)) +- feature: **[All SDKs]** propagate `agentId`, `parentAgentId`, and `interactionType` from LLM inference start frames into request-handler contexts ([#1949](https://github.com/github/copilot-sdk/pull/1949)) +- improvement: **[Rust]** make tool schema and MCP server serialization deterministic by replacing `HashMap` with `IndexMap` ([#1931](https://github.com/github/copilot-sdk/pull/1931)) +- improvement: **[Rust]** use `native-tls` for the build-time CLI download ([#1964](https://github.com/github/copilot-sdk/pull/1964)) +- bugfix: **[.NET]** avoid Windows in-process test teardown deadlock ([#1997](https://github.com/github/copilot-sdk/pull/1997)) + +### New contributors + +- @agoncal made their first contribution in [#1951](https://github.com/github/copilot-sdk/pull/1951) +- @Shivam60 made their first contribution in [#1964](https://github.com/github/copilot-sdk/pull/1964) +- @rinceyuan made their first contribution in [#1978](https://github.com/github/copilot-sdk/pull/1978) +- @belaltaher8 made their first contribution in [#1864](https://github.com/github/copilot-sdk/pull/1864) + +## [java/v1.0.6](https://github.com/github/copilot-sdk/releases/tag/java/v1.0.6) (2026-07-08) + +### Feature: inline lambda tool definitions + +Developers can now define tools directly at the call site using `ToolDefinition.from(...)` with typed lambda handlers and `Param.of(...)` parameter metadata — no separate annotated class required. Async variants (`fromAsync`) and `ToolInvocation` context injection (`fromWithToolInvocation`) are also available. ([#1895](https://github.com/github/copilot-sdk/pull/1895)) + +```java +ToolDefinition greet = ToolDefinition.from( + "greet", "Greets a user by name", + Param.of(String.class, "name", "The user's name"), + name -> "Hello, " + name + "!"); +``` + +### Other changes + +- bugfix: **[Java]** preserve explicit null map values in JSON-RPC params so user setting clears reach the CLI ([#1906](https://github.com/github/copilot-sdk/pull/1906)) +- feature: **[Java]** add experimental `onGitHubTelemetry` callback on `CopilotClientOptions` for receiving forwarded GitHub telemetry events ([#1835](https://github.com/github/copilot-sdk/pull/1835)) + +## [java/v1.0.5-01](https://github.com/github/copilot-sdk/releases/tag/java/v1.0.5-01) (2026-07-01) + +### Feature: new session options — citations, agent exclusions, and credit limits + +Three new options are available on `SessionConfig` and `ResumeSessionConfig`. `enableCitations` (experimental) enables native model citations for supported providers; `excludedBuiltInAgents` hides named built-in agents from discovery; and `sessionLimits` sets a per-session AI-credit budget. ([#1865](https://github.com/github/copilot-sdk/pull/1865)) + +```java +SessionConfig config = new SessionConfig() + .setEnableCitations(true) + .setExcludedBuiltInAgents(List.of("copilot")) + .setSessionLimits(new SessionLimitsConfig(100.0)); +``` + +### New contributors + +- @coleflennikenmsft made their first contribution in [#1854](https://github.com/github/copilot-sdk/pull/1854) +- @szabta89 made their first contribution in [#1856](https://github.com/github/copilot-sdk/pull/1856) + +## [v1.0.5](https://github.com/github/copilot-sdk/releases/tag/v1.0.5) (2026-07-01) + +### Feature: MCP OAuth host token handlers + +SDK applications can now handle OAuth challenges from MCP servers that require host-provided authentication. Register an `onMcpAuthRequest` callback on the session config and the SDK will invoke it whenever an MCP server responds with a `401 WWW-Authenticate` challenge; return an access token (or cancel the request). Supports initial auth, refresh, reauth, and upscope flows across all SDKs. ([#1669](https://github.com/github/copilot-sdk/pull/1669)) + +```ts +const session = await client.createSession({ + onMcpAuthRequest: async (request) => ({ + accessToken: await myIdentityProvider.getToken(request.serverUrl), + }), +}); +``` + +```cs +var session = await client.CreateSessionAsync(new SessionConfig +{ + OnMcpAuthRequest = async ctx => + McpAuthResult.FromToken(new McpAuthToken + { + AccessToken = await myIdentityProvider.GetTokenAsync(ctx.ServerUrl) + }), +}); +``` + +### Feature: session options for citations, excluded agents, and spending limits + +Three additional session configuration options are now available across all SDKs. ([#1865](https://github.com/github/copilot-sdk/pull/1865)) + +```ts +const session = await client.createSession({ + enableCitations: true, + excludedBuiltinAgents: ["github-search"], + sessionLimits: { maxAiCredits: 10 }, +}); +``` + +```cs +var session = await client.CreateSessionAsync(new SessionConfig +{ + EnableCitations = true, + ExcludedBuiltInAgents = ["github-search"], + SessionLimits = new SessionLimitsConfig { MaxAiCredits = 10 }, +}); +``` + +### Other changes + +- improvement: **[All SDKs]** rename BYOK callback field `getBearerToken` → `bearerTokenProvider`; add `sessionId` to `ProviderTokenArgs` for per-session token scoping ([#1796](https://github.com/github/copilot-sdk/pull/1796)) +- bugfix: **[Node]** fix MCP OAuth `registerInterest` sent before `session.resume`, causing "Session not found" errors when resuming a session with `onMcpAuthRequest` ([#1861](https://github.com/github/copilot-sdk/pull/1861)) +- feature: **[Java]** `@CopilotTool` and `@CopilotToolParam` annotations with compile-time annotation processor for ergonomic tool registration via `ToolDefinition.fromObject()` ([#1792](https://github.com/github/copilot-sdk/pull/1792), [#1838](https://github.com/github/copilot-sdk/pull/1838)) +- feature: **[Java]** `ToolInvocation` parameter injection in `@CopilotTool` methods for accessing session context without exposing it to the LLM schema ([#1832](https://github.com/github/copilot-sdk/pull/1832)) +- feature: **[Rust]** add 9 GitHub-anchored variants to `Attachment` enum (`GitHubCommit`, `GitHubRelease`, `GitHubActionsJob`, `GitHubRepository`, `GitHubFileDiff`, `GitHubTreeComparison`, `GitHubUrl`, `GitHubFile`, `GitHubSnippet`) ([#1823](https://github.com/github/copilot-sdk/pull/1823)) + +### New contributors + +- @pallaviraiturkar0 made their first contribution in [#1823](https://github.com/github/copilot-sdk/pull/1823) +- @roji made their first contribution in [#1827](https://github.com/github/copilot-sdk/pull/1827) +## [java/v1.0.4](https://github.com/github/copilot-sdk/releases/tag/java/v1.0.4) (2026-06-25) + +### Feature: HTTP request callback support + +Register a `CopilotRequestHandler` on the client to intercept every outbound LLM inference HTTP or WebSocket request — for both BYOK and CAPI — and mutate, replace, or fully forward it. Useful for logging, header injection, model substitution, or custom routing. ([#1689](https://github.com/github/copilot-sdk/pull/1689), [#1775](https://github.com/github/copilot-sdk/pull/1775), [#1784](https://github.com/github/copilot-sdk/pull/1784)) + +```java +final class MyHandler extends CopilotRequestHandler { + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext ctx) throws Exception { + HttpRequest mutated = HttpRequest.newBuilder(request, (n, v) -> true) + .header("X-Debug-Session", ctx.sessionId() == null ? "none" : ctx.sessionId()) + .build(); + return super.sendRequest(mutated, ctx); + } +} + +CopilotClient client = new CopilotClient( + new CopilotClientOptions().setRequestHandler(new MyHandler())); +``` + +### Feature: `getBearerToken` callback for BYOK providers (Managed Identity) + +BYOK provider configs now accept a `getBearerToken` callback so the SDK consumer can resolve bearer tokens (e.g. Azure Managed Identity) on demand. The SDK takes zero Azure SDK dependency — the consumer supplies the callback using any identity library. ([#1748](https://github.com/github/copilot-sdk/pull/1748)) + +```java +var provider = new ProviderConfig() + .setType("openai") + .setBaseUrl(baseUrl) + .setGetBearerToken(args -> cred.getToken(ctx).map(AccessToken::getToken).toFuture()); +``` + +### Feature: experimental multi-provider BYOK registry + +Register multiple named providers and models on a single session via `NamedProviderConfig` and `ProviderModelConfig`. Custom agents can reference provider-qualified model IDs such as `"alpha/sonnet"`. This feature is experimental. ([#1718](https://github.com/github/copilot-sdk/pull/1718)) + +### Feature: `preamble` system message section and `preserve` action + +Two new customization options for system message sections. `SystemMessageSections.PREAMBLE` targets only the identity preamble without affecting its sibling sub-sections (`identity` and `tool_instructions` are now documented as section groups). The new `preserve` action protects an individually-addressable section from a group-level `remove`. ([#1713](https://github.com/github/copilot-sdk/pull/1713)) + +### Other changes + +- feature: add optional `memory` configuration (`MemoryConfiguration`) to session create and resume ([#1617](https://github.com/github/copilot-sdk/pull/1617)) +- feature: `defer` parameter on tool definitions controls eager vs. lazy tool loading (`"auto"` or `"never"`) ([#1632](https://github.com/github/copilot-sdk/pull/1632)) +- feature: `otlpProtocol` telemetry option for configuring OTLP export transport (`"http/json"` or `"http/protobuf"`) ([#1648](https://github.com/github/copilot-sdk/pull/1648)) +- feature: `ModelBilling.tokenPrices` surfaced on public SDK types, exposing per-tier pricing and context window limits ([#1633](https://github.com/github/copilot-sdk/pull/1633)) +- feature: `CapiSessionOptions.enableWebSocketResponses` and `ProviderConfig.transport` for WebSocket transport control on session create/resume ([#1711](https://github.com/github/copilot-sdk/pull/1711)) +- improvement: call `runtime.shutdown` during client stop for deterministic OTEL telemetry flush before process cleanup ([#1667](https://github.com/github/copilot-sdk/pull/1667)) +- improvement: rename `SystemPromptSections` → `SystemMessageSections` for cross-SDK consistency; old class deprecated with `forRemoval=true` ([#1683](https://github.com/github/copilot-sdk/pull/1683)) + +### New contributors + +- @almaleksia made their first contribution in [#1632](https://github.com/github/copilot-sdk/pull/1632) +- @dereklegenzoff made their first contribution in [#1711](https://github.com/github/copilot-sdk/pull/1711) +- @ellismg made their first contribution in [#1750](https://github.com/github/copilot-sdk/pull/1750) + +## [v1.0.2](https://github.com/github/copilot-sdk/releases/tag/v1.0.2) (2026-06-18) + +### Feature: opt-in memory for sessions + +Sessions can now be configured with persistent memory, allowing the agent to recall information across turns. Set `memory: { enabled: true }` when creating or resuming a session; when omitted the runtime default applies. ([#1617](https://github.com/github/copilot-sdk/pull/1617)) + +```ts +const session = await client.createSession({ + memory: { enabled: true }, +}); +``` + +```cs +var session = await client.CreateSessionAsync(new SessionConfig +{ + Memory = new MemoryConfiguration { Enabled = true } +}); +``` + +### Feature: `defer` parameter for tool definitions + +Tools now support a `defer` option controlling whether they are pre-loaded eagerly or surfaced lazily through tool search. Use `"auto"` (the default) to allow lazy loading, or `"never"` to force pre-loading. ([#1632](https://github.com/github/copilot-sdk/pull/1632)) + +```ts +defineTool("lookup_issue", { + description: "Fetch issue details", + parameters: z.object({ id: z.string() }), + defer: "auto", + handler: async ({ id }) => { /* ... */ }, +}); +``` + +```cs +var tool = CopilotTool.DefineTool( + async ([Description("Issue ID")] string id) => { /* ... */ }, + toolOptions: new CopilotToolOptions { Defer = CopilotToolDefer.Auto }); +``` + +### Other changes + +- feature: **[All SDKs]** add `otlpProtocol` telemetry option (`"http/json"` or `"http/protobuf"`) for configuring OTLP export transport ([#1648](https://github.com/github/copilot-sdk/pull/1648)) +- feature: **[All SDKs]** surface `ModelBilling.tokenPrices` on public SDK types, exposing per-tier input/output/cache pricing and context window limits ([#1633](https://github.com/github/copilot-sdk/pull/1633)) +- improvement: **[All SDKs]** call `runtime.shutdown` during normal client stop for deterministic OTEL telemetry flush before process cleanup ([#1667](https://github.com/github/copilot-sdk/pull/1667)) +- improvement: **[Go]** thread `context.Context` through the JSON-RPC request path for proper cancellation support ([#1643](https://github.com/github/copilot-sdk/pull/1643)) +- improvement: **[Java]** add `getOpenCanvases()` to `CopilotSession` to track currently open canvas instances, matching the other SDKs ([#1606](https://github.com/github/copilot-sdk/pull/1606)) +- improvement: **[Java]** rename `SystemPromptSections` to `SystemMessageSections` for cross-SDK consistency; old class deprecated with `forRemoval=true` ([#1683](https://github.com/github/copilot-sdk/pull/1683)) +- bugfix: **[Python]** round sub-millisecond durations in `to_timedelta_int` to avoid serialization errors ([#1668](https://github.com/github/copilot-sdk/pull/1668)) +- bugfix: **[Rust]** skip CLI binary download in `build.rs` when `DOCS_RS` env var is set ([#1660](https://github.com/github/copilot-sdk/pull/1660)) + +### New contributors + +- @andyfeller made their first contribution in [#1631](https://github.com/github/copilot-sdk/pull/1631) +- @almaleksia made their first contribution in [#1632](https://github.com/github/copilot-sdk/pull/1632) +- @idryzhov made their first contribution in [#1668](https://github.com/github/copilot-sdk/pull/1668) +- @scottaddie made their first contribution in [#1636](https://github.com/github/copilot-sdk/pull/1636) + ## [v0.2.2](https://github.com/github/copilot-sdk/releases/tag/v0.2.2) (2026-04-10) ### Feature: `enableConfigDiscovery` for automatic MCP and skill config loading diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fa57dbe6..5135e596d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thanks for your interest in contributing! -This repository contains the Copilot SDK, a set of multi-language SDKs (Node/TypeScript, Python, Go, .NET, Rust) for building applications with the GitHub Copilot agent, maintained by the GitHub Copilot team. +This repository contains the Copilot SDK, a set of multi-language SDKs (Node/TypeScript, Python, Go, .NET, Java, and Rust) for building applications with the GitHub Copilot agent, maintained by the GitHub Copilot team. Contributions 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). @@ -33,63 +33,26 @@ We are generally **not** looking for: - Additional documentation - **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. -## Prerequisites for Running and Testing Code +## Developing an SDK -This is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on: +Setup, build, and test instructions are maintained with each SDK: -### All SDKs - -1. 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`. - -### Node.js/TypeScript SDK - -1. Install [Node.js](https://nodejs.org/) (v18+) -1. Install dependencies: `cd nodejs && npm ci` - -### Python SDK - -1. Install [Python 3.8+](https://www.python.org/downloads/) -1. Install [uv](https://github.com/astral-sh/uv) -1. Install dependencies: `cd python && uv pip install -e ".[dev]"` - -### Go SDK - -1. Install [Go 1.24+](https://go.dev/doc/install) -1. Install [golangci-lint](https://golangci-lint.run/welcome/install/#local-installation) -1. Install dependencies: `cd go && go mod download` - -### .NET SDK - -1. Install [.NET 8.0+](https://dotnet.microsoft.com/download) -1. Install .NET dependencies: `cd dotnet && dotnet restore` +- [Node.js/TypeScript](nodejs/README.md#development) +- [Python](python/README.md#development) +- [Go](go/README.md#development) +- [.NET](dotnet/README.md#development) +- [Rust](rust/README.md#development) +- [Java](java/README.md#development-setup) ## Submitting a Pull Request 1. Fork and clone the repository -1. Install dependencies for the SDK(s) you're modifying (see above) -1. Make sure the tests pass on your machine (see commands below) -1. Make sure linter passes on your machine (see commands below) +1. Follow the development instructions for the SDK(s) you're modifying 1. Create a new branch: `git checkout -b my-branch-name` -1. Make your change, add tests, and make sure the tests and linter still pass +1. Make your change, add tests, and run the documented checks 1. Push to your fork and [submit a pull request][pr] 1. Pat yourself on the back and wait for your pull request to be reviewed and merged. -### Running Tests and Linters - -```bash -# Node.js -cd nodejs && npm test && npm run lint - -# Python -cd python && uv run pytest && uv run ruff check . - -# Go -cd go && go test ./... && golangci-lint run ./... - -# .NET -cd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj -``` - Here are a few things you can do that will increase the likelihood of your pull request being accepted: - Write tests. diff --git a/README.md b/README.md index ceb7a5b35..b2ef69d05 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,20 @@ Agents for every app. -Embed Copilot's agentic workflows in your application—now available in public preview as a programmable SDK for Python, TypeScript, Go, .NET, and Java. A Rust SDK is also available in technical preview. +Embed Copilot's agentic workflows in your application with the GitHub Copilot SDK for Python, TypeScript, Go, .NET, Java, and Rust. The 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. ## Available SDKs -| SDK | Location | Cookbook | Installation | -| ------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **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` | -| **Python** | [`python/`](./python/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/python/README.md) | `pip install github-copilot-sdk` | -| **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` | -| **.NET** | [`dotnet/`](./dotnet/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` | -| **Rust** | [`rust/`](./rust/) | — | `cargo add github-copilot-sdk` | -| **Java** | [`java/`](./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](./java/README.md#maven) and [Gradle](./java/README.md#gradle) | +| SDK | Location | Cookbook | Installation | API docs | +| ------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| **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` | | +| **Python** | [`python/`](./python/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/python/README.md) | `pip install github-copilot-sdk` | | +| **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` | [API docs](https://pkg.go.dev/github.com/github/copilot-sdk/go#readme-api-reference) | +| **.NET** | [`dotnet/`](./dotnet/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` | | +| **Rust** | [`rust/`](./rust/) | — | `cargo add github-copilot-sdk` | [API docs](https://docs.rs/github-copilot-sdk/latest/github_copilot_sdk/#api-reference) | +| **Java** | [`java/`](./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](./java/README.md#maven) and [Gradle](./java/README.md#gradle) | [API docs](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/) | See the individual SDK READMEs for installation, usage examples, and API reference. @@ -37,7 +37,7 @@ Quick steps: 1. **(Optional) Install the Copilot CLI** For Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically and no separate installation is required. -For the Go, Java and Rust SDKs, [install the CLI manually](https://github.com/features/copilot/cli) or ensure `copilot` is available in your PATH unless you opt into their application-level CLI bundling features. +For Go, Java, and Rust, [install the CLI manually](https://github.com/features/copilot/cli) or ensure `copilot` is available in your PATH. Go and Rust also expose application-level CLI bundling features. 2. **Install your preferred SDK** using the commands above. @@ -65,11 +65,11 @@ Yes, a GitHub Copilot subscription is required to use the GitHub Copilot SDK, ** ### How does billing work for SDK usage? -Billing 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). +Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your usage allowance. For more information on Copilot usage billing, see [Usage in GitHub Copilot](https://docs.github.com/en/copilot/reference/copilot-billing/models-and-pricing). ### Does it support BYOK (Bring Your Own Key)? -Yes, 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. +Yes, 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, Microsoft Foundry, Anthropic) to access models through those providers. See the **[BYOK documentation](./docs/auth/byok.md)** for setup instructions and examples. **Note:** BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported. @@ -82,13 +82,13 @@ The SDK supports multiple authentication methods: - **Environment variables** - `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, `GITHUB_TOKEN` - **BYOK** - Use your own API keys (no GitHub auth required) -See the **[Authentication documentation](./docs/auth/index.md)** for details on each method. +See the **[Authentication documentation](./docs/auth/README.md)** for details on each method. ### Do I need to install the Copilot CLI separately? No — for Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically as a dependency. You do not need to install it separately. -For Go, Java and Rust SDKs, the CLI is **not** bundled by default. Install the CLI manually, ensure `copilot` is available in your PATH, or opt into their application-level CLI bundling features. +For Go, Java, and Rust SDKs, the CLI is **not** bundled by default. Install the CLI manually or ensure `copilot` is available in your PATH. Go and Rust also expose application-level CLI bundling features. Advanced: You can override the CLI binary or connect to an external server. See the individual SDK README for language-specific options. @@ -117,7 +117,7 @@ All models available via Copilot CLI are supported in the SDK. The SDK also expo ### Is the SDK production-ready? -The 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. +The GitHub Copilot SDK is generally available and follows semantic versioning. See [CHANGELOG.md](./CHANGELOG.md) for release notes. ### How do I report issues or request features? @@ -125,11 +125,11 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag ## Quick Links -- **[Documentation](./docs/index.md)** – Full documentation index +- **[Documentation](./docs/README.md)** – Full documentation index - **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running -- **[Setup Guides](./docs/setup/index.md)** – Architecture, deployment, and scaling -- **[Authentication](./docs/auth/index.md)** – GitHub OAuth, BYOK, and more -- **[Features](./docs/features/index.md)** – Hooks, custom agents, MCP, skills, and more +- **[Setup Guides](./docs/setup/README.md)** – Architecture, deployment, and scaling +- **[Authentication](./docs/auth/README.md)** – GitHub OAuth, BYOK, and more +- **[Features](./docs/features/README.md)** – Hooks, custom agents, MCP, skills, and more - **[Troubleshooting](./docs/troubleshooting/debugging.md)** – Common issues and solutions - **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages - **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..3be019f14 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,84 @@ +# Copilot SDK + +Welcome 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. + +## Where to start + +| I want to... | Go to | +|---|---| +| **Build my first app** | [Getting Started](./getting-started.md)—end-to-end tutorial with streaming & custom tools | +| **Set up for production** | [Setup Guides](./setup/README.md)—architecture, deployment patterns, scaling | +| **Configure authentication** | [Authentication](./auth/README.md)—GitHub OAuth, server-to-server authentication, environment variables, BYOK | +| **Add features to my app** | [Features](./features/README.md)—hooks, custom agents, MCP, skills, and more | +| **Debug an issue** | [Troubleshooting](./troubleshooting/debugging.md)—common problems and solutions | + +## Documentation map + +### [Getting Started](./getting-started.md) + +Step-by-step tutorial that takes you from zero to a working Copilot app with streaming responses and custom tools. + +### [Setup](./setup/README.md) + +How to configure and deploy the SDK for your use case. + +* [Default Setup (Bundled CLI)](./setup/bundled-cli.md): the SDK includes the CLI automatically +* [Local CLI](./setup/local-cli.md): use your own CLI binary or running instance +* [Backend Services](./setup/backend-services.md): server-side with headless CLI over TCP +* [GitHub OAuth](./setup/github-oauth.md): implement the OAuth flow +* [Azure Managed Identity](./setup/azure-managed-identity.md): BYOK with Microsoft Foundry +* [Scaling & Multi-Tenancy](./setup/scaling.md): horizontal scaling, isolation patterns +* [Multi-Tenancy & Server Deployments](./setup/multi-tenancy.md): mode: "empty", session isolation, integration IDs, sessionFs + +### [Authentication](./auth/README.md) + +Configuring how users and services authenticate with Copilot. + +* [Authentication Overview](./auth/README.md): methods, priority order, and examples +* [Server-to-server authentication](./auth/server-to-server-tokens.md): use GitHub Actions or GitHub App installation tokens for organization-attributed automation +* [Bring Your Own Key (BYOK)](./auth/byok.md): use your own API keys from OpenAI, Azure, Anthropic, and more + +### [Features](./features/README.md) + +Guides for building with the SDK's capabilities. + +* [Hooks](./features/hooks.md): intercept and customize session behavior +* [Custom Agents](./features/custom-agents.md): define specialized sub-agents +* [MCP Servers](./features/mcp.md): integrate Model Context Protocol servers +* [Skills](./features/skills.md): load reusable prompt modules +* [Plugin Directories](./features/plugin-directories.md): bundle skills, hooks, MCP servers, and agents as a single loadable plugin +* [Session limits](./features/session-limits.md): set an AI Credits budget for a session +* [Image Input](./features/image-input.md): send images as attachments +* [Streaming Events](./features/streaming-events.md): real-time event reference +* [Steering & Queueing](./features/steering-and-queueing.md): message delivery modes +* [Session Persistence](./features/session-persistence.md): resume sessions across restarts +* [Remote Sessions](./features/remote-sessions.md): share sessions to GitHub web and mobile via Mission Control +* [Cloud Sessions](./features/cloud-sessions.md): run sessions on GitHub-hosted compute with the cloud: option +* [Fleet Mode](./features/fleet-mode.md): dispatch parallel sub-agents for parallelizable work + +### [Hooks Reference](./hooks/README.md) + +Detailed API reference for each session hook. + +* [Pre-Tool Use](./hooks/pre-tool-use.md): approve, deny, or modify tool calls +* [Post-Tool Use](./hooks/post-tool-use.md): transform tool results +* [User Prompt Submitted](./hooks/user-prompt-submitted.md): modify or filter user messages +* [User Prompt Transformed](./hooks/user-prompt-transformed.md): inspect or replace model-facing prompts +* [Session Lifecycle](./hooks/session-lifecycle.md): session start and end +* [Error Handling](./hooks/error-handling.md): custom error handling + +### [Troubleshooting](./troubleshooting/debugging.md) + +* [Debugging Guide](./troubleshooting/debugging.md): common issues and solutions +* [MCP Debugging](./troubleshooting/mcp-debugging.md): MCP-specific troubleshooting +* [Compatibility](./troubleshooting/compatibility.md): SDK vs CLI feature matrix + +### [Observability](./observability/opentelemetry.md) + +* [OpenTelemetry Instrumentation](./observability/opentelemetry.md): built-in TelemetryConfig and trace context propagation + +### [Integrations](./integrations/microsoft-agent-framework.md) + +Guides for using the SDK with other platforms and frameworks. + +* [Microsoft Agent Framework](./integrations/microsoft-agent-framework.md): MAF multi-agent workflows diff --git a/docs/auth/README.md b/docs/auth/README.md new file mode 100644 index 000000000..a85d6de6e --- /dev/null +++ b/docs/auth/README.md @@ -0,0 +1,13 @@ +# Authentication + +Choose the authentication method that best fits your deployment scenario for the GitHub Copilot SDK. + +* [Authenticate Copilot SDK](authenticate.md): methods, priority order, and examples +* [Server-to-server authentication](server-to-server-tokens.md): use GitHub Actions or GitHub App installation tokens for organization-attributed automation +* [Bring your own key (BYOK)](./byok.md): use your own API keys from OpenAI, Azure, Anthropic, and more + +## Authentication priority + +When multiple credentials are configured, an explicit SDK token takes priority, followed by direct Copilot API environment authentication, environment variable GitHub tokens, stored Copilot CLI credentials, and then GitHub CLI credentials. Server-to-server installation tokens use the environment variable path. See [Authenticate Copilot SDK](authenticate.md#authentication-priority) for details. + +For multi-user server mode, pass a per-session `gitHubToken` so each session runs with the correct GitHub identity; see [Multi-user and server deployments](../setup/multi-tenancy.md). diff --git a/docs/auth/authenticate.md b/docs/auth/authenticate.md index 36bc855f5..d54c95451 100644 --- a/docs/auth/authenticate.md +++ b/docs/auth/authenticate.md @@ -9,7 +9,8 @@ The GitHub Copilot SDK supports multiple authentication methods to fit different | [GitHub Signed-in User](#github-signed-in-user) | Interactive apps where users sign in with GitHub | Yes | | [OAuth GitHub App](#oauth-github-app) | Apps acting on behalf of users via OAuth | Yes | | [Environment Variables](#environment-variables) | CI/CD, automation, server-to-server | Yes | -| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, etc.) | No | +| [Server-to-server authentication](./server-to-server-tokens.md) | Organization-attributed automation and direct organization billing | No user subscription; organization policy required | +| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Microsoft Foundry, OpenAI, and more) | No | ## GitHub signed-in user @@ -167,7 +168,7 @@ func main() { import copilot "github.com/github/copilot-sdk/go" client := copilot.NewClient(&copilot.ClientOptions{ - GithubToken: userAccessToken, // Token from OAuth flow + GitHubToken: userAccessToken, // Token from OAuth flow UseLoggedInUser: copilot.Bool(false), // Don't use stored CLI credentials }) ``` @@ -221,7 +222,7 @@ client.start().get(); **Supported token types:** * `gho_` - OAuth user access tokens -* `ghu_` - GitHub App user access tokens +* `ghu_` - GitHub App user access tokens * `github_pat_` - Fine-grained personal access tokens **Not supported:** @@ -236,6 +237,8 @@ client.start().get(); For automation, CI/CD pipelines, and server-to-server scenarios, you can authenticate using environment variables. +For organization-attributed automation that should not use a user's personal access token, see [Server-to-server authentication](./server-to-server-tokens.md). + **Supported environment variables (in priority order):** 1. `COPILOT_GITHUB_TOKEN` - Recommended for explicit Copilot usage 1. `GH_TOKEN` - GitHub CLI compatible @@ -275,23 +278,23 @@ await client.start()
**When to use:** -* CI/CD pipelines (GitHub Actions, Jenkins, etc.) +* CI/CD pipelines (GitHub Actions, Jenkins, and more) * Automated testing * Server-side applications with service accounts * Development when you don't want to use interactive login ## BYOK (bring your own key) -BYOK allows you to use your own API keys from model providers like Azure AI Foundry, OpenAI, or Anthropic. This bypasses GitHub Copilot authentication entirely. +BYOK allows you to use your own API keys from model providers like Microsoft Foundry, OpenAI, or Anthropic. This bypasses GitHub Copilot authentication entirely. **Key benefits:** * No GitHub Copilot subscription required * Use enterprise model deployments * Direct billing with your model provider -* Support for Azure AI Foundry, OpenAI, Anthropic, and OpenAI-compatible endpoints +* Support for Microsoft Foundry, OpenAI, Anthropic, and OpenAI-compatible endpoints **See the [BYOK documentation](./byok.md) for complete details**, including: -* Azure AI Foundry setup +* Microsoft Foundry setup * Provider configuration options * Limitations and considerations * Complete code examples @@ -300,13 +303,14 @@ BYOK allows you to use your own API keys from model providers like Azure AI Foun When multiple authentication methods are available, the SDK uses them in this priority order: -1. **Explicit `gitHubToken`** - Token passed directly to SDK constructor -1. **HMAC key** - `CAPI_HMAC_KEY` or `COPILOT_HMAC_KEY` environment variables +1. **Explicit `gitHubToken`** - Token passed directly to the SDK client or session configuration 1. **Direct API token** - `GITHUB_COPILOT_API_TOKEN` with `COPILOT_API_URL` 1. **Environment variable tokens** - `COPILOT_GITHUB_TOKEN` → `GH_TOKEN` → `GITHUB_TOKEN` 1. **Stored OAuth credentials** - From previous `copilot` CLI login 1. **GitHub CLI** - `gh auth` credentials +For multi-user server mode, pass a per-session `gitHubToken` so each session runs with the correct GitHub identity; see [Multi-user and server deployments](../setup/multi-tenancy.md). + ## Disabling auto-login To prevent the SDK from automatically using stored credentials or `gh` CLI auth, use the `useLoggedInUser: false` option: diff --git a/docs/auth/byok.md b/docs/auth/byok.md index 8bfc5d50c..0fbf9bd8e 100644 --- a/docs/auth/byok.md +++ b/docs/auth/byok.md @@ -7,15 +7,15 @@ BYOK allows you to use the Copilot SDK with your own API keys from model provide | Provider | Type Value | Notes | |----------|------------|-------| | OpenAI | `"openai"` | OpenAI API and OpenAI-compatible endpoints | -| Azure OpenAI / Azure AI Foundry | `"azure"` | Azure-hosted models | +| Microsoft Foundry / Azure OpenAI | `"openai"` or `"azure"` | Use `"openai"` for `/openai/v1/`; use `"azure"` for native Azure endpoints | | Anthropic | `"anthropic"` | Claude models | | Ollama | `"openai"` | Local models via OpenAI-compatible API | | Microsoft Foundry Local | `"openai"` | Run AI models locally on your device via OpenAI-compatible API | | Other OpenAI-compatible | `"openai"` | vLLM, LiteLLM, etc. | -## Quick start: Azure AI Foundry +## Quick start: Microsoft Foundry -Azure AI Foundry (formerly Azure OpenAI) is a common BYOK deployment target for enterprises. Here's a complete example: +Microsoft Foundry is a common BYOK deployment target for enterprises. Here's a complete example:
Python @@ -26,7 +26,7 @@ import os from copilot import CopilotClient from copilot.session import PermissionHandler -FOUNDRY_MODEL_URL = "https://your-resource.openai.azure.com/openai/v1/" +FOUNDRY_MODEL_URL = "https://.openai.azure.com/openai/v1/" # Set FOUNDRY_API_KEY environment variable async def main(): @@ -66,7 +66,7 @@ asyncio.run(main()) ```typescript import { CopilotClient } from "@github/copilot-sdk"; -const FOUNDRY_MODEL_URL = "https://your-resource.openai.azure.com/openai/v1/"; +const FOUNDRY_MODEL_URL = "https://.openai.azure.com/openai/v1/"; const client = new CopilotClient(); const session = await client.createSession({ @@ -114,8 +114,8 @@ func main() { Model: "gpt-5.2-codex", // Your deployment name Provider: &copilot.ProviderConfig{ Type: "openai", - BaseURL: "https://your-resource.openai.azure.com/openai/v1/", - WireApi: "responses", // Use "completions" for older models + BaseURL: "https://.openai.azure.com/openai/v1/", + WireAPI: "responses", // Use "completions" for older models APIKey: os.Getenv("FOUNDRY_API_KEY"), }, }) @@ -151,7 +151,7 @@ await using var session = await client.CreateSessionAsync(new SessionConfig Provider = new ProviderConfig { Type = "openai", - BaseUrl = "https://your-resource.openai.azure.com/openai/v1/", + BaseUrl = "https://.openai.azure.com/openai/v1/", WireApi = "responses", // Use "completions" for older models ApiKey = Environment.GetEnvironmentVariable("FOUNDRY_API_KEY"), }, @@ -181,7 +181,7 @@ var session = client.createSession(new SessionConfig() .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) .setProvider(new ProviderConfig() .setType("openai") - .setBaseUrl("https://your-resource.openai.azure.com/openai/v1/") + .setBaseUrl("https://.openai.azure.com/openai/v1/") .setWireApi("responses") // Use "completions" for older models .setApiKey(System.getenv("FOUNDRY_API_KEY"))) ).get(); @@ -205,15 +205,18 @@ client.stop().get(); | `baseUrl` / `base_url` | string | **Required.** API endpoint URL | | `apiKey` / `api_key` | string | API key (optional for local providers like Ollama) | | `bearerToken` / `bearer_token` | string | Bearer token auth (takes precedence over apiKey) | -| `wireApi` / `wire_api` | `"completions"` \| `"responses"` | API format (default: `"completions"`) | -| `azure.apiVersion` / `azure.api_version` | string | Azure API version (default: `"2024-10-21"`) | +| `bearerTokenProvider` / `bearer_token_provider` | callback | Returns a bearer token on demand (takes precedence over `apiKey` and `bearerToken`) | +| `wireApi` / `wire_api` | `"completions"` \| `"responses"` | Select `"completions"` for broad model compatibility (the Chat Completions API); select `"responses"` for multi-turn state management, tool namespacing, and reasoning support (the Responses API). Anthropic models always use the Messages API regardless of this setting. | +| `azure.apiVersion` / `azure.api_version` | string | Azure API version. When set, the runtime uses the versioned deployment route; when omitted, it uses the GA versionless `v1` route. | ### Wire API format The `wireApi` setting determines which OpenAI API format to use: -* **`"completions"`** (default) - Chat Completions API (`/chat/completions`). Use for most models. -* **`"responses"`** - Responses API. Use for GPT-5 series models that support the newer responses format. +* **`"completions"`** (default) - Chat Completions API (`/chat/completions`) for broad model compatibility. +* **`"responses"`** - Responses API for multi-turn state management, tool namespacing, and reasoning support. + +Anthropic models always use the Anthropic Messages API regardless of this setting. ### Type-specific notes @@ -257,14 +260,14 @@ provider: { } ``` -### Azure AI Foundry (OpenAI-compatible endpoint) +### Microsoft Foundry (OpenAI-compatible endpoint) -For Azure AI Foundry deployments with `/openai/v1/` endpoints, use `type: "openai"`: +For Microsoft Foundry deployments with `/openai/v1/` endpoints, use `type: "openai"`: ```typescript provider: { type: "openai", - baseUrl: "https://your-resource.openai.azure.com/openai/v1/", + baseUrl: "https://.openai.azure.com/openai/v1/", apiKey: process.env.FOUNDRY_API_KEY, wireApi: "responses", // For GPT-5 series models } @@ -324,12 +327,14 @@ provider: { ### Bearer token authentication -Some providers require bearer token authentication instead of API keys: +Some providers require bearer token authentication instead of API keys. Supply a static token with `bearerToken`, or supply a `bearerTokenProvider` callback that the GitHub Copilot SDK runtime invokes before outbound provider requests. The callback or identity library it wraps manages token caching and refresh. + +Use `bearerToken` when your application already has a token: ```typescript provider: { type: "openai", - baseUrl: "https://my-custom-endpoint.example.com/v1", + baseUrl: "https://.openai.azure.com/openai/v1/", bearerToken: process.env.MY_BEARER_TOKEN, // Sets Authorization header } ``` @@ -337,6 +342,22 @@ provider: { > [!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. +Use `bearerTokenProvider` to acquire tokens on demand: + + + +```typescript +provider: { + type: "openai", + baseUrl: "https://my-custom-endpoint.example.com/v1", + bearerTokenProvider: async () => { + return await acquireBearerToken(); + }, +} +``` + +For more details about acquiring and refreshing Microsoft Entra bearer tokens, see [Azure Managed Identity with BYOK](../setup/azure-managed-identity.md). + ## Custom model listing When 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. @@ -407,7 +428,7 @@ func main() { Name: "My Custom Model", Capabilities: copilot.ModelCapabilities{ Supports: copilot.ModelSupports{Vision: false, ReasoningEffort: false}, - Limits: copilot.ModelLimits{MaxContextWindowTokens: 128000}, + Limits: copilot.ModelLimits{MaxContextWindowTokens: copilot.Int(128000)}, }, }, }, nil @@ -472,14 +493,6 @@ Results are cached after the first call, just like the default behavior. The han ## Limitations -When using BYOK, be aware of these limitations: - -### Identity limitations - -BYOK authentication uses **static credentials only**. - -You must use an API key or static bearer token that you manage yourself. - ### Feature limitations Some Copilot features may behave differently with BYOK: @@ -493,9 +506,8 @@ Some Copilot features may behave differently with BYOK: | Provider | Limitations | |----------|-------------| -| Azure AI Foundry | No Entra ID auth; must use API keys | -| Ollama | No API key; local only; model support varies | | [Microsoft Foundry Local](https://foundrylocal.ai) | Local only; model availability depends on device hardware; no API key required | +| Ollama | No API key; local only; model support varies | | OpenAI | Subject to OpenAI rate limits and quotas | ## Troubleshooting @@ -527,7 +539,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", provider: { type: "azure", baseUrl: "https://my-resource.openai.azure.com", @@ -550,7 +562,7 @@ provider: { } ``` -However, if your Azure AI Foundry deployment provides an OpenAI-compatible endpoint path (e.g., `/openai/v1/`), use `type: "openai"`: +However, if your Microsoft Foundry deployment provides an OpenAI-compatible endpoint path (for example, `/openai/v1/`), use `type: "openai"`: ```typescript @@ -558,7 +570,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", provider: { type: "openai", baseUrl: "https://your-resource.openai.azure.com/openai/v1/", @@ -568,7 +580,7 @@ const session = await client.createSession({ ```typescript -// ✅ Correct: OpenAI-compatible Azure AI Foundry endpoint +// ✅ Correct: OpenAI-compatible Microsoft Foundry endpoint provider: { type: "openai", baseUrl: "https://your-resource.openai.azure.com/openai/v1/", @@ -610,5 +622,5 @@ foundry model run phi-4-mini ## Next steps -* [Authentication Overview](./index.md) - Learn about all authentication methods +* [Authentication Overview](./README.md) - Learn about all authentication methods * [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app diff --git a/docs/auth/index.md b/docs/auth/index.md deleted file mode 100644 index 2d5a3914a..000000000 --- a/docs/auth/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Authentication - -Choose the authentication method that best fits your deployment scenario for the GitHub Copilot SDK. - -* [Authenticate Copilot SDK](authenticate.md): methods, priority order, and examples -* [Bring your own key (BYOK)](./byok.md): use your own API keys from OpenAI, Azure, Anthropic, and more diff --git a/docs/auth/server-to-server-tokens.md b/docs/auth/server-to-server-tokens.md new file mode 100644 index 000000000..b7b4fcf40 --- /dev/null +++ b/docs/auth/server-to-server-tokens.md @@ -0,0 +1,205 @@ +# Server-to-server authentication + +Use a short-lived installation access token when a service needs to make Copilot requests on behalf of an organization without a user's credentials. In GitHub Actions, use the built-in `GITHUB_TOKEN` instead. + +## GitHub Actions + +For workflows in an organization-owned repository, grant the built-in token permission to make Copilot requests: + +```yaml +permissions: + contents: read + copilot-requests: write + +jobs: + copilot: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - run: your-application + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +The organization's **Allow use of Copilot CLI billed to the organization** policy must be enabled. This approach needs no GitHub App or stored authentication secret. For details, see [Using Copilot CLI in GitHub Actions with GITHUB_TOKEN](https://docs.github.com/en/copilot/how-tos/copilot-cli/use-copilot-cli-in-actions). + +## Other services and CI systems + +For services outside GitHub Actions: + +1. Create a GitHub App with the **Copilot Requests** repository permission set to **Read & write**. +1. Install it on the organization that should be billed. The current Copilot permission check requires **All repositories** access. +1. [Create an installation access token](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app) with a repository ID and the Copilot permission: + + ```json + { + "repository_ids": [123456789], + "permissions": { + "copilot_requests": "write" + } + } + ``` + +1. Pass the resulting `ghs_` token to the runtime as `COPILOT_GITHUB_TOKEN`. + +The organization must be enabled for Copilot requests from GitHub App installations. Installation tokens expire after one hour. + +> [!WARNING] +> Do not pass an installation token through the SDK's `gitHubToken`, `github_token`, or equivalent option. That option is for user tokens. Installation tokens must use the runtime environment authentication path. + +## Configure the runtime + +The following examples assume the minted token is in `INSTALLATION_TOKEN`. They pass it only to the child runtime and disable fallback to stored user credentials. + +
+TypeScript + +```typescript +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; + +const token = process.env.INSTALLATION_TOKEN; +if (!token) throw new Error("INSTALLATION_TOKEN is required"); + +const client = new CopilotClient({ + connection: RuntimeConnection.forStdio(), + env: { + ...process.env, + COPILOT_GITHUB_TOKEN: token, + }, + useLoggedInUser: false, +}); +``` + +
+
+Python + +```python +import os + +from copilot import CopilotClient, RuntimeConnection + +client = CopilotClient( + connection=RuntimeConnection.for_stdio(), + env={**os.environ, "COPILOT_GITHUB_TOKEN": os.environ["INSTALLATION_TOKEN"]}, + use_logged_in_user=False, +) +``` + +
+
+Go + +```go +package main + +import ( + "log" + "os" + + copilot "github.com/github/copilot-sdk/go" +) + +func main() { + token, ok := os.LookupEnv("INSTALLATION_TOKEN") + if !ok { + log.Fatal("INSTALLATION_TOKEN is required") + } + client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.StdioConnection{}, + Env: append(os.Environ(), "COPILOT_GITHUB_TOKEN="+token), + UseLoggedInUser: copilot.Bool(false), + }) + _ = client +} +``` + +
+
+Rust + +```rust +use github_copilot_sdk::{ClientOptions, Transport}; + +fn main() { + let token = std::env::var("INSTALLATION_TOKEN").expect("INSTALLATION_TOKEN is required"); + let options = ClientOptions::new() + .with_transport(Transport::Stdio) + .with_env([("COPILOT_GITHUB_TOKEN", token)]) + .with_use_logged_in_user(false); + drop(options); +} +``` + +
+
+.NET + +```csharp +using System.Collections; +using GitHub.Copilot; + +var token = Environment.GetEnvironmentVariable("INSTALLATION_TOKEN") + ?? throw new InvalidOperationException("INSTALLATION_TOKEN is required"); +var environment = Environment.GetEnvironmentVariables() + .Cast() + .ToDictionary(entry => (string)entry.Key, entry => entry.Value?.ToString() ?? ""); +environment["COPILOT_GITHUB_TOKEN"] = token; + +await using var client = new CopilotClient(new CopilotClientOptions +{ + Connection = RuntimeConnection.ForStdio(), + Environment = environment, + UseLoggedInUser = false, +}); +``` + +
+
+Java + +```java +import com.github.copilot.CopilotClient; +import com.github.copilot.rpc.CopilotClientOptions; +import java.util.HashMap; +import java.util.Objects; + +var environment = new HashMap<>(System.getenv()); +var token = Objects.requireNonNull( + System.getenv("INSTALLATION_TOKEN"), "INSTALLATION_TOKEN is required"); +environment.put("COPILOT_GITHUB_TOKEN", token); + +try (var client = new CopilotClient(new CopilotClientOptions() + .setEnvironment(environment) + .setUseLoggedInUser(false))) { + // Use the client. +} +``` + +
+ +For in-process FFI, set `COPILOT_GITHUB_TOKEN` in the host environment before loading the runtime; per-client environment options are not supported. For an existing runtime URI, set it on that runtime process. + +## Refresh tokens + +Mint a new installation token before the current token expires. For a child process, restart the SDK client with the new environment. For an in-process or existing runtime, restart the host runtime with the new token. + +## Billing + +Usage is attributed and billed to the account that owns the GitHub App installation. Use an organization installation for organization billing; a user-account installation attributes usage to that user. + +## Troubleshooting + +| Symptom | Check | +|---|---| +| `401 Unauthorized` | Confirm the organization supports GitHub App installation authentication for Copilot. | +| `403 Resource not accessible by integration` or an error mentioning user information | Confirm the installation token is in `COPILOT_GITHUB_TOKEN`, not the SDK's explicit token option. | +| `403 Forbidden` from the Copilot API | Confirm the token request contains `repository_ids` and `copilot_requests: write`. | +| `403 Forbidden` with the required token request | Confirm the app installation has **All repositories** access, then mint a new token. | +| Requested model is unavailable | Confirm the organization's Copilot policy allows the model and the bundled runtime supports it. | +| Wrong account billed | Confirm the installation belongs to the intended organization. | + +## Further reading + +* [Authenticate Copilot SDK](./authenticate.md): other authentication methods and priority +* [Generating an installation access token](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app): GitHub App token creation diff --git a/docs/developer-docs/secrets.md b/docs/developer-docs/secrets.md new file mode 100644 index 000000000..573f4f22e --- /dev/null +++ b/docs/developer-docs/secrets.md @@ -0,0 +1,68 @@ +# Secrets management + +This document covers secrets management for the github/copilot-sdk repository. It lists the GitHub Actions secrets that maintainers must keep configured and not expired. + +> [!WARNING] +> If any of these secrets expire or are revoked, the corresponding workflows will fail silently or with opaque permission errors. Review this list periodically and rotate secrets before they expire. + +## SDK test secrets + +These secrets are used by the per-language SDK test workflows and the canary workflow. + +* **`COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY`**: HMAC key used to authenticate with the Copilot Developer CLI integration endpoint during tests. Injected as `COPILOT_HMAC_KEY` in test environments. + * Workflows: `nodejs-sdk-tests.yml`, `python-sdk-tests.yml`, `go-sdk-tests.yml`, `dotnet-sdk-tests.yml`, `rust-sdk-tests.yml`, `sdk-canary.yml` + +## Agentic workflow secrets + +These secrets power the GitHub Agentic Workflows (gh-aw) used for issue triage, code generation, and release automation. + +* **`COPILOT_GITHUB_TOKEN`**: GitHub OAuth token consumed by the Copilot CLI for AI authentication. Required by all agentic workflows when invoking `copilot` for AI inference. + * Workflows: `issue-triage.lock.yml`, `issue-classification.lock.yml`, `handle-bug.lock.yml`, `handle-enhancement.lock.yml`, `handle-question.lock.yml`, `handle-documentation.lock.yml`, `java-codegen-check.yml`, `java-codegen-fix.lock.yml`, `java-smoke-test.yml`, `java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml`, `release-changelog.lock.yml`, `sdk-consistency-review.lock.yml`, `cross-repo-issue-analysis.lock.yml` + +* **`GH_AW_GITHUB_TOKEN`**: Optional GitHub token override for repository operations (reading code, creating pull requests, and making GitHub API calls). If unset, workflows use the automatic `GITHUB_TOKEN`. + * Workflows: `issue-triage.lock.yml`, `issue-classification.lock.yml`, `handle-bug.lock.yml`, `handle-enhancement.lock.yml`, `handle-question.lock.yml`, `handle-documentation.lock.yml`, `java-codegen-fix.lock.yml`, `java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml`, `release-changelog.lock.yml`, `sdk-consistency-review.lock.yml`, `cross-repo-issue-analysis.lock.yml` + +* **`GH_AW_GITHUB_MCP_SERVER_TOKEN`**: Optional token override for the GitHub MCP server container. If unset, workflows fall back to `GH_AW_GITHUB_TOKEN` and then the automatic `GITHUB_TOKEN`. + * Workflows: `issue-triage.lock.yml`, `issue-classification.lock.yml`, `handle-bug.lock.yml`, `handle-enhancement.lock.yml`, `handle-question.lock.yml`, `handle-documentation.lock.yml`, `java-codegen-fix.lock.yml`, `java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml`, `release-changelog.lock.yml`, `sdk-consistency-review.lock.yml`, `cross-repo-issue-analysis.lock.yml` + +* **`GH_AW_CI_TRIGGER_TOKEN`**: Token used to trigger CI workflows from within agentic workflow runs. + * Workflows: `java-codegen-fix.lock.yml`, `java-adapt-handwritten-code-to-accept-upgrade-changes.lock.yml`, `release-changelog.lock.yml` + +* **`RUNTIME_TRIAGE_TOKEN`**: GitHub token with issue write access to both `github/copilot-sdk` and `github/copilot-agent-runtime`, and read access to `github/copilot-agent-runtime` contents. Used to clone that repository, add labels to the source issue, create linked runtime issues, and make GitHub API calls. + * Workflows: `cross-repo-issue-analysis.lock.yml` + +## Java publishing secrets + +These secrets are used by the Java SDK Maven Central publishing workflow (`java-publish-maven.yml`) and the snapshot publishing workflow (`java-publish-snapshot.yml`). + +* **`JAVA_MAVEN_CENTRAL_USERNAME`**: Username generated by a Maven Central Portal user token. + * Workflows: `java-publish-maven.yml`, `java-publish-snapshot.yml` + +* **`JAVA_MAVEN_CENTRAL_PASSWORD`**: Password or token for Maven Central (Sonatype OSSRH) authentication. + * Workflows: `java-publish-maven.yml`, `java-publish-snapshot.yml` + +* **`JAVA_GPG_SECRET_KEY`**: GPG private key used to sign Java release artifacts for Maven Central. + * Workflows: `java-publish-maven.yml` + +* **`JAVA_GPG_PASSPHRASE`**: Passphrase for the GPG signing key. + * Workflows: `java-publish-maven.yml` + +* **`JAVA_RELEASE_TOKEN`**: GitHub token with **push** permission on the repository. Used by the release workflow for `actions/checkout`, pushing release commits and tags to `main`, and running `mvn release:prepare -DpushChanges=true`. + * Workflows: `java-publish-maven.yml` + +* **`JAVA_RELEASE_GITHUB_TOKEN`**: GitHub token with **workflow dispatch** (actions:write) permission on `github/copilot-sdk-java`. Used to trigger the documentation site deployment after a release is published. + * Workflows: `java-publish-maven.yml` + +## Rust publishing secret + +* **`CARGO_REGISTRY_TOKEN`**: Authentication token for publishing the Rust SDK crate to crates.io. + * Workflows: `publish.yml` + +## Secrets not managed in this repository + +* **`GITHUB_TOKEN`**: Automatically provided by GitHub Actions. No manual management required. + +## Further reading + +* [GitHub docs: Using secrets in GitHub Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) +* [Repository secrets settings](https://github.com/github/copilot-sdk/settings/secrets/actions) (maintainer access required) diff --git a/docs/features/README.md b/docs/features/README.md new file mode 100644 index 000000000..f97140b78 --- /dev/null +++ b/docs/features/README.md @@ -0,0 +1,34 @@ +# Features + +These guides cover the capabilities you can add to your Copilot SDK application. Each guide includes examples in supported languages (TypeScript, Python, Go, .NET, Java, and Rust) where available. + +> **New to the SDK?** Start with the [Getting Started tutorial](../getting-started.md) first, then come back here to add more capabilities. + +## Guides + +| Feature | Description | +|---|---| +| [The Agent Loop](./agent-loop.md) | How the CLI processes a prompt—the tool-use loop, turns, and completion signals | +| [Hooks](./hooks.md) | Intercept and customize session behavior—control tool execution, transform results, handle errors | +| [Custom Agents](./custom-agents.md) | Define specialized sub-agents with scoped tools and instructions | +| [Fleet Mode](./fleet-mode.md) | Dispatch multiple sub-agents in parallel for large, independent workstreams | +| [MCP Servers](./mcp.md) | Integrate Model Context Protocol servers for external tool access | +| [Skills](./skills.md) | Load reusable prompt modules from directories | +| [Plugin Directories](./plugin-directories.md) | Bundle skills, hooks, MCP servers, and agents as a single loadable plugin | +| [Session limits](./session-limits.md) | Set an AI Credits budget for a session and observe budget events | +| [Citations](./citations.md) | Link assistant responses back to their supporting sources | +| [Image Input](./image-input.md) | Send images to sessions as attachments | +| [Streaming Events](./streaming-events.md) | Subscribe to real-time session events (40+ event types) | +| [Usage and Billing](./usage-and-billing.md) | Read token counts, context-window utilization, AI credit cost, and account quota | +| [Steering & Queueing](./steering-and-queueing.md) | Control message delivery—immediate steering vs. sequential queueing | +| [Context Clearing](./context-management.md) | Replace conversation context safely with terminal tools | +| [Session Persistence](./session-persistence.md) | Resume sessions across restarts, manage session storage | +| [Remote Sessions](./remote-sessions.md) | Share locally hosted sessions to GitHub web and mobile via Mission Control | +| [Cloud Sessions](./cloud-sessions.md) | Run sessions on GitHub-hosted compute through Mission Control | + +## Related + +* [Hooks Reference](../hooks/README.md): detailed API reference for each hook type +* [Integrations](../integrations/microsoft-agent-framework.md): use the SDK with other platforms (MAF, etc.) +* [Troubleshooting](../troubleshooting/debugging.md): when things don't work as expected +* [Compatibility](../troubleshooting/compatibility.md): SDK vs CLI feature matrix diff --git a/docs/features/citations.md b/docs/features/citations.md new file mode 100644 index 000000000..b68ae292c --- /dev/null +++ b/docs/features/citations.md @@ -0,0 +1,443 @@ +# Citations + +Citations link spans of an assistant response back to the sources that support them. Turn on `enableCitations` when you create or resume a session, then read the `citations` payload on `assistant.message` events to render footnotes, source lists, or inline links. + +> [!WARNING] +> Citations are experimental. The option name, event payload, and provider coverage can change in a future release. + +## How citations work + +Citations are produced by the model provider, not by the SDK. The flow has three parts: + +1. Your application supplies citable material, such as a document attachment or a tool result that carries source content. +1. The runtime marks that material as citable on the wire when `enableCitations` is on. For Anthropic models, file attachments are sent as `document` blocks with citations enabled. +1. The model returns citation metadata, and the runtime normalizes it into a provider-agnostic `citations` object on the final `assistant.message` event. + +Provider support is limited. The `provider` field on each source records where the citation came from: + +| Provider value | Meaning | +|---|---| +| `anthropic` | Citation produced by an Anthropic (Claude) model response | +| `openai` | Citation produced by an OpenAI model response | +| `client` | Citation synthesized by the runtime from tool output | + +> [!NOTE] +> Turning on `enableCitations` does not guarantee that a response contains citations. Models emit them only when the response is grounded in citable source material. Always treat the `citations` field as optional. + +## Enable citations on a session + +Set the option on session create, and set it again on resume if you want citations after a restart. + +
+TypeScript + + + +```typescript +const session = await client.createSession({ + onPermissionRequest: approveAll, + enableCitations: true, +}); + +const resumed = await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + enableCitations: true, +}); +``` + +
+
+Python + + + +```python +session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + enable_citations=True, +) + +resumed = await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + enable_citations=True, +) +``` + +
+
+Go + + + +```go +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + EnableCitations: copilot.Bool(true), +}) + +resumed, err := client.ResumeSession(ctx, session.SessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + EnableCitations: copilot.Bool(true), +}) +``` + +
+
+.NET + + + +```csharp +var session = await client.CreateSessionAsync(new SessionConfig +{ + OnPermissionRequest = PermissionHandler.ApproveAll, + EnableCitations = true, +}); + +var resumed = await client.ResumeSessionAsync(session.SessionId, new ResumeSessionConfig +{ + OnPermissionRequest = PermissionHandler.ApproveAll, + EnableCitations = true, +}); +``` + +
+
+Java + + + +```java +CopilotSession session = client + .createSession(new SessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setEnableCitations(true)) + .get(); + +CopilotSession resumed = client + .resumeSession(session.getSessionId(), new ResumeSessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setEnableCitations(true)) + .get(); +``` + +
+
+Rust + + + +```rust +let session = client + .create_session( + SessionConfig::new() + .approve_all_permissions() + .with_enable_citations(true), + ) + .await?; + +let resumed = client + .resume_session( + ResumeSessionConfig::new(session.id().clone()) + .approve_all_permissions() + .with_enable_citations(true), + ) + .await?; +``` + +
+ +## Read citations from assistant messages + +Citations arrive on the final `assistant.message` event, not on `assistant.message_delta` events. Wait for the final message before you render source markers. + +
+TypeScript + + + +```typescript +session.on((event) => { + if (event.type !== "assistant.message" || !event.data.citations) { + return; + } + + const { sources, spans } = event.data.citations; + const sourceById = new Map(sources.map((source) => [source.id, source])); + + for (const span of spans) { + const quoted = event.data.content.slice(span.startIndex, span.endIndex); + for (const reference of span.references) { + const source = sourceById.get(reference.sourceId); + const label = source?.title ?? source?.url ?? source?.path ?? source?.id; + console.log(`"${quoted}" — ${label}`); + } + } +}); +``` + +
+
+Python + + + +```python +from copilot.session_events import SessionEventType + +def utf16_slice(text: str, start: int, end: int) -> str: + """Slice by UTF-16 code units, which is how span offsets are measured.""" + units = text.encode("utf-16-le") + return units[start * 2 : end * 2].decode("utf-16-le") + +def handle(event): + if event.type != SessionEventType.ASSISTANT_MESSAGE or not event.data.citations: + return + + sources = {source.id: source for source in event.data.citations.sources} + + for span in event.data.citations.spans: + quoted = utf16_slice(event.data.content, span.start_index, span.end_index) + for reference in span.references: + source = sources[reference.source_id] + label = source.title or source.url or source.path or source.id + print(f'"{quoted}" — {label}') + +session.on(handle) +``` + +
+
+Go + + + +```go +// import "unicode/utf16" + +session.On(func(event copilot.SessionEvent) { + d, ok := event.Data.(*copilot.AssistantMessageData) + if !ok || d.Citations == nil { + return + } + + sources := map[string]copilot.CitationSource{} + for _, source := range d.Citations.Sources { + sources[source.ID] = source + } + + // Span offsets are UTF-16 code units, so index the UTF-16 view of the content. + units := utf16.Encode([]rune(d.Content)) + + for _, span := range d.Citations.Spans { + quoted := string(utf16.Decode(units[span.StartIndex:span.EndIndex])) + for _, reference := range span.References { + source := sources[reference.SourceID] + label := source.ID + switch { + case source.Title != nil: + label = *source.Title + case source.URL != nil: + label = *source.URL + case source.Path != nil: + label = *source.Path + } + fmt.Printf("%q — %s\n", quoted, label) + } + } +}) +``` + +
+
+.NET + + + +```csharp +session.On(evt => +{ + if (evt is not AssistantMessageEvent message || message.Data.Citations is null) + { + return; + } + + var sources = message.Data.Citations.Sources.ToDictionary(source => source.Id); + + foreach (var span in message.Data.Citations.Spans) + { + var quoted = message.Data.Content[(int)span.StartIndex..(int)span.EndIndex]; + foreach (var reference in span.References) + { + var source = sources[reference.SourceId]; + var label = source.Title ?? source.Url ?? source.Path ?? source.Id; + Console.WriteLine($"\"{quoted}\" — {label}"); + } + } +}); +``` + +
+
+Java + + + +```java +session.on(AssistantMessageEvent.class, event -> { + Citations citations = event.getData().citations(); + if (citations == null) { + return; + } + + Map sources = citations.sources().stream() + .collect(Collectors.toMap(CitationSource::id, source -> source)); + + for (CitationSpan span : citations.spans()) { + String quoted = event.getData().content() + .substring(span.startIndex().intValue(), span.endIndex().intValue()); + for (CitationReference reference : span.references()) { + CitationSource source = sources.get(reference.sourceId()); + String label = source.title() != null ? source.title() + : source.url() != null ? source.url() + : source.path() != null ? source.path() + : source.id(); + System.out.printf("\"%s\" — %s%n", quoted, label); + } + } +}); +``` + +
+
+Rust + + + +```rust +use github_copilot_sdk::session_events::AssistantMessageData; +use std::collections::HashMap; + +let mut events = session.subscribe(); + +while let Ok(event) = events.recv().await { + if event.event_type != "assistant.message" { + continue; + } + + let Some(data) = event.typed_data::() else { + continue; + }; + let Some(citations) = data.citations.as_ref() else { + continue; + }; + + let sources: HashMap<&str, _> = citations + .sources + .iter() + .map(|source| (source.id.as_str(), source)) + .collect(); + + // Span offsets are UTF-16 code units, so index the UTF-16 view of the content. + let units: Vec = data.content.encode_utf16().collect(); + + for span in &citations.spans { + let quoted = String::from_utf16_lossy( + &units[span.start_index as usize..span.end_index as usize], + ); + for reference in &span.references { + let Some(source) = sources.get(reference.source_id.as_str()) else { + continue; + }; + let label = source + .title + .as_deref() + .or(source.url.as_deref()) + .or(source.path.as_deref()) + .unwrap_or(source.id.as_str()); + println!("\"{quoted}\" — {label}"); + } + } +} +``` + +
+ +## Citation payload reference + +The `citations` object separates deduplicated sources from the spans that reference them, so a source cited five times appears once in `sources`. + +| Type | Field | Description | +|---|---|---| +| `Citations` | `sources` | Deduplicated set of sources referenced by the citation spans | +| `Citations` | `spans` | Spans of generated text annotated with their supporting sources | +| `CitationSource` | `id` | Stable, turn-scoped identifier referenced by `CitationReference.sourceId` | +| `CitationSource` | `provider` | System that produced the citation: `anthropic`, `openai`, or `client` | +| `CitationSource` | `title?` | Human-readable title of the source | +| `CitationSource` | `url?` | URL of the source, when it is a web resource | +| `CitationSource` | `path?` | File path relative to the agent workspace root, when the source is a file | +| `CitationSpan` | `startIndex` | Start offset in the final message content (UTF-16 code units, zero-based, inclusive) | +| `CitationSpan` | `endIndex` | End offset in the final message content (UTF-16 code units, zero-based, exclusive) | +| `CitationSpan` | `references` | The sources that support this span | +| `CitationReference` | `sourceId` | Identifier of the `CitationSource` this reference points to | +| `CitationReference` | `citedText?` | Exact text from the source that supports the span, when the model provides it | +| `CitationReference` | `location?` | Location within the source that supports the span | +| `CitationReference` | `providerMetadata?` | Provider-native correlation data, passed through opaquely | + +> [!TIP] +> Span offsets are measured in UTF-16 code units against the final `content` string. TypeScript, Java, and .NET strings are already UTF-16, so you can slice them directly. Python strings are indexed by Unicode code point and Go and Rust strings are UTF-8, so convert the content to UTF-16 code units before slicing, as the examples above do. + +### Citation locations + +`CitationReference.location` is a discriminated union keyed on `type`: + +| Location type | Fields | Use | +|---|---|---| +| `char` | `startIndex`, `endIndex` | Character range within the source text | +| `page` | `startPage`, `endPage` | Page range within a paginated document | +| `block` | `startBlock`, `endBlock` | Content-block range within a structured document | + +## Provide citable sources + +Citations need source material the model can attribute. There are two ways to supply it. + +### Attach documents to a message + +When citations are enabled and the session uses an Anthropic provider, file attachments are sent as `document` blocks with citations turned on, so the model can cite passages from them. + + + +```typescript +await session.sendAndWait({ + prompt: "Summarize the attached PDF and cite the passages you used.", + attachments: [ + { + type: "blob", + data: pdfBase64, + displayName: "quarterly-report.pdf", + mimeType: "application/pdf", + }, + ], +}); +``` + +See [Image input](./image-input.md) for the attachment API and the `file` and `blob` attachment shapes. + +### Return citable sources from a tool + +Tool results carry an experimental `citableSources` array. Each entry supplies `content` that the model can cite, along with an `id` and optional `title`, `url`, and `path`. These sources are persisted with the tool result, so they survive session resume, and citations built from them are tagged with the `client` provider. + +## Limitations + +* Citations are experimental in every SDK and are not covered by compatibility guarantees. +* Coverage depends on the model provider. A session configured for a provider without citation support emits no `citations` payload. +* Citations are only present on the final `assistant.message` event, so streaming consumers cannot render them mid-response. +* Public code and IP-duplication citations are not part of this surface. + +## Further reading + +* [Streaming events](./streaming-events.md): subscribe to session events and narrow event types +* [Image input](./image-input.md): attach files and in-memory blobs to a message +* [Session persistence](./session-persistence.md): resume sessions and re-apply session options +* [Compatibility](../troubleshooting/compatibility.md): SDK and CLI feature matrix diff --git a/docs/features/cloud-sessions.md b/docs/features/cloud-sessions.md new file mode 100644 index 000000000..863f9456b --- /dev/null +++ b/docs/features/cloud-sessions.md @@ -0,0 +1,384 @@ +# Cloud sessions + +Cloud sessions run Copilot work on GitHub-hosted compute through Mission Control. Use them when your app should create a session that executes remotely instead of starting a local Copilot CLI session on the user's machine or your server. + +## Prerequisites + +Before creating a cloud session, make sure: + +* The user has Copilot access with cloud-agent entitlement. +* The session can authenticate to GitHub, either with a user token or a logged-in Copilot CLI identity. +* You can associate the session with a GitHub repository. This is optional in the SDK type, but recommended so Mission Control and the cloud agent have repository context. +* Organization policies allow remote control and viewing sessions from cloud surfaces. + +## Creating a cloud session + +Set the create-session `cloud` option to create a cloud session. You can include repository metadata to associate the cloud session with a GitHub repository. + + + +### TypeScript + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +await client.start(); + +const session = await client.createSession({ + onPermissionRequest: async () => ({ kind: "approve-once" }), + cloud: { + repository: { + owner: "github", + name: "copilot-sdk", + branch: "main", + }, + }, +}); +``` + +### Python + +```python +from copilot import ( + CloudSessionOptions, + CloudSessionRepository, + CopilotClient, + PermissionHandler, +) + +client = CopilotClient() +await client.start() + +session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + cloud=CloudSessionOptions( + repository=CloudSessionRepository( + owner="github", + name="copilot-sdk", + branch="main", + ) + ), +) +``` + +### Go + + +```go +package main + +import ( + "context" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + _ = run(context.Background()) +} + +func run(ctx context.Context) error { + client := copilot.NewClient(nil) + if err := client.Start(ctx); err != nil { + return err + } + + session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + Cloud: &copilot.CloudSessionOptions{ + Repository: &copilot.CloudSessionRepository{ + Owner: "github", + Name: "copilot-sdk", + Branch: "main", + }, + }, + OnPermissionRequest: func(_ copilot.PermissionRequest, _ copilot.PermissionInvocation) (rpc.PermissionDecision, error) { + return &rpc.PermissionDecisionApproveOnce{}, nil + }, + }) + _ = session + return err +} +``` + + +```go +client := copilot.NewClient(nil) +if err := client.Start(ctx); err != nil { + return err +} + +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + Cloud: &copilot.CloudSessionOptions{ + Repository: &copilot.CloudSessionRepository{ + Owner: "github", + Name: "copilot-sdk", + Branch: "main", + }, + }, + OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { + return &rpc.PermissionDecisionApproveOnce{}, nil + }, +}) +_ = session +``` + +### .NET + +```csharp +await using var client = new CopilotClient(); + +var session = await client.CreateSessionAsync(new SessionConfig +{ + Cloud = new CloudSessionOptions + { + Repository = new CloudSessionRepository + { + Owner = "github", + Name = "copilot-sdk", + Branch = "main", + }, + }, + OnPermissionRequest = (req, inv) => + Task.FromResult(PermissionDecision.ApproveOnce()), +}); +``` + +### Java + +```java +import com.github.copilot.CopilotClient; +import com.github.copilot.rpc.*; + +try (var client = new CopilotClient()) { + client.start().get(); + + var session = client.createSession( + new SessionConfig() + .setCloud(new CloudSessionOptions() + .setRepository(new CloudSessionRepository() + .setOwner("github") + .setName("copilot-sdk") + .setBranch("main"))) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + ).get(); +} +``` + +### Rust + +```rust +use std::sync::Arc; +use github_copilot_sdk::{CloudSessionOptions, CloudSessionRepository, SessionConfig}; +use github_copilot_sdk::handler::ApproveAllHandler; + +let session = client.create_session( + SessionConfig::default() + .with_cloud(CloudSessionOptions::with_repository( + CloudSessionRepository::new("github", "copilot-sdk").with_branch("main"), + )) + .with_permission_handler(Arc::new(ApproveAllHandler)), +).await?; +``` + + + +## Sending the first prompt + +Cloud sessions initialize in two phases: `createSession` resolves as soon as Mission Control has reserved a task, but the remote `copilot-agent` worker takes another second or two to connect and emit `session.start`. If you call `session.send` before that, the runtime's `RemoteSession.send` throws `"Remote session is still starting"` — but the schema wrapper is fire-and-forget and **silently swallows the error** while still returning a fresh `messageId` to your code. The prompt is dropped on the server and never reaches the worker. + +To send reliably, subscribe to events **before** sending and await the first `session.start` event whose `producer` is `"copilot-agent"`: + + +```typescript +import { CopilotClient, type CopilotSession } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +await client.start(); + +const session: CopilotSession = await client.createSession({ + streaming: true, // required for assistant.message_delta to fire + cloud: { repository: { owner: "github", name: "copilot-sdk" } }, + onPermissionRequest: async () => ({ kind: "approve-once" }), +}); + +// Subscribe BEFORE sending so you don't miss the start event. +const ready = new Promise((resolve) => { + const off = session.on("session.start", (event) => { + if (event.data?.producer === "copilot-agent") { + off(); + resolve(); + } + }); +}); + +await ready; +await session.send({ prompt: "Summarize the README" }); +``` + +A few notes: + +* Set `streaming: true` on `createSession` so the runtime emits `assistant.message_delta` events. Without it, the only assistant signal you get is the final `assistant.message` — fine for batch use, but the chat will look frozen if you're rendering a live UI. See [Streaming Events](./streaming-events.md). +* Only the **first** `session.send` is sensitive to this race. Subsequent sends on the same session work normally because the runtime keeps `hasSessionStarted` set for the life of the session. +* Apply a timeout (e.g. 60 s) around the `ready` promise so a stuck Mission Control provisioning doesn't hang your app forever. +* The same pattern works in every SDK language — subscribe to `session.start`, check `producer === "copilot-agent"`, then call `send`. + +## Accessing the Mission Control URL + +Cloud sessions are inherently remote: once the worker connects, Mission Control publishes the session at `https://github.com/copilot/tasks/{sessionId}` and the runtime emits a `session.info` event with the URL. You do **not** need to call `remote.enable()` — that API is only for promoting a local session to Mission Control. + +Capture the URL by subscribing to `session.info` and filtering by `infoType: "remote"`: + + +```typescript +session.on("session.info", (event) => { + if (event.data?.infoType === "remote" && event.data.url) { + console.log("Open from web or mobile:", event.data.url); + // For example, surface in your UI as a shareable link or QR code. + } +}); +``` + +The event fires shortly after `session.start`. If your renderer mounts after the event has already fired, persist the URL alongside the session record in your app's state and rehydrate on remount — the runtime does not re-emit `session.info` on its own. + +For the same wiring on local sessions promoted via `remote: true`, see [Remote Sessions](./remote-sessions.md). + +## Repository association + +The `cloud.repository` object associates the cloud session with a GitHub repository: + +| Field | Required | Description | +|-------|----------|-------------| +| `owner` | Yes | Repository owner or organization. | +| `name` | Yes | Repository name. | +| `branch` | No | Branch to use for repository context. Omit it to let the runtime choose the default branch or current repository context. | + +Repository association is optional in the SDK type, but include it whenever your app knows the target repository. It helps Mission Control display the session in the right context and gives the cloud agent a clearer starting point. + +Use `branch` when the work should start from a specific branch. If your app is creating sessions from pull requests, issue triage flows, or deployment workflows, pass the branch that matches the user-visible task. + +## Resuming a cloud session + +The `cloud` option only applies when creating a new session. To resume an existing cloud session, use the standard resume API for the SDK language: + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +await client.start(); + +const session = await client.resumeSession("session-id", { + onPermissionRequest: async () => ({ kind: "approve-once" }), +}); +void session; +``` + + +```typescript +const session = await client.resumeSession("session-id", { + onPermissionRequest: async () => ({ kind: "approve-once" }), +}); +``` + +Do not pass `cloud` again on resume. The saved session metadata determines that the session is cloud-backed, and resume follows the normal session resume path. + +## Org policies and entitlements + +Cloud session creation can fail when the user or organization is not entitled to cloud-agent execution or when organization-level policies block the flow. In particular, policies for cloud sandbox can prevent clients from creating the cloud task. + +When this happens, the runtime reports a `"policy_blocked"` failure reason for cloud task creation. Treat this as an authorization or policy outcome, not as a transient infrastructure failure. + +In TypeScript, check for the reason before retrying: + + +```typescript +import { + CopilotClient, + type CloudSessionRepository, +} from "@github/copilot-sdk"; + +const client = new CopilotClient(); +await client.start(); + +const repository: CloudSessionRepository = { + owner: "github", + name: "copilot-sdk", +}; + +try { + await client.createSession({ + cloud: { repository }, + onPermissionRequest: async () => ({ kind: "approve-once" }), + }); +} catch (error) { + if ((error as { reason?: string }).reason === "policy_blocked") { + // Show an admin-facing message or link to org policy settings. + } + throw error; +} +``` + + +```typescript +try { + await client.createSession({ cloud: { repository } }); +} catch (error) { + if ((error as { reason?: string }).reason === "policy_blocked") { + // Show an admin-facing message or link to org policy settings. + } + throw error; +} +``` + +In languages where SDK errors are represented differently, inspect the surfaced error reason or code and handle `"policy_blocked"` explicitly. Retrying without a policy change is not expected to succeed. + +## Integration ID and routing + +Cloud sessions are stamped with a `Copilot-Integration-Id` header derived from the `GITHUB_COPILOT_INTEGRATION_ID` environment variable. This integration ID is used by Mission Control for routing, attribution, and integration-specific behavior. + +For multi-user server guidance and full integration ID details, see [Multi-tenancy](../setup/multi-tenancy.md). + +Mission Control routes SDK-created cloud sessions to the `copilot-developer-sandbox` agent slug. The name is an internal routing slug for the cloud agent and does not mean the session uses the local Windows sandbox. + +## Advanced: `COPILOT_MC_BASE_URL` + +By default, the runtime derives the Mission Control base URL from the configured Copilot API URL. Set `COPILOT_MC_BASE_URL` only when you need to override that Mission Control endpoint. + +This may be required for GitHub Enterprise Server deployments. Confirm the correct value and support status with your GitHub representative before relying on it in production. + +```shell +COPILOT_MC_BASE_URL="https://example.com/agents" +``` + +## Cloud sessions vs. remote sessions + +| Capability | Remote sessions | Cloud sessions | +|------------|-----------------|----------------| +| Execution location | Local machine or your server | GitHub-hosted compute | +| Mission Control role | Shares a local session to GitHub web/mobile | Creates and routes the hosted session | +| SDK option | `remote: true` on the client or session | `cloud: { ... }` on create session | +| Resume path | Standard resume | Standard resume | +| Windows sandbox relation | Unrelated | Unrelated | + +Use remote sessions when the session should execute where the SDK runtime is already running, but also be accessible from Mission Control. Use cloud sessions when the session should execute on GitHub-hosted compute. + +## Troubleshooting + +| Symptom | Likely cause | What to check | +|---------|--------------|---------------| +| Cloud session creation returns `"policy_blocked"` | Organization policy blocks remote control or view from cloud flows | Check org Copilot policies and user entitlement | +| Session creates without repository context | `cloud.repository` was omitted | Pass `owner`, `name`, and optionally `branch` | +| Resume ignores a new `cloud` option | `cloud` only applies to new sessions | Resume the existing session normally | +| Confusion with sandbox settings | Windows sandbox and cloud sessions are separate | Do not use `SANDBOX=true` for cloud execution | +| `session.send` resolves with a `messageId` but no `assistant.*` events fire and Mission Control shows no prompt | The session.send raced ahead of `session.start` from the remote worker; the runtime swallowed the prompt | Await the first `session.start` event with `producer === "copilot-agent"` before sending. See [Sending the first prompt](#sending-the-first-prompt) | +| Live UI never updates even though the cloud worker is processing | `streaming` was not set on `createSession`, so only the final `assistant.message` is emitted | Set `streaming: true` on `createSession` and re-launch | +| Cloud session works but no shareable URL appears in your UI | App never subscribed to `session.info` for the URL | Subscribe to `session.info` and filter `infoType === "remote"`. See [Accessing the Mission Control URL](#accessing-the-mission-control-url) | + +## See also + +* [Remote Sessions](./remote-sessions.md): share locally hosted sessions through Mission Control +* [Streaming Events](./streaming-events.md): subscribe to `assistant.*` deltas for live UI rendering +* [Multi-tenancy](../setup/multi-tenancy.md): integration IDs and server deployment patterns +* [Authentication](../auth/README.md): configure GitHub authentication for SDK sessions diff --git a/docs/features/context-management.md b/docs/features/context-management.md new file mode 100644 index 000000000..6472b046a --- /dev/null +++ b/docs/features/context-management.md @@ -0,0 +1,57 @@ +# Context clearing and terminal tools + +Use `session.history.clearContext` when a host needs to replace the current conversation context without replacing the session. Typical uses include handoffs and host-managed context lifecycle policies. + +Context clearing is different from creating a new session: it preserves the session identity, system and developer messages, configuration, and event log while removing the model-facing conversation. + +> [!IMPORTANT] +> `clearContext` is a tool-handler primitive. The runtime rejects calls made without a tool call in flight, calls with an empty seed prompt, and calls on remote sessions. + +## Define a context-clearing tool + +A successful context-clearing tool should be terminal. Otherwise, the agent loop may make another model call against the newly cleared window before starting the seeded turn. + +```typescript +import { approveAll, CopilotClient, defineTool } from "@github/copilot-sdk"; +import type { CopilotSession } from "@github/copilot-sdk"; +import { z } from "zod"; + +const client = new CopilotClient(); +let session: CopilotSession; + +session = await client.createSession({ + onPermissionRequest: approveAll, + tools: [ + defineTool("clear_context", { + description: "Clear the conversation and start a fresh context window", + parameters: z.object({ prompt: z.string() }), + isTerminal: true, + defer: "never", + handler: async ({ prompt }) => { + const { messagesCleared } = + await session.rpc.history.clearContext({ prompt }); + return `Cleared ${messagesCleared} messages.`; + }, + }), + ], +}); +``` + +The required `prompt` becomes the first user message in the fresh context. A successful clear emits `session.context_cleared` with the number of removed messages and the initial message. + +## Terminal-tool behavior + +`isTerminal` ends the current agent turn only when the tool succeeds. A failure, denial, rejection, timeout, or input-validation error remains visible to the model so it can recover or retry. + +The option follows each language's naming conventions: + +| SDK | Tool option | +|---|---| +| Node.js | `isTerminal` | +| Python | `is_terminal` | +| Go | `IsTerminal` | +| .NET | `CopilotToolOptions.IsTerminal` | +| Java | `ToolDefinition.isTerminal(true)` or `@CopilotTool(isTerminal = true)` | +| Rust | `with_is_terminal(true)` | + +Use terminality only for tools whose successful completion should end the turn. Ordinary tools should leave it unset. diff --git a/docs/features/custom-agents.md b/docs/features/custom-agents.md index d0f209649..9e2f59768 100644 --- a/docs/features/custom-agents.md +++ b/docs/features/custom-agents.md @@ -1,6 +1,6 @@ # Custom agents and sub-agent orchestration -Define specialized agents with scoped tools and prompts, then let Copilot orchestrate them as sub-agents within a single session. +Define specialized agents with scoped tools and prompts, then let Copilot orchestrate them as sub-agents within a single session. For dispatching multiple sub-agents in parallel, see [Fleet Mode](./fleet-mode.md). ## Overview @@ -37,7 +37,7 @@ const client = new CopilotClient(); await client.start(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", customAgents: [ { name: "researcher", @@ -71,7 +71,7 @@ await client.start() session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", custom_agents=[ { "name": "researcher", @@ -112,7 +112,7 @@ func main() { client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", CustomAgents: []copilot.CustomAgentConfig{ { Name: "researcher", @@ -144,7 +144,7 @@ client := copilot.NewClient(nil) client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", CustomAgents: []copilot.CustomAgentConfig{ { Name: "researcher", @@ -179,7 +179,7 @@ using GitHub.Copilot.Rpc; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", CustomAgents = new List { new() @@ -219,7 +219,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setCustomAgents(List.of( new CustomAgentConfig() .setName("researcher") @@ -253,10 +253,14 @@ try (var client = new CopilotClient()) { | `mcpServers` | `object` | | MCP server configurations specific to this agent | | `infer` | `boolean` | | Whether the runtime can auto-select this agent (default: `true`) | | `skills` | `string[]` | | Skill names to preload into the agent's context at startup | +| `model` | `string` | | Model identifier to use while this agent runs | +| `reasoningEffort` | `string` | | Reasoning effort to use while this agent runs. When omitted, the SDK sends no per-agent override and the runtime resolves the effort (see note below) | > [!TIP] > A good `description` helps the runtime match user intent to the right agent. Be specific about the agent's expertise and capabilities. +Set `model` and `reasoningEffort` to override the parent session's model settings while a custom agent runs. When `reasoningEffort` is omitted, the SDK sends no per-agent override and the runtime resolves the effort from its own precedence: a per-call client option, the resolved model's default, or the agent definition all take priority; otherwise the runtime inherits the parent session's effort only when the subagent runs the same model as the parent. When the subagent resolves to a different model, it falls back to that model's default instead of inheriting the parent's effort. Python uses `reasoning_effort`, .NET uses `ReasoningEffort`, Go uses `ReasoningEffort`, Java uses `setReasoningEffort`, and Rust uses `with_reasoning_effort`. + In 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. | Session Config Property | Type | Description | @@ -434,14 +438,16 @@ By default, all custom agents are available for automatic selection (`infer: tru When a sub-agent runs, the parent session emits lifecycle events. Subscribe to these events to build UIs that visualize agent activity. +Sub-agent-originated session events share the parent session stream and include envelope-level `agentId`. Root/main agent events and session-level events omit `agentId`, so renderers can keep the parent response separate from sub-agent traces by checking the event envelope. + ### Event types | Event | Emitted when | Data | |-------|-------------|------| | `subagent.selected` | Runtime selects an agent for the task | `agentName`, `agentDisplayName`, `tools` | -| `subagent.started` | Sub-agent begins execution | `toolCallId`, `agentName`, `agentDisplayName`, `agentDescription` | -| `subagent.completed` | Sub-agent finishes successfully | `toolCallId`, `agentName`, `agentDisplayName` | -| `subagent.failed` | Sub-agent encounters an error | `toolCallId`, `agentName`, `agentDisplayName`, `error` | +| `subagent.started` | Sub-agent begins execution | `toolCallId`, `agentName`, `agentDisplayName`, `agentDescription`, `model?` | +| `subagent.completed` | Sub-agent finishes successfully | `toolCallId`, `agentName`, `agentDisplayName`, `model?`, `durationMs?`, `totalTokens?`, `totalToolCalls?` | +| `subagent.failed` | Sub-agent encounters an error | `toolCallId`, `agentName`, `agentDisplayName`, `error`, `model?`, `durationMs?`, `totalTokens?`, `totalToolCalls?` | | `subagent.deselected` | Runtime switches away from the sub-agent |—| ### Subscribing to events @@ -460,11 +466,15 @@ session.on((event) => { case "subagent.completed": console.log(`✅ Sub-agent completed: ${event.data.agentDisplayName}`); + if (event.data.durationMs !== undefined) console.log(` Duration: ${event.data.durationMs}ms`); + if (event.data.totalTokens !== undefined) console.log(` Tokens: ${event.data.totalTokens}`); + if (event.data.totalToolCalls !== undefined) console.log(` Tool calls: ${event.data.totalToolCalls}`); break; case "subagent.failed": console.log(`❌ Sub-agent failed: ${event.data.agentDisplayName}`); console.log(` Error: ${event.data.error}`); + if (event.data.durationMs !== undefined) console.log(` Duration: ${event.data.durationMs}ms`); break; case "subagent.selected": @@ -529,7 +539,7 @@ func main() { client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, diff --git a/docs/features/fleet-mode.md b/docs/features/fleet-mode.md new file mode 100644 index 000000000..891a8ef04 --- /dev/null +++ b/docs/features/fleet-mode.md @@ -0,0 +1,349 @@ +# Fleet mode + +Fleet mode is Copilot's parallel orchestration pattern for work that can be split across independent sub-agents. In the runtime research notes, fleet mode is described as "the runtime's built-in pattern for dispatching multiple sub-agents in parallel via the `task` tool, with SQL todos as the shared coordination state." Use it when one parent session should coordinate several workers, collect their results, and continue the conversation with the combined context. + +## When to use fleet mode + +Fleet mode is useful when the work can be decomposed before execution and each unit can run without waiting for the others. + +Good fits include: + +* Multi-file refactors where each worker owns a file, package, or language SDK. +* Batch reviews where each worker checks a separate diff, module, or alert group. +* Parallel research across independent repositories, services, or feature areas. +* Documentation refreshes where each worker owns a page or topic. +* Migration tasks where each worker can validate its own slice and report back. + +Avoid fleet mode for: + +* Sequential tasks where step 2 needs the concrete output from step 1. +* Tightly coupled edits where workers would contend for the same files. +* Small tasks that one synchronous sub-agent or the parent agent can finish quickly. +* Tasks that require continuous shared reasoning rather than clear ownership. + +Fleet mode works best when the parent session can create clear units of work, assign one owner per unit, and define what each worker must return. + +## Starting fleet mode + +The SDK exposes fleet mode through the session RPC namespace in several languages. The binding is experimental in the generated RPC surface; pin both the SDK and the Copilot CLI runtime if your application depends on it. + +### From within a session + +The wire method is `session.fleet.start`. The optional `prompt` is combined with the runtime's fleet orchestration instructions. + +
+Node.js / TypeScript + +```typescript +const result = await session.rpc.fleet.start({ + prompt: "Refactor each SDK package independently, then summarize the changes.", +}); + +if (result.started) { + console.log("Fleet mode started"); +} +``` + +
+ +
+Python + +```python +from copilot.rpc import FleetStartRequest + +result = await session.rpc.fleet.start( + FleetStartRequest( + prompt="Review each service independently, then summarize the risks." + ) +) + +if result.started: + print("Fleet mode started") +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + session, err := client.CreateSession(ctx, &copilot.SessionConfig{}) + if err != nil { + return + } + + prompt := "Update each package independently, then report validation results." + result, err := session.RPC.Fleet.Start(ctx, &rpc.FleetStartRequest{ + Prompt: &prompt, + }) + if err != nil { + return + } + if result.Started { + fmt.Println("Fleet mode started") + } +} +``` + + +```go +prompt := "Update each package independently, then report validation results." +result, err := session.RPC.Fleet.Start(ctx, &rpc.FleetStartRequest{ + Prompt: &prompt, +}) +if err != nil { + return err +} +if result.Started { + fmt.Println("Fleet mode started") +} +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(); +await using var session = await client.CreateSessionAsync(new SessionConfig()); + +var result = await session.Rpc.Fleet.StartAsync( + "Audit each project independently, then summarize the findings."); + +if (result.Started) +{ + Console.WriteLine("Fleet mode started"); +} +``` + + +```csharp +var result = await session.Rpc.Fleet.StartAsync( + "Audit each project independently, then summarize the findings."); + +if (result.Started) +{ + Console.WriteLine("Fleet mode started"); +} +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::rpc::FleetStartRequest; + +let result = session + .rpc() + .fleet() + .start(FleetStartRequest { + prompt: Some("Research each crate independently, then summarize the plan.".into()), + }) + .await?; + +if result.started { + println!("Fleet mode started"); +} +``` + +
+ +Native typed bindings for fleet mode were verified in Node.js/TypeScript, Python, Go, .NET, and Rust. A Java binding was not found in `java/src/main/java` on this branch, so Java examples are omitted until that surface is available. + +### From plan mode + +Plan-mode UIs can start fleet deployment by returning the `autopilot_fleet` exit action. The generated session event types describe it as: + +```typescript +type ExitPlanModeAction = + | "exit_only" + | "interactive" + | "autopilot" + /** Exit plan mode and continue with parallel autonomous workers. */ + | "autopilot_fleet"; +``` + +Use this when a user approves a plan that already contains independent work items. Use `autopilot` for a single autonomous worker and `interactive` when the user should stay in the loop. + +## How sub-agents coordinate + +Fleet mode relies on explicit coordination state instead of implicit shared memory. The parent agent decomposes the work into todos, each sub-agent owns one todo, and the orchestrator dispatches workers whose dependencies are already complete. + +The canonical schema is: + +```sql +CREATE TABLE todos ( + id TEXT PRIMARY KEY, + title TEXT NOT NULL, + description TEXT, + status TEXT DEFAULT 'pending' +); + +CREATE TABLE todo_deps ( + todo_id TEXT, + depends_on TEXT, + PRIMARY KEY (todo_id, depends_on) +); +``` + +Each todo moves through a small state machine: + +```text +pending -> in_progress -> done + \-> blocked +``` + +A sub-agent should: + +1. Claim exactly one ready todo by setting `status = 'in_progress'`. +1. Work only on that todo's scope. +1. Store its result in the conversation or relevant task output. +1. Set `status = 'done'` when complete. +1. Set `status = 'blocked'` when it cannot proceed, and include the reason. + +The orchestrator can find work whose dependencies are satisfied with a query like: + +```sql +SELECT t.* +FROM todos t +WHERE t.status = 'pending' + AND NOT EXISTS ( + SELECT 1 + FROM todo_deps td + JOIN todos dep ON td.depends_on = dep.id + WHERE td.todo_id = t.id + AND dep.status != 'done' + ); +``` + +This pattern gives every worker a clear owner and lets the parent session reason about what is ready, running, complete, or blocked. + +## Lifecycle hooks + +Fleet mode invokes sub-agents through the runtime's task mechanism. The runtime emits hook activity for sub-agent tool calls: the runtime 1.0.52 changelog notes that `preToolUse`, `postToolUse`, `subagentStart`, and `subagentStop` fire correctly for sub-agent tool calls. + +A dedicated SDK hook callback for `subagentStart` or `subagentStop` was not found in the public SDK surface on this branch. SDK consumers can observe sub-agent activity through the generic session event stream, which includes events such as `subagent.started`, `subagent.completed`, `subagent.failed`, `subagent.selected`, and `subagent.deselected`. + +
+Node.js / TypeScript + +```typescript +session.on((event) => { + if (event.type === "subagent.started") { + console.log(`Started ${event.data.agentDisplayName}`); + } + + if (event.type === "subagent.completed") { + console.log(`Completed ${event.data.agentDisplayName}`); + } +}); +``` + +
+ +
+Python + + +```python +import asyncio +from copilot import CopilotClient +from copilot.session import PermissionHandler + +async def main(): + client = CopilotClient() + await client.start() + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + + def handle_event(event): + if event.type == "subagent.started": + print(f"Started {event.data.agent_display_name}") + elif event.type == "subagent.completed": + print(f"Completed {event.data.agent_display_name}") + + unsubscribe = session.on(handle_event) + +asyncio.run(main()) +``` + + +```python +def handle_event(event): + if event.type == "subagent.started": + print(f"Started {event.data.agent_display_name}") + elif event.type == "subagent.completed": + print(f"Completed {event.data.agent_display_name}") + +unsubscribe = session.on(handle_event) +``` + +
+ +For hook configuration that is already exposed at the SDK layer, see [Hooks](hooks.md). For sub-agent event payloads, see [Custom agents and sub-agent orchestration](custom-agents.md). + +## Plugin sub-agents + +The runtime can load plugins with `--plugin-dir`. Plugins loaded this way can register their agents as available `task(agent_type=...)` sub-agent types in prompt mode, which means fleet mode can dispatch to those plugin-provided worker types. + +This is currently a runtime-level configuration pattern rather than a documented SDK-level registration API. Configure the Copilot CLI runtime with the plugin directory, then connect the SDK client to that runtime. Native SDK helpers for registering plugin sub-agent types may be added in the future. + +Conceptually, a fleet prompt can then ask for a specific worker type: + +```text +Use task(agent_type="security-review") for each independent package. +Run the workers in parallel and summarize only high-confidence findings. +``` + +Keep plugin-provided sub-agent types narrow and descriptive so the orchestrator can choose them reliably. + +## Best practices + +* Decompose the work into independent units before starting fleet mode. +* Minimize dependencies between todos; dependencies reduce parallelism. +* Give each todo a durable ID, a clear title, and a complete description. +* Make each sub-agent own exactly one todo at a time. +* Use background sub-agents for truly parallel work. +* Use synchronous sub-agent calls for serialized steps or validation gates. +* Provide each sub-agent with complete context; sub-agents are stateless across calls. +* Include file paths, commands, expected outputs, and constraints in each worker prompt. +* Do not dispatch a single background sub-agent; prefer a synchronous call or batch multiple workers in parallel. +* Avoid assigning overlapping files to different workers unless the parent agent will reconcile conflicts explicitly. +* Require every worker to report what it changed, how it validated the change, and what remains blocked. +* Have the parent agent verify the combined result after workers finish. + +## Limitations and open questions + +* Fleet mode is exposed through generated session RPC bindings and is marked experimental in several SDKs. +* The SQL todos pattern is the canonical coordination model in the runtime guidance, but whether it is a stable extensibility contract for SDK consumers is still an open question. +* `subagentStart` and `subagentStop` are runtime hook names; this branch exposes sub-agent lifecycle to SDK consumers through the generic session event stream, not dedicated hook callbacks. +* Plugin sub-agent registration is configured at the runtime layer through `--plugin-dir`; no SDK-level plugin registration helper was verified on this branch. +* Java native typed bindings for `session.fleet.start` were not found in the Java SDK source on this branch. +* Fleet mode does not remove the need for parent-agent review. Parallel workers can produce inconsistent assumptions that the orchestrator must reconcile. + +## See also + +* [Custom agents and sub-agent orchestration](custom-agents.md) +* [Hooks](hooks.md) diff --git a/docs/features/hooks.md b/docs/features/hooks.md index 6af5232a6..6a7833990 100644 --- a/docs/features/hooks.md +++ b/docs/features/hooks.md @@ -9,20 +9,22 @@ A hook is a callback you register once when creating a session. The SDK invokes ```mermaid flowchart LR A[Session starts] -->|onSessionStart| B[User sends prompt] - B -->|onUserPromptSubmitted| C[Agent picks a tool] - C -->|onPreToolUse| D[Tool executes] - D -->|onPostToolUse| E{More work?} - E -->|yes| C - E -->|no| F[Session ends] - F -->|onSessionEnd| G((Done)) - C -.->|error| H[onErrorOccurred] - D -.->|error| H + B -->|onUserPromptSubmitted| C[Runtime transforms prompt] + C -->|onUserPromptTransformed| D[Agent picks a tool] + D -->|onPreToolUse| E[Tool executes] + E -->|onPostToolUse| F{More work?} + F -->|yes| D + F -->|no| G[Session ends] + G -->|onSessionEnd| H((Done)) + D -.->|error| I[onErrorOccurred] + E -.->|error| I ``` | Hook | When it fires | What you can do | | ------------------------------------------------------------------- | ----------------------------------- | ------------------------------------------ | | [`onSessionStart`](../hooks/session-lifecycle.md#session-start) | Session begins (new or resumed) | Inject context, load preferences | | [`onUserPromptSubmitted`](../hooks/user-prompt-submitted.md) | User sends a message | Rewrite prompts, add context, filter input | +| [`onUserPromptTransformed`](../hooks/user-prompt-transformed.md) | Runtime builds the model prompt | Inspect or replace model-facing content | | [`onPreToolUse`](../hooks/pre-tool-use.md) | Before a tool executes | Allow / deny / modify the call | | [`onPostToolUse`](../hooks/post-tool-use.md) | After a tool returns (success only) | Transform results, redact secrets, audit | | [`onPostToolUseFailure`](../hooks/post-tool-use.md#failure-variant) | After a tool returns a failure | Inject retry guidance, log failures | @@ -1051,16 +1053,17 @@ const session = await client.createSession({ For full type definitions, input/output field tables, and additional examples for every hook, see the API reference: -- [Hooks Overview](../hooks/hooks-overview.md) -- [Pre-Tool Use](../hooks/pre-tool-use.md) -- [Post-Tool Use](../hooks/post-tool-use.md) -- [User Prompt Submitted](../hooks/user-prompt-submitted.md) -- [Session Lifecycle](../hooks/session-lifecycle.md) -- [Error Handling](../hooks/error-handling.md) +* [Hooks Overview](../hooks/hooks-overview.md) +* [Pre-Tool Use](../hooks/pre-tool-use.md) +* [Post-Tool Use](../hooks/post-tool-use.md) +* [User Prompt Submitted](../hooks/user-prompt-submitted.md) +* [User Prompt Transformed](../hooks/user-prompt-transformed.md) +* [Session Lifecycle](../hooks/session-lifecycle.md) +* [Error Handling](../hooks/error-handling.md) ## See also -- [Getting Started](../getting-started.md) -- [Custom Agents & Sub-Agent Orchestration](./custom-agents.md) -- [Streaming Session Events](./streaming-events.md) -- [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file +* [Getting Started](../getting-started.md) +* [Custom Agents & Sub-Agent Orchestration](./custom-agents.md) +* [Streaming Session Events](./streaming-events.md) +* [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file diff --git a/docs/features/image-input.md b/docs/features/image-input.md index b850a4c1b..321e5d2fc 100644 --- a/docs/features/image-input.md +++ b/docs/features/image-input.md @@ -47,7 +47,7 @@ const client = new CopilotClient(); await client.start(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -75,7 +75,7 @@ await client.start() session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", ) await session.send( @@ -110,7 +110,7 @@ func main() { client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, @@ -120,7 +120,7 @@ func main() { session.Send(ctx, copilot.MessageOptions{ Prompt: "Describe what you see in this image", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentFile{ + &copilot.AttachmentFile{ DisplayName: "screenshot.png", Path: path, }, @@ -136,7 +136,7 @@ client := copilot.NewClient(nil) client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, @@ -146,7 +146,7 @@ path := "/absolute/path/to/screenshot.png" session.Send(ctx, copilot.MessageOptions{ Prompt: "Describe what you see in this image", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentFile{ + &copilot.AttachmentFile{ DisplayName: "screenshot.png", Path: path, }, @@ -171,7 +171,7 @@ public static class ImageInputExample await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", OnPermissionRequest = (req, inv) => Task.FromResult(PermissionDecision.ApproveOnce()), }); @@ -179,9 +179,9 @@ public static class ImageInputExample await session.SendAsync(new MessageOptions { Prompt = "Describe what you see in this image", - Attachments = new List + Attachments = new List { - new UserMessageAttachmentFile + new AttachmentFile { Path = "/absolute/path/to/screenshot.png", DisplayName = "screenshot.png", @@ -200,7 +200,7 @@ using GitHub.Copilot.Rpc; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", OnPermissionRequest = (req, inv) => Task.FromResult(PermissionDecision.ApproveOnce()), }); @@ -208,9 +208,9 @@ await using var session = await client.CreateSessionAsync(new SessionConfig await session.SendAsync(new MessageOptions { Prompt = "Describe what you see in this image", - Attachments = new List + Attachments = new List { - new UserMessageAttachmentFile + new AttachmentFile { Path = "/absolute/path/to/screenshot.png", DisplayName = "screenshot.png", @@ -234,7 +234,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -263,7 +263,7 @@ const client = new CopilotClient(); await client.start(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -294,7 +294,7 @@ await client.start() session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", ) base64_image_data = "..." # your base64-encoded image @@ -332,7 +332,7 @@ func main() { client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, @@ -344,8 +344,8 @@ func main() { session.Send(ctx, copilot.MessageOptions{ Prompt: "Describe what you see in this image", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentBlob{ - Data: base64ImageData, + &copilot.AttachmentBlob{ + Data: &base64ImageData, MIMEType: mimeType, DisplayName: &displayName, }, @@ -361,8 +361,8 @@ displayName := "screenshot.png" session.Send(ctx, copilot.MessageOptions{ Prompt: "Describe what you see in this image", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentBlob{ - Data: base64ImageData, // base64-encoded string + &copilot.AttachmentBlob{ + Data: &base64ImageData, // base64-encoded string MIMEType: mimeType, DisplayName: &displayName, }, @@ -387,7 +387,7 @@ public static class BlobAttachmentExample await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", OnPermissionRequest = (req, inv) => Task.FromResult(PermissionDecision.ApproveOnce()), }); @@ -396,9 +396,9 @@ public static class BlobAttachmentExample await session.SendAsync(new MessageOptions { Prompt = "Describe what you see in this image", - Attachments = new List + Attachments = new List { - new UserMessageAttachmentBlob + new AttachmentBlob { Data = base64ImageData, MimeType = "image/png", @@ -415,9 +415,9 @@ public static class BlobAttachmentExample await session.SendAsync(new MessageOptions { Prompt = "Describe what you see in this image", - Attachments = new List + Attachments = new List { - new UserMessageAttachmentBlob + new AttachmentBlob { Data = base64ImageData, MimeType = "image/png", @@ -442,7 +442,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); diff --git a/docs/features/index.md b/docs/features/index.md deleted file mode 100644 index 2fa11b76e..000000000 --- a/docs/features/index.md +++ /dev/null @@ -1,27 +0,0 @@ -# Features - -These guides cover the capabilities you can add to your Copilot SDK application. Each guide includes examples in supported languages (TypeScript, Python, Go, .NET, Java, and Rust) where available. - -> **New to the SDK?** Start with the [Getting Started tutorial](../getting-started.md) first, then come back here to add more capabilities. - -## Guides - -| Feature | Description | -|---|---| -| [The Agent Loop](./agent-loop.md) | How the CLI processes a prompt—the tool-use loop, turns, and completion signals | -| [Hooks](./hooks.md) | Intercept and customize session behavior—control tool execution, transform results, handle errors | -| [Custom Agents](./custom-agents.md) | Define specialized sub-agents with scoped tools and instructions | -| [MCP Servers](./mcp.md) | Integrate Model Context Protocol servers for external tool access | -| [Skills](./skills.md) | Load reusable prompt modules from directories | -| [Image Input](./image-input.md) | Send images to sessions as attachments | -| [Streaming Events](./streaming-events.md) | Subscribe to real-time session events (40+ event types) | -| [Steering & Queueing](./steering-and-queueing.md) | Control message delivery—immediate steering vs. sequential queueing | -| [Session Persistence](./session-persistence.md) | Resume sessions across restarts, manage session storage | -| [Remote Sessions](./remote-sessions.md) | Share sessions to GitHub web and mobile via Mission Control | - -## Related - -* [Hooks Reference](../hooks/index.md): detailed API reference for each hook type -* [Integrations](../integrations/microsoft-agent-framework.md): use the SDK with other platforms (MAF, etc.) -* [Troubleshooting](../troubleshooting/debugging.md): when things don't work as expected -* [Compatibility](../troubleshooting/compatibility.md): SDK vs CLI feature matrix diff --git a/docs/features/mcp.md b/docs/features/mcp.md index e974532b0..caac63327 100644 --- a/docs/features/mcp.md +++ b/docs/features/mcp.md @@ -120,7 +120,7 @@ func main() { "my-local-server": copilot.MCPStdioServerConfig{ Command: "node", Args: []string{"./mcp-server.js"}, - Tools: &[]string{"*"}, + Tools: []string{"*"}, }, }, }) @@ -154,6 +154,35 @@ await using var session = await client.CreateSessionAsync(new SessionConfig }); ``` +## Disabling configured servers per session + +Set `disabledMcpServers` to exact MCP server names that must not run in a session. +The setting is scoped to the individual create or resume request; it does not +modify global MCP settings or the server configuration. + +```typescript +const session = await client.createSession({ + mcpServers: { + filesystem: { type: "local", command: "npx", args: ["-y", "@modelcontextprotocol/server-filesystem", "."] }, + github: { type: "http", url: "https://api.githubcopilot.com/mcp/" }, + }, + disabledMcpServers: ["github"], +}); +``` + +| SDK | Configuration property | +| --- | --- | +| Node.js | `disabledMcpServers` | +| Python | `disabled_mcp_servers` | +| Go | `DisabledMCPServers` | +| .NET | `DisabledMcpServers` | +| Java | `setDisabledMcpServers(...)` | +| Rust | `with_disabled_mcp_servers(...)` | + +On session creation and a **cold** resume, disabled servers are not started and +the runtime does not initiate their authentication. A resident resume cannot +undo a server that the runtime has already spawned. Names are matched exactly. + ## Tool configuration You can control which tools are available to an MCP server using the `tools` field. diff --git a/docs/features/plugin-directories.md b/docs/features/plugin-directories.md new file mode 100644 index 000000000..4af11d9a7 --- /dev/null +++ b/docs/features/plugin-directories.md @@ -0,0 +1,393 @@ +# Plugin directories + +A **plugin** is a directory that bundles SDK extensions — skills, hooks, MCP servers, custom agents, and LSP configuration — behind a single manifest. Pointing the SDK at a plugin directory loads everything the plugin contributes, so you can ship reusable capability packs without writing per-extension wiring in every host application. + +This guide explains the plugin folder layout, how to load a plugin from a directory, when to use plugin directories vs. registering individual extensions, and how to make plugin sets deterministic. + +## When to use plugin directories + +Use a plugin directory when you want to: + +* **Distribute a bundle of capabilities** as one unit — e.g., a "TypeScript reviewer" pack with a skill, a `preToolUse` hook that enforces lint, and a custom agent that runs the reviewer. +* **Vendor capability packs into a repository** so every clone of the host application loads the same extensions deterministically. +* **Develop a plugin locally** before publishing it to a marketplace. +* **Override or extend** a marketplace-installed plugin with a local checkout for testing. + +If you only need to add a single MCP server, a single hook, or a single custom agent, you can register it inline via the SDK config (`mcpServers`, `hooks`, `customAgents`). Plugin directories are most useful once you have three or more related extensions that ship together. + +## Plugin folder layout + +The Copilot CLI scans each plugin directory for a `plugin.json` manifest or a root-level `SKILL.md`. A minimal plugin looks like this: + +``` +my-plugin/ +├── plugin.json # manifest (required unless using SKILL.md only) +├── SKILL.md # optional: top-level skill +├── hooks.json # optional: hooks config +├── .mcp.json # optional: MCP server config +├── agents/ # optional: custom agents (one .md file per agent) +│ └── code-reviewer.md +└── skills/ # optional: additional skills + └── lint-fix/ + └── SKILL.md +``` + +The manifest may also live at `.github/plugin.json` or `.github/plugin/plugin.json` so plugins can sit inside an existing repository without changing its root layout. Each subsystem (hooks, MCP, LSP, skills, agents) has its own loader and is optional — a plugin only needs the parts it contributes. + +For the full manifest schema, see the runtime documentation referenced from your CLI's `/plugin` slash command. + +## Loading a plugin directory from the SDK + +Plugin directories are loaded by passing `--plugin-dir ` to the Copilot CLI when the SDK spawns it. Each language exposes this through the runtime connection's extra-args option. The flag can be repeated to load multiple plugins. + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; + +async function main() { + const client = new CopilotClient({ + connection: RuntimeConnection.forStdio({ + args: [ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + ], + }), + }); + + await client.start(); +} + +main(); +``` + + +```typescript +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; + +const client = new CopilotClient({ + connection: RuntimeConnection.forStdio({ + args: [ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + ], + }), +}); + +await client.start(); +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient, StdioRuntimeConnection + +client = CopilotClient( + connection=StdioRuntimeConnection( + args=( + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + ), + ), +) +await client.start() +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + + copilot "github.com/github/copilot-sdk/go" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.StdioConnection{ + Args: []string{ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + }, + }, + }) + if err := client.Start(ctx); err != nil { + return + } +} +``` + + +```go +client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.StdioConnection{ + Args: []string{ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + }, + }, +}) +if err := client.Start(ctx); err != nil { + return err +} +``` + +
+ +
+.NET + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(new CopilotClientOptions +{ + Connection = RuntimeConnection.ForStdio(args: new[] + { + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + }), +}); + +await client.StartAsync(); +``` + +
+ +
+Java + + +```java +import com.github.copilot.CopilotClient; +import com.github.copilot.rpc.CopilotClientOptions; + +public class PluginDirectoriesExample { + public static void main(String[] args) throws Exception { + var options = new CopilotClientOptions() + .setCliArgs(new String[] { + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + }); + + var client = new CopilotClient(options); + client.start().get(); + } +} +``` + + +```java +var options = new CopilotClientOptions() + .setCliArgs(new String[] { + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + }); + +var client = new CopilotClient(options); +client.start().get(); +``` + +
+ +
+Rust + + +```rust +use github_copilot_sdk::{Client, ClientOptions}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let _client = Client::start( + ClientOptions::new().with_extra_args([ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + ]), + ) + .await?; + Ok(()) +} +``` + + +```rust +use github_copilot_sdk::{Client, ClientOptions}; + +let client = Client::start( + ClientOptions::new().with_extra_args([ + "--plugin-dir", "./plugins/code-reviewer", + "--plugin-dir", "./plugins/lint-fix", + ]), +) +.await?; +``` + +
+ +> The example above uses an stdio runtime connection — the default when the SDK bundles the CLI. If you connect to an external runtime via a URL (`forUri` / `ForUri`), pass `--plugin-dir` to the long-running CLI server when you start it; the SDK does not forward `--plugin-dir` to runtimes it didn't spawn. + +## Trusted host-bundled plugin directories + +Applications that ship their own trusted plugins can register them as a client startup option. The SDK sends the complete ordered set after connecting and verifying the protocol, before `start` returns or any session can be created. Paths must be absolute; leaving the option unset or empty makes no RPC call. + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +async function main() { + const client = new CopilotClient({ + builtinPluginDirectories: [ + "/opt/my-app/copilot-plugins/core", + "/opt/my-app/copilot-plugins/github", + ], + }); + await client.start(); +} + +main(); +``` + + +The equivalent option in each SDK is: + +| SDK | Startup option | +|---|---| +| Node.js / TypeScript | `builtinPluginDirectories: string[]` | +| Python | `builtin_plugin_directories=[...]` | +| Go | `BuiltinPluginDirectories: []string{...}` | +| .NET | `BuiltinPluginDirectories = [...]` | +| Java | `.setBuiltinPluginDirectories(List.of(Path.of(...)))` | +| Rust | `.with_builtin_plugin_directories([...])` | + +This is a trust boundary for plugins bundled and controlled by the host application. It is distinct from `--plugin-dir`, which is a CLI process launch argument for explicitly loading ordinary plugin directories. The startup option also works when connecting to an existing runtime because it is sent over JSON-RPC rather than forwarded as a process argument. + +## What a plugin can contribute + +Loading a plugin directory makes its extensions visible to every session created by the client. The runtime merges plugin-provided extensions with anything you register inline: + +| Plugin contributes | Visible to session as | +|---|---| +| Skills (`SKILL.md`, `skills/*/SKILL.md`) | Items in `session.skills.list()`; injectable by name | +| Custom agents (`agents/*.md`) | Dispatchable via the `task(agent_type=...)` tool | +| Hooks (`hooks.json`) | Fired alongside hooks registered via the SDK | +| MCP servers (`.mcp.json`) | Tools and resources reachable through `session.mcp.*` | +| LSP servers (`.lsp.json`) | Initialized via `session.lsp.initialize(...)` | + +Plugin agents are first-class sub-agents in [fleet mode](./fleet-mode.md): a parent agent can dispatch them by `agent_type`, and the runtime fires the `subagentStart` / `subagentStop` hooks for them like any other sub-agent. + +## Plugin-dir vs marketplace plugins + +The runtime has two ways to install plugins, and both end up looking the same to a session: + +* **Marketplace / direct-repo plugins** are installed persistently through the CLI's `/plugin` slash command or the underlying `installedPlugins` user setting. They are *ambient* — every session that runs against the same user config sees them, and they participate in plugin discovery rules. +* **`--plugin-dir` plugins** are *explicit and ephemeral* — they only apply to the CLI process you launched with that flag. They take precedence over ambient discovery and are de-duplicated against marketplace entries with the same cache path, so the same plugin won't load twice when both surfaces reference it. + +For SDK-driven applications, `--plugin-dir` is usually the right choice: it keeps the plugin set under your application's control instead of depending on per-machine user state. + +## Making plugin sets deterministic + +When the host machine may have other plugins installed (marketplace or personal), set `COPILOT_PLUGIN_DIR_ONLY=true` in the runtime's environment to suppress automatic plugin discovery. Only the directories you pass via `--plugin-dir` will load. + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; + +async function main() { + process.env.COPILOT_PLUGIN_DIR_ONLY = "true"; + const client = new CopilotClient({ + connection: RuntimeConnection.forStdio({ + args: ["--plugin-dir", "./plugins/code-reviewer"], + }), + }); + await client.start(); +} + +main(); +``` + + +```typescript +process.env.COPILOT_PLUGIN_DIR_ONLY = "true"; + +const client = new CopilotClient({ + connection: RuntimeConnection.forStdio({ + args: ["--plugin-dir", "./plugins/code-reviewer"], + }), +}); +await client.start(); +``` + +
+ +Use this in CI, in headless server deployments, and anywhere you want a reproducible plugin set that doesn't depend on the host's user configuration. + +## Inspecting which plugins loaded + +Once a session is created, list the active plugins to confirm a directory was picked up correctly: + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +async function main() { + const client = new CopilotClient(); + await client.start(); + const session = await client.createSession({ + onPermissionRequest: async () => ({ kind: "approve-once" }), + }); + + const plugins = await session.rpc.plugins.list(); + for (const plugin of plugins.plugins) { + console.log(`${plugin.name} (${plugin.enabled ? "enabled" : "disabled"})`); + } +} + +main(); +``` + + +```typescript +const plugins = await session.rpc.plugins.list(); +for (const plugin of plugins.plugins) { + console.log(`${plugin.name} (${plugin.enabled ? "enabled" : "disabled"})`); +} +``` + +
+ +Plugins loaded via `--plugin-dir` appear in this list with their cache path set to the directory you provided. Marketplace installs are tagged with their registry source. + +## Troubleshooting + +* **"no plugin.json or SKILL.md found in <dir>"** — the directory exists but doesn't qualify as a plugin. Add a `plugin.json` manifest at the root (or under `.github/`), or include a top-level `SKILL.md`. +* **Plugin loaded but agents/skills not visible** — make sure the plugin manifest declares the agents/skills it contributes, or use the implicit layout (`agents/*.md`, `skills/*/SKILL.md`). Then call `session.rpc.skills.reload()` to pick up changes without restarting. +* **Duplicate hooks firing** — the runtime de-duplicates by `cache_path`, but only when the same directory is referenced both as a marketplace install and a `--plugin-dir`. If two different directories contain the same plugin, both will load. Remove one or use `COPILOT_PLUGIN_DIR_ONLY=true`. +* **`--plugin-dir` ignored when connecting to an external runtime** — the SDK only forwards extra args when it spawns the CLI itself. For external runtimes (`forUri`/`ForUri`), pass `--plugin-dir` on the command line that starts the runtime server. + +## Related + +* [Custom Agents](./custom-agents.md): write agents that ship inside a plugin's `agents/` folder. +* [Skills](./skills.md): how `SKILL.md` files are loaded, and the skill-tier ordering rules. +* [Hooks](./hooks.md): hooks defined by a plugin fire alongside SDK-registered hooks. +* [MCP Servers](./mcp.md): plugin-provided MCP servers integrate the same way as inline registrations. +* [Fleet Mode](./fleet-mode.md): plugin-provided agents are dispatchable as sub-agents. diff --git a/docs/features/remote-sessions.md b/docs/features/remote-sessions.md index f58238eee..f103b9cf6 100644 --- a/docs/features/remote-sessions.md +++ b/docs/features/remote-sessions.md @@ -2,6 +2,8 @@ Remote sessions let users access their Copilot session from GitHub web and mobile via [Mission Control](https://github.com). When enabled, the SDK connects each session to Mission Control, producing a URL that can be shared as a link or QR code. +For running sessions on GitHub-hosted compute, see [Cloud Sessions](./cloud-sessions.md). + ## Prerequisites * The user must be authenticated (GitHub token or logged-in user) @@ -11,7 +13,7 @@ Remote sessions let users access their Copilot session from GitHub web and mobil ### Always-on (client-level) -Set `remote: true` when creating the client. Every session in a GitHub repo automatically gets a remote URL. +Set `enableRemoteSessions: true` when creating the client. Every session in a GitHub repo automatically gets a remote URL. @@ -21,7 +23,7 @@ Set `remote: true` when creating the client. Every session in a GitHub repo auto ```typescript import { CopilotClient } from "@github/copilot-sdk"; -const client = new CopilotClient({ remote: true }); +const client = new CopilotClient({ enableRemoteSessions: true }); const session = await client.createSession({ workingDirectory: "/path/to/github-repo", onPermissionRequest: async () => ({ allowed: true }), @@ -57,7 +59,7 @@ session.on(on_event) ```go -client, _ := copilot.NewClient(&copilot.ClientOptions{Remote: true}) +client := copilot.NewClient(&copilot.ClientOptions{EnableRemoteSessions: true}) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ WorkingDirectory: "/path/to/github-repo", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { @@ -76,7 +78,7 @@ session.On(func(event copilot.SessionEvent) { ```csharp -var client = new CopilotClient(new CopilotClientOptions { Remote = true }); +var client = new CopilotClient(new CopilotClientOptions { EnableRemoteSessions = true }); var session = await client.CreateSessionAsync(new SessionConfig { WorkingDirectory = "/path/to/github-repo", @@ -120,92 +122,6 @@ while let Ok(event) = events.recv().await { -### Cloud sessions - -Set the create-session `cloud` option to create a remote session in the cloud instead of a local session. You can include repository metadata to associate the cloud session with a GitHub repository. - - - -#### TypeScript - - -```typescript -const session = await client.createSession({ - onPermissionRequest: async () => ({ allowed: true }), - cloud: { - repository: { owner: "github", name: "copilot-sdk", branch: "main" }, - }, -}); -``` - -#### Python - - -```python -from copilot import CloudSessionOptions, CloudSessionRepository - -session = await client.create_session( - on_permission_request=PermissionHandler.approve_all, - cloud=CloudSessionOptions( - repository=CloudSessionRepository( - owner="github", - name="copilot-sdk", - branch="main", - ) - ), -) -``` - -#### Go - - -```go -session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Cloud: &copilot.CloudSessionOptions{ - Repository: &copilot.CloudSessionRepository{ - Owner: "github", - Name: "copilot-sdk", - Branch: "main", - }, - }, -}) -``` - -#### C# - - -```csharp -var session = await client.CreateSessionAsync(new SessionConfig -{ - Cloud = new CloudSessionOptions - { - Repository = new CloudSessionRepository - { - Owner = "github", - Name = "copilot-sdk", - Branch = "main" - } - } -}); -``` - -#### Rust - - -```rust -use github_copilot_sdk::{CloudSessionOptions, CloudSessionRepository, SessionConfig}; - -let session = client.create_session( - SessionConfig::default().with_cloud( - CloudSessionOptions::with_repository( - CloudSessionRepository::new("github", "copilot-sdk").with_branch("main"), - ), - ), -).await?; -``` - - - ### On-demand (per-session toggle) Use `session.rpc.remote.enable()` to start remote access mid-session, and `session.rpc.remote.disable()` to stop it. This is equivalent to the CLI's `/remote on` and `/remote off` commands. @@ -285,7 +201,6 @@ The remote URL can be rendered as a QR code for easy mobile access. The SDK prov ## Notes -* The `remote` client option only applies when the SDK spawns the CLI process. It is ignored when connecting to an external server via `cliUrl`. -* The `cloud` session option applies only to new sessions created with `session.create`; it is not used when resuming an existing session. +* The `enableRemoteSessions` client option applies when the SDK starts the runtime, either as a child process or as an in-process host. It is ignored when connecting to an already-running runtime. * If the working directory is not a GitHub repository, remote setup is silently skipped (always-on mode) or returns an error (on-demand mode). * Remote sessions require authentication. Ensure `gitHubToken` or `useLoggedInUser` is configured. diff --git a/docs/features/session-limits.md b/docs/features/session-limits.md new file mode 100644 index 000000000..e5cf624cd --- /dev/null +++ b/docs/features/session-limits.md @@ -0,0 +1,174 @@ +# Session limits + +Session limits let an application set an AI Credits budget for a Copilot session. Use `sessionLimits` when creating or resuming a session to set a soft cap for the current accounting window. + +## Configure a session limit + +Set `maxAiCredits` to the AI Credits soft cap for the session's current accounting window. Usage is checked after model calls return, so one response can exceed the configured value before the runtime blocks the next model call. The SDK forwards this value to the Copilot CLI when it creates or resumes the session. + +
+TypeScript + + + +```typescript +const session = await client.createSession({ + onPermissionRequest: approveAll, + sessionLimits: { + maxAiCredits: 30, + }, +}); + +const resumed = await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + sessionLimits: { + maxAiCredits: 30, + }, +}); +``` + +
+
+Python + + + +```python +session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + session_limits={ + "max_ai_credits": 30, + }, +) + +resumed = await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + session_limits={ + "max_ai_credits": 30, + }, +) +``` + +
+
+Go + + + +```go +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SessionLimits: &rpc.SessionLimitsConfig{ + MaxAiCredits: copilot.Float64(30), + }, +}) + +resumed, err := client.ResumeSession(ctx, session.SessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SessionLimits: &rpc.SessionLimitsConfig{ + MaxAiCredits: copilot.Float64(30), + }, +}) +``` + +
+
+.NET + + + +```csharp +var session = await client.CreateSessionAsync(new SessionConfig +{ + OnPermissionRequest = PermissionHandler.ApproveAll, + SessionLimits = new SessionLimitsConfig + { + MaxAiCredits = 30, + }, +}); + +var resumed = await client.ResumeSessionAsync(session.SessionId, new ResumeSessionConfig +{ + OnPermissionRequest = PermissionHandler.ApproveAll, + SessionLimits = new SessionLimitsConfig + { + MaxAiCredits = 30, + }, +}); +``` + +
+
+Java + + + +```java +CopilotSession session = client + .createSession(new SessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setSessionLimits(new SessionLimitsConfig(30.0))) + .get(); + +CopilotSession resumed = client + .resumeSession(session.getSessionId(), new ResumeSessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setSessionLimits(new SessionLimitsConfig(30.0))) + .get(); +``` + +
+
+Rust + + + +```rust +let limits = SessionLimitsConfig { + max_ai_credits: Some(30.0), +}; + +let session = client + .create_session( + SessionConfig::default() + .approve_all_permissions() + .with_session_limits(limits.clone()), + ) + .await?; + +let resumed = client + .resume_session( + ResumeSessionConfig::new(session.id().clone()) + .approve_all_permissions() + .with_session_limits(limits), + ) + .await?; +``` + +
+ +## Observe budget events + +Applications can subscribe to session events to update UI when the soft cap changes or the session reaches the exhausted-budget flow. + +| Event type | When it is emitted | Important fields | +|---|---|---| +| `session.session_limits_changed` | Active session limits changed. A `null` `sessionLimits` value means no limits are active. | `sessionLimits.maxAiCredits?` | +| `session.usage_checkpoint` | The runtime records durable aggregate usage for resume and accounting. | `totalNanoAiu`, `totalPremiumRequests?` | +| `session_limits_exhausted.requested` | The session reached the exhausted-budget flow and needs a user decision before continuing. | `requestId`, `maxAiCredits`, `usedAiCredits` | +| `session_limits_exhausted.completed` | The exhausted-limit prompt was resolved. | `requestId`, `response.action`, `response.additionalAiCredits?`, `response.maxAiCredits?` | + +Use the generated event types for the SDK language you are using. For example, TypeScript narrows by `event.type`: + +```typescript +session.on((event) => { + if (event.type === "session_limits_exhausted.requested") { + showBudgetDialog({ + requestId: event.data.requestId, + maxAiCredits: event.data.maxAiCredits, + usedAiCredits: event.data.usedAiCredits, + }); + } +}); +``` diff --git a/docs/features/skills.md b/docs/features/skills.md index 6db955e74..5b8388162 100644 --- a/docs/features/skills.md +++ b/docs/features/skills.md @@ -24,7 +24,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", skillDirectories: [ "./skills/code-review", "./skills/documentation", @@ -50,7 +50,7 @@ async def main(): session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", skill_directories=[ "./skills/code-review", "./skills/documentation", @@ -87,7 +87,7 @@ func main() { defer client.Stop() session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", SkillDirectories: []string{ "./skills/code-review", "./skills/documentation", @@ -122,7 +122,7 @@ using GitHub.Copilot.Rpc; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", SkillDirectories = new List { "./skills/code-review", @@ -154,7 +154,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setSkillDirectories(List.of( "./skills/code-review", "./skills/documentation" diff --git a/docs/features/steering-and-queueing.md b/docs/features/steering-and-queueing.md index 7dbdc17b7..7bfffc433 100644 --- a/docs/features/steering-and-queueing.md +++ b/docs/features/steering-and-queueing.md @@ -47,7 +47,7 @@ const client = new CopilotClient(); await client.start(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -77,7 +77,7 @@ async def main(): session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", ) # Start a long-running task @@ -118,7 +118,7 @@ func main() { defer client.Stop() session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, @@ -158,7 +158,7 @@ using GitHub.Copilot.Rpc; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", OnPermissionRequest = (req, inv) => Task.FromResult(PermissionDecision.ApproveOnce()), }); @@ -191,7 +191,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -234,7 +234,7 @@ const client = new CopilotClient(); await client.start(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -269,7 +269,7 @@ async def main(): session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", ) # Send an initial task @@ -311,7 +311,7 @@ func main() { client.Start(ctx) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil }, @@ -371,7 +371,7 @@ public static class QueueingExample await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "gpt-5.4", OnPermissionRequest = (req, inv) => Task.FromResult(PermissionDecision.ApproveOnce()), }); @@ -434,7 +434,7 @@ try (var client = new CopilotClient()) { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -475,7 +475,7 @@ You can use both patterns together in a single session. Steering affects the cur ```typescript const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -503,7 +503,7 @@ await session.send({ ```python session = await client.create_session( on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(), - model="gpt-4.1", + model="gpt-5.4", ) # Start a task diff --git a/docs/features/streaming-events.md b/docs/features/streaming-events.md index 3388d6a1a..10f111d9f 100644 --- a/docs/features/streaming-events.md +++ b/docs/features/streaming-events.md @@ -56,6 +56,7 @@ Every session event, regardless of type, includes these fields: | `id` | `string` (UUID v4) | Unique event identifier | | `timestamp` | `string` (ISO 8601) | When the event was created | | `parentId` | `string \| null` | ID of the previous event in the chain; `null` for the first event | +| `agentId` | `string?` | Sub-agent instance ID for sub-agent-originated events; absent for root/main agent and session-level events | | `ephemeral` | `boolean?` | `true` for transient events; absent or `false` for persisted events | | `type` | `string` | Event type discriminator (see tables below) | | `data` | `object` | Event-specific payload | @@ -85,7 +86,7 @@ session.on("assistant.message_delta", (event) => { ```python from copilot import CopilotClient -from copilot.generated.session_events import SessionEventType +from copilot.session_events import SessionEventType client = CopilotClient() @@ -100,7 +101,7 @@ def handle(event): ```python -from copilot.generated.session_events import SessionEventType +from copilot.session_events import SessionEventType def handle(event): if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA: @@ -130,7 +131,7 @@ func main() { client := copilot.NewClient(nil) session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "gpt-5.4", Streaming: copilot.Bool(true), OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionApproveOnce{}, nil @@ -209,7 +210,7 @@ session.on(AssistantMessageDeltaEvent.class, event ->
> [!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`. +> **(Python / Go)** These SDKs use separate, per-event data types (for example, `AssistantMessageDeltaData`), so only the relevant fields exist on each type. > > [!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. @@ -217,6 +218,139 @@ session.on(AssistantMessageDeltaEvent.class, event -> > [!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. +## Render only the parent agent response + +Sub-agent events share the parent session stream and include envelope-level `agentId`. Root/main agent events and session-level events omit `agentId`, so main-chat renderers can ignore assistant events where `agentId` is set and route those events to traces or progress UI instead. + +
+TypeScript + +```typescript +import type { CopilotSession } from "@github/copilot-sdk"; + +export function subscribeParentResponse(session: CopilotSession): void { + session.on("assistant.message_delta", (event) => { + if (!event.agentId) { + process.stdout.write(event.data.deltaContent); + } + }); +} +``` + +
+ +
+Python + +```python +from copilot import CopilotSession, SessionEvent, SessionEventType +from copilot.session_events import AssistantMessageDeltaData + + +def subscribe_parent_response(session: CopilotSession) -> None: + def handle(event: SessionEvent) -> None: + if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA and event.agent_id is None: + data = event.data + if isinstance(data, AssistantMessageDeltaData): + print(data.delta_content, end="", flush=True) + + session.on(handle) +``` + +
+ +
+Go + +```go +package example + +import ( + "fmt" + + copilot "github.com/github/copilot-sdk/go" +) + +func subscribeParentResponse(session *copilot.Session) { + session.On(func(event copilot.SessionEvent) { + if event.AgentID != nil { + return + } + + if d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok { + fmt.Print(d.DeltaContent) + } + }) +} +``` + +
+ +
+.NET + +```csharp +using System; +using GitHub.Copilot; + +static class ParentAgentResponseExample +{ + public static void SubscribeParentResponse(CopilotSession session) + { + session.On(evt => + { + if (evt.AgentId is null) + { + Console.Write(evt.Data.DeltaContent); + } + }); + } +} +``` + +
+ +
+Java + +```java +import com.github.copilot.CopilotSession; +import com.github.copilot.generated.AssistantMessageDeltaEvent; + +final class ParentAgentResponseExample { + static void subscribeParentResponse(CopilotSession session) { + session.on(AssistantMessageDeltaEvent.class, event -> { + if (event.getAgentId() == null) { + System.out.print(event.getData().deltaContent()); + } + }); + } +} +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::session::Session; + +async fn subscribe_parent_response(session: &Session) { + let mut events = session.subscribe(); + + while let Ok(event) = events.recv().await { + if event.event_type == "assistant.message_delta" && event.agent_id.is_none() { + if let Some(delta) = event.data.get("deltaContent").and_then(|v| v.as_str()) { + print!("{delta}"); + } + } + } +} +``` + +
+ ## Assistant events These events track the agent's response lifecycle—from turn start through streaming chunks to the final message. @@ -271,7 +405,7 @@ The assistant's complete response for this LLM call. May include tool invocation | `phase` | `string` | | Generation phase (e.g., `"thinking"` vs `"response"`) | | `outputTokens` | `number` | | Actual output token count from the API response | | `interactionId` | `string` | | CAPI interaction ID for telemetry | -| `parentToolCallId` | `string` | | Set when this message originates from a sub-agent | +| `parentToolCallId` | `string` | | Deprecated. Use envelope-level `agentId` for sub-agent attribution | **`ToolRequest` fields:** @@ -290,7 +424,7 @@ Ephemeral. Incremental chunk of the assistant's text response, streamed in real |------------|------|----------|-------------| | `messageId` | `string` | ✅ | Matches the corresponding `assistant.message` event | | `deltaContent` | `string` | ✅ | Text chunk to append to the message | -| `parentToolCallId` | `string` | | Set when originating from a sub-agent | +| `parentToolCallId` | `string` | | Deprecated. Use envelope-level `agentId` for sub-agent attribution | ### `assistant.turn_end` @@ -306,17 +440,26 @@ Ephemeral. Token usage and cost information for an individual API call. | Data Field | Type | Required | Description | |------------|------|----------|-------------| -| `model` | `string` | ✅ | Model identifier (e.g., `"gpt-4.1"`) | +| `model` | `string` | ✅ | Model identifier (e.g., `"gpt-5.4"`) | | `inputTokens` | `number` | | Input tokens consumed | | `outputTokens` | `number` | | Output tokens produced | +| `reasoningTokens` | `number` | | Output tokens used for reasoning/chain-of-thought (subset of `outputTokens`) | | `cacheReadTokens` | `number` | | Tokens read from prompt cache | | `cacheWriteTokens` | `number` | | Tokens written to prompt cache | +| `cacheExpiresAt` | `string` | | ISO 8601 timestamp when the prompt cache for this model call expires | +| `contentFilterTriggered` | `boolean` | | Whether the response was blocked or truncated by content filtering (`finish_reason === 'content_filter'`) | +| `finishReason` | `string` | | Model finish reason (e.g., `"stop"`, `"length"`, `"tool_calls"`, `"content_filter"`) | | `cost` | `number` | | Model multiplier cost for billing | | `duration` | `number` | | API call duration in milliseconds | +| `timeToFirstTokenMs` | `number` | | Time from request dispatch to first token received (streaming latency) | +| `interTokenLatencyMs` | `number` | | Average latency between consecutive tokens (streaming throughput) | +| `reasoningEffort` | `string` | | Reasoning effort level used for this call (e.g., `"low"`, `"medium"`, `"high"`) | | `initiator` | `string` | | What triggered this call (e.g., `"sub-agent"`); absent for user-initiated | | `apiCallId` | `string` | | Completion ID from the provider (e.g., `chatcmpl-abc123`) | +| `serviceRequestId` | `string` | | Copilot service request ID (`x-copilot-service-request-id`) for CAPI log correlation | +| `apiEndpoint` | `"/chat/completions" \| "/v1/messages" \| "/responses" \| "ws:/responses"` | | API endpoint used for the model call; useful for observability and cost attribution. `ws:/responses` is the websocket variant of the responses API | | `providerCallId` | `string` | | GitHub request tracing ID (`x-github-request-id`) | -| `parentToolCallId` | `string` | | Set when usage originates from a sub-agent | +| `parentToolCallId` | `string` | | Deprecated. Use envelope-level `agentId` for sub-agent attribution | | `quotaSnapshots` | `Record` | | Per-quota resource usage, keyed by quota identifier | | `copilotUsage` | `CopilotUsage` | | Itemized token cost breakdown from the API | @@ -343,7 +486,7 @@ Emitted when a tool begins executing. | `arguments` | `object` | | Parsed arguments passed to the tool | | `mcpServerName` | `string` | | MCP server name, when the tool is provided by an MCP server | | `mcpToolName` | `string` | | Original tool name on the MCP server | -| `parentToolCallId` | `string` | | Set when invoked by a sub-agent | +| `parentToolCallId` | `string` | | Deprecated. Use envelope-level `agentId` for sub-agent attribution | ### `tool.execution_partial_result` @@ -377,7 +520,7 @@ Emitted when a tool finishes executing—successfully or with an error. | `result` | `Result` | | Present on success (see below) | | `error` | `{ message, code? }` | | Present on failure | | `toolTelemetry` | `object` | | Tool-specific telemetry (e.g., CodeQL check counts) | -| `parentToolCallId` | `string` | | Set when invoked by a sub-agent | +| `parentToolCallId` | `string` | | Deprecated. Use envelope-level `agentId` for sub-agent attribution | **`Result` fields:** @@ -405,7 +548,7 @@ Ephemeral. The agent has finished all processing and is ready for the next messa | Data Field | Type | Required | Description | |------------|------|----------|-------------| -| `backgroundTasks` | `BackgroundTasks` | | Background agents/shells still running when the agent became idle | +| `aborted` | `boolean` | | True when the preceding turn was cancelled via abort signal | ### `session.error` @@ -471,6 +614,24 @@ Ephemeral. Context window utilization snapshot. | `currentTokens` | `number` | ✅ | Current tokens in the context window | | `messagesLength` | `number` | ✅ | Current message count in the conversation | +### `session.session_limits_changed` + +Session limits changed for the current accounting window. A `null` `sessionLimits` value means no limits are active. + +| Data Field | Type | Required | Description | +|------------|------|----------|-------------| +| `sessionLimits` | `SessionLimitsConfig \| null` | ✅ | Current session limits, or `null` when no limits are active | +| `sessionLimits.maxAiCredits` | `number` | | Maximum AI Credits allowed across the session's current accounting window | + +### `session.usage_checkpoint` + +Durable aggregate usage checkpoint used to reconstruct accounting when a session is resumed. + +| Data Field | Type | Required | Description | +|------------|------|----------|-------------| +| `totalNanoAiu` | `number` | ✅ | Session-wide accumulated nano-AI units cost at checkpoint time | +| `totalPremiumRequests` | `number` | | Total number of premium API requests used at checkpoint time | + ### `session.task_complete` The agent has completed its assigned task. @@ -500,7 +661,7 @@ These events are emitted when the agent needs approval or input from the user be ### `permission.requested` -Ephemeral. The agent needs permission to perform an action (run a command, write a file, etc.). +The agent needs permission to perform an action (run a command, write a file, etc.). | Data Field | Type | Required | Description | |------------|------|----------|-------------| @@ -523,7 +684,7 @@ All `kind` variants also include an optional `toolCallId` linking back to the to ### `permission.completed` -Ephemeral. A permission request was resolved. +A permission request was resolved. | Data Field | Type | Required | Description | |------------|------|----------|-------------| @@ -580,6 +741,7 @@ A custom agent was invoked as a sub-agent. | `agentName` | `string` | ✅ | Internal name of the sub-agent | | `agentDisplayName` | `string` | ✅ | Human-readable display name | | `agentDescription` | `string` | ✅ | Description of what the sub-agent does | +| `model` | `string` | | Model the sub-agent will run with, when known at start | ### `subagent.completed` @@ -590,6 +752,10 @@ A sub-agent finished successfully. | `toolCallId` | `string` | ✅ | Matches the corresponding `subagent.started` | | `agentName` | `string` | ✅ | Internal name | | `agentDisplayName` | `string` | ✅ | Display name | +| `model` | `string` | | Model used by the sub-agent | +| `durationMs` | `number` | | Wall-clock execution duration in milliseconds | +| `totalTokens` | `number` | | Total input and output tokens consumed | +| `totalToolCalls` | `number` | | Total tool calls made | ### `subagent.failed` @@ -601,6 +767,10 @@ A sub-agent encountered an error. | `agentName` | `string` | ✅ | Internal name | | `agentDisplayName` | `string` | ✅ | Display name | | `error` | `string` | ✅ | Error message | +| `model` | `string` | | Model selected for the sub-agent, when known | +| `durationMs` | `number` | | Wall-clock execution duration in milliseconds | +| `totalTokens` | `number` | | Total input and output tokens consumed before failure | +| `totalToolCalls` | `number` | | Total tool calls made before failure | ### `subagent.selected` @@ -665,7 +835,7 @@ A system or developer prompt was injected into the conversation. ### `external_tool.requested` -Ephemeral. The agent wants to invoke an external tool (one provided by the SDK consumer). +The agent wants to invoke an external tool (one provided by the SDK consumer). | Data Field | Type | Required | Description | |------------|------|----------|-------------| @@ -677,7 +847,7 @@ Ephemeral. The agent wants to invoke an external tool (one provided by the SDK c ### `external_tool.completed` -Ephemeral. An external tool request was resolved. +An external tool request was resolved. | Data Field | Type | Required | Description | |------------|------|----------|-------------| @@ -720,6 +890,27 @@ Ephemeral. A queued command was resolved. |------------|------|----------|-------------| | `requestId` | `string` | ✅ | Matches the corresponding `command.queued` | +### `session_limits_exhausted.requested` + +Ephemeral. The current session budget was exhausted and the runtime needs a user decision before continuing. + +| Data Field | Type | Required | Description | +|------------|------|----------|-------------| +| `requestId` | `string` | ✅ | Use this ID when responding to the pending exhausted-limit request | +| `maxAiCredits` | `number` | ✅ | Configured max AI Credits for the current accounting window | +| `usedAiCredits` | `number` | ✅ | AI Credits already consumed in the current accounting window | + +### `session_limits_exhausted.completed` + +Ephemeral. A pending exhausted-limit request was resolved. + +| Data Field | Type | Required | Description | +|------------|------|----------|-------------| +| `requestId` | `string` | ✅ | Matches the corresponding `session_limits_exhausted.requested` event | +| `response.action` | `"add" \| "set" \| "unset" \| "cancel"` | ✅ | Action selected for the exhausted-limit request | +| `response.additionalAiCredits` | `number` | | AI Credits to add to the current max when `response.action` is `"add"` | +| `response.maxAiCredits` | `number` | | New absolute max AI Credits when `response.action` is `"set"` | + ## Quick reference: agentic turn flow A typical agentic turn emits events in this order: @@ -734,8 +925,8 @@ assistant.turn_start → Turn begins ├── assistant.usage → Token usage for this API call (ephemeral) │ ├── [If tools were requested:] -│ ├── permission.requested → Needs user approval (ephemeral) -│ ├── permission.completed → Approval result (ephemeral) +│ ├── permission.requested → Needs user approval +│ ├── permission.completed → Approval result │ ├── tool.execution_start → Tool begins │ ├── tool.execution_partial_result → Streaming tool output (ephemeral, repeated) │ ├── tool.execution_progress → Progress updates (ephemeral, repeated) @@ -749,6 +940,8 @@ session.idle → Ready for next message (ephemeral) ## All event types at a glance +This table lists key `data` payload fields. Common envelope fields are documented above. + | Event Type | Ephemeral | Category | Key Data Fields | |------------|-----------|----------|-----------------| | `assistant.turn_start` | | Assistant | `turnId`, `interactionId?` | @@ -757,41 +950,45 @@ session.idle → Ready for next message (ephemeral) | `assistant.reasoning_delta` | ✅ | Assistant | `reasoningId`, `deltaContent` | | `assistant.streaming_delta` | ✅ | Assistant | `totalResponseSizeBytes` | | `assistant.message` | | Assistant | `messageId`, `content`, `toolRequests?`, `outputTokens?`, `phase?` | -| `assistant.message_delta` | ✅ | Assistant | `messageId`, `deltaContent`, `parentToolCallId?` | +| `assistant.message_delta` | ✅ | Assistant | `messageId`, `deltaContent` | | `assistant.turn_end` | | Assistant | `turnId` | -| `assistant.usage` | ✅ | Assistant | `model`, `inputTokens?`, `outputTokens?`, `cost?`, `duration?` | +| `assistant.usage` | ✅ | Assistant | `model`, `apiEndpoint?`, `inputTokens?`, `outputTokens?`, `cost?`, `duration?` | | `tool.user_requested` | | Tool | `toolCallId`, `toolName`, `arguments?` | | `tool.execution_start` | | Tool | `toolCallId`, `toolName`, `arguments?`, `mcpServerName?` | | `tool.execution_partial_result` | ✅ | Tool | `toolCallId`, `partialOutput` | | `tool.execution_progress` | ✅ | Tool | `toolCallId`, `progressMessage` | | `tool.execution_complete` | | Tool | `toolCallId`, `success`, `result?`, `error?` | -| `session.idle` | ✅ | Session | `backgroundTasks?` | +| `session.idle` | ✅ | Session | `aborted?` | | `session.error` | | Session | `errorType`, `message`, `statusCode?` | | `session.compaction_start` | | Session | *(empty)* | | `session.compaction_complete` | | Session | `success`, `preCompactionTokens?`, `summaryContent?` | | `session.title_changed` | ✅ | Session | `title` | | `session.context_changed` | | Session | `cwd`, `gitRoot?`, `repository?`, `branch?` | | `session.usage_info` | ✅ | Session | `tokenLimit`, `currentTokens`, `messagesLength` | +| `session.session_limits_changed` | | Session | `sessionLimits` | +| `session.usage_checkpoint` | | Session | `totalNanoAiu`, `totalPremiumRequests?` | | `session.task_complete` | | Session | `summary?` | | `session.shutdown` | | Session | `shutdownType`, `codeChanges`, `modelMetrics` | -| `permission.requested` | ✅ | Permission | `requestId`, `permissionRequest` | -| `permission.completed` | ✅ | Permission | `requestId`, `result.kind` | +| `permission.requested` | | Permission | `requestId`, `permissionRequest` | +| `permission.completed` | | Permission | `requestId`, `result.kind` | | `user_input.requested` | ✅ | User Input | `requestId`, `question`, `choices?` | | `user_input.completed` | ✅ | User Input | `requestId` | | `elicitation.requested` | ✅ | User Input | `requestId`, `message`, `requestedSchema` | | `elicitation.completed` | ✅ | User Input | `requestId` | -| `subagent.started` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName` | -| `subagent.completed` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName` | -| `subagent.failed` | | Sub-Agent | `toolCallId`, `agentName`, `error` | +| `subagent.started` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName`, `model?` | +| `subagent.completed` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName`, `model?`, `durationMs?`, `totalTokens?`, `totalToolCalls?` | +| `subagent.failed` | | Sub-Agent | `toolCallId`, `agentName`, `error`, `model?`, `durationMs?`, `totalTokens?`, `totalToolCalls?` | | `subagent.selected` | | Sub-Agent | `agentName`, `agentDisplayName`, `tools` | | `subagent.deselected` | | Sub-Agent | *(empty)* | | `skill.invoked` | | Skill | `name`, `path`, `content`, `allowedTools?` | | `abort` | | Control | `reason` | | `user.message` | | User | `content`, `attachments?`, `agentMode?` | | `system.message` | | System | `content`, `role` | -| `external_tool.requested` | ✅ | External Tool | `requestId`, `toolName`, `arguments?` | -| `external_tool.completed` | ✅ | External Tool | `requestId` | +| `external_tool.requested` | | External Tool | `requestId`, `toolName`, `arguments?` | +| `external_tool.completed` | | External Tool | `requestId` | | `command.queued` | ✅ | Command | `requestId`, `command` | | `command.completed` | ✅ | Command | `requestId` | +| `session_limits_exhausted.requested` | ✅ | Session | `requestId`, `maxAiCredits`, `usedAiCredits` | +| `session_limits_exhausted.completed` | ✅ | Session | `requestId`, `response.action` | | `exit_plan_mode.requested` | ✅ | Plan Mode | `requestId`, `summary`, `planContent`, `actions` | | `exit_plan_mode.completed` | ✅ | Plan Mode | `requestId` | \ No newline at end of file diff --git a/docs/features/usage-and-billing.md b/docs/features/usage-and-billing.md new file mode 100644 index 000000000..ec662b685 --- /dev/null +++ b/docs/features/usage-and-billing.md @@ -0,0 +1,1355 @@ +# Usage and billing metrics + +This guide shows how to read token counts, context-window utilization, AI credit cost, and account quota from a Copilot SDK application. Examples are shown for TypeScript, Python, Go, .NET, Java, and Rust. + +> [!TIP] +> Each example is functionally equivalent across languages. The TypeScript snippet is expanded by default; select your language from the collapsible blocks to see the same logic in that SDK. + +## Overview + +The SDK surfaces usage data through two complementary mechanisms: + +* **Session events**: ephemeral events the runtime emits as a turn runs. Subscribe to these for real-time, per-API-call data. +* **RPC methods**: request/response calls you make on demand. Use these to snapshot accumulated totals or look up account-level quota. + +The table below maps each signal to the API that exposes it. + +| Signal | API | Scope | Type | +|---|---|---|---| +| Per-call token counts | `assistant.usage` event | Session | Event | +| Context-window utilization | `session.usage_info` event | Session | Event | +| Context-window breakdown (on demand) | `session.metadata.contextInfo` | Session | RPC | +| Accumulated AI credit and token totals | `session.usage.getMetrics` | Session | RPC | +| Per-model AI credit pricing | `models.list` | Server | RPC | +| Account quota and premium interactions | `account.getQuota` | Server | RPC | + +> [!NOTE] +> `session.usage.getMetrics`, `session.metadata.contextInfo`, and `session.metadata.recomputeContextTokens` are marked experimental in the generated RPC surface. In .NET they raise the `GHCP001` experimental diagnostic, which you suppress with `#pragma warning disable GHCP001` or a project-level `GHCP001`. Pin both the SDK and the Copilot CLI runtime if your application depends on them. + +The field tables below list only the fields used in the examples on this page. The complete, always-current field reference is the generated SDK types plus [Streaming events](./streaming-events.md), which is regenerated from the CLI schema on every dependency bump. Treat those as the source of truth and this page as a task-oriented guide. + +## Per-call token counts + +The `assistant.usage` event is emitted once for every model API call in a turn (including calls made by sub-agents). It carries the token counts and the billing multiplier for that single call. + +The example below uses these fields. See [Streaming events](./streaming-events.md#assistantusage) for the full list, including cache, reasoning, latency, and tracing fields. + +| Field | Type | Description | +|---|---|---| +| `model` | `string` | Model identifier for this call | +| `inputTokens` | `number` | Input tokens consumed | +| `outputTokens` | `number` | Output tokens produced | +| `cost` | `number` | Premium request multiplier applied to this call | + +> [!TIP] +> `assistant.usage` is ephemeral, so it is delivered live but not replayed when you resume a session. To read accumulated totals after the fact, call `session.usage.getMetrics` (see [Accumulated AI credit and token totals](#accumulated-ai-credit-and-token-totals)). + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({ streaming: true }); + +session.on("assistant.usage", (event) => { + const { model, inputTokens, outputTokens, cost } = event.data; + console.log( + `${model}: in=${inputTokens ?? 0} out=${outputTokens ?? 0} cost=${cost ?? 0}`, + ); +}); +``` + + +```typescript +session.on("assistant.usage", (event) => { + const { model, inputTokens, outputTokens, cost } = event.data; + console.log( + `${model}: in=${inputTokens ?? 0} out=${outputTokens ?? 0} cost=${cost ?? 0}`, + ); +}); +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient +from copilot.session_events import SessionEventType + +client = CopilotClient() +session = await client.create_session(streaming=True) + +def on_usage(event): + if event.type == SessionEventType.ASSISTANT_USAGE: + data = event.data + print(f"{data.model}: in={data.input_tokens or 0} out={data.output_tokens or 0} cost={data.cost or 0}") + +session.on(on_usage) +``` + + +```python +def on_usage(event): + if event.type == SessionEventType.ASSISTANT_USAGE: + data = event.data + print(f"{data.model}: in={data.input_tokens or 0} out={data.output_tokens or 0} cost={data.cost or 0}") + +session.on(on_usage) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ + Streaming: copilot.Bool(true), + OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { + return &rpc.PermissionDecisionApproveOnce{}, nil + }, + }) + + session.On(func(event copilot.SessionEvent) { + d, ok := event.Data.(*copilot.AssistantUsageData) + if !ok { + return + } + in, out, cost := int64(0), int64(0), float64(0) + if d.InputTokens != nil { + in = *d.InputTokens + } + if d.OutputTokens != nil { + out = *d.OutputTokens + } + if d.Cost != nil { + cost = *d.Cost + } + fmt.Printf("%s: in=%d out=%d cost=%g\n", d.Model, in, out, cost) + }) + _ = session +} +``` + + +```go +session.On(func(event copilot.SessionEvent) { + d, ok := event.Data.(*copilot.AssistantUsageData) + if !ok { + return + } + in, out, cost := int64(0), int64(0), float64(0) + if d.InputTokens != nil { + in = *d.InputTokens + } + if d.OutputTokens != nil { + out = *d.OutputTokens + } + if d.Cost != nil { + cost = *d.Cost + } + fmt.Printf("%s: in=%d out=%d cost=%g\n", d.Model, in, out, cost) +}) +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(); +await using var session = await client.CreateSessionAsync(new SessionConfig { Streaming = true }); + +session.On(evt => +{ + var data = evt.Data; + Console.WriteLine( + $"{data.Model}: in={data.InputTokens ?? 0} out={data.OutputTokens ?? 0} cost={data.Cost ?? 0}"); +}); +``` + + +```csharp +session.On(evt => +{ + var data = evt.Data; + Console.WriteLine( + $"{data.Model}: in={data.InputTokens ?? 0} out={data.OutputTokens ?? 0} cost={data.Cost ?? 0}"); +}); +``` + +
+ +
+Java + + +```java +session.on(AssistantUsageEvent.class, event -> { + var data = event.getData(); + long in = data.inputTokens() != null ? data.inputTokens() : 0; + long out = data.outputTokens() != null ? data.outputTokens() : 0; + double cost = data.cost() != null ? data.cost() : 0.0; + System.out.printf("%s: in=%d out=%d cost=%s%n", data.model(), in, out, cost); +}); +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::session_events::AssistantUsageData; + +let mut events = session.subscribe(); +while let Ok(event) = events.recv().await { + if event.event_type == "assistant.usage" { + if let Some(data) = event.typed_data::() { + println!( + "{}: in={} out={} cost={}", + data.model, + data.input_tokens.unwrap_or(0), + data.output_tokens.unwrap_or(0), + data.cost.unwrap_or(0.0), + ); + } + } +} +``` + +
+ +## Context-window utilization + +Token counts tell you what each call consumed. Context-window utilization tells you how full the model's prompt window is right now—useful for showing a progress bar or warning the user before automatic compaction kicks in. + +### Live updates with `session.usage_info` + +The runtime emits a `session.usage_info` event whenever the context-window size changes. The example uses `currentTokens` and `tokenLimit`; see [Streaming events](./streaming-events.md#sessionusage_info) for the complete payload. + +| Field | Type | Description | +|---|---|---| +| `currentTokens` | `number` | Tokens currently in the context window | +| `tokenLimit` | `number` | Maximum tokens for the model's context window | + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({ streaming: true }); + +session.on("session.usage_info", (event) => { + const { currentTokens, tokenLimit } = event.data; + const pct = Math.round((currentTokens / tokenLimit) * 100); + console.log(`Context: ${currentTokens}/${tokenLimit} (${pct}%)`); +}); +``` + + +```typescript +session.on("session.usage_info", (event) => { + const { currentTokens, tokenLimit } = event.data; + const pct = Math.round((currentTokens / tokenLimit) * 100); + console.log(`Context: ${currentTokens}/${tokenLimit} (${pct}%)`); +}); +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient +from copilot.session_events import SessionEventType + +client = CopilotClient() +session = await client.create_session(streaming=True) + +def on_usage_info(event): + if event.type == SessionEventType.SESSION_USAGE_INFO: + data = event.data + pct = round(data.current_tokens / data.token_limit * 100) + print(f"Context: {data.current_tokens}/{data.token_limit} ({pct}%)") + +session.on(on_usage_info) +``` + + +```python +def on_usage_info(event): + if event.type == SessionEventType.SESSION_USAGE_INFO: + data = event.data + pct = round(data.current_tokens / data.token_limit * 100) + print(f"Context: {data.current_tokens}/{data.token_limit} ({pct}%)") + +session.on(on_usage_info) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ + Streaming: copilot.Bool(true), + OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) { + return &rpc.PermissionDecisionApproveOnce{}, nil + }, + }) + + session.On(func(event copilot.SessionEvent) { + d, ok := event.Data.(*copilot.SessionUsageInfoData) + if !ok { + return + } + pct := int(float64(d.CurrentTokens) / float64(d.TokenLimit) * 100) + fmt.Printf("Context: %d/%d (%d%%)\n", d.CurrentTokens, d.TokenLimit, pct) + }) + _ = session +} +``` + + +```go +session.On(func(event copilot.SessionEvent) { + d, ok := event.Data.(*copilot.SessionUsageInfoData) + if !ok { + return + } + pct := int(float64(d.CurrentTokens) / float64(d.TokenLimit) * 100) + fmt.Printf("Context: %d/%d (%d%%)\n", d.CurrentTokens, d.TokenLimit, pct) +}) +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(); +await using var session = await client.CreateSessionAsync(new SessionConfig { Streaming = true }); + +session.On(evt => +{ + var pct = (int)Math.Round((double)evt.Data.CurrentTokens / evt.Data.TokenLimit * 100); + Console.WriteLine($"Context: {evt.Data.CurrentTokens}/{evt.Data.TokenLimit} ({pct}%)"); +}); +``` + + +```csharp +session.On(evt => +{ + var pct = (int)Math.Round((double)evt.Data.CurrentTokens / evt.Data.TokenLimit * 100); + Console.WriteLine($"Context: {evt.Data.CurrentTokens}/{evt.Data.TokenLimit} ({pct}%)"); +}); +``` + +
+ +
+Java + + +```java +session.on(SessionUsageInfoEvent.class, event -> { + var data = event.getData(); + long pct = Math.round((double) data.currentTokens() / data.tokenLimit() * 100); + System.out.printf("Context: %d/%d (%d%%)%n", data.currentTokens(), data.tokenLimit(), pct); +}); +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::session_events::SessionUsageInfoData; + +let mut events = session.subscribe(); +while let Ok(event) = events.recv().await { + if event.event_type == "session.usage_info" { + if let Some(data) = event.typed_data::() { + let pct = (data.current_tokens as f64 / data.token_limit as f64 * 100.0) as i64; + println!("Context: {}/{} ({}%)", data.current_tokens, data.token_limit, pct); + } + } +} +``` + +
+ +### On-demand breakdown with `session.metadata.contextInfo` + +Events only fire when the context changes. To read the current breakdown at any moment—for example, right after resuming a session—call `session.metadata.contextInfo`. Pass `0` for `promptTokenLimit` to use the runtime default; pass `0` for `outputTokenLimit` if the value is unknown. + +The result's `contextInfo` is `null` until the session has been initialized (the system prompt and tool metadata have been cached). It breaks the total down into `systemTokens`, `conversationTokens`, and `toolDefinitionsTokens`, alongside the `promptTokenLimit`. + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({}); + +const { contextInfo } = await session.rpc.metadata.contextInfo({ + promptTokenLimit: 0, + outputTokenLimit: 0, +}); + +if (contextInfo) { + console.log( + `Total ${contextInfo.totalTokens}/${contextInfo.promptTokenLimit} ` + + `(system=${contextInfo.systemTokens}, conversation=${contextInfo.conversationTokens})`, + ); +} +``` + + +```typescript +const { contextInfo } = await session.rpc.metadata.contextInfo({ + promptTokenLimit: 0, + outputTokenLimit: 0, +}); + +if (contextInfo) { + console.log( + `Total ${contextInfo.totalTokens}/${contextInfo.promptTokenLimit} ` + + `(system=${contextInfo.systemTokens}, conversation=${contextInfo.conversationTokens})`, + ); +} +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient +from copilot.rpc import MetadataContextInfoRequest + +client = CopilotClient() +session = await client.create_session() + +result = await session.rpc.metadata.context_info( + MetadataContextInfoRequest(prompt_token_limit=0, output_token_limit=0) +) +info = result.context_info + +if info is not None: + print( + f"Total {info.total_tokens}/{info.prompt_token_limit} " + f"(system={info.system_tokens}, conversation={info.conversation_tokens})" + ) +``` + + +```python +result = await session.rpc.metadata.context_info( + MetadataContextInfoRequest(prompt_token_limit=0, output_token_limit=0) +) +info = result.context_info + +if info is not None: + print( + f"Total {info.total_tokens}/{info.prompt_token_limit} " + f"(system={info.system_tokens}, conversation={info.conversation_tokens})" + ) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{}) + + result, _ := session.RPC.Metadata.ContextInfo(ctx, &rpc.MetadataContextInfoRequest{ + PromptTokenLimit: 0, + OutputTokenLimit: 0, + }) + + if info := result.ContextInfo; info != nil { + fmt.Printf("Total %d/%d (system=%d, conversation=%d)\n", + info.TotalTokens, info.PromptTokenLimit, info.SystemTokens, info.ConversationTokens) + } +} +``` + + +```go +result, _ := session.RPC.Metadata.ContextInfo(ctx, &rpc.MetadataContextInfoRequest{ + PromptTokenLimit: 0, + OutputTokenLimit: 0, +}) + +if info := result.ContextInfo; info != nil { + fmt.Printf("Total %d/%d (system=%d, conversation=%d)\n", + info.TotalTokens, info.PromptTokenLimit, info.SystemTokens, info.ConversationTokens) +} +``` + +
+ +
+.NET + + +```csharp +#pragma warning disable GHCP001 +using GitHub.Copilot; + +await using var client = new CopilotClient(); +await using var session = await client.CreateSessionAsync(new SessionConfig()); + +var result = await session.Rpc.Metadata.ContextInfoAsync(promptTokenLimit: 0, outputTokenLimit: 0); +var info = result.ContextInfo; + +if (info is not null) +{ + Console.WriteLine( + $"Total {info.TotalTokens}/{info.PromptTokenLimit} " + + $"(system={info.SystemTokens}, conversation={info.ConversationTokens})"); +} +#pragma warning restore GHCP001 +``` + + +```csharp +var result = await session.Rpc.Metadata.ContextInfoAsync(promptTokenLimit: 0, outputTokenLimit: 0); +var info = result.ContextInfo; + +if (info is not null) +{ + Console.WriteLine( + $"Total {info.TotalTokens}/{info.PromptTokenLimit} " + + $"(system={info.SystemTokens}, conversation={info.ConversationTokens})"); +} +``` + +
+ +
+Java + + +```java +var result = session.getRpc().metadata + .contextInfo(new SessionMetadataContextInfoParams(null, 0L, 0L, null)) + .join(); +var info = result.contextInfo(); + +if (info != null) { + System.out.printf("Total %d/%d (system=%d, conversation=%d)%n", + info.totalTokens(), info.promptTokenLimit(), info.systemTokens(), info.conversationTokens()); +} +``` + +
+ +
+Rust + +```rust +use github_copilot_sdk::rpc::MetadataContextInfoRequest; + +let result = session + .rpc() + .metadata() + .context_info(MetadataContextInfoRequest { + prompt_token_limit: 0, + output_token_limit: 0, + selected_model: None, + }) + .await?; + +if let Some(info) = result.context_info { + println!( + "Total {}/{} (system={}, conversation={})", + info.total_tokens, info.prompt_token_limit, info.system_tokens, info.conversation_tokens, + ); +} +``` + +
+ +## Accumulated AI credit and token totals + +`session.usage.getMetrics` returns the running totals for the whole session in a single call. This is the cleanest way to read AI credit cost, because it aggregates every API call (main agent and sub-agents) for you. + +The example uses the fields below. The generated `UsageGetMetricsResult` type is the full reference. + +| Field | Type | Description | +|---|---|---| +| `totalNanoAiu` | `number` | Session-wide AI credit cost, in nano-AI units | +| `totalPremiumRequestCost` | `number` | Premium request cost across all models, after multipliers | +| `modelMetrics` | `Record` | Per-model breakdown; each entry has `usage.inputTokens`, `usage.outputTokens`, and `totalNanoAiu` | + +> [!NOTE] +> Cost is reported in **nano-AI units** (the field is named `totalNanoAiu`). The exact conversion to AI credits and the precise meaning of premium request accounting are defined by GitHub Copilot billing, not by the SDK—treat [GitHub's Copilot billing documentation](https://docs.github.com/en/copilot/managing-copilot/understanding-and-managing-copilot-usage) as the source of truth and verify before surfacing currency-like values to users. The examples divide by `1e9` as a convenience, following the SI `nano` prefix; confirm this matches current billing before relying on it. The `modelMetrics` and `tokenDetails` maps are keyed by runtime strings (model IDs and token-type names) that the SDK type system does not validate. + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); +const session = await client.createSession({}); + +const metrics = await session.rpc.usage.getMetrics(); + +const aiCredits = (metrics.totalNanoAiu ?? 0) / 1e9; +console.log(`AI credits used: ${aiCredits.toFixed(6)}`); +console.log(`Premium requests: ${metrics.totalPremiumRequestCost}`); + +for (const [model, m] of Object.entries(metrics.modelMetrics)) { + if (!m) continue; + console.log( + `${model}: in=${m.usage.inputTokens} out=${m.usage.outputTokens} ` + + `nanoAiu=${m.totalNanoAiu ?? 0}`, + ); +} +``` + + +```typescript +const metrics = await session.rpc.usage.getMetrics(); + +const aiCredits = (metrics.totalNanoAiu ?? 0) / 1e9; +console.log(`AI credits used: ${aiCredits.toFixed(6)}`); +console.log(`Premium requests: ${metrics.totalPremiumRequestCost}`); + +for (const [model, m] of Object.entries(metrics.modelMetrics)) { + if (!m) continue; + console.log( + `${model}: in=${m.usage.inputTokens} out=${m.usage.outputTokens} ` + + `nanoAiu=${m.totalNanoAiu ?? 0}`, + ); +} +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient + +client = CopilotClient() +session = await client.create_session() + +metrics = await session.rpc.usage.get_metrics() + +ai_credits = (metrics.total_nano_aiu or 0) / 1e9 +print(f"AI credits used: {ai_credits:.6f}") +print(f"Premium requests: {metrics.total_premium_request_cost}") + +for model, m in metrics.model_metrics.items(): + print(f"{model}: in={m.usage.input_tokens} out={m.usage.output_tokens} nanoAiu={m.total_nano_aiu or 0}") +``` + + +```python +metrics = await session.rpc.usage.get_metrics() + +ai_credits = (metrics.total_nano_aiu or 0) / 1e9 +print(f"AI credits used: {ai_credits:.6f}") +print(f"Premium requests: {metrics.total_premium_request_cost}") + +for model, m in metrics.model_metrics.items(): + print(f"{model}: in={m.usage.input_tokens} out={m.usage.output_tokens} nanoAiu={m.total_nano_aiu or 0}") +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{}) + + metrics, _ := session.RPC.Usage.GetMetrics(ctx) + + aiCredits := float64(0) + if metrics.TotalNanoAiu != nil { + aiCredits = *metrics.TotalNanoAiu / 1e9 + } + fmt.Printf("AI credits used: %.6f\n", aiCredits) + fmt.Printf("Premium requests: %v\n", metrics.TotalPremiumRequestCost) + + for model, m := range metrics.ModelMetrics { + nanoAiu := float64(0) + if m.TotalNanoAiu != nil { + nanoAiu = *m.TotalNanoAiu + } + fmt.Printf("%s: in=%d out=%d nanoAiu=%v\n", model, m.Usage.InputTokens, m.Usage.OutputTokens, nanoAiu) + } +} +``` + + +```go +metrics, _ := session.RPC.Usage.GetMetrics(ctx) + +aiCredits := float64(0) +if metrics.TotalNanoAiu != nil { + aiCredits = *metrics.TotalNanoAiu / 1e9 +} +fmt.Printf("AI credits used: %.6f\n", aiCredits) +fmt.Printf("Premium requests: %v\n", metrics.TotalPremiumRequestCost) + +for model, m := range metrics.ModelMetrics { + nanoAiu := float64(0) + if m.TotalNanoAiu != nil { + nanoAiu = *m.TotalNanoAiu + } + fmt.Printf("%s: in=%d out=%d nanoAiu=%v\n", model, m.Usage.InputTokens, m.Usage.OutputTokens, nanoAiu) +} +``` + +
+ +
+.NET + + +```csharp +#pragma warning disable GHCP001 +using GitHub.Copilot; + +await using var client = new CopilotClient(); +await using var session = await client.CreateSessionAsync(new SessionConfig()); + +var metrics = await session.Rpc.Usage.GetMetricsAsync(); + +var aiCredits = (metrics.TotalNanoAiu ?? 0) / 1e9; +Console.WriteLine($"AI credits used: {aiCredits:F6}"); +Console.WriteLine($"Premium requests: {metrics.TotalPremiumRequestCost}"); + +foreach (var (model, m) in metrics.ModelMetrics) +{ + Console.WriteLine( + $"{model}: in={m.Usage.InputTokens} out={m.Usage.OutputTokens} nanoAiu={m.TotalNanoAiu ?? 0}"); +} +#pragma warning restore GHCP001 +``` + + +```csharp +var metrics = await session.Rpc.Usage.GetMetricsAsync(); + +var aiCredits = (metrics.TotalNanoAiu ?? 0) / 1e9; +Console.WriteLine($"AI credits used: {aiCredits:F6}"); +Console.WriteLine($"Premium requests: {metrics.TotalPremiumRequestCost}"); + +foreach (var (model, m) in metrics.ModelMetrics) +{ + Console.WriteLine( + $"{model}: in={m.Usage.InputTokens} out={m.Usage.OutputTokens} nanoAiu={m.TotalNanoAiu ?? 0}"); +} +``` + +
+ +
+Java + + +```java +var metrics = session.getRpc().usage.getMetrics().join(); + +double aiCredits = metrics.totalNanoAiu() != null ? metrics.totalNanoAiu() / 1e9 : 0; +System.out.printf("AI credits used: %.6f%n", aiCredits); +System.out.printf("Premium requests: %s%n", metrics.totalPremiumRequestCost()); + +metrics.modelMetrics().forEach((model, m) -> { + double nanoAiu = m.totalNanoAiu() != null ? m.totalNanoAiu() : 0; + System.out.printf("%s: in=%d out=%d nanoAiu=%s%n", + model, m.usage().inputTokens(), m.usage().outputTokens(), nanoAiu); +}); +``` + +
+ +
+Rust + +```rust +let metrics = session.rpc().usage().get_metrics().await?; + +let ai_credits = metrics.total_nano_aiu.unwrap_or(0.0) / 1e9; +println!("AI credits used: {ai_credits:.6}"); +println!("Premium requests: {}", metrics.total_premium_request_cost); + +for (model, m) in &metrics.model_metrics { + let nano_aiu = m.total_nano_aiu.unwrap_or(0.0); + println!( + "{model}: in={} out={} nanoAiu={nano_aiu}", + m.usage.input_tokens, m.usage.output_tokens, + ); +} +``` + +
+ +## Per-model AI credit pricing + +To estimate cost before you run a turn, read each model's token prices from `models.list`. This is a server-scoped call on the client, so it does not need a session. Prices are expressed in AI credits per billing batch of tokens. The generated `ModelBillingTokenPrices` type lists every field, including `cachePrice`. + +| Field | Type | Description | +|---|---|---| +| `billing.multiplier` | `number` | Premium request cost multiplier relative to the base rate | +| `billing.tokenPrices.inputPrice` | `number` | AI credit cost per batch of input tokens | +| `billing.tokenPrices.outputPrice` | `number` | AI credit cost per batch of output tokens | +| `billing.tokenPrices.batchSize` | `number` | Number of tokens per billing batch | + +> [!NOTE] +> Price values change as plans and models evolve. Read them at runtime as shown below; never hard-code the numbers into your application. + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); + +const { models } = await client.rpc.models.list({}); + +for (const model of models) { + const prices = model.billing?.tokenPrices; + if (!prices) continue; + console.log( + `${model.id}: input=${prices.inputPrice} output=${prices.outputPrice} ` + + `per ${prices.batchSize} tokens (x${model.billing?.multiplier ?? 1})`, + ); +} +``` + + +```typescript +const { models } = await client.rpc.models.list({}); + +for (const model of models) { + const prices = model.billing?.tokenPrices; + if (!prices) continue; + console.log( + `${model.id}: input=${prices.inputPrice} output=${prices.outputPrice} ` + + `per ${prices.batchSize} tokens (x${model.billing?.multiplier ?? 1})`, + ); +} +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient +from copilot.rpc import ModelsListRequest + +client = CopilotClient() + +result = await client.rpc.models.list(ModelsListRequest()) + +for model in result.models: + prices = model.billing.token_prices if model.billing else None + if prices is None: + continue + multiplier = model.billing.multiplier if model.billing else 1 + print( + f"{model.id}: input={prices.input_price} output={prices.output_price} " + f"per {prices.batch_size} tokens (x{multiplier})" + ) +``` + + +```python +result = await client.rpc.models.list(ModelsListRequest()) + +for model in result.models: + prices = model.billing.token_prices if model.billing else None + if prices is None: + continue + multiplier = model.billing.multiplier if model.billing else 1 + print( + f"{model.id}: input={prices.input_price} output={prices.output_price} " + f"per {prices.batch_size} tokens (x{multiplier})" + ) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + list, _ := client.RPC.Models.List(ctx, &rpc.ModelsListRequest{}) + + for _, model := range list.Models { + if model.Billing == nil || model.Billing.TokenPrices == nil { + continue + } + prices := model.Billing.TokenPrices + multiplier := 1.0 + if model.Billing.Multiplier != nil { + multiplier = *model.Billing.Multiplier + } + in, out := 0.0, 0.0 + if prices.InputPrice != nil { + in = *prices.InputPrice + } + if prices.OutputPrice != nil { + out = *prices.OutputPrice + } + batch := int64(0) + if prices.BatchSize != nil { + batch = *prices.BatchSize + } + fmt.Printf("%s: input=%v output=%v per %d tokens (x%v)\n", model.ID, in, out, batch, multiplier) + } +} +``` + + +```go +list, _ := client.RPC.Models.List(ctx, &rpc.ModelsListRequest{}) + +for _, model := range list.Models { + if model.Billing == nil || model.Billing.TokenPrices == nil { + continue + } + prices := model.Billing.TokenPrices + multiplier := 1.0 + if model.Billing.Multiplier != nil { + multiplier = *model.Billing.Multiplier + } + in, out := 0.0, 0.0 + if prices.InputPrice != nil { + in = *prices.InputPrice + } + if prices.OutputPrice != nil { + out = *prices.OutputPrice + } + batch := int64(0) + if prices.BatchSize != nil { + batch = *prices.BatchSize + } + fmt.Printf("%s: input=%v output=%v per %d tokens (x%v)\n", model.ID, in, out, batch, multiplier) +} +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(); + +var list = await client.Rpc.Models.ListAsync(); + +foreach (var model in list.Models) +{ + var prices = model.Billing?.TokenPrices; + if (prices is null) continue; + Console.WriteLine( + $"{model.Id}: input={prices.InputPrice} output={prices.OutputPrice} " + + $"per {prices.BatchSize} tokens (x{model.Billing?.Multiplier ?? 1})"); +} +``` + + +```csharp +var list = await client.Rpc.Models.ListAsync(); + +foreach (var model in list.Models) +{ + var prices = model.Billing?.TokenPrices; + if (prices is null) continue; + Console.WriteLine( + $"{model.Id}: input={prices.InputPrice} output={prices.OutputPrice} " + + $"per {prices.BatchSize} tokens (x{model.Billing?.Multiplier ?? 1})"); +} +``` + +
+ +
+Java + + +```java +var list = client.getRpc().models.list().join(); + +for (var model : list.models()) { + var billing = model.billing(); + if (billing == null || billing.tokenPrices() == null) { + continue; + } + var prices = billing.tokenPrices(); + double multiplier = billing.multiplier() != null ? billing.multiplier() : 1; + System.out.printf("%s: input=%s output=%s per %d tokens (x%s)%n", + model.id(), prices.inputPrice(), prices.outputPrice(), prices.batchSize(), multiplier); +} +``` + +
+ +
+Rust + +```rust +let list = client.rpc().models().list().await?; + +for model in &list.models { + let Some(billing) = &model.billing else { continue }; + let Some(prices) = &billing.token_prices else { continue }; + let multiplier = billing.multiplier.unwrap_or(1.0); + println!( + "{}: input={} output={} per {} tokens (x{multiplier})", + model.id, + prices.input_price.unwrap_or(0.0), + prices.output_price.unwrap_or(0.0), + prices.batch_size.unwrap_or(0), + ); +} +``` + +
+ +## Account quota and premium interactions + +`account.getQuota` reports the authenticated user's remaining Copilot entitlement. The result's `quotaSnapshots` map is keyed by quota type—commonly `premium_interactions`, `chat`, and `completions`. Use it to show users how much of their monthly allowance is left, or to gate work before they hit a limit. + +The example uses the fields below; the generated `AccountQuotaSnapshot` type is the full reference. The `quotaSnapshots` keys are runtime strings that the SDK type system does not validate, so guard your lookups. + +| Field | Type | Description | +|---|---|---| +| `entitlementRequests` | `number` | Requests included in the entitlement, or `-1` for unlimited | +| `usedRequests` | `number` | Requests used so far this period | +| `remainingPercentage` | `number` | Percentage of the entitlement remaining | +| `resetDate` | `string` | ISO 8601 date when the quota resets | + +> [!TIP] +> To read quota for a specific user rather than the connection's global auth context (for example, in a multi-tenant backend), pass that user's GitHub token to `getQuota`. See [Multi-tenancy](../setup/multi-tenancy.md). + +
+Node.js / TypeScript + + +```typescript +import { CopilotClient } from "@github/copilot-sdk"; + +const client = new CopilotClient(); + +const { quotaSnapshots } = await client.rpc.account.getQuota({}); +const premium = quotaSnapshots["premium_interactions"]; + +if (premium) { + console.log( + `Premium interactions: ${premium.usedRequests}/${premium.entitlementRequests} ` + + `(${premium.remainingPercentage.toFixed(1)}% left, resets ${premium.resetDate ?? "n/a"})`, + ); +} +``` + + +```typescript +const { quotaSnapshots } = await client.rpc.account.getQuota({}); +const premium = quotaSnapshots["premium_interactions"]; + +if (premium) { + console.log( + `Premium interactions: ${premium.usedRequests}/${premium.entitlementRequests} ` + + `(${premium.remainingPercentage.toFixed(1)}% left, resets ${premium.resetDate ?? "n/a"})`, + ); +} +``` + +
+ +
+Python + + +```python +from copilot import CopilotClient +from copilot.rpc import AccountGetQuotaRequest + +client = CopilotClient() + +result = await client.rpc.account.get_quota(AccountGetQuotaRequest()) +premium = result.quota_snapshots.get("premium_interactions") + +if premium is not None: + print( + f"Premium interactions: {premium.used_requests}/{premium.entitlement_requests} " + f"({premium.remaining_percentage:.1f}% left, resets {premium.reset_date or 'n/a'})" + ) +``` + + +```python +result = await client.rpc.account.get_quota(AccountGetQuotaRequest()) +premium = result.quota_snapshots.get("premium_interactions") + +if premium is not None: + print( + f"Premium interactions: {premium.used_requests}/{premium.entitlement_requests} " + f"({premium.remaining_percentage:.1f}% left, resets {premium.reset_date or 'n/a'})" + ) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func main() { + ctx := context.Background() + client := copilot.NewClient(nil) + client.Start(ctx) + + result, _ := client.RPC.Account.GetQuota(ctx, &rpc.AccountGetQuotaRequest{}) + + if premium, ok := result.QuotaSnapshots["premium_interactions"]; ok { + resets := "n/a" + if premium.ResetDate != nil { + resets = premium.ResetDate.Format(time.RFC3339) + } + fmt.Printf("Premium interactions: %d/%d (%.1f%% left, resets %s)\n", + premium.UsedRequests, premium.EntitlementRequests, premium.RemainingPercentage, resets) + } +} +``` + + +```go +result, _ := client.RPC.Account.GetQuota(ctx, &rpc.AccountGetQuotaRequest{}) + +if premium, ok := result.QuotaSnapshots["premium_interactions"]; ok { + resets := "n/a" + if premium.ResetDate != nil { + resets = premium.ResetDate.Format(time.RFC3339) + } + fmt.Printf("Premium interactions: %d/%d (%.1f%% left, resets %s)\n", + premium.UsedRequests, premium.EntitlementRequests, premium.RemainingPercentage, resets) +} +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +await using var client = new CopilotClient(); + +var result = await client.Rpc.Account.GetQuotaAsync(); + +if (result.QuotaSnapshots.TryGetValue("premium_interactions", out var premium)) +{ + Console.WriteLine( + $"Premium interactions: {premium.UsedRequests}/{premium.EntitlementRequests} " + + $"({premium.RemainingPercentage:F1}% left, resets {premium.ResetDate?.ToString("o") ?? "n/a"})"); +} +``` + + +```csharp +var result = await client.Rpc.Account.GetQuotaAsync(); + +if (result.QuotaSnapshots.TryGetValue("premium_interactions", out var premium)) +{ + Console.WriteLine( + $"Premium interactions: {premium.UsedRequests}/{premium.EntitlementRequests} " + + $"({premium.RemainingPercentage:F1}% left, resets {premium.ResetDate?.ToString("o") ?? "n/a"})"); +} +``` + +
+ +
+Java + + +```java +var result = client.getRpc().account.getQuota().join(); +var premium = result.quotaSnapshots().get("premium_interactions"); + +if (premium != null) { + System.out.printf("Premium interactions: %d/%d (%.1f%% left, resets %s)%n", + premium.usedRequests(), premium.entitlementRequests(), + premium.remainingPercentage(), premium.resetDate()); +} +``` + +
+ +
+Rust + +```rust +let result = client.rpc().account().get_quota().await?; + +if let Some(premium) = result.quota_snapshots.get("premium_interactions") { + let resets = premium.reset_date.as_deref().unwrap_or("n/a"); + println!( + "Premium interactions: {}/{} ({:.1}% left, resets {resets})", + premium.used_requests, premium.entitlement_requests, premium.remaining_percentage, + ); +} +``` + +
+ +## Choosing the right API + +Use this summary to decide which API fits your use case: + +* **Render a live cost or token meter as a turn runs**: subscribe to `assistant.usage` and `session.usage_info`. +* **Show a final cost summary after a turn or session**: call `session.usage.getMetrics`. +* **Display context-window usage on resume, before any new turn**: call `session.metadata.contextInfo`. +* **Estimate cost before running work**: read `models.list` token prices. +* **Warn users before they exhaust their plan**: call `account.getQuota`. + +## Further reading + +* [Streaming events](./streaming-events.md): full field-level reference for `assistant.usage`, `session.usage_info`, and every other session event +* [Observability](../observability/README.md): export usage data to OpenTelemetry for cost attribution +* [Multi-tenancy](../setup/multi-tenancy.md): resolve per-user quota and models with a GitHub token diff --git a/docs/getting-started.md b/docs/getting-started.md index 80c9541e4..53b6497fd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -18,7 +18,7 @@ Copilot: In Tokyo it's 75°F and sunny. Great day to be outside! Before you begin, make sure you have: -* **GitHub Copilot CLI** installed and authenticated ([Installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli)) +* **GitHub Copilot CLI** installed and authenticated (the Node.js, Python, and .NET SDKs provide the CLI automatically—see [Bundled CLI](./setup/bundled-cli.md). Required for Go, Java, and Rust unless using their application-level CLI bundling features.) * Your preferred language runtime: * **Node.js** 20+ or **Python** 3.11+ or **Go** 1.24+ or **Rust** 1.94+ or **Java** 17+ or **.NET** 8.0+ @@ -150,7 +150,7 @@ Create `index.ts`: import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); -const session = await client.createSession({ model: "gpt-4.1" }); +const session = await client.createSession({ model: "auto" }); const response = await session.sendAndWait({ prompt: "What is 2 + 2?" }); console.log(response?.data.content); @@ -181,7 +181,7 @@ async def main(): client = CopilotClient() await client.start() - session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1") + session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="auto") response = await session.send_and_wait("What is 2 + 2?") print(response.data.content) @@ -223,7 +223,7 @@ func main() { } defer client.Stop() - session, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"}) + session, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "auto"}) if err != nil { log.Fatal(err) } @@ -264,7 +264,7 @@ use github_copilot_sdk::{Client, ClientOptions, MessageOptions, SessionConfig}; async fn main() -> Result<(), Box> { let client = Client::start(ClientOptions::default()).await?; let session = client - .create_session(SessionConfig::default().with_handler(Arc::new(ApproveAllHandler))) + .create_session(SessionConfig::default().with_permission_handler(Arc::new(ApproveAllHandler))) .await?; let response = session @@ -304,7 +304,7 @@ using GitHub.Copilot; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "auto", OnPermissionRequest = PermissionHandler.ApproveAll }); @@ -337,7 +337,7 @@ public class HelloCopilot { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("auto") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -383,7 +383,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "auto", streaming: true, }); @@ -413,13 +413,13 @@ import asyncio import sys from copilot import CopilotClient from copilot.session import PermissionHandler -from copilot.generated.session_events import SessionEventType +from copilot.session_events import SessionEventType async def main(): client = CopilotClient() await client.start() - session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1", streaming=True) + session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="auto", streaming=True) # Listen for response chunks def handle_event(event): @@ -466,7 +466,7 @@ func main() { defer client.Stop() session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "auto", Streaming: copilot.Bool(true), }) if err != nil { @@ -514,7 +514,7 @@ async fn main() -> Result<(), Box> { let mut config = SessionConfig::default(); config.streaming = Some(true); let session = client - .create_session(config.with_handler(Arc::new(ApproveAllHandler))) + .create_session(config.with_permission_handler(Arc::new(ApproveAllHandler))) .await?; // Listen for response chunks @@ -562,7 +562,7 @@ using GitHub.Copilot; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "auto", OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = true, }); @@ -602,7 +602,7 @@ public class HelloCopilot { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("auto") .setStreaming(true) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -666,7 +666,7 @@ unsubscribeIdle(); ```python from copilot import CopilotClient, PermissionDecisionApproveOnce -from copilot.generated.session_events import SessionEvent, SessionEventType +from copilot.session_events import SessionEvent, SessionEventType client = CopilotClient() @@ -912,7 +912,7 @@ const getWeather = defineTool("get_weather", { const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "auto", streaming: true, tools: [getWeather], }); @@ -947,7 +947,7 @@ import sys from copilot import CopilotClient from copilot.session import PermissionHandler from copilot.tools import define_tool -from copilot.generated.session_events import SessionEventType +from copilot.session_events import SessionEventType from pydantic import BaseModel, Field # Define the parameters for the tool using Pydantic @@ -968,7 +968,7 @@ async def main(): client = CopilotClient() await client.start() - session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1", streaming=True, tools=[get_weather]) + session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="auto", streaming=True, tools=[get_weather]) def handle_event(event): if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA: @@ -1045,7 +1045,7 @@ func main() { defer client.Stop() session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "auto", Streaming: copilot.Bool(true), Tools: []copilot.Tool{getWeather}, }) @@ -1086,7 +1086,7 @@ use std::sync::Arc; use std::time::Duration; use github_copilot_sdk::handler::ApproveAllHandler; -use github_copilot_sdk::tool::{JsonSchema, ToolHandlerRouter, define_tool}; +use github_copilot_sdk::tool::{define_tool, JsonSchema}; use github_copilot_sdk::{Client, ClientOptions, MessageOptions, SessionConfig, ToolResult}; use serde::Deserialize; @@ -1098,27 +1098,28 @@ struct GetWeatherParams { #[tokio::main] async fn main() -> Result<(), Box> { // Define a tool that Copilot can call - let router = ToolHandlerRouter::new( - vec![define_tool( - "get_weather", - "Get the current weather for a city", - |_inv, params: GetWeatherParams| async move { - Ok(ToolResult::Text(format!( - "{}: 62°F and sunny", - params.city - ))) - }, - )], - Arc::new(ApproveAllHandler), - ); - let tools = router.tools(); + let tools = vec![define_tool( + "get_weather", + "Get the current weather for a city", + |_inv, params: GetWeatherParams| async move { + Ok(ToolResult::Text(format!( + "{}: 62°F and sunny", + params.city + ))) + }, + )]; let client = Client::start(ClientOptions::default()).await?; let mut config = SessionConfig::default(); config.streaming = Some(true); - config.tools = Some(tools); - let session = client.create_session(config.with_handler(Arc::new(router))).await?; + let session = client + .create_session( + config + .with_tools(tools) + .with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await?; let mut events = session.subscribe(); tokio::spawn(async move { @@ -1184,7 +1185,7 @@ var getWeather = CopilotTool.DefineTool( await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "auto", OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = true, Tools = [getWeather], @@ -1258,7 +1259,7 @@ public class HelloCopilot { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("auto") .setStreaming(true) .setTools(List.of(getWeather)) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) @@ -1315,7 +1316,7 @@ const getWeather = defineTool("get_weather", { const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "auto", streaming: true, tools: [getWeather], }); @@ -1370,7 +1371,7 @@ import sys from copilot import CopilotClient from copilot.session import PermissionHandler from copilot.tools import define_tool -from copilot.generated.session_events import SessionEventType +from copilot.session_events import SessionEventType from pydantic import BaseModel, Field class GetWeatherParams(BaseModel): @@ -1388,7 +1389,7 @@ async def main(): client = CopilotClient() await client.start() - session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1", streaming=True, tools=[get_weather]) + session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="auto", streaming=True, tools=[get_weather]) def handle_event(event): if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA: @@ -1481,7 +1482,7 @@ func main() { defer client.Stop() session, err := client.CreateSession(ctx, &copilot.SessionConfig{ - Model: "gpt-4.1", + Model: "auto", Streaming: copilot.Bool(true), Tools: []copilot.Tool{getWeather}, }) @@ -1546,7 +1547,7 @@ use std::sync::Arc; use std::time::Duration; use github_copilot_sdk::handler::ApproveAllHandler; -use github_copilot_sdk::tool::{JsonSchema, ToolHandlerRouter, define_tool}; +use github_copilot_sdk::tool::{define_tool, JsonSchema}; use github_copilot_sdk::{Client, ClientOptions, MessageOptions, SessionConfig, ToolResult}; use serde::Deserialize; @@ -1567,27 +1568,28 @@ fn read_line() -> Option { #[tokio::main] async fn main() -> Result<(), Box> { - let router = ToolHandlerRouter::new( - vec![define_tool( - "get_weather", - "Get the current weather for a city", - |_inv, params: GetWeatherParams| async move { - Ok(ToolResult::Text(format!( - "{}: 62°F and sunny", - params.city - ))) - }, - )], - Arc::new(ApproveAllHandler), - ); - let tools = router.tools(); + let tools = vec![define_tool( + "get_weather", + "Get the current weather for a city", + |_inv, params: GetWeatherParams| async move { + Ok(ToolResult::Text(format!( + "{}: 62°F and sunny", + params.city + ))) + }, + )]; let client = Client::start(ClientOptions::default()).await?; let mut config = SessionConfig::default(); config.streaming = Some(true); - config.tools = Some(tools); - let session = client.create_session(config.with_handler(Arc::new(router))).await?; + let session = client + .create_session( + config + .with_tools(tools) + .with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await?; let mut events = session.subscribe(); tokio::spawn(async move { @@ -1669,7 +1671,7 @@ var getWeather = CopilotTool.DefineTool( await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { - Model = "gpt-4.1", + Model = "auto", OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = true, Tools = [getWeather] @@ -1763,7 +1765,7 @@ public class WeatherAssistant { var session = client.createSession( new SessionConfig() - .setModel("gpt-4.1") + .setModel("auto") .setStreaming(true) .setOnPermissionRequest(request -> CompletableFuture.completedFuture(PermissionDecision.allow()) @@ -1909,9 +1911,11 @@ const session = await client.createSession({ }); ``` -Available section IDs: `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `runtime_instructions`, `last_instructions`. +Available section IDs: `preamble`, `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `runtime_instructions`, `last_instructions`. -Each 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. +`identity` and `tool_instructions` are section *groups*: they target a collection of related sub-sections as a unit. Use `preamble` to target just the identity preamble without affecting its sibling sub-sections. + +Each override supports five actions: `replace`, `remove`, `append`, `prepend`, and `preserve`. The `preserve` action is a no-op that opts an individually-addressable section out of a group-level `remove` (for example, keep `tone` when removing the `identity` group). Unknown section IDs are handled gracefully: content from `replace`/`append`/`prepend` overrides is appended to additional instructions, and `remove` overrides are silently ignored. See the language-specific SDK READMEs for examples in [TypeScript](../nodejs/README.md), [Python](../python/README.md), [Go](../go/README.md), [Rust](../rust/README.md), [Java](../java/README.md), and [C#](../dotnet/README.md). @@ -1998,9 +2002,9 @@ import ( func main() { ctx := context.Background() - client := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:4321"}, - }) + client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.URIConnection{URL: "localhost:4321"}, + }) if err := client.Start(ctx); err != nil { log.Fatal(err) @@ -2019,7 +2023,7 @@ func main() { import copilot "github.com/github/copilot-sdk/go" client := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:4321"}, + Connection: copilot.URIConnection{URL: "localhost:4321"}, }) if err := client.Start(ctx); err != nil { @@ -2049,12 +2053,13 @@ let mut options = ClientOptions::default(); options.transport = Transport::External { host: "localhost".to_string(), port: 4321, + connection_token: None, }; let client = Client::start(options).await?; // Use the client normally let session = client - .create_session(SessionConfig::default().with_handler(Arc::new(ApproveAllHandler))) + .create_session(SessionConfig::default().with_permission_handler(Arc::new(ApproveAllHandler))) .await?; // ... ``` @@ -2103,7 +2108,7 @@ var session = client.createSession(
-**Note:** When `cli_url` / `cliUrl` / Go's `UriConnection` is provided, or Rust uses `Transport::External`, the SDK will not spawn or manage a CLI process - it will only connect to the existing server at the specified URL. +**Note:** When `cli_url` / `cliUrl` / Go's `URIConnection` is provided, or Rust uses `Transport::External`, the SDK will not spawn or manage a CLI process - it will only connect to the existing server at the specified URL. ## Telemetry and observability @@ -2154,7 +2159,7 @@ Install with telemetry extras: `pip install copilot-sdk[telemetry]` (provides `o ```go -client, err := copilot.NewClient(copilot.ClientOptions{ +client := copilot.NewClient(&copilot.ClientOptions{ Telemetry: &copilot.TelemetryConfig{ OTLPEndpoint: "http://localhost:4318", }, @@ -2225,11 +2230,14 @@ Dependency: `io.opentelemetry:opentelemetry-api` | Option | Node.js | Python | Go | Rust | Java | .NET | Description | |---|---|---|---|---|---|---|---| | OTLP endpoint | `otlpEndpoint` | `otlp_endpoint` | `OTLPEndpoint` | `otlp_endpoint` | `otlpEndpoint` | `OtlpEndpoint` | OTLP HTTP endpoint URL | +| OTLP protocol | `otlpProtocol` | `otlp_protocol` | `OTLPProtocol` | `otlp_protocol` | `otlpProtocol` | `OtlpProtocol` | OTLP HTTP protocol for all signals: `"http/json"` or `"http/protobuf"` | | File path | `filePath` | `file_path` | `FilePath` | `file_path` | `filePath` | `FilePath` | File path for JSON-lines trace output | | Exporter type | `exporterType` | `exporter_type` | `ExporterType` | `exporter_type` | `exporterType` | `ExporterType` | `"otlp-http"` or `"file"` | | Source name | `sourceName` | `source_name` | `SourceName` | `source_name` | `sourceName` | `SourceName` | Instrumentation scope name | | Capture content | `captureContent` | `capture_content` | `CaptureContent` | `capture_content` | `captureContent` | `CaptureContent` | Whether to capture message content | +The OTLP protocol field configures the CLI's `"otlp-http"` exporter for all signals. Leave it unset to use the CLI default, or set it to `"http/protobuf"` to export protobuf over HTTP. + ### File export To write traces to a local file instead of an OTLP endpoint: @@ -2256,7 +2264,7 @@ Trace context is propagated automatically—no manual instrumentation is needed: ## Learn more * [Authentication Guide](./auth/authenticate.md) - GitHub OAuth, environment variables, and BYOK -* [BYOK (Bring Your Own Key)](./auth/byok.md) - Use your own API keys from Azure AI Foundry, OpenAI, etc. +* [BYOK (Bring Your Own Key)](./auth/byok.md) - Use your own API keys from Microsoft Foundry, OpenAI, etc. * [Node.js SDK Reference](../nodejs/README.md) * [Python SDK Reference](../python/README.md) * [Go SDK Reference](../go/README.md) diff --git a/docs/hooks/README.md b/docs/hooks/README.md new file mode 100644 index 000000000..a6c7e1aa6 --- /dev/null +++ b/docs/hooks/README.md @@ -0,0 +1,11 @@ +# Use hooks + +Detailed API reference for each session hook in the GitHub Copilot SDK. + +* [Hooks overview](./hooks-overview.md): quick start, common patterns, and hook invocation context +* [Pre-tool use](./pre-tool-use.md): approve, deny, or modify tool calls +* [Post-tool use](./post-tool-use.md): transform tool results +* [User prompt submitted](./user-prompt-submitted.md): modify or filter user messages +* [User prompt transformed](./user-prompt-transformed.md): inspect or replace model-facing prompts +* [Session lifecycle](./session-lifecycle.md): session start and end +* [Error handling](./error-handling.md): custom error handling diff --git a/docs/hooks/error-handling.md b/docs/hooks/error-handling.md index 471c9c426..e235b2ae5 100644 --- a/docs/hooks/error-handling.md +++ b/docs/hooks/error-handling.md @@ -514,6 +514,6 @@ const session = await client.createSession({ ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Session Lifecycle Hooks](./session-lifecycle.md) * [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file diff --git a/docs/hooks/hooks-overview.md b/docs/hooks/hooks-overview.md index ad9a2eb52..8d5583e99 100644 --- a/docs/hooks/hooks-overview.md +++ b/docs/hooks/hooks-overview.md @@ -16,9 +16,11 @@ Hooks allow you to intercept and customize the behavior of Copilot sessions at k | [`onPostToolUse`](./post-tool-use.md) | After a tool executes (success only) | Result transformation, logging | | [`onPostToolUseFailure`](./post-tool-use.md#failure-variant) | After a tool execution whose result was a failure | Inject retry guidance, log failures | | [`onUserPromptSubmitted`](./user-prompt-submitted.md) | When user sends a message | Prompt modification, filtering | +| [`onUserPromptTransformed`](./user-prompt-transformed.md) | After runtime prompt transformation | Inspect or replace model-facing content | | [`onSessionStart`](./session-lifecycle.md#session-start) | Session begins | Add context, configure session | | [`onSessionEnd`](./session-lifecycle.md#session-end) | Session ends | Cleanup, analytics | | [`onErrorOccurred`](./error-handling.md) | Error happens | Custom error handling | +| [`onAgentStop`](./session-lifecycle.md#agent-stop) | Top-level agent naturally stops | Validate completion or request another turn | ## Quick start @@ -262,7 +264,9 @@ const session = await client.createSession({ * **[Pre-Tool Use Hook](./pre-tool-use.md)** - Control tool execution permissions * **[Post-Tool Use Hook](./post-tool-use.md)** - Transform tool results * **[User Prompt Submitted Hook](./user-prompt-submitted.md)** - Modify user prompts +* **[User Prompt Transformed Hook](./user-prompt-transformed.md)** - Replace model-facing prompts * **[Session Lifecycle Hooks](./session-lifecycle.md)** - Session start and end +* **[Agent Stop Hook](./session-lifecycle.md#agent-stop)** - Validate completion before the agent stops * **[Error Handling Hook](./error-handling.md)** - Custom error handling ## See also diff --git a/docs/hooks/index.md b/docs/hooks/index.md deleted file mode 100644 index 517be9614..000000000 --- a/docs/hooks/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Use hooks - -Detailed API reference for each session hook in the GitHub Copilot SDK. - -* [Hooks overview](./hooks-overview.md): quick start, common patterns, and hook invocation context -* [Pre-tool use](./pre-tool-use.md): approve, deny, or modify tool calls -* [Post-tool use](./post-tool-use.md): transform tool results -* [User prompt submitted](./user-prompt-submitted.md): modify or filter user messages -* [Session lifecycle](./session-lifecycle.md): session start and end -* [Error handling](./error-handling.md): custom error handling diff --git a/docs/hooks/post-tool-use.md b/docs/hooks/post-tool-use.md index 86473c0a2..b7ef3af1c 100644 --- a/docs/hooks/post-tool-use.md +++ b/docs/hooks/post-tool-use.md @@ -2,10 +2,10 @@ The `onPostToolUse` hook is called **after** a tool executes **successfully**. Use it to: -- Transform or filter tool results -- Log tool execution for auditing -- Add context based on results -- Suppress results from the conversation +* Transform or filter tool results +* Log tool execution for auditing +* Add context based on results +* Suppress results from the conversation > **Failure variant** — `onPostToolUse` only fires for successful tool executions. To observe **failed** tool calls, register `onPostToolUseFailure` (`on_post_tool_use_failure` in Python, `OnPostToolUseFailure` in Go/.NET, `on_post_tool_use_failure` in Rust). The handler receives `{ sessionId, toolName, toolArgs, error, timestamp, workingDirectory }` — the `error` field is a string extracted from the tool's failure result — and may return `{ additionalContext: string }` to inject extra guidance for the model (e.g. retry hints). See the [hooks overview](./hooks-overview.md) for the full list. > @@ -507,6 +507,6 @@ const session = await client.createSession({ ## See also -- [Hooks Overview](./index.md) -- [Pre-Tool Use Hook](./pre-tool-use.md) -- [Error Handling Hook](./error-handling.md) \ No newline at end of file +* [Hooks Overview](./README.md) +* [Pre-Tool Use Hook](./pre-tool-use.md) +* [Error Handling Hook](./error-handling.md) \ No newline at end of file diff --git a/docs/hooks/pre-tool-use.md b/docs/hooks/pre-tool-use.md index fe373cc2f..4abe2a052 100644 --- a/docs/hooks/pre-tool-use.md +++ b/docs/hooks/pre-tool-use.md @@ -154,6 +154,23 @@ Return `null` or `undefined` to allow the tool to execute with no changes. Other | `"deny"` | Tool is blocked, reason shown to user | | `"ask"` | User is prompted to approve (interactive mode) | +### Skipping permission prompts for trusted custom tools + +If you define a custom tool that is safe to run without prompting, set `skipPermission: true` on the tool definition. Use this for trusted, app-owned tools whose inputs are already constrained by your application; use `onPreToolUse` when you need per-call policy checks or argument validation. + +```typescript +const getWeather = defineTool("get_weather", { + description: "Get weather for a location.", + parameters: { + type: "object", + properties: { location: { type: "string" } }, + required: ["location"], + }, + skipPermission: true, + handler: async ({ location }) => ({ forecast: `Sunny in ${location}` }), +}); +``` + ## Examples ### Allow all tools (logging only) @@ -437,6 +454,6 @@ const session = await client.createSession({ ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Post-Tool Use Hook](./post-tool-use.md) * [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file diff --git a/docs/hooks/session-lifecycle.md b/docs/hooks/session-lifecycle.md index aed71132e..485752601 100644 --- a/docs/hooks/session-lifecycle.md +++ b/docs/hooks/session-lifecycle.md @@ -540,6 +540,42 @@ Session Summary: }); ``` +## Agent stop hook {#agent-stop} + +The agent stop hook runs when the top-level agent naturally reaches the end of a turn. It is separate from `onSessionEnd`: the session remains active, and the hook can request another agent turn. + +| Language | Handler | +|----------|---------| +| Node.js / TypeScript | `onAgentStop` | +| Python | `on_agent_stop` | +| Go | `OnAgentStop` | +| .NET | `OnAgentStop` | +| Rust | `on_agent_stop` | +| Java | `setOnAgentStop` | + +### Input + +The public member names follow each language's casing conventions: + +| Meaning | Node.js / Python | Go / .NET | Rust | Java | +|---------|------------------|-----------|------|------| +| Why the agent stopped, such as `end_turn` | `stopReason` | `StopReason` | `stop_reason` | `getStopReason()` | +| Path to the on-disk session transcript | `transcriptPath` | `TranscriptPath` | `transcript_path` | `getTranscriptPath()` | +| Whether an earlier block decision already forced this continuation | `stopHookActive` | `StopHookActive` | `stop_hook_active` | `getStopHookActive()` | + +### Output + +Return no output to let the agent stop. Return a block decision to enqueue another user message and continue: + +```json +{ + "decision": "block", + "reason": "Run the final validation and fix any failures." +} +``` + +Use the active-stop member listed above to avoid repeatedly blocking an agent that has already continued because of this hook. The runtime also caps consecutive block decisions. + ## Best practices 1. **Keep `onSessionStart` fast** - Users are waiting for the session to be ready. @@ -554,6 +590,6 @@ Session Summary: ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Error Handling Hook](./error-handling.md) * [Debugging Guide](../troubleshooting/debugging.md) diff --git a/docs/hooks/user-prompt-submitted.md b/docs/hooks/user-prompt-submitted.md index edb6c7a3f..230afca96 100644 --- a/docs/hooks/user-prompt-submitted.md +++ b/docs/hooks/user-prompt-submitted.md @@ -415,11 +415,11 @@ const session = await client.createSession({ }); ``` -### Rate limiting +### Usage threshold notices ```typescript const promptTimestamps: number[] = []; -const RATE_LIMIT = 10; // prompts +const NOTICE_THRESHOLD = 10; // prompts const RATE_WINDOW = 60000; // 1 minute const session = await client.createSession({ @@ -431,15 +431,16 @@ const session = await client.createSession({ while (promptTimestamps.length > 0 && promptTimestamps[0] < now - RATE_WINDOW) { promptTimestamps.shift(); } - - if (promptTimestamps.length >= RATE_LIMIT) { + + promptTimestamps.push(now); + if (promptTimestamps.length >= NOTICE_THRESHOLD) { + // This is advisory context for the model, not an enforced rate limit. + // Enforce hard limits before calling session.send(). return { - reject: true, - rejectReason: `Rate limit exceeded. Please wait before sending more prompts.`, + additionalContext: `The user has sent ${promptTimestamps.length} prompts in the last minute. Suggest waiting before sending more.`, }; } - - promptTimestamps.push(now); + return null; }, }, @@ -490,12 +491,12 @@ const session = await client.createSession({ 1. **Use `additionalContext` over `modifiedPrompt`** - Adding context is less intrusive than rewriting the prompt. -1. **Provide clear rejection reasons** - When rejecting prompts, explain why and how to fix it. +1. **Use `additionalContext` for advisory guidance**: This hook cannot reject a prompt or enforce policy. Enforce hard limits before calling `session.send()`. 1. **Keep processing fast** - This hook runs on every user message. Avoid slow operations. ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Session Lifecycle Hooks](./session-lifecycle.md) * [Pre-Tool Use Hook](./pre-tool-use.md) \ No newline at end of file diff --git a/docs/hooks/user-prompt-transformed.md b/docs/hooks/user-prompt-transformed.md new file mode 100644 index 000000000..f7791d78b --- /dev/null +++ b/docs/hooks/user-prompt-transformed.md @@ -0,0 +1,129 @@ +# User prompt transformed hook + +The `userPromptTransformed` hook runs after the runtime adds generated context to a submitted prompt, but before the resulting content is persisted to session history or sent to the model. + +Use it when you need to inspect or replace the exact model-facing prompt. The `prompt` input contains the user prompt after any `userPromptSubmitted` hooks have run, while `transformedPrompt` also contains runtime-generated context such as ``. + +## Input and output + +| Input field | Type | Description | +| --- | --- | --- | +| `sessionId` | string | Runtime session ID | +| `timestamp` | date/time | Time the hook was invoked | +| `cwd` / `workingDirectory` | string | Current working directory | +| `prompt` | string | Prompt after `userPromptSubmitted` hooks | +| `transformedPrompt` | string | Model-facing prompt after runtime transformations | + +Return no value to leave the transformed prompt unchanged. Return `modifiedTransformedPrompt` to replace the content that is stored in session history and sent to the model. + +## Examples + +
+TypeScript + + +```typescript +const session = await client.createSession({ + hooks: { + onUserPromptTransformed: async (input) => ({ + modifiedTransformedPrompt: redact(input.transformedPrompt), + }), + }, +}); +``` + +
+ +
+Python + + +```python +session = await client.create_session( + hooks={ + "on_user_prompt_transformed": lambda input_data, invocation: { + "modifiedTransformedPrompt": redact(input_data["transformedPrompt"]) + } + } +) +``` + +
+ +
+Go + + +```go +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + Hooks: &copilot.SessionHooks{ + OnUserPromptTransformed: func(input copilot.UserPromptTransformedHookInput, invocation copilot.HookInvocation) (*copilot.UserPromptTransformedHookOutput, error) { + return &copilot.UserPromptTransformedHookOutput{ + ModifiedTransformedPrompt: copilot.String(redact(input.TransformedPrompt)), + }, nil + }, + }, +}) +``` + +
+ +
+.NET + + +```csharp +var session = await client.CreateSessionAsync(new SessionConfig +{ + Hooks = new SessionHooks + { + OnUserPromptTransformed = (input, invocation) => + Task.FromResult(new() + { + ModifiedTransformedPrompt = Redact(input.TransformedPrompt), + }), + }, +}); +``` + +
+ +
+Java + + +```java +var hooks = new SessionHooks().setOnUserPromptTransformed((input, invocation) -> + CompletableFuture.completedFuture( + new UserPromptTransformedHookOutput(redact(input.transformedPrompt())))); + +var session = client.createSession(new SessionConfig().setHooks(hooks)).get(); +``` + +
+ +
+Rust + +```rust +#[async_trait] +impl SessionHooks for MyHooks { + async fn on_user_prompt_transformed( + &self, + input: UserPromptTransformedInput, + _ctx: HookContext, + ) -> Option { + Some(UserPromptTransformedOutput { + modified_transformed_prompt: Some(redact(&input.transformed_prompt)), + }) + } +} + +let session = client + .create_session(SessionConfig::default().with_hooks(Arc::new(MyHooks))) + .await?; +``` + +
+ +The replacement is persisted as the user message content, so resumed sessions replay the modified content unchanged. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 059b54b12..000000000 --- a/docs/index.md +++ /dev/null @@ -1,77 +0,0 @@ -# Copilot SDK - -Welcome 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. - -## Where to start - -| I want to... | Go to | -|---|---| -| **Build my first app** | [Getting Started](./getting-started.md)—end-to-end tutorial with streaming & custom tools | -| **Set up for production** | [Setup Guides](./setup/index.md)—architecture, deployment patterns, scaling | -| **Configure authentication** | [Authentication](./auth/index.md)—GitHub OAuth, environment variables, BYOK | -| **Add features to my app** | [Features](./features/index.md)—hooks, custom agents, MCP, skills, and more | -| **Debug an issue** | [Troubleshooting](./troubleshooting/debugging.md)—common problems and solutions | - -## Documentation map - -### [Getting Started](./getting-started.md) - -Step-by-step tutorial that takes you from zero to a working Copilot app with streaming responses and custom tools. - -### [Setup](./setup/index.md) - -How to configure and deploy the SDK for your use case. - -* [Default Setup (Bundled CLI)](./setup/bundled-cli.md): the SDK includes the CLI automatically -* [Local CLI](./setup/local-cli.md): use your own CLI binary or running instance -* [Backend Services](./setup/backend-services.md): server-side with headless CLI over TCP -* [GitHub OAuth](./setup/github-oauth.md): implement the OAuth flow -* [Azure Managed Identity](./setup/azure-managed-identity.md): BYOK with Azure AI Foundry -* [Scaling & Multi-Tenancy](./setup/scaling.md): horizontal scaling, isolation patterns - -### [Authentication](./auth/index.md) - -Configuring how users and services authenticate with Copilot. - -* [Authentication Overview](./auth/index.md): methods, priority order, and examples -* [Bring Your Own Key (BYOK)](./auth/byok.md): use your own API keys from OpenAI, Azure, Anthropic, and more - -### [Features](./features/index.md) - -Guides for building with the SDK's capabilities. - -* [Hooks](./features/hooks.md): intercept and customize session behavior -* [Custom Agents](./features/custom-agents.md): define specialized sub-agents -* [MCP Servers](./features/mcp.md): integrate Model Context Protocol servers -* [Skills](./features/skills.md): load reusable prompt modules -* [Image Input](./features/image-input.md): send images as attachments -* [Streaming Events](./features/streaming-events.md): real-time event reference -* [Steering & Queueing](./features/steering-and-queueing.md): message delivery modes -* [Session Persistence](./features/session-persistence.md): resume sessions across restarts -* [Remote Sessions](./features/remote-sessions.md): share sessions to GitHub web and mobile - -### [Hooks Reference](./hooks/index.md) - -Detailed API reference for each session hook. - -* [Pre-Tool Use](./hooks/pre-tool-use.md): approve, deny, or modify tool calls -* [Post-Tool Use](./hooks/post-tool-use.md): transform tool results -* [User Prompt Submitted](./hooks/user-prompt-submitted.md): modify or filter user messages -* [Session Lifecycle](./hooks/session-lifecycle.md): session start and end -* [Error Handling](./hooks/error-handling.md): custom error handling - -### [Troubleshooting](./troubleshooting/debugging.md) - -* [Debugging Guide](./troubleshooting/debugging.md): common issues and solutions -* [MCP Debugging](./troubleshooting/mcp-debugging.md): MCP-specific troubleshooting -* [Compatibility](./troubleshooting/compatibility.md): SDK vs CLI feature matrix - -### [Observability](./observability/opentelemetry.md) - -* [OpenTelemetry Instrumentation](./observability/opentelemetry.md): built-in TelemetryConfig and trace context propagation - -### [Integrations](./integrations/microsoft-agent-framework.md) - -Guides for using the SDK with other platforms and frameworks. - -* [Microsoft Agent Framework](./integrations/microsoft-agent-framework.md): MAF multi-agent workflows diff --git a/docs/integrations/index.md b/docs/integrations/README.md similarity index 100% rename from docs/integrations/index.md rename to docs/integrations/README.md diff --git a/docs/integrations/microsoft-agent-framework.md b/docs/integrations/microsoft-agent-framework.md index 3d6d99086..5543e6aef 100644 --- a/docs/integrations/microsoft-agent-framework.md +++ b/docs/integrations/microsoft-agent-framework.md @@ -123,7 +123,7 @@ var client = new CopilotClient(); client.start().get(); var session = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -206,18 +206,24 @@ You can also use Copilot SDK's native tool definition alongside MAF tools: Node.js / TypeScript (standalone SDK) ```typescript -import { CopilotClient, DefineTool } from "@github/copilot-sdk"; +import { CopilotClient, defineTool } from "@github/copilot-sdk"; -const getWeather = DefineTool({ - name: "GetWeather", +const getWeather = defineTool("GetWeather", { description: "Get the current weather for a given location.", - parameters: { location: { type: "string", description: "City name" } }, - execute: async ({ location }) => `The weather in ${location} is sunny, 25°C.`, + parameters: { + type: "object", + properties: { + location: { type: "string", description: "City name" }, + }, + required: ["location"], + }, + handler: async ({ location }: { location: string }) => + `The weather in ${location} is sunny, 25°C.`, }); const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", tools: [getWeather], onPermissionRequest: async () => ({ kind: "approve-once" }), }); @@ -255,7 +261,7 @@ try (var client = new CopilotClient()) { client.start().get(); var session = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setTools(List.of(getWeather)) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -296,7 +302,7 @@ AIAgent reviewer = copilotClient.AsAIAgent(new AIAgentOptions // Azure OpenAI agent for generating documentation AIAgent documentor = AIAgent.FromOpenAI(new OpenAIAgentOptions { - Model = "gpt-4.1", + Model = "gpt-5.4", Instructions = "You write clear, concise documentation for code changes.", }); @@ -330,7 +336,7 @@ async def main(): # OpenAI agent for documentation documentor = OpenAIAgent( - model="gpt-4.1", + model="gpt-5.4", instructions="You write clear, concise documentation for code changes.", ) @@ -360,7 +366,7 @@ client.start().get(); // Step 1: Code review session var reviewer = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -370,7 +376,7 @@ var review = reviewer.sendAndWait(new MessageOptions() // Step 2: Documentation session using review output var documentor = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -434,12 +440,12 @@ var client = new CopilotClient(); client.start().get(); var securitySession = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); var perfSession = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -518,13 +524,13 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", streaming: true, onPermissionRequest: async () => ({ kind: "approve-once" }), }); session.on("assistant.message_delta", (event) => { - process.stdout.write(event.data.delta ?? ""); + process.stdout.write(event.data.deltaContent ?? ""); }); await session.sendAndWait({ prompt: "Write a quicksort implementation in TypeScript" }); @@ -544,7 +550,7 @@ var client = new CopilotClient(); client.start().get(); var session = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setStreaming(true) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -598,7 +604,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", onPermissionRequest: async () => ({ kind: "approve-once" }), }); const response = await session.sendAndWait({ prompt: "Explain this code" }); diff --git a/docs/observability/README.md b/docs/observability/README.md new file mode 100644 index 000000000..3f75e4658 --- /dev/null +++ b/docs/observability/README.md @@ -0,0 +1,7 @@ +# Observability + +Monitor and debug your GitHub Copilot SDK applications. + +* [OpenTelemetry instrumentation](./opentelemetry.md): built-in TelemetryConfig and trace context propagation + +For cost attribution and endpoint-level analysis, subscribe to `assistant.usage` events and inspect `apiEndpoint` (`AssistantUsageApiEndpoint`); see [Streaming events](../features/streaming-events.md). diff --git a/docs/observability/index.md b/docs/observability/index.md deleted file mode 100644 index 9859cdffd..000000000 --- a/docs/observability/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Observability - -Monitor and debug your GitHub Copilot SDK applications. - -* [OpenTelemetry instrumentation](./opentelemetry.md): built-in TelemetryConfig and trace context propagation diff --git a/docs/observability/opentelemetry.md b/docs/observability/opentelemetry.md index ee2014efb..b3932ce66 100644 --- a/docs/observability/opentelemetry.md +++ b/docs/observability/opentelemetry.md @@ -43,7 +43,7 @@ client = CopilotClient( ```go -client, err := copilot.NewClient(copilot.ClientOptions{ +client := copilot.NewClient(&copilot.ClientOptions{ Telemetry: &copilot.TelemetryConfig{ OTLPEndpoint: "http://localhost:4318", }, @@ -104,17 +104,22 @@ let client = Client::start(ClientOptions::new() | Option | Node.js | Python | Go | .NET | Java | Rust | Description | |---|---|---|---|---|---|---|---| | OTLP endpoint | `otlpEndpoint` | `otlp_endpoint` | `OTLPEndpoint` | `OtlpEndpoint` | `otlpEndpoint` | `otlp_endpoint` | OTLP HTTP endpoint URL | +| OTLP protocol | `otlpProtocol` | `otlp_protocol` | `OTLPProtocol` | `OtlpProtocol` | `otlpProtocol` | `otlp_protocol` | OTLP HTTP protocol for all signals: `"http/json"` or `"http/protobuf"` | | File path | `filePath` | `file_path` | `FilePath` | `FilePath` | `filePath` | `file_path` | File path for JSON-lines trace output | | Exporter type | `exporterType` | `exporter_type` | `ExporterType` | `ExporterType` | `exporterType` | `exporter_type` | `"otlp-http"` or `"file"` | | Source name | `sourceName` | `source_name` | `SourceName` | `SourceName` | `sourceName` | `source_name` | Instrumentation scope name | | Capture content | `captureContent` | `capture_content` | `CaptureContent` | `CaptureContent` | `captureContent` | `capture_content` | Whether to capture message content | +The OTLP protocol field configures the CLI's `"otlp-http"` exporter for all signals. Leave it unset to use the CLI default, or set it to `"http/protobuf"` to export protobuf over HTTP. + ### Trace context propagation > **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. The 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. +For cost attribution alongside traces, subscribe to `assistant.usage` events and inspect `apiEndpoint` (`AssistantUsageApiEndpoint`) to see whether a turn used Chat Completions, Responses, or Anthropic Messages; see [Streaming events](../features/streaming-events.md). + #### SDK → CLI (outbound) For **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: @@ -147,29 +152,36 @@ When the CLI invokes a tool handler, the `traceparent` and `tracestate` from the ```typescript +import { defineTool } from "@github/copilot-sdk"; import { propagation, context, trace } from "@opentelemetry/api"; -session.registerTool(myTool, async (args, invocation) => { - // Restore the CLI's trace context as the active context - const carrier = { - traceparent: invocation.traceparent, - tracestate: invocation.tracestate, - }; - const parentCtx = propagation.extract(context.active(), carrier); - - // Create a child span under the CLI's span - const tracer = trace.getTracer("my-app"); - return context.with(parentCtx, () => - tracer.startActiveSpan("my-tool", async (span) => { - try { - const result = await doWork(args); - return result; - } finally { - span.end(); - } - }) - ); +const myTool = defineTool("my-tool", { + description: "Do work", + handler: async (args, invocation) => { + // Restore the CLI's trace context as the active context + const carrier = { + traceparent: invocation.traceparent, + tracestate: invocation.tracestate, + }; + const parentCtx = propagation.extract(context.active(), carrier); + + // Create a child span under the CLI's span + const tracer = trace.getTracer("my-app"); + return context.with(parentCtx, () => + tracer.startActiveSpan("my-tool", async (span) => { + try { + const result = await doWork(args); + return result; + } finally { + span.end(); + } + }) + ); + }, }); + +// Tool handlers are registered when the session is created. +const session = await client.createSession({ tools: [myTool] }); ``` ### Per-language dependencies diff --git a/docs/setup/README.md b/docs/setup/README.md new file mode 100644 index 000000000..e4723ab48 --- /dev/null +++ b/docs/setup/README.md @@ -0,0 +1,12 @@ +# Set up Copilot SDK + +Configure and deploy the GitHub Copilot SDK for your use case. + +* [Choosing a setup path](./choosing-a-setup-path.md): architecture, personas, and decision matrix +* [Default setup (bundled CLI)](./bundled-cli.md): the SDK includes the CLI automatically +* [Local CLI](./local-cli.md): use your own CLI binary or running instance +* [Backend services](./backend-services.md): server-side with headless CLI over TCP +* [Multi-tenancy and server deployments](./multi-tenancy.md): SDK options for multi-user server mode +* [GitHub OAuth](./github-oauth.md): implement the OAuth flow +* [Azure managed identity](./azure-managed-identity.md): BYOK with Microsoft Foundry +* [Scaling and multi-tenancy](./scaling.md): horizontal scaling, isolation patterns diff --git a/docs/setup/azure-managed-identity.md b/docs/setup/azure-managed-identity.md index c803c7f89..cac33edb2 100644 --- a/docs/setup/azure-managed-identity.md +++ b/docs/setup/azure-managed-identity.md @@ -1,70 +1,321 @@ -# Azure managed identity with BYOK +# Azure Managed Identity with BYOK -The 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. +The GitHub Copilot SDK's [BYOK mode](../auth/byok.md) supports static API keys, but Azure deployments often use **Managed Identity** (Microsoft Entra ID) instead of long-lived keys. The GitHub Copilot SDK is designed to compose with the Azure Identity SDK for maximum flexibility. Supply a bearer token provider callback that can fetch fresh tokens on demand using an Azure Identity SDK API. -This 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. +This guide shows how to use Azure Identity SDK APIs to authenticate with Microsoft Foundry models through the GitHub Copilot SDK. Most languages use `DefaultAzureCredential`; Rust uses `DeveloperToolsCredential` locally and `ManagedIdentityCredential` in Azure. ## How it works -Azure AI Foundry's OpenAI-compatible endpoint accepts bearer tokens from Entra ID in place of static API keys. The pattern is: +Microsoft Foundry's OpenAI-compatible endpoint (`https://.openai.azure.com/openai/v1/`) accepts bearer tokens from Microsoft Entra ID in place of static API keys. This guide uses a token provider callback so the GitHub Copilot SDK runtime can request fresh tokens on demand. -1. Use `DefaultAzureCredential` to obtain a token for the `https://cognitiveservices.azure.com/.default` scope -1. Pass the token as the `bearer_token` in the BYOK provider config -1. Refresh the token before it expires (tokens are typically valid for ~1 hour) +Using Python as an example, the flow is: + +1. Configure `DefaultAzureCredential` for your environment. +1. Pass a callback, in `bearer_token_provider` of the BYOK provider configuration, that uses `DefaultAzureCredential` to obtain a token for the `https://ai.azure.com/.default` scope. +1. Let the GitHub Copilot SDK request fresh tokens on demand through that callback. ```mermaid sequenceDiagram participant App as Your Application - participant AAD as Entra ID - participant SDK as Copilot SDK - participant Foundry as Azure AI Foundry - - App->>AAD: DefaultAzureCredential.get_token() - AAD-->>App: Bearer token (~1hr) - App->>SDK: create_session(provider={bearer_token: token}) + participant SDK as GitHub Copilot SDK + participant Foundry as Microsoft Foundry + participant MEID as Microsoft Entra ID + + App->>SDK: create_session(provider={bearer_token_provider: callback}) + App->>SDK: send message + SDK->>App: Request token from callback + App->>MEID: DefaultAzureCredential.get_token() + MEID-->>App: Access token + App-->>SDK: token SDK->>Foundry: Request with Authorization: Bearer Foundry-->>SDK: Model response SDK-->>App: Session events ``` -## Python example +## Code samples ### Prerequisites +Install the Azure Identity and GitHub Copilot SDK packages for your language: + +
+.NET + + + +```bash +dotnet add package GitHub.Copilot.SDK +dotnet add package Azure.Core +``` + +
+
+Go + + + +```bash +go get github.com/github/copilot-sdk/go +go get github.com/Azure/azure-sdk-for-go/sdk/azidentity +``` + +
+
+Java + + + +```xml + + com.github + copilot-sdk-java + ${copilot.sdk.version} + + + + com.azure + azure-identity + ${azure.identity.version} + +``` + +
+
+Python + + + ```bash pip install github-copilot-sdk azure-identity ``` -### Basic usage +
+
+Rust + + + +```bash +cargo add github-copilot-sdk azure_identity azure_core +cargo add tokio --features macros,rt-multi-thread +``` + +
+
+TypeScript + + + +```bash +npm install @github/copilot-sdk @azure/identity +``` + +
+ +### Use a token provider callback + +Use this approach when you want the GitHub Copilot SDK runtime to request fresh tokens on demand through a callback that you provide. The Azure Identity SDK handles token caching and refresh timing. + +Here are language-specific implementations: + +
+.NET + + + +```csharp +using Azure.Core; +using Azure.Identity; +using GitHub.Copilot; + +DefaultAzureCredential credential = new( + DefaultAzureCredential.DefaultEnvironmentVariableName); +await using CopilotClient client = new(); +string foundryUrl = Environment.GetEnvironmentVariable("FOUNDRY_RESOURCE_URL")!; + +await using CopilotSession session = await client.CreateSessionAsync(new SessionConfig +{ + Model = "gpt-5.5", + Provider = new ProviderConfig + { + Type = "openai", + BaseUrl = $"{foundryUrl}/openai/v1/", + BearerTokenProvider = async _ => + { + AccessToken token = await credential.GetTokenAsync( + new TokenRequestContext(["https://ai.azure.com/.default"])); + return token.Token; + }, + WireApi = "responses", + }, +}); + +AssistantMessageEvent? response = await session.SendAndWaitAsync( + new MessageOptions { Prompt = "Hello from Managed Identity!" }); +Console.WriteLine(response?.Data.Content); +``` + +
+
+Go + + + +```go +package main + +import ( + "context" + "fmt" + "log" + "os" + "time" + + "github.com/Azure/azure-sdk-for-go/sdk/azcore/policy" + "github.com/Azure/azure-sdk-for-go/sdk/azidentity" + copilot "github.com/github/copilot-sdk/go" +) +func main() { + opts := azidentity.DefaultAzureCredentialOptions{RequireAzureTokenCredentials: true} + credential, err := azidentity.NewDefaultAzureCredential(&opts) + if err != nil { + log.Fatal(err) + } + + getBearerToken := func(args copilot.ProviderTokenArgs) (string, error) { + token, err := credential.GetToken(context.Background(), policy.TokenRequestOptions{ + Scopes: []string{"https://ai.azure.com/.default"}, + }) + if err != nil { + return "", err + } + return token.Token, nil + } + + client := copilot.NewClient(nil) + if err := client.Start(context.Background()); err != nil { + log.Fatal(err) + } + defer client.Stop() + + foundryURL := os.Getenv("FOUNDRY_RESOURCE_URL") + + session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{ + Model: "gpt-5.5", + Provider: &copilot.ProviderConfig{ + Type: "openai", + BaseURL: fmt.Sprintf("%s/openai/v1/", foundryURL), + BearerTokenProvider: getBearerToken, + WireAPI: "responses", + }, + }) + if err != nil { + log.Fatal(err) + } + defer session.Disconnect() + + ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second) + defer cancel() + + response, err := session.SendAndWait(ctx, copilot.MessageOptions{ + Prompt: "Hello from Managed Identity!", + }) + if err != nil { + log.Fatal(err) + } + + if response != nil { + if data, ok := response.Data.(*copilot.AssistantMessageData); ok { + fmt.Println(data.Content) + } + } +} +``` + +
+
+Java + + + +```java +import com.azure.core.credential.TokenRequestContext; +import com.azure.identity.AzureIdentityEnvVars; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.github.copilot.CopilotClient; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.BearerTokenProvider; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.SessionConfig; + +public class ManagedIdentityExample { + public static void main(String[] args) throws Exception { + var credential = new DefaultAzureCredentialBuilder() + .requireEnvVars(AzureIdentityEnvVars.AZURE_TOKEN_CREDENTIALS) + .build(); + BearerTokenProvider tokenProvider = providerArgs -> + credential + .getToken(new TokenRequestContext().addScopes("https://ai.azure.com/.default")) + .map(accessToken -> accessToken.getToken()) + .toFuture(); + String foundryUrl = System.getenv("FOUNDRY_RESOURCE_URL"); + + try (var client = new CopilotClient()) { + client.start().get(); + + var session = client.createSession(new SessionConfig() + .setModel("gpt-5.5") + .setProvider(new ProviderConfig() + .setType("openai") + .setBaseUrl(foundryUrl + "/openai/v1/") + .setBearerTokenProvider(tokenProvider) + .setWireApi("responses"))) + .get(); + + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Hello from Managed Identity!")) + .get(); + System.out.println(response.getData().content()); + + session.disconnect().get(); + } + } +} +``` + +
+
+Python + + ```python import asyncio import os -from azure.identity import DefaultAzureCredential +from azure.identity.aio import DefaultAzureCredential from copilot import CopilotClient from copilot.session import PermissionHandler, ProviderConfig -COGNITIVE_SERVICES_SCOPE = "https://cognitiveservices.azure.com/.default" - - async def main(): - # Get a token using Managed Identity, Azure CLI, or other credential chain - credential = DefaultAzureCredential() - token = credential.get_token(COGNITIVE_SERVICES_SCOPE).token + credential = DefaultAzureCredential(require_envvar=True) + async def get_bearer_token(_args) -> str: + token = await credential.get_token("https://ai.azure.com/.default") + return token.token - foundry_url = os.environ["AZURE_AI_FOUNDRY_RESOURCE_URL"] + foundry_url = os.environ["FOUNDRY_RESOURCE_URL"] client = CopilotClient() await client.start() session = await client.create_session( on_permission_request=PermissionHandler.approve_all, - model="gpt-4.1", + model="gpt-5.5", provider=ProviderConfig( type="openai", base_url=f"{foundry_url.rstrip('/')}/openai/v1/", - bearer_token=token, # Short-lived bearer token + bearer_token_provider=get_bearer_token, wire_api="responses", ), ) @@ -73,140 +324,144 @@ async def main(): print(response.data.content) await client.stop() + await credential.close() asyncio.run(main()) ``` -### Token refresh for long-running applications - -Bearer tokens expire (typically after ~1 hour). For servers or long-running agents, refresh the token before creating each session: - -```python -from azure.identity import DefaultAzureCredential -from copilot import CopilotClient -from copilot.session import PermissionHandler, ProviderConfig - -COGNITIVE_SERVICES_SCOPE = "https://cognitiveservices.azure.com/.default" - +
+
+Rust -class ManagedIdentityCopilotAgent: - """Copilot agent that refreshes Entra ID tokens for Azure AI Foundry.""" - - def __init__(self, foundry_url: str, model: str = "gpt-4.1"): - self.foundry_url = foundry_url.rstrip("/") - self.model = model - self.credential = DefaultAzureCredential() - self.client = CopilotClient() - - def _get_provider_config(self) -> ProviderConfig: - """Build a ProviderConfig with a fresh bearer token.""" - token = self.credential.get_token(COGNITIVE_SERVICES_SCOPE).token - return ProviderConfig( - type="openai", - base_url=f"{self.foundry_url}/openai/v1/", - bearer_token=token, - wire_api="responses", - ) - - async def chat(self, prompt: str) -> str: - """Send a prompt and return the response text.""" - # Fresh token for each session - session = await self.client.create_session( - on_permission_request=PermissionHandler.approve_all, - model=self.model, - provider=self._get_provider_config(), - ) - - response = await session.send_and_wait(prompt) - await session.disconnect() + - return response.data.content if response else "" +```rust +use std::sync::Arc; + +use azure_core::credentials::TokenCredential; +use azure_identity::{DeveloperToolsCredential, ManagedIdentityCredential}; +use github_copilot_sdk::{BearerTokenError, Client, ClientOptions, MessageOptions, ProviderTokenArgs}; +use github_copilot_sdk::types::{ProviderConfig, SessionConfig}; + +fn credential_for_environment() -> azure_core::Result> { + match std::env::var("AZURE_TOKEN_CREDENTIALS").as_deref() { + Ok("ManagedIdentityCredential") => Ok(ManagedIdentityCredential::new(None)?), + _ => Ok(DeveloperToolsCredential::new(None)?), + } +} + +#[tokio::main] +async fn main() -> Result<(), Box> { + let credential = credential_for_environment()?; + let foundry_url = std::env::var("FOUNDRY_RESOURCE_URL")?; + + let get_bearer_token = { + let credential = credential.clone(); + move |_args: ProviderTokenArgs| { + let credential = credential.clone(); + async move { + let token = credential + .get_token(&["https://ai.azure.com/.default"], None) + .await + .map_err(|err| BearerTokenError::message(err.to_string()))?; + Ok(token.token.secret().to_string()) + } + } + }; + + let mut provider = ProviderConfig::default(); + provider.provider_type = Some("openai".to_string()); + provider.base_url = format!("{}/openai/v1/", foundry_url.trim_end_matches('/')); + provider.bearer_token_provider = Some(Arc::new(get_bearer_token)); + provider.wire_api = Some("responses".to_string()); + + let mut config = SessionConfig::default(); + config.model = Some("gpt-5.5".to_string()); + config.provider = Some(provider); + + let client = Client::start(ClientOptions::default()).await?; + let session = client.create_session(config).await?; + + session + .send_and_wait(MessageOptions::new("Hello from Managed Identity!")) + .await?; + + session.disconnect().await?; + client.stop().await?; + Ok(()) +} ``` -## Node.js / TypeScript example +
+
+TypeScript + ```typescript import { DefaultAzureCredential } from "@azure/identity"; import { CopilotClient } from "@github/copilot-sdk"; -const credential = new DefaultAzureCredential(); -const tokenResponse = await credential.getToken( - "https://cognitiveservices.azure.com/.default" -); +const credential = new DefaultAzureCredential({ + requiredEnvVars: ["AZURE_TOKEN_CREDENTIALS"], +}); +const getBearerToken = async () => { + const tokenResponse = await credential.getToken("https://ai.azure.com/.default"); + return tokenResponse.token; +}; const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.5", provider: { type: "openai", - baseUrl: `${process.env.AZURE_AI_FOUNDRY_RESOURCE_URL}/openai/v1/`, - bearerToken: tokenResponse.token, + baseUrl: `${process.env.FOUNDRY_RESOURCE_URL}/openai/v1/`, + bearerTokenProvider: getBearerToken, wireApi: "responses", }, }); -const response = await session.sendAndWait({ prompt: "Hello!" }); +const response = await session.sendAndWait({ prompt: "Hello from Managed Identity!" }); console.log(response?.data.content); await client.stop(); ``` -## .NET example - - -```csharp -using Azure.Identity; -using GitHub.Copilot; - -var credential = new DefaultAzureCredential(); -var token = await credential.GetTokenAsync( - new Azure.Core.TokenRequestContext( - new[] { "https://cognitiveservices.azure.com/.default" })); - -await using var client = new CopilotClient(); -var foundryUrl = Environment.GetEnvironmentVariable("AZURE_AI_FOUNDRY_RESOURCE_URL"); - -await using var session = await client.CreateSessionAsync(new SessionConfig -{ - Model = "gpt-4.1", - Provider = new ProviderConfig - { - Type = "openai", - BaseUrl = $"{foundryUrl!.TrimEnd('/')}/openai/v1/", - BearerToken = token.Token, - WireApi = "responses", - }, -}); - -var response = await session.SendAndWaitAsync( - new MessageOptions { Prompt = "Hello from Managed Identity!" }); -Console.WriteLine(response?.Data.Content); -``` +
## Environment configuration | Variable | Description | Example | |----------|-------------|---------| -| `AZURE_AI_FOUNDRY_RESOURCE_URL` | Your Azure AI Foundry resource URL | `https://myresource.openai.azure.com` | +| `AZURE_TOKEN_CREDENTIALS` | When running in **Azure**, set it to `ManagedIdentityCredential`. When running **locally**, set it to either `dev` or a developer tool credential name, such as `AzureCliCredential`. | `ManagedIdentityCredential` | +| `AZURE_CLIENT_ID` | *Optional.* When running in **Azure**, set this to the client ID of a User-assigned Managed Identity when using `ManagedIdentityCredential`. If not set, Azure uses the System-assigned Managed Identity. | `11111111-2222-3333-4444-555555555555` | +| `FOUNDRY_RESOURCE_URL` | Your Microsoft Foundry resource URL | `https://.openai.azure.com` | -No API key environment variable is needed—authentication is handled by `DefaultAzureCredential`, which automatically supports: +No API key environment variable is needed—authentication is handled by Azure Identity credentials. In .NET, Go, Java, Python, and TypeScript, `DefaultAzureCredential` automatically supports: -* **Managed Identity** (system-assigned or user-assigned): for Azure-hosted apps +* **Managed Identity** (System-assigned or User-assigned): for Azure-hosted apps * **Azure CLI** (`az login`): for local development * **Environment variables** (`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`): for service principals * **Workload Identity**: for Kubernetes -See the [DefaultAzureCredential documentation](https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential) for the full credential chain. +In .NET, Go, Java, Python, and TypeScript, `ManagedIdentityCredential` reads `AZURE_CLIENT_ID` to select a User-assigned Managed Identity. Rust is an exception in this guide. + +In Rust, use `DeveloperToolsCredential` for local development and `ManagedIdentityCredential` when running in Azure. For other languages, see the `DefaultAzureCredential` documentation for the full credential chain: + +* [.NET](https://aka.ms/azsdk/net/identity/credential-chains#defaultazurecredential-overview) +* [Go](https://aka.ms/azsdk/go/identity/credential-chains#defaultazurecredential-overview) +* [Java](https://aka.ms/azsdk/java/identity/credential-chains#defaultazurecredential-overview) +* [Python](https://aka.ms/azsdk/python/identity/credential-chains#defaultazurecredential-overview) +* [TypeScript](https://aka.ms/azsdk/js/identity/credential-chains#defaultazurecredential-overview) ## When to use this pattern | Scenario | Recommendation | |----------|----------------| | Azure-hosted app with Managed Identity | ✅ Use this pattern | -| App with existing Azure AD service principal | ✅ Use this pattern | +| App with existing Microsoft Entra service principal | ✅ Use this pattern | | Local development with `az login` | ✅ Use this pattern | | Non-Azure environment with static API key | Use [standard BYOK](../auth/byok.md) | | GitHub Copilot subscription available | Use [GitHub OAuth](./github-oauth.md) | @@ -215,4 +470,3 @@ See the [DefaultAzureCredential documentation](https://learn.microsoft.com/pytho * [BYOK Setup Guide](../auth/byok.md): Static API key configuration * [Backend Services](./backend-services.md): Server-side deployment -* [Azure Identity documentation](https://learn.microsoft.com/python/api/overview/azure/identity-readme) diff --git a/docs/setup/backend-services.md b/docs/setup/backend-services.md index 2dc2c47d1..7f1da36e8 100644 --- a/docs/setup/backend-services.md +++ b/docs/setup/backend-services.md @@ -6,7 +6,7 @@ Run the Copilot SDK in server-side applications—APIs, web backends, microservi ## How it works -Instead 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 `Connection` option (`UriConnection`). +Instead 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 `Connection` option (`URIConnection`). ```mermaid flowchart TB @@ -36,6 +36,8 @@ flowchart TB * Multiple SDK clients can share one CLI server * Works with any auth method (GitHub tokens, env vars, BYOK) +For multi-user server mode, configure SDK clients with `mode: "empty"`, pass user credentials per session, and explicitly allow tools for each session. See [Multi-Tenancy & Server Deployments](./multi-tenancy.md) for the full pattern. + ## Architecture: auto-managed vs. external CLI ```mermaid @@ -123,15 +125,18 @@ Restart=always Node.js / TypeScript ```typescript -import { CopilotClient } from "@github/copilot-sdk"; +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; const client = new CopilotClient({ - cliUrl: "localhost:4321", + connection: RuntimeConnection.forUri("localhost:4321"), + mode: "empty", }); const session = await client.createSession({ sessionId: `user-${userId}-${Date.now()}`, - model: "gpt-4.1", + model: "gpt-5.4", + availableTools: ["custom:*"], + gitHubToken: user.githubToken, }); const response = await session.sendAndWait({ prompt: req.body.message }); @@ -152,7 +157,7 @@ client = CopilotClient( ) await client.start() -session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1", session_id=f"user-{user_id}-{int(time.time())}") +session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-5.4", session_id=f"user-{user_id}-{int(time.time())}") response = await session.send_and_wait(message) ``` @@ -178,15 +183,15 @@ func main() { userID := "user1" message := "Hello" - client := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:4321"}, - }) + client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.URIConnection{URL: "localhost:4321"}, + }) client.Start(ctx) defer client.Stop() session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ SessionID: fmt.Sprintf("user-%s-%d", userID, time.Now().Unix()), - Model: "gpt-4.1", + Model: "gpt-5.4", }) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message}) @@ -197,14 +202,14 @@ func main() { ```go client := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:4321"}, + Connection: copilot.URIConnection{URL: "localhost:4321"}, }) client.Start(ctx) defer client.Stop() session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ SessionID: fmt.Sprintf("user-%s-%d", userID, time.Now().Unix()), - Model: "gpt-4.1", + Model: "gpt-5.4", }) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message}) @@ -230,7 +235,7 @@ var client = new CopilotClient(new CopilotClientOptions await using var session = await client.CreateSessionAsync(new SessionConfig { SessionId = $"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}", - Model = "gpt-4.1", + Model = "gpt-5.4", }); var response = await session.SendAndWaitAsync( @@ -247,7 +252,7 @@ var client = new CopilotClient(new CopilotClientOptions await using var session = await client.CreateSessionAsync(new SessionConfig { SessionId = $"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}", - Model = "gpt-4.1", + Model = "gpt-5.4", }); var response = await session.SendAndWaitAsync( @@ -275,7 +280,7 @@ try { var session = client.createSession(new SessionConfig() .setSessionId(String.format("user-%s-%d", userId, System.currentTimeMillis() / 1000)) - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -318,17 +323,18 @@ copilot --headless --port 4321 Pass individual user tokens when creating sessions. See [GitHub OAuth](./github-oauth.md) for the full flow. ```typescript +const client = new CopilotClient({ + connection: RuntimeConnection.forUri("localhost:4321"), + mode: "empty", +}); + // Your API receives user tokens from your auth layer app.post("/chat", authMiddleware, async (req, res) => { - const client = new CopilotClient({ - cliUrl: "localhost:4321", - gitHubToken: req.user.githubToken, - useLoggedInUser: false, - }); - const session = await client.createSession({ sessionId: `user-${req.user.id}-chat`, - model: "gpt-4.1", + model: "gpt-5.4", + availableTools: ["custom:*"], + gitHubToken: req.user.githubToken, }); const response = await session.sendAndWait({ @@ -345,11 +351,11 @@ Use your own API keys for the model provider. See [BYOK](../auth/byok.md) for de ```typescript const client = new CopilotClient({ - cliUrl: "localhost:4321", + connection: RuntimeConnection.forUri("localhost:4321"), }); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", provider: { type: "openai", baseUrl: "https://api.openai.com/v1", @@ -380,14 +386,15 @@ flowchart TB ```typescript import express from "express"; -import { CopilotClient } from "@github/copilot-sdk"; +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; const app = express(); app.use(express.json()); -// Single shared CLI connection +// Single shared CLI connection for multi-user server mode const client = new CopilotClient({ - cliUrl: process.env.CLI_URL || "localhost:4321", + connection: RuntimeConnection.forUri(process.env.CLI_URL || "localhost:4321"), + mode: "empty", }); app.post("/api/chat", async (req, res) => { @@ -400,7 +407,9 @@ app.post("/api/chat", async (req, res) => { } catch { session = await client.createSession({ sessionId, - model: "gpt-4.1", + model: "gpt-5.4", + availableTools: ["custom:*"], + gitHubToken: req.user.githubToken, }); } @@ -417,17 +426,17 @@ app.listen(3000); ### Background worker ```typescript -import { CopilotClient } from "@github/copilot-sdk"; +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; const client = new CopilotClient({ - cliUrl: process.env.CLI_URL || "localhost:4321", + connection: RuntimeConnection.forUri(process.env.CLI_URL || "localhost:4321"), }); // Process jobs from a queue async function processJob(job: Job) { const session = await client.createSession({ sessionId: `job-${job.id}`, - model: "gpt-4.1", + model: "gpt-5.4", }); const response = await session.sendAndWait({ @@ -538,11 +547,13 @@ setInterval(() => cleanupSessions(24 * 60 * 60 * 1000), 60 * 60 * 1000); | Need | Next Guide | |------|-----------| | Multiple CLI servers / high availability | [Scaling & Multi-Tenancy](./scaling.md) | +| SDK isolation for concurrent users | [Multi-Tenancy & Server Deployments](./multi-tenancy.md) | | GitHub account auth for users | [GitHub OAuth](./github-oauth.md) | | Your own model keys | [BYOK](../auth/byok.md) | ## Next steps +* **[Multi-Tenancy & Server Deployments](./multi-tenancy.md)**: Configure SDK isolation for concurrent users * **[Scaling & Multi-Tenancy](./scaling.md)**: Handle more users, add redundancy * **[Session Persistence](../features/session-persistence.md)**: Resume sessions across restarts * **[GitHub OAuth](./github-oauth.md)**: Add user authentication diff --git a/docs/setup/bundled-cli.md b/docs/setup/bundled-cli.md index 94bb61754..f067de8fd 100644 --- a/docs/setup/bundled-cli.md +++ b/docs/setup/bundled-cli.md @@ -1,12 +1,20 @@ # Default setup (bundled CLI) -The 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. +The Node.js and .NET SDKs include the Copilot CLI as a dependency—your app ships with everything it needs, with no extra installation or configuration required. + +The Python SDK recommends a one-time download step after installation: + +```bash +python -m copilot download-runtime +``` + +This downloads the matching runtime and caches it locally. If you skip this step, the SDK will attempt to download it automatically on first use as a fallback. **Best for:** Most applications—desktop apps, standalone tools, CLI utilities, prototypes, and more. ## How it works -When 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. +When you install the SDK, the Copilot runtime is included automatically (Node.js, .NET) or downloaded via `python -m copilot download-runtime` (Python). The SDK starts it as a child process and communicates over stdio. There's nothing extra to configure. ```mermaid flowchart TB @@ -39,7 +47,7 @@ import { CopilotClient } from "@github/copilot-sdk"; const client = new CopilotClient(); -const session = await client.createSession({ model: "gpt-4.1" }); +const session = await client.createSession({ model: "gpt-5.4" }); const response = await session.sendAndWait({ prompt: "Hello!" }); console.log(response?.data.content); @@ -58,7 +66,7 @@ from copilot.session import PermissionHandler client = CopilotClient() await client.start() -session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1") +session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-5.4") response = await session.send_and_wait("Hello!") print(response.data.content) @@ -71,7 +79,7 @@ await client.stop() Go > [!NOTE] -> The Go SDK does not bundle the CLI. You must install the CLI separately or set `Connection` to point to an existing binary. See [Local CLI Setup](./local-cli.md) for details. +> Unlike Node.js, Python, and .NET, the Go SDK does not include a CLI as an automatic dependency. With no explicit path, `NewClient(nil)` uses an embedded CLI when available, then falls back to `copilot` on `PATH`. To embed a CLI, run the [bundler tool](../../go/README.md#distributing-your-application-with-an-embedded-github-copilot-cli) at build time. You can also set `COPILOT_CLI_PATH` or point a `Connection` at an existing binary. See [Local CLI Setup](./local-cli.md) for details. ```go @@ -93,7 +101,7 @@ func main() { } defer client.Stop() - session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"}) + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5.4"}) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) if d, ok := response.Data.(*copilot.AssistantMessageData); ok { fmt.Println(d.Content) @@ -109,7 +117,7 @@ if err := client.Start(ctx); err != nil { } defer client.Stop() -session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"}) +session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5.4"}) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) if d, ok := response.Data.(*copilot.AssistantMessageData); ok { fmt.Println(d.Content) @@ -124,7 +132,7 @@ if d, ok := response.Data.(*copilot.AssistantMessageData); ok { ```csharp await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync( - new SessionConfig { Model = "gpt-4.1" }); + new SessionConfig { Model = "gpt-5.4" }); var response = await session.SendAndWaitAsync( new MessageOptions { Prompt = "Hello!" }); @@ -137,7 +145,7 @@ Console.WriteLine(response?.Data.Content); Java > [!NOTE] -> The Java SDK does not bundle or embed the Copilot CLI. You must install the CLI separately and configure its path via `Connection` or the `COPILOT_CLI_PATH` environment variable. +> The Java SDK does not bundle or embed the Copilot CLI. Install the CLI separately and either make `copilot` available on your `PATH` or set its location with `setCliPath(...)` (or connect to a running CLI server with `setCliUrl(...)`). ```java import com.github.copilot.CopilotClient; @@ -150,7 +158,7 @@ var client = new CopilotClient(new CopilotClientOptions() client.start().get(); var session = client.createSession(new SessionConfig() - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); @@ -211,7 +219,7 @@ If you manage your own model provider keys, users don't need GitHub accounts at const client = new CopilotClient(); const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", provider: { type: "openai", baseUrl: "https://api.openai.com/v1", @@ -233,7 +241,7 @@ const client = new CopilotClient(); const sessionId = `project-${projectName}`; const session = await client.createSession({ sessionId, - model: "gpt-4.1", + model: "gpt-5.4", }); // User closes app... diff --git a/docs/setup/choosing-a-setup-path.md b/docs/setup/choosing-a-setup-path.md index f1c4636c6..17c971e65 100644 --- a/docs/setup/choosing-a-setup-path.md +++ b/docs/setup/choosing-a-setup-path.md @@ -50,6 +50,7 @@ You're building tools for your team or company. Users are employees who need to 1. **[Backend Services](./backend-services.md)**—Run the SDK in your internal services **If scaling beyond a single server:** +1. **[Multi-tenancy and server deployments](./multi-tenancy.md)**—Configure SDK options for multi-user server mode 1. **[Scaling & Multi-Tenancy](./scaling.md)**—Handle multiple users and services ### 🚀 App developer (ISV) @@ -62,6 +63,7 @@ You're building a product for customers. You need to handle authentication for y 1. **[Backend Services](./backend-services.md)**—Power your product from server-side code **For production:** +1. **[Multi-tenancy and server deployments](./multi-tenancy.md)**—Use `mode: "empty"`, per-session tokens, and isolated runtime state 1. **[Scaling & Multi-Tenancy](./scaling.md)**—Serve many customers reliably ### 🏗️ Platform developer @@ -70,6 +72,7 @@ You're embedding Copilot into a platform—APIs, developer tools, or infrastruct **Start with:** 1. **[Backend Services](./backend-services.md)**—Core server-side integration +1. **[Multi-tenancy and server deployments](./multi-tenancy.md)**—SDK-level isolation, per-session auth, and shared runtime options 1. **[Scaling & Multi-Tenancy](./scaling.md)**—Session isolation, horizontal scaling, persistence **Depending on your auth model:** @@ -85,9 +88,10 @@ Use this table to find the right guides based on what you need to do: | Getting started quickly | [Default Setup (Bundled CLI)](./bundled-cli.md) | | Use your own CLI binary or server | [Local CLI](./local-cli.md) | | Users sign in with GitHub | [GitHub OAuth](./github-oauth.md) | -| Use your own model keys (OpenAI, Azure, etc.) | [BYOK](../auth/byok.md) | +| Use your own model keys (OpenAI, Azure, and more) | [BYOK](../auth/byok.md) | | Azure BYOK with Managed Identity (no API keys) | [Azure Managed Identity](./azure-managed-identity.md) | | Run the SDK on a server | [Backend Services](./backend-services.md) | +| Configure SDK options for concurrent users | [Multi-tenancy and server deployments](./multi-tenancy.md) | | Serve multiple users / scale horizontally | [Scaling & Multi-Tenancy](./scaling.md) | ## Configuration comparison diff --git a/docs/setup/github-oauth.md b/docs/setup/github-oauth.md index aea6b22b9..5b44024b1 100644 --- a/docs/setup/github-oauth.md +++ b/docs/setup/github-oauth.md @@ -133,7 +133,7 @@ function createClientForUser(userToken: string): CopilotClient { const client = createClientForUser("gho_user_access_token"); const session = await client.createSession({ sessionId: `user-${userId}-session`, - model: "gpt-4.1", + model: "gpt-5.4", }); const response = await session.sendAndWait({ prompt: "Hello!" }); @@ -158,7 +158,7 @@ def create_client_for_user(user_token: str) -> CopilotClient: client = create_client_for_user("gho_user_access_token") await client.start() -session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1", session_id=f"user-{user_id}-session") +session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-5.4", session_id=f"user-{user_id}-session") response = await session.send_and_wait("Hello!") ``` @@ -195,7 +195,7 @@ func main() { session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ SessionID: fmt.Sprintf("user-%s-session", userID), - Model: "gpt-4.1", + Model: "gpt-5.4", }) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) _ = response @@ -206,7 +206,7 @@ func main() { ```go func createClientForUser(userToken string) *copilot.Client { return copilot.NewClient(&copilot.ClientOptions{ - GithubToken: userToken, + GitHubToken: userToken, UseLoggedInUser: copilot.Bool(false), }) } @@ -218,7 +218,7 @@ defer client.Stop() session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ SessionID: fmt.Sprintf("user-%s-session", userID), - Model: "gpt-4.1", + Model: "gpt-5.4", }) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) ``` @@ -245,7 +245,7 @@ await using var client = CreateClientForUser("gho_user_access_token"); await using var session = await client.CreateSessionAsync(new SessionConfig { SessionId = $"user-{userId}-session", - Model = "gpt-4.1", + Model = "gpt-5.4", }); var response = await session.SendAndWaitAsync( @@ -266,7 +266,7 @@ await using var client = CreateClientForUser("gho_user_access_token"); await using var session = await client.CreateSessionAsync(new SessionConfig { SessionId = $"user-{userId}-session", - Model = "gpt-4.1", + Model = "gpt-5.4", }); var response = await session.SendAndWaitAsync( @@ -297,7 +297,7 @@ var userId = "user1"; try (var client = createClientForUser("gho_user_access_token")) { var session = client.createSession(new SessionConfig() .setSessionId(String.format("user-%s-session", userId)) - .setModel("gpt-4.1") + .setModel("gpt-5.4") .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); diff --git a/docs/setup/index.md b/docs/setup/index.md deleted file mode 100644 index d077cc6bb..000000000 --- a/docs/setup/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Set up Copilot SDK - -Configure and deploy the GitHub Copilot SDK for your use case. - -* [Choosing a setup path](./choosing-a-setup-path.md): architecture, personas, and decision matrix -* [Default setup (bundled CLI)](./bundled-cli.md): the SDK includes the CLI automatically -* [Local CLI](./local-cli.md): use your own CLI binary or running instance -* [Backend services](./backend-services.md): server-side with headless CLI over TCP -* [GitHub OAuth](./github-oauth.md): implement the OAuth flow -* [Azure managed identity](./azure-managed-identity.md): BYOK with Azure AI Foundry -* [Scaling and multi-tenancy](./scaling.md): horizontal scaling, isolation patterns diff --git a/docs/setup/local-cli.md b/docs/setup/local-cli.md index 4c7b5dced..79a656396 100644 --- a/docs/setup/local-cli.md +++ b/docs/setup/local-cli.md @@ -1,8 +1,8 @@ # Local CLI setup -Use 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. +Use a specific CLI binary instead of the SDK's automatic CLI management. This is an advanced option—you supply the CLI path explicitly, and you are responsible for ensuring version compatibility with the SDK. -**Use when:** You need to pin a specific CLI version, or work with the Go SDK (which does not bundle a CLI). +**Use when:** You need to pin a specific CLI version, or work with the Go SDK (which does not include a CLI automatically). ## How it works @@ -40,7 +40,7 @@ const client = new CopilotClient({ cliPath: "/usr/local/bin/copilot", }); -const session = await client.createSession({ model: "gpt-4.1" }); +const session = await client.createSession({ model: "gpt-5.4" }); const response = await session.sendAndWait({ prompt: "Hello!" }); console.log(response?.data.content); @@ -54,7 +54,7 @@ await client.stop(); ```python from copilot import CopilotClient -from copilot.generated.session_events import AssistantMessageData +from copilot.session_events import AssistantMessageData from copilot.session import PermissionHandler client = CopilotClient({ @@ -62,7 +62,7 @@ client = CopilotClient({ }) await client.start() -session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-4.1") +session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-5.4") response = await session.send_and_wait("Hello!") if response: match response.data: @@ -78,7 +78,7 @@ await client.stop() Go > [!NOTE] -> The Go SDK does not bundle a CLI, so you must always provide `Connection`. +> The Go SDK does not ship a CLI automatically. Install `copilot` on `PATH`, set the `COPILOT_CLI_PATH` environment variable, embed a CLI with the [bundler tool](../../go/README.md#distributing-your-application-with-an-embedded-github-copilot-cli), or point `StdioConnection.Path` at an installed binary. ```go @@ -102,7 +102,7 @@ func main() { } defer client.Stop() - session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"}) + session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5.4"}) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) if response != nil { if d, ok := response.Data.(*copilot.AssistantMessageData); ok { @@ -122,7 +122,7 @@ if err := client.Start(ctx); err != nil { } defer client.Stop() -session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-4.1"}) +session, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5.4"}) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!"}) if response != nil { if d, ok := response.Data.(*copilot.AssistantMessageData); ok { @@ -143,7 +143,7 @@ var client = new CopilotClient(new CopilotClientOptions }); await using var session = await client.CreateSessionAsync( - new SessionConfig { Model = "gpt-4.1" }); + new SessionConfig { Model = "gpt-5.4" }); var response = await session.SendAndWaitAsync( new MessageOptions { Prompt = "Hello!" }); @@ -190,7 +190,7 @@ Sessions default to ephemeral. To create resumable sessions, provide your own se // Create a named session const session = await client.createSession({ sessionId: "my-project-analysis", - model: "gpt-4.1", + model: "gpt-5.4", }); // Later, resume it diff --git a/docs/setup/multi-tenancy.md b/docs/setup/multi-tenancy.md new file mode 100644 index 000000000..2f82dde0b --- /dev/null +++ b/docs/setup/multi-tenancy.md @@ -0,0 +1,457 @@ +# Multi-tenancy and server deployments + +Multi-user server mode means running the Copilot SDK from backend code that serves more than one human, tenant, workspace, or integration account. In this setup, the application owns request routing and authorization, while the SDK and runtime provide per-session state, per-session authentication, and explicit tool registration so one user's session does not inherit another user's tools or identity. + +**Best for:** SaaS products, partner integrations, internal platforms, and backend services that handle concurrent users. + +## Use this guide when + +Use this guide when you are building: + +* A multi-user SaaS product that embeds Copilot-powered agents +* A backend for a partner integration, such as a Copilot Studio or Fabric-style pattern +* Any server that handles concurrent users, workspaces, tenants, or requests +* A shared runtime where multiple SDK clients connect to one Copilot runtime process + +This guide is a sister to [Scaling and multi-tenancy](./scaling.md). Use that guide for topology, load-balancing, and storage patterns. Use this guide for SDK-level options and runtime isolation choices. + +## Key SDK options + +| Option | Use it for | Notes | +|--------|------------|-------| +| `mode: "empty"` | Disabling ambient OS tools and CLI defaults | Required for multi-user or shared scenarios. | +| `sessionIdleTimeoutSeconds` | Cleaning idle sessions | Set a server-side timeout for long-running processes. | +| `baseDirectory` | Isolating `COPILOT_HOME` per runtime instance | Ignored when connecting to an existing runtime. | +| `sessionFs` | Routing session filesystem storage off local disk | Pair with per-session filesystem providers. | +| `RuntimeConnection.forUri(url)` | Sharing one already-running runtime | Language names vary; see samples below. | +| Per-session `gitHubToken` | Scoping auth to the requesting user | Prefer this over a single shared user token. | + +### `mode: "empty"` + +`mode: "empty"` disables optional Copilot CLI behavior by default. In multi-user server mode, this is the safe baseline because your application must explicitly decide which tools, MCP servers, skills, and workspace paths a session can access. + +Do not use the default `mode: "copilot-cli"` for shared servers. That mode is intended for CLI-like coding agents and can expose ambient host filesystem capabilities. + +
+TypeScript + +```typescript +import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk"; + +// baseDirectory and sessionIdleTimeoutSeconds apply when the SDK spawns the +// runtime. With RuntimeConnection.forUri(...) configure COPILOT_HOME and the +// idle timeout on the runtime process itself. +const client = new CopilotClient({ + mode: "empty", + connection: RuntimeConnection.forUri(process.env.COPILOT_RUNTIME_URL!), +}); + +const session = await client.createSession({ + sessionId: `user-${user.id}-${crypto.randomUUID()}`, + model: "gpt-5.4", + availableTools: ["custom:lookupOrder", "custom:createTicket"], + gitHubToken: user.githubToken, +}); +``` + +
+ +
+Python + +```python +from copilot import CopilotClient, RuntimeConnection +from copilot.session import PermissionHandler + +client = CopilotClient( + mode="empty", + base_directory=f"/var/lib/my-app/copilot/{runtime_instance_id}", + session_idle_timeout_seconds=900, + connection=RuntimeConnection.for_uri(runtime_url), +) +await client.start() + +session = await client.create_session( + session_id=f"user-{user.id}-{request_id}", + model="gpt-5.4", + available_tools=["custom:lookupOrder", "custom:createTicket"], + github_token=user.github_token, + on_permission_request=PermissionHandler.approve_all, +) +``` + +
+ +
+Go + + +```go +package main + +import ( + "context" + "fmt" + + copilot "github.com/github/copilot-sdk/go" +) + +type appUser struct { + ID string + GitHubToken string +} + +func main() { + ctx := context.Background() + runtimeInstanceID := "instance-1" + runtimeURL := "http://127.0.0.1:8080" + requestID := "req-1" + user := appUser{ID: "alice", GitHubToken: "gho_xxx"} + + client := copilot.NewClient(&copilot.ClientOptions{ + Mode: copilot.ModeEmpty, + BaseDirectory: fmt.Sprintf("/var/lib/my-app/copilot/%s", runtimeInstanceID), + SessionIdleTimeoutSeconds: 900, + Connection: copilot.URIConnection{URL: runtimeURL}, + }) + + session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + SessionID: fmt.Sprintf("user-%s-%s", user.ID, requestID), + Model: "gpt-5.4", + AvailableTools: []string{"custom:lookupOrder", "custom:createTicket"}, + GitHubToken: user.GitHubToken, + }) + _ = session + _ = err +} +``` + + +```go +client := copilot.NewClient(&copilot.ClientOptions{ + Mode: copilot.ModeEmpty, + BaseDirectory: fmt.Sprintf("/var/lib/my-app/copilot/%s", runtimeInstanceID), + SessionIdleTimeoutSeconds: 900, + Connection: copilot.URIConnection{URL: runtimeURL}, +}) + +session, err := client.CreateSession(ctx, &copilot.SessionConfig{ + SessionID: fmt.Sprintf("user-%s-%s", user.ID, requestID), + Model: "gpt-5.4", + AvailableTools: []string{"custom:lookupOrder", "custom:createTicket"}, + GitHubToken: user.GitHubToken, +}) +``` + +
+ +
+.NET + + +```csharp +using GitHub.Copilot; + +var runtimeInstanceId = "instance-1"; +var runtimeUrl = "http://127.0.0.1:8080"; +var requestId = "req-1"; +var user = new { Id = "alice", GitHubToken = "gho_xxx" }; + +var client = new CopilotClient(new CopilotClientOptions +{ + Mode = CopilotClientMode.Empty, + BaseDirectory = $"/var/lib/my-app/copilot/{runtimeInstanceId}", + SessionIdleTimeoutSeconds = 900, + Connection = RuntimeConnection.ForUri(runtimeUrl), +}); + +await using var session = await client.CreateSessionAsync(new SessionConfig +{ + SessionId = $"user-{user.Id}-{requestId}", + Model = "gpt-5.4", + AvailableTools = ["custom:lookupOrder", "custom:createTicket"], + GitHubToken = user.GitHubToken, +}); +``` + + +```csharp +var client = new CopilotClient(new CopilotClientOptions +{ + Mode = CopilotClientMode.Empty, + BaseDirectory = $"/var/lib/my-app/copilot/{runtimeInstanceId}", + SessionIdleTimeoutSeconds = 900, + Connection = RuntimeConnection.ForUri(runtimeUrl), +}); + +await using var session = await client.CreateSessionAsync(new SessionConfig +{ + SessionId = $"user-{user.Id}-{requestId}", + Model = "gpt-5.4", + AvailableTools = ["custom:lookupOrder", "custom:createTicket"], + GitHubToken = user.GitHubToken, +}); +``` + +
+ +
+Java + + +```java +import java.util.List; +import com.github.copilot.CopilotClient; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.SessionConfig; + +public class MultiTenancyExample { + record User(String id, String gitHubToken) {} + + public static void main(String[] args) throws Exception { + String runtimeUrl = "http://localhost:4321"; + String requestId = "req-1"; + User user = new User("u1", "ghu_token"); + + // setCopilotHome and setSessionIdleTimeoutSeconds are ignored when + // setCliUrl is used; configure those on the runtime process instead. + var client = new CopilotClient(new CopilotClientOptions() + .setMode(CopilotClientMode.EMPTY) + .setCliUrl(runtimeUrl) + ); + + var session = client.createSession(new SessionConfig() + .setSessionId("user-" + user.id() + "-" + requestId) + .setModel("gpt-5.4") + .setAvailableTools(List.of("custom:lookupOrder", "custom:createTicket")) + .setGitHubToken(user.gitHubToken()) + ).get(); + } +} +``` + + +```java +// setCopilotHome and setSessionIdleTimeoutSeconds are ignored when +// setCliUrl is used; configure those on the runtime process instead. +var client = new CopilotClient(new CopilotClientOptions() + .setMode(CopilotClientMode.EMPTY) + .setCliUrl(runtimeUrl) +); + +var session = client.createSession(new SessionConfig() + .setSessionId("user-" + user.id() + "-" + requestId) + .setModel("gpt-5.4") + .setAvailableTools(List.of("custom:lookupOrder", "custom:createTicket")) + .setGitHubToken(user.gitHubToken()) +).get(); +``` + +
+ +
+Rust + +```rust +use std::path::PathBuf; +use github_copilot_sdk::{Client, ClientOptions, Transport}; +use github_copilot_sdk::mode::ClientMode; +use github_copilot_sdk::types::SessionConfig; + +let client = Client::start( + ClientOptions::new() + .with_mode(ClientMode::Empty) + .with_base_directory(PathBuf::from(format!( + "/var/lib/my-app/copilot/{runtime_instance_id}" + ))) + .with_session_idle_timeout_seconds(900) + .with_transport(Transport::External { + host: runtime_host.to_string(), + port: runtime_port, + connection_token: None, + }), +).await?; + +let session = client.create_session( + SessionConfig::default() + .with_session_id(format!("user-{}-{request_id}", user.id)) + .with_model("gpt-5.4") + .with_available_tools(["custom:lookupOrder", "custom:createTicket"]) + .with_github_token(user.github_token), +).await?; +``` + +
+ +### `sessionIdleTimeoutSeconds` + +Set `sessionIdleTimeoutSeconds` on servers so inactive sessions are cleaned up automatically. This prevents zombie sessions in long-running processes and reduces memory and filesystem pressure. + +| Language | Public option | +|----------|---------------| +| TypeScript | `sessionIdleTimeoutSeconds` | +| Python | `session_idle_timeout_seconds` | +| Go | `SessionIdleTimeoutSeconds` | +| .NET | `SessionIdleTimeoutSeconds` | +| Java | `setSessionIdleTimeoutSeconds(...)` | +| Rust | `with_session_idle_timeout_seconds(...)` | + +Use a value that matches your product's conversation lifetime. For chat backends, 15 to 30 minutes is usually a good starting point. For workflow agents, use a longer timeout and explicit deletion when the workflow completes. + +### `baseDirectory` + +`baseDirectory` sets `COPILOT_HOME` for a runtime instance. Use it to isolate runtime state, credentials, and session data per process, pod, worker, or tenant boundary. + +```typescript +const client = new CopilotClient({ + mode: "empty", + baseDirectory: `/var/lib/my-app/copilot/runtime-${process.env.HOSTNAME}`, + sessionIdleTimeoutSeconds: 900, +}); +``` + +The runtime stores session state under the configured `COPILOT_HOME`, including `session-state/{sessionId}`. If your app runs multiple runtime instances, give each instance a distinct directory unless you intentionally use shared storage. + +When the SDK connects to an already-running runtime with `RuntimeConnection.forUri(url)`, `baseDirectory` is ignored by the SDK client. Configure `COPILOT_HOME` on the runtime process instead. + +### `sessionFs` + +`sessionFs` registers a custom session filesystem provider so session-scoped file I/O can be routed through application storage instead of the runtime's local disk. Use it when local disk is ephemeral, when session state needs to live in object storage, or when a platform needs to enforce tenant-aware storage paths. + +```typescript +const client = new CopilotClient({ + mode: "empty", + sessionFs: { + initialCwd: "/workspace", + sessionStatePath: "/session-state", + conventions: "posix", + }, +}); +``` + +For languages that expose a provider callback, configure `sessionFs` at the client level and provide a per-session filesystem handler when creating or resuming a session. See [Session Persistence](../features/session-persistence.md) for persistence concepts and storage trade-offs. + +Verified public SDK surfaces: + +| Language | Client-level config | Per-session provider | +|----------|---------------------|----------------------| +| TypeScript | `sessionFs` | `createSessionFsAdapter` / provider callbacks | +| Python | `session_fs` | `create_session_fs_handler` | +| Go | `SessionFS` | `CreateSessionFSProvider` | +| .NET | `SessionFs` | `CreateSessionFsProvider` | +| Rust | `with_session_fs(...)` | `with_session_fs_provider(...)` | + +Java does not currently expose a verified public `sessionFs` option, so this guide does not show a Java `sessionFs` sample. + +### `RuntimeConnection.forUri(url)` + +Use an external runtime connection when multiple SDK clients should share one already-running runtime. This is common in backend services where the runtime process is managed separately from request handlers. + +| Language | External runtime connection | +|----------|-----------------------------| +| TypeScript | `RuntimeConnection.forUri(url)` | +| Python | `RuntimeConnection.for_uri(url)` | +| Go | `copilot.URIConnection{URL: url}` | +| .NET | `RuntimeConnection.ForUri(url)` | +| Java | `setCliUrl(url)` | +| Rust | `Transport::External { host, port, connection_token }` | + +External runtimes manage their own process-level authentication and storage. Pass per-session tokens on `createSession` or `resumeSession` when you need user-specific auth. + +### Per-session `gitHubToken` + +Set `gitHubToken` on each session to scope GitHub auth to the requesting user. This is different from a client-level token, which authenticates the runtime process. + +```typescript +const session = await client.createSession({ + sessionId: `user-${user.id}-support`, + model: "gpt-5.4", + availableTools: ["custom:*"], + gitHubToken: user.githubToken, +}); +``` + +Use per-session tokens for content exclusion, model routing, quota checks, and user-specific Copilot access. Avoid sharing one service token across users unless your product intentionally uses service-account semantics. + +## Integration ID + +Partners building branded agents can set an integration ID for Mission Control requests. The runtime reads `GITHUB_COPILOT_INTEGRATION_ID` and stamps it as the `Copilot-Integration-Id` HTTP header on every Mission Control request. + +```bash +GITHUB_COPILOT_INTEGRATION_ID=my-product-agent copilot --headless --port 4321 +``` + +The default integration ID is `copilot-developer-cli`. Use a stable value such as `my-product-agent` for attribution and routing. The integration ID is currently configured by environment variable only; it is not a first-class SDK option. + +If the SDK spawns the runtime, pass the environment variable through the client environment option. If you connect with `RuntimeConnection.forUri(url)`, set the environment variable on the runtime process itself. + +## Session-level isolation guarantees + +Session-level isolation means the runtime keeps user-specific model and state information scoped to a session, not in global shared state. + +| Surface | Isolation behavior | +|---------|--------------------| +| Model list cache | Per-session. Model lookup uses the session's model list cache. | +| Session state | Per session ID under `COPILOT_HOME/session-state/{sessionId}`. | +| GitHub identity | Per-session when `gitHubToken` is set on the session. | +| Tools | Explicit in `mode: "empty"`; ambient in `mode: "copilot-cli"`. | +| Host filesystem | Shared by the runtime process if host tools are available. | + +`mode: "empty"` is what makes shared runtime patterns viable: no ambient OS tools are exposed unless your application registers or allows them. With `mode: "copilot-cli"`, OS filesystem access is shared through the host process, so do not use that mode for multi-user server mode. + +Session state is stored under `COPILOT_HOME/session-state/{sessionId}` unless you route it through `sessionFs`. Use unique session IDs that include your own tenant or user boundary, and enforce access control before resuming or deleting sessions. + +## Pattern comparison + +| Pattern | Use when | Trade-offs | +|---------|----------|------------| +| Pattern 1: isolated CLI per user | You need the strongest isolation boundary or separate process credentials per user. | Strong isolation; higher resource cost. See [Scaling and multi-tenancy](./scaling.md). | +| Pattern 2: shared CLI with `mode: "empty"` | You want one runtime to serve many users while your app controls tools, auth, and session IDs. | Efficient; requires careful tool registration, per-session tokens, and application-level access checks. | +| Pattern 3: hybrid | You route compute-heavy work to cloud sessions and light work to local sessions. | Flexible; requires workload routing and policy handling. See [Cloud Sessions](../features/cloud-sessions.md). | + +### Pattern 2: shared CLI with `mode: "empty"` + +In this pattern, all users connect through your backend to one runtime pool. The application performs user authentication, chooses a session ID, passes the user's GitHub token on the session, and provides an explicit tool allowlist. + +```mermaid +flowchart TB + U1["User A"] --> API["Your backend"] + U2["User B"] --> API + API --> Runtime["Shared Copilot runtime"] + Runtime --> SA["session-state/user-a-..."] + Runtime --> SB["session-state/user-b-..."] + + API -. "mode: empty" .-> Runtime + API -. "per-session gitHubToken" .-> Runtime + + style API fill:#0d1117,stroke:#58a6ff,color:#c9d1d9 + style Runtime fill:#0d1117,stroke:#3fb950,color:#c9d1d9 +``` + +Use these rules: + +* Always start the client or runtime in `mode: "empty"`. +* Use unique session IDs and store ownership metadata in your application database. +* Check ownership before `resumeSession`, `deleteSession`, or any UI action that references a session ID. +* Pass `gitHubToken` per session when requests should run as the user. +* Register only the tools the session needs, and prefer source-qualified allowlists such as `custom:*` or `mcp:search_docs`. +* Set `sessionIdleTimeoutSeconds` and delete completed workflow sessions explicitly. + +## Common pitfalls + +* Forgetting `mode: "empty"`. The default `copilot-cli` mode exposes CLI-style behavior and may expose the host filesystem through ambient tools. +* Not setting `sessionIdleTimeoutSeconds`. Long-running servers can accumulate idle sessions if they do not clean them up. +* Sharing one `gitHubToken` across users instead of passing a per-session token. +* Trusting client-provided session IDs without checking ownership in your backend. +* Setting `baseDirectory` on a client that connects to an existing runtime and expecting it to move runtime storage. Configure the runtime process instead. +* Allowing broad tool patterns such as `builtin:*` without reviewing whether each tool is appropriate for your users. + +## See also + +* [Scaling and multi-tenancy](./scaling.md): deployment topologies, storage patterns, and isolation comparisons +* [Backend services setup](./backend-services.md): running the runtime in headless server mode +* [BYOK](../auth/byok.md): using your own model provider credentials +* [Cloud Sessions](../features/cloud-sessions.md): routing selected work to cloud sessions +* [Session Persistence](../features/session-persistence.md): managing resumable session state +* [Features overview](../features/README.md): tools, events, hooks, and advanced SDK features diff --git a/docs/setup/scaling.md b/docs/setup/scaling.md index 371a402b3..c4a7a0953 100644 --- a/docs/setup/scaling.md +++ b/docs/setup/scaling.md @@ -2,6 +2,8 @@ Design 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. +For SDK-level options and patterns, see [Multi-Tenancy & Server Deployments](./multi-tenancy.md). + **Best for:** Platform developers, SaaS builders, any deployment serving more than a handful of concurrent users. ## Core concepts @@ -322,7 +324,7 @@ app.post("/chat", async (req, res) => { const session = await client.createSession({ sessionId: `user-${req.user.id}-chat`, - model: "gpt-4.1", + model: "gpt-5.4", }); const response = await session.sendAndWait({ prompt: req.body.message }); @@ -402,7 +404,7 @@ class SessionManager { // Create or resume const session = await client.createSession({ sessionId, - model: "gpt-4.1", + model: "gpt-5.4", }); this.activeSessions.set(sessionId, session); @@ -448,7 +450,7 @@ For stateless API endpoints where each request is independent: ```typescript app.post("/api/analyze", async (req, res) => { const session = await client.createSession({ - model: "gpt-4.1", + model: "gpt-5.4", }); try { @@ -473,7 +475,7 @@ app.post("/api/chat/start", async (req, res) => { const session = await client.createSession({ sessionId, - model: "gpt-4.1", + model: "gpt-5.4", infiniteSessions: { enabled: true, backgroundCompactionThreshold: 0.80, diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/README.md similarity index 100% rename from docs/troubleshooting/index.md rename to docs/troubleshooting/README.md diff --git a/docs/troubleshooting/compatibility.md b/docs/troubleshooting/compatibility.md index 89476b26f..da8bf0daa 100644 --- a/docs/troubleshooting/compatibility.md +++ b/docs/troubleshooting/compatibility.md @@ -77,17 +77,19 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b | System message | `systemMessage` config | Append or replace | | Custom provider | `provider` config | BYOK support | | Infinite sessions | `infiniteSessions` config | Auto-compaction | -| Permission handler | `onPermissionRequest` | Approve/deny requests | +| Permission handler | `onPermissionRequest` | Approve/deny requests; optionally attach a `decisionContext` for auto-approval telemetry | | User input handler | `onUserInputRequest` | Handle ask_user | | Skills | `skillDirectories` config | Custom skills | | Disabled skills | `disabledSkills` config | Disable specific skills | | Config directory | `configDir` config | Override default config location | | Client name | `clientName` config | Identify app in User-Agent | | Working directory | `workingDirectory` config | Set session cwd | +| Additional directories | `additionalDirectories` config | Grant session access beyond the working directory; re-supply on resume | | **Experimental** | | | | Agent management | `session.rpc.agent.*` | List, select, deselect, get current agent | -| Fleet mode | `session.rpc.fleet.start()` | Parallel sub-agent execution | +| Fleet mode | `session.rpc.fleet.start()` | Parallel sub-agent execution; see [Fleet mode](../features/fleet-mode.md) | | Manual compaction | `session.rpc.history.compact()` | Trigger compaction on demand | +| Context clearing | `session.rpc.history.clearContext()` | Replace conversation context from a terminal tool | | History truncation | `session.rpc.history.truncate()` | Remove events from a point onward | | Session forking | `server.rpc.sessions.fork()` | Fork a session at a point in history | @@ -170,6 +172,10 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b ## Workarounds +### Fleet mode + +Fleet mode is available through `session.rpc.fleet.start()` for SDK applications that want the runtime to dispatch parallel sub-agents for a larger objective. Use it when independent subtasks can run concurrently and then be summarized by the main session. For a full guide, see [Fleet mode](../features/fleet-mode.md). + ### Session export The `--share` option is not available via SDK. Workarounds: diff --git a/docs/troubleshooting/debugging.md b/docs/troubleshooting/debugging.md index 77f950552..588049f0d 100644 --- a/docs/troubleshooting/debugging.md +++ b/docs/troubleshooting/debugging.md @@ -292,7 +292,7 @@ var client = new CopilotClient(new CopilotClientOptions ```go client := copilot.NewClient(&copilot.ClientOptions{ - GithubToken: os.Getenv("GITHUB_TOKEN"), + GitHubToken: os.Getenv("GITHUB_TOKEN"), }) ```
@@ -303,7 +303,7 @@ var client = new CopilotClient(new CopilotClientOptions ```csharp var client = new CopilotClient(new CopilotClientOptions { - GithubToken = Environment.GetEnvironmentVariable("GITHUB_TOKEN") + GitHubToken = Environment.GetEnvironmentVariable("GITHUB_TOKEN") }); ```
diff --git a/docs/troubleshooting/mcp-debugging.md b/docs/troubleshooting/mcp-debugging.md index 664826c6e..f93f7acae 100644 --- a/docs/troubleshooting/mcp-debugging.md +++ b/docs/troubleshooting/mcp-debugging.md @@ -393,7 +393,7 @@ Create a wrapper script to log all communication: #!/bin/bash # mcp-debug-wrapper.sh -LOG="/tmp/mcp-debug-$(date +%s).log" +LOG="./mcp-debug-$(date +%s).log" ACTUAL_SERVER="$1" shift @@ -446,10 +446,10 @@ When opening an issue or asking for help, collect: * [ ] SDK language and version * [ ] CLI version (`copilot --version`) -* [ ] MCP server type (Node.js, Python, .NET, Go, Rust, etc.) +* [ ] MCP server type (Node.js, Python, .NET, Go, Rust, and more) * [ ] Full MCP server configuration (redact secrets) * [ ] Result of manual `initialize` test -* [ ] Result of manual `tools/list` test +* [ ] Result of manual `tools/list` test * [ ] Debug logs from SDK * [ ] Any error messages diff --git a/dotnet/Directory.Build.props b/dotnet/Directory.Build.props index 88c409e86..5198064b3 100644 --- a/dotnet/Directory.Build.props +++ b/dotnet/Directory.Build.props @@ -8,4 +8,9 @@ true + + $(MSBuildThisFileDirectory)Open.snk + true + + diff --git a/dotnet/Open.snk b/dotnet/Open.snk new file mode 100644 index 000000000..22a3cbd25 Binary files /dev/null and b/dotnet/Open.snk differ diff --git a/dotnet/README.md b/dotnet/README.md index 719c554f4..6efd6e094 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -2,12 +2,16 @@ SDK for programmatic control of GitHub Copilot CLI. -> **Note:** This SDK is in public preview and may change in breaking ways. +## Prerequisites + +To use the SDK, you'll need: + +- Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) ## Installation ```bash -dotnet add package GitHub.Copilot +dotnet add package GitHub.Copilot.SDK ``` ## Run the Samples @@ -33,7 +37,7 @@ using GitHub.Copilot; await using var client = new CopilotClient(); await client.StartAsync(); -// Create a session (OnPermissionRequest is optional; ApproveAll allows every tool) +// ApproveAll is only valid when managed settings are disabled. await using var session = await client.CreateSessionAsync(new SessionConfig { Model = "gpt-5", @@ -60,6 +64,12 @@ await session.SendAsync(new MessageOptions { Prompt = "What is 2+2?" }); await done.Task; ``` +When targeting MCP tools configured through `McpServers`, remember the runtime +tool name is `-`. For `AvailableTools` and +`ExcludedTools`, prefer the source-qualified form +`mcp:-`. For `CustomAgents[].Tools` and +`DefaultAgent.ExcludedTools`, use `-` directly. + ## API Reference ### CopilotClient @@ -74,7 +84,7 @@ new CopilotClient(CopilotClientOptions? options = null) - `Connection` - How to connect to the Copilot runtime. Defaults to `null` (equivalent to `RuntimeConnection.ForStdio()` with the bundled runtime). See "RuntimeConnection" below. - `LogLevel` - Runtime log level. Accepts well-known values `CopilotLogLevel.None`, `Error`, `Warning`, `Info`, `Debug`, `All`. Defaults to null (the runtime's own default). -- `WorkingDirectory` - Working directory for the runtime process. +- `WorkingDirectory` - Working directory for the runtime process. When not set, the spawned runtime inherits the calling application's current working directory. - `BaseDirectory` - Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime process. When not set, the runtime defaults to `~/.copilot`. Useful in restricted environments where only specific directories are writable. Ignored when connecting via `RuntimeConnection.ForUri(...)`. - `EnableRemoteSessions` - Enables remote-session features. - `Environment` - Environment variables to pass to the runtime process. @@ -113,7 +123,7 @@ Create a new conversation session. - `SessionId` - Custom session ID - `Model` - Model to use ("gpt-5", "claude-sonnet-4.5", etc.) -- `ReasoningEffort` - Reasoning effort level for models that support it ("low", "medium", "high", "xhigh"). Use `ListModelsAsync()` to check which models support this option. +- `ReasoningEffort` - Reasoning effort level for models that support it ("low", "medium", "high", "xhigh", "max"). Use `ListModelsAsync()` to check which models support this option. - `Tools` - Custom tool declarations exposed to the CLI. Declarations without an invocable `AIFunction` are left pending for manual resolution. - `SystemMessage` - System message customization - `AvailableTools` - List of tool names to allow @@ -121,7 +131,9 @@ Create a new conversation session. - `Provider` - Custom API provider configuration (BYOK) - `Streaming` - Enable streaming of response chunks (default: false) - `InfiniteSessions` - Configure automatic context compaction (see below) -- `OnPermissionRequest` - Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. Use `PermissionHandler.ApproveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section. +- `WorkingDirectory` - Working directory for the session. When not set, the runtime uses its own process working directory. +- `EnableSessionStore` - Enables the cross-session store for search and retrieval across sessions. When unset in `CopilotClientMode.CopilotCli`, the runtime default applies (enabled). In `CopilotClientMode.Empty`, defaults to disabled. +- `OnPermissionRequest` - Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. `PermissionHandler.ApproveAll` approves requests when managed settings are disabled and throws when `EnableManagedSettings` is true. Custom handlers can inspect `ManagedApprovalRequired` for human-facing confirmation logic. See [Permission Handling](#permission-handling) section. - `OnUserInputRequest` - Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section. - `Hooks` - Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section. @@ -285,9 +297,9 @@ The SDK supports image attachments via the `Attachments` parameter. You can atta await session.SendAsync(new MessageOptions { Prompt = "What's in this image?", - Attachments = new List + Attachments = new List { - new UserMessageDataAttachmentsItemFile + new AttachmentFile { Path = "/path/to/image.jpg", DisplayName = "image.jpg", @@ -299,9 +311,9 @@ await session.SendAsync(new MessageOptions await session.SendAsync(new MessageOptions { Prompt = "What's in this image?", - Attachments = new List + Attachments = new List { - new UserMessageDataAttachmentsItemBlob + new AttachmentBlob { Data = base64ImageData, MimeType = "image/png", @@ -412,6 +424,21 @@ When enabled, sessions emit compaction events: - `SessionCompactionStartEvent` - Background compaction started - `SessionCompactionCompleteEvent` - Compaction finished (includes token counts) +## Memory + +Sessions can opt into persistent memory, allowing the agent to read and write memory across turns. Memory is configured per session and applies to both `CreateSessionAsync` and `ResumeSessionAsync`. +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```csharp +var session = await client.CreateSessionAsync(new SessionConfig +{ + Model = "gpt-5", + Memory = new MemoryConfiguration { Enabled = true } +}); +``` + +When `Memory` is left unset, no memory configuration is sent and the runtime default applies. In the default `CopilotClientMode.CopilotCli` the SDK leaves `Memory` unset so the runtime applies its own default, while `CopilotClientMode.Empty` defaults `Memory` to disabled unless you set it explicitly. + ## Advanced Usage ### Manual Server Control @@ -506,6 +533,26 @@ var safeLookup = CopilotTool.DefineTool( If you want to use `AIFunctionFactory.Create` directly, you can set `skip_permission` in the tool's `AdditionalProperties`. +#### Deferring Tools + +Set `CopilotToolOptions.Defer` to control whether a tool may be loaded lazily via tool search rather than always pre-loaded. Use `CopilotToolDefer.Auto` to allow the tool to be deferred and surfaced through tool search, or `CopilotToolDefer.Never` to force it to always be pre-loaded. Defaults to `CopilotToolDefer.Auto`. + +```csharp +var lookupIssue = CopilotTool.DefineTool( + async ([Description("Issue ID")] string id) => { + // your logic + }, + toolOptions: new CopilotToolOptions + { + Defer = CopilotToolDefer.Auto + }, + factoryOptions: new AIFunctionFactoryOptions + { + Name = "lookup_issue", + Description = "Fetch issue details", + }); +``` + ## Commands Register 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. @@ -638,9 +685,9 @@ var session = await client.CreateSessionAsync(new SessionConfig }); ``` -Available section IDs are defined as static properties on the `SystemMessageSection` struct: `Identity`, `Tone`, `ToolEfficiency`, `EnvironmentContext`, `CodeChangeRules`, `Guidelines`, `Safety`, `ToolInstructions`, `CustomInstructions`, `RuntimeInstructions`, `LastInstructions`. +Available section IDs are defined as static properties on the `SystemMessageSection` struct: `Preamble`, `Identity`, `Tone`, `ToolEfficiency`, `EnvironmentContext`, `CodeChangeRules`, `Guidelines`, `Safety`, `ToolInstructions`, `CustomInstructions`, `RuntimeInstructions`, `LastInstructions`. `Identity` and `ToolInstructions` are section groups that target a collection of related sub-sections as a unit; use `Preamble` to target just the identity preamble. -Each 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. +Each section override supports five actions: `Replace`, `Remove`, `Append`, `Prepend`, and `Preserve` (a no-op that opts an individually-addressable section out of a group-level `Remove`). Unknown section IDs are handled gracefully: content is appended to additional instructions, and `Remove` overrides are silently ignored. #### Replace Mode @@ -675,13 +722,12 @@ await session2.SendAsync(new MessageOptions { Prompt = "Hello from session 2" }) await session.SendAsync(new MessageOptions { Prompt = "Analyze this file", - Attachments = new List + Attachments = new List { - new UserMessageDataAttachmentsItem + new AttachmentFile { - Type = UserMessageDataAttachmentsItemType.File, Path = "/path/to/file.cs", - DisplayName = "My File" + DisplayName = "My File", } } }); @@ -720,6 +766,7 @@ var client = new CopilotClient(new CopilotClientOptions **TelemetryConfig properties:** - `OtlpEndpoint` - OTLP HTTP endpoint URL +- `OtlpProtocol` - OTLP HTTP protocol for all signals (`"http/json"` or `"http/protobuf"`) - `FilePath` - File path for JSON-lines trace output - `ExporterType` - `"otlp-http"` or `"file"` - `SourceName` - Instrumentation scope name @@ -735,7 +782,7 @@ An `OnPermissionRequest` handler is optional when you create or resume a session ### Approve All (simplest) -Use the built-in `PermissionHandler.ApproveAll` helper to allow every tool call without any checks: +Use the built-in `PermissionHandler.ApproveAll` helper to approve ordinary permission requests automatically: ```csharp using GitHub.Copilot; @@ -747,9 +794,11 @@ var session = await client.CreateSessionAsync(new SessionConfig }); ``` +When `EnableManagedSettings` is true for the session, `ApproveAll` throws on the first permission request. Use a custom handler for managed sessions; request-level `ManagedApprovalRequired` remains available for human-facing confirmation logic. + ### Custom Permission Handler -Provide your own permission handler (`Func>`) to inspect each request and apply custom logic: +Provide your own permission handler (`Func>`) to inspect each request and apply custom logic. Check `ManagedApprovalRequired` before any automatic approval: ```csharp var session = await client.CreateSessionAsync(new SessionConfig @@ -757,6 +806,11 @@ var session = await client.CreateSessionAsync(new SessionConfig Model = "gpt-5", OnPermissionRequest = async (request, invocation) => { + if (request.ManagedApprovalRequired is true) + { + return PermissionDecision.NoResult(); + } + // Pattern-match on the discriminated PermissionRequest union to access // per-kind fields (FullCommandText, Path, ToolName, …). return request switch @@ -984,10 +1038,24 @@ catch (Exception ex) } ``` -## Requirements +## Development -- .NET 8.0 or later -- GitHub Copilot CLI installed and in PATH (or provide custom `Connection = RuntimeConnection.ForStdio(path: ...)`) +Development requires [.NET SDK 10+](https://dotnet.microsoft.com/download) and a supported [Node.js version](../nodejs/README.md#prerequisites). From the repository root: + +```bash +cd nodejs +npm ci +``` + +```bash +cd test/harness +npm ci +``` + +```bash +cd dotnet +dotnet test +``` ## License diff --git a/dotnet/src/BearerTokenProvider.cs b/dotnet/src/BearerTokenProvider.cs new file mode 100644 index 000000000..923c225bc --- /dev/null +++ b/dotnet/src/BearerTokenProvider.cs @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Diagnostics.CodeAnalysis; + +namespace GitHub.Copilot; + +/// +/// Arguments passed to a bearer-token callback (the BearerTokenProvider property +/// on / ) when the +/// runtime needs a fresh bearer token for a BYOK provider. +/// +/// +/// Part of the experimental managed-identity / bearer-token-provider surface and +/// may change or be removed in future SDK or CLI releases. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderTokenArgs +{ + /// + /// Name of the BYOK provider needing a token. For the singular, whole-session + /// this is the implicit provider name + /// ("default"); for entries it is + /// . + /// + /// + /// The callback closes over its own token scope/audience; the runtime is + /// provider-agnostic and forwards only the provider name. + /// + public required string ProviderName { get; init; } + + /// + /// Id of the session that triggered this token request. A client-level + /// shared callback registered for many sessions can use this to resolve the + /// owning session and scope token acquisition or caching per session. + /// + public required string SessionId { get; init; } +} diff --git a/dotnet/src/Canvas.cs b/dotnet/src/Canvas.cs index b4e63f1b3..6bf8be984 100644 --- a/dotnet/src/Canvas.cs +++ b/dotnet/src/Canvas.cs @@ -57,6 +57,32 @@ public sealed class ExtensionInfo public string Name { get; set; } = string.Empty; } +/// +/// Stable identity for a host/SDK connection that supplies built-in canvases. +/// +/// +/// When set on session create or resume, the runtime uses +/// verbatim as the agent-facing canvas extension id, so canvases declared on a +/// control connection survive stdio reconnect and CLI process restart instead +/// of being re-keyed to a per-connection id. The id is opaque to the runtime; a +/// per-window-stable value such as app:builtin:<windowId> is +/// recommended. An id beginning with connection: is reserved and ignored +/// by the runtime. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderIdentity +{ + /// + /// Opaque, stable provider id used verbatim as the canvas extension id. + /// + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Optional display name surfaced as the canvas extension name. + [JsonPropertyName("name")] + public string? Name { get; set; } +} + /// Structured exception returned from canvas handlers. /// /// Throw this from implementations to surface a diff --git a/dotnet/src/Client.cs b/dotnet/src/Client.cs index 16c02e887..58c1074c0 100644 --- a/dotnet/src/Client.cs +++ b/dotnet/src/Client.cs @@ -8,12 +8,14 @@ using Microsoft.Extensions.Logging.Abstractions; using System.Collections.Concurrent; using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Net.Sockets; using System.Runtime.ExceptionServices; using System.Runtime.InteropServices; using System.Text; using System.Text.Json; +using System.Text.Json.Nodes; using System.Text.Json.Serialization; using System.Text.RegularExpressions; @@ -58,6 +60,7 @@ public sealed partial class CopilotClient : IDisposable, IAsyncDisposable /// private const int MinProtocolVersion = 3; private static readonly TimeSpan s_stderrPumpShutdownTimeout = TimeSpan.FromSeconds(5); + private static readonly TimeSpan s_runtimeShutdownTimeout = TimeSpan.FromSeconds(10); /// /// Provides a thread-safe collection of active Copilot sessions, indexed by session identifier. @@ -73,10 +76,12 @@ public sealed partial class CopilotClient : IDisposable, IAsyncDisposable private readonly ILogger _logger; private readonly int? _optionsPort; private readonly string? _optionsHost; + private readonly string[] _builtinPluginDirectories; private readonly Func>>? _onListModels; private readonly List _lifecycleHandlers = []; private Task? _connectionTask; + private FfiRuntimeHost? _ffiHost; private bool _disposed; private int? _actualPort; private int? _negotiatedProtocolVersion; @@ -84,6 +89,13 @@ public sealed partial class CopilotClient : IDisposable, IAsyncDisposable private List? _modelsCache; private ServerRpc? _serverRpc; + /// + /// Client-global RPC handlers (e.g. the LLM inference provider adapter), + /// built once at construction when the corresponding option is configured and + /// registered on every connection. Null when no client-global API is enabled. + /// + private readonly ClientGlobalApiHandlers? _clientGlobalApis; + private sealed record LifecycleSubscription(Type EventType, Action Handler); /// @@ -126,13 +138,24 @@ private sealed record LifecycleSubscription(Type EventType, Action !IsFullyQualifiedPath(path))) + { + throw new ArgumentException( + $"{nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.BuiltinPluginDirectories)} " + + $"must contain only absolute paths: {path}", + nameof(options)); + } switch (_connection) { case StdioRuntimeConnection: break; + case InProcessRuntimeConnection: + break; + case TcpRuntimeConnection tcp: if (tcp.ConnectionToken is { Length: 0 }) { @@ -161,9 +184,13 @@ public CopilotClient(CopilotClientOptions? options = null) throw new ArgumentException($"Unsupported RuntimeConnection type: {_connection.GetType().Name}", nameof(options)); } + ValidateEnvironmentOptions(_options, _connection); + _logger = _options.Logger ?? NullLogger.Instance; _onListModels = _options.OnListModels; + _clientGlobalApis = BuildClientGlobalApis(); + // Empty mode: validate at construction time that the app supplied a // per-session persistence location. The runtime is mode-agnostic, so // without this check it would silently fall back to ~/.copilot, which @@ -187,6 +214,96 @@ _options.SessionFs is not null || } } + /// + /// Validates environment-variable options against the resolved transport. + /// Per-client environment is only representable for child-process transports + /// (each client owns its own OS process). The in-process (FFI) transport + /// loads the native runtime into the shared host process, whose single + /// environment block cannot carry per-client values, so environment and + /// telemetry options that lower to environment variables are rejected there. + /// + private static void ValidateEnvironmentOptions(CopilotClientOptions options, RuntimeConnection connection) + { + if (connection is InProcessRuntimeConnection) + { + if (options.Environment is not null) + { + throw new ArgumentException( + $"{nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.Environment)} is not supported with " + + $"{nameof(RuntimeConnection)}.{nameof(RuntimeConnection.ForInProcess)}(): the in-process transport " + + "loads the native runtime into the shared host process, whose single environment block cannot carry " + + "per-client values. Set the variables on the host process environment instead.", + nameof(options)); + } + + if (options.Telemetry is not null) + { + throw new ArgumentException( + $"{nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.Telemetry)} is not supported with " + + $"{nameof(RuntimeConnection)}.{nameof(RuntimeConnection.ForInProcess)}(): telemetry configuration is " + + "lowered to environment variables read by native runtime code running in the shared host process, so " + + "per-client telemetry cannot be honored in-process. Configure telemetry via the host process " + + "environment, or use a child-process transport.", + nameof(options)); + } + + if (options.WorkingDirectory is not null) + { + throw new ArgumentException( + $"{nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.WorkingDirectory)} is not supported with " + + $"{nameof(RuntimeConnection)}.{nameof(RuntimeConnection.ForInProcess)}(): the in-process transport hosts " + + "the native runtime in the shared host process and spawns the worker without a working-directory " + + "parameter, so a per-client working directory cannot be honored in-process. Use a child-process " + + "transport, or set the process working directory before creating the client.", + nameof(options)); + } + + return; + } + + if (connection is ChildProcessRuntimeConnection { Environment: not null } && options.Environment is not null) + { + throw new ArgumentException( + $"Set environment variables via either {nameof(CopilotClientOptions)}.{nameof(CopilotClientOptions.Environment)} " + + $"or {nameof(ChildProcessRuntimeConnection)}.{nameof(ChildProcessRuntimeConnection.Environment)}, not both. " + + $"Prefer {nameof(ChildProcessRuntimeConnection)}.{nameof(ChildProcessRuntimeConnection.Environment)} for " + + "child-process transports.", + nameof(options)); + } + } + + /// + /// Environment variable that overrides the transport used when the caller does not + /// specify . Accepts "inprocess" + /// or "stdio" (case-insensitive); unset preserves the default stdio transport. + /// Any other value is an error. Ignored when a is set + /// explicitly. + /// + internal const string DefaultConnectionEnvVar = "COPILOT_SDK_DEFAULT_CONNECTION"; + + /// + /// Resolves the default for the no-Connection case, + /// honoring . + /// + private static RuntimeConnection ResolveDefaultConnection(CopilotClientOptions options) + { + var value = options.Environment is not null + && options.Environment.TryGetValue(DefaultConnectionEnvVar, out var fromOptions) + ? fromOptions + : Environment.GetEnvironmentVariable(DefaultConnectionEnvVar); + + if (string.IsNullOrEmpty(value) || string.Equals(value, "stdio", StringComparison.OrdinalIgnoreCase)) + { + return RuntimeConnection.ForStdio(); + } + if (string.Equals(value, "inprocess", StringComparison.OrdinalIgnoreCase)) + { + return RuntimeConnection.ForInProcess(); + } + throw new ArgumentException( + $"Invalid {DefaultConnectionEnvVar} value '{value}'. Expected 'inprocess', 'stdio', or unset."); + } + /// /// Parses a runtime URL into a URI with host and port. /// @@ -209,6 +326,26 @@ private static Uri ParseRuntimeUrl(string url) return new Uri(url); } + private static bool IsFullyQualifiedPath(string path) + { + if (string.IsNullOrEmpty(path) || !Path.IsPathRooted(path)) + { + return false; + } +#if NETSTANDARD2_0 + if (Path.DirectorySeparatorChar != '\\') + { + return true; + } + + bool IsSeparator(char value) => value == '\\' || value == '/'; + return (path.Length >= 3 && path[1] == ':' && IsSeparator(path[2])) + || (path.Length >= 2 && IsSeparator(path[0]) && IsSeparator(path[1])); +#else + return Path.IsPathFullyQualified(path); +#endif + } + /// /// Starts the Copilot client and connects to the server. /// @@ -240,7 +377,56 @@ async Task StartCoreAsync(CancellationToken ct) try { - if (_connection is UriRuntimeConnection) + if (_connection is InProcessRuntimeConnection) + { + var ffiEnvironment = new Dictionary(); + if (!string.IsNullOrEmpty(_options.GitHubToken)) + { + ffiEnvironment["COPILOT_SDK_AUTH_TOKEN"] = _options.GitHubToken!; + } + if (!string.IsNullOrEmpty(_options.BaseDirectory)) + { + ffiEnvironment["COPILOT_HOME"] = _options.BaseDirectory!; + } + if (_options.Mode == CopilotClientMode.Empty) + { + ffiEnvironment["COPILOT_DISABLE_KEYTAR"] = "1"; + } + + var ffiArgs = new List(); + if (_options.LogLevel is { } logLevel && !string.IsNullOrEmpty(logLevel.Value)) + { + ffiArgs.AddRange(["--log-level", logLevel.Value]); + } + if (!string.IsNullOrEmpty(_options.GitHubToken)) + { + ffiArgs.AddRange(["--auth-token-env", "COPILOT_SDK_AUTH_TOKEN"]); + } + var useLoggedInUser = _options.UseLoggedInUser ?? string.IsNullOrEmpty(_options.GitHubToken); + if (!useLoggedInUser) + { + ffiArgs.Add("--no-auto-login"); + } + if (_options.SessionIdleTimeoutSeconds is > 0) + { + ffiArgs.AddRange(["--session-idle-timeout", _options.SessionIdleTimeoutSeconds.Value.ToString(CultureInfo.InvariantCulture)]); + } + if (_options.EnableRemoteSessions) + { + ffiArgs.Add("--remote"); + } + + var ffiHost = FfiRuntimeHost.Create( + ResolveCliPathForFfi(), + GetNapiPrebuildsFolderOrThrow(), + ffiEnvironment, + ffiArgs, + _logger); + _ffiHost = ffiHost; + await ffiHost.StartAsync(ct); + connection = await ConnectToServerAsync(null, null, null, null, ct, ffiHost); + } + else if (_connection is UriRuntimeConnection) { // External runtime _actualPort = _optionsPort; @@ -266,6 +452,13 @@ async Task StartCoreAsync(CancellationToken ct) "CopilotClient.StartAsync protocol verification complete. Elapsed={Elapsed}", startTimestamp); + if (_builtinPluginDirectories.Length > 0) + { + var request = new BuiltinPluginDirectoriesRequest(_builtinPluginDirectories); + await InvokeRpcAsync( + connection.Rpc, "plugins.builtin.set", [request], null, ct); + } + var sessionFsTimestamp = Stopwatch.GetTimestamp(); await ConfigureSessionFsAsync(ct); if (_options.SessionFs is not null) @@ -275,6 +468,8 @@ async Task StartCoreAsync(CancellationToken ct) sessionFsTimestamp); } + await ConfigureLlmInferenceAsync(ct); + LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotClient.StartAsync complete. Elapsed={Elapsed}", startTimestamp); @@ -291,7 +486,7 @@ async Task StartCoreAsync(CancellationToken ct) if (connection is not null) { - await CleanupConnectionAsync(connection, errors: null); + await CleanupConnectionAsync(connection, errors: null, gracefulRuntimeShutdown: false); } else if (cliProcess is not null) { @@ -312,6 +507,7 @@ async Task StartCoreAsync(CancellationToken ct) /// This method performs graceful cleanup: /// /// Closes all active sessions (releases in-memory resources) + /// Requests runtime shutdown for SDK-owned CLI processes /// Closes the JSON-RPC connection /// Terminates the CLI server process (if spawned by this client) /// @@ -346,7 +542,7 @@ public async Task StopAsync() _sessions.Clear(); - await CleanupConnectionAsync(errors); + await CleanupConnectionAsync(errors, gracefulRuntimeShutdown: true); ThrowErrors(errors); } @@ -378,7 +574,7 @@ public async Task ForceStopAsync() _sessions.Clear(); var errors = new List(); - await CleanupConnectionAsync(errors); + await CleanupConnectionAsync(errors, gracefulRuntimeShutdown: false); ThrowErrors(errors); } @@ -398,7 +594,7 @@ private static void ThrowErrors(List? errors) } } - private async Task CleanupConnectionAsync(List? errors) + private async Task CleanupConnectionAsync(List? errors, bool gracefulRuntimeShutdown) { var connectionTask = _connectionTask; if (connectionTask is null) @@ -419,11 +615,34 @@ private async Task CleanupConnectionAsync(List? errors) return; } - await CleanupConnectionAsync(ctx, errors); + await CleanupConnectionAsync(ctx, errors, gracefulRuntimeShutdown); } - private async Task CleanupConnectionAsync(Connection ctx, List? errors) + private async Task CleanupConnectionAsync(Connection ctx, List? errors, bool gracefulRuntimeShutdown) { + if (gracefulRuntimeShutdown && (ctx.CliProcess is not null || ctx.FfiHost is not null)) + { + var runtimeShutdownTimestamp = Stopwatch.GetTimestamp(); + try + { + using var cancellation = new CancellationTokenSource(s_runtimeShutdownTimeout); + await ctx.Server.Runtime.ShutdownAsync(cancellation.Token); + LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, + "CopilotClient.StopAsync runtime shutdown complete. Elapsed={Elapsed}", + runtimeShutdownTimestamp); + } + catch (Exception ex) when (ex is OperationCanceledException + or InvalidOperationException + or ObjectDisposedException + or IOException + or SocketException) + { + LoggingHelpers.LogTiming(_logger, LogLevel.Debug, ex, + "CopilotClient.StopAsync runtime shutdown failed. Elapsed={Elapsed}", + runtimeShutdownTimestamp); + } + } + try { ctx.Rpc.Dispose(); } catch (Exception ex) { AddCleanupError(errors, ex, _logger); } @@ -441,6 +660,13 @@ private async Task CleanupConnectionAsync(Connection ctx, List? error { await CleanupCliProcessAsync(childProcess, ctx.StderrPump, errors, _logger); } + + if (ctx.FfiHost is { } ffiHost) + { + try { ffiHost.Dispose(); } + catch (Exception ex) { AddCleanupError(errors, ex, _logger); } + _ffiHost = null; + } } private static async Task CleanupCliProcessAsync(Process childProcess, ProcessStderrPump? stderrPump, List? errors, ILogger? logger) @@ -451,10 +677,32 @@ private static async Task CleanupCliProcessAsync(Process childProcess, ProcessSt { if (!childProcess.HasExited) { + // The runtime completes all cleanup before responding to + // runtime.shutdown and then leaves termination to us; it + // deliberately keeps its JSON-RPC server alive to send the + // response and never self-exits. Waiting for a self-exit that + // will never come just wastes time, so terminate the child + // immediately and only wait to reap it. childProcess.Kill(entireProcessTree: true); // Kill is asynchronous; wait for the root CLI process to exit so cleanup callers // do not observe StopAsync/DisposeAsync completion while it is still tearing down. - await childProcess.WaitForExitAsync(); + var killWaitTimestamp = Stopwatch.GetTimestamp(); + try + { + await childProcess.WaitForExitAsync().WaitAsync(s_runtimeShutdownTimeout); + } + catch (TimeoutException ex) + { + if (logger is not null) + { + LoggingHelpers.LogTiming(logger, LogLevel.Debug, ex, + "Timed out waiting for runtime process to exit after kill. Elapsed={Elapsed}, Timeout={Timeout}", + killWaitTimestamp, + s_runtimeShutdownTimeout); + } + + AddCleanupError(errors, ex, logger); + } } } catch (Exception ex) @@ -571,7 +819,10 @@ private CopilotSession InitializeSession( _logger, this); session.RegisterTools(config.Tools ?? []); - session.RegisterPermissionHandler(config.OnPermissionRequest); + session.RegisterPermissionHandler( + config.OnPermissionRequest, + config.EnableManagedSettings is true || config.ManagedSettings is not null); + session.RegisterMcpAuthHandler(config.OnMcpAuthRequest); session.RegisterCommands(config.Commands); session.RegisterElicitationHandler(config.OnElicitationRequest); session.RegisterExitPlanModeHandler(config.OnExitPlanModeRequest); @@ -594,6 +845,7 @@ private CopilotSession InitializeSession( } ConfigureSessionFsHandlers(session, config.CreateSessionFsProvider); session.SetCanvasHandler(config.CanvasHandler); + session.RegisterBearerTokenProviders(BuildBearerTokenCallbacks(config)); RegisterSession(session); session.StartProcessingEvents(); LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, @@ -606,6 +858,34 @@ private CopilotSession InitializeSession( return session; } + /// + /// Implicit provider name for the singular, whole-session . + /// + private const string DefaultBearerTokenProviderName = "default"; + + /// + /// Collects the per-provider BearerTokenProvider callbacks keyed by + /// provider name for session-side registration. The singular, whole-session + /// uses the implicit + /// . + /// + private static Dictionary>> BuildBearerTokenCallbacks(SessionConfigBase config) + { + var callbacks = new Dictionary>>(StringComparer.Ordinal); + if (config.Provider?.BearerTokenProvider is { } singular) + { + callbacks[DefaultBearerTokenProviderName] = singular; + } + if (config.Providers != null) + { + foreach (var provider in config.Providers.Where(provider => provider.BearerTokenProvider is not null)) + { + callbacks[provider.Name] = provider.BearerTokenProvider!; + } + } + return callbacks; + } + /// /// Catches misuse of / /// at the SDK boundary so @@ -664,6 +944,7 @@ private void ApplyConfigDefaultsForMode(SessionConfigBase config) { if (_options.Mode == CopilotClientMode.Empty) { + config.EnableExperimentalMode ??= false; config.EnableSessionTelemetry ??= false; config.SkipEmbeddingRetrieval ??= true; config.EmbeddingCacheStorage ??= EmbeddingCacheStorageMode.InMemory; @@ -672,7 +953,9 @@ private void ApplyConfigDefaultsForMode(SessionConfigBase config) config.EnableHostGitOperations ??= false; config.EnableSessionStore ??= false; config.EnableSkills ??= false; + config.Memory ??= new MemoryConfiguration { Enabled = false }; config.McpOAuthTokenStorage ??= McpOAuthTokenStorageMode.InMemory; + config.CustomAgentsLocalOnly ??= true; } } @@ -850,9 +1133,11 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.Hooks.OnPostToolUse != null || config.Hooks.OnPostToolUseFailure != null || config.Hooks.OnUserPromptSubmitted != null || + config.Hooks.OnUserPromptTransformed != null || config.Hooks.OnSessionStart != null || config.Hooks.OnSessionEnd != null || - config.Hooks.OnErrorOccurred != null); + config.Hooks.OnErrorOccurred != null || + config.Hooks.OnAgentStop != null); var (wireSystemMessage, transformCallbacks) = ExtractTransformCallbacks(config.SystemMessage); @@ -891,11 +1176,16 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.ReasoningSummary, config.ContextTier, config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(), + config.EnableCitations, + config.EnableFileChangeTracking, wireSystemMessage, toolFilter.AvailableTools, toolFilter.ExcludedTools, + config.ExcludedBuiltInAgents, config.Provider, + config.Capi, config.EnableSessionTelemetry, + config.EnableExperimentalMode, config.OnPermissionRequest != null ? true : null, config.OnUserInputRequest != null ? true : null, config.OnExitPlanModeRequest != null ? true : null, @@ -912,6 +1202,7 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.Agent, config.ConfigDirectory, config.EnableConfigDiscovery, + config.CustomAgentsLocalOnly, config.SkipEmbeddingRetrieval, config.EmbeddingCacheStorage, config.OrganizationCustomInstructions, @@ -923,6 +1214,7 @@ public async Task CreateSessionAsync(SessionConfig config, Cance config.SkillDirectories, config.DisabledSkills, config.InfiniteSessions, + config.SessionLimits, Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(), RequestElicitation: config.OnElicitationRequest != null, RequestMcpApps: config.EnableMcpApps ? true : null, @@ -934,13 +1226,25 @@ public async Task CreateSessionAsync(SessionConfig config, Cance Cloud: config.Cloud, InstructionDirectories: config.InstructionDirectories, PluginDirectories: config.PluginDirectories, + DisabledMcpServers: config.DisabledMcpServers, LargeOutput: config.LargeOutput, + ToolSearch: config.ToolSearch, + Memory: config.Memory, Canvases: config.Canvases, RequestCanvasRenderer: config.RequestCanvasRenderer, RequestExtensions: config.RequestExtensions, ExtensionSdkPath: config.ExtensionSdkPath, ExtensionInfo: config.ExtensionInfo, - ToolFilterPrecedence: toolFilter.ToolFilterPrecedence); + CanvasProvider: config.CanvasProvider, + Providers: config.Providers, + Models: config.Models, + ToolFilterPrecedence: toolFilter.ToolFilterPrecedence, + ExpAssignments: config.ExpAssignments, + EnableManagedSettings: config.EnableManagedSettings, + GitHubMcpToolConfig: config.GitHubMcpToolConfig, + ManagedSettings: config.ManagedSettings, + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); @@ -987,6 +1291,11 @@ public async Task CreateSessionAsync(SessionConfig config, Cance $"session.create returned sessionId {response.SessionId} but the caller requested {localSessionId}."); } + if (config.OnMcpAuthRequest is not null) + { + await session.Rpc.EventLog.RegisterInterestAsync("mcp.oauth_required", cancellationToken); + } + session.WorkspacePath = response.WorkspacePath; session.SetCapabilities(response.Capabilities); session.SetOpenCanvases(response.OpenCanvases); @@ -1058,9 +1367,11 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.Hooks.OnPostToolUse != null || config.Hooks.OnPostToolUseFailure != null || config.Hooks.OnUserPromptSubmitted != null || + config.Hooks.OnUserPromptTransformed != null || config.Hooks.OnSessionStart != null || config.Hooks.OnSessionEnd != null || - config.Hooks.OnErrorOccurred != null); + config.Hooks.OnErrorOccurred != null || + config.Hooks.OnAgentStop != null); var (wireSystemMessage, transformCallbacks) = ExtractTransformCallbacks(config.SystemMessage); @@ -1073,7 +1384,6 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes transformCallbacks, hasHooks, "CopilotClient.ResumeSessionAsync"); - try { var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext(); @@ -1086,11 +1396,16 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.ReasoningSummary, config.ContextTier, config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(), + config.EnableCitations, + config.EnableFileChangeTracking, wireSystemMessage, toolFilter.AvailableTools, toolFilter.ExcludedTools, + config.ExcludedBuiltInAgents, config.Provider, + config.Capi, config.EnableSessionTelemetry, + config.EnableExperimentalMode, config.OnPermissionRequest != null ? true : null, config.OnUserInputRequest != null ? true : null, config.OnExitPlanModeRequest != null ? true : null, @@ -1099,6 +1414,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.WorkingDirectory, config.ConfigDirectory, config.EnableConfigDiscovery, + config.CustomAgentsLocalOnly, config.SkipEmbeddingRetrieval, config.EmbeddingCacheStorage, config.OrganizationCustomInstructions, @@ -1119,6 +1435,7 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes config.SkillDirectories, config.DisabledSkills, config.InfiniteSessions, + config.SessionLimits, Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(), RequestElicitation: config.OnElicitationRequest != null, RequestMcpApps: config.EnableMcpApps ? true : null, @@ -1130,14 +1447,26 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes ContinuePendingWork: config.ContinuePendingWork, InstructionDirectories: config.InstructionDirectories, PluginDirectories: config.PluginDirectories, + DisabledMcpServers: config.DisabledMcpServers, LargeOutput: config.LargeOutput, + ToolSearch: config.ToolSearch, + Memory: config.Memory, Canvases: config.Canvases, RequestCanvasRenderer: config.RequestCanvasRenderer, RequestExtensions: config.RequestExtensions, ExtensionSdkPath: config.ExtensionSdkPath, ExtensionInfo: config.ExtensionInfo, + CanvasProvider: config.CanvasProvider, OpenCanvases: config.OpenCanvases, - ToolFilterPrecedence: toolFilter.ToolFilterPrecedence); + Providers: config.Providers, + Models: config.Models, + ToolFilterPrecedence: toolFilter.ToolFilterPrecedence, + ExpAssignments: config.ExpAssignments, + EnableManagedSettings: config.EnableManagedSettings, + GitHubMcpToolConfig: config.GitHubMcpToolConfig, + ManagedSettings: config.ManagedSettings, + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); var response = await InvokeRpcAsync( @@ -1151,6 +1480,11 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes session.SetCapabilities(response.Capabilities); session.SetOpenCanvases(response.OpenCanvases); + if (config.OnMcpAuthRequest is not null) + { + await session.Rpc.EventLog.RegisterInterestAsync("mcp.oauth_required", cancellationToken); + } + await UpdateSessionOptionsForModeAsync(session, config, cancellationToken).ConfigureAwait(false); } catch (Exception ex) @@ -1572,6 +1906,11 @@ private static string FormatCliExitedMessage(string message, string stderrOutput Message = "CopilotClient.ConnectToServerAsync connecting to CLI server. Host={Host}, Port={Port}")] private static partial void LogConnectingToCliServer(ILogger logger, string host, int port); + [LoggerMessage( + Level = LogLevel.Warning, + Message = "[CLI] {Line}")] + private static partial void LogCliStderrLine(ILogger logger, string line); + private static IOException CreateCliExitedException(string message, StringBuilder stderrBuffer) { string stderrOutput; @@ -1604,6 +1943,42 @@ await Rpc.SessionFs.SetProviderAsync( cancellationToken: cancellationToken); } + /// + /// Builds the client-global RPC handler bag at construction time. Registers + /// the LLM inference provider adapter and/or the GitHub telemetry adapter + /// depending on which options are configured; returns null when no + /// client-global API is configured so the registration is skipped entirely. + /// + private ClientGlobalApiHandlers? BuildClientGlobalApis() + { + var handler = _options.RequestHandler; + var onGitHubTelemetry = _options.OnGitHubTelemetry; + if (handler is null && onGitHubTelemetry is null) + { + return null; + } + + return new ClientGlobalApiHandlers + { + LlmInference = handler is null ? null : new LlmInferenceAdapter(handler, () => _serverRpc), + GitHubTelemetry = onGitHubTelemetry is null ? null : new GitHubTelemetryAdapter(onGitHubTelemetry, _logger), + }; + } + + /// + /// Tells the runtime to route its outbound model-layer requests through this + /// client's LLM inference provider. No-op when interception is not configured. + /// + private async Task ConfigureLlmInferenceAsync(CancellationToken cancellationToken) + { + if (_clientGlobalApis?.LlmInference is null) + { + return; + } + + await Rpc.LlmInference.SetProviderAsync(cancellationToken); + } + private void ConfigureSessionFsHandlers(CopilotSession session, Func? createSessionFsHandler) { if (_options.SessionFs is null) @@ -1637,14 +2012,26 @@ private async Task VerifyProtocolVersionAsync(Connection connection, Cancellatio int? serverVersion; try { - var token = _connection switch - { - TcpRuntimeConnection tcp => tcp.ConnectionToken, - UriRuntimeConnection uri => uri.ConnectionToken, - _ => null, - }; + var token = _ffiHost is not null + ? null // FFI hosting is an ungated in-process connection; no token. + : _connection switch + { + TcpRuntimeConnection tcp => tcp.ConnectionToken, + UriRuntimeConnection uri => uri.ConnectionToken, + _ => null, + }; var connectResponse = await InvokeRpcAsync( - connection.Rpc, "connect", [new ConnectRequest { Token = token }], connection.StderrBuffer, cancellationToken); + connection.Rpc, + "connect", + [new ConnectHandshakeRequest( + token, + // Opt in to GitHub telemetry forwarding at the connection level when a + // handler is registered (mirrors the runtime, which reads this flag on the + // `connect` handshake so the first session's un-replayable `session.start` + // event is forwarded). Also sent on session.create/resume for older CLIs. + _options.OnGitHubTelemetry != null ? true : null)], + connection.StderrBuffer, + cancellationToken); serverVersion = (int)connectResponse.ProtocolVersion; } catch (IOException ex) when (ex.InnerException is RemoteRpcException remoteEx && IsUnsupportedConnectMethod(remoteEx)) @@ -1687,6 +2074,25 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) || string.Equals(ex.Message, "Unhandled method connect", StringComparison.Ordinal); } + // Applies the telemetry-derived environment variables the runtime reads to + // enable OTLP export. Shared by the stdio/tcp child-process path and the + // in-process FFI path so telemetry behaves identically across transports. + private static void ApplyTelemetryEnvironment(IDictionary environment, TelemetryConfig? telemetry) + { + if (telemetry is null) + { + return; + } + + environment["COPILOT_OTEL_ENABLED"] = "true"; + if (telemetry.OtlpEndpoint is not null) environment["OTEL_EXPORTER_OTLP_ENDPOINT"] = telemetry.OtlpEndpoint; + if (telemetry.OtlpProtocol is not null) environment["OTEL_EXPORTER_OTLP_PROTOCOL"] = telemetry.OtlpProtocol; + if (telemetry.FilePath is not null) environment["COPILOT_OTEL_FILE_EXPORTER_PATH"] = telemetry.FilePath; + if (telemetry.ExporterType is not null) environment["COPILOT_OTEL_EXPORTER_TYPE"] = telemetry.ExporterType; + if (telemetry.SourceName is not null) environment["COPILOT_OTEL_SOURCE_NAME"] = telemetry.SourceName; + if (telemetry.CaptureContent is { } capture) environment["OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"] = capture ? "true" : "false"; + } + private async Task<(Process Process, int? DetectedLocalhostTcpPort, ProcessStderrPump StderrPump)> StartCliServerAsync(CancellationToken cancellationToken) { var options = _options; @@ -1695,9 +2101,12 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) var tcpConnection = _connection as TcpRuntimeConnection; var useStdio = _connection is StdioRuntimeConnection; - // Use explicit path, COPILOT_CLI_PATH env var (from options.Environment or process env), or bundled runtime - no PATH fallback - var envCliPath = options.Environment is not null && options.Environment.TryGetValue("COPILOT_CLI_PATH", out var envValue) ? envValue - : System.Environment.GetEnvironmentVariable("COPILOT_CLI_PATH"); + // Use explicit path, COPILOT_CLI_PATH env var (from the connection's + // Environment, options.Environment, or process env), or bundled runtime - no PATH fallback + var envCliPath = + (childProcessConnection.Environment is not null && childProcessConnection.Environment.TryGetValue("COPILOT_CLI_PATH", out var connEnvValue) ? connEnvValue : null) + ?? (options.Environment is not null && options.Environment.TryGetValue("COPILOT_CLI_PATH", out var envValue) ? envValue : null) + ?? System.Environment.GetEnvironmentVariable("COPILOT_CLI_PATH"); var cliPath = childProcessConnection.Path ?? envCliPath ?? GetBundledCliPath(out var searchedPath) @@ -1764,10 +2173,11 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) CreateNoWindow = true }; - if (options.Environment != null) + var childEnvironment = options.Environment ?? childProcessConnection.Environment; + if (childEnvironment != null) { startInfo.Environment.Clear(); - foreach (var (key, value) in options.Environment) + foreach (var (key, value) in childEnvironment) { startInfo.Environment[key] = value; } @@ -1801,15 +2211,7 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) } // Set telemetry environment variables if configured - if (options.Telemetry is { } telemetry) - { - startInfo.Environment["COPILOT_OTEL_ENABLED"] = "true"; - if (telemetry.OtlpEndpoint is not null) startInfo.Environment["OTEL_EXPORTER_OTLP_ENDPOINT"] = telemetry.OtlpEndpoint; - if (telemetry.FilePath is not null) startInfo.Environment["COPILOT_OTEL_FILE_EXPORTER_PATH"] = telemetry.FilePath; - if (telemetry.ExporterType is not null) startInfo.Environment["COPILOT_OTEL_EXPORTER_TYPE"] = telemetry.ExporterType; - if (telemetry.SourceName is not null) startInfo.Environment["COPILOT_OTEL_SOURCE_NAME"] = telemetry.SourceName; - if (telemetry.CaptureContent is { } capture) startInfo.Environment["OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"] = capture ? "true" : "false"; - } + ApplyTelemetryEnvironment(startInfo.Environment, options.Telemetry); var cliProcess = new Process { StartInfo = startInfo }; try @@ -1904,7 +2306,12 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) { string os; if (OperatingSystem.IsWindows()) os = "win"; - else if (OperatingSystem.IsLinux()) os = "linux"; + else if (OperatingSystem.IsLinux()) + { + os = RuntimeInformation.RuntimeIdentifier.StartsWith("linux-musl-", StringComparison.Ordinal) + ? "linux-musl" + : "linux"; + } else if (OperatingSystem.IsMacOS()) os = "osx"; else return null; @@ -1918,6 +2325,62 @@ private static bool IsUnsupportedConnectMethod(RemoteRpcException ex) return arch != null ? $"{os}-{arch}" : null; } + private string ResolveCliPathForFfi() + { + var envCliPath = _options.Environment is not null && _options.Environment.TryGetValue("COPILOT_CLI_PATH", out var envValue) + ? envValue + : System.Environment.GetEnvironmentVariable("COPILOT_CLI_PATH"); + if (!string.IsNullOrEmpty(envCliPath)) + { + return envCliPath; + } + + // Fall back to the bundled single-file CLI the same way stdio discovers it. + // It embeds its own Node and is spawned directly as `copilot --embedded-host`, + // with the sibling cdylib loaded in-process (FfiRuntimeHost.Create prefers the + // flat `libcopilot_runtime.so`/`copilot_runtime.dll` next to the CLI, falling + // back to the dev `prebuilds//runtime.node` layout). + var bundled = GetBundledCliPath(out var searchedPath); + return bundled + ?? throw new InvalidOperationException( + "In-process FFI hosting requires the Copilot CLI. Set the COPILOT_CLI_PATH " + + $"environment variable, or ensure the bundled CLI is present (looked in '{searchedPath}')."); + } + + /// + /// Returns the napi-rs prebuilds folder name for the current host — the + /// <node-platform>-<arch> convention (e.g. win32-x64, + /// darwin-arm64, linux-x64) under which the runtime ships + /// prebuilds/<folder>/runtime.node. This differs from the .NET RID + /// (win-x64/osx-x64) for Windows and macOS. + /// + private static string? GetNapiPrebuildsFolder() + { + string platform; + if (OperatingSystem.IsWindows()) platform = "win32"; + else if (OperatingSystem.IsLinux()) + { + platform = RuntimeInformation.RuntimeIdentifier.StartsWith("linux-musl-", StringComparison.Ordinal) + ? "linuxmusl" + : "linux"; + } + else if (OperatingSystem.IsMacOS()) platform = "darwin"; + else return null; + + var arch = System.Runtime.InteropServices.RuntimeInformation.OSArchitecture switch + { + System.Runtime.InteropServices.Architecture.X64 => "x64", + System.Runtime.InteropServices.Architecture.Arm64 => "arm64", + _ => null, + }; + + return arch != null ? $"{platform}-{arch}" : null; + } + + private static string GetNapiPrebuildsFolderOrThrow() => + GetNapiPrebuildsFolder() + ?? throw new InvalidOperationException("Could not determine a napi-rs prebuilds folder for FFI hosting."); + private static (string FileName, IEnumerable Args) ResolveCliCommand(string cliPath, IEnumerable args) { var isJsFile = cliPath.EndsWith(".js", StringComparison.OrdinalIgnoreCase); @@ -1930,7 +2393,7 @@ private static (string FileName, IEnumerable Args) ResolveCliCommand(str return (cliPath, args); } - private async Task ConnectToServerAsync(Process? cliProcess, string? tcpHost, int? tcpPort, ProcessStderrPump? stderrPump, CancellationToken cancellationToken) + private async Task ConnectToServerAsync(Process? cliProcess, string? tcpHost, int? tcpPort, ProcessStderrPump? stderrPump, CancellationToken cancellationToken, FfiRuntimeHost? ffiHost = null) { var setupTimestamp = Stopwatch.GetTimestamp(); NetworkStream? networkStream = null; @@ -1940,7 +2403,12 @@ private async Task ConnectToServerAsync(Process? cliProcess, string? { Stream inputStream, outputStream; - if (_connection is StdioRuntimeConnection) + if (ffiHost is not null) + { + inputStream = ffiHost.ReceiveStream; + outputStream = ffiHost.SendStream; + } + else if (_connection is StdioRuntimeConnection) { if (cliProcess == null) { @@ -1997,14 +2465,19 @@ private async Task ConnectToServerAsync(Process? cliProcess, string? var session = GetSession(sessionId) ?? throw new ArgumentException($"Unknown session {sessionId}"); return session.ClientSessionApis; }); + if (_clientGlobalApis is not null) + { + ClientGlobalApiRegistration.RegisterClientGlobalApiHandlers(rpc, _clientGlobalApis); + } rpc.StartListening(); LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotClient.ConnectToServerAsync transport setup complete. Elapsed={Elapsed}", setupTimestamp); - _serverRpc = new ServerRpc(rpc); + var connection = new Connection(rpc, cliProcess, networkStream, stderrPump, ffiHost); + _serverRpc = connection.Server; - return new Connection(rpc, cliProcess, networkStream, stderrPump); + return connection; } catch { @@ -2090,13 +2563,15 @@ public void Dispose() /// /// A representing the asynchronous dispose operation. /// - /// This method calls to immediately release all resources. + /// This method calls to gracefully shut down the runtime and + /// release all resources. Use for an immediate hard stop + /// that skips graceful runtime shutdown. /// public async ValueTask DisposeAsync() { if (_disposed) return; _disposed = true; - await ForceStopAsync(); + await StopAsync(); } private class RpcHandler(CopilotClient client) @@ -2204,13 +2679,16 @@ private class Connection( JsonRpc rpc, Process? cliProcess, // Set if we created the child process NetworkStream? networkStream, // Set if using TCP - ProcessStderrPump? stderrPump = null) // Captures stderr for error messages + ProcessStderrPump? stderrPump = null, // Captures stderr for error messages + FfiRuntimeHost? ffiHost = null) // Set if using in-process FFI hosting { public Process? CliProcess => cliProcess; public JsonRpc Rpc => rpc; + public ServerRpc Server => field ?? Interlocked.CompareExchange(ref field, new(rpc), null) ?? field; public NetworkStream? NetworkStream => networkStream; public ProcessStderrPump? StderrPump => stderrPump; public StringBuilder? StderrBuffer => stderrPump?.Buffer; + public FfiRuntimeHost? FfiHost => ffiHost; } private sealed class ProcessStderrPump @@ -2245,7 +2723,7 @@ private async Task PumpAsync(Process process, ILogger logger, CancellationToken Buffer.AppendLine(line); } - logger.LogWarning("[CLI] {Line}", line); + LogCliStderrLine(logger, line); } } catch (Exception e) when (cancellationToken.IsCancellationRequested @@ -2278,11 +2756,16 @@ internal record CreateSessionRequest( ReasoningSummary? ReasoningSummary, ContextTier? ContextTier, IList? Tools, + bool? EnableCitations, + bool? EnableFileChangeTracking, SystemMessageConfig? SystemMessage, IList? AvailableTools, IList? ExcludedTools, + [property: JsonPropertyName("excludedBuiltinAgents")] IList? ExcludedBuiltInAgents, ProviderConfig? Provider, + CapiSessionOptions? Capi, bool? EnableSessionTelemetry, + bool? IsExperimentalMode, bool? RequestPermission, bool? RequestUserInput, bool? RequestExitPlanMode, @@ -2299,6 +2782,7 @@ internal record CreateSessionRequest( string? Agent, [property: JsonPropertyName("configDir")] string? ConfigDirectory, bool? EnableConfigDiscovery, + [property: JsonPropertyName("customAgentsLocalOnly")] bool? CustomAgentsLocalOnly, bool? SkipEmbeddingRetrieval, EmbeddingCacheStorageMode? EmbeddingCacheStorage, string? OrganizationCustomInstructions, @@ -2310,6 +2794,7 @@ internal record CreateSessionRequest( IList? SkillDirectories, IList? DisabledSkills, InfiniteSessionConfig? InfiniteSessions, + SessionLimitsConfig? SessionLimits, IList? Commands = null, bool? RequestElicitation = null, bool? RequestMcpApps = null, @@ -2321,14 +2806,26 @@ internal record CreateSessionRequest( CloudSessionOptions? Cloud = null, IList? InstructionDirectories = null, IList? PluginDirectories = null, + [property: JsonPropertyName("disabledMcpServers")] IList? DisabledMcpServers = null, LargeToolOutputConfig? LargeOutput = null, + ToolSearchConfig? ToolSearch = null, + MemoryConfiguration? Memory = null, #pragma warning disable GHCP001 IList? Canvases = null, bool? RequestCanvasRenderer = null, bool? RequestExtensions = null, string? ExtensionSdkPath = null, ExtensionInfo? ExtensionInfo = null, - OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null); + CanvasProviderIdentity? CanvasProvider = null, + IList? Providers = null, + IList? Models = null, + OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null, + [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, + [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, + [property: JsonPropertyName("managedSettings")] ManagedSettings? ManagedSettings = null, + bool? EnableGitHubTelemetryForwarding = null, + [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null, + IList? AdditionalDirectories = null); #pragma warning restore GHCP001 internal record ToolDefinition( @@ -2336,15 +2833,24 @@ internal record ToolDefinition( string? Description, JsonElement Parameters, /* JSON schema */ bool? OverridesBuiltInTool = null, - bool? SkipPermission = null) + bool? SkipPermission = null, + CopilotToolDefer? Defer = null, + IDictionary? Metadata = null, + bool? IsTerminal = null) { public static ToolDefinition FromAIFunction(AIFunctionDeclaration function) { var overrides = function.AdditionalProperties.TryGetValue(CopilotTool.OverridesBuiltInToolKey, out var val) && val is true; var skipPerm = function.AdditionalProperties.TryGetValue(CopilotTool.SkipPermissionKey, out var skipVal) && skipVal is true; + var defer = function.AdditionalProperties.TryGetValue(CopilotTool.DeferKey, out var deferVal) && deferVal is CopilotToolDefer d ? d : (CopilotToolDefer?)null; + var metadata = function.AdditionalProperties.TryGetValue(CopilotTool.MetadataKey, out var metaVal) && metaVal is IDictionary m ? m : null; + var isTerminal = function.AdditionalProperties.TryGetValue(CopilotTool.IsTerminalKey, out var terminalVal) && terminalVal is true; return new ToolDefinition(function.Name, function.Description, function.JsonSchema, overrides ? true : null, - skipPerm ? true : null); + skipPerm ? true : null, + defer, + metadata, + isTerminal ? true : null); } } @@ -2364,11 +2870,16 @@ internal record ResumeSessionRequest( ReasoningSummary? ReasoningSummary, ContextTier? ContextTier, IList? Tools, + bool? EnableCitations, + bool? EnableFileChangeTracking, SystemMessageConfig? SystemMessage, IList? AvailableTools, IList? ExcludedTools, + [property: JsonPropertyName("excludedBuiltinAgents")] IList? ExcludedBuiltInAgents, ProviderConfig? Provider, + CapiSessionOptions? Capi, bool? EnableSessionTelemetry, + bool? IsExperimentalMode, bool? RequestPermission, bool? RequestUserInput, bool? RequestExitPlanMode, @@ -2377,6 +2888,7 @@ internal record ResumeSessionRequest( string? WorkingDirectory, [property: JsonPropertyName("configDir")] string? ConfigDirectory, bool? EnableConfigDiscovery, + [property: JsonPropertyName("customAgentsLocalOnly")] bool? CustomAgentsLocalOnly, bool? SkipEmbeddingRetrieval, EmbeddingCacheStorageMode? EmbeddingCacheStorage, string? OrganizationCustomInstructions, @@ -2385,7 +2897,7 @@ internal record ResumeSessionRequest( bool? EnableHostGitOperations, bool? EnableSessionStore, bool? EnableSkills, - bool? SuppressResumeEvent, + [property: JsonPropertyName("disableResume")] bool? SuppressResumeEvent, bool? Streaming, bool? IncludeSubAgentStreamingEvents, IDictionary? McpServers, @@ -2397,6 +2909,7 @@ internal record ResumeSessionRequest( IList? SkillDirectories, IList? DisabledSkills, InfiniteSessionConfig? InfiniteSessions, + SessionLimitsConfig? SessionLimits, IList? Commands = null, bool? RequestElicitation = null, bool? RequestMcpApps = null, @@ -2408,15 +2921,27 @@ internal record ResumeSessionRequest( bool? ContinuePendingWork = null, IList? InstructionDirectories = null, IList? PluginDirectories = null, + [property: JsonPropertyName("disabledMcpServers")] IList? DisabledMcpServers = null, LargeToolOutputConfig? LargeOutput = null, + ToolSearchConfig? ToolSearch = null, + MemoryConfiguration? Memory = null, #pragma warning disable GHCP001 IList? Canvases = null, bool? RequestCanvasRenderer = null, bool? RequestExtensions = null, string? ExtensionSdkPath = null, ExtensionInfo? ExtensionInfo = null, + CanvasProviderIdentity? CanvasProvider = null, IList? OpenCanvases = null, - OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null); + IList? Providers = null, + IList? Models = null, + OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence = null, + [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, + [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, + [property: JsonPropertyName("managedSettings")] ManagedSettings? ManagedSettings = null, + bool? EnableGitHubTelemetryForwarding = null, + [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null, + IList? AdditionalDirectories = null); #pragma warning restore GHCP001 internal record ResumeSessionResponse( @@ -2453,6 +2978,13 @@ internal record GetSessionMetadataRequest( internal record GetSessionMetadataResponse( SessionMetadata? Session); + internal record ConnectHandshakeRequest( + string? Token, + [property: JsonPropertyName("enableGitHubTelemetryForwarding")] bool? EnableGitHubTelemetryForwarding = null); + + internal record BuiltinPluginDirectoriesRequest( + string[] Paths); + internal record SetForegroundSessionRequest( string SessionId); @@ -2487,10 +3019,16 @@ internal record HooksInvokeResponse( [JsonSerializable(typeof(ListSessionsResponse))] [JsonSerializable(typeof(GetSessionMetadataRequest))] [JsonSerializable(typeof(GetSessionMetadataResponse))] + [JsonSerializable(typeof(ConnectHandshakeRequest))] + [JsonSerializable(typeof(BuiltinPluginDirectoriesRequest))] [JsonSerializable(typeof(McpOAuthTokenStorageMode))] [JsonSerializable(typeof(EmbeddingCacheStorageMode))] [JsonSerializable(typeof(ModelCapabilitiesOverride))] [JsonSerializable(typeof(ProviderConfig))] + [JsonSerializable(typeof(CapiSessionOptions))] + [JsonSerializable(typeof(NamedProviderConfig))] + [JsonSerializable(typeof(ProviderModelConfig))] + [JsonSerializable(typeof(SessionLimitsConfig))] [JsonSerializable(typeof(ResumeSessionRequest))] [JsonSerializable(typeof(ResumeSessionResponse))] [JsonSerializable(typeof(SessionCapabilities))] @@ -2501,6 +3039,7 @@ internal record HooksInvokeResponse( [JsonSerializable(typeof(SystemMessageTransformRpcResponse))] [JsonSerializable(typeof(CommandWireDefinition))] [JsonSerializable(typeof(ToolDefinition))] + [JsonSerializable(typeof(CopilotToolDefer))] [JsonSerializable(typeof(ToolResultAIContent))] [JsonSerializable(typeof(ToolResultObject))] [JsonSerializable(typeof(UserInputRequestResponse))] @@ -2530,3 +3069,28 @@ public sealed class ToolResultAIContent(ToolResultObject toolResult) : AIContent /// public ToolResultObject Result => toolResult; } + +/// +/// Bridges the generated client-global handler to +/// the public OnGitHubTelemetry callback, forwarding the generated +/// payload unchanged. +/// +[Experimental(Diagnostics.Experimental)] +internal sealed class GitHubTelemetryAdapter(Func callback, ILogger logger) : Rpc.IGitHubTelemetryHandler +{ + private readonly Func _callback = callback ?? throw new ArgumentNullException(nameof(callback)); + private readonly ILogger _logger = logger ?? NullLogger.Instance; + + public async Task EventAsync(Rpc.GitHubTelemetryNotification request, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(request); + try + { + await _callback(request).ConfigureAwait(false); + } + catch (Exception ex) + { + _logger.LogWarning(ex, "Error handling gitHubTelemetry.event notification"); + } + } +} diff --git a/dotnet/src/CopilotRequestHandler.cs b/dotnet/src/CopilotRequestHandler.cs new file mode 100644 index 000000000..514d77da6 --- /dev/null +++ b/dotnet/src/CopilotRequestHandler.cs @@ -0,0 +1,1076 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using System.Buffers; +using System.Collections.Concurrent; +using System.Diagnostics.CodeAnalysis; +using System.Net.WebSockets; +using System.Runtime.CompilerServices; +using System.Text; +using System.Threading.Channels; + +namespace GitHub.Copilot; + +/// +/// Transport the runtime would otherwise use to issue an intercepted +/// model-layer request. +/// +[Experimental(Diagnostics.Experimental)] +public enum CopilotRequestTransport +{ + /// + /// Plain HTTP or a streamed SSE response. Each body chunk is an opaque + /// byte range. + /// + Http, + + /// + /// Full-duplex WebSocket channel. Each request-body chunk is one inbound + /// WebSocket message and each response-body write is one outbound message. + /// + WebSocket, +} + +/// +/// Per-request context handed to every hook. +/// Exposes the routing and cancellation details of a single intercepted request +/// so overrides can observe or rewrite it. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class CopilotRequestContext +{ + /// + /// Creates an instance of by copying the values from another instance. + /// + /// A instance to copy values from. + public CopilotRequestContext(CopilotRequestContext original) + : this(original.RequestId, original.Url, original.Headers) + { + SessionId = original.SessionId; + AgentId = original.AgentId; + ParentAgentId = original.ParentAgentId; + InteractionType = original.InteractionType; + Transport = original.Transport; + CancellationToken = original.CancellationToken; + WebSocketResponse = original.WebSocketResponse; + } + + internal CopilotRequestContext(string requestId, string url, IReadOnlyDictionary> headers) + { + RequestId = requestId; + Url = url; + Headers = headers; + } + + /// Opaque runtime-minted id, stable across the request lifecycle. + public string RequestId { get; init; } + + /// Runtime session id that triggered the request, if any. + public string? SessionId { get; init; } + + /// Stable per-agent-instance id for the agent trajectory that issued this request. + public string? AgentId { get; init; } + + /// Id of the parent agent when this request was issued by a subagent. + public string? ParentAgentId { get; init; } + + /// Runtime classification for the interaction that produced this request. + public string? InteractionType { get; init; } + + /// Transport the runtime would otherwise use. + public CopilotRequestTransport Transport { get; init; } + + /// Request URL. + public string Url { get; init; } + + /// Request headers. + public IReadOnlyDictionary> Headers { get; init; } + + /// + /// Cancelled when the runtime aborts this in-flight request. Subclasses that + /// issue their own I/O should pass this through so the upstream call is torn + /// down too. + /// + public CancellationToken CancellationToken { get; init; } + + internal LlmWebSocketResponseBridge? WebSocketResponse { get; set; } +} + +/// A single WebSocket message exchanged through a hook. +[Experimental(Diagnostics.Experimental)] +public readonly struct CopilotWebSocketMessage(ReadOnlyMemory data, bool isBinary) +{ + /// The message payload bytes. + public ReadOnlyMemory Data { get; } = data; + + /// True for a binary frame; false for a UTF-8 text frame. + public bool IsBinary { get; } = isBinary; + + /// Decodes the payload as UTF-8 text. + public string GetText() => Encoding.UTF8.GetString(Data.Span); + + /// Creates a text message from a UTF-8 string. + public static CopilotWebSocketMessage FromText(string text) => new(Encoding.UTF8.GetBytes(text), isBinary: false); +} + +/// +/// Terminal status for a callback-owned WebSocket connection. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class CopilotWebSocketCloseStatus +{ + /// The close description, if any. + public string? Description { get; init; } + + /// + /// Optional error code surfaced to the runtime when the close is a failure + /// rather than a clean end-of-stream. + /// + public string? ErrorCode { get; init; } + + /// The error that terminated the connection, if any. + public Exception? Error { get; init; } + + /// Shared normal-closure instance. + public static CopilotWebSocketCloseStatus NormalClosure { get; } = new(); +} + +/// +/// Lower-level WebSocket handler with no upstream connection. This is the +/// abstract base shared by all WebSocket handlers; it does not open or forward +/// to any upstream server on its own. Subclass it directly only to service a +/// fully synthetic connection yourself. For the common case of mutating and +/// forwarding traffic to the real upstream, subclass +/// instead, which connects upstream and +/// forwards by default. +/// +[Experimental(Diagnostics.Experimental)] +public abstract class CopilotWebSocketHandler : IAsyncDisposable +{ + private readonly TaskCompletionSource _completion = + new(TaskCreationOptions.RunContinuationsAsynchronously); + private int _closed; + private bool _suppressCloseOnDispose; + + /// Request context for this WebSocket connection. + protected CopilotRequestContext Context { get; } + + internal Task Completion => _completion.Task; + + /// + /// Initializes a per-connection handler for the supplied request context. + /// + protected CopilotWebSocketHandler(CopilotRequestContext context) + { + Context = context; + _ = context.WebSocketResponse ?? throw new InvalidOperationException("WebSocket response bridge is not attached."); + } + + /// + /// Send a message from the runtime to the upstream connection. + /// + public abstract Task SendRequestMessageAsync(CopilotWebSocketMessage message); + + /// + /// Send a message from the upstream connection back to the runtime. + /// Override to mutate or duplicate messages; call base to emit. + /// + public virtual Task SendResponseMessageAsync(CopilotWebSocketMessage message) => + Context.WebSocketResponse!.WriteAsync(message); + + /// + /// Close the connection and finalise the runtime-facing response. + /// + public virtual async Task CloseAsync(CopilotWebSocketCloseStatus status) + { + if (Interlocked.Exchange(ref _closed, 1) != 0) + { + return; + } + + if (status.Error is not null) + { + await Context.WebSocketResponse! + .ErrorAsync(status.Description ?? status.Error.Message, status.ErrorCode) + .ConfigureAwait(false); + } + else + { + await Context.WebSocketResponse!.EndAsync().ConfigureAwait(false); + } + + _completion.TrySetResult(status); + } + + internal void SuppressCloseOnDispose() => _suppressCloseOnDispose = true; + + internal virtual Task OpenAsync() => Task.CompletedTask; + + /// + public virtual async ValueTask DisposeAsync() + { + GC.SuppressFinalize(this); + if (!_suppressCloseOnDispose && Volatile.Read(ref _closed) == 0) + { + await CloseAsync(CopilotWebSocketCloseStatus.NormalClosure).ConfigureAwait(false); + } + } +} + +/// +/// WebSocket handler that connects to the real upstream and forwards traffic by +/// default. This is the type returned by the default +/// . Override nothing to +/// get full pass-through. To mutate traffic, subclass this type and override a +/// send method, then call the base implementation to keep forwarding upstream. +/// (Subclassing instead would drop +/// forwarding entirely.) +/// +[Experimental(Diagnostics.Experimental)] +public class CopilotWebSocketForwarder : CopilotWebSocketHandler +{ + private WebSocket? _upstream; + private CancellationTokenSource? _pumpCts; + private Task? _responsePump; + + /// + /// Initializes a forwarding handler that will open the upstream socket on + /// demand using the supplied URL/headers from . + /// + public CopilotWebSocketForwarder(CopilotRequestContext context) + : base(context) + { + } + + /// + /// Opens the upstream socket and starts the built-in response pump. + /// + internal override async Task OpenAsync() + { + if (_upstream is not null) + { + return; + } + + var socket = new ClientWebSocket(); + foreach (var (name, values) in Context.Headers) + { + if (LlmInferenceHeaders.Forbidden.Contains(name)) + { + continue; + } + + try + { + socket.Options.SetRequestHeader(name, string.Join(", ", values)); + } + catch + { + // Some headers are managed by the handshake; ignore rejections. + } + } + + await socket.ConnectAsync(ToWebSocketUri(Context.Url), Context.CancellationToken).ConfigureAwait(false); + _upstream = socket; + _pumpCts = CancellationTokenSource.CreateLinkedTokenSource(Context.CancellationToken); + + // Start the pump without a cancellation token on Task.Run itself: if the + // linked token is already cancelled, we still want PumpResponsesAsync to + // run so its cleanup (closing the upstream and finalising the response) + // executes rather than the task being cancelled before it ever starts. + _responsePump = Task.Run(() => PumpResponsesAsync(_pumpCts.Token)); + } + + /// + /// Sends a message from the runtime to the upstream connection. Subclasses may override to mutate messages. + /// + /// The message to send. + /// A representing the asynchronous operation. + public override Task SendRequestMessageAsync(CopilotWebSocketMessage message) + { + if (_upstream?.State != WebSocketState.Open) + { + return Task.CompletedTask; + } + + var type = message.IsBinary ? WebSocketMessageType.Binary : WebSocketMessageType.Text; + return _upstream.SendAsync( + message.Data, + type, + endOfMessage: true, + Context.CancellationToken).AsTask(); + } + + /// + public override async Task CloseAsync(CopilotWebSocketCloseStatus status) + { + _pumpCts?.Cancel(); + if (_upstream is not null) + { + await CloseWebSocketQuietlyAsync(_upstream).ConfigureAwait(false); + } + await base.CloseAsync(status).ConfigureAwait(false); + } + + /// + public override async ValueTask DisposeAsync() + { + GC.SuppressFinalize(this); + try + { + await base.DisposeAsync().ConfigureAwait(false); + } + finally + { + _pumpCts?.Cancel(); + _pumpCts?.Dispose(); + _upstream?.Dispose(); + if (_responsePump is not null) + { + await ObserveQuietlyAsync(_responsePump).ConfigureAwait(false); + } + } + } + + private async Task PumpResponsesAsync(CancellationToken cancellationToken) + { + if (_upstream is null) + { + return; + } + + try + { + while (_upstream.State == WebSocketState.Open) + { + var message = await ReceiveMessageAsync(_upstream, cancellationToken).ConfigureAwait(false); + if (message is null) + { + break; + } + + await SendResponseMessageAsync(message.Value).ConfigureAwait(false); + } + + await CloseAsync(CopilotWebSocketCloseStatus.NormalClosure).ConfigureAwait(false); + } + catch (OperationCanceledException) when (Context.CancellationToken.IsCancellationRequested) + { + // Runtime-side cancellation aborts the request pump; the outer + // handler rethrows that cancellation rather than finalising here. + } + catch (Exception ex) + { + await CloseAsync(new CopilotWebSocketCloseStatus + { + Description = ex.Message, + Error = ex, + }).ConfigureAwait(false); + } + } + + private static async Task ReceiveMessageAsync(WebSocket socket, CancellationToken cancellationToken) + { + var buffer = ArrayPool.Shared.Rent(16 * 1024); + try + { + using var assembled = new MemoryStream(); + ValueWebSocketReceiveResult result; + do + { + try + { + result = await socket.ReceiveAsync(buffer.AsMemory(), cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + return null; + } + catch (WebSocketException) + { + return null; + } + + if (result.MessageType == WebSocketMessageType.Close) + { + return null; + } + + assembled.Write(buffer, 0, result.Count); + } + while (!result.EndOfMessage); + + return new CopilotWebSocketMessage(assembled.ToArray(), result.MessageType == WebSocketMessageType.Binary); + } + finally + { + ArrayPool.Shared.Return(buffer); + } + } + + private static async Task CloseWebSocketQuietlyAsync(WebSocket socket) + { + try + { + if (socket.State is WebSocketState.Open or WebSocketState.CloseReceived) + { + await socket.CloseAsync(WebSocketCloseStatus.NormalClosure, statusDescription: null, CancellationToken.None).ConfigureAwait(false); + } + } + catch + { + // Best-effort; the socket may already be closed. + } + } + + [SuppressMessage("Usage", "CA1031:Do not catch general exception types", Justification = "Best-effort teardown of the losing pump.")] + private static async Task ObserveQuietlyAsync(Task task) + { + try + { + await task.ConfigureAwait(false); + } + catch + { + // Best-effort teardown only. + } + } + + private static Uri ToWebSocketUri(string url) + { + var builder = new UriBuilder(url); + if (builder.Scheme.Equals("https", StringComparison.OrdinalIgnoreCase)) + { + builder.Scheme = "wss"; + } + else if (builder.Scheme.Equals("http", StringComparison.OrdinalIgnoreCase)) + { + builder.Scheme = "ws"; + } + + return builder.Uri; + } +} + +/// +/// Base class for SDK consumers who want to observe or mutate the LLM inference +/// requests the runtime issues (for both CAPI and BYOK providers). Subclass and +/// override or . +/// +[Experimental(Diagnostics.Experimental)] +public class CopilotRequestHandler +{ + private static readonly HttpClient s_sharedHttpClient = new(); + + private readonly HttpClient _httpClient; + + /// + /// Initializes a new instance that issues upstream requests using a shared + /// process-wide . + /// + public CopilotRequestHandler() + : this(null) + { + } + + /// + /// Initializes a new instance that issues upstream requests using the supplied + /// , or a shared process-wide instance when is . + /// + /// The to use, or to use the shared instance. + public CopilotRequestHandler(HttpClient? httpClient) + { + _httpClient = httpClient ?? s_sharedHttpClient; + } + + /// + /// Issue the upstream HTTP request. Override to mutate the request before + /// calling base, mutate the returned response after, or replace the + /// call entirely. + /// + protected virtual Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) => + _httpClient.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, ctx.CancellationToken); + + /// + /// Open the upstream WebSocket connection. Override to return a custom + /// or to construct a + /// against a rewritten URL. + /// + protected virtual Task OpenWebSocketAsync(CopilotRequestContext ctx) => + Task.FromResult(new CopilotWebSocketForwarder(ctx)); + + /// + /// Entry point invoked by the adapter once per intercepted request. Routes to + /// the HTTP or WebSocket flow and drives the consumer's overridable hooks. + /// + internal Task HandleAsync(LlmInferenceExchange exchange) => + exchange.Context.Transport == CopilotRequestTransport.WebSocket + ? HandleWebSocketAsync(exchange) + : HandleHttpAsync(exchange); + + private async Task HandleHttpAsync(LlmInferenceExchange exchange) + { + using var request = await BuildHttpRequestAsync(exchange).ConfigureAwait(false); + using var response = await SendRequestAsync(request, exchange.Context).ConfigureAwait(false); + await StreamResponseAsync(response, exchange).ConfigureAwait(false); + } + + private static async Task BuildHttpRequestAsync(LlmInferenceExchange exchange) + { + var method = new HttpMethod(exchange.Method); + var message = new HttpRequestMessage(method, exchange.Context.Url); + + var hasBody = method != HttpMethod.Get && method != HttpMethod.Head; + var body = await DrainAsync(exchange.RequestBody).ConfigureAwait(false); + if (hasBody && body.Length > 0) + { + message.Content = new ByteArrayContent(body); + } + + foreach (var (name, values) in exchange.Context.Headers) + { + if (LlmInferenceHeaders.Forbidden.Contains(name)) + { + continue; + } + + if (!message.Headers.TryAddWithoutValidation(name, values)) + { +#if NETSTANDARD2_0 + if (!hasBody) + { + continue; + } +#endif + message.Content ??= new ByteArrayContent([]); + message.Content.Headers.TryAddWithoutValidation(name, values); + } + } + + return message; + } + + private static async Task StreamResponseAsync(HttpResponseMessage response, LlmInferenceExchange exchange) + { + await exchange.StartResponseAsync( + (int)response.StatusCode, + response.ReasonPhrase, + HeadersToMultiMap(response)).ConfigureAwait(false); + + var ct = exchange.Context.CancellationToken; + using var stream = await response.Content.ReadAsStreamAsync(ct).ConfigureAwait(false); + var buffer = new byte[16 * 1024]; + int read; + while ((read = await stream.ReadAsync(buffer.AsMemory(), ct).ConfigureAwait(false)) > 0) + { + await exchange.WriteResponseAsync(new ReadOnlyMemory(buffer, 0, read)).ConfigureAwait(false); + } + + await exchange.EndResponseAsync().ConfigureAwait(false); + } + + private async Task HandleWebSocketAsync(LlmInferenceExchange exchange) + { + var ctx = exchange.Context; + var bridge = new LlmWebSocketResponseBridge(exchange); + ctx.WebSocketResponse = bridge; + + var handler = await OpenWebSocketAsync(ctx).ConfigureAwait(false); + try + { + await handler.OpenAsync().ConfigureAwait(false); + + // The runtime blocks the WebSocket connect until it receives the + // 101 response head (the upgrade acknowledgement) and only then + // begins forwarding inbound messages as request-body chunks. Emit + // it eagerly here — waiting for the first upstream message would + // deadlock, since the upstream stays silent until it receives a + // request message the runtime won't send before the upgrade + // completes. + await bridge.StartAsync().ConfigureAwait(false); + + var clientPump = Task.Run(async () => + { + await foreach (var chunk in exchange.RequestBody.WithCancellation(ctx.CancellationToken).ConfigureAwait(false)) + { + await handler.SendRequestMessageAsync(new CopilotWebSocketMessage(chunk, isBinary: false)).ConfigureAwait(false); + } + }, ctx.CancellationToken); + + var first = await Task.WhenAny(clientPump, handler.Completion).ConfigureAwait(false); + if (first == clientPump) + { + if (clientPump.IsFaulted || clientPump.IsCanceled) + { + handler.SuppressCloseOnDispose(); + await clientPump.ConfigureAwait(false); + } + + await handler.CloseAsync(CopilotWebSocketCloseStatus.NormalClosure).ConfigureAwait(false); + await handler.Completion.ConfigureAwait(false); + return; + } + + var closeStatus = await handler.Completion.ConfigureAwait(false); + if (closeStatus.Error is not null) + { + throw closeStatus.Error; + } + } + finally + { + await handler.DisposeAsync().ConfigureAwait(false); + } + } + + private static async Task DrainAsync(IAsyncEnumerable> stream) + { + using var buffer = new MemoryStream(); + await foreach (var chunk in stream.ConfigureAwait(false)) + { + if (chunk.Length > 0) + { + buffer.Write(chunk.Span); + } + } + + return buffer.ToArray(); + } + + private static Dictionary> HeadersToMultiMap(HttpResponseMessage response) + { + var result = new Dictionary>(StringComparer.OrdinalIgnoreCase); + foreach (var header in response.Headers) + { + result[header.Key] = [.. header.Value]; + } + + if (response.Content is not null) + { + foreach (var header in response.Content.Headers) + { + result[header.Key] = [.. header.Value]; + } + } + + return result; + } +} + +/// +/// One intercepted request in flight. Carries the request context plus the body +/// byte stream the runtime feeds in via httpRequestChunk frames, and +/// emits the consumer's response straight back to the runtime through the +/// generated llmInference server API. Replaces the former +/// provider/sink/response-channel indirection with a single object the adapter +/// owns and the handler writes to. +/// +internal sealed class LlmInferenceExchange +{ + private readonly Func _getServerRpc; + private readonly Channel _body = Channel.CreateUnbounded( + new UnboundedChannelOptions { SingleReader = true, SingleWriter = true }); + + private bool _started; + private bool _finished; + private bool _cancelled; + + internal LlmInferenceExchange(string requestId, Func getServerRpc) + { + RequestId = requestId; + _getServerRpc = getServerRpc; + } + + internal string RequestId { get; } + + internal string Method { get; set; } = "GET"; + + internal CopilotRequestContext Context { get; set; } = null!; + + internal CancellationTokenSource Abort { get; } = new(); + + internal bool Started => _started; + + internal bool Finished => _finished; + + internal bool Cancelled => _cancelled; + + // --- Request body feed (driven by the adapter as chunk frames arrive) --- + + internal void PushChunk(byte[] data) => _body.Writer.TryWrite(new BodyItem { Chunk = data }); + + internal void PushEnd() => _body.Writer.TryWrite(new BodyItem { End = true }); + + internal void PushCancel(string? reason) + { + _cancelled = true; + Abort.Cancel(); + _body.Writer.TryWrite(new BodyItem { Cancel = true, CancelReason = reason }); + } + + /// + /// Request body bytes, yielded as they arrive. A cancel frame surfaces as an + /// so the consumer's upstream call + /// is torn down. + /// + internal IAsyncEnumerable> RequestBody => ReadBodyAsync(Abort.Token); + + private async IAsyncEnumerable> ReadBodyAsync( + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + while (await _body.Reader.WaitToReadAsync(cancellationToken).ConfigureAwait(false)) + { + while (_body.Reader.TryRead(out var item)) + { + if (item.Cancel) + { + _body.Writer.TryComplete(); + throw new OperationCanceledException( + item.CancelReason is null + ? "Request cancelled by runtime" + : $"Request cancelled by runtime: {item.CancelReason}"); + } + + if (item.End) + { + _body.Writer.TryComplete(); + yield break; + } + + if (item.Chunk is { Length: > 0 }) + { + yield return item.Chunk; + } + } + } + } + + // --- Response emit (driven by the handler). Strict state machine: --- + // StartResponseAsync once -> zero or more WriteResponseAsync -> exactly one + // of EndResponseAsync / ErrorResponseAsync. + + internal async Task StartResponseAsync(int status, string? statusText, IReadOnlyDictionary>? headers) + { + if (_started) + { + throw new InvalidOperationException("LLM inference response StartAsync() called twice."); + } + + if (_finished) + { + throw new InvalidOperationException("LLM inference response already finished."); + } + + _started = true; + await ServerRpc() + .LlmInference.HttpResponseStartAsync(RequestId, status, ToWireHeaders(headers), statusText) + .ConfigureAwait(false); + } + + internal Task WriteResponseAsync(ReadOnlyMemory data) => + WriteChunkAsync(Convert.ToBase64String(data.ToArray()), binary: true); + + internal Task WriteResponseAsync(string text) + { + ArgumentNullException.ThrowIfNull(text); + return WriteChunkAsync(text, binary: false); + } + + internal async Task EndResponseAsync() + { + if (_finished) + { + return; + } + + _finished = true; + await ServerRpc().LlmInference.HttpResponseChunkAsync(RequestId, string.Empty, end: true).ConfigureAwait(false); + } + + internal async Task ErrorResponseAsync(string message, string? code = null) + { + ArgumentNullException.ThrowIfNull(message); + + if (_finished) + { + return; + } + + _finished = true; + await ServerRpc() + .LlmInference.HttpResponseChunkAsync( + RequestId, + string.Empty, + end: true, + error: new LlmInferenceHttpResponseChunkError { Message = message, Code = code }) + .ConfigureAwait(false); + } + + private async Task WriteChunkAsync(string data, bool binary) + { + if (_cancelled) + { + throw new InvalidOperationException("LLM inference request was cancelled by the runtime."); + } + + if (!_started) + { + throw new InvalidOperationException("LLM inference response WriteAsync() called before StartAsync()."); + } + + if (_finished) + { + throw new InvalidOperationException("LLM inference response WriteAsync() called after EndAsync()/ErrorAsync()."); + } + + await ServerRpc() + .LlmInference.HttpResponseChunkAsync(RequestId, data, binary: binary, end: false) + .ConfigureAwait(false); + } + + private ServerRpc ServerRpc() => + _getServerRpc() ?? throw new InvalidOperationException("LLM inference response used after RPC connection closed."); + + private static Dictionary> ToWireHeaders(IReadOnlyDictionary>? headers) + { + var result = new Dictionary>(StringComparer.OrdinalIgnoreCase); + if (headers is null) + { + return result; + } + + foreach (var (name, values) in headers) + { + result[name] = values as IList ?? [.. values]; + } + + return result; + } + + private struct BodyItem + { + public byte[]? Chunk; + public bool End; + public bool Cancel; + public string? CancelReason; + } +} + +/// +/// Adapts the generated RPC entry points onto +/// a consumer's . Each httpRequestStart +/// allocates an and runs the handler in the +/// background; subsequent httpRequestChunk frames feed its body stream. +/// +internal sealed class LlmInferenceAdapter(CopilotRequestHandler handler, Func getServerRpc) : ILlmInferenceHandler +{ + private readonly CopilotRequestHandler _handler = handler ?? throw new ArgumentNullException(nameof(handler)); + private readonly Func _getServerRpc = getServerRpc ?? throw new ArgumentNullException(nameof(getServerRpc)); + private readonly ConcurrentDictionary _pending = new(StringComparer.Ordinal); + + public Task HttpRequestStartAsync(LlmInferenceHttpRequestStartRequest request, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(request); + + var transport = request.Transport == LlmInferenceHttpRequestStartTransport.Websocket + ? CopilotRequestTransport.WebSocket + : CopilotRequestTransport.Http; + + // The runtime dispatches httpRequestStart and httpRequestChunk frames + // concurrently, so body chunks (including the terminal end frame) can + // arrive before this start frame runs. GetOrAdd adopts any exchange a + // racing chunk already created — with its buffered body — instead of + // dropping those frames and hanging the body drain. + var exchange = _pending.GetOrAdd(request.RequestId, id => new LlmInferenceExchange(id, _getServerRpc)); + exchange.Method = request.Method; + exchange.Context = new CopilotRequestContext(request.RequestId, request.Url, ToReadOnlyHeaders(request.Headers)) + { + SessionId = request.SessionId, + AgentId = request.AgentId, + ParentAgentId = request.ParentAgentId, + InteractionType = request.InteractionType, + Transport = transport, + CancellationToken = exchange.Abort.Token, + }; + + // Return from httpRequestStart immediately (after registering state) so + // the runtime's RPC reply is not gated on the consumer's I/O. The actual + // handler work runs asynchronously, exactly once per request. + _ = RunAsync(exchange); + + return Task.FromResult(new LlmInferenceHttpRequestStartResult()); + } + + public Task HttpRequestChunkAsync(LlmInferenceHttpRequestChunkRequest request, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(request); + + // A chunk may arrive before its matching httpRequestStart (frames are + // dispatched concurrently). GetOrAdd buffers the body into the + // exchange's channel so no chunk — in particular the terminal end + // frame — is ever lost; the start frame later adopts this same exchange. + var exchange = _pending.GetOrAdd(request.RequestId, id => new LlmInferenceExchange(id, _getServerRpc)); + RouteChunk(exchange, request); + + return Task.FromResult(new LlmInferenceHttpRequestChunkResult()); + } + + private async Task RunAsync(LlmInferenceExchange exchange) + { + try + { + await _handler.HandleAsync(exchange).ConfigureAwait(false); + if (!exchange.Finished) + { + await FinalizeAsync(exchange, 502, "LLM inference handler returned without finalising the response (call ResponseBody.EndAsync() or .ErrorAsync()).", code: null).ConfigureAwait(false); + } + } + catch (Exception ex) + { + if (exchange.Cancelled || exchange.Abort.IsCancellationRequested) + { + // The runtime already cancelled this request; the handler's throw + // is just the abort propagating out of its upstream call. + await FinalizeAsync(exchange, 499, "Request cancelled by runtime", code: "cancelled").ConfigureAwait(false); + return; + } + + await FinalizeAsync(exchange, 502, ex.Message, code: null).ConfigureAwait(false); + } + finally + { + _pending.TryRemove(exchange.RequestId, out _); + } + } + + private static async Task FinalizeAsync(LlmInferenceExchange exchange, int status, string message, string? code) + { + if (exchange.Finished) + { + return; + } + + try + { + if (!exchange.Started) + { + await exchange.StartResponseAsync(status, statusText: null, headers: null).ConfigureAwait(false); + } + + await exchange.ErrorResponseAsync(message, code).ConfigureAwait(false); + } + catch + { + // Best-effort — the connection may already be dead. + } + } + + private static void RouteChunk(LlmInferenceExchange exchange, LlmInferenceHttpRequestChunkRequest chunk) + { + if (chunk.Cancel == true) + { + exchange.PushCancel(chunk.CancelReason); + return; + } + + if (!string.IsNullOrEmpty(chunk.Data)) + { + exchange.PushChunk(DecodeChunkData(chunk.Data, chunk.Binary == true)); + } + + if (chunk.End == true) + { + exchange.PushEnd(); + } + } + + private static byte[] DecodeChunkData(string data, bool binary) => + binary ? Convert.FromBase64String(data) : Encoding.UTF8.GetBytes(data); + + private static Dictionary> ToReadOnlyHeaders(IDictionary> headers) + { + var result = new Dictionary>(StringComparer.OrdinalIgnoreCase); + foreach (var (name, values) in headers) + { + result[name] = values as IReadOnlyList ?? [.. values]; + } + + return result; + } +} + +/// +/// Forwards upstream WebSocket messages back to the owning +/// . The 101 upgrade head is emitted eagerly +/// via (the runtime gates the connect on it); +/// thereafter writes are serialised so the head always precedes any body or +/// terminal frame. +/// +internal sealed class LlmWebSocketResponseBridge(LlmInferenceExchange exchange) +{ + private readonly SemaphoreSlim _gate = new(1, 1); + private bool _started; + private bool _completed; + + /// Emit the 101 upgrade head now, acknowledging the WebSocket connect. + internal Task StartAsync() => RunAsync(terminal: false, () => Task.CompletedTask); + + internal Task WriteAsync(CopilotWebSocketMessage message) => RunAsync(terminal: false, () => + message.IsBinary + ? exchange.WriteResponseAsync(message.Data) + : exchange.WriteResponseAsync(message.GetText())); + + internal Task EndAsync() => RunAsync(terminal: true, () => exchange.EndResponseAsync()); + + internal Task ErrorAsync(string message, string? code) => + RunAsync(terminal: true, () => exchange.ErrorResponseAsync(message, code)); + + private async Task RunAsync(bool terminal, Func action) + { + await _gate.WaitAsync().ConfigureAwait(false); + try + { + if (_completed) + { + return; + } + + if (!_started) + { + _started = true; + await exchange.StartResponseAsync(101, statusText: null, headers: null).ConfigureAwait(false); + } + + if (terminal) + { + _completed = true; + } + + await action().ConfigureAwait(false); + } + finally + { + _gate.Release(); + } + } +} + +internal static class LlmInferenceHeaders +{ + // Computed/managed by the HTTP/WS stack; forwarding them verbatim either + // throws or corrupts the request. + internal static readonly HashSet Forbidden = new(StringComparer.OrdinalIgnoreCase) + { + "host", + "connection", + "content-length", + "transfer-encoding", + "keep-alive", + "upgrade", + "proxy-connection", + "te", + "trailer", + }; +} diff --git a/dotnet/src/CopilotTool.cs b/dotnet/src/CopilotTool.cs index feed5be76..ca62ccc5d 100644 --- a/dotnet/src/CopilotTool.cs +++ b/dotnet/src/CopilotTool.cs @@ -3,6 +3,7 @@ *--------------------------------------------------------------------------------------------*/ using Microsoft.Extensions.AI; +using System.Text.Json.Nodes; namespace GitHub.Copilot; @@ -17,6 +18,15 @@ public static class CopilotTool /// The key used in to indicate that a tool can execute without a permission prompt. internal const string SkipPermissionKey = "skip_permission"; + /// The key used in to indicate that a successful call to the tool ends the agent turn. + internal const string IsTerminalKey = "is_terminal"; + + /// The key used in to carry the tool's deferral mode. + internal const string DeferKey = "defer"; + + /// The key used in to carry the tool's opaque host-defined metadata. + internal const string MetadataKey = "metadata"; + /// /// Defines a tool for use in a . /// @@ -84,7 +94,7 @@ static void ApplyToolInvocationBinding(AIFunctionFactoryOptions factoryOptions) static void ApplyToolOptions(AIFunctionFactoryOptions factoryOptions, CopilotToolOptions? toolOptions) { - if (toolOptions is not null && (toolOptions.OverridesBuiltInTool || toolOptions.SkipPermission)) + if (toolOptions is not null && (toolOptions.OverridesBuiltInTool || toolOptions.SkipPermission || toolOptions.IsTerminal || toolOptions.Defer is not null || toolOptions.Metadata is not null)) { Dictionary additionalProperties = new(StringComparer.Ordinal); if (factoryOptions.AdditionalProperties is not null) @@ -105,6 +115,21 @@ static void ApplyToolOptions(AIFunctionFactoryOptions factoryOptions, CopilotToo additionalProperties[SkipPermissionKey] = true; } + if (toolOptions.IsTerminal) + { + additionalProperties[IsTerminalKey] = true; + } + + if (toolOptions.Defer is { } defer) + { + additionalProperties[DeferKey] = defer; + } + + if (toolOptions.Metadata is { } metadata) + { + additionalProperties[MetadataKey] = metadata; + } + factoryOptions.AdditionalProperties = additionalProperties; } } @@ -121,7 +146,7 @@ public sealed class CopilotToolOptions /// Gets or sets a value indicating whether this tool intentionally overrides a built-in Copilot tool with the same name. /// /// - /// When a with set to true is used to define a tool, + /// When a with set to true is used to define a tool, /// the resulting will include "is_override": true in its . /// public bool OverridesBuiltInTool { get; set; } @@ -130,8 +155,47 @@ public sealed class CopilotToolOptions /// Gets or sets a value indicating whether this tool can execute without a permission prompt. /// /// - /// When a with set to true is used to define a tool, + /// When a with set to true is used to define a tool, /// the resulting will include "skip_permission": true in its . /// public bool SkipPermission { get; set; } + + /// + /// Gets or sets a value indicating whether a successful call to this tool ends the agent turn. + /// + /// + /// When true, the runtime's tool phase halts after a successful call instead of feeding the result back to the + /// model for another round. A failed call leaves the loop running so the model can read the error and retry. + /// The resulting includes "is_terminal": true in its . + /// + public bool IsTerminal { get; set; } + + /// + /// Gets or sets a value controlling whether this tool may be deferred (loaded lazily via tool search) rather than always pre-loaded. + /// + /// + /// When set, the resulting carries the value in its and the + /// SDK forwards it to the CLI as the tool's defer mode. Defaults to "auto". + /// + public CopilotToolDefer? Defer { get; set; } + + /// + /// Gets or sets opaque, host-defined metadata associated with the tool definition. + /// + public IDictionary? Metadata { get; set; } +} + +/// +/// Controls whether a tool may be deferred (loaded lazily via tool search) rather than always pre-loaded. +/// +[System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))] +public enum CopilotToolDefer +{ + /// The tool can be deferred and surfaced through tool search. + [System.Text.Json.Serialization.JsonStringEnumMemberName("auto")] + Auto, + + /// The tool is always pre-loaded. + [System.Text.Json.Serialization.JsonStringEnumMemberName("never")] + Never } diff --git a/dotnet/src/FfiRuntimeHost.cs b/dotnet/src/FfiRuntimeHost.cs new file mode 100644 index 000000000..a838b9fd1 --- /dev/null +++ b/dotnet/src/FfiRuntimeHost.cs @@ -0,0 +1,683 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using Microsoft.Extensions.Logging; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using System.Text.Json; +using System.Threading.Channels; + +namespace GitHub.Copilot; + +/// +/// Hosts the Copilot runtime in-process by loading the Rust cdylib (runtime.node) +/// and speaking JSON-RPC over its C ABI (FFI) instead of spawning a CLI child process +/// and communicating over stdio/TCP. +/// +/// +/// The Rust host_start export spawns the residual TypeScript worker itself — +/// typically the packaged single-file CLI (copilot --embedded-host, which embeds +/// its own Node) or, for dev, node dist-cli/index.js --embedded-host — so the .NET +/// host never launches Node directly. JSON-RPC frames are pumped across the ABI: writes go +/// to connection_write; inbound frames arrive on a native callback that feeds +/// . +/// +/// The native interop layer has two implementations selected by target framework. On +/// modern .NET it uses source-generated LibraryImport P/Invoke with an +/// UnmanagedCallersOnly function-pointer callback, which is trim- and +/// NativeAOT-compatible. On netstandard2.0 (which has neither LibraryImport +/// nor NativeLibrary) it falls back to classic delegate-based P/Invoke over a +/// hand-rolled dlopen/LoadLibrary loader. Because the library lives at a +/// runtime-resolved absolute path, the modern path maps the logical +/// via a resolver and the legacy path loads the absolute path +/// directly. +/// +/// +internal sealed partial class FfiRuntimeHost : IDisposable +{ + /// Logical name the native interop layer binds the cdylib to. + private const string LibraryName = "copilot_runtime"; + + private readonly ILogger _logger; + private readonly string _cliEntrypoint; + private readonly string _libraryPath; + private readonly IReadOnlyDictionary? _environment; + private readonly IReadOnlyList _args; + + private readonly CallbackReceiveStream _receiveStream = new(); + private CallbackSendStream? _sendStream; + + private uint _serverId; + private uint _connectionId; + private bool _disposed; + + private FfiRuntimeHost(string libraryPath, string cliEntrypoint, IReadOnlyDictionary? environment, IReadOnlyList args, ILogger logger) + { + _libraryPath = libraryPath; + _cliEntrypoint = cliEntrypoint; + _environment = environment; + _args = args; + _logger = logger; + } + + /// The stream JSON-RPC reads server→client frames from. + public Stream ReceiveStream => _receiveStream; + + /// The stream JSON-RPC writes client→server frames to. + public Stream SendStream => _sendStream + ?? throw new InvalidOperationException("FfiRuntimeHost has not been started."); + + /// + /// Loads the cdylib next to the given CLI entrypoint and prepares the FFI host. + /// The entrypoint is either the packaged single-file CLI binary (e.g. + /// runtimes/<rid>/native/copilot) or, for dev, a .js file (e.g. + /// dist-cli/index.js) launched via node. The cdylib is resolved + /// relative to the entrypoint directory, preferring the flat, natural + /// shared-library name the .NET build emits (e.g. libcopilot_runtime.so) + /// and falling back to the dev tarball layout + /// prebuilds/<prebuildsFolder>/runtime.node, where + /// is the napi-rs + /// <node-platform>-<arch> folder name (e.g. win32-x64). + /// + public static FfiRuntimeHost Create(string cliEntrypoint, string prebuildsFolder, IReadOnlyDictionary? environment, IReadOnlyList args, ILogger logger) + { + var fullEntrypoint = Path.GetFullPath(cliEntrypoint); + var distDir = Path.GetDirectoryName(fullEntrypoint) + ?? throw new InvalidOperationException($"Could not determine directory for '{cliEntrypoint}'."); + + // Bundled .NET layout: flat, natural shared-library name next to the CLI. + var flatLibraryPath = Path.Combine(distDir, GetRuntimeLibraryFileName()); + // Dev/tarball layout: dist-cli/prebuilds/-/runtime.node. + var prebuildsLibraryPath = Path.Combine(distDir, "prebuilds", prebuildsFolder, "runtime.node"); + + var libraryPath = File.Exists(flatLibraryPath) ? flatLibraryPath + : File.Exists(prebuildsLibraryPath) ? prebuildsLibraryPath + : throw new InvalidOperationException( + $"FFI runtime library not found. Looked for '{flatLibraryPath}' and '{prebuildsLibraryPath}'."); + + PrepareNativeLibrary(libraryPath); + return new FfiRuntimeHost(libraryPath, fullEntrypoint, environment, args, logger); + } + + /// + /// The natural platform shared-library file name for the runtime cdylib, as + /// emitted by the .NET build (the .node file renamed to what the Rust cdylib + /// would be called on this OS). + /// + private static string GetRuntimeLibraryFileName() + { + if (OperatingSystem.IsWindows()) return "copilot_runtime.dll"; + if (OperatingSystem.IsMacOS()) return "libcopilot_runtime.dylib"; + return "libcopilot_runtime.so"; + } + + /// + /// Starts the in-process runtime: spawns the CLI worker via the Rust host, + /// waits for readiness, and opens the FFI JSON-RPC connection. + /// + public async Task StartAsync(CancellationToken cancellationToken) + { + // host_start blocks until the worker connects back and signals readiness + // (up to ~30s), and connection_open must run outside any async runtime, so + // perform the blocking FFI handshake on a background thread. + await Task.Run(() => + { + var argvJson = BuildArgvJson(_cliEntrypoint, _args); + var envJson = BuildEnvJson(_environment); + + _serverId = NativeHostStart(argvJson, envJson); + if (_serverId == 0) + { + throw new InvalidOperationException( + $"copilot_runtime_host_start failed (library '{_libraryPath}', entrypoint '{_cliEntrypoint}')."); + } + + _connectionId = NativeOpenConnection(_serverId); + if (_connectionId == 0) + { + DisposeNativeCallback(); + NativeHostShutdown(_serverId); + _serverId = 0; + throw new InvalidOperationException("copilot_runtime_connection_open failed."); + } + + _sendStream = new CallbackSendStream(SendFrame); + }, cancellationToken).ConfigureAwait(false); + + if (_logger.IsEnabled(LogLevel.Debug)) + { + _logger.LogDebug( + "FfiRuntimeHost started. Library={Library}, ServerId={ServerId}, ConnectionId={ConnectionId}", + _libraryPath, _serverId, _connectionId); + } + } + + private static byte[] BuildArgvJson(string cliEntrypoint, IReadOnlyList args) + { + // A .js entrypoint (dev / dist-cli) is launched via node; the packaged + // single-file CLI binary embeds its own Node and is invoked directly. + var isJsFile = cliEntrypoint.EndsWith(".js", StringComparison.OrdinalIgnoreCase); + using var stream = new MemoryStream(); + using (var writer = new Utf8JsonWriter(stream)) + { + writer.WriteStartArray(); + if (isJsFile) + { + writer.WriteStringValue("node"); + } + writer.WriteStringValue(cliEntrypoint); + writer.WriteStringValue("--embedded-host"); + // Pin the worker to the bundled pkg matching the loaded cdylib, instead of + // drifting to a newer version under the user's ~/.copilot/pkg (ABI skew). + writer.WriteStringValue("--no-auto-update"); + foreach (var arg in args) + { + writer.WriteStringValue(arg); + } + writer.WriteEndArray(); + } + return stream.ToArray(); + } + + private static byte[]? BuildEnvJson(IReadOnlyDictionary? environment) + { + if (environment is null || environment.Count == 0) + { + return null; + } + using var stream = new MemoryStream(); + using (var writer = new Utf8JsonWriter(stream)) + { + writer.WriteStartObject(); + foreach (var kvp in environment) + { + writer.WriteString(kvp.Key, kvp.Value); + } + writer.WriteEndObject(); + } + return stream.ToArray(); + } + + /// + /// Writes one framed message to the native connection. The bytes are read + /// synchronously by the native side (it copies before returning), so the + /// span does not need to outlive the call — no allocation or copy on our side. + /// + private delegate bool FrameWriter(ReadOnlySpan frame); + + private bool SendFrame(ReadOnlySpan frame) + { + if (_disposed || _connectionId == 0) + { + return false; + } + return NativeConnectionWrite(_connectionId, frame); + } + + private void FeedInbound(IntPtr bytesPtr, UIntPtr bytesLen) + { + var length = checked((int)bytesLen.ToUInt64()); + var buffer = new byte[length]; + Marshal.Copy(bytesPtr, buffer, 0, length); + _receiveStream.Feed(buffer); + } + + public void Dispose() + { + if (_disposed) + { + return; + } + _disposed = true; + + try + { + if (_connectionId != 0) + { + NativeConnectionClose(_connectionId); + _connectionId = 0; + } + } + catch (Exception ex) + { + _logger.LogDebug(ex, "FfiRuntimeHost: connection_close failed"); + } + + try + { + if (_serverId != 0) + { + NativeHostShutdown(_serverId); + _serverId = 0; + } + } + catch (Exception ex) + { + _logger.LogDebug(ex, "FfiRuntimeHost: host_shutdown failed"); + } + + _receiveStream.Complete(); + DisposeNativeCallback(); + } + + /// Length as the native pointer-sized unsigned integer the ABI expects. + private static UIntPtr Len(int value) => new((uint)value); + +#if NET + // ---- Modern interop: source-generated LibraryImport P/Invoke (trim/AOT-safe) ---- + + private static readonly object ResolverLock = new(); + private static bool s_resolverRegistered; + private static string? s_resolvedLibraryPath; + + // A normal (non-pinned) handle to this instance, passed to the native side as + // the callback's user_data so the static outbound callback can route back here. + private GCHandle _selfHandle; + + /// + /// Registers (once) a process-wide + /// that maps to the absolute runtime.node path so the + /// stubs resolve. The resolved handle is cached by + /// the runtime after first use, so all in-process hosts share a single loaded library. + /// + private static void PrepareNativeLibrary(string libraryPath) + { + lock (ResolverLock) + { + if (s_resolvedLibraryPath is not null && s_resolvedLibraryPath != libraryPath) + { + throw new InvalidOperationException( + $"An in-process FFI runtime library is already loaded from '{s_resolvedLibraryPath}'; " + + $"loading a different library from '{libraryPath}' in the same process is not supported."); + } + s_resolvedLibraryPath = libraryPath; + if (!s_resolverRegistered) + { + NativeLibrary.SetDllImportResolver(typeof(FfiRuntimeHost).Assembly, Resolve); + s_resolverRegistered = true; + } + } + } + + private static IntPtr Resolve(string libraryName, Assembly assembly, DllImportSearchPath? searchPath) + { + if (libraryName == LibraryName && s_resolvedLibraryPath is not null) + { + return NativeLibrary.Load(s_resolvedLibraryPath); + } + return IntPtr.Zero; + } + + private static uint NativeHostStart(byte[] argvJson, byte[]? env) => + HostStart(argvJson, Len(argvJson.Length), env, env is null ? UIntPtr.Zero : Len(env.Length)); + + private uint NativeOpenConnection(uint serverId) + { + _selfHandle = GCHandle.Alloc(this); + unsafe + { + return ConnectionOpen( + serverId, + &OnOutboundStatic, + GCHandle.ToIntPtr(_selfHandle), + null, UIntPtr.Zero, + null, UIntPtr.Zero, + null, UIntPtr.Zero); + } + } + + private static bool NativeHostShutdown(uint serverId) => HostShutdown(serverId); + + private static bool NativeConnectionWrite(uint connectionId, ReadOnlySpan frame) => ConnectionWrite(connectionId, frame, Len(frame.Length)); + + private static bool NativeConnectionClose(uint connectionId) => ConnectionClose(connectionId); + + private void DisposeNativeCallback() + { + if (_selfHandle.IsAllocated) + { + _selfHandle.Free(); + } + } + + [UnmanagedCallersOnly(CallConvs = new[] { typeof(CallConvCdecl) })] + private static void OnOutboundStatic(IntPtr userData, IntPtr bytesPtr, nuint bytesLen) + { + if (userData == IntPtr.Zero || bytesPtr == IntPtr.Zero || bytesLen == 0) + { + return; + } + if (GCHandle.FromIntPtr(userData).Target is FfiRuntimeHost self) + { + self.FeedInbound(bytesPtr, bytesLen); + } + } + + [LibraryImport(LibraryName, EntryPoint = "copilot_runtime_host_start")] + [UnmanagedCallConv(CallConvs = new[] { typeof(CallConvCdecl) })] + private static partial uint HostStart( + byte[] argvJson, nuint argvJsonLen, + byte[]? env, nuint envLen); + + [LibraryImport(LibraryName, EntryPoint = "copilot_runtime_host_shutdown")] + [UnmanagedCallConv(CallConvs = new[] { typeof(CallConvCdecl) })] + [return: MarshalAs(UnmanagedType.U1)] + private static partial bool HostShutdown(uint serverId); + + [LibraryImport(LibraryName, EntryPoint = "copilot_runtime_connection_open")] + [UnmanagedCallConv(CallConvs = new[] { typeof(CallConvCdecl) })] + private static unsafe partial uint ConnectionOpen( + uint serverId, + delegate* unmanaged[Cdecl] onOutbound, + IntPtr userData, + byte[]? extSource, nuint extSourceLen, + byte[]? extName, nuint extNameLen, + byte[]? connToken, nuint connTokenLen); + + [LibraryImport(LibraryName, EntryPoint = "copilot_runtime_connection_write")] + [UnmanagedCallConv(CallConvs = new[] { typeof(CallConvCdecl) })] + [return: MarshalAs(UnmanagedType.U1)] + private static partial bool ConnectionWrite(uint connectionId, ReadOnlySpan bytes, nuint bytesLen); + + [LibraryImport(LibraryName, EntryPoint = "copilot_runtime_connection_close")] + [UnmanagedCallConv(CallConvs = new[] { typeof(CallConvCdecl) })] + [return: MarshalAs(UnmanagedType.U1)] + private static partial bool ConnectionClose(uint connectionId); +#else + // ---- Legacy interop: delegate-based P/Invoke for netstandard2.0 ---- + // netstandard2.0 has neither LibraryImport, NativeLibrary, nor UnmanagedCallersOnly, + // so the cdylib is loaded through a hand-rolled dlopen/LoadLibrary shim and each + // export is bound to a [UnmanagedFunctionPointer] delegate. The outbound callback is + // an instance delegate kept alive in a field for the connection's lifetime. + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint HostStartDelegate( + byte[] argvJson, UIntPtr argvJsonLen, + byte[]? env, UIntPtr envLen); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.U1)] + private delegate bool HostShutdownDelegate(uint serverId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint ConnectionOpenDelegate( + uint serverId, + OutboundCallbackDelegate onOutbound, + IntPtr userData, + byte[]? extSource, UIntPtr extSourceLen, + byte[]? extName, UIntPtr extNameLen, + byte[]? connToken, UIntPtr connTokenLen); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.U1)] + private delegate bool ConnectionWriteDelegate(uint connectionId, IntPtr bytes, UIntPtr bytesLen); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.U1)] + private delegate bool ConnectionCloseDelegate(uint connectionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void OutboundCallbackDelegate(IntPtr userData, IntPtr bytesPtr, UIntPtr bytesLen); + + private static readonly object NativeLock = new(); + private static bool s_loaded; + private static string? s_loadedPath; + private static HostStartDelegate? s_hostStart; + private static HostShutdownDelegate? s_hostShutdown; + private static ConnectionOpenDelegate? s_connectionOpen; + private static ConnectionWriteDelegate? s_connectionWrite; + private static ConnectionCloseDelegate? s_connectionClose; + + // Held for the connection's lifetime so the marshaled function pointer handed to the + // native side is not collected while Rust may still invoke it. + private OutboundCallbackDelegate? _outboundDelegate; + + private static void PrepareNativeLibrary(string libraryPath) + { + lock (NativeLock) + { + if (s_loaded) + { + if (s_loadedPath != libraryPath) + { + throw new InvalidOperationException( + $"An in-process FFI runtime library is already loaded from '{s_loadedPath}'; " + + $"loading a different library from '{libraryPath}' in the same process is not supported."); + } + return; + } + + var handle = NativeLoader.Load(libraryPath); + if (handle == IntPtr.Zero) + { + throw new InvalidOperationException($"Failed to load FFI runtime library '{libraryPath}'."); + } + + s_hostStart = Bind(handle, "copilot_runtime_host_start"); + s_hostShutdown = Bind(handle, "copilot_runtime_host_shutdown"); + s_connectionOpen = Bind(handle, "copilot_runtime_connection_open"); + s_connectionWrite = Bind(handle, "copilot_runtime_connection_write"); + s_connectionClose = Bind(handle, "copilot_runtime_connection_close"); + s_loaded = true; + s_loadedPath = libraryPath; + } + } + + private static T Bind(IntPtr handle, string export) where T : Delegate + { + var symbol = NativeLoader.GetSymbol(handle, export); + if (symbol == IntPtr.Zero) + { + throw new InvalidOperationException($"FFI runtime library is missing the '{export}' export."); + } + return Marshal.GetDelegateForFunctionPointer(symbol); + } + + private static uint NativeHostStart(byte[] argvJson, byte[]? env) => + s_hostStart!(argvJson, Len(argvJson.Length), env, env is null ? UIntPtr.Zero : Len(env.Length)); + + private uint NativeOpenConnection(uint serverId) + { + _outboundDelegate = OnOutbound; + return s_connectionOpen!( + serverId, + _outboundDelegate, + IntPtr.Zero, + null, UIntPtr.Zero, + null, UIntPtr.Zero, + null, UIntPtr.Zero); + } + + private static bool NativeHostShutdown(uint serverId) => s_hostShutdown!(serverId); + + private static unsafe bool NativeConnectionWrite(uint connectionId, ReadOnlySpan frame) + { + fixed (byte* ptr = frame) + { + return s_connectionWrite!(connectionId, (IntPtr)ptr, Len(frame.Length)); + } + } + + private static bool NativeConnectionClose(uint connectionId) => s_connectionClose!(connectionId); + + private void DisposeNativeCallback() => _outboundDelegate = null; + + private void OnOutbound(IntPtr userData, IntPtr bytesPtr, UIntPtr bytesLen) + { + if (bytesPtr == IntPtr.Zero || bytesLen == UIntPtr.Zero) + { + return; + } + FeedInbound(bytesPtr, bytesLen); + } + + /// + /// Minimal cross-platform native library loader for netstandard2.0, which lacks + /// NativeLibrary. Uses LoadLibrary/GetProcAddress on Windows + /// and dlopen/dlsym elsewhere (trying libdl.so.2 first, then + /// libdl for older Linux and macOS). + /// + private static class NativeLoader + { + public static IntPtr Load(string path) => + RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? Windows.LoadLibrary(path) : Unix.Open(path); + + public static IntPtr GetSymbol(IntPtr handle, string name) => + RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? Windows.GetProcAddress(handle, name) : Unix.Sym(handle, name); + + private static class Windows + { + [DllImport("kernel32", SetLastError = true, CharSet = CharSet.Unicode, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr LoadLibrary([MarshalAs(UnmanagedType.LPWStr)] string path); + + [DllImport("kernel32", SetLastError = true, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr GetProcAddress(IntPtr module, [MarshalAs(UnmanagedType.LPStr)] string name); + } + + private static class Unix + { + private const int RtldNow = 2; + + public static IntPtr Open(string path) + { + try { return Libdl2.dlopen(path, RtldNow); } + catch (DllNotFoundException) { return Libdl1.dlopen(path, RtldNow); } + } + + public static IntPtr Sym(IntPtr handle, string name) + { + try { return Libdl2.dlsym(handle, name); } + catch (DllNotFoundException) { return Libdl1.dlsym(handle, name); } + } + + private static class Libdl2 + { + [DllImport("libdl.so.2", EntryPoint = "dlopen", CharSet = CharSet.Ansi, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr dlopen([MarshalAs(UnmanagedType.LPStr)] string fileName, int flags); + + [DllImport("libdl.so.2", EntryPoint = "dlsym", CharSet = CharSet.Ansi, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr dlsym(IntPtr handle, [MarshalAs(UnmanagedType.LPStr)] string symbol); + } + + private static class Libdl1 + { + [DllImport("libdl", EntryPoint = "dlopen", CharSet = CharSet.Ansi, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr dlopen([MarshalAs(UnmanagedType.LPStr)] string fileName, int flags); + + [DllImport("libdl", EntryPoint = "dlsym", CharSet = CharSet.Ansi, BestFitMapping = false, ThrowOnUnmappableChar = true)] + public static extern IntPtr dlsym(IntPtr handle, [MarshalAs(UnmanagedType.LPStr)] string symbol); + } + } + } +#endif + + /// + /// A read-only stream fed by the native outbound callback. Chunks are queued on + /// an unbounded channel and drained in order by the JSON-RPC read loop. + /// + private sealed class CallbackReceiveStream : Stream + { + private readonly Channel _channel = Channel.CreateUnbounded( + new UnboundedChannelOptions { SingleReader = true, SingleWriter = false }); + private ReadOnlyMemory _leftover; + + public void Feed(byte[] data) => _channel.Writer.TryWrite(data); + + public void Complete() => _channel.Writer.TryComplete(); + +#if !NETSTANDARD2_0 + public override async ValueTask ReadAsync(Memory buffer, CancellationToken cancellationToken = default) + { + return await ReadCoreAsync(buffer, cancellationToken).ConfigureAwait(false); + } +#endif + + private async ValueTask ReadCoreAsync(Memory buffer, CancellationToken cancellationToken) + { + if (_leftover.IsEmpty) + { + while (true) + { + if (!await _channel.Reader.WaitToReadAsync(cancellationToken).ConfigureAwait(false)) + { + return 0; // EOF: channel completed. + } + if (_channel.Reader.TryRead(out var chunk)) + { + _leftover = chunk; + break; + } + // Data was signalled but lost a race for it; wait again rather + // than reporting a spurious EOF. + } + } + + var n = Math.Min(buffer.Length, _leftover.Length); + _leftover.Span.Slice(0, n).CopyTo(buffer.Span); + _leftover = _leftover.Slice(n); + return n; + } + + public override int Read(byte[] buffer, int offset, int count) => + ReadCoreAsync(buffer.AsMemory(offset, count), CancellationToken.None).AsTask().GetAwaiter().GetResult(); + + public override Task ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) => + ReadCoreAsync(buffer.AsMemory(offset, count), cancellationToken).AsTask(); + + public override bool CanRead => true; + public override bool CanSeek => false; + public override bool CanWrite => false; + public override long Length => throw new NotSupportedException(); + public override long Position { get => throw new NotSupportedException(); set => throw new NotSupportedException(); } + public override void Flush() { } + public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException(); + public override void SetLength(long value) => throw new NotSupportedException(); + public override void Write(byte[] buffer, int offset, int count) => throw new NotSupportedException(); + } + + /// + /// A write-only stream that forwards each frame to the native + /// connection_write export. + /// + private sealed class CallbackSendStream(FrameWriter write) : Stream + { + private void WriteFrame(ReadOnlySpan frame) + { + if (!write(frame)) + { + throw new IOException("Failed to write a frame to the in-process runtime connection."); + } + } + + public override void Write(byte[] buffer, int offset, int count) => WriteFrame(buffer.AsSpan(offset, count)); + +#if !NETSTANDARD2_0 + public override void Write(ReadOnlySpan buffer) => WriteFrame(buffer); + + public override ValueTask WriteAsync(ReadOnlyMemory buffer, CancellationToken cancellationToken = default) + { + WriteFrame(buffer.Span); + return ValueTask.CompletedTask; + } +#endif + + public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) + { + WriteFrame(buffer.AsSpan(offset, count)); + return Task.CompletedTask; + } + + public override bool CanRead => false; + public override bool CanSeek => false; + public override bool CanWrite => true; + public override long Length => throw new NotSupportedException(); + public override long Position { get => throw new NotSupportedException(); set => throw new NotSupportedException(); } + public override void Flush() { } + public override Task FlushAsync(CancellationToken cancellationToken) => Task.CompletedTask; + public override int Read(byte[] buffer, int offset, int count) => throw new NotSupportedException(); + public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException(); + public override void SetLength(long value) => throw new NotSupportedException(); + } +} diff --git a/dotnet/src/Generated/Rpc.cs b/dotnet/src/Generated/Rpc.cs index 346177f63..71d49d526 100644 --- a/dotnet/src/Generated/Rpc.cs +++ b/dotnet/src/Generated/Rpc.cs @@ -19,6 +19,7 @@ namespace GitHub.Copilot.Rpc; /// Server liveness response, including the echoed message, current server timestamp, and protocol version. +[Experimental(Diagnostics.Experimental)] public sealed class PingResult { /// Echoed message (or default greeting). @@ -35,6 +36,7 @@ public sealed class PingResult } /// Optional message to echo back to the caller. +[Experimental(Diagnostics.Experimental)] internal sealed class PingRequest { /// Optional message to echo back. @@ -43,6 +45,7 @@ internal sealed class PingRequest } /// Handshake result reporting the server's protocol version and package version on success. +[Experimental(Diagnostics.Experimental)] internal sealed class ConnectResult { /// Always true on success. @@ -58,22 +61,65 @@ internal sealed class ConnectResult public string Version { get; set; } = string.Empty; } -/// Optional connection token presented by the SDK client during the handshake. +/// Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). +[Experimental(Diagnostics.Experimental)] internal sealed class ConnectRequest { + /// Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the runtime forwards every internal telemetry event it emits — across all sessions, plus sessionless events — to this connection over the `gitHubTelemetry.event` notification. Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); host-only compatibility events are forward-only and intentionally skip that path. Intended for first-party hosts that re-emit the events into their own telemetry stores. Both unrestricted and restricted events are forwarded, each tagged with a `restricted` discriminator; a backstop drops restricted events when restricted telemetry is disabled — using the process-global gate for ordinary events and an explicit session-scoped decision for host-only events. + [JsonPropertyName("enableGitHubTelemetryForwarding")] + public bool? EnableGitHubTelemetryForwarding { get; set; } + /// Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN. [JsonPropertyName("token")] public string? Token { get; set; } } +/// Active server-driven promotion for a model, including its discount and optional expiry. +[Experimental(Diagnostics.Experimental)] +public sealed class ModelBillingPromo +{ + /// Percentage discount (0-100) applied while the promotion is active. May be fractional. + [JsonPropertyName("discountPercent")] + public double? DiscountPercent { get; set; } + + /// UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion omits this field. When present, the API only surfaces a promo whose expiry parses and is in the future, so consumers should treat a past value as expired. + [JsonPropertyName("endsAt")] + public string? EndsAt { get; set; } + + /// Stable identifier for the promotion campaign. + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present. + [JsonPropertyName("message")] + public string? Message { get; set; } +} + /// Long context tier pricing (available for models with extended context windows). +[Experimental(Diagnostics.Experimental)] public sealed class ModelBillingTokenPricesLongContext { - /// AI Credits cost per billing batch of cached tokens. + /// Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens. + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonPropertyName("cachePrice")] public double? CachePrice { get; set; } - /// Maximum context window tokens for the long context tier. + /// AI Credits cost per billing batch of cached (read) tokens. + [JsonPropertyName("cacheReadPrice")] + public double? CacheReadPrice { get; set; } + + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. + [JsonPropertyName("cacheWritePrice")] + public double? CacheWritePrice { get; set; } + + /// Use maxPromptTokens instead. Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonPropertyName("contextMax")] public long? ContextMax { get; set; } @@ -81,23 +127,44 @@ public sealed class ModelBillingTokenPricesLongContext [JsonPropertyName("inputPrice")] public double? InputPrice { get; set; } + /// Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + [JsonPropertyName("maxPromptTokens")] + public long? MaxPromptTokens { get; set; } + /// AI Credits cost per billing batch of output tokens. [JsonPropertyName("outputPrice")] public double? OutputPrice { get; set; } } /// Token-level pricing information for this model. +[Experimental(Diagnostics.Experimental)] public sealed class ModelBillingTokenPrices { /// Number of tokens per standard billing batch. [JsonPropertyName("batchSize")] public long? BatchSize { get; set; } - /// AI Credits cost per billing batch of cached tokens. + /// Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens. + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonPropertyName("cachePrice")] public double? CachePrice { get; set; } - /// Maximum context window tokens for the default tier. + /// AI Credits cost per billing batch of cached (read) tokens. + [JsonPropertyName("cacheReadPrice")] + public double? CacheReadPrice { get; set; } + + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. + [JsonPropertyName("cacheWritePrice")] + public double? CacheWritePrice { get; set; } + + /// Use maxPromptTokens instead. Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonPropertyName("contextMax")] public long? ContextMax { get; set; } @@ -109,24 +176,38 @@ public sealed class ModelBillingTokenPrices [JsonPropertyName("longContext")] public ModelBillingTokenPricesLongContext? LongContext { get; set; } + /// Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + [JsonPropertyName("maxPromptTokens")] + public long? MaxPromptTokens { get; set; } + /// AI Credits cost per billing batch of output tokens. [JsonPropertyName("outputPrice")] public double? OutputPrice { get; set; } } /// Billing information. +[Experimental(Diagnostics.Experimental)] public sealed class ModelBilling { + /// Whole-number percentage discount (0-100) applied to usage billed through this model. Populated for the synthetic `auto` model, where requests routed by auto-mode are billed at a reduced rate; absent for concrete models. + [JsonPropertyName("discountPercent")] + public int? DiscountPercent { get; set; } + /// Billing cost multiplier relative to the base rate. [JsonPropertyName("multiplier")] public double? Multiplier { get; set; } + /// Active server-driven promotion for this model, if any. Present when the model is being promoted with a discount, which may be time-boxed or open-ended. + [JsonPropertyName("promo")] + public ModelBillingPromo? Promo { get; set; } + /// Token-level pricing information for this model. [JsonPropertyName("tokenPrices")] public ModelBillingTokenPrices? TokenPrices { get; set; } } /// Vision-specific limits. +[Experimental(Diagnostics.Experimental)] public sealed class ModelCapabilitiesLimitsVision { /// Maximum image size in bytes. @@ -143,6 +224,7 @@ public sealed class ModelCapabilitiesLimitsVision } /// Token limits for prompts, outputs, and context window. +[Experimental(Diagnostics.Experimental)] public sealed class ModelCapabilitiesLimits { /// Maximum total context window size in tokens. @@ -163,8 +245,13 @@ public sealed class ModelCapabilitiesLimits } /// Feature flags indicating what the model supports. +[Experimental(Diagnostics.Experimental)] public sealed class ModelCapabilitiesSupports { + /// Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + [JsonPropertyName("adaptive_thinking")] + public AdaptiveThinkingSupport? AdaptiveThinking { get; set; } + /// Whether this model supports reasoning effort configuration. [JsonPropertyName("reasoningEffort")] public bool? ReasoningEffort { get; set; } @@ -175,6 +262,7 @@ public sealed class ModelCapabilitiesSupports } /// Model capabilities and limits. +[Experimental(Diagnostics.Experimental)] public sealed class ModelCapabilities { /// Token limits for prompts, outputs, and context window. @@ -187,6 +275,7 @@ public sealed class ModelCapabilities } /// Policy state (if applicable). +[Experimental(Diagnostics.Experimental)] public sealed class ModelPolicy { /// Current policy state for this model. @@ -198,7 +287,8 @@ public sealed class ModelPolicy public string? Terms { get; set; } } -/// Schema for the `Model` type. +/// Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. +[Experimental(Diagnostics.Experimental)] public sealed class Model { /// Billing information. @@ -209,10 +299,6 @@ public sealed class Model [JsonPropertyName("capabilities")] public ModelCapabilities Capabilities { get => field ??= new(); set; } - /// Default reasoning effort level (only present if model supports reasoning effort). - [JsonPropertyName("defaultReasoningEffort")] - public string? DefaultReasoningEffort { get; set; } - /// Model identifier (e.g., "claude-sonnet-4.5"). [JsonPropertyName("id")] public string Id { get; set; } = string.Empty; @@ -239,6 +325,7 @@ public sealed class Model } /// List of Copilot models available to the resolved user, including capabilities and billing metadata. +[Experimental(Diagnostics.Experimental)] public sealed class ModelList { /// List of available models with full metadata. @@ -247,6 +334,7 @@ public sealed class ModelList } /// RPC data type for ModelsList operations. +[Experimental(Diagnostics.Experimental)] internal sealed class ModelsListRequest { /// 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. @@ -254,7 +342,26 @@ internal sealed class ModelsListRequest public string? GitHubToken { get; set; } } -/// Schema for the `Tool` type. +/// A well-known model in the runtime's built-in catalog. +[Experimental(Diagnostics.Experimental)] +public sealed class BuiltInModelCatalogEntry +{ + /// Well-known runtime model ID suitable for `ProviderConfig.modelId` or `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; +} + +/// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. +[Experimental(Diagnostics.Experimental)] +public sealed class BuiltInModelCatalog +{ + /// Built-in model entries. + [JsonPropertyName("models")] + public IList Models { get => field ??= []; set; } +} + +/// Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. +[Experimental(Diagnostics.Experimental)] public sealed class Tool { /// Description of what the tool does. @@ -279,6 +386,7 @@ public sealed class Tool } /// Built-in tools available for the requested model, with their parameters and instructions. +[Experimental(Diagnostics.Experimental)] public sealed class ToolList { /// List of available built-in tools with metadata. @@ -287,6 +395,7 @@ public sealed class ToolList } /// Optional model identifier whose tool overrides should be applied to the listing. +[Experimental(Diagnostics.Experimental)] internal sealed class ToolsListRequest { /// Optional model ID — when provided, the returned tool list reflects model-specific overrides. @@ -294,7 +403,8 @@ internal sealed class ToolsListRequest public string? Model { get; set; } } -/// Schema for the `AccountQuotaSnapshot` type. +/// Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. +[Experimental(Diagnostics.Experimental)] public sealed class AccountQuotaSnapshot { /// Number of requests included in the entitlement, or -1 for unlimited entitlements. @@ -331,6 +441,7 @@ public sealed class AccountQuotaSnapshot } /// Quota usage snapshots for the resolved user, keyed by quota type. +[Experimental(Diagnostics.Experimental)] public sealed class AccountGetQuotaResult { /// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions). @@ -339,6 +450,7 @@ public sealed class AccountGetQuotaResult } /// RPC data type for AccountGetQuota operations. +[Experimental(Diagnostics.Experimental)] internal sealed class AccountGetQuotaRequest { /// GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. @@ -346,765 +458,810 @@ internal sealed class AccountGetQuotaRequest public string? GitHubToken { get; set; } } -/// Confirmation that the secret values were registered. -public sealed class SecretsAddFilterValuesResult +/// Initial authentication info for the session. +/// Polymorphic base type discriminated by type. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(AuthInfoHmac), "hmac")] +[JsonDerivedType(typeof(AuthInfoEnv), "env")] +[JsonDerivedType(typeof(AuthInfoToken), "token")] +[JsonDerivedType(typeof(AuthInfoCopilotApiToken), "copilot-api-token")] +[JsonDerivedType(typeof(AuthInfoUser), "user")] +[JsonDerivedType(typeof(AuthInfoGhCli), "gh-cli")] +[JsonDerivedType(typeof(AuthInfoApiKey), "api-key")] +public partial class AuthInfo { - /// Whether the values were successfully registered. - [JsonPropertyName("ok")] - public bool Ok { get; set; } + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; } -/// Secret values to add to the redaction filter. -internal sealed class SecretsAddFilterValuesRequest -{ - /// Raw secret values to register for redaction. - [JsonPropertyName("values")] - public IList Values { get => field ??= []; set; } -} -/// Schema for the `DiscoveredMcpServer` type. -public sealed class DiscoveredMcpServer +/// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. +[Experimental(Diagnostics.Experimental)] +public sealed class CopilotUserResponseEndpoints { - /// Whether the server is enabled (not in the disabled list). - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } - - /// Server name (config key). - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Configuration source: user, workspace, plugin, or builtin. - [JsonPropertyName("source")] - public McpServerSource Source { get; set; } + /// Gets or sets the api value. + [JsonPropertyName("api")] + public string? Api { get; set; } - /// Server transport type: stdio, http, sse (deprecated), or memory. - [JsonPropertyName("type")] - public DiscoveredMcpServerType? Type { get; set; } -} + /// Gets or sets the exp value. + [JsonPropertyName("exp")] + public string? Exp { get; set; } -/// MCP servers discovered from user, workspace, plugin, and built-in sources. -public sealed class McpDiscoverResult -{ - /// MCP servers discovered from all sources. - [JsonPropertyName("servers")] - public IList Servers { get => field ??= []; set; } -} + /// Gets or sets the origin-tracker value. + [JsonPropertyName("origin-tracker")] + public string? OriginTracker { get; set; } -/// Optional working directory used as context for MCP server discovery. -internal sealed class McpDiscoverRequest -{ - /// Working directory used as context for discovery (e.g., plugin resolution). - [JsonPropertyName("workingDirectory")] - public string? WorkingDirectory { get; set; } -} + /// Gets or sets the proxy value. + [JsonPropertyName("proxy")] + public string? Proxy { get; set; } -/// User-configured MCP servers, keyed by server name. -public sealed class McpConfigList -{ - /// All MCP servers from user config, keyed by name. - [JsonPropertyName("servers")] - public IDictionary Servers { get => field ??= new Dictionary(); set; } + /// Gets or sets the telemetry value. + [JsonPropertyName("telemetry")] + public string? Telemetry { get; set; } } -/// MCP server name and configuration to add to user configuration. -internal sealed class McpConfigAddRequest +/// RPC data type for CopilotUserResponseOrganizationListItem operations. +public sealed class CopilotUserResponseOrganizationListItem { - /// MCP server configuration (stdio process or remote HTTP/SSE). - [JsonPropertyName("config")] - public JsonElement Config { get; set; } + /// Gets or sets the login value. + [JsonPropertyName("login")] + public string? Login { get; set; } - /// Unique name for the MCP server. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] + /// Gets or sets the name value. [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + public string? Name { get; set; } } -/// MCP server name and replacement configuration to write to user configuration. -internal sealed class McpConfigUpdateRequest +/// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. +[Experimental(Diagnostics.Experimental)] +public sealed class CopilotUserResponseQuotaSnapshotsChat { - /// MCP server configuration (stdio process or remote HTTP/SSE). - [JsonPropertyName("config")] - public JsonElement Config { get; set; } + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + [JsonPropertyName("entitlement")] + public double? Entitlement { get; set; } - /// Name of the MCP server to update. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; -} + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + [JsonPropertyName("has_quota")] + public bool? HasQuota { get; set; } -/// MCP server name to remove from user configuration. -internal sealed class McpConfigRemoveRequest -{ - /// Name of the MCP server to remove. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; -} + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. + [JsonPropertyName("overage_count")] + public double? OverageCount { get; set; } -/// MCP server names to enable for new sessions. -internal sealed class McpConfigEnableRequest -{ - /// 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. - [JsonPropertyName("names")] - public IList Names { get => field ??= []; set; } -} + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + [JsonPropertyName("overage_permitted")] + public bool? OveragePermitted { get; set; } -/// MCP server names to disable for new sessions. -internal sealed class McpConfigDisableRequest -{ - /// 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. - [JsonPropertyName("names")] - public IList Names { get => field ??= []; set; } -} + /// Percentage of the entitlement remaining at the snapshot timestamp. + [JsonPropertyName("percent_remaining")] + public double? PercentRemaining { get; set; } -/// Schema for the `ServerSkill` type. -public sealed class ServerSkill -{ - /// Description of what the skill does. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Identifier of the quota bucket this snapshot describes. + [JsonPropertyName("quota_id")] + public string? QuotaId { get; set; } - /// Whether the skill is currently enabled (based on global config). - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Amount of quota remaining at the snapshot timestamp. + [JsonPropertyName("quota_remaining")] + public double? QuotaRemaining { get; set; } - /// Unique identifier for the skill. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Unix epoch time, in seconds, when this quota next resets. + [JsonPropertyName("quota_reset_at")] + public double? QuotaResetAt { get; set; } - /// Absolute path to the skill file. - [JsonPropertyName("path")] - public string? Path { get; set; } + /// Remaining entitlement/quota amount at the snapshot timestamp. + [JsonPropertyName("remaining")] + public double? Remaining { get; set; } - /// The project path this skill belongs to (only for project/inherited skills). - [JsonPropertyName("projectPath")] - public string? ProjectPath { get; set; } + /// UTC timestamp when this snapshot was captured. + [JsonPropertyName("timestamp_utc")] + public string? TimestampUtc { get; set; } - /// Source location type (e.g., project, personal-copilot, plugin, builtin). - [JsonPropertyName("source")] - public SkillSource Source { get; set; } + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + [JsonPropertyName("token_based_billing")] + public bool? TokenBasedBilling { get; set; } - /// Whether the skill can be invoked by the user as a slash command. - [JsonPropertyName("userInvocable")] - public bool UserInvocable { get; set; } + /// Whether the entitlement for this category is unlimited. + [JsonPropertyName("unlimited")] + public bool? Unlimited { get; set; } } -/// Skills discovered across global and project sources. -public sealed class ServerSkillList +/// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. +[Experimental(Diagnostics.Experimental)] +public sealed class CopilotUserResponseQuotaSnapshotsCompletions { - /// All discovered skills across all sources. - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } -} + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + [JsonPropertyName("entitlement")] + public double? Entitlement { get; set; } -/// Optional project paths and additional skill directories to include in discovery. -internal sealed class SkillsDiscoverRequest -{ - /// Optional list of project directory paths to scan for project-scoped skills. - [JsonPropertyName("projectPaths")] - public IList? ProjectPaths { get; set; } - - /// Optional list of additional skill directory paths to include. - [JsonPropertyName("skillDirectories")] - public IList? SkillDirectories { get; set; } -} - -/// Skill names to mark as disabled in global configuration, replacing any previous list. -internal sealed class SkillsConfigSetDisabledSkillsRequest -{ - /// List of skill names to disable. - [JsonPropertyName("disabledSkills")] - public IList DisabledSkills { get => field ??= []; set; } -} - -/// Indicates whether the calling client was registered as the session filesystem provider. -public sealed class SessionFsSetProviderResult -{ - /// Whether the provider was set successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + [JsonPropertyName("has_quota")] + public bool? HasQuota { get; set; } -/// Optional capabilities declared by the provider. -public sealed class SessionFsSetProviderCapabilities -{ - /// Whether the provider supports SQLite query/exists operations. - [JsonPropertyName("sqlite")] - public bool? Sqlite { get; set; } -} + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. + [JsonPropertyName("overage_count")] + public double? OverageCount { get; set; } -/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. -internal sealed class SessionFsSetProviderRequest -{ - /// Optional capabilities declared by the provider. - [JsonPropertyName("capabilities")] - public SessionFsSetProviderCapabilities? Capabilities { get; set; } + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + [JsonPropertyName("overage_permitted")] + public bool? OveragePermitted { get; set; } - /// Path conventions used by this filesystem. - [JsonPropertyName("conventions")] - public SessionFsSetProviderConventions Conventions { get; set; } + /// Percentage of the entitlement remaining at the snapshot timestamp. + [JsonPropertyName("percent_remaining")] + public double? PercentRemaining { get; set; } - /// Initial working directory for sessions. - [JsonPropertyName("initialCwd")] - public string InitialCwd { get; set; } = string.Empty; + /// Identifier of the quota bucket this snapshot describes. + [JsonPropertyName("quota_id")] + public string? QuotaId { get; set; } - /// Path within each session's SessionFs where the runtime stores files for that session. - [JsonPropertyName("sessionStatePath")] - public string SessionStatePath { get; set; } = string.Empty; -} + /// Amount of quota remaining at the snapshot timestamp. + [JsonPropertyName("quota_remaining")] + public double? QuotaRemaining { get; set; } -/// Identifier and optional friendly name assigned to the newly forked session. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionsForkResult -{ - /// Friendly name assigned to the forked session, if any. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Unix epoch time, in seconds, when this quota next resets. + [JsonPropertyName("quota_reset_at")] + public double? QuotaResetAt { get; set; } - /// The new forked session's ID. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Remaining entitlement/quota amount at the snapshot timestamp. + [JsonPropertyName("remaining")] + public double? Remaining { get; set; } -/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionsForkRequest -{ - /// Optional friendly name to assign to the forked session. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// UTC timestamp when this snapshot was captured. + [JsonPropertyName("timestamp_utc")] + public string? TimestampUtc { get; set; } - /// Source session ID to fork from. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + [JsonPropertyName("token_based_billing")] + public bool? TokenBasedBilling { get; set; } - /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included. - [JsonPropertyName("toEventId")] - public string? ToEventId { get; set; } + /// Whether the entitlement for this category is unlimited. + [JsonPropertyName("unlimited")] + public bool? Unlimited { get; set; } } -/// Repository associated with the connected remote session. +/// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. [Experimental(Diagnostics.Experimental)] -public sealed class ConnectedRemoteSessionMetadataRepository +public sealed class CopilotUserResponseQuotaSnapshotsPremiumInteractions { - /// Branch associated with the remote session. - [JsonPropertyName("branch")] - public string Branch { get; set; } = string.Empty; - - /// Repository name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Repository owner or organization login. - [JsonPropertyName("owner")] - public string Owner { get; set; } = string.Empty; -} + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + [JsonPropertyName("entitlement")] + public double? Entitlement { get; set; } -/// Metadata for a connected remote session. -[Experimental(Diagnostics.Experimental)] -public sealed class ConnectedRemoteSessionMetadata -{ - /// Neutral SDK discriminator for the connected remote session kind. - [JsonPropertyName("kind")] - public ConnectedRemoteSessionMetadataKind Kind { get; set; } + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + [JsonPropertyName("has_quota")] + public bool? HasQuota { get; set; } - /// Last session update time as an ISO 8601 string. - [JsonPropertyName("modifiedTime")] - public DateTimeOffset ModifiedTime { get; set; } + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. + [JsonPropertyName("overage_count")] + public double? OverageCount { get; set; } - /// Optional friendly session name. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + [JsonPropertyName("overage_permitted")] + public bool? OveragePermitted { get; set; } - /// Pull request number associated with the session. - [JsonPropertyName("pullRequestNumber")] - public long? PullRequestNumber { get; set; } + /// Percentage of the entitlement remaining at the snapshot timestamp. + [JsonPropertyName("percent_remaining")] + public double? PercentRemaining { get; set; } - /// Repository associated with the connected remote session. - [JsonPropertyName("repository")] - public ConnectedRemoteSessionMetadataRepository Repository { get => field ??= new(); set; } + /// Identifier of the quota bucket this snapshot describes. + [JsonPropertyName("quota_id")] + public string? QuotaId { get; set; } - /// Original remote resource identifier. - [JsonPropertyName("resourceId")] - public string? ResourceId { get; set; } + /// Amount of quota remaining at the snapshot timestamp. + [JsonPropertyName("quota_remaining")] + public double? QuotaRemaining { get; set; } - /// SDK session ID for the connected remote session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Unix epoch time, in seconds, when this quota next resets. + [JsonPropertyName("quota_reset_at")] + public double? QuotaResetAt { get; set; } - /// Remote session staleness deadline as an ISO 8601 string. - [JsonPropertyName("staleAt")] - public DateTimeOffset? StaleAt { get; set; } + /// Remaining entitlement/quota amount at the snapshot timestamp. + [JsonPropertyName("remaining")] + public double? Remaining { get; set; } - /// Session start time as an ISO 8601 string. - [JsonPropertyName("startTime")] - public DateTimeOffset StartTime { get; set; } + /// UTC timestamp when this snapshot was captured. + [JsonPropertyName("timestamp_utc")] + public string? TimestampUtc { get; set; } - /// Remote session state returned by the backing service. - [JsonPropertyName("state")] - public string? State { get; set; } + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + [JsonPropertyName("token_based_billing")] + public bool? TokenBasedBilling { get; set; } - /// Optional session summary. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// Whether the entitlement for this category is unlimited. + [JsonPropertyName("unlimited")] + public bool? Unlimited { get; set; } } -/// Remote session connection result. +/// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. [Experimental(Diagnostics.Experimental)] -public sealed class RemoteSessionConnectionResult +public sealed class CopilotUserResponseQuotaSnapshots { - /// Metadata for a connected remote session. - [JsonPropertyName("metadata")] - public ConnectedRemoteSessionMetadata Metadata { get => field ??= new(); set; } + /// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + [JsonPropertyName("chat")] + public CopilotUserResponseQuotaSnapshotsChat? Chat { get; set; } - /// SDK session ID for the connected remote session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + [JsonPropertyName("completions")] + public CopilotUserResponseQuotaSnapshotsCompletions? Completions { get; set; } -/// Remote session connection parameters. -[Experimental(Diagnostics.Experimental)] -internal sealed class ConnectRemoteSessionParams -{ - /// Session ID to connect to. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + [JsonPropertyName("premium_interactions")] + public CopilotUserResponseQuotaSnapshotsPremiumInteractions? PremiumInteractions { get; set; } } -/// Schema for the `SessionContext` type. +/// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. [Experimental(Diagnostics.Experimental)] -public sealed class SessionContext +public sealed class CopilotUserResponse { - /// Active git branch. - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// Copilot access SKU identifier (e.g. `free_limited_copilot`, `copilot_for_business_seat_quota`) used to gate model and feature access. + [JsonPropertyName("access_type_sku")] + public string? AccessTypeSku { get; set; } - /// Most recent working directory for this session. - [JsonPropertyName("cwd")] - public string Cwd { get; set; } = string.Empty; + /// Opaque analytics tracking identifier for the user, forwarded from the Copilot API. + [JsonPropertyName("analytics_tracking_id")] + public string? AnalyticsTrackingId { get; set; } - /// Git repository root, if the cwd was inside a git repo. - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Date the Copilot seat was assigned to the user, if applicable. + [JsonPropertyName("assigned_date")] + public string? AssignedDate { get; set; } - /// Repository host type. - [JsonPropertyName("hostType")] - public SessionContextHostType? HostType { get; set; } + /// Whether the user is eligible to sign up for the free/limited Copilot tier. + [JsonPropertyName("can_signup_for_limited")] + public bool? CanSignupForLimited { get; set; } - /// Repository slug in `owner/name` form, when known. - [JsonPropertyName("repository")] - public string? Repository { get; set; } -} + /// Whether the user is able to upgrade their Copilot plan. + [JsonPropertyName("can_upgrade_plan")] + public bool? CanUpgradePlan { get; set; } -/// Schema for the `SessionMetadata` type. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionMetadata -{ - /// Runtime client name that created/last resumed this session. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// Whether Copilot chat is enabled for the user. + [JsonPropertyName("chat_enabled")] + public bool? ChatEnabled { get; set; } - /// Schema for the `SessionContext` type. - [JsonPropertyName("context")] - public SessionContext? Context { get; set; } + /// Whether CLI remote control is enabled for the user. + [JsonPropertyName("cli_remote_control_enabled")] + public bool? CliRemoteControlEnabled { get; set; } - /// True for detached maintenance sessions that should be hidden from normal resume lists. - [JsonPropertyName("isDetached")] - public bool? IsDetached { get; set; } + /// Whether cloud session storage is enabled for the user. + [JsonPropertyName("cloud_session_storage_enabled")] + public bool? CloudSessionStorageEnabled { get; set; } - /// True for remote (GitHub) sessions; false for local. - [JsonPropertyName("isRemote")] - public bool IsRemote { get; set; } + /// Whether the Codex agent is enabled for the user. + [JsonPropertyName("codex_agent_enabled")] + public bool? CodexAgentEnabled { get; set; } - /// GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. - [JsonPropertyName("mcTaskId")] - public string? McTaskId { get; set; } + /// Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`). + [JsonPropertyName("copilot_plan")] + public string? CopilotPlan { get; set; } - /// Last-modified time of the session's persisted state, as ISO 8601. - [JsonPropertyName("modifiedTime")] - public string ModifiedTime { get; set; } = string.Empty; + /// Whether `.copilotignore` content-exclusion support is enabled for the user. + [JsonPropertyName("copilotignore_enabled")] + public bool? CopilotignoreEnabled { get; set; } - /// Optional human-friendly name set via /rename. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. + [JsonPropertyName("endpoints")] + public CopilotUserResponseEndpoints? Endpoints { get; set; } - /// Stable session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether MCP (Model Context Protocol) support is enabled for the user. + [JsonPropertyName("is_mcp_enabled")] + public bool? IsMcpEnabled { get; set; } - /// Session creation time as an ISO 8601 timestamp. - [JsonPropertyName("startTime")] - public string StartTime { get; set; } = string.Empty; + /// Whether the user is a GitHub/Microsoft staff member. + [JsonPropertyName("is_staff")] + public bool? IsStaff { get; set; } - /// Short summary of the session, when one has been derived. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// Per-category quota allotments for free/limited-tier users, keyed by quota category. + [JsonPropertyName("limited_user_quotas")] + public IDictionary? LimitedUserQuotas { get; set; } + + /// Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API. + [JsonPropertyName("limited_user_reset_date")] + public string? LimitedUserResetDate { get; set; } + + /// GitHub login of the authenticated user. + [JsonPropertyName("login")] + public string? Login { get; set; } + + /// Per-category monthly quota allotments, keyed by quota category. + [JsonPropertyName("monthly_quotas")] + public IDictionary? MonthlyQuotas { get; set; } + + /// Organizations the user belongs to, each with an optional login and display name. + [JsonPropertyName("organization_list")] + public IList? OrganizationList { get; set; } + + /// Logins of the organizations the user belongs to. + [JsonPropertyName("organization_login_list")] + public IList? OrganizationLoginList { get; set; } + + /// Date the user's usage quota next resets, as a raw string from the Copilot API; see `quota_reset_date_utc` for the UTC-normalized value. + [JsonPropertyName("quota_reset_date")] + public string? QuotaResetDate { get; set; } + + /// UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets). + [JsonPropertyName("quota_reset_date_utc")] + public string? QuotaResetDateUtc { get; set; } + + /// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. + [JsonPropertyName("quota_snapshots")] + public CopilotUserResponseQuotaSnapshots? QuotaSnapshots { get; set; } + + /// Whether the user's telemetry is subject to restricted-data handling. + [JsonPropertyName("restricted_telemetry")] + public bool? RestrictedTelemetry { get; set; } + + /// Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime. + [JsonPropertyName("te")] + public bool? Te { get; set; } + + /// Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota. + [JsonPropertyName("token_based_billing")] + public bool? TokenBasedBilling { get; set; } } -/// Persisted sessions matching the filter, ordered most-recently-modified first. +/// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. +/// The hmac variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionList +public partial class AuthInfoHmac : AuthInfo { - /// Sessions ordered most-recently-modified first. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; set; } + /// + [JsonIgnore] + public override string Type => "hmac"; + + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// HMAC secret used to sign requests. + [JsonPropertyName("hmac")] + public required string Hmac { get; set; } + + /// Authentication host. HMAC auth always targets the public GitHub host. + [JsonPropertyName("host")] + public required string Host { get; set; } } -/// Optional filter applied to the returned sessions. +/// Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. +/// The env variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionListFilter +public partial class AuthInfoEnv : AuthInfo { - /// Match sessions whose context.branch equals this value. - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// + [JsonIgnore] + public override string Type => "env"; - /// Match sessions whose context.cwd equals this value. - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } - /// Match sessions whose context.gitRoot equals this value. - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Name of the environment variable the token was sourced from. + [JsonPropertyName("envVar")] + public required string EnvVar { get; set; } - /// Match sessions whose context.repository equals this value. - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// Authentication host (e.g. https://github.com or a GHES host). + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("login")] + public string? Login { get; set; } + + /// The token value itself. Treat as a secret. + [JsonPropertyName("token")] + public required string Token { get; set; } } -/// Optional metadata-load limit and filters applied to the returned sessions. +/// Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. +/// The token variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsListRequest +public partial class AuthInfoToken : AuthInfo { - /// Optional filter applied to the returned sessions. - [JsonPropertyName("filter")] - public SessionListFilter? Filter { get; set; } + /// + [JsonIgnore] + public override string Type => "token"; - /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. - [JsonPropertyName("includeDetached")] - public bool? IncludeDetached { get; set; } + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } - /// When provided, only the first N sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every session. - [JsonPropertyName("metadataLimit")] - public long? MetadataLimit { get; set; } + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// The token value itself. Treat as a secret. + [JsonPropertyName("token")] + public required string Token { get; set; } } -/// ID of the local session bound to the given GitHub task, or omitted when none. +/// Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. +/// The copilot-api-token variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionsFindByTaskIDResult +public partial class AuthInfoCopilotApiToken : AuthInfo { - /// Omitted when no local session is bound to that GitHub task. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// + [JsonIgnore] + public override string Type => "copilot-api-token"; + + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// Authentication host (always the public GitHub host). + [JsonPropertyName("host")] + public required string Host { get; set; } } -/// GitHub task ID to look up. +/// Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. +/// The user variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsFindByTaskIDRequest +public partial class AuthInfoUser : AuthInfo { - /// GitHub task ID to look up. - [JsonPropertyName("taskId")] - public string TaskId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "user"; + + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// OAuth user login. + [JsonPropertyName("login")] + public required string Login { get; set; } } -/// Session ID matching the prefix, omitted when no unique match exists. +/// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. +/// The gh-cli variant of . [Experimental(Diagnostics.Experimental)] -public sealed class SessionsFindByPrefixResult +public partial class AuthInfoGhCli : AuthInfo { - /// Omitted when no unique session matches the prefix (no match or ambiguous). - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// + [JsonIgnore] + public override string Type => "gh-cli"; + + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } + + /// User login as reported by `gh auth status`. + [JsonPropertyName("login")] + public required string Login { get; set; } + + /// The token returned by `gh auth token`. Treat as a secret. + [JsonPropertyName("token")] + public required string Token { get; set; } } -/// UUID prefix to resolve to a unique session ID. +/// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. +/// The api-key variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsFindByPrefixRequest +public partial class AuthInfoApiKey : AuthInfo { - /// UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when there is no match or the prefix matches multiple sessions. - [JsonPropertyName("prefix")] - public string Prefix { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "api-key"; + + /// The API key. Treat as a secret. + [JsonPropertyName("apiKey")] + public required string ApiKey { get; set; } + + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("copilotUser")] + public CopilotUserResponse? CopilotUser { get; set; } + + /// Authentication host. + [JsonPropertyName("host")] + public required string Host { get; set; } } -/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +/// Current authentication state. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsGetLastForContextResult +public sealed class AccountGetCurrentAuthResult { - /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// Authentication errors from the last auth attempt, if any. + [JsonPropertyName("authErrors")] + public IList? AuthErrors { get; set; } + + /// Current authentication information, if authenticated. + [JsonPropertyName("authInfo")] + public AuthInfo? AuthInfo { get; set; } } -/// Optional working-directory context used to score session relevance. +/// Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetLastForContextRequest +public sealed class AccountAllUsers { - /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. - [JsonPropertyName("context")] - public SessionContext? Context { get; set; } + /// Authentication information for this user. + [JsonPropertyName("authInfo")] + public AuthInfo AuthInfo { get => field ??= new(); set; } + + /// Associated token, if available. + [JsonPropertyName("token")] + public string? Token { get; set; } } -/// Absolute path to the session's events.jsonl file on disk. +/// Result of a successful login; throws on failure. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsGetEventFilePathResult +public sealed class AccountLoginResult { - /// Absolute path to the session's events.jsonl file. - [JsonPropertyName("filePath")] - public string FilePath { get; set; } = string.Empty; + /// Whether the credential was persisted to a secure store (system keychain, or the config file when plaintext storage is enabled). False when no secure store was available and the token was not saved, so the consumer can decide how to proceed. + [JsonPropertyName("storedInVault")] + public bool StoredInVault { get; set; } } -/// Session ID whose event-log file path to compute. +/// Credentials to store after successful authentication. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetEventFilePathRequest +internal sealed class AccountLoginRequest { - /// Session ID whose event-log file path to compute. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// GitHub host URL. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; + + /// User login/username. + [JsonPropertyName("login")] + public string Login { get; set; } = string.Empty; + + /// GitHub authentication token. + [JsonPropertyName("token")] + public string Token { get; set; } = string.Empty; } -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// Logout result indicating if more users remain. [Experimental(Diagnostics.Experimental)] -public sealed class SessionSizes +public sealed class AccountLogoutResult { - /// Map of sessionId -> on-disk size in bytes for the session's workspace directory. - [JsonPropertyName("sizes")] - public IDictionary Sizes { get => field ??= new Dictionary(); set; } + /// Whether other authenticated users remain after logout. + [JsonPropertyName("hasMoreUsers")] + public bool HasMoreUsers { get; set; } } -/// Session IDs from the input set that are currently in use by another process. +/// User to log out. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsCheckInUseResult +internal sealed class AccountLogoutRequest { - /// Session IDs from the input set that are currently held by another running process via an alive lock file. - [JsonPropertyName("inUse")] - public IList InUse { get => field ??= []; set; } + /// Authentication information for the user to log out. + [JsonPropertyName("authInfo")] + public AuthInfo AuthInfo { get => field ??= new(); set; } } -/// Session IDs to test for live in-use locks. +/// Confirmation that the secret values were registered. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsCheckInUseRequest +public sealed class SecretsAddFilterValuesResult { - /// Session IDs to test for live in-use locks. - [JsonPropertyName("sessionIds")] - public IList SessionIds { get => field ??= []; set; } + /// Whether the values were successfully registered. + [JsonPropertyName("ok")] + public bool Ok { get; set; } } -/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +/// Secret values to add to the redaction filter. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsGetPersistedRemoteSteerableResult +internal sealed class SecretsAddFilterValuesRequest { - /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted. - [JsonPropertyName("remoteSteerable")] - public bool? RemoteSteerable { get; set; } + /// Raw secret values to register for redaction. + [JsonPropertyName("values")] + public IList Values { get => field ??= []; set; } } -/// Session ID to look up the persisted remote-steerable flag for. +/// MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsGetPersistedRemoteSteerableRequest +public sealed class DiscoveredMcpServer { - /// Session ID to look up the persisted remote-steerable flag for. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Whether the server is enabled (not in the disabled list). + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } -/// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionsCloseResult -{ + /// Server name (config key). + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Configuration source: user, workspace, plugin, or builtin. + [JsonPropertyName("source")] + public McpServerSource Source { get; set; } + + /// Plugin name that provided this server, when source is plugin. + [JsonPropertyName("sourcePlugin")] + public string? SourcePlugin { get; set; } + + /// Plugin version that provided this server, when source is plugin. + [JsonPropertyName("sourcePluginVersion")] + public string? SourcePluginVersion { get; set; } + + /// Server transport type: stdio, http, sse (deprecated), or memory. + [JsonPropertyName("type")] + public DiscoveredMcpServerType? Type { get; set; } } -/// Session ID to close. +/// MCP servers discovered from user, workspace, plugin, and built-in sources. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsCloseRequest +public sealed class McpDiscoverResult { - /// Session ID to close. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// MCP servers discovered from all sources. + [JsonPropertyName("servers")] + public IList Servers { get => field ??= []; set; } } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Optional working directory used as context for MCP server discovery. [Experimental(Diagnostics.Experimental)] -public sealed class SessionBulkDeleteResult +internal sealed class McpDiscoverRequest { - /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). - [JsonPropertyName("freedBytes")] - public IDictionary FreedBytes { get => field ??= new Dictionary(); set; } + /// Working directory used as context for discovery (e.g., plugin resolution). + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } } -/// Session IDs to close, deactivate, and delete from disk. +/// User-configured MCP servers, keyed by server name. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsBulkDeleteRequest +public sealed class McpConfigList { - /// Session IDs to close, deactivate, and delete from disk. - [JsonPropertyName("sessionIds")] - public IList SessionIds { get => field ??= []; set; } + /// All MCP servers from user config, keyed by name. + [JsonPropertyName("servers")] + public IDictionary Servers { get => field ??= new Dictionary(); set; } } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// MCP server name and configuration to add to user configuration. [Experimental(Diagnostics.Experimental)] -public sealed class SessionPruneResult +internal sealed class McpConfigAddRequest { - /// Session IDs that would be deleted in dry-run mode (always empty otherwise). - [JsonPropertyName("candidates")] - public IList Candidates { get => field ??= []; set; } - - /// Session IDs that were deleted (always empty in dry-run mode). - [JsonPropertyName("deleted")] - public IList Deleted { get => field ??= []; set; } - - /// True when no deletions were actually performed. - [JsonPropertyName("dryRun")] - public bool DryRun { get; set; } - - /// Total bytes freed (actual when not dry-run, projected when dry-run). - [JsonPropertyName("freedBytes")] - public long FreedBytes { get; set; } + /// MCP server configuration (stdio process or remote HTTP/SSE). + [JsonPropertyName("config")] + public JsonElement Config { get; set; } - /// Session IDs that were skipped (e.g., named sessions). - [JsonPropertyName("skipped")] - public IList Skipped { get => field ??= []; set; } + /// Unique name for the MCP server. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). +/// MCP server name and replacement configuration to write to user configuration. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsPruneOldRequest +internal sealed class McpConfigUpdateRequest { - /// When true, only report what would be deleted without performing any deletion. - [JsonPropertyName("dryRun")] - public bool? DryRun { get; set; } - - /// Session IDs that should never be considered for pruning. - [JsonPropertyName("excludeSessionIds")] - public IList? ExcludeSessionIds { get; set; } - - /// When true, named sessions (set via /rename) are also eligible for pruning. - [JsonPropertyName("includeNamed")] - public bool? IncludeNamed { get; set; } + /// MCP server configuration (stdio process or remote HTTP/SSE). + [JsonPropertyName("config")] + public JsonElement Config { get; set; } - /// Delete sessions whose modifiedTime is at least this many days old. - [JsonPropertyName("olderThanDays")] - public long OlderThanDays { get; set; } + /// Name of the MCP server to update. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). +/// MCP server name to remove from user configuration. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsSaveResult +internal sealed class McpConfigRemoveRequest { + /// Name of the MCP server to remove. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Session ID whose pending events should be flushed to disk. +/// MCP server names to enable for new sessions. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsSaveRequest +internal sealed class McpConfigEnableRequest { - /// Session ID whose pending events should be flushed to disk. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// 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. + [JsonPropertyName("names")] + public IList Names { get => field ??= []; set; } } -/// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. +/// MCP server names to disable for new sessions. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsReleaseLockResult +internal sealed class McpConfigDisableRequest { + /// 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. + [JsonPropertyName("names")] + public IList Names { get => field ??= []; set; } } -/// Session ID whose in-use lock should be released. +/// Installed plugin that contributes a discovered extension. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsReleaseLockRequest +public sealed class DiscoveredExtensionPlugin { - /// Session ID whose in-use lock should be released. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Installed plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// Discovered extension metadata and persistent enablement state. [Experimental(Diagnostics.Experimental)] -public sealed class SessionEnrichMetadataResult +public sealed class DiscoveredExtension { - /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; set; } -} + /// Whether this extension's persistent per-ID preference is enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } -/// Session metadata records to enrich with summary and context information. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionsEnrichMetadataRequest -{ - /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. - [JsonPropertyName("sessions")] - public IList Sessions { get => field ??= []; set; } -} + /// Source-qualified ID accepted by both server and session extension enablement methods. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; -/// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionsReloadPluginHooksResult -{ -} + /// Human-readable extension name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; -/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionsReloadPluginHooksRequest -{ - /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. - [JsonPropertyName("deferRepoHooks")] - public bool? DeferRepoHooks { get; set; } + /// Absolute path to the extension entry module, suitable for revealing it in a file manager. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Active session ID to reload hooks for. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Containing plugin metadata for plugin-contributed extensions. + [JsonPropertyName("plugin")] + public DiscoveredExtensionPlugin? Plugin { get; set; } + + /// Discovery source. + [JsonPropertyName("source")] + public DiscoveredExtensionSource Source { get; set; } } -/// Queued repo-level startup prompts and the total hook command count after loading. +/// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. [Experimental(Diagnostics.Experimental)] -public sealed class SessionLoadDeferredRepoHooksResult +public sealed class DiscoveredExtensions { - /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. - [JsonPropertyName("hookCount")] - public long HookCount { get; set; } + /// Discovered user and enabled installed-plugin extensions from persisted Copilot home state. + [JsonPropertyName("extensions")] + public IList Extensions { get => field ??= []; set; } - /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. - [JsonPropertyName("startupPrompts")] - public IList StartupPrompts { get => field ??= []; set; } + /// Effective extension loading mode. Defaults to load_and_augment when unset. + [JsonPropertyName("mode")] + public DiscoveredExtensionMode Mode { get; set; } } -/// Active session ID whose deferred repo-level hooks should be loaded. +/// Source-qualified extension identifiers to persistently enable for future sessions. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsLoadDeferredRepoHooksRequest +internal sealed class DiscoveredExtensionsEnableRequest { - /// Active session ID whose deferred repo-level hooks should be loaded. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Source-qualified user or plugin extension IDs to enable. + [JsonPropertyName("ids")] + public IList Ids { get => field ??= []; set; } } -/// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. +/// Source-qualified extension identifiers to persistently disable for future sessions. [Experimental(Diagnostics.Experimental)] -public sealed class SessionsSetAdditionalPluginsResult +internal sealed class DiscoveredExtensionsDisableRequest { + /// Source-qualified user or plugin extension IDs to disable. + [JsonPropertyName("ids")] + public IList Ids { get => field ??= []; set; } } -/// Schema for the `InstalledPlugin` type. +/// Information about an installed plugin tracked in global state. [Experimental(Diagnostics.Experimental)] -public sealed class InstalledPlugin +public sealed class InstalledPluginInfo { - /// Path where the plugin is cached locally. - [JsonPropertyName("cache_path")] - public string? CachePath { get; set; } + /// Opaque, stable hash identifying a direct (non-marketplace) install source. Present only for direct repo / URL / local installs; absent for marketplace plugins. Same source yields the same id; distinct sources never collide. + [JsonPropertyName("directSourceId")] + public string? DirectSourceId { get; set; } - /// Whether the plugin is currently enabled. + /// Whether the plugin is currently enabled for new sessions. [JsonPropertyName("enabled")] public bool Enabled { get; set; } - /// Installation timestamp. - [JsonPropertyName("installed_at")] - public string InstalledAt { get; set; } = string.Empty; - - /// Marketplace the plugin came from (empty string for direct repo installs). + /// Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. [JsonPropertyName("marketplace")] public string Marketplace { get; set; } = string.Empty; @@ -1112,7272 +1269,17441 @@ public sealed class InstalledPlugin [JsonPropertyName("name")] public string Name { get; set; } = string.Empty; - /// Source for direct repo installs (when marketplace is empty). - [JsonPropertyName("source")] - public JsonElement? Source { get; set; } - - /// Version installed (if available). + /// Installed version (when reported by the plugin manifest). [JsonPropertyName("version")] public string? Version { get; set; } } -/// Manager-wide additional plugins to register; replaces any previously-configured set. +/// Plugins installed in user/global state. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionsSetAdditionalPluginsRequest +public sealed class PluginListResult { - /// Manager-wide additional plugins to register. Replaces any previously-configured set. Pass an empty array to clear. + /// Installed plugins. [JsonPropertyName("plugins")] - public IList Plugins { get => field ??= []; set; } + public IList Plugins { get => field ??= []; set; } } -/// Outcome of an agentRegistry.spawn call. -/// Polymorphic base type discriminated by kind. +/// Result of installing a plugin. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(AgentRegistrySpawnResultSpawned), "spawned")] -[JsonDerivedType(typeof(AgentRegistrySpawnResultSpawnError), "spawn-error")] -[JsonDerivedType(typeof(AgentRegistrySpawnResultRegistryTimeout), "registry-timeout")] -[JsonDerivedType(typeof(AgentRegistrySpawnResultValidationError), "validation-error")] -public partial class AgentRegistrySpawnResult +public sealed class PluginInstallResult { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} + /// Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. + [JsonPropertyName("deprecationWarning")] + public string? DeprecationWarning { get; set; } + /// The newly installed plugin's metadata. + [JsonPropertyName("plugin")] + public InstalledPluginInfo Plugin { get => field ??= new(); set; } -/// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). -[Experimental(Diagnostics.Experimental)] -public sealed class AgentRegistryLiveTargetEntry -{ - /// Kind of attention required when status === "attention". Meaningful only when status === "attention". - [JsonPropertyName("attentionKind")] - public AgentRegistryLiveTargetEntryAttentionKind? AttentionKind { get; set; } - - /// Git branch of the session (when known). - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// Optional post-install message provided by the plugin (e.g. setup instructions). + [JsonPropertyName("postInstallMessage")] + public string? PostInstallMessage { get; set; } - /// Copilot CLI version that wrote the entry. - [JsonPropertyName("copilotVersion")] - public string CopilotVersion { get; set; } = string.Empty; + /// Number of skills discovered and installed from the plugin. + [JsonPropertyName("skillsInstalled")] + public long SkillsInstalled { get; set; } +} - /// Working directory of the session (when known). - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } +/// Plugin source and optional working directory for relative-path resolution. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsInstallRequest +{ + /// Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result. + [JsonPropertyName("source")] + public string Source { get; set; } = string.Empty; - /// Bind host for the entry's JSON-RPC server. - [JsonPropertyName("host")] - public string Host { get; set; } = string.Empty; + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } +} - /// Process kind tag for the registry entry. - [JsonPropertyName("kind")] - public AgentRegistryLiveTargetEntryKind Kind { get; set; } +/// Name (or spec) of the plugin to uninstall. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsUninstallRequest +{ + /// Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. + [JsonPropertyName("directSourceId")] + public string? DirectSourceId { get; set; } - /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness). - [JsonPropertyName("lastSeenMs")] - public long LastSeenMs { get; set; } + /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; +} - /// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. - [JsonPropertyName("lastTerminalEvent")] - public AgentRegistryLiveTargetEntryLastTerminalEvent? LastTerminalEvent { get; set; } +/// Result of updating a single plugin. +[Experimental(Diagnostics.Experimental)] +public sealed class PluginUpdateResult +{ + /// Version after the update, when reported by the plugin manifest. + [JsonPropertyName("newVersion")] + public string? NewVersion { get; set; } - /// Model identifier currently selected for the session. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// Version that was previously installed, when available. + [JsonPropertyName("previousVersion")] + public string? PreviousVersion { get; set; } - /// Operating-system pid of the process owning this entry. - [JsonPropertyName("pid")] - public long Pid { get; set; } + /// Number of skills discovered and installed after the update. + [JsonPropertyName("skillsInstalled")] + public long SkillsInstalled { get; set; } +} - /// TCP port the entry's JSON-RPC server is listening on. - [JsonPropertyName("port")] - public long Port { get; set; } +/// Name (or spec) of the plugin to update. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsUpdateRequest +{ + /// Plugin name or "plugin@marketplace" spec to update. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; +} - /// Registry entry schema version (1 = ui-server, 2 = managed-server). - [JsonPropertyName("schemaVersion")] - public long SchemaVersion { get; set; } +/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. +[Experimental(Diagnostics.Experimental)] +public sealed class PluginUpdateAllEntry +{ + /// Error message (failure only). + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Session ID of the foreground session for this entry. - [JsonPropertyName("sessionId")] - public string? SessionId { get; set; } + /// Marketplace the plugin came from. Empty string ("") for direct installs. + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; - /// Friendly session name (when set). - [JsonPropertyName("sessionName")] - public string? SessionName { get; set; } + /// Plugin name that was updated. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// ISO 8601 timestamp captured at registration. - [JsonPropertyName("startedAt")] - public string StartedAt { get; set; } = string.Empty; + /// Version after the update, when available. + [JsonPropertyName("newVersion")] + public string? NewVersion { get; set; } - /// Coarse lifecycle status of the foreground session. - [JsonPropertyName("status")] - public AgentRegistryLiveTargetEntryStatus? Status { get; set; } + /// Previously installed version, when available. + [JsonPropertyName("previousVersion")] + public string? PreviousVersion { get; set; } - /// Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. - [JsonPropertyName("statusRevision")] - public long? StatusRevision { get; set; } + /// Number of skills installed after the update (success only). + [JsonPropertyName("skillsInstalled")] + public long? SkillsInstalled { get; set; } - /// Connection token (null when the target is unauthenticated). - [JsonInclude] - [JsonPropertyName("token")] - internal string? Token { get; set; } + /// Whether the update succeeded for this plugin. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Per-spawn log-capture outcome; populated from spawnLiveTarget. +/// Result of updating all installed plugins. [Experimental(Diagnostics.Experimental)] -public sealed class AgentRegistryLogCapture +public sealed class PluginUpdateAllResult { - /// Whether per-spawn log capture is on (false when env-disabled or open failed). - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } - - /// Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used). - [JsonPropertyName("openError")] - public string? OpenError { get; set; } - - /// Categorized reason for log-open failure. - [JsonPropertyName("openErrorReason")] - public AgentRegistryLogCaptureOpenErrorReason? OpenErrorReason { get; set; } - - /// Absolute path to the per-spawn log file (only set when enabled). - [JsonPropertyName("path")] - public string? Path { get; set; } + /// Per-plugin update results in deterministic order. + [JsonPropertyName("results")] + public IList Results { get => field ??= []; set; } } -/// Managed-server child was spawned and registered successfully. -/// The spawned variant of . +/// Plugin names (or specs) to enable. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultSpawned : AgentRegistrySpawnResult +internal sealed class PluginsEnableRequest { - /// - [JsonIgnore] - public override string Kind => "spawned"; - - /// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). - [JsonPropertyName("entry")] - public required AgentRegistryLiveTargetEntry Entry { get; set; } - - /// If the delegate attempted to send the initial prompt and failed, the categorized error message. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("initialPromptError")] - public string? InitialPromptError { get; set; } - - /// Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("initialPromptSent")] - public bool? InitialPromptSent { get; set; } - - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logCapture")] - public AgentRegistryLogCapture? LogCapture { get; set; } + /// Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API. + [JsonPropertyName("names")] + public IList Names { get => field ??= []; set; } } -/// `child_process.spawn` itself failed before the child entered the registry. -/// The spawn-error variant of . +/// Plugin names (or specs) to disable. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultSpawnError : AgentRegistrySpawnResult +internal sealed class PluginsDisableRequest { - /// - [JsonIgnore] - public override string Kind => "spawn-error"; - - /// Underlying errno code (e.g. ENOENT, EACCES) when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("code")] - public string? Code { get; set; } - - /// Human-readable error message. - [JsonPropertyName("message")] - public required string Message { get; set; } + /// Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins. + [JsonPropertyName("names")] + public IList Names { get => field ??= []; set; } } -/// Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. -/// The registry-timeout variant of . +/// Registered marketplace summary. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultRegistryTimeout : AgentRegistrySpawnResult +public sealed class MarketplaceInfo { - /// - [JsonIgnore] - public override string Kind => "registry-timeout"; + /// True when this is a default marketplace shipped with the runtime. Defaults are not removable. + [JsonPropertyName("isDefault")] + public bool? IsDefault { get; set; } - /// Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance). - [JsonPropertyName("childPid")] - public required long ChildPid { get; set; } + /// Marketplace name (matches the @marketplace suffix in plugin specs). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Per-spawn log-capture outcome; populated from spawnLiveTarget. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logCapture")] - public AgentRegistryLogCapture? LogCapture { get; set; } + /// Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: owner/repo"). + [JsonPropertyName("source")] + public string Source { get; set; } = string.Empty; } -/// Synchronous pre-validation rejected the spawn request. -/// The validation-error variant of . +/// All registered marketplaces, including built-in defaults. [Experimental(Diagnostics.Experimental)] -public partial class AgentRegistrySpawnResultValidationError : AgentRegistrySpawnResult +public sealed class MarketplaceListResult { - /// - [JsonIgnore] - public override string Kind => "validation-error"; + /// Registered marketplaces. + [JsonPropertyName("marketplaces")] + public IList Marketplaces { get => field ??= []; set; } +} - /// Which parameter field was invalid. Omitted when the rejection is not field-specific. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("field")] - public AgentRegistrySpawnValidationErrorField? Field { get; set; } +/// Result of registering a new marketplace. +[Experimental(Diagnostics.Experimental)] +public sealed class MarketplaceAddResult +{ + /// Final name of the marketplace as resolved from its manifest. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; +} - /// Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. - [JsonPropertyName("message")] - public required string Message { get; set; } +/// Marketplace source and optional working directory for relative-path resolution. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsMarketplacesAddRequest +{ + /// Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL (user@host:path), or a local path. The marketplace's own name (from its manifest) is used as the registration key. + [JsonPropertyName("source")] + public string Source { get; set; } = string.Empty; - /// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. - [JsonPropertyName("reason")] - public required AgentRegistrySpawnValidationErrorReason Reason { get; set; } + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } } -/// Inputs to spawn a managed-server child via the controller's spawn delegate. +/// Outcome of the remove attempt, including dependent-plugin info when applicable. [Experimental(Diagnostics.Experimental)] -internal sealed class AgentRegistrySpawnRequest +public sealed class MarketplaceRemoveResult { - /// Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. - [JsonPropertyName("agentName")] - public string? AgentName { get; set; } - - /// Working directory for the spawned child (must be an existing directory). - [JsonPropertyName("cwd")] - public string Cwd { get; set; } = string.Empty; + /// Names of installed plugins that prevented removal. Populated only when `removed=false`. + [JsonPropertyName("dependentPlugins")] + public IList? DependentPlugins { get; set; } - /// Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). - [JsonPropertyName("initialPrompt")] - public string? InitialPrompt { get; set; } + /// True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. + [JsonPropertyName("removed")] + public bool Removed { get; set; } +} - /// Model identifier to apply to the new session. - [JsonPropertyName("model")] - public string? Model { get; set; } +/// Name of the marketplace to remove and an optional force flag. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsMarketplacesRemoveRequest +{ + /// When true, also uninstall every plugin sourced from this marketplace. When false (default), removal is a no-op if any plugin from this marketplace is installed and the dependent plugin names are returned in the result. + [JsonPropertyName("force")] + public bool? Force { get; set; } - /// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + /// Marketplace name to remove. [JsonPropertyName("name")] - public string? Name { get; set; } - - /// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. - [JsonPropertyName("permissionMode")] - public AgentRegistrySpawnPermissionMode? PermissionMode { get; set; } + public string Name { get; set; } = string.Empty; } -/// Identifies the target session. +/// Plugin entry advertised by a marketplace. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSuspendRequest +public sealed class MarketplacePluginInfo { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Short description from the marketplace catalog, when present. + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Plugin name as listed in the marketplace catalog. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } -/// Result of sending a user message. +/// Plugins advertised by the marketplace. [Experimental(Diagnostics.Experimental)] -public sealed class SendResult +public sealed class MarketplaceBrowseResult { - /// Unique identifier assigned to the message. - [JsonPropertyName("messageId")] - public string MessageId { get; set; } = string.Empty; + /// Plugins advertised by the marketplace. + [JsonPropertyName("plugins")] + public IList Plugins { get => field ??= []; set; } } -/// A user message attachment — a file, directory, code selection, blob, or GitHub reference. -/// Polymorphic base type discriminated by type. +/// Name of the marketplace whose plugin catalog to fetch. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(SendAttachmentFile), "file")] -[JsonDerivedType(typeof(SendAttachmentDirectory), "directory")] -[JsonDerivedType(typeof(SendAttachmentSelection), "selection")] -[JsonDerivedType(typeof(SendAttachmentGithubReference), "github_reference")] -[JsonDerivedType(typeof(SendAttachmentBlob), "blob")] -public partial class SendAttachment +internal sealed class PluginsMarketplacesBrowseRequest { - /// The type discriminator. - [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; + /// Marketplace name to browse. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; } - -/// Optional line range to scope the attachment to a specific section of the file. +/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. [Experimental(Diagnostics.Experimental)] -public sealed class SendAttachmentFileLineRange +public sealed class MarketplaceRefreshEntry { - /// End line number (1-based, inclusive). - [JsonPropertyName("end")] - public long End { get; set; } + /// Error message (failure only). + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Start line number (1-based). - [JsonPropertyName("start")] - public long Start { get; set; } + /// Marketplace name that was refreshed. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Whether the refresh succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// File attachment. -/// The file variant of . +/// Result of refreshing one or more marketplace catalogs. [Experimental(Diagnostics.Experimental)] -public partial class SendAttachmentFile : SendAttachment +public sealed class MarketplaceRefreshResult { - /// - [JsonIgnore] - public override string Type => "file"; - - /// User-facing display name for the attachment. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } - - /// Optional line range to scope the attachment to a specific section of the file. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("lineRange")] - public SendAttachmentFileLineRange? LineRange { get; set; } + /// Per-marketplace refresh results in deterministic order. + [JsonPropertyName("results")] + public IList Results { get => field ??= []; set; } +} - /// Absolute file path. - [JsonPropertyName("path")] - public required string Path { get; set; } +/// RPC data type for PluginsMarketplacesRefresh operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class PluginsMarketplacesRefreshRequest +{ + /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + [JsonPropertyName("name")] + public string? Name { get; set; } } -/// Directory attachment. -/// The directory variant of . +/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. [Experimental(Diagnostics.Experimental)] -public partial class SendAttachmentDirectory : SendAttachment +public sealed class ServerSkill { - /// - [JsonIgnore] - public override string Type => "directory"; + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. + [JsonPropertyName("argumentHint")] + public string? ArgumentHint { get; set; } - /// User-facing display name for the attachment. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } + /// Canonical slash command name used to invoke the skill, without the leading '/'. + [JsonPropertyName("commandName")] + public string? CommandName { get; set; } - /// Absolute directory path. + /// Description of what the skill does. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Whether the skill is currently enabled (based on global config). + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Unique identifier for the skill. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Absolute path to the skill file. [JsonPropertyName("path")] - public required string Path { get; set; } -} + public string? Path { get; set; } -/// End position of the selection. -[Experimental(Diagnostics.Experimental)] -public sealed class SendAttachmentSelectionDetailsEnd -{ - /// End character offset within the line (0-based). - [JsonPropertyName("character")] - public long Character { get; set; } + /// The project path this skill belongs to (only for project/inherited skills). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } - /// End line number (0-based). - [JsonPropertyName("line")] - public long Line { get; set; } + /// Source location type (e.g., project, personal-copilot, plugin, builtin). + [JsonPropertyName("source")] + public SkillSource Source { get; set; } + + /// Whether the skill can be invoked by the user as a slash command. + [JsonPropertyName("userInvocable")] + public bool UserInvocable { get; set; } } -/// Start position of the selection. +/// Skills discovered across global and project sources. [Experimental(Diagnostics.Experimental)] -public sealed class SendAttachmentSelectionDetailsStart +public sealed class ServerSkillList { - /// Start character offset within the line (0-based). - [JsonPropertyName("character")] - public long Character { get; set; } + /// Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills are excluded so host-local paths are not disclosed to multitenant callers. + [JsonPropertyName("errors")] + public IList? Errors { get; set; } - /// Start line number (0-based). - [JsonPropertyName("line")] - public long Line { get; set; } + /// All discovered skills across all sources. + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// Position range of the selection within the file. +/// Optional project paths and additional skill directories to include in discovery. [Experimental(Diagnostics.Experimental)] -public sealed class SendAttachmentSelectionDetails +internal sealed class SkillsDiscoverRequest { - /// End position of the selection. - [JsonPropertyName("end")] - public SendAttachmentSelectionDetailsEnd End { get => field ??= new(); set; } + /// When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments. + [JsonPropertyName("excludeHostSkills")] + public bool? ExcludeHostSkills { get; set; } - /// Start position of the selection. - [JsonPropertyName("start")] - public SendAttachmentSelectionDetailsStart Start { get => field ??= new(); set; } + /// Optional list of project directory paths to scan for project-scoped skills. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } + + /// Optional list of additional skill directory paths to include. + [JsonPropertyName("skillDirectories")] + public IList? SkillDirectories { get; set; } } -/// Code selection attachment from an editor. -/// The selection variant of . +/// Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. [Experimental(Diagnostics.Experimental)] -public partial class SendAttachmentSelection : SendAttachment +public sealed class SkillDiscoveryPath { - /// - [JsonIgnore] - public override string Type => "selection"; - - /// User-facing display name for the selection. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } + /// Absolute path of the create/discovery target (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Absolute path to the file containing the selection. - [JsonPropertyName("filePath")] - public required string FilePath { get; set; } + /// Whether this is the canonical directory to create a new skill in its tier. At most one entry per tier is preferred; the `personal-agents` and `custom` scopes are never preferred. + [JsonPropertyName("preferredForCreation")] + public bool PreferredForCreation { get; set; } - /// Position range of the selection within the file. - [JsonPropertyName("selection")] - public required SendAttachmentSelectionDetails Selection { get; set; } + /// The input project path this directory was derived from (only for project scope). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } - /// The selected text content. - [JsonPropertyName("text")] - public required string Text { get; set; } + /// Which tier this directory belongs to. + [JsonPropertyName("scope")] + public SkillDiscoveryScope Scope { get; set; } } -/// GitHub issue, pull request, or discussion reference. -/// The github_reference variant of . +/// Canonical locations where skills can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -public partial class SendAttachmentGithubReference : SendAttachment +public sealed class SkillDiscoveryPathList { - /// - [JsonIgnore] - public override string Type => "github_reference"; - - /// Issue, pull request, or discussion number. - [JsonPropertyName("number")] - public required long Number { get; set; } - - /// Type of GitHub reference. - [JsonPropertyName("referenceType")] - public required SendAttachmentGithubReferenceType ReferenceType { get; set; } - - /// Current state of the referenced item (e.g., open, closed, merged). - [JsonPropertyName("state")] - public required string State { get; set; } - - /// Title of the referenced item. - [JsonPropertyName("title")] - public required string Title { get; set; } - - /// URL to the referenced item on GitHub. - [JsonPropertyName("url")] - public required string Url { get; set; } + /// Canonical skill create/discovery directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Blob attachment with inline base64-encoded data. -/// The blob variant of . +/// Optional project paths to enumerate. [Experimental(Diagnostics.Experimental)] -public partial class SendAttachmentBlob : SendAttachment +internal sealed class SkillsGetDiscoveryPathsRequest { - /// - [JsonIgnore] - public override string Type => "blob"; - - /// Base64-encoded content. - [Base64String] - [JsonPropertyName("data")] - public required string Data { get; set; } - - /// User-facing display name for the attachment. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("displayName")] - public string? DisplayName { get; set; } + /// When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments. + [JsonPropertyName("excludeHostSkills")] + public bool? ExcludeHostSkills { get; set; } - /// MIME type of the inline data. - [JsonPropertyName("mimeType")] - public required string MimeType { get; set; } + /// Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// Parameters for sending a user message to the session. +/// Skill names to mark as disabled in global configuration, replacing any previous list. [Experimental(Diagnostics.Experimental)] -internal sealed class SendRequest +internal sealed class SkillsConfigSetDisabledSkillsRequest { - /// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. - [JsonPropertyName("agentMode")] - public SendAgentMode? AgentMode { get; set; } + /// List of skill names to disable. + [JsonPropertyName("disabledSkills")] + public IList DisabledSkills { get => field ??= []; set; } +} - /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message. - [JsonPropertyName("attachments")] - public IList? Attachments { get; set; } +/// Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. +[Experimental(Diagnostics.Experimental)] +public sealed class AgentInfo +{ + /// Description of the agent's purpose. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. - [JsonPropertyName("billable")] - public bool? Billable { get; set; } + /// Human-readable display name. + [JsonPropertyName("displayName")] + public string DisplayName { get; set; } = string.Empty; - /// If provided, this is shown in the timeline instead of `prompt`. - [JsonPropertyName("displayPrompt")] - public string? DisplayPrompt { get; set; } + /// Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. - [JsonPropertyName("mode")] - public SendMode? Mode { get; set; } + /// MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. + [Experimental(Diagnostics.Experimental)] + [JsonPropertyName("mcpServers")] + public IDictionary? McpServers { get; set; } - /// If true, adds the message to the front of the queue instead of the end. - [JsonPropertyName("prepend")] - public bool? Prepend { get; set; } + /// Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference. + [JsonPropertyName("model")] + public string? Model { get; set; } - /// The user message text. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// Name of the agent. Use `id` as the stable selection identifier. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. - [JsonPropertyName("requestHeaders")] - public IDictionary? RequestHeaders { get; set; } + /// Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. + [JsonPropertyName("path")] + public string? Path { get; set; } - /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange. - [JsonPropertyName("requiredTool")] - public string? RequiredTool { get; set; } + /// Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. + [JsonPropertyName("prompt")] + public string? Prompt { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Skill names preloaded into this agent's context. Omitted means none. + [JsonPropertyName("skills")] + public IList? Skills { get; set; } - /// Optional provenance tag copied to the resulting user.message event. Supported values are `system`, `command-*`, and `schedule-*`. - [JsonInclude] + /// Where the agent definition was loaded from. [JsonPropertyName("source")] - internal JsonElement? Source { get; set; } + public AgentInfoSource? Source { get; set; } - /// W3C Trace Context traceparent header for distributed tracing of this agent turn. - [JsonPropertyName("traceparent")] - public string? Traceparent { get; set; } + /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. + [JsonPropertyName("tools")] + public IList? Tools { get; set; } - /// W3C Trace Context tracestate header for distributed tracing. - [JsonPropertyName("tracestate")] - public string? Tracestate { get; set; } + /// Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. + [JsonPropertyName("userInvocable")] + public bool? UserInvocable { get; set; } +} - /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. - [JsonPropertyName("wait")] - public bool? Wait { get; set; } +/// Agents discovered across user, project, plugin, and remote sources. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerAgentList +{ + /// All discovered agents across all sources. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } } -/// Result of aborting the current turn. +/// Optional project paths to include in agent discovery. [Experimental(Diagnostics.Experimental)] -public sealed class AbortResult +internal sealed class AgentsDiscoverRequest { - /// Error message if the abort failed. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// When true, omit the host's agents (the user-level agent directory and all plugin agents), leaving only project and remote agents. For multitenant deployments. + [JsonPropertyName("excludeHostAgents")] + public bool? ExcludeHostAgents { get; set; } - /// Whether the abort completed successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Optional list of project directory paths to scan for project-scoped agents. When omitted or empty, only user/plugin/remote-independent agents are returned (no project scan). + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// Parameters for aborting the current turn. +/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. [Experimental(Diagnostics.Experimental)] -internal sealed class AbortRequest +public sealed class AgentDiscoveryPath { - /// Finite reason code describing why the current turn was aborted. - [JsonPropertyName("reason")] - public AbortReason? Reason { get; set; } + /// Absolute path of the search/create directory (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether this is the canonical directory to create a new agent in its tier. At most one entry per tier is preferred. + [JsonPropertyName("preferredForCreation")] + public bool PreferredForCreation { get; set; } + + /// The input project path this directory was derived from (only for project scope). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } + + /// Which tier this directory belongs to. + [JsonPropertyName("scope")] + public AgentDiscoveryPathScope Scope { get; set; } } -/// Parameters for shutting down the session. +/// Canonical locations where custom agents can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -internal sealed class ShutdownRequest +public sealed class AgentDiscoveryPathList { - /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. - [JsonPropertyName("reason")] - public string? Reason { get; set; } - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; - - /// Why the session is being shut down. Defaults to "routine" when omitted. - [JsonPropertyName("type")] - public ShutdownType? Type { get; set; } + /// Canonical agent create/discovery directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Identifier of the session event that was emitted for the log message. +/// Optional project paths to include when enumerating agent discovery directories. [Experimental(Diagnostics.Experimental)] -public sealed class LogResult +internal sealed class AgentsGetDiscoveryPathsRequest { - /// The unique identifier of the emitted session event. - [JsonPropertyName("eventId")] - public Guid EventId { get; set; } + /// When true, omit the host's user-level agent directory, leaving only project directories. For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + [JsonPropertyName("excludeHostAgents")] + public bool? ExcludeHostAgents { get; set; } + + /// Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. +/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. [Experimental(Diagnostics.Experimental)] -internal sealed class LogRequest +public sealed class InstructionSource { - /// When true, the message is transient and not persisted to the session event log on disk. - [JsonPropertyName("ephemeral")] - public bool? Ephemeral { get; set; } + /// Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files. + [JsonPropertyName("applyTo")] + public IList? ApplyTo { get; set; } - /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". - [JsonPropertyName("level")] - public SessionLogLevel? Level { get; set; } + /// Raw content of the instruction file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Human-readable message. - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + /// When true, this source starts disabled and must be toggled on by the user. + [JsonPropertyName("defaultDisabled")] + public bool? DefaultDisabled { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Short description (body after frontmatter) for use in instruction tables. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. - [JsonPropertyName("tip")] - public string? Tip { get; set; } + /// Unique identifier for this source (used for toggling). + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + /// Human-readable label. + [JsonPropertyName("label")] + public string Label { get; set; } = string.Empty; + + /// Where this source lives — used for UI grouping. + [JsonPropertyName("location")] + public InstructionSourceLocation Location { get; set; } + + /// The project path this source was discovered from. Only set by sessionless discovery for repository, working-directory, and project-scoped plugin sources, where it disambiguates sources across multiple workspace roots. The session-scoped getSources leaves it unset. + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } + + /// File path relative to repo or absolute for home. + [JsonPropertyName("sourcePath")] + public string SourcePath { get; set; } = string.Empty; + + /// Category of instruction source — used for merge logic. [JsonPropertyName("type")] - public string? Type { get; set; } + public InstructionSourceType Type { get; set; } +} - /// Optional URL the user can open in their browser for more details. - [Url] - [StringSyntax(StringSyntaxAttribute.Uri)] - [JsonPropertyName("url")] - public string? Url { get; set; } +/// Instruction sources discovered across user, repository, and plugin sources. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerInstructionSourceList +{ + /// All discovered instruction sources. + [JsonPropertyName("sources")] + public IList Sources { get => field ??= []; set; } } -/// Authentication status and account metadata for the session. +/// Optional project paths to include in instruction discovery. [Experimental(Diagnostics.Experimental)] -public sealed class SessionAuthStatus +internal sealed class InstructionsDiscoverRequest { - /// Authentication type. - [JsonPropertyName("authType")] - public AuthInfoType? AuthType { get; set; } + /// When true, omit the host's instruction sources (user/home-level files and plugin rules), leaving only repository and working-directory sources. For multitenant deployments. + [JsonPropertyName("excludeHostInstructions")] + public bool? ExcludeHostInstructions { get; set; } - /// Copilot plan tier (e.g., individual_pro, business). - [JsonPropertyName("copilotPlan")] - public string? CopilotPlan { get; set; } + /// Optional list of project directory paths to scan for repository/working-directory instruction sources. When omitted or empty, only user-level and plugin instruction sources are returned (no project scan). + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } +} - /// Authentication host URL. - [Url] - [StringSyntax(StringSyntaxAttribute.Uri)] - [JsonPropertyName("host")] - public string? Host { get; set; } +/// Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. +[Experimental(Diagnostics.Experimental)] +public sealed class InstructionDiscoveryPath +{ + /// Whether the target is a single file or a directory of instruction files. + [JsonPropertyName("kind")] + public InstructionDiscoveryPathKind Kind { get; set; } - /// Whether the session has resolved authentication. - [JsonPropertyName("isAuthenticated")] - public bool IsAuthenticated { get; set; } + /// Which tier this target belongs to. + [JsonPropertyName("location")] + public InstructionDiscoveryPathLocation Location { get; set; } - /// Authenticated login/username, if available. - [JsonPropertyName("login")] - public string? Login { get; set; } + /// Absolute path of the file or directory (may not exist on disk yet). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Human-readable authentication status description. - [JsonPropertyName("statusMessage")] - public string? StatusMessage { get; set; } + /// Whether this is the canonical target to create new instructions in its tier. At most one entry per tier is preferred. + [JsonPropertyName("preferredForCreation")] + public bool PreferredForCreation { get; set; } + + /// The input project path this target was derived from (only for repository targets). + [JsonPropertyName("projectPath")] + public string? ProjectPath { get; set; } } -/// Identifies the target session. +/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAuthGetStatusRequest +public sealed class InstructionDiscoveryPathList { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Canonical instruction create/discovery files and directories, in priority order. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } } -/// Indicates whether the credential update succeeded. +/// Optional project paths to include when enumerating instruction discovery targets. [Experimental(Diagnostics.Experimental)] -public sealed class SessionSetCredentialsResult +internal sealed class InstructionsGetDiscoveryPathsRequest { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + [JsonPropertyName("excludeHostInstructions")] + public bool? ExcludeHostInstructions { get; set; } + + /// Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. + [JsonPropertyName("projectPaths")] + public IList? ProjectPaths { get; set; } } -/// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. -/// Polymorphic base type discriminated by type. +/// A literal choice the command input accepts, with a human-facing description. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(AuthInfoHmac), "hmac")] -[JsonDerivedType(typeof(AuthInfoEnv), "env")] -[JsonDerivedType(typeof(AuthInfoToken), "token")] -[JsonDerivedType(typeof(AuthInfoCopilotApiToken), "copilot-api-token")] -[JsonDerivedType(typeof(AuthInfoUser), "user")] -[JsonDerivedType(typeof(AuthInfoGhCli), "gh-cli")] -[JsonDerivedType(typeof(AuthInfoApiKey), "api-key")] -public partial class AuthInfo +public sealed class SlashCommandInputChoice { - /// The type discriminator. - [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; -} + /// Human-readable description shown alongside the choice. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + /// The literal choice value (e.g. 'on', 'off', 'show'). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; +} -/// Schema for the `CopilotUserResponseEndpoints` type. +/// Optional unstructured input hint. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponseEndpoints +public sealed class SlashCommandInput { - /// Gets or sets the api value. - [JsonPropertyName("api")] - public string? Api { get; set; } - - /// Gets or sets the origin-tracker value. - [JsonPropertyName("origin-tracker")] - public string? OriginTracker { get; set; } + /// Optional literal choices the input accepts, each with a human-facing description; clients may render these as selectable options. + [JsonPropertyName("choices")] + public IList? Choices { get; set; } - /// Gets or sets the proxy value. - [JsonPropertyName("proxy")] - public string? Proxy { get; set; } + /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). + [JsonPropertyName("completion")] + public SlashCommandInputCompletion? Completion { get; set; } - /// Gets or sets the telemetry value. - [JsonPropertyName("telemetry")] - public string? Telemetry { get; set; } -} + /// Hint to display when command input has not been provided. + [JsonPropertyName("hint")] + public string Hint { get; set; } = string.Empty; -/// RPC data type for CopilotUserResponseOrganizationListItem operations. -public sealed class CopilotUserResponseOrganizationListItem -{ - /// Gets or sets the login value. - [JsonPropertyName("login")] - public string? Login { get; set; } + /// When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace. + [JsonPropertyName("preserveMultilineInput")] + public bool? PreserveMultilineInput { get; set; } - /// Gets or sets the name value. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// When true, the command requires non-empty input; clients should render the input hint as required. + [JsonPropertyName("required")] + public bool? Required { get; set; } } -/// Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. +/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponseQuotaSnapshotsChat +public sealed class SlashCommandInfo { - /// Gets or sets the entitlement value. - [JsonPropertyName("entitlement")] - public double? Entitlement { get; set; } - - /// Gets or sets the has_quota value. - [JsonPropertyName("has_quota")] - public bool? HasQuota { get; set; } - - /// Gets or sets the overage_count value. - [JsonPropertyName("overage_count")] - public double? OverageCount { get; set; } + /// Canonical aliases without leading slashes. + [JsonPropertyName("aliases")] + public IList? Aliases { get; set; } - /// Gets or sets the overage_permitted value. - [JsonPropertyName("overage_permitted")] - public bool? OveragePermitted { get; set; } + /// Whether the command may run while an agent turn is active. + [JsonPropertyName("allowDuringAgentExecution")] + public bool AllowDuringAgentExecution { get; set; } - /// Gets or sets the percent_remaining value. - [JsonPropertyName("percent_remaining")] - public double? PercentRemaining { get; set; } + /// Human-readable command description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Gets or sets the quota_id value. - [JsonPropertyName("quota_id")] - public string? QuotaId { get; set; } + /// Whether the command is experimental. + [JsonPropertyName("experimental")] + public bool? Experimental { get; set; } - /// Gets or sets the quota_remaining value. - [JsonPropertyName("quota_remaining")] - public double? QuotaRemaining { get; set; } + /// Optional unstructured input hint. + [JsonPropertyName("input")] + public SlashCommandInput? Input { get; set; } - /// Gets or sets the quota_reset_at value. - [JsonPropertyName("quota_reset_at")] - public double? QuotaResetAt { get; set; } + /// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. + [JsonPropertyName("kind")] + public SlashCommandKind Kind { get; set; } - /// Gets or sets the remaining value. - [JsonPropertyName("remaining")] - public double? Remaining { get; set; } + /// Canonical command name without a leading slash. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Gets or sets the timestamp_utc value. - [JsonPropertyName("timestamp_utc")] - public string? TimestampUtc { get; set; } + /// Whether the command may be the target of `/every` / `/after` schedules. Resolution happens at every tick, so only set this when the command is safe to re-invoke and produces an agent prompt. + [JsonPropertyName("schedulable")] + public bool? Schedulable { get; set; } +} - /// Gets or sets the token_based_billing value. - [JsonPropertyName("token_based_billing")] - public bool? TokenBasedBilling { get; set; } - - /// Gets or sets the unlimited value. - [JsonPropertyName("unlimited")] - public bool? Unlimited { get; set; } +/// Slash commands available in the session, after applying any include/exclude filters. +[Experimental(Diagnostics.Experimental)] +public sealed class CommandList +{ + /// Commands available in this session. + [JsonPropertyName("commands")] + public IList Commands { get => field ??= []; set; } } -/// Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. +/// A single user setting's effective value alongside its default, so consumers can render settings left at their default. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponseQuotaSnapshotsCompletions +public sealed class UserSettingMetadata { - /// Gets or sets the entitlement value. - [JsonPropertyName("entitlement")] - public double? Entitlement { get; set; } - - /// Gets or sets the has_quota value. - [JsonPropertyName("has_quota")] - public bool? HasQuota { get; set; } - - /// Gets or sets the overage_count value. - [JsonPropertyName("overage_count")] - public double? OverageCount { get; set; } + /// The centrally-known default for this setting (null when no default is registered). + [JsonPropertyName("default")] + public JsonElement Default { get; set; } - /// Gets or sets the overage_permitted value. - [JsonPropertyName("overage_permitted")] - public bool? OveragePermitted { get; set; } + /// True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false. + [JsonPropertyName("isDefault")] + public bool IsDefault { get; set; } - /// Gets or sets the percent_remaining value. - [JsonPropertyName("percent_remaining")] - public double? PercentRemaining { get; set; } + /// The effective value: the user's value if set, otherwise the default. + [JsonPropertyName("value")] + public JsonElement Value { get; set; } +} - /// Gets or sets the quota_id value. - [JsonPropertyName("quota_id")] - public string? QuotaId { get; set; } +/// Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. +[Experimental(Diagnostics.Experimental)] +public sealed class UserSettingsGetResult +{ + /// Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default. + [JsonPropertyName("settings")] + public IDictionary Settings { get => field ??= new Dictionary(); set; } +} - /// Gets or sets the quota_remaining value. - [JsonPropertyName("quota_remaining")] - public double? QuotaRemaining { get; set; } +/// Outcome of writing user settings. +[Experimental(Diagnostics.Experimental)] +public sealed class UserSettingsSetResult +{ + /// Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed. + [JsonPropertyName("shadowedKeys")] + public IList ShadowedKeys { get => field ??= []; set; } +} - /// Gets or sets the quota_reset_at value. - [JsonPropertyName("quota_reset_at")] - public double? QuotaResetAt { get; set; } +/// Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. +[Experimental(Diagnostics.Experimental)] +internal sealed class UserSettingsSetRequest +{ + /// Partial user settings to write, as a free-form object keyed by setting name. + [JsonPropertyName("settings")] + public JsonElement Settings { get; set; } +} - /// Gets or sets the remaining value. - [JsonPropertyName("remaining")] - public double? Remaining { get; set; } +/// Validated device-managed settings discovered before a session exists. +[Experimental(Diagnostics.Experimental)] +public sealed class ManagedSettingsReadResult +{ + /// Discovery or validation error text when managed settings could not be read safely. + [JsonPropertyName("errorMessage")] + public string? ErrorMessage { get; set; } - /// Gets or sets the timestamp_utc value. - [JsonPropertyName("timestamp_utc")] - public string? TimestampUtc { get; set; } + /// Validated, canonical managed-settings JSON. Omitted when no managed settings were discovered or when discovered settings failed validation. + [JsonPropertyName("settingsJson")] + public JsonElement? SettingsJson { get; set; } +} - /// Gets or sets the token_based_billing value. - [JsonPropertyName("token_based_billing")] - public bool? TokenBasedBilling { get; set; } +/// Indicates whether the calling client was registered as the session filesystem provider. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSetProviderResult +{ + /// Whether the provider was set successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } +} - /// Gets or sets the unlimited value. - [JsonPropertyName("unlimited")] - public bool? Unlimited { get; set; } +/// Optional capabilities declared by the provider. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSetProviderCapabilities +{ + /// Whether the provider supports SQLite query/exists operations. + [JsonPropertyName("sqlite")] + public bool? Sqlite { get; set; } } -/// Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. +/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponseQuotaSnapshotsPremiumInteractions +internal sealed class SessionFsSetProviderRequest { - /// Gets or sets the entitlement value. - [JsonPropertyName("entitlement")] - public double? Entitlement { get; set; } + /// Optional capabilities declared by the provider. + [JsonPropertyName("capabilities")] + public SessionFsSetProviderCapabilities? Capabilities { get; set; } - /// Gets or sets the has_quota value. - [JsonPropertyName("has_quota")] - public bool? HasQuota { get; set; } + /// Path conventions used by this filesystem. + [JsonPropertyName("conventions")] + public SessionFsSetProviderConventions Conventions { get; set; } - /// Gets or sets the overage_count value. - [JsonPropertyName("overage_count")] - public double? OverageCount { get; set; } + /// Initial working directory for sessions. + [JsonPropertyName("initialCwd")] + public string InitialCwd { get; set; } = string.Empty; - /// Gets or sets the overage_permitted value. - [JsonPropertyName("overage_permitted")] - public bool? OveragePermitted { get; set; } + /// Path within each session's SessionFs where the runtime stores files for that session. + [JsonPropertyName("sessionStatePath")] + public string SessionStatePath { get; set; } = string.Empty; +} - /// Gets or sets the percent_remaining value. - [JsonPropertyName("percent_remaining")] - public double? PercentRemaining { get; set; } +/// Indicates whether the calling client was registered as the LLM inference provider. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceSetProviderResult +{ + /// Whether the provider was set successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } +} - /// Gets or sets the quota_id value. - [JsonPropertyName("quota_id")] - public string? QuotaId { get; set; } +/// Whether the start frame was accepted. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpResponseStartResult +{ + /// True when the response start was matched to a pending request; false when unknown. + [JsonPropertyName("accepted")] + public bool Accepted { get; set; } +} - /// Gets or sets the quota_remaining value. - [JsonPropertyName("quota_remaining")] - public double? QuotaRemaining { get; set; } +/// Response head. +[Experimental(Diagnostics.Experimental)] +internal sealed class LlmInferenceHttpResponseStartRequest +{ + /// Gets or sets the headers value. + [JsonPropertyName("headers")] + public IDictionary> Headers { get => field ??= new Dictionary>(); set; } - /// Gets or sets the quota_reset_at value. - [JsonPropertyName("quota_reset_at")] - public double? QuotaResetAt { get; set; } + /// Matches the requestId from the originating httpRequestStart frame. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; - /// Gets or sets the remaining value. - [JsonPropertyName("remaining")] - public double? Remaining { get; set; } + /// HTTP status code. + [JsonPropertyName("status")] + public long Status { get; set; } - /// Gets or sets the timestamp_utc value. - [JsonPropertyName("timestamp_utc")] - public string? TimestampUtc { get; set; } + /// Optional HTTP status reason phrase. + [JsonPropertyName("statusText")] + public string? StatusText { get; set; } +} - /// Gets or sets the token_based_billing value. - [JsonPropertyName("token_based_billing")] - public bool? TokenBasedBilling { get; set; } +/// Whether the chunk was accepted. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpResponseChunkResult +{ + /// True when the chunk was matched to a pending request; false when unknown. + [JsonPropertyName("accepted")] + public bool Accepted { get; set; } +} - /// Gets or sets the unlimited value. - [JsonPropertyName("unlimited")] - public bool? Unlimited { get; set; } +/// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpResponseChunkError +{ + /// Optional machine-readable error code. + [JsonPropertyName("code")] + public string? Code { get; set; } + + /// Human-readable failure description. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; } -/// Schema for the `CopilotUserResponseQuotaSnapshots` type. +/// A response body chunk or terminal error. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponseQuotaSnapshots +internal sealed class LlmInferenceHttpResponseChunkRequest { - /// Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. - [JsonPropertyName("chat")] - public CopilotUserResponseQuotaSnapshotsChat? Chat { get; set; } + /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + [JsonPropertyName("binary")] + public bool? Binary { get; set; } - /// Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. - [JsonPropertyName("completions")] - public CopilotUserResponseQuotaSnapshotsCompletions? Completions { get; set; } + /// Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk with empty data and end=true). + [JsonPropertyName("data")] + public string Data { get; set; } = string.Empty; - /// Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. - [JsonPropertyName("premium_interactions")] - public CopilotUserResponseQuotaSnapshotsPremiumInteractions? PremiumInteractions { get; set; } + /// When true, this is the final body chunk for the response. The runtime treats the response body as complete after receiving an end-marked chunk. + [JsonPropertyName("end")] + public bool? End { get; set; } + + /// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + [JsonPropertyName("error")] + public LlmInferenceHttpResponseChunkError? Error { get; set; } + + /// Matches the requestId from the originating httpRequestStart frame. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; } -/// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. +/// Pre-resolved working-directory context for session startup. [Experimental(Diagnostics.Experimental)] -public sealed class CopilotUserResponse +public sealed class SessionContext { - /// Gets or sets the access_type_sku value. - [JsonPropertyName("access_type_sku")] - public string? AccessTypeSku { get; set; } - - /// Gets or sets the analytics_tracking_id value. - [JsonPropertyName("analytics_tracking_id")] - public string? AnalyticsTrackingId { get; set; } + /// Active git branch. + [JsonPropertyName("branch")] + public string? Branch { get; set; } - /// Gets or sets the assigned_date value. - [JsonPropertyName("assigned_date")] - public string? AssignedDate { get; set; } + /// Most recent working directory for this session. + [JsonPropertyName("cwd")] + public string Cwd { get; set; } = string.Empty; - /// Gets or sets the can_signup_for_limited value. - [JsonPropertyName("can_signup_for_limited")] - public bool? CanSignupForLimited { get; set; } + /// Git repository root, if the cwd was inside a git repo. + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } - /// Gets or sets the chat_enabled value. - [JsonPropertyName("chat_enabled")] - public bool? ChatEnabled { get; set; } + /// Repository host type. + [JsonPropertyName("hostType")] + public SessionContextHostType? HostType { get; set; } - /// Gets or sets the cli_remote_control_enabled value. - [JsonPropertyName("cli_remote_control_enabled")] - public bool? CliRemoteControlEnabled { get; set; } + /// Repository slug in `owner/name` form, when known. + [JsonPropertyName("repository")] + public string? Repository { get; set; } +} - /// Gets or sets the cloud_session_storage_enabled value. - [JsonPropertyName("cloud_session_storage_enabled")] - public bool? CloudSessionStorageEnabled { get; set; } +/// GitHub repository the remote session belongs to. +[Experimental(Diagnostics.Experimental)] +public sealed class RemoteSessionMetadataRepository +{ + /// Branch associated with the remote session. + [JsonPropertyName("branch")] + public string Branch { get; set; } = string.Empty; - /// Gets or sets the codex_agent_enabled value. - [JsonPropertyName("codex_agent_enabled")] - public bool? CodexAgentEnabled { get; set; } + /// Repository name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Gets or sets the copilot_plan value. - [JsonPropertyName("copilot_plan")] - public string? CopilotPlan { get; set; } + /// Repository owner. + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; +} - /// Gets or sets the copilotignore_enabled value. - [JsonPropertyName("copilotignore_enabled")] - public bool? CopilotignoreEnabled { get; set; } +/// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). +[Experimental(Diagnostics.Experimental)] +public sealed class RemoteSessionMetadataValue +{ + /// Most recent working directory context. + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } - /// Schema for the `CopilotUserResponseEndpoints` type. - [JsonPropertyName("endpoints")] - public CopilotUserResponseEndpoints? Endpoints { get; set; } + /// Always true for remote sessions. + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } - /// Gets or sets the is_mcp_enabled value. - [JsonPropertyName("is_mcp_enabled")] - public bool? IsMcpEnabled { get; set; } + /// Last-modified time as an ISO 8601 timestamp. + [JsonPropertyName("modifiedTime")] + public string ModifiedTime { get; set; } = string.Empty; - /// Gets or sets the limited_user_quotas value. - [JsonPropertyName("limited_user_quotas")] - public IDictionary? LimitedUserQuotas { get; set; } + /// Optional human-friendly name set via /rename. + [JsonPropertyName("name")] + public string? Name { get; set; } - /// Gets or sets the limited_user_reset_date value. - [JsonPropertyName("limited_user_reset_date")] - public string? LimitedUserResetDate { get; set; } + /// Pull request number associated with the session. + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } - /// Gets or sets the login value. - [JsonPropertyName("login")] - public string? Login { get; set; } + /// Backing remote session IDs (most recent first). + [JsonPropertyName("remoteSessionIds")] + public IList RemoteSessionIds { get => field ??= []; set; } - /// Gets or sets the monthly_quotas value. - [JsonPropertyName("monthly_quotas")] - public IDictionary? MonthlyQuotas { get; set; } + /// GitHub repository the remote session belongs to. + [JsonPropertyName("repository")] + public RemoteSessionMetadataRepository Repository { get => field ??= new(); set; } - /// Gets or sets the organization_list value. - [JsonPropertyName("organization_list")] - public IList? OrganizationList { get; set; } + /// Original remote resource identifier (task ID or PR node ID). + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } - /// Gets or sets the organization_login_list value. - [JsonPropertyName("organization_login_list")] - public IList? OrganizationLoginList { get; set; } + /// Stable session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Gets or sets the quota_reset_date value. - [JsonPropertyName("quota_reset_date")] - public string? QuotaResetDate { get; set; } + /// Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. + [JsonPropertyName("staleAt")] + public string? StaleAt { get; set; } - /// Gets or sets the quota_reset_date_utc value. - [JsonPropertyName("quota_reset_date_utc")] - public string? QuotaResetDateUtc { get; set; } + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public string StartTime { get; set; } = string.Empty; - /// Schema for the `CopilotUserResponseQuotaSnapshots` type. - [JsonPropertyName("quota_snapshots")] - public CopilotUserResponseQuotaSnapshots? QuotaSnapshots { get; set; } + /// Server-side task state returned by GitHub. + [JsonPropertyName("state")] + public string? State { get; set; } - /// Gets or sets the restricted_telemetry value. - [JsonPropertyName("restricted_telemetry")] - public bool? RestrictedTelemetry { get; set; } + /// Short summary of the session, when one has been derived. + [JsonPropertyName("summary")] + public string? Summary { get; set; } - /// Gets or sets the token_based_billing value. - [JsonPropertyName("token_based_billing")] - public bool? TokenBasedBilling { get; set; } + /// Whether the remote task originated from CCA or CLI `--remote`. + [JsonPropertyName("taskType")] + public RemoteSessionMetadataTaskType? TaskType { get; set; } } -/// Schema for the `HMACAuthInfo` type. -/// The hmac variant of . +/// `sessions.open` handoff progress update with step, status, and optional message. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoHmac : AuthInfo +public sealed class SessionsOpenProgress { - /// - [JsonIgnore] - public override string Type => "hmac"; - - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Optional step message. + [JsonPropertyName("message")] + public string? Message { get; set; } - /// HMAC secret used to sign requests. - [JsonPropertyName("hmac")] - public required string Hmac { get; set; } + /// Step status. + [JsonPropertyName("status")] + public SessionsOpenProgressStatus Status { get; set; } - /// Authentication host. HMAC auth always targets the public GitHub host. - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Handoff step. + [JsonPropertyName("step")] + public SessionsOpenProgressStep Step { get; set; } } -/// Schema for the `EnvAuthInfo` type. -/// The env variant of . +/// Result of opening a session. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoEnv : AuthInfo +public sealed class SessionOpenResult { - /// - [JsonIgnore] - public override string Type => "env"; + /// Remote session metadata, present when status is `connected`. + [JsonPropertyName("metadata")] + public RemoteSessionMetadataValue? Metadata { get; set; } - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Handoff progress steps, present when status is `handed_off`. + [JsonPropertyName("progress")] + public IList? Progress { get; set; } - /// Name of the environment variable the token was sourced from. - [JsonPropertyName("envVar")] - public required string EnvVar { get; set; } + /// Remote session ID, present when status is `connected`. + [JsonPropertyName("remoteSessionId")] + public string? RemoteSessionId { get; set; } - /// Authentication host (e.g. https://github.com or a GHES host). - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Opened session ID. Omitted when status is `not_found`. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } - /// User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("login")] - public string? Login { get; set; } + /// Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. + [JsonPropertyName("startupPrompts")] + public IList? StartupPrompts { get; set; } - /// The token value itself. Treat as a secret. - [JsonPropertyName("token")] - public required string Token { get; set; } + /// Outcome of the open request. + [JsonPropertyName("status")] + public SessionsOpenStatus Status { get; set; } } -/// Schema for the `TokenAuthInfo` type. -/// The token variant of . +/// Identifier and optional friendly name assigned to the newly forked session. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoToken : AuthInfo +public sealed class SessionsForkResult { - /// - [JsonIgnore] - public override string Type => "token"; - - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } - - /// Authentication host. - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Friendly name assigned to the forked session, if any. + [JsonPropertyName("name")] + public string? Name { get; set; } - /// The token value itself. Treat as a secret. - [JsonPropertyName("token")] - public required string Token { get; set; } + /// The new forked session's ID. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `CopilotApiTokenAuthInfo` type. -/// The copilot-api-token variant of . +/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoCopilotApiToken : AuthInfo +internal sealed class SessionsForkRequest { - /// - [JsonIgnore] - public override string Type => "copilot-api-token"; + /// Optional friendly name to assign to the forked session. + [JsonPropertyName("name")] + public string? Name { get; set; } - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Source session ID to fork from. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Authentication host (always the public GitHub host). - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included. + [JsonPropertyName("toEventId")] + public string? ToEventId { get; set; } } -/// Schema for the `UserAuthInfo` type. -/// The user variant of . +/// Repository associated with the connected remote session. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoUser : AuthInfo +public sealed class ConnectedRemoteSessionMetadataRepository { - /// - [JsonIgnore] - public override string Type => "user"; - - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Branch associated with the remote session. + [JsonPropertyName("branch")] + public string Branch { get; set; } = string.Empty; - /// Authentication host. - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Repository name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// OAuth user login. - [JsonPropertyName("login")] - public required string Login { get; set; } + /// Repository owner or organization login. + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; } -/// Schema for the `GhCliAuthInfo` type. -/// The gh-cli variant of . +/// Metadata for a connected remote session. [Experimental(Diagnostics.Experimental)] -public partial class AuthInfoGhCli : AuthInfo +public sealed class ConnectedRemoteSessionMetadata { - /// - [JsonIgnore] - public override string Type => "gh-cli"; + /// Neutral SDK discriminator for the connected remote session kind. + [JsonPropertyName("kind")] + public ConnectedRemoteSessionMetadataKind Kind { get; set; } - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Last session update time as an ISO 8601 string. + [JsonPropertyName("modifiedTime")] + public DateTimeOffset ModifiedTime { get; set; } - /// Authentication host. - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Optional friendly session name. + [JsonPropertyName("name")] + public string? Name { get; set; } - /// User login as reported by `gh auth status`. - [JsonPropertyName("login")] - public required string Login { get; set; } + /// Pull request number associated with the session. + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } - /// The token returned by `gh auth token`. Treat as a secret. - [JsonPropertyName("token")] - public required string Token { get; set; } -} + /// Repository associated with the connected remote session. + [JsonPropertyName("repository")] + public ConnectedRemoteSessionMetadataRepository Repository { get => field ??= new(); set; } -/// Schema for the `ApiKeyAuthInfo` type. -/// The api-key variant of . -[Experimental(Diagnostics.Experimental)] -public partial class AuthInfoApiKey : AuthInfo -{ - /// - [JsonIgnore] - public override string Type => "api-key"; + /// Original remote resource identifier. + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } - /// The API key. Treat as a secret. - [JsonPropertyName("apiKey")] - public required string ApiKey { get; set; } + /// SDK session ID for the connected remote session. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("copilotUser")] - public CopilotUserResponse? CopilotUser { get; set; } + /// Remote session staleness deadline as an ISO 8601 string. + [JsonPropertyName("staleAt")] + public DateTimeOffset? StaleAt { get; set; } - /// Authentication host. - [JsonPropertyName("host")] - public required string Host { get; set; } + /// Session start time as an ISO 8601 string. + [JsonPropertyName("startTime")] + public DateTimeOffset StartTime { get; set; } + + /// Remote session state returned by the backing service. + [JsonPropertyName("state")] + public string? State { get; set; } + + /// Optional session summary. + [JsonPropertyName("summary")] + public string? Summary { get; set; } } -/// New auth credentials to install on the session. Omit to leave credentials unchanged. +/// Remote session connection result. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSetCredentialsParams +public sealed class RemoteSessionConnectionResult { - /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. - [JsonPropertyName("credentials")] - public AuthInfo? Credentials { get; set; } + /// Metadata for a connected remote session. + [JsonPropertyName("metadata")] + public ConnectedRemoteSessionMetadata Metadata { get => field ??= new(); set; } - /// Target session identifier. + /// SDK session ID for the connected remote session. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. +/// Remote session connection parameters. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasAction +internal sealed class ConnectRemoteSessionParams { - /// Description of the action. - [JsonPropertyName("description")] - public string? Description { get; set; } - - /// JSON Schema for the action input. - [JsonPropertyName("inputSchema")] - public JsonElement? InputSchema { get; set; } - - /// Action name exposed by the canvas provider. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Session ID to connect to. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Canvas available in the current session. +/// Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields. +/// Data type discriminated by isRemote. [Experimental(Diagnostics.Experimental)] -public sealed class DiscoveredCanvas +public partial class SessionListEntry { - /// Actions the agent or host may invoke on an open instance. - [JsonPropertyName("actions")] - public IList? Actions { get; set; } - - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + /// The boolean discriminator. + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } - /// Short, single-sentence description shown to the agent in canvas catalogs. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Runtime client name that created/last resumed this session. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } - /// Human-readable canvas name. - [JsonPropertyName("displayName")] - public string DisplayName { get; set; } = string.Empty; + /// Pre-resolved working-directory context for session startup. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// True for detached maintenance sessions that should be hidden from normal resume lists. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isDetached")] + public bool? IsDetached { get; set; } - /// Owning extension display name, when available. - [JsonPropertyName("extensionName")] - public string? ExtensionName { get; set; } - - /// JSON Schema for canvas open input. - [JsonPropertyName("inputSchema")] - public JsonElement? InputSchema { get; set; } -} + /// GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mcTaskId")] + public string? McTaskId { get; set; } -/// Declared canvases available in this session. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasList -{ - /// Declared canvases available in this session. - [JsonPropertyName("canvases")] - public IList Canvases { get => field ??= []; set; } -} + /// Last-modified time of the session's persisted state, as ISO 8601. + [JsonPropertyName("modifiedTime")] + public required string ModifiedTime { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionCanvasListRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Optional human-friendly name set via /rename. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("name")] + public string? Name { get; set; } -/// Open canvas instance snapshot. -[Experimental(Diagnostics.Experimental)] -public sealed class OpenCanvasInstance -{ - /// Runtime-controlled routing state for an open canvas instance. - [JsonPropertyName("availability")] - public CanvasInstanceAvailability Availability { get; set; } + /// Pull request number associated with the session. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + /// Backing remote session IDs (most recent first). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("remoteSessionIds")] + public IList? RemoteSessionIds { get; set; } - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// GitHub repository the remote session belongs to. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("repository")] + public RemoteSessionMetadataRepository? Repository { get; set; } - /// Owning extension display name, when available. - [JsonPropertyName("extensionName")] - public string? ExtensionName { get; set; } + /// Original remote resource identifier (task ID or PR node ID). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } - /// Input supplied when the instance was opened. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// Stable session identifier. + [JsonPropertyName("sessionId")] + public required string SessionId { get; set; } - /// Stable caller-supplied canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("staleAt")] + public string? StaleAt { get; set; } - /// Whether this snapshot came from an idempotent reopen. - [JsonPropertyName("reopen")] - public bool Reopen { get; set; } + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public required string StartTime { get; set; } - /// Provider-supplied status text. - [JsonPropertyName("status")] - public string? Status { get; set; } + /// Server-side task state returned by GitHub. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("state")] + public string? State { get; set; } - /// Rendered title. - [JsonPropertyName("title")] - public string? Title { get; set; } + /// Short summary of the session, when one has been derived. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("summary")] + public string? Summary { get; set; } - /// URL for web-rendered canvases. - [JsonPropertyName("url")] - public string? Url { get; set; } + /// Whether the remote task originated from CCA or CLI `--remote`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("taskType")] + public RemoteSessionMetadataTaskType? TaskType { get; set; } } -/// Live open-canvas snapshot. +/// Sessions matching the filter, ordered most-recently-modified first. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasListOpenResult +public sealed class SessionList { - /// Currently open canvas instances. - [JsonPropertyName("openCanvases")] - public IList OpenCanvases { get => field ??= []; set; } + /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } } -/// Identifies the target session. +/// Optional filter applied to the returned sessions. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionCanvasListOpenRequest +public sealed class SessionListFilter { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Match sessions whose context.branch equals this value. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// Match sessions whose context.cwd equals this value. + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } + + /// Match sessions whose context.gitRoot equals this value. + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } + + /// Match sessions whose context.repository equals this value. + [JsonPropertyName("repository")] + public string? Repository { get; set; } } -/// Canvas open parameters. +/// Optional source filter, metadata-load limit, and context filter applied to the returned sessions. [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasOpenRequest +internal sealed class SessionsListRequest { - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + /// Optional filter applied to the returned sessions. + [JsonPropertyName("filter")] + public SessionListFilter? Filter { get; set; } - /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. - [JsonPropertyName("extensionId")] - public string? ExtensionId { get; set; } + /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. + [JsonPropertyName("includeDetached")] + public bool? IncludeDetached { get; set; } - /// Canvas open input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// When provided, only the first N local sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every local session. Has no effect on remote entries (which always carry their full shape). + [JsonPropertyName("metadataLimit")] + public long? MetadataLimit { get; set; } - /// Caller-supplied stable instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Which session sources to include. Defaults to `local` for backward compatibility. + [JsonPropertyName("source")] + public SessionSource? Source { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Only meaningful when `source` includes remote. When true, propagates errors from the remote service instead of silently returning an empty remote list. Defaults to false. + [JsonPropertyName("throwOnError")] + public bool? ThrowOnError { get; set; } } -/// Canvas close parameters. +/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasCloseRequest +public sealed class LocalSessionMetadataValue { - /// Open canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Runtime client name that created/last resumed this session. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } - /// Target session identifier. + /// Pre-resolved working-directory context for session startup. + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } + + /// True for detached maintenance sessions that should be hidden from normal resume lists. + [JsonPropertyName("isDetached")] + public bool? IsDetached { get; set; } + + /// Always false for local sessions. + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } + + /// GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + [JsonPropertyName("mcTaskId")] + public string? McTaskId { get; set; } + + /// Last-modified time of the session's persisted state, as ISO 8601. + [JsonPropertyName("modifiedTime")] + public string ModifiedTime { get; set; } = string.Empty; + + /// Optional human-friendly name set via /rename. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Stable session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Session creation time as an ISO 8601 timestamp. + [JsonPropertyName("startTime")] + public string StartTime { get; set; } = string.Empty; + + /// Short summary of the session, when one has been derived. + [JsonPropertyName("summary")] + public string? Summary { get; set; } } -/// Canvas action invocation result. +/// Persisted local session metadata when the session exists. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasActionInvokeResult +internal sealed class SessionsGetMetadataResult { - /// Provider-supplied action result. - [JsonPropertyName("result")] - public JsonElement? Result { get; set; } + /// Local session metadata, omitted when the session does not exist. + [JsonPropertyName("session")] + public LocalSessionMetadataValue? Session { get; set; } } -/// Canvas action invocation parameters. +/// Session ID whose persisted metadata should be read. [Experimental(Diagnostics.Experimental)] -internal sealed class CanvasActionInvokeRequest +internal sealed class SessionsGetMetadataRequest { - /// Action name to invoke. - [JsonPropertyName("actionName")] - public string ActionName { get; set; } = string.Empty; - - /// Action input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } - - /// Open canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; - - /// Target session identifier. + /// Session ID to inspect. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// The currently selected model, reasoning effort, and context tier for the session. +/// Recent local session IDs that contain user-visible history. [Experimental(Diagnostics.Experimental)] -public sealed class CurrentModel +internal sealed class SessionsListNonEmptySessionIdsResult { - /// Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. - [JsonPropertyName("contextTier")] - public ModelCurrentContextTier? ContextTier { get; set; } - - /// Currently active model identifier. - [JsonPropertyName("modelId")] - public string? ModelId { get; set; } + /// Session IDs ordered newest-first. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } +} - /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. - [JsonPropertyName("reasoningEffort")] - public string? ReasoningEffort { get; set; } +/// Limit for non-empty local session IDs. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsListNonEmptySessionIdsRequest +{ + /// Maximum number of session IDs to return. + [JsonPropertyName("limit")] + public long? Limit { get; set; } } -/// Identifies the target session. +/// ID of the local session bound to the given GitHub task, or omitted when none. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionModelGetCurrentRequest +public sealed class SessionsFindByTaskIDResult { - /// Target session identifier. + /// Omitted when no local session is bound to that GitHub task. [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + public string? SessionId { get; set; } } -/// The model identifier active on the session after the switch. +/// GitHub task ID to look up. [Experimental(Diagnostics.Experimental)] -public sealed class ModelSwitchToResult +internal sealed class SessionsFindByTaskIDRequest { - /// Currently active model identifier after the switch. - [JsonPropertyName("modelId")] - public string? ModelId { get; set; } + /// GitHub task ID to look up. + [JsonPropertyName("taskId")] + public string TaskId { get; set; } = string.Empty; } -/// Vision-specific limits. +/// Session ID matching the prefix, omitted when no unique match exists. [Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverrideLimitsVision +public sealed class SessionsFindByPrefixResult { - /// Maximum image size in bytes. - [JsonPropertyName("max_prompt_image_size")] - public long? MaxPromptImageSize { get; set; } - - /// Maximum number of images per prompt. - [JsonPropertyName("max_prompt_images")] - public long? MaxPromptImages { get; set; } - - /// MIME types the model accepts. - [JsonPropertyName("supported_media_types")] - public IList? SupportedMediaTypes { get; set; } + /// Omitted when no unique session matches the prefix (no match or ambiguous). + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } } -/// Token limits for prompts, outputs, and context window. +/// UUID prefix to resolve to a unique session ID. [Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverrideLimits +internal sealed class SessionsFindByPrefixRequest { - /// Maximum total context window size in tokens. - [JsonPropertyName("max_context_window_tokens")] - public long? MaxContextWindowTokens { get; set; } - - /// Maximum number of output/completion tokens. - [JsonPropertyName("max_output_tokens")] - public long? MaxOutputTokens { get; set; } - - /// Maximum number of prompt/input tokens. - [JsonPropertyName("max_prompt_tokens")] - public long? MaxPromptTokens { get; set; } - - /// Vision-specific limits. - [JsonPropertyName("vision")] - public ModelCapabilitiesOverrideLimitsVision? Vision { get; set; } + /// UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when there is no match or the prefix matches multiple sessions. + [JsonPropertyName("prefix")] + public string Prefix { get; set; } = string.Empty; } -/// Feature flags indicating what the model supports. +/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. [Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverrideSupports +public sealed class SessionsGetLastForContextResult { - /// Whether this model supports reasoning effort configuration. - [JsonPropertyName("reasoningEffort")] - public bool? ReasoningEffort { get; set; } - - /// Whether this model supports vision/image input. - [JsonPropertyName("vision")] - public bool? Vision { get; set; } + /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } } -/// Override individual model capabilities resolved by the runtime. +/// Optional working-directory context used to score session relevance. [Experimental(Diagnostics.Experimental)] -public sealed class ModelCapabilitiesOverride +internal sealed class SessionsGetLastForContextRequest { - /// Token limits for prompts, outputs, and context window. - [JsonPropertyName("limits")] - public ModelCapabilitiesOverrideLimits? Limits { get; set; } - - /// Feature flags indicating what the model supports. - [JsonPropertyName("supports")] - public ModelCapabilitiesOverrideSupports? Supports { get; set; } + /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. + [JsonPropertyName("context")] + public SessionContext? Context { get; set; } } -/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. +/// Absolute path to the session's events.jsonl file on disk. [Experimental(Diagnostics.Experimental)] -internal sealed class ModelSwitchToRequest +internal sealed class SessionsGetEventFilePathResult { - /// Explicit context tier for the selected model. `"default"` / `"long_context"` pin the tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier untouched. - [JsonPropertyName("contextTier")] - public ModelSwitchToRequestContextTier? ContextTier { get; set; } - - /// Override individual model capabilities resolved by the runtime. - [JsonPropertyName("modelCapabilities")] - public ModelCapabilitiesOverride? ModelCapabilities { get; set; } - - /// Model identifier to switch to. - [JsonPropertyName("modelId")] - public string ModelId { get; set; } = string.Empty; - - /// Reasoning effort level to use for the model. "none" disables reasoning. - [JsonPropertyName("reasoningEffort")] - public string? ReasoningEffort { get; set; } - - /// Reasoning summary mode to request for supported model clients. - [JsonPropertyName("reasoningSummary")] - public ReasoningSummary? ReasoningSummary { get; set; } + /// Absolute path to the session's events.jsonl file. + [JsonPropertyName("filePath")] + public string FilePath { get; set; } = string.Empty; +} - /// Target session identifier. +/// Session ID whose event-log file path to compute. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetEventFilePathRequest +{ + /// Session ID whose event-log file path to compute. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. +/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. [Experimental(Diagnostics.Experimental)] -public sealed class ModelSetReasoningEffortResult +public sealed class SessionSizes { - /// Reasoning effort level recorded on the session after the update. - [JsonPropertyName("reasoningEffort")] - public string ReasoningEffort { get; set; } = string.Empty; + /// Map of sessionId -> on-disk size in bytes for the session's workspace directory. + [JsonPropertyName("sizes")] + public IDictionary Sizes { get => field ??= new Dictionary(); set; } } -/// Reasoning effort level to apply to the currently selected model. +/// Session IDs from the input set that are currently in use by another process. [Experimental(Diagnostics.Experimental)] -internal sealed class ModelSetReasoningEffortRequest +public sealed class SessionsCheckInUseResult { - /// Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. - [JsonPropertyName("reasoningEffort")] - public string ReasoningEffort { get; set; } = string.Empty; - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Session IDs from the input set that are currently held by another running process via an alive lock file. + [JsonPropertyName("inUse")] + public IList InUse { get => field ??= []; set; } } -/// The list of models available to this session. +/// Session IDs to test for live in-use locks. [Experimental(Diagnostics.Experimental)] -public sealed class SessionModelList +internal sealed class SessionsCheckInUseRequest { - /// Available models, ordered with the most preferred default first. - [JsonPropertyName("list")] - public IList List { get => field ??= []; set; } - - /// Per-quota snapshots returned alongside the model list, keyed by quota type. - [JsonPropertyName("quotaSnapshots")] - public IDictionary? QuotaSnapshots { get; set; } + /// Session IDs to test for live in-use locks. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } } -/// Optional listing options. +/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. [Experimental(Diagnostics.Experimental)] -public sealed class ModelListRequest +internal sealed class SessionsGetPersistedRemoteSteerableResult { - /// If true, bypasses the per-session model list cache and re-fetches from CAPI. - [JsonPropertyName("skipCache")] - public bool? SkipCache { get; set; } + /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted. + [JsonPropertyName("remoteSteerable")] + public bool? RemoteSteerable { get; set; } } -/// Optional listing options. +/// Session ID to look up the persisted remote-steerable flag for. [Experimental(Diagnostics.Experimental)] -internal sealed class ModelListRequestWithSession +internal sealed class SessionsGetPersistedRemoteSteerableRequest { - /// Target session identifier. + /// Session ID to look up the persisted remote-steerable flag for. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// If true, bypasses the per-session model list cache and re-fetches from CAPI. - [JsonPropertyName("skipCache")] - public bool? SkipCache { get; set; } } -/// Identifies the target session. +/// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionModeGetRequest +public sealed class SessionsCloseResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; } -/// Agent interaction mode to apply to the session. +/// Session ID to close. [Experimental(Diagnostics.Experimental)] -internal sealed class ModeSetRequest +internal sealed class SessionsCloseRequest { - /// The session mode the agent is operating in. - [JsonPropertyName("mode")] - public SessionMode Mode { get; set; } - - /// Target session identifier. + /// Session ID to close. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// The session's friendly name, or null when not yet set. +/// Map of sessionId -> bytes freed by removing the session's workspace directory. [Experimental(Diagnostics.Experimental)] -public sealed class NameGetResult +public sealed class SessionBulkDeleteResult { - /// The session name (user-set or auto-generated), or null if not yet set. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). + [JsonPropertyName("freedBytes")] + public IDictionary FreedBytes { get => field ??= new Dictionary(); set; } } -/// Identifies the target session. +/// Session IDs to close, deactivate, and delete from disk. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionNameGetRequest +internal sealed class SessionsBulkDeleteRequest { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Session IDs to close, deactivate, and delete from disk. + [JsonPropertyName("sessionIds")] + public IList SessionIds { get => field ??= []; set; } } -/// New friendly name to apply to the session. +/// Session ID to delete from disk. [Experimental(Diagnostics.Experimental)] -internal sealed class NameSetRequest +internal sealed class SessionsDeleteRequest { - /// New session name (1–100 characters, trimmed of leading/trailing whitespace). - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [MaxLength(100)] - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Target session identifier. + /// Session ID to delete. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; -} -/// Indicates whether the auto-generated summary was applied as the session's name. -[Experimental(Diagnostics.Experimental)] -public sealed class NameSetAutoResult -{ - /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. - [JsonPropertyName("applied")] - public bool Applied { get; set; } + /// Internal resolved session directory path to delete. + [JsonPropertyName("sessionPath")] + public string? SessionPath { get; set; } } -/// Auto-generated session summary to apply as the session's name when no user-set name exists. +/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. [Experimental(Diagnostics.Experimental)] -internal sealed class NameSetAutoRequest +public sealed class SessionPruneResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Session IDs that would be deleted in dry-run mode (always empty otherwise). + [JsonPropertyName("candidates")] + public IList Candidates { get => field ??= []; set; } - /// Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. - [JsonPropertyName("summary")] - public string Summary { get; set; } = string.Empty; + /// Session IDs that were deleted (always empty in dry-run mode). + [JsonPropertyName("deleted")] + public IList Deleted { get => field ??= []; set; } + + /// True when no deletions were actually performed. + [JsonPropertyName("dryRun")] + public bool DryRun { get; set; } + + /// Total bytes freed (actual when not dry-run, projected when dry-run). + [JsonPropertyName("freedBytes")] + public long FreedBytes { get; set; } + + /// Session IDs that were skipped (e.g., named sessions). + [JsonPropertyName("skipped")] + public IList Skipped { get => field ??= []; set; } } -/// Existence, contents, and resolved path of the session plan file. +/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). [Experimental(Diagnostics.Experimental)] -public sealed class PlanReadResult +internal sealed class SessionsPruneOldRequest { - /// The content of the plan file, or null if it does not exist. - [JsonPropertyName("content")] - public string? Content { get; set; } + /// When true, only report what would be deleted without performing any deletion. + [JsonPropertyName("dryRun")] + public bool? DryRun { get; set; } - /// Whether the plan file exists in the workspace. - [JsonPropertyName("exists")] - public bool Exists { get; set; } + /// Session IDs that should never be considered for pruning. + [JsonPropertyName("excludeSessionIds")] + public IList? ExcludeSessionIds { get; set; } - /// Absolute file path of the plan file, or null if workspace is not enabled. - [JsonPropertyName("path")] - public string? Path { get; set; } + /// When true, named sessions (set via /rename) are also eligible for pruning. + [JsonPropertyName("includeNamed")] + public bool? IncludeNamed { get; set; } + + /// Delete sessions whose modifiedTime is at least this many days old. + [JsonPropertyName("olderThanDays")] + public long OlderThanDays { get; set; } } -/// Identifies the target session. +/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). [Experimental(Diagnostics.Experimental)] -internal sealed class SessionPlanReadRequest +public sealed class SessionsSaveResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; } -/// Replacement contents to write to the session plan file. +/// Session ID whose pending events should be flushed to disk. [Experimental(Diagnostics.Experimental)] -internal sealed class PlanUpdateRequest +internal sealed class SessionsSaveRequest { - /// The new content for the plan file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; - - /// Target session identifier. + /// Session ID whose pending events should be flushed to disk. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionPlanDeleteRequest +public sealed class SessionsReleaseLockResult { - /// Target session identifier. +} + +/// Session ID whose in-use lock should be released. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsReleaseLockRequest +{ + /// Session ID whose in-use lock should be released. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// RPC data type for WorkspacesGetWorkspaceResultWorkspace operations. -public sealed class WorkspacesGetWorkspaceResultWorkspace +/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionEnrichMetadataResult { - /// Gets or sets the branch value. - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } +} - /// Gets or sets the chronicle_sync_dismissed value. - [JsonPropertyName("chronicle_sync_dismissed")] - public bool? ChronicleSyncDismissed { get; set; } +/// Session metadata records to enrich with summary and context information. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsEnrichMetadataRequest +{ + /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. + [JsonPropertyName("sessions")] + public IList Sessions { get => field ??= []; set; } +} - /// Gets or sets the client_name value. - [JsonPropertyName("client_name")] - public string? ClientName { get; set; } +/// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionsReloadPluginHooksResult +{ +} - /// Gets or sets the created_at value. - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } +/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsReloadPluginHooksRequest +{ + /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. + [JsonPropertyName("deferRepoHooks")] + public bool? DeferRepoHooks { get; set; } - /// Gets or sets the cwd value. - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + /// Active session ID to reload hooks for. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Gets or sets the git_root value. - [JsonPropertyName("git_root")] - public string? GitRoot { get; set; } +/// Queued repo-level startup prompts and the total hook command count after loading. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionLoadDeferredRepoHooksResult +{ + /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. + [JsonPropertyName("hookCount")] + public long HookCount { get; set; } - /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - [JsonPropertyName("host_type")] - public WorkspacesWorkspaceDetailsHostType? HostType { get; set; } + /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. + [JsonPropertyName("startupPrompts")] + public IList StartupPrompts { get => field ??= []; set; } +} - /// Gets or sets the id value. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; +/// Active session ID whose deferred repo-level hooks should be loaded. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsLoadDeferredRepoHooksRequest +{ + /// Active session ID whose deferred repo-level hooks should be loaded. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Gets or sets the mc_last_event_id value. - [JsonPropertyName("mc_last_event_id")] - public string? McLastEventId { get; set; } +/// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionsSetAdditionalPluginsResult +{ +} - /// Gets or sets the mc_session_id value. - [JsonPropertyName("mc_session_id")] - public string? McSessionId { get; set; } +/// Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. +[Experimental(Diagnostics.Experimental)] +public sealed class InstalledPlugin +{ + /// Path where the plugin is cached locally. + [JsonPropertyName("cache_path")] + public string? CachePath { get; set; } - /// Gets or sets the mc_task_id value. - [JsonPropertyName("mc_task_id")] - public string? McTaskId { get; set; } + /// Whether the plugin is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } - /// Gets or sets the name value. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// Installation timestamp. + [JsonPropertyName("installed_at")] + public string InstalledAt { get; set; } = string.Empty; - /// Gets or sets the remote_steerable value. - [JsonPropertyName("remote_steerable")] - public bool? RemoteSteerable { get; set; } + /// Marketplace the plugin came from (empty string for direct repo installs). + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; - /// Gets or sets the repository value. - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Gets or sets the summary_count value. - [JsonPropertyName("summary_count")] - public long? SummaryCount { get; set; } + /// Source for direct repo installs (when marketplace is empty). + [JsonPropertyName("source")] + public JsonElement? Source { get; set; } - /// Gets or sets the updated_at value. - [JsonPropertyName("updated_at")] - public DateTimeOffset? UpdatedAt { get; set; } + /// Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + [JsonPropertyName("source_sha")] + public string? SourceSha { get; set; } - /// Gets or sets the user_named value. - [JsonPropertyName("user_named")] - public bool? UserNamed { get; set; } + /// Version installed (if available). + [JsonPropertyName("version")] + public string? Version { get; set; } } -/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// Manager-wide additional plugins to register; replaces any previously-configured set. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesGetWorkspaceResult +internal sealed class SessionsSetAdditionalPluginsRequest { - /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). - [JsonPropertyName("path")] - public string? Path { get; set; } + /// Manager-wide additional plugins to register. Replaces any previously-configured set. Pass an empty array to clear. + [JsonPropertyName("plugins")] + public IList Plugins { get => field ??= []; set; } +} - /// Current workspace metadata, or null if not available. - [JsonPropertyName("workspace")] - public WorkspacesGetWorkspaceResultWorkspace? Workspace { get; set; } +/// Dynamic-context board entry count, when available. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionsGetBoardEntryCountResult +{ + /// Board entry count, when available. + [JsonPropertyName("count")] + public long? Count { get; set; } } -/// Identifies the target session. +/// Session ID whose board entry count should be returned. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesGetWorkspaceRequest +internal sealed class SessionsGetBoardEntryCountRequest { - /// Target session identifier. + /// Session ID whose board entry count should be returned. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Relative paths of files stored in the session workspace files directory. +/// State of the runtime-managed remote-control singleton. +/// Polymorphic base type discriminated by state. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesListFilesResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "state", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(RemoteControlStatusOff), "off")] +[JsonDerivedType(typeof(RemoteControlStatusConnecting), "connecting")] +[JsonDerivedType(typeof(RemoteControlStatusActive), "active")] +[JsonDerivedType(typeof(RemoteControlStatusError), "error")] +public partial class RemoteControlStatus { - /// Relative file paths in the workspace files directory. - [JsonPropertyName("files")] - public IList Files { get => field ??= []; set; } + /// The type discriminator. + [JsonPropertyName("state")] + public virtual string State { get; set; } = string.Empty; } -/// Identifies the target session. + +/// Remote control is not connected. +/// The off variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesListFilesRequest +public partial class RemoteControlStatusOff : RemoteControlStatus { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string State => "off"; } -/// Contents of the requested workspace file as a UTF-8 string. +/// Remote control is in the middle of initial setup. +/// The connecting variant of . [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesReadFileResult +public partial class RemoteControlStatusConnecting : RemoteControlStatus { - /// File content as a UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string State => "connecting"; + + /// Session id the connection is attaching to. + [JsonPropertyName("attachedSessionId")] + public required string AttachedSessionId { get; set; } } -/// Relative path of the workspace file to read. +/// Remote control is connected to a local session. +/// The active variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesReadFileRequest +public partial class RemoteControlStatusActive : RemoteControlStatus { - /// Relative path within the workspace files directory. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string State => "active"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Session id remote control is pointed at. + [JsonPropertyName("attachedSessionId")] + public required string AttachedSessionId { get; set; } + + /// True while a read-only/session-sync export is deferred, awaiting the first `user.message` before its MC session exists. Marked internal: this field is excluded from the public SDK surface and is populated only on the CLI in-process path. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("awaitingFirstMessage")] + internal bool? AwaitingFirstMessage { get; set; } + + /// MC frontend URL for this session, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("frontendUrl")] + public string? FrontendUrl { get; set; } + + /// Whether the MC session may steer this session. + [JsonPropertyName("isSteerable")] + public required bool IsSteerable { get; set; } } -/// Relative path and UTF-8 content for the workspace file to create or overwrite. +/// The last setup attempt failed. The singleton is otherwise off. +/// The error variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesCreateFileRequest +public partial class RemoteControlStatusError : RemoteControlStatus { - /// File content to write as a UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string State => "error"; - /// Relative path within the workspace files directory. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Session id the failing setup attempt targeted, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("attachedSessionId")] + public string? AttachedSessionId { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Human-readable error message from the last setup attempt. + [JsonPropertyName("error")] + public required string Error { get; set; } } -/// Schema for the `WorkspacesCheckpoints` type. +/// Wrapper for the singleton's current status. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesCheckpoints +public sealed class RemoteControlStatusResult { - /// Filename of the checkpoint within the workspace checkpoints directory. - [JsonPropertyName("filename")] - public string Filename { get; set; } = string.Empty; + /// State of the runtime-managed remote-control singleton. + [JsonPropertyName("status")] + public RemoteControlStatus Status { get => field ??= new(); set; } +} - /// Checkpoint number assigned by the workspace manager. - [JsonPropertyName("number")] - public long Number { get; set; } +/// Reattach to an existing MC session without creating a new one. +[Experimental(Diagnostics.Experimental)] +public sealed class RemoteControlConfigExistingMcSession +{ + /// Existing MC session ID to reattach to. + [JsonPropertyName("mcSessionId")] + public string McSessionId { get; set; } = string.Empty; - /// Human-readable checkpoint title. - [JsonPropertyName("title")] - public string Title { get; set; } = string.Empty; + /// Existing MC task ID for the reattached session. + [JsonPropertyName("mcTaskId")] + public string McTaskId { get; set; } = string.Empty; } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Configuration for the runtime-managed remote-control singleton. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesListCheckpointsResult +public sealed class RemoteControlConfig { - /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. - [JsonPropertyName("checkpoints")] - public IList Checkpoints { get => field ??= []; set; } + /// Reattach to an existing MC session without creating a new one. + [JsonPropertyName("existingMcSession")] + public RemoteControlConfigExistingMcSession? ExistingMcSession { get; set; } + + /// Whether the user explicitly requested remote (vs. implicit session-sync). Controls warning surfacing for missing-repo cases. + [JsonPropertyName("explicit")] + public bool Explicit { get; set; } + + /// Whether remote export should be enabled. + [JsonPropertyName("remote")] + public bool Remote { get; set; } + + /// When true, suppresses timeline messages on successful setup. + [JsonPropertyName("silent")] + public bool Silent { get; set; } + + /// Whether the MC session may steer the local session (write mode). + [JsonPropertyName("steerable")] + public bool Steerable { get; set; } + + /// Existing Mission Control task ID to attach the exported session to. + [JsonPropertyName("taskId")] + public string? TaskId { get; set; } } -/// Identifies the target session. +/// Parameters for attaching the remote-control singleton to a session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionWorkspacesListCheckpointsRequest +internal sealed class SessionsStartRemoteControlRequest { - /// Target session identifier. + /// Configuration for the runtime-managed remote-control singleton. + [JsonPropertyName("config")] + public RemoteControlConfig Config { get => field ??= new(); set; } + + /// Local session id to attach remote control to. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// Outcome of a transferRemoteControl call. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesReadCheckpointResult +public sealed class RemoteControlTransferResult { - /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. - [JsonPropertyName("content")] - public string? Content { get; set; } + /// State of the runtime-managed remote-control singleton. + [JsonPropertyName("status")] + public RemoteControlStatus Status { get => field ??= new(); set; } + + /// Whether the rebinding actually happened. + [JsonPropertyName("transferred")] + public bool Transferred { get; set; } } -/// Checkpoint number to read. +/// Parameters for atomically rebinding the remote-control singleton. [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesReadCheckpointRequest -{ - /// Checkpoint number to read. - [JsonPropertyName("number")] - public long Number { get; set; } - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} - -/// RPC data type for WorkspacesSaveLargePasteResultSaved operations. -public sealed class WorkspacesSaveLargePasteResultSaved +internal sealed class SessionsTransferRemoteControlRequest { - /// Filename within the workspace files directory. - [JsonPropertyName("filename")] - public string Filename { get; set; } = string.Empty; + /// When provided, the transfer is rejected unless the singleton currently points at this session id (compare-and-swap semantics to avoid clobbering newer state). + [JsonPropertyName("expectedFromSessionId")] + public string? ExpectedFromSessionId { get; set; } - /// Absolute filesystem path to the saved paste file. - [JsonPropertyName("filePath")] - public string FilePath { get; set; } = string.Empty; - - /// Size of the saved file in bytes. - [JsonPropertyName("sizeBytes")] - public long SizeBytes { get; set; } + /// Local session id to point remote control at. + [JsonPropertyName("toSessionId")] + public string ToSessionId { get; set; } = string.Empty; } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// Patch for the singleton's steering state. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspacesSaveLargePasteResult +internal sealed class SessionsSetRemoteControlSteeringRequest { - /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions). - [JsonPropertyName("saved")] - public WorkspacesSaveLargePasteResultSaved? Saved { get; set; } + /// Target steering state. Today only `true` is actionable on the underlying exporter; `false` is reserved for future use. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } } -/// Pasted content to save as a UTF-8 file in the session workspace. +/// Outcome of a stopRemoteControl call. [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesSaveLargePasteRequest +public sealed class RemoteControlStopResult { - /// Pasted content to save as a UTF-8 file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// State of the runtime-managed remote-control singleton. + [JsonPropertyName("status")] + public RemoteControlStatus Status { get => field ??= new(); set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Whether the singleton was actually torn down by this call. + [JsonPropertyName("stopped")] + public bool Stopped { get; set; } } -/// A single changed file and its unified diff. +/// RPC data type for SessionsStopRemoteControl operations. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspaceDiffFileChange +internal sealed class SessionsStopRemoteControlRequest { - /// Type of change represented by this file diff. - [JsonPropertyName("changeType")] - public WorkspaceDiffFileChangeType ChangeType { get; set; } - - /// Unified diff content for the file. Empty when the diff was truncated. - [JsonPropertyName("diff")] - public string Diff { get; set; } = string.Empty; + /// When provided, the stop is rejected unless the singleton currently points at this session id (compare-and-swap semantics). + [JsonPropertyName("expectedSessionId")] + public string? ExpectedSessionId { get; set; } - /// Whether the diff content was omitted because it exceeded the per-file size limit. - [JsonPropertyName("isTruncated")] - public bool? IsTruncated { get; set; } - - /// Original file path for renamed files. - [JsonPropertyName("oldPath")] - public string? OldPath { get; set; } - - /// Path to the changed file, relative to the workspace root. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. Use during shutdown or explicit `/remote off`. + [JsonPropertyName("force")] + public bool? Force { get; set; } } -/// Workspace diff result for the requested mode. +/// Handle for releasing the extension tool registration. [Experimental(Diagnostics.Experimental)] -public sealed class WorkspaceDiffResult +internal sealed class RegisterExtensionToolsResult { - /// Default branch used for a branch diff, when branch mode was requested. - [JsonPropertyName("baseBranch")] - public string? BaseBranch { get; set; } - - /// Changed files and their unified diffs. - [JsonPropertyName("changes")] - public IList Changes { get => field ??= []; set; } - - /// Whether a requested branch diff fell back to unstaged changes because branch diff failed. - [JsonPropertyName("isFallback")] - public bool IsFallback { get; set; } - - /// Effective mode used for the returned changes. - [JsonPropertyName("mode")] - public WorkspaceDiffMode Mode { get; set; } - - /// Diff mode requested by the client. - [JsonPropertyName("requestedMode")] - public WorkspaceDiffMode RequestedMode { get; set; } } -/// Parameters for computing a workspace diff. +/// Optional registration options. [Experimental(Diagnostics.Experimental)] -internal sealed class WorkspacesDiffRequest +public sealed class SessionsRegisterExtensionToolsOnSessionOptions { - /// Diff mode requested by the client. - [JsonPropertyName("mode")] - public WorkspaceDiffMode Mode { get; set; } - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; } -/// Schema for the `InstructionsSources` type. +/// Params to attach an extension loader's tools to a session. [Experimental(Diagnostics.Experimental)] -public sealed class InstructionsSources +internal sealed class RegisterExtensionToolsParams { - /// Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files. - [JsonPropertyName("applyTo")] - public IList? ApplyTo { get; set; } - - /// Raw content of the instruction file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; - - /// When true, this source starts disabled and must be toggled on by the user. - [JsonPropertyName("defaultDisabled")] - public bool? DefaultDisabled { get; set; } - - /// Short description (body after frontmatter) for use in instruction tables. - [JsonPropertyName("description")] - public string? Description { get; set; } - - /// Unique identifier for this source (used for toggling). - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; - - /// Human-readable label. - [JsonPropertyName("label")] - public string Label { get; set; } = string.Empty; - - /// Where this source lives — used for UI grouping. - [JsonPropertyName("location")] - public InstructionsSourcesLocation Location { get; set; } - - /// File path relative to repo or absolute for home. - [JsonPropertyName("sourcePath")] - public string SourcePath { get; set; } = string.Empty; - - /// Category of instruction source — used for merge logic. - [JsonPropertyName("type")] - public InstructionsSourcesType Type { get; set; } -} + /// Optional registration options. + [JsonPropertyName("options")] + public SessionsRegisterExtensionToolsOnSessionOptions? Options { get; set; } -/// Instruction sources loaded for the session, in merge order. -[Experimental(Diagnostics.Experimental)] -public sealed class InstructionsGetSourcesResult -{ - /// Instruction sources for the session. - [JsonPropertyName("sources")] - public IList Sources { get => field ??= []; set; } + /// Session to register extension tools on. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Params to attach or detach an in-process ExtensionController delegate. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionInstructionsGetSourcesRequest +internal sealed class ConfigureSessionExtensionsParams { - /// Target session identifier. + /// Session to attach the extension controller delegate to. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether fleet mode was successfully activated. +/// Outcome of an agentRegistry.spawn call. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class FleetStartResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(AgentRegistrySpawnResultSpawned), "spawned")] +[JsonDerivedType(typeof(AgentRegistrySpawnResultSpawnError), "spawn-error")] +[JsonDerivedType(typeof(AgentRegistrySpawnResultRegistryTimeout), "registry-timeout")] +[JsonDerivedType(typeof(AgentRegistrySpawnResultValidationError), "validation-error")] +public partial class AgentRegistrySpawnResult { - /// Whether fleet mode was successfully activated. - [JsonPropertyName("started")] - public bool Started { get; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Optional user prompt to combine with the fleet orchestration instructions. + +/// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). [Experimental(Diagnostics.Experimental)] -internal sealed class FleetStartRequest +public sealed class AgentRegistryLiveTargetEntry { - /// Optional user prompt to combine with fleet instructions. - [JsonPropertyName("prompt")] - public string? Prompt { get; set; } + /// Kind of attention required when status === "attention". Meaningful only when status === "attention". + [JsonPropertyName("attentionKind")] + public AgentRegistryLiveTargetEntryAttentionKind? AttentionKind { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Git branch of the session (when known). + [JsonPropertyName("branch")] + public string? Branch { get; set; } -/// Schema for the `AgentInfo` type. -[Experimental(Diagnostics.Experimental)] -public sealed class AgentInfo -{ - /// Description of the agent's purpose. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Copilot CLI version that wrote the entry. + [JsonPropertyName("copilotVersion")] + public string CopilotVersion { get; set; } = string.Empty; - /// Human-readable display name. - [JsonPropertyName("displayName")] - public string DisplayName { get; set; } = string.Empty; + /// Working directory of the session (when known). + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } - /// Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// Bind host for the entry's JSON-RPC server. + [JsonPropertyName("host")] + public string Host { get; set; } = string.Empty; - /// MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. - [Experimental(Diagnostics.Experimental)] - [JsonPropertyName("mcpServers")] - public IDictionary? McpServers { get; set; } + /// Process kind tag for the registry entry. + [JsonPropertyName("kind")] + public AgentRegistryLiveTargetEntryKind Kind { get; set; } + + /// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness). + [JsonPropertyName("lastSeenMs")] + public long LastSeenMs { get; set; } + + /// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. + [JsonPropertyName("lastTerminalEvent")] + public AgentRegistryLiveTargetEntryLastTerminalEvent? LastTerminalEvent { get; set; } - /// Preferred model id for this agent. When omitted, inherits the outer agent's model. + /// Model identifier currently selected for the session. [JsonPropertyName("model")] public string? Model { get; set; } - /// Unique identifier of the custom agent. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Operating-system pid of the process owning this entry. + [JsonPropertyName("pid")] + public long Pid { get; set; } - /// Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. - [JsonPropertyName("path")] - public string? Path { get; set; } + /// TCP port the entry's JSON-RPC server is listening on. + [JsonPropertyName("port")] + public long Port { get; set; } - /// Skill names preloaded into this agent's context. Omitted means none. - [JsonPropertyName("skills")] - public IList? Skills { get; set; } + /// Registry entry schema version (1 = ui-server, 2 = managed-server). + [JsonPropertyName("schemaVersion")] + public long SchemaVersion { get; set; } - /// Where the agent definition was loaded from. - [JsonPropertyName("source")] - public AgentInfoSource? Source { get; set; } + /// Session ID of the foreground session for this entry. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } - /// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. - [JsonPropertyName("tools")] - public IList? Tools { get; set; } + /// Friendly session name (when set). + [JsonPropertyName("sessionName")] + public string? SessionName { get; set; } - /// Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. - [JsonPropertyName("userInvocable")] - public bool? UserInvocable { get; set; } -} + /// ISO 8601 timestamp captured at registration. + [JsonPropertyName("startedAt")] + public string StartedAt { get; set; } = string.Empty; -/// Custom agents available to the session. -[Experimental(Diagnostics.Experimental)] -public sealed class AgentList -{ - /// Available custom agents. - [JsonPropertyName("agents")] - public IList Agents { get => field ??= []; set; } -} + /// Coarse lifecycle status of the foreground session. + [JsonPropertyName("status")] + public AgentRegistryLiveTargetEntryStatus? Status { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentListRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. + [JsonPropertyName("statusRevision")] + public long? StatusRevision { get; set; } + + /// Connection token (null when the target is unauthenticated). + [JsonInclude] + [JsonPropertyName("token")] + internal string? Token { get; set; } } -/// The currently selected custom agent, or null when using the default agent. +/// Per-spawn log-capture outcome; populated from spawnLiveTarget. [Experimental(Diagnostics.Experimental)] -public sealed class AgentGetCurrentResult +public sealed class AgentRegistryLogCapture { - /// Currently selected custom agent, or null if using the default agent. - [JsonPropertyName("agent")] - public AgentInfo? Agent { get; set; } + /// Whether per-spawn log capture is on (false when env-disabled or open failed). + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used). + [JsonPropertyName("openError")] + public string? OpenError { get; set; } + + /// Categorized reason for log-open failure. + [JsonPropertyName("openErrorReason")] + public AgentRegistryLogCaptureOpenErrorReason? OpenErrorReason { get; set; } + + /// Absolute path to the per-spawn log file (only set when enabled). + [JsonPropertyName("path")] + public string? Path { get; set; } } -/// Identifies the target session. +/// Managed-server child was spawned and registered successfully. +/// The spawned variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentGetCurrentRequest +public partial class AgentRegistrySpawnResultSpawned : AgentRegistrySpawnResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "spawned"; + + /// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). + [JsonPropertyName("entry")] + public required AgentRegistryLiveTargetEntry Entry { get; set; } + + /// If the delegate attempted to send the initial prompt and failed, the categorized error message. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("initialPromptError")] + public string? InitialPromptError { get; set; } + + /// Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("initialPromptSent")] + public bool? InitialPromptSent { get; set; } + + /// Per-spawn log-capture outcome; populated from spawnLiveTarget. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("logCapture")] + public AgentRegistryLogCapture? LogCapture { get; set; } } -/// The newly selected custom agent. +/// `child_process.spawn` itself failed before the child entered the registry. +/// The spawn-error variant of . [Experimental(Diagnostics.Experimental)] -public sealed class AgentSelectResult +public partial class AgentRegistrySpawnResultSpawnError : AgentRegistrySpawnResult { - /// The newly selected custom agent. - [JsonPropertyName("agent")] - public AgentInfo Agent { get => field ??= new(); set; } + /// + [JsonIgnore] + public override string Kind => "spawn-error"; + + /// Underlying errno code (e.g. ENOENT, EACCES) when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("code")] + public string? Code { get; set; } + + /// Human-readable error message. + [JsonPropertyName("message")] + public required string Message { get; set; } } -/// Name of the custom agent to select for subsequent turns. +/// Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. +/// The registry-timeout variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class AgentSelectRequest +public partial class AgentRegistrySpawnResultRegistryTimeout : AgentRegistrySpawnResult { - /// Name of the custom agent to select. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "registry-timeout"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance). + [JsonPropertyName("childPid")] + public required long ChildPid { get; set; } + + /// Per-spawn log-capture outcome; populated from spawnLiveTarget. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("logCapture")] + public AgentRegistryLogCapture? LogCapture { get; set; } } -/// Identifies the target session. +/// Synchronous pre-validation rejected the spawn request. +/// The validation-error variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentDeselectRequest +public partial class AgentRegistrySpawnResultValidationError : AgentRegistrySpawnResult { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "validation-error"; + + /// Which parameter field was invalid. Omitted when the rejection is not field-specific. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("field")] + public AgentRegistrySpawnValidationErrorField? Field { get; set; } + + /// Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. + [JsonPropertyName("reason")] + public required AgentRegistrySpawnValidationErrorReason Reason { get; set; } } -/// Custom agents available to the session after reloading definitions from disk. +/// Inputs to spawn a managed-server child via the controller's spawn delegate. [Experimental(Diagnostics.Experimental)] -public sealed class AgentReloadResult +internal sealed class AgentRegistrySpawnRequest { - /// Reloaded custom agents. - [JsonPropertyName("agents")] - public IList Agents { get => field ??= []; set; } + /// Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. + [JsonPropertyName("agentName")] + public string? AgentName { get; set; } + + /// Working directory for the spawned child (must be an existing directory). + [JsonPropertyName("cwd")] + public string Cwd { get; set; } = string.Empty; + + /// Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). + [JsonPropertyName("initialPrompt")] + public string? InitialPrompt { get; set; } + + /// Model identifier to apply to the new session. + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. + [JsonPropertyName("permissionMode")] + public AgentRegistrySpawnPermissionMode? PermissionMode { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionAgentReloadRequest +internal sealed class SessionSuspendRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Identifier assigned to the newly started background agent task. +/// Result of sending a user message. [Experimental(Diagnostics.Experimental)] -public sealed class TasksStartAgentResult +public sealed class SendResult { - /// Generated agent ID for the background task. - [JsonPropertyName("agentId")] - public string AgentId { get; set; } = string.Empty; + /// Unique identifier assigned to the message. + [JsonPropertyName("messageId")] + public string MessageId { get; set; } = string.Empty; } -/// Agent type, prompt, name, and optional description and model override for the new task. +/// Parameters for sending a user message to the session. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksStartAgentRequest +internal sealed class SendRequest { - /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose'). - [JsonPropertyName("agentType")] - public string AgentType { get; set; } = string.Empty; + /// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. + [JsonPropertyName("agentMode")] + public SendAgentMode? AgentMode { get; set; } - /// Short description of the task. - [JsonPropertyName("description")] - public string? Description { get; set; } + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message. + [JsonPropertyName("attachments")] + public IList? Attachments { get; set; } - /// Optional model override. - [JsonPropertyName("model")] - public string? Model { get; set; } + /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + [JsonPropertyName("billable")] + public bool? Billable { get; set; } - /// Short name for the agent, used to generate a human-readable ID. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// If provided, this is shown in the timeline instead of `prompt`. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } - /// Task prompt for the agent. + /// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + [JsonPropertyName("mode")] + public SendMode? Mode { get; set; } + + /// If true, adds the message to the front of the queue instead of the end. + [JsonPropertyName("prepend")] + public bool? Prepend { get; set; } + + /// The user message text. [JsonPropertyName("prompt")] public string Prompt { get; set; } = string.Empty; + /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + [JsonPropertyName("requestHeaders")] + public IDictionary? RequestHeaders { get; set; } + + /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange. + [JsonPropertyName("requiredTool")] + public string? RequiredTool { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-<command-id>` for command-originated messages, `schedule-<numeric-id>` for scheduled prompts, or `agent-<agent-id>` for prompts sent by another agent. + [RegularExpression("^(user|system|command-.*|schedule-\\d+|agent-.+)$")] + [JsonInclude] + [JsonPropertyName("source")] + internal string? Source { get; set; } + + /// W3C Trace Context traceparent header for distributed tracing of this agent turn. + [JsonPropertyName("traceparent")] + public string? Traceparent { get; set; } + + /// W3C Trace Context tracestate header for distributed tracing. + [JsonPropertyName("tracestate")] + public string? Tracestate { get; set; } + + /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + [JsonPropertyName("wait")] + public bool? Wait { get; set; } } -/// Schema for the `TaskInfo` type. -/// Polymorphic base type discriminated by type. +/// Result of sending zero or more user messages. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(TaskInfoAgent), "agent")] -[JsonDerivedType(typeof(TaskInfoShell), "shell")] -public partial class TaskInfo +public sealed class SendMessagesResult { - /// The type discriminator. - [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; + /// Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided. + [JsonPropertyName("messageIds")] + public IList MessageIds { get => field ??= []; set; } } - -/// Schema for the `TaskAgentInfo` type. -/// The agent variant of . +/// A single user message to append to the session as part of a `session.sendMessages` turn. [Experimental(Diagnostics.Experimental)] -public partial class TaskInfoAgent : TaskInfo +public sealed class SendMessageItem { - /// - [JsonIgnore] - public override string Type => "agent"; + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message. + [JsonPropertyName("attachments")] + public IList? Attachments { get; set; } - /// ISO 8601 timestamp when the current active period began. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("activeStartedAt")] - public DateTimeOffset? ActiveStartedAt { get; set; } + /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + [JsonInclude] + [JsonPropertyName("billable")] + internal bool? Billable { get; set; } - /// Accumulated active execution time in milliseconds. - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("activeTimeMs")] - public TimeSpan? ActiveTime { get; set; } - - /// Type of agent running this task. - [JsonPropertyName("agentType")] - public required string AgentType { get; set; } - - /// 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. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("canPromoteToBackground")] - public bool? CanPromoteToBackground { get; set; } - - /// ISO 8601 timestamp when the task finished. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("completedAt")] - public DateTimeOffset? CompletedAt { get; set; } - - /// Short description of the task. - [JsonPropertyName("description")] - public required string Description { get; set; } - - /// Error message when the task failed. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("error")] - public string? Error { get; set; } - - /// Whether task execution is synchronously awaited or managed in the background. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("executionMode")] - public TaskExecutionMode? ExecutionMode { get; set; } - - /// Unique task identifier. - [JsonPropertyName("id")] - public required string Id { get; set; } - - /// ISO 8601 timestamp when the agent entered idle state. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("idleSince")] - public DateTimeOffset? IdleSince { get; set; } - - /// Most recent response text from the agent. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("latestResponse")] - public string? LatestResponse { get; set; } - - /// Model used for the task when specified. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("model")] - public string? Model { get; set; } + /// If provided, this is shown in the timeline instead of `prompt`. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } - /// Prompt passed to the agent. + /// The user message text. [JsonPropertyName("prompt")] - public required string Prompt { get; set; } - - /// Result text from the task when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("result")] - public string? Result { get; set; } - - /// ISO 8601 timestamp when the task was started. - [JsonPropertyName("startedAt")] - public required DateTimeOffset StartedAt { get; set; } + public string Prompt { get; set; } = string.Empty; - /// Current lifecycle status of the task. - [JsonPropertyName("status")] - public required TaskStatus Status { get; set; } + /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange. + [JsonPropertyName("requiredTool")] + public string? RequiredTool { get; set; } - /// Tool call ID associated with this agent task. - [JsonPropertyName("toolCallId")] - public required string ToolCallId { get; set; } + /// Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-<command-id>` for command-originated messages, `schedule-<numeric-id>` for scheduled prompts, or `agent-<agent-id>` for prompts sent by another agent. + [RegularExpression("^(user|system|command-.*|schedule-\\d+|agent-.+)$")] + [JsonInclude] + [JsonPropertyName("source")] + internal string? Source { get; set; } } -/// Schema for the `TaskShellInfo` type. -/// The shell variant of . +/// Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. [Experimental(Diagnostics.Experimental)] -public partial class TaskInfoShell : TaskInfo +internal sealed class SendMessagesRequest { - /// - [JsonIgnore] - public override string Type => "shell"; + /// The UI mode the agent was in when these messages were sent. Defaults to the session's current mode. + [JsonPropertyName("agentMode")] + public SendAgentMode? AgentMode { get; set; } - /// Whether the shell runs inside a managed PTY session or as an independent background process. - [JsonPropertyName("attachmentMode")] - public required TaskShellInfoAttachmentMode AttachmentMode { get; set; } + /// The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message. + [JsonPropertyName("messages")] + public IList Messages { get => field ??= []; set; } - /// Whether this shell task can be promoted to background mode. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("canPromoteToBackground")] - public bool? CanPromoteToBackground { get; set; } + /// How to deliver the messages. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + [JsonPropertyName("mode")] + public SendMode? Mode { get; set; } - /// Command being executed. - [JsonPropertyName("command")] - public required string Command { get; set; } + /// If true, adds the messages to the front of the queue instead of the end. + [JsonPropertyName("prepend")] + public bool? Prepend { get; set; } - /// ISO 8601 timestamp when the task finished. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("completedAt")] - public DateTimeOffset? CompletedAt { get; set; } + /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + [JsonPropertyName("requestHeaders")] + public IDictionary? RequestHeaders { get; set; } - /// Short description of the task. - [JsonPropertyName("description")] - public required string Description { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Whether task execution is synchronously awaited or managed in the background. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("executionMode")] - public TaskExecutionMode? ExecutionMode { get; set; } + /// W3C Trace Context traceparent header for distributed tracing of this agent turn. + [JsonPropertyName("traceparent")] + public string? Traceparent { get; set; } - /// Unique task identifier. - [JsonPropertyName("id")] - public required string Id { get; set; } + /// W3C Trace Context tracestate header for distributed tracing. + [JsonPropertyName("tracestate")] + public string? Tracestate { get; set; } - /// Path to the detached shell log, when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("logPath")] - public string? LogPath { get; set; } + /// If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + [JsonPropertyName("wait")] + public bool? Wait { get; set; } +} - /// Process ID when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("pid")] - public long? Pid { get; set; } +/// Internal request for sending a system notification. +[Experimental(Diagnostics.Experimental)] +internal sealed class SendSystemNotificationRequest +{ + /// Optional structured notification kind. + [JsonPropertyName("kind")] + public JsonElement? Kind { get; set; } - /// ISO 8601 timestamp when the task was started. - [JsonPropertyName("startedAt")] - public required DateTimeOffset StartedAt { get; set; } + /// Notification text to deliver to the model. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Current lifecycle status of the task. - [JsonPropertyName("status")] - public required TaskStatus Status { get; set; } + /// Internal delivery options, including passive policy. + [JsonPropertyName("options")] + public JsonElement? Options { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Background tasks currently tracked by the session. +/// Result of aborting the current turn. [Experimental(Diagnostics.Experimental)] -public sealed class TaskList +public sealed class AbortResult { - /// Currently tracked tasks. - [JsonPropertyName("tasks")] - public IList Tasks { get => field ??= []; set; } + /// Error message if the abort failed. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Whether the abort completed successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Identifies the target session. +/// Parameters for aborting the current turn. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksListRequest +internal sealed class AbortRequest { + /// Finite reason code describing why the current turn was aborted. + [JsonPropertyName("reason")] + public AbortReason? Reason { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. +/// Result of interrupting the main agent turn. [Experimental(Diagnostics.Experimental)] -public sealed class TasksRefreshResult +public sealed class InterruptMainTurnResult { + /// Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + [JsonPropertyName("interrupted")] + public bool Interrupted { get; set; } } -/// Identifies the target session. +/// Parameters for interrupting the main agent turn. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksRefreshRequest +internal sealed class InterruptMainTurnRequest { + /// When true, the user's queued prompts are preserved and run as the next turn once the interrupted turn unwinds; when false (the default), the queue is cleared like a plain abort. + [JsonPropertyName("flushQueued")] + public bool? FlushQueued { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class TasksWaitForPendingResult +internal sealed class SessionCancelAllBackgroundAgentsRequest { + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Parameters for shutting down the session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksWaitForPendingRequest +internal sealed class ShutdownRequest { + /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. + [JsonPropertyName("reason")] + public string? Reason { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; -} -/// Polymorphic base type discriminated by type. -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "type", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(TasksGetProgressResultProgressAgent), "agent")] -[JsonDerivedType(typeof(TasksGetProgressResultProgressShell), "shell")] -public partial class TasksGetProgressResultProgress -{ - /// The type discriminator. + /// Why the session is being shut down. Defaults to "routine" when omitted. [JsonPropertyName("type")] - public virtual string Type { get; set; } = string.Empty; + public ShutdownType? Type { get; set; } } +/// Identifier of the session event that was emitted for the log message. +[Experimental(Diagnostics.Experimental)] +public sealed class LogResult +{ + /// The unique identifier of the emitted session event. + [JsonPropertyName("eventId")] + public Guid EventId { get; set; } +} -/// Schema for the `TaskProgressLine` type. +/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. [Experimental(Diagnostics.Experimental)] -public sealed class TaskProgressLine +internal sealed class LogRequest { - /// Display message, e.g., "▸ bash", "✓ edit src/foo.ts". + /// When true, the message is transient and not persisted to the session event log on disk. + [JsonPropertyName("ephemeral")] + public bool? Ephemeral { get; set; } + + /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". + [JsonPropertyName("level")] + public SessionLogLevel? Level { get; set; } + + /// Human-readable message. [JsonPropertyName("message")] public string Message { get; set; } = string.Empty; - /// ISO 8601 timestamp when this event occurred. - [JsonPropertyName("timestamp")] - public DateTimeOffset Timestamp { get; set; } -} + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; -/// Schema for the `TaskAgentProgress` type. -/// The agent variant of . -public partial class TasksGetProgressResultProgressAgent : TasksGetProgressResultProgress -{ - /// - [JsonIgnore] - public override string Type => "agent"; + /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + [JsonPropertyName("tip")] + public string? Tip { get; set; } - /// The most recent intent reported by the agent. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("latestIntent")] - public string? LatestIntent { get; set; } + /// Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + [JsonPropertyName("type")] + public string? Type { get; set; } - /// Recent tool execution events converted to display lines. - [JsonPropertyName("recentActivity")] - public required IList RecentActivity { get; set; } + /// Optional URL the user can open in their browser for more details. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("url")] + public string? Url { get; set; } } -/// Schema for the `TaskShellProgress` type. -/// The shell variant of . -public partial class TasksGetProgressResultProgressShell : TasksGetProgressResultProgress +/// Authentication status and account metadata for the session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionAuthStatus { - /// - [JsonIgnore] - public override string Type => "shell"; + /// Authentication type. + [JsonPropertyName("authType")] + public AuthInfoType? AuthType { get; set; } - /// Process ID when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("pid")] - public long? Pid { get; set; } + /// Copilot plan tier (e.g., individual_pro, business). + [JsonPropertyName("copilotPlan")] + public string? CopilotPlan { get; set; } - /// Recent stdout/stderr lines from the running shell command. - [JsonPropertyName("recentOutput")] - public required string RecentOutput { get; set; } -} + /// Authentication host URL. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("host")] + public string? Host { get; set; } -/// Progress information for the task, or null when no task with that ID is tracked. -[Experimental(Diagnostics.Experimental)] -public sealed class TasksGetProgressResult -{ - /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. - [JsonPropertyName("progress")] - public TasksGetProgressResultProgress? Progress { get; set; } + /// Whether the session has resolved authentication. + [JsonPropertyName("isAuthenticated")] + public bool IsAuthenticated { get; set; } + + /// Authenticated login/username, if available. + [JsonPropertyName("login")] + public string? Login { get; set; } + + /// Human-readable authentication status description. + [JsonPropertyName("statusMessage")] + public string? StatusMessage { get; set; } } -/// Identifier of the background task to fetch progress for. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksGetProgressRequest +internal sealed class SessionGitHubAuthGetStatusRequest { - /// Task identifier (agent ID or shell ID). - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; - /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// The first sync-waiting task that can currently be promoted to background mode. +/// Indicates whether the credential update succeeded. [Experimental(Diagnostics.Experimental)] -public sealed class TasksGetCurrentPromotableResult +public sealed class SessionSetCredentialsResult { - /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. - [JsonPropertyName("task")] - public TaskInfo? Task { get; set; } + /// Whether the session ended up with a populated `copilotUser` for the installed credentials. `true` when the supplied credential already carried `copilotUser` or it was successfully re-resolved server-side. `false` when the credential is installed without `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In both `false` cases the token swap still applied, but plan/quota/billing metadata is degraded. Present whenever a credential was supplied; omitted only when no credential was supplied (no-op call). + [JsonPropertyName("copilotUserResolved")] + public bool? CopilotUserResolved { get; set; } + + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } } -/// Identifies the target session. +/// New auth credentials to install on the session. Omit to leave credentials unchanged. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksGetCurrentPromotableRequest +internal sealed class SessionSetCredentialsParams { + /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime installs the supplied value immediately for outbound model/API requests. When the credential carries a raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous install) so plan/quota/billing metadata regains fidelity; on resolution failure the verbatim credential remains installed. It does NOT otherwise validate the credential. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. + [JsonPropertyName("credentials")] + public AuthInfo? Credentials { get; set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the task was successfully promoted to background mode. +/// A file included in the redacted debug bundle. [Experimental(Diagnostics.Experimental)] -public sealed class TasksPromoteToBackgroundResult +public sealed class DebugCollectLogsCollectedEntry { - /// Whether the task was successfully promoted to background mode. - [JsonPropertyName("promoted")] - public bool Promoted { get; set; } + /// Relative path of the file in the staged bundle/archive. + [JsonPropertyName("bundlePath")] + public string BundlePath { get; set; } = string.Empty; + + /// Redacted output size in bytes. + [JsonPropertyName("sizeBytes")] + public long SizeBytes { get; set; } + + /// Source category for this entry. + [JsonPropertyName("source")] + public DebugCollectLogsSource Source { get; set; } } -/// Identifier of the task to promote to background mode. +/// An optional debug bundle entry that could not be included. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksPromoteToBackgroundRequest +public sealed class DebugCollectLogsSkippedEntry { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// Relative path requested for this bundle entry. + [JsonPropertyName("bundlePath")] + public string BundlePath { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Server-local source path that could not be read. + [JsonPropertyName("path")] + public string? Path { get; set; } + + /// Reason the entry was skipped. + [JsonPropertyName("reason")] + public string Reason { get; set; } = string.Empty; } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// Result of collecting a redacted debug bundle. [Experimental(Diagnostics.Experimental)] -public sealed class TasksPromoteCurrentToBackgroundResult +public sealed class DebugCollectLogsResult { - /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. - [JsonPropertyName("task")] - public TaskInfo? Task { get; set; } + /// Files included in the redacted bundle. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } + + /// Destination kind that was written. + [JsonPropertyName("kind")] + public DebugCollectLogsResultKind Kind { get; set; } + + /// Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Optional files or directories that could not be included. + [JsonPropertyName("skippedEntries")] + public IList? SkippedEntries { get; set; } } -/// Identifies the target session. +/// A caller-provided server-local file or directory to include in the debug bundle. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionTasksPromoteCurrentToBackgroundRequest +public sealed class DebugCollectLogsEntry { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Relative path to use inside the staged bundle/archive. + [JsonPropertyName("bundlePath")] + public string BundlePath { get; set; } = string.Empty; + + /// Kind of source path to include. + [JsonPropertyName("kind")] + public DebugCollectLogsEntryKind Kind { get; set; } + + /// Server-local source path to read. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// How text content from this entry should be redacted. Defaults to plain-text. + [JsonPropertyName("redaction")] + public DebugCollectLogsRedaction? Redaction { get; set; } + + /// When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. + [JsonPropertyName("required")] + public bool? Required { get; set; } } -/// Indicates whether the background task was successfully cancelled. +/// Destination for the redacted debug bundle. +/// Polymorphic base type discriminated by kind. [Experimental(Diagnostics.Experimental)] -public sealed class TasksCancelResult +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(DebugCollectLogsDestinationArchive), "archive")] +[JsonDerivedType(typeof(DebugCollectLogsDestinationDirectory), "directory")] +public partial class DebugCollectLogsDestination { - /// Whether the task was successfully cancelled. - [JsonPropertyName("cancelled")] - public bool Cancelled { get; set; } + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Identifier of the background task to cancel. + +/// The archive variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class TasksCancelRequest +public partial class DebugCollectLogsDestinationArchive : DebugCollectLogsDestination { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "archive"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// When true, create the archive atomically without overwriting an existing file by appending ` (N)` before the extension as needed. Defaults to false. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("noOverwrite")] + public bool? NoOverwrite { get; set; } -/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. -[Experimental(Diagnostics.Experimental)] -public sealed class TasksRemoveResult -{ - /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). - [JsonPropertyName("removed")] - public bool Removed { get; set; } + /// Absolute or server-relative path for the .tgz archive to create. + [JsonPropertyName("outputPath")] + public required string OutputPath { get; set; } } -/// Identifier of the completed or cancelled task to remove from tracking. +/// The directory variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class TasksRemoveRequest +public partial class DebugCollectLogsDestinationDirectory : DebugCollectLogsDestination { - /// Task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Kind => "directory"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Directory where redacted files should be staged. The directory is created if needed. + [JsonPropertyName("outputDirectory")] + public required string OutputDirectory { get; set; } } -/// Indicates whether the message was delivered, with an error message when delivery failed. +/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. [Experimental(Diagnostics.Experimental)] -public sealed class TasksSendMessageResult +public sealed class DebugCollectLogsInclude { - /// Error message if delivery failed. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Server-local path to the current process log. When set, it is included as `process.log` and its directory is searched for prior logs from the same session. + [JsonPropertyName("currentProcessLogPath")] + public string? CurrentProcessLogPath { get; set; } - /// Whether the message was successfully delivered or steered. - [JsonPropertyName("sent")] - public bool Sent { get; set; } + /// Include the session event log (`events.jsonl`). Defaults to true. + [JsonPropertyName("events")] + public bool? Events { get; set; } + + /// Server-local path to the session's events.jsonl file. Internal callers normally omit this and let the runtime derive it from the session. + [JsonPropertyName("eventsPath")] + public string? EventsPath { get; set; } + + /// Maximum number of previous process logs to include. Defaults to 5. + [JsonPropertyName("previousProcessLogLimit")] + public long? PreviousProcessLogLimit { get; set; } + + /// Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions. + [JsonPropertyName("processLogDirectory")] + public string? ProcessLogDirectory { get; set; } + + /// Include process logs for the session. Defaults to true. + [JsonPropertyName("processLogs")] + public bool? ProcessLogs { get; set; } + + /// Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. + [JsonPropertyName("shellLogs")] + public bool? ShellLogs { get; set; } } -/// Identifier of the target agent task, message content, and optional sender agent ID. +/// Options for collecting a redacted session debug bundle. [Experimental(Diagnostics.Experimental)] -internal sealed class TasksSendMessageRequest +internal sealed class DebugCollectLogsRequest { - /// Agent ID of the sender, if sent on behalf of another agent. - [JsonPropertyName("fromAgentId")] - public string? FromAgentId { get; set; } + /// Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape. + [JsonPropertyName("additionalEntries")] + public IList? AdditionalEntries { get; set; } - /// Agent task identifier. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// Where the redacted bundle should be written. Use `archive` to produce a .tgz, or `directory` to stage redacted files for caller-managed upload/post-processing. + [JsonPropertyName("destination")] + public DebugCollectLogsDestination Destination { get => field ??= new(); set; } - /// Message content to send to the agent. - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + /// Which built-in session diagnostics to include. Omitted fields default to true. + [JsonPropertyName("include")] + public DebugCollectLogsInclude? Include { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Schema for the `Skill` type. +/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. [Experimental(Diagnostics.Experimental)] -public sealed class Skill +public sealed class CanvasAction { - /// Description of what the skill does. + /// Description of the action. [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + public string? Description { get; set; } - /// Whether the skill is currently enabled. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// JSON Schema for the action input. + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } - /// Unique identifier for the skill. + /// Action name exposed by the canvas provider. [JsonPropertyName("name")] public string Name { get; set; } = string.Empty; +} - /// Absolute path to the skill file. - [JsonPropertyName("path")] - public string? Path { get; set; } +/// Canvas available in the current session. +[Experimental(Diagnostics.Experimental)] +public sealed class DiscoveredCanvas +{ + /// Actions the agent or host may invoke on an open instance. + [JsonPropertyName("actions")] + public IList? Actions { get; set; } - /// Name of the plugin that provides the skill, when source is 'plugin'. - [JsonPropertyName("pluginName")] - public string? PluginName { get; set; } + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; - /// Source location type (e.g., project, personal-copilot, plugin, builtin). - [JsonPropertyName("source")] - public SkillSource Source { get; set; } + /// Short, single-sentence description shown to the agent in canvas catalogs. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; - /// Whether the skill can be invoked by the user as a slash command. - [JsonPropertyName("userInvocable")] - public bool UserInvocable { get; set; } + /// Human-readable canvas name. + [JsonPropertyName("displayName")] + public string DisplayName { get; set; } = string.Empty; + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; + + /// Owning extension display name, when available. + [JsonPropertyName("extensionName")] + public string? ExtensionName { get; set; } + + /// Host-local PNG path for the canvas icon, when supplied. + [JsonPropertyName("icon")] + public string? Icon { get; set; } + + /// JSON Schema for canvas open input. + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } } -/// Skills available to the session, with their enabled state. +/// Declared canvases available in this session. [Experimental(Diagnostics.Experimental)] -public sealed class SkillList +public sealed class CanvasList { - /// Available skills. - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } + /// Declared canvases available in this session. + [JsonPropertyName("canvases")] + public IList Canvases { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsListRequest +internal sealed class SessionCanvasListRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Schema for the `SkillsInvokedSkill` type. +/// Open canvas instance snapshot. [Experimental(Diagnostics.Experimental)] -public sealed class SkillsInvokedSkill +public sealed class OpenCanvasInstance { - /// Tools that should be auto-approved when this skill is active, captured at invocation time. - [JsonPropertyName("allowedTools")] - public IList? AllowedTools { get; set; } + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; - /// Full content of the skill file. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; - /// Turn number when the skill was invoked. - [JsonPropertyName("invokedAtTurn")] - public long InvokedAtTurn { get; set; } + /// Owning extension display name, when available. + [JsonPropertyName("extensionName")] + public string? ExtensionName { get; set; } - /// Unique identifier for the skill. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Host-local PNG path for the canvas icon, when supplied. + [JsonPropertyName("icon")] + public string? Icon { get; set; } - /// Path to the SKILL.md file. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Input supplied when the instance was opened. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Stable caller-supplied canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; + + /// Provider-supplied status text. + [JsonPropertyName("status")] + public string? Status { get; set; } + + /// Rendered title. + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// URL for web-rendered canvases. + [JsonPropertyName("url")] + public string? Url { get; set; } } -/// Skills invoked during this session, ordered by invocation time (most recent last). +/// Live open-canvas snapshot. [Experimental(Diagnostics.Experimental)] -public sealed class SkillsGetInvokedResult +public sealed class CanvasListOpenResult { - /// Skills invoked during this session, ordered by invocation time (most recent last). - [JsonPropertyName("skills")] - public IList Skills { get => field ??= []; set; } + /// Currently open canvas instances. + [JsonPropertyName("openCanvases")] + public IList OpenCanvases { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsGetInvokedRequest +internal sealed class SessionCanvasListOpenRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Name of the skill to enable for the session. +/// Canvas open parameters. [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsEnableRequest +internal sealed class CanvasOpenRequest { - /// Name of the skill to enable. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; + + /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. + [JsonPropertyName("extensionId")] + public string? ExtensionId { get; set; } + + /// Canvas open input. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Caller-supplied stable instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Name of the skill to disable for the session. +/// Canvas close parameters. [Experimental(Diagnostics.Experimental)] -internal sealed class SkillsDisableRequest +internal sealed class CanvasCloseRequest { - /// Name of the skill to disable. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Open canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// Canvas action invocation result. [Experimental(Diagnostics.Experimental)] -public sealed class SkillsLoadDiagnostics +public sealed class CanvasActionInvokeResult { - /// Errors emitted while loading skills (e.g. skills that failed to load entirely). - [JsonPropertyName("errors")] - public IList Errors { get => field ??= []; set; } - - /// Warnings emitted while loading skills (e.g. skills that loaded but had issues). - [JsonPropertyName("warnings")] - public IList Warnings { get => field ??= []; set; } + /// Provider-supplied action result. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } } -/// Identifies the target session. +/// Canvas action invocation parameters. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsReloadRequest +internal sealed class CanvasActionInvokeRequest { + /// Action name to invoke. + [JsonPropertyName("actionName")] + public string ActionName { get; set; } = string.Empty; + + /// Action input. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Open canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Identifies the target session. +/// Machine-readable factory run failure. +/// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionSkillsEnsureLoadedRequest +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(FactoryRunFailureFactoryLimitReached), "factory_limit_reached")] +[JsonDerivedType(typeof(FactoryRunFailureFactoryResumeDeclined), "factory_resume_declined")] +[JsonDerivedType(typeof(FactoryRunFailureFactoryDurableFailure), "factory_durable_failure")] +[JsonDerivedType(typeof(FactoryRunFailureFactoryAccountingIncomplete), "factory_accounting_incomplete")] +public partial class FactoryRunFailure { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; } -/// Schema for the `McpServer` type. + +/// The factory_limit_reached variant of . [Experimental(Diagnostics.Experimental)] -public sealed class McpServer +public partial class FactoryRunFailureFactoryLimitReached : FactoryRunFailure { - /// Error message if the server failed to connect. + /// + [JsonIgnore] + public override string Type => "factory_limit_reached"; + + /// Resource ceiling that stopped the run. + [JsonPropertyName("kind")] + public required FactoryRunFailureKind Kind { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public required string RunId { get; set; } + + /// Approved effective ceiling that was reached. + [JsonPropertyName("value")] + public required double Value { get; set; } +} + +/// The factory_resume_declined variant of . +[Experimental(Diagnostics.Experimental)] +public partial class FactoryRunFailureFactoryResumeDeclined : FactoryRunFailure +{ + /// + [JsonIgnore] + public override string Type => "factory_resume_declined"; + + /// Human-readable reason the resume did not proceed. + [JsonPropertyName("reason")] + public required string Reason { get; set; } + + /// Factory run identifier whose changed limits were declined. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// The factory_durable_failure variant of . +[Experimental(Diagnostics.Experimental)] +public partial class FactoryRunFailureFactoryDurableFailure : FactoryRunFailure +{ + /// + [JsonIgnore] + public override string Type => "factory_durable_failure"; + + /// Stable failure code. + [JsonPropertyName("code")] + public required string Code { get; set; } + + /// Execution-critical durable operation that failed. + [JsonPropertyName("operation")] + public required FactoryDurableOperation Operation { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// The run stopped because its usage accounting could not be completed. +/// The factory_accounting_incomplete variant of . +[Experimental(Diagnostics.Experimental)] +public partial class FactoryRunFailureFactoryAccountingIncomplete : FactoryRunFailure +{ + /// + [JsonIgnore] + public override string Type => "factory_accounting_incomplete"; + + /// Confirmed usage in nano-AIU, representing the floor of what the run spent. + [JsonPropertyName("drainedNanoAiu")] + public required long DrainedNanoAiu { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// Complete current or terminal factory run envelope. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryRunResult +{ + /// Error message for an errored run. [JsonPropertyName("error")] public string? Error { get; set; } - /// Server name (config key). - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Machine-readable failure details for an errored run. + [JsonPropertyName("failure")] + public FactoryRunFailure? Failure { get; set; } - /// Configuration source: user, workspace, plugin, or builtin. - [JsonPropertyName("source")] - public McpServerSource? Source { get; set; } + /// Reason for a halted or cancelled run. + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Completed factory result. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Partial journal and progress snapshot for a halted, cancelled, or errored run. + [JsonPropertyName("snapshot")] + public JsonElement? Snapshot { get; set; } - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured. + /// Current or terminal factory run status. [JsonPropertyName("status")] - public McpServerStatus Status { get; set; } + public FactoryRunStatus Status { get; set; } } -/// MCP servers configured for the session, with their connection status. +/// Wire-only per-invocation factory resource ceiling overrides. [Experimental(Diagnostics.Experimental)] -public sealed class McpServerList +public sealed class FactoryRunLimits { - /// Configured MCP servers. - [JsonPropertyName("servers")] - public IList Servers { get => field ??= []; set; } + /// Maximum AI credits consumed by factory subagents and their descendants. The post-paid ceiling is soft: parallel turns can settle beyond it before the run stops. + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } + + /// Maximum number of factory subagents that may run concurrently. + [JsonPropertyName("maxConcurrentSubagents")] + public long? MaxConcurrentSubagents { get; set; } + + /// Maximum total number of factory subagents that may be admitted. + [JsonPropertyName("maxTotalSubagents")] + public long? MaxTotalSubagents { get; set; } + + /// Maximum accumulated active-execution time in seconds. Active execution includes the entire extension body, subprocess waits, queued-agent waits, and sleeps; time between resumed attempts is not counted. + [JsonPropertyName("timeoutSeconds")] + public double? TimeoutSeconds { get; set; } } -/// Identifies the target session. +/// Options controlling factory invocation. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpListRequest +public sealed class RunOptions { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Per-invocation resource ceiling overrides. + [JsonPropertyName("limits")] + public FactoryRunLimits? Limits { get; set; } + + /// Run identifier whose journal and progress should seed this resumed run. + [JsonPropertyName("resumeFromRunId")] + public string? ResumeFromRunId { get; set; } } -/// Name of the MCP server to enable for the session. +/// Parameters for invoking a registered factory. [Experimental(Diagnostics.Experimental)] -internal sealed class McpEnableRequest +internal sealed class FactoryRunRequest { - /// Name of the MCP server to enable. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Factory input value. + [JsonPropertyName("args")] + public JsonElement Args { get; set; } + + /// Registered factory name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Factory invocation options. + [JsonPropertyName("options")] + public RunOptions? Options { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Name of the MCP server to disable for the session. +/// Resolved persisted factory identity and resumed run envelope. [Experimental(Diagnostics.Experimental)] -internal sealed class McpDisableRequest +public sealed class FactoryResumeResult { - /// Name of the MCP server to disable. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Persisted factory name resolved for the resumed run. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Terminal resumed run envelope. + [JsonPropertyName("run")] + public FactoryRunResult Run { get => field ??= new(); set; } } -/// Identifies the target session. +/// Parameters for resuming a factory run from its persisted identity. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpReloadRequest +internal sealed class FactoryResumeRequest { + /// Optional per-invocation resource ceiling overrides. + [JsonPropertyName("limits")] + public FactoryRunLimits? Limits { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. +/// Parameters for retrieving a factory run. [Experimental(Diagnostics.Experimental)] -public sealed class McpExecuteSamplingResult +internal sealed class FactoryGetRunRequest { + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// Declared or approved factory resource ceilings. [Experimental(Diagnostics.Experimental)] -public sealed class McpSamplingExecutionResult +public sealed class FactoryDeclaredLimits { - /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. - [JsonPropertyName("action")] - public McpSamplingExecutionAction Action { get; set; } + /// Gets or sets the maxAiCredits value. + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } - /// Error description, present when action='failure'. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Gets or sets the maxConcurrentSubagents value. + [JsonPropertyName("maxConcurrentSubagents")] + public long? MaxConcurrentSubagents { get; set; } - /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. - [JsonPropertyName("result")] - public McpExecuteSamplingResult? Result { get; set; } + /// Gets or sets the maxTotalSubagents value. + [JsonPropertyName("maxTotalSubagents")] + public long? MaxTotalSubagents { get; set; } + + /// Gets or sets the timeoutSeconds value. + [JsonPropertyName("timeoutSeconds")] + public double? TimeoutSeconds { get; set; } } -/// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. +/// Durable factory resource consumption. [Experimental(Diagnostics.Experimental)] -public sealed class McpExecuteSamplingRequest +public sealed class FactoryRunConsumed { + /// Gets or sets the activeMs value. + [JsonPropertyName("activeMs")] + public long ActiveMs { get; set; } + + /// Gets or sets the nanoAiu value. + [JsonPropertyName("nanoAiu")] + public long NanoAiu { get; set; } + + /// Gets or sets the subagents value. + [JsonPropertyName("subagents")] + public long Subagents { get; set; } } -/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. +/// Current factory phase identity. [Experimental(Diagnostics.Experimental)] -internal sealed class McpExecuteSamplingParams +public sealed class FactoryCurrentPhase { - /// The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). - [JsonPropertyName("mcpRequestId")] - public JsonElement McpRequestId { get; set; } + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. - [JsonPropertyName("request")] - public McpExecuteSamplingRequest Request { get => field ??= new(); set; } + /// Gets or sets the ordinal value. + [JsonPropertyName("ordinal")] + public long? Ordinal { get; set; } +} - /// Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; +/// Prompt-safe terminal factory outcome. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryRunTerminal +{ + /// Gets or sets the error value. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Name of the MCP server that initiated the sampling request. - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Gets or sets the failure value. + [JsonPropertyName("failure")] + public FactoryRunFailure? Failure { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Gets or sets the reason value. + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Gets or sets the resultPreview value. + [JsonPropertyName("resultPreview")] + public string? ResultPreview { get; set; } } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// Durable factory run summary with read-time live overlays. [Experimental(Diagnostics.Experimental)] -public sealed class McpCancelSamplingExecutionResult +public sealed class FactoryRunSummary { - /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). - [JsonPropertyName("cancelled")] - public bool Cancelled { get; set; } + /// Gets or sets the activeSegmentStartedAt value. + [JsonPropertyName("activeSegmentStartedAt")] + public long? ActiveSegmentStartedAt { get; set; } + + /// Gets or sets the approved value. + [JsonPropertyName("approved")] + public FactoryDeclaredLimits? Approved { get; set; } + + /// Gets or sets the completedAt value. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Gets or sets the consumed value. + [JsonPropertyName("consumed")] + public FactoryRunConsumed Consumed { get => field ??= new(); set; } + + /// Gets or sets the createdAt value. + [JsonPropertyName("createdAt")] + public long CreatedAt { get; set; } + + /// Gets or sets the currentPhase value. + [JsonPropertyName("currentPhase")] + public FactoryCurrentPhase? CurrentPhase { get; set; } + + /// Gets or sets the declaredLimits value. + [JsonPropertyName("declaredLimits")] + public FactoryDeclaredLimits DeclaredLimits { get => field ??= new(); set; } + + /// Gets or sets the declaredPhaseCount value. + [JsonPropertyName("declaredPhaseCount")] + public long DeclaredPhaseCount { get; set; } + + /// Gets or sets the description value. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Gets or sets the factoryName value. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; + + /// Gets or sets the liveAgentCount value. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } + + /// Gets or sets the observedAt value. + [JsonPropertyName("observedAt")] + public long ObservedAt { get; set; } + + /// Gets or sets the revision value. + [JsonPropertyName("revision")] + public long Revision { get; set; } + + /// Gets or sets the runId value. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Gets or sets the startedAt value. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Gets or sets the status value. + [JsonPropertyName("status")] + public FactoryRunStatus Status { get; set; } + + /// Gets or sets the terminal value. + [JsonPropertyName("terminal")] + public FactoryRunTerminal? Terminal { get; set; } + + /// Gets or sets the totalSpawnedAgentCount value. + [JsonPropertyName("totalSpawnedAgentCount")] + public long TotalSpawnedAgentCount { get; set; } + + /// Gets or sets the updatedAt value. + [JsonPropertyName("updatedAt")] + public long UpdatedAt { get; set; } } -/// The requestId previously passed to executeSampling that should be cancelled. +/// A page of factory runs in durable creation order. [Experimental(Diagnostics.Experimental)] -internal sealed class McpCancelSamplingExecutionParams +public sealed class FactoryListRunsResult { - /// The requestId previously passed to executeSampling that should be cancelled. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Whether terminal runs newer than this page exist. + [JsonPropertyName("hasMoreNewer")] + public bool? HasMoreNewer { get; set; } + + /// Newest terminal-run cursor in this page, or null when the terminal window is empty. + [JsonPropertyName("newestSeq")] + public long? NewestSeq { get; set; } + + /// Oldest terminal-run cursor in this page, or null when the terminal window is empty. + [JsonPropertyName("oldestSeq")] + public long? OldestSeq { get; set; } + + /// Number of terminal runs older than this page. + [JsonPropertyName("omittedOlder")] + public long? OmittedOlder { get; set; } + + /// Gets or sets the runs value. + [JsonPropertyName("runs")] + public IList Runs { get => field ??= []; set; } +} + +/// Parameters for paging factory runs. +[Experimental(Diagnostics.Experimental)] +internal sealed class FactoryListRunsRequest +{ + /// Exclusive forward cursor. + [JsonPropertyName("afterSeq")] + public long? AfterSeq { get; set; } + + /// Exclusive backward cursor. + [JsonPropertyName("beforeSeq")] + public long? BeforeSeq { get; set; } + + /// Maximum terminal runs to return. Defaults to 200 and is capped at 500. + [JsonPropertyName("limit")] + public int? Limit { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Env-value mode recorded on the session after the update. +/// Prompt-safe durable identity and live status for a direct factory agent. [Experimental(Diagnostics.Experimental)] -public sealed class McpSetEnvValueModeResult +public sealed class FactoryAgentSummary { - /// Mode recorded on the session after the update. - [JsonPropertyName("mode")] - public McpSetEnvValueModeDetails Mode { get; set; } + /// Gets or sets the activeMs value. + [JsonPropertyName("activeMs")] + public long ActiveMs { get; set; } + + /// Gets or sets the activity value. + [JsonPropertyName("activity")] + public string? Activity { get; set; } + + /// Gets or sets the agentId value. + [JsonPropertyName("agentId")] + public string AgentId { get; set; } = string.Empty; + + /// Gets or sets the agentType value. + [JsonPropertyName("agentType")] + public string AgentType { get; set; } = string.Empty; + + /// Gets or sets the completedAt value. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Gets or sets the label value. + [JsonPropertyName("label")] + public string Label { get; set; } = string.Empty; + + /// Gets or sets the phaseId value. + [JsonPropertyName("phaseId")] + public string? PhaseId { get; set; } + + /// Gets or sets the requestedModel value. + [JsonPropertyName("requestedModel")] + public string? RequestedModel { get; set; } + + /// Gets or sets the resolvedModel value. + [JsonPropertyName("resolvedModel")] + public string? ResolvedModel { get; set; } + + /// Gets or sets the runId value. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Gets or sets the startedAt value. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Gets or sets the status value. + [JsonPropertyName("status")] + public string Status { get; set; } = string.Empty; + + /// Gets or sets the toolCallId value. + [JsonPropertyName("toolCallId")] + public string ToolCallId { get; set; } = string.Empty; } -/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +/// Durable lifecycle and timing for one factory phase. [Experimental(Diagnostics.Experimental)] -internal sealed class McpSetEnvValueModeParams +public sealed class FactoryPhaseObservation { - /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". - [JsonPropertyName("mode")] - public McpSetEnvValueModeDetails Mode { get; set; } + /// Gets or sets the accumulatedActiveMs value. + [JsonPropertyName("accumulatedActiveMs")] + public long AccumulatedActiveMs { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Gets or sets the completedAt value. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Gets or sets the currentActiveMs value. + [JsonPropertyName("currentActiveMs")] + public long CurrentActiveMs { get; set; } + + /// Gets or sets the detail value. + [JsonPropertyName("detail")] + public string? Detail { get; set; } + + /// Gets or sets the entryCount value. + [JsonPropertyName("entryCount")] + public long EntryCount { get; set; } + + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Gets or sets the lastEnteredRunAttempt value. + [JsonPropertyName("lastEnteredRunAttempt")] + public long LastEnteredRunAttempt { get; set; } + + /// Gets or sets the liveAgentCount value. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } + + /// Gets or sets the ordinal value. + [JsonPropertyName("ordinal")] + public long? Ordinal { get; set; } + + /// Gets or sets the startedAt value. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Gets or sets the status value. + [JsonPropertyName("status")] + public FactoryPhaseStatus Status { get; set; } + + /// Gets or sets the title value. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; + + /// Gets or sets the totalAgentCount value. + [JsonPropertyName("totalAgentCount")] + public long TotalAgentCount { get; set; } } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// One durable factory progress record. [Experimental(Diagnostics.Experimental)] -public sealed class McpRemoveGitHubResult +public sealed class FactoryProgressLine { - /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). - [JsonPropertyName("removed")] - public bool Removed { get; set; } + /// Resume attempt that emitted this record. + [JsonPropertyName("attempt")] + public long Attempt { get; set; } + + /// Progress record kind. + [JsonPropertyName("kind")] + public FactoryLogLineKind Kind { get; set; } + + /// Phase active when the record was emitted, or null before any phase. + [JsonPropertyName("phaseId")] + public string? PhaseId { get; set; } + + /// Epoch milliseconds when the record was persisted. + [JsonPropertyName("recordedAt")] + public long RecordedAt { get; set; } + + /// Global monotonic sequence number within the run. + [JsonPropertyName("seq")] + public long Seq { get; set; } + + /// Prompt-safe progress text. + [JsonPropertyName("text")] + public string Text { get; set; } = string.Empty; } -/// Identifies the target session. +/// A bidirectional page of factory progress. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpRemoveGitHubRequest +public sealed class FactoryProgressPage { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Gets or sets the hasMoreNewer value. + [JsonPropertyName("hasMoreNewer")] + public bool HasMoreNewer { get; set; } + + /// Gets or sets the hasMoreOlder value. + [JsonPropertyName("hasMoreOlder")] + public bool HasMoreOlder { get; set; } + + /// Gets or sets the newestSeq value. + [JsonPropertyName("newestSeq")] + public long? NewestSeq { get; set; } + + /// Gets or sets the oldestSeq value. + [JsonPropertyName("oldestSeq")] + public long? OldestSeq { get; set; } + + /// Gets or sets the records value. + [JsonPropertyName("records")] + public IList Records { get => field ??= []; set; } + + /// Run revision reflected by this page. + [JsonPropertyName("revision")] + public long Revision { get; set; } } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Full factory run observability detail. [Experimental(Diagnostics.Experimental)] -public sealed class McpOauthLoginResult +public sealed class FactoryRunDetail { - /// 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. - [Url] - [StringSyntax(StringSyntaxAttribute.Uri)] - [JsonPropertyName("authorizationUrl")] - public string? AuthorizationUrl { get; set; } + /// Gets or sets the activeSegmentStartedAt value. + [JsonPropertyName("activeSegmentStartedAt")] + public long? ActiveSegmentStartedAt { get; set; } + + /// Gets or sets the agents value. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } + + /// Gets or sets the approved value. + [JsonPropertyName("approved")] + public FactoryDeclaredLimits? Approved { get; set; } + + /// Gets or sets the completedAt value. + [JsonPropertyName("completedAt")] + public long? CompletedAt { get; set; } + + /// Gets or sets the consumed value. + [JsonPropertyName("consumed")] + public FactoryRunConsumed Consumed { get => field ??= new(); set; } + + /// Gets or sets the createdAt value. + [JsonPropertyName("createdAt")] + public long CreatedAt { get; set; } + + /// Gets or sets the currentPhase value. + [JsonPropertyName("currentPhase")] + public FactoryCurrentPhase? CurrentPhase { get; set; } + + /// Gets or sets the declaredLimits value. + [JsonPropertyName("declaredLimits")] + public FactoryDeclaredLimits DeclaredLimits { get => field ??= new(); set; } + + /// Gets or sets the declaredPhaseCount value. + [JsonPropertyName("declaredPhaseCount")] + public long DeclaredPhaseCount { get; set; } + + /// Gets or sets the description value. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Gets or sets the factoryName value. + [JsonPropertyName("factoryName")] + public string FactoryName { get; set; } = string.Empty; + + /// Gets or sets the liveAgentCount value. + [JsonPropertyName("liveAgentCount")] + public long LiveAgentCount { get; set; } + + /// Gets or sets the observedAt value. + [JsonPropertyName("observedAt")] + public long ObservedAt { get; set; } + + /// Gets or sets the phases value. + [JsonPropertyName("phases")] + public IList Phases { get => field ??= []; set; } + + /// Gets or sets the progress value. + [JsonPropertyName("progress")] + public FactoryProgressPage Progress { get => field ??= new(); set; } + + /// Gets or sets the revision value. + [JsonPropertyName("revision")] + public long Revision { get; set; } + + /// Gets or sets the runId value. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Gets or sets the startedAt value. + [JsonPropertyName("startedAt")] + public long? StartedAt { get; set; } + + /// Gets or sets the status value. + [JsonPropertyName("status")] + public FactoryRunStatus Status { get; set; } + + /// Gets or sets the terminal value. + [JsonPropertyName("terminal")] + public FactoryRunTerminal? Terminal { get; set; } + + /// Gets or sets the totalSpawnedAgentCount value. + [JsonPropertyName("totalSpawnedAgentCount")] + public long TotalSpawnedAgentCount { get; set; } + + /// Gets or sets the updatedAt value. + [JsonPropertyName("updatedAt")] + public long UpdatedAt { get; set; } } -/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. +/// Parameters for paging factory progress. [Experimental(Diagnostics.Experimental)] -internal sealed class McpOauthLoginRequest +internal sealed class FactoryGetRunProgressRequest { - /// 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. - [JsonPropertyName("callbackSuccessMessage")] - public string? CallbackSuccessMessage { get; set; } + /// Exclusive forward cursor. + [JsonPropertyName("afterSeq")] + public long? AfterSeq { get; set; } - /// 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. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// Exclusive backward cursor. + [JsonPropertyName("beforeSeq")] + public long? BeforeSeq { get; set; } - /// 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. - [JsonPropertyName("forceReauth")] - public bool? ForceReauth { get; set; } + /// Maximum records to return. Defaults to 200 and is capped at 500. + [JsonPropertyName("limit")] + public int? Limit { get; set; } - /// Name of the remote MCP server to authenticate. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Optional phase identifier used to scope records and cursors. + [JsonPropertyName("phaseId")] + public string? PhaseId { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Schema for the `McpAppsResourceContent` type. +/// Parameters for cancelling a factory run. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsResourceContent +internal sealed class FactoryCancelRequest { - /// Resource-level metadata (CSP, permissions, etc.). - [JsonPropertyName("_meta")] - public IDictionary? _meta { get; set; } - - /// Base64-encoded binary content. - [JsonPropertyName("blob")] - public string? Blob { get; set; } - - /// MIME type of the content. - [JsonPropertyName("mimeType")] - public string? MimeType { get; set; } + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; - /// Text content (e.g. HTML). - [JsonPropertyName("text")] - public string? Text { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// The resource URI (typically ui://...). - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; +/// Acknowledgement that a factory request was accepted. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryAckResult +{ } -/// Resource contents returned by the MCP server. +/// One ordered factory progress line. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsReadResourceResult +public sealed class FactoryLogLine { - /// Resource contents returned by the server. - [JsonPropertyName("contents")] - public IList Contents { get => field ??= []; set; } + /// Progress line kind. + [JsonPropertyName("kind")] + public FactoryLogLineKind Kind { get; set; } + + /// Monotonic sequence number within the factory run. + [JsonPropertyName("seq")] + public long Seq { get; set; } + + /// Progress text. + [JsonPropertyName("text")] + public string Text { get; set; } = string.Empty; } -/// MCP server and resource URI to fetch. +/// Parameters for recording factory progress. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsReadResourceRequest +internal sealed class FactoryLogRequest { - /// Name of the MCP server hosting the resource. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; + + /// Ordered progress lines to append. + [JsonPropertyName("lines")] + public IList Lines { get => field ??= []; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// Resource URI (typically ui://...). - [JsonPropertyName("uri")] - public string Uri { get; set; } = string.Empty; } -/// App-callable tools from the named MCP server. +/// Result of one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsListToolsResult +public sealed class FactoryAgentResult { - /// App-callable tools from the server. - [JsonPropertyName("tools")] - public IList> Tools { get => field ??= []; set; } + /// Agent result, omitted when the agent produced no result. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } } -/// MCP server to list app-callable tools for. +/// Options for one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsListToolsRequest +public sealed class FactoryAgentOptions { - /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("originServerName")] - public string OriginServerName { get; set; } = string.Empty; + /// Optional custom agent name for the subagent. This field is accepted but not yet honored. + [JsonPropertyName("agent")] + public string? Agent { get; set; } - /// MCP server hosting the app. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Optional context tier for the subagent. This field is accepted but not yet honored. + [JsonPropertyName("contextTier")] + public ContextTier? ContextTier { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Optional label distinguishing otherwise identical memoized agent calls. + [JsonPropertyName("label")] + public string? Label { get; set; } + + /// Optional model identifier for the subagent. + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Optional reasoning effort for the subagent. This field is accepted but not yet honored. + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } + + /// Optional JSON Schema for structured agent output. + [JsonPropertyName("schema")] + public JsonElement? Schema { get; set; } } -/// MCP server, tool name, and arguments to invoke from an MCP App view. +/// Parameters for one factory-scoped subagent call. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsCallToolRequest +internal sealed class FactoryAgentRequest { - /// Tool arguments. - [JsonPropertyName("arguments")] - public IDictionary? Arguments { get; set; } + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; - /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("originServerName")] - public string OriginServerName { get; set; } = string.Empty; + /// Factory run identifier that owns the subagent. + [JsonPropertyName("factoryRunId")] + public string FactoryRunId { get; set; } = string.Empty; - /// MCP server hosting the tool. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Subagent execution options. + [JsonPropertyName("opts")] + public FactoryAgentOptions Opts { get => field ??= new(); set; } + + /// Prompt to send to the subagent. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// MCP tool name. - [JsonPropertyName("toolName")] - public string ToolName { get; set; } = string.Empty; } -/// Host context advertised to MCP App guests. +/// Result of reading a factory journal entry. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsSetHostContextDetails +public sealed class FactoryJournalGetResult { - /// Display modes the host supports. - [JsonPropertyName("availableDisplayModes")] - public IList? AvailableDisplayModes { get; set; } - - /// Current display mode (SEP-1865). - [JsonPropertyName("displayMode")] - public McpAppsSetHostContextDetailsDisplayMode? DisplayMode { get; set; } - - /// BCP-47 locale, e.g. 'en-US'. - [JsonPropertyName("locale")] - public string? Locale { get; set; } - - /// Platform type for responsive design. - [JsonPropertyName("platform")] - public McpAppsSetHostContextDetailsPlatform? Platform { get; set; } - - /// UI theme preference per SEP-1865. - [JsonPropertyName("theme")] - public McpAppsSetHostContextDetailsTheme? Theme { get; set; } - - /// IANA timezone, e.g. 'America/New_York'. - [JsonPropertyName("timeZone")] - public string? TimeZone { get; set; } + /// Whether the journal contained the requested key. + [JsonPropertyName("hit")] + public bool Hit { get; set; } - /// Host application identifier. - [JsonPropertyName("userAgent")] - public string? UserAgent { get; set; } + /// Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + [JsonPropertyName("resultJson")] + public JsonElement? ResultJson { get; set; } } -/// Host context to advertise to MCP App guests. +/// Parameters for reading a factory journal entry. [Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsSetHostContextRequest +internal sealed class FactoryJournalGetRequest { - /// Host context advertised to MCP App guests. - [JsonPropertyName("context")] - public McpAppsSetHostContextDetails Context { get => field ??= new(); set; } + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; + + /// Namespaced journal key. + [JsonPropertyName("key")] + public string Key { get; set; } = string.Empty; + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Current host context. +/// Parameters for storing a factory journal entry. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsHostContextDetails +internal sealed class FactoryJournalPutRequest { - /// Display modes the host supports. - [JsonPropertyName("availableDisplayModes")] - public IList? AvailableDisplayModes { get; set; } - - /// Current display mode (SEP-1865). - [JsonPropertyName("displayMode")] - public McpAppsHostContextDetailsDisplayMode? DisplayMode { get; set; } - - /// BCP-47 locale, e.g. 'en-US'. - [JsonPropertyName("locale")] - public string? Locale { get; set; } + /// Opaque token identifying the current factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; - /// Platform type for responsive design. - [JsonPropertyName("platform")] - public McpAppsHostContextDetailsPlatform? Platform { get; set; } + /// Namespaced journal key. + [JsonPropertyName("key")] + public string Key { get; set; } = string.Empty; - /// UI theme preference per SEP-1865. - [JsonPropertyName("theme")] - public McpAppsHostContextDetailsTheme? Theme { get; set; } + /// JSON result to memoize. + [JsonPropertyName("resultJson")] + public JsonElement ResultJson { get; set; } - /// IANA timezone, e.g. 'America/New_York'. - [JsonPropertyName("timeZone")] - public string? TimeZone { get; set; } + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; - /// Host application identifier. - [JsonPropertyName("userAgent")] - public string? UserAgent { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Current host context advertised to MCP App guests. +/// The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsHostContext +public sealed class CurrentModel { - /// Current host context. - [JsonPropertyName("context")] - public McpAppsHostContextDetails Context { get => field ??= new(); set; } + /// Context tier for models that support multiple context-window sizes. + [JsonPropertyName("contextTier")] + public ContextTier? ContextTier { get; set; } + + /// Currently active model identifier. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionMcpAppsGetHostContextRequest +internal sealed class SessionModelGetCurrentRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Capability negotiation snapshot. +/// The model identifier active on the session after the switch. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseCapability +public sealed class ModelSwitchToResult { - /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers. - [JsonPropertyName("advertised")] - public bool Advertised { get; set; } - - /// Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on. - [JsonPropertyName("featureFlagEnabled")] - public bool FeatureFlagEnabled { get; set; } + /// True when the switch was deferred (enqueued as a cancellable `/model` command) because a turn was active or another model change was already queued, rather than applied immediately. When true, the session's live model is unchanged until the queued change drains. + [JsonPropertyName("deferred")] + public bool? Deferred { get; set; } - /// Whether the session has the `mcp-apps` capability. - [JsonPropertyName("sessionHasMcpApps")] - public bool SessionHasMcpApps { get; set; } + /// Currently active model identifier after the switch. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } } -/// What the server returned for this session. +/// Vision-specific limits. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseServer +public sealed class ModelCapabilitiesOverrideLimitsVision { - /// Whether the named server is currently connected. - [JsonPropertyName("connected")] - public bool Connected { get; set; } - - /// Up to 5 tool names with `_meta.ui` for quick inspection. - [JsonPropertyName("sampleToolNames")] - public IList SampleToolNames { get => field ??= []; set; } + /// Maximum image size in bytes. + [JsonPropertyName("max_prompt_image_size")] + public long? MaxPromptImageSize { get; set; } - /// Total tools returned by the server's tools/list. - [JsonPropertyName("toolCount")] - public double ToolCount { get; set; } + /// Maximum number of images per prompt. + [JsonPropertyName("max_prompt_images")] + public long? MaxPromptImages { get; set; } - /// Tools whose `_meta.ui` is populated (resourceUri and/or visibility set). - [JsonPropertyName("toolsWithUiMeta")] - public double ToolsWithUiMeta { get; set; } + /// MIME types the model accepts. + [JsonPropertyName("supported_media_types")] + public IList? SupportedMediaTypes { get; set; } } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// Token limits for prompts, outputs, and context window. [Experimental(Diagnostics.Experimental)] -public sealed class McpAppsDiagnoseResult +public sealed class ModelCapabilitiesOverrideLimits { - /// Capability negotiation snapshot. - [JsonPropertyName("capability")] - public McpAppsDiagnoseCapability Capability { get => field ??= new(); set; } + /// Maximum total context window size in tokens. + [JsonPropertyName("max_context_window_tokens")] + public long? MaxContextWindowTokens { get; set; } - /// What the server returned for this session. - [JsonPropertyName("server")] - public McpAppsDiagnoseServer Server { get => field ??= new(); set; } -} + /// Maximum number of output/completion tokens. + [JsonPropertyName("max_output_tokens")] + public long? MaxOutputTokens { get; set; } -/// MCP server to diagnose MCP Apps wiring for. -[Experimental(Diagnostics.Experimental)] -internal sealed class McpAppsDiagnoseRequest -{ - /// MCP server to probe. - [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("serverName")] - public string ServerName { get; set; } = string.Empty; + /// Maximum number of prompt/input tokens. + [JsonPropertyName("max_prompt_tokens")] + public long? MaxPromptTokens { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Vision-specific limits. + [JsonPropertyName("vision")] + public ModelCapabilitiesOverrideLimitsVision? Vision { get; set; } } -/// Schema for the `Plugin` type. +/// Feature flags indicating what the model supports. [Experimental(Diagnostics.Experimental)] -public sealed class Plugin +public sealed class ModelCapabilitiesOverrideSupports { - /// Whether the plugin is currently enabled. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } - - /// Marketplace the plugin came from. - [JsonPropertyName("marketplace")] - public string Marketplace { get; set; } = string.Empty; + /// Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + [JsonPropertyName("adaptive_thinking")] + public AdaptiveThinkingSupport? AdaptiveThinking { get; set; } - /// Plugin name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Whether this model supports reasoning effort configuration. + [JsonPropertyName("reasoningEffort")] + public bool? ReasoningEffort { get; set; } - /// Installed version. - [JsonPropertyName("version")] - public string? Version { get; set; } + /// Whether this model supports vision/image input. + [JsonPropertyName("vision")] + public bool? Vision { get; set; } } -/// Plugins installed for the session, with their enabled state and version metadata. +/// Optional capability overrides (vision, tool_calls, reasoning, etc.). [Experimental(Diagnostics.Experimental)] -public sealed class PluginList +public sealed class ModelCapabilitiesOverride { - /// Installed plugins. - [JsonPropertyName("plugins")] - public IList Plugins { get => field ??= []; set; } -} + /// Token limits for prompts, outputs, and context window. + [JsonPropertyName("limits")] + public ModelCapabilitiesOverrideLimits? Limits { get; set; } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionPluginsListRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Feature flags indicating what the model supports. + [JsonPropertyName("supports")] + public ModelCapabilitiesOverrideSupports? Supports { get; set; } } -/// Indicates whether the session options patch was applied successfully. +/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. [Experimental(Diagnostics.Experimental)] -public sealed class SessionUpdateOptionsResult +internal sealed class ModelSwitchToRequest { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Explicit context tier for the selected model. `"default"` / `"long_context"` apply the requested tier; omit this field to use normal model behavior with no explicit tier. + [JsonPropertyName("contextTier")] + public ContextTier? ContextTier { get; set; } -/// Schema for the `SessionInstalledPlugin` type. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionInstalledPlugin -{ - /// Path where the plugin is cached locally. - [JsonPropertyName("cache_path")] - public string? CachePath { get; set; } + /// When true, defer this switch (enqueue it) if another model change is already queued, even when no turn is active — so it drains last (FIFO) and wins over the already-queued change. Intended for genuine user-initiated model selections; internal restore/reapply switches omit it and apply immediately when no turn is active. When no other model change is queued this has no effect (a switch still applies immediately unless a turn is active). + [JsonPropertyName("deferIfModelChangeQueued")] + public bool? DeferIfModelChangeQueued { get; set; } - /// Whether the plugin is currently enabled. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Override individual model capabilities resolved by the runtime. + [JsonPropertyName("modelCapabilities")] + public ModelCapabilitiesOverride? ModelCapabilities { get; set; } - /// Installation timestamp (ISO-8601). - [JsonPropertyName("installed_at")] - public string InstalledAt { get; set; } = string.Empty; + /// Model selection id to switch to, as returned by `list`. A bare id (e.g. `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. + [JsonPropertyName("modelId")] + public string ModelId { get; set; } = string.Empty; - /// Marketplace the plugin came from (empty string for direct repo installs). - [JsonPropertyName("marketplace")] - public string Marketplace { get; set; } = string.Empty; + /// Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted, no effort override is applied. + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } - /// Plugin name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Reasoning summary mode to request for supported model clients. + [JsonPropertyName("reasoningSummary")] + public ReasoningSummary? ReasoningSummary { get; set; } - /// Source descriptor for direct repo installs (when marketplace is empty). - [JsonPropertyName("source")] - public JsonElement? Source { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Installed version, if known. - [JsonPropertyName("version")] - public string? Version { get; set; } + /// Output verbosity level to request for supported models. + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } } -/// Patch of mutable session options to apply to the running session. +/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionUpdateOptionsParams +public sealed class ModelSetReasoningEffortResult { - /// Additional content-exclusion policies to merge into the session's policy set. Opaque shape; see `ContentExclusionApiResponse` in the runtime. - [Experimental(Diagnostics.Experimental)] - [JsonPropertyName("additionalContentExclusionPolicies")] - public IList? AdditionalContentExclusionPolicies { get; set; } + /// Reasoning effort level recorded on the session after the update. + [JsonPropertyName("reasoningEffort")] + public string ReasoningEffort { get; set; } = string.Empty; +} - /// Runtime context discriminator (e.g., `cli`, `actions`). - [JsonPropertyName("agentContext")] - public string? AgentContext { get; set; } +/// Reasoning effort level to apply to the currently selected model. +[Experimental(Diagnostics.Experimental)] +internal sealed class ModelSetReasoningEffortRequest +{ + /// Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. + [JsonPropertyName("reasoningEffort")] + public string ReasoningEffort { get; set; } = string.Empty; - /// Whether to disable the `ask_user` tool (encourages autonomous behavior). - [JsonPropertyName("askUserDisabled")] - public bool? AskUserDisabled { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Allowlist of tool names available to this session. - [JsonPropertyName("availableTools")] - public IList? AvailableTools { get; set; } +/// Cost-category metadata for a CAPI model. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionModelPriceCategory +{ + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Identifier of the client driving the session. - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// Gets or sets the priceCategory value. + [JsonPropertyName("priceCategory")] + public ModelPickerPriceCategory PriceCategory { get; set; } +} - /// Whether to include the `Co-authored-by` trailer in commit messages. - [JsonPropertyName("coauthorEnabled")] - public bool? CoauthorEnabled { get; set; } +/// The list of models available to this session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionModelList +{ + /// Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`). + [JsonPropertyName("list")] + public IList List { get => field ??= []; set; } - /// Whether to allow auto-mode continuation across turns. - [JsonPropertyName("continueOnAutoMode")] - public bool? ContinueOnAutoMode { get; set; } + /// Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable. + [JsonPropertyName("modelPriceCategories")] + public IList? ModelPriceCategories { get; set; } - /// Override URL for the Copilot API endpoint. - [JsonPropertyName("copilotUrl")] - public string? CopilotUrl { get; set; } + /// Per-quota snapshots returned alongside the model list, keyed by quota type. + [JsonPropertyName("quotaSnapshots")] + public IDictionary? QuotaSnapshots { get; set; } +} - /// Whether to default custom agents to local-only execution. - [JsonPropertyName("customAgentsLocalOnly")] - public bool? CustomAgentsLocalOnly { get; set; } +/// RPC data type for SessionModelList operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionModelListRequest +{ + /// If true, bypasses the per-session model list cache and re-fetches from CAPI. + [JsonPropertyName("skipCache")] + public bool? SkipCache { get; set; } +} - /// Instruction source IDs to exclude from the system prompt. - [JsonPropertyName("disabledInstructionSources")] - public IList? DisabledInstructionSources { get; set; } +/// RPC data type for SessionModelListRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionModelListRequestWithSession +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Skill IDs that should be excluded from this session. - [JsonPropertyName("disabledSkills")] - public IList? DisabledSkills { get; set; } + /// If true, bypasses the per-session model list cache and re-fetches from CAPI. + [JsonPropertyName("skipCache")] + public bool? SkipCache { get; set; } +} - /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. - [JsonPropertyName("enableFileHooks")] - public bool? EnableFileHooks { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionModeGetRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). - [JsonPropertyName("enableHostGitOperations")] - public bool? EnableHostGitOperations { get; set; } +/// Agent interaction mode to apply to the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class ModeSetRequest +{ + /// The session mode the agent is operating in. + [JsonPropertyName("mode")] + public SessionMode Mode { get; set; } - /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. - [JsonPropertyName("enableOnDemandInstructionDiscovery")] - public bool? EnableOnDemandInstructionDiscovery { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to surface reasoning-summary events from the model. - [JsonPropertyName("enableReasoningSummaries")] - public bool? EnableReasoningSummaries { get; set; } +/// The session's friendly name, or null when not yet set. +[Experimental(Diagnostics.Experimental)] +public sealed class NameGetResult +{ + /// The session name (user-set or auto-generated), or null if not yet set. + [JsonPropertyName("name")] + public string? Name { get; set; } +} - /// Whether shell-script safety heuristics are enabled. - [JsonPropertyName("enableScriptSafety")] - public bool? EnableScriptSafety { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionNameGetRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to enable cross-session store writes and reads. - [JsonPropertyName("enableSessionStore")] - public bool? EnableSessionStore { get; set; } +/// New friendly name to apply to the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class NameSetRequest +{ + /// New session name (1–100 characters, trimmed of leading/trailing whitespace). + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [MaxLength(100)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. - [JsonPropertyName("enableSkills")] - public bool? EnableSkills { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to stream model responses. - [JsonPropertyName("enableStreaming")] - public bool? EnableStreaming { get; set; } +/// Indicates whether the auto-generated summary was applied as the session's name. +[Experimental(Diagnostics.Experimental)] +public sealed class NameSetAutoResult +{ + /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. + [JsonPropertyName("applied")] + public bool Applied { get; set; } +} - /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). - [JsonPropertyName("envValueMode")] - public OptionsUpdateEnvValueMode? EnvValueMode { get; set; } +/// Auto-generated session summary to apply as the session's name when no user-set name exists. +[Experimental(Diagnostics.Experimental)] +internal sealed class NameSetAutoRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Override directory for the session-events log. When unset, the runtime's default events log directory is used. - [JsonPropertyName("eventsLogDirectory")] - public string? EventsLogDirectory { get; set; } + /// Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. + [JsonPropertyName("summary")] + public string Summary { get; set; } = string.Empty; +} - /// Denylist of tool names for this session. - [JsonPropertyName("excludedTools")] - public IList? ExcludedTools { get; set; } +/// Existence, contents, and resolved path of the session plan file. +[Experimental(Diagnostics.Experimental)] +public sealed class PlanReadResult +{ + /// The content of the plan file, or null if it does not exist. + [JsonPropertyName("content")] + public string? Content { get; set; } - /// Map of feature-flag IDs to their boolean enabled state. - [JsonPropertyName("featureFlags")] - public IDictionary? FeatureFlags { get; set; } + /// Whether the plan file exists in the workspace. + [JsonPropertyName("exists")] + public bool Exists { get; set; } - /// Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. - [JsonPropertyName("installedPlugins")] - public IList? InstalledPlugins { get; set; } + /// Absolute file path of the plan file, or null if workspace is not enabled. + [JsonPropertyName("path")] + public string? Path { get; set; } +} - /// Stable integration identifier used for analytics and rate-limit attribution. - [JsonPropertyName("integrationId")] - public string? IntegrationId { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionPlanReadRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether experimental capabilities are enabled. - [JsonPropertyName("isExperimentalMode")] - public bool? IsExperimentalMode { get; set; } - - /// Whether interactive shell sessions are logged. - [JsonPropertyName("logInteractiveShells")] - public bool? LogInteractiveShells { get; set; } - - /// Identifier sent to LSP-style integrations. - [JsonPropertyName("lspClientName")] - public string? LspClientName { get; set; } - - /// Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). - [JsonPropertyName("manageScheduleEnabled")] - public bool? ManageScheduleEnabled { get; set; } - - /// The model ID to use for assistant turns. - [JsonPropertyName("model")] - public string? Model { get; set; } - - /// Organization-level custom instructions to inject into the system prompt. - [JsonPropertyName("organizationCustomInstructions")] - public string? OrganizationCustomInstructions { get; set; } - - /// Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the runtime. - [Experimental(Diagnostics.Experimental)] - [JsonPropertyName("provider")] - public JsonElement? Provider { get; set; } - - /// Reasoning effort for the selected model (model-defined enum). - [JsonPropertyName("reasoningEffort")] - public string? ReasoningEffort { get; set; } - - /// Whether the session is running in an interactive UI. - [JsonPropertyName("runningInInteractiveMode")] - public bool? RunningInInteractiveMode { get; set; } - - /// Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. - [Experimental(Diagnostics.Experimental)] - [JsonPropertyName("sandboxConfig")] - public JsonElement? SandboxConfig { get; set; } +/// Replacement contents to write to the session plan file. +[Experimental(Diagnostics.Experimental)] +internal sealed class PlanUpdateRequest +{ + /// The new content for the plan file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; +} - /// Shell init profile (`None` or `NonInteractive`). - [JsonPropertyName("shellInitProfile")] - public string? ShellInitProfile { get; set; } - - /// Per-shell process flags (e.g., `pwsh` arguments). - [JsonPropertyName("shellProcessFlags")] - public IList? ShellProcessFlags { get; set; } - - /// Additional directories to search for skills. - [JsonPropertyName("skillDirectories")] - public IList? SkillDirectories { get; set; } - - /// Whether to skip loading custom instruction sources. - [JsonPropertyName("skipCustomInstructions")] - public bool? SkipCustomInstructions { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionPlanDeleteRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether to skip embedding retrieval pipeline initialization and execution. - [JsonPropertyName("skipEmbeddingRetrieval")] - public bool? SkipEmbeddingRetrieval { get; set; } +/// A single todo row read from the session SQL `todos` table. All fields are optional because the SQL schema is best-effort and the agent may not have populated every column. +[Experimental(Diagnostics.Experimental)] +public sealed class PlanSqlTodosRow +{ + /// Todo description. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. - [JsonPropertyName("toolFilterPrecedence")] - public OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence { get; set; } + /// Todo identifier. + [JsonPropertyName("id")] + public string? Id { get; set; } - /// Optional path for trajectory output. - [JsonPropertyName("trajectoryFile")] - public string? TrajectoryFile { get; set; } + /// Todo status. + [JsonPropertyName("status")] + public string? Status { get; set; } - /// Absolute working-directory path for shell tools. - [JsonPropertyName("workingDirectory")] - public string? WorkingDirectory { get; set; } + /// Todo title. + [JsonPropertyName("title")] + public string? Title { get; set; } } -/// Parameters for (re)loading the merged LSP configuration set. +/// Todo rows read from the session SQL database. Empty when no session database is available. [Experimental(Diagnostics.Experimental)] -internal sealed class LspInitializeRequest +public sealed class PlanReadSqlTodosResult { - /// Force re-initialization even when LSP configs were already loaded for the working directory. - [JsonPropertyName("force")] - public bool? Force { get; set; } - - /// Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Rows from the session SQL todos table, ordered by creation time and id. + [JsonPropertyName("rows")] + public IList Rows { get => field ??= []; set; } +} +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionPlanReadSqlTodosRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. - [JsonPropertyName("workingDirectory")] - public string? WorkingDirectory { get; set; } } -/// Schema for the `Extension` type. +/// A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. [Experimental(Diagnostics.Experimental)] -public sealed class Extension +public sealed class PlanSqlTodoDependency { - /// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper'). - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; - - /// Extension name (directory name). - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - /// Process ID if the extension is running. - [JsonPropertyName("pid")] - public long? Pid { get; set; } - - /// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/). - [JsonPropertyName("source")] - public ExtensionSource Source { get; set; } + /// ID of the todo it depends on. + [JsonPropertyName("dependsOn")] + public string DependsOn { get; set; } = string.Empty; - /// Current status: running, disabled, failed, or starting. - [JsonPropertyName("status")] - public ExtensionStatus Status { get; set; } + /// ID of the todo that has the dependency. + [JsonPropertyName("todoId")] + public string TodoId { get; set; } = string.Empty; } -/// Extensions discovered for the session, with their current status. +/// Todo rows + dependency edges read from the session SQL database. [Experimental(Diagnostics.Experimental)] -public sealed class ExtensionList +public sealed class PlanReadSqlTodosWithDependenciesResult { - /// Discovered extensions and their current status. - [JsonPropertyName("extensions")] - public IList Extensions { get => field ??= []; set; } + /// Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does not affect the rows result and vice versa. + [JsonPropertyName("dependencies")] + public IList Dependencies { get => field ??= []; set; } + + /// Rows from the session SQL todos table, ordered by creation time and id. Empty when no database, no todos table, or the SELECT failed. + [JsonPropertyName("rows")] + public IList Rows { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionExtensionsListRequest +internal sealed class SessionPlanReadSqlTodosWithDependenciesRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Source-qualified extension identifier to enable for the session. -[Experimental(Diagnostics.Experimental)] -internal sealed class ExtensionsEnableRequest +/// RPC data type for WorkspacesGetWorkspaceResultWorkspace operations. +public sealed class WorkspacesGetWorkspaceResultWorkspace { - /// Source-qualified extension ID to enable. + /// Gets or sets the branch value. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// Gets or sets the chronicle_sync_dismissed value. + [JsonPropertyName("chronicle_sync_dismissed")] + public bool? ChronicleSyncDismissed { get; set; } + + /// Gets or sets the client_name value. + [JsonPropertyName("client_name")] + public string? ClientName { get; set; } + + /// Gets or sets the created_at value. + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + + /// Gets or sets the cwd value. + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } + + /// Gets or sets the git_root value. + [JsonPropertyName("git_root")] + public string? GitRoot { get; set; } + + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + [JsonPropertyName("host_type")] + public WorkspacesWorkspaceDetailsHostType? HostType { get; set; } + + /// Gets or sets the id value. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] [JsonPropertyName("id")] public string Id { get; set; } = string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Gets or sets the mc_last_event_id value. + [JsonPropertyName("mc_last_event_id")] + public string? McLastEventId { get; set; } + + /// Gets or sets the mc_session_id value. + [JsonPropertyName("mc_session_id")] + public string? McSessionId { get; set; } + + /// Gets or sets the mc_task_id value. + [JsonPropertyName("mc_task_id")] + public string? McTaskId { get; set; } + + /// Gets or sets the name value. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Gets or sets the remote_steerable value. + [JsonPropertyName("remote_steerable")] + public bool? RemoteSteerable { get; set; } + + /// Gets or sets the repository value. + [JsonPropertyName("repository")] + public string? Repository { get; set; } + + /// Gets or sets the summary_count value. + [JsonPropertyName("summary_count")] + public long? SummaryCount { get; set; } + + /// Gets or sets the updated_at value. + [JsonPropertyName("updated_at")] + public DateTimeOffset? UpdatedAt { get; set; } + + /// Gets or sets the user_named value. + [JsonPropertyName("user_named")] + public bool? UserNamed { get; set; } } -/// Source-qualified extension identifier to disable for the session. +/// Current workspace metadata for the session, including its absolute filesystem path when available. [Experimental(Diagnostics.Experimental)] -internal sealed class ExtensionsDisableRequest +public sealed class WorkspacesGetWorkspaceResult { - /// Source-qualified extension ID to disable. - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + [JsonPropertyName("path")] + public string? Path { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Current workspace metadata, or null if not available. + [JsonPropertyName("workspace")] + public WorkspacesGetWorkspaceResultWorkspace? Workspace { get; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionExtensionsReloadRequest +internal sealed class SessionWorkspacesGetWorkspaceRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the external tool call result was handled successfully. +/// Workspace metadata fields to update. [Experimental(Diagnostics.Experimental)] -public sealed class HandlePendingToolCallResult +internal sealed class WorkspacesUpdateMetadataRequest { - /// Whether the tool call result was handled successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Opaque workspace context supplied by the session host. + [JsonPropertyName("context")] + public JsonElement? Context { get; set; } + + /// Optional workspace display name override. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Pending external tool call request ID, with the tool result or an error describing why it failed. +/// Optional session context used when creating a local workspace. [Experimental(Diagnostics.Experimental)] -internal sealed class HandlePendingToolCallRequest +internal sealed class WorkspacesEnsureRequest { - /// Error message if the tool call failed. - [JsonPropertyName("error")] - public string? Error { get; set; } - - /// Request ID of the pending tool call. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - - /// Tool call result (string or expanded result object). - [JsonPropertyName("result")] - public JsonElement? Result { get; set; } + /// Opaque workspace context supplied by the session host. + [JsonPropertyName("context")] + public JsonElement? Context { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +/// Relative paths of files stored in the session workspace files directory. [Experimental(Diagnostics.Experimental)] -public sealed class ToolsInitializeAndValidateResult +public sealed class WorkspacesListFilesResult { + /// Relative file paths in the workspace files directory. + [JsonPropertyName("files")] + public IList Files { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionToolsInitializeAndValidateRequest +internal sealed class SessionWorkspacesListFilesRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Lightweight metadata for a currently initialized session tool. +/// Contents of the requested workspace file as a UTF-8 string. [Experimental(Diagnostics.Experimental)] -public sealed class CurrentToolMetadata +public sealed class WorkspacesReadFileResult { - /// Whether the tool is loaded on demand via tool search. - [JsonPropertyName("deferLoading")] - public bool? DeferLoading { get; set; } + /// File content as a UTF-8 string. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; +} - /// Tool description. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; +/// Relative path of the workspace file to read. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesReadFileRequest +{ + /// Relative path within the workspace files directory. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// JSON Schema for tool input. - [JsonPropertyName("input_schema")] - public IDictionary? InputSchema { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// MCP server name for MCP-backed tools. - [JsonPropertyName("mcpServerName")] - public string? McpServerName { get; set; } +/// Relative path and UTF-8 content for the workspace file to create or overwrite. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesCreateFileRequest +{ + /// File content to write as a UTF-8 string. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Raw MCP tool name for MCP-backed tools. - [JsonPropertyName("mcpToolName")] - public string? McpToolName { get; set; } + /// Relative path within the workspace files directory. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; - /// Model-facing tool name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Optional MCP/config namespaced tool name. - [JsonPropertyName("namespacedName")] - public string? NamespacedName { get; set; } +/// Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. +[Experimental(Diagnostics.Experimental)] +public sealed class WorkspacesCheckpoints +{ + /// Filename of the checkpoint within the workspace checkpoints directory. + [JsonPropertyName("filename")] + public string Filename { get; set; } = string.Empty; + + /// Checkpoint number assigned by the workspace manager. + [JsonPropertyName("number")] + public long Number { get; set; } + + /// Human-readable checkpoint title. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; } -/// Current lightweight tool metadata snapshot for the session. +/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. [Experimental(Diagnostics.Experimental)] -public sealed class ToolsGetCurrentMetadataResult +public sealed class WorkspacesListCheckpointsResult { - /// Current tool metadata, or null when tools have not been initialized yet. - [JsonPropertyName("tools")] - public IList? Tools { get; set; } + /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. + [JsonPropertyName("checkpoints")] + public IList Checkpoints { get => field ??= []; set; } } /// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionToolsGetCurrentMetadataRequest +internal sealed class SessionWorkspacesListCheckpointsRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Optional unstructured input hint. +/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandInput +public sealed class WorkspacesReadCheckpointResult { - /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). - [JsonPropertyName("completion")] - public SlashCommandInputCompletion? Completion { get; set; } + /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. + [JsonPropertyName("content")] + public string? Content { get; set; } +} - /// Hint to display when command input has not been provided. - [JsonPropertyName("hint")] - public string Hint { get; set; } = string.Empty; +/// Checkpoint number to read. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesReadCheckpointRequest +{ + /// Checkpoint number to read. + [JsonPropertyName("number")] + public long Number { get; set; } - /// When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace. - [JsonPropertyName("preserveMultilineInput")] - public bool? PreserveMultilineInput { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// When true, the command requires non-empty input; clients should render the input hint as required. - [JsonPropertyName("required")] - public bool? Required { get; set; } +/// RPC data type for WorkspacesAddSummaryResultSummary operations. +public sealed class WorkspacesAddSummaryResultSummary +{ } -/// Schema for the `SlashCommandInfo` type. +/// RPC data type for WorkspacesAddSummaryResultWorkspace operations. +public sealed class WorkspacesAddSummaryResultWorkspace +{ +} + +/// Persisted summary metadata and refreshed workspace metadata. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandInfo +public sealed class WorkspacesAddSummaryResult { - /// Canonical aliases without leading slashes. - [JsonPropertyName("aliases")] - public IList? Aliases { get; set; } + /// Gets or sets the summary value. + [JsonPropertyName("summary")] + public WorkspacesAddSummaryResultSummary? Summary { get; set; } - /// Whether the command may run while an agent turn is active. - [JsonPropertyName("allowDuringAgentExecution")] - public bool AllowDuringAgentExecution { get; set; } + /// Gets or sets the workspace value. + [JsonPropertyName("workspace")] + public WorkspacesAddSummaryResultWorkspace? Workspace { get; set; } +} - /// Human-readable command description. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; +/// Compaction summary checkpoint to persist. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesAddSummaryRequest +{ + /// Markdown summary content to persist. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Whether the command is experimental. - [JsonPropertyName("experimental")] - public bool? Experimental { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; - /// Optional unstructured input hint. - [JsonPropertyName("input")] - public SlashCommandInput? Input { get; set; } + /// Summary title shown in checkpoint listings. + [JsonPropertyName("title")] + public string Title { get; set; } = string.Empty; +} - /// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. - [JsonPropertyName("kind")] - public SlashCommandKind Kind { get; set; } +/// Rollback point for local workspace summaries. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesTruncateSummariesRequest +{ + /// Number of newest summaries to keep. + [JsonPropertyName("keepCount")] + public long KeepCount { get; set; } - /// Canonical command name without a leading slash. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Slash commands available in the session, after applying any include/exclude filters. +/// Autopilot objective file content, or null when missing. [Experimental(Diagnostics.Experimental)] -public sealed class CommandList +public sealed class WorkspacesReadAutopilotObjectiveResult { - /// Commands available in this session. - [JsonPropertyName("commands")] - public IList Commands { get => field ??= []; set; } + /// Autopilot objective file content, or null when missing. + [JsonPropertyName("content")] + public string? Content { get; set; } } -/// Optional filters controlling which command sources to include in the listing. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class CommandsListRequest +internal sealed class SessionWorkspacesReadAutopilotObjectiveRequest { - /// Include runtime built-in commands. - [JsonPropertyName("includeBuiltins")] - public bool? IncludeBuiltins { get; set; } - - /// Include commands registered by protocol clients, including SDK clients and extensions. - [JsonPropertyName("includeClientCommands")] - public bool? IncludeClientCommands { get; set; } - - /// Include enabled user-invocable skills and commands. - [JsonPropertyName("includeSkills")] - public bool? IncludeSkills { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Optional filters controlling which command sources to include in the listing. +/// Result of writing the autopilot objective file. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsListRequestWithSession +public sealed class WorkspacesWriteAutopilotObjectiveResult { - /// Include runtime built-in commands. - [JsonPropertyName("includeBuiltins")] - public bool? IncludeBuiltins { get; set; } - - /// Include commands registered by protocol clients, including SDK clients and extensions. - [JsonPropertyName("includeClientCommands")] - public bool? IncludeClientCommands { get; set; } + /// Filesystem operation performed. + [JsonPropertyName("operation")] + public string Operation { get; set; } = string.Empty; +} - /// Include enabled user-invocable skills and commands. - [JsonPropertyName("includeSkills")] - public bool? IncludeSkills { get; set; } +/// Autopilot objective file content to persist. +[Experimental(Diagnostics.Experimental)] +internal sealed class WorkspacesWriteAutopilotObjectiveRequest +{ + /// Autopilot objective file content. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Result of invoking the slash command (text output, prompt to send to the agent, or completion). -/// Polymorphic base type discriminated by kind. +/// Result of deleting the autopilot objective file. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(SlashCommandInvocationResultText), "text")] -[JsonDerivedType(typeof(SlashCommandInvocationResultAgentPrompt), "agent-prompt")] -[JsonDerivedType(typeof(SlashCommandInvocationResultCompleted), "completed")] -[JsonDerivedType(typeof(SlashCommandInvocationResultSelectSubcommand), "select-subcommand")] -public partial class SlashCommandInvocationResult +public sealed class WorkspacesDeleteAutopilotObjectiveResult { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; + /// True when a file was deleted. + [JsonPropertyName("deleted")] + public bool Deleted { get; set; } } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionWorkspacesDeleteAutopilotObjectiveRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} -/// Schema for the `SlashCommandTextResult` type. -/// The text variant of . +/// Whether the autopilot objective file exists. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultText : SlashCommandInvocationResult +public sealed class WorkspacesAutopilotObjectiveExistsResult { - /// - [JsonIgnore] - public override string Kind => "text"; + /// True when the objective file exists. + [JsonPropertyName("exists")] + public bool Exists { get; set; } +} - /// Whether text contains Markdown. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("markdown")] - public bool? Markdown { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionWorkspacesAutopilotObjectiveExistsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Whether ANSI sequences should be preserved. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("preserveAnsi")] - public bool? PreserveAnsi { get; set; } +/// RPC data type for WorkspacesSaveLargePasteResultSaved operations. +public sealed class WorkspacesSaveLargePasteResultSaved +{ + /// Filename within the workspace files directory. + [JsonPropertyName("filename")] + public string Filename { get; set; } = string.Empty; - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("runtimeSettingsChanged")] - public bool? RuntimeSettingsChanged { get; set; } + /// Absolute filesystem path to the saved paste file. + [JsonPropertyName("filePath")] + public string FilePath { get; set; } = string.Empty; - /// Text output for the client to render. - [JsonPropertyName("text")] - public required string Text { get; set; } + /// Size of the saved file in bytes. + [JsonPropertyName("sizeBytes")] + public long SizeBytes { get; set; } } -/// Schema for the `SlashCommandAgentPromptResult` type. -/// The agent-prompt variant of . +/// Descriptor for the saved paste file, or null when the workspace is unavailable. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultAgentPrompt : SlashCommandInvocationResult +public sealed class WorkspacesSaveLargePasteResult { - /// - [JsonIgnore] - public override string Kind => "agent-prompt"; - - /// Prompt text to display to the user. - [JsonPropertyName("displayPrompt")] - public required string DisplayPrompt { get; set; } - - /// Optional target session mode for the agent prompt. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("mode")] - public SessionMode? Mode { get; set; } - - /// Prompt to submit to the agent. - [JsonPropertyName("prompt")] - public required string Prompt { get; set; } - - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("runtimeSettingsChanged")] - public bool? RuntimeSettingsChanged { get; set; } + /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions). + [JsonPropertyName("saved")] + public WorkspacesSaveLargePasteResultSaved? Saved { get; set; } } -/// Schema for the `SlashCommandCompletedResult` type. -/// The completed variant of . +/// Pasted content to save as a UTF-8 file in the session workspace. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultCompleted : SlashCommandInvocationResult +internal sealed class WorkspacesSaveLargePasteRequest { - /// - [JsonIgnore] - public override string Kind => "completed"; - - /// Optional user-facing message describing the completed command. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("message")] - public string? Message { get; set; } + /// Pasted content to save as a UTF-8 file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("runtimeSettingsChanged")] - public bool? RuntimeSettingsChanged { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `SlashCommandSelectSubcommandOption` type. +/// A single changed file and its unified diff. [Experimental(Diagnostics.Experimental)] -public sealed class SlashCommandSelectSubcommandOption +public sealed class WorkspaceDiffFileChange { - /// Human-readable description of the subcommand. - [JsonPropertyName("description")] - public string Description { get; set; } = string.Empty; + /// Type of change represented by this file diff. + [JsonPropertyName("changeType")] + public WorkspaceDiffFileChangeType ChangeType { get; set; } - /// Optional group label for organizing options. - [JsonPropertyName("group")] - public string? Group { get; set; } + /// Unified diff content for the file. Empty when the diff was truncated. + [JsonPropertyName("diff")] + public string Diff { get; set; } = string.Empty; - /// Subcommand name to invoke. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Whether the diff content was omitted because it exceeded the per-file size limit. + [JsonPropertyName("isTruncated")] + public bool? IsTruncated { get; set; } + + /// Original file path for renamed files. + [JsonPropertyName("oldPath")] + public string? OldPath { get; set; } + + /// Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive). + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; } -/// Schema for the `SlashCommandSelectSubcommandResult` type. -/// The select-subcommand variant of . +/// Workspace diff result for the requested mode. [Experimental(Diagnostics.Experimental)] -public partial class SlashCommandInvocationResultSelectSubcommand : SlashCommandInvocationResult +public sealed class WorkspaceDiffResult { - /// - [JsonIgnore] - public override string Kind => "select-subcommand"; + /// Default branch used for a branch diff, when branch mode was requested. + [JsonPropertyName("baseBranch")] + public string? BaseBranch { get; set; } - /// Parent command name that requires subcommand selection. - [JsonPropertyName("command")] - public required string Command { get; set; } + /// Changed files and their unified diffs. + [JsonPropertyName("changes")] + public IList Changes { get => field ??= []; set; } - /// Available subcommand options for the client to present. - [JsonPropertyName("options")] - public required IList Options { get; set; } + /// Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable. + [JsonPropertyName("isFallback")] + public bool IsFallback { get; set; } - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("runtimeSettingsChanged")] - public bool? RuntimeSettingsChanged { get; set; } + /// Effective mode used for the returned changes. + [JsonPropertyName("mode")] + public WorkspaceDiffMode Mode { get; set; } - /// Human-readable title for the selection UI. - [JsonPropertyName("title")] - public required string Title { get; set; } + /// Diff mode requested by the client. + [JsonPropertyName("requestedMode")] + public WorkspaceDiffMode RequestedMode { get; set; } + + /// Why the session diff could not be produced, when applicable. Set only when `session` mode was requested and `isFallback` is true, so a client can tell the permanent `file-change-tracking-disabled` apart from the transient `session-busy`, which the same request answers once the session settles. Never set for `unstaged` or `branch` mode, and never `unsupported-remote-session`: a remote session's captures live on its own host, so a `session`-mode diff is rejected for one rather than answered with a controller-side fallback. + [JsonPropertyName("unavailableReason")] + public HistoryRewindUnavailableReason? UnavailableReason { get; set; } } -/// Slash command name and optional raw input string to invoke. +/// Parameters for computing a workspace diff. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsInvokeRequest +internal sealed class WorkspacesDiffRequest { - /// Raw input after the command name. - [JsonPropertyName("input")] - public string? Input { get; set; } + /// When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. + [JsonPropertyName("ignoreWhitespace")] + public bool? IgnoreWhitespace { get; set; } - /// Command name. Leading slashes are stripped and the name is matched case-insensitively. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Diff mode requested by the client. + [JsonPropertyName("mode")] + public WorkspaceDiffMode Mode { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the pending client-handled command was completed successfully. +/// Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). [Experimental(Diagnostics.Experimental)] -public sealed class CommandsHandlePendingCommandResult +public sealed class CompletionsGetTriggerCharactersResult { - /// Whether the command was handled successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + [JsonPropertyName("triggerCharacters")] + public IList TriggerCharacters { get => field ??= []; set; } } -/// Pending command request ID and an optional error if the client handler failed. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsHandlePendingCommandRequest +internal sealed class SessionCompletionsGetTriggerCharactersRequest { - /// Error message if the command handler failed. - [JsonPropertyName("error")] - public string? Error { get; set; } - - /// Request ID from the command invocation event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Error message produced while executing the command, if any. +/// A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` (UTF-16 code units) in the composer with `insertText`; when the range is absent, the active token around the cursor is replaced. [Experimental(Diagnostics.Experimental)] -public sealed class ExecuteCommandResult +public sealed class SessionCompletionItem { - /// Error message produced while executing the command, if any. Omitted when the handler succeeded. - [JsonPropertyName("error")] - public string? Error { get; set; } + /// Text spliced into the composer when the item is accepted. + [JsonPropertyName("insertText")] + public string InsertText { get; set; } = string.Empty; + + /// Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. + [JsonPropertyName("kind")] + public string? Kind { get; set; } + + /// Primary display label for the picker row. Falls back to `insertText` when absent. + [JsonPropertyName("label")] + public string? Label { get; set; } + + /// End (exclusive) of the replacement range in `text`, in UTF-16 code units. + [JsonPropertyName("rangeEnd")] + public long? RangeEnd { get; set; } + + /// Start of the replacement range in `text`, in UTF-16 code units. + [JsonPropertyName("rangeStart")] + public long? RangeStart { get; set; } } -/// Slash command name and argument string to execute synchronously. +/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. [Experimental(Diagnostics.Experimental)] -internal sealed class ExecuteCommandParams +public sealed class CompletionsRequestResult { - /// Argument string to pass to the command (empty string if none). - [JsonPropertyName("args")] - public string Args { get; set; } = string.Empty; + /// Completion items in host-ranked order. + [JsonPropertyName("items")] + public IList Items { get => field ??= []; set; } +} - /// Name of the slash command to invoke (without the leading '/'). - [JsonPropertyName("commandName")] - public string CommandName { get; set; } = string.Empty; +/// Request host-driven completions for the current composer input. +[Experimental(Diagnostics.Experimental)] +internal sealed class CompletionsRequestRequest +{ + /// Cursor offset within `text`, in UTF-16 code units. + [JsonPropertyName("offset")] + public long Offset { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; + + /// The full composed composer input. + [JsonPropertyName("text")] + public string Text { get; set; } = string.Empty; } -/// Indicates whether the command was accepted into the local execution queue. +/// Instruction sources loaded for the session, in merge order. [Experimental(Diagnostics.Experimental)] -public sealed class EnqueueCommandResult +public sealed class InstructionsGetSourcesResult { - /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). - [JsonPropertyName("queued")] - public bool Queued { get; set; } + /// Instruction sources for the session. + [JsonPropertyName("sources")] + public IList Sources { get => field ??= []; set; } } -/// Slash-prefixed command string to enqueue for FIFO processing. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class EnqueueCommandParams +internal sealed class SessionInstructionsGetSourcesRequest { - /// Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. - [JsonPropertyName("command")] - public string Command { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether fleet mode was successfully activated. +[Experimental(Diagnostics.Experimental)] +public sealed class FleetStartResult +{ + /// Whether fleet mode was successfully activated. + [JsonPropertyName("started")] + public bool Started { get; set; } +} + +/// Optional user prompt to combine with the fleet orchestration instructions. +[Experimental(Diagnostics.Experimental)] +internal sealed class FleetStartRequest +{ + /// Optional user prompt to combine with fleet instructions. + [JsonPropertyName("prompt")] + public string? Prompt { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the queued-command response was matched to a pending request. +/// Agents available to the session. [Experimental(Diagnostics.Experimental)] -public sealed class CommandsRespondToQueuedCommandResult +public sealed class AgentList { - /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Available agents. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } } -/// Result of the queued command execution. -/// Data type discriminated by handled. +/// RPC data type for SessionAgentList operations. [Experimental(Diagnostics.Experimental)] -public partial class QueuedCommandResult +public sealed class SessionAgentListRequest { - /// The boolean discriminator. - [JsonPropertyName("handled")] - public bool Handled { get; set; } + /// When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. + [JsonPropertyName("includeBuiltInAgents")] + public bool? IncludeBuiltInAgents { get; set; } - /// When true, the runtime will not process subsequent queued commands until a new request comes in. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("stopProcessingQueue")] - public bool? StopProcessingQueue { get; set; } + /// When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. + [JsonPropertyName("includePrompt")] + public bool? IncludePrompt { get; set; } } -/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). +/// RPC data type for SessionAgentListRequestWithSession operations. [Experimental(Diagnostics.Experimental)] -internal sealed class CommandsRespondToQueuedCommandRequest +internal sealed class SessionAgentListRequestWithSession { - /// Request ID from the `command.queued` event the host is responding to. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. + [JsonPropertyName("includeBuiltInAgents")] + public bool? IncludeBuiltInAgents { get; set; } - /// Result of the queued command execution. - [JsonPropertyName("result")] - public QueuedCommandResult Result { get => field ??= new(); set; } + /// When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. + [JsonPropertyName("includePrompt")] + public bool? IncludePrompt { get; set; } /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Feature override key/value pairs to attach to subsequent telemetry events from this session. +/// An in-memory authored prompt override for an available agent. [Experimental(Diagnostics.Experimental)] -internal sealed class TelemetrySetFeatureOverridesRequest +internal sealed class AgentSetPromptRequest { - /// Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. - [JsonPropertyName("features")] - public IDictionary Features { get => field ??= new Dictionary(); set; } + /// Stable effective agent id. Plugin namespace separators are normalized. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Replacement authored prompt. Empty text is valid. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// The elicitation response (accept with form values, decline, or cancel). +/// The currently selected custom agent, or null when using the default agent. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationResponse +public sealed class AgentGetCurrentResult { - /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). - [JsonPropertyName("action")] - public UIElicitationResponseAction Action { get; set; } - - /// The form values submitted by the user (present when action is 'accept'). - [JsonPropertyName("content")] - public IDictionary? Content { get; set; } + /// Currently selected custom agent, or null if using the default agent. + [JsonPropertyName("agent")] + public AgentInfo? Agent { get; set; } } -/// JSON Schema describing the form fields to present to the user. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationSchema -{ - /// Form field definitions, keyed by field name. - [JsonPropertyName("properties")] - public IDictionary Properties { get => field ??= new Dictionary(); set; } - - /// List of required field names. - [JsonPropertyName("required")] - public IList? Required { get; set; } - - /// Schema type indicator (always 'object'). - [JsonPropertyName("type")] - public string Type { get; set; } = string.Empty; -} - -/// Prompt message and JSON schema describing the form fields to elicit from the user. -[Experimental(Diagnostics.Experimental)] -internal sealed class UIElicitationRequest +internal sealed class SessionAgentGetCurrentRequest { - /// Message describing what information is needed from the user. - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; - - /// JSON Schema describing the form fields to present to the user. - [JsonPropertyName("requestedSchema")] - public UIElicitationSchema RequestedSchema { get => field ??= new(); set; } - /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// The newly selected custom agent. [Experimental(Diagnostics.Experimental)] -public sealed class UIElicitationResult +public sealed class AgentSelectResult { - /// Whether the response was accepted. False if the request was already resolved by another client. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// The newly selected custom agent. + [JsonPropertyName("agent")] + public AgentInfo Agent { get => field ??= new(); set; } } -/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +/// Name of the custom agent to select for subsequent turns. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingElicitationRequest +internal sealed class AgentSelectRequest { - /// The unique request ID from the elicitation.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - - /// The elicitation response (accept with form values, decline, or cancel). - [JsonPropertyName("result")] - public UIElicitationResponse Result { get => field ??= new(); set; } + /// Name of the custom agent to select. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the pending UI request was resolved by this call. -[Experimental(Diagnostics.Experimental)] -public sealed class UIHandlePendingResult -{ - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - [JsonPropertyName("success")] - public bool Success { get; set; } -} - -/// Schema for the `UIUserInputResponse` type. -[Experimental(Diagnostics.Experimental)] -public sealed class UIUserInputResponse -{ - /// The user's answer text. - [JsonPropertyName("answer")] - public string Answer { get; set; } = string.Empty; - - /// True if the user typed a freeform response, false if they selected a presented choice. Used by telemetry to differentiate between free text input and choice selection. - [JsonPropertyName("wasFreeform")] - public bool WasFreeform { get; set; } -} - -/// Request ID of a pending `user_input.requested` event and the user's response. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingUserInputRequest +internal sealed class SessionAgentDeselectRequest { - /// The unique request ID from the user_input.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - - /// Schema for the `UIUserInputResponse` type. - [JsonPropertyName("response")] - public UIUserInputResponse Response { get => field ??= new(); set; } - /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +/// Custom agents available to the session after reloading definitions from disk. [Experimental(Diagnostics.Experimental)] -public sealed class UIHandlePendingSamplingResponse +public sealed class AgentReloadResult { + /// Reloaded custom agents. + [JsonPropertyName("agents")] + public IList Agents { get => field ??= []; set; } } -/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingSamplingRequest +internal sealed class SessionAgentReloadRequest { - /// The unique request ID from the sampling.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - - /// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. - [JsonPropertyName("response")] - public UIHandlePendingSamplingResponse? Response { get; set; } - /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +/// Identifier assigned to the newly started background agent task. [Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingAutoModeSwitchRequest +public sealed class TasksStartAgentResult { - /// The unique request ID from the auto_mode_switch.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; - - /// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). - [JsonPropertyName("response")] - public UIAutoModeSwitchResponse Response { get; set; } - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Generated agent ID for the background task. + [JsonPropertyName("agentId")] + public string AgentId { get; set; } = string.Empty; } -/// Schema for the `UIExitPlanModeResponse` type. +/// Agent type, prompt, name, and optional description and model override for the new task. [Experimental(Diagnostics.Experimental)] -public sealed class UIExitPlanModeResponse +internal sealed class TasksStartAgentRequest { - /// Whether the plan was approved. - [JsonPropertyName("approved")] - public bool Approved { get; set; } - - /// Whether subsequent edits should be auto-approved without confirmation. - [JsonPropertyName("autoApproveEdits")] - public bool? AutoApproveEdits { get; set; } + /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose'). + [JsonPropertyName("agentType")] + public string AgentType { get; set; } = string.Empty; - /// Feedback from the user when they declined the plan or requested changes. - [JsonPropertyName("feedback")] - public string? Feedback { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public string? Description { get; set; } - /// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. - [JsonPropertyName("selectedAction")] - public UIExitPlanModeAction? SelectedAction { get; set; } -} + /// Optional model override. + [JsonPropertyName("model")] + public string? Model { get; set; } -/// Request ID of a pending `exit_plan_mode.requested` event and the user's response. -[Experimental(Diagnostics.Experimental)] -internal sealed class UIHandlePendingExitPlanModeRequest -{ - /// The unique request ID from the exit_plan_mode.requested event. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Short name for the agent, used to generate a human-readable ID. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// Schema for the `UIExitPlanModeResponse` type. - [JsonPropertyName("response")] - public UIExitPlanModeResponse Response { get => field ??= new(); set; } + /// Task prompt for the agent. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). -[Experimental(Diagnostics.Experimental)] -public sealed class UIRegisterDirectAutoModeSwitchHandlerResult -{ - /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. - [JsonPropertyName("handle")] - public string Handle { get; set; } = string.Empty; -} - -/// Identifies the target session. +/// Tracked task union returned by task APIs, containing either an agent task or a shell task. +/// Polymorphic base type discriminated by type. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionUiRegisterDirectAutoModeSwitchHandlerRequest +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(TaskInfoAgent), "agent")] +[JsonDerivedType(typeof(TaskInfoShell), "shell")] +public partial class TaskInfo { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; } -/// Indicates whether the handle was active and the registration count was decremented. -[Experimental(Diagnostics.Experimental)] -public sealed class UIUnregisterDirectAutoModeSwitchHandlerResult -{ - /// True if the handle was active and decremented the counter; false if the handle was unknown. - [JsonPropertyName("unregistered")] - public bool Unregistered { get; set; } -} -/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +/// Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. +/// The agent variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class UIUnregisterDirectAutoModeSwitchHandlerRequest +public partial class TaskInfoAgent : TaskInfo { - /// Handle previously returned by `registerDirectAutoModeSwitchHandler`. - [JsonPropertyName("handle")] - public string Handle { get; set; } = string.Empty; + /// + [JsonIgnore] + public override string Type => "agent"; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// ISO 8601 timestamp when the current active period began. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("activeStartedAt")] + public DateTimeOffset? ActiveStartedAt { get; set; } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsConfigureResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Accumulated active execution time in milliseconds. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("activeTimeMs")] + public TimeSpan? ActiveTime { get; set; } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsConfigureAdditionalContentExclusionPolicyRuleSource -{ - /// Gets or sets the name value. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Type of agent running this task. + [JsonPropertyName("agentType")] + public required string AgentType { get; set; } - /// Gets or sets the type value. - [JsonPropertyName("type")] - public string Type { get; set; } = string.Empty; -} + /// 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. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("canPromoteToBackground")] + public bool? CanPromoteToBackground { get; set; } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsConfigureAdditionalContentExclusionPolicyRule -{ - /// Gets or sets the ifAnyMatch value. - [JsonPropertyName("ifAnyMatch")] - public IList? IfAnyMatch { get; set; } + /// ISO 8601 timestamp when the task finished. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("completedAt")] + public DateTimeOffset? CompletedAt { get; set; } - /// Gets or sets the ifNoneMatch value. - [JsonPropertyName("ifNoneMatch")] - public IList? IfNoneMatch { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public required string Description { get; set; } - /// Gets or sets the paths value. - [JsonPropertyName("paths")] - public IList Paths { get => field ??= []; set; } + /// Error message when the task failed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. - [JsonPropertyName("source")] - public PermissionsConfigureAdditionalContentExclusionPolicyRuleSource Source { get => field ??= new(); set; } -} + /// Whether task execution is synchronously awaited or managed in the background. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("executionMode")] + public TaskExecutionMode? ExecutionMode { get; set; } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsConfigureAdditionalContentExclusionPolicy -{ - /// Gets or sets the last_updated_at value. - [JsonPropertyName("last_updated_at")] - public JsonElement LastUpdatedAt { get; set; } + /// Unique task identifier. + [JsonPropertyName("id")] + public required string Id { get; set; } - /// Gets or sets the rules value. - [JsonPropertyName("rules")] - public IList Rules { get => field ??= []; set; } + /// ISO 8601 timestamp when the agent entered idle state. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("idleSince")] + public DateTimeOffset? IdleSince { get; set; } - /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. - [JsonPropertyName("scope")] - public PermissionsConfigureAdditionalContentExclusionPolicyScope Scope { get; set; } -} + /// Most recent response text from the agent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("latestResponse")] + public string? LatestResponse { get; set; } -/// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsConfig -{ - /// Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). - [JsonPropertyName("additionalDirectories")] - public IList? AdditionalDirectories { get; set; } + /// Requested model override for the task when specified. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } - /// Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. - [JsonPropertyName("includeTempDirectory")] - public bool? IncludeTempDirectory { get; set; } + /// Most recent prompt delivered to the agent. Updated whenever the agent receives a follow-up message. + [JsonPropertyName("prompt")] + public required string Prompt { get; set; } - /// If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. - [JsonPropertyName("unrestricted")] - public bool? Unrestricted { get; set; } + /// Runtime model resolved for the task when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resolvedModel")] + public string? ResolvedModel { get; set; } - /// Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. - [JsonPropertyName("workspacePath")] - public string? WorkspacePath { get; set; } -} + /// Result text from the task when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("result")] + public string? Result { get; set; } -/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionRulesSet -{ - /// Rules that auto-approve matching requests. - [JsonPropertyName("approved")] - public IList Approved { get => field ??= []; set; } + /// ISO 8601 timestamp when the task was started. + [JsonPropertyName("startedAt")] + public required DateTimeOffset StartedAt { get; set; } - /// Rules that auto-deny matching requests. - [JsonPropertyName("denied")] - public IList Denied { get => field ??= []; set; } + /// Current lifecycle status of the task. + [JsonPropertyName("status")] + public required TaskStatus Status { get; set; } + + /// Tool call ID associated with this agent task. + [JsonPropertyName("toolCallId")] + public required string ToolCallId { get; set; } } -/// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. +/// Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. +/// The shell variant of . [Experimental(Diagnostics.Experimental)] -public sealed class PermissionUrlsConfig +public partial class TaskInfoShell : TaskInfo { - /// Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. - [JsonPropertyName("initialAllowed")] - public IList? InitialAllowed { get; set; } + /// + [JsonIgnore] + public override string Type => "shell"; - /// If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. - [JsonPropertyName("unrestricted")] - public bool? Unrestricted { get; set; } -} + /// Whether the shell runs inside a managed PTY session or as an independent background process. + [JsonPropertyName("attachmentMode")] + public required TaskShellInfoAttachmentMode AttachmentMode { get; set; } -/// Patch of permission policy fields to apply (omit a field to leave it unchanged). -[Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsConfigureParams -{ - /// If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. - [JsonPropertyName("additionalContentExclusionPolicies")] - public IList? AdditionalContentExclusionPolicies { get; set; } + /// Whether this shell task can be promoted to background mode. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("canPromoteToBackground")] + public bool? CanPromoteToBackground { get; set; } - /// If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. - [JsonPropertyName("approveAllReadPermissionRequests")] - public bool? ApproveAllReadPermissionRequests { get; set; } + /// Command being executed. + [JsonPropertyName("command")] + public required string Command { get; set; } - /// If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. - [JsonPropertyName("approveAllToolPermissionRequests")] - public bool? ApproveAllToolPermissionRequests { get; set; } + /// ISO 8601 timestamp when the task finished. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("completedAt")] + public DateTimeOffset? CompletedAt { get; set; } - /// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. - [JsonPropertyName("paths")] - public PermissionPathsConfig? Paths { get; set; } + /// Short description of the task. + [JsonPropertyName("description")] + public required string Description { get; set; } - /// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. - [JsonPropertyName("rules")] - public PermissionRulesSet? Rules { get; set; } + /// Whether task execution is synchronously awaited or managed in the background. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("executionMode")] + public TaskExecutionMode? ExecutionMode { get; set; } + + /// Unique task identifier. + [JsonPropertyName("id")] + public required string Id { get; set; } + + /// Path to the detached shell log, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("logPath")] + public string? LogPath { get; set; } + + /// Process ID when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pid")] + public long? Pid { get; set; } + + /// ISO 8601 timestamp when the task was started. + [JsonPropertyName("startedAt")] + public required DateTimeOffset StartedAt { get; set; } + + /// Current lifecycle status of the task. + [JsonPropertyName("status")] + public required TaskStatus Status { get; set; } +} + +/// Background tasks currently tracked by the session. +[Experimental(Diagnostics.Experimental)] +public sealed class TaskList +{ + /// Currently tracked tasks. + [JsonPropertyName("tasks")] + public IList Tasks { get => field ??= []; set; } +} +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionTasksListRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. - [JsonPropertyName("urls")] - public PermissionUrlsConfig? Urls { get; set; } } -/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionRequestResult +public sealed class TasksRefreshResult { - /// Whether the permission request was handled successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } } -/// The client's response to the pending permission prompt. -/// Polymorphic base type discriminated by kind. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(PermissionDecisionApproveOnce), "approve-once")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSession), "approve-for-session")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocation), "approve-for-location")] -[JsonDerivedType(typeof(PermissionDecisionApprovePermanently), "approve-permanently")] -[JsonDerivedType(typeof(PermissionDecisionReject), "reject")] -[JsonDerivedType(typeof(PermissionDecisionUserNotAvailable), "user-not-available")] -[JsonDerivedType(typeof(PermissionDecisionApproved), "approved")] -[JsonDerivedType(typeof(PermissionDecisionApprovedForSession), "approved-for-session")] -[JsonDerivedType(typeof(PermissionDecisionApprovedForLocation), "approved-for-location")] -[JsonDerivedType(typeof(PermissionDecisionCancelled), "cancelled")] -[JsonDerivedType(typeof(PermissionDecisionDeniedByRules), "denied-by-rules")] -[JsonDerivedType(typeof(PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser), "denied-no-approval-rule-and-could-not-request-from-user")] -[JsonDerivedType(typeof(PermissionDecisionDeniedInteractivelyByUser), "denied-interactively-by-user")] -[JsonDerivedType(typeof(PermissionDecisionDeniedByContentExclusionPolicy), "denied-by-content-exclusion-policy")] -[JsonDerivedType(typeof(PermissionDecisionDeniedByPermissionRequestHook), "denied-by-permission-request-hook")] -public partial class PermissionDecision +internal sealed class SessionTasksRefreshRequest { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } - -/// Schema for the `PermissionDecisionApproveOnce` type. -/// The approve-once variant of . +/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveOnce : PermissionDecision +public sealed class TasksWaitForPendingResult { - /// - [JsonIgnore] - public override string Kind => "approve-once"; } -/// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts). -/// Polymorphic base type discriminated by kind. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] +internal sealed class SessionTasksWaitForPendingRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Polymorphic base type discriminated by type. [JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", + TypeDiscriminatorPropertyName = "type", UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCommands), "commands")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalRead), "read")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalWrite), "write")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcp), "mcp")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcpSampling), "mcp-sampling")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMemory), "memory")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCustomTool), "custom-tool")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalExtensionManagement), "extension-management")] -[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), "extension-permission-access")] -public partial class PermissionDecisionApproveForSessionApproval +[JsonDerivedType(typeof(TasksGetProgressResultProgressAgent), "agent")] +[JsonDerivedType(typeof(TasksGetProgressResultProgressShell), "shell")] +public partial class TasksGetProgressResultProgress { /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type. -/// The commands variant of . +/// Timestamped display line for task progress output or recent agent activity. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalCommands : PermissionDecisionApproveForSessionApproval +public sealed class TaskProgressLine { - /// - [JsonIgnore] - public override string Kind => "commands"; + /// Display message, e.g., "▸ bash", "✓ edit src/foo.ts". + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { get; set; } + /// ISO 8601 timestamp when this event occurred. + [JsonPropertyName("timestamp")] + public DateTimeOffset Timestamp { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalRead` type. -/// The read variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalRead : PermissionDecisionApproveForSessionApproval +/// Progress snapshot for an agent task, with recent activity lines and optional latest intent. +/// The agent variant of . +public partial class TasksGetProgressResultProgressAgent : TasksGetProgressResultProgress { /// [JsonIgnore] - public override string Kind => "read"; + public override string Type => "agent"; + + /// The most recent intent reported by the agent. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("latestIntent")] + public string? LatestIntent { get; set; } + + /// Recent tool execution events converted to display lines. + [JsonPropertyName("recentActivity")] + public required IList RecentActivity { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type. -/// The write variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalWrite : PermissionDecisionApproveForSessionApproval +/// Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID. +/// The shell variant of . +public partial class TasksGetProgressResultProgressShell : TasksGetProgressResultProgress { /// [JsonIgnore] - public override string Kind => "write"; + public override string Type => "shell"; + + /// Process ID when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pid")] + public long? Pid { get; set; } + + /// Recent stdout/stderr lines from the running shell command. + [JsonPropertyName("recentOutput")] + public required string RecentOutput { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type. -/// The mcp variant of . +/// Progress information for the task, or null when no task with that ID is tracked. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalMcp : PermissionDecisionApproveForSessionApproval +public sealed class TasksGetProgressResult { - /// - [JsonIgnore] - public override string Kind => "mcp"; - - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } - - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } + /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. + [JsonPropertyName("progress")] + public TasksGetProgressResultProgress? Progress { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type. -/// The mcp-sampling variant of . +/// Identifier of the background task to fetch progress for. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalMcpSampling : PermissionDecisionApproveForSessionApproval +internal sealed class TasksGetProgressRequest { - /// - [JsonIgnore] - public override string Kind => "mcp-sampling"; + /// Task identifier (agent ID or shell ID). + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type. -/// The memory variant of . +/// The first sync-waiting task that can currently be promoted to background mode. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalMemory : PermissionDecisionApproveForSessionApproval +public sealed class TasksGetCurrentPromotableResult { - /// - [JsonIgnore] - public override string Kind => "memory"; + /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. + [JsonPropertyName("task")] + public TaskInfo? Task { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type. -/// The custom-tool variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalCustomTool : PermissionDecisionApproveForSessionApproval +internal sealed class SessionTasksGetCurrentPromotableRequest { - /// - [JsonIgnore] - public override string Kind => "custom-tool"; - - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type. -/// The extension-management variant of . +/// Indicates whether the task was successfully promoted to background mode. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalExtensionManagement : PermissionDecisionApproveForSessionApproval +public sealed class TasksPromoteToBackgroundResult { - /// - [JsonIgnore] - public override string Kind => "extension-management"; - - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("operation")] - public string? Operation { get; set; } + /// Whether the task was successfully promoted to background mode. + [JsonPropertyName("promoted")] + public bool Promoted { get; set; } } -/// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` type. -/// The extension-permission-access variant of . +/// Identifier of the task to promote to background mode. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess : PermissionDecisionApproveForSessionApproval +internal sealed class TasksPromoteToBackgroundRequest { - /// - [JsonIgnore] - public override string Kind => "extension-permission-access"; + /// Task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// Extension name. - [JsonPropertyName("extensionName")] - public required string ExtensionName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForSession` type. -/// The approve-for-session variant of . +/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForSession : PermissionDecision +public sealed class TasksPromoteCurrentToBackgroundResult { - /// - [JsonIgnore] - public override string Kind => "approve-for-session"; - - /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("approval")] - public PermissionDecisionApproveForSessionApproval? Approval { get; set; } - - /// URL domain to approve for the rest of the session (URL prompts only). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("domain")] - public string? Domain { get; set; } + /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. + [JsonPropertyName("task")] + public TaskInfo? Task { get; set; } } -/// Approval to persist for this location. -/// Polymorphic base type discriminated by kind. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCommands), "commands")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalRead), "read")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalWrite), "write")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcp), "mcp")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcpSampling), "mcp-sampling")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMemory), "memory")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCustomTool), "custom-tool")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalExtensionManagement), "extension-management")] -[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess), "extension-permission-access")] -public partial class PermissionDecisionApproveForLocationApproval +internal sealed class SessionTasksPromoteCurrentToBackgroundRequest { - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } - -/// Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type. -/// The commands variant of . +/// Indicates whether the background task was successfully cancelled. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalCommands : PermissionDecisionApproveForLocationApproval +public sealed class TasksCancelResult { - /// - [JsonIgnore] - public override string Kind => "commands"; - - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { get; set; } + /// Whether the task was successfully cancelled. + [JsonPropertyName("cancelled")] + public bool Cancelled { get; set; } } -/// Schema for the `PermissionDecisionApproveForLocationApprovalRead` type. -/// The read variant of . +/// Identifier of the background task to cancel. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalRead : PermissionDecisionApproveForLocationApproval +internal sealed class TasksCancelRequest { - /// - [JsonIgnore] - public override string Kind => "read"; + /// Task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type. -/// The write variant of . +/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalWrite : PermissionDecisionApproveForLocationApproval +public sealed class TasksRemoveResult { - /// - [JsonIgnore] - public override string Kind => "write"; + /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). + [JsonPropertyName("removed")] + public bool Removed { get; set; } } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type. -/// The mcp variant of . +/// Identifier of the completed or cancelled task to remove from tracking. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalMcp : PermissionDecisionApproveForLocationApproval +internal sealed class TasksRemoveRequest { - /// - [JsonIgnore] - public override string Kind => "mcp"; - - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// Task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type. -/// The mcp-sampling variant of . +/// Indicates whether the message was delivered, with an error message when delivery failed. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalMcpSampling : PermissionDecisionApproveForLocationApproval +public sealed class TasksSendMessageResult { - /// - [JsonIgnore] - public override string Kind => "mcp-sampling"; + /// Error message if delivery failed. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// Whether the message was successfully delivered or steered. + [JsonPropertyName("sent")] + public bool Sent { get; set; } } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type. -/// The memory variant of . +/// Identifier of the target agent task, message content, and optional sender agent ID. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalMemory : PermissionDecisionApproveForLocationApproval +internal sealed class TasksSendMessageRequest { - /// - [JsonIgnore] - public override string Kind => "memory"; + /// Agent ID of the sender, if sent on behalf of another agent. + [JsonPropertyName("fromAgentId")] + public string? FromAgentId { get; set; } + + /// Agent task identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Message content to send to the agent. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type. -/// The custom-tool variant of . +/// Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalCustomTool : PermissionDecisionApproveForLocationApproval +public sealed class Skill { - /// - [JsonIgnore] - public override string Kind => "custom-tool"; + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. + [JsonPropertyName("argumentHint")] + public string? ArgumentHint { get; set; } - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { get; set; } + /// Canonical slash command name used to invoke the skill, without the leading '/'. + [JsonPropertyName("commandName")] + public string? CommandName { get; set; } + + /// Description of what the skill does. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Whether the skill is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Unique identifier for the skill. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Absolute path to the skill file. + [JsonPropertyName("path")] + public string? Path { get; set; } + + /// Name of the plugin that provides the skill, when source is 'plugin'. + [JsonPropertyName("pluginName")] + public string? PluginName { get; set; } + + /// Source location type (e.g., project, personal-copilot, plugin, builtin). + [JsonPropertyName("source")] + public SkillSource Source { get; set; } + + /// Whether the skill can be invoked by the user as a slash command. + [JsonPropertyName("userInvocable")] + public bool UserInvocable { get; set; } } -/// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type. -/// The extension-management variant of . +/// Skills available to the session, with their enabled state. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalExtensionManagement : PermissionDecisionApproveForLocationApproval +public sealed class SkillList { - /// - [JsonIgnore] - public override string Kind => "extension-management"; - - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("operation")] - public string? Operation { get; set; } + /// Available skills. + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` type. -/// The extension-permission-access variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess : PermissionDecisionApproveForLocationApproval +internal sealed class SessionSkillsListRequest { - /// - [JsonIgnore] - public override string Kind => "extension-permission-access"; - - /// Extension name. - [JsonPropertyName("extensionName")] - public required string ExtensionName { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproveForLocation` type. -/// The approve-for-location variant of . +/// Skill invocation record with name, path, content, allowed tools, and turn number. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproveForLocation : PermissionDecision +public sealed class SkillsInvokedSkill { - /// - [JsonIgnore] - public override string Kind => "approve-for-location"; + /// Tools that should be auto-approved when this skill is active, captured at invocation time. + [JsonPropertyName("allowedTools")] + public IList? AllowedTools { get; set; } - /// Approval to persist for this location. - [JsonPropertyName("approval")] - public required PermissionDecisionApproveForLocationApproval Approval { get; set; } + /// Full content of the skill file. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; - /// Location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public required string LocationKey { get; set; } -} + /// Turn number when the skill was invoked. + [JsonPropertyName("invokedAtTurn")] + public long InvokedAtTurn { get; set; } -/// Schema for the `PermissionDecisionApprovePermanently` type. -/// The approve-permanently variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovePermanently : PermissionDecision -{ - /// - [JsonIgnore] - public override string Kind => "approve-permanently"; + /// Unique identifier for the skill. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// URL domain to approve permanently. - [JsonPropertyName("domain")] - public required string Domain { get; set; } + /// Path to the SKILL.md file. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionReject` type. -/// The reject variant of . +/// Skills invoked during this session, ordered by invocation time (most recent last). [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionReject : PermissionDecision +public sealed class SkillsGetInvokedResult { - /// - [JsonIgnore] - public override string Kind => "reject"; - - /// Optional feedback explaining the rejection. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("feedback")] - public string? Feedback { get; set; } + /// Skills invoked during this session, ordered by invocation time (most recent last). + [JsonPropertyName("skills")] + public IList Skills { get => field ??= []; set; } } -/// Schema for the `PermissionDecisionUserNotAvailable` type. -/// The user-not-available variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionUserNotAvailable : PermissionDecision +internal sealed class SessionSkillsGetInvokedRequest { - /// - [JsonIgnore] - public override string Kind => "user-not-available"; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApproved` type. -/// The approved variant of . +/// Name of the skill to enable for the session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApproved : PermissionDecision +internal sealed class SkillsEnableRequest { - /// - [JsonIgnore] - public override string Kind => "approved"; + /// Name of the skill to enable. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApprovedForSession` type. -/// The approved-for-session variant of . +/// Name of the skill to disable for the session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovedForSession : PermissionDecision +internal sealed class SkillsDisableRequest { - /// - [JsonIgnore] - public override string Kind => "approved-for-session"; + /// Name of the skill to disable. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// The approval to add as a session-scoped rule. - [JsonPropertyName("approval")] - public required UserToolSessionApproval Approval { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionApprovedForLocation` type. -/// The approved-for-location variant of . +/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionApprovedForLocation : PermissionDecision +public sealed class SkillsLoadDiagnostics { - /// - [JsonIgnore] - public override string Kind => "approved-for-location"; - - /// The approval to persist for this location. - [JsonPropertyName("approval")] - public required UserToolSessionApproval Approval { get; set; } + /// Errors emitted while loading skills (e.g. skills that failed to load entirely). + [JsonPropertyName("errors")] + public IList Errors { get => field ??= []; set; } - /// The location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public required string LocationKey { get; set; } + /// Warnings emitted while loading skills (e.g. skills that loaded but had issues). + [JsonPropertyName("warnings")] + public IList Warnings { get => field ??= []; set; } } -/// Schema for the `PermissionDecisionCancelled` type. -/// The cancelled variant of . +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionCancelled : PermissionDecision +internal sealed class SessionSkillsReloadRequest { - /// - [JsonIgnore] - public override string Kind => "cancelled"; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} - /// Optional explanation of why the request was cancelled. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("reason")] - public string? Reason { get; set; } +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionSkillsEnsureLoadedRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PermissionDecisionDeniedByRules` type. -/// The denied-by-rules variant of . +/// Recorded MCP server connection failure. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedByRules : PermissionDecision +public sealed class McpServerFailureInfo { - /// - [JsonIgnore] - public override string Kind => "denied-by-rules"; + /// Failure message produced when the MCP server connection failed. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; - /// Rules that denied the request. - [JsonPropertyName("rules")] - public required IList Rules { get; set; } + /// epoch-ms timestamp at which the failure was recorded. + [JsonPropertyName("timestamp")] + public long Timestamp { get; set; } } -/// Schema for the `PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. -/// The denied-no-approval-rule-and-could-not-request-from-user variant of . +/// Recorded MCP server pending-auth state. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser : PermissionDecision +public sealed class McpServerNeedsAuthInfo { - /// - [JsonIgnore] - public override string Kind => "denied-no-approval-rule-and-could-not-request-from-user"; + /// epoch-ms timestamp at which the server signalled it needs authentication. + [JsonPropertyName("timestamp")] + public long Timestamp { get; set; } } -/// Schema for the `PermissionDecisionDeniedInteractivelyByUser` type. -/// The denied-interactively-by-user variant of . +/// Host-level state, omitted when no MCP host is initialized. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedInteractivelyByUser : PermissionDecision +public sealed class McpHostState { - /// - [JsonIgnore] - public override string Kind => "denied-interactively-by-user"; + /// Names of currently-connected MCP clients. + [JsonPropertyName("clients")] + public IList Clients { get => field ??= []; set; } - /// Optional feedback from the user explaining the denial. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("feedback")] - public string? Feedback { get; set; } + /// Configured servers that are explicitly disabled. + [JsonPropertyName("disabledServers")] + public IList DisabledServers { get => field ??= []; set; } - /// Whether to force-reject the current agent turn. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("forceReject")] - public bool? ForceReject { get; set; } + /// Map of server name to recorded connection failure. + [JsonPropertyName("failedServers")] + public IDictionary FailedServers { get => field ??= new Dictionary(); set; } + + /// Configured servers filtered out by MCP server policy. + [JsonPropertyName("filteredServers")] + public IList FilteredServers { get => field ??= []; set; } + + /// Whether third-party MCP servers are policy-enabled for this session. + [JsonPropertyName("mcp3pEnabled")] + public bool Mcp3pEnabled { get; set; } + + /// Map of server name to recorded pending-auth state. + [JsonPropertyName("needsAuthServers")] + public IDictionary NeedsAuthServers { get => field ??= new Dictionary(); set; } + + /// Names of servers with in-flight connection attempts. + [JsonPropertyName("pendingConnections")] + public IList PendingConnections { get => field ??= []; set; } } -/// Schema for the `PermissionDecisionDeniedByContentExclusionPolicy` type. -/// The denied-by-content-exclusion-policy variant of . +/// MCP server status entry, including config source/plugin source and any connection error. [Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedByContentExclusionPolicy : PermissionDecision +public sealed class McpServer { - /// - [JsonIgnore] - public override string Kind => "denied-by-content-exclusion-policy"; + /// Error message if the server failed to connect. + [JsonPropertyName("error")] + public string? Error { get; set; } - /// Human-readable explanation of why the path was excluded. - [JsonPropertyName("message")] - public required string Message { get; set; } + /// Server name (config key). + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// File path that triggered the exclusion. - [JsonPropertyName("path")] - public required string Path { get; set; } -} + /// Configuration source: user, workspace, plugin, or builtin. + [JsonPropertyName("source")] + public McpServerSource? Source { get; set; } -/// Schema for the `PermissionDecisionDeniedByPermissionRequestHook` type. -/// The denied-by-permission-request-hook variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionDecisionDeniedByPermissionRequestHook : PermissionDecision -{ - /// - [JsonIgnore] - public override string Kind => "denied-by-permission-request-hook"; + /// Plugin name that provided this server, when source is plugin. + [JsonPropertyName("sourcePlugin")] + public string? SourcePlugin { get; set; } - /// Whether to interrupt the current agent turn. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("interrupt")] - public bool? Interrupt { get; set; } + /// Plugin version that provided this server, when source is plugin. + [JsonPropertyName("sourcePluginVersion")] + public string? SourcePluginVersion { get; set; } - /// Optional message from the hook explaining the denial. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("message")] - public string? Message { get; set; } + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured. + [JsonPropertyName("status")] + public McpServerStatus Status { get; set; } } -/// Pending permission request ID and the decision to apply (approve/reject and scope). +/// MCP servers configured for the session, with their connection status and host-level state. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionDecisionRequest +public sealed class McpServerList { - /// Request ID of the pending permission request. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Host-level state, omitted when no MCP host is initialized. + [JsonPropertyName("host")] + public McpHostState? Host { get; set; } - /// The client's response to the pending permission prompt. - [JsonPropertyName("result")] - public PermissionDecision Result { get => field ??= new(); set; } + /// Configured MCP servers. + [JsonPropertyName("servers")] + public IList Servers { get => field ??= []; set; } +} +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMcpListRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Schema for the `PendingPermissionRequest` type. +/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. [Experimental(Diagnostics.Experimental)] -public sealed class PendingPermissionRequest +public sealed class McpToolUi { - /// The user-facing permission prompt details (commands, write, read, mcp, url, memory, custom-tool, path, hook). - [JsonPropertyName("request")] - public PermissionPromptRequest Request { get; set; } = null!; + /// URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use `session.mcp.resources.read` to fetch its HTML and resource metadata. + [JsonPropertyName("resourceUri")] + public string? ResourceUri { get; set; } - /// Unique identifier for the pending permission request. - [JsonPropertyName("requestId")] - public string RequestId { get; set; } = string.Empty; + /// Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + [JsonPropertyName("visibility")] + public IList? Visibility { get; set; } } -/// List of pending permission requests reconstructed from event history. +/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. [Experimental(Diagnostics.Experimental)] -public sealed class PendingPermissionRequestList +public sealed class McpTools { - /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. - [JsonPropertyName("items")] - public IList Items { get => field ??= []; set; } -} + /// Tool description, when provided. + [JsonPropertyName("description")] + public string? Description { get; set; } -/// No parameters; returns currently-pending permission requests for the session. -[Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsPendingRequestsRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Tool name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` block was present without recognized fields. + [JsonPropertyName("ui")] + public McpToolUi? Ui { get; set; } } -/// Indicates whether the operation succeeded. +/// Tools exposed by the connected MCP server. Throws when the server is not connected. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsSetApproveAllResult +public sealed class McpListToolsResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Tools exposed by the server. + [JsonPropertyName("tools")] + public IList Tools { get => field ??= []; set; } } -/// Allow-all toggle for tool permission requests, with an optional telemetry source. +/// Server name whose tool list should be returned. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetApproveAllRequest +internal sealed class McpListToolsRequest { - /// Whether to auto-approve all tool permission requests. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Name of the connected MCP server whose tools to list. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. - [JsonPropertyName("source")] - public PermissionsSetApproveAllSource? Source { get; set; } } -/// Indicates whether the operation succeeded and reports the post-mutation state. +/// Name of the MCP server to enable for the session. [Experimental(Diagnostics.Experimental)] -public sealed class AllowAllPermissionSetResult +internal sealed class McpEnableRequest { - /// Authoritative allow-all state after the mutation. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Name of the MCP server to enable. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Whether to enable full allow-all permissions for the session. +/// Name of the MCP server to disable for the session. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetAllowAllRequest +internal sealed class McpDisableRequest { - /// Whether to enable full allow-all permissions. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Name of the MCP server to disable. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; - - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. - [JsonPropertyName("source")] - public PermissionsSetAllowAllSource? Source { get; set; } -} - -/// Current full allow-all permission state. -[Experimental(Diagnostics.Experimental)] -public sealed class AllowAllPermissionState -{ - /// Whether full allow-all permissions are currently active. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } } -/// No parameters. +/// Identifies the target session. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsGetAllowAllRequest +internal sealed class SessionMcpReloadRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// MCP server allowed by policy, with server name and optional PII-free explanatory note. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsModifyRulesResult +public sealed class McpAllowedServer { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Allowed server name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// PII-free note explaining why the server was allowed. + [JsonPropertyName("redactedNote")] + public string? RedactedNote { get; set; } } -/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. +/// MCP server filtered by policy, with name, reason, and optional redacted reason. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsModifyRulesParams +public sealed class McpFilteredServer { - /// Rules to add to the scope. Applied before `remove`/`removeAll`. - [JsonPropertyName("add")] - public IList? Add { get; set; } + /// Deprecated. This field is no longer populated. + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif + [JsonPropertyName("enterpriseName")] + public string? EnterpriseName { get; set; } - /// Specific rules to remove from the scope. Ignored when `removeAll` is true. - [JsonPropertyName("remove")] - public IList? Remove { get; set; } + /// Filtered server name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; - /// When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. - [JsonPropertyName("removeAll")] - public bool? RemoveAll { get; set; } + /// Human-readable filter reason. + [JsonPropertyName("reason")] + public string Reason { get; set; } = string.Empty; - /// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. - [JsonPropertyName("scope")] - public PermissionsModifyRulesScope Scope { get; set; } + /// PII-free filter reason. + [JsonPropertyName("redactedReason")] + public string? RedactedReason { get; set; } +} + +/// MCP server startup filtering result. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpStartServersResult +{ + /// Non-default servers allowed by policy. + [JsonPropertyName("allowedServers")] + public IList? AllowedServers { get; set; } + + /// Servers filtered out before startup. + [JsonPropertyName("filteredServers")] + public IList FilteredServers { get => field ??= []; set; } +} +/// Opaque MCP reload configuration. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpReloadWithConfigRequest +{ /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsSetRequiredResult +public sealed class McpExecuteSamplingResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } } -/// Toggles whether permission prompts should be bridged into session events for this client. +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsSetRequiredRequest +public sealed class McpSamplingExecutionResult { - /// Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). - [JsonPropertyName("required")] - public bool Required { get; set; } + /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. + [JsonPropertyName("action")] + public McpSamplingExecutionAction Action { get; set; } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Error description, present when action='failure'. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + [JsonPropertyName("result")] + public McpExecuteSamplingResult? Result { get; set; } } -/// Indicates whether the operation succeeded. +/// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsResetSessionApprovalsResult +public sealed class McpExecuteSamplingRequest { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } } -/// No parameters; clears all session-scoped tool permission approvals. +/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsResetSessionApprovalsRequest +internal sealed class McpExecuteSamplingParams { + /// The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). + [JsonPropertyName("mcpRequestId")] + public JsonElement McpRequestId { get; set; } + + /// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. + [JsonPropertyName("request")] + public McpExecuteSamplingRequest Request { get => field ??= new(); set; } + + /// Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Name of the MCP server that initiated the sampling request. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsNotifyPromptShownResult +public sealed class McpCancelSamplingExecutionResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). + [JsonPropertyName("cancelled")] + public bool Cancelled { get; set; } } -/// Notification payload describing the permission prompt that the client just rendered. +/// The requestId previously passed to executeSampling that should be cancelled. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPromptShownNotification +internal sealed class McpCancelSamplingExecutionParams { - /// Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). - [JsonPropertyName("message")] - public string Message { get; set; } = string.Empty; + /// The requestId previously passed to executeSampling that should be cancelled. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Snapshot of the session's allow-listed directories and primary working directory. +/// Env-value mode recorded on the session after the update. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsList +public sealed class McpSetEnvValueModeResult { - /// All directories currently allowed for tool access on this session. - [JsonPropertyName("directories")] - public IList Directories { get => field ??= []; set; } + /// Mode recorded on the session after the update. + [JsonPropertyName("mode")] + public McpSetEnvValueModeDetails Mode { get; set; } +} - /// The primary working directory for this session. - [JsonPropertyName("primary")] - public string Primary { get; set; } = string.Empty; +/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +[Experimental(Diagnostics.Experimental)] +internal sealed class McpSetEnvValueModeParams +{ + /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". + [JsonPropertyName("mode")] + public McpSetEnvValueModeDetails Mode { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// No parameters; returns the session's allow-listed directories. +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionsPathsListRequest +public sealed class McpRemoveGitHubResult +{ + /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). + [JsonPropertyName("removed")] + public bool Removed { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMcpRemoveGitHubRequest { /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// Result of configuring GitHub MCP. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsPathsAddResult +internal sealed class McpConfigureGitHubResult { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Whether GitHub MCP configuration changed. + [JsonPropertyName("changed")] + public bool Changed { get; set; } } -/// Directory path to add to the session's allowed directories. +/// Opaque auth info used to configure GitHub MCP. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsAddParams +internal sealed class McpConfigureGitHubRequest { - /// Directory to add to the allow-list. The runtime resolves and validates the path before adding. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpStartServerRequest +{ + /// MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server with its already-registered configuration (config-free start-by-name). + [JsonPropertyName("config")] + public JsonElement? Config { get; set; } + + /// Name of the MCP server to start. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the operation succeeded. +/// Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionsPathsUpdatePrimaryResult +internal sealed class McpRestartServerRequest { - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart the server with its already-registered configuration (config-free restart-by-name). + [JsonPropertyName("config")] + public JsonElement? Config { get; set; } + + /// Name of the MCP server to restart. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Directory path to set as the session's new primary working directory. +/// Server name for an individual MCP server stop. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsUpdatePrimaryParams +internal sealed class McpStopServerRequest { - /// Directory to set as the new primary working directory for the session's permission policy. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Name of the MCP server to stop. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the supplied path is within the session's allowed directories. +/// Registration parameters for an external MCP client. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsAllowedCheckResult +internal sealed class McpRegisterExternalClientRequest { - /// Whether the path is within the session's allowed directories. - [JsonPropertyName("allowed")] - public bool Allowed { get; set; } + /// Logical server name for the external client. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Path to evaluate against the session's allowed directories. +/// Server name identifying the external client to remove. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsAllowedCheckParams +internal sealed class McpUnregisterExternalClientRequest { - /// Path to check against the session's allowed directories. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Server name of the external client to unregister. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Indicates whether the supplied path is within the session's workspace directory. +/// Whether the named MCP server is running. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionPathsWorkspaceCheckResult +public sealed class McpIsServerRunningResult { - /// Whether the path is within the session workspace directory. - [JsonPropertyName("allowed")] - public bool Allowed { get; set; } + /// True if the server has an active client and transport. + [JsonPropertyName("running")] + public bool Running { get; set; } } -/// Path to evaluate against the session's workspace (primary) directory. +/// Server name to check running status for. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionPathsWorkspaceCheckParams +internal sealed class McpIsServerRunningRequest { - /// Path to check against the session workspace directory. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Name of the MCP server to check. + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; } -/// Resolved location-permissions key and type. +/// Indicates whether the pending MCP OAuth response was accepted. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionLocationResolveResult +public sealed class McpOauthHandlePendingResult { - /// Location key used in the location-permissions store. - [JsonPropertyName("locationKey")] - public string LocationKey { get; set; } = string.Empty; + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + [JsonPropertyName("success")] + public bool Success { get; set; } +} - /// Whether the location is a git repo or directory. - [JsonPropertyName("locationType")] - public PermissionLocationType LocationType { get; set; } +/// Host response to the pending OAuth request. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpOauthPendingRequestResponseToken), "token")] +[JsonDerivedType(typeof(McpOauthPendingRequestResponseCancelled), "cancelled")] +public partial class McpOauthPendingRequestResponse +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; } -/// Working directory to resolve into a location-permissions key. + +/// The token variant of . [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationResolveParams +public partial class McpOauthPendingRequestResponseToken : McpOauthPendingRequestResponse +{ + /// + [JsonIgnore] + public override string Kind => "token"; + + /// Access token acquired by the SDK host. + [JsonPropertyName("accessToken")] + public required string AccessToken { get; set; } + + /// Token lifetime in seconds, if known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("expiresIn")] + public long? ExpiresIn { get; set; } + + /// OAuth token type. Defaults to Bearer when omitted. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("tokenType")] + public string? TokenType { get; set; } +} + +/// The cancelled variant of . +[Experimental(Diagnostics.Experimental)] +public partial class McpOauthPendingRequestResponseCancelled : McpOauthPendingRequestResponse +{ + /// + [JsonIgnore] + public override string Kind => "cancelled"; +} + +/// Pending MCP OAuth request ID and host-provided token or cancellation response. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpOauthHandlePendingRequest { + /// OAuth request identifier from the mcp.oauth_required event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Host response to the pending OAuth request. + [JsonPropertyName("result")] + public McpOauthPendingRequestResponse Result { get => field ??= new(); set; } + /// Target session identifier. [JsonPropertyName("sessionId")] public string SessionId { get; set; } = string.Empty; +} - /// Working directory whose permission location should be resolved. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; +/// Identifies the MCP server whose persisted OAuth credentials were updated. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpOauthAuthenticationStateChangedRequest +{ + /// Whether the target session must mint a session-scoped access token instead of reusing a shared access token persisted by another session. + [JsonPropertyName("refreshSessionToken")] + public bool? RefreshSessionToken { get; set; } + + /// Name of the MCP server whose OAuth credentials were updated. Omit only when the host cannot identify the server. + [JsonPropertyName("serverName")] + public string? ServerName { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; } -/// Summary of persisted location permissions applied to the session. +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. [Experimental(Diagnostics.Experimental)] -public sealed class PermissionLocationApplyResult +public sealed class McpOauthLoginResult { - /// Number of persisted allowed directories added to the live path manager. - [JsonPropertyName("appliedDirectoryCount")] - public long AppliedDirectoryCount { get; set; } + /// 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. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("authorizationUrl")] + public string? AuthorizationUrl { get; set; } +} - /// Number of location-scoped rules added to the live permission service. - [JsonPropertyName("appliedRuleCount")] - public long AppliedRuleCount { get; set; } +/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpOauthLoginRequest +{ + /// 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. + [JsonPropertyName("callbackSuccessMessage")] + public string? CallbackSuccessMessage { get; set; } - /// Location-scoped rules applied to the live permission service. - [JsonPropertyName("appliedRules")] - public IList AppliedRules { get => field ??= []; set; } + /// Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. + [JsonPropertyName("clientId")] + public string? ClientId { get; set; } - /// Whether a different location was applied since the previous apply call. - [JsonPropertyName("changed")] - public bool Changed { get; set; } + /// 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. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } - /// Location key used in the location-permissions store. - [JsonPropertyName("locationKey")] - public string LocationKey { get; set; } = string.Empty; + /// Optional OAuth client secret override for this login. The runtime treats this as an ephemeral host-owned secret, uses it for this authentication attempt and does not persist it. + [JsonPropertyName("clientSecret")] + public string? ClientSecret { get; set; } + + /// 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. + [JsonPropertyName("forceReauth")] + public bool? ForceReauth { get; set; } + + /// Optional OAuth grant type override for this login. Defaults to the server configuration, or authorization_code when no grant type is specified. + [JsonPropertyName("grantType")] + public McpOauthLoginGrantType? GrantType { get; set; } + + /// Optional override indicating whether the static OAuth client is public. When false, the runtime treats it as confidential and uses the per-login clientSecret if provided, otherwise retrieving the client secret from the MCP OAuth secret store. + [JsonPropertyName("publicClient")] + public bool? PublicClient { get; set; } + + /// Name of the remote MCP server to authenticate. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the pending MCP OAuth response was accepted. +[Experimental(Diagnostics.Experimental)] +public sealed class McpOauthRespondResult +{ + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Pending MCP OAuth request id to respond to. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpOauthRespondRequest +{ + /// OAuth request identifier from the mcp.oauth_required event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the pending MCP headers refresh response was accepted. +[Experimental(Diagnostics.Experimental)] +public sealed class McpHeadersHandlePendingHeadersRefreshRequestResult +{ + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Host response: supply dynamic headers or decline this refresh. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestHeaders), "headers")] +[JsonDerivedType(typeof(McpHeadersHandlePendingHeadersRefreshRequestNone), "none")] +public partial class McpHeadersHandlePendingHeadersRefreshRequest +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// The headers variant of . +[Experimental(Diagnostics.Experimental)] +public partial class McpHeadersHandlePendingHeadersRefreshRequestHeaders : McpHeadersHandlePendingHeadersRefreshRequest +{ + /// + [JsonIgnore] + public override string Kind => "headers"; + + /// Headers to overlay onto the MCP request. Dynamic headers override static config headers but do not replace SDK-managed request headers. + [JsonPropertyName("headers")] + public required IDictionary Headers { get; set; } +} + +/// The none variant of . +[Experimental(Diagnostics.Experimental)] +public partial class McpHeadersHandlePendingHeadersRefreshRequestNone : McpHeadersHandlePendingHeadersRefreshRequest +{ + /// + [JsonIgnore] + public override string Kind => "none"; +} + +/// MCP headers refresh request id and the host response. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpHeadersHandlePendingHeadersRefreshRequestRequest +{ + /// Headers refresh request identifier from mcp.headers_refresh_required. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Host response: supply dynamic headers or decline this refresh. + [JsonPropertyName("result")] + public McpHeadersHandlePendingHeadersRefreshRequest Result { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsResourceContent +{ + /// Resource-level metadata (CSP, permissions, etc.). + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } + + /// Base64-encoded binary content. + [JsonPropertyName("blob")] + public string? Blob { get; set; } + + /// MIME type of the content. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Text content (e.g. HTML). + [JsonPropertyName("text")] + public string? Text { get; set; } + + /// The resource URI (typically ui://...). + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; +} + +/// Resource contents returned by the MCP server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsReadResourceResult +{ + /// Resource contents returned by the server. + [JsonPropertyName("contents")] + public IList Contents { get => field ??= []; set; } +} + +/// MCP server and resource URI to fetch. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpAppsReadResourceRequest +{ + /// Name of the MCP server hosting the resource. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Resource URI (typically ui://...). + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; +} + +/// App-callable tools from the named MCP server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsListToolsResult +{ + /// App-callable tools from the server. + [JsonPropertyName("tools")] + public IList> Tools { get => field ??= []; set; } +} + +/// MCP server to list app-callable tools for. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpAppsListToolsRequest +{ + /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("originServerName")] + public string OriginServerName { get; set; } = string.Empty; + + /// MCP server hosting the app. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// MCP server, tool name, and arguments to invoke from an MCP App view. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpAppsCallToolRequest +{ + /// Tool arguments. + [JsonPropertyName("arguments")] + public IDictionary? Arguments { get; set; } + + /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("originServerName")] + public string OriginServerName { get; set; } = string.Empty; + + /// MCP server hosting the tool. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// MCP tool name. + [JsonPropertyName("toolName")] + public string ToolName { get; set; } = string.Empty; +} + +/// Host context advertised to MCP App guests. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsSetHostContextDetails +{ + /// Display modes the host supports. + [JsonPropertyName("availableDisplayModes")] + public IList? AvailableDisplayModes { get; set; } + + /// Current display mode (SEP-1865). + [JsonPropertyName("displayMode")] + public McpAppsSetHostContextDetailsDisplayMode? DisplayMode { get; set; } + + /// BCP-47 locale, e.g. 'en-US'. + [JsonPropertyName("locale")] + public string? Locale { get; set; } + + /// Platform type for responsive design. + [JsonPropertyName("platform")] + public McpAppsSetHostContextDetailsPlatform? Platform { get; set; } + + /// UI theme preference per SEP-1865. + [JsonPropertyName("theme")] + public McpAppsSetHostContextDetailsTheme? Theme { get; set; } + + /// IANA timezone, e.g. 'America/New_York'. + [JsonPropertyName("timeZone")] + public string? TimeZone { get; set; } + + /// Host application identifier. + [JsonPropertyName("userAgent")] + public string? UserAgent { get; set; } +} + +/// Host context to advertise to MCP App guests. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpAppsSetHostContextRequest +{ + /// Host context advertised to MCP App guests. + [JsonPropertyName("context")] + public McpAppsSetHostContextDetails Context { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Current host context. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsHostContextDetails +{ + /// Display modes the host supports. + [JsonPropertyName("availableDisplayModes")] + public IList? AvailableDisplayModes { get; set; } + + /// Current display mode (SEP-1865). + [JsonPropertyName("displayMode")] + public McpAppsHostContextDetailsDisplayMode? DisplayMode { get; set; } + + /// BCP-47 locale, e.g. 'en-US'. + [JsonPropertyName("locale")] + public string? Locale { get; set; } + + /// Platform type for responsive design. + [JsonPropertyName("platform")] + public McpAppsHostContextDetailsPlatform? Platform { get; set; } + + /// UI theme preference per SEP-1865. + [JsonPropertyName("theme")] + public McpAppsHostContextDetailsTheme? Theme { get; set; } + + /// IANA timezone, e.g. 'America/New_York'. + [JsonPropertyName("timeZone")] + public string? TimeZone { get; set; } + + /// Host application identifier. + [JsonPropertyName("userAgent")] + public string? UserAgent { get; set; } +} + +/// Current host context advertised to MCP App guests. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsHostContext +{ + /// Current host context. + [JsonPropertyName("context")] + public McpAppsHostContextDetails Context { get => field ??= new(); set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMcpAppsGetHostContextRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Capability negotiation snapshot. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsDiagnoseCapability +{ + /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers. + [JsonPropertyName("advertised")] + public bool Advertised { get; set; } + + /// Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on. + [JsonPropertyName("featureFlagEnabled")] + public bool FeatureFlagEnabled { get; set; } + + /// Whether the session has the `mcp-apps` capability. + [JsonPropertyName("sessionHasMcpApps")] + public bool SessionHasMcpApps { get; set; } +} + +/// What the server returned for this session. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsDiagnoseServer +{ + /// Whether the named server is currently connected. + [JsonPropertyName("connected")] + public bool Connected { get; set; } + + /// Up to 5 tool names with `_meta.ui` for quick inspection. + [JsonPropertyName("sampleToolNames")] + public IList SampleToolNames { get => field ??= []; set; } + + /// Total tools returned by the server's tools/list. + [JsonPropertyName("toolCount")] + public double ToolCount { get; set; } + + /// Tools whose `_meta.ui` is populated (resourceUri and/or visibility set). + [JsonPropertyName("toolsWithUiMeta")] + public double ToolsWithUiMeta { get; set; } +} + +/// Diagnostic snapshot of MCP Apps wiring for the named server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpAppsDiagnoseResult +{ + /// Capability negotiation snapshot. + [JsonPropertyName("capability")] + public McpAppsDiagnoseCapability Capability { get => field ??= new(); set; } + + /// What the server returned for this session. + [JsonPropertyName("server")] + public McpAppsDiagnoseServer Server { get => field ??= new(); set; } +} + +/// MCP server to diagnose MCP Apps wiring for. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpAppsDiagnoseRequest +{ + /// MCP server to probe. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourceContent +{ + /// Resource-level metadata (CSP, permissions, etc.). + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } + + /// Base64-encoded binary content. + [JsonPropertyName("blob")] + public string? Blob { get; set; } + + /// MIME type of the content. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Text content (e.g. HTML). + [JsonPropertyName("text")] + public string? Text { get; set; } + + /// The resource URI. + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; +} + +/// Resource contents returned by the MCP server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourcesReadResult +{ + /// Resource contents returned by the server. + [JsonPropertyName("contents")] + public IList Contents { get => field ??= []; set; } +} + +/// MCP server and resource URI to fetch. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpResourcesReadRequest +{ + /// Name of the MCP server hosting the resource. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Resource URI. + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; +} + +/// Standard MCP resource annotations plus preserved non-standard annotation fields. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourceAnnotations +{ + /// Server-provided non-standard annotation fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } + + /// Intended audience roles for this resource. + [JsonPropertyName("audience")] + public IList? Audience { get; set; } + + /// Last-modified timestamp hint. + [JsonPropertyName("lastModified")] + public string? LastModified { get; set; } + + /// Priority hint for model/client use. + [JsonPropertyName("priority")] + public double? Priority { get; set; } +} + +/// A resource icon descriptor plus preserved non-standard icon fields. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourceIcon +{ + /// Server-provided non-standard icon fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } + + /// Icon MIME type, when known. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Icon sizes hint. + [JsonPropertyName("sizes")] + public string? Sizes { get; set; } + + /// Icon URI. + [JsonPropertyName("src")] + public string Src { get; set; } = string.Empty; + + /// Theme hint for this icon. + [JsonPropertyName("theme")] + public string? Theme { get; set; } +} + +/// An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResource +{ + /// Resource-level metadata. + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } + + /// Server-provided non-standard descriptor fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } + + /// Model/client annotations associated with this resource. + [JsonPropertyName("annotations")] + public McpResourceAnnotations? Annotations { get; set; } + + /// Optional description of what this resource represents. + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Icons associated with this resource. + [JsonPropertyName("icons")] + public IList? Icons { get; set; } + + /// MIME type of the resource, if known. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// The programmatic name of the resource. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Resource size in bytes, when known. + [JsonPropertyName("size")] + public long? Size { get; set; } + + /// Optional human-readable display title. + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// The resource URI (e.g. ui://... or file:///...). + [JsonPropertyName("uri")] + public string Uri { get; set; } = string.Empty; +} + +/// One page of resources advertised by the named MCP server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourcesListResult +{ + /// Opaque cursor for the next page, if the server has more resources. + [JsonPropertyName("nextCursor")] + public string? NextCursor { get; set; } + + /// Resources advertised by the server (proxied MCP `resources/list`). + [JsonPropertyName("resources")] + public IList Resources { get => field ??= []; set; } +} + +/// MCP server whose resources to enumerate. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpResourcesListRequest +{ + /// Opaque MCP pagination cursor from a prior `nextCursor` value. + [JsonPropertyName("cursor")] + public string? Cursor { get; set; } + + /// Name of the MCP server whose resources to enumerate. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourceTemplate +{ + /// Resource-template-level metadata. + [JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } + + /// Server-provided non-standard descriptor fields preserved from the MCP response. + [JsonPropertyName("additionalProperties")] + public IDictionary? AdditionalProperties { get; set; } + + /// Model/client annotations associated with this template. + [JsonPropertyName("annotations")] + public McpResourceAnnotations? Annotations { get; set; } + + /// Optional description of what this template is for. + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Icons associated with resources matching this template. + [JsonPropertyName("icons")] + public IList? Icons { get; set; } + + /// MIME type for resources matching this template, if uniform. + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// The programmatic name of the resource template. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Optional human-readable display title. + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// An RFC 6570 URI template for constructing resource URIs. + [JsonPropertyName("uriTemplate")] + public string UriTemplate { get; set; } = string.Empty; +} + +/// One page of resource templates advertised by the named MCP server. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourcesListTemplatesResult +{ + /// Opaque cursor for the next page, if the server has more resource templates. + [JsonPropertyName("nextCursor")] + public string? NextCursor { get; set; } + + /// Resource templates advertised by the server (proxied MCP `resources/templates/list`). + [JsonPropertyName("resourceTemplates")] + public IList ResourceTemplates { get => field ??= []; set; } +} + +/// MCP server whose resource templates to enumerate. +[Experimental(Diagnostics.Experimental)] +internal sealed class McpResourcesListTemplatesRequest +{ + /// Opaque MCP pagination cursor from a prior `nextCursor` value. + [JsonPropertyName("cursor")] + public string? Cursor { get; set; } + + /// Name of the MCP server whose resource templates to enumerate. + [RegularExpression("^[^\\x00-\\x1f/\\x7f-\\x9f}]+(?:\\/[^\\x00-\\x1f/\\x7f-\\x9f}]+)*$")] + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("serverName")] + public string ServerName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Session plugin metadata, with name, marketplace, optional version, and enabled state. +[Experimental(Diagnostics.Experimental)] +public sealed class Plugin +{ + /// Whether the plugin is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Marketplace the plugin came from. + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; + + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Installed version. + [JsonPropertyName("version")] + public string? Version { get; set; } +} + +/// Plugins installed for the session, with their enabled state and version metadata. +[Experimental(Diagnostics.Experimental)] +public sealed class PluginList +{ + /// Installed plugins. + [JsonPropertyName("plugins")] + public IList Plugins { get => field ??= []; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionPluginsListRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// RPC data type for SessionPluginsReload operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionPluginsReloadRequest +{ + /// When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + [JsonPropertyName("deferRepoHooks")] + public bool? DeferRepoHooks { get; set; } + + /// Re-run custom-agent discovery after refreshing plugins. Defaults to true. + [JsonPropertyName("reloadCustomAgents")] + public bool? ReloadCustomAgents { get; set; } + + /// Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). + [JsonPropertyName("reloadExtensions")] + public bool? ReloadExtensions { get; set; } + + /// Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). + [JsonPropertyName("reloadHooks")] + public bool? ReloadHooks { get; set; } + + /// Reload MCP server connections after refreshing plugins. Defaults to true. + [JsonPropertyName("reloadMcp")] + public bool? ReloadMcp { get; set; } +} + +/// RPC data type for SessionPluginsReloadRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionPluginsReloadRequestWithSession +{ + /// When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + [JsonPropertyName("deferRepoHooks")] + public bool? DeferRepoHooks { get; set; } + + /// Re-run custom-agent discovery after refreshing plugins. Defaults to true. + [JsonPropertyName("reloadCustomAgents")] + public bool? ReloadCustomAgents { get; set; } + + /// Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). + [JsonPropertyName("reloadExtensions")] + public bool? ReloadExtensions { get; set; } + + /// Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). + [JsonPropertyName("reloadHooks")] + public bool? ReloadHooks { get; set; } + + /// Reload MCP server connections after refreshing plugins. Defaults to true. + [JsonPropertyName("reloadMcp")] + public bool? ReloadMcp { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderSessionToken +{ + /// When the token expires, if known. Callers should refresh by calling `getEndpoint` again before this time, or reactively on any 401/403 response from `baseUrl`. + [JsonPropertyName("expiresAt")] + public DateTimeOffset? ExpiresAt { get; set; } + + /// HTTP header name the token must be sent under. + [JsonPropertyName("header")] + public string Header { get; set; } = string.Empty; + + /// The model the token is bound to, when applicable. When set, the token is only valid for requests against this model. + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// The short-lived token value. + [JsonPropertyName("token")] + public string Token { get; set; } = string.Empty; +} + +/// A snapshot of the provider endpoint the session is currently configured to talk to. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderEndpoint +{ + /// A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } + + /// Base URL to pass to the LLM client library. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("baseUrl")] + public string BaseUrl { get; set; } = string.Empty; + + /// HTTP headers the caller must include on every outbound request. + [JsonPropertyName("headers")] + public IDictionary Headers { get => field ??= new Dictionary(); set; } + + /// Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. + [JsonPropertyName("sessionToken")] + public ProviderSessionToken? SessionToken { get; set; } + + /// Transport to be used for provider requests. + [JsonPropertyName("transport")] + public ProviderEndpointTransport? Transport { get; set; } + + /// Provider family. Matches the `type` field of a BYOK provider config. + [JsonPropertyName("type")] + public ProviderEndpointType Type { get; set; } + + /// Wire API to be used, when required for the provider type. + [JsonPropertyName("wireApi")] + public ProviderEndpointWireApi? WireApi { get; set; } +} + +/// RPC data type for SessionProviderGetEndpoint operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionProviderGetEndpointRequest +{ + /// Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } +} + +/// RPC data type for SessionProviderGetEndpointRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionProviderGetEndpointRequestWithSession +{ + /// Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// The selectable model entries synthesized for the models added by this call. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderAddResult +{ + /// Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added. + [JsonPropertyName("models")] + public IList Models { get => field ??= []; set; } +} + +/// A BYOK model definition referencing a named provider. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderModelConfig +{ + /// Optional capability overrides (vision, tool_calls, reasoning, etc.). + [JsonPropertyName("capabilities")] + public ModelCapabilitiesOverride? Capabilities { get; set; } + + /// Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified `provider/id`. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Maximum context window tokens for the model. + [JsonPropertyName("maxContextWindowTokens")] + public double? MaxContextWindowTokens { get; set; } + + /// Maximum output tokens for the model. + [JsonPropertyName("maxOutputTokens")] + public double? MaxOutputTokens { get; set; } + + /// Maximum prompt/input tokens for the model. + [JsonPropertyName("maxPromptTokens")] + public double? MaxPromptTokens { get; set; } + + /// Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// Display name for model pickers. Defaults to the provider-qualified selection id (`provider/id`). + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Name of the NamedProviderConfig that serves this model. + [JsonPropertyName("provider")] + public string Provider { get; set; } = string.Empty; + + /// The model name sent to the provider API for inference. Defaults to `id`. + [JsonPropertyName("wireModel")] + public string? WireModel { get; set; } +} + +/// Azure-specific provider options. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderConfigAzure +{ + /// API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. + [JsonPropertyName("apiVersion")] + public string? ApiVersion { get; set; } +} + +/// A named BYOK provider connection (transport + credentials). +[Experimental(Diagnostics.Experimental)] +public sealed class NamedProviderConfig +{ + /// API key. Optional for local providers like Ollama. + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } + + /// Azure-specific provider options. + [JsonPropertyName("azure")] + public ProviderConfigAzure? Azure { get; set; } + + /// API endpoint URL. + [JsonPropertyName("baseUrl")] + public string BaseUrl { get; set; } = string.Empty; + + /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + [JsonPropertyName("bearerToken")] + public string? BearerToken { get; set; } + + /// When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer <token>` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. + [JsonPropertyName("hasBearerTokenProvider")] + public bool? HasBearerTokenProvider { get; set; } + + /// Custom HTTP headers to include in all outbound requests to the provider. + [JsonPropertyName("headers")] + public IDictionary? Headers { get; set; } + + /// Stable identifier referenced by BYOK model definitions. Must not contain '/'. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Provider transport. Defaults to "http". + [JsonPropertyName("transport")] + public ProviderConfigTransport? Transport { get; set; } + + /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + [JsonPropertyName("type")] + public ProviderConfigType? Type { get; set; } + + /// Wire API format (openai/azure only). Defaults to "completions". + [JsonPropertyName("wireApi")] + public ProviderConfigWireApi? WireApi { get; set; } +} + +/// BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. +[Experimental(Diagnostics.Experimental)] +internal sealed class ProviderAddRequest +{ + /// BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry. + [JsonPropertyName("models")] + public IList? Models { get; set; } + + /// Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'. + [JsonPropertyName("providers")] + public IList? Providers { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the session options patch was applied successfully. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionUpdateOptionsResult +{ + /// Number of hooks loaded from installed plugins, returned when installedPlugins is updated. + [JsonPropertyName("pluginHookCount")] + public long? PluginHookCount { get; set; } + + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. +[Experimental(Diagnostics.Experimental)] +public sealed class OptionsUpdateAdditionalContentExclusionPolicyRuleSource +{ + /// Gets or sets the name value. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Gets or sets the type value. + [JsonPropertyName("type")] + public string Type { get; set; } = string.Empty; +} + +/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. +[Experimental(Diagnostics.Experimental)] +public sealed class OptionsUpdateAdditionalContentExclusionPolicyRule +{ + /// Gets or sets the ifAnyMatch value. + [JsonPropertyName("ifAnyMatch")] + public IList? IfAnyMatch { get; set; } + + /// Gets or sets the ifNoneMatch value. + [JsonPropertyName("ifNoneMatch")] + public IList? IfNoneMatch { get; set; } + + /// Gets or sets the paths value. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } + + /// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. + [JsonPropertyName("source")] + public OptionsUpdateAdditionalContentExclusionPolicyRuleSource Source { get => field ??= new(); set; } +} + +/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. +[Experimental(Diagnostics.Experimental)] +public sealed class OptionsUpdateAdditionalContentExclusionPolicy +{ + /// Gets or sets the last_updated_at value. + [JsonPropertyName("last_updated_at")] + public JsonElement LastUpdatedAt { get; set; } + + /// Gets or sets the rules value. + [JsonPropertyName("rules")] + public IList Rules { get => field ??= []; set; } + + /// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + [JsonPropertyName("scope")] + public OptionsUpdateAdditionalContentExclusionPolicyScope Scope { get; set; } +} + +/// Options scoped to the built-in CAPI (Copilot API) provider. +[Experimental(Diagnostics.Experimental)] +public sealed class CapiSessionOptions +{ + /// Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. + [JsonPropertyName("enableWebSocketResponses")] + public bool? EnableWebSocketResponses { get; set; } +} + +/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionInstalledPlugin +{ + /// Path where the plugin is cached locally. + [JsonPropertyName("cache_path")] + public string? CachePath { get; set; } + + /// Whether the plugin is currently enabled. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Installation timestamp (ISO-8601). + [JsonPropertyName("installed_at")] + public string InstalledAt { get; set; } = string.Empty; + + /// Marketplace the plugin came from (empty string for direct repo installs). + [JsonPropertyName("marketplace")] + public string Marketplace { get; set; } = string.Empty; + + /// Plugin name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Source descriptor for direct repo installs (when marketplace is empty). + [JsonPropertyName("source")] + public JsonElement? Source { get; set; } + + /// Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + [JsonPropertyName("source_sha")] + public string? SourceSha { get; set; } + + /// Installed version, if known. + [JsonPropertyName("version")] + public string? Version { get; set; } +} + +/// Custom model-provider configuration (BYOK). +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderConfig +{ + /// API key. Optional for local providers like Ollama. + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } + + /// Azure-specific provider options. + [JsonPropertyName("azure")] + public ProviderConfigAzure? Azure { get; set; } + + /// API endpoint URL. + [JsonPropertyName("baseUrl")] + public string BaseUrl { get; set; } = string.Empty; + + /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + [JsonPropertyName("bearerToken")] + public string? BearerToken { get; set; } + + /// When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer <token>` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. + [JsonPropertyName("hasBearerTokenProvider")] + public bool? HasBearerTokenProvider { get; set; } + + /// Custom HTTP headers to include in all outbound requests to the provider. + [JsonPropertyName("headers")] + public IDictionary? Headers { get; set; } + + /// Maximum context window tokens for the model. + [JsonPropertyName("maxContextWindowTokens")] + public double? MaxContextWindowTokens { get; set; } + + /// Maximum output tokens for the model. + [JsonPropertyName("maxOutputTokens")] + public double? MaxOutputTokens { get; set; } + + /// Maximum prompt/input tokens for the model. + [JsonPropertyName("maxPromptTokens")] + public double? MaxPromptTokens { get; set; } + + /// Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// Provider transport. Defaults to "http". + [JsonPropertyName("transport")] + public ProviderConfigTransport? Transport { get; set; } + + /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + [JsonPropertyName("type")] + public ProviderConfigType? Type { get; set; } + + /// Wire API format (openai/azure only). Defaults to "completions". + [JsonPropertyName("wireApi")] + public ProviderConfigWireApi? WireApi { get; set; } + + /// The model identifier sent to the provider API for inference (the "wire" model), as opposed to modelId which is the well-known base. + [JsonPropertyName("wireModel")] + public string? WireModel { get; set; } +} + +/// Credential-injection capability flags applied while the sandbox is enabled. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigAuth +{ + /// Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in). + [JsonPropertyName("gh")] + public bool? Gh { get; set; } + + /// Whether to inject git credentials as an `http.<url>.extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's own helper before the sandbox is applied. Default: false (opt-in). + [JsonPropertyName("git")] + public bool? Git { get; set; } +} + +/// macOS seatbelt experimental options. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicyExperimentalSeatbelt +{ + /// Whether the macOS seatbelt profile may access the keychain. + [JsonPropertyName("keychainAccess")] + public bool? KeychainAccess { get; set; } +} + +/// Platform-specific experimental policy fields. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicyExperimental +{ + /// macOS seatbelt experimental options. + [JsonPropertyName("seatbelt")] + public SandboxConfigUserPolicyExperimentalSeatbelt? Seatbelt { get; set; } +} + +/// Filesystem rules to merge into the base policy. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicyFilesystem +{ + /// Whether to clear the policy when the session exits. + [JsonPropertyName("clearPolicyOnExit")] + public bool? ClearPolicyOnExit { get; set; } + + /// Paths explicitly denied. + [JsonPropertyName("deniedPaths")] + public IList? DeniedPaths { get; set; } + + /// Paths granted read-only access. + [JsonPropertyName("readonlyPaths")] + public IList? ReadonlyPaths { get; set; } + + /// Paths granted read/write access. + [JsonPropertyName("readwritePaths")] + public IList? ReadwritePaths { get; set; } +} + +/// HTTP proxy configuration for sandboxed traffic. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicyNetworkProxy +{ + /// Optional password for proxy authentication, combined with the URL at spawn time. The persisted value may be a literal password, a `${secret:…}` reference resolved from the OS keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the sandboxed process routes through the proxy. The /sandbox dialog stores a real password in the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in settings.json); the field is masked in the dialog and redacted by /settings show. + [JsonPropertyName("password")] + public string? Password { get; set; } + + /// Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is. + [JsonPropertyName("url")] + public string Url { get; set; } = string.Empty; + + /// Optional username for proxy authentication. Combined with the URL (and `password`) into `user:pass@host` when the sandboxed process routes through the proxy. + [JsonPropertyName("username")] + public string? Username { get; set; } +} + +/// Network rules to merge into the base policy. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicyNetwork +{ + /// Whether traffic to local/loopback addresses is allowed. + [JsonPropertyName("allowLocalNetwork")] + public bool? AllowLocalNetwork { get; set; } + + /// Whether outbound network traffic is allowed at all. + [JsonPropertyName("allowOutbound")] + public bool? AllowOutbound { get; set; } + + /// HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. Credentials go in the separate `username`/`password` fields. A credential-free http:// loopback proxy URL is routed through the localhost proxy automatically; an https:// or authenticated loopback URL is used as-is. + [JsonPropertyName("proxy")] + public SandboxConfigUserPolicyNetworkProxy? Proxy { get; set; } +} + +/// macOS seatbelt-specific options. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicySeatbelt +{ + /// Whether the macOS seatbelt profile may access the keychain. + [JsonPropertyName("keychainAccess")] + public bool? KeychainAccess { get; set; } +} + +/// User-managed sandbox policy fragment merged into the auto-discovered base policy. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfigUserPolicy +{ + /// Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is absent. + [JsonPropertyName("experimental")] + public SandboxConfigUserPolicyExperimental? Experimental { get; set; } + + /// Filesystem rules to merge into the base policy. + [JsonPropertyName("filesystem")] + public SandboxConfigUserPolicyFilesystem? Filesystem { get; set; } + + /// Network rules to merge into the base policy. + [JsonPropertyName("network")] + public SandboxConfigUserPolicyNetwork? Network { get; set; } + + /// macOS seatbelt options to merge into the base policy. + [JsonPropertyName("seatbelt")] + public SandboxConfigUserPolicySeatbelt? Seatbelt { get; set; } +} + +/// Resolved sandbox configuration. +[Experimental(Diagnostics.Experimental)] +public sealed class SandboxConfig +{ + /// Whether to auto-add the current working directory to readwritePaths. Default: true. + [JsonPropertyName("addCurrentWorkingDirectory")] + public bool? AddCurrentWorkingDirectory { get; set; } + + /// Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without extra configuration; a relocated CARGO_HOME additionally gets its Cargo lock files granted read-write. Default: true (enabled by default; set to false to opt out). + [JsonPropertyName("allowDevToolAccess")] + public bool? AllowDevToolAccess { get; set; } + + /// Credential-injection capability flags. + [JsonPropertyName("auth")] + public SandboxConfigAuth? Auth { get; set; } + + /// Whether sandboxing is enabled for the session. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// User-managed sandbox policy fragment merged into the auto-discovered base policy. + [JsonPropertyName("userPolicy")] + public SandboxConfigUserPolicy? UserPolicy { get; set; } +} + +/// A host-provided script sourced before each built-in shell command when its shell target matches the active shell. +[Experimental(Diagnostics.Experimental)] +public sealed class ShellInitScript +{ + /// Path to the script to source. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Built-in shell that may source this script. + [JsonPropertyName("shell")] + public ShellInitScriptShell Shell { get; set; } +} + +/// Per-session settings for built-in shell tools. +[Experimental(Diagnostics.Experimental)] +public sealed class ShellOptions +{ + /// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. + [JsonPropertyName("initProfile")] + public ShellInitProfile? InitProfile { get; set; } + + /// + /// Ordered host-provided script paths sourced before each built-in shell command when the + /// entry's shell target matches the active shell. Use these for rc files, environment setup scripts, + /// or other custom scripts. A script that returns a nonzero status is reported, and later scripts + /// and the user command continue while the shell remains running. Because scripts are sourced into + /// the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating behavior + /// can prevent continuation. Script standard output is preserved; Bash script stderr is discarded, + /// PowerShell exception messages are replaced, and runtime-generated failure notices omit + /// configured script paths. When sandboxing is enabled, each script must already be readable under + /// the active sandbox filesystem policy. Pass an empty array to clear the list. + /// + [JsonPropertyName("initScripts")] + public IList? InitScripts { get; set; } + + /// + /// Flags passed to the active built-in shell process on startup, replacing its default flags. + /// When omitted, the built-in Bash shell uses `--norc --noprofile`, + /// and the built-in PowerShell shell uses `-NoProfile -NoLogo`. + /// + [JsonPropertyName("processFlags")] + public IList? ProcessFlags { get; set; } +} + +/// Patch of mutable session options to apply to the running session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionUpdateOptionsParams +{ + /// Additional content-exclusion policies to merge into the session's policy set. + [Experimental(Diagnostics.Experimental)] + [JsonPropertyName("additionalContentExclusionPolicies")] + public IList? AdditionalContentExclusionPolicies { get; set; } + + /// Runtime context discriminator (e.g., `cli`, `actions`). + [JsonPropertyName("agentContext")] + public string? AgentContext { get; set; } + + /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + [JsonPropertyName("allowAllMcpServerInstructions")] + public bool? AllowAllMcpServerInstructions { get; set; } + + /// Whether to disable the `ask_user` tool (encourages autonomous behavior). + [JsonPropertyName("askUserDisabled")] + public bool? AskUserDisabled { get; set; } + + /// Allowlist of tool names available to this session. + [JsonPropertyName("availableTools")] + public IList? AvailableTools { get; set; } + + /// Options scoped to the built-in CAPI (Copilot API) provider. + [JsonPropertyName("capi")] + public CapiSessionOptions? Capi { get; set; } + + /// Identifier of the client driving the session. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } + + /// Whether to include the `Co-authored-by` trailer in commit messages. + [JsonPropertyName("coauthorEnabled")] + public bool? CoauthorEnabled { get; set; } + + /// Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. + [JsonPropertyName("contextTier")] + public OptionsUpdateContextTier? ContextTier { get; set; } + + /// Whether to allow auto-mode continuation across turns. + [JsonPropertyName("continueOnAutoMode")] + public bool? ContinueOnAutoMode { get; set; } + + /// Override URL for the Copilot API endpoint. + [JsonPropertyName("copilotUrl")] + public string? CopilotUrl { get; set; } + + /// Whether to default custom agents to local-only execution. + [JsonPropertyName("customAgentsLocalOnly")] + public bool? CustomAgentsLocalOnly { get; set; } + + /// Instruction source IDs to exclude from the system prompt. + [JsonPropertyName("disabledInstructionSources")] + public IList? DisabledInstructionSources { get; set; } + + /// Skill IDs that should be excluded from this session. + [JsonPropertyName("disabledSkills")] + public IList? DisabledSkills { get; set; } + + /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. + [JsonPropertyName("enableFileHooks")] + public bool? EnableFileHooks { get; set; } + + /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). + [JsonPropertyName("enableHostGitOperations")] + public bool? EnableHostGitOperations { get; set; } + + /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`. + [JsonPropertyName("enableOnDemandInstructionDiscovery")] + public bool? EnableOnDemandInstructionDiscovery { get; set; } + + /// Whether to surface reasoning-summary events from the model. + [JsonPropertyName("enableReasoningSummaries")] + public bool? EnableReasoningSummaries { get; set; } + + /// Whether shell-script safety heuristics are enabled. + [JsonPropertyName("enableScriptSafety")] + public bool? EnableScriptSafety { get; set; } + + /// Whether to enable cross-session store writes and reads. + [JsonPropertyName("enableSessionStore")] + public bool? EnableSessionStore { get; set; } + + /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. + [JsonPropertyName("enableSkills")] + public bool? EnableSkills { get; set; } + + /// Whether to stream model responses. + [JsonPropertyName("enableStreaming")] + public bool? EnableStreaming { get; set; } + + /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). + [JsonPropertyName("envValueMode")] + public OptionsUpdateEnvValueMode? EnvValueMode { get; set; } + + /// Override directory for the session-events log. When unset, the runtime's default events log directory is used. + [JsonPropertyName("eventsLogDirectory")] + public string? EventsLogDirectory { get; set; } + + /// Whether subagent callback events should be forwarded into the session event log sink. + [JsonPropertyName("eventsLogIncludesSubagents")] + public bool? EventsLogIncludesSubagents { get; set; } + + /// Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. + [JsonPropertyName("excludedBuiltinAgents")] + public IList? ExcludedBuiltinAgents { get; set; } + + /// Denylist of tool names for this session. + [JsonPropertyName("excludedTools")] + public IList? ExcludedTools { get; set; } + + /// Map of feature-flag IDs to their boolean enabled state. + [JsonPropertyName("featureFlags")] + public IDictionary? FeatureFlags { get; set; } + + /// Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. + [JsonPropertyName("includedBuiltinAgents")] + public IList? IncludedBuiltinAgents { get; set; } + + /// Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. + [JsonPropertyName("installedPlugins")] + public IList? InstalledPlugins { get; set; } + + /// Stable integration identifier used for analytics and rate-limit attribution. + [JsonPropertyName("integrationId")] + public string? IntegrationId { get; set; } + + /// Whether experimental capabilities are enabled. + [JsonPropertyName("isExperimentalMode")] + public bool? IsExperimentalMode { get; set; } + + /// Whether interactive shell sessions are logged. + [JsonPropertyName("logInteractiveShells")] + public bool? LogInteractiveShells { get; set; } + + /// Identifier sent to LSP-style integrations. + [JsonPropertyName("lspClientName")] + public string? LspClientName { get; set; } + + /// Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). + [JsonPropertyName("manageScheduleEnabled")] + public bool? ManageScheduleEnabled { get; set; } + + /// Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB. + [JsonPropertyName("maxInlineBinaryBytes")] + public long? MaxInlineBinaryBytes { get; set; } + + /// The model ID to use for assistant turns. + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Per-property model capability overrides for the selected model. + [JsonPropertyName("modelCapabilitiesOverrides")] + public ModelCapabilitiesOverride? ModelCapabilitiesOverrides { get; set; } + + /// Organization-level custom instructions to inject into the system prompt. + [JsonPropertyName("organizationCustomInstructions")] + public string? OrganizationCustomInstructions { get; set; } + + /// Custom model-provider configuration (BYOK). + [JsonPropertyName("provider")] + public ProviderConfig? Provider { get; set; } + + /// Reasoning effort for the selected model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } + + /// Reasoning summary mode for supported model clients. + [JsonPropertyName("reasoningSummary")] + public OptionsUpdateReasoningSummary? ReasoningSummary { get; set; } + + /// Whether the session is running in an interactive UI. + [JsonPropertyName("runningInInteractiveMode")] + public bool? RunningInInteractiveMode { get; set; } + + /// Resolved sandbox configuration. + [JsonPropertyName("sandboxConfig")] + public SandboxConfig? SandboxConfig { get; set; } + + /// Replaces the session's capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the field to leave the existing capability set unchanged. + [JsonPropertyName("sessionCapabilities")] + public IList? SessionCapabilities { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Optional session limits. Pass null to clear the session limits. + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { get; set; } + + /// Per-session settings for built-in shell tools. + [JsonPropertyName("shell")] + public ShellOptions? Shell { get; set; } + + /// Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). + [EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif + [JsonPropertyName("shellInitProfile")] + public string? ShellInitProfile { get; set; } + + /// PowerShell process flags applied to built-in and user-requested shell commands. + [JsonPropertyName("shellProcessFlags")] + public IList? ShellProcessFlags { get; set; } + + /// Additional directories to search for skills. + [JsonPropertyName("skillDirectories")] + public IList? SkillDirectories { get; set; } + + /// Whether to skip loading custom instruction sources. + [JsonPropertyName("skipCustomInstructions")] + public bool? SkipCustomInstructions { get; set; } + + /// Whether to skip embedding retrieval pipeline initialization and execution. + [JsonPropertyName("skipEmbeddingRetrieval")] + public bool? SkipEmbeddingRetrieval { get; set; } + + /// When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement. + [JsonPropertyName("suppressCustomAgentPrompt")] + public bool? SuppressCustomAgentPrompt { get; set; } + + /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. + [JsonPropertyName("toolFilterPrecedence")] + public OptionsUpdateToolFilterPrecedence? ToolFilterPrecedence { get; set; } + + /// Optional path for trajectory output. + [JsonPropertyName("trajectoryFile")] + public string? TrajectoryFile { get; set; } + + /// Output verbosity level for supported models. + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } + + /// Absolute working-directory path for shell tools. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } +} + +/// Parameters for (re)loading the merged LSP configuration set. +[Experimental(Diagnostics.Experimental)] +internal sealed class LspInitializeRequest +{ + /// Force re-initialization even when LSP configs were already loaded for the working directory. + [JsonPropertyName("force")] + public bool? Force { get; set; } + + /// Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } +} + +/// Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. +[Experimental(Diagnostics.Experimental)] +public sealed class Extension +{ + /// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext'). + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Extension name (directory name). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Process ID if the extension is running. + [JsonPropertyName("pid")] + public long? Pid { get; set; } + + /// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state/<id>/extensions/). + [JsonPropertyName("source")] + public ExtensionSource Source { get; set; } + + /// Current status: running, disabled, failed, or starting. + [JsonPropertyName("status")] + public ExtensionStatus Status { get; set; } +} + +/// Extensions discovered for the session, with their current status. +[Experimental(Diagnostics.Experimental)] +public sealed class ExtensionList +{ + /// Discovered extensions and their current status. + [JsonPropertyName("extensions")] + public IList Extensions { get => field ??= []; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionExtensionsListRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Source-qualified extension identifier to enable for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class ExtensionsEnableRequest +{ + /// Source-qualified extension ID to enable. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Source-qualified extension identifier to disable for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class ExtensionsDisableRequest +{ + /// Source-qualified extension ID to disable. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionExtensionsReloadRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context. +/// Polymorphic base type discriminated by type. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(PushAttachmentFile), "file")] +[JsonDerivedType(typeof(PushAttachmentDirectory), "directory")] +[JsonDerivedType(typeof(PushAttachmentSelection), "selection")] +[JsonDerivedType(typeof(PushAttachmentGitHubReference), "github_reference")] +[JsonDerivedType(typeof(PushAttachmentGitHubCommit), "github_commit")] +[JsonDerivedType(typeof(PushAttachmentGitHubRelease), "github_release")] +[JsonDerivedType(typeof(PushAttachmentGitHubActionsJob), "github_actions_job")] +[JsonDerivedType(typeof(PushAttachmentGitHubRepository), "github_repository")] +[JsonDerivedType(typeof(PushAttachmentGitHubFileDiff), "github_file_diff")] +[JsonDerivedType(typeof(PushAttachmentGitHubTreeComparison), "github_tree_comparison")] +[JsonDerivedType(typeof(PushAttachmentGitHubUrl), "github_url")] +[JsonDerivedType(typeof(PushAttachmentGitHubFile), "github_file")] +[JsonDerivedType(typeof(PushAttachmentGitHubSnippet), "github_snippet")] +[JsonDerivedType(typeof(PushAttachmentBlob), "blob")] +[JsonDerivedType(typeof(PushAttachmentExtensionContext), "extension_context")] +public partial class PushAttachment +{ + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; +} + + +/// Optional line range to scope the attachment to a specific section of the file. +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentFileLineRange +{ + /// End line number (1-based, inclusive). + [JsonPropertyName("end")] + public long End { get; set; } + + /// Start line number (1-based). + [JsonPropertyName("start")] + public long Start { get; set; } +} + +/// File attachment. +/// The file variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentFile : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "file"; + + /// User-facing display name for the attachment. + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } + + /// Optional line range to scope the attachment to a specific section of the file. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("lineRange")] + public PushAttachmentFileLineRange? LineRange { get; set; } + + /// Absolute file path. + [JsonPropertyName("path")] + public required string Path { get; set; } +} + +/// Directory attachment. +/// The directory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentDirectory : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "directory"; + + /// User-facing display name for the attachment. + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } + + /// Absolute directory path. + [JsonPropertyName("path")] + public required string Path { get; set; } +} + +/// End position of the selection. +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentSelectionDetailsEnd +{ + /// End character offset within the line (0-based). + [JsonPropertyName("character")] + public long Character { get; set; } + + /// End line number (0-based). + [JsonPropertyName("line")] + public long Line { get; set; } +} + +/// Start position of the selection. +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentSelectionDetailsStart +{ + /// Start character offset within the line (0-based). + [JsonPropertyName("character")] + public long Character { get; set; } + + /// Start line number (0-based). + [JsonPropertyName("line")] + public long Line { get; set; } +} + +/// Position range of the selection within the file. +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentSelectionDetails +{ + /// End position of the selection. + [JsonPropertyName("end")] + public PushAttachmentSelectionDetailsEnd End { get => field ??= new(); set; } + + /// Start position of the selection. + [JsonPropertyName("start")] + public PushAttachmentSelectionDetailsStart Start { get => field ??= new(); set; } +} + +/// Code selection attachment from an editor. +/// The selection variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentSelection : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "selection"; + + /// User-facing display name for the selection. + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } + + /// Absolute path to the file containing the selection. + [JsonPropertyName("filePath")] + public required string FilePath { get; set; } + + /// Position range of the selection within the file. + [JsonPropertyName("selection")] + public required PushAttachmentSelectionDetails Selection { get; set; } + + /// The selected text content. + [JsonPropertyName("text")] + public required string Text { get; set; } +} + +/// GitHub issue, pull request, or discussion reference. +/// The github_reference variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubReference : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_reference"; + + /// Issue, pull request, or discussion number. + [JsonPropertyName("number")] + public required long Number { get; set; } + + /// Type of GitHub reference. + [JsonPropertyName("referenceType")] + public required PushAttachmentGitHubReferenceType ReferenceType { get; set; } + + /// Current state of the referenced item (e.g., open, closed, merged). + [JsonPropertyName("state")] + public required string State { get; set; } + + /// Title of the referenced item. + [JsonPropertyName("title")] + public required string Title { get; set; } + + /// URL to the referenced item on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a GitHub repository. +[Experimental(Diagnostics.Experimental)] +public sealed class PushGitHubRepoRef +{ + /// Numeric GitHub repository id. + [JsonPropertyName("id")] + public long? Id { get; set; } + + /// Repository name (without owner). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Repository owner login (user or organization). + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; +} + +/// Pointer to a GitHub commit. +/// The github_commit variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubCommit : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_commit"; + + /// First line of the commit message. + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// Full commit SHA. + [JsonPropertyName("oid")] + public required string Oid { get; set; } + + /// Repository the commit belongs to. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// URL to the commit on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a GitHub release. +/// The github_release variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubRelease : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_release"; + + /// Human-readable release name. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Repository the release belongs to. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// Git tag the release is anchored to. + [JsonPropertyName("tagName")] + public required string TagName { get; set; } + + /// URL to the release on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a GitHub Actions job. +/// The github_actions_job variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubActionsJob : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_actions_job"; + + /// Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("conclusion")] + public string? Conclusion { get; set; } + + /// Job id within the workflow run. + [JsonPropertyName("jobId")] + public required long JobId { get; set; } + + /// Display name of the job. + [JsonPropertyName("jobName")] + public required string JobName { get; set; } + + /// Repository the workflow run belongs to. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// URL to the job on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } + + /// Display name of the workflow the job ran in. + [JsonPropertyName("workflowName")] + public required string WorkflowName { get; set; } +} + +/// Pointer to a GitHub repository. +/// The github_repository variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubRepository : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_repository"; + + /// Short description of the repository. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ref")] + public string? Ref { get; set; } + + /// Repository pointer. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// URL to the repository on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// One side of a file diff (head or base). +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentGitHubFileDiffSide +{ + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Git ref (branch, tag, or commit SHA) the file is read at. + [JsonPropertyName("ref")] + public string Ref { get; set; } = string.Empty; + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public PushGitHubRepoRef Repo { get => field ??= new(); set; } +} + +/// Pointer to a single-file diff. At least one of `head` and `base` must be present. +/// The github_file_diff variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubFileDiff : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_file_diff"; + + /// File location on the base side of the diff. Absent for additions. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("base")] + public PushAttachmentGitHubFileDiffSide? Base { get; set; } + + /// File location on the head side of the diff. Absent for deletions. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("head")] + public PushAttachmentGitHubFileDiffSide? Head { get; set; } + + /// URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL). + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// One side of a tree comparison (head or base). +[Experimental(Diagnostics.Experimental)] +public sealed class PushAttachmentGitHubTreeComparisonSide +{ + /// Repository the revision belongs to. + [JsonPropertyName("repo")] + public PushGitHubRepoRef Repo { get => field ??= new(); set; } + + /// Git revision (branch, tag, or commit SHA). + [JsonPropertyName("revision")] + public string Revision { get; set; } = string.Empty; +} + +/// Pointer to a comparison between two git revisions. +/// The github_tree_comparison variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubTreeComparison : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_tree_comparison"; + + /// Base side of the comparison. + [JsonPropertyName("base")] + public required PushAttachmentGitHubTreeComparisonSide Base { get; set; } + + /// Head side of the comparison. + [JsonPropertyName("head")] + public required PushAttachmentGitHubTreeComparisonSide Head { get; set; } + + /// URL to the comparison on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Generic GitHub URL reference. +/// The github_url variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubUrl : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_url"; + + /// URL to the GitHub resource. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a file in a GitHub repository at a specific ref. +/// The github_file variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubFile : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_file"; + + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } + + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { get; set; } + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// URL to the file on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a line range inside a file in a GitHub repository. +/// The github_snippet variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentGitHubSnippet : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "github_snippet"; + + /// Line range the snippet covers. + [JsonPropertyName("lineRange")] + public required PushAttachmentFileLineRange LineRange { get; set; } + + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } + + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { get; set; } + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required PushGitHubRepoRef Repo { get; set; } + + /// URL to the snippet on GitHub (with line anchor). + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Blob attachment with inline base64-encoded data. +/// The blob variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentBlob : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "blob"; + + /// Base64-encoded content. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// User-facing display name for the attachment. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } + + /// MIME type of the inline data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } +} + +/// Slim input shape for extension_context attachments; identity fields are runtime-derived. +/// The extension_context variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PushAttachmentExtensionContext : PushAttachment +{ + /// + [JsonIgnore] + public override string Type => "extension_context"; + + /// Caller-supplied JSON payload (required, may be null but not undefined). + [JsonPropertyName("payload")] + public required JsonElement Payload { get; set; } + + /// Human-readable composer pill label. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("title")] + public required string Title { get; set; } +} + +/// Parameters for session.extensions.sendAttachmentsToMessage. +[Experimental(Diagnostics.Experimental)] +internal sealed class SendAttachmentsToMessageParams +{ + /// Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape. + [JsonPropertyName("attachments")] + public IList Attachments { get => field ??= []; set; } + + /// Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment. + [JsonPropertyName("instanceId")] + public string? InstanceId { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the external tool call result was handled successfully. +[Experimental(Diagnostics.Experimental)] +public sealed class HandlePendingToolCallResult +{ + /// Whether the tool call result was handled successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Pending external tool call request ID, with the tool result or an error describing why it failed. +[Experimental(Diagnostics.Experimental)] +internal sealed class HandlePendingToolCallRequest +{ + /// Error message if the tool call failed. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Request ID of the pending tool call. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Tool call result (string or expanded result object). + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +[Experimental(Diagnostics.Experimental)] +public sealed class ToolsInitializeAndValidateResult +{ +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionToolsInitializeAndValidateRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Lightweight metadata for a currently initialized session tool. +[Experimental(Diagnostics.Experimental)] +public sealed class CurrentToolMetadata +{ + /// Whether the tool is loaded on demand via tool search. + [JsonPropertyName("deferLoading")] + public bool? DeferLoading { get; set; } + + /// Tool description. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// JSON Schema for tool input. + [JsonPropertyName("input_schema")] + public IDictionary? InputSchema { get; set; } + + /// MCP server name for MCP-backed tools. + [JsonPropertyName("mcpServerName")] + public string? McpServerName { get; set; } + + /// Raw MCP tool name for MCP-backed tools. + [JsonPropertyName("mcpToolName")] + public string? McpToolName { get; set; } + + /// Model-facing tool name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Optional MCP/config namespaced tool name. + [JsonPropertyName("namespacedName")] + public string? NamespacedName { get; set; } +} + +/// Current lightweight tool metadata snapshot for the session. +[Experimental(Diagnostics.Experimental)] +public sealed class ToolsGetCurrentMetadataResult +{ + /// Current tool metadata, or null when tools have not been initialized yet. + [JsonPropertyName("tools")] + public IList? Tools { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionToolsGetCurrentMetadataRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Empty result after applying subagent settings. +[Experimental(Diagnostics.Experimental)] +public sealed class ToolsUpdateSubagentSettingsResult +{ +} + +/// Subagent model, reasoning effort, and context tier settings. +[Experimental(Diagnostics.Experimental)] +public sealed class SubagentSettingsEntry +{ + /// Context tier override for matching subagents. + [JsonPropertyName("contextTier")] + public SubagentSettingsEntryContextTier? ContextTier { get; set; } + + /// Reasoning effort override for matching subagents. + [JsonPropertyName("effortLevel")] + public string? EffortLevel { get; set; } + + /// Model override for matching subagents. + [JsonPropertyName("model")] + public string? Model { get; set; } +} + +/// Configured per-agent subagent overrides. +public sealed class UpdateSubagentSettingsRequestSubagents +{ + /// Per-agent settings keyed by subagent agent_type. + [JsonPropertyName("agents")] + public IDictionary? Agents { get; set; } + + /// Names of subagents the user has turned off; they cannot be dispatched. + [JsonPropertyName("disabledSubagents")] + public IList? DisabledSubagents { get; set; } + + /// Maximum number of subagents that can run concurrently; applies to usage-based billing users only. + [JsonPropertyName("maxConcurrency")] + public int? MaxConcurrency { get; set; } + + /// Maximum subagent nesting depth; applies to usage-based billing users only. + [JsonPropertyName("maxDepth")] + public int? MaxDepth { get; set; } +} + +/// Subagent settings to apply to the current session. +[Experimental(Diagnostics.Experimental)] +internal sealed class UpdateSubagentSettingsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Subagent settings to apply, or null to clear the live session override. + [JsonPropertyName("subagents")] + public UpdateSubagentSettingsRequestSubagents? Subagents { get; set; } +} + +/// RPC data type for SessionCommandsList operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionCommandsListRequest +{ + /// Include runtime built-in commands. + [JsonPropertyName("includeBuiltins")] + public bool? IncludeBuiltins { get; set; } + + /// Include commands registered by protocol clients, including SDK clients and extensions. + [JsonPropertyName("includeClientCommands")] + public bool? IncludeClientCommands { get; set; } + + /// Include enabled user-invocable skills and commands. + [JsonPropertyName("includeSkills")] + public bool? IncludeSkills { get; set; } +} + +/// RPC data type for SessionCommandsListRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionCommandsListRequestWithSession +{ + /// Include runtime built-in commands. + [JsonPropertyName("includeBuiltins")] + public bool? IncludeBuiltins { get; set; } + + /// Include commands registered by protocol clients, including SDK clients and extensions. + [JsonPropertyName("includeClientCommands")] + public bool? IncludeClientCommands { get; set; } + + /// Include enabled user-invocable skills and commands. + [JsonPropertyName("includeSkills")] + public bool? IncludeSkills { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(SlashCommandInvocationResultText), "text")] +[JsonDerivedType(typeof(SlashCommandInvocationResultAgentPrompt), "agent-prompt")] +[JsonDerivedType(typeof(SlashCommandInvocationResultCompleted), "completed")] +[JsonDerivedType(typeof(SlashCommandInvocationResultSelectSubcommand), "select-subcommand")] +public partial class SlashCommandInvocationResult +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. +/// The text variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SlashCommandInvocationResultText : SlashCommandInvocationResult +{ + /// + [JsonIgnore] + public override string Kind => "text"; + + /// Whether text contains Markdown. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("markdown")] + public bool? Markdown { get; set; } + + /// Whether ANSI sequences should be preserved. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("preserveAnsi")] + public bool? PreserveAnsi { get; set; } + + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } + + /// Text output for the client to render. + [JsonPropertyName("text")] + public required string Text { get; set; } +} + +/// Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. +/// The agent-prompt variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SlashCommandInvocationResultAgentPrompt : SlashCommandInvocationResult +{ + /// + [JsonIgnore] + public override string Kind => "agent-prompt"; + + /// Prompt text to display to the user. + [JsonPropertyName("displayPrompt")] + public required string DisplayPrompt { get; set; } + + /// Optional target session mode for the agent prompt. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mode")] + public SessionMode? Mode { get; set; } + + /// Optional user-facing notice to show before the prompt is submitted. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("notice")] + public string? Notice { get; set; } + + /// Prompt to submit to the agent. + [JsonPropertyName("prompt")] + public required string Prompt { get; set; } + + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } +} + +/// Slash-command invocation result indicating completion, with optional message and settings-change flag. +/// The completed variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SlashCommandInvocationResultCompleted : SlashCommandInvocationResult +{ + /// + [JsonIgnore] + public override string Kind => "completed"; + + /// Optional user-facing message describing the completed command. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("message")] + public string? Message { get; set; } + + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } +} + +/// Selectable slash-command subcommand option with name, description, and optional group label. +[Experimental(Diagnostics.Experimental)] +public sealed class SlashCommandSelectSubcommandOption +{ + /// Human-readable description of the subcommand. + [JsonPropertyName("description")] + public string Description { get; set; } = string.Empty; + + /// Optional group label for organizing options. + [JsonPropertyName("group")] + public string? Group { get; set; } + + /// Subcommand name to invoke. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; +} + +/// Slash-command invocation result asking the client to present subcommand options for a parent command. +/// The select-subcommand variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SlashCommandInvocationResultSelectSubcommand : SlashCommandInvocationResult +{ + /// + [JsonIgnore] + public override string Kind => "select-subcommand"; + + /// Parent command name that requires subcommand selection. + [JsonPropertyName("command")] + public required string Command { get; set; } + + /// Available subcommand options for the client to present. + [JsonPropertyName("options")] + public required IList Options { get; set; } + + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("runtimeSettingsChanged")] + public bool? RuntimeSettingsChanged { get; set; } + + /// Human-readable title for the selection UI. + [JsonPropertyName("title")] + public required string Title { get; set; } +} + +/// Slash command name and optional raw input string to invoke. +[Experimental(Diagnostics.Experimental)] +internal sealed class CommandsInvokeRequest +{ + /// Raw input after the command name. + [JsonPropertyName("input")] + public string? Input { get; set; } + + /// Command name. Leading slashes are stripped and the name is matched case-insensitively. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the pending client-handled command was completed successfully. +[Experimental(Diagnostics.Experimental)] +public sealed class CommandsHandlePendingCommandResult +{ + /// Whether the command was handled successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Pending command request ID and an optional error if the client handler failed. +[Experimental(Diagnostics.Experimental)] +internal sealed class CommandsHandlePendingCommandRequest +{ + /// Error message if the command handler failed. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Request ID from the command invocation event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Error message produced while executing the command, if any. +[Experimental(Diagnostics.Experimental)] +public sealed class ExecuteCommandResult +{ + /// Error message produced while executing the command, if any. Omitted when the handler succeeded. + [JsonPropertyName("error")] + public string? Error { get; set; } +} + +/// Slash command name and argument string to execute synchronously. +[Experimental(Diagnostics.Experimental)] +internal sealed class ExecuteCommandParams +{ + /// Argument string to pass to the command (empty string if none). + [JsonPropertyName("args")] + public string Args { get; set; } = string.Empty; + + /// Name of the slash command to invoke (without the leading '/'). + [JsonPropertyName("commandName")] + public string CommandName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the command was accepted into the local execution queue. +[Experimental(Diagnostics.Experimental)] +public sealed class EnqueueCommandResult +{ + /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). + [JsonPropertyName("queued")] + public bool Queued { get; set; } +} + +/// Slash-prefixed command string to enqueue for FIFO processing. +[Experimental(Diagnostics.Experimental)] +internal sealed class EnqueueCommandParams +{ + /// Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. + [JsonPropertyName("command")] + public string Command { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the queued-command response was matched to a pending request. +[Experimental(Diagnostics.Experimental)] +public sealed class CommandsRespondToQueuedCommandResult +{ + /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Result of the queued command execution. +/// Data type discriminated by handled. +[Experimental(Diagnostics.Experimental)] +public partial class QueuedCommandResult +{ + /// The boolean discriminator. + [JsonPropertyName("handled")] + public bool Handled { get; set; } + + /// When true, the runtime will not process subsequent queued commands until a new request comes in. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("stopProcessingQueue")] + public bool? StopProcessingQueue { get; set; } +} + +/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). +[Experimental(Diagnostics.Experimental)] +internal sealed class CommandsRespondToQueuedCommandRequest +{ + /// Request ID from the `command.queued` event the host is responding to. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Result of the queued command execution. + [JsonPropertyName("result")] + public QueuedCommandResult Result { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Telemetry engagement ID for the session, when available. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionTelemetryEngagement +{ + /// Current telemetry engagement ID, when available. + [JsonPropertyName("engagementId")] + public string? EngagementId { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionTelemetryGetEngagementIdRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Feature override key/value pairs to attach to subsequent telemetry events from this session. +[Experimental(Diagnostics.Experimental)] +internal sealed class TelemetrySetFeatureOverridesRequest +{ + /// Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. + [JsonPropertyName("features")] + public IDictionary Features { get => field ??= new Dictionary(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Transient answer generated from current conversation context. +[Experimental(Diagnostics.Experimental)] +public sealed class UIEphemeralQueryResult +{ + /// Full assistant response text. + [JsonPropertyName("answer")] + public string Answer { get; set; } = string.Empty; +} + +/// Transient question to answer without adding it to conversation history. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIEphemeralQueryRequest +{ + /// Question to answer from the current conversation context. + [JsonPropertyName("question")] + public string Question { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// The elicitation response (accept with form values, decline, or cancel). +[Experimental(Diagnostics.Experimental)] +public sealed class UIElicitationResponse +{ + /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). + [JsonPropertyName("action")] + public UIElicitationResponseAction Action { get; set; } + + /// The form values submitted by the user (present when action is 'accept'). + [JsonPropertyName("content")] + public IDictionary? Content { get; set; } +} + +/// JSON Schema describing the form fields to present to the user. +[Experimental(Diagnostics.Experimental)] +public sealed class UIElicitationSchema +{ + /// Form field definitions, keyed by field name. + [JsonPropertyName("properties")] + public IDictionary Properties { get => field ??= new Dictionary(); set; } + + /// List of required field names. + [JsonPropertyName("required")] + public IList? Required { get; set; } + + /// Schema type indicator (always 'object'). + [JsonPropertyName("type")] + public string Type { get; set; } = string.Empty; +} + +/// Prompt message and JSON schema describing the form fields to elicit from the user. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIElicitationRequest +{ + /// Message describing what information is needed from the user. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; + + /// JSON Schema describing the form fields to present to the user. + [JsonPropertyName("requestedSchema")] + public UIElicitationSchema RequestedSchema { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +[Experimental(Diagnostics.Experimental)] +public sealed class UIElicitationResult +{ + /// Whether the response was accepted. False if the request was already resolved by another client. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingElicitationRequest +{ + /// The unique request ID from the elicitation.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// The elicitation response (accept with form values, decline, or cancel). + [JsonPropertyName("result")] + public UIElicitationResponse Result { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the pending UI request was resolved by this call. +[Experimental(Diagnostics.Experimental)] +public sealed class UIHandlePendingResult +{ + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// User response for a pending user-input request, with answer text and whether it was typed freeform. +[Experimental(Diagnostics.Experimental)] +public sealed class UIUserInputResponse +{ + /// The user's answer text. + [JsonPropertyName("answer")] + public string Answer { get; set; } = string.Empty; + + /// True if the user typed a freeform response, false if they selected a presented choice. Used by telemetry to differentiate between free text input and choice selection. + [JsonPropertyName("wasFreeform")] + public bool WasFreeform { get; set; } +} + +/// Request ID of a pending `user_input.requested` event and the user's response. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingUserInputRequest +{ + /// The unique request ID from the user_input.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// User response for a pending user-input request, with answer text and whether it was typed freeform. + [JsonPropertyName("response")] + public UIUserInputResponse Response { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +[Experimental(Diagnostics.Experimental)] +public sealed class UIHandlePendingSamplingResponse +{ +} + +/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingSamplingRequest +{ + /// The unique request ID from the sampling.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. + [JsonPropertyName("response")] + public UIHandlePendingSamplingResponse? Response { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingAutoModeSwitchRequest +{ + /// The unique request ID from the auto_mode_switch.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). + [JsonPropertyName("response")] + public UIAutoModeSwitchResponse Response { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// The user's selected action for an exhausted session limit. +[Experimental(Diagnostics.Experimental)] +public sealed class UISessionLimitsExhaustedResponse +{ + /// Action selected by the user. + [JsonPropertyName("action")] + public UISessionLimitsExhaustedResponseAction Action { get; set; } + + /// AI Credits to add to the current max when action is 'add'. + [JsonPropertyName("additionalAiCredits")] + public double? AdditionalAiCredits { get; set; } + + /// New absolute max AI Credits when action is 'set'. + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } +} + +/// Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingSessionLimitsExhaustedRequest +{ + /// The unique request ID from the session_limits_exhausted.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// The selected session-limit action. + [JsonPropertyName("response")] + public UISessionLimitsExhaustedResponse Response { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. +[Experimental(Diagnostics.Experimental)] +public sealed class UIExitPlanModeResponse +{ + /// Whether the plan was approved. + [JsonPropertyName("approved")] + public bool Approved { get; set; } + + /// Whether subsequent edits should be auto-approved without confirmation. + [JsonPropertyName("autoApproveEdits")] + public bool? AutoApproveEdits { get; set; } + + /// When true, the agent is instructed to end its turn without starting implementation so the client can restore the session model and auto-submit a fresh implementation turn on it. Set only when a distinct plan configuration (a different model, reasoning effort, or context tier) actually ran the planning turn. + [JsonPropertyName("deferImplementation")] + public bool? DeferImplementation { get; set; } + + /// Feedback from the user when they declined the plan or requested changes. + [JsonPropertyName("feedback")] + public string? Feedback { get; set; } + + /// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. + [JsonPropertyName("selectedAction")] + public UIExitPlanModeAction? SelectedAction { get; set; } +} + +/// Request ID of a pending `exit_plan_mode.requested` event and the user's response. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIHandlePendingExitPlanModeRequest +{ + /// The unique request ID from the exit_plan_mode.requested event. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. + [JsonPropertyName("response")] + public UIExitPlanModeResponse Response { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). +[Experimental(Diagnostics.Experimental)] +public sealed class UIRegisterDirectAutoModeSwitchHandlerResult +{ + /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. + [JsonPropertyName("handle")] + public string Handle { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionUiRegisterDirectAutoModeSwitchHandlerRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the handle was active and the registration count was decremented. +[Experimental(Diagnostics.Experimental)] +public sealed class UIUnregisterDirectAutoModeSwitchHandlerResult +{ + /// True if the handle was active and decremented the counter; false if the handle was unknown. + [JsonPropertyName("unregistered")] + public bool Unregistered { get; set; } +} + +/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +[Experimental(Diagnostics.Experimental)] +internal sealed class UIUnregisterDirectAutoModeSwitchHandlerRequest +{ + /// Handle previously returned by `registerDirectAutoModeSwitchHandler`. + [JsonPropertyName("handle")] + public string Handle { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsConfigureResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsConfigureAdditionalContentExclusionPolicyRuleSource +{ + /// Gets or sets the name value. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Gets or sets the type value. + [JsonPropertyName("type")] + public string Type { get; set; } = string.Empty; +} + +/// Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsConfigureAdditionalContentExclusionPolicyRule +{ + /// Gets or sets the ifAnyMatch value. + [JsonPropertyName("ifAnyMatch")] + public IList? IfAnyMatch { get; set; } + + /// Gets or sets the ifNoneMatch value. + [JsonPropertyName("ifNoneMatch")] + public IList? IfNoneMatch { get; set; } + + /// Gets or sets the paths value. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } + + /// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. + [JsonPropertyName("source")] + public PermissionsConfigureAdditionalContentExclusionPolicyRuleSource Source { get => field ??= new(); set; } +} + +/// Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsConfigureAdditionalContentExclusionPolicy +{ + /// Gets or sets the last_updated_at value. + [JsonPropertyName("last_updated_at")] + public JsonElement LastUpdatedAt { get; set; } + + /// Gets or sets the rules value. + [JsonPropertyName("rules")] + public IList Rules { get => field ??= []; set; } + + /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. + [JsonPropertyName("scope")] + public PermissionsConfigureAdditionalContentExclusionPolicyScope Scope { get; set; } +} + +/// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionPathsConfig +{ + /// Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). + [JsonPropertyName("additionalDirectories")] + public IList? AdditionalDirectories { get; set; } + + /// Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + [JsonPropertyName("includeTempDirectory")] + public bool? IncludeTempDirectory { get; set; } + + /// If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. + [JsonPropertyName("unrestricted")] + public bool? Unrestricted { get; set; } + + /// Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + [JsonPropertyName("workspacePath")] + public string? WorkspacePath { get; set; } +} + +/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionRulesSet +{ + /// Rules that auto-approve matching requests. + [JsonPropertyName("approved")] + public IList Approved { get => field ??= []; set; } + + /// Rules that auto-deny matching requests. + [JsonPropertyName("denied")] + public IList Denied { get => field ??= []; set; } +} + +/// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionUrlsConfig +{ + /// Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. + [JsonPropertyName("initialAllowed")] + public IList? InitialAllowed { get; set; } + + /// If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. + [JsonPropertyName("unrestricted")] + public bool? Unrestricted { get; set; } +} + +/// Patch of permission policy fields to apply (omit a field to leave it unchanged). +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsConfigureParams +{ + /// If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. + [JsonPropertyName("additionalContentExclusionPolicies")] + public IList? AdditionalContentExclusionPolicies { get; set; } + + /// If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. + [JsonPropertyName("approveAllReadPermissionRequests")] + public bool? ApproveAllReadPermissionRequests { get; set; } + + /// If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. + [JsonPropertyName("approveAllToolPermissionRequests")] + public bool? ApproveAllToolPermissionRequests { get; set; } + + /// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. + [JsonPropertyName("paths")] + public PermissionPathsConfig? Paths { get; set; } + + /// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. + [JsonPropertyName("rules")] + public PermissionRulesSet? Rules { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. + [JsonPropertyName("urls")] + public PermissionUrlsConfig? Urls { get; set; } +} + +/// Indicates whether the permission decision was applied; false when the request was already resolved. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionRequestResult +{ + /// Whether the permission request was handled successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Optional informational context describing how and where the permission decision was made. This does not affect permission behavior. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionDecisionContext +{ + /// Disposition of the permission request as observed by the responding client. + [JsonPropertyName("outcome")] + public PermissionDecisionOutcome Outcome { get; set; } + + /// Controlled reason or actor responsible for the response. + [JsonPropertyName("source")] + public PermissionDecisionSource Source { get; set; } + + /// Client surface that submitted the response. + [JsonPropertyName("surface")] + public PermissionDecisionSurface Surface { get; set; } +} + +/// The client's response to the pending permission prompt. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(PermissionDecisionApproveOnce), "approve-once")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSession), "approve-for-session")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocation), "approve-for-location")] +[JsonDerivedType(typeof(PermissionDecisionApprovePermanently), "approve-permanently")] +[JsonDerivedType(typeof(PermissionDecisionReject), "reject")] +[JsonDerivedType(typeof(PermissionDecisionUserNotAvailable), "user-not-available")] +[JsonDerivedType(typeof(PermissionDecisionApproved), "approved")] +[JsonDerivedType(typeof(PermissionDecisionApprovedForSession), "approved-for-session")] +[JsonDerivedType(typeof(PermissionDecisionApprovedForLocation), "approved-for-location")] +[JsonDerivedType(typeof(PermissionDecisionCancelled), "cancelled")] +[JsonDerivedType(typeof(PermissionDecisionDeniedByRules), "denied-by-rules")] +[JsonDerivedType(typeof(PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser), "denied-no-approval-rule-and-could-not-request-from-user")] +[JsonDerivedType(typeof(PermissionDecisionDeniedInteractivelyByUser), "denied-interactively-by-user")] +[JsonDerivedType(typeof(PermissionDecisionDeniedByContentExclusionPolicy), "denied-by-content-exclusion-policy")] +[JsonDerivedType(typeof(PermissionDecisionDeniedByPermissionRequestHook), "denied-by-permission-request-hook")] +public partial class PermissionDecision +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Permission-decision request variant to approve only the current permission request. +/// The approve-once variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveOnce : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approve-once"; + + /// True only when a host surfaced this request to a user who approved it. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approvedInteractively")] + public bool? ApprovedInteractively { get; set; } +} + +/// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts). +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCommands), "commands")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalRead), "read")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalWrite), "write")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcp), "mcp")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcpSampling), "mcp-sampling")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMemory), "memory")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCustomTool), "custom-tool")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalFactory), "factory")] +[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), "extension-permission-access")] +public partial class PermissionDecisionApproveForSessionApproval +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Session-scoped approval details for specific command identifiers. +/// The commands variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalCommands : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "commands"; + + /// Command identifiers covered by this approval. + [JsonPropertyName("commandIdentifiers")] + public required IList CommandIdentifiers { get; set; } +} + +/// Session-scoped approval details for read-only filesystem operations. +/// The read variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalRead : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "read"; +} + +/// Session-scoped approval details for filesystem write operations. +/// The write variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalWrite : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "write"; +} + +/// Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. +/// The mcp variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalMcp : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "mcp"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } + + /// MCP tool name, or null to cover every tool on the server. + [JsonPropertyName("toolName")] + public string? ToolName { get; set; } +} + +/// Session-scoped approval details for MCP sampling requests from a server. +/// The mcp-sampling variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalMcpSampling : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "mcp-sampling"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Session-scoped approval details for writes to long-term memory. +/// The memory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalMemory : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "memory"; +} + +/// Session-scoped approval details for a custom tool, keyed by tool name. +/// The custom-tool variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalCustomTool : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "custom-tool"; + + /// Custom tool name. + [JsonPropertyName("toolName")] + public required string ToolName { get; set; } +} + +/// Session-scoped approval details for extension-management operations, optionally narrowed by operation. +/// The extension-management variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalExtensionManagement : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-management"; + + /// Optional operation identifier; when omitted, the approval covers all extension management operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("operation")] + public string? Operation { get; set; } +} + +/// Session-scoped factory approval, optionally narrowed by approval key. +/// The factory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalFactory : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approvalKey")] + public string? ApprovalKey { get; set; } +} + +/// Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. +/// The extension-permission-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess : PermissionDecisionApproveForSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-permission-access"; + + /// Extension name. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } +} + +/// Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. +/// The approve-for-session variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForSession : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approve-for-session"; + + /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approval")] + public PermissionDecisionApproveForSessionApproval? Approval { get; set; } + + /// URL domain to approve for the rest of the session (URL prompts only). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("domain")] + public string? Domain { get; set; } +} + +/// Approval to persist for this location. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCommands), "commands")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalRead), "read")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalWrite), "write")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcp), "mcp")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcpSampling), "mcp-sampling")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMemory), "memory")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCustomTool), "custom-tool")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalFactory), "factory")] +[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess), "extension-permission-access")] +public partial class PermissionDecisionApproveForLocationApproval +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Location-scoped approval details for specific command identifiers. +/// The commands variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalCommands : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "commands"; + + /// Command identifiers covered by this approval. + [JsonPropertyName("commandIdentifiers")] + public required IList CommandIdentifiers { get; set; } +} + +/// Location-scoped approval details for read-only filesystem operations. +/// The read variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalRead : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "read"; +} + +/// Location-scoped approval details for filesystem write operations. +/// The write variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalWrite : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "write"; +} + +/// Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. +/// The mcp variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalMcp : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "mcp"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } + + /// MCP tool name, or null to cover every tool on the server. + [JsonPropertyName("toolName")] + public string? ToolName { get; set; } +} + +/// Location-scoped approval details for MCP sampling requests from a server. +/// The mcp-sampling variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalMcpSampling : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "mcp-sampling"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Location-scoped approval details for writes to long-term memory. +/// The memory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalMemory : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "memory"; +} + +/// Location-scoped approval details for a custom tool, keyed by tool name. +/// The custom-tool variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalCustomTool : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "custom-tool"; + + /// Custom tool name. + [JsonPropertyName("toolName")] + public required string ToolName { get; set; } +} + +/// Location-scoped approval details for extension-management operations, optionally narrowed by operation. +/// The extension-management variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalExtensionManagement : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-management"; + + /// Optional operation identifier; when omitted, the approval covers all extension management operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("operation")] + public string? Operation { get; set; } +} + +/// Location-scoped factory approval, optionally narrowed by approval key. +/// The factory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalFactory : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approvalKey")] + public string? ApprovalKey { get; set; } +} + +/// Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. +/// The extension-permission-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess : PermissionDecisionApproveForLocationApproval +{ + /// + [JsonIgnore] + public override string Kind => "extension-permission-access"; + + /// Extension name. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } +} + +/// Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. +/// The approve-for-location variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproveForLocation : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approve-for-location"; + + /// Approval to persist for this location. + [JsonPropertyName("approval")] + public required PermissionDecisionApproveForLocationApproval Approval { get; set; } + + /// Location key (git root or cwd) to persist the approval to. + [JsonPropertyName("locationKey")] + public required string LocationKey { get; set; } +} + +/// Permission-decision request variant to permanently approve a URL domain across sessions. +/// The approve-permanently variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApprovePermanently : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approve-permanently"; + + /// URL domain to approve permanently. + [JsonPropertyName("domain")] + public required string Domain { get; set; } +} + +/// Permission-decision request variant to reject a pending permission request, with optional feedback. +/// The reject variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionReject : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "reject"; + + /// Optional feedback explaining the rejection. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("feedback")] + public string? Feedback { get; set; } +} + +/// Permission-decision variant indicating no user was available to confirm the request. +/// The user-not-available variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionUserNotAvailable : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "user-not-available"; +} + +/// Permission-decision variant indicating the request was approved. +/// The approved variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApproved : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approved"; +} + +/// Permission-decision variant indicating approval was remembered for the session, with approval details. +/// The approved-for-session variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApprovedForSession : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approved-for-session"; + + /// The approval to add as a session-scoped rule. + [JsonPropertyName("approval")] + public required UserToolSessionApproval Approval { get; set; } +} + +/// Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. +/// The approved-for-location variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionApprovedForLocation : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "approved-for-location"; + + /// The approval to persist for this location. + [JsonPropertyName("approval")] + public required UserToolSessionApproval Approval { get; set; } + + /// The location key (git root or cwd) to persist the approval to. + [JsonPropertyName("locationKey")] + public required string LocationKey { get; set; } +} + +/// Permission-decision variant indicating the request was cancelled before use, with an optional reason. +/// The cancelled variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionCancelled : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "cancelled"; + + /// Optional explanation of why the request was cancelled. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reason")] + public string? Reason { get; set; } +} + +/// Permission-decision variant indicating explicit denial by permission rules, with the matching rules. +/// The denied-by-rules variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionDeniedByRules : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "denied-by-rules"; + + /// Rules that denied the request. + [JsonPropertyName("rules")] + public required IList Rules { get; set; } +} + +/// Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. +/// The denied-no-approval-rule-and-could-not-request-from-user variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "denied-no-approval-rule-and-could-not-request-from-user"; +} + +/// Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. +/// The denied-interactively-by-user variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionDeniedInteractivelyByUser : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "denied-interactively-by-user"; + + /// Optional feedback from the user explaining the denial. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("feedback")] + public string? Feedback { get; set; } + + /// Whether to force-reject the current agent turn. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("forceReject")] + public bool? ForceReject { get; set; } +} + +/// Permission-decision variant indicating denial by content-exclusion policy, with path and message. +/// The denied-by-content-exclusion-policy variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionDeniedByContentExclusionPolicy : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "denied-by-content-exclusion-policy"; + + /// Human-readable explanation of why the path was excluded. + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// File path that triggered the exclusion. + [JsonPropertyName("path")] + public required string Path { get; set; } +} + +/// Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. +/// The denied-by-permission-request-hook variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionDecisionDeniedByPermissionRequestHook : PermissionDecision +{ + /// + [JsonIgnore] + public override string Kind => "denied-by-permission-request-hook"; + + /// Whether to interrupt the current agent turn. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interrupt")] + public bool? Interrupt { get; set; } + + /// Optional message from the hook explaining the denial. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("message")] + public string? Message { get; set; } +} + +/// Pending permission request ID and the decision to apply (approve/reject and scope). +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionDecisionRequest +{ + /// Optional informational context describing how and where this response was made. Omit it to preserve legacy behavior without attributing an origin. + [JsonPropertyName("decisionContext")] + public PermissionDecisionContext? DecisionContext { get; set; } + + /// Request ID of the pending permission request. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// The client's response to the pending permission prompt. + [JsonPropertyName("result")] + public PermissionDecision Result { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. +[Experimental(Diagnostics.Experimental)] +public sealed class PendingPermissionRequest +{ + /// The user-facing permission prompt details (commands, write, read, mcp, url, memory, custom-tool, path, hook). + [JsonPropertyName("request")] + public PermissionPromptRequest Request { get; set; } = null!; + + /// Unique identifier for the pending permission request. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; +} + +/// List of pending permission requests reconstructed from event history. +[Experimental(Diagnostics.Experimental)] +public sealed class PendingPermissionRequestList +{ + /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. + [JsonPropertyName("items")] + public IList Items { get => field ??= []; set; } +} + +/// No parameters; returns currently-pending permission requests for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsPendingRequestsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsSetApproveAllResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Allow-all toggle for tool permission requests, with an optional telemetry source. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsSetApproveAllRequest +{ + /// Whether to auto-approve all tool permission requests. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + [JsonPropertyName("source")] + public PermissionsSetApproveAllSource? Source { get; set; } +} + +/// Indicates whether the operation succeeded and reports the post-mutation state. +[Experimental(Diagnostics.Experimental)] +public sealed class AllowAllPermissionSetResult +{ + /// Authoritative full allow-all state after the mutation. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Authoritative allow-all mode after the mutation. + [JsonPropertyName("mode")] + public PermissionsAllowAllMode? Mode { get; set; } + + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Allow-all mode to apply for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsSetAllowAllRequest +{ + /// Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`. + [JsonPropertyName("enabled")] + public bool? Enabled { get; set; } + + /// Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM auto-approval; `off` disables both. + [JsonPropertyName("mode")] + public PermissionsAllowAllMode? Mode { get; set; } + + /// Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + [JsonPropertyName("source")] + public PermissionsSetAllowAllSource? Source { get; set; } +} + +/// Current allow-all permission mode. +[Experimental(Diagnostics.Experimental)] +public sealed class AllowAllPermissionState +{ + /// Whether full allow-all permissions are currently active. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Current allow-all mode. + [JsonPropertyName("mode")] + public PermissionsAllowAllMode? Mode { get; set; } +} + +/// No parameters. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsGetAllowAllRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsModifyRulesResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsModifyRulesParams +{ + /// Rules to add to the scope. Applied before `remove`/`removeAll`. + [JsonPropertyName("add")] + public IList? Add { get; set; } + + /// Specific rules to remove from the scope. Ignored when `removeAll` is true. + [JsonPropertyName("remove")] + public IList? Remove { get; set; } + + /// When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. + [JsonPropertyName("removeAll")] + public bool? RemoveAll { get; set; } + + /// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. + [JsonPropertyName("scope")] + public PermissionsModifyRulesScope Scope { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsSetRequiredResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Toggles whether permission prompts should be bridged into session events for this client. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsSetRequiredRequest +{ + /// Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). + [JsonPropertyName("required")] + public bool Required { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsResetSessionApprovalsResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Clears session-scoped tool permission approvals, and optionally the location-scoped ones. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsResetSessionApprovalsRequest +{ + /// Whether location-scoped approvals are cleared too. Defaults to `true`. + [JsonPropertyName("includeLocation")] + public bool? IncludeLocation { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsNotifyPromptShownResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Notification payload describing the permission prompt that the client just rendered. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionPromptShownNotification +{ + /// Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Snapshot of the session's allow-listed directories and primary working directory. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionPathsList +{ + /// All directories currently allowed for tool access on this session. + [JsonPropertyName("directories")] + public IList Directories { get => field ??= []; set; } + + /// The primary working directory for this session. + [JsonPropertyName("primary")] + public string Primary { get; set; } = string.Empty; +} + +/// No parameters; returns the session's allow-listed directories. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionsPathsListRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsPathsAddResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Directory path to add to the session's allowed directories. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionPathsAddParams +{ + /// Directory to add to the allow-list. The runtime resolves and validates the path before adding. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsPathsUpdatePrimaryResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Directory path to set as the session's new primary working directory. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionPathsUpdatePrimaryParams +{ + /// Directory to set as the new primary working directory for the session's permission policy. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the supplied path is within the session's allowed directories. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionPathsAllowedCheckResult +{ + /// Whether the path is within the session's allowed directories. + [JsonPropertyName("allowed")] + public bool Allowed { get; set; } +} + +/// Path to evaluate against the session's allowed directories. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionPathsAllowedCheckParams +{ + /// Path to check against the session's allowed directories. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the supplied path is within the session's workspace directory. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionPathsWorkspaceCheckResult +{ + /// Whether the path is within the session workspace directory. + [JsonPropertyName("allowed")] + public bool Allowed { get; set; } +} + +/// Path to evaluate against the session's workspace (primary) directory. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionPathsWorkspaceCheckParams +{ + /// Path to check against the session workspace directory. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Resolved location-permissions key and type. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionLocationResolveResult +{ + /// Location key used in the location-permissions store. + [JsonPropertyName("locationKey")] + public string LocationKey { get; set; } = string.Empty; + + /// Whether the location is a git repo or directory. + [JsonPropertyName("locationType")] + public PermissionLocationType LocationType { get; set; } +} + +/// Working directory to resolve into a location-permissions key. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionLocationResolveParams +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Working directory whose permission location should be resolved. + [JsonPropertyName("workingDirectory")] + public string WorkingDirectory { get; set; } = string.Empty; +} + +/// Summary of persisted location permissions applied to the session. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionLocationApplyResult +{ + /// Number of persisted allowed directories added to the live path manager. + [JsonPropertyName("appliedDirectoryCount")] + public long AppliedDirectoryCount { get; set; } + + /// Number of location-scoped rules added to the live permission service. + [JsonPropertyName("appliedRuleCount")] + public long AppliedRuleCount { get; set; } + + /// Location-scoped rules applied to the live permission service. + [JsonPropertyName("appliedRules")] + public IList AppliedRules { get => field ??= []; set; } + + /// Whether a different location was applied since the previous apply call. + [JsonPropertyName("changed")] + public bool Changed { get; set; } + + /// Location key used in the location-permissions store. + [JsonPropertyName("locationKey")] + public string LocationKey { get; set; } = string.Empty; + + /// Whether the location is a git repo or directory. + [JsonPropertyName("locationType")] + public PermissionLocationType LocationType { get; set; } +} + +/// Working directory to load persisted location permissions for. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionLocationApplyParams +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Working directory whose persisted location permissions should be applied. + [JsonPropertyName("workingDirectory")] + public string WorkingDirectory { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsLocationsAddToolApprovalResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Tool approval to persist and apply. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsCommands), "commands")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsRead), "read")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsWrite), "write")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMcp), "mcp")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMcpSampling), "mcp-sampling")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMemory), "memory")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsCustomTool), "custom-tool")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsFactory), "factory")] +[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess), "extension-permission-access")] +public partial class PermissionsLocationsAddToolApprovalDetails +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Location-persisted tool approval details for specific command identifiers. +/// The commands variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsCommands : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "commands"; + + /// Command identifiers covered by this approval. + [JsonPropertyName("commandIdentifiers")] + public required IList CommandIdentifiers { get; set; } +} + +/// Location-persisted tool approval details for read-only filesystem operations. +/// The read variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsRead : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "read"; +} + +/// Location-persisted tool approval details for filesystem write operations. +/// The write variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsWrite : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "write"; +} + +/// Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. +/// The mcp variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsMcp : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "mcp"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } + + /// MCP tool name, or null to cover every tool on the server. + [JsonPropertyName("toolName")] + public string? ToolName { get; set; } +} + +/// Location-persisted tool approval details for MCP sampling requests from a server. +/// The mcp-sampling variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsMcpSampling : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "mcp-sampling"; + + /// MCP server name. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Location-persisted tool approval details for writes to long-term memory. +/// The memory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsMemory : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "memory"; +} + +/// Location-persisted tool approval details for a custom tool, keyed by tool name. +/// The custom-tool variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsCustomTool : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "custom-tool"; + + /// Custom tool name. + [JsonPropertyName("toolName")] + public required string ToolName { get; set; } +} + +/// Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. +/// The extension-management variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsExtensionManagement : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "extension-management"; + + /// Optional operation identifier; when omitted, the approval covers all extension management operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("operation")] + public string? Operation { get; set; } +} + +/// Location-persisted factory approval, optionally narrowed by approval key. +/// The factory variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsFactory : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approvalKey")] + public string? ApprovalKey { get; set; } +} + +/// Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. +/// The extension-permission-access variant of . +[Experimental(Diagnostics.Experimental)] +public partial class PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess : PermissionsLocationsAddToolApprovalDetails +{ + /// + [JsonIgnore] + public override string Kind => "extension-permission-access"; + + /// Extension name. + [JsonPropertyName("extensionName")] + public required string ExtensionName { get; set; } +} + +/// Location-scoped tool approval to persist. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionLocationAddToolApprovalParams +{ + /// Tool approval to persist and apply. + [JsonPropertyName("approval")] + public PermissionsLocationsAddToolApprovalDetails Approval { get => field ??= new(); set; } + + /// Location key (git root or cwd) to persist the approval to. + [JsonPropertyName("locationKey")] + public string LocationKey { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Folder trust check result. +[Experimental(Diagnostics.Experimental)] +public sealed class FolderTrustCheckResult +{ + /// Whether the folder is trusted. + [JsonPropertyName("trusted")] + public bool Trusted { get; set; } +} + +/// Folder path to check for trust. +[Experimental(Diagnostics.Experimental)] +internal sealed class FolderTrustCheckParams +{ + /// Folder path to check. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsFolderTrustAddTrustedResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Folder path to add to trusted folders. +[Experimental(Diagnostics.Experimental)] +internal sealed class FolderTrustAddParams +{ + /// Folder path to mark as trusted. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class PermissionsUrlsSetUnrestrictedModeResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Whether the URL-permission policy should run in unrestricted mode. +[Experimental(Diagnostics.Experimental)] +internal sealed class PermissionUrlsSetUnrestrictedModeParams +{ + /// Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// The repository the remote session targets. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataSnapshotRemoteMetadataRepository +{ + /// The branch the remote session is operating on. + [JsonPropertyName("branch")] + public string Branch { get; set; } = string.Empty; + + /// The GitHub repository name (without owner). + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// The GitHub owner (user or organization) of the target repository. + [JsonPropertyName("owner")] + public string Owner { get; set; } = string.Empty; +} + +/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataSnapshotRemoteMetadata +{ + /// The pull request number the remote session is associated with, if any. + [JsonPropertyName("pullRequestNumber")] + public long? PullRequestNumber { get; set; } + + /// The repository the remote session targets. + [JsonPropertyName("repository")] + public MetadataSnapshotRemoteMetadataRepository Repository { get => field ??= new(); set; } + + /// The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. + [JsonPropertyName("resourceId")] + public string? ResourceId { get; set; } + + /// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. + [JsonPropertyName("taskType")] + public MetadataSnapshotRemoteMetadataTaskType? TaskType { get; set; } +} + +/// Public-facing projection of workspace metadata for SDK / TUI consumers. +public sealed class SessionMetadataSnapshotWorkspace +{ + /// Branch checked out at session start, if any. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// ISO 8601 timestamp when the workspace was created. + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + + /// Current working directory at session start. + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } + + /// Resolved git root for cwd, if any. + [JsonPropertyName("git_root")] + public string? GitRoot { get; set; } + + /// Repository host type, if known. + [JsonPropertyName("host_type")] + public WorkspaceSummaryHostType? HostType { get; set; } + + /// Workspace identifier (1:1 with sessionId). + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Display name for the session, if set. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any. + [JsonPropertyName("repository")] + public string? Repository { get; set; } + + /// ISO 8601 timestamp when the workspace was last updated. + [JsonPropertyName("updated_at")] + public DateTimeOffset? UpdatedAt { get; set; } + + /// Whether the display name was explicitly set by the user. + [JsonPropertyName("user_named")] + public bool? UserNamed { get; set; } +} + +/// Point-in-time snapshot of slow-changing session identifier and state fields. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionMetadataSnapshot +{ + /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. + [JsonPropertyName("alreadyInUse")] + public bool AlreadyInUse { get; set; } + + /// Runtime client name associated with the session (telemetry identifier). + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } + + /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). + [JsonPropertyName("currentMode")] + public MetadataSnapshotCurrentMode CurrentMode { get; set; } + + /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. + [JsonPropertyName("initialName")] + public string? InitialName { get; set; } + + /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process). + [JsonPropertyName("isRemote")] + public bool IsRemote { get; set; } + + /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. + [JsonPropertyName("modifiedTime")] + public DateTimeOffset ModifiedTime { get; set; } + + /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + [JsonPropertyName("remoteMetadata")] + public MetadataSnapshotRemoteMetadata? RemoteMetadata { get; set; } + + /// Currently selected model identifier, if any. + [JsonPropertyName("selectedModel")] + public string? SelectedModel { get; set; } + + /// The unique identifier of the session. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Current session limits, or null when no limits are active. + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { get; set; } + + /// ISO 8601 timestamp of when the session started. + [JsonPropertyName("startTime")] + public DateTimeOffset StartTime { get; set; } + + /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. + [JsonPropertyName("summary")] + public string? Summary { get; set; } + + /// Absolute path to the session's current working directory. + [JsonPropertyName("workingDirectory")] + public string WorkingDirectory { get; set; } = string.Empty; + + /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). + [JsonPropertyName("workspace")] + public SessionMetadataSnapshotWorkspace? Workspace { get; set; } + + /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace. + [JsonPropertyName("workspacePath")] + public string? WorkspacePath { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMetadataSnapshotRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the local session is currently processing a turn or background continuation. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataIsProcessingResult +{ + /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. + [JsonPropertyName("processing")] + public bool Processing { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMetadataIsProcessingRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Current activity flags for the session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionActivity +{ + /// Whether an in-flight operation can currently be aborted. + [JsonPropertyName("abortable")] + public bool Abortable { get; set; } + + /// Whether the session currently has active work, including running turns or tasks. + [JsonPropertyName("hasActiveWork")] + public bool HasActiveWork { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMetadataActivityRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Token-usage breakdown for the session's current context window. +public sealed class MetadataContextInfoResultContextInfo +{ + /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%). + [JsonPropertyName("bufferTokens")] + public long BufferTokens { get; set; } + + /// Token count at which background compaction starts (configurable percentage of promptTokenLimit). + [JsonPropertyName("compactionThreshold")] + public long CompactionThreshold { get; set; } + + /// Tokens consumed by user/assistant/tool messages. + [JsonPropertyName("conversationTokens")] + public long ConversationTokens { get; set; } + + /// Prompt token limit plus the model's full output token limit. + [JsonPropertyName("limit")] + public long Limit { get; set; } + + /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools). + [JsonPropertyName("mcpToolsTokens")] + public long McpToolsTokens { get; set; } + + /// The model used for token counting. + [JsonPropertyName("modelName")] + public string ModelName { get; set; } = string.Empty; + + /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified). + [JsonPropertyName("promptTokenLimit")] + public long PromptTokenLimit { get; set; } + + /// Tokens consumed by the system prompt. + [JsonPropertyName("systemTokens")] + public long SystemTokens { get; set; } + + /// Tokens consumed by tool definitions sent to the model (excludes deferred tools). + [JsonPropertyName("toolDefinitionsTokens")] + public long ToolDefinitionsTokens { get; set; } + + /// Sum of system, conversation and tool-definition tokens. + [JsonPropertyName("totalTokens")] + public long TotalTokens { get; set; } +} + +/// Token breakdown for the session's current context window, or null if uninitialized. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataContextInfoResult +{ + /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + [JsonPropertyName("contextInfo")] + public MetadataContextInfoResultContextInfo? ContextInfo { get; set; } +} + +/// Model identifier and token limits used to compute the context-info breakdown. +[Experimental(Diagnostics.Experimental)] +internal sealed class MetadataContextInfoRequest +{ + /// Maximum output tokens allowed by the target model. Pass 0 if unknown. + [JsonPropertyName("outputTokenLimit")] + public long OutputTokenLimit { get; set; } + + /// Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. + [JsonPropertyName("promptTokenLimit")] + public long PromptTokenLimit { get; set; } + + /// Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. + [JsonPropertyName("selectedModel")] + public string? SelectedModel { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. +public sealed class MetadataContextAttributionResultContextAttributionCategories +{ + /// Output reserve plus post-blocking-threshold buffer. + [JsonPropertyName("buffer")] + public long Buffer { get; set; } + + /// Custom-instructions tokens (0 when none are configured). + [JsonPropertyName("customInstructions")] + public long CustomInstructions { get; set; } + + /// Remaining unused window capacity (clamped at 0). + [JsonPropertyName("freeSpace")] + public long FreeSpace { get; set; } + + /// MCP tool-definition tokens. + [JsonPropertyName("mcpTools")] + public long McpTools { get; set; } + + /// Conversation (user/assistant/tool) message tokens. + [JsonPropertyName("messages")] + public long Messages { get; set; } + + /// System prompt tokens, excluding custom instructions. + [JsonPropertyName("systemPrompt")] + public long SystemPrompt { get; set; } + + /// Non-MCP tool-definition tokens. + [JsonPropertyName("systemTools")] + public long SystemTools { get; set; } +} + +/// Successful compaction history for the session. +public sealed class MetadataContextAttributionResultContextAttributionCompactions +{ + /// Number of successful compactions in this session. + [JsonPropertyName("count")] + public long Count { get; set; } +} + +/// RPC data type for MetadataContextAttributionResultContextAttributionEntry operations. +public sealed class MetadataContextAttributionResultContextAttributionEntry +{ + /// Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + [JsonPropertyName("attributes")] + public IDictionary? Attributes { get; set; } + + /// Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + [JsonPropertyName("kind")] + public string Kind { get; set; } = string.Empty; + + /// Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. + [JsonPropertyName("label")] + public string Label { get; set; } = string.Empty; + + /// Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. + [JsonPropertyName("parentId")] + public string? ParentId { get; set; } + + /// Token count currently in context attributable to this entry. + [JsonPropertyName("tokens")] + public long Tokens { get; set; } +} + +/// Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. +public sealed class MetadataContextAttributionResultContextAttribution +{ + /// Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. + [JsonPropertyName("bufferTokens")] + public long BufferTokens { get; set; } + + /// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. + [JsonPropertyName("categories")] + public MetadataContextAttributionResultContextAttributionCategories Categories { get => field ??= new(); set; } + + /// Successful compaction history for the session. + [JsonPropertyName("compactions")] + public MetadataContextAttributionResultContextAttributionCompactions Compactions { get => field ??= new(); set; } + + /// Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. + [JsonPropertyName("compactionThreshold")] + public long CompactionThreshold { get; set; } + + /// Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } + + /// Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. + [JsonPropertyName("limit")] + public long Limit { get; set; } + + /// The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. + [JsonPropertyName("modelId")] + public string ModelId { get; set; } = string.Empty; + + /// How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). + [JsonPropertyName("modelSource")] + public string ModelSource { get; set; } = string.Empty; + + /// Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + [JsonPropertyName("promptTokenLimit")] + public long PromptTokenLimit { get; set; } + + /// Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. + [JsonPropertyName("totalTokens")] + public long TotalTokens { get; set; } +} + +/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataContextAttributionResult +{ + /// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + [JsonPropertyName("contextAttribution")] + public MetadataContextAttributionResultContextAttribution? ContextAttribution { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionMetadataGetContextAttributionRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// A single large message currently in context. +[Experimental(Diagnostics.Experimental)] +public sealed class ContextHeaviestMessage +{ + /// Stable identifier for this message within the snapshot. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. + [JsonPropertyName("label")] + public string Label { get; set; } = string.Empty; + + /// Role of the chat message (`user`, `assistant`, or `tool`). + [JsonPropertyName("role")] + public string Role { get; set; } = string.Empty; + + /// Token count currently in context for this individual message. + [JsonPropertyName("tokens")] + public long Tokens { get; set; } +} + +/// The heaviest individual messages in the session's context window, most-expensive first. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataContextHeaviestMessagesResult +{ + /// Heaviest messages, most-expensive first. + [JsonPropertyName("messages")] + public IList Messages { get => field ??= []; set; } + + /// Total token count of the current context window, so callers can compute each message's share without a second call. + [JsonPropertyName("totalTokens")] + public long TotalTokens { get; set; } +} + +/// Parameters for the heaviest-messages query. +[Experimental(Diagnostics.Experimental)] +internal sealed class MetadataContextHeaviestMessagesRequest +{ + /// Maximum number of messages to return, most-expensive first. Omit for the server default. + [JsonPropertyName("limit")] + public long? Limit { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataRecordContextChangeResult +{ +} + +/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionWorkingDirectoryContext +{ + /// Merge-base commit SHA (fork point from the remote default branch). + [JsonPropertyName("baseCommit")] + public string? BaseCommit { get; set; } + + /// Current git branch name. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// Current working directory path. + [JsonPropertyName("cwd")] + public string Cwd { get; set; } = string.Empty; + + /// Root directory of the git repository, resolved via git rev-parse. + [JsonPropertyName("gitRoot")] + public string? GitRoot { get; set; } + + /// Head commit of the current git branch. + [JsonPropertyName("headCommit")] + public string? HeadCommit { get; set; } + + /// Hosting platform type of the repository. + [JsonPropertyName("hostType")] + public SessionWorkingDirectoryContextHostType? HostType { get; set; } + + /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps). + [JsonPropertyName("repository")] + public string? Repository { get; set; } + + /// Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com"). + [JsonPropertyName("repositoryHost")] + public string? RepositoryHost { get; set; } +} + +/// Updated working-directory/git context to record on the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class MetadataRecordContextChangeRequest +{ + /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + [JsonPropertyName("context")] + public SessionWorkingDirectoryContext Context { get => field ??= new(); set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataSetWorkingDirectoryResult +{ + /// Working directory after the update. + [JsonPropertyName("workingDirectory")] + public string WorkingDirectory { get; set; } = string.Empty; +} + +/// Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. +[Experimental(Diagnostics.Experimental)] +internal sealed class MetadataSetWorkingDirectoryRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. + [JsonPropertyName("workingDirectory")] + public string WorkingDirectory { get; set; } = string.Empty; +} + +/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. +[Experimental(Diagnostics.Experimental)] +public sealed class MetadataRecomputeContextTokensResult +{ + /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). + [JsonPropertyName("messagesTokenCount")] + public long MessagesTokenCount { get; set; } + + /// Tokens contributed by system/developer prompt snapshots. + [JsonPropertyName("systemTokenCount")] + public long SystemTokenCount { get; set; } + + /// Sum of tokens across chat-context and system-context messages currently held by the session. + [JsonPropertyName("totalTokens")] + public long TotalTokens { get; set; } +} + +/// Model identifier to use when re-tokenizing the session's existing messages. +[Experimental(Diagnostics.Experimental)] +internal sealed class MetadataRecomputeContextTokensRequest +{ + /// Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. + [JsonPropertyName("modelId")] + public string ModelId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Availability of built-in job tools surfaced to boundary consumers. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsBuiltInToolAvailabilitySnapshot +{ + /// Gets or sets the createPullRequest value. + [JsonPropertyName("createPullRequest")] + public bool? CreatePullRequest { get; set; } + + /// Gets or sets the reportProgress value. + [JsonPropertyName("reportProgress")] + public bool? ReportProgress { get; set; } +} + +/// Redacted job settings for a session. The job nonce is excluded. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsJobSnapshot +{ + /// Gets or sets the builtInToolAvailability value. + [JsonPropertyName("builtInToolAvailability")] + public SessionSettingsBuiltInToolAvailabilitySnapshot? BuiltInToolAvailability { get; set; } + + /// Gets or sets the eventType value. + [JsonPropertyName("eventType")] + public string? EventType { get; set; } + + /// Gets or sets the isTriggerJob value. + [JsonPropertyName("isTriggerJob")] + public bool? IsTriggerJob { get; set; } +} + +/// Redacted model routing settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsModelSnapshot +{ + /// Gets or sets the callbackUrl value. + [JsonPropertyName("callbackUrl")] + public string? CallbackUrl { get; set; } + + /// Gets or sets the defaultReasoningEffort value. + [JsonPropertyName("defaultReasoningEffort")] + public string? DefaultReasoningEffort { get; set; } + + /// Gets or sets the instanceId value. + [JsonPropertyName("instanceId")] + public string? InstanceId { get; set; } + + /// Gets or sets the model value. + [JsonPropertyName("model")] + public string? Model { get; set; } +} + +/// Online-evaluation settings safe to expose across the SDK boundary. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsOnlineEvaluationSnapshot +{ + /// Gets or sets the disableOnlineEvaluation value. + [JsonPropertyName("disableOnlineEvaluation")] + public bool? DisableOnlineEvaluation { get; set; } + + /// Gets or sets the enableOnlineEvaluationOutputFile value. + [JsonPropertyName("enableOnlineEvaluationOutputFile")] + public bool? EnableOnlineEvaluationOutputFile { get; set; } +} + +/// Redacted repository and GitHub host settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsRepoSnapshot +{ + /// Gets or sets the branch value. + [JsonPropertyName("branch")] + public string? Branch { get; set; } + + /// Gets or sets the commit value. + [JsonPropertyName("commit")] + public string? Commit { get; set; } + + /// Gets or sets the host value. + [JsonPropertyName("host")] + public string? Host { get; set; } + + /// Gets or sets the hostProtocol value. + [JsonPropertyName("hostProtocol")] + public string? HostProtocol { get; set; } + + /// Gets or sets the id value. + [JsonPropertyName("id")] + public double? Id { get; set; } + + /// Gets or sets the name value. + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// Gets or sets the ownerId value. + [JsonPropertyName("ownerId")] + public double? OwnerId { get; set; } + + /// Gets or sets the ownerName value. + [JsonPropertyName("ownerName")] + public string? OwnerName { get; set; } + + /// Gets or sets the prCommitCount value. + [JsonPropertyName("prCommitCount")] + public double? PrCommitCount { get; set; } + + /// Gets or sets the readWrite value. + [JsonPropertyName("readWrite")] + public bool? ReadWrite { get; set; } + + /// Gets or sets the secretScanningUrl value. + [JsonPropertyName("secretScanningUrl")] + public string? SecretScanningUrl { get; set; } + + /// Gets or sets the serverUrl value. + [JsonPropertyName("serverUrl")] + public string? ServerUrl { get; set; } +} + +/// Redacted validation and memory-tool settings for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionSettingsValidationSnapshot +{ + /// Gets or sets the advisoryEnabled value. + [JsonPropertyName("advisoryEnabled")] + public bool? AdvisoryEnabled { get; set; } + + /// Gets or sets the codeqlEnabled value. + [JsonPropertyName("codeqlEnabled")] + public bool? CodeqlEnabled { get; set; } + + /// Gets or sets the codeReviewEnabled value. + [JsonPropertyName("codeReviewEnabled")] + public bool? CodeReviewEnabled { get; set; } + + /// Gets or sets the codeReviewModel value. + [JsonPropertyName("codeReviewModel")] + public string? CodeReviewModel { get; set; } + + /// Gets or sets the dependabotTimeout value. + [JsonPropertyName("dependabotTimeout")] + public double? DependabotTimeout { get; set; } + + /// Gets or sets the memoryStoreEnabled value. + [JsonPropertyName("memoryStoreEnabled")] + public bool? MemoryStoreEnabled { get; set; } + + /// Gets or sets the memoryVoteEnabled value. + [JsonPropertyName("memoryVoteEnabled")] + public bool? MemoryVoteEnabled { get; set; } + + /// Gets or sets the secretScanningEnabled value. + [JsonPropertyName("secretScanningEnabled")] + public bool? SecretScanningEnabled { get; set; } + + /// Gets or sets the timeout value. + [JsonPropertyName("timeout")] + public double? Timeout { get; set; } +} + +/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionSettingsSnapshot +{ + /// Gets or sets the clientName value. + [JsonPropertyName("clientName")] + public string? ClientName { get; set; } + + /// Gets or sets the job value. + [JsonPropertyName("job")] + public SessionSettingsJobSnapshot Job { get => field ??= new(); set; } + + /// Gets or sets the model value. + [JsonPropertyName("model")] + public SessionSettingsModelSnapshot Model { get => field ??= new(); set; } + + /// Gets or sets the onlineEvaluation value. + [JsonPropertyName("onlineEvaluation")] + public SessionSettingsOnlineEvaluationSnapshot OnlineEvaluation { get => field ??= new(); set; } + + /// Gets or sets the repo value. + [JsonPropertyName("repo")] + public SessionSettingsRepoSnapshot Repo { get => field ??= new(); set; } + + /// Gets or sets the startTimeMs value. + [JsonPropertyName("startTimeMs")] + public double? StartTimeMs { get; set; } + + /// Gets or sets the timeoutMs value. + [JsonPropertyName("timeoutMs")] + public double? TimeoutMs { get; set; } + + /// Gets or sets the validation value. + [JsonPropertyName("validation")] + public SessionSettingsValidationSnapshot Validation { get => field ??= new(); set; } + + /// Gets or sets the version value. + [JsonPropertyName("version")] + public string? Version { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionSettingsSnapshotRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of evaluating a Rust-owned settings predicate. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionSettingsEvaluatePredicateResult +{ + /// Gets or sets the enabled value. + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } +} + +/// Named Rust-owned settings predicate to evaluate for this session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionSettingsEvaluatePredicateRequest +{ + /// Predicate name. The runtime owns the raw feature-flag names and composition logic. + [JsonPropertyName("name")] + public SessionSettingsPredicateName Name { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Tool name for tool-scoped predicates such as trivial-change handling. + [JsonPropertyName("toolName")] + public string? ToolName { get; set; } +} + +/// Content-exclusion decision for one requested path. +[Experimental(Diagnostics.Experimental)] +public sealed class ContentExclusionPathCheck +{ + /// Whether the session's complete content-exclusion policy excludes the path. + [JsonPropertyName("excluded")] + public bool Excluded { get; set; } + + /// The path supplied by the caller. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; +} + +/// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. +[Experimental(Diagnostics.Experimental)] +public sealed class ContentExclusionCheckPathsResult +{ + /// Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded. + [JsonPropertyName("available")] + public bool Available { get; set; } + + /// Per-path decisions in request order. Empty when available is false. + [JsonPropertyName("checks")] + public IList Checks { get => field ??= []; set; } +} + +/// Local file system absolute paths within the session working directory to check against its content-exclusion policy. +[Experimental(Diagnostics.Experimental)] +internal sealed class ContentExclusionCheckPathsRequest +{ + /// Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. + [JsonPropertyName("paths")] + public IList Paths { get => field ??= []; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +[Experimental(Diagnostics.Experimental)] +public sealed class ShellExecResult +{ + /// Unique identifier for tracking streamed output. + [JsonPropertyName("processId")] + public string ProcessId { get; set; } = string.Empty; +} + +/// Shell command to run, with optional working directory and timeout in milliseconds. +[Experimental(Diagnostics.Experimental)] +internal sealed class ShellExecRequest +{ + /// Shell command to execute. + [JsonPropertyName("command")] + public string Command { get; set; } = string.Empty; + + /// Working directory (defaults to session working directory). + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Timeout in milliseconds (default: 30000). + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("timeout")] + public TimeSpan? Timeout { get; set; } +} + +/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +[Experimental(Diagnostics.Experimental)] +public sealed class ShellKillResult +{ + /// Whether the signal was sent successfully. + [JsonPropertyName("killed")] + public bool Killed { get; set; } +} + +/// Identifier of a process previously returned by "shell.exec" and the signal to send. +[Experimental(Diagnostics.Experimental)] +internal sealed class ShellKillRequest +{ + /// Process identifier returned by shell.exec. + [JsonPropertyName("processId")] + public string ProcessId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Signal to send (default: SIGTERM). + [JsonPropertyName("signal")] + public ShellKillSignal? Signal { get; set; } +} + +/// Result of a user-requested shell command. +[Experimental(Diagnostics.Experimental)] +public sealed class UserRequestedShellCommandResult +{ + /// Error output when the execution failed. + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Process exit code, when available. + [JsonPropertyName("exitCode")] + public long? ExitCode { get; set; } + + /// Captured command output. + [JsonPropertyName("output")] + public string Output { get; set; } = string.Empty; + + /// Whether the command completed successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } + + /// Tool call id emitted for the shell execution. + [JsonPropertyName("toolCallId")] + public string ToolCallId { get; set; } = string.Empty; +} + +/// User-requested shell command and cancellation handle. +[Experimental(Diagnostics.Experimental)] +internal sealed class ShellExecuteUserRequestedRequest +{ + /// Shell command to execute. + [JsonPropertyName("command")] + public string Command { get; set; } = string.Empty; + + /// Caller-provided cancellation handle for this execution. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Cancellation result for a user-requested shell command. +[Experimental(Diagnostics.Experimental)] +public sealed class CancelUserRequestedShellCommandResult +{ + /// Whether an in-flight execution was found and signalled to cancel. + [JsonPropertyName("cancelled")] + public bool Cancelled { get; set; } +} + +/// User-requested shell execution cancellation handle. +[Experimental(Diagnostics.Experimental)] +internal sealed class ShellCancelUserRequestedRequest +{ + /// Request ID previously passed to executeUserRequested. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Post-compaction context window usage breakdown. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryCompactContextWindow +{ + /// Token count from non-system messages (user, assistant, tool). + [JsonPropertyName("conversationTokens")] + public long? ConversationTokens { get; set; } + + /// Current total tokens in the context window (system + conversation + tool definitions). + [JsonPropertyName("currentTokens")] + public long CurrentTokens { get; set; } + + /// Current number of messages in the conversation. + [JsonPropertyName("messagesLength")] + public long MessagesLength { get; set; } + + /// Token count from system message(s). + [JsonPropertyName("systemTokens")] + public long? SystemTokens { get; set; } + + /// Maximum token count for the model's context window. + [JsonPropertyName("tokenLimit")] + public long TokenLimit { get; set; } + + /// Token count from tool definitions. + [JsonPropertyName("toolDefinitionsTokens")] + public long? ToolDefinitionsTokens { get; set; } +} + +/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryCompactResult +{ + /// Post-compaction context window usage breakdown. + [JsonPropertyName("contextWindow")] + public HistoryCompactContextWindow? ContextWindow { get; set; } + + /// Number of messages removed during compaction. + [JsonPropertyName("messagesRemoved")] + public long MessagesRemoved { get; set; } + + /// Whether compaction completed successfully. + [JsonPropertyName("success")] + public bool Success { get; set; } + + /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + [JsonPropertyName("summaryContent")] + public string? SummaryContent { get; set; } + + /// Number of tokens freed by compaction. + [JsonPropertyName("tokensRemoved")] + public long TokensRemoved { get; set; } +} + +/// RPC data type for SessionHistoryCompact operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionHistoryCompactRequest +{ + /// Optional user-provided instructions to focus the compaction summary. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MaxLength(4000)] + [JsonPropertyName("customInstructions")] + public string? CustomInstructions { get; set; } + + /// Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. + [JsonPropertyName("tokenLimit")] + public long? TokenLimit { get; set; } + + /// What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). + [JsonPropertyName("trigger")] + public SessionHistoryCompactRequestTrigger? Trigger { get; set; } +} + +/// RPC data type for SessionHistoryCompactRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionHistoryCompactRequestWithSession +{ + /// Optional user-provided instructions to focus the compaction summary. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MaxLength(4000)] + [JsonPropertyName("customInstructions")] + public string? CustomInstructions { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. + [JsonPropertyName("tokenLimit")] + public long? TokenLimit { get; set; } + + /// What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). + [JsonPropertyName("trigger")] + public SessionHistoryCompactRequestTrigger? Trigger { get; set; } +} + +/// Number of events that were removed by the truncation. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryTruncateResult +{ + /// Failure detail when checkpointCleanupFailed is true. + [JsonPropertyName("checkpointCleanupError")] + public string? CheckpointCleanupError { get; set; } + + /// True when conversation truncation succeeded but post-truncation workspace checkpoint cleanup failed. History is already truncated; callers may still prune snapshots but should report a checkpoint-cleanup rather than a truncation failure. + [JsonPropertyName("checkpointCleanupFailed")] + public bool? CheckpointCleanupFailed { get; set; } + + /// Number of events that were removed. + [JsonPropertyName("eventsRemoved")] + public long EventsRemoved { get; set; } +} + +/// Identifier of the event to truncate to; this event and all later events are removed. +[Experimental(Diagnostics.Experimental)] +internal sealed class HistoryTruncateRequest +{ + /// Event ID to truncate to. This event and all events after it are removed from the session. + [JsonPropertyName("eventId")] + public string EventId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// A root user turn that the session can rewind to. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryRewindPoint +{ + /// Whether at least one file in this turn or a later turn can be restored. + [JsonPropertyName("canRestoreFiles")] + public bool CanRestoreFiles { get; set; } + + /// ID of the user.message event that begins the discarded suffix. + [JsonPropertyName("eventId")] + public string EventId { get; set; } = string.Empty; + + /// Number of unique files in this turn and all later turns that have captured changes. + [JsonPropertyName("fileCount")] + public long FileCount { get; set; } + + /// Whether this turn was an automatically injected autopilot continuation. + [JsonPropertyName("isAutopilotContinuation")] + public bool IsAutopilotContinuation { get; set; } + + /// Lines added by this turn's captured file changes. + [JsonPropertyName("linesAdded")] + public long LinesAdded { get; set; } + + /// Lines removed by this turn's captured file changes. + [JsonPropertyName("linesRemoved")] + public long LinesRemoved { get; set; } + + /// ISO timestamp of the user turn. + [JsonPropertyName("timestamp")] + public string Timestamp { get; set; } = string.Empty; + + /// Whether this turn itself captured any file changes. + [JsonPropertyName("turnChangedFiles")] + public bool TurnChangedFiles { get; set; } + + /// User-visible message text for the turn. + [JsonPropertyName("userMessage")] + public string UserMessage { get; set; } = string.Empty; +} + +/// Rewind points and file-change-tracking availability for the session. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryListRewindPointsResult +{ + /// Whether this session captured file changes from its first turn. + [JsonPropertyName("fileChangeTrackingEnabled")] + public bool FileChangeTrackingEnabled { get; set; } + + /// Root user turns in chronological order. Empty when `unavailableReason` is set. + [JsonPropertyName("points")] + public IList Points { get => field ??= []; set; } + + /// Why the listed points could not be produced, when applicable; the points list is empty whenever it is set. `unsupported-remote-session` is permanent for the session and comes with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the file-change captures cannot be read while work that may still mutate them is in flight; the same request succeeds once the session settles, so a client that wants points should retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an untracked local session still lists conversation-only points and reports that through `fileChangeTrackingEnabled: false`. + [JsonPropertyName("unavailableReason")] + public HistoryRewindUnavailableReason? UnavailableReason { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionHistoryListRewindPointsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// A file that a conversation-and-files rewind would restore. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryRewindFilePreview +{ + /// Aggregate change made across the discarded turns. + [JsonPropertyName("changeType")] + public HistoryRewindChangeType ChangeType { get; set; } + + /// Lines added across the discarded turns. + [JsonPropertyName("linesAdded")] + public long LinesAdded { get; set; } + + /// Lines removed across the discarded turns. + [JsonPropertyName("linesRemoved")] + public long LinesRemoved { get; set; } + + /// Absolute path of the captured file. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; +} + +/// Files and aggregate changes for a prospective rewind. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryPreviewRewindResult +{ + /// Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. + [JsonPropertyName("available")] + public bool Available { get; set; } + + /// Number of unique files in the preview. + [JsonPropertyName("fileCount")] + public long FileCount { get; set; } + + /// Files ordered by path. + [JsonPropertyName("files")] + public IList Files { get => field ??= []; set; } + + /// Why file restore is unavailable, when applicable. Populated only when `available` is false and never set when `available` is true. + [JsonPropertyName("reason")] + public HistoryRewindUnavailableReason? Reason { get; set; } +} + +/// Event boundary to preview for conversation-and-files rewind. +[Experimental(Diagnostics.Experimental)] +internal sealed class HistoryPreviewRewindRequest +{ + /// ID of the user.message event that begins the discarded suffix. + [JsonPropertyName("eventId")] + public string EventId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// A captured file that rewind intentionally left unchanged. +[Experimental(Diagnostics.Experimental)] +public sealed class HistorySkippedFileRestore +{ + /// Absolute path of the skipped file. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Reason the file was not restored. + [JsonPropertyName("reason")] + public HistoryFileRestoreSkipReason Reason { get; set; } +} + +/// Structured outcome of a rewind request. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryRewindResult +{ + /// Failure detail. Set only for the failure and partial-failure outcomes (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`). + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Number of persisted events removed by conversation truncation. Present only when truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`) and for `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + [JsonPropertyName("eventsRemoved")] + public long? EventsRemoved { get; set; } + + /// Overall rewind outcome. This discriminates the result: it governs which of the remaining fields are populated, so consumers must switch on it before reading `eventsRemoved`, `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that populate it. + [JsonPropertyName("outcome")] + public HistoryRewindOutcome Outcome { get; set; } + + /// Absolute paths restored to their captured preimages. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + [JsonPropertyName("restoredFiles")] + public IList RestoredFiles { get => field ??= []; set; } + + /// Captured files intentionally left unchanged. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + [JsonPropertyName("skippedFiles")] + public IList SkippedFiles { get => field ??= []; set; } +} + +/// Boundary and mode for rewinding session history. +[Experimental(Diagnostics.Experimental)] +internal sealed class HistoryRewindRequest +{ + /// ID of the user.message event that begins the discarded suffix. + [JsonPropertyName("eventId")] + public string EventId { get; set; } = string.Empty; + + /// Whether to rewind only conversation history or also restore captured files. + [JsonPropertyName("mode")] + public HistoryRewindMode Mode { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether an in-progress background compaction was cancelled. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryCancelBackgroundCompactionResult +{ + /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. + [JsonPropertyName("cancelled")] + public bool Cancelled { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionHistoryCancelBackgroundCompactionRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether an in-progress manual compaction was aborted. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryAbortManualCompactionResult +{ + /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. + [JsonPropertyName("aborted")] + public bool Aborted { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionHistoryAbortManualCompactionRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Markdown summary of the conversation context (empty when not available). +[Experimental(Diagnostics.Experimental)] +public sealed class HistorySummarizeForHandoffResult +{ + /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. + [JsonPropertyName("summary")] + public string Summary { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionHistorySummarizeForHandoffRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. +[Experimental(Diagnostics.Experimental)] +public sealed class HistoryClearContextResult +{ + /// Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. + [JsonPropertyName("messagesCleared")] + public long MessagesCleared { get; set; } +} + +/// Parameters for clearing the conversation and seeding the window that replaces it. +[Experimental(Diagnostics.Experimental)] +internal sealed class HistoryClearContextRequest +{ + /// First user message of the fresh context window. Required: a cleared window holding only system and developer messages is not a conversation a model can answer, so every clear seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop exits, which is why the call must be made from inside a tool handler. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. +[Experimental(Diagnostics.Experimental)] +public sealed class QueuePendingItems +{ + /// Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an explicit mode report interactive. This is not necessarily the mode that will constrain the turn: a plan or autopilot session applies its own write gate, continuation loop and permission posture to every drained item regardless of the mode stored here. + [JsonPropertyName("agentMode")] + public SendAgentMode AgentMode { get; set; } + + /// Human-readable text to display for this queue entry in the UI. + [JsonPropertyName("displayText")] + public string DisplayText { get; set; } = string.Empty; + + /// Stable opaque id for the canonical queued item. Batch rows share one id. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Whether this item is a queued user message or a queued slash command / model change. + [JsonPropertyName("kind")] + public QueuePendingItemsKind Kind { get; set; } +} + +/// Snapshot of the session's pending queued items and immediate-steering messages. +[Experimental(Diagnostics.Experimental)] +public sealed class QueuePendingItemsResult +{ + /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. + [JsonPropertyName("items")] + public IList Items { get => field ??= []; set; } + + /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + [JsonPropertyName("steeringMessages")] + public IList SteeringMessages { get => field ??= []; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueuePendingItemsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Internal snapshot of native queue state for local session orchestration. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueSnapshotResult +{ + /// Insertion orders for queued items, aligned with `items`. + [JsonPropertyName("itemOrders")] + public IList? ItemOrders { get; set; } + + /// User-facing pending items in FIFO order. + [JsonPropertyName("items")] + public IList Items { get => field ??= []; set; } + + /// Insertion orders for immediate steering messages, aligned with `steeringMessages`. + [JsonPropertyName("steeringMessageOrders")] + public IList? SteeringMessageOrders { get; set; } + + /// Immediate steering messages waiting for an active turn. + [JsonPropertyName("steeringMessages")] + public IList SteeringMessages { get => field ??= []; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueSnapshotRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of moving a queued item. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueMoveItemResult +{ + /// True when the item changed position; false when it was already at the requested position. + [JsonPropertyName("changed")] + public bool Changed { get; set; } +} + +/// Parameters for moving a queued item by stable id. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueMoveItemRequest +{ + /// Stable opaque queued-item id. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Zero-based target position in the public visible queue. Values outside the queue clamp to an end. + [JsonPropertyName("toPosition")] + public long ToPosition { get; set; } +} + +/// Result of inserting a queued message. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueInsertAtResult +{ + /// Fresh stable opaque id assigned to the inserted item. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; +} + +/// Serializable message fields accepted by queue.insertAt. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueInsertMessage +{ + /// Optional explicit agent mode. When omitted, the session's current mode is assigned. + [JsonPropertyName("agentMode")] + public SendAgentMode? AgentMode { get; set; } + + /// Optional attachments for the message. + [JsonPropertyName("attachments")] + public IList? Attachments { get; set; } + + /// Whether the message is billable. + [JsonPropertyName("billable")] + public bool? Billable { get; set; } + + /// Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity. + [JsonPropertyName("delivery")] + public string? Delivery { get; set; } + + /// Optional user-facing display text. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Accepted for SendOptions compatibility but ignored; inserted items always use queued delivery semantics. + [JsonPropertyName("mode")] + public SendMode? Mode { get; set; } + + /// Accepted for SendOptions compatibility but ignored; the requested public position controls placement. + [JsonPropertyName("prepend")] + public bool? Prepend { get; set; } + + /// The user message text. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Per-turn request headers. + [JsonPropertyName("requestHeaders")] + public IDictionary? RequestHeaders { get; set; } + + /// Required tool name for the turn, when any. + [JsonPropertyName("requiredTool")] + public string? RequiredTool { get; set; } + + /// Optional provenance source. `system` is rejected: it would hide the inserted row from `pendingItems` and make it unaddressable while still executing, so inserted items must stay visible. + [JsonPropertyName("source")] + public string? Source { get; set; } + + /// Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state. + [JsonPropertyName("wait")] + public bool? Wait { get; set; } +} + +/// Parameters for inserting a queued message at a public visible position. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueInsertAtRequest +{ + /// Gets or sets the message value. + [JsonPropertyName("message")] + public QueueInsertMessage Message { get => field ??= new(); set; } + + /// Zero-based position in the public visible queue. Values outside the queue clamp to an end. + [JsonPropertyName("position")] + public long Position { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of removing a queued item. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueRemoveAtResult +{ + /// True when the addressed item was removed. + [JsonPropertyName("removed")] + public bool Removed { get; set; } +} + +/// Parameters for removing a queued item by stable id. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueRemoveAtRequest +{ + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of editing a queued message. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueUpdateTextResult +{ + /// True when the stored text changed. + [JsonPropertyName("updated")] + public bool Updated { get; set; } +} + +/// Parameters for editing a single queued message. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueUpdateTextRequest +{ + /// Gets or sets the displayPrompt value. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Gets or sets the prompt value. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of duplicating a queued item. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueDuplicateAtResult +{ + /// Fresh stable opaque id assigned to the duplicate. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; +} + +/// Parameters for duplicating a queued item. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueDuplicateAtRequest +{ + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueSetDrainPausedRequest +{ + /// Gets or sets the paused value. + [JsonPropertyName("paused")] + public bool Paused { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of trying to steer a queued message into a live turn. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueSendNowResult +{ + /// True when the item was accepted into the steering lane; false when no main turn was live. + [JsonPropertyName("steered")] + public bool Steered { get; set; } +} + +/// Parameters for steering a queued message into a live turn. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueSendNowRequest +{ + /// Gets or sets the id value. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Whether the native queue has pending work. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueHasPendingResult +{ + /// True when queued or immediate native work is pending. + [JsonPropertyName("hasPending")] + public bool HasPending { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueHasPendingRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Whether a deferred-idle drain should run. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueBeginDeferredIdleDrainResult +{ + /// True when the host should run finishDeferredIdleDrain asynchronously. + [JsonPropertyName("shouldDrain")] + public bool ShouldDrain { get; set; } +} + +/// Inputs for starting a deferred-idle drain. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueBeginDeferredIdleDrainRequest +{ + /// Whether the host still has active background work. + [JsonPropertyName("activeBackgroundWork")] + public bool ActiveBackgroundWork { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Action selected by the native deferred-idle drain. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueFinishDeferredIdleDrainResult +{ + /// Whether the deferred idle was caused by an aborted foreground turn. + [JsonPropertyName("aborted")] + public bool Aborted { get; set; } + + /// One of none, processQueue, or emitSessionIdle. + [JsonPropertyName("action")] + public string Action { get; set; } = string.Empty; +} + +/// Inputs for completing a deferred-idle drain. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueFinishDeferredIdleDrainRequest +{ + /// Whether the host still has active background work. + [JsonPropertyName("activeBackgroundWork")] + public bool ActiveBackgroundWork { get; set; } + + /// Whether native queued work remains. + [JsonPropertyName("hasPending")] + public bool HasPending { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Inputs for marking session.idle deferred in native state. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueDeferSessionIdleRequest +{ + /// Whether the deferred idle was caused by an aborted foreground turn. + [JsonPropertyName("aborted")] + public bool Aborted { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether a user-facing pending item was removed. +[Experimental(Diagnostics.Experimental)] +public sealed class QueueRemoveMostRecentResult +{ + /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + [JsonPropertyName("removed")] + public bool Removed { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueRemoveMostRecentRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueClearRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Internal filter for consuming queued system notifications. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueConsumeSystemNotificationsRequest +{ + /// Opaque runtime-owned filter object. + [JsonPropertyName("filter")] + public JsonElement Filter { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of enqueueing the resume-pending wake item. +[Experimental(Diagnostics.Experimental)] +internal sealed class QueueEnqueueResumePendingResult +{ + /// True when a wake item was newly queued. + [JsonPropertyName("queued")] + public bool Queued { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueEnqueueResumePendingRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionQueueProcessRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Batch of session events returned by a read, with cursor and continuation metadata. +[Experimental(Diagnostics.Experimental)] +public sealed class EventsReadResult +{ + /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing `direction: backward` with it (the cursor is also self-describing, so backward paging continues correctly). + [JsonPropertyName("cursor")] + public string Cursor { get; set; } = string.Empty; + + /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history. For a forward read the fallback starts from the beginning of the remaining history; for a backward read it falls back to the tail (the newest window). Because the fallback page is a fresh boundary snapshot rather than a continuation of the requested cursor, it may overlap events the consumer has already rendered — a backward fallback to the tail in particular can repeat the newest window. On 'expired', consumers should reset or rebase their local pagination state (or deduplicate by event id) before continuing from the returned cursor rather than blindly appending/prepending the fallback page. + [JsonPropertyName("cursorStatus")] + public EventsCursorStatus CursorStatus { get; set; } + + /// Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set `includeEphemeral: false` to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order. + [JsonPropertyName("events")] + public IList Events { get => field ??= []; set; } + + /// True when more events are available in the read's direction. For a forward read, true means the batch returned `max` events and more are available immediately. For a backward read, true means older persisted events remain before the returned window. + [JsonPropertyName("hasMore")] + public bool HasMore { get; set; } +} + +/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. +[Experimental(Diagnostics.Experimental)] +internal sealed class EventLogReadRequest +{ + /// Optional non-empty list of subagent identifiers. When provided, only events owned by one of these agents are returned; ownership recognizes the event envelope's agentId plus legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over agentScope. + [JsonPropertyName("agentIds")] + public IList? AgentIds { get; set; } + + /// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. + [JsonPropertyName("agentScope")] + public EventsAgentScope? AgentScope { get; set; } + + /// Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. + [JsonPropertyName("cursor")] + public string? Cursor { get; set; } + + /// Direction to page through the session's persisted event history. 'forward' (default) pages from the cursor toward newer events (or from the start of history when no cursor is given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` events, and the returned cursor pages toward OLDER events on subsequent backward reads. Events within a returned batch are always in chronological (oldest-to-newest) order, even for a backward read. Backward reads cover PERSISTED history only; ephemeral events are never returned by a backward read. `direction` selects the INITIAL read only: the returned cursor is self-describing, so a continuation read pages in the cursor's own direction regardless of the `direction` passed alongside it — a forward cursor always pages forward and a backward cursor always pages backward. Pass the direction that matches the cursor to avoid confusion. + [JsonPropertyName("direction")] + public EventsReadDirection? Direction { get; set; } + + /// When false, skip ephemeral events entirely and return only durable (persisted) events. History-backfill callers that discard ephemerals anyway should set this so the read is bounded by the durable log length instead of racing the ephemeral ring on a busy session. Defaults to true (ephemerals are interleaved with durable events in creation order). Ignored by backward reads, which always cover persisted history only. + [JsonPropertyName("includeEphemeral")] + public bool? IncludeEphemeral { get; set; } + + /// Maximum number of events to return in this batch (1–1000, default 200). + [JsonPropertyName("max")] + public long? Max { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Either '*' to receive all event types, or a non-empty list of event types to receive. + [JsonPropertyName("types")] + public JsonElement? Types { get; set; } + + /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). This applies to forward reads only: a backward read always returns immediately and ignores `waitMs`, because backward paging covers persisted history only while new events append at the tail (the opposite end from a backward page), so no blocking or ephemeral delivery can occur. + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("waitMs")] + public TimeSpan? Wait { get; set; } +} + +/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). +[Experimental(Diagnostics.Experimental)] +public sealed class EventLogTailResult +{ + /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). + [JsonPropertyName("cursor")] + public string Cursor { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionEventLogTailRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Opaque handle representing an event-type interest registration. +[Experimental(Diagnostics.Experimental)] +public sealed class RegisterEventInterestResult +{ + /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. + [JsonPropertyName("handle")] + public string Handle { get; set; } = string.Empty; +} + +/// Event type to register consumer interest for, used by runtime gating logic. +[Experimental(Diagnostics.Experimental)] +internal sealed class RegisterEventInterestParams +{ + /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest is registered the runtime still attempts non-interactive reconnect from cached or refreshable tokens, and only marks the server `needs-auth` if usable credentials are unavailable — it does not open a browser or start interactive OAuth without a consumer). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. + [JsonPropertyName("eventType")] + public string EventType { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the operation succeeded. +[Experimental(Diagnostics.Experimental)] +public sealed class EventLogReleaseInterestResult +{ + /// Whether the operation succeeded. + [JsonPropertyName("success")] + public bool Success { get; set; } +} + +/// Opaque handle previously returned by `registerInterest` to release. +[Experimental(Diagnostics.Experimental)] +internal sealed class ReleaseEventInterestParams +{ + /// Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. + [JsonPropertyName("handle")] + public string Handle { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Aggregated code change metrics. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsCodeChanges +{ + /// Distinct file paths modified during the session. + [JsonPropertyName("filesModified")] + public IList FilesModified { get => field ??= []; set; } + + /// Number of distinct files modified. + [JsonPropertyName("filesModifiedCount")] + public long FilesModifiedCount { get; set; } + + /// Total lines of code added. + [JsonPropertyName("linesAdded")] + public long LinesAdded { get; set; } + + /// Total lines of code removed. + [JsonPropertyName("linesRemoved")] + public long LinesRemoved { get; set; } +} + +/// Request count and cost metrics for this model. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsModelMetricRequests +{ + /// User-initiated premium request cost (with multiplier applied). + [JsonPropertyName("cost")] + public double Cost { get; set; } + + /// Number of API requests made with this model. + [JsonPropertyName("count")] + public long Count { get; set; } +} + +/// Per-model token-detail entry containing the accumulated token count for one token type. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsModelMetricTokenDetail +{ + /// Accumulated token count for this token type. + [JsonPropertyName("tokenCount")] + public long TokenCount { get; set; } +} + +/// Token usage metrics for this model. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsModelMetricUsage +{ + /// Total tokens read from prompt cache. + [JsonPropertyName("cacheReadTokens")] + public long CacheReadTokens { get; set; } + + /// Total tokens written to prompt cache. + [JsonPropertyName("cacheWriteTokens")] + public long CacheWriteTokens { get; set; } + + /// Total input tokens consumed. + [JsonPropertyName("inputTokens")] + public long InputTokens { get; set; } + + /// Total output tokens produced. + [JsonPropertyName("outputTokens")] + public long OutputTokens { get; set; } + + /// Total output tokens used for reasoning. + [JsonPropertyName("reasoningTokens")] + public long? ReasoningTokens { get; set; } +} + +/// Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsModelMetric +{ + /// Latest known prompt-cache expiration for this model. A timestamp in the past indicates that the observed cache has expired. + [JsonPropertyName("cacheExpiresAt")] + public DateTimeOffset? CacheExpiresAt { get; set; } + + /// Request count and cost metrics for this model. + [JsonPropertyName("requests")] + public UsageMetricsModelMetricRequests Requests { get => field ??= new(); set; } + + /// Token count details per type. + [JsonPropertyName("tokenDetails")] + public IDictionary? TokenDetails { get; set; } + + /// Accumulated nano-AI units cost for this model. + [JsonPropertyName("totalNanoAiu")] + public double? TotalNanoAiu { get; set; } + + /// Token usage metrics for this model. + [JsonPropertyName("usage")] + public UsageMetricsModelMetricUsage Usage { get => field ??= new(); set; } +} + +/// Session-wide token-detail entry containing the accumulated token count for one token type. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageMetricsTokenDetail +{ + /// Accumulated token count for this token type. + [JsonPropertyName("tokenCount")] + public long TokenCount { get; set; } +} + +/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +[Experimental(Diagnostics.Experimental)] +public sealed class UsageGetMetricsResult +{ + /// Aggregated code change metrics. + [JsonPropertyName("codeChanges")] + public UsageMetricsCodeChanges CodeChanges { get => field ??= new(); set; } + + /// Currently active model identifier. + [JsonPropertyName("currentModel")] + public string? CurrentModel { get; set; } + + /// Input tokens from the most recent main-agent API call. + [JsonPropertyName("lastCallInputTokens")] + public long LastCallInputTokens { get; set; } + + /// Output tokens from the most recent main-agent API call. + [JsonPropertyName("lastCallOutputTokens")] + public long LastCallOutputTokens { get; set; } + + /// Per-model token and request metrics, keyed by model identifier. + [JsonPropertyName("modelMetrics")] + public IDictionary ModelMetrics { get => field ??= new Dictionary(); set; } + + /// ISO 8601 timestamp when the session started. + [JsonPropertyName("sessionStartTime")] + public DateTimeOffset SessionStartTime { get; set; } + + /// Session-wide per-token-type accumulated token counts. + [JsonPropertyName("tokenDetails")] + public IDictionary? TokenDetails { get; set; } + + /// Total time spent in model API calls (milliseconds). + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("totalApiDurationMs")] + public TimeSpan TotalApiDuration { get; set; } + + /// Session-wide accumulated nano-AI units cost. + [JsonPropertyName("totalNanoAiu")] + public double? TotalNanoAiu { get; set; } + + /// Total user-initiated premium request cost across all models (may be fractional due to multipliers). + [JsonPropertyName("totalPremiumRequestCost")] + public double TotalPremiumRequestCost { get; set; } + + /// Raw count of user-initiated API requests. + [JsonPropertyName("totalUserRequests")] + public long TotalUserRequests { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionUsageGetMetricsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Prediction result. Available results include prediction details; unavailable results include an explicit reason. +/// Polymorphic base type discriminated by kind. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "kind", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(SessionLimitPredictionResultAvailable), "available")] +[JsonDerivedType(typeof(SessionLimitPredictionResultUnavailable), "unavailable")] +public partial class SessionLimitPredictionResult +{ + /// The type discriminator. + [JsonPropertyName("kind")] + public virtual string Kind { get; set; } = string.Empty; +} + + +/// Baseline data provenance for a prediction. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionLimitPredictionBaselineData +{ + /// End of the baseline data slice. + [JsonPropertyName("windowEnd")] + public string WindowEnd { get; set; } = string.Empty; + + /// Start of the baseline data slice. + [JsonPropertyName("windowStart")] + public string WindowStart { get; set; } = string.Empty; +} + +/// Semantic usage tier and its AI-credit cap. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionLimitPredictionTierOption +{ + /// AI-credit cap for this tier. + [JsonPropertyName("cap")] + public double Cap { get; set; } + + /// Gets or sets the tier value. + [JsonPropertyName("tier")] + public SessionLimitPredictionTier Tier { get; set; } +} + +/// Explainable AI-credit session-limit prediction. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionLimitPredictionDetails +{ + /// Baseline data provenance. + [JsonPropertyName("baselineData")] + public SessionLimitPredictionBaselineData BaselineData { get => field ??= new(); set; } + + /// Client population used for the prediction. + [JsonPropertyName("clientType")] + public SessionLimitPredictionClientType ClientType { get; set; } + + /// Resolved model family when known. + [JsonPropertyName("family")] + public string? Family { get; set; } + + /// Model identifier used for lookup. + [JsonPropertyName("modelId")] + public string ModelId { get; set; } = string.Empty; + + /// Recommended maximum AI credits for this session. + [JsonPropertyName("recommendedCap")] + public double RecommendedCap { get; set; } + + /// Tier chosen as the recommended cap. + [JsonPropertyName("recommendedTier")] + public SessionLimitPredictionTier RecommendedTier { get; set; } + + /// Baseline fallback level used to create the prediction. + [JsonPropertyName("source")] + public SessionLimitPredictionSource Source { get; set; } + + /// Key matched at the source level, such as a model id, family id, or `global`. + [JsonPropertyName("sourceKey")] + public string SourceKey { get; set; } = string.Empty; + + /// Ordered usage tiers and their AI-credit caps. + [JsonPropertyName("tiers")] + public IList Tiers { get => field ??= []; set; } +} + +/// The available variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SessionLimitPredictionResultAvailable : SessionLimitPredictionResult +{ + /// + [JsonIgnore] + public override string Kind => "available"; + + /// Predicted session limit details. + [JsonPropertyName("prediction")] + public required SessionLimitPredictionDetails Prediction { get; set; } +} + +/// The unavailable variant of . +[Experimental(Diagnostics.Experimental)] +public partial class SessionLimitPredictionResultUnavailable : SessionLimitPredictionResult +{ + /// + [JsonIgnore] + public override string Kind => "unavailable"; + + /// Reason no prediction is available. + [JsonPropertyName("reason")] + public required SessionLimitPredictionUnavailableReason Reason { get; set; } +} + +/// RPC data type for SessionLimitPredictionPredict operations. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionLimitPredictionPredictRequest +{ + /// Client type to size for. Defaults to `cli-interactive`. + [JsonPropertyName("clientType")] + public SessionLimitPredictionClientType? ClientType { get; set; } + + /// Optional model identifier override. If omitted, the session's current model is used. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } +} + +/// RPC data type for SessionLimitPredictionPredictRequestWithSession operations. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionLimitPredictionPredictRequestWithSession +{ + /// Client type to size for. Defaults to `cli-interactive`. + [JsonPropertyName("clientType")] + public SessionLimitPredictionClientType? ClientType { get; set; } + + /// Optional model identifier override. If omitted, the session's current model is used. + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +[Experimental(Diagnostics.Experimental)] +public sealed class RemoteEnableResult +{ + /// Whether remote steering is enabled. + [JsonPropertyName("remoteSteerable")] + public bool RemoteSteerable { get; set; } + + /// GitHub frontend URL for this session. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("url")] + public string? Url { get; set; } +} + +/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. +[Experimental(Diagnostics.Experimental)] +internal sealed class RemoteEnableRequest +{ + /// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. + [JsonPropertyName("mode")] + public RemoteSessionMode? Mode { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionRemoteDisableRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. +[Experimental(Diagnostics.Experimental)] +public sealed class RemoteNotifySteerableChangedResult +{ +} + +/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. +[Experimental(Diagnostics.Experimental)] +internal sealed class RemoteNotifySteerableChangedRequest +{ + /// Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. + [JsonPropertyName("remoteSteerable")] + public bool RemoteSteerable { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Current sharing status and shareable GitHub URL for a session. +[Experimental(Diagnostics.Experimental)] +public sealed class VisibilityGetResult +{ + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("shareUrl")] + public string? ShareUrl { get; set; } + + /// Current sharing status. Absent when the session is not synced or the status could not be retrieved (e.g. the user is not authenticated). + [JsonPropertyName("status")] + public SessionVisibilityStatus? Status { get; set; } + + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent. + [JsonPropertyName("synced")] + public bool Synced { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionVisibilityGetRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Effective sharing status and shareable GitHub URL after updating session visibility. +[Experimental(Diagnostics.Experimental)] +public sealed class VisibilitySetResult +{ + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] + [JsonPropertyName("shareUrl")] + public string? ShareUrl { get; set; } + + /// Effective sharing status after the update. May differ from the requested status for task types that are already visible to repository readers by default. Absent when the update could not be applied (e.g. the session is not synced or the user is not authenticated). + [JsonPropertyName("status")] + public SessionVisibilityStatus? Status { get; set; } + + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent. + [JsonPropertyName("synced")] + public bool Synced { get; set; } +} + +/// Desired sharing status for the session. +[Experimental(Diagnostics.Experimental)] +internal sealed class VisibilitySetRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Sharing status to apply. "repo" makes the session visible to repository readers; "unshared" restricts it to the creator and collaborators. + [JsonPropertyName("status")] + public SessionVisibilityStatus Status { get; set; } +} + +/// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. +[Experimental(Diagnostics.Experimental)] +public sealed class ScheduleEntry +{ + /// Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. + [JsonPropertyName("at")] + public long? At { get; set; } + + /// 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. + [JsonPropertyName("cron")] + public string? Cron { get; set; } + + /// Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). + [JsonPropertyName("id")] + public long Id { get; set; } + + /// Interval between scheduled ticks, in milliseconds (relative-interval schedules). + [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonPropertyName("intervalMs")] + public TimeSpan? Interval { get; set; } + + /// ISO 8601 timestamp when the next tick is scheduled to fire. + [JsonPropertyName("nextRunAt")] + public DateTimeOffset NextRunAt { get; set; } + + /// Prompt text that gets enqueued on every tick. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). + [JsonPropertyName("recurring")] + public bool Recurring { get; set; } + + /// True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. + [JsonPropertyName("selfPaced")] + public bool? SelfPaced { get; set; } + + /// IANA timezone the `cron` expression is evaluated in. + [JsonPropertyName("tz")] + public string? Tz { get; set; } +} + +/// Snapshot of the currently active recurring prompts for this session. +[Experimental(Diagnostics.Experimental)] +public sealed class ScheduleList +{ + /// Active scheduled prompts, ordered by id. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionScheduleListRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionScheduleHydrateRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Whether the session currently has an active self-paced schedule. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleHasSelfPacedResult +{ + /// True when at least one active schedule is self-paced. + [JsonPropertyName("hasSelfPaced")] + public bool HasSelfPaced { get; set; } +} + +/// Identifies the target session. +[Experimental(Diagnostics.Experimental)] +internal sealed class SessionScheduleHasSelfPacedRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result of registering or re-arming a scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleAddResult +{ + /// The registered or updated schedule entry. + [JsonPropertyName("entry")] + public ScheduleEntry? Entry { get; set; } + + /// User-facing validation error, when registration failed. + [JsonPropertyName("error")] + public string? Error { get; set; } +} + +/// Register a relative-interval scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleAddRequest +{ + /// Optional display-only prompt label. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Human-readable interval such as `30s`, `5m`, or `2h`. + [JsonPropertyName("interval")] + public string Interval { get; set; } = string.Empty; + + /// Prompt text to enqueue when the schedule fires. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Whether the schedule should re-arm after each tick. Defaults to true. + [JsonPropertyName("recurring")] + public bool? Recurring { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Register a cron scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleAddCronRequest +{ + /// 5-field cron expression. + [JsonPropertyName("cron")] + public string Cron { get; set; } = string.Empty; + + /// Optional display-only prompt label. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Prompt text to enqueue when the schedule fires. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Whether the schedule should re-arm after each tick. Defaults to true. + [JsonPropertyName("recurring")] + public bool? Recurring { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// IANA timezone for evaluating the cron expression. + [JsonPropertyName("tz")] + public string? Tz { get; set; } +} + +/// Register an absolute-time scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleAddAtRequest +{ + /// Epoch milliseconds when the prompt should fire. + [JsonPropertyName("at")] + public long At { get; set; } + + /// Optional display-only prompt label. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Prompt text to enqueue when the schedule fires. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Whether the schedule should re-arm after each tick. Defaults to false. + [JsonPropertyName("recurring")] + public bool? Recurring { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Register a self-paced scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleAddSelfPacedRequest +{ + /// Optional display-only prompt label. + [JsonPropertyName("displayPrompt")] + public string? DisplayPrompt { get; set; } + + /// Prompt text to enqueue when the schedule fires. + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Re-arm a self-paced scheduled prompt. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleRearmSelfPacedRequest +{ + /// Epoch milliseconds when the prompt should next fire. + [JsonPropertyName("at")] + public long At { get; set; } + + /// Id of the self-paced scheduled prompt. + [JsonPropertyName("id")] + public long Id { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +[Experimental(Diagnostics.Experimental)] +public sealed class ScheduleStopResult +{ + /// The removed entry, or omitted if no entry matched. + [JsonPropertyName("entry")] + public ScheduleEntry? Entry { get; set; } +} + +/// Identifier of the scheduled prompt to remove. +[Experimental(Diagnostics.Experimental)] +internal sealed class ScheduleStopRequest +{ + /// Id of the scheduled prompt to remove. + [JsonPropertyName("id")] + public long Id { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer <token>` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderTokenAcquireResult +{ + /// The bearer token value (without the `Bearer ` prefix). + [JsonPropertyName("token")] + public string Token { get; set; } = string.Empty; +} + +/// Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderTokenAcquireRequest +{ + /// Name of the BYOK provider needing a token. For the legacy whole-session `provider` this is the implicit provider name; for named providers it is `NamedProviderConfig.name`. + [JsonPropertyName("providerName")] + public string ProviderName { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Result returned by an extension factory closure. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryExecuteResult +{ + /// Factory result value. + [JsonPropertyName("result")] + public JsonElement? Result { get; set; } +} + +/// Parameters sent to the owning extension to execute a factory closure. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryExecuteRequest +{ + /// Factory input value. + [JsonPropertyName("args")] + public JsonElement Args { get; set; } + + /// Opaque token identifying this factory execution attempt. + [JsonPropertyName("executionToken")] + public string ExecutionToken { get; set; } = string.Empty; + + /// Registered factory name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Parameters for cooperatively aborting a factory body. +[Experimental(Diagnostics.Experimental)] +public sealed class FactoryAbortRequest +{ + /// Factory run identifier. + [JsonPropertyName("runId")] + public string RunId { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Describes a filesystem error. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsError +{ + /// Error classification. + [JsonPropertyName("code")] + public SessionFsErrorCode Code { get; set; } + + /// Free-form detail about the error, for logging/diagnostics. + [JsonPropertyName("message")] + public string? Message { get; set; } +} + +/// File content as a UTF-8 string, or a filesystem error if the read failed. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReadFileResult +{ + /// File content as UTF-8 string. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; + + /// Describes a filesystem error. + [JsonPropertyName("error")] + public SessionFsError? Error { get; set; } +} + +/// Path of the file to read from the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReadFileRequest +{ + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// File path, content to write, and optional mode for the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsWriteFileRequest +{ + /// Content to write. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; + + /// Optional POSIX-style mode for newly created files. + [JsonPropertyName("mode")] + public long? Mode { get; set; } + + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// File path, content to append, and optional mode for the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsAppendFileRequest +{ + /// Content to append. + [JsonPropertyName("content")] + public string Content { get; set; } = string.Empty; + + /// Optional POSIX-style mode for newly created files. + [JsonPropertyName("mode")] + public long? Mode { get; set; } + + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Indicates whether the requested path exists in the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsExistsResult +{ + /// Whether the path exists. + [JsonPropertyName("exists")] + public bool Exists { get; set; } +} + +/// Path to test for existence in the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsExistsRequest +{ + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsStatResult +{ + /// ISO 8601 timestamp of creation. + [JsonPropertyName("birthtime")] + public DateTimeOffset Birthtime { get; set; } + + /// Describes a filesystem error. + [JsonPropertyName("error")] + public SessionFsError? Error { get; set; } + + /// Whether the path is a directory. + [JsonPropertyName("isDirectory")] + public bool IsDirectory { get; set; } + + /// Whether the path is a file. + [JsonPropertyName("isFile")] + public bool IsFile { get; set; } + + /// ISO 8601 timestamp of last modification. + [JsonPropertyName("mtime")] + public DateTimeOffset Mtime { get; set; } + + /// File size in bytes. + [JsonPropertyName("size")] + public long Size { get; set; } +} + +/// Path whose metadata should be returned from the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsStatRequest +{ + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsMkdirRequest +{ + /// Optional POSIX-style mode for newly created directories. + [JsonPropertyName("mode")] + public long? Mode { get; set; } + + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Create parent directories as needed. + [JsonPropertyName("recursive")] + public bool? Recursive { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Names of entries in the requested directory, or a filesystem error if the read failed. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReaddirResult +{ + /// Entry names in the directory. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } + + /// Describes a filesystem error. + [JsonPropertyName("error")] + public SessionFsError? Error { get; set; } +} + +/// Directory path whose entries should be listed from the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReaddirRequest +{ + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReaddirWithTypesEntry +{ + /// Entry name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Entry type. + [JsonPropertyName("type")] + public SessionFsReaddirWithTypesEntryType Type { get; set; } +} + +/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReaddirWithTypesResult +{ + /// Directory entries with type information. + [JsonPropertyName("entries")] + public IList Entries { get => field ??= []; set; } + + /// Describes a filesystem error. + [JsonPropertyName("error")] + public SessionFsError? Error { get; set; } +} + +/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsReaddirWithTypesRequest +{ + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsRmRequest +{ + /// Ignore errors if the path does not exist. + [JsonPropertyName("force")] + public bool? Force { get; set; } + + /// Path using SessionFs conventions. + [JsonPropertyName("path")] + public string Path { get; set; } = string.Empty; + + /// Remove directories and their contents recursively. + [JsonPropertyName("recursive")] + public bool? Recursive { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsRenameRequest +{ + /// Destination path using SessionFs conventions. + [JsonPropertyName("dest")] + public string Dest { get; set; } = string.Empty; + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Source path using SessionFs conventions. + [JsonPropertyName("src")] + public string Src { get; set; } = string.Empty; +} + +/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteQueryResult +{ + /// Column names from the result set. + [JsonPropertyName("columns")] + public IList Columns { get => field ??= []; set; } + + /// Describes a filesystem error. + [JsonPropertyName("error")] + public SessionFsError? Error { get; set; } + + /// SQLite last_insert_rowid() value for INSERT. + [JsonPropertyName("lastInsertRowid")] + public long? LastInsertRowid { get; set; } + + /// For SELECT: array of row objects. For others: empty array. + [JsonPropertyName("rows")] + public IList> Rows { get => field ??= []; set; } + + /// Number of rows affected (for INSERT/UPDATE/DELETE). + [JsonPropertyName("rowsAffected")] + public long RowsAffected { get; set; } +} + +/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteQueryRequest +{ + /// Optional named bind parameters. + [JsonPropertyName("params")] + public IDictionary? Params { get; set; } + + /// SQL query to execute. + [JsonPropertyName("query")] + public string Query { get; set; } = string.Empty; + + /// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected). + [JsonPropertyName("queryType")] + public SessionFsSqliteQueryType QueryType { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionError +{ + /// Gets or sets the errorClass value. + [JsonPropertyName("errorClass")] + public SessionFsSqliteTransactionErrorClass ErrorClass { get; set; } + + /// Gets or sets the message value. + [JsonPropertyName("message")] + public string Message { get; set; } = string.Empty; +} + +/// Per-statement results, or a classified transaction error. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionResult +{ + /// Gets or sets the error value. + [JsonPropertyName("error")] + public SessionFsSqliteTransactionError? Error { get; set; } + + /// Gets or sets the results value. + [JsonPropertyName("results")] + public IList Results { get => field ??= []; set; } +} + +/// One statement in an atomic SQLite transaction. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionStatement +{ + /// Optional named bind parameters. + [JsonPropertyName("params")] + public IDictionary? Params { get; set; } + + /// SQL statement to execute. + [JsonPropertyName("query")] + public string Query { get; set; } = string.Empty; + + /// How to execute the statement. + [JsonPropertyName("queryType")] + public SessionFsSqliteQueryType QueryType { get; set; } +} + +/// Statements to execute atomically. Providers apply busy handling for every call. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// Gets or sets the statements value. + [JsonPropertyName("statements")] + public IList Statements { get => field ??= []; set; } +} + +/// Indicates whether the per-session SQLite database already exists. +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteExistsResult +{ + /// Whether the session database already exists. + [JsonPropertyName("exists")] + public bool Exists { get; set; } +} + +/// Identifies the target session. +public sealed class SessionFsSqliteExistsRequest +{ + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Canvas open result returned by the provider. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderOpenResult +{ + /// Provider-supplied status text. + [JsonPropertyName("status")] + public string? Status { get; set; } + + /// Provider-supplied title. + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// URL for web-rendered canvases. + [JsonPropertyName("url")] + public string? Url { get; set; } +} + +/// Host capabilities. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasHostContextCapabilities +{ + /// Whether canvas rendering is supported. + [JsonPropertyName("canvases")] + public bool? Canvases { get; set; } +} + +/// Host context supplied by the runtime. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasHostContext +{ + /// Host capabilities. + [JsonPropertyName("capabilities")] + public CanvasHostContextCapabilities? Capabilities { get; set; } +} + +/// Session context supplied by the runtime. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasSessionContext +{ + /// Active session working directory, when known. + [JsonPropertyName("workingDirectory")] + public string? WorkingDirectory { get; set; } +} + +/// Canvas open parameters sent to the provider. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderOpenRequest +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; + + /// Host context supplied by the runtime. + [JsonPropertyName("host")] + public CanvasHostContext? Host { get; set; } + + /// Canvas open input. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Stable caller-supplied canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; + + /// Session context supplied by the runtime. + [JsonPropertyName("session")] + public CanvasSessionContext? Session { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Canvas close parameters sent to the provider. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderCloseRequest +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; + + /// Host context supplied by the runtime. + [JsonPropertyName("host")] + public CanvasHostContext? Host { get; set; } + + /// Canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; + + /// Session context supplied by the runtime. + [JsonPropertyName("session")] + public CanvasSessionContext? Session { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Canvas action invocation parameters sent to the provider. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasProviderInvokeActionRequest +{ + /// Action name to invoke. + [JsonPropertyName("actionName")] + public string ActionName { get; set; } = string.Empty; + + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public string CanvasId { get; set; } = string.Empty; + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public string ExtensionId { get; set; } = string.Empty; + + /// Host context supplied by the runtime. + [JsonPropertyName("host")] + public CanvasHostContext? Host { get; set; } + + /// Action input. + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Canvas instance identifier. + [JsonPropertyName("instanceId")] + public string InstanceId { get; set; } = string.Empty; + + /// Session context supplied by the runtime. + [JsonPropertyName("session")] + public CanvasSessionContext? Session { get; set; } + + /// Target session identifier. + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; +} + +/// Opaque integrator-owned process launch profile for one extension entrypoint. +[Experimental(Diagnostics.Experimental)] +public sealed class ExtensionLaunchProfile +{ + /// Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint. + [JsonPropertyName("args")] + public IList Args { get => field ??= []; set; } + + /// Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. + [JsonPropertyName("env")] + public IDictionary Env { get => field ??= new Dictionary(); set; } + + /// Executable used to launch the extension entrypoint. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("executable")] + public string Executable { get; set; } = string.Empty; +} + +/// The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. +[Experimental(Diagnostics.Experimental)] +public sealed class ExtensionLaunchProviderResolveResult +{ + /// Opaque launch profile, omitted when this provider does not support the entrypoint. + [JsonPropertyName("launch")] + public ExtensionLaunchProfile? Launch { get; set; } +} + +/// A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. +[Experimental(Diagnostics.Experimental)] +public sealed class ExtensionLaunchProviderResolveRequest +{ + /// Source-qualified extension identifier. + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// Absolute path to the discovered extension entrypoint. + [JsonPropertyName("modulePath")] + public string ModulePath { get; set; } = string.Empty; + + /// Human-readable extension name. + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// Discovery source for the extension entrypoint. + [JsonPropertyName("source")] + public ExtensionSource Source { get; set; } +} + +/// Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpRequestStartResult +{ +} + +/// The head of an outbound model-layer HTTP request. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpRequestStartRequest +{ + /// Stable identity of the agent trajectory that issued this request. Present when the request originates from an agent turn; absent for requests outside any agent context. This is the same identity used by lifecycle and bridged session events and remains constant across turns and retries. + [JsonPropertyName("agentId")] + public string? AgentId { get; set; } + + /// Identity of the agent invocation (one agentic loop) that issued this request. It remains fixed across physical retries within the invocation and is distinct from the stable trajectory `agentId`. A caller-supplied invocation id always takes precedence (this covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests fall back to the runtime's agent task id — the same value the runtime emits as the `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. + [JsonPropertyName("agentInvocationId")] + public string? AgentInvocationId { get; set; } + + /// Gets or sets the headers value. + [JsonPropertyName("headers")] + public IDictionary> Headers { get => field ??= new Dictionary>(); set; } + + /// Coarse classification of the interaction that produced this request. Open string for forward-compatibility; known values include `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, and `conversation-user`. Absent when the runtime did not classify the request. Comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` header from this same context. + [JsonPropertyName("interactionType")] + public string? InteractionType { get; set; } + + /// HTTP method, e.g. GET, POST. + [JsonPropertyName("method")] + public string Method { get; set; } = string.Empty; + + /// Stable identity of the immediate parent trajectory. Present for child trajectories such as subagents and conversation-sampling requests; absent for root-agent and non-agent requests. + [JsonPropertyName("parentAgentId")] + public string? ParentAgentId { get; set; } + + /// Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies back to the runtime. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; + + /// Id of the runtime session that triggered this request, when one is in scope. Absent for requests issued outside any session (e.g. startup model-catalog or capability resolution). This is a payload field — not a dispatch key — because the client-global API is registered process-wide rather than per session. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } + + /// Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. + [JsonPropertyName("transport")] + public LlmInferenceHttpRequestStartTransport? Transport { get; set; } + + /// Absolute request URL. + [JsonPropertyName("url")] + public string Url { get; set; } = string.Empty; +} + +/// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpRequestChunkResult +{ +} + +/// A request body chunk or cancellation signal. +[Experimental(Diagnostics.Experimental)] +public sealed class LlmInferenceHttpRequestChunkRequest +{ + /// Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent transport can attribute successive turns correctly: when a WebSocket connection is reused across turns, the httpRequestStart identity reflects only the turn that opened the connection, so each later turn stamps its own invocation id here. Absent when the runtime has no invocation context for the request, or on the plain-HTTP transport where every request has its own httpRequestStart. + [JsonPropertyName("agentInvocationId")] + public string? AgentInvocationId { get; set; } + + /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + [JsonPropertyName("binary")] + public bool? Binary { get; set; } + + /// When true, the runtime is cancelling the in-flight request (e.g. upstream consumer aborted). `data` is ignored. Implies end-of-request. + [JsonPropertyName("cancel")] + public bool? Cancel { get; set; } + + /// Optional human-readable reason for the cancellation, propagated for logging. + [JsonPropertyName("cancelReason")] + public string? CancelReason { get; set; } + + /// Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty. + [JsonPropertyName("data")] + public string Data { get; set; } = string.Empty; + + /// When true, this is the final body chunk for the request. The SDK may rely on having received an end-marked chunk before treating the request body as complete. + [JsonPropertyName("end")] + public bool? End { get; set; } + + /// Matches the requestId from the originating httpRequestStart frame. + [JsonPropertyName("requestId")] + public string RequestId { get; set; } = string.Empty; +} + +/// Client environment metadata describing the process that produced a telemetry event. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTelemetryClientInfo +{ + /// Copilot CLI version string. + [JsonPropertyName("cli_version")] + public string CliVersion { get; set; } = string.Empty; + + /// Name of the client application. + [JsonPropertyName("client_name")] + public string? ClientName { get; set; } + + /// Type of client. + [JsonPropertyName("client_type")] + public string? ClientType { get; set; } + + /// Copilot subscription plan, when known. + [JsonPropertyName("copilot_plan")] + public string? CopilotPlan { get; set; } + + /// Stable machine identifier for the device. + [JsonPropertyName("dev_device_id")] + public string? DevDeviceId { get; set; } + + /// Whether the user is a GitHub/Microsoft staff member. + [JsonPropertyName("is_staff")] + public bool? IsStaff { get; set; } + + /// Node.js runtime version string. + [JsonPropertyName("node_version")] + public string NodeVersion { get; set; } = string.Empty; + + /// Operating system architecture (e.g. arm64, x64). + [JsonPropertyName("os_arch")] + public string OsArch { get; set; } = string.Empty; + + /// Operating system platform (e.g. darwin, linux, win32). + [JsonPropertyName("os_platform")] + public string OsPlatform { get; set; } = string.Empty; + + /// Operating system version string. + [JsonPropertyName("os_version")] + public string OsVersion { get; set; } = string.Empty; +} + +/// A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing GitHubTelemetryNotification distinguishes standard from restricted events; the payload shape is identical for both. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTelemetryEvent +{ + /// Client environment metadata. + [JsonPropertyName("client")] + public GitHubTelemetryClientInfo? Client { get; set; } + + /// Copilot tracking ID for user-level attribution. + [JsonPropertyName("copilot_tracking_id")] + public string? CopilotTrackingId { get; set; } + + /// Timestamp when the event was created (ISO 8601 format). + [JsonPropertyName("created_at")] + public string? CreatedAt { get; set; } + + /// Experiment assignment context. + [JsonPropertyName("exp_assignment_context")] + public string? ExpAssignmentContext { get; set; } + + /// Feature flags enabled for this session, as a map from flag to value. + [JsonPropertyName("features")] + public IDictionary? Features { get; set; } + + /// Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). + [JsonPropertyName("kind")] + public string Kind { get; set; } = string.Empty; + + /// Numeric metrics as a map from key to value. + [JsonPropertyName("metrics")] + public IDictionary Metrics { get => field ??= new Dictionary(); set; } + + /// Reference to the model call that produced this event. + [JsonPropertyName("model_call_id")] + public string? ModelCallId { get; set; } + + /// String-valued properties as a map from key to value. + [JsonPropertyName("properties")] + public IDictionary Properties { get => field ??= new Dictionary(); set; } + + /// Session identifier the event belongs to. + [JsonPropertyName("session_id")] + public string? SessionId { get; set; } +} + +/// Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubTelemetryNotification +{ + /// The telemetry event, in the runtime's native GitHub-shaped telemetry format. + [JsonPropertyName("event")] + public GitHubTelemetryEvent Event { get => field ??= new(); set; } + + /// Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only. + [JsonPropertyName("restricted")] + public bool Restricted { get; set; } + + /// Session the telemetry event belongs to, when it is session-scoped. Omitted for sessionless events (for example, `server.sendTelemetry` calls with no session id), which are still forwarded to opted-in connections. + [JsonPropertyName("sessionId")] + public string? SessionId { get; set; } +} + +/// Resolved Anthropic adaptive-thinking capability for a model. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AdaptiveThinkingSupport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AdaptiveThinkingSupport(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The model does not accept thinking.type='adaptive'. + public static AdaptiveThinkingSupport Unsupported { get; } = new("unsupported"); + + /// The model accepts adaptive thinking but also accepts thinking.type='enabled'. + public static AdaptiveThinkingSupport Optional { get; } = new("optional"); + + /// The model only accepts adaptive thinking and rejects thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + public static AdaptiveThinkingSupport Required { get; } = new("required"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AdaptiveThinkingSupport left, AdaptiveThinkingSupport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AdaptiveThinkingSupport left, AdaptiveThinkingSupport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AdaptiveThinkingSupport other && Equals(other); + + /// + public bool Equals(AdaptiveThinkingSupport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AdaptiveThinkingSupport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AdaptiveThinkingSupport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AdaptiveThinkingSupport)); + } + } +} + + +/// Model capability category for grouping in the model picker. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelPickerCategory : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelPickerCategory(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Lightweight model category optimized for faster, lower-cost interactions. + public static ModelPickerCategory Lightweight { get; } = new("lightweight"); + + /// Versatile model category suitable for a broad range of tasks. + public static ModelPickerCategory Versatile { get; } = new("versatile"); + + /// Powerful model category optimized for complex tasks. + public static ModelPickerCategory Powerful { get; } = new("powerful"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelPickerCategory left, ModelPickerCategory right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelPickerCategory left, ModelPickerCategory right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelPickerCategory other && Equals(other); + + /// + public bool Equals(ModelPickerCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelPickerCategory Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelPickerCategory value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerCategory)); + } + } +} + + +/// Relative cost tier for token-based billing users. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelPickerPriceCategory : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelPickerPriceCategory(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Lowest relative token cost tier. + public static ModelPickerPriceCategory Low { get; } = new("low"); + + /// Medium relative token cost tier. + public static ModelPickerPriceCategory Medium { get; } = new("medium"); + + /// High relative token cost tier. + public static ModelPickerPriceCategory High { get; } = new("high"); + + /// Highest relative token cost tier. + public static ModelPickerPriceCategory VeryHigh { get; } = new("very_high"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelPickerPriceCategory left, ModelPickerPriceCategory right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelPickerPriceCategory left, ModelPickerPriceCategory right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelPickerPriceCategory other && Equals(other); + + /// + public bool Equals(ModelPickerPriceCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelPickerPriceCategory Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelPickerPriceCategory value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerPriceCategory)); + } + } +} + + +/// Current policy state for this model. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelPolicyState : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelPolicyState(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The model is enabled by policy. + public static ModelPolicyState Enabled { get; } = new("enabled"); + + /// The model is disabled by policy. + public static ModelPolicyState Disabled { get; } = new("disabled"); + + /// No explicit policy is configured for the model. + public static ModelPolicyState Unconfigured { get; } = new("unconfigured"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelPolicyState left, ModelPolicyState right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelPolicyState left, ModelPolicyState right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelPolicyState other && Equals(other); + + /// + public bool Equals(ModelPolicyState other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelPolicyState Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelPolicyState value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPolicyState)); + } + } +} + + +/// Server transport type: stdio, http, sse (deprecated), or memory. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DiscoveredMcpServerType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DiscoveredMcpServerType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Server communicates over stdio with a local child process. + public static DiscoveredMcpServerType Stdio { get; } = new("stdio"); + + /// Server communicates over streamable HTTP. + public static DiscoveredMcpServerType Http { get; } = new("http"); + + /// Server communicates over Server-Sent Events (deprecated). + public static DiscoveredMcpServerType Sse { get; } = new("sse"); + + /// Server is backed by an in-memory runtime implementation. + public static DiscoveredMcpServerType Memory { get; } = new("memory"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is DiscoveredMcpServerType other && Equals(other); + + /// + public bool Equals(DiscoveredMcpServerType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DiscoveredMcpServerType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, DiscoveredMcpServerType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DiscoveredMcpServerType)); + } + } +} + + +/// Persisted extension discovery source. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DiscoveredExtensionSource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DiscoveredExtensionSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Extension discovered from the user's extensions directory. + public static DiscoveredExtensionSource User { get; } = new("user"); + + /// Extension contributed by an installed plugin. + public static DiscoveredExtensionSource Plugin { get; } = new("plugin"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DiscoveredExtensionSource left, DiscoveredExtensionSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DiscoveredExtensionSource left, DiscoveredExtensionSource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is DiscoveredExtensionSource other && Equals(other); + + /// + public bool Equals(DiscoveredExtensionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DiscoveredExtensionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, DiscoveredExtensionSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DiscoveredExtensionSource)); + } + } +} + + +/// Effective extension loading and agent-management mode. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DiscoveredExtensionMode : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DiscoveredExtensionMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Extensions are not loaded. + public static DiscoveredExtensionMode Disabled { get; } = new("disabled"); + + /// Extensions are loaded, but the agent cannot create, reload, or manage them. + public static DiscoveredExtensionMode LoadOnly { get; } = new("load_only"); + + /// Extensions are loaded and the agent can create, reload, and manage them. + public static DiscoveredExtensionMode LoadAndAugment { get; } = new("load_and_augment"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DiscoveredExtensionMode left, DiscoveredExtensionMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DiscoveredExtensionMode left, DiscoveredExtensionMode right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is DiscoveredExtensionMode other && Equals(other); + + /// + public bool Equals(DiscoveredExtensionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DiscoveredExtensionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, DiscoveredExtensionMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DiscoveredExtensionMode)); + } + } +} + + +/// Which tier this directory belongs to. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SkillDiscoveryScope : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SkillDiscoveryScope(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A project's repository skill directory. + public static SkillDiscoveryScope Project { get; } = new("project"); + + /// The user's personal Copilot skill directory. + public static SkillDiscoveryScope PersonalCopilot { get; } = new("personal-copilot"); + + /// The user's personal agents skill directory. + public static SkillDiscoveryScope PersonalAgents { get; } = new("personal-agents"); + + /// A configured custom skill directory. + public static SkillDiscoveryScope Custom { get; } = new("custom"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SkillDiscoveryScope left, SkillDiscoveryScope right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SkillDiscoveryScope left, SkillDiscoveryScope right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SkillDiscoveryScope other && Equals(other); + + /// + public bool Equals(SkillDiscoveryScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SkillDiscoveryScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SkillDiscoveryScope value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillDiscoveryScope)); + } + } +} + + +/// Where the agent definition was loaded from. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentInfoSource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentInfoSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Agent loaded from the user's personal agent configuration. + public static AgentInfoSource User { get; } = new("user"); + + /// Agent loaded from the current project's repository configuration. + public static AgentInfoSource Project { get; } = new("project"); + + /// Agent inherited from a parent project or workspace. + public static AgentInfoSource Inherited { get; } = new("inherited"); + + /// Agent provided by a remote runtime or service. + public static AgentInfoSource Remote { get; } = new("remote"); + + /// Agent contributed by an installed plugin. + public static AgentInfoSource Plugin { get; } = new("plugin"); + + /// Agent built into the Copilot runtime. + public static AgentInfoSource Builtin { get; } = new("builtin"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentInfoSource left, AgentInfoSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentInfoSource left, AgentInfoSource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentInfoSource other && Equals(other); + + /// + public bool Equals(AgentInfoSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentInfoSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentInfoSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentInfoSource)); + } + } +} + + +/// Which tier this directory belongs to. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentDiscoveryPathScope : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentDiscoveryPathScope(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The user's personal agent configuration directory. + public static AgentDiscoveryPathScope User { get; } = new("user"); + + /// A project's repository agent directory. + public static AgentDiscoveryPathScope Project { get; } = new("project"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentDiscoveryPathScope left, AgentDiscoveryPathScope right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentDiscoveryPathScope left, AgentDiscoveryPathScope right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentDiscoveryPathScope other && Equals(other); + + /// + public bool Equals(AgentDiscoveryPathScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentDiscoveryPathScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentDiscoveryPathScope value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentDiscoveryPathScope)); + } + } +} + + +/// Where this source lives — used for UI grouping. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct InstructionSourceLocation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public InstructionSourceLocation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Instructions live in user-level configuration. + public static InstructionSourceLocation User { get; } = new("user"); + + /// Instructions live in repository-level configuration. + public static InstructionSourceLocation Repository { get; } = new("repository"); + + /// Instructions live under the current working directory. + public static InstructionSourceLocation WorkingDirectory { get; } = new("working-directory"); + + /// Instructions live in plugin-provided configuration. + public static InstructionSourceLocation Plugin { get; } = new("plugin"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(InstructionSourceLocation left, InstructionSourceLocation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(InstructionSourceLocation left, InstructionSourceLocation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is InstructionSourceLocation other && Equals(other); + + /// + public bool Equals(InstructionSourceLocation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override InstructionSourceLocation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, InstructionSourceLocation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionSourceLocation)); + } + } +} + + +/// Category of instruction source — used for merge logic. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct InstructionSourceType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public InstructionSourceType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Instructions loaded from the user's home configuration. + public static InstructionSourceType Home { get; } = new("home"); + + /// Instructions loaded from repository-scoped files. + public static InstructionSourceType Repo { get; } = new("repo"); + + /// Instructions loaded from model-specific files. + public static InstructionSourceType Model { get; } = new("model"); + + /// Instructions loaded from VS Code instruction files. + public static InstructionSourceType Vscode { get; } = new("vscode"); + + /// Instructions discovered from nested agent files. + public static InstructionSourceType NestedAgents { get; } = new("nested-agents"); + + /// Instructions inherited from child instruction files. + public static InstructionSourceType ChildInstructions { get; } = new("child-instructions"); + + /// Instructions supplied by an installed plugin. + public static InstructionSourceType Plugin { get; } = new("plugin"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(InstructionSourceType left, InstructionSourceType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(InstructionSourceType left, InstructionSourceType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is InstructionSourceType other && Equals(other); + + /// + public bool Equals(InstructionSourceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override InstructionSourceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, InstructionSourceType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionSourceType)); + } + } +} + + +/// Whether the target is a single file or a directory of instruction files. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct InstructionDiscoveryPathKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public InstructionDiscoveryPathKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The target is a single instruction file. + public static InstructionDiscoveryPathKind File { get; } = new("file"); + + /// The target is a directory that holds instruction files. + public static InstructionDiscoveryPathKind Directory { get; } = new("directory"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(InstructionDiscoveryPathKind left, InstructionDiscoveryPathKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(InstructionDiscoveryPathKind left, InstructionDiscoveryPathKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is InstructionDiscoveryPathKind other && Equals(other); + + /// + public bool Equals(InstructionDiscoveryPathKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override InstructionDiscoveryPathKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, InstructionDiscoveryPathKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionDiscoveryPathKind)); + } + } +} + + +/// Which tier this target belongs to. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct InstructionDiscoveryPathLocation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public InstructionDiscoveryPathLocation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Instructions live in user-level configuration. + public static InstructionDiscoveryPathLocation User { get; } = new("user"); + + /// Instructions live in repository-level configuration. + public static InstructionDiscoveryPathLocation Repository { get; } = new("repository"); + + /// Instructions live under the current working directory. + public static InstructionDiscoveryPathLocation WorkingDirectory { get; } = new("working-directory"); + + /// Instructions live in plugin-provided configuration. + public static InstructionDiscoveryPathLocation Plugin { get; } = new("plugin"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(InstructionDiscoveryPathLocation left, InstructionDiscoveryPathLocation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(InstructionDiscoveryPathLocation left, InstructionDiscoveryPathLocation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is InstructionDiscoveryPathLocation other && Equals(other); + + /// + public bool Equals(InstructionDiscoveryPathLocation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override InstructionDiscoveryPathLocation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, InstructionDiscoveryPathLocation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionDiscoveryPathLocation)); + } + } +} + + +/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SlashCommandInputCompletion : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SlashCommandInputCompletion(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Input should complete filesystem directories. + public static SlashCommandInputCompletion Directory { get; } = new("directory"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SlashCommandInputCompletion other && Equals(other); + + /// + public bool Equals(SlashCommandInputCompletion other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SlashCommandInputCompletion Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SlashCommandInputCompletion value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandInputCompletion)); + } + } +} + + +/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SlashCommandKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SlashCommandKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Command implemented by the runtime. + public static SlashCommandKind Builtin { get; } = new("builtin"); + + /// Command backed by a skill. + public static SlashCommandKind Skill { get; } = new("skill"); + + /// Command registered by an SDK client or extension. + public static SlashCommandKind Client { get; } = new("client"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SlashCommandKind left, SlashCommandKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SlashCommandKind left, SlashCommandKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SlashCommandKind other && Equals(other); + + /// + public bool Equals(SlashCommandKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SlashCommandKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SlashCommandKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandKind)); + } + } +} + + +/// Path conventions used by this filesystem. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionFsSetProviderConventions : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionFsSetProviderConventions(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Paths use Windows path conventions. + public static SessionFsSetProviderConventions Windows { get; } = new("windows"); + + /// Paths use POSIX path conventions. + public static SessionFsSetProviderConventions Posix { get; } = new("posix"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionFsSetProviderConventions left, SessionFsSetProviderConventions right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionFsSetProviderConventions left, SessionFsSetProviderConventions right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionFsSetProviderConventions other && Equals(other); + + /// + public bool Equals(SessionFsSetProviderConventions other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionFsSetProviderConventions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionFsSetProviderConventions value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionFsSetProviderConventions)); + } + } +} + + +/// Repository host type. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionContextHostType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionContextHostType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Session repository is hosted on GitHub. + public static SessionContextHostType GitHub { get; } = new("github"); + + /// Session repository is hosted on Azure DevOps. + public static SessionContextHostType Ado { get; } = new("ado"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionContextHostType left, SessionContextHostType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionContextHostType left, SessionContextHostType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionContextHostType other && Equals(other); + + /// + public bool Equals(SessionContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionContextHostType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionContextHostType)); + } + } +} + + +/// Whether the remote task originated from CCA or CLI `--remote`. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct RemoteSessionMetadataTaskType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public RemoteSessionMetadataTaskType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// GitHub Copilot coding agent task. + public static RemoteSessionMetadataTaskType Cca { get; } = new("cca"); + + /// CLI remote task. + public static RemoteSessionMetadataTaskType Cli { get; } = new("cli"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(RemoteSessionMetadataTaskType left, RemoteSessionMetadataTaskType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(RemoteSessionMetadataTaskType left, RemoteSessionMetadataTaskType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is RemoteSessionMetadataTaskType other && Equals(other); + + /// + public bool Equals(RemoteSessionMetadataTaskType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override RemoteSessionMetadataTaskType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, RemoteSessionMetadataTaskType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(RemoteSessionMetadataTaskType)); + } + } +} + + +/// Step status. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionsOpenProgressStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionsOpenProgressStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The step has started and has not yet finished. + public static SessionsOpenProgressStatus InProgress { get; } = new("in-progress"); + + /// The step has completed successfully. + public static SessionsOpenProgressStatus Complete { get; } = new("complete"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionsOpenProgressStatus left, SessionsOpenProgressStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionsOpenProgressStatus left, SessionsOpenProgressStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionsOpenProgressStatus other && Equals(other); + + /// + public bool Equals(SessionsOpenProgressStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionsOpenProgressStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionsOpenProgressStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenProgressStatus)); + } + } +} + + +/// Handoff step. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionsOpenProgressStep : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionsOpenProgressStep(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Loading the source session's events from the remote service. + public static SessionsOpenProgressStep LoadSession { get; } = new("load-session"); + + /// Validating that the local repository matches the remote session's repository. + public static SessionsOpenProgressStep ValidateRepo { get; } = new("validate-repo"); + + /// Checking the local working tree for uncommitted changes that would block the handoff. + public static SessionsOpenProgressStep CheckChanges { get; } = new("check-changes"); + + /// Checking out the branch associated with the remote session in the local working tree. + public static SessionsOpenProgressStep CheckoutBranch { get; } = new("checkout-branch"); + + /// Creating the new local session and seeding it with the source session's events. + public static SessionsOpenProgressStep CreateSession { get; } = new("create-session"); + + /// Persisting the newly-created local session to disk. + public static SessionsOpenProgressStep SaveSession { get; } = new("save-session"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionsOpenProgressStep left, SessionsOpenProgressStep right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionsOpenProgressStep left, SessionsOpenProgressStep right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionsOpenProgressStep other && Equals(other); + + /// + public bool Equals(SessionsOpenProgressStep other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionsOpenProgressStep Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionsOpenProgressStep value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenProgressStep)); + } + } +} + + +/// Outcome of the open request. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionsOpenStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionsOpenStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A new session was created. + public static SessionsOpenStatus Created { get; } = new("created"); + + /// An existing session was loaded or reattached. + public static SessionsOpenStatus Resumed { get; } = new("resumed"); + + /// No matching persisted session was found. + public static SessionsOpenStatus NotFound { get; } = new("not_found"); + + /// Connected to an existing remote session. + public static SessionsOpenStatus Connected { get; } = new("connected"); + + /// Remote session was handed off to a new local session. + public static SessionsOpenStatus HandedOff { get; } = new("handed_off"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionsOpenStatus left, SessionsOpenStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionsOpenStatus left, SessionsOpenStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionsOpenStatus other && Equals(other); + + /// + public bool Equals(SessionsOpenStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionsOpenStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionsOpenStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionsOpenStatus)); + } + } +} + + +/// Neutral SDK discriminator for the connected remote session kind. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ConnectedRemoteSessionMetadataKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ConnectedRemoteSessionMetadataKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Remote CLI session. + public static ConnectedRemoteSessionMetadataKind RemoteSession { get; } = new("remote-session"); + + /// GitHub Copilot coding agent session. + public static ConnectedRemoteSessionMetadataKind CodingAgent { get; } = new("coding-agent"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ConnectedRemoteSessionMetadataKind other && Equals(other); + + /// + public bool Equals(ConnectedRemoteSessionMetadataKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ConnectedRemoteSessionMetadataKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ConnectedRemoteSessionMetadataKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ConnectedRemoteSessionMetadataKind)); + } + } +} + + +/// Which session sources to include. Defaults to `local` for backward compatibility. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionSource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Return only local sessions. + public static SessionSource Local { get; } = new("local"); + + /// Return only remote sessions. + public static SessionSource Remote { get; } = new("remote"); + + /// Return both local and remote sessions. + public static SessionSource All { get; } = new("all"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionSource left, SessionSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionSource left, SessionSource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionSource other && Equals(other); + + /// + public bool Equals(SessionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionSource)); + } + } +} + + +/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryAttentionKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLiveTargetEntryAttentionKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Session is blocked on an unrecoverable error. + public static AgentRegistryLiveTargetEntryAttentionKind Error { get; } = new("error"); + + /// Session is waiting for a tool-permission decision. + public static AgentRegistryLiveTargetEntryAttentionKind Permission { get; } = new("permission"); + + /// Session is waiting for the user to approve or reject a plan. + public static AgentRegistryLiveTargetEntryAttentionKind ExitPlan { get; } = new("exit_plan"); + + /// Session is waiting on an elicitation prompt. + public static AgentRegistryLiveTargetEntryAttentionKind Elicitation { get; } = new("elicitation"); + + /// Session is waiting for free-form user input. + public static AgentRegistryLiveTargetEntryAttentionKind UserInput { get; } = new("user_input"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryAttentionKind other && Equals(other); + + /// + public bool Equals(AgentRegistryLiveTargetEntryAttentionKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistryLiveTargetEntryAttentionKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryAttentionKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryAttentionKind)); + } + } +} + + +/// Process kind tag for the registry entry. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLiveTargetEntryKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Interactive Copilot CLI exposing a UI server (legacy/normal CLI process). + public static AgentRegistryLiveTargetEntryKind UiServer { get; } = new("ui-server"); + + /// Headless `--server --managed-server` child spawned by a controller. + public static AgentRegistryLiveTargetEntryKind ManagedServer { get; } = new("managed-server"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryKind other && Equals(other); + + /// + public bool Equals(AgentRegistryLiveTargetEntryKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistryLiveTargetEntryKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryKind)); + } + } +} + + +/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryLastTerminalEvent : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLiveTargetEntryLastTerminalEvent(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Last turn ended cleanly (model returned a final assistant message). + public static AgentRegistryLiveTargetEntryLastTerminalEvent TurnEnd { get; } = new("turn_end"); + + /// Last turn was aborted (e.g. user interrupted). + public static AgentRegistryLiveTargetEntryLastTerminalEvent Abort { get; } = new("abort"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryLastTerminalEvent other && Equals(other); + + /// + public bool Equals(AgentRegistryLiveTargetEntryLastTerminalEvent other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistryLiveTargetEntryLastTerminalEvent Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryLastTerminalEvent value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryLastTerminalEvent)); + } + } +} + + +/// Coarse lifecycle status of the foreground session. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLiveTargetEntryStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLiveTargetEntryStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Session is actively processing a turn. + public static AgentRegistryLiveTargetEntryStatus Working { get; } = new("working"); + + /// Session is idle, waiting for input. + public static AgentRegistryLiveTargetEntryStatus Waiting { get; } = new("waiting"); + + /// Last turn completed successfully. + public static AgentRegistryLiveTargetEntryStatus Done { get; } = new("done"); + + /// Session needs user attention (see attentionKind for the specific reason). + public static AgentRegistryLiveTargetEntryStatus Attention { get; } = new("attention"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryStatus other && Equals(other); + + /// + public bool Equals(AgentRegistryLiveTargetEntryStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistryLiveTargetEntryStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Whether the location is a git repo or directory. - [JsonPropertyName("locationType")] - public PermissionLocationType LocationType { get; set; } + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryStatus)); + } + } } -/// Working directory to load persisted location permissions for. + +/// Categorized reason for log-open failure. [Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationApplyParams +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistryLogCaptureOpenErrorReason : IEquatable { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + private readonly string? _value; - /// Working directory whose persisted location permissions should be applied. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistryLogCaptureOpenErrorReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsLocationsAddToolApprovalResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Tool approval to persist and apply. -/// Polymorphic base type discriminated by kind. -[Experimental(Diagnostics.Experimental)] -[JsonPolymorphic( - TypeDiscriminatorPropertyName = "kind", - UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsCommands), "commands")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsRead), "read")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsWrite), "write")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMcp), "mcp")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMcpSampling), "mcp-sampling")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsMemory), "memory")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsCustomTool), "custom-tool")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsExtensionManagement), "extension-management")] -[JsonDerivedType(typeof(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess), "extension-permission-access")] -public partial class PermissionsLocationsAddToolApprovalDetails -{ - /// The type discriminator. - [JsonPropertyName("kind")] - public virtual string Kind { get; set; } = string.Empty; -} + /// Filesystem permission denied opening the log file. + public static AgentRegistryLogCaptureOpenErrorReason Permission { get; } = new("permission"); + /// No space left on device. + public static AgentRegistryLogCaptureOpenErrorReason DiskFull { get; } = new("disk_full"); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsCommands` type. -/// The commands variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsCommands : PermissionsLocationsAddToolApprovalDetails -{ - /// - [JsonIgnore] - public override string Kind => "commands"; + /// Other / uncategorized open failure. + public static AgentRegistryLogCaptureOpenErrorReason Other { get; } = new("other"); - /// Command identifiers covered by this approval. - [JsonPropertyName("commandIdentifiers")] - public required IList CommandIdentifiers { get; set; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => !(left == right); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsRead` type. -/// The read variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsRead : PermissionsLocationsAddToolApprovalDetails -{ /// - [JsonIgnore] - public override string Kind => "read"; -} + public override bool Equals(object? obj) => obj is AgentRegistryLogCaptureOpenErrorReason other && Equals(other); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsWrite` type. -/// The write variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsWrite : PermissionsLocationsAddToolApprovalDetails -{ /// - [JsonIgnore] - public override string Kind => "write"; -} + public bool Equals(AgentRegistryLogCaptureOpenErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcp` type. -/// The mcp variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsMcp : PermissionsLocationsAddToolApprovalDetails -{ /// - [JsonIgnore] - public override string Kind => "mcp"; + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } + /// + public override string ToString() => Value; - /// MCP tool name, or null to cover every tool on the server. - [JsonPropertyName("toolName")] - public string? ToolName { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistryLogCaptureOpenErrorReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentRegistryLogCaptureOpenErrorReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLogCaptureOpenErrorReason)); + } + } } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcpSampling` type. -/// The mcp-sampling variant of . + +/// Which parameter field was invalid. Omitted when the rejection is not field-specific. [Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsMcpSampling : PermissionsLocationsAddToolApprovalDetails +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistrySpawnValidationErrorField : IEquatable { - /// - [JsonIgnore] - public override string Kind => "mcp-sampling"; + private readonly string? _value; - /// MCP server name. - [JsonPropertyName("serverName")] - public required string ServerName { get; set; } -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistrySpawnValidationErrorField(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMemory` type. -/// The memory variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsMemory : PermissionsLocationsAddToolApprovalDetails -{ - /// - [JsonIgnore] - public override string Kind => "memory"; -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsCustomTool` type. -/// The custom-tool variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsCustomTool : PermissionsLocationsAddToolApprovalDetails -{ - /// - [JsonIgnore] - public override string Kind => "custom-tool"; + /// The cwd parameter. + public static AgentRegistrySpawnValidationErrorField Cwd { get; } = new("cwd"); - /// Custom tool name. - [JsonPropertyName("toolName")] - public required string ToolName { get; set; } -} + /// The session name parameter. + public static AgentRegistrySpawnValidationErrorField Name { get; } = new("name"); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionManagement` type. -/// The extension-management variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsExtensionManagement : PermissionsLocationsAddToolApprovalDetails -{ - /// - [JsonIgnore] - public override string Kind => "extension-management"; + /// The agentName parameter. + public static AgentRegistrySpawnValidationErrorField AgentName { get; } = new("agentName"); - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("operation")] - public string? Operation { get; set; } -} + /// The model parameter. + public static AgentRegistrySpawnValidationErrorField Model { get; } = new("model"); + + /// The permissionMode parameter. + public static AgentRegistrySpawnValidationErrorField PermissionMode { get; } = new("permissionMode"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => !(left == right); -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess` type. -/// The extension-permission-access variant of . -[Experimental(Diagnostics.Experimental)] -public partial class PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess : PermissionsLocationsAddToolApprovalDetails -{ /// - [JsonIgnore] - public override string Kind => "extension-permission-access"; + public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorField other && Equals(other); - /// Extension name. - [JsonPropertyName("extensionName")] - public required string ExtensionName { get; set; } -} + /// + public bool Equals(AgentRegistrySpawnValidationErrorField other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Location-scoped tool approval to persist. -[Experimental(Diagnostics.Experimental)] -internal sealed class PermissionLocationAddToolApprovalParams -{ - /// Tool approval to persist and apply. - [JsonPropertyName("approval")] - public PermissionsLocationsAddToolApprovalDetails Approval { get => field ??= new(); set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Location key (git root or cwd) to persist the approval to. - [JsonPropertyName("locationKey")] - public string LocationKey { get; set; } = string.Empty; + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistrySpawnValidationErrorField Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Folder trust check result. -[Experimental(Diagnostics.Experimental)] -public sealed class FolderTrustCheckResult -{ - /// Whether the folder is trusted. - [JsonPropertyName("trusted")] - public bool Trusted { get; set; } + /// + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorField value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorField)); + } + } } -/// Folder path to check for trust. + +/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. [Experimental(Diagnostics.Experimental)] -internal sealed class FolderTrustCheckParams +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistrySpawnValidationErrorReason : IEquatable { - /// Folder path to check. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistrySpawnValidationErrorReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsFolderTrustAddTrustedResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Folder path to add to trusted folders. -[Experimental(Diagnostics.Experimental)] -internal sealed class FolderTrustAddParams -{ - /// Folder path to mark as trusted. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Provided cwd does not exist on disk. + public static AgentRegistrySpawnValidationErrorReason CwdNotFound { get; } = new("cwd-not-found"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Provided cwd exists but is not a directory. + public static AgentRegistrySpawnValidationErrorReason CwdNotDirectory { get; } = new("cwd-not-directory"); -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class PermissionsUrlsSetUnrestrictedModeResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} + /// Session name failed validateSessionName. + public static AgentRegistrySpawnValidationErrorReason InvalidName { get; } = new("invalid-name"); -/// Whether the URL-permission policy should run in unrestricted mode. -[Experimental(Diagnostics.Experimental)] -internal sealed class PermissionUrlsSetUnrestrictedModeParams -{ - /// Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. - [JsonPropertyName("enabled")] - public bool Enabled { get; set; } + /// Requested agent name was not found in builtin or custom agents. + public static AgentRegistrySpawnValidationErrorReason UnknownAgent { get; } = new("unknown-agent"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Requested model is not available to this session. + public static AgentRegistrySpawnValidationErrorReason UnknownModel { get; } = new("unknown-model"); -/// The repository the remote session targets. -[Experimental(Diagnostics.Experimental)] -public sealed class MetadataSnapshotRemoteMetadataRepository -{ - /// The branch the remote session is operating on. - [JsonPropertyName("branch")] - public string Branch { get; set; } = string.Empty; + /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode. + public static AgentRegistrySpawnValidationErrorReason YoloNotAllowed { get; } = new("yolo-not-allowed"); - /// The GitHub repository name (without owner). - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => left.Equals(right); - /// The GitHub owner (user or organization) of the target repository. - [JsonPropertyName("owner")] - public string Owner { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorReason other && Equals(other); + + /// + public bool Equals(AgentRegistrySpawnValidationErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistrySpawnValidationErrorReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorReason)); + } + } } -/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + +/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. [Experimental(Diagnostics.Experimental)] -public sealed class MetadataSnapshotRemoteMetadata +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AgentRegistrySpawnPermissionMode : IEquatable { - /// The pull request number the remote session is associated with, if any. - [JsonPropertyName("pullRequestNumber")] - public long? PullRequestNumber { get; set; } + private readonly string? _value; - /// The repository the remote session targets. - [JsonPropertyName("repository")] - public MetadataSnapshotRemoteMetadataRepository Repository { get => field ??= new(); set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AgentRegistrySpawnPermissionMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. - [JsonPropertyName("resourceId")] - public string? ResourceId { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. - [JsonPropertyName("taskType")] - public MetadataSnapshotRemoteMetadataTaskType? TaskType { get; set; } -} + /// Standard permission posture (prompts for each request). + public static AgentRegistrySpawnPermissionMode Default { get; } = new("default"); -/// Public-facing projection of workspace metadata for SDK / TUI consumers. -public sealed class SessionMetadataSnapshotWorkspace -{ - /// Branch checked out at session start, if any. - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// Full allow-all (requires the controller-local session to currently be in allow-all mode). + public static AgentRegistrySpawnPermissionMode Yolo { get; } = new("yolo"); - /// ISO 8601 timestamp when the workspace was created. - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => left.Equals(right); - /// Current working directory at session start. - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => !(left == right); - /// Resolved git root for cwd, if any. - [JsonPropertyName("git_root")] - public string? GitRoot { get; set; } + /// + public override bool Equals(object? obj) => obj is AgentRegistrySpawnPermissionMode other && Equals(other); - /// Repository host type, if known. - [JsonPropertyName("host_type")] - public WorkspaceSummaryHostType? HostType { get; set; } + /// + public bool Equals(AgentRegistrySpawnPermissionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Workspace identifier (1:1 with sessionId). - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("id")] - public string Id { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Display name for the session, if set. - [JsonPropertyName("name")] - public string? Name { get; set; } + /// + public override string ToString() => Value; - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any. - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AgentRegistrySpawnPermissionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// ISO 8601 timestamp when the workspace was last updated. - [JsonPropertyName("updated_at")] - public DateTimeOffset? UpdatedAt { get; set; } + /// + public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnPermissionMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnPermissionMode)); + } + } } -/// Point-in-time snapshot of slow-changing session identifier and state fields. + +/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. [Experimental(Diagnostics.Experimental)] -public sealed class SessionMetadataSnapshot +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SendAgentMode : IEquatable { - /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. - [JsonPropertyName("alreadyInUse")] - public bool AlreadyInUse { get; set; } + private readonly string? _value; - /// Runtime client name associated with the session (telemetry identifier). - [JsonPropertyName("clientName")] - public string? ClientName { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SendAgentMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). - [JsonPropertyName("currentMode")] - public MetadataSnapshotCurrentMode CurrentMode { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. - [JsonPropertyName("initialName")] - public string? InitialName { get; set; } + /// The agent is responding interactively to the user. + public static SendAgentMode Interactive { get; } = new("interactive"); - /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process). - [JsonPropertyName("isRemote")] - public bool IsRemote { get; set; } + /// The agent is preparing a plan before making changes. + public static SendAgentMode Plan { get; } = new("plan"); + + /// The agent is working autonomously toward task completion. + public static SendAgentMode Autopilot { get; } = new("autopilot"); - /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. - [JsonPropertyName("modifiedTime")] - public DateTimeOffset ModifiedTime { get; set; } + /// The agent is in shell-focused UI mode. + public static SendAgentMode Shell { get; } = new("shell"); - /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. - [JsonPropertyName("remoteMetadata")] - public MetadataSnapshotRemoteMetadata? RemoteMetadata { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SendAgentMode left, SendAgentMode right) => left.Equals(right); - /// Currently selected model identifier, if any. - [JsonPropertyName("selectedModel")] - public string? SelectedModel { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SendAgentMode left, SendAgentMode right) => !(left == right); - /// The unique identifier of the session. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override bool Equals(object? obj) => obj is SendAgentMode other && Equals(other); - /// ISO 8601 timestamp of when the session started. - [JsonPropertyName("startTime")] - public DateTimeOffset StartTime { get; set; } + /// + public bool Equals(SendAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. - [JsonPropertyName("summary")] - public string? Summary { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Absolute path to the session's current working directory. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; + /// + public override string ToString() => Value; - /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). - [JsonPropertyName("workspace")] - public SessionMetadataSnapshotWorkspace? Workspace { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SendAgentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace. - [JsonPropertyName("workspacePath")] - public string? WorkspacePath { get; set; } + /// + public override void Write(Utf8JsonWriter writer, SendAgentMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendAgentMode)); + } + } } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionMetadataSnapshotRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} -/// Indicates whether the local session is currently processing a turn or background continuation. +/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. [Experimental(Diagnostics.Experimental)] -public sealed class MetadataIsProcessingResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SendMode : IEquatable { - /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. - [JsonPropertyName("processing")] - public bool Processing { get; set; } -} + private readonly string? _value; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionMetadataIsProcessingRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SendMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Token-usage breakdown for the session's current context window. -public sealed class MetadataContextInfoResultContextInfo -{ - /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%). - [JsonPropertyName("bufferTokens")] - public long BufferTokens { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Token count at which background compaction starts (configurable percentage of promptTokenLimit). - [JsonPropertyName("compactionThreshold")] - public long CompactionThreshold { get; set; } + /// Append the message to the normal session queue. + public static SendMode Enqueue { get; } = new("enqueue"); - /// Tokens consumed by user/assistant/tool messages. - [JsonPropertyName("conversationTokens")] - public long ConversationTokens { get; set; } + /// Interject the message during the in-progress turn. + public static SendMode Immediate { get; } = new("immediate"); - /// Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. - [JsonPropertyName("limit")] - public long Limit { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SendMode left, SendMode right) => left.Equals(right); - /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools). - [JsonPropertyName("mcpToolsTokens")] - public long McpToolsTokens { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SendMode left, SendMode right) => !(left == right); - /// The model used for token counting. - [JsonPropertyName("modelName")] - public string ModelName { get; set; } = string.Empty; + /// + public override bool Equals(object? obj) => obj is SendMode other && Equals(other); - /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified). - [JsonPropertyName("promptTokenLimit")] - public long PromptTokenLimit { get; set; } + /// + public bool Equals(SendMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Tokens consumed by the system prompt. - [JsonPropertyName("systemTokens")] - public long SystemTokens { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Tokens consumed by tool definitions sent to the model (excludes deferred tools). - [JsonPropertyName("toolDefinitionsTokens")] - public long ToolDefinitionsTokens { get; set; } + /// + public override string ToString() => Value; - /// Sum of system, conversation and tool-definition tokens. - [JsonPropertyName("totalTokens")] - public long TotalTokens { get; set; } -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SendMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Token breakdown for the session's current context window, or null if uninitialized. -[Experimental(Diagnostics.Experimental)] -public sealed class MetadataContextInfoResult -{ - /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). - [JsonPropertyName("contextInfo")] - public MetadataContextInfoResultContextInfo? ContextInfo { get; set; } + /// + public override void Write(Utf8JsonWriter writer, SendMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendMode)); + } + } } -/// Model identifier and token limits used to compute the context-info breakdown. + +/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataContextInfoRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionLogLevel : IEquatable { - /// Maximum output tokens allowed by the target model. Pass 0 if unknown. - [JsonPropertyName("outputTokenLimit")] - public long OutputTokenLimit { get; set; } - - /// Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. - [JsonPropertyName("promptTokenLimit")] - public long PromptTokenLimit { get; set; } - - /// Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. - [JsonPropertyName("selectedModel")] - public string? SelectedModel { get; set; } + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionLogLevel(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). -[Experimental(Diagnostics.Experimental)] -public sealed class MetadataRecordContextChangeResult -{ -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionWorkingDirectoryContext -{ - /// Merge-base commit SHA (fork point from the remote default branch). - [JsonPropertyName("baseCommit")] - public string? BaseCommit { get; set; } + /// Informational message. + public static SessionLogLevel Info { get; } = new("info"); - /// Current git branch name. - [JsonPropertyName("branch")] - public string? Branch { get; set; } + /// Warning message that may require attention. + public static SessionLogLevel Warning { get; } = new("warning"); - /// Current working directory path. - [JsonPropertyName("cwd")] - public string Cwd { get; set; } = string.Empty; + /// Error message describing a failure. + public static SessionLogLevel Error { get; } = new("error"); - /// Root directory of the git repository, resolved via git rev-parse. - [JsonPropertyName("gitRoot")] - public string? GitRoot { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLogLevel left, SessionLogLevel right) => left.Equals(right); - /// Head commit of the current git branch. - [JsonPropertyName("headCommit")] - public string? HeadCommit { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLogLevel left, SessionLogLevel right) => !(left == right); - /// Hosting platform type of the repository. - [JsonPropertyName("hostType")] - public SessionWorkingDirectoryContextHostType? HostType { get; set; } + /// + public override bool Equals(object? obj) => obj is SessionLogLevel other && Equals(other); - /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps). - [JsonPropertyName("repository")] - public string? Repository { get; set; } + /// + public bool Equals(SessionLogLevel other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com"). - [JsonPropertyName("repositoryHost")] - public string? RepositoryHost { get; set; } -} + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); -/// Updated working-directory/git context to record on the session. -[Experimental(Diagnostics.Experimental)] -internal sealed class MetadataRecordContextChangeRequest -{ - /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. - [JsonPropertyName("context")] - public SessionWorkingDirectoryContext Context { get => field ??= new(); set; } + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionLogLevel Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. -[Experimental(Diagnostics.Experimental)] -public sealed class MetadataSetWorkingDirectoryResult -{ - /// Working directory after the update. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, SessionLogLevel value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLogLevel)); + } + } } -/// Absolute path to set as the session's new working directory. + +/// Authentication type. [Experimental(Diagnostics.Experimental)] -internal sealed class MetadataSetWorkingDirectoryRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AuthInfoType : IEquatable { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + private readonly string? _value; - /// Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. - [JsonPropertyName("workingDirectory")] - public string WorkingDirectory { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AuthInfoType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. -[Experimental(Diagnostics.Experimental)] -public sealed class MetadataRecomputeContextTokensResult -{ - /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). - [JsonPropertyName("messagesTokenCount")] - public long MessagesTokenCount { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Tokens contributed by system/developer prompt snapshots. - [JsonPropertyName("systemTokenCount")] - public long SystemTokenCount { get; set; } + /// Authentication provided by a GitHub App HMAC credential. + public static AuthInfoType Hmac { get; } = new("hmac"); - /// Sum of tokens across chat-context and system-context messages currently held by the session. - [JsonPropertyName("totalTokens")] - public long TotalTokens { get; set; } -} + /// Authentication resolved from environment-provided credentials. + public static AuthInfoType Env { get; } = new("env"); -/// Model identifier to use when re-tokenizing the session's existing messages. -[Experimental(Diagnostics.Experimental)] -internal sealed class MetadataRecomputeContextTokensRequest -{ - /// Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. - [JsonPropertyName("modelId")] - public string ModelId { get; set; } = string.Empty; + /// Authentication from an interactive user sign-in. + public static AuthInfoType User { get; } = new("user"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Authentication delegated to the GitHub CLI. + public static AuthInfoType GhCli { get; } = new("gh-cli"); -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. -[Experimental(Diagnostics.Experimental)] -public sealed class ShellExecResult -{ - /// Unique identifier for tracking streamed output. - [JsonPropertyName("processId")] - public string ProcessId { get; set; } = string.Empty; -} + /// Authentication from an API key credential. + public static AuthInfoType ApiKey { get; } = new("api-key"); -/// Shell command to run, with optional working directory and timeout in milliseconds. -[Experimental(Diagnostics.Experimental)] -internal sealed class ShellExecRequest -{ - /// Shell command to execute. - [JsonPropertyName("command")] - public string Command { get; set; } = string.Empty; + /// Authentication from a GitHub token. + public static AuthInfoType Token { get; } = new("token"); - /// Working directory (defaults to session working directory). - [JsonPropertyName("cwd")] - public string? Cwd { get; set; } + /// Authentication from a Copilot API token. + public static AuthInfoType CopilotApiToken { get; } = new("copilot-api-token"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AuthInfoType left, AuthInfoType right) => left.Equals(right); - /// Timeout in milliseconds (default: 30000). - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("timeout")] - public TimeSpan? Timeout { get; set; } -} + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AuthInfoType left, AuthInfoType right) => !(left == right); -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. -[Experimental(Diagnostics.Experimental)] -public sealed class ShellKillResult -{ - /// Whether the signal was sent successfully. - [JsonPropertyName("killed")] - public bool Killed { get; set; } -} + /// + public override bool Equals(object? obj) => obj is AuthInfoType other && Equals(other); -/// Identifier of a process previously returned by "shell.exec" and the signal to send. -[Experimental(Diagnostics.Experimental)] -internal sealed class ShellKillRequest -{ - /// Process identifier returned by shell.exec. - [JsonPropertyName("processId")] - public string ProcessId { get; set; } = string.Empty; + /// + public bool Equals(AuthInfoType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Signal to send (default: SIGTERM). - [JsonPropertyName("signal")] - public ShellKillSignal? Signal { get; set; } + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AuthInfoType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AuthInfoType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AuthInfoType)); + } + } } -/// Post-compaction context window usage breakdown. + +/// Source category for a collected debug bundle entry. [Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactContextWindow +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DebugCollectLogsSource : IEquatable { - /// Token count from non-system messages (user, assistant, tool). - [JsonPropertyName("conversationTokens")] - public long? ConversationTokens { get; set; } + private readonly string? _value; - /// Current total tokens in the context window (system + conversation + tool definitions). - [JsonPropertyName("currentTokens")] - public long CurrentTokens { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DebugCollectLogsSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Current number of messages in the conversation. - [JsonPropertyName("messagesLength")] - public long MessagesLength { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Token count from system message(s). - [JsonPropertyName("systemTokens")] - public long? SystemTokens { get; set; } + /// Session event log. + public static DebugCollectLogsSource Events { get; } = new("events"); - /// Maximum token count for the model's context window. - [JsonPropertyName("tokenLimit")] - public long TokenLimit { get; set; } + /// Process log for the session. + public static DebugCollectLogsSource ProcessLog { get; } = new("process-log"); - /// Token count from tool definitions. - [JsonPropertyName("toolDefinitionsTokens")] - public long? ToolDefinitionsTokens { get; set; } -} + /// Interactive shell log for the session. + public static DebugCollectLogsSource ShellLog { get; } = new("shell-log"); -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactResult -{ - /// Post-compaction context window usage breakdown. - [JsonPropertyName("contextWindow")] - public HistoryCompactContextWindow? ContextWindow { get; set; } + /// Caller-provided diagnostic entry. + public static DebugCollectLogsSource Additional { get; } = new("additional"); - /// Number of messages removed during compaction. - [JsonPropertyName("messagesRemoved")] - public long MessagesRemoved { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DebugCollectLogsSource left, DebugCollectLogsSource right) => left.Equals(right); - /// Whether compaction completed successfully. - [JsonPropertyName("success")] - public bool Success { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsSource left, DebugCollectLogsSource right) => !(left == right); - /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). - [JsonPropertyName("summaryContent")] - public string? SummaryContent { get; set; } + /// + public override bool Equals(object? obj) => obj is DebugCollectLogsSource other && Equals(other); - /// Number of tokens freed by compaction. - [JsonPropertyName("tokensRemoved")] - public long TokensRemoved { get; set; } -} + /// + public bool Equals(DebugCollectLogsSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Optional compaction parameters. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryCompactRequest -{ - /// Optional user-provided instructions to focus the compaction summary. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MaxLength(4000)] - [JsonPropertyName("customInstructions")] - public string? CustomInstructions { get; set; } -} + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); -/// Optional compaction parameters. -[Experimental(Diagnostics.Experimental)] -internal sealed class HistoryCompactRequestWithSession -{ - /// Optional user-provided instructions to focus the compaction summary. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MaxLength(4000)] - [JsonPropertyName("customInstructions")] - public string? CustomInstructions { get; set; } + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DebugCollectLogsSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Number of events that were removed by the truncation. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryTruncateResult -{ - /// Number of events that were removed. - [JsonPropertyName("eventsRemoved")] - public long EventsRemoved { get; set; } + /// + public override void Write(Utf8JsonWriter writer, DebugCollectLogsSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsSource)); + } + } } -/// Identifier of the event to truncate to; this event and all later events are removed. + +/// Destination kind that was written. [Experimental(Diagnostics.Experimental)] -internal sealed class HistoryTruncateRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DebugCollectLogsResultKind : IEquatable { - /// Event ID to truncate to. This event and all events after it are removed from the session. - [JsonPropertyName("eventId")] - public string EventId { get; set; } = string.Empty; + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DebugCollectLogsResultKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Indicates whether an in-progress background compaction was cancelled. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryCancelBackgroundCompactionResult -{ - /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. - [JsonPropertyName("cancelled")] - public bool Cancelled { get; set; } -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistoryCancelBackgroundCompactionRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// A .tgz archive was written. + public static DebugCollectLogsResultKind Archive { get; } = new("archive"); -/// Indicates whether an in-progress manual compaction was aborted. -[Experimental(Diagnostics.Experimental)] -public sealed class HistoryAbortManualCompactionResult -{ - /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. - [JsonPropertyName("aborted")] - public bool Aborted { get; set; } -} + /// A directory containing redacted files was written. + public static DebugCollectLogsResultKind Directory { get; } = new("directory"); -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistoryAbortManualCompactionRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DebugCollectLogsResultKind left, DebugCollectLogsResultKind right) => left.Equals(right); -/// Markdown summary of the conversation context (empty when not available). -[Experimental(Diagnostics.Experimental)] -public sealed class HistorySummarizeForHandoffResult -{ - /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. - [JsonPropertyName("summary")] - public string Summary { get; set; } = string.Empty; -} + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsResultKind left, DebugCollectLogsResultKind right) => !(left == right); -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionHistorySummarizeForHandoffRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override bool Equals(object? obj) => obj is DebugCollectLogsResultKind other && Equals(other); -/// Schema for the `QueuePendingItems` type. -[Experimental(Diagnostics.Experimental)] -public sealed class QueuePendingItems -{ - /// Human-readable text to display for this queue entry in the UI. - [JsonPropertyName("displayText")] - public string DisplayText { get; set; } = string.Empty; + /// + public bool Equals(DebugCollectLogsResultKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Whether this item is a queued user message or a queued slash command / model change. - [JsonPropertyName("kind")] - public QueuePendingItemsKind Kind { get; set; } -} + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); -/// Snapshot of the session's pending queued items and immediate-steering messages. -[Experimental(Diagnostics.Experimental)] -public sealed class QueuePendingItemsResult -{ - /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. - [JsonPropertyName("items")] - public IList Items { get => field ??= []; set; } + /// + public override string ToString() => Value; - /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). - [JsonPropertyName("steeringMessages")] - public IList SteeringMessages { get => field ??= []; set; } -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DebugCollectLogsResultKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueuePendingItemsRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, DebugCollectLogsResultKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsResultKind)); + } + } } -/// Indicates whether a user-facing pending item was removed. -[Experimental(Diagnostics.Experimental)] -public sealed class QueueRemoveMostRecentResult -{ - /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. - [JsonPropertyName("removed")] - public bool Removed { get; set; } -} -/// Identifies the target session. +/// Kind of caller-provided debug log entry. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueueRemoveMostRecentRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DebugCollectLogsEntryKind : IEquatable { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + private readonly string? _value; -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionQueueClearRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DebugCollectLogsEntryKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Batch of session events returned by a read, with cursor and continuation metadata. -[Experimental(Diagnostics.Experimental)] -public sealed class EventsReadResult -{ - /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. - [JsonPropertyName("cursor")] - public string Cursor { get; set; } = string.Empty; + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. - [JsonPropertyName("cursorStatus")] - public EventsCursorStatus CursorStatus { get; set; } + /// Include a single server-local file. + public static DebugCollectLogsEntryKind File { get; } = new("file"); - /// Events are delivered in two batches per read: persisted events first (in append order), then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral events do not interleave within a single read. - [JsonPropertyName("events")] - public IList Events { get => field ??= []; set; } + /// Include files from a server-local directory recursively. + public static DebugCollectLogsEntryKind Directory { get; } = new("directory"); - /// True when the read returned `max` events and more events are available immediately. When false, the next read with a non-zero `waitMs` will block until a new event arrives or the wait expires. - [JsonPropertyName("hasMore")] - public bool HasMore { get; set; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind right) => left.Equals(right); -/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. -[Experimental(Diagnostics.Experimental)] -internal sealed class EventLogReadRequest -{ - /// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. - [JsonPropertyName("agentScope")] - public EventsAgentScope? AgentScope { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsEntryKind left, DebugCollectLogsEntryKind right) => !(left == right); - /// Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. - [JsonPropertyName("cursor")] - public string? Cursor { get; set; } + /// + public override bool Equals(object? obj) => obj is DebugCollectLogsEntryKind other && Equals(other); - /// Maximum number of events to return in this batch (1–1000, default 200). - [JsonPropertyName("max")] - public int? Max { get; set; } + /// + public bool Equals(DebugCollectLogsEntryKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Either '*' to receive all event types, or a non-empty list of event types to receive. - [JsonPropertyName("types")] - public JsonElement? Types { get; set; } + /// + public override string ToString() => Value; - /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("waitMs")] - public TimeSpan? Wait { get; set; } -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DebugCollectLogsEntryKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). -[Experimental(Diagnostics.Experimental)] -public sealed class EventLogTailResult -{ - /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). - [JsonPropertyName("cursor")] - public string Cursor { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, DebugCollectLogsEntryKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsEntryKind)); + } + } } -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionEventLogTailRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} -/// Opaque handle representing an event-type interest registration. +/// How a collected debug entry should be redacted before being staged. [Experimental(Diagnostics.Experimental)] -public sealed class RegisterEventInterestResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct DebugCollectLogsRedaction : IEquatable { - /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. - [JsonPropertyName("handle")] - public string Handle { get; set; } = string.Empty; -} + private readonly string? _value; -/// Event type to register consumer interest for, used by runtime gating logic. -[Experimental(Diagnostics.Experimental)] -internal sealed class RegisterEventInterestParams -{ - /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full interactive OAuth flow to the consumer; when no interest is registered the runtime installs a browserless fallback that silently reuses cached tokens). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. - [JsonPropertyName("eventType")] - public string EventType { get; set; } = string.Empty; + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public DebugCollectLogsRedaction(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Redact the file as plain UTF-8 log text. + public static DebugCollectLogsRedaction PlainText { get; } = new("plain-text"); + + /// Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. + public static DebugCollectLogsRedaction EventsJsonl { get; } = new("events-jsonl"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(DebugCollectLogsRedaction left, DebugCollectLogsRedaction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(DebugCollectLogsRedaction left, DebugCollectLogsRedaction right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is DebugCollectLogsRedaction other && Equals(other); + + /// + public bool Equals(DebugCollectLogsRedaction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override DebugCollectLogsRedaction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, DebugCollectLogsRedaction value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DebugCollectLogsRedaction)); + } + } } -/// Indicates whether the operation succeeded. -[Experimental(Diagnostics.Experimental)] -public sealed class EventLogReleaseInterestResult -{ - /// Whether the operation succeeded. - [JsonPropertyName("success")] - public bool Success { get; set; } -} -/// Opaque handle previously returned by `registerInterest` to release. +/// Cumulative resource ceiling that stopped a factory run. [Experimental(Diagnostics.Experimental)] -internal sealed class ReleaseEventInterestParams +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryRunFailureKind : IEquatable { - /// Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. - [JsonPropertyName("handle")] - public string Handle { get; set; } = string.Empty; + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryRunFailureKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Aggregated code change metrics. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsCodeChanges -{ - /// Distinct file paths modified during the session. - [JsonPropertyName("filesModified")] - public IList FilesModified { get => field ??= []; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Number of distinct files modified. - [JsonPropertyName("filesModifiedCount")] - public long FilesModifiedCount { get; set; } + /// The run admitted the approved maximum total number of subagents. + public static FactoryRunFailureKind MaxTotalSubagents { get; } = new("maxTotalSubagents"); - /// Total lines of code added. - [JsonPropertyName("linesAdded")] - public long LinesAdded { get; set; } + /// The run reached the approved accumulated active-execution time in seconds. + public static FactoryRunFailureKind TimeoutSeconds { get; } = new("timeoutSeconds"); - /// Total lines of code removed. - [JsonPropertyName("linesRemoved")] - public long LinesRemoved { get; set; } -} + /// The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. + public static FactoryRunFailureKind MaxAiCredits { get; } = new("maxAiCredits"); -/// Request count and cost metrics for this model. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsModelMetricRequests -{ - /// User-initiated premium request cost (with multiplier applied). - [JsonPropertyName("cost")] - public double Cost { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryRunFailureKind left, FactoryRunFailureKind right) => left.Equals(right); - /// Number of API requests made with this model. - [JsonPropertyName("count")] - public long Count { get; set; } -} + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryRunFailureKind left, FactoryRunFailureKind right) => !(left == right); -/// Schema for the `UsageMetricsModelMetricTokenDetail` type. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsModelMetricTokenDetail -{ - /// Accumulated token count for this token type. - [JsonPropertyName("tokenCount")] - public long TokenCount { get; set; } -} + /// + public override bool Equals(object? obj) => obj is FactoryRunFailureKind other && Equals(other); -/// Token usage metrics for this model. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsModelMetricUsage -{ - /// Total tokens read from prompt cache. - [JsonPropertyName("cacheReadTokens")] - public long CacheReadTokens { get; set; } + /// + public bool Equals(FactoryRunFailureKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Total tokens written to prompt cache. - [JsonPropertyName("cacheWriteTokens")] - public long CacheWriteTokens { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Total input tokens consumed. - [JsonPropertyName("inputTokens")] - public long InputTokens { get; set; } + /// + public override string ToString() => Value; - /// Total output tokens produced. - [JsonPropertyName("outputTokens")] - public long OutputTokens { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override FactoryRunFailureKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Total output tokens used for reasoning. - [JsonPropertyName("reasoningTokens")] - public long? ReasoningTokens { get; set; } + /// + public override void Write(Utf8JsonWriter writer, FactoryRunFailureKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunFailureKind)); + } + } } -/// Schema for the `UsageMetricsModelMetric` type. + +/// Execution-critical factory storage operation. [Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsModelMetric +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryDurableOperation : IEquatable { - /// Request count and cost metrics for this model. - [JsonPropertyName("requests")] - public UsageMetricsModelMetricRequests Requests { get => field ??= new(); set; } + private readonly string? _value; - /// Token count details per type. - [JsonPropertyName("tokenDetails")] - public IDictionary? TokenDetails { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryDurableOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Accumulated nano-AI units cost for this model. - [JsonPropertyName("totalNanoAiu")] - public double? TotalNanoAiu { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Token usage metrics for this model. - [JsonPropertyName("usage")] - public UsageMetricsModelMetricUsage Usage { get => field ??= new(); set; } -} + /// Creating the durable run and declared phases. + public static FactoryDurableOperation CreateRun { get; } = new("createRun"); -/// Schema for the `UsageMetricsTokenDetail` type. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageMetricsTokenDetail -{ - /// Accumulated token count for this token type. - [JsonPropertyName("tokenCount")] - public long TokenCount { get; set; } -} + /// Persisting the transition to running. + public static FactoryDurableOperation MarkRunStarted { get; } = new("markRunStarted"); -/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. -[Experimental(Diagnostics.Experimental)] -public sealed class UsageGetMetricsResult -{ - /// Aggregated code change metrics. - [JsonPropertyName("codeChanges")] - public UsageMetricsCodeChanges CodeChanges { get => field ??= new(); set; } + /// Persisting the terminal run envelope. + public static FactoryDurableOperation FinishRun { get; } = new("finishRun"); - /// Currently active model identifier. - [JsonPropertyName("currentModel")] - public string? CurrentModel { get; set; } + /// Persisting subagent admission accounting. + public static FactoryDurableOperation ReserveAgent { get; } = new("reserveAgent"); - /// Input tokens from the most recent main-agent API call. - [JsonPropertyName("lastCallInputTokens")] - public long LastCallInputTokens { get; set; } + /// Rolling back an uncommitted subagent admission. + public static FactoryDurableOperation ReleaseAgent { get; } = new("releaseAgent"); - /// Output tokens from the most recent main-agent API call. - [JsonPropertyName("lastCallOutputTokens")] - public long LastCallOutputTokens { get; set; } + /// Persisting an idempotent model-usage charge. + public static FactoryDurableOperation ChargeCredit { get; } = new("chargeCredit"); - /// Per-model token and request metrics, keyed by model identifier. - [JsonPropertyName("modelMetrics")] - public IDictionary ModelMetrics { get => field ??= new Dictionary(); set; } + /// Persisting active execution time. + public static FactoryDurableOperation AddElapsed { get; } = new("addElapsed"); - /// ISO 8601 timestamp when the session started. - [JsonPropertyName("sessionStartTime")] - public DateTimeOffset SessionStartTime { get; set; } + /// Reading the authoritative AI-credit total. + public static FactoryDurableOperation ReconcileCreditTotal { get; } = new("reconcileCreditTotal"); - /// Session-wide per-token-type accumulated token counts. - [JsonPropertyName("tokenDetails")] - public IDictionary? TokenDetails { get; set; } + /// Reading a journal entry without treating storage failure as a cache miss. + public static FactoryDurableOperation JournalGet { get; } = new("journalGet"); - /// Total time spent in model API calls (milliseconds). - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("totalApiDurationMs")] - public TimeSpan TotalApiDuration { get; set; } + /// Persisting a journal entry before reporting success. + public static FactoryDurableOperation JournalPut { get; } = new("journalPut"); - /// Session-wide accumulated nano-AI units cost. - [JsonPropertyName("totalNanoAiu")] - public double? TotalNanoAiu { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryDurableOperation left, FactoryDurableOperation right) => left.Equals(right); - /// Total user-initiated premium request cost across all models (may be fractional due to multipliers). - [JsonPropertyName("totalPremiumRequestCost")] - public double TotalPremiumRequestCost { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryDurableOperation left, FactoryDurableOperation right) => !(left == right); - /// Raw count of user-initiated API requests. - [JsonPropertyName("totalUserRequests")] - public long TotalUserRequests { get; set; } -} + /// + public override bool Equals(object? obj) => obj is FactoryDurableOperation other && Equals(other); -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionUsageGetMetricsRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public bool Equals(FactoryDurableOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. -[Experimental(Diagnostics.Experimental)] -public sealed class RemoteEnableResult -{ - /// Whether remote steering is enabled. - [JsonPropertyName("remoteSteerable")] - public bool RemoteSteerable { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// GitHub frontend URL for this session. - [Url] - [StringSyntax(StringSyntaxAttribute.Uri)] - [JsonPropertyName("url")] - public string? Url { get; set; } -} + /// + public override string ToString() => Value; -/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. -[Experimental(Diagnostics.Experimental)] -internal sealed class RemoteEnableRequest -{ - /// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. - [JsonPropertyName("mode")] - public RemoteSessionMode? Mode { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override FactoryDurableOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, FactoryDurableOperation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryDurableOperation)); + } + } } -/// Identifies the target session. + +/// Current or terminal state of a factory run. [Experimental(Diagnostics.Experimental)] -internal sealed class SessionRemoteDisableRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryRunStatus : IEquatable { - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryRunStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The run was minted and is awaiting approval. + public static FactoryRunStatus Pending { get; } = new("pending"); + + /// The run is executing. + public static FactoryRunStatus Running { get; } = new("running"); + + /// The run completed successfully. + public static FactoryRunStatus Completed { get; } = new("completed"); + + /// The run was interrupted while resource budget remained. + public static FactoryRunStatus Halted { get; } = new("halted"); + + /// The run was cancelled before completion. + public static FactoryRunStatus Cancelled { get; } = new("cancelled"); + + /// The factory body failed or reached a cumulative resource ceiling. + public static FactoryRunStatus Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryRunStatus left, FactoryRunStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryRunStatus left, FactoryRunStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is FactoryRunStatus other && Equals(other); + + /// + public bool Equals(FactoryRunStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override FactoryRunStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. -[Experimental(Diagnostics.Experimental)] -public sealed class RemoteNotifySteerableChangedResult -{ + /// + public override void Write(Utf8JsonWriter writer, FactoryRunStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryRunStatus)); + } + } } -/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. + +/// Derived lifecycle state of a factory phase. [Experimental(Diagnostics.Experimental)] -internal sealed class RemoteNotifySteerableChangedRequest +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryPhaseStatus : IEquatable { - /// Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. - [JsonPropertyName("remoteSteerable")] - public bool RemoteSteerable { get; set; } + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryPhaseStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Schema for the `ScheduleEntry` type. -[Experimental(Diagnostics.Experimental)] -public sealed class ScheduleEntry -{ - /// Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. - [JsonPropertyName("displayPrompt")] - public string? DisplayPrompt { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). - [JsonPropertyName("id")] - public long Id { get; set; } + /// The phase has not been entered yet. + public static FactoryPhaseStatus Pending { get; } = new("pending"); - /// Interval between scheduled ticks, in milliseconds. - [JsonConverter(typeof(MillisecondsTimeSpanConverter))] - [JsonPropertyName("intervalMs")] - public TimeSpan Interval { get; set; } + /// The phase is currently entered and accumulating active time. + public static FactoryPhaseStatus Active { get; } = new("active"); - /// ISO 8601 timestamp when the next tick is scheduled to fire. - [JsonPropertyName("nextRunAt")] - public DateTimeOffset NextRunAt { get; set; } + /// The phase was entered and has since been closed. + public static FactoryPhaseStatus Completed { get; } = new("completed"); - /// Prompt text that gets enqueued on every tick. - [JsonPropertyName("prompt")] - public string Prompt { get; set; } = string.Empty; + /// The phase was never entered because a later phase was entered or the run reached a terminal state. + public static FactoryPhaseStatus Skipped { get; } = new("skipped"); - /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). - [JsonPropertyName("recurring")] - public bool Recurring { get; set; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryPhaseStatus left, FactoryPhaseStatus right) => left.Equals(right); -/// Snapshot of the currently active recurring prompts for this session. -[Experimental(Diagnostics.Experimental)] -public sealed class ScheduleList -{ - /// Active scheduled prompts, ordered by id. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } -} + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryPhaseStatus left, FactoryPhaseStatus right) => !(left == right); -/// Identifies the target session. -[Experimental(Diagnostics.Experimental)] -internal sealed class SessionScheduleListRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override bool Equals(object? obj) => obj is FactoryPhaseStatus other && Equals(other); -/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. -[Experimental(Diagnostics.Experimental)] -public sealed class ScheduleStopResult -{ - /// The removed entry, or omitted if no entry matched. - [JsonPropertyName("entry")] - public ScheduleEntry? Entry { get; set; } -} + /// + public bool Equals(FactoryPhaseStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Identifier of the scheduled prompt to remove. -[Experimental(Diagnostics.Experimental)] -internal sealed class ScheduleStopRequest -{ - /// Id of the scheduled prompt to remove. - [JsonPropertyName("id")] - public long Id { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override string ToString() => Value; -/// Describes a filesystem error. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsError -{ - /// Error classification. - [JsonPropertyName("code")] - public SessionFsErrorCode Code { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override FactoryPhaseStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Free-form detail about the error, for logging/diagnostics. - [JsonPropertyName("message")] - public string? Message { get; set; } + /// + public override void Write(Utf8JsonWriter writer, FactoryPhaseStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryPhaseStatus)); + } + } } -/// File content as a UTF-8 string, or a filesystem error if the read failed. + +/// Kind of factory progress line. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReadFileResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct FactoryLogLineKind : IEquatable { - /// File content as UTF-8 string. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + private readonly string? _value; - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public FactoryLogLineKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Path of the file to read from the client-provided session filesystem. -public sealed class SessionFsReadFileRequest -{ - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// A narrator log line. + public static FactoryLogLineKind Log { get; } = new("log"); -/// File path, content to write, and optional mode for the client-provided session filesystem. -public sealed class SessionFsWriteFileRequest -{ - /// Content to write. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// A named factory phase marker. + public static FactoryLogLineKind Phase { get; } = new("phase"); - /// Optional POSIX-style mode for newly created files. - [JsonPropertyName("mode")] - public long? Mode { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryLogLineKind left, FactoryLogLineKind right) => left.Equals(right); - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryLogLineKind left, FactoryLogLineKind right) => !(left == right); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override bool Equals(object? obj) => obj is FactoryLogLineKind other && Equals(other); -/// File path, content to append, and optional mode for the client-provided session filesystem. -public sealed class SessionFsAppendFileRequest -{ - /// Content to append. - [JsonPropertyName("content")] - public string Content { get; set; } = string.Empty; + /// + public bool Equals(FactoryLogLineKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Optional POSIX-style mode for newly created files. - [JsonPropertyName("mode")] - public long? Mode { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override FactoryLogLineKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Indicates whether the requested path exists in the client-provided session filesystem. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsExistsResult -{ - /// Whether the path exists. - [JsonPropertyName("exists")] - public bool Exists { get; set; } + /// + public override void Write(Utf8JsonWriter writer, FactoryLogLineKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryLogLineKind)); + } + } } -/// Path to test for existence in the client-provided session filesystem. -public sealed class SessionFsExistsRequest -{ - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; - - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} -/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +/// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsStatResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct WorkspacesWorkspaceDetailsHostType : IEquatable { - /// ISO 8601 timestamp of creation. - [JsonPropertyName("birthtime")] - public DateTimeOffset Birthtime { get; set; } + private readonly string? _value; - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public WorkspacesWorkspaceDetailsHostType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Whether the path is a directory. - [JsonPropertyName("isDirectory")] - public bool IsDirectory { get; set; } + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Whether the path is a file. - [JsonPropertyName("isFile")] - public bool IsFile { get; set; } + /// Workspace repository is hosted on GitHub. + public static WorkspacesWorkspaceDetailsHostType GitHub { get; } = new("github"); - /// ISO 8601 timestamp of last modification. - [JsonPropertyName("mtime")] - public DateTimeOffset Mtime { get; set; } + /// Workspace repository is hosted on Azure DevOps. + public static WorkspacesWorkspaceDetailsHostType Ado { get; } = new("ado"); - /// File size in bytes. - [JsonPropertyName("size")] - public long Size { get; set; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType right) => left.Equals(right); -/// Path whose metadata should be returned from the client-provided session filesystem. -public sealed class SessionFsStatRequest -{ - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType right) => !(left == right); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override bool Equals(object? obj) => obj is WorkspacesWorkspaceDetailsHostType other && Equals(other); -/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. -public sealed class SessionFsMkdirRequest -{ - /// Optional POSIX-style mode for newly created directories. - [JsonPropertyName("mode")] - public long? Mode { get; set; } + /// + public bool Equals(WorkspacesWorkspaceDetailsHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Create parent directories as needed. - [JsonPropertyName("recursive")] - public bool? Recursive { get; set; } + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override WorkspacesWorkspaceDetailsHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, WorkspacesWorkspaceDetailsHostType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspacesWorkspaceDetailsHostType)); + } + } } -/// Names of entries in the requested directory, or a filesystem error if the read failed. + +/// Type of change represented by this file diff. [Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct WorkspaceDiffFileChangeType : IEquatable { - /// Entry names in the directory. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } + private readonly string? _value; - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } -} + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public WorkspaceDiffFileChangeType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } -/// Directory path whose entries should be listed from the client-provided session filesystem. -public sealed class SessionFsReaddirRequest -{ - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// The file was added. + public static WorkspaceDiffFileChangeType Added { get; } = new("added"); -/// Schema for the `SessionFsReaddirWithTypesEntry` type. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirWithTypesEntry -{ - /// Entry name. - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; + /// The file was modified. + public static WorkspaceDiffFileChangeType Modified { get; } = new("modified"); - /// Entry type. - [JsonPropertyName("type")] - public SessionFsReaddirWithTypesEntryType Type { get; set; } -} + /// The file was deleted. + public static WorkspaceDiffFileChangeType Deleted { get; } = new("deleted"); -/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsReaddirWithTypesResult -{ - /// Directory entries with type information. - [JsonPropertyName("entries")] - public IList Entries { get => field ??= []; set; } + /// The file was renamed. + public static WorkspaceDiffFileChangeType Renamed { get; } = new("renamed"); - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } -} + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => left.Equals(right); -/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. -public sealed class SessionFsReaddirWithTypesRequest -{ - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => !(left == right); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override bool Equals(object? obj) => obj is WorkspaceDiffFileChangeType other && Equals(other); -/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. -public sealed class SessionFsRmRequest -{ - /// Ignore errors if the path does not exist. - [JsonPropertyName("force")] - public bool? Force { get; set; } + /// + public bool Equals(WorkspaceDiffFileChangeType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Path using SessionFs conventions. - [JsonPropertyName("path")] - public string Path { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Remove directories and their contents recursively. - [JsonPropertyName("recursive")] - public bool? Recursive { get; set; } + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override WorkspaceDiffFileChangeType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, WorkspaceDiffFileChangeType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffFileChangeType)); + } + } } -/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. -public sealed class SessionFsRenameRequest + +/// Diff mode requested by the client. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct WorkspaceDiffMode : IEquatable { - /// Destination path using SessionFs conventions. - [JsonPropertyName("dest")] - public string Dest { get; set; } = string.Empty; + private readonly string? _value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public WorkspaceDiffMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Source path using SessionFs conventions. - [JsonPropertyName("src")] - public string Src { get; set; } = string.Empty; -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsSqliteQueryResult -{ - /// Column names from the result set. - [JsonPropertyName("columns")] - public IList Columns { get => field ??= []; set; } + /// Return staged, unstaged, and untracked working tree changes. + public static WorkspaceDiffMode Unstaged { get; } = new("unstaged"); - /// Describes a filesystem error. - [JsonPropertyName("error")] - public SessionFsError? Error { get; set; } + /// Return changes compared with the default branch. + public static WorkspaceDiffMode Branch { get; } = new("branch"); - /// SQLite last_insert_rowid() value for INSERT. - [JsonPropertyName("lastInsertRowid")] - public long? LastInsertRowid { get; set; } + /// Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). + public static WorkspaceDiffMode Session { get; } = new("session"); - /// For SELECT: array of row objects. For others: empty array. - [JsonPropertyName("rows")] - public IList> Rows { get => field ??= []; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspaceDiffMode left, WorkspaceDiffMode right) => left.Equals(right); - /// Number of rows affected (for INSERT/UPDATE/DELETE). - [JsonPropertyName("rowsAffected")] - public long RowsAffected { get; set; } -} + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspaceDiffMode left, WorkspaceDiffMode right) => !(left == right); -/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. -public sealed class SessionFsSqliteQueryRequest -{ - /// Optional named bind parameters. - [JsonPropertyName("params")] - public IDictionary? Params { get; set; } + /// + public override bool Equals(object? obj) => obj is WorkspaceDiffMode other && Equals(other); - /// SQL query to execute. - [JsonPropertyName("query")] - public string Query { get; set; } = string.Empty; + /// + public bool Equals(WorkspaceDiffMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected). - [JsonPropertyName("queryType")] - public SessionFsSqliteQueryType QueryType { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// + public override string ToString() => Value; -/// Indicates whether the per-session SQLite database already exists. -[Experimental(Diagnostics.Experimental)] -public sealed class SessionFsSqliteExistsResult -{ - /// Whether the session database already exists. - [JsonPropertyName("exists")] - public bool Exists { get; set; } -} + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override WorkspaceDiffMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } -/// Identifies the target session. -public sealed class SessionFsSqliteExistsRequest -{ - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, WorkspaceDiffMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffMode)); + } + } } -/// Canvas open result returned by the provider. + +/// Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasProviderOpenResult +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct HistoryRewindUnavailableReason : IEquatable { - /// Provider-supplied status text. - [JsonPropertyName("status")] - public string? Status { get; set; } + private readonly string? _value; - /// Provider-supplied title. - [JsonPropertyName("title")] - public string? Title { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public HistoryRewindUnavailableReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// URL for web-rendered canvases. - [JsonPropertyName("url")] - public string? Url { get; set; } -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Host capabilities. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasHostContextCapabilities -{ - /// Whether canvas rendering is supported. - [JsonPropertyName("canvases")] - public bool? Canvases { get; set; } -} + /// The session did not opt into file-change tracking before its first turn. + public static HistoryRewindUnavailableReason FileChangeTrackingDisabled { get; } = new("file-change-tracking-disabled"); -/// Host context supplied by the runtime. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasHostContext -{ - /// Host capabilities. - [JsonPropertyName("capabilities")] - public CanvasHostContextCapabilities? Capabilities { get; set; } -} + /// The session still has work that may mutate files or history. Transient: the same request succeeds once the session settles, so callers should retry rather than treat it as a failure. + public static HistoryRewindUnavailableReason SessionBusy { get; } = new("session-busy"); -/// Session context supplied by the runtime. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasSessionContext -{ - /// Active session working directory, when known. - [JsonPropertyName("workingDirectory")] - public string? WorkingDirectory { get; set; } -} + /// Remote-backed rewind routing is not supported. + public static HistoryRewindUnavailableReason UnsupportedRemoteSession { get; } = new("unsupported-remote-session"); -/// Canvas open parameters sent to the provider. -public sealed class CanvasProviderOpenRequest -{ - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryRewindUnavailableReason left, HistoryRewindUnavailableReason right) => left.Equals(right); - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryRewindUnavailableReason left, HistoryRewindUnavailableReason right) => !(left == right); - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// + public override bool Equals(object? obj) => obj is HistoryRewindUnavailableReason other && Equals(other); - /// Canvas open input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// + public bool Equals(HistoryRewindUnavailableReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Stable caller-supplied canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Session context supplied by the runtime. - [JsonPropertyName("session")] - public CanvasSessionContext? Session { get; set; } + /// + public override string ToString() => Value; - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override HistoryRewindUnavailableReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, HistoryRewindUnavailableReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindUnavailableReason)); + } + } } -/// Canvas close parameters sent to the provider. -public sealed class CanvasProviderCloseRequest -{ - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; +/// Whether task execution is synchronously awaited or managed in the background. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct TaskExecutionMode : IEquatable +{ + private readonly string? _value; - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public TaskExecutionMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; - /// Session context supplied by the runtime. - [JsonPropertyName("session")] - public CanvasSessionContext? Session { get; set; } + /// The task was started with synchronous waiting. + public static TaskExecutionMode Sync { get; } = new("sync"); - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; -} + /// The task is managed in the background. + public static TaskExecutionMode Background { get; } = new("background"); -/// Canvas action invocation parameters sent to the provider. -public sealed class CanvasProviderInvokeActionRequest -{ - /// Action name to invoke. - [JsonPropertyName("actionName")] - public string ActionName { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(TaskExecutionMode left, TaskExecutionMode right) => left.Equals(right); - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public string CanvasId { get; set; } = string.Empty; + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(TaskExecutionMode left, TaskExecutionMode right) => !(left == right); - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public string ExtensionId { get; set; } = string.Empty; + /// + public override bool Equals(object? obj) => obj is TaskExecutionMode other && Equals(other); - /// Host context supplied by the runtime. - [JsonPropertyName("host")] - public CanvasHostContext? Host { get; set; } + /// + public bool Equals(TaskExecutionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - /// Action input. - [JsonPropertyName("input")] - public JsonElement? Input { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Canvas instance identifier. - [JsonPropertyName("instanceId")] - public string InstanceId { get; set; } = string.Empty; + /// + public override string ToString() => Value; - /// Session context supplied by the runtime. - [JsonPropertyName("session")] - public CanvasSessionContext? Session { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override TaskExecutionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } - /// Target session identifier. - [JsonPropertyName("sessionId")] - public string SessionId { get; set; } = string.Empty; + /// + public override void Write(Utf8JsonWriter writer, TaskExecutionMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskExecutionMode)); + } + } } -/// Model capability category for grouping in the model picker. + +/// Current lifecycle status of the task. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPickerCategory : IEquatable +public readonly struct TaskStatus : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelPickerCategory(string value) + public TaskStatus(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Lightweight model category optimized for faster, lower-cost interactions. - public static ModelPickerCategory Lightweight { get; } = new("lightweight"); + /// The task is actively executing. + public static TaskStatus Running { get; } = new("running"); - /// Versatile model category suitable for a broad range of tasks. - public static ModelPickerCategory Versatile { get; } = new("versatile"); + /// The task is waiting for additional input. + public static TaskStatus Idle { get; } = new("idle"); - /// Powerful model category optimized for complex tasks. - public static ModelPickerCategory Powerful { get; } = new("powerful"); + /// The task finished successfully. + public static TaskStatus Completed { get; } = new("completed"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelPickerCategory left, ModelPickerCategory right) => left.Equals(right); + /// The task finished with an error. + public static TaskStatus Failed { get; } = new("failed"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelPickerCategory left, ModelPickerCategory right) => !(left == right); + /// The task was cancelled before completion. + public static TaskStatus Cancelled { get; } = new("cancelled"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(TaskStatus left, TaskStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(TaskStatus left, TaskStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPickerCategory other && Equals(other); + public override bool Equals(object? obj) => obj is TaskStatus other && Equals(other); /// - public bool Equals(ModelPickerCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(TaskStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8385,67 +18711,62 @@ public ModelPickerCategory(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelPickerCategory Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override TaskStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelPickerCategory value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, TaskStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerCategory)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskStatus)); } } } -/// Relative cost tier for token-based billing users. +/// Whether the shell runs inside a managed PTY session or as an independent background process. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPickerPriceCategory : IEquatable +public readonly struct TaskShellInfoAttachmentMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelPickerPriceCategory(string value) + public TaskShellInfoAttachmentMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Lowest relative token cost tier. - public static ModelPickerPriceCategory Low { get; } = new("low"); - - /// Medium relative token cost tier. - public static ModelPickerPriceCategory Medium { get; } = new("medium"); - - /// High relative token cost tier. - public static ModelPickerPriceCategory High { get; } = new("high"); + /// The shell runs in a managed PTY session. + public static TaskShellInfoAttachmentMode Attached { get; } = new("attached"); - /// Highest relative token cost tier. - public static ModelPickerPriceCategory VeryHigh { get; } = new("very_high"); + /// The shell runs as an independent background process. + public static TaskShellInfoAttachmentMode Detached { get; } = new("detached"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelPickerPriceCategory left, ModelPickerPriceCategory right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelPickerPriceCategory left, ModelPickerPriceCategory right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPickerPriceCategory other && Equals(other); + public override bool Equals(object? obj) => obj is TaskShellInfoAttachmentMode other && Equals(other); /// - public bool Equals(ModelPickerPriceCategory other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(TaskShellInfoAttachmentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8453,64 +18774,62 @@ public ModelPickerPriceCategory(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelPickerPriceCategory Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override TaskShellInfoAttachmentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelPickerPriceCategory value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, TaskShellInfoAttachmentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPickerPriceCategory)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskShellInfoAttachmentMode)); } } } -/// Current policy state for this model. +/// Consumer allowed to call an MCP tool. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelPolicyState : IEquatable +public readonly struct McpToolUiVisibility : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelPolicyState(string value) + public McpToolUiVisibility(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The model is enabled by policy. - public static ModelPolicyState Enabled { get; } = new("enabled"); - - /// The model is disabled by policy. - public static ModelPolicyState Disabled { get; } = new("disabled"); + /// The model may call the tool. + public static McpToolUiVisibility Model { get; } = new("model"); - /// No explicit policy is configured for the model. - public static ModelPolicyState Unconfigured { get; } = new("unconfigured"); + /// An MCP App view may call the tool. + public static McpToolUiVisibility App { get; } = new("app"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelPolicyState left, ModelPolicyState right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpToolUiVisibility left, McpToolUiVisibility right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelPolicyState left, ModelPolicyState right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpToolUiVisibility left, McpToolUiVisibility right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelPolicyState other && Equals(other); + public override bool Equals(object? obj) => obj is McpToolUiVisibility other && Equals(other); /// - public bool Equals(ModelPolicyState other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpToolUiVisibility other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8518,67 +18837,65 @@ public ModelPolicyState(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelPolicyState Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpToolUiVisibility Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelPolicyState value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpToolUiVisibility value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelPolicyState)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpToolUiVisibility)); } } } -/// Server transport type: stdio, http, sse (deprecated), or memory. +/// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct DiscoveredMcpServerType : IEquatable +public readonly struct McpSamplingExecutionAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public DiscoveredMcpServerType(string value) + public McpSamplingExecutionAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Server communicates over stdio with a local child process. - public static DiscoveredMcpServerType Stdio { get; } = new("stdio"); - - /// Server communicates over streamable HTTP. - public static DiscoveredMcpServerType Http { get; } = new("http"); + /// The sampling inference completed and produced a result. + public static McpSamplingExecutionAction Success { get; } = new("success"); - /// Server communicates over Server-Sent Events (deprecated). - public static DiscoveredMcpServerType Sse { get; } = new("sse"); + /// The sampling inference failed or was rejected. + public static McpSamplingExecutionAction Failure { get; } = new("failure"); - /// Server is backed by an in-memory runtime implementation. - public static DiscoveredMcpServerType Memory { get; } = new("memory"); + /// The sampling inference was cancelled before completion. + public static McpSamplingExecutionAction Cancelled { get; } = new("cancelled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpSamplingExecutionAction left, McpSamplingExecutionAction right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(DiscoveredMcpServerType left, DiscoveredMcpServerType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpSamplingExecutionAction left, McpSamplingExecutionAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is DiscoveredMcpServerType other && Equals(other); + public override bool Equals(object? obj) => obj is McpSamplingExecutionAction other && Equals(other); /// - public bool Equals(DiscoveredMcpServerType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpSamplingExecutionAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8586,61 +18903,62 @@ public DiscoveredMcpServerType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override DiscoveredMcpServerType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpSamplingExecutionAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, DiscoveredMcpServerType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpSamplingExecutionAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(DiscoveredMcpServerType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSamplingExecutionAction)); } } } -/// Path conventions used by this filesystem. +/// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionFsSetProviderConventions : IEquatable +public readonly struct McpSetEnvValueModeDetails : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionFsSetProviderConventions(string value) + public McpSetEnvValueModeDetails(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Paths use Windows path conventions. - public static SessionFsSetProviderConventions Windows { get; } = new("windows"); + /// Treat MCP server environment values as literal strings. + public static McpSetEnvValueModeDetails Direct { get; } = new("direct"); - /// Paths use POSIX path conventions. - public static SessionFsSetProviderConventions Posix { get; } = new("posix"); + /// Treat MCP server environment values as host-side references to resolve before launch. + public static McpSetEnvValueModeDetails Indirect { get; } = new("indirect"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionFsSetProviderConventions left, SessionFsSetProviderConventions right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionFsSetProviderConventions left, SessionFsSetProviderConventions right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionFsSetProviderConventions other && Equals(other); + public override bool Equals(object? obj) => obj is McpSetEnvValueModeDetails other && Equals(other); /// - public bool Equals(SessionFsSetProviderConventions other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpSetEnvValueModeDetails other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8648,62 +18966,62 @@ public SessionFsSetProviderConventions(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionFsSetProviderConventions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpSetEnvValueModeDetails Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionFsSetProviderConventions value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpSetEnvValueModeDetails value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionFsSetProviderConventions)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSetEnvValueModeDetails)); } } } -/// Neutral SDK discriminator for the connected remote session kind. +/// OAuth grant type override for this login. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ConnectedRemoteSessionMetadataKind : IEquatable +public readonly struct McpOauthLoginGrantType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ConnectedRemoteSessionMetadataKind(string value) + public McpOauthLoginGrantType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Remote CLI session. - public static ConnectedRemoteSessionMetadataKind RemoteSession { get; } = new("remote-session"); + /// Interactive browser-based OAuth flow using an authorization code, typically with PKCE. + public static McpOauthLoginGrantType AuthorizationCode { get; } = new("authorization_code"); - /// GitHub Copilot coding agent session. - public static ConnectedRemoteSessionMetadataKind CodingAgent { get; } = new("coding-agent"); + /// Headless OAuth flow where a confidential client authenticates directly with a client secret. + public static McpOauthLoginGrantType ClientCredentials { get; } = new("client_credentials"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpOauthLoginGrantType left, McpOauthLoginGrantType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ConnectedRemoteSessionMetadataKind left, ConnectedRemoteSessionMetadataKind right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpOauthLoginGrantType left, McpOauthLoginGrantType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ConnectedRemoteSessionMetadataKind other && Equals(other); + public override bool Equals(object? obj) => obj is McpOauthLoginGrantType other && Equals(other); /// - public bool Equals(ConnectedRemoteSessionMetadataKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpOauthLoginGrantType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8711,62 +19029,65 @@ public ConnectedRemoteSessionMetadataKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ConnectedRemoteSessionMetadataKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpOauthLoginGrantType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ConnectedRemoteSessionMetadataKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpOauthLoginGrantType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ConnectedRemoteSessionMetadataKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthLoginGrantType)); } } } -/// Repository host type. +/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionContextHostType : IEquatable +public readonly struct McpAppsSetHostContextDetailsAvailableDisplayMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionContextHostType(string value) + public McpAppsSetHostContextDetailsAvailableDisplayMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Session repository is hosted on GitHub. - public static SessionContextHostType Github { get; } = new("github"); + /// Rendered inline within the host conversation surface. + public static McpAppsSetHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); - /// Session repository is hosted on Azure DevOps. - public static SessionContextHostType Ado { get; } = new("ado"); + /// Rendered as a fullscreen overlay. + public static McpAppsSetHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionContextHostType left, SessionContextHostType right) => left.Equals(right); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsSetHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionContextHostType left, SessionContextHostType right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsAvailableDisplayMode other && Equals(other); /// - public bool Equals(SessionContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsSetHostContextDetailsAvailableDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8774,71 +19095,65 @@ public SessionContextHostType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsSetHostContextDetailsAvailableDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionContextHostType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsAvailableDisplayMode)); } } } -/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +/// Current display mode (SEP-1865). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryAttentionKind : IEquatable +public readonly struct McpAppsSetHostContextDetailsDisplayMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistryLiveTargetEntryAttentionKind(string value) + public McpAppsSetHostContextDetailsDisplayMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Session is blocked on an unrecoverable error. - public static AgentRegistryLiveTargetEntryAttentionKind Error { get; } = new("error"); - - /// Session is waiting for a tool-permission decision. - public static AgentRegistryLiveTargetEntryAttentionKind Permission { get; } = new("permission"); - - /// Session is waiting for the user to approve or reject a plan. - public static AgentRegistryLiveTargetEntryAttentionKind ExitPlan { get; } = new("exit_plan"); - - /// Session is waiting on an elicitation prompt. - public static AgentRegistryLiveTargetEntryAttentionKind Elicitation { get; } = new("elicitation"); + /// Rendered inline within the host conversation surface. + public static McpAppsSetHostContextDetailsDisplayMode Inline { get; } = new("inline"); - /// Session is waiting for free-form user input. - public static AgentRegistryLiveTargetEntryAttentionKind UserInput { get; } = new("user_input"); + /// Rendered as a fullscreen overlay. + public static McpAppsSetHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind right) => left.Equals(right); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsSetHostContextDetailsDisplayMode Pip { get; } = new("pip"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistryLiveTargetEntryAttentionKind left, AgentRegistryLiveTargetEntryAttentionKind right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryAttentionKind other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsDisplayMode other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryAttentionKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsSetHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8846,62 +19161,65 @@ public AgentRegistryLiveTargetEntryAttentionKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistryLiveTargetEntryAttentionKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsSetHostContextDetailsDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryAttentionKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryAttentionKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsDisplayMode)); } } } -/// Process kind tag for the registry entry. +/// Platform type for responsive design. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryKind : IEquatable +public readonly struct McpAppsSetHostContextDetailsPlatform : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistryLiveTargetEntryKind(string value) + public McpAppsSetHostContextDetailsPlatform(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Interactive Copilot CLI exposing a UI server (legacy/normal CLI process). - public static AgentRegistryLiveTargetEntryKind UiServer { get; } = new("ui-server"); + /// Host runs in a web browser. + public static McpAppsSetHostContextDetailsPlatform Web { get; } = new("web"); - /// Headless `--server --managed-server` child spawned by a controller. - public static AgentRegistryLiveTargetEntryKind ManagedServer { get; } = new("managed-server"); + /// Host runs as a desktop application. + public static McpAppsSetHostContextDetailsPlatform Desktop { get; } = new("desktop"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => left.Equals(right); + /// Host runs on a mobile device. + public static McpAppsSetHostContextDetailsPlatform Mobile { get; } = new("mobile"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistryLiveTargetEntryKind left, AgentRegistryLiveTargetEntryKind right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryKind other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsPlatform other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsSetHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8909,62 +19227,62 @@ public AgentRegistryLiveTargetEntryKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistryLiveTargetEntryKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsSetHostContextDetailsPlatform Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsPlatform value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsPlatform)); } } } -/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +/// UI theme preference per SEP-1865. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryLastTerminalEvent : IEquatable +public readonly struct McpAppsSetHostContextDetailsTheme : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistryLiveTargetEntryLastTerminalEvent(string value) + public McpAppsSetHostContextDetailsTheme(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Last turn ended cleanly (model returned a final assistant message). - public static AgentRegistryLiveTargetEntryLastTerminalEvent TurnEnd { get; } = new("turn_end"); + /// Light UI theme. + public static McpAppsSetHostContextDetailsTheme Light { get; } = new("light"); - /// Last turn was aborted (e.g. user interrupted). - public static AgentRegistryLiveTargetEntryLastTerminalEvent Abort { get; } = new("abort"); + /// Dark UI theme. + public static McpAppsSetHostContextDetailsTheme Dark { get; } = new("dark"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistryLiveTargetEntryLastTerminalEvent left, AgentRegistryLiveTargetEntryLastTerminalEvent right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryLastTerminalEvent other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsTheme other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryLastTerminalEvent other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsSetHostContextDetailsTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -8972,68 +19290,65 @@ public AgentRegistryLiveTargetEntryLastTerminalEvent(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistryLiveTargetEntryLastTerminalEvent Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsSetHostContextDetailsTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryLastTerminalEvent value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryLastTerminalEvent)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsTheme)); } } } -/// Coarse lifecycle status of the foreground session. +/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLiveTargetEntryStatus : IEquatable +public readonly struct McpAppsHostContextDetailsAvailableDisplayMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistryLiveTargetEntryStatus(string value) + public McpAppsHostContextDetailsAvailableDisplayMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Session is actively processing a turn. - public static AgentRegistryLiveTargetEntryStatus Working { get; } = new("working"); - - /// Session is idle, waiting for input. - public static AgentRegistryLiveTargetEntryStatus Waiting { get; } = new("waiting"); + /// Rendered inline within the host conversation surface. + public static McpAppsHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); - /// Last turn completed successfully. - public static AgentRegistryLiveTargetEntryStatus Done { get; } = new("done"); + /// Rendered as a fullscreen overlay. + public static McpAppsHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); - /// Session needs user attention (see attentionKind for the specific reason). - public static AgentRegistryLiveTargetEntryStatus Attention { get; } = new("attention"); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsHostContextDetailsAvailableDisplayMode left, McpAppsHostContextDetailsAvailableDisplayMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistryLiveTargetEntryStatus left, AgentRegistryLiveTargetEntryStatus right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsHostContextDetailsAvailableDisplayMode left, McpAppsHostContextDetailsAvailableDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLiveTargetEntryStatus other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsAvailableDisplayMode other && Equals(other); /// - public bool Equals(AgentRegistryLiveTargetEntryStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsHostContextDetailsAvailableDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9041,65 +19356,65 @@ public AgentRegistryLiveTargetEntryStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistryLiveTargetEntryStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsHostContextDetailsAvailableDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistryLiveTargetEntryStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLiveTargetEntryStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsAvailableDisplayMode)); } } } -/// Categorized reason for log-open failure. +/// Current display mode (SEP-1865). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistryLogCaptureOpenErrorReason : IEquatable +public readonly struct McpAppsHostContextDetailsDisplayMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistryLogCaptureOpenErrorReason(string value) + public McpAppsHostContextDetailsDisplayMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Filesystem permission denied opening the log file. - public static AgentRegistryLogCaptureOpenErrorReason Permission { get; } = new("permission"); + /// Rendered inline within the host conversation surface. + public static McpAppsHostContextDetailsDisplayMode Inline { get; } = new("inline"); - /// No space left on device. - public static AgentRegistryLogCaptureOpenErrorReason DiskFull { get; } = new("disk_full"); + /// Rendered as a fullscreen overlay. + public static McpAppsHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); - /// Other / uncategorized open failure. - public static AgentRegistryLogCaptureOpenErrorReason Other { get; } = new("other"); + /// Rendered as a picture-in-picture floating panel. + public static McpAppsHostContextDetailsDisplayMode Pip { get; } = new("pip"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistryLogCaptureOpenErrorReason left, AgentRegistryLogCaptureOpenErrorReason right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistryLogCaptureOpenErrorReason other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsDisplayMode other && Equals(other); /// - public bool Equals(AgentRegistryLogCaptureOpenErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9107,71 +19422,65 @@ public AgentRegistryLogCaptureOpenErrorReason(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistryLogCaptureOpenErrorReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsHostContextDetailsDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistryLogCaptureOpenErrorReason value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsDisplayMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistryLogCaptureOpenErrorReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsDisplayMode)); } } } -/// Which parameter field was invalid. Omitted when the rejection is not field-specific. +/// Platform type for responsive design. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnValidationErrorField : IEquatable +public readonly struct McpAppsHostContextDetailsPlatform : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistrySpawnValidationErrorField(string value) + public McpAppsHostContextDetailsPlatform(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The cwd parameter. - public static AgentRegistrySpawnValidationErrorField Cwd { get; } = new("cwd"); - - /// The session name parameter. - public static AgentRegistrySpawnValidationErrorField Name { get; } = new("name"); - - /// The agentName parameter. - public static AgentRegistrySpawnValidationErrorField AgentName { get; } = new("agentName"); + /// Host runs in a web browser. + public static McpAppsHostContextDetailsPlatform Web { get; } = new("web"); - /// The model parameter. - public static AgentRegistrySpawnValidationErrorField Model { get; } = new("model"); + /// Host runs as a desktop application. + public static McpAppsHostContextDetailsPlatform Desktop { get; } = new("desktop"); - /// The permissionMode parameter. - public static AgentRegistrySpawnValidationErrorField PermissionMode { get; } = new("permissionMode"); + /// Host runs on a mobile device. + public static McpAppsHostContextDetailsPlatform Mobile { get; } = new("mobile"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsHostContextDetailsPlatform left, McpAppsHostContextDetailsPlatform right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistrySpawnValidationErrorField left, AgentRegistrySpawnValidationErrorField right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsHostContextDetailsPlatform left, McpAppsHostContextDetailsPlatform right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorField other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsPlatform other && Equals(other); /// - public bool Equals(AgentRegistrySpawnValidationErrorField other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9179,74 +19488,62 @@ public AgentRegistrySpawnValidationErrorField(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistrySpawnValidationErrorField Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsHostContextDetailsPlatform Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorField value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsPlatform value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorField)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsPlatform)); } } } -/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. +/// UI theme preference per SEP-1865. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnValidationErrorReason : IEquatable +public readonly struct McpAppsHostContextDetailsTheme : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistrySpawnValidationErrorReason(string value) + public McpAppsHostContextDetailsTheme(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Provided cwd does not exist on disk. - public static AgentRegistrySpawnValidationErrorReason CwdNotFound { get; } = new("cwd-not-found"); - - /// Provided cwd exists but is not a directory. - public static AgentRegistrySpawnValidationErrorReason CwdNotDirectory { get; } = new("cwd-not-directory"); - - /// Session name failed validateSessionName. - public static AgentRegistrySpawnValidationErrorReason InvalidName { get; } = new("invalid-name"); - - /// Requested agent name was not found in builtin or custom agents. - public static AgentRegistrySpawnValidationErrorReason UnknownAgent { get; } = new("unknown-agent"); - - /// Requested model is not available to this session. - public static AgentRegistrySpawnValidationErrorReason UnknownModel { get; } = new("unknown-model"); + /// Light UI theme. + public static McpAppsHostContextDetailsTheme Light { get; } = new("light"); - /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode. - public static AgentRegistrySpawnValidationErrorReason YoloNotAllowed { get; } = new("yolo-not-allowed"); + /// Dark UI theme. + public static McpAppsHostContextDetailsTheme Dark { get; } = new("dark"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistrySpawnValidationErrorReason left, AgentRegistrySpawnValidationErrorReason right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnValidationErrorReason other && Equals(other); + public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsTheme other && Equals(other); /// - public bool Equals(AgentRegistrySpawnValidationErrorReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpAppsHostContextDetailsTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9254,62 +19551,62 @@ public AgentRegistrySpawnValidationErrorReason(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistrySpawnValidationErrorReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpAppsHostContextDetailsTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnValidationErrorReason value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnValidationErrorReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsTheme)); } } } -/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. +/// Transport to be used for provider requests. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentRegistrySpawnPermissionMode : IEquatable +public readonly struct ProviderEndpointTransport : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentRegistrySpawnPermissionMode(string value) + public ProviderEndpointTransport(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Standard permission posture (prompts for each request). - public static AgentRegistrySpawnPermissionMode Default { get; } = new("default"); + /// HTTP request/streaming transport. + public static ProviderEndpointTransport Http { get; } = new("http"); - /// Full allow-all (requires the controller-local session to currently be in allow-all mode). - public static AgentRegistrySpawnPermissionMode Yolo { get; } = new("yolo"); + /// WebSocket transport. + public static ProviderEndpointTransport Websockets { get; } = new("websockets"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderEndpointTransport left, ProviderEndpointTransport right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentRegistrySpawnPermissionMode left, AgentRegistrySpawnPermissionMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderEndpointTransport left, ProviderEndpointTransport right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentRegistrySpawnPermissionMode other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointTransport other && Equals(other); /// - public bool Equals(AgentRegistrySpawnPermissionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderEndpointTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9317,68 +19614,65 @@ public AgentRegistrySpawnPermissionMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentRegistrySpawnPermissionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderEndpointTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentRegistrySpawnPermissionMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointTransport value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentRegistrySpawnPermissionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointTransport)); } } } -/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. +/// Provider family. Matches the `type` field of a BYOK provider config. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SendAgentMode : IEquatable +public readonly struct ProviderEndpointType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SendAgentMode(string value) + public ProviderEndpointType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The agent is responding interactively to the user. - public static SendAgentMode Interactive { get; } = new("interactive"); - - /// The agent is preparing a plan before making changes. - public static SendAgentMode Plan { get; } = new("plan"); + /// OpenAI-compatible endpoint (use the OpenAI client library). + public static ProviderEndpointType Openai { get; } = new("openai"); - /// The agent is working autonomously toward task completion. - public static SendAgentMode Autopilot { get; } = new("autopilot"); + /// Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). + public static ProviderEndpointType Azure { get; } = new("azure"); - /// The agent is in shell-focused UI mode. - public static SendAgentMode Shell { get; } = new("shell"); + /// Anthropic endpoint (use the Anthropic client library). + public static ProviderEndpointType Anthropic { get; } = new("anthropic"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SendAgentMode left, SendAgentMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderEndpointType left, ProviderEndpointType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SendAgentMode left, SendAgentMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderEndpointType left, ProviderEndpointType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SendAgentMode other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointType other && Equals(other); /// - public bool Equals(SendAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderEndpointType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9386,65 +19680,62 @@ public SendAgentMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SendAgentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderEndpointType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SendAgentMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendAgentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointType)); } } } -/// Type of GitHub reference. +/// Wire API to be used, when required for the provider type. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SendAttachmentGithubReferenceType : IEquatable +public readonly struct ProviderEndpointWireApi : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SendAttachmentGithubReferenceType(string value) + public ProviderEndpointWireApi(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// GitHub issue reference. - public static SendAttachmentGithubReferenceType Issue { get; } = new("issue"); - - /// GitHub pull request reference. - public static SendAttachmentGithubReferenceType Pr { get; } = new("pr"); + /// Classic chat-completions request shape. + public static ProviderEndpointWireApi Completions { get; } = new("completions"); - /// GitHub discussion reference. - public static SendAttachmentGithubReferenceType Discussion { get; } = new("discussion"); + /// Newer responses request shape. + public static ProviderEndpointWireApi Responses { get; } = new("responses"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SendAttachmentGithubReferenceType left, SendAttachmentGithubReferenceType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderEndpointWireApi left, ProviderEndpointWireApi right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SendAttachmentGithubReferenceType left, SendAttachmentGithubReferenceType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderEndpointWireApi left, ProviderEndpointWireApi right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SendAttachmentGithubReferenceType other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderEndpointWireApi other && Equals(other); /// - public bool Equals(SendAttachmentGithubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderEndpointWireApi other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9452,62 +19743,62 @@ public SendAttachmentGithubReferenceType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SendAttachmentGithubReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderEndpointWireApi Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SendAttachmentGithubReferenceType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderEndpointWireApi value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendAttachmentGithubReferenceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderEndpointWireApi)); } } } -/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. +/// Provider transport. Defaults to "http". [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SendMode : IEquatable +public readonly struct ProviderConfigTransport : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SendMode(string value) + public ProviderConfigTransport(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Append the message to the normal session queue. - public static SendMode Enqueue { get; } = new("enqueue"); + /// HTTP request/streaming transport. + public static ProviderConfigTransport Http { get; } = new("http"); - /// Interject the message during the in-progress turn. - public static SendMode Immediate { get; } = new("immediate"); + /// WebSocket transport. + public static ProviderConfigTransport Websockets { get; } = new("websockets"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SendMode left, SendMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderConfigTransport left, ProviderConfigTransport right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SendMode left, SendMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderConfigTransport left, ProviderConfigTransport right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SendMode other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigTransport other && Equals(other); /// - public bool Equals(SendMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderConfigTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9515,65 +19806,65 @@ public SendMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SendMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderConfigTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SendMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigTransport value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SendMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigTransport)); } } } -/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". +/// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionLogLevel : IEquatable +public readonly struct ProviderConfigType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionLogLevel(string value) + public ProviderConfigType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Informational message. - public static SessionLogLevel Info { get; } = new("info"); + /// Generic OpenAI-compatible API. + public static ProviderConfigType Openai { get; } = new("openai"); - /// Warning message that may require attention. - public static SessionLogLevel Warning { get; } = new("warning"); + /// Azure OpenAI Service endpoint. + public static ProviderConfigType Azure { get; } = new("azure"); - /// Error message describing a failure. - public static SessionLogLevel Error { get; } = new("error"); + /// Anthropic API endpoint. + public static ProviderConfigType Anthropic { get; } = new("anthropic"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionLogLevel left, SessionLogLevel right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderConfigType left, ProviderConfigType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionLogLevel left, SessionLogLevel right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderConfigType left, ProviderConfigType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionLogLevel other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigType other && Equals(other); /// - public bool Equals(SessionLogLevel other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderConfigType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9581,77 +19872,62 @@ public SessionLogLevel(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionLogLevel Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderConfigType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionLogLevel value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLogLevel)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigType)); } } } -/// Authentication type. +/// Wire API format (openai/azure only). Defaults to "completions". [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AuthInfoType : IEquatable +public readonly struct ProviderConfigWireApi : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AuthInfoType(string value) + public ProviderConfigWireApi(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Authentication provided by a GitHub App HMAC credential. - public static AuthInfoType Hmac { get; } = new("hmac"); - - /// Authentication resolved from environment-provided credentials. - public static AuthInfoType Env { get; } = new("env"); - - /// Authentication from an interactive user sign-in. - public static AuthInfoType User { get; } = new("user"); - - /// Authentication delegated to the GitHub CLI. - public static AuthInfoType GhCli { get; } = new("gh-cli"); - - /// Authentication from an API key credential. - public static AuthInfoType ApiKey { get; } = new("api-key"); - - /// Authentication from a GitHub token. - public static AuthInfoType Token { get; } = new("token"); + /// OpenAI Chat Completions wire format. + public static ProviderConfigWireApi Completions { get; } = new("completions"); - /// Authentication from a Copilot API token. - public static AuthInfoType CopilotApiToken { get; } = new("copilot-api-token"); + /// OpenAI Responses API wire format. + public static ProviderConfigWireApi Responses { get; } = new("responses"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AuthInfoType left, AuthInfoType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ProviderConfigWireApi left, ProviderConfigWireApi right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AuthInfoType left, AuthInfoType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ProviderConfigWireApi left, ProviderConfigWireApi right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AuthInfoType other && Equals(other); + public override bool Equals(object? obj) => obj is ProviderConfigWireApi other && Equals(other); /// - public bool Equals(AuthInfoType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ProviderConfigWireApi other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9659,62 +19935,62 @@ public AuthInfoType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AuthInfoType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ProviderConfigWireApi Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AuthInfoType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ProviderConfigWireApi value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AuthInfoType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ProviderConfigWireApi)); } } } -/// Runtime-controlled routing state for an open canvas instance. +/// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct CanvasInstanceAvailability : IEquatable +public readonly struct OptionsUpdateAdditionalContentExclusionPolicyScope : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public CanvasInstanceAvailability(string value) + public OptionsUpdateAdditionalContentExclusionPolicyScope(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The owning provider is currently connected and routing calls will be dispatched normally. - public static CanvasInstanceAvailability Ready { get; } = new("ready"); + /// The content exclusion policy applies to the current repository. + public static OptionsUpdateAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); - /// The owning provider is not currently connected. Routing calls fail with canvas_provider_unavailable until the agent re-issues open_canvas (which rehydrates via a fresh canvas.open) or the provider reconnects. - public static CanvasInstanceAvailability Stale { get; } = new("stale"); + /// The content exclusion policy applies across all repositories. + public static OptionsUpdateAdditionalContentExclusionPolicyScope All { get; } = new("all"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(CanvasInstanceAvailability left, CanvasInstanceAvailability right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OptionsUpdateAdditionalContentExclusionPolicyScope left, OptionsUpdateAdditionalContentExclusionPolicyScope right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(CanvasInstanceAvailability left, CanvasInstanceAvailability right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OptionsUpdateAdditionalContentExclusionPolicyScope left, OptionsUpdateAdditionalContentExclusionPolicyScope right) => !(left == right); /// - public override bool Equals(object? obj) => obj is CanvasInstanceAvailability other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateAdditionalContentExclusionPolicyScope other && Equals(other); /// - public bool Equals(CanvasInstanceAvailability other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OptionsUpdateAdditionalContentExclusionPolicyScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9722,62 +19998,62 @@ public CanvasInstanceAvailability(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override CanvasInstanceAvailability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OptionsUpdateAdditionalContentExclusionPolicyScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, CanvasInstanceAvailability value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CanvasInstanceAvailability)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateAdditionalContentExclusionPolicyScope)); } } } -/// Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. +/// Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelCurrentContextTier : IEquatable +public readonly struct OptionsUpdateContextTier : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelCurrentContextTier(string value) + public OptionsUpdateContextTier(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Use the model's default context window. - public static ModelCurrentContextTier Default { get; } = new("default"); + /// Use the model's default context tier and its standard token limits / pricing. + public static OptionsUpdateContextTier Default { get; } = new("default"); - /// Pin the session to the long-context tier when supported. - public static ModelCurrentContextTier LongContext { get; } = new("long_context"); + /// Use the model's long-context tier (when available) so larger inputs are accepted and tier-specific pricing applies. + public static OptionsUpdateContextTier LongContext { get; } = new("long_context"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelCurrentContextTier left, ModelCurrentContextTier right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OptionsUpdateContextTier left, OptionsUpdateContextTier right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelCurrentContextTier left, ModelCurrentContextTier right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OptionsUpdateContextTier left, OptionsUpdateContextTier right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelCurrentContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateContextTier other && Equals(other); /// - public bool Equals(ModelCurrentContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OptionsUpdateContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9785,61 +20061,62 @@ public ModelCurrentContextTier(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelCurrentContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OptionsUpdateContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelCurrentContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateContextTier value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCurrentContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateContextTier)); } } } -/// Defines the allowed values. +/// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelSwitchToRequestContextTier : IEquatable +public readonly struct OptionsUpdateEnvValueMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelSwitchToRequestContextTier(string value) + public OptionsUpdateEnvValueMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Use the model's default context window. - public static ModelSwitchToRequestContextTier Default { get; } = new("default"); + /// Pass MCP server environment values as literal strings. + public static OptionsUpdateEnvValueMode Direct { get; } = new("direct"); - /// Pin the session to the long-context tier when supported. - public static ModelSwitchToRequestContextTier LongContext { get; } = new("long_context"); + /// Resolve MCP server environment values from host-side references. + public static OptionsUpdateEnvValueMode Indirect { get; } = new("indirect"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelSwitchToRequestContextTier left, ModelSwitchToRequestContextTier right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelSwitchToRequestContextTier left, ModelSwitchToRequestContextTier right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelSwitchToRequestContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateEnvValueMode other && Equals(other); /// - public bool Equals(ModelSwitchToRequestContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OptionsUpdateEnvValueMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9847,62 +20124,65 @@ public ModelSwitchToRequestContextTier(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelSwitchToRequestContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OptionsUpdateEnvValueMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelSwitchToRequestContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateEnvValueMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelSwitchToRequestContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateEnvValueMode)); } } } -/// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. +/// Reasoning summary mode for supported model clients. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspacesWorkspaceDetailsHostType : IEquatable +public readonly struct OptionsUpdateReasoningSummary : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkspacesWorkspaceDetailsHostType(string value) + public OptionsUpdateReasoningSummary(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Workspace repository is hosted on GitHub. - public static WorkspacesWorkspaceDetailsHostType Github { get; } = new("github"); + /// Do not request reasoning summaries from the model. + public static OptionsUpdateReasoningSummary None { get; } = new("none"); - /// Workspace repository is hosted on Azure DevOps. - public static WorkspacesWorkspaceDetailsHostType Ado { get; } = new("ado"); + /// Request a concise summary of model reasoning. + public static OptionsUpdateReasoningSummary Concise { get; } = new("concise"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType right) => left.Equals(right); + /// Request a detailed summary of model reasoning. + public static OptionsUpdateReasoningSummary Detailed { get; } = new("detailed"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspacesWorkspaceDetailsHostType left, WorkspacesWorkspaceDetailsHostType right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OptionsUpdateReasoningSummary left, OptionsUpdateReasoningSummary right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OptionsUpdateReasoningSummary left, OptionsUpdateReasoningSummary right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspacesWorkspaceDetailsHostType other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateReasoningSummary other && Equals(other); /// - public bool Equals(WorkspacesWorkspaceDetailsHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OptionsUpdateReasoningSummary other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9910,68 +20190,89 @@ public WorkspacesWorkspaceDetailsHostType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkspacesWorkspaceDetailsHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OptionsUpdateReasoningSummary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkspacesWorkspaceDetailsHostType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateReasoningSummary value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspacesWorkspaceDetailsHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateReasoningSummary)); } } } -/// Type of change represented by this file diff. +/// Session capability enabled for this session. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceDiffFileChangeType : IEquatable +public readonly struct SessionCapability : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkspaceDiffFileChangeType(string value) + public SessionCapability(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The file was added. - public static WorkspaceDiffFileChangeType Added { get; } = new("added"); + /// TUI-specific prompt hints such as keyboard shortcuts. + public static SessionCapability TuiHints { get; } = new("tui-hints"); - /// The file was modified. - public static WorkspaceDiffFileChangeType Modified { get; } = new("modified"); + /// Plan-mode handling and instructions. + public static SessionCapability PlanMode { get; } = new("plan-mode"); - /// The file was deleted. - public static WorkspaceDiffFileChangeType Deleted { get; } = new("deleted"); + /// Memory tool and memories prompt section. + public static SessionCapability Memory { get; } = new("memory"); - /// The file was renamed. - public static WorkspaceDiffFileChangeType Renamed { get; } = new("renamed"); + /// Copilot CLI documentation tool and prompt section. + public static SessionCapability CliDocumentation { get; } = new("cli-documentation"); + + /// Interactive ask_user tool support. + public static SessionCapability AskUser { get; } = new("ask-user"); + + /// Interactive CLI identity and behavior. + public static SessionCapability InteractiveMode { get; } = new("interactive-mode"); + + /// Automatic hidden system notifications. + public static SessionCapability SystemNotifications { get; } = new("system-notifications"); + + /// SDK elicitation support. + public static SessionCapability Elicitation { get; } = new("elicitation"); + + /// Cross-session history tools and session-store SQL prompt/tool metadata. + public static SessionCapability SessionStore { get; } = new("session-store"); + + /// MCP Apps UI passthrough. + public static SessionCapability McpApps { get; } = new("mcp-apps"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => left.Equals(right); + /// Host-provided canvas rendering support. + public static SessionCapability CanvasRenderer { get; } = new("canvas-renderer"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspaceDiffFileChangeType left, WorkspaceDiffFileChangeType right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionCapability left, SessionCapability right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionCapability left, SessionCapability right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceDiffFileChangeType other && Equals(other); + public override bool Equals(object? obj) => obj is SessionCapability other && Equals(other); /// - public bool Equals(WorkspaceDiffFileChangeType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionCapability other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -9979,62 +20280,62 @@ public WorkspaceDiffFileChangeType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkspaceDiffFileChangeType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionCapability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkspaceDiffFileChangeType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionCapability value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffFileChangeType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionCapability)); } } } -/// Diff mode requested by the client. +/// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceDiffMode : IEquatable +public readonly struct ShellInitProfile : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkspaceDiffMode(string value) + public ShellInitProfile(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Return staged, unstaged, and untracked working tree changes. - public static WorkspaceDiffMode Unstaged { get; } = new("unstaged"); + /// Disable automatic non-interactive profile loading. Explicit initScripts still run. + public static ShellInitProfile None { get; } = new("none"); - /// Return changes compared with the default branch. - public static WorkspaceDiffMode Branch { get; } = new("branch"); + /// Allow automatic non-interactive profile loading when supported. Explicit initScripts still run. + public static ShellInitProfile NonInteractive { get; } = new("non-interactive"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspaceDiffMode left, WorkspaceDiffMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ShellInitProfile left, ShellInitProfile right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspaceDiffMode left, WorkspaceDiffMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ShellInitProfile left, ShellInitProfile right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceDiffMode other && Equals(other); + public override bool Equals(object? obj) => obj is ShellInitProfile other && Equals(other); /// - public bool Equals(WorkspaceDiffMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ShellInitProfile other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10042,68 +20343,62 @@ public WorkspaceDiffMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkspaceDiffMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ShellInitProfile Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkspaceDiffMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ShellInitProfile value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceDiffMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellInitProfile)); } } } -/// Where this source lives — used for UI grouping. +/// Supported built-in shells for initialization scripts. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionsSourcesLocation : IEquatable +public readonly struct ShellInitScriptShell : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public InstructionsSourcesLocation(string value) + public ShellInitScriptShell(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Instructions live in user-level configuration. - public static InstructionsSourcesLocation User { get; } = new("user"); - - /// Instructions live in repository-level configuration. - public static InstructionsSourcesLocation Repository { get; } = new("repository"); - - /// Instructions live under the current working directory. - public static InstructionsSourcesLocation WorkingDirectory { get; } = new("working-directory"); + /// Source the script in the built-in Bash shell on macOS and Linux. + public static ShellInitScriptShell Bash { get; } = new("bash"); - /// Instructions live in plugin-provided configuration. - public static InstructionsSourcesLocation Plugin { get; } = new("plugin"); + /// Source the script in the built-in PowerShell shell on Windows. + public static ShellInitScriptShell Powershell { get; } = new("powershell"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(InstructionsSourcesLocation left, InstructionsSourcesLocation right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ShellInitScriptShell left, ShellInitScriptShell right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(InstructionsSourcesLocation left, InstructionsSourcesLocation right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ShellInitScriptShell left, ShellInitScriptShell right) => !(left == right); /// - public override bool Equals(object? obj) => obj is InstructionsSourcesLocation other && Equals(other); + public override bool Equals(object? obj) => obj is ShellInitScriptShell other && Equals(other); /// - public bool Equals(InstructionsSourcesLocation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ShellInitScriptShell other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10111,77 +20406,62 @@ public InstructionsSourcesLocation(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override InstructionsSourcesLocation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ShellInitScriptShell Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, InstructionsSourcesLocation value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ShellInitScriptShell value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionsSourcesLocation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellInitScriptShell)); } } } -/// Category of instruction source — used for merge logic. +/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct InstructionsSourcesType : IEquatable +public readonly struct OptionsUpdateToolFilterPrecedence : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public InstructionsSourcesType(string value) + public OptionsUpdateToolFilterPrecedence(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Instructions loaded from the user's home configuration. - public static InstructionsSourcesType Home { get; } = new("home"); - - /// Instructions loaded from repository-scoped files. - public static InstructionsSourcesType Repo { get; } = new("repo"); - - /// Instructions loaded from model-specific files. - public static InstructionsSourcesType Model { get; } = new("model"); - - /// Instructions loaded from VS Code instruction files. - public static InstructionsSourcesType Vscode { get; } = new("vscode"); - - /// Instructions discovered from nested agent files. - public static InstructionsSourcesType NestedAgents { get; } = new("nested-agents"); - - /// Instructions inherited from child instruction files. - public static InstructionsSourcesType ChildInstructions { get; } = new("child-instructions"); + /// If availableTools is set, it is the only constraint that applies (excludedTools is ignored). Preserves CLI / pre-existing client behavior. Default. + public static OptionsUpdateToolFilterPrecedence Available { get; } = new("available"); - /// Instructions supplied by an installed plugin. - public static InstructionsSourcesType Plugin { get; } = new("plugin"); + /// A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND it does not match the denylist. Makes 'all except X' expressible by combining the two lists. + public static OptionsUpdateToolFilterPrecedence Excluded { get; } = new("excluded"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(InstructionsSourcesType left, InstructionsSourcesType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(InstructionsSourcesType left, InstructionsSourcesType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => !(left == right); /// - public override bool Equals(object? obj) => obj is InstructionsSourcesType other && Equals(other); + public override bool Equals(object? obj) => obj is OptionsUpdateToolFilterPrecedence other && Equals(other); /// - public bool Equals(InstructionsSourcesType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OptionsUpdateToolFilterPrecedence other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10189,74 +20469,68 @@ public InstructionsSourcesType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override InstructionsSourcesType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OptionsUpdateToolFilterPrecedence Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, InstructionsSourcesType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OptionsUpdateToolFilterPrecedence value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(InstructionsSourcesType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateToolFilterPrecedence)); } } } -/// Where the agent definition was loaded from. +/// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state/<id>/extensions/). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AgentInfoSource : IEquatable +public readonly struct ExtensionSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AgentInfoSource(string value) + public ExtensionSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Agent loaded from the user's personal agent configuration. - public static AgentInfoSource User { get; } = new("user"); - - /// Agent loaded from the current project's repository configuration. - public static AgentInfoSource Project { get; } = new("project"); - - /// Agent inherited from a parent project or workspace. - public static AgentInfoSource Inherited { get; } = new("inherited"); + /// Extension discovered from the current project's .github/extensions directory. + public static ExtensionSource Project { get; } = new("project"); - /// Agent provided by a remote runtime or service. - public static AgentInfoSource Remote { get; } = new("remote"); + /// Extension discovered from the user's ~/.copilot/extensions directory. + public static ExtensionSource User { get; } = new("user"); - /// Agent contributed by an installed plugin. - public static AgentInfoSource Plugin { get; } = new("plugin"); + /// Extension contributed by an installed plugin. + public static ExtensionSource Plugin { get; } = new("plugin"); - /// Agent built into the Copilot runtime. - public static AgentInfoSource Builtin { get; } = new("builtin"); + /// Extension discovered from the current session's state directory (loaded only for this session). + public static ExtensionSource Session { get; } = new("session"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AgentInfoSource left, AgentInfoSource right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ExtensionSource left, ExtensionSource right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AgentInfoSource left, AgentInfoSource right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ExtensionSource left, ExtensionSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AgentInfoSource other && Equals(other); + public override bool Equals(object? obj) => obj is ExtensionSource other && Equals(other); /// - public bool Equals(AgentInfoSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ExtensionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10264,62 +20538,68 @@ public AgentInfoSource(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AgentInfoSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ExtensionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AgentInfoSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ExtensionSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AgentInfoSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionSource)); } } } -/// Whether task execution is synchronously awaited or managed in the background. +/// Current status: running, disabled, failed, or starting. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskExecutionMode : IEquatable +public readonly struct ExtensionStatus : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public TaskExecutionMode(string value) + public ExtensionStatus(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The task was started with synchronous waiting. - public static TaskExecutionMode Sync { get; } = new("sync"); + /// The extension process is running. + public static ExtensionStatus Running { get; } = new("running"); - /// The task is managed in the background. - public static TaskExecutionMode Background { get; } = new("background"); + /// The extension is installed but disabled. + public static ExtensionStatus Disabled { get; } = new("disabled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(TaskExecutionMode left, TaskExecutionMode right) => left.Equals(right); + /// The extension failed to start or crashed. + public static ExtensionStatus Failed { get; } = new("failed"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(TaskExecutionMode left, TaskExecutionMode right) => !(left == right); + /// The extension process is starting. + public static ExtensionStatus Starting { get; } = new("starting"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ExtensionStatus left, ExtensionStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ExtensionStatus left, ExtensionStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is TaskExecutionMode other && Equals(other); + public override bool Equals(object? obj) => obj is ExtensionStatus other && Equals(other); /// - public bool Equals(TaskExecutionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ExtensionStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10327,71 +20607,65 @@ public TaskExecutionMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override TaskExecutionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ExtensionStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, TaskExecutionMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ExtensionStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskExecutionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionStatus)); } } } -/// Current lifecycle status of the task. +/// Type of GitHub reference. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskStatus : IEquatable +public readonly struct PushAttachmentGitHubReferenceType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public TaskStatus(string value) + public PushAttachmentGitHubReferenceType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The task is actively executing. - public static TaskStatus Running { get; } = new("running"); - - /// The task is waiting for additional input. - public static TaskStatus Idle { get; } = new("idle"); - - /// The task finished successfully. - public static TaskStatus Completed { get; } = new("completed"); + /// GitHub issue reference. + public static PushAttachmentGitHubReferenceType Issue { get; } = new("issue"); - /// The task finished with an error. - public static TaskStatus Failed { get; } = new("failed"); + /// GitHub pull request reference. + public static PushAttachmentGitHubReferenceType Pr { get; } = new("pr"); - /// The task was cancelled before completion. - public static TaskStatus Cancelled { get; } = new("cancelled"); + /// GitHub discussion reference. + public static PushAttachmentGitHubReferenceType Discussion { get; } = new("discussion"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(TaskStatus left, TaskStatus right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PushAttachmentGitHubReferenceType left, PushAttachmentGitHubReferenceType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(TaskStatus left, TaskStatus right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PushAttachmentGitHubReferenceType left, PushAttachmentGitHubReferenceType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is TaskStatus other && Equals(other); + public override bool Equals(object? obj) => obj is PushAttachmentGitHubReferenceType other && Equals(other); /// - public bool Equals(TaskStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PushAttachmentGitHubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10399,62 +20673,65 @@ public TaskStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override TaskStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PushAttachmentGitHubReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, TaskStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PushAttachmentGitHubReferenceType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PushAttachmentGitHubReferenceType)); } } } -/// Whether the shell runs inside a managed PTY session or as an independent background process. +/// Context tier override for matching subagents. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct TaskShellInfoAttachmentMode : IEquatable +public readonly struct SubagentSettingsEntryContextTier : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public TaskShellInfoAttachmentMode(string value) + public SubagentSettingsEntryContextTier(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The shell runs in a managed PTY session. - public static TaskShellInfoAttachmentMode Attached { get; } = new("attached"); + /// Inherit the parent session's effective context tier at dispatch time. + public static SubagentSettingsEntryContextTier Inherit { get; } = new("inherit"); - /// The shell runs as an independent background process. - public static TaskShellInfoAttachmentMode Detached { get; } = new("detached"); + /// Use the model's default context window. + public static SubagentSettingsEntryContextTier Default { get; } = new("default"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode right) => left.Equals(right); + /// Pin the subagent to the long-context tier when supported. + public static SubagentSettingsEntryContextTier LongContext { get; } = new("long_context"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(TaskShellInfoAttachmentMode left, TaskShellInfoAttachmentMode right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SubagentSettingsEntryContextTier left, SubagentSettingsEntryContextTier right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SubagentSettingsEntryContextTier left, SubagentSettingsEntryContextTier right) => !(left == right); /// - public override bool Equals(object? obj) => obj is TaskShellInfoAttachmentMode other && Equals(other); + public override bool Equals(object? obj) => obj is SubagentSettingsEntryContextTier other && Equals(other); /// - public bool Equals(TaskShellInfoAttachmentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SubagentSettingsEntryContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10462,65 +20739,65 @@ public TaskShellInfoAttachmentMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override TaskShellInfoAttachmentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SubagentSettingsEntryContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, TaskShellInfoAttachmentMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SubagentSettingsEntryContextTier value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskShellInfoAttachmentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SubagentSettingsEntryContextTier)); } } } -/// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. +/// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpSamplingExecutionAction : IEquatable +public readonly struct UIElicitationResponseAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpSamplingExecutionAction(string value) + public UIElicitationResponseAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The sampling inference completed and produced a result. - public static McpSamplingExecutionAction Success { get; } = new("success"); - - /// The sampling inference failed or was rejected. - public static McpSamplingExecutionAction Failure { get; } = new("failure"); + /// The user submitted the requested form values. + public static UIElicitationResponseAction Accept { get; } = new("accept"); - /// The sampling inference was cancelled before completion. - public static McpSamplingExecutionAction Cancelled { get; } = new("cancelled"); + /// The user explicitly declined to provide the requested input. + public static UIElicitationResponseAction Decline { get; } = new("decline"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpSamplingExecutionAction left, McpSamplingExecutionAction right) => left.Equals(right); + /// The user dismissed the elicitation request. + public static UIElicitationResponseAction Cancel { get; } = new("cancel"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpSamplingExecutionAction left, McpSamplingExecutionAction right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UIElicitationResponseAction left, UIElicitationResponseAction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UIElicitationResponseAction left, UIElicitationResponseAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpSamplingExecutionAction other && Equals(other); + public override bool Equals(object? obj) => obj is UIElicitationResponseAction other && Equals(other); /// - public bool Equals(McpSamplingExecutionAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UIElicitationResponseAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10528,62 +20805,65 @@ public McpSamplingExecutionAction(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpSamplingExecutionAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override UIElicitationResponseAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpSamplingExecutionAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIElicitationResponseAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSamplingExecutionAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIElicitationResponseAction)); } } } -/// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". +/// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpSetEnvValueModeDetails : IEquatable +public readonly struct UIAutoModeSwitchResponse : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpSetEnvValueModeDetails(string value) + public UIAutoModeSwitchResponse(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Treat MCP server environment values as literal strings. - public static McpSetEnvValueModeDetails Direct { get; } = new("direct"); + /// Allow the automatic mode switch for this turn. + public static UIAutoModeSwitchResponse Yes { get; } = new("yes"); - /// Treat MCP server environment values as host-side references to resolve before launch. - public static McpSetEnvValueModeDetails Indirect { get; } = new("indirect"); + /// Allow this mode switch and persist the preference. + public static UIAutoModeSwitchResponse YesAlways { get; } = new("yes_always"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => left.Equals(right); + /// Decline the automatic mode switch. + public static UIAutoModeSwitchResponse No { get; } = new("no"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpSetEnvValueModeDetails left, McpSetEnvValueModeDetails right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UIAutoModeSwitchResponse left, UIAutoModeSwitchResponse right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UIAutoModeSwitchResponse left, UIAutoModeSwitchResponse right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpSetEnvValueModeDetails other && Equals(other); + public override bool Equals(object? obj) => obj is UIAutoModeSwitchResponse other && Equals(other); /// - public bool Equals(McpSetEnvValueModeDetails other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UIAutoModeSwitchResponse other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10591,65 +20871,68 @@ public McpSetEnvValueModeDetails(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpSetEnvValueModeDetails Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override UIAutoModeSwitchResponse Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpSetEnvValueModeDetails value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIAutoModeSwitchResponse value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpSetEnvValueModeDetails)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIAutoModeSwitchResponse)); } } } -/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. +/// User action selected for an exhausted session limit. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsAvailableDisplayMode : IEquatable +public readonly struct UISessionLimitsExhaustedResponseAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsSetHostContextDetailsAvailableDisplayMode(string value) + public UISessionLimitsExhaustedResponseAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Rendered inline within the host conversation surface. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); + /// Increase the current max by an exact AI Credits amount. + public static UISessionLimitsExhaustedResponseAction Add { get; } = new("add"); - /// Rendered as a fullscreen overlay. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); + /// Set a new absolute max AI Credits value. + public static UISessionLimitsExhaustedResponseAction Set { get; } = new("set"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsSetHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); + /// Remove the current session limit. + public static UISessionLimitsExhaustedResponseAction Unset { get; } = new("unset"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode right) => left.Equals(right); + /// Leave the limit unchanged and cancel the blocked model request. + public static UISessionLimitsExhaustedResponseAction Cancel { get; } = new("cancel"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsSetHostContextDetailsAvailableDisplayMode left, McpAppsSetHostContextDetailsAvailableDisplayMode right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UISessionLimitsExhaustedResponseAction left, UISessionLimitsExhaustedResponseAction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UISessionLimitsExhaustedResponseAction left, UISessionLimitsExhaustedResponseAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsAvailableDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is UISessionLimitsExhaustedResponseAction other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsAvailableDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UISessionLimitsExhaustedResponseAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10657,65 +20940,68 @@ public McpAppsSetHostContextDetailsAvailableDisplayMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsSetHostContextDetailsAvailableDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override UISessionLimitsExhaustedResponseAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UISessionLimitsExhaustedResponseAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsAvailableDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UISessionLimitsExhaustedResponseAction)); } } } -/// Current display mode (SEP-1865). +/// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsDisplayMode : IEquatable +public readonly struct UIExitPlanModeAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsSetHostContextDetailsDisplayMode(string value) + public UIExitPlanModeAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Rendered inline within the host conversation surface. - public static McpAppsSetHostContextDetailsDisplayMode Inline { get; } = new("inline"); + /// Exit plan mode without starting implementation. + public static UIExitPlanModeAction ExitOnly { get; } = new("exit_only"); - /// Rendered as a fullscreen overlay. - public static McpAppsSetHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); + /// Exit plan mode and continue interactively. + public static UIExitPlanModeAction Interactive { get; } = new("interactive"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsSetHostContextDetailsDisplayMode Pip { get; } = new("pip"); + /// Exit plan mode and continue in autopilot mode. + public static UIExitPlanModeAction Autopilot { get; } = new("autopilot"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode right) => left.Equals(right); + /// Exit plan mode and continue in autopilot mode with parallel subagent execution. + public static UIExitPlanModeAction AutopilotFleet { get; } = new("autopilot_fleet"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsSetHostContextDetailsDisplayMode left, McpAppsSetHostContextDetailsDisplayMode right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UIExitPlanModeAction left, UIExitPlanModeAction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UIExitPlanModeAction left, UIExitPlanModeAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is UIExitPlanModeAction other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(UIExitPlanModeAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10723,65 +21009,62 @@ public McpAppsSetHostContextDetailsDisplayMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsSetHostContextDetailsDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override UIExitPlanModeAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsDisplayMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, UIExitPlanModeAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIExitPlanModeAction)); } } } -/// Platform type for responsive design. +/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsPlatform : IEquatable +public readonly struct PermissionsConfigureAdditionalContentExclusionPolicyScope : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsSetHostContextDetailsPlatform(string value) + public PermissionsConfigureAdditionalContentExclusionPolicyScope(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Host runs in a web browser. - public static McpAppsSetHostContextDetailsPlatform Web { get; } = new("web"); - - /// Host runs as a desktop application. - public static McpAppsSetHostContextDetailsPlatform Desktop { get; } = new("desktop"); + /// The content exclusion policy applies to the current repository. + public static PermissionsConfigureAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); - /// Host runs on a mobile device. - public static McpAppsSetHostContextDetailsPlatform Mobile { get; } = new("mobile"); + /// The content exclusion policy applies across all repositories. + public static PermissionsConfigureAdditionalContentExclusionPolicyScope All { get; } = new("all"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsSetHostContextDetailsPlatform left, McpAppsSetHostContextDetailsPlatform right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsPlatform other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsConfigureAdditionalContentExclusionPolicyScope other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionsConfigureAdditionalContentExclusionPolicyScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10789,62 +21072,65 @@ public McpAppsSetHostContextDetailsPlatform(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsSetHostContextDetailsPlatform Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionsConfigureAdditionalContentExclusionPolicyScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsPlatform value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsConfigureAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsPlatform)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsConfigureAdditionalContentExclusionPolicyScope)); } } } -/// UI theme preference per SEP-1865. +/// Disposition of a permission request as observed by the responding client. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsSetHostContextDetailsTheme : IEquatable +public readonly struct PermissionDecisionOutcome : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsSetHostContextDetailsTheme(string value) + public PermissionDecisionOutcome(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Light UI theme. - public static McpAppsSetHostContextDetailsTheme Light { get; } = new("light"); + /// The request was approved automatically without a new human decision. + public static PermissionDecisionOutcome AutoApproved { get; } = new("auto_approved"); - /// Dark UI theme. - public static McpAppsSetHostContextDetailsTheme Dark { get; } = new("dark"); + /// The request was denied without an interactive user decision; source records why. + public static PermissionDecisionOutcome AutopilotDenied { get; } = new("autopilot_denied"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme right) => left.Equals(right); + /// The response came from an interactive user prompt. + public static PermissionDecisionOutcome PromptedUser { get; } = new("prompted_user"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsSetHostContextDetailsTheme left, McpAppsSetHostContextDetailsTheme right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionDecisionOutcome left, PermissionDecisionOutcome right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionDecisionOutcome left, PermissionDecisionOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsSetHostContextDetailsTheme other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionOutcome other && Equals(other); /// - public bool Equals(McpAppsSetHostContextDetailsTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionDecisionOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10852,65 +21138,68 @@ public McpAppsSetHostContextDetailsTheme(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsSetHostContextDetailsTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionDecisionOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsSetHostContextDetailsTheme value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionDecisionOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsSetHostContextDetailsTheme)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionOutcome)); } } } -/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +/// Controlled reason or actor responsible for a permission response. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsAvailableDisplayMode : IEquatable +public readonly struct PermissionDecisionSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsHostContextDetailsAvailableDisplayMode(string value) + public PermissionDecisionSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Rendered inline within the host conversation surface. - public static McpAppsHostContextDetailsAvailableDisplayMode Inline { get; } = new("inline"); + /// The response followed the auto-approval judge recommendation. + public static PermissionDecisionSource JudgeRecommendation { get; } = new("judge_recommendation"); - /// Rendered as a fullscreen overlay. - public static McpAppsHostContextDetailsAvailableDisplayMode Fullscreen { get; } = new("fullscreen"); + /// A human supplied the response through an interactive prompt. + public static PermissionDecisionSource HumanResponse { get; } = new("human_response"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsHostContextDetailsAvailableDisplayMode Pip { get; } = new("pip"); + /// The host applied a standing policy or override rather than a judge recommendation or human decision. + public static PermissionDecisionSource HostPolicy { get; } = new("host_policy"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsHostContextDetailsAvailableDisplayMode left, McpAppsHostContextDetailsAvailableDisplayMode right) => left.Equals(right); + /// The host denied the request because no interactive user response was available. + public static PermissionDecisionSource UnattendedFallback { get; } = new("unattended_fallback"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsHostContextDetailsAvailableDisplayMode left, McpAppsHostContextDetailsAvailableDisplayMode right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionDecisionSource left, PermissionDecisionSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionDecisionSource left, PermissionDecisionSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsAvailableDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionSource other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsAvailableDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionDecisionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10918,65 +21207,68 @@ public McpAppsHostContextDetailsAvailableDisplayMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsHostContextDetailsAvailableDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionDecisionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsAvailableDisplayMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionDecisionSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsAvailableDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionSource)); } } } -/// Current display mode (SEP-1865). +/// Client surface that submitted a permission response. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsDisplayMode : IEquatable +public readonly struct PermissionDecisionSurface : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsHostContextDetailsDisplayMode(string value) + public PermissionDecisionSurface(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Rendered inline within the host conversation surface. - public static McpAppsHostContextDetailsDisplayMode Inline { get; } = new("inline"); + /// The interactive Copilot CLI terminal UI. + public static PermissionDecisionSurface Tui { get; } = new("tui"); - /// Rendered as a fullscreen overlay. - public static McpAppsHostContextDetailsDisplayMode Fullscreen { get; } = new("fullscreen"); + /// The non-interactive Copilot CLI prompt mode. + public static PermissionDecisionSurface PromptMode { get; } = new("prompt_mode"); - /// Rendered as a picture-in-picture floating panel. - public static McpAppsHostContextDetailsDisplayMode Pip { get; } = new("pip"); + /// The Copilot App client. + public static PermissionDecisionSurface CopilotApp { get; } = new("copilot_app"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => left.Equals(right); + /// A generic Copilot SDK client. + public static PermissionDecisionSurface Sdk { get; } = new("sdk"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsHostContextDetailsDisplayMode left, McpAppsHostContextDetailsDisplayMode right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionDecisionSurface left, PermissionDecisionSurface right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionDecisionSurface left, PermissionDecisionSurface right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsDisplayMode other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionDecisionSurface other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsDisplayMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionDecisionSurface other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -10984,65 +21276,68 @@ public McpAppsHostContextDetailsDisplayMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsHostContextDetailsDisplayMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionDecisionSurface Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsDisplayMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionDecisionSurface value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsDisplayMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionDecisionSurface)); } } } -/// Platform type for responsive design. +/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsPlatform : IEquatable +public readonly struct PermissionsSetApproveAllSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsHostContextDetailsPlatform(string value) + public PermissionsSetApproveAllSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Host runs in a web browser. - public static McpAppsHostContextDetailsPlatform Web { get; } = new("web"); + /// Allow-all was enabled from a CLI command-line flag. + public static PermissionsSetApproveAllSource CliFlag { get; } = new("cli_flag"); - /// Host runs as a desktop application. - public static McpAppsHostContextDetailsPlatform Desktop { get; } = new("desktop"); + /// Allow-all was enabled by a slash command. + public static PermissionsSetApproveAllSource SlashCommand { get; } = new("slash_command"); - /// Host runs on a mobile device. - public static McpAppsHostContextDetailsPlatform Mobile { get; } = new("mobile"); + /// Allow-all was enabled by confirming autopilot behavior. + public static PermissionsSetApproveAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsHostContextDetailsPlatform left, McpAppsHostContextDetailsPlatform right) => left.Equals(right); + /// Allow-all was enabled through an RPC caller. + public static PermissionsSetApproveAllSource Rpc { get; } = new("rpc"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsHostContextDetailsPlatform left, McpAppsHostContextDetailsPlatform right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsPlatform other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsSetApproveAllSource other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsPlatform other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionsSetApproveAllSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11050,62 +21345,65 @@ public McpAppsHostContextDetailsPlatform(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsHostContextDetailsPlatform Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionsSetApproveAllSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsPlatform value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsSetApproveAllSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsPlatform)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetApproveAllSource)); } } } -/// UI theme preference per SEP-1865. +/// Current or requested allow-all mode. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct McpAppsHostContextDetailsTheme : IEquatable +public readonly struct PermissionsAllowAllMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public McpAppsHostContextDetailsTheme(string value) + public PermissionsAllowAllMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Light UI theme. - public static McpAppsHostContextDetailsTheme Light { get; } = new("light"); + /// Permission requests follow the normal approval flow. + public static PermissionsAllowAllMode Off { get; } = new("off"); - /// Dark UI theme. - public static McpAppsHostContextDetailsTheme Dark { get; } = new("dark"); + /// Tool, path, and URL permission requests are automatically approved. + public static PermissionsAllowAllMode On { get; } = new("on"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme right) => left.Equals(right); + /// Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + public static PermissionsAllowAllMode Auto { get; } = new("auto"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(McpAppsHostContextDetailsTheme left, McpAppsHostContextDetailsTheme right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionsAllowAllMode left, PermissionsAllowAllMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionsAllowAllMode left, PermissionsAllowAllMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is McpAppsHostContextDetailsTheme other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsAllowAllMode other && Equals(other); /// - public bool Equals(McpAppsHostContextDetailsTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionsAllowAllMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11113,62 +21411,68 @@ public McpAppsHostContextDetailsTheme(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override McpAppsHostContextDetailsTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionsAllowAllMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, McpAppsHostContextDetailsTheme value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsAllowAllMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpAppsHostContextDetailsTheme)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsAllowAllMode)); } } } -/// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). +/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateEnvValueMode : IEquatable +public readonly struct PermissionsSetAllowAllSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public OptionsUpdateEnvValueMode(string value) + public PermissionsSetAllowAllSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Pass MCP server environment values as literal strings. - public static OptionsUpdateEnvValueMode Direct { get; } = new("direct"); + /// Allow-all was enabled from a CLI command-line flag. + public static PermissionsSetAllowAllSource CliFlag { get; } = new("cli_flag"); - /// Resolve MCP server environment values from host-side references. - public static OptionsUpdateEnvValueMode Indirect { get; } = new("indirect"); + /// Allow-all was enabled by a slash command. + public static PermissionsSetAllowAllSource SlashCommand { get; } = new("slash_command"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode right) => left.Equals(right); + /// Allow-all was enabled by confirming autopilot behavior. + public static PermissionsSetAllowAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OptionsUpdateEnvValueMode left, OptionsUpdateEnvValueMode right) => !(left == right); + /// Allow-all was enabled through an RPC caller. + public static PermissionsSetAllowAllSource Rpc { get; } = new("rpc"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is OptionsUpdateEnvValueMode other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsSetAllowAllSource other && Equals(other); /// - public bool Equals(OptionsUpdateEnvValueMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionsSetAllowAllSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11176,62 +21480,62 @@ public OptionsUpdateEnvValueMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override OptionsUpdateEnvValueMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionsSetAllowAllSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, OptionsUpdateEnvValueMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsSetAllowAllSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateEnvValueMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetAllowAllSource)); } } } -/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. +/// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct OptionsUpdateToolFilterPrecedence : IEquatable +public readonly struct PermissionsModifyRulesScope : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public OptionsUpdateToolFilterPrecedence(string value) + public PermissionsModifyRulesScope(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// If availableTools is set, it is the only constraint that applies (excludedTools is ignored). Preserves CLI / pre-existing client behavior. Default. - public static OptionsUpdateToolFilterPrecedence Available { get; } = new("available"); + /// Apply the rule change only to this session. + public static PermissionsModifyRulesScope Session { get; } = new("session"); - /// A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND it does not match the denylist. Makes 'all except X' expressible by combining the two lists. - public static OptionsUpdateToolFilterPrecedence Excluded { get; } = new("excluded"); + /// Persist the rule change for this project location. + public static PermissionsModifyRulesScope Location { get; } = new("location"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(OptionsUpdateToolFilterPrecedence left, OptionsUpdateToolFilterPrecedence right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => !(left == right); /// - public override bool Equals(object? obj) => obj is OptionsUpdateToolFilterPrecedence other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionsModifyRulesScope other && Equals(other); /// - public bool Equals(OptionsUpdateToolFilterPrecedence other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionsModifyRulesScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11239,62 +21543,62 @@ public OptionsUpdateToolFilterPrecedence(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override OptionsUpdateToolFilterPrecedence Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionsModifyRulesScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, OptionsUpdateToolFilterPrecedence value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionsModifyRulesScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OptionsUpdateToolFilterPrecedence)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsModifyRulesScope)); } } } -/// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/). +/// Whether the location is a git repo or directory. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ExtensionSource : IEquatable +public readonly struct PermissionLocationType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ExtensionSource(string value) + public PermissionLocationType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Extension discovered from the current project's .github/extensions directory. - public static ExtensionSource Project { get; } = new("project"); + /// The permission location is persisted at the git repository root. + public static PermissionLocationType Repo { get; } = new("repo"); - /// Extension discovered from the user's ~/.copilot/extensions directory. - public static ExtensionSource User { get; } = new("user"); + /// The permission location is persisted at the working directory. + public static PermissionLocationType Dir { get; } = new("dir"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ExtensionSource left, ExtensionSource right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionLocationType left, PermissionLocationType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ExtensionSource left, ExtensionSource right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionLocationType left, PermissionLocationType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ExtensionSource other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionLocationType other && Equals(other); /// - public bool Equals(ExtensionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionLocationType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11302,68 +21606,65 @@ public ExtensionSource(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ExtensionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionLocationType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ExtensionSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionLocationType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionLocationType)); } } } -/// Current status: running, disabled, failed, or starting. +/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ExtensionStatus : IEquatable +public readonly struct MetadataSnapshotCurrentMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ExtensionStatus(string value) + public MetadataSnapshotCurrentMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The extension process is running. - public static ExtensionStatus Running { get; } = new("running"); - - /// The extension is installed but disabled. - public static ExtensionStatus Disabled { get; } = new("disabled"); + /// The agent is responding interactively to the user. + public static MetadataSnapshotCurrentMode Interactive { get; } = new("interactive"); - /// The extension failed to start or crashed. - public static ExtensionStatus Failed { get; } = new("failed"); + /// The agent is preparing a plan before making changes. + public static MetadataSnapshotCurrentMode Plan { get; } = new("plan"); - /// The extension process is starting. - public static ExtensionStatus Starting { get; } = new("starting"); + /// The agent is working autonomously toward task completion. + public static MetadataSnapshotCurrentMode Autopilot { get; } = new("autopilot"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ExtensionStatus left, ExtensionStatus right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ExtensionStatus left, ExtensionStatus right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ExtensionStatus other && Equals(other); + public override bool Equals(object? obj) => obj is MetadataSnapshotCurrentMode other && Equals(other); /// - public bool Equals(ExtensionStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(MetadataSnapshotCurrentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11371,59 +21672,62 @@ public ExtensionStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ExtensionStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override MetadataSnapshotCurrentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ExtensionStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, MetadataSnapshotCurrentMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ExtensionStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotCurrentMode)); } } } -/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion). +/// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SlashCommandInputCompletion : IEquatable +public readonly struct MetadataSnapshotRemoteMetadataTaskType : IEquatable { private readonly string? _value; - - /// Initializes a new instance of the struct. - /// The value to associate with this . + + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SlashCommandInputCompletion(string value) + public MetadataSnapshotRemoteMetadataTaskType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Input should complete filesystem directories. - public static SlashCommandInputCompletion Directory { get; } = new("directory"); + /// Remote task originated from Copilot Coding Agent. + public static MetadataSnapshotRemoteMetadataTaskType Cca { get; } = new("cca"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => left.Equals(right); + /// Remote task originated from a CLI remote-session invocation. + public static MetadataSnapshotRemoteMetadataTaskType Cli { get; } = new("cli"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SlashCommandInputCompletion left, SlashCommandInputCompletion right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SlashCommandInputCompletion other && Equals(other); + public override bool Equals(object? obj) => obj is MetadataSnapshotRemoteMetadataTaskType other && Equals(other); /// - public bool Equals(SlashCommandInputCompletion other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(MetadataSnapshotRemoteMetadataTaskType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11431,65 +21735,62 @@ public SlashCommandInputCompletion(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SlashCommandInputCompletion Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override MetadataSnapshotRemoteMetadataTaskType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SlashCommandInputCompletion value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, MetadataSnapshotRemoteMetadataTaskType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandInputCompletion)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotRemoteMetadataTaskType)); } } } -/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command. +/// Repository host type, if known. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SlashCommandKind : IEquatable +public readonly struct WorkspaceSummaryHostType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SlashCommandKind(string value) + public WorkspaceSummaryHostType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Command implemented by the runtime. - public static SlashCommandKind Builtin { get; } = new("builtin"); - - /// Command backed by a skill. - public static SlashCommandKind Skill { get; } = new("skill"); + /// Workspace summary repository is hosted on GitHub. + public static WorkspaceSummaryHostType GitHub { get; } = new("github"); - /// Command registered by an SDK client or extension. - public static SlashCommandKind Client { get; } = new("client"); + /// Workspace summary repository is hosted on Azure DevOps. + public static WorkspaceSummaryHostType Ado { get; } = new("ado"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SlashCommandKind left, SlashCommandKind right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspaceSummaryHostType left, WorkspaceSummaryHostType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SlashCommandKind left, SlashCommandKind right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspaceSummaryHostType left, WorkspaceSummaryHostType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SlashCommandKind other && Equals(other); + public override bool Equals(object? obj) => obj is WorkspaceSummaryHostType other && Equals(other); /// - public bool Equals(SlashCommandKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(WorkspaceSummaryHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11497,65 +21798,62 @@ public SlashCommandKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SlashCommandKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override WorkspaceSummaryHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SlashCommandKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, WorkspaceSummaryHostType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SlashCommandKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceSummaryHostType)); } } } -/// The user's response: accept (submitted), decline (rejected), or cancel (dismissed). +/// Hosting platform type of the repository. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UIElicitationResponseAction : IEquatable +public readonly struct SessionWorkingDirectoryContextHostType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public UIElicitationResponseAction(string value) + public SessionWorkingDirectoryContextHostType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The user submitted the requested form values. - public static UIElicitationResponseAction Accept { get; } = new("accept"); - - /// The user explicitly declined to provide the requested input. - public static UIElicitationResponseAction Decline { get; } = new("decline"); + /// The working directory repository is hosted on GitHub. + public static SessionWorkingDirectoryContextHostType GitHub { get; } = new("github"); - /// The user dismissed the elicitation request. - public static UIElicitationResponseAction Cancel { get; } = new("cancel"); + /// The working directory repository is hosted on Azure DevOps. + public static SessionWorkingDirectoryContextHostType Ado { get; } = new("ado"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(UIElicitationResponseAction left, UIElicitationResponseAction right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UIElicitationResponseAction left, UIElicitationResponseAction right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UIElicitationResponseAction other && Equals(other); + public override bool Equals(object? obj) => obj is SessionWorkingDirectoryContextHostType other && Equals(other); /// - public bool Equals(UIElicitationResponseAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionWorkingDirectoryContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11563,65 +21861,113 @@ public UIElicitationResponseAction(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override UIElicitationResponseAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionWorkingDirectoryContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, UIElicitationResponseAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionWorkingDirectoryContextHostType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIElicitationResponseAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionWorkingDirectoryContextHostType)); } } } -/// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). +/// Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UIAutoModeSwitchResponse : IEquatable +public readonly struct SessionSettingsPredicateName : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public UIAutoModeSwitchResponse(string value) + public SessionSettingsPredicateName(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Allow the automatic mode switch for this turn. - public static UIAutoModeSwitchResponse Yes { get; } = new("yes"); + /// Whether the security-tools feature flag enables security tool wiring. + public static SessionSettingsPredicateName SecurityToolsEnabled { get; } = new("securityToolsEnabled"); - /// Allow this mode switch and persist the preference. - public static UIAutoModeSwitchResponse YesAlways { get; } = new("yes_always"); + /// Whether third-party security tools should receive the security prompt. + public static SessionSettingsPredicateName ThirdPartySecurityPromptEnabled { get; } = new("thirdPartySecurityPromptEnabled"); - /// Decline the automatic mode switch. - public static UIAutoModeSwitchResponse No { get; } = new("no"); + /// Whether validation may run in parallel. + public static SessionSettingsPredicateName ParallelValidationEnabled { get; } = new("parallelValidationEnabled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(UIAutoModeSwitchResponse left, UIAutoModeSwitchResponse right) => left.Equals(right); + /// Whether runtime timing telemetry is enabled. + public static SessionSettingsPredicateName RuntimeTimingTelemetryEnabled { get; } = new("runtimeTimingTelemetryEnabled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UIAutoModeSwitchResponse left, UIAutoModeSwitchResponse right) => !(left == right); + /// Whether the co-author hook is enabled. + public static SessionSettingsPredicateName CoAuthorHookEnabled { get; } = new("coAuthorHookEnabled"); + + /// Whether Chronicle integration is enabled. + public static SessionSettingsPredicateName ChronicleEnabled { get; } = new("chronicleEnabled"); + + /// Whether content-exclusion policy may self-fetch data. + public static SessionSettingsPredicateName ContentExclusionSelfFetchEnabled { get; } = new("contentExclusionSelfFetchEnabled"); + + /// Whether Claude Opus token-limit caps should be applied. + public static SessionSettingsPredicateName CapClaudeOpusTokenLimitsEnabled { get; } = new("capClaudeOpusTokenLimitsEnabled"); + + /// Whether code-review behavior is enabled. + public static SessionSettingsPredicateName CodeReviewFeatureEnabled { get; } = new("codeReviewFeatureEnabled"); + + /// Whether CCA should use the TypeScript autofind behavior. + public static SessionSettingsPredicateName CcaUseTsAutofindEnabled { get; } = new("ccaUseTsAutofindEnabled"); + + /// Whether the dependency checker is enabled. + public static SessionSettingsPredicateName DependencyCheckerEnabled { get; } = new("dependencyCheckerEnabled"); + + /// Whether the Dependabot checker is enabled. + public static SessionSettingsPredicateName DependabotCheckerEnabled { get; } = new("dependabotCheckerEnabled"); + + /// Whether the CodeQL checker is enabled. + public static SessionSettingsPredicateName CodeqlCheckerEnabled { get; } = new("codeqlCheckerEnabled"); + + /// Whether trivial-change handling is enabled. + public static SessionSettingsPredicateName TrivialChangeEnabled { get; } = new("trivialChangeEnabled"); + + /// Whether trivial-change skip behavior is enabled. + public static SessionSettingsPredicateName TrivialChangeSkipEnabled { get; } = new("trivialChangeSkipEnabled"); + + /// Whether trivial-change handling is enabled for code review. + public static SessionSettingsPredicateName TrivialChangeEnabledForCodeReview { get; } = new("trivialChangeEnabledForCodeReview"); + + /// Whether trivial-change skip behavior is enabled for code review. + public static SessionSettingsPredicateName TrivialChangeSkipEnabledForCodeReview { get; } = new("trivialChangeSkipEnabledForCodeReview"); + + /// Whether trivial-change handling is enabled for a specific tool. + public static SessionSettingsPredicateName TrivialChangeEnabledForTool { get; } = new("trivialChangeEnabledForTool"); + + /// Whether trivial-change skip behavior is enabled for a specific tool. + public static SessionSettingsPredicateName TrivialChangeSkipEnabledForTool { get; } = new("trivialChangeSkipEnabledForTool"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionSettingsPredicateName left, SessionSettingsPredicateName right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionSettingsPredicateName left, SessionSettingsPredicateName right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UIAutoModeSwitchResponse other && Equals(other); + public override bool Equals(object? obj) => obj is SessionSettingsPredicateName other && Equals(other); /// - public bool Equals(UIAutoModeSwitchResponse other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionSettingsPredicateName other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11629,68 +21975,65 @@ public UIAutoModeSwitchResponse(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override UIAutoModeSwitchResponse Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionSettingsPredicateName Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, UIAutoModeSwitchResponse value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionSettingsPredicateName value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIAutoModeSwitchResponse)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionSettingsPredicateName)); } } } -/// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. +/// Signal to send (default: SIGTERM). [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UIExitPlanModeAction : IEquatable +public readonly struct ShellKillSignal : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public UIExitPlanModeAction(string value) + public ShellKillSignal(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Exit plan mode without starting implementation. - public static UIExitPlanModeAction ExitOnly { get; } = new("exit_only"); - - /// Exit plan mode and continue interactively. - public static UIExitPlanModeAction Interactive { get; } = new("interactive"); + /// Request graceful process termination. + public static ShellKillSignal SIGTERM { get; } = new("SIGTERM"); - /// Exit plan mode and continue in autopilot mode. - public static UIExitPlanModeAction Autopilot { get; } = new("autopilot"); + /// Forcefully terminate the process. + public static ShellKillSignal SIGKILL { get; } = new("SIGKILL"); - /// Exit plan mode and continue in autopilot mode with parallel subagent execution. - public static UIExitPlanModeAction AutopilotFleet { get; } = new("autopilot_fleet"); + /// Send an interrupt signal to the process. + public static ShellKillSignal SIGINT { get; } = new("SIGINT"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(UIExitPlanModeAction left, UIExitPlanModeAction right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ShellKillSignal left, ShellKillSignal right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UIExitPlanModeAction left, UIExitPlanModeAction right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ShellKillSignal left, ShellKillSignal right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UIExitPlanModeAction other && Equals(other); + public override bool Equals(object? obj) => obj is ShellKillSignal other && Equals(other); /// - public bool Equals(UIExitPlanModeAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ShellKillSignal other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11698,62 +22041,61 @@ public UIExitPlanModeAction(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override UIExitPlanModeAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ShellKillSignal Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, UIExitPlanModeAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ShellKillSignal value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UIExitPlanModeAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellKillSignal)); } } } -/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. -[Experimental(Diagnostics.Experimental)] +/// What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsConfigureAdditionalContentExclusionPolicyScope : IEquatable +public readonly struct SessionHistoryCompactRequestTrigger : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionsConfigureAdditionalContentExclusionPolicyScope(string value) + public SessionHistoryCompactRequestTrigger(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The content exclusion policy applies to the current repository. - public static PermissionsConfigureAdditionalContentExclusionPolicyScope Repo { get; } = new("repo"); + /// User-requested compaction, e.g. the /compact command or a direct history.compact call. + public static SessionHistoryCompactRequestTrigger Manual { get; } = new("manual"); - /// The content exclusion policy applies across all repositories. - public static PermissionsConfigureAdditionalContentExclusionPolicyScope All { get; } = new("all"); + /// Compaction requested while switching to a model with a smaller context window. + public static SessionHistoryCompactRequestTrigger ModelSwitch { get; } = new("model_switch"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionHistoryCompactRequestTrigger left, SessionHistoryCompactRequestTrigger right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsConfigureAdditionalContentExclusionPolicyScope left, PermissionsConfigureAdditionalContentExclusionPolicyScope right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionHistoryCompactRequestTrigger left, SessionHistoryCompactRequestTrigger right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionsConfigureAdditionalContentExclusionPolicyScope other && Equals(other); + public override bool Equals(object? obj) => obj is SessionHistoryCompactRequestTrigger other && Equals(other); /// - public bool Equals(PermissionsConfigureAdditionalContentExclusionPolicyScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionHistoryCompactRequestTrigger other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11761,68 +22103,65 @@ public PermissionsConfigureAdditionalContentExclusionPolicyScope(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionsConfigureAdditionalContentExclusionPolicyScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionHistoryCompactRequestTrigger Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionsConfigureAdditionalContentExclusionPolicyScope value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionHistoryCompactRequestTrigger value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsConfigureAdditionalContentExclusionPolicyScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionHistoryCompactRequestTrigger)); } } } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// Aggregate file change represented by a rewind preview. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsSetApproveAllSource : IEquatable +public readonly struct HistoryRewindChangeType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionsSetApproveAllSource(string value) + public HistoryRewindChangeType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Allow-all was enabled from a CLI command-line flag. - public static PermissionsSetApproveAllSource CliFlag { get; } = new("cli_flag"); - - /// Allow-all was enabled by a slash command. - public static PermissionsSetApproveAllSource SlashCommand { get; } = new("slash_command"); + /// The discarded turns created the file. + public static HistoryRewindChangeType Created { get; } = new("created"); - /// Allow-all was enabled by confirming autopilot behavior. - public static PermissionsSetApproveAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); + /// The discarded turns deleted the file. + public static HistoryRewindChangeType Deleted { get; } = new("deleted"); - /// Allow-all was enabled through an RPC caller. - public static PermissionsSetApproveAllSource Rpc { get; } = new("rpc"); + /// The discarded turns modified the file. + public static HistoryRewindChangeType Modified { get; } = new("modified"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryRewindChangeType left, HistoryRewindChangeType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsSetApproveAllSource left, PermissionsSetApproveAllSource right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryRewindChangeType left, HistoryRewindChangeType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionsSetApproveAllSource other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindChangeType other && Equals(other); /// - public bool Equals(PermissionsSetApproveAllSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(HistoryRewindChangeType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11830,68 +22169,83 @@ public PermissionsSetApproveAllSource(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionsSetApproveAllSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override HistoryRewindChangeType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionsSetApproveAllSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, HistoryRewindChangeType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetApproveAllSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindChangeType)); } } } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// Outcome of a rewind request. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsSetAllowAllSource : IEquatable +public readonly struct HistoryRewindOutcome : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionsSetAllowAllSource(string value) + public HistoryRewindOutcome(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Allow-all was enabled from a CLI command-line flag. - public static PermissionsSetAllowAllSource CliFlag { get; } = new("cli_flag"); + /// The requested rewind completed; reachable in either mode. + public static HistoryRewindOutcome Success { get; } = new("success"); - /// Allow-all was enabled by a slash command. - public static PermissionsSetAllowAllSource SlashCommand { get; } = new("slash_command"); + /// The session still has work that may mutate files or history; reachable in either mode. + public static HistoryRewindOutcome SessionBusy { get; } = new("session-busy"); - /// Allow-all was enabled by confirming autopilot behavior. - public static PermissionsSetAllowAllSource AutopilotConfirmation { get; } = new("autopilot_confirmation"); + /// A conversation-and-files rewind was requested for a session that did not enable capture; conversation-only rewinds never produce this. + public static HistoryRewindOutcome FileChangeTrackingDisabled { get; } = new("file-change-tracking-disabled"); - /// Allow-all was enabled through an RPC caller. - public static PermissionsSetAllowAllSource Rpc { get; } = new("rpc"); + /// Remote-backed rewind routing is not supported; reachable in either mode. + public static HistoryRewindOutcome UnsupportedRemoteSession { get; } = new("unsupported-remote-session"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource right) => left.Equals(right); + /// File restore failed and all applied file changes were rolled back; only conversation-and-files rewinds produce this. + public static HistoryRewindOutcome FilesRolledBack { get; } = new("files-rolled-back"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsSetAllowAllSource left, PermissionsSetAllowAllSource right) => !(left == right); + /// File restore failed and its rollback could not fully restore the pre-rewind state; only conversation-and-files rewinds produce this. + public static HistoryRewindOutcome RollbackIncomplete { get; } = new("rollback-incomplete"); + + /// Conversation truncation failed. In conversation-and-files mode any files that were restored are left in place because conversation history cannot be un-truncated; in conversation-only mode no files are restored. Consult restoredFiles for what, if anything, was applied. + public static HistoryRewindOutcome TruncationFailed { get; } = new("truncation-failed"); + + /// The conversation was rewound (and, in conversation-and-files mode, captured files were restored), but persisted checkpoints could not be cleaned up; reachable in either mode. + public static HistoryRewindOutcome CheckpointCleanupFailed { get; } = new("checkpoint-cleanup-failed"); + + /// Files and conversation were rewound, but obsolete file snapshots could not be removed; only conversation-and-files rewinds produce this. + public static HistoryRewindOutcome SnapshotPruneFailed { get; } = new("snapshot-prune-failed"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryRewindOutcome left, HistoryRewindOutcome right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryRewindOutcome left, HistoryRewindOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionsSetAllowAllSource other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindOutcome other && Equals(other); /// - public bool Equals(PermissionsSetAllowAllSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(HistoryRewindOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11899,62 +22253,62 @@ public PermissionsSetAllowAllSource(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionsSetAllowAllSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override HistoryRewindOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionsSetAllowAllSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, HistoryRewindOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsSetAllowAllSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindOutcome)); } } } -/// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. +/// Reason a captured file was not restored. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionsModifyRulesScope : IEquatable +public readonly struct HistoryFileRestoreSkipReason : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionsModifyRulesScope(string value) + public HistoryFileRestoreSkipReason(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Apply the rule change only to this session. - public static PermissionsModifyRulesScope Session { get; } = new("session"); + /// The file changed after Copilot's last captured write. + public static HistoryFileRestoreSkipReason UserModified { get; } = new("user-modified"); - /// Persist the rule change for this project location. - public static PermissionsModifyRulesScope Location { get; } = new("location"); + /// A faithful preimage was not captured. + public static HistoryFileRestoreSkipReason SkippedCapture { get; } = new("skipped-capture"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryFileRestoreSkipReason left, HistoryFileRestoreSkipReason right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionsModifyRulesScope left, PermissionsModifyRulesScope right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryFileRestoreSkipReason left, HistoryFileRestoreSkipReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionsModifyRulesScope other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryFileRestoreSkipReason other && Equals(other); /// - public bool Equals(PermissionsModifyRulesScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(HistoryFileRestoreSkipReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -11962,62 +22316,62 @@ public PermissionsModifyRulesScope(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionsModifyRulesScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override HistoryFileRestoreSkipReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionsModifyRulesScope value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, HistoryFileRestoreSkipReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionsModifyRulesScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryFileRestoreSkipReason)); } } } -/// Whether the location is a git repo or directory. +/// Scope of a rewind operation. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionLocationType : IEquatable +public readonly struct HistoryRewindMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionLocationType(string value) + public HistoryRewindMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The permission location is persisted at the git repository root. - public static PermissionLocationType Repo { get; } = new("repo"); + /// Discard conversation events while leaving files unchanged. + public static HistoryRewindMode Conversation { get; } = new("conversation"); - /// The permission location is persisted at the working directory. - public static PermissionLocationType Dir { get; } = new("dir"); + /// Discard conversation events and restore captured files changed by those turns. + public static HistoryRewindMode ConversationAndFiles { get; } = new("conversation-and-files"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionLocationType left, PermissionLocationType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HistoryRewindMode left, HistoryRewindMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionLocationType left, PermissionLocationType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HistoryRewindMode left, HistoryRewindMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionLocationType other && Equals(other); + public override bool Equals(object? obj) => obj is HistoryRewindMode other && Equals(other); /// - public bool Equals(PermissionLocationType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(HistoryRewindMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12025,65 +22379,62 @@ public PermissionLocationType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionLocationType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override HistoryRewindMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionLocationType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, HistoryRewindMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionLocationType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HistoryRewindMode)); } } } -/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot'). +/// Whether this item is a queued user message or a queued slash command / model change. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct MetadataSnapshotCurrentMode : IEquatable +public readonly struct QueuePendingItemsKind : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public MetadataSnapshotCurrentMode(string value) + public QueuePendingItemsKind(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The agent is responding interactively to the user. - public static MetadataSnapshotCurrentMode Interactive { get; } = new("interactive"); - - /// The agent is preparing a plan before making changes. - public static MetadataSnapshotCurrentMode Plan { get; } = new("plan"); + /// A queued user message. + public static QueuePendingItemsKind Message { get; } = new("message"); - /// The agent is working autonomously toward task completion. - public static MetadataSnapshotCurrentMode Autopilot { get; } = new("autopilot"); + /// A queued slash command or model-change command. + public static QueuePendingItemsKind Command { get; } = new("command"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(QueuePendingItemsKind left, QueuePendingItemsKind right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(MetadataSnapshotCurrentMode left, MetadataSnapshotCurrentMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(QueuePendingItemsKind left, QueuePendingItemsKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is MetadataSnapshotCurrentMode other && Equals(other); + public override bool Equals(object? obj) => obj is QueuePendingItemsKind other && Equals(other); /// - public bool Equals(MetadataSnapshotCurrentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(QueuePendingItemsKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12091,62 +22442,62 @@ public MetadataSnapshotCurrentMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override MetadataSnapshotCurrentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override QueuePendingItemsKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, MetadataSnapshotCurrentMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, QueuePendingItemsKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotCurrentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(QueuePendingItemsKind)); } } } -/// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. +/// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history (the beginning for a forward read, the tail for a backward read). The fallback page is a fresh boundary snapshot, not a continuation of the requested cursor, so it may overlap already-rendered events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate by event id) before continuing from the returned cursor. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct MetadataSnapshotRemoteMetadataTaskType : IEquatable +public readonly struct EventsCursorStatus : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public MetadataSnapshotRemoteMetadataTaskType(string value) + public EventsCursorStatus(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Remote task originated from Copilot Coding Agent. - public static MetadataSnapshotRemoteMetadataTaskType Cca { get; } = new("cca"); + /// The cursor was applied successfully. + public static EventsCursorStatus Ok { get; } = new("ok"); - /// Remote task originated from a CLI remote-session invocation. - public static MetadataSnapshotRemoteMetadataTaskType Cli { get; } = new("cli"); + /// The cursor referred to history that is no longer available. + public static EventsCursorStatus Expired { get; } = new("expired"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(EventsCursorStatus left, EventsCursorStatus right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(MetadataSnapshotRemoteMetadataTaskType left, MetadataSnapshotRemoteMetadataTaskType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(EventsCursorStatus left, EventsCursorStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is MetadataSnapshotRemoteMetadataTaskType other && Equals(other); + public override bool Equals(object? obj) => obj is EventsCursorStatus other && Equals(other); /// - public bool Equals(MetadataSnapshotRemoteMetadataTaskType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(EventsCursorStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12154,62 +22505,62 @@ public MetadataSnapshotRemoteMetadataTaskType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override MetadataSnapshotRemoteMetadataTaskType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override EventsCursorStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, MetadataSnapshotRemoteMetadataTaskType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, EventsCursorStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(MetadataSnapshotRemoteMetadataTaskType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsCursorStatus)); } } } -/// Repository host type, if known. +/// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceSummaryHostType : IEquatable +public readonly struct EventsAgentScope : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkspaceSummaryHostType(string value) + public EventsAgentScope(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Workspace summary repository is hosted on GitHub. - public static WorkspaceSummaryHostType Github { get; } = new("github"); + /// Return main-agent events and typed subagent lifecycle events. + public static EventsAgentScope Primary { get; } = new("primary"); - /// Workspace summary repository is hosted on Azure DevOps. - public static WorkspaceSummaryHostType Ado { get; } = new("ado"); + /// Return events from all agents. + public static EventsAgentScope All { get; } = new("all"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspaceSummaryHostType left, WorkspaceSummaryHostType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(EventsAgentScope left, EventsAgentScope right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspaceSummaryHostType left, WorkspaceSummaryHostType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(EventsAgentScope left, EventsAgentScope right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceSummaryHostType other && Equals(other); + public override bool Equals(object? obj) => obj is EventsAgentScope other && Equals(other); /// - public bool Equals(WorkspaceSummaryHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(EventsAgentScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12217,62 +22568,62 @@ public WorkspaceSummaryHostType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkspaceSummaryHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override EventsAgentScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkspaceSummaryHostType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, EventsAgentScope value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceSummaryHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsAgentScope)); } } } -/// Hosting platform type of the repository. +/// Direction to page through the session's persisted event history. 'forward' pages from the cursor toward newer events; 'backward' returns the newest window first (tail-first) and pages toward older events. Events within a returned batch are always chronological (oldest-to-newest), even for a backward read. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionWorkingDirectoryContextHostType : IEquatable +public readonly struct EventsReadDirection : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionWorkingDirectoryContextHostType(string value) + public EventsReadDirection(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The working directory repository is hosted on GitHub. - public static SessionWorkingDirectoryContextHostType Github { get; } = new("github"); + /// Page from the cursor toward newer events (default). + public static EventsReadDirection Forward { get; } = new("forward"); - /// The working directory repository is hosted on Azure DevOps. - public static SessionWorkingDirectoryContextHostType Ado { get; } = new("ado"); + /// Tail-first: return the newest events and page toward older events. + public static EventsReadDirection Backward { get; } = new("backward"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(EventsReadDirection left, EventsReadDirection right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionWorkingDirectoryContextHostType left, SessionWorkingDirectoryContextHostType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(EventsReadDirection left, EventsReadDirection right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionWorkingDirectoryContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is EventsReadDirection other && Equals(other); /// - public bool Equals(SessionWorkingDirectoryContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(EventsReadDirection other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12280,65 +22631,62 @@ public SessionWorkingDirectoryContextHostType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionWorkingDirectoryContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override EventsReadDirection Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionWorkingDirectoryContextHostType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, EventsReadDirection value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionWorkingDirectoryContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsReadDirection)); } } } -/// Signal to send (default: SIGTERM). +/// Client population used for the prediction baseline. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ShellKillSignal : IEquatable +public readonly struct SessionLimitPredictionClientType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ShellKillSignal(string value) + public SessionLimitPredictionClientType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Request graceful process termination. - public static ShellKillSignal SIGTERM { get; } = new("SIGTERM"); - - /// Forcefully terminate the process. - public static ShellKillSignal SIGKILL { get; } = new("SIGKILL"); + /// Interactive CLI sessions where a user can accept, edit, or top up the limit. + public static SessionLimitPredictionClientType CliInteractive { get; } = new("cli-interactive"); - /// Send an interrupt signal to the process. - public static ShellKillSignal SIGINT { get; } = new("SIGINT"); + /// Prompt/non-interactive CLI sessions where the initial limit must cover more of the run. + public static SessionLimitPredictionClientType CliPrompt { get; } = new("cli-prompt"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ShellKillSignal left, ShellKillSignal right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLimitPredictionClientType left, SessionLimitPredictionClientType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ShellKillSignal left, ShellKillSignal right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLimitPredictionClientType left, SessionLimitPredictionClientType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ShellKillSignal other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLimitPredictionClientType other && Equals(other); /// - public bool Equals(ShellKillSignal other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLimitPredictionClientType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12346,62 +22694,68 @@ public ShellKillSignal(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ShellKillSignal Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionLimitPredictionClientType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ShellKillSignal value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionLimitPredictionClientType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShellKillSignal)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLimitPredictionClientType)); } } } -/// Whether this item is a queued user message or a queued slash command / model change. +/// Semantic usage tier used for a recommended cap or additional headroom. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct QueuePendingItemsKind : IEquatable +public readonly struct SessionLimitPredictionTier : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public QueuePendingItemsKind(string value) + public SessionLimitPredictionTier(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// A queued user message. - public static QueuePendingItemsKind Message { get; } = new("message"); + /// Recommended starting tier. + public static SessionLimitPredictionTier Recommended { get; } = new("recommended"); + + /// Additional headroom for longer-running sessions. + public static SessionLimitPredictionTier AdditionalHeadroom { get; } = new("additional_headroom"); - /// A queued slash command or model-change command. - public static QueuePendingItemsKind Command { get; } = new("command"); + /// Generous headroom for unusually high usage. + public static SessionLimitPredictionTier GenerousHeadroom { get; } = new("generous_headroom"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(QueuePendingItemsKind left, QueuePendingItemsKind right) => left.Equals(right); + /// Maximum available headroom tier. + public static SessionLimitPredictionTier MaximumHeadroom { get; } = new("maximum_headroom"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(QueuePendingItemsKind left, QueuePendingItemsKind right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLimitPredictionTier left, SessionLimitPredictionTier right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLimitPredictionTier left, SessionLimitPredictionTier right) => !(left == right); /// - public override bool Equals(object? obj) => obj is QueuePendingItemsKind other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLimitPredictionTier other && Equals(other); /// - public bool Equals(QueuePendingItemsKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLimitPredictionTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12409,62 +22763,65 @@ public QueuePendingItemsKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override QueuePendingItemsKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionLimitPredictionTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, QueuePendingItemsKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionLimitPredictionTier value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(QueuePendingItemsKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLimitPredictionTier)); } } } -/// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. +/// Baseline fallback level used to create the prediction. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct EventsCursorStatus : IEquatable +public readonly struct SessionLimitPredictionSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public EventsCursorStatus(string value) + public SessionLimitPredictionSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The cursor was applied successfully. - public static EventsCursorStatus Ok { get; } = new("ok"); + /// The prediction used the exact resolved model's baseline cell. + public static SessionLimitPredictionSource Model { get; } = new("model"); - /// The cursor referred to history that is no longer available. - public static EventsCursorStatus Expired { get; } = new("expired"); + /// The exact model was unavailable, so the prediction used the model family's baseline cell. + public static SessionLimitPredictionSource Family { get; } = new("family"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(EventsCursorStatus left, EventsCursorStatus right) => left.Equals(right); + /// No model or family cell was available, so the prediction used the global client-type baseline cell. + public static SessionLimitPredictionSource Global { get; } = new("global"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(EventsCursorStatus left, EventsCursorStatus right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLimitPredictionSource left, SessionLimitPredictionSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLimitPredictionSource left, SessionLimitPredictionSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is EventsCursorStatus other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLimitPredictionSource other && Equals(other); /// - public bool Equals(EventsCursorStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLimitPredictionSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12472,62 +22829,62 @@ public EventsCursorStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override EventsCursorStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionLimitPredictionSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, EventsCursorStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionLimitPredictionSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsCursorStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLimitPredictionSource)); } } } -/// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. +/// Reason a prediction could not be computed. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct EventsAgentScope : IEquatable +public readonly struct SessionLimitPredictionUnavailableReason : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public EventsAgentScope(string value) + public SessionLimitPredictionUnavailableReason(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Return main-agent events and typed subagent lifecycle events. - public static EventsAgentScope Primary { get; } = new("primary"); + /// The current model is auto and has not resolved to a concrete model yet. + public static SessionLimitPredictionUnavailableReason AutoUnresolved { get; } = new("auto_unresolved"); - /// Return events from all agents. - public static EventsAgentScope All { get; } = new("all"); + /// No model was provided and the session does not currently have a selected model. + public static SessionLimitPredictionUnavailableReason NoModel { get; } = new("no_model"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(EventsAgentScope left, EventsAgentScope right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLimitPredictionUnavailableReason left, SessionLimitPredictionUnavailableReason right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(EventsAgentScope left, EventsAgentScope right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLimitPredictionUnavailableReason left, SessionLimitPredictionUnavailableReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is EventsAgentScope other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLimitPredictionUnavailableReason other && Equals(other); /// - public bool Equals(EventsAgentScope other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLimitPredictionUnavailableReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -12535,20 +22892,20 @@ public EventsAgentScope(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override EventsAgentScope Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionLimitPredictionUnavailableReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, EventsAgentScope value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionLimitPredictionUnavailableReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(EventsAgentScope)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLimitPredictionUnavailableReason)); } } } @@ -12620,6 +22977,69 @@ public override void Write(Utf8JsonWriter writer, RemoteSessionMode value, JsonS } +/// Sharing status for a synced session. "repo" makes the session visible to anyone with read access to the repository; "unshared" restricts it to the creator and collaborators. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionVisibilityStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionVisibilityStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The session is visible to repository readers. + public static SessionVisibilityStatus Repo { get; } = new("repo"); + + /// The session is restricted to its creator and collaborators. + public static SessionVisibilityStatus Unshared { get; } = new("unshared"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionVisibilityStatus left, SessionVisibilityStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionVisibilityStatus left, SessionVisibilityStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionVisibilityStatus other && Equals(other); + + /// + public bool Equals(SessionVisibilityStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionVisibilityStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionVisibilityStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionVisibilityStatus)); + } + } +} + + /// Error classification. [Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] @@ -12812,6 +23232,135 @@ public override void Write(Utf8JsonWriter writer, SessionFsSqliteQueryType value } +/// SQLite transaction failure classification. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionFsSqliteTransactionErrorClass : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionFsSqliteTransactionErrorClass(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// SQLite reported BUSY or LOCKED before commit; the transaction was rolled back and may be retried. + public static SessionFsSqliteTransactionErrorClass BusyOrLocked { get; } = new("busyOrLocked"); + + /// The statement, database, or provider failed definitively and must not be retried automatically. + public static SessionFsSqliteTransactionErrorClass Fatal { get; } = new("fatal"); + + /// The transport failed after the provider may have committed; retrying could duplicate effects. + public static SessionFsSqliteTransactionErrorClass PostCommitAmbiguous { get; } = new("postCommitAmbiguous"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionFsSqliteTransactionErrorClass left, SessionFsSqliteTransactionErrorClass right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionFsSqliteTransactionErrorClass left, SessionFsSqliteTransactionErrorClass right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionFsSqliteTransactionErrorClass other && Equals(other); + + /// + public bool Equals(SessionFsSqliteTransactionErrorClass other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionFsSqliteTransactionErrorClass Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionFsSqliteTransactionErrorClass value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionFsSqliteTransactionErrorClass)); + } + } +} + + +/// Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct LlmInferenceHttpRequestStartTransport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public LlmInferenceHttpRequestStartTransport(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Plain HTTP or SSE response. Each body chunk is an opaque byte range; the response is a status line, headers, and a (possibly streamed) body. + public static LlmInferenceHttpRequestStartTransport Http { get; } = new("http"); + + /// Full-duplex WebSocket channel. Each body chunk maps to exactly one WebSocket message and the `binary` flag distinguishes text from binary frames; request and response chunks flow concurrently. + public static LlmInferenceHttpRequestStartTransport Websocket { get; } = new("websocket"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(LlmInferenceHttpRequestStartTransport left, LlmInferenceHttpRequestStartTransport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(LlmInferenceHttpRequestStartTransport left, LlmInferenceHttpRequestStartTransport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is LlmInferenceHttpRequestStartTransport other && Equals(other); + + /// + public bool Equals(LlmInferenceHttpRequestStartTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override LlmInferenceHttpRequestStartTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, LlmInferenceHttpRequestStartTransport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(LlmInferenceHttpRequestStartTransport)); + } + } +} + + /// Provides server-scoped RPC methods (no session required). public sealed class ServerRpc { @@ -12826,22 +23375,33 @@ internal ServerRpc(JsonRpc rpc) /// Optional message to echo back. /// The to monitor for cancellation requests. The default is . /// Server liveness response, including the echoed message, current server timestamp, and protocol version. + [Experimental(Diagnostics.Experimental)] public async Task PingAsync(string? message = null, CancellationToken cancellationToken = default) { var request = new PingRequest { Message = message }; return await CopilotClient.InvokeRpcAsync(_rpc, "ping", [request], cancellationToken); } - /// Performs the SDK server connection handshake and validates the optional connection token. + /// Performs the SDK server connection handshake and validates the optional connection token. Marked internal because this is JSON-RPC transport plumbing invoked automatically by an SDK client's own `connect()` wrapper, not a user-facing method. Stays internal as long as the SDK client owns the handshake; would only become public if the SDK ever exposed the raw schema surface to consumers without a connection wrapper. /// Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN. + /// Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the runtime forwards every internal telemetry event it emits — across all sessions, plus sessionless events — to this connection over the `gitHubTelemetry.event` notification. Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); host-only compatibility events are forward-only and intentionally skip that path. Intended for first-party hosts that re-emit the events into their own telemetry stores. Both unrestricted and restricted events are forwarded, each tagged with a `restricted` discriminator; a backstop drops restricted events when restricted telemetry is disabled — using the process-global gate for ordinary events and an explicit session-scoped decision for host-only events. /// The to monitor for cancellation requests. The default is . /// Handshake result reporting the server's protocol version and package version on success. - internal async Task ConnectAsync(string? token = null, CancellationToken cancellationToken = default) + [Experimental(Diagnostics.Experimental)] + internal async Task ConnectAsync(string? token = null, bool? enableGitHubTelemetryForwarding = null, CancellationToken cancellationToken = default) { - var request = new ConnectRequest { Token = token }; + var request = new ConnectRequest { Token = token, EnableGitHubTelemetryForwarding = enableGitHubTelemetryForwarding }; return await CopilotClient.InvokeRpcAsync(_rpc, "connect", [request], cancellationToken); } + /// Registers the calling SDK client as the per-entrypoint extension launch provider. Call before creating any sessions. When omitted, the runtime temporarily falls back to its built-in Node launcher for backward compatibility. + /// The to monitor for cancellation requests. The default is . + [Experimental(Diagnostics.Experimental)] + public async Task RegisterExtensionLaunchProviderAsync(CancellationToken cancellationToken = default) + { + await CopilotClient.InvokeRpcAsync(_rpc, "registerExtensionLaunchProvider", [], cancellationToken); + } + /// Models APIs. public ServerModelsApi Models => field ?? @@ -12872,24 +23432,72 @@ internal async Task ConnectAsync(string? token = null, Cancellati Interlocked.CompareExchange(ref field, new(_rpc), null) ?? field; + /// Extensions APIs. + public ServerExtensionsApi Extensions => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + + /// Plugins APIs. + public ServerPluginsApi Plugins => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// Skills APIs. public ServerSkillsApi Skills => field ?? Interlocked.CompareExchange(ref field, new(_rpc), null) ?? field; + /// Agents APIs. + public ServerAgentsApi Agents => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + + /// Instructions APIs. + public ServerInstructionsApi Instructions => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + + /// Commands APIs. + public ServerCommandsApi Commands => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// User APIs. public ServerUserApi User => field ?? Interlocked.CompareExchange(ref field, new(_rpc), null) ?? field; + /// ManagedSettings APIs. + public ServerManagedSettingsApi ManagedSettings => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + + /// Runtime APIs. + public ServerRuntimeApi Runtime => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// SessionFs APIs. public ServerSessionFsApi SessionFs => field ?? Interlocked.CompareExchange(ref field, new(_rpc), null) ?? field; + /// LlmInference APIs. + public ServerLlmInferenceApi LlmInference => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; + /// Sessions APIs. public ServerSessionsApi Sessions => field ?? @@ -12904,6 +23512,7 @@ internal async Task ConnectAsync(string? token = null, Cancellati } /// Provides server-scoped Models APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerModelsApi { private readonly JsonRpc _rpc; @@ -12922,9 +23531,18 @@ public async Task ListAsync(string? gitHubToken = null, CancellationT var request = new ModelsListRequest { GitHubToken = gitHubToken }; return await CopilotClient.InvokeRpcAsync(_rpc, "models.list", [request], cancellationToken); } + + /// Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access. + /// The to monitor for cancellation requests. The default is . + /// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. + public async Task GetBuiltInCatalogAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "models.getBuiltInCatalog", [], cancellationToken); + } } /// Provides server-scoped Tools APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerToolsApi { private readonly JsonRpc _rpc; @@ -12946,27 +23564,73 @@ public async Task ListAsync(string? model = null, CancellationToken ca } /// Provides server-scoped Account APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerAccountApi { private readonly JsonRpc _rpc; internal ServerAccountApi(JsonRpc rpc) { - _rpc = rpc; + _rpc = rpc; + } + + /// Gets Copilot quota usage for the authenticated user or supplied GitHub token. + /// GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. + /// The to monitor for cancellation requests. The default is . + /// Quota usage snapshots for the resolved user, keyed by quota type. + public async Task GetQuotaAsync(string? gitHubToken = null, CancellationToken cancellationToken = default) + { + var request = new AccountGetQuotaRequest { GitHubToken = gitHubToken }; + return await CopilotClient.InvokeRpcAsync(_rpc, "account.getQuota", [request], cancellationToken); + } + + /// Gets the currently active authentication credentials from the global auth manager. + /// The to monitor for cancellation requests. The default is . + /// Current authentication state. + public async Task GetCurrentAuthAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "account.getCurrentAuth", [], cancellationToken); + } + + /// Gets all authenticated users available for account switching. + /// The to monitor for cancellation requests. The default is . + /// List of all authenticated users. + public async Task> GetAllUsersAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync>(_rpc, "account.getAllUsers", [], cancellationToken); + } + + /// Stores authentication credentials after successful login (e.g., device code flow). + /// GitHub host URL. + /// User login/username. + /// GitHub authentication token. + /// The to monitor for cancellation requests. The default is . + /// Result of a successful login; throws on failure. + public async Task LoginAsync(string host, string login, string token, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(host); + ArgumentNullException.ThrowIfNull(login); + ArgumentNullException.ThrowIfNull(token); + + var request = new AccountLoginRequest { Host = host, Login = login, Token = token }; + return await CopilotClient.InvokeRpcAsync(_rpc, "account.login", [request], cancellationToken); } - /// Gets Copilot quota usage for the authenticated user or supplied GitHub token. - /// GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. + /// Removes user authentication from keychain and persisted state. + /// Authentication information for the user to log out. /// The to monitor for cancellation requests. The default is . - /// Quota usage snapshots for the resolved user, keyed by quota type. - public async Task GetQuotaAsync(string? gitHubToken = null, CancellationToken cancellationToken = default) + /// Logout result indicating if more users remain. + public async Task LogoutAsync(AuthInfo authInfo, CancellationToken cancellationToken = default) { - var request = new AccountGetQuotaRequest { GitHubToken = gitHubToken }; - return await CopilotClient.InvokeRpcAsync(_rpc, "account.getQuota", [request], cancellationToken); + ArgumentNullException.ThrowIfNull(authInfo); + + var request = new AccountLogoutRequest { AuthInfo = authInfo }; + return await CopilotClient.InvokeRpcAsync(_rpc, "account.logout", [request], cancellationToken); } } /// Provides server-scoped Secrets APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerSecretsApi { private readonly JsonRpc _rpc; @@ -12990,6 +23654,7 @@ public async Task AddFilterValuesAsync(IListProvides server-scoped Mcp APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerMcpApi { private readonly JsonRpc _rpc; @@ -13017,6 +23682,7 @@ public async Task DiscoverAsync(string? workingDirectory = nu } /// Provides server-scoped McpConfig APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerMcpConfigApi { private readonly JsonRpc _rpc; @@ -13101,7 +23767,211 @@ public async Task ReloadAsync(CancellationToken cancellationToken = default) } } +/// Provides server-scoped Extensions APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerExtensionsApi +{ + private readonly JsonRpc _rpc; + + internal ServerExtensionsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Discovers user and enabled installed-plugin extensions from persisted Copilot home state, including enablement preferences. Launch-scoped additional plugins are not included. + /// The to monitor for cancellation requests. The default is . + /// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + public async Task DiscoverAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "extensions.discover", [], cancellationToken); + } + + /// Persistently enables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.enable to update them. + /// Source-qualified user or plugin extension IDs to enable. + /// The to monitor for cancellation requests. The default is . + public async Task EnableAsync(IList ids, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ids); + + var request = new DiscoveredExtensionsEnableRequest { Ids = ids }; + await CopilotClient.InvokeRpcAsync(_rpc, "extensions.enable", [request], cancellationToken); + } + + /// Persistently disables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.disable to update them. + /// Source-qualified user or plugin extension IDs to disable. + /// The to monitor for cancellation requests. The default is . + public async Task DisableAsync(IList ids, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ids); + + var request = new DiscoveredExtensionsDisableRequest { Ids = ids }; + await CopilotClient.InvokeRpcAsync(_rpc, "extensions.disable", [request], cancellationToken); + } +} + +/// Provides server-scoped Plugins APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerPluginsApi +{ + private readonly JsonRpc _rpc; + + internal ServerPluginsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Lists plugins installed in user/global state. + /// The to monitor for cancellation requests. The default is . + /// Plugins installed in user/global state. + public async Task ListAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.list", [], cancellationToken); + } + + /// Installs a plugin from a marketplace, GitHub repo, URL, or local path. + /// Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result. + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + /// The to monitor for cancellation requests. The default is . + /// Result of installing a plugin. + public async Task InstallAsync(string source, string? workingDirectory = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(source); + + var request = new PluginsInstallRequest { Source = source, WorkingDirectory = workingDirectory }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.install", [request], cancellationToken); + } + + /// Uninstalls an installed plugin. + /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + /// Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. + /// The to monitor for cancellation requests. The default is . + public async Task UninstallAsync(string name, string? directSourceId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + + var request = new PluginsUninstallRequest { Name = name, DirectSourceId = directSourceId }; + await CopilotClient.InvokeRpcAsync(_rpc, "plugins.uninstall", [request], cancellationToken); + } + + /// Updates an installed plugin to its latest published version. + /// Plugin name or "plugin@marketplace" spec to update. + /// The to monitor for cancellation requests. The default is . + /// Result of updating a single plugin. + public async Task UpdateAsync(string name, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + + var request = new PluginsUpdateRequest { Name = name }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.update", [request], cancellationToken); + } + + /// Updates every installed plugin to its latest published version. + /// The to monitor for cancellation requests. The default is . + /// Result of updating all installed plugins. + public async Task UpdateAllAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.updateAll", [], cancellationToken); + } + + /// Enables installed plugins for new sessions. + /// Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API. + /// The to monitor for cancellation requests. The default is . + public async Task EnableAsync(IList names, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(names); + + var request = new PluginsEnableRequest { Names = names }; + await CopilotClient.InvokeRpcAsync(_rpc, "plugins.enable", [request], cancellationToken); + } + + /// Disables installed plugins for new sessions. + /// Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins. + /// The to monitor for cancellation requests. The default is . + public async Task DisableAsync(IList names, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(names); + + var request = new PluginsDisableRequest { Names = names }; + await CopilotClient.InvokeRpcAsync(_rpc, "plugins.disable", [request], cancellationToken); + } + + /// Marketplaces APIs. + public ServerPluginsMarketplacesApi Marketplaces => + field ?? + Interlocked.CompareExchange(ref field, new(_rpc), null) ?? + field; +} + +/// Provides server-scoped PluginsMarketplaces APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerPluginsMarketplacesApi +{ + private readonly JsonRpc _rpc; + + internal ServerPluginsMarketplacesApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Lists all registered marketplaces (defaults + user-added). + /// The to monitor for cancellation requests. The default is . + /// All registered marketplaces, including built-in defaults. + public async Task ListAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.marketplaces.list", [], cancellationToken); + } + + /// Registers a new marketplace from a source (owner/repo, URL, or local path). + /// Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL (user@host:path), or a local path. The marketplace's own name (from its manifest) is used as the registration key. + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + /// The to monitor for cancellation requests. The default is . + /// Result of registering a new marketplace. + public async Task AddAsync(string source, string? workingDirectory = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(source); + + var request = new PluginsMarketplacesAddRequest { Source = source, WorkingDirectory = workingDirectory }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.marketplaces.add", [request], cancellationToken); + } + + /// Removes a previously-registered marketplace. When the marketplace has dependent plugins and `force` is not set, the marketplace is left intact and the result lists the dependents so the caller can decide whether to retry with `force=true`. + /// Marketplace name to remove. + /// When true, also uninstall every plugin sourced from this marketplace. When false (default), removal is a no-op if any plugin from this marketplace is installed and the dependent plugin names are returned in the result. + /// The to monitor for cancellation requests. The default is . + /// Outcome of the remove attempt, including dependent-plugin info when applicable. + public async Task RemoveAsync(string name, bool? force = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + + var request = new PluginsMarketplacesRemoveRequest { Name = name, Force = force }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.marketplaces.remove", [request], cancellationToken); + } + + /// Lists plugins advertised by a registered marketplace. + /// Marketplace name to browse. + /// The to monitor for cancellation requests. The default is . + /// Plugins advertised by the marketplace. + public async Task BrowseAsync(string name, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(name); + + var request = new PluginsMarketplacesBrowseRequest { Name = name }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.marketplaces.browse", [request], cancellationToken); + } + + /// Re-fetches one or all registered marketplace catalogs. + /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + /// The to monitor for cancellation requests. The default is . + /// Result of refreshing one or more marketplace catalogs. + public async Task RefreshAsync(string? name = null, CancellationToken cancellationToken = default) + { + var request = new PluginsMarketplacesRefreshRequest { Name = name }; + return await CopilotClient.InvokeRpcAsync(_rpc, "plugins.marketplaces.refresh", [request], cancellationToken); + } +} + /// Provides server-scoped Skills APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerSkillsApi { private readonly JsonRpc _rpc; @@ -13114,14 +23984,26 @@ internal ServerSkillsApi(JsonRpc rpc) /// Discovers skills across global and project sources. /// Optional list of project directory paths to scan for project-scoped skills. /// Optional list of additional skill directory paths to include. + /// When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments. /// The to monitor for cancellation requests. The default is . /// Skills discovered across global and project sources. - public async Task DiscoverAsync(IList? projectPaths = null, IList? skillDirectories = null, CancellationToken cancellationToken = default) + public async Task DiscoverAsync(IList? projectPaths = null, IList? skillDirectories = null, bool? excludeHostSkills = null, CancellationToken cancellationToken = default) { - var request = new SkillsDiscoverRequest { ProjectPaths = projectPaths, SkillDirectories = skillDirectories }; + var request = new SkillsDiscoverRequest { ProjectPaths = projectPaths, SkillDirectories = skillDirectories, ExcludeHostSkills = excludeHostSkills }; return await CopilotClient.InvokeRpcAsync(_rpc, "skills.discover", [request], cancellationToken); } + /// Returns the canonical directories where a client may create skills that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. + /// Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. + /// When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments. + /// The to monitor for cancellation requests. The default is . + /// Canonical locations where skills can be created so the runtime will recognize them. + public async Task GetDiscoveryPathsAsync(IList? projectPaths = null, bool? excludeHostSkills = null, CancellationToken cancellationToken = default) + { + var request = new SkillsGetDiscoveryPathsRequest { ProjectPaths = projectPaths, ExcludeHostSkills = excludeHostSkills }; + return await CopilotClient.InvokeRpcAsync(_rpc, "skills.getDiscoveryPaths", [request], cancellationToken); + } + /// Config APIs. public ServerSkillsConfigApi Config => field ?? @@ -13130,6 +24012,7 @@ public async Task DiscoverAsync(IList? projectPaths = n } /// Provides server-scoped SkillsConfig APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerSkillsConfigApi { private readonly JsonRpc _rpc; @@ -13151,7 +24034,96 @@ public async Task SetDisabledSkillsAsync(IList disabledSkills, Cancellat } } +/// Provides server-scoped Agents APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerAgentsApi +{ + private readonly JsonRpc _rpc; + + internal ServerAgentsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Discovers custom agents across user, project, plugin, and remote sources. + /// Optional list of project directory paths to scan for project-scoped agents. When omitted or empty, only user/plugin/remote-independent agents are returned (no project scan). + /// When true, omit the host's agents (the user-level agent directory and all plugin agents), leaving only project and remote agents. For multitenant deployments. + /// The to monitor for cancellation requests. The default is . + /// Agents discovered across user, project, plugin, and remote sources. + public async Task DiscoverAsync(IList? projectPaths = null, bool? excludeHostAgents = null, CancellationToken cancellationToken = default) + { + var request = new AgentsDiscoverRequest { ProjectPaths = projectPaths, ExcludeHostAgents = excludeHostAgents }; + return await CopilotClient.InvokeRpcAsync(_rpc, "agents.discover", [request], cancellationToken); + } + + /// Returns the canonical directories where a client may create custom agents that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. + /// Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. + /// When true, omit the host's user-level agent directory, leaving only project directories. For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + /// The to monitor for cancellation requests. The default is . + /// Canonical locations where custom agents can be created so the runtime will recognize them. + public async Task GetDiscoveryPathsAsync(IList? projectPaths = null, bool? excludeHostAgents = null, CancellationToken cancellationToken = default) + { + var request = new AgentsGetDiscoveryPathsRequest { ProjectPaths = projectPaths, ExcludeHostAgents = excludeHostAgents }; + return await CopilotClient.InvokeRpcAsync(_rpc, "agents.getDiscoveryPaths", [request], cancellationToken); + } +} + +/// Provides server-scoped Instructions APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerInstructionsApi +{ + private readonly JsonRpc _rpc; + + internal ServerInstructionsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Discovers instruction sources across user, repository, and plugin sources. + /// Optional list of project directory paths to scan for repository/working-directory instruction sources. When omitted or empty, only user-level and plugin instruction sources are returned (no project scan). + /// When true, omit the host's instruction sources (user/home-level files and plugin rules), leaving only repository and working-directory sources. For multitenant deployments. + /// The to monitor for cancellation requests. The default is . + /// Instruction sources discovered across user, repository, and plugin sources. + public async Task DiscoverAsync(IList? projectPaths = null, bool? excludeHostInstructions = null, CancellationToken cancellationToken = default) + { + var request = new InstructionsDiscoverRequest { ProjectPaths = projectPaths, ExcludeHostInstructions = excludeHostInstructions }; + return await CopilotClient.InvokeRpcAsync(_rpc, "instructions.discover", [request], cancellationToken); + } + + /// Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created. + /// Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. + /// When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + /// The to monitor for cancellation requests. The default is . + /// Canonical files and directories where custom instructions can be created so the runtime will recognize them. + public async Task GetDiscoveryPathsAsync(IList? projectPaths = null, bool? excludeHostInstructions = null, CancellationToken cancellationToken = default) + { + var request = new InstructionsGetDiscoveryPathsRequest { ProjectPaths = projectPaths, ExcludeHostInstructions = excludeHostInstructions }; + return await CopilotClient.InvokeRpcAsync(_rpc, "instructions.getDiscoveryPaths", [request], cancellationToken); + } +} + +/// Provides server-scoped Commands APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerCommandsApi +{ + private readonly JsonRpc _rpc; + + internal ServerCommandsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Lists the well-known built-in slash commands that work as the first message in a new session (e.g. /plan, /env), without requiring an active session. Commands that depend on session state, authentication, or a synced session are omitted. + /// The to monitor for cancellation requests. The default is . + /// Slash commands available in the session, after applying any include/exclude filters. + public async Task ListAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "commands.list", [], cancellationToken); + } +} + /// Provides server-scoped User APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerUserApi { private readonly JsonRpc _rpc; @@ -13169,6 +24141,7 @@ internal ServerUserApi(JsonRpc rpc) } /// Provides server-scoped UserSettings APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerUserSettingsApi { private readonly JsonRpc _rpc; @@ -13184,9 +24157,69 @@ public async Task ReloadAsync(CancellationToken cancellationToken = default) { await CopilotClient.InvokeRpcAsync(_rpc, "user.settings.reload", [], cancellationToken); } + + /// Lists every known user setting (settings.json overlaid with the legacy config.json, config.json wins), each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time. + /// The to monitor for cancellation requests. The default is . + /// Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. + public async Task GetAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "user.settings.get", [], cancellationToken); + } + + /// Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed. Returns the keys whose new value is shadowed by a legacy config.json entry (config.json wins on read), which the runtime leaves in place — such writes do not take effect until the legacy value is removed. + /// Partial user settings to write, as a free-form object keyed by setting name. + /// The to monitor for cancellation requests. The default is . + /// Outcome of writing user settings. + public async Task SetAsync(object settings, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(settings); + + var request = new UserSettingsSetRequest { Settings = CopilotClient.ToJsonElementForWire(settings)!.Value }; + return await CopilotClient.InvokeRpcAsync(_rpc, "user.settings.set", [request], cancellationToken); + } +} + +/// Provides server-scoped ManagedSettings APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerManagedSettingsApi +{ + private readonly JsonRpc _rpc; + + internal ServerManagedSettingsApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session. + /// The to monitor for cancellation requests. The default is . + /// Validated device-managed settings discovered before a session exists. + public async Task ReadAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "managedSettings.read", [], cancellationToken); + } +} + +/// Provides server-scoped Runtime APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerRuntimeApi +{ + private readonly JsonRpc _rpc; + + internal ServerRuntimeApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process. + /// The to monitor for cancellation requests. The default is . + public async Task ShutdownAsync(CancellationToken cancellationToken = default) + { + await CopilotClient.InvokeRpcAsync(_rpc, "runtime.shutdown", [], cancellationToken); + } } /// Provides server-scoped SessionFs APIs. +[Experimental(Diagnostics.Experimental)] public sealed class ServerSessionFsApi { private readonly JsonRpc _rpc; @@ -13213,6 +24246,59 @@ public async Task SetProviderAsync(string initialCwd } } +/// Provides server-scoped LlmInference APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ServerLlmInferenceApi +{ + private readonly JsonRpc _rpc; + + internal ServerLlmInferenceApi(JsonRpc rpc) + { + _rpc = rpc; + } + + /// Registers an SDK client as the LLM inference callback provider. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the calling client was registered as the LLM inference provider. + public async Task SetProviderAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "llmInference.setProvider", [], cancellationToken); + } + + /// Delivers the response head (status + headers) for an in-flight request, correlated by the requestId the runtime supplied in httpRequestStart. Must be called exactly once per request before any httpResponseChunk frames. + /// Matches the requestId from the originating httpRequestStart frame. + /// HTTP status code. + /// The headers parameter. + /// Optional HTTP status reason phrase. + /// The to monitor for cancellation requests. The default is . + /// Whether the start frame was accepted. + public async Task HttpResponseStartAsync(string requestId, long status, IDictionary> headers, string? statusText = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(headers); + + var request = new LlmInferenceHttpResponseStartRequest { RequestId = requestId, Status = status, Headers = headers, StatusText = statusText }; + return await CopilotClient.InvokeRpcAsync(_rpc, "llmInference.httpResponseStart", [request], cancellationToken); + } + + /// Delivers a body byte range (or a terminal transport error) for an in-flight response, correlated by requestId. Set `end` true on the last chunk. When `error` is set the response terminates with a transport-level failure and the runtime raises an APIConnectionError. + /// Matches the requestId from the originating httpRequestStart frame. + /// Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk with empty data and end=true). + /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + /// When true, this is the final body chunk for the response. The runtime treats the response body as complete after receiving an end-marked chunk. + /// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + /// The to monitor for cancellation requests. The default is . + /// Whether the chunk was accepted. + public async Task HttpResponseChunkAsync(string requestId, string data, bool? binary = null, bool? end = null, LlmInferenceHttpResponseChunkError? error = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(data); + + var request = new LlmInferenceHttpResponseChunkRequest { RequestId = requestId, Data = data, Binary = binary, End = end, Error = error }; + return await CopilotClient.InvokeRpcAsync(_rpc, "llmInference.httpResponseChunk", [request], cancellationToken); + } +} + /// Provides server-scoped Sessions APIs. [Experimental(Diagnostics.Experimental)] public sealed class ServerSessionsApi @@ -13224,6 +24310,14 @@ internal ServerSessionsApi(JsonRpc rpc) _rpc = rpc; } + /// Creates or resumes a local session and returns the opened session ID. + /// The to monitor for cancellation requests. The default is . + /// Result of opening a session. + public async Task OpenAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.open", [], cancellationToken); + } + /// Creates a new session by forking persisted history from an existing session. /// Source session ID to fork from. /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included. @@ -13246,20 +24340,44 @@ public async Task ConnectAsync(string sessionId, { ArgumentNullException.ThrowIfNull(sessionId); - var request = new ConnectRemoteSessionParams { SessionId = sessionId }; - return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.connect", [request], cancellationToken); + var request = new ConnectRemoteSessionParams { SessionId = sessionId }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.connect", [request], cancellationToken); + } + + /// Lists sessions, optionally filtered by source and working-directory context. Returned entries are discriminated by `isRemote`: local entries carry only the lightweight `LocalSessionMetadataValue` shape; remote entries carry the full `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.). + /// Which session sources to include. Defaults to `local` for backward compatibility. + /// When provided, only the first N local sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every local session. Has no effect on remote entries (which always carry their full shape). + /// Optional filter applied to the returned sessions. + /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. + /// Only meaningful when `source` includes remote. When true, propagates errors from the remote service instead of silently returning an empty remote list. Defaults to false. + /// The to monitor for cancellation requests. The default is . + /// Sessions matching the filter, ordered most-recently-modified first. + public async Task ListAsync(SessionSource? source = null, long? metadataLimit = null, SessionListFilter? filter = null, bool? includeDetached = null, bool? throwOnError = null, CancellationToken cancellationToken = default) + { + var request = new SessionsListRequest { Source = source, MetadataLimit = metadataLimit, Filter = filter, IncludeDetached = includeDetached, ThrowOnError = throwOnError }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.list", [request], cancellationToken); + } + + /// Reads lightweight persisted metadata for one local session without opening it. + /// Session ID to inspect. + /// The to monitor for cancellation requests. The default is . + /// Persisted local session metadata when the session exists. + internal async Task GetMetadataAsync(string sessionId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + + var request = new SessionsGetMetadataRequest { SessionId = sessionId }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.getMetadata", [request], cancellationToken); } - /// Lists persisted sessions, optionally filtered by working-directory context. - /// When provided, only the first N sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every session. - /// Optional filter applied to the returned sessions. - /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. + /// Lists recent local session IDs that contain user-visible history, omitting housekeeping-only sessions. + /// Maximum number of session IDs to return. /// The to monitor for cancellation requests. The default is . - /// Persisted sessions matching the filter, ordered most-recently-modified first. - public async Task ListAsync(long? metadataLimit = null, SessionListFilter? filter = null, bool? includeDetached = null, CancellationToken cancellationToken = default) + /// Recent local session IDs that contain user-visible history. + internal async Task ListNonEmptySessionIdsAsync(long? limit = null, CancellationToken cancellationToken = default) { - var request = new SessionsListRequest { MetadataLimit = metadataLimit, Filter = filter, IncludeDetached = includeDetached }; - return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.list", [request], cancellationToken); + var request = new SessionsListNonEmptySessionIdsRequest { Limit = limit }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.listNonEmptySessionIds", [request], cancellationToken); } /// Finds the local session bound to a GitHub task ID, if any. @@ -13296,11 +24414,11 @@ public async Task GetLastForContextAsync(Sessio return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.getLastForContext", [request], cancellationToken); } - /// Computes the absolute path to a session's persisted events.jsonl file. + /// Computes the absolute path to a session's persisted events.jsonl file. Internal: filesystem paths are only meaningful in-process (CLI and runtime share a filesystem). Currently used by the CLI's contribution-graph feature to read historical events directly. Remote SDK consumers must not depend on this; a proper event-query API would replace it if the contribution graph ever needed to work over the wire. /// Session ID whose event-log file path to compute. /// The to monitor for cancellation requests. The default is . /// Absolute path to the session's events.jsonl file on disk. - public async Task GetEventFilePathAsync(string sessionId, CancellationToken cancellationToken = default) + internal async Task GetEventFilePathAsync(string sessionId, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(sessionId); @@ -13328,11 +24446,11 @@ public async Task CheckInUseAsync(IList sessio return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.checkInUse", [request], cancellationToken); } - /// Returns a session's persisted remote-steerable flag, if any has been recorded. + /// Returns a session's persisted remote-steerable flag, if any has been recorded. Internal: this is CLI-specific book-keeping used by `--continue` / `--resume` to inherit the prior session's remote-steerable preference. SDK consumers that want similar behavior should manage their own persistence around start/stop calls rather than relying on this runtime-side flag. /// Session ID to look up the persisted remote-steerable flag for. /// The to monitor for cancellation requests. The default is . /// The session's persisted remote-steerable flag, or omitted when no value has been persisted. - public async Task GetPersistedRemoteSteerableAsync(string sessionId, CancellationToken cancellationToken = default) + internal async Task GetPersistedRemoteSteerableAsync(string sessionId, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(sessionId); @@ -13364,6 +24482,18 @@ public async Task BulkDeleteAsync(IList session return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.bulkDelete", [request], cancellationToken); } + /// Deletes one local session from disk after running the same lifecycle hooks as the session manager. + /// Session ID to delete. + /// Internal resolved session directory path to delete. + /// The to monitor for cancellation requests. The default is . + internal async Task DeleteAsync(string sessionId, string? sessionPath = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + + var request = new SessionsDeleteRequest { SessionId = sessionId, SessionPath = sessionPath }; + await CopilotClient.InvokeRpcAsync(_rpc, "sessions.delete", [request], cancellationToken); + } + /// Deletes sessions older than the given threshold, with optional dry-run and exclusion list. /// Delete sessions whose modifiedTime is at least this many days old. /// When true, only report what would be deleted without performing any deletion. @@ -13405,7 +24535,7 @@ public async Task ReleaseLockAsync(string sessionId, /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. /// The to monitor for cancellation requests. The default is . /// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. - public async Task EnrichMetadataAsync(IList sessions, CancellationToken cancellationToken = default) + public async Task EnrichMetadataAsync(IList sessions, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(sessions); @@ -13449,6 +24579,98 @@ public async Task SetAdditionalPluginsAsync( var request = new SessionsSetAdditionalPluginsRequest { Plugins = plugins }; return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.setAdditionalPlugins", [request], cancellationToken); } + + /// Gets the dynamic-context board entry count associated with a session, when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, `rem_consolidation_complete`) can pair START / END board counts around the detached rem-agent spawn. "Dynamic context board" is a runtime-internal concept that is not part of the public SDK contract; the long-term plan is to relocate the telemetry emission into the runtime so this method can be deleted entirely. + /// Session ID whose board entry count should be returned. + /// The to monitor for cancellation requests. The default is . + /// Dynamic-context board entry count, when available. + internal async Task GetBoardEntryCountAsync(string sessionId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + + var request = new SessionsGetBoardEntryCountRequest { SessionId = sessionId }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.getBoardEntryCount", [request], cancellationToken); + } + + /// Attaches the runtime-managed remote-control singleton to a session, awaiting initial setup. If remote control is already attached to a different session, the singleton is transferred (preserving the underlying Mission Control connection). Returns the final status. + /// Local session id to attach remote control to. + /// Configuration for the runtime-managed remote-control singleton. + /// The to monitor for cancellation requests. The default is . + /// Wrapper for the singleton's current status. + public async Task StartRemoteControlAsync(string sessionId, RemoteControlConfig config, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + ArgumentNullException.ThrowIfNull(config); + + var request = new SessionsStartRemoteControlRequest { SessionId = sessionId, Config = config }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.startRemoteControl", [request], cancellationToken); + } + + /// Atomically rebinds the remote-control singleton to a different session, preserving the underlying Mission Control connection. When `expectedFromSessionId` is provided and does not match the singleton's current `attachedSessionId`, the transfer is rejected with `transferred: false` and the current status is returned unchanged. + /// Local session id to point remote control at. + /// When provided, the transfer is rejected unless the singleton currently points at this session id (compare-and-swap semantics to avoid clobbering newer state). + /// The to monitor for cancellation requests. The default is . + /// Outcome of a transferRemoteControl call. + public async Task TransferRemoteControlAsync(string toSessionId, string? expectedFromSessionId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(toSessionId); + + var request = new SessionsTransferRemoteControlRequest { ToSessionId = toSessionId, ExpectedFromSessionId = expectedFromSessionId }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.transferRemoteControl", [request], cancellationToken); + } + + /// Patches the steering state of the active remote-control singleton. When remote control is off, this is a no-op and the off status is returned. Today only `enabled: true` is actionable on the underlying exporter; passing `false` is reserved for future use. + /// Target steering state. Today only `true` is actionable on the underlying exporter; `false` is reserved for future use. + /// The to monitor for cancellation requests. The default is . + /// Wrapper for the singleton's current status. + public async Task SetRemoteControlSteeringAsync(bool enabled, CancellationToken cancellationToken = default) + { + var request = new SessionsSetRemoteControlSteeringRequest { Enabled = enabled }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.setRemoteControlSteering", [request], cancellationToken); + } + + /// Stops the remote-control singleton. When `expectedSessionId` is provided and does not match the singleton's current `attachedSessionId`, the stop is rejected with `stopped: false` and the current status is returned unchanged (unless `force` is set, in which case the singleton is unconditionally torn down). + /// When provided, the stop is rejected unless the singleton currently points at this session id (compare-and-swap semantics). + /// When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. Use during shutdown or explicit `/remote off`. + /// The to monitor for cancellation requests. The default is . + /// Outcome of a stopRemoteControl call. + public async Task StopRemoteControlAsync(string? expectedSessionId = null, bool? force = null, CancellationToken cancellationToken = default) + { + var request = new SessionsStopRemoteControlRequest { ExpectedSessionId = expectedSessionId, Force = force }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.stopRemoteControl", [request], cancellationToken); + } + + /// Returns the current state of the remote-control singleton, including the attached session id and frontend URL when active. + /// The to monitor for cancellation requests. The default is . + /// Wrapper for the singleton's current status. + public async Task GetRemoteControlStatusAsync(CancellationToken cancellationToken = default) + { + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.getRemoteControlStatus", [], cancellationToken); + } + + /// Registers extension-provided tools on the given session, gated by an optional `enabled` callback. Returns an opaque unsubscribe function the caller must invoke to deregister the tools when the extension is torn down. Marked internal because `loader`, `enabled`, and the returned `unsubscribe` are in-process handles that cannot cross the JSON-RPC boundary. Disappears once extension discovery / launch / tool registration are owned by the runtime: SDK consumers will pass pure config (search paths, disabled ids) via `SessionOptions` and the runtime will resolve, launch, register, and tear down extensions itself. + /// Session to register extension tools on. + /// Optional registration options. + /// The to monitor for cancellation requests. The default is . + /// Handle for releasing the extension tool registration. + internal async Task RegisterExtensionToolsOnSessionAsync(string sessionId, SessionsRegisterExtensionToolsOnSessionOptions? options = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + + var request = new RegisterExtensionToolsParams { SessionId = sessionId, Options = options }; + return await CopilotClient.InvokeRpcAsync(_rpc, "sessions.registerExtensionToolsOnSession", [request], cancellationToken); + } + + /// Attaches (or detaches) an in-process ExtensionController delegate for the given session, used by shared-API surfaces that need to query or modify the session's extension state. Pass `controller: undefined` to detach. Marked internal because the controller is an in-process object that cannot cross the JSON-RPC boundary. Disappears alongside `registerExtensionToolsOnSession`: once the runtime owns extension management, the public surface exposes list/enable/disable/reload as dedicated RPCs served by the runtime. + /// Session to attach the extension controller delegate to. + /// The to monitor for cancellation requests. The default is . + internal async Task ConfigureSessionExtensionsAsync(string sessionId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(sessionId); + + var request = new ConfigureSessionExtensionsParams { SessionId = sessionId }; + await CopilotClient.InvokeRpcAsync(_rpc, "sessions.configureSessionExtensions", [request], cancellationToken); + } } /// Provides server-scoped AgentRegistry APIs. @@ -13492,8 +24714,14 @@ internal SessionRpc(CopilotSession session) internal CopilotSession Session => _session; - /// Auth APIs. - public AuthApi Auth => + /// GitHubAuth APIs. + public GitHubAuthApi GitHubAuth => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + + /// Debug APIs. + public DebugApi Debug => field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; @@ -13504,6 +24732,12 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Factory APIs. + public FactoryApi Factory => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Model APIs. public ModelApi Model => field ?? @@ -13534,6 +24768,12 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Completions APIs. + public CompletionsApi Completions => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Instructions APIs. public InstructionsApi Instructions => field ?? @@ -13576,6 +24816,12 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Provider APIs. + public ProviderApi Provider => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Options APIs. public OptionsApi Options => field ?? @@ -13630,6 +24876,18 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Settings APIs. + public SettingsApi Settings => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + + /// ContentExclusion APIs. + public ContentExclusionApi ContentExclusion => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Shell APIs. public ShellApi Shell => field ?? @@ -13660,12 +24918,24 @@ internal SessionRpc(CopilotSession session) Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// LimitPrediction APIs. + public LimitPredictionApi LimitPrediction => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Remote APIs. public RemoteApi Remote => field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Visibility APIs. + public VisibilityApi Visibility => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Schedule APIs. public ScheduleApi Schedule => field ?? @@ -13691,24 +24961,60 @@ public async Task SuspendAsync(CancellationToken cancellationToken = default) /// If true, adds the message to the front of the queue instead of the end. /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange. - /// Optional provenance tag copied to the resulting user.message event. Supported values are `system`, `command-*`, and `schedule-*`. + /// Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-<command-id>` for command-originated messages, `schedule-<numeric-id>` for scheduled prompts, or `agent-<agent-id>` for prompts sent by another agent. /// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. /// W3C Trace Context traceparent header for distributed tracing of this agent turn. /// W3C Trace Context tracestate header for distributed tracing. - /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. + /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. /// The to monitor for cancellation requests. The default is . /// Result of sending a user message. [Experimental(Diagnostics.Experimental)] - public async Task SendAsync(string prompt, string? displayPrompt = null, IList? attachments = null, SendMode? mode = null, bool? prepend = null, bool? billable = null, string? requiredTool = null, object? source = null, SendAgentMode? agentMode = null, IDictionary? requestHeaders = null, string? traceparent = null, string? tracestate = null, bool? wait = null, CancellationToken cancellationToken = default) + public async Task SendAsync(string prompt, string? displayPrompt = null, IList? attachments = null, SendMode? mode = null, bool? prepend = null, bool? billable = null, string? requiredTool = null, string? source = null, SendAgentMode? agentMode = null, IDictionary? requestHeaders = null, string? traceparent = null, string? tracestate = null, bool? wait = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(prompt); _session.ThrowIfDisposed(); - var request = new SendRequest { SessionId = _session.SessionId, Prompt = prompt, DisplayPrompt = displayPrompt, Attachments = attachments, Mode = mode, Prepend = prepend, Billable = billable, RequiredTool = requiredTool, Source = CopilotClient.ToJsonElementForWire(source), AgentMode = agentMode, RequestHeaders = requestHeaders, Traceparent = traceparent, Tracestate = tracestate, Wait = wait }; + var request = new SendRequest { SessionId = _session.SessionId, Prompt = prompt, DisplayPrompt = displayPrompt, Attachments = attachments, Mode = mode, Prepend = prepend, Billable = billable, RequiredTool = requiredTool, Source = source, AgentMode = agentMode, RequestHeaders = requestHeaders, Traceparent = traceparent, Tracestate = tracestate, Wait = wait }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.send", [request], cancellationToken); } + /// Sends zero or more user messages to the session in a single turn and returns their message IDs. All provided messages are appended to the conversation in order, then exactly one agent turn runs over the resulting history. When the list is empty, one turn runs over the existing history with no new user message. Remote-backed (Mission Control) sessions do not support this method and will return an error. + /// The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message. + /// How to deliver the messages. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + /// If true, adds the messages to the front of the queue instead of the end. + /// The UI mode the agent was in when these messages were sent. Defaults to the session's current mode. + /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + /// W3C Trace Context traceparent header for distributed tracing of this agent turn. + /// W3C Trace Context tracestate header for distributed tracing. + /// If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + /// The to monitor for cancellation requests. The default is . + /// Result of sending zero or more user messages. + [Experimental(Diagnostics.Experimental)] + public async Task SendMessagesAsync(IList messages, SendMode? mode = null, bool? prepend = null, SendAgentMode? agentMode = null, IDictionary? requestHeaders = null, string? traceparent = null, string? tracestate = null, bool? wait = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(messages); + _session.ThrowIfDisposed(); + + var request = new SendMessagesRequest { SessionId = _session.SessionId, Messages = messages, Mode = mode, Prepend = prepend, AgentMode = agentMode, RequestHeaders = requestHeaders, Traceparent = traceparent, Tracestate = tracestate, Wait = wait }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.sendMessages", [request], cancellationToken); + } + + /// Queues or sends an internal system notification to the session according to its passive policy. + /// Notification text to deliver to the model. + /// Optional structured notification kind. + /// Internal delivery options, including passive policy. + /// The to monitor for cancellation requests. The default is . + [Experimental(Diagnostics.Experimental)] + internal async Task SendSystemNotificationAsync(string message, object? kind = null, object? options = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(message); + _session.ThrowIfDisposed(); + + var request = new SendSystemNotificationRequest { SessionId = _session.SessionId, Message = message, Kind = CopilotClient.ToJsonElementForWire(kind), Options = CopilotClient.ToJsonElementForWire(options) }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.sendSystemNotification", [request], cancellationToken); + } + /// Aborts the current agent turn. /// Finite reason code describing why the current turn was aborted. /// The to monitor for cancellation requests. The default is . @@ -13722,6 +25028,31 @@ public async Task AbortAsync(AbortReason? reason = null, Cancellati return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.abort", [request], cancellationToken); } + /// Interrupts the current main agent turn while leaving running background work (subagents, sidekicks, and promoted attached shells) alive. No-op when the main loop is not processing. + /// When true, the user's queued prompts are preserved and run as the next turn once the interrupted turn unwinds; when false (the default), the queue is cleared like a plain abort. + /// The to monitor for cancellation requests. The default is . + /// Result of interrupting the main agent turn. + [Experimental(Diagnostics.Experimental)] + public async Task InterruptMainTurnAsync(bool? flushQueued = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new InterruptMainTurnRequest { SessionId = _session.SessionId, FlushQueued = flushQueued }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.interruptMainTurn", [request], cancellationToken); + } + + /// Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop. Promoted attached shells are left running. + /// The to monitor for cancellation requests. The default is . + /// The number of running background agents (task-registry agents) that were cancelled. + [Experimental(Diagnostics.Experimental)] + public async Task CancelAllBackgroundAgentsAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionCancelAllBackgroundAgentsRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.cancelAllBackgroundAgents", [request], cancellationToken); + } + /// Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down. /// Why the session is being shut down. Defaults to "routine" when omitted. /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. @@ -13747,143 +25078,372 @@ public async Task ShutdownAsync(ShutdownType? type = null, string? reason = null [Experimental(Diagnostics.Experimental)] public async Task LogAsync(string message, SessionLogLevel? level = null, string? type = null, bool? ephemeral = null, string? url = null, string? tip = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(message); + ArgumentNullException.ThrowIfNull(message); + _session.ThrowIfDisposed(); + + var request = new LogRequest { SessionId = _session.SessionId, Message = message, Level = level, Type = type, Ephemeral = ephemeral, Url = url, Tip = tip }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.log", [request], cancellationToken); + } +} + +/// Provides session-scoped GitHubAuth APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class GitHubAuthApi +{ + private readonly CopilotSession _session; + + internal GitHubAuthApi(CopilotSession session) + { + _session = session; + } + + /// Gets authentication status and account metadata for the session. + /// The to monitor for cancellation requests. The default is . + /// Authentication status and account metadata for the session. + public async Task GetStatusAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionGitHubAuthGetStatusRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.getStatus", [request], cancellationToken); + } + + /// Updates the session's auth credentials used for outbound model and API requests. + /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime installs the supplied value immediately for outbound model/API requests. When the credential carries a raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous install) so plan/quota/billing metadata regains fidelity; on resolution failure the verbatim credential remains installed. It does NOT otherwise validate the credential. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the credential update succeeded. + public async Task SetCredentialsAsync(AuthInfo? credentials = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionSetCredentialsParams { SessionId = _session.SessionId, Credentials = credentials }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.gitHubAuth.setCredentials", [request], cancellationToken); + } +} + +/// Provides session-scoped Debug APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class DebugApi +{ + private readonly CopilotSession _session; + + internal DebugApi(CopilotSession session) + { + _session = session; + } + + /// Collects a redacted session debug log bundle into a local archive or staging directory. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape. + /// Where the redacted bundle should be written. Use `archive` to produce a .tgz, or `directory` to stage redacted files for caller-managed upload/post-processing. + /// Which built-in session diagnostics to include. Omitted fields default to true. + /// Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape. + /// The to monitor for cancellation requests. The default is . + /// Result of collecting a redacted debug bundle. + public async Task CollectLogsAsync(DebugCollectLogsDestination destination, DebugCollectLogsInclude? include = null, IList? additionalEntries = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(destination); + _session.ThrowIfDisposed(); + + var request = new DebugCollectLogsRequest { SessionId = _session.SessionId, Destination = destination, Include = include, AdditionalEntries = additionalEntries }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.debug.collectLogs", [request], cancellationToken); + } +} + +/// Provides session-scoped Canvas APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasApi +{ + private readonly CopilotSession _session; + + internal CanvasApi(CopilotSession session) + { + _session = session; + } + + /// Lists canvases declared for the session. + /// The to monitor for cancellation requests. The default is . + /// Declared canvases available in this session. + public async Task ListAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionCanvasListRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.list", [request], cancellationToken); + } + + /// Lists currently open canvas instances for the live session. + /// The to monitor for cancellation requests. The default is . + /// Live open-canvas snapshot. + public async Task ListOpenAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionCanvasListOpenRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.listOpen", [request], cancellationToken); + } + + /// Opens or focuses a canvas instance. + /// Provider-local canvas identifier. + /// Caller-supplied stable instance identifier. + /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. + /// Canvas open input. + /// The to monitor for cancellation requests. The default is . + /// Open canvas instance snapshot. + public async Task OpenAsync(string canvasId, string instanceId, string? extensionId = null, object? input = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(canvasId); + ArgumentNullException.ThrowIfNull(instanceId); + _session.ThrowIfDisposed(); + + var request = new CanvasOpenRequest { SessionId = _session.SessionId, CanvasId = canvasId, InstanceId = instanceId, ExtensionId = extensionId, Input = CopilotClient.ToJsonElementForWire(input) }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.open", [request], cancellationToken); + } + + /// Closes an open canvas instance. + /// Open canvas instance identifier. + /// The to monitor for cancellation requests. The default is . + public async Task CloseAsync(string instanceId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(instanceId); + _session.ThrowIfDisposed(); + + var request = new CanvasCloseRequest { SessionId = _session.SessionId, InstanceId = instanceId }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.close", [request], cancellationToken); + } + + /// Action APIs. + public CanvasActionApi Action => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; +} + +/// Provides session-scoped CanvasAction APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class CanvasActionApi +{ + private readonly CopilotSession _session; + + internal CanvasActionApi(CopilotSession session) + { + _session = session; + } + + /// Invokes an action on an open canvas instance. + /// Open canvas instance identifier. + /// Action name to invoke. + /// Action input. + /// The to monitor for cancellation requests. The default is . + /// Canvas action invocation result. + public async Task InvokeAsync(string instanceId, string actionName, object? input = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(instanceId); + ArgumentNullException.ThrowIfNull(actionName); _session.ThrowIfDisposed(); - var request = new LogRequest { SessionId = _session.SessionId, Message = message, Level = level, Type = type, Ephemeral = ephemeral, Url = url, Tip = tip }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.log", [request], cancellationToken); + var request = new CanvasActionInvokeRequest { SessionId = _session.SessionId, InstanceId = instanceId, ActionName = actionName, Input = CopilotClient.ToJsonElementForWire(input) }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.action.invoke", [request], cancellationToken); } } -/// Provides session-scoped Auth APIs. +/// Provides session-scoped Factory APIs. [Experimental(Diagnostics.Experimental)] -public sealed class AuthApi +public sealed class FactoryApi { private readonly CopilotSession _session; - internal AuthApi(CopilotSession session) + internal FactoryApi(CopilotSession session) { _session = session; } - /// Gets authentication status and account metadata for the session. + /// Runs a registered factory by name at the top level. + /// Registered factory name. + /// Factory input value. + /// Factory invocation options. /// The to monitor for cancellation requests. The default is . - /// Authentication status and account metadata for the session. - public async Task GetStatusAsync(CancellationToken cancellationToken = default) + /// Complete current or terminal factory run envelope. + public async Task RunAsync(string name, object args, RunOptions? options = null, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(name); + ArgumentNullException.ThrowIfNull(args); _session.ThrowIfDisposed(); - var request = new SessionAuthGetStatusRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.auth.getStatus", [request], cancellationToken); + var request = new FactoryRunRequest { SessionId = _session.SessionId, Name = name, Args = CopilotClient.ToJsonElementForWire(args)!.Value, Options = options }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.run", [request], cancellationToken); } - /// Updates the session's auth credentials used for outbound model and API requests. - /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. + /// Resumes a factory run using its persisted name, arguments, journal, and accounting. + /// Factory run identifier. + /// Optional per-invocation resource ceiling overrides. /// The to monitor for cancellation requests. The default is . - /// Indicates whether the credential update succeeded. - public async Task SetCredentialsAsync(AuthInfo? credentials = null, CancellationToken cancellationToken = default) + /// Resolved persisted factory identity and resumed run envelope. + public async Task ResumeAsync(string runId, FactoryRunLimits? limits = null, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(runId); _session.ThrowIfDisposed(); - var request = new SessionSetCredentialsParams { SessionId = _session.SessionId, Credentials = credentials }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.auth.setCredentials", [request], cancellationToken); + var request = new FactoryResumeRequest { SessionId = _session.SessionId, RunId = runId, Limits = limits }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.resume", [request], cancellationToken); } -} -/// Provides session-scoped Canvas APIs. -[Experimental(Diagnostics.Experimental)] -public sealed class CanvasApi -{ - private readonly CopilotSession _session; + /// Gets the current or settled envelope for a factory run. + /// Factory run identifier. + /// The to monitor for cancellation requests. The default is . + /// Complete current or terminal factory run envelope. + public async Task GetRunAsync(string runId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(runId); + _session.ThrowIfDisposed(); - internal CanvasApi(CopilotSession session) + var request = new FactoryGetRunRequest { SessionId = _session.SessionId, RunId = runId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.getRun", [request], cancellationToken); + } + + /// Lists durable factory runs for this session in creation order. + /// Exclusive forward cursor. + /// Exclusive backward cursor. + /// Maximum terminal runs to return. Defaults to 200 and is capped at 500. + /// The to monitor for cancellation requests. The default is . + /// A page of factory runs in durable creation order. + public async Task ListRunsAsync(long? afterSeq = null, long? beforeSeq = null, int? limit = null, CancellationToken cancellationToken = default) { - _session = session; + _session.ThrowIfDisposed(); + + var request = new FactoryListRunsRequest { SessionId = _session.SessionId, AfterSeq = afterSeq, BeforeSeq = beforeSeq, Limit = limit }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.listRuns", [request], cancellationToken); } - /// Lists canvases declared for the session. + /// Gets durable and live observability detail for one factory run. + /// Factory run identifier. /// The to monitor for cancellation requests. The default is . - /// Declared canvases available in this session. - public async Task ListAsync(CancellationToken cancellationToken = default) + /// Full factory run observability detail. + public async Task GetRunDetailAsync(string runId, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(runId); _session.ThrowIfDisposed(); - var request = new SessionCanvasListRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.list", [request], cancellationToken); + var request = new FactoryGetRunRequest { SessionId = _session.SessionId, RunId = runId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.getRunDetail", [request], cancellationToken); } - /// Lists currently open canvas instances for the live session. + /// Pages durable progress for one factory run. + /// Factory run identifier. + /// Optional phase identifier used to scope records and cursors. + /// Exclusive forward cursor. + /// Exclusive backward cursor. + /// Maximum records to return. Defaults to 200 and is capped at 500. /// The to monitor for cancellation requests. The default is . - /// Live open-canvas snapshot. - public async Task ListOpenAsync(CancellationToken cancellationToken = default) + /// A bidirectional page of factory progress. + public async Task GetRunProgressAsync(string runId, string? phaseId = null, long? afterSeq = null, long? beforeSeq = null, int? limit = null, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(runId); _session.ThrowIfDisposed(); - var request = new SessionCanvasListOpenRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.listOpen", [request], cancellationToken); + var request = new FactoryGetRunProgressRequest { SessionId = _session.SessionId, RunId = runId, PhaseId = phaseId, AfterSeq = afterSeq, BeforeSeq = beforeSeq, Limit = limit }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.getRunProgress", [request], cancellationToken); } - /// Opens or focuses a canvas instance. - /// Provider-local canvas identifier. - /// Caller-supplied stable instance identifier. - /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. - /// Canvas open input. + /// Requests cancellation of a factory run and returns its run envelope. + /// Factory run identifier. /// The to monitor for cancellation requests. The default is . - /// Open canvas instance snapshot. - public async Task OpenAsync(string canvasId, string instanceId, string? extensionId = null, object? input = null, CancellationToken cancellationToken = default) + /// Complete current or terminal factory run envelope. + public async Task CancelAsync(string runId, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(canvasId); - ArgumentNullException.ThrowIfNull(instanceId); + ArgumentNullException.ThrowIfNull(runId); _session.ThrowIfDisposed(); - var request = new CanvasOpenRequest { SessionId = _session.SessionId, CanvasId = canvasId, InstanceId = instanceId, ExtensionId = extensionId, Input = CopilotClient.ToJsonElementForWire(input) }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.open", [request], cancellationToken); + var request = new FactoryCancelRequest { SessionId = _session.SessionId, RunId = runId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.cancel", [request], cancellationToken); } - /// Closes an open canvas instance. - /// Open canvas instance identifier. + /// Records a batch of ordered factory progress lines. + /// Factory run identifier. + /// Opaque token identifying the current factory execution attempt. + /// Ordered progress lines to append. /// The to monitor for cancellation requests. The default is . - public async Task CloseAsync(string instanceId, CancellationToken cancellationToken = default) + /// Acknowledgement that a factory request was accepted. + public async Task LogAsync(string runId, string executionToken, IList lines, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(instanceId); + ArgumentNullException.ThrowIfNull(runId); + ArgumentNullException.ThrowIfNull(executionToken); + ArgumentNullException.ThrowIfNull(lines); _session.ThrowIfDisposed(); - var request = new CanvasCloseRequest { SessionId = _session.SessionId, InstanceId = instanceId }; - await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.close", [request], cancellationToken); + var request = new FactoryLogRequest { SessionId = _session.SessionId, RunId = runId, ExecutionToken = executionToken, Lines = lines }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.log", [request], cancellationToken); } - /// Action APIs. - public CanvasActionApi Action => + /// Runs one factory-scoped subagent and returns its result. + /// Factory run identifier that owns the subagent. + /// Opaque token identifying the current factory execution attempt. + /// Prompt to send to the subagent. + /// Subagent execution options. + /// The to monitor for cancellation requests. The default is . + /// Result of one factory-scoped subagent call. + public async Task AgentAsync(string factoryRunId, string executionToken, string prompt, FactoryAgentOptions opts, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(factoryRunId); + ArgumentNullException.ThrowIfNull(executionToken); + ArgumentNullException.ThrowIfNull(prompt); + ArgumentNullException.ThrowIfNull(opts); + _session.ThrowIfDisposed(); + + var request = new FactoryAgentRequest { SessionId = _session.SessionId, FactoryRunId = factoryRunId, ExecutionToken = executionToken, Prompt = prompt, Opts = opts }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.agent", [request], cancellationToken); + } + + /// Journal APIs. + public FactoryJournalApi Journal => field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; } -/// Provides session-scoped CanvasAction APIs. +/// Provides session-scoped FactoryJournal APIs. [Experimental(Diagnostics.Experimental)] -public sealed class CanvasActionApi +public sealed class FactoryJournalApi { private readonly CopilotSession _session; - internal CanvasActionApi(CopilotSession session) + internal FactoryJournalApi(CopilotSession session) { _session = session; } - /// Invokes an action on an open canvas instance. - /// Open canvas instance identifier. - /// Action name to invoke. - /// Action input. + /// Reads a memoized factory journal entry. + /// Factory run identifier. + /// Opaque token identifying the current factory execution attempt. + /// Namespaced journal key. /// The to monitor for cancellation requests. The default is . - /// Canvas action invocation result. - public async Task InvokeAsync(string instanceId, string actionName, object? input = null, CancellationToken cancellationToken = default) + /// Result of reading a factory journal entry. + public async Task GetAsync(string runId, string executionToken, string key, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(instanceId); - ArgumentNullException.ThrowIfNull(actionName); + ArgumentNullException.ThrowIfNull(runId); + ArgumentNullException.ThrowIfNull(executionToken); + ArgumentNullException.ThrowIfNull(key); _session.ThrowIfDisposed(); - var request = new CanvasActionInvokeRequest { SessionId = _session.SessionId, InstanceId = instanceId, ActionName = actionName, Input = CopilotClient.ToJsonElementForWire(input) }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.canvas.action.invoke", [request], cancellationToken); + var request = new FactoryJournalGetRequest { SessionId = _session.SessionId, RunId = runId, ExecutionToken = executionToken, Key = key }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.journal.get", [request], cancellationToken); + } + + /// Stores a memoized factory journal entry. + /// Factory run identifier. + /// Opaque token identifying the current factory execution attempt. + /// Namespaced journal key. + /// JSON result to memoize. + /// The to monitor for cancellation requests. The default is . + /// Acknowledgement that a factory request was accepted. + public async Task PutAsync(string runId, string executionToken, string key, object resultJson, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(runId); + ArgumentNullException.ThrowIfNull(executionToken); + ArgumentNullException.ThrowIfNull(key); + ArgumentNullException.ThrowIfNull(resultJson); + _session.ThrowIfDisposed(); + + var request = new FactoryJournalPutRequest { SessionId = _session.SessionId, RunId = runId, ExecutionToken = executionToken, Key = key, ResultJson = CopilotClient.ToJsonElementForWire(resultJson)!.Value }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.factory.journal.put", [request], cancellationToken); } } @@ -13900,7 +25460,7 @@ internal ModelApi(CopilotSession session) /// Gets the currently selected model for the session. /// The to monitor for cancellation requests. The default is . - /// The currently selected model, reasoning effort, and context tier for the session. + /// The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. public async Task GetCurrentAsync(CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); @@ -13910,19 +25470,21 @@ public async Task GetCurrentAsync(CancellationToken cancellationTo } /// Switches the session to a model and optional reasoning configuration. - /// Model identifier to switch to. - /// Reasoning effort level to use for the model. "none" disables reasoning. + /// Model selection id to switch to, as returned by `list`. A bare id (e.g. `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. + /// Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted, no effort override is applied. /// Reasoning summary mode to request for supported model clients. + /// Output verbosity level to request for supported models. /// Override individual model capabilities resolved by the runtime. - /// Explicit context tier for the selected model. `"default"` / `"long_context"` pin the tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier untouched. + /// Explicit context tier for the selected model. `"default"` / `"long_context"` apply the requested tier; omit this field to use normal model behavior with no explicit tier. + /// When true, defer this switch (enqueue it) if another model change is already queued, even when no turn is active — so it drains last (FIFO) and wins over the already-queued change. Intended for genuine user-initiated model selections; internal restore/reapply switches omit it and apply immediately when no turn is active. When no other model change is queued this has no effect (a switch still applies immediately unless a turn is active). /// The to monitor for cancellation requests. The default is . /// The model identifier active on the session after the switch. - public async Task SwitchToAsync(string modelId, string? reasoningEffort = null, ReasoningSummary? reasoningSummary = null, ModelCapabilitiesOverride? modelCapabilities = null, ModelSwitchToRequestContextTier? contextTier = null, CancellationToken cancellationToken = default) + public async Task SwitchToAsync(string modelId, string? reasoningEffort = null, ReasoningSummary? reasoningSummary = null, Verbosity? verbosity = null, ModelCapabilitiesOverride? modelCapabilities = null, ContextTier? contextTier = null, bool? deferIfModelChangeQueued = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(modelId); _session.ThrowIfDisposed(); - var request = new ModelSwitchToRequest { SessionId = _session.SessionId, ModelId = modelId, ReasoningEffort = reasoningEffort, ReasoningSummary = reasoningSummary, ModelCapabilities = modelCapabilities, ContextTier = contextTier }; + var request = new ModelSwitchToRequest { SessionId = _session.SessionId, ModelId = modelId, ReasoningEffort = reasoningEffort, ReasoningSummary = reasoningSummary, Verbosity = verbosity, ModelCapabilities = modelCapabilities, ContextTier = contextTier, DeferIfModelChangeQueued = deferIfModelChangeQueued }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.model.switchTo", [request], cancellationToken); } @@ -13943,11 +25505,11 @@ public async Task SetReasoningEffortAsync(string /// Optional listing options. /// The to monitor for cancellation requests. The default is . /// The list of models available to this session. - public async Task ListAsync(ModelListRequest? request = null, CancellationToken cancellationToken = default) + public async Task ListAsync(SessionModelListRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var rpcRequest = new ModelListRequestWithSession { SessionId = _session.SessionId, SkipCache = request?.SkipCache }; + var rpcRequest = new SessionModelListRequestWithSession { SessionId = _session.SessionId, SkipCache = request?.SkipCache }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.model.list", [rpcRequest], cancellationToken); } } @@ -14077,6 +25639,28 @@ public async Task DeleteAsync(CancellationToken cancellationToken = default) var request = new SessionPlanDeleteRequest { SessionId = _session.SessionId }; await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.plan.delete", [request], cancellationToken); } + + /// Reads todo rows from the session SQL database for plan rendering. + /// The to monitor for cancellation requests. The default is . + /// Todo rows read from the session SQL database. Empty when no session database is available. + public async Task ReadSqlTodosAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionPlanReadSqlTodosRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.plan.readSqlTodos", [request], cancellationToken); + } + + /// Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren't available. Clients should call this on session start and after every `session.todos_changed` event to refresh structured-UI rendering. + /// The to monitor for cancellation requests. The default is . + /// Todo rows + dependency edges read from the session SQL database. + public async Task ReadSqlTodosWithDependenciesAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionPlanReadSqlTodosWithDependenciesRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.plan.readSqlTodosWithDependencies", [request], cancellationToken); + } } /// Provides session-scoped Workspaces APIs. @@ -14101,6 +25685,31 @@ public async Task GetWorkspaceAsync(CancellationTo return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.getWorkspace", [request], cancellationToken); } + /// Updates workspace metadata for a local session and returns the refreshed workspace. + /// Opaque workspace context supplied by the session host. + /// Optional workspace display name override. + /// The to monitor for cancellation requests. The default is . + /// Current workspace metadata for the session, including its absolute filesystem path when available. + public async Task UpdateMetadataAsync(object? context = null, string? name = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new WorkspacesUpdateMetadataRequest { SessionId = _session.SessionId, Context = CopilotClient.ToJsonElementForWire(context), Name = name }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.updateMetadata", [request], cancellationToken); + } + + /// Ensures a local session workspace exists and returns it. + /// Opaque workspace context supplied by the session host. + /// The to monitor for cancellation requests. The default is . + /// Current workspace metadata for the session, including its absolute filesystem path when available. + public async Task EnsureAsync(object? context = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new WorkspacesEnsureRequest { SessionId = _session.SessionId, Context = CopilotClient.ToJsonElementForWire(context) }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.ensure", [request], cancellationToken); + } + /// Lists files stored in the session workspace files directory. /// The to monitor for cancellation requests. The default is . /// Relative paths of files stored in the session workspace files directory. @@ -14162,6 +25771,79 @@ public async Task ReadCheckpointAsync(long numbe return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.readCheckpoint", [request], cancellationToken); } + /// Adds a compaction summary checkpoint to the local session workspace. + /// Summary title shown in checkpoint listings. + /// Markdown summary content to persist. + /// The to monitor for cancellation requests. The default is . + /// Persisted summary metadata and refreshed workspace metadata. + public async Task AddSummaryAsync(string title, string content, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(title); + ArgumentNullException.ThrowIfNull(content); + _session.ThrowIfDisposed(); + + var request = new WorkspacesAddSummaryRequest { SessionId = _session.SessionId, Title = title, Content = content }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.addSummary", [request], cancellationToken); + } + + /// Truncates local workspace compaction summaries after a rollback. + /// Number of newest summaries to keep. + /// The to monitor for cancellation requests. The default is . + /// Current workspace metadata for the session, including its absolute filesystem path when available. + public async Task TruncateSummariesAsync(long keepCount, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new WorkspacesTruncateSummariesRequest { SessionId = _session.SessionId, KeepCount = keepCount }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.truncateSummaries", [request], cancellationToken); + } + + /// Reads the autopilot objective state file from the local session workspace. + /// The to monitor for cancellation requests. The default is . + /// Autopilot objective file content, or null when missing. + public async Task ReadAutopilotObjectiveAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionWorkspacesReadAutopilotObjectiveRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.readAutopilotObjective", [request], cancellationToken); + } + + /// Writes the autopilot objective state file in the local session workspace. + /// Autopilot objective file content. + /// The to monitor for cancellation requests. The default is . + /// Result of writing the autopilot objective file. + public async Task WriteAutopilotObjectiveAsync(string content, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(content); + _session.ThrowIfDisposed(); + + var request = new WorkspacesWriteAutopilotObjectiveRequest { SessionId = _session.SessionId, Content = content }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.writeAutopilotObjective", [request], cancellationToken); + } + + /// Deletes the autopilot objective state file from the local session workspace. + /// The to monitor for cancellation requests. The default is . + /// Result of deleting the autopilot objective file. + public async Task DeleteAutopilotObjectiveAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionWorkspacesDeleteAutopilotObjectiveRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.deleteAutopilotObjective", [request], cancellationToken); + } + + /// Checks whether the local session workspace has an autopilot objective state file. + /// The to monitor for cancellation requests. The default is . + /// Whether the autopilot objective file exists. + public async Task AutopilotObjectiveExistsAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionWorkspacesAutopilotObjectiveExistsRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.autopilotObjectiveExists", [request], cancellationToken); + } + /// Saves pasted content as a UTF-8 file in the session workspace. /// Pasted content to save as a UTF-8 file. /// The to monitor for cancellation requests. The default is . @@ -14175,19 +25857,57 @@ public async Task SaveLargePasteAsync(string con return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.saveLargePaste", [request], cancellationToken); } - /// Computes a diff for the session workspace. + /// Computes a diff for the session workspace. Never rejects for a busy session: a `session`-mode diff that cannot read the session's file-change captures falls back to an unstaged git diff with `isFallback: true` and reports why in `unavailableReason`. /// Diff mode requested by the client. + /// When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. /// The to monitor for cancellation requests. The default is . /// Workspace diff result for the requested mode. - public async Task DiffAsync(WorkspaceDiffMode mode, CancellationToken cancellationToken = default) + public async Task DiffAsync(WorkspaceDiffMode mode, bool? ignoreWhitespace = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new WorkspacesDiffRequest { SessionId = _session.SessionId, Mode = mode }; + var request = new WorkspacesDiffRequest { SessionId = _session.SessionId, Mode = mode, IgnoreWhitespace = ignoreWhitespace }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.workspaces.diff", [request], cancellationToken); } } +/// Provides session-scoped Completions APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class CompletionsApi +{ + private readonly CopilotSession _session; + + internal CompletionsApi(CopilotSession session) + { + _session = session; + } + + /// Gets the characters that should trigger host-driven completions for the session. Empty disables host-driven completions (e.g. local sessions, or a relay host that does not advertise them). + /// The to monitor for cancellation requests. The default is . + /// Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). + public async Task GetTriggerCharactersAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionCompletionsGetTriggerCharactersRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.completions.getTriggerCharacters", [request], cancellationToken); + } + + /// Requests host-driven completion items for the current composer input. Returns an empty list when the host has no items or does not support completions. + /// The full composed composer input. + /// Cursor offset within `text`, in UTF-16 code units. + /// The to monitor for cancellation requests. The default is . + /// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + public async Task RequestAsync(string text, long offset, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(text); + _session.ThrowIfDisposed(); + + var request = new CompletionsRequestRequest { SessionId = _session.SessionId, Text = text, Offset = offset }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.completions.request", [request], cancellationToken); + } +} + /// Provides session-scoped Instructions APIs. [Experimental(Diagnostics.Experimental)] public sealed class InstructionsApi @@ -14246,15 +25966,30 @@ internal AgentApi(CopilotSession session) _session = session; } - /// Lists custom agents available to the session. + /// Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents. + /// Controls whether built-in agents and authored prompt text are included. + /// The to monitor for cancellation requests. The default is . + /// Agents available to the session. + public async Task ListAsync(SessionAgentListRequest? request = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var rpcRequest = new SessionAgentListRequestWithSession { SessionId = _session.SessionId, IncludeBuiltInAgents = request?.IncludeBuiltInAgents, IncludePrompt = request?.IncludePrompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.agent.list", [rpcRequest], cancellationToken); + } + + /// Sets an in-memory authored prompt override for an available agent. For built-in agents, this replaces only the static base prompt while preserving runtime-owned dynamic prompt composition and behavior. The special `general-purpose` agent is not overrideable. Overrides are not persisted; resumed and forked sessions start without them, so the host must re-apply them. + /// Stable effective agent id. Plugin namespace separators are normalized. + /// Replacement authored prompt. Empty text is valid. /// The to monitor for cancellation requests. The default is . - /// Custom agents available to the session. - public async Task ListAsync(CancellationToken cancellationToken = default) + public async Task SetPromptAsync(string id, string prompt, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(id); + ArgumentNullException.ThrowIfNull(prompt); _session.ThrowIfDisposed(); - var request = new SessionAgentListRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.agent.list", [request], cancellationToken); + var request = new AgentSetPromptRequest { SessionId = _session.SessionId, Id = id, Prompt = prompt }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.agent.setPrompt", [request], cancellationToken); } /// Gets the currently selected custom agent for the session. @@ -14547,9 +26282,9 @@ internal McpApi(CopilotSession session) _session = session; } - /// Lists MCP servers configured for the session and their connection status. + /// Lists MCP servers configured for the session, their connection status, and host-level state. The host-level state (disabled/filtered servers, failed/needs-auth/pending connections, mcp3p policy, full config) is empty/zero when no MCP host has been initialized for the session. /// The to monitor for cancellation requests. The default is . - /// MCP servers configured for the session, with their connection status. + /// MCP servers configured for the session, with their connection status and host-level state. public async Task ListAsync(CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); @@ -14558,6 +26293,19 @@ public async Task ListAsync(CancellationToken cancellationToken = return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.list", [request], cancellationToken); } + /// Lists the tools exposed by a connected MCP server on this session's host. This performs a live `tools/list` request. Tool UI metadata is returned independently of whether MCP Apps rendering is enabled for the session. + /// Name of the connected MCP server whose tools to list. + /// The to monitor for cancellation requests. The default is . + /// Tools exposed by the connected MCP server. Throws when the server is not connected. + public async Task ListToolsAsync(string serverName, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpListToolsRequest { SessionId = _session.SessionId, ServerName = serverName }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.listTools", [request], cancellationToken); + } + /// Enables an MCP server for the session. /// Name of the MCP server to enable. /// The to monitor for cancellation requests. The default is . @@ -14592,6 +26340,17 @@ public async Task ReloadAsync(CancellationToken cancellationToken = default) await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.reload", [request], cancellationToken); } + /// Reloads MCP server connections for the session with an explicit host-provided configuration. + /// The to monitor for cancellation requests. The default is . + /// MCP server startup filtering result. + internal async Task ReloadWithConfigAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new McpReloadWithConfigRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.reloadWithConfig", [request], cancellationToken); + } + /// Runs an MCP sampling inference on behalf of an MCP server. /// Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. /// Name of the MCP server that initiated the sampling request. @@ -14614,37 +26373,123 @@ public async Task ExecuteSamplingAsync(string reques /// Cancels an in-flight MCP sampling execution by request ID. /// The requestId previously passed to executeSampling that should be cancelled. /// The to monitor for cancellation requests. The default is . - /// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. - public async Task CancelSamplingExecutionAsync(string requestId, CancellationToken cancellationToken = default) + /// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + public async Task CancelSamplingExecutionAsync(string requestId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + _session.ThrowIfDisposed(); + + var request = new McpCancelSamplingExecutionParams { SessionId = _session.SessionId, RequestId = requestId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.cancelSamplingExecution", [request], cancellationToken); + } + + /// Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect). + /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". + /// The to monitor for cancellation requests. The default is . + /// Env-value mode recorded on the session after the update. + public async Task SetEnvValueModeAsync(McpSetEnvValueModeDetails mode, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new McpSetEnvValueModeParams { SessionId = _session.SessionId, Mode = mode }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.setEnvValueMode", [request], cancellationToken); + } + + /// Removes the auto-managed `github` MCP server when present. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + public async Task RemoveGitHubAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionMcpRemoveGitHubRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.removeGitHub", [request], cancellationToken); + } + + /// Configures the built-in GitHub MCP server for the session's current auth context. + /// The to monitor for cancellation requests. The default is . + /// Result of configuring GitHub MCP. + internal async Task ConfigureGitHubAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new McpConfigureGitHubRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.configureGitHub", [request], cancellationToken); + } + + /// Starts an individual MCP server on the live session. Omit `config` for a config-free start-by-name of an already-configured server (reuses the server's already-registered configuration); supply `config` to start from a caller-supplied configuration. Session-scoped and ephemeral: the server is added to this session's running set only and is reaped when the session ends. Does NOT modify persistent user configuration (`mcp.config.*`), so it does not affect future sessions. The server surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / `session.mcp_server_status_changed` events like any other server. + /// Name of the MCP server to start. + /// MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server with its already-registered configuration (config-free start-by-name). + /// The to monitor for cancellation requests. The default is . + public async Task StartServerAsync(string serverName, object? config = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpStartServerRequest { SessionId = _session.SessionId, ServerName = serverName, Config = CopilotClient.ToJsonElementForWire(config) }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.startServer", [request], cancellationToken); + } + + /// Restarts an individual MCP server on the live session (stops then starts). Omit `config` for a config-free restart-by-name of an already-configured server; supply `config` to restart with a replacement configuration. Session-scoped and ephemeral: does NOT modify persistent user configuration (`mcp.config.*`). + /// Name of the MCP server to restart. + /// Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart the server with its already-registered configuration (config-free restart-by-name). + /// The to monitor for cancellation requests. The default is . + public async Task RestartServerAsync(string serverName, object? config = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpRestartServerRequest { SessionId = _session.SessionId, ServerName = serverName, Config = CopilotClient.ToJsonElementForWire(config) }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.restartServer", [request], cancellationToken); + } + + /// Stops an individual MCP server on the session's host. + /// Name of the MCP server to stop. + /// The to monitor for cancellation requests. The default is . + public async Task StopServerAsync(string serverName, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpStopServerRequest { SessionId = _session.SessionId, ServerName = serverName }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.stopServer", [request], cancellationToken); + } + + /// Registers a pre-connected external MCP client (e.g. IDE) on the session's host. The caller retains lifecycle ownership of the client and transport. Marked internal because the `client` and `transport` arguments are in-process MCP SDK instances that cannot be serialized across the JSON-RPC boundary; once the CLI moves on top of the SDK, external clients will be expressed as transport configs the runtime can construct itself. + /// Logical server name for the external client. + /// The to monitor for cancellation requests. The default is . + internal async Task RegisterExternalClientAsync(string serverName, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(serverName); _session.ThrowIfDisposed(); - var request = new McpCancelSamplingExecutionParams { SessionId = _session.SessionId, RequestId = requestId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.cancelSamplingExecution", [request], cancellationToken); + var request = new McpRegisterExternalClientRequest { SessionId = _session.SessionId, ServerName = serverName }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.registerExternalClient", [request], cancellationToken); } - /// Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect). - /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". + /// Unregisters a previously registered external MCP client by server name. Marked internal as the paired companion of `registerExternalClient`: only in-process callers that registered a client this way can meaningfully unregister it. Disappears alongside `registerExternalClient`: once external clients are described to the runtime as config rather than handed in as instances, lifecycle (including deregistration) is owned entirely by the runtime. + /// Server name of the external client to unregister. /// The to monitor for cancellation requests. The default is . - /// Env-value mode recorded on the session after the update. - public async Task SetEnvValueModeAsync(McpSetEnvValueModeDetails mode, CancellationToken cancellationToken = default) + internal async Task UnregisterExternalClientAsync(string serverName, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(serverName); _session.ThrowIfDisposed(); - var request = new McpSetEnvValueModeParams { SessionId = _session.SessionId, Mode = mode }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.setEnvValueMode", [request], cancellationToken); + var request = new McpUnregisterExternalClientRequest { SessionId = _session.SessionId, ServerName = serverName }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.unregisterExternalClient", [request], cancellationToken); } - /// Removes the auto-managed `github` MCP server when present. + /// Checks whether a named MCP server is currently running on the session's host. + /// Name of the MCP server to check. /// The to monitor for cancellation requests. The default is . - /// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). - public async Task RemoveGitHubAsync(CancellationToken cancellationToken = default) + /// Whether the named MCP server is running. + public async Task IsServerRunningAsync(string serverName, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(serverName); _session.ThrowIfDisposed(); - var request = new SessionMcpRemoveGitHubRequest { SessionId = _session.SessionId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.removeGitHub", [request], cancellationToken); + var request = new McpIsServerRunningRequest { SessionId = _session.SessionId, ServerName = serverName }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.isServerRunning", [request], cancellationToken); } /// Oauth APIs. @@ -14653,11 +26498,23 @@ public async Task RemoveGitHubAsync(CancellationToken can Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + /// Headers APIs. + public McpHeadersApi Headers => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; + /// Apps APIs. public McpAppsApi Apps => field ?? Interlocked.CompareExchange(ref field, new(_session), null) ?? field; + + /// Resources APIs. + public McpResourcesApi Resources => + field ?? + Interlocked.CompareExchange(ref field, new(_session), null) ?? + field; } /// Provides session-scoped McpOauth APIs. @@ -14671,21 +26528,92 @@ internal McpOauthApi(CopilotSession session) _session = session; } + /// Resolves a pending MCP OAuth request with a host-provided token or cancellation. The pending request is emitted as mcp.oauth_required with the data necessary to authorize the request. + /// OAuth request identifier from the mcp.oauth_required event. + /// Host response to the pending OAuth request. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the pending MCP OAuth response was accepted. + public async Task HandlePendingRequestAsync(string requestId, McpOauthPendingRequestResponse result, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(result); + _session.ThrowIfDisposed(); + + var request = new McpOauthHandlePendingRequest { SessionId = _session.SessionId, RequestId = requestId, Result = result }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.oauth.handlePendingRequest", [request], cancellationToken); + } + + /// Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed. + /// Name of the MCP server whose OAuth credentials were updated. Omit only when the host cannot identify the server. + /// Whether the target session must mint a session-scoped access token instead of reusing a shared access token persisted by another session. + /// The to monitor for cancellation requests. The default is . + public async Task AuthenticationStateChangedAsync(string? serverName = null, bool? refreshSessionToken = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new McpOauthAuthenticationStateChangedRequest { SessionId = _session.SessionId, ServerName = serverName, RefreshSessionToken = refreshSessionToken }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.oauth.authenticationStateChanged", [request], cancellationToken); + } + /// Starts OAuth authentication for a remote MCP server. /// Name of the remote MCP server to authenticate. /// 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. /// 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. /// 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. + /// Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. + /// Optional OAuth client secret override for this login. The runtime treats this as an ephemeral host-owned secret, uses it for this authentication attempt and does not persist it. + /// Optional override indicating whether the static OAuth client is public. When false, the runtime treats it as confidential and uses the per-login clientSecret if provided, otherwise retrieving the client secret from the MCP OAuth secret store. + /// Optional OAuth grant type override for this login. Defaults to the server configuration, or authorization_code when no grant type is specified. /// The to monitor for cancellation requests. The default is . /// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. - public async Task LoginAsync(string serverName, bool? forceReauth = null, string? clientName = null, string? callbackSuccessMessage = null, CancellationToken cancellationToken = default) + public async Task LoginAsync(string serverName, bool? forceReauth = null, string? clientName = null, string? callbackSuccessMessage = null, string? clientId = null, string? clientSecret = null, bool? publicClient = null, McpOauthLoginGrantType? grantType = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(serverName); _session.ThrowIfDisposed(); - var request = new McpOauthLoginRequest { SessionId = _session.SessionId, ServerName = serverName, ForceReauth = forceReauth, ClientName = clientName, CallbackSuccessMessage = callbackSuccessMessage }; + var request = new McpOauthLoginRequest { SessionId = _session.SessionId, ServerName = serverName, ForceReauth = forceReauth, ClientName = clientName, CallbackSuccessMessage = callbackSuccessMessage, ClientId = clientId, ClientSecret = clientSecret, PublicClient = publicClient, GrantType = grantType }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.oauth.login", [request], cancellationToken); } + + /// Responds to a pending MCP OAuth authorization request by its request id. + /// OAuth request identifier from the mcp.oauth_required event. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the pending MCP OAuth response was accepted. + public async Task RespondAsync(string requestId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + _session.ThrowIfDisposed(); + + var request = new McpOauthRespondRequest { SessionId = _session.SessionId, RequestId = requestId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.oauth.respond", [request], cancellationToken); + } +} + +/// Provides session-scoped McpHeaders APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class McpHeadersApi +{ + private readonly CopilotSession _session; + + internal McpHeadersApi(CopilotSession session) + { + _session = session; + } + + /// Responds to a pending MCP dynamic headers refresh request. Hosts that subscribe to `mcp.headers_refresh_required` use this to provide short-lived per-server headers or to indicate that no dynamic headers are available for this refresh. + /// Headers refresh request identifier from mcp.headers_refresh_required. + /// Host response: supply dynamic headers or decline this refresh. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the pending MCP headers refresh response was accepted. + public async Task HandlePendingHeadersRefreshRequestAsync(string requestId, McpHeadersHandlePendingHeadersRefreshRequest result, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(result); + _session.ThrowIfDisposed(); + + var request = new McpHeadersHandlePendingHeadersRefreshRequestRequest { SessionId = _session.SessionId, RequestId = requestId, Result = result }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.headers.handlePendingHeadersRefreshRequest", [request], cancellationToken); + } } /// Provides session-scoped McpApps APIs. @@ -14784,6 +26712,61 @@ public async Task DiagnoseAsync(string serverName, Cancel } } +/// Provides session-scoped McpResources APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class McpResourcesApi +{ + private readonly CopilotSession _session; + + internal McpResourcesApi(CopilotSession session) + { + _session = session; + } + + /// Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`). + /// Name of the MCP server hosting the resource. + /// Resource URI. + /// The to monitor for cancellation requests. The default is . + /// Resource contents returned by the MCP server. + public async Task ReadAsync(string serverName, string uri, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + ArgumentNullException.ThrowIfNull(uri); + _session.ThrowIfDisposed(); + + var request = new McpResourcesReadRequest { SessionId = _session.SessionId, ServerName = serverName, Uri = uri }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.resources.read", [request], cancellationToken); + } + + /// Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`. + /// Name of the MCP server whose resources to enumerate. + /// Opaque MCP pagination cursor from a prior `nextCursor` value. + /// The to monitor for cancellation requests. The default is . + /// One page of resources advertised by the named MCP server. + public async Task ListAsync(string serverName, string? cursor = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpResourcesListRequest { SessionId = _session.SessionId, ServerName = serverName, Cursor = cursor }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.resources.list", [request], cancellationToken); + } + + /// Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`. + /// Name of the MCP server whose resource templates to enumerate. + /// Opaque MCP pagination cursor from a prior `nextCursor` value. + /// The to monitor for cancellation requests. The default is . + /// One page of resource templates advertised by the named MCP server. + public async Task ListTemplatesAsync(string serverName, string? cursor = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serverName); + _session.ThrowIfDisposed(); + + var request = new McpResourcesListTemplatesRequest { SessionId = _session.SessionId, ServerName = serverName, Cursor = cursor }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.mcp.resources.listTemplates", [request], cancellationToken); + } +} + /// Provides session-scoped Plugins APIs. [Experimental(Diagnostics.Experimental)] public sealed class PluginsApi @@ -14805,6 +26788,54 @@ public async Task ListAsync(CancellationToken cancellationToken = de var request = new SessionPluginsListRequest { SessionId = _session.SessionId }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.plugins.list", [request], cancellationToken); } + + /// Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately. + /// Optional flags controlling which side effects the reload performs. + /// The to monitor for cancellation requests. The default is . + public async Task ReloadAsync(SessionPluginsReloadRequest? request = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var rpcRequest = new SessionPluginsReloadRequestWithSession { SessionId = _session.SessionId, ReloadMcp = request?.ReloadMcp, ReloadCustomAgents = request?.ReloadCustomAgents, ReloadHooks = request?.ReloadHooks, ReloadExtensions = request?.ReloadExtensions, DeferRepoHooks = request?.DeferRepoHooks }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.plugins.reload", [rpcRequest], cancellationToken); + } +} + +/// Provides session-scoped Provider APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderApi +{ + private readonly CopilotSession _session; + + internal ProviderApi(CopilotSession session) + { + _session = session; + } + + /// Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses. + /// Optional model identifier to scope the endpoint snapshot to. + /// The to monitor for cancellation requests. The default is . + /// A snapshot of the provider endpoint the session is currently configured to talk to. + public async Task GetEndpointAsync(SessionProviderGetEndpointRequest? request = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var rpcRequest = new SessionProviderGetEndpointRequestWithSession { SessionId = _session.SessionId, ModelId = request?.ModelId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.provider.getEndpoint", [rpcRequest], cancellationToken); + } + + /// Adds BYOK providers and/or models to the session's registry at runtime, extending the additive registry built from the session's `providers`/`models` options. Both fields are optional, so a call may add providers only, models only, or both. Within a single call providers are registered before models, so a model may reference a provider added in the same call; across calls a model may reference any provider already registered (from session creation or a prior add). A model whose referenced provider is not registered by the end of the call is rejected. Newly added models become selectable via `model.list` / `model.switchTo` and are inherited by sub-agents spawned afterwards. + /// Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'. + /// BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry. + /// The to monitor for cancellation requests. The default is . + /// The selectable model entries synthesized for the models added by this call. + public async Task AddAsync(IList? providers = null, IList? models = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new ProviderAddRequest { SessionId = _session.SessionId, Providers = providers, Models = models }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.provider.add", [request], cancellationToken); + } } /// Provides session-scoped Options APIs. @@ -14820,28 +26851,38 @@ internal OptionsApi(CopilotSession session) /// Patches the genuinely-mutable subset of session options. /// The model ID to use for assistant turns. - /// Reasoning effort for the selected model (model-defined enum). + /// Per-property model capability overrides for the selected model. + /// Reasoning effort for the selected model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. + /// Reasoning summary mode for supported model clients. + /// Output verbosity level for supported models. /// Identifier of the client driving the session. /// Identifier sent to LSP-style integrations. /// Stable integration identifier used for analytics and rate-limit attribution. /// Map of feature-flag IDs to their boolean enabled state. /// Whether experimental capabilities are enabled. - /// Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the runtime. + /// Custom model-provider configuration (BYOK). + /// Options scoped to the built-in CAPI (Copilot API) provider. /// Absolute working-directory path for shell tools. /// Allowlist of tool names available to this session. /// Denylist of tool names for this session. + /// Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. + /// Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. /// Whether shell-script safety heuristics are enabled. - /// Shell init profile (`None` or `NonInteractive`). - /// Per-shell process flags (e.g., `pwsh` arguments). - /// Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. + /// Per-session settings for built-in shell tools. + /// Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). + /// PowerShell process flags applied to built-in and user-requested shell commands. + /// Resolved sandbox configuration. /// Whether interactive shell sessions are logged. /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). + /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. /// Additional directories to search for skills. /// Skill IDs that should be excluded from this session. - /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. + /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`. + /// Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB. /// Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. /// Whether to default custom agents to local-only execution. + /// When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement. /// Whether to skip loading custom instruction sources. /// Instruction source IDs to exclude from the system prompt. /// Whether to include the `Co-authored-by` trailer in commit messages. @@ -14854,21 +26895,25 @@ internal OptionsApi(CopilotSession session) /// Whether to surface reasoning-summary events from the model. /// Runtime context discriminator (e.g., `cli`, `actions`). /// Override directory for the session-events log. When unset, the runtime's default events log directory is used. - /// Additional content-exclusion policies to merge into the session's policy set. Opaque shape; see `ContentExclusionApiResponse` in the runtime. + /// Whether subagent callback events should be forwarded into the session event log sink. + /// Additional content-exclusion policies to merge into the session's policy set. /// Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). + /// Replaces the session's capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the field to leave the existing capability set unchanged. /// Whether to skip embedding retrieval pipeline initialization and execution. /// Organization-level custom instructions to inject into the system prompt. /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). /// Whether to enable cross-session store writes and reads. /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. + /// Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. + /// Optional session limits. Pass null to clear the session limits. /// The to monitor for cancellation requests. The default is . /// Indicates whether the session options patch was applied successfully. - public async Task UpdateAsync(string? model = null, string? reasoningEffort = null, string? clientName = null, string? lspClientName = null, string? integrationId = null, IDictionary? featureFlags = null, bool? isExperimentalMode = null, object? provider = null, string? workingDirectory = null, IList? availableTools = null, IList? excludedTools = null, OptionsUpdateToolFilterPrecedence? toolFilterPrecedence = null, bool? enableScriptSafety = null, string? shellInitProfile = null, IList? shellProcessFlags = null, object? sandboxConfig = null, bool? logInteractiveShells = null, OptionsUpdateEnvValueMode? envValueMode = null, IList? skillDirectories = null, IList? disabledSkills = null, bool? enableOnDemandInstructionDiscovery = null, IList? installedPlugins = null, bool? customAgentsLocalOnly = null, bool? skipCustomInstructions = null, IList? disabledInstructionSources = null, bool? coauthorEnabled = null, string? trajectoryFile = null, bool? enableStreaming = null, string? copilotUrl = null, bool? askUserDisabled = null, bool? continueOnAutoMode = null, bool? runningInInteractiveMode = null, bool? enableReasoningSummaries = null, string? agentContext = null, string? eventsLogDirectory = null, IList? additionalContentExclusionPolicies = null, bool? manageScheduleEnabled = null, bool? skipEmbeddingRetrieval = null, string? organizationCustomInstructions = null, bool? enableFileHooks = null, bool? enableHostGitOperations = null, bool? enableSessionStore = null, bool? enableSkills = null, CancellationToken cancellationToken = default) + public async Task UpdateAsync(string? model = null, ModelCapabilitiesOverride? modelCapabilitiesOverrides = null, string? reasoningEffort = null, OptionsUpdateReasoningSummary? reasoningSummary = null, Verbosity? verbosity = null, string? clientName = null, string? lspClientName = null, string? integrationId = null, IDictionary? featureFlags = null, bool? isExperimentalMode = null, ProviderConfig? provider = null, CapiSessionOptions? capi = null, string? workingDirectory = null, IList? availableTools = null, IList? excludedTools = null, IList? includedBuiltinAgents = null, IList? excludedBuiltinAgents = null, OptionsUpdateToolFilterPrecedence? toolFilterPrecedence = null, bool? enableScriptSafety = null, ShellOptions? shell = null, string? shellInitProfile = null, IList? shellProcessFlags = null, SandboxConfig? sandboxConfig = null, bool? logInteractiveShells = null, OptionsUpdateEnvValueMode? envValueMode = null, bool? allowAllMcpServerInstructions = null, IList? skillDirectories = null, IList? disabledSkills = null, bool? enableOnDemandInstructionDiscovery = null, long? maxInlineBinaryBytes = null, IList? installedPlugins = null, bool? customAgentsLocalOnly = null, bool? suppressCustomAgentPrompt = null, bool? skipCustomInstructions = null, IList? disabledInstructionSources = null, bool? coauthorEnabled = null, string? trajectoryFile = null, bool? enableStreaming = null, string? copilotUrl = null, bool? askUserDisabled = null, bool? continueOnAutoMode = null, bool? runningInInteractiveMode = null, bool? enableReasoningSummaries = null, string? agentContext = null, string? eventsLogDirectory = null, bool? eventsLogIncludesSubagents = null, IList? additionalContentExclusionPolicies = null, bool? manageScheduleEnabled = null, IList? sessionCapabilities = null, bool? skipEmbeddingRetrieval = null, string? organizationCustomInstructions = null, bool? enableFileHooks = null, bool? enableHostGitOperations = null, bool? enableSessionStore = null, bool? enableSkills = null, OptionsUpdateContextTier? contextTier = null, SessionLimitsConfig? sessionLimits = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new SessionUpdateOptionsParams { SessionId = _session.SessionId, Model = model, ReasoningEffort = reasoningEffort, ClientName = clientName, LspClientName = lspClientName, IntegrationId = integrationId, FeatureFlags = featureFlags, IsExperimentalMode = isExperimentalMode, Provider = CopilotClient.ToJsonElementForWire(provider), WorkingDirectory = workingDirectory, AvailableTools = availableTools, ExcludedTools = excludedTools, ToolFilterPrecedence = toolFilterPrecedence, EnableScriptSafety = enableScriptSafety, ShellInitProfile = shellInitProfile, ShellProcessFlags = shellProcessFlags, SandboxConfig = CopilotClient.ToJsonElementForWire(sandboxConfig), LogInteractiveShells = logInteractiveShells, EnvValueMode = envValueMode, SkillDirectories = skillDirectories, DisabledSkills = disabledSkills, EnableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery, InstalledPlugins = installedPlugins, CustomAgentsLocalOnly = customAgentsLocalOnly, SkipCustomInstructions = skipCustomInstructions, DisabledInstructionSources = disabledInstructionSources, CoauthorEnabled = coauthorEnabled, TrajectoryFile = trajectoryFile, EnableStreaming = enableStreaming, CopilotUrl = copilotUrl, AskUserDisabled = askUserDisabled, ContinueOnAutoMode = continueOnAutoMode, RunningInInteractiveMode = runningInInteractiveMode, EnableReasoningSummaries = enableReasoningSummaries, AgentContext = agentContext, EventsLogDirectory = eventsLogDirectory, AdditionalContentExclusionPolicies = additionalContentExclusionPolicies?.Select(static v => CopilotClient.ToJsonElementForWire(v)!.Value).ToList(), ManageScheduleEnabled = manageScheduleEnabled, SkipEmbeddingRetrieval = skipEmbeddingRetrieval, OrganizationCustomInstructions = organizationCustomInstructions, EnableFileHooks = enableFileHooks, EnableHostGitOperations = enableHostGitOperations, EnableSessionStore = enableSessionStore, EnableSkills = enableSkills }; + var request = new SessionUpdateOptionsParams { SessionId = _session.SessionId, Model = model, ModelCapabilitiesOverrides = modelCapabilitiesOverrides, ReasoningEffort = reasoningEffort, ReasoningSummary = reasoningSummary, Verbosity = verbosity, ClientName = clientName, LspClientName = lspClientName, IntegrationId = integrationId, FeatureFlags = featureFlags, IsExperimentalMode = isExperimentalMode, Provider = provider, Capi = capi, WorkingDirectory = workingDirectory, AvailableTools = availableTools, ExcludedTools = excludedTools, IncludedBuiltinAgents = includedBuiltinAgents, ExcludedBuiltinAgents = excludedBuiltinAgents, ToolFilterPrecedence = toolFilterPrecedence, EnableScriptSafety = enableScriptSafety, Shell = shell, ShellInitProfile = shellInitProfile, ShellProcessFlags = shellProcessFlags, SandboxConfig = sandboxConfig, LogInteractiveShells = logInteractiveShells, EnvValueMode = envValueMode, AllowAllMcpServerInstructions = allowAllMcpServerInstructions, SkillDirectories = skillDirectories, DisabledSkills = disabledSkills, EnableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery, MaxInlineBinaryBytes = maxInlineBinaryBytes, InstalledPlugins = installedPlugins, CustomAgentsLocalOnly = customAgentsLocalOnly, SuppressCustomAgentPrompt = suppressCustomAgentPrompt, SkipCustomInstructions = skipCustomInstructions, DisabledInstructionSources = disabledInstructionSources, CoauthorEnabled = coauthorEnabled, TrajectoryFile = trajectoryFile, EnableStreaming = enableStreaming, CopilotUrl = copilotUrl, AskUserDisabled = askUserDisabled, ContinueOnAutoMode = continueOnAutoMode, RunningInInteractiveMode = runningInInteractiveMode, EnableReasoningSummaries = enableReasoningSummaries, AgentContext = agentContext, EventsLogDirectory = eventsLogDirectory, EventsLogIncludesSubagents = eventsLogIncludesSubagents, AdditionalContentExclusionPolicies = additionalContentExclusionPolicies, ManageScheduleEnabled = manageScheduleEnabled, SessionCapabilities = sessionCapabilities, SkipEmbeddingRetrieval = skipEmbeddingRetrieval, OrganizationCustomInstructions = organizationCustomInstructions, EnableFileHooks = enableFileHooks, EnableHostGitOperations = enableHostGitOperations, EnableSessionStore = enableSessionStore, EnableSkills = enableSkills, ContextTier = contextTier, SessionLimits = sessionLimits }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.options.update", [request], cancellationToken); } } @@ -14953,6 +26998,19 @@ public async Task ReloadAsync(CancellationToken cancellationToken = default) var request = new SessionExtensionsReloadRequest { SessionId = _session.SessionId }; await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.extensions.reload", [request], cancellationToken); } + + /// Push attachments into the next user-message turn from an extension. The host should surface them as composer pills and forward them via the next session.send call. Callable only by extension-owned connections. + /// Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape. + /// Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment. + /// The to monitor for cancellation requests. The default is . + public async Task SendAttachmentsToMessageAsync(IList attachments, string? instanceId = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(attachments); + _session.ThrowIfDisposed(); + + var request = new SendAttachmentsToMessageParams { SessionId = _session.SessionId, Attachments = attachments, InstanceId = instanceId }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.extensions.sendAttachmentsToMessage", [request], cancellationToken); + } } /// Provides session-scoped Tools APIs. @@ -15002,6 +27060,18 @@ public async Task GetCurrentMetadataAsync(Cancell var request = new SessionToolsGetCurrentMetadataRequest { SessionId = _session.SessionId }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.getCurrentMetadata", [request], cancellationToken); } + + /// Updates the current session's live subagent settings after user settings change. The persisted user settings remain the source of truth for future sessions. + /// Subagent settings to apply, or null to clear the live session override. + /// The to monitor for cancellation requests. The default is . + /// Empty result after applying subagent settings. + public async Task UpdateSubagentSettingsAsync(UpdateSubagentSettingsRequestSubagents? subagents = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new UpdateSubagentSettingsRequest { SessionId = _session.SessionId, Subagents = subagents }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.tools.updateSubagentSettings", [request], cancellationToken); + } } /// Provides session-scoped Commands APIs. @@ -15019,11 +27089,11 @@ internal CommandsApi(CopilotSession session) /// Optional filters controlling which command sources to include in the listing. /// The to monitor for cancellation requests. The default is . /// Slash commands available in the session, after applying any include/exclude filters. - public async Task ListAsync(CommandsListRequest? request = null, CancellationToken cancellationToken = default) + public async Task ListAsync(SessionCommandsListRequest? request = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var rpcRequest = new CommandsListRequestWithSession { SessionId = _session.SessionId, IncludeBuiltins = request?.IncludeBuiltins, IncludeSkills = request?.IncludeSkills, IncludeClientCommands = request?.IncludeClientCommands }; + var rpcRequest = new SessionCommandsListRequestWithSession { SessionId = _session.SessionId, IncludeBuiltins = request?.IncludeBuiltins, IncludeSkills = request?.IncludeSkills, IncludeClientCommands = request?.IncludeClientCommands }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.commands.list", [rpcRequest], cancellationToken); } @@ -15031,7 +27101,7 @@ public async Task ListAsync(CommandsListRequest? request = null, Ca /// Command name. Leading slashes are stripped and the name is matched case-insensitively. /// Raw input after the command name. /// The to monitor for cancellation requests. The default is . - /// Result of invoking the slash command (text output, prompt to send to the agent, or completion). + /// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). public async Task InvokeAsync(string name, string? input = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(name); @@ -15110,6 +27180,17 @@ internal TelemetryApi(CopilotSession session) _session = session; } + /// Gets the telemetry engagement ID currently associated with the session, when available. + /// The to monitor for cancellation requests. The default is . + /// Telemetry engagement ID for the session, when available. + public async Task GetEngagementIdAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionTelemetryGetEngagementIdRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.telemetry.getEngagementId", [request], cancellationToken); + } + /// Sets feature override key/value pairs to attach to subsequent telemetry events for the session. /// Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. /// The to monitor for cancellation requests. The default is . @@ -15134,6 +27215,19 @@ internal UiApi(CopilotSession session) _session = session; } + /// Runs a transient no-tools model query against the current conversation context. + /// Question to answer from the current conversation context. + /// The to monitor for cancellation requests. The default is . + /// Transient answer generated from current conversation context. + public async Task EphemeralQueryAsync(string question, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(question); + _session.ThrowIfDisposed(); + + var request = new UIEphemeralQueryRequest { SessionId = _session.SessionId, Question = question }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.ui.ephemeralQuery", [request], cancellationToken); + } + /// Requests structured input from a UI-capable client. /// Message describing what information is needed from the user. /// JSON Schema describing the form fields to present to the user. @@ -15166,7 +27260,7 @@ public async Task HandlePendingElicitationAsync(string requ /// Resolves a pending `user_input.requested` event with the user's response. /// The unique request ID from the user_input.requested event. - /// Schema for the `UIUserInputResponse` type. + /// User response for a pending user-input request, with answer text and whether it was typed freeform. /// The to monitor for cancellation requests. The default is . /// Indicates whether the pending UI request was resolved by this call. public async Task HandlePendingUserInputAsync(string requestId, UIUserInputResponse response, CancellationToken cancellationToken = default) @@ -15207,9 +27301,24 @@ public async Task HandlePendingAutoModeSwitchAsync(string return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.ui.handlePendingAutoModeSwitch", [request], cancellationToken); } + /// Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action. + /// The unique request ID from the session_limits_exhausted.requested event. + /// The selected session-limit action. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether the pending UI request was resolved by this call. + public async Task HandlePendingSessionLimitsExhaustedAsync(string requestId, UISessionLimitsExhaustedResponse response, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(response); + _session.ThrowIfDisposed(); + + var request = new UIHandlePendingSessionLimitsExhaustedRequest { SessionId = _session.SessionId, RequestId = requestId, Response = response }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.ui.handlePendingSessionLimitsExhausted", [request], cancellationToken); + } + /// Resolves a pending `exit_plan_mode.requested` event with the user's response. /// The unique request ID from the exit_plan_mode.requested event. - /// Schema for the `UIExitPlanModeResponse` type. + /// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. /// The to monitor for cancellation requests. The default is . /// Indicates whether the pending UI request was resolved by this call. public async Task HandlePendingExitPlanModeAsync(string requestId, UIExitPlanModeResponse response, CancellationToken cancellationToken = default) @@ -15278,15 +27387,16 @@ public async Task ConfigureAsync(bool? approveAllToo /// Provides a decision for a pending tool permission request. /// Request ID of the pending permission request. /// The client's response to the pending permission prompt. + /// Optional informational context describing how and where this response was made. Omit it to preserve legacy behavior without attributing an origin. /// The to monitor for cancellation requests. The default is . /// Indicates whether the permission decision was applied; false when the request was already resolved. - public async Task HandlePendingPermissionRequestAsync(string requestId, PermissionDecision result, CancellationToken cancellationToken = default) + public async Task HandlePendingPermissionRequestAsync(string requestId, PermissionDecision result, PermissionDecisionContext? decisionContext = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(requestId); ArgumentNullException.ThrowIfNull(result); _session.ThrowIfDisposed(); - var request = new PermissionDecisionRequest { SessionId = _session.SessionId, RequestId = requestId, Result = result }; + var request = new PermissionDecisionRequest { SessionId = _session.SessionId, RequestId = requestId, Result = result, DecisionContext = decisionContext }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.handlePendingPermissionRequest", [request], cancellationToken); } @@ -15314,22 +27424,24 @@ public async Task SetApproveAllAsync(bool enable return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.setApproveAll", [request], cancellationToken); } - /// Enables or disables full allow-all permissions (tools, paths, and URLs) for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the unrestricted path and URL managers and emits `session.permissions_changed` on transition. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. - /// Whether to enable full allow-all permissions. + /// Sets the allow-all permission mode for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. The `on` mode swaps in unrestricted path and URL managers and emits `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths active while attaching LLM safety recommendations. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. + /// Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM auto-approval; `off` disables both. + /// Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`. + /// Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. /// The to monitor for cancellation requests. The default is . /// Indicates whether the operation succeeded and reports the post-mutation state. - public async Task SetAllowAllAsync(bool enabled, PermissionsSetAllowAllSource? source = null, CancellationToken cancellationToken = default) + public async Task SetAllowAllAsync(PermissionsAllowAllMode? mode = null, bool? enabled = null, string? model = null, PermissionsSetAllowAllSource? source = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new PermissionsSetAllowAllRequest { SessionId = _session.SessionId, Enabled = enabled, Source = source }; + var request = new PermissionsSetAllowAllRequest { SessionId = _session.SessionId, Mode = mode, Enabled = enabled, Model = model, Source = source }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.setAllowAll", [request], cancellationToken); } - /// Returns whether full allow-all permissions are currently active for the session. + /// Returns the current allow-all permission mode for the session. /// The to monitor for cancellation requests. The default is . - /// Current full allow-all permission state. + /// Current allow-all permission mode. public async Task GetAllowAllAsync(CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); @@ -15366,13 +27478,14 @@ public async Task SetRequiredAsync(bool required, } /// Clears session-scoped tool permission approvals. + /// Whether location-scoped approvals are cleared too. Defaults to `true`. /// The to monitor for cancellation requests. The default is . /// Indicates whether the operation succeeded. - public async Task ResetSessionApprovalsAsync(CancellationToken cancellationToken = default) + public async Task ResetSessionApprovalsAsync(bool? includeLocation = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new PermissionsResetSessionApprovalsRequest { SessionId = _session.SessionId }; + var request = new PermissionsResetSessionApprovalsRequest { SessionId = _session.SessionId, IncludeLocation = includeLocation }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.permissions.resetSessionApprovals", [request], cancellationToken); } @@ -15637,6 +27750,17 @@ public async Task IsProcessingAsync(CancellationToke return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.isProcessing", [request], cancellationToken); } + /// Returns a snapshot of activity flags for the session. + /// The to monitor for cancellation requests. The default is . + /// Current activity flags for the session. + public async Task ActivityAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionMetadataActivityRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.activity", [request], cancellationToken); + } + /// Returns the token breakdown for the session's current context window for a given model. /// Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. /// Maximum output tokens allowed by the target model. Pass 0 if unknown. @@ -15651,10 +27775,33 @@ public async Task ContextInfoAsync(long promptTokenLi return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.contextInfo", [request], cancellationToken); } - /// Records a working-directory/git context change and emits a `session.context_changed` event. + /// Returns the experimental per-source attribution breakdown of the session's current context window as a flat list of entries (skills, subagents, MCP servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via parentId), plus the successful compaction count. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. Returns null until the session has initialized its system prompt and tool metadata. + /// The to monitor for cancellation requests. The default is . + /// Per-source attribution breakdown for the session's current context window, or null if uninitialized. + public async Task GetContextAttributionAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionMetadataGetContextAttributionRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.getContextAttribution", [request], cancellationToken); + } + + /// Returns the largest individual messages currently in the session's context window, most-expensive first. Companion to `metadata.getContextAttribution`. Returns an empty list until the session has initialized. + /// Maximum number of messages to return, most-expensive first. Omit for the server default. + /// The to monitor for cancellation requests. The default is . + /// The heaviest individual messages in the session's context window, most-expensive first. + public async Task GetContextHeaviestMessagesAsync(long? limit = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new MetadataContextHeaviestMessagesRequest { SessionId = _session.SessionId, Limit = limit }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.getContextHeaviestMessages", [request], cancellationToken); + } + + /// Records a working-directory/git context change and emits a `session.context_changed` event. For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event): a local session's working directory is authoritative and is moved via `metadata.setWorkingDirectory` (or an SDK `session.resume` that supplies a `workingDirectory`), not by this method. /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. /// The to monitor for cancellation requests. The default is . - /// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). + /// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. public async Task RecordContextChangeAsync(SessionWorkingDirectoryContext context, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(context); @@ -15664,10 +27811,10 @@ public async Task RecordContextChangeAsync(Se return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.metadata.recordContextChange", [request], cancellationToken); } - /// Updates the session's recorded working directory. + /// Updates the session's working directory. For local sessions the target is validated first (an absolute path that exists on disk) and the permission primary directory is re-based; a rejected validation fails the call before any session state changes. /// Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. /// The to monitor for cancellation requests. The default is . - /// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. + /// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. public async Task SetWorkingDirectoryAsync(string workingDirectory, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(workingDirectory); @@ -15691,6 +27838,67 @@ public async Task RecomputeContextTokensAs } } +/// Provides session-scoped Settings APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class SettingsApi +{ + private readonly CopilotSession _session; + + internal SettingsApi(CopilotSession session) + { + _session = session; + } + + /// Returns a redacted snapshot of session runtime settings, with secrets and raw feature flags excluded. Internal: the runtime settings shape is a runtime-internal surface and is deliberately kept out of the public SDK, because consumers should not depend on the runtime's internal settings layout. It remains callable in-process and is expected to be reworked as the runtime internals are consolidated. + /// The to monitor for cancellation requests. The default is . + /// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. + internal async Task SnapshotAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionSettingsSnapshotRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.settings.snapshot", [request], cancellationToken); + } + + /// Evaluates a named Rust-owned settings predicate without exposing raw feature flags. Internal: the raw feature-flag names and composition are runtime-internal, so this predicate-evaluation helper is kept out of the public SDK surface and is callable in-process only. + /// Predicate name. The runtime owns the raw feature-flag names and composition logic. + /// Tool name for tool-scoped predicates such as trivial-change handling. + /// The to monitor for cancellation requests. The default is . + /// Result of evaluating a Rust-owned settings predicate. + internal async Task EvaluatePredicateAsync(SessionSettingsPredicateName name, string? toolName = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionSettingsEvaluatePredicateRequest { SessionId = _session.SessionId, Name = name, ToolName = toolName }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.settings.evaluatePredicate", [request], cancellationToken); + } +} + +/// Provides session-scoped ContentExclusion APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class ContentExclusionApi +{ + private readonly CopilotSession _session; + + internal ContentExclusionApi(CopilotSession session) + { + _session = session; + } + + /// Checks local file system absolute paths within the session working directory against its content-exclusion policy. Results preserve input order. Unsupported paths/filesystems and unavailable policy evaluation return available false, and callers must treat every requested path as excluded. + /// Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. + /// The to monitor for cancellation requests. The default is . + /// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. + public async Task CheckPathsAsync(IList paths, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(paths); + _session.ThrowIfDisposed(); + + var request = new ContentExclusionCheckPathsRequest { SessionId = _session.SessionId, Paths = paths }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.contentExclusion.checkPaths", [request], cancellationToken); + } +} + /// Provides session-scoped Shell APIs. [Experimental(Diagnostics.Experimental)] public sealed class ShellApi @@ -15702,7 +27910,7 @@ internal ShellApi(CopilotSession session) _session = session; } - /// Starts a shell command and streams output through session notifications. + /// Starts a shell command and streams output through session notifications. The command runs as the leader of its own process group (POSIX) or in a dedicated job object (Windows), so a forced termination — via "shell.kill", the request timeout, or session disposal — signals that whole group/job rather than only the direct child. Two gaps are worth planning for: a command that exits on its own does not trigger that teardown, and on POSIX a descendant that moves itself into a new session or process group (for example via "setsid") leaves the signalled group, so either can leave a background process running. /// Shell command to execute. /// Working directory (defaults to session working directory). /// Timeout in milliseconds (default: 30000). @@ -15717,7 +27925,7 @@ public async Task ExecAsync(string command, string? cwd = null, return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.shell.exec", [request], cancellationToken); } - /// Sends a signal to a shell process previously started via "shell.exec". + /// Sends a signal to a shell process previously started via "shell.exec". The signal targets the command's whole process group (POSIX) or job object (Windows), so descendants still in that group are signalled too, not just the direct child. On POSIX a descendant that moved itself into a new session or process group (for example via "setsid") is no longer in the signalled group and survives. /// Process identifier returned by shell.exec. /// Signal to send (default: SIGTERM). /// The to monitor for cancellation requests. The default is . @@ -15730,6 +27938,34 @@ public async Task KillAsync(string processId, ShellKillSignal? var request = new ShellKillRequest { SessionId = _session.SessionId, ProcessId = processId, Signal = signal }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.shell.kill", [request], cancellationToken); } + + /// Executes a user-requested shell command through the session runtime. + /// Caller-provided cancellation handle for this execution. + /// Shell command to execute. + /// The to monitor for cancellation requests. The default is . + /// Result of a user-requested shell command. + public async Task ExecuteUserRequestedAsync(string requestId, string command, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + ArgumentNullException.ThrowIfNull(command); + _session.ThrowIfDisposed(); + + var request = new ShellExecuteUserRequestedRequest { SessionId = _session.SessionId, RequestId = requestId, Command = command }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.shell.executeUserRequested", [request], cancellationToken); + } + + /// Cancels a user-requested shell command by request ID. + /// Request ID previously passed to executeUserRequested. + /// The to monitor for cancellation requests. The default is . + /// Cancellation result for a user-requested shell command. + public async Task CancelUserRequestedAsync(string requestId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(requestId); + _session.ThrowIfDisposed(); + + var request = new ShellCancelUserRequestedRequest { SessionId = _session.SessionId, RequestId = requestId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.shell.cancelUserRequested", [request], cancellationToken); + } } /// Provides session-scoped History APIs. @@ -15746,26 +27982,64 @@ internal HistoryApi(CopilotSession session) /// Compacts the session history to reduce context usage. /// Optional compaction parameters. /// The to monitor for cancellation requests. The default is . - /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. - public async Task CompactAsync(HistoryCompactRequest? request = null, CancellationToken cancellationToken = default) + /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + public async Task CompactAsync(SessionHistoryCompactRequest? request = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var rpcRequest = new SessionHistoryCompactRequestWithSession { SessionId = _session.SessionId, CustomInstructions = request?.CustomInstructions, Trigger = request?.Trigger, TokenLimit = request?.TokenLimit }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.compact", [rpcRequest], cancellationToken); + } + + /// Truncates persisted session history to a specific event. + /// Event ID to truncate to. This event and all events after it are removed from the session. + /// The to monitor for cancellation requests. The default is . + /// Number of events that were removed by the truncation. + public async Task TruncateAsync(string eventId, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(eventId); + _session.ThrowIfDisposed(); + + var request = new HistoryTruncateRequest { SessionId = _session.SessionId, EventId = eventId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.truncate", [request], cancellationToken); + } + + /// Lists the user turns that the session can rewind to. Never rejects for a busy session: rewind reads need the session's file-change captures to be settled, so a session that still holds active work answers with `unavailableReason: "session-busy"` and no points, which the caller can retry. + /// The to monitor for cancellation requests. The default is . + /// Rewind points and file-change-tracking availability for the session. + public async Task ListRewindPointsAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionHistoryListRewindPointsRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.listRewindPoints", [request], cancellationToken); + } + + /// Previews the files that a conversation-and-files rewind would restore. + /// ID of the user.message event that begins the discarded suffix. + /// The to monitor for cancellation requests. The default is . + /// Files and aggregate changes for a prospective rewind. + public async Task PreviewRewindAsync(string eventId, CancellationToken cancellationToken = default) { + ArgumentNullException.ThrowIfNull(eventId); _session.ThrowIfDisposed(); - var rpcRequest = new HistoryCompactRequestWithSession { SessionId = _session.SessionId, CustomInstructions = request?.CustomInstructions }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.compact", [rpcRequest], cancellationToken); + var request = new HistoryPreviewRewindRequest { SessionId = _session.SessionId, EventId = eventId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.previewRewind", [request], cancellationToken); } - /// Truncates persisted session history to a specific event. - /// Event ID to truncate to. This event and all events after it are removed from the session. + /// Rewinds the session conversation, optionally restoring files changed by the discarded turns. Not crash-atomic: file restore and conversation truncation are separate stores, applied in that order, so a process crash between them can leave the workspace rewound while the conversation still contains the discarded turns. There is no recovery journal; re-running the same rewind is the recovery path for a crash before truncation lands, since file restore is idempotent (already-restored files are reported as skipped) and truncation is re-derived from the still-retained boundary event. After truncation lands that boundary no longer exists, so the same request is rejected; the only stage that can still be outstanding is snapshot pruning, whose failure leaves orphan snapshots the capture store tolerates. The reverse inconsistency cannot occur, because truncation is never applied before file restore succeeds. + /// ID of the user.message event that begins the discarded suffix. + /// Whether to rewind only conversation history or also restore captured files. /// The to monitor for cancellation requests. The default is . - /// Number of events that were removed by the truncation. - public async Task TruncateAsync(string eventId, CancellationToken cancellationToken = default) + /// Structured outcome of a rewind request. + public async Task RewindAsync(string eventId, HistoryRewindMode mode, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(eventId); _session.ThrowIfDisposed(); - var request = new HistoryTruncateRequest { SessionId = _session.SessionId, EventId = eventId }; - return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.truncate", [request], cancellationToken); + var request = new HistoryRewindRequest { SessionId = _session.SessionId, EventId = eventId, Mode = mode }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.rewind", [request], cancellationToken); } /// Cancels any in-progress background compaction on a local session. @@ -15800,6 +28074,19 @@ public async Task SummarizeForHandoffAsync(Can var request = new SessionHistorySummarizeForHandoffRequest { SessionId = _session.SessionId }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.summarizeForHandoff", [request], cancellationToken); } + + /// Clears the session's conversation history, keeping only system and developer messages, and seeds the fresh context window with a first user message. Must be called from inside a tool handler: the clear has to drop the results of the tool calls its wipe orphans, and it rejects when no tool call is in flight. + /// First user message of the fresh context window. Required: a cleared window holding only system and developer messages is not a conversation a model can answer, so every clear seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop exits, which is why the call must be made from inside a tool handler. + /// The to monitor for cancellation requests. The default is . + /// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. + public async Task ClearContextAsync(string prompt, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new HistoryClearContextRequest { SessionId = _session.SessionId, Prompt = prompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.history.clearContext", [request], cancellationToken); + } } /// Provides session-scoped Queue APIs. @@ -15824,6 +28111,158 @@ public async Task PendingItemsAsync(CancellationToken c return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.pendingItems", [request], cancellationToken); } + /// Returns the internal native queue snapshot for in-process session orchestration. + /// The to monitor for cancellation requests. The default is . + /// Internal snapshot of native queue state for local session orchestration. + internal async Task SnapshotAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionQueueSnapshotRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.snapshot", [request], cancellationToken); + } + + /// Moves an addressable queued item to a public visible position. + /// Stable opaque queued-item id. + /// Zero-based target position in the public visible queue. Values outside the queue clamp to an end. + /// The to monitor for cancellation requests. The default is . + /// Result of moving a queued item. + public async Task MoveItemAsync(string id, long toPosition, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + _session.ThrowIfDisposed(); + + var request = new QueueMoveItemRequest { SessionId = _session.SessionId, Id = id, ToPosition = toPosition }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.moveItem", [request], cancellationToken); + } + + /// Inserts a new queued message at a public visible position. + /// Zero-based position in the public visible queue. Values outside the queue clamp to an end. + /// The message parameter. + /// The to monitor for cancellation requests. The default is . + /// Result of inserting a queued message. + public async Task InsertAtAsync(long position, QueueInsertMessage message, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(message); + _session.ThrowIfDisposed(); + + var request = new QueueInsertAtRequest { SessionId = _session.SessionId, Position = position, Message = message }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.insertAt", [request], cancellationToken); + } + + /// Removes an addressable queued item by its stable id. + /// The id parameter. + /// The to monitor for cancellation requests. The default is . + /// Result of removing a queued item. + public async Task RemoveAtAsync(string id, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + _session.ThrowIfDisposed(); + + var request = new QueueRemoveAtRequest { SessionId = _session.SessionId, Id = id }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.removeAt", [request], cancellationToken); + } + + /// Updates the text of an addressable single-message queue item. + /// The id parameter. + /// The prompt parameter. + /// The displayPrompt parameter. + /// The to monitor for cancellation requests. The default is . + /// Result of editing a queued message. + public async Task UpdateTextAsync(string id, string prompt, string? displayPrompt = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new QueueUpdateTextRequest { SessionId = _session.SessionId, Id = id, Prompt = prompt, DisplayPrompt = displayPrompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.updateText", [request], cancellationToken); + } + + /// Duplicates an addressable queued item immediately after its source. + /// The id parameter. + /// The to monitor for cancellation requests. The default is . + /// Result of duplicating a queued item. + public async Task DuplicateAtAsync(string id, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + _session.ThrowIfDisposed(); + + var request = new QueueDuplicateAtRequest { SessionId = _session.SessionId, Id = id }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.duplicateAt", [request], cancellationToken); + } + + /// Acquires or releases the queued-lane drain pause. + /// The paused parameter. + /// The to monitor for cancellation requests. The default is . + public async Task SetDrainPausedAsync(bool paused, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new QueueSetDrainPausedRequest { SessionId = _session.SessionId, Paused = paused }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.setDrainPaused", [request], cancellationToken); + } + + /// Moves an addressable queued message into the live turn's steering lane. + /// The id parameter. + /// The to monitor for cancellation requests. The default is . + /// Result of trying to steer a queued message into a live turn. + public async Task SendNowAsync(string id, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(id); + _session.ThrowIfDisposed(); + + var request = new QueueSendNowRequest { SessionId = _session.SessionId, Id = id }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.sendNow", [request], cancellationToken); + } + + /// Reports whether the local session has native queued work pending. + /// The to monitor for cancellation requests. The default is . + /// Whether the native queue has pending work. + internal async Task HasPendingAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionQueueHasPendingRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.hasPending", [request], cancellationToken); + } + + /// Begins a native deferred-idle drain when background work has quiesced. + /// Whether the host still has active background work. + /// The to monitor for cancellation requests. The default is . + /// Whether a deferred-idle drain should run. + internal async Task BeginDeferredIdleDrainAsync(bool activeBackgroundWork, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new QueueBeginDeferredIdleDrainRequest { SessionId = _session.SessionId, ActiveBackgroundWork = activeBackgroundWork }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.beginDeferredIdleDrain", [request], cancellationToken); + } + + /// Finishes a native deferred-idle drain and reports whether to drain queue work or emit idle. + /// Whether the host still has active background work. + /// Whether native queued work remains. + /// The to monitor for cancellation requests. The default is . + /// Action selected by the native deferred-idle drain. + internal async Task FinishDeferredIdleDrainAsync(bool activeBackgroundWork, bool hasPending, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new QueueFinishDeferredIdleDrainRequest { SessionId = _session.SessionId, ActiveBackgroundWork = activeBackgroundWork, HasPending = hasPending }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.finishDeferredIdleDrain", [request], cancellationToken); + } + + /// Marks session.idle as deferred by native background work state. + /// Whether the deferred idle was caused by an aborted foreground turn. + /// The to monitor for cancellation requests. The default is . + internal async Task DeferSessionIdleAsync(bool aborted, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new QueueDeferSessionIdleRequest { SessionId = _session.SessionId, Aborted = aborted }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.deferSessionIdle", [request], cancellationToken); + } + /// Removes the most recently queued user-facing item (LIFO). /// The to monitor for cancellation requests. The default is . /// Indicates whether a user-facing pending item was removed. @@ -15844,6 +28283,40 @@ public async Task ClearAsync(CancellationToken cancellationToken = default) var request = new SessionQueueClearRequest { SessionId = _session.SessionId }; await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.clear", [request], cancellationToken); } + + /// Consumes queued native system notifications matching an internal filter. + /// Opaque runtime-owned filter object. + /// The to monitor for cancellation requests. The default is . + /// Indicates whether a user-facing pending item was removed. + internal async Task ConsumeSystemNotificationsAsync(object filter, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(filter); + _session.ThrowIfDisposed(); + + var request = new QueueConsumeSystemNotificationsRequest { SessionId = _session.SessionId, Filter = CopilotClient.ToJsonElementForWire(filter)!.Value }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.consumeSystemNotifications", [request], cancellationToken); + } + + /// Enqueues the internal resume-pending wake item when orphan handling needs a follow-up turn. + /// The to monitor for cancellation requests. The default is . + /// Result of enqueueing the resume-pending wake item. + internal async Task EnqueueResumePendingAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionQueueEnqueueResumePendingRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.enqueueResumePending", [request], cancellationToken); + } + + /// Drains the native local-session work queue for in-process session orchestration. + /// The to monitor for cancellation requests. The default is . + internal async Task ProcessAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionQueueProcessRequest { SessionId = _session.SessionId }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.queue.process", [request], cancellationToken); + } } /// Provides session-scoped EventLog APIs. @@ -15857,19 +28330,22 @@ internal EventLogApi(CopilotSession session) _session = session; } - /// Reads a batch of session events from a cursor, optionally waiting for new events. + /// Reads a batch of session events from a cursor, optionally waiting for new events. Supports tail-first reads via `direction: backward`. /// Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. /// Maximum number of events to return in this batch (1–1000, default 200). - /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). + /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). This applies to forward reads only: a backward read always returns immediately and ignores `waitMs`, because backward paging covers persisted history only while new events append at the tail (the opposite end from a backward page), so no blocking or ephemeral delivery can occur. /// Either '*' to receive all event types, or a non-empty list of event types to receive. /// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. + /// Optional non-empty list of subagent identifiers. When provided, only events owned by one of these agents are returned; ownership recognizes the event envelope's agentId plus legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over agentScope. + /// Direction to page through the session's persisted event history. 'forward' (default) pages from the cursor toward newer events (or from the start of history when no cursor is given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` events, and the returned cursor pages toward OLDER events on subsequent backward reads. Events within a returned batch are always in chronological (oldest-to-newest) order, even for a backward read. Backward reads cover PERSISTED history only; ephemeral events are never returned by a backward read. `direction` selects the INITIAL read only: the returned cursor is self-describing, so a continuation read pages in the cursor's own direction regardless of the `direction` passed alongside it — a forward cursor always pages forward and a backward cursor always pages backward. Pass the direction that matches the cursor to avoid confusion. + /// When false, skip ephemeral events entirely and return only durable (persisted) events. History-backfill callers that discard ephemerals anyway should set this so the read is bounded by the durable log length instead of racing the ephemeral ring on a busy session. Defaults to true (ephemerals are interleaved with durable events in creation order). Ignored by backward reads, which always cover persisted history only. /// The to monitor for cancellation requests. The default is . /// Batch of session events returned by a read, with cursor and continuation metadata. - public async Task ReadAsync(string? cursor = null, int? max = null, TimeSpan? waitMs = null, object? types = null, EventsAgentScope? agentScope = null, CancellationToken cancellationToken = default) + public async Task ReadAsync(string? cursor = null, long? max = null, TimeSpan? waitMs = null, object? types = null, EventsAgentScope? agentScope = null, IList? agentIds = null, EventsReadDirection? direction = null, bool? includeEphemeral = null, CancellationToken cancellationToken = default) { _session.ThrowIfDisposed(); - var request = new EventLogReadRequest { SessionId = _session.SessionId, Cursor = cursor, Max = max, Wait = waitMs, Types = CopilotClient.ToJsonElementForWire(types), AgentScope = agentScope }; + var request = new EventLogReadRequest { SessionId = _session.SessionId, Cursor = cursor, Max = max, Wait = waitMs, Types = CopilotClient.ToJsonElementForWire(types), AgentScope = agentScope, AgentIds = agentIds, Direction = direction, IncludeEphemeral = includeEphemeral }; return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.eventLog.read", [request], cancellationToken); } @@ -15885,7 +28361,7 @@ public async Task TailAsync(CancellationToken cancellationTo } /// Registers consumer interest in an event type for runtime gating purposes. - /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full interactive OAuth flow to the consumer; when no interest is registered the runtime installs a browserless fallback that silently reuses cached tokens). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. + /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest is registered the runtime still attempts non-interactive reconnect from cached or refreshable tokens, and only marks the server `needs-auth` if usable credentials are unavailable — it does not open a browser or start interactive OAuth without a consumer). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. /// The to monitor for cancellation requests. The default is . /// Opaque handle representing an event-type interest registration. public async Task RegisterInterestAsync(string eventType, CancellationToken cancellationToken = default) @@ -15934,6 +28410,30 @@ public async Task GetMetricsAsync(CancellationToken cance } } +/// Provides session-scoped LimitPrediction APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class LimitPredictionApi +{ + private readonly CopilotSession _session; + + internal LimitPredictionApi(CopilotSession session) + { + _session = session; + } + + /// Predicts an AI-credit session limit for the session's resolved model. Returns an unavailable result instead of falling back when the current model is unresolved auto. + /// Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + /// The to monitor for cancellation requests. The default is . + /// Prediction result. Available results include prediction details; unavailable results include an explicit reason. + public async Task PredictAsync(SessionLimitPredictionPredictRequest? request = null, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var rpcRequest = new SessionLimitPredictionPredictRequestWithSession { SessionId = _session.SessionId, ModelId = request?.ModelId, ClientType = request?.ClientType }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.limitPrediction.predict", [rpcRequest], cancellationToken); + } +} + /// Provides session-scoped Remote APIs. [Experimental(Diagnostics.Experimental)] public sealed class RemoteApi @@ -15980,6 +28480,41 @@ public async Task NotifySteerableChangedAsyn } } +/// Provides session-scoped Visibility APIs. +[Experimental(Diagnostics.Experimental)] +public sealed class VisibilityApi +{ + private readonly CopilotSession _session; + + internal VisibilityApi(CopilotSession session) + { + _session = session; + } + + /// Returns the session's current Mission Control sharing status and shareable GitHub URL. Reflects whether the synced session is visible to repository readers ("repo") or restricted to its creator and collaborators ("unshared"). + /// The to monitor for cancellation requests. The default is . + /// Current sharing status and shareable GitHub URL for a session. + public async Task GetAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionVisibilityGetRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.visibility.get", [request], cancellationToken); + } + + /// Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers. Returns the effective status and shareable GitHub URL after the change. + /// Sharing status to apply. "repo" makes the session visible to repository readers; "unshared" restricts it to the creator and collaborators. + /// The to monitor for cancellation requests. The default is . + /// Effective sharing status and shareable GitHub URL after updating session visibility. + public async Task SetAsync(SessionVisibilityStatus status, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new VisibilitySetRequest { SessionId = _session.SessionId, Status = status }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.visibility.set", [request], cancellationToken); + } +} + /// Provides session-scoped Schedule APIs. [Experimental(Diagnostics.Experimental)] public sealed class ScheduleApi @@ -16002,6 +28537,105 @@ public async Task ListAsync(CancellationToken cancellationToken = return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.list", [request], cancellationToken); } + /// Hydrates the native schedule registry from persisted session events. + /// The to monitor for cancellation requests. The default is . + internal async Task HydrateAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionScheduleHydrateRequest { SessionId = _session.SessionId }; + await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.hydrate", [request], cancellationToken); + } + + /// Reports whether the session has an active self-paced scheduled prompt. + /// The to monitor for cancellation requests. The default is . + /// Whether the session currently has an active self-paced schedule. + internal async Task HasSelfPacedAsync(CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new SessionScheduleHasSelfPacedRequest { SessionId = _session.SessionId }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.hasSelfPaced", [request], cancellationToken); + } + + /// Registers a relative-interval scheduled prompt. + /// Human-readable interval such as `30s`, `5m`, or `2h`. + /// Prompt text to enqueue when the schedule fires. + /// Whether the schedule should re-arm after each tick. Defaults to true. + /// Optional display-only prompt label. + /// The to monitor for cancellation requests. The default is . + /// Result of registering or re-arming a scheduled prompt. + internal async Task AddAsync(string interval, string prompt, bool? recurring = null, string? displayPrompt = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(interval); + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new ScheduleAddRequest { SessionId = _session.SessionId, Interval = interval, Prompt = prompt, Recurring = recurring, DisplayPrompt = displayPrompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.add", [request], cancellationToken); + } + + /// Registers a recurring cron scheduled prompt. + /// 5-field cron expression. + /// Prompt text to enqueue when the schedule fires. + /// Whether the schedule should re-arm after each tick. Defaults to true. + /// Optional display-only prompt label. + /// IANA timezone for evaluating the cron expression. + /// The to monitor for cancellation requests. The default is . + /// Result of registering or re-arming a scheduled prompt. + internal async Task AddCronAsync(string cron, string prompt, bool? recurring = null, string? displayPrompt = null, string? tz = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(cron); + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new ScheduleAddCronRequest { SessionId = _session.SessionId, Cron = cron, Prompt = prompt, Recurring = recurring, DisplayPrompt = displayPrompt, Tz = tz }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.addCron", [request], cancellationToken); + } + + /// Registers an absolute-time scheduled prompt. + /// Epoch milliseconds when the prompt should fire. + /// Prompt text to enqueue when the schedule fires. + /// Whether the schedule should re-arm after each tick. Defaults to false. + /// Optional display-only prompt label. + /// The to monitor for cancellation requests. The default is . + /// Result of registering or re-arming a scheduled prompt. + internal async Task AddAtAsync(long at, string prompt, bool? recurring = null, string? displayPrompt = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new ScheduleAddAtRequest { SessionId = _session.SessionId, At = at, Prompt = prompt, Recurring = recurring, DisplayPrompt = displayPrompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.addAt", [request], cancellationToken); + } + + /// Registers a self-paced scheduled prompt. + /// Prompt text to enqueue when the schedule fires. + /// Optional display-only prompt label. + /// The to monitor for cancellation requests. The default is . + /// Result of registering or re-arming a scheduled prompt. + internal async Task AddSelfPacedAsync(string prompt, string? displayPrompt = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(prompt); + _session.ThrowIfDisposed(); + + var request = new ScheduleAddSelfPacedRequest { SessionId = _session.SessionId, Prompt = prompt, DisplayPrompt = displayPrompt }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.addSelfPaced", [request], cancellationToken); + } + + /// Re-arms an active self-paced scheduled prompt. + /// Id of the self-paced scheduled prompt. + /// Epoch milliseconds when the prompt should next fire. + /// The to monitor for cancellation requests. The default is . + /// Result of registering or re-arming a scheduled prompt. + internal async Task RearmSelfPacedAsync(long id, long at, CancellationToken cancellationToken = default) + { + _session.ThrowIfDisposed(); + + var request = new ScheduleRearmSelfPacedRequest { SessionId = _session.SessionId, Id = id, At = at }; + return await CopilotClient.InvokeRpcAsync(_session.Rpc, "session.schedule.rearmSelfPaced", [request], cancellationToken); + } + /// Removes a scheduled prompt by id. /// Id of the scheduled prompt to remove. /// The to monitor for cancellation requests. The default is . @@ -16015,6 +28649,33 @@ public async Task StopAsync(long id, CancellationToken cance } } +/// Handles `providerToken` client session API methods. +[Experimental(Diagnostics.Experimental)] +public interface IProviderTokenHandler +{ + /// Asks the SDK client to get a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Session-scoped: the runtime calls it back on the connection that most recently supplied that provider's config for the session (the creating connection, or a resuming connection if the session was resumed — distinct providers may be owned by different connections), passing the provider name, and uses the returned token as the Authorization header for the outbound model request. The runtime does no caching — it calls this once per outbound request; the SDK consumer owns token acquisition, caching, and refresh. + /// Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. + /// The to monitor for cancellation requests. The default is . + /// A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer <token>` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. + Task GetTokenAsync(ProviderTokenAcquireRequest request, CancellationToken cancellationToken = default); +} + +/// Handles `factory` client session API methods. +[Experimental(Diagnostics.Experimental)] +public interface IFactoryHandler +{ + /// Asks the owning extension connection to execute a registered factory closure. + /// Parameters sent to the owning extension to execute a factory closure. + /// The to monitor for cancellation requests. The default is . + /// Result returned by an extension factory closure. + Task ExecuteAsync(FactoryExecuteRequest request, CancellationToken cancellationToken = default); + /// Asks the owning extension connection to abort a running factory cooperatively. + /// Parameters for cooperatively aborting a factory body. + /// The to monitor for cancellation requests. The default is . + /// Acknowledgement that a factory request was accepted. + Task AbortAsync(FactoryAbortRequest request, CancellationToken cancellationToken = default); +} + /// Handles `sessionFs` client session API methods. [Experimental(Diagnostics.Experimental)] public interface ISessionFsHandler @@ -16069,11 +28730,16 @@ public interface ISessionFsHandler /// The to monitor for cancellation requests. The default is . /// Describes a filesystem error. Task RenameAsync(SessionFsRenameRequest request, CancellationToken cancellationToken = default); - /// Executes a SQLite query against the per-session database. - /// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. + /// Executes a SQLite query against the per-session database. Providers apply busy handling for every call. + /// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. /// The to monitor for cancellation requests. The default is . /// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. Task SqliteQueryAsync(SessionFsSqliteQueryRequest request, CancellationToken cancellationToken = default); + /// Executes SQLite statements atomically on the provider-owned connection. + /// Statements to execute atomically. Providers apply busy handling for every call. + /// The to monitor for cancellation requests. The default is . + /// Per-statement results, or a classified transaction error. + Task SqliteTransactionAsync(SessionFsSqliteTransactionRequest request, CancellationToken cancellationToken = default); /// Checks whether the per-session SQLite database already exists, without creating it. /// Identifies the target session. /// The to monitor for cancellation requests. The default is . @@ -16104,6 +28770,12 @@ public interface ICanvasHandler /// Provides all client session API handler groups for a session. public sealed class ClientSessionApiHandlers { + /// Optional handler for ProviderToken client session API methods. + public IProviderTokenHandler? ProviderToken { get; set; } + + /// Optional handler for Factory client session API methods. + public IFactoryHandler? Factory { get; set; } + /// Optional handler for SessionFs client session API methods. public ISessionFsHandler? SessionFs { get; set; } @@ -16121,6 +28793,24 @@ internal static class ClientSessionApiRegistration /// public static void RegisterClientSessionApiHandlers(JsonRpc rpc, Func getHandlers) { + rpc.SetLocalRpcMethod("providerToken.getToken", (Func>)(async (request, cancellationToken) => + { + var handler = getHandlers(request.SessionId).ProviderToken; + if (handler is null) throw new InvalidOperationException($"No providerToken handler registered for session: {request.SessionId}"); + return await handler.GetTokenAsync(request, cancellationToken); + }), singleObjectParam: true); + rpc.SetLocalRpcMethod("factory.execute", (Func>)(async (request, cancellationToken) => + { + var handler = getHandlers(request.SessionId).Factory; + if (handler is null) throw new InvalidOperationException($"No factory handler registered for session: {request.SessionId}"); + return await handler.ExecuteAsync(request, cancellationToken); + }), singleObjectParam: true); + rpc.SetLocalRpcMethod("factory.abort", (Func>)(async (request, cancellationToken) => + { + var handler = getHandlers(request.SessionId).Factory; + if (handler is null) throw new InvalidOperationException($"No factory handler registered for session: {request.SessionId}"); + return await handler.AbortAsync(request, cancellationToken); + }), singleObjectParam: true); rpc.SetLocalRpcMethod("sessionFs.readFile", (Func>)(async (request, cancellationToken) => { var handler = getHandlers(request.SessionId).SessionFs; @@ -16187,6 +28877,12 @@ public static void RegisterClientSessionApiHandlers(JsonRpc rpc, Func>)(async (request, cancellationToken) => + { + var handler = getHandlers(request.SessionId).SessionFs; + if (handler is null) throw new InvalidOperationException($"No sessionFs handler registered for session: {request.SessionId}"); + return await handler.SqliteTransactionAsync(request, cancellationToken); + }), singleObjectParam: true); rpc.SetLocalRpcMethod("sessionFs.sqliteExists", (Func>)(async (request, cancellationToken) => { var handler = getHandlers(request.SessionId).SessionFs; @@ -16214,6 +28910,90 @@ public static void RegisterClientSessionApiHandlers(JsonRpc rpc, FuncHandles `extensionLaunchProvider` client global API methods. +[Experimental(Diagnostics.Experimental)] +public interface IExtensionLaunchProviderHandler +{ + /// Asks the registered SDK client to resolve an opaque process launch profile for one discovered extension entrypoint immediately before launch or reload. The provider must respond within 15 seconds. + /// A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. + /// The to monitor for cancellation requests. The default is . + /// The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. + Task ResolveAsync(ExtensionLaunchProviderResolveRequest request, CancellationToken cancellationToken = default); +} + +/// Handles `llmInference` client global API methods. +[Experimental(Diagnostics.Experimental)] +public interface ILlmInferenceHandler +{ + /// Announces an outbound model-layer HTTP request the runtime wants the SDK client to service. Carries the request head only; the body always follows as one or more httpRequestChunk frames keyed by the same requestId, even when the body is empty (a single chunk with end=true). + /// The head of an outbound model-layer HTTP request. + /// The to monitor for cancellation requests. The default is . + /// Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. + Task HttpRequestStartAsync(LlmInferenceHttpRequestStartRequest request, CancellationToken cancellationToken = default); + /// Delivers a body byte range (or a cancellation signal) for a request previously announced via httpRequestStart, correlated by requestId. The runtime fires at least one chunk per request — when there is no body, a single chunk with empty data and end=true. Mid-stream the runtime may send a chunk with cancel=true to abort the request; the SDK then stops issuing httpResponseChunk frames and may emit a terminal httpResponseChunk with error set. + /// A request body chunk or cancellation signal. + /// The to monitor for cancellation requests. The default is . + /// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. + Task HttpRequestChunkAsync(LlmInferenceHttpRequestChunkRequest request, CancellationToken cancellationToken = default); +} + +/// Handles `gitHubTelemetry` client global API methods. +[Experimental(Diagnostics.Experimental)] +public interface IGitHubTelemetryHandler +{ + /// Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive every event the runtime emits after the handshake — across all sessions, plus sessionless events (for example, `server.sendTelemetry` calls with no session id). + /// Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. + /// The to monitor for cancellation requests. The default is . + Task EventAsync(GitHubTelemetryNotification request, CancellationToken cancellationToken = default); +} + +/// Provides all client global API handler groups for a connection. +public sealed class ClientGlobalApiHandlers +{ + /// Optional handler for ExtensionLaunchProvider client global API methods. + public IExtensionLaunchProviderHandler? ExtensionLaunchProvider { get; set; } + + /// Optional handler for LlmInference client global API methods. + public ILlmInferenceHandler? LlmInference { get; set; } + + /// Optional handler for GitHubTelemetry client global API methods. + public IGitHubTelemetryHandler? GitHubTelemetry { get; set; } +} + +/// Registers client global API handlers on a JSON-RPC connection. +internal static class ClientGlobalApiRegistration +{ + /// + /// Registers handlers for server-to-client global API calls. + /// Unlike client session APIs, these methods carry no implicit + /// sessionId dispatch key — a single set of handlers serves the + /// entire connection. + /// + public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiHandlers handlers) + { + rpc.SetLocalRpcMethod("extensionLaunchProvider.resolve", (Func>)(async (request, cancellationToken) => + { + var handler = handlers.ExtensionLaunchProvider ?? throw new InvalidOperationException("No extensionLaunchProvider client-global handler registered"); + return await handler.ResolveAsync(request, cancellationToken); + }), singleObjectParam: true); + rpc.SetLocalRpcMethod("llmInference.httpRequestStart", (Func>)(async (request, cancellationToken) => + { + var handler = handlers.LlmInference ?? throw new InvalidOperationException("No llmInference client-global handler registered"); + return await handler.HttpRequestStartAsync(request, cancellationToken); + }), singleObjectParam: true); + rpc.SetLocalRpcMethod("llmInference.httpRequestChunk", (Func>)(async (request, cancellationToken) => + { + var handler = handlers.LlmInference ?? throw new InvalidOperationException("No llmInference client-global handler registered"); + return await handler.HttpRequestChunkAsync(request, cancellationToken); + }), singleObjectParam: true); + rpc.SetLocalRpcMethod("gitHubTelemetry.event", (Func)(async (request, cancellationToken) => + { + var handler = handlers.GitHubTelemetry ?? throw new InvalidOperationException("No gitHubTelemetry client-global handler registered"); + await handler.EventAsync(request, cancellationToken); + }), singleObjectParam: true); + } +} + [JsonSourceGenerationOptions( JsonSerializerDefaults.Web, AllowOutOfOrderMetadataProperties = true, @@ -16226,12 +29006,15 @@ public static void RegisterClientSessionApiHandlers(JsonRpc rpc, Func))] +[JsonSerializable(typeof(IList))] [JsonSerializable(typeof(InstalledPlugin))] +[JsonSerializable(typeof(InstalledPluginInfo))] +[JsonSerializable(typeof(InstructionDiscoveryPath))] +[JsonSerializable(typeof(InstructionDiscoveryPathList))] +[JsonSerializable(typeof(InstructionSource))] +[JsonSerializable(typeof(InstructionsDiscoverRequest))] +[JsonSerializable(typeof(InstructionsGetDiscoveryPathsRequest))] [JsonSerializable(typeof(InstructionsGetSourcesResult))] -[JsonSerializable(typeof(InstructionsSources))] +[JsonSerializable(typeof(InterruptMainTurnRequest))] +[JsonSerializable(typeof(InterruptMainTurnResult))] +[JsonSerializable(typeof(LlmInferenceHttpRequestChunkRequest))] +[JsonSerializable(typeof(LlmInferenceHttpRequestChunkResult))] +[JsonSerializable(typeof(LlmInferenceHttpRequestStartRequest))] +[JsonSerializable(typeof(LlmInferenceHttpRequestStartResult))] +[JsonSerializable(typeof(LlmInferenceHttpResponseChunkError))] +[JsonSerializable(typeof(LlmInferenceHttpResponseChunkRequest))] +[JsonSerializable(typeof(LlmInferenceHttpResponseChunkResult))] +[JsonSerializable(typeof(LlmInferenceHttpResponseStartRequest))] +[JsonSerializable(typeof(LlmInferenceHttpResponseStartResult))] +[JsonSerializable(typeof(LlmInferenceSetProviderResult))] +[JsonSerializable(typeof(LocalSessionMetadataValue))] [JsonSerializable(typeof(LogRequest))] [JsonSerializable(typeof(LogResult))] [JsonSerializable(typeof(LspInitializeRequest))] +[JsonSerializable(typeof(ManagedSettingsReadResult))] +[JsonSerializable(typeof(MarketplaceAddResult))] +[JsonSerializable(typeof(MarketplaceBrowseResult))] +[JsonSerializable(typeof(MarketplaceInfo))] +[JsonSerializable(typeof(MarketplaceListResult))] +[JsonSerializable(typeof(MarketplacePluginInfo))] +[JsonSerializable(typeof(MarketplaceRefreshEntry))] +[JsonSerializable(typeof(MarketplaceRefreshResult))] +[JsonSerializable(typeof(MarketplaceRemoveResult))] +[JsonSerializable(typeof(McpAllowedServer))] [JsonSerializable(typeof(McpAppsCallToolRequest))] [JsonSerializable(typeof(McpAppsDiagnoseCapability))] [JsonSerializable(typeof(McpAppsDiagnoseRequest))] @@ -16578,6 +29570,8 @@ public static void RegisterClientSessionApiHandlers(JsonRpc rpc, FuncPayload indicating the session is idle with no background agents in flight. +/// Payload indicating the session is idle with no background agents or attached shell commands in flight. /// Represents the session.idle event. public sealed partial class SessionIdleEvent : SessionEvent { @@ -257,6 +285,19 @@ public sealed partial class SessionScheduleCancelledEvent : SessionEvent public required SessionScheduleCancelledData Data { get; set; } } +/// Self-paced schedule re-armed for its next run. +/// Represents the session.schedule_rearmed event. +public sealed partial class SessionScheduleRearmedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.schedule_rearmed"; + + /// The session.schedule_rearmed event payload. + [JsonPropertyName("data")] + public required SessionScheduleRearmedData Data { get; set; } +} + /// Autopilot objective state file operation details indicating what changed. /// Represents the session.autopilot_objective_changed event. public sealed partial class SessionAutopilotObjectiveChangedEvent : SessionEvent @@ -322,7 +363,20 @@ public sealed partial class SessionModeChangedEvent : SessionEvent public required SessionModeChangedData Data { get; set; } } -/// Permissions change details carrying the aggregate allow-all boolean transition. +/// Session limits update details. Null clears the limits. +/// Represents the session.session_limits_changed event. +public sealed partial class SessionSessionLimitsChangedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.session_limits_changed"; + + /// The session.session_limits_changed event payload. + [JsonPropertyName("data")] + public required SessionSessionLimitsChangedData Data { get; set; } +} + +/// Permissions change details carrying the aggregate allow-all transition. /// Represents the session.permissions_changed event. public sealed partial class SessionPermissionsChangedEvent : SessionEvent { @@ -348,6 +402,19 @@ public sealed partial class SessionPlanChangedEvent : SessionEvent public required SessionPlanChangedData Data { get; set; } } +/// Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. +/// Represents the session.todos_changed event. +public sealed partial class SessionTodosChangedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.todos_changed"; + + /// The session.todos_changed event payload. + [JsonPropertyName("data")] + public required SessionTodosChangedData Data { get; set; } +} + /// Workspace file change details including path and operation type. /// Represents the session.workspace_file_changed event. public sealed partial class SessionWorkspaceFileChangedEvent : SessionEvent @@ -413,6 +480,19 @@ public sealed partial class SessionShutdownEvent : SessionEvent public required SessionShutdownData Data { get; set; } } +/// Durable session usage checkpoint for reconstructing aggregate accounting on resume. +/// Represents the session.usage_checkpoint event. +public sealed partial class SessionUsageCheckpointEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.usage_checkpoint"; + + /// The session.usage_checkpoint event payload. + [JsonPropertyName("data")] + public required SessionUsageCheckpointData Data { get; set; } +} + /// Working directory and git context at session start. /// Represents the session.context_changed event. public sealed partial class SessionContextChangedEvent : SessionEvent @@ -439,6 +519,19 @@ public sealed partial class SessionUsageInfoEvent : SessionEvent public required SessionUsageInfoData Data { get; set; } } +/// Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages). +/// Represents the session.context_cleared event. +public sealed partial class SessionContextClearedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.context_cleared"; + + /// The session.context_cleared event payload. + [JsonPropertyName("data")] + public required SessionContextClearedData Data { get; set; } +} + /// Context window breakdown at the start of LLM-powered conversation compaction. /// Represents the session.compaction_start event. public sealed partial class SessionCompactionStartEvent : SessionEvent @@ -478,7 +571,7 @@ public sealed partial class SessionTaskCompleteEvent : SessionEvent public required SessionTaskCompleteData Data { get; set; } } -/// Schema for the `UserMessageData` type. +/// Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. /// Represents the user.message event. public sealed partial class UserMessageEvent : SessionEvent { @@ -517,6 +610,19 @@ public sealed partial class AssistantTurnStartEvent : SessionEvent public required AssistantTurnStartData Data { get; set; } } +/// Metadata for an additional model inference attempt within an existing assistant turn. +/// Represents the assistant.turn_retry event. +public sealed partial class AssistantTurnRetryEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.turn_retry"; + + /// The assistant.turn_retry event payload. + [JsonPropertyName("data")] + public required AssistantTurnRetryData Data { get; set; } +} + /// Agent intent description for current activity or plan. /// Represents the assistant.intent event. public sealed partial class AssistantIntentEvent : SessionEvent @@ -530,6 +636,19 @@ public sealed partial class AssistantIntentEvent : SessionEvent public required AssistantIntentData Data { get; set; } } +/// Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message. +/// Represents the assistant.server_tool_progress event. +public sealed partial class AssistantServerToolProgressEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.server_tool_progress"; + + /// The assistant.server_tool_progress event payload. + [JsonPropertyName("data")] + public required AssistantServerToolProgressData Data { get; set; } +} + /// Assistant reasoning content for timeline display with complete thinking text. /// Represents the assistant.reasoning event. public sealed partial class AssistantReasoningEvent : SessionEvent @@ -556,6 +675,19 @@ public sealed partial class AssistantReasoningDeltaEvent : SessionEvent public required AssistantReasoningDeltaData Data { get; set; } } +/// Streaming tool-call input delta for incremental tool-call updates. +/// Represents the assistant.tool_call_delta event. +public sealed partial class AssistantToolCallDeltaEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.tool_call_delta"; + + /// The assistant.tool_call_delta event payload. + [JsonPropertyName("data")] + public required AssistantToolCallDeltaData Data { get; set; } +} + /// Streaming response progress with cumulative byte count. /// Represents the assistant.streaming_delta event. public sealed partial class AssistantStreamingDeltaEvent : SessionEvent @@ -621,6 +753,19 @@ public sealed partial class AssistantTurnEndEvent : SessionEvent public required AssistantTurnEndData Data { get; set; } } +/// Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred. +/// Represents the assistant.idle event. +public sealed partial class AssistantIdleEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "assistant.idle"; + + /// The assistant.idle event payload. + [JsonPropertyName("data")] + public required AssistantIdleData Data { get; set; } +} + /// LLM API call usage metrics including tokens, costs, quotas, and billing information. /// Represents the assistant.usage event. public sealed partial class AssistantUsageEvent : SessionEvent @@ -647,6 +792,19 @@ public sealed partial class ModelCallFailureEvent : SessionEvent public required ModelCallFailureData Data { get; set; } } +/// Model API dispatch metadata for internal telemetry. +/// Represents the model.call_start event. +public sealed partial class ModelCallStartEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "model.call_start"; + + /// The model.call_start event payload. + [JsonPropertyName("data")] + public required ModelCallStartData Data { get; set; } +} + /// Turn abort information including the reason for termination. /// Represents the abort event. public sealed partial class AbortEvent : SessionEvent @@ -725,6 +883,19 @@ public sealed partial class ToolExecutionCompleteEvent : SessionEvent public required ToolExecutionCompleteData Data { get; set; } } +/// Persisted generic client-side tool activations restored when a session resumes. +/// Represents the tool_search.activated event. +public sealed partial class ToolSearchActivatedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "tool_search.activated"; + + /// The tool_search.activated event payload. + [JsonPropertyName("data")] + public required ToolSearchActivatedData Data { get; set; } +} + /// Skill invocation details including content, allowed tools, and plugin metadata. /// Represents the skill.invoked event. public sealed partial class SkillInvokedEvent : SessionEvent @@ -842,6 +1013,20 @@ public sealed partial class HookProgressEvent : SessionEvent public required HookProgressData Data { get; set; } } +/// Canonical bytes for a content-addressed binary asset shared by reference across events. +/// Represents the session.binary_asset event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionBinaryAssetEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.binary_asset"; + + /// The session.binary_asset event payload. + [JsonPropertyName("data")] + public required SessionBinaryAssetData Data { get; set; } +} + /// System/developer instruction content with role and optional template metadata. /// Represents the system.message event. public sealed partial class SystemMessageEvent : SessionEvent @@ -998,6 +1183,32 @@ public sealed partial class McpOauthCompletedEvent : SessionEvent public required McpOauthCompletedData Data { get; set; } } +/// Dynamic headers refresh request for a remote MCP server. +/// Represents the mcp.headers_refresh_required event. +public sealed partial class McpHeadersRefreshRequiredEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "mcp.headers_refresh_required"; + + /// The mcp.headers_refresh_required event payload. + [JsonPropertyName("data")] + public required McpHeadersRefreshRequiredData Data { get; set; } +} + +/// MCP headers refresh request completion notification. +/// Represents the mcp.headers_refresh_completed event. +public sealed partial class McpHeadersRefreshCompletedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "mcp.headers_refresh_completed"; + + /// The mcp.headers_refresh_completed event payload. + [JsonPropertyName("data")] + public required McpHeadersRefreshCompletedData Data { get; set; } +} + /// Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. /// Represents the session.custom_notification event. public sealed partial class SessionCustomNotificationEvent : SessionEvent @@ -1102,6 +1313,74 @@ public sealed partial class AutoModeSwitchCompletedEvent : SessionEvent public required AutoModeSwitchCompletedData Data { get; set; } } +/// Session limit exhaustion notification requiring user action. +/// Represents the session_limits_exhausted.requested event. +public sealed partial class SessionLimitsExhaustedRequestedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session_limits_exhausted.requested"; + + /// The session_limits_exhausted.requested event payload. + [JsonPropertyName("data")] + public required SessionLimitsExhaustedRequestedData Data { get; set; } +} + +/// Session limit exhaustion prompt completion notification. +/// Represents the session_limits_exhausted.completed event. +public sealed partial class SessionLimitsExhaustedCompletedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session_limits_exhausted.completed"; + + /// The session_limits_exhausted.completed event payload. + [JsonPropertyName("data")] + public required SessionLimitsExhaustedCompletedData Data { get; set; } +} + +/// Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. +/// Represents the session.auto_mode_resolved event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionAutoModeResolvedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.auto_mode_resolved"; + + /// The session.auto_mode_resolved event payload. + [JsonPropertyName("data")] + public required SessionAutoModeResolvedData Data { get; set; } +} + +/// Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. +/// Represents the session.managed_settings_resolved event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionManagedSettingsResolvedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.managed_settings_resolved"; + + /// The session.managed_settings_resolved event payload. + [JsonPropertyName("data")] + public required SessionManagedSettingsResolvedData Data { get; set; } +} + +/// Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. +/// Represents the session.managed_settings_enforced event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionManagedSettingsEnforcedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.managed_settings_enforced"; + + /// The session.managed_settings_enforced event payload. + [JsonPropertyName("data")] + public required SessionManagedSettingsEnforcedData Data { get; set; } +} + /// SDK command registration change notification. /// Represents the commands.changed event. public sealed partial class CommandsChangedEvent : SessionEvent @@ -1154,7 +1433,7 @@ public sealed partial class ExitPlanModeCompletedEvent : SessionEvent public required ExitPlanModeCompletedData Data { get; set; } } -/// Schema for the `ToolsUpdatedData` type. +/// Payload of `session.tools_updated` identifying the model whose resolved tools were updated. /// Represents the session.tools_updated event. public sealed partial class SessionToolsUpdatedEvent : SessionEvent { @@ -1167,7 +1446,7 @@ public sealed partial class SessionToolsUpdatedEvent : SessionEvent public required SessionToolsUpdatedData Data { get; set; } } -/// Schema for the `BackgroundTasksChangedData` type. +/// Empty payload for `session.background_tasks_changed`, indicating background task state changed. /// Represents the session.background_tasks_changed event. public sealed partial class SessionBackgroundTasksChangedEvent : SessionEvent { @@ -1180,7 +1459,21 @@ public sealed partial class SessionBackgroundTasksChangedEvent : SessionEvent public required SessionBackgroundTasksChangedData Data { get; set; } } -/// Schema for the `SkillsLoadedData` type. +/// Ephemeral invalidation signal for a changed factory run. +/// Represents the factory.run_updated event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunUpdatedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "factory.run_updated"; + + /// The factory.run_updated event payload. + [JsonPropertyName("data")] + public required FactoryRunUpdatedData Data { get; set; } +} + +/// Payload of `session.skills_loaded` listing resolved skill metadata. /// Represents the session.skills_loaded event. public sealed partial class SessionSkillsLoadedEvent : SessionEvent { @@ -1193,7 +1486,7 @@ public sealed partial class SessionSkillsLoadedEvent : SessionEvent public required SessionSkillsLoadedData Data { get; set; } } -/// Schema for the `CustomAgentsUpdatedData` type. +/// Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. /// Represents the session.custom_agents_updated event. public sealed partial class SessionCustomAgentsUpdatedEvent : SessionEvent { @@ -1206,7 +1499,7 @@ public sealed partial class SessionCustomAgentsUpdatedEvent : SessionEvent public required SessionCustomAgentsUpdatedData Data { get; set; } } -/// Schema for the `McpServersLoadedData` type. +/// Payload of `session.mcp_servers_loaded` listing MCP server status summaries. /// Represents the session.mcp_servers_loaded event. public sealed partial class SessionMcpServersLoadedEvent : SessionEvent { @@ -1219,7 +1512,7 @@ public sealed partial class SessionMcpServersLoadedEvent : SessionEvent public required SessionMcpServersLoadedData Data { get; set; } } -/// Schema for the `McpServerStatusChangedData` type. +/// Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. /// Represents the session.mcp_server_status_changed event. public sealed partial class SessionMcpServerStatusChangedEvent : SessionEvent { @@ -1232,7 +1525,46 @@ public sealed partial class SessionMcpServerStatusChangedEvent : SessionEvent public required SessionMcpServerStatusChangedData Data { get; set; } } -/// Schema for the `ExtensionsLoadedData` type. +/// Payload identifying the MCP server associated with a list change. +/// Represents the mcp.tools.list_changed event. +public sealed partial class McpToolsListChangedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "mcp.tools.list_changed"; + + /// The mcp.tools.list_changed event payload. + [JsonPropertyName("data")] + public required McpToolsListChangedData Data { get; set; } +} + +/// Payload identifying the MCP server associated with a list change. +/// Represents the mcp.resources.list_changed event. +public sealed partial class McpResourcesListChangedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "mcp.resources.list_changed"; + + /// The mcp.resources.list_changed event payload. + [JsonPropertyName("data")] + public required McpResourcesListChangedData Data { get; set; } +} + +/// Payload identifying the MCP server associated with a list change. +/// Represents the mcp.prompts.list_changed event. +public sealed partial class McpPromptsListChangedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "mcp.prompts.list_changed"; + + /// The mcp.prompts.list_changed event payload. + [JsonPropertyName("data")] + public required McpPromptsListChangedData Data { get; set; } +} + +/// Payload of `session.extensions_loaded` listing discovered extensions and their statuses. /// Represents the session.extensions_loaded event. public sealed partial class SessionExtensionsLoadedEvent : SessionEvent { @@ -1245,8 +1577,9 @@ public sealed partial class SessionExtensionsLoadedEvent : SessionEvent public required SessionExtensionsLoadedData Data { get; set; } } -/// Schema for the `CanvasOpenedData` type. +/// Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. /// Represents the session.canvas.opened event. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionCanvasOpenedEvent : SessionEvent { /// @@ -1258,8 +1591,9 @@ public sealed partial class SessionCanvasOpenedEvent : SessionEvent public required SessionCanvasOpenedData Data { get; set; } } -/// Schema for the `CanvasRegistryChangedData` type. +/// Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. /// Represents the session.canvas.registry_changed event. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionCanvasRegistryChangedEvent : SessionEvent { /// @@ -1271,6 +1605,75 @@ public sealed partial class SessionCanvasRegistryChangedEvent : SessionEvent public required SessionCanvasRegistryChangedData Data { get; set; } } +/// Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. +/// Represents the session.canvas.closed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasClosedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.canvas.closed"; + + /// The session.canvas.closed event payload. + [JsonPropertyName("data")] + public required SessionCanvasClosedData Data { get; set; } +} + +/// Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. +/// Represents the session.canvas.unavailable event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasUnavailableEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.canvas.unavailable"; + + /// The session.canvas.unavailable event payload. + [JsonPropertyName("data")] + public required SessionCanvasUnavailableData Data { get; set; } +} + +/// Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. +/// Represents the session.canvas.recorded event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasRecordedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.canvas.recorded"; + + /// The session.canvas.recorded event payload. + [JsonPropertyName("data")] + public required SessionCanvasRecordedData Data { get; set; } +} + +/// Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. +/// Represents the session.canvas.removed event. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasRemovedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.canvas.removed"; + + /// The session.canvas.removed event payload. + [JsonPropertyName("data")] + public required SessionCanvasRemovedData Data { get; set; } +} + +/// Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. +/// Represents the session.extensions.attachments_pushed event. +public sealed partial class SessionExtensionsAttachmentsPushedEvent : SessionEvent +{ + /// + [JsonIgnore] + public override string Type => "session.extensions.attachments_pushed"; + + /// The session.extensions.attachments_pushed event payload. + [JsonPropertyName("data")] + public required SessionExtensionsAttachmentsPushedData Data { get; set; } +} + /// MCP App view called a tool on a connected MCP server (SEP-1865). /// Represents the mcp_app.tool_call_complete event. public sealed partial class McpAppToolCallCompleteEvent : SessionEvent @@ -1300,7 +1703,7 @@ public sealed partial class SessionStartData /// Context tier selected at session creation time for models with tiered context pricing; null when no tier is selected (e.g., non-tiered model). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("contextTier")] - public SessionStartDataContextTier? ContextTier { get; set; } + public ContextTier? ContextTier { get; set; } /// Version string of the Copilot application. [JsonPropertyName("copilotVersion")] @@ -1311,6 +1714,11 @@ public sealed partial class SessionStartData [JsonPropertyName("detachedFromSpawningParentSessionId")] public string? DetachedFromSpawningParentSessionId { get; set; } + /// Per-session GitHub MCP override persisted for cold resume. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("githubMcpToolConfig")] + public GitHubMcpToolConfig? GitHubMcpToolConfig { get; set; } + /// Identifier of the software producing the events (e.g., "copilot-agent"). [JsonPropertyName("producer")] public required string Producer { get; set; } @@ -1339,10 +1747,20 @@ public sealed partial class SessionStartData [JsonPropertyName("sessionId")] public required string SessionId { get; set; } + /// Session limits configured at session creation time, if any. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { get; set; } + /// ISO 8601 timestamp when the session was created. [JsonPropertyName("startTime")] public required DateTimeOffset StartTime { get; set; } + /// Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high"). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } + /// Schema version number for the session event format. [JsonPropertyName("version")] public required long Version { get; set; } @@ -1364,9 +1782,9 @@ public sealed partial class SessionResumeData /// Context tier currently selected at resume time; null when no tier is active. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("contextTier")] - public SessionResumeDataContextTier? ContextTier { get; set; } + public ContextTier? ContextTier { get; set; } - /// 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. + /// 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 or omitted, pending work is normally marked as interrupted unless the resume passively joined live work owned by another client; sessionWasActive distinguishes that case. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("continuePendingWork")] public bool? ContinuePendingWork { get; set; } @@ -1375,6 +1793,11 @@ public sealed partial class SessionResumeData [JsonPropertyName("eventCount")] public required long EventCount { get; set; } + /// On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("eventsFileSizeBytes")] + public long? EventsFileSizeBytes { get; set; } + /// Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max"). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("reasoningEffort")] @@ -1399,10 +1822,20 @@ public sealed partial class SessionResumeData [JsonPropertyName("selectedModel")] public string? SelectedModel { get; set; } - /// 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. + /// Session limits currently configured at resume time; null when no limits are active. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { get; set; } + + /// True when this resume passively joined a session that already had live work running in the runtime - an agent turn, a native queue run, a queued resume continuation, or an in-flight send (for example, an extension joining a session another client was actively driving). False (or omitted) when the session had no live work or when the resume explicitly abandoned pending work, including cold resumes and suspended sessions that remain resident in memory. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("sessionWasActive")] public bool? SessionWasActive { get; set; } + + /// Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high"). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } } /// Notifies that the session's remote steering capability has changed. @@ -1460,7 +1893,7 @@ public sealed partial class SessionErrorData public string? Url { get; set; } } -/// Payload indicating the session is idle with no background agents in flight. +/// Payload indicating the session is idle with no background agents or attached shell commands in flight. public sealed partial class SessionIdleData { /// True when the preceding agentic loop was cancelled via abort signal. @@ -1480,6 +1913,16 @@ public sealed partial class SessionTitleChangedData /// Scheduled prompt registered via /every or /after. public sealed partial class SessionScheduleCreatedData { + /// Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("at")] + public long? At { get; set; } + + /// 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cron")] + public string? Cron { get; set; } + /// Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("displayPrompt")] @@ -1489,10 +1932,16 @@ public sealed partial class SessionScheduleCreatedData [JsonPropertyName("id")] public required long Id { get; set; } - /// Interval between ticks in milliseconds. + /// Interval between ticks in milliseconds (relative-interval schedules). [JsonConverter(typeof(MillisecondsTimeSpanConverter))] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("intervalMs")] - public required TimeSpan Interval { get; set; } + public TimeSpan? Interval { get; set; } + + /// Who created the schedule (`user` or `model`). Persisted so a resumed session keeps gating non-user schedules from firing skills that opted out of model invocation. Absent on entries created before this field existed; a missing origin fails closed (treated the same as a non-user origin), so such a schedule may not resolve a `disable-model-invocation` skill. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("origin")] + public ScheduleOrigin? Origin { get; set; } /// Prompt text that gets enqueued on every tick. [JsonPropertyName("prompt")] @@ -1502,6 +1951,16 @@ public sealed partial class SessionScheduleCreatedData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("recurring")] public bool? Recurring { get; set; } + + /// True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled rather than auto-computed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("selfPaced")] + public bool? SelfPaced { get; set; } + + /// IANA timezone the `cron` expression is evaluated in. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("tz")] + public string? Tz { get; set; } } /// Scheduled prompt cancelled from the schedule manager dialog. @@ -1512,6 +1971,18 @@ public sealed partial class SessionScheduleCancelledData public required long Id { get; set; } } +/// Self-paced schedule re-armed for its next run. +public sealed partial class SessionScheduleRearmedData +{ + /// Id of the self-paced schedule that was re-armed. + [JsonPropertyName("id")] + public required long Id { get; set; } + + /// Absolute time (epoch milliseconds) the model armed the next run to fire. + [JsonPropertyName("nextRunAt")] + public required long NextRunAt { get; set; } +} + /// Autopilot objective state file operation details indicating what changed. public sealed partial class SessionAutopilotObjectiveChangedData { @@ -1572,7 +2043,7 @@ public sealed partial class SessionWarningData /// Model change details including previous and new model identifiers. public sealed partial class SessionModelChangeData { - /// 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. + /// Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("cause")] public string? Cause { get; set; } @@ -1580,7 +2051,7 @@ public sealed partial class SessionModelChangeData /// Context tier after the model change; null explicitly clears a previously selected tier. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("contextTier")] - public SessionModelChangeDataContextTier? ContextTier { get; set; } + public ContextTier? ContextTier { get; set; } /// Newly selected model identifier. [JsonPropertyName("newModel")] @@ -1601,6 +2072,11 @@ public sealed partial class SessionModelChangeData [JsonPropertyName("previousReasoningSummary")] public ReasoningSummary? PreviousReasoningSummary { get; set; } + /// Output verbosity level before the model change, if applicable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("previousVerbosity")] + public Verbosity? PreviousVerbosity { get; set; } + /// Reasoning effort level after the model change, if applicable. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("reasoningEffort")] @@ -1610,6 +2086,11 @@ public sealed partial class SessionModelChangeData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("reasoningSummary")] public ReasoningSummary? ReasoningSummary { get; set; } + + /// Output verbosity level after the model change, if applicable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("verbosity")] + public Verbosity? Verbosity { get; set; } } /// Agent mode change details including previous and new modes. @@ -1624,13 +2105,33 @@ public sealed partial class SessionModeChangedData public required SessionMode PreviousMode { get; set; } } -/// Permissions change details carrying the aggregate allow-all boolean transition. +/// Session limits update details. Null clears the limits. +public sealed partial class SessionSessionLimitsChangedData +{ + /// Current session limits, or null when no limits are active. + [JsonPropertyName("sessionLimits")] + public SessionLimitsConfig? SessionLimits { get; set; } +} + +/// Permissions change details carrying the aggregate allow-all transition. public sealed partial class SessionPermissionsChangedData { + /// Allow-all mode after the change. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("allowAllPermissionMode")] + public PermissionAllowAllMode? AllowAllPermissionMode { get; set; } + /// Aggregate allow-all flag after the change. [JsonPropertyName("allowAllPermissions")] public required bool AllowAllPermissions { get; set; } + /// Allow-all mode before the change. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("previousAllowAllPermissionMode")] + public PermissionAllowAllMode? PreviousAllowAllPermissionMode { get; set; } + /// Aggregate allow-all flag before the change. [JsonPropertyName("previousAllowAllPermissions")] public required bool PreviousAllowAllPermissions { get; set; } @@ -1644,6 +2145,11 @@ public sealed partial class SessionPlanChangedData public required PlanChangedOperation Operation { get; set; } } +/// Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. +public sealed partial class SessionTodosChangedData +{ +} + /// Workspace file change details including path and operation type. public sealed partial class SessionWorkspaceFileChangedData { @@ -1768,6 +2274,11 @@ public sealed partial class SessionShutdownData [JsonPropertyName("errorReason")] public string? ErrorReason { get; set; } + /// On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("eventsFileSizeBytes")] + public long? EventsFileSizeBytes { get; set; } + /// Per-model usage breakdown, keyed by model identifier. [JsonPropertyName("modelMetrics")] public required IDictionary ModelMetrics { get; set; } @@ -1813,6 +2324,26 @@ public sealed partial class SessionShutdownData internal double? TotalPremiumRequests { get; set; } } +/// Durable session usage checkpoint for reconstructing aggregate accounting on resume. +public sealed partial class SessionUsageCheckpointData +{ + /// Internal per-model prompt-cache state used to restore expiration tracking on resume. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("modelCacheState")] + internal UsageCheckpointModelCacheState[]? ModelCacheState { get; set; } + + /// Session-wide accumulated nano-AI units cost at checkpoint time. + [JsonPropertyName("totalNanoAiu")] + public required double TotalNanoAiu { get; set; } + + /// Total number of premium API requests used at checkpoint time. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("totalPremiumRequests")] + internal double? TotalPremiumRequests { get; set; } +} + /// Working directory and git context at session start. public sealed partial class SessionContextChangedData { @@ -1845,6 +2376,11 @@ public sealed partial class SessionContextChangedData [JsonPropertyName("hostType")] public WorkingDirectoryContextHostType? HostType { get; set; } + /// Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pendingGitContext")] + public bool? PendingGitContext { get; set; } + /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("repository")] @@ -1892,6 +2428,19 @@ public sealed partial class SessionUsageInfoData public long? ToolDefinitionsTokens { get; set; } } +/// Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages). +public sealed partial class SessionContextClearedData +{ + /// Optional initial message set after clearing. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("initialMessage")] + public string? InitialMessage { get; set; } + + /// Number of conversation messages that were cleared. + [JsonPropertyName("messagesCleared")] + public required long MessagesCleared { get; set; } +} + /// Context window breakdown at the start of LLM-powered conversation compaction. public sealed partial class SessionCompactionStartData { @@ -1900,15 +2449,35 @@ public sealed partial class SessionCompactionStartData [JsonPropertyName("conversationTokens")] public long? ConversationTokens { get; set; } + /// Total context tokens (system + conversation + tool definitions) at compaction start, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("currentTokens")] + public long? CurrentTokens { get; set; } + + /// Model identifier used for compaction, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Token count from system message(s) at compaction start. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("systemTokens")] public long? SystemTokens { get; set; } + /// Model context window token limit the compaction is targeting, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("tokenLimit")] + public long? TokenLimit { get; set; } + /// Token count from tool definitions at compaction start. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolDefinitionsTokens")] public long? ToolDefinitionsTokens { get; set; } + + /// What initiated this compaction, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("trigger")] + public CompactionTrigger? Trigger { get; set; } } /// Conversation compaction results including success status, metrics, and optional error details. @@ -1974,6 +2543,11 @@ public sealed partial class SessionCompactionCompleteData [JsonPropertyName("serviceRequestId")] public string? ServiceRequestId { get; set; } + /// For failed compaction only: the HTTP status code of the compaction LLM call failure, when it carried one. Absent for successful compaction and for failures without an HTTP status (e.g. an empty model response or a transport error). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("statusCode")] + public long? StatusCode { get; set; } + /// Whether compaction completed successfully. [JsonPropertyName("success")] public required bool Success { get; set; } @@ -1988,6 +2562,11 @@ public sealed partial class SessionCompactionCompleteData [JsonPropertyName("systemTokens")] public long? SystemTokens { get; set; } + /// Model context window token limit the compaction was targeting, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("tokenLimit")] + public long? TokenLimit { get; set; } + /// Number of tokens removed during compaction. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("tokensRemoved")] @@ -1997,12 +2576,32 @@ public sealed partial class SessionCompactionCompleteData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolDefinitionsTokens")] public long? ToolDefinitionsTokens { get; set; } + + /// What initiated this compaction, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("trigger")] + public CompactionTrigger? Trigger { get; set; } } /// Task completion notification with summary from the agent. public sealed partial class SessionTaskCompleteData { - /// Whether the tool call succeeded. False when validation failed (e.g., invalid arguments). + /// Active autopilot objective ID evaluated by the completion reviewer. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("objectiveId")] + public long? ObjectiveId { get; set; } + + /// Semantic completion decision. Absent on legacy events and invalid tool calls. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outcome")] + public TaskCompletionOutcome? Outcome { get; set; } + + /// Label-safe runtime rationale for the completion decision (e.g. a cancellation or pause/resume downgrade), when one applies. Reviewer-authored rationale is intentionally omitted here because this event has no IFC label channel; the reviewer's findings remain available through its own labeled sub-agent events. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("success")] public bool? Success { get; set; } @@ -2013,7 +2612,7 @@ public sealed partial class SessionTaskCompleteData public string? Summary { get; set; } } -/// Schema for the `UserMessageData` type. +/// Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. public sealed partial class UserMessageData { /// The agent mode that was active when this message was sent. @@ -2024,12 +2623,17 @@ public sealed partial class UserMessageData /// Files, selections, or GitHub references attached to the message. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("attachments")] - public UserMessageAttachment[]? Attachments { get; set; } + public Attachment[]? Attachments { get; set; } /// The user's message text as displayed in the timeline. [JsonPropertyName("content")] public required string Content { get; set; } + /// How this message was delivered to the agentic loop relative to loop state (idle-start vs. steering/queued while busy). The timing axis; combine with `source` (origin) for the full picture. Used for telemetry attribution. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("delivery")] + public UserMessageDelivery? Delivery { get; set; } + /// CAPI interaction ID for correlating this user message with its turn. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("interactionId")] @@ -2050,7 +2654,7 @@ public sealed partial class UserMessageData [JsonPropertyName("parentAgentTaskId")] public string? ParentAgentTaskId { get; set; } - /// Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user). + /// Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-<agent-id>` for an inter-agent prompt). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("source")] public string? Source { get; set; } @@ -2079,11 +2683,34 @@ public sealed partial class AssistantTurnStartData [JsonPropertyName("interactionId")] public string? InteractionId { get; set; } + /// Model identifier used for this turn, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Identifier for this turn within the agentic loop, typically a stringified turn number. [JsonPropertyName("turnId")] public required string TurnId { get; set; } } +/// Metadata for an additional model inference attempt within an existing assistant turn. +public sealed partial class AssistantTurnRetryData +{ + /// Model identifier used for this retry, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Provider or runtime classification that caused the retry, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// Identifier of the turn whose model inference is being retried. + [JsonPropertyName("turnId")] + public required string TurnId { get; set; } +} + /// Agent intent description for current activity or plan. public sealed partial class AssistantIntentData { @@ -2092,6 +2719,22 @@ public sealed partial class AssistantIntentData public required string Intent { get; set; } } +/// Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message. +public sealed partial class AssistantServerToolProgressData +{ + /// Kind of hosted server tool that is running. Only `web_search` is emitted today. + [JsonPropertyName("kind")] + public required string Kind { get; set; } + + /// Position of the hosted tool call in the response output. Stable across the call's lifecycle events (unlike the provider's per-event item id, which CAPI rotates), so the host keys the live in-progress row on it. + [JsonPropertyName("outputIndex")] + public required long OutputIndex { get; set; } + + /// Lifecycle status of the hosted call: `in_progress`, `searching`, or `completed`. + [JsonPropertyName("status")] + public required string Status { get; set; } +} + /// Assistant reasoning content for timeline display with complete thinking text. public sealed partial class AssistantReasoningData { @@ -2102,6 +2745,11 @@ public sealed partial class AssistantReasoningData /// Unique identifier for this reasoning block. [JsonPropertyName("reasoningId")] public required string ReasoningId { get; set; } + + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } } /// Streaming reasoning delta for incremental extended thinking updates. @@ -2116,6 +2764,28 @@ public sealed partial class AssistantReasoningDeltaData public required string ReasoningId { get; set; } } +/// Streaming tool-call input delta for incremental tool-call updates. +public sealed partial class AssistantToolCallDeltaData +{ + /// Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input. + [JsonPropertyName("inputDelta")] + public required string InputDelta { get; set; } + + /// Tool call ID this delta belongs to, matching the corresponding assistant.message tool request. + [JsonPropertyName("toolCallId")] + public required string ToolCallId { get; set; } + + /// Name of the tool being invoked, when known from the stream. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolName")] + public string? ToolName { get; set; } + + /// Tool call type, when known from the stream. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolType")] + public AssistantMessageToolRequestType? ToolType { get; set; } +} + /// Streaming response progress with cumulative byte count. public sealed partial class AssistantStreamingDeltaData { @@ -2127,17 +2797,31 @@ public sealed partial class AssistantStreamingDeltaData /// Assistant response containing text content, optional tool requests, and interaction metadata. public sealed partial class AssistantMessageData { - /// Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping. - [Experimental(Diagnostics.Experimental)] + /// Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("anthropicAdvisorBlocks")] - public JsonElement[]? AnthropicAdvisorBlocks { get; set; } + [JsonPropertyName("apiCallId")] + public string? ApiCallId { get; set; } + + /// Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("chunkCount")] + public long? ChunkCount { get; set; } - /// Anthropic advisor model ID used for this response, for timeline display on replay. + /// Zero-based position of this message within its model call's response. Absent when the response was not split into chunks. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("chunkIndex")] + public long? ChunkIndex { get; set; } + + /// Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. [Experimental(Diagnostics.Experimental)] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("anthropicAdvisorModel")] - public string? AnthropicAdvisorModel { get; set; } + [JsonPropertyName("citations")] + public Citations? Citations { get; set; } + + /// Client-minted request id (x-request-id header) echoed by the server. Distinct from requestId (x-github-request-id) and serviceRequestId (x-copilot-service-request-id). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("clientRequestId")] + public string? ClientRequestId { get; set; } /// The assistant's text response content. [JsonPropertyName("content")] @@ -2169,7 +2853,9 @@ public sealed partial class AssistantMessageData /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] - [Obsolete("This member is deprecated and will be removed in a future version.")] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } @@ -2189,11 +2875,26 @@ public sealed partial class AssistantMessageData [JsonPropertyName("reasoningText")] public string? ReasoningText { get; set; } + /// OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningWireField")] + public string? ReasoningWireField { get; set; } + /// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("requestId")] public string? RequestId { get; set; } + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } + + /// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("serverTools")] + public AssistantMessageServerTools? ServerTools { get; set; } + /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("serviceRequestId")] @@ -2236,7 +2937,9 @@ public sealed partial class AssistantMessageDeltaData /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] - [Obsolete("This member is deprecated and will be removed in a future version.")] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } @@ -2245,11 +2948,25 @@ public sealed partial class AssistantMessageDeltaData /// Turn completion metadata including the turn identifier. public sealed partial class AssistantTurnEndData { + /// Model identifier used for this turn, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Identifier of the turn that has ended, matching the corresponding assistant.turn_start event. [JsonPropertyName("turnId")] public required string TurnId { get; set; } } +/// Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred. +public sealed partial class AssistantIdleData +{ + /// True when the preceding agentic loop was cancelled via abort signal. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("aborted")] + public bool? Aborted { get; set; } +} + /// LLM API call usage metrics including tokens, costs, quotas, and billing information. public sealed partial class AssistantUsageData { @@ -2263,6 +2980,17 @@ public sealed partial class AssistantUsageData [JsonPropertyName("apiEndpoint")] public AssistantUsageApiEndpoint? ApiEndpoint { get; set; } + /// Number of tools available to the model for this call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("availableToolCount")] + internal long? AvailableToolCount { get; set; } + + /// Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cacheExpiresAt")] + public DateTimeOffset? CacheExpiresAt { get; set; } + /// Number of tokens read from prompt cache. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("cacheReadTokens")] @@ -2273,11 +3001,15 @@ public sealed partial class AssistantUsageData [JsonPropertyName("cacheWriteTokens")] public long? CacheWriteTokens { get; set; } + /// Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("contentFilterTriggered")] + public bool? ContentFilterTriggered { get; set; } + /// Per-request cost and usage data from the CAPI copilot_usage response field. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonInclude] [JsonPropertyName("copilotUsage")] - internal AssistantUsageCopilotUsage? CopilotUsage { get; set; } + public AssistantUsageCopilotUsage? CopilotUsage { get; set; } /// Model multiplier cost for billing purposes. [Experimental(Diagnostics.Experimental)] @@ -2291,6 +3023,11 @@ public sealed partial class AssistantUsageData [JsonPropertyName("duration")] public TimeSpan? Duration { get; set; } + /// Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter". + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("finishReason")] + public string? FinishReason { get; set; } + /// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("initiator")] @@ -2301,6 +3038,11 @@ public sealed partial class AssistantUsageData [JsonPropertyName("inputTokens")] public long? InputTokens { get; set; } + /// Coarse classification of the interaction that produced this call, mirroring the session's per-request agent context (e.g. `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, `conversation-user`). Non-billing; lets consumers attribute a model call to a call class (e.g. sub-agent/sidekick) independently of the billing initiator. Absent when the runtime did not classify the request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interactionType")] + public string? InteractionType { get; set; } + /// Average inter-token latency in milliseconds. Only available for streaming requests. [JsonConverter(typeof(MillisecondsTimeSpanConverter))] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -2311,6 +3053,12 @@ public sealed partial class AssistantUsageData [JsonPropertyName("model")] public required string Model { get; set; } + /// Number of tool calls returned by the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("numToolCalls")] + internal long? NumToolCalls { get; set; } + /// Number of output tokens produced. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("outputTokens")] @@ -2318,7 +3066,9 @@ public sealed partial class AssistantUsageData /// Parent tool call ID when this usage originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] - [Obsolete("This member is deprecated and will be removed in a future version.")] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } @@ -2344,6 +3094,11 @@ public sealed partial class AssistantUsageData [JsonPropertyName("reasoningTokens")] public long? ReasoningTokens { get; set; } + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } + /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("serviceRequestId")] @@ -2354,6 +3109,18 @@ public sealed partial class AssistantUsageData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("timeToFirstTokenMs")] public TimeSpan? TimeToFirstToken { get; set; } + + /// Tool-call counts keyed by tool name. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolCounts")] + internal IDictionary? ToolCounts { get; set; } + + /// Number of tokens used by tool definitions for this call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("toolTokenCount")] + internal long? ToolTokenCount { get; set; } } /// Failed LLM API call metadata for telemetry. @@ -2364,22 +3131,67 @@ public sealed partial class ModelCallFailureData [JsonPropertyName("apiCallId")] public string? ApiCallId { get; set; } + /// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("apiEndpoint")] + public AssistantUsageApiEndpoint? ApiEndpoint { get; set; } + + /// For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("badRequestKind")] + public ModelCallFailureBadRequestKind? BadRequestKind { get; set; } + /// Duration of the failed API call in milliseconds. [JsonConverter(typeof(MillisecondsTimeSpanConverter))] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("durationMs")] public TimeSpan? Duration { get; set; } + /// For HTTP 400 failures only: the `code` from the CAPI error envelope (e.g. 'model_max_prompt_tokens_exceeded') identifying which deterministic validation failure occurred. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("errorCode")] + public string? ErrorCode { get; set; } + /// Raw provider/runtime error message for restricted telemetry. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("errorMessage")] public string? ErrorMessage { get; set; } + /// For HTTP 400 failures only: the `type` from the CAPI error envelope (e.g. 'websocket_error'), a coarser companion to errorCode for envelopes that carry no code. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("errorType")] + public string? ErrorType { get; set; } + + /// Whether the failure originated from an API response or the request transport. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("failureKind")] + public ModelCallFailureKind? FailureKind { get; set; } + /// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("initiator")] public string? Initiator { get; set; } + /// Whether the session selected Auto mode for the failed call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isAuto")] + public bool? IsAuto { get; set; } + + /// Whether the failed call used a bring-your-own-key provider. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("isByok")] + public bool? IsByok { get; set; } + + /// Effective maximum output-token limit for the failed call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxOutputTokens")] + public long? MaxOutputTokens { get; set; } + + /// Effective maximum prompt-token limit for the failed call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxPromptTokens")] + public long? MaxPromptTokens { get; set; } + /// Model identifier used for the failed API call. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] @@ -2390,6 +3202,27 @@ public sealed partial class ModelCallFailureData [JsonPropertyName("providerCallId")] public string? ProviderCallId { get; set; } + /// Per-quota usage snapshots parsed from the failed response's quota headers, keyed by quota identifier. Present when the error response carried quota headers (e.g. a 402 once the additional spend limit is reached) so the UI can refresh the quota display on failure. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("quotaSnapshots")] + internal IDictionary? QuotaSnapshots { get; set; } + + /// Reasoning effort level used for the failed model call, if applicable. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } + + /// Content-free structural summary of the failing request. Contains only counts and shape flags (no prompt content), so it is safe for unrestricted telemetry. Populated only for client-error (4xx) failures. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestFingerprint")] + public ModelCallFailureRequestFingerprint? RequestFingerprint { get; set; } + + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } + /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("serviceRequestId")] @@ -2403,6 +3236,30 @@ public sealed partial class ModelCallFailureData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("statusCode")] public int? StatusCode { get; set; } + + /// Transport used for the failed model call (http or websocket). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("transport")] + public ModelCallFailureTransport? Transport { get; set; } +} + +/// Model API dispatch metadata for internal telemetry. +public sealed partial class ModelCallStartData +{ + /// Model identifier used for this API call, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Previous response or interaction identifier included in the model request, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("previousResponseId")] + internal string? PreviousResponseId { get; set; } + + /// Identifier of the assistant turn that initiated the model call. + [JsonPropertyName("turnId")] + public required string TurnId { get; set; } } /// Turn abort information including the reason for termination. @@ -2453,17 +3310,39 @@ public sealed partial class ToolExecutionStartData [JsonPropertyName("mcpToolName")] public string? McpToolName { get; set; } + /// Model identifier that generated this tool call. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] - [Obsolete("This member is deprecated and will be removed in a future version.")] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } + + /// Shell-tool path hints derived from the command at start time for shell tools (bash/powershell/local_shell). Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. Absent for non-shell tools. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("shellToolInfo")] + public ToolExecutionStartShellToolInfo? ShellToolInfo { get; set; } + /// Unique identifier for this tool call. [JsonPropertyName("toolCallId")] public required string ToolCallId { get; set; } + /// Tool definition metadata, present for MCP tools with MCP Apps support. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolDescription")] + public ToolExecutionStartToolDescription? ToolDescription { get; set; } + /// Name of the tool being executed. [JsonPropertyName("toolName")] public required string ToolName { get; set; } @@ -2516,6 +3395,12 @@ public sealed partial class ToolExecutionCompleteData [JsonPropertyName("isUserRequested")] public bool? IsUserRequested { get; set; } + /// FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels). Persisted as `{ ifc: ... }` so the label survives session resume, including model-visible failure results. Experimental. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mcpMeta")] + public JsonElement? McpMeta { get; set; } + /// Model identifier that generated this tool call. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] @@ -2523,7 +3408,9 @@ public sealed partial class ToolExecutionCompleteData /// Tool call ID of the parent tool invocation when this event originates from a sub-agent. [EditorBrowsable(EditorBrowsableState.Never)] - [Obsolete("This member is deprecated and will be removed in a future version.")] +#if NET5_0_OR_GREATER + [Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("parentToolCallId")] public string? ParentToolCallId { get; set; } @@ -2533,6 +3420,11 @@ public sealed partial class ToolExecutionCompleteData [JsonPropertyName("result")] public ToolExecutionCompleteResult? Result { get; set; } + /// Gets or sets the rte value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rte")] + public bool? Rte { get; set; } + /// Whether this tool execution ran inside a sandbox container. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("sandboxed")] @@ -2562,6 +3454,18 @@ public sealed partial class ToolExecutionCompleteData public string? TurnId { get; set; } } +/// Persisted generic client-side tool activations restored when a session resumes. +public sealed partial class ToolSearchActivatedData +{ + /// Tool-search strategy that activated the definitions. + [JsonPropertyName("strategy")] + public required string Strategy { get; set; } + + /// Names of tool definitions activated by this search invocation. + [JsonPropertyName("toolNames")] + public required string[] ToolNames { get; set; } +} + /// Skill invocation details including content, allowed tools, and plugin metadata. public sealed partial class SkillInvokedData { @@ -2579,6 +3483,11 @@ public sealed partial class SkillInvokedData [JsonPropertyName("description")] public string? Description { get; set; } + /// Model identifier active when the skill was invoked, when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + /// Name of the invoked skill. [JsonPropertyName("name")] public required string Name { get; set; } @@ -2597,7 +3506,7 @@ public sealed partial class SkillInvokedData [JsonPropertyName("pluginVersion")] public string? PluginVersion { get; set; } - /// Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill). + /// Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("source")] public string? Source { get; set; } @@ -2623,7 +3532,7 @@ public sealed partial class SubagentStartedData [JsonPropertyName("agentName")] public required string AgentName { get; set; } - /// Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck). + /// Model the sub-agent will run with, when known at start. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] public string? Model { get; set; } @@ -2644,6 +3553,11 @@ public sealed partial class SubagentCompletedData [JsonPropertyName("agentName")] public required string AgentName { get; set; } + /// Whether the sub-agent was torn down by cancellation - its own abort, or an ancestor being killed - instead of finishing its work. Cancellation is not a failure, so the run still reports completion; this distinguishes a torn-down sub-agent from one that ran to the end. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cancelled")] + public bool? Cancelled { get; set; } + /// Wall-clock duration of the sub-agent execution in milliseconds. [JsonConverter(typeof(MillisecondsTimeSpanConverter))] [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -2691,7 +3605,7 @@ public sealed partial class SubagentFailedData [JsonPropertyName("error")] public required string Error { get; set; } - /// Model used by the sub-agent (if any model calls succeeded before failure). + /// Model selected for the sub-agent, when known. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("model")] public string? Model { get; set; } @@ -2781,6 +3695,46 @@ public sealed partial class HookProgressData /// Human-readable progress message from the hook process. [JsonPropertyName("message")] public required string Message { get; set; } + + /// When true, this status message replaces the previous temporary one instead of accumulating. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("temporary")] + public bool? Temporary { get; set; } +} + +/// Canonical bytes for a content-addressed binary asset shared by reference across events. +public sealed partial class SessionBinaryAssetData +{ + /// Content-addressed id for this binary asset (e.g. "sha256:..."). + [JsonPropertyName("assetId")] + public required string AssetId { get; set; } + + /// Decoded byte length of the binary asset. + [JsonPropertyName("byteLength")] + public required long ByteLength { get; set; } + + /// Base64-encoded binary data. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// Human-readable description of the binary data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Optional metadata from the producing tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// MIME type of the binary asset. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } + + /// Binary asset type discriminator. Use "image" for images and "resource" otherwise. + [JsonPropertyName("type")] + public required BinaryAssetType Type { get; set; } } /// System/developer instruction content with role and optional template metadata. @@ -2790,6 +3744,11 @@ public sealed partial class SystemMessageData [JsonPropertyName("content")] public required string Content { get; set; } + /// Logical interaction identifier for the model run receiving this prompt. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("interactionId")] + public string? InteractionId { get; set; } + /// Metadata about the prompt template and its construction. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("metadata")] @@ -2837,6 +3796,11 @@ public sealed partial class PermissionRequestedData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("resolvedByHook")] public bool? ResolvedByHook { get; set; } + + /// Neutral risk metadata supplied by the tool host. Consumers may display this value but must not use it to bypass the permission decision. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("riskAssessment")] + public JsonElement? RiskAssessment { get; set; } } /// Permission request completion notification signaling UI dismissal. @@ -2983,10 +3947,24 @@ public sealed partial class SamplingCompletedData /// OAuth authentication request for an MCP server. public sealed partial class McpOauthRequiredData { - /// Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth(). + /// Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. Header order and casing are transport-dependent, and duplicate header names may appear multiple times. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("httpResponse")] + public McpOauthHttpResponse? HttpResponse { get; set; } + + /// Why the runtime is requesting host-provided OAuth credentials. + [JsonPropertyName("reason")] + public required McpOauthRequestReason Reason { get; set; } + + /// Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest. [JsonPropertyName("requestId")] public required string RequestId { get; set; } + /// Raw OAuth protected-resource metadata document fetched for the MCP server, if available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceMetadata")] + public string? ResourceMetadata { get; set; } + /// Display name of the MCP server that requires OAuth. [JsonPropertyName("serverName")] public required string ServerName { get; set; } @@ -2999,27 +3977,68 @@ public sealed partial class McpOauthRequiredData [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("staticClientConfig")] public McpOauthRequiredStaticClientConfig? StaticClientConfig { get; set; } + + /// OAuth WWW-Authenticate parameters parsed from the auth challenge, if available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("wwwAuthenticateParams")] + public McpOauthWWWAuthenticateParams? WwwAuthenticateParams { get; set; } } /// MCP OAuth request completion notification. public sealed partial class McpOauthCompletedData { + /// How the pending OAuth request was completed. + [JsonPropertyName("outcome")] + public required McpOauthCompletionOutcome Outcome { get; set; } + /// Request ID of the resolved OAuth request. [JsonPropertyName("requestId")] public required string RequestId { get; set; } } -/// Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. -public sealed partial class SessionCustomNotificationData +/// Dynamic headers refresh request for a remote MCP server. +public sealed partial class McpHeadersRefreshRequiredData { - /// Source-defined custom notification name. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("name")] - public required string Name { get; set; } + /// Why dynamic headers are being requested. + [JsonPropertyName("reason")] + public required McpHeadersRefreshRequiredReason Reason { get; set; } - /// Source-defined JSON payload for the custom notification. - [JsonPropertyName("payload")] + /// Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest(). + [JsonPropertyName("requestId")] + public required string RequestId { get; set; } + + /// Display name of the remote MCP server requesting headers. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } + + /// URL of the remote MCP server requesting headers. + [JsonPropertyName("serverUrl")] + public required string ServerUrl { get; set; } +} + +/// MCP headers refresh request completion notification. +public sealed partial class McpHeadersRefreshCompletedData +{ + /// How the pending MCP headers refresh request resolved. + [JsonPropertyName("outcome")] + public required McpHeadersRefreshCompletedOutcome Outcome { get; set; } + + /// Request ID of the resolved headers refresh request. + [JsonPropertyName("requestId")] + public required string RequestId { get; set; } +} + +/// Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. +public sealed partial class SessionCustomNotificationData +{ + /// Source-defined custom notification name. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Source-defined JSON payload for the custom notification. + [JsonPropertyName("payload")] public required JsonElement Payload { get; set; } /// Namespace for the custom notification producer. @@ -3157,6 +4176,183 @@ public sealed partial class AutoModeSwitchCompletedData public required AutoModeSwitchResponse Response { get; set; } } +/// Session limit exhaustion notification requiring user action. +public sealed partial class SessionLimitsExhaustedRequestedData +{ + /// Configured max AI Credits for the current accounting window. + [JsonPropertyName("maxAiCredits")] + public required double MaxAiCredits { get; set; } + + /// Unique identifier for this request; used to respond via session.ui.handlePendingSessionLimitsExhausted(). + [JsonPropertyName("requestId")] + public required string RequestId { get; set; } + + /// AI Credits already consumed in the current accounting window. + [JsonPropertyName("usedAiCredits")] + public required double UsedAiCredits { get; set; } +} + +/// Session limit exhaustion prompt completion notification. +public sealed partial class SessionLimitsExhaustedCompletedData +{ + /// Request ID of the resolved request; clients should dismiss any UI for this request. + [JsonPropertyName("requestId")] + public required string RequestId { get; set; } + + /// The user's selected session-limit action. + [JsonPropertyName("response")] + public required SessionLimitsExhaustedResponse Response { get; set; } +} + +/// Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionAutoModeResolvedData +{ + /// Models offered to the router for this resolution. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("availableModels")] + public string[]? AvailableModels { get; set; } + + /// Ordered candidate model list the router returned, when not a fallback. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("candidateModels")] + public string[]? CandidateModels { get; set; } + + /// Per-category classifier scores (0-1) behind the bucket: the granular HYDRA capability scores (reasoning, code_gen, debugging, tool_use), or the binary needs_reasoning/no_reasoning scores when HYDRA didn't run. Lets clients show a breakdown rather than just the bucket. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("categoryScores")] + public IDictionary? CategoryScores { get; set; } + + /// The concrete model the session will use after any intent refinement. + [JsonPropertyName("chosenModel")] + public required string ChosenModel { get; set; } + + /// The chosen model's score shortfall relative to the top candidate. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("chosenShortfall")] + public double? ChosenShortfall { get; set; } + + /// Classifier confidence for the predicted label, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("confidence")] + public double? Confidence { get; set; } + + /// End-to-end client wait time for the router request in milliseconds. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("endToEndLatencyMs")] + public double? EndToEndLatencyMs { get; set; } + + /// Whether the router fell back to the standard Auto selection. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fallback")] + public bool? Fallback { get; set; } + + /// Server-provided reason for falling back, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("fallbackReason")] + public string? FallbackReason { get; set; } + + /// Whether the routed prompt contained an image. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("hasImage")] + public bool? HasImage { get; set; } + + /// The predicted classifier label (e.g. `needs_reasoning`), when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("predictedLabel")] + public string? PredictedLabel { get; set; } + + /// Coarse request-difficulty bucket, for explaining why a model was chosen ("picked X because this looks like high-reasoning work"). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reasoningBucket")] + public AutoModeResolvedReasoningBucket? ReasoningBucket { get; set; } + + /// Server-reported router processing time in milliseconds. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("routerLatencyMs")] + public double? RouterLatencyMs { get; set; } + + /// The routing method the server applied, when Auto Intent ran. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("routingMethod")] + public string? RoutingMethod { get; set; } + + /// Whether a sticky model choice overrode the router result. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("stickyOverride")] + public bool? StickyOverride { get; set; } +} + +/// Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionManagedSettingsResolvedData +{ + /// Whether enterprise policy disables bypass-permissions ("yolo") mode for this session. Deny-wins across layers, and forced on when `failClosed` is true. + [JsonPropertyName("bypassPermissionsDisabled")] + public required bool BypassPermissionsDisabled { get; set; } + + /// Whether a session-local permissions layer injected by the SDK host was present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("clientManaged")] + public bool? ClientManaged { get; set; } + + /// Whether an actual device MDM/plist/registry/file managed-settings layer was present. + [JsonPropertyName("deviceManaged")] + public required bool DeviceManaged { get; set; } + + /// Whether managed policy could not be determined (e.g. a failed server fetch) and the session fell back to the fail-closed restriction. When true, restrictions such as disabling bypass-permissions are enforced even though `settings` may be absent. + [JsonPropertyName("failClosed")] + public required bool FailClosed { get; set; } + + /// The setting keys under enterprise management in the effective managed settings (e.g. `model`, `enabledPlugins`, `permissions`). Empty when no managed settings are in force. + [JsonPropertyName("managedKeys")] + public required string[] ManagedKeys { get; set; } + + /// Whether at least two managed sources supplied permission allowlists, so enforcement intersects them and the flattened settings payload omits `permissions.allow`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("permissionsAllowIntersected")] + public bool? PermissionsAllowIntersected { get; set; } + + /// Whether the server (account/org) managed-settings layer was present. + [JsonPropertyName("serverManaged")] + public required bool ServerManaged { get; set; } + + /// The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("settings")] + public JsonElement? Settings { get; set; } + + /// Channel summary: `server`, `device`, or `client` when exactly one channel contributed; `mixed` when multiple channels contributed; otherwise `none`. Consult the per-channel booleans for exact provenance. + [JsonPropertyName("source")] + public required ManagedSettingsResolvedSource Source { get; set; } +} + +/// Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionManagedSettingsEnforcedData +{ + /// The category of runtime action that managed policy governed. + [JsonPropertyName("action")] + public required ManagedSettingsEnforcedAction Action { get; set; } + + /// For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused. Absent for actions without a specific escalation primitive. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("escalation")] + public ManagedSettingsEnforcedEscalation? Escalation { get; set; } + + /// Whether the enforcement was forced by fail-closed handling (managed policy could not be determined) rather than an explicit managed setting. When true, `setting` still names the restriction that was applied. + [JsonPropertyName("failClosed")] + public required bool FailClosed { get; set; } + + /// A human-readable explanation of why the action was governed, suitable for surfacing to the user. + [JsonPropertyName("message")] + public required string Message { get; set; } + + /// The managed setting key responsible for the enforcement (e.g. `permissions.disableBypassPermissionsMode`). + [JsonPropertyName("setting")] + public required string Setting { get; set; } +} + /// SDK command registration change notification. public sealed partial class CommandsChangedData { @@ -3226,7 +4422,7 @@ public sealed partial class ExitPlanModeCompletedData public ExitPlanModeAction? SelectedAction { get; set; } } -/// Schema for the `ToolsUpdatedData` type. +/// Payload of `session.tools_updated` identifying the model whose resolved tools were updated. public sealed partial class SessionToolsUpdatedData { /// Identifier of the model the resolved tools apply to. @@ -3234,12 +4430,25 @@ public sealed partial class SessionToolsUpdatedData public required string Model { get; set; } } -/// Schema for the `BackgroundTasksChangedData` type. +/// Empty payload for `session.background_tasks_changed`, indicating background task state changed. public sealed partial class SessionBackgroundTasksChangedData { } -/// Schema for the `SkillsLoadedData` type. +/// Ephemeral invalidation signal for a changed factory run. +[Experimental(Diagnostics.Experimental)] +public sealed partial class FactoryRunUpdatedData +{ + /// Monotonic revision now available for the run. + [JsonPropertyName("revision")] + public required long Revision { get; set; } + + /// Gets or sets the runId value. + [JsonPropertyName("runId")] + public required string RunId { get; set; } +} + +/// Payload of `session.skills_loaded` listing resolved skill metadata. public sealed partial class SessionSkillsLoadedData { /// Array of resolved skill metadata. @@ -3247,7 +4456,7 @@ public sealed partial class SessionSkillsLoadedData public required SkillsLoadedSkill[] Skills { get; set; } } -/// Schema for the `CustomAgentsUpdatedData` type. +/// Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. public sealed partial class SessionCustomAgentsUpdatedData { /// Array of loaded custom agent metadata. @@ -3263,7 +4472,7 @@ public sealed partial class SessionCustomAgentsUpdatedData public required string[] Warnings { get; set; } } -/// Schema for the `McpServersLoadedData` type. +/// Payload of `session.mcp_servers_loaded` listing MCP server status summaries. public sealed partial class SessionMcpServersLoadedData { /// Array of MCP server status summaries. @@ -3271,7 +4480,7 @@ public sealed partial class SessionMcpServersLoadedData public required McpServersLoadedServer[] Servers { get; set; } } -/// Schema for the `McpServerStatusChangedData` type. +/// Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. public sealed partial class SessionMcpServerStatusChangedData { /// Error message if the server entered a failed state. @@ -3283,12 +4492,36 @@ public sealed partial class SessionMcpServerStatusChangedData [JsonPropertyName("serverName")] public required string ServerName { get; set; } - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured. + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured. [JsonPropertyName("status")] public required McpServerStatus Status { get; set; } } -/// Schema for the `ExtensionsLoadedData` type. +/// Payload identifying the MCP server associated with a list change. +public sealed partial class McpToolsListChangedData +{ + /// Name of the MCP server whose list changed. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Payload identifying the MCP server associated with a list change. +public sealed partial class McpResourcesListChangedData +{ + /// Name of the MCP server whose list changed. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Payload identifying the MCP server associated with a list change. +public sealed partial class McpPromptsListChangedData +{ + /// Name of the MCP server whose list changed. + [JsonPropertyName("serverName")] + public required string ServerName { get; set; } +} + +/// Payload of `session.extensions_loaded` listing discovered extensions and their statuses. public sealed partial class SessionExtensionsLoadedData { /// Array of discovered extensions and their status. @@ -3296,13 +4529,10 @@ public sealed partial class SessionExtensionsLoadedData public required ExtensionsLoadedExtension[] Extensions { get; set; } } -/// Schema for the `CanvasOpenedData` type. +/// Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionCanvasOpenedData { - /// Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. - [JsonPropertyName("availability")] - public required CanvasOpenedAvailability Availability { get; set; } - /// Provider-local canvas identifier. [JsonPropertyName("canvasId")] public required string CanvasId { get; set; } @@ -3316,6 +4546,11 @@ public sealed partial class SessionCanvasOpenedData [JsonPropertyName("extensionName")] public string? ExtensionName { get; set; } + /// Host-local PNG path for the canvas icon, when supplied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("icon")] + public string? Icon { get; set; } + /// Input supplied when the instance was opened. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("input")] @@ -3325,10 +4560,6 @@ public sealed partial class SessionCanvasOpenedData [JsonPropertyName("instanceId")] public required string InstanceId { get; set; } - /// Whether this notification represents an idempotent reopen. - [JsonPropertyName("reopen")] - public required bool Reopen { get; set; } - /// Provider-supplied status text. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("status")] @@ -3345,7 +4576,8 @@ public sealed partial class SessionCanvasOpenedData public string? Url { get; set; } } -/// Schema for the `CanvasRegistryChangedData` type. +/// Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. +[Experimental(Diagnostics.Experimental)] public sealed partial class SessionCanvasRegistryChangedData { /// Canvas declarations currently available. @@ -3353,6 +4585,100 @@ public sealed partial class SessionCanvasRegistryChangedData public required CanvasRegistryChangedCanvas[] Canvases { get; set; } } +/// Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasClosedData +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public required string CanvasId { get; set; } + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Stable caller-supplied identifier of the canvas instance that was closed. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("instanceId")] + public required string InstanceId { get; set; } +} + +/// Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasUnavailableData +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public required string CanvasId { get; set; } + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Stable caller-supplied identifier of the canvas instance whose provider became unavailable. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("instanceId")] + public required string InstanceId { get; set; } +} + +/// Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasRecordedData +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public required string CanvasId { get; set; } + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Input supplied when the instance was opened. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("input")] + public JsonElement? Input { get; set; } + + /// Stable caller-supplied canvas instance identifier. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("instanceId")] + public required string InstanceId { get; set; } + + /// Rendered title. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } +} + +/// Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. +[Experimental(Diagnostics.Experimental)] +public sealed partial class SessionCanvasRemovedData +{ + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public required string CanvasId { get; set; } + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Stable caller-supplied identifier of the canvas instance that was closed. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("instanceId")] + public required string InstanceId { get; set; } +} + +/// Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. +public sealed partial class SessionExtensionsAttachmentsPushedData +{ + /// Attachments contributed by an extension; the host should surface these as composer pills and forward them via the next session.send call. + [JsonPropertyName("attachments")] + public required Attachment[] Attachments { get; set; } +} + /// MCP App view called a tool on a connected MCP server (SEP-1865). public sealed partial class McpAppToolCallCompleteData { @@ -3426,6 +4752,11 @@ public sealed partial class WorkingDirectoryContext [JsonPropertyName("hostType")] public WorkingDirectoryContextHostType? HostType { get; set; } + /// Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("pendingGitContext")] + public bool? PendingGitContext { get; set; } + /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("repository")] @@ -3437,6 +4768,16 @@ public sealed partial class WorkingDirectoryContext public string? RepositoryHost { get; set; } } +/// Optional session limits. +/// Nested data type for SessionLimitsConfig. +public sealed partial class SessionLimitsConfig +{ + /// Maximum AI Credits allowed across the session's current accounting window. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } +} + /// Repository context for the handed-off session. /// Nested data type for HandoffRepository. public sealed partial class HandoffRepository @@ -3489,7 +4830,7 @@ public sealed partial class ShutdownModelMetricRequests public long? Count { get; set; } } -/// Schema for the `ShutdownModelMetricTokenDetail` type. +/// A token-type entry in a shutdown model metric, storing the accumulated token count. /// Nested data type for ShutdownModelMetricTokenDetail. public sealed partial class ShutdownModelMetricTokenDetail { @@ -3524,7 +4865,7 @@ public sealed partial class ShutdownModelMetricUsage public long? ReasoningTokens { get; set; } } -/// Schema for the `ShutdownModelMetric` type. +/// Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. /// Nested data type for ShutdownModelMetric. public sealed partial class ShutdownModelMetric { @@ -3548,7 +4889,7 @@ public sealed partial class ShutdownModelMetric public required ShutdownModelMetricUsage Usage { get; set; } } -/// Schema for the `ShutdownTokenDetail` type. +/// A session-wide shutdown token-type entry storing the accumulated token count. /// Nested data type for ShutdownTokenDetail. public sealed partial class ShutdownTokenDetail { @@ -3557,6 +4898,24 @@ public sealed partial class ShutdownTokenDetail public required long TokenCount { get; set; } } +/// Internal prompt-cache expiration state for one model. +/// Nested data type for UsageCheckpointModelCacheState. +internal sealed partial class UsageCheckpointModelCacheState +{ + /// Latest known prompt-cache expiration. + [JsonPropertyName("cacheExpiresAt")] + public required DateTimeOffset CacheExpiresAt { get; set; } + + /// Retained cache lifetime in seconds, used to refresh expiration after a cache read. + [JsonInclude] + [JsonPropertyName("cacheTtlSeconds")] + internal required long CacheTtlSeconds { get; set; } + + /// Model identifier associated with this cache state. + [JsonPropertyName("modelId")] + public required string ModelId { get; set; } +} + /// Token usage detail for a single billing category. /// Nested data type for CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail. public sealed partial class CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail @@ -3583,8 +4942,10 @@ public sealed partial class CompactionCompleteCompactionTokensUsedCopilotUsageTo internal sealed partial class CompactionCompleteCompactionTokensUsedCopilotUsage { /// Itemized token usage breakdown. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] [JsonPropertyName("tokenDetails")] - public required CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[] TokenDetails { get; set; } + internal CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[]? TokenDetails { get; set; } /// Total cost in nano-AI units for this request. [JsonPropertyName("totalNanoAiu")] @@ -3634,8 +4995,8 @@ public sealed partial class CompactionCompleteCompactionTokensUsed } /// Optional line range to scope the attachment to a specific section of the file. -/// Nested data type for UserMessageAttachmentFileLineRange. -public sealed partial class UserMessageAttachmentFileLineRange +/// Nested data type for AttachmentFileLineRange. +public sealed partial class AttachmentFileLineRange { /// End line number (1-based, inclusive). [JsonPropertyName("end")] @@ -3647,13 +5008,23 @@ public sealed partial class UserMessageAttachmentFileLineRange } /// File attachment. -/// The file variant of . -public sealed partial class UserMessageAttachmentFile : UserMessageAttachment +/// The file variant of . +public sealed partial class AttachmentFile : Attachment { /// [JsonIgnore] public override string Type => "file"; + /// Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assetId")] + public string? AssetId { get; set; } + + /// Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("byteLength")] + public long? ByteLength { get; set; } + /// User-facing display name for the attachment. [JsonPropertyName("displayName")] public required string DisplayName { get; set; } @@ -3661,16 +5032,31 @@ public sealed partial class UserMessageAttachmentFile : UserMessageAttachment /// Optional line range to scope the attachment to a specific section of the file. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("lineRange")] - public UserMessageAttachmentFileLineRange? LineRange { get; set; } + public AttachmentFileLineRange? LineRange { get; set; } + + /// Internal: MIME type of the file's model-facing bytes (post-resize for images). Set when the file's bytes are interned to an asset. Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mimeType")] + public string? MimeType { get; set; } + + /// Internal: why model-facing bytes are absent from persistence. Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("omittedReason")] + public OmittedBinaryOmittedReason? OmittedReason { get; set; } /// Absolute file path. [JsonPropertyName("path")] public required string Path { get; set; } + + /// Frozen rendered line this attachment contributed to the <tagged_files> prompt block (e.g. "* /path (123 lines)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. Present only for attachments routed to <tagged_files> (mutually exclusive with assetId, which marks bytes sent natively). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("taggedFilesEntry")] + public string? TaggedFilesEntry { get; set; } } /// Directory attachment. -/// The directory variant of . -public sealed partial class UserMessageAttachmentDirectory : UserMessageAttachment +/// The directory variant of . +public sealed partial class AttachmentDirectory : Attachment { /// [JsonIgnore] @@ -3683,11 +5069,16 @@ public sealed partial class UserMessageAttachmentDirectory : UserMessageAttachme /// Absolute directory path. [JsonPropertyName("path")] public required string Path { get; set; } + + /// Frozen rendered line this attachment contributed to the <tagged_files> prompt block (e.g. "* /path (12 items)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("taggedFilesEntry")] + public string? TaggedFilesEntry { get; set; } } /// End position of the selection. -/// Nested data type for UserMessageAttachmentSelectionDetailsEnd. -public sealed partial class UserMessageAttachmentSelectionDetailsEnd +/// Nested data type for AttachmentSelectionDetailsEnd. +public sealed partial class AttachmentSelectionDetailsEnd { /// End character offset within the line (0-based). [JsonPropertyName("character")] @@ -3699,8 +5090,8 @@ public sealed partial class UserMessageAttachmentSelectionDetailsEnd } /// Start position of the selection. -/// Nested data type for UserMessageAttachmentSelectionDetailsStart. -public sealed partial class UserMessageAttachmentSelectionDetailsStart +/// Nested data type for AttachmentSelectionDetailsStart. +public sealed partial class AttachmentSelectionDetailsStart { /// Start character offset within the line (0-based). [JsonPropertyName("character")] @@ -3712,21 +5103,21 @@ public sealed partial class UserMessageAttachmentSelectionDetailsStart } /// Position range of the selection within the file. -/// Nested data type for UserMessageAttachmentSelectionDetails. -public sealed partial class UserMessageAttachmentSelectionDetails +/// Nested data type for AttachmentSelectionDetails. +public sealed partial class AttachmentSelectionDetails { /// End position of the selection. [JsonPropertyName("end")] - public required UserMessageAttachmentSelectionDetailsEnd End { get; set; } + public required AttachmentSelectionDetailsEnd End { get; set; } /// Start position of the selection. [JsonPropertyName("start")] - public required UserMessageAttachmentSelectionDetailsStart Start { get; set; } + public required AttachmentSelectionDetailsStart Start { get; set; } } /// Code selection attachment from an editor. -/// The selection variant of . -public sealed partial class UserMessageAttachmentSelection : UserMessageAttachment +/// The selection variant of . +public sealed partial class AttachmentSelection : Attachment { /// [JsonIgnore] @@ -3742,7 +5133,7 @@ public sealed partial class UserMessageAttachmentSelection : UserMessageAttachme /// Position range of the selection within the file. [JsonPropertyName("selection")] - public required UserMessageAttachmentSelectionDetails Selection { get; set; } + public required AttachmentSelectionDetails Selection { get; set; } /// The selected text content. [JsonPropertyName("text")] @@ -3750,8 +5141,8 @@ public sealed partial class UserMessageAttachmentSelection : UserMessageAttachme } /// GitHub issue, pull request, or discussion reference. -/// The github_reference variant of . -public sealed partial class UserMessageAttachmentGithubReference : UserMessageAttachment +/// The github_reference variant of . +public sealed partial class AttachmentGitHubReference : Attachment { /// [JsonIgnore] @@ -3763,7 +5154,7 @@ public sealed partial class UserMessageAttachmentGithubReference : UserMessageAt /// Type of GitHub reference. [JsonPropertyName("referenceType")] - public required UserMessageAttachmentGithubReferenceType ReferenceType { get; set; } + public required AttachmentGitHubReferenceType ReferenceType { get; set; } /// Current state of the referenced item (e.g., open, closed, merged). [JsonPropertyName("state")] @@ -3778,40 +5169,474 @@ public sealed partial class UserMessageAttachmentGithubReference : UserMessageAt public required string Url { get; set; } } -/// Blob attachment with inline base64-encoded data. -/// The blob variant of . -public sealed partial class UserMessageAttachmentBlob : UserMessageAttachment +/// Pointer to a GitHub repository. +/// Nested data type for GitHubRepoRef. +public sealed partial class GitHubRepoRef +{ + /// Numeric GitHub repository id. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("id")] + public long? Id { get; set; } + + /// Repository name (without owner). + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Repository owner login (user or organization). + [JsonPropertyName("owner")] + public required string Owner { get; set; } +} + +/// Pointer to a GitHub commit. +/// The github_commit variant of . +public sealed partial class AttachmentGitHubCommit : Attachment { /// [JsonIgnore] - public override string Type => "blob"; + public override string Type => "github_commit"; - /// Base64-encoded content. - [Base64String] - [JsonPropertyName("data")] - public required string Data { get; set; } + /// First line of the commit message. + [JsonPropertyName("message")] + public required string Message { get; set; } - /// User-facing display name for the attachment. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("displayName")] - public string? DisplayName { get; set; } + /// Full commit SHA. + [JsonPropertyName("oid")] + public required string Oid { get; set; } - /// MIME type of the inline data. - [JsonPropertyName("mimeType")] - public required string MimeType { get; set; } + /// Repository the commit belongs to. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// URL to the commit on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } } -/// A user message attachment — a file, directory, code selection, blob, or GitHub reference. -/// Polymorphic base type discriminated by type. -[JsonPolymorphic( +/// Pointer to a GitHub release. +/// The github_release variant of . +public sealed partial class AttachmentGitHubRelease : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_release"; + + /// Human-readable release name. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Repository the release belongs to. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// Git tag the release is anchored to. + [JsonPropertyName("tagName")] + public required string TagName { get; set; } + + /// URL to the release on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a GitHub Actions job. +/// The github_actions_job variant of . +public sealed partial class AttachmentGitHubActionsJob : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_actions_job"; + + /// Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("conclusion")] + public string? Conclusion { get; set; } + + /// Job id within the workflow run. + [JsonPropertyName("jobId")] + public required long JobId { get; set; } + + /// Display name of the job. + [JsonPropertyName("jobName")] + public required string JobName { get; set; } + + /// Repository the workflow run belongs to. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// URL to the job on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } + + /// Display name of the workflow the job ran in. + [JsonPropertyName("workflowName")] + public required string WorkflowName { get; set; } +} + +/// Pointer to a GitHub repository. +/// The github_repository variant of . +public sealed partial class AttachmentGitHubRepository : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_repository"; + + /// Short description of the repository. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ref")] + public string? Ref { get; set; } + + /// Repository pointer. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// URL to the repository on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// One side of a file diff (head or base). +/// Nested data type for AttachmentGitHubFileDiffSide. +public sealed partial class AttachmentGitHubFileDiffSide +{ + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } + + /// Git ref (branch, tag, or commit SHA) the file is read at. + [JsonPropertyName("ref")] + public required string Ref { get; set; } + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } +} + +/// Pointer to a single-file diff. At least one of `head` and `base` must be present. +/// The github_file_diff variant of . +public sealed partial class AttachmentGitHubFileDiff : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_file_diff"; + + /// File location on the base side of the diff. Absent for additions. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("base")] + public AttachmentGitHubFileDiffSide? Base { get; set; } + + /// File location on the head side of the diff. Absent for deletions. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("head")] + public AttachmentGitHubFileDiffSide? Head { get; set; } + + /// URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL). + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// One side of a tree comparison (head or base). +/// Nested data type for AttachmentGitHubTreeComparisonSide. +public sealed partial class AttachmentGitHubTreeComparisonSide +{ + /// Repository the revision belongs to. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// Git revision (branch, tag, or commit SHA). + [JsonPropertyName("revision")] + public required string Revision { get; set; } +} + +/// Pointer to a comparison between two git revisions. +/// The github_tree_comparison variant of . +public sealed partial class AttachmentGitHubTreeComparison : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_tree_comparison"; + + /// Base side of the comparison. + [JsonPropertyName("base")] + public required AttachmentGitHubTreeComparisonSide Base { get; set; } + + /// Head side of the comparison. + [JsonPropertyName("head")] + public required AttachmentGitHubTreeComparisonSide Head { get; set; } + + /// URL to the comparison on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Generic GitHub URL reference. +/// The github_url variant of . +public sealed partial class AttachmentGitHubUrl : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_url"; + + /// URL to the GitHub resource. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a file in a GitHub repository at a specific ref. +/// The github_file variant of . +public sealed partial class AttachmentGitHubFile : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_file"; + + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } + + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { get; set; } + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// URL to the file on GitHub. + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Pointer to a line range inside a file in a GitHub repository. +/// The github_snippet variant of . +public sealed partial class AttachmentGitHubSnippet : Attachment +{ + /// + [JsonIgnore] + public override string Type => "github_snippet"; + + /// Line range the snippet covers. + [JsonPropertyName("lineRange")] + public required AttachmentFileLineRange LineRange { get; set; } + + /// Repository-relative path to the file. + [JsonPropertyName("path")] + public required string Path { get; set; } + + /// Git ref the file is read at (branch, tag, or commit SHA). + [JsonPropertyName("ref")] + public required string Ref { get; set; } + + /// Repository the file lives in. + [JsonPropertyName("repo")] + public required GitHubRepoRef Repo { get; set; } + + /// URL to the snippet on GitHub (with line anchor). + [JsonPropertyName("url")] + public required string Url { get; set; } +} + +/// Blob attachment with inline base64-encoded data. +/// The blob variant of . +public sealed partial class AttachmentBlob : Attachment +{ + /// + [JsonIgnore] + public override string Type => "blob"; + + /// Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("assetId")] + public string? AssetId { get; set; } + + /// Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("byteLength")] + public long? ByteLength { get; set; } + + /// Base64-encoded content. Present on input and for external consumers; replaced by an internal `assetId` reference in persisted events when interned to a content-addressed asset. + [Base64String] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("data")] + public string? Data { get; set; } + + /// User-facing display name for the attachment. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } + + /// MIME type of the inline data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } + + /// Internal: why model-facing bytes are absent from persistence. Absent externally. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("omittedReason")] + public OmittedBinaryOmittedReason? OmittedReason { get; set; } +} + +/// Structured context contributed by an extension. Composer pills displayed in the host are forwarded back through session.send.attachments, then rendered into the model prompt as an <extension_context> XML block. +/// The extension_context variant of . +public sealed partial class AttachmentExtensionContext : Attachment +{ + /// + [JsonIgnore] + public override string Type => "extension_context"; + + /// Provider-local canvas identifier when the push was bound to a canvas instance. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("canvasId")] + public string? CanvasId { get; set; } + + /// ISO 8601 timestamp captured by the runtime when the push was accepted. + [JsonPropertyName("capturedAt")] + public required DateTimeOffset CapturedAt { get; set; } + + /// Owning extension identifier. Runtime-derived from the caller's connection when produced via session.extensions.sendAttachmentsToMessage; preserved verbatim on subsequent transports. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Open canvas instance identifier when the push was bound to a canvas instance. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("instanceId")] + public string? InstanceId { get; set; } + + /// Caller-supplied JSON payload. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("payload")] + public JsonElement? Payload { get; set; } + + /// Human-readable composer pill label. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("title")] + public required string Title { get; set; } +} + +/// A user message attachment — a file, directory, code selection, blob, GitHub reference, GitHub-anchored pointer, or extension-supplied context payload. +/// Polymorphic base type discriminated by type. +[JsonPolymorphic( + TypeDiscriminatorPropertyName = "type", + UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] +[JsonDerivedType(typeof(AttachmentFile), "file")] +[JsonDerivedType(typeof(AttachmentDirectory), "directory")] +[JsonDerivedType(typeof(AttachmentSelection), "selection")] +[JsonDerivedType(typeof(AttachmentGitHubReference), "github_reference")] +[JsonDerivedType(typeof(AttachmentGitHubCommit), "github_commit")] +[JsonDerivedType(typeof(AttachmentGitHubRelease), "github_release")] +[JsonDerivedType(typeof(AttachmentGitHubActionsJob), "github_actions_job")] +[JsonDerivedType(typeof(AttachmentGitHubRepository), "github_repository")] +[JsonDerivedType(typeof(AttachmentGitHubFileDiff), "github_file_diff")] +[JsonDerivedType(typeof(AttachmentGitHubTreeComparison), "github_tree_comparison")] +[JsonDerivedType(typeof(AttachmentGitHubUrl), "github_url")] +[JsonDerivedType(typeof(AttachmentGitHubFile), "github_file")] +[JsonDerivedType(typeof(AttachmentGitHubSnippet), "github_snippet")] +[JsonDerivedType(typeof(AttachmentBlob), "blob")] +[JsonDerivedType(typeof(AttachmentExtensionContext), "extension_context")] +public partial class Attachment +{ + /// The type discriminator. + [JsonPropertyName("type")] + public virtual string Type { get; set; } = string.Empty; +} + + +/// A source that backs one or more cited spans in the assistant's response. +/// Nested data type for CitationSource. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationSource +{ + /// Stable, turn-scoped identifier for this source, referenced by CitationReference.sourceId. + [JsonPropertyName("id")] + public required string Id { get; set; } + + /// File path relative to the agent's workspace root, when the source is a file. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("path")] + public string? Path { get; set; } + + /// The system that produced this citation. + [JsonPropertyName("provider")] + public required CitationProvider Provider { get; set; } + + /// Human-readable title of the source. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// URL of the source, when it is a web resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("url")] + public string? Url { get; set; } +} + +/// A character range within the source's text content. +/// The char variant of . +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationLocationChar : CitationLocation +{ + /// + [JsonIgnore] + public override string Type => "char"; + + /// End character offset within the source text (zero-based, exclusive). + [JsonPropertyName("endIndex")] + public required long EndIndex { get; set; } + + /// Start character offset within the source text (zero-based, inclusive). + [JsonPropertyName("startIndex")] + public required long StartIndex { get; set; } +} + +/// A page range within a paginated source document. +/// The page variant of . +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationLocationPage : CitationLocation +{ + /// + [JsonIgnore] + public override string Type => "page"; + + /// Last page number of the cited range (inclusive). + [JsonPropertyName("endPage")] + public required long EndPage { get; set; } + + /// First page number of the cited range. + [JsonPropertyName("startPage")] + public required long StartPage { get; set; } +} + +/// A content-block range within a structured source document. +/// The block variant of . +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationLocationBlock : CitationLocation +{ + /// + [JsonIgnore] + public override string Type => "block"; + + /// Index of the last content block of the cited range (zero-based, exclusive). + [JsonPropertyName("endBlock")] + public required long EndBlock { get; set; } + + /// Index of the first content block of the cited range (zero-based, inclusive). + [JsonPropertyName("startBlock")] + public required long StartBlock { get; set; } +} + +/// Location within a cited source (character, page, or content-block range) that supports a span. +/// Polymorphic base type discriminated by type. +[Experimental(Diagnostics.Experimental)] +[JsonPolymorphic( TypeDiscriminatorPropertyName = "type", UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] -[JsonDerivedType(typeof(UserMessageAttachmentFile), "file")] -[JsonDerivedType(typeof(UserMessageAttachmentDirectory), "directory")] -[JsonDerivedType(typeof(UserMessageAttachmentSelection), "selection")] -[JsonDerivedType(typeof(UserMessageAttachmentGithubReference), "github_reference")] -[JsonDerivedType(typeof(UserMessageAttachmentBlob), "blob")] -public partial class UserMessageAttachment +[JsonDerivedType(typeof(CitationLocationChar), "char")] +[JsonDerivedType(typeof(CitationLocationPage), "page")] +[JsonDerivedType(typeof(CitationLocationBlock), "block")] +public partial class CitationLocation { /// The type discriminator. [JsonPropertyName("type")] @@ -3819,6 +5644,93 @@ public partial class UserMessageAttachment } +/// A single citation occurrence linking a span of generated text to a supporting source. +/// Nested data type for CitationReference. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationReference +{ + /// The exact text from the source that supports the cited span, when provided by the model. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("citedText")] + public string? CitedText { get; set; } + + /// Location within the source that supports the cited span, when the provider reports one. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("location")] + public CitationLocation? Location { get; set; } + + /// Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("providerMetadata")] + public JsonElement? ProviderMetadata { get; set; } + + /// Identifier of the CitationSource this reference points to (CitationSource.id). + [JsonPropertyName("sourceId")] + public required string SourceId { get; set; } +} + +/// A contiguous span of generated assistant text and the source references that support it. +/// Nested data type for CitationSpan. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitationSpan +{ + /// End offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, exclusive). + [JsonPropertyName("endIndex")] + public required long EndIndex { get; set; } + + /// The sources that support this span of generated text. + [JsonPropertyName("references")] + public required CitationReference[] References { get; set; } + + /// Start offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, inclusive). + [JsonPropertyName("startIndex")] + public required long StartIndex { get; set; } +} + +/// Provider-agnostic citations linking spans of the assistant's response to their supporting sources. +/// Nested data type for Citations. +[Experimental(Diagnostics.Experimental)] +public sealed partial class Citations +{ + /// Deduplicated set of sources referenced by the citation spans. + [JsonPropertyName("sources")] + public required CitationSource[] Sources { get; set; } + + /// Spans of generated text annotated with the sources that support them. + [JsonPropertyName("spans")] + public required CitationSpan[] Spans { get; set; } +} + +/// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping. +/// Nested data type for AssistantMessageServerTools. +[Experimental(Diagnostics.Experimental)] +public sealed partial class AssistantMessageServerTools +{ + /// Gets or sets the advisorModel value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("advisorModel")] + public string? AdvisorModel { get; set; } + + /// Gets or sets the functionCallNamespaces value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("functionCallNamespaces")] + public IDictionary? FunctionCallNamespaces { get; set; } + + /// Gets or sets the items value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("items")] + public JsonElement[]? Items { get; set; } + + /// Gets or sets the provider value. + [JsonPropertyName("provider")] + public required string Provider { get; set; } + + /// Gets or sets the rawContentBlocks value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("rawContentBlocks")] + public JsonElement[]? RawContentBlocks { get; set; } +} + /// A tool invocation request from the assistant. /// Nested data type for AssistantMessageToolRequest. public sealed partial class AssistantMessageToolRequest @@ -3885,18 +5797,20 @@ public sealed partial class AssistantUsageCopilotUsageTokenDetail /// Per-request cost and usage data from the CAPI copilot_usage response field. /// Nested data type for AssistantUsageCopilotUsage. -internal sealed partial class AssistantUsageCopilotUsage +public sealed partial class AssistantUsageCopilotUsage { /// Itemized token usage breakdown. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] [JsonPropertyName("tokenDetails")] - public required AssistantUsageCopilotUsageTokenDetail[] TokenDetails { get; set; } + internal AssistantUsageCopilotUsageTokenDetail[]? TokenDetails { get; set; } /// Total cost in nano-AI units for this request. [JsonPropertyName("totalNanoAiu")] public required double TotalNanoAiu { get; set; } } -/// Schema for the `AssistantUsageQuotaSnapshot` type. +/// Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota. /// Nested data type for AssistantUsageQuotaSnapshot. internal sealed partial class AssistantUsageQuotaSnapshot { @@ -3905,6 +5819,12 @@ internal sealed partial class AssistantUsageQuotaSnapshot [JsonPropertyName("entitlementRequests")] internal required long EntitlementRequests { get; set; } + /// Whether the user currently has quota available for use. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("hasQuota")] + internal bool? HasQuota { get; set; } + /// Whether the user has an unlimited usage entitlement. [JsonInclude] [JsonPropertyName("isUnlimitedEntitlement")] @@ -3920,6 +5840,12 @@ internal sealed partial class AssistantUsageQuotaSnapshot [JsonPropertyName("overageAllowedWithExhaustedQuota")] internal required bool OverageAllowedWithExhaustedQuota { get; set; } + /// Pay-as-you-go additional-usage budget cap in AI credits (1 credit = $0.01); present only when CAPI emits a finite value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("overageEntitlement")] + internal double? OverageEntitlement { get; set; } + /// Percentage of quota remaining (0 to 100). [JsonInclude] [JsonPropertyName("remainingPercentage")] @@ -3931,6 +5857,12 @@ internal sealed partial class AssistantUsageQuotaSnapshot [JsonPropertyName("resetDate")] internal DateTimeOffset? ResetDate { get; set; } + /// Whether this snapshot uses token-based billing (AI-credits allocation). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonInclude] + [JsonPropertyName("tokenBasedBilling")] + internal bool? TokenBasedBilling { get; set; } + /// Whether usage is still permitted after quota exhaustion. [JsonInclude] [JsonPropertyName("usageAllowedWithExhaustedQuota")] @@ -3942,11 +5874,108 @@ internal sealed partial class AssistantUsageQuotaSnapshot internal required long UsedRequests { get; set; } } -/// Error details when the tool execution failed. -/// Nested data type for ToolExecutionCompleteError. -public sealed partial class ToolExecutionCompleteError +/// Content-free structural summary of the failing request for diagnosing malformed 4xx calls. +/// Nested data type for ModelCallFailureRequestFingerprint. +public sealed partial class ModelCallFailureRequestFingerprint { - /// Machine-readable error code. + /// Total number of image content parts. + [JsonPropertyName("imagePartCount")] + public required long ImagePartCount { get; set; } + + /// Image parts whose media type cannot be determined (rejected by strict providers). + [JsonPropertyName("imagePartsMissingMediaType")] + public required long ImagePartsMissingMediaType { get; set; } + + /// Role of the final message in the request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("lastMessageRole")] + public string? LastMessageRole { get; set; } + + /// Total number of messages in the request. + [JsonPropertyName("messageCount")] + public required long MessageCount { get; set; } + + /// Tool calls whose name is missing or empty (rejected by strict providers). + [JsonPropertyName("namelessToolCallCount")] + public required long NamelessToolCallCount { get; set; } + + /// Total number of tool calls across assistant messages. + [JsonPropertyName("toolCallCount")] + public required long ToolCallCount { get; set; } + + /// Number of "tool" result messages in the request. + [JsonPropertyName("toolResultMessageCount")] + public required long ToolResultMessageCount { get; set; } +} + +/// Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs. +/// Nested data type for ToolExecutionStartShellToolInfo. +public sealed partial class ToolExecutionStartShellToolInfo +{ + /// The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("displayCommand")] + public string? DisplayCommand { get; set; } + + /// Whether the command includes a file write redirection (e.g., > or >>). + [JsonPropertyName("hasWriteFileRedirection")] + public required bool HasWriteFileRedirection { get; set; } + + /// File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. + [JsonPropertyName("possiblePaths")] + public required string[] PossiblePaths { get; set; } +} + +/// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. +/// Nested data type for ToolExecutionStartToolDescriptionMetaUI. +public sealed partial class ToolExecutionStartToolDescriptionMetaUI +{ + /// URI of the UI resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceUri")] + public string? ResourceUri { get; set; } + + /// Who can access this tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("visibility")] + public ToolExecutionStartToolDescriptionMetaUIVisibility[]? Visibility { get; set; } +} + +/// MCP Apps metadata for UI resource association. +/// Nested data type for ToolExecutionStartToolDescriptionMeta. +public sealed partial class ToolExecutionStartToolDescriptionMeta +{ + /// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ui")] + public ToolExecutionStartToolDescriptionMetaUI? Ui { get; set; } +} + +/// Tool definition metadata, present for MCP tools with MCP Apps support. +/// Nested data type for ToolExecutionStartToolDescription. +public sealed partial class ToolExecutionStartToolDescription +{ + /// MCP Apps metadata for UI resource association. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("_meta")] + public ToolExecutionStartToolDescriptionMeta? Meta { get; set; } + + /// Tool description. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Tool name. + [JsonPropertyName("name")] + public required string Name { get; set; } +} + +/// Error details when the tool execution failed. +/// Nested data type for ToolExecutionCompleteError. +public sealed partial class ToolExecutionCompleteError +{ + /// Machine-readable error code. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("code")] public string? Code { get; set; } @@ -3956,6 +5985,228 @@ public sealed partial class ToolExecutionCompleteError public required string Message { get; set; } } +/// Binary result returned by a tool for the model. +/// Nested data type for PersistedBinaryImage. +public sealed partial class PersistedBinaryImage +{ + /// Base64-encoded binary data. + [Base64String] + [JsonPropertyName("data")] + public required string Data { get; set; } + + /// Human-readable description of the binary data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Optional metadata from the producing tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// MIME type of the binary data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } + + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + [JsonPropertyName("type")] + public required PersistedBinaryImageType Type { get; set; } +} + +/// A binary result whose data was omitted from persistence due to the inline size limit. +/// Nested data type for OmittedBinaryResult. +[Experimental(Diagnostics.Experimental)] +public sealed partial class OmittedBinaryResult +{ + /// Decoded byte length of the omitted binary data. + [JsonPropertyName("byteLength")] + public required long ByteLength { get; set; } + + /// Human-readable description of the binary data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Optional metadata from the producing tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// MIME type of the omitted binary data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } + + /// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable. + [JsonPropertyName("omittedReason")] + public required OmittedBinaryOmittedReason OmittedReason { get; set; } + + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + [JsonPropertyName("type")] + public required OmittedBinaryType Type { get; set; } +} + +/// A reference to binary data persisted once on a session.binary_asset event and shared by id. +/// Nested data type for BinaryAssetReference. +[Experimental(Diagnostics.Experimental)] +public sealed partial class BinaryAssetReference +{ + /// Content-addressed id of the session.binary_asset event that holds this binary's bytes (e.g. "sha256:..."). + [JsonPropertyName("assetId")] + public required string AssetId { get; set; } + + /// Decoded byte length of the referenced binary data. + [JsonPropertyName("byteLength")] + public required long ByteLength { get; set; } + + /// Human-readable description of the binary data. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// Optional metadata from the producing tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// MIME type of the referenced binary data. + [JsonPropertyName("mimeType")] + public required string MimeType { get; set; } + + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + [JsonPropertyName("type")] + public required BinaryAssetReferenceType Type { get; set; } +} + +/// A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset reference. +/// JSON union data type for PersistedBinaryResult. +[JsonConverter(typeof(Converter))] +public sealed partial class PersistedBinaryResult +{ + /// Gets the value when this instance contains . + public PersistedBinaryImage? PersistedBinaryImage { get; } + + /// Gets the value when this instance contains . + public OmittedBinaryResult? OmittedBinaryResult { get; } + + /// Gets the value when this instance contains . + public BinaryAssetReference? BinaryAssetReference { get; } + + /// Initializes a new instance of the class from . + public PersistedBinaryResult(PersistedBinaryImage value) + { + ArgumentNullException.ThrowIfNull(value); + PersistedBinaryImage = value; + } + + /// Converts to . + public static implicit operator PersistedBinaryResult(PersistedBinaryImage value) => new(value); + + /// Initializes a new instance of the class from . + public PersistedBinaryResult(OmittedBinaryResult value) + { + ArgumentNullException.ThrowIfNull(value); + OmittedBinaryResult = value; + } + + /// Converts to . + public static implicit operator PersistedBinaryResult(OmittedBinaryResult value) => new(value); + + /// Initializes a new instance of the class from . + public PersistedBinaryResult(BinaryAssetReference value) + { + ArgumentNullException.ThrowIfNull(value); + BinaryAssetReference = value; + } + + /// Converts to . + public static implicit operator PersistedBinaryResult(BinaryAssetReference value) => new(value); + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override PersistedBinaryResult Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + throw new JsonException("Expected JSON object for PersistedBinaryResult."); + } + + using var document = JsonDocument.ParseValue(ref reader); + var element = document.RootElement; + if (element.ValueKind == JsonValueKind.Object && element.TryGetProperty("data", out _) && !element.TryGetProperty("assetId", out _) && !element.TryGetProperty("byteLength", out _) && !element.TryGetProperty("omittedReason", out _)) + { + var persistedBinaryImage = JsonSerializer.Deserialize(element, SessionEventsJsonContext.Default.PersistedBinaryImage); + return persistedBinaryImage is null ? throw new JsonException("Expected PersistedBinaryImage value.") : new PersistedBinaryResult(persistedBinaryImage); + } + if (element.ValueKind == JsonValueKind.Object && element.TryGetProperty("omittedReason", out _) && !element.TryGetProperty("assetId", out _) && !element.TryGetProperty("data", out _)) + { + var omittedBinaryResult = JsonSerializer.Deserialize(element, SessionEventsJsonContext.Default.OmittedBinaryResult); + return omittedBinaryResult is null ? throw new JsonException("Expected OmittedBinaryResult value.") : new PersistedBinaryResult(omittedBinaryResult); + } + if (element.ValueKind == JsonValueKind.Object && element.TryGetProperty("assetId", out _) && !element.TryGetProperty("data", out _) && !element.TryGetProperty("omittedReason", out _)) + { + var binaryAssetReference = JsonSerializer.Deserialize(element, SessionEventsJsonContext.Default.BinaryAssetReference); + return binaryAssetReference is null ? throw new JsonException("Expected BinaryAssetReference value.") : new PersistedBinaryResult(binaryAssetReference); + } + + throw new JsonException("JSON value did not match any PersistedBinaryResult variant."); + } + + /// + public override void Write(Utf8JsonWriter writer, PersistedBinaryResult value, JsonSerializerOptions options) + { + if (value.PersistedBinaryImage is { } persistedBinaryImage) + { + JsonSerializer.Serialize(writer, persistedBinaryImage, SessionEventsJsonContext.Default.PersistedBinaryImage); + return; + } + if (value.OmittedBinaryResult is { } omittedBinaryResult) + { + JsonSerializer.Serialize(writer, omittedBinaryResult, SessionEventsJsonContext.Default.OmittedBinaryResult); + return; + } + if (value.BinaryAssetReference is { } binaryAssetReference) + { + JsonSerializer.Serialize(writer, binaryAssetReference, SessionEventsJsonContext.Default.BinaryAssetReference); + return; + } + + throw new JsonException("No PersistedBinaryResult variant value is set."); + } + } +} + +/// A source supplied by a tool that should be made available to the model as citable content. +/// Nested data type for CitableSource. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CitableSource +{ + /// The source text made available to the model as citable content. + [JsonPropertyName("content")] + public required string Content { get; set; } + + /// Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source. + [JsonPropertyName("id")] + public required string Id { get; set; } + + /// File path relative to the agent's workspace root, when the source is a file. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("path")] + public string? Path { get; set; } + + /// Human-readable title of the source. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// URL of the source, when it is a web resource. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("url")] + public string? Url { get; set; } +} + /// Plain text content block. /// The text variant of . public sealed partial class ToolExecutionCompleteContentText : ToolExecutionCompleteContent @@ -3969,8 +6220,12 @@ public sealed partial class ToolExecutionCompleteContentText : ToolExecutionComp public required string Text { get; set; } } -/// Terminal/shell output content block with optional exit code and working directory. +/// Deprecated for shell command exit metadata. Use ToolExecutionCompleteContentShellExit instead. /// The terminal variant of . +[EditorBrowsable(EditorBrowsableState.Never)] +#if NET5_0_OR_GREATER +[Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif public sealed partial class ToolExecutionCompleteContentTerminal : ToolExecutionCompleteContent { /// @@ -3992,6 +6247,38 @@ public sealed partial class ToolExecutionCompleteContentTerminal : ToolExecution public required string Text { get; set; } } +/// Shell command exit metadata with optional output preview. +/// The shell_exit variant of . +public sealed partial class ToolExecutionCompleteContentShellExit : ToolExecutionCompleteContent +{ + /// + [JsonIgnore] + public override string Type => "shell_exit"; + + /// Working directory where the shell command was executed. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("cwd")] + public string? Cwd { get; set; } + + /// Exit code from the completed shell command. + [JsonPropertyName("exitCode")] + public required long ExitCode { get; set; } + + /// Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputPreview")] + public string? OutputPreview { get; set; } + + /// Whether outputPreview is known to be incomplete or truncated. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("outputTruncated")] + public bool? OutputTruncated { get; set; } + + /// Shell id, as assigned by Copilot runtime. + [JsonPropertyName("shellId")] + public required string ShellId { get; set; } +} + /// Image content block with base64-encoded data. /// The image variant of . public sealed partial class ToolExecutionCompleteContentImage : ToolExecutionCompleteContent @@ -4094,7 +6381,7 @@ public sealed partial class ToolExecutionCompleteContentResourceLink : ToolExecu public required string Uri { get; set; } } -/// Schema for the `EmbeddedTextResourceContents` type. +/// Embedded text resource contents identified by a URI, with an optional MIME type and a text payload. /// Nested data type for EmbeddedTextResourceContents. public sealed partial class EmbeddedTextResourceContents { @@ -4112,7 +6399,7 @@ public sealed partial class EmbeddedTextResourceContents public required string Uri { get; set; } } -/// Schema for the `EmbeddedBlobResourceContents` type. +/// Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob. /// Nested data type for EmbeddedBlobResourceContents. public sealed partial class EmbeddedBlobResourceContents { @@ -4229,6 +6516,7 @@ public sealed partial class ToolExecutionCompleteContentResource : ToolExecution UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)] [JsonDerivedType(typeof(ToolExecutionCompleteContentText), "text")] [JsonDerivedType(typeof(ToolExecutionCompleteContentTerminal), "terminal")] +[JsonDerivedType(typeof(ToolExecutionCompleteContentShellExit), "shell_exit")] [JsonDerivedType(typeof(ToolExecutionCompleteContentImage), "image")] [JsonDerivedType(typeof(ToolExecutionCompleteContentAudio), "audio")] [JsonDerivedType(typeof(ToolExecutionCompleteContentResourceLink), "resource_link")] @@ -4241,7 +6529,7 @@ public partial class ToolExecutionCompleteContent } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. +/// CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. /// Nested data type for ToolExecutionCompleteUIResourceMetaUICsp. public sealed partial class ToolExecutionCompleteUIResourceMetaUICsp { @@ -4266,60 +6554,60 @@ public sealed partial class ToolExecutionCompleteUIResourceMetaUICsp public string[]? ResourceDomains { get; set; } } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. +/// Marker object for camera permission on an MCP Apps UI resource. /// Nested data type for ToolExecutionCompleteUIResourceMetaUIPermissionsCamera. public sealed partial class ToolExecutionCompleteUIResourceMetaUIPermissionsCamera { } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. +/// Marker object for clipboard-write permission on an MCP Apps UI resource. /// Nested data type for ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite. public sealed partial class ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite { } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. +/// Marker object for geolocation permission on an MCP Apps UI resource. /// Nested data type for ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation. public sealed partial class ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation { } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. +/// Marker object for microphone permission on an MCP Apps UI resource. /// Nested data type for ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone. public sealed partial class ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone { } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. +/// Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. /// Nested data type for ToolExecutionCompleteUIResourceMetaUIPermissions. public sealed partial class ToolExecutionCompleteUIResourceMetaUIPermissions { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. + /// Marker object for camera permission on an MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("camera")] public ToolExecutionCompleteUIResourceMetaUIPermissionsCamera? Camera { get; set; } - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. + /// Marker object for clipboard-write permission on an MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("clipboardWrite")] public ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite? ClipboardWrite { get; set; } - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. + /// Marker object for geolocation permission on an MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("geolocation")] public ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation? Geolocation { get; set; } - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. + /// Marker object for microphone permission on an MCP Apps UI resource. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("microphone")] public ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone? Microphone { get; set; } } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. +/// MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. /// Nested data type for ToolExecutionCompleteUIResourceMetaUI. public sealed partial class ToolExecutionCompleteUIResourceMetaUI { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. + /// CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("csp")] public ToolExecutionCompleteUIResourceMetaUICsp? Csp { get; set; } @@ -4329,7 +6617,7 @@ public sealed partial class ToolExecutionCompleteUIResourceMetaUI [JsonPropertyName("domain")] public string? Domain { get; set; } - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. + /// Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("permissions")] public ToolExecutionCompleteUIResourceMetaUIPermissions? Permissions { get; set; } @@ -4344,7 +6632,7 @@ public sealed partial class ToolExecutionCompleteUIResourceMetaUI /// Nested data type for ToolExecutionCompleteUIResourceMeta. public sealed partial class ToolExecutionCompleteUIResourceMeta { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. + /// MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("ui")] public ToolExecutionCompleteUIResourceMetaUI? Ui { get; set; } @@ -4357,7 +6645,7 @@ public sealed partial class ToolExecutionCompleteUIResource /// Resource-level UI metadata (CSP, permissions, visual preferences). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("_meta")] - public ToolExecutionCompleteUIResourceMeta? _meta { get; set; } + public ToolExecutionCompleteUIResourceMeta? Meta { get; set; } /// Base64-encoded HTML content. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -4382,6 +6670,18 @@ public sealed partial class ToolExecutionCompleteUIResource /// Nested data type for ToolExecutionCompleteResult. public sealed partial class ToolExecutionCompleteResult { + /// Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("binaryResultsForLlm")] + public PersistedBinaryResult[]? BinaryResultsForLlm { get; set; } + + /// Provider-neutral source material this tool makes available to the model as citable content. Persisted so it survives session resume. Experimental. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("citableSources")] + public CitableSource[]? CitableSources { get; set; } + /// Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency. [JsonPropertyName("content")] public required string Content { get; set; } @@ -4396,13 +6696,24 @@ public sealed partial class ToolExecutionCompleteResult [JsonPropertyName("detailedContent")] public string? DetailedContent { get; set; } + /// FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels) — persisted as `{ ifc: ... }` (only the `ifc` key, not the whole `_meta`). Persisted so the FIDES IFC label survives session resume: the engine rehydrates accumulated taint by replaying these on load. Populated for ingress sources when FIDES IFC is on. Experimental. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("mcpMeta")] + public JsonElement? McpMeta { get; set; } + + /// Structured content (arbitrary JSON) returned verbatim by the MCP tool. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("structuredContent")] + public JsonElement? StructuredContent { get; set; } + /// MCP Apps UI resource content for rendering in a sandboxed iframe. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("uiResource")] public ToolExecutionCompleteUIResource? UiResource { get; set; } } -/// Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. +/// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. /// Nested data type for ToolExecutionCompleteToolDescriptionMetaUI. public sealed partial class ToolExecutionCompleteToolDescriptionMetaUI { @@ -4421,7 +6732,7 @@ public sealed partial class ToolExecutionCompleteToolDescriptionMetaUI /// Nested data type for ToolExecutionCompleteToolDescriptionMeta. public sealed partial class ToolExecutionCompleteToolDescriptionMeta { - /// Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. + /// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("ui")] public ToolExecutionCompleteToolDescriptionMetaUI? Ui { get; set; } @@ -4434,7 +6745,7 @@ public sealed partial class ToolExecutionCompleteToolDescription /// MCP Apps metadata for UI resource association. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("_meta")] - public ToolExecutionCompleteToolDescriptionMeta? _meta { get; set; } + public ToolExecutionCompleteToolDescriptionMeta? Meta { get; set; } /// Tool description. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] @@ -4454,6 +6765,11 @@ public sealed partial class HookEndError [JsonPropertyName("message")] public required string Message { get; set; } + /// Source label of the hook that errored (e.g. the plugin it was loaded from), when known. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("source")] + public string? Source { get; set; } + /// Error stack trace, when available. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("stack")] @@ -4475,7 +6791,7 @@ public sealed partial class SystemMessageMetadata public IDictionary? Variables { get; set; } } -/// Schema for the `SystemNotificationAgentCompleted` type. +/// System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt. /// The agent_completed variant of . public sealed partial class SystemNotificationAgentCompleted : SystemNotification { @@ -4506,7 +6822,7 @@ public sealed partial class SystemNotificationAgentCompleted : SystemNotificatio public required SystemNotificationAgentCompletedStatus Status { get; set; } } -/// Schema for the `SystemNotificationAgentIdle` type. +/// System notification metadata for a background agent that became idle, including agent ID, type, and description. /// The agent_idle variant of . public sealed partial class SystemNotificationAgentIdle : SystemNotification { @@ -4528,7 +6844,7 @@ public sealed partial class SystemNotificationAgentIdle : SystemNotification public string? Description { get; set; } } -/// Schema for the `SystemNotificationNewInboxMessage` type. +/// System notification metadata for a new inbox message, including entry ID, sender details, and summary. /// The new_inbox_message variant of . public sealed partial class SystemNotificationNewInboxMessage : SystemNotification { @@ -4553,7 +6869,7 @@ public sealed partial class SystemNotificationNewInboxMessage : SystemNotificati public required string Summary { get; set; } } -/// Schema for the `SystemNotificationShellCompleted` type. +/// System notification metadata for a shell session that completed, including shell ID, optional exit code, and description. /// The shell_completed variant of . public sealed partial class SystemNotificationShellCompleted : SystemNotification { @@ -4576,7 +6892,7 @@ public sealed partial class SystemNotificationShellCompleted : SystemNotificatio public required string ShellId { get; set; } } -/// Schema for the `SystemNotificationShellDetachedCompleted` type. +/// System notification metadata for a detached shell session that completed, including shell ID and description. /// The shell_detached_completed variant of . public sealed partial class SystemNotificationShellDetachedCompleted : SystemNotification { @@ -4594,7 +6910,7 @@ public sealed partial class SystemNotificationShellDetachedCompleted : SystemNot public required string ShellId { get; set; } } -/// Schema for the `SystemNotificationInstructionDiscovered` type. +/// System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool. /// The instruction_discovered variant of . public sealed partial class SystemNotificationInstructionDiscovered : SystemNotification { @@ -4620,6 +6936,74 @@ public sealed partial class SystemNotificationInstructionDiscovered : SystemNoti public required string TriggerTool { get; set; } } +/// System notification metadata for a factory execution attempt that reached a terminal state. +/// The factory_completed variant of . +public sealed partial class SystemNotificationFactoryCompleted : SystemNotification +{ + /// + [JsonIgnore] + public override string Type => "factory_completed"; + + /// Execution attempt that reached this terminal state. + [JsonPropertyName("attempt")] + public required long Attempt { get; set; } + + /// Consumed AI usage in nano-AIU. + [JsonPropertyName("consumedNanoAiu")] + public required long ConsumedNanoAiu { get; set; } + + /// Subagents consumed by the run across all attempts. + [JsonPropertyName("consumedSubagents")] + public required long ConsumedSubagents { get; set; } + + /// Accumulated active execution time in milliseconds. + [JsonPropertyName("elapsedMs")] + public required long ElapsedMs { get; set; } + + /// Persisted factory name. + [JsonPropertyName("factoryName")] + public required string FactoryName { get; set; } + + /// Machine-readable terminal failure details, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("failure")] + public JsonElement? Failure { get; set; } + + /// Bounded prompt-safe preview of the completed result. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MaxLength(256)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resultPreview")] + public string? ResultPreview { get; set; } + + /// Actionable run_factory resume guidance for a resource-limit failure. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("retryGuidance")] + public string? RetryGuidance { get; set; } + + /// Factory run identifier. + [JsonPropertyName("runId")] + public required string RunId { get; set; } + + /// Terminal status reached by this execution attempt. + [JsonPropertyName("status")] + public required SystemNotificationFactoryCompletedStatus Status { get; set; } +} + +/// System notification metadata from an external host that does not match a runtime-owned notification kind. +/// The unclassified variant of . +public sealed partial class SystemNotificationUnclassified : SystemNotification +{ + /// + [JsonIgnore] + public override string Type => "unclassified"; + + /// Opaque metadata supplied by the external host, when present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("metadata")] + public JsonElement? Metadata { get; set; } +} + /// Structured metadata identifying what triggered this notification. /// Polymorphic base type discriminated by type. [JsonPolymorphic( @@ -4631,6 +7015,8 @@ public sealed partial class SystemNotificationInstructionDiscovered : SystemNoti [JsonDerivedType(typeof(SystemNotificationShellCompleted), "shell_completed")] [JsonDerivedType(typeof(SystemNotificationShellDetachedCompleted), "shell_detached_completed")] [JsonDerivedType(typeof(SystemNotificationInstructionDiscovered), "instruction_discovered")] +[JsonDerivedType(typeof(SystemNotificationFactoryCompleted), "factory_completed")] +[JsonDerivedType(typeof(SystemNotificationUnclassified), "unclassified")] public partial class SystemNotification { /// The type discriminator. @@ -4639,7 +7025,7 @@ public partial class SystemNotification } -/// Schema for the `PermissionRequestShellCommand` type. +/// A parsed command identifier in a shell permission request, including whether it is read-only. /// Nested data type for PermissionRequestShellCommand. public sealed partial class PermissionRequestShellCommand { @@ -4652,7 +7038,20 @@ public sealed partial class PermissionRequestShellCommand public required bool ReadOnly { get; set; } } -/// Schema for the `PermissionRequestShellPossibleUrl` type. +/// A parsed shell command segment used for argument-aware managed policy matching. +/// Nested data type for PermissionRequestShellCommandSegment. +public sealed partial class PermissionRequestShellCommandSegment +{ + /// Full text of this command segment, including arguments. + [JsonPropertyName("fullCommandText")] + public required string FullCommandText { get; set; } + + /// Command identifier (e.g., executable name). + [JsonPropertyName("identifier")] + public required string Identifier { get; set; } +} + +/// A URL that may be accessed by a command in a shell permission request. /// Nested data type for PermissionRequestShellPossibleUrl. public sealed partial class PermissionRequestShellPossibleUrl { @@ -4677,6 +7076,11 @@ public sealed partial class PermissionRequestShell : PermissionRequest [JsonPropertyName("commands")] public required PermissionRequestShellCommand[] Commands { get; set; } + /// Parsed command segments, including arguments, used for managed policy matching. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("commandSegments")] + public PermissionRequestShellCommandSegment[]? CommandSegments { get; set; } + /// The complete shell command text to be executed. [JsonPropertyName("fullCommandText")] public required string FullCommandText { get; set; } @@ -4689,6 +7093,15 @@ public sealed partial class PermissionRequestShell : PermissionRequest [JsonPropertyName("intention")] public required string Intention { get; set; } + /// + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public override bool? ManagedApprovalRequired + { + get => base.ManagedApprovalRequired; + set => base.ManagedApprovalRequired = value; + } + /// File paths that may be read or written by the command. [JsonPropertyName("possiblePaths")] public required string[] PossiblePaths { get; set; } @@ -4697,6 +7110,16 @@ public sealed partial class PermissionRequestShell : PermissionRequest [JsonPropertyName("possibleUrls")] public required PermissionRequestShellPossibleUrl[] PossibleUrls { get; set; } + /// True when the model has requested to run this command outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypass")] + public bool? RequestSandboxBypass { get; set; } + + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypassReason")] + public string? RequestSandboxBypassReason { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -4732,11 +7155,30 @@ public sealed partial class PermissionRequestWrite : PermissionRequest [JsonPropertyName("intention")] public required string Intention { get; set; } + /// + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public override bool? ManagedApprovalRequired + { + get => base.ManagedApprovalRequired; + set => base.ManagedApprovalRequired = value; + } + /// Complete new file contents for newly created files. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("newFileContents")] public string? NewFileContents { get; set; } + /// True when a built-in file tool (apply_patch / str_replace_editor) asked to write a path the sandbox filesystem policy would block, and the host opted in via sandbox.allowBypass. This is a request, not a grant: the write happens unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypass")] + public bool? RequestSandboxBypass { get; set; } + + /// Justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypassReason")] + public string? RequestSandboxBypassReason { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -4755,10 +7197,29 @@ public sealed partial class PermissionRequestRead : PermissionRequest [JsonPropertyName("intention")] public required string Intention { get; set; } + /// + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public override bool? ManagedApprovalRequired + { + get => base.ManagedApprovalRequired; + set => base.ManagedApprovalRequired = value; + } + /// Path of the file or directory being read. [JsonPropertyName("path")] public required string Path { get; set; } + /// True when the model has requested to run this search outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypass")] + public bool? RequestSandboxBypass { get; set; } + + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypassReason")] + public string? RequestSandboxBypassReason { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -4812,6 +7273,30 @@ public sealed partial class PermissionRequestUrl : PermissionRequest [JsonPropertyName("intention")] public required string Intention { get; set; } + /// + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public override bool? ManagedApprovalRequired + { + get => base.ManagedApprovalRequired; + set => base.ManagedApprovalRequired = value; + } + + /// Immediately preceding URL when this request is for a redirect target. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("redirectedFrom")] + public string? RedirectedFrom { get; set; } + + /// True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypass")] + public bool? RequestSandboxBypass { get; set; } + + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypassReason")] + public string? RequestSandboxBypassReason { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -4943,6 +7428,98 @@ public sealed partial class PermissionRequestExtensionManagement : PermissionReq public string? ToolCallId { get; set; } } +/// A declared phase shown in a factory permission prompt. +/// Nested data type for FactoryPermissionPhase. +public sealed partial class FactoryPermissionPhase +{ + /// Optional phase detail. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("detail")] + public string? Detail { get; set; } + + /// Phase title. + [JsonPropertyName("title")] + public required string Title { get; set; } +} + +/// Factory run or authoring permission request. +/// The factory variant of . +public sealed partial class PermissionRequestFactory : PermissionRequest +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Canonical key used for scoped factory approvals. + [JsonPropertyName("approvalKey")] + public required string ApprovalKey { get; set; } + + /// Whether this factory is eligible for persistent approval. + [JsonPropertyName("canPersistApproval")] + public required bool CanPersistApproval { get; set; } + + /// Gets or sets the declaredMaxAiCredits value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxAiCredits")] + public double? DeclaredMaxAiCredits { get; set; } + + /// Gets or sets the declaredMaxConcurrentSubagents value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxConcurrentSubagents")] + public long? DeclaredMaxConcurrentSubagents { get; set; } + + /// Gets or sets the declaredMaxTotalSubagents value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxTotalSubagents")] + public long? DeclaredMaxTotalSubagents { get; set; } + + /// Gets or sets the declaredTimeoutSeconds value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredTimeoutSeconds")] + public double? DeclaredTimeoutSeconds { get; set; } + + /// Factory description. + [JsonPropertyName("description")] + public required string Description { get; set; } + + /// Effective AI-credit limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } + + /// Effective concurrent-subagent limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxConcurrentSubagents")] + public long? MaxConcurrentSubagents { get; set; } + + /// Effective total-subagent limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxTotalSubagents")] + public long? MaxTotalSubagents { get; set; } + + /// Factory name. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Factory operation, either run or author. + [JsonPropertyName("operation")] + public required FactoryPermissionOperation Operation { get; set; } + + /// Declared factory phases. + [JsonPropertyName("phases")] + public required FactoryPermissionPhase[] Phases { get; set; } + + /// Effective active-time limit in seconds; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("timeoutSeconds")] + public double? TimeoutSeconds { get; set; } + + /// Tool call ID that triggered this permission request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } +} + /// Extension permission access request. /// The extension-permission-access variant of . public sealed partial class PermissionRequestExtensionPermissionAccess : PermissionRequest @@ -4979,15 +7556,46 @@ public sealed partial class PermissionRequestExtensionPermissionAccess : Permiss [JsonDerivedType(typeof(PermissionRequestCustomTool), "custom-tool")] [JsonDerivedType(typeof(PermissionRequestHook), "hook")] [JsonDerivedType(typeof(PermissionRequestExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(PermissionRequestFactory), "factory")] [JsonDerivedType(typeof(PermissionRequestExtensionPermissionAccess), "extension-permission-access")] public partial class PermissionRequest { /// The type discriminator. [JsonPropertyName("kind")] public virtual string Kind { get; set; } = string.Empty; + + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public virtual bool? ManagedApprovalRequired { get; set; } } +/// Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is "auto"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. +/// Nested data type for PermissionAutoApproval. +[Experimental(Diagnostics.Experimental)] +public sealed partial class PermissionAutoApproval +{ + /// Classified cause of an `error` recommendation. Absent for every other recommendation. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("failureReason")] + public AutoApprovalJudgeFailureReason? FailureReason { get; set; } + + /// Model id that produced the recommendation, when the judge was consulted and reported one. Absent for `excluded` (the judge was not consulted) and for failures that occurred before a model was selected. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("model")] + public string? Model { get; set; } + + /// Human-readable reason for the judge's recommendation, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// The auto-approval safety judge's outcome for this request. + [JsonPropertyName("recommendation")] + public required AutoApprovalRecommendation Recommendation { get; set; } +} + /// Shell command permission prompt. /// The commands variant of . public sealed partial class PermissionPromptRequestCommands : PermissionPromptRequest @@ -4996,6 +7604,12 @@ public sealed partial class PermissionPromptRequestCommands : PermissionPromptRe [JsonIgnore] public override string Kind => "commands"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Whether the UI can offer session-wide approval for this command pattern. [JsonPropertyName("canOfferSessionApproval")] public required bool CanOfferSessionApproval { get; set; } @@ -5012,6 +7626,11 @@ public sealed partial class PermissionPromptRequestCommands : PermissionPromptRe [JsonPropertyName("intention")] public required string Intention { get; set; } + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public bool? ManagedApprovalRequired { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -5031,6 +7650,12 @@ public sealed partial class PermissionPromptRequestWrite : PermissionPromptReque [JsonIgnore] public override string Kind => "write"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Whether the UI can offer session-wide approval for file write operations. [JsonPropertyName("canOfferSessionApproval")] public required bool CanOfferSessionApproval { get; set; } @@ -5047,6 +7672,11 @@ public sealed partial class PermissionPromptRequestWrite : PermissionPromptReque [JsonPropertyName("intention")] public required string Intention { get; set; } + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public bool? ManagedApprovalRequired { get; set; } + /// Complete new file contents for newly created files. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("newFileContents")] @@ -5066,10 +7696,21 @@ public sealed partial class PermissionPromptRequestRead : PermissionPromptReques [JsonIgnore] public override string Kind => "read"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Human-readable description of why the file is being read. [JsonPropertyName("intention")] public required string Intention { get; set; } + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public bool? ManagedApprovalRequired { get; set; } + /// Path of the file or directory being read. [JsonPropertyName("path")] public required string Path { get; set; } @@ -5093,6 +7734,12 @@ public sealed partial class PermissionPromptRequestMcp : PermissionPromptRequest [JsonPropertyName("args")] public JsonElement? Args { get; set; } + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Name of the MCP server providing the tool. [JsonPropertyName("serverName")] public required string ServerName { get; set; } @@ -5119,10 +7766,36 @@ public sealed partial class PermissionPromptRequestUrl : PermissionPromptRequest [JsonIgnore] public override string Kind => "url"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Human-readable description of why the URL is being accessed. [JsonPropertyName("intention")] public required string Intention { get; set; } + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public bool? ManagedApprovalRequired { get; set; } + + /// Immediately preceding URL when this prompt is for a redirect target. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("redirectedFrom")] + public string? RedirectedFrom { get; set; } + + /// True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypass")] + public bool? RequestSandboxBypass { get; set; } + + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("requestSandboxBypassReason")] + public string? RequestSandboxBypassReason { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -5146,6 +7819,12 @@ public sealed partial class PermissionPromptRequestMemory : PermissionPromptRequ [JsonPropertyName("action")] public PermissionRequestMemoryAction? Action { get; set; } + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Source references for the stored fact (store only). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("citations")] @@ -5189,6 +7868,12 @@ public sealed partial class PermissionPromptRequestCustomTool : PermissionPrompt [JsonPropertyName("args")] public JsonElement? Args { get; set; } + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Tool call ID that triggered this permission request. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("toolCallId")] @@ -5215,6 +7900,12 @@ public sealed partial class PermissionPromptRequestPath : PermissionPromptReques [JsonPropertyName("accessKind")] public required PermissionPromptRequestPathAccessKind AccessKind { get; set; } + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// File paths that require explicit approval. [JsonPropertyName("paths")] public required string[] Paths { get; set; } @@ -5233,6 +7924,12 @@ public sealed partial class PermissionPromptRequestHook : PermissionPromptReques [JsonIgnore] public override string Kind => "hook"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Optional message from the hook explaining why confirmation is needed. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("hookMessage")] @@ -5261,6 +7958,12 @@ public sealed partial class PermissionPromptRequestExtensionManagement : Permiss [JsonIgnore] public override string Kind => "extension-management"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Name of the extension being managed. [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("extensionName")] @@ -5276,6 +7979,95 @@ public sealed partial class PermissionPromptRequestExtensionManagement : Permiss public string? ToolCallId { get; set; } } +/// Factory run or authoring permission prompt. +/// The factory variant of . +public sealed partial class PermissionPromptRequestFactory : PermissionPromptRequest +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Canonical key used for scoped factory approvals. + [JsonPropertyName("approvalKey")] + public required string ApprovalKey { get; set; } + + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + + /// Whether this factory is eligible for persistent approval. + [JsonPropertyName("canPersistApproval")] + public required bool CanPersistApproval { get; set; } + + /// Gets or sets the declaredMaxAiCredits value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxAiCredits")] + public double? DeclaredMaxAiCredits { get; set; } + + /// Gets or sets the declaredMaxConcurrentSubagents value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxConcurrentSubagents")] + public long? DeclaredMaxConcurrentSubagents { get; set; } + + /// Gets or sets the declaredMaxTotalSubagents value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredMaxTotalSubagents")] + public long? DeclaredMaxTotalSubagents { get; set; } + + /// Gets or sets the declaredTimeoutSeconds value. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("declaredTimeoutSeconds")] + public double? DeclaredTimeoutSeconds { get; set; } + + /// Factory description. + [JsonPropertyName("description")] + public required string Description { get; set; } + + /// Whether managed policy requires a human response and forbids host auto-approval. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("managedApprovalRequired")] + public bool? ManagedApprovalRequired { get; set; } + + /// Effective AI-credit limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } + + /// Effective concurrent-subagent limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxConcurrentSubagents")] + public long? MaxConcurrentSubagents { get; set; } + + /// Effective total-subagent limit; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxTotalSubagents")] + public long? MaxTotalSubagents { get; set; } + + /// Factory name. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// Factory operation, either run or author. + [JsonPropertyName("operation")] + public required FactoryPermissionOperation Operation { get; set; } + + /// Declared factory phases. + [JsonPropertyName("phases")] + public required FactoryPermissionPhase[] Phases { get; set; } + + /// Effective active-time limit in seconds; omitted means unlimited. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("timeoutSeconds")] + public double? TimeoutSeconds { get; set; } + + /// Tool call ID that triggered this permission request. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("toolCallId")] + public string? ToolCallId { get; set; } +} + /// Extension permission access prompt. /// The extension-permission-access variant of . public sealed partial class PermissionPromptRequestExtensionPermissionAccess : PermissionPromptRequest @@ -5284,6 +8076,12 @@ public sealed partial class PermissionPromptRequestExtensionPermissionAccess : P [JsonIgnore] public override string Kind => "extension-permission-access"; + /// Auto-approval judge information for this request; present only when auto mode is enabled. + [Experimental(Diagnostics.Experimental)] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("autoApproval")] + public PermissionAutoApproval? AutoApproval { get; set; } + /// Capabilities the extension is requesting. [JsonPropertyName("capabilities")] public required string[] Capabilities { get; set; } @@ -5313,6 +8111,7 @@ public sealed partial class PermissionPromptRequestExtensionPermissionAccess : P [JsonDerivedType(typeof(PermissionPromptRequestPath), "path")] [JsonDerivedType(typeof(PermissionPromptRequestHook), "hook")] [JsonDerivedType(typeof(PermissionPromptRequestExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(PermissionPromptRequestFactory), "factory")] [JsonDerivedType(typeof(PermissionPromptRequestExtensionPermissionAccess), "extension-permission-access")] public partial class PermissionPromptRequest { @@ -5322,7 +8121,7 @@ public partial class PermissionPromptRequest } -/// Schema for the `PermissionApproved` type. +/// Permission response variant indicating the request was approved without persisting an approval rule. /// The approved variant of . public sealed partial class PermissionResultApproved : PermissionResult { @@ -5331,7 +8130,7 @@ public sealed partial class PermissionResultApproved : PermissionResult public override string Kind => "approved"; } -/// Schema for the `UserToolSessionApprovalCommands` type. +/// Session-scoped tool-approval rule for specific shell command identifiers. /// The commands variant of . public sealed partial class UserToolSessionApprovalCommands : UserToolSessionApproval { @@ -5344,7 +8143,7 @@ public sealed partial class UserToolSessionApprovalCommands : UserToolSessionApp public required string[] CommandIdentifiers { get; set; } } -/// Schema for the `UserToolSessionApprovalRead` type. +/// Session-scoped tool-approval rule for read-only filesystem operations. /// The read variant of . public sealed partial class UserToolSessionApprovalRead : UserToolSessionApproval { @@ -5353,7 +8152,7 @@ public sealed partial class UserToolSessionApprovalRead : UserToolSessionApprova public override string Kind => "read"; } -/// Schema for the `UserToolSessionApprovalWrite` type. +/// Session-scoped tool-approval rule for filesystem write operations. /// The write variant of . public sealed partial class UserToolSessionApprovalWrite : UserToolSessionApproval { @@ -5362,7 +8161,7 @@ public sealed partial class UserToolSessionApprovalWrite : UserToolSessionApprov public override string Kind => "write"; } -/// Schema for the `UserToolSessionApprovalMcp` type. +/// Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null. /// The mcp variant of . public sealed partial class UserToolSessionApprovalMcp : UserToolSessionApproval { @@ -5379,7 +8178,7 @@ public sealed partial class UserToolSessionApprovalMcp : UserToolSessionApproval public string? ToolName { get; set; } } -/// Schema for the `UserToolSessionApprovalMemory` type. +/// Session-scoped tool-approval rule for writes to long-term memory. /// The memory variant of . public sealed partial class UserToolSessionApprovalMemory : UserToolSessionApproval { @@ -5388,7 +8187,7 @@ public sealed partial class UserToolSessionApprovalMemory : UserToolSessionAppro public override string Kind => "memory"; } -/// Schema for the `UserToolSessionApprovalCustomTool` type. +/// Session-scoped tool-approval rule for a custom tool, keyed by tool name. /// The custom-tool variant of . public sealed partial class UserToolSessionApprovalCustomTool : UserToolSessionApproval { @@ -5401,7 +8200,7 @@ public sealed partial class UserToolSessionApprovalCustomTool : UserToolSessionA public required string ToolName { get; set; } } -/// Schema for the `UserToolSessionApprovalExtensionManagement` type. +/// Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation. /// The extension-management variant of . public sealed partial class UserToolSessionApprovalExtensionManagement : UserToolSessionApproval { @@ -5415,7 +8214,21 @@ public sealed partial class UserToolSessionApprovalExtensionManagement : UserToo public string? Operation { get; set; } } -/// Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type. +/// Session-scoped factory approval, optionally narrowed by approval key. +/// The factory variant of . +public sealed partial class UserToolSessionApprovalFactory : UserToolSessionApproval +{ + /// + [JsonIgnore] + public override string Kind => "factory"; + + /// Optional factory operation name or canonical approval key. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("approvalKey")] + public string? ApprovalKey { get; set; } +} + +/// Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name. /// The extension-permission-access variant of . public sealed partial class UserToolSessionApprovalExtensionPermissionAccess : UserToolSessionApproval { @@ -5440,6 +8253,7 @@ public sealed partial class UserToolSessionApprovalExtensionPermissionAccess : U [JsonDerivedType(typeof(UserToolSessionApprovalMemory), "memory")] [JsonDerivedType(typeof(UserToolSessionApprovalCustomTool), "custom-tool")] [JsonDerivedType(typeof(UserToolSessionApprovalExtensionManagement), "extension-management")] +[JsonDerivedType(typeof(UserToolSessionApprovalFactory), "factory")] [JsonDerivedType(typeof(UserToolSessionApprovalExtensionPermissionAccess), "extension-permission-access")] public partial class UserToolSessionApproval { @@ -5449,7 +8263,7 @@ public partial class UserToolSessionApproval } -/// Schema for the `PermissionApprovedForSession` type. +/// Permission response variant that approves a request and remembers the provided approval for the rest of the session. /// The approved-for-session variant of . public sealed partial class PermissionResultApprovedForSession : PermissionResult { @@ -5462,7 +8276,7 @@ public sealed partial class PermissionResultApprovedForSession : PermissionResul public required UserToolSessionApproval Approval { get; set; } } -/// Schema for the `PermissionApprovedForLocation` type. +/// Permission response variant that approves a request and persists the provided approval to a project location key. /// The approved-for-location variant of . public sealed partial class PermissionResultApprovedForLocation : PermissionResult { @@ -5479,7 +8293,7 @@ public sealed partial class PermissionResultApprovedForLocation : PermissionResu public required string LocationKey { get; set; } } -/// Schema for the `PermissionCancelled` type. +/// Permission response variant indicating the request was cancelled before use, with an optional reason. /// The cancelled variant of . public sealed partial class PermissionResultCancelled : PermissionResult { @@ -5493,7 +8307,7 @@ public sealed partial class PermissionResultCancelled : PermissionResult public string? Reason { get; set; } } -/// Schema for the `PermissionRule` type. +/// A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value. /// Nested data type for PermissionRule. public sealed partial class PermissionRule { @@ -5506,7 +8320,7 @@ public sealed partial class PermissionRule public required string Kind { get; set; } } -/// Schema for the `PermissionDeniedByRules` type. +/// Permission response variant denied because matching approval rules explicitly blocked the request. /// The denied-by-rules variant of . public sealed partial class PermissionResultDeniedByRules : PermissionResult { @@ -5519,7 +8333,7 @@ public sealed partial class PermissionResultDeniedByRules : PermissionResult public required PermissionRule[] Rules { get; set; } } -/// Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. +/// Permission response variant denied because no approval rule matched and user confirmation was unavailable. /// The denied-no-approval-rule-and-could-not-request-from-user variant of . public sealed partial class PermissionResultDeniedNoApprovalRuleAndCouldNotRequestFromUser : PermissionResult { @@ -5528,7 +8342,7 @@ public sealed partial class PermissionResultDeniedNoApprovalRuleAndCouldNotReque public override string Kind => "denied-no-approval-rule-and-could-not-request-from-user"; } -/// Schema for the `PermissionDeniedInteractivelyByUser` type. +/// Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag. /// The denied-interactively-by-user variant of . public sealed partial class PermissionResultDeniedInteractivelyByUser : PermissionResult { @@ -5547,7 +8361,7 @@ public sealed partial class PermissionResultDeniedInteractivelyByUser : Permissi public bool? ForceReject { get; set; } } -/// Schema for the `PermissionDeniedByContentExclusionPolicy` type. +/// Permission response variant denying a path under content exclusion policy, with the path and message. /// The denied-by-content-exclusion-policy variant of . public sealed partial class PermissionResultDeniedByContentExclusionPolicy : PermissionResult { @@ -5564,7 +8378,7 @@ public sealed partial class PermissionResultDeniedByContentExclusionPolicy : Per public required string Path { get; set; } } -/// Schema for the `PermissionDeniedByPermissionRequestHook` type. +/// Permission response variant denied by a permission-request hook, with optional message and interrupt flag. /// The denied-by-permission-request-hook variant of . public sealed partial class PermissionResultDeniedByPermissionRequestHook : PermissionResult { @@ -5623,6 +8437,37 @@ public sealed partial class ElicitationRequestedSchema public required string Type { get; set; } } +/// Single HTTP header entry as a name/value pair. +/// Nested data type for HeaderEntry. +public sealed partial class HeaderEntry +{ + /// HTTP response header name as observed by the runtime. + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// HTTP response header value as observed by the runtime. + [JsonPropertyName("value")] + public required string Value { get; set; } +} + +/// Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. +/// Nested data type for McpOauthHttpResponse. +public sealed partial class McpOauthHttpResponse +{ + /// Complete UTF-8 response body for host-specific challenge handling, including an empty string for an empty body. Omitted when the complete body is not valid UTF-8; body read failures fail the HTTP operation rather than exposing a partial response. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("body")] + public string? Body { get; set; } + + /// HTTP response headers as observed by the runtime. Order and casing are transport-dependent, and duplicate header names may appear multiple times. + [JsonPropertyName("headers")] + public required HeaderEntry[] Headers { get; set; } + + /// HTTP status code returned with the auth challenge. + [JsonPropertyName("statusCode")] + public required int StatusCode { get; set; } +} + /// Static OAuth client configuration, if the server specifies one. /// Nested data type for McpOauthRequiredStaticClientConfig. public sealed partial class McpOauthRequiredStaticClientConfig @@ -5631,6 +8476,11 @@ public sealed partial class McpOauthRequiredStaticClientConfig [JsonPropertyName("clientId")] public required string ClientId { get; set; } + /// Optional OAuth client secret for confidential static clients, when the runtime can resolve one. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("clientSecret")] + public string? ClientSecret { get; set; } + /// 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). [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyName("grantType")] @@ -5642,7 +8492,46 @@ public sealed partial class McpOauthRequiredStaticClientConfig public bool? PublicClient { get; set; } } -/// Schema for the `CommandsChangedCommand` type. +/// OAuth WWW-Authenticate parameters parsed from an MCP auth challenge. +/// Nested data type for McpOauthWWWAuthenticateParams. +public sealed partial class McpOauthWWWAuthenticateParams +{ + /// OAuth error from the WWW-Authenticate error parameter, if present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("error")] + public string? Error { get; set; } + + /// Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceMetadataUrl")] + public string? ResourceMetadataUrl { get; set; } + + /// Requested OAuth scopes from the WWW-Authenticate scope parameter, if present. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("scope")] + public string? Scope { get; set; } +} + +/// The user's selected action for an exhausted session limit. +/// Nested data type for SessionLimitsExhaustedResponse. +public sealed partial class SessionLimitsExhaustedResponse +{ + /// Action selected by the user. + [JsonPropertyName("action")] + public required SessionLimitsExhaustedResponseAction Action { get; set; } + + /// AI Credits to add to the current max when action is 'add'. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("additionalAiCredits")] + public double? AdditionalAiCredits { get; set; } + + /// New absolute max AI Credits when action is 'set'. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("maxAiCredits")] + public double? MaxAiCredits { get; set; } +} + +/// A single slash command available in the session, as listed by the `commands.changed` event. /// Nested data type for CommandsChangedCommand. public sealed partial class CommandsChangedCommand { @@ -5676,10 +8565,20 @@ public sealed partial class CapabilitiesChangedUI public bool? McpApps { get; set; } } -/// Schema for the `SkillsLoadedSkill` type. +/// A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint. /// Nested data type for SkillsLoadedSkill. public sealed partial class SkillsLoadedSkill { + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("argumentHint")] + public string? ArgumentHint { get; set; } + + /// Canonical slash command name used to invoke the skill, without the leading '/'. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("commandName")] + public string? CommandName { get; set; } + /// Description of what the skill does. [JsonPropertyName("description")] public required string Description { get; set; } @@ -5706,7 +8605,7 @@ public sealed partial class SkillsLoadedSkill public required bool UserInvocable { get; set; } } -/// Schema for the `CustomAgentsUpdatedAgent` type. +/// A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override. /// Nested data type for CustomAgentsUpdatedAgent. public sealed partial class CustomAgentsUpdatedAgent { @@ -5744,7 +8643,7 @@ public sealed partial class CustomAgentsUpdatedAgent public required bool UserInvocable { get; set; } } -/// Schema for the `McpServersLoadedServer` type. +/// A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata. /// Nested data type for McpServersLoadedServer. public sealed partial class McpServersLoadedServer { @@ -5772,7 +8671,7 @@ public sealed partial class McpServersLoadedServer [JsonPropertyName("source")] public McpServerSource? Source { get; set; } - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured. + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured. [JsonPropertyName("status")] public required McpServerStatus Status { get; set; } @@ -5782,11 +8681,11 @@ public sealed partial class McpServersLoadedServer public McpServerTransport? Transport { get; set; } } -/// Schema for the `ExtensionsLoadedExtension` type. +/// A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status. /// Nested data type for ExtensionsLoadedExtension. public sealed partial class ExtensionsLoadedExtension { - /// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper'). + /// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext'). [JsonPropertyName("id")] public required string Id { get; set; } @@ -5794,142 +8693,1864 @@ public sealed partial class ExtensionsLoadedExtension [JsonPropertyName("name")] public required string Name { get; set; } - /// Discovery source. - [JsonPropertyName("source")] - public required ExtensionsLoadedExtensionSource Source { get; set; } + /// Discovery source. + [JsonPropertyName("source")] + public required ExtensionsLoadedExtensionSource Source { get; set; } + + /// Current status: running, disabled, failed, or starting. + [JsonPropertyName("status")] + public required ExtensionsLoadedExtensionStatus Status { get; set; } +} + +/// A single action within a canvas declaration, with its name, optional description, and optional input schema. +/// Nested data type for CanvasRegistryChangedCanvasAction. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CanvasRegistryChangedCanvasAction +{ + /// Action description. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("description")] + public string? Description { get; set; } + + /// JSON Schema for action input. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } + + /// Action name. + [JsonPropertyName("name")] + public required string Name { get; set; } +} + +/// A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions. +/// Nested data type for CanvasRegistryChangedCanvas. +[Experimental(Diagnostics.Experimental)] +public sealed partial class CanvasRegistryChangedCanvas +{ + /// Actions the agent or host may invoke. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("actions")] + public CanvasRegistryChangedCanvasAction[]? Actions { get; set; } + + /// Provider-local canvas identifier. + [JsonPropertyName("canvasId")] + public required string CanvasId { get; set; } + + /// Short, single-sentence description shown to the agent in canvas catalogs. + [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] + [MinLength(1)] + [JsonPropertyName("description")] + public required string Description { get; set; } + + /// Human-readable canvas name. + [JsonPropertyName("displayName")] + public required string DisplayName { get; set; } + + /// Owning provider identifier. + [JsonPropertyName("extensionId")] + public required string ExtensionId { get; set; } + + /// Owning extension display name, when available. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("extensionName")] + public string? ExtensionName { get; set; } + + /// Host-local PNG path for the canvas icon, when supplied. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("icon")] + public string? Icon { get; set; } + + /// JSON Schema for canvas open input. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("inputSchema")] + public JsonElement? InputSchema { get; set; } +} + +/// Set when the underlying tools/call threw an error before returning a CallToolResult. +/// Nested data type for McpAppToolCallCompleteError. +public sealed partial class McpAppToolCallCompleteError +{ + /// Human-readable error message. + [JsonPropertyName("message")] + public required string Message { get; set; } +} + +/// MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. +/// Nested data type for McpAppToolCallCompleteToolMetaUI. +public sealed partial class McpAppToolCallCompleteToolMetaUI +{ + /// `ui://` URI declared by the tool's `_meta.ui.resourceUri`. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("resourceUri")] + public string? ResourceUri { get; set; } + + /// Tool visibility per SEP-1865 (typically a subset of `["model","app"]`). + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("visibility")] + public string[]? Visibility { get; set; } +} + +/// The tool's `_meta.ui` block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools. +/// Nested data type for McpAppToolCallCompleteToolMeta. +public sealed partial class McpAppToolCallCompleteToolMeta +{ + /// MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [JsonPropertyName("ui")] + public McpAppToolCallCompleteToolMetaUI? Ui { get; set; } +} + +/// Hosting platform type of the repository (github or ado). +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct WorkingDirectoryContextHostType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public WorkingDirectoryContextHostType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Repository is hosted on GitHub. + public static WorkingDirectoryContextHostType GitHub { get; } = new("github"); + + /// Repository is hosted on Azure DevOps. + public static WorkingDirectoryContextHostType Ado { get; } = new("ado"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is WorkingDirectoryContextHostType other && Equals(other); + + /// + public bool Equals(WorkingDirectoryContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override WorkingDirectoryContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, WorkingDirectoryContextHostType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkingDirectoryContextHostType)); + } + } +} + +/// Allowed values for the `ContextTier` enumeration. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ContextTier : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ContextTier(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Default context tier with standard context window size. + public static ContextTier Default { get; } = new("default"); + + /// Extended context tier with a larger context window. + public static ContextTier LongContext { get; } = new("long_context"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ContextTier left, ContextTier right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ContextTier left, ContextTier right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ContextTier other && Equals(other); + + /// + public bool Equals(ContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ContextTier value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ContextTier)); + } + } +} + +/// Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed"). +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ReasoningSummary : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ReasoningSummary(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Do not request reasoning summaries from the model. + public static ReasoningSummary None { get; } = new("none"); + + /// Request a concise summary of the model's reasoning. + public static ReasoningSummary Concise { get; } = new("concise"); + + /// Request a detailed summary of the model's reasoning. + public static ReasoningSummary Detailed { get; } = new("detailed"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ReasoningSummary left, ReasoningSummary right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ReasoningSummary left, ReasoningSummary right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ReasoningSummary other && Equals(other); + + /// + public bool Equals(ReasoningSummary other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ReasoningSummary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ReasoningSummary value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ReasoningSummary)); + } + } +} + +/// Output verbosity level used for supported model calls (e.g. "low", "medium", "high"). +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct Verbosity : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public Verbosity(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// A terse response was requested. + public static Verbosity Low { get; } = new("low"); + + /// A medium amount of response detail was requested. + public static Verbosity Medium { get; } = new("medium"); + + /// A more detailed response was requested. + public static Verbosity High { get; } = new("high"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(Verbosity left, Verbosity right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(Verbosity left, Verbosity right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is Verbosity other && Equals(other); + + /// + public bool Equals(Verbosity other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override Verbosity Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, Verbosity value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(Verbosity)); + } + } +} + +/// Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ScheduleOrigin : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ScheduleOrigin(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The schedule was created by an explicit user action, such as `/every` or `/after`. + public static ScheduleOrigin User { get; } = new("user"); + + /// The schedule was created by the agent via the `manage_schedule` tool. + public static ScheduleOrigin Model { get; } = new("model"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ScheduleOrigin left, ScheduleOrigin right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ScheduleOrigin left, ScheduleOrigin right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ScheduleOrigin other && Equals(other); + + /// + public bool Equals(ScheduleOrigin other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ScheduleOrigin Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ScheduleOrigin value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ScheduleOrigin)); + } + } +} + +/// The type of operation performed on the autopilot objective state file. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AutopilotObjectiveChangedOperation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AutopilotObjectiveChangedOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Autopilot objective state file was created for a new objective. + public static AutopilotObjectiveChangedOperation Create { get; } = new("create"); + + /// Autopilot objective state file was updated for an existing objective. + public static AutopilotObjectiveChangedOperation Update { get; } = new("update"); + + /// Autopilot objective state file was deleted or cleared. + public static AutopilotObjectiveChangedOperation Delete { get; } = new("delete"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutopilotObjectiveChangedOperation left, AutopilotObjectiveChangedOperation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutopilotObjectiveChangedOperation left, AutopilotObjectiveChangedOperation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AutopilotObjectiveChangedOperation other && Equals(other); + + /// + public bool Equals(AutopilotObjectiveChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AutopilotObjectiveChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AutopilotObjectiveChangedOperation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedOperation)); + } + } +} + +/// Current autopilot objective status, if one exists. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AutopilotObjectiveChangedStatus : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AutopilotObjectiveChangedStatus(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Objective is active and can drive autopilot continuations. + public static AutopilotObjectiveChangedStatus Active { get; } = new("active"); + + /// Objective is paused and will not drive autopilot continuations. + public static AutopilotObjectiveChangedStatus Paused { get; } = new("paused"); + + /// Legacy objective state indicating the previous continuation cap was reached. + public static AutopilotObjectiveChangedStatus CapReached { get; } = new("cap_reached"); + + /// Objective was completed by the agent. + public static AutopilotObjectiveChangedStatus Completed { get; } = new("completed"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AutopilotObjectiveChangedStatus other && Equals(other); + + /// + public bool Equals(AutopilotObjectiveChangedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AutopilotObjectiveChangedStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AutopilotObjectiveChangedStatus value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedStatus)); + } + } +} + +/// The session mode the agent is operating in. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct SessionMode : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public SessionMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The agent is responding interactively to the user. + public static SessionMode Interactive { get; } = new("interactive"); + + /// The agent is preparing a plan before making changes. + public static SessionMode Plan { get; } = new("plan"); + + /// The agent is working autonomously toward task completion. + public static SessionMode Autopilot { get; } = new("autopilot"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionMode left, SessionMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionMode left, SessionMode right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is SessionMode other && Equals(other); + + /// + public bool Equals(SessionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override SessionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, SessionMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionMode)); + } + } +} + +/// Allow-all mode for the session. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct PermissionAllowAllMode : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public PermissionAllowAllMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Permission requests follow the normal approval flow. + public static PermissionAllowAllMode Off { get; } = new("off"); + + /// Tool, path, and URL permission requests are automatically approved. + public static PermissionAllowAllMode On { get; } = new("on"); + + /// Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + public static PermissionAllowAllMode Auto { get; } = new("auto"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionAllowAllMode left, PermissionAllowAllMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionAllowAllMode left, PermissionAllowAllMode right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is PermissionAllowAllMode other && Equals(other); + + /// + public bool Equals(PermissionAllowAllMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override PermissionAllowAllMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, PermissionAllowAllMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionAllowAllMode)); + } + } +} + +/// The type of operation performed on the plan file. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct PlanChangedOperation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public PlanChangedOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The plan file was created. + public static PlanChangedOperation Create { get; } = new("create"); + + /// The plan file was updated. + public static PlanChangedOperation Update { get; } = new("update"); + + /// The plan file was deleted. + public static PlanChangedOperation Delete { get; } = new("delete"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PlanChangedOperation left, PlanChangedOperation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PlanChangedOperation left, PlanChangedOperation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is PlanChangedOperation other && Equals(other); + + /// + public bool Equals(PlanChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override PlanChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, PlanChangedOperation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PlanChangedOperation)); + } + } +} + +/// Whether the file was newly created or updated. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct WorkspaceFileChangedOperation : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public WorkspaceFileChangedOperation(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The workspace file was created. + public static WorkspaceFileChangedOperation Create { get; } = new("create"); + + /// The workspace file was updated. + public static WorkspaceFileChangedOperation Update { get; } = new("update"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is WorkspaceFileChangedOperation other && Equals(other); + + /// + public bool Equals(WorkspaceFileChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override WorkspaceFileChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, WorkspaceFileChangedOperation value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceFileChangedOperation)); + } + } +} + +/// Origin type of the session being handed off. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct HandoffSourceType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public HandoffSourceType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The handoff originated from a remote session. + public static HandoffSourceType Remote { get; } = new("remote"); + + /// The handoff originated from a local session. + public static HandoffSourceType Local { get; } = new("local"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(HandoffSourceType left, HandoffSourceType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(HandoffSourceType left, HandoffSourceType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is HandoffSourceType other && Equals(other); + + /// + public bool Equals(HandoffSourceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override HandoffSourceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, HandoffSourceType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HandoffSourceType)); + } + } +} + +/// Whether the session ended normally ("routine") or due to a crash/fatal error ("error"). +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ShutdownType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ShutdownType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The session ended normally. + public static ShutdownType Routine { get; } = new("routine"); + + /// The session ended because of a crash or fatal error. + public static ShutdownType Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ShutdownType left, ShutdownType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ShutdownType left, ShutdownType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ShutdownType other && Equals(other); + + /// + public bool Equals(ShutdownType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ShutdownType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ShutdownType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShutdownType)); + } + } +} + +/// What initiated a conversation compaction. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CompactionTrigger : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CompactionTrigger(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Background compaction started automatically because context utilization crossed the background threshold. + public static CompactionTrigger Threshold { get; } = new("threshold"); + + /// Compaction forced by a context-limit model response (e.g. HTTP 413) before retrying the request. + public static CompactionTrigger ContextLimitRetry { get; } = new("context_limit_retry"); + + /// User-requested compaction, e.g. the /compact command or the history.compact API. + public static CompactionTrigger Manual { get; } = new("manual"); + + /// Emergency compaction triggered by high process memory usage. + public static CompactionTrigger MemoryPressure { get; } = new("memory_pressure"); + + /// Compaction requested while switching to a model with a smaller context window. + public static CompactionTrigger ModelSwitch { get; } = new("model_switch"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CompactionTrigger left, CompactionTrigger right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CompactionTrigger left, CompactionTrigger right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CompactionTrigger other && Equals(other); + + /// + public bool Equals(CompactionTrigger other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override CompactionTrigger Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CompactionTrigger value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CompactionTrigger)); + } + } +} + +/// Semantic result of evaluating a task completion request. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct TaskCompletionOutcome : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public TaskCompletionOutcome(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The completion request was accepted and the objective is complete. + public static TaskCompletionOutcome Completed { get; } = new("completed"); + + /// The completion request was rejected because more work or validation remains. + public static TaskCompletionOutcome Continue { get; } = new("continue"); + + /// Completion cannot proceed without intervention; the active objective is paused when one is identified. + public static TaskCompletionOutcome Blocked { get; } = new("blocked"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(TaskCompletionOutcome left, TaskCompletionOutcome right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(TaskCompletionOutcome left, TaskCompletionOutcome right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is TaskCompletionOutcome other && Equals(other); + + /// + public bool Equals(TaskCompletionOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override TaskCompletionOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, TaskCompletionOutcome value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(TaskCompletionOutcome)); + } + } +} + +/// The agent mode that was active when this message was sent. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct UserMessageAgentMode : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public UserMessageAgentMode(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The agent is responding interactively to the user. + public static UserMessageAgentMode Interactive { get; } = new("interactive"); + + /// The agent is preparing a plan before making changes. + public static UserMessageAgentMode Plan { get; } = new("plan"); + + /// The agent is working autonomously toward task completion. + public static UserMessageAgentMode Autopilot { get; } = new("autopilot"); + + /// The agent is in shell-focused UI mode. + public static UserMessageAgentMode Shell { get; } = new("shell"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UserMessageAgentMode left, UserMessageAgentMode right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UserMessageAgentMode left, UserMessageAgentMode right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is UserMessageAgentMode other && Equals(other); + + /// + public bool Equals(UserMessageAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override UserMessageAgentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, UserMessageAgentMode value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageAgentMode)); + } + } +} + +/// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct OmittedBinaryOmittedReason : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public OmittedBinaryOmittedReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Bytes exceeded the session's inline size limit. + public static OmittedBinaryOmittedReason TooLarge { get; } = new("too_large"); + + /// The referenced binary asset could not be found (e.g. a truncated log). + public static OmittedBinaryOmittedReason AssetUnavailable { get; } = new("asset_unavailable"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OmittedBinaryOmittedReason left, OmittedBinaryOmittedReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OmittedBinaryOmittedReason left, OmittedBinaryOmittedReason right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is OmittedBinaryOmittedReason other && Equals(other); + + /// + public bool Equals(OmittedBinaryOmittedReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override OmittedBinaryOmittedReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, OmittedBinaryOmittedReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OmittedBinaryOmittedReason)); + } + } +} + +/// Type of GitHub reference. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AttachmentGitHubReferenceType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AttachmentGitHubReferenceType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// GitHub issue reference. + public static AttachmentGitHubReferenceType Issue { get; } = new("issue"); + + /// GitHub pull request reference. + public static AttachmentGitHubReferenceType Pr { get; } = new("pr"); + + /// GitHub discussion reference. + public static AttachmentGitHubReferenceType Discussion { get; } = new("discussion"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AttachmentGitHubReferenceType left, AttachmentGitHubReferenceType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AttachmentGitHubReferenceType left, AttachmentGitHubReferenceType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AttachmentGitHubReferenceType other && Equals(other); + + /// + public bool Equals(AttachmentGitHubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AttachmentGitHubReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AttachmentGitHubReferenceType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AttachmentGitHubReferenceType)); + } + } +} + +/// How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct UserMessageDelivery : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public UserMessageDelivery(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). + public static UserMessageDelivery Idle { get; } = new("idle"); + + /// Injected into the current in-flight run while the agent was busy (immediate mode). + public static UserMessageDelivery Steering { get; } = new("steering"); + + /// Enqueued while the agent was busy; processed as its own run afterward. + public static UserMessageDelivery Queued { get; } = new("queued"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(UserMessageDelivery left, UserMessageDelivery right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(UserMessageDelivery left, UserMessageDelivery right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is UserMessageDelivery other && Equals(other); + + /// + public bool Equals(UserMessageDelivery other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override UserMessageDelivery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, UserMessageDelivery value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageDelivery)); + } + } +} + +/// Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AssistantMessageToolRequestType : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AssistantMessageToolRequestType(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Standard function-style tool call. + public static AssistantMessageToolRequestType Function { get; } = new("function"); + + /// Custom grammar-based tool call. + public static AssistantMessageToolRequestType Custom { get; } = new("custom"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AssistantMessageToolRequestType left, AssistantMessageToolRequestType right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AssistantMessageToolRequestType left, AssistantMessageToolRequestType right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AssistantMessageToolRequestType other && Equals(other); + + /// + public bool Equals(AssistantMessageToolRequestType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AssistantMessageToolRequestType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AssistantMessageToolRequestType value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistantMessageToolRequestType)); + } + } +} + +/// The system that produced a citation. +[Experimental(Diagnostics.Experimental)] +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct CitationProvider : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public CitationProvider(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Citation produced by an Anthropic (Claude) model response. + public static CitationProvider Anthropic { get; } = new("anthropic"); + + /// Citation produced by an OpenAI model response. + public static CitationProvider Openai { get; } = new("openai"); + + /// Citation synthesized client-side by the runtime from tool output. + public static CitationProvider Client { get; } = new("client"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(CitationProvider left, CitationProvider right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(CitationProvider left, CitationProvider right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is CitationProvider other && Equals(other); + + /// + public bool Equals(CitationProvider other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override CitationProvider Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, CitationProvider value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CitationProvider)); + } + } +} + +/// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AssistantUsageApiEndpoint : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AssistantUsageApiEndpoint(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Chat Completions API endpoint. + public static AssistantUsageApiEndpoint ChatCompletions { get; } = new("/chat/completions"); + + /// Anthropic Messages API endpoint. + public static AssistantUsageApiEndpoint V1Messages { get; } = new("/v1/messages"); + + /// Responses API endpoint. + public static AssistantUsageApiEndpoint Responses { get; } = new("/responses"); + + /// WebSocket Responses API endpoint. + public static AssistantUsageApiEndpoint WsResponses { get; } = new("ws:/responses"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AssistantUsageApiEndpoint left, AssistantUsageApiEndpoint right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AssistantUsageApiEndpoint left, AssistantUsageApiEndpoint right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is AssistantUsageApiEndpoint other && Equals(other); + + /// + public bool Equals(AssistantUsageApiEndpoint other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AssistantUsageApiEndpoint Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AssistantUsageApiEndpoint value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistantUsageApiEndpoint)); + } + } +} + +/// For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelCallFailureBadRequestKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelCallFailureBadRequestKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The 400 response carried no error body (transient gateway/proxy signature). + public static ModelCallFailureBadRequestKind Bodyless { get; } = new("bodyless"); + + /// The 400 response carried a structured CAPI error envelope (deterministic validation failure). + public static ModelCallFailureBadRequestKind StructuredError { get; } = new("structured_error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelCallFailureBadRequestKind left, ModelCallFailureBadRequestKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelCallFailureBadRequestKind left, ModelCallFailureBadRequestKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelCallFailureBadRequestKind other && Equals(other); + + /// + public bool Equals(ModelCallFailureBadRequestKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelCallFailureBadRequestKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelCallFailureBadRequestKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureBadRequestKind)); + } + } +} + +/// Boundary that produced a model call failure. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelCallFailureKind : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelCallFailureKind(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// The provider returned an API error response. + public static ModelCallFailureKind Api { get; } = new("api"); + + /// The request transport failed before a usable API response completed. + public static ModelCallFailureKind Transport { get; } = new("transport"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelCallFailureKind left, ModelCallFailureKind right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelCallFailureKind left, ModelCallFailureKind right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelCallFailureKind other && Equals(other); + + /// + public bool Equals(ModelCallFailureKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelCallFailureKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelCallFailureKind value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureKind)); + } + } +} + +/// Where the failed model call originated. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelCallFailureSource : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelCallFailureSource(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// Model call from the top-level agent. + public static ModelCallFailureSource TopLevel { get; } = new("top_level"); + + /// Model call from a sub-agent. + public static ModelCallFailureSource Subagent { get; } = new("subagent"); + + /// Model call from MCP sampling. + public static ModelCallFailureSource McpSampling { get; } = new("mcp_sampling"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelCallFailureSource left, ModelCallFailureSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelCallFailureSource left, ModelCallFailureSource right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelCallFailureSource other && Equals(other); + + /// + public bool Equals(ModelCallFailureSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; + + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelCallFailureSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelCallFailureSource value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureSource)); + } + } +} + +/// Transport used for a failed model call. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct ModelCallFailureTransport : IEquatable +{ + private readonly string? _value; + + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public ModelCallFailureTransport(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } + + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; + + /// HTTP transport, including SSE streams. + public static ModelCallFailureTransport Http { get; } = new("http"); + + /// WebSocket transport. + public static ModelCallFailureTransport Websocket { get; } = new("websocket"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ModelCallFailureTransport left, ModelCallFailureTransport right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ModelCallFailureTransport left, ModelCallFailureTransport right) => !(left == right); + + /// + public override bool Equals(object? obj) => obj is ModelCallFailureTransport other && Equals(other); + + /// + public bool Equals(ModelCallFailureTransport other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + + /// + public override string ToString() => Value; - /// Current status: running, disabled, failed, or starting. - [JsonPropertyName("status")] - public required ExtensionsLoadedExtensionStatus Status { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override ModelCallFailureTransport Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, ModelCallFailureTransport value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureTransport)); + } + } } -/// Schema for the `CanvasRegistryChangedCanvasAction` type. -/// Nested data type for CanvasRegistryChangedCanvasAction. -public sealed partial class CanvasRegistryChangedCanvasAction +/// Finite reason code describing why the current turn was aborted. +[JsonConverter(typeof(Converter))] +[DebuggerDisplay("{Value,nq}")] +public readonly struct AbortReason : IEquatable { - /// Action description. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("description")] - public string? Description { get; set; } + private readonly string? _value; - /// JSON Schema for action input. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("inputSchema")] - public JsonElement? InputSchema { get; set; } + /// Initializes a new instance of the struct. + /// The value to associate with this . + [JsonConstructor] + public AbortReason(string value) + { + ArgumentException.ThrowIfNullOrWhiteSpace(value); + _value = value; + } - /// Action name. - [JsonPropertyName("name")] - public required string Name { get; set; } -} + /// Gets the value associated with this . + public string Value => _value ?? string.Empty; -/// Schema for the `CanvasRegistryChangedCanvas` type. -/// Nested data type for CanvasRegistryChangedCanvas. -public sealed partial class CanvasRegistryChangedCanvas -{ - /// Actions the agent or host may invoke. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("actions")] - public CanvasRegistryChangedCanvasAction[]? Actions { get; set; } + /// The local user requested the abort, for example by pressing Ctrl+C in the CLI. + public static AbortReason UserInitiated { get; } = new("user_initiated"); - /// Provider-local canvas identifier. - [JsonPropertyName("canvasId")] - public required string CanvasId { get; set; } + /// A remote command requested the abort. + public static AbortReason RemoteCommand { get; } = new("remote_command"); - /// Short, single-sentence description shown to the agent in canvas catalogs. - [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members")] - [MinLength(1)] - [JsonPropertyName("description")] - public required string Description { get; set; } + /// An MCP server delivered a user.abort notification. + public static AbortReason UserAbort { get; } = new("user_abort"); - /// Human-readable canvas name. - [JsonPropertyName("displayName")] - public required string DisplayName { get; set; } + /// Autopilot stopped the run because the active objective reached its user-set --max-ai-credits limit. + public static AbortReason AutopilotCreditLimit { get; } = new("autopilot_credit_limit"); - /// Owning provider identifier. - [JsonPropertyName("extensionId")] - public required string ExtensionId { get; set; } + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AbortReason left, AbortReason right) => left.Equals(right); - /// Owning extension display name, when available. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("extensionName")] - public string? ExtensionName { get; set; } + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AbortReason left, AbortReason right) => !(left == right); - /// JSON Schema for canvas open input. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("inputSchema")] - public JsonElement? InputSchema { get; set; } -} + /// + public override bool Equals(object? obj) => obj is AbortReason other && Equals(other); -/// Set when the underlying tools/call threw an error before returning a CallToolResult. -/// Nested data type for McpAppToolCallCompleteError. -public sealed partial class McpAppToolCallCompleteError -{ - /// Human-readable error message. - [JsonPropertyName("message")] - public required string Message { get; set; } -} + /// + public bool Equals(AbortReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); -/// Schema for the `McpAppToolCallCompleteToolMetaUI` type. -/// Nested data type for McpAppToolCallCompleteToolMetaUI. -public sealed partial class McpAppToolCallCompleteToolMetaUI -{ - /// `ui://` URI declared by the tool's `_meta.ui.resourceUri`. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("resourceUri")] - public string? ResourceUri { get; set; } + /// + public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - /// Tool visibility per SEP-1865 (typically a subset of `["model","app"]`). - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("visibility")] - public string[]? Visibility { get; set; } -} + /// + public override string ToString() => Value; -/// The tool's `_meta.ui` block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools. -/// Nested data type for McpAppToolCallCompleteToolMeta. -public sealed partial class McpAppToolCallCompleteToolMeta -{ - /// Schema for the `McpAppToolCallCompleteToolMetaUI` type. - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [JsonPropertyName("ui")] - public McpAppToolCallCompleteToolMetaUI? Ui { get; set; } + /// Provides a for serializing instances. + [EditorBrowsable(EditorBrowsableState.Never)] + public sealed class Converter : JsonConverter + { + /// + public override AbortReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + } + + /// + public override void Write(Utf8JsonWriter writer, AbortReason value, JsonSerializerOptions options) + { + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AbortReason)); + } + } } -/// Hosting platform type of the repository (github or ado). +/// Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkingDirectoryContextHostType : IEquatable +public readonly struct ToolExecutionStartToolDescriptionMetaUIVisibility : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkingDirectoryContextHostType(string value) + public ToolExecutionStartToolDescriptionMetaUIVisibility(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Repository is hosted on GitHub. - public static WorkingDirectoryContextHostType Github { get; } = new("github"); + /// Tool is callable by the model (LLM tool surface). + public static ToolExecutionStartToolDescriptionMetaUIVisibility Model { get; } = new("model"); - /// Repository is hosted on Azure DevOps. - public static WorkingDirectoryContextHostType Ado { get; } = new("ado"); + /// Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool. + public static ToolExecutionStartToolDescriptionMetaUIVisibility App { get; } = new("app"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ToolExecutionStartToolDescriptionMetaUIVisibility left, ToolExecutionStartToolDescriptionMetaUIVisibility right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkingDirectoryContextHostType left, WorkingDirectoryContextHostType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ToolExecutionStartToolDescriptionMetaUIVisibility left, ToolExecutionStartToolDescriptionMetaUIVisibility right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkingDirectoryContextHostType other && Equals(other); + public override bool Equals(object? obj) => obj is ToolExecutionStartToolDescriptionMetaUIVisibility other && Equals(other); /// - public bool Equals(WorkingDirectoryContextHostType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ToolExecutionStartToolDescriptionMetaUIVisibility other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -5937,60 +10558,60 @@ public WorkingDirectoryContextHostType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkingDirectoryContextHostType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ToolExecutionStartToolDescriptionMetaUIVisibility Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkingDirectoryContextHostType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ToolExecutionStartToolDescriptionMetaUIVisibility value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkingDirectoryContextHostType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolExecutionStartToolDescriptionMetaUIVisibility)); } } } -/// Defines the allowed values. +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionStartDataContextTier : IEquatable +public readonly struct PersistedBinaryImageType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionStartDataContextTier(string value) + public PersistedBinaryImageType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Default context tier with standard context window size. - public static SessionStartDataContextTier Default { get; } = new("default"); + /// Binary image data. + public static PersistedBinaryImageType Image { get; } = new("image"); - /// Extended context tier with a larger context window. - public static SessionStartDataContextTier LongContext { get; } = new("long_context"); + /// Other binary resource data. + public static PersistedBinaryImageType Resource { get; } = new("resource"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionStartDataContextTier left, SessionStartDataContextTier right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PersistedBinaryImageType left, PersistedBinaryImageType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionStartDataContextTier left, SessionStartDataContextTier right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PersistedBinaryImageType left, PersistedBinaryImageType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionStartDataContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is PersistedBinaryImageType other && Equals(other); /// - public bool Equals(SessionStartDataContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PersistedBinaryImageType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -5998,63 +10619,60 @@ public SessionStartDataContextTier(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionStartDataContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PersistedBinaryImageType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionStartDataContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PersistedBinaryImageType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionStartDataContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PersistedBinaryImageType)); } } } -/// Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed"). +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ReasoningSummary : IEquatable +public readonly struct OmittedBinaryType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ReasoningSummary(string value) + public OmittedBinaryType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Do not request reasoning summaries from the model. - public static ReasoningSummary None { get; } = new("none"); - - /// Request a concise summary of the model's reasoning. - public static ReasoningSummary Concise { get; } = new("concise"); + /// Binary image data. + public static OmittedBinaryType Image { get; } = new("image"); - /// Request a detailed summary of the model's reasoning. - public static ReasoningSummary Detailed { get; } = new("detailed"); + /// Other binary resource data. + public static OmittedBinaryType Resource { get; } = new("resource"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ReasoningSummary left, ReasoningSummary right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(OmittedBinaryType left, OmittedBinaryType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ReasoningSummary left, ReasoningSummary right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(OmittedBinaryType left, OmittedBinaryType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ReasoningSummary other && Equals(other); + public override bool Equals(object? obj) => obj is OmittedBinaryType other && Equals(other); /// - public bool Equals(ReasoningSummary other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(OmittedBinaryType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6062,60 +10680,60 @@ public ReasoningSummary(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ReasoningSummary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override OmittedBinaryType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ReasoningSummary value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, OmittedBinaryType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ReasoningSummary)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(OmittedBinaryType)); } } } -/// Defines the allowed values. +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionResumeDataContextTier : IEquatable +public readonly struct BinaryAssetReferenceType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionResumeDataContextTier(string value) + public BinaryAssetReferenceType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Default context tier with standard context window size. - public static SessionResumeDataContextTier Default { get; } = new("default"); + /// Binary image data. + public static BinaryAssetReferenceType Image { get; } = new("image"); - /// Extended context tier with a larger context window. - public static SessionResumeDataContextTier LongContext { get; } = new("long_context"); + /// Other binary resource data. + public static BinaryAssetReferenceType Resource { get; } = new("resource"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionResumeDataContextTier left, SessionResumeDataContextTier right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(BinaryAssetReferenceType left, BinaryAssetReferenceType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionResumeDataContextTier left, SessionResumeDataContextTier right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(BinaryAssetReferenceType left, BinaryAssetReferenceType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionResumeDataContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is BinaryAssetReferenceType other && Equals(other); /// - public bool Equals(SessionResumeDataContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(BinaryAssetReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6123,63 +10741,60 @@ public SessionResumeDataContextTier(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionResumeDataContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override BinaryAssetReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionResumeDataContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, BinaryAssetReferenceType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionResumeDataContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BinaryAssetReferenceType)); } } } -/// The type of operation performed on the autopilot objective state file. +/// Theme variant this icon is intended for. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutopilotObjectiveChangedOperation : IEquatable +public readonly struct ToolExecutionCompleteContentResourceLinkIconTheme : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AutopilotObjectiveChangedOperation(string value) + public ToolExecutionCompleteContentResourceLinkIconTheme(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Autopilot objective state file was created for a new objective. - public static AutopilotObjectiveChangedOperation Create { get; } = new("create"); - - /// Autopilot objective state file was updated for an existing objective. - public static AutopilotObjectiveChangedOperation Update { get; } = new("update"); + /// Icon intended for light themes. + public static ToolExecutionCompleteContentResourceLinkIconTheme Light { get; } = new("light"); - /// Autopilot objective state file was deleted or cleared. - public static AutopilotObjectiveChangedOperation Delete { get; } = new("delete"); + /// Icon intended for dark themes. + public static ToolExecutionCompleteContentResourceLinkIconTheme Dark { get; } = new("dark"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AutopilotObjectiveChangedOperation left, AutopilotObjectiveChangedOperation right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ToolExecutionCompleteContentResourceLinkIconTheme left, ToolExecutionCompleteContentResourceLinkIconTheme right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AutopilotObjectiveChangedOperation left, AutopilotObjectiveChangedOperation right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ToolExecutionCompleteContentResourceLinkIconTheme left, ToolExecutionCompleteContentResourceLinkIconTheme right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AutopilotObjectiveChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is ToolExecutionCompleteContentResourceLinkIconTheme other && Equals(other); /// - public bool Equals(AutopilotObjectiveChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ToolExecutionCompleteContentResourceLinkIconTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6187,66 +10802,60 @@ public AutopilotObjectiveChangedOperation(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AutopilotObjectiveChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ToolExecutionCompleteContentResourceLinkIconTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AutopilotObjectiveChangedOperation value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ToolExecutionCompleteContentResourceLinkIconTheme value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolExecutionCompleteContentResourceLinkIconTheme)); } } } -/// Current autopilot objective status, if one exists. +/// Allowed values for the `ToolExecutionCompleteToolDescriptionMetaUIVisibility` enumeration. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutopilotObjectiveChangedStatus : IEquatable +public readonly struct ToolExecutionCompleteToolDescriptionMetaUIVisibility : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AutopilotObjectiveChangedStatus(string value) + public ToolExecutionCompleteToolDescriptionMetaUIVisibility(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Objective is active and can drive autopilot continuations. - public static AutopilotObjectiveChangedStatus Active { get; } = new("active"); - - /// Objective is paused and will not drive autopilot continuations. - public static AutopilotObjectiveChangedStatus Paused { get; } = new("paused"); - - /// Legacy objective state indicating the previous continuation cap was reached. - public static AutopilotObjectiveChangedStatus CapReached { get; } = new("cap_reached"); - - /// Objective was completed by the agent. - public static AutopilotObjectiveChangedStatus Completed { get; } = new("completed"); + /// Tool is callable by the model (LLM tool surface). + public static ToolExecutionCompleteToolDescriptionMetaUIVisibility Model { get; } = new("model"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => left.Equals(right); + /// Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool. + public static ToolExecutionCompleteToolDescriptionMetaUIVisibility App { get; } = new("app"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AutopilotObjectiveChangedStatus left, AutopilotObjectiveChangedStatus right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ToolExecutionCompleteToolDescriptionMetaUIVisibility left, ToolExecutionCompleteToolDescriptionMetaUIVisibility right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ToolExecutionCompleteToolDescriptionMetaUIVisibility left, ToolExecutionCompleteToolDescriptionMetaUIVisibility right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AutopilotObjectiveChangedStatus other && Equals(other); + public override bool Equals(object? obj) => obj is ToolExecutionCompleteToolDescriptionMetaUIVisibility other && Equals(other); /// - public bool Equals(AutopilotObjectiveChangedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ToolExecutionCompleteToolDescriptionMetaUIVisibility other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6254,60 +10863,63 @@ public AutopilotObjectiveChangedStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AutopilotObjectiveChangedStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ToolExecutionCompleteToolDescriptionMetaUIVisibility Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AutopilotObjectiveChangedStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ToolExecutionCompleteToolDescriptionMetaUIVisibility value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutopilotObjectiveChangedStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolExecutionCompleteToolDescriptionMetaUIVisibility)); } } } -/// Defines the allowed values. +/// What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionModelChangeDataContextTier : IEquatable +public readonly struct SkillInvokedTrigger : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionModelChangeDataContextTier(string value) + public SkillInvokedTrigger(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Default context tier with standard context window size. - public static SessionModelChangeDataContextTier Default { get; } = new("default"); + /// Skill invocation requested explicitly by the user, such as via a slash command or UI affordance. + public static SkillInvokedTrigger UserInvoked { get; } = new("user-invoked"); - /// Extended context tier with a larger context window. - public static SessionModelChangeDataContextTier LongContext { get; } = new("long_context"); + /// Skill invocation requested by the agent. + public static SkillInvokedTrigger AgentInvoked { get; } = new("agent-invoked"); + + /// Skill content loaded as part of another context, such as a configured custom agent or subagent. + public static SkillInvokedTrigger ContextLoad { get; } = new("context-load"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionModelChangeDataContextTier left, SessionModelChangeDataContextTier right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SkillInvokedTrigger left, SkillInvokedTrigger right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionModelChangeDataContextTier left, SessionModelChangeDataContextTier right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SkillInvokedTrigger left, SkillInvokedTrigger right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionModelChangeDataContextTier other && Equals(other); + public override bool Equals(object? obj) => obj is SkillInvokedTrigger other && Equals(other); /// - public bool Equals(SessionModelChangeDataContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SkillInvokedTrigger other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6315,63 +10927,60 @@ public SessionModelChangeDataContextTier(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionModelChangeDataContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SkillInvokedTrigger Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionModelChangeDataContextTier value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SkillInvokedTrigger value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionModelChangeDataContextTier)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillInvokedTrigger)); } } } -/// The session mode the agent is operating in. +/// Binary asset type discriminator. Use "image" for images and "resource" otherwise. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SessionMode : IEquatable +public readonly struct BinaryAssetType : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SessionMode(string value) + public BinaryAssetType(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The agent is responding interactively to the user. - public static SessionMode Interactive { get; } = new("interactive"); - - /// The agent is preparing a plan before making changes. - public static SessionMode Plan { get; } = new("plan"); + /// Binary image data. + public static BinaryAssetType Image { get; } = new("image"); - /// The agent is working autonomously toward task completion. - public static SessionMode Autopilot { get; } = new("autopilot"); + /// Other binary resource data. + public static BinaryAssetType Resource { get; } = new("resource"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SessionMode left, SessionMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(BinaryAssetType left, BinaryAssetType right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SessionMode left, SessionMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(BinaryAssetType left, BinaryAssetType right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SessionMode other && Equals(other); + public override bool Equals(object? obj) => obj is BinaryAssetType other && Equals(other); /// - public bool Equals(SessionMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(BinaryAssetType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6379,63 +10988,60 @@ public SessionMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SessionMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override BinaryAssetType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SessionMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, BinaryAssetType value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(BinaryAssetType)); } } } -/// The type of operation performed on the plan file. +/// Message role: "system" for system prompts, "developer" for developer-injected instructions. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PlanChangedOperation : IEquatable +public readonly struct SystemMessageRole : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PlanChangedOperation(string value) + public SystemMessageRole(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The plan file was created. - public static PlanChangedOperation Create { get; } = new("create"); - - /// The plan file was updated. - public static PlanChangedOperation Update { get; } = new("update"); + /// System prompt message. + public static SystemMessageRole System { get; } = new("system"); - /// The plan file was deleted. - public static PlanChangedOperation Delete { get; } = new("delete"); + /// Developer instruction message. + public static SystemMessageRole Developer { get; } = new("developer"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PlanChangedOperation left, PlanChangedOperation right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SystemMessageRole left, SystemMessageRole right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PlanChangedOperation left, PlanChangedOperation right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SystemMessageRole left, SystemMessageRole right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PlanChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is SystemMessageRole other && Equals(other); /// - public bool Equals(PlanChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SystemMessageRole other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6443,60 +11049,60 @@ public PlanChangedOperation(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PlanChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SystemMessageRole Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PlanChangedOperation value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SystemMessageRole value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PlanChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemMessageRole)); } } } -/// Whether the file was newly created or updated. +/// Whether the agent completed successfully or failed. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct WorkspaceFileChangedOperation : IEquatable +public readonly struct SystemNotificationAgentCompletedStatus : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public WorkspaceFileChangedOperation(string value) + public SystemNotificationAgentCompletedStatus(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The workspace file was created. - public static WorkspaceFileChangedOperation Create { get; } = new("create"); + /// The agent completed successfully. + public static SystemNotificationAgentCompletedStatus Completed { get; } = new("completed"); - /// The workspace file was updated. - public static WorkspaceFileChangedOperation Update { get; } = new("update"); + /// The agent failed. + public static SystemNotificationAgentCompletedStatus Failed { get; } = new("failed"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(WorkspaceFileChangedOperation left, WorkspaceFileChangedOperation right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is WorkspaceFileChangedOperation other && Equals(other); + public override bool Equals(object? obj) => obj is SystemNotificationAgentCompletedStatus other && Equals(other); /// - public bool Equals(WorkspaceFileChangedOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SystemNotificationAgentCompletedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6504,60 +11110,66 @@ public WorkspaceFileChangedOperation(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override WorkspaceFileChangedOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SystemNotificationAgentCompletedStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, WorkspaceFileChangedOperation value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SystemNotificationAgentCompletedStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(WorkspaceFileChangedOperation)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationAgentCompletedStatus)); } } } -/// Origin type of the session being handed off. +/// Terminal status reached by a factory execution attempt. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct HandoffSourceType : IEquatable +public readonly struct SystemNotificationFactoryCompletedStatus : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public HandoffSourceType(string value) + public SystemNotificationFactoryCompletedStatus(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The handoff originated from a remote session. - public static HandoffSourceType Remote { get; } = new("remote"); + /// The factory completed successfully. + public static SystemNotificationFactoryCompletedStatus Completed { get; } = new("completed"); - /// The handoff originated from a local session. - public static HandoffSourceType Local { get; } = new("local"); + /// The factory was halted. + public static SystemNotificationFactoryCompletedStatus Halted { get; } = new("halted"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(HandoffSourceType left, HandoffSourceType right) => left.Equals(right); + /// The factory was cancelled. + public static SystemNotificationFactoryCompletedStatus Cancelled { get; } = new("cancelled"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(HandoffSourceType left, HandoffSourceType right) => !(left == right); + /// The factory failed. + public static SystemNotificationFactoryCompletedStatus Error { get; } = new("error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SystemNotificationFactoryCompletedStatus left, SystemNotificationFactoryCompletedStatus right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SystemNotificationFactoryCompletedStatus left, SystemNotificationFactoryCompletedStatus right) => !(left == right); /// - public override bool Equals(object? obj) => obj is HandoffSourceType other && Equals(other); + public override bool Equals(object? obj) => obj is SystemNotificationFactoryCompletedStatus other && Equals(other); /// - public bool Equals(HandoffSourceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SystemNotificationFactoryCompletedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6565,60 +11177,60 @@ public HandoffSourceType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override HandoffSourceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SystemNotificationFactoryCompletedStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, HandoffSourceType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SystemNotificationFactoryCompletedStatus value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(HandoffSourceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationFactoryCompletedStatus)); } } } -/// Whether the session ended normally ("routine") or due to a crash/fatal error ("error"). +/// Whether this is a store or vote memory operation. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ShutdownType : IEquatable +public readonly struct PermissionRequestMemoryAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ShutdownType(string value) + public PermissionRequestMemoryAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The session ended normally. - public static ShutdownType Routine { get; } = new("routine"); + /// Store a new memory. + public static PermissionRequestMemoryAction Store { get; } = new("store"); - /// The session ended because of a crash or fatal error. - public static ShutdownType Error { get; } = new("error"); + /// Vote on an existing memory. + public static PermissionRequestMemoryAction Vote { get; } = new("vote"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ShutdownType left, ShutdownType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ShutdownType left, ShutdownType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ShutdownType other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionRequestMemoryAction other && Equals(other); /// - public bool Equals(ShutdownType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionRequestMemoryAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6626,66 +11238,60 @@ public ShutdownType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ShutdownType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionRequestMemoryAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ShutdownType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ShutdownType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryAction)); } } } -/// The agent mode that was active when this message was sent. +/// Vote direction (vote only). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UserMessageAgentMode : IEquatable +public readonly struct PermissionRequestMemoryDirection : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public UserMessageAgentMode(string value) + public PermissionRequestMemoryDirection(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The agent is responding interactively to the user. - public static UserMessageAgentMode Interactive { get; } = new("interactive"); - - /// The agent is preparing a plan before making changes. - public static UserMessageAgentMode Plan { get; } = new("plan"); - - /// The agent is working autonomously toward task completion. - public static UserMessageAgentMode Autopilot { get; } = new("autopilot"); + /// Vote that the memory is useful or accurate. + public static PermissionRequestMemoryDirection Upvote { get; } = new("upvote"); - /// The agent is in shell-focused UI mode. - public static UserMessageAgentMode Shell { get; } = new("shell"); + /// Vote that the memory is incorrect or outdated. + public static PermissionRequestMemoryDirection Downvote { get; } = new("downvote"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(UserMessageAgentMode left, UserMessageAgentMode right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionRequestMemoryDirection left, PermissionRequestMemoryDirection right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UserMessageAgentMode left, UserMessageAgentMode right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionRequestMemoryDirection left, PermissionRequestMemoryDirection right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UserMessageAgentMode other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionRequestMemoryDirection other && Equals(other); /// - public bool Equals(UserMessageAgentMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionRequestMemoryDirection other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6693,63 +11299,60 @@ public UserMessageAgentMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override UserMessageAgentMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionRequestMemoryDirection Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, UserMessageAgentMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryDirection value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageAgentMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryDirection)); } } } -/// Type of GitHub reference. +/// Operation gated by a factory permission request. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct UserMessageAttachmentGithubReferenceType : IEquatable +public readonly struct FactoryPermissionOperation : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public UserMessageAttachmentGithubReferenceType(string value) + public FactoryPermissionOperation(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// GitHub issue reference. - public static UserMessageAttachmentGithubReferenceType Issue { get; } = new("issue"); - - /// GitHub pull request reference. - public static UserMessageAttachmentGithubReferenceType Pr { get; } = new("pr"); + /// Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. + public static FactoryPermissionOperation Run { get; } = new("run"); - /// GitHub discussion reference. - public static UserMessageAttachmentGithubReferenceType Discussion { get; } = new("discussion"); + /// Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. + public static FactoryPermissionOperation Author { get; } = new("author"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(UserMessageAttachmentGithubReferenceType left, UserMessageAttachmentGithubReferenceType right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(FactoryPermissionOperation left, FactoryPermissionOperation right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(UserMessageAttachmentGithubReferenceType left, UserMessageAttachmentGithubReferenceType right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(FactoryPermissionOperation left, FactoryPermissionOperation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is UserMessageAttachmentGithubReferenceType other && Equals(other); + public override bool Equals(object? obj) => obj is FactoryPermissionOperation other && Equals(other); /// - public bool Equals(UserMessageAttachmentGithubReferenceType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(FactoryPermissionOperation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6757,60 +11360,70 @@ public UserMessageAttachmentGithubReferenceType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override UserMessageAttachmentGithubReferenceType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override FactoryPermissionOperation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, UserMessageAttachmentGithubReferenceType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, FactoryPermissionOperation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(UserMessageAttachmentGithubReferenceType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(FactoryPermissionOperation)); } } } -/// Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. +/// Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs. +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AssistantMessageToolRequestType : IEquatable +public readonly struct AutoApprovalJudgeFailureReason : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AssistantMessageToolRequestType(string value) + public AutoApprovalJudgeFailureReason(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Standard function-style tool call. - public static AssistantMessageToolRequestType Function { get; } = new("function"); + /// The judge model call exceeded its deadline. + public static AutoApprovalJudgeFailureReason Timeout { get; } = new("timeout"); - /// Custom grammar-based tool call. - public static AssistantMessageToolRequestType Custom { get; } = new("custom"); + /// The judge model call was cancelled before it returned. + public static AutoApprovalJudgeFailureReason Abort { get; } = new("abort"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AssistantMessageToolRequestType left, AssistantMessageToolRequestType right) => left.Equals(right); + /// The judge model call completed but returned no content. + public static AutoApprovalJudgeFailureReason EmptyResponse { get; } = new("empty_response"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AssistantMessageToolRequestType left, AssistantMessageToolRequestType right) => !(left == right); + /// The judge model call failed (for example a transport, authentication, or rate-limit error). + public static AutoApprovalJudgeFailureReason ModelError { get; } = new("model_error"); + + /// The judge model replied, but the reply carried no ALLOW/DENY verdict. + public static AutoApprovalJudgeFailureReason ParseError { get; } = new("parse_error"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutoApprovalJudgeFailureReason left, AutoApprovalJudgeFailureReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutoApprovalJudgeFailureReason left, AutoApprovalJudgeFailureReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AssistantMessageToolRequestType other && Equals(other); + public override bool Equals(object? obj) => obj is AutoApprovalJudgeFailureReason other && Equals(other); /// - public bool Equals(AssistantMessageToolRequestType other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AutoApprovalJudgeFailureReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6818,66 +11431,67 @@ public AssistantMessageToolRequestType(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AssistantMessageToolRequestType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AutoApprovalJudgeFailureReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AssistantMessageToolRequestType value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, AutoApprovalJudgeFailureReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistantMessageToolRequestType)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoApprovalJudgeFailureReason)); } } } -/// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary. +/// Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off). +[Experimental(Diagnostics.Experimental)] [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AssistantUsageApiEndpoint : IEquatable +public readonly struct AutoApprovalRecommendation : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AssistantUsageApiEndpoint(string value) + public AutoApprovalRecommendation(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Chat Completions API endpoint. - public static AssistantUsageApiEndpoint ChatCompletions { get; } = new("/chat/completions"); + /// The judge evaluated the request and recommends automatically approving it. + public static AutoApprovalRecommendation Approve { get; } = new("approve"); - /// Anthropic Messages API endpoint. - public static AssistantUsageApiEndpoint V1Messages { get; } = new("/v1/messages"); + /// The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + public static AutoApprovalRecommendation RequireApproval { get; } = new("requireApproval"); - /// Responses API endpoint. - public static AssistantUsageApiEndpoint Responses { get; } = new("/responses"); + /// Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. + public static AutoApprovalRecommendation Excluded { get; } = new("excluded"); - /// WebSocket Responses API endpoint. - public static AssistantUsageApiEndpoint WsResponses { get; } = new("ws:/responses"); + /// The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. + public static AutoApprovalRecommendation Error { get; } = new("error"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AssistantUsageApiEndpoint left, AssistantUsageApiEndpoint right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutoApprovalRecommendation left, AutoApprovalRecommendation right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AssistantUsageApiEndpoint left, AssistantUsageApiEndpoint right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutoApprovalRecommendation left, AutoApprovalRecommendation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AssistantUsageApiEndpoint other && Equals(other); + public override bool Equals(object? obj) => obj is AutoApprovalRecommendation other && Equals(other); /// - public bool Equals(AssistantUsageApiEndpoint other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AutoApprovalRecommendation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6885,63 +11499,63 @@ public AssistantUsageApiEndpoint(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AssistantUsageApiEndpoint Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AutoApprovalRecommendation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AssistantUsageApiEndpoint value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, AutoApprovalRecommendation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AssistantUsageApiEndpoint)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoApprovalRecommendation)); } } } -/// Where the failed model call originated. +/// Underlying permission kind that needs path approval. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ModelCallFailureSource : IEquatable +public readonly struct PermissionPromptRequestPathAccessKind : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ModelCallFailureSource(string value) + public PermissionPromptRequestPathAccessKind(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Model call from the top-level agent. - public static ModelCallFailureSource TopLevel { get; } = new("top_level"); + /// Read access to a filesystem path. + public static PermissionPromptRequestPathAccessKind Read { get; } = new("read"); - /// Model call from a sub-agent. - public static ModelCallFailureSource Subagent { get; } = new("subagent"); + /// Shell command access involving a filesystem path. + public static PermissionPromptRequestPathAccessKind Shell { get; } = new("shell"); - /// Model call from MCP sampling. - public static ModelCallFailureSource McpSampling { get; } = new("mcp_sampling"); + /// Write access to a filesystem path. + public static PermissionPromptRequestPathAccessKind Write { get; } = new("write"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ModelCallFailureSource left, ModelCallFailureSource right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(PermissionPromptRequestPathAccessKind left, PermissionPromptRequestPathAccessKind right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ModelCallFailureSource left, ModelCallFailureSource right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(PermissionPromptRequestPathAccessKind left, PermissionPromptRequestPathAccessKind right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ModelCallFailureSource other && Equals(other); + public override bool Equals(object? obj) => obj is PermissionPromptRequestPathAccessKind other && Equals(other); /// - public bool Equals(ModelCallFailureSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(PermissionPromptRequestPathAccessKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -6949,63 +11563,60 @@ public ModelCallFailureSource(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ModelCallFailureSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override PermissionPromptRequestPathAccessKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ModelCallFailureSource value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, PermissionPromptRequestPathAccessKind value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ModelCallFailureSource)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionPromptRequestPathAccessKind)); } } } -/// Finite reason code describing why the current turn was aborted. +/// Elicitation mode; "form" for structured input, "url" for browser-based. Defaults to "form" when absent. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AbortReason : IEquatable +public readonly struct ElicitationRequestedMode : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AbortReason(string value) + public ElicitationRequestedMode(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The local user requested the abort, for example by pressing Ctrl+C in the CLI. - public static AbortReason UserInitiated { get; } = new("user_initiated"); - - /// A remote command requested the abort. - public static AbortReason RemoteCommand { get; } = new("remote_command"); + /// Structured form-based elicitation. + public static ElicitationRequestedMode Form { get; } = new("form"); - /// An MCP server delivered a user.abort notification. - public static AbortReason UserAbort { get; } = new("user_abort"); + /// Browser URL-based elicitation. + public static ElicitationRequestedMode Url { get; } = new("url"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AbortReason left, AbortReason right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ElicitationRequestedMode left, ElicitationRequestedMode right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AbortReason left, AbortReason right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ElicitationRequestedMode left, ElicitationRequestedMode right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AbortReason other && Equals(other); + public override bool Equals(object? obj) => obj is ElicitationRequestedMode other && Equals(other); /// - public bool Equals(AbortReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ElicitationRequestedMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7013,60 +11624,63 @@ public AbortReason(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AbortReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ElicitationRequestedMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AbortReason value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ElicitationRequestedMode value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AbortReason)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ElicitationRequestedMode)); } } } -/// Theme variant this icon is intended for. +/// The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ToolExecutionCompleteContentResourceLinkIconTheme : IEquatable +public readonly struct ElicitationCompletedAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ToolExecutionCompleteContentResourceLinkIconTheme(string value) + public ElicitationCompletedAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Icon intended for light themes. - public static ToolExecutionCompleteContentResourceLinkIconTheme Light { get; } = new("light"); + /// The user submitted the requested form. + public static ElicitationCompletedAction Accept { get; } = new("accept"); - /// Icon intended for dark themes. - public static ToolExecutionCompleteContentResourceLinkIconTheme Dark { get; } = new("dark"); + /// The user explicitly declined the request. + public static ElicitationCompletedAction Decline { get; } = new("decline"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ToolExecutionCompleteContentResourceLinkIconTheme left, ToolExecutionCompleteContentResourceLinkIconTheme right) => left.Equals(right); + /// The user dismissed the request. + public static ElicitationCompletedAction Cancel { get; } = new("cancel"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ToolExecutionCompleteContentResourceLinkIconTheme left, ToolExecutionCompleteContentResourceLinkIconTheme right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ElicitationCompletedAction left, ElicitationCompletedAction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ElicitationCompletedAction left, ElicitationCompletedAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ToolExecutionCompleteContentResourceLinkIconTheme other && Equals(other); + public override bool Equals(object? obj) => obj is ElicitationCompletedAction other && Equals(other); /// - public bool Equals(ToolExecutionCompleteContentResourceLinkIconTheme other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ElicitationCompletedAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7074,60 +11688,66 @@ public ToolExecutionCompleteContentResourceLinkIconTheme(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ToolExecutionCompleteContentResourceLinkIconTheme Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ElicitationCompletedAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ToolExecutionCompleteContentResourceLinkIconTheme value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ElicitationCompletedAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolExecutionCompleteContentResourceLinkIconTheme)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ElicitationCompletedAction)); } } } -/// Allowed values for the `ToolExecutionCompleteToolDescriptionMetaUIVisibility` enumeration. +/// Reason the runtime is requesting host-provided MCP OAuth credentials. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ToolExecutionCompleteToolDescriptionMetaUIVisibility : IEquatable +public readonly struct McpOauthRequestReason : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ToolExecutionCompleteToolDescriptionMetaUIVisibility(string value) + public McpOauthRequestReason(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Tool is callable by the model (LLM tool surface). - public static ToolExecutionCompleteToolDescriptionMetaUIVisibility Model { get; } = new("model"); + /// Initial credentials are required before connecting to the MCP server. + public static McpOauthRequestReason Initial { get; } = new("initial"); - /// Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool. - public static ToolExecutionCompleteToolDescriptionMetaUIVisibility App { get; } = new("app"); + /// The current host-provided credential was rejected and a replacement is requested. + public static McpOauthRequestReason Refresh { get; } = new("refresh"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ToolExecutionCompleteToolDescriptionMetaUIVisibility left, ToolExecutionCompleteToolDescriptionMetaUIVisibility right) => left.Equals(right); + /// The server requires a new host authorization flow before continuing. + public static McpOauthRequestReason Reauth { get; } = new("reauth"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ToolExecutionCompleteToolDescriptionMetaUIVisibility left, ToolExecutionCompleteToolDescriptionMetaUIVisibility right) => !(left == right); + /// The server requires a credential with additional scope or audience. + public static McpOauthRequestReason Upscope { get; } = new("upscope"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpOauthRequestReason left, McpOauthRequestReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpOauthRequestReason left, McpOauthRequestReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ToolExecutionCompleteToolDescriptionMetaUIVisibility other && Equals(other); + public override bool Equals(object? obj) => obj is McpOauthRequestReason other && Equals(other); /// - public bool Equals(ToolExecutionCompleteToolDescriptionMetaUIVisibility other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpOauthRequestReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7135,63 +11755,60 @@ public ToolExecutionCompleteToolDescriptionMetaUIVisibility(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ToolExecutionCompleteToolDescriptionMetaUIVisibility Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpOauthRequestReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ToolExecutionCompleteToolDescriptionMetaUIVisibility value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpOauthRequestReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ToolExecutionCompleteToolDescriptionMetaUIVisibility)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthRequestReason)); } } } -/// What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent). +/// How the pending MCP OAuth request was completed. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SkillInvokedTrigger : IEquatable +public readonly struct McpOauthCompletionOutcome : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SkillInvokedTrigger(string value) + public McpOauthCompletionOutcome(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Skill invocation requested explicitly by the user, such as via a slash command or UI affordance. - public static SkillInvokedTrigger UserInvoked { get; } = new("user-invoked"); - - /// Skill invocation requested by the agent. - public static SkillInvokedTrigger AgentInvoked { get; } = new("agent-invoked"); + /// The request completed with a token-backed OAuth provider. + public static McpOauthCompletionOutcome Token { get; } = new("token"); - /// Skill content loaded as part of another context, such as a configured custom agent or subagent. - public static SkillInvokedTrigger ContextLoad { get; } = new("context-load"); + /// The request completed without an OAuth provider. + public static McpOauthCompletionOutcome Cancelled { get; } = new("cancelled"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SkillInvokedTrigger left, SkillInvokedTrigger right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpOauthCompletionOutcome left, McpOauthCompletionOutcome right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SkillInvokedTrigger left, SkillInvokedTrigger right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpOauthCompletionOutcome left, McpOauthCompletionOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SkillInvokedTrigger other && Equals(other); + public override bool Equals(object? obj) => obj is McpOauthCompletionOutcome other && Equals(other); /// - public bool Equals(SkillInvokedTrigger other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpOauthCompletionOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7199,60 +11816,63 @@ public SkillInvokedTrigger(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SkillInvokedTrigger Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpOauthCompletionOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SkillInvokedTrigger value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpOauthCompletionOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SkillInvokedTrigger)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpOauthCompletionOutcome)); } } } -/// Message role: "system" for system prompts, "developer" for developer-injected instructions. +/// Why dynamic headers are being requested. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SystemMessageRole : IEquatable +public readonly struct McpHeadersRefreshRequiredReason : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SystemMessageRole(string value) + public McpHeadersRefreshRequiredReason(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// System prompt message. - public static SystemMessageRole System { get; } = new("system"); + /// The transport is making its first dynamic header request for this server. + public static McpHeadersRefreshRequiredReason Startup { get; } = new("startup"); - /// Developer instruction message. - public static SystemMessageRole Developer { get; } = new("developer"); + /// The previously cached dynamic headers expired. + public static McpHeadersRefreshRequiredReason TtlExpired { get; } = new("ttl-expired"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SystemMessageRole left, SystemMessageRole right) => left.Equals(right); + /// The server returned 401 and stale dynamic headers were invalidated. + public static McpHeadersRefreshRequiredReason AuthFailed { get; } = new("auth-failed"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SystemMessageRole left, SystemMessageRole right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpHeadersRefreshRequiredReason left, McpHeadersRefreshRequiredReason right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpHeadersRefreshRequiredReason left, McpHeadersRefreshRequiredReason right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SystemMessageRole other && Equals(other); + public override bool Equals(object? obj) => obj is McpHeadersRefreshRequiredReason other && Equals(other); /// - public bool Equals(SystemMessageRole other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpHeadersRefreshRequiredReason other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7260,60 +11880,63 @@ public SystemMessageRole(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SystemMessageRole Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpHeadersRefreshRequiredReason Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SystemMessageRole value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpHeadersRefreshRequiredReason value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemMessageRole)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpHeadersRefreshRequiredReason)); } } } -/// Whether the agent completed successfully or failed. +/// How the pending MCP headers refresh request resolved. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct SystemNotificationAgentCompletedStatus : IEquatable +public readonly struct McpHeadersRefreshCompletedOutcome : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public SystemNotificationAgentCompletedStatus(string value) + public McpHeadersRefreshCompletedOutcome(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The agent completed successfully. - public static SystemNotificationAgentCompletedStatus Completed { get; } = new("completed"); + /// The host supplied dynamic headers. + public static McpHeadersRefreshCompletedOutcome Headers { get; } = new("headers"); - /// The agent failed. - public static SystemNotificationAgentCompletedStatus Failed { get; } = new("failed"); + /// The host responded with no dynamic headers. + public static McpHeadersRefreshCompletedOutcome None { get; } = new("none"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => left.Equals(right); + /// No response arrived within the bounded window. + public static McpHeadersRefreshCompletedOutcome Timeout { get; } = new("timeout"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(SystemNotificationAgentCompletedStatus left, SystemNotificationAgentCompletedStatus right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(McpHeadersRefreshCompletedOutcome left, McpHeadersRefreshCompletedOutcome right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(McpHeadersRefreshCompletedOutcome left, McpHeadersRefreshCompletedOutcome right) => !(left == right); /// - public override bool Equals(object? obj) => obj is SystemNotificationAgentCompletedStatus other && Equals(other); + public override bool Equals(object? obj) => obj is McpHeadersRefreshCompletedOutcome other && Equals(other); /// - public bool Equals(SystemNotificationAgentCompletedStatus other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(McpHeadersRefreshCompletedOutcome other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7321,60 +11944,63 @@ public SystemNotificationAgentCompletedStatus(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override SystemNotificationAgentCompletedStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override McpHeadersRefreshCompletedOutcome Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, SystemNotificationAgentCompletedStatus value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, McpHeadersRefreshCompletedOutcome value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SystemNotificationAgentCompletedStatus)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(McpHeadersRefreshCompletedOutcome)); } } } -/// Whether this is a store or vote memory operation. +/// The user's auto-mode-switch choice. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionRequestMemoryAction : IEquatable +public readonly struct AutoModeSwitchResponse : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionRequestMemoryAction(string value) + public AutoModeSwitchResponse(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Store a new memory. - public static PermissionRequestMemoryAction Store { get; } = new("store"); + /// Switch models for this request. + public static AutoModeSwitchResponse Yes { get; } = new("yes"); - /// Vote on an existing memory. - public static PermissionRequestMemoryAction Vote { get; } = new("vote"); + /// Switch models now and keep using the replacement automatically. + public static AutoModeSwitchResponse YesAlways { get; } = new("yes_always"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => left.Equals(right); + /// Do not switch models. + public static AutoModeSwitchResponse No { get; } = new("no"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionRequestMemoryAction left, PermissionRequestMemoryAction right) => !(left == right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutoModeSwitchResponse left, AutoModeSwitchResponse right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutoModeSwitchResponse left, AutoModeSwitchResponse right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionRequestMemoryAction other && Equals(other); + public override bool Equals(object? obj) => obj is AutoModeSwitchResponse other && Equals(other); /// - public bool Equals(PermissionRequestMemoryAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AutoModeSwitchResponse other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7382,60 +12008,66 @@ public PermissionRequestMemoryAction(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionRequestMemoryAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AutoModeSwitchResponse Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, AutoModeSwitchResponse value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoModeSwitchResponse)); } } } -/// Vote direction (vote only). +/// User action selected for an exhausted session limit. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionRequestMemoryDirection : IEquatable +public readonly struct SessionLimitsExhaustedResponseAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionRequestMemoryDirection(string value) + public SessionLimitsExhaustedResponseAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Vote that the memory is useful or accurate. - public static PermissionRequestMemoryDirection Upvote { get; } = new("upvote"); + /// Increase the current max by an exact AI Credits amount. + public static SessionLimitsExhaustedResponseAction Add { get; } = new("add"); - /// Vote that the memory is incorrect or outdated. - public static PermissionRequestMemoryDirection Downvote { get; } = new("downvote"); + /// Set a new absolute max AI Credits value. + public static SessionLimitsExhaustedResponseAction Set { get; } = new("set"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionRequestMemoryDirection left, PermissionRequestMemoryDirection right) => left.Equals(right); + /// Remove the current session limit. + public static SessionLimitsExhaustedResponseAction Unset { get; } = new("unset"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionRequestMemoryDirection left, PermissionRequestMemoryDirection right) => !(left == right); + /// Leave the limit unchanged and cancel the blocked model request. + public static SessionLimitsExhaustedResponseAction Cancel { get; } = new("cancel"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(SessionLimitsExhaustedResponseAction left, SessionLimitsExhaustedResponseAction right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(SessionLimitsExhaustedResponseAction left, SessionLimitsExhaustedResponseAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionRequestMemoryDirection other && Equals(other); + public override bool Equals(object? obj) => obj is SessionLimitsExhaustedResponseAction other && Equals(other); /// - public bool Equals(PermissionRequestMemoryDirection other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(SessionLimitsExhaustedResponseAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7443,63 +12075,63 @@ public PermissionRequestMemoryDirection(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionRequestMemoryDirection Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override SessionLimitsExhaustedResponseAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionRequestMemoryDirection value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, SessionLimitsExhaustedResponseAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionRequestMemoryDirection)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(SessionLimitsExhaustedResponseAction)); } } } -/// Underlying permission kind that needs path approval. +/// Coarse request-difficulty bucket for UX explainability. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct PermissionPromptRequestPathAccessKind : IEquatable +public readonly struct AutoModeResolvedReasoningBucket : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public PermissionPromptRequestPathAccessKind(string value) + public AutoModeResolvedReasoningBucket(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Read access to a filesystem path. - public static PermissionPromptRequestPathAccessKind Read { get; } = new("read"); + /// The request looks low-reasoning; a lighter model is appropriate. + public static AutoModeResolvedReasoningBucket Low { get; } = new("low"); - /// Shell command access involving a filesystem path. - public static PermissionPromptRequestPathAccessKind Shell { get; } = new("shell"); + /// The request needs a moderate amount of reasoning. + public static AutoModeResolvedReasoningBucket Medium { get; } = new("medium"); - /// Write access to a filesystem path. - public static PermissionPromptRequestPathAccessKind Write { get; } = new("write"); + /// The request looks high-reasoning; a stronger model is appropriate. + public static AutoModeResolvedReasoningBucket High { get; } = new("high"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(PermissionPromptRequestPathAccessKind left, PermissionPromptRequestPathAccessKind right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(AutoModeResolvedReasoningBucket left, AutoModeResolvedReasoningBucket right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(PermissionPromptRequestPathAccessKind left, PermissionPromptRequestPathAccessKind right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(AutoModeResolvedReasoningBucket left, AutoModeResolvedReasoningBucket right) => !(left == right); /// - public override bool Equals(object? obj) => obj is PermissionPromptRequestPathAccessKind other && Equals(other); + public override bool Equals(object? obj) => obj is AutoModeResolvedReasoningBucket other && Equals(other); /// - public bool Equals(PermissionPromptRequestPathAccessKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(AutoModeResolvedReasoningBucket other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7507,60 +12139,69 @@ public PermissionPromptRequestPathAccessKind(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override PermissionPromptRequestPathAccessKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override AutoModeResolvedReasoningBucket Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, PermissionPromptRequestPathAccessKind value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, AutoModeResolvedReasoningBucket value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(PermissionPromptRequestPathAccessKind)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoModeResolvedReasoningBucket)); } } } -/// Elicitation mode; "form" for structured input, "url" for browser-based. Defaults to "form" when absent. +/// Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ElicitationRequestedMode : IEquatable +public readonly struct ManagedSettingsResolvedSource : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ElicitationRequestedMode(string value) + public ManagedSettingsResolvedSource(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Structured form-based elicitation. - public static ElicitationRequestedMode Form { get; } = new("form"); + /// Only the server/account channel contributed. + public static ManagedSettingsResolvedSource Server { get; } = new("server"); - /// Browser URL-based elicitation. - public static ElicitationRequestedMode Url { get; } = new("url"); + /// Only the device MDM/plist/registry/file channel contributed. + public static ManagedSettingsResolvedSource Device { get; } = new("device"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ElicitationRequestedMode left, ElicitationRequestedMode right) => left.Equals(right); + /// Only session-local SDK-host injection contributed. + public static ManagedSettingsResolvedSource Client { get; } = new("client"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ElicitationRequestedMode left, ElicitationRequestedMode right) => !(left == right); + /// More than one channel contributed. Ordinary keys resolve device over server per key, while permissions compose restrictively across all present layers. + public static ManagedSettingsResolvedSource Mixed { get; } = new("mixed"); + + /// No managed policy is in force (no channel contributed). + public static ManagedSettingsResolvedSource None { get; } = new("none"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ManagedSettingsResolvedSource left, ManagedSettingsResolvedSource right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ManagedSettingsResolvedSource left, ManagedSettingsResolvedSource right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ElicitationRequestedMode other && Equals(other); + public override bool Equals(object? obj) => obj is ManagedSettingsResolvedSource other && Equals(other); /// - public bool Equals(ElicitationRequestedMode other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ManagedSettingsResolvedSource other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7568,63 +12209,57 @@ public ElicitationRequestedMode(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ElicitationRequestedMode Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ManagedSettingsResolvedSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ElicitationRequestedMode value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ManagedSettingsResolvedSource value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ElicitationRequestedMode)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ManagedSettingsResolvedSource)); } } } -/// The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed). +/// The category of runtime action that enterprise managed settings governed (blocked or capped). [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct ElicitationCompletedAction : IEquatable +public readonly struct ManagedSettingsEnforcedAction : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public ElicitationCompletedAction(string value) + public ManagedSettingsEnforcedAction(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// The user submitted the requested form. - public static ElicitationCompletedAction Accept { get; } = new("accept"); - - /// The user explicitly declined the request. - public static ElicitationCompletedAction Decline { get; } = new("decline"); - - /// The user dismissed the request. - public static ElicitationCompletedAction Cancel { get; } = new("cancel"); + /// An attempt to turn on a bypass-permissions ("yolo") escalation was refused or capped because policy disables bypass-permissions mode. + public static ManagedSettingsEnforcedAction BypassPermissionsBlocked { get; } = new("bypass_permissions_blocked"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ElicitationCompletedAction left, ElicitationCompletedAction right) => left.Equals(right); + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ManagedSettingsEnforcedAction left, ManagedSettingsEnforcedAction right) => left.Equals(right); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ElicitationCompletedAction left, ElicitationCompletedAction right) => !(left == right); + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ManagedSettingsEnforcedAction left, ManagedSettingsEnforcedAction right) => !(left == right); /// - public override bool Equals(object? obj) => obj is ElicitationCompletedAction other && Equals(other); + public override bool Equals(object? obj) => obj is ManagedSettingsEnforcedAction other && Equals(other); /// - public bool Equals(ElicitationCompletedAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ManagedSettingsEnforcedAction other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7632,63 +12267,69 @@ public ElicitationCompletedAction(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override ElicitationCompletedAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ManagedSettingsEnforcedAction Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, ElicitationCompletedAction value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ManagedSettingsEnforcedAction value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ElicitationCompletedAction)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ManagedSettingsEnforcedAction)); } } } -/// The user's auto-mode-switch choice. +/// For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] -public readonly struct AutoModeSwitchResponse : IEquatable +public readonly struct ManagedSettingsEnforcedEscalation : IEquatable { private readonly string? _value; - /// Initializes a new instance of the struct. - /// The value to associate with this . + /// Initializes a new instance of the struct. + /// The value to associate with this . [JsonConstructor] - public AutoModeSwitchResponse(string value) + public ManagedSettingsEnforcedEscalation(string value) { ArgumentException.ThrowIfNullOrWhiteSpace(value); _value = value; } - /// Gets the value associated with this . + /// Gets the value associated with this . public string Value => _value ?? string.Empty; - /// Switch models for this request. - public static AutoModeSwitchResponse Yes { get; } = new("yes"); + /// Full allow-all ("/allow-all on") permissions — auto-approving tools, paths, and URLs. + public static ManagedSettingsEnforcedEscalation AllowAll { get; } = new("allow_all"); - /// Switch models now and keep using the replacement automatically. - public static AutoModeSwitchResponse YesAlways { get; } = new("yes_always"); + /// Auto-approval of all tool permission requests. + public static ManagedSettingsEnforcedEscalation ApproveAll { get; } = new("approve_all"); - /// Do not switch models. - public static AutoModeSwitchResponse No { get; } = new("no"); + /// Advisory auto-approval ("/allow-all auto") mode — keeps normal prompt paths and adds LLM-advised approval, distinct from full allow-all. + public static ManagedSettingsEnforcedEscalation AutoApproval { get; } = new("auto_approval"); - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(AutoModeSwitchResponse left, AutoModeSwitchResponse right) => left.Equals(right); + /// Unrestricted filesystem access outside the session's allowed directories. + public static ManagedSettingsEnforcedEscalation UnrestrictedPaths { get; } = new("unrestricted_paths"); - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(AutoModeSwitchResponse left, AutoModeSwitchResponse right) => !(left == right); + /// Unrestricted URL fetch access. + public static ManagedSettingsEnforcedEscalation UnrestrictedUrls { get; } = new("unrestricted_urls"); + + /// Returns a value indicating whether two instances are equivalent. + public static bool operator ==(ManagedSettingsEnforcedEscalation left, ManagedSettingsEnforcedEscalation right) => left.Equals(right); + + /// Returns a value indicating whether two instances are not equivalent. + public static bool operator !=(ManagedSettingsEnforcedEscalation left, ManagedSettingsEnforcedEscalation right) => !(left == right); /// - public override bool Equals(object? obj) => obj is AutoModeSwitchResponse other && Equals(other); + public override bool Equals(object? obj) => obj is ManagedSettingsEnforcedEscalation other && Equals(other); /// - public bool Equals(AutoModeSwitchResponse other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + public bool Equals(ManagedSettingsEnforcedEscalation other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); /// public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); @@ -7696,20 +12337,20 @@ public AutoModeSwitchResponse(string value) /// public override string ToString() => Value; - /// Provides a for serializing instances. + /// Provides a for serializing instances. [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter + public sealed class Converter : JsonConverter { /// - public override AutoModeSwitchResponse Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ManagedSettingsEnforcedEscalation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); } /// - public override void Write(Utf8JsonWriter writer, AutoModeSwitchResponse value, JsonSerializerOptions options) + public override void Write(Utf8JsonWriter writer, ManagedSettingsEnforcedEscalation value, JsonSerializerOptions options) { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(AutoModeSwitchResponse)); + GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ManagedSettingsEnforcedEscalation)); } } } @@ -7924,7 +12565,7 @@ public override void Write(Utf8JsonWriter writer, McpServerSource value, JsonSer } } -/// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured. +/// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured. [JsonConverter(typeof(Converter))] [DebuggerDisplay("{Value,nq}")] public readonly struct McpServerStatus : IEquatable @@ -7958,6 +12599,9 @@ public McpServerStatus(string value) /// The server is configured but disabled. public static McpServerStatus Disabled { get; } = new("disabled"); + /// The server was intentionally stopped and can be restarted on demand when policy permits; a server quarantined by restrictive managed policy stays stopped and cannot be restarted until the policy allows it. + public static McpServerStatus Stopped { get; } = new("stopped"); + /// The server is not configured for this session. public static McpServerStatus NotConfigured { get; } = new("not_configured"); @@ -8089,6 +12733,12 @@ public ExtensionsLoadedExtensionSource(string value) /// Extension discovered from the user's extension directory. public static ExtensionsLoadedExtensionSource User { get; } = new("user"); + /// Extension contributed by an installed plugin. + public static ExtensionsLoadedExtensionSource Plugin { get; } = new("plugin"); + + /// Extension discovered from the current session's state directory. + public static ExtensionsLoadedExtensionSource Session { get; } = new("session"); + /// Returns a value indicating whether two instances are equivalent. public static bool operator ==(ExtensionsLoadedExtensionSource left, ExtensionsLoadedExtensionSource right) => left.Equals(right); @@ -8192,67 +12842,6 @@ public override void Write(Utf8JsonWriter writer, ExtensionsLoadedExtensionStatu } } -/// Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. -[JsonConverter(typeof(Converter))] -[DebuggerDisplay("{Value,nq}")] -public readonly struct CanvasOpenedAvailability : IEquatable -{ - private readonly string? _value; - - /// Initializes a new instance of the struct. - /// The value to associate with this . - [JsonConstructor] - public CanvasOpenedAvailability(string value) - { - ArgumentException.ThrowIfNullOrWhiteSpace(value); - _value = value; - } - - /// Gets the value associated with this . - public string Value => _value ?? string.Empty; - - /// Provider connection is live; actions can be invoked. - public static CanvasOpenedAvailability Ready { get; } = new("ready"); - - /// Provider has gone away; the instance is awaiting rebinding. - public static CanvasOpenedAvailability Stale { get; } = new("stale"); - - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(CanvasOpenedAvailability left, CanvasOpenedAvailability right) => left.Equals(right); - - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(CanvasOpenedAvailability left, CanvasOpenedAvailability right) => !(left == right); - - /// - public override bool Equals(object? obj) => obj is CanvasOpenedAvailability other && Equals(other); - - /// - public bool Equals(CanvasOpenedAvailability other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); - - /// - public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); - - /// - public override string ToString() => Value; - - /// Provides a for serializing instances. - [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter - { - /// - public override CanvasOpenedAvailability Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) - { - return new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); - } - - /// - public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value, JsonSerializerOptions options) - { - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(CanvasOpenedAvailability)); - } - } -} - [JsonSourceGenerationOptions( JsonSerializerDefaults.Web, AllowOutOfOrderMetadataProperties = true, @@ -8260,12 +12849,15 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] [JsonSerializable(typeof(AbortData))] [JsonSerializable(typeof(AbortEvent))] +[JsonSerializable(typeof(AssistantIdleData))] +[JsonSerializable(typeof(AssistantIdleEvent))] [JsonSerializable(typeof(AssistantIntentData))] [JsonSerializable(typeof(AssistantIntentEvent))] [JsonSerializable(typeof(AssistantMessageData))] [JsonSerializable(typeof(AssistantMessageDeltaData))] [JsonSerializable(typeof(AssistantMessageDeltaEvent))] [JsonSerializable(typeof(AssistantMessageEvent))] +[JsonSerializable(typeof(AssistantMessageServerTools))] [JsonSerializable(typeof(AssistantMessageStartData))] [JsonSerializable(typeof(AssistantMessageStartEvent))] [JsonSerializable(typeof(AssistantMessageToolRequest))] @@ -8273,10 +12865,16 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(AssistantReasoningDeltaData))] [JsonSerializable(typeof(AssistantReasoningDeltaEvent))] [JsonSerializable(typeof(AssistantReasoningEvent))] +[JsonSerializable(typeof(AssistantServerToolProgressData))] +[JsonSerializable(typeof(AssistantServerToolProgressEvent))] [JsonSerializable(typeof(AssistantStreamingDeltaData))] [JsonSerializable(typeof(AssistantStreamingDeltaEvent))] +[JsonSerializable(typeof(AssistantToolCallDeltaData))] +[JsonSerializable(typeof(AssistantToolCallDeltaEvent))] [JsonSerializable(typeof(AssistantTurnEndData))] [JsonSerializable(typeof(AssistantTurnEndEvent))] +[JsonSerializable(typeof(AssistantTurnRetryData))] +[JsonSerializable(typeof(AssistantTurnRetryEvent))] [JsonSerializable(typeof(AssistantTurnStartData))] [JsonSerializable(typeof(AssistantTurnStartEvent))] [JsonSerializable(typeof(AssistantUsageCopilotUsage))] @@ -8284,15 +12882,47 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(AssistantUsageData))] [JsonSerializable(typeof(AssistantUsageEvent))] [JsonSerializable(typeof(AssistantUsageQuotaSnapshot))] +[JsonSerializable(typeof(Attachment))] +[JsonSerializable(typeof(AttachmentBlob))] +[JsonSerializable(typeof(AttachmentDirectory))] +[JsonSerializable(typeof(AttachmentExtensionContext))] +[JsonSerializable(typeof(AttachmentFile))] +[JsonSerializable(typeof(AttachmentFileLineRange))] +[JsonSerializable(typeof(AttachmentGitHubActionsJob))] +[JsonSerializable(typeof(AttachmentGitHubCommit))] +[JsonSerializable(typeof(AttachmentGitHubFile))] +[JsonSerializable(typeof(AttachmentGitHubFileDiff))] +[JsonSerializable(typeof(AttachmentGitHubFileDiffSide))] +[JsonSerializable(typeof(AttachmentGitHubReference))] +[JsonSerializable(typeof(AttachmentGitHubRelease))] +[JsonSerializable(typeof(AttachmentGitHubRepository))] +[JsonSerializable(typeof(AttachmentGitHubSnippet))] +[JsonSerializable(typeof(AttachmentGitHubTreeComparison))] +[JsonSerializable(typeof(AttachmentGitHubTreeComparisonSide))] +[JsonSerializable(typeof(AttachmentGitHubUrl))] +[JsonSerializable(typeof(AttachmentSelection))] +[JsonSerializable(typeof(AttachmentSelectionDetails))] +[JsonSerializable(typeof(AttachmentSelectionDetailsEnd))] +[JsonSerializable(typeof(AttachmentSelectionDetailsStart))] [JsonSerializable(typeof(AutoModeSwitchCompletedData))] [JsonSerializable(typeof(AutoModeSwitchCompletedEvent))] [JsonSerializable(typeof(AutoModeSwitchRequestedData))] [JsonSerializable(typeof(AutoModeSwitchRequestedEvent))] +[JsonSerializable(typeof(BinaryAssetReference))] [JsonSerializable(typeof(CanvasRegistryChangedCanvas))] [JsonSerializable(typeof(CanvasRegistryChangedCanvasAction))] [JsonSerializable(typeof(CapabilitiesChangedData))] [JsonSerializable(typeof(CapabilitiesChangedEvent))] [JsonSerializable(typeof(CapabilitiesChangedUI))] +[JsonSerializable(typeof(CitableSource))] +[JsonSerializable(typeof(CitationLocation))] +[JsonSerializable(typeof(CitationLocationBlock))] +[JsonSerializable(typeof(CitationLocationChar))] +[JsonSerializable(typeof(CitationLocationPage))] +[JsonSerializable(typeof(CitationReference))] +[JsonSerializable(typeof(CitationSource))] +[JsonSerializable(typeof(CitationSpan))] +[JsonSerializable(typeof(Citations))] [JsonSerializable(typeof(CommandCompletedData))] [JsonSerializable(typeof(CommandCompletedEvent))] [JsonSerializable(typeof(CommandExecuteData))] @@ -8322,7 +12952,13 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(ExternalToolCompletedEvent))] [JsonSerializable(typeof(ExternalToolRequestedData))] [JsonSerializable(typeof(ExternalToolRequestedEvent))] +[JsonSerializable(typeof(FactoryPermissionPhase))] +[JsonSerializable(typeof(FactoryRunUpdatedData))] +[JsonSerializable(typeof(FactoryRunUpdatedEvent))] +[JsonSerializable(typeof(GitHubMcpToolConfig))] +[JsonSerializable(typeof(GitHubRepoRef))] [JsonSerializable(typeof(HandoffRepository))] +[JsonSerializable(typeof(HeaderEntry))] [JsonSerializable(typeof(HookEndData))] [JsonSerializable(typeof(HookEndError))] [JsonSerializable(typeof(HookEndEvent))] @@ -8335,16 +12971,33 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(McpAppToolCallCompleteEvent))] [JsonSerializable(typeof(McpAppToolCallCompleteToolMeta))] [JsonSerializable(typeof(McpAppToolCallCompleteToolMetaUI))] +[JsonSerializable(typeof(McpHeadersRefreshCompletedData))] +[JsonSerializable(typeof(McpHeadersRefreshCompletedEvent))] +[JsonSerializable(typeof(McpHeadersRefreshRequiredData))] +[JsonSerializable(typeof(McpHeadersRefreshRequiredEvent))] [JsonSerializable(typeof(McpOauthCompletedData))] [JsonSerializable(typeof(McpOauthCompletedEvent))] +[JsonSerializable(typeof(McpOauthHttpResponse))] [JsonSerializable(typeof(McpOauthRequiredData))] [JsonSerializable(typeof(McpOauthRequiredEvent))] [JsonSerializable(typeof(McpOauthRequiredStaticClientConfig))] +[JsonSerializable(typeof(McpOauthWWWAuthenticateParams))] +[JsonSerializable(typeof(McpPromptsListChangedData))] +[JsonSerializable(typeof(McpPromptsListChangedEvent))] +[JsonSerializable(typeof(McpResourcesListChangedData))] +[JsonSerializable(typeof(McpResourcesListChangedEvent))] [JsonSerializable(typeof(McpServersLoadedServer))] +[JsonSerializable(typeof(McpToolsListChangedData))] +[JsonSerializable(typeof(McpToolsListChangedEvent))] [JsonSerializable(typeof(ModelCallFailureData))] [JsonSerializable(typeof(ModelCallFailureEvent))] +[JsonSerializable(typeof(ModelCallFailureRequestFingerprint))] +[JsonSerializable(typeof(ModelCallStartData))] +[JsonSerializable(typeof(ModelCallStartEvent))] +[JsonSerializable(typeof(OmittedBinaryResult))] [JsonSerializable(typeof(PendingMessagesModifiedData))] [JsonSerializable(typeof(PendingMessagesModifiedEvent))] +[JsonSerializable(typeof(PermissionAutoApproval))] [JsonSerializable(typeof(PermissionCompletedData))] [JsonSerializable(typeof(PermissionCompletedEvent))] [JsonSerializable(typeof(PermissionPromptRequest))] @@ -8352,6 +13005,7 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(PermissionPromptRequestCustomTool))] [JsonSerializable(typeof(PermissionPromptRequestExtensionManagement))] [JsonSerializable(typeof(PermissionPromptRequestExtensionPermissionAccess))] +[JsonSerializable(typeof(PermissionPromptRequestFactory))] [JsonSerializable(typeof(PermissionPromptRequestHook))] [JsonSerializable(typeof(PermissionPromptRequestMcp))] [JsonSerializable(typeof(PermissionPromptRequestMemory))] @@ -8363,12 +13017,14 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(PermissionRequestCustomTool))] [JsonSerializable(typeof(PermissionRequestExtensionManagement))] [JsonSerializable(typeof(PermissionRequestExtensionPermissionAccess))] +[JsonSerializable(typeof(PermissionRequestFactory))] [JsonSerializable(typeof(PermissionRequestHook))] [JsonSerializable(typeof(PermissionRequestMcp))] [JsonSerializable(typeof(PermissionRequestMemory))] [JsonSerializable(typeof(PermissionRequestRead))] [JsonSerializable(typeof(PermissionRequestShell))] [JsonSerializable(typeof(PermissionRequestShellCommand))] +[JsonSerializable(typeof(PermissionRequestShellCommandSegment))] [JsonSerializable(typeof(PermissionRequestShellPossibleUrl))] [JsonSerializable(typeof(PermissionRequestUrl))] [JsonSerializable(typeof(PermissionRequestWrite))] @@ -8385,24 +13041,40 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(PermissionResultDeniedInteractivelyByUser))] [JsonSerializable(typeof(PermissionResultDeniedNoApprovalRuleAndCouldNotRequestFromUser))] [JsonSerializable(typeof(PermissionRule))] +[JsonSerializable(typeof(PersistedBinaryImage))] +[JsonSerializable(typeof(PersistedBinaryResult))] [JsonSerializable(typeof(SamplingCompletedData))] [JsonSerializable(typeof(SamplingCompletedEvent))] [JsonSerializable(typeof(SamplingRequestedData))] [JsonSerializable(typeof(SamplingRequestedEvent))] +[JsonSerializable(typeof(SessionAutoModeResolvedData))] +[JsonSerializable(typeof(SessionAutoModeResolvedEvent))] [JsonSerializable(typeof(SessionAutopilotObjectiveChangedData))] [JsonSerializable(typeof(SessionAutopilotObjectiveChangedEvent))] [JsonSerializable(typeof(SessionBackgroundTasksChangedData))] [JsonSerializable(typeof(SessionBackgroundTasksChangedEvent))] +[JsonSerializable(typeof(SessionBinaryAssetData))] +[JsonSerializable(typeof(SessionBinaryAssetEvent))] +[JsonSerializable(typeof(SessionCanvasClosedData))] +[JsonSerializable(typeof(SessionCanvasClosedEvent))] [JsonSerializable(typeof(SessionCanvasOpenedData))] [JsonSerializable(typeof(SessionCanvasOpenedEvent))] +[JsonSerializable(typeof(SessionCanvasRecordedData))] +[JsonSerializable(typeof(SessionCanvasRecordedEvent))] [JsonSerializable(typeof(SessionCanvasRegistryChangedData))] [JsonSerializable(typeof(SessionCanvasRegistryChangedEvent))] +[JsonSerializable(typeof(SessionCanvasRemovedData))] +[JsonSerializable(typeof(SessionCanvasRemovedEvent))] +[JsonSerializable(typeof(SessionCanvasUnavailableData))] +[JsonSerializable(typeof(SessionCanvasUnavailableEvent))] [JsonSerializable(typeof(SessionCompactionCompleteData))] [JsonSerializable(typeof(SessionCompactionCompleteEvent))] [JsonSerializable(typeof(SessionCompactionStartData))] [JsonSerializable(typeof(SessionCompactionStartEvent))] [JsonSerializable(typeof(SessionContextChangedData))] [JsonSerializable(typeof(SessionContextChangedEvent))] +[JsonSerializable(typeof(SessionContextClearedData))] +[JsonSerializable(typeof(SessionContextClearedEvent))] [JsonSerializable(typeof(SessionCustomAgentsUpdatedData))] [JsonSerializable(typeof(SessionCustomAgentsUpdatedEvent))] [JsonSerializable(typeof(SessionCustomNotificationData))] @@ -8410,6 +13082,8 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(SessionErrorData))] [JsonSerializable(typeof(SessionErrorEvent))] [JsonSerializable(typeof(SessionEvent))] +[JsonSerializable(typeof(SessionExtensionsAttachmentsPushedData))] +[JsonSerializable(typeof(SessionExtensionsAttachmentsPushedEvent))] [JsonSerializable(typeof(SessionExtensionsLoadedData))] [JsonSerializable(typeof(SessionExtensionsLoadedEvent))] [JsonSerializable(typeof(SessionHandoffData))] @@ -8418,6 +13092,16 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(SessionIdleEvent))] [JsonSerializable(typeof(SessionInfoData))] [JsonSerializable(typeof(SessionInfoEvent))] +[JsonSerializable(typeof(SessionLimitsConfig))] +[JsonSerializable(typeof(SessionLimitsExhaustedCompletedData))] +[JsonSerializable(typeof(SessionLimitsExhaustedCompletedEvent))] +[JsonSerializable(typeof(SessionLimitsExhaustedRequestedData))] +[JsonSerializable(typeof(SessionLimitsExhaustedRequestedEvent))] +[JsonSerializable(typeof(SessionLimitsExhaustedResponse))] +[JsonSerializable(typeof(SessionManagedSettingsEnforcedData))] +[JsonSerializable(typeof(SessionManagedSettingsEnforcedEvent))] +[JsonSerializable(typeof(SessionManagedSettingsResolvedData))] +[JsonSerializable(typeof(SessionManagedSettingsResolvedEvent))] [JsonSerializable(typeof(SessionMcpServerStatusChangedData))] [JsonSerializable(typeof(SessionMcpServerStatusChangedEvent))] [JsonSerializable(typeof(SessionMcpServersLoadedData))] @@ -8438,6 +13122,10 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(SessionScheduleCancelledEvent))] [JsonSerializable(typeof(SessionScheduleCreatedData))] [JsonSerializable(typeof(SessionScheduleCreatedEvent))] +[JsonSerializable(typeof(SessionScheduleRearmedData))] +[JsonSerializable(typeof(SessionScheduleRearmedEvent))] +[JsonSerializable(typeof(SessionSessionLimitsChangedData))] +[JsonSerializable(typeof(SessionSessionLimitsChangedEvent))] [JsonSerializable(typeof(SessionShutdownData))] [JsonSerializable(typeof(SessionShutdownEvent))] [JsonSerializable(typeof(SessionSkillsLoadedData))] @@ -8450,10 +13138,14 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(SessionTaskCompleteEvent))] [JsonSerializable(typeof(SessionTitleChangedData))] [JsonSerializable(typeof(SessionTitleChangedEvent))] +[JsonSerializable(typeof(SessionTodosChangedData))] +[JsonSerializable(typeof(SessionTodosChangedEvent))] [JsonSerializable(typeof(SessionToolsUpdatedData))] [JsonSerializable(typeof(SessionToolsUpdatedEvent))] [JsonSerializable(typeof(SessionTruncationData))] [JsonSerializable(typeof(SessionTruncationEvent))] +[JsonSerializable(typeof(SessionUsageCheckpointData))] +[JsonSerializable(typeof(SessionUsageCheckpointEvent))] [JsonSerializable(typeof(SessionUsageInfoData))] [JsonSerializable(typeof(SessionUsageInfoEvent))] [JsonSerializable(typeof(SessionWarningData))] @@ -8487,10 +13179,12 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(SystemNotificationAgentIdle))] [JsonSerializable(typeof(SystemNotificationData))] [JsonSerializable(typeof(SystemNotificationEvent))] +[JsonSerializable(typeof(SystemNotificationFactoryCompleted))] [JsonSerializable(typeof(SystemNotificationInstructionDiscovered))] [JsonSerializable(typeof(SystemNotificationNewInboxMessage))] [JsonSerializable(typeof(SystemNotificationShellCompleted))] [JsonSerializable(typeof(SystemNotificationShellDetachedCompleted))] +[JsonSerializable(typeof(SystemNotificationUnclassified))] [JsonSerializable(typeof(ToolExecutionCompleteContent))] [JsonSerializable(typeof(ToolExecutionCompleteContentAudio))] [JsonSerializable(typeof(ToolExecutionCompleteContentImage))] @@ -8498,6 +13192,7 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(ToolExecutionCompleteContentResourceDetails))] [JsonSerializable(typeof(ToolExecutionCompleteContentResourceLink))] [JsonSerializable(typeof(ToolExecutionCompleteContentResourceLinkIcon))] +[JsonSerializable(typeof(ToolExecutionCompleteContentShellExit))] [JsonSerializable(typeof(ToolExecutionCompleteContentTerminal))] [JsonSerializable(typeof(ToolExecutionCompleteContentText))] [JsonSerializable(typeof(ToolExecutionCompleteData))] @@ -8522,22 +13217,19 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(ToolExecutionProgressEvent))] [JsonSerializable(typeof(ToolExecutionStartData))] [JsonSerializable(typeof(ToolExecutionStartEvent))] +[JsonSerializable(typeof(ToolExecutionStartShellToolInfo))] +[JsonSerializable(typeof(ToolExecutionStartToolDescription))] +[JsonSerializable(typeof(ToolExecutionStartToolDescriptionMeta))] +[JsonSerializable(typeof(ToolExecutionStartToolDescriptionMetaUI))] +[JsonSerializable(typeof(ToolSearchActivatedData))] +[JsonSerializable(typeof(ToolSearchActivatedEvent))] [JsonSerializable(typeof(ToolUserRequestedData))] [JsonSerializable(typeof(ToolUserRequestedEvent))] +[JsonSerializable(typeof(UsageCheckpointModelCacheState))] [JsonSerializable(typeof(UserInputCompletedData))] [JsonSerializable(typeof(UserInputCompletedEvent))] [JsonSerializable(typeof(UserInputRequestedData))] [JsonSerializable(typeof(UserInputRequestedEvent))] -[JsonSerializable(typeof(UserMessageAttachment))] -[JsonSerializable(typeof(UserMessageAttachmentBlob))] -[JsonSerializable(typeof(UserMessageAttachmentDirectory))] -[JsonSerializable(typeof(UserMessageAttachmentFile))] -[JsonSerializable(typeof(UserMessageAttachmentFileLineRange))] -[JsonSerializable(typeof(UserMessageAttachmentGithubReference))] -[JsonSerializable(typeof(UserMessageAttachmentSelection))] -[JsonSerializable(typeof(UserMessageAttachmentSelectionDetails))] -[JsonSerializable(typeof(UserMessageAttachmentSelectionDetailsEnd))] -[JsonSerializable(typeof(UserMessageAttachmentSelectionDetailsStart))] [JsonSerializable(typeof(UserMessageData))] [JsonSerializable(typeof(UserMessageEvent))] [JsonSerializable(typeof(UserToolSessionApproval))] @@ -8545,6 +13237,7 @@ public override void Write(Utf8JsonWriter writer, CanvasOpenedAvailability value [JsonSerializable(typeof(UserToolSessionApprovalCustomTool))] [JsonSerializable(typeof(UserToolSessionApprovalExtensionManagement))] [JsonSerializable(typeof(UserToolSessionApprovalExtensionPermissionAccess))] +[JsonSerializable(typeof(UserToolSessionApprovalFactory))] [JsonSerializable(typeof(UserToolSessionApprovalMcp))] [JsonSerializable(typeof(UserToolSessionApprovalMemory))] [JsonSerializable(typeof(UserToolSessionApprovalRead))] diff --git a/dotnet/src/GitHub.Copilot.SDK.csproj b/dotnet/src/GitHub.Copilot.SDK.csproj index 7a9fa2bdc..f48fb802d 100644 --- a/dotnet/src/GitHub.Copilot.SDK.csproj +++ b/dotnet/src/GitHub.Copilot.SDK.csproj @@ -16,6 +16,7 @@ copilot.png github;copilot;sdk;jsonrpc;agent true + true true snupkg true diff --git a/dotnet/src/JsonRpc.cs b/dotnet/src/JsonRpc.cs index 912d5a529..36289d2e6 100644 --- a/dotnet/src/JsonRpc.cs +++ b/dotnet/src/JsonRpc.cs @@ -29,6 +29,8 @@ internal sealed partial class JsonRpc : IDisposable { private const int ErrorCodeMethodNotFound = -32601; private const int ErrorCodeInternalError = -32603; + private const int InitialReadBufferSize = 256; + private const int MaximumRetainedReadBufferSize = 1024 * 1024; private readonly Stream _sendStream; private readonly Stream _receiveStream; @@ -206,14 +208,12 @@ public void Dispose() private async Task SendMessageAsync(T message, JsonTypeInfo typeInfo, CancellationToken cancellationToken) { - // "Content-Length: " (16) + max int digits (10) + "\r\n\r\n" (4) - const int MaxHeaderLength = 30; - var json = JsonSerializer.SerializeToUtf8Bytes(message, typeInfo); - var headerBuf = ArrayPool.Shared.Rent(MaxHeaderLength); - bool wrote = Utf8.TryWrite(headerBuf, $"Content-Length: {json.Length}\r\n\r\n", out int headerLen); - Debug.Assert(wrote && headerLen > 0); + // Format the LSP header and body into a single pooled buffer so the framed + // message is written in one call — over the FFI transport that is one native + // boundary crossing per message instead of two. + var frame = BuildFrame(json, out int frameLen); // Cancellation only applies to *waiting* for the write lock. Once we hold the lock // and start writing a framed message, we must finish it — cancelling between the @@ -223,20 +223,45 @@ private async Task SendMessageAsync(T message, JsonTypeInfo typeInfo, Canc await _writeLock.WaitAsync(cancellationToken).ConfigureAwait(false); try { - await _sendStream.WriteAsync(headerBuf.AsMemory(0, headerLen), CancellationToken.None).ConfigureAwait(false); - await _sendStream.WriteAsync(json, CancellationToken.None).ConfigureAwait(false); + await _sendStream.WriteAsync(frame.AsMemory(0, frameLen), CancellationToken.None).ConfigureAwait(false); await _sendStream.FlushAsync(CancellationToken.None).ConfigureAwait(false); } finally { _writeLock.Release(); - ArrayPool.Shared.Return(headerBuf); + ArrayPool.Shared.Return(frame); } } + /// + /// Writes Content-Length: N\r\n\r\n followed by into a + /// single buffer rented from . The caller owns the returned + /// buffer and must return it to the shared pool. + /// + private static byte[] BuildFrame(ReadOnlySpan json, out int frameLen) + { + // "Content-Length: " (16) + max int digits (10) + "\r\n\r\n" (4) + const int MaxHeaderLength = 30; + + // Over-rent by the (fixed, tiny) header bound so the header can be written + // straight into the frame — no scratch buffer or header copy. The JSON is + // already UTF-8, so the only copy is placing it after the header, which is + // unavoidable since Content-Length needs its length up front. + var frame = ArrayPool.Shared.Rent(MaxHeaderLength + json.Length); + if (!Utf8.TryWrite(frame, $"Content-Length: {json.Length}\r\n\r\n", out int headerLen)) + { + ArrayPool.Shared.Return(frame); + throw new InvalidOperationException("Failed to write JSON-RPC frame header."); + } + + json.CopyTo(frame.AsSpan(headerLen)); + frameLen = headerLen + json.Length; + return frame; + } + private async Task ReadLoopAsync(CancellationToken cancellationToken) { - var buffer = new byte[256]; + var buffer = new byte[InitialReadBufferSize]; int carried = 0; // bytes in buffer carried over from previous read try { @@ -275,6 +300,17 @@ private async Task ReadLoopAsync(CancellationToken cancellationToken) Buffer.BlockCopy(buffer, contentLength, buffer, 0, carried); } + if (buffer.Length > MaximumRetainedReadBufferSize) + { + var retainedBuffer = new byte[Math.Max(InitialReadBufferSize, carried)]; + if (carried > 0) + { + Buffer.BlockCopy(buffer, 0, retainedBuffer, 0, carried); + } + + buffer = retainedBuffer; + } + if (message is not { } parsed) { continue; @@ -470,7 +506,7 @@ private void HandleResponse(JsonElement message, JsonElement idProp) } catch (Exception ex) { - _logger.LogWarning(ex, "Inline response callback for request {RequestId} threw", id); + LogInlineResponseCallbackThrew(_logger, ex, id); pending.TrySetException(ex); return; } @@ -935,6 +971,11 @@ private sealed class CancelRequestParams public long Id { get; set; } } + [LoggerMessage( + Level = LogLevel.Warning, + Message = "Inline response callback for request {RequestId} threw")] + private static partial void LogInlineResponseCallbackThrew(ILogger logger, Exception exception, long requestId); + [JsonSerializable(typeof(CancelRequestParams))] private partial class CancelRequestParamsContext : JsonSerializerContext; } diff --git a/dotnet/src/PermissionDecision.cs b/dotnet/src/PermissionDecision.cs index 54e123791..3eb1d0e08 100644 --- a/dotnet/src/PermissionDecision.cs +++ b/dotnet/src/PermissionDecision.cs @@ -43,4 +43,13 @@ public static PermissionDecision Reject(string? feedback = null) => /// connected client to answer instead. /// public static PermissionDecision NoResult() => new PermissionDecisionNoResult(); + + /// + /// Optional provenance describing how and where this decision was made. + /// This is never serialized as part of the decision itself: the SDK forwards + /// it to the runtime as a sibling of result so that auto-approval + /// telemetry can be attributed correctly. + /// + [JsonIgnore] + public PermissionDecisionContext? DecisionContext { get; set; } } diff --git a/dotnet/src/PermissionHandlers.cs b/dotnet/src/PermissionHandlers.cs index 4386e8ba6..d990ca653 100644 --- a/dotnet/src/PermissionHandlers.cs +++ b/dotnet/src/PermissionHandlers.cs @@ -9,7 +9,34 @@ namespace GitHub.Copilot; /// Provides pre-built permission request handlers. public static class PermissionHandler { - /// A permission handler that approves all permission requests. + /// + /// A permission handler that approves requests when managed settings are disabled. + /// public static Func> ApproveAll { get; } = - (_, _) => Task.FromResult(PermissionDecision.ApproveOnce()); + (request, invocation) => invocation.ManagedSettingsEnabled + ? Task.FromException( + new InvalidOperationException("ApproveAll cannot be used when managed settings are enabled")) + : RequiresManagedApproval(request) + ? Task.FromResult(PermissionDecision.NoResult()) + : Task.FromResult(PermissionDecision.ApproveOnce()); + + private static bool RequiresManagedApproval(PermissionRequest request) + { + if (request.ManagedApprovalRequired is true) + { + return true; + } + + return request.GetType() == typeof(PermissionRequest) + && request.Kind is not ("shell" + or "write" + or "read" + or "mcp" + or "url" + or "memory" + or "custom-tool" + or "hook" + or "extension-management" + or "extension-permission-access"); + } } diff --git a/dotnet/src/Polyfills/DownlevelExtensions.cs b/dotnet/src/Polyfills/DownlevelExtensions.cs index 17c98643e..fc611010c 100644 --- a/dotnet/src/Polyfills/DownlevelExtensions.cs +++ b/dotnet/src/Polyfills/DownlevelExtensions.cs @@ -376,6 +376,25 @@ public async ValueTask ReadExactlyAsync(Memory buffer, Threading.Cancellat totalRead += bytesRead; } } + + public void Write(ReadOnlySpan buffer) + { + if (buffer.IsEmpty) + { + return; + } + + var rented = ArrayPool.Shared.Rent(buffer.Length); + try + { + buffer.CopyTo(rented); + stream.Write(rented, 0, buffer.Length); + } + finally + { + ArrayPool.Shared.Return(rented); + } + } } private static async ValueTask ReadAsyncSlow(Stream stream, Memory buffer, Threading.CancellationToken cancellationToken) @@ -646,3 +665,125 @@ public async Task WaitAsync(TimeSpan timeout, CancellationToken cancellationT } } } + +namespace System.Text +{ + internal static class DownlevelEncodingExtensions + { + extension(Encoding encoding) + { + public string GetString(ReadOnlySpan bytes) + { + if (bytes.IsEmpty) + { + return string.Empty; + } + + var rented = ArrayPool.Shared.Rent(bytes.Length); + try + { + bytes.CopyTo(rented); + return encoding.GetString(rented, 0, bytes.Length); + } + finally + { + ArrayPool.Shared.Return(rented); + } + } + } + } +} + +namespace System.Net.Http +{ + internal static class DownlevelHttpContentExtensions + { + extension(HttpContent content) + { + public Task ReadAsStreamAsync(Threading.CancellationToken cancellationToken) + { + // The underlying netstandard2.0 ReadAsStreamAsync() can't be cancelled, + // but honour an already-cancelled token to match the BCL overload. + cancellationToken.ThrowIfCancellationRequested(); + return content.ReadAsStreamAsync(); + } + } + } +} + +namespace System.Net.WebSockets +{ + /// + /// Polyfill for the System.Net.WebSockets.ValueWebSocketReceiveResult + /// struct, which is unavailable on .NET Standard 2.0. + /// + internal readonly struct ValueWebSocketReceiveResult + { + public ValueWebSocketReceiveResult(int count, WebSocketMessageType messageType, bool endOfMessage) + { + Count = count; + MessageType = messageType; + EndOfMessage = endOfMessage; + } + + public int Count { get; } + + public WebSocketMessageType MessageType { get; } + + public bool EndOfMessage { get; } + } + + internal static class DownlevelWebSocketExtensions + { + extension(WebSocket socket) + { + public ValueTask SendAsync(ReadOnlyMemory buffer, WebSocketMessageType messageType, bool endOfMessage, Threading.CancellationToken cancellationToken) + { + if (Runtime.InteropServices.MemoryMarshal.TryGetArray(buffer, out ArraySegment segment)) + { + return new ValueTask(socket.SendAsync(segment, messageType, endOfMessage, cancellationToken)); + } + + return SendAsyncSlow(socket, buffer, messageType, endOfMessage, cancellationToken); + } + + public ValueTask ReceiveAsync(Memory buffer, Threading.CancellationToken cancellationToken) => + ReceiveAsyncCore(socket, buffer, cancellationToken); + } + + private static async ValueTask SendAsyncSlow(WebSocket socket, ReadOnlyMemory buffer, WebSocketMessageType messageType, bool endOfMessage, Threading.CancellationToken cancellationToken) + { + var rented = ArrayPool.Shared.Rent(buffer.Length); + try + { + buffer.CopyTo(rented); + await socket.SendAsync(new ArraySegment(rented, 0, buffer.Length), messageType, endOfMessage, cancellationToken).ConfigureAwait(false); + } + finally + { + ArrayPool.Shared.Return(rented); + } + } + + private static async ValueTask ReceiveAsyncCore(WebSocket socket, Memory buffer, Threading.CancellationToken cancellationToken) + { + if (Runtime.InteropServices.MemoryMarshal.TryGetArray(buffer, out ArraySegment segment)) + { + var result = await socket.ReceiveAsync(segment, cancellationToken).ConfigureAwait(false); + return new ValueWebSocketReceiveResult(result.Count, result.MessageType, result.EndOfMessage); + } + + var rented = ArrayPool.Shared.Rent(buffer.Length); + try + { + var result = await socket.ReceiveAsync(new ArraySegment(rented, 0, buffer.Length), cancellationToken).ConfigureAwait(false); + new ReadOnlyMemory(rented, 0, result.Count).CopyTo(buffer); + return new ValueWebSocketReceiveResult(result.Count, result.MessageType, result.EndOfMessage); + } + finally + { + ArrayPool.Shared.Return(rented); + } + } + } +} diff --git a/dotnet/src/Session.cs b/dotnet/src/Session.cs index 6e7d5ea30..0ce10c290 100644 --- a/dotnet/src/Session.cs +++ b/dotnet/src/Session.cs @@ -1,4 +1,4 @@ -/*--------------------------------------------------------------------------------------------- +/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ @@ -58,10 +58,13 @@ public sealed partial class CopilotSession : IAsyncDisposable { private readonly Dictionary _toolHandlers = []; private readonly Dictionary> _commandHandlers = []; + private readonly Dictionary>> _bearerTokenProviders = new(StringComparer.Ordinal); private readonly ILogger _logger; private readonly CopilotClient _parentClient; private volatile Func>? _permissionHandler; + private bool _managedSettingsEnabled; + private volatile Func>? _mcpAuthHandler; private volatile Func>? _userInputHandler; private volatile Func>? _elicitationHandler; private volatile Func>? _exitPlanModeHandler; @@ -76,9 +79,7 @@ private sealed record EventSubscription(Type EventType, Action Han private Dictionary>>? _transformCallbacks; private readonly SemaphoreSlim _transformCallbacksLock = new(1, 1); -#pragma warning disable GHCP001 private IReadOnlyList _openCanvases = Array.Empty(); -#pragma warning restore GHCP001 private int _isDisposed; @@ -90,6 +91,13 @@ private sealed record EventSubscription(Type EventType, Action Han private readonly Channel _eventChannel = Channel.CreateUnbounded( new() { SingleReader = true }); + /// + /// Fixed name of the runtime's built-in tool-search tool. A client can + /// replace its behavior by registering a tool with this exact name and + /// OverridesBuiltInTool set to true. + /// + private const string ToolSearchToolName = "tool_search_tool"; + /// /// Gets the unique identifier for this session. /// @@ -126,17 +134,15 @@ public SessionCapabilities Capabilities private set; } -#pragma warning disable GHCP001 /// /// Canvas instances currently known to be open for this session. /// /// /// Populated from the most recent session.resume response and live - /// session.canvas.opened events. + /// session.canvas.opened and session.canvas.closed events. /// [Experimental(Diagnostics.Experimental)] public IReadOnlyList OpenCanvases => _openCanvases; -#pragma warning restore GHCP001 /// /// Gets the UI API for eliciting information from the user during this session. @@ -257,7 +263,7 @@ public Task SendAsync(string prompt, CancellationToken cancellationToken /// Prompt = "Explain this code", /// Attachments = new List<Attachment> /// { - /// new() { Type = "file", Path = "./Program.cs" } + /// new AttachmentFile { Path = "./Program.cs", DisplayName = "Program.cs" } /// } /// }); /// @@ -552,13 +558,22 @@ internal void RegisterTools(ICollection tools) /// Registers a handler for permission requests. /// /// The permission handler function. + /// Whether managed settings are enabled for the session. /// /// When the assistant needs permission to perform certain actions (e.g., file operations), /// this handler is called to approve or deny the request. /// - internal void RegisterPermissionHandler(Func>? handler) + internal void RegisterPermissionHandler( + Func>? handler, + bool managedSettingsEnabled) { _permissionHandler = handler; + _managedSettingsEnabled = managedSettingsEnabled; + } + + internal void RegisterMcpAuthHandler(Func>? handler) + { + _mcpAuthHandler = handler; } /// @@ -580,7 +595,8 @@ internal async Task HandlePermissionRequestAsync(JsonElement var invocation = new PermissionInvocation { - SessionId = SessionId + SessionId = SessionId, + ManagedSettingsEnabled = _managedSettingsEnabled }; var permissionTimestamp = Stopwatch.GetTimestamp(); @@ -636,6 +652,39 @@ private async Task HandleBroadcastEventAsync(SessionEvent sessionEvent) break; } + case McpOauthRequiredEvent authEvent: + { + var data = authEvent.Data; + if (string.IsNullOrEmpty(data.RequestId)) + return; + + var handler = _mcpAuthHandler; + if (handler is null) + { + if (_logger.IsEnabled(LogLevel.Warning)) + { + _logger.LogWarning( + "Received MCP OAuth request without a registered MCP auth handler. SessionId={SessionId}, RequestId={RequestId}", + SessionId, + data.RequestId); + } + return; + } + + await ExecuteMcpAuthAndRespondAsync(data.RequestId, new McpAuthContext + { + SessionId = SessionId, + RequestId = data.RequestId, + ServerName = data.ServerName, + ServerUrl = data.ServerUrl, + Reason = data.Reason, + WwwAuthenticateParams = data.WwwAuthenticateParams, + ResourceMetadata = data.ResourceMetadata, + StaticClientConfig = data.StaticClientConfig + }, handler); + break; + } + case CommandExecuteEvent cmdEvent: { var data = cmdEvent.Data; @@ -705,6 +754,91 @@ await HandleElicitationRequestAsync( } } + private async Task ExecuteMcpAuthAndRespondAsync( + string requestId, + McpAuthContext context, + Func> handler) + { + try + { + var result = await handler(context); + McpOauthPendingRequestResponse response = + result is { Cancelled: false, Token: { } token } + ? new McpOauthPendingRequestResponseToken + { + AccessToken = token.AccessToken, + TokenType = token.TokenType, + ExpiresIn = token.ExpiresIn + } + : new McpOauthPendingRequestResponseCancelled(); + + await Rpc.Mcp.Oauth.HandlePendingRequestAsync(requestId, response); + } + catch (OperationCanceledException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (ObjectDisposedException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (InvalidOperationException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (ArgumentException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (NotSupportedException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (JsonException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (RemoteRpcException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (IOException) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + catch (Exception ex) when (IsRecoverableMcpAuthFailure(ex)) + { + await TryCancelMcpAuthRequestAsync(requestId); + } + } + + private static bool IsRecoverableMcpAuthFailure(Exception exception) + => exception is not OperationCanceledException + and not OutOfMemoryException + and not StackOverflowException + and not AccessViolationException + and not AppDomainUnloadedException; + + private async Task TryCancelMcpAuthRequestAsync(string requestId) + { + try + { + await Rpc.Mcp.Oauth.HandlePendingRequestAsync(requestId, new McpOauthPendingRequestResponseCancelled()); + } + catch (IOException) + { + // Connection lost — nothing we can do. + } + catch (ObjectDisposedException) + { + // Connection already disposed — nothing we can do. + } + catch (RemoteRpcException) + { + // The pending request may already be gone — nothing we can do. + } + } + /// /// Executes a tool handler and sends the result back via the HandlePendingToolCall RPC. /// @@ -720,6 +854,26 @@ private async Task ExecuteToolAndRespondAsync(string requestId, string toolName, Arguments = arguments }; + // The built-in tool-search tool receives a snapshot of the session's + // currently initialized tools so an override can filter the live + // catalog without issuing its own RPC. Fetch it only for that tool + // to avoid a round-trip on every tool call; a failed fetch leaves + // the snapshot null rather than failing the tool. + if (toolName == ToolSearchToolName) + { + try + { + var metadata = await Rpc.Tools.GetCurrentMetadataAsync(); + invocation.AvailableTools = metadata.Tools; + } + catch (Exception ex) when (ex is RemoteRpcException or IOException or ObjectDisposedException or JsonException) + { + // A failed metadata fetch is non-fatal: leave AvailableTools + // null so the tool still runs without the snapshot. + LogToolMetadataFetchFailed(ex, toolName); + } + } + var aiFunctionArgs = new AIFunctionArguments { Context = new Dictionary @@ -784,7 +938,8 @@ private async Task ExecutePermissionAndRespondAsync(string requestId, Permission { var invocation = new PermissionInvocation { - SessionId = SessionId + SessionId = SessionId, + ManagedSettingsEnabled = _managedSettingsEnabled }; var permissionTimestamp = Stopwatch.GetTimestamp(); @@ -799,15 +954,16 @@ private async Task ExecutePermissionAndRespondAsync(string requestId, Permission return; } var responseRpcTimestamp = Stopwatch.GetTimestamp(); - await Rpc.Permissions.HandlePendingPermissionRequestAsync(requestId, decision); + await Rpc.Permissions.HandlePendingPermissionRequestAsync(requestId, decision, decision.DecisionContext); LoggingHelpers.LogTiming(_logger, LogLevel.Debug, null, "CopilotSession.ExecutePermissionAndRespondAsync response sent successfully. Elapsed={Elapsed}, SessionId={SessionId}, RequestId={RequestId}", responseRpcTimestamp, SessionId, requestId); } - catch (Exception) + catch (Exception ex) { + _logger.LogError(ex, "Permission handler or response delivery failed. SessionId={SessionId}, RequestId={RequestId}", SessionId, requestId); try { await Rpc.Permissions.HandlePendingPermissionRequestAsync(requestId, PermissionDecision.UserNotAvailable()); @@ -873,6 +1029,51 @@ internal void RegisterAutoModeSwitchHandler(Func + /// Registers per-provider BearerTokenProvider callbacks for BYOK + /// providers configured with managed-identity / on-demand bearer-token auth. + /// + /// + /// The runtime never receives the callback itself; the SDK strips it from the + /// provider config and instead sends hasBearerTokenProvider: true. When + /// the runtime needs a token it issues a session-scoped + /// providerToken.getToken request, which this handler routes to the + /// matching per-provider callback. + /// + /// Map of provider name to callback, or null/empty to clear. + internal void RegisterBearerTokenProviders(IReadOnlyDictionary>>? providers) + { + _bearerTokenProviders.Clear(); + if (providers is null || providers.Count == 0) + { + ClientSessionApis.ProviderToken = null; + return; + } + foreach (var (name, callback) in providers) + { + _bearerTokenProviders[name] = callback; + } + ClientSessionApis.ProviderToken = new BearerTokenProviderHandler(this); + } + + /// + /// Routes runtime providerToken.getToken requests to the matching + /// per-provider BearerTokenProvider callback registered on the session. + /// + private sealed class BearerTokenProviderHandler(CopilotSession session) : IProviderTokenHandler + { + public async Task GetTokenAsync(ProviderTokenAcquireRequest request, CancellationToken cancellationToken = default) + { + if (!session._bearerTokenProviders.TryGetValue(request.ProviderName, out var callback)) + { + throw new InvalidOperationException( + $"No bearer-token provider registered for provider \"{request.ProviderName}\""); + } + var token = await callback(new ProviderTokenArgs { ProviderName = request.ProviderName, SessionId = request.SessionId }).ConfigureAwait(false); + return new ProviderTokenAcquireResult { Token = token }; + } + } + /// /// Sets the capabilities reported by the host for this session. /// @@ -882,7 +1083,6 @@ internal void SetCapabilities(SessionCapabilities? capabilities) Capabilities = capabilities ?? new SessionCapabilities(); } -#pragma warning disable GHCP001 internal void SetOpenCanvases(IList? canvases) { _openCanvases = canvases is { Count: > 0 } @@ -892,14 +1092,26 @@ internal void SetOpenCanvases(IList? canvases) private void UpdateOpenCanvasesFromEvent(SessionEvent sessionEvent) { + if (sessionEvent is SessionCanvasClosedEvent closedEvent) + { + var closedInstanceId = closedEvent.Data.InstanceId; + if (string.IsNullOrEmpty(closedInstanceId)) + { + _logger.LogWarning("failed to deserialize session.canvas.closed payload"); + return; + } + + RemoveOpenCanvas(closedInstanceId); + return; + } + if (sessionEvent is not SessionCanvasOpenedEvent canvasEvent) return; var data = canvasEvent.Data; if (string.IsNullOrEmpty(data.InstanceId) || string.IsNullOrEmpty(data.CanvasId) - || string.IsNullOrEmpty(data.ExtensionId) - || string.IsNullOrEmpty(data.Availability.Value)) + || string.IsNullOrEmpty(data.ExtensionId)) { _logger.LogWarning("failed to deserialize session.canvas.opened payload"); return; @@ -907,15 +1119,14 @@ private void UpdateOpenCanvasesFromEvent(SessionEvent sessionEvent) UpsertOpenCanvas(new OpenCanvasInstance { - Availability = new CanvasInstanceAvailability(data.Availability.Value), CanvasId = data.CanvasId, ExtensionId = data.ExtensionId, ExtensionName = data.ExtensionName, Input = data.Input, InstanceId = data.InstanceId, - Reopen = data.Reopen, Status = data.Status, Title = data.Title, + Icon = data.Icon, Url = data.Url, }); } @@ -931,19 +1142,24 @@ private void UpsertOpenCanvas(OpenCanvasInstance canvas) _openCanvases = canvases.AsReadOnly(); } + private void RemoveOpenCanvas(string instanceId) + { + var canvases = _openCanvases.Where(open => open.InstanceId != instanceId).ToList(); + _openCanvases = canvases.AsReadOnly(); + } + internal void SetCanvasHandler(ICanvasHandler? handler) { ClientSessionApis.Canvas = handler is null ? null : new CanvasHandlerAdapter(handler); } - private static readonly JsonElement NullJsonElement = JsonDocument.Parse("null").RootElement.Clone(); + private static readonly JsonElement NullJsonElement = JsonElement.Parse("null"); private static JsonElement SerializeActionResult(object? value) { var element = CopilotClient.ToJsonElementForWire(value); return element ?? NullJsonElement; } -#pragma warning restore GHCP001 private sealed class CanvasHandlerAdapter(ICanvasHandler handler) : Rpc.ICanvasHandler { @@ -1397,6 +1613,11 @@ internal void RegisterHooks(SessionHooks hooks) JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.UserPromptSubmittedHookInput)!, invocation) : null, + "userPromptTransformed" => hooks.OnUserPromptTransformed != null + ? await hooks.OnUserPromptTransformed( + JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.UserPromptTransformedHookInput)!, + invocation) + : null, "sessionStart" => hooks.OnSessionStart != null ? await hooks.OnSessionStart( JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.SessionStartHookInput)!, @@ -1412,6 +1633,11 @@ internal void RegisterHooks(SessionHooks hooks) JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.ErrorOccurredHookInput)!, invocation) : null, + "agentStop" => hooks.OnAgentStop != null + ? await hooks.OnAgentStop( + JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.AgentStopHookInput)!, + invocation) + : null, _ => null }; } @@ -1568,22 +1794,50 @@ public async Task AbortAsync(CancellationToken cancellationToken = default) /// Changes the model for this session. /// The new model takes effect for the next message. Conversation history is preserved. /// - /// Model ID to switch to (e.g., "gpt-4.1"). - /// Reasoning effort level (e.g., "low", "medium", "high", "xhigh"). + /// Model ID to switch to (e.g., "gpt-5.4"). + /// Reasoning effort level (e.g., "low", "medium", "high", "xhigh", "max"). /// Per-property overrides for model capabilities, deep-merged over runtime defaults. /// Optional cancellation token. /// /// - /// await session.SetModelAsync("gpt-4.1"); + /// await session.SetModelAsync("gpt-5.4"); /// await session.SetModelAsync("claude-sonnet-4.6", "high"); + /// await session.SetModelAsync("gpt-5.4", new SetModelOptions { ContextTier = ContextTier.LongContext }); /// /// - public async Task SetModelAsync(string model, string? reasoningEffort, ModelCapabilitiesOverride? modelCapabilities = null, CancellationToken cancellationToken = default) + public Task SetModelAsync(string model, string? reasoningEffort, ModelCapabilitiesOverride? modelCapabilities = null, CancellationToken cancellationToken = default) + { + return SetModelAsync( + model, + new SetModelOptions + { + ReasoningEffort = reasoningEffort, + ModelCapabilities = modelCapabilities, + }, + cancellationToken); + } + + /// + /// Changes the model for this session. + /// The new model takes effect for the next message. Conversation history is preserved. + /// + /// Model ID to switch to (e.g., "gpt-5.4"). + /// Settings for the new model. + /// Optional cancellation token. + public async Task SetModelAsync(string model, SetModelOptions options, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(model); ThrowIfDisposed(); - await Rpc.Model.SwitchToAsync(model, reasoningEffort, reasoningSummary: null, modelCapabilities: modelCapabilities, cancellationToken: cancellationToken); + await Rpc.Model.SwitchToAsync( + model, + options.ReasoningEffort, + options.ReasoningSummary, + null, + options.ModelCapabilities, + options.ContextTier, + null, + cancellationToken); } /// @@ -1593,7 +1847,7 @@ public Task SetModelAsync(string model, CancellationToken cancellationToken = de { ThrowIfDisposed(); - return SetModelAsync(model, reasoningEffort: null, modelCapabilities: null, cancellationToken); + return SetModelAsync(model, new SetModelOptions(), cancellationToken); } /// @@ -1700,12 +1954,15 @@ await InvokeRpcAsync( [LoggerMessage(Level = LogLevel.Error, Message = "Unhandled exception in session event handler")] private partial void LogEventHandlerError(Exception exception); + [LoggerMessage(Level = LogLevel.Debug, Message = "Failed to fetch tool metadata for {toolName}")] + private partial void LogToolMetadataFetchFailed(Exception exception, string toolName); + internal record SendMessageRequest { public string SessionId { get; init; } = string.Empty; public string Prompt { get; init; } = string.Empty; public string? DisplayPrompt { get; init; } - public IList? Attachments { get; init; } + public IList? Attachments { get; init; } public string? Mode { get; init; } [JsonPropertyName("agentMode")] public AgentMode? AgentMode { get; init; } @@ -1749,6 +2006,8 @@ internal void ThrowIfDisposed() AllowOutOfOrderMetadataProperties = true, NumberHandling = JsonNumberHandling.AllowReadingFromString, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] + [JsonSerializable(typeof(AgentStopHookInput))] + [JsonSerializable(typeof(AgentStopHookOutput))] [JsonSerializable(typeof(AutoModeSwitchRequest))] [JsonSerializable(typeof(AutoModeSwitchResponse))] [JsonSerializable(typeof(Dictionary))] @@ -1776,8 +2035,10 @@ internal void ThrowIfDisposed() [JsonSerializable(typeof(SessionStartHookOutput))] [JsonSerializable(typeof(SystemMessageTransformRpcResponse))] [JsonSerializable(typeof(SystemMessageTransformSection))] - [JsonSerializable(typeof(UserMessageAttachment))] + [JsonSerializable(typeof(Attachment))] [JsonSerializable(typeof(UserPromptSubmittedHookInput))] [JsonSerializable(typeof(UserPromptSubmittedHookOutput))] + [JsonSerializable(typeof(UserPromptTransformedHookInput))] + [JsonSerializable(typeof(UserPromptTransformedHookOutput))] internal partial class SessionJsonContext : JsonSerializerContext; } diff --git a/dotnet/src/SessionFsProvider.cs b/dotnet/src/SessionFsProvider.cs index fbb8df507..a353c93ad 100644 --- a/dotnet/src/SessionFsProvider.cs +++ b/dotnet/src/SessionFsProvider.cs @@ -3,6 +3,7 @@ *--------------------------------------------------------------------------------------------*/ using GitHub.Copilot.Rpc; +using System.Diagnostics.CodeAnalysis; using System.Text.Json; namespace GitHub.Copilot; @@ -27,6 +28,23 @@ public sealed class SessionFsSqliteResult public long? LastInsertRowid { get; set; } } +/// +/// One statement in an atomic SQLite transaction passed to +/// . +/// +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteStatement +{ + /// How to execute: "exec", "query", or "run". + public SessionFsSqliteQueryType QueryType { get; set; } + + /// SQL statement to execute. + public string Query { get; set; } = string.Empty; + + /// Optional named bind parameters. + public IDictionary? Params { get; set; } +} + /// /// Optional interface for subclasses that support /// per-session SQLite databases. Implement this interface on your provider to enable @@ -55,6 +73,52 @@ public interface ISessionFsSqliteProvider Task ExistsAsync(CancellationToken cancellationToken); } +/// +/// Optional capability for session filesystem providers that support atomic SQLite transactions. +/// +public interface ISessionFsSqliteTransactionProvider +{ + /// + /// Executes atomically against the per-session database. + /// + /// Statements to execute in order, inside a single transaction. + /// Cancellation token. + /// One result per statement, in the same order as . + /// + /// Thrown to tell the runtime how the failure should be classified. Any other exception + /// is reported as . + /// + Task> TransactionAsync( + IList statements, + CancellationToken cancellationToken); +} + +/// +/// Thrown by an to classify a failed SQLite transaction. +/// guarantees the transaction +/// rolled back and is safe to retry; +/// must never be retried. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class SessionFsSqliteTransactionException : Exception +{ + /// Initializes a new instance of the class. + /// Human-readable failure description. + /// How the runtime should classify the failure. + /// Optional underlying exception. + public SessionFsSqliteTransactionException( + string message, + SessionFsSqliteTransactionErrorClass errorClass, + Exception? innerException = null) + : base(message, innerException) + { + ErrorClass = errorClass; + } + + /// Gets the failure classification reported to the runtime. + public SessionFsSqliteTransactionErrorClass ErrorClass { get; } +} + /// /// Base class for session filesystem providers. Subclasses override the /// virtual methods and use normal C# patterns (return values, throw exceptions). @@ -297,7 +361,7 @@ async Task ISessionFsHandler.SqliteQueryAsync(Sessio { Rows = result?.Rows?.Select(row => (IDictionary)row.ToDictionary( kvp => kvp.Key, - kvp => CopilotClient.ToJsonElementForWire(kvp.Value)!.Value)).ToList() ?? [], + kvp => ToJsonElement(kvp.Value))).ToList() ?? [], Columns = result?.Columns ?? [], RowsAffected = result?.RowsAffected ?? 0, LastInsertRowid = result?.LastInsertRowid, @@ -309,6 +373,78 @@ async Task ISessionFsHandler.SqliteQueryAsync(Sessio } } + async Task ISessionFsHandler.SqliteTransactionAsync(SessionFsSqliteTransactionRequest request, CancellationToken cancellationToken) + { + if (this is not ISessionFsSqliteTransactionProvider transactionProvider) + { + return new SessionFsSqliteTransactionResult + { + Error = new SessionFsSqliteTransactionError + { + ErrorClass = SessionFsSqliteTransactionErrorClass.Fatal, + Message = "SQLite is not supported by this provider.", + }, + }; + } + + IList results; + try + { + var statements = request.Statements.Select(statement => new SessionFsSqliteStatement + { + QueryType = statement.QueryType, + Query = statement.Query, + Params = statement.Params?.ToDictionary(kvp => kvp.Key, kvp => JsonElementToValue(kvp.Value)), + }).ToList(); + results = await transactionProvider.TransactionAsync(statements, cancellationToken).ConfigureAwait(false); + } + catch (SessionFsSqliteTransactionException ex) + { + return new SessionFsSqliteTransactionResult + { + Error = new SessionFsSqliteTransactionError { ErrorClass = ex.ErrorClass, Message = ex.Message }, + }; + } + catch (Exception ex) + { + return new SessionFsSqliteTransactionResult + { + Error = new SessionFsSqliteTransactionError + { + ErrorClass = SessionFsSqliteTransactionErrorClass.Fatal, + Message = ex.Message, + }, + }; + } + + try + { + return new SessionFsSqliteTransactionResult + { + Results = results.Select(result => new SessionFsSqliteQueryResult + { + Rows = result.Rows?.Select(row => (IDictionary)row.ToDictionary( + kvp => kvp.Key, + kvp => ToJsonElement(kvp.Value))).ToList() ?? [], + Columns = result.Columns ?? [], + RowsAffected = result.RowsAffected, + LastInsertRowid = result.LastInsertRowid, + }).ToList(), + }; + } + catch (Exception ex) + { + return new SessionFsSqliteTransactionResult + { + Error = new SessionFsSqliteTransactionError + { + ErrorClass = SessionFsSqliteTransactionErrorClass.PostCommitAmbiguous, + Message = ex.Message, + }, + }; + } + } + async Task ISessionFsHandler.SqliteExistsAsync(SessionFsSqliteExistsRequest request, CancellationToken cancellationToken) { if (this is not ISessionFsSqliteProvider sqliteProvider) @@ -336,6 +472,9 @@ private static SessionFsError ToSessionFsError(Exception ex) return new SessionFsError { Code = code, Message = ex.Message }; } + private static JsonElement ToJsonElement(object? value) => + CopilotClient.ToJsonElementForWire(value) ?? JsonElement.Parse("null"); + private static object? JsonElementToValue(JsonElement element) => element.ValueKind switch { JsonValueKind.Null => null, diff --git a/dotnet/src/Types.cs b/dotnet/src/Types.cs index e26391069..c0810b387 100644 --- a/dotnet/src/Types.cs +++ b/dotnet/src/Types.cs @@ -5,12 +5,14 @@ using GitHub.Copilot.Rpc; using Microsoft.Extensions.AI; using Microsoft.Extensions.Logging; +using System; using System.ComponentModel; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; +using System.Threading.Tasks; namespace GitHub.Copilot; @@ -143,6 +145,20 @@ public static TcpRuntimeConnection ForTcp(int port = 0, string? connectionToken /// Optional shared secret to authenticate the connection. public static UriRuntimeConnection ForUri(string url, string? connectionToken = null) => new() { Url = url, ConnectionToken = connectionToken }; + + /// + /// Host the runtime in-process by loading its native library and communicating + /// over the C ABI (FFI) — no child process is spawned by the SDK for JSON-RPC + /// transport. The bundled runtime is used; to point at a non-default runtime + /// entrypoint, set the COPILOT_CLI_PATH environment variable. + /// + /// + /// Works across the SDK's target frameworks: modern .NET uses NativeLibrary, + /// while netstandard2.0 consumers use a built-in fallback native loader. + /// + [Experimental(Diagnostics.Experimental)] + public static InProcessRuntimeConnection ForInProcess() + => new(); } /// @@ -157,6 +173,16 @@ internal ChildProcessRuntimeConnection() { } /// Extra command-line arguments to pass to the runtime process. public IList? Args { get; set; } + + /// + /// Gets or sets the environment variables passed to the spawned runtime process, + /// replacing the inherited environment. + /// + /// + /// Cannot be combined with ; setting both throws + /// an when the client is constructed. + /// + public IReadOnlyDictionary? Environment { get; set; } } /// @@ -168,6 +194,19 @@ public sealed class StdioRuntimeConnection : ChildProcessRuntimeConnection internal StdioRuntimeConnection() { } } +/// +/// Hosts the runtime in-process by loading its native library and communicating +/// over the C ABI (FFI). Construct via . +/// Works across the SDK's target frameworks (modern .NET and netstandard2.0). +/// To point at a non-default runtime entrypoint, set the COPILOT_CLI_PATH +/// environment variable. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class InProcessRuntimeConnection : RuntimeConnection +{ + internal InProcessRuntimeConnection() { } +} + /// /// Spawns a runtime child process listening on a TCP socket. Construct via /// . @@ -270,6 +309,7 @@ private CopilotClientOptions(CopilotClientOptions? other) Connection = other.Connection; WorkingDirectory = other.WorkingDirectory; BaseDirectory = other.BaseDirectory; + BuiltinPluginDirectories = other.BuiltinPluginDirectories is null ? null : [.. other.BuiltinPluginDirectories]; Environment = other.Environment; GitHubToken = other.GitHubToken; Logger = other.Logger; @@ -278,6 +318,8 @@ private CopilotClientOptions(CopilotClientOptions? other) UseLoggedInUser = other.UseLoggedInUser; OnListModels = other.OnListModels; SessionFs = other.SessionFs; + RequestHandler = other.RequestHandler; + OnGitHubTelemetry = other.OnGitHubTelemetry; SessionIdleTimeoutSeconds = other.SessionIdleTimeoutSeconds; EnableRemoteSessions = other.EnableRemoteSessions; Mode = other.Mode; @@ -317,6 +359,13 @@ private CopilotClientOptions(CopilotClientOptions? other) /// public string? BaseDirectory { get; set; } + /// + /// Absolute paths to trusted plugin directories bundled by the host. + /// When non-empty, the complete set is registered with the runtime during + /// startup before sessions can be created. + /// + public IList? BuiltinPluginDirectories { get; set; } + /// /// Log level for the Copilot runtime. Use the well-known values on /// (, @@ -327,7 +376,15 @@ private CopilotClientOptions(CopilotClientOptions? other) /// public CopilotLogLevel? LogLevel { get; set; } - /// Environment variables to pass to the runtime process. + /// + /// Gets or sets environment variables passed to the runtime process. + /// + /// + /// Not supported with the in-process transport (), + /// which runs the runtime in the host process; setting this option there throws an + /// . For child-process transports, prefer + /// ; setting both throws. + /// public IReadOnlyDictionary? Environment { get; set; } /// Logger instance for SDK diagnostic output. @@ -364,6 +421,26 @@ private CopilotClientOptions(CopilotClientOptions? other) /// public SessionFsConfig? SessionFs { get; set; } + /// + /// Configures interception of the LLM inference requests the runtime would + /// otherwise issue itself (for both CAPI and BYOK providers). When set, the + /// client registers a client-global LLM inference handler on connect, so + /// every model-layer HTTP / WebSocket request is routed to this + /// subclass instead of the runtime's own + /// outbound call. + /// + [Experimental(Diagnostics.Experimental)] + public CopilotRequestHandler? RequestHandler { get; set; } + + /// + /// Experimental. Receives GitHub telemetry events the runtime forwards to this + /// connection; setting a handler opts created/resumed sessions into forwarding. + /// The SDK awaits the handler task so it may perform asynchronous work. + /// + [Experimental(Diagnostics.Experimental)] + [EditorBrowsable(EditorBrowsableState.Never)] + public Func? OnGitHubTelemetry { get; set; } + /// /// OpenTelemetry configuration for the runtime. /// When set to a non- instance, the runtime is started with OpenTelemetry instrumentation enabled. @@ -413,6 +490,14 @@ public sealed class TelemetryConfig /// public string? OtlpEndpoint { get; set; } + /// + /// OTLP HTTP protocol for all signals ("http/json" or "http/protobuf"). + /// + /// + /// Maps to the OTEL_EXPORTER_OTLP_PROTOCOL environment variable. + /// + public string? OtlpProtocol { get; set; } + /// /// File path for the file exporter. /// @@ -620,6 +705,12 @@ public sealed class ToolResultObject [JsonPropertyName("toolTelemetry")] public IDictionary? ToolTelemetry { get; set; } + /// + /// Names of tools returned by a tool-search tool. + /// + [JsonPropertyName("toolReferences")] + public IList? ToolReferences { get; set; } + /// /// Converts the result of an invocation into a /// . Handles , @@ -731,6 +822,14 @@ public sealed class ToolInvocation /// Arguments passed to the tool by the language model. /// public JsonElement? Arguments { get; set; } + /// + /// Snapshot of the session's currently initialized tools. The SDK populates + /// this only when the invocation targets the built-in tool-search tool + /// (tool_search_tool), so a tool-search override can rank/filter the + /// live catalog — including MCP tools configured in settings — without + /// issuing its own RPC. null for every other tool invocation. + /// + public IList? AvailableTools { get; set; } } /// @@ -742,6 +841,9 @@ public sealed class PermissionInvocation /// Identifier of the session that triggered the permission request. /// public string SessionId { get; set; } = string.Empty; + + /// Whether managed settings are enabled for this session. + public bool ManagedSettingsEnabled { get; set; } } // ============================================================================ @@ -1106,6 +1208,72 @@ public sealed class ElicitationContext public string? Url { get; set; } } +/// +/// Context for an MCP OAuth request callback. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class McpAuthContext +{ + /// Identifier of the session that triggered the MCP OAuth request. + public string SessionId { get; set; } = string.Empty; + + /// Identifier of the pending MCP OAuth request. + public string RequestId { get; set; } = string.Empty; + + /// Display name of the MCP server that requires OAuth. + public string ServerName { get; set; } = string.Empty; + + /// URL of the MCP server that requires OAuth. + public string ServerUrl { get; set; } = string.Empty; + + /// Why the runtime is requesting host-provided OAuth credentials. + public McpOauthRequestReason Reason { get; set; } + + /// Parsed WWW-Authenticate parameters from the MCP server, if available. + public McpOauthWWWAuthenticateParams? WwwAuthenticateParams { get; set; } + + /// Raw RFC 9728 protected-resource metadata JSON fetched by the runtime, if available. + public string? ResourceMetadata { get; set; } + + /// Static OAuth client configuration, if the server specifies one. + public McpOauthRequiredStaticClientConfig? StaticClientConfig { get; set; } +} + +/// +/// Host-provided OAuth token data for a pending MCP OAuth request. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class McpAuthToken +{ + /// Access token acquired by the SDK host. + public required string AccessToken { get; set; } + + /// OAuth token type. Defaults to Bearer when omitted. + public string? TokenType { get; set; } + + /// Token lifetime in seconds, if known. + public long? ExpiresIn { get; set; } +} + +/// +/// Result returned by an MCP auth request handler. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class McpAuthResult +{ + /// Whether the request should be cancelled instead of resolved with a token. + public bool Cancelled { get; set; } + + /// Host-provided token data. Ignored when is true. + public McpAuthToken? Token { get; set; } + + /// Create a token result. + public static McpAuthResult FromToken(McpAuthToken token) => new() { Token = token }; + + /// Create a cancellation result. + public static McpAuthResult Cancel() => new() { Cancelled = true }; +} + // ============================================================================ // Session Capabilities // ============================================================================ @@ -1496,6 +1664,55 @@ public sealed class UserPromptSubmittedHookOutput public bool? SuppressOutput { get; set; } } +/// +/// Input for a user-prompt-transformed hook. +/// +public sealed class UserPromptTransformedHookInput +{ + /// + /// The runtime session ID of the session that triggered the hook. + /// + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// + /// Unix timestamp in milliseconds when the prompt was transformed. + /// + [JsonPropertyName("timestamp")] + [JsonConverter(typeof(UnixMillisecondsDateTimeOffsetConverter))] + public DateTimeOffset Timestamp { get; set; } + + /// + /// Current working directory of the session. + /// + [JsonPropertyName("cwd")] + public string WorkingDirectory { get; set; } = string.Empty; + + /// + /// The user prompt after any user-prompt-submitted hooks have run. + /// + [JsonPropertyName("prompt")] + public string Prompt { get; set; } = string.Empty; + + /// + /// The model-facing prompt after runtime transformations. + /// + [JsonPropertyName("transformedPrompt")] + public string TransformedPrompt { get; set; } = string.Empty; +} + +/// +/// Output for a user-prompt-transformed hook. +/// +public sealed class UserPromptTransformedHookOutput +{ + /// + /// Replacement model-facing prompt to persist and send to the model. + /// + [JsonPropertyName("modifiedTransformedPrompt")] + public string? ModifiedTransformedPrompt { get; set; } +} + /// /// Input for a session-start hook. /// @@ -1714,6 +1931,67 @@ public sealed class ErrorOccurredHookOutput public string? UserNotification { get; set; } } +/// +/// Input for an agent-stop hook. +/// +public sealed class AgentStopHookInput +{ + /// + /// The runtime session ID of the session that triggered the hook. + /// + [JsonPropertyName("sessionId")] + public string SessionId { get; set; } = string.Empty; + + /// + /// Unix timestamp in milliseconds when the agent stopped. + /// + [JsonPropertyName("timestamp")] + [JsonConverter(typeof(UnixMillisecondsDateTimeOffsetConverter))] + public DateTimeOffset Timestamp { get; set; } + + /// + /// Current working directory of the session. + /// + [JsonPropertyName("cwd")] + public string WorkingDirectory { get; set; } = string.Empty; + + /// + /// Reason the agent stopped. + /// + [JsonPropertyName("stopReason")] + public string? StopReason { get; set; } + + /// + /// Path to the on-disk session transcript. + /// + [JsonPropertyName("transcriptPath")] + public string? TranscriptPath { get; set; } + + /// + /// Whether this stop follows a previous block decision from the hook. + /// + [JsonPropertyName("stop_hook_active")] + public bool? StopHookActive { get; set; } +} + +/// +/// Output for an agent-stop hook. +/// +public sealed class AgentStopHookOutput +{ + /// + /// Set to "block" to keep the agent running. + /// + [JsonPropertyName("decision")] + public string? Decision { get; set; } + + /// + /// Follow-up instruction supplied when the stop is blocked. + /// + [JsonPropertyName("reason")] + public string? Reason { get; set; } +} + /// /// Hook handlers configuration for a session. /// @@ -1746,6 +2024,11 @@ public sealed class SessionHooks /// public Func>? OnUserPromptSubmitted { get; set; } + /// + /// Handler called after the runtime transforms a submitted prompt and before it is stored. + /// + public Func>? OnUserPromptTransformed { get; set; } + /// /// Handler called when a session starts. /// @@ -1760,6 +2043,11 @@ public sealed class SessionHooks /// Handler called when an error occurs. /// public Func>? OnErrorOccurred { get; set; } + + /// + /// Handler called when the top-level agent reaches a natural stop. + /// + public Func>? OnAgentStop { get; set; } } /// @@ -1820,6 +2108,13 @@ public enum SectionOverrideAction /// Prepend content before the existing section. [JsonStringEnumMemberName("prepend")] Prepend, + /// + /// No-op marker that opts an individually-addressable section out of a group-level + /// remove (e.g. keep when removing the + /// group). + /// + [JsonStringEnumMemberName("preserve")] + Preserve, /// Transform the section content via a callback. [JsonStringEnumMemberName("transform")] Transform @@ -1858,6 +2153,8 @@ public sealed class SectionOverride public readonly struct SystemMessageSection : IEquatable { /// Agent identity preamble and mode statement. + public static SystemMessageSection Preamble { get; } = new("preamble"); + /// Section group covering the identity preamble and its sibling sub-sections (tone, tool efficiency, etc.). public static SystemMessageSection Identity { get; } = new("identity"); /// Response style, conciseness rules, output formatting preferences. public static SystemMessageSection Tone { get; } = new("tone"); @@ -1983,6 +2280,15 @@ public sealed class ProviderConfig [JsonPropertyName("wireApi")] public string? WireApi { get; set; } + /// + /// Transport for OpenAI Responses requests ("http" or "websockets"). Defaults to "http". + /// Set to "websockets" to deliver Responses API requests over a persistent WebSocket + /// connection instead of HTTP. Applies to OpenAI-compatible providers using + /// wireApi: "responses". + /// + [JsonPropertyName("transport")] + public string? Transport { get; set; } + /// /// Base URL of the provider's API endpoint. /// @@ -2003,6 +2309,29 @@ public sealed class ProviderConfig [JsonPropertyName("bearerToken")] public string? BearerToken { get; set; } + /// + /// Wire-only flag, emitted automatically when is set, that tells + /// the runtime to request a token over the session-scoped providerToken.getToken RPC + /// before each outbound request to this provider. Derived from ; + /// internal and never part of the public API. + /// + [JsonInclude] + [JsonPropertyName("hasBearerTokenProvider")] + internal bool? HasBearerTokenProvider => BearerTokenProvider is not null ? true : null; + + /// + /// Per-request callback that resolves a bearer token on demand for this BYOK provider (for + /// example via Azure Managed Identity). The Copilot SDK takes no identity dependency: supply a + /// callback backed by your own identity library. Never serialized — setting it makes the SDK send + /// hasBearerTokenProvider: true on the wire and answer the runtime's + /// providerToken.getToken requests. When set alongside /, this callback takes precedence: + /// the runtime applies the token it returns as the Authorization: Bearer header for each request + /// and does not send the static credential. + /// + [JsonIgnore] + [Experimental(Diagnostics.Experimental)] + public Func>? BearerTokenProvider { get; set; } + /// /// Azure-specific configuration options. /// @@ -2050,18 +2379,191 @@ public sealed class ProviderConfig public int? MaxOutputTokens { get; set; } } +/// +/// Provider-scoped options for the Copilot API (CAPI) provider. +/// +public sealed class CapiSessionOptions +{ + /// + /// When , forces the HTTP Responses transport for the CAPI Responses API + /// instead of the default WebSocket transport. + /// + /// + /// WebSocket transport is the default for CAPI Responses API requests when the model advertises + /// the ws:/responses endpoint. Set this to for users behind proxies + /// where WebSockets fail. Setting it to is equivalent to setting the + /// COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES environment variable. The option is scoped under + /// the capi namespace because a single session can host multiple providers, such as CAPI and + /// BYOK, so transport choice is provider-level. + /// + [JsonPropertyName("enableWebSocketResponses")] + public bool? EnableWebSocketResponses { get; set; } +} + /// /// Azure OpenAI-specific provider options. /// public sealed class AzureOptions { /// - /// Azure OpenAI API version to use (e.g., "2024-02-01"). + /// Azure OpenAI API version. When omitted, the runtime uses the GA versionless v1 route. /// [JsonPropertyName("apiVersion")] public string? ApiVersion { get; set; } } +/// +/// A named BYOK provider connection (transport + credentials only), referenced by +/// entries via . +/// +/// Unlike the singular, whole-session — which bypasses +/// Copilot API authentication — named providers are additive and coexist with Copilot +/// API auth, so models from CAPI and one or more BYOK providers can be mixed within a +/// single session and across sub-agents. Combining named providers/models with +/// is rejected. +/// +/// +[Experimental(Diagnostics.Experimental)] +public sealed class NamedProviderConfig +{ + /// + /// Stable identifier referenced by . + /// Must not contain '/'. + /// + [JsonPropertyName("name")] + public string Name { get; set; } = string.Empty; + + /// + /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// Wire API format (openai/azure only). Defaults to "completions". + /// + [JsonPropertyName("wireApi")] + public string? WireApi { get; set; } + + /// + /// API endpoint URL. + /// + [JsonPropertyName("baseUrl")] + public string BaseUrl { get; set; } = string.Empty; + + /// + /// API key. Optional for local providers like Ollama. + /// + [JsonPropertyName("apiKey")] + public string? ApiKey { get; set; } + + /// + /// Bearer token for authentication. Sets the Authorization header directly. + /// Takes precedence over when both are set. + /// + [JsonPropertyName("bearerToken")] + public string? BearerToken { get; set; } + + /// + /// Wire-only flag, emitted automatically when is set, that tells + /// the runtime to request a token over the session-scoped providerToken.getToken RPC + /// before each outbound request to this provider. Derived from ; + /// internal and never part of the public API. + /// + [JsonInclude] + [JsonPropertyName("hasBearerTokenProvider")] + internal bool? HasBearerTokenProvider => BearerTokenProvider is not null ? true : null; + + /// + /// Per-request callback that resolves a bearer token on demand for this BYOK provider (for + /// example via Azure Managed Identity). The Copilot SDK takes no identity dependency: supply a + /// callback backed by your own identity library. Never serialized — setting it makes the SDK send + /// hasBearerTokenProvider: true on the wire and answer the runtime's + /// providerToken.getToken requests. When set alongside /, this callback takes precedence: + /// the runtime applies the token it returns as the Authorization: Bearer header for each request + /// and does not send the static credential. + /// + [JsonIgnore] + [Experimental(Diagnostics.Experimental)] + public Func>? BearerTokenProvider { get; set; } + + /// + /// Azure-specific configuration options. + /// + [JsonPropertyName("azure")] + public AzureOptions? Azure { get; set; } + + /// + /// Custom HTTP headers to include in all outbound requests to the provider. + /// + [JsonPropertyName("headers")] + public IDictionary? Headers { get; set; } +} + +/// +/// A BYOK model definition that references a by name +/// and is added to the session's selectable model list. The session-wide selection id +/// (shown in the model list and passed to model switching) is the provider-qualified +/// provider/id, so BYOK ids never collide with bare CAPI ids. +/// +[Experimental(Diagnostics.Experimental)] +public sealed class ProviderModelConfig +{ + /// + /// Provider-local model id, unique within its provider. + /// + [JsonPropertyName("id")] + public string Id { get; set; } = string.Empty; + + /// + /// Name of the that serves this model. + /// + [JsonPropertyName("provider")] + public string Provider { get; set; } = string.Empty; + + /// + /// The model name sent to the provider API for inference. Defaults to . + /// + [JsonPropertyName("wireModel")] + public string? WireModel { get; set; } + + /// + /// Well-known base model id used for behavior/capability/config lookup. Defaults to . + /// + [JsonPropertyName("modelId")] + public string? ModelId { get; set; } + + /// + /// Display name for model pickers. Defaults to the provider-qualified selection id. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// Maximum prompt/input tokens for the model. + /// + [JsonPropertyName("maxPromptTokens")] + public int? MaxPromptTokens { get; set; } + + /// + /// Maximum context window tokens for the model. + /// + [JsonPropertyName("maxContextWindowTokens")] + public int? MaxContextWindowTokens { get; set; } + + /// + /// Maximum output tokens for the model. + /// + [JsonPropertyName("maxOutputTokens")] + public int? MaxOutputTokens { get; set; } + + /// + /// Optional capability overrides (vision, tool_calls, reasoning, etc.) for the synthesized model. + /// + [JsonPropertyName("capabilities")] + public ModelCapabilitiesOverride? Capabilities { get; set; } +} + // ============================================================================ // MCP Server Configuration Types // ============================================================================ @@ -2286,6 +2788,14 @@ public sealed class CustomAgentConfig /// [JsonPropertyName("model")] public string? Model { get; set; } + + /// + /// Reasoning effort level for this agent's model. + /// When omitted, the runtime resolves model configuration, then inherits + /// the parent effort only if this agent uses the same model. + /// + [JsonPropertyName("reasoningEffort")] + public string? ReasoningEffort { get; set; } } /// @@ -2364,6 +2874,42 @@ public sealed class LargeToolOutputConfig public string? OutputDirectory { get; set; } } +/// +/// Overrides the runtime's built-in tool-search behavior. +/// Defers tools to keep the model's active tool set small. +/// To override the tool-search tool's implementation, register a tool +/// named "tool_search_tool" with OverridesBuiltInTool set to +/// . +/// +public sealed class ToolSearchConfig +{ + /// + /// Enable or disable tool search. + /// + [JsonPropertyName("enabled")] + public bool? Enabled { get; set; } + + /// + /// The tool count above which MCP and external tools are deferred behind + /// tool search. When , the runtime default (30) + /// applies. + /// + [JsonPropertyName("deferThreshold")] + public int? DeferThreshold { get; set; } +} + +/// +/// Configuration for session memory. +/// +public sealed class MemoryConfiguration +{ + /// + /// Whether memory is enabled for the session. + /// + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } +} + /// /// GitHub repository metadata to associate with a cloud session. /// @@ -2391,62 +2937,183 @@ public sealed class CloudSessionOptions } /// -/// Context window tier for models that support tiered context windows. +/// Optional settings for . /// -[JsonConverter(typeof(ContextTier.Converter))] -[DebuggerDisplay("{Value,nq}")] -public readonly struct ContextTier : IEquatable +public struct SetModelOptions { - private readonly string? _value; + /// + /// Reasoning effort level for the new model. + /// + public string? ReasoningEffort { get; set; } - /// Initializes a new instance of the struct. - /// The value to associate with this . - [JsonConstructor] - public ContextTier(string value) - { - ArgumentException.ThrowIfNullOrWhiteSpace(value); - _value = value; - } + /// + /// Reasoning summary mode for models that support configurable reasoning summaries. + /// + /// + /// Use to suppress summary output regardless of whether reasoning is enabled. + /// + public ReasoningSummary? ReasoningSummary { get; set; } - /// Gets the value associated with this . - public string Value => _value ?? string.Empty; + /// + /// Explicit context window tier for models that support it. + /// Leave unset to use normal model behavior with no explicit tier. + /// + public ContextTier? ContextTier { get; set; } - /// Default context tier with standard context window size. - public static ContextTier Default { get; } = new("default"); + /// Per-property overrides for model capabilities, deep-merged over runtime defaults. + public ModelCapabilitiesOverride? ModelCapabilities { get; set; } +} - /// Extended context tier with a larger context window. - public static ContextTier LongContext { get; } = new("long_context"); +/// +/// A single configuration entry in a . +/// Each entry carries an identifier and a bag of typed parameter values. +/// +public sealed class ExpConfigEntry +{ + /// Identifier of the configuration entry. + [JsonPropertyName("Id")] + public string Id { get; set; } = string.Empty; - /// Returns a value indicating whether two instances are equivalent. - public static bool operator ==(ContextTier left, ContextTier right) => left.Equals(right); + /// + /// Parameter values keyed by parameter name. Each value is a scalar string, + /// number, boolean, or null. + /// + [JsonPropertyName("Parameters")] + public IDictionary Parameters { get; set; } = new Dictionary(); +} - /// Returns a value indicating whether two instances are not equivalent. - public static bool operator !=(ContextTier left, ContextTier right) => !left.Equals(right); +/// +/// ExP ("flight") assignment data, in the same JSON shape the Copilot CLI +/// fetches from the experimentation service. Property names serialize as +/// PascalCase (Features, Flights, ...) to match the on-the-wire +/// contract consumed by the runtime. +/// +public sealed class CopilotExpAssignmentResponse +{ + /// Enabled feature names. + [JsonPropertyName("Features")] + public IList Features { get; set; } = new List(); - /// - public override bool Equals([NotNullWhen(true)] object? obj) => obj is ContextTier other && Equals(other); + /// Assigned flights keyed by flight name. + [JsonPropertyName("Flights")] + public IDictionary Flights { get; set; } = new Dictionary(); - /// - public bool Equals(ContextTier other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase); + /// Configuration entries carrying typed parameter values. + [JsonPropertyName("Configs")] + public IList Configs { get; set; } = new List(); - /// - public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value); + /// Opaque parameter-group payload passed through untouched. Optional. + [JsonPropertyName("ParameterGroups")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public JsonNode? ParameterGroups { get; set; } - /// - public override string ToString() => Value; + /// Version of the flighting configuration. Optional. + [JsonPropertyName("FlightingVersion")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public int? FlightingVersion { get; set; } - /// Provides a for serializing instances. - [EditorBrowsable(EditorBrowsableState.Never)] - public sealed class Converter : JsonConverter - { - /// - public override ContextTier Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - new(GeneratedStringEnumJson.ReadValue(ref reader, typeToConvert)); + /// Impression identifier for the assignment. Optional. + [JsonPropertyName("ImpressionId")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? ImpressionId { get; set; } - /// - public override void Write(Utf8JsonWriter writer, ContextTier value, JsonSerializerOptions options) => - GeneratedStringEnumJson.WriteValue(writer, value.Value, typeof(ContextTier)); - } + /// Assignment context string forwarded to CAPI and telemetry. + [JsonPropertyName("AssignmentContext")] + public string AssignmentContext { get; set; } = string.Empty; +} + +/// +/// Configuration for the built-in GitHub MCP server. +/// +public sealed class GitHubMcpToolConfig +{ + /// Enables all GitHub MCP tools. + [JsonPropertyName("enableAllTools")] + public bool? EnableAllTools { get; set; } + + /// Additional GitHub MCP toolsets to enable. + [JsonPropertyName("additionalToolsets")] + public IList? AdditionalToolsets { get; set; } + + /// Additional GitHub MCP tools to enable. + [JsonPropertyName("additionalTools")] + public IList? AdditionalTools { get; set; } + + /// Enables GitHub MCP insiders-mode tools. + [JsonPropertyName("enableInsidersMode")] + public bool? EnableInsidersMode { get; set; } + + /// + /// Disables form deferral for GitHub MCP tools. This only applies to the + /// built-in GitHub MCP server and only has an effect when MCP Apps and + /// form-backed GitHub tools are enabled. + /// + [JsonPropertyName("disableFormDeferral")] + public bool? DisableFormDeferral { get; set; } +} + +/// +/// Controls whether bypass-permissions mode is available in a managed session. +/// +[JsonConverter(typeof(JsonStringEnumConverter))] +public enum DisableBypassPermissionsMode +{ + /// Turn off bypass-permissions mode. + [JsonStringEnumMemberName("disable")] + Disable +} + +/// +/// Permission rules injected as a managed-settings layer at session bootstrap. +/// All fields are optional; omitted fields impose no constraint from this layer. +/// +/// +/// This layer composes restrictively with any server- or device-level managed +/// settings: and rules are unioned across +/// layers, every present list must admit a tool for it to be +/// allowed, and is honored if any +/// layer sets it (deny-wins). +/// +public sealed class ManagedSettingsPermissions +{ + /// + /// When set to "disable", bypass-permissions mode is turned off for the + /// session regardless of other layers. Serialized as + /// disableBypassPermissionsMode. + /// + [JsonPropertyName("disableBypassPermissionsMode")] + public DisableBypassPermissionsMode? DisableBypassPermissionsMode { get; set; } + + /// Tool-permission patterns that are always denied. + [JsonPropertyName("deny")] + public IList? Deny { get; set; } + + /// Tool-permission patterns that require an explicit ask. + [JsonPropertyName("ask")] + public IList? Ask { get; set; } + + /// Tool-permission patterns that are allowed without prompting. + [JsonPropertyName("allow")] + public IList? Allow { get; set; } +} + +/// +/// Managed-settings layer injected at session startup. Currently carries only a +/// object. +/// +/// +/// This layer is startup-only and is not persisted with the session. It must be +/// re-supplied on to remain in +/// effect; omitting it on resume clears the previously injected layer. It can be +/// combined with . Older +/// runtimes may ignore this additive field, so hosts must not rely on injected +/// policy until they ship a compatible runtime. +/// +public sealed class ManagedSettings +{ + /// Permission rules for this managed-settings layer. + [JsonPropertyName("permissions")] + public ManagedSettingsPermissions? Permissions { get; set; } } /// @@ -2475,6 +3142,9 @@ protected SessionConfigBase(SessionConfigBase? other) DefaultAgent = other.DefaultAgent; Agent = other.Agent; DisabledSkills = other.DisabledSkills is not null ? [.. other.DisabledSkills] : null; + DisabledMcpServers = other.DisabledMcpServers is not null ? [.. other.DisabledMcpServers] : null; + EnableCitations = other.EnableCitations; + EnableFileChangeTracking = other.EnableFileChangeTracking; EnableConfigDiscovery = other.EnableConfigDiscovery; SkipEmbeddingRetrieval = other.SkipEmbeddingRetrieval; EmbeddingCacheStorage = other.EmbeddingCacheStorage; @@ -2485,10 +3155,27 @@ protected SessionConfigBase(SessionConfigBase? other) EnableSessionStore = other.EnableSessionStore; EnableSkills = other.EnableSkills; EnableMcpApps = other.EnableMcpApps; + GitHubMcpToolConfig = other.GitHubMcpToolConfig is null + ? null + : new GitHubMcpToolConfig + { + EnableAllTools = other.GitHubMcpToolConfig.EnableAllTools, + AdditionalToolsets = other.GitHubMcpToolConfig.AdditionalToolsets is not null + ? [.. other.GitHubMcpToolConfig.AdditionalToolsets] + : null, + AdditionalTools = other.GitHubMcpToolConfig.AdditionalTools is not null + ? [.. other.GitHubMcpToolConfig.AdditionalTools] + : null, + EnableInsidersMode = other.GitHubMcpToolConfig.EnableInsidersMode, + DisableFormDeferral = other.GitHubMcpToolConfig.DisableFormDeferral, + }; + ExcludedBuiltInAgents = other.ExcludedBuiltInAgents is not null ? [.. other.ExcludedBuiltInAgents] : null; ExcludedTools = other.ExcludedTools is not null ? [.. other.ExcludedTools] : null; Hooks = other.Hooks; InfiniteSessions = other.InfiniteSessions; LargeOutput = other.LargeOutput; + ToolSearch = other.ToolSearch; + Memory = other.Memory; McpServers = other.McpServers is not null ? (other.McpServers is Dictionary dict ? new Dictionary(dict, dict.Comparer) @@ -2501,10 +3188,15 @@ protected SessionConfigBase(SessionConfigBase? other) OnElicitationRequest = other.OnElicitationRequest; OnEvent = other.OnEvent; OnExitPlanModeRequest = other.OnExitPlanModeRequest; + OnMcpAuthRequest = other.OnMcpAuthRequest; OnPermissionRequest = other.OnPermissionRequest; OnUserInputRequest = other.OnUserInputRequest; Provider = other.Provider; + Capi = other.Capi; + Providers = other.Providers is not null ? [.. other.Providers] : null; + Models = other.Models is not null ? [.. other.Models] : null; EnableSessionTelemetry = other.EnableSessionTelemetry; + EnableExperimentalMode = other.EnableExperimentalMode; SkipCustomInstructions = other.SkipCustomInstructions; CustomAgentsLocalOnly = other.CustomAgentsLocalOnly; CoauthorEnabled = other.CoauthorEnabled; @@ -2515,22 +3207,28 @@ protected SessionConfigBase(SessionConfigBase? other) CreateSessionFsProvider = other.CreateSessionFsProvider; GitHubToken = other.GitHubToken; RemoteSession = other.RemoteSession; + ExpAssignments = other.ExpAssignments; + EnableManagedSettings = other.EnableManagedSettings; + ManagedSettings = other.ManagedSettings; #pragma warning disable GHCP001 Canvases = other.Canvases is not null ? [.. other.Canvases] : null; RequestCanvasRenderer = other.RequestCanvasRenderer; RequestExtensions = other.RequestExtensions; ExtensionSdkPath = other.ExtensionSdkPath; ExtensionInfo = other.ExtensionInfo; + CanvasProvider = other.CanvasProvider; CanvasHandler = other.CanvasHandler; #pragma warning restore GHCP001 SkillDirectories = other.SkillDirectories is not null ? [.. other.SkillDirectories] : null; PluginDirectories = other.PluginDirectories is not null ? [.. other.PluginDirectories] : null; InstructionDirectories = other.InstructionDirectories is not null ? [.. other.InstructionDirectories] : null; + SessionLimits = other.SessionLimits; Streaming = other.Streaming; IncludeSubAgentStreamingEvents = other.IncludeSubAgentStreamingEvents; SystemMessage = other.SystemMessage; Tools = other.Tools is not null ? [.. other.Tools] : null; WorkingDirectory = other.WorkingDirectory; + AdditionalDirectories = other.AdditionalDirectories is not null ? [.. other.AdditionalDirectories] : null; } /// Client name to identify the application using the SDK. @@ -2541,7 +3239,7 @@ protected SessionConfigBase(SessionConfigBase? other) /// /// Reasoning effort level for models that support it. - /// Valid values: "low", "medium", "high", "xhigh". + /// Valid values: "low", "medium", "high", "xhigh", "max". /// Only applies to models where capabilities.supports.reasoningEffort is true. /// public string? ReasoningEffort { get; set; } @@ -2564,6 +3262,27 @@ protected SessionConfigBase(SessionConfigBase? other) /// Per-property overrides for model capabilities, deep-merged over runtime defaults. public ModelCapabilitiesOverride? ModelCapabilities { get; set; } + /// + /// Enables native model citations for models that support them. + /// + /// + /// Citations are experimental, off by default, and currently available for Anthropic models. + /// This option may change or be removed while citation support is experimental. + /// + [Experimental(Diagnostics.Experimental)] + public bool? EnableCitations { get; set; } + + /// + /// Opts in to capturing file changes for session rewind and cumulative + /// session diff. + /// + /// + /// On create, capture starts with the first turn. On resume, tracking can be + /// enabled only when the session still has a valid baseline; earlier untracked + /// changes cannot be reconstructed. + /// + public bool? EnableFileChangeTracking { get; set; } + /// /// Override the default configuration directory location. /// When specified, the session will use this directory for storing config and state. @@ -2571,15 +3290,8 @@ protected SessionConfigBase(SessionConfigBase? other) public string? ConfigDirectory { get; set; } /// - /// When , automatically discovers MCP server configurations - /// (e.g. .mcp.json, .vscode/mcp.json) and skill directories from - /// the working directory and merges them with any explicitly provided - /// and , with explicit - /// values taking precedence on name collision. - /// - /// Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) - /// are always loaded from the working directory regardless of this setting. - /// + /// Enables runtime discovery of supported configuration. Explicitly supplied + /// configuration takes precedence over discovered values. /// public bool? EnableConfigDiscovery { get; set; } @@ -2656,9 +3368,39 @@ protected SessionConfigBase(SessionConfigBase? other) /// List of tool names to exclude from the session. public IList? ExcludedTools { get; set; } + /// + /// Built-in subagent names to exclude from this session. + /// + /// + /// Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a + /// custom agent with the same name is available. + /// + [JsonPropertyName("excludedBuiltinAgents")] + public IList? ExcludedBuiltInAgents { get; set; } + /// Custom model provider configuration for the session. public ProviderConfig? Provider { get; set; } + /// + /// CAPI (Copilot API) provider-scoped configuration for the session. + /// + public CapiSessionOptions? Capi { get; set; } + + /// + /// Named BYOK provider connections (transport + credentials). Additive to Copilot + /// API authentication (unlike ); combine with . + /// Cannot be combined with . + /// + [Experimental(Diagnostics.Experimental)] + public IList? Providers { get; set; } + + /// + /// BYOK model definitions added to the session's selectable model list, each + /// referencing a entry by name. + /// + [Experimental(Diagnostics.Experimental)] + public IList? Models { get; set; } + /// /// Enables or disables internal session telemetry for this session. /// When false, disables session telemetry. When null (the default) or true, @@ -2670,6 +3412,15 @@ protected SessionConfigBase(SessionConfigBase? other) /// public bool? EnableSessionTelemetry { get; set; } + /// + /// Controls whether the session enables experimental features. + /// + /// + /// Defaults to in . + /// Otherwise, the runtime decides when left . + /// + public bool? EnableExperimentalMode { get; set; } + /// /// When , suppresses loading of custom instruction files /// (e.g. .github/copilot-instructions.md, AGENTS.md) from the working directory. @@ -2749,12 +3500,25 @@ protected SessionConfigBase(SessionConfigBase? other) [Experimental(Diagnostics.Experimental)] public bool EnableMcpApps { get; set; } + /// + /// Configuration for the built-in GitHub MCP server. + /// DisableFormDeferral only applies to that server and only has an + /// effect when MCP Apps and form-backed GitHub tools are enabled. + /// + public GitHubMcpToolConfig? GitHubMcpToolConfig { get; set; } + /// Hook handlers for session lifecycle events. public SessionHooks? Hooks { get; set; } /// Working directory for the session. public string? WorkingDirectory { get; set; } + /// + /// Additional directories the agent may access beyond . + /// Relative paths resolve against the session working directory. Re-supply them when resuming. + /// + public IList? AdditionalDirectories { get; set; } + /// /// Enable streaming of assistant message and reasoning chunks. /// When true, assistant.message_delta and assistant.reasoning_delta events @@ -2822,12 +3586,29 @@ protected SessionConfigBase(SessionConfigBase? other) /// List of skill names to disable. public IList? DisabledSkills { get; set; } + /// + /// Exact MCP server names to disable for this session. Disabled servers are not + /// started or authenticated on create or cold resume; a resident resume cannot + /// stop servers that are already running. + /// + public IList? DisabledMcpServers { get; set; } + /// /// Infinite session configuration for persistent workspaces and automatic compaction. /// When enabled (default), sessions automatically manage context limits and persist state. /// public InfiniteSessionConfig? InfiniteSessions { get; set; } + /// + /// Optional limits for the session's current accounting window. + /// + /// + /// These settings only model the caller's configured limits. Enforcement and + /// limit-exhaustion behavior are handled by the runtime. + /// + [Experimental(Diagnostics.Experimental)] + public SessionLimitsConfig? SessionLimits { get; set; } + /// /// Configuration for handling large tool outputs. When a tool produces /// output exceeding the configured size, the output is written to a temp @@ -2836,6 +3617,19 @@ protected SessionConfigBase(SessionConfigBase? other) /// public LargeToolOutputConfig? LargeOutput { get; set; } + /// + /// Overrides the runtime's built-in tool-search behavior. + /// Tool search defers tools to keep the model's active tool set small. When , + /// the runtime default applies. + /// + public ToolSearchConfig? ToolSearch { get; set; } + + /// + /// Configuration for session memory. When set, controls whether the + /// session can read and write persistent memory. + /// + public MemoryConfiguration? Memory { get; set; } + /// /// Optional event handler registered on the session before the session.create / session.resume /// RPC is issued, ensuring early events are delivered. @@ -2865,6 +3659,44 @@ protected SessionConfigBase(SessionConfigBase? other) /// public RemoteSessionMode? RemoteSession { get; set; } + /// + /// ExP assignment ("flight") data injected by a trusted integrator, in the + /// same JSON shape the Copilot CLI fetches from the experimentation service + /// (CopilotExpAssignmentResponse). When provided, the runtime feeds it + /// into the same feature-flag path as CLI-fetched assignments and stamps it + /// onto telemetry and the CAPI request header. When unset, the session does + /// not block on ExP. Intended for out-of-process integrators that fetch ExP + /// data themselves; malformed payloads are dropped by the runtime (fail-open). + /// Serialized on the wire as expAssignments. + /// + /// + /// This is an internal/trusted-integrator option and is hidden from editor + /// completion. It is not part of the broadly advertised public surface. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public CopilotExpAssignmentResponse? ExpAssignments { get; set; } + + /// + /// Opt-in: when true, the runtime self-fetches enterprise managed + /// settings (bypass-permissions policy) at session bootstrap using the + /// session's . Requires to + /// be set; if omitted, the runtime is expected to reject session creation + /// (fail-closed). When unset, behaves exactly as before. Serialized on the + /// wire as enableManagedSettings. + /// + public bool? EnableManagedSettings { get; set; } + + /// + /// Optional managed-settings layer injected at session bootstrap. Currently + /// carries a permissions object that composes restrictively with any + /// server- or device-level managed settings. This layer is startup-only and + /// is not persisted: it must be re-supplied on resume to remain in effect, + /// and omitting it on resume clears the previously injected layer. Can be + /// combined with . Serialized on the wire + /// as managedSettings. + /// + public ManagedSettings? ManagedSettings { get; set; } + #pragma warning disable GHCP001 /// /// Canvas declarations advertised by this connection. The runtime forwards @@ -2906,6 +3738,16 @@ protected SessionConfigBase(SessionConfigBase? other) [Experimental(Diagnostics.Experimental)] public ExtensionInfo? ExtensionInfo { get; set; } + /// + /// Stable identity for a host/SDK connection that supplies built-in + /// canvases. When set, the runtime uses + /// verbatim as the agent-facing canvas extension id, so canvases declared on + /// a control connection survive reconnect and CLI restart. Honored on + /// session create and resume. + /// + [Experimental(Diagnostics.Experimental)] + public CanvasProviderIdentity? CanvasProvider { get; set; } + /// /// Provider-side canvas lifecycle handler. The SDK routes inbound /// canvas.open / canvas.close / canvas.action.invoke @@ -2915,6 +3757,14 @@ protected SessionConfigBase(SessionConfigBase? other) [JsonIgnore] public ICanvasHandler? CanvasHandler { get; set; } #pragma warning restore GHCP001 + + /// + /// Optional handler for MCP OAuth requests from MCP servers. + /// When provided, the SDK can satisfy MCP server OAuth requests with host-provided token data or cancellation. + /// + [Experimental(Diagnostics.Experimental)] + [JsonIgnore] + public Func>? OnMcpAuthRequest { get; set; } } /// @@ -3058,7 +3908,7 @@ private MessageOptions(MessageOptions? other) /// /// File or data attachments to include with the message. /// - public IList? Attachments { get; set; } + public IList? Attachments { get; set; } /// /// How to deliver the message. "enqueue" (default) appends to the message queue; /// "immediate" interjects during an in-progress turn. @@ -3339,6 +4189,12 @@ public sealed class ModelBilling /// [JsonPropertyName("multiplier")] public double? Multiplier { get; set; } + + /// + /// Token-level pricing information for this model. + /// + [JsonPropertyName("tokenPrices")] + public ModelBillingTokenPrices? TokenPrices { get; set; } } /// @@ -3531,6 +4387,8 @@ public sealed class SystemMessageTransformRpcResponse [JsonSerializable(typeof(AutoModeSwitchRequest))] [JsonSerializable(typeof(AutoModeSwitchResponse))] [JsonSerializable(typeof(CustomAgentConfig))] +[JsonSerializable(typeof(CopilotExpAssignmentResponse))] +[JsonSerializable(typeof(ExpConfigEntry))] [JsonSerializable(typeof(ExitPlanModeRequest))] [JsonSerializable(typeof(ExitPlanModeResult))] [JsonSerializable(typeof(GetAuthStatusResponse))] @@ -3540,6 +4398,8 @@ public sealed class SystemMessageTransformRpcResponse [JsonSerializable(typeof(McpServerConfig))] [JsonSerializable(typeof(MessageOptions))] [JsonSerializable(typeof(ModelBilling))] +[JsonSerializable(typeof(GitHub.Copilot.Rpc.ModelBillingTokenPrices))] +[JsonSerializable(typeof(GitHub.Copilot.Rpc.ModelBillingTokenPricesLongContext))] [JsonSerializable(typeof(ModelCapabilities))] [JsonSerializable(typeof(ModelCapabilitiesOverride))] [JsonSerializable(typeof(ModelInfo))] @@ -3550,6 +4410,7 @@ public sealed class SystemMessageTransformRpcResponse [JsonSerializable(typeof(PingRequest))] [JsonSerializable(typeof(PingResponse))] [JsonSerializable(typeof(ProviderConfig))] +[JsonSerializable(typeof(CapiSessionOptions))] [JsonSerializable(typeof(SessionContext))] [JsonSerializable(typeof(SessionLifecycleEvent))] [JsonSerializable(typeof(SessionLifecycleEventMetadata))] @@ -3573,5 +4434,6 @@ public sealed class SystemMessageTransformRpcResponse [JsonSerializable(typeof(CanvasProviderOpenResult))] [JsonSerializable(typeof(CanvasHostContext))] [JsonSerializable(typeof(ExtensionInfo))] +[JsonSerializable(typeof(CanvasProviderIdentity))] #pragma warning restore GHCP001 internal partial class TypesJsonContext : JsonSerializerContext; diff --git a/dotnet/src/UnixMillisecondsDateTimeOffsetConverter.cs b/dotnet/src/UnixMillisecondsDateTimeOffsetConverter.cs index 4b8fcc361..8e176fbaf 100644 --- a/dotnet/src/UnixMillisecondsDateTimeOffsetConverter.cs +++ b/dotnet/src/UnixMillisecondsDateTimeOffsetConverter.cs @@ -13,8 +13,14 @@ namespace GitHub.Copilot; public sealed class UnixMillisecondsDateTimeOffsetConverter : JsonConverter { /// - public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - DateTimeOffset.FromUnixTimeMilliseconds(reader.GetInt64()); + public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + // The CLI may serialize the epoch-millisecond timestamp as a JSON integer + // or as a floating-point number (e.g. 1700000000000.0). GetInt64 throws on a + // fractional token, so fall back to reading a double and truncating. + long milliseconds = reader.TryGetInt64(out long value) ? value : (long)reader.GetDouble(); + return DateTimeOffset.FromUnixTimeMilliseconds(milliseconds); + } /// public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options) => diff --git a/dotnet/src/build/GitHub.Copilot.SDK.targets b/dotnet/src/build/GitHub.Copilot.SDK.targets index 94b6515ea..5f7944b2c 100644 --- a/dotnet/src/build/GitHub.Copilot.SDK.targets +++ b/dotnet/src/build/GitHub.Copilot.SDK.targets @@ -9,6 +9,7 @@ <_CopilotOs Condition="'$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('win'))">win <_CopilotOs Condition="'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('osx'))">osx <_CopilotOs Condition="'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('maccatalyst'))">osx + <_CopilotOs Condition="'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('linux-musl'))">linux-musl <_CopilotOs Condition="'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != ''">linux @@ -22,7 +23,7 @@ - + @@ -31,10 +32,19 @@ <_CopilotPlatform Condition="'$(_CopilotRid)' == 'win-arm64'">win32-arm64 <_CopilotPlatform Condition="'$(_CopilotRid)' == 'linux-x64'">linux-x64 <_CopilotPlatform Condition="'$(_CopilotRid)' == 'linux-arm64'">linux-arm64 + <_CopilotPlatform Condition="'$(_CopilotRid)' == 'linux-musl-x64'">linuxmusl-x64 + <_CopilotPlatform Condition="'$(_CopilotRid)' == 'linux-musl-arm64'">linuxmusl-arm64 <_CopilotPlatform Condition="'$(_CopilotRid)' == 'osx-x64'">darwin-x64 <_CopilotPlatform Condition="'$(_CopilotRid)' == 'osx-arm64'">darwin-arm64 <_CopilotBinary Condition="$(_CopilotRid.StartsWith('win-'))">copilot.exe <_CopilotBinary Condition="'$(_CopilotBinary)' == ''">copilot + + <_CopilotRuntimeLib Condition="$(_CopilotRid.StartsWith('win-'))">copilot_runtime.dll + <_CopilotRuntimeLib Condition="$(_CopilotRid.StartsWith('osx-'))">libcopilot_runtime.dylib + <_CopilotRuntimeLib Condition="'$(_CopilotRuntimeLib)' == ''">libcopilot_runtime.so + <_CopilotRuntimeNodePath>$(_CopilotCacheDir)\prebuilds\$(_CopilotPlatform)\runtime.node + + diff --git a/dotnet/test/AssemblyInfo.cs b/dotnet/test/AssemblyInfo.cs index e34f0e255..6f5f258a9 100644 --- a/dotnet/test/AssemblyInfo.cs +++ b/dotnet/test/AssemblyInfo.cs @@ -3,8 +3,9 @@ *--------------------------------------------------------------------------------------------*/ using Xunit; +using GitHub.Copilot.Test.Harness; -// Each E2E test class fixture spins up its own Copilot CLI subprocess plus a CapiProxy +// Each E2E test class fixture spins up its own Copilot CLI subprocess plus a ReplayProxy // (replaying HTTP proxy) Node.js subprocess. With ~25 test classes, running them in parallel // would launch ~50 long-lived Node.js processes simultaneously and exhaust both file // descriptors and memory on developer machines and CI runners (especially Windows). Tests @@ -13,3 +14,5 @@ // (a) sharing a single CLI subprocess across classes, or (b) gating concurrency with a // semaphore that limits concurrent fixtures to a small number (e.g. 2-3). [assembly: CollectionBehavior(DisableTestParallelization = true)] + +[assembly: InProcessEnvIsolation] diff --git a/dotnet/test/ConnectionTokenTests.cs b/dotnet/test/ConnectionTokenTests.cs index 524ff2586..3192bada6 100644 --- a/dotnet/test/ConnectionTokenTests.cs +++ b/dotnet/test/ConnectionTokenTests.cs @@ -113,7 +113,7 @@ public class ConnectionTokenAutoGeneratedTests : IAsyncLifetime public async Task InitializeAsync() { _ctx = await E2ETestContext.CreateAsync(); - _client = _ctx.CreateClient(useStdio: false); + _client = _ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForTcp() }); } public async Task DisposeAsync() diff --git a/dotnet/test/E2E/AskUserE2ETests.cs b/dotnet/test/E2E/AskUserE2ETests.cs index db1a4dd92..e08ba10cb 100644 --- a/dotnet/test/E2E/AskUserE2ETests.cs +++ b/dotnet/test/E2E/AskUserE2ETests.cs @@ -30,13 +30,11 @@ public async Task Should_Invoke_User_Input_Handler_When_Model_Uses_Ask_User_Tool } }); - await session.SendAsync(new MessageOptions + await session.SendAndWaitAsync(new MessageOptions { Prompt = "Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before continuing." }); - await TestHelper.GetFinalAssistantMessageAsync(session); - // Should have received at least one user input request Assert.NotEmpty(userInputRequests); @@ -62,13 +60,11 @@ public async Task Should_Receive_Choices_In_User_Input_Request() } }); - await session.SendAsync(new MessageOptions + await session.SendAndWaitAsync(new MessageOptions { 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." }); - await TestHelper.GetFinalAssistantMessageAsync(session); - // Should have received a request Assert.NotEmpty(userInputRequests); diff --git a/dotnet/test/E2E/BuiltinToolsE2ETests.cs b/dotnet/test/E2E/BuiltinToolsE2ETests.cs index 863331e9d..5fc031417 100644 --- a/dotnet/test/E2E/BuiltinToolsE2ETests.cs +++ b/dotnet/test/E2E/BuiltinToolsE2ETests.cs @@ -16,6 +16,12 @@ namespace GitHub.Copilot.Test.E2E; public class BuiltinToolsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "builtin_tools", output) { + // Built-in tool tests spawn a real CLI subprocess and execute actual shell / + // file tools. Under slow/concurrent CI (notably Windows) this agent loop can + // briefly exceed the 60s SendAndWaitAsync default, so give it extra headroom + // while still failing fast on a genuine hang. + private static readonly TimeSpan SendTimeout = TimeSpan.FromSeconds(120); + [Fact] public async Task Should_Capture_Exit_Code_In_Output() { @@ -23,7 +29,7 @@ public async Task Should_Capture_Exit_Code_In_Output() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Run 'echo hello && echo world'. Tell me the exact output.", - }); + }, SendTimeout); var content = msg?.Data.Content ?? string.Empty; Assert.Contains("hello", content); Assert.Contains("world", content); @@ -43,8 +49,8 @@ public async Task Should_Capture_Stderr_Output() var session = await CreateSessionAsync(); var msg = await session.SendAndWaitAsync(new MessageOptions { - Prompt = "Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.", - }); + Prompt = "Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. Reply with just the stderr content.", + }, SendTimeout); Assert.Contains("error_msg", msg?.Data.Content ?? string.Empty); } @@ -56,7 +62,7 @@ public async Task Should_Read_File_With_Line_Range() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.", - }); + }, SendTimeout); var content = msg?.Data.Content ?? string.Empty; Assert.Contains("line2", content); Assert.Contains("line4", content); @@ -69,7 +75,7 @@ public async Task Should_Handle_Nonexistent_File_Gracefully() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.", - }); + }, SendTimeout); var content = (msg?.Data.Content ?? string.Empty).ToUpperInvariant(); // Match any of the common phrasings for a missing-file response. Assert.True( @@ -90,7 +96,7 @@ public async Task Should_Edit_A_File_Successfully() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.", - }); + }, SendTimeout); Assert.Contains("Hi Universe", msg?.Data.Content ?? string.Empty); } @@ -101,7 +107,7 @@ public async Task Should_Create_A_New_File() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.", - }); + }, SendTimeout); Assert.Contains("Created by test", msg?.Data.Content ?? string.Empty); } @@ -113,7 +119,7 @@ public async Task Should_Search_For_Patterns_In_Files() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.", - }); + }, SendTimeout); var content = msg?.Data.Content ?? string.Empty; Assert.Contains("apple", content); Assert.Contains("apricot", content); @@ -130,7 +136,7 @@ public async Task Should_Find_Files_By_Pattern() var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Find all .ts files in this directory (recursively). List the filenames you found.", - }); + }, SendTimeout); Assert.Contains("index.ts", msg?.Data.Content ?? string.Empty); } } diff --git a/dotnet/test/E2E/ByokBearerTokenProviderE2ETests.cs b/dotnet/test/E2E/ByokBearerTokenProviderE2ETests.cs new file mode 100644 index 000000000..4d2cb5e34 --- /dev/null +++ b/dotnet/test/E2E/ByokBearerTokenProviderE2ETests.cs @@ -0,0 +1,292 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Collections.Concurrent; +using System.Net; +using System.Net.Http; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// End-to-end coverage for the experimental BYOK bearer-token-provider surface +/// (BearerTokenProvider on a provider config). The callback stays entirely on +/// the SDK/client side: the SDK strips it from the wire config, sets the +/// hasBearerTokenProvider flag, and the runtime calls back over the +/// session-scoped providerToken.getToken RPC before each outbound model +/// request, applying the returned token as the Authorization header. +/// +/// +/// +/// These tests mirror the Node SDK's byok_bearer_token_provider.e2e.test.ts. +/// Rather than standing up a real HTTP listener, each test installs a +/// that intercepts the runtime's outbound +/// model request in-process, captures the Authorization header, and +/// returns a synthetic response — so nothing touches the network and there is no +/// CAPI proxy acting as the inference endpoint. They validate, against a real +/// runtime: +/// +/// +/// the callback's token reaches the model request as Authorization: Bearer <token>; +/// the runtime re-acquires a token per request (no runtime-side caching); +/// per-provider dispatch routes each provider's turn to its own callback, +/// and the resulting token reaches that provider's endpoint. +/// +/// +[Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] +public class ByokBearerTokenProviderE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "byok_bearer_token_provider", output) +{ + // Fake BYOK provider hosts. These are never actually dialed: the request + // handler fully answers any request aimed at a `.invalid` host, so they only + // need to be syntactically valid, non-resolving URLs. Distinct hosts let the + // per-provider test assert routing by host. + private const string PrimaryHost = "byok-endpoint.invalid"; + private const string PrimaryBaseUrl = $"https://{PrimaryHost}/v1"; + private const string RedHost = "byok-red.invalid"; + private const string RedBaseUrl = $"https://{RedHost}/v1"; + private const string BlueHost = "byok-blue.invalid"; + private const string BlueBaseUrl = $"https://{BlueHost}/v1"; + + private CopilotClient CreateClientWith(CapturingRequestHandler handler) => + Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(), + RequestHandler = handler, + }); + + /// + /// Drives one BYOK turn against the given providers/models. The capturing + /// handler 404s the BYOK request, which errors the turn after the runtime has + /// already applied the (token-bearing) Authorization header — which is + /// all these tests assert on. The resulting error is swallowed. + /// + private static async Task RunTurnAsync( + CopilotClient client, + IList providers, + IList models, + string selectionId, + string prompt) + { + var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + Model = selectionId, + Providers = providers, + Models = models, + }); + try + { + await session.SendAndWaitAsync(new MessageOptions { Prompt = prompt }); + } + catch (InvalidOperationException) + { + // The handler always 404s the BYOK endpoint, so the turn errors after + // the token-bearing request was already captured. Expected. + } + finally + { + await session.DisposeAsync(); + } + } + + [Fact] + public async Task Applies_The_Callbacks_Token_As_The_Authorization_Header() + { + const string sentinel = "sentinel-bearer-token-abc123"; + var calls = 0; + + var handler = new CapturingRequestHandler(); + await using var client = CreateClientWith(handler); + await client.StartAsync(); + + var providers = new List + { + new() + { + Name = "mi", + Type = "openai", + WireApi = "completions", + BaseUrl = PrimaryBaseUrl, + BearerTokenProvider = _ => + { + Interlocked.Increment(ref calls); + return Task.FromResult(sentinel); + }, + }, + }; + var models = new List + { + new() { Id = "default", Provider = "mi", WireModel = "byok-gpt-4o" }, + }; + + await RunTurnAsync(client, providers, models, "mi/default", "What is 5+5?"); + + // The runtime acquired a token via the callback and applied it verbatim as + // the bearer credential on the outbound model request. + Assert.Contains($"Bearer {sentinel}", handler.AuthHeaders()); + Assert.True(calls >= 1, "Expected the bearer-token callback to be invoked at least once."); + } + + [Fact] + public async Task Re_Acquires_A_Fresh_Token_For_Each_Request() + { + var calls = 0; + + var handler = new CapturingRequestHandler(); + await using var client = CreateClientWith(handler); + await client.StartAsync(); + + var providers = new List + { + new() + { + Name = "mi", + Type = "openai", + WireApi = "completions", + BaseUrl = PrimaryBaseUrl, + // A distinct token per acquisition proves the runtime re-invokes + // the callback per request rather than caching a previous token. + BearerTokenProvider = _ => + { + var n = Interlocked.Increment(ref calls); + return Task.FromResult($"rotating-token-{n}"); + }, + }, + }; + var models = new List + { + new() { Id = "default", Provider = "mi", WireModel = "byok-gpt-4o" }, + }; + + await RunTurnAsync(client, providers, models, "mi/default", "What is 1+1?"); + await RunTurnAsync(client, providers, models, "mi/default", "What is 2+2?"); + + // Each outbound request carries a freshly-acquired, distinct token. + var auths = handler.AuthHeaders(); + Assert.True(auths.Count >= 2, $"Expected at least 2 captured Authorization headers, saw {auths.Count}."); + Assert.Matches(@"^Bearer rotating-token-\d+$", auths[0]); + Assert.Matches(@"^Bearer rotating-token-\d+$", auths[1]); + Assert.NotEqual(auths[0], auths[1]); + Assert.True(calls >= 2, "Expected the bearer-token callback to be invoked at least twice."); + } + + [Fact] + public async Task Dispatches_Token_Acquisition_Per_Provider() + { + var tokenByProvider = new Dictionary + { + ["red"] = "token-for-red", + ["blue"] = "token-for-blue", + }; + var acquiredFor = new ConcurrentBag(); + + Func> MakeCallback(string providerName) => + args => + { + // The runtime forwards the requesting provider's name so the client + // can dispatch to the right credential. + Assert.Equal(providerName, args.ProviderName); + // The runtime also forwards the owning session id so a + // client-level shared callback can resolve the session. + Assert.False(string.IsNullOrEmpty(args.SessionId)); + acquiredFor.Add(providerName); + return Task.FromResult(tokenByProvider[providerName]); + }; + + var handler = new CapturingRequestHandler(); + await using var client = CreateClientWith(handler); + await client.StartAsync(); + + var providers = new List + { + new() + { + Name = "red", + Type = "openai", + WireApi = "completions", + BaseUrl = RedBaseUrl, + BearerTokenProvider = MakeCallback("red"), + }, + new() + { + Name = "blue", + Type = "openai", + WireApi = "completions", + BaseUrl = BlueBaseUrl, + BearerTokenProvider = MakeCallback("blue"), + }, + }; + var models = new List + { + new() { Id = "default", Provider = "red", WireModel = "byok-gpt-4o" }, + new() { Id = "default", Provider = "blue", WireModel = "byok-gpt-4o" }, + }; + + await RunTurnAsync(client, providers, models, "red/default", "What is 3+3?"); + await RunTurnAsync(client, providers, models, "blue/default", "What is 4+4?"); + + // Each provider's turn was authenticated with its own token AND that token + // was delivered to that provider's endpoint, proving per-provider dispatch + // (not a single session-global credential). + Assert.Equal($"Bearer {tokenByProvider["red"]}", handler.AuthHeaderForHost(RedHost)); + Assert.Equal($"Bearer {tokenByProvider["blue"]}", handler.AuthHeaderForHost(BlueHost)); + Assert.Contains("red", acquiredFor); + Assert.Contains("blue", acquiredFor); + } +} + +/// +/// A used in place of a real HTTP listener. +/// The runtime invokes for every model-layer HTTP +/// request. Requests aimed at a fake BYOK host (*.invalid) are captured — +/// recording the Authorization header the runtime applied after calling +/// the provider's BearerTokenProvider callback over the session-scoped +/// providerToken.getToken RPC — and answered with a synthetic 404 +/// (a non-retryable status, so each outbound model request yields exactly one +/// capture). Every other request (CAPI bootstrap: model catalog, policy, …) is +/// served a synthetic well-formed response so the bootstrap never touches the +/// network. +/// +internal sealed class CapturingRequestHandler : CopilotRequestHandler +{ + private readonly ConcurrentQueue _captures = new(); + + protected override Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + var uri = request.RequestUri!; + if (uri.Host.EndsWith(".invalid", StringComparison.Ordinal)) + { + _captures.Enqueue(new CapturedRequest( + uri.Host, + request.Headers.TryGetValues("Authorization", out var values) + ? string.Join(", ", values) + : null)); + + var response = new HttpResponseMessage(HttpStatusCode.NotFound) + { + Content = new StringContent( + "{\"error\":{\"message\":\"fake byok endpoint\"}}", + System.Text.Encoding.UTF8, + "application/json"), + }; + return Task.FromResult(response); + } + + // CAPI bootstrap (model catalog, policy, …) — answered off-network. + return Task.FromResult(RecordingRequestHandler.BuildNonInferenceResponse(uri.ToString())); + } + + /// The Authorization headers captured across BYOK requests, in arrival order. + public IReadOnlyList AuthHeaders() => + [.. _captures.Select(c => c.Authorization).Where(v => v is not null).Cast()]; + + /// The Authorization header captured for requests aimed at , if any. + public string? AuthHeaderForHost(string host) => + _captures.FirstOrDefault(c => string.Equals(c.Host, host, StringComparison.Ordinal))?.Authorization; + + private sealed record CapturedRequest(string Host, string? Authorization); +} diff --git a/dotnet/test/E2E/ClientE2ETests.cs b/dotnet/test/E2E/ClientE2ETests.cs index 9972e3b33..b6bdfd90f 100644 --- a/dotnet/test/E2E/ClientE2ETests.cs +++ b/dotnet/test/E2E/ClientE2ETests.cs @@ -9,8 +9,13 @@ namespace GitHub.Copilot.Test.E2E; // These tests bypass E2ETestBase because they are about how the CLI subprocess is started // Other test classes should instead inherit from E2ETestBase -public class ClientE2ETests +public class ClientE2ETests(E2ETestFixture fixture) : IClassFixture { + private const string FailingCliScript = + "process.stderr.write('nonexistent test flag on stderr\\n'); process.exit(1);"; + + private E2ETestContext Ctx => fixture.Ctx; + [Theory] [InlineData(true)] // stdio transport [InlineData(false)] // TCP transport @@ -33,6 +38,32 @@ public async Task Should_Start_And_Connect_To_Server(bool useStdio) } } + [Fact] + public async Task Should_Start_And_Connect_Over_InProcess_Ffi() + { + // In-process FFI hosting resolves the CLI entrypoint (COPILOT_CLI_PATH or the + // bundled CLI binary) and its sibling native runtime library itself; if neither + // is available, StartAsync throws and the test fails hard. + using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForInProcess(), + }); + + try + { + await client.StartAsync(); + var pong = await client.PingAsync("ffi message"); + Assert.Equal("pong: ffi message", pong.Message); + Assert.NotEqual(default, pong.Timestamp); + + await client.StopAsync(); + } + finally + { + await client.ForceStopAsync(); + } + } + [Theory] [InlineData(true)] // stdio transport [InlineData(false)] // TCP transport @@ -40,7 +71,7 @@ public async Task Should_Force_Stop_Without_Cleanup(bool useStdio) { using var client = new CopilotClient(new CopilotClientOptions { Connection = useStdio ? RuntimeConnection.ForStdio() : RuntimeConnection.ForTcp() }); - await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); await client.ForceStopAsync(); } @@ -139,7 +170,7 @@ public async Task Should_List_Models_When_Authenticated(bool useStdio) public async Task Should_Not_Throw_When_Disposing_Session_After_Stopping_Client(bool useStdio) { await using var client = new CopilotClient(new CopilotClientOptions { Connection = useStdio ? RuntimeConnection.ForStdio() : RuntimeConnection.ForTcp() }); - await using var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); await client.StopAsync(); } @@ -149,11 +180,14 @@ public async Task Should_Not_Throw_When_Disposing_Session_After_Stopping_Client( [InlineData(false)] // TCP transport public async Task Should_Report_Error_With_Stderr_When_CLI_Fails_To_Start(bool useStdio) { + var cliPath = Path.Join(Ctx.WorkDir, $"failing-cli-{Guid.NewGuid():N}.js"); + await File.WriteAllTextAsync(cliPath, FailingCliScript); + var client = new CopilotClient(new CopilotClientOptions { Connection = useStdio - ? RuntimeConnection.ForStdio(args: ["--nonexistent-flag-for-testing"]) - : RuntimeConnection.ForTcp(args: ["--nonexistent-flag-for-testing"]) + ? RuntimeConnection.ForStdio(path: cliPath) + : RuntimeConnection.ForTcp(path: cliPath) }); var ex = await Assert.ThrowsAsync(() => client.StartAsync()); @@ -175,7 +209,7 @@ public async Task Should_Report_Error_With_Stderr_When_CLI_Fails_To_Start(bool u // Verify subsequent calls also fail (don't hang) var ex2 = await Assert.ThrowsAnyAsync(async () => { - var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); await session.SendAsync(new MessageOptions { Prompt = "test" }); }); Assert.True( @@ -193,7 +227,7 @@ public async Task Should_Report_Error_With_Stderr_When_CLI_Fails_To_Start(bool u public async Task Should_Allow_CreateSession_Called_Without_PermissionHandler(bool useStdio) { await using var client = new CopilotClient(new CopilotClientOptions { Connection = useStdio ? RuntimeConnection.ForStdio() : RuntimeConnection.ForTcp() }); - await using var session = await client.CreateSessionAsync(new SessionConfig()); + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig()); Assert.NotNull(session.SessionId); } @@ -208,7 +242,7 @@ public async Task Should_Allow_ResumeSession_Called_Without_PermissionHandler() { Connection = RuntimeConnection.ForTcp(connectionToken: connectionToken), }); - await using var originalSession = await client.CreateSessionAsync(new SessionConfig()); + await using var originalSession = await ctx.CreateSessionAsync(client, new SessionConfig()); var port = client.RuntimePort ?? throw new InvalidOperationException("Client must be using TCP transport to support multi-client resume."); @@ -217,7 +251,7 @@ public async Task Should_Allow_ResumeSession_Called_Without_PermissionHandler() { Connection = RuntimeConnection.ForUri($"localhost:{port}", connectionToken: connectionToken), }); - await using var resumedSession = await resumeClient.ResumeSessionAsync(originalSession.SessionId, new()); + await using var resumedSession = await ctx.ResumeSessionAsync(resumeClient, originalSession.SessionId, new()); Assert.Equal(originalSession.SessionId, resumedSession.SessionId); } diff --git a/dotnet/test/E2E/ClientOptionsE2ETests.cs b/dotnet/test/E2E/ClientOptionsE2ETests.cs index 6360cb55a..5391e4bdb 100644 --- a/dotnet/test/E2E/ClientOptionsE2ETests.cs +++ b/dotnet/test/E2E/ClientOptionsE2ETests.cs @@ -7,6 +7,7 @@ using System.Net; using System.Net.Sockets; using System.Text.Json; +using GitHub.Copilot.Test.Harness; using Xunit; using Xunit.Abstractions; @@ -41,7 +42,7 @@ public async Task Should_Use_Client_Cwd_For_Default_WorkingDirectory() WorkingDirectory = clientCwd, }); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -71,20 +72,20 @@ public async Task Should_Propagate_Process_Options_To_Spawned_Cli() { Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), BaseDirectory = copilotHomeFromOption, - Environment = clientEnv, GitHubToken = "process-option-token", LogLevel = CopilotLogLevel.Debug, SessionIdleTimeoutSeconds = 17, Telemetry = new TelemetryConfig { OtlpEndpoint = "http://127.0.0.1:4318", + OtlpProtocol = "http/protobuf", FilePath = telemetryPath, ExporterType = "file", SourceName = "dotnet-sdk-e2e", CaptureContent = true, }, UseLoggedInUser = false, - }); + }, environment: clientEnv); await client.StartAsync(); @@ -104,12 +105,13 @@ public async Task Should_Propagate_Process_Options_To_Spawned_Cli() Assert.Equal("process-option-token", capturedEnv.GetProperty("COPILOT_SDK_AUTH_TOKEN").GetString()); Assert.Equal("true", capturedEnv.GetProperty("COPILOT_OTEL_ENABLED").GetString()); Assert.Equal("http://127.0.0.1:4318", capturedEnv.GetProperty("OTEL_EXPORTER_OTLP_ENDPOINT").GetString()); + Assert.Equal("http/protobuf", capturedEnv.GetProperty("OTEL_EXPORTER_OTLP_PROTOCOL").GetString()); Assert.Equal(telemetryPath, capturedEnv.GetProperty("COPILOT_OTEL_FILE_EXPORTER_PATH").GetString()); Assert.Equal("file", capturedEnv.GetProperty("COPILOT_OTEL_EXPORTER_TYPE").GetString()); Assert.Equal("dotnet-sdk-e2e", capturedEnv.GetProperty("COPILOT_OTEL_SOURCE_NAME").GetString()); Assert.Equal("true", capturedEnv.GetProperty("OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT").GetString()); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, IncludeSubAgentStreamingEvents = false, @@ -138,7 +140,7 @@ public async Task Should_Forward_EnableSessionTelemetry_In_Wire_Request() await client.StartAsync(); // When explicitly set to false, it should appear in the wire request - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableSessionTelemetry = false, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -165,7 +167,7 @@ public async Task Should_Omit_EnableSessionTelemetry_When_Not_Set() await client.StartAsync(); // When omitted (null/default), the field should not be present in the wire request - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -178,7 +180,7 @@ public async Task Should_Omit_EnableSessionTelemetry_When_Not_Set() } [Fact] - public async Task Should_Forward_Granular_Multitenancy_Fields_In_Create_Wire_Request() + public async Task Should_Forward_CustomAgentsLocalOnly_In_Create_Wire_Request() { var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); @@ -191,6 +193,65 @@ public async Task Should_Forward_Granular_Multitenancy_Fields_In_Create_Wire_Req await client.StartAsync(); var session = await client.CreateSessionAsync(new SessionConfig + { + CustomAgentsLocalOnly = false, + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath)); + var createRequest = GetCapturedRequestParams(capture.RootElement, "session.create"); + Assert.False(createRequest.GetProperty("customAgentsLocalOnly").GetBoolean()); + + await session.DisposeAsync(); + } + + [Fact] + public async Task Should_Forward_CustomAgentsLocalOnly_In_Resume_Wire_Request() + { + var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), + UseLoggedInUser = false, + }); + + await client.StartAsync(); + + var createSession = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + var sessionId = createSession.SessionId; + await createSession.DisposeAsync(); + + var resumeSession = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig + { + CustomAgentsLocalOnly = false, + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath)); + var resumeRequest = GetCapturedRequestParams(capture.RootElement, "session.resume"); + Assert.False(resumeRequest.GetProperty("customAgentsLocalOnly").GetBoolean()); + + await resumeSession.DisposeAsync(); + } + + [Fact] + public async Task Should_Forward_Granular_Multitenancy_Fields_In_Create_Wire_Request() + { + var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), + UseLoggedInUser = false, + }); + + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { SkipEmbeddingRetrieval = false, OrganizationCustomInstructions = "Follow org policy.", @@ -217,6 +278,207 @@ public async Task Should_Forward_Granular_Multitenancy_Fields_In_Create_Wire_Req await session.DisposeAsync(); } + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Should_Forward_Advanced_Session_Options_In_Create_Wire_Request() + { + var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); + var outputDirectory = Path.Join(Ctx.WorkDir, "large-output-create"); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), + UseLoggedInUser = false, + }); + + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + ClientName = "advanced-create-client", + Model = "claude-sonnet-4.5", + ReasoningEffort = "medium", + ReasoningSummary = ReasoningSummary.Detailed, + ContextTier = ContextTier.LongContext, + EnableCitations = true, + Capi = new CapiSessionOptions { EnableWebSocketResponses = false }, + McpOAuthTokenStorage = McpOAuthTokenStorageMode.Persistent, + CustomAgents = + [ + new CustomAgentConfig + { + Name = "agent-one", + DisplayName = "Agent One", + Description = "Handles agent-one tasks.", + Prompt = "Be agent one.", + Tools = ["view"], + Infer = true, + Skills = ["create-skill"], + Model = "claude-haiku-4.5", + }, + ], + DefaultAgent = new DefaultAgentConfig { ExcludedTools = ["edit"] }, + Agent = "agent-one", + SkillDirectories = ["skills-create"], + DisabledSkills = ["disabled-create-skill"], + PluginDirectories = ["plugins-create"], + InfiniteSessions = new InfiniteSessionConfig + { + Enabled = false, + BackgroundCompactionThreshold = 0.5, + BufferExhaustionThreshold = 0.9, + }, + LargeOutput = new LargeToolOutputConfig + { + Enabled = true, + MaxSizeBytes = 4096, + OutputDirectory = outputDirectory, + }, + Memory = new MemoryConfiguration { Enabled = true }, + GitHubToken = "session-create-token", + RemoteSession = GitHub.Copilot.Rpc.RemoteSessionMode.Export, + Cloud = new CloudSessionOptions + { + Repository = new CloudSessionRepository + { + Owner = "github", + Name = "copilot-sdk", + Branch = "main", + }, + }, + EnableMcpApps = true, + RequestCanvasRenderer = true, + RequestExtensions = true, + ExtensionSdkPath = "custom-extension-sdk", + ExtensionInfo = new ExtensionInfo { Source = "dotnet-sdk-tests", Name = "advanced-create-extension" }, + Canvases = + [ + new CanvasDeclaration + { + Id = "advanced-create-canvas", + DisplayName = "Advanced Create Canvas", + Description = "Covers create-time canvas options.", + }, + ], + Providers = + [ + new NamedProviderConfig + { + Name = "create-provider", + Type = "openai", + WireApi = "responses", + BaseUrl = "https://create-provider.example.test/v1", + ApiKey = "create-provider-key", + Headers = new Dictionary { ["X-Create-Provider"] = "yes" }, + }, + ], + Models = + [ + new ProviderModelConfig + { + Provider = "create-provider", + Id = "create-model", + Name = "Create Model", + ModelId = "claude-sonnet-4.5", + WireModel = "create-wire-model", + MaxContextWindowTokens = 12_000, + MaxPromptTokens = 10_000, + MaxOutputTokens = 2_000, + }, + ], + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath)); + var createRequest = GetCapturedRequestParams(capture.RootElement, "session.create"); + Assert.Equal("advanced-create-client", createRequest.GetProperty("clientName").GetString()); + Assert.Equal("claude-sonnet-4.5", createRequest.GetProperty("model").GetString()); + Assert.Equal("medium", createRequest.GetProperty("reasoningEffort").GetString()); + Assert.Equal("detailed", createRequest.GetProperty("reasoningSummary").GetString()); + Assert.Equal("long_context", createRequest.GetProperty("contextTier").GetString()); + Assert.True(createRequest.GetProperty("enableCitations").GetBoolean()); + Assert.False(createRequest.GetProperty("capi").GetProperty("enableWebSocketResponses").GetBoolean()); + Assert.Equal("persistent", createRequest.GetProperty("mcpOAuthTokenStorage").GetString()); + Assert.Equal("agent-one", createRequest.GetProperty("agent").GetString()); + Assert.Equal("edit", createRequest.GetProperty("defaultAgent").GetProperty("excludedTools")[0].GetString()); + Assert.Equal("agent-one", createRequest.GetProperty("customAgents")[0].GetProperty("name").GetString()); + Assert.Equal("plugins-create", createRequest.GetProperty("pluginDirectories")[0].GetString()); + Assert.Equal("disabled-create-skill", createRequest.GetProperty("disabledSkills")[0].GetString()); + Assert.False(createRequest.GetProperty("infiniteSessions").GetProperty("enabled").GetBoolean()); + Assert.True(createRequest.GetProperty("largeOutput").GetProperty("enabled").GetBoolean()); + Assert.Equal(4096, createRequest.GetProperty("largeOutput").GetProperty("maxSizeBytes").GetInt64()); + Assert.Equal(outputDirectory, createRequest.GetProperty("largeOutput").GetProperty("outputDir").GetString()); + Assert.True(createRequest.GetProperty("memory").GetProperty("enabled").GetBoolean()); + Assert.Equal("session-create-token", createRequest.GetProperty("gitHubToken").GetString()); + Assert.Equal("export", createRequest.GetProperty("remoteSession").GetString()); + Assert.Equal("github", createRequest.GetProperty("cloud").GetProperty("repository").GetProperty("owner").GetString()); + Assert.True(createRequest.GetProperty("requestMcpApps").GetBoolean()); + Assert.True(createRequest.GetProperty("requestCanvasRenderer").GetBoolean()); + Assert.True(createRequest.GetProperty("requestExtensions").GetBoolean()); + Assert.Equal("custom-extension-sdk", createRequest.GetProperty("extensionSdkPath").GetString()); + Assert.Equal("advanced-create-extension", createRequest.GetProperty("extensionInfo").GetProperty("name").GetString()); + Assert.Equal("advanced-create-canvas", createRequest.GetProperty("canvases")[0].GetProperty("id").GetString()); + Assert.Equal("create-provider", createRequest.GetProperty("providers")[0].GetProperty("name").GetString()); + Assert.Equal("responses", createRequest.GetProperty("providers")[0].GetProperty("wireApi").GetString()); + Assert.Equal("create-model", createRequest.GetProperty("models")[0].GetProperty("id").GetString()); + Assert.Equal(12000, createRequest.GetProperty("models")[0].GetProperty("maxContextWindowTokens").GetInt32()); + + await session.DisposeAsync(); + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Should_Forward_Singular_Provider_Options_In_Create_Wire_Request() + { + var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), + UseLoggedInUser = false, + }); + + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + Model = "claude-sonnet-4.5", + Provider = new ProviderConfig + { + Type = "azure", + WireApi = "responses", + Transport = "http", + BaseUrl = "https://azure-provider.example.test/openai", + ApiKey = "provider-api-key", + BearerToken = "provider-bearer-token", + Azure = new AzureOptions { ApiVersion = "2024-02-15-preview" }, + Headers = new Dictionary { ["X-Provider-Wire"] = "yes" }, + ModelId = "claude-sonnet-4.5", + WireModel = "azure-deployment", + MaxPromptTokens = 8192, + MaxOutputTokens = 1024, + }, + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath)); + var provider = GetCapturedRequestParams(capture.RootElement, "session.create").GetProperty("provider"); + Assert.Equal("azure", provider.GetProperty("type").GetString()); + Assert.Equal("responses", provider.GetProperty("wireApi").GetString()); + Assert.Equal("http", provider.GetProperty("transport").GetString()); + Assert.Equal("https://azure-provider.example.test/openai", provider.GetProperty("baseUrl").GetString()); + Assert.Equal("provider-api-key", provider.GetProperty("apiKey").GetString()); + Assert.Equal("provider-bearer-token", provider.GetProperty("bearerToken").GetString()); + Assert.Equal("2024-02-15-preview", provider.GetProperty("azure").GetProperty("apiVersion").GetString()); + Assert.Equal("yes", provider.GetProperty("headers").GetProperty("X-Provider-Wire").GetString()); + Assert.Equal("claude-sonnet-4.5", provider.GetProperty("modelId").GetString()); + Assert.Equal("azure-deployment", provider.GetProperty("wireModel").GetString()); + Assert.Equal(8192, provider.GetProperty("maxPromptTokens").GetInt32()); + Assert.Equal(1024, provider.GetProperty("maxOutputTokens").GetInt32()); + + await session.DisposeAsync(); + } + [Fact] public async Task Should_Apply_Empty_Mode_Defaults_To_CreateSession_Wire_Request() { @@ -232,7 +494,7 @@ public async Task Should_Apply_Empty_Mode_Defaults_To_CreateSession_Wire_Request await client.StartAsync(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), @@ -248,6 +510,7 @@ public async Task Should_Apply_Empty_Mode_Defaults_To_CreateSession_Wire_Request Assert.False(createRequest.GetProperty("enableHostGitOperations").GetBoolean()); Assert.False(createRequest.GetProperty("enableSessionStore").GetBoolean()); Assert.False(createRequest.GetProperty("enableSkills").GetBoolean()); + Assert.True(createRequest.GetProperty("customAgentsLocalOnly").GetBoolean()); Assert.False(createRequest.TryGetProperty("organizationCustomInstructions", out _)); await session.DisposeAsync(); @@ -271,7 +534,7 @@ public async Task Should_Propagate_Activity_TraceContext_To_Session_Create_And_S activity.TraceStateString = "vendor=create-send"; activity.Start(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -355,7 +618,7 @@ public async Task Should_Propagate_Activity_TraceContext_To_Session_Resume() activity.TraceStateString = "vendor=resume"; activity.Start(); - var session = await client.ResumeSessionAsync("trace-resume-session", new ResumeSessionConfig + var session = await Ctx.ResumeSessionAsync(client, "trace-resume-session", new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -382,7 +645,7 @@ public async Task Should_Forward_Granular_Multitenancy_Fields_In_Resume_Wire_Req await client.StartAsync(); - var session = await client.ResumeSessionAsync("resume-session", new ResumeSessionConfig + var session = await Ctx.ResumeSessionAsync(client, "resume-session", new ResumeSessionConfig { SkipEmbeddingRetrieval = false, OrganizationCustomInstructions = "Resume org policy.", @@ -409,6 +672,88 @@ public async Task Should_Forward_Granular_Multitenancy_Fields_In_Resume_Wire_Req await session.DisposeAsync(); } + [Fact] + public async Task Should_Forward_Advanced_Session_Options_In_Resume_Wire_Request() + { + var (cliPath, capturePath) = await CreateFakeCliCaptureAsync(); + var outputDirectory = Path.Join(Ctx.WorkDir, "large-output-resume"); + using var canvasInput = JsonDocument.Parse("{\"start\":41}"); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(path: cliPath, args: ["--capture-file", capturePath]), + UseLoggedInUser = false, + }); + + await client.StartAsync(); + + var session = await Ctx.ResumeSessionAsync(client, "advanced-resume-session", new ResumeSessionConfig + { + ClientName = "advanced-resume-client", + Model = "claude-haiku-4.5", + ReasoningEffort = "low", + ReasoningSummary = ReasoningSummary.None, + ContextTier = ContextTier.Default, + SuppressResumeEvent = true, + ContinuePendingWork = true, + McpOAuthTokenStorage = McpOAuthTokenStorageMode.Persistent, + PluginDirectories = ["plugins-resume"], + LargeOutput = new LargeToolOutputConfig + { + Enabled = false, + MaxSizeBytes = 2048, + OutputDirectory = outputDirectory, + }, + Memory = new MemoryConfiguration { Enabled = false }, + RemoteSession = GitHub.Copilot.Rpc.RemoteSessionMode.On, + OpenCanvases = + [ + new GitHub.Copilot.Rpc.OpenCanvasInstance + { + CanvasId = "resume-canvas", + ExtensionId = "dotnet-sdk-tests/resume-extension", + ExtensionName = "Resume Extension", + InstanceId = "resume-canvas-1", + Input = canvasInput.RootElement.Clone(), + Status = "ready", + Title = "Resume Canvas", + Url = "https://example.com/resume-canvas", + }, + ], + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath)); + var resumeRequest = GetCapturedRequestParams(capture.RootElement, "session.resume"); + Assert.Equal("advanced-resume-session", resumeRequest.GetProperty("sessionId").GetString()); + Assert.Equal("advanced-resume-client", resumeRequest.GetProperty("clientName").GetString()); + Assert.Equal("claude-haiku-4.5", resumeRequest.GetProperty("model").GetString()); + Assert.Equal("low", resumeRequest.GetProperty("reasoningEffort").GetString()); + Assert.Equal("none", resumeRequest.GetProperty("reasoningSummary").GetString()); + Assert.Equal("default", resumeRequest.GetProperty("contextTier").GetString()); + Assert.True(resumeRequest.GetProperty("disableResume").GetBoolean()); + Assert.True(resumeRequest.GetProperty("continuePendingWork").GetBoolean()); + Assert.Equal("persistent", resumeRequest.GetProperty("mcpOAuthTokenStorage").GetString()); + Assert.Equal("plugins-resume", resumeRequest.GetProperty("pluginDirectories")[0].GetString()); + Assert.False(resumeRequest.GetProperty("largeOutput").GetProperty("enabled").GetBoolean()); + Assert.Equal(2048, resumeRequest.GetProperty("largeOutput").GetProperty("maxSizeBytes").GetInt64()); + Assert.Equal(outputDirectory, resumeRequest.GetProperty("largeOutput").GetProperty("outputDir").GetString()); + Assert.False(resumeRequest.GetProperty("memory").GetProperty("enabled").GetBoolean()); + Assert.Equal("on", resumeRequest.GetProperty("remoteSession").GetString()); + + var openCanvas = resumeRequest.GetProperty("openCanvases")[0]; + Assert.Equal("resume-canvas", openCanvas.GetProperty("canvasId").GetString()); + Assert.Equal("dotnet-sdk-tests/resume-extension", openCanvas.GetProperty("extensionId").GetString()); + Assert.Equal("Resume Extension", openCanvas.GetProperty("extensionName").GetString()); + Assert.Equal("resume-canvas-1", openCanvas.GetProperty("instanceId").GetString()); + Assert.Equal(41, openCanvas.GetProperty("input").GetProperty("start").GetInt32()); + Assert.Equal("ready", openCanvas.GetProperty("status").GetString()); + Assert.Equal("Resume Canvas", openCanvas.GetProperty("title").GetString()); + Assert.Equal("https://example.com/resume-canvas", openCanvas.GetProperty("url").GetString()); + + await session.DisposeAsync(); + } + [Fact] public async Task Should_Apply_Empty_Mode_Defaults_To_ResumeSession_Wire_Request() { @@ -424,7 +769,7 @@ public async Task Should_Apply_Empty_Mode_Defaults_To_ResumeSession_Wire_Request await client.StartAsync(); - var session = await client.ResumeSessionAsync("resume-empty-session", new ResumeSessionConfig + var session = await Ctx.ResumeSessionAsync(client, "resume-empty-session", new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), @@ -440,6 +785,7 @@ public async Task Should_Apply_Empty_Mode_Defaults_To_ResumeSession_Wire_Request Assert.False(resumeRequest.GetProperty("enableHostGitOperations").GetBoolean()); Assert.False(resumeRequest.GetProperty("enableSessionStore").GetBoolean()); Assert.False(resumeRequest.GetProperty("enableSkills").GetBoolean()); + Assert.True(resumeRequest.GetProperty("customAgentsLocalOnly").GetBoolean()); Assert.False(resumeRequest.TryGetProperty("organizationCustomInstructions", out _)); await session.DisposeAsync(); @@ -642,6 +988,7 @@ function saveCapture() { COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN, COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT, + OTEL_EXPORTER_OTLP_PROTOCOL: process.env.OTEL_EXPORTER_OTLP_PROTOCOL, COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH, COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE, COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME, diff --git a/dotnet/test/E2E/CommandsE2ETests.cs b/dotnet/test/E2E/CommandsE2ETests.cs index 20db2d7cb..5b778f9cc 100644 --- a/dotnet/test/E2E/CommandsE2ETests.cs +++ b/dotnet/test/E2E/CommandsE2ETests.cs @@ -30,7 +30,7 @@ public async Task Session_Commands_List_Returns_Builtins_And_Respects_Client_Com await TestHelper.WaitForConditionAsync( async () => { - clientCommands = await session.Rpc.Commands.ListAsync(new CommandsListRequest + clientCommands = await session.Rpc.Commands.ListAsync(new SessionCommandsListRequest { IncludeBuiltins = false, IncludeClientCommands = true, @@ -45,7 +45,7 @@ await TestHelper.WaitForConditionAsync( Assert.Contains(clientCommands.Commands, c => IsCommand(c, "rollback", SlashCommandKind.Client)); Assert.DoesNotContain(clientCommands.Commands, c => c.Kind == SlashCommandKind.Builtin); - var builtinCommands = await session.Rpc.Commands.ListAsync(new CommandsListRequest + var builtinCommands = await session.Rpc.Commands.ListAsync(new SessionCommandsListRequest { IncludeBuiltins = true, IncludeClientCommands = false, @@ -64,7 +64,7 @@ public async Task Session_Commands_Invoke_Known_Builtin_Returns_Expected_Result( { var session = await CreateSessionAsync(); - var builtinCommands = await session.Rpc.Commands.ListAsync(new CommandsListRequest + var builtinCommands = await session.Rpc.Commands.ListAsync(new SessionCommandsListRequest { IncludeBuiltins = true, IncludeClientCommands = false, @@ -128,7 +128,7 @@ public async Task Session_Commands_Execute_Runs_Registered_Command_Handler() await TestHelper.WaitForConditionAsync( async () => { - var commands = await session.Rpc.Commands.ListAsync(new CommandsListRequest + var commands = await session.Rpc.Commands.ListAsync(new SessionCommandsListRequest { IncludeBuiltins = false, IncludeClientCommands = true, @@ -202,8 +202,9 @@ public async Task Session_With_Commands_Creates_Successfully() [Fact] public async Task Session_With_Commands_Resumes_Successfully() { - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { diff --git a/dotnet/test/E2E/CopilotRequestCancelErrorE2ETests.cs b/dotnet/test/E2E/CopilotRequestCancelErrorE2ETests.cs new file mode 100644 index 000000000..a9b645d2a --- /dev/null +++ b/dotnet/test/E2E/CopilotRequestCancelErrorE2ETests.cs @@ -0,0 +1,172 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Net.Http; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +#pragma warning disable GHCP001 // The LLM inference surface is intentionally experimental. + +/// +/// Cancellation and error coverage for . These +/// two scenarios exercise the handler's terminal paths that the happy-path +/// session-id and WebSocket tests never reach: +/// +/// +/// +/// Error — the handler throws from +/// for an inference request. The base adapter reports a transport error back to +/// the runtime rather than hanging. +/// +/// +/// +/// +/// Runtime cancel — the handler blocks an inference request indefinitely; +/// when the consumer aborts the turn the runtime cancels the in-flight request, +/// firing . The handler +/// observes the abort instead of leaking a stuck request. +/// +/// +/// +/// Non-inference model-layer requests (catalog, policy, model session) are served +/// via so the turn +/// reaches the inference step; the success-path SSE body is intentionally omitted +/// because neither scenario completes a turn. +/// +public class CopilotRequestCancelErrorE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "copilot_request_cancel_error", output) +{ + private CopilotClient CreateClientWith(CopilotRequestHandler handler) => + Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(), + RequestHandler = handler, + }); + + [Fact] + public async Task Reports_A_Thrown_Callback_Error_Instead_Of_Hanging() + { + var handler = new ThrowingRequestHandler(); + await using var client = CreateClientWith(handler); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + try + { + // The callback throws on inference; the turn surfaces an error (or + // completes without an assistant message) rather than hanging. + await Record.ExceptionAsync(() => + session.SendAndWaitAsync(new MessageOptions { Prompt = "Say OK." })); + } + finally + { + await session.DisposeAsync(); + } + + Assert.True(handler.InferenceAttempts > 0, "expected the inference callback to be reached and raise"); + } + + [Fact] + public async Task Observes_Runtime_Cancellation_Of_An_In_Flight_Inference_Request() + { + var handler = new CancellingRequestHandler(); + await using var client = CreateClientWith(handler); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + try + { + await session.SendAsync(new MessageOptions { Prompt = "Say OK." }); + await WaitForAsync(() => handler.InferenceEntered, TimeSpan.FromSeconds(60)); + await session.AbortAsync(); + await WaitForAsync(() => handler.SawAbort, TimeSpan.FromSeconds(30)); + } + finally + { + await session.DisposeAsync(); + } + + Assert.True(handler.InferenceEntered, "expected the inference callback to be entered"); + Assert.True(handler.SawAbort, "expected the callback to observe runtime cancellation"); + } + + private static async Task WaitForAsync(Func predicate, TimeSpan timeout) + { + var deadline = DateTime.UtcNow + timeout; + while (!predicate()) + { + if (DateTime.UtcNow > deadline) + { + throw new TimeoutException("WaitForAsync timed out"); + } + + await Task.Delay(50); + } + } +} + +/// Throws from every inference request to exercise the error-reporting path. +internal sealed class ThrowingRequestHandler : CopilotRequestHandler +{ + private int _inferenceAttempts; + + public int InferenceAttempts => Volatile.Read(ref _inferenceAttempts); + + protected override Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + var url = request.RequestUri!.ToString(); + if (!RecordingRequestHandler.IsInferenceUrl(url)) + { + return Task.FromResult(RecordingRequestHandler.BuildNonInferenceResponse(url)); + } + + Interlocked.Increment(ref _inferenceAttempts); + throw new InvalidOperationException("synthetic-callback-transport-failure"); + } +} + +/// Blocks every inference request until the runtime cancels it. +internal sealed class CancellingRequestHandler : CopilotRequestHandler +{ + private volatile bool _inferenceEntered; + private volatile bool _sawAbort; + + public bool InferenceEntered => _inferenceEntered; + + public bool SawAbort => _sawAbort; + + protected override async Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + var url = request.RequestUri!.ToString(); + if (!RecordingRequestHandler.IsInferenceUrl(url)) + { + return RecordingRequestHandler.BuildNonInferenceResponse(url); + } + + _inferenceEntered = true; + try + { + // Never produce a response; wait for the runtime to cancel us. + await Task.Delay(Timeout.Infinite, ctx.CancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + _sawAbort = true; + throw; + } + + return RecordingRequestHandler.BuildNonInferenceResponse(url); + } +} diff --git a/dotnet/test/E2E/CopilotRequestE2EProvider.cs b/dotnet/test/E2E/CopilotRequestE2EProvider.cs new file mode 100644 index 000000000..89826b4f8 --- /dev/null +++ b/dotnet/test/E2E/CopilotRequestE2EProvider.cs @@ -0,0 +1,203 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Collections.Concurrent; +using System.Net; +using System.Net.Http; +using System.Text; +using System.Text.RegularExpressions; + +namespace GitHub.Copilot.Test.E2E; + +#pragma warning disable GHCP001 // The LLM inference surface is intentionally experimental. + +/// +/// A subclass for e2e tests that records every +/// intercepted request (url + threaded session id) and fully replaces the +/// upstream call with a fabricated, well-formed response for every model-layer +/// endpoint, so an agent turn completes entirely off-network — no upstream +/// server and no CAPI proxy acting as the inference endpoint. +/// +/// +/// +/// This exercises the public extension surface end to end: a consumer subclasses +/// and overrides to +/// short-circuit the upstream HTTP call with any +/// it likes. The base class streams that response back to the runtime. +/// +/// +/// All response bodies are emitted as raw JSON string literals rather than via +/// JsonSerializer: the test project disables reflection-based STJ on +/// net8.0 (JsonSerializerIsReflectionEnabledByDefault=false), so +/// serializing anonymous types would throw at runtime. +/// +/// +internal sealed class RecordingRequestHandler : CopilotRequestHandler +{ + internal const string SyntheticText = "OK from the synthetic stream."; + + private static readonly Regex WantsStreamRegex = new("\"stream\"\\s*:\\s*true", RegexOptions.Compiled); + + private readonly ConcurrentQueue _records = new(); + + public IReadOnlyCollection Records => _records; + + public IReadOnlyList InferenceRequests => + [.. _records.Where(r => IsInferenceUrl(r.Url))]; + + protected override async Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + var url = request.RequestUri!.ToString(); + var bodyText = request.Content is null + ? string.Empty +#if NET8_0_OR_GREATER + : await request.Content.ReadAsStringAsync(ctx.CancellationToken).ConfigureAwait(false); +#else + : await request.Content.ReadAsStringAsync().ConfigureAwait(false); +#endif + _records.Enqueue(new InterceptedRequest( + url, + ctx.SessionId, + ctx.AgentId, + ctx.ParentAgentId, + ctx.InteractionType, + bodyText)); + + return IsInferenceUrl(url) + ? BuildInferenceResponse(url, bodyText) + : BuildNonInferenceResponse(url); + } + + internal static bool IsInferenceUrl(string url) + { + var u = url.ToLowerInvariant(); + return u.EndsWith("/chat/completions", StringComparison.Ordinal) + || u.EndsWith("/responses", StringComparison.Ordinal) + || u.EndsWith("/v1/messages", StringComparison.Ordinal) + || u.EndsWith("/messages", StringComparison.Ordinal); + } + + /// + /// Synthesizes a well-formed inference response so the agent turn completes. + /// The runtime selects /responses for both the CAPI and BYOK sessions + /// here; /chat/completions is handled too for robustness. + /// + private static HttpResponseMessage BuildInferenceResponse(string url, string bodyText) + { + var wantsStream = WantsStreamRegex.IsMatch(bodyText); + var u = url.ToLowerInvariant(); + + if (u.Contains("/responses", StringComparison.Ordinal)) + { + return wantsStream + ? Sse(string.Concat(ResponsesStreamEvents)) + : Json(BufferedResponseJson); + } + + if (u.Contains("/chat/completions", StringComparison.Ordinal) && wantsStream) + { + return Sse(string.Concat(ChatCompletionStreamEvents)); + } + + if (u.EndsWith("/messages", StringComparison.Ordinal)) + { + return wantsStream + ? Sse(string.Concat(AnthropicStreamEvents)) + : Json(BufferedAnthropicMessageJson); + } + + // /chat/completions non-streaming (and any other inference url) — buffered JSON. + return Json(BufferedChatCompletionJson); + } + + /// + /// Serves the non-inference model-layer GETs/POSTs the runtime issues + /// (catalog, model session, policy). These flow through the same callback + /// but carry no session id (they happen outside an agent turn). Shared with + /// the cancel/error e2e handlers so the turn can reach the inference step. + /// + internal static HttpResponseMessage BuildNonInferenceResponse(string url) + { + var u = url.ToLowerInvariant(); + if (u.EndsWith("/models", StringComparison.Ordinal)) + { + return Json(ModelCatalogJson); + } + + if (u.Contains("/models/session", StringComparison.Ordinal)) + { + return Json("{}"); + } + + if (u.Contains("/policy", StringComparison.Ordinal)) + { + return Json("{\"state\":\"enabled\"}"); + } + + return Json("{}"); + } + + internal static HttpResponseMessage Json(string body) => new(HttpStatusCode.OK) + { + Content = new StringContent(body, Encoding.UTF8, "application/json"), + }; + + private static HttpResponseMessage Sse(string body) => new(HttpStatusCode.OK) + { + Content = new StringContent(body, Encoding.UTF8, "text/event-stream"), + }; + + private static readonly string[] ResponsesStreamEvents = + [ + "event: response.created\ndata: {\"type\":\"response.created\",\"response\":{\"id\":\"resp_stub_1\",\"object\":\"response\",\"status\":\"in_progress\",\"output\":[]}}\n\n", + "event: response.output_item.added\ndata: {\"type\":\"response.output_item.added\",\"output_index\":0,\"item\":{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[]}}\n\n", + "event: response.content_part.added\ndata: {\"type\":\"response.content_part.added\",\"output_index\":0,\"content_index\":0,\"part\":{\"type\":\"output_text\",\"text\":\"\"}}\n\n", + "event: response.output_text.delta\ndata: {\"type\":\"response.output_text.delta\",\"output_index\":0,\"content_index\":0,\"delta\":\"" + SyntheticText + "\"}\n\n", + "event: response.output_text.done\ndata: {\"type\":\"response.output_text.done\",\"output_index\":0,\"content_index\":0,\"text\":\"" + SyntheticText + "\"}\n\n", + "event: response.completed\ndata: {\"type\":\"response.completed\",\"response\":{\"id\":\"resp_stub_1\",\"object\":\"response\",\"status\":\"completed\",\"output\":[{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"" + SyntheticText + "\"}]}],\"usage\":{\"input_tokens\":5,\"output_tokens\":7,\"total_tokens\":12}}}\n\n", + ]; + + private static readonly string[] ChatCompletionStreamEvents = + [ + "data: {\"id\":\"chatcmpl-stub-1\",\"object\":\"chat.completion.chunk\",\"created\":1,\"model\":\"claude-sonnet-4.5\",\"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"\"},\"finish_reason\":null}]}\n\n", + "data: {\"id\":\"chatcmpl-stub-1\",\"object\":\"chat.completion.chunk\",\"created\":1,\"model\":\"claude-sonnet-4.5\",\"choices\":[{\"index\":0,\"delta\":{\"content\":\"" + SyntheticText + "\"},\"finish_reason\":null}]}\n\n", + "data: {\"id\":\"chatcmpl-stub-1\",\"object\":\"chat.completion.chunk\",\"created\":1,\"model\":\"claude-sonnet-4.5\",\"choices\":[{\"index\":0,\"delta\":{},\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":5,\"completion_tokens\":7,\"total_tokens\":12}}\n\n", + "data: [DONE]\n\n", + ]; + + // Anthropic Messages streaming (SSE) sequence. Emitted when the runtime issues a + // streaming /messages request (stream: true); the buffered JSON below is only valid + // for non-streaming requests, and returning it for a streaming request makes the + // runtime's Anthropic client fail with "stream ended without producing a Message". + private static readonly string[] AnthropicStreamEvents = + [ + "event: message_start\ndata: {\"type\":\"message_start\",\"message\":{\"id\":\"msg_stub_1\",\"type\":\"message\",\"role\":\"assistant\",\"model\":\"claude-sonnet-4.5\",\"content\":[],\"stop_reason\":null,\"stop_sequence\":null,\"usage\":{\"input_tokens\":5,\"output_tokens\":1}}}\n\n", + "event: content_block_start\ndata: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"text\",\"text\":\"\"}}\n\n", + "event: content_block_delta\ndata: {\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"text_delta\",\"text\":\"" + SyntheticText + "\"}}\n\n", + "event: content_block_stop\ndata: {\"type\":\"content_block_stop\",\"index\":0}\n\n", + "event: message_delta\ndata: {\"type\":\"message_delta\",\"delta\":{\"stop_reason\":\"end_turn\",\"stop_sequence\":null},\"usage\":{\"output_tokens\":7}}\n\n", + "event: message_stop\ndata: {\"type\":\"message_stop\"}\n\n", + ]; + + private static readonly string BufferedResponseJson = + "{\"id\":\"resp_stub_1\",\"object\":\"response\",\"status\":\"completed\",\"output\":[{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"" + SyntheticText + "\"}]}],\"usage\":{\"input_tokens\":5,\"output_tokens\":7,\"total_tokens\":12}}"; + + private static readonly string BufferedChatCompletionJson = + "{\"id\":\"chatcmpl-stub-1\",\"object\":\"chat.completion\",\"created\":1,\"model\":\"claude-sonnet-4.5\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"" + SyntheticText + "\"},\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":5,\"completion_tokens\":7,\"total_tokens\":12}}"; + + private static readonly string BufferedAnthropicMessageJson = + "{\"id\":\"msg_stub_1\",\"type\":\"message\",\"role\":\"assistant\",\"model\":\"claude-sonnet-4.5\",\"content\":[{\"type\":\"text\",\"text\":\"" + SyntheticText + "\"}],\"stop_reason\":\"end_turn\",\"stop_sequence\":null,\"usage\":{\"input_tokens\":5,\"output_tokens\":7}}"; + + private const string ModelCatalogJson = + "{\"data\":[{\"id\":\"claude-sonnet-4.5\",\"name\":\"Claude Sonnet 4.5\",\"object\":\"model\",\"vendor\":\"Anthropic\",\"version\":\"1\",\"preview\":false,\"model_picker_enabled\":true,\"capabilities\":{\"type\":\"chat\",\"family\":\"claude-sonnet-4.5\",\"tokenizer\":\"o200k_base\",\"limits\":{\"max_context_window_tokens\":200000,\"max_output_tokens\":8192},\"supports\":{\"streaming\":true,\"tool_calls\":true,\"parallel_tool_calls\":true,\"vision\":true}}}]}"; +} + +/// A single request the callback intercepted. +internal sealed record InterceptedRequest( + string Url, + string? SessionId, + string? AgentId, + string? ParentAgentId, + string? InteractionType, + string Body); diff --git a/dotnet/test/E2E/CopilotRequestSessionIdE2ETests.cs b/dotnet/test/E2E/CopilotRequestSessionIdE2ETests.cs new file mode 100644 index 000000000..fd00cc9b9 --- /dev/null +++ b/dotnet/test/E2E/CopilotRequestSessionIdE2ETests.cs @@ -0,0 +1,120 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +#pragma warning disable GHCP001 // The LLM inference surface is intentionally experimental. + +/// +/// Asserts the runtime threads its session id into the LLM inference callback +/// for BOTH a CAPI session and a BYOK session. The callback alone services +/// every model-layer request — no upstream server, no CAPI proxy acting as the +/// inference endpoint — so the only source of req.SessionId is the +/// runtime's own per-client threading. +/// +public class CopilotRequestSessionIdE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "llm_inference_session_id", output) +{ + private CopilotClient CreateClientWith(RecordingRequestHandler provider) => + Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(), + RequestHandler = provider, + }); + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] + public async Task Threads_The_Session_Id_Into_A_Capi_Session_Inference_Request() + { + var provider = new RecordingRequestHandler(); + await using var client = CreateClientWith(provider); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + var capiSessionId = session.SessionId; + + string content; + try + { + var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Say OK." }); + content = msg?.Data.Content ?? string.Empty; + } + finally + { + await session.DisposeAsync(); + } + + var inference = provider.InferenceRequests; + Assert.NotEmpty(inference); + Assert.All(inference, r => + { + Assert.Equal(capiSessionId, r.SessionId); + AssertAgentMetadata(r); + }); + + // Validate the final assistant response arrived (guards against truncated captures) + Assert.Contains("OK from the synthetic", content); + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Threads_The_Session_Id_Into_A_Byok_Session_Inference_Request() + { + var provider = new RecordingRequestHandler(); + await using var client = CreateClientWith(provider); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + // BYOK providers require an explicit model id. + Model = "claude-sonnet-4.5", + Provider = new ProviderConfig + { + Type = "openai", + WireApi = "responses", + BaseUrl = "https://byok.invalid/v1", + ApiKey = "byok-secret", + ModelId = "claude-sonnet-4.5", + WireModel = "claude-sonnet-4.5", + }, + }); + var byokSessionId = session.SessionId; + + string content; + try + { + var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Say OK." }); + content = msg?.Data.Content ?? string.Empty; + } + finally + { + await session.DisposeAsync(); + } + + var inference = provider.InferenceRequests; + Assert.NotEmpty(inference); + Assert.All(inference, r => + { + Assert.Equal(byokSessionId, r.SessionId); + AssertAgentMetadata(r); + }); + + // Validate the final assistant response arrived (guards against truncated captures) + Assert.Contains("OK from the synthetic", content); + } + + private static void AssertAgentMetadata(InterceptedRequest request) + { + Assert.False(string.IsNullOrEmpty(request.AgentId)); + Assert.False(string.IsNullOrEmpty(request.InteractionType)); + } +} diff --git a/dotnet/test/E2E/CopilotRequestWebSocketE2ETests.cs b/dotnet/test/E2E/CopilotRequestWebSocketE2ETests.cs new file mode 100644 index 000000000..80ccdb8c9 --- /dev/null +++ b/dotnet/test/E2E/CopilotRequestWebSocketE2ETests.cs @@ -0,0 +1,387 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +#if NET8_0_OR_GREATER + +using System.Net; +using System.Net.Sockets; +using System.Net.WebSockets; +using System.Text; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +#pragma warning disable GHCP001 // The LLM inference surface is intentionally experimental. + +/// +/// Drives a full agent turn over the WebSocket inference transport through a +/// subclass. A single handler services both +/// transports against an in-process fake upstream: model-layer GETs and the +/// single-shot HTTP /responses call are forwarded over HTTP, while the +/// main turn flows over a real WebSocket opened by a +/// . +/// +/// +/// This is the regression test for the WebSocket upgrade deadlock: the runtime +/// blocks the WebSocket connect until it observes the 101 response head, so the +/// handler must emit it eagerly rather than waiting for the first upstream +/// message. Without the eager start the turn never completes and this test +/// times out. +/// +[Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] +public class CopilotRequestWebSocketE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "copilot_request_websocket", output) +{ + [Fact] + public async Task Services_A_WebSocket_Turn_End_To_End_Via_The_Request_Handler() + { + await using var upstream = new FakeCopilotUpstream(); + var counters = new HandlerCounters(); + var handler = new ForwardingUpstreamHandler(upstream.BaseUrl, counters); + + // Enable the WebSocket Responses transport in the spawned runtime so the + // main agent turn picks the WS path; single-shot calls still go over HTTP + // through the same handler. + var env = Ctx.GetEnvironment(); + env["COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES"] = "true"; + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(), + RequestHandler = handler, + }, environment: env); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + string content; + try + { + var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Say OK." }); + content = msg?.Data.Content ?? string.Empty; + } + finally + { + await session.DisposeAsync(); + } + + // The HTTP hooks fired — the runtime issued model-layer GETs (catalog, + // policy) and possibly a single-shot inference, all forwarded over HTTP. + Assert.True(counters.HttpRequests > 0, "expected SendRequestAsync to fire"); + + // The WebSocket hooks fired — the main agent turn went over the WS path + // and we observed messages in both directions. + Assert.True(counters.WsRequestMessages > 0, "expected SendRequestMessageAsync (runtime -> upstream) to fire"); + Assert.True(counters.WsResponseMessages > 0, "expected SendResponseMessageAsync (upstream -> runtime) to fire"); + Assert.True(upstream.WsRequestMessageCount > 0, "expected upstream WS to receive request messages"); + + // The synthetic content surfaced in the assistant turn — proves the full + // chain (runtime -> handler -> upstream -> handler -> runtime) over the + // WebSocket transport is intact. + // Validate the final assistant response arrived (guards against truncated captures) + Assert.Contains("OK from synthetic", content); + } +} + +/// Cross-direction message counters shared with the test assertions. +internal sealed class HandlerCounters +{ + public int HttpRequests; + public int WsRequestMessages; + public int WsResponseMessages; +} + +/// +/// A that points every intercepted request at +/// the in-process : HTTP requests are rewritten +/// and forwarded by the base class, and WebSocket connections are opened against +/// the rewritten URL via a counting . +/// +internal sealed class ForwardingUpstreamHandler(string upstreamBaseUrl, HandlerCounters counters) : CopilotRequestHandler +{ + private readonly Uri _upstream = new(upstreamBaseUrl); + + protected override Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + Interlocked.Increment(ref counters.HttpRequests); + request.RequestUri = Rewrite(request.RequestUri!); + return base.SendRequestAsync(request, ctx); + } + + protected override Task OpenWebSocketAsync(CopilotRequestContext ctx) + { + ctx = new CopilotRequestContext(ctx) { Url = Rewrite(new Uri(ctx.Url)).ToString() }; + return Task.FromResult(new CountingForwardingWebSocketHandler(ctx, counters)); + } + + private Uri Rewrite(Uri original) => new UriBuilder(original) + { + Scheme = _upstream.Scheme, + Host = _upstream.Host, + Port = _upstream.Port, + }.Uri; +} + +/// +/// A pass-through forwarding handler that counts messages in both directions. +/// +internal sealed class CountingForwardingWebSocketHandler( + CopilotRequestContext context, + HandlerCounters counters) + : CopilotWebSocketForwarder(context) +{ + public override Task SendRequestMessageAsync(CopilotWebSocketMessage message) + { + Interlocked.Increment(ref counters.WsRequestMessages); + return base.SendRequestMessageAsync(message); + } + + public override Task SendResponseMessageAsync(CopilotWebSocketMessage message) + { + Interlocked.Increment(ref counters.WsResponseMessages); + return base.SendResponseMessageAsync(message); + } +} + +/// +/// In-process upstream that speaks the CAPI shapes the runtime needs: model +/// catalog (advertising the WebSocket /responses endpoint), policy, a +/// single-shot HTTP /responses SSE stream, and a WebSocket endpoint at +/// /responses that answers each inbound response.create with the +/// ordered /responses events the reducer expects. +/// +internal sealed class FakeCopilotUpstream : IAsyncDisposable +{ + private const string HttpText = "OK from synthetic HTTP upstream."; + private const string WsText = "OK from synthetic WS upstream."; + + private readonly HttpListener _listener = new(); + private readonly CancellationTokenSource _cts = new(); + private readonly Task _loop; + private int _wsRequestMessages; + + public string BaseUrl { get; } + + public int WsRequestMessageCount => Volatile.Read(ref _wsRequestMessages); + + public FakeCopilotUpstream() + { + var port = GetFreePort(); + BaseUrl = $"http://127.0.0.1:{port}/"; + _listener.Prefixes.Add(BaseUrl); + _listener.Start(); + _loop = Task.Run(() => AcceptLoopAsync(_cts.Token), _cts.Token); + } + + private async Task AcceptLoopAsync(CancellationToken ct) + { + while (!ct.IsCancellationRequested) + { + HttpListenerContext context; + try + { + context = await _listener.GetContextAsync().ConfigureAwait(false); + } + catch + { + break; + } + + _ = Task.Run(() => HandleContextAsync(context, ct), ct); + } + } + + private async Task HandleContextAsync(HttpListenerContext context, CancellationToken ct) + { + try + { + if (context.Request.IsWebSocketRequest) + { + await HandleWebSocketAsync(context, ct).ConfigureAwait(false); + } + else + { + await HandleHttpAsync(context, ct).ConfigureAwait(false); + } + } + catch + { + // Best-effort: the runtime tears connections down as turns complete. + } + } + + private async Task HandleWebSocketAsync(HttpListenerContext context, CancellationToken ct) + { + var wsContext = await context.AcceptWebSocketAsync(subProtocol: null).ConfigureAwait(false); + var socket = wsContext.WebSocket; + var buffer = new byte[16 * 1024]; + + while (socket.State == WebSocketState.Open && !ct.IsCancellationRequested) + { + var message = await ReceiveTextAsync(socket, buffer, ct).ConfigureAwait(false); + if (message is null) + { + break; + } + + Interlocked.Increment(ref _wsRequestMessages); + + foreach (var (_, json) in ResponseEvents(WsText, "resp_stub_ws")) + { + var bytes = Encoding.UTF8.GetBytes(json); + await socket.SendAsync( + new ArraySegment(bytes), + WebSocketMessageType.Text, + endOfMessage: true, + ct).ConfigureAwait(false); + } + } + + if (socket.State == WebSocketState.Open || socket.State == WebSocketState.CloseReceived) + { + try + { + await socket.CloseAsync(WebSocketCloseStatus.NormalClosure, null, CancellationToken.None).ConfigureAwait(false); + } + catch + { + // Already torn down. + } + } + } + + private static async Task ReceiveTextAsync(WebSocket socket, byte[] buffer, CancellationToken ct) + { + using var assembled = new MemoryStream(); + WebSocketReceiveResult result; + do + { + result = await socket.ReceiveAsync(new ArraySegment(buffer), ct).ConfigureAwait(false); + if (result.MessageType == WebSocketMessageType.Close) + { + return null; + } + + assembled.Write(buffer, 0, result.Count); + } + while (!result.EndOfMessage); + + return Encoding.UTF8.GetString(assembled.ToArray()); + } + + private static async Task HandleHttpAsync(HttpListenerContext context, CancellationToken ct) + { + if (context.Request.HasEntityBody) + { + using var input = context.Request.InputStream; + var drain = new byte[8 * 1024]; + while (await input.ReadAsync(drain.AsMemory(), ct).ConfigureAwait(false) > 0) + { + // Discard the request body; the synthetic response is fixed. + } + } + + var path = context.Request.Url!.AbsolutePath.ToLowerInvariant(); + string contentType = "application/json"; + string body; + + if (path.EndsWith("/models", StringComparison.Ordinal)) + { + body = ModelCatalogJson; + } + else if (path.Contains("/models/session")) + { + body = "{}"; + } + else if (path.Contains("/policy")) + { + body = "{\"state\":\"enabled\"}"; + } + else if (path.EndsWith("/responses", StringComparison.Ordinal)) + { + contentType = "text/event-stream"; + body = BuildSse(HttpText, "resp_stub_http"); + } + else + { + body = "{}"; + } + + var bytes = Encoding.UTF8.GetBytes(body); + context.Response.StatusCode = 200; + context.Response.ContentType = contentType; + context.Response.ContentLength64 = bytes.Length; + await context.Response.OutputStream.WriteAsync(bytes.AsMemory(), ct).ConfigureAwait(false); + context.Response.OutputStream.Close(); + } + + private static string BuildSse(string text, string id) + { + var sb = new StringBuilder(); + foreach (var (type, json) in ResponseEvents(text, id)) + { + sb.Append("event: ").Append(type).Append("\ndata: ").Append(json).Append("\n\n"); + } + + return sb.ToString(); + } + + private static (string Type, string Json)[] ResponseEvents(string text, string id) => + [ + ("response.created", + "{\"type\":\"response.created\",\"response\":{\"id\":\"" + id + "\",\"object\":\"response\",\"status\":\"in_progress\",\"output\":[]}}"), + ("response.output_item.added", + "{\"type\":\"response.output_item.added\",\"output_index\":0,\"item\":{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[]}}"), + ("response.content_part.added", + "{\"type\":\"response.content_part.added\",\"output_index\":0,\"content_index\":0,\"part\":{\"type\":\"output_text\",\"text\":\"\"}}"), + ("response.output_text.delta", + "{\"type\":\"response.output_text.delta\",\"output_index\":0,\"content_index\":0,\"delta\":\"" + text + "\"}"), + ("response.output_text.done", + "{\"type\":\"response.output_text.done\",\"output_index\":0,\"content_index\":0,\"text\":\"" + text + "\"}"), + ("response.completed", + "{\"type\":\"response.completed\",\"response\":{\"id\":\"" + id + "\",\"object\":\"response\",\"status\":\"completed\",\"output\":[{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"" + text + "\"}]}],\"usage\":{\"input_tokens\":5,\"output_tokens\":7,\"total_tokens\":12}}}"), + ]; + + private const string ModelCatalogJson = + "{\"data\":[{\"id\":\"claude-sonnet-4.5\",\"name\":\"Claude Sonnet 4.5\",\"object\":\"model\",\"vendor\":\"Anthropic\",\"version\":\"1\",\"preview\":false,\"model_picker_enabled\":true,\"supported_endpoints\":[\"/responses\",\"ws:/responses\"],\"capabilities\":{\"type\":\"chat\",\"family\":\"claude-sonnet-4.5\",\"tokenizer\":\"o200k_base\",\"limits\":{\"max_context_window_tokens\":200000,\"max_output_tokens\":8192},\"supports\":{\"streaming\":true,\"tool_calls\":true,\"parallel_tool_calls\":true,\"vision\":true}}}]}"; + + private static int GetFreePort() + { + using var probe = new TcpListener(IPAddress.Loopback, 0); + probe.Start(); + return ((IPEndPoint)probe.LocalEndpoint).Port; + } + + public async ValueTask DisposeAsync() + { + _cts.Cancel(); + try + { + _listener.Stop(); + _listener.Close(); + } + catch + { + // Already stopped. + } + + try + { + await _loop.ConfigureAwait(false); + } + catch + { + // Accept loop unwinds on listener shutdown. + } + + _cts.Dispose(); + } +} + +#endif diff --git a/dotnet/test/E2E/GitHubTelemetryForwardingE2ETests.cs b/dotnet/test/E2E/GitHubTelemetryForwardingE2ETests.cs new file mode 100644 index 000000000..80d0ccb0b --- /dev/null +++ b/dotnet/test/E2E/GitHubTelemetryForwardingE2ETests.cs @@ -0,0 +1,66 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Collections.Concurrent; +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +#pragma warning disable GHCP001 // GitHub telemetry forwarding is experimental. + +// TODO(BYOK): Anthropic Messages produced no GitHub telemetry notification. Determine whether +// provider-backed sessions should forward the same telemetry before keeping this CAPI-only. +[Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] +public class GitHubTelemetryForwardingE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "github_telemetry", output) +{ + [Fact] + public async Task Should_Forward_GitHub_Telemetry_For_A_Live_Session() + { + var notifications = new ConcurrentQueue(); + + await using var client = Ctx.CreateClient(options: new CopilotClientOptions + { + OnGitHubTelemetry = notification => + { + notifications.Enqueue(notification); + return Task.CompletedTask; + }, + }); + + CopilotSession? session = null; + try + { + session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + await TestHelper.WaitForConditionAsync( + () => !notifications.IsEmpty, + timeout: TimeSpan.FromSeconds(30), + timeoutMessage: "Timed out waiting for GitHub telemetry notification."); + + Assert.True(notifications.TryPeek(out var notification)); + Assert.False(string.IsNullOrEmpty(notification.SessionId)); + Assert.NotNull(notification.Event); + Assert.NotEmpty(notification.Event.Kind); + Assert.IsType(notification.Restricted); + } + finally + { + if (session is not null) + { + await session.DisposeAsync(); + } + + await client.StopAsync(); + } + } +} + +#pragma warning restore GHCP001 diff --git a/dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs b/dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs index 19704f8fd..decdb3190 100644 --- a/dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs +++ b/dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs @@ -11,8 +11,9 @@ namespace GitHub.Copilot.Test.E2E; /// /// E2E coverage for every handler exposed on : /// OnPreToolUse, OnPostToolUse, OnPostToolUseFailure, OnUserPromptSubmitted, -/// OnSessionStart, OnSessionEnd, OnErrorOccurred. Output-shape behavior -/// (modifiedPrompt / additionalContext / errorHandling / modifiedArgs / +/// OnUserPromptTransformed, OnSessionStart, OnSessionEnd, OnErrorOccurred, +/// OnAgentStop. Output-shape behavior (modifiedPrompt / modifiedTransformedPrompt / +/// additionalContext / errorHandling / modifiedArgs / /// modifiedResult / sessionSummary) is asserted alongside hook invocation. If a /// new handler is added to SessionHooks, add a corresponding test here. /// @@ -163,6 +164,37 @@ public async Task Should_Invoke_UserPromptSubmitted_Hook_And_Modify_Prompt() Assert.Contains("HOOKED_PROMPT", response?.Data.Content ?? string.Empty); } + [Fact] + public async Task Should_Invoke_UserPromptTransformed_Hook_And_Modify_Transformed_Prompt() + { + var inputs = new List(); + var session = await CreateSessionAsync(new SessionConfig + { + Hooks = new SessionHooks + { + OnUserPromptTransformed = (input, invocation) => + { + inputs.Add(input); + Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId)); + return Task.FromResult(new UserPromptTransformedHookOutput + { + ModifiedTransformedPrompt = "Reply with exactly: HOOKED_TRANSFORMED_PROMPT", + }); + }, + }, + }); + + var response = await session.SendAndWaitAsync(new MessageOptions { Prompt = "Answer the request above." }); + + Assert.NotEmpty(inputs); + Assert.Contains("Answer the request above.", inputs[0].Prompt); + Assert.Contains("Answer the request above.", inputs[0].TransformedPrompt); + Assert.Contains("", inputs[0].TransformedPrompt); + Assert.True(inputs[0].Timestamp > DateTimeOffset.UnixEpoch); + Assert.False(string.IsNullOrEmpty(inputs[0].WorkingDirectory)); + Assert.Contains("HOOKED_TRANSFORMED_PROMPT", response?.Data.Content ?? string.Empty); + } + [Fact] public async Task Should_Invoke_SessionStart_Hook() { @@ -255,6 +287,45 @@ await session.SendAndWaitAsync(new MessageOptions Assert.NotNull(session.SessionId); } + [Fact] + public async Task Should_Invoke_AgentStop_Hook_And_Apply_Block_Response() + { + var inputs = new List(); + var session = await CreateSessionAsync(new SessionConfig + { + Hooks = new SessionHooks + { + OnAgentStop = (input, invocation) => + { + inputs.Add(input); + Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId)); + if (inputs.Count == 1) + { + return Task.FromResult(new AgentStopHookOutput + { + Decision = "block", + Reason = "Reply with exactly: AGENT_STOP_CONTINUED", + }); + } + + return Task.FromResult(null); + }, + }, + }); + + var response = await session.SendAndWaitAsync(new MessageOptions + { + Prompt = "Reply with exactly: AGENT_STOP_INITIAL", + }); + + Assert.Equal(2, inputs.Count); + Assert.NotEqual(true, inputs[0].StopHookActive); + Assert.True(inputs[1].StopHookActive); + Assert.Equal("end_turn", inputs[0].StopReason); + Assert.False(string.IsNullOrWhiteSpace(inputs[0].TranscriptPath)); + Assert.Contains("AGENT_STOP_CONTINUED", response?.Data.Content ?? string.Empty); + } + [Fact] public async Task Should_Allow_PreToolUse_To_Return_ModifiedArgs_And_SuppressOutput() { @@ -309,13 +380,12 @@ public async Task Should_Allow_PostToolUse_To_Return_ModifiedResult() var session = await CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, - AvailableTools = ["report_intent"], Hooks = new SessionHooks { OnPostToolUse = (input, invocation) => { inputs.Add(input); - if (input.ToolName != "report_intent") + if (input.ToolName != "view") { return Task.FromResult(null); } @@ -336,14 +406,14 @@ public async Task Should_Allow_PostToolUse_To_Return_ModifiedResult() var response = await session.SendAndWaitAsync(new MessageOptions { - Prompt = "Call the report_intent tool with intent 'Testing post hook', then reply done.", + Prompt = "Call the view tool to read the current directory, then reply done.", }); - Assert.Contains(inputs, input => input.ToolName == "report_intent"); - Assert.Equal("Done.", response?.Data.Content); + Assert.Contains(inputs, input => input.ToolName == "view"); + Assert.Contains("done", (response?.Data.Content ?? string.Empty).ToLowerInvariant()); } - [Fact] + [Fact(Skip = "Fails with 1.0.64-0 runtime: built-in tools are not available when hooks restrict availableTools, so the failure path cannot be exercised. Follow up with runtime team.")] public async Task Should_Invoke_PostToolUseFailure_Hook_For_Failed_Tool_Result() { var failureInputs = new List(); diff --git a/dotnet/test/E2E/HooksE2ETests.cs b/dotnet/test/E2E/HooksE2ETests.cs index ab971c26e..0d9155fbc 100644 --- a/dotnet/test/E2E/HooksE2ETests.cs +++ b/dotnet/test/E2E/HooksE2ETests.cs @@ -30,7 +30,7 @@ public async Task Should_Invoke_PreToolUse_Hook_When_Model_Runs_A_Tool() }); // Create a file for the model to read - await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, "hello.txt"), "Hello from the test!"); + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "hello.txt"), "Hello from the test!"); await session.SendAsync(new MessageOptions { @@ -66,7 +66,7 @@ public async Task Should_Invoke_PostToolUse_Hook_After_Model_Runs_A_Tool() }); // Create a file for the model to read - await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, "world.txt"), "World from the test!"); + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "world.txt"), "World from the test!"); await session.SendAsync(new MessageOptions { @@ -107,7 +107,7 @@ public async Task Should_Invoke_Both_PreToolUse_And_PostToolUse_Hooks_For_Single } }); - await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, "both.txt"), "Testing both hooks!"); + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "both.txt"), "Testing both hooks!"); await session.SendAsync(new MessageOptions { @@ -147,7 +147,7 @@ public async Task Should_Deny_Tool_Execution_When_PreToolUse_Returns_Deny() // Create a file var originalContent = "Original content that should not be modified"; - await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, "protected.txt"), originalContent); + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "protected.txt"), originalContent); await session.SendAsync(new MessageOptions { diff --git a/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs b/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs index 4e573ff5c..caf49fa6d 100644 --- a/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs +++ b/dotnet/test/E2E/InMemorySessionFsSqliteHandler.cs @@ -17,7 +17,7 @@ internal record SqliteCall(string SessionId, string QueryType, string Query); /// for file operations instead of touching disk. /// internal sealed class InMemorySessionFsSqliteHandler(string sessionId, List sqliteCalls) - : SessionFsProvider, ISessionFsSqliteProvider + : SessionFsProvider, ISessionFsSqliteProvider, ISessionFsSqliteTransactionProvider { internal ConcurrentDictionary Files { get; } = new(); private readonly ConcurrentDictionary _directories = new(); @@ -45,28 +45,82 @@ private SqliteConnection GetOrCreateDb() string query, IDictionary? bindParams, CancellationToken cancellationToken) + { + return Task.FromResult(RunStatement(GetOrCreateDb(), null, queryType, query, bindParams)); + } + + public Task> TransactionAsync( + IList statements, + CancellationToken cancellationToken) + { + var db = GetOrCreateDb(); + using var transaction = db.BeginTransaction(); + try + { + IList results = statements + .Select(statement => RunStatement(db, transaction, statement.QueryType, statement.Query, statement.Params) + ?? new SessionFsSqliteResult()) + .ToList(); + try + { + transaction.Commit(); + } + catch (Exception ex) + { + throw new SessionFsSqliteTransactionException( + ex.Message, + SessionFsSqliteTransactionErrorClass.PostCommitAmbiguous, + ex); + } + return Task.FromResult(results); + } + catch (SessionFsSqliteTransactionException) + { + throw; + } + catch (SqliteException ex) + { + transaction.Rollback(); + var errorClass = ex.SqliteErrorCode is 5 or 6 + ? SessionFsSqliteTransactionErrorClass.BusyOrLocked + : SessionFsSqliteTransactionErrorClass.Fatal; + throw new SessionFsSqliteTransactionException(ex.Message, errorClass, ex); + } + catch (Exception ex) + { + transaction.Rollback(); + throw new SessionFsSqliteTransactionException(ex.Message, SessionFsSqliteTransactionErrorClass.Fatal, ex); + } + } + + private SessionFsSqliteResult? RunStatement( + SqliteConnection db, + SqliteTransaction? transaction, + SessionFsSqliteQueryType queryType, + string query, + IDictionary? bindParams) { sqliteCalls.Add(new SqliteCall(sessionId, queryType.Value, query)); var trimmed = query.Trim(); if (trimmed.Length == 0) { - return Task.FromResult(null); + return null; } - var db = GetOrCreateDb(); - if (queryType == SessionFsSqliteQueryType.Exec) { using var cmd = db.CreateCommand(); + cmd.Transaction = transaction; cmd.CommandText = trimmed; cmd.ExecuteNonQuery(); - return Task.FromResult(null); + return null; } if (queryType == SessionFsSqliteQueryType.Query) { using var cmd = db.CreateCommand(); + cmd.Transaction = transaction; cmd.CommandText = trimmed; AddParams(cmd, bindParams); @@ -88,33 +142,35 @@ private SqliteConnection GetOrCreateDb() rows.Add(row); } - return Task.FromResult(new SessionFsSqliteResult + return new SessionFsSqliteResult { Columns = columns, Rows = rows, RowsAffected = 0, - }); + }; } if (queryType == SessionFsSqliteQueryType.Run) { using var cmd = db.CreateCommand(); + cmd.Transaction = transaction; cmd.CommandText = trimmed; AddParams(cmd, bindParams); var rowsAffected = cmd.ExecuteNonQuery(); using var rowidCmd = db.CreateCommand(); + rowidCmd.Transaction = transaction; rowidCmd.CommandText = "SELECT last_insert_rowid()"; var lastRowid = rowidCmd.ExecuteScalar(); - return Task.FromResult(new SessionFsSqliteResult + return new SessionFsSqliteResult { Columns = [], Rows = [], RowsAffected = rowsAffected, LastInsertRowid = lastRowid is long l ? l : null, - }); + }; } throw new ArgumentException($"Unknown queryType: {queryType}"); diff --git a/dotnet/test/E2E/McpOAuthE2ETests.cs b/dotnet/test/E2E/McpOAuthE2ETests.cs new file mode 100644 index 000000000..1085aba04 --- /dev/null +++ b/dotnet/test/E2E/McpOAuthE2ETests.cs @@ -0,0 +1,360 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using System.Diagnostics; +using System.Net.Http; +using System.Text.Json; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +public class McpOAuthE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "mcp_oauth", output) +{ + private const string ExpectedToken = "sdk-host-token"; + private const string RefreshToken = ExpectedToken + "-refresh"; + private const string UpscopeToken = ExpectedToken + "-upscope"; + private const string ReauthToken = ExpectedToken + "-reauth"; + + [Fact] + public async Task Should_Satisfy_MCP_OAuth_Using_Host_Provided_Token() + { + await using var oauthServer = await OAuthMcpServer.StartAsync(ExpectedToken); + var serverName = "oauth-protected-mcp"; + McpAuthContext? observedRequest = null; + + await using var session = await CreateSessionAsync(new SessionConfig + { + OnMcpAuthRequest = request => + { + observedRequest = request; + return Task.FromResult(McpAuthResult.FromToken(new McpAuthToken + { + AccessToken = ExpectedToken, + TokenType = "Bearer", + ExpiresIn = 3600 + })); + }, + McpServers = new Dictionary + { + [serverName] = new McpHttpServerConfig + { + Url = $"{oauthServer.Url}/mcp", + Tools = ["*"] + } + } + }); + + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + var tools = await session.Rpc.Mcp.ListToolsAsync(serverName); + Assert.Contains(tools.Tools, tool => tool.Name == "whoami"); + + Assert.NotNull(observedRequest); + Assert.NotEmpty(observedRequest!.RequestId); + Assert.Equal(serverName, observedRequest!.ServerName); + Assert.Equal($"{oauthServer.Url}/mcp", observedRequest.ServerUrl); + Assert.Equal(McpOauthRequestReason.Initial, observedRequest.Reason); + Assert.NotNull(observedRequest.WwwAuthenticateParams); + Assert.Equal($"{oauthServer.Url}/.well-known/oauth-protected-resource", observedRequest.WwwAuthenticateParams!.ResourceMetadataUrl); + Assert.Equal("mcp.read", observedRequest.WwwAuthenticateParams.Scope); + Assert.Equal("invalid_token", observedRequest.WwwAuthenticateParams.Error); + + using var metadata = JsonDocument.Parse(observedRequest.ResourceMetadata!); + Assert.Equal($"{oauthServer.Url}/mcp", metadata.RootElement.GetProperty("resource").GetString()); + + var requests = await oauthServer.GetRequestsAsync(); + Assert.Contains(requests, request => request.Authorization is null); + Assert.Contains(requests, request => request.Authorization == $"Bearer {ExpectedToken}"); + } + + [Fact] + public async Task Should_Resolve_Pending_MCP_OAuth_Request_With_Direct_Rpc() + { + await using var oauthServer = await OAuthMcpServer.StartAsync(ExpectedToken); + var serverName = "oauth-direct-rpc-mcp"; + var authRequest = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + var releaseHandler = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + + await using var session = await CreateSessionAsync(new SessionConfig + { + OnMcpAuthRequest = request => + { + authRequest.TrySetResult(request); + return releaseHandler.Task; + }, + McpServers = new Dictionary + { + [serverName] = new McpHttpServerConfig + { + Url = $"{oauthServer.Url}/mcp", + Tools = ["*"], + }, + }, + }); + + var connected = WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + var request = await authRequest.Task.WaitAsync(TimeSpan.FromSeconds(30)); + Assert.NotEmpty(request.RequestId); + Assert.Equal(serverName, request.ServerName); + Assert.Equal($"{oauthServer.Url}/mcp", request.ServerUrl); + Assert.Equal(McpOauthRequestReason.Initial, request.Reason); + Assert.NotNull(request.WwwAuthenticateParams); + Assert.Equal("mcp.read", request.WwwAuthenticateParams!.Scope); + + var handled = await session.Rpc.Mcp.Oauth.HandlePendingRequestAsync( + request.RequestId, + new McpOauthPendingRequestResponseToken + { + AccessToken = ExpectedToken, + TokenType = "Bearer", + ExpiresIn = 3600, + }); + Assert.True(handled.Success); + + await connected; + var tools = await session.Rpc.Mcp.ListToolsAsync(serverName); + Assert.Contains(tools.Tools, tool => tool.Name == "whoami"); + + releaseHandler.SetResult(McpAuthResult.FromToken(new McpAuthToken { AccessToken = ExpectedToken })); + } + + [Fact] + public async Task Should_Request_Replacement_Tokens_Across_MCP_OAuth_Lifecycle() + { + await using var oauthServer = await OAuthMcpServer.StartAsync(ExpectedToken); + var serverName = "oauth-lifecycle-mcp"; + List observedReasons = []; + var refreshCount = 0; + + await using var session = await CreateSessionAsync(new SessionConfig + { + EnableMcpApps = true, + OnMcpAuthRequest = request => + { + observedReasons.Add(request.Reason); + if (request.Reason == McpOauthRequestReason.Refresh) + { + refreshCount++; + Assert.NotNull(request.WwwAuthenticateParams); + Assert.Null(request.WwwAuthenticateParams!.ResourceMetadataUrl); + Assert.Equal("invalid_token", request.WwwAuthenticateParams.Error); + if (refreshCount > 1) + { + return Task.FromResult(McpAuthResult.Cancel()); + } + } + + if (request.Reason == McpOauthRequestReason.Upscope) + { + Assert.NotNull(request.WwwAuthenticateParams); + Assert.Equal($"{oauthServer.Url}/.well-known/oauth-protected-resource", request.WwwAuthenticateParams!.ResourceMetadataUrl); + Assert.Equal("mcp.write", request.WwwAuthenticateParams.Scope); + Assert.Equal("insufficient_scope", request.WwwAuthenticateParams.Error); + } + + var token = request.Reason == McpOauthRequestReason.Refresh + ? RefreshToken + : request.Reason == McpOauthRequestReason.Upscope + ? UpscopeToken + : request.Reason == McpOauthRequestReason.Reauth + ? ReauthToken + : ExpectedToken; + + return Task.FromResult(McpAuthResult.FromToken(new McpAuthToken + { + AccessToken = token + })); + }, + McpServers = new Dictionary + { + [serverName] = new McpHttpServerConfig + { + Url = $"{oauthServer.Url}/mcp", + Tools = ["*"] + } + } + }); + + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + await CallWhoamiAsync(session, serverName, "refresh"); + await CallWhoamiAsync(session, serverName, "upscope"); + await CallWhoamiAsync(session, serverName, "reauth"); + + Assert.Equal( + [ + McpOauthRequestReason.Initial, + McpOauthRequestReason.Refresh, + McpOauthRequestReason.Upscope, + McpOauthRequestReason.Refresh, + McpOauthRequestReason.Reauth + ], + observedReasons); + + var requests = await oauthServer.GetRequestsAsync(); + Assert.Contains(requests, request => request.Authorization == $"Bearer {RefreshToken}"); + Assert.Contains(requests, request => request.Authorization == $"Bearer {UpscopeToken}"); + Assert.Contains(requests, request => request.Authorization == $"Bearer {ReauthToken}"); + } + + [Fact] + public async Task Should_Cancel_Pending_MCP_OAuth_Request() + { + await using var oauthServer = await OAuthMcpServer.StartAsync(ExpectedToken); + var serverName = "oauth-cancelled-mcp"; + var authRequest = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + + await using var session = await CreateSessionAsync(new SessionConfig + { + OnMcpAuthRequest = request => + { + authRequest.TrySetResult(request); + return Task.FromResult(McpAuthResult.Cancel()); + }, + McpServers = new Dictionary + { + [serverName] = new McpHttpServerConfig + { + Url = $"{oauthServer.Url}/mcp", + Tools = ["*"] + } + } + }); + + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.NeedsAuth); + + // The MCP connection is kicked off by session.create, but the SDK only registers its + // `mcp.oauth_required` event interest once create returns. If the server's initial 401 + // wins that race, the runtime records `needs-auth` WITHOUT invoking the host callback, + // so the callback fires only on a later auth retry (now that interest is registered), + // with the same `Initial` reason. Await the callback rather than sampling it the instant + // `needs-auth` first appears, which is what made this test flaky. + var observedRequest = await authRequest.Task.WaitAsync(TimeSpan.FromSeconds(60)); + + Assert.NotEmpty(observedRequest.RequestId); + Assert.Equal(serverName, observedRequest.ServerName); + Assert.Equal(McpOauthRequestReason.Initial, observedRequest.Reason); + } + + private static async Task CallWhoamiAsync(CopilotSession session, string serverName, string scenario) + { + using var argumentDocument = JsonDocument.Parse($"{{\"scenario\":\"{scenario}\"}}"); + var result = await session.Rpc.Mcp.Apps.CallToolAsync( + serverName, + "whoami", + serverName, + new Dictionary + { + ["scenario"] = argumentDocument.RootElement.GetProperty("scenario").Clone() + }); + + var content = result["content"].EnumerateArray().ToList(); + Assert.Single(content); + Assert.Equal("oauth-test-user", content[0].GetProperty("text").GetString()); + } + + private sealed class OAuthMcpServer : IAsyncDisposable + { + private readonly Process _process; + private readonly HttpClient _http = new(); + + private OAuthMcpServer(Process process, string url) + { + _process = process; + Url = url; + } + + public string Url { get; } + + public static async Task StartAsync(string expectedToken) + { + var repoRoot = FindRepoRoot(); + var script = GetRepoRelativePath(repoRoot, "test", "harness", "test-mcp-oauth-server.mjs"); + var startInfo = new ProcessStartInfo + { + FileName = "node", + Arguments = QuoteProcessArgument(script), + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false + }; + startInfo.Environment["EXPECTED_TOKEN"] = expectedToken; + + var process = Process.Start(startInfo) + ?? throw new InvalidOperationException("Failed to start OAuth MCP server."); + var stderrTask = process.StandardError.ReadToEndAsync(); + + using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10)); + while (!cts.IsCancellationRequested) + { + var line = await process.StandardOutput.ReadLineAsync(cts.Token); + if (line is null) + { + throw new InvalidOperationException($"OAuth MCP server exited before listening: {await stderrTask}"); + } + if (line.StartsWith("Listening: ", StringComparison.Ordinal)) + { + return new OAuthMcpServer(process, line["Listening: ".Length..]); + } + } + + throw new TimeoutException($"Timed out waiting for OAuth MCP server: {await stderrTask}"); + } + + public async Task> GetRequestsAsync() + { + var json = await _http.GetStringAsync($"{Url}/__requests"); + using var document = JsonDocument.Parse(json); + return document.RootElement.EnumerateArray() + .Select(element => new OAuthMcpRequest( + element.TryGetProperty("authorization", out var authorization) + && authorization.ValueKind is JsonValueKind.String + ? authorization.GetString() + : null)) + .ToList(); + } + + public async ValueTask DisposeAsync() + { + _http.Dispose(); + if (!_process.HasExited) + { + _process.Kill(entireProcessTree: true); + await _process.WaitForExitAsync(); + } + _process.Dispose(); + } + + private static string FindRepoRoot() + { + var dir = new DirectoryInfo(AppContext.BaseDirectory); + while (dir != null) + { + var candidate = GetRepoRelativePath(dir.FullName, "test", "harness", "test-mcp-oauth-server.mjs"); + if (File.Exists(candidate)) + return dir.FullName; + dir = dir.Parent; + } + throw new InvalidOperationException("Could not find repository root."); + } + + private static string GetRepoRelativePath(string repoRoot, params string[] relativeSegments) + { + var path = repoRoot; + foreach (var segment in relativeSegments) + { + if (Path.IsPathRooted(segment)) + throw new ArgumentException("Repository-relative path segments must not be rooted.", nameof(relativeSegments)); + path = Path.Join(path, segment); + } + return Path.GetFullPath(path); + } + + private static string QuoteProcessArgument(string argument) + => "\"" + argument.Replace("\"", "\\\"") + "\""; + } + + private sealed record OAuthMcpRequest(string? Authorization); +} diff --git a/dotnet/test/E2E/ModeEmptyE2ETests.cs b/dotnet/test/E2E/ModeEmptyE2ETests.cs index df1bbc857..433e6a745 100644 --- a/dotnet/test/E2E/ModeEmptyE2ETests.cs +++ b/dotnet/test/E2E/ModeEmptyE2ETests.cs @@ -21,7 +21,7 @@ public class ModeEmptyE2ETests(E2ETestFixture fixture, ITestOutputHelper output) public async Task Empty_Mode_Isolated_Set_Shell_Tool_Is_Not_Exposed() { await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), @@ -45,7 +45,7 @@ public async Task Empty_Mode_Isolated_Set_Shell_Tool_Is_Not_Exposed() public async Task Empty_Mode_Builtin_Star_Exposes_All_Built_In_Tools() { await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn("*"), @@ -65,7 +65,7 @@ public async Task Empty_Mode_Excluded_Tools_Subtracts_From_Available_Tools() { var shellToolName = OperatingSystem.IsWindows() ? "powershell" : "bash"; await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn("*"), @@ -85,7 +85,7 @@ public async Task Empty_Mode_Excluded_Tools_Subtracts_From_Available_Tools() public async Task Empty_Mode_Strips_Environment_Context_From_The_System_Message_By_Default() { await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), @@ -109,7 +109,7 @@ public async Task Empty_Mode_Strips_Environment_Context_From_The_System_Message_ public async Task Empty_Mode_System_Message_Replace_Llm_Follows_Caller_Content_Verbatim() { await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), @@ -128,7 +128,7 @@ public async Task Empty_Mode_System_Message_Replace_Llm_Follows_Caller_Content_V public async Task Empty_Mode_Append_Caller_Instruction_Takes_Effect_And_Env_Context_Stripped() { await using var client = Ctx.CreateClient(options: EmptyModeOptions(Ctx)); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated), diff --git a/dotnet/test/E2E/ModeHandlersE2ETests.cs b/dotnet/test/E2E/ModeHandlersE2ETests.cs index 40552fa9f..b9f0e69b2 100644 --- a/dotnet/test/E2E/ModeHandlersE2ETests.cs +++ b/dotnet/test/E2E/ModeHandlersE2ETests.cs @@ -8,6 +8,7 @@ namespace GitHub.Copilot.Test.E2E; +[Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public class ModeHandlersE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "mode_handlers", output) { @@ -24,7 +25,7 @@ public async Task Should_Invoke_Exit_Plan_Mode_Handler_When_Model_Uses_Tool() TaskCreationOptions.RunContinuationsAsynchronously); await using var client = CreateAuthenticatedClient(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { GitHubToken = Token, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -60,7 +61,7 @@ public async Task Should_Invoke_Exit_Plan_Mode_Handler_When_Model_Uses_Tool() var (request, invocation) = await handlerTask.Task.WaitAsync(TimeSpan.FromSeconds(30)); Assert.Equal(session.SessionId, invocation.SessionId); Assert.Equal(summary, request.Summary); - Assert.Equal(["interactive", "autopilot", "exit_only"], request.Actions); + Assert.Equal(["autopilot", "interactive", "exit_only"], request.Actions); Assert.Equal("interactive", request.RecommendedAction); Assert.NotNull(request.PlanContent); @@ -92,7 +93,7 @@ public async Task Should_Invoke_Auto_Mode_Switch_Handler_When_Rate_Limited() TaskCreationOptions.RunContinuationsAsynchronously); await using var client = CreateAuthenticatedClient(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { GitHubToken = Token, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -155,7 +156,7 @@ private CopilotClient CreateAuthenticatedClient() ["COPILOT_DEBUG_GITHUB_API_URL"] = Ctx.ProxyUrl, }; - return Ctx.CreateClient(options: new CopilotClientOptions { Environment = env }); + return Ctx.CreateClient(environment: env); } private Task ConfigureAuthenticatedUserAsync() diff --git a/dotnet/test/E2E/MultiClientCommandsElicitationE2ETests.cs b/dotnet/test/E2E/MultiClientCommandsElicitationE2ETests.cs index d60c21709..d869dc816 100644 --- a/dotnet/test/E2E/MultiClientCommandsElicitationE2ETests.cs +++ b/dotnet/test/E2E/MultiClientCommandsElicitationE2ETests.cs @@ -59,7 +59,7 @@ public async Task InitializeAsync() await Ctx.ConfigureForTestAsync("multi_client", _testName); // Trigger connection so we can read the port - var initSession = await Client1.CreateSessionAsync(new SessionConfig + var initSession = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -102,7 +102,7 @@ public async Task DisposeAsync() [Fact] public async Task Client_Receives_Commands_Changed_When_Another_Client_Joins_With_Commands() { - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -120,7 +120,7 @@ public async Task Client_Receives_Commands_Changed_When_Another_Client_Joins_Wit }); // Client2 joins with commands - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Commands = @@ -148,7 +148,7 @@ public async Task Client_Receives_Commands_Changed_When_Another_Client_Joins_Wit public async Task Capabilities_Changed_Fires_When_Second_Client_Joins_With_Elicitation_Handler() { // Client1 creates session without elicitation - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -168,7 +168,7 @@ public async Task Capabilities_Changed_Fires_When_Second_Client_Joins_With_Elici }); // Client2 joins WITH elicitation handler — triggers capabilities.changed - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, OnElicitationRequest = _ => Task.FromResult(new ElicitationResult @@ -194,7 +194,7 @@ public async Task Capabilities_Changed_Fires_When_Second_Client_Joins_With_Elici public async Task Capabilities_Changed_Fires_When_Elicitation_Provider_Disconnects() { // Client1 creates session without elicitation - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -222,7 +222,7 @@ public async Task Capabilities_Changed_Fires_When_Elicitation_Provider_Disconnec }); // Client3 joins WITH elicitation handler - await _client3.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + await Ctx.ResumeSessionAsync(_client3, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, OnElicitationRequest = _ => Task.FromResult(new ElicitationResult diff --git a/dotnet/test/E2E/MultiClientE2ETests.cs b/dotnet/test/E2E/MultiClientE2ETests.cs index faaf38393..4dbe7190a 100644 --- a/dotnet/test/E2E/MultiClientE2ETests.cs +++ b/dotnet/test/E2E/MultiClientE2ETests.cs @@ -58,7 +58,7 @@ public async Task InitializeAsync() await Ctx.ConfigureForTestAsync("multi_client", _testName); // Trigger connection so we can read the port - var initSession = await Client1.CreateSessionAsync(new SessionConfig + var initSession = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -96,13 +96,13 @@ public async Task Both_Clients_See_Tool_Request_And_Completion_Events() { var tool = AIFunctionFactory.Create(MagicNumber, "magic_number"); - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Tools = [tool], }); - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -148,7 +148,7 @@ public async Task One_Client_Approves_Permission_And_Both_See_The_Result() { var client1PermissionRequests = new List(); - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = (request, _) => { @@ -158,7 +158,7 @@ public async Task One_Client_Approves_Permission_And_Both_See_The_Result() }); // Client 2 resumes — its handler never completes, so only client 1's approval takes effect - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = (_, _) => new TaskCompletionSource().Task, }); @@ -200,13 +200,13 @@ await session1.SendAsync(new MessageOptions [Fact] public async Task One_Client_Rejects_Permission_And_Both_See_The_Result() { - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = (_, _) => Task.FromResult(PermissionDecision.Reject()), }); // Client 2 resumes — its handler never completes - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = (_, _) => new TaskCompletionSource().Task, }); @@ -252,13 +252,13 @@ public async Task Two_Clients_Register_Different_Tools_And_Agent_Uses_Both() var toolA = AIFunctionFactory.Create(CityLookup, "city_lookup"); var toolB = AIFunctionFactory.Create(CurrencyLookup, "currency_lookup"); - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Tools = [toolA], }); - var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Tools = [toolB], @@ -294,13 +294,13 @@ public async Task Disconnecting_Client_Removes_Its_Tools() var toolA = AIFunctionFactory.Create(StableTool, "stable_tool"); var toolB = AIFunctionFactory.Create(EphemeralTool, "ephemeral_tool"); - var session1 = await Client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(Client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Tools = [toolA], }); - await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + await Ctx.ResumeSessionAsync(Client2, session1.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Tools = [toolB], diff --git a/dotnet/test/E2E/MultiProviderRegistryE2ETests.cs b/dotnet/test/E2E/MultiProviderRegistryE2ETests.cs new file mode 100644 index 000000000..80827cc86 --- /dev/null +++ b/dotnet/test/E2E/MultiProviderRegistryE2ETests.cs @@ -0,0 +1,209 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using System.Text.Json; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// End-to-end coverage for the experimental multi-provider BYOK registry +/// ( / ). +/// Validates that several named providers, several models per provider, and +/// custom agents bound to those provider-qualified models can coexist in one +/// session, be launched, and route inference to the configured provider with +/// the configured wire model and headers. +/// +[Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] +public class MultiProviderRegistryE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "multi_provider_registry", output) +{ + /// + /// Builds a heterogeneous registry: two providers of different types, with + /// multiple models each. Provider-qualified selection ids are + /// alpha/sonnet, alpha/haiku, beta/opus, beta/haiku. + /// + private static IList RegistryProviders() => + [ + new() + { + Name = "alpha", + Type = "openai", + WireApi = "completions", + BaseUrl = "https://alpha.example.test/v1", + ApiKey = "alpha-secret", + Headers = new Dictionary { ["X-Provider"] = "alpha" }, + }, + new() + { + Name = "beta", + Type = "anthropic", + BaseUrl = "https://beta.example.test", + BearerToken = "beta-bearer", + Headers = new Dictionary { ["X-Provider"] = "beta" }, + }, + ]; + + private static IList RegistryModels() => + [ + new() { Id = "sonnet", Provider = "alpha", WireModel = "byok-gpt-4o", MaxPromptTokens = 111111 }, + new() { Id = "haiku", Provider = "alpha", WireModel = "byok-gpt-4o-mini" }, + new() { Id = "opus", Provider = "beta", WireModel = "byok-claude-3-opus" }, + new() { Id = "haiku", Provider = "beta", WireModel = "byok-claude-3-haiku" }, + ]; + + private static IList RegistryAgents() => + [ + new() { Name = "orchestrator", DisplayName = "Orchestrator", Description = "Top-level planner.", Prompt = "Plan and delegate.", Model = "alpha/sonnet" }, + new() { Name = "researcher", DisplayName = "Researcher", Description = "Deep research subagent.", Prompt = "Research thoroughly.", Model = "beta/opus" }, + new() { Name = "fast-helper", DisplayName = "Fast Helper", Description = "Quick subagent.", Prompt = "Answer quickly.", Model = "alpha/haiku" }, + new() { Name = "summarizer", DisplayName = "Summarizer", Description = "Summarizing subagent.", Prompt = "Summarize.", Model = "beta/haiku" }, + ]; + + [Fact] + public async Task Should_Register_Multiple_Providers_With_Custom_Agents_Bound_To_Their_Models() + { + var session = await CreateSessionAsync(new SessionConfig + { + Providers = RegistryProviders(), + Models = RegistryModels(), + CustomAgents = RegistryAgents(), + }); + + var agents = (await session.Rpc.Agent.ListAsync()).Agents; + + // All four custom agents coexist in a single session. + Assert.Equal(4, agents.Count); + + // Each agent is bound to its configured provider-qualified BYOK model. + AssertAgentModel(agents, "orchestrator", "alpha/sonnet", "Orchestrator", "Top-level planner."); + AssertAgentModel(agents, "researcher", "beta/opus", "Researcher", "Deep research subagent."); + AssertAgentModel(agents, "fast-helper", "alpha/haiku", "Fast Helper", "Quick subagent."); + AssertAgentModel(agents, "summarizer", "beta/haiku", "Summarizer", "Summarizing subagent."); + + // Models from BOTH providers are represented, proving the two providers + // and their models coexist within the same session. + var boundModels = agents.Select(a => a.Model).ToHashSet(); + Assert.Contains(boundModels, m => m!.StartsWith("alpha/", StringComparison.Ordinal)); + Assert.Contains(boundModels, m => m!.StartsWith("beta/", StringComparison.Ordinal)); + } + + [Fact] + public async Task Should_Route_Alpha_Sonnet_Turn_To_Its_Provider_And_Wire_Model() + => await AssertRoutingAsync("alpha/sonnet", "byok-gpt-4o", "alpha"); + + [Fact] + public async Task Should_Route_Alpha_Haiku_Turn_To_Its_Provider_And_Wire_Model() + => await AssertRoutingAsync("alpha/haiku", "byok-gpt-4o-mini", "alpha"); + + [Fact] + public async Task Should_Route_Delta_Turbo_Turn_To_Its_Provider_And_Wire_Model() + => await AssertRoutingAsync("delta/turbo", "byok-gpt-4-turbo", "delta"); + + /// + /// Selects in a session whose registry holds + /// two OpenAI-compatible providers (each pointed at the replay proxy), runs a + /// turn, and asserts the captured request used the model's configured wire + /// model and carried the owning provider's header and credential. + /// + private async Task AssertRoutingAsync(string selectionId, string expectedWireModel, string expectedProviderHeader) + { + // Two OpenAI-compatible providers, both pointed at the replay proxy so + // their /chat/completions traffic is captured. They are distinguished on + // the wire by their per-provider X-Provider header. "alpha" carries two + // models (multiple models per provider); "delta" carries one. + var providers = new List + { + new() + { + Name = "alpha", + Type = "openai", + WireApi = "completions", + BaseUrl = Ctx.ProxyUrl, + ApiKey = "alpha-secret", + Headers = new Dictionary { ["X-Provider"] = "alpha" }, + }, + new() + { + Name = "delta", + Type = "openai", + WireApi = "completions", + BaseUrl = Ctx.ProxyUrl, + ApiKey = "delta-secret", + Headers = new Dictionary { ["X-Provider"] = "delta" }, + }, + }; + var models = new List + { + new() { Id = "sonnet", Provider = "alpha", WireModel = "byok-gpt-4o" }, + new() { Id = "haiku", Provider = "alpha", WireModel = "byok-gpt-4o-mini" }, + new() { Id = "turbo", Provider = "delta", WireModel = "byok-gpt-4-turbo" }, + }; + + var session = await CreateSessionAsync(new SessionConfig + { + Model = selectionId, + Providers = providers, + Models = models, + }); + + var exchanges = await SendAndWaitForExchangesAsync( + session, + new MessageOptions { Prompt = "What is 5+5?" }); + + var exchange = Assert.Single(exchanges); + + // The wire model sent to the provider is the selected model's WireModel, + // not its provider-qualified selection id. + Assert.Equal(expectedWireModel, exchange.Request.Model); + + // The request carried the owning provider's custom header, proving the + // turn was dispatched against the correct provider connection. + Assert.Equal(expectedProviderHeader, GetHeaderValue(exchange, "X-Provider")); + + // The provider's API key was applied as an Authorization header. + Assert.False(string.IsNullOrEmpty(GetHeaderValue(exchange, "Authorization"))); + } + + private static void AssertAgentModel( + IEnumerable agents, + string name, + string expectedModel, + string expectedDisplayName, + string expectedDescription) + { + var agent = Assert.Single(agents, a => string.Equals(a.Name, name, StringComparison.Ordinal)); + Assert.Equal(expectedModel, agent.Model); + Assert.Equal(expectedDisplayName, agent.DisplayName); + Assert.Equal(expectedDescription, agent.Description); + } + + private static string? GetHeaderValue(ParsedHttpExchange exchange, string name) + { + if (exchange.RequestHeaders == null) + { + return null; + } + + foreach (var kv in exchange.RequestHeaders) + { + if (!string.Equals(kv.Key, name, StringComparison.OrdinalIgnoreCase)) + { + continue; + } + + return kv.Value.ValueKind switch + { + JsonValueKind.String => kv.Value.GetString(), + JsonValueKind.Array when kv.Value.GetArrayLength() > 0 => kv.Value[0].GetString(), + _ => kv.Value.ToString(), + }; + } + + return null; + } +} diff --git a/dotnet/test/E2E/PendingWorkResumeE2ETests.cs b/dotnet/test/E2E/PendingWorkResumeE2ETests.cs index 9cc0785bf..b3ca21819 100644 --- a/dotnet/test/E2E/PendingWorkResumeE2ETests.cs +++ b/dotnet/test/E2E/PendingWorkResumeE2ETests.cs @@ -24,14 +24,13 @@ public async Task Should_Continue_Pending_Permission_Request_After_Resume() { var originalPermissionRequest = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); var releaseOriginalPermission = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); - var resumedToolInvoked = false; await using var server = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForTcp(connectionToken: SharedToken) }); await server.StartAsync(); var cliUrl = GetCliUrl(server); using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(suspendedClient, new SessionConfig { Tools = [AIFunctionFactory.Create(ResumePermissionTool, "resume_permission_tool")], OnPermissionRequest = (request, _) => @@ -58,7 +57,7 @@ await session1.SendAsync(new MessageOptions await suspendedClient.ForceStopAsync(); await using var resumedTcpClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session2 = await resumedTcpClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(resumedTcpClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = (_, _) => Task.FromResult(PermissionDecision.NoResult()), @@ -66,10 +65,7 @@ await session1.SendAsync(new MessageOptions [ AIFunctionFactory.Create( ([Description("Value to transform")] string value) => - { - resumedToolInvoked = true; - return $"PERMISSION_RESUMED_{value.ToUpperInvariant()}"; - }, + $"PERMISSION_RESUMED_{value.ToUpperInvariant()}", "resume_permission_tool") ], }); @@ -79,11 +75,6 @@ await session1.SendAsync(new MessageOptions new RpcPermissionDecisionApproveOnce()); Assert.True(permissionResult.Success); - var answer = await TestHelper.GetFinalAssistantMessageAsync(session2, PendingWorkTimeout); - - Assert.True(resumedToolInvoked); - Assert.Contains("PERMISSION_RESUMED_ALPHA", answer?.Data.Content ?? string.Empty); - await session2.DisposeAsync(); await resumedTcpClient.ForceStopAsync(); } @@ -108,7 +99,7 @@ public async Task Should_Continue_Pending_External_Tool_Request_After_Resume() var cliUrl = GetCliUrl(server); using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(suspendedClient, new SessionConfig { Tools = [AIFunctionFactory.Create(BlockingExternalTool, "resume_external_tool")], OnPermissionRequest = PermissionHandler.ApproveAll, @@ -129,7 +120,7 @@ await session1.SendAsync(new MessageOptions await suspendedClient.ForceStopAsync(); await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session2 = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(resumedClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -140,10 +131,6 @@ await session1.SendAsync(new MessageOptions result: JsonDocument.Parse("\"EXTERNAL_RESUMED_BETA\"").RootElement.Clone()); Assert.True(toolResult.Success); - var answer = await TestHelper.GetFinalAssistantMessageAsync(session2, PendingWorkTimeout); - - Assert.Contains("EXTERNAL_RESUMED_BETA", answer?.Data.Content ?? string.Empty); - await session2.DisposeAsync(); await resumedClient.ForceStopAsync(); } @@ -161,7 +148,23 @@ async Task BlockingExternalTool([Description("Value to look up")] string } [Fact] - public async Task Should_Keep_Pending_External_Tool_Handleable_On_Warm_Resume_When_ContinuePendingWork_Is_False() + public Task Should_Keep_Pending_External_Tool_Handleable_On_Warm_Resume_When_ContinuePendingWork_Is_False() => + AssertPendingExternalToolHandleableOnResumeAsync( + disconnectOriginalClient: false, + expectedSessionWasActive: true, + expectedHandleResult: true); + + [Fact] + public Task Should_Keep_Pending_External_Tool_Handleable_On_Cold_Resume_When_ContinuePendingWork_Is_False() => + AssertPendingExternalToolHandleableOnResumeAsync( + disconnectOriginalClient: true, + expectedSessionWasActive: false, + expectedHandleResult: false); + + private async Task AssertPendingExternalToolHandleableOnResumeAsync( + bool disconnectOriginalClient, + bool expectedSessionWasActive, + bool expectedHandleResult) { var originalToolStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); var releaseOriginalTool = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); @@ -172,7 +175,7 @@ public async Task Should_Keep_Pending_External_Tool_Handleable_On_Warm_Resume_Wh var cliUrl = GetCliUrl(server); using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(suspendedClient, new SessionConfig { Tools = [AIFunctionFactory.Create(BlockingExternalTool, "resume_external_tool")], OnPermissionRequest = PermissionHandler.ApproveAll, @@ -191,28 +194,54 @@ await session1.SendAsync(new MessageOptions var toolEvent = await toolRequested; Assert.Equal("beta", await originalToolStarted.Task.WaitAsync(PendingWorkTimeout)); - await suspendedClient.ForceStopAsync(); + if (disconnectOriginalClient) + { + await suspendedClient.ForceStopAsync(); + } await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session2 = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + + // In warm mode the original client still owns the tool registration; + // re-registering it from the resumed client would cause a name-clash. In + // cold mode the original is gone, so we register a fresh throwing handler + // to assert the runtime doesn't re-invoke the tool on resume (orphan + // auto-completion happens internally). + var resumeConfig = new ResumeSessionConfig { ContinuePendingWork = false, OnPermissionRequest = PermissionHandler.ApproveAll, - }); + }; + if (disconnectOriginalClient) + { + resumeConfig.Tools = [AIFunctionFactory.Create(ResumedExternalTool, "resume_external_tool")]; + } + + var session2 = await Ctx.ResumeSessionAsync(resumedClient, sessionId, resumeConfig); var resumeEvent = await GetSingleResumeEventAsync(session2); Assert.Equal(false, resumeEvent.Data.ContinuePendingWork); - Assert.Equal(true, resumeEvent.Data.SessionWasActive); + Assert.Equal(expectedSessionWasActive, resumeEvent.Data.SessionWasActive); + // Warm: the runtime still has the pending request and HandlePendingToolCall + // will succeed. + // Cold: the runtime auto-completed the orphaned tool call with a synthetic + // interrupt result during resume, so HandlePendingToolCall correctly reports + // success=false. The session should still be healthy for new turns. var resumedResult = await session2.Rpc.Tools.HandlePendingToolCallAsync( toolEvent.Data.RequestId, result: JsonDocument.Parse("\"EXTERNAL_RESUMED_BETA\"").RootElement.Clone()); - Assert.True(resumedResult.Success); - - // continuePendingWork=false may interrupt agent continuation before this response, - // but the pending call should still accept an explicit completion. + Assert.Equal(expectedHandleResult, resumedResult.Success); Assert.Equal(1, invocationCount); + if (!expectedHandleResult) + { + var followUp = await session2.SendAndWaitAsync(new MessageOptions + { + Prompt = "Reply with exactly: COLD_RESUMED_FOLLOWUP", + }); + Assert.Contains("COLD_RESUMED_FOLLOWUP", followUp?.Data.Content ?? string.Empty); + } + await session2.DisposeAsync(); await resumedClient.ForceStopAsync(); } @@ -228,6 +257,10 @@ async Task BlockingExternalTool([Description("Value to look up")] string originalToolStarted.TrySetResult(value); return await releaseOriginalTool.Task; } + + [Description("Looks up a value after resumption")] + string ResumedExternalTool([Description("Value to look up")] string value) => + throw new InvalidOperationException("Resumed-session handler should not be invoked"); } [Fact] @@ -243,7 +276,7 @@ public async Task Should_Continue_Parallel_Pending_External_Tool_Requests_After_ var cliUrl = GetCliUrl(server); using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(suspendedClient, new SessionConfig { Tools = [ @@ -273,7 +306,7 @@ await Task.WhenAll( await suspendedClient.ForceStopAsync(); await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var session2 = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(resumedClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -324,7 +357,7 @@ public async Task Should_Resume_Successfully_When_No_Pending_Work_Exists() string sessionId; await using (var firstClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) })) { - var firstSession = await firstClient.CreateSessionAsync(new SessionConfig + var firstSession = await Ctx.CreateSessionAsync(firstClient, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -337,7 +370,7 @@ public async Task Should_Resume_Successfully_When_No_Pending_Work_Exists() } await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var resumedSession = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var resumedSession = await Ctx.ResumeSessionAsync(resumedClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -362,7 +395,7 @@ public async Task Should_Report_ContinuePendingWork_True_In_Resume_Event() string sessionId; await using (var firstClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) })) { - var firstSession = await firstClient.CreateSessionAsync(new SessionConfig + var firstSession = await Ctx.CreateSessionAsync(firstClient, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -378,7 +411,7 @@ public async Task Should_Report_ContinuePendingWork_True_In_Resume_Event() } await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: SharedToken) }); - var resumedSession = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var resumedSession = await Ctx.ResumeSessionAsync(resumedClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = PermissionHandler.ApproveAll, diff --git a/dotnet/test/E2E/PerSessionAuthE2ETests.cs b/dotnet/test/E2E/PerSessionAuthE2ETests.cs index 6bc92f08d..4b370768a 100644 --- a/dotnet/test/E2E/PerSessionAuthE2ETests.cs +++ b/dotnet/test/E2E/PerSessionAuthE2ETests.cs @@ -8,6 +8,7 @@ namespace GitHub.Copilot.Test.E2E; +[Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public class PerSessionAuthE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "per-session-auth", output) { /// @@ -22,7 +23,7 @@ private CopilotClient CreateAuthTestClient() }; // Disable the harness's auto-injected client token so the per-session // auth tests validate only session-scoped tokens. - return Ctx.CreateClient(options: new CopilotClientOptions { Environment = env }, autoInjectGitHubToken: false); + return Ctx.CreateClient(environment: env, autoInjectGitHubToken: false); } private CopilotClient CreateNoAuthTestClient() @@ -32,9 +33,8 @@ private CopilotClient CreateNoAuthTestClient() return Ctx.CreateClient(options: new CopilotClientOptions { - Environment = env, UseLoggedInUser = false, - }, autoInjectGitHubToken: false); + }, autoInjectGitHubToken: false, environment: env); } private static Dictionary WithoutAuthEnv(Dictionary env) @@ -75,13 +75,13 @@ public async Task ShouldAuthenticateWithGitHubToken() { await SetupCopilotUsersAsync(); - await using var session = await AuthClient.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(AuthClient, new SessionConfig { GitHubToken = "token-alice", OnPermissionRequest = PermissionHandler.ApproveAll, }); - var status = await session.Rpc.Auth.GetStatusAsync(); + var status = await session.Rpc.GitHubAuth.GetStatusAsync(); Assert.True(status.IsAuthenticated); Assert.Equal("alice", status.Login); } @@ -91,23 +91,23 @@ public async Task ShouldIsolateAuthBetweenSessions() { await SetupCopilotUsersAsync(); - await using var sessionA = await AuthClient.CreateSessionAsync(new SessionConfig + await using var sessionA = await Ctx.CreateSessionAsync(AuthClient, new SessionConfig { GitHubToken = "token-alice", OnPermissionRequest = PermissionHandler.ApproveAll, }); - await using var sessionB = await AuthClient.CreateSessionAsync(new SessionConfig + await using var sessionB = await Ctx.CreateSessionAsync(AuthClient, new SessionConfig { GitHubToken = "token-bob", OnPermissionRequest = PermissionHandler.ApproveAll, }); - var statusA = await sessionA.Rpc.Auth.GetStatusAsync(); + var statusA = await sessionA.Rpc.GitHubAuth.GetStatusAsync(); Assert.True(statusA.IsAuthenticated); Assert.Equal("alice", statusA.Login); - var statusB = await sessionB.Rpc.Auth.GetStatusAsync(); + var statusB = await sessionB.Rpc.GitHubAuth.GetStatusAsync(); Assert.True(statusB.IsAuthenticated); Assert.Equal("bob", statusB.Login); } @@ -117,12 +117,12 @@ public async Task ShouldBeUnauthenticatedWithoutToken() { var noAuthClient = CreateNoAuthTestClient(); - await using var session = await noAuthClient.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(noAuthClient, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); - var status = await session.Rpc.Auth.GetStatusAsync(); + var status = await session.Rpc.GitHubAuth.GetStatusAsync(); // Without a per-session GitHub token, there is no per-session identity. Assert.True(string.IsNullOrEmpty(status.Login), $"Expected no per-session login without token, got {status.Login}"); } @@ -132,7 +132,7 @@ public async Task ShouldFailWithInvalidToken() { await SetupCopilotUsersAsync(); - var ex = await Assert.ThrowsAnyAsync(() => AuthClient.CreateSessionAsync(new SessionConfig + var ex = await Assert.ThrowsAnyAsync(() => Ctx.CreateSessionAsync(AuthClient, new SessionConfig { GitHubToken = "invalid-token", OnPermissionRequest = PermissionHandler.ApproveAll, diff --git a/dotnet/test/E2E/PermissionE2ETests.cs b/dotnet/test/E2E/PermissionE2ETests.cs index c4f3f108b..2225dcba8 100644 --- a/dotnet/test/E2E/PermissionE2ETests.cs +++ b/dotnet/test/E2E/PermissionE2ETests.cs @@ -205,7 +205,7 @@ public async Task Should_Resume_Session_With_Permission_Handler() await session1.DisposeAsync(); // Resume with permission handler - var session2 = await Client.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client, sessionId, new ResumeSessionConfig { OnPermissionRequest = (request, invocation) => { @@ -279,7 +279,7 @@ public async Task Should_Deny_Tool_Operations_When_Handler_Explicitly_Denies_Aft await session1.SendAndWaitAsync(new MessageOptions { Prompt = "What is 1+1?" }); await session1.DisposeAsync(); - var session2 = await Client.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(Client, sessionId, new ResumeSessionConfig { OnPermissionRequest = (_, _) => Task.FromResult(PermissionDecision.UserNotAvailable()) @@ -377,7 +377,7 @@ void AddLifecycleEvent(string phase, string? toolCallId) } }); - await session.SendAsync(new MessageOptions + var sendTask = session.SendAndWaitAsync(new MessageOptions { Prompt = "Run 'echo slow_handler_test'" }); @@ -391,7 +391,13 @@ await session.SendAsync(new MessageOptions releaseHandler.SetResult(); - var message = await TestHelper.GetFinalAssistantMessageAsync(session); + var message = await sendTask; + var persistedEvents = await WaitForPersistedEventsAsync( + session, + events => + events.OfType().Any(evt => evt.Data.ToolCallId == targetToolId) && + events.OfType().Any(evt => evt.Data.ToolCallId == targetToolId), + $"Timed out waiting for persisted tool lifecycle for tool call '{targetToolId}'."); List<(string Phase, string? ToolCallId)> orderedLifecycle; lock (lifecycleLock) @@ -401,20 +407,23 @@ await session.SendAsync(new MessageOptions var permissionStartIndex = orderedLifecycle.FindIndex(evt => evt.Phase == "permission-start" && evt.ToolCallId == targetToolId); var permissionCompleteIndex = orderedLifecycle.FindIndex(evt => evt.Phase == "permission-complete" && evt.ToolCallId == targetToolId); - var toolStartIndex = orderedLifecycle.FindIndex(evt => evt.Phase == "tool-start" && evt.ToolCallId == targetToolId); - var toolCompleteIndex = orderedLifecycle.FindIndex(evt => evt.Phase == "tool-complete" && evt.ToolCallId == targetToolId); var observedLifecycle = string.Join(", ", orderedLifecycle.Select(evt => $"{evt.Phase}:{evt.ToolCallId}")); + var toolStartIndex = persistedEvents.FindIndex(evt => + evt is ToolExecutionStartEvent started && started.Data.ToolCallId == targetToolId); + var toolCompleteIndex = persistedEvents.FindIndex(evt => + evt is ToolExecutionCompleteEvent completed && completed.Data.ToolCallId == targetToolId); + var observedPersistedEvents = string.Join(", ", persistedEvents.Select(DescribeEvent)); Assert.InRange(permissionStartIndex, 0, orderedLifecycle.Count - 1); Assert.InRange(permissionCompleteIndex, 0, orderedLifecycle.Count - 1); - Assert.InRange(toolStartIndex, 0, orderedLifecycle.Count - 1); - Assert.InRange(toolCompleteIndex, 0, orderedLifecycle.Count - 1); Assert.True( - permissionCompleteIndex < toolCompleteIndex, - $"Expected permission completion before target tool completion. Observed: {observedLifecycle}"); + permissionStartIndex < permissionCompleteIndex, + $"Expected permission handler to complete after it started. Observed: {observedLifecycle}"); + Assert.InRange(toolStartIndex, 0, persistedEvents.Count - 1); + Assert.InRange(toolCompleteIndex, 0, persistedEvents.Count - 1); Assert.True( toolStartIndex < toolCompleteIndex, - $"Expected target tool start before target tool completion. Observed: {observedLifecycle}"); + $"Expected target tool start before target tool completion. Observed: {observedPersistedEvents}"); // The tool should have actually run after permission was granted Assert.Contains("slow_handler_test", message?.Data.Content ?? string.Empty); @@ -573,24 +582,21 @@ public async Task Should_Short_Circuit_Permission_Handler_When_Set_Approve_All_E try { - var toolCompleted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); - using var subscription = session.On(evt => - { - if (evt is ToolExecutionCompleteEvent done && done.Data.Success) - { - toolCompleted.TrySetResult(done); - } - }); - await session.SendAndWaitAsync(new MessageOptions { Prompt = "Run 'echo test' and tell me what happens", }); - // A real shell tool must have completed successfully under the runtime-level approval. - await toolCompleted.Task.WaitAsync(TimeSpan.FromSeconds(30)); + var persistedEvents = await WaitForPersistedEventsAsync( + session, + events => events.OfType().Any(evt => + evt.Data.Success && ToolCompleteContains(evt, "test")), + "Timed out waiting for persisted successful shell tool completion."); Assert.Equal(0, Volatile.Read(ref handlerCallCount)); + Assert.Contains( + persistedEvents.OfType(), + evt => evt.Data.Success && ToolCompleteContains(evt, "test")); } finally { @@ -758,6 +764,40 @@ private static bool PathsEqual(string expected, string actual) OperatingSystem.IsWindows() ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal); } + private static async Task> WaitForPersistedEventsAsync( + CopilotSession session, + Func, bool> condition, + string timeoutMessage) + { + List events = []; + await TestHelper.WaitForConditionAsync( + async () => + { + events = (await session.GetEventsAsync()).ToList(); + return condition(events); + }, + timeoutMessage: timeoutMessage); + return events; + } + + private static string DescribeEvent(SessionEvent evt) + => evt switch + { + ToolExecutionStartEvent started => $"{evt.Type}:{started.Data.ToolCallId}", + ToolExecutionCompleteEvent completed => $"{evt.Type}:{completed.Data.ToolCallId}:{completed.Data.Success}", + _ => evt.Type, + }; + + private static bool ToolCompleteContains(ToolExecutionCompleteEvent evt, string expected) + => evt.Data.Result?.Content.Contains(expected, StringComparison.OrdinalIgnoreCase) == true || + evt.Data.Result?.DetailedContent?.Contains(expected, StringComparison.OrdinalIgnoreCase) == true || + evt.Data.Result?.Contents?.Any(content => content switch + { + ToolExecutionCompleteContentText text => text.Text.Contains(expected, StringComparison.OrdinalIgnoreCase), + ToolExecutionCompleteContentTerminal terminal => terminal.Text.Contains(expected, StringComparison.OrdinalIgnoreCase), + _ => false, + }) == true; + private static string NormalizePath(string path) { var fullPath = Path.GetFullPath(path); diff --git a/dotnet/test/E2E/PreMcpToolCallHookE2ETests.cs b/dotnet/test/E2E/PreMcpToolCallHookE2ETests.cs index 8e5240a9a..02f860614 100644 --- a/dotnet/test/E2E/PreMcpToolCallHookE2ETests.cs +++ b/dotnet/test/E2E/PreMcpToolCallHookE2ETests.cs @@ -20,7 +20,7 @@ private static string FindMetaEchoTestHarnessDir() var dir = new DirectoryInfo(AppContext.BaseDirectory); while (dir != null) { - var candidate = Path.Combine(dir.FullName, "test", "harness", "test-mcp-meta-echo-server.mjs"); + var candidate = Path.Join(dir.FullName, "test", "harness", "test-mcp-meta-echo-server.mjs"); if (File.Exists(candidate)) return Path.GetDirectoryName(candidate)!; dir = dir.Parent; @@ -33,7 +33,7 @@ private static string FindMetaEchoTestHarnessDir() ["meta-echo"] = new McpStdioServerConfig { Command = "node", - Args = [Path.Combine(testHarnessDir, "test-mcp-meta-echo-server.mjs")], + Args = [Path.Join(testHarnessDir, "test-mcp-meta-echo-server.mjs")], WorkingDirectory = testHarnessDir, Tools = ["*"] } diff --git a/dotnet/test/E2E/ProviderEndpointE2ETests.cs b/dotnet/test/E2E/ProviderEndpointE2ETests.cs new file mode 100644 index 000000000..d2bf06982 --- /dev/null +++ b/dotnet/test/E2E/ProviderEndpointE2ETests.cs @@ -0,0 +1,121 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using System.Text.RegularExpressions; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +public class ProviderEndpointE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "provider-endpoint", output) +{ + /// + /// Creates a client with the provider-endpoint API opt-in env var + /// (COPILOT_ALLOW_GET_PROVIDER_ENDPOINT) set on the CLI subprocess. + /// + private CopilotClient CreateProviderEndpointClient() + { + var env = new Dictionary(Ctx.GetEnvironment()) + { + ["COPILOT_ALLOW_GET_PROVIDER_ENDPOINT"] = "true", + }; + return Ctx.CreateClient(environment: env); + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task ShouldReturnByokProviderEndpointWhenCustomProviderIsConfigured() + { + var client = CreateProviderEndpointClient(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + Provider = new ProviderConfig + { + Type = "openai", + WireApi = "completions", + BaseUrl = "https://api.example.test/v1", + ApiKey = "byok-secret", + Headers = new Dictionary { ["X-Custom-Header"] = "byok-yes" }, + }, + }); + + try + { + var endpoint = await session.Rpc.Provider.GetEndpointAsync(); + + Assert.Equal(ProviderEndpointType.Openai, endpoint.Type); + Assert.Equal(ProviderEndpointWireApi.Completions, endpoint.WireApi); + Assert.Equal("https://api.example.test/v1", endpoint.BaseUrl); + Assert.Equal("byok-secret", endpoint.ApiKey); + Assert.Equal("byok-yes", endpoint.Headers["X-Custom-Header"]); + // BYOK sessions never issue a CAPI session token. + Assert.Null(endpoint.SessionToken); + } + finally + { + try { await session.DisposeAsync(); } + catch { /* disconnect may fail since the BYOK provider URL is fake */ } + } + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] + public async Task ShouldReturnCapiProviderEndpointForOAuthAuthenticatedSession() + { + var client = CreateProviderEndpointClient(); + + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + var endpoint = await session.Rpc.Provider.GetEndpointAsync(); + + Assert.True( + endpoint.Type == ProviderEndpointType.Openai + || endpoint.Type == ProviderEndpointType.Azure + || endpoint.Type == ProviderEndpointType.Anthropic, + $"unexpected endpoint.Type {endpoint.Type}"); + // wireApi is omitted for anthropic; otherwise one of the OpenAI shapes. + if (endpoint.Type != ProviderEndpointType.Anthropic) + { + Assert.True( + endpoint.WireApi == ProviderEndpointWireApi.Completions + || endpoint.WireApi == ProviderEndpointWireApi.Responses, + $"unexpected endpoint.WireApi {endpoint.WireApi}"); + } + + // CAPI baseUrl is the (proxy) Copilot API URL injected by the harness. + Assert.Matches(@"^https?://", endpoint.BaseUrl); + + // For CAPI OAuth sessions the apiKey is the resolved GitHub bearer. + Assert.False(string.IsNullOrEmpty(endpoint.ApiKey)); + + // Standard CAPI headers should be present, and Authorization is + // surfaced as the runtime sends it (`Bearer `). + Assert.False(string.IsNullOrEmpty(endpoint.Headers["Copilot-Integration-Id"])); + Assert.Matches(new Regex("Copilot", RegexOptions.IgnoreCase), endpoint.Headers["User-Agent"]); + Assert.False(string.IsNullOrEmpty(endpoint.Headers["X-GitHub-Api-Version"])); + Assert.Matches(@"[0-9a-f-]{8,}", endpoint.Headers["X-Interaction-Id"]); + Assert.Equal($"Bearer {endpoint.ApiKey}", endpoint.Headers["Authorization"]); + + // When the omit-modelId path returned an auto-mode session token, it + // must use the documented header name. The harness may have a non-auto + // model selected, in which case the field is simply omitted. + if (endpoint.SessionToken != null) + { + Assert.Equal("Copilot-Session-Token", endpoint.SessionToken.Header); + Assert.False(string.IsNullOrEmpty(endpoint.SessionToken.Token)); + if (endpoint.SessionToken.ExpiresAt.HasValue) + { + Assert.True(endpoint.SessionToken.ExpiresAt.Value > DateTimeOffset.MinValue); + } + } + } +} diff --git a/dotnet/test/E2E/RewindE2ETests.cs b/dotnet/test/E2E/RewindE2ETests.cs new file mode 100644 index 000000000..ced06b93f --- /dev/null +++ b/dotnet/test/E2E/RewindE2ETests.cs @@ -0,0 +1,81 @@ +// Copyright (c) GitHub, Inc. +// Licensed under the MIT License. + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; + +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +public class RewindE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rewind", output) +{ + private const string FileName = "rewind-sdk.txt"; + private const string FileContent = "SDK rewind content"; + + [Fact] + public async Task Should_Restore_Tracked_File_And_Conversation() + { + var filePath = Path.Join(Ctx.WorkDir, FileName); + await using var session = await CreateSessionAsync(new SessionConfig + { + Model = "claude-sonnet-4.5", + EnableFileChangeTracking = true, + }); + + var response = await session.SendAndWaitAsync( + new MessageOptions + { + Prompt = $"Use the create tool to create {FileName} containing exactly {FileContent}. " + + "After the tool succeeds, reply with exactly SDK_REWIND_DONE.", + }, + TimeSpan.FromSeconds(30)); + + Assert.Equal("SDK_REWIND_DONE", response?.Data.Content); + Assert.True(File.Exists(filePath)); + Assert.Equal(FileContent, await File.ReadAllTextAsync(filePath)); + + HistoryListRewindPointsResult? rewindPoints = null; + await TestHelper.WaitForConditionAsync( + async () => + { + rewindPoints = await session.Rpc.History.ListRewindPointsAsync(); + return rewindPoints.UnavailableReason is null; + }, + timeout: TimeSpan.FromSeconds(10), + timeoutMessage: "Timed out waiting for rewind points to become available.", + pollInterval: TimeSpan.FromMilliseconds(100)); + + Assert.NotNull(rewindPoints); + Assert.True(rewindPoints.FileChangeTrackingEnabled); + var rewindPoint = Assert.Single(rewindPoints.Points); + Assert.True(rewindPoint.CanRestoreFiles); + Assert.Equal(1, rewindPoint.FileCount); + + var preview = await session.Rpc.History.PreviewRewindAsync(rewindPoint.EventId); + Assert.True(preview.Available); + var previewFile = Assert.Single(preview.Files); + Assert.Equal( + Path.GetFullPath(filePath), + Path.GetFullPath(previewFile.Path), + OperatingSystem.IsWindows() ? StringComparer.OrdinalIgnoreCase : StringComparer.Ordinal); + + var rewind = await session.Rpc.History.RewindAsync( + rewindPoint.EventId, + HistoryRewindMode.ConversationAndFiles); + + Assert.Equal(HistoryRewindOutcome.Success, rewind.Outcome); + Assert.True(rewind.EventsRemoved > 0); + var restoredFile = Assert.Single(rewind.RestoredFiles); + Assert.Equal( + Path.GetFullPath(filePath), + Path.GetFullPath(restoredFile), + OperatingSystem.IsWindows() ? StringComparer.OrdinalIgnoreCase : StringComparer.Ordinal); + Assert.False(File.Exists(filePath)); + + var events = await session.GetEventsAsync(); + Assert.DoesNotContain(events, sessionEvent => sessionEvent.Id.ToString() == rewindPoint.EventId); + } +} diff --git a/dotnet/test/E2E/RpcExtensionsLoadedE2ETests.cs b/dotnet/test/E2E/RpcExtensionsLoadedE2ETests.cs index c1e43b09e..0a3513e4b 100644 --- a/dotnet/test/E2E/RpcExtensionsLoadedE2ETests.cs +++ b/dotnet/test/E2E/RpcExtensionsLoadedE2ETests.cs @@ -58,8 +58,7 @@ private CopilotClient CreateExtensionsClient() return Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForStdio(args: ["--yolo"]), - Environment = ExtensionsEnabledEnvironment(), - }); + }, environment: ExtensionsEnabledEnvironment()); } /// @@ -190,7 +189,7 @@ public async Task Discovers_Loads_And_Reports_Running_Extension(string sourceVal await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, WorkingDirectory = workingDirectory, @@ -215,7 +214,7 @@ public async Task Disable_Then_Enable_Cycles_Extension_Status() await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -241,7 +240,7 @@ public async Task Reload_Picks_Up_Extension_Added_After_Session_Create() // Start the session BEFORE writing the extension so the initial discovery sees nothing. await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -286,7 +285,7 @@ public async Task Failed_Extension_Reports_Failed_Status() await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -307,7 +306,7 @@ public async Task Multiple_Extensions_Are_Discovered_Independently() await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -329,7 +328,7 @@ public async Task Reload_Preserves_Disabled_State_Across_Calls() await using var client = CreateExtensionsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { EnableConfigDiscovery = true, OnPermissionRequest = PermissionHandler.ApproveAll, diff --git a/dotnet/test/E2E/RpcMcpAndSkillsE2ETests.cs b/dotnet/test/E2E/RpcMcpAndSkillsE2ETests.cs index d53f93c9a..0d2942d4b 100644 --- a/dotnet/test/E2E/RpcMcpAndSkillsE2ETests.cs +++ b/dotnet/test/E2E/RpcMcpAndSkillsE2ETests.cs @@ -189,7 +189,7 @@ public async Task Should_List_Extensions() { Connection = RuntimeConnection.ForStdio(args: ["--yolo"]), }); - await using var session = await yoloClient.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(yoloClient, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -208,7 +208,7 @@ public async Task Should_List_Extensions() public async Task Should_Round_Trip_Mcp_App_Host_Context() { await using var client = CreateMcpAppsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -253,7 +253,7 @@ public async Task Should_Diagnose_And_Report_Mcp_App_Capability_Errors() new Dictionary { ["MCP_APP_RPC_VALUE"] = "from-app-rpc" }; await using var client = CreateMcpAppsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { McpServers = mcpServers, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -292,7 +292,7 @@ public async Task Should_Report_Error_When_Mcp_App_Resource_Is_Not_Available() { const string serverName = "rpc-apps-resource-server"; await using var client = CreateMcpAppsClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { McpServers = CreateTestMcpServers(serverName), OnPermissionRequest = PermissionHandler.ApproveAll, @@ -368,7 +368,7 @@ public async Task Should_Report_Error_When_Extensions_Are_Not_Available() { Connection = RuntimeConnection.ForStdio(args: ["--yolo"]), }); - await using var session = await yoloClient.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(yoloClient, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -398,10 +398,7 @@ private CopilotClient CreateMcpAppsClient() environment["COPILOT_MCP_APPS"] = "true"; environment["MCP_APPS"] = "true"; - return Ctx.CreateClient(options: new CopilotClientOptions - { - Environment = environment, - }); + return Ctx.CreateClient(environment: environment); } private static void CreateSkill(string skillsDir, string skillName, string description) diff --git a/dotnet/test/E2E/RpcMcpLifecycleE2ETests.cs b/dotnet/test/E2E/RpcMcpLifecycleE2ETests.cs new file mode 100644 index 000000000..60c4bde3f --- /dev/null +++ b/dotnet/test/E2E/RpcMcpLifecycleE2ETests.cs @@ -0,0 +1,84 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for the public session-scoped MCP lifecycle RPC methods: +/// listTools, isServerRunning, and stopServer. +/// +public class RpcMcpLifecycleE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_mcp_lifecycle", output) +{ + [Fact] + public async Task Should_List_Tools_And_Report_Running_Status_For_Connected_Server() + { + const string serverName = "rpc-lifecycle-list-server"; + await using var session = await CreateSessionAsync(new SessionConfig + { + McpServers = CreateTestMcpServers(serverName), + }); + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + + var tools = await session.Rpc.Mcp.ListToolsAsync(serverName); + Assert.NotNull(tools.Tools); + Assert.NotEmpty(tools.Tools); + Assert.All(tools.Tools, tool => Assert.False(string.IsNullOrWhiteSpace(tool.Name))); + + // A connected server reports running; a name that was never configured does not. + Assert.True((await session.Rpc.Mcp.IsServerRunningAsync(serverName)).Running); + Assert.False((await session.Rpc.Mcp.IsServerRunningAsync($"missing-{Guid.NewGuid():N}")).Running); + } + + [Fact] + public async Task Should_Throw_When_Listing_Tools_For_Unconnected_Server() + { + const string serverName = "rpc-lifecycle-unconnected-host"; + await using var session = await CreateSessionAsync(new SessionConfig + { + McpServers = CreateTestMcpServers(serverName), + }); + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + + // The MCP host is initialized (a server is connected), but the requested server is not, + // so listTools reaches the runtime and fails with a domain error rather than "Unhandled method". + var ex = await Assert.ThrowsAnyAsync( + () => session.Rpc.Mcp.ListToolsAsync($"missing-{Guid.NewGuid():N}")); + var message = ex.ToString(); + AssertNotUnhandledMethod(message); + Assert.Contains("not connected", message, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task Should_Stop_Running_Mcp_Server() + { + const string serverName = "rpc-lifecycle-stop-server"; + await using var session = await CreateSessionAsync(new SessionConfig + { + McpServers = CreateTestMcpServers(serverName), + }); + await WaitForMcpServerStatusAsync(session, serverName, McpServerStatus.Connected); + Assert.True((await session.Rpc.Mcp.IsServerRunningAsync(serverName)).Running); + + await session.Rpc.Mcp.StopServerAsync(serverName); + + await WaitForMcpRunningAsync(session, serverName, expectedRunning: false); + } + + private static Task WaitForMcpRunningAsync(CopilotSession session, string serverName, bool expectedRunning) => + Harness.TestHelper.WaitForConditionAsync( + async () => (await session.Rpc.Mcp.IsServerRunningAsync(serverName)).Running == expectedRunning, + timeout: TimeSpan.FromSeconds(60), + pollInterval: TimeSpan.FromMilliseconds(200), + timeoutMessage: $"{serverName} running={expectedRunning}"); + + private static void AssertNotUnhandledMethod(string message) + { + Assert.DoesNotContain("Unhandled method", message, StringComparison.OrdinalIgnoreCase); + } +} diff --git a/dotnet/test/E2E/RpcRemoteE2ETests.cs b/dotnet/test/E2E/RpcRemoteE2ETests.cs index 40c3d8273..2af223542 100644 --- a/dotnet/test/E2E/RpcRemoteE2ETests.cs +++ b/dotnet/test/E2E/RpcRemoteE2ETests.cs @@ -48,12 +48,10 @@ public async Task Should_Notify_Steerable_Changed_Event_And_Persist_Flag() await session.Rpc.Remote.NotifySteerableChangedAsync(true); await WaitForRemoteSteerableEventAsync(session, expected: true); - Assert.True((await Client.Rpc.Sessions.GetPersistedRemoteSteerableAsync(session.SessionId)).RemoteSteerable); await session.Rpc.Remote.NotifySteerableChangedAsync(false); await WaitForRemoteSteerableEventAsync(session, expected: false); - Assert.False((await Client.Rpc.Sessions.GetPersistedRemoteSteerableAsync(session.SessionId)).RemoteSteerable); } private static async Task WaitForRemoteSteerableEventAsync(CopilotSession session, bool expected) diff --git a/dotnet/test/E2E/RpcServerE2ETests.cs b/dotnet/test/E2E/RpcServerE2ETests.cs index dea86df81..2df8593cc 100644 --- a/dotnet/test/E2E/RpcServerE2ETests.cs +++ b/dotnet/test/E2E/RpcServerE2ETests.cs @@ -9,7 +9,8 @@ using RpcSessionFsSetProviderConventions = GitHub.Copilot.Rpc.SessionFsSetProviderConventions; using RpcSessionContext = GitHub.Copilot.Rpc.SessionContext; using RpcSessionListFilter = GitHub.Copilot.Rpc.SessionListFilter; -using RpcSessionMetadata = GitHub.Copilot.Rpc.SessionMetadata; +using RpcLocalSessionMetadataValue = GitHub.Copilot.Rpc.LocalSessionMetadataValue; +using RpcSessionListEntry = GitHub.Copilot.Rpc.SessionListEntry; namespace GitHub.Copilot.Test.E2E; @@ -36,9 +37,8 @@ private CopilotClient CreateAuthenticatedClient(string token) return Ctx.CreateClient(options: new CopilotClientOptions { - Environment = env, GitHubToken = token, - }); + }, environment: env); } private async Task ConfigureAuthenticatedUserAsync( @@ -73,41 +73,34 @@ private static bool PathEquals(string? expected, string? actual) return string.Equals(normalizedExpected, normalizedActual, comparison); } - private async Task SaveAndWaitForEventFileAsync(string sessionId) - => await SaveAndWaitForEventFileAsync(Client, sessionId); + private async Task SaveSessionAsync(string sessionId) + => await SaveSessionAsync(Client, sessionId); - private static async Task SaveAndWaitForEventFileAsync(CopilotClient client, string sessionId) + private static async Task SaveSessionAsync(CopilotClient client, string sessionId) { var saveResult = await client.Rpc.Sessions.SaveAsync(sessionId); Assert.NotNull(saveResult); - - var pathResult = await client.Rpc.Sessions.GetEventFilePathAsync(sessionId); - Assert.False(string.IsNullOrWhiteSpace(pathResult.FilePath)); - Assert.True(Path.IsPathRooted(pathResult.FilePath), $"Expected an absolute event file path, got '{pathResult.FilePath}'."); - Assert.Equal("events.jsonl", Path.GetFileName(pathResult.FilePath)); - - return pathResult.FilePath; } - private static async Task PersistSessionAsync(CopilotClient client, CopilotSession session, string marker) + private static async Task PersistSessionAsync(CopilotClient client, CopilotSession session, string marker) { await session.LogAsync(marker); - return await SaveAndWaitForEventFileAsync(client, session.SessionId); + await SaveSessionAsync(client, session.SessionId); } - private async Task WaitForListedSessionAsync( + private async Task WaitForListedSessionAsync( string sessionId, RpcSessionListFilter? filter = null, long? metadataLimit = null) => await WaitForListedSessionAsync(Client, sessionId, filter, metadataLimit); - private static async Task WaitForListedSessionAsync( + private static async Task WaitForListedSessionAsync( CopilotClient client, string sessionId, RpcSessionListFilter? filter = null, long? metadataLimit = null) { - RpcSessionMetadata? metadata = null; + RpcSessionListEntry? metadata = null; await TestHelper.WaitForConditionAsync( async () => { @@ -133,6 +126,41 @@ public async Task Should_Call_Rpc_Ping_With_Typed_Params_And_Result() } [Fact] + public async Task Should_Reject_Llm_Inference_Response_Frames_For_Missing_Request() + { + await Client.StartAsync(); + + var start = await Client.Rpc.LlmInference.HttpResponseStartAsync( + requestId: "missing-llm-inference-request", + status: 200, + headers: new Dictionary> + { + ["content-type"] = ["text/event-stream"], + }, + statusText: "OK"); + Assert.False(start.Accepted); + + var chunk = await Client.Rpc.LlmInference.HttpResponseChunkAsync( + requestId: "missing-llm-inference-request", + data: "data: {}\n\n", + binary: false, + end: false); + Assert.False(chunk.Accepted); + + var error = await Client.Rpc.LlmInference.HttpResponseChunkAsync( + requestId: "missing-llm-inference-request", + data: string.Empty, + end: true, + error: new GitHub.Copilot.Rpc.LlmInferenceHttpResponseChunkError + { + Code = "missing_request", + Message = "No pending LLM inference request.", + }); + Assert.False(error.Accepted); + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Call_Rpc_Models_List_With_Typed_Result() { const string token = "rpc-models-token"; @@ -148,6 +176,7 @@ public async Task Should_Call_Rpc_Models_List_With_Typed_Result() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Call_Rpc_Account_GetQuota_When_Authenticated() { const string token = "rpc-quota-token"; @@ -209,10 +238,7 @@ public async Task Should_Add_Secret_Filter_Values() { var environment = Ctx.GetEnvironment(); environment["COPILOT_ENABLE_SECRET_FILTERING"] = "true"; - await using var client = Ctx.CreateClient(options: new CopilotClientOptions - { - Environment = environment, - }); + await using var client = Ctx.CreateClient(environment: environment); await client.StartAsync(); var secret = $"rpc-secret-{Guid.NewGuid():N}"; @@ -232,7 +258,7 @@ public async Task Should_List_Find_And_Inspect_Persisted_Session_State() var missingTaskId = $"missing-task-{Guid.NewGuid():N}"; var missingSessionId = Guid.NewGuid().ToString(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { SessionId = sessionId, WorkingDirectory = workingDirectory, @@ -241,8 +267,7 @@ public async Task Should_List_Find_And_Inspect_Persisted_Session_State() try { - var eventFilePath = await SaveAndWaitForEventFileAsync(client, sessionId); - Assert.Contains(sessionId, eventFilePath, StringComparison.OrdinalIgnoreCase); + await SaveSessionAsync(client, sessionId); var listed = await client.Rpc.Sessions.ListAsync( metadataLimit: 0, @@ -269,9 +294,6 @@ public async Task Should_List_Find_And_Inspect_Persisted_Session_State() var inUse = await client.Rpc.Sessions.CheckInUseAsync([sessionId, missingSessionId]); Assert.DoesNotContain(missingSessionId, inUse.InUse); - - var remoteSteerable = await client.Rpc.Sessions.GetPersistedRemoteSteerableAsync(sessionId); - Assert.Null(remoteSteerable.RemoteSteerable); } finally { @@ -288,7 +310,7 @@ public async Task Should_Enrich_Basic_Session_Metadata() var sessionId = Guid.NewGuid().ToString(); var workingDirectory = CreateUniqueWorkDirectory("server-rpc-enrich"); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { SessionId = sessionId, WorkingDirectory = workingDirectory, @@ -297,9 +319,9 @@ public async Task Should_Enrich_Basic_Session_Metadata() try { - await SaveAndWaitForEventFileAsync(client, sessionId); + await SaveSessionAsync(client, sessionId); - var basic = new RpcSessionMetadata + var basic = new RpcLocalSessionMetadataValue { SessionId = sessionId, StartTime = DateTimeOffset.UtcNow.ToString("O"), @@ -333,7 +355,7 @@ public async Task Should_Close_Active_Session_And_Release_Lock() await using var client = CreateAuthenticatedClient(token); var sessionId = Guid.NewGuid().ToString(); var workingDirectory = CreateUniqueWorkDirectory("server-rpc-close"); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { SessionId = sessionId, WorkingDirectory = workingDirectory, @@ -357,8 +379,8 @@ public async Task Should_Check_In_Use_Session_From_Another_Runtime_And_Release_L { var sessionId = Guid.NewGuid().ToString(); var workingDirectory = CreateUniqueWorkDirectory("server-rpc-in-use"); - await using var otherClient = Ctx.CreateClient(useStdio: true); - await using var otherSession = await otherClient.CreateSessionAsync(new SessionConfig + await using var otherClient = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForStdio() }); + await using var otherSession = await Ctx.CreateSessionAsync(otherClient, new SessionConfig { SessionId = sessionId, WorkingDirectory = workingDirectory, @@ -399,14 +421,14 @@ public async Task Should_Prune_DryRun_And_BulkDelete_Persisted_Session() var missingSessionId = Guid.NewGuid().ToString(); var workingDirectory = CreateUniqueWorkDirectory("server-rpc-delete"); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { SessionId = sessionId, WorkingDirectory = workingDirectory, OnPermissionRequest = PermissionHandler.ApproveAll, }); - await SaveAndWaitForEventFileAsync(client, sessionId); + await SaveSessionAsync(client, sessionId); await client.Rpc.Sessions.CloseAsync(sessionId); var prune = await client.Rpc.Sessions.PruneOldAsync( @@ -503,6 +525,44 @@ public async Task Should_Discover_Server_Mcp_And_Skills() Assert.True(discoveredSkill.Enabled); Assert.EndsWith(Path.Join(skillName, "SKILL.md"), discoveredSkill.Path); + var skillPaths = await Client.Rpc.Skills.GetDiscoveryPathsAsync( + projectPaths: [Ctx.WorkDir], + excludeHostSkills: true); + var projectSkillPath = Assert.Single(skillPaths.Paths, path => + PathEquals(Ctx.WorkDir, path.ProjectPath) && path.PreferredForCreation); + Assert.False(string.IsNullOrWhiteSpace(projectSkillPath.Path)); + + var agents = await Client.Rpc.Agents.DiscoverAsync( + projectPaths: [Ctx.WorkDir], + excludeHostAgents: true); + Assert.NotNull(agents.Agents); + Assert.All(agents.Agents, agent => Assert.False(string.IsNullOrWhiteSpace(agent.Name))); + + var agentPaths = await Client.Rpc.Agents.GetDiscoveryPathsAsync( + projectPaths: [Ctx.WorkDir], + excludeHostAgents: true); + var projectAgentPath = Assert.Single(agentPaths.Paths, path => + PathEquals(Ctx.WorkDir, path.ProjectPath) && path.PreferredForCreation); + Assert.False(string.IsNullOrWhiteSpace(projectAgentPath.Path)); + + var instructions = await Client.Rpc.Instructions.DiscoverAsync( + projectPaths: [Ctx.WorkDir], + excludeHostInstructions: true); + Assert.NotNull(instructions.Sources); + Assert.All(instructions.Sources, source => + { + Assert.False(string.IsNullOrWhiteSpace(source.Id)); + Assert.False(string.IsNullOrWhiteSpace(source.Label)); + Assert.False(string.IsNullOrWhiteSpace(source.SourcePath)); + }); + + var instructionPaths = await Client.Rpc.Instructions.GetDiscoveryPathsAsync( + projectPaths: [Ctx.WorkDir], + excludeHostInstructions: true); + Assert.NotEmpty(instructionPaths.Paths); + Assert.Contains(instructionPaths.Paths, path => PathEquals(Ctx.WorkDir, path.ProjectPath)); + Assert.All(instructionPaths.Paths, path => Assert.False(string.IsNullOrWhiteSpace(path.Path))); + try { await Client.Rpc.Skills.Config.SetDisabledSkillsAsync([skillName]); diff --git a/dotnet/test/E2E/RpcServerMiscE2ETests.cs b/dotnet/test/E2E/RpcServerMiscE2ETests.cs new file mode 100644 index 000000000..29e560100 --- /dev/null +++ b/dotnet/test/E2E/RpcServerMiscE2ETests.cs @@ -0,0 +1,293 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot; +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for miscellaneous server-scoped RPC methods, including account auth state, +/// user.settings get/set/reload, agentRegistry.spawn, runtime.shutdown, sessions.open, and the +/// session-scoped session.extensions.sendAttachmentsToMessage. +/// +/// Several of these are intentionally exercised at the wiring/guard boundary because the meaningful +/// "happy path" requires capabilities the SDK host does not expose (a registered agent-registry +/// delegate, an extension-owned connection). For those we assert the method reaches the runtime and +/// enforces its documented guard rather than failing as an unknown method. +/// +public class RpcServerMiscE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_server_misc", output) +{ + [Fact] + public async Task Should_Reload_User_Settings() + { + await Client.StartAsync(); + + // Drops the runtime's in-memory user-settings cache so the next read observes disk. Returns + // no value; success is simply completing without error. + await Client.Rpc.User.Settings.ReloadAsync(); + } + + [Fact] + public async Task Should_Get_Set_And_Clear_User_Settings() + { + await Client.StartAsync(); + + var before = await Client.Rpc.User.Settings.GetAsync(); + Assert.NotNull(before.Settings); + Assert.NotEmpty(before.Settings); + Assert.All(before.Settings, setting => + { + Assert.False(string.IsNullOrWhiteSpace(setting.Key)); + Assert.True( + setting.Value.Value.ValueKind != System.Text.Json.JsonValueKind.Undefined + || setting.Value.Default.ValueKind != System.Text.Json.JsonValueKind.Undefined, + $"Setting '{setting.Key}' should expose either a value or a default."); + }); + + var settingToToggle = before.Settings.First(setting => + setting.Value.Value.ValueKind is System.Text.Json.JsonValueKind.True or System.Text.Json.JsonValueKind.False); + var settingKey = settingToToggle.Key; + var toggledValue = settingToToggle.Value.Value.ValueKind != System.Text.Json.JsonValueKind.True; + + var set = await Client.Rpc.User.Settings.SetAsync(ParseSettingJson(settingKey, toggledValue ? "true" : "false")); + Assert.NotNull(set.ShadowedKeys); + Assert.DoesNotContain(settingKey, set.ShadowedKeys); + + await Client.Rpc.User.Settings.ReloadAsync(); + var afterSet = await Client.Rpc.User.Settings.GetAsync(); + var updatedSetting = Assert.Contains(settingKey, afterSet.Settings); + Assert.False(updatedSetting.IsDefault); + Assert.Equal(toggledValue, updatedSetting.Value.GetBoolean()); + + var clear = await Client.Rpc.User.Settings.SetAsync(ParseSettingJson(settingKey, "null")); + Assert.NotNull(clear.ShadowedKeys); + + await Client.Rpc.User.Settings.ReloadAsync(); + var afterClear = await Client.Rpc.User.Settings.GetAsync(); + var clearedSetting = Assert.Contains(settingKey, afterClear.Settings); + Assert.True(clearedSetting.IsDefault); + } + + [Fact] + public async Task Should_Login_List_GetCurrentAuth_And_Logout_Account() + { + var (client, home) = await CreateIsolatedClientAsync(autoInjectGitHubToken: false); + var login = $"rpc-account-{Guid.NewGuid():N}"; + var token = $"rpc-account-token-{Guid.NewGuid():N}"; + + try + { + await Ctx.SetCopilotUserByTokenAsync(token, new CopilotUserConfig( + Login: login, + CopilotPlan: "individual_pro", + Endpoints: new CopilotUserEndpoints(Api: Ctx.ProxyUrl, Telemetry: "https://localhost:1/telemetry"), + AnalyticsTrackingId: "rpc-account-tracking-id")); + + var initial = await client.Rpc.Account.GetCurrentAuthAsync(); + Assert.Null(initial.AuthInfo); + + var loginResult = await client.Rpc.Account.LoginAsync("https://github.com", login, token); + Assert.NotNull(loginResult); + + var current = await client.Rpc.Account.GetCurrentAuthAsync(); + Assert.Null(current.AuthErrors); + var authInfo = Assert.IsType(current.AuthInfo); + Assert.Equal("https://github.com", authInfo.Host); + Assert.Equal(login, authInfo.Login); + + var users = await client.Rpc.Account.GetAllUsersAsync(); + Assert.All(users, user => Assert.False(string.IsNullOrWhiteSpace(user.AuthInfo.Type))); + var account = users.FirstOrDefault(user => + user.AuthInfo is AuthInfoUser userAuth + && string.Equals(userAuth.Login, login, StringComparison.Ordinal)); + if (account is not null) + { + Assert.Equal(token, account.Token); + } + + var logout = await client.Rpc.Account.LogoutAsync(authInfo); + Assert.False(logout.HasMoreUsers); + + var afterLogout = await client.Rpc.Account.GetCurrentAuthAsync(); + Assert.Null(afterLogout.AuthInfo); + } + finally + { + await client.DisposeAsync(); + TryDeleteDirectory(home); + } + } + + [Fact] + public async Task Should_Report_Agent_Registry_Spawn_Gate_Closed() + { + await Client.StartAsync(); + + // agentRegistry.spawn is gated off on the SDK host (no spawn delegate is registered). The + // call must still reach the runtime and be rejected by that gate, proving the method is + // wired rather than an unknown method. + var ex = await Assert.ThrowsAnyAsync( + () => Client.Rpc.AgentRegistry.SpawnAsync(cwd: Path.GetTempPath())); + + var message = ex.ToString(); + Assert.DoesNotContain("Unhandled method", message, StringComparison.OrdinalIgnoreCase); + Assert.Contains("agentRegistry.spawn", message, StringComparison.OrdinalIgnoreCase); + Assert.True( + message.Contains("not enabled", StringComparison.OrdinalIgnoreCase) + || message.Contains("no delegate", StringComparison.OrdinalIgnoreCase), + message); + } + + [Fact] + public async Task Should_Shut_Down_Owned_Runtime() + { + // runtime.shutdown must only ever target a dedicated, SDK-owned runtime — never the shared + // fixture client whose process backs every other test. + var client = Ctx.CreateClient(); + await client.StartAsync(); + + try + { + // Confirm the runtime is live before shutting it down. + await client.Rpc.User.Settings.ReloadAsync(); + + await client.Rpc.Runtime.ShutdownAsync(); + + // After a graceful shutdown the runtime tears down and stops serving. Poll until a + // follow-up RPC fails rather than asserting on a single immediate call, which could race + // shutdown propagation across the connection. + await Harness.TestHelper.WaitForConditionAsync( + async () => + { + try { await client.Rpc.User.Settings.ReloadAsync(); return false; } + catch (Exception ex) when (IsExpectedShutdownException(ex)) { return true; } + }, + timeout: TimeSpan.FromSeconds(15), + pollInterval: TimeSpan.FromMilliseconds(100), + timeoutMessage: "Runtime kept serving RPCs after a graceful shutdown."); + } + finally + { + await DisposeStoppedRuntimeClientAsync(client); + } + } + + [Fact] + public async Task Should_Report_Not_Found_When_Opening_Session_Without_Context() + { + // sessions.open with no parameters asks the runtime to resume the last session for the + // (unspecified) context. A fresh runtime with its own empty COPILOT_HOME has no such + // session, so the documented "not_found" outcome is returned deterministically. + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var result = await client.Rpc.Sessions.OpenAsync(); + + Assert.Equal(SessionsOpenStatus.NotFound, result.Status); + Assert.Null(result.SessionId); + } + finally + { + await client.DisposeAsync(); + TryDeleteDirectory(home); + } + } + + [Fact] + public async Task Should_Reject_Send_Attachments_From_Non_Extension_Connection() + { + // session.extensions.sendAttachmentsToMessage may only be called over an extension-owned + // connection. A normal SDK session connection has no extensionId, so the runtime rejects the + // push — confirming the method is wired and enforces its ownership guard. + await using var session = await CreateSessionAsync(); + + var ex = await Assert.ThrowsAnyAsync( + () => session.Rpc.Extensions.SendAttachmentsToMessageAsync(new List())); + var message = ex.ToString(); + Assert.DoesNotContain("Unhandled method", message, StringComparison.OrdinalIgnoreCase); + Assert.Contains("extension", message, StringComparison.OrdinalIgnoreCase); + } + + /// + /// Creates a started client backed by a throwaway COPILOT_HOME so its session store is empty and + /// independent of every other test and of the shared fixture client. + /// + private async Task<(CopilotClient Client, string Home)> CreateIsolatedClientAsync( + bool autoInjectGitHubToken = true) + { + var home = Path.Combine(Path.GetTempPath(), "copilot-e2e-misc-home-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(home); + + var env = Ctx.GetEnvironment(); + env["COPILOT_HOME"] = home; + env["GH_CONFIG_DIR"] = home; + env["XDG_CONFIG_HOME"] = home; + env["XDG_STATE_HOME"] = home; + if (!autoInjectGitHubToken) + { + env["GH_TOKEN"] = ""; + env["GITHUB_TOKEN"] = ""; + } + + var options = new CopilotClientOptions(); + if (!autoInjectGitHubToken) + { + options.UseLoggedInUser = false; + } + + var client = Ctx.CreateClient( + options: options, + autoInjectGitHubToken: autoInjectGitHubToken, + environment: env); + await client.StartAsync(); + return (client, home); + } + + private static void TryDeleteDirectory(string path) + { + try + { + if (Directory.Exists(path)) + { + Directory.Delete(path, recursive: true); + } + } + catch (Exception ex) when (ex is IOException or UnauthorizedAccessException) + { + // Temp directories are reclaimed by the OS; ignore transient locks on cleanup. + } + } + + private static async Task DisposeStoppedRuntimeClientAsync(CopilotClient client) + { + try + { + await client.DisposeAsync(); + } + catch (Exception ex) when (IsExpectedShutdownException(ex)) + { + // The runtime.shutdown test intentionally stops the process before disposal. + } + } + + private static bool IsExpectedShutdownException(Exception ex) => + ex is OperationCanceledException + or InvalidOperationException + or ObjectDisposedException + or IOException; + + private static System.Text.Json.JsonElement ParseJsonElement(string json) + { + using var document = System.Text.Json.JsonDocument.Parse(json); + return document.RootElement.Clone(); + } + + private static System.Text.Json.JsonElement ParseSettingJson(string key, string valueLiteral) + => ParseJsonElement("{\"" + System.Text.Json.JsonEncodedText.Encode(key) + "\":" + valueLiteral + "}"); +} diff --git a/dotnet/test/E2E/RpcServerPluginsE2ETests.cs b/dotnet/test/E2E/RpcServerPluginsE2ETests.cs new file mode 100644 index 000000000..64a0f1c26 --- /dev/null +++ b/dotnet/test/E2E/RpcServerPluginsE2ETests.cs @@ -0,0 +1,336 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot; +using GitHub.Copilot.Rpc; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for the server-scoped plugin and marketplace RPC methods that were previously +/// untested: plugins.install/list/uninstall/update/updateAll/enable/disable, +/// plugins.marketplaces.add/list/browse/refresh/remove, and mcp.config.reload. +/// +/// All fixtures are self-contained local directories so the tests run fully offline (the E2E +/// proxy blocks github.com). A local marketplace directory with the plugin nested inside it +/// (a "monorepo" marketplace) lets the runtime install a real marketplace-scoped plugin without +/// any network access, which in turn makes enable/disable/update meaningful rather than no-ops. +/// Each test runs against its own client with a fresh COPILOT_HOME so installed-plugin and +/// marketplace state never leaks between tests. +/// +public class RpcServerPluginsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_server_plugins", output) +{ + private const string MarketplaceName = "csharp-e2e-marketplace"; + private const string PluginName = "csharp-e2e-plugin"; + private const string DirectPluginName = "csharp-e2e-direct"; + + [Fact] + public async Task Should_Install_And_List_Plugin_From_Local_Marketplace() + { + var marketplaceDir = CreateLocalMarketplaceFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + await client.Rpc.Plugins.Marketplaces.AddAsync(marketplaceDir); + + var spec = $"{PluginName}@{MarketplaceName}"; + var install = await client.Rpc.Plugins.InstallAsync(spec); + + Assert.Equal(PluginName, install.Plugin.Name); + Assert.Equal(MarketplaceName, install.Plugin.Marketplace); + Assert.True(install.Plugin.Enabled); + Assert.True(install.SkillsInstalled >= 1, $"expected at least one skill, got {install.SkillsInstalled}"); + // Marketplace installs are the supported path and must NOT carry the deprecation warning. + Assert.Null(install.DeprecationWarning); + + var afterInstall = await client.Rpc.Plugins.ListAsync(); + var listed = Assert.Single( + afterInstall.Plugins, + p => p.Name == PluginName && p.Marketplace == MarketplaceName); + Assert.True(listed.Enabled); + + } + finally + { + await DisposeIsolatedAsync(client, home, marketplaceDir); + } + } + + [Fact] + public async Task Should_Enable_And_Disable_Marketplace_Plugin() + { + var marketplaceDir = CreateLocalMarketplaceFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var spec = $"{PluginName}@{MarketplaceName}"; + await client.Rpc.Plugins.Marketplaces.AddAsync(marketplaceDir); + await client.Rpc.Plugins.InstallAsync(spec); + + await client.Rpc.Plugins.DisableAsync([spec]); + Assert.False(GetPlugin(await client.Rpc.Plugins.ListAsync()).Enabled); + + await client.Rpc.Plugins.EnableAsync([spec]); + Assert.True(GetPlugin(await client.Rpc.Plugins.ListAsync()).Enabled); + } + finally + { + await DisposeIsolatedAsync(client, home, marketplaceDir); + } + + static InstalledPluginInfo GetPlugin(PluginListResult list) => + Assert.Single(list.Plugins, p => p.Name == PluginName && p.Marketplace == MarketplaceName); + } + + [Fact] + public async Task Should_Update_Single_Marketplace_Plugin() + { + var marketplaceDir = CreateLocalMarketplaceFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var spec = $"{PluginName}@{MarketplaceName}"; + await client.Rpc.Plugins.Marketplaces.AddAsync(marketplaceDir); + await client.Rpc.Plugins.InstallAsync(spec); + + // Re-installs from the (local) marketplace catalog and re-counts skills. + var update = await client.Rpc.Plugins.UpdateAsync(spec); + + Assert.True(update.SkillsInstalled >= 1, $"expected at least one skill, got {update.SkillsInstalled}"); + Assert.Equal("1.0.0", update.PreviousVersion); + Assert.Equal("1.0.0", update.NewVersion); + } + finally + { + await DisposeIsolatedAsync(client, home, marketplaceDir); + } + } + + [Fact] + public async Task Should_Update_All_Installed_Plugins() + { + var marketplaceDir = CreateLocalMarketplaceFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var spec = $"{PluginName}@{MarketplaceName}"; + await client.Rpc.Plugins.Marketplaces.AddAsync(marketplaceDir); + await client.Rpc.Plugins.InstallAsync(spec); + + var result = await client.Rpc.Plugins.UpdateAllAsync(); + + var entry = Assert.Single( + result.Results, + r => r.Name == PluginName && r.Marketplace == MarketplaceName); + Assert.True(entry.Success, entry.Error); + Assert.True(entry.SkillsInstalled >= 1); + } + finally + { + await DisposeIsolatedAsync(client, home, marketplaceDir); + } + } + + [Fact] + public async Task Should_Install_Direct_Local_Plugin_With_Deprecation_Warning() + { + var pluginDir = CreateDirectPluginFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var install = await client.Rpc.Plugins.InstallAsync(pluginDir); + + Assert.Equal(DirectPluginName, install.Plugin.Name); + // Direct (local path) installs have no originating marketplace and are deprecated. + Assert.Equal(string.Empty, install.Plugin.Marketplace); + Assert.NotNull(install.DeprecationWarning); + Assert.Contains("deprecated", install.DeprecationWarning, StringComparison.OrdinalIgnoreCase); + Assert.True(install.SkillsInstalled >= 1, $"expected at least one skill, got {install.SkillsInstalled}"); + + var afterInstall = await client.Rpc.Plugins.ListAsync(); + Assert.Single(afterInstall.Plugins, p => p.Name == DirectPluginName); + Assert.False(string.IsNullOrEmpty(install.Plugin.DirectSourceId)); + + await client.Rpc.Plugins.UninstallAsync(DirectPluginName, install.Plugin.DirectSourceId); + + var afterUninstall = await client.Rpc.Plugins.ListAsync(); + Assert.DoesNotContain(afterUninstall.Plugins, p => p.Name == DirectPluginName); + } + finally + { + await DisposeIsolatedAsync(client, home, pluginDir); + } + } + + [Fact] + public async Task Should_List_Browse_Refresh_And_Remove_Local_Marketplace() + { + var marketplaceDir = CreateLocalMarketplaceFixture(); + var (client, home) = await CreateIsolatedClientAsync(); + try + { + var add = await client.Rpc.Plugins.Marketplaces.AddAsync(marketplaceDir); + Assert.Equal(MarketplaceName, add.Name); + + var list = await client.Rpc.Plugins.Marketplaces.ListAsync(); + var mine = Assert.Single(list.Marketplaces, m => m.Name == MarketplaceName); + Assert.NotEqual(true, mine.IsDefault); + // The runtime always ships built-in default marketplaces alongside user-added ones. + Assert.Contains(list.Marketplaces, m => m.IsDefault == true); + + var browse = await client.Rpc.Plugins.Marketplaces.BrowseAsync(MarketplaceName); + var advertised = Assert.Single(browse.Plugins, p => p.Name == PluginName); + Assert.False(string.IsNullOrEmpty(advertised.Description)); + + var refresh = await client.Rpc.Plugins.Marketplaces.RefreshAsync(MarketplaceName); + var refreshed = Assert.Single(refresh.Results, r => r.Name == MarketplaceName); + Assert.True(refreshed.Success, refreshed.Error); + + var remove = await client.Rpc.Plugins.Marketplaces.RemoveAsync(MarketplaceName); + Assert.True(remove.Removed); + + var afterRemove = await client.Rpc.Plugins.Marketplaces.ListAsync(); + Assert.DoesNotContain(afterRemove.Marketplaces, m => m.Name == MarketplaceName); + } + finally + { + await DisposeIsolatedAsync(client, home, marketplaceDir); + } + } + + [Fact] + public async Task Should_Reload_Mcp_Config_Cache() + { + var (client, home) = await CreateIsolatedClientAsync(); + try + { + // Drops the runtime's in-memory MCP server-definition cache; succeeds with no return value. + await client.Rpc.Mcp.Config.ReloadAsync(); + } + finally + { + await DisposeIsolatedAsync(client, home, null); + } + } + + /// + /// Creates a self-contained local marketplace directory: a marketplace.json catalog plus the + /// plugin it advertises nested inside as a subdirectory. The plugin's catalog source is a + /// relative path, so the runtime resolves and installs it purely from the local filesystem. + /// + private static string CreateLocalMarketplaceFixture() + { + var dir = Path.Combine(Path.GetTempPath(), "copilot-e2e-mp-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(dir); + + var manifest = $$""" + { + "name": "{{MarketplaceName}}", + "owner": { "name": "Copilot SDK E2E" }, + "metadata": { "description": "Local marketplace fixture for SDK E2E tests." }, + "plugins": [ + { + "name": "{{PluginName}}", + "source": "./{{PluginName}}", + "description": "E2E demo plugin advertised by the local marketplace.", + "version": "1.0.0" + } + ] + } + """; + File.WriteAllText(Path.Combine(dir, "marketplace.json"), manifest); + + var pluginDir = Path.Combine(dir, PluginName); + Directory.CreateDirectory(pluginDir); + WriteSkillFile(pluginDir); + + return dir; + } + + /// + /// Creates a directory installable as a direct (deprecated) local plugin: a minimal plugin.json + /// manifest plus a single skill. + /// + private static string CreateDirectPluginFixture() + { + var dir = Path.Combine(Path.GetTempPath(), "copilot-e2e-plugin-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(dir); + + var manifest = $$""" + { + "name": "{{DirectPluginName}}", + "description": "E2E demo plugin installed directly from a local path.", + "version": "1.0.0" + } + """; + File.WriteAllText(Path.Combine(dir, "plugin.json"), manifest); + WriteSkillFile(dir); + + return dir; + } + + private static void WriteSkillFile(string pluginDir) + { + const string skill = """ + --- + name: csharp-e2e-skill + description: A demo skill contributed by the E2E test plugin. + --- + # Demo Skill + + This skill exists so the plugin reports at least one installed skill. + """; + File.WriteAllText(Path.Combine(pluginDir, "SKILL.md"), skill); + } + + /// + /// Creates a started client backed by a throwaway COPILOT_HOME so plugin/marketplace state is + /// isolated from every other test and from the shared fixture client. + /// + private async Task<(CopilotClient Client, string Home)> CreateIsolatedClientAsync() + { + var home = Path.Combine(Path.GetTempPath(), "copilot-e2e-home-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(home); + + var env = Ctx.GetEnvironment(); + env["COPILOT_HOME"] = home; + env["GH_CONFIG_DIR"] = home; + env["XDG_CONFIG_HOME"] = home; + env["XDG_STATE_HOME"] = home; + + var client = Ctx.CreateClient(environment: env); + await client.StartAsync(); + return (client, home); + } + + private static async Task DisposeIsolatedAsync(CopilotClient client, string home, string? fixtureDir) + { + try { await client.DisposeAsync(); } + catch { /* best-effort */ } + + TryDeleteDirectory(home); + if (fixtureDir is not null) + { + TryDeleteDirectory(fixtureDir); + } + } + + private static void TryDeleteDirectory(string path) + { + try + { + if (Directory.Exists(path)) + { + Directory.Delete(path, recursive: true); + } + } + catch + { + // Temp directories are reclaimed by the OS; ignore transient locks on cleanup. + } + } +} diff --git a/dotnet/test/E2E/RpcServerRemoteControlE2ETests.cs b/dotnet/test/E2E/RpcServerRemoteControlE2ETests.cs new file mode 100644 index 000000000..5fb874a52 --- /dev/null +++ b/dotnet/test/E2E/RpcServerRemoteControlE2ETests.cs @@ -0,0 +1,105 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for the server-scoped remote-control RPC methods that were previously untested: +/// getRemoteControlStatus, setRemoteControlSteering, stopRemoteControl, transferRemoteControl, and +/// startRemoteControl. The remote-control singleton is per-runtime shared state, so every test uses +/// its own dedicated client process and leaves the singleton in the "off" state. +/// +public class RpcServerRemoteControlE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_server_remote_control", output) +{ + [Fact] + public async Task Should_Report_Remote_Control_Status_As_Off() + { + await using var client = Ctx.CreateClient(); + await client.StartAsync(); + + var result = await client.Rpc.Sessions.GetRemoteControlStatusAsync(); + + // A runtime that has never attached remote control reports the off singleton state. + Assert.IsType(result.Status); + Assert.Equal("off", result.Status.State); + } + + [Fact] + public async Task Should_Treat_Set_Steering_As_No_Op_When_Off() + { + await using var client = Ctx.CreateClient(); + await client.StartAsync(); + + // Steering only applies to an active singleton; with remote control off it is a no-op that + // returns the unchanged off status rather than failing. + var result = await client.Rpc.Sessions.SetRemoteControlSteeringAsync(false); + + Assert.IsType(result.Status); + } + + [Fact] + public async Task Should_Report_Not_Stopped_When_Remote_Control_Is_Off() + { + await using var client = Ctx.CreateClient(); + await client.StartAsync(); + + var result = await client.Rpc.Sessions.StopRemoteControlAsync(); + + // Nothing is attached, so there is nothing to tear down. + Assert.False(result.Stopped); + Assert.IsType(result.Status); + } + + [Fact] + public async Task Should_Reject_Transfer_When_Off_With_Compare_And_Swap() + { + await using var client = Ctx.CreateClient(); + await client.StartAsync(); + + // Compare-and-swap transfer is rejected because the singleton is off (it points at no + // session), so the expected-from guard can never match and nothing is rebound. + var result = await client.Rpc.Sessions.TransferRemoteControlAsync( + toSessionId: $"rc-to-{Guid.NewGuid():N}", + expectedFromSessionId: $"rc-from-{Guid.NewGuid():N}"); + + Assert.False(result.Transferred); + Assert.IsType(result.Status); + } + + [Fact] + public async Task Should_Reach_Runtime_When_Starting_Remote_Control_For_Unknown_Session() + { + await using var client = Ctx.CreateClient(); + await client.StartAsync(); + + try + { + // startRemoteControl attaches the singleton to a local session. A well-formed session id + // that the runtime does not know is rejected at the runtime (not as an unhandled method), + // proving the method is wired through without requiring a live Mission Control backend. + var ex = await Assert.ThrowsAnyAsync( + () => client.Rpc.Sessions.StartRemoteControlAsync( + $"missing-session-{Guid.NewGuid():N}", + new RemoteControlConfig { Remote = false, Explicit = false, Silent = true, Steerable = false })); + + var message = ex.ToString(); + Assert.DoesNotContain("Unhandled method", message, StringComparison.OrdinalIgnoreCase); + Assert.True( + message.Contains("session", StringComparison.OrdinalIgnoreCase) + || message.Contains("remote", StringComparison.OrdinalIgnoreCase), + message); + } + finally + { + // Force the singleton back to off regardless of how the start attempt resolved. + try { await client.Rpc.Sessions.StopRemoteControlAsync(force: true); } + catch { /* best-effort reset */ } + } + } +} diff --git a/dotnet/test/E2E/RpcSessionStateE2ETests.cs b/dotnet/test/E2E/RpcSessionStateE2ETests.cs index 1f35a9173..6dce3c250 100644 --- a/dotnet/test/E2E/RpcSessionStateE2ETests.cs +++ b/dotnet/test/E2E/RpcSessionStateE2ETests.cs @@ -35,16 +35,31 @@ public async Task Should_Call_Session_Rpc_Model_GetCurrent() [Fact] public async Task Should_Call_Session_Rpc_Model_SwitchTo() { - await using var session = await CreateSessionAsync(new SessionConfig { Model = "claude-sonnet-4.5" }); + // The runtime caches /models per (auth, base_url) for 30 minutes (see + // capi_client.rs LIST_MODELS_CACHE). Tests in this class share one CLI + // subprocess and proxy URL via E2ETestFixture, so the first snapshot's + // models list is reused by every later test. SwitchTo needs gpt-5.4 in + // the cache; rather than poisoning every other snapshot we spin up an + // isolated context with its own proxy → its own (auth, base_url) cache + // key. + await using var isolatedCtx = await E2ETestContext.CreateAsync(); + await isolatedCtx.ConfigureForTestAsync("rpc_session_state", nameof(Should_Call_Session_Rpc_Model_SwitchTo)); + var isolatedClient = isolatedCtx.CreateClient(); + + await using var session = await isolatedCtx.CreateSessionAsync(isolatedClient, new SessionConfig + { + Model = "claude-sonnet-4.5", + OnPermissionRequest = PermissionHandler.ApproveAll, + }); var before = await session.Rpc.Model.GetCurrentAsync(); Assert.Equal("claude-sonnet-4.5", before.ModelId); - var result = await session.Rpc.Model.SwitchToAsync(modelId: "gpt-4.1", reasoningEffort: "high"); - var after = await session.Rpc.Model.GetCurrentAsync(); + var result = await session.Rpc.Model.SwitchToAsync(modelId: "gpt-5.4", reasoningEffort: "high"); + Assert.Equal("gpt-5.4", result.ModelId); - Assert.Equal("gpt-4.1", result.ModelId); - Assert.True(after.ModelId is "gpt-4.1" || after.ModelId == before.ModelId, $"Unexpected current model after switch: {after.ModelId}"); + var after = await session.Rpc.Model.GetCurrentAsync(); + Assert.Equal("gpt-5.4", after.ModelId); } [Fact] @@ -263,7 +278,6 @@ public async Task Should_Call_Metadata_Snapshot_SetWorkingDirectory_And_RecordCo { var firstDirectory = CreateUniqueDirectory(); var secondDirectory = CreateUniqueDirectory(); - var contextDirectory = CreateUniqueDirectory(); var branch = $"rpc-context-{Guid.NewGuid():N}"; await using var session = await CreateSessionAsync(new SessionConfig { @@ -307,14 +321,17 @@ await TestHelper.WaitForConditionAsync( TimeSpan.FromSeconds(15), timeoutDescription: "session.context_changed event after metadata.recordContextChange"); + // For local sessions the CLI treats the session cwd as authoritative, so a + // recordContextChange that reports a divergent cwd is ignored and emits no event. + // Report the current working directory (secondDirectory) to observe the change. var context = new SessionWorkingDirectoryContext { - Cwd = contextDirectory, + Cwd = secondDirectory, GitRoot = firstDirectory, Branch = branch, Repository = "github/copilot-sdk-e2e", RepositoryHost = "github.com", - HostType = SessionWorkingDirectoryContextHostType.Github, + HostType = SessionWorkingDirectoryContextHostType.GitHub, BaseCommit = "0000000000000000000000000000000000000000", HeadCommit = "1111111111111111111111111111111111111111", }; @@ -323,8 +340,8 @@ await TestHelper.WaitForConditionAsync( Assert.NotNull(recordResult); var contextChanged = await contextChangedTask; - Assert.True(PathEquals(contextDirectory, contextChanged.Data.Cwd), - $"Expected context cwd '{contextDirectory}', actual '{contextChanged.Data.Cwd}'."); + Assert.True(PathEquals(secondDirectory, contextChanged.Data.Cwd), + $"Expected context cwd '{secondDirectory}', actual '{contextChanged.Data.Cwd}'."); Assert.True(PathEquals(firstDirectory, contextChanged.Data.GitRoot), $"Expected context git root '{firstDirectory}', actual '{contextChanged.Data.GitRoot}'."); Assert.Equal(branch, contextChanged.Data.Branch); @@ -428,13 +445,13 @@ public async Task Should_Set_ReasoningEffort_And_Auto_Name() public async Task Should_Set_Auth_Credentials() { await using var client = Ctx.CreateClient(); - await using var session = await client.CreateSessionAsync(new SessionConfig + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); var login = $"sdk-rpc-{Guid.NewGuid():N}"; - var setCredentials = await session.Rpc.Auth.SetCredentialsAsync(new AuthInfoUser + var setCredentials = await session.Rpc.GitHubAuth.SetCredentialsAsync(new AuthInfoUser { CopilotUser = new CopilotUserResponse { @@ -453,7 +470,7 @@ public async Task Should_Set_Auth_Credentials() }); Assert.True(setCredentials.Success); - var status = await session.Rpc.Auth.GetStatusAsync(); + var status = await session.Rpc.GitHubAuth.GetStatusAsync(); Assert.True(status.IsAuthenticated); Assert.Equal(AuthInfoType.User, status.AuthType); Assert.Equal("https://github.com", status.Host); diff --git a/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs b/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs new file mode 100644 index 000000000..28ec9b7cf --- /dev/null +++ b/dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs @@ -0,0 +1,330 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for session-scoped RPC methods that were previously untested: +/// completions, model.list, metadata.activity/context attribution/heaviest messages, +/// permissions.getAllowAll/setAllowAll, plan.readSqlTodos, provider.add, +/// telemetry.getEngagementId, tools.getCurrentMetadata/updateSubagentSettings, +/// session visibility, and the session-scoped plugins.reload. +/// +public class RpcSessionStateExtrasE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_session_state_extras", output) +{ + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] + public async Task Should_List_Models_For_Session() + { + // model.list resolves models through the session's own auth context, which requires the + // GitHub token -> user resolution to be served by the proxy (a fresh shared client does not + // route token resolution there). Use a dedicated authenticated client like the server-scoped + // models.list coverage does. + const string token = "rpc-session-model-list-token"; + await ConfigureAuthenticatedUserAsync(token); + await using var client = CreateAuthenticatedClient(token); + await using var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + Model = "claude-sonnet-4.5", + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + var result = await session.Rpc.Model.ListAsync(); + + Assert.NotNull(result.List); + Assert.NotEmpty(result.List); + // The configured model must be present in the returned catalog. + Assert.Contains(result.List, model => model.GetRawText().Contains("claude-sonnet-4.5", StringComparison.Ordinal)); + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Should_Add_Byok_Provider_And_Model_At_Runtime() + { + await using var session = await CreateSessionAsync(); + var providerName = $"sdk-runtime-provider-{Guid.NewGuid():N}"; + var modelId = "sdk-runtime-model"; + var selectionId = $"{providerName}/{modelId}"; + + var added = await session.Rpc.Provider.AddAsync( + providers: + [ + new GitHub.Copilot.Rpc.NamedProviderConfig + { + Name = providerName, + Type = ProviderConfigType.Openai, + WireApi = ProviderConfigWireApi.Completions, + BaseUrl = "https://api.example.test/v1", + ApiKey = "runtime-provider-secret", + Headers = new Dictionary { ["X-SDK-Provider"] = "runtime" }, + }, + ], + models: + [ + new GitHub.Copilot.Rpc.ProviderModelConfig + { + Provider = providerName, + Id = modelId, + Name = "SDK Runtime Model", + ModelId = "claude-sonnet-4.5", + WireModel = "wire-sdk-runtime-model", + MaxContextWindowTokens = 4_096, + MaxPromptTokens = 3_072, + MaxOutputTokens = 1_024, + Capabilities = new GitHub.Copilot.Rpc.ModelCapabilitiesOverride + { + Limits = new GitHub.Copilot.Rpc.ModelCapabilitiesOverrideLimits + { + MaxContextWindowTokens = 4_096, + MaxPromptTokens = 3_072, + MaxOutputTokens = 1_024, + }, + Supports = new GitHub.Copilot.Rpc.ModelCapabilitiesOverrideSupports + { + ReasoningEffort = false, + Vision = false, + }, + }, + }, + ]); + + var addedModel = Assert.Single(added.Models); + var addedModelJson = addedModel.GetRawText(); + Assert.Contains(selectionId, addedModelJson, StringComparison.Ordinal); + Assert.Contains("SDK Runtime Model", addedModelJson, StringComparison.Ordinal); + + var listed = await session.Rpc.Model.ListAsync(); + Assert.Contains(listed.List, model => model.GetRawText().Contains(selectionId, StringComparison.Ordinal)); + + var switched = await session.Rpc.Model.SwitchToAsync(selectionId); + Assert.Equal(selectionId, switched.ModelId); + Assert.Equal(selectionId, (await session.Rpc.Model.GetCurrentAsync()).ModelId); + } + + [Fact] + public async Task Should_Report_Session_Activity_When_Idle() + { + await using var session = await CreateSessionAsync(); + + var activity = await session.Rpc.Metadata.ActivityAsync(); + + // A freshly created session that has not been sent any work is idle: no active turns or + // tasks, and nothing to abort. + Assert.False(activity.HasActiveWork, "Expected a freshly created session to report no active work."); + Assert.False(activity.Abortable, "Expected a freshly created session to have nothing abortable."); + } + + [Fact] + public async Task Should_Return_Empty_Completions_When_Host_Does_Not_Provide_Them() + { + await using var session = await CreateSessionAsync(); + + var triggers = await session.Rpc.Completions.GetTriggerCharactersAsync(); + Assert.NotNull(triggers.TriggerCharacters); + Assert.Empty(triggers.TriggerCharacters); + + var completions = await session.Rpc.Completions.RequestAsync("Use @", offset: 5); + Assert.NotNull(completions.Items); + Assert.Empty(completions.Items); + } + + [Fact] + public async Task Should_Report_Visibility_As_Unsynced_For_Local_Session() + { + await using var session = await CreateSessionAsync(); + + var initial = await session.Rpc.Visibility.GetAsync(); + Assert.False(initial.Synced); + Assert.Null(initial.Status); + Assert.Null(initial.ShareUrl); + + var set = await session.Rpc.Visibility.SetAsync(SessionVisibilityStatus.Repo); + Assert.False(set.Synced); + Assert.Null(set.Status); + Assert.Null(set.ShareUrl); + } + + [Fact] + public async Task Should_Get_And_Set_AllowAll_Permissions() + { + await using var session = await CreateSessionAsync(); + + try + { + var initial = await session.Rpc.Permissions.GetAllowAllAsync(); + Assert.False(initial.Enabled, "Allow-all should be disabled on a fresh session."); + + var enable = await session.Rpc.Permissions.SetAllowAllAsync(enabled: true); + Assert.True(enable.Success); + Assert.True(enable.Enabled); + Assert.True((await session.Rpc.Permissions.GetAllowAllAsync()).Enabled); + + var disable = await session.Rpc.Permissions.SetAllowAllAsync(enabled: false); + Assert.True(disable.Success); + Assert.False(disable.Enabled); + Assert.False((await session.Rpc.Permissions.GetAllowAllAsync()).Enabled); + } + finally + { + await session.Rpc.Permissions.SetAllowAllAsync(enabled: false); + } + } + + [Fact] + public async Task Should_Read_Empty_Sql_Todos_For_Fresh_Session() + { + await using var session = await CreateSessionAsync(); + + var result = await session.Rpc.Plan.ReadSqlTodosAsync(); + + // A fresh session has never written to its SQL todos table, so the query returns an empty + // (but non-null) row set rather than failing. + Assert.NotNull(result.Rows); + Assert.Empty(result.Rows); + } + + [Fact] + public async Task Should_Get_Telemetry_Engagement_Id() + { + await using var session = await CreateSessionAsync(); + + var result = await session.Rpc.Telemetry.GetEngagementIdAsync(); + + // The engagement id is optional (null until telemetry assigns one), but the call must + // round-trip without error and return a result object. + Assert.NotNull(result); + } + + [Fact] + public async Task Should_Get_Current_Tool_Metadata_After_Initialization() + { + await using var session = await CreateSessionAsync(); + + // getCurrentMetadata returns the tool snapshot captured for the most recent turn; it is null + // until the session has processed a turn. Drive one real turn so the runtime computes and + // records the current tool metadata. + var answer = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 2+2?" }); + Assert.NotNull(answer); + + var result = await session.Rpc.Tools.GetCurrentMetadataAsync(); + + Assert.NotNull(result.Tools); + Assert.NotEmpty(result.Tools!); + Assert.All(result.Tools!, tool => + { + Assert.False(string.IsNullOrWhiteSpace(tool.Name)); + Assert.NotNull(tool.Description); + }); + } + + [Fact] + public async Task Should_Get_Context_Attribution_And_Heaviest_Messages_After_Turn() + { + await using var session = await CreateSessionAsync(); + + var answer = await session.SendAndWaitAsync(new MessageOptions + { + Prompt = "Say CONTEXT_METADATA_OK exactly.", + }); + Assert.Contains("CONTEXT_METADATA_OK", answer?.Data.Content ?? string.Empty, StringComparison.Ordinal); + + var attribution = await session.Rpc.Metadata.GetContextAttributionAsync(); + var contextAttribution = Assert.IsType( + attribution.ContextAttribution); + Assert.True(contextAttribution.TotalTokens > 0); + Assert.True(contextAttribution.Compactions.Count >= 0); + Assert.NotEmpty(contextAttribution.Entries); + Assert.All(contextAttribution.Entries, entry => + { + Assert.False(string.IsNullOrWhiteSpace(entry.Id)); + Assert.False(string.IsNullOrWhiteSpace(entry.Kind)); + Assert.False(string.IsNullOrWhiteSpace(entry.Label)); + Assert.True(entry.Tokens >= 0); + if (entry.Attributes is not null) + { + Assert.All(entry.Attributes, attribute => Assert.False(string.IsNullOrWhiteSpace(attribute.Key))); + } + }); + + var heaviest = await session.Rpc.Metadata.GetContextHeaviestMessagesAsync(limit: 2); + Assert.True(heaviest.TotalTokens > 0); + Assert.NotNull(heaviest.Messages); + Assert.True(heaviest.Messages.Count <= 2); + Assert.All(heaviest.Messages, message => + { + Assert.False(string.IsNullOrWhiteSpace(message.Id)); + Assert.False(string.IsNullOrWhiteSpace(message.Label)); + Assert.False(string.IsNullOrWhiteSpace(message.Role)); + Assert.True(message.Tokens > 0); + }); + } + + [Fact] + public async Task Should_Update_And_Clear_Live_Subagent_Settings() + { + await using var session = await CreateSessionAsync(); + + var update = await session.Rpc.Tools.UpdateSubagentSettingsAsync(new UpdateSubagentSettingsRequestSubagents + { + Agents = new Dictionary + { + ["general-purpose"] = new() + { + Model = "claude-sonnet-4.5", + EffortLevel = "high", + ContextTier = SubagentSettingsEntryContextTier.Default, + }, + }, + DisabledSubagents = ["explore"], + MaxConcurrency = 2, + MaxDepth = 1, + }); + Assert.NotNull(update); + + var clear = await session.Rpc.Tools.UpdateSubagentSettingsAsync(); + Assert.NotNull(clear); + } + + [Fact] + public async Task Should_Reload_Session_Plugins() + { + await using var session = await CreateSessionAsync(); + + // Reloading refreshes the session's plugin set; with no plugins configured it is a no-op + // that must still complete successfully and leave the plugin list queryable. + await session.Rpc.Plugins.ReloadAsync(); + + var plugins = await session.Rpc.Plugins.ListAsync(); + Assert.NotNull(plugins.Plugins); + Assert.All(plugins.Plugins, plugin => Assert.False(string.IsNullOrWhiteSpace(plugin.Name))); + } + + private CopilotClient CreateAuthenticatedClient(string token) + { + var env = new Dictionary(Ctx.GetEnvironment()) + { + ["COPILOT_DEBUG_GITHUB_API_URL"] = Ctx.ProxyUrl, + }; + + return Ctx.CreateClient(options: new CopilotClientOptions + { + GitHubToken = token, + }, environment: env); + } + + private async Task ConfigureAuthenticatedUserAsync(string token) + { + await Ctx.SetCopilotUserByTokenAsync(token, new CopilotUserConfig( + Login: "rpc-session-extras-user", + CopilotPlan: "individual_pro", + Endpoints: new CopilotUserEndpoints(Api: Ctx.ProxyUrl, Telemetry: "https://localhost:1/telemetry"), + AnalyticsTrackingId: "rpc-session-extras-tracking-id")); + } +} diff --git a/dotnet/test/E2E/RpcShellAndFleetE2ETests.cs b/dotnet/test/E2E/RpcShellAndFleetE2ETests.cs index a51fc7dae..2946b7bbe 100644 --- a/dotnet/test/E2E/RpcShellAndFleetE2ETests.cs +++ b/dotnet/test/E2E/RpcShellAndFleetE2ETests.cs @@ -28,7 +28,7 @@ public async Task Should_Execute_Shell_Command() [Fact] public async Task Should_Kill_Shell_Process() { - var session = await CreateSessionAsync(); + await using var session = await CreateSessionAsync(); var command = OperatingSystem.IsWindows() ? "powershell -NoLogo -NoProfile -Command \"Start-Sleep -Seconds 30\"" : "sleep 30"; diff --git a/dotnet/test/E2E/RpcShellUserRequestedE2ETests.cs b/dotnet/test/E2E/RpcShellUserRequestedE2ETests.cs new file mode 100644 index 000000000..c51b385d8 --- /dev/null +++ b/dotnet/test/E2E/RpcShellUserRequestedE2ETests.cs @@ -0,0 +1,119 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for the session-scoped user-requested shell RPC methods that were previously +/// untested: shell.executeUserRequested and shell.cancelUserRequested. +/// +public class RpcShellUserRequestedE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_shell_user_requested", output) +{ + [Fact] + public async Task Should_Execute_User_Requested_Shell_Command() + { + await using var session = await CreateSessionAsync(); + var marker = $"copilotusershell{Guid.NewGuid():N}"; + var requestId = $"req-{Guid.NewGuid():N}"; + + var result = await session.Rpc.Shell.ExecuteUserRequestedAsync(requestId, $"echo {marker}"); + + Assert.True(result.Success, $"Expected the shell command to succeed. Error: {result.Error}"); + Assert.True(result.ExitCode == 0, $"Expected exit code 0 but got {result.ExitCode}."); + Assert.Contains(marker, result.Output, StringComparison.Ordinal); + Assert.False(string.IsNullOrWhiteSpace(result.ToolCallId)); + } + + [Fact] + public async Task Should_Cancel_User_Requested_Shell_Command() + { + await using var session = await CreateSessionAsync(); + + // Cancelling an unknown request id is a clean negative: nothing is in flight to cancel. + var missing = await session.Rpc.Shell.CancelUserRequestedAsync($"missing-{Guid.NewGuid():N}"); + Assert.False(missing.Cancelled); + + // De-race an in-flight cancellation: launch a long command that first writes a marker file + // (so we know it is genuinely running) and then sleeps. Keep the marker outside the fixture + // workspace so Windows cleanup is not blocked by lingering process handles. + var requestId = $"req-{Guid.NewGuid():N}"; + var markerPath = Path.Join(Path.GetTempPath(), $"shell-cancel-{Guid.NewGuid():N}.txt"); + var executeTask = session.Rpc.Shell.ExecuteUserRequestedAsync( + requestId, + CreateMarkerThenSleepCommand(markerPath, seconds: 60)); + + try + { + await WaitForFileExistsAsync(markerPath); + + // The marker proves the child process reached the command body, but the runtime may not + // yet have registered the request in its cancellable in-flight map. Poll the cancel until + // it takes effect so the assertion is not racy. WaitForConditionAsync stops on the first + // call that reports Cancelled, so the command is cancelled exactly once. + await TestHelper.WaitForConditionAsync( + async () => (await session.Rpc.Shell.CancelUserRequestedAsync(requestId)).Cancelled, + timeout: TimeSpan.FromSeconds(15), + pollInterval: TimeSpan.FromMilliseconds(100), + timeoutMessage: "Timed out waiting for the user-requested shell command to become cancellable."); + + // The aborted execution returns a non-success result rather than hanging. + var result = await executeTask.WaitAsync(TimeSpan.FromSeconds(30)); + Assert.False(result.Success); + } + finally + { + if (!executeTask.IsCompleted) + { + try { await executeTask.WaitAsync(TimeSpan.FromSeconds(30)); } + catch { /* best-effort drain so the long command does not outlive the test */ } + } + + TryDeleteFile(markerPath); + } + } + + private static string CreateMarkerThenSleepCommand(string markerPath, int seconds) + { + // The runtime already runs the command through the platform shell (pwsh -Command "" on + // Windows, sh -c "" elsewhere), so emit the script body directly instead of spawning a + // *second* nested shell. Cancellation kills only the shell the runtime spawned; a nested + // powershell.exe/sh would be orphaned and keep the session working directory locked, which + // breaks fixture cleanup on Windows (manifesting as an IOException during teardown). + if (OperatingSystem.IsWindows()) + { + return $"Set-Content -LiteralPath '{markerPath}' -Value 'running'; Start-Sleep -Seconds {seconds}"; + } + + return $"echo running > '{markerPath}'; sleep {seconds}"; + } + + private static async Task WaitForFileExistsAsync(string path) + { + await TestHelper.WaitForConditionAsync( + () => File.Exists(path), + timeout: TimeSpan.FromSeconds(30), + timeoutMessage: $"Timed out waiting for the shell command to create '{path}'.", + pollInterval: TimeSpan.FromMilliseconds(100)); + } + + private static void TryDeleteFile(string path) + { + try + { + if (File.Exists(path)) + { + File.Delete(path); + } + } + catch (Exception ex) when (TestHelper.IsTransientFileSystemException(ex)) + { + // Best-effort cleanup; the OS temp directory is reclaimed independently. + } + } +} diff --git a/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs b/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs index fbb289297..640e4f72f 100644 --- a/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs +++ b/dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs @@ -72,6 +72,9 @@ await AssertImplementedFailureAsync( } [Fact] + // TODO(BYOK): Provider-backed task agents handled an invalid model differently. Verify that + // BYOK model validation should reject it consistently before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Report_Implemented_Error_For_Invalid_Task_Agent_Model() { var session = await CreateSessionAsync(); @@ -149,29 +152,38 @@ await TestHelper.WaitForConditionAsync( async () => { task = await FindAgentTaskAsync(session, started.AgentId); - return task?.LatestResponse?.Contains("TASK_AGENT_DONE", StringComparison.Ordinal) == true - || task?.Result?.Contains("TASK_AGENT_DONE", StringComparison.Ordinal) == true - || task?.Status == GitHub.Copilot.Rpc.TaskStatus.Completed - || task?.Status == GitHub.Copilot.Rpc.TaskStatus.Failed; + return task is null + || task.Status == GitHub.Copilot.Rpc.TaskStatus.Completed + || task.Status == GitHub.Copilot.Rpc.TaskStatus.Failed + || task.Status == GitHub.Copilot.Rpc.TaskStatus.Cancelled + || task.Status == GitHub.Copilot.Rpc.TaskStatus.Idle; }, timeout: TimeSpan.FromSeconds(60), timeoutMessage: $"Background agent task '{started.AgentId}' did not produce a final observable state."); - Assert.NotNull(task); - Assert.Contains("TASK_AGENT_DONE", task.LatestResponse ?? task.Result ?? string.Empty); - await taskCompletionNotification.Task.WaitAsync(TimeSpan.FromSeconds(30)); - - if (task.Status == GitHub.Copilot.Rpc.TaskStatus.Idle) + if (task is not null) { - var cancel = await session.Rpc.Tasks.CancelAsync(started.AgentId); - Assert.True(cancel.Cancelled); - } + Assert.Contains("TASK_AGENT_DONE", task.LatestResponse ?? task.Result ?? string.Empty); - var remove = await session.Rpc.Tasks.RemoveAsync(started.AgentId); - Assert.True(remove.Removed); + if (task.Status == GitHub.Copilot.Rpc.TaskStatus.Idle) + { + var cancel = await session.Rpc.Tasks.CancelAsync(started.AgentId); + Assert.True(cancel.Cancelled); + } + + var remove = await session.Rpc.Tasks.RemoveAsync(started.AgentId); + // Completion delivery also removes finished tasks, so this call may lose that race. + Assert.True( + remove.Removed || taskCompletionNotification.Task.IsCompleted, + $"Background agent task '{started.AgentId}' was not removed before its completion notification was delivered."); + } var afterRemove = await session.Rpc.Tasks.ListAsync(); - Assert.DoesNotContain(afterRemove.Tasks.OfType(), t => string.Equals(t.Id, started.AgentId, StringComparison.Ordinal)); + var taskAfterRemove = afterRemove.Tasks.OfType() + .SingleOrDefault(t => string.Equals(t.Id, started.AgentId, StringComparison.Ordinal)); + Assert.Null(taskAfterRemove); + + await taskCompletionNotification.Task.WaitAsync(TimeSpan.FromSeconds(30)); } [Fact] @@ -209,6 +221,14 @@ public async Task Should_Return_Expected_Results_For_Missing_Pending_Handler_Req response: UIAutoModeSwitchResponse.No); Assert.False(autoModeSwitch.Success); + var sessionLimits = await session.Rpc.Ui.HandlePendingSessionLimitsExhaustedAsync( + requestId: "missing-session-limits-exhausted-request", + response: new UISessionLimitsExhaustedResponse + { + Action = UISessionLimitsExhaustedResponseAction.Cancel, + }); + Assert.False(sessionLimits.Success); + var exitPlanMode = await session.Rpc.Ui.HandlePendingExitPlanModeAsync( requestId: "missing-exit-plan-mode-request", response: new UIExitPlanModeResponse @@ -251,6 +271,19 @@ public async Task Should_Return_Expected_Results_For_Missing_Pending_Handler_Req LocationKey = "missing-location", }); Assert.False(locationApproval.Success); + + var missingHeaders = await session.Rpc.Mcp.Headers.HandlePendingHeadersRefreshRequestAsync( + requestId: "missing-headers-refresh-request", + result: new McpHeadersHandlePendingHeadersRefreshRequestHeaders + { + Headers = new Dictionary { ["X-SDK-Test"] = "missing" }, + }); + Assert.False(missingHeaders.Success); + + var missingNoHeaders = await session.Rpc.Mcp.Headers.HandlePendingHeadersRefreshRequestAsync( + requestId: "missing-headers-refresh-none-request", + result: new McpHeadersHandlePendingHeadersRefreshRequestNone()); + Assert.False(missingNoHeaders.Success); } [Fact] diff --git a/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs b/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs new file mode 100644 index 000000000..76043fd73 --- /dev/null +++ b/dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot; +using GitHub.Copilot.Rpc; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +/// +/// E2E coverage for the session-scoped session.ui.ephemeralQuery RPC method. Unlike the +/// other newly covered methods this one is model-backed: the runtime runs a transient, no-tools +/// model completion against the current conversation context and returns the assistant's answer +/// without recording it in the conversation history. The exchange is served from a recorded +/// snapshot so the assertion on the answer text is deterministic. +/// +public class RpcUiEphemeralQueryE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "rpc_ui_ephemeral_query", output) +{ + [Fact] + public async Task Should_Answer_Ephemeral_Query() + { + await using var session = await CreateSessionAsync(); + + // A fresh session has no prior turns, so the ephemeral query is sent to the model as a + // single user message with the runtime's transient "quick side question" system prompt. + // The recorded snapshot supplies a canned answer, letting us assert a meaningful value. + var result = await session.Rpc.Ui.EphemeralQueryAsync( + "In one word, what is the primary color of a clear daytime sky?"); + + Assert.NotNull(result); + Assert.False(string.IsNullOrWhiteSpace(result.Answer)); + Assert.Contains("blue", result.Answer, StringComparison.OrdinalIgnoreCase); + } +} diff --git a/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs b/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs index ea4ae15b4..092b28971 100644 --- a/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs +++ b/dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs @@ -29,7 +29,7 @@ public async Task Should_Return_Null_Or_Empty_Content_For_Unknown_Checkpoint() { await using var session = await CreateSessionAsync(); - var result = await session.Rpc.Workspaces.ReadCheckpointAsync(long.MaxValue); + var result = await session.Rpc.Workspaces.ReadCheckpointAsync(uint.MaxValue); Assert.True(string.IsNullOrEmpty(result.Content)); } diff --git a/dotnet/test/E2E/SessionConfigE2ETests.cs b/dotnet/test/E2E/SessionConfigE2ETests.cs index a763b6b72..1bc4c52eb 100644 --- a/dotnet/test/E2E/SessionConfigE2ETests.cs +++ b/dotnet/test/E2E/SessionConfigE2ETests.cs @@ -4,6 +4,7 @@ using GitHub.Copilot.Rpc; using GitHub.Copilot.Test.Harness; +using System.Text; using System.Text.Json; using Xunit; using Xunit.Abstractions; @@ -21,6 +22,9 @@ public class SessionConfigE2ETests(E2ETestFixture fixture, ITestOutputHelper out "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="); [Fact] + // TODO(BYOK): Anthropic Messages history diverged after enabling vision via SetModel. Verify + // that model capability overrides work for provider-backed sessions before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Vision_Disabled_Then_Enabled_Via_SetModel() { await File.WriteAllBytesAsync(Path.Join(Ctx.WorkDir, "test.png"), Png1X1); @@ -61,6 +65,9 @@ await session.SetModelAsync( } [Fact] + // TODO(BYOK): Anthropic Messages history diverged after disabling vision via SetModel. Verify + // that model capability overrides work for provider-backed sessions before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Vision_Enabled_Then_Disabled_Via_SetModel() { await File.WriteAllBytesAsync(Path.Join(Ctx.WorkDir, "test.png"), Png1X1); @@ -120,6 +127,7 @@ public async Task Should_Use_Custom_SessionId() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Apply_ReasoningEffort_On_Session_Create() { const string reasoningModelId = "custom-reasoning-model"; @@ -139,6 +147,7 @@ public async Task Should_Apply_ReasoningEffort_On_Session_Create() } [Theory] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] [InlineData("low")] [InlineData("medium")] [InlineData("high")] @@ -161,11 +170,14 @@ public async Task Should_Apply_All_ReasoningEffort_Values_On_Session_Create(stri } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Apply_ReasoningEffort_On_Session_Resume() { - var originalSession = await CreateSessionAsync(); + await using var originalSession = await CreateSessionAsync(); + var sessionId = originalSession.SessionId; + await SuspendAndUntrackSessionForResumeAsync(originalSession); const string reasoningModelId = "custom-reasoning-model"; - var resumedSession = await ResumeSessionAsync(originalSession.SessionId, new ResumeSessionConfig + var resumedSession = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { Model = reasoningModelId, Provider = CreateProxyProvider("resume-reasoning"), @@ -177,10 +189,12 @@ public async Task Should_Apply_ReasoningEffort_On_Session_Resume() Assert.Equal("high", resumeEvent.Data.ReasoningEffort); await resumedSession.DisposeAsync(); - await originalSession.DisposeAsync(); } [Fact] + // TODO(BYOK): The Anthropic user-agent omitted ClientName and contained only its provider SDK + // identifier. Determine the expected propagation for custom providers before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Forward_ClientName_In_UserAgent() { var session = await CreateSessionAsync(new SessionConfig @@ -197,6 +211,7 @@ public async Task Should_Forward_ClientName_In_UserAgent() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Forward_Custom_Provider_Headers_On_Create() { var session = await CreateSessionAsync(new SessionConfig @@ -216,10 +231,12 @@ public async Task Should_Forward_Custom_Provider_Headers_On_Create() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Forward_Custom_Provider_Headers_On_Resume() { - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { @@ -238,6 +255,7 @@ public async Task Should_Forward_Custom_Provider_Headers_On_Resume() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Forward_Provider_Wire_Model() { // Verifies that ProviderConfig.WireModel overrides the model name sent to @@ -269,6 +287,7 @@ public async Task Should_Forward_Provider_Wire_Model() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Use_Provider_Model_Id_As_Wire_Model() { // ProviderConfig.ModelId drives both the runtime resolved model AND the wire model @@ -322,8 +341,9 @@ public async Task Should_Apply_WorkingDirectory_On_Session_Resume() Directory.CreateDirectory(subDir); await File.WriteAllTextAsync(Path.Join(subDir, "resume-marker.txt"), "I am in the resume working directory"); - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { @@ -343,8 +363,9 @@ public async Task Should_Apply_WorkingDirectory_On_Session_Resume() [Fact] public async Task Should_Apply_SystemMessage_On_Session_Resume() { - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); var resumeInstruction = "End the response with RESUME_SYSTEM_MESSAGE_SENTINEL."; var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig @@ -405,11 +426,13 @@ await File.WriteAllTextAsync( Path.Join(instructionFilesDir, "extra.instructions.md"), $"Always include {sentinel}."); - var session1 = await CreateSessionAsync(new SessionConfig + await using var session1 = await CreateSessionAsync(new SessionConfig { WorkingDirectory = projectDir, }); - var session2 = await ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig + var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); + var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { WorkingDirectory = projectDir, InstructionDirectories = [instructionDir], @@ -421,14 +444,14 @@ await File.WriteAllTextAsync( Assert.Contains(sentinel, GetSystemMessage(exchange)); await session2.DisposeAsync(); - await session1.DisposeAsync(); } [Fact] public async Task Should_Apply_AvailableTools_On_Session_Resume() { - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { @@ -449,6 +472,203 @@ public async Task Should_Apply_AvailableTools_On_Session_Resume() } [Fact] + public async Task Should_Apply_Session_Limits_On_Create() + { + var session = await CreateSessionAsync(new SessionConfig + { + SessionLimits = new SessionLimitsConfig + { + MaxAiCredits = 30, + }, + }); + + try + { + var exchange = await SendAndGetNextExchangeAsync( + session, + "Acknowledge the current session limits."); + + AssertSessionLimitsStatus(exchange, "30 AI credits"); + } + finally + { + await session.DisposeAsync(); + } + } + + [Fact] + public async Task Should_Apply_Session_Limits_On_Resume() + { + await using var session1 = await CreateSessionAsync(); + var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); + var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig + { + SessionLimits = new SessionLimitsConfig + { + MaxAiCredits = 30, + }, + }); + + try + { + var exchange = await SendAndGetNextExchangeAsync( + session2, + "Acknowledge the current session limits."); + + AssertSessionLimitsStatus(exchange, "30 AI credits"); + } + finally + { + await session2.DisposeAsync(); + } + } + + [Fact] + public async Task Should_Apply_Excluded_Built_In_Agents_On_Create() + { + const string excludedAgent = "explore"; + const string prompt = "What is 1+1?"; + + var baselineSession = await CreateSessionAsync(); + try + { + var baselineExchange = await SendAndGetNextExchangeAsync(baselineSession, prompt); + Assert.Contains(excludedAgent, GetTaskAgentTypes(baselineExchange)); + } + finally + { + await baselineSession.DisposeAsync(); + } + + var excludedSession = await CreateSessionAsync(new SessionConfig + { + ExcludedBuiltInAgents = [excludedAgent], + }); + + try + { + var excludedExchange = await SendAndGetNextExchangeAsync(excludedSession, prompt); + var agentTypes = GetTaskAgentTypes(excludedExchange); + + Assert.NotEmpty(agentTypes); + Assert.DoesNotContain(excludedAgent, agentTypes); + } + finally + { + await excludedSession.DisposeAsync(); + } + } + + [Fact] + public async Task Should_Apply_Excluded_Built_In_Agents_On_Resume() + { + const string excludedAgent = "explore"; + + await using var session1 = await CreateSessionAsync(); + var sessionId = session1.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session1); + var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig + { + ExcludedBuiltInAgents = [excludedAgent], + }); + + try + { + var exchange = await SendAndGetNextExchangeAsync(session2, "What is 1+1?"); + var agentTypes = GetTaskAgentTypes(exchange); + + Assert.NotEmpty(agentTypes); + Assert.DoesNotContain(excludedAgent, agentTypes); + } + finally + { + await session2.DisposeAsync(); + } + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Should_Enable_Citations_For_Anthropic_File_Attachments_On_Create() + { + var handler = new RecordingRequestHandler(); + await using var client = CreateClientWithRequestHandler(handler); + await client.StartAsync(); + + var session = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + Model = "claude-sonnet-4.5", + EnableCitations = true, + Provider = CreateAnthropicProvider(), + }); + + try + { + await session.SendAndWaitAsync(new MessageOptions + { + Prompt = "Summarize the attached PDF with citations enabled.", + Attachments = [CreatePdfAttachment()], + }); + + AssertAnthropicDocumentCitationsEnabled(Assert.Single(handler.InferenceRequests).Body); + } + finally + { + await session.DisposeAsync(); + } + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] + public async Task Should_Enable_Citations_For_Anthropic_File_Attachments_On_Resume() + { + const string connectionToken = "citation-resume-token"; + var handler = new RecordingRequestHandler(); + await using var client = CreateClientWithRequestHandler( + handler, + RuntimeConnection.ForTcp(connectionToken: connectionToken)); + await client.StartAsync(); + + var session1 = await Ctx.CreateSessionAsync(client, new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + var sessionId = session1.SessionId; + var port = client.RuntimePort + ?? throw new InvalidOperationException("The handler-backed E2E client must use TCP transport to support multi-client resume."); + await using var resumeClient = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri($"localhost:{port}", connectionToken: connectionToken), + }); + + var session2 = await Ctx.ResumeSessionAsync(resumeClient, sessionId, new ResumeSessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + Model = "claude-sonnet-4.5", + EnableCitations = true, + Provider = CreateAnthropicProvider(), + }); + + try + { + await session2.SendAndWaitAsync(new MessageOptions + { + Prompt = "Summarize the attached PDF with citations enabled.", + Attachments = [CreatePdfAttachment()], + }); + + AssertAnthropicDocumentCitationsEnabled(Assert.Single(handler.InferenceRequests).Body); + } + finally + { + await session2.DisposeAsync(); + await session1.DisposeAsync(); + } + } + + [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Create_Session_With_Custom_Provider_Config() { // Per the TS test (session_config.e2e.test.ts), this only verifies that a @@ -476,6 +696,9 @@ public async Task Should_Create_Session_With_Custom_Provider_Config() } [Fact] + // TODO(BYOK): Anthropic Messages request history diverged while replaying this blob attachment. + // Confirm native clients preserve blob/image turns before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Accept_Blob_Attachments() { // Write the image to disk so the model can view it if it tries @@ -492,7 +715,7 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "What color is this pixel? Reply in one word.", Attachments = [ - new UserMessageAttachmentBlob + new AttachmentBlob { Data = pngBase64, MimeType = "image/png", @@ -517,7 +740,7 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "Summarize the attached file", Attachments = [ - new UserMessageAttachmentFile + new AttachmentFile { Path = attachedPath, DisplayName = "attached.txt", @@ -542,6 +765,95 @@ private static bool HasImageUrlContent(List messages) typeProp.GetString() == "image_url")); } + private CopilotClient CreateClientWithRequestHandler( + CopilotRequestHandler handler, + RuntimeConnection? connection = null) + { + return Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = connection ?? RuntimeConnection.ForStdio(), + RequestHandler = handler, + }); + } + + private async Task SendAndGetNextExchangeAsync(CopilotSession session, string prompt) + { + var existingCount = (await Ctx.GetExchangesAsync()).Count; + var exchanges = await SendAndWaitForExchangesAsync( + session, + new MessageOptions { Prompt = prompt }, + minimumCount: existingCount + 1); + return exchanges[existingCount]; + } + + private static void AssertSessionLimitsStatus(ParsedHttpExchange exchange, string expectedRemaining) + { + var message = exchange.Request.Messages.SingleOrDefault(m => + m.Role == "user" + && m.StringContent?.Contains("", StringComparison.Ordinal) == true); + + Assert.NotNull(message); + Assert.Contains($"Remaining session limits: {expectedRemaining}.", message!.StringContent); + Assert.Contains( + "Be frugal; avoid optional exploration and unnecessary tool calls.", + message.StringContent); + } + + private static IReadOnlyList GetTaskAgentTypes(ParsedHttpExchange exchange) + { + var taskTool = Assert.Single( + exchange.Request.Tools ?? [], + tool => string.Equals(tool.Function.Name, "task", StringComparison.Ordinal)); + var parameters = taskTool.Function.Parameters; + + Assert.NotNull(parameters); + var enumValues = parameters!.Value + .GetProperty("properties") + .GetProperty("agent_type") + .GetProperty("enum"); + + return [.. enumValues.EnumerateArray().Select(value => value.GetString()).OfType()]; + } + + private static AttachmentBlob CreatePdfAttachment() + { + const string pdfText = "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n"; + + return new AttachmentBlob + { + Data = Convert.ToBase64String(Encoding.ASCII.GetBytes(pdfText)), + DisplayName = "citation-source.pdf", + MimeType = "application/pdf", + }; + } + + private static ProviderConfig CreateAnthropicProvider() + { + return new ProviderConfig + { + Type = "anthropic", + BaseUrl = "https://anthropic-citations.invalid/v1", + ApiKey = "test-provider-key", + ModelId = "claude-sonnet-4.5", + WireModel = "claude-sonnet-4.5", + }; + } + + private static void AssertAnthropicDocumentCitationsEnabled(string requestBody) + { + using var document = JsonDocument.Parse(requestBody); + var documentBlocks = document.RootElement + .GetProperty("messages") + .EnumerateArray() + .SelectMany(message => message.GetProperty("content").EnumerateArray()) + .Where(block => block.GetProperty("type").GetString() == "document") + .ToList(); + + var documentBlock = Assert.Single(documentBlocks); + Assert.Equal("citation-source.pdf", documentBlock.GetProperty("title").GetString()); + Assert.True(documentBlock.GetProperty("citations").GetProperty("enabled").GetBoolean()); + } + private ProviderConfig CreateProxyProvider(string headerValue) { return new ProviderConfig diff --git a/dotnet/test/E2E/SessionE2ETests.cs b/dotnet/test/E2E/SessionE2ETests.cs index 7825f479c..27ef7437f 100644 --- a/dotnet/test/E2E/SessionE2ETests.cs +++ b/dotnet/test/E2E/SessionE2ETests.cs @@ -34,7 +34,7 @@ public async Task ShouldCreateAndDisconnectSessions() [Fact] public async Task Should_Have_Stateful_Conversation() { - var session = await CreateSessionAsync(); + await using var session = await CreateSessionAsync(); var assistantMessage = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 1+1?" }); Assert.NotNull(assistantMessage); @@ -228,11 +228,11 @@ public async Task Should_Create_Session_With_Custom_Tool() [Fact] public async Task Should_Reject_Resuming_Active_Session_Using_The_Same_Client() { - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; var exception = await Assert.ThrowsAsync(() => - Client.ResumeSessionAsync(sessionId, new ResumeSessionConfig + Ctx.ResumeSessionAsync(Client, sessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, })); @@ -245,13 +245,12 @@ public async Task Should_Resume_A_Session_Using_A_New_Client() var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; - await session1.SendAsync(new MessageOptions { Prompt = "What is 1+1?" }); - var answer = await TestHelper.GetFinalAssistantMessageAsync(session1); + var answer = await session1.SendAndWaitAsync(new MessageOptions { Prompt = "What is 1+1?" }); Assert.NotNull(answer); Assert.Contains("2", answer!.Data.Content ?? string.Empty); using var newClient = Ctx.CreateClient(); - var session2 = await newClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(newClient, sessionId, new ResumeSessionConfig { ContinuePendingWork = true, OnPermissionRequest = PermissionHandler.ApproveAll, @@ -269,6 +268,33 @@ public async Task Should_Resume_A_Session_Using_A_New_Client() Assert.Contains("4", answer2!.Data.Content ?? string.Empty); } + [Fact] + public async Task Resumes_A_Persisted_Session_From_A_New_Client_When_An_Mcp_OAuth_Handler_Is_Configured() + { + static Task CancelMcpAuthAsync(McpAuthContext request) + => Task.FromResult(McpAuthResult.Cancel()); + + await using var session1 = await CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = CancelMcpAuthAsync, + }); + var sessionId = session1.SessionId; + + var answer = await session1.SendAndWaitAsync(new MessageOptions { Prompt = "What is 1+1?" }); + Assert.NotNull(answer); + Assert.Contains("2", answer!.Data.Content ?? string.Empty); + + using var newClient = Ctx.CreateClient(); + await using var session2 = await Ctx.ResumeSessionAsync(newClient, sessionId, new ResumeSessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = CancelMcpAuthAsync, + }); + + Assert.Equal(sessionId, session2.SessionId); + } + [Fact] public async Task Should_Throw_Error_When_Resuming_Non_Existent_Session() { @@ -305,10 +331,10 @@ await session.SendAsync(new MessageOptions // Verify an abort event exists in messages Assert.Contains(messages, m => m is AbortEvent); - // We should be able to send another message - var answer = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 2+2?" }); - Assert.NotNull(answer); - Assert.Contains("4", answer!.Data.Content ?? string.Empty); + await session.SendAsync(new MessageOptions { Prompt = "What is 2+2?" }); + var recoveryMessage = await TestHelper.GetFinalAssistantMessageAsync(session); + Assert.NotNull(recoveryMessage); + Assert.Contains("4", recoveryMessage.Data.Content ?? string.Empty); } [Fact] @@ -585,14 +611,17 @@ public async Task Should_Set_Model_On_Existing_Session() [Fact] public async Task Should_Set_Model_With_ReasoningEffort() { - var session = await CreateSessionAsync(); + await using var isolatedCtx = await E2ETestContext.CreateAsync(); + await isolatedCtx.ConfigureForTestAsync("session", nameof(Should_Set_Model_With_ReasoningEffort)); + var isolatedClient = isolatedCtx.CreateClient(); + await using var session = await isolatedCtx.CreateSessionAsync(isolatedClient); var modelChangedTask = TestHelper.GetNextEventOfTypeAsync(session); - await session.SetModelAsync("gpt-4.1", "high"); + await session.SetModelAsync("gpt-5.4", "high"); var modelChanged = await modelChangedTask; - Assert.Equal("gpt-4.1", modelChanged.Data.NewModel); + Assert.Equal("gpt-5.4", modelChanged.Data.NewModel); Assert.Equal("high", modelChanged.Data.ReasoningEffort); } @@ -689,20 +718,25 @@ public async Task DisposeAsync_From_Handler_Does_Not_Deadlock() session.On(evt => { - if (evt is UserMessageEvent) + if (evt is SessionInfoEvent) { // Call DisposeAsync from within a handler — must not deadlock. session.DisposeAsync().AsTask().ContinueWith(_ => disposed.TrySetResult()); } }); - await session.SendAsync(new MessageOptions { Prompt = "What is 1+1?" }); + await session.LogAsync("Dispose from handler trigger"); // If this times out, we deadlocked. await disposed.Task.WaitAsync(TimeSpan.FromSeconds(10)); + + await Client.ForceStopAsync(); } [Fact] + // TODO(BYOK): Anthropic Messages request history diverged while replaying this blob attachment. + // Confirm native clients preserve blob/image turns before keeping this CAPI-only. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Accept_Blob_Attachments() { var pngBase64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="; @@ -715,7 +749,7 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "Describe this image", Attachments = [ - new UserMessageAttachmentBlob + new AttachmentBlob { Data = pngBase64, MimeType = "image/png", @@ -740,17 +774,17 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "Read the attached file and reply with its contents.", Attachments = [ - new UserMessageAttachmentFile + new AttachmentFile { DisplayName = "attached-file.txt", Path = filePath, - LineRange = new UserMessageAttachmentFileLineRange { Start = 1, End = 1 }, + LineRange = new AttachmentFileLineRange { Start = 1, End = 1 }, }, ], }); var userMessage = (await session.GetEventsAsync()).OfType().Last(); - var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); + var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); Assert.Equal("attached-file.txt", attachment.DisplayName); Assert.Equal(filePath, attachment.Path); Assert.Equal(1, attachment.LineRange!.Start); @@ -771,7 +805,7 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "List the attached directory.", Attachments = [ - new UserMessageAttachmentDirectory + new AttachmentDirectory { DisplayName = "attached-directory", Path = directoryPath, @@ -780,7 +814,7 @@ await session.SendAndWaitAsync(new MessageOptions }); var userMessage = (await session.GetEventsAsync()).OfType().Last(); - var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); + var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); Assert.Equal("attached-directory", attachment.DisplayName); Assert.Equal(directoryPath, attachment.Path); } @@ -798,22 +832,22 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "Summarize the selected code.", Attachments = [ - new UserMessageAttachmentSelection + new AttachmentSelection { DisplayName = "selected-file.cs", FilePath = filePath, Text = "string Value = \"SELECTION_SENTINEL\";", - Selection = new UserMessageAttachmentSelectionDetails + Selection = new AttachmentSelectionDetails { - Start = new UserMessageAttachmentSelectionDetailsStart { Line = 1, Character = 10 }, - End = new UserMessageAttachmentSelectionDetailsEnd { Line = 1, Character = 45 }, + Start = new AttachmentSelectionDetailsStart { Line = 1, Character = 10 }, + End = new AttachmentSelectionDetailsEnd { Line = 1, Character = 45 }, }, }, ], }); var userMessage = (await session.GetEventsAsync()).OfType().Last(); - var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); + var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); Assert.Equal("selected-file.cs", attachment.DisplayName); Assert.Equal(filePath, attachment.FilePath); Assert.Equal("string Value = \"SELECTION_SENTINEL\";", attachment.Text); @@ -824,7 +858,7 @@ await session.SendAndWaitAsync(new MessageOptions } [Fact] - public async Task Should_Send_With_Github_Reference_Attachment() + public async Task Should_Send_With_GitHub_Reference_Attachment() { var session = await CreateSessionAsync(); @@ -833,10 +867,10 @@ await session.SendAndWaitAsync(new MessageOptions Prompt = "Using only the GitHub reference metadata in this message, summarize the reference. Do not call any tools.", Attachments = [ - new UserMessageAttachmentGithubReference + new AttachmentGitHubReference { Number = 1234, - ReferenceType = UserMessageAttachmentGithubReferenceType.Issue, + ReferenceType = AttachmentGitHubReferenceType.Issue, State = "open", Title = "Add E2E attachment coverage", Url = "https://github.com/github/copilot-sdk/issues/1234", @@ -845,9 +879,9 @@ await session.SendAndWaitAsync(new MessageOptions }); var userMessage = (await session.GetEventsAsync()).OfType().Last(); - var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); + var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!)); Assert.Equal(1234, attachment.Number); - Assert.Equal(UserMessageAttachmentGithubReferenceType.Issue, attachment.ReferenceType); + Assert.Equal(AttachmentGitHubReferenceType.Issue, attachment.ReferenceType); Assert.Equal("open", attachment.State); Assert.Equal("Add E2E attachment coverage", attachment.Title); Assert.Equal("https://github.com/github/copilot-sdk/issues/1234", attachment.Url); @@ -893,6 +927,7 @@ await session.SendAndWaitAsync(new MessageOptions } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Create_Session_With_Custom_Provider() { var session = await CreateSessionAsync(new SessionConfig @@ -918,6 +953,7 @@ public async Task Should_Create_Session_With_Custom_Provider() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Create_Session_With_Azure_Provider() { var session = await CreateSessionAsync(new SessionConfig @@ -947,10 +983,12 @@ public async Task Should_Create_Session_With_Azure_Provider() } [Fact] + [Trait(E2ETestTraits.Backend, E2ETestTraits.SelfConfiguredBackend)] public async Task Should_Resume_Session_With_Custom_Provider() { - var session = await CreateSessionAsync(); + await using var session = await CreateSessionAsync(); var sessionId = session.SessionId; + await SuspendAndUntrackSessionForResumeAsync(session); var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig { @@ -972,7 +1010,5 @@ public async Task Should_Resume_Session_With_Custom_Provider() { // disconnect may fail since the provider is fake } - - await session.DisposeAsync(); } } diff --git a/dotnet/test/E2E/SessionFsE2ETests.cs b/dotnet/test/E2E/SessionFsE2ETests.cs index 1d0157658..cc02b5abf 100644 --- a/dotnet/test/E2E/SessionFsE2ETests.cs +++ b/dotnet/test/E2E/SessionFsE2ETests.cs @@ -28,7 +28,7 @@ public async Task Should_Route_File_Operations_Through_The_Session_Fs_Provider() { await using var client = CreateSessionFsClient(providerRoot); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new TestSessionFsHandler(s.SessionId, providerRoot), @@ -58,7 +58,7 @@ public async Task Should_Load_Session_Data_From_Fs_Provider_On_Resume() await using var client = CreateSessionFsClient(providerRoot); Func createSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot); - var session1 = await client.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = createSessionFsHandler, @@ -72,7 +72,7 @@ public async Task Should_Load_Session_Data_From_Fs_Provider_On_Resume() var eventsPath = GetStoredPath(providerRoot, sessionId, $"{SessionFsConfig.SessionStatePath}/events.jsonl"); await WaitForConditionAsync(() => File.Exists(eventsPath)); - var session2 = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(client, sessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = createSessionFsHandler, @@ -97,7 +97,7 @@ public async Task Should_Reject_SetProvider_When_Sessions_Already_Exist() await using var client1 = CreateSessionFsClient(providerRoot, useStdio: false, tcpConnectionToken: "session-fs-shared-token"); var createSessionFsHandler = (Func)(s => new TestSessionFsHandler(s.SessionId, providerRoot)); - _ = await client1.CreateSessionAsync(new SessionConfig + _ = await Ctx.CreateSessionAsync(client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = createSessionFsHandler, @@ -319,7 +319,7 @@ public async Task Should_Map_Large_Output_Handling_Into_SessionFs() var suppliedFileContent = new string('x', largeContentSize); await using var client = CreateSessionFsClient(providerRoot); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new TestSessionFsHandler(s.SessionId, providerRoot), @@ -361,7 +361,7 @@ public async Task Should_Succeed_With_Compaction_While_Using_SessionFs() try { await using var client = CreateSessionFsClient(providerRoot); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new TestSessionFsHandler(s.SessionId, providerRoot), @@ -400,7 +400,7 @@ public async Task Should_Write_Workspace_Metadata_Via_SessionFs() try { await using var client = CreateSessionFsClient(providerRoot); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new TestSessionFsHandler(s.SessionId, providerRoot), @@ -410,8 +410,10 @@ public async Task Should_Write_Workspace_Metadata_Via_SessionFs() Assert.Contains("56", msg?.Data.Content ?? string.Empty); var workspaceYamlPath = GetStoredPath(providerRoot, session.SessionId, $"{SessionFsConfig.SessionStatePath}/workspace.yaml"); - await WaitForConditionAsync(() => File.Exists(workspaceYamlPath), TimeSpan.FromSeconds(30)); - Assert.Contains(session.SessionId, await ReadAllTextSharedAsync(workspaceYamlPath)); + await WaitForConditionAsync( + async () => File.Exists(workspaceYamlPath) + && (await ReadAllTextSharedAsync(workspaceYamlPath)).Contains(session.SessionId), + TimeSpan.FromSeconds(30)); var indexPath = GetStoredPath(providerRoot, session.SessionId, $"{SessionFsConfig.SessionStatePath}/checkpoints/index.md"); await WaitForConditionAsync(() => File.Exists(indexPath), TimeSpan.FromSeconds(30)); @@ -431,7 +433,7 @@ public async Task Should_Persist_Plan_Md_Via_SessionFs() try { await using var client = CreateSessionFsClient(providerRoot); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new TestSessionFsHandler(s.SessionId, providerRoot), @@ -442,8 +444,10 @@ public async Task Should_Persist_Plan_Md_Via_SessionFs() await session.Rpc.Plan.UpdateAsync("# Test Plan\n\nThis is a test."); var planPath = GetStoredPath(providerRoot, session.SessionId, $"{SessionFsConfig.SessionStatePath}/plan.md"); - await WaitForConditionAsync(() => File.Exists(planPath), TimeSpan.FromSeconds(30)); - Assert.Contains("This is a test.", await ReadAllTextSharedAsync(planPath)); + await WaitForConditionAsync( + async () => File.Exists(planPath) + && (await ReadAllTextSharedAsync(planPath)).Contains("This is a test."), + TimeSpan.FromSeconds(30)); await session.DisposeAsync(); } @@ -577,7 +581,8 @@ private static string NormalizeRelativePathSegment(string segment, string paramN return normalized; } - private sealed class ThrowingSessionFsProvider(Exception exception) : SessionFsProvider, ISessionFsSqliteProvider + private sealed class ThrowingSessionFsProvider(Exception exception) + : SessionFsProvider, ISessionFsSqliteProvider, ISessionFsSqliteTransactionProvider { protected override Task ReadFileAsync(string path, CancellationToken cancellationToken) => Task.FromException(exception); @@ -612,6 +617,9 @@ protected override Task RenameAsync(string src, string dest, CancellationToken c Task ISessionFsSqliteProvider.QueryAsync(SessionFsSqliteQueryType queryType, string query, IDictionary? bindParams, CancellationToken cancellationToken) => Task.FromException(exception); + Task> ISessionFsSqliteTransactionProvider.TransactionAsync(IList statements, CancellationToken cancellationToken) => + Task.FromException>(exception); + Task ISessionFsSqliteProvider.ExistsAsync(CancellationToken cancellationToken) => Task.FromException(exception); } diff --git a/dotnet/test/E2E/SessionFsSqliteE2ETests.cs b/dotnet/test/E2E/SessionFsSqliteE2ETests.cs index 1e6175f9c..8ed86c72e 100644 --- a/dotnet/test/E2E/SessionFsSqliteE2ETests.cs +++ b/dotnet/test/E2E/SessionFsSqliteE2ETests.cs @@ -31,7 +31,7 @@ public async Task Should_Route_Sql_Queries_Through_The_Sessionfs_Sqlite_Handler( { await using var client = CreateSessionFsClient(); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => new InMemorySessionFsSqliteHandler(s.SessionId, _sqliteCalls), @@ -65,7 +65,7 @@ public async Task Should_Allow_Subagents_To_Use_Sql_Tool_Via_Inherited_Sessionfs await using var client = CreateSessionFsClient(); var handler = (InMemorySessionFsSqliteHandler?)null; - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, CreateSessionFsProvider = s => @@ -117,9 +117,9 @@ await TestHelper.WaitForConditionAsync( private CopilotClient CreateSessionFsClient() { return Ctx.CreateClient( - useStdio: true, options: new CopilotClientOptions { + Connection = RuntimeConnection.ForStdio(), SessionFs = SessionFsConfig, }); } diff --git a/dotnet/test/E2E/SessionMcpAndAgentConfigE2ETests.cs b/dotnet/test/E2E/SessionMcpAndAgentConfigE2ETests.cs index 18a8835a6..796c02121 100644 --- a/dotnet/test/E2E/SessionMcpAndAgentConfigE2ETests.cs +++ b/dotnet/test/E2E/SessionMcpAndAgentConfigE2ETests.cs @@ -23,9 +23,7 @@ public async Task Should_Accept_MCP_Server_Configuration_On_Session_Create() await WaitForMcpServerStatusAsync(session, "test-server", McpServerStatus.Connected); // Simple interaction to verify session works - await session.SendAsync(new MessageOptions { Prompt = "What is 2+2?" }); - - var message = await TestHelper.GetFinalAssistantMessageAsync(session); + var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 2+2?" }); Assert.NotNull(message); Assert.Contains("4", message!.Data.Content); @@ -112,9 +110,7 @@ public async Task Should_Accept_Custom_Agent_Configuration_On_Session_Create() Assert.Matches(@"^[a-f0-9-]+$", session.SessionId); // Simple interaction to verify session works - await session.SendAsync(new MessageOptions { Prompt = "What is 5+5?" }); - - var message = await TestHelper.GetFinalAssistantMessageAsync(session); + var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 5+5?" }); Assert.NotNull(message); Assert.Contains("10", message!.Data.Content); diff --git a/dotnet/test/E2E/SessionTodosChangedE2ETests.cs b/dotnet/test/E2E/SessionTodosChangedE2ETests.cs new file mode 100644 index 000000000..c99086648 --- /dev/null +++ b/dotnet/test/E2E/SessionTodosChangedE2ETests.cs @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +public class SessionTodosChangedE2ETests(E2ETestFixture fixture, ITestOutputHelper output) + : E2ETestBase(fixture, "session_todos_changed", output) +{ + private static readonly string[] ExpectedTodoIds = ["alpha", "beta"]; + + [Fact] + public async Task Fires_Session_Todos_Changed_And_Exposes_Rows_And_Dependencies() + { + await using var session = await CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + var todosChangedTask = TestHelper.GetNextEventOfTypeAsync( + session, + TimeSpan.FromSeconds(30)); + + await session.SendAndWaitAsync(new MessageOptions + { + Prompt = + "Use the sql tool exactly once to execute all three of the following statements " + + "together, in this exact order, in a single sql tool call (a single query string " + + "containing all three statements):\n" + + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n" + + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n" + + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n" + + "Then stop. Do not insert any other rows or create any other tables.", + }); + + await todosChangedTask; + + var result = await session.Rpc.Plan.ReadSqlTodosWithDependenciesAsync(); + + var ids = result.Rows + .Select(row => row.Id) + .OfType() + .OrderBy(id => id, StringComparer.Ordinal) + .ToArray(); + + Assert.Equal(ExpectedTodoIds, ids); + + Assert.Contains(result.Dependencies, dependency => + dependency.TodoId == "beta" && + dependency.DependsOn == "alpha"); + } +} diff --git a/dotnet/test/E2E/SkillsE2ETests.cs b/dotnet/test/E2E/SkillsE2ETests.cs index 76f84106f..3b005fc01 100644 --- a/dotnet/test/E2E/SkillsE2ETests.cs +++ b/dotnet/test/E2E/SkillsE2ETests.cs @@ -208,13 +208,14 @@ public async Task Should_Apply_Skill_On_Session_Resume_With_SkillDirectories() var skillsDir = CreateSkillDir(); // Create a session without skills first - var session1 = await CreateSessionAsync(); + await using var session1 = await CreateSessionAsync(); var sessionId = session1.SessionId; // First message without skill - marker should not appear var message1 = await session1.SendAndWaitAsync(new MessageOptions { Prompt = "Say hi." }); Assert.NotNull(message1); Assert.DoesNotContain(SkillMarker, message1!.Data.Content); + await SuspendAndUntrackSessionForResumeAsync(session1); // Resume with skillDirectories - skill should now be active var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig diff --git a/dotnet/test/E2E/StreamingFidelityE2ETests.cs b/dotnet/test/E2E/StreamingFidelityE2ETests.cs index fec00f1cb..bea4760c8 100644 --- a/dotnet/test/E2E/StreamingFidelityE2ETests.cs +++ b/dotnet/test/E2E/StreamingFidelityE2ETests.cs @@ -2,6 +2,7 @@ * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ +using GitHub.Copilot.Test.Harness; using Xunit; using Xunit.Abstractions; @@ -46,6 +47,9 @@ public async Task Should_Produce_Delta_Events_When_Streaming_Is_Enabled() } [Fact] + // TODO(BYOK): Anthropic Messages emitted delta events with Streaming=false. Investigate the + // native-client streaming contract before keeping this disabled for every BYOK backend. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Not_Produce_Deltas_When_Streaming_Is_Disabled() { var session = await CreateSessionAsync(new SessionConfig { Streaming = false }); @@ -79,7 +83,7 @@ public async Task Should_Produce_Deltas_After_Session_Resume() // Resume using a new client using var newClient = Ctx.CreateClient(); - var session2 = await newClient.ResumeSessionAsync(session.SessionId, + var session2 = await Ctx.ResumeSessionAsync(newClient, session.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = true }); var events = new List(); @@ -106,6 +110,9 @@ public async Task Should_Produce_Deltas_After_Session_Resume() } [Fact] + // TODO(BYOK): Anthropic Messages emitted delta events after resuming with Streaming=false. + // Investigate the native-client streaming contract before keeping this disabled for every BYOK backend. + [Trait(E2ETestTraits.Backend, E2ETestTraits.CapiOnly)] public async Task Should_Not_Produce_Deltas_After_Session_Resume_With_Streaming_Disabled() { var session = await CreateSessionAsync(new SessionConfig { Streaming = true }); @@ -114,7 +121,7 @@ public async Task Should_Not_Produce_Deltas_After_Session_Resume_With_Streaming_ // Resume using a new client with streaming DISABLED using var newClient = Ctx.CreateClient(); - var session2 = await newClient.ResumeSessionAsync(session.SessionId, + var session2 = await Ctx.ResumeSessionAsync(newClient, session.SessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = false }); var events = new List(); @@ -143,8 +150,12 @@ public async Task Should_Emit_Streaming_Deltas_With_Reasoning_Effort_Configured( { // Verifies that setting ReasoningEffort alongside Streaming=true does not break // the streaming pipeline — deltas still arrive and complete successfully. - var session = await CreateSessionAsync(new SessionConfig + await using var isolatedCtx = await E2ETestContext.CreateAsync(); + await isolatedCtx.ConfigureForTestAsync("streaming_fidelity", nameof(Should_Emit_Streaming_Deltas_With_Reasoning_Effort_Configured)); + var isolatedClient = isolatedCtx.CreateClient(); + await using var session = await isolatedCtx.CreateSessionAsync(isolatedClient, new SessionConfig { + Model = "gpt-5.4", Streaming = true, ReasoningEffort = "high", }); @@ -170,8 +181,6 @@ public async Task Should_Emit_Streaming_Deltas_With_Reasoning_Effort_Configured( var messages = await session.GetEventsAsync(); var startEvent = Assert.Single(messages.OfType()); Assert.Equal("high", startEvent.Data.ReasoningEffort); - - await session.DisposeAsync(); } [Fact] diff --git a/dotnet/test/E2E/SubagentHooksE2ETests.cs b/dotnet/test/E2E/SubagentHooksE2ETests.cs index 5c8543215..8314b8c09 100644 --- a/dotnet/test/E2E/SubagentHooksE2ETests.cs +++ b/dotnet/test/E2E/SubagentHooksE2ETests.cs @@ -3,12 +3,15 @@ *--------------------------------------------------------------------------------------------*/ using System.Collections.Concurrent; +using System.Net.Http; using GitHub.Copilot.Test.Harness; using Xunit; using Xunit.Abstractions; namespace GitHub.Copilot.Test.E2E; +#pragma warning disable GHCP001 // The LLM inference surface is intentionally experimental. + public class SubagentHooksE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "subagent_hooks", output) { @@ -16,13 +19,18 @@ public class SubagentHooksE2ETests(E2ETestFixture fixture, ITestOutputHelper out public async Task Should_Invoke_PreToolUse_And_PostToolUse_Hooks_For_Sub_Agent_Tool_Calls() { var hookLog = new ConcurrentBag<(string Kind, string ToolName, string SessionId)>(); + var requestHandler = new RecordingForwardingRequestHandler(); // Create a client with the session-based subagents feature flag var env = new Dictionary(Ctx.GetEnvironment()); env["COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS"] = "true"; - var client = Ctx.CreateClient(options: new CopilotClientOptions { Environment = env }); + var client = Ctx.CreateClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForStdio(), + RequestHandler = requestHandler + }, environment: env); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Hooks = new SessionHooks @@ -44,7 +52,7 @@ public async Task Should_Invoke_PreToolUse_And_PostToolUse_Hooks_For_Sub_Agent_T }); // Create a file for the sub-agent to read - await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, "subagent-test.txt"), "Hello from subagent test!"); + await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, "subagent-test.txt"), "Hello from subagent test!"); await session.SendAndWaitAsync( new MessageOptions @@ -69,5 +77,42 @@ await session.SendAndWaitAsync( // input.SessionId distinguishes parent from sub-agent Assert.NotEqual(viewPre[0].SessionId, taskPre[0].SessionId); + AssertSubagentRequestMetadata(requestHandler.InferenceRequests); + } + + private static void AssertSubagentRequestMetadata(IReadOnlyCollection records) + { + Assert.NotEmpty(records); + var subagentRequest = records.FirstOrDefault(r => !string.IsNullOrEmpty(r.ParentAgentId)); + Assert.NotNull(subagentRequest); + Assert.False(string.IsNullOrEmpty(subagentRequest.AgentId), + "Sub-agent inference request should carry an agent id"); + Assert.False(string.IsNullOrEmpty(subagentRequest.InteractionType), + "Sub-agent inference request should carry an interaction type"); + Assert.NotEqual(subagentRequest.ParentAgentId, subagentRequest.AgentId); + } + + private sealed class RecordingForwardingRequestHandler : CopilotRequestHandler + { + private readonly ConcurrentBag _records = []; + + public IReadOnlyCollection InferenceRequests => + [.. _records.Where(r => RecordingRequestHandler.IsInferenceUrl(r.Url))]; + + protected override Task SendRequestAsync(HttpRequestMessage request, CopilotRequestContext ctx) + { + _records.Add(new RequestRecord( + request.RequestUri!.ToString(), + ctx.AgentId, + ctx.ParentAgentId, + ctx.InteractionType)); + return base.SendRequestAsync(request, ctx); + } } + + private sealed record RequestRecord( + string Url, + string? AgentId, + string? ParentAgentId, + string? InteractionType); } diff --git a/dotnet/test/E2E/SuspendE2ETests.cs b/dotnet/test/E2E/SuspendE2ETests.cs index f531f0e59..b88a9897b 100644 --- a/dotnet/test/E2E/SuspendE2ETests.cs +++ b/dotnet/test/E2E/SuspendE2ETests.cs @@ -58,7 +58,7 @@ public async Task Should_Allow_Resume_And_Continue_Conversation_After_Suspend() string sessionId; await using (var client1 = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: sharedToken) })) { - var session1 = await client1.CreateSessionAsync(new SessionConfig + var session1 = await Ctx.CreateSessionAsync(client1, new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); @@ -78,7 +78,7 @@ await session1.SendAndWaitAsync(new MessageOptions // A different client should be able to pick the session back up. The previous // turn was completed before suspend, so there is no pending work to continue. await using var client2 = Ctx.CreateClient(options: new CopilotClientOptions { Connection = RuntimeConnection.ForUri(cliUrl, connectionToken: sharedToken) }); - var session2 = await client2.ResumeSessionAsync(sessionId, new ResumeSessionConfig + var session2 = await Ctx.ResumeSessionAsync(client2, sessionId, new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, }); diff --git a/dotnet/test/E2E/SystemMessageSectionsE2ETests.cs b/dotnet/test/E2E/SystemMessageSectionsE2ETests.cs new file mode 100644 index 000000000..41c46d3b9 --- /dev/null +++ b/dotnet/test/E2E/SystemMessageSectionsE2ETests.cs @@ -0,0 +1,73 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Rpc; +using GitHub.Copilot.Test.Harness; +using Xunit; +using Xunit.Abstractions; + +namespace GitHub.Copilot.Test.E2E; + +public class SystemMessageSectionsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, "system_message_sections", output) +{ + [Fact] + public async Task Should_Use_Replaced_Identity_Section_In_Response() + { + var session = await CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + SystemMessage = new SystemMessageConfig + { + Mode = SystemMessageMode.Customize, + Sections = new Dictionary + { + [SystemMessageSection.Identity] = new SectionOverride + { + Action = SectionOverrideAction.Replace, + Content = "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening." + } + } + } + }); + + await session.SendAsync(new MessageOptions { Prompt = "Who are you?" }); + var response = await TestHelper.GetFinalAssistantMessageAsync(session); + + Assert.NotNull(response); + var content = response.Data.Content.ToLowerInvariant(); + Assert.True( + content.Contains("botanica") || content.Contains("garden") || content.Contains("plant"), + $"Expected response to reflect the replaced identity section, but got: {response.Data.Content}"); + } + + [Fact] + public async Task Should_Use_Replaced_Preamble_Section_In_Response() + { + var session = await CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + SystemMessage = new SystemMessageConfig + { + Mode = SystemMessageMode.Customize, + Sections = new Dictionary + { + [SystemMessageSection.Preamble] = new SectionOverride + { + Action = SectionOverrideAction.Replace, + Content = "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening." + } + } + } + }); + + await session.SendAsync(new MessageOptions { Prompt = "Who are you?" }); + var response = await TestHelper.GetFinalAssistantMessageAsync(session); + + Assert.NotNull(response); + var content = response.Data.Content.ToLowerInvariant(); + Assert.True( + content.Contains("botanica") || content.Contains("garden") || content.Contains("plant"), + $"Expected response to reflect the replaced preamble section, but got: {response.Data.Content}"); + } +} diff --git a/dotnet/test/E2E/TelemetryExportE2ETests.cs b/dotnet/test/E2E/TelemetryExportE2ETests.cs index ceec2326e..48e3b53ad 100644 --- a/dotnet/test/E2E/TelemetryExportE2ETests.cs +++ b/dotnet/test/E2E/TelemetryExportE2ETests.cs @@ -24,6 +24,7 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() await using var client = Ctx.CreateClient(options: new CopilotClientOptions { + Connection = RuntimeConnection.ForStdio(), Telemetry = new TelemetryConfig { FilePath = telemetryPath, @@ -33,7 +34,7 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() }, }); - var session = await client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(client, new SessionConfig { Tools = [AIFunctionFactory.Create(EchoTelemetryMarker, toolName, "Echoes a marker string for telemetry validation.")], OnPermissionRequest = PermissionHandler.ApproveAll, @@ -47,10 +48,7 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() await session.DisposeAsync(); await client.StopAsync(); - var entries = await ReadTelemetryEntriesAsync( - telemetryPath, - entries => entries.Any(entry => GetTypeName(entry) == "span" && - GetStringAttribute(entry, "gen_ai.operation.name") == "invoke_agent")); + var entries = await ReadTelemetryEntriesAsync(telemetryPath); var spans = entries.Where(entry => GetTypeName(entry) == "span").ToList(); Assert.NotEmpty(spans); @@ -89,46 +87,23 @@ public async Task Should_Export_File_Telemetry_For_Sdk_Interactions() static string EchoTelemetryMarker(string value) => value; } - private static async Task> ReadTelemetryEntriesAsync( - string path, - Func, bool> isComplete) + private static async Task> ReadTelemetryEntriesAsync(string path) { - IReadOnlyList entries = []; - await TestHelper.WaitForConditionAsync( - async () => - { - entries = await ReadTelemetryEntriesOnceAsync(path); - return entries.Count > 0 && isComplete(entries); - }, - timeout: TimeSpan.FromSeconds(30), - timeoutMessage: $"Timed out waiting for telemetry records in '{path}'.", - transientExceptionFilter: exception => TestHelper.IsTransientFileSystemException(exception) || exception is JsonException); - - return entries; - - static async Task> ReadTelemetryEntriesOnceAsync(string path) + var entries = new List(); + using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read); + using var reader = new StreamReader(stream); + while (await reader.ReadLineAsync() is { } line) { - if (!File.Exists(path) || new FileInfo(path).Length == 0) + if (string.IsNullOrWhiteSpace(line)) { - return []; + continue; } - var entries = new List(); - using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete); - using var reader = new StreamReader(stream); - while (await reader.ReadLineAsync() is { } line) - { - if (string.IsNullOrWhiteSpace(line)) - { - continue; - } - - using var document = JsonDocument.Parse(line); - entries.Add(document.RootElement.Clone()); - } - - return entries; + using var document = JsonDocument.Parse(line); + entries.Add(document.RootElement.Clone()); } + + return entries; } private static string? GetTraceId(JsonElement entry) => GetStringProperty(entry, "traceId"); diff --git a/dotnet/test/E2E/ToolsE2ETests.cs b/dotnet/test/E2E/ToolsE2ETests.cs index 57ed6be2d..ea615fbc4 100644 --- a/dotnet/test/E2E/ToolsE2ETests.cs +++ b/dotnet/test/E2E/ToolsE2ETests.cs @@ -61,6 +61,59 @@ static string EncryptString([Description("String to encrypt")] string input) => input.ToUpperInvariant(); } + [Fact] + public async Task Low_Level_Tool_Definition() + { + string currentPhase = string.Empty; + + var session = await CreateSessionAsync(new SessionConfig + { + Tools = + [ + AIFunctionFactory.Create(SetCurrentPhase, new AIFunctionFactoryOptions + { + Name = "set_current_phase", + Description = "Sets the current phase of the agent", + }), + AIFunctionFactory.Create(SearchItems, new AIFunctionFactoryOptions + { + Name = "search_items", + Description = "Search for items by keyword", + }), + ], + AvailableTools = new ToolSet().AddCustom("*").AddBuiltIn("web_fetch"), + OnPermissionRequest = PermissionHandler.ApproveAll, + }); + + await session.SendAsync(new MessageOptions + { + Prompt = "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results." + }); + + var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session); + + Assert.NotNull(assistantMessage); + var content = assistantMessage!.Data.Content ?? string.Empty; + Assert.NotEmpty(content); + Assert.Contains("analyzing", content, StringComparison.OrdinalIgnoreCase); + Assert.True(content.Contains("item_alpha", StringComparison.OrdinalIgnoreCase) + || content.Contains("item_beta", StringComparison.OrdinalIgnoreCase), + $"Expected content to mention item_alpha or item_beta, got: {content}"); + Assert.Equal("analyzing", currentPhase); + + Task SetCurrentPhase(string phase) + { + currentPhase = phase; + return Task.FromResult($"Phase set to {phase}"); + } + + Task SearchItems(AIFunctionArguments args) + { + Assert.Equal("copilot", args["keyword"]?.ToString()); + return Task.FromResult("Found: item_alpha, item_beta"); + } + } + [Fact] public async Task Handles_Tool_Calling_Errors() { @@ -253,7 +306,7 @@ public async Task Invokes_Custom_Tool_With_Permission_Handler() { var permissionRequests = new List(); - var session = await Client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(Client, new SessionConfig { Tools = [AIFunctionFactory.Create(EncryptStringForPermission, "encrypt_string")], OnPermissionRequest = (request, invocation) => @@ -287,7 +340,7 @@ public async Task Denies_Custom_Tool_When_Permission_Denied() { var toolHandlerCalled = false; - var session = await Client.CreateSessionAsync(new SessionConfig + var session = await Ctx.CreateSessionAsync(Client, new SessionConfig { Tools = [AIFunctionFactory.Create(EncryptStringDenied, "encrypt_string")], OnPermissionRequest = async (request, invocation) => PermissionDecision.Reject(), diff --git a/dotnet/test/Harness/CapiProxy.cs b/dotnet/test/Harness/CapiProxy.cs deleted file mode 100644 index 905aa192b..000000000 --- a/dotnet/test/Harness/CapiProxy.cs +++ /dev/null @@ -1,275 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -using System.Diagnostics; -using System.Net.Http; -using System.Net.Http.Json; -using System.Runtime.InteropServices; -using System.Text; -using System.Text.Json; -using System.Text.Json.Serialization; -using System.Text.RegularExpressions; - -namespace GitHub.Copilot.Test.Harness; - -public sealed partial class CapiProxy : IAsyncDisposable -{ - private Process? _process; - private Task? _startupTask; - - public string? ConnectProxyUrl { get; private set; } - public string? CaFilePath { get; private set; } - - public Task StartAsync() - { - return _startupTask ??= StartCoreAsync(); - - async Task StartCoreAsync() - { - string filename; - string args; - - if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) - { - filename = "cmd.exe"; - args = "/c npm.cmd run start"; - - } - else - { - filename = "npm"; - args = "run start"; - } - - var startInfo = new ProcessStartInfo - { - FileName = filename, - WorkingDirectory = Path.Join(FindRepoRoot(), "test", "harness"), - Arguments = args, - UseShellExecute = false, - RedirectStandardOutput = true, - RedirectStandardError = true, - CreateNoWindow = true, - }; - - _process = new Process { StartInfo = startInfo }; - - var tcs = new TaskCompletionSource(); - var errorOutput = new StringBuilder(); - - _process.OutputDataReceived += (_, e) => - { - if (e.Data == null) return; - var match = Regex.Match(e.Data, @"Listening: (?http://[^\s]+)\s+(?\{.*\})$"); - if (!match.Success) - { - if (e.Data.Contains("Listening: ", StringComparison.Ordinal)) - { - tcs.TrySetException( - new InvalidOperationException( - $"Proxy startup line missing CONNECT proxy metadata: {e.Data}")); - } - return; - } - try - { - var metadata = JsonSerializer.Deserialize( - match.Groups["metadata"].Value, - CapiProxyJsonContext.Default.ProxyStartupMetadata); - ConnectProxyUrl = metadata?.ConnectProxyUrl; - CaFilePath = metadata?.CaFilePath; - } - catch (Exception ex) when (ex is JsonException or NotSupportedException) - { - tcs.TrySetException( - new InvalidOperationException( - $"Failed to parse proxy startup metadata: {match.Groups["metadata"].Value}", - ex)); - return; - } - if (string.IsNullOrEmpty(ConnectProxyUrl) || string.IsNullOrEmpty(CaFilePath)) - { - tcs.TrySetException( - new InvalidOperationException( - $"Proxy startup metadata missing CONNECT proxy details: {e.Data}")); - return; - } - tcs.TrySetResult(match.Groups["url"].Value); - }; - - _process.ErrorDataReceived += (_, e) => - { - if (e.Data == null) return; - errorOutput.AppendLine(e.Data); - Console.Error.WriteLine(e.Data); - }; - - _process.Start(); - _process.BeginOutputReadLine(); - _process.BeginErrorReadLine(); - _ = _process.WaitForExitAsync().ContinueWith(_ => - { - if (_process?.ExitCode is int exitCode && exitCode != 0) - { - tcs.TrySetException(new Exception($"Proxy exited with code {_process.ExitCode}: {errorOutput}")); - } - }); - - // Use longer timeout on Windows due to slower process startup - var timeoutSeconds = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? 30 : 10; - using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(timeoutSeconds)); - cts.Token.Register(() => tcs.TrySetException(new TimeoutException("Timeout waiting for proxy"))); - - return await tcs.Task; - } - } - - public async Task StopAsync(bool skipWritingCache = false) - { - if (_startupTask != null) - { - try - { - var url = await _startupTask; - var stopUrl = skipWritingCache ? $"{url}/stop?skipWritingCache=true" : $"{url}/stop"; - using var client = new HttpClient(); - await client.PostAsync(stopUrl, null); - } - catch { /* Best effort */ } - } - - if (_process is { HasExited: false }) - { - try { _process.Kill(entireProcessTree: true); await _process.WaitForExitAsync(); } - catch { /* Ignore */ } - } - - _process?.Dispose(); - _process = null; - _startupTask = null; - } - - public async Task ConfigureAsync(string filePath, string workDir) - { - var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); - - using var client = new HttpClient(); - var response = await client.PostAsJsonAsync($"{url}/config", new ConfigureRequest(filePath, workDir), CapiProxyJsonContext.Default.ConfigureRequest); - response.EnsureSuccessStatusCode(); - } - - private record ConfigureRequest(string FilePath, string WorkDir); - - private record ProxyStartupMetadata(string? ConnectProxyUrl, string? CaFilePath); - - public async Task> GetExchangesAsync() - { - var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); - - using var client = new HttpClient(); - return await client.GetFromJsonAsync($"{url}/exchanges", CapiProxyJsonContext.Default.ListParsedHttpExchange) - ?? []; - } - - public async Task SetCopilotUserByTokenAsync(string token, CopilotUserConfig response) - { - var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); - - using var client = new HttpClient(); - var payload = new CopilotUserByTokenRequest(token, response); - var resp = await client.PostAsJsonAsync($"{url}/copilot-user-config", payload, CapiProxyJsonContext.Default.CopilotUserByTokenRequest); - resp.EnsureSuccessStatusCode(); - } - - public async ValueTask DisposeAsync() - { - await StopAsync(); - } - - private static string FindRepoRoot() - { - var dir = new DirectoryInfo(AppContext.BaseDirectory); - while (dir != null) - { - if (File.Exists(Path.Combine(dir.FullName, "justfile"))) - return dir.FullName; - dir = dir.Parent; - } - throw new InvalidOperationException("Could not find repository root"); - } - - [JsonSourceGenerationOptions(JsonSerializerDefaults.Web)] - [JsonSerializable(typeof(ConfigureRequest))] - [JsonSerializable(typeof(List))] - [JsonSerializable(typeof(CopilotUserByTokenRequest))] - [JsonSerializable(typeof(Dictionary))] - [JsonSerializable(typeof(ProxyStartupMetadata))] - private partial class CapiProxyJsonContext : JsonSerializerContext; -} - -public record CopilotUserByTokenRequest(string Token, CopilotUserConfig Response); - -public record CopilotUserConfig( - string Login, - [property: JsonPropertyName("copilot_plan")] - string CopilotPlan, - CopilotUserEndpoints Endpoints, - [property: JsonPropertyName("analytics_tracking_id")] - string AnalyticsTrackingId, - [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [property: JsonPropertyName("quota_snapshots")] - IReadOnlyDictionary? QuotaSnapshots = null); - -public record CopilotUserEndpoints(string Api, string Telemetry); - -public record CopilotUserQuotaSnapshot( - [property: JsonPropertyName("entitlement")] - int Entitlement, - [property: JsonPropertyName("overage_count")] - int OverageCount, - [property: JsonPropertyName("overage_permitted")] - bool OveragePermitted, - [property: JsonPropertyName("percent_remaining")] - double PercentRemaining, - [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [property: JsonPropertyName("timestamp_utc")] - string? TimestampUtc = null, - [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - [property: JsonPropertyName("unlimited")] - bool? Unlimited = null); - -public record ParsedHttpExchange( - ChatCompletionRequest Request, - ChatCompletionResponse? Response, - Dictionary? RequestHeaders); - -public record ChatCompletionRequest( - string Model, - List Messages, - List? Tools); - -public record ChatCompletionMessage( - string Role, - JsonElement? Content, - [property: JsonPropertyName("tool_call_id")] string? ToolCallId, - [property: JsonPropertyName("tool_calls")] List? ToolCalls) -{ - /// - /// Returns Content as a string when the JSON value is a string, or null otherwise. - /// - [JsonIgnore] - public string? StringContent => Content is { ValueKind: JsonValueKind.String } c ? c.GetString() : null; -} - -public record ChatCompletionToolCall(string Id, string Type, ChatCompletionToolCallFunction Function); - -public record ChatCompletionToolCallFunction(string Name, string? Arguments); - -public record ChatCompletionTool(string Type, ChatCompletionToolFunction Function); - -public record ChatCompletionToolFunction(string Name, string? Description); - -public record ChatCompletionResponse(string Id, string Model, List Choices); - -public record ChatCompletionChoice(int Index, ChatCompletionMessage Message, [property: JsonPropertyName("finish_reason")] string FinishReason); diff --git a/dotnet/test/Harness/E2ETestBackend.cs b/dotnet/test/Harness/E2ETestBackend.cs new file mode 100644 index 000000000..04808ed7a --- /dev/null +++ b/dotnet/test/Harness/E2ETestBackend.cs @@ -0,0 +1,122 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +namespace GitHub.Copilot.Test.Harness; + +internal enum E2ETestBackend +{ + Capi, + AnthropicMessages, + OpenAIResponses, + OpenAICompletions, +} + +internal static class E2ETestBackendConfiguration +{ + internal const string EnvironmentVariable = "COPILOT_SDK_E2E_BACKEND"; + private const string AnthropicDefaultModel = "claude-sonnet-4.5"; + private const string OpenAIDefaultModel = "gpt-4.1"; + private const string FakeCredential = "fake-byok-credential-for-e2e-tests"; + + internal static E2ETestBackend Current + => Parse(Environment.GetEnvironmentVariable(EnvironmentVariable)); + + internal static E2ETestBackend Parse(string? value) + => value?.Trim().ToLowerInvariant() switch + { + null or "" or "capi" => E2ETestBackend.Capi, + "anthropic-messages" => E2ETestBackend.AnthropicMessages, + "openai-responses" => E2ETestBackend.OpenAIResponses, + "openai-completions" => E2ETestBackend.OpenAICompletions, + _ => throw new ArgumentOutOfRangeException( + nameof(value), + value, + $"Unsupported {EnvironmentVariable} value. Expected capi, anthropic-messages, openai-responses, or openai-completions."), + }; + + internal static string ToWireName(this E2ETestBackend backend) + => backend switch + { + E2ETestBackend.Capi => "capi", + E2ETestBackend.AnthropicMessages => "anthropic-messages", + E2ETestBackend.OpenAIResponses => "openai-responses", + E2ETestBackend.OpenAICompletions => "openai-completions", + _ => throw new ArgumentOutOfRangeException(nameof(backend), backend, null), + }; + + internal static void ApplyProvider( + this E2ETestBackend backend, + SessionConfig config, + string proxyUrl) + { + if (backend == E2ETestBackend.Capi + || config.Provider is not null + || config.Providers is not null) + { + return; + } + + var model = config.Model ??= backend.GetDefaultModel(); + config.Provider = CreateProvider(backend, proxyUrl, model); + } + + internal static void ApplyProvider( + this E2ETestBackend backend, + ResumeSessionConfig config, + string proxyUrl) + { + if (backend == E2ETestBackend.Capi || config.Provider is not null) + { + return; + } + + var model = config.Model ??= backend.GetDefaultModel(); + config.Provider = CreateProvider(backend, proxyUrl, model); + } + + private static string GetDefaultModel(this E2ETestBackend backend) + => backend switch + { + E2ETestBackend.AnthropicMessages => AnthropicDefaultModel, + E2ETestBackend.OpenAIResponses or E2ETestBackend.OpenAICompletions => OpenAIDefaultModel, + _ => throw new ArgumentOutOfRangeException(nameof(backend), backend, null), + }; + + private static ProviderConfig CreateProvider( + E2ETestBackend backend, + string proxyUrl, + string model) + => new() + { + BaseUrl = proxyUrl, + Type = backend switch + { + E2ETestBackend.AnthropicMessages => "anthropic", + E2ETestBackend.OpenAIResponses or E2ETestBackend.OpenAICompletions => "openai", + _ => throw new ArgumentOutOfRangeException(nameof(backend), backend, null), + }, + WireApi = backend switch + { + E2ETestBackend.AnthropicMessages => null, + E2ETestBackend.OpenAIResponses => "responses", + E2ETestBackend.OpenAICompletions => "completions", + _ => throw new ArgumentOutOfRangeException(nameof(backend), backend, null), + }, + BearerToken = FakeCredential, + ModelId = model, + WireModel = model, + }; +} + +internal static class E2ETestTraits +{ + // Trait key used by workflow filters to classify backend compatibility. + internal const string Backend = "E2EBackend"; + + // Requires the default CAPI backend and is excluded from BYOK legs. + internal const string CapiOnly = "CapiOnly"; + + // Owns its backend setup and must not inherit the backend selected by the test matrix. + internal const string SelfConfiguredBackend = "SelfConfiguredBackend"; +} diff --git a/dotnet/test/Harness/E2ETestBase.cs b/dotnet/test/Harness/E2ETestBase.cs index ddd1b894b..3eb0f0e97 100644 --- a/dotnet/test/Harness/E2ETestBase.cs +++ b/dotnet/test/Harness/E2ETestBase.cs @@ -59,6 +59,7 @@ internal static string GetTestName(ITestOutputHelper output) public async Task InitializeAsync() { + Ctx.PrepareForTest(); await Ctx.CleanupAfterTestAsync(); await Ctx.ConfigureForTestAsync(_snapshotCategory, _testName); } @@ -76,7 +77,7 @@ protected Task CreateSessionAsync(SessionConfig? config = null) { config ??= new SessionConfig(); config.OnPermissionRequest ??= PermissionHandler.ApproveAll; - return Client.CreateSessionAsync(config); + return Ctx.CreateSessionAsync(Client, config); } /// @@ -88,15 +89,38 @@ protected async Task ResumeSessionAsync(string sessionId, Resume config ??= new ResumeSessionConfig(); config.OnPermissionRequest ??= PermissionHandler.ApproveAll; - await Client.StartAsync(); - var port = Client.RuntimePort - ?? throw new InvalidOperationException("The shared E2E client must use TCP transport to support multi-client resume."); - - var client = Ctx.CreateClient(options: new CopilotClientOptions + CopilotClient client; + if (E2ETestContext.UsesInProcessTransport) + { + client = Client; + } + else { - Connection = RuntimeConnection.ForUri($"localhost:{port}", connectionToken: E2ETestFixture.SharedTcpConnectionToken), - }); - return await client.ResumeSessionAsync(sessionId, config); + await Client.StartAsync(); + var port = Client.RuntimePort + ?? throw new InvalidOperationException("The shared E2E client must use TCP transport to support multi-client resume."); + + client = Ctx.CreateClient(options: new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri($"localhost:{port}", connectionToken: E2ETestFixture.SharedTcpConnectionToken), + }); + } + + return await Ctx.ResumeSessionAsync(client, sessionId, config); + } + + protected static async Task SuspendAndUntrackSessionForResumeAsync(CopilotSession session) + { + await session.Rpc.SuspendAsync(); + + // In-process clients host separate runtimes, while session.destroy removes the + // session from the current runtime. Untrack locally to exercise resume without + // either replacing an active wrapper or destroying the session first. + var removeFromClient = typeof(CopilotSession).GetMethod( + "RemoveFromClient", + BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("CopilotSession.RemoveFromClient was not found."); + removeFromClient.Invoke(session, null); } protected static string GetSystemMessage(ParsedHttpExchange exchange) diff --git a/dotnet/test/Harness/E2ETestContext.cs b/dotnet/test/Harness/E2ETestContext.cs index 8c6465f05..1c88d809b 100644 --- a/dotnet/test/Harness/E2ETestContext.cs +++ b/dotnet/test/Harness/E2ETestContext.cs @@ -5,6 +5,7 @@ using Microsoft.Extensions.Logging; using System.Diagnostics; using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; using System.Text.RegularExpressions; namespace GitHub.Copilot.Test.Harness; @@ -12,21 +13,23 @@ namespace GitHub.Copilot.Test.Harness; public sealed class E2ETestContext : IAsyncDisposable { private const string DefaultGitHubToken = "fake-token-for-e2e-tests"; + private static readonly TimeSpan s_gracefulClientStopTimeout = TimeSpan.FromSeconds(30); public string HomeDir { get; } public string WorkDir { get; } public string ProxyUrl { get; } + internal static bool UsesInProcessTransport => IsInProcess(null); /// Optional logger injected by tests; applied to all clients created via . public ILogger? Logger { get; set; } - private readonly CapiProxy _proxy; + private readonly ReplayProxy _proxy; private readonly string _repoRoot; private readonly object _clientsLock = new(); private readonly List _persistentClients = []; private readonly List _transientClients = []; - private E2ETestContext(string homeDir, string workDir, string proxyUrl, CapiProxy proxy, string repoRoot) + private E2ETestContext(string homeDir, string workDir, string proxyUrl, ReplayProxy proxy, string repoRoot) { HomeDir = homeDir; WorkDir = workDir; @@ -50,7 +53,7 @@ public static async Task CreateAsync() homeDir = ResolveSymlinks(homeDir); workDir = ResolveSymlinks(workDir); - var proxy = new CapiProxy(); + var proxy = new ReplayProxy(); var proxyUrl = await proxy.StartAsync(); await proxy.SetCopilotUserByTokenAsync(DefaultGitHubToken, new CopilotUserConfig( Login: "e2e-test-user", @@ -140,11 +143,41 @@ private static string GetCliPath(string repoRoot) var envPath = Environment.GetEnvironmentVariable("COPILOT_CLI_PATH"); if (!string.IsNullOrEmpty(envPath)) return envPath; - var path = Path.Combine(repoRoot, "nodejs/node_modules/@github/copilot/index.js"); - if (!File.Exists(path)) - throw new InvalidOperationException($"CLI not found at {path}. Run 'npm install' in the nodejs directory first."); + // As of CLI 1.0.64-1 the @github/copilot package is a thin loader; the + // runnable index.js ships in the installed platform package. + var githubModules = Path.Join(repoRoot, "nodejs", "node_modules", "@github"); + var packagePrefix = GetCliPackagePrefix(); + var candidates = Directory.Exists(githubModules) + ? Directory.EnumerateDirectories(githubModules, $"{packagePrefix}-*", SearchOption.TopDirectoryOnly) + .Select(directory => Path.Join(directory, "index.js")) + .Where(File.Exists) + .ToArray() + : []; + + return candidates.Length switch + { + 1 => candidates[0], + 0 => throw new InvalidOperationException( + $"CLI package matching '{packagePrefix}-*' not found under {githubModules}. " + + "Run 'npm install' in the nodejs directory first."), + _ => throw new InvalidOperationException( + $"Multiple CLI packages matching '{packagePrefix}-*' found under {githubModules}: " + + string.Join(", ", candidates.Select(Path.GetDirectoryName))), + }; + } - return path; + private static string GetCliPackagePrefix() + { + var platform = OperatingSystem.IsWindows() + ? "win32" + : OperatingSystem.IsMacOS() + ? "darwin" + : OperatingSystem.IsLinux() + ? RuntimeInformation.RuntimeIdentifier.StartsWith("linux-musl-", StringComparison.Ordinal) + ? "linuxmusl" + : "linux" + : throw new PlatformNotSupportedException("Unsupported operating system for Copilot CLI E2E tests."); + return $"copilot-{platform}"; } public async Task ConfigureForTestAsync(string testFile, [CallerMemberName] string? testName = null) @@ -153,7 +186,10 @@ public async Task ConfigureForTestAsync(string testFile, [CallerMemberName] stri // to avoid case collisions on case-insensitive filesystems (macOS/Windows) var sanitizedName = Regex.Replace(testName!, @"[^a-zA-Z0-9]", "_").ToLowerInvariant(); var snapshotPath = Path.Combine(_repoRoot, "test", "snapshots", testFile, $"{sanitizedName}.yaml"); - await _proxy.ConfigureAsync(snapshotPath, WorkDir); + await _proxy.ConfigureAsync( + snapshotPath, + WorkDir, + E2ETestBackendConfiguration.Current.ToWireName()); } public Task> GetExchangesAsync() @@ -173,10 +209,17 @@ public Dictionary GetEnvironment() .ToDictionary(e => (string)e.Key, e => e.Value?.ToString()); env["COPILOT_API_URL"] = ProxyUrl; + // Route GitHub API calls (e.g. the MCP registry policy check) to the + // replay proxy so MCP enablement stays hermetic. Without this the CLI + // reaches the real api.github.com, which is slow/unreachable on macOS + // CI runners and makes MCP servers time out before reaching connected. + env["COPILOT_DEBUG_GITHUB_API_URL"] = ProxyUrl; env["COPILOT_HOME"] = HomeDir; env["GH_CONFIG_DIR"] = HomeDir; env["XDG_CONFIG_HOME"] = HomeDir; env["XDG_STATE_HOME"] = HomeDir; + env["COPILOT_MCP_APPS"] = "true"; + env["MCP_APPS"] = "true"; if (!string.IsNullOrEmpty(_proxy.ConnectProxyUrl) && !string.IsNullOrEmpty(_proxy.CaFilePath)) { const string noProxy = "127.0.0.1,localhost,::1"; @@ -199,6 +242,16 @@ public Dictionary GetEnvironment() env["GITHUB_TOKEN"] = env["GH_TOKEN"] = DefaultGitHubToken; + // Disable HMAC auth for E2E runs. CI sets COPILOT_HMAC_KEY at the job + // level as an ambient credential, but the replay snapshots are captured + // against Bearer/OAuth (SDK-token) requests. In stdio the SDK token + // outranks HMAC so this is a no-op, but in-process auth resolution runs + // host-side in this process and would otherwise pick HMAC (which ranks + // above the GitHub token) and fail provider.getEndpoint. An empty value + // disables the method (runtime filters out empty HMAC keys). + env["COPILOT_HMAC_KEY"] = ""; + env["CAPI_HMAC_KEY"] = ""; + return env!; } @@ -210,41 +263,83 @@ public Dictionary GetEnvironment() } public CopilotClient CreateClient( - bool? useStdio = null, CopilotClientOptions? options = null, bool autoInjectGitHubToken = true, - bool persistent = false) + bool persistent = false, + IReadOnlyDictionary? environment = null) { options ??= new CopilotClientOptions(); - options.WorkingDirectory ??= WorkDir; - options.Environment ??= GetEnvironment(); options.Logger ??= Logger; - // Build the connection. If the caller supplied one, just ensure the runtime path is set; - // otherwise default to Stdio with the bundled runtime (matches CopilotClient's own default). - // useStdio is a convenience shortcut for the no-Connection case; passing both is ambiguous. - if (useStdio is not null && options.Connection is not null) + // Resolve the working directory the worker should run in. Child-process and + // URI transports take it as a per-client option; the in-process transport + // rejects a per-client WorkingDirectory (the native host spawns the worker + // without a cwd parameter), so — mirroring the Node/Rust harnesses — we point + // THIS process's cwd at the desired directory before the worker spawns and + // clear the per-client option. InProcessEnvIsolationAttribute.After restores + // the cwd after the test. + var desiredWorkingDirectory = options.WorkingDirectory ?? WorkDir; + + // Tests must supply environment via the 'environment' parameter, which the + // harness routes to the right place per transport (the connection for + // child-process transports, the host process for in-process). Setting + // options.Environment directly bypasses that routing and is unsupported + // in-process, so reject it here. + if (options.Environment is not null) { throw new ArgumentException( - "Specify either useStdio or options.Connection, not both. " + - "Use options.Connection (e.g. RuntimeConnection.ForStdio() / RuntimeConnection.ForTcp()) to control transport when supplying a Connection.", - nameof(useStdio)); + "Do not set options.Environment in E2E tests; pass the 'environment' parameter to CreateClient instead.", + nameof(options)); } + // The full environment the client runs with: harness defaults (proxy + // redirect, isolated home, cleared HMAC/tokens, etc.) unless the test + // supplied a complete replacement. + var env = environment is not null + ? environment.ToDictionary(kvp => kvp.Key, kvp => kvp.Value) + : GetEnvironment(); + + // When the test doesn't pin a transport, leave Connection null so + // CopilotClient honors COPILOT_SDK_DEFAULT_CONNECTION (stdio by default, + // or in-process); the CI matrix uses this to run the suite under both. + // Tests that need a specific transport set options.Connection directly. var cliPath = GetCliPath(_repoRoot); switch (options.Connection) { + case null when !IsInProcess(null): + // No explicit connection and not the in-process default: the + // default resolves to stdio, so materialize it here so the + // environment can be attached to the connection below. + options.Connection = RuntimeConnection.ForStdio(path: cliPath); + break; case null: - options.Connection = useStdio == false - ? RuntimeConnection.ForTcp(path: cliPath) - : RuntimeConnection.ForStdio(path: cliPath); + // In-process default: leave Connection unset so CopilotClient's + // ResolveDefaultConnection honors COPILOT_SDK_DEFAULT_CONNECTION. break; case ChildProcessRuntimeConnection child when child.Path is null: child.Path = cliPath; break; } + if (IsInProcess(options.Connection)) + { + options.WorkingDirectory = null; + ApplyInProcessEnvironment(env, desiredWorkingDirectory); + } + else if (options.Connection is ChildProcessRuntimeConnection child) + { + // Child-process transport: hand the environment to the spawned child + // via the connection, where per-client environment is coherent. + child.Environment = env; + options.WorkingDirectory = desiredWorkingDirectory; + } + else + { + // URI / existing-runtime transport: per-client WorkingDirectory applies normally. + options.WorkingDirectory = desiredWorkingDirectory; + } + // Auto-inject auth token unless connecting to an existing runtime via URI. var isExistingRuntime = options.Connection is UriRuntimeConnection; if (autoInjectGitHubToken @@ -269,6 +364,48 @@ public CopilotClient CreateClient( return client; } + public Task CreateSessionAsync( + CopilotClient client, + SessionConfig? config = null) + { + config ??= new SessionConfig(); + E2ETestBackendConfiguration.Current.ApplyProvider(config, ProxyUrl); + return client.CreateSessionAsync(config); + } + + public Task ResumeSessionAsync( + CopilotClient client, + string sessionId, + ResumeSessionConfig? config = null) + { + config ??= new ResumeSessionConfig(); + E2ETestBackendConfiguration.Current.ApplyProvider(config, ProxyUrl); + return client.ResumeSessionAsync(sessionId, config); + } + + internal void PrepareForTest() + { + if (UsesInProcessTransport) + { + ApplyInProcessEnvironment(GetEnvironment(), WorkDir); + } + } + + private static void ApplyInProcessEnvironment(IReadOnlyDictionary environment, string workingDirectory) + { + // Runtime code runs host-side in this process and reads its ambient environment, + // so restore the per-test redirects and isolated home after the assembly-level + // isolation attribute reset them at the end of the preceding test. + foreach (var (name, value) in environment) + { + InProcessEnvIsolation.Apply(name, value); + } + + // The worker inherits the host process cwd because the native host has no + // per-client working-directory parameter. + InProcessEnvIsolation.SetWorkingDirectory(workingDirectory); + } + public void UntrackClient(CopilotClient client) { lock (_clientsLock) @@ -295,7 +432,7 @@ public async Task CleanupAfterTestAsync() { try { - await client.ForceStopAsync(); + await StopClientForCleanupAsync(client); } catch (Exception ex) when (IsTransientCleanupException(ex)) { @@ -329,7 +466,7 @@ public async ValueTask DisposeAsync() { try { - await client.ForceStopAsync(); + await StopClientForCleanupAsync(client); } catch (Exception ex) when (IsTransientCleanupException(ex)) { @@ -391,6 +528,58 @@ private static async Task DeleteDirectoryAsync(string path) } } + /// + /// Determines whether the resolved transport is the in-process (FFI) host, + /// mirroring 's own default-connection resolution: + /// an explicit , or (when no connection + /// is given) the COPILOT_SDK_DEFAULT_CONNECTION=inprocess default. + /// + private static bool IsInProcess(RuntimeConnection? connection) + { + if (connection is InProcessRuntimeConnection) + { + return true; + } + if (connection is null) + { + return string.Equals( + Environment.GetEnvironmentVariable("COPILOT_SDK_DEFAULT_CONNECTION"), + "inprocess", + StringComparison.OrdinalIgnoreCase); + } + return false; + } + + private static async Task StopClientForCleanupAsync(CopilotClient client) + { + var isInProcess = string.Equals( + Environment.GetEnvironmentVariable("COPILOT_SDK_DEFAULT_CONNECTION"), + "inprocess", + StringComparison.OrdinalIgnoreCase); + if (isInProcess) + { + var gracefulStop = client.StopAsync(); + try + { + await gracefulStop.WaitAsync(s_gracefulClientStopTimeout); + } + catch (TimeoutException) + { + Console.Error.WriteLine( + $"Graceful in-process client cleanup exceeded {s_gracefulClientStopTimeout}; forcing shutdown."); + await client.ForceStopAsync(); + + // Disposing the connection completes any session.destroy RPC that + // blocked graceful cleanup. Observe that task before continuing. + await gracefulStop.WaitAsync(s_gracefulClientStopTimeout); + } + } + else + { + await client.ForceStopAsync(); + } + } + private static bool IsTransientCleanupException(Exception exception) => exception is IOException or UnauthorizedAccessException; } diff --git a/dotnet/test/Harness/E2ETestFixture.cs b/dotnet/test/Harness/E2ETestFixture.cs index 95bebc139..e29f5f7f6 100644 --- a/dotnet/test/Harness/E2ETestFixture.cs +++ b/dotnet/test/Harness/E2ETestFixture.cs @@ -19,10 +19,15 @@ public async Task InitializeAsync() Ctx = await E2ETestContext.CreateAsync(); Client = Ctx.CreateClient(options: new CopilotClientOptions { - Connection = RuntimeConnection.ForTcp(connectionToken: SharedTcpConnectionToken), + Connection = CreateSharedConnection(E2ETestContext.UsesInProcessTransport), }, persistent: true); } + internal static RuntimeConnection CreateSharedConnection(bool useInProcessTransport) => + useInProcessTransport + ? RuntimeConnection.ForInProcess() + : RuntimeConnection.ForTcp(connectionToken: SharedTcpConnectionToken); + public async Task DisposeAsync() { await Ctx.DisposeAsync(); diff --git a/dotnet/test/Harness/InProcessEnvIsolation.cs b/dotnet/test/Harness/InProcessEnvIsolation.cs new file mode 100644 index 000000000..af06001ed --- /dev/null +++ b/dotnet/test/Harness/InProcessEnvIsolation.cs @@ -0,0 +1,111 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Collections; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using Xunit.Sdk; + +namespace GitHub.Copilot.Test.Harness; + +// Because many of the tests mutate global environment variables, we have to snapshot the original +// state and restore it after each test. Otherwise tests influence each other depending on run order. +// This is especially important for the in-process transport because the runtime is inside the test +// host process and will be reading/writing its environment variables directly. +internal static class InProcessEnvIsolation +{ + // Unset because CI sets them but the replay snapshots expect Bearer/OAuth. + private static readonly string[] SuppressEnvVars = ["COPILOT_HMAC_KEY", "CAPI_HMAC_KEY"]; + + // Captured at load, before any fixture/test mutates env. + private static readonly Dictionary s_ambient = CaptureEnvironment(); + + // The process working directory captured at load, restored after each test so an + // in-process test that repoints the cwd (the FFI worker inherits it at spawn) + // can't leak that change into the next test. + private static readonly string s_ambientCwd = Directory.GetCurrentDirectory(); + + // Runs at assembly load so the ambient env is snapshotted before the shared + // fixture mirrors per-test env onto the process. Justifies suppressing CA2255. +#pragma warning disable CA2255 // ModuleInitializer discouraged in libraries; intentional in this test harness. + [ModuleInitializer] + internal static void CaptureAtLoad() => _ = s_ambient; +#pragma warning restore CA2255 + + [DllImport("libc", EntryPoint = "setenv", CharSet = CharSet.Ansi, + BestFitMapping = false, ThrowOnUnmappableChar = true)] + private static extern int NativeSetEnv(string name, string value, int overwrite); + + [DllImport("libc", EntryPoint = "unsetenv", CharSet = CharSet.Ansi, + BestFitMapping = false, ThrowOnUnmappableChar = true)] + private static extern int NativeUnsetEnv(string name); + + // Sets/unsets on the managed cache and, on Unix, the libc block so native + // readers in the loaded cdylib observe it. + public static void Apply(string name, string? value) + { + Environment.SetEnvironmentVariable(name, value); + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + _ = value is null ? NativeUnsetEnv(name) : NativeSetEnv(name, value, 1); + } + } + + public static void NeutralizeAmbientCredentials() + { + foreach (var name in SuppressEnvVars) + { + Apply(name, null); + } + } + + // Points the process working directory at the given path so the in-process FFI + // worker inherits it at spawn (the native host has no per-client cwd parameter). + // RestoreAmbient() returns the process to its load-time cwd after the test. + public static void SetWorkingDirectory(string path) => + Directory.SetCurrentDirectory(path); + + public static void RestoreAmbient() + { + // Unconditionally repoint the process cwd at its load-time value. We must + // not read Directory.GetCurrentDirectory() first: an in-process test can + // chdir into a temp work dir that the harness then deletes, so getcwd() + // would throw FileNotFoundException. SetCurrentDirectory to an absolute + // path succeeds regardless of whether the old cwd still exists. + Directory.SetCurrentDirectory(s_ambientCwd); + + foreach (DictionaryEntry entry in Environment.GetEnvironmentVariables()) + { + var name = (string)entry.Key; + if (!s_ambient.ContainsKey(name)) + { + Apply(name, null); + } + } + + foreach (var (name, value) in s_ambient) + { + if (!string.Equals(Environment.GetEnvironmentVariable(name), value, StringComparison.Ordinal)) + { + Apply(name, value); + } + } + } + + private static Dictionary CaptureEnvironment() => + Environment.GetEnvironmentVariables() + .Cast() + .ToDictionary(e => (string)e.Key, e => e.Value?.ToString(), StringComparer.Ordinal); +} + +[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false)] +public sealed class InProcessEnvIsolationAttribute : BeforeAfterTestAttribute +{ + public override void Before(MethodInfo methodUnderTest) => + InProcessEnvIsolation.NeutralizeAmbientCredentials(); + + public override void After(MethodInfo methodUnderTest) => + InProcessEnvIsolation.RestoreAmbient(); +} diff --git a/dotnet/test/Harness/ModuleInitializerAttribute.cs b/dotnet/test/Harness/ModuleInitializerAttribute.cs new file mode 100644 index 000000000..fd9528733 --- /dev/null +++ b/dotnet/test/Harness/ModuleInitializerAttribute.cs @@ -0,0 +1,13 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +#if !NET5_0_OR_GREATER +namespace System.Runtime.CompilerServices; + +// Polyfill so [ModuleInitializer] compiles on net472; recognized by the compiler. +[AttributeUsage(AttributeTargets.Method, Inherited = false)] +internal sealed class ModuleInitializerAttribute : Attribute +{ +} +#endif diff --git a/dotnet/test/Harness/ReplayProxy.cs b/dotnet/test/Harness/ReplayProxy.cs new file mode 100644 index 000000000..895ebccb8 --- /dev/null +++ b/dotnet/test/Harness/ReplayProxy.cs @@ -0,0 +1,278 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Diagnostics; +using System.Net.Http; +using System.Net.Http.Json; +using System.Runtime.InteropServices; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; +using System.Text.RegularExpressions; + +namespace GitHub.Copilot.Test.Harness; + +public sealed partial class ReplayProxy : IAsyncDisposable +{ + private Process? _process; + private Task? _startupTask; + + public string? ConnectProxyUrl { get; private set; } + public string? CaFilePath { get; private set; } + + public Task StartAsync() + { + return _startupTask ??= StartCoreAsync(); + + async Task StartCoreAsync() + { + string filename; + string args; + + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + filename = "cmd.exe"; + args = "/c npm.cmd run start"; + + } + else + { + filename = "npm"; + args = "run start"; + } + + var startInfo = new ProcessStartInfo + { + FileName = filename, + WorkingDirectory = Path.Join(FindRepoRoot(), "test", "harness"), + Arguments = args, + UseShellExecute = false, + RedirectStandardOutput = true, + RedirectStandardError = true, + CreateNoWindow = true, + }; + + _process = new Process { StartInfo = startInfo }; + + var tcs = new TaskCompletionSource(); + var errorOutput = new StringBuilder(); + + _process.OutputDataReceived += (_, e) => + { + if (e.Data == null) return; + var match = Regex.Match(e.Data, @"Listening: (?http://[^\s]+)\s+(?\{.*\})$"); + if (!match.Success) + { + if (e.Data.Contains("Listening: ", StringComparison.Ordinal)) + { + tcs.TrySetException( + new InvalidOperationException( + $"Proxy startup line missing CONNECT proxy metadata: {e.Data}")); + } + return; + } + try + { + var metadata = JsonSerializer.Deserialize( + match.Groups["metadata"].Value, + ReplayProxyJsonContext.Default.ProxyStartupMetadata); + ConnectProxyUrl = metadata?.ConnectProxyUrl; + CaFilePath = metadata?.CaFilePath; + } + catch (Exception ex) when (ex is JsonException or NotSupportedException) + { + tcs.TrySetException( + new InvalidOperationException( + $"Failed to parse proxy startup metadata: {match.Groups["metadata"].Value}", + ex)); + return; + } + if (string.IsNullOrEmpty(ConnectProxyUrl) || string.IsNullOrEmpty(CaFilePath)) + { + tcs.TrySetException( + new InvalidOperationException( + $"Proxy startup metadata missing CONNECT proxy details: {e.Data}")); + return; + } + tcs.TrySetResult(match.Groups["url"].Value); + }; + + _process.ErrorDataReceived += (_, e) => + { + if (e.Data == null) return; + errorOutput.AppendLine(e.Data); + Console.Error.WriteLine(e.Data); + }; + + _process.Start(); + _process.BeginOutputReadLine(); + _process.BeginErrorReadLine(); + _ = _process.WaitForExitAsync().ContinueWith(_ => + { + if (_process?.ExitCode is int exitCode && exitCode != 0) + { + tcs.TrySetException(new Exception($"Proxy exited with code {_process.ExitCode}: {errorOutput}")); + } + }); + + // Use longer timeout on Windows due to slower process startup + var timeoutSeconds = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? 30 : 10; + using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(timeoutSeconds)); + cts.Token.Register(() => tcs.TrySetException(new TimeoutException("Timeout waiting for proxy"))); + + return await tcs.Task; + } + } + + public async Task StopAsync(bool skipWritingCache = false) + { + if (_startupTask != null) + { + try + { + var url = await _startupTask; + var stopUrl = skipWritingCache ? $"{url}/stop?skipWritingCache=true" : $"{url}/stop"; + using var client = new HttpClient(); + await client.PostAsync(stopUrl, null); + } + catch { /* Best effort */ } + } + + if (_process is { HasExited: false }) + { + try { _process.Kill(entireProcessTree: true); await _process.WaitForExitAsync(); } + catch { /* Ignore */ } + } + + _process?.Dispose(); + _process = null; + _startupTask = null; + } + + public async Task ConfigureAsync(string filePath, string workDir, string backend) + { + var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); + + using var client = new HttpClient(); + var response = await client.PostAsJsonAsync( + $"{url}/config", + new ConfigureRequest(filePath, workDir, backend), + ReplayProxyJsonContext.Default.ConfigureRequest); + response.EnsureSuccessStatusCode(); + } + + private record ConfigureRequest(string FilePath, string WorkDir, string Backend); + + private record ProxyStartupMetadata(string? ConnectProxyUrl, string? CaFilePath); + + public async Task> GetExchangesAsync() + { + var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); + + using var client = new HttpClient(); + return await client.GetFromJsonAsync($"{url}/exchanges", ReplayProxyJsonContext.Default.ListParsedHttpExchange) + ?? []; + } + + public async Task SetCopilotUserByTokenAsync(string token, CopilotUserConfig response) + { + var url = await (_startupTask ?? throw new InvalidOperationException("Proxy not started")); + + using var client = new HttpClient(); + var payload = new CopilotUserByTokenRequest(token, response); + var resp = await client.PostAsJsonAsync($"{url}/copilot-user-config", payload, ReplayProxyJsonContext.Default.CopilotUserByTokenRequest); + resp.EnsureSuccessStatusCode(); + } + + public async ValueTask DisposeAsync() + { + await StopAsync(); + } + + private static string FindRepoRoot() + { + var dir = new DirectoryInfo(AppContext.BaseDirectory); + while (dir != null) + { + if (File.Exists(Path.Combine(dir.FullName, "justfile"))) + return dir.FullName; + dir = dir.Parent; + } + throw new InvalidOperationException("Could not find repository root"); + } + + [JsonSourceGenerationOptions(JsonSerializerDefaults.Web)] + [JsonSerializable(typeof(ConfigureRequest))] + [JsonSerializable(typeof(List))] + [JsonSerializable(typeof(CopilotUserByTokenRequest))] + [JsonSerializable(typeof(Dictionary))] + [JsonSerializable(typeof(ProxyStartupMetadata))] + private partial class ReplayProxyJsonContext : JsonSerializerContext; +} + +public record CopilotUserByTokenRequest(string Token, CopilotUserConfig Response); + +public record CopilotUserConfig( + string Login, + [property: JsonPropertyName("copilot_plan")] + string CopilotPlan, + CopilotUserEndpoints Endpoints, + [property: JsonPropertyName("analytics_tracking_id")] + string AnalyticsTrackingId, + [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [property: JsonPropertyName("quota_snapshots")] + IReadOnlyDictionary? QuotaSnapshots = null); + +public record CopilotUserEndpoints(string Api, string Telemetry); + +public record CopilotUserQuotaSnapshot( + [property: JsonPropertyName("entitlement")] + int Entitlement, + [property: JsonPropertyName("overage_count")] + int OverageCount, + [property: JsonPropertyName("overage_permitted")] + bool OveragePermitted, + [property: JsonPropertyName("percent_remaining")] + double PercentRemaining, + [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [property: JsonPropertyName("timestamp_utc")] + string? TimestampUtc = null, + [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + [property: JsonPropertyName("unlimited")] + bool? Unlimited = null); + +public record ParsedHttpExchange( + ChatCompletionRequest Request, + ChatCompletionResponse? Response, + Dictionary? RequestHeaders); + +public record ChatCompletionRequest( + string Model, + List Messages, + List? Tools); + +public record ChatCompletionMessage( + string Role, + JsonElement? Content, + [property: JsonPropertyName("tool_call_id")] string? ToolCallId, + [property: JsonPropertyName("tool_calls")] List? ToolCalls) +{ + /// + /// Returns Content as a string when the JSON value is a string, or null otherwise. + /// + [JsonIgnore] + public string? StringContent => Content is { ValueKind: JsonValueKind.String } c ? c.GetString() : null; +} + +public record ChatCompletionToolCall(string Id, string Type, ChatCompletionToolCallFunction Function); + +public record ChatCompletionToolCallFunction(string Name, string? Arguments); + +public record ChatCompletionTool(string Type, ChatCompletionToolFunction Function); + +public record ChatCompletionToolFunction(string Name, string? Description, JsonElement? Parameters); + +public record ChatCompletionResponse(string Id, string Model, List Choices); + +public record ChatCompletionChoice(int Index, ChatCompletionMessage Message, [property: JsonPropertyName("finish_reason")] string FinishReason); diff --git a/dotnet/test/Unit/CanvasTests.cs b/dotnet/test/Unit/CanvasTests.cs index 18dec1733..4993d88f6 100644 --- a/dotnet/test/Unit/CanvasTests.cs +++ b/dotnet/test/Unit/CanvasTests.cs @@ -150,11 +150,9 @@ public void SessionCanvasOpenedEvent_UpdatesOpenCanvasSnapshots() Timestamp = DateTimeOffset.UtcNow, Data = new SessionCanvasOpenedData { - Availability = CanvasOpenedAvailability.Ready, CanvasId = "", ExtensionId = "project:counter", InstanceId = "missing-canvas-id", - Reopen = false, } }); DispatchEvent(session, new SessionCanvasOpenedEvent @@ -163,16 +161,15 @@ public void SessionCanvasOpenedEvent_UpdatesOpenCanvasSnapshots() Timestamp = DateTimeOffset.UtcNow, Data = new SessionCanvasOpenedData { - Availability = CanvasOpenedAvailability.Ready, CanvasId = "counter", ExtensionId = "project:counter", ExtensionName = "Counter Provider", InstanceId = "counter-1", Title = "Counter", + Icon = "beaker", Status = "ready", Url = "https://example.test/counter", Input = JsonDocument.Parse("""{"seed":1}""").RootElement.Clone(), - Reopen = false, } }); DispatchEvent(session, new SessionCanvasOpenedEvent @@ -181,12 +178,10 @@ public void SessionCanvasOpenedEvent_UpdatesOpenCanvasSnapshots() Timestamp = DateTimeOffset.UtcNow, Data = new SessionCanvasOpenedData { - Availability = CanvasOpenedAvailability.Stale, CanvasId = "logs", ExtensionId = "project:logs", InstanceId = "logs-1", Title = "Logs", - Reopen = false, } }); @@ -201,16 +196,15 @@ public void SessionCanvasOpenedEvent_UpdatesOpenCanvasSnapshots() Timestamp = DateTimeOffset.UtcNow, Data = new SessionCanvasOpenedData { - Availability = CanvasOpenedAvailability.Stale, CanvasId = "counter", ExtensionId = "project:counter", ExtensionName = "Counter Provider", InstanceId = "counter-1", Title = "Counter Updated", + Icon = "beaker-filled", Status = "reconnected", Url = "https://example.test/counter-updated", Input = JsonDocument.Parse("""{"seed":2}""").RootElement.Clone(), - Reopen = true, } }); @@ -220,15 +214,97 @@ public void SessionCanvasOpenedEvent_UpdatesOpenCanvasSnapshots() { Assert.Equal("counter-1", canvas.InstanceId); Assert.Equal("Counter Updated", canvas.Title); + Assert.Equal("beaker-filled", canvas.Icon); Assert.Equal("reconnected", canvas.Status); Assert.Equal("https://example.test/counter-updated", canvas.Url); - Assert.True(canvas.Reopen); - Assert.Equal(CanvasInstanceAvailability.Stale, canvas.Availability); Assert.Equal(2, canvas.Input!.Value.GetProperty("seed").GetInt32()); }, canvas => Assert.Equal("logs-1", canvas.InstanceId)); } + [Fact] + public void SessionCanvasClosedEvent_RemovesOpenCanvasSnapshots() + { + var session = CreateSession(); + + DispatchEvent(session, new SessionCanvasOpenedEvent + { + Id = Guid.NewGuid(), + Timestamp = DateTimeOffset.UtcNow, + Data = new SessionCanvasOpenedData + { + CanvasId = "counter", + ExtensionId = "project:counter", + InstanceId = "counter-1", + Title = "Counter", + } + }); + DispatchEvent(session, new SessionCanvasOpenedEvent + { + Id = Guid.NewGuid(), + Timestamp = DateTimeOffset.UtcNow, + Data = new SessionCanvasOpenedData + { + CanvasId = "logs", + ExtensionId = "project:logs", + InstanceId = "logs-1", + Title = "Logs", + } + }); + + Assert.Collection( + session.OpenCanvases, + canvas => Assert.Equal("counter-1", canvas.InstanceId), + canvas => Assert.Equal("logs-1", canvas.InstanceId)); + + // Closing one instance removes it; the other remains. + DispatchEvent(session, new SessionCanvasClosedEvent + { + Id = Guid.NewGuid(), + Timestamp = DateTimeOffset.UtcNow, + Data = new SessionCanvasClosedData + { + CanvasId = "counter", + ExtensionId = "project:counter", + InstanceId = "counter-1", + } + }); + + Assert.Collection( + session.OpenCanvases, + canvas => Assert.Equal("logs-1", canvas.InstanceId)); + + // Closing an absent instance is a no-op (idempotent). + DispatchEvent(session, new SessionCanvasClosedEvent + { + Id = Guid.NewGuid(), + Timestamp = DateTimeOffset.UtcNow, + Data = new SessionCanvasClosedData + { + CanvasId = "counter", + ExtensionId = "project:counter", + InstanceId = "counter-1", + } + }); + + // A closed event with an empty instance id leaves the snapshot intact. + DispatchEvent(session, new SessionCanvasClosedEvent + { + Id = Guid.NewGuid(), + Timestamp = DateTimeOffset.UtcNow, + Data = new SessionCanvasClosedData + { + CanvasId = "logs", + ExtensionId = "project:logs", + InstanceId = "", + } + }); + + Assert.Collection( + session.OpenCanvases, + canvas => Assert.Equal("logs-1", canvas.InstanceId)); + } + [Fact] public void ExtensionInfo_Serializes_SourceAndName() { @@ -240,6 +316,28 @@ public void ExtensionInfo_Serializes_SourceAndName() Assert.Equal("demo", doc.RootElement.GetProperty("name").GetString()); } + [Fact] + public void CanvasProviderIdentity_Serializes_IdAndName() + { + var options = GetSerializerOptions(); + var identity = new CanvasProviderIdentity { Id = "app:builtin:window-1", Name = "Built-in" }; + var json = JsonSerializer.Serialize(identity, options); + using var doc = JsonDocument.Parse(json); + Assert.Equal("app:builtin:window-1", doc.RootElement.GetProperty("id").GetString()); + Assert.Equal("Built-in", doc.RootElement.GetProperty("name").GetString()); + } + + [Fact] + public void CanvasProviderIdentity_OmitsNullName() + { + var options = GetSerializerOptions(); + var identity = new CanvasProviderIdentity { Id = "app:builtin:window-1" }; + var json = JsonSerializer.Serialize(identity, options); + using var doc = JsonDocument.Parse(json); + Assert.Equal("app:builtin:window-1", doc.RootElement.GetProperty("id").GetString()); + Assert.False(doc.RootElement.TryGetProperty("name", out _)); + } + [Fact] public async Task CanvasHandlerBase_DefaultOnClose_Completes() { @@ -275,6 +373,7 @@ public void SessionConfig_Clone_CopiesCanvasFields() RequestCanvasRenderer = true, RequestExtensions = true, ExtensionInfo = new ExtensionInfo { Source = "github-app", Name = "demo" }, + CanvasProvider = new CanvasProviderIdentity { Id = "app:builtin:window-1", Name = "Built-in" }, CanvasHandler = handler }; @@ -287,6 +386,8 @@ public void SessionConfig_Clone_CopiesCanvasFields() Assert.True(clone.RequestExtensions); Assert.NotNull(clone.ExtensionInfo); Assert.Equal("github-app", clone.ExtensionInfo!.Source); + Assert.NotNull(clone.CanvasProvider); + Assert.Equal("app:builtin:window-1", clone.CanvasProvider!.Id); Assert.Same(handler, clone.CanvasHandler); // Mutating the clone's list does not affect the original. @@ -303,6 +404,7 @@ public void ResumeSessionConfig_Clone_CopiesCanvasFields() Canvases = new[] { new CanvasDeclaration { Id = "c1", DisplayName = "C", Description = "d" } }, RequestCanvasRenderer = true, ExtensionInfo = new ExtensionInfo { Source = "s", Name = "n" }, + CanvasProvider = new CanvasProviderIdentity { Id = "app:builtin:window-2" }, CanvasHandler = handler }; @@ -312,6 +414,8 @@ public void ResumeSessionConfig_Clone_CopiesCanvasFields() Assert.Single(clone.Canvases!); Assert.True(clone.RequestCanvasRenderer); Assert.NotNull(clone.ExtensionInfo); + Assert.NotNull(clone.CanvasProvider); + Assert.Equal("app:builtin:window-2", clone.CanvasProvider!.Id); Assert.Same(handler, clone.CanvasHandler); } diff --git a/dotnet/test/Unit/ClientSessionLifetimeTests.cs b/dotnet/test/Unit/ClientSessionLifetimeTests.cs index c52148a03..a561ee44b 100644 --- a/dotnet/test/Unit/ClientSessionLifetimeTests.cs +++ b/dotnet/test/Unit/ClientSessionLifetimeTests.cs @@ -5,16 +5,85 @@ #if NET8_0_OR_GREATER using System.Net; using System.Net.Sockets; +using System.Diagnostics; using System.Reflection; using System.Runtime.CompilerServices; using System.Text; using System.Text.Json; +using GitHub.Copilot.Rpc; using Xunit; namespace GitHub.Copilot.Test.Unit; public sealed class ClientSessionLifetimeTests { + private sealed record RpcRequestRecord(string Method, JsonElement Params); + + [Fact] + public async Task StopAsync_Requests_Runtime_Shutdown_For_Owned_Process() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + using var process = StartExitedProcess(); + await ReplaceConnectionCliProcessAsync(client, process); + + await client.StopAsync(); + + Assert.Equal(1, server.RuntimeShutdownCount); + } + + [Fact] + public async Task DisposeAsync_Requests_Runtime_Shutdown_For_Owned_Process() + { + await using var server = await FakeCopilotServer.StartAsync(); + var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + using var process = StartExitedProcess(); + await ReplaceConnectionCliProcessAsync(client, process); + + await client.DisposeAsync(); + + Assert.Equal(1, server.RuntimeShutdownCount); + } + + [Fact] + public async Task StopAsync_Does_Not_Throw_When_Runtime_Shutdown_Fails() + { + await using var server = await FakeCopilotServer.StartAsync(); + server.FailRuntimeShutdown(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + using var process = StartExitedProcess(); + await ReplaceConnectionCliProcessAsync(client, process); + + await client.StopAsync(); + + Assert.Equal(1, server.RuntimeShutdownCount); + } + + [Fact] + public async Task ForceStopAsync_And_External_Stop_Do_Not_Request_Runtime_Shutdown() + { + await using var forceServer = await FakeCopilotServer.StartAsync(); + await using var forceClient = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(forceServer.Url) }); + await forceClient.StartAsync(); + using var process = StartExitedProcess(); + await ReplaceConnectionCliProcessAsync(forceClient, process); + + await forceClient.ForceStopAsync(); + + Assert.Equal(0, forceServer.RuntimeShutdownCount); + + await using var externalServer = await FakeCopilotServer.StartAsync(); + await using var externalClient = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(externalServer.Url) }); + await externalClient.StartAsync(); + + await externalClient.StopAsync(); + + Assert.Equal(0, externalServer.RuntimeShutdownCount); + } + [Fact] public async Task Dropped_Session_Remains_Rooted_By_Client() { @@ -114,6 +183,27 @@ public async Task StopAsync_Keeps_Session_Rooted_Until_Destroy_Completes() AssertSessionCount(client, sessions: 0); } + [Fact] + public async Task ForceStopAsync_Unblocks_StopAsync_When_Session_Destroy_Hangs() + { + await using var server = await FakeCopilotServer.StartAsync(); + server.DelayDestroy(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + _ = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var stopTask = client.StopAsync(); + await server.DestroyStarted; + + await client.ForceStopAsync(); + await stopTask.WaitAsync(TimeSpan.FromSeconds(5)); + + AssertSessionCount(client, sessions: 0); + } + [Fact] public async Task ResumeSessionAsync_Throws_When_Same_Client_Already_Tracks_Session() { @@ -136,6 +226,267 @@ public async Task ResumeSessionAsync_Throws_When_Same_Client_Already_Tracks_Sess AssertSessionCount(client, sessions: 1); } + [Fact] + public async Task CreateSessionAsync_Serializes_CustomAgent_ReasoningEffort() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + CustomAgents = + [ + new CustomAgentConfig + { + Name = "reasoning-agent", + Prompt = "Think carefully.", + ReasoningEffort = "high" + } + ], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + var agent = Assert.Single(request.Params.GetProperty("customAgents").EnumerateArray()); + Assert.Equal("high", agent.GetProperty("reasoningEffort").GetString()); + } + + [Fact] + public async Task CreateSessionAsync_Omits_CustomAgent_ReasoningEffort_When_Unset() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + CustomAgents = + [ + new CustomAgentConfig + { + Name = "default-agent", + Prompt = "Use runtime defaults." + } + ], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + var agent = Assert.Single(request.Params.GetProperty("customAgents").EnumerateArray()); + Assert.False(agent.TryGetProperty("reasoningEffort", out _)); + } + + [Fact] + public async Task SessionRequests_Serialize_AdditionalDirectories() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + await using var created = await client.CreateSessionAsync(new SessionConfig + { + AdditionalDirectories = ["/repo/shared", "/repo/generated"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var createRequest = Assert.Single(server.Requests, request => request.Method == "session.create"); + Assert.Collection( + createRequest.Params.GetProperty("additionalDirectories").EnumerateArray(), + value => Assert.Equal("/repo/shared", value.GetString()), + value => Assert.Equal("/repo/generated", value.GetString())); + + server.ClearRequests(); + + await using var resumed = await client.ResumeSessionAsync("resume-with-additional-directories", new ResumeSessionConfig + { + AdditionalDirectories = ["/repo/resumed"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var resumeRequest = Assert.Single(server.Requests, request => request.Method == "session.resume"); + Assert.Collection( + resumeRequest.Params.GetProperty("additionalDirectories").EnumerateArray(), + value => Assert.Equal("/repo/resumed", value.GetString())); + } + + [Fact] + public async Task SessionRequests_Serialize_Terminal_Tools() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + var terminalTool = CopilotTool.DefineTool( + (Func)(() => "done"), + new CopilotToolOptions { IsTerminal = true }); + var plainTool = CopilotTool.DefineTool((Func)(() => "continue")); + + await using var created = await client.CreateSessionAsync(new SessionConfig + { + Tools = [terminalTool, plainTool], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var createRequest = Assert.Single(server.Requests, request => request.Method == "session.create"); + var createTools = createRequest.Params.GetProperty("tools"); + Assert.True(createTools[0].GetProperty("isTerminal").GetBoolean()); + Assert.False(createTools[1].TryGetProperty("isTerminal", out _)); + + server.ClearRequests(); + + await using var resumed = await client.ResumeSessionAsync("resume-with-terminal-tool", new ResumeSessionConfig + { + Tools = [terminalTool], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var resumeRequest = Assert.Single(server.Requests, request => request.Method == "session.resume"); + Assert.True(resumeRequest.Params.GetProperty("tools")[0].GetProperty("isTerminal").GetBoolean()); + } + + [Fact] + public async Task CreateSessionAsync_Registers_McpAuth_Interest_Only_When_Handler_Configured() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + await using var withoutAuth = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnEvent = _ => { } + }); + + Assert.DoesNotContain(server.Requests, request => + request.Method == "session.eventLog.registerInterest" + && request.Params.GetProperty("eventType").GetString() == "mcp.oauth_required"); + Assert.Contains(server.Requests, request => + request.Method == "session.create" + && request.Params.GetProperty("requestPermission").GetBoolean()); + + server.ClearRequests(); + + await using var withAuth = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = _ => Task.FromResult(McpAuthResult.Cancel()) + }); + + Assert.Collection( + server.Requests.Take(2), + request => Assert.Equal("session.create", request.Method), + request => + { + Assert.Equal("session.eventLog.registerInterest", request.Method); + Assert.Equal("mcp.oauth_required", request.Params.GetProperty("eventType").GetString()); + }); + } + + [Fact] + public async Task CreateSessionAsync_Registers_McpAuth_Interest_After_Cloud_Create_When_Handler_Configured() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + var cloud = new CloudSessionOptions + { + Repository = new CloudSessionRepository + { + Owner = "github", + Name = "copilot-sdk", + Branch = "main" + } + }; + + await using var withoutAuth = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + Cloud = cloud + }); + + Assert.DoesNotContain(server.Requests, request => + request.Method == "session.eventLog.registerInterest" + && request.Params.GetProperty("eventType").GetString() == "mcp.oauth_required"); + + server.ClearRequests(); + + await using var withAuth = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = _ => Task.FromResult(McpAuthResult.Cancel()), + Cloud = cloud + }); + + Assert.Collection( + server.Requests.Take(2), + request => Assert.Equal("session.create", request.Method), + request => + { + Assert.Equal("session.eventLog.registerInterest", request.Method); + Assert.Equal("mcp.oauth_required", request.Params.GetProperty("eventType").GetString()); + }); + } + + [Fact] + public async Task ResumeSessionAsync_Registers_McpAuth_Interest_Only_When_Handler_Configured() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + await using var withoutAuth = await client.ResumeSessionAsync("session-without-auth", new ResumeSessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnEvent = _ => { } + }); + + Assert.DoesNotContain(server.Requests, request => + request.Method == "session.eventLog.registerInterest" + && request.Params.GetProperty("eventType").GetString() == "mcp.oauth_required"); + Assert.Contains(server.Requests, request => + request.Method == "session.resume" + && request.Params.GetProperty("requestPermission").GetBoolean()); + + server.ClearRequests(); + + await using var withAuth = await client.ResumeSessionAsync("session-with-auth", new ResumeSessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = _ => Task.FromResult(McpAuthResult.Cancel()) + }); + + Assert.Collection( + server.Requests.Take(2), + request => Assert.Equal("session.resume", request.Method), + request => + { + Assert.Equal("session.eventLog.registerInterest", request.Method); + Assert.Equal("mcp.oauth_required", request.Params.GetProperty("eventType").GetString()); + }); + } + + [Fact] + public async Task McpAuth_Handler_Exception_Cancels_Pending_Request() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll, + OnMcpAuthRequest = _ => throw new ApplicationException("boom") + }); + + DispatchEvent(session, new McpOauthRequiredEvent + { + Data = new McpOauthRequiredData + { + RequestId = "mcp-auth-request-1", + ServerName = "oauth-mcp", + ServerUrl = "http://localhost/mcp", + Reason = McpOauthRequestReason.Initial + } + }); + + var request = await WaitForRequestAsync(server, "session.mcp.oauth.handlePendingRequest"); + Assert.Equal("mcp-auth-request-1", request.Params.GetProperty("requestId").GetString()); + Assert.Equal("cancelled", request.Params.GetProperty("result").GetProperty("kind").GetString()); + } + [Fact] public async Task Generated_Session_Rpc_Throws_When_Session_Disposed() { @@ -186,6 +537,351 @@ private static int GetPrivateDictionaryCount(CopilotClient client, string fieldN return (int)count.GetValue(dictionary)!; } + [Fact] + public async Task CreateSessionAsync_Serializes_ManagedSettings_Permissions() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + var permissionInvocation = new TaskCompletionSource( + TaskCreationOptions.RunContinuationsAsynchronously); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + ManagedSettings = new ManagedSettings + { + Permissions = new ManagedSettingsPermissions + { + DisableBypassPermissionsMode = DisableBypassPermissionsMode.Disable, + Deny = ["shell(rm*)"], + Ask = ["write"], + Allow = [] + } + }, + OnPermissionRequest = (_, invocation) => + { + permissionInvocation.TrySetResult(invocation); + return Task.FromResult(PermissionDecision.NoResult()); + } + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + Assert.False(request.Params.TryGetProperty("enableManagedSettings", out _)); + var permissions = request.Params.GetProperty("managedSettings").GetProperty("permissions"); + Assert.Equal("disable", permissions.GetProperty("disableBypassPermissionsMode").GetString()); + Assert.Equal("shell(rm*)", Assert.Single(permissions.GetProperty("deny").EnumerateArray()).GetString()); + Assert.Equal("write", Assert.Single(permissions.GetProperty("ask").EnumerateArray()).GetString()); + Assert.Empty(permissions.GetProperty("allow").EnumerateArray()); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "managed-permission" + } + }); + var invocation = await permissionInvocation.Task.WaitAsync(TimeSpan.FromSeconds(5)); + Assert.True(invocation.ManagedSettingsEnabled); + } + + [Fact] + public async Task PermissionResponse_Forwards_DecisionContext_As_Sibling_Of_Result() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = (_, _) => Task.FromResult( + new PermissionDecisionApproveOnce + { + DecisionContext = new PermissionDecisionContext + { + Outcome = PermissionDecisionOutcome.AutoApproved, + Source = PermissionDecisionSource.HostPolicy, + Surface = PermissionDecisionSurface.Sdk + } + }) + }); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "req-with-context" + } + }); + + var request = await WaitForRequestAsync(server, "session.permissions.handlePendingPermissionRequest"); + + Assert.True(request.Params.TryGetProperty("decisionContext", out var decisionContext)); + Assert.Equal("auto_approved", decisionContext.GetProperty("outcome").GetString()); + Assert.Equal("host_policy", decisionContext.GetProperty("source").GetString()); + Assert.Equal("sdk", decisionContext.GetProperty("surface").GetString()); + + var result = request.Params.GetProperty("result"); + Assert.Equal("approve-once", result.GetProperty("kind").GetString()); + Assert.False(result.TryGetProperty("decisionContext", out _)); + } + + [Fact] + public async Task PermissionResponse_Omits_DecisionContext_When_Not_Supplied() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = (_, _) => Task.FromResult(PermissionDecision.ApproveOnce()) + }); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "req-no-context" + } + }); + + var request = await WaitForRequestAsync(server, "session.permissions.handlePendingPermissionRequest"); + + Assert.False(request.Params.TryGetProperty("decisionContext", out _)); + var result = request.Params.GetProperty("result"); + Assert.Equal("approve-once", result.GetProperty("kind").GetString()); + Assert.False(result.TryGetProperty("decisionContext", out _)); + } + + [Fact] + public async Task PermissionResponse_Uses_Latest_Context_When_Reassigned() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = (_, _) => + { + var decision = new PermissionDecisionApproveOnce + { + DecisionContext = new PermissionDecisionContext + { + Outcome = PermissionDecisionOutcome.PromptedUser, + Source = PermissionDecisionSource.HumanResponse, + Surface = PermissionDecisionSurface.Tui + } + }; + decision.DecisionContext = new PermissionDecisionContext + { + Outcome = PermissionDecisionOutcome.AutoApproved, + Source = PermissionDecisionSource.HostPolicy, + Surface = PermissionDecisionSurface.Sdk + }; + return Task.FromResult(decision); + } + }); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "req-replace-context" + } + }); + + var request = await WaitForRequestAsync(server, "session.permissions.handlePendingPermissionRequest"); + + var decisionContext = request.Params.GetProperty("decisionContext"); + Assert.Equal("auto_approved", decisionContext.GetProperty("outcome").GetString()); + Assert.Equal("host_policy", decisionContext.GetProperty("source").GetString()); + Assert.Equal("sdk", decisionContext.GetProperty("surface").GetString()); + } + + [Fact] + public async Task PermissionResponse_Is_Suppressed_For_NoResult_Even_With_Context() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + var handlerInvoked = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = (_, _) => + { + handlerInvoked.TrySetResult(); + return Task.FromResult( + new PermissionDecisionNoResult + { + DecisionContext = new PermissionDecisionContext + { + Outcome = PermissionDecisionOutcome.PromptedUser, + Source = PermissionDecisionSource.HumanResponse, + Surface = PermissionDecisionSurface.Sdk + } + }); + } + }); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "req-no-result" + } + }); + + await handlerInvoked.Task.WaitAsync(TimeSpan.FromSeconds(5)); + // Give the send path a chance to (incorrectly) fire before asserting suppression. + await Task.Delay(200); + + Assert.DoesNotContain(server.Requests, request => request.Method == "session.permissions.handlePendingPermissionRequest"); + } + + [Fact] + public async Task PermissionResponse_Never_Nests_DecisionContext_Inside_Result() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = (_, _) => Task.FromResult( + new PermissionDecisionReject + { + Feedback = "denied by policy", + DecisionContext = new PermissionDecisionContext + { + Outcome = PermissionDecisionOutcome.AutopilotDenied, + Source = PermissionDecisionSource.HostPolicy, + Surface = PermissionDecisionSurface.Sdk + } + }) + }); + + DispatchEvent(session, new PermissionRequestedEvent + { + Data = new PermissionRequestedData + { + PermissionRequest = new PermissionRequest { Kind = "read" }, + RequestId = "req-reject-context" + } + }); + + var request = await WaitForRequestAsync(server, "session.permissions.handlePendingPermissionRequest"); + + var result = request.Params.GetProperty("result"); + Assert.Equal("reject", result.GetProperty("kind").GetString()); + Assert.Equal("denied by policy", result.GetProperty("feedback").GetString()); + // The context provenance must never be serialized inside the decision itself. + Assert.False(result.TryGetProperty("decisionContext", out _)); + // It is forwarded as a sibling instead. + Assert.True(request.Params.TryGetProperty("decisionContext", out _)); + } + + [Fact] + public async Task CreateSessionAsync_Omits_ManagedSettings_When_Unset() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + await client.StartAsync(); + + await using var session = await client.CreateSessionAsync(new SessionConfig + { + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.create"); + Assert.False(request.Params.TryGetProperty("managedSettings", out _)); + } + + [Fact] + public async Task ResumeSessionAsync_Serializes_ManagedSettings_Permissions() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + await using var session = await client.ResumeSessionAsync("session-managed", new ResumeSessionConfig + { + ManagedSettings = new ManagedSettings + { + Permissions = new ManagedSettingsPermissions + { + Deny = ["shell(rm*)"] + } + }, + OnPermissionRequest = PermissionHandler.ApproveAll, + OnEvent = _ => { } + }); + + var request = Assert.Single(server.Requests, request => request.Method == "session.resume"); + var permissions = request.Params.GetProperty("managedSettings").GetProperty("permissions"); + Assert.Equal("shell(rm*)", Assert.Single(permissions.GetProperty("deny").EnumerateArray()).GetString()); + } + + private static void DispatchEvent(CopilotSession session, SessionEvent evt) + { + var method = typeof(CopilotSession).GetMethod("DispatchEvent", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("DispatchEvent method was not found."); + method.Invoke(session, [evt]); + } + + private static async Task WaitForRequestAsync(FakeCopilotServer server, string method) + { + using var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(5)); + while (!timeout.IsCancellationRequested) + { + var request = server.Requests.FirstOrDefault(request => request.Method == method); + if (request is not null) + { + return request; + } + + await Task.Delay(20, CancellationToken.None); + } + + throw new TimeoutException($"Timed out waiting for RPC method '{method}'."); + } + + private static async Task ReplaceConnectionCliProcessAsync(CopilotClient client, Process process) + { + var field = typeof(CopilotClient).GetField("_connectionTask", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("_connectionTask field was not found."); + var connectionTask = (Task)field.GetValue(client)!; + await connectionTask; + + var resultProperty = connectionTask.GetType().GetProperty(nameof(Task.Result)) + ?? throw new InvalidOperationException("Connection task result property was not found."); + var connection = resultProperty.GetValue(connectionTask)!; + var connectionType = connection.GetType(); + var rpc = connectionType.GetProperty("Rpc")!.GetValue(connection); + var networkStream = connectionType.GetProperty("NetworkStream")!.GetValue(connection); + var constructor = connectionType.GetConstructors(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public).Single(); + var updatedConnection = constructor.Invoke([rpc, process, networkStream, null, null]); + var fromResult = typeof(Task).GetMethod(nameof(Task.FromResult))!.MakeGenericMethod(connectionType); + field.SetValue(client, fromResult.Invoke(null, [updatedConnection])); + } + + private static Process StartExitedProcess() + { + var startInfo = OperatingSystem.IsWindows() + ? new ProcessStartInfo(Environment.GetEnvironmentVariable("COMSPEC") ?? "cmd.exe", "/c exit 0") + : new ProcessStartInfo("/bin/sh", "-c \"exit 0\""); + startInfo.UseShellExecute = false; + var process = Process.Start(startInfo) + ?? throw new InvalidOperationException("Failed to start test process."); + process.WaitForExit(); + return process; + } + private sealed class FakeCopilotServer : IAsyncDisposable { private readonly TcpListener _listener; @@ -194,8 +890,11 @@ private sealed class FakeCopilotServer : IAsyncDisposable private readonly TaskCompletionSource _destroyStarted = new(TaskCreationOptions.RunContinuationsAsynchronously); private readonly TaskCompletionSource _allowDestroy = new(TaskCreationOptions.RunContinuationsAsynchronously); private readonly Task _serverTask; + private readonly List _requests = []; + private readonly object _requestsLock = new(); private string? _lastSessionId; private bool _delayDestroy; + private bool _failRuntimeShutdown; private FakeCopilotServer(TcpListener listener) { @@ -221,6 +920,27 @@ public static Task StartAsync() public Task DestroyStarted => _destroyStarted.Task; + public int RuntimeShutdownCount { get; private set; } + + public IReadOnlyList Requests + { + get + { + lock (_requestsLock) + { + return _requests.ToArray(); + } + } + } + + public void ClearRequests() + { + lock (_requestsLock) + { + _requests.Clear(); + } + } + public void DelayDestroy() { _delayDestroy = true; @@ -231,6 +951,11 @@ public void CompleteDestroy() _allowDestroy.TrySetResult(); } + public void FailRuntimeShutdown() + { + _failRuntimeShutdown = true; + } + public async ValueTask DisposeAsync() { _allowDestroy.TrySetResult(); @@ -275,6 +1000,29 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel var id = idElement.Clone(); var method = request.GetProperty("method").GetString(); + if (method == "runtime.shutdown" && _failRuntimeShutdown) + { + RuntimeShutdownCount++; + await WriteMessageAsync(stream, new Dictionary + { + ["jsonrpc"] = "2.0", + ["id"] = id, + ["error"] = new Dictionary + { + ["code"] = -32000, + ["message"] = "runtime shutdown failed" + } + }, cancellationToken); + return; + } + + var paramsElement = request.TryGetProperty("params", out var rawParams) + ? rawParams.Clone() + : JsonDocument.Parse("{}").RootElement.Clone(); + lock (_requestsLock) + { + _requests.Add(new RpcRequestRecord(method!, paramsElement)); + } object? result = method switch { "connect" => new Dictionary @@ -285,15 +1033,28 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel }, "session.create" => CreateSessionResult(request), "session.resume" => CreateSessionResult(request), + "session.eventLog.registerInterest" => new Dictionary + { + ["id"] = "interest-1" + }, "session.send" => new Dictionary { ["messageId"] = "message-1" }, + "session.mcp.oauth.handlePendingRequest" => new Dictionary + { + ["success"] = true + }, + "session.permissions.handlePendingPermissionRequest" => new Dictionary + { + ["success"] = true + }, "session.delete" => new Dictionary { ["success"] = true }, "session.destroy" => await DestroySessionAsync(cancellationToken), + "runtime.shutdown" => HandleRuntimeShutdown(), _ => throw new InvalidOperationException($"Unexpected RPC method '{method}'.") }; @@ -340,6 +1101,12 @@ private async Task HandleRequestAsync(Stream stream, JsonElement request, Cancel return []; } + private Dictionary HandleRuntimeShutdown() + { + RuntimeShutdownCount++; + return []; + } + private async Task WriteMessageAsync(Stream stream, object payload, CancellationToken cancellationToken) { using var bodyStream = new MemoryStream(); diff --git a/dotnet/test/Unit/CloneTests.cs b/dotnet/test/Unit/CloneTests.cs index 7353307e7..4bacdfe33 100644 --- a/dotnet/test/Unit/CloneTests.cs +++ b/dotnet/test/Unit/CloneTests.cs @@ -20,6 +20,7 @@ public void CopilotClientOptions_Clone_CopiesAllProperties() GitHubToken = "ghp_test", UseLoggedInUser = false, BaseDirectory = "/custom/copilot/home", + BuiltinPluginDirectories = ["/plugins/core", "/plugins/github"], EnableRemoteSessions = true, SessionIdleTimeoutSeconds = 600, }; @@ -33,6 +34,8 @@ public void CopilotClientOptions_Clone_CopiesAllProperties() Assert.Equal(original.GitHubToken, clone.GitHubToken); Assert.Equal(original.UseLoggedInUser, clone.UseLoggedInUser); Assert.Equal(original.BaseDirectory, clone.BaseDirectory); + Assert.Equal(original.BuiltinPluginDirectories, clone.BuiltinPluginDirectories); + Assert.NotSame(original.BuiltinPluginDirectories, clone.BuiltinPluginDirectories); Assert.Equal(original.EnableRemoteSessions, clone.EnableRemoteSessions); Assert.Equal(original.SessionIdleTimeoutSeconds, clone.SessionIdleTimeoutSeconds); } @@ -73,15 +76,21 @@ public void SessionConfig_Clone_CopiesAllProperties() ConfigDirectory = "/config", AvailableTools = ["tool1", "tool2"], ExcludedTools = ["tool3"], + ExcludedBuiltInAgents = ["explore", "task"], WorkingDirectory = "/workspace", + AdditionalDirectories = ["/shared", "/generated"], Streaming = true, + EnableCitations = true, + EnableFileChangeTracking = true, EnableSessionTelemetry = false, + EnableExperimentalMode = true, EnableOnDemandInstructionDiscovery = true, IncludeSubAgentStreamingEvents = false, McpServers = new Dictionary { ["server1"] = new McpStdioServerConfig { Command = "echo" } }, McpOAuthTokenStorage = McpOAuthTokenStorageMode.Persistent, - CustomAgents = [new CustomAgentConfig { Name = "agent1", Model = "claude-haiku-4.5" }], + CustomAgents = [new CustomAgentConfig { Name = "agent1", Model = "claude-haiku-4.5", ReasoningEffort = "high" }], Agent = "agent1", + Capi = new CapiSessionOptions { EnableWebSocketResponses = false }, Cloud = new CloudSessionOptions { Repository = new CloudSessionRepository @@ -95,8 +104,11 @@ public void SessionConfig_Clone_CopiesAllProperties() SkillDirectories = ["/skills"], InstructionDirectories = ["/instructions"], DisabledSkills = ["skill1"], + DisabledMcpServers = ["server1"], PluginDirectories = ["/plugins"], LargeOutput = new LargeToolOutputConfig { Enabled = true, MaxSizeBytes = 2048, OutputDirectory = "/tmp/out" }, + Memory = new MemoryConfiguration { Enabled = true }, + SessionLimits = new SessionLimitsConfig { MaxAiCredits = 42.5 }, OnExitPlanModeRequest = static (_, _) => Task.FromResult(new ExitPlanModeResult()), OnAutoModeSwitchRequest = static (_, _) => Task.FromResult(AutoModeSwitchResponse.No), }; @@ -112,23 +124,33 @@ public void SessionConfig_Clone_CopiesAllProperties() Assert.Equal(original.ConfigDirectory, clone.ConfigDirectory); Assert.Equal(original.AvailableTools, clone.AvailableTools); Assert.Equal(original.ExcludedTools, clone.ExcludedTools); + Assert.Equal(original.ExcludedBuiltInAgents, clone.ExcludedBuiltInAgents); Assert.Equal(original.WorkingDirectory, clone.WorkingDirectory); + Assert.Equal(original.AdditionalDirectories, clone.AdditionalDirectories); Assert.Equal(original.Streaming, clone.Streaming); + Assert.Equal(original.EnableCitations, clone.EnableCitations); + Assert.Equal(original.EnableFileChangeTracking, clone.EnableFileChangeTracking); Assert.Equal(original.EnableSessionTelemetry, clone.EnableSessionTelemetry); + Assert.Equal(original.EnableExperimentalMode, clone.EnableExperimentalMode); Assert.Equal(original.EnableOnDemandInstructionDiscovery, clone.EnableOnDemandInstructionDiscovery); Assert.Equal(original.IncludeSubAgentStreamingEvents, clone.IncludeSubAgentStreamingEvents); Assert.Equal(original.McpServers.Count, clone.McpServers!.Count); Assert.Equal(original.McpOAuthTokenStorage, clone.McpOAuthTokenStorage); Assert.Equal(original.CustomAgents.Count, clone.CustomAgents!.Count); Assert.Equal(original.CustomAgents[0].Model, clone.CustomAgents[0].Model); + Assert.Equal(original.CustomAgents[0].ReasoningEffort, clone.CustomAgents[0].ReasoningEffort); Assert.Equal(original.Agent, clone.Agent); + Assert.Same(original.Capi, clone.Capi); Assert.Same(original.Cloud, clone.Cloud); Assert.Equal(original.DefaultAgent!.ExcludedTools, clone.DefaultAgent!.ExcludedTools); Assert.Equal(original.SkillDirectories, clone.SkillDirectories); Assert.Equal(original.InstructionDirectories, clone.InstructionDirectories); Assert.Equal(original.DisabledSkills, clone.DisabledSkills); + Assert.Equal(original.DisabledMcpServers, clone.DisabledMcpServers); Assert.Equal(original.PluginDirectories, clone.PluginDirectories); Assert.Same(original.LargeOutput, clone.LargeOutput); + Assert.Same(original.Memory, clone.Memory); + Assert.Same(original.SessionLimits, clone.SessionLimits); Assert.Same(original.OnExitPlanModeRequest, clone.OnExitPlanModeRequest); Assert.Same(original.OnAutoModeSwitchRequest, clone.OnAutoModeSwitchRequest); } @@ -140,11 +162,14 @@ public void SessionConfig_Clone_CollectionsAreIndependent() { AvailableTools = ["tool1"], ExcludedTools = ["tool2"], + ExcludedBuiltInAgents = ["explore"], McpServers = new Dictionary { ["s1"] = new McpStdioServerConfig { Command = "echo" } }, CustomAgents = [new CustomAgentConfig { Name = "a1" }], + AdditionalDirectories = ["/shared"], SkillDirectories = ["/skills"], InstructionDirectories = ["/instructions"], DisabledSkills = ["skill1"], + DisabledMcpServers = ["server1"], }; var clone = original.Clone(); @@ -152,20 +177,26 @@ public void SessionConfig_Clone_CollectionsAreIndependent() // Mutate clone collections clone.AvailableTools!.Add("tool99"); clone.ExcludedTools!.Add("tool99"); + clone.ExcludedBuiltInAgents!.Add("task"); clone.McpServers!["s2"] = new McpStdioServerConfig { Command = "echo" }; clone.CustomAgents!.Add(new CustomAgentConfig { Name = "a2" }); + clone.AdditionalDirectories!.Add("/generated"); clone.SkillDirectories!.Add("/more"); clone.InstructionDirectories!.Add("/more-instructions"); clone.DisabledSkills!.Add("skill99"); + clone.DisabledMcpServers!.Add("server99"); // Original is unaffected Assert.Single(original.AvailableTools!); Assert.Single(original.ExcludedTools!); + Assert.Single(original.ExcludedBuiltInAgents!); Assert.Single(original.McpServers!); Assert.Single(original.CustomAgents!); + Assert.Single(original.AdditionalDirectories!); Assert.Single(original.SkillDirectories!); Assert.Single(original.InstructionDirectories!); Assert.Single(original.DisabledSkills!); + Assert.Single(original.DisabledMcpServers!); } [Fact] @@ -186,11 +217,14 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() { AvailableTools = ["tool1"], ExcludedTools = ["tool2"], + ExcludedBuiltInAgents = ["explore"], McpServers = new Dictionary { ["s1"] = new McpStdioServerConfig { Command = "echo" } }, CustomAgents = [new CustomAgentConfig { Name = "a1" }], + AdditionalDirectories = ["/shared"], SkillDirectories = ["/skills"], InstructionDirectories = ["/instructions"], DisabledSkills = ["skill1"], + DisabledMcpServers = ["server1"], }; var clone = original.Clone(); @@ -198,20 +232,26 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() // Mutate clone collections clone.AvailableTools!.Add("tool99"); clone.ExcludedTools!.Add("tool99"); + clone.ExcludedBuiltInAgents!.Add("task"); clone.McpServers!["s2"] = new McpStdioServerConfig { Command = "echo" }; clone.CustomAgents!.Add(new CustomAgentConfig { Name = "a2" }); + clone.AdditionalDirectories!.Add("/generated"); clone.SkillDirectories!.Add("/more"); clone.InstructionDirectories!.Add("/more-instructions"); clone.DisabledSkills!.Add("skill99"); + clone.DisabledMcpServers!.Add("server99"); // Original is unaffected Assert.Single(original.AvailableTools!); Assert.Single(original.ExcludedTools!); + Assert.Single(original.ExcludedBuiltInAgents!); Assert.Single(original.McpServers!); Assert.Single(original.CustomAgents!); + Assert.Single(original.AdditionalDirectories!); Assert.Single(original.SkillDirectories!); Assert.Single(original.InstructionDirectories!); Assert.Single(original.DisabledSkills!); + Assert.Single(original.DisabledMcpServers!); } [Fact] @@ -231,7 +271,7 @@ public void MessageOptions_Clone_CopiesAllProperties() var original = new MessageOptions { Prompt = "Hello", - Attachments = [new UserMessageAttachmentFile { Path = "/test.txt", DisplayName = "test.txt" }], + Attachments = [new AttachmentFile { Path = "/test.txt", DisplayName = "test.txt" }], Mode = "chat", }; @@ -247,12 +287,12 @@ public void MessageOptions_Clone_AttachmentsAreIndependent() { var original = new MessageOptions { - Attachments = [new UserMessageAttachmentFile { Path = "/test.txt", DisplayName = "test.txt" }], + Attachments = [new AttachmentFile { Path = "/test.txt", DisplayName = "test.txt" }], }; var clone = original.Clone(); - clone.Attachments!.Add(new UserMessageAttachmentFile { Path = "/other.txt", DisplayName = "other.txt" }); + clone.Attachments!.Add(new AttachmentFile { Path = "/other.txt", DisplayName = "other.txt" }); Assert.Single(original.Attachments!); } @@ -266,11 +306,13 @@ public void Clone_WithNullCollections_ReturnsNullCollections() Assert.Null(clone.AvailableTools); Assert.Null(clone.ExcludedTools); + Assert.Null(clone.ExcludedBuiltInAgents); Assert.Null(clone.McpServers); Assert.Null(clone.CustomAgents); Assert.Null(clone.SkillDirectories); Assert.Null(clone.InstructionDirectories); Assert.Null(clone.DisabledSkills); + Assert.Null(clone.DisabledMcpServers); Assert.Null(clone.Tools); Assert.Null(clone.DefaultAgent); Assert.True(clone.IncludeSubAgentStreamingEvents); @@ -355,6 +397,19 @@ public void ResumeSessionConfig_Clone_CopiesEnableSessionTelemetry() Assert.False(clone.EnableSessionTelemetry); } + [Fact] + public void ResumeSessionConfig_Clone_CopiesEnableExperimentalMode() + { + var original = new ResumeSessionConfig + { + EnableExperimentalMode = true, + }; + + var clone = original.Clone(); + + Assert.True(clone.EnableExperimentalMode); + } + [Fact] public void ResumeSessionConfig_Clone_CopiesContinuePendingWork() { @@ -402,12 +457,14 @@ public void ResumeSessionConfig_Clone_CopiesPluginDirectoriesAndLargeOutput() { PluginDirectories = ["/resume/plugins"], LargeOutput = largeOutput, + Memory = new MemoryConfiguration { Enabled = true }, }; var clone = original.Clone(); Assert.Equal(original.PluginDirectories, clone.PluginDirectories); Assert.Same(original.LargeOutput, clone.LargeOutput); + Assert.Same(original.Memory, clone.Memory); } [Fact] @@ -440,6 +497,26 @@ public void ResumeSessionConfig_Clone_PreservesEnableSessionTelemetryDefault() Assert.Null(clone.EnableSessionTelemetry); } + [Fact] + public void SessionConfig_Clone_PreservesEnableExperimentalModeDefault() + { + var original = new SessionConfig(); + + var clone = original.Clone(); + + Assert.Null(clone.EnableExperimentalMode); + } + + [Fact] + public void ResumeSessionConfig_Clone_PreservesEnableExperimentalModeDefault() + { + var original = new ResumeSessionConfig(); + + var clone = original.Clone(); + + Assert.Null(clone.EnableExperimentalMode); + } + [Fact] public void SessionConfig_Clone_CopiesEnableOnDemandInstructionDiscovery() { @@ -511,4 +588,30 @@ public void ResumeSessionConfig_Clone_CopiesMcpOAuthTokenStorage() Assert.Equal(McpOAuthTokenStorageMode.Persistent, clone.McpOAuthTokenStorage); } + + [Fact] + public void SessionConfig_Clone_CopiesCapiOptions() + { + var original = new SessionConfig + { + Capi = new CapiSessionOptions { EnableWebSocketResponses = false }, + }; + + var clone = original.Clone(); + + Assert.Same(original.Capi, clone.Capi); + } + + [Fact] + public void ResumeSessionConfig_Clone_CopiesCapiOptions() + { + var original = new ResumeSessionConfig + { + Capi = new CapiSessionOptions { EnableWebSocketResponses = false }, + }; + + var clone = original.Clone(); + + Assert.Same(original.Capi, clone.Capi); + } } diff --git a/dotnet/test/Unit/CopilotToolTests.cs b/dotnet/test/Unit/CopilotToolTests.cs index 76ad0e425..19fa6258b 100644 --- a/dotnet/test/Unit/CopilotToolTests.cs +++ b/dotnet/test/Unit/CopilotToolTests.cs @@ -5,6 +5,7 @@ using Microsoft.Extensions.AI; using System.ComponentModel; using System.Text.Json; +using System.Text.Json.Nodes; using Xunit; namespace GitHub.Copilot.Test.Unit; @@ -19,7 +20,8 @@ public void DefineTool_Sets_Name_Description_And_Copilot_Metadata() new CopilotToolOptions { OverridesBuiltInTool = true, - SkipPermission = true + SkipPermission = true, + Defer = CopilotToolDefer.Auto }); Assert.Equal("test_tool", function.Name); @@ -28,6 +30,30 @@ public void DefineTool_Sets_Name_Description_And_Copilot_Metadata() Assert.True((bool)isOverride!); Assert.True(function.AdditionalProperties.TryGetValue("skip_permission", out var skipPermission)); Assert.True((bool)skipPermission!); + Assert.True(function.AdditionalProperties.TryGetValue("defer", out var defer)); + Assert.Equal(CopilotToolDefer.Auto, defer); + } + + [Fact] + public void DefineTool_Sets_IsTerminal_Metadata() + { + var function = CopilotTool.DefineTool( + ReturnsOk, + new CopilotToolOptions + { + IsTerminal = true + }); + + Assert.True(function.AdditionalProperties.TryGetValue("is_terminal", out var isTerminal)); + Assert.True((bool)isTerminal!); + } + + [Fact] + public void DefineTool_Omits_IsTerminal_When_Not_Set() + { + var function = CopilotTool.DefineTool(ReturnsOk); + + Assert.False(function.AdditionalProperties.ContainsKey("is_terminal")); } [Fact] @@ -37,6 +63,35 @@ public void DefineTool_Omits_Copilot_Metadata_When_Flags_Are_False() Assert.False(function.AdditionalProperties.ContainsKey("is_override")); Assert.False(function.AdditionalProperties.ContainsKey("skip_permission")); + Assert.False(function.AdditionalProperties.ContainsKey("defer")); + } + + [Fact] + public void DefineTool_Sets_Metadata_In_Additional_Properties() + { + var metadata = new Dictionary + { + ["github.com/copilot:safeForTelemetry"] = new JsonObject + { + ["name"] = true, + ["inputsNames"] = false + } + }; + + var function = CopilotTool.DefineTool( + ReturnsOk, + new CopilotToolOptions { Metadata = metadata }); + + Assert.True(function.AdditionalProperties.TryGetValue("metadata", out var value)); + Assert.Same(metadata, value); + } + + [Fact] + public void DefineTool_Omits_Metadata_When_Unset() + { + var function = CopilotTool.DefineTool(ReturnsOk); + + Assert.False(function.AdditionalProperties.ContainsKey("metadata")); } [Fact] diff --git a/dotnet/test/Unit/E2ETestBackendTests.cs b/dotnet/test/Unit/E2ETestBackendTests.cs new file mode 100644 index 000000000..f7c39a508 --- /dev/null +++ b/dotnet/test/Unit/E2ETestBackendTests.cs @@ -0,0 +1,80 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using GitHub.Copilot.Test.Harness; +using Xunit; + +namespace GitHub.Copilot.Test.Unit; + +public class E2ETestBackendTests +{ + [Theory] + [InlineData(null, "capi")] + [InlineData("", "capi")] + [InlineData("capi", "capi")] + [InlineData("ANTHROPIC-MESSAGES", "anthropic-messages")] + [InlineData("openai-responses", "openai-responses")] + [InlineData("openai-completions", "openai-completions")] + public void ParsesBackend(string? value, string expected) + => Assert.Equal(expected, E2ETestBackendConfiguration.Parse(value).ToWireName()); + + [Fact] + public void RejectsUnknownBackend() + => Assert.Throws( + () => E2ETestBackendConfiguration.Parse("unknown")); + + [Theory] + [InlineData("anthropic-messages", "anthropic", null, "claude-sonnet-4.5")] + [InlineData("openai-responses", "openai", "responses", "gpt-4.1")] + [InlineData("openai-completions", "openai", "completions", "gpt-4.1")] + public void AppliesProvider( + string backendValue, + string expectedType, + string? expectedWireApi, + string expectedModel) + { + var backend = E2ETestBackendConfiguration.Parse(backendValue); + var config = new SessionConfig(); + backend.ApplyProvider(config, "http://localhost:1234"); + + Assert.Equal(expectedModel, config.Model); + Assert.Equal("http://localhost:1234", config.Provider!.BaseUrl); + Assert.Equal(expectedType, config.Provider.Type); + Assert.Equal(expectedWireApi, config.Provider.WireApi); + Assert.Equal(expectedModel, config.Provider.ModelId); + Assert.Equal(expectedModel, config.Provider.WireModel); + Assert.False(string.IsNullOrEmpty(config.Provider.BearerToken)); + } + + [Fact] + public void PreservesExplicitModel() + { + var config = new SessionConfig { Model = "test-model" }; + E2ETestBackend.OpenAIResponses.ApplyProvider(config, "http://localhost:1234"); + + Assert.Equal("test-model", config.Model); + Assert.Equal("test-model", config.Provider!.ModelId); + Assert.Equal("test-model", config.Provider.WireModel); + } + + [Fact] + public void PreservesExplicitProvider() + { + var provider = new ProviderConfig + { + Type = "custom", + ModelId = "provider-model", + }; + var config = new SessionConfig + { + Model = "session-model", + Provider = provider, + }; + + E2ETestBackend.OpenAIResponses.ApplyProvider(config, "http://localhost:1234"); + + Assert.Equal("session-model", config.Model); + Assert.Same(provider, config.Provider); + } +} diff --git a/dotnet/test/Unit/E2ETestFixtureTests.cs b/dotnet/test/Unit/E2ETestFixtureTests.cs new file mode 100644 index 000000000..f7dee3ce0 --- /dev/null +++ b/dotnet/test/Unit/E2ETestFixtureTests.cs @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using Xunit; + +namespace GitHub.Copilot.Test.Unit; + +public class E2ETestFixtureTests +{ + [Fact] + public void Shared_Client_Uses_InProcess_Connection_For_InProcess_Tests() + { + var connection = E2ETestFixture.CreateSharedConnection(useInProcessTransport: true); + + Assert.IsType(connection); + } + + [Fact] + public void Shared_Client_Preserves_Tcp_Connection_For_OutOfProcess_Tests() + { + var connection = Assert.IsType( + E2ETestFixture.CreateSharedConnection(useInProcessTransport: false)); + + Assert.Equal(E2ETestFixture.SharedTcpConnectionToken, connection.ConnectionToken); + } +} diff --git a/dotnet/test/Unit/ForwardCompatibilityTests.cs b/dotnet/test/Unit/ForwardCompatibilityTests.cs index 09133dfb5..b52a7713f 100644 --- a/dotnet/test/Unit/ForwardCompatibilityTests.cs +++ b/dotnet/test/Unit/ForwardCompatibilityTests.cs @@ -168,6 +168,24 @@ public void FromJson_UnknownEventType_WithUnknownEnumInData_DoesNotThrow() Assert.Equal("unknown", result.Type); } + [Fact] + public void FromJson_InternalEventType_ReturnsBaseSessionEvent() + { + var json = """ + { + "id": "12345678-1234-1234-1234-123456789abc", + "timestamp": "2026-06-15T10:30:00Z", + "type": "session.memory_changed", + "data": {} + } + """; + + var result = SessionEvent.FromJson(json); + + Assert.IsType(result); + Assert.Equal("unknown", result.Type); + } + [Fact] public void FromJson_KnownEventType_WithUnknownEnumInData_PreservesValue() { diff --git a/dotnet/test/Unit/GitHubTelemetryTests.cs b/dotnet/test/Unit/GitHubTelemetryTests.cs new file mode 100644 index 000000000..a4a241e38 --- /dev/null +++ b/dotnet/test/Unit/GitHubTelemetryTests.cs @@ -0,0 +1,593 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +#if NET8_0_OR_GREATER +using System.Net; +using System.Net.Sockets; +using System.Text; +using System.Text.Json; +using Xunit; + +using GitHub.Copilot.Rpc; + +namespace GitHub.Copilot.Test.Unit; + +#pragma warning disable GHCP001 // GitHub telemetry forwarding is experimental. + +public sealed class GitHubTelemetryTests +{ + [Theory] + [InlineData(false)] + [InlineData(true)] + public async Task BuiltinPluginDirectories_Default_Or_Empty_Does_Not_Call_Rpc(bool useEmpty) + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + BuiltinPluginDirectories = useEmpty ? [] : null, + }); + + await client.StartAsync(); + + Assert.Equal(0, server.BuiltinPluginSetCount); + } + + [Fact] + public async Task BuiltinPluginDirectories_Are_Set_Once_Before_Start_Completes() + { + var paths = new[] + { + Path.GetFullPath(Path.Join("plugins", "core")), + Path.GetFullPath(Path.Join("plugins", "github")), + }; + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + BuiltinPluginDirectories = paths, + }); + + await client.StartAsync(); + + Assert.Equal(1, server.BuiltinPluginSetCount); + var payload = server.LastBuiltinPluginParams + ?? throw new InvalidOperationException("plugins.builtin.set was not captured."); + Assert.Collection( + payload.GetProperty("paths").EnumerateArray(), + value => Assert.Equal(paths[0], value.GetString()), + value => Assert.Equal(paths[1], value.GetString())); + } + + [Fact] + public void BuiltinPluginDirectories_Reject_Relative_Paths() + { + var exception = Assert.Throws(() => new CopilotClient(new CopilotClientOptions + { + BuiltinPluginDirectories = ["plugins/core"], + })); + + Assert.Contains("absolute paths", exception.Message); + } + + [Fact] + public async Task CreateSession_Opts_Into_Forwarding_When_Handler_Provided() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + OnGitHubTelemetry = _ => Task.CompletedTask, + }); + await client.StartAsync(); + + await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + + var createParams = server.LastCreateParams ?? throw new InvalidOperationException("session.create was not captured."); + Assert.True(createParams.TryGetProperty("enableGitHubTelemetryForwarding", out var flag)); + Assert.True(flag.GetBoolean()); + } + + [Fact] + public async Task ResumeSession_Opts_Into_Forwarding_When_Handler_Provided() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + OnGitHubTelemetry = _ => Task.CompletedTask, + }); + await client.StartAsync(); + + await client.ResumeSessionAsync("session-1", new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + + var resumeParams = server.LastResumeParams ?? throw new InvalidOperationException("session.resume was not captured."); + Assert.True(resumeParams.TryGetProperty("enableGitHubTelemetryForwarding", out var flag)); + Assert.True(flag.GetBoolean()); + } + + [Fact] + public async Task Connect_Opts_Into_Forwarding_When_Handler_Provided() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + OnGitHubTelemetry = _ => Task.CompletedTask, + }); + await client.StartAsync(); + + var connectParams = server.LastConnectParams ?? throw new InvalidOperationException("connect was not captured."); + Assert.True(connectParams.TryGetProperty("enableGitHubTelemetryForwarding", out var flag)); + Assert.True(flag.GetBoolean()); + } + + [Fact] + public async Task Connect_Does_Not_Opt_In_Without_Handler() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + }); + await client.StartAsync(); + + var connectParams = server.LastConnectParams ?? throw new InvalidOperationException("connect was not captured."); + var present = connectParams.TryGetProperty("enableGitHubTelemetryForwarding", out var flag); + Assert.True( + !present || flag.ValueKind == JsonValueKind.Null, + "connect request should omit enableGitHubTelemetryForwarding (or send null) when no handler is registered"); + } + + [Fact] + public async Task CreateSession_Does_Not_Opt_In_Without_Handler() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + }); + await client.StartAsync(); + + await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }); + + var createParams = server.LastCreateParams ?? throw new InvalidOperationException("session.create was not captured."); + var optedIn = createParams.TryGetProperty("enableGitHubTelemetryForwarding", out var flag) + && flag.ValueKind == JsonValueKind.True; + Assert.False(optedIn); + } + + [Fact] + public async Task GitHubTelemetry_Event_Is_Forwarded_To_OnGitHubTelemetry() + { + var received = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + OnGitHubTelemetry = notification => + { + received.TrySetResult(notification); + return Task.CompletedTask; + }, + }); + await client.StartAsync(); + + await server.SendGitHubTelemetryEventAsync(new Dictionary + { + ["sessionId"] = "session-1", + ["restricted"] = false, + ["event"] = new Dictionary + { + ["kind"] = "tool_call_executed", + ["properties"] = new Dictionary { ["tool"] = "shell" }, + ["metrics"] = new Dictionary { ["duration_ms"] = 42 }, + ["session_id"] = "session-1", + }, + }); + + var notification = await received.Task.WaitAsync(TimeSpan.FromSeconds(10)); + Assert.Equal("session-1", notification.SessionId); + Assert.False(notification.Restricted); + Assert.Equal("tool_call_executed", notification.Event.Kind); + Assert.Equal("shell", notification.Event.Properties["tool"]); + Assert.Equal(42, notification.Event.Metrics["duration_ms"]); + Assert.Equal("session-1", notification.Event.SessionId); + } + + [Fact] + public async Task GitHubTelemetry_Event_Maps_Restricted_And_ClientInfo() + { + var received = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + OnGitHubTelemetry = notification => + { + received.TrySetResult(notification); + return Task.CompletedTask; + }, + }); + await client.StartAsync(); + + await server.SendGitHubTelemetryEventAsync(new Dictionary + { + ["sessionId"] = "session-2", + ["restricted"] = true, + ["event"] = new Dictionary + { + ["kind"] = "model_call", + ["properties"] = new Dictionary { ["model"] = "gpt-5" }, + ["metrics"] = new Dictionary { ["tokens"] = 128 }, + ["session_id"] = "session-2", + ["client"] = new Dictionary + { + ["cli_version"] = "1.2.3", + ["os_platform"] = "win32", + ["os_arch"] = "x64", + ["node_version"] = "20.0.0", + ["is_staff"] = false, + }, + }, + }); + + var notification = await received.Task.WaitAsync(TimeSpan.FromSeconds(10)); + Assert.True(notification.Restricted); + + var clientInfo = notification.Event.Client; + Assert.NotNull(clientInfo); + Assert.Equal("1.2.3", clientInfo!.CliVersion); + Assert.Equal("win32", clientInfo.OsPlatform); + Assert.Equal("x64", clientInfo.OsArch); + Assert.Equal("20.0.0", clientInfo.NodeVersion); + Assert.Equal(false, clientInfo.IsStaff); + } + + [Fact] + public async Task CreateSession_EmptyMode_Sends_IsExperimentalMode_False_By_Default() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + await client.StartAsync(); + + await client.CreateSessionAsync(new SessionConfig + { + AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated).ToList(), + }); + + var createParams = server.LastCreateParams ?? throw new InvalidOperationException("session.create was not captured."); + Assert.True(createParams.TryGetProperty("isExperimentalMode", out var flag)); + Assert.False(flag.GetBoolean()); + } + + [Fact] + public async Task ResumeSession_EmptyMode_Sends_IsExperimentalMode_False_By_Default() + { + await using var server = await FakeTelemetryServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions + { + Connection = RuntimeConnection.ForUri(server.Url), + Mode = CopilotClientMode.Empty, + BaseDirectory = Path.GetTempPath(), + }); + await client.StartAsync(); + + await client.ResumeSessionAsync("session-1", new ResumeSessionConfig + { + AvailableTools = new ToolSet().AddBuiltIn(BuiltInTools.Isolated).ToList(), + }); + + var resumeParams = server.LastResumeParams ?? throw new InvalidOperationException("session.resume was not captured."); + Assert.True(resumeParams.TryGetProperty("isExperimentalMode", out var flag)); + Assert.False(flag.GetBoolean()); + } + + private sealed class FakeTelemetryServer : IAsyncDisposable + { + private readonly TcpListener _listener; + private readonly CancellationTokenSource _cts = new(); + private readonly SemaphoreSlim _writeLock = new(1, 1); + private readonly TaskCompletionSource _connected = new(TaskCreationOptions.RunContinuationsAsynchronously); + private readonly Task _serverTask; + + private FakeTelemetryServer(TcpListener listener) + { + _listener = listener; + _serverTask = RunAsync(); + } + + public string Url + { + get + { + var endpoint = (IPEndPoint)_listener.LocalEndpoint; + return $"http://127.0.0.1:{endpoint.Port}"; + } + } + + public JsonElement? LastCreateParams { get; private set; } + + public JsonElement? LastResumeParams { get; private set; } + + public JsonElement? LastConnectParams { get; private set; } + + public JsonElement? LastBuiltinPluginParams { get; private set; } + + public int BuiltinPluginSetCount { get; private set; } + + public static Task StartAsync() + { + var listener = new TcpListener(IPAddress.Loopback, 0); + listener.Start(); + return Task.FromResult(new FakeTelemetryServer(listener)); + } + + public async Task SendGitHubTelemetryEventAsync(Dictionary notificationParams) + { + var stream = await _connected.Task.WaitAsync(_cts.Token); + + // Send a genuine JSON-RPC notification (no "id"), exactly as the runtime + // does via sendNotification. This exercises the real notification dispatch + // path rather than masking it behind a request that carries an id. + await WriteMessageAsync(stream, new Dictionary + { + ["jsonrpc"] = "2.0", + ["method"] = "gitHubTelemetry.event", + ["params"] = notificationParams, + }, _cts.Token); + } + + public async ValueTask DisposeAsync() + { + _cts.Cancel(); + _listener.Stop(); + + try + { + await _serverTask; + } + catch (Exception ex) when (ex is OperationCanceledException or ObjectDisposedException or IOException or SocketException) + { + // Expected during teardown: the listener/socket is torn down while the + // server loop is still awaiting I/O. Observe the exception and move on. + _ = ex; + } + + _cts.Dispose(); + _writeLock.Dispose(); + } + + private async Task RunAsync() + { + using var tcpClient = await _listener.AcceptTcpClientAsync(_cts.Token); + using var stream = tcpClient.GetStream(); + _connected.TrySetResult(stream); + + while (!_cts.Token.IsCancellationRequested) + { + using var message = await ReadMessageAsync(stream, _cts.Token); + if (message is null) + { + return; + } + + // Inbound messages without a "method" are responses to our own + // server-initiated requests (e.g. session.* the SDK answers); the + // SDK never replies to the gitHubTelemetry.event notification. + if (!message.RootElement.TryGetProperty("method", out _)) + { + continue; + } + + await HandleRequestAsync(stream, message.RootElement, _cts.Token); + } + } + + private async Task HandleRequestAsync(Stream stream, JsonElement request, CancellationToken cancellationToken) + { + if (!request.TryGetProperty("id", out var idElement)) + { + return; + } + + var id = idElement.Clone(); + var method = request.GetProperty("method").GetString(); + + object? result = method switch + { + "connect" => CaptureConnect(request), + "plugins.builtin.set" => CaptureBuiltinPluginDirectories(request), + "session.create" => CaptureCreate(request), + "session.resume" => CaptureResume(request), + "session.send" => new Dictionary { ["messageId"] = "message-1" }, + "session.destroy" => new Dictionary(), + "session.options.update" => new Dictionary { ["success"] = true }, + "runtime.shutdown" => new Dictionary(), + _ => throw new InvalidOperationException($"Unexpected RPC method '{method}'."), + }; + + await WriteMessageAsync(stream, new Dictionary + { + ["jsonrpc"] = "2.0", + ["id"] = id, + ["result"] = result, + }, cancellationToken); + } + + private Dictionary CaptureConnect(JsonElement request) + { + LastConnectParams = request.TryGetProperty("params", out var p) ? p.Clone() : null; + return new Dictionary + { + ["ok"] = true, + ["protocolVersion"] = 3, + ["version"] = "test", + }; + } + + private Dictionary CaptureBuiltinPluginDirectories(JsonElement request) + { + BuiltinPluginSetCount++; + LastBuiltinPluginParams = request.TryGetProperty("params", out var p) ? p.Clone() : null; + return new Dictionary(); + } + + private Dictionary CaptureCreate(JsonElement request) + { + LastCreateParams = request.TryGetProperty("params", out var p) ? p.Clone() : null; + return SessionResult(LastCreateParams); + } + + private Dictionary CaptureResume(JsonElement request) + { + LastResumeParams = request.TryGetProperty("params", out var p) ? p.Clone() : null; + return SessionResult(LastResumeParams); + } + + private static Dictionary SessionResult(JsonElement? paramsElement) + { + string sessionId = "session-1"; + if (paramsElement is { ValueKind: JsonValueKind.Object } p + && p.TryGetProperty("sessionId", out var sidProp) + && sidProp.ValueKind == JsonValueKind.String + && sidProp.GetString() is string sid + && !string.IsNullOrEmpty(sid)) + { + sessionId = sid; + } + + return new Dictionary + { + ["sessionId"] = sessionId, + ["workspacePath"] = null, + ["capabilities"] = null, + }; + } + + private async Task WriteMessageAsync(Stream stream, object payload, CancellationToken cancellationToken) + { + using var bodyStream = new MemoryStream(); + using (var writer = new Utf8JsonWriter(bodyStream)) + { + WriteJsonValue(writer, payload); + } + + var body = bodyStream.ToArray(); + var header = Encoding.ASCII.GetBytes($"Content-Length: {body.Length}\r\n\r\n"); + + await _writeLock.WaitAsync(cancellationToken); + try + { + await stream.WriteAsync(header, cancellationToken); + await stream.WriteAsync(body, cancellationToken); + await stream.FlushAsync(cancellationToken); + } + finally + { + _writeLock.Release(); + } + } + + private static void WriteJsonValue(Utf8JsonWriter writer, object? value) + { + switch (value) + { + case null: + writer.WriteNullValue(); + break; + case string stringValue: + writer.WriteStringValue(stringValue); + break; + case bool boolValue: + writer.WriteBooleanValue(boolValue); + break; + case int intValue: + writer.WriteNumberValue(intValue); + break; + case long longValue: + writer.WriteNumberValue(longValue); + break; + case JsonElement jsonElement: + jsonElement.WriteTo(writer); + break; + case Dictionary dictionary: + writer.WriteStartObject(); + foreach (var (propertyName, propertyValue) in dictionary) + { + writer.WritePropertyName(propertyName); + WriteJsonValue(writer, propertyValue); + } + writer.WriteEndObject(); + break; + default: + throw new InvalidOperationException($"Unexpected JSON value type '{value.GetType().Name}'."); + } + } + + private static async Task ReadMessageAsync(Stream stream, CancellationToken cancellationToken) + { + var headerBytes = new List(); + while (true) + { + var value = await ReadByteAsync(stream, cancellationToken); + if (value < 0) + { + return null; + } + + headerBytes.Add((byte)value); + var count = headerBytes.Count; + if (count >= 4 && + headerBytes[count - 4] == '\r' && + headerBytes[count - 3] == '\n' && + headerBytes[count - 2] == '\r' && + headerBytes[count - 1] == '\n') + { + break; + } + } + + var header = Encoding.ASCII.GetString([.. headerBytes]); + var contentLength = header + .Split(["\r\n"], StringSplitOptions.RemoveEmptyEntries) + .Select(line => line.Split(':', 2)) + .Where(parts => parts.Length == 2 && parts[0].Equals("Content-Length", StringComparison.OrdinalIgnoreCase)) + .Select(parts => int.Parse(parts[1].Trim(), System.Globalization.CultureInfo.InvariantCulture)) + .Single(); + + var body = new byte[contentLength]; + var offset = 0; + while (offset < body.Length) + { + var read = await stream.ReadAsync(body.AsMemory(offset, body.Length - offset), cancellationToken); + if (read == 0) + { + return null; + } + + offset += read; + } + + return JsonDocument.Parse(body); + } + + private static async Task ReadByteAsync(Stream stream, CancellationToken cancellationToken) + { + var buffer = new byte[1]; + var read = await stream.ReadAsync(buffer, cancellationToken); + return read == 0 ? -1 : buffer[0]; + } + } +} + +#pragma warning restore GHCP001 +#endif diff --git a/dotnet/test/Unit/JsonRpcTests.cs b/dotnet/test/Unit/JsonRpcTests.cs index 9e8b19044..f4acfd355 100644 --- a/dotnet/test/Unit/JsonRpcTests.cs +++ b/dotnet/test/Unit/JsonRpcTests.cs @@ -3,6 +3,7 @@ *--------------------------------------------------------------------------------------------*/ using System.Reflection; +using System.Text; using System.Text.Json; using System.Text.Json.Serialization.Metadata; using Xunit; @@ -93,6 +94,57 @@ public async Task JsonRpc_Cancels_And_Disposes_Pending_Requests() await Assert.ThrowsAnyAsync(() => pending); } + [Fact] + public async Task JsonRpc_Does_Not_Retain_Oversized_Receive_Buffer() + { + var oversizedFrame = CreateResponseFrame( + long.MaxValue, + "ignored", + headerPaddingLength: 1024 * 1024); + var carriedFrame = CreateResponseFrame(1, "carried"); + using var receiveStream = new CoalescedFramesThenWaitStream(oversizedFrame, carriedFrame); + using var rpc = new JsonRpcReflection(Stream.Null, receiveStream); + + var carriedResponse = rpc.InvokeAsync("pending", args: null); + rpc.StartListening(); + + var responseCompleted = await Task.WhenAny( + carriedResponse, + Task.Delay(TimeSpan.FromSeconds(5))); + Assert.Same(carriedResponse, responseCompleted); + Assert.Equal("carried", await carriedResponse); + Assert.True(receiveStream.FramesWereCoalesced); + + var readCompleted = await Task.WhenAny( + receiveStream.PostFrameReadBufferSize, + Task.Delay(TimeSpan.FromSeconds(5))); + Assert.Same(receiveStream.PostFrameReadBufferSize, readCompleted); + Assert.InRange(await receiveStream.PostFrameReadBufferSize, 1, 1024 * 1024); + } + + private static byte[] CreateResponseFrame(long id, string result, int headerPaddingLength = 0) + { + using var bodyStream = new MemoryStream(); + using (var writer = new Utf8JsonWriter(bodyStream)) + { + writer.WriteStartObject(); + writer.WriteString("jsonrpc", "2.0"); + writer.WriteNumber("id", id); + writer.WriteString("result", result); + writer.WriteEndObject(); + } + + var body = bodyStream.ToArray(); + var paddingHeader = headerPaddingLength > 0 + ? $"X-Padding: {new string('x', headerPaddingLength)}\r\n" + : string.Empty; + var header = Encoding.ASCII.GetBytes($"{paddingHeader}Content-Length: {body.Length}\r\n\r\n"); + var frame = new byte[header.Length + body.Length]; + header.CopyTo(frame, 0); + body.CopyTo(frame, header.Length); + return frame; + } + private static int GetRemoteErrorCode(Exception exception) { var property = exception.GetType().GetProperty("ErrorCode", BindingFlags.Instance | BindingFlags.Public); @@ -170,12 +222,17 @@ private sealed class JsonRpcReflection : IDisposable private readonly object _instance; public JsonRpcReflection(Stream stream) + : this(stream, stream) + { + } + + public JsonRpcReflection(Stream sendStream, Stream receiveStream) { _instance = Activator.CreateInstance( JsonRpcType, BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic, binder: null, - args: [stream, stream, SerializerOptions, null], + args: [sendStream, receiveStream, SerializerOptions, null], culture: null)!; } @@ -198,6 +255,82 @@ public async Task InvokeAsync(string methodName, object?[]? args, Cancella public void Dispose() => ((IDisposable)_instance).Dispose(); } + private sealed class CoalescedFramesThenWaitStream : Stream + { + private readonly TaskCompletionSource _postFrameReadBufferSize = + new(TaskCreationOptions.RunContinuationsAsynchronously); + private readonly byte[] _frames; + private readonly int _firstFrameLength; + private int _offset; + + public CoalescedFramesThenWaitStream(byte[] firstFrame, byte[] secondFrame) + { + _firstFrameLength = firstFrame.Length; + _frames = new byte[firstFrame.Length + secondFrame.Length]; + firstFrame.CopyTo(_frames, 0); + secondFrame.CopyTo(_frames, firstFrame.Length); + } + + public bool FramesWereCoalesced { get; private set; } + + public Task PostFrameReadBufferSize => _postFrameReadBufferSize.Task; + + public override bool CanRead => true; + + public override bool CanSeek => false; + + public override bool CanWrite => false; + + public override long Length => throw new NotSupportedException(); + + public override long Position { get => throw new NotSupportedException(); set => throw new NotSupportedException(); } + + public override int Read(byte[] buffer, int offset, int count) => throw new NotSupportedException(); + + public override Task ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) => + ReadCoreAsync(buffer.AsMemory(offset, count), cancellationToken).AsTask(); + +#if NET8_0_OR_GREATER + public override +#else + internal +#endif + ValueTask ReadAsync(Memory destination, CancellationToken cancellationToken = default) => + ReadCoreAsync(destination, cancellationToken); + + public override void Flush() + { + } + + public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException(); + + public override void SetLength(long value) => throw new NotSupportedException(); + + public override void Write(byte[] buffer, int offset, int count) => throw new NotSupportedException(); + + private ValueTask ReadCoreAsync(Memory destination, CancellationToken cancellationToken) + { + if (_offset >= _frames.Length) + { + _postFrameReadBufferSize.TrySetResult(destination.Length); + return new ValueTask(WaitForCancellationAsync(cancellationToken)); + } + + var startingOffset = _offset; + var bytesRead = Math.Min(destination.Length, _frames.Length - _offset); + _frames.AsMemory(_offset, bytesRead).CopyTo(destination); + _offset += bytesRead; + FramesWereCoalesced |= startingOffset < _firstFrameLength && _offset == _frames.Length; + return new ValueTask(bytesRead); + } + + private static async Task WaitForCancellationAsync(CancellationToken cancellationToken) + { + await Task.Delay(Timeout.InfiniteTimeSpan, cancellationToken).ConfigureAwait(false); + return 0; + } + } + private sealed class InMemoryDuplexStream : Stream { private readonly Queue _buffer = new(); diff --git a/dotnet/test/Unit/PermissionHandlerTests.cs b/dotnet/test/Unit/PermissionHandlerTests.cs new file mode 100644 index 000000000..675ea1282 --- /dev/null +++ b/dotnet/test/Unit/PermissionHandlerTests.cs @@ -0,0 +1,127 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +using System.Text.Json; +using System.Text.Json.Serialization.Metadata; +using GitHub.Copilot.Rpc; +using Xunit; + +namespace GitHub.Copilot.Test.Unit; + +public class PermissionHandlerTests +{ + private static readonly JsonSerializerOptions SerializerOptions = new() + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver(), + }; + + [Fact] + public void PermissionEventExposesManagedApprovalRequired() + { + const string json = """ + { + "permissionRequest": { + "kind": "read", + "intention": "Read managed content", + "path": "/workspace/file.txt", + "managedApprovalRequired": true + }, + "requestId": "permission-1" + } + """; + + var data = JsonSerializer.Deserialize( + json, + SerializerOptions); + + Assert.NotNull(data); + var request = Assert.IsType(data.PermissionRequest); + Assert.True(request.ManagedApprovalRequired); + PermissionRequest genericRequest = request; + Assert.True(genericRequest.ManagedApprovalRequired); + } + + [Fact] + public async Task ApproveAllThrowsWhenManagedSettingsEnabled() + { + var request = new PermissionRequest + { + Kind = "read", + ManagedApprovalRequired = true, + }; + + await Assert.ThrowsAsync(() => + PermissionHandler.ApproveAll(request, new PermissionInvocation + { + ManagedSettingsEnabled = true, + })); + } + + [Fact] + public async Task ApproveAllApprovesOrdinaryRequest() + { + var request = new PermissionRequest { Kind = "read" }; + + var decision = await PermissionHandler.ApproveAll(request, new PermissionInvocation()); + + Assert.IsType(decision); + } + + [Fact] + public async Task ApproveAllLeavesManagedRequestPendingWhenSessionFlagIsAbsent() + { + var request = new PermissionRequestRead + { + Intention = "Read managed content", + ManagedApprovalRequired = true, + Path = "/workspace/file.txt", + }; + + var decision = await PermissionHandler.ApproveAll(request, new PermissionInvocation()); + + Assert.IsType(decision); + } + + [Fact] + public async Task ApproveAllLeavesManagedKnownVariantPendingThroughBaseType() + { + PermissionRequest request = new PermissionRequestRead + { + Intention = "Read managed content", + ManagedApprovalRequired = true, + Path = "/workspace/file.txt", + }; + + var decision = await PermissionHandler.ApproveAll(request, new PermissionInvocation()); + + Assert.IsType(decision); + } + + [Fact] + public void DerivedManagedApprovalAccessorForwardsToBaseStorage() + { + var request = new PermissionRequestRead + { + Intention = "Read managed content", + ManagedApprovalRequired = true, + Path = "/workspace/file.txt", + }; + + PermissionRequest genericRequest = request; + Assert.True(genericRequest.ManagedApprovalRequired); + + genericRequest.ManagedApprovalRequired = false; + Assert.False(request.ManagedApprovalRequired); + } + + [Fact] + public async Task ApproveAllLeavesUnknownRequestPending() + { + var request = new PermissionRequest { Kind = "future-managed-kind" }; + + var decision = await PermissionHandler.ApproveAll(request, new PermissionInvocation()); + + Assert.IsType(decision); + } +} diff --git a/dotnet/test/Unit/PublicDtoTests.cs b/dotnet/test/Unit/PublicDtoTests.cs index c81a8a7a6..d1918d2b9 100644 --- a/dotnet/test/Unit/PublicDtoTests.cs +++ b/dotnet/test/Unit/PublicDtoTests.cs @@ -20,6 +20,25 @@ namespace GitHub.Copilot.Test.Unit; /// public class PublicDtoTests { + [Fact] + public void McpAuth_Result_Factories_Represent_Token_And_Cancellation() + { + var token = new McpAuthToken + { + AccessToken = "host-token", + TokenType = "Bearer", + ExpiresIn = 3600, + }; + + var tokenResult = McpAuthResult.FromToken(token); + Assert.Same(token, tokenResult.Token); + Assert.False(tokenResult.Cancelled); + + var cancelled = McpAuthResult.Cancel(); + Assert.True(cancelled.Cancelled); + Assert.Null(cancelled.Token); + } + [Fact] public void Public_Dto_Properties_Can_Be_Set_And_Read() { diff --git a/dotnet/test/Unit/SerializationTests.cs b/dotnet/test/Unit/SerializationTests.cs index b0797d34b..6edf16809 100644 --- a/dotnet/test/Unit/SerializationTests.cs +++ b/dotnet/test/Unit/SerializationTests.cs @@ -3,6 +3,7 @@ *--------------------------------------------------------------------------------------------*/ using Xunit; +using System.Collections.Generic; using System.Text.Json; #if !NET8_0_OR_GREATER using System.Runtime.Serialization; @@ -27,7 +28,8 @@ public void ProviderConfig_CanSerializeHeaders_WithSdkOptions() ModelId = "gpt-4o", WireModel = "my-finetune-v3", MaxPromptTokens = 100_000, - MaxOutputTokens = 4096 + MaxOutputTokens = 4096, + Transport = "websockets" }; var json = JsonSerializer.Serialize(original, options); @@ -39,6 +41,7 @@ public void ProviderConfig_CanSerializeHeaders_WithSdkOptions() Assert.Equal("my-finetune-v3", root.GetProperty("wireModel").GetString()); Assert.Equal(100_000, root.GetProperty("maxPromptTokens").GetInt32()); Assert.Equal(4096, root.GetProperty("maxOutputTokens").GetInt32()); + Assert.Equal("websockets", root.GetProperty("transport").GetString()); var deserialized = JsonSerializer.Deserialize(json, options); Assert.NotNull(deserialized); @@ -48,6 +51,80 @@ public void ProviderConfig_CanSerializeHeaders_WithSdkOptions() Assert.Equal("my-finetune-v3", deserialized.WireModel); Assert.Equal(100_000, deserialized.MaxPromptTokens); Assert.Equal(4096, deserialized.MaxOutputTokens); + Assert.Equal("websockets", deserialized.Transport); + } + + [Fact] + public void CapiSessionOptions_CanSerializeEnableWebSocketResponses_WithSdkOptions() + { + var options = GetSerializerOptions(); + var original = new CapiSessionOptions + { + EnableWebSocketResponses = false + }; + + var json = JsonSerializer.Serialize(original, options); + using var document = JsonDocument.Parse(json); + var root = document.RootElement; + Assert.False(root.GetProperty("enableWebSocketResponses").GetBoolean()); + + var deserialized = JsonSerializer.Deserialize(json, options); + Assert.NotNull(deserialized); + Assert.False(deserialized.EnableWebSocketResponses); + } + + [Fact] + public void ModelBilling_CanSerializeTokenPrices_WithSdkOptions() + { + var options = GetSerializerOptions(); + var original = new ModelBilling + { + Multiplier = 1.5, + TokenPrices = new GitHub.Copilot.Rpc.ModelBillingTokenPrices + { + InputPrice = 2.0, + OutputPrice = 8.0, + CacheReadPrice = 0.5, + CacheWritePrice = 0.75, + BatchSize = 1_000_000L, + MaxPromptTokens = 128_000L, + LongContext = new GitHub.Copilot.Rpc.ModelBillingTokenPricesLongContext + { + InputPrice = 4.0, + OutputPrice = 16.0, + CacheReadPrice = 1.0, + CacheWritePrice = 1.25, + MaxPromptTokens = 1_000_000L + } + } + }; + + var json = JsonSerializer.Serialize(original, options); + using var document = JsonDocument.Parse(json); + var root = document.RootElement; + Assert.Equal(1.5, root.GetProperty("multiplier").GetDouble()); + var tokenPrices = root.GetProperty("tokenPrices"); + Assert.Equal(2.0, tokenPrices.GetProperty("inputPrice").GetDouble()); + Assert.Equal(8.0, tokenPrices.GetProperty("outputPrice").GetDouble()); + Assert.Equal(0.5, tokenPrices.GetProperty("cacheReadPrice").GetDouble()); + Assert.Equal(0.75, tokenPrices.GetProperty("cacheWritePrice").GetDouble()); + Assert.Equal(1_000_000L, tokenPrices.GetProperty("batchSize").GetInt64()); + Assert.Equal(128_000L, tokenPrices.GetProperty("maxPromptTokens").GetInt64()); + var longContext = tokenPrices.GetProperty("longContext"); + Assert.Equal(4.0, longContext.GetProperty("inputPrice").GetDouble()); + Assert.Equal(1.25, longContext.GetProperty("cacheWritePrice").GetDouble()); + Assert.Equal(1_000_000L, longContext.GetProperty("maxPromptTokens").GetInt64()); + + var deserialized = JsonSerializer.Deserialize(json, options); + Assert.NotNull(deserialized); + Assert.Equal(1.5, deserialized.Multiplier); + Assert.NotNull(deserialized.TokenPrices); + Assert.Equal(2.0, deserialized.TokenPrices.InputPrice); + Assert.Equal(1_000_000L, deserialized.TokenPrices.BatchSize); + Assert.Equal(128_000L, deserialized.TokenPrices.MaxPromptTokens); + Assert.NotNull(deserialized.TokenPrices.LongContext); + Assert.Equal(16.0, deserialized.TokenPrices.LongContext.OutputPrice); + Assert.Equal(1_000_000L, deserialized.TokenPrices.LongContext.MaxPromptTokens); } [Fact] @@ -171,6 +248,102 @@ public void ResumeSessionRequest_CanSerializeInstructionDirectories_WithSdkOptio Assert.Equal("C:\\resume-instructions", root.GetProperty("instructionDirectories")[0].GetString()); } + [Fact] + public void SessionRequests_CanSerializeCapiOptions_WithSdkOptions() + { + var options = GetSerializerOptions(); + var capi = new CapiSessionOptions { EnableWebSocketResponses = false }; + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id"), + ("Capi", capi)); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + Assert.False(createDocument.RootElement.GetProperty("capi").GetProperty("enableWebSocketResponses").GetBoolean()); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("Capi", capi)); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + Assert.False(resumeDocument.RootElement.GetProperty("capi").GetProperty("enableWebSocketResponses").GetBoolean()); + } + + [Fact] + public void SessionRequests_OmitCapiOptions_WhenUnset() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id")); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + Assert.False(createDocument.RootElement.TryGetProperty("capi", out _)); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id")); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + Assert.False(resumeDocument.RootElement.TryGetProperty("capi", out _)); + } + + [Fact] + public void SessionRequests_CanSerializeGitHubMcpToolConfig_WithSdkOptions() + { + var options = GetSerializerOptions(); + var githubConfig = new GitHubMcpToolConfig + { + EnableAllTools = true, + AdditionalToolsets = ["repos"], + AdditionalTools = ["get_issue"], + EnableInsidersMode = true, + DisableFormDeferral = true, + }; + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("GitHubMcpToolConfig", githubConfig)); + using var createDocument = JsonDocument.Parse(JsonSerializer.Serialize(createRequest, createRequestType, options)); + var createConfig = createDocument.RootElement.GetProperty("githubMcpToolConfig"); + Assert.True(createConfig.GetProperty("enableAllTools").GetBoolean()); + Assert.Equal("repos", createConfig.GetProperty("additionalToolsets")[0].GetString()); + Assert.True(createConfig.GetProperty("disableFormDeferral").GetBoolean()); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("GitHubMcpToolConfig", githubConfig)); + using var resumeDocument = JsonDocument.Parse(JsonSerializer.Serialize(resumeRequest, resumeRequestType, options)); + Assert.True(resumeDocument.RootElement.TryGetProperty("githubMcpToolConfig", out _)); + } + + [Fact] + public void SessionRequests_OmitGitHubMcpToolConfig_WhenUnset() + { + var options = GetSerializerOptions(); + foreach (var requestName in new[] { "CreateSessionRequest", "ResumeSessionRequest" }) + { + var requestType = GetNestedType(typeof(CopilotClient), requestName); + var request = CreateInternalRequest(requestType, ("SessionId", "session-id")); + using var document = JsonDocument.Parse(JsonSerializer.Serialize(request, requestType, options)); + Assert.False(document.RootElement.TryGetProperty("githubMcpToolConfig", out _)); + } + } + [Fact] public void SessionRequests_CanSerializeReasoningSummary_WithSdkOptions() { @@ -238,12 +411,14 @@ public void SessionRequests_CanSerializePluginDirectoriesAndLargeOutput_WithSdkO createRequestType, ("SessionId", "session-id"), ("PluginDirectories", pluginDirs), + ("DisabledMcpServers", new List { "local-files", "remote-github" }), ("LargeOutput", largeOutput)); var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); using var createDocument = JsonDocument.Parse(createJson); var createRoot = createDocument.RootElement; Assert.Equal("/tmp/plugins/a", createRoot.GetProperty("pluginDirectories")[0].GetString()); + Assert.Equal("local-files", createRoot.GetProperty("disabledMcpServers")[0].GetString()); Assert.Equal("/tmp/plugins/b", createRoot.GetProperty("pluginDirectories")[1].GetString()); var createLargeOutput = createRoot.GetProperty("largeOutput"); Assert.True(createLargeOutput.GetProperty("enabled").GetBoolean()); @@ -255,18 +430,206 @@ public void SessionRequests_CanSerializePluginDirectoriesAndLargeOutput_WithSdkO resumeRequestType, ("SessionId", "session-id"), ("PluginDirectories", pluginDirs), + ("DisabledMcpServers", new List { "local-files", "remote-github" }), ("LargeOutput", largeOutput)); var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); using var resumeDocument = JsonDocument.Parse(resumeJson); var resumeRoot = resumeDocument.RootElement; Assert.Equal("/tmp/plugins/a", resumeRoot.GetProperty("pluginDirectories")[0].GetString()); + Assert.Equal("local-files", resumeRoot.GetProperty("disabledMcpServers")[0].GetString()); var resumeLargeOutput = resumeRoot.GetProperty("largeOutput"); Assert.True(resumeLargeOutput.GetProperty("enabled").GetBoolean()); Assert.Equal(1024, resumeLargeOutput.GetProperty("maxSizeBytes").GetInt64()); Assert.Equal("/tmp/large-output", resumeLargeOutput.GetProperty("outputDir").GetString()); } + [Fact] + public void SessionRequests_CanSerializeMemory_WithSdkOptions() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id"), + ("Memory", new MemoryConfiguration { Enabled = true })); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + var createRoot = createDocument.RootElement; + Assert.True(createRoot.GetProperty("memory").GetProperty("enabled").GetBoolean()); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("Memory", new MemoryConfiguration { Enabled = false })); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + var resumeRoot = resumeDocument.RootElement; + Assert.False(resumeRoot.GetProperty("memory").GetProperty("enabled").GetBoolean()); + } + + [Fact] + public void SessionRequests_CanSerializeCitationAgentExclusionAndLimits_WithSdkOptions() + { + var options = GetSerializerOptions(); + var excludedAgents = new List { "explore", "task" }; + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id"), + ("EnableCitations", true), + ("EnableFileChangeTracking", true), + ("ExcludedBuiltInAgents", excludedAgents), + ("SessionLimits", new SessionLimitsConfig { MaxAiCredits = 12.5 })); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + var createRoot = createDocument.RootElement; + Assert.True(createRoot.GetProperty("enableCitations").GetBoolean()); + Assert.True(createRoot.GetProperty("enableFileChangeTracking").GetBoolean()); + Assert.Equal("explore", createRoot.GetProperty("excludedBuiltinAgents")[0].GetString()); + Assert.Equal(12.5, createRoot.GetProperty("sessionLimits").GetProperty("maxAiCredits").GetDouble()); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("EnableCitations", true), + ("EnableFileChangeTracking", true), + ("ExcludedBuiltInAgents", excludedAgents), + ("SessionLimits", new SessionLimitsConfig { MaxAiCredits = 7.25 })); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + var resumeRoot = resumeDocument.RootElement; + Assert.True(resumeRoot.GetProperty("enableCitations").GetBoolean()); + Assert.True(resumeRoot.GetProperty("enableFileChangeTracking").GetBoolean()); + Assert.Equal("task", resumeRoot.GetProperty("excludedBuiltinAgents")[1].GetString()); + Assert.Equal(7.25, resumeRoot.GetProperty("sessionLimits").GetProperty("maxAiCredits").GetDouble()); + } + + [Fact] + public void SessionRequests_OmitMemory_WhenUnset() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id")); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + Assert.False(createDocument.RootElement.TryGetProperty("memory", out _)); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id")); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + Assert.False(resumeDocument.RootElement.TryGetProperty("memory", out _)); + } + + [Fact] + public void SessionRequests_CanSerializeExpAssignments_WithSdkOptions() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id"), + ("ExpAssignments", new CopilotExpAssignmentResponse + { + Configs = new List { new() { Id = "exp-create" } }, + })); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + var createRoot = createDocument.RootElement; + Assert.Equal("exp-create", createRoot.GetProperty("expAssignments").GetProperty("Configs")[0].GetProperty("Id").GetString()); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("ExpAssignments", new CopilotExpAssignmentResponse + { + Configs = new List { new() { Id = "exp-resume" } }, + })); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + var resumeRoot = resumeDocument.RootElement; + Assert.Equal("exp-resume", resumeRoot.GetProperty("expAssignments").GetProperty("Configs")[0].GetProperty("Id").GetString()); + } + + [Fact] + public void SessionRequests_OmitExpAssignments_WhenUnset() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id")); + + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + Assert.False(createDocument.RootElement.TryGetProperty("expAssignments", out _)); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id")); + + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + Assert.False(resumeDocument.RootElement.TryGetProperty("expAssignments", out _)); + } + + [Fact] + public void SessionConfigClone_PreservesExpAssignments() + { + var config = new SessionConfig + { + SessionId = "session-id", + ExpAssignments = new CopilotExpAssignmentResponse + { + Configs = new List { new() { Id = "exp-create" } }, + }, + }; + + var clone = config.Clone(); + + Assert.NotNull(clone.ExpAssignments); + Assert.Equal("exp-create", clone.ExpAssignments!.Configs[0].Id); + } + + [Fact] + public void ResumeSessionConfigClone_PreservesExpAssignments() + { + var config = new ResumeSessionConfig + { + ExpAssignments = new CopilotExpAssignmentResponse + { + Configs = new List { new() { Id = "exp-resume" } }, + }, + }; + + var clone = config.Clone(); + + Assert.NotNull(clone.ExpAssignments); + Assert.Equal("exp-resume", clone.ExpAssignments!.Configs[0].Id); + } + [Fact] public void CreateSessionRequest_CanSerializeEnableSessionTelemetry_WithSdkOptions() { @@ -283,6 +646,58 @@ public void CreateSessionRequest_CanSerializeEnableSessionTelemetry_WithSdkOptio Assert.False(root.GetProperty("enableSessionTelemetry").GetBoolean()); } + [Fact] + public void CreateSessionRequest_CanSerializeCustomAgentsLocalOnly_WithSdkOptions() + { + var options = GetSerializerOptions(); + var requestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var request = CreateInternalRequest( + requestType, + ("SessionId", "session-id"), + ("CustomAgentsLocalOnly", true)); + + var json = JsonSerializer.Serialize(request, requestType, options); + using var document = JsonDocument.Parse(json); + Assert.True(document.RootElement.GetProperty("customAgentsLocalOnly").GetBoolean()); + } + + [Fact] + public void ResumeSessionRequest_CanSerializeCustomAgentsLocalOnly_WithSdkOptions() + { + var options = GetSerializerOptions(); + var requestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var request = CreateInternalRequest( + requestType, + ("SessionId", "session-id"), + ("CustomAgentsLocalOnly", true)); + + var json = JsonSerializer.Serialize(request, requestType, options); + using var document = JsonDocument.Parse(json); + Assert.True(document.RootElement.GetProperty("customAgentsLocalOnly").GetBoolean()); + } + + [Fact] + public void SessionRequests_OmitCustomAgentsLocalOnly_WhenUnset() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id")); + var createJson = JsonSerializer.Serialize(createRequest, createRequestType, options); + using var createDocument = JsonDocument.Parse(createJson); + Assert.False(createDocument.RootElement.TryGetProperty("customAgentsLocalOnly", out _)); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id")); + var resumeJson = JsonSerializer.Serialize(resumeRequest, resumeRequestType, options); + using var resumeDocument = JsonDocument.Parse(resumeJson); + Assert.False(resumeDocument.RootElement.TryGetProperty("customAgentsLocalOnly", out _)); + } + [Fact] public void ResumeSessionRequest_CanSerializeEnableSessionTelemetry_WithSdkOptions() { @@ -299,6 +714,40 @@ public void ResumeSessionRequest_CanSerializeEnableSessionTelemetry_WithSdkOptio Assert.False(root.GetProperty("enableSessionTelemetry").GetBoolean()); } + [Fact] + public void SessionRequests_CanSerializeEnableExperimentalMode_WithSdkOptions() + { + var options = GetSerializerOptions(); + + var createRequestType = GetNestedType(typeof(CopilotClient), "CreateSessionRequest"); + var createRequest = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id"), + ("IsExperimentalMode", false)); + var createRoot = JsonDocument.Parse(JsonSerializer.Serialize(createRequest, createRequestType, options)).RootElement; + Assert.False(createRoot.GetProperty("isExperimentalMode").GetBoolean()); + + var createRequestOmitted = CreateInternalRequest( + createRequestType, + ("SessionId", "session-id")); + var createOmittedRoot = JsonDocument.Parse(JsonSerializer.Serialize(createRequestOmitted, createRequestType, options)).RootElement; + Assert.False(createOmittedRoot.TryGetProperty("isExperimentalMode", out _)); + + var resumeRequestType = GetNestedType(typeof(CopilotClient), "ResumeSessionRequest"); + var resumeRequest = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id"), + ("IsExperimentalMode", true)); + var resumeRoot = JsonDocument.Parse(JsonSerializer.Serialize(resumeRequest, resumeRequestType, options)).RootElement; + Assert.True(resumeRoot.GetProperty("isExperimentalMode").GetBoolean()); + + var resumeRequestOmitted = CreateInternalRequest( + resumeRequestType, + ("SessionId", "session-id")); + var resumeOmittedRoot = JsonDocument.Parse(JsonSerializer.Serialize(resumeRequestOmitted, resumeRequestType, options)).RootElement; + Assert.False(resumeOmittedRoot.TryGetProperty("isExperimentalMode", out _)); + } + [Fact] public void CreateSessionRequest_CanSerializeEnableOnDemandInstructionDiscovery_WithSdkOptions() { @@ -365,7 +814,6 @@ public void ResumeSessionRequest_CanSerializeOpenCanvases_WithSdkOptions() CanvasId = "canvas-id", ExtensionId = "ext-id", InstanceId = "instance-1", - Availability = CanvasInstanceAvailability.Ready, }, }; var request = CreateInternalRequest( @@ -481,6 +929,48 @@ public void PermissionDecision_SerializesBaseDiscriminator_WithSdkOptions() Assert.Equal("approve-once", document.RootElement.GetProperty("kind").GetString()); } + [Fact] + public void AgentStopHookInput_DeserializesWireFields_WithSdkOptions() + { + var options = GetSerializerOptions(); + var input = JsonSerializer.Deserialize( + """ + { + "sessionId": "session-1", + "timestamp": 1700000000000, + "cwd": "/repo", + "stopReason": "end_turn", + "transcriptPath": "/tmp/transcript.jsonl", + "stop_hook_active": true + } + """, + options); + + Assert.NotNull(input); + Assert.Equal("session-1", input.SessionId); + Assert.Equal("/repo", input.WorkingDirectory); + Assert.Equal("end_turn", input.StopReason); + Assert.Equal("/tmp/transcript.jsonl", input.TranscriptPath); + Assert.True(input.StopHookActive); + Assert.Equal(DateTimeOffset.FromUnixTimeMilliseconds(1700000000000), input.Timestamp); + } + + [Fact] + public void AgentStopHookOutput_SerializesBlockDecision_WithSdkOptions() + { + var options = GetSerializerOptions(); + var output = new AgentStopHookOutput + { + Decision = "block", + Reason = "finish the remaining work" + }; + + var json = JsonSerializer.SerializeToElement(output, options); + + Assert.Equal("block", json.GetProperty("decision").GetString()); + Assert.Equal("finish the remaining work", json.GetProperty("reason").GetString()); + } + [Fact] public void HooksInvokeResponse_SerializesPreMcpToolCallHookOutput_WithMetaToUse() { @@ -550,6 +1040,48 @@ public void HooksInvokeResponse_SerializesNullOutput_AsEmptyOrNoOutputProperty() // else: property omitted, which is fine (runtime treats undefined output as no-op) } + [Fact] + public void ToolResultObject_SerializesToolReferences_WithSdkOptions() + { + var options = GetSerializerOptions(); + var original = new ToolResultObject + { + TextResultForLlm = "found 2 tools", + ResultType = "success", + ToolReferences = ["get_weather", "check_status"], + }; + + var json = JsonSerializer.Serialize(original, options); + using var document = JsonDocument.Parse(json); + var root = document.RootElement; + Assert.Equal("found 2 tools", root.GetProperty("textResultForLlm").GetString()); + var refs = root.GetProperty("toolReferences"); + Assert.Equal(JsonValueKind.Array, refs.ValueKind); + Assert.Equal(2, refs.GetArrayLength()); + Assert.Equal("get_weather", refs[0].GetString()); + Assert.Equal("check_status", refs[1].GetString()); + + var deserialized = JsonSerializer.Deserialize(json, options); + Assert.NotNull(deserialized); + string[] expectedReferences = ["get_weather", "check_status"]; + Assert.Equal(expectedReferences, deserialized!.ToolReferences); + } + + [Fact] + public void ToolResultObject_OmitsToolReferences_WhenNull_WithSdkOptions() + { + var options = GetSerializerOptions(); + var original = new ToolResultObject + { + TextResultForLlm = "ok", + ResultType = "success", + }; + + var json = JsonSerializer.Serialize(original, options); + using var document = JsonDocument.Parse(json); + Assert.False(document.RootElement.TryGetProperty("toolReferences", out _)); + } + private static JsonSerializerOptions GetSerializerOptions() { var prop = typeof(CopilotClient) diff --git a/dotnet/test/Unit/SessionEventSerializationTests.cs b/dotnet/test/Unit/SessionEventSerializationTests.cs index 47b4ac3f7..326ac3f3c 100644 --- a/dotnet/test/Unit/SessionEventSerializationTests.cs +++ b/dotnet/test/Unit/SessionEventSerializationTests.cs @@ -150,14 +150,21 @@ public class SessionEventSerializationTests Data = new McpOauthRequiredData { RequestId = "oauth-request", + Reason = McpOauthRequestReason.Initial, ServerName = "oauth-server", ServerUrl = "https://example.com/mcp", StaticClientConfig = new McpOauthRequiredStaticClientConfig { ClientId = "client-id", + ClientSecret = "static-secret", GrantType = "client_credentials", PublicClient = false, }, + WwwAuthenticateParams = new McpOauthWWWAuthenticateParams + { + ResourceMetadataUrl = "https://example.com/.well-known/oauth-protected-resource", + }, + ResourceMetadata = """{"resource":"https://example.com/mcp"}""", }, }, "mcp.oauth_required" @@ -281,6 +288,17 @@ public void SessionEvent_ToJson_RoundTrips_JsonElementBackedPayloads(SessionEven .GetProperty("staticClientConfig") .GetProperty("grantType") .GetString()); + Assert.Equal( + "static-secret", + root.GetProperty("data") + .GetProperty("staticClientConfig") + .GetProperty("clientSecret") + .GetString()); + Assert.Equal( + """{"resource":"https://example.com/mcp"}""", + root.GetProperty("data") + .GetProperty("resourceMetadata") + .GetString()); break; case "assistant.message_start": @@ -297,4 +315,118 @@ public void SessionEvent_ToJson_RoundTrips_JsonElementBackedPayloads(SessionEven break; } } + + [Fact] + public void McpOauthRequiredData_Allows_Missing_Optional_Metadata() + { + const string json = """ + { + "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "timestamp": "2026-03-15T21:26:54.987Z", + "parentId": null, + "type": "mcp.oauth_required", + "data": { + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp" + } + } + """; + + var authEvent = Assert.IsType(SessionEvent.FromJson(json)); + Assert.Null(authEvent.Data.WwwAuthenticateParams); + Assert.Null(authEvent.Data.ResourceMetadata); + } + + [Fact] + public void McpOauthRequiredData_Preserves_Static_Client_Secret() + { + const string json = """ + { + "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "timestamp": "2026-03-15T21:26:54.987Z", + "parentId": null, + "type": "mcp.oauth_required", + "data": { + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp", + "staticClientConfig": { + "clientId": "static-client", + "clientSecret": "static-secret", + "grantType": "client_credentials", + "publicClient": false + } + } + } + """; + + var authEvent = Assert.IsType(SessionEvent.FromJson(json)); + + Assert.NotNull(authEvent.Data.StaticClientConfig); + Assert.Equal("static-secret", authEvent.Data.StaticClientConfig.ClientSecret); + } + + [Fact] + public void ManagedSettingsResolvedData_Preserves_Client_Provenance() + { + Assert.Equal("server", ManagedSettingsResolvedSource.Server.Value); + Assert.Equal("device", ManagedSettingsResolvedSource.Device.Value); + Assert.Equal("client", ManagedSettingsResolvedSource.Client.Value); + Assert.Equal("mixed", ManagedSettingsResolvedSource.Mixed.Value); + Assert.Equal("none", ManagedSettingsResolvedSource.None.Value); + + const string clientJson = """ + { + "id": "11111111-1111-1111-1111-111111111111", + "timestamp": "2026-03-15T21:26:54.987Z", + "parentId": null, + "type": "session.managed_settings_resolved", + "data": { + "source": "client", + "serverManaged": false, + "deviceManaged": false, + "clientManaged": true, + "failClosed": false, + "bypassPermissionsDisabled": true, + "managedKeys": ["permissions"] + } + } + """; + + var clientEvent = Assert.IsType( + SessionEvent.FromJson(clientJson)); + Assert.Equal(ManagedSettingsResolvedSource.Client, clientEvent.Data.Source); + Assert.True(clientEvent.Data.ClientManaged); + using (var document = JsonDocument.Parse(clientEvent.ToJson())) + { + Assert.True(document.RootElement.GetProperty("data").GetProperty("clientManaged").GetBoolean()); + } + + const string mixedJson = """ + { + "id": "22222222-2222-2222-2222-222222222222", + "timestamp": "2026-03-15T21:26:54.987Z", + "parentId": null, + "type": "session.managed_settings_resolved", + "data": { + "source": "mixed", + "serverManaged": true, + "deviceManaged": true, + "failClosed": false, + "bypassPermissionsDisabled": true, + "managedKeys": ["permissions"] + } + } + """; + + var mixedEvent = Assert.IsType( + SessionEvent.FromJson(mixedJson)); + Assert.Equal(ManagedSettingsResolvedSource.Mixed, mixedEvent.Data.Source); + Assert.Null(mixedEvent.Data.ClientManaged); + using var mixedDocument = JsonDocument.Parse(mixedEvent.ToJson()); + Assert.False(mixedDocument.RootElement.GetProperty("data").TryGetProperty("clientManaged", out _)); + } } diff --git a/dotnet/test/Unit/TelemetryTests.cs b/dotnet/test/Unit/TelemetryTests.cs index 9229285b9..979e575b3 100644 --- a/dotnet/test/Unit/TelemetryTests.cs +++ b/dotnet/test/Unit/TelemetryTests.cs @@ -16,6 +16,7 @@ public void TelemetryConfig_DefaultValues_AreNull() var config = new TelemetryConfig(); Assert.Null(config.OtlpEndpoint); + Assert.Null(config.OtlpProtocol); Assert.Null(config.FilePath); Assert.Null(config.ExporterType); Assert.Null(config.SourceName); @@ -28,6 +29,7 @@ public void TelemetryConfig_CanSetAllProperties() var config = new TelemetryConfig { OtlpEndpoint = "http://localhost:4318", + OtlpProtocol = "http/protobuf", FilePath = "/tmp/traces.json", ExporterType = "otlp-http", SourceName = "my-app", @@ -35,6 +37,7 @@ public void TelemetryConfig_CanSetAllProperties() }; Assert.Equal("http://localhost:4318", config.OtlpEndpoint); + Assert.Equal("http/protobuf", config.OtlpProtocol); Assert.Equal("/tmp/traces.json", config.FilePath); Assert.Equal("otlp-http", config.ExporterType); Assert.Equal("my-app", config.SourceName); diff --git a/go/README.md b/go/README.md index 568d75f9d..d8588699c 100644 --- a/go/README.md +++ b/go/README.md @@ -2,7 +2,12 @@ A Go SDK for programmatic access to the GitHub Copilot CLI. -> **Note:** This SDK is in public preview and may change in breaking ways. +## Prerequisites + +To use the SDK, you'll need: + +- Go 1.24 or later +- GitHub Copilot CLI installed and in `PATH` (or set `COPILOT_CLI_PATH`) ## Installation @@ -50,7 +55,6 @@ func main() { } defer client.Stop() - // Create a session (OnPermissionRequest is optional; ApproveAll allows every tool) session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{ Model: "gpt-5", OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -84,6 +88,12 @@ func main() { } ``` +When targeting MCP tools configured through `MCPServers`, remember the runtime +tool name is `-`. For `AvailableTools` and +`ExcludedTools`, prefer the source-qualified form +`mcp:-`. For `CustomAgents[].Tools` and +`DefaultAgent.ExcludedTools`, use `-` directly. + ## Distributing your application with an embedded GitHub Copilot CLI The SDK supports bundling, using Go's `embed` package, the Copilot CLI binary within your application's distribution. @@ -96,6 +106,49 @@ Follow these steps to embed the CLI: That's it! When your application calls `copilot.NewClient` without a `Connection` field (or with an empty `StdioConnection{}`) and no `COPILOT_CLI_PATH` environment variable, the SDK will automatically install the embedded CLI to a cache directory and use it for all operations. +The bundler prepares the native runtime library required by the [in-process transport](#in-process-transport-experimental). It is included in the application only when building with the `copilot_inprocess` build tag. + +## In-process transport (Experimental) + +> **Experimental:** the in-process API may change in a future release. + +By default the SDK starts the runtime as a child process and talks JSON-RPC over stdio or TCP. The **in-process** transport instead loads a native runtime library directly into your process. + +Build your application with the `copilot_inprocess` build tag: + +```sh +go build -tags copilot_inprocess +``` + +```go +client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.InProcessConnection{}, +}) +if err := client.Start(context.Background()); err != nil { + log.Fatal(err) +} +defer client.Stop() +``` + +Resolution and requirements: + +- The application must be built with the `copilot_inprocess` build tag. +- Set `COPILOT_SDK_DEFAULT_CONNECTION=inprocess` to select the in-process + transport when `ClientOptions.Connection` is nil. An explicit connection + always takes precedence. +- Set `COPILOT_CLI_PATH` only when using an externally provisioned compatible runtime package; otherwise the bundled runtime is used. No `PATH` lookup is performed. +- Embedded runtime versions are isolated in separate cache directories. Start fails loudly if the native runtime is unavailable. +- Linux in-process bundles include both glibc and musl runtime packages and select the matching package automatically at startup. +- Only one native runtime version may be loaded per process. + +The in-process transport rejects options that cannot be honored by a runtime hosted in your shared process (each panics at `NewClient`): + +- `Env` — the host process has a single environment block. Set variables on the host process environment instead. +- `WorkingDirectory` — the runtime shares the host process's working directory. Change the process working directory before creating the client. +- `Telemetry` — per-client telemetry is lowered to native-runtime environment variables. Use a child-process transport for per-client telemetry. + +Implemented with pure-Go FFI (via [purego](https://github.com/ebitengine/purego)), so `CGO_ENABLED=0` and cross-compilation are preserved; no C toolchain is required. + ## API Reference ### Client @@ -104,13 +157,13 @@ That's it! When your application calls `copilot.NewClient` without a `Connection - `Start(ctx context.Context) error` - Start the CLI server - `Stop() error` - Stop the CLI server - `ForceStop()` - Forcefully stop without graceful cleanup -- `CreateSession(config *SessionConfig) (*Session, error)` - Create a new session -- `ResumeSession(sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume an existing session -- `ResumeSessionWithOptions(sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume with additional configuration -- `ListSessions(filter *SessionListFilter) ([]SessionMetadata, error)` - List sessions (with optional filter) -- `DeleteSession(sessionID string) error` - Delete a session permanently +- `CreateSession(ctx context.Context, config *SessionConfig) (*Session, error)` - Create a new session +- `ResumeSession(ctx context.Context, sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume an existing session +- `ResumeSessionWithOptions(ctx context.Context, sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume with additional configuration +- `ListSessions(ctx context.Context, filter *SessionListFilter) ([]SessionMetadata, error)` - List sessions (with optional filter) +- `DeleteSession(ctx context.Context, sessionID string) error` - Delete a session permanently - `GetLastSessionID(ctx context.Context) (*string, error)` - Get the ID of the most recently updated session -- `Ping(message string) (*PingResponse, error)` - Ping the server +- `Ping(ctx context.Context, message string) (*PingResponse, error)` - Ping the server - `RuntimePort() int` - TCP port the runtime is listening on (0 if stdio) - `GetForegroundSessionID(ctx context.Context) (*string, error)` - Get the session ID currently displayed in TUI (TUI+server mode only) - `SetForegroundSessionID(ctx context.Context, sessionID string) error` - Request TUI to display a specific session (TUI+server mode only) @@ -137,34 +190,39 @@ Event types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifec **ClientOptions:** - `Connection` (RuntimeConnection): How the SDK connects to the runtime. Construct via one of: - - `StdioConnection{Path, Args}` — spawn a runtime over stdio (the default if `Connection` is nil) - - `TcpConnection{Port, ConnectionToken, Path, Args}` — spawn a runtime that listens on TCP - - `UriConnection{URL, ConnectionToken}` — connect to an already-running runtime (no process spawned) + - `StdioConnection{Path, Args, Env}` — spawn a runtime over stdio (the default if `Connection` is nil) + - `TCPConnection{Port, ConnectionToken, Path, Args, Env}` — spawn a runtime that listens on TCP + - `URIConnection{URL, ConnectionToken}` — connect to an already-running runtime (no process spawned) + - `InProcessConnection{}` — **Experimental.** Host the runtime in-process via the native FFI library instead of spawning a child process. See [In-process transport](#in-process-transport-experimental) below. When `Path` is empty for stdio/tcp, the SDK uses the bundled CLI (or `COPILOT_CLI_PATH` env var). -- `WorkingDirectory` (string): Working directory for the runtime process -- `BaseDirectory` (string): Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime. When empty, the runtime defaults to `~/.copilot`. Ignored with `UriConnection`. This does **not** affect where the Go SDK extracts the embedded CLI binary; use `embeddedcli.Config.Dir` for the extraction/cache location. + + `StdioConnection` and `TCPConnection` accept an optional connection-level `Env`. Set environment variables via **either** the client-level `Env` option or the connection's `Env`, not both (setting both panics); prefer the connection-level `Env`. +- `WorkingDirectory` (string): Working directory for the runtime process (default: current process working directory) +- `BaseDirectory` (string): Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime. When empty, the runtime defaults to `~/.copilot`. Ignored with `URIConnection`. This does **not** affect where the Go SDK extracts the embedded CLI binary; use `embeddedcli.Config.Dir` for the extraction/cache location. - `LogLevel` (string): Log level. When empty (default), the runtime uses its own default level (the SDK does not pass `--log-level`). - `Env` ([]string): Environment variables for the runtime process (default: inherits from current process) - `GitHubToken` (string): GitHub token for authentication. When provided, takes priority over other auth methods. -- `UseLoggedInUser` (\*bool): Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `UriConnection`. -- `EnableRemoteSessions` (bool): Enable remote session support (Mission Control integration). Ignored with `UriConnection`. +- `UseLoggedInUser` (\*bool): Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `URIConnection`. +- `EnableRemoteSessions` (bool): Enable remote session support (Mission Control integration). Ignored with `URIConnection`. - `Telemetry` (\*TelemetryConfig): OpenTelemetry configuration for the runtime. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below. **SessionConfig:** - `Model` (string): Model to use ("gpt-5", "claude-sonnet-4.5", etc.). **Required when using custom provider.** -- `ReasoningEffort` (string): Reasoning effort level for models that support it ("low", "medium", "high", "xhigh"). Use `ListModels()` to check which models support this option. +- `ReasoningEffort` (string): Reasoning effort level for models that support it ("low", "medium", "high", "xhigh", "max"). Use `ListModels()` to check which models support this option. - `SessionID` (string): Custom session ID - `Tools` ([]Tool): Custom tools exposed to the CLI - `SystemMessage` (\*SystemMessageConfig): System message configuration. Supports three modes: - **append** (default): Appends `Content` after the SDK-managed prompt - **replace**: Replaces the entire prompt with `Content` - - **customize**: Selectively override individual sections via `Sections` map (keys: `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionRuntimeInstructions`, `SectionLastInstructions`; values: `SectionOverride` with `Action` and optional `Content`) + - **customize**: Selectively override individual sections via `Sections` map (keys: `SectionPreamble`, `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionRuntimeInstructions`, `SectionLastInstructions`; values: `SectionOverride` with `Action` and optional `Content`) - `Provider` (\*ProviderConfig): Custom API provider configuration (BYOK). See [Custom Providers](#custom-providers) section. - `Streaming` (*bool): Enable streaming delta events (nil = runtime default) - `InfiniteSessions` (\*InfiniteSessionConfig): Automatic context compaction configuration -- `OnPermissionRequest` (PermissionHandlerFunc): Optional handler called before each tool execution to approve or deny it. When nil, permission requests are emitted as events and left pending for manual resolution. Use `copilot.PermissionHandler.ApproveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section. +- `WorkingDirectory` (string): Working directory for the session (default: runtime process working directory) +- `EnableSessionStore` (\*bool): Enables the cross-session store for search and retrieval across sessions. When unset in `ModeCopilotCli`, the runtime default applies (enabled). In `ModeEmpty`, defaults to disabled. +- `OnPermissionRequest` (PermissionHandlerFunc): Optional handler called before each tool execution to approve or deny it. When nil, permission requests are emitted as events and left pending for manual resolution. `copilot.PermissionHandler.ApproveAll` approves requests when managed settings are disabled and returns an error when `EnableManagedSettings` is true. Custom handlers can inspect `RequiresManagedApproval()` for human-facing confirmation logic. See [Permission Handling](#permission-handling) section. - `OnUserInputRequest` (UserInputHandler): Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section. - `Hooks` (\*SessionHooks): Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section. - `Commands` ([]CommandDefinition): Slash-commands registered for this session. See [Commands](#commands) section. @@ -233,14 +291,17 @@ session, err := client.CreateSession(ctx, &copilot.SessionConfig{ }) ``` -Available section constants: `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionRuntimeInstructions`, `SectionLastInstructions`. +Available section constants: `SectionPreamble`, `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionRuntimeInstructions`, `SectionLastInstructions`. + +`SectionIdentity` and `SectionToolInstructions` are section _groups_ that target a collection of related sub-sections as a unit. Use `SectionPreamble` to target just the identity preamble without affecting its sibling sub-sections. -Each section override supports four actions: +Each section override supports five actions: - **`replace`** — Replace the section content entirely - **`remove`** — Remove the section from the prompt - **`append`** — Add content after the existing section - **`prepend`** — Add content before the existing section +- **`preserve`** — No-op that opts an individually-addressable section out of a group-level `remove` Unknown section IDs are handled gracefully: content from `replace`/`append`/`prepend` overrides is appended to additional instructions, and `remove` overrides are silently ignored. @@ -253,7 +314,7 @@ The SDK supports image attachments via the `Attachments` field in `MessageOption _, err = session.Send(context.Background(), copilot.MessageOptions{ Prompt: "What's in this image?", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentFile{ + &copilot.AttachmentFile{ DisplayName: "image.jpg", Path: "/path/to/image.jpg", }, @@ -265,7 +326,7 @@ mimeType := "image/png" _, err = session.Send(context.Background(), copilot.MessageOptions{ Prompt: "What's in this image?", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentBlob{ + &copilot.AttachmentBlob{ Data: base64ImageData, MIMEType: mimeType, }, @@ -374,6 +435,18 @@ safeLookup := copilot.DefineTool("safe_lookup", "A read-only lookup that needs n safeLookup.SkipPermission = true ``` +#### Deferring Tools + +Set `Defer` to control whether a tool may be loaded lazily via tool search rather than always pre-loaded. Use `copilot.ToolDeferAuto` to allow the tool to be deferred and surfaced through tool search, or `copilot.ToolDeferNever` to force it to always be pre-loaded. Defaults to `copilot.ToolDeferAuto`. + +```go +lookupIssue := copilot.DefineTool("lookup_issue", "Fetch issue details", + func(params LookupParams, inv copilot.ToolInvocation) (any, error) { + // your logic + }) +lookupIssue.Defer = copilot.ToolDeferAuto +``` + ## Streaming Enable streaming to receive assistant response chunks as they're generated: @@ -487,6 +560,33 @@ When enabled, sessions emit compaction events: - `session.compaction_start` - Background compaction started - `session.compaction_complete` - Compaction finished (includes token counts) +## Memory + +Sessions can opt in to the memory feature, which lets the agent persist and recall +information across turns. Provide a `MemoryConfiguration` on session create or resume; +when omitted, the runtime default applies. In the default `ModeCopilotCli` client mode the +SDK leaves `Memory` unset so the runtime applies its own default, while `ModeEmpty` +defaults `Memory` to disabled unless you set it explicitly. +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```go +// Enable memory for a session +session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{ + Model: "gpt-5", + Memory: &copilot.MemoryConfiguration{ + Enabled: true, + }, +}) + +// Disable memory for a session +session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{ + Model: "gpt-5", + Memory: &copilot.MemoryConfiguration{ + Enabled: false, + }, +}) +``` + ## Custom Providers The 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. @@ -497,8 +597,8 @@ The SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own K - `BaseURL` (string): API endpoint URL (required) - `APIKey` (string): API key (optional for local providers like Ollama) - `BearerToken` (string): Bearer token for authentication (takes precedence over APIKey) -- `WireApi` (string): API format for OpenAI/Azure - "completions" or "responses" (default: "completions") -- `Azure.APIVersion` (string): Azure API version (default: "2024-10-21") +- `WireAPI` (string): API format for OpenAI/Azure - "completions" or "responses" (default: "completions") +- `Azure.APIVersion` (string): Azure API version; when empty, the runtime uses the GA versionless `v1` route **Example with Ollama:** @@ -553,7 +653,7 @@ session, err := client.CreateSession(context.Background(), &copilot.SessionConfi The SDK supports OpenTelemetry for distributed tracing. Provide a `Telemetry` config to enable trace export and automatic W3C Trace Context propagation. ```go -client, err := copilot.NewClient(copilot.ClientOptions{ +client := copilot.NewClient(&copilot.ClientOptions{ Telemetry: &copilot.TelemetryConfig{ OTLPEndpoint: "http://localhost:4318", }, @@ -563,6 +663,7 @@ client, err := copilot.NewClient(copilot.ClientOptions{ **TelemetryConfig fields:** - `OTLPEndpoint` (string): OTLP HTTP endpoint URL +- `OTLPProtocol` (string): OTLP HTTP protocol for all signals (`"http/json"` or `"http/protobuf"`) - `FilePath` (string): File path for JSON-lines trace output - `ExporterType` (string): `"otlp-http"` or `"file"` - `SourceName` (string): Instrumentation scope name @@ -580,7 +681,7 @@ An `OnPermissionRequest` handler is optional when you create or resume a session ### Approve All (simplest) -Use the built-in `PermissionHandler.ApproveAll` helper to allow every tool call without any checks: +Use the built-in `PermissionHandler.ApproveAll` helper when managed settings are disabled: ```go session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{ @@ -589,9 +690,11 @@ session, err := client.CreateSession(context.Background(), &copilot.SessionConfi }) ``` +When `EnableManagedSettings` is true for the session, `ApproveAll` returns an error. Use a custom handler for managed sessions; request-level `RequiresManagedApproval()` remains available for human-facing confirmation logic. + ### Custom Permission Handler -Provide your own `PermissionHandlerFunc` to inspect each request and apply custom logic: +Provide your own `PermissionHandlerFunc` to inspect each request and apply custom logic. Check `RequiresManagedApproval()` before any automatic approval: ```go import ( @@ -604,6 +707,10 @@ import ( session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{ Model: "gpt-5", OnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (rpc.PermissionDecision, error) { + if request.RequiresManagedApproval() { + return &rpc.PermissionDecisionNoResult{}, nil + } + // Type-switch on the discriminated PermissionRequest variants to // access per-kind fields: if shell, ok := request.(*copilot.PermissionRequestShell); ok { @@ -804,7 +911,7 @@ confirmed, err := ui.Confirm(ctx, "Deploy to production?") choice, ok, err := ui.Select(ctx, "Pick an environment", []string{"staging", "production"}) // Text input — returns (text, ok bool, error) -name, ok, err := ui.Input(ctx, "Enter the release name", &copilot.UiInputOptions{ +name, ok, err := ui.Input(ctx, "Enter the release name", &copilot.UIInputOptions{ Title: "Release Name", Description: "A short name for the release", MinLength: copilot.Int(1), @@ -812,11 +919,10 @@ name, ok, err := ui.Input(ctx, "Enter the release name", &copilot.UiInputOptions }) // Full custom elicitation with a schema -result, err := ui.Elicitation(ctx, "Configure deployment", rpc.RequestedSchema{ - Type: rpc.RequestedSchemaTypeObject, - Properties: map[string]rpc.Property{ - "target": {Type: rpc.PropertyTypeString, Enum: []string{"staging", "production"}}, - "force": {Type: rpc.PropertyTypeBoolean}, +result, err := ui.Elicitation(ctx, "Configure deployment", copilot.ElicitationSchema{ + Properties: map[string]any{ + "target": map[string]any{"type": "string", "enum": []string{"staging", "production"}}, + "force": map[string]any{"type": "boolean"}, }, Required: []string{"target"}, }) @@ -841,7 +947,7 @@ session, err := client.CreateSession(ctx, &copilot.SessionConfig{ // Return the user's response return copilot.ElicitationResult{ - Action: "accept", + Action: copilot.ElicitationActionAccept, Content: map[string]any{"confirmed": true}, }, nil }, @@ -872,6 +978,25 @@ Communicates with CLI via TCP socket. Useful for distributed scenarios. - `COPILOT_CLI_PATH` - Path to the Copilot CLI executable +## Development + +Tests require a supported [Node.js version](../nodejs/README.md#prerequisites). From the repository root: + +```bash +cd nodejs +npm ci +``` + +```bash +cd test/harness +npm ci +``` + +```bash +cd go +./test.sh +``` + ## License MIT diff --git a/go/canvas.go b/go/canvas.go index 43263a813..e31598bb1 100644 --- a/go/canvas.go +++ b/go/canvas.go @@ -25,7 +25,7 @@ type CanvasDeclaration struct { // Description is a short, single-sentence description shown to the agent in canvas catalogs. Description string `json:"description"` // InputSchema is the JSON Schema for the `input` payload accepted by `canvas.open`. - InputSchema map[string]any `json:"inputSchema,omitempty"` + InputSchema map[string]any `json:"inputSchema,omitzero"` // Actions are the agent-callable actions this canvas exposes. Actions []rpc.CanvasAction `json:"actions,omitempty"` } @@ -42,6 +42,24 @@ type ExtensionInfo struct { Name string `json:"name"` } +// CanvasProviderIdentity is the stable identity for a host/SDK connection +// that supplies built-in canvases. +// +// When set on session create or resume, the runtime uses ID verbatim as the +// agent-facing canvas extension id, so host-provided canvases survive +// reconnect and CLI restart. +// +// Experimental: CanvasProviderIdentity is part of an experimental +// wire-protocol surface and may change or be removed in future SDK or CLI +// releases. +type CanvasProviderIdentity struct { + // ID is an opaque, stable provider id used verbatim as the canvas + // extension id. + ID string `json:"id"` + // Name is an optional display name surfaced as the canvas extension name. + Name *string `json:"name,omitempty"` +} + // CanvasError is a structured error returned from canvas handlers. // // Wire envelope: diff --git a/go/canvas_test.go b/go/canvas_test.go index c6f74772a..3fdd2facc 100644 --- a/go/canvas_test.go +++ b/go/canvas_test.go @@ -136,7 +136,7 @@ func TestCanvasAdapter_DispatchesToHandler(t *testing.T) { session := newTestCanvasSession("s1") session.registerCanvasHandler(handler) - openResp, err := session.clientSessionApis.Canvas.Open(&rpc.CanvasProviderOpenRequest{ + openResp, err := session.clientSessionAPIs.Canvas.Open(&rpc.CanvasProviderOpenRequest{ SessionID: "s1", ExtensionID: "project:echo", CanvasID: "echo", @@ -156,7 +156,7 @@ func TestCanvasAdapter_DispatchesToHandler(t *testing.T) { t.Fatalf("response URL not propagated: %+v", openResp) } - actionResp, err := session.clientSessionApis.Canvas.Invoke(&rpc.CanvasProviderInvokeActionRequest{ + actionResp, err := session.clientSessionAPIs.Canvas.Invoke(&rpc.CanvasProviderInvokeActionRequest{ SessionID: "s1", ExtensionID: "project:echo", CanvasID: "echo", @@ -178,7 +178,7 @@ func TestCanvasAdapter_DispatchesToHandler(t *testing.T) { t.Fatalf("unexpected action result: %#v", actionResp) } - closeResp, err := session.clientSessionApis.Canvas.Close(&rpc.CanvasProviderCloseRequest{ + closeResp, err := session.clientSessionAPIs.Canvas.Close(&rpc.CanvasProviderCloseRequest{ SessionID: "s1", ExtensionID: "project:echo", CanvasID: "echo", @@ -198,7 +198,7 @@ func TestCanvasAdapter_DispatchesToHandler(t *testing.T) { func TestCanvasAdapter_NoHandler_ReturnsUnsetError(t *testing.T) { session := newTestCanvasSession("s1") - _, err := session.clientSessionApis.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) + _, err := session.clientSessionAPIs.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) assertCanvasJSONRPCError(t, err, "canvas_handler_unset", "") } @@ -208,7 +208,7 @@ func TestCanvasAdapter_HandlerCanvasError_Wired(t *testing.T) { openErr: NewCanvasError("permission_denied", "nope"), }) - _, err := session.clientSessionApis.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) + _, err := session.clientSessionAPIs.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) assertCanvasJSONRPCError(t, err, "permission_denied", "nope") } @@ -218,11 +218,11 @@ func TestCanvasAdapter_HandlerGenericError_WrappedAsCanvasHandlerError(t *testin openErr: errors.New("boom"), }) - _, err := session.clientSessionApis.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) + _, err := session.clientSessionAPIs.Canvas.Open(&rpc.CanvasProviderOpenRequest{SessionID: "s1"}) assertCanvasJSONRPCError(t, err, "canvas_handler_error", "boom") } -func TestCanvasRegisterClientSessionApiHandlers_RawJSONRoundTrip(t *testing.T) { +func TestCanvasRegisterClientSessionAPIHandlers_RawJSONRoundTrip(t *testing.T) { clientToServerReader, clientToServerWriter := io.Pipe() serverToClientReader, serverToClientWriter := io.Pipe() @@ -233,9 +233,9 @@ func TestCanvasRegisterClientSessionApiHandlers_RawJSONRoundTrip(t *testing.T) { openResult: rpc.CanvasProviderOpenResult{Status: strPtr("ready")}, actionResult: map[string]any{"count": float64(2)}, }) - rpc.RegisterClientSessionApiHandlers(server, func(sessionID string) *rpc.ClientSessionApiHandlers { + rpc.RegisterClientSessionAPIHandlers(server, func(sessionID string) *rpc.ClientSessionAPIHandlers { if sessionID == "s1" { - return session.clientSessionApis + return session.clientSessionAPIs } return nil }) @@ -251,7 +251,7 @@ func TestCanvasRegisterClientSessionApiHandlers_RawJSONRoundTrip(t *testing.T) { _ = serverToClientReader.Close() }) - raw, err := requester.Request("canvas.open", map[string]any{ + raw, err := requester.Request(t.Context(), "canvas.open", map[string]any{ "sessionId": "s1", "extensionId": "ext", "canvasId": "echo", @@ -284,7 +284,7 @@ func TestCanvasRegisterClientSessionApiHandlers_RawJSONRoundTrip(t *testing.T) { t.Fatalf("expected status=ready, got %v", decoded["status"]) } - actionRaw, err := requester.Request("canvas.action.invoke", map[string]any{ + actionRaw, err := requester.Request(t.Context(), "canvas.action.invoke", map[string]any{ "sessionId": "s1", "extensionId": "ext", "canvasId": "echo", @@ -310,11 +310,9 @@ func TestCanvasResumeSessionResponse_OpenCanvasesParse(t *testing.T) { "workspacePath": "/tmp/ws", "openCanvases": [ { - "availability": "ready", "canvasId": "echo", "extensionId": "project:echo", - "instanceId": "echo-1", - "reopen": false + "instanceId": "echo-1" } ] }`) @@ -343,11 +341,9 @@ func TestCanvasResumeSessionRequest_OpenCanvasesWireShape(t *testing.T) { SessionID: "s1", OpenCanvases: []rpc.OpenCanvasInstance{ { - Availability: "ready", - CanvasID: "echo", - ExtensionID: "project:echo", - InstanceID: "echo-1", - Reopen: false, + CanvasID: "echo", + ExtensionID: "project:echo", + InstanceID: "echo-1", }, }, } @@ -417,9 +413,9 @@ func assertCanvasJSONRPCError(t *testing.T, err error, wantCode, wantMessage str func newTestCanvasSession(sessionID string) *Session { session := &Session{ SessionID: sessionID, - clientSessionApis: &rpc.ClientSessionApiHandlers{}, + clientSessionAPIs: &rpc.ClientSessionAPIHandlers{}, } - session.clientSessionApis.Canvas = newCanvasClientSessionAdapter(session) + session.clientSessionAPIs.Canvas = newCanvasClientSessionAdapter(session) return session } diff --git a/go/client.go b/go/client.go index 3ccee2896..fb02897f9 100644 --- a/go/client.go +++ b/go/client.go @@ -34,9 +34,11 @@ import ( "encoding/json" "errors" "fmt" + "log" "net" "os" "os/exec" + "path/filepath" "regexp" "strconv" "strings" @@ -52,22 +54,77 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) -func validateSessionFsConfig(config *SessionFsConfig) error { +// defaultBearerTokenProviderName is the implicit provider name for the singular, +// whole-session [ProviderConfig]. Named providers are keyed by their own Name. +const defaultBearerTokenProviderName = "default" + +// collectBearerTokenProviders gathers the per-provider [BearerTokenProvider] callbacks +// from the singular provider and any named providers, keyed by provider name. The +// singular provider uses the implicit name "default"; named providers use their +// own Name. Returns nil when no callbacks are configured. +func collectBearerTokenProviders(provider *ProviderConfig, providers []NamedProviderConfig) map[string]BearerTokenProvider { + callbacks := make(map[string]BearerTokenProvider) + if provider != nil && provider.BearerTokenProvider != nil { + callbacks[defaultBearerTokenProviderName] = provider.BearerTokenProvider + } + for i := range providers { + if providers[i].BearerTokenProvider != nil { + callbacks[providers[i].Name] = providers[i].BearerTokenProvider + } + } + if len(callbacks) == 0 { + return nil + } + return callbacks +} + +func validateSessionFSConfig(config *SessionFSConfig) error { if config == nil { return nil } if config.InitialWorkingDirectory == "" { - return errors.New("SessionFs.InitialWorkingDirectory is required") + return errors.New("SessionFS.InitialWorkingDirectory is required") } if config.SessionStatePath == "" { - return errors.New("SessionFs.SessionStatePath is required") + return errors.New("SessionFS.SessionStatePath is required") } - if config.Conventions != rpc.SessionFsSetProviderConventionsPosix && config.Conventions != rpc.SessionFsSetProviderConventionsWindows { - return errors.New("SessionFs.Conventions must be either 'posix' or 'windows'") + if config.Conventions != rpc.SessionFSSetProviderConventionsPosix && config.Conventions != rpc.SessionFSSetProviderConventionsWindows { + return errors.New("SessionFS.Conventions must be either 'posix' or 'windows'") } return nil } +// validateEnvironmentOptions enforces the transport-specific rules for +// per-client environment, working directory, and telemetry. It panics (fails +// loud) on a misconfiguration, matching the other SDKs. +// +// The in-process transport loads the native runtime into this process, whose +// single environment block and process-global working directory cannot carry +// per-client values, and whose telemetry lowers to shared process-global env +// vars — so options that depend on them are rejected there. Child-process +// transports each own their OS process, so per-connection env is allowed, but +// setting it in both the client-level option and the connection is rejected. +func validateEnvironmentOptions(connection RuntimeConnection, opts *ClientOptions) { + if _, ok := connection.(InProcessConnection); ok { + if opts.Env != nil { + panic("Env is not supported with InProcessConnection: the in-process transport loads the native runtime into the shared host process, whose single environment block cannot carry per-client values. Set the variables on the host process environment instead.") + } + if opts.WorkingDirectory != "" { + panic("WorkingDirectory is not supported with InProcessConnection: the native runtime shares the host process working directory. Use a child-process transport, or set the process working directory before creating the client.") + } + if opts.Telemetry != nil { + panic("Telemetry is not supported with InProcessConnection: telemetry configuration is lowered to environment variables read by native runtime code running in the shared host process, so per-client telemetry cannot be honored in-process. Configure telemetry via the host process environment, or use a child-process transport.") + } + return + } + + if cp, ok := connection.(childProcessConnection); ok { + if cp.connEnv() != nil && opts.Env != nil { + panic("Set environment variables via either the client-level Env option or the connection's Env, not both. Prefer the connection-level Env for child-process transports.") + } + } +} + // Client manages the connection to the Copilot CLI server and provides session management. // // The Client can either spawn a CLI server process or connect to an existing server. @@ -80,7 +137,7 @@ func validateSessionFsConfig(config *SessionFsConfig) error { // // // Or connect to an existing server // client := copilot.NewClient(&copilot.ClientOptions{ -// CLIUrl: "localhost:3000", +// Connection: copilot.URIConnection{URL: "localhost:3000"}, // }) // // if err := client.Start(); err != nil { @@ -99,7 +156,9 @@ type Client struct { isExternalServer bool conn net.Conn // stores net.Conn for external TCP connections useStdio bool // resolved value from options - // resolved process options for the spawned runtime (zero values for UriConnection) + useInProcess bool // true for InProcessConnection (FFI transport) + ffiHost inProcessHost + // resolved process options for the spawned runtime (zero values for URIConnection) cliPath string cliArgs []string port int @@ -123,11 +182,11 @@ type Client struct { // RPC provides typed server-scoped RPC methods. // This field is nil until the client is connected via Start(). - RPC *rpc.ServerRpc + RPC *rpc.ServerRPC // internalRPC provides SDK-internal RPC methods (handshake helpers etc.). // Lowercase = not exported; external callers cannot reach it. - internalRPC *rpc.InternalServerRpc + internalRPC *rpc.InternalServerRPC } // NewClient creates a new Copilot runtime client with the given options. @@ -150,7 +209,7 @@ type Client struct { // // // Connect to an already-running runtime // client := copilot.NewClient(&copilot.ClientOptions{ -// Connection: copilot.UriConnection{URL: "localhost:8080"}, +// Connection: copilot.URIConnection{URL: "localhost:8080"}, // }) func NewClient(options *ClientOptions) *Client { opts := ClientOptions{} @@ -167,11 +226,22 @@ func NewClient(options *ClientOptions) *Client { if options != nil { opts = *options } + for _, path := range opts.BuiltinPluginDirectories { + if !filepath.IsAbs(path) { + panic(fmt.Sprintf("BuiltinPluginDirectories must contain only absolute paths: %s", path)) + } + } + opts.BuiltinPluginDirectories = append([]string(nil), opts.BuiltinPluginDirectories...) - // Resolve the connection. nil defaults to an empty StdioConnection. + // Resolve the connection. An explicit connection always wins; otherwise + // honor the same process/environment override as the other SDKs. connection := opts.Connection if connection == nil { - connection = StdioConnection{} + env := opts.Env + if env == nil { + env = os.Environ() + } + connection = resolveDefaultConnection(env) } switch conn := connection.(type) { case StdioConnection: @@ -180,7 +250,7 @@ func NewClient(options *ClientOptions) *Client { if len(conn.Args) > 0 { client.cliArgs = append([]string{}, conn.Args...) } - case TcpConnection: + case TCPConnection: client.useStdio = false client.cliPath = conn.Path if len(conn.Args) > 0 { @@ -188,23 +258,42 @@ func NewClient(options *ClientOptions) *Client { } client.port = conn.Port client.tcpConnectionToken = conn.ConnectionToken - case UriConnection: + case URIConnection: if conn.URL == "" { - panic("UriConnection requires a non-empty URL") + panic("URIConnection requires a non-empty URL") } - host, port := parseCliUrl(conn.URL) + host, port := parseCLIURL(conn.URL) client.actualHost = host client.actualPort = port client.isExternalServer = true client.useStdio = false client.tcpConnectionToken = conn.ConnectionToken + case InProcessConnection: + client.useStdio = false + client.useInProcess = true default: panic(fmt.Sprintf("unknown RuntimeConnection type: %T", connection)) } + // Validate transport-specific option constraints (fail loud). The in-process + // transport loads the runtime into this process, whose single environment + // block, process-global working directory, and shared telemetry state cannot + // carry per-client values. Child-process transports may set env via either + // the client-level option or the connection, but not both. + validateEnvironmentOptions(connection, &opts) + // Validate auth options when connecting to an external runtime. if client.isExternalServer && (opts.GitHubToken != "" || opts.UseLoggedInUser != nil) { - panic("GitHubToken and UseLoggedInUser cannot be used with UriConnection (external runtime manages its own auth)") + panic("GitHubToken and UseLoggedInUser cannot be used with URIConnection (external runtime manages its own auth)") + } + + // For child-process transports, a connection-level env takes precedence over + // the client-level env (setting both was rejected above). Resolve it before + // defaulting so an explicit empty connection env stays authoritative. + if cp, ok := connection.(childProcessConnection); ok { + if env := cp.connEnv(); env != nil { + opts.Env = env + } } // Default Env to current environment if not set @@ -212,26 +301,27 @@ func NewClient(options *ClientOptions) *Client { opts.Env = os.Environ() } - // Check effective environment for CLI path (only if not explicitly set via options) - if client.cliPath == "" { + // Check the effective environment for a child-process runtime override. + if client.cliPath == "" && !client.useInProcess { if cliPath := getEnvValue(opts.Env, "COPILOT_CLI_PATH"); cliPath != "" { client.cliPath = cliPath } } // Resolve the effective connection token: explicit value if set; else if the SDK - // spawns its own runtime in TCP mode, generate a UUID; otherwise empty. + // spawns its own runtime in TCP mode, generate a UUID; otherwise empty. The + // in-process transport uses no socket, so it needs no connection token. if client.tcpConnectionToken != "" { client.effectiveConnectionToken = client.tcpConnectionToken - } else if !client.useStdio && !client.isExternalServer { + } else if !client.useStdio && !client.isExternalServer && !client.useInProcess { client.effectiveConnectionToken = uuid.NewString() } if opts.OnListModels != nil { client.onListModels = opts.OnListModels } - if opts.SessionFs != nil { - if err := validateSessionFsConfig(opts.SessionFs); err != nil { + if opts.SessionFS != nil { + if err := validateSessionFSConfig(opts.SessionFS); err != nil { panic(err.Error()) } } @@ -241,6 +331,27 @@ func NewClient(options *ClientOptions) *Client { return client } +const defaultConnectionEnvVar = "COPILOT_SDK_DEFAULT_CONNECTION" + +// resolveDefaultConnection selects the transport when no explicit connection +// was supplied. The override is primarily used by hosts and the E2E transport +// matrix; explicit connection options always take precedence. +func resolveDefaultConnection(env []string) RuntimeConnection { + value := getEnvValue(env, defaultConnectionEnvVar) + switch { + case value == "", strings.EqualFold(value, "stdio"): + return StdioConnection{} + case strings.EqualFold(value, "inprocess"): + return InProcessConnection{} + default: + panic(fmt.Sprintf( + "invalid %s value %q: expected \"inprocess\", \"stdio\", or unset", + defaultConnectionEnvVar, + value, + )) + } +} + // getEnvValue looks up a key in an environment slice ([]string of "KEY=VALUE"). // Returns the value if found, or empty string otherwise. func getEnvValue(env []string, key string) string { @@ -266,19 +377,19 @@ func setEnvValue(env []string, key string, value string) []string { return append(filtered, key+"="+value) } -// parseCliUrl parses a CLI URL into host and port components. +// parseCLIURL parses a CLI URL into host and port components. // // Supports formats: "host:port", "http://host:port", "https://host:port", or just "port". // Panics if the URL format is invalid or the port is out of range. -func parseCliUrl(url string) (string, int) { +func parseCLIURL(url string) (string, int) { // Remove protocol if present - cleanUrl, _ := strings.CutPrefix(url, "https://") - cleanUrl, _ = strings.CutPrefix(cleanUrl, "http://") + cleanURL, _ := strings.CutPrefix(url, "https://") + cleanURL, _ = strings.CutPrefix(cleanURL, "http://") // Parse host:port or port format var host string var portStr string - if before, after, found := strings.Cut(cleanUrl, ":"); found { + if before, after, found := strings.Cut(cleanURL, ":"); found { host = before portStr = after } else { @@ -293,7 +404,7 @@ func parseCliUrl(url string) (string, int) { // Validate port port, err := strconv.Atoi(portStr) if err != nil || port <= 0 || port > 65535 { - panic(fmt.Sprintf("Invalid port in CLIUrl: %s", url)) + panic(fmt.Sprintf("Invalid port in URIConnection: %s", url)) } return host, port @@ -302,7 +413,7 @@ func parseCliUrl(url string) (string, int) { // Start starts the CLI server (if not using an external server) and establishes // a connection. // -// If connecting to an external server (via CLIUrl), only establishes the connection. +// If connecting to an external server (via URIConnection), only establishes the connection. // Otherwise, spawns the CLI server process and then connects. // // This method is called automatically when creating a session if AutoStart is true (default). @@ -349,20 +460,35 @@ func (c *Client) Start(ctx context.Context) error { return errors.Join(err, killErr) } + if len(c.options.BuiltinPluginDirectories) > 0 { + if _, err := c.client.Request(ctx, "plugins.builtin.set", map[string]any{ + "paths": c.options.BuiltinPluginDirectories, + }); err != nil { + c.client.Stop() + c.client = nil + c.conn = nil + c.RPC = nil + c.internalRPC = nil + killErr := c.killProcess() + c.state = stateError + return errors.Join(err, killErr) + } + } + // If a session filesystem provider was configured, register it. - if c.options.SessionFs != nil { - req := &rpc.SessionFsSetProviderRequest{ - InitialCwd: c.options.SessionFs.InitialWorkingDirectory, - SessionStatePath: c.options.SessionFs.SessionStatePath, - Conventions: c.options.SessionFs.Conventions, - } - if c.options.SessionFs.Capabilities != nil { - sqlite := c.options.SessionFs.Capabilities.Sqlite - req.Capabilities = &rpc.SessionFsSetProviderCapabilities{ + if c.options.SessionFS != nil { + req := &rpc.SessionFSSetProviderRequest{ + InitialCwd: c.options.SessionFS.InitialWorkingDirectory, + SessionStatePath: c.options.SessionFS.SessionStatePath, + Conventions: c.options.SessionFS.Conventions, + } + if c.options.SessionFS.Capabilities != nil { + sqlite := c.options.SessionFS.Capabilities.Sqlite + req.Capabilities = &rpc.SessionFSSetProviderCapabilities{ Sqlite: &sqlite, } } - _, err := c.RPC.SessionFs.SetProvider(ctx, req) + _, err := c.RPC.SessionFS.SetProvider(ctx, req) if err != nil { killErr := c.killProcess() c.state = stateError @@ -370,6 +496,15 @@ func (c *Client) Start(ctx context.Context) error { } } + // If a request handler was configured, register as the inference provider. + if c.options.RequestHandler != nil { + if _, err := c.RPC.LlmInference.SetProvider(ctx); err != nil { + killErr := c.killProcess() + c.state = stateError + return errors.Join(err, killErr) + } + } + c.state = stateConnected return nil } @@ -378,8 +513,9 @@ func (c *Client) Start(ctx context.Context) error { // // This method performs graceful cleanup: // 1. Closes all active sessions (releases in-memory resources) -// 2. Closes the JSON-RPC connection -// 3. Terminates the CLI server process (if spawned by this client) +// 2. Requests runtime shutdown for SDK-owned CLI processes +// 3. Closes the JSON-RPC connection +// 4. Terminates the CLI server process (if spawned by this client) // // Note: session data on disk is preserved, so sessions can be resumed later. // To permanently remove session data before stopping, call [Client.DeleteSession] @@ -416,14 +552,48 @@ func (c *Client) Stop() error { c.startStopMux.Lock() defer c.startStopMux.Unlock() - // Kill CLI process FIRST (this closes stdout and unblocks readLoop) - only if we spawned it + if (c.process != nil || c.ffiHost != nil) && !c.isExternalServer && c.RPC != nil { + rpcClient := c.RPC + runtimeShutdownStart := time.Now() + shutdownDone := make(chan error, 1) + go func() { + _, err := rpcClient.Runtime.Shutdown(context.Background()) + shutdownDone <- err + }() + + select { + case err := <-shutdownDone: + if err != nil { + c.logDebugTiming(runtimeShutdownStart, "CopilotClient.Stop runtime shutdown failed") + errs = append(errs, fmt.Errorf("failed to gracefully shut down runtime: %w", err)) + } else { + c.logDebugTiming(runtimeShutdownStart, "CopilotClient.Stop runtime shutdown complete") + } + case <-time.After(runtimeShutdownTimeout): + c.logDebugTiming(runtimeShutdownStart, "CopilotClient.Stop runtime shutdown timed out") + errs = append(errs, fmt.Errorf("timed out gracefully shutting down runtime after %s", runtimeShutdownTimeout)) + } + } + + // The runtime completes all cleanup before responding to runtime.shutdown + // and then leaves termination to us; it deliberately keeps its JSON-RPC + // server alive to send the response and never self-exits. Waiting for a + // self-exit that will never come just wastes time, so terminate the child + // immediately and only wait to reap it. if c.process != nil && !c.isExternalServer { - if err := c.killProcess(); err != nil { + if err := c.killProcessAndWait(); err != nil { errs = append(errs, err) } } c.process = nil + // Tear down the in-process FFI host (closes the connection and shuts down the + // native runtime). No child process to reap in this mode. + if c.ffiHost != nil { + c.ffiHost.Dispose() + c.ffiHost = nil + } + // Close external TCP connection if exists if c.isExternalServer && c.conn != nil { if err := c.conn.Close(); err != nil { @@ -453,6 +623,13 @@ func (c *Client) Stop() error { return errors.Join(errs...) } +func (c *Client) logDebugTiming(start time.Time, message string) { + switch strings.ToLower(c.options.LogLevel) { + case "debug", "all": + log.Printf("%s elapsed=%s", message, time.Since(start)) + } +} + // ForceStop forcefully stops the CLI server without graceful cleanup. // // Use this when [Client.Stop] fails or takes too long. This method: @@ -498,6 +675,12 @@ func (c *Client) ForceStop() { } c.process = nil + // Dispose the in-process FFI host (if any) without waiting on graceful shutdown. + if c.ffiHost != nil { + c.ffiHost.Dispose() + c.ffiHost = nil + } + // Close external TCP connection if exists if c.isExternalServer && c.conn != nil { _ = c.conn.Close() // Ignore errors @@ -589,6 +772,10 @@ func extractTransformCallbacks(config *SystemMessageConfig) (*SystemMessageConfi return wireConfig, callbacks } +func hasManagedSettings(enableManagedSettings *bool, managedSettings *ManagedSettings) bool { + return (enableManagedSettings != nil && *enableManagedSettings) || managedSettings != nil +} + func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Session, error) { if config == nil { config = &SessionConfig{} @@ -607,9 +794,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses req.ReasoningSummary = config.ReasoningSummary req.ContextTier = config.ContextTier req.ConfigDir = config.ConfigDirectory - if config.EnableConfigDiscovery { - req.EnableConfigDiscovery = Bool(true) - } + req.EnableConfigDiscovery = config.EnableConfigDiscovery req.SkipEmbeddingRetrieval = config.SkipEmbeddingRetrieval req.EmbeddingCacheStorage = config.EmbeddingCacheStorage req.OrganizationCustomInstructions = config.OrganizationCustomInstructions @@ -629,14 +814,23 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses req.AvailableTools = availableTools req.ExcludedTools = excludedTools req.ToolFilterPrecedence = precedence + req.ExcludedBuiltInAgents = config.ExcludedBuiltInAgents req.Provider = config.Provider + req.Capi = config.Capi + req.Providers = config.Providers + req.Models = config.Models req.EnableSessionTelemetry = config.EnableSessionTelemetry + req.EnableCitations = config.EnableCitations + req.EnableFileChangeTracking = config.EnableFileChangeTracking + req.SessionLimits = config.SessionLimits + req.IsExperimentalMode = config.EnableExperimentalMode req.SkipCustomInstructions = config.SkipCustomInstructions req.CustomAgentsLocalOnly = config.CustomAgentsLocalOnly req.CoauthorEnabled = config.CoauthorEnabled req.ManageScheduleEnabled = config.ManageScheduleEnabled req.ModelCapabilities = config.ModelCapabilities req.WorkingDirectory = config.WorkingDirectory + req.AdditionalDirectories = config.AdditionalDirectories req.MCPServers = config.MCPServers req.MCPOAuthTokenStorage = config.MCPOAuthTokenStorage req.EnvValueMode = "direct" @@ -647,15 +841,26 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses req.PluginDirectories = config.PluginDirectories req.InstructionDirectories = config.InstructionDirectories req.DisabledSkills = config.DisabledSkills + if config.DisabledMCPServers != nil { + req.DisabledMCPServers = &config.DisabledMCPServers + } req.InfiniteSessions = config.InfiniteSessions req.LargeOutput = config.LargeOutput + req.ToolSearch = config.ToolSearch + req.Memory = config.Memory req.GitHubToken = config.GitHubToken req.RemoteSession = config.RemoteSession req.Cloud = config.Cloud req.Canvases = config.Canvases + req.ExtensionInfo = config.ExtensionInfo + req.CanvasProvider = config.CanvasProvider req.RequestCanvasRenderer = config.RequestCanvasRenderer req.RequestExtensions = config.RequestExtensions - req.ExtensionSdkPath = config.ExtensionSdkPath + req.ExtensionSDKPath = config.ExtensionSDKPath + req.ExtensionInfo = config.ExtensionInfo + req.ExpAssignments = config.ExpAssignments + req.EnableManagedSettings = config.EnableManagedSettings + req.ManagedSettings = config.ManagedSettings if len(config.Commands) > 0 { cmds := make([]wireCommand, 0, len(config.Commands)) @@ -673,9 +878,10 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses if config.OnAutoModeSwitchRequest != nil { req.RequestAutoModeSwitch = Bool(true) } - if config.EnableMcpApps { - req.RequestMcpApps = Bool(true) + if config.EnableMCPApps { + req.RequestMCPApps = Bool(true) } + req.GitHubMCPToolConfig = config.GitHubMCPToolConfig if config.Streaming != nil { req.Streaming = config.Streaming @@ -685,17 +891,22 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses } else { req.IncludeSubAgentStreamingEvents = Bool(true) } + if c.options.OnGitHubTelemetry != nil { + req.EnableGitHubTelemetryForwarding = Bool(true) + } if config.OnUserInputRequest != nil { req.RequestUserInput = Bool(true) } if config.Hooks != nil && (config.Hooks.OnPreToolUse != nil || - config.Hooks.OnPreMcpToolCall != nil || + config.Hooks.OnPreMCPToolCall != nil || config.Hooks.OnPostToolUse != nil || config.Hooks.OnPostToolUseFailure != nil || config.Hooks.OnUserPromptSubmitted != nil || + config.Hooks.OnUserPromptTransformed != nil || config.Hooks.OnSessionStart != nil || config.Hooks.OnSessionEnd != nil || - config.Hooks.OnErrorOccurred != nil) { + config.Hooks.OnErrorOccurred != nil || + config.Hooks.OnAgentStop != nil) { req.Hooks = Bool(true) } if config.OnPermissionRequest != nil { @@ -730,10 +941,16 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses // message is dispatched) so notifications for the new session id are // routed to a registered session. initializeSession := func(sessionID string) (*Session, error) { - s := newSession(sessionID, c.client, "") + s := newSession( + sessionID, + c.client, + "", + hasManagedSettings(config.EnableManagedSettings, config.ManagedSettings), + ) s.registerTools(config.Tools) s.registerPermissionHandler(config.OnPermissionRequest) + s.registerMCPAuthHandler(config.OnMCPAuthRequest) if config.OnUserInputRequest != nil { s.registerUserInputHandler(config.OnUserInputRequest) } @@ -761,28 +978,31 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses if config.CanvasHandler != nil { s.registerCanvasHandler(config.CanvasHandler) } + if bearerTokenProviders := collectBearerTokenProviders(config.Provider, config.Providers); bearerTokenProviders != nil { + s.registerBearerTokenProviders(bearerTokenProviders) + } c.sessionsMux.Lock() c.sessions[sessionID] = s c.sessionsMux.Unlock() - if c.options.SessionFs != nil { - if config.CreateSessionFsProvider == nil { + if c.options.SessionFS != nil { + if config.CreateSessionFSProvider == nil { c.sessionsMux.Lock() delete(c.sessions, sessionID) c.sessionsMux.Unlock() - return nil, fmt.Errorf("CreateSessionFsProvider is required in session config when SessionFs is enabled in client options") + return nil, fmt.Errorf("CreateSessionFSProvider is required in session config when SessionFS is enabled in client options") } - provider := config.CreateSessionFsProvider(s) - if c.options.SessionFs.Capabilities != nil && c.options.SessionFs.Capabilities.Sqlite { - if _, ok := provider.(SessionFsSqliteProvider); !ok { + provider := config.CreateSessionFSProvider(s) + if c.options.SessionFS.Capabilities != nil && c.options.SessionFS.Capabilities.Sqlite { + if _, ok := provider.(SessionFSSqliteProvider); !ok { c.sessionsMux.Lock() delete(c.sessions, sessionID) c.sessionsMux.Unlock() - return nil, fmt.Errorf("SessionFs capabilities declare SQLite support but the provider does not implement SessionFsSqliteProvider") + return nil, fmt.Errorf("SessionFS capabilities declare SQLite support but the provider does not implement SessionFSSqliteProvider") } } - s.clientSessionApis.SessionFs = newSessionFsAdapter(provider) + s.clientSessionAPIs.SessionFS = newSessionFSAdapter(provider) } return s, nil } @@ -832,7 +1052,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses } } - result, err := c.client.RequestWithInlineResponse("session.create", req, inlineCb) + result, err := c.client.RequestWithInlineResponse(ctx, "session.create", req, inlineCb) if err != nil { if registeredSessionID != "" { c.sessionsMux.Lock() @@ -862,6 +1082,14 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses c.sessionsMux.Unlock() return nil, fmt.Errorf("session.create returned sessionId %s but the caller requested %s", response.SessionID, localSessionID) } + if config.OnMCPAuthRequest != nil { + if _, err := c.client.Request(ctx, "session.eventLog.registerInterest", map[string]any{ + "sessionId": session.SessionID, + "eventType": "mcp.oauth_required", + }); err != nil { + return nil, err + } + } session.workspacePath = response.WorkspacePath session.setCapabilities(response.Capabilities) @@ -924,7 +1152,11 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.SystemMessage = wireSystemMessage req.Tools = config.Tools req.Provider = config.Provider + req.Capi = config.Capi + req.Providers = config.Providers + req.Models = config.Models req.EnableSessionTelemetry = config.EnableSessionTelemetry + req.IsExperimentalMode = config.EnableExperimentalMode req.SkipCustomInstructions = config.SkipCustomInstructions req.CustomAgentsLocalOnly = config.CustomAgentsLocalOnly req.CoauthorEnabled = config.CoauthorEnabled @@ -937,6 +1169,10 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.AvailableTools = availableTools req.ExcludedTools = excludedTools req.ToolFilterPrecedence = precedence + req.ExcludedBuiltInAgents = config.ExcludedBuiltInAgents + req.EnableCitations = config.EnableCitations + req.EnableFileChangeTracking = config.EnableFileChangeTracking + req.SessionLimits = config.SessionLimits if config.Streaming != nil { req.Streaming = config.Streaming } @@ -945,24 +1181,28 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, } else { req.IncludeSubAgentStreamingEvents = Bool(true) } + if c.options.OnGitHubTelemetry != nil { + req.EnableGitHubTelemetryForwarding = Bool(true) + } if config.OnUserInputRequest != nil { req.RequestUserInput = Bool(true) } if config.Hooks != nil && (config.Hooks.OnPreToolUse != nil || - config.Hooks.OnPreMcpToolCall != nil || + config.Hooks.OnPreMCPToolCall != nil || config.Hooks.OnPostToolUse != nil || config.Hooks.OnPostToolUseFailure != nil || config.Hooks.OnUserPromptSubmitted != nil || + config.Hooks.OnUserPromptTransformed != nil || config.Hooks.OnSessionStart != nil || config.Hooks.OnSessionEnd != nil || - config.Hooks.OnErrorOccurred != nil) { + config.Hooks.OnErrorOccurred != nil || + config.Hooks.OnAgentStop != nil) { req.Hooks = Bool(true) } req.WorkingDirectory = config.WorkingDirectory + req.AdditionalDirectories = config.AdditionalDirectories req.ConfigDir = config.ConfigDirectory - if config.EnableConfigDiscovery { - req.EnableConfigDiscovery = Bool(true) - } + req.EnableConfigDiscovery = config.EnableConfigDiscovery req.SkipEmbeddingRetrieval = config.SkipEmbeddingRetrieval req.EmbeddingCacheStorage = config.EmbeddingCacheStorage req.OrganizationCustomInstructions = config.OrganizationCustomInstructions @@ -974,9 +1214,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, if config.SuppressResumeEvent { req.DisableResume = Bool(true) } - if config.ContinuePendingWork { - req.ContinuePendingWork = Bool(true) - } + req.ContinuePendingWork = config.ContinuePendingWork req.MCPServers = config.MCPServers req.MCPOAuthTokenStorage = config.MCPOAuthTokenStorage req.EnvValueMode = "direct" @@ -987,15 +1225,26 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.PluginDirectories = config.PluginDirectories req.InstructionDirectories = config.InstructionDirectories req.DisabledSkills = config.DisabledSkills + if config.DisabledMCPServers != nil { + req.DisabledMCPServers = &config.DisabledMCPServers + } req.InfiniteSessions = config.InfiniteSessions req.LargeOutput = config.LargeOutput + req.ToolSearch = config.ToolSearch + req.Memory = config.Memory req.GitHubToken = config.GitHubToken req.RemoteSession = config.RemoteSession req.Canvases = config.Canvases req.OpenCanvases = config.OpenCanvases + req.ExtensionInfo = config.ExtensionInfo + req.CanvasProvider = config.CanvasProvider req.RequestCanvasRenderer = config.RequestCanvasRenderer req.RequestExtensions = config.RequestExtensions - req.ExtensionSdkPath = config.ExtensionSdkPath + req.ExtensionSDKPath = config.ExtensionSDKPath + req.ExtensionInfo = config.ExtensionInfo + req.ExpAssignments = config.ExpAssignments + req.EnableManagedSettings = config.EnableManagedSettings + req.ManagedSettings = config.ManagedSettings if config.OnPermissionRequest != nil { req.RequestPermission = Bool(true) } @@ -1016,9 +1265,10 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, if config.OnAutoModeSwitchRequest != nil { req.RequestAutoModeSwitch = Bool(true) } - if config.EnableMcpApps { - req.RequestMcpApps = Bool(true) + if config.EnableMCPApps { + req.RequestMCPApps = Bool(true) } + req.GitHubMCPToolConfig = config.GitHubMCPToolConfig traceparent, tracestate := getTraceContext(ctx) req.Traceparent = traceparent @@ -1026,10 +1276,16 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, // Create and register the session before issuing the RPC so that // events emitted by the CLI (e.g. session.start) are not dropped. - session := newSession(sessionID, c.client, "") + session := newSession( + sessionID, + c.client, + "", + hasManagedSettings(config.EnableManagedSettings, config.ManagedSettings), + ) session.registerTools(config.Tools) session.registerPermissionHandler(config.OnPermissionRequest) + session.registerMCPAuthHandler(config.OnMCPAuthRequest) if config.OnUserInputRequest != nil { session.registerUserInputHandler(config.OnUserInputRequest) } @@ -1057,31 +1313,34 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, if config.CanvasHandler != nil { session.registerCanvasHandler(config.CanvasHandler) } + if bearerTokenProviders := collectBearerTokenProviders(config.Provider, config.Providers); bearerTokenProviders != nil { + session.registerBearerTokenProviders(bearerTokenProviders) + } c.sessionsMux.Lock() c.sessions[sessionID] = session c.sessionsMux.Unlock() - if c.options.SessionFs != nil { - if config.CreateSessionFsProvider == nil { + if c.options.SessionFS != nil { + if config.CreateSessionFSProvider == nil { c.sessionsMux.Lock() delete(c.sessions, sessionID) c.sessionsMux.Unlock() - return nil, fmt.Errorf("CreateSessionFsProvider is required in session config when SessionFs is enabled in client options") + return nil, fmt.Errorf("CreateSessionFSProvider is required in session config when SessionFS is enabled in client options") } - provider := config.CreateSessionFsProvider(session) - if c.options.SessionFs.Capabilities != nil && c.options.SessionFs.Capabilities.Sqlite { - if _, ok := provider.(SessionFsSqliteProvider); !ok { + provider := config.CreateSessionFSProvider(session) + if c.options.SessionFS.Capabilities != nil && c.options.SessionFS.Capabilities.Sqlite { + if _, ok := provider.(SessionFSSqliteProvider); !ok { c.sessionsMux.Lock() delete(c.sessions, sessionID) c.sessionsMux.Unlock() - return nil, fmt.Errorf("SessionFs capabilities declare SQLite support but the provider does not implement SessionFsSqliteProvider") + return nil, fmt.Errorf("SessionFS capabilities declare SQLite support but the provider does not implement SessionFSSqliteProvider") } } - session.clientSessionApis.SessionFs = newSessionFsAdapter(provider) + session.clientSessionAPIs.SessionFS = newSessionFSAdapter(provider) } - result, err := c.client.Request("session.resume", req) + result, err := c.client.Request(ctx, "session.resume", req) if err != nil { c.sessionsMux.Lock() delete(c.sessions, sessionID) @@ -1097,6 +1356,18 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, return nil, fmt.Errorf("failed to unmarshal response: %w", err) } + if config.OnMCPAuthRequest != nil { + if _, err := c.client.Request(ctx, "session.eventLog.registerInterest", map[string]any{ + "sessionId": sessionID, + "eventType": "mcp.oauth_required", + }); err != nil { + c.sessionsMux.Lock() + delete(c.sessions, sessionID) + c.sessionsMux.Unlock() + return nil, err + } + } + session.workspacePath = response.WorkspacePath session.setCapabilities(response.Capabilities) session.setOpenCanvases(response.OpenCanvases) @@ -1142,7 +1413,7 @@ func (c *Client) ListSessions(ctx context.Context, filter *SessionListFilter) ([ if filter != nil { params.Filter = filter } - result, err := c.client.Request("session.list", params) + result, err := c.client.Request(ctx, "session.list", params) if err != nil { return nil, err } @@ -1174,7 +1445,7 @@ func (c *Client) GetSessionMetadata(ctx context.Context, sessionID string) (*Ses return nil, err } - result, err := c.client.Request("session.getMetadata", getSessionMetadataRequest{SessionID: sessionID}) + result, err := c.client.Request(ctx, "session.getMetadata", getSessionMetadataRequest{SessionID: sessionID}) if err != nil { return nil, err } @@ -1205,7 +1476,7 @@ func (c *Client) DeleteSession(ctx context.Context, sessionID string) error { return err } - result, err := c.client.Request("session.delete", deleteSessionRequest{SessionID: sessionID}) + result, err := c.client.Request(ctx, "session.delete", deleteSessionRequest{SessionID: sessionID}) if err != nil { return err } @@ -1252,7 +1523,7 @@ func (c *Client) GetLastSessionID(ctx context.Context) (*string, error) { return nil, err } - result, err := c.client.Request("session.getLastId", getLastSessionIDRequest{}) + result, err := c.client.Request(ctx, "session.getLastId", getLastSessionIDRequest{}) if err != nil { return nil, err } @@ -1284,7 +1555,7 @@ func (c *Client) GetForegroundSessionID(ctx context.Context) (*string, error) { return nil, err } - result, err := c.client.Request("session.getForeground", getForegroundSessionRequest{}) + result, err := c.client.Request(ctx, "session.getForeground", getForegroundSessionRequest{}) if err != nil { return nil, err } @@ -1312,7 +1583,7 @@ func (c *Client) SetForegroundSessionID(ctx context.Context, sessionID string) e return err } - result, err := c.client.Request("session.setForeground", setForegroundSessionRequest{SessionID: sessionID}) + result, err := c.client.Request(ctx, "session.setForeground", setForegroundSessionRequest{SessionID: sessionID}) if err != nil { return err } @@ -1452,7 +1723,7 @@ func (c *Client) Ping(ctx context.Context, message string) (*PingResponse, error return nil, fmt.Errorf("client not connected") } - result, err := c.client.Request("ping", pingRequest{Message: message}) + result, err := c.client.Request(ctx, "ping", pingRequest{Message: message}) if err != nil { return nil, err } @@ -1470,7 +1741,7 @@ func (c *Client) GetStatus(ctx context.Context) (*GetStatusResponse, error) { return nil, fmt.Errorf("client not connected") } - result, err := c.client.Request("status.get", getStatusRequest{}) + result, err := c.client.Request(ctx, "status.get", getStatusRequest{}) if err != nil { return nil, err } @@ -1488,7 +1759,7 @@ func (c *Client) GetAuthStatus(ctx context.Context) (*GetAuthStatusResponse, err return nil, fmt.Errorf("client not connected") } - result, err := c.client.Request("auth.getStatus", getAuthStatusRequest{}) + result, err := c.client.Request(ctx, "auth.getStatus", getAuthStatusRequest{}) if err != nil { return nil, err } @@ -1529,7 +1800,7 @@ func (c *Client) ListModels(ctx context.Context) ([]ModelInfo, error) { return nil, fmt.Errorf("client not connected") } // Cache miss - fetch from backend while holding lock - result, err := c.client.Request("models.list", listModelsRequest{}) + result, err := c.client.Request(ctx, "models.list", listModelsRequest{}) if err != nil { return nil, err } @@ -1554,6 +1825,8 @@ func (c *Client) ListModels(ctx context.Context) ([]ModelInfo, error) { // minProtocolVersion is the minimum protocol version this SDK can communicate with. const minProtocolVersion = 3 +const runtimeShutdownTimeout = 10 * time.Second +const processExitTimeout = 10 * time.Second // verifyProtocolVersion sends the `connect` handshake (carrying the optional token) and // verifies the server's protocol version. Falls back to `ping` against legacy servers @@ -1562,7 +1835,7 @@ func (c *Client) verifyProtocolVersion(ctx context.Context) error { if c.client == nil { return fmt.Errorf("client not connected") } - maxVersion := GetSdkProtocolVersion() + maxVersion := GetSDKProtocolVersion() var serverVersion *int tokenPtr := (*string)(nil) @@ -1570,7 +1843,15 @@ func (c *Client) verifyProtocolVersion(ctx context.Context) error { t := c.effectiveConnectionToken tokenPtr = &t } - connectResult, err := c.internalRPC.Connect(ctx, &rpc.ConnectRequest{Token: tokenPtr}) + connectReq := &connectHandshakeRequest{Token: tokenPtr} + // Opt in to GitHub telemetry forwarding at the connection level when a handler is + // registered (mirrors the runtime, which reads this flag on the `connect` handshake + // so the first session's un-replayable `session.start` event is forwarded). Also + // sent on session.create/resume for older CLIs. + if c.options.OnGitHubTelemetry != nil { + connectReq.EnableGitHubTelemetryForwarding = Bool(true) + } + rawConnectResult, err := c.client.Request(ctx, "connect", connectReq) if err != nil { var rpcErr *jsonrpc2.Error if errors.As(err, &rpcErr) && (rpcErr.Code == jsonrpc2.ErrMethodNotFound.Code || rpcErr.Message == "Unhandled method connect") { @@ -1585,6 +1866,10 @@ func (c *Client) verifyProtocolVersion(ctx context.Context) error { return err } } else { + var connectResult rpc.ConnectResult + if err := json.Unmarshal(rawConnectResult, &connectResult); err != nil { + return err + } v := int(connectResult.ProtocolVersion) serverVersion = &v } @@ -1601,6 +1886,11 @@ func (c *Client) verifyProtocolVersion(ctx context.Context) error { return nil } +type connectHandshakeRequest struct { + Token *string `json:"token,omitempty"` + EnableGitHubTelemetryForwarding *bool `json:"enableGitHubTelemetryForwarding,omitempty"` +} + // stderrBufferSize is the maximum number of bytes kept from the CLI process's // stderr. Only the tail is retained so that memory stays bounded even when the // process produces a large amount of diagnostic output. @@ -1611,6 +1901,10 @@ const stderrBufferSize = 64 * 1024 // This spawns the CLI server as a subprocess using the configured transport // mode (stdio or TCP). func (c *Client) startCLIServer(ctx context.Context) error { + if c.useInProcess { + return c.startInProcess(ctx) + } + cliPath := c.cliPath if cliPath == "" { // If no CLI path is provided, attempt to use the embedded CLI if available @@ -1701,6 +1995,9 @@ func (c *Client) startCLIServer(ctx context.Context) error { if t.OTLPEndpoint != "" { c.process.Env = setEnvValue(c.process.Env, "OTEL_EXPORTER_OTLP_ENDPOINT", t.OTLPEndpoint) } + if t.OTLPProtocol != "" { + c.process.Env = setEnvValue(c.process.Env, "OTEL_EXPORTER_OTLP_PROTOCOL", t.OTLPProtocol) + } if t.FilePath != "" { c.process.Env = setEnvValue(c.process.Env, "COPILOT_OTEL_FILE_EXPORTER_PATH", t.FilePath) } @@ -1751,8 +2048,8 @@ func (c *Client) startCLIServer(ctx context.Context) error { c.state = stateDisconnected }() }) - c.RPC = rpc.NewServerRpc(c.client) - c.internalRPC = rpc.NewInternalServerRpc(c.client) + c.RPC = rpc.NewServerRPC(c.client) + c.internalRPC = rpc.NewInternalServerRPC(c.client) c.setupNotificationHandler() c.client.Start() @@ -1817,7 +2114,122 @@ func (c *Client) startCLIServer(ctx context.Context) error { } } +// startInProcess loads the native runtime library and wires the JSON-RPC client +// to its FFI byte streams. +func (c *Client) startInProcess(ctx context.Context) error { + if !inProcessAvailable { + return errors.New("in-process transport unavailable: rebuild with -tags copilot_inprocess on a supported platform") + } + + runtimePath := c.cliPath + if runtimePath == "" { + // The in-process transport does not resolve a bare command name from PATH + // (unlike the child-process transport). + if p := getEnvValue(c.options.Env, "COPILOT_CLI_PATH"); p != "" { + runtimePath = p + } + } + if runtimePath == "" { + runtimePath = embeddedcli.Path() + } + if runtimePath == "" { + return errors.New("in-process runtime unavailable: set COPILOT_CLI_PATH to a compatible runtime package or build with the bundled embedded runtime") + } + + config := c.inProcessHostConfig() + + host, err := createInProcessHost(runtimePath, config) + if err != nil { + return err + } + // Own the host before the blocking handshake so a cancelled or failed start + // leaves it disposable by Stop/ForceStop rather than leaking (host.Start runs + // on its own goroutine and cannot be interrupted once the native call begins). + c.ffiHost = host + + errCh := make(chan error, 1) + go func() { errCh <- host.Start() }() + select { + case err := <-errCh: + if err != nil { + host.Dispose() + c.ffiHost = nil + return err + } + case <-ctx.Done(): + c.ffiHost = nil + go func() { + <-errCh + host.Dispose() + }() + return ctx.Err() + } + + c.client = jsonrpc2.NewClient(host.Writer(), host.Reader()) + c.client.SetOnClose(func() { + // Run in a goroutine to avoid deadlocking with Stop/ForceStop, which hold + // startStopMux while waiting for readLoop to finish. + go func() { + c.startStopMux.Lock() + defer c.startStopMux.Unlock() + c.state = stateDisconnected + }() + }) + c.RPC = rpc.NewServerRPC(c.client) + c.internalRPC = rpc.NewInternalServerRPC(c.client) + c.setupNotificationHandler() + c.client.Start() + return nil +} + +func (c *Client) inProcessHostConfig() inProcessHostConfig { + args := make([]string, 0, 8) + if c.options.LogLevel != "" { + args = append(args, "--log-level", c.options.LogLevel) + } + if c.options.GitHubToken != "" { + args = append(args, "--auth-token-env", "COPILOT_SDK_AUTH_TOKEN") + } + useLoggedInUser := true + if c.options.UseLoggedInUser != nil { + useLoggedInUser = *c.options.UseLoggedInUser + } else if c.options.GitHubToken != "" { + useLoggedInUser = false + } + if !useLoggedInUser { + args = append(args, "--no-auto-login") + } + if c.options.SessionIdleTimeoutSeconds > 0 { + args = append(args, "--session-idle-timeout", strconv.Itoa(c.options.SessionIdleTimeoutSeconds)) + } + if c.options.EnableRemoteSessions { + args = append(args, "--remote") + } + + environment := make(map[string]string) + if c.options.GitHubToken != "" { + environment["COPILOT_SDK_AUTH_TOKEN"] = c.options.GitHubToken + } + if c.options.BaseDirectory != "" { + environment["COPILOT_HOME"] = c.options.BaseDirectory + } + if c.options.Mode == ModeEmpty { + environment["COPILOT_DISABLE_KEYTAR"] = "1" + } + + return inProcessHostConfig{ + Environment: environment, + Args: args, + } +} + func (c *Client) killProcess() error { + // Tear down the in-process FFI host on error paths that reuse killProcess to + // abort a start (there is no OS process to kill in that mode). + if c.ffiHost != nil { + c.ffiHost.Dispose() + c.ffiHost = nil + } if p := c.osProcess.Swap(nil); p != nil { if err := p.Kill(); err != nil { return fmt.Errorf("failed to kill CLI process: %w", err) @@ -1827,6 +2239,21 @@ func (c *Client) killProcess() error { return nil } +func (c *Client) killProcessAndWait() error { + done := c.processDone + killErr := c.killProcess() + if done == nil { + return killErr + } + + select { + case <-done: + return killErr + case <-time.After(processExitTimeout): + return errors.Join(killErr, fmt.Errorf("timed out waiting for CLI process to exit after kill")) + } +} + // monitorProcess signals when the CLI process exits and captures any exit error. // processError is intentionally a local: each process lifecycle gets its own // error value, so goroutines from previous processes can't overwrite the @@ -1864,17 +2291,17 @@ func (c *Client) monitorProcess() { // connectToServer establishes a connection to the server. func (c *Client) connectToServer(ctx context.Context) error { - if c.useStdio { - // Already connected via stdio in startCLIServer + if c.useStdio || c.useInProcess { + // Already connected: stdio in startCLIServer, FFI streams in startInProcess. return nil } // Connect via TCP - return c.connectViaTcp(ctx) + return c.connectViaTCP(ctx) } -// connectViaTcp connects to the CLI server via TCP socket. -func (c *Client) connectViaTcp(ctx context.Context) error { +// connectViaTCP connects to the CLI server via TCP socket. +func (c *Client) connectViaTCP(ctx context.Context) error { if c.actualPort == 0 { return fmt.Errorf("server port not available") } @@ -1904,8 +2331,8 @@ func (c *Client) connectViaTcp(ctx context.Context) error { c.state = stateDisconnected }() }) - c.RPC = rpc.NewServerRpc(c.client) - c.internalRPC = rpc.NewInternalServerRpc(c.client) + c.RPC = rpc.NewServerRPC(c.client) + c.internalRPC = rpc.NewInternalServerRPC(c.client) c.setupNotificationHandler() c.client.Start() @@ -1919,17 +2346,47 @@ func (c *Client) setupNotificationHandler() { c.client.SetRequestHandler("userInput.request", jsonrpc2.RequestHandlerFor(c.handleUserInputRequest)) c.client.SetRequestHandler("exitPlanMode.request", jsonrpc2.RequestHandlerFor(c.handleExitPlanModeRequest)) c.client.SetRequestHandler("autoModeSwitch.request", jsonrpc2.RequestHandlerFor(c.handleAutoModeSwitchRequest)) - c.client.SetRequestHandler("hooks.invoke", jsonrpc2.RequestHandlerFor(c.handleHooksInvoke)) c.client.SetRequestHandler("systemMessage.transform", jsonrpc2.RequestHandlerFor(c.handleSystemMessageTransform)) - rpc.RegisterClientSessionApiHandlers(c.client, func(sessionID string) *rpc.ClientSessionApiHandlers { + rpc.RegisterClientSessionAPIHandlers(c.client, func(sessionID string) *rpc.ClientSessionAPIHandlers { c.sessionsMux.Lock() defer c.sessionsMux.Unlock() session := c.sessions[sessionID] if session == nil { return nil } - return session.clientSessionApis + return session.clientSessionAPIs }) + // hooks.invoke is a client-global RPC method: one connection-level handler + // receives every hook callback and routes to the owning session via the + // payload's sessionId. Always register the global handlers so the generated + // hooks.invoke handler is wired to our dispatcher. + handlers := &rpc.ClientGlobalAPIHandlers{ + Hooks: &hooksAdapter{client: c}, + } + if c.options.RequestHandler != nil { + handlers.LlmInference = newCopilotRequestAdapter(c.options.RequestHandler, func() *rpc.ServerLlmInferenceAPI { + if c.RPC == nil { + return nil + } + return c.RPC.LlmInference + }) + } + if c.options.OnGitHubTelemetry != nil { + handlers.GitHubTelemetry = &gitHubTelemetryAdapter{callback: c.options.OnGitHubTelemetry} + } + rpc.RegisterClientGlobalAPIHandlers(c.client, handlers) +} + +// gitHubTelemetryAdapter adapts the OnGitHubTelemetry option to the generated +// rpc.GitHubTelemetryHandler interface. +type gitHubTelemetryAdapter struct { + callback func(notification *rpc.GitHubTelemetryNotification) +} + +func (a *gitHubTelemetryAdapter) Event(request *rpc.GitHubTelemetryNotification) error { + defer func() { recover() }() // Ignore handler panics + a.callback(request) + return nil } func (c *Client) handleSessionEvent(req sessionEventRequest) { @@ -2025,7 +2482,8 @@ func (c *Client) handleAutoModeSwitchRequest(req autoModeSwitchRequest) (*autoMo return &autoModeSwitchResponse{Response: response}, nil } -// handleHooksInvoke handles a hooks invocation from the CLI server. +// handleHooksInvoke routes a hook callback to its owning session, keyed by the +// payload's sessionId. func (c *Client) handleHooksInvoke(req hooksInvokeRequest) (map[string]any, *jsonrpc2.Error) { if req.SessionID == "" || req.Type == "" { return nil, &jsonrpc2.Error{Code: -32602, Message: "invalid hooks invoke payload"} @@ -2050,6 +2508,34 @@ func (c *Client) handleHooksInvoke(req hooksInvokeRequest) (map[string]any, *jso return result, nil } +// hooksAdapter implements the generated rpc.HooksHandler, delegating to the +// client's per-session hook dispatcher. +type hooksAdapter struct { + client *Client +} + +func (a *hooksAdapter) Invoke(request *rpc.HookInvokeRequest) (*rpc.HookInvokeResponse, error) { + rawInput, err := json.Marshal(request.Input) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("invalid hooks invoke payload: %v", err)} + } + + result, rpcErr := a.client.handleHooksInvoke(hooksInvokeRequest{ + SessionID: request.SessionID, + Type: string(request.HookType), + Input: rawInput, + }) + if rpcErr != nil { + return nil, rpcErr + } + + response := &rpc.HookInvokeResponse{} + if result != nil { + response.Output = result["output"] + } + return response, nil +} + // handleSystemMessageTransform handles a system message transform request from the CLI server. func (c *Client) handleSystemMessageTransform(req systemMessageTransformRequest) (systemMessageTransformResponse, *jsonrpc2.Error) { if req.SessionID == "" { diff --git a/go/client_test.go b/go/client_test.go index 3f3ca64ea..f21442679 100644 --- a/go/client_test.go +++ b/go/client_test.go @@ -3,6 +3,9 @@ package copilot import ( "context" "encoding/json" + "fmt" + "io" + "net" "os" "os/exec" "path/filepath" @@ -12,7 +15,9 @@ import ( "strings" "sync" "testing" + "time" + "github.com/github/copilot-sdk/go/internal/jsonrpc2" "github.com/github/copilot-sdk/go/internal/truncbuffer" "github.com/github/copilot-sdk/go/rpc" ) @@ -22,7 +27,7 @@ import ( func TestClient_URLParsing(t *testing.T) { t.Run("should parse port-only URL format", func(t *testing.T) { client := NewClient(&ClientOptions{ - Connection: UriConnection{URL: "8080"}, + Connection: URIConnection{URL: "8080"}, }) if client.actualPort != 8080 { t.Errorf("Expected port 8080, got %d", client.actualPort) @@ -37,7 +42,7 @@ func TestClient_URLParsing(t *testing.T) { t.Run("should parse host:port URL format", func(t *testing.T) { client := NewClient(&ClientOptions{ - Connection: UriConnection{URL: "127.0.0.1:9000"}, + Connection: URIConnection{URL: "127.0.0.1:9000"}, }) if client.actualPort != 9000 || client.actualHost != "127.0.0.1" { t.Errorf("Expected 127.0.0.1:9000, got %s:%d", client.actualHost, client.actualPort) @@ -46,7 +51,7 @@ func TestClient_URLParsing(t *testing.T) { t.Run("should parse http://host:port URL format", func(t *testing.T) { client := NewClient(&ClientOptions{ - Connection: UriConnection{URL: "http://localhost:7000"}, + Connection: URIConnection{URL: "http://localhost:7000"}, }) if client.actualPort != 7000 || client.actualHost != "localhost" { t.Errorf("Expected localhost:7000, got %s:%d", client.actualHost, client.actualPort) @@ -55,7 +60,7 @@ func TestClient_URLParsing(t *testing.T) { t.Run("should parse https://host:port URL format", func(t *testing.T) { client := NewClient(&ClientOptions{ - Connection: UriConnection{URL: "https://example.com:443"}, + Connection: URIConnection{URL: "https://example.com:443"}, }) if client.actualPort != 443 || client.actualHost != "example.com" { t.Errorf("Expected example.com:443, got %s:%d", client.actualHost, client.actualPort) @@ -68,7 +73,7 @@ func TestClient_URLParsing(t *testing.T) { t.Error("Expected panic for invalid URL format") } }() - NewClient(&ClientOptions{Connection: UriConnection{URL: "invalid-url"}}) + NewClient(&ClientOptions{Connection: URIConnection{URL: "invalid-url"}}) }) t.Run("should panic for invalid port - too high", func(t *testing.T) { @@ -77,7 +82,7 @@ func TestClient_URLParsing(t *testing.T) { t.Error("Expected panic") } }() - NewClient(&ClientOptions{Connection: UriConnection{URL: "localhost:99999"}}) + NewClient(&ClientOptions{Connection: URIConnection{URL: "localhost:99999"}}) }) t.Run("should panic for invalid port - zero", func(t *testing.T) { @@ -86,7 +91,7 @@ func TestClient_URLParsing(t *testing.T) { t.Error("Expected panic") } }() - NewClient(&ClientOptions{Connection: UriConnection{URL: "localhost:0"}}) + NewClient(&ClientOptions{Connection: URIConnection{URL: "localhost:0"}}) }) t.Run("should panic for invalid port - negative", func(t *testing.T) { @@ -95,16 +100,16 @@ func TestClient_URLParsing(t *testing.T) { t.Error("Expected panic") } }() - NewClient(&ClientOptions{Connection: UriConnection{URL: "localhost:-1"}}) + NewClient(&ClientOptions{Connection: URIConnection{URL: "localhost:-1"}}) }) - t.Run("should panic when UriConnection has empty URL", func(t *testing.T) { + t.Run("should panic when URIConnection has empty URL", func(t *testing.T) { defer func() { if r := recover(); r == nil { t.Error("Expected panic for empty URL") } }() - NewClient(&ClientOptions{Connection: UriConnection{}}) + NewClient(&ClientOptions{Connection: URIConnection{}}) }) t.Run("stdio connection uses stdio transport", func(t *testing.T) { @@ -115,9 +120,9 @@ func TestClient_URLParsing(t *testing.T) { }) t.Run("tcp connection uses tcp transport", func(t *testing.T) { - client := NewClient(&ClientOptions{Connection: TcpConnection{Port: 8080}}) + client := NewClient(&ClientOptions{Connection: TCPConnection{Port: 8080}}) if client.useStdio { - t.Error("Expected useStdio=false for TcpConnection") + t.Error("Expected useStdio=false for TCPConnection") } if client.port != 8080 { t.Errorf("Expected port=8080, got %d", client.port) @@ -126,31 +131,590 @@ func TestClient_URLParsing(t *testing.T) { t.Run("uri connection is treated as external server", func(t *testing.T) { client := NewClient(&ClientOptions{ - Connection: UriConnection{URL: "localhost:8080"}, + Connection: URIConnection{URL: "localhost:8080"}, }) if !client.isExternalServer { - t.Error("Expected isExternalServer=true for UriConnection") + t.Error("Expected isExternalServer=true for URIConnection") } }) } -func TestClient_SessionFsConfig(t *testing.T) { +func TestClient_BuiltinPluginDirectories(t *testing.T) { + t.Run("default and empty do not call RPC", func(t *testing.T) { + for _, paths := range [][]string{nil, []string{}} { + t.Run(fmt.Sprintf("len=%d", len(paths)), func(t *testing.T) { + url, requests, cleanup := newStartupRPCServer(t) + defer cleanup() + + client := NewClient(&ClientOptions{ + Connection: URIConnection{URL: url}, + BuiltinPluginDirectories: paths, + }) + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + defer client.ForceStop() + + if got := countMethod(requests(), "plugins.builtin.set"); got != 0 { + t.Fatalf("plugins.builtin.set call count = %d, want 0", got) + } + }) + } + }) + + t.Run("configured paths call RPC once", func(t *testing.T) { + url, requests, cleanup := newStartupRPCServer(t) + defer cleanup() + cwd, err := os.Getwd() + if err != nil { + t.Fatalf("Getwd failed: %v", err) + } + paths := []string{ + filepath.Join(cwd, "plugins", "core"), + filepath.Join(cwd, "plugins", "github"), + } + + client := NewClient(&ClientOptions{ + Connection: URIConnection{URL: url}, + BuiltinPluginDirectories: paths, + }) + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + defer client.ForceStop() + + var calls []startupRPCRequest + for _, request := range requests() { + if request.Method == "plugins.builtin.set" { + calls = append(calls, request) + } + } + if len(calls) != 1 { + t.Fatalf("plugins.builtin.set call count = %d, want 1", len(calls)) + } + var payload struct { + Paths []string `json:"paths"` + } + if err := json.Unmarshal(calls[0].Params, &payload); err != nil { + t.Fatalf("decode plugins.builtin.set params: %v", err) + } + if !reflect.DeepEqual(payload.Paths, paths) { + t.Fatalf("paths = %v, want %v", payload.Paths, paths) + } + }) + + t.Run("relative path panics", func(t *testing.T) { + defer func() { + if recovered := recover(); recovered == nil { + t.Fatal("expected NewClient to panic") + } + }() + NewClient(&ClientOptions{BuiltinPluginDirectories: []string{"plugins/core"}}) + }) + + t.Run("startup RPC failure clears transport for reconnect", func(t *testing.T) { + url, _, cleanup := newStartupRPCServerWithBuiltinFailure(t, true) + defer cleanup() + cwd, err := os.Getwd() + if err != nil { + t.Fatalf("Getwd failed: %v", err) + } + client := NewClient(&ClientOptions{ + Connection: URIConnection{URL: url}, + BuiltinPluginDirectories: []string{filepath.Join(cwd, "plugins", "core")}, + }) + + if err := client.Start(t.Context()); err == nil { + t.Fatal("Start unexpectedly succeeded") + } + if client.client != nil { + t.Fatal("client transport was not cleared after startup RPC failure") + } + if client.conn != nil { + t.Fatal("connection was not cleared after startup RPC failure") + } + if client.RPC != nil { + t.Fatal("typed RPC client was not cleared after startup RPC failure") + } + if client.internalRPC != nil { + t.Fatal("internal RPC client was not cleared after startup RPC failure") + } + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("second Start failed: %v", err) + } + defer client.ForceStop() + }) +} + +type startupRPCRequest struct { + Method string + Params json.RawMessage +} + +func newStartupRPCServer(t *testing.T) (string, func() []startupRPCRequest, func()) { + return newStartupRPCServerWithBuiltinFailure(t, false) +} + +func newStartupRPCServerWithBuiltinFailure(t *testing.T, failFirstBuiltin bool) (string, func() []startupRPCRequest, func()) { + t.Helper() + listener, err := net.Listen("tcp", "127.0.0.1:0") + if err != nil { + t.Fatalf("listen: %v", err) + } + + var mux sync.Mutex + var requests []startupRPCRequest + serverReady := make(chan *jsonrpc2.Client, 8) + var builtinSetCount int + go func() { + for { + conn, acceptErr := listener.Accept() + if acceptErr != nil { + return + } + server := jsonrpc2.NewClient(conn, conn) + record := func(method string, params json.RawMessage) { + mux.Lock() + requests = append(requests, startupRPCRequest{ + Method: method, + Params: append(json.RawMessage(nil), params...), + }) + mux.Unlock() + } + server.SetRequestHandler("connect", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + record("connect", params) + return []byte(`{"ok":true,"protocolVersion":3,"version":"test"}`), nil + }) + server.SetRequestHandler("plugins.builtin.set", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + record("plugins.builtin.set", params) + mux.Lock() + builtinSetCount++ + shouldFail := failFirstBuiltin && builtinSetCount == 1 + mux.Unlock() + if shouldFail { + return nil, &jsonrpc2.Error{Code: -32000, Message: "builtin registration failed"} + } + return []byte(`{}`), nil + }) + server.Start() + serverReady <- server + } + }() + + snapshot := func() []startupRPCRequest { + mux.Lock() + defer mux.Unlock() + return append([]startupRPCRequest(nil), requests...) + } + cleanup := func() { + listener.Close() + for { + select { + case server := <-serverReady: + server.Stop() + case <-time.After(time.Second): + return + default: + return + } + } + } + return listener.Addr().String(), snapshot, cleanup +} + +func countMethod(requests []startupRPCRequest, method string) int { + count := 0 + for _, request := range requests { + if request.Method == method { + count++ + } + } + return count +} + +func TestClient_StopRequestsRuntimeShutdownForOwnedProcess(t *testing.T) { + rpcClient, server, shutdownCalled := newRuntimeShutdownRpcPair(t) + client := &Client{ + process: &exec.Cmd{}, + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + processDone: make(chan struct{}), + } + close(client.processDone) + + if err := client.Stop(); err != nil { + t.Fatalf("Stop failed: %v", err) + } + + select { + case <-shutdownCalled: + default: + t.Fatal("Stop did not request runtime.shutdown") + } + + server.Stop() +} + +func TestClient_ForceStopAndExternalStopDoNotRequestRuntimeShutdown(t *testing.T) { + rpcClient, server, shutdownCalled := newRuntimeShutdownRpcPair(t) + client := &Client{ + process: &exec.Cmd{}, + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + client.ForceStop() + assertRuntimeShutdownNotCalled(t, shutdownCalled) + server.Stop() + + externalRpcClient, externalServer, externalShutdownCalled := newRuntimeShutdownRpcPair(t) + externalClient := &Client{ + client: externalRpcClient, + RPC: rpc.NewServerRPC(externalRpcClient), + sessions: make(map[string]*Session), + isExternalServer: true, + } + + if err := externalClient.Stop(); err != nil { + t.Fatalf("external Stop failed: %v", err) + } + assertRuntimeShutdownNotCalled(t, externalShutdownCalled) + externalServer.Stop() +} + +func newRuntimeShutdownRpcPair(t *testing.T) (*jsonrpc2.Client, *jsonrpc2.Client, chan struct{}) { + t.Helper() + + clientConn, serverConn := net.Pipe() + t.Cleanup(func() { + clientConn.Close() + serverConn.Close() + }) + + rpcClient := jsonrpc2.NewClient(clientConn, clientConn) + server := jsonrpc2.NewClient(serverConn, serverConn) + shutdownCalled := make(chan struct{}, 1) + server.SetRequestHandler("runtime.shutdown", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + shutdownCalled <- struct{}{} + return []byte(`{}`), nil + }) + rpcClient.Start() + server.Start() + return rpcClient, server, shutdownCalled +} + +func TestClient_ForwardsCapiOptionsToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + _, err := client.CreateSession(t.Context(), &SessionConfig{ + Capi: &CapiSessionOptions{EnableWebSocketResponses: Bool(false)}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertCapiEnableWebSocketResponses(t, <-createParams) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-capi","workspacePath":"/workspace"}`), nil + }) + + _, err = client.ResumeSessionWithOptions(t.Context(), "resumed-capi", &ResumeSessionConfig{ + Capi: &CapiSessionOptions{EnableWebSocketResponses: Bool(false)}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertCapiEnableWebSocketResponses(t, <-resumeParams) +} + +func TestClient_ForwardsAdditionalDirectoriesToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + _, err := client.CreateSession(t.Context(), &SessionConfig{ + AdditionalDirectories: []string{"/repo/shared", "/repo/generated"}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertAdditionalDirectories(t, <-createParams, []string{"/repo/shared", "/repo/generated"}) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-additional-directories","workspacePath":"/workspace"}`), nil + }) + + _, err = client.ResumeSessionWithOptions( + t.Context(), + "resumed-additional-directories", + &ResumeSessionConfig{AdditionalDirectories: []string{"/repo/resumed"}}, + ) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertAdditionalDirectories(t, <-resumeParams, []string{"/repo/resumed"}) +} + +func assertAdditionalDirectories(t *testing.T, params json.RawMessage, want []string) { + t.Helper() + var payload struct { + AdditionalDirectories []string `json:"additionalDirectories"` + } + if err := json.Unmarshal(params, &payload); err != nil { + t.Fatalf("failed to decode request params: %v", err) + } + if !reflect.DeepEqual(payload.AdditionalDirectories, want) { + t.Fatalf("additionalDirectories = %v, want %v", payload.AdditionalDirectories, want) + } +} + +func TestClient_ForwardsCanvasProviderToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + _, err := client.CreateSession(t.Context(), &SessionConfig{ + ExtensionInfo: &ExtensionInfo{Source: "github-app", Name: "counter-provider"}, + CanvasProvider: &CanvasProviderIdentity{ID: "app:builtin:window-1", Name: String("Built-in")}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertCanvasProviderForwarded(t, <-createParams, "app:builtin:window-1", "Built-in", "counter-provider") + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-canvas","workspacePath":"/workspace"}`), nil + }) + + _, err = client.ResumeSessionWithOptions(t.Context(), "resumed-canvas", &ResumeSessionConfig{ + CanvasProvider: &CanvasProviderIdentity{ID: "app:builtin:window-1"}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertCanvasProviderForwarded(t, <-resumeParams, "app:builtin:window-1", "", "") +} + +// assertCanvasProviderForwarded checks the outbound params carry canvasProvider +// with the expected id. A non-empty wantName asserts the name is present; an +// empty wantName asserts the name key is omitted from the wire. A non-empty +// wantExtensionName asserts extensionInfo.name is forwarded alongside it. +func assertCanvasProviderForwarded(t *testing.T, params json.RawMessage, wantID, wantName, wantExtensionName string) { + t.Helper() + + var decoded map[string]any + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + provider, ok := decoded["canvasProvider"].(map[string]any) + if !ok { + t.Fatalf("expected canvasProvider object in request params, got %T", decoded["canvasProvider"]) + } + if provider["id"] != wantID { + t.Fatalf("expected canvasProvider.id=%q, got %v", wantID, provider["id"]) + } + if wantName == "" { + if _, present := provider["name"]; present { + t.Fatalf("expected canvasProvider.name to be omitted, got %v", provider["name"]) + } + } else if provider["name"] != wantName { + t.Fatalf("expected canvasProvider.name=%q, got %v", wantName, provider["name"]) + } + if wantExtensionName != "" { + info, ok := decoded["extensionInfo"].(map[string]any) + if !ok { + t.Fatalf("expected extensionInfo object in request params, got %T", decoded["extensionInfo"]) + } + if info["name"] != wantExtensionName { + t.Fatalf("expected extensionInfo.name=%q, got %v", wantExtensionName, info["name"]) + } + } +} + +func TestClient_ForwardsNewSessionOptionsToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + _, err := client.CreateSession(t.Context(), &SessionConfig{ + ExcludedBuiltInAgents: []string{"explore"}, + EnableCitations: Bool(true), + EnableFileChangeTracking: Bool(true), + SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ptr(30)}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertNewSessionOptions(t, <-createParams, true, true, "explore", 30) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-options","workspacePath":"/workspace"}`), nil + }) + + _, err = client.ResumeSessionWithOptions(t.Context(), "resumed-options", &ResumeSessionConfig{ + ExcludedBuiltInAgents: []string{"task"}, + EnableCitations: Bool(false), + EnableFileChangeTracking: Bool(false), + SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ptr(15)}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertNewSessionOptions(t, <-resumeParams, false, false, "task", 15) +} + +func assertCapiEnableWebSocketResponses(t *testing.T, params json.RawMessage) { + t.Helper() + + var decoded map[string]any + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + + capi, ok := decoded["capi"].(map[string]any) + if !ok { + t.Fatalf("expected capi object in request params, got %T", decoded["capi"]) + } + if capi["enableWebSocketResponses"] != false { + t.Fatalf("expected capi.enableWebSocketResponses=false, got %v", capi["enableWebSocketResponses"]) + } +} + +func assertNewSessionOptions( + t *testing.T, + params json.RawMessage, + expectedCitations bool, + expectedFileChangeTracking bool, + expectedAgent string, + expectedCredits float64, +) { + t.Helper() + + var decoded map[string]any + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + if decoded["enableCitations"] != expectedCitations { + t.Fatalf("expected enableCitations=%v, got %v", expectedCitations, decoded["enableCitations"]) + } + if decoded["enableFileChangeTracking"] != expectedFileChangeTracking { + t.Fatalf("expected enableFileChangeTracking=%v, got %v", expectedFileChangeTracking, decoded["enableFileChangeTracking"]) + } + agents, ok := decoded["excludedBuiltinAgents"].([]any) + if !ok || len(agents) != 1 || agents[0] != expectedAgent { + t.Fatalf("expected excludedBuiltinAgents=[%q], got %#v", expectedAgent, decoded["excludedBuiltinAgents"]) + } + limits, ok := decoded["sessionLimits"].(map[string]any) + if !ok { + t.Fatalf("expected sessionLimits object, got %T", decoded["sessionLimits"]) + } + if limits["maxAiCredits"] != expectedCredits { + t.Fatalf("expected sessionLimits.maxAiCredits=%v, got %v", expectedCredits, limits["maxAiCredits"]) + } +} + +func float64Ptr(value float64) *float64 { + return &value +} + +func sessionIDFromParams(t *testing.T, params json.RawMessage) string { + t.Helper() + + var decoded struct { + SessionID string `json:"sessionId"` + } + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + if decoded.SessionID == "" { + t.Fatal("expected generated sessionId in request params") + } + return decoded.SessionID +} + +func assertRuntimeShutdownNotCalled(t *testing.T, shutdownCalled <-chan struct{}) { + t.Helper() + select { + case <-shutdownCalled: + t.Fatal("runtime.shutdown should not have been requested") + default: + } +} + +func TestClient_SessionFSConfig(t *testing.T) { t.Run("should throw error when InitialWorkingDirectory is missing", func(t *testing.T) { defer func() { if r := recover(); r == nil { - t.Error("Expected panic for missing SessionFs.InitialWorkingDirectory") + t.Error("Expected panic for missing SessionFS.InitialWorkingDirectory") } else { - matched, _ := regexp.MatchString("SessionFs.InitialWorkingDirectory is required", r.(string)) + matched, _ := regexp.MatchString("SessionFS.InitialWorkingDirectory is required", r.(string)) if !matched { - t.Errorf("Expected panic message to contain 'SessionFs.InitialWorkingDirectory is required', got: %v", r) + t.Errorf("Expected panic message to contain 'SessionFS.InitialWorkingDirectory is required', got: %v", r) } } }() NewClient(&ClientOptions{ - SessionFs: &SessionFsConfig{ + SessionFS: &SessionFSConfig{ SessionStatePath: "/session-state", - Conventions: rpc.SessionFsSetProviderConventionsPosix, + Conventions: rpc.SessionFSSetProviderConventionsPosix, }, }) }) @@ -158,19 +722,19 @@ func TestClient_SessionFsConfig(t *testing.T) { t.Run("should throw error when SessionStatePath is missing", func(t *testing.T) { defer func() { if r := recover(); r == nil { - t.Error("Expected panic for missing SessionFs.SessionStatePath") + t.Error("Expected panic for missing SessionFS.SessionStatePath") } else { - matched, _ := regexp.MatchString("SessionFs.SessionStatePath is required", r.(string)) + matched, _ := regexp.MatchString("SessionFS.SessionStatePath is required", r.(string)) if !matched { - t.Errorf("Expected panic message to contain 'SessionFs.SessionStatePath is required', got: %v", r) + t.Errorf("Expected panic message to contain 'SessionFS.SessionStatePath is required', got: %v", r) } } }() NewClient(&ClientOptions{ - SessionFs: &SessionFsConfig{ + SessionFS: &SessionFSConfig{ InitialWorkingDirectory: "/", - Conventions: rpc.SessionFsSetProviderConventionsPosix, + Conventions: rpc.SessionFSSetProviderConventionsPosix, }, }) }) @@ -216,12 +780,12 @@ func TestClient_AuthOptions(t *testing.T) { } }) - t.Run("should panic when GitHubToken is used with UriConnection", func(t *testing.T) { + t.Run("should panic when GitHubToken is used with URIConnection", func(t *testing.T) { defer func() { if r := recover(); r == nil { - t.Error("Expected panic for auth options with UriConnection") + t.Error("Expected panic for auth options with URIConnection") } else { - matched, _ := regexp.MatchString("GitHubToken and UseLoggedInUser cannot be used with UriConnection", r.(string)) + matched, _ := regexp.MatchString("GitHubToken and UseLoggedInUser cannot be used with URIConnection", r.(string)) if !matched { t.Errorf("Expected panic message about auth options, got: %v", r) } @@ -229,20 +793,20 @@ func TestClient_AuthOptions(t *testing.T) { }() NewClient(&ClientOptions{ - Connection: UriConnection{URL: "localhost:8080"}, + Connection: URIConnection{URL: "localhost:8080"}, GitHubToken: "gho_test_token", }) }) - t.Run("should panic when UseLoggedInUser is used with UriConnection", func(t *testing.T) { + t.Run("should panic when UseLoggedInUser is used with URIConnection", func(t *testing.T) { defer func() { if r := recover(); r == nil { - t.Error("Expected panic for auth options with UriConnection") + t.Error("Expected panic for auth options with URIConnection") } }() NewClient(&ClientOptions{ - Connection: UriConnection{URL: "localhost:8080"}, + Connection: URIConnection{URL: "localhost:8080"}, UseLoggedInUser: Bool(false), }) }) @@ -315,6 +879,198 @@ func TestClient_EnvOptions(t *testing.T) { }) } +func TestClient_InProcessConnection(t *testing.T) { + t.Run("requires build tag", func(t *testing.T) { + if inProcessAvailable { + t.Skip("in-process transport is enabled") + } + + client := NewClient(&ClientOptions{Connection: InProcessConnection{}}) + err := client.Start(context.Background()) + if err == nil || !strings.Contains(err.Error(), "-tags copilot_inprocess") { + t.Fatalf("Expected build-tag error, got %v", err) + } + }) + + t.Run("uses in-process transport", func(t *testing.T) { + client := NewClient(&ClientOptions{Connection: InProcessConnection{}}) + if !client.useInProcess { + t.Error("Expected useInProcess=true for InProcessConnection") + } + if client.useStdio { + t.Error("Expected useStdio=false for InProcessConnection") + } + if client.isExternalServer { + t.Error("Expected isExternalServer=false for InProcessConnection") + } + if client.cliPath != "" { + t.Errorf("Expected in-process cliPath to stay empty at construction, got %q", client.cliPath) + } + }) + + t.Run("does not resolve COPILOT_CLI_PATH into cliPath at construction", func(t *testing.T) { + t.Setenv("COPILOT_CLI_PATH", "/from/env/copilot") + client := NewClient(&ClientOptions{Connection: InProcessConnection{}}) + if client.cliPath != "" { + t.Errorf("Expected in-process cliPath to stay empty at construction, got %q", client.cliPath) + } + }) + + t.Run("panics when Env is set", func(t *testing.T) { + defer func() { + if r := recover(); r == nil { + t.Error("Expected panic when Env is set with InProcessConnection") + } + }() + NewClient(&ClientOptions{ + Connection: InProcessConnection{}, + Env: []string{"FOO=bar"}, + }) + }) + + t.Run("panics when WorkingDirectory is set", func(t *testing.T) { + defer func() { + if r := recover(); r == nil { + t.Error("Expected panic when WorkingDirectory is set with InProcessConnection") + } + }() + NewClient(&ClientOptions{ + Connection: InProcessConnection{}, + WorkingDirectory: "/tmp/work", + }) + }) + + t.Run("panics when Telemetry is set", func(t *testing.T) { + defer func() { + if r := recover(); r == nil { + t.Error("Expected panic when Telemetry is set with InProcessConnection") + } + }() + NewClient(&ClientOptions{ + Connection: InProcessConnection{}, + Telemetry: &TelemetryConfig{ExporterType: "file"}, + }) + }) + + t.Run("forwards typed runtime options", func(t *testing.T) { + client := NewClient(&ClientOptions{ + Connection: InProcessConnection{}, + GitHubToken: "test-token", + UseLoggedInUser: Bool(false), + BaseDirectory: "/copilot-home", + LogLevel: "debug", + SessionIdleTimeoutSeconds: 30, + EnableRemoteSessions: true, + Mode: ModeEmpty, + }) + + config := client.inProcessHostConfig() + expectedArgs := []string{ + "--log-level", "debug", + "--auth-token-env", "COPILOT_SDK_AUTH_TOKEN", + "--no-auto-login", + "--session-idle-timeout", "30", + "--remote", + } + if !reflect.DeepEqual(config.Args, expectedArgs) { + t.Fatalf("Expected managed arguments %v, got %v", expectedArgs, config.Args) + } + expectedEnvironment := map[string]string{ + "COPILOT_SDK_AUTH_TOKEN": "test-token", + "COPILOT_HOME": "/copilot-home", + "COPILOT_DISABLE_KEYTAR": "1", + } + if !reflect.DeepEqual(config.Environment, expectedEnvironment) { + t.Fatalf("Expected managed environment %v, got %v", expectedEnvironment, config.Environment) + } + }) +} + +func TestClient_DefaultConnection(t *testing.T) { + t.Run("defaults to stdio when override is unset", func(t *testing.T) { + t.Setenv(defaultConnectionEnvVar, "") + + client := NewClient(nil) + + if !client.useStdio || client.useInProcess { + t.Fatalf("Expected stdio default, got useStdio=%v useInProcess=%v", client.useStdio, client.useInProcess) + } + }) + + t.Run("selects in-process case-insensitively", func(t *testing.T) { + t.Setenv(defaultConnectionEnvVar, "InPrOcEsS") + + client := NewClient(nil) + + if !client.useInProcess || client.useStdio { + t.Fatalf("Expected in-process default, got useStdio=%v useInProcess=%v", client.useStdio, client.useInProcess) + } + }) + + t.Run("accepts explicit stdio override", func(t *testing.T) { + t.Setenv(defaultConnectionEnvVar, "STDIO") + + client := NewClient(nil) + + if !client.useStdio || client.useInProcess { + t.Fatalf("Expected stdio default, got useStdio=%v useInProcess=%v", client.useStdio, client.useInProcess) + } + }) + + t.Run("explicit connection takes precedence", func(t *testing.T) { + t.Setenv(defaultConnectionEnvVar, "inprocess") + + client := NewClient(&ClientOptions{Connection: TCPConnection{Port: 1234}}) + + if client.useInProcess || client.useStdio || client.port != 1234 { + t.Fatalf("Expected explicit TCP connection to win, got useStdio=%v useInProcess=%v port=%d", client.useStdio, client.useInProcess, client.port) + } + }) + + t.Run("panics for invalid override", func(t *testing.T) { + t.Setenv(defaultConnectionEnvVar, "tcp") + + defer func() { + if r := recover(); r == nil { + t.Fatal("Expected invalid default connection override to panic") + } + }() + NewClient(nil) + }) +} + +func TestClient_ConnectionLevelEnv(t *testing.T) { + t.Run("rejects env set on both client and connection", func(t *testing.T) { + defer func() { + if r := recover(); r == nil { + t.Error("Expected panic when env is set on both client and connection") + } + }() + NewClient(&ClientOptions{ + Connection: StdioConnection{Env: []string{"A=1"}}, + Env: []string{"B=2"}, + }) + }) + + t.Run("stdio connection env is used when client env is unset", func(t *testing.T) { + client := NewClient(&ClientOptions{ + Connection: StdioConnection{Env: []string{"ONLY=conn"}}, + }) + if len(client.options.Env) != 1 || client.options.Env[0] != "ONLY=conn" { + t.Errorf("Expected connection-level Env to be used, got %v", client.options.Env) + } + }) + + t.Run("tcp connection env is used when client env is unset", func(t *testing.T) { + client := NewClient(&ClientOptions{ + Connection: TCPConnection{Port: 9000, Env: []string{"ONLY=conn"}}, + }) + if len(client.options.Env) != 1 || client.options.Env[0] != "ONLY=conn" { + t.Errorf("Expected connection-level Env to be used, got %v", client.options.Env) + } + }) +} + func TestClient_SessionIdleTimeoutSeconds(t *testing.T) { t.Run("should store SessionIdleTimeoutSeconds option", func(t *testing.T) { client := NewClient(&ClientOptions{ @@ -336,18 +1092,16 @@ func TestClient_SessionIdleTimeoutSeconds(t *testing.T) { } func findCLIPathForTest() string { - abs, _ := filepath.Abs("../nodejs/node_modules/@github/copilot/index.js") - if fileExistsForTest(abs) { - return abs + base, err := filepath.Abs("../nodejs/node_modules/@github") + if err == nil { + matches, _ := filepath.Glob(filepath.Join(base, "copilot-*", "index.js")) + if len(matches) > 0 { + return matches[0] + } } return "" } -func fileExistsForTest(path string) bool { - _, err := os.Stat(path) - return err == nil -} - func TestCreateSessionRequest_ClientName(t *testing.T) { t.Run("includes clientName in JSON when set", func(t *testing.T) { req := createSessionRequest{ClientName: "my-app"} @@ -466,6 +1220,73 @@ func TestSessionRequests_ContextTier(t *testing.T) { }) } +func TestSessionRequests_EnableConfigDiscovery(t *testing.T) { + t.Run("create includes enableConfigDiscovery when true", func(t *testing.T) { + req := createSessionRequest{EnableConfigDiscovery: Bool(true)} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableConfigDiscovery"] != true { + t.Errorf("Expected enableConfigDiscovery to be true, got %v", m["enableConfigDiscovery"]) + } + }) + + t.Run("create includes enableConfigDiscovery when false", func(t *testing.T) { + req := createSessionRequest{EnableConfigDiscovery: Bool(false)} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableConfigDiscovery"] != false { + t.Errorf("Expected enableConfigDiscovery to be false, got %v", m["enableConfigDiscovery"]) + } + }) + + t.Run("create omits enableConfigDiscovery when unset", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["enableConfigDiscovery"]; ok { + t.Error("Expected enableConfigDiscovery to be omitted when unset") + } + }) + + t.Run("resume includes enableConfigDiscovery when false", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", EnableConfigDiscovery: Bool(false)} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableConfigDiscovery"] != false { + t.Errorf("Expected enableConfigDiscovery to be false, got %v", m["enableConfigDiscovery"]) + } + }) + + t.Run("resume omits enableConfigDiscovery when unset", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["enableConfigDiscovery"]; ok { + t.Error("Expected enableConfigDiscovery to be omitted when unset") + } + }) +} + func TestSessionRequests_PluginDirectoriesAndLargeOutput(t *testing.T) { pluginDirs := []string{"/tmp/plugins/a", "/tmp/plugins/b"} enabled := true @@ -482,9 +1303,11 @@ func TestSessionRequests_PluginDirectoriesAndLargeOutput(t *testing.T) { "outputDir": "/tmp/large-output", } expectedPluginDirs := []any{"/tmp/plugins/a", "/tmp/plugins/b"} + expectedDisabledMCPServers := []any{"local-files", "remote-github"} + disabledMCPServers := []string{"local-files", "remote-github"} t.Run("create includes pluginDirectories and largeOutput in JSON when set", func(t *testing.T) { - req := createSessionRequest{PluginDirectories: pluginDirs, LargeOutput: largeOutput} + req := createSessionRequest{PluginDirectories: pluginDirs, DisabledMCPServers: &disabledMCPServers, LargeOutput: largeOutput} data, err := json.Marshal(req) if err != nil { t.Fatalf("Failed to marshal: %v", err) @@ -496,13 +1319,16 @@ func TestSessionRequests_PluginDirectoriesAndLargeOutput(t *testing.T) { if !reflect.DeepEqual(m["pluginDirectories"], expectedPluginDirs) { t.Errorf("Expected pluginDirectories %v, got %v", expectedPluginDirs, m["pluginDirectories"]) } + if !reflect.DeepEqual(m["disabledMcpServers"], expectedDisabledMCPServers) { + t.Errorf("Expected disabledMcpServers %v, got %v", expectedDisabledMCPServers, m["disabledMcpServers"]) + } if !reflect.DeepEqual(m["largeOutput"], expectedLargeOutput) { t.Errorf("Expected largeOutput %v, got %v", expectedLargeOutput, m["largeOutput"]) } }) t.Run("resume includes pluginDirectories and largeOutput in JSON when set", func(t *testing.T) { - req := resumeSessionRequest{SessionID: "s1", PluginDirectories: pluginDirs, LargeOutput: largeOutput} + req := resumeSessionRequest{SessionID: "s1", PluginDirectories: pluginDirs, DisabledMCPServers: &disabledMCPServers, LargeOutput: largeOutput} data, err := json.Marshal(req) if err != nil { t.Fatalf("Failed to marshal: %v", err) @@ -514,11 +1340,36 @@ func TestSessionRequests_PluginDirectoriesAndLargeOutput(t *testing.T) { if !reflect.DeepEqual(m["pluginDirectories"], expectedPluginDirs) { t.Errorf("Expected pluginDirectories %v, got %v", expectedPluginDirs, m["pluginDirectories"]) } + if !reflect.DeepEqual(m["disabledMcpServers"], expectedDisabledMCPServers) { + t.Errorf("Expected disabledMcpServers %v, got %v", expectedDisabledMCPServers, m["disabledMcpServers"]) + } if !reflect.DeepEqual(m["largeOutput"], expectedLargeOutput) { t.Errorf("Expected largeOutput %v, got %v", expectedLargeOutput, m["largeOutput"]) } }) + t.Run("create and resume include explicit empty disabledMcpServers", func(t *testing.T) { + emptyDisabledMCPServers := []string{} + requests := []any{ + createSessionRequest{DisabledMCPServers: &emptyDisabledMCPServers}, + resumeSessionRequest{SessionID: "s1", DisabledMCPServers: &emptyDisabledMCPServers}, + } + + for _, request := range requests { + data, err := json.Marshal(request) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if value, ok := m["disabledMcpServers"]; !ok || !reflect.DeepEqual(value, []any{}) { + t.Errorf("Expected explicit empty disabledMcpServers, got %v", value) + } + } + }) + t.Run("create omits pluginDirectories and largeOutput when nil", func(t *testing.T) { req := createSessionRequest{} data, err := json.Marshal(req) @@ -532,10 +1383,92 @@ func TestSessionRequests_PluginDirectoriesAndLargeOutput(t *testing.T) { if _, ok := m["pluginDirectories"]; ok { t.Errorf("Expected pluginDirectories to be omitted") } + if _, ok := m["disabledMcpServers"]; ok { + t.Error("Expected disabledMcpServers to be omitted") + } if _, ok := m["largeOutput"]; ok { t.Errorf("Expected largeOutput to be omitted") } }) + + t.Run("resume omits disabledMcpServers when nil", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["disabledMcpServers"]; ok { + t.Error("Expected disabledMcpServers to be omitted") + } + }) +} + +func TestSessionRequests_Memory(t *testing.T) { + t.Run("create includes memory in JSON when enabled", func(t *testing.T) { + req := createSessionRequest{Memory: &MemoryConfiguration{Enabled: true}} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + expected := map[string]any{"enabled": true} + if !reflect.DeepEqual(m["memory"], expected) { + t.Errorf("Expected memory %v, got %v", expected, m["memory"]) + } + }) + + t.Run("resume includes memory in JSON when disabled", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", Memory: &MemoryConfiguration{Enabled: false}} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + expected := map[string]any{"enabled": false} + if !reflect.DeepEqual(m["memory"], expected) { + t.Errorf("Expected memory %v, got %v", expected, m["memory"]) + } + }) + + t.Run("create omits memory when nil", func(t *testing.T) { + req := createSessionRequest{} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["memory"]; ok { + t.Errorf("Expected memory to be omitted") + } + }) + + t.Run("resume omits memory when nil", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["memory"]; ok { + t.Errorf("Expected memory to be omitted") + } + }) } func TestCreateSessionRequest_Agent(t *testing.T) { @@ -667,61 +1600,145 @@ func TestCreateSessionRequest_MCPOAuthTokenStorage(t *testing.T) { } }) - t.Run("omits mcpOAuthTokenStorage from JSON when empty", func(t *testing.T) { - req := createSessionRequest{} - data, err := json.Marshal(req) + t.Run("omits mcpOAuthTokenStorage from JSON when empty", func(t *testing.T) { + req := createSessionRequest{} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["mcpOAuthTokenStorage"]; ok { + t.Error("Expected mcpOAuthTokenStorage to be omitted when empty") + } + }) +} + +func TestResumeSessionRequest_MCPOAuthTokenStorage(t *testing.T) { + t.Run("includes mcpOAuthTokenStorage in JSON when set", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", MCPOAuthTokenStorage: "persistent"} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["mcpOAuthTokenStorage"] != "persistent" { + t.Errorf("Expected mcpOAuthTokenStorage to be 'persistent', got %v", m["mcpOAuthTokenStorage"]) + } + }) + + t.Run("omits mcpOAuthTokenStorage from JSON when empty", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["mcpOAuthTokenStorage"]; ok { + t.Error("Expected mcpOAuthTokenStorage to be omitted when empty") + } + }) +} + +func TestOverridesBuiltInTool(t *testing.T) { + t.Run("OverridesBuiltInTool is serialized in tool definition", func(t *testing.T) { + tool := Tool{ + Name: "grep", + Description: "Custom grep", + OverridesBuiltInTool: true, + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + } + data, err := json.Marshal(tool) + if err != nil { + t.Fatalf("failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("failed to unmarshal: %v", err) + } + if v, ok := m["overridesBuiltInTool"]; !ok || v != true { + t.Errorf("expected overridesBuiltInTool=true, got %v", m) + } + }) + + t.Run("OverridesBuiltInTool omitted when false", func(t *testing.T) { + tool := Tool{ + Name: "custom_tool", + Description: "A custom tool", + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + } + data, err := json.Marshal(tool) if err != nil { - t.Fatalf("Failed to marshal: %v", err) + t.Fatalf("failed to marshal: %v", err) } var m map[string]any if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) + t.Fatalf("failed to unmarshal: %v", err) } - if _, ok := m["mcpOAuthTokenStorage"]; ok { - t.Error("Expected mcpOAuthTokenStorage to be omitted when empty") + if _, ok := m["overridesBuiltInTool"]; ok { + t.Errorf("expected overridesBuiltInTool to be omitted, got %v", m) } }) } -func TestResumeSessionRequest_MCPOAuthTokenStorage(t *testing.T) { - t.Run("includes mcpOAuthTokenStorage in JSON when set", func(t *testing.T) { - req := resumeSessionRequest{SessionID: "s1", MCPOAuthTokenStorage: "persistent"} - data, err := json.Marshal(req) +func TestToolDefer(t *testing.T) { + t.Run("Defer is serialized in tool definition", func(t *testing.T) { + tool := Tool{ + Name: "lookup_issue", + Description: "Fetch issue details", + Defer: ToolDeferAuto, + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + } + data, err := json.Marshal(tool) if err != nil { - t.Fatalf("Failed to marshal: %v", err) + t.Fatalf("failed to marshal: %v", err) } var m map[string]any if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) + t.Fatalf("failed to unmarshal: %v", err) } - if m["mcpOAuthTokenStorage"] != "persistent" { - t.Errorf("Expected mcpOAuthTokenStorage to be 'persistent', got %v", m["mcpOAuthTokenStorage"]) + if v, ok := m["defer"]; !ok || v != "auto" { + t.Errorf("expected defer=auto, got %v", m) } }) - t.Run("omits mcpOAuthTokenStorage from JSON when empty", func(t *testing.T) { - req := resumeSessionRequest{SessionID: "s1"} - data, err := json.Marshal(req) + t.Run("Defer omitted when unset", func(t *testing.T) { + tool := Tool{ + Name: "custom_tool", + Description: "A custom tool", + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + } + data, err := json.Marshal(tool) if err != nil { - t.Fatalf("Failed to marshal: %v", err) + t.Fatalf("failed to marshal: %v", err) } var m map[string]any if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) + t.Fatalf("failed to unmarshal: %v", err) } - if _, ok := m["mcpOAuthTokenStorage"]; ok { - t.Error("Expected mcpOAuthTokenStorage to be omitted when empty") + if _, ok := m["defer"]; ok { + t.Errorf("expected defer to be omitted, got %v", m) } }) } -func TestOverridesBuiltInTool(t *testing.T) { - t.Run("OverridesBuiltInTool is serialized in tool definition", func(t *testing.T) { +func TestToolMetadata(t *testing.T) { + t.Run("Metadata is serialized in tool definition", func(t *testing.T) { tool := Tool{ - Name: "grep", - Description: "Custom grep", - OverridesBuiltInTool: true, - Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + Name: "my_tool", + Description: "A custom tool", + Metadata: map[string]any{ + "github.com/copilot:safeForTelemetry": map[string]any{"name": true, "inputsNames": false}, + }, + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, } data, err := json.Marshal(tool) if err != nil { @@ -731,12 +1748,16 @@ func TestOverridesBuiltInTool(t *testing.T) { if err := json.Unmarshal(data, &m); err != nil { t.Fatalf("failed to unmarshal: %v", err) } - if v, ok := m["overridesBuiltInTool"]; !ok || v != true { - t.Errorf("expected overridesBuiltInTool=true, got %v", m) + meta, ok := m["metadata"].(map[string]any) + if !ok { + t.Fatalf("expected metadata object, got %v", m) + } + if _, ok := meta["github.com/copilot:safeForTelemetry"]; !ok { + t.Errorf("expected namespaced key preserved, got %v", meta) } }) - t.Run("OverridesBuiltInTool omitted when false", func(t *testing.T) { + t.Run("Metadata omitted when unset", func(t *testing.T) { tool := Tool{ Name: "custom_tool", Description: "A custom tool", @@ -750,8 +1771,8 @@ func TestOverridesBuiltInTool(t *testing.T) { if err := json.Unmarshal(data, &m); err != nil { t.Fatalf("failed to unmarshal: %v", err) } - if _, ok := m["overridesBuiltInTool"]; ok { - t.Errorf("expected overridesBuiltInTool to be omitted, got %v", m) + if _, ok := m["metadata"]; ok { + t.Errorf("expected metadata to be omitted, got %v", m) } }) } @@ -800,7 +1821,7 @@ func TestListModelsWithCustomHandler(t *testing.T) { Name: "My Custom Model", Capabilities: ModelCapabilities{ Supports: ModelSupports{Vision: false, ReasoningEffort: false}, - Limits: ModelLimits{MaxContextWindowTokens: 128000}, + Limits: ModelLimits{MaxContextWindowTokens: Int(128000)}, }, }, } @@ -825,6 +1846,78 @@ func TestListModelsWithCustomHandler(t *testing.T) { } } +func TestModelBillingTokenPricesJSON(t *testing.T) { + int64Ptr := func(v int64) *int64 { + return &v + } + + wire := `{ + "multiplier": 1.5, + "tokenPrices": { + "inputPrice": 2.0, + "outputPrice": 8.0, + "cachePrice": 0.5, + "batchSize": 1000000, + "contextMax": 128000, + "longContext": { + "inputPrice": 4.0, + "outputPrice": 16.0, + "cachePrice": 1.0, + "maxPromptTokens": 1000000 + } + } + }` + expected := rpc.ModelBillingTokenPrices{ + InputPrice: Float64(2.0), + OutputPrice: Float64(8.0), + CachePrice: Float64(0.5), + BatchSize: int64Ptr(1000000), + ContextMax: int64Ptr(128000), + LongContext: &rpc.ModelBillingTokenPricesLongContext{ + InputPrice: Float64(4.0), + OutputPrice: Float64(16.0), + CachePrice: Float64(1.0), + MaxPromptTokens: int64Ptr(1000000), + }, + } + + var billing ModelBilling + if err := json.Unmarshal([]byte(wire), &billing); err != nil { + t.Fatalf("unmarshal failed: %v", err) + } + + if billing.TokenPrices == nil { + t.Fatal("expected TokenPrices to be set") + } + tp := billing.TokenPrices + if !reflect.DeepEqual(*tp, expected) { + t.Errorf("unexpected TokenPrices: %+v", tp) + } + if tp.LongContext == nil { + t.Fatal("expected LongContext to be set") + } + lc := tp.LongContext + if lc.InputPrice == nil || *lc.InputPrice != 4.0 { + t.Errorf("unexpected LongContext.InputPrice: %v", lc.InputPrice) + } + if lc.MaxPromptTokens == nil || *lc.MaxPromptTokens != 1000000 { + t.Errorf("unexpected LongContext.MaxPromptTokens: %v", lc.MaxPromptTokens) + } + + // Round-trip back to JSON and ensure the nested structure survives. + out, err := json.Marshal(billing) + if err != nil { + t.Fatalf("marshal failed: %v", err) + } + var reparsed ModelBilling + if err := json.Unmarshal(out, &reparsed); err != nil { + t.Fatalf("re-unmarshal failed: %v", err) + } + if reparsed.TokenPrices == nil || !reflect.DeepEqual(*reparsed.TokenPrices, expected) { + t.Errorf("round-trip lost token price data: %s", out) + } +} + func TestListModelsHandlerCachesResults(t *testing.T) { customModels := []ModelInfo{ { @@ -832,7 +1925,7 @@ func TestListModelsHandlerCachesResults(t *testing.T) { Name: "Cached Model", Capabilities: ModelCapabilities{ Supports: ModelSupports{Vision: false, ReasoningEffort: false}, - Limits: ModelLimits{MaxContextWindowTokens: 128000}, + Limits: ModelLimits{MaxContextWindowTokens: Int(128000)}, }, }, } @@ -919,6 +2012,291 @@ func TestClient_StartStopRace(t *testing.T) { } } +func TestClient_MCPAuthInterestRegistration(t *testing.T) { + t.Run("create skips MCP OAuth interest without auth handler", func(t *testing.T) { + client, requests, cleanup := newInMemoryClient(t) + defer cleanup() + + session, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnEvent: func(SessionEvent) {}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + assertNoMCPAuthInterest(t, requests.snapshot()) + assertRequestMethod(t, requests.snapshot(), "session.create") + assertCreateRequestPermission(t, requests.snapshot()) + }) + + t.Run("create registers MCP OAuth interest after local session create when auth handler is configured", func(t *testing.T) { + client, requests, cleanup := newInMemoryClient(t) + defer cleanup() + + session, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnMCPAuthRequest: func(MCPAuthRequest, MCPAuthInvocation) (*MCPAuthResult, error) { + return MCPAuthResultCancelled(), nil + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + snapshot := requests.snapshot() + assertRequestMethod(t, snapshot, "session.eventLog.registerInterest") + if snapshot[0].Method != "session.create" { + t.Fatalf("expected session.create before MCP auth interest, got %s", snapshot[0].Method) + } + if snapshot[1].Method != "session.eventLog.registerInterest" { + t.Fatalf("expected MCP auth interest after session.create, got %s", snapshot[1].Method) + } + assertMCPAuthInterest(t, snapshot[1]) + assertCreateRequestPermission(t, snapshot) + }) + + t.Run("cloud create registers MCP OAuth interest after server assigns id only when auth handler is configured", func(t *testing.T) { + client, requests, cleanup := newInMemoryClient(t) + defer cleanup() + + withoutAuth, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + Cloud: &CloudSessionOptions{ + Repository: &CloudSessionRepository{Owner: "github", Name: "copilot-sdk", Branch: "main"}, + }, + }) + if err != nil { + t.Fatalf("CreateSession without auth failed: %v", err) + } + defer withoutAuth.Disconnect() + + assertNoMCPAuthInterest(t, requests.snapshot()) + requests.clear() + + withAuth, err := client.CreateSession(t.Context(), &SessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnMCPAuthRequest: func(MCPAuthRequest, MCPAuthInvocation) (*MCPAuthResult, error) { + return MCPAuthResultCancelled(), nil + }, + Cloud: &CloudSessionOptions{ + Repository: &CloudSessionRepository{Owner: "github", Name: "copilot-sdk", Branch: "main"}, + }, + }) + if err != nil { + t.Fatalf("CreateSession with auth failed: %v", err) + } + defer withAuth.Disconnect() + + snapshot := requests.snapshot() + if snapshot[0].Method != "session.create" { + t.Fatalf("expected cloud session.create before MCP auth interest, got %s", snapshot[0].Method) + } + if snapshot[1].Method != "session.eventLog.registerInterest" { + t.Fatalf("expected MCP auth interest after cloud session.create, got %s", snapshot[1].Method) + } + assertMCPAuthInterest(t, snapshot[1]) + }) + + t.Run("resume conditionally registers MCP OAuth interest after session resume", func(t *testing.T) { + client, requests, cleanup := newInMemoryClient(t) + defer cleanup() + + withoutAuth, err := client.ResumeSession(t.Context(), "session-without-auth", &ResumeSessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnEvent: func(SessionEvent) {}, + }) + if err != nil { + t.Fatalf("ResumeSession without auth failed: %v", err) + } + defer withoutAuth.Disconnect() + + assertNoMCPAuthInterest(t, requests.snapshot()) + assertRequestMethod(t, requests.snapshot(), "session.resume") + requests.clear() + + withAuth, err := client.ResumeSession(t.Context(), "session-with-auth", &ResumeSessionConfig{ + OnPermissionRequest: PermissionHandler.ApproveAll, + OnMCPAuthRequest: func(MCPAuthRequest, MCPAuthInvocation) (*MCPAuthResult, error) { + return MCPAuthResultCancelled(), nil + }, + }) + if err != nil { + t.Fatalf("ResumeSession with auth failed: %v", err) + } + defer withAuth.Disconnect() + + snapshot := requests.snapshot() + if snapshot[0].Method != "session.resume" { + t.Fatalf("expected session.resume before MCP auth interest, got %s", snapshot[0].Method) + } + if snapshot[1].Method != "session.eventLog.registerInterest" { + t.Fatalf("expected MCP auth interest after session.resume, got %s", snapshot[1].Method) + } + assertMCPAuthInterest(t, snapshot[1]) + }) +} + +type recordedRequest struct { + Method string + Params map[string]any +} + +type requestRecorder struct { + mu sync.Mutex + requests []recordedRequest +} + +func (r *requestRecorder) append(request recordedRequest) { + r.mu.Lock() + defer r.mu.Unlock() + r.requests = append(r.requests, request) +} + +func (r *requestRecorder) snapshot() []recordedRequest { + r.mu.Lock() + defer r.mu.Unlock() + out := make([]recordedRequest, len(r.requests)) + copy(out, r.requests) + return out +} + +func (r *requestRecorder) clear() { + r.mu.Lock() + defer r.mu.Unlock() + r.requests = nil +} + +func newInMemoryClient(t *testing.T) (*Client, *requestRecorder, func()) { + t.Helper() + + stdinR, stdinW := io.Pipe() + stdoutR, stdoutW := io.Pipe() + rpcClient := jsonrpc2.NewClient(stdinW, stdoutR) + rpcClient.Start() + + client := NewClient(&ClientOptions{}) + client.client = rpcClient + client.RPC = rpc.NewServerRPC(rpcClient) + client.state = stateConnected + + requests := &requestRecorder{} + done := make(chan struct{}) + go serveInMemoryRuntime(t, stdinR, stdoutW, requests, done) + + cleanup := func() { + rpcClient.Stop() + stdinR.Close() + stdinW.Close() + stdoutR.Close() + stdoutW.Close() + <-done + } + return client, requests, cleanup +} + +func serveInMemoryRuntime(t *testing.T, stdinR *io.PipeReader, stdoutW *io.PipeWriter, requests *requestRecorder, done chan<- struct{}) { + t.Helper() + defer close(done) + + serverAssignedSessions := 0 + for { + frame, err := readTestJSONRPCFrame(stdinR) + if err != nil { + return + } + + var request struct { + ID json.RawMessage `json:"id"` + Method string `json:"method"` + Params map[string]any `json:"params"` + } + if err := json.Unmarshal(frame, &request); err != nil { + t.Errorf("failed to unmarshal JSON-RPC request: %v", err) + return + } + requests.append(recordedRequest{Method: request.Method, Params: request.Params}) + + var result map[string]any + switch request.Method { + case "session.create", "session.resume": + sessionID, _ := request.Params["sessionId"].(string) + if sessionID == "" { + serverAssignedSessions++ + sessionID = fmt.Sprintf("server-assigned-session-%d", serverAssignedSessions) + } + result = map[string]any{"sessionId": sessionID, "workspacePath": nil} + case "session.eventLog.registerInterest": + result = map[string]any{"id": "interest-1"} + case "session.options.update": + result = map[string]any{"success": true} + case "session.skills.reload", "session.destroy": + result = map[string]any{} + default: + t.Errorf("unexpected JSON-RPC method %s", request.Method) + return + } + + response := map[string]any{ + "jsonrpc": "2.0", + "id": json.RawMessage(request.ID), + "result": result, + } + data, err := json.Marshal(response) + if err != nil { + t.Errorf("failed to marshal JSON-RPC response: %v", err) + return + } + if _, err := fmt.Fprintf(stdoutW, "Content-Length: %d\r\n\r\n%s", len(data), data); err != nil { + return + } + } +} + +func assertRequestMethod(t *testing.T, requests []recordedRequest, method string) { + t.Helper() + for _, request := range requests { + if request.Method == method { + return + } + } + t.Fatalf("expected %s request in %+v", method, requests) +} + +func assertNoMCPAuthInterest(t *testing.T, requests []recordedRequest) { + t.Helper() + for _, request := range requests { + if request.Method == "session.eventLog.registerInterest" && request.Params["eventType"] == "mcp.oauth_required" { + t.Fatalf("did not expect MCP auth interest registration in %+v", requests) + } + } +} + +func assertMCPAuthInterest(t *testing.T, request recordedRequest) { + t.Helper() + if request.Method != "session.eventLog.registerInterest" { + t.Fatalf("expected registerInterest request, got %s", request.Method) + } + if request.Params["eventType"] != "mcp.oauth_required" { + t.Fatalf("expected mcp.oauth_required interest, got %v", request.Params["eventType"]) + } +} + +func assertCreateRequestPermission(t *testing.T, requests []recordedRequest) { + t.Helper() + for _, request := range requests { + if request.Method == "session.create" { + if request.Params["requestPermission"] != true { + t.Fatalf("expected create requestPermission=true, got %v", request.Params["requestPermission"]) + } + return + } + } + t.Fatalf("session.create request not found in %+v", requests) +} + func TestCreateSessionRequest_Commands(t *testing.T) { t.Run("forwards commands in session.create RPC", func(t *testing.T) { req := createSessionRequest{ @@ -981,32 +2359,114 @@ func TestCreateSessionRequest_Cloud(t *testing.T) { if err := json.Unmarshal(data, &m); err != nil { t.Fatalf("Failed to unmarshal: %v", err) } - cloud, ok := m["cloud"].(map[string]any) - if !ok { - t.Fatalf("Expected cloud to be an object, got %T", m["cloud"]) - } - repository, ok := cloud["repository"].(map[string]any) - if !ok { - t.Fatalf("Expected cloud.repository to be an object, got %T", cloud["repository"]) - } - if repository["owner"] != "github" { - t.Errorf("Expected owner 'github', got %v", repository["owner"]) - } - if repository["name"] != "copilot-sdk" { - t.Errorf("Expected name 'copilot-sdk', got %v", repository["name"]) - } - if repository["branch"] != "main" { - t.Errorf("Expected branch 'main', got %v", repository["branch"]) + cloud, ok := m["cloud"].(map[string]any) + if !ok { + t.Fatalf("Expected cloud to be an object, got %T", m["cloud"]) + } + repository, ok := cloud["repository"].(map[string]any) + if !ok { + t.Fatalf("Expected cloud.repository to be an object, got %T", cloud["repository"]) + } + if repository["owner"] != "github" { + t.Errorf("Expected owner 'github', got %v", repository["owner"]) + } + if repository["name"] != "copilot-sdk" { + t.Errorf("Expected name 'copilot-sdk', got %v", repository["name"]) + } + if repository["branch"] != "main" { + t.Errorf("Expected branch 'main', got %v", repository["branch"]) + } + }) + + t.Run("omits cloud from JSON when unset", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["cloud"]; ok { + t.Error("Expected cloud to be omitted when unset") + } + }) +} + +func TestSessionRequests_Capi(t *testing.T) { + t.Run("forwards capi options in session.create RPC", func(t *testing.T) { + req := createSessionRequest{ + Capi: &CapiSessionOptions{EnableWebSocketResponses: Bool(false)}, + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + capi, ok := m["capi"].(map[string]any) + if !ok { + t.Fatalf("Expected capi to be an object, got %T", m["capi"]) + } + if capi["enableWebSocketResponses"] != false { + t.Errorf("Expected enableWebSocketResponses=false, got %v", capi["enableWebSocketResponses"]) + } + }) + + t.Run("forwards capi options in session.resume RPC", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + Capi: &CapiSessionOptions{EnableWebSocketResponses: Bool(false)}, + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + capi, ok := m["capi"].(map[string]any) + if !ok { + t.Fatalf("Expected capi to be an object, got %T", m["capi"]) + } + if capi["enableWebSocketResponses"] != false { + t.Errorf("Expected enableWebSocketResponses=false, got %v", capi["enableWebSocketResponses"]) + } + }) + + t.Run("omits capi from JSON when unset", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["capi"]; ok { + t.Error("Expected capi to be omitted when unset") + } + }) +} + +func TestProviderConfig_Transport(t *testing.T) { + t.Run("serializes transport with camelCase key", func(t *testing.T) { + cfg := ProviderConfig{BaseURL: "https://example.com", Transport: "websockets"} + data, err := json.Marshal(cfg) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["transport"] != "websockets" { + t.Errorf("Expected transport=websockets, got %v", m["transport"]) } }) - t.Run("omits cloud from JSON when unset", func(t *testing.T) { - req := createSessionRequest{} - data, _ := json.Marshal(req) + t.Run("omits transport from JSON when unset", func(t *testing.T) { + cfg := ProviderConfig{BaseURL: "https://example.com"} + data, _ := json.Marshal(cfg) var m map[string]any json.Unmarshal(data, &m) - if _, ok := m["cloud"]; ok { - t.Error("Expected cloud to be omitted when unset") + if _, ok := m["transport"]; ok { + t.Error("Expected transport to be omitted when unset") } }) } @@ -1146,10 +2606,10 @@ func TestResumeSessionRequest_RequestElicitation(t *testing.T) { }) } -func TestCreateSessionRequest_RequestMcpApps(t *testing.T) { - t.Run("sends requestMcpApps flag when EnableMcpApps is set", func(t *testing.T) { +func TestCreateSessionRequest_RequestMCPApps(t *testing.T) { + t.Run("sends requestMCPApps flag when EnableMCPApps is set", func(t *testing.T) { req := createSessionRequest{ - RequestMcpApps: Bool(true), + RequestMCPApps: Bool(true), } data, err := json.Marshal(req) if err != nil { @@ -1164,7 +2624,7 @@ func TestCreateSessionRequest_RequestMcpApps(t *testing.T) { } }) - t.Run("does not send requestMcpApps when EnableMcpApps is unset", func(t *testing.T) { + t.Run("does not send requestMcpApps when EnableMCPApps is unset", func(t *testing.T) { req := createSessionRequest{} data, _ := json.Marshal(req) var m map[string]any @@ -1175,11 +2635,68 @@ func TestCreateSessionRequest_RequestMcpApps(t *testing.T) { }) } -func TestResumeSessionRequest_RequestMcpApps(t *testing.T) { - t.Run("sends requestMcpApps flag when EnableMcpApps is set", func(t *testing.T) { +func TestSessionRequests_EnableExperimentalMode(t *testing.T) { + t.Run("create forwards enableExperimentalMode when explicitly false", func(t *testing.T) { + req := createSessionRequest{ + IsExperimentalMode: Bool(false), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["isExperimentalMode"] != false { + t.Errorf("Expected isExperimentalMode to be false, got %v", m["isExperimentalMode"]) + } + }) + + t.Run("create omits enableExperimentalMode when unset", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["isExperimentalMode"]; ok { + t.Error("Expected isExperimentalMode to be omitted when not set") + } + }) + + t.Run("resume forwards enableExperimentalMode when explicitly true", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + IsExperimentalMode: Bool(true), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["isExperimentalMode"] != true { + t.Errorf("Expected isExperimentalMode to be true, got %v", m["isExperimentalMode"]) + } + }) + + t.Run("resume omits enableExperimentalMode when unset", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["isExperimentalMode"]; ok { + t.Error("Expected isExperimentalMode to be omitted when not set") + } + }) +} + +func TestResumeSessionRequest_RequestMCPApps(t *testing.T) { + t.Run("sends requestMcpApps flag when EnableMCPApps is set", func(t *testing.T) { req := resumeSessionRequest{ SessionID: "s1", - RequestMcpApps: Bool(true), + RequestMCPApps: Bool(true), } data, err := json.Marshal(req) if err != nil { @@ -1194,7 +2711,7 @@ func TestResumeSessionRequest_RequestMcpApps(t *testing.T) { } }) - t.Run("does not send requestMcpApps when EnableMcpApps is unset", func(t *testing.T) { + t.Run("does not send requestMcpApps when RequestMCPApps is unset", func(t *testing.T) { req := resumeSessionRequest{SessionID: "s1"} data, _ := json.Marshal(req) var m map[string]any @@ -1205,6 +2722,68 @@ func TestResumeSessionRequest_RequestMcpApps(t *testing.T) { }) } +func TestSessionRequests_GitHubMCPToolConfig(t *testing.T) { + config := &GitHubMCPToolConfig{ + EnableAllTools: Bool(true), + AdditionalToolsets: []string{"repos"}, + AdditionalTools: []string{"get_issue"}, + EnableInsidersMode: Bool(true), + DisableFormDeferral: Bool(true), + } + expected := map[string]any{ + "enableAllTools": true, + "additionalToolsets": []any{"repos"}, + "additionalTools": []any{"get_issue"}, + "enableInsidersMode": true, + "disableFormDeferral": true, + } + + t.Run("create", func(t *testing.T) { + data, err := json.Marshal(createSessionRequest{GitHubMCPToolConfig: config}) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var payload map[string]any + if err := json.Unmarshal(data, &payload); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if !reflect.DeepEqual(payload["githubMcpToolConfig"], expected) { + t.Fatalf("Unexpected githubMcpToolConfig: %#v", payload["githubMcpToolConfig"]) + } + }) + + t.Run("resume", func(t *testing.T) { + data, err := json.Marshal(resumeSessionRequest{ + SessionID: "s1", + GitHubMCPToolConfig: config, + }) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var payload map[string]any + if err := json.Unmarshal(data, &payload); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if !reflect.DeepEqual(payload["githubMcpToolConfig"], expected) { + t.Fatalf("Unexpected githubMcpToolConfig: %#v", payload["githubMcpToolConfig"]) + } + }) + + t.Run("unset is omitted", func(t *testing.T) { + data, err := json.Marshal(createSessionRequest{}) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var payload map[string]any + if err := json.Unmarshal(data, &payload); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := payload["githubMcpToolConfig"]; ok { + t.Fatal("Expected githubMcpToolConfig to be omitted") + } + }) +} + func TestResumeSessionRequest_ModeCallbackFlags(t *testing.T) { req := resumeSessionRequest{ SessionID: "s1", @@ -1333,6 +2912,24 @@ func TestResumeSessionRequest_ContinuePendingWork(t *testing.T) { } }) + t.Run("forwards continuePendingWork when false", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + ContinuePendingWork: Bool(false), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["continuePendingWork"] != false { + t.Errorf("Expected continuePendingWork to be false, got %v", m["continuePendingWork"]) + } + }) + t.Run("omits continuePendingWork when not set", func(t *testing.T) { req := resumeSessionRequest{SessionID: "s1"} data, _ := json.Marshal(req) @@ -1409,72 +3006,351 @@ func TestCreateSessionRequest_IncludeSubAgentStreamingEvents(t *testing.T) { }) } -func TestResumeSessionRequest_EnableSessionTelemetry(t *testing.T) { - t.Run("forwards enableSessionTelemetry when false", func(t *testing.T) { - req := resumeSessionRequest{ - SessionID: "s1", - EnableSessionTelemetry: Bool(false), - } - data, err := json.Marshal(req) - if err != nil { - t.Fatalf("Failed to marshal: %v", err) - } - var m map[string]any - if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) - } - if m["enableSessionTelemetry"] != false { - t.Errorf("Expected enableSessionTelemetry to be false, got %v", m["enableSessionTelemetry"]) - } - }) +func TestResumeSessionRequest_EnableSessionTelemetry(t *testing.T) { + t.Run("forwards enableSessionTelemetry when false", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + EnableSessionTelemetry: Bool(false), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableSessionTelemetry"] != false { + t.Errorf("Expected enableSessionTelemetry to be false, got %v", m["enableSessionTelemetry"]) + } + }) + + t.Run("omits enableSessionTelemetry when not set", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["enableSessionTelemetry"]; ok { + t.Error("Expected enableSessionTelemetry to be omitted when not set") + } + }) +} + +func TestResumeSessionRequest_IncludeSubAgentStreamingEvents(t *testing.T) { + t.Run("defaults to true when nil", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + IncludeSubAgentStreamingEvents: Bool(true), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["includeSubAgentStreamingEvents"] != true { + t.Errorf("Expected includeSubAgentStreamingEvents to be true, got %v", m["includeSubAgentStreamingEvents"]) + } + }) + + t.Run("preserves explicit false", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + IncludeSubAgentStreamingEvents: Bool(false), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["includeSubAgentStreamingEvents"] != false { + t.Errorf("Expected includeSubAgentStreamingEvents to be false, got %v", m["includeSubAgentStreamingEvents"]) + } + }) +} + +func TestCreateSessionRequest_EnableGitHubTelemetryForwarding(t *testing.T) { + t.Run("forwards explicit true", func(t *testing.T) { + req := createSessionRequest{ + EnableGitHubTelemetryForwarding: Bool(true), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableGitHubTelemetryForwarding"] != true { + t.Errorf("Expected enableGitHubTelemetryForwarding to be true, got %v", m["enableGitHubTelemetryForwarding"]) + } + }) + + t.Run("omits when not set", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["enableGitHubTelemetryForwarding"]; ok { + t.Error("Expected enableGitHubTelemetryForwarding to be omitted when not set") + } + }) +} + +func TestResumeSessionRequest_EnableGitHubTelemetryForwarding(t *testing.T) { + t.Run("forwards explicit true", func(t *testing.T) { + req := resumeSessionRequest{ + SessionID: "s1", + EnableGitHubTelemetryForwarding: Bool(true), + } + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableGitHubTelemetryForwarding"] != true { + t.Errorf("Expected enableGitHubTelemetryForwarding to be true, got %v", m["enableGitHubTelemetryForwarding"]) + } + }) + + t.Run("omits when not set", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["enableGitHubTelemetryForwarding"]; ok { + t.Error("Expected enableGitHubTelemetryForwarding to be omitted when not set") + } + }) +} + +func TestClient_ForwardsGitHubTelemetryForwardingToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + options: ClientOptions{OnGitHubTelemetry: func(*rpc.GitHubTelemetryNotification) {}}, + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + if _, err := client.CreateSession(t.Context(), &SessionConfig{}); err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertForwardingFlagTrue(t, <-createParams) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed","workspacePath":"/workspace"}`), nil + }) + + if _, err := client.ResumeSessionWithOptions(t.Context(), "resumed", &ResumeSessionConfig{}); err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertForwardingFlagTrue(t, <-resumeParams) +} + +func assertForwardingFlagTrue(t *testing.T, params json.RawMessage) { + t.Helper() + var decoded map[string]any + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + if decoded["enableGitHubTelemetryForwarding"] != true { + t.Fatalf("expected enableGitHubTelemetryForwarding=true, got %v", decoded["enableGitHubTelemetryForwarding"]) + } +} + +func TestClient_OmitsGitHubTelemetryForwardingWhenNoHandler(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + options: ClientOptions{}, + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + if _, err := client.CreateSession(t.Context(), &SessionConfig{}); err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertForwardingFlagAbsent(t, <-createParams) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed","workspacePath":"/workspace"}`), nil + }) + + if _, err := client.ResumeSessionWithOptions(t.Context(), "resumed", &ResumeSessionConfig{}); err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertForwardingFlagAbsent(t, <-resumeParams) +} + +func assertForwardingFlagAbsent(t *testing.T, params json.RawMessage) { + t.Helper() + var decoded map[string]any + if err := json.Unmarshal(params, &decoded); err != nil { + t.Fatalf("failed to unmarshal request params: %v", err) + } + if _, ok := decoded["enableGitHubTelemetryForwarding"]; ok { + t.Fatalf("expected enableGitHubTelemetryForwarding to be omitted, got %v", decoded["enableGitHubTelemetryForwarding"]) + } +} + +func TestClient_ForwardsGitHubTelemetryForwardingOnConnect(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + internalRPC: rpc.NewInternalServerRPC(rpcClient), + sessions: make(map[string]*Session), + options: ClientOptions{OnGitHubTelemetry: func(*rpc.GitHubTelemetryNotification) {}}, + } + + connectParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("connect", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + connectParams <- append(json.RawMessage(nil), params...) + return []byte(`{"ok":true,"protocolVersion":3,"version":"test"}`), nil + }) + + if err := client.verifyProtocolVersion(t.Context()); err != nil { + t.Fatalf("verifyProtocolVersion failed: %v", err) + } + assertForwardingFlagTrue(t, <-connectParams) +} + +func TestClient_OmitsGitHubTelemetryForwardingOnConnectWhenNoHandler(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + internalRPC: rpc.NewInternalServerRPC(rpcClient), + sessions: make(map[string]*Session), + options: ClientOptions{}, + } - t.Run("omits enableSessionTelemetry when not set", func(t *testing.T) { - req := resumeSessionRequest{SessionID: "s1"} - data, _ := json.Marshal(req) - var m map[string]any - json.Unmarshal(data, &m) - if _, ok := m["enableSessionTelemetry"]; ok { - t.Error("Expected enableSessionTelemetry to be omitted when not set") - } + connectParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("connect", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + connectParams <- append(json.RawMessage(nil), params...) + return []byte(`{"ok":true,"protocolVersion":3,"version":"test"}`), nil }) + + if err := client.verifyProtocolVersion(t.Context()); err != nil { + t.Fatalf("verifyProtocolVersion failed: %v", err) + } + assertForwardingFlagAbsent(t, <-connectParams) } -func TestResumeSessionRequest_IncludeSubAgentStreamingEvents(t *testing.T) { - t.Run("defaults to true when nil", func(t *testing.T) { - req := resumeSessionRequest{ - SessionID: "s1", - IncludeSubAgentStreamingEvents: Bool(true), - } - data, err := json.Marshal(req) - if err != nil { - t.Fatalf("Failed to marshal: %v", err) +func TestGitHubTelemetryNotificationRoutesToCallback(t *testing.T) { + // The runtime forwards telemetry via a JSON-RPC *notification* (no id). + // Drive a real Content-Length-framed notification through the transport and + // verify that a real Client wired with OnGitHubTelemetry routes it to the + // callback through the client's own client-global handler registration + // (setupNotificationHandler), rather than registering the adapter by hand. + clientConn, serverConn := net.Pipe() + defer clientConn.Close() + defer serverConn.Close() + + rpcClient := jsonrpc2.NewClient(clientConn, clientConn) + rpcClient.Start() + defer rpcClient.Stop() + + // Drain the client->server direction so net.Pipe writes never block. + go func() { + buf := make([]byte, 4096) + for { + if _, err := serverConn.Read(buf); err != nil { + return + } } - var m map[string]any - if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) + }() + + received := make(chan *rpc.GitHubTelemetryNotification, 1) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + options: ClientOptions{ + OnGitHubTelemetry: func(n *rpc.GitHubTelemetryNotification) { received <- n }, + }, + } + // setupNotificationHandler is what registers the gitHubTelemetryAdapter when + // OnGitHubTelemetry is set; exercising it here covers the real client wiring. + client.setupNotificationHandler() + + notification := map[string]any{ + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": map[string]any{ + "sessionId": "sess-telemetry", + "restricted": true, + "event": map[string]any{ + "kind": "tool_call_executed", + "metrics": map[string]any{"duration_ms": 12.5}, + "properties": map[string]any{"tool": "shell"}, + }, + }, + } + data, err := json.Marshal(notification) + if err != nil { + t.Fatalf("marshal notification: %v", err) + } + go func() { + _, _ = fmt.Fprintf(serverConn, "Content-Length: %d\r\n\r\n%s", len(data), data) + }() + + select { + case n := <-received: + sessionID := "" + if n.SessionID != nil { + sessionID = *n.SessionID } - if m["includeSubAgentStreamingEvents"] != true { - t.Errorf("Expected includeSubAgentStreamingEvents to be true, got %v", m["includeSubAgentStreamingEvents"]) + if sessionID != "sess-telemetry" { + t.Errorf("session id = %q, want sess-telemetry", sessionID) } - }) - - t.Run("preserves explicit false", func(t *testing.T) { - req := resumeSessionRequest{ - SessionID: "s1", - IncludeSubAgentStreamingEvents: Bool(false), + if !n.Restricted { + t.Error("expected restricted to be true") } - data, err := json.Marshal(req) - if err != nil { - t.Fatalf("Failed to marshal: %v", err) + if n.Event.Kind != "tool_call_executed" { + t.Errorf("kind = %q, want tool_call_executed", n.Event.Kind) } - var m map[string]any - if err := json.Unmarshal(data, &m); err != nil { - t.Fatalf("Failed to unmarshal: %v", err) + if n.Event.Metrics["duration_ms"] != 12.5 { + t.Errorf("metrics[duration_ms] = %v, want 12.5", n.Event.Metrics["duration_ms"]) } - if m["includeSubAgentStreamingEvents"] != false { - t.Errorf("Expected includeSubAgentStreamingEvents to be false, got %v", m["includeSubAgentStreamingEvents"]) + if n.Event.Properties["tool"] != "shell" { + t.Errorf("properties[tool] = %q, want shell", n.Event.Properties["tool"]) } - }) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for telemetry notification") + } } func TestCreateSessionRequest_EnableOnDemandInstructionDiscovery(t *testing.T) { @@ -1724,3 +3600,325 @@ func TestStartCLIServer_StderrFieldSet(t *testing.T) { t.Error("expected Stderr to be *truncbuffer.TruncBuffer after assignment") } } + +func TestCreateSessionRequest_ExpAssignments(t *testing.T) { + assignments := &CopilotExpAssignmentResponse{ + Features: []string{"copilot_exp_flag"}, + Flights: map[string]string{"copilot_exp_flag": "treatment"}, + Configs: []ExpConfigEntry{ + {ID: "cfg-1", Parameters: map[string]ExpFlagValue{"threshold": 5, "enabled": true}}, + }, + AssignmentContext: "ctx-123", + } + + t.Run("includes expAssignments in JSON when set", func(t *testing.T) { + req := createSessionRequest{ExpAssignments: assignments} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + got, ok := m["expAssignments"].(map[string]any) + if !ok { + t.Fatalf("Expected expAssignments to be an object, got %v", m["expAssignments"]) + } + if got["AssignmentContext"] != "ctx-123" { + t.Errorf("Expected AssignmentContext 'ctx-123', got %v", got["AssignmentContext"]) + } + }) + + t.Run("omits expAssignments from JSON when nil", func(t *testing.T) { + req := createSessionRequest{} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["expAssignments"]; ok { + t.Error("Expected expAssignments to be omitted when nil") + } + }) +} + +func TestCopilotExpAssignmentResponse_MarshalNormalizesNilCollections(t *testing.T) { + // A response left with zero-value collections must still serialize the + // required fields as JSON arrays/objects, not null, so the runtime does not + // treat the payload as malformed. + data, err := json.Marshal(&CopilotExpAssignmentResponse{AssignmentContext: "ctx"}) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]json.RawMessage + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + for _, tc := range []struct{ key, want string }{ + {"Features", "[]"}, + {"Flights", "{}"}, + {"Configs", "[]"}, + {"AssignmentContext", `"ctx"`}, + } { + if got := string(m[tc.key]); got != tc.want { + t.Errorf("Expected %s to serialize as %s, got %s", tc.key, tc.want, got) + } + } + + // A nil Parameters map on an entry must likewise serialize as {}. + entryData, err := json.Marshal(ExpConfigEntry{ID: "cfg"}) + if err != nil { + t.Fatalf("Failed to marshal entry: %v", err) + } + if err := json.Unmarshal(entryData, &m); err != nil { + t.Fatalf("Failed to unmarshal entry: %v", err) + } + if got := string(m["Parameters"]); got != "{}" { + t.Errorf("Expected Parameters to serialize as {}, got %s", got) + } +} + +func TestResumeSessionRequest_ExpAssignments(t *testing.T) { + assignments := &CopilotExpAssignmentResponse{ + Features: []string{"copilot_exp_flag"}, + Flights: map[string]string{"copilot_exp_flag": "treatment"}, + Configs: []ExpConfigEntry{ + {ID: "cfg-1", Parameters: map[string]ExpFlagValue{"copilot_exp_flag": "treatment"}}, + }, + AssignmentContext: "ctx-456", + } + + t.Run("includes expAssignments in JSON when set", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", ExpAssignments: assignments} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + got, ok := m["expAssignments"].(map[string]any) + if !ok { + t.Fatalf("Expected expAssignments to be an object, got %v", m["expAssignments"]) + } + if got["AssignmentContext"] != "ctx-456" { + t.Errorf("Expected AssignmentContext 'ctx-456', got %v", got["AssignmentContext"]) + } + }) + + t.Run("omits expAssignments from JSON when nil", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1"} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["expAssignments"]; ok { + t.Error("Expected expAssignments to be omitted when nil") + } + }) +} + +func TestIsTerminal(t *testing.T) { + t.Run("IsTerminal is serialized in tool definition", func(t *testing.T) { + tool := Tool{ + Name: "clear_context", + Description: "Clear the conversation", + IsTerminal: true, + Handler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil }, + } + data, err := json.Marshal(tool) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["isTerminal"] != true { + t.Errorf("Expected isTerminal to be true, got %v", m["isTerminal"]) + } + }) + + t.Run("IsTerminal is omitted when false", func(t *testing.T) { + tool := Tool{Name: "plain", Description: "A plain tool"} + data, err := json.Marshal(tool) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["isTerminal"]; ok { + t.Error("Expected isTerminal to be omitted when false") + } + }) +} + +func TestSessionRequests_ManagedSettings(t *testing.T) { + settings := &ManagedSettings{ + Permissions: &ManagedSettingsPermissions{ + DisableBypassPermissionsMode: DisableBypassPermissionsModeDisable, + Deny: []string{"Shell(git push)"}, + Ask: []string{"Domain(publish.example)"}, + Allow: []string{"Read(**)"}, + }, + } + + expectedPermissions := map[string]any{ + "disableBypassPermissionsMode": "disable", + "deny": []any{"Shell(git push)"}, + "ask": []any{"Domain(publish.example)"}, + "allow": []any{"Read(**)"}, + } + + t.Run("direct injection enables managed safeguards", func(t *testing.T) { + if !hasManagedSettings(nil, settings) { + t.Fatal("expected injected managed settings to enable managed safeguards") + } + if hasManagedSettings(nil, nil) { + t.Fatal("expected an ordinary session to remain unmanaged") + } + }) + + t.Run("includes managedSettings on create when set", func(t *testing.T) { + req := createSessionRequest{EnableManagedSettings: Bool(true), ManagedSettings: settings} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if m["enableManagedSettings"] != true { + t.Errorf("Expected enableManagedSettings true, got %v", m["enableManagedSettings"]) + } + ms, ok := m["managedSettings"].(map[string]any) + if !ok { + t.Fatalf("Expected managedSettings object, got %v", m["managedSettings"]) + } + perms, ok := ms["permissions"].(map[string]any) + if !ok { + t.Fatalf("Expected permissions object, got %v", ms["permissions"]) + } + if !reflect.DeepEqual(perms, expectedPermissions) { + t.Errorf("permissions mismatch:\n got: %#v\nwant: %#v", perms, expectedPermissions) + } + }) + + t.Run("includes managedSettings on resume when set", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", ManagedSettings: settings} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + if err := json.Unmarshal(data, &m); err != nil { + t.Fatalf("Failed to unmarshal: %v", err) + } + if _, ok := m["managedSettings"].(map[string]any); !ok { + t.Fatalf("Expected managedSettings object, got %v", m["managedSettings"]) + } + }) + + t.Run("omits managedSettings when nil", func(t *testing.T) { + req := createSessionRequest{} + data, _ := json.Marshal(req) + var m map[string]any + json.Unmarshal(data, &m) + if _, ok := m["managedSettings"]; ok { + t.Error("Expected managedSettings to be omitted when nil") + } + }) + + t.Run("preserves explicit empty permission arrays", func(t *testing.T) { + // A non-nil empty allow list is restrictive: it admits no operations. + // Preserve field presence while still omitting nil slices. + req := createSessionRequest{ManagedSettings: &ManagedSettings{ + Permissions: &ManagedSettingsPermissions{ + DisableBypassPermissionsMode: DisableBypassPermissionsModeDisable, + Deny: []string{}, + Ask: []string{}, + Allow: []string{}, + }, + }} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + json.Unmarshal(data, &m) + perms := m["managedSettings"].(map[string]any)["permissions"].(map[string]any) + if perms["disableBypassPermissionsMode"] != "disable" { + t.Errorf("Expected disableBypassPermissionsMode preserved, got %v", perms["disableBypassPermissionsMode"]) + } + for _, key := range []string{"deny", "ask", "allow"} { + if value, ok := perms[key].([]any); !ok || len(value) != 0 { + t.Errorf("Expected %s to be an explicit empty array, got %v", key, perms[key]) + } + } + }) + + t.Run("distinguishes explicit empty allow from an absent allow", func(t *testing.T) { + // Security-critical: a present empty allow list admits nothing, while an + // absent allow list imposes no allow restriction. The wire output must + // tell these apart per-field, so an explicit empty slice serializes as + // `[]` while a nil slice is omitted entirely. + req := createSessionRequest{ManagedSettings: &ManagedSettings{ + Permissions: &ManagedSettingsPermissions{ + Allow: []string{}, // present but empty: admit nothing + // Deny and Ask left nil: no such restriction supplied. + }, + }} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + json.Unmarshal(data, &m) + perms := m["managedSettings"].(map[string]any)["permissions"].(map[string]any) + + allow, ok := perms["allow"].([]any) + if !ok || len(allow) != 0 { + t.Errorf("Expected allow to be an explicit empty array, got %v", perms["allow"]) + } + if _, present := perms["deny"]; present { + t.Errorf("Expected deny to be omitted when nil, got %v", perms["deny"]) + } + if _, present := perms["ask"]; present { + t.Errorf("Expected ask to be omitted when nil, got %v", perms["ask"]) + } + }) + + t.Run("distinguishes explicit empty arrays on resume", func(t *testing.T) { + req := resumeSessionRequest{SessionID: "s1", ManagedSettings: &ManagedSettings{ + Permissions: &ManagedSettingsPermissions{ + Deny: []string{}, + Ask: []string{}, + Allow: []string{}, + }, + }} + data, err := json.Marshal(req) + if err != nil { + t.Fatalf("Failed to marshal: %v", err) + } + var m map[string]any + json.Unmarshal(data, &m) + perms := m["managedSettings"].(map[string]any)["permissions"].(map[string]any) + for _, key := range []string{"deny", "ask", "allow"} { + if value, ok := perms[key].([]any); !ok || len(value) != 0 { + t.Errorf("Expected %s to be an explicit empty array on resume, got %v", key, perms[key]) + } + } + }) +} diff --git a/go/cmd/bundler/main.go b/go/cmd/bundler/main.go index 1e5f5ecd8..e63d1fde6 100644 --- a/go/cmd/bundler/main.go +++ b/go/cmd/bundler/main.go @@ -91,14 +91,47 @@ func main() { fmt.Printf("Building bundle for %s (CLI version %s)\n", *platform, version) - binaryPath, sha256Hash, err := buildBundle(info, version, outputPath) + binaryPath, sha256Hash, runtimeArtifactPath, runtimeHash, err := buildBundle(info, version, outputPath, goos) if err != nil { fmt.Fprintf(os.Stderr, "Error: %v\n", err) os.Exit(1) } + var muslBinaryPath, muslRuntimeArtifactPath string + var muslBinaryHash, muslRuntimeHash []byte + if goos == "linux" { + muslInfo := platformInfo{ + npmPlatform: strings.Replace(info.npmPlatform, "linux-", "linuxmusl-", 1), + binaryName: info.binaryName, + } + muslOutputPath := filepath.Join(*output, defaultOutputFileName(version, "linuxmusl", goarch, info.binaryName)) + muslBinaryPath, muslBinaryHash, muslRuntimeArtifactPath, muslRuntimeHash, err = buildBundle( + muslInfo, + version, + muslOutputPath, + goos, + ) + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + } + // Generate the Go file with embed directive - if err := generateGoFile(goos, goarch, binaryPath, version, sha256Hash, "main"); err != nil { + if err := generateGoFile( + goos, + goarch, + binaryPath, + version, + sha256Hash, + runtimeArtifactPath, + runtimeHash, + muslBinaryPath, + muslBinaryHash, + muslRuntimeArtifactPath, + muslRuntimeHash, + "main", + ); err != nil { fmt.Fprintf(os.Stderr, "Error: %v\n", err) os.Exit(1) } @@ -253,12 +286,16 @@ func isHex(s string) bool { return true } -// buildBundle downloads the CLI binary and writes it to outputPath. -func buildBundle(info platformInfo, cliVersion, outputPath string) (string, []byte, error) { +// buildBundle downloads the CLI binary (and, when the CLI package ships it, the +// native in-process runtime library) and writes them to outputPath's directory. +// It returns the CLI bundle path and hash, plus the runtime-library artifact path +// and hash (both empty when the package does not ship the runtime library). +func buildBundle(info platformInfo, cliVersion, outputPath, goos string) (string, []byte, string, []byte, error) { outputDir := filepath.Dir(outputPath) if outputDir == "" { outputDir = "." } + runtimeArtifactPath := filepath.Join(outputDir, runtimeLibArtifactName(cliVersion, info.npmPlatform, goos)) // Check if output already exists if _, err := os.Stat(outputPath); err == nil { @@ -266,68 +303,254 @@ func buildBundle(info platformInfo, cliVersion, outputPath string) (string, []by fmt.Printf("Output %s already exists, skipping download\n", outputPath) sha256Hash, err := sha256FileFromCompressed(outputPath) if err != nil { - return "", nil, fmt.Errorf("failed to hash existing output: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to hash existing output: %w", err) } if err := downloadCLILicense(cliVersion, outputPath); err != nil { - return "", nil, fmt.Errorf("failed to download CLI license: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to download CLI license: %w", err) + } + // Reuse an existing runtime-library artifact if present. + if _, err := os.Stat(runtimeArtifactPath); err == nil { + runtimeHash, err := sha256FileFromCompressed(runtimeArtifactPath) + if err != nil { + return "", nil, "", nil, fmt.Errorf("failed to hash existing runtime library: %w", err) + } + return outputPath, sha256Hash, runtimeArtifactPath, runtimeHash, nil } - return outputPath, sha256Hash, nil + return outputPath, sha256Hash, "", nil, nil } // Create temp directory for download tempDir, err := os.MkdirTemp("", "copilot-bundler-*") if err != nil { - return "", nil, fmt.Errorf("failed to create temp dir: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to create temp dir: %w", err) } defer os.RemoveAll(tempDir) // Download the binary - binaryPath, err := downloadCLIBinary(info.npmPlatform, info.binaryName, cliVersion, tempDir) + binaryPath, tarballPath, err := downloadCLIBinary(info.npmPlatform, info.binaryName, cliVersion, tempDir) if err != nil { - return "", nil, fmt.Errorf("failed to download CLI binary: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to download CLI binary: %w", err) } // Create output directory if needed if outputDir != "." { if err := os.MkdirAll(outputDir, 0755); err != nil { - return "", nil, fmt.Errorf("failed to create output directory: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to create output directory: %w", err) } } sha256Hash, err := sha256File(binaryPath) if err != nil { - return "", nil, fmt.Errorf("failed to hash output binary: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to hash output binary: %w", err) } if err := compressZstdFile(binaryPath, outputPath); err != nil { - return "", nil, fmt.Errorf("failed to write output binary: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to write output binary: %w", err) } if err := downloadCLILicense(cliVersion, outputPath); err != nil { - return "", nil, fmt.Errorf("failed to download CLI license: %w", err) + return "", nil, "", nil, fmt.Errorf("failed to download CLI license: %w", err) } + + // Extract the native in-process runtime library from the same tarball, if the + // package ships it (older CLI versions do not). Missing is not an error — the + // generated file simply omits the runtime embed for that platform. + rawLibPath := filepath.Join(tempDir, "runtime.node") + found, err := extractOptionalFileFromTarball(tarballPath, tempDir, + "package/prebuilds/"+info.npmPlatform+"/runtime.node", "runtime.node") + if err != nil { + return "", nil, "", nil, fmt.Errorf("failed to extract runtime library: %w", err) + } + var runtimeHash []byte + returnedRuntimeArtifact := "" + if found { + runtimeHash, err = sha256File(rawLibPath) + if err != nil { + return "", nil, "", nil, fmt.Errorf("failed to hash runtime library: %w", err) + } + if err := compressZstdFile(rawLibPath, runtimeArtifactPath); err != nil { + return "", nil, "", nil, fmt.Errorf("failed to write runtime library: %w", err) + } + returnedRuntimeArtifact = runtimeArtifactPath + fmt.Printf("Successfully created %s\n", runtimeArtifactPath) + } else { + fmt.Printf("Package %s does not ship a runtime library; in-process transport unavailable for this platform bundle\n", info.npmPlatform) + } + fmt.Printf("Successfully created %s\n", outputPath) - return outputPath, sha256Hash, nil + return outputPath, sha256Hash, returnedRuntimeArtifact, runtimeHash, nil } -// generateGoFile creates a Go source file that embeds the binary and metadata. -func generateGoFile(goos, goarch, binaryPath, cliVersion string, sha256Hash []byte, pkgName string) error { - // Generate Go file path: zcopilot_linux_amd64.go (without version) +// runtimeLibArtifactName builds the compressed runtime-library artifact filename. +func runtimeLibArtifactName(version, npmPlatform, goos string) string { + return fmt.Sprintf("zcopilotruntime_%s_%s.%s.zst", version, npmPlatform, runtimeLibExt(goos)) +} + +// runtimeLibExt returns the shared-library extension for the target OS. +func runtimeLibExt(goos string) string { + switch goos { + case "windows": + return "dll" + case "darwin": + return "dylib" + default: + return "so" + } +} + +// generateGoFile creates separate source files for normal and in-process builds. +// Both embed the CLI, while only the copilot_inprocess-tagged file embeds the +// native runtime library. +func generateGoFile( + goos, + goarch, + binaryPath, + cliVersion string, + sha256Hash []byte, + runtimeArtifactPath string, + runtimeHash []byte, + muslBinaryPath string, + muslBinaryHash []byte, + muslRuntimeArtifactPath string, + muslRuntimeHash []byte, + pkgName string, +) error { binaryName := filepath.Base(binaryPath) licenseName := licenseFileName(binaryName) - goFileName := fmt.Sprintf("zcopilot_%s_%s.go", goos, goarch) - goFilePath := filepath.Join(filepath.Dir(binaryPath), goFileName) hashBase64 := "" if len(sha256Hash) > 0 { hashBase64 = base64.StdEncoding.EncodeToString(sha256Hash) } - content := fmt.Sprintf(`// Code generated by copilot-sdk bundler; DO NOT EDIT. + outputDir := filepath.Dir(binaryPath) + defaultPath := filepath.Join(outputDir, fmt.Sprintf("zcopilot_%s_%s.go", goos, goarch)) + defaultContent := generatedGoFileContent( + "!copilot_inprocess", + pkgName, + binaryName, + licenseName, + cliVersion, + hashBase64, + "", + nil, + "", + nil, + "", + nil, + ) + if err := os.WriteFile(defaultPath, []byte(defaultContent), 0644); err != nil { + return err + } + + inProcessPath := filepath.Join(outputDir, fmt.Sprintf("zcopilot_inprocess_%s_%s.go", goos, goarch)) + inProcessContent := generatedGoFileContent( + "copilot_inprocess", + pkgName, + binaryName, + licenseName, + cliVersion, + hashBase64, + runtimeArtifactPath, + runtimeHash, + muslBinaryPath, + muslBinaryHash, + muslRuntimeArtifactPath, + muslRuntimeHash, + ) + if err := os.WriteFile(inProcessPath, []byte(inProcessContent), 0644); err != nil { + return err + } + + fmt.Printf("Generated %s\n", defaultPath) + fmt.Printf("Generated %s\n", inProcessPath) + return nil +} + +func generatedGoFileContent( + buildConstraint, + pkgName, + binaryName, + licenseName, + cliVersion, + hashBase64, + runtimeArtifactPath string, + runtimeHash []byte, + muslBinaryPath string, + muslBinaryHash []byte, + muslRuntimeArtifactPath string, + muslRuntimeHash []byte, +) string { + runtimeEmbed := "" + runtimeConfig := "" + runtimeReader := "" + if runtimeArtifactPath != "" { + runtimeArtifactName := filepath.Base(runtimeArtifactPath) + runtimeHashBase64 := base64.StdEncoding.EncodeToString(runtimeHash) + runtimeEmbed = fmt.Sprintf(` +//go:embed %s +var localEmbeddedCopilotRuntimeLib []byte +`, runtimeArtifactName) + runtimeConfig = fmt.Sprintf(` + RuntimeLib: runtimeLibReader(), + RuntimeLibHash: mustDecodeBase64(%q),`, runtimeHashBase64) + runtimeReader = ` +func runtimeLibReader() io.Reader { + r, err := zstd.NewReader(bytes.NewReader(localEmbeddedCopilotRuntimeLib)) + if err != nil { + panic("failed to create zstd reader: " + err.Error()) + } + return r +} +` + } + + muslEmbed := "" + muslConfig := "" + muslReaders := "" + if muslBinaryPath != "" && muslRuntimeArtifactPath != "" { + muslBinaryName := filepath.Base(muslBinaryPath) + muslBinaryHashBase64 := base64.StdEncoding.EncodeToString(muslBinaryHash) + muslRuntimeName := filepath.Base(muslRuntimeArtifactPath) + muslRuntimeHashBase64 := base64.StdEncoding.EncodeToString(muslRuntimeHash) + muslEmbed = fmt.Sprintf(` +//go:embed %s +var localEmbeddedCopilotCLILinuxMusl []byte + +//go:embed %s +var localEmbeddedCopilotRuntimeLibLinuxMusl []byte +`, muslBinaryName, muslRuntimeName) + muslConfig = fmt.Sprintf(` + LinuxMuslCli: linuxMuslCLIReader(), + LinuxMuslCliHash: mustDecodeBase64(%q), + LinuxMuslRuntimeLib: linuxMuslRuntimeLibReader(), + LinuxMuslRuntimeLibHash: mustDecodeBase64(%q),`, muslBinaryHashBase64, muslRuntimeHashBase64) + muslReaders = ` +func linuxMuslCLIReader() io.Reader { + r, err := zstd.NewReader(bytes.NewReader(localEmbeddedCopilotCLILinuxMusl)) + if err != nil { + panic("failed to create zstd reader: " + err.Error()) + } + return r +} + +func linuxMuslRuntimeLibReader() io.Reader { + r, err := zstd.NewReader(bytes.NewReader(localEmbeddedCopilotRuntimeLibLinuxMusl)) + if err != nil { + panic("failed to create zstd reader: " + err.Error()) + } + return r +} +` + } + + return fmt.Sprintf(`//go:build %s + +// Code generated by copilot-sdk bundler; DO NOT EDIT. package %s import ( "bytes" - "io" "encoding/base64" _ "embed" + "io" "github.com/github/copilot-sdk/go/embeddedcli" "github.com/klauspost/compress/zstd" @@ -338,14 +561,15 @@ var localEmbeddedCopilotCLI []byte //go:embed %s var localEmbeddedCopilotCLILicense []byte - +%s +%s func init() { embeddedcli.Setup(embeddedcli.Config{ Cli: cliReader(), License: localEmbeddedCopilotCLILicense, Version: %q, - CliHash: mustDecodeBase64(%q), + CliHash: mustDecodeBase64(%q),%s%s }) } @@ -356,7 +580,8 @@ func cliReader() io.Reader { } return r } - +%s +%s func mustDecodeBase64(s string) []byte { b, err := base64.StdEncoding.DecodeString(s) if err != nil { @@ -364,73 +589,68 @@ func mustDecodeBase64(s string) []byte { } return b } -`, pkgName, binaryName, licenseName, cliVersion, hashBase64) - - if err := os.WriteFile(goFilePath, []byte(content), 0644); err != nil { - return err - } - - fmt.Printf("Generated %s\n", goFilePath) - return nil +`, buildConstraint, pkgName, binaryName, licenseName, runtimeEmbed, muslEmbed, cliVersion, hashBase64, runtimeConfig, muslConfig, runtimeReader, muslReaders) } -// downloadCLIBinary downloads the npm tarball and extracts the CLI binary. -func downloadCLIBinary(npmPlatform, binaryName, cliVersion, destDir string) (string, error) { +// downloadCLIBinary downloads the npm tarball and extracts the CLI binary. It +// returns the extracted binary path and the downloaded tarball path (retained so +// callers can extract additional files, such as the runtime library). +func downloadCLIBinary(npmPlatform, binaryName, cliVersion, destDir string) (string, string, error) { tarballURL := fmt.Sprintf(tarballURLFmt, npmPlatform, npmPlatform, cliVersion) fmt.Printf("Downloading from %s...\n", tarballURL) resp, err := http.Get(tarballURL) if err != nil { - return "", fmt.Errorf("failed to download: %w", err) + return "", "", fmt.Errorf("failed to download: %w", err) } defer resp.Body.Close() if resp.StatusCode != http.StatusOK { - return "", fmt.Errorf("failed to download: %s", resp.Status) + return "", "", fmt.Errorf("failed to download: %s", resp.Status) } // Save tarball to temp file tarballPath := filepath.Join(destDir, fmt.Sprintf("copilot-%s-%s.tgz", npmPlatform, cliVersion)) tarballFile, err := os.Create(tarballPath) if err != nil { - return "", fmt.Errorf("failed to create tarball file: %w", err) + return "", "", fmt.Errorf("failed to create tarball file: %w", err) } if _, err := io.Copy(tarballFile, resp.Body); err != nil { tarballFile.Close() - return "", fmt.Errorf("failed to save tarball: %w", err) + return "", "", fmt.Errorf("failed to save tarball: %w", err) } if err := tarballFile.Close(); err != nil { - return "", fmt.Errorf("failed to close tarball file: %w", err) + return "", "", fmt.Errorf("failed to close tarball file: %w", err) } // Extract only the CLI binary to avoid unpacking the full package tree. binaryPath := filepath.Join(destDir, binaryName) if err := extractFileFromTarball(tarballPath, destDir, "package/"+binaryName, binaryName); err != nil { - return "", fmt.Errorf("failed to extract binary: %w", err) + return "", "", fmt.Errorf("failed to extract binary: %w", err) } // Verify binary exists if _, err := os.Stat(binaryPath); err != nil { - return "", fmt.Errorf("binary not found after extraction: %w", err) + return "", "", fmt.Errorf("binary not found after extraction: %w", err) } // Make executable on Unix if !strings.HasSuffix(binaryName, ".exe") { if err := os.Chmod(binaryPath, 0755); err != nil { - return "", fmt.Errorf("failed to chmod binary: %w", err) + return "", "", fmt.Errorf("failed to chmod binary: %w", err) } } stat, err := os.Stat(binaryPath) if err != nil { - return "", fmt.Errorf("failed to stat binary: %w", err) + return "", "", fmt.Errorf("failed to stat binary: %w", err) } sizeMB := float64(stat.Size()) / 1024 / 1024 fmt.Printf("Downloaded %s (%.1f MB)\n", binaryName, sizeMB) - return binaryPath, nil + return binaryPath, tarballPath, nil } // downloadCLILicense downloads the @github/copilot package and writes its license next to outputPath. @@ -561,6 +781,21 @@ func extractFileFromTarball(tarballPath, destDir, targetPath, outputName string) return fmt.Errorf("file %q not found in tarball", targetPath) } +// extractOptionalFileFromTarball extracts a single file from a .tgz into destDir +// like extractFileFromTarball, but returns (false, nil) instead of an error when +// the file is absent. Used for the runtime library, which older CLI packages do +// not ship. +func extractOptionalFileFromTarball(tarballPath, destDir, targetPath, outputName string) (bool, error) { + err := extractFileFromTarball(tarballPath, destDir, targetPath, outputName) + if err == nil { + return true, nil + } + if strings.Contains(err.Error(), "not found in tarball") { + return false, nil + } + return false, err +} + // compressZstdFile compresses src into dst using zstd. func compressZstdFile(src, dst string) error { srcFile, err := os.Open(src) diff --git a/go/cmd/bundler/main_test.go b/go/cmd/bundler/main_test.go new file mode 100644 index 000000000..badc79135 --- /dev/null +++ b/go/cmd/bundler/main_test.go @@ -0,0 +1,81 @@ +package main + +import ( + "go/parser" + "go/token" + "os" + "path/filepath" + "strings" + "testing" +) + +func TestGenerateGoFileGatesRuntimeEmbed(t *testing.T) { + dir := t.TempDir() + binaryPath := filepath.Join(dir, "copilot.zst") + runtimePath := filepath.Join(dir, "runtime.node.zst") + muslBinaryPath := filepath.Join(dir, "copilot-musl.zst") + muslRuntimePath := filepath.Join(dir, "runtime-musl.node.zst") + for _, path := range []string{ + binaryPath, + licensePathForOutput(binaryPath), + runtimePath, + muslBinaryPath, + muslRuntimePath, + } { + if err := os.WriteFile(path, []byte("test"), 0644); err != nil { + t.Fatal(err) + } + } + + hash := make([]byte, 32) + if err := generateGoFile( + "linux", + "amd64", + binaryPath, + "1.2.3", + hash, + runtimePath, + hash, + muslBinaryPath, + hash, + muslRuntimePath, + hash, + "main", + ); err != nil { + t.Fatal(err) + } + + defaultSource, err := os.ReadFile(filepath.Join(dir, "zcopilot_linux_amd64.go")) + if err != nil { + t.Fatal(err) + } + if !strings.Contains(string(defaultSource), "//go:build !copilot_inprocess") { + t.Fatal("default embed file does not exclude copilot_inprocess builds") + } + if strings.Contains(string(defaultSource), "localEmbeddedCopilotRuntimeLib") { + t.Fatal("default embed file includes the native runtime") + } + if _, err := parser.ParseFile(token.NewFileSet(), "zcopilot_linux_amd64.go", defaultSource, parser.AllErrors); err != nil { + t.Fatalf("default generated source is invalid: %v", err) + } + + inProcessSource, err := os.ReadFile(filepath.Join(dir, "zcopilot_inprocess_linux_amd64.go")) + if err != nil { + t.Fatal(err) + } + if !strings.Contains(string(inProcessSource), "//go:build copilot_inprocess") { + t.Fatal("in-process embed file does not require the copilot_inprocess tag") + } + if !strings.Contains(string(inProcessSource), "localEmbeddedCopilotRuntimeLib") { + t.Fatal("in-process embed file does not include the native runtime") + } + if !strings.Contains(string(inProcessSource), "localEmbeddedCopilotCLILinuxMusl") { + t.Fatal("in-process embed file does not include the Linux musl CLI") + } + if !strings.Contains(string(inProcessSource), "localEmbeddedCopilotRuntimeLibLinuxMusl") { + t.Fatal("in-process embed file does not include the Linux musl runtime") + } + if _, err := parser.ParseFile(token.NewFileSet(), "zcopilot_inprocess_linux_amd64.go", inProcessSource, parser.AllErrors); err != nil { + t.Fatalf("in-process generated source is invalid: %v", err) + } +} diff --git a/go/copilot_request_handler.go b/go/copilot_request_handler.go new file mode 100644 index 000000000..ba8bb9b91 --- /dev/null +++ b/go/copilot_request_handler.go @@ -0,0 +1,863 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package copilot + +import ( + "bytes" + "context" + "encoding/base64" + "fmt" + "io" + "net/http" + "strconv" + "strings" + "sync" + + "github.com/coder/websocket" + "github.com/github/copilot-sdk/go/rpc" +) + +// Hop-by-hop and length headers the transport recomputes; forwarding them +// verbatim corrupts the request. +var forbiddenRequestHeaders = map[string]struct{}{ + "host": {}, + "connection": {}, + "content-length": {}, + "transfer-encoding": {}, + "keep-alive": {}, + "upgrade": {}, + "proxy-connection": {}, + "te": {}, + "trailer": {}, +} + +func isForbiddenRequestHeader(name string) bool { + lower := strings.ToLower(name) + if _, ok := forbiddenRequestHeaders[lower]; ok { + return true + } + return strings.HasPrefix(lower, "sec-websocket-") +} + +var sharedHTTPTransport = func() http.RoundTripper { + t := http.DefaultTransport.(*http.Transport).Clone() + t.DisableCompression = true + return t +}() + +// CopilotRequestContext is the per-request context handed to every +// [CopilotRequestHandler] seam. +type CopilotRequestContext struct { + RequestID string + SessionID string + AgentID string + ParentAgentID string + InteractionType string + // Transport is "http" (covering plain HTTP and SSE) or "websocket". + Transport string + Method string + URL string + Headers http.Header + // body yields request body frames as they arrive from the runtime. It is + // unexported framework plumbing: the adapter drains it for HTTP requests + // and pumps it to [CopilotWebSocketHandler.SendRequestMessage] for + // WebSocket requests. Consumers read the HTTP body via the standard + // [http.Request] Body in a custom RoundTripper, or receive WebSocket frames + // via SendRequestMessage — never from this channel directly (doing so would + // race the adapter's pump goroutine and lose frames). The channel is closed + // when the body ends or the request is cancelled. For WebSocket requests + // each frame's Binary flag distinguishes a binary frame from a UTF-8 text + // frame; for HTTP it is always a body byte chunk. + body <-chan CopilotWebSocketMessage + // Context is cancelled when the runtime cancels this in-flight request. + Context context.Context +} + +// CopilotWebSocketCloseStatus is the terminal status for a callback-owned +// WebSocket connection. +type CopilotWebSocketCloseStatus struct { + Description string + ErrorCode string + Err error +} + +// CopilotWebSocketMessage is a single WebSocket frame exchanged through the +// handler seam. Binary distinguishes a binary frame from a UTF-8 text frame. +type CopilotWebSocketMessage struct { + Data []byte + Binary bool +} + +// Text decodes the frame payload as a UTF-8 string. +func (m CopilotWebSocketMessage) Text() string { return string(m.Data) } + +// NewTextMessage creates a text-frame message from a UTF-8 string. Binary +// frames are constructed directly with CopilotWebSocketMessage{Data: ..., Binary: true}. +func NewTextMessage(text string) CopilotWebSocketMessage { + return CopilotWebSocketMessage{Data: []byte(text), Binary: false} +} + +// CopilotRequestHandler is the idiomatic handler for intercepting or replacing +// LLM inference requests. HTTP requests are forwarded through Transport (an +// [http.RoundTripper]); supply a custom RoundTripper to mutate the request, +// post-process the response, or replace the call entirely. WebSocket requests +// are serviced by OpenWebSocket; supply one to return a custom handler. +// +// The default behaviour (both fields nil) transparently forwards HTTP through a +// shared transport and opens a forwarding WebSocket connection to the runtime's +// original URL. +type CopilotRequestHandler struct { + // Transport forwards HTTP requests. When nil a shared default transport is + // used. RoundTrip is called directly, so redirects are not followed. + Transport http.RoundTripper + // OpenWebSocket returns a per-connection WebSocket handler. When nil a + // transparent [CopilotWebSocketForwarder] to the request URL is opened. + OpenWebSocket func(ctx *CopilotRequestContext) (CopilotWebSocketHandler, error) +} + +// WebSocketResponseWriter forwards upstream→runtime WebSocket messages back +// into the runtime response. A [CopilotWebSocketHandler] receives one in +// [CopilotWebSocketHandler.Open]. +type WebSocketResponseWriter interface { + // SendText forwards an upstream text message to the runtime. + SendText(data []byte) error + // SendBinary forwards an upstream binary message to the runtime. + SendBinary(data []byte) error +} + +// CopilotWebSocketHandler is a per-connection WebSocket handler returned by +// [CopilotRequestHandler.OpenWebSocket]. The default implementation is +// [CopilotWebSocketForwarder]; a full transport replacement implements +// this interface directly. +type CopilotWebSocketHandler interface { + // Open establishes the connection and starts forwarding upstream→runtime + // messages into resp. It must not block. ctx is cancelled on teardown. + Open(ctx context.Context, resp WebSocketResponseWriter) error + // SendRequestMessage forwards one runtime→upstream message. + SendRequestMessage(ctx context.Context, msg CopilotWebSocketMessage) error + // Done is closed when the upstream connection completes (closed or errored). + Done() <-chan struct{} + // Err returns the terminal error after Done is closed, or nil on clean close. + Err() error + // Close tears down the connection. + Close() error +} + +// copilotContextKey is used to attach [CopilotRequestContext] to an +// [http.Request] so custom [http.RoundTripper] implementations can access +// metadata (e.g. SessionID and AgentID) without additional parameters. +type copilotContextKey struct{} + +// RequestContextFrom returns the [CopilotRequestContext] attached to an +// http.Request by the adapter, or nil if not present. Call this from a custom +// [http.RoundTripper] to access metadata such as SessionID and AgentID. +func RequestContextFrom(r *http.Request) *CopilotRequestContext { + v, _ := r.Context().Value(copilotContextKey{}).(*CopilotRequestContext) + return v +} + +func (h *CopilotRequestHandler) handle(rctx *CopilotRequestContext, sink *responseSink) error { + if rctx.Transport == "websocket" { + return h.handleWebSocket(rctx, sink) + } + return h.handleHTTP(rctx, sink) +} + +func (h *CopilotRequestHandler) roundTripper() http.RoundTripper { + if h.Transport != nil { + return h.Transport + } + return sharedHTTPTransport +} + +func (h *CopilotRequestHandler) handleHTTP(rctx *CopilotRequestContext, sink *responseSink) error { + httpReq, err := buildHTTPRequest(rctx) + if err != nil { + return err + } + resp, err := h.roundTripper().RoundTrip(httpReq) + if err != nil { + return err + } + defer resp.Body.Close() + return streamResponseToSink(resp, sink) +} + +func buildHTTPRequest(rctx *CopilotRequestContext) (*http.Request, error) { + body := drainBody(rctx.body) + method := strings.ToUpper(rctx.Method) + var bodyReader io.Reader + if len(body) > 0 && method != http.MethodGet && method != http.MethodHead { + bodyReader = bytes.NewReader(body) + } + httpReq, err := http.NewRequestWithContext(rctx.Context, method, rctx.URL, bodyReader) + if err != nil { + return nil, err + } + // Attach rctx so custom RoundTripper implementations can read metadata + // (e.g. SessionID and AgentID) via [RequestContextFrom]. + httpReq = httpReq.WithContext(context.WithValue(httpReq.Context(), copilotContextKey{}, rctx)) + for name, values := range rctx.Headers { + if isForbiddenRequestHeader(name) { + continue + } + for _, v := range values { + httpReq.Header.Add(name, v) + } + } + return httpReq, nil +} + +func drainBody(ch <-chan CopilotWebSocketMessage) []byte { + var buf bytes.Buffer + for frame := range ch { + buf.Write(frame.Data) + } + return buf.Bytes() +} + +func streamResponseToSink(resp *http.Response, sink *responseSink) error { + if err := sink.start(resp.StatusCode, statusText(resp), cloneHeader(resp.Header)); err != nil { + return err + } + buf := make([]byte, 32*1024) + for { + n, readErr := resp.Body.Read(buf) + if n > 0 { + // writeText copies eagerly via string(...), so the reused read + // buffer can be passed directly without an extra per-chunk alloc. + if err := sink.writeText(buf[:n]); err != nil { + return err + } + } + if readErr == io.EOF { + break + } + if readErr != nil { + return sink.sinkError(readErr.Error(), "") + } + } + return sink.end() +} + +func statusText(resp *http.Response) string { + return strings.TrimSpace(strings.TrimPrefix(resp.Status, strconv.Itoa(resp.StatusCode))) +} + +func cloneHeader(h http.Header) http.Header { + out := http.Header{} + for k, vs := range h { + out[k] = append([]string(nil), vs...) + } + return out +} + +func (h *CopilotRequestHandler) handleWebSocket(rctx *CopilotRequestContext, sink *responseSink) error { + var handler CopilotWebSocketHandler + var err error + if h.OpenWebSocket != nil { + handler, err = h.OpenWebSocket(rctx) + } else { + handler = NewCopilotWebSocketForwarder(rctx.URL, rctx.Headers) + } + if err != nil { + return err + } + + writer := &wsResponseWriter{sink: sink} + // Emit the 101 upgrade head eagerly — the runtime gates connect_via_callback + // on receiving httpResponseStart/101 before sending request chunks; a lazy + // first-write start deadlocks until timeout. + if err := writer.start(); err != nil { + return err + } + if err := handler.Open(rctx.Context, writer); err != nil { + return writer.fail(err.Error(), "") + } + defer func() { _ = handler.Close() }() + + clientDone := make(chan struct{}) + go func() { + defer close(clientDone) + for { + select { + case frame, ok := <-rctx.body: + if !ok { + return + } + if err := handler.SendRequestMessage(rctx.Context, frame); err != nil { + return + } + case <-rctx.Context.Done(): + return + } + } + }() + + select { + case <-handler.Done(): + if e := handler.Err(); e != nil { + return writer.fail(e.Error(), "") + } + return writer.end() + case <-clientDone: + _ = handler.Close() + <-handler.Done() + if e := handler.Err(); e != nil { + return writer.fail(e.Error(), "") + } + return writer.end() + case <-rctx.Context.Done(): + return writer.fail("Request cancelled by runtime", "cancelled") + } +} + +// wsResponseWriter serialises WebSocket response writes into the sink. +type wsResponseWriter struct { + mu sync.Mutex + sink *responseSink + started bool + completed bool +} + +func (w *wsResponseWriter) start() error { + w.mu.Lock() + defer w.mu.Unlock() + if w.started { + return nil + } + w.started = true + return w.sink.start(101, "", http.Header{}) +} + +func (w *wsResponseWriter) SendText(data []byte) error { + w.mu.Lock() + defer w.mu.Unlock() + if w.completed { + return nil + } + return w.sink.writeText(data) +} + +func (w *wsResponseWriter) SendBinary(data []byte) error { + w.mu.Lock() + defer w.mu.Unlock() + if w.completed { + return nil + } + return w.sink.writeBinary(data) +} + +func (w *wsResponseWriter) end() error { + w.mu.Lock() + defer w.mu.Unlock() + if w.completed { + return nil + } + w.completed = true + return w.sink.end() +} + +func (w *wsResponseWriter) fail(message string, code string) error { + w.mu.Lock() + defer w.mu.Unlock() + if w.completed { + return nil + } + w.completed = true + return w.sink.sinkError(message, code) +} + +// CopilotWebSocketForwarder is the default [CopilotWebSocketHandler]: +// it dials the real upstream and runs a receive loop forwarding upstream→runtime +// messages. Set OnSendRequestMessage / OnSendResponseMessage to observe, +// transform, or drop messages in either direction. +type CopilotWebSocketForwarder struct { + URL string + Headers http.Header + // OnSendRequestMessage observes or transforms each runtime→upstream frame. + // The frame type (text vs binary) is available via the message's Binary + // field and may be changed in the returned message. Return nil to drop the + // frame. + OnSendRequestMessage func(msg CopilotWebSocketMessage) *CopilotWebSocketMessage + // OnSendResponseMessage observes or transforms each upstream→runtime frame. + // The frame type (text vs binary) is available via the message's Binary + // field and may be changed in the returned message. Return nil to drop the + // frame. + OnSendResponseMessage func(msg CopilotWebSocketMessage) *CopilotWebSocketMessage + + conn *websocket.Conn + resp WebSocketResponseWriter + done chan struct{} + err error + closeOnce sync.Once +} + +// NewCopilotWebSocketForwarder creates a forwarding handler targeting +// url with the given handshake headers. +func NewCopilotWebSocketForwarder(url string, headers http.Header) *CopilotWebSocketForwarder { + return &CopilotWebSocketForwarder{URL: url, Headers: headers, done: make(chan struct{})} +} + +func (f *CopilotWebSocketForwarder) Open(ctx context.Context, resp WebSocketResponseWriter) error { + f.resp = resp + if f.done == nil { + f.done = make(chan struct{}) + } + opts := &websocket.DialOptions{HTTPHeader: f.dialHeaders()} + conn, _, err := websocket.Dial(ctx, f.URL, opts) + if err != nil { + return err + } + conn.SetReadLimit(-1) + f.conn = conn + go f.receiveLoop(ctx) + return nil +} + +func (f *CopilotWebSocketForwarder) dialHeaders() http.Header { + out := http.Header{} + for name, values := range f.Headers { + if isForbiddenRequestHeader(name) { + continue + } + for _, v := range values { + out.Add(name, v) + } + } + return out +} + +func (f *CopilotWebSocketForwarder) receiveLoop(ctx context.Context) { + defer close(f.done) + for { + typ, data, err := f.conn.Read(ctx) + if err != nil { + if websocket.CloseStatus(err) == websocket.StatusNormalClosure || websocket.CloseStatus(err) == websocket.StatusGoingAway { + f.err = nil + } else if ctx.Err() != nil { + f.err = nil + } else { + f.err = err + } + return + } + out := CopilotWebSocketMessage{Data: data, Binary: typ == websocket.MessageBinary} + if f.OnSendResponseMessage != nil { + transformed := f.OnSendResponseMessage(out) + if transformed == nil { + continue + } + out = *transformed + } + if out.Binary { + _ = f.resp.SendBinary(out.Data) + } else { + _ = f.resp.SendText(out.Data) + } + } +} + +func (f *CopilotWebSocketForwarder) SendRequestMessage(ctx context.Context, msg CopilotWebSocketMessage) error { + out := msg + if f.OnSendRequestMessage != nil { + transformed := f.OnSendRequestMessage(msg) + if transformed == nil { + return nil + } + out = *transformed + } + if f.conn == nil { + return nil + } + msgType := websocket.MessageText + if out.Binary { + msgType = websocket.MessageBinary + } + return f.conn.Write(ctx, msgType, out.Data) +} + +func (f *CopilotWebSocketForwarder) Done() <-chan struct{} { return f.done } +func (f *CopilotWebSocketForwarder) Err() error { return f.err } + +func (f *CopilotWebSocketForwarder) Close() error { + f.closeOnce.Do(func() { + if f.conn != nil { + _ = f.conn.Close(websocket.StatusNormalClosure, "") + } + }) + return nil +} + +// --- Internal adapter --- + +// frameQueue is an unbounded FIFO of body frames, decoupling the RPC dispatch +// goroutine (which only pushes) from the consumer goroutine (which pops). +type frameQueue struct { + mu sync.Mutex + cond *sync.Cond + items []CopilotWebSocketMessage + done bool +} + +func newFrameQueue() *frameQueue { + q := &frameQueue{} + q.cond = sync.NewCond(&q.mu) + return q +} + +func (q *frameQueue) push(m CopilotWebSocketMessage) { + q.mu.Lock() + if !q.done { + q.items = append(q.items, m) + } + q.cond.Signal() + q.mu.Unlock() +} + +func (q *frameQueue) close() { + q.mu.Lock() + q.done = true + q.cond.Broadcast() + q.mu.Unlock() +} + +func (q *frameQueue) pop() (CopilotWebSocketMessage, bool) { + q.mu.Lock() + defer q.mu.Unlock() + for len(q.items) == 0 && !q.done { + q.cond.Wait() + } + if len(q.items) > 0 { + m := q.items[0] + q.items = q.items[1:] + return m, true + } + return CopilotWebSocketMessage{}, false +} + +type pendingExchange struct { + mu sync.Mutex + queue *frameQueue + ctx context.Context + cancel context.CancelFunc + started bool + finished bool +} + +type copilotRequestAdapter struct { + handler *CopilotRequestHandler + getRPC func() *rpc.ServerLlmInferenceAPI + + mu sync.Mutex + pending map[string]*pendingExchange +} + +func newCopilotRequestAdapter(handler *CopilotRequestHandler, getRPC func() *rpc.ServerLlmInferenceAPI) rpc.LlmInferenceHandler { + return &copilotRequestAdapter{ + handler: handler, + getRPC: getRPC, + pending: make(map[string]*pendingExchange), + } +} + +// getOrCreateExchange returns the exchange for requestID, allocating one if it +// does not yet exist. The runtime dispatches httpRequestStart and +// httpRequestChunk frames on separate goroutines (see jsonrpc2.handleRequest), +// so a body chunk — including the terminal end frame — can arrive before its +// start frame runs. Creating the exchange (and its buffering frameQueue) on +// first touch means those chunks are buffered rather than dropped, instead of +// hanging the body drain forever. +func (a *copilotRequestAdapter) getOrCreateExchange(requestID string) *pendingExchange { + a.mu.Lock() + defer a.mu.Unlock() + if exchange, ok := a.pending[requestID]; ok { + return exchange + } + ctx, cancel := context.WithCancel(context.Background()) + exchange := &pendingExchange{queue: newFrameQueue(), ctx: ctx, cancel: cancel} + a.pending[requestID] = exchange + return exchange +} + +func (a *copilotRequestAdapter) HttpRequestStart(params *rpc.LlmInferenceHTTPRequestStartRequest) (*rpc.LlmInferenceHTTPRequestStartResult, error) { + // Adopt any exchange a racing chunk already created — with its buffered + // body — rather than dropping those frames. + exchange := a.getOrCreateExchange(params.RequestID) + ctx := exchange.ctx + bodyCh := make(chan CopilotWebSocketMessage) + + go func() { + defer close(bodyCh) + for { + m, ok := exchange.queue.pop() + if !ok { + return + } + select { + case bodyCh <- m: + case <-ctx.Done(): + return + } + } + }() + + transport := "http" + if params.Transport != nil { + transport = string(*params.Transport) + } + sessionID := "" + if params.SessionID != nil { + sessionID = *params.SessionID + } + headers := http.Header{} + for k, v := range params.Headers { + headers[k] = append([]string(nil), v...) + } + + rctx := &CopilotRequestContext{ + RequestID: params.RequestID, + SessionID: sessionID, + AgentID: stringOrEmpty(params.AgentID), + ParentAgentID: stringOrEmpty(params.ParentAgentID), + InteractionType: stringOrEmpty(params.InteractionType), + Method: params.Method, + URL: params.URL, + Headers: headers, + Transport: transport, + body: bodyCh, + Context: ctx, + } + sink := &responseSink{requestID: params.RequestID, adapter: a, exchange: exchange} + go a.runHandler(rctx, sink, exchange) + return &rpc.LlmInferenceHTTPRequestStartResult{}, nil +} + +func (a *copilotRequestAdapter) HttpRequestChunk(params *rpc.LlmInferenceHTTPRequestChunkRequest) (*rpc.LlmInferenceHTTPRequestChunkResult, error) { + // May arrive before the matching start frame (frames are dispatched on + // separate goroutines); get-or-create so the body is buffered, never lost. + exchange := a.getOrCreateExchange(params.RequestID) + a.routeChunk(exchange, params) + return &rpc.LlmInferenceHTTPRequestChunkResult{}, nil +} + +func (a *copilotRequestAdapter) routeChunk(exchange *pendingExchange, params *rpc.LlmInferenceHTTPRequestChunkRequest) { + if params.Cancel != nil && *params.Cancel { + exchange.cancel() + exchange.queue.close() + return + } + if params.Data != "" { + binary := params.Binary != nil && *params.Binary + if data, err := decodeChunkData(params.Data, binary); err == nil { + exchange.queue.push(CopilotWebSocketMessage{Data: data, Binary: binary}) + } + } + if params.End != nil && *params.End { + exchange.queue.close() + } +} + +func (a *copilotRequestAdapter) runHandler(rctx *CopilotRequestContext, sink *responseSink, exchange *pendingExchange) { + err := a.handler.handle(rctx, sink) + if err != nil { + if exchange.ctx.Err() != nil { + a.finishCancelled(sink, exchange) + return + } + a.failViaSink(sink, exchange, err.Error()) + return + } + exchange.mu.Lock() + finished := exchange.finished + exchange.mu.Unlock() + if !finished { + a.failViaSink(sink, exchange, "CopilotRequestHandler returned without finalising the response") + } +} + +func (a *copilotRequestAdapter) failViaSink(sink *responseSink, exchange *pendingExchange, message string) { + exchange.mu.Lock() + finished := exchange.finished + started := exchange.started + exchange.mu.Unlock() + if finished { + return + } + if !started { + _ = sink.start(502, "", http.Header{}) + } + _ = sink.sinkError(message, "") +} + +func (a *copilotRequestAdapter) finishCancelled(sink *responseSink, exchange *pendingExchange) { + exchange.mu.Lock() + finished := exchange.finished + started := exchange.started + exchange.mu.Unlock() + if finished { + return + } + if !started { + _ = sink.start(499, "", http.Header{}) + } + _ = sink.sinkError("Request cancelled by runtime", "cancelled") +} + +func (a *copilotRequestAdapter) removePending(requestID string) { + a.mu.Lock() + delete(a.pending, requestID) + a.mu.Unlock() +} + +func stringOrEmpty(value *string) string { + if value == nil { + return "" + } + return *value +} + +func decodeChunkData(data string, binary bool) ([]byte, error) { + if binary { + return base64.StdEncoding.DecodeString(data) + } + return []byte(data), nil +} + +// responseSink writes response frames to the runtime via RPC. +type responseSink struct { + requestID string + adapter *copilotRequestAdapter + exchange *pendingExchange +} + +func (s *responseSink) rpcAPI() (*rpc.ServerLlmInferenceAPI, error) { + r := s.adapter.getRPC() + if r == nil { + return nil, fmt.Errorf("CopilotRequestHandler response sink used after RPC connection closed") + } + return r, nil +} + +func (s *responseSink) start(status int, statusTxt string, headers http.Header) error { + s.exchange.mu.Lock() + if s.exchange.started { + s.exchange.mu.Unlock() + return fmt.Errorf("CopilotRequestHandler response sink Start() called twice") + } + if s.exchange.finished { + s.exchange.mu.Unlock() + return fmt.Errorf("CopilotRequestHandler response sink already finished") + } + s.exchange.started = true + s.exchange.mu.Unlock() + + api, err := s.rpcAPI() + if err != nil { + return err + } + var st *string + if statusTxt != "" { + st = &statusTxt + } + h := map[string][]string(headers) + if h == nil { + h = map[string][]string{} + } + _, err = api.HttpResponseStart(context.Background(), &rpc.LlmInferenceHTTPResponseStartRequest{ + RequestID: s.requestID, + Status: int64(status), + StatusText: st, + Headers: h, + }) + return err +} + +func (s *responseSink) writeText(data []byte) error { + return s.writeRaw(string(data), false) +} + +func (s *responseSink) writeBinary(data []byte) error { + return s.writeRaw(base64.StdEncoding.EncodeToString(data), true) +} + +func (s *responseSink) writeRaw(data string, binary bool) error { + s.exchange.mu.Lock() + started := s.exchange.started + finished := s.exchange.finished + s.exchange.mu.Unlock() + if !started { + return fmt.Errorf("CopilotRequestHandler response sink Write() called before Start()") + } + if finished { + return fmt.Errorf("CopilotRequestHandler response sink Write() called after End()/Error()") + } + api, err := s.rpcAPI() + if err != nil { + return err + } + end := false + chunk := &rpc.LlmInferenceHTTPResponseChunkRequest{ + RequestID: s.requestID, + Data: data, + End: &end, + } + if binary { + b := true + chunk.Binary = &b + } + _, err = api.HttpResponseChunk(context.Background(), chunk) + return err +} + +func (s *responseSink) end() error { + s.exchange.mu.Lock() + if s.exchange.finished { + s.exchange.mu.Unlock() + return nil + } + s.exchange.finished = true + s.exchange.mu.Unlock() + s.adapter.removePending(s.requestID) + api, err := s.rpcAPI() + if err != nil { + return err + } + end := true + _, err = api.HttpResponseChunk(context.Background(), &rpc.LlmInferenceHTTPResponseChunkRequest{ + RequestID: s.requestID, + Data: "", + End: &end, + }) + return err +} + +func (s *responseSink) sinkError(message string, code string) error { + s.exchange.mu.Lock() + if s.exchange.finished { + s.exchange.mu.Unlock() + return nil + } + s.exchange.finished = true + s.exchange.mu.Unlock() + s.adapter.removePending(s.requestID) + api, err := s.rpcAPI() + if err != nil { + return err + } + end := true + chunkErr := &rpc.LlmInferenceHTTPResponseChunkError{Message: message} + if code != "" { + c := code + chunkErr.Code = &c + } + _, err = api.HttpResponseChunk(context.Background(), &rpc.LlmInferenceHTTPResponseChunkRequest{ + RequestID: s.requestID, + Data: "", + End: &end, + Error: chunkErr, + }) + return err +} diff --git a/go/definetool.go b/go/definetool.go index ccaa69a58..a63aeab9f 100644 --- a/go/definetool.go +++ b/go/definetool.go @@ -159,7 +159,7 @@ func ConvertMCPCallToolResult(value any) (ToolResult, bool) { } binaryResults = append(binaryResults, ToolBinaryResult{ Data: data, - MimeType: mimeType, + MIMEType: mimeType, Type: "image", }) case "resource": @@ -175,7 +175,7 @@ func ConvertMCPCallToolResult(value any) (ToolResult, bool) { uri, _ := resRaw["uri"].(string) binaryResults = append(binaryResults, ToolBinaryResult{ Data: blob, - MimeType: mimeType, + MIMEType: mimeType, Type: "resource", Description: uri, }) @@ -207,7 +207,7 @@ func generateSchemaForType(t reflect.Type) map[string]any { } // Handle pointer types - if t.Kind() == reflect.Ptr { + if t.Kind() == reflect.Pointer { t = t.Elem() } diff --git a/go/definetool_test.go b/go/definetool_test.go index cc9fecb2c..f7161fb94 100644 --- a/go/definetool_test.go +++ b/go/definetool_test.go @@ -358,8 +358,8 @@ func TestConvertMCPCallToolResult(t *testing.T) { if result.BinaryResultsForLLM[0].Data != "base64data" { t.Errorf("Expected data 'base64data', got %q", result.BinaryResultsForLLM[0].Data) } - if result.BinaryResultsForLLM[0].MimeType != "image/png" { - t.Errorf("Expected mimeType 'image/png', got %q", result.BinaryResultsForLLM[0].MimeType) + if result.BinaryResultsForLLM[0].MIMEType != "image/png" { + t.Errorf("Expected mimeType 'image/png', got %q", result.BinaryResultsForLLM[0].MIMEType) } }) diff --git a/go/embeddedcli/installer.go b/go/embeddedcli/installer.go index deb4c2eef..9702b3aec 100644 --- a/go/embeddedcli/installer.go +++ b/go/embeddedcli/installer.go @@ -5,9 +5,10 @@ import "github.com/github/copilot-sdk/go/internal/embeddedcli" // Config defines the inputs used to install and locate the embedded Copilot CLI. // // Cli and CliHash are required. If Dir is empty, the CLI is installed into the -// system cache directory. Version is used to suffix the installed binary name to -// allow multiple versions to coexist. License, when provided, is written next -// to the installed binary. +// system cache directory. When Version is set, the CLI and runtime library are +// installed into a version-specific child directory so multiple versions can +// coexist. Linux musl alternatives, when provided, are selected automatically. +// License, when provided, is written next to the installed binary. type Config = embeddedcli.Config // Setup sets the embedded GitHub Copilot CLI install configuration. @@ -15,3 +16,11 @@ type Config = embeddedcli.Config func Setup(cfg Config) { embeddedcli.Setup(cfg) } + +// Path returns the absolute path to the embedded Copilot CLI, installing it on +// first call if necessary. It returns an empty string when no embedded CLI was +// configured via Setup (e.g. a build compiled without the embedded runtime). +// The result is computed once and cached for the life of the process. +func Path() string { + return embeddedcli.Path() +} diff --git a/go/go.mod b/go/go.mod index 16114a0ab..ba0f4feb7 100644 --- a/go/go.mod +++ b/go/go.mod @@ -8,6 +8,8 @@ require ( ) require ( + github.com/coder/websocket v1.8.15 + github.com/ebitengine/purego v0.10.1 github.com/google/uuid v1.6.0 go.opentelemetry.io/otel v1.35.0 go.opentelemetry.io/otel/trace v1.35.0 diff --git a/go/go.sum b/go/go.sum index ec2bbcc1e..cab5b6aab 100644 --- a/go/go.sum +++ b/go/go.sum @@ -1,5 +1,9 @@ +github.com/coder/websocket v1.8.15 h1:6B2JPeOGlpff2Uz6vOEH1Vzpi0iUz20A+lPVhPHtNUA= +github.com/coder/websocket v1.8.15/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.10.1 h1:dewVBCBT2GaMu1SrNTYxQhgQBethzfhiwvZiLGP/qyY= +github.com/ebitengine/purego v0.10.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= diff --git a/go/inprocess.go b/go/inprocess.go new file mode 100644 index 000000000..c74410e42 --- /dev/null +++ b/go/inprocess.go @@ -0,0 +1,15 @@ +package copilot + +import "io" + +type inProcessHost interface { + Start() error + Writer() io.WriteCloser + Reader() io.ReadCloser + Dispose() +} + +type inProcessHostConfig struct { + Environment map[string]string + Args []string +} diff --git a/go/inprocess_disabled.go b/go/inprocess_disabled.go new file mode 100644 index 000000000..b86ed5ca3 --- /dev/null +++ b/go/inprocess_disabled.go @@ -0,0 +1,11 @@ +//go:build !copilot_inprocess || (!darwin && !linux && !windows) + +package copilot + +import "errors" + +const inProcessAvailable = false + +func createInProcessHost(string, inProcessHostConfig) (inProcessHost, error) { + return nil, errors.New("in-process transport unavailable") +} diff --git a/go/inprocess_enabled.go b/go/inprocess_enabled.go new file mode 100644 index 000000000..c20013d8a --- /dev/null +++ b/go/inprocess_enabled.go @@ -0,0 +1,11 @@ +//go:build copilot_inprocess && (darwin || linux || windows) + +package copilot + +import "github.com/github/copilot-sdk/go/internal/ffihost" + +const inProcessAvailable = true + +func createInProcessHost(runtimePath string, config inProcessHostConfig) (inProcessHost, error) { + return ffihost.Create(runtimePath, config.Environment, config.Args) +} diff --git a/go/internal/e2e/agent_and_compact_rpc_e2e_test.go b/go/internal/e2e/agent_and_compact_rpc_e2e_test.go index cfb879917..c02a8571d 100644 --- a/go/internal/e2e/agent_and_compact_rpc_e2e_test.go +++ b/go/internal/e2e/agent_and_compact_rpc_e2e_test.go @@ -11,7 +11,7 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) -func TestAgentSelectionRpcE2E(t *testing.T) { +func TestAgentSelectionRPCE2E(t *testing.T) { cliPath := testharness.CLIPath() if cliPath == "" { t.Fatal("CLI not found. Run 'npm install' in the nodejs directory first.") @@ -333,7 +333,7 @@ func agentSummaries(agents []rpc.AgentInfo) []string { return summaries } -func TestSessionCompactionRpcE2E(t *testing.T) { +func TestSessionCompactionRPCE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/builtin_tools_e2e_test.go b/go/internal/e2e/builtin_tools_e2e_test.go index a25108fed..46d3f1dca 100644 --- a/go/internal/e2e/builtin_tools_e2e_test.go +++ b/go/internal/e2e/builtin_tools_e2e_test.go @@ -1,16 +1,24 @@ package e2e import ( + "context" "os" "path/filepath" "runtime" "strings" "testing" + "time" copilot "github.com/github/copilot-sdk/go" "github.com/github/copilot-sdk/go/internal/e2e/testharness" ) +// Built-in tool tests spawn a real CLI subprocess and execute actual shell / +// file tools. Under slow/concurrent CI (notably Windows) this agent loop can +// briefly exceed the 60s SendAndWait default, so give it extra headroom while +// still failing fast on a genuine hang. +const sendTimeout = 120 * time.Second + func TestBuiltinToolsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() @@ -27,7 +35,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Run 'echo hello && echo world'. Tell me the exact output.", }) if err != nil { @@ -55,8 +65,10 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ - Prompt: "Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.", + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ + Prompt: "Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. Reply with just the stderr content.", }) if err != nil { t.Fatalf("SendAndWait failed: %v", err) @@ -82,7 +94,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.", }) if err != nil { @@ -106,7 +120,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.", }) if err != nil { @@ -139,7 +155,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.", }) if err != nil { @@ -162,7 +180,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.", }) if err != nil { @@ -189,7 +209,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.", }) if err != nil { @@ -223,7 +245,9 @@ func TestBuiltinToolsE2E(t *testing.T) { } t.Cleanup(func() { _ = session.Disconnect() }) - msg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + sendCtx, cancel := context.WithTimeout(t.Context(), sendTimeout) + defer cancel() + msg, err := session.SendAndWait(sendCtx, copilot.MessageOptions{ Prompt: "Find all .ts files in this directory (recursively). List the filenames you found.", }) if err != nil { diff --git a/go/internal/e2e/byok_bearer_token_provider_e2e_test.go b/go/internal/e2e/byok_bearer_token_provider_e2e_test.go new file mode 100644 index 000000000..33e32b132 --- /dev/null +++ b/go/internal/e2e/byok_bearer_token_provider_e2e_test.go @@ -0,0 +1,290 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "net/http" + "strconv" + "strings" + "sync" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +// Fake BYOK provider base URLs. These hosts are never actually dialed: the +// capturing RoundTripper fully answers any request aimed at a `.invalid` host, +// so they only need to be syntactically valid, non-resolving URLs. Distinct +// hosts let the per-provider test assert routing by host. +const ( + byokPrimaryHost = "byok-endpoint.invalid" + byokPrimaryBaseURL = "https://" + byokPrimaryHost + "/v1" + byokRedHost = "byok-red.invalid" + byokRedBaseURL = "https://" + byokRedHost + "/v1" + byokBlueHost = "byok-blue.invalid" + byokBlueBaseURL = "https://" + byokBlueHost + "/v1" +) + +// capturedBYOKRequest records the host and Authorization header of one outbound +// HTTP request the runtime aimed at a fake BYOK provider endpoint. +type capturedBYOKRequest struct { + host string + authorization string +} + +// byokCapturingRoundTripper stands in for a real HTTP upstream. It records the +// `Authorization` header the runtime applied (after calling the provider's +// BearerTokenProvider callback over the session-scoped `providerToken.getToken` RPC) +// for every request aimed at a fake `.invalid` BYOK host, answering them with a +// synthetic 404 (a non-retryable status, so each outbound model request yields +// exactly one capture). Every other request (CAPI bootstrap: model catalog, +// policy, session) is fabricated locally so the test never touches the network. +type byokCapturingRoundTripper struct { + mu sync.Mutex + captures []capturedBYOKRequest +} + +func (rt *byokCapturingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) { + if strings.HasSuffix(req.URL.Hostname(), ".invalid") { + rt.mu.Lock() + rt.captures = append(rt.captures, capturedBYOKRequest{ + host: req.URL.Host, + authorization: req.Header.Get("Authorization"), + }) + rt.mu.Unlock() + if req.Body != nil { + _ = req.Body.Close() + } + return buildJSONResponse(http.StatusNotFound, `{"error":{"message":"fake byok endpoint"}}`), nil + } + return buildNonInferenceResponse(req.URL.String()), nil +} + +// authHeaders returns the captured Authorization headers in arrival order. +func (rt *byokCapturingRoundTripper) authHeaders() []string { + rt.mu.Lock() + defer rt.mu.Unlock() + headers := make([]string, 0, len(rt.captures)) + for _, c := range rt.captures { + if c.authorization != "" { + headers = append(headers, c.authorization) + } + } + return headers +} + +// authHeaderForHost returns the Authorization header captured for requests aimed +// at host, if any. +func (rt *byokCapturingRoundTripper) authHeaderForHost(host string) string { + rt.mu.Lock() + defer rt.mu.Unlock() + for _, c := range rt.captures { + if c.host == host { + return c.authorization + } + } + return "" +} + +func (rt *byokCapturingRoundTripper) reset() { + rt.mu.Lock() + defer rt.mu.Unlock() + rt.captures = nil +} + +// TestBYOKBearerTokenProvider is end-to-end coverage for the experimental BYOK +// bearer-token-provider surface (BearerTokenProvider on a provider config). The +// callback stays entirely on the SDK/client side: the SDK strips it from the +// wire config, sets the `hasBearerTokenProvider` flag, and the runtime calls +// back over the session-scoped `providerToken.getToken` RPC before each outbound +// model request, applying the returned token as the `Authorization` header. +// +// Rather than standing up a real HTTP listener, the test installs a capturing +// RoundTripper that intercepts the runtime's outbound model request in-process, +// captures the `Authorization` header, and returns a synthetic response. It +// validates, against a real runtime: +// 1. the callback's token reaches the model request as `Authorization: Bearer `; +// 2. the runtime re-acquires a token per request (no runtime-side caching); +// 3. per-provider dispatch routes each provider's turn to its own callback, and +// the resulting token reaches that provider's endpoint. +func TestBYOKBearerTokenProvider(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + ctx := testharness.NewTestContext(t) + rt := &byokCapturingRoundTripper{} + handler := &copilot.CopilotRequestHandler{Transport: rt} + + client := newCopilotRequestClient(ctx, handler) + t.Cleanup(func() { client.ForceStop() }) + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + // runTurn drives one BYOK turn; the synthetic 404 errors the turn after the + // runtime has already sent the token-bearing request, which is all the test + // asserts on, so the resulting error is expected and swallowed. + runTurn := func(providers []copilot.NamedProviderConfig, models []copilot.ProviderModelConfig, selectionID, prompt string) { + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: selectionID, + Providers: providers, + Models: models, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + _, _ = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: prompt}) + _ = session.Disconnect() + } + + t.Run("applies the callback's token as the Authorization header", func(t *testing.T) { + rt.reset() + const sentinel = "sentinel-bearer-token-abc123" + var mu sync.Mutex + calls := 0 + getBearerToken := func(args copilot.ProviderTokenArgs) (string, error) { + mu.Lock() + calls++ + mu.Unlock() + return sentinel, nil + } + + providers := []copilot.NamedProviderConfig{{ + Name: "mi", + Type: "openai", + WireAPI: "completions", + BaseURL: byokPrimaryBaseURL, + BearerTokenProvider: getBearerToken, + }} + models := []copilot.ProviderModelConfig{{ID: "default", Provider: "mi", WireModel: "byok-gpt-4o"}} + + runTurn(providers, models, "mi/default", "What is 5+5?") + + // The runtime acquired a token via the callback and applied it verbatim + // as the bearer credential on the outbound model request. + if !containsString(rt.authHeaders(), "Bearer "+sentinel) { + t.Fatalf("Expected captured Authorization headers to contain %q, got %v", "Bearer "+sentinel, rt.authHeaders()) + } + mu.Lock() + gotCalls := calls + mu.Unlock() + if gotCalls < 1 { + t.Fatalf("Expected the callback to be invoked at least once, got %d", gotCalls) + } + }) + + t.Run("re-acquires a fresh token for each request (no runtime caching)", func(t *testing.T) { + rt.reset() + var mu sync.Mutex + calls := 0 + getBearerToken := func(args copilot.ProviderTokenArgs) (string, error) { + mu.Lock() + calls++ + token := "rotating-token-" + strconv.Itoa(calls) + mu.Unlock() + // A distinct token per acquisition proves the runtime re-invokes the + // callback per request rather than caching a previous token. + return token, nil + } + + providers := []copilot.NamedProviderConfig{{ + Name: "mi", + Type: "openai", + WireAPI: "completions", + BaseURL: byokPrimaryBaseURL, + BearerTokenProvider: getBearerToken, + }} + models := []copilot.ProviderModelConfig{{ID: "default", Provider: "mi", WireModel: "byok-gpt-4o"}} + + runTurn(providers, models, "mi/default", "What is 1+1?") + runTurn(providers, models, "mi/default", "What is 2+2?") + + // Each outbound request carries a freshly-acquired, distinct token. + auths := rt.authHeaders() + if len(auths) < 2 { + t.Fatalf("Expected at least 2 captured Authorization headers, got %d: %v", len(auths), auths) + } + if !strings.HasPrefix(auths[0], "Bearer rotating-token-") || !strings.HasPrefix(auths[1], "Bearer rotating-token-") { + t.Fatalf("Expected rotating-token bearer headers, got %v", auths) + } + if auths[0] == auths[1] { + t.Fatalf("Expected distinct tokens per request, both were %q", auths[0]) + } + mu.Lock() + gotCalls := calls + mu.Unlock() + if gotCalls < 2 { + t.Fatalf("Expected the callback to be invoked at least twice, got %d", gotCalls) + } + }) + + t.Run("dispatches token acquisition per provider", func(t *testing.T) { + rt.reset() + tokenByProvider := map[string]string{ + "red": "token-for-red", + "blue": "token-for-blue", + } + var mu sync.Mutex + var acquiredFor []string + makeCallback := func(providerName string) copilot.BearerTokenProvider { + return func(args copilot.ProviderTokenArgs) (string, error) { + // The runtime forwards the requesting provider's name so the + // client can dispatch to the right credential. + if args.ProviderName != providerName { + t.Errorf("Expected providerName %q, got %q", providerName, args.ProviderName) + } + // The runtime also forwards the owning session id so a + // client-level shared callback can resolve the session. + if args.SessionID == "" { + t.Errorf("Expected a non-empty session id in token args") + } + mu.Lock() + acquiredFor = append(acquiredFor, providerName) + mu.Unlock() + return tokenByProvider[providerName], nil + } + } + + providers := []copilot.NamedProviderConfig{ + { + Name: "red", + Type: "openai", + WireAPI: "completions", + BaseURL: byokRedBaseURL, + BearerTokenProvider: makeCallback("red"), + }, + { + Name: "blue", + Type: "openai", + WireAPI: "completions", + BaseURL: byokBlueBaseURL, + BearerTokenProvider: makeCallback("blue"), + }, + } + models := []copilot.ProviderModelConfig{ + {ID: "default", Provider: "red", WireModel: "byok-gpt-4o"}, + {ID: "default", Provider: "blue", WireModel: "byok-gpt-4o"}, + } + + runTurn(providers, models, "red/default", "What is 3+3?") + runTurn(providers, models, "blue/default", "What is 4+4?") + + // Each provider's turn was authenticated with its own token AND that + // token was delivered to that provider's endpoint, proving per-provider + // dispatch (not a single session-global credential). + if got := rt.authHeaderForHost(byokRedHost); got != "Bearer "+tokenByProvider["red"] { + t.Fatalf("Expected red host to receive %q, got %q", "Bearer "+tokenByProvider["red"], got) + } + if got := rt.authHeaderForHost(byokBlueHost); got != "Bearer "+tokenByProvider["blue"] { + t.Fatalf("Expected blue host to receive %q, got %q", "Bearer "+tokenByProvider["blue"], got) + } + mu.Lock() + got := append([]string(nil), acquiredFor...) + mu.Unlock() + if !containsString(got, "red") || !containsString(got, "blue") { + t.Fatalf("Expected both providers to acquire tokens, got %v", got) + } + }) +} diff --git a/go/internal/e2e/client_api_e2e_test.go b/go/internal/e2e/client_api_e2e_test.go index 15e97b5a7..3b0c88845 100644 --- a/go/internal/e2e/client_api_e2e_test.go +++ b/go/internal/e2e/client_api_e2e_test.go @@ -9,7 +9,7 @@ import ( ) // Mirrors dotnet/test/ClientSessionManagementTests.cs (snapshot category "client_api"). -func TestClientApiE2E(t *testing.T) { +func TestClientAPIE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/client_e2e_test.go b/go/internal/e2e/client_e2e_test.go index e4dfed2d4..d7fc3f06a 100644 --- a/go/internal/e2e/client_e2e_test.go +++ b/go/internal/e2e/client_e2e_test.go @@ -44,7 +44,7 @@ func TestClientE2E(t *testing.T) { t.Run("should start and connect to server using tcp", func(t *testing.T) { client := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.TcpConnection{Path: cliPath}, + Connection: copilot.TCPConnection{Path: cliPath}, }) t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/client_options_e2e_test.go b/go/internal/e2e/client_options_e2e_test.go index 205714f34..86332eb6f 100644 --- a/go/internal/e2e/client_options_e2e_test.go +++ b/go/internal/e2e/client_options_e2e_test.go @@ -10,6 +10,7 @@ import ( copilot "github.com/github/copilot-sdk/go" "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" ) // Mirrors the E2E portions of dotnet/test/ClientOptionsTests.cs (snapshot category "client_options"). @@ -17,12 +18,12 @@ import ( // Go's ClientOptions is a plain struct with no setter validation; equivalent behavior is covered // in package-level unit tests. func TestClientOptionsE2E(t *testing.T) { - t.Run("should listen on configured tcp port", func(t *testing.T) { + t.Run("should listen on configured TCP port", func(t *testing.T) { ctx := testharness.NewTestContext(t) - port := getAvailableTcpPort(t) + port := getAvailableTCPPort(t) client := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: ctx.CLIPath, Port: port} + opts.Connection = copilot.TCPConnection{Path: ctx.CLIPath, Port: port} }) t.Cleanup(func() { client.ForceStop() }) @@ -110,6 +111,7 @@ func TestClientOptionsE2E(t *testing.T) { opts.SessionIdleTimeoutSeconds = 17 opts.Telemetry = &copilot.TelemetryConfig{ OTLPEndpoint: "http://127.0.0.1:4318", + OTLPProtocol: "http/protobuf", FilePath: telemetryPath, ExporterType: "file", SourceName: "go-sdk-e2e", @@ -147,6 +149,7 @@ func TestClientOptionsE2E(t *testing.T) { "COPILOT_SDK_AUTH_TOKEN": "process-option-token", "COPILOT_OTEL_ENABLED": "true", "OTEL_EXPORTER_OTLP_ENDPOINT": "http://127.0.0.1:4318", + "OTEL_EXPORTER_OTLP_PROTOCOL": "http/protobuf", "COPILOT_OTEL_FILE_EXPORTER_PATH": telemetryPath, "COPILOT_OTEL_EXPORTER_TYPE": "file", "COPILOT_OTEL_SOURCE_NAME": "go-sdk-e2e", @@ -159,15 +162,15 @@ func TestClientOptionsE2E(t *testing.T) { } session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ - EnableConfigDiscovery: true, + EnableConfigDiscovery: copilot.Bool(true), EnableOnDemandInstructionDiscovery: copilot.Bool(true), IncludeSubAgentStreamingEvents: copilot.Bool(false), + CustomAgentsLocalOnly: copilot.Bool(false), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { t.Fatalf("CreateSession failed: %v", err) } - t.Cleanup(func() { session.Disconnect() }) updated := readCapture(t, capturePath) var createReq *capturedRequest @@ -194,7 +197,418 @@ func TestClientOptionsE2E(t *testing.T) { if v, ok := params["includeSubAgentStreamingEvents"].(bool); !ok || v != false { t.Errorf("Expected session.create.params.includeSubAgentStreamingEvents=false, got %v", params["includeSubAgentStreamingEvents"]) } + if v, ok := params["customAgentsLocalOnly"].(bool); !ok || v != false { + t.Errorf("Expected session.create.params.customAgentsLocalOnly=false, got %v", params["customAgentsLocalOnly"]) + } + + sessionID := session.SessionID + if err := session.Disconnect(); err != nil { + t.Fatalf("Disconnect failed: %v", err) + } + resumed, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ + CustomAgentsLocalOnly: copilot.Bool(false), + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("ResumeSession failed: %v", err) + } + t.Cleanup(func() { _ = resumed.Disconnect() }) + + resumedCapture := readCapture(t, capturePath) + for _, req := range resumedCapture.Requests { + if req.Method != "session.resume" { + continue + } + resumeParams, ok := req.Params.(map[string]any) + if !ok { + t.Fatalf("Expected session.resume params to be an object, got %T", req.Params) + } + if v, ok := resumeParams["customAgentsLocalOnly"].(bool); !ok || v != false { + t.Errorf("Expected session.resume.params.customAgentsLocalOnly=false, got %v", + resumeParams["customAgentsLocalOnly"]) + } + return + } + t.Fatalf("session.resume request was not captured. Captured requests: %+v", resumedCapture.Requests) }) + + t.Run("should send empty-mode custom agent locality defaults in initial requests", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + cliPath := filepath.Join(ctx.WorkDir, "fake-cli-empty-"+randomHex(t)+".js") + capturePath := filepath.Join(ctx.WorkDir, "fake-cli-empty-capture-"+randomHex(t)+".json") + if err := os.WriteFile(cliPath, []byte(fakeStdioCliScript), 0644); err != nil { + t.Fatalf("Failed to write fake CLI script: %v", err) + } + + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.StdioConnection{ + Path: cliPath, + Args: []string{"--capture-file", capturePath}, + } + opts.Mode = copilot.ModeEmpty + opts.BaseDirectory = ctx.WorkDir + opts.UseLoggedInUser = copilot.Bool(false) + }) + t.Cleanup(func() { client.ForceStop() }) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + AvailableTools: []string{"builtin:ask_user"}, + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + sessionID := session.SessionID + if err := session.Disconnect(); err != nil { + t.Fatalf("Disconnect failed: %v", err) + } + + resumed, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ + AvailableTools: []string{"builtin:ask_user"}, + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("ResumeSession failed: %v", err) + } + t.Cleanup(func() { _ = resumed.Disconnect() }) + + capture := readCapture(t, capturePath) + foundCreate := false + foundResume := false + for _, req := range capture.Requests { + params, ok := req.Params.(map[string]any) + if !ok { + continue + } + switch req.Method { + case "session.create": + foundCreate = true + if v, ok := params["customAgentsLocalOnly"].(bool); !ok || !v { + t.Errorf("Expected session.create.params.customAgentsLocalOnly=true, got %v", + params["customAgentsLocalOnly"]) + } + case "session.resume": + foundResume = true + if v, ok := params["customAgentsLocalOnly"].(bool); !ok || !v { + t.Errorf("Expected session.resume.params.customAgentsLocalOnly=true, got %v", + params["customAgentsLocalOnly"]) + } + } + } + if !foundCreate || !foundResume { + t.Fatalf("Expected create and resume requests, got %+v", capture.Requests) + } + }) + + t.Run("should forward advanced session creation options to the CLI", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + cliPath := filepath.Join(ctx.WorkDir, "fake-cli-"+randomHex(t)+".js") + capturePath := filepath.Join(ctx.WorkDir, "fake-cli-capture-"+randomHex(t)+".json") + if err := os.WriteFile(cliPath, []byte(fakeStdioCliScript), 0644); err != nil { + t.Fatalf("Failed to write fake CLI script: %v", err) + } + + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.StdioConnection{Path: cliPath, Args: []string{"--capture-file", capturePath}} + opts.GitHubToken = "advanced-create-client-token" + opts.UseLoggedInUser = copilot.Bool(false) + }) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + sessionID := "advanced-session-id" + workingDirectory := t.TempDir() + configDirectory := t.TempDir() + embeddingCacheStorage := "in-memory" + organizationCustomInstructions := "organization guidance" + maxAiCredits := float64(42) + extensionSDKPath := filepath.Join(ctx.WorkDir, "extension-sdk") + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + SessionID: sessionID, + ClientName: "go-sdk-e2e-client", + Model: "claude-sonnet-4.5", + ReasoningEffort: "low", + ReasoningSummary: copilot.ReasoningSummaryNone, + ContextTier: copilot.ContextTierLongContext, + ConfigDirectory: configDirectory, + EnableConfigDiscovery: copilot.Bool(true), + SkipEmbeddingRetrieval: copilot.Bool(true), + EmbeddingCacheStorage: &embeddingCacheStorage, + OrganizationCustomInstructions: &organizationCustomInstructions, + EnableOnDemandInstructionDiscovery: copilot.Bool(true), + EnableFileHooks: copilot.Bool(false), + EnableHostGitOperations: copilot.Bool(false), + EnableSessionStore: copilot.Bool(false), + EnableSkills: copilot.Bool(false), + WorkingDirectory: workingDirectory, + Streaming: copilot.Bool(true), + IncludeSubAgentStreamingEvents: copilot.Bool(false), + AvailableTools: []string{"read_file"}, + ExcludedTools: []string{"bash"}, + ExcludedBuiltInAgents: []string{"legacy-agent"}, + EnableSessionTelemetry: copilot.Bool(false), + EnableCitations: copilot.Bool(true), + SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: &maxAiCredits}, + SkipCustomInstructions: copilot.Bool(true), + CustomAgentsLocalOnly: copilot.Bool(true), + CoauthorEnabled: copilot.Bool(false), + ManageScheduleEnabled: copilot.Bool(false), + GitHubToken: "advanced-create-session-token", + RemoteSession: rpc.RemoteSessionModeExport, + SkillDirectories: []string{"skills"}, + PluginDirectories: []string{"plugins"}, + InstructionDirectories: []string{"instructions"}, + DisabledSkills: []string{"disabled-skill"}, + EnableMCPApps: true, + Canvases: []copilot.CanvasDeclaration{{ + ID: "canvas", + DisplayName: "Canvas", + Description: "Canvas description", + InputSchema: map[string]any{"type": "object"}, + }}, + RequestCanvasRenderer: copilot.Bool(true), + RequestExtensions: copilot.Bool(true), + ExtensionSDKPath: &extensionSDKPath, + ExtensionInfo: &copilot.ExtensionInfo{Source: "github-app", Name: "go-e2e-extension"}, + ExpAssignments: &copilot.CopilotExpAssignmentResponse{Flights: map[string]string{"feature": "enabled"}, AssignmentContext: "ctx"}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + session.Disconnect() + + createReq := getCapturedRequest(t, capturePath, "session.create") + params, ok := createReq.Params.(map[string]any) + if !ok { + t.Fatalf("Expected session.create params object, got %T", createReq.Params) + } + expectedValues := map[string]any{ + "sessionId": sessionID, + "clientName": "go-sdk-e2e-client", + "model": "claude-sonnet-4.5", + "reasoningEffort": "low", + "reasoningSummary": "none", + "contextTier": "long_context", + "configDir": configDirectory, + "enableConfigDiscovery": true, + "skipEmbeddingRetrieval": true, + "embeddingCacheStorage": embeddingCacheStorage, + "organizationCustomInstructions": organizationCustomInstructions, + "enableOnDemandInstructionDiscovery": true, + "enableFileHooks": false, + "enableHostGitOperations": false, + "enableSessionStore": false, + "enableSkills": false, + "workingDirectory": workingDirectory, + "streaming": true, + "includeSubAgentStreamingEvents": false, + "enableSessionTelemetry": false, + "enableCitations": true, + "skipCustomInstructions": true, + "customAgentsLocalOnly": true, + "coauthorEnabled": false, + "manageScheduleEnabled": false, + "gitHubToken": "advanced-create-session-token", + "remoteSession": "export", + "requestMcpApps": true, + "requestCanvasRenderer": true, + "requestExtensions": true, + "extensionSdkPath": extensionSDKPath, + "envValueMode": "direct", + } + for key, expected := range expectedValues { + if params[key] != expected { + t.Fatalf("Expected %s=%#v, got %#v in %#v", key, expected, params[key], params) + } + } + assertStringArray(t, params["availableTools"], []string{"read_file"}) + assertStringArray(t, params["excludedTools"], []string{"bash"}) + assertStringArray(t, params["excludedBuiltinAgents"], []string{"legacy-agent"}) + assertStringArray(t, params["skillDirectories"], []string{"skills"}) + assertStringArray(t, params["pluginDirectories"], []string{"plugins"}) + assertStringArray(t, params["instructionDirectories"], []string{"instructions"}) + assertStringArray(t, params["disabledSkills"], []string{"disabled-skill"}) + if params["sessionLimits"].(map[string]any)["maxAiCredits"] != maxAiCredits { + t.Fatalf("Expected sessionLimits to be forwarded, got %#v", params["sessionLimits"]) + } + extensionInfo := params["extensionInfo"].(map[string]any) + if extensionInfo["source"] != "github-app" || extensionInfo["name"] != "go-e2e-extension" { + t.Fatalf("Expected extensionInfo to be forwarded, got %#v", extensionInfo) + } + canvases := params["canvases"].([]any) + canvas := canvases[0].(map[string]any) + if canvas["id"] != "canvas" || canvas["displayName"] != "Canvas" || canvas["description"] != "Canvas description" { + t.Fatalf("Expected canvas declaration to be forwarded, got %#v", canvas) + } + if params["expAssignments"].(map[string]any)["Flights"].(map[string]any)["feature"] != "enabled" { + t.Fatalf("Expected expAssignments to be forwarded, got %#v", params["expAssignments"]) + } + }) + + t.Run("should forward singular provider configuration on session creation", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + cliPath := filepath.Join(ctx.WorkDir, "fake-cli-"+randomHex(t)+".js") + capturePath := filepath.Join(ctx.WorkDir, "fake-cli-capture-"+randomHex(t)+".json") + if err := os.WriteFile(cliPath, []byte(fakeStdioCliScript), 0644); err != nil { + t.Fatalf("Failed to write fake CLI script: %v", err) + } + + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.StdioConnection{Path: cliPath, Args: []string{"--capture-file", capturePath}} + opts.GitHubToken = "provider-client-token" + opts.UseLoggedInUser = copilot.Bool(false) + }) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + Provider: &copilot.ProviderConfig{ + Type: "openai", + WireAPI: "responses", + Transport: "websockets", + BaseURL: "https://models.example.test/v1", + APIKey: "provider-key", + ModelID: "base-model", + WireModel: "wire-model", + MaxPromptTokens: 1000, + MaxOutputTokens: 2000, + Headers: map[string]string{"x-provider": "go"}, + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + session.Disconnect() + + createReq := getCapturedRequest(t, capturePath, "session.create") + params := createReq.Params.(map[string]any) + provider := params["provider"].(map[string]any) + for key, expected := range map[string]any{ + "type": "openai", + "wireApi": "responses", + "transport": "websockets", + "baseUrl": "https://models.example.test/v1", + "apiKey": "provider-key", + "modelId": "base-model", + "wireModel": "wire-model", + "maxPromptTokens": float64(1000), + "maxOutputTokens": float64(2000), + } { + if provider[key] != expected { + t.Fatalf("Expected provider.%s=%#v, got %#v in %#v", key, expected, provider[key], provider) + } + } + if provider["headers"].(map[string]any)["x-provider"] != "go" { + t.Fatalf("Expected provider headers to be forwarded, got %#v", provider["headers"]) + } + }) + + t.Run("should forward advanced session resume options to the CLI", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + cliPath := filepath.Join(ctx.WorkDir, "fake-cli-"+randomHex(t)+".js") + capturePath := filepath.Join(ctx.WorkDir, "fake-cli-capture-"+randomHex(t)+".json") + if err := os.WriteFile(cliPath, []byte(fakeStdioCliScript), 0644); err != nil { + t.Fatalf("Failed to write fake CLI script: %v", err) + } + + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.StdioConnection{Path: cliPath, Args: []string{"--capture-file", capturePath}} + opts.GitHubToken = "advanced-resume-client-token" + opts.UseLoggedInUser = copilot.Bool(false) + }) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + workingDirectory := t.TempDir() + configDirectory := t.TempDir() + continuePendingWork := false + extensionSDKPath := filepath.Join(ctx.WorkDir, "resume-extension-sdk") + session, err := client.ResumeSession(t.Context(), "resume-session-id", &copilot.ResumeSessionConfig{ + Model: "gpt-5-mini", + ReasoningEffort: "low", + ReasoningSummary: copilot.ReasoningSummaryNone, + ContextTier: copilot.ContextTierLongContext, + WorkingDirectory: workingDirectory, + ConfigDirectory: configDirectory, + EnableConfigDiscovery: copilot.Bool(false), + SuppressResumeEvent: true, + ContinuePendingWork: &continuePendingWork, + Streaming: copilot.Bool(true), + IncludeSubAgentStreamingEvents: copilot.Bool(false), + GitHubToken: "advanced-resume-session-token", + Canvases: []copilot.CanvasDeclaration{{ + ID: "resume-canvas", + DisplayName: "Resume Canvas", + Description: "Resume canvas description", + InputSchema: map[string]any{"type": "object"}, + }}, + OpenCanvases: []rpc.OpenCanvasInstance{{ + CanvasID: "resume-canvas", + ExtensionID: "github-app/go-e2e-extension", + InstanceID: "resume-instance", + Input: map[string]any{"value": "from-resume"}, + }}, + RequestCanvasRenderer: copilot.Bool(true), + RequestExtensions: copilot.Bool(true), + ExtensionSDKPath: &extensionSDKPath, + ExtensionInfo: &copilot.ExtensionInfo{Source: "github-app", Name: "go-e2e-extension"}, + ExpAssignments: &copilot.CopilotExpAssignmentResponse{Flights: map[string]string{"resumeFeature": "enabled"}, AssignmentContext: "ctx"}, + }) + if err != nil { + t.Fatalf("ResumeSession failed: %v", err) + } + session.Disconnect() + + resumeReq := getCapturedRequest(t, capturePath, "session.resume") + params := resumeReq.Params.(map[string]any) + expectedValues := map[string]any{ + "sessionId": "resume-session-id", + "model": "gpt-5-mini", + "reasoningEffort": "low", + "reasoningSummary": "none", + "contextTier": "long_context", + "workingDirectory": workingDirectory, + "configDir": configDirectory, + "enableConfigDiscovery": false, + "disableResume": true, + "continuePendingWork": false, + "streaming": true, + "includeSubAgentStreamingEvents": false, + "gitHubToken": "advanced-resume-session-token", + "requestCanvasRenderer": true, + "requestExtensions": true, + "extensionSdkPath": extensionSDKPath, + "envValueMode": "direct", + } + for key, expected := range expectedValues { + if params[key] != expected { + t.Fatalf("Expected resume %s=%#v, got %#v in %#v", key, expected, params[key], params) + } + } + openCanvases := params["openCanvases"].([]any) + openCanvas := openCanvases[0].(map[string]any) + if openCanvas["canvasId"] != "resume-canvas" || openCanvas["extensionId"] != "github-app/go-e2e-extension" || + openCanvas["instanceId"] != "resume-instance" { + t.Fatalf("Expected open canvas state to be forwarded, got %#v", openCanvas) + } + extensionInfo := params["extensionInfo"].(map[string]any) + if extensionInfo["source"] != "github-app" || extensionInfo["name"] != "go-e2e-extension" { + t.Fatalf("Expected extensionInfo on resume, got %#v", extensionInfo) + } + if params["expAssignments"].(map[string]any)["Flights"].(map[string]any)["resumeFeature"] != "enabled" { + t.Fatalf("Expected resume expAssignments to be forwarded, got %#v", params["expAssignments"]) + } + }) + } // --------------------------------------------------------------------------- @@ -241,19 +655,19 @@ func TestClientOptionsUnit(t *testing.T) { } }) - t.Run("should panic when GitHubToken used with UriConnection", func(t *testing.T) { + t.Run("should panic when GitHubToken used with URIConnection", func(t *testing.T) { assertPanics(t, func() { _ = copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:8080"}, + Connection: copilot.URIConnection{URL: "localhost:8080"}, GitHubToken: "gho_test_token", }) }) }) - t.Run("should panic when UseLoggedInUser used with UriConnection", func(t *testing.T) { + t.Run("should panic when UseLoggedInUser used with URIConnection", func(t *testing.T) { assertPanics(t, func() { _ = copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: "localhost:8080"}, + Connection: copilot.URIConnection{URL: "localhost:8080"}, UseLoggedInUser: copilot.Bool(false), }) }) @@ -278,7 +692,7 @@ func TestClientOptionsUnit(t *testing.T) { }) } -func getAvailableTcpPort(t *testing.T) int { +func getAvailableTCPPort(t *testing.T) int { t.Helper() listener, err := net.Listen("tcp", "127.0.0.1:0") if err != nil { @@ -350,8 +764,36 @@ func readCapture(t *testing.T, path string) capturedCli { return c } -// fakeStdioCliScript is identical to the one used by the .NET / Python -// equivalents (dotnet/test/ClientOptionsTests.cs and python/e2e/test_client_options.py). +func getCapturedRequest(t *testing.T, path, method string) capturedRequest { + t.Helper() + capture := readCapture(t, path) + for _, request := range capture.Requests { + if request.Method == method { + return request + } + } + t.Fatalf("Expected %s request in capture, got %+v", method, capture.Requests) + return capturedRequest{} +} + +func assertStringArray(t *testing.T, value any, expected []string) { + t.Helper() + items, ok := value.([]any) + if !ok { + t.Fatalf("Expected string array %v, got %#v", expected, value) + } + if len(items) != len(expected) { + t.Fatalf("Expected string array %v, got %#v", expected, items) + } + for i, expectedValue := range expected { + if items[i] != expectedValue { + t.Fatalf("Expected string array %v, got %#v", expected, items) + } + } +} + +// fakeStdioCliScript is intentionally kept close to the fake CLIs used by the +// other SDK client-options E2E tests, while still matching Go's request capture shape. const fakeStdioCliScript = ` const fs = require("fs"); @@ -372,6 +814,7 @@ function saveCapture() { COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN, COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT, + OTEL_EXPORTER_OTLP_PROTOCOL: process.env.OTEL_EXPORTER_OTLP_PROTOCOL, COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH, COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE, COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME, @@ -421,7 +864,12 @@ function handleMessage(message) { writeResponse(message.id, { message: "pong", protocolVersion: 3, timestamp: Date.now() }); return; } - if (message.method === "session.create") { + if (message.method === "session.create" || message.method === "session.resume") { + const sessionId = (message.params && message.params.sessionId) || "fake-session"; + writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null }); + return; + } + if (message.method === "session.resume") { const sessionId = (message.params && message.params.sessionId) || "fake-session"; writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null }); return; diff --git a/go/internal/e2e/commands_and_elicitation_e2e_test.go b/go/internal/e2e/commands_and_elicitation_e2e_test.go index 68b9badd1..af7520a4c 100644 --- a/go/internal/e2e/commands_and_elicitation_e2e_test.go +++ b/go/internal/e2e/commands_and_elicitation_e2e_test.go @@ -14,7 +14,7 @@ import ( func TestCommandsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client1 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.TCPConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { client1.ForceStop() }) @@ -33,7 +33,7 @@ func TestCommandsE2E(t *testing.T) { } client2 := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTcpToken}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTCPToken}, }) t.Cleanup(func() { client2.ForceStop() }) @@ -53,7 +53,7 @@ func TestCommandsE2E(t *testing.T) { var clientCommands *rpc.CommandList waitForRPCCondition(t, 30*time.Second, "client commands to be listed", func() (bool, error) { var err error - clientCommands, err = session.RPC.Commands.List(t.Context(), &rpc.CommandsListRequest{ + clientCommands, err = session.RPC.Commands.List(t.Context(), &rpc.SessionCommandsListRequest{ IncludeBuiltins: rpcPtr(false), IncludeClientCommands: rpcPtr(true), IncludeSkills: rpcPtr(false), @@ -68,7 +68,7 @@ func TestCommandsE2E(t *testing.T) { t.Fatalf("Expected client-command-only list to exclude builtins, got %+v", clientCommands.Commands) } - builtinCommands, err := session.RPC.Commands.List(t.Context(), &rpc.CommandsListRequest{ + builtinCommands, err := session.RPC.Commands.List(t.Context(), &rpc.SessionCommandsListRequest{ IncludeBuiltins: rpcPtr(true), IncludeClientCommands: rpcPtr(false), IncludeSkills: rpcPtr(false), @@ -93,7 +93,7 @@ func TestCommandsE2E(t *testing.T) { } defer session.Disconnect() - builtinCommands, err := session.RPC.Commands.List(t.Context(), &rpc.CommandsListRequest{ + builtinCommands, err := session.RPC.Commands.List(t.Context(), &rpc.SessionCommandsListRequest{ IncludeBuiltins: rpcPtr(true), IncludeClientCommands: rpcPtr(false), IncludeSkills: rpcPtr(false), @@ -152,7 +152,7 @@ func TestCommandsE2E(t *testing.T) { defer session.Disconnect() waitForRPCCondition(t, 30*time.Second, "registered deploy command", func() (bool, error) { - commands, err := session.RPC.Commands.List(t.Context(), &rpc.CommandsListRequest{ + commands, err := session.RPC.Commands.List(t.Context(), &rpc.SessionCommandsListRequest{ IncludeBuiltins: rpcPtr(false), IncludeClientCommands: rpcPtr(true), IncludeSkills: rpcPtr(false), @@ -437,7 +437,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, OnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) { - return copilot.ElicitationResult{Action: "accept", Content: map[string]any{}}, nil + return copilot.ElicitationResult{Action: copilot.ElicitationActionAccept, Content: map[string]any{}}, nil }, }) if err != nil { @@ -481,7 +481,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { t.Errorf("Expected RequestedSchema to contain 'confirmed' property") } return copilot.ElicitationResult{ - Action: "accept", + Action: copilot.ElicitationActionAccept, Content: map[string]any{"confirmed": true}, }, nil }, @@ -505,7 +505,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, OnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) { - return copilot.ElicitationResult{Action: "decline"}, nil + return copilot.ElicitationResult{Action: copilot.ElicitationActionDecline}, nil }, }) if err != nil { @@ -534,7 +534,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { t.Errorf("Expected RequestedSchema to contain 'selection' property") } return copilot.ElicitationResult{ - Action: "accept", + Action: copilot.ElicitationActionAccept, Content: map[string]any{"selection": "beta"}, }, nil }, @@ -568,7 +568,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { t.Errorf("Expected RequestedSchema to contain 'value' property") } return copilot.ElicitationResult{ - Action: "accept", + Action: copilot.ElicitationActionAccept, Content: map[string]any{"value": "typed value"}, }, nil }, @@ -579,7 +579,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { minLen := 1 maxLen := 20 - value, ok, err := session.UI().Input(t.Context(), "Enter value", &copilot.UiInputOptions{ + value, ok, err := session.UI().Input(t.Context(), "Enter value", &copilot.UIInputOptions{ Title: "Value", Description: "A value to test", MinLength: &minLen, @@ -601,9 +601,9 @@ func TestUIElicitationCallbackE2E(t *testing.T) { ctx.ConfigureForTest(t) responses := []copilot.ElicitationResult{ - {Action: "accept", Content: map[string]any{"name": "Mona"}}, - {Action: "decline"}, - {Action: "cancel"}, + {Action: copilot.ElicitationActionAccept, Content: map[string]any{"name": "Mona"}}, + {Action: copilot.ElicitationActionDecline}, + {Action: copilot.ElicitationActionCancel}, } var idx int @@ -625,9 +625,8 @@ func TestUIElicitationCallbackE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - schema := rpc.UIElicitationSchema{ - Type: rpc.UIElicitationSchemaTypeObject, - Properties: map[string]rpc.UIElicitationSchemaProperty{ + schema := copilot.ElicitationSchema{ + Properties: map[string]any{ "name": &rpc.UIElicitationSchemaPropertyString{}, }, Required: []string{"name"}, @@ -637,10 +636,10 @@ func TestUIElicitationCallbackE2E(t *testing.T) { if err != nil { t.Fatalf("Elicitation accept call failed: %v", err) } - if accept.Action != "accept" { + if accept.Action != copilot.ElicitationActionAccept { t.Errorf("Expected accept.Action='accept', got %q", accept.Action) } - if accept.Content == nil || fmt.Sprintf("%v", accept.Content["name"]) != "Mona" { + if accept.Content == nil || accept.Content["name"] != "Mona" { t.Errorf("Expected accept.Content[name]='Mona', got %v", accept.Content) } @@ -648,7 +647,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { if err != nil { t.Fatalf("Elicitation decline call failed: %v", err) } - if decline.Action != "decline" { + if decline.Action != copilot.ElicitationActionDecline { t.Errorf("Expected decline.Action='decline', got %q", decline.Action) } @@ -656,7 +655,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { if err != nil { t.Fatalf("Elicitation cancel call failed: %v", err) } - if cancel.Action != "cancel" { + if cancel.Action != copilot.ElicitationActionCancel { t.Errorf("Expected cancel.Action='cancel', got %q", cancel.Action) } }) @@ -681,7 +680,7 @@ func TestUIElicitationCallbackE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, OnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) { - return copilot.ElicitationResult{Action: "accept", Content: map[string]any{}}, nil + return copilot.ElicitationResult{Action: copilot.ElicitationActionAccept, Content: map[string]any{}}, nil }, }) if err != nil { @@ -694,35 +693,20 @@ func TestUIElicitationCallbackE2E(t *testing.T) { }) } -// schemaHasProperty reports whether the elicitation schema map has a top-level -// property with the given name. RequestedSchema["properties"] is typically a -// map[string]rpc.UIElicitationSchemaProperty, but we accept any map[string]X. -func schemaHasProperty(schema map[string]any, name string) bool { +// schemaHasProperty reports whether the elicitation schema has a top-level +// property with the given name. +func schemaHasProperty(schema *copilot.ElicitationSchema, name string) bool { if schema == nil { return false } - props, ok := schema["properties"] - if !ok || props == nil { - return false - } - switch p := props.(type) { - case map[string]any: - _, found := p[name] - return found - case map[string]rpc.UIElicitationSchemaProperty: - _, found := p[name] - return found - default: - // Fallback: marshal/unmarshal via reflection-friendly route. - // For test diagnostic purposes we treat unknown shapes as not found. - return false - } + _, found := schema.Properties[name] + return found } func TestUIElicitationMultiClientE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client1 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.TCPConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { client1.ForceStop() }) @@ -770,13 +754,13 @@ func TestUIElicitationMultiClientE2E(t *testing.T) { // Client2 joins with elicitation handler — should trigger capabilities.changed client2 := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTcpToken}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTCPToken}, }) session2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, SuppressResumeEvent: true, OnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) { - return copilot.ElicitationResult{Action: "accept", Content: map[string]any{}}, nil + return copilot.ElicitationResult{Action: copilot.ElicitationActionAccept, Content: map[string]any{}}, nil }, }) if err != nil { @@ -830,13 +814,13 @@ func TestUIElicitationMultiClientE2E(t *testing.T) { // Client3 (dedicated for this test) joins with elicitation handler client3 := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTcpToken}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTCPToken}, }) _, err = client3.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, SuppressResumeEvent: true, OnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) { - return copilot.ElicitationResult{Action: "accept", Content: map[string]any{}}, nil + return copilot.ElicitationResult{Action: copilot.ElicitationActionAccept, Content: map[string]any{}}, nil }, }) if err != nil { diff --git a/go/internal/e2e/connection_token_test.go b/go/internal/e2e/connection_token_test.go index f68bb0bf8..6d36000b3 100644 --- a/go/internal/e2e/connection_token_test.go +++ b/go/internal/e2e/connection_token_test.go @@ -13,7 +13,7 @@ func TestConnectionToken(t *testing.T) { t.Run("explicit token round-trips successfully", func(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{ + opts.Connection = copilot.TCPConnection{ Path: ctx.CLIPath, ConnectionToken: "right-token", } @@ -36,7 +36,7 @@ func TestConnectionToken(t *testing.T) { t.Run("auto-generated token round-trips successfully", func(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: ctx.CLIPath} + opts.Connection = copilot.TCPConnection{Path: ctx.CLIPath} }) t.Cleanup(func() { client.ForceStop() }) @@ -56,7 +56,7 @@ func TestConnectionToken(t *testing.T) { t.Run("sibling client with wrong token is rejected", func(t *testing.T) { ctx := testharness.NewTestContext(t) good := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{ + opts.Connection = copilot.TCPConnection{ Path: ctx.CLIPath, ConnectionToken: "right-token", } @@ -72,7 +72,7 @@ func TestConnectionToken(t *testing.T) { } bad := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{ + Connection: copilot.URIConnection{ URL: fmt.Sprintf("localhost:%d", port), ConnectionToken: "wrong", }, @@ -91,7 +91,7 @@ func TestConnectionToken(t *testing.T) { t.Run("sibling client with no token is rejected", func(t *testing.T) { ctx := testharness.NewTestContext(t) good := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{ + opts.Connection = copilot.TCPConnection{ Path: ctx.CLIPath, ConnectionToken: "right-token", } @@ -107,7 +107,7 @@ func TestConnectionToken(t *testing.T) { } none := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", port)}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", port)}, }) t.Cleanup(func() { none.ForceStop() }) diff --git a/go/internal/e2e/copilot_request_cancel_error_e2e_test.go b/go/internal/e2e/copilot_request_cancel_error_e2e_test.go new file mode 100644 index 000000000..46091d5ac --- /dev/null +++ b/go/internal/e2e/copilot_request_cancel_error_e2e_test.go @@ -0,0 +1,175 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "errors" + "io" + "net/http" + "sync" + "sync/atomic" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +// TestCopilotRequestCancelError covers the two terminal paths of +// CopilotRequestHandler that the happy-path handler and session-id tests never +// reach: +// +// - error: the Transport returns an error for an inference request → the +// adapter reports a transport error instead of hanging. +// - cancel: the Transport blocks indefinitely on an inference request; when +// the consumer aborts the turn the runtime cancels the in-flight request, +// firing the request's context cancellation. + +// --- error case --- + +type throwingTransport struct { + mu sync.Mutex + totalCalls int + callsBeforeError int +} + +func (tr *throwingTransport) RoundTrip(req *http.Request) (*http.Response, error) { + tr.mu.Lock() + tr.totalCalls++ + tr.mu.Unlock() + + if isInferenceURL(req.URL.String()) { + // Drain the body so the request is fully consumed before erroring. + if req.Body != nil { + _, _ = io.Copy(io.Discard, req.Body) + } + tr.mu.Lock() + tr.callsBeforeError++ + tr.mu.Unlock() + return nil, errors.New("synthetic-callback-transport-failure") + } + return buildNonInferenceResponse(req.URL.String()), nil +} + +func TestCopilotRequestError(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + ctx := testharness.NewTestContext(t) + transport := &throwingTransport{} + handler := &copilot.CopilotRequestHandler{Transport: transport} + client := newCopilotRequestClient(ctx, handler) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + // The transport throws on inference; the agent layer surfaces it as an + // error or an event rather than hanging. + _, sendErr := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Say OK."}) + _ = session.Disconnect() + + transport.mu.Lock() + total := transport.totalCalls + before := transport.callsBeforeError + transport.mu.Unlock() + + if total == 0 { + t.Fatal("Expected the transport to be invoked") + } + if before == 0 { + t.Fatal("Expected the inference transport call to be reached and raise") + } + if sendErr != nil && len(sendErr.Error()) == 0 { + t.Fatal("Expected a non-empty error string when an error surfaces") + } +} + +// --- cancel case --- + +type cancellingTransport struct { + inferenceEntered atomic.Bool + sawAbort atomic.Bool + abortSeen chan struct{} + once sync.Once +} + +func newCancellingTransport() *cancellingTransport { + return &cancellingTransport{abortSeen: make(chan struct{})} +} + +func (tr *cancellingTransport) RoundTrip(req *http.Request) (*http.Response, error) { + if !isInferenceURL(req.URL.String()) { + return buildNonInferenceResponse(req.URL.String()), nil + } + if req.Body != nil { + _, _ = io.Copy(io.Discard, req.Body) + } + tr.inferenceEntered.Store(true) + // Block until the runtime cancels the request (via context cancellation). + <-req.Context().Done() + tr.sawAbort.Store(true) + tr.once.Do(func() { close(tr.abortSeen) }) + return nil, req.Context().Err() +} + +func waitFor(t *testing.T, predicate func() bool, timeout time.Duration) { + t.Helper() + deadline := time.Now().Add(timeout) + for !predicate() { + if time.Now().After(deadline) { + t.Fatal("waitFor timed out") + } + time.Sleep(50 * time.Millisecond) + } +} + +func TestCopilotRequestCancel(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + ctx := testharness.NewTestContext(t) + transport := newCancellingTransport() + handler := &copilot.CopilotRequestHandler{Transport: transport} + client := newCopilotRequestClient(ctx, handler) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + if _, err := session.Send(t.Context(), copilot.MessageOptions{Prompt: "Say OK."}); err != nil { + t.Fatalf("send failed: %v", err) + } + waitFor(t, transport.inferenceEntered.Load, 60*time.Second) + if err := session.Abort(t.Context()); err != nil { + t.Fatalf("abort failed: %v", err) + } + + select { + case <-transport.abortSeen: + case <-time.After(30 * time.Second): + t.Fatal("Timed out waiting for the transport to observe runtime cancellation") + } + _ = session.Disconnect() + + if !transport.inferenceEntered.Load() { + t.Fatal("Expected the inference transport call to be entered") + } + if !transport.sawAbort.Load() { + t.Fatal("Expected the transport to observe the runtime-driven cancellation") + } +} diff --git a/go/internal/e2e/copilot_request_handler_e2e_test.go b/go/internal/e2e/copilot_request_handler_e2e_test.go new file mode 100644 index 000000000..a0cfcb63e --- /dev/null +++ b/go/internal/e2e/copilot_request_handler_e2e_test.go @@ -0,0 +1,208 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "context" + "encoding/json" + "net/http" + "net/http/httptest" + "net/url" + "strings" + "sync/atomic" + "testing" + + "github.com/coder/websocket" + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +const ( + handlerHTTPText = "OK from synthetic HTTP upstream." + handlerWSText = "OK from synthetic WS upstream." +) + +// wsSupportedEndpoints advertises both HTTP /responses and WS /responses so +// the runtime picks the WebSocket path when the ExP flag is set. +var wsSupportedEndpoints = []string{"/responses", "ws:/responses"} + +type handlerCounters struct { + httpRequests atomic.Int32 + httpResponses atomic.Int32 + wsRequestMessages atomic.Int32 + wsResponseMessages atomic.Int32 + upstreamWSRequests atomic.Int32 +} + +func sseBody(text, respID string) string { + return buildResponsesSSEBody(text, respID) +} + +// startFakeUpstreams brings up a real HTTP upstream (catalog / policy / +// responses-SSE) and a real WebSocket upstream that echoes /responses events +// per inbound message. +func startFakeUpstreams(t *testing.T, counters *handlerCounters) (httpURL, wsURL string) { + t.Helper() + + httpSrv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + path := strings.ToLower(strings.SplitN(r.URL.Path, "?", 2)[0]) + defer func() { _ = r.Body.Close() }() + switch { + case strings.HasSuffix(path, "/models"): + w.Header().Set("content-type", "application/json") + _, _ = w.Write([]byte(modelCatalogJSON(wsSupportedEndpoints))) + case strings.HasSuffix(path, "/models/session"): + w.Header().Set("content-type", "application/json") + _, _ = w.Write([]byte("{}")) + case strings.Contains(path, "/policy"): + w.Header().Set("content-type", "application/json") + _, _ = w.Write([]byte(`{"state":"enabled"}`)) + case strings.HasSuffix(path, "/responses"): + w.Header().Set("content-type", "text/event-stream") + _, _ = w.Write([]byte(sseBody(handlerHTTPText, "resp_stub_http"))) + default: + w.Header().Set("content-type", "application/json") + w.WriteHeader(http.StatusNotFound) + _, _ = w.Write([]byte(`{"error":"not_found"}`)) + } + })) + t.Cleanup(httpSrv.Close) + + wsSrv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + c, err := websocket.Accept(w, r, &websocket.AcceptOptions{InsecureSkipVerify: true}) + if err != nil { + return + } + defer c.Close(websocket.StatusNormalClosure, "") + c.SetReadLimit(-1) + bg := context.Background() + for { + _, _, readErr := c.Read(bg) + if readErr != nil { + return + } + counters.upstreamWSRequests.Add(1) + for _, event := range responsesEvents(handlerWSText, "resp_stub_ws") { + raw, _ := json.Marshal(event) + if err := c.Write(bg, websocket.MessageText, raw); err != nil { + return + } + } + } + })) + t.Cleanup(wsSrv.Close) + + return httpSrv.URL, "ws://" + strings.TrimPrefix(wsSrv.URL, "http://") +} + +type rewritingRoundTripper struct { + base *url.URL + counters *handlerCounters + inner http.RoundTripper +} + +func (rt *rewritingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) { + rt.counters.httpRequests.Add(1) + req.URL.Scheme = rt.base.Scheme + req.URL.Host = rt.base.Host + req.Host = rt.base.Host + req.Header.Set("x-test-mutated", "1") + resp, err := rt.inner.RoundTrip(req) + if err != nil { + return nil, err + } + rt.counters.httpResponses.Add(1) + resp.Header.Set("x-test-response-mutated", "1") + return resp, nil +} + +func TestCopilotRequestHandler(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + ctx := testharness.NewTestContext(t) + counters := &handlerCounters{} + httpURL, wsURL := startFakeUpstreams(t, counters) + + httpBase, err := url.Parse(httpURL) + if err != nil { + t.Fatalf("Failed to parse upstream URL: %v", err) + } + wsBase, err := url.Parse(wsURL) + if err != nil { + t.Fatalf("Failed to parse upstream ws URL: %v", err) + } + + handler := &copilot.CopilotRequestHandler{ + Transport: &rewritingRoundTripper{ + base: httpBase, + counters: counters, + inner: http.DefaultTransport.(*http.Transport).Clone(), + }, + OpenWebSocket: func(rctx *copilot.CopilotRequestContext) (copilot.CopilotWebSocketHandler, error) { + parsed, perr := url.Parse(rctx.URL) + if perr != nil { + return nil, perr + } + parsed.Scheme = wsBase.Scheme + parsed.Host = wsBase.Host + fwd := copilot.NewCopilotWebSocketForwarder(parsed.String(), rctx.Headers) + fwd.OnSendRequestMessage = func(msg copilot.CopilotWebSocketMessage) *copilot.CopilotWebSocketMessage { + counters.wsRequestMessages.Add(1) + return &msg + } + fwd.OnSendResponseMessage = func(msg copilot.CopilotWebSocketMessage) *copilot.CopilotWebSocketMessage { + counters.wsResponseMessages.Add(1) + return &msg + } + return fwd, nil + }, + } + + client := newCopilotRequestClient(ctx, handler, "COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES=true") + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + result, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Say OK."}) + if err != nil { + t.Fatalf("send_and_wait failed: %v", err) + } + _ = session.Disconnect() + + // The HTTP seam fired — the runtime issued model-layer GETs (catalog, + // policy) and possibly a single-shot inference through the RoundTripper. + if counters.httpRequests.Load() == 0 { + t.Fatal("Expected the HTTP RoundTripper to fire") + } + if counters.httpResponses.Load() == 0 { + t.Fatal("Expected the HTTP response mutation to fire") + } + + // The WebSocket seam fired — the main agent turn went over the WS path and + // we observed messages in both directions. + if counters.wsRequestMessages.Load() == 0 { + t.Fatal("Expected runtime → upstream ws messages") + } + if counters.wsResponseMessages.Load() == 0 { + t.Fatal("Expected upstream → runtime ws messages") + } + if counters.upstreamWSRequests.Load() == 0 { + t.Fatal("Expected the upstream WS to receive request messages") + } + + // Validate the final assistant response arrived (guards against truncated captures) + text := assistantText(result) + if !strings.Contains(text, "OK from synthetic") || !strings.Contains(text, "upstream") { + t.Fatalf("Expected synthetic upstream content in assistant reply, got %q", text) + } +} diff --git a/go/internal/e2e/copilot_request_helpers_test.go b/go/internal/e2e/copilot_request_helpers_test.go new file mode 100644 index 000000000..81d14f4d9 --- /dev/null +++ b/go/internal/e2e/copilot_request_helpers_test.go @@ -0,0 +1,288 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "encoding/json" + "io" + "net/http" + "regexp" + "strings" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +// Shared synthetic-upstream helpers for the CopilotRequestHandler e2e tests. +// +// These tests have no recorded snapshots: the registered handler fabricates +// well-formed model responses and the runtime routes all of its model-layer +// HTTP/WebSocket traffic through that handler instead of the CAPI proxy. The +// helpers centralise the synthetic CAPI shapes (model catalog, policy, +// /responses SSE, /chat/completions) so each test focuses on the behaviour it +// is exercising. + +const syntheticResponseText = "OK from the synthetic stream." + +var streamTrueRe = regexp.MustCompile(`"stream"\s*:\s*true`) + +func isStreamingRequest(body string) bool { + return streamTrueRe.MatchString(body) +} + +func isInferenceURL(url string) bool { + u := strings.ToLower(url) + return strings.HasSuffix(u, "/chat/completions") || + strings.HasSuffix(u, "/responses") || + strings.HasSuffix(u, "/v1/messages") || + strings.HasSuffix(u, "/messages") +} + +func sseFrame(eventType string, data map[string]any) string { + raw, _ := json.Marshal(data) + return "event: " + eventType + "\ndata: " + string(raw) + "\n\n" +} + +func modelCatalogJSON(supportedEndpoints []string) string { + model := map[string]any{ + "id": "claude-sonnet-4.5", + "name": "Claude Sonnet 4.5", + "object": "model", + "vendor": "Anthropic", + "version": "1", + "preview": false, + "model_picker_enabled": true, + "capabilities": map[string]any{ + "type": "chat", + "family": "claude-sonnet-4.5", + "tokenizer": "o200k_base", + "limits": map[string]any{ + "max_context_window_tokens": 200000, + "max_output_tokens": 8192, + }, + "supports": map[string]any{ + "streaming": true, + "tool_calls": true, + "parallel_tool_calls": true, + "vision": true, + }, + }, + } + if supportedEndpoints != nil { + model["supported_endpoints"] = supportedEndpoints + } + raw, _ := json.Marshal(map[string]any{"data": []any{model}}) + return string(raw) +} + +// responsesEvents returns the ordered /responses event objects the runtime's +// reducer expects. Used raw (one object == one WebSocket message) for the WS +// path and SSE-framed for the HTTP path. +func responsesEvents(text, respID string) []map[string]any { + return []map[string]any{ + { + "type": "response.created", + "response": map[string]any{"id": respID, "object": "response", "status": "in_progress", "output": []any{}}, + }, + { + "type": "response.output_item.added", + "output_index": 0, + "item": map[string]any{"id": "msg_1", "type": "message", "role": "assistant", "content": []any{}}, + }, + { + "type": "response.content_part.added", + "output_index": 0, + "content_index": 0, + "part": map[string]any{"type": "output_text", "text": ""}, + }, + {"type": "response.output_text.delta", "output_index": 0, "content_index": 0, "delta": text}, + {"type": "response.output_text.done", "output_index": 0, "content_index": 0, "text": text}, + { + "type": "response.completed", + "response": map[string]any{ + "id": respID, + "object": "response", + "status": "completed", + "output": []any{ + map[string]any{ + "id": "msg_1", + "type": "message", + "role": "assistant", + "content": []any{map[string]any{"type": "output_text", "text": text}}, + }, + }, + "usage": map[string]any{"input_tokens": 5, "output_tokens": 7, "total_tokens": 12}, + }, + }, + } +} + +// buildResponsesSSEBody returns a complete SSE body for a /responses streaming response. +func buildResponsesSSEBody(text, respID string) string { + var sb strings.Builder + for _, event := range responsesEvents(text, respID) { + sb.WriteString(sseFrame(event["type"].(string), event)) + } + return sb.String() +} + +// buildAnthropicMessageSSEBody returns a complete Anthropic Messages SSE body for a +// streaming /messages response (message_start … message_stop). The buffered JSON +// message is only valid for a non-streaming request; a streaming request expects +// named SSE events or the runtime fails to finalize the message. +func buildAnthropicMessageSSEBody(text string) string { + events := []struct { + name string + data map[string]any + }{ + {"message_start", map[string]any{ + "type": "message_start", + "message": map[string]any{ + "id": "msg_stub_1", "type": "message", "role": "assistant", + "model": "claude-sonnet-4.5", "content": []any{}, + "stop_reason": nil, "stop_sequence": nil, + "usage": map[string]any{"input_tokens": 5, "output_tokens": 1}, + }, + }}, + {"content_block_start", map[string]any{ + "type": "content_block_start", "index": 0, + "content_block": map[string]any{"type": "text", "text": ""}, + }}, + {"content_block_delta", map[string]any{ + "type": "content_block_delta", "index": 0, + "delta": map[string]any{"type": "text_delta", "text": text}, + }}, + {"content_block_stop", map[string]any{"type": "content_block_stop", "index": 0}}, + {"message_delta", map[string]any{ + "type": "message_delta", + "delta": map[string]any{"stop_reason": "end_turn", "stop_sequence": nil}, + "usage": map[string]any{"output_tokens": 7}, + }}, + {"message_stop", map[string]any{"type": "message_stop"}}, + } + var sb strings.Builder + for _, event := range events { + sb.WriteString(sseFrame(event.name, event.data)) + } + return sb.String() +} + +// buildInferenceResponse synthesizes a well-formed inference HTTP response. +func buildInferenceResponse(url string, bodyText string) *http.Response { + wantsStream := isStreamingRequest(bodyText) + u := strings.ToLower(url) + + if strings.Contains(u, "/responses") { + if wantsStream { + return buildSSEResponse(buildResponsesSSEBody(syntheticResponseText, "resp_stub_1")) + } + events := responsesEvents(syntheticResponseText, "resp_stub_1") + last := events[len(events)-1]["response"] + raw, _ := json.Marshal(last) + return buildJSONResponse(200, string(raw)) + } + + if strings.Contains(u, "/chat/completions") && wantsStream { + base := func() map[string]any { + return map[string]any{ + "id": "chatcmpl-stub-1", "object": "chat.completion.chunk", + "created": 1, "model": "claude-sonnet-4.5", + } + } + c1 := base() + c1["choices"] = []any{map[string]any{"index": 0, "delta": map[string]any{"role": "assistant", "content": ""}, "finish_reason": nil}} + c2 := base() + c2["choices"] = []any{map[string]any{"index": 0, "delta": map[string]any{"content": syntheticResponseText}, "finish_reason": nil}} + c3 := base() + c3["choices"] = []any{map[string]any{"index": 0, "delta": map[string]any{}, "finish_reason": "stop"}} + c3["usage"] = map[string]any{"prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12} + var sb strings.Builder + for _, chunk := range []map[string]any{c1, c2, c3} { + raw, _ := json.Marshal(chunk) + sb.WriteString("data: " + string(raw) + "\n\n") + } + sb.WriteString("data: [DONE]\n\n") + return buildSSEResponse(sb.String()) + } + + if strings.HasSuffix(u, "/messages") { + if wantsStream { + return buildSSEResponse(buildAnthropicMessageSSEBody(syntheticResponseText)) + } + raw, _ := json.Marshal(map[string]any{ + "id": "msg_stub_1", + "type": "message", + "role": "assistant", + "model": "claude-sonnet-4.5", + "content": []any{map[string]any{"type": "text", "text": syntheticResponseText}}, + "stop_reason": "end_turn", + "stop_sequence": nil, + "usage": map[string]any{"input_tokens": 5, "output_tokens": 7}, + }) + return buildJSONResponse(200, string(raw)) + } + + raw, _ := json.Marshal(map[string]any{ + "id": "chatcmpl-stub-1", "object": "chat.completion", "created": 1, "model": "claude-sonnet-4.5", + "choices": []any{map[string]any{"index": 0, "message": map[string]any{"role": "assistant", "content": syntheticResponseText}, "finish_reason": "stop"}}, + "usage": map[string]any{"prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12}, + }) + return buildJSONResponse(200, string(raw)) +} + +// buildNonInferenceResponse serves catalog / session / policy endpoints. +func buildNonInferenceResponse(url string) *http.Response { + u := strings.ToLower(url) + switch { + case strings.HasSuffix(u, "/models"): + return buildJSONResponse(200, modelCatalogJSON(nil)) + case strings.Contains(u, "/models/session"): + return buildJSONResponse(200, "{}") + case strings.Contains(u, "/policy"): + return buildJSONResponse(200, `{"state":"enabled"}`) + } + return buildJSONResponse(200, "{}") +} + +func buildJSONResponse(status int, body string) *http.Response { + return &http.Response{ + StatusCode: status, + Status: http.StatusText(status), + Header: http.Header{"Content-Type": {"application/json"}}, + Body: io.NopCloser(strings.NewReader(body)), + } +} + +func buildSSEResponse(body string) *http.Response { + return &http.Response{ + StatusCode: 200, + Status: "OK", + Header: http.Header{"Content-Type": {"text/event-stream"}, "Cache-Control": {"no-cache"}}, + Body: io.NopCloser(strings.NewReader(body)), + } +} + +func assistantText(msg *copilot.SessionEvent) string { + if msg == nil { + return "" + } + if d, ok := msg.Data.(*copilot.AssistantMessageData); ok { + return d.Content + } + return "" +} + +// newCopilotRequestClient builds a client wired to handler via RequestHandler. +// Each test that needs inference interception owns an isolated client carrying +// its own handler. extraEnv is appended to the spawned runtime's environment +// (e.g. to flip an ExP flag for the WS transport). +func newCopilotRequestClient(ctx *testharness.TestContext, handler *copilot.CopilotRequestHandler, extraEnv ...string) *copilot.Client { + return ctx.NewClient(func(o *copilot.ClientOptions) { + o.RequestHandler = handler + if len(extraEnv) > 0 { + o.Env = append(o.Env, extraEnv...) + } + }) +} diff --git a/go/internal/e2e/copilot_request_session_id_e2e_test.go b/go/internal/e2e/copilot_request_session_id_e2e_test.go new file mode 100644 index 000000000..f7673bd45 --- /dev/null +++ b/go/internal/e2e/copilot_request_session_id_e2e_test.go @@ -0,0 +1,183 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "io" + "net/http" + "strings" + "sync" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +type interceptedRequest struct { + url string + sessionID string + agentID string + parentAgentID string + interactionType string + body string +} + +// recordingTransport intercepts every model-layer request, records its URL and +// session ID (extracted from the CopilotRequestContext attached to the +// http.Request), and synthesizes a well-formed response so turns complete. +type recordingTransport struct { + mu sync.Mutex + records []interceptedRequest +} + +func (rt *recordingTransport) RoundTrip(req *http.Request) (*http.Response, error) { + rctx := copilot.RequestContextFrom(req) + sessionID := "" + agentID := "" + parentAgentID := "" + interactionType := "" + if rctx != nil { + sessionID = rctx.SessionID + agentID = rctx.AgentID + parentAgentID = rctx.ParentAgentID + interactionType = rctx.InteractionType + } + bodyBytes := []byte(nil) + if req.Body != nil { + bodyBytes, _ = io.ReadAll(req.Body) + } + bodyText := string(bodyBytes) + + rt.mu.Lock() + rt.records = append(rt.records, interceptedRequest{ + url: req.URL.String(), + sessionID: sessionID, + agentID: agentID, + parentAgentID: parentAgentID, + interactionType: interactionType, + body: bodyText, + }) + rt.mu.Unlock() + + if isInferenceURL(req.URL.String()) { + return buildInferenceResponse(req.URL.String(), bodyText), nil + } + return buildNonInferenceResponse(req.URL.String()), nil +} + +func (rt *recordingTransport) inferenceRecords() []interceptedRequest { + rt.mu.Lock() + defer rt.mu.Unlock() + var out []interceptedRequest + for _, r := range rt.records { + if isInferenceURL(r.url) { + out = append(out, r) + } + } + return out +} + +func assertAgentMetadata(t *testing.T, r interceptedRequest) { + t.Helper() + if r.agentID == "" { + t.Fatal("inference request must carry an agent id") + } + if r.interactionType == "" { + t.Fatal("inference request must carry an interaction type") + } +} + +func TestCopilotRequestSessionID(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + ctx := testharness.NewTestContext(t) + transport := &recordingTransport{} + handler := &copilot.CopilotRequestHandler{Transport: transport} + client := newCopilotRequestClient(ctx, handler) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + var capiSessionID string + + t.Run("threads session id into a CAPI session", func(t *testing.T) { + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + capiSessionID = session.SessionID + + result, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Say OK."}) + if err != nil { + t.Fatalf("send_and_wait failed: %v", err) + } + _ = session.Disconnect() + + inference := transport.inferenceRecords() + if len(inference) == 0 { + t.Fatal("Expected at least one intercepted inference request") + } + for _, r := range inference { + if r.sessionID != capiSessionID { + t.Fatalf("CAPI inference request must carry session id %q, got %q", capiSessionID, r.sessionID) + } + assertAgentMetadata(t, r) + } + + // Validate the final assistant response arrived (guards against truncated captures) + if !strings.Contains(assistantText(result), "OK from the synthetic") { + t.Fatalf("Expected synthetic content in assistant reply, got %q", assistantText(result)) + } + }) + + t.Run("threads session id into a BYOK session", func(t *testing.T) { + before := len(transport.inferenceRecords()) + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: "claude-sonnet-4.5", + Provider: &copilot.ProviderConfig{ + Type: "openai", + WireAPI: "responses", + BaseURL: "https://byok.invalid/v1", + APIKey: "byok-secret", + ModelID: "claude-sonnet-4.5", + WireModel: "claude-sonnet-4.5", + }, + }) + if err != nil { + t.Fatalf("Failed to create BYOK session: %v", err) + } + byokSessionID := session.SessionID + + result, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Say OK."}) + if err != nil { + t.Fatalf("send_and_wait failed: %v", err) + } + _ = session.Disconnect() + + inference := transport.inferenceRecords() + if len(inference) <= before { + t.Fatal("Expected at least one intercepted BYOK inference request") + } + for _, r := range inference[before:] { + if r.sessionID != byokSessionID { + t.Fatalf("BYOK inference request must carry session id %q, got %q", byokSessionID, r.sessionID) + } + assertAgentMetadata(t, r) + } + + if byokSessionID == capiSessionID { + t.Fatal("Expected per-session ids to differ between turns") + } + + // Validate the final assistant response arrived (guards against truncated captures) + if !strings.Contains(assistantText(result), "OK from the synthetic") { + t.Fatalf("Expected synthetic content in assistant reply, got %q", assistantText(result)) + } + }) +} diff --git a/go/internal/e2e/event_fidelity_e2e_test.go b/go/internal/e2e/event_fidelity_e2e_test.go index c48a4908a..e7cc4bfb3 100644 --- a/go/internal/e2e/event_fidelity_e2e_test.go +++ b/go/internal/e2e/event_fidelity_e2e_test.go @@ -168,6 +168,7 @@ func TestEventFidelityE2E(t *testing.T) { if answer == nil { t.Fatal("Expected SendAndWait to return an assistant message") + return } if ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, "18") { t.Errorf("Expected answer to contain '18', got %v", answer.Data) diff --git a/go/internal/e2e/github_telemetry_e2e_test.go b/go/internal/e2e/github_telemetry_e2e_test.go new file mode 100644 index 000000000..aa26ba31f --- /dev/null +++ b/go/internal/e2e/github_telemetry_e2e_test.go @@ -0,0 +1,68 @@ +package e2e + +import ( + "sync" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestGitHubTelemetryE2E(t *testing.T) { + t.Run("should forward github telemetry for a live session", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + ctx.ConfigureForTest(t) + + var mu sync.Mutex + var notifications []*rpc.GitHubTelemetryNotification + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.OnGitHubTelemetry = func(notification *rpc.GitHubTelemetryNotification) { + mu.Lock() + notifications = append(notifications, notification) + mu.Unlock() + } + }) + t.Cleanup(func() { client.ForceStop() }) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + t.Cleanup(func() { session.Disconnect() }) + + notification := waitForGitHubTelemetryNotification(t, &mu, ¬ifications, 30*time.Second) + if notification.SessionID == nil || *notification.SessionID == "" { + t.Fatal("Expected a non-empty SessionID") + } + if notification.Event.Kind == "" { + t.Fatal("Expected a non-empty Event.Kind") + } + }) +} + +func waitForGitHubTelemetryNotification(t *testing.T, mu *sync.Mutex, notifications *[]*rpc.GitHubTelemetryNotification, timeout time.Duration) *rpc.GitHubTelemetryNotification { + t.Helper() + + deadline := time.Now().Add(timeout) + for time.Now().Before(deadline) { + mu.Lock() + if len(*notifications) > 0 { + notification := (*notifications)[0] + mu.Unlock() + if notification != nil { + return notification + } + t.Fatal("Received nil GitHub telemetry notification") + } + mu.Unlock() + + time.Sleep(50 * time.Millisecond) + } + + t.Fatalf("Timed out waiting for GitHub telemetry notification after %s", timeout) + return nil +} diff --git a/go/internal/e2e/hooks_extended_e2e_test.go b/go/internal/e2e/hooks_extended_e2e_test.go index 5c049da8a..5cbba3856 100644 --- a/go/internal/e2e/hooks_extended_e2e_test.go +++ b/go/internal/e2e/hooks_extended_e2e_test.go @@ -14,8 +14,9 @@ import ( // Mirrors dotnet/test/HookLifecycleAndOutputTests.cs (snapshot category "hooks_extended"). // // Covers each handler exposed on copilot.SessionHooks: OnPreToolUse, -// OnPostToolUse, OnPostToolUseFailure, OnUserPromptSubmitted, OnSessionStart, -// OnSessionEnd, OnErrorOccurred. Output-shape behavior (modifiedPrompt / +// OnPostToolUse, OnPostToolUseFailure, OnUserPromptSubmitted, +// OnUserPromptTransformed, OnSessionStart, OnSessionEnd, OnErrorOccurred, +// OnAgentStop. Output-shape behavior (modifiedPrompt / modifiedTransformedPrompt / // additionalContext / errorHandling / modifiedArgs / modifiedResult / // sessionSummary) is asserted alongside hook invocation. If a new handler is // added to SessionHooks, add a corresponding test here. @@ -72,6 +73,59 @@ func TestHooksExtendedE2E(t *testing.T) { } }) + t.Run("should invoke userPromptTransformed hook and modify transformed prompt", func(t *testing.T) { + ctx.ConfigureForTest(t) + + var ( + mu sync.Mutex + inputs []copilot.UserPromptTransformedHookInput + ) + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Hooks: &copilot.SessionHooks{ + OnUserPromptTransformed: func(input copilot.UserPromptTransformedHookInput, invocation copilot.HookInvocation) (*copilot.UserPromptTransformedHookOutput, error) { + mu.Lock() + inputs = append(inputs, input) + mu.Unlock() + if invocation.SessionID == "" { + t.Error("Expected non-empty session ID in invocation") + } + return &copilot.UserPromptTransformedHookOutput{ + ModifiedTransformedPrompt: copilot.String("Reply with exactly: HOOKED_TRANSFORMED_PROMPT"), + }, nil + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Answer the request above."}) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + + mu.Lock() + defer mu.Unlock() + if len(inputs) == 0 { + t.Fatal("Expected at least one userPromptTransformed hook invocation") + } + if !strings.Contains(inputs[0].Prompt, "Answer the request above.") { + t.Errorf("Expected original prompt in hook input, got %q", inputs[0].Prompt) + } + if !strings.Contains(inputs[0].TransformedPrompt, "Answer the request above.") || + !strings.Contains(inputs[0].TransformedPrompt, "") { + t.Errorf("Expected runtime-transformed prompt in hook input, got %q", inputs[0].TransformedPrompt) + } + if !inputs[0].Timestamp.After(time.UnixMilli(0)) || inputs[0].WorkingDirectory == "" { + t.Error("Expected timestamp and working directory in hook input") + } + assistantMessage, ok := response.Data.(*copilot.AssistantMessageData) + if !ok || !strings.Contains(assistantMessage.Content, "HOOKED_TRANSFORMED_PROMPT") { + t.Errorf("Expected transformed prompt response, got %v", response.Data) + } + }) + t.Run("should invoke sessionStart hook", func(t *testing.T) { ctx.ConfigureForTest(t) @@ -215,6 +269,66 @@ func TestHooksExtendedE2E(t *testing.T) { } }) + t.Run("should invoke agentStop hook and apply block response", func(t *testing.T) { + ctx.ConfigureForTest(t) + + var ( + mu sync.Mutex + inputs []copilot.AgentStopHookInput + ) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Hooks: &copilot.SessionHooks{ + OnAgentStop: func(input copilot.AgentStopHookInput, invocation copilot.HookInvocation) (*copilot.AgentStopHookOutput, error) { + mu.Lock() + inputs = append(inputs, input) + callCount := len(inputs) + mu.Unlock() + if invocation.SessionID == "" { + t.Error("Expected non-empty session ID in invocation") + } + if callCount == 1 { + return &copilot.AgentStopHookOutput{ + Decision: "block", + Reason: "Reply with exactly: AGENT_STOP_CONTINUED", + }, nil + } + return nil, nil + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Reply with exactly: AGENT_STOP_INITIAL", + }) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + + mu.Lock() + defer mu.Unlock() + if len(inputs) != 2 { + t.Fatalf("Expected two agentStop hook invocations, got %+v", inputs) + } + if inputs[0].StopHookActive { + t.Error("Expected first agentStop invocation to not be a continuation") + } + if !inputs[1].StopHookActive { + t.Error("Expected second agentStop invocation to be a continuation") + } + if inputs[0].StopReason != "end_turn" || inputs[0].TranscriptPath == "" { + t.Errorf("Unexpected first agentStop input: %+v", inputs[0]) + } + assistantMessage, ok := response.Data.(*copilot.AssistantMessageData) + if !ok || !strings.Contains(assistantMessage.Content, "AGENT_STOP_CONTINUED") { + t.Errorf("Expected final response to contain AGENT_STOP_CONTINUED, got %v", response.Data) + } + }) + t.Run("should allow preToolUse to return modifiedArgs and suppressOutput", func(t *testing.T) { ctx.ConfigureForTest(t) @@ -293,13 +407,12 @@ func TestHooksExtendedE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - AvailableTools: []string{"report_intent"}, Hooks: &copilot.SessionHooks{ OnPostToolUse: func(input copilot.PostToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) { mu.Lock() inputs = append(inputs, input) mu.Unlock() - if input.ToolName != "report_intent" { + if input.ToolName != "view" { return nil, nil } return &copilot.PostToolUseHookOutput{ @@ -318,7 +431,7 @@ func TestHooksExtendedE2E(t *testing.T) { } response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ - Prompt: "Call the report_intent tool with intent 'Testing post hook', then reply done.", + Prompt: "Call the view tool to read the current directory, then reply done.", }) if err != nil { t.Fatalf("Failed to send message: %v", err) @@ -326,24 +439,27 @@ func TestHooksExtendedE2E(t *testing.T) { mu.Lock() defer mu.Unlock() - hadReportIntent := false + hadView := false for _, input := range inputs { - if input.ToolName == "report_intent" { - hadReportIntent = true + if input.ToolName == "view" { + hadView = true break } } - if !hadReportIntent { - t.Errorf("Expected at least one postToolUse invocation for report_intent, got %+v", inputs) + if !hadView { + t.Errorf("Expected at least one postToolUse invocation for view, got %+v", inputs) } assistantMessage, ok := response.Data.(*copilot.AssistantMessageData) - if !ok || assistantMessage.Content != "Done." { - t.Errorf("Expected response content to be 'Done.', got %v", response.Data) + if !ok || !strings.Contains(strings.ToLower(assistantMessage.Content), "done") { + t.Errorf("Expected response content to contain 'done', got %v", response.Data) } }) t.Run("should invoke postToolUseFailure hook for failed tool result", func(t *testing.T) { + t.Skip("Fails with 1.0.64-0 runtime: built-in tools are not available when " + + "hooks restrict availableTools, so the failure path cannot be exercised. " + + "Follow up with runtime team.") ctx.ConfigureForTest(t) var ( diff --git a/go/internal/e2e/inprocess_ffi_e2e_test.go b/go/internal/e2e/inprocess_ffi_e2e_test.go new file mode 100644 index 000000000..6923384a2 --- /dev/null +++ b/go/internal/e2e/inprocess_ffi_e2e_test.go @@ -0,0 +1,62 @@ +package e2e + +import ( + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +// TestInProcessFfiE2E is a smoke test for the in-process (FFI) transport. It +// starts a client that loads the native runtime cdylib next to the resolved CLI +// entrypoint, lets the native host spawn the worker, performs a purely local +// "ping" round-trip through the runtime, and stops cleanly. No auth or replay +// proxy is involved, so it needs no snapshot. +// +// Mirrors python/e2e/test_inprocess_ffi_e2e.py and +// nodejs/test/e2e/inprocess_ffi.e2e.test.ts. +func TestInProcessFfiE2E(t *testing.T) { + // Loading the native runtime cdylib (libnode) into this test process installs + // foreign signal handlers. On macOS the Go runtime then aborts when it reaps + // its own os/exec children (see ffihost signal re-arming). The in-process + // matrix cell already loads libnode for the whole suite and re-arms those + // handlers; the default (child-process) cell must never load it, so restrict + // this dedicated FFI smoke test to the in-process cell. + if !testharness.IsInProcessTransport() { + t.Skip("in-process FFI smoke test runs only under the inprocess transport cell") + } + + cliPath := testharness.CLIPath() + if cliPath == "" { + t.Fatal("CLI not found. Run 'npm install' in the nodejs directory first.") + } + t.Setenv("COPILOT_CLI_PATH", cliPath) + + t.Run("should start and connect over in-process FFI", func(t *testing.T) { + client := copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.InProcessConnection{}, + }) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client over in-process FFI: %v", err) + } + + pong, err := client.Ping(t.Context(), "ffi message") + if err != nil { + t.Fatalf("Failed to ping: %v", err) + } + + if pong.Message != "pong: ffi message" { + t.Errorf("Expected pong.message to be 'pong: ffi message', got %q", pong.Message) + } + + if pong.Timestamp.IsZero() { + t.Errorf("Expected non-zero pong.timestamp, got %s", pong.Timestamp) + } + + if err := client.Stop(); err != nil { + t.Errorf("Expected no errors on stop, got %v", err) + } + }) +} diff --git a/go/internal/e2e/mcp_and_agents_e2e_test.go b/go/internal/e2e/mcp_and_agents_e2e_test.go index 4c7f29bc8..71a152eca 100644 --- a/go/internal/e2e/mcp_and_agents_e2e_test.go +++ b/go/internal/e2e/mcp_and_agents_e2e_test.go @@ -31,7 +31,7 @@ func TestMCPServersE2E(t *testing.T) { if session.SessionID == "" { t.Error("Expected non-empty session ID") } - waitForMCPServerStatus(t, session, "test-server", rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, "test-server", rpc.MCPServerStatusConnected) // Simple interaction to verify session works _, err = session.Send(t.Context(), copilot.MessageOptions{ @@ -59,7 +59,7 @@ func TestMCPServersE2E(t *testing.T) { mcpServers := map[string]copilot.MCPServerConfig{ "test-server": copilot.MCPStdioServerConfig{ Command: "git", - Tools: &[]string{"*"}, + Tools: []string{"*"}, }, } @@ -107,7 +107,7 @@ func TestMCPServersE2E(t *testing.T) { if session2.SessionID != sessionID { t.Errorf("Expected session ID %s, got %s", sessionID, session2.SessionID) } - waitForMCPServerStatus(t, session2, "test-server", rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session2, "test-server", rpc.MCPServerStatusConnected) session2.Disconnect() }) @@ -115,17 +115,14 @@ func TestMCPServersE2E(t *testing.T) { t.Run("should pass literal env values to MCP server subprocess", func(t *testing.T) { ctx.ConfigureForTest(t) - mcpServerPath, err := filepath.Abs("../../../test/harness/test-mcp-server.mjs") - if err != nil { - t.Fatalf("Failed to resolve test-mcp-server path: %v", err) - } + mcpServerPath := testharness.RepoPath("test", "harness", "test-mcp-server.mjs") mcpServerDir := filepath.Dir(mcpServerPath) mcpServers := map[string]copilot.MCPServerConfig{ "env-echo": copilot.MCPStdioServerConfig{ Command: "node", Args: []string{mcpServerPath}, - Tools: &[]string{"*"}, + Tools: []string{"*"}, Env: map[string]string{"TEST_SECRET": "hunter2"}, WorkingDirectory: mcpServerDir, }, @@ -142,7 +139,7 @@ func TestMCPServersE2E(t *testing.T) { if session.SessionID == "" { t.Error("Expected non-empty session ID") } - waitForMCPServerStatus(t, session, "env-echo", rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, "env-echo", rpc.MCPServerStatusConnected) message, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "Use the env-echo/get_env tool to read the TEST_SECRET environment variable. Reply with just the value, nothing else.", @@ -174,8 +171,8 @@ func TestMCPServersE2E(t *testing.T) { if session.SessionID == "" { t.Error("Expected non-empty session ID") } - waitForMCPServerStatus(t, session, "server1", rpc.McpServerStatusConnected) - waitForMCPServerStatus(t, session, "server2", rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, "server1", rpc.MCPServerStatusConnected) + waitForMCPServerStatus(t, session, "server2", rpc.MCPServerStatusConnected) session.Disconnect() }) @@ -408,7 +405,7 @@ func TestCombinedConfigurationE2E(t *testing.T) { if session.SessionID == "" { t.Error("Expected non-empty session ID") } - waitForMCPServerStatus(t, session, "shared-server", rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, "shared-server", rpc.MCPServerStatusConnected) session.Disconnect() }) diff --git a/go/internal/e2e/mcp_oauth_e2e_test.go b/go/internal/e2e/mcp_oauth_e2e_test.go new file mode 100644 index 000000000..95de73edd --- /dev/null +++ b/go/internal/e2e/mcp_oauth_e2e_test.go @@ -0,0 +1,456 @@ +package e2e + +import ( + "bufio" + "encoding/json" + "net/http" + "os" + "os/exec" + "slices" + "strings" + "sync" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +const expectedMCPOAuthToken = "sdk-host-token" +const refreshMCPOAuthToken = expectedMCPOAuthToken + "-refresh" +const upscopeMCPOAuthToken = expectedMCPOAuthToken + "-upscope" +const reauthMCPOAuthToken = expectedMCPOAuthToken + "-reauth" + +func TestMCPOAuthE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("satisfy MCP OAuth using host-provided token", func(t *testing.T) { + baseURL := startOAuthMCPServer(t) + serverName := "oauth-protected-mcp" + tokenType := "Bearer" + expiresIn := int64(3600) + var observedRequest copilot.MCPAuthRequest + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + OnMCPAuthRequest: func(request copilot.MCPAuthRequest, _ copilot.MCPAuthInvocation) (*copilot.MCPAuthResult, error) { + observedRequest = request + return copilot.MCPAuthResultToken(&copilot.MCPAuthToken{ + AccessToken: expectedMCPOAuthToken, + TokenType: &tokenType, + ExpiresIn: &expiresIn, + }), nil + }, + MCPServers: map[string]copilot.MCPServerConfig{ + serverName: copilot.MCPHTTPServerConfig{ + URL: baseURL + "/mcp", + Tools: []string{"*"}, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + t.Cleanup(func() { session.Disconnect() }) + + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + tools, err := session.RPC.MCP.ListTools(t.Context(), &rpc.MCPListToolsRequest{ServerName: serverName}) + if err != nil { + t.Fatalf("Failed to list MCP tools: %v", err) + } + if len(tools.Tools) != 1 || tools.Tools[0].Name != "whoami" { + t.Fatalf("Expected whoami tool, got %#v", tools.Tools) + } + + if observedRequest.ServerName != serverName { + t.Fatalf("Expected serverName %q, got %q", serverName, observedRequest.ServerName) + } + if observedRequest.ServerURL != baseURL+"/mcp" { + t.Fatalf("Expected serverUrl %q, got %q", baseURL+"/mcp", observedRequest.ServerURL) + } + if observedRequest.WwwAuthenticateParams == nil { + t.Fatal("Expected WWW-Authenticate params") + } + if observedRequest.Reason != "initial" { + t.Fatalf("Unexpected auth request reason: %q", observedRequest.Reason) + } + if observedRequest.WwwAuthenticateParams.ResourceMetadataURL == nil || + *observedRequest.WwwAuthenticateParams.ResourceMetadataURL != baseURL+"/.well-known/oauth-protected-resource" { + t.Fatalf("Unexpected resource metadata URL: %v", observedRequest.WwwAuthenticateParams.ResourceMetadataURL) + } + if stringValue(observedRequest.WwwAuthenticateParams.Scope) != "mcp.read" || stringValue(observedRequest.WwwAuthenticateParams.Error) != "invalid_token" { + t.Fatalf("Unexpected WWW-Authenticate params: %#v", observedRequest.WwwAuthenticateParams) + } + + var metadata map[string]any + if observedRequest.ResourceMetadata == nil { + t.Fatal("Expected resource metadata to be propagated") + } + if err := json.Unmarshal([]byte(*observedRequest.ResourceMetadata), &metadata); err != nil { + t.Fatalf("Failed to parse resource metadata: %v", err) + } + if metadata["resource"] != baseURL+"/mcp" { + t.Fatalf("Expected resource %q, got %#v", baseURL+"/mcp", metadata["resource"]) + } + + requests := fetchOAuthMCPRequests(t, baseURL) + if !hasAuthorization(requests, "") { + t.Fatal("Expected at least one unauthenticated MCP request") + } + if !hasAuthorization(requests, "Bearer "+expectedMCPOAuthToken) { + t.Fatal("Expected at least one MCP request with host-provided token") + } + }) + + t.Run("request replacement tokens across MCP OAuth lifecycle", func(t *testing.T) { + baseURL := startOAuthMCPServer(t) + serverName := "oauth-lifecycle-mcp" + var mu sync.Mutex + var observedReasons []copilot.MCPOauthRequestReason + refreshCount := 0 + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + EnableMCPApps: true, + OnMCPAuthRequest: func(request copilot.MCPAuthRequest, _ copilot.MCPAuthInvocation) (*copilot.MCPAuthResult, error) { + mu.Lock() + observedReasons = append(observedReasons, request.Reason) + refreshOrdinal := 0 + if request.Reason == copilot.MCPOauthRequestReasonRefresh { + refreshCount++ + refreshOrdinal = refreshCount + } + mu.Unlock() + + token := expectedMCPOAuthToken + switch request.Reason { + case copilot.MCPOauthRequestReasonRefresh: + if request.WwwAuthenticateParams == nil || + request.WwwAuthenticateParams.ResourceMetadataURL != nil || + stringValue(request.WwwAuthenticateParams.Error) != "invalid_token" { + t.Fatalf("Unexpected refresh WWW-Authenticate params: %#v", request.WwwAuthenticateParams) + } + if refreshOrdinal > 1 { + return copilot.MCPAuthResultCancelled(), nil + } + token = refreshMCPOAuthToken + case copilot.MCPOauthRequestReasonUpscope: + token = upscopeMCPOAuthToken + if request.WwwAuthenticateParams == nil || + request.WwwAuthenticateParams.ResourceMetadataURL == nil || + *request.WwwAuthenticateParams.ResourceMetadataURL != baseURL+"/.well-known/oauth-protected-resource" || + stringValue(request.WwwAuthenticateParams.Scope) != "mcp.write" || + stringValue(request.WwwAuthenticateParams.Error) != "insufficient_scope" { + t.Fatalf("Unexpected upscope WWW-Authenticate params: %#v", request.WwwAuthenticateParams) + } + case copilot.MCPOauthRequestReasonReauth: + token = reauthMCPOAuthToken + } + return copilot.MCPAuthResultToken(&copilot.MCPAuthToken{AccessToken: token}), nil + }, + MCPServers: map[string]copilot.MCPServerConfig{ + serverName: copilot.MCPHTTPServerConfig{ + URL: baseURL + "/mcp", + Tools: []string{"*"}, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + t.Cleanup(func() { session.Disconnect() }) + + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + callWhoami(t, session, serverName, "refresh") + callWhoami(t, session, serverName, "upscope") + callWhoami(t, session, serverName, "reauth") + + mu.Lock() + reasons := append([]copilot.MCPOauthRequestReason(nil), observedReasons...) + mu.Unlock() + expectedReasons := []copilot.MCPOauthRequestReason{ + copilot.MCPOauthRequestReasonInitial, + copilot.MCPOauthRequestReasonRefresh, + copilot.MCPOauthRequestReasonUpscope, + copilot.MCPOauthRequestReasonRefresh, + copilot.MCPOauthRequestReasonReauth, + } + if !slices.Equal(reasons, expectedReasons) { + t.Fatalf("Unexpected auth request reasons: %#v", reasons) + } + + requests := fetchOAuthMCPRequests(t, baseURL) + if !hasAuthorization(requests, "Bearer "+refreshMCPOAuthToken) { + t.Fatal("Expected at least one MCP request with refresh token") + } + if !hasAuthorization(requests, "Bearer "+upscopeMCPOAuthToken) { + t.Fatal("Expected at least one MCP request with upscope token") + } + if !hasAuthorization(requests, "Bearer "+reauthMCPOAuthToken) { + t.Fatal("Expected at least one MCP request with reauth token") + } + }) + + t.Run("cancel pending MCP OAuth request", func(t *testing.T) { + baseURL := startOAuthMCPServer(t) + serverName := "oauth-cancelled-mcp" + var mu sync.Mutex + var observedRequest copilot.MCPAuthRequest + var observed bool + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + OnMCPAuthRequest: func(request copilot.MCPAuthRequest, _ copilot.MCPAuthInvocation) (*copilot.MCPAuthResult, error) { + mu.Lock() + observedRequest = request + observed = true + mu.Unlock() + return copilot.MCPAuthResultCancelled(), nil + }, + MCPServers: map[string]copilot.MCPServerConfig{ + serverName: copilot.MCPHTTPServerConfig{ + URL: baseURL + "/mcp", + Tools: []string{"*"}, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + t.Cleanup(func() { session.Disconnect() }) + + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusNeedsAuth) + + // The MCP connection is kicked off by session.create, but the SDK only registers its + // `mcp.oauth_required` event interest once create returns. If the server's initial 401 + // wins that race, the runtime records `needs-auth` WITHOUT invoking the host callback, + // so `observedRequest` is briefly unset even after `needs-auth` is observed. A later + // auth retry (now that interest is registered) invokes the callback with the same + // `Initial` reason. Wait for the callback rather than sampling it the instant + // `needs-auth` first appears, which is what made this test flaky. + var request copilot.MCPAuthRequest + deadline := time.Now().Add(60 * time.Second) + for { + mu.Lock() + got := observed + request = observedRequest + mu.Unlock() + if got { + break + } + if time.Now().After(deadline) { + t.Fatalf("%s OAuth request did not reach the host callback", serverName) + } + time.Sleep(200 * time.Millisecond) + } + + if request.ServerName != serverName { + t.Fatalf("Expected serverName %q, got %q", serverName, request.ServerName) + } + if request.Reason != copilot.MCPOauthRequestReasonInitial { + t.Fatalf("Unexpected auth request reason: %q", request.Reason) + } + }) + + t.Run("resolve pending MCP OAuth request through RPC", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + ctx.ConfigureWithoutSnapshot(t) + client := ctx.NewClient() + defer client.ForceStop() + + baseURL := startOAuthMCPServer(t) + serverName := "oauth-direct-rpc-mcp" + requests := make(chan copilot.MCPAuthRequest, 1) + releaseHandler := make(chan struct{}) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + EnableMCPApps: true, + OnMCPAuthRequest: func(request copilot.MCPAuthRequest, _ copilot.MCPAuthInvocation) (*copilot.MCPAuthResult, error) { + requests <- request + <-releaseHandler + return copilot.MCPAuthResultCancelled(), nil + }, + MCPServers: map[string]copilot.MCPServerConfig{ + serverName: copilot.MCPHTTPServerConfig{ + URL: baseURL + "/mcp", + Tools: []string{"*"}, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + t.Cleanup(func() { session.Disconnect() }) + + connected := make(chan error, 1) + go func() { + connected <- waitForMCPServerStatusResult(t.Context(), session, serverName, rpc.MCPServerStatusConnected, 60*time.Second) + }() + + var request copilot.MCPAuthRequest + select { + case request = <-requests: + case <-time.After(30 * time.Second): + t.Fatal("Timed out waiting for MCP OAuth request") + } + + tokenType := "Bearer" + expiresIn := int64(3600) + result, err := session.RPC.MCP.Oauth().HandlePendingRequest(t.Context(), &rpc.MCPOauthHandlePendingRequest{ + RequestID: request.RequestID, + Result: rpc.MCPOauthPendingRequestResponseToken{ + AccessToken: expectedMCPOAuthToken, + TokenType: &tokenType, + ExpiresIn: &expiresIn, + }, + }) + if err != nil { + close(releaseHandler) + t.Fatalf("HandlePendingRequest failed: %v", err) + } + close(releaseHandler) + if !result.Success { + t.Fatal("Expected direct MCP OAuth pending request resolution to succeed") + } + + if err := <-connected; err != nil { + t.Fatal(err) + } + requestLog := fetchOAuthMCPRequests(t, baseURL) + if !hasAuthorization(requestLog, "Bearer "+expectedMCPOAuthToken) { + t.Fatal("Expected MCP request with token supplied through direct RPC") + } + }) +} + +type oauthMCPRequest struct { + Authorization *string `json:"authorization"` +} + +func startOAuthMCPServer(t *testing.T) string { + t.Helper() + + serverPath := testharness.RepoPath("test", "harness", "test-mcp-oauth-server.mjs") + cmd := exec.Command("node", serverPath) + cmd.Env = append(os.Environ(), "EXPECTED_TOKEN="+expectedMCPOAuthToken) + stdout, err := cmd.StdoutPipe() + if err != nil { + t.Fatalf("Failed to pipe OAuth MCP server stdout: %v", err) + } + var stderr syncBuffer + cmd.Stderr = &stderr + if err := cmd.Start(); err != nil { + t.Fatalf("Failed to start OAuth MCP server: %v", err) + } + t.Cleanup(func() { + if cmd.ProcessState != nil && cmd.ProcessState.Exited() { + return + } + _ = cmd.Process.Kill() + _, _ = cmd.Process.Wait() + }) + + lines := make(chan string, 1) + go func() { + scanner := bufio.NewScanner(stdout) + for scanner.Scan() { + lines <- scanner.Text() + return + } + close(lines) + }() + + select { + case line, ok := <-lines: + if !ok { + t.Fatalf("OAuth MCP server exited before listening: %s", stderr.String()) + } + const prefix = "Listening: " + if !strings.HasPrefix(line, prefix) { + t.Fatalf("Unexpected OAuth MCP server startup line %q. stderr=%s", line, stderr.String()) + } + return strings.TrimPrefix(line, prefix) + case <-time.After(10 * time.Second): + t.Fatalf("Timed out waiting for OAuth MCP server: %s", stderr.String()) + } + return "" +} + +func stringValue(value *string) string { + if value == nil { + return "" + } + return *value +} + +// syncBuffer is a minimal io.Writer whose contents can be read concurrently. +// os/exec writes to cmd.Stderr on a separate goroutine, so reading a plain +// strings.Builder while the process is running is a data race (caught by -race). +type syncBuffer struct { + mu sync.Mutex + buf strings.Builder +} + +func (b *syncBuffer) Write(p []byte) (int, error) { + b.mu.Lock() + defer b.mu.Unlock() + return b.buf.Write(p) +} + +func (b *syncBuffer) String() string { + b.mu.Lock() + defer b.mu.Unlock() + return b.buf.String() +} + +func fetchOAuthMCPRequests(t *testing.T, baseURL string) []oauthMCPRequest { + t.Helper() + + response, err := http.Get(baseURL + "/__requests") + if err != nil { + t.Fatalf("Failed to fetch OAuth MCP requests: %v", err) + } + defer response.Body.Close() + if response.StatusCode != http.StatusOK { + t.Fatalf("Failed to fetch OAuth MCP requests: %s", response.Status) + } + var requests []oauthMCPRequest + if err := json.NewDecoder(response.Body).Decode(&requests); err != nil { + t.Fatalf("Failed to decode OAuth MCP requests: %v", err) + } + return requests +} + +func hasAuthorization(requests []oauthMCPRequest, expected string) bool { + for _, request := range requests { + if request.Authorization == nil && expected == "" { + return true + } + if request.Authorization != nil && *request.Authorization == expected { + return true + } + } + return false +} + +func callWhoami(t *testing.T, session *copilot.Session, serverName string, scenario string) { + t.Helper() + + result, err := session.RPC.MCP.Apps().CallTool(t.Context(), &rpc.MCPAppsCallToolRequest{ + OriginServerName: serverName, + ServerName: serverName, + ToolName: "whoami", + Arguments: map[string]any{"scenario": scenario}, + }) + if err != nil { + t.Fatalf("Failed to call whoami for %s: %v", scenario, err) + } + content, ok := (*result)["content"].([]any) + if !ok || len(content) != 1 { + t.Fatalf("Unexpected whoami result: %#v", result) + } +} diff --git a/go/internal/e2e/mcp_server_helpers_test.go b/go/internal/e2e/mcp_server_helpers_test.go index f6cf2ad6b..68e72b18b 100644 --- a/go/internal/e2e/mcp_server_helpers_test.go +++ b/go/internal/e2e/mcp_server_helpers_test.go @@ -1,21 +1,21 @@ package e2e import ( + "context" + "fmt" "path/filepath" "testing" "time" copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" "github.com/github/copilot-sdk/go/rpc" ) func testMCPServers(t *testing.T, serverNames ...string) map[string]copilot.MCPServerConfig { t.Helper() - mcpServerPath, err := filepath.Abs("../../../test/harness/test-mcp-server.mjs") - if err != nil { - t.Fatalf("Failed to resolve test-mcp-server path: %v", err) - } + mcpServerPath := testharness.RepoPath("test", "harness", "test-mcp-server.mjs") mcpServerDir := filepath.Dir(mcpServerPath) mcpServers := make(map[string]copilot.MCPServerConfig, len(serverNames)) @@ -23,20 +23,26 @@ func testMCPServers(t *testing.T, serverNames ...string) map[string]copilot.MCPS mcpServers[serverName] = copilot.MCPStdioServerConfig{ Command: "node", Args: []string{mcpServerPath}, - Tools: &[]string{"*"}, + Tools: []string{"*"}, WorkingDirectory: mcpServerDir, } } return mcpServers } -func waitForMCPServerStatus(t *testing.T, session *copilot.Session, serverName string, expectedStatus rpc.McpServerStatus) { +func waitForMCPServerStatus(t *testing.T, session *copilot.Session, serverName string, expectedStatus rpc.MCPServerStatus) { t.Helper() + if err := waitForMCPServerStatusResult(t.Context(), session, serverName, expectedStatus, 60*time.Second); err != nil { + t.Fatal(err) + } +} + +func waitForMCPServerStatusResult(ctx context.Context, session *copilot.Session, serverName string, expectedStatus rpc.MCPServerStatus, timeout time.Duration) error { var lastStatus string - deadline := time.Now().Add(60 * time.Second) + deadline := time.Now().Add(timeout) for time.Now().Before(deadline) { - result, err := session.RPC.Mcp.List(t.Context()) + result, err := session.RPC.MCP.List(ctx) if err != nil { lastStatus = err.Error() } else { @@ -46,7 +52,7 @@ func waitForMCPServerStatus(t *testing.T, session *copilot.Session, serverName s continue } if server.Status == expectedStatus { - return + return nil } lastStatus = string(server.Status) break @@ -55,5 +61,5 @@ func waitForMCPServerStatus(t *testing.T, session *copilot.Session, serverName s time.Sleep(200 * time.Millisecond) } - t.Fatalf("%s did not reach %s; last status was %s", serverName, expectedStatus, lastStatus) + return fmt.Errorf("%s did not reach %s; last status was %s", serverName, expectedStatus, lastStatus) } diff --git a/go/internal/e2e/mode_handlers_e2e_test.go b/go/internal/e2e/mode_handlers_e2e_test.go index 15800bf85..e7471fbd0 100644 --- a/go/internal/e2e/mode_handlers_e2e_test.go +++ b/go/internal/e2e/mode_handlers_e2e_test.go @@ -101,7 +101,7 @@ func TestModeHandlersE2E(t *testing.T) { if request.Summary != planSummary { t.Fatalf("Expected summary %q, got %q", planSummary, request.Summary) } - if len(request.Actions) != 3 || request.Actions[0] != "interactive" || request.Actions[1] != "autopilot" || request.Actions[2] != "exit_only" { + if len(request.Actions) != 3 || request.Actions[0] != "autopilot" || request.Actions[1] != "interactive" || request.Actions[2] != "exit_only" { t.Fatalf("Unexpected actions: %#v", request.Actions) } if request.RecommendedAction != "interactive" { diff --git a/go/internal/e2e/multi_client_e2e_test.go b/go/internal/e2e/multi_client_e2e_test.go index a5c852bc8..742145536 100644 --- a/go/internal/e2e/multi_client_e2e_test.go +++ b/go/internal/e2e/multi_client_e2e_test.go @@ -18,7 +18,7 @@ func TestMultiClientE2E(t *testing.T) { // Use TCP mode so a second client can connect to the same CLI process ctx := testharness.NewTestContext(t) client1 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.TCPConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { client1.ForceStop() }) @@ -37,7 +37,7 @@ func TestMultiClientE2E(t *testing.T) { } client2 := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTcpToken}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTCPToken}, }) t.Cleanup(func() { client2.ForceStop() }) @@ -487,7 +487,7 @@ func TestMultiClientE2E(t *testing.T) { // Recreate client2 for cleanup (but don't rejoin the session) client2 = copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTcpToken}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort), ConnectionToken: sharedTCPToken}, }) // Now only stable_tool should be available diff --git a/go/internal/e2e/multi_provider_registry_e2e_test.go b/go/internal/e2e/multi_provider_registry_e2e_test.go new file mode 100644 index 000000000..7bec13414 --- /dev/null +++ b/go/internal/e2e/multi_provider_registry_e2e_test.go @@ -0,0 +1,195 @@ +package e2e + +import ( + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +// TestMultiProviderRegistryE2E exercises the experimental multi-provider BYOK +// registry (Providers / Models on the session config). It validates that +// several named providers, several models per provider, and custom agents +// bound to those provider-qualified models can coexist in one session, be +// launched, and route inference to the configured provider with the configured +// wire model and headers. +func TestMultiProviderRegistryE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + t.Run("should register multiple providers with custom agents bound to their models", func(t *testing.T) { + ctx.ConfigureForTest(t) + + // A heterogeneous registry: two providers of different types, with + // multiple models each. Provider-qualified selection ids are + // alpha/sonnet, alpha/haiku, beta/opus, beta/haiku. + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Providers: []copilot.NamedProviderConfig{ + { + Name: "alpha", + Type: "openai", + WireAPI: "completions", + BaseURL: "https://alpha.example.test/v1", + APIKey: "alpha-secret", + Headers: map[string]string{"X-Provider": "alpha"}, + }, + { + Name: "beta", + Type: "anthropic", + BaseURL: "https://beta.example.test", + BearerToken: "beta-bearer", + Headers: map[string]string{"X-Provider": "beta"}, + }, + }, + Models: []copilot.ProviderModelConfig{ + {ID: "sonnet", Provider: "alpha", WireModel: "byok-gpt-4o", MaxPromptTokens: 111111}, + {ID: "haiku", Provider: "alpha", WireModel: "byok-gpt-4o-mini"}, + {ID: "opus", Provider: "beta", WireModel: "byok-claude-3-opus"}, + {ID: "haiku", Provider: "beta", WireModel: "byok-claude-3-haiku"}, + }, + CustomAgents: []copilot.CustomAgentConfig{ + {Name: "orchestrator", DisplayName: "Orchestrator", Description: "Top-level planner.", Prompt: "Plan and delegate.", Model: "alpha/sonnet"}, + {Name: "researcher", DisplayName: "Researcher", Description: "Deep research subagent.", Prompt: "Research thoroughly.", Model: "beta/opus"}, + {Name: "fast-helper", DisplayName: "Fast Helper", Description: "Quick subagent.", Prompt: "Answer quickly.", Model: "alpha/haiku"}, + {Name: "summarizer", DisplayName: "Summarizer", Description: "Summarizing subagent.", Prompt: "Summarize.", Model: "beta/haiku"}, + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + + result, err := session.RPC.Agent.List(t.Context()) + if err != nil { + t.Fatalf("Agent.List failed: %v", err) + } + + // All four custom agents coexist in a single session. + if len(result.Agents) != 4 { + t.Fatalf("Expected 4 agents, got %d", len(result.Agents)) + } + + // Each agent is bound to its configured provider-qualified BYOK model. + boundModels := map[string]string{} + for _, agent := range result.Agents { + model := "" + if agent.Model != nil { + model = *agent.Model + } + boundModels[agent.Name] = model + } + expected := map[string]string{ + "orchestrator": "alpha/sonnet", + "researcher": "beta/opus", + "fast-helper": "alpha/haiku", + "summarizer": "beta/haiku", + } + for name, want := range expected { + if got := boundModels[name]; got != want { + t.Errorf("Expected agent %q bound to model %q, got %q", name, want, got) + } + } + + // Models from BOTH providers are represented, proving the two providers + // and their models coexist within the same session. + var hasAlpha, hasBeta bool + for _, model := range boundModels { + if strings.HasPrefix(model, "alpha/") { + hasAlpha = true + } + if strings.HasPrefix(model, "beta/") { + hasBeta = true + } + } + if !hasAlpha || !hasBeta { + t.Errorf("Expected both providers represented; hasAlpha=%v hasBeta=%v", hasAlpha, hasBeta) + } + }) + + assertRouting := func(t *testing.T, selectionID, expectedWireModel, expectedProviderHeader string) { + ctx.ConfigureForTest(t) + + // Two OpenAI-compatible providers, both pointed at the replay proxy so + // their /chat/completions traffic is captured. They are distinguished + // on the wire by their per-provider X-Provider header. "alpha" carries + // two models (multiple models per provider); "delta" carries one. + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: selectionID, + Providers: []copilot.NamedProviderConfig{ + { + Name: "alpha", + Type: "openai", + WireAPI: "completions", + BaseURL: ctx.ProxyURL, + APIKey: "alpha-secret", + Headers: map[string]string{"X-Provider": "alpha"}, + }, + { + Name: "delta", + Type: "openai", + WireAPI: "completions", + BaseURL: ctx.ProxyURL, + APIKey: "delta-secret", + Headers: map[string]string{"X-Provider": "delta"}, + }, + }, + Models: []copilot.ProviderModelConfig{ + {ID: "sonnet", Provider: "alpha", WireModel: "byok-gpt-4o"}, + {ID: "haiku", Provider: "alpha", WireModel: "byok-gpt-4o-mini"}, + {ID: "turbo", Provider: "delta", WireModel: "byok-gpt-4-turbo"}, + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + + if _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "What is 5+5?"}); err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + + exchanges, err := ctx.GetExchanges() + if err != nil { + t.Fatalf("GetExchanges failed: %v", err) + } + if len(exchanges) != 1 { + t.Fatalf("Expected exactly 1 exchange, got %d", len(exchanges)) + } + exchange := exchanges[0] + + // The wire model sent to the provider is the selected model's WireModel, + // not its provider-qualified selection id. + if exchange.Request.Model != expectedWireModel { + t.Errorf("Expected request model %q, got %q", expectedWireModel, exchange.Request.Model) + } + + // The request carried the owning provider's custom header, proving the + // turn was dispatched against the correct provider connection. + if !exchangeHasHeader(exchange, "X-Provider", expectedProviderHeader) { + t.Errorf("Expected X-Provider header %q to be present", expectedProviderHeader) + } + + // The provider's API key was applied as an Authorization header. + if !exchangeHasHeader(exchange, "Authorization", "Bearer") { + t.Error("Expected an Authorization header on the dispatched request") + } + } + + t.Run("should route alpha sonnet turn to its provider and wire model", func(t *testing.T) { + assertRouting(t, "alpha/sonnet", "byok-gpt-4o", "alpha") + }) + + t.Run("should route alpha haiku turn to its provider and wire model", func(t *testing.T) { + assertRouting(t, "alpha/haiku", "byok-gpt-4o-mini", "alpha") + }) + + t.Run("should route delta turbo turn to its provider and wire model", func(t *testing.T) { + assertRouting(t, "delta/turbo", "byok-gpt-4-turbo", "delta") + }) +} diff --git a/go/internal/e2e/pending_work_resume_e2e_test.go b/go/internal/e2e/pending_work_resume_e2e_test.go index 552886413..00419aec5 100644 --- a/go/internal/e2e/pending_work_resume_e2e_test.go +++ b/go/internal/e2e/pending_work_resume_e2e_test.go @@ -1,7 +1,6 @@ package e2e import ( - "context" "errors" "fmt" "strings" @@ -18,17 +17,17 @@ const pendingWorkTimeout = 60 * time.Second // Mirrors dotnet/test/PendingWorkResumeTests.cs (snapshot category "pending_work_resume"). // -// Each subtest spawns a TCP server client, connects a "suspended" client through CLIUrl, -// triggers some pending work (permission request or external tool call), then ForceStops -// the suspended client (preserving session state) and resumes from a fresh client with -// ContinuePendingWork=true. +// Most subtests spawn a TCP server client, connect a "suspended" client through URIConnection +// trigger pending work, then ForceStop the suspended client (preserving session state) +// and resume from a fresh client with ContinuePendingWork=true. Warm-join coverage keeps +// the original client connected while a second client resumes the same session. func TestPendingWorkResumeE2E(t *testing.T) { ctx := testharness.NewTestContext(t) t.Run("should continue pending permission request after resume", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) type ValueParams struct { Value string `json:"value" jsonschema:"Value to transform"` @@ -43,7 +42,7 @@ func TestPendingWorkResumeE2E(t *testing.T) { releasePermission := make(chan rpc.PermissionDecision, 1) suspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) session1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{ Tools: []copilot.Tool{originalTool}, @@ -97,23 +96,18 @@ func TestPendingWorkResumeE2E(t *testing.T) { // Snap the suspended client offline before the original handler resolves. suspendedClient.ForceStop() - var resumedToolInvoked bool - var mu sync.Mutex resumedTool := copilot.DefineTool("resume_permission_tool", "Transforms a value after permission is granted", func(params ValueParams, inv copilot.ToolInvocation) (string, error) { - mu.Lock() - resumedToolInvoked = true - mu.Unlock() return "PERMISSION_RESUMED_" + strings.ToUpper(params.Value), nil }) resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { resumedClient.ForceStop() }) session2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), OnPermissionRequest: func(_ copilot.PermissionRequest, _ copilot.PermissionInvocation) (rpc.PermissionDecision, error) { return &rpc.PermissionDecisionNoResult{}, nil }, @@ -134,24 +128,6 @@ func TestPendingWorkResumeE2E(t *testing.T) { t.Fatalf("Expected HandlePendingPermissionRequest to succeed, got %+v", permResult) } - ctxFinal, cancel := context.WithTimeout(t.Context(), pendingWorkTimeout) - defer cancel() - answer, err := testharness.GetFinalAssistantMessage(ctxFinal, session2) - if err != nil { - t.Fatalf("Failed to wait for final assistant message: %v", err) - } - - mu.Lock() - invoked := resumedToolInvoked - mu.Unlock() - if !invoked { - t.Error("Expected resumed tool implementation to be invoked") - } - - if assistant, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, "PERMISSION_RESUMED_ALPHA") { - t.Errorf("Expected response to contain 'PERMISSION_RESUMED_ALPHA', got %v", answer.Data) - } - // Allow original handler to unblock so cleanup proceeds. select { case releasePermission <- &rpc.PermissionDecisionUserNotAvailable{}: @@ -164,7 +140,7 @@ func TestPendingWorkResumeE2E(t *testing.T) { t.Run("should continue pending external tool request after resume", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) type ValueParams struct { Value string `json:"value" jsonschema:"Value to look up"` @@ -183,7 +159,7 @@ func TestPendingWorkResumeE2E(t *testing.T) { }) suspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) session1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{ Tools: []copilot.Tool{originalTool}, @@ -219,12 +195,12 @@ func TestPendingWorkResumeE2E(t *testing.T) { suspendedClient.ForceStop() resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { resumedClient.ForceStop() }) session2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { @@ -242,16 +218,6 @@ func TestPendingWorkResumeE2E(t *testing.T) { t.Errorf("Expected HandlePendingToolCall to succeed, got %+v", toolResult) } - ctxFinal, cancel := context.WithTimeout(t.Context(), pendingWorkTimeout) - defer cancel() - answer, err := testharness.GetFinalAssistantMessage(ctxFinal, session2) - if err != nil { - t.Fatalf("Failed to wait for final assistant message: %v", err) - } - if assistant, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, "EXTERNAL_RESUMED_BETA") { - t.Errorf("Expected response to contain 'EXTERNAL_RESUMED_BETA', got %v", answer.Data) - } - select { case releaseTool <- "ORIGINAL_SHOULD_NOT_WIN": default: @@ -263,7 +229,7 @@ func TestPendingWorkResumeE2E(t *testing.T) { t.Run("should continue parallel pending external tool requests after resume", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) type ValueParams struct { Value string `json:"value" jsonschema:"Value to look up"` @@ -291,7 +257,7 @@ func TestPendingWorkResumeE2E(t *testing.T) { }) suspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) session1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{ Tools: []copilot.Tool{originalA, originalB}, @@ -334,12 +300,12 @@ func TestPendingWorkResumeE2E(t *testing.T) { suspendedClient.ForceStop() resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { resumedClient.ForceStop() }) session2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { @@ -377,12 +343,12 @@ func TestPendingWorkResumeE2E(t *testing.T) { t.Run("should resume successfully when no pending work exists", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) var sessionID string func() { firstClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) defer firstClient.ForceStop() @@ -408,12 +374,12 @@ func TestPendingWorkResumeE2E(t *testing.T) { }() resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { resumedClient.ForceStop() }) resumedSession, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { @@ -433,131 +399,177 @@ func TestPendingWorkResumeE2E(t *testing.T) { resumedSession.Disconnect() }) - t.Run("should keep pending external tool handleable on warm resume when continuependingwork is false", func(t *testing.T) { - ctx.ConfigureForTest(t) - - _, cliURL := startTcpServer(t, ctx) - - type ValueParams struct { - Value string `json:"value" jsonschema:"Value to look up"` - } - toolStarted := make(chan string, 1) - releaseTool := make(chan string, 1) - - originalTool := copilot.DefineTool("resume_external_tool", "Looks up a value after resumption", - func(params ValueParams, inv copilot.ToolInvocation) (string, error) { - select { - case toolStarted <- params.Value: - default: - } - return <-releaseTool, nil + for _, scenario := range []struct { + name string + disconnectOriginalClient bool + expectedSessionWasActive bool + expectedHandleResult bool + }{ + {name: "warm", disconnectOriginalClient: false, expectedSessionWasActive: true, expectedHandleResult: true}, + {name: "cold", disconnectOriginalClient: true, expectedSessionWasActive: false, expectedHandleResult: false}, + } { + scenario := scenario + t.Run(fmt.Sprintf("should keep pending external tool handleable on %s resume when continuependingwork is false", scenario.name), func(t *testing.T) { + ctx.ConfigureForTest(t) + + _, cliURL := startTCPServer(t, ctx) + + type ValueParams struct { + Value string `json:"value" jsonschema:"Value to look up"` + } + toolStarted := make(chan string, 1) + releaseTool := make(chan string, 1) + + originalTool := copilot.DefineTool("resume_external_tool", "Looks up a value after resumption", + func(params ValueParams, inv copilot.ToolInvocation) (string, error) { + select { + case toolStarted <- params.Value: + default: + } + return <-releaseTool, nil + }) + + suspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) + if !scenario.disconnectOriginalClient { + defer suspendedClient.ForceStop() + } + session1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{ + Tools: []copilot.Tool{originalTool}, + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + sessionID := session1.SessionID - suspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} - }) - session1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{ - Tools: []copilot.Tool{originalTool}, - OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - }) - if err != nil { - t.Fatalf("Failed to create session: %v", err) - } - sessionID := session1.SessionID - - toolEventCh := waitForExternalToolRequests(session1, []string{"resume_external_tool"}) + toolEventCh := waitForExternalToolRequests(session1, []string{"resume_external_tool"}) - if _, err := session1.Send(t.Context(), copilot.MessageOptions{ - Prompt: "Use resume_external_tool with value 'beta', then reply with the result.", - }); err != nil { - t.Fatalf("Failed to send message: %v", err) - } + if _, err := session1.Send(t.Context(), copilot.MessageOptions{ + Prompt: "Use resume_external_tool with value 'beta', then reply with the result.", + }); err != nil { + t.Fatalf("Failed to send message: %v", err) + } - toolEvents, err := waitForExternalToolResults(toolEventCh, pendingWorkTimeout) - if err != nil { - t.Fatalf("waiting for external tool requests: %v", err) - } - toolEvent := toolEvents["resume_external_tool"] + toolEvents, err := waitForExternalToolResults(toolEventCh, pendingWorkTimeout) + if err != nil { + t.Fatalf("waiting for external tool requests: %v", err) + } + toolEvent := toolEvents["resume_external_tool"] - select { - case v := <-toolStarted: - if v != "beta" { - t.Errorf("Expected original tool started with 'beta', got %q", v) + select { + case v := <-toolStarted: + if v != "beta" { + t.Errorf("Expected original tool started with 'beta', got %q", v) + } + case <-time.After(pendingWorkTimeout): + t.Fatal("Timed out waiting for original tool to start") } - case <-time.After(pendingWorkTimeout): - t.Fatal("Timed out waiting for original tool to start") - } - suspendedClient.ForceStop() + if scenario.disconnectOriginalClient { + suspendedClient.ForceStop() + } - resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} - }) - t.Cleanup(func() { resumedClient.ForceStop() }) + resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} + }) + t.Cleanup(func() { resumedClient.ForceStop() }) + + // In warm mode the original client still owns the tool registration; + // re-registering it from the resumed client would cause a name-clash. In + // cold mode the original is gone, so we register a fresh throwing handler + // to assert the runtime doesn't re-invoke the tool on resume (orphan + // auto-completion happens internally). + resumeConfig := &copilot.ResumeSessionConfig{ + ContinuePendingWork: copilot.Bool(false), + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + } + if scenario.disconnectOriginalClient { + resumeConfig.Tools = []copilot.Tool{ + copilot.DefineTool("resume_external_tool", "Looks up a value after resumption", + func(_ ValueParams, _ copilot.ToolInvocation) (string, error) { + t.Errorf("Resumed-session handler should not be invoked") + return "", fmt.Errorf("resumed-session handler should not be invoked") + }), + } + } - session2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: false, - OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - }) - if err != nil { - t.Fatalf("Failed to resume session: %v", err) - } + session2, err := resumedClient.ResumeSession(t.Context(), sessionID, resumeConfig) + if err != nil { + t.Fatalf("Failed to resume session: %v", err) + } - // Verify resume event reflects ContinuePendingWork=false and SessionWasActive=true - messages, err := session2.GetEvents(t.Context()) - if err != nil { - t.Fatalf("GetEvents failed: %v", err) - } - var resumeEvent *copilot.SessionResumeData - for _, msg := range messages { - if msg.Type() == copilot.SessionEventTypeSessionResume { - if d, ok := msg.Data.(*copilot.SessionResumeData); ok { - resumeEvent = d - break + messages, err := session2.GetEvents(t.Context()) + if err != nil { + t.Fatalf("GetEvents failed: %v", err) + } + var resumeEvent *copilot.SessionResumeData + for _, msg := range messages { + if msg.Type() == copilot.SessionEventTypeSessionResume { + if d, ok := msg.Data.(*copilot.SessionResumeData); ok { + resumeEvent = d + break + } } } - } - if resumeEvent == nil { - t.Fatal("Expected a session.resume event") - return - } - if resumeEvent.ContinuePendingWork == nil || *resumeEvent.ContinuePendingWork != false { - t.Errorf("Expected ContinuePendingWork=false in resume event, got %v", resumeEvent.ContinuePendingWork) - } - if resumeEvent.SessionWasActive == nil || *resumeEvent.SessionWasActive != true { - t.Errorf("Expected SessionWasActive=true in resume event, got %v", resumeEvent.SessionWasActive) - } + if resumeEvent == nil { + t.Fatal("Expected a session.resume event") + return + } + if resumeEvent.ContinuePendingWork != nil && *resumeEvent.ContinuePendingWork { + t.Errorf("Expected ContinuePendingWork=false in resume event, got %v", resumeEvent.ContinuePendingWork) + } + if resumeEvent.SessionWasActive == nil || *resumeEvent.SessionWasActive != scenario.expectedSessionWasActive { + t.Errorf("Expected SessionWasActive=%t in resume event, got %v", scenario.expectedSessionWasActive, resumeEvent.SessionWasActive) + } - // Even with ContinuePendingWork=false, the pending tool call should still be - // handleable via HandlePendingToolCall. - toolResult, err := session2.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{ - RequestID: toolEvent.RequestID, - Result: rpc.ExternalToolStringResult("EXTERNAL_RESUMED_BETA"), - }) - if err != nil { - t.Fatalf("Failed to handle pending tool call: %v", err) - } - if !toolResult.Success { - t.Errorf("Expected HandlePendingToolCall to succeed, got %+v", toolResult) - } + // In warm mode the runtime still has the pending request; in cold mode the + // runtime auto-completed the orphan with a synthetic interrupt result during + // resume, so HandlePendingToolCall is expected to report Success=false. + toolResult, err := session2.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{ + RequestID: toolEvent.RequestID, + Result: rpc.ExternalToolStringResult("EXTERNAL_RESUMED_BETA"), + }) + if err != nil { + t.Fatalf("Failed to handle pending tool call: %v", err) + } + if toolResult.Success != scenario.expectedHandleResult { + t.Errorf("Expected HandlePendingToolCall Success=%t, got %+v", scenario.expectedHandleResult, toolResult) + } - select { - case releaseTool <- "ORIGINAL_SHOULD_NOT_WIN": - default: - } + if !scenario.expectedHandleResult { + // Cold path: orphan auto-completion does not trigger an LLM turn on its + // own, but the session should remain healthy for new work. + followUp, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Reply with exactly: COLD_RESUMED_FOLLOWUP", + }) + if err != nil { + t.Fatalf("Failed to send follow-up turn: %v", err) + } + if assistant, ok := followUp.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, "COLD_RESUMED_FOLLOWUP") { + t.Errorf("Expected follow-up answer to contain 'COLD_RESUMED_FOLLOWUP', got %v", followUp.Data) + } + } - session2.Disconnect() - }) + select { + case releaseTool <- "ORIGINAL_SHOULD_NOT_WIN": + default: + } + + session2.Disconnect() + }) + } t.Run("should report continuependingwork true in resume event", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) var sessionID string func() { firstClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) defer firstClient.ForceStop() @@ -583,12 +595,12 @@ func TestPendingWorkResumeE2E(t *testing.T) { }() resumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { resumedClient.ForceStop() }) resumedSession, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { @@ -646,18 +658,18 @@ func serverCliURL(t *testing.T, server *copilot.Client) string { return fmt.Sprintf("localhost:%d", port) } -// sharedTcpToken is the connection token used by startTcpServer and any sibling +// sharedTCPToken is the connection token used by startTCPServer and any sibling // client that connects via the resulting CLI URL. Tests use a fixed token rather // than the auto-generated one because the second client is constructed without // access to the first client's internal state. -const sharedTcpToken = "tcp-shared-test-token" +const sharedTCPToken = "tcp-shared-test-token" -// startTcpServer starts a TCP-mode server client and returns its CLI URL. +// startTCPServer starts a TCP-mode server client and returns its CLI URL. // It triggers an initial connection so RuntimePort is populated. -func startTcpServer(t *testing.T, ctx *testharness.TestContext) (*copilot.Client, string) { +func startTCPServer(t *testing.T, ctx *testharness.TestContext) (*copilot.Client, string) { t.Helper() server := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.TCPConnection{Path: opts.Connection.(copilot.StdioConnection).Path, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { server.ForceStop() }) // Trigger connection so we can read the port. CreateSession+Disconnect is the diff --git a/go/internal/e2e/per_session_auth_e2e_test.go b/go/internal/e2e/per_session_auth_e2e_test.go index eed11bcfa..e004fa6b5 100644 --- a/go/internal/e2e/per_session_auth_e2e_test.go +++ b/go/internal/e2e/per_session_auth_e2e_test.go @@ -47,7 +47,7 @@ func TestPerSessionAuthE2E(t *testing.T) { t.Fatalf("Failed to create session: %v", err) } - authStatus, err := session.RPC.Auth.GetStatus(t.Context()) + authStatus, err := session.RPC.GitHubAuth.GetStatus(t.Context()) if err != nil { t.Fatalf("Failed to get auth status: %v", err) } @@ -79,12 +79,12 @@ func TestPerSessionAuthE2E(t *testing.T) { t.Fatalf("Failed to create session B: %v", err) } - statusA, err := sessionA.RPC.Auth.GetStatus(t.Context()) + statusA, err := sessionA.RPC.GitHubAuth.GetStatus(t.Context()) if err != nil { t.Fatalf("Failed to get auth status for session A: %v", err) } - statusB, err := sessionB.RPC.Auth.GetStatus(t.Context()) + statusB, err := sessionB.RPC.GitHubAuth.GetStatus(t.Context()) if err != nil { t.Fatalf("Failed to get auth status for session B: %v", err) } @@ -115,7 +115,7 @@ func TestPerSessionAuthE2E(t *testing.T) { t.Fatalf("Failed to create session: %v", err) } - authStatus, err := session.RPC.Auth.GetStatus(t.Context()) + authStatus, err := session.RPC.GitHubAuth.GetStatus(t.Context()) if err != nil { t.Fatalf("Failed to get auth status: %v", err) } diff --git a/go/internal/e2e/permissions_e2e_test.go b/go/internal/e2e/permissions_e2e_test.go index 9d3b11da8..89681470e 100644 --- a/go/internal/e2e/permissions_e2e_test.go +++ b/go/internal/e2e/permissions_e2e_test.go @@ -96,7 +96,7 @@ func TestPermissionsE2E(t *testing.T) { } _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ - Prompt: "Run 'echo hello' and tell me the output", + Prompt: "Run 'echo test' and tell me what happens", }) if err != nil { t.Fatalf("Failed to send message: %v", err) @@ -843,7 +843,7 @@ func TestPermissionsE2E(t *testing.T) { IncludeTempDirectory: &includeTemp, Unrestricted: &unrestricted, }, - Urls: &rpc.PermissionUrlsConfig{ + URLs: &rpc.PermissionURLsConfig{ InitialAllowed: []string{"https://example.invalid/permissions-configure"}, Unrestricted: &unrestricted, }, @@ -971,18 +971,18 @@ func TestPermissionsE2E(t *testing.T) { t.Fatalf("Expected ModifyRules(remove) Success=true") } - enableUrls, err := session.RPC.Permissions.Urls().SetUnrestrictedMode(t.Context(), &rpc.PermissionUrlsSetUnrestrictedModeParams{Enabled: true}) + enableURLs, err := session.RPC.Permissions.URLs().SetUnrestrictedMode(t.Context(), &rpc.PermissionURLsSetUnrestrictedModeParams{Enabled: true}) if err != nil { - t.Fatalf("Permissions.Urls.SetUnrestrictedMode(true) failed: %v", err) + t.Fatalf("Permissions.URLs.SetUnrestrictedMode(true) failed: %v", err) } - if !enableUrls.Success { + if !enableURLs.Success { t.Fatalf("Expected SetUnrestrictedMode(true) Success=true") } - disableUrls, err := session.RPC.Permissions.Urls().SetUnrestrictedMode(t.Context(), &rpc.PermissionUrlsSetUnrestrictedModeParams{Enabled: false}) + disableURLs, err := session.RPC.Permissions.URLs().SetUnrestrictedMode(t.Context(), &rpc.PermissionURLsSetUnrestrictedModeParams{Enabled: false}) if err != nil { - t.Fatalf("Permissions.Urls.SetUnrestrictedMode(false) failed: %v", err) + t.Fatalf("Permissions.URLs.SetUnrestrictedMode(false) failed: %v", err) } - if !disableUrls.Success { + if !disableURLs.Success { t.Fatalf("Expected SetUnrestrictedMode(false) Success=true") } }) diff --git a/go/internal/e2e/pre_mcp_tool_call_hook_e2e_test.go b/go/internal/e2e/pre_mcp_tool_call_hook_e2e_test.go index 2253f3825..111cfb86a 100644 --- a/go/internal/e2e/pre_mcp_tool_call_hook_e2e_test.go +++ b/go/internal/e2e/pre_mcp_tool_call_hook_e2e_test.go @@ -10,22 +10,21 @@ import ( "github.com/github/copilot-sdk/go/internal/e2e/testharness" ) -func TestPreMcpToolCallHookE2E(t *testing.T) { +func TestPreMCPToolCallHookE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) - testHarnessDir, _ := filepath.Abs("../../../test/harness") + testHarnessDir := testharness.RepoPath("test", "harness") metaEchoServer := filepath.Join(testHarnessDir, "test-mcp-meta-echo-server.mjs") metaEchoConfig := func() map[string]copilot.MCPServerConfig { - tools := []string{"*"} return map[string]copilot.MCPServerConfig{ "meta-echo": copilot.MCPStdioServerConfig{ Command: "node", Args: []string{metaEchoServer}, WorkingDirectory: testHarnessDir, - Tools: &tools, + Tools: []string{"*"}, }, } } @@ -35,18 +34,18 @@ func TestPreMcpToolCallHookE2E(t *testing.T) { var ( mu sync.Mutex - inputs []copilot.PreMcpToolCallHookInput + inputs []copilot.PreMCPToolCallHookInput ) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, MCPServers: metaEchoConfig(), Hooks: &copilot.SessionHooks{ - OnPreMcpToolCall: func(input copilot.PreMcpToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMcpToolCallHookOutput, error) { + OnPreMCPToolCall: func(input copilot.PreMCPToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMCPToolCallHookOutput, error) { mu.Lock() inputs = append(inputs, input) mu.Unlock() - return &copilot.PreMcpToolCallHookOutput{ + return &copilot.PreMCPToolCallHookOutput{ MetaToUse: map[string]any{ "injected": "by-hook", "source": "test", @@ -98,18 +97,18 @@ func TestPreMcpToolCallHookE2E(t *testing.T) { var ( mu sync.Mutex - inputs []copilot.PreMcpToolCallHookInput + inputs []copilot.PreMCPToolCallHookInput ) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, MCPServers: metaEchoConfig(), Hooks: &copilot.SessionHooks{ - OnPreMcpToolCall: func(input copilot.PreMcpToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMcpToolCallHookOutput, error) { + OnPreMCPToolCall: func(input copilot.PreMCPToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMCPToolCallHookOutput, error) { mu.Lock() inputs = append(inputs, input) mu.Unlock() - return &copilot.PreMcpToolCallHookOutput{ + return &copilot.PreMCPToolCallHookOutput{ MetaToUse: map[string]any{ "completely": "replaced", }, @@ -154,18 +153,18 @@ func TestPreMcpToolCallHookE2E(t *testing.T) { var ( mu sync.Mutex - inputs []copilot.PreMcpToolCallHookInput + inputs []copilot.PreMCPToolCallHookInput ) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, MCPServers: metaEchoConfig(), Hooks: &copilot.SessionHooks{ - OnPreMcpToolCall: func(input copilot.PreMcpToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMcpToolCallHookOutput, error) { + OnPreMCPToolCall: func(input copilot.PreMCPToolCallHookInput, invocation copilot.HookInvocation) (*copilot.PreMCPToolCallHookOutput, error) { mu.Lock() inputs = append(inputs, input) mu.Unlock() - return &copilot.PreMcpToolCallHookOutput{ + return &copilot.PreMCPToolCallHookOutput{ MetaToUse: nil, }, nil }, diff --git a/go/internal/e2e/provider_endpoint_e2e_test.go b/go/internal/e2e/provider_endpoint_e2e_test.go new file mode 100644 index 000000000..aad02ca2b --- /dev/null +++ b/go/internal/e2e/provider_endpoint_e2e_test.go @@ -0,0 +1,147 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package e2e + +import ( + "regexp" + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +// session.provider.getEndpoint is gated behind COPILOT_ALLOW_GET_PROVIDER_ENDPOINT; +// the harness env passed to the CLI subprocess opts in for this test file. +func TestProviderEndpointE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + + client := ctx.NewClient(func(opts *copilot.ClientOptions) { + opts.Env = append(opts.Env, "COPILOT_ALLOW_GET_PROVIDER_ENDPOINT=true") + }) + t.Cleanup(func() { client.ForceStop() }) + + t.Run("returns the BYOK provider endpoint when a custom provider is configured", func(t *testing.T) { + ctx.ConfigureForTest(t) + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Provider: &copilot.ProviderConfig{ + Type: "openai", + WireAPI: "completions", + BaseURL: "https://api.example.test/v1", + APIKey: "byok-secret", + Headers: map[string]string{"X-Custom-Header": "byok-yes"}, + }, + }) + if err != nil { + t.Fatalf("create session: %v", err) + } + // disconnect may fail since the BYOK provider URL is fake. + defer func() { _ = session.Disconnect() }() + + endpoint, err := session.RPC.Provider.GetEndpoint(t.Context()) + if err != nil { + t.Fatalf("getEndpoint: %v", err) + } + + if endpoint.Type != rpc.ProviderEndpointTypeOpenai { + t.Errorf("Type: want %q, got %q", rpc.ProviderEndpointTypeOpenai, endpoint.Type) + } + if endpoint.WireAPI == nil || *endpoint.WireAPI != rpc.ProviderEndpointWireAPICompletions { + t.Errorf("WireAPI: want %q, got %v", rpc.ProviderEndpointWireAPICompletions, endpoint.WireAPI) + } + if endpoint.BaseURL != "https://api.example.test/v1" { + t.Errorf("BaseURL: got %q", endpoint.BaseURL) + } + if endpoint.APIKey == nil || *endpoint.APIKey != "byok-secret" { + t.Errorf("APIKey: got %v", endpoint.APIKey) + } + if got := endpoint.Headers["X-Custom-Header"]; got != "byok-yes" { + t.Errorf("X-Custom-Header: got %q", got) + } + // BYOK sessions never issue a CAPI session token. + if endpoint.SessionToken != nil { + t.Errorf("SessionToken: expected nil, got %+v", endpoint.SessionToken) + } + }) + + t.Run("returns the CAPI provider endpoint for an OAuth-authenticated session", func(t *testing.T) { + ctx.ConfigureForTest(t) + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("create session: %v", err) + } + defer func() { + if err := session.Disconnect(); err != nil { + t.Errorf("disconnect: %v", err) + } + }() + + endpoint, err := session.RPC.Provider.GetEndpoint(t.Context()) + if err != nil { + t.Fatalf("getEndpoint: %v", err) + } + + switch endpoint.Type { + case rpc.ProviderEndpointTypeOpenai, rpc.ProviderEndpointTypeAzure, rpc.ProviderEndpointTypeAnthropic: + default: + t.Errorf("unexpected Type %q", endpoint.Type) + } + // wireApi is omitted for anthropic; otherwise one of the OpenAI shapes. + if endpoint.Type != rpc.ProviderEndpointTypeAnthropic { + if endpoint.WireAPI == nil || + (*endpoint.WireAPI != rpc.ProviderEndpointWireAPICompletions && + *endpoint.WireAPI != rpc.ProviderEndpointWireAPIResponses) { + t.Errorf("unexpected WireAPI %v for type %q", endpoint.WireAPI, endpoint.Type) + } + } + + // CAPI baseUrl is the (proxy) Copilot API URL injected by the harness. + if !strings.HasPrefix(endpoint.BaseURL, "http://") && !strings.HasPrefix(endpoint.BaseURL, "https://") { + t.Errorf("BaseURL not an http(s) URL: %q", endpoint.BaseURL) + } + + // For CAPI OAuth sessions the apiKey is the resolved GitHub bearer. + if endpoint.APIKey == nil || len(*endpoint.APIKey) == 0 { + t.Fatalf("APIKey should be a non-empty string, got %v", endpoint.APIKey) + } + + // Standard CAPI headers must be present, and Authorization is surfaced + // as the runtime sends it (`Bearer `). + if endpoint.Headers["Copilot-Integration-Id"] == "" { + t.Errorf("Copilot-Integration-Id header missing") + } + if ua := endpoint.Headers["User-Agent"]; !regexp.MustCompile(`(?i)Copilot`).MatchString(ua) { + t.Errorf("User-Agent should mention Copilot, got %q", ua) + } + if endpoint.Headers["X-GitHub-Api-Version"] == "" { + t.Errorf("X-GitHub-Api-Version header missing") + } + if !regexp.MustCompile(`[0-9a-f-]{8,}`).MatchString(endpoint.Headers["X-Interaction-Id"]) { + t.Errorf("X-Interaction-Id should match interaction-id format, got %q", endpoint.Headers["X-Interaction-Id"]) + } + if want, got := "Bearer "+*endpoint.APIKey, endpoint.Headers["Authorization"]; want != got { + t.Errorf("Authorization: want %q, got %q", want, got) + } + + // When the omit-modelId path returned an auto-mode session token, it + // must use the documented header name. The harness may have a non-auto + // model selected, in which case the field is simply omitted. + if endpoint.SessionToken != nil { + if endpoint.SessionToken.Header != "Copilot-Session-Token" { + t.Errorf("SessionToken.Header: got %q", endpoint.SessionToken.Header) + } + if endpoint.SessionToken.Token == "" { + t.Errorf("SessionToken.Token should be non-empty") + } + if endpoint.SessionToken.ExpiresAt != nil && endpoint.SessionToken.ExpiresAt.IsZero() { + t.Errorf("SessionToken.ExpiresAt should be a valid time when present") + } + } + }) +} diff --git a/go/internal/e2e/resume_mcp_oauth_e2e_test.go b/go/internal/e2e/resume_mcp_oauth_e2e_test.go new file mode 100644 index 000000000..db61f483a --- /dev/null +++ b/go/internal/e2e/resume_mcp_oauth_e2e_test.go @@ -0,0 +1,60 @@ +package e2e + +import ( + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +func TestResumeMCPOAuthE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should resume a persisted session with mcp auth handler", func(t *testing.T) { + ctx.ConfigureForTest(t) + + mcpAuthHandler := func(copilot.MCPAuthRequest, copilot.MCPAuthInvocation) (*copilot.MCPAuthResult, error) { + return copilot.MCPAuthResultCancelled(), nil + } + + session1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + OnMCPAuthRequest: mcpAuthHandler, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + sessionID := session1.SessionID + + _, err = session1.Send(t.Context(), copilot.MessageOptions{Prompt: "What is 1+1?"}) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + + answer, err := testharness.GetFinalAssistantMessage(t.Context(), session1) + if err != nil { + t.Fatalf("Failed to get assistant message: %v", err) + } + if ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, "2") { + t.Errorf("Expected answer to contain '2', got %v", answer.Data) + } + + newClient := ctx.NewClient() + t.Cleanup(func() { newClient.ForceStop() }) + + session2, err := newClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + OnMCPAuthRequest: mcpAuthHandler, + }) + if err != nil { + t.Fatalf("Failed to resume session: %v", err) + } + + if session2.SessionID != sessionID { + t.Errorf("Expected resumed session ID to match, got %q vs %q", session2.SessionID, sessionID) + } + }) +} diff --git a/go/internal/e2e/rewind_e2e_test.go b/go/internal/e2e/rewind_e2e_test.go new file mode 100644 index 000000000..b15e546eb --- /dev/null +++ b/go/internal/e2e/rewind_e2e_test.go @@ -0,0 +1,152 @@ +package e2e + +import ( + "os" + "path/filepath" + "runtime" + "strings" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +const ( + rewindFileName = "rewind-sdk.txt" + rewindFileContent = "SDK rewind content" +) + +func TestRewindE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should restore tracked file and conversation", func(t *testing.T) { + ctx.ConfigureForTest(t) + filePath := filepath.Join(ctx.WorkDir, rewindFileName) + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + Model: "claude-sonnet-4.5", + EnableFileChangeTracking: copilot.Bool(true), + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Use the create tool to create " + rewindFileName + " containing exactly " + + rewindFileContent + ". After the tool succeeds, reply with exactly SDK_REWIND_DONE.", + }) + if err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + responseData, ok := response.Data.(*copilot.AssistantMessageData) + if !ok || responseData.Content != "SDK_REWIND_DONE" { + t.Fatalf("Expected SDK_REWIND_DONE response, got %+v", response) + } + content, err := os.ReadFile(filePath) + if err != nil { + t.Fatalf("Failed to read created file: %v", err) + } + if string(content) != rewindFileContent { + t.Fatalf("Expected file content %q, got %q", rewindFileContent, content) + } + + rewindPoints := waitForRewindPoints(t, session) + if !rewindPoints.FileChangeTrackingEnabled { + t.Fatal("Expected file change tracking to be enabled") + } + if len(rewindPoints.Points) != 1 { + t.Fatalf("Expected one rewind point, got %+v", rewindPoints.Points) + } + rewindPoint := rewindPoints.Points[0] + if !rewindPoint.CanRestoreFiles || rewindPoint.FileCount != 1 { + t.Fatalf("Expected one restorable file, got %+v", rewindPoint) + } + + preview, err := session.RPC.History.PreviewRewind(t.Context(), &rpc.HistoryPreviewRewindRequest{ + EventID: rewindPoint.EventID, + }) + if err != nil { + t.Fatalf("PreviewRewind failed: %v", err) + } + if !preview.Available || len(preview.Files) != 1 { + t.Fatalf("Expected one available preview file, got %+v", preview) + } + assertSameRewindPath(t, filePath, preview.Files[0].Path) + + rewind, err := session.RPC.History.Rewind(t.Context(), &rpc.HistoryRewindRequest{ + EventID: rewindPoint.EventID, + Mode: rpc.HistoryRewindModeConversationAndFiles, + }) + if err != nil { + t.Fatalf("Rewind failed: %v", err) + } + if rewind.Outcome != rpc.HistoryRewindOutcomeSuccess { + t.Fatalf("Expected successful rewind, got %+v", rewind) + } + if rewind.EventsRemoved == nil || *rewind.EventsRemoved < 1 { + t.Fatalf("Expected rewind to remove events, got %+v", rewind) + } + if len(rewind.RestoredFiles) != 1 { + t.Fatalf("Expected one restored file, got %+v", rewind.RestoredFiles) + } + assertSameRewindPath(t, filePath, rewind.RestoredFiles[0]) + if _, err := os.Stat(filePath); !os.IsNotExist(err) { + t.Fatalf("Expected rewound file to be removed, stat error: %v", err) + } + + events, err := session.GetEvents(t.Context()) + if err != nil { + t.Fatalf("GetEvents failed: %v", err) + } + for _, event := range events { + if event.ID == rewindPoint.EventID { + t.Fatalf("Expected rewound event %q to be removed", rewindPoint.EventID) + } + } + }) +} + +func waitForRewindPoints(t *testing.T, session *copilot.Session) *rpc.HistoryListRewindPointsResult { + t.Helper() + deadline := time.Now().Add(10 * time.Second) + for { + result, err := session.RPC.History.ListRewindPoints(t.Context()) + if err != nil { + t.Fatalf("ListRewindPoints failed: %v", err) + } + if result.UnavailableReason == nil { + return result + } + if time.Now().After(deadline) { + t.Fatalf("Timed out waiting for rewind points: %s", *result.UnavailableReason) + } + time.Sleep(100 * time.Millisecond) + } +} + +func assertSameRewindPath(t *testing.T, expected, actual string) { + t.Helper() + expectedPath, err := filepath.Abs(expected) + if err != nil { + t.Fatalf("Failed to resolve expected path: %v", err) + } + actualPath, err := filepath.Abs(actual) + if err != nil { + t.Fatalf("Failed to resolve actual path: %v", err) + } + + expectedPath = filepath.Clean(expectedPath) + actualPath = filepath.Clean(actualPath) + if runtime.GOOS == "windows" { + if !strings.EqualFold(expectedPath, actualPath) { + t.Fatalf("Expected path %q, got %q", expectedPath, actualPath) + } + } else if expectedPath != actualPath { + t.Fatalf("Expected path %q, got %q", expectedPath, actualPath) + } +} diff --git a/go/internal/e2e/rpc_e2e_test.go b/go/internal/e2e/rpc_e2e_test.go index ccbf26d1d..fcf843814 100644 --- a/go/internal/e2e/rpc_e2e_test.go +++ b/go/internal/e2e/rpc_e2e_test.go @@ -9,7 +9,7 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) -func TestRpcE2E(t *testing.T) { +func TestRPCE2E(t *testing.T) { cliPath := testharness.CLIPath() if cliPath == "" { t.Fatal("CLI not found. Run 'npm install' in the nodejs directory first.") @@ -113,7 +113,7 @@ func TestRpcE2E(t *testing.T) { }) } -func TestSessionRpcE2E(t *testing.T) { +func TestSessionRPCE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/rpc_event_log_e2e_test.go b/go/internal/e2e/rpc_event_log_e2e_test.go index 63614b4e2..4e491026c 100644 --- a/go/internal/e2e/rpc_event_log_e2e_test.go +++ b/go/internal/e2e/rpc_event_log_e2e_test.go @@ -12,7 +12,7 @@ import ( const rpcEventLogTimeout = 30 * time.Second // Mirrors dotnet/test/E2E/RpcEventLogE2ETests.cs (snapshot category "rpc_event_log"). -func TestRpcEventLogE2E(t *testing.T) { +func TestRPCEventLogE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -29,7 +29,7 @@ func TestRpcEventLogE2E(t *testing.T) { waitForRPCCondition(t, rpcEventLogTimeout, "persisted session.plan_changed event", func() (bool, error) { var err error read, err = session.RPC.EventLog.Read(t.Context(), &rpc.EventLogReadRequest{ - Max: rpcPtr(int32(100)), + Max: rpcPtr(int64(100)), WaitMs: rpcPtr(int32(0)), }) if err != nil { @@ -67,7 +67,7 @@ func TestRpcEventLogE2E(t *testing.T) { } read, err = session.RPC.EventLog.Read(t.Context(), &rpc.EventLogReadRequest{ Cursor: &tail.Cursor, - Max: rpcPtr(int32(10)), + Max: rpcPtr(int64(10)), WaitMs: rpcPtr(int32(0)), }) return err == nil && read.CursorStatus == rpc.EventsCursorStatusOk && len(read.Events) == 0, err @@ -131,7 +131,7 @@ func TestRpcEventLogE2E(t *testing.T) { go func() { result, err := session.RPC.EventLog.Read(t.Context(), &rpc.EventLogReadRequest{ Cursor: &tail.Cursor, - Max: rpcPtr(int32(10)), + Max: rpcPtr(int64(10)), WaitMs: rpcPtr(int32(5000)), Types: &rpc.EventLogTypes{StringArray: []string{string(copilot.SessionEventTypeSessionTitleChanged)}}, }) diff --git a/go/internal/e2e/rpc_event_side_effects_e2e_test.go b/go/internal/e2e/rpc_event_side_effects_e2e_test.go index 765a570a2..ef66ec83e 100644 --- a/go/internal/e2e/rpc_event_side_effects_e2e_test.go +++ b/go/internal/e2e/rpc_event_side_effects_e2e_test.go @@ -14,7 +14,7 @@ import ( const rpcEventSideEffectsTimeout = 30 * time.Second // Mirrors dotnet/test/RpcEventSideEffectsE2ETests.cs (snapshot category "rpc_event_side_effects"). -func TestRpcEventSideEffectsE2E(t *testing.T) { +func TestRPCEventSideEffectsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/rpc_mcp_and_skills_e2e_test.go b/go/internal/e2e/rpc_mcp_and_skills_e2e_test.go index 9f358644b..22f53c48a 100644 --- a/go/internal/e2e/rpc_mcp_and_skills_e2e_test.go +++ b/go/internal/e2e/rpc_mcp_and_skills_e2e_test.go @@ -14,7 +14,7 @@ import ( // Mirrors dotnet/test/RpcMcpAndSkillsTests.cs (snapshot category "rpc_mcp_and_skills"). // Tests session-scoped MCP, skills, plugins, and extensions RPCs. -func TestRpcMcpAndSkillsE2E(t *testing.T) { +func TestRPCMCPAndSkillsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) // --yolo auto-approves extension permission gates at the CLI level, // preventing breakage from new gates (e.g., extension-permission-access). @@ -27,7 +27,7 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Run("should list and toggle session skills", func(t *testing.T) { skillName := fmt.Sprintf("session-rpc-skill-%s", randomHex(t)) - skillsDir := createMcpSkillsRpcDirectory(t, ctx.WorkDir, "session-rpc-skills", skillName, "Session skill controlled by RPC.") + skillsDir := createMCPSkillsRPCDirectory(t, ctx.WorkDir, "session-rpc-skills", skillName, "Session skill controlled by RPC.") session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -65,7 +65,7 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Run("should ensure skills are loaded and list invoked skills", func(t *testing.T) { skillName := fmt.Sprintf("ensure-rpc-skill-%s", randomHex(t)) - skillsDir := createMcpSkillsRpcDirectory(t, ctx.WorkDir, "session-rpc-skills", skillName, "Skill loaded explicitly by RPC.") + skillsDir := createMCPSkillsRPCDirectory(t, ctx.WorkDir, "session-rpc-skills", skillName, "Skill loaded explicitly by RPC.") session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -150,10 +150,10 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) - result, err := session.RPC.Mcp.List(t.Context()) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + result, err := session.RPC.MCP.List(t.Context()) if err != nil { - t.Fatalf("Mcp.List failed: %v", err) + t.Fatalf("MCP.List failed: %v", err) } var found bool for _, server := range result.Servers { @@ -180,36 +180,36 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) - direct, err := session.RPC.Mcp.SetEnvValueMode(t.Context(), &rpc.McpSetEnvValueModeParams{Mode: rpc.McpSetEnvValueModeDetailsDirect}) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + direct, err := session.RPC.MCP.SetEnvValueMode(t.Context(), &rpc.MCPSetEnvValueModeParams{Mode: rpc.MCPSetEnvValueModeDetailsDirect}) if err != nil { - t.Fatalf("Mcp.SetEnvValueMode(direct) failed: %v", err) + t.Fatalf("MCP.SetEnvValueMode(direct) failed: %v", err) } - if direct.Mode != rpc.McpSetEnvValueModeDetailsDirect { + if direct.Mode != rpc.MCPSetEnvValueModeDetailsDirect { t.Fatalf("Expected direct env value mode, got %+v", direct) } - indirect, err := session.RPC.Mcp.SetEnvValueMode(t.Context(), &rpc.McpSetEnvValueModeParams{Mode: rpc.McpSetEnvValueModeDetailsIndirect}) + indirect, err := session.RPC.MCP.SetEnvValueMode(t.Context(), &rpc.MCPSetEnvValueModeParams{Mode: rpc.MCPSetEnvValueModeDetailsIndirect}) if err != nil { - t.Fatalf("Mcp.SetEnvValueMode(indirect) failed: %v", err) + t.Fatalf("MCP.SetEnvValueMode(indirect) failed: %v", err) } - if indirect.Mode != rpc.McpSetEnvValueModeDetailsIndirect { + if indirect.Mode != rpc.MCPSetEnvValueModeDetailsIndirect { t.Fatalf("Expected indirect env value mode, got %+v", indirect) } - removeGitHub, err := session.RPC.Mcp.RemoveGitHub(t.Context()) + removeGitHub, err := session.RPC.MCP.RemoveGitHub(t.Context()) if err != nil { - t.Fatalf("Mcp.RemoveGitHub failed: %v", err) + t.Fatalf("MCP.RemoveGitHub failed: %v", err) } if removeGitHub.Removed { t.Fatalf("Expected RemoveGitHub=false for explicitly configured server, got %+v", removeGitHub) } - servers, err := session.RPC.Mcp.List(t.Context()) + servers, err := session.RPC.MCP.List(t.Context()) if err != nil { - t.Fatalf("Mcp.List failed: %v", err) + t.Fatalf("MCP.List failed: %v", err) } var stillConnected bool for _, server := range servers.Servers { - if server.Name == serverName && server.Status == rpc.McpServerStatusConnected { + if server.Name == serverName && server.Status == rpc.MCPServerStatusConnected { stillConnected = true break } @@ -228,27 +228,27 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { if err != nil { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) - cancelMissing, err := session.RPC.Mcp.CancelSamplingExecution(t.Context(), &rpc.McpCancelSamplingExecutionParams{RequestID: "missing-" + randomHex(t)}) + cancelMissing, err := session.RPC.MCP.CancelSamplingExecution(t.Context(), &rpc.MCPCancelSamplingExecutionParams{RequestID: "missing-" + randomHex(t)}) if err != nil { - t.Fatalf("Mcp.CancelSamplingExecution failed: %v", err) + t.Fatalf("MCP.CancelSamplingExecution failed: %v", err) } if cancelMissing.Cancelled { t.Fatal("Expected cancelling missing sampling execution to report Cancelled=false") } - result, err := session.RPC.Mcp.ExecuteSampling(t.Context(), &rpc.McpExecuteSamplingParams{ + result, err := session.RPC.MCP.ExecuteSampling(t.Context(), &rpc.MCPExecuteSamplingParams{ RequestID: "sampling-" + randomHex(t), ServerName: "missing-sampling-server", - McpRequestID: "mcp-request-" + randomHex(t), - Request: rpc.McpExecuteSamplingRequest{}, + MCPRequestID: "mcp-request-" + randomHex(t), + Request: rpc.MCPExecuteSamplingRequest{}, }) if err != nil { - assertRpcError(t, "Mcp.ExecuteSampling", func() error { return err }, "sampling") + assertRPCError(t, "MCP.ExecuteSampling", func() error { return err }, "sampling") return } - if result.Action != rpc.McpSamplingExecutionActionFailure { + if result.Action != rpc.MCPSamplingExecutionActionFailure { t.Fatalf("Expected sampling failure action, got %+v", result) } if result.Result != nil || result.Error == nil || strings.TrimSpace(*result.Error) == "" { @@ -306,8 +306,8 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { } }) - t.Run("should round trip mcp app host context", func(t *testing.T) { - mcpAppsClient := createMcpAppsClient(ctx) + t.Run("should round trip MCP app host context", func(t *testing.T) { + mcpAppsClient := createMCPAppsClient(ctx) t.Cleanup(func() { mcpAppsClient.ForceStop() }) session, err := mcpAppsClient.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -316,14 +316,14 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - displayMode := rpc.McpAppsSetHostContextDetailsDisplayModeInline - platform := rpc.McpAppsSetHostContextDetailsPlatformDesktop - theme := rpc.McpAppsSetHostContextDetailsThemeDark - if _, err := session.RPC.Mcp.Apps().SetHostContext(t.Context(), &rpc.McpAppsSetHostContextRequest{ - Context: rpc.McpAppsSetHostContextDetails{ - AvailableDisplayModes: []rpc.McpAppsSetHostContextDetailsAvailableDisplayMode{ - rpc.McpAppsSetHostContextDetailsAvailableDisplayModeInline, - rpc.McpAppsSetHostContextDetailsAvailableDisplayModeFullscreen, + displayMode := rpc.MCPAppsSetHostContextDetailsDisplayModeInline + platform := rpc.MCPAppsSetHostContextDetailsPlatformDesktop + theme := rpc.MCPAppsSetHostContextDetailsThemeDark + if _, err := session.RPC.MCP.Apps().SetHostContext(t.Context(), &rpc.MCPAppsSetHostContextRequest{ + Context: rpc.MCPAppsSetHostContextDetails{ + AvailableDisplayModes: []rpc.MCPAppsSetHostContextDetailsAvailableDisplayMode{ + rpc.MCPAppsSetHostContextDetailsAvailableDisplayModeInline, + rpc.MCPAppsSetHostContextDetailsAvailableDisplayModeFullscreen, }, DisplayMode: &displayMode, Locale: rpcPtr("en-GB"), @@ -333,12 +333,12 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { UserAgent: rpcPtr("go-sdk-e2e"), }, }); err != nil { - t.Fatalf("Mcp.Apps.SetHostContext failed: %v", err) + t.Fatalf("MCP.Apps.SetHostContext failed: %v", err) } - result, err := session.RPC.Mcp.Apps().GetHostContext(t.Context()) + result, err := session.RPC.MCP.Apps().GetHostContext(t.Context()) if err != nil { - t.Fatalf("Mcp.Apps.GetHostContext failed: %v", err) + t.Fatalf("MCP.Apps.GetHostContext failed: %v", err) } if result.Context.DisplayMode == nil || string(*result.Context.DisplayMode) != "inline" || result.Context.Locale == nil || *result.Context.Locale != "en-GB" || @@ -362,7 +362,7 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { servers[serverName] = stdio } - mcpAppsClient := createMcpAppsClient(ctx) + mcpAppsClient := createMCPAppsClient(ctx) t.Cleanup(func() { mcpAppsClient.ForceStop() }) session, err := mcpAppsClient.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -371,31 +371,31 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { if err != nil { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) - waitForMCPServerStatus(t, session, otherServerName, rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + waitForMCPServerStatus(t, session, otherServerName, rpc.MCPServerStatusConnected) - diagnose, err := session.RPC.Mcp.Apps().Diagnose(t.Context(), &rpc.McpAppsDiagnoseRequest{ServerName: serverName}) + diagnose, err := session.RPC.MCP.Apps().Diagnose(t.Context(), &rpc.MCPAppsDiagnoseRequest{ServerName: serverName}) if err != nil { - t.Fatalf("Mcp.Apps.Diagnose failed: %v", err) + t.Fatalf("MCP.Apps.Diagnose failed: %v", err) } if !diagnose.Server.Connected || diagnose.Server.ToolCount < 1 { t.Fatalf("Expected connected MCP app diagnose result with tools, got %+v", diagnose) } - assertMcpAppsResultOrImplementedError(t, "Mcp.Apps.ListTools(self)", func() (any, error) { - return session.RPC.Mcp.Apps().ListTools(t.Context(), &rpc.McpAppsListToolsRequest{ + assertMCPAppsResultOrImplementedError(t, "MCP.Apps.ListTools(self)", func() (any, error) { + return session.RPC.MCP.Apps().ListTools(t.Context(), &rpc.MCPAppsListToolsRequest{ ServerName: serverName, OriginServerName: serverName, }) }) - assertMcpAppsResultOrImplementedError(t, "Mcp.Apps.ListTools(other)", func() (any, error) { - return session.RPC.Mcp.Apps().ListTools(t.Context(), &rpc.McpAppsListToolsRequest{ + assertMCPAppsResultOrImplementedError(t, "MCP.Apps.ListTools(other)", func() (any, error) { + return session.RPC.MCP.Apps().ListTools(t.Context(), &rpc.MCPAppsListToolsRequest{ ServerName: serverName, OriginServerName: otherServerName, }) }) - assertMcpAppsResultOrImplementedError(t, "Mcp.Apps.CallTool", func() (any, error) { - return session.RPC.Mcp.Apps().CallTool(t.Context(), &rpc.McpAppsCallToolRequest{ + assertMCPAppsResultOrImplementedError(t, "MCP.Apps.CallTool", func() (any, error) { + return session.RPC.MCP.Apps().CallTool(t.Context(), &rpc.MCPAppsCallToolRequest{ ServerName: serverName, OriginServerName: serverName, ToolName: "get_env", @@ -406,7 +406,7 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Run("should report error when mcp app resource is not available", func(t *testing.T) { const serverName = "rpc-apps-resource-server" - mcpAppsClient := createMcpAppsClient(ctx) + mcpAppsClient := createMCPAppsClient(ctx) t.Cleanup(func() { mcpAppsClient.ForceStop() }) session, err := mcpAppsClient.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, @@ -415,9 +415,9 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { if err != nil { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) - _, err = session.RPC.Mcp.Apps().ReadResource(t.Context(), &rpc.McpAppsReadResourceRequest{ + _, err = session.RPC.MCP.Apps().ReadResource(t.Context(), &rpc.MCPAppsReadResourceRequest{ ServerName: serverName, URI: "ui://missing-resource", }) @@ -439,20 +439,20 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - assertRpcError(t, "Mcp.Enable", func() error { - _, e := session.RPC.Mcp.Enable(t.Context(), &rpc.McpEnableRequest{ServerName: "missing-server"}) + assertRPCError(t, "MCP.Enable", func() error { + _, e := session.RPC.MCP.Enable(t.Context(), &rpc.MCPEnableRequest{ServerName: "missing-server"}) return e }, "no mcp host initialized") - assertRpcError(t, "Mcp.Disable", func() error { - _, e := session.RPC.Mcp.Disable(t.Context(), &rpc.McpDisableRequest{ServerName: "missing-server"}) + assertRPCError(t, "MCP.Disable", func() error { + _, e := session.RPC.MCP.Disable(t.Context(), &rpc.MCPDisableRequest{ServerName: "missing-server"}) return e }, "no mcp host initialized") - assertRpcError(t, "Mcp.Reload", func() error { - _, e := session.RPC.Mcp.Reload(t.Context()) + assertRPCError(t, "MCP.Reload", func() error { + _, e := session.RPC.MCP.Reload(t.Context()) return e }, "mcp config reload not available") - assertRpcError(t, "Mcp.Oauth.Login", func() error { - _, e := session.RPC.Mcp.Oauth().Login(t.Context(), &rpc.McpOauthLoginRequest{ServerName: "missing-server"}) + assertRPCError(t, "MCP.Oauth.Login", func() error { + _, e := session.RPC.MCP.Oauth().Login(t.Context(), &rpc.MCPOauthLoginRequest{ServerName: "missing-server"}) return e }, "mcp host is not available") }) @@ -466,10 +466,10 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { if err != nil { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) - assertRpcError(t, "Mcp.Oauth.Login", func() error { - _, e := session.RPC.Mcp.Oauth().Login(t.Context(), &rpc.McpOauthLoginRequest{ServerName: "missing-server"}) + assertRPCError(t, "MCP.Oauth.Login", func() error { + _, e := session.RPC.MCP.Oauth().Login(t.Context(), &rpc.MCPOauthLoginRequest{ServerName: "missing-server"}) return e }, "is not configured") }) @@ -483,13 +483,13 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { if err != nil { t.Fatalf("CreateSession failed: %v", err) } - waitForMCPServerStatus(t, session, serverName, rpc.McpServerStatusConnected) + waitForMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) force := true clientName := "SDK E2E" callback := "Done" - assertRpcError(t, "Mcp.Oauth.Login", func() error { - _, e := session.RPC.Mcp.Oauth().Login(t.Context(), &rpc.McpOauthLoginRequest{ + assertRPCError(t, "MCP.Oauth.Login", func() error { + _, e := session.RPC.MCP.Oauth().Login(t.Context(), &rpc.MCPOauthLoginRequest{ ServerName: serverName, ForceReauth: &force, ClientName: &clientName, @@ -507,24 +507,24 @@ func TestRpcMcpAndSkillsE2E(t *testing.T) { t.Fatalf("CreateSession failed: %v", err) } - assertRpcError(t, "Extensions.Enable", func() error { + assertRPCError(t, "Extensions.Enable", func() error { _, e := session.RPC.Extensions.Enable(t.Context(), &rpc.ExtensionsEnableRequest{ID: "missing-extension"}) return e }, "extensions not available") - assertRpcError(t, "Extensions.Disable", func() error { + assertRPCError(t, "Extensions.Disable", func() error { _, e := session.RPC.Extensions.Disable(t.Context(), &rpc.ExtensionsDisableRequest{ID: "missing-extension"}) return e }, "extensions not available") - assertRpcError(t, "Extensions.Reload", func() error { + assertRPCError(t, "Extensions.Reload", func() error { _, e := session.RPC.Extensions.Reload(t.Context()) return e }, "extensions not available") }) } -// createMcpSkillsRpcDirectory creates a unique skills directory containing a single +// createMCPSkillsRPCDirectory creates a unique skills directory containing a single // SKILL.md and returns the parent directory suitable for SkillDirectories. -func createMcpSkillsRpcDirectory(t *testing.T, workDir, baseName, skillName, description string) string { +func createMCPSkillsRPCDirectory(t *testing.T, workDir, baseName, skillName, description string) string { t.Helper() skillsDir := filepath.Join(workDir, baseName, randomHex(t)) if err := os.MkdirAll(skillsDir, 0755); err != nil { @@ -570,13 +570,13 @@ func assertSkillState(t *testing.T, list *rpc.SkillList, name string, enabled bo return matched } -func createMcpAppsClient(ctx *testharness.TestContext) *copilot.Client { +func createMCPAppsClient(ctx *testharness.TestContext) *copilot.Client { return ctx.NewClient(func(opts *copilot.ClientOptions) { opts.Env = append(opts.Env, "COPILOT_MCP_APPS=true", "MCP_APPS=true") }) } -func assertMcpAppsResultOrImplementedError(t *testing.T, name string, action func() (any, error)) { +func assertMCPAppsResultOrImplementedError(t *testing.T, name string, action func() (any, error)) { t.Helper() result, err := action() if err == nil { @@ -584,11 +584,11 @@ func assertMcpAppsResultOrImplementedError(t *testing.T, name string, action fun t.Fatalf("%s returned nil result", name) } switch value := result.(type) { - case *rpc.McpAppsListToolsResult: + case *rpc.MCPAppsListToolsResult: if value.Tools == nil { t.Fatalf("%s returned nil Tools", name) } - case *rpc.SessionMcpAppsCallToolResult: + case *rpc.SessionMCPAppsCallToolResult: if value == nil { t.Fatalf("%s returned nil CallTool result", name) } @@ -603,7 +603,7 @@ func assertMcpAppsResultOrImplementedError(t *testing.T, name string, action fun } } -func assertRpcError(t *testing.T, name string, action func() error, expectedSubstring string) { +func assertRPCError(t *testing.T, name string, action func() error, expectedSubstring string) { t.Helper() err := action() if err == nil { diff --git a/go/internal/e2e/rpc_mcp_config_e2e_test.go b/go/internal/e2e/rpc_mcp_config_e2e_test.go index 528c92080..4e950fa3c 100644 --- a/go/internal/e2e/rpc_mcp_config_e2e_test.go +++ b/go/internal/e2e/rpc_mcp_config_e2e_test.go @@ -9,9 +9,9 @@ import ( ) // Mirrors dotnet/test/RpcMcpConfigTests.cs (snapshot category "rpc_mcp_config"). -// Tests server-scoped MCP configuration management via mcp.config.* RPCs. -func TestRpcMcpConfigE2E(t *testing.T) { - t.Run("should call server mcp config rpcs", func(t *testing.T) { +// Tests server-scoped MCP configuration management via MCP.Config.* RPCs. +func TestRPCMCPConfigE2E(t *testing.T) { + t.Run("should call server MCP config rpcs", func(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -21,18 +21,18 @@ func TestRpcMcpConfigE2E(t *testing.T) { serverName := fmt.Sprintf("sdk-test-%s", randomHex(t)) - baseConfig := &rpc.McpServerConfigStdio{ + baseConfig := &rpc.MCPServerConfigStdio{ Command: "node", Args: []string{"-v"}, } - updatedConfig := &rpc.McpServerConfigStdio{ + updatedConfig := &rpc.MCPServerConfigStdio{ Command: "node", Args: []string{"--version"}, } - initial, err := client.RPC.Mcp.Config().List(t.Context()) + initial, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (initial) failed: %v", err) + t.Fatalf("MCP.Config.List (initial) failed: %v", err) } if _, present := initial.Servers[serverName]; present { t.Fatalf("Did not expect %q to be present initially", serverName) @@ -40,40 +40,40 @@ func TestRpcMcpConfigE2E(t *testing.T) { // Best-effort cleanup if a subtest assertion fails mid-flight. t.Cleanup(func() { - _, _ = client.RPC.Mcp.Config().Remove(t.Context(), &rpc.McpConfigRemoveRequest{Name: serverName}) + _, _ = client.RPC.MCP.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}) }) - if _, err := client.RPC.Mcp.Config().Add(t.Context(), &rpc.McpConfigAddRequest{ + if _, err := client.RPC.MCP.Config().Add(t.Context(), &rpc.MCPConfigAddRequest{ Name: serverName, Config: baseConfig, }); err != nil { - t.Fatalf("Mcp.Config.Add failed: %v", err) + t.Fatalf("MCP.Config.Add failed: %v", err) } - afterAdd, err := client.RPC.Mcp.Config().List(t.Context()) + afterAdd, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after add) failed: %v", err) + t.Fatalf("MCP.Config.List (after add) failed: %v", err) } if _, present := afterAdd.Servers[serverName]; !present { t.Fatalf("Expected %q to be present after Add", serverName) } - if _, err := client.RPC.Mcp.Config().Update(t.Context(), &rpc.McpConfigUpdateRequest{ + if _, err := client.RPC.MCP.Config().Update(t.Context(), &rpc.MCPConfigUpdateRequest{ Name: serverName, Config: updatedConfig, }); err != nil { - t.Fatalf("Mcp.Config.Update failed: %v", err) + t.Fatalf("MCP.Config.Update failed: %v", err) } - afterUpdate, err := client.RPC.Mcp.Config().List(t.Context()) + afterUpdate, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after update) failed: %v", err) + t.Fatalf("MCP.Config.List (after update) failed: %v", err) } updated, present := afterUpdate.Servers[serverName] if !present { t.Fatalf("Expected %q to still be present after Update", serverName) } - updatedLocal, ok := updated.(*rpc.McpServerConfigStdio) + updatedLocal, ok := updated.(*rpc.MCPServerConfigStdio) if !ok { t.Fatalf("Expected local MCP config, got %T", updated) } @@ -84,27 +84,27 @@ func TestRpcMcpConfigE2E(t *testing.T) { t.Errorf("Expected args[0]='--version', got %v", updatedLocal.Args) } - if _, err := client.RPC.Mcp.Config().Disable(t.Context(), &rpc.McpConfigDisableRequest{Names: []string{serverName}}); err != nil { - t.Fatalf("Mcp.Config.Disable failed: %v", err) + if _, err := client.RPC.MCP.Config().Disable(t.Context(), &rpc.MCPConfigDisableRequest{Names: []string{serverName}}); err != nil { + t.Fatalf("MCP.Config.Disable failed: %v", err) } - if _, err := client.RPC.Mcp.Config().Enable(t.Context(), &rpc.McpConfigEnableRequest{Names: []string{serverName}}); err != nil { - t.Fatalf("Mcp.Config.Enable failed: %v", err) + if _, err := client.RPC.MCP.Config().Enable(t.Context(), &rpc.MCPConfigEnableRequest{Names: []string{serverName}}); err != nil { + t.Fatalf("MCP.Config.Enable failed: %v", err) } - if _, err := client.RPC.Mcp.Config().Remove(t.Context(), &rpc.McpConfigRemoveRequest{Name: serverName}); err != nil { - t.Fatalf("Mcp.Config.Remove failed: %v", err) + if _, err := client.RPC.MCP.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}); err != nil { + t.Fatalf("MCP.Config.Remove failed: %v", err) } - afterRemove, err := client.RPC.Mcp.Config().List(t.Context()) + afterRemove, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after remove) failed: %v", err) + t.Fatalf("MCP.Config.List (after remove) failed: %v", err) } if _, present := afterRemove.Servers[serverName]; present { t.Errorf("Expected %q to be removed", serverName) } }) - t.Run("should round trip http mcp oauth config rpc", func(t *testing.T) { + t.Run("should round trip http MCP oauth config rpc", func(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -114,19 +114,19 @@ func TestRpcMcpConfigE2E(t *testing.T) { serverName := fmt.Sprintf("sdk-http-oauth-%s", randomHex(t)) - httpType := rpc.McpServerConfigHTTPTypeHTTP + httpType := rpc.MCPServerConfigHTTPTypeHTTP urlBase := "https://example.com/mcp" urlUpdated := "https://example.com/updated-mcp" clientID := "client-id" clientIDUpdated := "updated-client-id" - grantClientCreds := rpc.McpServerConfigHTTPOauthGrantTypeClientCredentials - grantAuthCode := rpc.McpServerConfigHTTPOauthGrantTypeAuthorizationCode + grantClientCreds := rpc.MCPServerConfigHTTPOauthGrantTypeClientCredentials + grantAuthCode := rpc.MCPServerConfigHTTPOauthGrantTypeAuthorizationCode var publicFalse = false var publicTrue = true var timeoutBase int64 = 3000 var timeoutUpdated int64 = 4000 - baseConfig := &rpc.McpServerConfigHTTP{ + baseConfig := &rpc.MCPServerConfigHTTP{ Type: &httpType, URL: urlBase, Headers: map[string]string{"Authorization": "Bearer token"}, @@ -136,7 +136,7 @@ func TestRpcMcpConfigE2E(t *testing.T) { Tools: []string{"*"}, Timeout: &timeoutBase, } - updatedConfig := &rpc.McpServerConfigHTTP{ + updatedConfig := &rpc.MCPServerConfigHTTP{ Type: &httpType, URL: urlUpdated, OauthClientID: &clientIDUpdated, @@ -147,25 +147,25 @@ func TestRpcMcpConfigE2E(t *testing.T) { } t.Cleanup(func() { - _, _ = client.RPC.Mcp.Config().Remove(t.Context(), &rpc.McpConfigRemoveRequest{Name: serverName}) + _, _ = client.RPC.MCP.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}) }) - if _, err := client.RPC.Mcp.Config().Add(t.Context(), &rpc.McpConfigAddRequest{ + if _, err := client.RPC.MCP.Config().Add(t.Context(), &rpc.MCPConfigAddRequest{ Name: serverName, Config: baseConfig, }); err != nil { - t.Fatalf("Mcp.Config.Add failed: %v", err) + t.Fatalf("MCP.Config.Add failed: %v", err) } - afterAdd, err := client.RPC.Mcp.Config().List(t.Context()) + afterAdd, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after add) failed: %v", err) + t.Fatalf("MCP.Config.List (after add) failed: %v", err) } added, present := afterAdd.Servers[serverName] if !present { t.Fatalf("Expected %q to be present after Add", serverName) } - addedHTTP, ok := added.(*rpc.McpServerConfigHTTP) + addedHTTP, ok := added.(*rpc.MCPServerConfigHTTP) if !ok { t.Fatalf("Expected HTTP MCP config, got %T", added) } @@ -188,21 +188,21 @@ func TestRpcMcpConfigE2E(t *testing.T) { t.Errorf("Expected oauthGrantType='client_credentials', got %v", addedHTTP.OauthGrantType) } - if _, err := client.RPC.Mcp.Config().Update(t.Context(), &rpc.McpConfigUpdateRequest{ + if _, err := client.RPC.MCP.Config().Update(t.Context(), &rpc.MCPConfigUpdateRequest{ Name: serverName, Config: updatedConfig, }); err != nil { - t.Fatalf("Mcp.Config.Update failed: %v", err) + t.Fatalf("MCP.Config.Update failed: %v", err) } - afterUpdate, err := client.RPC.Mcp.Config().List(t.Context()) + afterUpdate, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after update) failed: %v", err) + t.Fatalf("MCP.Config.List (after update) failed: %v", err) } updated, present := afterUpdate.Servers[serverName] if !present { t.Fatalf("Expected %q to still be present after Update", serverName) } - updatedHTTP, ok := updated.(*rpc.McpServerConfigHTTP) + updatedHTTP, ok := updated.(*rpc.MCPServerConfigHTTP) if !ok { t.Fatalf("Expected HTTP MCP config, got %T", updated) } @@ -225,13 +225,13 @@ func TestRpcMcpConfigE2E(t *testing.T) { t.Errorf("Expected timeout=4000, got %v", updatedHTTP.Timeout) } - if _, err := client.RPC.Mcp.Config().Remove(t.Context(), &rpc.McpConfigRemoveRequest{Name: serverName}); err != nil { - t.Fatalf("Mcp.Config.Remove failed: %v", err) + if _, err := client.RPC.MCP.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}); err != nil { + t.Fatalf("MCP.Config.Remove failed: %v", err) } - afterRemove, err := client.RPC.Mcp.Config().List(t.Context()) + afterRemove, err := client.RPC.MCP.Config().List(t.Context()) if err != nil { - t.Fatalf("Mcp.Config.List (after remove) failed: %v", err) + t.Fatalf("MCP.Config.List (after remove) failed: %v", err) } if _, present := afterRemove.Servers[serverName]; present { t.Errorf("Expected %q to be removed", serverName) diff --git a/go/internal/e2e/rpc_mcp_lifecycle_e2e_test.go b/go/internal/e2e/rpc_mcp_lifecycle_e2e_test.go new file mode 100644 index 000000000..cfe1123fd --- /dev/null +++ b/go/internal/e2e/rpc_mcp_lifecycle_e2e_test.go @@ -0,0 +1,110 @@ +package e2e + +import ( + "strings" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcMcpLifecycle(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should_list_tools_and_report_running_status_for_connected_server", func(t *testing.T) { + ctx.ConfigureForTest(t) + const serverName = "rpc-lifecycle-list-server" + session := createPortedSession(t, client, &copilot.SessionConfig{MCPServers: testMCPServers(t, serverName)}) + defer session.Disconnect() + waitForPortedMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + + tools, err := session.RPC.MCP.ListTools(t.Context(), &rpc.MCPListToolsRequest{ServerName: serverName}) + if err != nil { + t.Fatalf("MCP.ListTools failed: %v", err) + } + if len(tools.Tools) == 0 { + t.Fatal("Expected connected MCP server to expose at least one tool") + } + for _, tool := range tools.Tools { + if strings.TrimSpace(tool.Name) == "" { + t.Fatalf("Expected non-empty MCP tool name, got %+v", tool) + } + } + + running, err := session.RPC.MCP.IsServerRunning(t.Context(), &rpc.MCPIsServerRunningRequest{ServerName: serverName}) + if err != nil { + t.Fatalf("MCP.IsServerRunning(%s) failed: %v", serverName, err) + } + if !running.Running { + t.Fatalf("Expected %s to be running", serverName) + } + missing, err := session.RPC.MCP.IsServerRunning(t.Context(), &rpc.MCPIsServerRunningRequest{ServerName: "missing-" + randomHex(t)}) + if err != nil { + t.Fatalf("MCP.IsServerRunning(missing) failed: %v", err) + } + if missing.Running { + t.Fatal("Expected missing MCP server not to be running") + } + }) + + t.Run("should_throw_when_listing_tools_for_unconnected_server", func(t *testing.T) { + ctx.ConfigureForTest(t) + const serverName = "rpc-lifecycle-unconnected-host" + session := createPortedSession(t, client, &copilot.SessionConfig{MCPServers: testMCPServers(t, serverName)}) + defer session.Disconnect() + waitForPortedMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + + _, err := session.RPC.MCP.ListTools(t.Context(), &rpc.MCPListToolsRequest{ServerName: "missing-" + randomHex(t)}) + if err == nil { + t.Fatal("Expected MCP.ListTools for an unconnected server to fail") + } + message := err.Error() + assertPortedNoUnhandledMethod(t, message) + assertPortedContainsFold(t, message, "not connected") + }) + + t.Run("should_stop_running_mcp_server", func(t *testing.T) { + ctx.ConfigureForTest(t) + const serverName = "rpc-lifecycle-stop-server" + session := createPortedSession(t, client, &copilot.SessionConfig{MCPServers: testMCPServers(t, serverName)}) + defer session.Disconnect() + waitForPortedMCPServerStatus(t, session, serverName, rpc.MCPServerStatusConnected) + waitForPortedMCPRunning(t, session, serverName, true) + + if _, err := session.RPC.MCP.StopServer(t.Context(), &rpc.MCPStopServerRequest{ServerName: serverName}); err != nil { + t.Fatalf("MCP.StopServer failed: %v", err) + } + waitForPortedMCPRunning(t, session, serverName, false) + }) +} + +func waitForPortedMCPServerStatus(t *testing.T, session *copilot.Session, serverName string, expectedStatus rpc.MCPServerStatus) { + t.Helper() + waitForRPCCondition(t, 60*time.Second, serverName+" reaching "+string(expectedStatus), func() (bool, error) { + result, err := session.RPC.MCP.List(t.Context()) + if err != nil { + return false, err + } + for _, server := range result.Servers { + if server.Name == serverName { + return server.Status == expectedStatus, nil + } + } + return false, nil + }) +} + +func waitForPortedMCPRunning(t *testing.T, session *copilot.Session, serverName string, expectedRunning bool) { + t.Helper() + waitForRPCCondition(t, 60*time.Second, serverName+" running state", func() (bool, error) { + result, err := session.RPC.MCP.IsServerRunning(t.Context(), &rpc.MCPIsServerRunningRequest{ServerName: serverName}) + if err != nil { + return false, err + } + return result.Running == expectedRunning, nil + }) +} diff --git a/go/internal/e2e/rpc_queue_e2e_test.go b/go/internal/e2e/rpc_queue_e2e_test.go index ff567fab1..7ab0b1793 100644 --- a/go/internal/e2e/rpc_queue_e2e_test.go +++ b/go/internal/e2e/rpc_queue_e2e_test.go @@ -11,7 +11,7 @@ import ( ) // Mirrors dotnet/test/E2E/RpcQueueE2ETests.cs (snapshot category "rpc_queue"). -func TestRpcQueueE2E(t *testing.T) { +func TestRPCQueueE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/rpc_remote_e2e_test.go b/go/internal/e2e/rpc_remote_e2e_test.go index b1243526b..fa4392b03 100644 --- a/go/internal/e2e/rpc_remote_e2e_test.go +++ b/go/internal/e2e/rpc_remote_e2e_test.go @@ -11,7 +11,7 @@ import ( ) // Mirrors dotnet/test/E2E/RpcRemoteE2ETests.cs (snapshot category "rpc_remote"). -func TestRpcRemoteE2E(t *testing.T) { +func TestRPCRemoteE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -51,25 +51,11 @@ func TestRpcRemoteE2E(t *testing.T) { t.Fatalf("Remote.NotifySteerableChanged(true) failed: %v", err) } waitForRemoteSteerableEvent(t, session, true) - persisted, err := client.RPC.Sessions.GetPersistedRemoteSteerable(t.Context(), &rpc.SessionsGetPersistedRemoteSteerableRequest{SessionID: session.SessionID}) - if err != nil { - t.Fatalf("Sessions.GetPersistedRemoteSteerable(true) failed: %v", err) - } - if persisted.RemoteSteerable == nil || !*persisted.RemoteSteerable { - t.Fatalf("Expected persisted RemoteSteerable=true, got %+v", persisted) - } if _, err := session.RPC.Remote.NotifySteerableChanged(t.Context(), &rpc.RemoteNotifySteerableChangedRequest{RemoteSteerable: false}); err != nil { t.Fatalf("Remote.NotifySteerableChanged(false) failed: %v", err) } waitForRemoteSteerableEvent(t, session, false) - persisted, err = client.RPC.Sessions.GetPersistedRemoteSteerable(t.Context(), &rpc.SessionsGetPersistedRemoteSteerableRequest{SessionID: session.SessionID}) - if err != nil { - t.Fatalf("Sessions.GetPersistedRemoteSteerable(false) failed: %v", err) - } - if persisted.RemoteSteerable == nil || *persisted.RemoteSteerable { - t.Fatalf("Expected persisted RemoteSteerable=false, got %+v", persisted) - } }) } diff --git a/go/internal/e2e/rpc_schedule_e2e_test.go b/go/internal/e2e/rpc_schedule_e2e_test.go index 359cd20e1..a20d48174 100644 --- a/go/internal/e2e/rpc_schedule_e2e_test.go +++ b/go/internal/e2e/rpc_schedule_e2e_test.go @@ -10,7 +10,7 @@ import ( ) // Mirrors dotnet/test/E2E/RpcScheduleE2ETests.cs (snapshot category "rpc_schedule"). -func TestRpcScheduleE2E(t *testing.T) { +func TestRPCScheduleE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) diff --git a/go/internal/e2e/rpc_server_e2e_test.go b/go/internal/e2e/rpc_server_e2e_test.go index 66288aa0e..6ea9ad685 100644 --- a/go/internal/e2e/rpc_server_e2e_test.go +++ b/go/internal/e2e/rpc_server_e2e_test.go @@ -3,6 +3,7 @@ package e2e import ( "fmt" "path/filepath" + "runtime" "strings" "testing" "time" @@ -15,7 +16,7 @@ import ( // Mirrors dotnet/test/RpcServerTests.cs (snapshot category "rpc_server"). // Tests server-scoped (non-session) RPCs. -func TestRpcServerE2E(t *testing.T) { +func TestRPCServerE2E(t *testing.T) { t.Run("should call rpc ping with typed params and result", func(t *testing.T) { ctx := testharness.NewTestContext(t) ctx.ConfigureForTest(t) @@ -161,17 +162,17 @@ func TestRpcServerE2E(t *testing.T) { t.Fatalf("Start failed: %v", err) } - result, err := client.RPC.SessionFs.SetProvider(t.Context(), &rpc.SessionFsSetProviderRequest{ + result, err := client.RPC.SessionFS.SetProvider(t.Context(), &rpc.SessionFSSetProviderRequest{ InitialCwd: "/", SessionStatePath: "/session-state", - Conventions: rpc.SessionFsSetProviderConventionsPosix, - Capabilities: &rpc.SessionFsSetProviderCapabilities{Sqlite: rpcPtr(true)}, + Conventions: rpc.SessionFSSetProviderConventionsPosix, + Capabilities: &rpc.SessionFSSetProviderCapabilities{Sqlite: rpcPtr(true)}, }) if err != nil { - t.Fatalf("SessionFs.SetProvider failed: %v", err) + t.Fatalf("SessionFS.SetProvider failed: %v", err) } if !result.Success { - t.Fatalf("Expected SessionFs.SetProvider Success=true, got %+v", result) + t.Fatalf("Expected SessionFS.SetProvider Success=true, got %+v", result) } }) @@ -196,6 +197,44 @@ func TestRpcServerE2E(t *testing.T) { } }) + t.Run("should return false for missing LLM response frames", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + start, err := client.RPC.LlmInference.HttpResponseStart(t.Context(), &rpc.LlmInferenceHTTPResponseStartRequest{ + RequestID: "missing-response-start-request", + Status: 200, + StatusText: rpcPtr("OK"), + Headers: map[string][]string{ + "content-type": {"application/json"}, + }, + }) + if err != nil { + t.Fatalf("LlmInference.HttpResponseStart failed: %v", err) + } + if start.Accepted { + t.Fatal("Expected Accepted=false for missing LLM response start request id") + } + + end := true + chunk, err := client.RPC.LlmInference.HttpResponseChunk(t.Context(), &rpc.LlmInferenceHTTPResponseChunkRequest{ + RequestID: "missing-response-chunk-request", + Data: "{}", + End: &end, + }) + if err != nil { + t.Fatalf("LlmInference.HttpResponseChunk failed: %v", err) + } + if chunk.Accepted { + t.Fatal("Expected Accepted=false for missing LLM response chunk request id") + } + }) + t.Run("should list find and inspect persisted session state", func(t *testing.T) { ctx := testharness.NewTestContext(t) token := "rpc-server-list-token-" + randomHex(t) @@ -221,10 +260,7 @@ func TestRpcServerE2E(t *testing.T) { t.Fatalf("Log failed: %v", err) } - eventFilePath := saveAndGetEventFilePath(t, client, sessionID) - if !strings.Contains(strings.ToLower(eventFilePath), strings.ToLower(sessionID)) { - t.Fatalf("Expected event file path %q to contain session ID %q", eventFilePath, sessionID) - } + saveSession(t, client, sessionID) metadataLimit := int64(0) filter := &rpc.SessionListFilter{Cwd: &workingDirectory} @@ -239,8 +275,9 @@ func TestRpcServerE2E(t *testing.T) { t.Fatal("Expected non-nil sessions list") } for _, metadata := range listed.Sessions { - if metadata.Context != nil { - assertRPCPathEqual(t, workingDirectory, metadata.Context.Cwd) + local, ok := metadata.(*rpc.LocalSessionMetadataValue) + if ok && local.Context != nil { + assertRPCPathEqual(t, workingDirectory, local.Context.Cwd) } } @@ -281,7 +318,7 @@ func TestRpcServerE2E(t *testing.T) { t.Fatalf("Expected non-negative size for %q, got %d", sessionID, size) } - inUse, err := client.RPC.Sessions.CheckInUse(t.Context(), &rpc.SessionsCheckInUseRequest{SessionIds: []string{sessionID, missingSessionID}}) + inUse, err := client.RPC.Sessions.CheckInUse(t.Context(), &rpc.SessionsCheckInUseRequest{SessionIDs: []string{sessionID, missingSessionID}}) if err != nil { t.Fatalf("Sessions.CheckInUse failed: %v", err) } @@ -289,13 +326,6 @@ func TestRpcServerE2E(t *testing.T) { t.Fatalf("Did not expect missing session %q to be in use: %+v", missingSessionID, inUse.InUse) } - remoteSteerable, err := client.RPC.Sessions.GetPersistedRemoteSteerable(t.Context(), &rpc.SessionsGetPersistedRemoteSteerableRequest{SessionID: sessionID}) - if err != nil { - t.Fatalf("Sessions.GetPersistedRemoteSteerable failed: %v", err) - } - if remoteSteerable.RemoteSteerable != nil { - t.Fatalf("Expected no persisted remote steerable flag, got %v", *remoteSteerable.RemoteSteerable) - } }) t.Run("should enrich basic session metadata", func(t *testing.T) { @@ -319,11 +349,11 @@ func TestRpcServerE2E(t *testing.T) { if err := session.Log(t.Context(), "SERVER_RPC_ENRICH_READY", nil); err != nil { t.Fatalf("Log failed: %v", err) } - saveAndGetEventFilePath(t, client, sessionID) + saveSession(t, client, sessionID) now := time.Now().UTC().Format(time.RFC3339Nano) result, err := client.RPC.Sessions.EnrichMetadata(t.Context(), &rpc.SessionsEnrichMetadataRequest{ - Sessions: []rpc.SessionMetadata{{ + Sessions: []rpc.LocalSessionMetadataValue{{ SessionID: sessionID, StartTime: now, ModifiedTime: now, @@ -371,7 +401,7 @@ func TestRpcServerE2E(t *testing.T) { if err := session.Log(t.Context(), "SERVER_RPC_CLOSE_READY", nil); err != nil { t.Fatalf("Log failed: %v", err) } - saveAndGetEventFilePath(t, client, sessionID) + saveSession(t, client, sessionID) if _, err := client.RPC.Sessions.Close(t.Context(), &rpc.SessionsCloseRequest{SessionID: sessionID}); err != nil { t.Fatalf("Sessions.Close failed: %v", err) @@ -379,7 +409,7 @@ func TestRpcServerE2E(t *testing.T) { if _, err := client.RPC.Sessions.ReleaseLock(t.Context(), &rpc.SessionsReleaseLockRequest{SessionID: sessionID}); err != nil { t.Fatalf("Sessions.ReleaseLock failed: %v", err) } - inUse, err := client.RPC.Sessions.CheckInUse(t.Context(), &rpc.SessionsCheckInUseRequest{SessionIds: []string{sessionID}}) + inUse, err := client.RPC.Sessions.CheckInUse(t.Context(), &rpc.SessionsCheckInUseRequest{SessionIDs: []string{sessionID}}) if err != nil { t.Fatalf("Sessions.CheckInUse failed: %v", err) } @@ -410,7 +440,7 @@ func TestRpcServerE2E(t *testing.T) { t.Fatalf("Log failed: %v", err) } - saveAndGetEventFilePath(t, client, sessionID) + saveSession(t, client, sessionID) if _, err := client.RPC.Sessions.Close(t.Context(), &rpc.SessionsCloseRequest{SessionID: sessionID}); err != nil { t.Fatalf("Sessions.Close failed: %v", err) } @@ -419,7 +449,7 @@ func TestRpcServerE2E(t *testing.T) { OlderThanDays: 0, DryRun: rpcPtr(true), IncludeNamed: rpcPtr(true), - ExcludeSessionIds: []string{}, + ExcludeSessionIDs: []string{}, }) if err != nil { t.Fatalf("Sessions.PruneOld failed: %v", err) @@ -435,7 +465,7 @@ func TestRpcServerE2E(t *testing.T) { } deleted, err := client.RPC.Sessions.BulkDelete(t.Context(), &rpc.SessionsBulkDeleteRequest{ - SessionIds: []string{sessionID, missingSessionID}, + SessionIDs: []string{sessionID, missingSessionID}, }) if err != nil { t.Fatalf("Sessions.BulkDelete failed: %v", err) @@ -474,7 +504,7 @@ func TestRpcServerE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ SessionID: sessionID, WorkingDirectory: workingDirectory, - EnableConfigDiscovery: false, + EnableConfigDiscovery: copilot.Bool(false), OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) if err != nil { @@ -532,12 +562,12 @@ func TestRpcServerE2E(t *testing.T) { } skillName := fmt.Sprintf("server-rpc-skill-%s", randomHex(t)) - skillsDir := createMcpSkillsRpcDirectory(t, ctx.WorkDir, "server-rpc-skills", skillName, "Skill discovered by server-scoped RPC tests.") + skillsDir := createMCPSkillsRPCDirectory(t, ctx.WorkDir, "server-rpc-skills", skillName, "Skill discovered by server-scoped RPC tests.") workingDir := ctx.WorkDir - mcp, err := client.RPC.Mcp.Discover(t.Context(), &rpc.McpDiscoverRequest{WorkingDirectory: &workingDir}) + mcp, err := client.RPC.MCP.Discover(t.Context(), &rpc.MCPDiscoverRequest{WorkingDirectory: &workingDir}) if err != nil { - t.Fatalf("Mcp.Discover failed: %v", err) + t.Fatalf("MCP.Discover failed: %v", err) } if mcp.Servers == nil { t.Errorf("Expected non-nil Servers") @@ -563,6 +593,84 @@ func TestRpcServerE2E(t *testing.T) { t.Errorf("Expected skill path to end with %q, got %v", expectedSuffix, discovered.Path) } + excludeHost := true + skillPaths, err := client.RPC.Skills.GetDiscoveryPaths(t.Context(), &rpc.SkillsGetDiscoveryPathsRequest{ + ProjectPaths: []string{ctx.WorkDir}, + ExcludeHostSkills: &excludeHost, + }) + if err != nil { + t.Fatalf("Skills.GetDiscoveryPaths failed: %v", err) + } + projectSkillPath := findSkillDiscoveryPath(skillPaths.Paths, ctx.WorkDir) + if projectSkillPath == nil { + t.Fatalf("Expected skill discovery paths to include %q", ctx.WorkDir) + return + } + if strings.TrimSpace(projectSkillPath.Path) == "" { + t.Fatal("Expected non-empty skill discovery path") + } + + agents, err := client.RPC.Agents.Discover(t.Context(), &rpc.AgentsDiscoverRequest{ + ProjectPaths: []string{ctx.WorkDir}, + ExcludeHostAgents: &excludeHost, + }) + if err != nil { + t.Fatalf("Agents.Discover failed: %v", err) + } + for _, agent := range agents.Agents { + if strings.TrimSpace(agent.Name) == "" { + t.Fatalf("Expected discovered agent to have a name: %+v", agent) + } + } + + agentPaths, err := client.RPC.Agents.GetDiscoveryPaths(t.Context(), &rpc.AgentsGetDiscoveryPathsRequest{ + ProjectPaths: []string{ctx.WorkDir}, + ExcludeHostAgents: &excludeHost, + }) + if err != nil { + t.Fatalf("Agents.GetDiscoveryPaths failed: %v", err) + } + projectAgentPath := findAgentDiscoveryPath(agentPaths.Paths, ctx.WorkDir) + if projectAgentPath == nil { + t.Fatalf("Expected agent discovery paths to include %q", ctx.WorkDir) + return + } + if strings.TrimSpace(projectAgentPath.Path) == "" { + t.Fatal("Expected non-empty agent discovery path") + } + + instructions, err := client.RPC.Instructions.Discover(t.Context(), &rpc.InstructionsDiscoverRequest{ + ProjectPaths: []string{ctx.WorkDir}, + ExcludeHostInstructions: &excludeHost, + }) + if err != nil { + t.Fatalf("Instructions.Discover failed: %v", err) + } + for _, source := range instructions.Sources { + if strings.TrimSpace(source.ID) == "" || strings.TrimSpace(source.Label) == "" || strings.TrimSpace(source.SourcePath) == "" { + t.Fatalf("Expected discovered instruction source fields to be populated: %+v", source) + } + } + + instructionPaths, err := client.RPC.Instructions.GetDiscoveryPaths(t.Context(), &rpc.InstructionsGetDiscoveryPathsRequest{ + ProjectPaths: []string{ctx.WorkDir}, + ExcludeHostInstructions: &excludeHost, + }) + if err != nil { + t.Fatalf("Instructions.GetDiscoveryPaths failed: %v", err) + } + if len(instructionPaths.Paths) == 0 { + t.Fatal("Expected instruction discovery paths") + } + if !hasInstructionDiscoveryPath(instructionPaths.Paths, ctx.WorkDir) { + t.Fatalf("Expected instruction discovery paths to include %q", ctx.WorkDir) + } + for _, path := range instructionPaths.Paths { + if strings.TrimSpace(path.Path) == "" { + t.Fatalf("Expected non-empty instruction discovery path: %+v", path) + } + } + // Disable the skill globally and re-discover. if _, err := client.RPC.Skills.Config().SetDisabledSkills(t.Context(), &rpc.SkillsConfigSetDisabledSkillsRequest{ DisabledSkills: []string{skillName}, @@ -624,23 +732,45 @@ func findServerSkill(skills []rpc.ServerSkill, name string) *rpc.ServerSkill { return nil } -func saveAndGetEventFilePath(t *testing.T, client *copilot.Client, sessionID string) string { - t.Helper() - if _, err := client.RPC.Sessions.Save(t.Context(), &rpc.SessionsSaveRequest{SessionID: sessionID}); err != nil { - t.Fatalf("Sessions.Save failed: %v", err) +func findSkillDiscoveryPath(paths []rpc.SkillDiscoveryPath, projectPath string) *rpc.SkillDiscoveryPath { + for i, path := range paths { + if path.ProjectPath != nil && path.PreferredForCreation && pathsEqual(*path.ProjectPath, projectPath) { + return &paths[i] + } } - path, err := client.RPC.Sessions.GetEventFilePath(t.Context(), &rpc.SessionsGetEventFilePathRequest{SessionID: sessionID}) - if err != nil { - t.Fatalf("Sessions.GetEventFilePath failed: %v", err) + return nil +} + +func findAgentDiscoveryPath(paths []rpc.AgentDiscoveryPath, projectPath string) *rpc.AgentDiscoveryPath { + for i, path := range paths { + if path.ProjectPath != nil && path.PreferredForCreation && pathsEqual(*path.ProjectPath, projectPath) { + return &paths[i] + } } - if strings.TrimSpace(path.FilePath) == "" { - t.Fatal("Expected non-empty event file path") + return nil +} + +func hasInstructionDiscoveryPath(paths []rpc.InstructionDiscoveryPath, projectPath string) bool { + for _, path := range paths { + if path.ProjectPath != nil && pathsEqual(*path.ProjectPath, projectPath) { + return true + } } - if !filepath.IsAbs(path.FilePath) { - t.Fatalf("Expected absolute event file path, got %q", path.FilePath) + return false +} + +func pathsEqual(left, right string) bool { + left = filepath.Clean(left) + right = filepath.Clean(right) + if runtime.GOOS == "windows" { + return strings.EqualFold(left, right) } - if filepath.Base(path.FilePath) != "events.jsonl" { - t.Fatalf("Expected events.jsonl event file, got %q", path.FilePath) + return left == right +} + +func saveSession(t *testing.T, client *copilot.Client, sessionID string) { + t.Helper() + if _, err := client.RPC.Sessions.Save(t.Context(), &rpc.SessionsSaveRequest{SessionID: sessionID}); err != nil { + t.Fatalf("Sessions.Save failed: %v", err) } - return path.FilePath } diff --git a/go/internal/e2e/rpc_server_misc_e2e_test.go b/go/internal/e2e/rpc_server_misc_e2e_test.go new file mode 100644 index 000000000..37ec57e1b --- /dev/null +++ b/go/internal/e2e/rpc_server_misc_e2e_test.go @@ -0,0 +1,276 @@ +package e2e + +import ( + "strings" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcServerMisc(t *testing.T) { + ctx := testharness.NewTestContext(t) + sharedClient := ctx.NewClient() + t.Cleanup(func() { sharedClient.ForceStop() }) + + t.Run("should_reload_user_settings", func(t *testing.T) { + ctx.ConfigureForTest(t) + if err := sharedClient.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + if _, err := sharedClient.RPC.User.Settings().Reload(t.Context()); err != nil { + t.Fatalf("User.Settings.Reload failed: %v", err) + } + }) + + t.Run("should_get_set_and_clear_user_settings", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + initial, err := client.RPC.User.Settings().Get(t.Context()) + if err != nil { + t.Fatalf("User.Settings.Get initial failed: %v", err) + } + if initial.Settings == nil { + t.Fatal("Expected settings map") + } + var key string + var value bool + for candidateKey, setting := range initial.Settings { + if candidateValue, ok := setting.Value.(bool); ok { + key = candidateKey + value = candidateValue + break + } + } + if key == "" { + t.Fatalf("Expected at least one boolean setting, got %+v", initial.Settings) + } + toggledValue := !value + + set, err := client.RPC.User.Settings().Set(t.Context(), &rpc.UserSettingsSetRequest{ + Settings: map[string]any{key: toggledValue}, + }) + if err != nil { + t.Fatalf("User.Settings.Set(toggle) failed: %v", err) + } + if len(set.ShadowedKeys) != 0 { + t.Fatalf("Expected no shadowed settings keys, got %+v", set.ShadowedKeys) + } + if _, err := client.RPC.User.Settings().Reload(t.Context()); err != nil { + t.Fatalf("User.Settings.Reload after set failed: %v", err) + } + afterSet, err := client.RPC.User.Settings().Get(t.Context()) + if err != nil { + t.Fatalf("User.Settings.Get after set failed: %v", err) + } + metadata, ok := afterSet.Settings[key] + if !ok { + t.Fatalf("Expected setting %q in %+v", key, afterSet.Settings) + } + if metadata.Value != toggledValue || metadata.IsDefault { + t.Fatalf("Expected explicit true setting, got %+v", metadata) + } + + clear, err := client.RPC.User.Settings().Set(t.Context(), &rpc.UserSettingsSetRequest{ + Settings: map[string]any{key: nil}, + }) + if err != nil { + t.Fatalf("User.Settings.Set(null) failed: %v", err) + } + if len(clear.ShadowedKeys) != 0 { + t.Fatalf("Expected no shadowed settings keys from clear, got %+v", clear.ShadowedKeys) + } + if _, err := client.RPC.User.Settings().Reload(t.Context()); err != nil { + t.Fatalf("User.Settings.Reload after clear failed: %v", err) + } + afterClear, err := client.RPC.User.Settings().Get(t.Context()) + if err != nil { + t.Fatalf("User.Settings.Get after clear failed: %v", err) + } + metadata, ok = afterClear.Settings[key] + if !ok { + t.Fatalf("Expected setting %q after clear in %+v", key, afterClear.Settings) + } + if !metadata.IsDefault { + t.Fatalf("Expected cleared setting to be default, got %+v", metadata) + } + }) + + t.Run("should_login_list_getcurrentauth_and_logout_account", func(t *testing.T) { + ctx.ConfigureForTest(t) + if err := ctx.SetCopilotUserByToken("go-account-token", map[string]interface{}{ + "login": "go-account-user", + "copilot_plan": "individual_pro", + "endpoints": map[string]interface{}{ + "api": ctx.ProxyURL, + "telemetry": "https://localhost:1/telemetry", + }, + "analytics_tracking_id": "go-account-user-tracking-id", + }); err != nil { + t.Fatalf("SetCopilotUserByToken failed: %v", err) + } + client := newNoTokenClient(t, ctx) + defer client.ForceStop() + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + + initial, err := client.RPC.Account.GetCurrentAuth(t.Context()) + if err != nil { + t.Fatalf("Account.GetCurrentAuth initial failed: %v", err) + } + if initial.AuthInfo != nil { + t.Fatalf("Expected no initial auth info, got %+v", initial.AuthInfo) + } + + login, err := client.RPC.Account.Login(t.Context(), &rpc.AccountLoginRequest{ + Host: "https://github.com", + Login: "go-account-user", + Token: "go-account-token", + }) + if err != nil { + t.Fatalf("Account.Login failed: %v", err) + } + if login == nil { + t.Fatal("Expected login result") + } + + current, err := client.RPC.Account.GetCurrentAuth(t.Context()) + if err != nil { + t.Fatalf("Account.GetCurrentAuth after login failed: %v", err) + } + authInfo, ok := current.AuthInfo.(*rpc.UserAuthInfo) + if !ok { + t.Fatalf("Expected user auth info after login, got %#v", current.AuthInfo) + } + if authInfo.Login != "go-account-user" || authInfo.Host != "https://github.com" { + t.Fatalf("Unexpected current auth info: %+v", authInfo) + } + + users, err := client.RPC.Account.GetAllUsers(t.Context()) + if err != nil { + t.Fatalf("Account.GetAllUsers failed: %v", err) + } + if users == nil { + t.Fatal("Expected non-nil users result") + return + } + for _, user := range *users { + userInfo, ok := user.AuthInfo.(*rpc.UserAuthInfo) + if !ok { + t.Fatalf("Expected user auth info in all users, got %#v", user.AuthInfo) + } + if userInfo.Login == "go-account-user" && (user.Token == nil || *user.Token != "go-account-token") { + t.Fatalf("Expected logged-in user's token to round trip, got %+v", user) + } + } + + logout, err := client.RPC.Account.Logout(t.Context(), &rpc.AccountLogoutRequest{ + AuthInfo: authInfo, + }) + if err != nil { + t.Fatalf("Account.Logout failed: %v", err) + } + if logout.HasMoreUsers { + t.Fatalf("Expected no users after isolated logout, got %+v", logout) + } + afterLogout, err := client.RPC.Account.GetCurrentAuth(t.Context()) + if err != nil { + t.Fatalf("Account.GetCurrentAuth after logout failed: %v", err) + } + if afterLogout.AuthInfo != nil { + t.Fatalf("Expected no auth after logout, got %+v", afterLogout.AuthInfo) + } + }) + + t.Run("should_report_agent_registry_spawn_gate_closed", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + _, err := client.RPC.AgentRegistry.Spawn(t.Context(), &rpc.AgentRegistrySpawnRequest{Cwd: ctx.WorkDir}) + if err == nil { + t.Fatal("Expected AgentRegistry.Spawn to be rejected by the closed spawn gate") + } + message := err.Error() + assertPortedNoUnhandledMethod(t, message) + assertPortedContainsFold(t, message, "agentRegistry.spawn") + if !strings.Contains(strings.ToLower(message), "not enabled") && !strings.Contains(strings.ToLower(message), "no delegate") { + t.Fatalf("Expected agentRegistry.spawn gate error, got %s", message) + } + }) + + t.Run("should_shut_down_owned_runtime", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + + if _, err := client.RPC.User.Settings().Reload(t.Context()); err != nil { + t.Fatalf("User.Settings.Reload before shutdown failed: %v", err) + } + if _, err := client.RPC.Runtime.Shutdown(t.Context()); err != nil { + t.Fatalf("Runtime.Shutdown failed: %v", err) + } + + waitForRPCCondition(t, 15*time.Second, "runtime to stop serving RPCs after shutdown", func() (bool, error) { + _, err := client.RPC.User.Settings().Reload(t.Context()) + return err != nil, nil + }) + }) + + t.Run("should_report_not_found_when_opening_session_without_context", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + result, err := client.RPC.Sessions.Open(t.Context(), nil) + if err != nil { + t.Fatalf("Sessions.Open failed: %v", err) + } + if result.Status != rpc.SessionsOpenStatusNotFound { + t.Fatalf("Expected Sessions.Open status not_found, got %+v", result) + } + if result.SessionID != nil { + t.Fatalf("Expected nil session ID for not_found, got %q", *result.SessionID) + } + }) + + t.Run("should_reject_send_attachments_from_non_extension_connection", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, sharedClient, nil) + defer session.Disconnect() + + _, err := session.RPC.Extensions.SendAttachmentsToMessage(t.Context(), &rpc.SendAttachmentsToMessageParams{Attachments: []rpc.PushAttachment{}}) + if err == nil { + t.Fatal("Expected SendAttachmentsToMessage from a normal SDK connection to fail") + } + message := err.Error() + assertPortedNoUnhandledMethod(t, message) + assertPortedContainsFold(t, message, "extension") + }) +} + +func newNoTokenClient(t *testing.T, ctx *testharness.TestContext) *copilot.Client { + t.Helper() + env := append([]string{}, ctx.Env()...) + env = append(env, + "COPILOT_HOME="+t.TempDir(), + "GH_CONFIG_DIR="+t.TempDir(), + "GH_TOKEN=", + "GITHUB_TOKEN=", + "COPILOT_SDK_AUTH_TOKEN=", + ) + useLoggedInUser := false + return copilot.NewClient(&copilot.ClientOptions{ + Connection: copilot.StdioConnection{Path: ctx.CLIPath}, + WorkingDirectory: ctx.WorkDir, + Env: env, + UseLoggedInUser: &useLoggedInUser, + }) +} diff --git a/go/internal/e2e/rpc_server_plugins_e2e_test.go b/go/internal/e2e/rpc_server_plugins_e2e_test.go new file mode 100644 index 000000000..a9d1d243c --- /dev/null +++ b/go/internal/e2e/rpc_server_plugins_e2e_test.go @@ -0,0 +1,468 @@ +package e2e + +import ( + "os" + "path/filepath" + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +const ( + portedMarketplaceName = "go-e2e-marketplace" + portedPluginName = "go-e2e-plugin" + portedDirectPluginName = "go-e2e-direct" +) + +func TestRpcServerPlugins(t *testing.T) { + ctx := testharness.NewTestContext(t) + + t.Run("should_install_and_list_plugin_from_local_marketplace", func(t *testing.T) { + ctx.ConfigureForTest(t) + marketplaceDir := createPortedLocalMarketplaceFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + if _, err := client.RPC.Plugins.Marketplaces().Add(t.Context(), &rpc.PluginsMarketplacesAddRequest{Source: marketplaceDir}); err != nil { + t.Fatalf("Plugins.Marketplaces.Add failed: %v", err) + } + + spec := portedPluginName + "@" + portedMarketplaceName + install, err := client.RPC.Plugins.Install(t.Context(), &rpc.PluginsInstallRequest{Source: spec}) + if err != nil { + t.Fatalf("Plugins.Install failed: %v", err) + } + if install.Plugin.Name != portedPluginName { + t.Fatalf("Expected installed plugin name %q, got %q", portedPluginName, install.Plugin.Name) + } + if install.Plugin.Marketplace != portedMarketplaceName { + t.Fatalf("Expected marketplace %q, got %q", portedMarketplaceName, install.Plugin.Marketplace) + } + if !install.Plugin.Enabled { + t.Fatal("Expected installed marketplace plugin to be enabled") + } + if install.SkillsInstalled < 1 { + t.Fatalf("Expected at least one skill, got %d", install.SkillsInstalled) + } + if install.DeprecationWarning != nil { + t.Fatalf("Marketplace install should not return deprecation warning, got %q", *install.DeprecationWarning) + } + + afterInstall, err := client.RPC.Plugins.List(t.Context()) + if err != nil { + t.Fatalf("Plugins.List after install failed: %v", err) + } + listed := findPortedInstalledPlugin(afterInstall.Plugins, portedPluginName, portedMarketplaceName) + if listed == nil { + t.Fatalf("Expected installed plugin %q in marketplace %q", portedPluginName, portedMarketplaceName) + return + } + if !listed.Enabled { + t.Fatal("Expected listed marketplace plugin to be enabled") + } + + }) + + t.Run("should_enable_and_disable_marketplace_plugin", func(t *testing.T) { + ctx.ConfigureForTest(t) + marketplaceDir := createPortedLocalMarketplaceFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + spec := portedPluginName + "@" + portedMarketplaceName + if _, err := client.RPC.Plugins.Marketplaces().Add(t.Context(), &rpc.PluginsMarketplacesAddRequest{Source: marketplaceDir}); err != nil { + t.Fatalf("Plugins.Marketplaces.Add failed: %v", err) + } + if _, err := client.RPC.Plugins.Install(t.Context(), &rpc.PluginsInstallRequest{Source: spec}); err != nil { + t.Fatalf("Plugins.Install failed: %v", err) + } + + if _, err := client.RPC.Plugins.Disable(t.Context(), &rpc.PluginsDisableRequest{Names: []string{spec}}); err != nil { + t.Fatalf("Plugins.Disable failed: %v", err) + } + if plugin := getPortedInstalledPlugin(t, client, portedPluginName, portedMarketplaceName); plugin.Enabled { + t.Fatal("Expected plugin to be disabled") + } + + if _, err := client.RPC.Plugins.Enable(t.Context(), &rpc.PluginsEnableRequest{Names: []string{spec}}); err != nil { + t.Fatalf("Plugins.Enable failed: %v", err) + } + if plugin := getPortedInstalledPlugin(t, client, portedPluginName, portedMarketplaceName); !plugin.Enabled { + t.Fatal("Expected plugin to be enabled") + } + }) + + t.Run("should_update_single_marketplace_plugin", func(t *testing.T) { + ctx.ConfigureForTest(t) + marketplaceDir := createPortedLocalMarketplaceFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + spec := portedPluginName + "@" + portedMarketplaceName + if _, err := client.RPC.Plugins.Marketplaces().Add(t.Context(), &rpc.PluginsMarketplacesAddRequest{Source: marketplaceDir}); err != nil { + t.Fatalf("Plugins.Marketplaces.Add failed: %v", err) + } + if _, err := client.RPC.Plugins.Install(t.Context(), &rpc.PluginsInstallRequest{Source: spec}); err != nil { + t.Fatalf("Plugins.Install failed: %v", err) + } + + update, err := client.RPC.Plugins.Update(t.Context(), &rpc.PluginsUpdateRequest{Name: spec}) + if err != nil { + t.Fatalf("Plugins.Update failed: %v", err) + } + if update.SkillsInstalled < 1 { + t.Fatalf("Expected at least one skill, got %d", update.SkillsInstalled) + } + if update.PreviousVersion == nil || *update.PreviousVersion != "1.0.0" { + t.Fatalf("Expected previous version 1.0.0, got %v", update.PreviousVersion) + } + if update.NewVersion == nil || *update.NewVersion != "1.0.0" { + t.Fatalf("Expected new version 1.0.0, got %v", update.NewVersion) + } + }) + + t.Run("should_update_all_installed_plugins", func(t *testing.T) { + ctx.ConfigureForTest(t) + marketplaceDir := createPortedLocalMarketplaceFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + spec := portedPluginName + "@" + portedMarketplaceName + if _, err := client.RPC.Plugins.Marketplaces().Add(t.Context(), &rpc.PluginsMarketplacesAddRequest{Source: marketplaceDir}); err != nil { + t.Fatalf("Plugins.Marketplaces.Add failed: %v", err) + } + if _, err := client.RPC.Plugins.Install(t.Context(), &rpc.PluginsInstallRequest{Source: spec}); err != nil { + t.Fatalf("Plugins.Install failed: %v", err) + } + + result, err := client.RPC.Plugins.UpdateAll(t.Context()) + if err != nil { + t.Fatalf("Plugins.UpdateAll failed: %v", err) + } + var matches []rpc.PluginUpdateAllEntry + for _, entry := range result.Results { + if entry.Name == portedPluginName && entry.Marketplace == portedMarketplaceName { + matches = append(matches, entry) + } + } + if len(matches) != 1 { + t.Fatalf("Expected exactly one update result for %q, got %d in %+v", spec, len(matches), result.Results) + } + entry := matches[0] + if !entry.Success { + t.Fatalf("Expected update all entry to succeed, got error %v", entry.Error) + } + if entry.SkillsInstalled == nil || *entry.SkillsInstalled < 1 { + t.Fatalf("Expected at least one skill installed, got %v", entry.SkillsInstalled) + } + }) + + t.Run("should_install_direct_local_plugin_with_deprecation_warning", func(t *testing.T) { + ctx.ConfigureForTest(t) + pluginDir := createPortedDirectPluginFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + install, err := client.RPC.Plugins.Install(t.Context(), &rpc.PluginsInstallRequest{Source: pluginDir}) + if err != nil { + t.Fatalf("Plugins.Install direct failed: %v", err) + } + if install.Plugin.Name != portedDirectPluginName { + t.Fatalf("Expected installed plugin name %q, got %q", portedDirectPluginName, install.Plugin.Name) + } + if install.Plugin.Marketplace != "" { + t.Fatalf("Expected direct plugin marketplace to be empty, got %q", install.Plugin.Marketplace) + } + if install.DeprecationWarning == nil || !strings.Contains(strings.ToLower(*install.DeprecationWarning), "deprecated") { + t.Fatalf("Expected deprecation warning containing deprecated, got %v", install.DeprecationWarning) + } + if install.SkillsInstalled < 1 { + t.Fatalf("Expected at least one skill, got %d", install.SkillsInstalled) + } + + afterInstall, err := client.RPC.Plugins.List(t.Context()) + if err != nil { + t.Fatalf("Plugins.List after direct install failed: %v", err) + } + if countPortedInstalledPluginByName(afterInstall.Plugins, portedDirectPluginName) != 1 { + t.Fatalf("Expected exactly one direct plugin named %q, got %+v", portedDirectPluginName, afterInstall.Plugins) + } + if install.Plugin.DirectSourceID == nil { + t.Fatal("Expected direct plugin install to include directSourceId") + } + + if _, err := client.RPC.Plugins.Uninstall(t.Context(), &rpc.PluginsUninstallRequest{ + DirectSourceID: install.Plugin.DirectSourceID, + Name: portedDirectPluginName, + }); err != nil { + t.Fatalf("Plugins.Uninstall direct failed: %v", err) + } + afterUninstall, err := client.RPC.Plugins.List(t.Context()) + if err != nil { + t.Fatalf("Plugins.List after direct uninstall failed: %v", err) + } + if countPortedInstalledPluginByName(afterUninstall.Plugins, portedDirectPluginName) != 0 { + t.Fatalf("Expected direct plugin %q to be removed, got %+v", portedDirectPluginName, afterUninstall.Plugins) + } + }) + + t.Run("should_list_browse_refresh_and_remove_local_marketplace", func(t *testing.T) { + ctx.ConfigureForTest(t) + marketplaceDir := createPortedLocalMarketplaceFixture(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + add, err := client.RPC.Plugins.Marketplaces().Add(t.Context(), &rpc.PluginsMarketplacesAddRequest{Source: marketplaceDir}) + if err != nil { + t.Fatalf("Plugins.Marketplaces.Add failed: %v", err) + } + if add.Name != portedMarketplaceName { + t.Fatalf("Expected marketplace name %q, got %q", portedMarketplaceName, add.Name) + } + + list, err := client.RPC.Plugins.Marketplaces().List(t.Context()) + if err != nil { + t.Fatalf("Plugins.Marketplaces.List failed: %v", err) + } + mine := findPortedMarketplace(list.Marketplaces, portedMarketplaceName) + if mine == nil { + t.Fatalf("Expected marketplace %q in list %+v", portedMarketplaceName, list.Marketplaces) + return + } + if mine.IsDefault != nil && *mine.IsDefault { + t.Fatal("Expected local marketplace not to be marked default") + } + if !containsPortedDefaultMarketplace(list.Marketplaces) { + t.Fatalf("Expected built-in default marketplace in %+v", list.Marketplaces) + } + + browse, err := client.RPC.Plugins.Marketplaces().Browse(t.Context(), &rpc.PluginsMarketplacesBrowseRequest{Name: portedMarketplaceName}) + if err != nil { + t.Fatalf("Plugins.Marketplaces.Browse failed: %v", err) + } + var advertised []rpc.MarketplacePluginInfo + for _, plugin := range browse.Plugins { + if plugin.Name == portedPluginName { + advertised = append(advertised, plugin) + } + } + if len(advertised) != 1 { + t.Fatalf("Expected one advertised plugin %q, got %+v", portedPluginName, browse.Plugins) + } + if advertised[0].Description == nil || strings.TrimSpace(*advertised[0].Description) == "" { + t.Fatalf("Expected advertised plugin description, got %+v", advertised[0]) + } + + refreshName := portedMarketplaceName + refresh, err := client.RPC.Plugins.Marketplaces().Refresh(t.Context(), &rpc.PluginsMarketplacesRefreshRequest{Name: &refreshName}) + if err != nil { + t.Fatalf("Plugins.Marketplaces.Refresh failed: %v", err) + } + var refreshMatches []rpc.MarketplaceRefreshEntry + for _, entry := range refresh.Results { + if entry.Name == portedMarketplaceName { + refreshMatches = append(refreshMatches, entry) + } + } + if len(refreshMatches) != 1 { + t.Fatalf("Expected one refresh result for %q, got %+v", portedMarketplaceName, refresh.Results) + } + if !refreshMatches[0].Success { + t.Fatalf("Expected refresh success, got error %v", refreshMatches[0].Error) + } + + remove, err := client.RPC.Plugins.Marketplaces().Remove(t.Context(), &rpc.PluginsMarketplacesRemoveRequest{Name: portedMarketplaceName}) + if err != nil { + t.Fatalf("Plugins.Marketplaces.Remove failed: %v", err) + } + if !remove.Removed { + t.Fatalf("Expected marketplace removal, got %+v", remove) + } + + afterRemove, err := client.RPC.Plugins.Marketplaces().List(t.Context()) + if err != nil { + t.Fatalf("Plugins.Marketplaces.List after remove failed: %v", err) + } + if findPortedMarketplace(afterRemove.Marketplaces, portedMarketplaceName) != nil { + t.Fatalf("Expected marketplace %q to be removed, got %+v", portedMarketplaceName, afterRemove.Marketplaces) + } + }) + + t.Run("should_reload_mcp_config_cache", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedIsolatedPortedClient(t, ctx) + defer client.ForceStop() + + if _, err := client.RPC.MCP.Config().Reload(t.Context()); err != nil { + t.Fatalf("MCP.Config.Reload failed: %v", err) + } + }) +} + +func newStartedPortedClient(t *testing.T, ctx *testharness.TestContext, opts ...func(*copilot.ClientOptions)) *copilot.Client { + t.Helper() + client := ctx.NewClient(opts...) + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Start failed: %v", err) + } + return client +} + +func newStartedIsolatedPortedClient(t *testing.T, ctx *testharness.TestContext) *copilot.Client { + t.Helper() + home, err := os.MkdirTemp(ctx.WorkDir, "plugin-home-") + if err != nil { + t.Fatalf("Failed to create isolated plugin home: %v", err) + } + return newStartedPortedClient(t, ctx, func(opts *copilot.ClientOptions) { + opts.Env = append(opts.Env, + "COPILOT_HOME="+home, + "GH_CONFIG_DIR="+home, + "XDG_CONFIG_HOME="+home, + "XDG_STATE_HOME="+home, + ) + }) +} + +func createPortedSession(t *testing.T, client *copilot.Client, config *copilot.SessionConfig) *copilot.Session { + t.Helper() + if config == nil { + config = &copilot.SessionConfig{} + } + if config.OnPermissionRequest == nil { + config.OnPermissionRequest = copilot.PermissionHandler.ApproveAll + } + session, err := client.CreateSession(t.Context(), config) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + return session +} + +func assertPortedNoUnhandledMethod(t *testing.T, message string) { + t.Helper() + if strings.Contains(strings.ToLower(message), "unhandled method") { + t.Fatalf("Expected RPC to reach runtime, got %s", message) + } +} + +func assertPortedContainsFold(t *testing.T, message string, fragments ...string) { + t.Helper() + lower := strings.ToLower(message) + for _, fragment := range fragments { + if strings.Contains(lower, strings.ToLower(fragment)) { + return + } + } + t.Fatalf("Expected %q to contain one of %v", message, fragments) +} + +func createPortedLocalMarketplaceFixture(t *testing.T) string { + t.Helper() + dir := t.TempDir() + manifest := `{ + "name": "` + portedMarketplaceName + `", + "owner": { "name": "Copilot SDK E2E" }, + "metadata": { "description": "Local marketplace fixture for SDK E2E tests." }, + "plugins": [ + { + "name": "` + portedPluginName + `", + "source": "./` + portedPluginName + `", + "description": "E2E demo plugin advertised by the local marketplace.", + "version": "1.0.0" + } + ] +}` + if err := os.WriteFile(filepath.Join(dir, "marketplace.json"), []byte(manifest), 0644); err != nil { + t.Fatalf("Failed to write marketplace manifest: %v", err) + } + pluginDir := filepath.Join(dir, portedPluginName) + if err := os.MkdirAll(pluginDir, 0755); err != nil { + t.Fatalf("Failed to create marketplace plugin directory: %v", err) + } + writePortedSkillFile(t, pluginDir) + return dir +} + +func createPortedDirectPluginFixture(t *testing.T) string { + t.Helper() + dir := t.TempDir() + manifest := `{ + "name": "` + portedDirectPluginName + `", + "description": "E2E demo plugin installed directly from a local path.", + "version": "1.0.0" +}` + if err := os.WriteFile(filepath.Join(dir, "plugin.json"), []byte(manifest), 0644); err != nil { + t.Fatalf("Failed to write direct plugin manifest: %v", err) + } + writePortedSkillFile(t, dir) + return dir +} + +func writePortedSkillFile(t *testing.T, pluginDir string) { + t.Helper() + const skill = `--- +name: go-e2e-skill +description: A demo skill contributed by the E2E test plugin. +--- +# Demo Skill + +This skill exists so the plugin reports at least one installed skill. +` + if err := os.WriteFile(filepath.Join(pluginDir, "SKILL.md"), []byte(skill), 0644); err != nil { + t.Fatalf("Failed to write skill file: %v", err) + } +} + +func getPortedInstalledPlugin(t *testing.T, client *copilot.Client, name, marketplace string) *rpc.InstalledPluginInfo { + t.Helper() + list, err := client.RPC.Plugins.List(t.Context()) + if err != nil { + t.Fatalf("Plugins.List failed: %v", err) + } + plugin := findPortedInstalledPlugin(list.Plugins, name, marketplace) + if plugin == nil { + t.Fatalf("Expected installed plugin %q in marketplace %q, got %+v", name, marketplace, list.Plugins) + } + return plugin +} + +func findPortedInstalledPlugin(plugins []rpc.InstalledPluginInfo, name, marketplace string) *rpc.InstalledPluginInfo { + for i := range plugins { + if plugins[i].Name == name && plugins[i].Marketplace == marketplace { + return &plugins[i] + } + } + return nil +} + +func countPortedInstalledPluginByName(plugins []rpc.InstalledPluginInfo, name string) int { + count := 0 + for _, plugin := range plugins { + if plugin.Name == name { + count++ + } + } + return count +} + +func findPortedMarketplace(marketplaces []rpc.MarketplaceInfo, name string) *rpc.MarketplaceInfo { + for i := range marketplaces { + if marketplaces[i].Name == name { + return &marketplaces[i] + } + } + return nil +} + +func containsPortedDefaultMarketplace(marketplaces []rpc.MarketplaceInfo) bool { + for _, marketplace := range marketplaces { + if marketplace.IsDefault != nil && *marketplace.IsDefault { + return true + } + } + return false +} diff --git a/go/internal/e2e/rpc_server_remote_control_e2e_test.go b/go/internal/e2e/rpc_server_remote_control_e2e_test.go new file mode 100644 index 000000000..7990b32c0 --- /dev/null +++ b/go/internal/e2e/rpc_server_remote_control_e2e_test.go @@ -0,0 +1,112 @@ +package e2e + +import ( + "strings" + "testing" + + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcServerRemoteControl(t *testing.T) { + ctx := testharness.NewTestContext(t) + + t.Run("should_report_remote_control_status_as_off", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + + result, err := client.RPC.Sessions.GetRemoteControlStatus(t.Context()) + if err != nil { + t.Fatalf("Sessions.GetRemoteControlStatus failed: %v", err) + } + assertPortedRemoteControlOff(t, result.Status) + }) + + t.Run("should_treat_set_steering_as_no_op_when_off", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + + result, err := client.RPC.Sessions.SetRemoteControlSteering(t.Context(), &rpc.SessionsSetRemoteControlSteeringRequest{Enabled: false}) + if err != nil { + t.Fatalf("Sessions.SetRemoteControlSteering failed: %v", err) + } + assertPortedRemoteControlOff(t, result.Status) + }) + + t.Run("should_report_not_stopped_when_remote_control_is_off", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + + result, err := client.RPC.Sessions.StopRemoteControl(t.Context(), &rpc.SessionsStopRemoteControlRequest{}) + if err != nil { + t.Fatalf("Sessions.StopRemoteControl failed: %v", err) + } + if result.Stopped { + t.Fatalf("Expected Stopped=false, got %+v", result) + } + assertPortedRemoteControlOff(t, result.Status) + }) + + t.Run("should_reject_transfer_when_off_with_compare_and_swap", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + + from := "rc-from-" + randomHex(t) + result, err := client.RPC.Sessions.TransferRemoteControl(t.Context(), &rpc.SessionsTransferRemoteControlRequest{ + ToSessionID: "rc-to-" + randomHex(t), + ExpectedFromSessionID: &from, + }) + if err != nil { + t.Fatalf("Sessions.TransferRemoteControl failed: %v", err) + } + if result.Transferred { + t.Fatalf("Expected Transferred=false, got %+v", result) + } + assertPortedRemoteControlOff(t, result.Status) + }) + + t.Run("should_reach_runtime_when_starting_remote_control_for_unknown_session", func(t *testing.T) { + ctx.ConfigureForTest(t) + client := newStartedPortedClient(t, ctx) + defer client.ForceStop() + defer func() { + force := true + _, _ = client.RPC.Sessions.StopRemoteControl(t.Context(), &rpc.SessionsStopRemoteControlRequest{Force: &force}) + }() + + _, err := client.RPC.Sessions.StartRemoteControl(t.Context(), &rpc.SessionsStartRemoteControlRequest{ + SessionID: "missing-session-" + randomHex(t), + Config: rpc.RemoteControlConfig{ + Remote: false, + Explicit: false, + Silent: true, + Steerable: false, + }, + }) + if err == nil { + t.Fatal("Expected StartRemoteControl for an unknown session to fail") + } + message := err.Error() + assertPortedNoUnhandledMethod(t, message) + if !strings.Contains(strings.ToLower(message), "session") && !strings.Contains(strings.ToLower(message), "remote") { + t.Fatalf("Expected error to mention session or remote, got %s", message) + } + }) +} + +func assertPortedRemoteControlOff(t *testing.T, status rpc.RemoteControlStatus) { + t.Helper() + if status == nil { + t.Fatal("Expected remote control status, got nil") + } + if status.State() != rpc.RemoteControlStatusStateOff { + t.Fatalf("Expected remote control state off, got %s (%T)", status.State(), status) + } + if _, ok := status.(*rpc.RemoteControlStatusOff); !ok { + t.Fatalf("Expected *RemoteControlStatusOff, got %T", status) + } +} diff --git a/go/internal/e2e/rpc_session_state_e2e_test.go b/go/internal/e2e/rpc_session_state_e2e_test.go index 1744cb10f..4046ab97f 100644 --- a/go/internal/e2e/rpc_session_state_e2e_test.go +++ b/go/internal/e2e/rpc_session_state_e2e_test.go @@ -15,7 +15,7 @@ import ( // // Reuses snapshot files in test/snapshots/rpc_session_state/. Tests that don't issue // LLM calls don't need snapshots. -func TestRpcSessionStateE2E(t *testing.T) { +func TestRPCSessionStateE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -42,8 +42,22 @@ func TestRpcSessionStateE2E(t *testing.T) { } }) + // The runtime caches /models per (auth, base_url) for 30 minutes (see + // capi_client.rs LIST_MODELS_CACHE). Within this test function all subtests + // share one CLI subprocess and proxy URL, so the first subtest's snapshot + // models list is reused by every later one. SwitchTo needs gpt-5.4 in the + // cache; rather than poison every other snapshot we give this subtest its + // own dedicated client + proxy → its own cache entry. t.Run("should call session rpc model switchTo", func(t *testing.T) { - session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + switchCtx := testharness.NewTestContext(t) + switchClient := switchCtx.NewClient() + t.Cleanup(func() { switchClient.ForceStop() }) + if err := switchClient.Start(t.Context()); err != nil { + t.Fatalf("Failed to start switch client: %v", err) + } + switchCtx.ConfigureForTest(t) + + session, err := switchClient.CreateSession(t.Context(), &copilot.SessionConfig{ Model: "claude-sonnet-4.5", OnPermissionRequest: copilot.PermissionHandler.ApproveAll, }) @@ -61,21 +75,21 @@ func TestRpcSessionStateE2E(t *testing.T) { reasoningEffort := "high" result, err := session.RPC.Model.SwitchTo(t.Context(), &rpc.ModelSwitchToRequest{ - ModelID: "gpt-4.1", + ModelID: "gpt-5.4", ReasoningEffort: &reasoningEffort, }) if err != nil { t.Fatalf("Model.SwitchTo failed: %v", err) } - if result.ModelID == nil || *result.ModelID != "gpt-4.1" { - t.Fatalf("Expected switch result model gpt-4.1, got %+v", result) + if result.ModelID == nil || *result.ModelID != "gpt-5.4" { + t.Fatalf("Expected switch result model gpt-5.4, got %+v", result) } after, err := session.RPC.Model.GetCurrent(t.Context()) if err != nil { t.Fatalf("Model.GetCurrent after switch failed: %v", err) } - if after.ModelID == nil || (*after.ModelID != "gpt-4.1" && *after.ModelID != *before.ModelID) { - t.Fatalf("Unexpected current model after switch; before=%q after=%+v", *before.ModelID, after) + if after.ModelID == nil || *after.ModelID != "gpt-5.4" { + t.Fatalf("Model.GetCurrent did not reflect SwitchTo; before=%q after=%+v", *before.ModelID, after) } }) @@ -468,7 +482,6 @@ func TestRpcSessionStateE2E(t *testing.T) { t.Run("should call metadata snapshot set working directory and record context change", func(t *testing.T) { firstDirectory := createUniqueRPCWorkDirectory(t, ctx, "rpc-session-state-first") secondDirectory := createUniqueRPCWorkDirectory(t, ctx, "rpc-session-state-second") - contextDirectory := createUniqueRPCWorkDirectory(t, ctx, "rpc-session-state-context") branch := "rpc-context-" + randomHex(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ @@ -515,12 +528,15 @@ func TestRpcSessionStateE2E(t *testing.T) { repo := "github/copilot-sdk-e2e" repoHost := "github.com" - hostType := rpc.SessionWorkingDirectoryContextHostTypeGithub + hostType := rpc.SessionWorkingDirectoryContextHostTypeGitHub baseCommit := "0000000000000000000000000000000000000000" headCommit := "1111111111111111111111111111111111111111" + // For local sessions the CLI treats the session cwd as authoritative, so a + // RecordContextChange that reports a divergent cwd is ignored and emits no event. + // Report the current working directory (secondDirectory) to observe the change. if _, err := session.RPC.Metadata.RecordContextChange(t.Context(), &rpc.MetadataRecordContextChangeRequest{ Context: rpc.SessionWorkingDirectoryContext{ - Cwd: contextDirectory, + Cwd: secondDirectory, GitRoot: &firstDirectory, Branch: &branch, Repository: &repo, @@ -534,7 +550,7 @@ func TestRpcSessionStateE2E(t *testing.T) { } contextChanged := awaitEvent(t, awaitContextChanged) data := contextChanged.Data.(*copilot.SessionContextChangedData) - assertRPCPathEqual(t, contextDirectory, data.Cwd) + assertRPCPathEqual(t, secondDirectory, data.Cwd) if data.GitRoot == nil { t.Fatal("Expected context changed git root") } @@ -690,7 +706,7 @@ func TestRpcSessionStateE2E(t *testing.T) { api := ctx.ProxyURL telemetry := "https://localhost:1/telemetry" - setCredentials, err := session.RPC.Auth.SetCredentials(t.Context(), &rpc.SessionSetCredentialsParams{ + setCredentials, err := session.RPC.GitHubAuth.SetCredentials(t.Context(), &rpc.SessionSetCredentialsParams{ Credentials: &rpc.UserAuthInfo{ CopilotUser: &rpc.CopilotUserResponse{ AnalyticsTrackingID: rpcPtr("rpc-session-state-tracking-id"), @@ -713,7 +729,7 @@ func TestRpcSessionStateE2E(t *testing.T) { t.Fatalf("Expected Auth.SetCredentials Success=true, got %+v", setCredentials) } - status, err := session.RPC.Auth.GetStatus(t.Context()) + status, err := session.RPC.GitHubAuth.GetStatus(t.Context()) if err != nil { t.Fatalf("Auth.GetStatus failed: %v", err) } @@ -1067,7 +1083,7 @@ func TestRpcSessionStateE2E(t *testing.T) { t.Errorf("Expected SetApproveAll(true) to succeed, got %+v", approve) } - reset, err := session.RPC.Permissions.ResetSessionApprovals(t.Context()) + reset, err := session.RPC.Permissions.ResetSessionApprovals(t.Context(), &rpc.PermissionsResetSessionApprovalsRequest{}) if err != nil { t.Fatalf("Failed to call ResetSessionApprovals: %v", err) } @@ -1097,9 +1113,9 @@ func TestRpcSessionStateE2E(t *testing.T) { t.Errorf("session.history.truncate should be implemented; error suggests it isn't: %v", err) } - _, err = session.RPC.Mcp.Oauth().Login(t.Context(), &rpc.McpOauthLoginRequest{ServerName: "missing-server"}) + _, err = session.RPC.MCP.Oauth().Login(t.Context(), &rpc.MCPOauthLoginRequest{ServerName: "missing-server"}) if err == nil { - t.Fatal("Expected Mcp.Oauth.Login with unknown server to fail") + t.Fatal("Expected MCP.Oauth.Login with unknown server to fail") } if strings.Contains(strings.ToLower(err.Error()), "unhandled method session.mcp.oauth.login") { t.Errorf("session.mcp.oauth.login should be implemented; error suggests it isn't: %v", err) diff --git a/go/internal/e2e/rpc_session_state_extras_e2e_test.go b/go/internal/e2e/rpc_session_state_extras_e2e_test.go new file mode 100644 index 000000000..1e33e8a8b --- /dev/null +++ b/go/internal/e2e/rpc_session_state_extras_e2e_test.go @@ -0,0 +1,351 @@ +package e2e + +import ( + "encoding/json" + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcSessionStateExtras(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should_list_models_for_session", func(t *testing.T) { + ctx.ConfigureForTest(t) + const token = "rpc-session-model-list-token" + registerProxyUser(t, ctx, token, "rpc-session-extras-user", nil) + authClient := newAuthenticatedClient(ctx, token) + defer authClient.ForceStop() + + session := createPortedSession(t, authClient, &copilot.SessionConfig{Model: "claude-sonnet-4.5"}) + defer session.Disconnect() + + result, err := session.RPC.Model.List(t.Context()) + if err != nil { + t.Fatalf("Model.List failed: %v", err) + } + if result.List == nil { + t.Fatal("Expected non-nil model list") + } + if len(result.List) == 0 { + t.Fatal("Expected non-empty model list") + } + found := false + for _, model := range result.List { + data, err := json.Marshal(model) + if err == nil && strings.Contains(string(data), "claude-sonnet-4.5") { + found = true + break + } + } + if !found { + t.Fatalf("Expected model list to include claude-sonnet-4.5, got %+v", result.List) + } + }) + + t.Run("should_report_session_activity_when_idle", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + activity, err := session.RPC.Metadata.Activity(t.Context()) + if err != nil { + t.Fatalf("Metadata.Activity failed: %v", err) + } + if activity.HasActiveWork { + t.Fatal("Expected a fresh session to report no active work") + } + if activity.Abortable { + t.Fatal("Expected a fresh session to have nothing abortable") + } + }) + + t.Run("should_get_and_set_allowall_permissions", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + defer func() { + _, _ = session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(false)}) + }() + + initial, err := session.RPC.Permissions.GetAllowAll(t.Context()) + if err != nil { + t.Fatalf("Permissions.GetAllowAll initial failed: %v", err) + } + if initial.Enabled { + t.Fatal("Allow-all should be disabled on a fresh session") + } + + enable, err := session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(true)}) + if err != nil { + t.Fatalf("Permissions.SetAllowAll(true) failed: %v", err) + } + if !enable.Success || !enable.Enabled { + t.Fatalf("Expected successful enable, got %+v", enable) + } + afterEnable, err := session.RPC.Permissions.GetAllowAll(t.Context()) + if err != nil { + t.Fatalf("Permissions.GetAllowAll after enable failed: %v", err) + } + if !afterEnable.Enabled { + t.Fatal("Expected allow-all to be enabled") + } + + disable, err := session.RPC.Permissions.SetAllowAll(t.Context(), &rpc.PermissionsSetAllowAllRequest{Enabled: copilot.Bool(false)}) + if err != nil { + t.Fatalf("Permissions.SetAllowAll(false) failed: %v", err) + } + if !disable.Success || disable.Enabled { + t.Fatalf("Expected successful disable, got %+v", disable) + } + afterDisable, err := session.RPC.Permissions.GetAllowAll(t.Context()) + if err != nil { + t.Fatalf("Permissions.GetAllowAll after disable failed: %v", err) + } + if afterDisable.Enabled { + t.Fatal("Expected allow-all to be disabled") + } + }) + + t.Run("should_read_empty_sql_todos_for_fresh_session", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + result, err := session.RPC.Plan.ReadSqlTodos(t.Context()) + if err != nil { + t.Fatalf("Plan.ReadSqlTodos failed: %v", err) + } + if result.Rows == nil { + t.Fatal("Expected non-nil SQL todo rows") + } + if len(result.Rows) != 0 { + t.Fatalf("Expected empty SQL todo rows, got %+v", result.Rows) + } + }) + + t.Run("should_get_telemetry_engagement_id", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + result, err := session.RPC.Telemetry.GetEngagementId(t.Context()) + if err != nil { + t.Fatalf("Telemetry.GetEngagementId failed: %v", err) + } + if result == nil { + t.Fatal("Expected non-nil telemetry engagement result") + } + }) + + t.Run("should_get_current_tool_metadata_after_initialization", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + answer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "What is 2+2?"}) + if err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + if answer == nil { + t.Fatal("Expected a final assistant message") + } + + result, err := session.RPC.Tools.GetCurrentMetadata(t.Context()) + if err != nil { + t.Fatalf("Tools.GetCurrentMetadata failed: %v", err) + } + if result.Tools == nil { + t.Fatal("Expected non-nil current tool metadata") + } + if len(result.Tools) == 0 { + t.Fatal("Expected non-empty current tool metadata") + } + for _, tool := range result.Tools { + if strings.TrimSpace(tool.Name) == "" { + t.Fatalf("Expected non-empty tool name, got %+v", tool) + } + if strings.TrimSpace(tool.Description) == "" { + t.Fatalf("Expected non-empty tool description, got %+v", tool) + } + } + }) + + t.Run("should_add_byok_provider_and_model_at_runtime", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + apiKey := "provider-key" + providerType := rpc.ProviderConfigTypeOpenai + wireAPI := rpc.ProviderConfigWireAPICompletions + modelName := "Go Added Model" + maxPromptTokens := float64(4096) + result, err := session.RPC.Provider.Add(t.Context(), &rpc.ProviderAddRequest{ + Providers: []rpc.NamedProviderConfig{{ + Name: "go-e2e-provider", + Type: &providerType, + BaseURL: "https://models.example.test/v1", + APIKey: &apiKey, + Headers: map[string]string{"x-provider": "go"}, + WireAPI: &wireAPI, + }}, + Models: []rpc.ProviderModelConfig{{ + ID: "small", + Provider: "go-e2e-provider", + Name: &modelName, + MaxPromptTokens: &maxPromptTokens, + }}, + }) + if err != nil { + t.Fatalf("Provider.Add failed: %v", err) + } + if len(result.Models) != 1 { + t.Fatalf("Expected one added provider model, got %+v", result.Models) + } + + selectionID := "go-e2e-provider/small" + if _, err := session.RPC.Model.SwitchTo(t.Context(), &rpc.ModelSwitchToRequest{ModelID: selectionID}); err != nil { + t.Fatalf("Model.SwitchTo added model failed: %v", err) + } + current, err := session.RPC.Model.GetCurrent(t.Context()) + if err != nil { + t.Fatalf("Model.GetCurrent after provider add failed: %v", err) + } + if current.ModelID == nil || *current.ModelID != selectionID { + t.Fatalf("Expected current model %q, got %+v", selectionID, current) + } + }) + + t.Run("should_return_empty_completions_when_host_does_not_provide_them", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + result, err := session.RPC.Completions.Request(t.Context(), &rpc.CompletionsRequestRequest{ + Text: "Use @ to mention context", + Offset: 5, + }) + if err != nil { + t.Fatalf("Completions.Request failed: %v", err) + } + if result.Items == nil { + t.Fatal("Expected non-nil completion items list") + } + }) + + t.Run("should_report_visibility_as_unsynced_for_local_session", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + status := rpc.SessionVisibilityStatusUnshared + set, err := session.RPC.Visibility.Set(t.Context(), &rpc.VisibilitySetRequest{Status: status}) + if err != nil { + t.Fatalf("Visibility.Set failed: %v", err) + } + if set.Synced || set.Status != nil || set.ShareURL != nil { + t.Fatalf("Expected unsynced visibility set result, got %+v", set) + } + get, err := session.RPC.Visibility.Get(t.Context()) + if err != nil { + t.Fatalf("Visibility.Get failed: %v", err) + } + if get.Synced || get.Status != nil || get.ShareURL != nil { + t.Fatalf("Expected unsynced visibility get result, got %+v", get) + } + }) + + t.Run("should_get_context_attribution_and_heaviest_messages_after_turn", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + answer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "Say CONTEXT_METADATA_OK exactly."}) + if err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + if answer == nil { + t.Fatal("Expected final assistant message") + } + + attribution, err := session.RPC.Metadata.GetContextAttribution(t.Context()) + if err != nil { + t.Fatalf("Metadata.GetContextAttribution failed: %v", err) + } + if attribution == nil { + t.Fatal("Expected attribution result") + } + limit := int64(5) + heaviest, err := session.RPC.Metadata.GetContextHeaviestMessages(t.Context(), &rpc.MetadataContextHeaviestMessagesRequest{Limit: &limit}) + if err != nil { + t.Fatalf("Metadata.GetContextHeaviestMessages failed: %v", err) + } + if heaviest.Messages == nil { + t.Fatal("Expected non-nil heaviest messages list") + } + }) + + t.Run("should_update_and_clear_live_subagent_settings", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + contextTier := rpc.SubagentSettingsEntryContextTierLongContext + model := "gpt-5-mini" + reasoningEffort := "low" + update, err := session.RPC.Tools.UpdateSubagentSettings(t.Context(), &rpc.UpdateSubagentSettingsRequest{ + Subagents: &rpc.SubagentSettings{ + DisabledSubagents: []string{"legacy-agent"}, + Agents: map[string]rpc.SubagentSettingsEntry{ + "general-purpose": { + ContextTier: &contextTier, + Model: &model, + EffortLevel: &reasoningEffort, + }, + }, + }, + }) + if err != nil { + t.Fatalf("Tools.UpdateSubagentSettings failed: %v", err) + } + if update == nil { + t.Fatal("Expected update result") + } + + clear, err := session.RPC.Tools.UpdateSubagentSettings(t.Context(), &rpc.UpdateSubagentSettingsRequest{}) + if err != nil { + t.Fatalf("Tools.UpdateSubagentSettings clear failed: %v", err) + } + if clear == nil { + t.Fatal("Expected clear result") + } + }) + + t.Run("should_reload_session_plugins", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + if _, err := session.RPC.Plugins.Reload(t.Context()); err != nil { + t.Fatalf("Plugins.Reload failed: %v", err) + } + plugins, err := session.RPC.Plugins.List(t.Context()) + if err != nil { + t.Fatalf("Plugins.List failed: %v", err) + } + if plugins.Plugins == nil { + t.Fatal("Expected non-nil session plugin list") + } + for _, plugin := range plugins.Plugins { + if strings.TrimSpace(plugin.Name) == "" { + t.Fatalf("Expected non-empty plugin name, got %+v", plugin) + } + } + }) +} diff --git a/go/internal/e2e/rpc_shell_and_fleet_e2e_test.go b/go/internal/e2e/rpc_shell_and_fleet_e2e_test.go index 7655d179e..81b8471da 100644 --- a/go/internal/e2e/rpc_shell_and_fleet_e2e_test.go +++ b/go/internal/e2e/rpc_shell_and_fleet_e2e_test.go @@ -17,7 +17,7 @@ import ( ) // Mirrors dotnet/test/RpcShellAndFleetTests.cs (snapshot category "rpc_shell_and_fleet"). -func TestRpcShellAndFleetE2E(t *testing.T) { +func TestRPCShellAndFleetE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -55,6 +55,7 @@ func TestRpcShellAndFleetE2E(t *testing.T) { if err != nil { t.Fatalf("Failed to create session: %v", err) } + t.Cleanup(func() { _ = session.Disconnect() }) var command string if runtime.GOOS == "windows" { diff --git a/go/internal/e2e/rpc_shell_user_requested_e2e_test.go b/go/internal/e2e/rpc_shell_user_requested_e2e_test.go new file mode 100644 index 000000000..0c388a3c1 --- /dev/null +++ b/go/internal/e2e/rpc_shell_user_requested_e2e_test.go @@ -0,0 +1,140 @@ +package e2e + +import ( + "fmt" + "os" + "path/filepath" + "runtime" + "strings" + "testing" + "time" + + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcShellUserRequested(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should_execute_user_requested_shell_command", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + marker := "copilotusershell" + randomHex(t) + requestID := "req-" + randomHex(t) + + result, err := session.RPC.Shell.ExecuteUserRequested(t.Context(), &rpc.ShellExecuteUserRequestedRequest{ + RequestID: requestID, + Command: "echo " + marker, + }) + if err != nil { + t.Fatalf("Shell.ExecuteUserRequested failed: %v", err) + } + if !result.Success { + t.Fatalf("Expected shell command to succeed, got error %v", result.Error) + } + if result.ExitCode == nil || *result.ExitCode != 0 { + t.Fatalf("Expected exit code 0, got %v", result.ExitCode) + } + if !strings.Contains(result.Output, marker) { + t.Fatalf("Expected output to contain %q, got %q", marker, result.Output) + } + if strings.TrimSpace(result.ToolCallID) == "" { + t.Fatal("Expected non-empty tool call ID") + } + }) + + t.Run("should_cancel_user_requested_shell_command", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + missing, err := session.RPC.Shell.CancelUserRequested(t.Context(), &rpc.ShellCancelUserRequestedRequest{RequestID: "missing-" + randomHex(t)}) + if err != nil { + t.Fatalf("Shell.CancelUserRequested(missing) failed: %v", err) + } + if missing.Cancelled { + t.Fatal("Expected cancelling an unknown request to return Cancelled=false") + } + + requestID := "req-" + randomHex(t) + markerPath := filepath.Join(os.TempDir(), "shell-cancel-"+randomHex(t)+".txt") + defer tryRemovePortedFile(markerPath) + + type executeResult struct { + result *rpc.UserRequestedShellCommandResult + err error + } + executeCh := make(chan executeResult, 1) + execDone := false + go func() { + result, err := session.RPC.Shell.ExecuteUserRequested(t.Context(), &rpc.ShellExecuteUserRequestedRequest{ + RequestID: requestID, + Command: createPortedMarkerThenSleepCommand(markerPath, 60), + }) + executeCh <- executeResult{result: result, err: err} + }() + defer func() { + if execDone { + return + } + _, _ = session.RPC.Shell.CancelUserRequested(t.Context(), &rpc.ShellCancelUserRequestedRequest{RequestID: requestID}) + select { + case <-executeCh: + case <-time.After(30 * time.Second): + } + }() + + waitForRPCCondition(t, 30*time.Second, "user-requested shell marker file", func() (bool, error) { + _, err := os.Stat(markerPath) + if err == nil { + return true, nil + } + if os.IsNotExist(err) { + return false, nil + } + return false, err + }) + + waitForRPCCondition(t, 15*time.Second, "user-requested shell command to become cancellable", func() (bool, error) { + cancel, err := session.RPC.Shell.CancelUserRequested(t.Context(), &rpc.ShellCancelUserRequestedRequest{RequestID: requestID}) + if err != nil { + return false, err + } + return cancel.Cancelled, nil + }) + + select { + case execution := <-executeCh: + execDone = true + if execution.err != nil { + t.Fatalf("ExecuteUserRequested returned error after cancellation: %v", execution.err) + } + if execution.result == nil { + t.Fatal("Expected execution result after cancellation") + } + if execution.result.Success { + t.Fatalf("Expected cancelled execution to be unsuccessful, got %+v", execution.result) + } + case <-time.After(30 * time.Second): + t.Fatal("Timed out waiting for cancelled user-requested shell command to finish") + } + }) +} + +func createPortedMarkerThenSleepCommand(markerPath string, seconds int) string { + if runtime.GOOS == "windows" { + escaped := strings.ReplaceAll(markerPath, "'", "''") + return fmt.Sprintf("Set-Content -LiteralPath '%s' -Value 'running'; Start-Sleep -Seconds %d", escaped, seconds) + } + escaped := strings.ReplaceAll(markerPath, "'", "'\\''") + return fmt.Sprintf("echo running > '%s'; sleep %d", escaped, seconds) +} + +func tryRemovePortedFile(path string) { + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + _ = err + } +} diff --git a/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go b/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go index bda0f2ad3..0267f8d04 100644 --- a/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go +++ b/go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go @@ -11,7 +11,7 @@ import ( ) // Mirrors dotnet/test/RpcTasksAndHandlersTests.cs (snapshot category "rpc_tasks_and_handlers"). -func TestRpcTasksAndHandlersE2E(t *testing.T) { +func TestRPCTasksAndHandlersE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -302,6 +302,39 @@ func TestRpcTasksAndHandlersE2E(t *testing.T) { if locationApproval.Success { t.Error("Expected Success=false for missing location approval request id") } + + sessionLimits, err := session.RPC.UI.HandlePendingSessionLimitsExhausted(t.Context(), &rpc.UIHandlePendingSessionLimitsExhaustedRequest{ + RequestID: "missing-session-limits-request", + Response: rpc.UISessionLimitsExhaustedResponse{Action: rpc.UISessionLimitsExhaustedResponseActionCancel}, + }) + if err != nil { + t.Fatalf("UI.HandlePendingSessionLimitsExhausted failed: %v", err) + } + if sessionLimits.Success { + t.Error("Expected Success=false for missing session limits request id") + } + + headers, err := session.RPC.MCP.Headers().HandlePendingHeadersRefreshRequest(t.Context(), &rpc.MCPHeadersHandlePendingHeadersRefreshRequestRequest{ + RequestID: "missing-headers-refresh-request", + Result: rpc.MCPHeadersHandlePendingHeadersRefreshRequestHeaders{Headers: map[string]string{"authorization": "Bearer refreshed"}}, + }) + if err != nil { + t.Fatalf("MCP.Headers.HandlePendingHeadersRefreshRequest failed: %v", err) + } + if headers.Success { + t.Error("Expected Success=false for missing MCP headers refresh request id") + } + + noHeaders, err := session.RPC.MCP.Headers().HandlePendingHeadersRefreshRequest(t.Context(), &rpc.MCPHeadersHandlePendingHeadersRefreshRequestRequest{ + RequestID: "missing-headers-refresh-none-request", + Result: rpc.MCPHeadersHandlePendingHeadersRefreshRequestNone{}, + }) + if err != nil { + t.Fatalf("MCP.Headers.HandlePendingHeadersRefreshRequest none failed: %v", err) + } + if noHeaders.Success { + t.Error("Expected Success=false for missing MCP headers refresh none request id") + } }) t.Run("should round trip rpc elicitation through config handler", func(t *testing.T) { @@ -311,7 +344,7 @@ func TestRpcTasksAndHandlersE2E(t *testing.T) { OnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) { handlerContext <- ctx return copilot.ElicitationResult{ - Action: "accept", + Action: copilot.ElicitationActionAccept, Content: map[string]any{ "answer": "from handler", "confirmed": true, @@ -347,7 +380,7 @@ func TestRpcTasksAndHandlersE2E(t *testing.T) { if ctx.SessionID != session.SessionID || ctx.Message != "Need details" { t.Fatalf("Unexpected elicitation context: %+v", ctx) } - if _, ok := ctx.RequestedSchema["properties"]; !ok { + if ctx.RequestedSchema == nil || ctx.RequestedSchema.Properties == nil { t.Fatalf("Expected requested schema to include properties, got %+v", ctx.RequestedSchema) } if response.Action != rpc.UIElicitationResponseActionAccept { diff --git a/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go b/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go new file mode 100644 index 000000000..2669faea9 --- /dev/null +++ b/go/internal/e2e/rpc_ui_ephemeral_query_e2e_test.go @@ -0,0 +1,38 @@ +package e2e + +import ( + "strings" + "testing" + + "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestRpcUiEphemeralQuery(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should_answer_ephemeral_query", func(t *testing.T) { + ctx.ConfigureForTest(t) + session := createPortedSession(t, client, nil) + defer session.Disconnect() + + result, err := session.RPC.UI.EphemeralQuery(t.Context(), &rpc.UIEphemeralQueryRequest{ + Question: "In one word, what is the primary color of a clear daytime sky?", + }) + if err != nil { + t.Fatalf("UI.EphemeralQuery failed: %v", err) + } + if result == nil { + t.Fatal("Expected non-nil ephemeral query result") + return + } + if strings.TrimSpace(result.Answer) == "" { + t.Fatal("Expected non-empty ephemeral query answer") + } + if !strings.Contains(strings.ToLower(result.Answer), "blue") { + t.Fatalf("Expected answer to contain blue, got %q", result.Answer) + } + }) +} diff --git a/go/internal/e2e/rpc_workspace_checkpoints_e2e_test.go b/go/internal/e2e/rpc_workspace_checkpoints_e2e_test.go index a11a2fef2..849e3a5fa 100644 --- a/go/internal/e2e/rpc_workspace_checkpoints_e2e_test.go +++ b/go/internal/e2e/rpc_workspace_checkpoints_e2e_test.go @@ -11,7 +11,7 @@ import ( ) // Mirrors dotnet/test/E2E/RpcWorkspaceCheckpointsE2ETests.cs (snapshot category "rpc_workspace_checkpoints"). -func TestRpcWorkspaceCheckpointsE2E(t *testing.T) { +func TestRPCWorkspaceCheckpointsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -33,6 +33,11 @@ func TestRpcWorkspaceCheckpointsE2E(t *testing.T) { }) t.Run("should return nil or empty content for unknown checkpoint", func(t *testing.T) { + // In-process, session.workspaces.readCheckpoint is answered by the native + // runtime, which decodes the checkpoint number as a u32 and rejects the + // large sentinel this test uses. Covered by the default (stdio) transport. + // Mirrors Rust's should_return_null_or_empty_content_for_unknown_checkpoint. + testharness.SkipIfInProcess(t, "readCheckpoint decodes the id as u32 in-process") session := createWorkspaceRPCSession(t, client) defer session.Disconnect() diff --git a/go/internal/e2e/session_config_e2e_test.go b/go/internal/e2e/session_config_e2e_test.go index e5daf931b..2ce48e3b3 100644 --- a/go/internal/e2e/session_config_e2e_test.go +++ b/go/internal/e2e/session_config_e2e_test.go @@ -5,13 +5,16 @@ import ( "encoding/base64" "encoding/json" "fmt" + "net/http" "os" "path/filepath" "strings" "testing" + "time" copilot "github.com/github/copilot-sdk/go" "github.com/github/copilot-sdk/go/internal/e2e/testharness" + "github.com/github/copilot-sdk/go/rpc" ) // hasImageURLContent returns true if any user message in the given exchanges @@ -36,6 +39,126 @@ func hasImageURLContent(exchanges []testharness.ParsedHttpExchange) bool { return false } +func sendAndGetNextExchange(t *testing.T, ctx *testharness.TestContext, session *copilot.Session, prompt string) testharness.ParsedHttpExchange { + t.Helper() + + existing, err := ctx.GetExchanges() + if err != nil { + t.Fatalf("GetExchanges failed: %v", err) + } + if _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: prompt}); err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + exchanges := ctx.WaitForExchanges(t, len(existing)+1) + return exchanges[len(existing)] +} + +func assertSessionLimitsStatus(t *testing.T, exchange testharness.ParsedHttpExchange, expectedRemaining string) { + t.Helper() + + for _, message := range exchange.Request.Messages { + if message.Role != "user" || !strings.Contains(message.Content, "") { + continue + } + if !strings.Contains(message.Content, "Remaining session limits: "+expectedRemaining+".") { + t.Fatalf("Expected session limits status to include remaining %q, got %q", expectedRemaining, message.Content) + } + if !strings.Contains(message.Content, "Be frugal; avoid optional exploration and unnecessary tool calls.") { + t.Fatalf("Expected frugality instruction in session limits status, got %q", message.Content) + } + return + } + t.Fatal("Expected session limits status message") +} + +func getTaskAgentTypes(t *testing.T, exchange testharness.ParsedHttpExchange) []string { + t.Helper() + + for _, tool := range exchange.Request.Tools { + if tool.Function.Name != "task" { + continue + } + var parameters struct { + Properties struct { + AgentType struct { + Enum []string `json:"enum"` + } `json:"agent_type"` + } `json:"properties"` + } + if err := json.Unmarshal(tool.Function.Parameters, ¶meters); err != nil { + t.Fatalf("Failed to unmarshal task tool parameters: %v", err) + } + return parameters.Properties.AgentType.Enum + } + t.Fatal("Expected task tool in request") + return nil +} + +func containsAgentType(values []string, needle string) bool { + for _, value := range values { + if value == needle { + return true + } + } + return false +} + +func createPDFAttachment() copilot.Attachment { + pdfText := "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n" + data := base64.StdEncoding.EncodeToString([]byte(pdfText)) + displayName := "citation-source.pdf" + return copilot.AttachmentBlob{ + Data: &data, + DisplayName: &displayName, + MIMEType: "application/pdf", + } +} + +func createAnthropicProvider() *copilot.ProviderConfig { + return &copilot.ProviderConfig{ + Type: "anthropic", + BaseURL: "https://anthropic-citations.invalid/v1", + APIKey: "test-provider-key", + ModelID: "claude-sonnet-4.5", + WireModel: "claude-sonnet-4.5", + } +} + +func assertAnthropicDocumentCitationsEnabled(t *testing.T, requestBody string) { + t.Helper() + + var body struct { + Messages []struct { + Content []map[string]any `json:"content"` + } `json:"messages"` + } + if err := json.Unmarshal([]byte(requestBody), &body); err != nil { + t.Fatalf("Failed to unmarshal Anthropic request body: %v", err) + } + var documents []map[string]any + for _, message := range body.Messages { + for _, block := range message.Content { + if block["type"] == "document" { + documents = append(documents, block) + } + } + } + if len(documents) != 1 { + t.Fatalf("Expected one Anthropic document block, got %d in body %s", len(documents), requestBody) + } + if documents[0]["title"] != "citation-source.pdf" { + t.Fatalf("Expected document title citation-source.pdf, got %v", documents[0]["title"]) + } + citations, ok := documents[0]["citations"].(map[string]any) + if !ok || citations["enabled"] != true { + t.Fatalf("Expected document citations.enabled=true, got %#v", documents[0]["citations"]) + } +} + +func float64Ref(value float64) *float64 { + return &value +} + func TestSessionConfigE2E(t *testing.T) { ctx := testharness.NewTestContext(t) client := ctx.NewClient() @@ -165,6 +288,224 @@ func TestSessionConfigE2E(t *testing.T) { }) } +func TestSessionConfigNewOptionsE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + t.Run("should apply session limits on create", func(t *testing.T) { + ctx.ConfigureForTest(t) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ref(30)}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + exchange := sendAndGetNextExchange(t, ctx, session, "Acknowledge the current session limits.") + assertSessionLimitsStatus(t, exchange, "30 AI credits") + }) + + t.Run("should apply session limits on resume", func(t *testing.T) { + ctx.ConfigureForTest(t) + + session1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session1.Disconnect() + + session2, err := client.ResumeSessionWithOptions(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SessionLimits: &rpc.SessionLimitsConfig{MaxAiCredits: float64Ref(30)}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + defer session2.Disconnect() + + exchange := sendAndGetNextExchange(t, ctx, session2, "Acknowledge the current session limits.") + assertSessionLimitsStatus(t, exchange, "30 AI credits") + }) + + t.Run("should apply excluded built in agents on create", func(t *testing.T) { + ctx.ConfigureForTest(t) + + const excludedAgent = "explore" + const prompt = "What is 1+1?" + baseline, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession baseline failed: %v", err) + } + baselineExchange := sendAndGetNextExchange(t, ctx, baseline, prompt) + if !containsAgentType(getTaskAgentTypes(t, baselineExchange), excludedAgent) { + t.Fatalf("Expected baseline task agents to include %q", excludedAgent) + } + _ = baseline.Disconnect() + + excluded, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + ExcludedBuiltInAgents: []string{excludedAgent}, + }) + if err != nil { + t.Fatalf("CreateSession excluded failed: %v", err) + } + defer excluded.Disconnect() + + excludedExchange := sendAndGetNextExchange(t, ctx, excluded, prompt) + agentTypes := getTaskAgentTypes(t, excludedExchange) + if len(agentTypes) == 0 { + t.Fatal("Expected task tool agent types") + } + if containsAgentType(agentTypes, excludedAgent) { + t.Fatalf("Expected excluded task agents not to include %q; got %v", excludedAgent, agentTypes) + } + }) + + t.Run("should apply excluded built in agents on resume", func(t *testing.T) { + ctx.ConfigureForTest(t) + + const excludedAgent = "explore" + session1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session1.Disconnect() + + session2, err := client.ResumeSessionWithOptions(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + ExcludedBuiltInAgents: []string{excludedAgent}, + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + defer session2.Disconnect() + + exchange := sendAndGetNextExchange(t, ctx, session2, "What is 1+1?") + agentTypes := getTaskAgentTypes(t, exchange) + if len(agentTypes) == 0 { + t.Fatal("Expected task tool agent types") + } + if containsAgentType(agentTypes, excludedAgent) { + t.Fatalf("Expected excluded task agents not to include %q; got %v", excludedAgent, agentTypes) + } + }) +} + +func TestSessionConfigNewOptionsCopilotRequestE2E(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") + t.Run("should enable citations for Anthropic file attachments on create", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + transport := &recordingTransport{} + handler := &copilot.CopilotRequestHandler{Transport: transport} + client := newCopilotRequestClient(ctx, handler) + t.Cleanup(func() { client.ForceStop() }) + + if err := client.Start(t.Context()); err != nil { + t.Fatalf("Failed to start client: %v", err) + } + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: "claude-sonnet-4.5", + EnableCitations: copilot.Bool(true), + Provider: createAnthropicProvider(), + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session.Disconnect() + + _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Summarize the attached PDF with citations enabled.", + Attachments: []copilot.Attachment{createPDFAttachment()}, + }) + if err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + + inference := transport.inferenceRecords() + if len(inference) != 1 { + t.Fatalf("Expected exactly one intercepted inference request, got %d", len(inference)) + } + assertAnthropicDocumentCitationsEnabled(t, inference[0].body) + }) + + t.Run("should enable citations for Anthropic file attachments on resume", func(t *testing.T) { + ctx := testharness.NewTestContext(t) + transport := &recordingTransport{} + handler := &copilot.CopilotRequestHandler{Transport: transport} + const connectionToken = "go-citation-resume-token" + server := ctx.NewClient(func(o *copilot.ClientOptions) { + o.Connection = copilot.TCPConnection{Path: ctx.CLIPath, ConnectionToken: connectionToken} + o.RequestHandler = handler + }) + t.Cleanup(func() { server.ForceStop() }) + + if err := server.Start(t.Context()); err != nil { + t.Fatalf("Failed to start server client: %v", err) + } + + session1, err := server.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + defer session1.Disconnect() + + runtimePort := server.RuntimePort() + if runtimePort == 0 { + t.Fatal("Expected non-zero runtime port") + } + resumeClient := ctx.NewClient(func(o *copilot.ClientOptions) { + o.Connection = copilot.URIConnection{ + URL: fmt.Sprintf("localhost:%d", runtimePort), + ConnectionToken: connectionToken, + } + }) + t.Cleanup(func() { resumeClient.ForceStop() }) + + session2, err := resumeClient.ResumeSessionWithOptions(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: "claude-sonnet-4.5", + EnableCitations: copilot.Bool(true), + Provider: createAnthropicProvider(), + }) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + defer session2.Disconnect() + + _, err = session2.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Summarize the attached PDF with citations enabled.", + Attachments: []copilot.Attachment{createPDFAttachment()}, + }) + if err != nil { + t.Fatalf("SendAndWait failed: %v", err) + } + + inference := transport.inferenceRecords() + if len(inference) != 1 { + t.Fatalf("Expected exactly one intercepted inference request, got %d", len(inference)) + } + assertAnthropicDocumentCitationsEnabled(t, inference[0].body) + }) +} + // TestSessionConfigExtras mirrors the additional Should_* tests in dotnet/test/SessionConfigTests.cs: // // Should_Use_Custom_SessionId @@ -649,6 +990,79 @@ func TestSessionConfigExtrasE2E(t *testing.T) { t.Errorf("Expected toolNames=[view], got %v", toolNames) } }) + + t.Run("should apply GitHub MCP tool config on create", func(t *testing.T) { + ctx.ConfigureForTest(t) + enableAllTools := true + enableInsidersMode := true + disableFormDeferral := true + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + EnableConfigDiscovery: copilot.Bool(true), + EnableMCPApps: true, + GitHubMCPToolConfig: &copilot.GitHubMCPToolConfig{ + EnableAllTools: &enableAllTools, + AdditionalToolsets: []string{"actions"}, + AdditionalTools: []string{"get_me"}, + EnableInsidersMode: &enableInsidersMode, + DisableFormDeferral: &disableFormDeferral, + }, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + t.Cleanup(func() { _ = session.Disconnect() }) + + assertGitHubMCPConfigApplied(t, ctx, session) + }) +} + +func assertGitHubMCPConfigApplied(t *testing.T, ctx *testharness.TestContext, session *copilot.Session) { + t.Helper() + if _, err := session.RPC.MCP.List(t.Context()); err != nil { + t.Fatalf("MCP.List failed: %v", err) + } + deadline := time.Now().Add(60 * time.Second) + var lastRequests []testharness.CapturedRequest + for time.Now().Before(deadline) { + requests, err := ctx.GetRequests() + if err == nil { + lastRequests = requests + var writableRequest *testharness.CapturedRequest + hasReadonlyRequest := false + for i := range requests { + request := &requests[i] + if request.URL == "/mcp/readonly" { + hasReadonlyRequest = true + } + if request.Method == http.MethodPost && request.URL == "/mcp" { + writableRequest = request + } + } + if writableRequest != nil { + if hasReadonlyRequest { + t.Fatalf("Expected writable GitHub MCP endpoint, got requests: %+v", requests) + } + assertCapturedHeader(t, writableRequest.Headers, "x-mcp-toolsets", "all") + assertCapturedHeader(t, writableRequest.Headers, "x-mcp-insiders", "true") + return + } + } + time.Sleep(200 * time.Millisecond) + } + t.Fatalf("Timed out waiting for configured GitHub MCP request; captured: %+v", lastRequests) +} + +func assertCapturedHeader(t *testing.T, headers map[string]json.RawMessage, name, expected string) { + t.Helper() + var actual string + if err := json.Unmarshal(headers[name], &actual); err != nil { + t.Fatalf("Failed to decode %s header: %v", name, err) + } + if actual != expected { + t.Fatalf("Expected %s=%q, got %q", name, expected, actual) + } } // createProxyProvider returns a ProviderConfig that points at the test proxy and diff --git a/go/internal/e2e/session_e2e_test.go b/go/internal/e2e/session_e2e_test.go index f73bef7ea..440a30348 100644 --- a/go/internal/e2e/session_e2e_test.go +++ b/go/internal/e2e/session_e2e_test.go @@ -643,11 +643,29 @@ func TestSessionE2E(t *testing.T) { } // We should be able to send another message - answer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: "What is 2+2?"}) + answerCh := make(chan *copilot.SessionEvent, 1) + answerErrCh := make(chan error, 1) + go func() { + evt, err := testharness.GetNextEventOfType(session, copilot.SessionEventTypeAssistantMessage, 60*time.Second) + if err != nil { + answerErrCh <- err + } else { + answerCh <- evt + } + }() + + _, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: "What is 2+2?"}) if err != nil { t.Fatalf("Failed to send message after abort: %v", err) } + var answer *copilot.SessionEvent + select { + case answer = <-answerCh: + case err := <-answerErrCh: + t.Fatalf("Failed waiting for assistant message after abort: %v", err) + } + if ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, "4") { t.Errorf("Expected answer to contain '4', got %v", answer.Data) } @@ -1029,7 +1047,12 @@ func getSystemMessage(exchange testharness.ParsedHttpExchange) string { } func TestSetModelWithReasoningEffortE2E(t *testing.T) { + t.Run("should set model with reasoningeffort", runSetModelWithReasoningEffortE2E) +} + +func runSetModelWithReasoningEffortE2E(t *testing.T) { ctx := testharness.NewTestContext(t) + ctx.ConfigureForTest(t) client := ctx.NewClient() t.Cleanup(func() { client.ForceStop() }) @@ -1054,15 +1077,15 @@ func TestSetModelWithReasoningEffortE2E(t *testing.T) { } }) - if err := session.SetModel(t.Context(), "gpt-4.1", &copilot.SetModelOptions{ReasoningEffort: copilot.String("high")}); err != nil { + if err := session.SetModel(t.Context(), "gpt-5.4", &copilot.SetModelOptions{ReasoningEffort: copilot.String("high")}); err != nil { t.Fatalf("SetModel returned error: %v", err) } select { case evt := <-modelChanged: md, mdOk := evt.Data.(*copilot.SessionModelChangeData) - if !mdOk || md.NewModel != "gpt-4.1" { - t.Errorf("Expected newModel 'gpt-4.1', got %v", evt.Data) + if !mdOk || md.NewModel != "gpt-5.4" { + t.Errorf("Expected newModel 'gpt-5.4', got %v", evt.Data) } if !mdOk || md.ReasoningEffort == nil || *md.ReasoningEffort != "high" { t.Errorf("Expected reasoningEffort 'high', got %v", evt.Data) @@ -1103,8 +1126,8 @@ func TestSessionBlobAttachmentE2E(t *testing.T) { _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "Describe this image", Attachments: []copilot.Attachment{ - &copilot.UserMessageAttachmentBlob{ - Data: data, + &copilot.AttachmentBlob{ + Data: &data, MIMEType: mimeType, DisplayName: &displayName, }, @@ -1256,7 +1279,7 @@ func getEventMessage(evt copilot.SessionEvent) string { } // TestSessionAttachments mirrors the C# Should_Send_With_*_Attachment tests in SessionTests.cs. -// Each subtest exercises a different UserMessageAttachment shape end-to-end through SendAndWait +// Each subtest exercises a different Attachment shape end-to-end through SendAndWait // and verifies the resulting user.message event captured by GetEvents. func TestSessionAttachmentsE2E(t *testing.T) { ctx := testharness.NewTestContext(t) @@ -1286,17 +1309,17 @@ func TestSessionAttachmentsE2E(t *testing.T) { path := filePath _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "Read the attached file and reply with its contents.", - Attachments: []copilot.Attachment{&copilot.UserMessageAttachmentFile{ + Attachments: []copilot.Attachment{&copilot.AttachmentFile{ DisplayName: displayName, Path: path, - LineRange: &copilot.UserMessageAttachmentFileLineRange{Start: 1, End: 1}, + LineRange: &copilot.AttachmentFileLineRange{Start: 1, End: 1}, }}, }) if err != nil { t.Fatalf("SendAndWait failed: %v", err) } - attachment, ok := lastUserAttachment(t, session).(*copilot.UserMessageAttachmentFile) + attachment, ok := lastUserAttachment(t, session).(*copilot.AttachmentFile) if !ok { t.Fatalf("Expected file attachment, got %T", lastUserAttachment(t, session)) } @@ -1333,7 +1356,7 @@ func TestSessionAttachmentsE2E(t *testing.T) { path := directoryPath _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "List the attached directory.", - Attachments: []copilot.Attachment{&copilot.UserMessageAttachmentDirectory{ + Attachments: []copilot.Attachment{&copilot.AttachmentDirectory{ DisplayName: displayName, Path: path, }}, @@ -1342,7 +1365,7 @@ func TestSessionAttachmentsE2E(t *testing.T) { t.Fatalf("SendAndWait failed: %v", err) } - attachment, ok := lastUserAttachment(t, session).(*copilot.UserMessageAttachmentDirectory) + attachment, ok := lastUserAttachment(t, session).(*copilot.AttachmentDirectory) if !ok { t.Fatalf("Expected directory attachment, got %T", lastUserAttachment(t, session)) } @@ -1374,13 +1397,13 @@ func TestSessionAttachmentsE2E(t *testing.T) { text := `string Value = "SELECTION_SENTINEL";` _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "Summarize the selected code.", - Attachments: []copilot.Attachment{&copilot.UserMessageAttachmentSelection{ + Attachments: []copilot.Attachment{&copilot.AttachmentSelection{ DisplayName: displayName, FilePath: filePathCopy, Text: text, - Selection: copilot.UserMessageAttachmentSelectionDetails{ - Start: copilot.UserMessageAttachmentSelectionDetailsStart{Line: 1, Character: 10}, - End: copilot.UserMessageAttachmentSelectionDetailsEnd{Line: 1, Character: 45}, + Selection: copilot.AttachmentSelectionDetails{ + Start: copilot.AttachmentSelectionDetailsStart{Line: 1, Character: 10}, + End: copilot.AttachmentSelectionDetailsEnd{Line: 1, Character: 45}, }, }}, }) @@ -1388,7 +1411,7 @@ func TestSessionAttachmentsE2E(t *testing.T) { t.Fatalf("SendAndWait failed: %v", err) } - attachment, ok := lastUserAttachment(t, session).(*copilot.UserMessageAttachmentSelection) + attachment, ok := lastUserAttachment(t, session).(*copilot.AttachmentSelection) if !ok { t.Fatalf("Expected selection attachment, got %T", lastUserAttachment(t, session)) } @@ -1420,13 +1443,13 @@ func TestSessionAttachmentsE2E(t *testing.T) { } number := int64(1234) - referenceType := copilot.UserMessageAttachmentGithubReferenceTypeIssue + referenceType := copilot.AttachmentGitHubReferenceTypeIssue state := "open" title := "Add E2E attachment coverage" url := "https://github.com/github/copilot-sdk/issues/1234" _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{ Prompt: "Using only the GitHub reference metadata in this message, summarize the reference. Do not call any tools.", - Attachments: []copilot.Attachment{&copilot.UserMessageAttachmentGithubReference{ + Attachments: []copilot.Attachment{&copilot.AttachmentGitHubReference{ Number: number, ReferenceType: referenceType, State: state, @@ -1438,14 +1461,14 @@ func TestSessionAttachmentsE2E(t *testing.T) { t.Fatalf("SendAndWait failed: %v", err) } - attachment, ok := lastUserAttachment(t, session).(*copilot.UserMessageAttachmentGithubReference) + attachment, ok := lastUserAttachment(t, session).(*copilot.AttachmentGitHubReference) if !ok { t.Fatalf("Expected GitHub reference attachment, got %T", lastUserAttachment(t, session)) } if attachment.Number != 1234 { t.Errorf("Expected Number=1234, got %v", attachment.Number) } - if attachment.ReferenceType != copilot.UserMessageAttachmentGithubReferenceTypeIssue { + if attachment.ReferenceType != copilot.AttachmentGitHubReferenceTypeIssue { t.Errorf("Expected ReferenceType=Issue, got %v", attachment.ReferenceType) } if attachment.State != "open" { diff --git a/go/internal/e2e/session_fs_e2e_test.go b/go/internal/e2e/session_fs_e2e_test.go index ef392ebbc..3ba91c799 100644 --- a/go/internal/e2e/session_fs_e2e_test.go +++ b/go/internal/e2e/session_fs_e2e_test.go @@ -15,17 +15,17 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) -func TestSessionFsE2E(t *testing.T) { +func TestSessionFSE2E(t *testing.T) { ctx := testharness.NewTestContext(t) providerRoot := t.TempDir() sessionStatePath := createSessionStatePath(t) - sessionFsConfig := &copilot.SessionFsConfig{ + sessionFSConfig := &copilot.SessionFSConfig{ InitialWorkingDirectory: "/", SessionStatePath: sessionStatePath, - Conventions: rpc.SessionFsSetProviderConventionsPosix, + Conventions: rpc.SessionFSSetProviderConventionsPosix, } - createSessionFsHandler := func(session *copilot.Session) copilot.SessionFsProvider { - return &testSessionFsHandler{ + createSessionFSHandler := func(session *copilot.Session) copilot.SessionFSProvider { + return &testSessionFSHandler{ root: providerRoot, sessionID: session.SessionID, } @@ -35,7 +35,7 @@ func TestSessionFsE2E(t *testing.T) { } client := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.SessionFs = sessionFsConfig + opts.SessionFS = sessionFSConfig }) t.Cleanup(func() { client.ForceStop() }) @@ -44,7 +44,7 @@ func TestSessionFsE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -81,7 +81,7 @@ func TestSessionFsE2E(t *testing.T) { session1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -111,7 +111,7 @@ func TestSessionFsE2E(t *testing.T) { session2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to resume session: %v", err) @@ -139,7 +139,7 @@ func TestSessionFsE2E(t *testing.T) { ctx.ConfigureForTest(t) client1 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.TcpConnection{Path: ctx.CLIPath} + opts.Connection = copilot.TCPConnection{Path: ctx.CLIPath} }) t.Cleanup(func() { client1.ForceStop() }) @@ -155,25 +155,25 @@ func TestSessionFsE2E(t *testing.T) { } client2 := copilot.NewClient(&copilot.ClientOptions{ - Connection: copilot.UriConnection{URL: fmt.Sprintf("localhost:%d", runtimePort)}, + Connection: copilot.URIConnection{URL: fmt.Sprintf("localhost:%d", runtimePort)}, LogLevel: "error", Env: ctx.Env(), - SessionFs: sessionFsConfig, + SessionFS: sessionFSConfig, }) t.Cleanup(func() { client2.ForceStop() }) if err := client2.Start(t.Context()); err == nil { - t.Fatal("Expected Start to fail when SessionFs provider is set after sessions already exist") + t.Fatal("Expected Start to fail when SessionFS provider is set after sessions already exist") } }) - t.Run("should map large output handling into SessionFs", func(t *testing.T) { + t.Run("should map large output handling into SessionFS", func(t *testing.T) { ctx.ConfigureForTest(t) suppliedFileContent := strings.Repeat("x", 100_000) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, Tools: []copilot.Tool{ copilot.DefineTool("get_big_string", "Returns a large string", func(_ struct{}, inv copilot.ToolInvocation) (string, error) { @@ -213,12 +213,12 @@ func TestSessionFsE2E(t *testing.T) { } }) - t.Run("should succeed with compaction while using SessionFs", func(t *testing.T) { + t.Run("should succeed with compaction while using SessionFS", func(t *testing.T) { ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -252,12 +252,12 @@ func TestSessionFsE2E(t *testing.T) { t.Fatalf("Timed out waiting for checkpoint rewrite: %v", err) } }) - t.Run("should write workspace metadata via SessionFs", func(t *testing.T) { + t.Run("should write workspace metadata via SessionFS", func(t *testing.T) { ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -277,7 +277,7 @@ func TestSessionFsE2E(t *testing.T) { t.Fatalf("Expected response to contain 56, got %q", content) } - // WorkspaceManager should have created workspace.yaml via SessionFs + // WorkspaceManager should have created workspace.yaml via SessionFS workspaceYamlPath := p(session.SessionID, sessionStatePath+"/workspace.yaml") if err := waitForFileContent(workspaceYamlPath, "id:", 5*time.Second); err != nil { t.Fatalf("Timed out waiting for workspace.yaml content: %v", err) @@ -294,12 +294,12 @@ func TestSessionFsE2E(t *testing.T) { } }) - t.Run("should persist plan.md via SessionFs", func(t *testing.T) { + t.Run("should persist plan.md via SessionFS", func(t *testing.T) { ctx.ConfigureForTest(t) session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -339,12 +339,12 @@ func createSessionStatePath(t *testing.T) string { return filepath.ToSlash(filepath.Join(t.TempDir(), "session-state")) } -type testSessionFsHandler struct { +type testSessionFSHandler struct { root string sessionID string } -func (h *testSessionFsHandler) ReadFile(path string) (string, error) { +func (h *testSessionFSHandler) ReadFile(path string) (string, error) { content, err := os.ReadFile(providerPath(h.root, h.sessionID, path)) if err != nil { return "", err @@ -352,7 +352,7 @@ func (h *testSessionFsHandler) ReadFile(path string) (string, error) { return string(content), nil } -func (h *testSessionFsHandler) WriteFile(path string, content string, mode *int) error { +func (h *testSessionFSHandler) WriteFile(path string, content string, mode *int) error { fullPath := providerPath(h.root, h.sessionID, path) if err := os.MkdirAll(filepath.Dir(fullPath), 0o755); err != nil { return err @@ -364,7 +364,7 @@ func (h *testSessionFsHandler) WriteFile(path string, content string, mode *int) return os.WriteFile(fullPath, []byte(content), perm) } -func (h *testSessionFsHandler) AppendFile(path string, content string, mode *int) error { +func (h *testSessionFSHandler) AppendFile(path string, content string, mode *int) error { fullPath := providerPath(h.root, h.sessionID, path) if err := os.MkdirAll(filepath.Dir(fullPath), 0o755); err != nil { return err @@ -382,7 +382,7 @@ func (h *testSessionFsHandler) AppendFile(path string, content string, mode *int return err } -func (h *testSessionFsHandler) Exists(path string) (bool, error) { +func (h *testSessionFSHandler) Exists(path string) (bool, error) { _, err := os.Stat(providerPath(h.root, h.sessionID, path)) if err == nil { return true, nil @@ -393,13 +393,13 @@ func (h *testSessionFsHandler) Exists(path string) (bool, error) { return false, err } -func (h *testSessionFsHandler) Stat(path string) (*copilot.SessionFsFileInfo, error) { +func (h *testSessionFSHandler) Stat(path string) (*copilot.SessionFSFileInfo, error) { info, err := os.Stat(providerPath(h.root, h.sessionID, path)) if err != nil { return nil, err } ts := info.ModTime().UTC() - return &copilot.SessionFsFileInfo{ + return &copilot.SessionFSFileInfo{ IsFile: !info.IsDir(), IsDirectory: info.IsDir(), Size: info.Size(), @@ -408,7 +408,7 @@ func (h *testSessionFsHandler) Stat(path string) (*copilot.SessionFsFileInfo, er }, nil } -func (h *testSessionFsHandler) MakeDirectory(path string, recursive bool, mode *int) error { +func (h *testSessionFSHandler) MakeDirectory(path string, recursive bool, mode *int) error { fullPath := providerPath(h.root, h.sessionID, path) perm := os.FileMode(0o777) if mode != nil { @@ -420,7 +420,7 @@ func (h *testSessionFsHandler) MakeDirectory(path string, recursive bool, mode * return os.Mkdir(fullPath, perm) } -func (h *testSessionFsHandler) ReadDirectory(path string) ([]string, error) { +func (h *testSessionFSHandler) ReadDirectory(path string) ([]string, error) { entries, err := os.ReadDir(providerPath(h.root, h.sessionID, path)) if err != nil { return nil, err @@ -432,18 +432,18 @@ func (h *testSessionFsHandler) ReadDirectory(path string) ([]string, error) { return names, nil } -func (h *testSessionFsHandler) ReadDirectoryWithTypes(path string) ([]rpc.SessionFsReaddirWithTypesEntry, error) { +func (h *testSessionFSHandler) ReadDirectoryWithTypes(path string) ([]rpc.SessionFSReaddirWithTypesEntry, error) { entries, err := os.ReadDir(providerPath(h.root, h.sessionID, path)) if err != nil { return nil, err } - result := make([]rpc.SessionFsReaddirWithTypesEntry, 0, len(entries)) + result := make([]rpc.SessionFSReaddirWithTypesEntry, 0, len(entries)) for _, entry := range entries { - entryType := rpc.SessionFsReaddirWithTypesEntryTypeFile + entryType := rpc.SessionFSReaddirWithTypesEntryTypeFile if entry.IsDir() { - entryType = rpc.SessionFsReaddirWithTypesEntryTypeDirectory + entryType = rpc.SessionFSReaddirWithTypesEntryTypeDirectory } - result = append(result, rpc.SessionFsReaddirWithTypesEntry{ + result = append(result, rpc.SessionFSReaddirWithTypesEntry{ Name: entry.Name(), Type: entryType, }) @@ -451,7 +451,7 @@ func (h *testSessionFsHandler) ReadDirectoryWithTypes(path string) ([]rpc.Sessio return result, nil } -func (h *testSessionFsHandler) Remove(path string, recursive bool, force bool) error { +func (h *testSessionFSHandler) Remove(path string, recursive bool, force bool) error { fullPath := providerPath(h.root, h.sessionID, path) var err error if recursive { @@ -465,7 +465,7 @@ func (h *testSessionFsHandler) Remove(path string, recursive bool, force bool) e return err } -func (h *testSessionFsHandler) Rename(src string, dest string) error { +func (h *testSessionFSHandler) Rename(src string, dest string) error { destPath := providerPath(h.root, h.sessionID, dest) if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil { return err @@ -525,13 +525,13 @@ func waitForFileContent(path string, needle string, timeout time.Duration) error return fmt.Errorf("file %s did not contain %q", path, needle) } -// TestSessionFsHandlerOperations mirrors the C# Should_Map_All_SessionFs_Handler_Operations test. -// It exercises every operation on testSessionFsHandler directly to ensure the test helper +// TestSessionFSHandlerOperations mirrors the C# Should_Map_All_SessionFS_Handler_Operations test. +// It exercises every operation on testSessionFSHandler directly to ensure the test helper // implementation routes file operations correctly to the per-session provider root. -func TestSessionFsHandlerOperationsE2E(t *testing.T) { +func TestSessionFSHandlerOperationsE2E(t *testing.T) { providerRoot := t.TempDir() sessionID := "handler-session" - handler := &testSessionFsHandler{root: providerRoot, sessionID: sessionID} + handler := &testSessionFSHandler{root: providerRoot, sessionID: sessionID} if err := handler.MakeDirectory("/workspace/nested", true, nil); err != nil { t.Fatalf("Mkdir failed: %v", err) @@ -589,7 +589,7 @@ func TestSessionFsHandlerOperationsE2E(t *testing.T) { } var found bool for _, entry := range typedEntries { - if entry.Name == "file.txt" && entry.Type == rpc.SessionFsReaddirWithTypesEntryTypeFile { + if entry.Name == "file.txt" && entry.Type == rpc.SessionFSReaddirWithTypesEntryTypeFile { found = true break } diff --git a/go/internal/e2e/session_fs_sqlite_e2e_test.go b/go/internal/e2e/session_fs_sqlite_e2e_test.go index f7e849f56..20cd77783 100644 --- a/go/internal/e2e/session_fs_sqlite_e2e_test.go +++ b/go/internal/e2e/session_fs_sqlite_e2e_test.go @@ -20,7 +20,7 @@ type sqliteCall struct { Query string } -// inMemorySqliteProvider is a SessionFsProvider backed by in-memory maps with a stub SQLite handler. +// inMemorySqliteProvider is a SessionFSProvider backed by in-memory maps with a stub SQLite handler. // The stub returns plausible canned responses based on query type rather than executing real SQL. // This avoids pulling in a real SQLite dependency (which would force a go directive bump across // all scenario go.mod files). @@ -83,17 +83,17 @@ func (p *inMemorySqliteProvider) Exists(path string) (bool, error) { return isFile || isDir, nil } -func (p *inMemorySqliteProvider) Stat(path string) (*copilot.SessionFsFileInfo, error) { +func (p *inMemorySqliteProvider) Stat(path string) (*copilot.SessionFSFileInfo, error) { p.mu.Lock() defer p.mu.Unlock() now := time.Now().UTC() if p.dirs[path] { - return &copilot.SessionFsFileInfo{ + return &copilot.SessionFSFileInfo{ IsFile: false, IsDirectory: true, Size: 0, Mtime: now, Birthtime: now, }, nil } if content, ok := p.files[path]; ok { - return &copilot.SessionFsFileInfo{ + return &copilot.SessionFSFileInfo{ IsFile: true, IsDirectory: false, Size: int64(len(content)), Mtime: now, Birthtime: now, }, nil } @@ -143,17 +143,17 @@ func (p *inMemorySqliteProvider) ReadDirectory(path string) ([]string, error) { return result, nil } -func (p *inMemorySqliteProvider) ReadDirectoryWithTypes(path string) ([]rpc.SessionFsReaddirWithTypesEntry, error) { +func (p *inMemorySqliteProvider) ReadDirectoryWithTypes(path string) ([]rpc.SessionFSReaddirWithTypesEntry, error) { p.mu.Lock() defer p.mu.Unlock() prefix := strings.TrimRight(path, "/") + "/" - entries := map[string]rpc.SessionFsReaddirWithTypesEntryType{} + entries := map[string]rpc.SessionFSReaddirWithTypesEntryType{} for d := range p.dirs { if strings.HasPrefix(d, prefix) { rest := d[len(prefix):] if rest != "" { name := strings.SplitN(rest, "/", 2)[0] - entries[name] = rpc.SessionFsReaddirWithTypesEntryTypeDirectory + entries[name] = rpc.SessionFSReaddirWithTypesEntryTypeDirectory } } } @@ -163,14 +163,14 @@ func (p *inMemorySqliteProvider) ReadDirectoryWithTypes(path string) ([]rpc.Sess if rest != "" { name := strings.SplitN(rest, "/", 2)[0] if _, exists := entries[name]; !exists { - entries[name] = rpc.SessionFsReaddirWithTypesEntryTypeFile + entries[name] = rpc.SessionFSReaddirWithTypesEntryTypeFile } } } } - result := make([]rpc.SessionFsReaddirWithTypesEntry, 0, len(entries)) + result := make([]rpc.SessionFSReaddirWithTypesEntry, 0, len(entries)) for name, typ := range entries { - result = append(result, rpc.SessionFsReaddirWithTypesEntry{Name: name, Type: typ}) + result = append(result, rpc.SessionFSReaddirWithTypesEntry{Name: name, Type: typ}) } sort.Slice(result, func(i, j int) bool { return result[i].Name < result[j].Name }) return result, nil @@ -195,9 +195,29 @@ func (p *inMemorySqliteProvider) Rename(src string, dest string) error { return nil } -func (p *inMemorySqliteProvider) SqliteQuery(queryType rpc.SessionFsSqliteQueryType, query string, params map[string]any) (*copilot.SessionFsSqliteQueryResult, error) { +func (p *inMemorySqliteProvider) SqliteQuery(queryType rpc.SessionFSSqliteQueryType, query string, params map[string]any) (*copilot.SessionFSSqliteQueryResult, error) { p.mu.Lock() defer p.mu.Unlock() + return p.runQueryLocked(queryType, query), nil +} + +func (p *inMemorySqliteProvider) SqliteTransaction(statements []rpc.SessionFSSqliteTransactionStatement) ([]copilot.SessionFSSqliteQueryResult, error) { + p.mu.Lock() + defer p.mu.Unlock() + results := make([]copilot.SessionFSSqliteQueryResult, 0, len(statements)) + for _, statement := range statements { + results = append(results, *p.runQueryLocked(statement.QueryType, statement.Query)) + } + return results, nil +} + +// runQueryLocked returns canned results based on query type. The agent doesn't +// know or care whether a real SQLite database is behind this — it just receives +// SQL tool results. These stubs return plausible responses so the agent can +// proceed normally without pulling in a real SQLite dependency. +// +// Callers must hold p.mu. +func (p *inMemorySqliteProvider) runQueryLocked(queryType rpc.SessionFSSqliteQueryType, query string) *copilot.SessionFSSqliteQueryResult { p.hadQuery = true *p.sqliteCalls = append(*p.sqliteCalls, sqliteCall{ SessionID: p.sessionID, @@ -205,32 +225,45 @@ func (p *inMemorySqliteProvider) SqliteQuery(queryType rpc.SessionFsSqliteQueryT Query: query, }) - // Return canned results based on query type. The agent doesn't know or care - // whether a real SQLite database is behind this — it just receives SQL tool - // results. These stubs return plausible responses so the agent can proceed - // normally without pulling in a real SQLite dependency. upper := strings.ToUpper(strings.TrimSpace(query)) switch queryType { - case rpc.SessionFsSqliteQueryTypeExec: - return &copilot.SessionFsSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}}, nil - case rpc.SessionFsSqliteQueryTypeRun: + case rpc.SessionFSSqliteQueryTypeExec: + return &copilot.SessionFSSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}} + case rpc.SessionFSSqliteQueryTypeRun: lastID := int64(1) - return &copilot.SessionFsSqliteQueryResult{ + return &copilot.SessionFSSqliteQueryResult{ Columns: []string{}, Rows: []map[string]any{}, RowsAffected: 1, LastInsertRowid: &lastID, - }, nil - case rpc.SessionFsSqliteQueryTypeQuery: - if strings.Contains(upper, "SELECT") { - return &copilot.SessionFsSqliteQueryResult{ + } + case rpc.SessionFSSqliteQueryTypeQuery: + // Only the "items" table the test asks the agent to create is modelled + // here. The runtime also reads its own bookkeeping tables (for example + // inbox_entries) through this provider and deserializes those rows into + // typed structs, so returning the canned item row for every SELECT would + // make the runtime reject rows it cannot parse. + if strings.Contains(upper, "SELECT") && readsTable(upper, "ITEMS") { + return &copilot.SessionFSSqliteQueryResult{ Columns: []string{"id", "name"}, Rows: []map[string]any{{"id": "a1", "name": "Widget"}}, - }, nil + } + } + return &copilot.SessionFSSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}} + } + return &copilot.SessionFSSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}} +} + +// readsTable reports whether an upper-cased SQL statement selects from the given +// table, tolerating the quoting styles the agent may emit. +func readsTable(upperQuery string, table string) bool { + names := []string{table, `"` + table + `"`, "`" + table + "`", "[" + table + "]", "MAIN." + table} + for _, name := range names { + if strings.Contains(upperQuery, "FROM "+name) { + return true } - return &copilot.SessionFsSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}}, nil } - return &copilot.SessionFsSqliteQueryResult{Columns: []string{}, Rows: []map[string]any{}}, nil + return false } func (p *inMemorySqliteProvider) SqliteExists() (bool, error) { @@ -239,27 +272,27 @@ func (p *inMemorySqliteProvider) SqliteExists() (bool, error) { return p.hadQuery, nil } -func TestSessionFsSqliteE2E(t *testing.T) { +func TestSessionFSSqliteE2E(t *testing.T) { ctx := testharness.NewTestContext(t) sessionStatePath := createSessionStatePath(t) - sessionFsConfig := &copilot.SessionFsConfig{ + sessionFSConfig := &copilot.SessionFSConfig{ InitialWorkingDirectory: "/", SessionStatePath: sessionStatePath, - Conventions: rpc.SessionFsSetProviderConventionsPosix, - Capabilities: &copilot.SessionFsCapabilities{Sqlite: true}, + Conventions: rpc.SessionFSSetProviderConventionsPosix, + Capabilities: &copilot.SessionFSCapabilities{Sqlite: true}, } var sqliteCalls []sqliteCall var providers sync.Map - createSessionFsHandler := func(session *copilot.Session) copilot.SessionFsProvider { + createSessionFSHandler := func(session *copilot.Session) copilot.SessionFSProvider { p := newInMemorySqliteProvider(session.SessionID, &sqliteCalls) providers.Store(session.SessionID, p) return p } client := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.SessionFs = sessionFsConfig + opts.SessionFS = sessionFSConfig }) t.Cleanup(func() { client.ForceStop() }) @@ -269,7 +302,7 @@ func TestSessionFsSqliteE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) @@ -307,7 +340,7 @@ func TestSessionFsSqliteE2E(t *testing.T) { session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, - CreateSessionFsProvider: createSessionFsHandler, + CreateSessionFSProvider: createSessionFSHandler, }) if err != nil { t.Fatalf("Failed to create session: %v", err) diff --git a/go/internal/e2e/session_todos_changed_e2e_test.go b/go/internal/e2e/session_todos_changed_e2e_test.go new file mode 100644 index 000000000..b0bf241b0 --- /dev/null +++ b/go/internal/e2e/session_todos_changed_e2e_test.go @@ -0,0 +1,81 @@ +package e2e + +import ( + "context" + "slices" + "sort" + "testing" + "time" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +func TestFiresSessionTodosChangedAndExposesRowsAndDependencies(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("fires session.todos_changed and exposes rows and dependencies", func(t *testing.T) { + ctx.ConfigureForTest(t) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + defer session.Disconnect() + + awaitTodosChanged := waitForMatchingEvent( + session, + copilot.SessionEventType("session.todos_changed"), + func(copilot.SessionEvent) bool { return true }, + "session.todos_changed event", + ) + + sendCtx, cancel := context.WithTimeout(t.Context(), 120*time.Second) + defer cancel() + _, err = session.SendAndWait(sendCtx, copilot.MessageOptions{ + Prompt: "Use the sql tool exactly once to execute all three of the following statements " + + "together, in this exact order, in a single sql tool call (a single query string " + + "containing all three statements):\n" + + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n" + + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n" + + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n" + + "Then stop. Do not insert any other rows or create any other tables.", + }) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + + awaitEvent(t, awaitTodosChanged) + + result, err := session.RPC.Plan.ReadSqlTodosWithDependencies(t.Context()) + if err != nil { + t.Fatalf("Plan.ReadSqlTodosWithDependencies failed: %v", err) + } + + var ids []string + for _, row := range result.Rows { + if row.ID != nil && *row.ID != "" { + ids = append(ids, *row.ID) + } + } + sort.Strings(ids) + if !slices.Equal(ids, []string{"alpha", "beta"}) { + t.Fatalf("Expected todo ids [alpha beta], got %v", ids) + } + + foundDependency := false + for _, dependency := range result.Dependencies { + if dependency.TodoID == "beta" && dependency.DependsOn == "alpha" { + foundDependency = true + break + } + } + if !foundDependency { + t.Fatalf("Expected dependency beta -> alpha, got %+v", result.Dependencies) + } + }) +} diff --git a/go/internal/e2e/skills_e2e_test.go b/go/internal/e2e/skills_e2e_test.go index 80cb4f686..06a96cf95 100644 --- a/go/internal/e2e/skills_e2e_test.go +++ b/go/internal/e2e/skills_e2e_test.go @@ -258,7 +258,7 @@ func TestSkillsE2E(t *testing.T) { disabledSession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, WorkingDirectory: projectDir, - EnableConfigDiscovery: false, + EnableConfigDiscovery: copilot.Bool(false), }) if err != nil { t.Fatalf("CreateSession (disabled) failed: %v", err) @@ -278,7 +278,7 @@ func TestSkillsE2E(t *testing.T) { enabledSession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, WorkingDirectory: projectDir, - EnableConfigDiscovery: true, + EnableConfigDiscovery: copilot.Bool(true), }) if err != nil { t.Fatalf("CreateSession (enabled) failed: %v", err) diff --git a/go/internal/e2e/streaming_fidelity_e2e_test.go b/go/internal/e2e/streaming_fidelity_e2e_test.go index 189b61bf2..7f6d4fba8 100644 --- a/go/internal/e2e/streaming_fidelity_e2e_test.go +++ b/go/internal/e2e/streaming_fidelity_e2e_test.go @@ -285,12 +285,16 @@ func TestStreamingFidelityE2E(t *testing.T) { }) t.Run("should emit streaming deltas with reasoning effort configured", func(t *testing.T) { - ctx.ConfigureForTest(t) + reasoningCtx := testharness.NewTestContext(t) + reasoningCtx.ConfigureForTest(t) + reasoningClient := reasoningCtx.NewClient() + t.Cleanup(func() { reasoningClient.ForceStop() }) // Verifies that setting ReasoningEffort alongside Streaming=true does not break // the streaming pipeline — deltas still arrive and complete successfully. - session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + session, err := reasoningClient.CreateSession(t.Context(), &copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + Model: "gpt-5.4", Streaming: copilot.Bool(true), ReasoningEffort: "high", }) diff --git a/go/internal/e2e/subagent_hooks_e2e_test.go b/go/internal/e2e/subagent_hooks_e2e_test.go index c632b1e60..0e2fde9f8 100644 --- a/go/internal/e2e/subagent_hooks_e2e_test.go +++ b/go/internal/e2e/subagent_hooks_e2e_test.go @@ -1,6 +1,7 @@ package e2e import ( + "net/http" "os" "path/filepath" "sync" @@ -10,10 +11,78 @@ import ( "github.com/github/copilot-sdk/go/internal/e2e/testharness" ) +type subagentRequestRecord struct { + agentID string + parentAgentID string + interactionType string +} + +type recordingForwardingTransport struct { + inner http.RoundTripper + mu sync.Mutex + records []subagentRequestRecord +} + +func newRecordingForwardingTransport() *recordingForwardingTransport { + inner := http.DefaultTransport.(*http.Transport).Clone() + inner.DisableCompression = true + return &recordingForwardingTransport{inner: inner} +} + +func (rt *recordingForwardingTransport) RoundTrip(req *http.Request) (*http.Response, error) { + if isInferenceURL(req.URL.String()) { + rctx := copilot.RequestContextFrom(req) + record := subagentRequestRecord{} + if rctx != nil { + record.agentID = rctx.AgentID + record.parentAgentID = rctx.ParentAgentID + record.interactionType = rctx.InteractionType + } + rt.mu.Lock() + rt.records = append(rt.records, record) + rt.mu.Unlock() + } + return rt.inner.RoundTrip(req) +} + +func (rt *recordingForwardingTransport) inferenceRecords() []subagentRequestRecord { + rt.mu.Lock() + defer rt.mu.Unlock() + out := make([]subagentRequestRecord, len(rt.records)) + copy(out, rt.records) + return out +} + +func assertSubagentRequestMetadata(t *testing.T, records []subagentRequestRecord) { + t.Helper() + if len(records) == 0 { + t.Fatal("request handler should observe inference requests") + } + for _, r := range records { + if r.parentAgentID == "" { + continue + } + if r.agentID == "" { + t.Fatal("sub-agent inference request should carry an agent id") + } + if r.interactionType == "" { + t.Fatal("sub-agent inference request should carry an interaction type") + } + if r.parentAgentID == r.agentID { + t.Fatal("sub-agent inference request should have distinct parent and child agent ids") + } + return + } + t.Fatal("sub-agent inference request should carry a parent agent id") +} + func TestSubagentHooksE2E(t *testing.T) { + testharness.SkipIfInProcess(t, "an LLM inference provider is process-global in-process") ctx := testharness.NewTestContext(t) + transport := newRecordingForwardingTransport() client := ctx.NewClient(func(o *copilot.ClientOptions) { o.Env = append(o.Env, "COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS=true") + o.RequestHandler = &copilot.CopilotRequestHandler{Transport: transport} }) t.Cleanup(func() { client.ForceStop() }) @@ -100,5 +169,6 @@ func TestSubagentHooksE2E(t *testing.T) { if viewPre[0].sessionID == taskPre.sessionID { t.Error("Sub-agent tool hooks should have a different sessionId than parent tool hooks") } + assertSubagentRequestMetadata(t, transport.inferenceRecords()) }) } diff --git a/go/internal/e2e/suspend_e2e_test.go b/go/internal/e2e/suspend_e2e_test.go index 672481a4f..8909193e2 100644 --- a/go/internal/e2e/suspend_e2e_test.go +++ b/go/internal/e2e/suspend_e2e_test.go @@ -48,10 +48,10 @@ func TestSuspendE2E(t *testing.T) { t.Run("should allow resume and continue conversation after suspend", func(t *testing.T) { ctx.ConfigureForTest(t) - _, cliURL := startTcpServer(t, ctx) + _, cliURL := startTCPServer(t, ctx) client1 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { client1.ForceStop() }) @@ -75,7 +75,7 @@ func TestSuspendE2E(t *testing.T) { client1.ForceStop() client2 := ctx.NewClient(func(opts *copilot.ClientOptions) { - opts.Connection = copilot.UriConnection{URL: cliURL, ConnectionToken: sharedTcpToken} + opts.Connection = copilot.URIConnection{URL: cliURL, ConnectionToken: sharedTCPToken} }) t.Cleanup(func() { client2.ForceStop() }) diff --git a/go/internal/e2e/system_message_sections_e2e_test.go b/go/internal/e2e/system_message_sections_e2e_test.go new file mode 100644 index 000000000..c1eb313a2 --- /dev/null +++ b/go/internal/e2e/system_message_sections_e2e_test.go @@ -0,0 +1,98 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +package e2e + +import ( + "strings" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/internal/e2e/testharness" +) + +func TestSystemMessageSectionsE2E(t *testing.T) { + ctx := testharness.NewTestContext(t) + client := ctx.NewClient() + t.Cleanup(func() { client.ForceStop() }) + + t.Run("should_use_replaced_identity_section_in_response", func(t *testing.T) { + ctx.ConfigureForTest(t) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SystemMessage: &copilot.SystemMessageConfig{ + Mode: "customize", + Sections: map[string]copilot.SectionOverride{ + "identity": { + Action: copilot.SectionActionReplace, + Content: "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening.", + }, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Who are you?", + }) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + if response == nil { + t.Fatal("Expected a response from the assistant") + return + } + + ad, ok := response.Data.(*copilot.AssistantMessageData) + if !ok { + t.Fatalf("Expected AssistantMessageData, got %T", response.Data) + } + content := strings.ToLower(ad.Content) + if !strings.Contains(content, "botanica") && !strings.Contains(content, "garden") && !strings.Contains(content, "plant") { + t.Errorf("Expected response to reflect the replaced identity section, but got: %s", ad.Content) + } + }) + + t.Run("should_use_replaced_preamble_section_in_response", func(t *testing.T) { + ctx.ConfigureForTest(t) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + SystemMessage: &copilot.SystemMessageConfig{ + Mode: "customize", + Sections: map[string]copilot.SectionOverride{ + copilot.SectionPreamble: { + Action: copilot.SectionActionReplace, + Content: "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening.", + }, + }, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + response, err := session.SendAndWait(t.Context(), copilot.MessageOptions{ + Prompt: "Who are you?", + }) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + if response == nil { + t.Fatal("Expected a response from the assistant") + return + } + + ad, ok := response.Data.(*copilot.AssistantMessageData) + if !ok { + t.Fatalf("Expected AssistantMessageData, got %T", response.Data) + } + content := strings.ToLower(ad.Content) + if !strings.Contains(content, "botanica") && !strings.Contains(content, "garden") && !strings.Contains(content, "plant") { + t.Errorf("Expected response to reflect the replaced preamble section, but got: %s", ad.Content) + } + }) +} diff --git a/go/internal/e2e/telemetry_e2e_test.go b/go/internal/e2e/telemetry_e2e_test.go index 071030281..4567817fd 100644 --- a/go/internal/e2e/telemetry_e2e_test.go +++ b/go/internal/e2e/telemetry_e2e_test.go @@ -7,7 +7,6 @@ import ( "path/filepath" "strings" "testing" - "time" copilot "github.com/github/copilot-sdk/go" "github.com/github/copilot-sdk/go/internal/e2e/testharness" @@ -15,6 +14,7 @@ import ( // Mirrors dotnet/test/TelemetryExportTests.cs (snapshot category "telemetry"). func TestTelemetryE2E(t *testing.T) { + testharness.SkipIfInProcess(t, "telemetry configuration is not honored in-process") t.Run("should export file telemetry for sdk interactions", func(t *testing.T) { ctx := testharness.NewTestContext(t) ctx.ConfigureForTest(t) @@ -72,14 +72,7 @@ func TestTelemetryE2E(t *testing.T) { t.Logf("Stop returned: %v", err) } - entries, err := readTelemetryEntries(t, telemetryPath, 30*time.Second, func(es []map[string]any) bool { - for _, e := range es { - if telemetryType(e) == "span" && stringAttr(e, "gen_ai.operation.name") == "invoke_agent" { - return true - } - } - return false - }) + entries, err := readTelemetryEntries(t, telemetryPath) if err != nil { t.Fatalf("readTelemetryEntries failed: %v", err) } @@ -182,33 +175,27 @@ func TestTelemetryE2E(t *testing.T) { }) } -func readTelemetryEntries(t *testing.T, path string, timeout time.Duration, isComplete func([]map[string]any) bool) ([]map[string]any, error) { +func readTelemetryEntries(t *testing.T, path string) ([]map[string]any, error) { t.Helper() - deadline := time.Now().Add(timeout) - for time.Now().Before(deadline) { - if info, err := os.Stat(path); err == nil && info.Size() > 0 { - data, err := os.ReadFile(path) - if err == nil { - var entries []map[string]any - for _, line := range strings.Split(string(data), "\n") { - line = strings.TrimSpace(line) - if line == "" { - continue - } - var entry map[string]any - if err := json.Unmarshal([]byte(line), &entry); err != nil { - continue - } - entries = append(entries, entry) - } - if len(entries) > 0 && isComplete(entries) { - return entries, nil - } - } + data, err := os.ReadFile(path) + if err != nil { + return nil, err + } + + var entries []map[string]any + for _, line := range strings.Split(string(data), "\n") { + line = strings.TrimSpace(line) + if line == "" { + continue } - time.Sleep(100 * time.Millisecond) + + var entry map[string]any + if err := json.Unmarshal([]byte(line), &entry); err != nil { + return nil, fmt.Errorf("parse telemetry entry in %q: %w", path, err) + } + entries = append(entries, entry) } - return nil, fmt.Errorf("timed out waiting for telemetry records in %q", path) + return entries, nil } func telemetryType(e map[string]any) string { return stringProp(e, "type") } @@ -307,6 +294,9 @@ func TestTelemetryConfigUnit(t *testing.T) { if cfg.OTLPEndpoint != "" { t.Errorf("Expected empty OTLPEndpoint, got %q", cfg.OTLPEndpoint) } + if cfg.OTLPProtocol != "" { + t.Errorf("Expected empty OTLPProtocol, got %q", cfg.OTLPProtocol) + } if cfg.FilePath != "" { t.Errorf("Expected empty FilePath, got %q", cfg.FilePath) } @@ -325,6 +315,7 @@ func TestTelemetryConfigUnit(t *testing.T) { // Mirrors: TelemetryConfig_CanSetAllProperties cfg := copilot.TelemetryConfig{ OTLPEndpoint: "http://localhost:4318", + OTLPProtocol: "http/protobuf", FilePath: "/tmp/traces.json", ExporterType: "otlp-http", SourceName: "my-app", @@ -333,6 +324,9 @@ func TestTelemetryConfigUnit(t *testing.T) { if cfg.OTLPEndpoint != "http://localhost:4318" { t.Errorf("OTLPEndpoint mismatch: %q", cfg.OTLPEndpoint) } + if cfg.OTLPProtocol != "http/protobuf" { + t.Errorf("OTLPProtocol mismatch: %q", cfg.OTLPProtocol) + } if cfg.FilePath != "/tmp/traces.json" { t.Errorf("FilePath mismatch: %q", cfg.FilePath) } diff --git a/go/internal/e2e/testharness/context.go b/go/internal/e2e/testharness/context.go index cae966667..03ebf24cb 100644 --- a/go/internal/e2e/testharness/context.go +++ b/go/internal/e2e/testharness/context.go @@ -29,10 +29,14 @@ func CLIPath() string { return } - // Look for CLI in sibling nodejs directory's node_modules - abs, err := filepath.Abs("../../../nodejs/node_modules/@github/copilot/index.js") - if err == nil && fileExists(abs) { - cliPath = abs + // Look for CLI in sibling nodejs directory's node_modules. As of CLI + // 1.0.64-1 the @github/copilot package is a thin loader; the runnable + // index.js ships in the installed platform package + // (e.g. @github/copilot-linux-x64). + base := RepoPath("nodejs", "node_modules", "@github") + matches, _ := filepath.Glob(filepath.Join(base, "copilot-*", "index.js")) + if len(matches) > 0 { + cliPath = matches[0] return } }) @@ -47,6 +51,67 @@ type TestContext struct { ProxyURL string proxy *CapiProxy + + // In-process transport state. When the inprocess CI matrix cell is active the + // worker inherits this process's ambient env and cwd (per-client env/working + // directory are rejected in-process), so the isolated test env/cwd are mirrored + // onto the real process and restored on Close. + inProcess bool + restoreEnv []envRestore + restoreCwd string +} + +// envRestore captures a single environment variable's prior value so the +// in-process ambient mirror can be undone during teardown. +type envRestore struct { + key string + prev string + had bool +} + +// isInProcessTransport reports whether the in-process (FFI) transport is selected +// for E2E tests via COPILOT_SDK_DEFAULT_CONNECTION=inprocess. Mirrors the +// Node/Python/.NET harnesses. +func isInProcessTransport() bool { + return strings.EqualFold(os.Getenv("COPILOT_SDK_DEFAULT_CONNECTION"), "inprocess") +} + +// init neutralizes any ambient HMAC signing key as early as package load when the +// in-process transport is selected. Host-side auth resolution ranks the HMAC key +// above the GitHub token, so an ambient COPILOT_HMAC_KEY (CI injects one as a +// job-level credential) would be picked over the token the replay snapshots +// expect, producing request signatures that miss the recorded exchanges. Because +// the runtime is hosted in this process, the key must be removed before the native +// library is loaded and captures it — a later, per-client override is too late and +// setting it to an empty value is still treated as a signing key. Out-of-process +// children resolve auth in their own process where the token already outranks the +// HMAC key, so this is scoped to the in-process cell. Mirrors the analogous +// module-load neutralization in the Node/Python/.NET harnesses. +// See https://github.com/github/copilot-sdk/issues/1934. +func init() { + if isInProcessTransport() { + os.Unsetenv("COPILOT_HMAC_KEY") + os.Unsetenv("CAPI_HMAC_KEY") + } +} + +// IsInProcessTransport reports whether E2E tests run under the in-process (FFI) +// transport. Tests that configure options unsupported in-process (e.g. per-client +// telemetry) should skip when this returns true. +func IsInProcessTransport() bool { + return isInProcessTransport() +} + +// SkipIfInProcess skips the test when E2E tests run under the in-process (FFI) +// transport, for behavior the shared in-process runtime cannot support (e.g. a +// process-global LLM inference provider, or per-client telemetry). The reason is +// surfaced in the test log so the skip is explicit rather than a silent transport +// downgrade. Such tests still run over stdio in the default matrix cell. +func SkipIfInProcess(t *testing.T, reason string) { + t.Helper() + if isInProcessTransport() { + t.Skipf("unsupported over the in-process (FFI) transport: %s", reason) + } } // NewTestContext creates a new test context with isolated directories and a replaying proxy. @@ -100,11 +165,12 @@ func NewTestContext(t *testing.T) *TestContext { } ctx := &TestContext{ - CLIPath: cliPath, - HomeDir: homeDir, - WorkDir: workDir, - ProxyURL: proxyURL, - proxy: proxy, + CLIPath: cliPath, + HomeDir: homeDir, + WorkDir: workDir, + ProxyURL: proxyURL, + proxy: proxy, + inProcess: isInProcessTransport(), } t.Cleanup(func() { @@ -140,7 +206,14 @@ func (c *TestContext) ConfigureForTest(t *testing.T) { t.Fatalf("Expected test name with subtest, got: %s", testName) } sanitizedName := strings.ToLower(regexp.MustCompile(`[^a-zA-Z0-9]`).ReplaceAllString(parts[1], "_")) - snapshotPath := filepath.Join("..", "..", "..", "test", "snapshots", testFile, sanitizedName+".yaml") + // Anchor the snapshot path to the caller's source directory rather than the + // process working directory: the in-process transport chdir's into the test's + // isolated work dir (the worker inherits the process cwd), so a cwd-relative + // path would resolve against the wrong root for every subtest after the first. + // All e2e test files live in go/internal/e2e, so the repo root is three levels + // up from the caller's directory. + repoRoot := filepath.Join(filepath.Dir(callerFile), "..", "..", "..") + snapshotPath := filepath.Join(repoRoot, "test", "snapshots", testFile, sanitizedName+".yaml") absSnapshotPath, err := filepath.Abs(snapshotPath) if err != nil { @@ -152,8 +225,21 @@ func (c *TestContext) ConfigureForTest(t *testing.T) { } } +// ConfigureWithoutSnapshot initializes the replay proxy without loading a recorded CAPI +// exchange file. Use this for tests that serve all model-layer behavior locally but +// still need proxy-backed auth and GitHub API endpoints. +func (c *TestContext) ConfigureWithoutSnapshot(t *testing.T) { + t.Helper() + + dummySnapshotPath := filepath.Join(c.WorkDir, "__no_snapshot__.yaml") + if err := c.proxy.Configure(dummySnapshotPath, c.WorkDir); err != nil { + t.Fatalf("Failed to configure proxy without snapshot: %v", err) + } +} + // Close cleans up the test context resources. func (c *TestContext) Close(testFailed bool) { + c.restoreInProcessEnvironment() if c.proxy != nil { c.proxy.StopWithOptions(testFailed) } @@ -165,11 +251,72 @@ func (c *TestContext) Close(testFailed bool) { } } +// applyInProcessEnvironment mirrors the isolated test environment onto the real +// process for in-process hosting: the worker inherits this process's env and cwd +// at spawn, so per-test redirects must live on os.Environ and the process cwd. +// Auth flows via GH_TOKEN/GITHUB_TOKEN (the FFI argv omits the stdio auth-token +// wiring); the ambient HMAC signing key is removed process-wide at package load +// (see init) so host-side auth matches the replay snapshots. mergedEnv is the +// effective per-client env (harness defaults plus any per-test additions); workDir +// is the effective working directory. Values are restored in Close. Safe to call +// more than once (restores unwind in reverse). +func (c *TestContext) applyInProcessEnvironment(mergedEnv []string, workDir string) { + inprocessEnv := map[string]string{} + for _, kv := range mergedEnv { + if key, value, ok := strings.Cut(kv, "="); ok { + inprocessEnv[key] = value + } + } + // Auth flows via GH_TOKEN/GITHUB_TOKEN for the in-process host, overriding any + // inherited values. The HMAC key is neutralized process-wide at package load. + inprocessEnv["GH_TOKEN"] = defaultGitHubToken + inprocessEnv["GITHUB_TOKEN"] = defaultGitHubToken + inprocessEnv["COPILOT_CLI_PATH"] = c.CLIPath + delete(inprocessEnv, "COPILOT_HMAC_KEY") + delete(inprocessEnv, "CAPI_HMAC_KEY") + + for key, value := range inprocessEnv { + prev, had := os.LookupEnv(key) + c.restoreEnv = append(c.restoreEnv, envRestore{key: key, prev: prev, had: had}) + os.Setenv(key, value) + } + if workDir != "" { + if c.restoreCwd == "" { + if cwd, err := os.Getwd(); err == nil { + c.restoreCwd = cwd + } + } + os.Chdir(workDir) + } +} + +// restoreInProcessEnvironment undoes applyInProcessEnvironment during teardown. +func (c *TestContext) restoreInProcessEnvironment() { + for i := len(c.restoreEnv) - 1; i >= 0; i-- { + r := c.restoreEnv[i] + if r.had { + os.Setenv(r.key, r.prev) + } else { + os.Unsetenv(r.key) + } + } + c.restoreEnv = nil + if c.restoreCwd != "" { + os.Chdir(c.restoreCwd) + c.restoreCwd = "" + } +} + // GetExchanges retrieves the captured HTTP exchanges from the proxy. func (c *TestContext) GetExchanges() ([]ParsedHttpExchange, error) { return c.proxy.GetExchanges() } +// GetRequests retrieves all captured outbound HTTP requests from the proxy. +func (c *TestContext) GetRequests() ([]CapturedRequest, error) { + return c.proxy.GetRequests() +} + // WaitForExchanges waits until the proxy has captured at least the requested exchanges. func (c *TestContext) WaitForExchanges(t *testing.T, minimumCount int) []ParsedHttpExchange { t.Helper() @@ -207,11 +354,18 @@ func (c *TestContext) Env() []string { env = append(env, c.proxy.ProxyEnv()...) env = append(env, "COPILOT_API_URL="+c.ProxyURL, + // Route GitHub API calls (e.g. the MCP registry policy check) to the + // replay proxy so MCP enablement stays hermetic. Without this the CLI + // reaches the real api.github.com, which is slow/unreachable on macOS + // CI runners and makes MCP servers time out before reaching connected. + "COPILOT_DEBUG_GITHUB_API_URL="+c.ProxyURL, "COPILOT_HOME="+c.HomeDir, "COPILOT_SDK_AUTH_TOKEN="+defaultGitHubToken, "GH_CONFIG_DIR="+c.HomeDir, "GH_TOKEN="+defaultGitHubToken, "GITHUB_TOKEN="+defaultGitHubToken, + "COPILOT_MCP_APPS=true", + "MCP_APPS=true", "XDG_CONFIG_HOME="+c.HomeDir, "XDG_STATE_HOME="+c.HomeDir, ) @@ -231,14 +385,44 @@ func (c *TestContext) NewClient(opts ...func(*copilot.ClientOptions)) *copilot.C opt(options) } - _, externalRuntime := options.Connection.(copilot.UriConnection) + _, externalRuntime := options.Connection.(copilot.URIConnection) if options.GitHubToken == "" && !externalRuntime { options.GitHubToken = defaultGitHubToken } + // Under the inprocess matrix cell, host the default stdio connection in-process. + // The worker inherits this process's ambient env/cwd (per-client env and working + // directory are rejected in-process), so mirror the effective (merged) env and + // cwd onto the real process and drop those options. Tests that pin a specific + // transport (TCP/URI/custom stdio) or configure per-client telemetry are left on + // their transport, mirroring the Node/.NET harnesses. + if c.inProcess && c.shouldUseInProcess(options) { + c.applyInProcessEnvironment(options.Env, options.WorkingDirectory) + options.Connection = copilot.InProcessConnection{} + options.Env = nil + options.WorkingDirectory = "" + } + return copilot.NewClient(options) } +// shouldUseInProcess reports whether a client built from options should be hosted +// in-process for the inprocess matrix cell. Only the harness default stdio +// connection is swapped; a test that pins a custom stdio path/args/env or a +// TCP/URI connection is exercising behavior that must stay on its own transport. +// +// Options the in-process runtime cannot support (per-client telemetry, an LLM +// inference provider) are NOT silently downgraded here — the affected tests skip +// explicitly via testharness.SkipIfInProcess so the limitation is visible rather +// than masked by a quiet transport swap. +func (c *TestContext) shouldUseInProcess(options *copilot.ClientOptions) bool { + s, ok := options.Connection.(copilot.StdioConnection) + if !ok { + return false + } + return s.Path == c.CLIPath && len(s.Args) == 0 && s.Env == nil +} + func fileExists(path string) bool { _, err := os.Stat(path) return err == nil diff --git a/go/internal/e2e/testharness/helper.go b/go/internal/e2e/testharness/helper.go index ca94d03ad..af08b2dbc 100644 --- a/go/internal/e2e/testharness/helper.go +++ b/go/internal/e2e/testharness/helper.go @@ -3,11 +3,32 @@ package testharness import ( "context" "errors" + "path/filepath" + "runtime" "time" copilot "github.com/github/copilot-sdk/go" ) +// RepoPath resolves a path relative to the repository root, anchored to this +// source file's directory rather than the process working directory. The +// in-process (FFI) transport os.Chdir's the whole test process into a per-test +// temp workdir (the shared runtime host inherits the process cwd), so any +// cwd-relative resolution (e.g. filepath.Abs("../../../test/...")) would break +// for every test after the first in-process one. This helper stays correct +// regardless of the current working directory. +func RepoPath(elem ...string) string { + _, callerFile, _, ok := runtime.Caller(0) + if !ok { + // Fall back to a cwd-relative join; only correct before any chdir. + return filepath.Join(append([]string{"..", "..", ".."}, elem...)...) + } + // This file lives at go/internal/e2e/testharness/, so the repo root is four + // levels up from its directory. + repoRoot := filepath.Join(filepath.Dir(callerFile), "..", "..", "..", "..") + return filepath.Join(append([]string{repoRoot}, elem...)...) +} + // GetFinalAssistantMessage waits for and returns the final assistant message from a session turn. // If alreadyIdle is true, skip waiting for session.idle (useful for resumed sessions where the // idle event was ephemeral and not persisted in the event history). diff --git a/go/internal/e2e/testharness/proxy.go b/go/internal/e2e/testharness/proxy.go index e407f13e0..2545882bc 100644 --- a/go/internal/e2e/testharness/proxy.go +++ b/go/internal/e2e/testharness/proxy.go @@ -38,11 +38,14 @@ func (p *CapiProxy) Start() (string, error) { return p.proxyURL, nil } - // The harness server is in the shared test directory - serverPath := "../../../test/harness/server.ts" + // The harness server is in the shared test directory. Anchor the path to + // the repo root (not the process cwd), because the in-process (FFI) + // transport os.Chdir's into a per-test temp workdir, which would otherwise + // break the cwd-relative resolution. + serverPath := RepoPath("test", "harness", "server.ts") p.cmd = exec.Command("npx", "tsx", serverPath) - p.cmd.Dir = "." // Will be resolved relative to test execution + p.cmd.Dir = RepoPath("test", "harness") stdout, err := p.cmd.StdoutPipe() if err != nil { @@ -185,6 +188,38 @@ func (p *CapiProxy) GetExchanges() ([]ParsedHttpExchange, error) { return exchanges, nil } +// GetRequests retrieves all captured outbound HTTP requests from the proxy. +func (p *CapiProxy) GetRequests() ([]CapturedRequest, error) { + p.mu.Lock() + url := p.proxyURL + p.mu.Unlock() + + if url == "" { + return nil, fmt.Errorf("proxy not started") + } + + resp, err := http.Get(url + "/requests") + if err != nil { + return nil, fmt.Errorf("failed to get requests: %w", err) + } + defer resp.Body.Close() + + var requests []CapturedRequest + if err := json.NewDecoder(resp.Body).Decode(&requests); err != nil { + return nil, fmt.Errorf("failed to decode requests: %w", err) + } + + return requests, nil +} + +// CapturedRequest represents an outbound HTTP request captured by the proxy. +type CapturedRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]json.RawMessage `json:"headers"` + Body string `json:"body"` +} + // ParsedHttpExchange represents a captured HTTP exchange. type ParsedHttpExchange struct { Request ChatCompletionRequest `json:"request"` @@ -256,8 +291,9 @@ type ChatCompletionTool struct { // ChatCompletionToolFunction represents a function tool. type ChatCompletionToolFunction struct { - Name string `json:"name"` - Description string `json:"description,omitempty"` + Name string `json:"name"` + Description string `json:"description,omitempty"` + Parameters json.RawMessage `json:"parameters,omitempty"` } // ChatCompletionResponse represents an OpenAI chat completion response. diff --git a/go/internal/e2e/tools_e2e_test.go b/go/internal/e2e/tools_e2e_test.go index 621f7758d..062d37791 100644 --- a/go/internal/e2e/tools_e2e_test.go +++ b/go/internal/e2e/tools_e2e_test.go @@ -84,6 +84,92 @@ func TestToolsE2E(t *testing.T) { } }) + t.Run("low_level_tool_definition", func(t *testing.T) { + ctx.ConfigureForTest(t) + + type PhaseArgs struct { + Phase string `json:"phase" jsonschema:"Current phase,enum=searching,enum=analyzing,enum=done"` + } + type SearchArgs struct { + Keyword string `json:"keyword" jsonschema:"Search keyword"` + } + + var mu sync.Mutex + currentPhase := "" + searchKeyword := "" + + setCurrentPhaseTool := copilot.DefineTool("set_current_phase", "Sets the current phase of the agent", + func(params PhaseArgs, inv copilot.ToolInvocation) (string, error) { + mu.Lock() + currentPhase = params.Phase + mu.Unlock() + return "Phase set to " + params.Phase, nil + }) + + searchItemsTool := copilot.DefineTool("search_items", "Search for items by keyword", + func(params SearchArgs, inv copilot.ToolInvocation) (string, error) { + mu.Lock() + searchKeyword = params.Keyword + mu.Unlock() + return "Found: item_alpha, item_beta", nil + }) + + session, err := client.CreateSession(t.Context(), &copilot.SessionConfig{ + OnPermissionRequest: copilot.PermissionHandler.ApproveAll, + AvailableTools: copilot.NewToolSet().AddCustom("*").AddBuiltIn("web_fetch").ToSlice(), + Tools: []copilot.Tool{ + setCurrentPhaseTool, + searchItemsTool, + }, + }) + if err != nil { + t.Fatalf("Failed to create session: %v", err) + } + + _, err = session.Send(t.Context(), copilot.MessageOptions{ + Prompt: "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results.", + }) + if err != nil { + t.Fatalf("Failed to send message: %v", err) + } + + answer, err := testharness.GetFinalAssistantMessage(t.Context(), session) + if err != nil { + t.Fatalf("Failed to get assistant message: %v", err) + } + + if answer == nil { + t.Fatalf("Expected non-nil assistant message") + return + } + ad, ok := answer.Data.(*copilot.AssistantMessageData) + if !ok { + t.Fatalf("Expected AssistantMessageData") + } + + content := ad.Content + if content == "" { + t.Fatalf("Expected non-empty response") + } + lower := strings.ToLower(content) + if !strings.Contains(lower, "analyzing") { + t.Errorf("Expected response to contain 'analyzing', got %q", content) + } + if !strings.Contains(lower, "item_alpha") && !strings.Contains(lower, "item_beta") { + t.Errorf("Expected response to contain 'item_alpha' or 'item_beta', got %q", content) + } + mu.Lock() + gotPhase := currentPhase + gotKeyword := searchKeyword + mu.Unlock() + if gotKeyword != "copilot" { + t.Errorf("Expected search keyword to be 'copilot', got %q", gotKeyword) + } + if gotPhase != "analyzing" { + t.Errorf("Expected currentPhase to be 'analyzing', got %q", gotPhase) + } + }) + t.Run("handles tool calling errors", func(t *testing.T) { ctx.ConfigureForTest(t) diff --git a/go/internal/embeddedcli/embeddedcli.go b/go/internal/embeddedcli/embeddedcli.go index 0866a3f81..cd0be2189 100644 --- a/go/internal/embeddedcli/embeddedcli.go +++ b/go/internal/embeddedcli/embeddedcli.go @@ -6,6 +6,7 @@ import ( "fmt" "io" "os" + "os/exec" "path/filepath" "runtime" "strings" @@ -18,15 +19,30 @@ import ( // Config defines the inputs used to install and locate the embedded Copilot CLI. // // Cli and CliHash are required. If Dir is empty, the CLI is installed into the -// system cache directory. Version is used to suffix the installed binary name to -// allow multiple versions to coexist. License, when provided, is written next -// to the installed binary. +// system cache directory. When Version is set, the CLI is installed into a +// version-specific child directory so multiple versions can coexist. License, +// when provided, is written next to the installed binary. +// +// RuntimeLib and RuntimeLibHash are optional: when set, the native in-process +// runtime library (cdylib) is installed next to the CLI binary so the in-process +// (FFI) transport can load it. They are omitted for CLI packages that do not +// ship the native runtime. type Config struct { Cli io.Reader CliHash []byte License []byte + RuntimeLib io.Reader + RuntimeLibHash []byte + + // LinuxMuslCli and LinuxMuslRuntimeLib are optional alternatives selected + // automatically when the application runs on a musl-based Linux system. + LinuxMuslCli io.Reader + LinuxMuslCliHash []byte + LinuxMuslRuntimeLib io.Reader + LinuxMuslRuntimeLibHash []byte + Dir string Version string } @@ -38,6 +54,12 @@ func Setup(cfg Config) { if len(cfg.CliHash) != sha256.Size { panic(fmt.Sprintf("CliHash must be a SHA-256 hash (%d bytes), got %d bytes", sha256.Size, len(cfg.CliHash))) } + if cfg.LinuxMuslCli != nil && len(cfg.LinuxMuslCliHash) != sha256.Size { + panic(fmt.Sprintf("LinuxMuslCliHash must be a SHA-256 hash (%d bytes), got %d bytes", sha256.Size, len(cfg.LinuxMuslCliHash))) + } + if cfg.LinuxMuslRuntimeLib != nil && len(cfg.LinuxMuslRuntimeLibHash) != sha256.Size { + panic(fmt.Sprintf("LinuxMuslRuntimeLibHash must be a SHA-256 hash (%d bytes), got %d bytes", sha256.Size, len(cfg.LinuxMuslRuntimeLibHash))) + } setupMu.Lock() defer setupMu.Unlock() if setupDone { @@ -61,14 +83,28 @@ var Path = sync.OnceValue(func() string { return path }) +// RuntimeLibPath returns the on-disk path to the installed native in-process +// runtime library (cdylib), or "" when no runtime library was bundled or the +// CLI could not be installed. It ensures the embedded CLI is installed first. +func RuntimeLibPath() string { + Path() + setupMu.Lock() + defer setupMu.Unlock() + return runtimeLibPath +} + var ( config Config setupMu sync.Mutex setupDone bool pathInitialized bool + runtimeLibPath string + linuxMuslBundle bool ) func install() (path string) { + selectLinuxMuslBundle() + verbose := os.Getenv("COPILOT_CLI_INSTALL_VERBOSE") == "1" logError := func(msg string, err error) { if verbose { @@ -103,18 +139,41 @@ func install() (path string) { return path } -func installAt(installDir string) (string, error) { - if err := os.MkdirAll(installDir, 0755); err != nil { - return "", fmt.Errorf("creating install directory: %w", err) +func selectLinuxMuslBundle() { + if runtime.GOOS != "linux" || config.LinuxMuslCli == nil || !isMusl() { + return } + config = linuxMuslConfig(config) + linuxMuslBundle = true +} + +func linuxMuslConfig(cfg Config) Config { + cfg.Cli = cfg.LinuxMuslCli + cfg.CliHash = cfg.LinuxMuslCliHash + cfg.RuntimeLib = cfg.LinuxMuslRuntimeLib + cfg.RuntimeLibHash = cfg.LinuxMuslRuntimeLibHash + return cfg +} + +func isMusl() bool { + out, _ := exec.Command("ldd", "--version").CombinedOutput() + return strings.Contains(strings.ToLower(string(out)), "musl") +} + +func installAt(installDir string) (string, error) { version := sanitizeVersion(config.Version) - lockName := ".copilot-cli.lock" if version != "" { - lockName = fmt.Sprintf(".copilot-cli-%s.lock", version) + installDir = filepath.Join(installDir, version) + } + if linuxMuslBundle { + installDir = filepath.Join(installDir, "linuxmusl") + } + if err := os.MkdirAll(installDir, 0755); err != nil { + return "", fmt.Errorf("creating install directory: %w", err) } // Best effort to prevent concurrent installs. - if release, _ := flock.Acquire(filepath.Join(installDir, lockName)); release != nil { + if release, _ := flock.Acquire(filepath.Join(installDir, ".copilot-cli.lock")); release != nil { defer release() } @@ -122,7 +181,7 @@ func installAt(installDir string) (string, error) { if runtime.GOOS == "windows" { binaryName += ".exe" } - finalPath := versionedBinaryPath(installDir, binaryName, version) + finalPath := filepath.Join(installDir, binaryName) if _, err := os.Stat(finalPath); err == nil { existingHash, err := hashFile(finalPath) @@ -132,6 +191,13 @@ func installAt(installDir string) (string, error) { if !bytes.Equal(existingHash, config.CliHash) { return "", fmt.Errorf("existing binary hash mismatch") } + if config.RuntimeLib != nil { + libPath, err := installRuntimeLib(installDir) + if err != nil { + return "", err + } + runtimeLibPath = libPath + } return finalPath, nil } @@ -155,17 +221,81 @@ func installAt(installDir string) (string, error) { return "", fmt.Errorf("writing license file: %w", err) } } + + // Install the native in-process runtime library (if bundled) next to the CLI. + // Fail closed on any hash mismatch; never place unverified native code. + if config.RuntimeLib != nil { + libPath, err := installRuntimeLib(installDir) + if err != nil { + return "", err + } + runtimeLibPath = libPath + } + return finalPath, nil } -// versionedBinaryPath builds the unpacked binary filename with an optional version suffix. -func versionedBinaryPath(dir, binaryName, version string) string { - if version == "" { - return filepath.Join(dir, binaryName) +// installRuntimeLib writes the embedded runtime cdylib into installDir under its +// natural platform file name, verifying its SHA-256. It is idempotent: an +// existing file with a matching hash is reused; a mismatch is a hard error. +func installRuntimeLib(installDir string) (string, error) { + if len(config.RuntimeLibHash) != sha256.Size { + return "", fmt.Errorf("RuntimeLibHash must be a SHA-256 hash (%d bytes), got %d bytes", sha256.Size, len(config.RuntimeLibHash)) + } + libPath := filepath.Join(installDir, naturalRuntimeLibName()) + + if _, err := os.Stat(libPath); err == nil { + existingHash, err := hashFile(libPath) + if err != nil { + return "", fmt.Errorf("hashing existing runtime library: %w", err) + } + if !bytes.Equal(existingHash, config.RuntimeLibHash) { + return "", fmt.Errorf("existing runtime library hash mismatch") + } + return libPath, nil + } + + // Write to a temp file in the same directory, verify, then atomically rename. + tmp, err := os.CreateTemp(installDir, ".copilot-runtime-*.tmp") + if err != nil { + return "", fmt.Errorf("creating temp runtime library: %w", err) + } + tmpPath := tmp.Name() + h := sha256.New() + _, err = io.Copy(io.MultiWriter(tmp, h), config.RuntimeLib) + if err1 := tmp.Close(); err1 != nil && err == nil { + err = err1 + } + if closer, ok := config.RuntimeLib.(io.Closer); ok { + closer.Close() + } + if err != nil { + os.Remove(tmpPath) + return "", fmt.Errorf("writing runtime library: %w", err) + } + if !bytes.Equal(h.Sum(nil), config.RuntimeLibHash) { + os.Remove(tmpPath) + return "", fmt.Errorf("runtime library hash mismatch") + } + if err := os.Rename(tmpPath, libPath); err != nil { + os.Remove(tmpPath) + return "", fmt.Errorf("installing runtime library: %w", err) + } + return libPath, nil +} + +// naturalRuntimeLibName is the flat platform file name for the runtime cdylib, +// matching ffihost.NaturalLibraryName (kept in sync; embeddedcli stays +// dependency-free for use by generated embed files). +func naturalRuntimeLibName() string { + switch runtime.GOOS { + case "windows": + return "copilot_runtime.dll" + case "darwin": + return "libcopilot_runtime.dylib" + default: + return "libcopilot_runtime.so" } - base := strings.TrimSuffix(binaryName, filepath.Ext(binaryName)) - ext := filepath.Ext(binaryName) - return filepath.Join(dir, fmt.Sprintf("%s_%s%s", base, version, ext)) } // sanitizeVersion makes a version string safe for filenames. @@ -188,7 +318,11 @@ func sanitizeVersion(version string) string { b.WriteRune('_') } } - return b.String() + sanitized := b.String() + if sanitized == "." || sanitized == ".." { + return strings.Repeat("_", len(sanitized)) + } + return sanitized } // hashFile returns the SHA-256 hash of a file on disk. diff --git a/go/internal/embeddedcli/embeddedcli_test.go b/go/internal/embeddedcli/embeddedcli_test.go index 0453f7293..b0394e0f6 100644 --- a/go/internal/embeddedcli/embeddedcli_test.go +++ b/go/internal/embeddedcli/embeddedcli_test.go @@ -16,6 +16,8 @@ func resetGlobals() { config = Config{} setupDone = false pathInitialized = false + runtimeLibPath = "" + linuxMuslBundle = false } func mustPanic(t *testing.T, fn func()) { @@ -36,6 +38,31 @@ func binaryNameForOS() string { return name } +func TestLinuxMuslConfigSelectsAlternativeArtifacts(t *testing.T) { + glibcCLI := strings.NewReader("glibc-cli") + glibcRuntime := strings.NewReader("glibc-runtime") + muslCLI := strings.NewReader("musl-cli") + muslRuntime := strings.NewReader("musl-runtime") + muslCLIHash := bytes.Repeat([]byte{1}, sha256.Size) + muslRuntimeHash := bytes.Repeat([]byte{2}, sha256.Size) + + selected := linuxMuslConfig(Config{ + Cli: glibcCLI, + RuntimeLib: glibcRuntime, + LinuxMuslCli: muslCLI, + LinuxMuslCliHash: muslCLIHash, + LinuxMuslRuntimeLib: muslRuntime, + LinuxMuslRuntimeLibHash: muslRuntimeHash, + }) + + if selected.Cli != muslCLI || selected.RuntimeLib != muslRuntime { + t.Fatal("Expected Linux musl artifacts to replace the glibc artifacts") + } + if !bytes.Equal(selected.CliHash, muslCLIHash) || !bytes.Equal(selected.RuntimeLibHash, muslRuntimeHash) { + t.Fatal("Expected Linux musl hashes to replace the glibc hashes") + } +} + func TestSetupPanicsOnNilCli(t *testing.T) { resetGlobals() mustPanic(t, func() { Setup(Config{}) }) @@ -65,7 +92,7 @@ func TestInstallAtWritesBinaryAndLicense(t *testing.T) { path := Path() - expectedPath := versionedBinaryPath(tempDir, binaryNameForOS(), "1.2.3") + expectedPath := filepath.Join(tempDir, "1.2.3", binaryNameForOS()) if path != expectedPath { t.Fatalf("unexpected path: got %q want %q", path, expectedPath) } @@ -99,7 +126,7 @@ func TestInstallAtWritesBinaryAndLicense(t *testing.T) { func TestInstallAtExistingBinaryHashMismatch(t *testing.T) { resetGlobals() tempDir := t.TempDir() - binaryPath := versionedBinaryPath(tempDir, binaryNameForOS(), "") + binaryPath := filepath.Join(tempDir, binaryNameForOS()) if err := os.MkdirAll(filepath.Dir(binaryPath), 0755); err != nil { t.Fatalf("mkdir: %v", err) } @@ -120,17 +147,102 @@ func TestInstallAtExistingBinaryHashMismatch(t *testing.T) { } func TestSanitizeVersion(t *testing.T) { - got := sanitizeVersion("v1.2.3+build/abc") - want := "v1.2.3_build_abc" - if got != want { - t.Fatalf("sanitizeVersion() = %q want %q", got, want) + tests := map[string]string{ + "v1.2.3+build/abc": "v1.2.3_build_abc", + ".": "_", + "..": "__", + } + for input, want := range tests { + if got := sanitizeVersion(input); got != want { + t.Errorf("sanitizeVersion(%q) = %q want %q", input, got, want) + } } } -func TestVersionedBinaryPath(t *testing.T) { - got := versionedBinaryPath("/tmp", "copilot.exe", "1.0.0") - want := filepath.Join("/tmp", "copilot_1.0.0.exe") - if got != want { - t.Fatalf("versionedBinaryPath() = %q want %q", got, want) +func TestInstallAtAllowsMultipleRuntimeVersions(t *testing.T) { + resetGlobals() + tempDir := t.TempDir() + + installVersion := func(version string, cliContent, runtimeContent []byte) (string, string) { + t.Helper() + cliHash := sha256.Sum256(cliContent) + runtimeHash := sha256.Sum256(runtimeContent) + config = Config{ + Cli: bytes.NewReader(cliContent), + CliHash: cliHash[:], + RuntimeLib: bytes.NewReader(runtimeContent), + RuntimeLibHash: runtimeHash[:], + Version: version, + } + + cliPath, err := installAt(tempDir) + if err != nil { + t.Fatalf("install version %s: %v", version, err) + } + return cliPath, runtimeLibPath + } + + cli1, runtime1 := installVersion("1.0.0", []byte("cli-one"), []byte("runtime-one")) + cli2, runtime2 := installVersion("2.0.0", []byte("cli-two"), []byte("runtime-two")) + + if cli1 == cli2 { + t.Fatalf("Expected versioned CLI paths to differ, got %q", cli1) + } + if runtime1 == runtime2 { + t.Fatalf("Expected versioned runtime paths to differ, got %q", runtime1) + } + if got, want := filepath.Base(cli1), binaryNameForOS(); got != want { + t.Fatalf("First CLI filename = %q, want %q", got, want) + } + if got, want := filepath.Base(runtime1), naturalRuntimeLibName(); got != want { + t.Fatalf("First runtime filename = %q, want %q", got, want) + } + if got, want := filepath.Base(filepath.Dir(cli1)), "1.0.0"; got != want { + t.Fatalf("First CLI version directory = %q, want %q", got, want) + } + if filepath.Dir(cli1) != filepath.Dir(runtime1) { + t.Fatalf("CLI and runtime were installed in different directories: %q and %q", cli1, runtime1) + } + if got, err := os.ReadFile(runtime1); err != nil || string(got) != "runtime-one" { + t.Fatalf("Unexpected first runtime: content=%q err=%v", got, err) + } + if got, err := os.ReadFile(runtime2); err != nil || string(got) != "runtime-two" { + t.Fatalf("Unexpected second runtime: content=%q err=%v", got, err) + } +} + +func TestInstallAtExistingBinaryInstallsMissingRuntime(t *testing.T) { + resetGlobals() + tempDir := t.TempDir() + versionDir := filepath.Join(tempDir, "1.2.3") + if err := os.MkdirAll(versionDir, 0755); err != nil { + t.Fatalf("mkdir: %v", err) + } + + cliContent := []byte("cli") + cliPath := filepath.Join(versionDir, binaryNameForOS()) + if err := os.WriteFile(cliPath, cliContent, 0755); err != nil { + t.Fatalf("write CLI: %v", err) + } + cliHash := sha256.Sum256(cliContent) + runtimeContent := []byte("runtime") + runtimeHash := sha256.Sum256(runtimeContent) + config = Config{ + Cli: bytes.NewReader(cliContent), + CliHash: cliHash[:], + RuntimeLib: bytes.NewReader(runtimeContent), + RuntimeLibHash: runtimeHash[:], + Version: "1.2.3", + } + + gotCLIPath, err := installAt(tempDir) + if err != nil { + t.Fatalf("installAt(): %v", err) + } + if gotCLIPath != cliPath { + t.Fatalf("installAt() = %q, want %q", gotCLIPath, cliPath) + } + if got, err := os.ReadFile(filepath.Join(versionDir, naturalRuntimeLibName())); err != nil || string(got) != "runtime" { + t.Fatalf("Unexpected runtime: content=%q err=%v", got, err) } } diff --git a/go/internal/ffihost/buffer.go b/go/internal/ffihost/buffer.go new file mode 100644 index 000000000..2185ce833 --- /dev/null +++ b/go/internal/ffihost/buffer.go @@ -0,0 +1,67 @@ +//go:build copilot_inprocess && (darwin || linux || windows) + +package ffihost + +import ( + "io" + "sync" +) + +// receiveBuffer is a thread-safe byte buffer that feeds blocking Read from a +// producer thread. The native outbound callback (invoked on a foreign runtime +// thread) appends frames via feed without ever blocking; the JSON-RPC reader +// goroutine drains them via Read, which blocks until data or EOF. +// +// It implements io.ReadCloser so it can be handed to jsonrpc2.NewClient as the +// server → client stream. +type receiveBuffer struct { + mu sync.Mutex + cond *sync.Cond + buf []byte + closed bool +} + +func newReceiveBuffer() *receiveBuffer { + rb := &receiveBuffer{} + rb.cond = sync.NewCond(&rb.mu) + return rb +} + +func (rb *receiveBuffer) feed(data []byte) { + rb.mu.Lock() + defer rb.mu.Unlock() + if rb.closed { + return + } + rb.buf = append(rb.buf, data...) + rb.cond.Broadcast() +} + +// Read blocks until at least one byte is available or the buffer is closed. +// It returns io.EOF only once the buffer is closed and fully drained. +func (rb *receiveBuffer) Read(p []byte) (int, error) { + if len(p) == 0 { + return 0, nil + } + rb.mu.Lock() + defer rb.mu.Unlock() + for len(rb.buf) == 0 && !rb.closed { + rb.cond.Wait() + } + if len(rb.buf) == 0 { + return 0, io.EOF + } + n := copy(p, rb.buf) + rb.buf = rb.buf[n:] + return n, nil +} + +// Close marks the buffer closed; subsequent Reads drain remaining bytes then +// return io.EOF. Idempotent. +func (rb *receiveBuffer) Close() error { + rb.mu.Lock() + defer rb.mu.Unlock() + rb.closed = true + rb.cond.Broadcast() + return nil +} diff --git a/go/internal/ffihost/ffihost.go b/go/internal/ffihost/ffihost.go new file mode 100644 index 000000000..30cd83128 --- /dev/null +++ b/go/internal/ffihost/ffihost.go @@ -0,0 +1,384 @@ +//go:build copilot_inprocess && (darwin || linux || windows) + +// Package ffihost hosts the Copilot runtime in-process by loading its native +// library and driving JSON-RPC over the runtime's C ABI. +// +// It pumps opaque LSP Content-Length-framed JSON-RPC bytes across the boundary: +// +// - client → server frames go to copilot_runtime_connection_write +// - server → client frames arrive on a native callback that feeds a +// thread-safe receive buffer read by the JSON-RPC client +// +// The existing internal/jsonrpc2 client handles framing unchanged — this is a +// transport swap, not a new protocol. Host exposes an io.WriteCloser (client → +// server) and io.ReadCloser (server → client) that plug straight into +// jsonrpc2.NewClient. +// +// The C ABI (shared with the .NET, Node.js, Python, and Rust SDKs): +// +// uint32 copilot_runtime_host_start(uint8 *argv, size_t argv_len, +// uint8 *env, size_t env_len); +// bool copilot_runtime_host_shutdown(uint32 server_id); +// uint32 copilot_runtime_connection_open(uint32 server_id, outbound cb, +// void *user_data, +// uint8 *a, size_t a_len, +// uint8 *b, size_t b_len, +// uint8 *c, size_t c_len); +// bool copilot_runtime_connection_write(uint32 conn_id, uint8 *bytes, size_t len); +// bool copilot_runtime_connection_close(uint32 conn_id); +// // outbound callback: +// void outbound(void *user_data, uint8 *bytes, size_t len); +// +// The native binding uses github.com/ebitengine/purego so the library is loaded +// at runtime with CGO disabled, preserving the SDK's pure-Go build and +// cross-compilation. +package ffihost + +import ( + "encoding/json" + "fmt" + "io" + "runtime" + "strings" + "sync" + "sync/atomic" + "unsafe" + + "github.com/ebitengine/purego" +) + +const symbolPrefix = "copilot_runtime_" + +// ffiLibrary binds the copilot_runtime_* C ABI exports of a loaded cdylib. +type ffiLibrary struct { + handle uintptr + hostStart func(argv unsafe.Pointer, argvLen uintptr, env unsafe.Pointer, envLen uintptr) uint32 + hostShutdown func(serverID uint32) bool + connectionOpen func(serverID uint32, cb uintptr, userData uintptr, a unsafe.Pointer, aLen uintptr, b unsafe.Pointer, bLen uintptr, c unsafe.Pointer, cLen uintptr) uint32 + connectionWrite func(connID uint32, bytes unsafe.Pointer, length uintptr) bool + connectionClose func(connID uint32) bool +} + +// The cdylib may only be loaded once per process; a second load of a different +// path is unsupported (matches the .NET/Node/Python/Rust hosts). Guard it here. +var ( + loadMu sync.Mutex + loadedLibrary *ffiLibrary + loadedLibraryPath string +) + +var ( + outboundCallbackOnce sync.Once + outboundCallbackHandle uintptr + outboundTargets sync.Map + nextOutboundToken atomic.Uint64 +) + +func sharedOutboundCallback() uintptr { + outboundCallbackOnce.Do(func() { + outboundCallbackHandle = purego.NewCallback(routeOutbound) + }) + return outboundCallbackHandle +} + +func routeOutbound(userData uintptr, bytesPtr uintptr, bytesLen uintptr) uintptr { + target, ok := outboundTargets.Load(userData) + if !ok { + return 0 + } + return target.(*Host).onOutbound(bytesPtr, bytesLen) +} + +func loadLibrary(libraryPath string) (lib *ffiLibrary, err error) { + loadMu.Lock() + defer loadMu.Unlock() + + if loadedLibrary != nil { + if loadedLibraryPath != libraryPath { + return nil, fmt.Errorf( + "an in-process FFI runtime library is already loaded from %q; loading a different library from %q in the same process is not supported", + loadedLibraryPath, libraryPath) + } + return loadedLibrary, nil + } + + handle, err := openLibrary(libraryPath) + if err != nil { + return nil, fmt.Errorf("loading FFI runtime library %q: %w", libraryPath, err) + } + + // RegisterLibFunc panics if a symbol is missing; convert that to an error so + // callers get a clean failure instead of a crash. + defer func() { + if r := recover(); r != nil { + err = fmt.Errorf("binding FFI runtime library %q: %v", libraryPath, r) + lib = nil + } + }() + + bound := &ffiLibrary{handle: handle} + purego.RegisterLibFunc(&bound.hostStart, handle, symbolPrefix+"host_start") + purego.RegisterLibFunc(&bound.hostShutdown, handle, symbolPrefix+"host_shutdown") + purego.RegisterLibFunc(&bound.connectionOpen, handle, symbolPrefix+"connection_open") + purego.RegisterLibFunc(&bound.connectionWrite, handle, symbolPrefix+"connection_write") + purego.RegisterLibFunc(&bound.connectionClose, handle, symbolPrefix+"connection_close") + + loadedLibrary = bound + loadedLibraryPath = libraryPath + return bound, nil +} + +// Host hosts the Copilot runtime in-process via its native C ABI. +// +// Construct with Create, call Start to open the FFI connection, wire +// Writer/Reader into jsonrpc2.NewClient, and call Dispose to tear everything +// down. +type Host struct { + libraryPath string + cliEntrypoint string + environment map[string]string + args []string + lib *ffiLibrary + + // lifecycleMu serializes native start/write/shutdown operations. hostStart + // cannot be interrupted, so Dispose waits for it before closing native IDs. + lifecycleMu sync.Mutex + // mu serializes disposal with native callbacks so the receive buffer cannot + // be fed after it is closed. + mu sync.Mutex + serverID uint32 + connectionID uint32 + disposed bool + // activeCallbacks counts outbound native callbacks currently executing. + activeCallbacks int + + recv *receiveBuffer + + callbackToken uintptr +} + +// Create resolves the native library and prepares the host. environment and +// args contain SDK-managed runtime options. +func Create(cliEntrypoint string, environment map[string]string, args []string) (*Host, error) { + libraryPath, err := ResolveLibraryPath(cliEntrypoint) + if err != nil { + return nil, err + } + lib, err := loadLibrary(libraryPath) + if err != nil { + return nil, err + } + return &Host{ + libraryPath: libraryPath, + cliEntrypoint: cliEntrypoint, + environment: environment, + args: append([]string(nil), args...), + lib: lib, + recv: newReceiveBuffer(), + }, nil +} + +// Start opens the FFI connection. Native startup may block, so callers should +// run it off any latency-sensitive goroutine. +func (h *Host) Start() error { + h.lifecycleMu.Lock() + defer h.lifecycleMu.Unlock() + + h.mu.Lock() + if h.disposed { + h.mu.Unlock() + return fmt.Errorf("the in-process runtime host is disposed") + } + h.mu.Unlock() + + argv := h.buildArgv() + env := h.buildEnv() + + var argvPtr, envPtr unsafe.Pointer + if len(argv) > 0 { + argvPtr = unsafe.Pointer(&argv[0]) + } + if len(env) > 0 { + envPtr = unsafe.Pointer(&env[0]) + } + + h.serverID = h.lib.hostStart(argvPtr, uintptr(len(argv)), envPtr, uintptr(len(env))) + // Keep the JSON buffers alive across the (synchronous) native call. + runtime.KeepAlive(argv) + runtime.KeepAlive(env) + if h.serverID == 0 { + return fmt.Errorf("copilot_runtime_host_start failed (library %q, entrypoint %q)", h.libraryPath, h.cliEntrypoint) + } + + // host_start spawned the worker child via libuv's uv_spawn, which installs a + // SIGCHLD handler without SA_ONSTACK on its first call. The Go runtime aborts + // ("non-Go code set up signal handler without SA_ONSTACK flag") when it later + // reaps one of its own os/exec children (e.g. a test-spawned MCP server) and + // the delivered SIGCHLD lands on a non-signal stack. Re-add SA_ONSTACK to that + // foreign handler now that it exists (implemented on darwin+linux; a no-op on + // other platforms, and before the first spawn there is nothing to fix — hence + // here rather than at library load). + rearmForeignSignalHandlers(h.lib.handle) + + callbackHandle := sharedOutboundCallback() + callbackToken := uintptr(nextOutboundToken.Add(1)) + outboundTargets.Store(callbackToken, h) + h.callbackToken = callbackToken + h.connectionID = h.lib.connectionOpen(h.serverID, callbackHandle, callbackToken, nil, 0, nil, 0, nil, 0) + if h.connectionID == 0 { + outboundTargets.Delete(callbackToken) + h.callbackToken = 0 + h.lib.hostShutdown(h.serverID) + rearmForeignSignalHandlers(h.lib.handle) + h.serverID = 0 + return fmt.Errorf("copilot_runtime_connection_open failed") + } + return nil +} + +// Writer returns the client → server frame sink (plug into jsonrpc2 as stdin). +func (h *Host) Writer() io.WriteCloser { return hostWriter{h} } + +// Reader returns the server → client frame source (plug into jsonrpc2 as stdout). +func (h *Host) Reader() io.ReadCloser { return h.recv } + +func (h *Host) buildArgv() []byte { + // A `.js` entrypoint (dev) is launched via node; the packaged single-file CLI + // embeds its own Node and is invoked directly. `--no-auto-update` pins the + // worker to the runtime package matching the loaded cdylib (avoids ABI skew). + var argv []string + if strings.HasSuffix(strings.ToLower(h.cliEntrypoint), ".js") { + argv = []string{"node", h.cliEntrypoint, "--embedded-host", "--no-auto-update"} + } else { + argv = []string{h.cliEntrypoint, "--embedded-host", "--no-auto-update"} + } + argv = append(argv, h.args...) + b, _ := json.Marshal(argv) + return b +} + +func (h *Host) buildEnv() []byte { + if len(h.environment) == 0 { + return nil + } + b, _ := json.Marshal(h.environment) + return b +} + +// onOutbound is the native server → client callback, invoked on a foreign +// runtime thread. The native pointer is only valid for this call, so the bytes +// are copied out before returning. Nothing may panic across the FFI boundary. +func (h *Host) onOutbound(bytesPtr uintptr, bytesLen uintptr) uintptr { + h.mu.Lock() + if h.disposed { + h.mu.Unlock() + return 0 + } + h.activeCallbacks++ + h.mu.Unlock() + + defer func() { + h.mu.Lock() + h.activeCallbacks-- + h.mu.Unlock() + // Never let a panic unwind into native code. + _ = recover() + }() + + if bytesPtr != 0 && bytesLen > 0 { + // The native runtime delivers the outbound frame as a raw buffer address + // (uintptr) plus length. Materialize a slice over it just long enough to + // copy the bytes into Go-owned memory before returning to native code. + //nolint:govet // FFI callback receives the buffer address as an integer; converting it to a pointer to copy out is the intended, checked-length use. + src := unsafe.Slice((*byte)(unsafe.Pointer(bytesPtr)), int(bytesLen)) + buf := make([]byte, len(src)) + copy(buf, src) + h.recv.feed(buf) + } + return 0 +} + +func (h *Host) writeFrame(frame []byte) (int, error) { + h.lifecycleMu.Lock() + defer h.lifecycleMu.Unlock() + + h.mu.Lock() + disposed := h.disposed + h.mu.Unlock() + connID := h.connectionID + if disposed || connID == 0 { + return 0, fmt.Errorf("the in-process runtime connection is closed") + } + if len(frame) == 0 { + return 0, nil + } + ok := h.lib.connectionWrite(connID, unsafe.Pointer(&frame[0]), uintptr(len(frame))) + runtime.KeepAlive(frame) + if !ok { + return 0, fmt.Errorf("failed to write a frame to the in-process runtime connection") + } + return len(frame), nil +} + +// Dispose closes the FFI connection, shuts down the native host, and releases +// resources. It is idempotent and waits for any in-flight outbound callback to +// finish before closing the receive buffer. +func (h *Host) Dispose() { + h.lifecycleMu.Lock() + defer h.lifecycleMu.Unlock() + + h.mu.Lock() + if h.disposed { + h.mu.Unlock() + return + } + // Publish disposed under the same lock onOutbound uses to check it, so no new + // callback can pass the check and increment activeCallbacks after the drain + // loop below observes zero. + h.disposed = true + connID := h.connectionID + serverID := h.serverID + callbackToken := h.callbackToken + h.connectionID = 0 + h.serverID = 0 + h.callbackToken = 0 + h.mu.Unlock() + + if callbackToken != 0 { + outboundTargets.Delete(callbackToken) + } + + // Stop accepting new callbacks and wait for in-flight ones to drain before + // closing the receive buffer they feed. + for { + h.mu.Lock() + if h.activeCallbacks == 0 { + h.mu.Unlock() + break + } + h.mu.Unlock() + runtime.Gosched() + } + + if connID != 0 { + h.lib.connectionClose(connID) + } + if serverID != 0 { + h.lib.hostShutdown(serverID) + // libuv may restore a previously saved SIGCHLD action while tearing down + // its final child watcher, so repair the process-wide handler again after + // shutdown before Go reaps another os/exec child. + rearmForeignSignalHandlers(h.lib.handle) + } + h.recv.Close() +} + +// hostWriter adapts Host into the io.WriteCloser jsonrpc2 writes request frames to. +type hostWriter struct{ h *Host } + +func (w hostWriter) Write(p []byte) (int, error) { return w.h.writeFrame(p) } + +func (w hostWriter) Close() error { + w.h.Dispose() + return nil +} diff --git a/go/internal/ffihost/ffihost_test.go b/go/internal/ffihost/ffihost_test.go new file mode 100644 index 000000000..bc588fa6a --- /dev/null +++ b/go/internal/ffihost/ffihost_test.go @@ -0,0 +1,98 @@ +//go:build copilot_inprocess && (darwin || linux || windows) + +package ffihost + +import ( + "encoding/json" + "sync/atomic" + "testing" + "time" + "unsafe" +) + +func TestDisposeUnregistersOutboundTarget(t *testing.T) { + token := uintptr(nextOutboundToken.Add(1)) + host := &Host{ + recv: newReceiveBuffer(), + callbackToken: token, + } + outboundTargets.Store(token, host) + + host.Dispose() + + if _, ok := outboundTargets.Load(token); ok { + t.Fatal("Expected disposed host to be removed from outbound callback registry") + } +} + +func TestBuildArgvAppendsManagedOptions(t *testing.T) { + host := &Host{ + cliEntrypoint: "copilot", + args: []string{"--log-level", "debug", "--remote"}, + } + + var argv []string + if err := json.Unmarshal(host.buildArgv(), &argv); err != nil { + t.Fatal(err) + } + + expected := []string{"copilot", "--embedded-host", "--no-auto-update", "--log-level", "debug", "--remote"} + if len(argv) != len(expected) { + t.Fatalf("Expected %d arguments, got %d: %v", len(expected), len(argv), argv) + } + for i := range expected { + if argv[i] != expected[i] { + t.Fatalf("Expected argument %d to be %q, got %q", i, expected[i], argv[i]) + } + } +} + +func TestDisposeWaitsForStartBeforeShuttingDown(t *testing.T) { + started := make(chan struct{}) + releaseStart := make(chan struct{}) + startDone := make(chan error, 1) + disposeDone := make(chan struct{}) + var shutdownID atomic.Uint32 + + host := &Host{ + lib: &ffiLibrary{ + hostStart: func(_ unsafe.Pointer, _ uintptr, _ unsafe.Pointer, _ uintptr) uint32 { + close(started) + <-releaseStart + return 41 + }, + hostShutdown: func(serverID uint32) bool { + shutdownID.Store(serverID) + return true + }, + connectionOpen: func(_ uint32, _ uintptr, _ uintptr, _ unsafe.Pointer, _ uintptr, _ unsafe.Pointer, _ uintptr, _ unsafe.Pointer, _ uintptr) uint32 { + return 42 + }, + connectionClose: func(_ uint32) bool { return true }, + }, + recv: newReceiveBuffer(), + } + + go func() { startDone <- host.Start() }() + <-started + go func() { + host.Dispose() + close(disposeDone) + }() + + select { + case <-disposeDone: + t.Fatal("Dispose returned before native startup completed") + case <-time.After(20 * time.Millisecond): + } + + close(releaseStart) + if err := <-startDone; err != nil { + t.Fatal(err) + } + <-disposeDone + + if got := shutdownID.Load(); got != 41 { + t.Fatalf("Expected shutdown of server 41, got %d", got) + } +} diff --git a/go/internal/ffihost/loader_other.go b/go/internal/ffihost/loader_other.go new file mode 100644 index 000000000..0b7bcc40b --- /dev/null +++ b/go/internal/ffihost/loader_other.go @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: MIT + +//go:build copilot_inprocess && (darwin || linux) + +package ffihost + +import "github.com/ebitengine/purego" + +// openLibrary loads the shared library at path and returns an opaque handle. +// RTLD_NOW surfaces any load problem here (eager binding) rather than at first +// call, matching the .NET/Python hosts; RTLD_LOCAL keeps the runtime's symbols +// private to this handle. +func openLibrary(path string) (uintptr, error) { + return purego.Dlopen(path, purego.RTLD_NOW|purego.RTLD_LOCAL) +} diff --git a/go/internal/ffihost/loader_windows.go b/go/internal/ffihost/loader_windows.go new file mode 100644 index 000000000..4ac2789f9 --- /dev/null +++ b/go/internal/ffihost/loader_windows.go @@ -0,0 +1,18 @@ +// SPDX-License-Identifier: MIT + +//go:build copilot_inprocess && windows + +package ffihost + +import "syscall" + +// openLibrary loads the DLL at path and returns its module handle. purego's +// RegisterLibFunc resolves exports from this handle via GetProcAddress, so the +// standard-library loader is sufficient and keeps CGO disabled. +func openLibrary(path string) (uintptr, error) { + handle, err := syscall.LoadLibrary(path) + if err != nil { + return 0, err + } + return uintptr(handle), nil +} diff --git a/go/internal/ffihost/resolve.go b/go/internal/ffihost/resolve.go new file mode 100644 index 000000000..c8d405232 --- /dev/null +++ b/go/internal/ffihost/resolve.go @@ -0,0 +1,117 @@ +package ffihost + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + "runtime" + "strings" + "sync" +) + +// NaturalLibraryName is the natural platform shared-library file name for the +// runtime cdylib — the `.node` file renamed to what a Rust cdylib would be +// called on this OS. The library is loaded by absolute path, so the on-disk name +// is ours to choose; this matches the flat name the bundler installs next to the +// CLI binary and the name the other SDKs use. +func NaturalLibraryName() string { + switch runtime.GOOS { + case "windows": + return "copilot_runtime.dll" + case "darwin": + return "libcopilot_runtime.dylib" + default: + return "libcopilot_runtime.so" + } +} + +// PrebuildsFolder returns the napi-rs `-` folder name the +// runtime package ships under prebuilds/ (e.g. linux-x64, darwin-arm64, +// win32-x64, including the musl variant on Alpine). Returns "" for unsupported +// platforms. +func PrebuildsFolder() string { + var platform string + switch runtime.GOOS { + case "linux": + if isMusl() { + platform = "linuxmusl" + } else { + platform = "linux" + } + case "darwin": + platform = "darwin" + case "windows": + platform = "win32" + default: + return "" + } + + var arch string + switch runtime.GOARCH { + case "amd64": + arch = "x64" + case "arm64": + arch = "arm64" + default: + return "" + } + return platform + "-" + arch +} + +// ResolveLibraryPath resolves the native runtime library next to the given CLI +// entrypoint. It checks, in order: +// +// 1. The natural platform library name next to the CLI (bundled/flat layout). +// 2. prebuilds//runtime.node next to the CLI (dev/package layout). +// +// It returns an error when neither exists. +func ResolveLibraryPath(cliEntrypoint string) (string, error) { + abs, err := filepath.Abs(cliEntrypoint) + if err != nil { + abs = cliEntrypoint + } + dir := filepath.Dir(abs) + + flat := filepath.Join(dir, NaturalLibraryName()) + if fileExists(flat) { + return flat, nil + } + + if folder := PrebuildsFolder(); folder != "" { + prebuilt := filepath.Join(dir, "prebuilds", folder, "runtime.node") + if fileExists(prebuilt) { + return prebuilt, nil + } + } + + return "", fmt.Errorf( + "in-process FFI runtime library not found next to %q (looked for %q and prebuilds/%s/runtime.node); "+ + "use a runtime package that ships the native library", + abs, NaturalLibraryName(), PrebuildsFolder()) +} + +func fileExists(path string) bool { + info, err := os.Stat(path) + return err == nil && !info.IsDir() +} + +var ( + muslOnce sync.Once + muslResult bool +) + +// isMusl reports whether the current Linux system uses musl libc (e.g. Alpine), +// which ships the runtime under the linuxmusl- prebuilds folder. +func isMusl() bool { + muslOnce.Do(func() { + if runtime.GOOS != "linux" { + return + } + // `ldd --version` prints "musl libc" on musl systems and errors/glibc text + // elsewhere; a best-effort check is enough to pick the prebuilds folder. + out, _ := exec.Command("ldd", "--version").CombinedOutput() + muslResult = strings.Contains(strings.ToLower(string(out)), "musl") + }) + return muslResult +} diff --git a/go/internal/ffihost/resolve_test.go b/go/internal/ffihost/resolve_test.go new file mode 100644 index 000000000..df3a668df --- /dev/null +++ b/go/internal/ffihost/resolve_test.go @@ -0,0 +1,54 @@ +package ffihost + +import ( + "os" + "path/filepath" + "testing" +) + +func TestResolveLibraryPathUsesNaturalLibraryNextToCLI(t *testing.T) { + dir := t.TempDir() + cliPath := filepath.Join(dir, "copilot") + libraryPath := filepath.Join(dir, NaturalLibraryName()) + + for _, path := range []string{cliPath, libraryPath} { + if err := os.WriteFile(path, []byte("test"), 0600); err != nil { + t.Fatalf("WriteFile(%q): %v", path, err) + } + } + + got, err := ResolveLibraryPath(cliPath) + if err != nil { + t.Fatalf("ResolveLibraryPath() error: %v", err) + } + if got != libraryPath { + t.Fatalf("ResolveLibraryPath() = %q, want %q", got, libraryPath) + } +} + +func TestResolveLibraryPathFallsBackToPrebuilds(t *testing.T) { + folder := PrebuildsFolder() + if folder == "" { + t.Skip("unsupported platform") + } + + dir := t.TempDir() + cliPath := filepath.Join(dir, "copilot") + libraryPath := filepath.Join(dir, "prebuilds", folder, "runtime.node") + if err := os.MkdirAll(filepath.Dir(libraryPath), 0755); err != nil { + t.Fatalf("MkdirAll(): %v", err) + } + for _, path := range []string{cliPath, libraryPath} { + if err := os.WriteFile(path, []byte("test"), 0600); err != nil { + t.Fatalf("WriteFile(%q): %v", path, err) + } + } + + got, err := ResolveLibraryPath(cliPath) + if err != nil { + t.Fatalf("ResolveLibraryPath() error: %v", err) + } + if got != libraryPath { + t.Fatalf("ResolveLibraryPath() = %q, want %q", got, libraryPath) + } +} diff --git a/go/internal/ffihost/sigonstack_darwin.go b/go/internal/ffihost/sigonstack_darwin.go new file mode 100644 index 000000000..2e7d2a99b --- /dev/null +++ b/go/internal/ffihost/sigonstack_darwin.go @@ -0,0 +1,81 @@ +// SPDX-License-Identifier: MIT + +//go:build copilot_inprocess && darwin + +package ffihost + +import ( + "encoding/binary" + "unsafe" + + "github.com/ebitengine/purego" +) + +// Darwin `struct sigaction` layout (16 bytes, little-endian on amd64/arm64): +// +// offset 0: union __sigaction_u sa_handler/sa_sigaction (8 bytes, pointer) +// offset 8: sigset_t sa_mask (4 bytes, uint32) +// offset 12: int sa_flags (4 bytes) +const ( + darwinSigactionSize = 16 + darwinFlagsOffset = 12 + saOnStack = 0x0001 // SA_ONSTACK on Darwin + sigDfl = 0 // SIG_DFL + sigIgn = 1 // SIG_IGN + maxSignal = 31 // NSIG-1 on Darwin +) + +// rearmForeignSignalHandlers re-adds the SA_ONSTACK flag to any signal handler +// installed by the native runtime (libnode/libuv, loaded via dlopen) that +// omitted it. The Go runtime aborts with "non-Go code set up signal handler +// without SA_ONSTACK flag" when such a signal (notably SIGCHLD, signal 20 on +// Darwin) is delivered while a Go-managed child process is reaped. libuv +// installs a SIGCHLD handler without SA_ONSTACK, which poisons every subsequent +// os/exec child reaped by Go in the same process (enforced by the Go runtime on +// both macOS and Linux; the Linux variant lives in sigonstack_linux.go). +// +// We preserve each foreign handler and merely OR in SA_ONSTACK, so libuv's child +// watching keeps working while the Go runtime stays happy. Handlers left at +// SIG_DFL/SIG_IGN and Go's own handlers (which already carry SA_ONSTACK) are +// untouched. Best-effort: any failure is silently ignored, since the worst case +// is the pre-existing crash. +func rearmForeignSignalHandlers(_ uintptr) { + handle, err := purego.Dlopen("/usr/lib/libSystem.B.dylib", purego.RTLD_NOW|purego.RTLD_GLOBAL) + if err != nil || handle == 0 { + return + } + + var sigaction func(sig int32, act, oact unsafe.Pointer) int32 + if !bindSigaction(handle, &sigaction) { + return + } + + for sig := int32(1); sig <= maxSignal; sig++ { + var cur [darwinSigactionSize]byte + if sigaction(sig, nil, unsafe.Pointer(&cur[0])) != 0 { + continue + } + handler := binary.LittleEndian.Uint64(cur[0:8]) + if handler == sigDfl || handler == sigIgn { + continue + } + flags := binary.LittleEndian.Uint32(cur[darwinFlagsOffset : darwinFlagsOffset+4]) + if flags&saOnStack != 0 { + continue + } + binary.LittleEndian.PutUint32(cur[darwinFlagsOffset:darwinFlagsOffset+4], flags|saOnStack) + sigaction(sig, unsafe.Pointer(&cur[0]), nil) + } +} + +// bindSigaction resolves libc's sigaction into fn, converting the panic +// RegisterLibFunc raises on a missing symbol into a false return. +func bindSigaction(handle uintptr, fn *func(sig int32, act, oact unsafe.Pointer) int32) (ok bool) { + defer func() { + if recover() != nil { + ok = false + } + }() + purego.RegisterLibFunc(fn, handle, "sigaction") + return true +} diff --git a/go/internal/ffihost/sigonstack_linux.go b/go/internal/ffihost/sigonstack_linux.go new file mode 100644 index 000000000..668cf6705 --- /dev/null +++ b/go/internal/ffihost/sigonstack_linux.go @@ -0,0 +1,82 @@ +// SPDX-License-Identifier: MIT + +//go:build copilot_inprocess && linux + +package ffihost + +import ( + "syscall" + "unsafe" +) + +const ( + linuxSaOnStack = 0x08000000 + linuxSigDfl = 0 + linuxSigIgn = 1 + linuxMaxSignal = 31 +) + +// linuxSigaction matches the kernel rt_sigaction ABI used by the Go runtime on +// Linux amd64 and arm64. +type linuxSigaction struct { + handler uintptr + flags uint64 + restorer uintptr + mask uint64 +} + +// rearmForeignSignalHandlers re-adds the SA_ONSTACK flag to any signal handler +// installed by the native runtime (libnode/libuv, loaded via dlopen) that +// omitted it. The Go runtime aborts with "non-Go code set up signal handler +// without SA_ONSTACK flag" when such a signal (notably SIGCHLD, signal 17 on +// Linux) is delivered while a Go-managed child process is reaped. libuv installs +// a SIGCHLD handler without SA_ONSTACK, which poisons every subsequent os/exec +// child reaped by Go in the same process. +// +// We preserve each foreign handler and merely OR in SA_ONSTACK, so libuv's child +// watching keeps working while the Go runtime stays happy. Handlers left at +// SIG_DFL/SIG_IGN and Go's own handlers (which already carry SA_ONSTACK) are +// untouched. Best-effort: any failure is silently ignored, since the worst case +// is the pre-existing crash. +func rearmForeignSignalHandlers(_ uintptr) { + for sig := 1; sig <= linuxMaxSignal; sig++ { + var action linuxSigaction + if !linuxGetSigaction(sig, &action) { + continue + } + if action.handler == linuxSigDfl || action.handler == linuxSigIgn { + continue + } + if action.flags&linuxSaOnStack != 0 { + continue + } + action.flags |= linuxSaOnStack + linuxSetSigaction(sig, &action) + } +} + +func linuxGetSigaction(signal int, action *linuxSigaction) bool { + _, _, errno := syscall.RawSyscall6( + syscall.SYS_RT_SIGACTION, + uintptr(signal), + 0, + uintptr(unsafe.Pointer(action)), + unsafe.Sizeof(action.mask), + 0, + 0, + ) + return errno == 0 +} + +func linuxSetSigaction(signal int, action *linuxSigaction) bool { + _, _, errno := syscall.RawSyscall6( + syscall.SYS_RT_SIGACTION, + uintptr(signal), + uintptr(unsafe.Pointer(action)), + 0, + unsafe.Sizeof(action.mask), + 0, + 0, + ) + return errno == 0 +} diff --git a/go/internal/ffihost/sigonstack_linux_test.go b/go/internal/ffihost/sigonstack_linux_test.go new file mode 100644 index 000000000..3a382385f --- /dev/null +++ b/go/internal/ffihost/sigonstack_linux_test.go @@ -0,0 +1,38 @@ +//go:build copilot_inprocess && linux + +package ffihost + +import ( + "os" + "os/signal" + "syscall" + "testing" +) + +func TestRearmForeignSignalHandlersAddsOnStack(t *testing.T) { + signals := make(chan os.Signal, 1) + signal.Notify(signals, syscall.SIGUSR1) + defer signal.Stop(signals) + + var original linuxSigaction + if !linuxGetSigaction(int(syscall.SIGUSR1), &original) { + t.Fatal("failed to read SIGUSR1 action") + } + defer linuxSetSigaction(int(syscall.SIGUSR1), &original) + + withoutOnStack := original + withoutOnStack.flags &^= linuxSaOnStack + if !linuxSetSigaction(int(syscall.SIGUSR1), &withoutOnStack) { + t.Fatal("failed to clear SA_ONSTACK") + } + + rearmForeignSignalHandlers(0) + + var rearmed linuxSigaction + if !linuxGetSigaction(int(syscall.SIGUSR1), &rearmed) { + t.Fatal("failed to read rearmed SIGUSR1 action") + } + if rearmed.flags&linuxSaOnStack == 0 { + t.Fatal("SA_ONSTACK was not restored") + } +} diff --git a/go/internal/ffihost/sigonstack_other.go b/go/internal/ffihost/sigonstack_other.go new file mode 100644 index 000000000..9da78255f --- /dev/null +++ b/go/internal/ffihost/sigonstack_other.go @@ -0,0 +1,10 @@ +// SPDX-License-Identifier: MIT + +//go:build copilot_inprocess && windows + +package ffihost + +// rearmForeignSignalHandlers is a no-op on platforms other than darwin and +// linux. Only those Unix platforms deliver the SA_ONSTACK-less SIGCHLD handler +// (installed by libuv) that the Go runtime rejects; Windows is unaffected. +func rearmForeignSignalHandlers(_ uintptr) {} diff --git a/go/internal/jsonrpc2/jsonrpc2.go b/go/internal/jsonrpc2/jsonrpc2.go index b2133e83c..09364057c 100644 --- a/go/internal/jsonrpc2/jsonrpc2.go +++ b/go/internal/jsonrpc2/jsonrpc2.go @@ -1,6 +1,7 @@ package jsonrpc2 import ( + "context" "crypto/rand" "encoding/json" "errors" @@ -202,8 +203,8 @@ func (c *Client) SetRequestHandler(method string, handler RequestHandler) { } // Request sends a JSON-RPC request and waits for the response -func (c *Client) Request(method string, params any) (json.RawMessage, error) { - return c.RequestWithInlineResponse(method, params, nil) +func (c *Client) Request(ctx context.Context, method string, params any) (json.RawMessage, error) { + return c.RequestWithInlineResponse(ctx, method, params, nil) } // RequestWithInlineResponse sends a JSON-RPC request and waits for the response, @@ -214,7 +215,13 @@ func (c *Client) Request(method string, params any) (json.RawMessage, error) { // server in the response) before any subsequent notification on the same // connection is dispatched. If the callback returns an error, that error is // returned to the awaiter in place of the response. -func (c *Client) RequestWithInlineResponse(method string, params any, onResponseInline func(json.RawMessage) error) (json.RawMessage, error) { +func (c *Client) RequestWithInlineResponse(ctx context.Context, method string, params any, onResponseInline func(json.RawMessage) error) (json.RawMessage, error) { + select { + case <-ctx.Done(): + return nil, ctx.Err() + default: + } + requestID := generateUUID() // Create response channel @@ -237,6 +244,8 @@ func (c *Client) RequestWithInlineResponse(method string, params any, onResponse // Check if process already exited before sending if c.processDone != nil { select { + case <-ctx.Done(): + return nil, ctx.Err() case <-c.processDone: if err := c.getProcessError(); err != nil { return nil, err @@ -266,13 +275,18 @@ func (c *Client) RequestWithInlineResponse(method string, params any, onResponse Params: paramsData, } - if err := c.sendMessage(request); err != nil { + if err := c.sendMessage(ctx, request); err != nil { + if ctxErr := ctx.Err(); ctxErr != nil { + return nil, ctxErr + } return nil, fmt.Errorf("failed to send request: %w", err) } // Wait for response, also checking for process exit if c.processDone != nil { select { + case <-ctx.Done(): + return nil, ctx.Err() case response := <-responseChan: if response.Error != nil { return nil, response.Error @@ -288,6 +302,8 @@ func (c *Client) RequestWithInlineResponse(method string, params any, onResponse } } select { + case <-ctx.Done(): + return nil, ctx.Err() case response := <-responseChan: if response.Error != nil { return nil, response.Error @@ -301,13 +317,26 @@ func (c *Client) RequestWithInlineResponse(method string, params any, onResponse // sendMessage writes a message to the stream. // Write serialization is achieved via a 1-buffered channel that holds the // writer when not in use, avoiding the need for a mutex on the write path. -func (c *Client) sendMessage(message any) error { +func (c *Client) sendMessage(ctx context.Context, message any) error { + select { + case <-ctx.Done(): + return ctx.Err() + default: + } + data, err := json.Marshal(message) if err != nil { return fmt.Errorf("failed to marshal message: %w", err) } - w := <-c.writer + var w *headerWriter + select { + case <-ctx.Done(): + return ctx.Err() + case <-c.stopChan: + return fmt.Errorf("client stopped") + case w = <-c.writer: + } defer func() { c.writer <- w }() return w.Write(data) } @@ -402,13 +431,15 @@ func (c *Client) handleResponse(response *Response) { } func (c *Client) handleRequest(request *Request) { + ctx := context.Background() + c.mu.Lock() handler := c.requestHandlers[request.Method] c.mu.Unlock() if handler == nil { if request.IsCall() { - c.sendErrorResponse(request.ID, &Error{ + c.sendErrorResponse(ctx, request.ID, &Error{ Code: ErrMethodNotFound.Code, Message: fmt.Sprintf("Method not found: %s", request.Method), }) @@ -425,7 +456,7 @@ func (c *Client) handleRequest(request *Request) { go func() { defer func() { if r := recover(); r != nil { - c.sendErrorResponse(request.ID, &Error{ + c.sendErrorResponse(ctx, request.ID, &Error{ Code: ErrInternal.Code, Message: fmt.Sprintf("request handler panic: %v", r), }) @@ -434,31 +465,31 @@ func (c *Client) handleRequest(request *Request) { result, err := handler(request.Params) if err != nil { - c.sendErrorResponse(request.ID, err) + c.sendErrorResponse(ctx, request.ID, err) return } - c.sendResponse(request.ID, result) + c.sendResponse(ctx, request.ID, result) }() } -func (c *Client) sendResponse(id json.RawMessage, result json.RawMessage) { +func (c *Client) sendResponse(ctx context.Context, id json.RawMessage, result json.RawMessage) { response := Response{ JSONRPC: version, ID: id, Result: result, } - if err := c.sendMessage(response); err != nil { + if err := c.sendMessage(ctx, response); err != nil { fmt.Printf("Failed to send JSON-RPC response: %v\n", err) } } -func (c *Client) sendErrorResponse(id json.RawMessage, rpcErr *Error) { +func (c *Client) sendErrorResponse(ctx context.Context, id json.RawMessage, rpcErr *Error) { response := Response{ JSONRPC: version, ID: id, Error: rpcErr, } - if err := c.sendMessage(response); err != nil { + if err := c.sendMessage(ctx, response); err != nil { fmt.Printf("Failed to send JSON-RPC error response: %v\n", err) } } diff --git a/go/internal/jsonrpc2/jsonrpc2_test.go b/go/internal/jsonrpc2/jsonrpc2_test.go index 26aa5a472..2c7bb3f56 100644 --- a/go/internal/jsonrpc2/jsonrpc2_test.go +++ b/go/internal/jsonrpc2/jsonrpc2_test.go @@ -1,6 +1,8 @@ package jsonrpc2 import ( + "bytes" + "context" "errors" "io" "sync" @@ -8,6 +10,12 @@ import ( "time" ) +type writeCloser struct { + io.Writer +} + +func (w writeCloser) Close() error { return nil } + func TestOnCloseCalledOnUnexpectedExit(t *testing.T) { stdinR, stdinW := io.Pipe() stdoutR, stdoutW := io.Pipe() @@ -137,7 +145,7 @@ func TestSetProcessDone_RequestMissesProcessError(t *testing.T) { stdoutW.Close() // Make a request — should get the specific process error. - _, err := client.Request("test.method", nil) + _, err := client.Request(context.Background(), "test.method", nil) if err != nil && err.Error() == "process exited unexpectedly" { misses++ } @@ -185,3 +193,101 @@ func TestSetProcessDone_ErrorCopiedEventually(t *testing.T) { t.Errorf("expected %q, got %q", processErr.Error(), err.Error()) } } + +func TestRequestReturnsContextErrorIfCanceledBeforeSend(t *testing.T) { + var stdin bytes.Buffer + client := NewClient(writeCloser{Writer: &stdin}, io.NopCloser(bytes.NewReader(nil))) + + ctx, cancel := context.WithCancel(context.Background()) + cancel() + + _, err := client.Request(ctx, "test.method", nil) + if !errors.Is(err, context.Canceled) { + t.Fatalf("expected context.Canceled, got %v", err) + } + if stdin.Len() != 0 { + t.Fatalf("expected no request to be written after cancellation, got %d bytes", stdin.Len()) + } + client.mu.Lock() + pending := len(client.pendingRequests) + client.mu.Unlock() + if pending != 0 { + t.Fatalf("expected no pending requests after cancellation, got %d", pending) + } +} + +func TestRequestReturnsContextErrorWhileAwaitingResponse(t *testing.T) { + var stdin bytes.Buffer + client := NewClient(writeCloser{Writer: &stdin}, io.NopCloser(bytes.NewReader(nil))) + ctx, cancel := context.WithCancel(context.Background()) + + errCh := make(chan error, 1) + go func() { + _, err := client.Request(ctx, "test.method", map[string]string{"hello": "world"}) + errCh <- err + }() + + waitForPendingRequest(t, client) + cancel() + + select { + case err := <-errCh: + if !errors.Is(err, context.Canceled) { + t.Fatalf("expected context.Canceled, got %v", err) + } + case <-time.After(time.Second): + t.Fatal("request did not return after context cancellation") + } + + client.mu.Lock() + pending := len(client.pendingRequests) + client.mu.Unlock() + if pending != 0 { + t.Fatalf("expected pending request cleanup after cancellation, got %d", pending) + } +} + +func TestSendMessageReturnsContextErrorWhileWaitingForWriter(t *testing.T) { + var stdin bytes.Buffer + client := NewClient(writeCloser{Writer: &stdin}, io.NopCloser(bytes.NewReader(nil))) + w := <-client.writer + defer func() { client.writer <- w }() + + ctx, cancel := context.WithCancel(context.Background()) + errCh := make(chan error, 1) + go func() { + errCh <- client.sendMessage(ctx, Request{JSONRPC: version, Method: "test.method"}) + }() + + cancel() + select { + case err := <-errCh: + if !errors.Is(err, context.Canceled) { + t.Fatalf("expected context.Canceled, got %v", err) + } + case <-time.After(time.Second): + t.Fatal("sendMessage did not return after context cancellation") + } +} + +func waitForPendingRequest(t *testing.T, client *Client) { + t.Helper() + deadline := time.After(time.Second) + ticker := time.NewTicker(time.Millisecond) + defer ticker.Stop() + + for { + client.mu.Lock() + pending := len(client.pendingRequests) + client.mu.Unlock() + if pending > 0 { + return + } + + select { + case <-deadline: + t.Fatal("timed out waiting for pending request") + case <-ticker.C: + } + } +} diff --git a/go/mode_empty.go b/go/mode_empty.go index a3e58ad9c..6057b2661 100644 --- a/go/mode_empty.go +++ b/go/mode_empty.go @@ -20,21 +20,21 @@ func validateNewClientForMode(opts *ClientOptions) { } // Empty mode requires durable, app-owned storage. Either: // - the app supplied a BaseDirectory the runtime can write to, - // - the app supplied a SessionFs implementation, + // - the app supplied a SessionFS implementation, // - or the app is connecting to an externally-managed runtime via - // UriConnection (in which case the host owns storage). + // URIConnection (in which case the host owns storage). if opts.BaseDirectory != "" { return } - if opts.SessionFs != nil { + if opts.SessionFS != nil { return } - if _, ok := opts.Connection.(UriConnection); ok { + if _, ok := opts.Connection.(URIConnection); ok { return } - panic("Client is in Mode=ModeEmpty but neither BaseDirectory, SessionFs, nor a UriConnection was supplied. " + - "Empty mode requires explicit, per-tenant storage; set ClientOptions.BaseDirectory or .SessionFs, " + - "or connect to an externally-managed runtime via UriConnection.") + panic("Client is in Mode=ModeEmpty but neither BaseDirectory, SessionFS, nor a URIConnection was supplied. " + + "Empty mode requires explicit, per-tenant storage; set ClientOptions.BaseDirectory or .SessionFS, " + + "or connect to an externally-managed runtime via URIConnection.") } // validateToolFilterList rejects bare "*" entries with an actionable error @@ -45,7 +45,7 @@ func validateToolFilterList(field string, list []string) error { if entry == "*" { return fmt.Errorf( "invalid %s entry %q: there is no bare wildcard. "+ - "Use one or more of NewToolSet().AddBuiltIn(\"*\"), .AddMcp(\"*\"), or .AddCustom(\"*\") "+ + "Use one or more of NewToolSet().AddBuiltIn(\"*\"), .AddMCP(\"*\"), or .AddCustom(\"*\") "+ "to target a specific source", field, entry) } @@ -122,6 +122,10 @@ func (c *Client) applyConfigDefaultsForMode(config *SessionConfig) { if c.options.Mode != ModeEmpty { return } + if config.EnableExperimentalMode == nil { + f := false + config.EnableExperimentalMode = &f + } if config.EnableSessionTelemetry == nil { f := false config.EnableSessionTelemetry = &f @@ -154,15 +158,26 @@ func (c *Client) applyConfigDefaultsForMode(config *SessionConfig) { f := false config.EnableSkills = &f } + if config.Memory == nil { + config.Memory = &MemoryConfiguration{Enabled: false} + } if config.MCPOAuthTokenStorage == "" { config.MCPOAuthTokenStorage = "in-memory" } + if config.CustomAgentsLocalOnly == nil { + localOnly := true + config.CustomAgentsLocalOnly = &localOnly + } } func (c *Client) applyResumeDefaultsForMode(config *ResumeSessionConfig) { if c.options.Mode != ModeEmpty { return } + if config.EnableExperimentalMode == nil { + f := false + config.EnableExperimentalMode = &f + } if config.EnableSessionTelemetry == nil { f := false config.EnableSessionTelemetry = &f @@ -195,9 +210,16 @@ func (c *Client) applyResumeDefaultsForMode(config *ResumeSessionConfig) { f := false config.EnableSkills = &f } + if config.Memory == nil { + config.Memory = &MemoryConfiguration{Enabled: false} + } if config.MCPOAuthTokenStorage == "" { config.MCPOAuthTokenStorage = "in-memory" } + if config.CustomAgentsLocalOnly == nil { + localOnly := true + config.CustomAgentsLocalOnly = &localOnly + } } // updateSessionOptionsForMode applies the per-mode safe-defaults patch via diff --git a/go/permission_context_test.go b/go/permission_context_test.go new file mode 100644 index 000000000..16c6d2d59 --- /dev/null +++ b/go/permission_context_test.go @@ -0,0 +1,260 @@ +package copilot + +import ( + "encoding/json" + "fmt" + "io" + "testing" + "time" + + "github.com/github/copilot-sdk/go/internal/jsonrpc2" + "github.com/github/copilot-sdk/go/rpc" +) + +// runPermissionExchange drives executePermissionAndRespond with the supplied +// handler and captures the raw JSON-RPC request frame the SDK emits (if any). +// The second return value reports whether a request was sent at all, so tests +// can assert that no-result decisions suppress the response entirely. +func runPermissionExchange(t *testing.T, handler PermissionHandlerFunc) (frame []byte, sent bool) { + t.Helper() + + stdinR, stdinW := io.Pipe() + stdoutR, stdoutW := io.Pipe() + t.Cleanup(func() { + stdinR.Close() + stdinW.Close() + stdoutR.Close() + stdoutW.Close() + }) + + client := jsonrpc2.NewClient(stdinW, stdoutR) + client.Start() + t.Cleanup(client.Stop) + + session := &Session{ + SessionID: "session-1", + client: client, + RPC: rpc.NewSessionRPC(client, "session-1"), + } + + frameCh := make(chan []byte, 1) + go func() { + captured, err := readTestJSONRPCFrame(stdinR) + if err != nil { + return + } + var request struct { + ID json.RawMessage `json:"id"` + } + _ = json.Unmarshal(captured, &request) + // Publish the captured frame before unblocking the RPC round trip so a + // sent response is always observable before executePermissionAndRespond + // returns. + frameCh <- captured + response := map[string]any{ + "jsonrpc": "2.0", + "id": json.RawMessage(request.ID), + "result": map[string]any{"applied": true}, + } + data, _ := json.Marshal(response) + _, _ = fmt.Fprintf(stdoutW, "Content-Length: %d\r\n\r\n%s", len(data), data) + }() + + done := make(chan struct{}) + go func() { + session.executePermissionAndRespond("permission-1", nil, handler) + close(done) + }() + + select { + case captured := <-frameCh: + return captured, true + case <-done: + select { + case captured := <-frameCh: + return captured, true + default: + return nil, false + } + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for permission response") + return nil, false + } +} + +// paramsOf extracts the top-level params object from a JSON-RPC request frame. +func paramsOf(t *testing.T, frame []byte) map[string]json.RawMessage { + t.Helper() + var request struct { + Method string `json:"method"` + Params map[string]json.RawMessage `json:"params"` + } + if err := json.Unmarshal(frame, &request); err != nil { + t.Fatalf("failed to unmarshal request frame: %v", err) + } + if request.Method != "session.permissions.handlePendingPermissionRequest" { + t.Fatalf("unexpected method %q", request.Method) + } + return request.Params +} + +func sampleDecisionContext() *rpc.PermissionDecisionContext { + return &rpc.PermissionDecisionContext{ + Outcome: PermissionDecisionOutcomeAutoApproved, + Source: PermissionDecisionSourceHostPolicy, + Surface: PermissionDecisionSurfaceSDK, + } +} + +func TestPermissionDecisionContextForwardedAsSiblingOfResult(t *testing.T) { + frame, sent := runPermissionExchange(t, func(PermissionRequest, PermissionInvocation) (rpc.PermissionDecision, error) { + return NewAttributedPermissionResult(&rpc.PermissionDecisionApproveOnce{}, sampleDecisionContext()), nil + }) + if !sent { + t.Fatal("expected a permission response to be sent") + } + + params := paramsOf(t, frame) + + // decisionContext must be a top-level sibling of result. + rawContext, ok := params["decisionContext"] + if !ok { + t.Fatal("expected decisionContext to be present as a top-level sibling of result") + } + var context rpc.PermissionDecisionContext + if err := json.Unmarshal(rawContext, &context); err != nil { + t.Fatalf("failed to unmarshal decisionContext: %v", err) + } + if context.Outcome != PermissionDecisionOutcomeAutoApproved || + context.Source != PermissionDecisionSourceHostPolicy || + context.Surface != PermissionDecisionSurfaceSDK { + t.Fatalf("unexpected decisionContext contents: %#v", context) + } + + // result must exist and must NOT contain a nested decisionContext. + rawResult, ok := params["result"] + if !ok { + t.Fatal("expected result to be present") + } + var result map[string]json.RawMessage + if err := json.Unmarshal(rawResult, &result); err != nil { + t.Fatalf("failed to unmarshal result: %v", err) + } + if _, nested := result["decisionContext"]; nested { + t.Fatal("decisionContext must not be nested inside result") + } +} + +func TestPermissionDecisionContextOmittedWithoutAttribution(t *testing.T) { + frame, sent := runPermissionExchange(t, func(PermissionRequest, PermissionInvocation) (rpc.PermissionDecision, error) { + return &rpc.PermissionDecisionApproveOnce{}, nil + }) + if !sent { + t.Fatal("expected a permission response to be sent") + } + + params := paramsOf(t, frame) + if _, ok := params["decisionContext"]; ok { + t.Fatal("expected decisionContext to be absent when no context is supplied") + } + if _, ok := params["result"]; !ok { + t.Fatal("expected result to be present") + } +} + +func TestAttributedResultReplacesRatherThanNests(t *testing.T) { + first := &rpc.PermissionDecisionContext{ + Outcome: PermissionDecisionOutcomePromptedUser, + Source: PermissionDecisionSourceHumanResponse, + Surface: PermissionDecisionSurfaceTui, + } + second := sampleDecisionContext() + + wrapped := NewAttributedPermissionResult(NewAttributedPermissionResult(&rpc.PermissionDecisionApproveOnce{}, first), second) + + if wrapped.DecisionContext != second { + t.Fatalf("expected the second context to replace the first, got %#v", wrapped.DecisionContext) + } + // The underlying decision must be the plain approve-once, not another wrapper. + if _, ok := wrapped.PermissionDecision.(*rpc.PermissionDecisionApproveOnce); !ok { + t.Fatalf("expected unwrapped decision to be *rpc.PermissionDecisionApproveOnce, got %T", wrapped.PermissionDecision) + } + + frame, sent := runPermissionExchange(t, func(PermissionRequest, PermissionInvocation) (rpc.PermissionDecision, error) { + return wrapped, nil + }) + if !sent { + t.Fatal("expected a permission response to be sent") + } + params := paramsOf(t, frame) + rawContext, ok := params["decisionContext"] + if !ok { + t.Fatal("expected decisionContext to be present") + } + var context rpc.PermissionDecisionContext + if err := json.Unmarshal(rawContext, &context); err != nil { + t.Fatalf("failed to unmarshal decisionContext: %v", err) + } + if context.Surface != PermissionDecisionSurfaceSDK { + t.Fatalf("expected replaced surface %q, got %q", PermissionDecisionSurfaceSDK, context.Surface) + } +} + +func TestAttributedNoResultStillSuppressesResponse(t *testing.T) { + frame, sent := runPermissionExchange(t, func(PermissionRequest, PermissionInvocation) (rpc.PermissionDecision, error) { + return NewAttributedPermissionResult(&rpc.PermissionDecisionNoResult{}, sampleDecisionContext()), nil + }) + if sent { + t.Fatalf("expected no response to be sent for an attributed no-result decision, got frame: %s", frame) + } +} + +// A handler may dereference the wrapper and return it by value. The embedded +// interface promotes its methods to the value type, so the value form also +// satisfies rpc.PermissionDecision and must be unwrapped identically to the +// pointer form -- otherwise the wrapper itself is sent as result and the +// context is silently dropped. +func TestValueFormAttributedResultIsUnwrapped(t *testing.T) { + frame, sent := runPermissionExchange(t, func(PermissionRequest, PermissionInvocation) (rpc.PermissionDecision, error) { + return *NewAttributedPermissionResult(&rpc.PermissionDecisionApproveOnce{}, sampleDecisionContext()), nil + }) + if !sent { + t.Fatal("expected a permission response to be sent") + } + + params := paramsOf(t, frame) + + if _, ok := params["decisionContext"]; !ok { + t.Fatal("expected decisionContext to be forwarded for a value-form attributed result") + } + + var result map[string]json.RawMessage + if err := json.Unmarshal(params["result"], &result); err != nil { + t.Fatalf("failed to unmarshal result: %v", err) + } + if _, nested := result["decisionContext"]; nested { + t.Fatal("decisionContext must not be nested inside result") + } + if _, leaked := result["PermissionDecision"]; leaked { + t.Fatal("the wrapper leaked into result instead of being unwrapped") + } +} + +func TestAttributedResultReplacesContextOnValueForm(t *testing.T) { + first := sampleDecisionContext() + second := &rpc.PermissionDecisionContext{ + Outcome: PermissionDecisionOutcomePromptedUser, + Source: PermissionDecisionSourceHumanResponse, + Surface: PermissionDecisionSurfaceTui, + } + + valueForm := *NewAttributedPermissionResult(&rpc.PermissionDecisionApproveOnce{}, first) + replaced := NewAttributedPermissionResult(valueForm, second) + + if replaced.DecisionContext != second { + t.Fatal("expected the second context to replace the first") + } + if _, nested := replaced.PermissionDecision.(AttributedPermissionResult); nested { + t.Fatal("value-form attribution must be replaced, not nested") + } +} diff --git a/go/permissions.go b/go/permissions.go index f86a72683..f27f9b6e6 100644 --- a/go/permissions.go +++ b/go/permissions.go @@ -1,15 +1,79 @@ package copilot import ( + "errors" + "github.com/github/copilot-sdk/go/rpc" ) +// AttributedPermissionResult pairs a permission decision with the context +// describing how it was reached, so the runtime can attribute auto-approval +// telemetry to the responding surface. +// +// The embedded [rpc.PermissionDecision] carries the actual decision, while +// DecisionContext is informational only and never changes permission behavior. +// It satisfies [rpc.PermissionDecision] itself, so a [PermissionHandlerFunc] +// can return it wherever a plain decision is expected. Prefer constructing it +// through [NewAttributedPermissionResult] rather than by hand. +// +// Experimental: AttributedPermissionResult is part of an experimental API and +// may change or be removed. +type AttributedPermissionResult struct { + rpc.PermissionDecision + // DecisionContext describes how and where the decision was reached. When nil + // the SDK omits it from the wire, preserving legacy behavior. + DecisionContext *rpc.PermissionDecisionContext +} + +// NewAttributedPermissionResult pairs a permission decision with the context +// describing how it was reached, so the runtime can attribute auto-approval +// telemetry to the responding surface. +// +// The returned value satisfies [rpc.PermissionDecision], so a +// [PermissionHandlerFunc] can return it directly. Passing an already-attributed +// result replaces the previous context rather than nesting it. If result is a +// [rpc.PermissionDecisionNoResult] (attributed or not), the SDK still +// suppresses the response. +// +// Experimental: NewAttributedPermissionResult is part of an experimental API +// and may change or be removed. +func NewAttributedPermissionResult(result rpc.PermissionDecision, decisionContext *rpc.PermissionDecisionContext) *AttributedPermissionResult { + decision, _ := splitAttribution(result) + return &AttributedPermissionResult{ + PermissionDecision: decision, + DecisionContext: decisionContext, + } +} + +// splitAttribution separates an optionally attributed result into the bare +// decision and its context, returning a nil context when there is none. +// +// Both the pointer and value forms are matched: embedding an interface promotes +// its methods to the value type too, so an AttributedPermissionResult passed by +// value also satisfies [rpc.PermissionDecision] and must not slip through +// unwrapped. +func splitAttribution(result rpc.PermissionDecision) (rpc.PermissionDecision, *rpc.PermissionDecisionContext) { + switch attributed := result.(type) { + case *AttributedPermissionResult: + return attributed.PermissionDecision, attributed.DecisionContext + case AttributedPermissionResult: + return attributed.PermissionDecision, attributed.DecisionContext + } + return result, nil +} + // PermissionHandler provides pre-built OnPermissionRequest implementations. var PermissionHandler = struct { - // ApproveAll approves all permission requests. + // ApproveAll approves permission requests when managed settings are disabled. ApproveAll PermissionHandlerFunc }{ - ApproveAll: func(_ PermissionRequest, _ PermissionInvocation) (rpc.PermissionDecision, error) { + ApproveAll: func(request PermissionRequest, invocation PermissionInvocation) (rpc.PermissionDecision, error) { + if invocation.ManagedSettingsEnabled { + return nil, errors.New("approveAll cannot be used when managed settings are enabled") + } + if request.RequiresManagedApproval() { + return &rpc.PermissionDecisionNoResult{}, nil + } return &rpc.PermissionDecisionApproveOnce{}, nil }, } diff --git a/go/permissions_test.go b/go/permissions_test.go new file mode 100644 index 000000000..517450dbf --- /dev/null +++ b/go/permissions_test.go @@ -0,0 +1,82 @@ +package copilot_test + +import ( + "encoding/json" + "testing" + + copilot "github.com/github/copilot-sdk/go" + "github.com/github/copilot-sdk/go/rpc" +) + +func TestPermissionEventExposesManagedApprovalRequired(t *testing.T) { + var data copilot.PermissionRequestedData + err := json.Unmarshal([]byte(`{ + "permissionRequest": { + "kind": "read", + "intention": "Read managed content", + "path": "/workspace/file.txt", + "managedApprovalRequired": true + }, + "requestId": "permission-1" + }`), &data) + if err != nil { + t.Fatal(err) + } + + if !data.PermissionRequest.RequiresManagedApproval() { + t.Fatal("expected managed approval to be required") + } +} + +func TestApproveAllApprovesOrdinaryRequest(t *testing.T) { + decision, err := copilot.PermissionHandler.ApproveAll( + &copilot.PermissionRequestRead{}, + copilot.PermissionInvocation{SessionID: "session-1"}, + ) + if err != nil { + t.Fatal(err) + } + if _, ok := decision.(*rpc.PermissionDecisionApproveOnce); !ok { + t.Fatalf("expected PermissionDecisionApproveOnce, got %T", decision) + } +} + +func TestApproveAllRejectsManagedSettingsSession(t *testing.T) { + decision, err := copilot.PermissionHandler.ApproveAll( + &copilot.PermissionRequestRead{}, + copilot.PermissionInvocation{ + SessionID: "session-1", + ManagedSettingsEnabled: true, + }, + ) + if err == nil { + t.Fatal("expected managed settings error") + } + if decision != nil { + t.Fatalf("expected no decision, got %T", decision) + } +} + +func TestApproveAllLeavesManagedRequestPending(t *testing.T) { + decision, err := copilot.PermissionHandler.ApproveAll( + &copilot.PermissionRequestRead{ManagedApprovalRequired: ptrTo(true)}, + copilot.PermissionInvocation{SessionID: "session-1"}, + ) + if err != nil { + t.Fatal(err) + } + if _, ok := decision.(*rpc.PermissionDecisionNoResult); !ok { + t.Fatalf("expected PermissionDecisionNoResult, got %T", decision) + } +} + +func TestRawPermissionRequestWithMalformedJSONRequiresManagedApproval(t *testing.T) { + request := rpc.RawPermissionRequest{Raw: json.RawMessage(`{"managedApprovalRequired":`)} + if !request.RequiresManagedApproval() { + t.Fatal("expected malformed raw request to fail closed") + } +} + +func ptrTo[T any](value T) *T { + return &value +} diff --git a/go/rpc/generated_rpc_api_shape_test.go b/go/rpc/generated_rpc_api_shape_test.go index bddbb263d..a6b357d54 100644 --- a/go/rpc/generated_rpc_api_shape_test.go +++ b/go/rpc/generated_rpc_api_shape_test.go @@ -16,8 +16,8 @@ var ( _ ExternalToolResult = (*ExternalToolTextResultForLlm)(nil) _ FilterMapping = FilterMappingEnumMap{} _ FilterMapping = ContentFilterModeMarkdown - _ McpServerConfig = (*McpServerConfigHTTP)(nil) - _ McpServerConfig = (*McpServerConfigStdio)(nil) + _ MCPServerConfig = (*MCPServerConfigHTTP)(nil) + _ MCPServerConfig = (*MCPServerConfigStdio)(nil) _ UIElicitationFieldValue = UIElicitationStringValue("") _ UIElicitationFieldValue = UIElicitationStringArrayValue(nil) _ UIElicitationFieldValue = UIElicitationBooleanValue(false) @@ -34,12 +34,12 @@ func TestGeneratedRPCAPIShape(t *testing.T) { assertInterfaceType(t, file, "FilterMapping") assertTypeExpr(t, fileSet, findTypeSpec(t, file, "FilterMappingEnumMap").Type, "map[string]ContentFilterMode") - assertInterfaceType(t, file, "McpServerConfig") - assertStructFieldType(t, file, fileSet, "McpConfigAddRequest", "Config", "McpServerConfig") - assertStructFieldType(t, file, fileSet, "McpConfigList", "Servers", "map[string]McpServerConfig") - assertStructFieldType(t, file, fileSet, "McpConfigUpdateRequest", "Config", "McpServerConfig") - assertStructFieldType(t, file, fileSet, "McpServerConfigHTTP", "FilterMapping", "FilterMapping") - assertStructFieldType(t, file, fileSet, "McpServerConfigStdio", "FilterMapping", "FilterMapping") + assertInterfaceType(t, file, "MCPServerConfig") + assertStructFieldType(t, file, fileSet, "MCPConfigAddRequest", "Config", "MCPServerConfig") + assertStructFieldType(t, file, fileSet, "MCPConfigList", "Servers", "map[string]MCPServerConfig") + assertStructFieldType(t, file, fileSet, "MCPConfigUpdateRequest", "Config", "MCPServerConfig") + assertStructFieldType(t, file, fileSet, "MCPServerConfigHTTP", "FilterMapping", "FilterMapping") + assertStructFieldType(t, file, fileSet, "MCPServerConfigStdio", "FilterMapping", "FilterMapping") assertInterfaceType(t, file, "UIElicitationFieldValue") assertTypeExpr(t, fileSet, findTypeSpec(t, file, "UIElicitationStringArrayValue").Type, "[]string") diff --git a/go/rpc/generated_rpc_union_test.go b/go/rpc/generated_rpc_union_test.go index c6f4c3b79..92bcb4c07 100644 --- a/go/rpc/generated_rpc_union_test.go +++ b/go/rpc/generated_rpc_union_test.go @@ -84,8 +84,8 @@ func TestFilterMappingJSONUnion(t *testing.T) { } } -func TestMcpServerConfigJSONUnion(t *testing.T) { - var localConfig McpServerConfig = &McpServerConfigStdio{ +func TestMCPServerConfigJSONUnion(t *testing.T) { + var localConfig MCPServerConfig = &MCPServerConfigStdio{ Args: []string{"-v"}, Command: "node", } @@ -97,16 +97,16 @@ func TestMcpServerConfigJSONUnion(t *testing.T) { t.Fatalf("marshal local config = %s", raw) } - decodedLocal, err := unmarshalMcpServerConfig([]byte(`{"args":["-v"],"command":"node"}`)) + decodedLocal, err := unmarshalMCPServerConfig([]byte(`{"args":["-v"],"command":"node"}`)) if err != nil { t.Fatalf("unmarshal local config: %v", err) } - decodedLocalValue, ok := decodedLocal.(*McpServerConfigStdio) + decodedLocalValue, ok := decodedLocal.(*MCPServerConfigStdio) if !ok || decodedLocalValue.Command != "node" || len(decodedLocalValue.Args) != 1 || decodedLocalValue.Args[0] != "-v" { t.Fatalf("unmarshal local config = %#v", decodedLocal) } - var httpConfig McpServerConfig = &McpServerConfigHTTP{URL: "https://example.com/mcp"} + var httpConfig MCPServerConfig = &MCPServerConfigHTTP{URL: "https://example.com/mcp"} raw, err = json.Marshal(httpConfig) if err != nil { t.Fatalf("marshal HTTP config: %v", err) @@ -115,21 +115,21 @@ func TestMcpServerConfigJSONUnion(t *testing.T) { t.Fatalf("marshal HTTP config = %s", raw) } - decodedHTTP, err := unmarshalMcpServerConfig([]byte(`{"url":"https://example.com/mcp"}`)) + decodedHTTP, err := unmarshalMCPServerConfig([]byte(`{"url":"https://example.com/mcp"}`)) if err != nil { t.Fatalf("unmarshal HTTP config: %v", err) } - decodedHTTPValue, ok := decodedHTTP.(*McpServerConfigHTTP) + decodedHTTPValue, ok := decodedHTTP.(*MCPServerConfigHTTP) if !ok || decodedHTTPValue.URL != "https://example.com/mcp" { t.Fatalf("unmarshal HTTP config = %#v", decodedHTTP) } - decodedRaw, err := unmarshalMcpServerConfig([]byte(`{"name":"future"}`)) + decodedRaw, err := unmarshalMCPServerConfig([]byte(`{"name":"future"}`)) if err != nil { t.Fatalf("unmarshal raw config: %v", err) } - if _, ok := decodedRaw.(*RawMcpServerConfigData); !ok { - t.Fatalf("unmarshal raw config = %T, want *RawMcpServerConfigData", decodedRaw) + if _, ok := decodedRaw.(*RawMCPServerConfigData); !ok { + t.Fatalf("unmarshal raw config = %T, want *RawMCPServerConfigData", decodedRaw) } } @@ -195,7 +195,7 @@ func TestCommandsInvokeUnmarshalsSlashCommandInvocationResult(t *testing.T) { }) input := "details" - result, err := NewSessionRpc(client, "session-1").Commands.Invoke(t.Context(), &CommandsInvokeRequest{ + result, err := NewSessionRPC(client, "session-1").Commands.Invoke(t.Context(), &CommandsInvokeRequest{ Input: &input, Name: "help", }) @@ -322,8 +322,8 @@ func TestUIElicitationSchemaPropertyJSONUnion(t *testing.T) { if !ok { t.Fatalf("count property = %T, want *UIElicitationSchemaPropertyNumber", schema.Properties["count"]) } - if count.Type() != UIElicitationSchemaPropertyTypeInteger { - t.Fatalf("count type = %q, want %q", count.Type(), UIElicitationSchemaPropertyTypeInteger) + if count.Discriminator != UIElicitationSchemaPropertyNumberTypeInteger { + t.Fatalf("count type = %q, want %q", count.Discriminator, UIElicitationSchemaPropertyNumberTypeInteger) } arrayChoice, ok := schema.Properties["arrayChoice"].(*UIElicitationArrayEnumField) diff --git a/go/rpc/permission_request_managed_approval.go b/go/rpc/permission_request_managed_approval.go new file mode 100644 index 000000000..020626893 --- /dev/null +++ b/go/rpc/permission_request_managed_approval.go @@ -0,0 +1,87 @@ +// Copyright (c) GitHub. All rights reserved. + +package rpc + +import "encoding/json" + +func managedApprovalRequired(value *bool) bool { + return value != nil && *value +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestCustomTool) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestExtensionManagement) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestExtensionPermissionAccess) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestFactory) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestHook) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestMCP) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestMemory) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestRead) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestShell) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestURL) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether managed policy requires an explicit +// human decision for this request. +func (r PermissionRequestWrite) RequiresManagedApproval() bool { + return managedApprovalRequired(r.ManagedApprovalRequired) +} + +// RequiresManagedApproval reports whether an unknown request carries managed +// approval metadata. +func (r RawPermissionRequest) RequiresManagedApproval() bool { + var metadata struct { + ManagedApprovalRequired *bool `json:"managedApprovalRequired"` + } + if json.Unmarshal(r.Raw, &metadata) != nil { + return true + } + return managedApprovalRequired(metadata.ManagedApprovalRequired) +} diff --git a/go/rpc/zrpc.go b/go/rpc/zrpc.go index e2c735ada..622c7a0cb 100644 --- a/go/rpc/zrpc.go +++ b/go/rpc/zrpc.go @@ -28,6 +28,33 @@ type AbortResult struct { Success bool `json:"success"` } +// Authenticated account entry returned by `account.getAllUsers`, with auth info and an +// optional associated token. +// Experimental: AccountAllUsers is part of an experimental API and may change or be removed. +type AccountAllUsers struct { + // Authentication information for this user + AuthInfo AuthInfo `json:"authInfo"` + // Associated token, if available + Token *string `json:"token,omitempty"` +} + +// List of all authenticated users +// Experimental: AccountGetAllUsersResult is part of an experimental API and may change or +// be removed. +type AccountGetAllUsersResult []AccountAllUsers + +// Current authentication state +// Experimental: AccountGetCurrentAuthResult is part of an experimental API and may change +// or be removed. +type AccountGetCurrentAuthResult struct { + // Authentication errors from the last auth attempt, if any + AuthErrors []string `json:"authErrors,omitzero"` + // Current authentication information, if authenticated + AuthInfo AuthInfo `json:"authInfo,omitempty"` +} + +// Experimental: AccountGetQuotaRequest is part of an experimental API and may change or be +// removed. type AccountGetQuotaRequest struct { // GitHub token for per-user quota lookup. When provided, resolves this token to determine // the user's quota instead of using the global auth. @@ -35,12 +62,55 @@ type AccountGetQuotaRequest struct { } // Quota usage snapshots for the resolved user, keyed by quota type. +// Experimental: AccountGetQuotaResult is part of an experimental API and may change or be +// removed. type AccountGetQuotaResult struct { // Quota snapshots keyed by type (e.g., chat, completions, premium_interactions) QuotaSnapshots map[string]AccountQuotaSnapshot `json:"quotaSnapshots"` } -// Schema for the `AccountQuotaSnapshot` type. +// Credentials to store after successful authentication +// Experimental: AccountLoginRequest is part of an experimental API and may change or be +// removed. +type AccountLoginRequest struct { + // GitHub host URL + Host string `json:"host"` + // User login/username + Login string `json:"login"` + // GitHub authentication token + Token string `json:"token"` +} + +// Result of a successful login; throws on failure +// Experimental: AccountLoginResult is part of an experimental API and may change or be +// removed. +type AccountLoginResult struct { + // Whether the credential was persisted to a secure store (system keychain, or the config + // file when plaintext storage is enabled). False when no secure store was available and the + // token was not saved, so the consumer can decide how to proceed. + StoredInVault bool `json:"storedInVault"` +} + +// User to log out +// Experimental: AccountLogoutRequest is part of an experimental API and may change or be +// removed. +type AccountLogoutRequest struct { + // Authentication information for the user to log out + AuthInfo AuthInfo `json:"authInfo"` +} + +// Logout result indicating if more users remain +// Experimental: AccountLogoutResult is part of an experimental API and may change or be +// removed. +type AccountLogoutResult struct { + // Whether other authenticated users remain after logout + HasMoreUsers bool `json:"hasMoreUsers"` +} + +// Quota usage snapshot for a Copilot quota type, including entitlement, used requests, +// overage, reset date, and remaining percentage. +// Experimental: AccountQuotaSnapshot is part of an experimental API and may change or be +// removed. type AccountQuotaSnapshot struct { // Number of requests included in the entitlement, or -1 for unlimited entitlements EntitlementRequests int64 `json:"entitlementRequests"` @@ -60,6 +130,30 @@ type AccountQuotaSnapshot struct { UsedRequests int64 `json:"usedRequests"` } +// Canonical directory where custom agents can be discovered or created, with scope, +// preference, and optional project path. +// Experimental: AgentDiscoveryPath is part of an experimental API and may change or be +// removed. +type AgentDiscoveryPath struct { + // Absolute path of the search/create directory (may not exist on disk yet) + Path string `json:"path"` + // Whether this is the canonical directory to create a new agent in its tier. At most one + // entry per tier is preferred. + PreferredForCreation bool `json:"preferredForCreation"` + // The input project path this directory was derived from (only for project scope) + ProjectPath *string `json:"projectPath,omitempty"` + // Which tier this directory belongs to + Scope AgentDiscoveryPathScope `json:"scope"` +} + +// Canonical locations where custom agents can be created so the runtime will recognize them. +// Experimental: AgentDiscoveryPathList is part of an experimental API and may change or be +// removed. +type AgentDiscoveryPathList struct { + // Canonical agent create/discovery directories, in priority order + Paths []AgentDiscoveryPath `json:"paths"` +} + // The currently selected custom agent, or null when using the default agent. // Experimental: AgentGetCurrentResult is part of an experimental API and may change or be // removed. @@ -68,7 +162,8 @@ type AgentGetCurrentResult struct { Agent *AgentInfo `json:"agent,omitempty"` } -// Schema for the `AgentInfo` type. +// Agent metadata, including identifiers, display details, source, tools, model, MCP +// servers, skills, and file path. // Experimental: AgentInfo is part of an experimental API and may change or be removed. type AgentInfo struct { // Description of the agent's purpose @@ -81,33 +176,49 @@ type AgentInfo struct { ID string `json:"id"` // MCP server configurations attached to this agent, keyed by server name. Server config // shape mirrors the MCP `mcpServers` schema. - // Experimental: McpServers is part of an experimental API and may change or be removed. - McpServers map[string]any `json:"mcpServers,omitempty"` - // Preferred model id for this agent. When omitted, inherits the outer agent's model. + // Experimental: MCPServers is part of an experimental API and may change or be removed. + MCPServers map[string]any `json:"mcpServers,omitzero"` + // Authored preferred model id for this agent. Runtime model selection may choose a + // different model; omitted means no authored preference. Model *string `json:"model,omitempty"` - // Unique identifier of the custom agent + // Name of the agent. Use `id` as the stable selection identifier. Name string `json:"name"` // Absolute local file path of the agent definition. Only set for file-based agents loaded // from disk; remote agents do not have a path. Path *string `json:"path,omitempty"` + // Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at + // invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. + Prompt *string `json:"prompt,omitempty"` // Skill names preloaded into this agent's context. Omitted means none. - Skills []string `json:"skills,omitempty"` + Skills []string `json:"skills,omitzero"` // Where the agent definition was loaded from Source *AgentInfoSource `json:"source,omitempty"` // Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. - Tools []string `json:"tools,omitempty"` + Tools []string `json:"tools,omitzero"` // Whether the agent can be selected directly by the user. Agents marked `false` are // subagent-only. UserInvocable *bool `json:"userInvocable,omitempty"` } -// Custom agents available to the session. +// Agents available to the session. // Experimental: AgentList is part of an experimental API and may change or be removed. type AgentList struct { - // Available custom agents + // Available agents Agents []AgentInfo `json:"agents"` } +type AgentListRequest struct { + // When true, request the session's configured built-in agents alongside custom agents. + // Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, + // but does not evaluate transient invocation requirements such as model availability. + // Built-in metadata may be omitted when the session cannot project it, such as a relay + // session. + IncludeBuiltInAgents *bool `json:"includeBuiltInAgents,omitempty"` + // When true, request authored base prompt text on each AgentInfo. Prompt text may be + // omitted when unavailable, such as for agents projected through a relay session. + IncludePrompt *bool `json:"includePrompt,omitempty"` +} + // Full registry entry for the spawned child. Lets the controller call // `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a // TOCTOU window). @@ -294,6 +405,18 @@ type AgentReloadResult struct { Agents []AgentInfo `json:"agents"` } +// Optional project paths to include in agent discovery. +// Experimental: AgentsDiscoverRequest is part of an experimental API and may change or be +// removed. +type AgentsDiscoverRequest struct { + // When true, omit the host's agents (the user-level agent directory and all plugin agents), + // leaving only project and remote agents. For multitenant deployments. + ExcludeHostAgents *bool `json:"excludeHostAgents,omitempty"` + // Optional list of project directory paths to scan for project-scoped agents. When omitted + // or empty, only user/plugin/remote-independent agents are returned (no project scan). + ProjectPaths []string `json:"projectPaths,omitzero"` +} + // Name of the custom agent to select for subsequent turns. // Experimental: AgentSelectRequest is part of an experimental API and may change or be // removed. @@ -310,29 +433,443 @@ type AgentSelectResult struct { Agent AgentInfo `json:"agent"` } +// An in-memory authored prompt override for an available agent. +// Experimental: AgentSetPromptRequest is part of an experimental API and may change or be +// removed. +type AgentSetPromptRequest struct { + // Stable effective agent id. Plugin namespace separators are normalized. + ID string `json:"id"` + // Replacement authored prompt. Empty text is valid. + Prompt string `json:"prompt"` +} + +// Optional project paths to include when enumerating agent discovery directories. +// Experimental: AgentsGetDiscoveryPathsRequest is part of an experimental API and may +// change or be removed. +type AgentsGetDiscoveryPathsRequest struct { + // When true, omit the host's user-level agent directory, leaving only project directories. + // For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + ExcludeHostAgents *bool `json:"excludeHostAgents,omitempty"` + // Optional list of project directory paths. When omitted or empty, only the user-level + // directory is returned. + ProjectPaths []string `json:"projectPaths,omitzero"` +} + // Indicates whether the operation succeeded and reports the post-mutation state. // Experimental: AllowAllPermissionSetResult is part of an experimental API and may change // or be removed. type AllowAllPermissionSetResult struct { - // Authoritative allow-all state after the mutation + // Authoritative full allow-all state after the mutation Enabled bool `json:"enabled"` + // Authoritative allow-all mode after the mutation + Mode *PermissionsAllowAllMode `json:"mode,omitempty"` // Whether the operation succeeded Success bool `json:"success"` } -// Current full allow-all permission state. +// Current allow-all permission mode. // Experimental: AllowAllPermissionState is part of an experimental API and may change or be // removed. type AllowAllPermissionState struct { // Whether full allow-all permissions are currently active Enabled bool `json:"enabled"` + // Current allow-all mode + Mode *PermissionsAllowAllMode `json:"mode,omitempty"` +} + +// A user message attachment — a file, directory, code selection, blob, GitHub-anchored +// pointer, or extension-supplied context payload +// Experimental: Attachment is part of an experimental API and may change or be removed. +type Attachment interface { + attachment() + Type() AttachmentType +} + +type RawAttachmentData struct { + Discriminator AttachmentType + Raw json.RawMessage +} + +func (RawAttachmentData) attachment() {} +func (r RawAttachmentData) Type() AttachmentType { + return r.Discriminator +} + +// Blob attachment with inline base64-encoded data +// Experimental: AttachmentBlob is part of an experimental API and may change or be removed. +type AttachmentBlob struct { + // Internal: content-addressed id of the session.binary_asset event holding this + // attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. + AssetID *string `json:"assetId,omitempty"` + // Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + ByteLength *int64 `json:"byteLength,omitempty"` + // Base64-encoded content. Present on input and for external consumers; replaced by an + // internal `assetId` reference in persisted events when interned to a content-addressed + // asset. + Data *string `json:"data,omitempty"` + // User-facing display name for the attachment + DisplayName *string `json:"displayName,omitempty"` + // MIME type of the inline data + MIMEType string `json:"mimeType"` + // Internal: why model-facing bytes are absent from persistence. Absent externally. + OmittedReason *OmittedBinaryOmittedReason `json:"omittedReason,omitempty"` +} + +func (AttachmentBlob) attachment() {} +func (AttachmentBlob) Type() AttachmentType { + return AttachmentTypeBlob +} + +// Directory attachment +// Experimental: AttachmentDirectory is part of an experimental API and may change or be +// removed. +type AttachmentDirectory struct { + // User-facing display name for the attachment + DisplayName string `json:"displayName"` + // Absolute directory path + Path string `json:"path"` + // Frozen rendered line this attachment contributed to the prompt block (e.g. + // "* /path (12 items)"). Captured at send time so resumed history reproduces the exact text + // the model saw, independent of later filesystem changes. + TaggedFilesEntry *string `json:"taggedFilesEntry,omitempty"` +} + +func (AttachmentDirectory) attachment() {} +func (AttachmentDirectory) Type() AttachmentType { + return AttachmentTypeDirectory +} + +// Structured context contributed by an extension. Composer pills displayed in the host are +// forwarded back through session.send.attachments, then rendered into the model prompt as +// an XML block. +// Experimental: AttachmentExtensionContext is part of an experimental API and may change or +// be removed. +type AttachmentExtensionContext struct { + // Provider-local canvas identifier when the push was bound to a canvas instance + CanvasID *string `json:"canvasId,omitempty"` + // ISO 8601 timestamp captured by the runtime when the push was accepted + CapturedAt time.Time `json:"capturedAt"` + // Owning extension identifier. Runtime-derived from the caller's connection when produced + // via session.extensions.sendAttachmentsToMessage; preserved verbatim on subsequent + // transports. + ExtensionID string `json:"extensionId"` + // Open canvas instance identifier when the push was bound to a canvas instance + InstanceID *string `json:"instanceId,omitempty"` + // Caller-supplied JSON payload + Payload any `json:"payload,omitempty"` + // Human-readable composer pill label + Title string `json:"title"` +} + +func (AttachmentExtensionContext) attachment() {} +func (AttachmentExtensionContext) Type() AttachmentType { + return AttachmentTypeExtensionContext +} + +// File attachment +// Experimental: AttachmentFile is part of an experimental API and may change or be removed. +type AttachmentFile struct { + // Internal: content-addressed id of the session.binary_asset event holding this + // attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. + AssetID *string `json:"assetId,omitempty"` + // Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + ByteLength *int64 `json:"byteLength,omitempty"` + // User-facing display name for the attachment + DisplayName string `json:"displayName"` + // Optional line range to scope the attachment to a specific section of the file + LineRange *AttachmentFileLineRange `json:"lineRange,omitempty"` + // Internal: MIME type of the file's model-facing bytes (post-resize for images). Set when + // the file's bytes are interned to an asset. Absent externally. + MIMEType *string `json:"mimeType,omitempty"` + // Internal: why model-facing bytes are absent from persistence. Absent externally. + OmittedReason *OmittedBinaryOmittedReason `json:"omittedReason,omitempty"` + // Absolute file path + Path string `json:"path"` + // Frozen rendered line this attachment contributed to the prompt block (e.g. + // "* /path (123 lines)"). Captured at send time so resumed history reproduces the exact + // text the model saw, independent of later filesystem changes. Present only for attachments + // routed to (mutually exclusive with assetId, which marks bytes sent + // natively). + TaggedFilesEntry *string `json:"taggedFilesEntry,omitempty"` +} + +func (AttachmentFile) attachment() {} +func (AttachmentFile) Type() AttachmentType { + return AttachmentTypeFile +} + +// Pointer to a GitHub Actions job. +// Experimental: AttachmentGitHubActionsJob is part of an experimental API and may change or +// be removed. +type AttachmentGitHubActionsJob struct { + // Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent + // for in-progress jobs. + Conclusion *string `json:"conclusion,omitempty"` + // Job id within the workflow run + JobID int64 `json:"jobId"` + // Display name of the job + JobName string `json:"jobName"` + // Repository the workflow run belongs to + Repo GitHubRepoRef `json:"repo"` + // URL to the job on GitHub + URL string `json:"url"` + // Display name of the workflow the job ran in + WorkflowName string `json:"workflowName"` +} + +func (AttachmentGitHubActionsJob) attachment() {} +func (AttachmentGitHubActionsJob) Type() AttachmentType { + return AttachmentTypeGitHubActionsJob +} + +// Pointer to a GitHub commit. +// Experimental: AttachmentGitHubCommit is part of an experimental API and may change or be +// removed. +type AttachmentGitHubCommit struct { + // First line of the commit message + Message string `json:"message"` + // Full commit SHA + Oid string `json:"oid"` + // Repository the commit belongs to + Repo GitHubRepoRef `json:"repo"` + // URL to the commit on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubCommit) attachment() {} +func (AttachmentGitHubCommit) Type() AttachmentType { + return AttachmentTypeGitHubCommit +} + +// Pointer to a file in a GitHub repository at a specific ref. +// Experimental: AttachmentGitHubFile is part of an experimental API and may change or be +// removed. +type AttachmentGitHubFile struct { + // Repository-relative path to the file + Path string `json:"path"` + // Git ref the file is read at (branch, tag, or commit SHA) + Ref string `json:"ref"` + // Repository the file lives in + Repo GitHubRepoRef `json:"repo"` + // URL to the file on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubFile) attachment() {} +func (AttachmentGitHubFile) Type() AttachmentType { + return AttachmentTypeGitHubFile +} + +// Pointer to a single-file diff. At least one of `head` and `base` must be present. +// Experimental: AttachmentGitHubFileDiff is part of an experimental API and may change or +// be removed. +type AttachmentGitHubFileDiff struct { + // File location on the base side of the diff. Absent for additions. + Base *AttachmentGitHubFileDiffSide `json:"base,omitempty"` + // File location on the head side of the diff. Absent for deletions. + Head *AttachmentGitHubFileDiffSide `json:"head,omitempty"` + // URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + URL string `json:"url"` +} + +func (AttachmentGitHubFileDiff) attachment() {} +func (AttachmentGitHubFileDiff) Type() AttachmentType { + return AttachmentTypeGitHubFileDiff +} + +// GitHub issue, pull request, or discussion reference +// Experimental: AttachmentGitHubReference is part of an experimental API and may change or +// be removed. +type AttachmentGitHubReference struct { + // Issue, pull request, or discussion number + Number int64 `json:"number"` + // Type of GitHub reference + ReferenceType AttachmentGitHubReferenceType `json:"referenceType"` + // Current state of the referenced item (e.g., open, closed, merged) + State string `json:"state"` + // Title of the referenced item + Title string `json:"title"` + // URL to the referenced item on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubReference) attachment() {} +func (AttachmentGitHubReference) Type() AttachmentType { + return AttachmentTypeGitHubReference +} + +// Pointer to a GitHub release. +// Experimental: AttachmentGitHubRelease is part of an experimental API and may change or be +// removed. +type AttachmentGitHubRelease struct { + // Human-readable release name + Name string `json:"name"` + // Repository the release belongs to + Repo GitHubRepoRef `json:"repo"` + // Git tag the release is anchored to + TagName string `json:"tagName"` + // URL to the release on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubRelease) attachment() {} +func (AttachmentGitHubRelease) Type() AttachmentType { + return AttachmentTypeGitHubRelease +} + +// Pointer to a GitHub repository. +// Experimental: AttachmentGitHubRepository is part of an experimental API and may change or +// be removed. +type AttachmentGitHubRepository struct { + // Short description of the repository + Description *string `json:"description,omitempty"` + // Git ref this attachment is anchored at (branch, tag, or commit). When absent the default + // branch is implied. + Ref *string `json:"ref,omitempty"` + // Repository pointer + Repo GitHubRepoRef `json:"repo"` + // URL to the repository on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubRepository) attachment() {} +func (AttachmentGitHubRepository) Type() AttachmentType { + return AttachmentTypeGitHubRepository +} + +// Pointer to a line range inside a file in a GitHub repository. +// Experimental: AttachmentGitHubSnippet is part of an experimental API and may change or be +// removed. +type AttachmentGitHubSnippet struct { + // Line range the snippet covers + LineRange AttachmentFileLineRange `json:"lineRange"` + // Repository-relative path to the file + Path string `json:"path"` + // Git ref the file is read at (branch, tag, or commit SHA) + Ref string `json:"ref"` + // Repository the file lives in + Repo GitHubRepoRef `json:"repo"` + // URL to the snippet on GitHub (with line anchor) + URL string `json:"url"` +} + +func (AttachmentGitHubSnippet) attachment() {} +func (AttachmentGitHubSnippet) Type() AttachmentType { + return AttachmentTypeGitHubSnippet +} + +// Pointer to a comparison between two git revisions. +// Experimental: AttachmentGitHubTreeComparison is part of an experimental API and may +// change or be removed. +type AttachmentGitHubTreeComparison struct { + // Base side of the comparison + Base AttachmentGitHubTreeComparisonSide `json:"base"` + // Head side of the comparison + Head AttachmentGitHubTreeComparisonSide `json:"head"` + // URL to the comparison on GitHub + URL string `json:"url"` +} + +func (AttachmentGitHubTreeComparison) attachment() {} +func (AttachmentGitHubTreeComparison) Type() AttachmentType { + return AttachmentTypeGitHubTreeComparison +} + +// Generic GitHub URL reference. +// Experimental: AttachmentGitHubURL is part of an experimental API and may change or be +// removed. +type AttachmentGitHubURL struct { + // URL to the GitHub resource + URL string `json:"url"` +} + +func (AttachmentGitHubURL) attachment() {} +func (AttachmentGitHubURL) Type() AttachmentType { + return AttachmentTypeGitHubURL +} + +// Code selection attachment from an editor +// Experimental: AttachmentSelection is part of an experimental API and may change or be +// removed. +type AttachmentSelection struct { + // User-facing display name for the selection + DisplayName string `json:"displayName"` + // Absolute path to the file containing the selection + FilePath string `json:"filePath"` + // Position range of the selection within the file + Selection AttachmentSelectionDetails `json:"selection"` + // The selected text content + Text string `json:"text"` +} + +func (AttachmentSelection) attachment() {} +func (AttachmentSelection) Type() AttachmentType { + return AttachmentTypeSelection +} + +// Optional line range to scope the attachment to a specific section of the file +// Experimental: AttachmentFileLineRange is part of an experimental API and may change or be +// removed. +type AttachmentFileLineRange struct { + // End line number (1-based, inclusive) + End int64 `json:"end"` + // Start line number (1-based) + Start int64 `json:"start"` +} + +// One side of a file diff (head or base) +// Experimental: AttachmentGitHubFileDiffSide is part of an experimental API and may change +// or be removed. +type AttachmentGitHubFileDiffSide struct { + // Repository-relative path to the file + Path string `json:"path"` + // Git ref (branch, tag, or commit SHA) the file is read at + Ref string `json:"ref"` + // Repository the file lives in + Repo GitHubRepoRef `json:"repo"` +} + +// One side of a tree comparison (head or base) +// Experimental: AttachmentGitHubTreeComparisonSide is part of an experimental API and may +// change or be removed. +type AttachmentGitHubTreeComparisonSide struct { + // Repository the revision belongs to + Repo GitHubRepoRef `json:"repo"` + // Git revision (branch, tag, or commit SHA) + Revision string `json:"revision"` +} + +// Position range of the selection within the file +// Experimental: AttachmentSelectionDetails is part of an experimental API and may change or +// be removed. +type AttachmentSelectionDetails struct { + // End position of the selection + End AttachmentSelectionDetailsEnd `json:"end"` + // Start position of the selection + Start AttachmentSelectionDetailsStart `json:"start"` +} + +// End position of the selection +// Experimental: AttachmentSelectionDetailsEnd is part of an experimental API and may change +// or be removed. +type AttachmentSelectionDetailsEnd struct { + // End character offset within the line (0-based) + Character int64 `json:"character"` + // End line number (0-based) + Line int64 `json:"line"` +} + +// Start position of the selection +// Experimental: AttachmentSelectionDetailsStart is part of an experimental API and may +// change or be removed. +type AttachmentSelectionDetailsStart struct { + // Start character offset within the line (0-based) + Character int64 `json:"character"` + // Start line number (0-based) + Line int64 `json:"line"` } -// The new auth credentials to install on the session. When omitted or `undefined`, the call -// is a no-op and the session's existing credentials are preserved. The runtime stores the -// value verbatim and uses it for outbound model/API requests; it does NOT re-validate or -// re-fetch the associated Copilot user response. Several variants carry secret material; -// treat this method's params as containing secrets at rest and in transit. +// Initial authentication info for the session. // Experimental: AuthInfo is part of an experimental API and may change or be removed. type AuthInfo interface { authInfo() @@ -349,7 +886,8 @@ func (r RawAuthInfoData) Type() AuthInfoType { return r.Discriminator } -// Schema for the `ApiKeyAuthInfo` type. +// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, +// carrying the secret `apiKey` and host. // Experimental: APIKeyAuthInfo is part of an experimental API and may change or be removed. type APIKeyAuthInfo struct { // The API key. Treat as a secret. @@ -367,7 +905,8 @@ func (APIKeyAuthInfo) Type() AuthInfoType { return AuthInfoTypeAPIKey } -// Schema for the `CopilotApiTokenAuthInfo` type. +// Authentication-info variant for direct Copilot API token auth sourced from environment +// variables, with public GitHub host. // Experimental: CopilotAPITokenAuthInfo is part of an experimental API and may change or be // removed. type CopilotAPITokenAuthInfo struct { @@ -384,7 +923,8 @@ func (CopilotAPITokenAuthInfo) Type() AuthInfoType { return AuthInfoTypeCopilotAPIToken } -// Schema for the `EnvAuthInfo` type. +// Authentication-info variant for a token sourced from an environment variable, with host, +// optional login, token, and env var name. // Experimental: EnvAuthInfo is part of an experimental API and may change or be removed. type EnvAuthInfo struct { // Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the @@ -407,9 +947,10 @@ func (EnvAuthInfo) Type() AuthInfoType { return AuthInfoTypeEnv } -// Schema for the `GhCliAuthInfo` type. -// Experimental: GhCliAuthInfo is part of an experimental API and may change or be removed. -type GhCliAuthInfo struct { +// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh +// auth token` value. +// Experimental: GhCLIAuthInfo is part of an experimental API and may change or be removed. +type GhCLIAuthInfo struct { // Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the // GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this // verbatim and does not re-fetch when set. @@ -422,12 +963,13 @@ type GhCliAuthInfo struct { Token string `json:"token"` } -func (GhCliAuthInfo) authInfo() {} -func (GhCliAuthInfo) Type() AuthInfoType { - return AuthInfoTypeGhCli +func (GhCLIAuthInfo) authInfo() {} +func (GhCLIAuthInfo) Type() AuthInfoType { + return AuthInfoTypeGhCLI } -// Schema for the `HMACAuthInfo` type. +// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub +// host and HMAC secret. // Experimental: HMACAuthInfo is part of an experimental API and may change or be removed. type HMACAuthInfo struct { // Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the @@ -435,17 +977,18 @@ type HMACAuthInfo struct { // verbatim and does not re-fetch when set. CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"` // HMAC secret used to sign requests. - Hmac string `json:"hmac"` + HMAC string `json:"hmac"` // Authentication host. HMAC auth always targets the public GitHub host. Host HMACAuthInfoHost `json:"host"` } func (HMACAuthInfo) authInfo() {} func (HMACAuthInfo) Type() AuthInfoType { - return AuthInfoTypeHmac + return AuthInfoTypeHMAC } -// Schema for the `TokenAuthInfo` type. +// Authentication-info variant for SDK-configured token authentication, carrying host and +// the secret token value. // Experimental: TokenAuthInfo is part of an experimental API and may change or be removed. type TokenAuthInfo struct { // Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the @@ -463,7 +1006,8 @@ func (TokenAuthInfo) Type() AuthInfoType { return AuthInfoTypeToken } -// Schema for the `UserAuthInfo` type. +// Authentication-info variant for OAuth user auth, with host and login; the token remains +// in the runtime secret store. // Experimental: UserAuthInfo is part of an experimental API and may change or be removed. type UserAuthInfo struct { // Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the @@ -481,6 +1025,33 @@ func (UserAuthInfo) Type() AuthInfoType { return AuthInfoTypeUser } +// The running runtime's complete catalog of well-known built-in model IDs, including +// supported models and additional IDs with built-in metadata. +// Experimental: BuiltInModelCatalog is part of an experimental API and may change or be +// removed. +type BuiltInModelCatalog struct { + // Built-in model entries. + Models []BuiltInModelCatalogEntry `json:"models"` +} + +// A well-known model in the runtime's built-in catalog. +// Experimental: BuiltInModelCatalogEntry is part of an experimental API and may change or +// be removed. +type BuiltInModelCatalogEntry struct { + // Well-known runtime model ID suitable for `ProviderConfig.modelId` or + // `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or + // model name and does not indicate CAPI entitlement or provider availability. + ID string `json:"id"` +} + +// Cancellation result for a user-requested shell command. +// Experimental: CancelUserRequestedShellCommandResult is part of an experimental API and +// may change or be removed. +type CancelUserRequestedShellCommandResult struct { + // Whether an in-flight execution was found and signalled to cancel + Cancelled bool `json:"cancelled"` +} + // Canvas action that the agent or host can invoke. To discover the input schema for a // particular action, call the list_canvas_capabilities tool. // Experimental: CanvasAction is part of an experimental API and may change or be removed. @@ -657,6 +1228,18 @@ type CanvasSessionContext struct { WorkingDirectory *string `json:"workingDirectory,omitempty"` } +// Options scoped to the built-in CAPI (Copilot API) provider. +// Experimental: CapiSessionOptions is part of an experimental API and may change or be +// removed. +type CapiSessionOptions struct { + // Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when + // the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses + // transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting + // this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` + // environment variable. + EnableWebSocketResponses *bool `json:"enableWebSocketResponses,omitempty"` +} + // Slash commands available in the session, after applying any include/exclude filters. // Experimental: CommandList is part of an experimental API and may change or be removed. type CommandList struct { @@ -692,7 +1275,6 @@ type CommandsInvokeRequest struct { Name string `json:"name"` } -// Optional filters controlling which command sources to include in the listing. // Experimental: CommandsListRequest is part of an experimental API and may change or be // removed. type CommandsListRequest struct { @@ -724,6 +1306,52 @@ type CommandsRespondToQueuedCommandResult struct { Success bool `json:"success"` } +// Characters that, when typed in the composer, should trigger a `completions.request`. +// Empty when the session has no host-driven completions (e.g. local sessions, or a relay +// host that does not advertise `completionTriggerCharacters`). +// Experimental: CompletionsGetTriggerCharactersResult is part of an experimental API and +// may change or be removed. +type CompletionsGetTriggerCharactersResult struct { + // Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven + // completions for the session. + TriggerCharacters []string `json:"triggerCharacters"` +} + +// Request host-driven completions for the current composer input. +// Experimental: CompletionsRequestRequest is part of an experimental API and may change or +// be removed. +type CompletionsRequestRequest struct { + // Cursor offset within `text`, in UTF-16 code units. + Offset int64 `json:"offset"` + // The full composed composer input. + Text string `json:"text"` +} + +// Host-driven completion items for the current composer input. Empty when the host returns +// no items or does not support completions. +// Experimental: CompletionsRequestResult is part of an experimental API and may change or +// be removed. +type CompletionsRequestResult struct { + // Completion items in host-ranked order. + Items []SessionCompletionItem `json:"items"` +} + +// Params to attach or detach an in-process ExtensionController delegate. +// Experimental: ConfigureSessionExtensionsParams is part of an experimental API and may +// change or be removed. +// Internal: ConfigureSessionExtensionsParams is an internal SDK API and is not part of the +// public surface. +type ConfigureSessionExtensionsParams struct { + // In-process ExtensionController delegate (CLI-only optimization). Marked internal: this + // field is excluded from the public SDK surface. The post-SDK extension surface exposes + // list/enable/disable/reload via dedicated RPCs served by the runtime. + // Internal: Controller is part of the SDK's internal API surface and is not intended for + // external use. + Controller any `json:"controller,omitempty"` + // Session to attach the extension controller delegate to. + SessionID string `json:"sessionId"` +} + // Metadata for a connected remote session. // Experimental: ConnectedRemoteSessionMetadata is part of an experimental API and may // change or be removed. @@ -772,14 +1400,28 @@ type ConnectRemoteSessionParams struct { SessionID string `json:"sessionId"` } -// Optional connection token presented by the SDK client during the handshake. +// Parameters for the `server.connect` handshake: an optional connection token and optional +// connection-level opt-ins (e.g. GitHub telemetry forwarding). +// Experimental: ConnectRequest is part of an experimental API and may change or be removed. // Internal: ConnectRequest is an internal SDK API and is not part of the public surface. type ConnectRequest struct { + // Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the + // runtime forwards every internal telemetry event it emits — across all sessions, plus + // sessionless events — to this connection over the `gitHubTelemetry.event` notification. + // Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); + // host-only compatibility events are forward-only and intentionally skip that path. + // Intended for first-party hosts that re-emit the events into their own telemetry stores. + // Both unrestricted and restricted events are forwarded, each tagged with a `restricted` + // discriminator; a backstop drops restricted events when restricted telemetry is disabled — + // using the process-global gate for ordinary events and an explicit session-scoped decision + // for host-only events. + EnableGitHubTelemetryForwarding *bool `json:"enableGitHubTelemetryForwarding,omitempty"` // Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN Token *string `json:"token,omitempty"` } // Handshake result reporting the server's protocol version and package version on success. +// Experimental: ConnectResult is part of an experimental API and may change or be removed. // Internal: ConnectResult is an internal SDK API and is not part of the public surface. type ConnectResult struct { // Always true on success @@ -790,44 +1432,123 @@ type ConnectResult struct { Version string `json:"version"` } -// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the -// GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this -// verbatim and does not re-fetch when set. -// Experimental: CopilotUserResponse is part of an experimental API and may change or be -// removed. -type CopilotUserResponse struct { - AccessTypeSku *string `json:"access_type_sku,omitempty"` - AnalyticsTrackingID *string `json:"analytics_tracking_id,omitempty"` - AssignedDate *string `json:"assigned_date,omitempty"` - CanSignupForLimited *bool `json:"can_signup_for_limited,omitempty"` - ChatEnabled *bool `json:"chat_enabled,omitempty"` - CliRemoteControlEnabled *bool `json:"cli_remote_control_enabled,omitempty"` - CloudSessionStorageEnabled *bool `json:"cloud_session_storage_enabled,omitempty"` - CodexAgentEnabled *bool `json:"codex_agent_enabled,omitempty"` - CopilotignoreEnabled *bool `json:"copilotignore_enabled,omitempty"` - CopilotPlan *string `json:"copilot_plan,omitempty"` - // Schema for the `CopilotUserResponseEndpoints` type. - Endpoints *CopilotUserResponseEndpoints `json:"endpoints,omitempty"` - IsMcpEnabled *bool `json:"is_mcp_enabled,omitempty"` - LimitedUserQuotas map[string]float64 `json:"limited_user_quotas,omitempty"` - LimitedUserResetDate *string `json:"limited_user_reset_date,omitempty"` - Login *string `json:"login,omitempty"` - MonthlyQuotas map[string]float64 `json:"monthly_quotas,omitempty"` - OrganizationList []CopilotUserResponseOrganizationListItem `json:"organization_list,omitempty"` - OrganizationLoginList []string `json:"organization_login_list,omitempty"` - QuotaResetDate *string `json:"quota_reset_date,omitempty"` - QuotaResetDateUtc *string `json:"quota_reset_date_utc,omitempty"` - // Schema for the `CopilotUserResponseQuotaSnapshots` type. - QuotaSnapshots *CopilotUserResponseQuotaSnapshots `json:"quota_snapshots,omitempty"` - RestrictedTelemetry *bool `json:"restricted_telemetry,omitempty"` - TokenBasedBilling *bool `json:"token_based_billing,omitempty"` -} - -// Schema for the `CopilotUserResponseEndpoints` type. -// Experimental: CopilotUserResponseEndpoints is part of an experimental API and may change -// or be removed. -type CopilotUserResponseEndpoints struct { +// Local file system absolute paths within the session working directory to check against +// its content-exclusion policy. +// Experimental: ContentExclusionCheckPathsRequest is part of an experimental API and may +// change or be removed. +type ContentExclusionCheckPathsRequest struct { + // Local file system absolute paths within the session working directory to check. Results + // are returned in the same order, including duplicates. + Paths []string `json:"paths"` +} + +// Batch content-exclusion result. Callers must fail closed when policy evaluation is +// unavailable. +// Experimental: ContentExclusionCheckPathsResult is part of an experimental API and may +// change or be removed. +type ContentExclusionCheckPathsResult struct { + // Whether the session's policy service was available for the complete batch. When false, + // checks is empty and callers must treat every requested path as excluded. + Available bool `json:"available"` + // Per-path decisions in request order. Empty when available is false. + Checks []ContentExclusionPathCheck `json:"checks"` +} + +// Content-exclusion decision for one requested path. +// Experimental: ContentExclusionPathCheck is part of an experimental API and may change or +// be removed. +type ContentExclusionPathCheck struct { + // Whether the session's complete content-exclusion policy excludes the path. + Excluded bool `json:"excluded"` + // The path supplied by the caller. + Path string `json:"path"` +} + +// A single large message currently in context. +// Experimental: ContextHeaviestMessage is part of an experimental API and may change or be +// removed. +type ContextHeaviestMessage struct { + // Stable identifier for this message within the snapshot. + ID string `json:"id"` + // Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. + Label string `json:"label"` + // Role of the chat message (`user`, `assistant`, or `tool`). + Role string `json:"role"` + // Token count currently in context for this individual message. + Tokens int64 `json:"tokens"` +} + +// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the +// GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this +// verbatim and does not re-fetch when set. +// Experimental: CopilotUserResponse is part of an experimental API and may change or be +// removed. +type CopilotUserResponse struct { + // Copilot access SKU identifier (e.g. `free_limited_copilot`, + // `copilot_for_business_seat_quota`) used to gate model and feature access. + AccessTypeSku *string `json:"access_type_sku,omitempty"` + // Opaque analytics tracking identifier for the user, forwarded from the Copilot API. + AnalyticsTrackingID *string `json:"analytics_tracking_id,omitempty"` + // Date the Copilot seat was assigned to the user, if applicable. + AssignedDate *string `json:"assigned_date,omitempty"` + // Whether the user is eligible to sign up for the free/limited Copilot tier. + CanSignupForLimited *bool `json:"can_signup_for_limited,omitempty"` + // Whether the user is able to upgrade their Copilot plan. + CanUpgradePlan *bool `json:"can_upgrade_plan,omitempty"` + // Whether Copilot chat is enabled for the user. + ChatEnabled *bool `json:"chat_enabled,omitempty"` + // Whether CLI remote control is enabled for the user. + CLIRemoteControlEnabled *bool `json:"cli_remote_control_enabled,omitempty"` + // Whether cloud session storage is enabled for the user. + CloudSessionStorageEnabled *bool `json:"cloud_session_storage_enabled,omitempty"` + // Whether the Codex agent is enabled for the user. + CodexAgentEnabled *bool `json:"codex_agent_enabled,omitempty"` + // Whether `.copilotignore` content-exclusion support is enabled for the user. + CopilotignoreEnabled *bool `json:"copilotignore_enabled,omitempty"` + // Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`). + CopilotPlan *string `json:"copilot_plan,omitempty"` + // Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. + Endpoints *CopilotUserResponseEndpoints `json:"endpoints,omitempty"` + // Whether MCP (Model Context Protocol) support is enabled for the user. + IsMCPEnabled *bool `json:"is_mcp_enabled,omitempty"` + // Whether the user is a GitHub/Microsoft staff member. + IsStaff *bool `json:"is_staff,omitempty"` + // Per-category quota allotments for free/limited-tier users, keyed by quota category. + LimitedUserQuotas map[string]float64 `json:"limited_user_quotas,omitzero"` + // Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API. + LimitedUserResetDate *string `json:"limited_user_reset_date,omitempty"` + // GitHub login of the authenticated user. + Login *string `json:"login,omitempty"` + // Per-category monthly quota allotments, keyed by quota category. + MonthlyQuotas map[string]float64 `json:"monthly_quotas,omitzero"` + // Organizations the user belongs to, each with an optional login and display name. + OrganizationList []CopilotUserResponseOrganizationListItem `json:"organization_list,omitzero"` + // Logins of the organizations the user belongs to. + OrganizationLoginList []string `json:"organization_login_list,omitzero"` + // Date the user's usage quota next resets, as a raw string from the Copilot API; see + // `quota_reset_date_utc` for the UTC-normalized value. + QuotaResetDate *string `json:"quota_reset_date,omitempty"` + // UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets). + QuotaResetDateUTC *string `json:"quota_reset_date_utc,omitempty"` + // Quota snapshot map from the raw Copilot user-response passthrough, with chat, + // completions, premium-interactions, and other entries. + QuotaSnapshots *CopilotUserResponseQuotaSnapshots `json:"quota_snapshots,omitempty"` + // Whether the user's telemetry is subject to restricted-data handling. + RestrictedTelemetry *bool `json:"restricted_telemetry,omitempty"` + // Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side + // eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime. + Te *bool `json:"te,omitempty"` + // Whether the account is on usage-based (token/AI-credit) billing rather than a fixed + // premium-request quota. + TokenBasedBilling *bool `json:"token_based_billing,omitempty"` +} + +// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. +// Experimental: CopilotUserResponseEndpoints is part of an experimental API and may change +// or be removed. +type CopilotUserResponseEndpoints struct { API *string `json:"api,omitempty"` + Exp *string `json:"exp,omitempty"` OriginTracker *string `json:"origin-tracker,omitempty"` Proxy *string `json:"proxy,omitempty"` Telemetry *string `json:"telemetry,omitempty"` @@ -838,78 +1559,131 @@ type CopilotUserResponseOrganizationListItem struct { Name *string `json:"name,omitempty"` } -// Schema for the `CopilotUserResponseQuotaSnapshots` type. +// Quota snapshot map from the raw Copilot user-response passthrough, with chat, +// completions, premium-interactions, and other entries. // Experimental: CopilotUserResponseQuotaSnapshots is part of an experimental API and may // change or be removed. type CopilotUserResponseQuotaSnapshots struct { - // Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. + // Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, + // overage, remaining quota, reset, and billing fields. Chat *CopilotUserResponseQuotaSnapshotsChat `json:"chat,omitempty"` - // Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. + // Completions quota snapshot from the raw Copilot user-response passthrough, with + // entitlement, overage, remaining quota, reset, and billing fields. Completions *CopilotUserResponseQuotaSnapshotsCompletions `json:"completions,omitempty"` - // Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. + // Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with + // entitlement, overage, remaining quota, reset, and billing fields. PremiumInteractions *CopilotUserResponseQuotaSnapshotsPremiumInteractions `json:"premium_interactions,omitempty"` } -// Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. +// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, +// overage, remaining quota, reset, and billing fields. // Experimental: CopilotUserResponseQuotaSnapshotsChat is part of an experimental API and // may change or be removed. type CopilotUserResponseQuotaSnapshotsChat struct { - Entitlement *float64 `json:"entitlement,omitempty"` - HasQuota *bool `json:"has_quota,omitempty"` - OverageCount *float64 `json:"overage_count,omitempty"` - OveragePermitted *bool `json:"overage_permitted,omitempty"` - PercentRemaining *float64 `json:"percent_remaining,omitempty"` - QuotaID *string `json:"quota_id,omitempty"` - QuotaRemaining *float64 `json:"quota_remaining,omitempty"` - QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` - Remaining *float64 `json:"remaining,omitempty"` - TimestampUtc *string `json:"timestamp_utc,omitempty"` - TokenBasedBilling *bool `json:"token_based_billing,omitempty"` - Unlimited *bool `json:"unlimited,omitempty"` -} - -// Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. + // Number of requests/units included in the entitlement for this period; `-1` denotes an + // unlimited entitlement. + Entitlement *float64 `json:"entitlement,omitempty"` + // Whether the user currently has quota available; when `false` and not unlimited, further + // requests are blocked until the quota resets. + HasQuota *bool `json:"has_quota,omitempty"` + // Count of additional pay-per-request usage consumed this period beyond the entitlement. + OverageCount *float64 `json:"overage_count,omitempty"` + // Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + OveragePermitted *bool `json:"overage_permitted,omitempty"` + // Percentage of the entitlement remaining at the snapshot timestamp. + PercentRemaining *float64 `json:"percent_remaining,omitempty"` + // Identifier of the quota bucket this snapshot describes. + QuotaID *string `json:"quota_id,omitempty"` + // Amount of quota remaining at the snapshot timestamp. + QuotaRemaining *float64 `json:"quota_remaining,omitempty"` + // Unix epoch time, in seconds, when this quota next resets. + QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` + // Remaining entitlement/quota amount at the snapshot timestamp. + Remaining *float64 `json:"remaining,omitempty"` + // UTC timestamp when this snapshot was captured. + TimestampUTC *string `json:"timestamp_utc,omitempty"` + // Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + // premium-request count. + TokenBasedBilling *bool `json:"token_based_billing,omitempty"` + // Whether the entitlement for this category is unlimited. + Unlimited *bool `json:"unlimited,omitempty"` +} + +// Completions quota snapshot from the raw Copilot user-response passthrough, with +// entitlement, overage, remaining quota, reset, and billing fields. // Experimental: CopilotUserResponseQuotaSnapshotsCompletions is part of an experimental API // and may change or be removed. type CopilotUserResponseQuotaSnapshotsCompletions struct { - Entitlement *float64 `json:"entitlement,omitempty"` - HasQuota *bool `json:"has_quota,omitempty"` - OverageCount *float64 `json:"overage_count,omitempty"` - OveragePermitted *bool `json:"overage_permitted,omitempty"` - PercentRemaining *float64 `json:"percent_remaining,omitempty"` - QuotaID *string `json:"quota_id,omitempty"` - QuotaRemaining *float64 `json:"quota_remaining,omitempty"` - QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` - Remaining *float64 `json:"remaining,omitempty"` - TimestampUtc *string `json:"timestamp_utc,omitempty"` - TokenBasedBilling *bool `json:"token_based_billing,omitempty"` - Unlimited *bool `json:"unlimited,omitempty"` -} - -// Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. + // Number of requests/units included in the entitlement for this period; `-1` denotes an + // unlimited entitlement. + Entitlement *float64 `json:"entitlement,omitempty"` + // Whether the user currently has quota available; when `false` and not unlimited, further + // requests are blocked until the quota resets. + HasQuota *bool `json:"has_quota,omitempty"` + // Count of additional pay-per-request usage consumed this period beyond the entitlement. + OverageCount *float64 `json:"overage_count,omitempty"` + // Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + OveragePermitted *bool `json:"overage_permitted,omitempty"` + // Percentage of the entitlement remaining at the snapshot timestamp. + PercentRemaining *float64 `json:"percent_remaining,omitempty"` + // Identifier of the quota bucket this snapshot describes. + QuotaID *string `json:"quota_id,omitempty"` + // Amount of quota remaining at the snapshot timestamp. + QuotaRemaining *float64 `json:"quota_remaining,omitempty"` + // Unix epoch time, in seconds, when this quota next resets. + QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` + // Remaining entitlement/quota amount at the snapshot timestamp. + Remaining *float64 `json:"remaining,omitempty"` + // UTC timestamp when this snapshot was captured. + TimestampUTC *string `json:"timestamp_utc,omitempty"` + // Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + // premium-request count. + TokenBasedBilling *bool `json:"token_based_billing,omitempty"` + // Whether the entitlement for this category is unlimited. + Unlimited *bool `json:"unlimited,omitempty"` +} + +// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with +// entitlement, overage, remaining quota, reset, and billing fields. // Experimental: CopilotUserResponseQuotaSnapshotsPremiumInteractions is part of an // experimental API and may change or be removed. type CopilotUserResponseQuotaSnapshotsPremiumInteractions struct { - Entitlement *float64 `json:"entitlement,omitempty"` - HasQuota *bool `json:"has_quota,omitempty"` - OverageCount *float64 `json:"overage_count,omitempty"` - OveragePermitted *bool `json:"overage_permitted,omitempty"` - PercentRemaining *float64 `json:"percent_remaining,omitempty"` - QuotaID *string `json:"quota_id,omitempty"` - QuotaRemaining *float64 `json:"quota_remaining,omitempty"` - QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` - Remaining *float64 `json:"remaining,omitempty"` - TimestampUtc *string `json:"timestamp_utc,omitempty"` - TokenBasedBilling *bool `json:"token_based_billing,omitempty"` - Unlimited *bool `json:"unlimited,omitempty"` -} - -// The currently selected model, reasoning effort, and context tier for the session. + // Number of requests/units included in the entitlement for this period; `-1` denotes an + // unlimited entitlement. + Entitlement *float64 `json:"entitlement,omitempty"` + // Whether the user currently has quota available; when `false` and not unlimited, further + // requests are blocked until the quota resets. + HasQuota *bool `json:"has_quota,omitempty"` + // Count of additional pay-per-request usage consumed this period beyond the entitlement. + OverageCount *float64 `json:"overage_count,omitempty"` + // Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + OveragePermitted *bool `json:"overage_permitted,omitempty"` + // Percentage of the entitlement remaining at the snapshot timestamp. + PercentRemaining *float64 `json:"percent_remaining,omitempty"` + // Identifier of the quota bucket this snapshot describes. + QuotaID *string `json:"quota_id,omitempty"` + // Amount of quota remaining at the snapshot timestamp. + QuotaRemaining *float64 `json:"quota_remaining,omitempty"` + // Unix epoch time, in seconds, when this quota next resets. + QuotaResetAt *float64 `json:"quota_reset_at,omitempty"` + // Remaining entitlement/quota amount at the snapshot timestamp. + Remaining *float64 `json:"remaining,omitempty"` + // UTC timestamp when this snapshot was captured. + TimestampUTC *string `json:"timestamp_utc,omitempty"` + // Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + // premium-request count. + TokenBasedBilling *bool `json:"token_based_billing,omitempty"` + // Whether the entitlement for this category is unlimited. + Unlimited *bool `json:"unlimited,omitempty"` +} + +// The currently selected model, reasoning effort, and context tier for the session. The +// context tier reflects `Session.getContextTier()`, restored from the session journal on +// resume. // Experimental: CurrentModel is part of an experimental API and may change or be removed. type CurrentModel struct { - // Context tier currently pinned for the session, when one is set. Reflects - // `Session.getContextTier()`, restored from the session journal on resume. - ContextTier *ModelCurrentContextTier `json:"contextTier,omitempty"` + // Context tier for models that support multiple context-window sizes. + ContextTier *ContextTier `json:"contextTier,omitempty"` // Currently active model identifier ModelID *string `json:"modelId,omitempty"` // Reasoning effort level currently applied to the active model, when one is set. Reads @@ -927,23 +1701,159 @@ type CurrentToolMetadata struct { // Tool description Description string `json:"description"` // JSON Schema for tool input - InputSchema map[string]any `json:"input_schema,omitempty"` + InputSchema map[string]any `json:"input_schema,omitzero"` // MCP server name for MCP-backed tools - McpServerName *string `json:"mcpServerName,omitempty"` + MCPServerName *string `json:"mcpServerName,omitempty"` // Raw MCP tool name for MCP-backed tools - McpToolName *string `json:"mcpToolName,omitempty"` + MCPToolName *string `json:"mcpToolName,omitempty"` // Model-facing tool name Name string `json:"name"` // Optional MCP/config namespaced tool name NamespacedName *string `json:"namespacedName,omitempty"` } +// A file included in the redacted debug bundle. +// Experimental: DebugCollectLogsCollectedEntry is part of an experimental API and may +// change or be removed. +type DebugCollectLogsCollectedEntry struct { + // Relative path of the file in the staged bundle/archive. + BundlePath string `json:"bundlePath"` + // Redacted output size in bytes. + SizeBytes int64 `json:"sizeBytes"` + // Source category for this entry. + Source DebugCollectLogsSource `json:"source"` +} + +// Destination for the redacted debug bundle. +// Experimental: DebugCollectLogsDestination is part of an experimental API and may change +// or be removed. +type DebugCollectLogsDestination interface { + debugCollectLogsDestination() + Kind() DebugCollectLogsDestinationKind +} + +type RawDebugCollectLogsDestinationData struct { + Discriminator DebugCollectLogsDestinationKind + Raw json.RawMessage +} + +func (RawDebugCollectLogsDestinationData) debugCollectLogsDestination() {} +func (r RawDebugCollectLogsDestinationData) Kind() DebugCollectLogsDestinationKind { + return r.Discriminator +} + +type DebugCollectLogsDestinationArchive struct { + // When true, create the archive atomically without overwriting an existing file by + // appending ` (N)` before the extension as needed. Defaults to false. + NoOverwrite *bool `json:"noOverwrite,omitempty"` + // Absolute or server-relative path for the .tgz archive to create. + OutputPath string `json:"outputPath"` +} + +func (DebugCollectLogsDestinationArchive) debugCollectLogsDestination() {} +func (DebugCollectLogsDestinationArchive) Kind() DebugCollectLogsDestinationKind { + return DebugCollectLogsDestinationKindArchive +} + +type DebugCollectLogsDestinationDirectory struct { + // Directory where redacted files should be staged. The directory is created if needed. + OutputDirectory string `json:"outputDirectory"` +} + +func (DebugCollectLogsDestinationDirectory) debugCollectLogsDestination() {} +func (DebugCollectLogsDestinationDirectory) Kind() DebugCollectLogsDestinationKind { + return DebugCollectLogsDestinationKindDirectory +} + +// A caller-provided server-local file or directory to include in the debug bundle. +// Experimental: DebugCollectLogsEntry is part of an experimental API and may change or be +// removed. +type DebugCollectLogsEntry struct { + // Relative path to use inside the staged bundle/archive. + BundlePath string `json:"bundlePath"` + // Kind of source path to include. + Kind DebugCollectLogsEntryKind `json:"kind"` + // Server-local source path to read. + Path string `json:"path"` + // How text content from this entry should be redacted. Defaults to plain-text. + Redaction *DebugCollectLogsRedaction `json:"redaction,omitempty"` + // When true, collection fails if this entry cannot be read. Defaults to false, which + // records the entry in `skippedEntries`. + Required *bool `json:"required,omitempty"` +} + +// Built-in session diagnostics to include in the bundle. Omitted fields default to true. +// Experimental: DebugCollectLogsInclude is part of an experimental API and may change or be +// removed. +type DebugCollectLogsInclude struct { + // Server-local path to the current process log. When set, it is included as `process.log` + // and its directory is searched for prior logs from the same session. + CurrentProcessLogPath *string `json:"currentProcessLogPath,omitempty"` + // Include the session event log (`events.jsonl`). Defaults to true. + Events *bool `json:"events,omitempty"` + // Server-local path to the session's events.jsonl file. Internal callers normally omit this + // and let the runtime derive it from the session. + EventsPath *string `json:"eventsPath,omitempty"` + // Maximum number of previous process logs to include. Defaults to 5. + PreviousProcessLogLimit *int64 `json:"previousProcessLogLimit,omitempty"` + // Server-local process log directory to search when `currentProcessLogPath` is unavailable, + // useful for collecting logs for inactive sessions. + ProcessLogDirectory *string `json:"processLogDirectory,omitempty"` + // Include process logs for the session. Defaults to true. + ProcessLogs *bool `json:"processLogs,omitempty"` + // Include interactive shell logs written under the session's `shell-logs` directory. + // Defaults to true. + ShellLogs *bool `json:"shellLogs,omitempty"` +} + +// Options for collecting a redacted session debug bundle. +// Experimental: DebugCollectLogsRequest is part of an experimental API and may change or be +// removed. +type DebugCollectLogsRequest struct { + // Caller-provided server-local files or directories to include in addition to the runtime's + // built-in session diagnostics. This lets host applications add their own diagnostics + // without changing the API shape. + AdditionalEntries []DebugCollectLogsEntry `json:"additionalEntries,omitzero"` + // Where the redacted bundle should be written. Use `archive` to produce a .tgz, or + // `directory` to stage redacted files for caller-managed upload/post-processing. + Destination DebugCollectLogsDestination `json:"destination"` + // Which built-in session diagnostics to include. Omitted fields default to true. + Include *DebugCollectLogsInclude `json:"include,omitempty"` +} + +// Result of collecting a redacted debug bundle. +// Experimental: DebugCollectLogsResult is part of an experimental API and may change or be +// removed. +type DebugCollectLogsResult struct { + // Files included in the redacted bundle. + Entries []DebugCollectLogsCollectedEntry `json:"entries"` + // Destination kind that was written. + Kind DebugCollectLogsResultKind `json:"kind"` + // Actual archive path or staging directory path written. This may differ from the requested + // path when no-overwrite suffixing or fallback-to-temp-directory was needed. + Path string `json:"path"` + // Optional files or directories that could not be included. + SkippedEntries []DebugCollectLogsSkippedEntry `json:"skippedEntries,omitzero"` +} + +// An optional debug bundle entry that could not be included. +// Experimental: DebugCollectLogsSkippedEntry is part of an experimental API and may change +// or be removed. +type DebugCollectLogsSkippedEntry struct { + // Relative path requested for this bundle entry. + BundlePath string `json:"bundlePath"` + // Server-local source path that could not be read. + Path *string `json:"path,omitempty"` + // Reason the entry was skipped. + Reason string `json:"reason"` +} + // Canvas available in the current session. // Experimental: DiscoveredCanvas is part of an experimental API and may change or be // removed. type DiscoveredCanvas struct { // Actions the agent or host may invoke on an open instance - Actions []CanvasAction `json:"actions,omitempty"` + Actions []CanvasAction `json:"actions,omitzero"` // Provider-local canvas identifier CanvasID string `json:"canvasId"` // Short, single-sentence description shown to the agent in canvas catalogs. @@ -954,20 +1864,82 @@ type DiscoveredCanvas struct { ExtensionID string `json:"extensionId"` // Owning extension display name, when available ExtensionName *string `json:"extensionName,omitempty"` + // Host-local PNG path for the canvas icon, when supplied + Icon *string `json:"icon,omitempty"` // JSON Schema for canvas open input InputSchema any `json:"inputSchema,omitempty"` } -// Schema for the `DiscoveredMcpServer` type. -type DiscoveredMcpServer struct { +// Discovered extension metadata and persistent enablement state. +// Experimental: DiscoveredExtension is part of an experimental API and may change or be +// removed. +type DiscoveredExtension struct { + // Whether this extension's persistent per-ID preference is enabled + Enabled bool `json:"enabled"` + // Source-qualified ID accepted by both server and session extension enablement methods + ID string `json:"id"` + // Human-readable extension name + Name string `json:"name"` + // Absolute path to the extension entry module, suitable for revealing it in a file manager + Path string `json:"path"` + // Containing plugin metadata for plugin-contributed extensions + Plugin *DiscoveredExtensionPlugin `json:"plugin,omitempty"` + // Discovery source + Source DiscoveredExtensionSource `json:"source"` +} + +// Installed plugin that contributes a discovered extension. +// Experimental: DiscoveredExtensionPlugin is part of an experimental API and may change or +// be removed. +type DiscoveredExtensionPlugin struct { + // Installed plugin name + Name string `json:"name"` +} + +// Extensions discovered from persisted Copilot home state and their effective loading mode. +// Launch-scoped additional plugins are not included. +// Experimental: DiscoveredExtensions is part of an experimental API and may change or be +// removed. +type DiscoveredExtensions struct { + // Discovered user and enabled installed-plugin extensions from persisted Copilot home state + Extensions []DiscoveredExtension `json:"extensions"` + // Effective extension loading mode. Defaults to load_and_augment when unset. + Mode DiscoveredExtensionMode `json:"mode"` +} + +// Source-qualified extension identifiers to persistently disable for future sessions. +// Experimental: DiscoveredExtensionsDisableRequest is part of an experimental API and may +// change or be removed. +type DiscoveredExtensionsDisableRequest struct { + // Source-qualified user or plugin extension IDs to disable + IDs []string `json:"ids"` +} + +// Source-qualified extension identifiers to persistently enable for future sessions. +// Experimental: DiscoveredExtensionsEnableRequest is part of an experimental API and may +// change or be removed. +type DiscoveredExtensionsEnableRequest struct { + // Source-qualified user or plugin extension IDs to enable + IDs []string `json:"ids"` +} + +// MCP server discovered by `mcp.discover`, with config source, optional plugin source, +// transport type, and enabled state. +// Experimental: DiscoveredMCPServer is part of an experimental API and may change or be +// removed. +type DiscoveredMCPServer struct { // Whether the server is enabled (not in the disabled list) Enabled bool `json:"enabled"` // Server name (config key) Name string `json:"name"` // Configuration source: user, workspace, plugin, or builtin - Source McpServerSource `json:"source"` + Source MCPServerSource `json:"source"` + // Plugin name that provided this server, when source is plugin. + SourcePlugin *string `json:"sourcePlugin,omitempty"` + // Plugin version that provided this server, when source is plugin. + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` // Server transport type: stdio, http, sse (deprecated), or memory - Type *DiscoveredMcpServerType `json:"type,omitempty"` + Type *DiscoveredMCPServerType `json:"type,omitempty"` } // Slash-prefixed command string to enqueue for FIFO processing. @@ -992,6 +1964,11 @@ type EnqueueCommandResult struct { // Experimental: EventLogReadRequest is part of an experimental API and may change or be // removed. type EventLogReadRequest struct { + // Optional non-empty list of subagent identifiers. When provided, only events owned by one + // of these agents are returned; ownership recognizes the event envelope's agentId plus + // legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over + // agentScope. + AgentIDs []string `json:"agentIds,omitzero"` // Agent-scope filter: 'primary' returns only main-agent events plus events whose type // starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns // events from all agents (matching wildcard-subscription behavior). Default is 'all' to @@ -1000,15 +1977,36 @@ type EventLogReadRequest struct { // Opaque cursor returned by a previous read. Omit on the first call to start from the // beginning of the session's persisted history. Cursor *string `json:"cursor,omitempty"` + // Direction to page through the session's persisted event history. 'forward' (default) + // pages from the cursor toward newer events (or from the start of history when no cursor is + // given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` + // events, and the returned cursor pages toward OLDER events on subsequent backward reads. + // Events within a returned batch are always in chronological (oldest-to-newest) order, even + // for a backward read. Backward reads cover PERSISTED history only; ephemeral events are + // never returned by a backward read. `direction` selects the INITIAL read only: the + // returned cursor is self-describing, so a continuation read pages in the cursor's own + // direction regardless of the `direction` passed alongside it — a forward cursor always + // pages forward and a backward cursor always pages backward. Pass the direction that + // matches the cursor to avoid confusion. + Direction *EventsReadDirection `json:"direction,omitempty"` + // When false, skip ephemeral events entirely and return only durable (persisted) events. + // History-backfill callers that discard ephemerals anyway should set this so the read is + // bounded by the durable log length instead of racing the ephemeral ring on a busy session. + // Defaults to true (ephemerals are interleaved with durable events in creation order). + // Ignored by backward reads, which always cover persisted history only. + IncludeEphemeral *bool `json:"includeEphemeral,omitempty"` // Maximum number of events to return in this batch (1–1000, default 200). - Max *int32 `json:"max,omitempty"` + Max *int64 `json:"max,omitempty"` // Either '*' to receive all event types, or a non-empty list of event types to receive Types *EventLogTypes `json:"types,omitempty"` // Milliseconds to wait for new events when the cursor is at the tail of history. 0 // (default) returns immediately even if no events are available. Capped at 30000ms. // Ephemeral events that arrive during the wait are delivered in this batch but are NOT // replayable on a subsequent read (use a non-zero waitMs in your next call to capture - // future ephemerals as they happen). + // future ephemerals as they happen). This applies to forward reads only: a backward read + // always returns immediately and ignores `waitMs`, because backward paging covers persisted + // history only while new events append at the tail (the opposite end from a backward page), + // so no blocking or ephemeral delivery can occur. WaitMs *int32 `json:"waitMs,omitempty"` } @@ -1046,20 +2044,31 @@ type EventLogTypes struct { // removed. type EventsReadResult struct { // Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue - // from where this read left off. Always present, even when no events were returned. + // from where this read left off. Always present, even when no events were returned. For a + // backward read this cursor pages toward OLDER events; keep passing `direction: backward` + // with it (the cursor is also self-describing, so backward paging continues correctly). Cursor string `json:"cursor"` // Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor // referred to an event that no longer exists in history (e.g. truncated or compacted away) - // and the read started from the beginning of the remaining history. + // and the read fell back to a boundary of the remaining history. For a forward read the + // fallback starts from the beginning of the remaining history; for a backward read it falls + // back to the tail (the newest window). Because the fallback page is a fresh boundary + // snapshot rather than a continuation of the requested cursor, it may overlap events the + // consumer has already rendered — a backward fallback to the tail in particular can repeat + // the newest window. On 'expired', consumers should reset or rebase their local pagination + // state (or deduplicate by event id) before continuing from the returned cursor rather than + // blindly appending/prepending the fallback page. CursorStatus EventsCursorStatus `json:"cursorStatus"` - // Events are delivered in two batches per read: persisted events first (in append order), - // then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were - // empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral - // events do not interleave within a single read. + // Session events for this batch, merged into a single stream in creation order: durable + // (persisted) events and ephemeral events interleave exactly as they were emitted. Set + // `includeEphemeral: false` to receive only durable events. Ephemeral events are never + // replayable once pruned from the in-memory ring, so a consumer that needs them should keep + // reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window + // contains persisted events only, still in chronological (oldest-to-newest) append order. Events []SessionEvent `json:"events"` - // True when the read returned `max` events and more events are available immediately. When - // false, the next read with a non-zero `waitMs` will block until a new event arrives or the - // wait expires. + // True when more events are available in the read's direction. For a forward read, true + // means the batch returned `max` events and more are available immediately. For a backward + // read, true means older persisted events remain before the returned window. HasMore bool `json:"hasMore"` } @@ -1082,21 +2091,62 @@ type ExecuteCommandResult struct { Error *string `json:"error,omitempty"` } -// Schema for the `Extension` type. +// Discovered extension metadata, including source-qualified ID, name, discovery source, +// status, and optional process ID. // Experimental: Extension is part of an experimental API and may change or be removed. type Extension struct { - // Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper') + // Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', + // 'plugin:my-plugin:my-ext') ID string `json:"id"` // Extension name (directory name) Name string `json:"name"` // Process ID if the extension is running Pid *int64 `json:"pid,omitempty"` - // Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) + // Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin + // (installed plugin), or session (session-state//extensions/) Source ExtensionSource `json:"source"` // Current status: running, disabled, failed, or starting Status ExtensionStatus `json:"status"` } +// Opaque integrator-owned process launch profile for one extension entrypoint. +// Experimental: ExtensionLaunchProfile is part of an experimental API and may change or be +// removed. +type ExtensionLaunchProfile struct { + // Opaque integrator-defined arguments passed to the executable. The runtime does not append + // the extension entrypoint. + Args []string `json:"args"` + // Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, + // SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. + Env map[string]string `json:"env"` + // Executable used to launch the extension entrypoint. + Executable string `json:"executable"` +} + +// A discovered extension entrypoint that the registered integrator may classify and resolve +// to an opaque launch profile. +// Experimental: ExtensionLaunchProviderResolveRequest is part of an experimental API and +// may change or be removed. +type ExtensionLaunchProviderResolveRequest struct { + // Source-qualified extension identifier. + ID string `json:"id"` + // Absolute path to the discovered extension entrypoint. + ModulePath string `json:"modulePath"` + // Human-readable extension name. + Name string `json:"name"` + // Discovery source for the extension entrypoint. + Source ExtensionSource `json:"source"` +} + +// The launch profile for a supported entrypoint. Omit launch when the provider does not +// support the entrypoint. +// Experimental: ExtensionLaunchProviderResolveResult is part of an experimental API and may +// change or be removed. +type ExtensionLaunchProviderResolveResult struct { + // Opaque launch profile, omitted when this provider does not support the entrypoint. + Launch *ExtensionLaunchProfile `json:"launch,omitempty"` +} + // Extensions discovered for the session, with their current status. // Experimental: ExtensionList is part of an experimental API and may change or be removed. type ExtensionList struct { @@ -1112,6 +2162,11 @@ type ExtensionsDisableRequest struct { ID string `json:"id"` } +// Experimental: ExtensionsDisableResult is part of an experimental API and may change or be +// removed. +type ExtensionsDisableResult struct { +} + // Source-qualified extension identifier to enable for the session. // Experimental: ExtensionsEnableRequest is part of an experimental API and may change or be // removed. @@ -1120,6 +2175,11 @@ type ExtensionsEnableRequest struct { ID string `json:"id"` } +// Experimental: ExtensionsEnableResult is part of an experimental API and may change or be +// removed. +type ExtensionsEnableResult struct { +} + // Tool call result (string or expanded result object) // Experimental: ExternalToolResult is part of an experimental API and may change or be // removed. @@ -1138,9 +2198,9 @@ func (ExternalToolTextResultForLlm) externalToolResult() {} // or be removed. type ExternalToolTextResultForLlm struct { // Base64-encoded binary results returned to the model - BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitempty"` + BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitzero"` // Structured content blocks from the tool - Contents []ExternalToolTextResultForLlmContent `json:"contents,omitempty"` + Contents []ExternalToolTextResultForLlmContent `json:"contents,omitzero"` // Optional error message for failed executions Error *string `json:"error,omitempty"` // Execution outcome classification. Optional for back-compat; normalized to 'success' (or @@ -1150,8 +2210,12 @@ type ExternalToolTextResultForLlm struct { SessionLog *string `json:"sessionLog,omitempty"` // Text result returned to the model TextResultForLlm string `json:"textResultForLlm"` + // Tool references returned by a tool-search override: names of deferred tools to surface to + // the model. When set, the tool result is materialized as `tool_reference` content blocks + // (rather than plain text) so the model knows which deferred tools are now available. + ToolReferences []string `json:"toolReferences,omitzero"` // Optional tool-specific telemetry - ToolTelemetry map[string]any `json:"toolTelemetry,omitempty"` + ToolTelemetry map[string]any `json:"toolTelemetry,omitzero"` } // Binary result returned by a tool for the model @@ -1163,7 +2227,7 @@ type ExternalToolTextResultForLlmBinaryResultsForLlm struct { // Human-readable description of the binary data Description *string `json:"description,omitempty"` // Optional metadata from the producing tool. - Metadata map[string]any `json:"metadata,omitempty"` + Metadata map[string]any `json:"metadata,omitzero"` // MIME type of the binary data MIMEType string `json:"mimeType"` // Binary result type discriminator. Use "image" for images and "resource" for other binary @@ -1240,7 +2304,7 @@ type ExternalToolTextResultForLlmContentResourceLink struct { // Human-readable description of the resource Description *string `json:"description,omitempty"` // Icons associated with this resource - Icons []ExternalToolTextResultForLlmContentResourceLinkIcon `json:"icons,omitempty"` + Icons []ExternalToolTextResultForLlmContentResourceLinkIcon `json:"icons,omitzero"` // MIME type of the resource content MIMEType *string `json:"mimeType,omitempty"` // Resource name identifier @@ -1258,6 +2322,28 @@ func (ExternalToolTextResultForLlmContentResourceLink) Type() ExternalToolTextRe return ExternalToolTextResultForLlmContentTypeResourceLink } +// Shell command exit metadata with optional output preview +// Experimental: ExternalToolTextResultForLlmContentShellExit is part of an experimental API +// and may change or be removed. +type ExternalToolTextResultForLlmContentShellExit struct { + // Working directory where the shell command was executed + Cwd *string `json:"cwd,omitempty"` + // Exit code from the completed shell command + ExitCode int64 `json:"exitCode"` + // Output associated with this shell command, if available. May be partial, truncated, or a + // preview; not guaranteed to be full output. + OutputPreview *string `json:"outputPreview,omitempty"` + // Whether outputPreview is known to be incomplete or truncated + OutputTruncated *bool `json:"outputTruncated,omitempty"` + // Shell id, as assigned by Copilot runtime + ShellID string `json:"shellId"` +} + +func (ExternalToolTextResultForLlmContentShellExit) externalToolTextResultForLlmContent() {} +func (ExternalToolTextResultForLlmContentShellExit) Type() ExternalToolTextResultForLlmContentType { + return ExternalToolTextResultForLlmContentTypeShellExit +} + // Terminal/shell output content block with optional exit code and working directory // Experimental: ExternalToolTextResultForLlmContentTerminal is part of an experimental API // and may change or be removed. @@ -1302,7 +2388,8 @@ type RawExternalToolTextResultForLlmContentResourceDetailsData struct { func (RawExternalToolTextResultForLlmContentResourceDetailsData) externalToolTextResultForLlmContentResourceDetails() { } -// Schema for the `EmbeddedBlobResourceContents` type. +// Embedded binary resource contents identified by a URI, with an optional MIME type and a +// base64-encoded blob. // Experimental: EmbeddedBlobResourceContents is part of an experimental API and may change // or be removed. type EmbeddedBlobResourceContents struct { @@ -1316,7 +2403,8 @@ type EmbeddedBlobResourceContents struct { func (EmbeddedBlobResourceContents) externalToolTextResultForLlmContentResourceDetails() {} -// Schema for the `EmbeddedTextResourceContents` type. +// Embedded text resource contents identified by a URI, with an optional MIME type and a +// text payload. // Experimental: EmbeddedTextResourceContents is part of an experimental API and may change // or be removed. type EmbeddedTextResourceContents struct { @@ -1337,15 +2425,513 @@ type ExternalToolTextResultForLlmContentResourceLinkIcon struct { // MIME type of the icon image MIMEType *string `json:"mimeType,omitempty"` // Available icon sizes (e.g., ['16x16', '32x32']) - Sizes []string `json:"sizes,omitempty"` + Sizes []string `json:"sizes,omitzero"` // URL or path to the icon image Src string `json:"src"` // Theme variant this icon is intended for Theme *ExternalToolTextResultForLlmContentResourceLinkIconTheme `json:"theme,omitempty"` } +// Parameters for cooperatively aborting a factory body. +// Experimental: FactoryAbortRequest is part of an experimental API and may change or be +// removed. +type FactoryAbortRequest struct { + // Factory run identifier. + RunID string `json:"runId"` + // Target session identifier + SessionID string `json:"sessionId"` +} + +// Acknowledgement that a factory request was accepted. +// Experimental: FactoryAckResult is part of an experimental API and may change or be +// removed. +type FactoryAckResult struct { +} + +// Options for one factory-scoped subagent call. +// Experimental: FactoryAgentOptions is part of an experimental API and may change or be +// removed. +type FactoryAgentOptions struct { + // Optional custom agent name for the subagent. This field is accepted but not yet honored. + Agent *string `json:"agent,omitempty"` + // Optional context tier for the subagent. This field is accepted but not yet honored. + ContextTier *ContextTier `json:"contextTier,omitempty"` + // Optional label distinguishing otherwise identical memoized agent calls. + Label *string `json:"label,omitempty"` + // Optional model identifier for the subagent. + Model *string `json:"model,omitempty"` + // Optional reasoning effort for the subagent. This field is accepted but not yet honored. + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Optional JSON Schema for structured agent output. + Schema any `json:"schema,omitempty"` +} + +// Parameters for one factory-scoped subagent call. +// Experimental: FactoryAgentRequest is part of an experimental API and may change or be +// removed. +type FactoryAgentRequest struct { + // Opaque token identifying the current factory execution attempt. + ExecutionToken string `json:"executionToken"` + // Factory run identifier that owns the subagent. + FactoryRunID string `json:"factoryRunId"` + // Subagent execution options. + Opts FactoryAgentOptions `json:"opts"` + // Prompt to send to the subagent. + Prompt string `json:"prompt"` +} + +// Result of one factory-scoped subagent call. +// Experimental: FactoryAgentResult is part of an experimental API and may change or be +// removed. +type FactoryAgentResult struct { + // Agent result, omitted when the agent produced no result. + Result any `json:"result,omitempty"` +} + +// Prompt-safe durable identity and live status for a direct factory agent. +// Experimental: FactoryAgentSummary is part of an experimental API and may change or be +// removed. +type FactoryAgentSummary struct { + ActiveMs int64 `json:"activeMs"` + Activity *string `json:"activity,omitempty"` + AgentID string `json:"agentId"` + AgentType string `json:"agentType"` + CompletedAt *int64 `json:"completedAt,omitempty"` + Label string `json:"label"` + PhaseID *string `json:"phaseId"` + RequestedModel *string `json:"requestedModel,omitempty"` + ResolvedModel *string `json:"resolvedModel,omitempty"` + RunID string `json:"runId"` + StartedAt *int64 `json:"startedAt,omitempty"` + Status string `json:"status"` + ToolCallID string `json:"toolCallId"` +} + +// Parameters for cancelling a factory run. +// Experimental: FactoryCancelRequest is part of an experimental API and may change or be +// removed. +type FactoryCancelRequest struct { + // Factory run identifier. + RunID string `json:"runId"` +} + +// Current factory phase identity. +// Experimental: FactoryCurrentPhase is part of an experimental API and may change or be +// removed. +type FactoryCurrentPhase struct { + ID string `json:"id"` + Ordinal *int64 `json:"ordinal"` +} + +// Declared or approved factory resource ceilings. +// Experimental: FactoryDeclaredLimits is part of an experimental API and may change or be +// removed. +type FactoryDeclaredLimits struct { + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` + MaxConcurrentSubagents *int64 `json:"maxConcurrentSubagents,omitempty"` + MaxTotalSubagents *int64 `json:"maxTotalSubagents,omitempty"` + TimeoutSeconds *float64 `json:"timeoutSeconds,omitempty"` +} + +// Parameters sent to the owning extension to execute a factory closure. +// Experimental: FactoryExecuteRequest is part of an experimental API and may change or be +// removed. +type FactoryExecuteRequest struct { + // Factory input value. + Args any `json:"args"` + // Opaque token identifying this factory execution attempt. + ExecutionToken string `json:"executionToken"` + // Registered factory name. + Name string `json:"name"` + // Factory run identifier. + RunID string `json:"runId"` + // Target session identifier + SessionID string `json:"sessionId"` +} + +// Result returned by an extension factory closure. +// Experimental: FactoryExecuteResult is part of an experimental API and may change or be +// removed. +type FactoryExecuteResult struct { + // Factory result value. + Result any `json:"result,omitempty"` +} + +// Parameters for paging factory progress. +// Experimental: FactoryGetRunProgressRequest is part of an experimental API and may change +// or be removed. +type FactoryGetRunProgressRequest struct { + // Exclusive forward cursor. + AfterSeq *int64 `json:"afterSeq,omitempty"` + // Exclusive backward cursor. + BeforeSeq *int64 `json:"beforeSeq,omitempty"` + // Maximum records to return. Defaults to 200 and is capped at 500. + Limit *int32 `json:"limit,omitempty"` + // Optional phase identifier used to scope records and cursors. + PhaseID *string `json:"phaseId,omitempty"` + // Factory run identifier. + RunID string `json:"runId"` +} + +// Parameters for retrieving a factory run. +// Experimental: FactoryGetRunRequest is part of an experimental API and may change or be +// removed. +type FactoryGetRunRequest struct { + // Factory run identifier. + RunID string `json:"runId"` +} + +// Parameters for reading a factory journal entry. +// Experimental: FactoryJournalGetRequest is part of an experimental API and may change or +// be removed. +type FactoryJournalGetRequest struct { + // Opaque token identifying the current factory execution attempt. + ExecutionToken string `json:"executionToken"` + // Namespaced journal key. + Key string `json:"key"` + // Factory run identifier. + RunID string `json:"runId"` +} + +// Result of reading a factory journal entry. +// Experimental: FactoryJournalGetResult is part of an experimental API and may change or be +// removed. +type FactoryJournalGetResult struct { + // Whether the journal contained the requested key. + Hit bool `json:"hit"` + // Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + ResultJSON any `json:"resultJson,omitempty"` +} + +// Parameters for storing a factory journal entry. +// Experimental: FactoryJournalPutRequest is part of an experimental API and may change or +// be removed. +type FactoryJournalPutRequest struct { + // Opaque token identifying the current factory execution attempt. + ExecutionToken string `json:"executionToken"` + // Namespaced journal key. + Key string `json:"key"` + // JSON result to memoize. + ResultJSON any `json:"resultJson"` + // Factory run identifier. + RunID string `json:"runId"` +} + +// Parameters for paging factory runs. +// Experimental: FactoryListRunsRequest is part of an experimental API and may change or be +// removed. +type FactoryListRunsRequest struct { + // Exclusive forward cursor. + AfterSeq *int64 `json:"afterSeq,omitempty"` + // Exclusive backward cursor. + BeforeSeq *int64 `json:"beforeSeq,omitempty"` + // Maximum terminal runs to return. Defaults to 200 and is capped at 500. + Limit *int32 `json:"limit,omitempty"` +} + +// A page of factory runs in durable creation order. +// Experimental: FactoryListRunsResult is part of an experimental API and may change or be +// removed. +type FactoryListRunsResult struct { + // Whether terminal runs newer than this page exist. + HasMoreNewer *bool `json:"hasMoreNewer,omitempty"` + // Newest terminal-run cursor in this page, or null when the terminal window is empty. + NewestSeq *int64 `json:"newestSeq,omitempty"` + // Oldest terminal-run cursor in this page, or null when the terminal window is empty. + OldestSeq *int64 `json:"oldestSeq,omitempty"` + // Number of terminal runs older than this page. + OmittedOlder *int64 `json:"omittedOlder,omitempty"` + Runs []FactoryRunSummary `json:"runs"` +} + +// One ordered factory progress line. +// Experimental: FactoryLogLine is part of an experimental API and may change or be removed. +type FactoryLogLine struct { + // Progress line kind. + Kind FactoryLogLineKind `json:"kind"` + // Monotonic sequence number within the factory run. + Seq int64 `json:"seq"` + // Progress text. + Text string `json:"text"` +} + +// Parameters for recording factory progress. +// Experimental: FactoryLogRequest is part of an experimental API and may change or be +// removed. +type FactoryLogRequest struct { + // Opaque token identifying the current factory execution attempt. + ExecutionToken string `json:"executionToken"` + // Ordered progress lines to append. + Lines []FactoryLogLine `json:"lines"` + // Factory run identifier. + RunID string `json:"runId"` +} + +// Durable lifecycle and timing for one factory phase. +// Experimental: FactoryPhaseObservation is part of an experimental API and may change or be +// removed. +type FactoryPhaseObservation struct { + AccumulatedActiveMs int64 `json:"accumulatedActiveMs"` + CompletedAt *int64 `json:"completedAt,omitempty"` + CurrentActiveMs int64 `json:"currentActiveMs"` + Detail *string `json:"detail,omitempty"` + EntryCount int64 `json:"entryCount"` + ID string `json:"id"` + LastEnteredRunAttempt int64 `json:"lastEnteredRunAttempt"` + LiveAgentCount int64 `json:"liveAgentCount"` + Ordinal *int64 `json:"ordinal"` + StartedAt *int64 `json:"startedAt,omitempty"` + Status FactoryPhaseStatus `json:"status"` + Title string `json:"title"` + TotalAgentCount int64 `json:"totalAgentCount"` +} + +// One durable factory progress record. +// Experimental: FactoryProgressLine is part of an experimental API and may change or be +// removed. +type FactoryProgressLine struct { + // Resume attempt that emitted this record. + Attempt int64 `json:"attempt"` + // Progress record kind. + Kind FactoryLogLineKind `json:"kind"` + // Phase active when the record was emitted, or null before any phase. + PhaseID *string `json:"phaseId"` + // Epoch milliseconds when the record was persisted. + RecordedAt int64 `json:"recordedAt"` + // Global monotonic sequence number within the run. + Seq int64 `json:"seq"` + // Prompt-safe progress text. + Text string `json:"text"` +} + +// A bidirectional page of factory progress. +// Experimental: FactoryProgressPage is part of an experimental API and may change or be +// removed. +type FactoryProgressPage struct { + HasMoreNewer bool `json:"hasMoreNewer"` + HasMoreOlder bool `json:"hasMoreOlder"` + NewestSeq *int64 `json:"newestSeq"` + OldestSeq *int64 `json:"oldestSeq"` + Records []FactoryProgressLine `json:"records"` + // Run revision reflected by this page. + Revision int64 `json:"revision"` +} + +// Parameters for resuming a factory run from its persisted identity. +// Experimental: FactoryResumeRequest is part of an experimental API and may change or be +// removed. +type FactoryResumeRequest struct { + // Optional per-invocation resource ceiling overrides. + Limits *FactoryRunLimits `json:"limits,omitempty"` + // Factory run identifier. + RunID string `json:"runId"` +} + +// Resolved persisted factory identity and resumed run envelope. +// Experimental: FactoryResumeResult is part of an experimental API and may change or be +// removed. +type FactoryResumeResult struct { + // Persisted factory name resolved for the resumed run. + FactoryName string `json:"factoryName"` + // Terminal resumed run envelope. + Run FactoryRunResult `json:"run"` +} + +// Durable factory resource consumption. +// Experimental: FactoryRunConsumed is part of an experimental API and may change or be +// removed. +type FactoryRunConsumed struct { + ActiveMs int64 `json:"activeMs"` + NanoAiu int64 `json:"nanoAiu"` + Subagents int64 `json:"subagents"` +} + +// Full factory run observability detail. +// Experimental: FactoryRunDetail is part of an experimental API and may change or be +// removed. +type FactoryRunDetail struct { + ActiveSegmentStartedAt *int64 `json:"activeSegmentStartedAt"` + Agents []FactoryAgentSummary `json:"agents"` + Approved *FactoryDeclaredLimits `json:"approved"` + CompletedAt *int64 `json:"completedAt"` + Consumed FactoryRunConsumed `json:"consumed"` + CreatedAt int64 `json:"createdAt"` + CurrentPhase *FactoryCurrentPhase `json:"currentPhase"` + DeclaredLimits FactoryDeclaredLimits `json:"declaredLimits"` + DeclaredPhaseCount int64 `json:"declaredPhaseCount"` + Description string `json:"description"` + FactoryName string `json:"factoryName"` + LiveAgentCount int64 `json:"liveAgentCount"` + ObservedAt int64 `json:"observedAt"` + Phases []FactoryPhaseObservation `json:"phases"` + Progress FactoryProgressPage `json:"progress"` + Revision int64 `json:"revision"` + RunID string `json:"runId"` + StartedAt *int64 `json:"startedAt"` + Status FactoryRunStatus `json:"status"` + Terminal *FactoryRunTerminal `json:"terminal"` + TotalSpawnedAgentCount int64 `json:"totalSpawnedAgentCount"` + UpdatedAt int64 `json:"updatedAt"` +} + +// Machine-readable factory run failure. +// Experimental: FactoryRunFailure is part of an experimental API and may change or be +// removed. +type FactoryRunFailure interface { + factoryRunFailure() + Type() FactoryRunFailureType +} + +type RawFactoryRunFailureData struct { + Discriminator FactoryRunFailureType + Raw json.RawMessage +} + +func (RawFactoryRunFailureData) factoryRunFailure() {} +func (r RawFactoryRunFailureData) Type() FactoryRunFailureType { + return r.Discriminator +} + +// The run stopped because its usage accounting could not be completed. +type FactoryRunFailureFactoryAccountingIncomplete struct { + // Confirmed usage in nano-AIU, representing the floor of what the run spent. + DrainedNanoAiu int64 `json:"drainedNanoAiu"` + // Factory run identifier. + RunID string `json:"runId"` +} + +func (FactoryRunFailureFactoryAccountingIncomplete) factoryRunFailure() {} +func (FactoryRunFailureFactoryAccountingIncomplete) Type() FactoryRunFailureType { + return FactoryRunFailureTypeFactoryAccountingIncomplete +} + +type FactoryRunFailureFactoryDurableFailure struct { + // Stable failure code. + Code string `json:"code"` + // Execution-critical durable operation that failed. + Operation FactoryDurableOperation `json:"operation"` + // Factory run identifier. + RunID string `json:"runId"` +} + +func (FactoryRunFailureFactoryDurableFailure) factoryRunFailure() {} +func (FactoryRunFailureFactoryDurableFailure) Type() FactoryRunFailureType { + return FactoryRunFailureTypeFactoryDurableFailure +} + +type FactoryRunFailureFactoryLimitReached struct { + // Resource ceiling that stopped the run. + Kind FactoryRunFailureKind `json:"kind"` + // Factory run identifier. + RunID string `json:"runId"` + // Approved effective ceiling that was reached. + Value float64 `json:"value"` +} + +func (FactoryRunFailureFactoryLimitReached) factoryRunFailure() {} +func (FactoryRunFailureFactoryLimitReached) Type() FactoryRunFailureType { + return FactoryRunFailureTypeFactoryLimitReached +} + +type FactoryRunFailureFactoryResumeDeclined struct { + // Human-readable reason the resume did not proceed. + Reason string `json:"reason"` + // Factory run identifier whose changed limits were declined. + RunID string `json:"runId"` +} + +func (FactoryRunFailureFactoryResumeDeclined) factoryRunFailure() {} +func (FactoryRunFailureFactoryResumeDeclined) Type() FactoryRunFailureType { + return FactoryRunFailureTypeFactoryResumeDeclined +} + +// Wire-only per-invocation factory resource ceiling overrides. +// Experimental: FactoryRunLimits is part of an experimental API and may change or be +// removed. +type FactoryRunLimits struct { + // Maximum AI credits consumed by factory subagents and their descendants. The post-paid + // ceiling is soft: parallel turns can settle beyond it before the run stops. + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` + // Maximum number of factory subagents that may run concurrently. + MaxConcurrentSubagents *int64 `json:"maxConcurrentSubagents,omitempty"` + // Maximum total number of factory subagents that may be admitted. + MaxTotalSubagents *int64 `json:"maxTotalSubagents,omitempty"` + // Maximum accumulated active-execution time in seconds. Active execution includes the + // entire extension body, subprocess waits, queued-agent waits, and sleeps; time between + // resumed attempts is not counted. + TimeoutSeconds *float64 `json:"timeoutSeconds,omitempty"` +} + +// Parameters for invoking a registered factory. +// Experimental: FactoryRunRequest is part of an experimental API and may change or be +// removed. +type FactoryRunRequest struct { + // Factory input value. + Args any `json:"args"` + // Registered factory name. + Name string `json:"name"` + // Factory invocation options. + Options *RunOptions `json:"options,omitempty"` +} + +// Complete current or terminal factory run envelope. +// Experimental: FactoryRunResult is part of an experimental API and may change or be +// removed. +type FactoryRunResult struct { + // Error message for an errored run. + Error *string `json:"error,omitempty"` + // Machine-readable failure details for an errored run. + Failure FactoryRunFailure `json:"failure,omitempty"` + // Reason for a halted or cancelled run. + Reason *string `json:"reason,omitempty"` + // Completed factory result. + Result any `json:"result,omitempty"` + // Factory run identifier. + RunID string `json:"runId"` + // Partial journal and progress snapshot for a halted, cancelled, or errored run. + Snapshot any `json:"snapshot,omitempty"` + // Current or terminal factory run status. + Status FactoryRunStatus `json:"status"` +} + +// Durable factory run summary with read-time live overlays. +// Experimental: FactoryRunSummary is part of an experimental API and may change or be +// removed. +type FactoryRunSummary struct { + ActiveSegmentStartedAt *int64 `json:"activeSegmentStartedAt"` + Approved *FactoryDeclaredLimits `json:"approved"` + CompletedAt *int64 `json:"completedAt"` + Consumed FactoryRunConsumed `json:"consumed"` + CreatedAt int64 `json:"createdAt"` + CurrentPhase *FactoryCurrentPhase `json:"currentPhase"` + DeclaredLimits FactoryDeclaredLimits `json:"declaredLimits"` + DeclaredPhaseCount int64 `json:"declaredPhaseCount"` + Description string `json:"description"` + FactoryName string `json:"factoryName"` + LiveAgentCount int64 `json:"liveAgentCount"` + ObservedAt int64 `json:"observedAt"` + Revision int64 `json:"revision"` + RunID string `json:"runId"` + StartedAt *int64 `json:"startedAt"` + Status FactoryRunStatus `json:"status"` + Terminal *FactoryRunTerminal `json:"terminal"` + TotalSpawnedAgentCount int64 `json:"totalSpawnedAgentCount"` + UpdatedAt int64 `json:"updatedAt"` +} + +// Prompt-safe terminal factory outcome. +// Experimental: FactoryRunTerminal is part of an experimental API and may change or be +// removed. +type FactoryRunTerminal struct { + Error *string `json:"error,omitempty"` + Failure FactoryRunFailure `json:"failure,omitempty"` + Reason *string `json:"reason,omitempty"` + ResultPreview *string `json:"resultPreview,omitempty"` +} + // Content filtering mode to apply to all tools, or a map of tool name to content filtering // mode. +// Experimental: FilterMapping is part of an experimental API and may change or be removed. type FilterMapping interface { filterMapping() } @@ -1396,6 +2982,94 @@ type FolderTrustCheckResult struct { Trusted bool `json:"trusted"` } +// Pointer to a GitHub repository. +// Experimental: GitHubRepoRef is part of an experimental API and may change or be removed. +type GitHubRepoRef struct { + // Numeric GitHub repository id + ID *int64 `json:"id,omitempty"` + // Repository name (without owner) + Name string `json:"name"` + // Repository owner login (user or organization) + Owner string `json:"owner"` +} + +// Client environment metadata describing the process that produced a telemetry event. +// Experimental: GitHubTelemetryClientInfo is part of an experimental API and may change or +// be removed. +type GitHubTelemetryClientInfo struct { + // Name of the client application. + ClientName *string `json:"client_name,omitempty"` + // Type of client. + ClientType *string `json:"client_type,omitempty"` + // Copilot CLI version string. + CLIVersion string `json:"cli_version"` + // Copilot subscription plan, when known. + CopilotPlan *string `json:"copilot_plan,omitempty"` + // Stable machine identifier for the device. + DevDeviceID *string `json:"dev_device_id,omitempty"` + // Whether the user is a GitHub/Microsoft staff member. + IsStaff *bool `json:"is_staff,omitempty"` + // Node.js runtime version string. + NodeVersion string `json:"node_version"` + // Operating system architecture (e.g. arm64, x64). + OsArch string `json:"os_arch"` + // Operating system platform (e.g. darwin, linux, win32). + OsPlatform string `json:"os_platform"` + // Operating system version string. + OsVersion string `json:"os_version"` +} + +// A single telemetry event in the runtime's native GitHub-shaped telemetry format, +// forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing +// GitHubTelemetryNotification distinguishes standard from restricted events; the payload +// shape is identical for both. +// Experimental: GitHubTelemetryEvent is part of an experimental API and may change or be +// removed. +type GitHubTelemetryEvent struct { + // Client environment metadata. + Client *GitHubTelemetryClientInfo `json:"client,omitempty"` + // Copilot tracking ID for user-level attribution. + CopilotTrackingID *string `json:"copilot_tracking_id,omitempty"` + // Timestamp when the event was created (ISO 8601 format). + CreatedAt *string `json:"created_at,omitempty"` + // Experiment assignment context. + ExpAssignmentContext *string `json:"exp_assignment_context,omitempty"` + // Feature flags enabled for this session, as a map from flag to value. + Features map[string]string `json:"features,omitzero"` + // Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). + Kind string `json:"kind"` + // Numeric metrics as a map from key to value. + Metrics map[string]float64 `json:"metrics"` + // Reference to the model call that produced this event. + ModelCallID *string `json:"model_call_id,omitempty"` + // String-valued properties as a map from key to value. + Properties map[string]string `json:"properties"` + // Session identifier the event belongs to. + SessionID *string `json:"session_id,omitempty"` +} + +// Experimental: GitHubTelemetryEventResult is part of an experimental API and may change or +// be removed. +type GitHubTelemetryEventResult struct { +} + +// Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the +// runtime forwards to a host connection that opted into telemetry forwarding during the +// `server.connect` handshake. +// Experimental: GitHubTelemetryNotification is part of an experimental API and may change +// or be removed. +type GitHubTelemetryNotification struct { + // The telemetry event, in the runtime's native GitHub-shaped telemetry format. + Event GitHubTelemetryEvent `json:"event"` + // Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route + // restricted events to first-party Microsoft stores only. + Restricted bool `json:"restricted"` + // Session the telemetry event belongs to, when it is session-scoped. Omitted for + // sessionless events (for example, `server.sendTelemetry` calls with no session id), which + // are still forwarded to opted-in connections. + SessionID *string `json:"sessionId,omitempty"` +} + // Pending external tool call request ID, with the tool result or an error describing why it // failed. // Experimental: HandlePendingToolCallRequest is part of an experimental API and may change @@ -1435,6 +3109,27 @@ type HistoryCancelBackgroundCompactionResult struct { Cancelled bool `json:"cancelled"` } +// Parameters for clearing the conversation and seeding the window that replaces it. +// Experimental: HistoryClearContextRequest is part of an experimental API and may change or +// be removed. +type HistoryClearContextRequest struct { + // First user message of the fresh context window. Required: a cleared window holding only + // system and developer messages is not a conversation a model can answer, so every clear + // seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop + // exits, which is why the call must be made from inside a tool handler. + Prompt string `json:"prompt"` +} + +// What a successful clear removed. A clear that could not be applied rejects instead of +// reporting a count. +// Experimental: HistoryClearContextResult is part of an experimental API and may change or +// be removed. +type HistoryClearContextResult struct { + // Number of non-system, non-developer messages that were removed from the conversation. + // Zero only when the window already held no conversation. + MessagesCleared int64 `json:"messagesCleared"` +} + // Post-compaction context window usage breakdown // Experimental: HistoryCompactContextWindow is part of an experimental API and may change // or be removed. @@ -1453,12 +3148,21 @@ type HistoryCompactContextWindow struct { ToolDefinitionsTokens *int64 `json:"toolDefinitionsTokens,omitempty"` } -// Optional compaction parameters. -// Experimental: HistoryCompactRequest is part of an experimental API and may change or be -// removed. type HistoryCompactRequest struct { // Optional user-provided instructions to focus the compaction summary CustomInstructions *string `json:"customInstructions,omitempty"` + // Context window token limit this compaction is targeting, recorded as the `tokenLimit` on + // the persisted `session.compaction_start` / `session.compaction_complete` events. Set it + // when the compaction targets a window other than the compacting model's own, e.g. + // switching to a model with a smaller context window: the compaction still runs on the + // current model, so the limit that motivated it would otherwise be lost. When absent, the + // events record the compacting model's own resolved limit. Attribution metadata only - it + // does not change how much the compaction removes. + TokenLimit *int64 `json:"tokenLimit,omitempty"` + // What initiated this compaction request, recorded as the `trigger` on the persisted + // `session.compaction_start` / `session.compaction_complete` events. When absent, the + // compaction is persisted without trigger attribution (initiator unknown). + Trigger *HistoryCompactRequestTrigger `json:"trigger,omitempty"` } // Compaction outcome with the number of tokens and messages removed, summary text, and the @@ -1479,13 +3183,148 @@ type HistoryCompactResult struct { TokensRemoved int64 `json:"tokensRemoved"` } -// Markdown summary of the conversation context (empty when not available). -// Experimental: HistorySummarizeForHandoffResult is part of an experimental API and may -// change or be removed. -type HistorySummarizeForHandoffResult struct { - // Markdown summary of the conversation context produced by an LLM. Empty string when there - // are no messages or when the session does not support local summarization. - Summary string `json:"summary"` +// Rewind points and file-change-tracking availability for the session. +// Experimental: HistoryListRewindPointsResult is part of an experimental API and may change +// or be removed. +type HistoryListRewindPointsResult struct { + // Whether this session captured file changes from its first turn. + FileChangeTrackingEnabled bool `json:"fileChangeTrackingEnabled"` + // Root user turns in chronological order. Empty when `unavailableReason` is set. + Points []HistoryRewindPoint `json:"points"` + // Why the listed points could not be produced, when applicable; the points list is empty + // whenever it is set. `unsupported-remote-session` is permanent for the session and comes + // with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever + // reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the + // file-change captures cannot be read while work that may still mutate them is in flight; + // the same request succeeds once the session settles, so a client that wants points should + // retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an + // untracked local session still lists conversation-only points and reports that through + // `fileChangeTrackingEnabled: false`. + UnavailableReason *HistoryRewindUnavailableReason `json:"unavailableReason,omitempty"` +} + +// Event boundary to preview for conversation-and-files rewind. +// Experimental: HistoryPreviewRewindRequest is part of an experimental API and may change +// or be removed. +type HistoryPreviewRewindRequest struct { + // ID of the user.message event that begins the discarded suffix. + EventID string `json:"eventId"` +} + +// Files and aggregate changes for a prospective rewind. +// Experimental: HistoryPreviewRewindResult is part of an experimental API and may change or +// be removed. +type HistoryPreviewRewindResult struct { + // Whether file restore is available for this session. This is authoritative: switch on it + // and read `reason` only when it is false. + Available bool `json:"available"` + // Number of unique files in the preview. + FileCount int64 `json:"fileCount"` + // Files ordered by path. + Files []HistoryRewindFilePreview `json:"files"` + // Why file restore is unavailable, when applicable. Populated only when `available` is + // false and never set when `available` is true. + Reason *HistoryRewindUnavailableReason `json:"reason,omitempty"` +} + +// A file that a conversation-and-files rewind would restore. +// Experimental: HistoryRewindFilePreview is part of an experimental API and may change or +// be removed. +type HistoryRewindFilePreview struct { + // Aggregate change made across the discarded turns. + ChangeType HistoryRewindChangeType `json:"changeType"` + // Lines added across the discarded turns. + LinesAdded int64 `json:"linesAdded"` + // Lines removed across the discarded turns. + LinesRemoved int64 `json:"linesRemoved"` + // Absolute path of the captured file. + Path string `json:"path"` +} + +// A root user turn that the session can rewind to. +// Experimental: HistoryRewindPoint is part of an experimental API and may change or be +// removed. +type HistoryRewindPoint struct { + // Whether at least one file in this turn or a later turn can be restored. + CanRestoreFiles bool `json:"canRestoreFiles"` + // ID of the user.message event that begins the discarded suffix. + EventID string `json:"eventId"` + // Number of unique files in this turn and all later turns that have captured changes. + FileCount int64 `json:"fileCount"` + // Whether this turn was an automatically injected autopilot continuation. + IsAutopilotContinuation bool `json:"isAutopilotContinuation"` + // Lines added by this turn's captured file changes. + LinesAdded int64 `json:"linesAdded"` + // Lines removed by this turn's captured file changes. + LinesRemoved int64 `json:"linesRemoved"` + // ISO timestamp of the user turn. + Timestamp string `json:"timestamp"` + // Whether this turn itself captured any file changes. + TurnChangedFiles bool `json:"turnChangedFiles"` + // User-visible message text for the turn. + UserMessage string `json:"userMessage"` +} + +// Boundary and mode for rewinding session history. +// Experimental: HistoryRewindRequest is part of an experimental API and may change or be +// removed. +type HistoryRewindRequest struct { + // ID of the user.message event that begins the discarded suffix. + EventID string `json:"eventId"` + // Whether to rewind only conversation history or also restore captured files. + Mode HistoryRewindMode `json:"mode"` +} + +// Structured outcome of a rewind request. +// Experimental: HistoryRewindResult is part of an experimental API and may change or be +// removed. +type HistoryRewindResult struct { + // Failure detail. Set only for the failure and partial-failure outcomes + // (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, + // `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the + // unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, + // `unsupported-remote-session`). + Error *string `json:"error,omitempty"` + // Number of persisted events removed by conversation truncation. Present only when + // truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and + // `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, + // `file-change-tracking-disabled`, `unsupported-remote-session`) and for + // `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + EventsRemoved *int64 `json:"eventsRemoved,omitempty"` + // Overall rewind outcome. This discriminates the result: it governs which of the remaining + // fields are populated, so consumers must switch on it before reading `eventsRemoved`, + // `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that + // populate it. + Outcome HistoryRewindOutcome `json:"outcome"` + // Absolute paths restored to their captured preimages. Always empty for conversation-only + // rewinds and for the unavailable outcomes (`session-busy`, + // `file-change-tracking-disabled`, `unsupported-remote-session`); only + // conversation-and-files outcomes that reached the file-restore stage populate it. + RestoredFiles []string `json:"restoredFiles"` + // Captured files intentionally left unchanged. Always empty for conversation-only rewinds + // and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, + // `unsupported-remote-session`); only conversation-and-files outcomes that reached the + // file-restore stage populate it. + SkippedFiles []HistorySkippedFileRestore `json:"skippedFiles"` +} + +// A captured file that rewind intentionally left unchanged. +// Experimental: HistorySkippedFileRestore is part of an experimental API and may change or +// be removed. +type HistorySkippedFileRestore struct { + // Absolute path of the skipped file. + Path string `json:"path"` + // Reason the file was not restored. + Reason HistoryFileRestoreSkipReason `json:"reason"` +} + +// Markdown summary of the conversation context (empty when not available). +// Experimental: HistorySummarizeForHandoffResult is part of an experimental API and may +// change or be removed. +type HistorySummarizeForHandoffResult struct { + // Markdown summary of the conversation context produced by an LLM. Empty string when there + // are no messages or when the session does not support local summarization. + Summary string `json:"summary"` } // Identifier of the event to truncate to; this event and all later events are removed. @@ -1500,11 +3339,38 @@ type HistoryTruncateRequest struct { // Experimental: HistoryTruncateResult is part of an experimental API and may change or be // removed. type HistoryTruncateResult struct { + // Failure detail when checkpointCleanupFailed is true. + CheckpointCleanupError *string `json:"checkpointCleanupError,omitempty"` + // True when conversation truncation succeeded but post-truncation workspace checkpoint + // cleanup failed. History is already truncated; callers may still prune snapshots but + // should report a checkpoint-cleanup rather than a truncation failure. + CheckpointCleanupFailed *bool `json:"checkpointCleanupFailed,omitempty"` // Number of events that were removed EventsRemoved int64 `json:"eventsRemoved"` } -// Schema for the `InstalledPlugin` type. +// Runtime-owned wire payload for a server-to-client hook callback invocation. +// Experimental: HookInvokeRequest is part of an experimental API and may change or be +// removed. +// Internal: HookInvokeRequest is an internal SDK API and is not part of the public surface. +type HookInvokeRequest struct { + // Internal: HookType is part of the SDK's internal API surface and is not intended for + // external use. + HookType HookType `json:"hookType"` + Input any `json:"input"` + SessionID string `json:"sessionId"` +} + +// Optional output returned by an SDK callback hook. +// Experimental: HookInvokeResponse is part of an experimental API and may change or be +// removed. +// Internal: HookInvokeResponse is an internal SDK API and is not part of the public surface. +type HookInvokeResponse struct { + Output any `json:"output,omitempty"` +} + +// Installed plugin record from global state, with marketplace, version, install time, +// enabled state, cache path, and source. // Experimental: InstalledPlugin is part of an experimental API and may change or be removed. type InstalledPlugin struct { // Path where the plugin is cached locally @@ -1519,32 +3385,60 @@ type InstalledPlugin struct { Name string `json:"name"` // Source for direct repo installs (when marketplace is empty) Source *InstalledPluginSource `json:"source,omitempty"` + // Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus + // its resolved source subtree — NOT a Git commit SHA) captured at marketplace + // install/update time. Auto-update compares it against the freshly recomputed fingerprint + // to detect a content change that does not bump the version. Absent for pre-existing + // installs and for direct (non-marketplace) installs. + SourceSha *string `json:"source_sha,omitempty"` // Version installed (if available) Version *string `json:"version,omitempty"` } +// Information about an installed plugin tracked in global state. +// Experimental: InstalledPluginInfo is part of an experimental API and may change or be +// removed. +type InstalledPluginInfo struct { + // Opaque, stable hash identifying a direct (non-marketplace) install source. Present only + // for direct repo / URL / local installs; absent for marketplace plugins. Same source + // yields the same id; distinct sources never collide. + DirectSourceID *string `json:"directSourceId,omitempty"` + // Whether the plugin is currently enabled for new sessions + Enabled bool `json:"enabled"` + // Marketplace the plugin came from. Empty string ("") for direct repo / URL / local + // installs. + Marketplace string `json:"marketplace"` + // Plugin name + Name string `json:"name"` + // Installed version (when reported by the plugin manifest) + Version *string `json:"version,omitempty"` +} + // Source for direct repo installs (when marketplace is empty) // Experimental: InstalledPluginSource is part of an experimental API and may change or be // removed. type InstalledPluginSource struct { - InstalledPluginSourceGithub *InstalledPluginSourceGithub + InstalledPluginSourceGitHub *InstalledPluginSourceGitHub InstalledPluginSourceLocal *InstalledPluginSourceLocal InstalledPluginSourceURL *InstalledPluginSourceURL String *string } -// Schema for the `InstalledPluginSourceGithub` type. -// Experimental: InstalledPluginSourceGithub is part of an experimental API and may change +// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or +// full commit SHA, and optional subpath. +// Experimental: InstalledPluginSourceGitHub is part of an experimental API and may change // or be removed. -type InstalledPluginSourceGithub struct { +type InstalledPluginSourceGitHub struct { Path *string `json:"path,omitempty"` Ref *string `json:"ref,omitempty"` Repo string `json:"repo"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` // Constant value. Always "github". - Source InstalledPluginSourceGithubSource `json:"source"` + Source InstalledPluginSourceGitHubSource `json:"source"` } -// Schema for the `InstalledPluginSourceLocal` type. +// Source descriptor for a direct local plugin install, with a local filesystem path. // Experimental: InstalledPluginSourceLocal is part of an experimental API and may change or // be removed. type InstalledPluginSourceLocal struct { @@ -1553,32 +3447,88 @@ type InstalledPluginSourceLocal struct { Source InstalledPluginSourceLocalSource `json:"source"` } -// Schema for the `InstalledPluginSourceUrl` type. +// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit +// SHA, and optional subpath. // Experimental: InstalledPluginSourceURL is part of an experimental API and may change or // be removed. type InstalledPluginSourceURL struct { Path *string `json:"path,omitempty"` Ref *string `json:"ref,omitempty"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` // Constant value. Always "url". Source InstalledPluginSourceURLSource `json:"source"` URL string `json:"url"` } +// Canonical file or directory where custom instructions can be discovered or created, with +// location, kind, preference, and project path. +// Experimental: InstructionDiscoveryPath is part of an experimental API and may change or +// be removed. +type InstructionDiscoveryPath struct { + // Whether the target is a single file or a directory of instruction files + Kind InstructionDiscoveryPathKind `json:"kind"` + // Which tier this target belongs to + Location InstructionDiscoveryPathLocation `json:"location"` + // Absolute path of the file or directory (may not exist on disk yet) + Path string `json:"path"` + // Whether this is the canonical target to create new instructions in its tier. At most one + // entry per tier is preferred. + PreferredForCreation bool `json:"preferredForCreation"` + // The input project path this target was derived from (only for repository targets) + ProjectPath *string `json:"projectPath,omitempty"` +} + +// Canonical files and directories where custom instructions can be created so the runtime +// will recognize them. +// Experimental: InstructionDiscoveryPathList is part of an experimental API and may change +// or be removed. +type InstructionDiscoveryPathList struct { + // Canonical instruction create/discovery files and directories, in priority order + Paths []InstructionDiscoveryPath `json:"paths"` +} + +// Optional project paths to include in instruction discovery. +// Experimental: InstructionsDiscoverRequest is part of an experimental API and may change +// or be removed. +type InstructionsDiscoverRequest struct { + // When true, omit the host's instruction sources (user/home-level files and plugin rules), + // leaving only repository and working-directory sources. For multitenant deployments. + ExcludeHostInstructions *bool `json:"excludeHostInstructions,omitempty"` + // Optional list of project directory paths to scan for repository/working-directory + // instruction sources. When omitted or empty, only user-level and plugin instruction + // sources are returned (no project scan). + ProjectPaths []string `json:"projectPaths,omitzero"` +} + +// Optional project paths to include when enumerating instruction discovery targets. +// Experimental: InstructionsGetDiscoveryPathsRequest is part of an experimental API and may +// change or be removed. +type InstructionsGetDiscoveryPathsRequest struct { + // When true, omit the host's user-level instruction targets, leaving only repository + // targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + ExcludeHostInstructions *bool `json:"excludeHostInstructions,omitempty"` + // Optional list of project directory paths. When omitted or empty, only the user-level + // targets are returned. + ProjectPaths []string `json:"projectPaths,omitzero"` +} + // Instruction sources loaded for the session, in merge order. // Experimental: InstructionsGetSourcesResult is part of an experimental API and may change // or be removed. type InstructionsGetSourcesResult struct { // Instruction sources for the session - Sources []InstructionsSources `json:"sources"` + Sources []InstructionSource `json:"sources"` } -// Schema for the `InstructionsSources` type. -// Experimental: InstructionsSources is part of an experimental API and may change or be +// Loaded instruction source for a session, including path, content, category, location, +// applicability, and optional description. +// Experimental: InstructionSource is part of an experimental API and may change or be // removed. -type InstructionsSources struct { +type InstructionSource struct { // Glob pattern(s) from frontmatter — when set, this instruction applies only to matching // files - ApplyTo []string `json:"applyTo,omitempty"` + ApplyTo []string `json:"applyTo,omitzero"` // Raw content of the instruction file Content string `json:"content"` // When true, this source starts disabled and must be toggled on by the user @@ -1590,11 +3540,230 @@ type InstructionsSources struct { // Human-readable label Label string `json:"label"` // Where this source lives — used for UI grouping - Location InstructionsSourcesLocation `json:"location"` + Location InstructionSourceLocation `json:"location"` + // The project path this source was discovered from. Only set by sessionless discovery for + // repository, working-directory, and project-scoped plugin sources, where it disambiguates + // sources across multiple workspace roots. The session-scoped getSources leaves it unset. + ProjectPath *string `json:"projectPath,omitempty"` // File path relative to repo or absolute for home SourcePath string `json:"sourcePath"` // Category of instruction source — used for merge logic - Type InstructionsSourcesType `json:"type"` + Type InstructionSourceType `json:"type"` +} + +// Parameters for interrupting the main agent turn. +// Experimental: InterruptMainTurnRequest is part of an experimental API and may change or +// be removed. +type InterruptMainTurnRequest struct { + // When true, the user's queued prompts are preserved and run as the next turn once the + // interrupted turn unwinds; when false (the default), the queue is cleared like a plain + // abort. + FlushQueued *bool `json:"flushQueued,omitempty"` +} + +// Result of interrupting the main agent turn. +// Experimental: InterruptMainTurnResult is part of an experimental API and may change or be +// removed. +type InterruptMainTurnResult struct { + // Whether an in-flight main agent turn was interrupted. False when the main loop was not + // processing. + Interrupted bool `json:"interrupted"` +} + +// HTTP headers as a map from lowercased header name to a list of values. Multi-valued +// headers (e.g. Set-Cookie) preserve all values. +// Experimental: LlmInferenceHeaders is part of an experimental API and may change or be +// removed. +type LlmInferenceHeaders map[string][]string + +// A request body chunk or cancellation signal. +// Experimental: LlmInferenceHTTPRequestChunkRequest is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPRequestChunkRequest struct { + // Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching + // the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent + // transport can attribute successive turns correctly: when a WebSocket connection is reused + // across turns, the httpRequestStart identity reflects only the turn that opened the + // connection, so each later turn stamps its own invocation id here. Absent when the runtime + // has no invocation context for the request, or on the plain-HTTP transport where every + // request has its own httpRequestStart. + AgentInvocationID *string `json:"agentInvocationId,omitempty"` + // When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + Binary *bool `json:"binary,omitempty"` + // When true, the runtime is cancelling the in-flight request (e.g. upstream consumer + // aborted). `data` is ignored. Implies end-of-request. + Cancel *bool `json:"cancel,omitempty"` + // Optional human-readable reason for the cancellation, propagated for logging. + CancelReason *string `json:"cancelReason,omitempty"` + // Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when + // `binary` is true. May be empty. + Data string `json:"data"` + // When true, this is the final body chunk for the request. The SDK may rely on having + // received an end-marked chunk before treating the request body as complete. + End *bool `json:"end,omitempty"` + // Matches the requestId from the originating httpRequestStart frame. + RequestID string `json:"requestId"` +} + +// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as +// fire-and-forget. +// Experimental: LlmInferenceHTTPRequestChunkResult is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPRequestChunkResult struct { +} + +// The head of an outbound model-layer HTTP request. +// Experimental: LlmInferenceHTTPRequestStartRequest is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPRequestStartRequest struct { + // Stable identity of the agent trajectory that issued this request. Present when the + // request originates from an agent turn; absent for requests outside any agent context. + // This is the same identity used by lifecycle and bridged session events and remains + // constant across turns and retries. + AgentID *string `json:"agentId,omitempty"` + // Identity of the agent invocation (one agentic loop) that issued this request. It remains + // fixed across physical retries within the invocation and is distinct from the stable + // trajectory `agentId`. A caller-supplied invocation id always takes precedence (this + // covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests + // fall back to the runtime's agent task id — the same value the runtime emits as the + // `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. + AgentInvocationID *string `json:"agentInvocationId,omitempty"` + Headers map[string][]string `json:"headers"` + // Coarse classification of the interaction that produced this request. Open string for + // forward-compatibility; known values include `conversation-agent`, + // `conversation-subagent`, `conversation-sampling`, `conversation-background`, + // `conversation-compaction`, and `conversation-user`. Absent when the runtime did not + // classify the request. Comes from the runtime's per-request agent context independently of + // transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` + // header from this same context. + InteractionType *string `json:"interactionType,omitempty"` + // HTTP method, e.g. GET, POST. + Method string `json:"method"` + // Stable identity of the immediate parent trajectory. Present for child trajectories such + // as subagents and conversation-sampling requests; absent for root-agent and non-agent + // requests. + ParentAgentID *string `json:"parentAgentId,omitempty"` + // Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate + // httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies + // back to the runtime. + RequestID string `json:"requestId"` + // Id of the runtime session that triggered this request, when one is in scope. Absent for + // requests issued outside any session (e.g. startup model-catalog or capability + // resolution). This is a payload field — not a dispatch key — because the client-global API + // is registered process-wide rather than per session. + SessionID *string `json:"sessionId,omitempty"` + // Transport the runtime would otherwise use for this request. `http` (the default when + // absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message + // channel where each body chunk maps to one WebSocket message and the `binary` flag + // distinguishes text from binary frames. The SDK consumer uses this to decide whether to + // service the request with an HTTP client or a WebSocket client. It is the one piece of + // request metadata the consumer cannot reliably infer from the URL or headers alone. + Transport *LlmInferenceHTTPRequestStartTransport `json:"transport,omitempty"` + // Absolute request URL. + URL string `json:"url"` +} + +// Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it +// does not imply the request will succeed. +// Experimental: LlmInferenceHTTPRequestStartResult is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPRequestStartResult struct { +} + +// Set to terminate the response with a transport-level failure. Implies end-of-stream; any +// further chunks for this requestId are ignored. +// Experimental: LlmInferenceHTTPResponseChunkError is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPResponseChunkError struct { + // Optional machine-readable error code. + Code *string `json:"code,omitempty"` + // Human-readable failure description. + Message string `json:"message"` +} + +// A response body chunk or terminal error. +// Experimental: LlmInferenceHTTPResponseChunkRequest is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPResponseChunkRequest struct { + // When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + Binary *bool `json:"binary,omitempty"` + // Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when + // `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk + // with empty data and end=true). + Data string `json:"data"` + // When true, this is the final body chunk for the response. The runtime treats the response + // body as complete after receiving an end-marked chunk. + End *bool `json:"end,omitempty"` + // Set to terminate the response with a transport-level failure. Implies end-of-stream; any + // further chunks for this requestId are ignored. + Error *LlmInferenceHTTPResponseChunkError `json:"error,omitempty"` + // Matches the requestId from the originating httpRequestStart frame. + RequestID string `json:"requestId"` +} + +// Whether the chunk was accepted. +// Experimental: LlmInferenceHTTPResponseChunkResult is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPResponseChunkResult struct { + // True when the chunk was matched to a pending request; false when unknown. + Accepted bool `json:"accepted"` +} + +// Response head. +// Experimental: LlmInferenceHTTPResponseStartRequest is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPResponseStartRequest struct { + Headers map[string][]string `json:"headers"` + // Matches the requestId from the originating httpRequestStart frame. + RequestID string `json:"requestId"` + // HTTP status code. + Status int64 `json:"status"` + // Optional HTTP status reason phrase. + StatusText *string `json:"statusText,omitempty"` +} + +// Whether the start frame was accepted. +// Experimental: LlmInferenceHTTPResponseStartResult is part of an experimental API and may +// change or be removed. +type LlmInferenceHTTPResponseStartResult struct { + // True when the response start was matched to a pending request; false when unknown. + Accepted bool `json:"accepted"` +} + +// Indicates whether the calling client was registered as the LLM inference provider. +// Experimental: LlmInferenceSetProviderResult is part of an experimental API and may change +// or be removed. +type LlmInferenceSetProviderResult struct { + // Whether the provider was set successfully + Success bool `json:"success"` +} + +// Persisted local session metadata, including identifiers, timestamps, summary/name, +// client, context, detached state, and task ID. +// Experimental: LocalSessionMetadataValue is part of an experimental API and may change or +// be removed. +type LocalSessionMetadataValue struct { + // Runtime client name that created/last resumed this session + ClientName *string `json:"clientName,omitempty"` + // Pre-resolved working-directory context for session startup. + Context *SessionContext `json:"context,omitempty"` + // True for detached maintenance sessions that should be hidden from normal resume lists. + IsDetached *bool `json:"isDetached,omitempty"` + // Always false for local sessions. + IsRemote bool `json:"isRemote"` + // GitHub task ID, when this local session is bound to one. Only present for local sessions + // exported to remote control. + McTaskID *string `json:"mcTaskId,omitempty"` + // Last-modified time of the session's persisted state, as ISO 8601 + ModifiedTime string `json:"modifiedTime"` + // Optional human-friendly name set via /rename + Name *string `json:"name,omitempty"` + // Stable session identifier + SessionID string `json:"sessionId"` + // Session creation time as an ISO 8601 timestamp + StartTime string `json:"startTime"` + // Short summary of the session, when one has been derived + Summary *string `json:"summary,omitempty"` } // Message text, optional severity level, persistence flag, optional follow-up URL, and @@ -1639,12 +3808,112 @@ type LspInitializeRequest struct { WorkingDirectory *string `json:"workingDirectory,omitempty"` } +// Validated device-managed settings discovered before a session exists. +// Experimental: ManagedSettingsReadResult is part of an experimental API and may change or +// be removed. +type ManagedSettingsReadResult struct { + // Discovery or validation error text when managed settings could not be read safely. + ErrorMessage *string `json:"errorMessage,omitempty"` + // Validated, canonical managed-settings JSON. Omitted when no managed settings were + // discovered or when discovered settings failed validation. + SettingsJSON any `json:"settingsJson,omitempty"` +} + +// Result of registering a new marketplace. +// Experimental: MarketplaceAddResult is part of an experimental API and may change or be +// removed. +type MarketplaceAddResult struct { + // Final name of the marketplace as resolved from its manifest + Name string `json:"name"` +} + +// Plugins advertised by the marketplace. +// Experimental: MarketplaceBrowseResult is part of an experimental API and may change or be +// removed. +type MarketplaceBrowseResult struct { + // Plugins advertised by the marketplace + Plugins []MarketplacePluginInfo `json:"plugins"` +} + +// Registered marketplace summary. +// Experimental: MarketplaceInfo is part of an experimental API and may change or be removed. +type MarketplaceInfo struct { + // True when this is a default marketplace shipped with the runtime. Defaults are not + // removable. + IsDefault *bool `json:"isDefault,omitempty"` + // Marketplace name (matches the @marketplace suffix in plugin specs) + Name string `json:"name"` + // Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: + // owner/repo"). + Source string `json:"source"` +} + +// All registered marketplaces, including built-in defaults. +// Experimental: MarketplaceListResult is part of an experimental API and may change or be +// removed. +type MarketplaceListResult struct { + // Registered marketplaces + Marketplaces []MarketplaceInfo `json:"marketplaces"` +} + +// Plugin entry advertised by a marketplace. +// Experimental: MarketplacePluginInfo is part of an experimental API and may change or be +// removed. +type MarketplacePluginInfo struct { + // Short description from the marketplace catalog, when present + Description *string `json:"description,omitempty"` + // Plugin name as listed in the marketplace catalog + Name string `json:"name"` +} + +// Per-marketplace refresh result, including marketplace name, success flag, and optional +// failure error. +// Experimental: MarketplaceRefreshEntry is part of an experimental API and may change or be +// removed. +type MarketplaceRefreshEntry struct { + // Error message (failure only) + Error *string `json:"error,omitempty"` + // Marketplace name that was refreshed + Name string `json:"name"` + // Whether the refresh succeeded + Success bool `json:"success"` +} + +// Result of refreshing one or more marketplace catalogs. +// Experimental: MarketplaceRefreshResult is part of an experimental API and may change or +// be removed. +type MarketplaceRefreshResult struct { + // Per-marketplace refresh results in deterministic order. + Results []MarketplaceRefreshEntry `json:"results"` +} + +// Outcome of the remove attempt, including dependent-plugin info when applicable. +// Experimental: MarketplaceRemoveResult is part of an experimental API and may change or be +// removed. +type MarketplaceRemoveResult struct { + // Names of installed plugins that prevented removal. Populated only when `removed=false`. + DependentPlugins []string `json:"dependentPlugins,omitzero"` + // True when the marketplace was actually removed. False when removal was skipped because + // the marketplace has dependent plugins and `force` was not set. + Removed bool `json:"removed"` +} + +// MCP server allowed by policy, with server name and optional PII-free explanatory note. +// Experimental: MCPAllowedServer is part of an experimental API and may change or be +// removed. +type MCPAllowedServer struct { + // Allowed server name + Name string `json:"name"` + // PII-free note explaining why the server was allowed + RedactedNote *string `json:"redactedNote,omitempty"` +} + // MCP server, tool name, and arguments to invoke from an MCP App view. -// Experimental: McpAppsCallToolRequest is part of an experimental API and may change or be +// Experimental: MCPAppsCallToolRequest is part of an experimental API and may change or be // removed. -type McpAppsCallToolRequest struct { +type MCPAppsCallToolRequest struct { // Tool arguments - Arguments map[string]any `json:"arguments,omitempty"` + Arguments map[string]any `json:"arguments,omitzero"` // **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the // app from this server only'), the call is rejected when this differs from `serverName`, // and rejected outright when missing. @@ -1656,39 +3925,39 @@ type McpAppsCallToolRequest struct { } // Capability negotiation snapshot -// Experimental: McpAppsDiagnoseCapability is part of an experimental API and may change or +// Experimental: MCPAppsDiagnoseCapability is part of an experimental API and may change or // be removed. -type McpAppsDiagnoseCapability struct { +type MCPAppsDiagnoseCapability struct { // Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers Advertised bool `json:"advertised"` // Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on FeatureFlagEnabled bool `json:"featureFlagEnabled"` // Whether the session has the `mcp-apps` capability - SessionHasMcpApps bool `json:"sessionHasMcpApps"` + SessionHasMCPApps bool `json:"sessionHasMcpApps"` } // MCP server to diagnose MCP Apps wiring for. -// Experimental: McpAppsDiagnoseRequest is part of an experimental API and may change or be +// Experimental: MCPAppsDiagnoseRequest is part of an experimental API and may change or be // removed. -type McpAppsDiagnoseRequest struct { +type MCPAppsDiagnoseRequest struct { // MCP server to probe ServerName string `json:"serverName"` } // Diagnostic snapshot of MCP Apps wiring for the named server. -// Experimental: McpAppsDiagnoseResult is part of an experimental API and may change or be +// Experimental: MCPAppsDiagnoseResult is part of an experimental API and may change or be // removed. -type McpAppsDiagnoseResult struct { +type MCPAppsDiagnoseResult struct { // Capability negotiation snapshot - Capability McpAppsDiagnoseCapability `json:"capability"` + Capability MCPAppsDiagnoseCapability `json:"capability"` // What the server returned for this session - Server McpAppsDiagnoseServer `json:"server"` + Server MCPAppsDiagnoseServer `json:"server"` } // What the server returned for this session -// Experimental: McpAppsDiagnoseServer is part of an experimental API and may change or be +// Experimental: MCPAppsDiagnoseServer is part of an experimental API and may change or be // removed. -type McpAppsDiagnoseServer struct { +type MCPAppsDiagnoseServer struct { // Whether the named server is currently connected Connected bool `json:"connected"` // Up to 5 tool names with `_meta.ui` for quick inspection @@ -1700,27 +3969,27 @@ type McpAppsDiagnoseServer struct { } // Current host context advertised to MCP App guests. -// Experimental: McpAppsHostContext is part of an experimental API and may change or be +// Experimental: MCPAppsHostContext is part of an experimental API and may change or be // removed. -type McpAppsHostContext struct { +type MCPAppsHostContext struct { // Current host context - Context McpAppsHostContextDetails `json:"context"` + Context MCPAppsHostContextDetails `json:"context"` } // Current host context -// Experimental: McpAppsHostContextDetails is part of an experimental API and may change or +// Experimental: MCPAppsHostContextDetails is part of an experimental API and may change or // be removed. -type McpAppsHostContextDetails struct { +type MCPAppsHostContextDetails struct { // Display modes the host supports - AvailableDisplayModes []McpAppsHostContextDetailsAvailableDisplayMode `json:"availableDisplayModes,omitempty"` + AvailableDisplayModes []MCPAppsHostContextDetailsAvailableDisplayMode `json:"availableDisplayModes,omitzero"` // Current display mode (SEP-1865) - DisplayMode *McpAppsHostContextDetailsDisplayMode `json:"displayMode,omitempty"` + DisplayMode *MCPAppsHostContextDetailsDisplayMode `json:"displayMode,omitempty"` // BCP-47 locale, e.g. 'en-US' Locale *string `json:"locale,omitempty"` // Platform type for responsive design - Platform *McpAppsHostContextDetailsPlatform `json:"platform,omitempty"` + Platform *MCPAppsHostContextDetailsPlatform `json:"platform,omitempty"` // UI theme preference per SEP-1865 - Theme *McpAppsHostContextDetailsTheme `json:"theme,omitempty"` + Theme *MCPAppsHostContextDetailsTheme `json:"theme,omitempty"` // IANA timezone, e.g. 'America/New_York' TimeZone *string `json:"timeZone,omitempty"` // Host application identifier @@ -1728,9 +3997,9 @@ type McpAppsHostContextDetails struct { } // MCP server to list app-callable tools for. -// Experimental: McpAppsListToolsRequest is part of an experimental API and may change or be +// Experimental: MCPAppsListToolsRequest is part of an experimental API and may change or be // removed. -type McpAppsListToolsRequest struct { +type MCPAppsListToolsRequest struct { // **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the // app from this server only'), the call is rejected when this differs from `serverName`, // and rejected outright when missing. @@ -1740,17 +4009,17 @@ type McpAppsListToolsRequest struct { } // App-callable tools from the named MCP server. -// Experimental: McpAppsListToolsResult is part of an experimental API and may change or be +// Experimental: MCPAppsListToolsResult is part of an experimental API and may change or be // removed. -type McpAppsListToolsResult struct { +type MCPAppsListToolsResult struct { // App-callable tools from the server Tools []map[string]any `json:"tools"` } // MCP server and resource URI to fetch. -// Experimental: McpAppsReadResourceRequest is part of an experimental API and may change or +// Experimental: MCPAppsReadResourceRequest is part of an experimental API and may change or // be removed. -type McpAppsReadResourceRequest struct { +type MCPAppsReadResourceRequest struct { // Name of the MCP server hosting the resource ServerName string `json:"serverName"` // Resource URI (typically ui://...) @@ -1758,21 +4027,22 @@ type McpAppsReadResourceRequest struct { } // Resource contents returned by the MCP server. -// Experimental: McpAppsReadResourceResult is part of an experimental API and may change or +// Experimental: MCPAppsReadResourceResult is part of an experimental API and may change or // be removed. -type McpAppsReadResourceResult struct { +type MCPAppsReadResourceResult struct { // Resource contents returned by the server - Contents []McpAppsResourceContent `json:"contents"` + Contents []MCPAppsResourceContent `json:"contents"` } -// Schema for the `McpAppsResourceContent` type. -// Experimental: McpAppsResourceContent is part of an experimental API and may change or be +// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource +// metadata. +// Experimental: MCPAppsResourceContent is part of an experimental API and may change or be // removed. -type McpAppsResourceContent struct { +type MCPAppsResourceContent struct { // Base64-encoded binary content Blob *string `json:"blob,omitempty"` // Resource-level metadata (CSP, permissions, etc.) - Meta map[string]any `json:"_meta,omitempty"` + Meta map[string]any `json:"_meta,omitzero"` // MIME type of the content MIMEType *string `json:"mimeType,omitempty"` // Text content (e.g. HTML) @@ -1782,19 +4052,19 @@ type McpAppsResourceContent struct { } // Host context advertised to MCP App guests -// Experimental: McpAppsSetHostContextDetails is part of an experimental API and may change +// Experimental: MCPAppsSetHostContextDetails is part of an experimental API and may change // or be removed. -type McpAppsSetHostContextDetails struct { +type MCPAppsSetHostContextDetails struct { // Display modes the host supports - AvailableDisplayModes []McpAppsSetHostContextDetailsAvailableDisplayMode `json:"availableDisplayModes,omitempty"` + AvailableDisplayModes []MCPAppsSetHostContextDetailsAvailableDisplayMode `json:"availableDisplayModes,omitzero"` // Current display mode (SEP-1865) - DisplayMode *McpAppsSetHostContextDetailsDisplayMode `json:"displayMode,omitempty"` + DisplayMode *MCPAppsSetHostContextDetailsDisplayMode `json:"displayMode,omitempty"` // BCP-47 locale, e.g. 'en-US' Locale *string `json:"locale,omitempty"` // Platform type for responsive design - Platform *McpAppsSetHostContextDetailsPlatform `json:"platform,omitempty"` + Platform *MCPAppsSetHostContextDetailsPlatform `json:"platform,omitempty"` // UI theme preference per SEP-1865 - Theme *McpAppsSetHostContextDetailsTheme `json:"theme,omitempty"` + Theme *MCPAppsSetHostContextDetailsTheme `json:"theme,omitempty"` // IANA timezone, e.g. 'America/New_York' TimeZone *string `json:"timeZone,omitempty"` // Host application identifier @@ -1802,26 +4072,26 @@ type McpAppsSetHostContextDetails struct { } // Host context to advertise to MCP App guests. -// Experimental: McpAppsSetHostContextRequest is part of an experimental API and may change +// Experimental: MCPAppsSetHostContextRequest is part of an experimental API and may change // or be removed. -type McpAppsSetHostContextRequest struct { +type MCPAppsSetHostContextRequest struct { // Host context advertised to MCP App guests - Context McpAppsSetHostContextDetails `json:"context"` + Context MCPAppsSetHostContextDetails `json:"context"` } // The requestId previously passed to executeSampling that should be cancelled. -// Experimental: McpCancelSamplingExecutionParams is part of an experimental API and may +// Experimental: MCPCancelSamplingExecutionParams is part of an experimental API and may // change or be removed. -type McpCancelSamplingExecutionParams struct { +type MCPCancelSamplingExecutionParams struct { // The requestId previously passed to executeSampling that should be cancelled RequestID string `json:"requestId"` } // Indicates whether an in-flight sampling execution with the given requestId was found and // cancelled. -// Experimental: McpCancelSamplingExecutionResult is part of an experimental API and may +// Experimental: MCPCancelSamplingExecutionResult is part of an experimental API and may // change or be removed. -type McpCancelSamplingExecutionResult struct { +type MCPCancelSamplingExecutionResult struct { // True if an in-flight execution with the given requestId was found and signalled to // cancel. False when no such execution is in flight (already completed, never started, or // cancelled by another caller). @@ -1829,106 +4099,152 @@ type McpCancelSamplingExecutionResult struct { } // MCP server name and configuration to add to user configuration. -type McpConfigAddRequest struct { +// Experimental: MCPConfigAddRequest is part of an experimental API and may change or be +// removed. +type MCPConfigAddRequest struct { // MCP server configuration (stdio process or remote HTTP/SSE) - Config McpServerConfig `json:"config"` + Config MCPServerConfig `json:"config"` // Unique name for the MCP server Name string `json:"name"` } -type McpConfigAddResult struct { +// Experimental: MCPConfigAddResult is part of an experimental API and may change or be +// removed. +type MCPConfigAddResult struct { } // MCP server names to disable for new sessions. -type McpConfigDisableRequest struct { +// Experimental: MCPConfigDisableRequest is part of an experimental API and may change or be +// removed. +type MCPConfigDisableRequest struct { // 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. Names []string `json:"names"` } -type McpConfigDisableResult struct { +// Experimental: MCPConfigDisableResult is part of an experimental API and may change or be +// removed. +type MCPConfigDisableResult struct { } // MCP server names to enable for new sessions. -type McpConfigEnableRequest struct { +// Experimental: MCPConfigEnableRequest is part of an experimental API and may change or be +// removed. +type MCPConfigEnableRequest struct { // 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. Names []string `json:"names"` } -type McpConfigEnableResult struct { +// Experimental: MCPConfigEnableResult is part of an experimental API and may change or be +// removed. +type MCPConfigEnableResult struct { } // User-configured MCP servers, keyed by server name. -type McpConfigList struct { +// Experimental: MCPConfigList is part of an experimental API and may change or be removed. +type MCPConfigList struct { // All MCP servers from user config, keyed by name - Servers map[string]McpServerConfig `json:"servers"` + Servers map[string]MCPServerConfig `json:"servers"` } -type McpConfigReloadResult struct { +// Experimental: MCPConfigReloadResult is part of an experimental API and may change or be +// removed. +type MCPConfigReloadResult struct { } // MCP server name to remove from user configuration. -type McpConfigRemoveRequest struct { +// Experimental: MCPConfigRemoveRequest is part of an experimental API and may change or be +// removed. +type MCPConfigRemoveRequest struct { // Name of the MCP server to remove Name string `json:"name"` } -type McpConfigRemoveResult struct { +// Experimental: MCPConfigRemoveResult is part of an experimental API and may change or be +// removed. +type MCPConfigRemoveResult struct { } // MCP server name and replacement configuration to write to user configuration. -type McpConfigUpdateRequest struct { +// Experimental: MCPConfigUpdateRequest is part of an experimental API and may change or be +// removed. +type MCPConfigUpdateRequest struct { // MCP server configuration (stdio process or remote HTTP/SSE) - Config McpServerConfig `json:"config"` + Config MCPServerConfig `json:"config"` // Name of the MCP server to update Name string `json:"name"` } -type McpConfigUpdateResult struct { +// Experimental: MCPConfigUpdateResult is part of an experimental API and may change or be +// removed. +type MCPConfigUpdateResult struct { +} + +// Opaque auth info used to configure GitHub MCP. +// Experimental: MCPConfigureGitHubRequest is part of an experimental API and may change or +// be removed. +type MCPConfigureGitHubRequest struct { + // Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process + // runtime shape (configureGitHubMcp is a no-op over the wire). + // Internal: AuthInfo is part of the SDK's internal API surface and is not intended for + // external use. + AuthInfo any `json:"authInfo"` +} + +// Result of configuring GitHub MCP. +// Experimental: MCPConfigureGitHubResult is part of an experimental API and may change or +// be removed. +type MCPConfigureGitHubResult struct { + // Whether GitHub MCP configuration changed. + Changed bool `json:"changed"` } // Name of the MCP server to disable for the session. -// Experimental: McpDisableRequest is part of an experimental API and may change or be +// Experimental: MCPDisableRequest is part of an experimental API and may change or be // removed. -type McpDisableRequest struct { +type MCPDisableRequest struct { // Name of the MCP server to disable ServerName string `json:"serverName"` } // Optional working directory used as context for MCP server discovery. -type McpDiscoverRequest struct { +// Experimental: MCPDiscoverRequest is part of an experimental API and may change or be +// removed. +type MCPDiscoverRequest struct { // Working directory used as context for discovery (e.g., plugin resolution) WorkingDirectory *string `json:"workingDirectory,omitempty"` } // MCP servers discovered from user, workspace, plugin, and built-in sources. -type McpDiscoverResult struct { +// Experimental: MCPDiscoverResult is part of an experimental API and may change or be +// removed. +type MCPDiscoverResult struct { // MCP servers discovered from all sources - Servers []DiscoveredMcpServer `json:"servers"` + Servers []DiscoveredMCPServer `json:"servers"` } // Name of the MCP server to enable for the session. -// Experimental: McpEnableRequest is part of an experimental API and may change or be +// Experimental: MCPEnableRequest is part of an experimental API and may change or be // removed. -type McpEnableRequest struct { +type MCPEnableRequest struct { // Name of the MCP server to enable ServerName string `json:"serverName"` } // Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. -// Experimental: McpExecuteSamplingParams is part of an experimental API and may change or +// Experimental: MCPExecuteSamplingParams is part of an experimental API and may change or // be removed. -type McpExecuteSamplingParams struct { +type MCPExecuteSamplingParams struct { // The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate // the inference with the originating MCP request for telemetry; this is distinct from // `requestId` (which is the schema-level cancellation handle). - McpRequestID any `json:"mcpRequestId"` + MCPRequestID any `json:"mcpRequestId"` // Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. // Treated as opaque at the schema layer; the runtime converts the embedded MCP messages // into the OpenAI chat-completion shape internally. - Request McpExecuteSamplingRequest `json:"request"` + Request MCPExecuteSamplingRequest `json:"request"` // Caller-provided unique identifier for this sampling execution. Use this same ID with // cancelSamplingExecution to cancel the in-flight call. Must be unique within the session // for the lifetime of the call. @@ -1940,47 +4256,217 @@ type McpExecuteSamplingParams struct { // Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. // Treated as opaque at the schema layer; the runtime converts the embedded MCP messages // into the OpenAI chat-completion shape internally. -// Experimental: McpExecuteSamplingRequest is part of an experimental API and may change or +// Experimental: MCPExecuteSamplingRequest is part of an experimental API and may change or // be removed. -type McpExecuteSamplingRequest struct { +type MCPExecuteSamplingRequest struct { } // MCP CreateMessageResult payload (with optional 'tools' extension), present when // action='success'. Treated as opaque at the schema layer; consumers should // construct/consume it per the MCP CreateMessageResult shape. -// Experimental: McpExecuteSamplingResult is part of an experimental API and may change or +// Experimental: MCPExecuteSamplingResult is part of an experimental API and may change or +// be removed. +type MCPExecuteSamplingResult struct { +} + +// MCP server filtered by policy, with name, reason, and optional redacted reason. +// Experimental: MCPFilteredServer is part of an experimental API and may change or be +// removed. +type MCPFilteredServer struct { + // Deprecated. This field is no longer populated. + // Deprecated: EnterpriseName is deprecated. + EnterpriseName *string `json:"enterpriseName,omitempty"` + // Filtered server name + Name string `json:"name"` + // Human-readable filter reason + Reason string `json:"reason"` + // PII-free filter reason + RedactedReason *string `json:"redactedReason,omitempty"` +} + +// Host response: supply dynamic headers or decline this refresh. +// Experimental: MCPHeadersHandlePendingHeadersRefreshRequest is part of an experimental API +// and may change or be removed. +type MCPHeadersHandlePendingHeadersRefreshRequest interface { + mcpHeadersHandlePendingHeadersRefreshRequest() + Kind() MCPHeadersHandlePendingHeadersRefreshRequestKind +} + +type RawMCPHeadersHandlePendingHeadersRefreshRequestData struct { + Discriminator MCPHeadersHandlePendingHeadersRefreshRequestKind + Raw json.RawMessage +} + +func (RawMCPHeadersHandlePendingHeadersRefreshRequestData) mcpHeadersHandlePendingHeadersRefreshRequest() { +} +func (r RawMCPHeadersHandlePendingHeadersRefreshRequestData) Kind() MCPHeadersHandlePendingHeadersRefreshRequestKind { + return r.Discriminator +} + +type MCPHeadersHandlePendingHeadersRefreshRequestHeaders struct { + // Headers to overlay onto the MCP request. Dynamic headers override static config headers + // but do not replace SDK-managed request headers. + Headers map[string]string `json:"headers"` +} + +func (MCPHeadersHandlePendingHeadersRefreshRequestHeaders) mcpHeadersHandlePendingHeadersRefreshRequest() { +} +func (MCPHeadersHandlePendingHeadersRefreshRequestHeaders) Kind() MCPHeadersHandlePendingHeadersRefreshRequestKind { + return MCPHeadersHandlePendingHeadersRefreshRequestKindHeaders +} + +type MCPHeadersHandlePendingHeadersRefreshRequestNone struct { +} + +func (MCPHeadersHandlePendingHeadersRefreshRequestNone) mcpHeadersHandlePendingHeadersRefreshRequest() { +} +func (MCPHeadersHandlePendingHeadersRefreshRequestNone) Kind() MCPHeadersHandlePendingHeadersRefreshRequestKind { + return MCPHeadersHandlePendingHeadersRefreshRequestKindNone +} + +// MCP headers refresh request id and the host response. +// Experimental: MCPHeadersHandlePendingHeadersRefreshRequestRequest is part of an +// experimental API and may change or be removed. +type MCPHeadersHandlePendingHeadersRefreshRequestRequest struct { + // Headers refresh request identifier from mcp.headers_refresh_required + RequestID string `json:"requestId"` + // Host response: supply dynamic headers or decline this refresh. + Result MCPHeadersHandlePendingHeadersRefreshRequest `json:"result"` +} + +// Indicates whether the pending MCP headers refresh response was accepted. +// Experimental: MCPHeadersHandlePendingHeadersRefreshRequestResult is part of an +// experimental API and may change or be removed. +type MCPHeadersHandlePendingHeadersRefreshRequestResult struct { + // Whether the response was accepted. False if the request was unknown, timed out, or + // already resolved. + Success bool `json:"success"` +} + +// Host-level state, omitted when no MCP host is initialized. +// Experimental: MCPHostState is part of an experimental API and may change or be removed. +type MCPHostState struct { + // Names of currently-connected MCP clients. + Clients []string `json:"clients"` + // Configured servers that are explicitly disabled. + DisabledServers []string `json:"disabledServers"` + // Map of server name to recorded connection failure. + FailedServers map[string]MCPServerFailureInfo `json:"failedServers"` + // Configured servers filtered out by MCP server policy. + FilteredServers []string `json:"filteredServers"` + // Whether third-party MCP servers are policy-enabled for this session. + Mcp3pEnabled bool `json:"mcp3pEnabled"` + // Map of server name to recorded pending-auth state. + NeedsAuthServers map[string]MCPServerNeedsAuthInfo `json:"needsAuthServers"` + // Names of servers with in-flight connection attempts. + PendingConnections []string `json:"pendingConnections"` +} + +// Server name to check running status for. +// Experimental: MCPIsServerRunningRequest is part of an experimental API and may change or +// be removed. +type MCPIsServerRunningRequest struct { + // Name of the MCP server to check + ServerName string `json:"serverName"` +} + +// Whether the named MCP server is running. +// Experimental: MCPIsServerRunningResult is part of an experimental API and may change or // be removed. -type McpExecuteSamplingResult struct { +type MCPIsServerRunningResult struct { + // True if the server has an active client and transport. + Running bool `json:"running"` +} + +// Server name whose tool list should be returned. +// Experimental: MCPListToolsRequest is part of an experimental API and may change or be +// removed. +type MCPListToolsRequest struct { + // Name of the connected MCP server whose tools to list. + ServerName string `json:"serverName"` +} + +// Tools exposed by the connected MCP server. Throws when the server is not connected. +// Experimental: MCPListToolsResult is part of an experimental API and may change or be +// removed. +type MCPListToolsResult struct { + // Tools exposed by the server. + Tools []MCPTools `json:"tools"` +} + +// Identifies the MCP server whose persisted OAuth credentials were updated. +// Experimental: MCPOauthAuthenticationStateChangedRequest is part of an experimental API +// and may change or be removed. +type MCPOauthAuthenticationStateChangedRequest struct { + // Whether the target session must mint a session-scoped access token instead of reusing a + // shared access token persisted by another session. + RefreshSessionToken *bool `json:"refreshSessionToken,omitempty"` + // Name of the MCP server whose OAuth credentials were updated. Omit only when the host + // cannot identify the server. + ServerName *string `json:"serverName,omitempty"` +} + +// Pending MCP OAuth request ID and host-provided token or cancellation response. +// Experimental: MCPOauthHandlePendingRequest is part of an experimental API and may change +// or be removed. +type MCPOauthHandlePendingRequest struct { + // OAuth request identifier from the mcp.oauth_required event + RequestID string `json:"requestId"` + // Host response to the pending OAuth request. + Result MCPOauthPendingRequestResponse `json:"result"` +} + +// Indicates whether the pending MCP OAuth response was accepted. +// Experimental: MCPOauthHandlePendingResult is part of an experimental API and may change +// or be removed. +type MCPOauthHandlePendingResult struct { + // Whether the response was accepted. False if the request was unknown, timed out, or + // already resolved. + Success bool `json:"success"` } // Remote MCP server name and optional overrides controlling reauthentication, OAuth client -// display name, and the callback success-page copy. -// Experimental: McpOauthLoginRequest is part of an experimental API and may change or be +// display name, callback success-page copy, and static OAuth client selection. +// Experimental: MCPOauthLoginRequest is part of an experimental API and may change or be // removed. -type McpOauthLoginRequest struct { +type MCPOauthLoginRequest struct { // 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. CallbackSuccessMessage *string `json:"callbackSuccessMessage,omitempty"` + // Optional OAuth client ID override for this login. When set, the runtime uses this + // pre-registered static client instead of dynamic client registration. + ClientID *string `json:"clientId,omitempty"` // 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. ClientName *string `json:"clientName,omitempty"` + // Optional OAuth client secret override for this login. The runtime treats this as an + // ephemeral host-owned secret, uses it for this authentication attempt and does not persist + // it. + ClientSecret *string `json:"clientSecret,omitempty"` // 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. ForceReauth *bool `json:"forceReauth,omitempty"` + // Optional OAuth grant type override for this login. Defaults to the server configuration, + // or authorization_code when no grant type is specified. + GrantType *MCPOauthLoginGrantType `json:"grantType,omitempty"` + // Optional override indicating whether the static OAuth client is public. When false, the + // runtime treats it as confidential and uses the per-login clientSecret if provided, + // otherwise retrieving the client secret from the MCP OAuth secret store. + PublicClient *bool `json:"publicClient,omitempty"` // Name of the remote MCP server to authenticate ServerName string `json:"serverName"` } // OAuth authorization URL the caller should open, or empty when cached tokens already // authenticated the server. -// Experimental: McpOauthLoginResult is part of an experimental API and may change or be +// Experimental: MCPOauthLoginResult is part of an experimental API and may change or be // removed. -type McpOauthLoginResult struct { +type MCPOauthLoginResult struct { // 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 @@ -1989,118 +4475,405 @@ type McpOauthLoginResult struct { AuthorizationURL *string `json:"authorizationUrl,omitempty"` } -// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to -// remove). -// Experimental: McpRemoveGitHubResult is part of an experimental API and may change or be -// removed. -type McpRemoveGitHubResult struct { - // True when the auto-managed `github` MCP server was removed; false when no removal - // happened (e.g. user has explicitly configured a `github` server, or the server was not - // registered). - Removed bool `json:"removed"` +// Host response to the pending OAuth request. +// Experimental: MCPOauthPendingRequestResponse is part of an experimental API and may +// change or be removed. +type MCPOauthPendingRequestResponse interface { + mcpOauthPendingRequestResponse() + Kind() MCPOauthPendingRequestResponseKind } -// Outcome of an MCP sampling execution: success result, failure error, or cancellation. -// Experimental: McpSamplingExecutionResult is part of an experimental API and may change or +type RawMCPOauthPendingRequestResponseData struct { + Discriminator MCPOauthPendingRequestResponseKind + Raw json.RawMessage +} + +func (RawMCPOauthPendingRequestResponseData) mcpOauthPendingRequestResponse() {} +func (r RawMCPOauthPendingRequestResponseData) Kind() MCPOauthPendingRequestResponseKind { + return r.Discriminator +} + +type MCPOauthPendingRequestResponseCancelled struct { +} + +func (MCPOauthPendingRequestResponseCancelled) mcpOauthPendingRequestResponse() {} +func (MCPOauthPendingRequestResponseCancelled) Kind() MCPOauthPendingRequestResponseKind { + return MCPOauthPendingRequestResponseKindCancelled +} + +type MCPOauthPendingRequestResponseToken struct { + // Access token acquired by the SDK host + AccessToken string `json:"accessToken"` + // Token lifetime in seconds, if known. + ExpiresIn *int64 `json:"expiresIn,omitempty"` + // OAuth token type. Defaults to Bearer when omitted. + TokenType *string `json:"tokenType,omitempty"` +} + +func (MCPOauthPendingRequestResponseToken) mcpOauthPendingRequestResponse() {} +func (MCPOauthPendingRequestResponseToken) Kind() MCPOauthPendingRequestResponseKind { + return MCPOauthPendingRequestResponseKindToken +} + +// Pending MCP OAuth request id to respond to. +// Experimental: MCPOauthRespondRequest is part of an experimental API and may change or be +// removed. +type MCPOauthRespondRequest struct { + // OAuth request identifier from the mcp.oauth_required event + RequestID string `json:"requestId"` +} + +// Indicates whether the pending MCP OAuth response was accepted. +// Experimental: MCPOauthRespondResult is part of an experimental API and may change or be +// removed. +type MCPOauthRespondResult struct { + // Whether the response was accepted. False if the request was unknown, timed out, or + // already resolved. + Success bool `json:"success"` +} + +// Registration parameters for an external MCP client. +// Experimental: MCPRegisterExternalClientRequest is part of an experimental API and may +// change or be removed. +type MCPRegisterExternalClientRequest struct { + // In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC + // boundary. + // Internal: Client is part of the SDK's internal API surface and is not intended for + // external use. + Client any `json:"client"` + // In-process server config (MCPServerConfig) paired with the in-process client/transport. + // Marked internal alongside its companions. + // Internal: Config is part of the SDK's internal API surface and is not intended for + // external use. + Config any `json:"config"` + // Logical server name for the external client + ServerName string `json:"serverName"` + // In-process MCP Transport instance. Marked internal: cannot be serialized across the + // JSON-RPC boundary. + // Internal: Transport is part of the SDK's internal API surface and is not intended for + // external use. + Transport any `json:"transport"` +} + +// Opaque MCP reload configuration. +// Experimental: MCPReloadWithConfigRequest is part of an experimental API and may change or +// be removed. +type MCPReloadWithConfigRequest struct { + // Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape + // (reloadMcpServers throws over the wire). + // Internal: Config is part of the SDK's internal API surface and is not intended for + // external use. + Config any `json:"config"` +} + +// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to +// remove). +// Experimental: MCPRemoveGitHubResult is part of an experimental API and may change or be +// removed. +type MCPRemoveGitHubResult struct { + // True when the auto-managed `github` MCP server was removed; false when no removal + // happened (e.g. user has explicitly configured a `github` server, or the server was not + // registered). + Removed bool `json:"removed"` +} + +// An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, +// MIME type, size, icons, annotations, and metadata. Server-provided fields outside the +// standard descriptor shape are exposed under `additionalProperties`. +// Experimental: MCPResource is part of an experimental API and may change or be removed. +type MCPResource struct { + // Server-provided non-standard descriptor fields preserved from the MCP response + AdditionalProperties map[string]any `json:"additionalProperties,omitzero"` + // Model/client annotations associated with this resource + Annotations *MCPResourceAnnotations `json:"annotations,omitempty"` + // Optional description of what this resource represents + Description *string `json:"description,omitempty"` + // Icons associated with this resource + Icons []MCPResourceIcon `json:"icons,omitzero"` + // Resource-level metadata + Meta map[string]any `json:"_meta,omitzero"` + // MIME type of the resource, if known + MIMEType *string `json:"mimeType,omitempty"` + // The programmatic name of the resource + Name string `json:"name"` + // Resource size in bytes, when known + Size *int64 `json:"size,omitempty"` + // Optional human-readable display title + Title *string `json:"title,omitempty"` + // The resource URI (e.g. ui://... or file:///...) + URI string `json:"uri"` +} + +// Standard MCP resource annotations plus preserved non-standard annotation fields. +// Experimental: MCPResourceAnnotations is part of an experimental API and may change or be +// removed. +type MCPResourceAnnotations struct { + // Server-provided non-standard annotation fields preserved from the MCP response + AdditionalProperties map[string]any `json:"additionalProperties,omitzero"` + // Intended audience roles for this resource + Audience []string `json:"audience,omitzero"` + // Last-modified timestamp hint + LastModified *string `json:"lastModified,omitempty"` + // Priority hint for model/client use + Priority *float64 `json:"priority,omitempty"` +} + +// MCP resource content with URI, optional MIME type, text or base64 blob, and resource +// metadata. +// Experimental: MCPResourceContent is part of an experimental API and may change or be +// removed. +type MCPResourceContent struct { + // Base64-encoded binary content + Blob *string `json:"blob,omitempty"` + // Resource-level metadata (CSP, permissions, etc.) + Meta map[string]any `json:"_meta,omitzero"` + // MIME type of the content + MIMEType *string `json:"mimeType,omitempty"` + // Text content (e.g. HTML) + Text *string `json:"text,omitempty"` + // The resource URI + URI string `json:"uri"` +} + +// A resource icon descriptor plus preserved non-standard icon fields. +// Experimental: MCPResourceIcon is part of an experimental API and may change or be removed. +type MCPResourceIcon struct { + // Server-provided non-standard icon fields preserved from the MCP response + AdditionalProperties map[string]any `json:"additionalProperties,omitzero"` + // Icon MIME type, when known + MIMEType *string `json:"mimeType,omitempty"` + // Icon sizes hint + Sizes *string `json:"sizes,omitempty"` + // Icon URI + Src string `json:"src"` + // Theme hint for this icon + Theme *string `json:"theme,omitempty"` +} + +// MCP server whose resources to enumerate. +// Experimental: MCPResourcesListRequest is part of an experimental API and may change or be +// removed. +type MCPResourcesListRequest struct { + // Opaque MCP pagination cursor from a prior `nextCursor` value + Cursor *string `json:"cursor,omitempty"` + // Name of the MCP server whose resources to enumerate + ServerName string `json:"serverName"` +} + +// One page of resources advertised by the named MCP server. +// Experimental: MCPResourcesListResult is part of an experimental API and may change or be +// removed. +type MCPResourcesListResult struct { + // Opaque cursor for the next page, if the server has more resources + NextCursor *string `json:"nextCursor,omitempty"` + // Resources advertised by the server (proxied MCP `resources/list`) + Resources []MCPResource `json:"resources"` +} + +// MCP server whose resource templates to enumerate. +// Experimental: MCPResourcesListTemplatesRequest is part of an experimental API and may +// change or be removed. +type MCPResourcesListTemplatesRequest struct { + // Opaque MCP pagination cursor from a prior `nextCursor` value + Cursor *string `json:"cursor,omitempty"` + // Name of the MCP server whose resource templates to enumerate + ServerName string `json:"serverName"` +} + +// One page of resource templates advertised by the named MCP server. +// Experimental: MCPResourcesListTemplatesResult is part of an experimental API and may +// change or be removed. +type MCPResourcesListTemplatesResult struct { + // Opaque cursor for the next page, if the server has more resource templates + NextCursor *string `json:"nextCursor,omitempty"` + // Resource templates advertised by the server (proxied MCP `resources/templates/list`) + ResourceTemplates []MCPResourceTemplate `json:"resourceTemplates"` +} + +// MCP server and resource URI to fetch. +// Experimental: MCPResourcesReadRequest is part of an experimental API and may change or be +// removed. +type MCPResourcesReadRequest struct { + // Name of the MCP server hosting the resource + ServerName string `json:"serverName"` + // Resource URI + URI string `json:"uri"` +} + +// Resource contents returned by the MCP server. +// Experimental: MCPResourcesReadResult is part of an experimental API and may change or be +// removed. +type MCPResourcesReadResult struct { + // Resource contents returned by the server + Contents []MCPResourceContent `json:"contents"` +} + +// An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, +// name, and optional title, description, MIME type, icons, annotations, and metadata. +// Server-provided fields outside the standard descriptor shape are exposed under +// `additionalProperties`. +// Experimental: MCPResourceTemplate is part of an experimental API and may change or be +// removed. +type MCPResourceTemplate struct { + // Server-provided non-standard descriptor fields preserved from the MCP response + AdditionalProperties map[string]any `json:"additionalProperties,omitzero"` + // Model/client annotations associated with this template + Annotations *MCPResourceAnnotations `json:"annotations,omitempty"` + // Optional description of what this template is for + Description *string `json:"description,omitempty"` + // Icons associated with resources matching this template + Icons []MCPResourceIcon `json:"icons,omitzero"` + // Resource-template-level metadata + Meta map[string]any `json:"_meta,omitzero"` + // MIME type for resources matching this template, if uniform + MIMEType *string `json:"mimeType,omitempty"` + // The programmatic name of the resource template + Name string `json:"name"` + // Optional human-readable display title + Title *string `json:"title,omitempty"` + // An RFC 6570 URI template for constructing resource URIs + URITemplate string `json:"uriTemplate"` +} + +// Server name and optional replacement configuration for an individual MCP server restart. +// Omit `config` for a config-free restart-by-name of an already-configured server. +// Experimental: MCPRestartServerRequest is part of an experimental API and may change or be +// removed. +type MCPRestartServerRequest struct { + // Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart + // the server with its already-registered configuration (config-free restart-by-name). + Config MCPServerConfig `json:"config,omitempty"` + // Name of the MCP server to restart + ServerName string `json:"serverName"` +} + +// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +// Experimental: MCPSamplingExecutionResult is part of an experimental API and may change or // be removed. -type McpSamplingExecutionResult struct { +type MCPSamplingExecutionResult struct { // Outcome of the sampling inference. 'success' produced a response; 'failure' encountered // an error (including agent-side rejection by content filter or criteria); 'cancelled' the // caller cancelled this execution via cancelSamplingExecution. - Action McpSamplingExecutionAction `json:"action"` + Action MCPSamplingExecutionAction `json:"action"` // Error description, present when action='failure'. Error *string `json:"error,omitempty"` // MCP CreateMessageResult payload (with optional 'tools' extension), present when // action='success'. Treated as opaque at the schema layer; consumers should // construct/consume it per the MCP CreateMessageResult shape. - Result *McpExecuteSamplingResult `json:"result,omitempty"` + Result *MCPExecuteSamplingResult `json:"result,omitempty"` } -// Schema for the `McpServer` type. -// Experimental: McpServer is part of an experimental API and may change or be removed. -type McpServer struct { +// MCP server status entry, including config source/plugin source and any connection error. +// Experimental: MCPServer is part of an experimental API and may change or be removed. +type MCPServer struct { // Error message if the server failed to connect Error *string `json:"error,omitempty"` // Server name (config key) Name string `json:"name"` // Configuration source: user, workspace, plugin, or builtin - Source *McpServerSource `json:"source,omitempty"` - // Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - Status McpServerStatus `json:"status"` + Source *MCPServerSource `json:"source,omitempty"` + // Plugin name that provided this server, when source is plugin. + SourcePlugin *string `json:"sourcePlugin,omitempty"` + // Plugin version that provided this server, when source is plugin. + SourcePluginVersion *string `json:"sourcePluginVersion,omitempty"` + // Connection status: connected, failed, needs-auth, pending, disabled, stopped, or + // not_configured + Status MCPServerStatus `json:"status"` } // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. -type McpServerAuthConfig interface { +// Experimental: MCPServerAuthConfig is part of an experimental API and may change or be +// removed. +type MCPServerAuthConfig interface { mcpServerAuthConfig() } -type McpServerAuthConfigBoolean bool +type MCPServerAuthConfigBoolean bool -func (McpServerAuthConfigBoolean) mcpServerAuthConfig() {} +func (MCPServerAuthConfigBoolean) mcpServerAuthConfig() {} -func (McpServerAuthConfigRedirectPort) mcpServerAuthConfig() {} +func (MCPServerAuthConfigRedirectPort) mcpServerAuthConfig() {} // Authentication settings with optional redirect port configuration. -type McpServerAuthConfigRedirectPort struct { +// Experimental: MCPServerAuthConfigRedirectPort is part of an experimental API and may +// change or be removed. +type MCPServerAuthConfigRedirectPort struct { // Fixed port for the OAuth redirect callback server. RedirectPort *int32 `json:"redirectPort,omitempty"` } // MCP server configuration (stdio process or remote HTTP/SSE) -type McpServerConfig interface { +// Experimental: MCPServerConfig is part of an experimental API and may change or be removed. +type MCPServerConfig interface { mcpServerConfig() } -type RawMcpServerConfigData struct { +type RawMCPServerConfigData struct { Raw json.RawMessage } -func (RawMcpServerConfigData) mcpServerConfig() {} +func (RawMCPServerConfigData) mcpServerConfig() {} // Remote MCP server configuration accessed over HTTP or SSE. -type McpServerConfigHTTP struct { +// Experimental: MCPServerConfigHTTP is part of an experimental API and may change or be +// removed. +type MCPServerConfigHTTP struct { // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - Auth McpServerAuthConfig `json:"auth,omitempty"` + Auth MCPServerAuthConfig `json:"auth,omitempty"` + // Controls if tools provided by this server can be loaded on demand via tool search (auto) + // or always included in the initial tool list (never) + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + // Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + // is unaffected. + DisableToolCache *bool `json:"disableToolCache,omitempty"` // Content filtering mode to apply to all tools, or a map of tool name to content filtering // mode. FilterMapping FilterMapping `json:"filterMapping,omitempty"` // HTTP headers to include in requests to the remote MCP server. - Headers map[string]string `json:"headers,omitempty"` + Headers map[string]string `json:"headers,omitzero"` // Whether this server is a built-in fallback used when the user has not configured their // own server. IsDefaultServer *bool `json:"isDefaultServer,omitempty"` // OAuth client ID for a pre-registered remote MCP OAuth client. OauthClientID *string `json:"oauthClientId,omitempty"` // OAuth grant type to use when authenticating to the remote MCP server. - OauthGrantType *McpServerConfigHTTPOauthGrantType `json:"oauthGrantType,omitempty"` + OauthGrantType *MCPServerConfigHTTPOauthGrantType `json:"oauthGrantType,omitempty"` // Whether the configured OAuth client is public and does not require a client secret. OauthPublicClient *bool `json:"oauthPublicClient,omitempty"` // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - Oidc McpServerAuthConfig `json:"oidc,omitempty"` + Oidc MCPServerAuthConfig `json:"oidc,omitempty"` // Timeout in milliseconds for tool calls to this server. Timeout *int64 `json:"timeout,omitempty"` // Tools to include. Defaults to all tools if not specified. - Tools []string `json:"tools,omitempty"` + Tools []string `json:"tools,omitzero"` // Remote transport type. Defaults to "http" when omitted. - Type *McpServerConfigHTTPType `json:"type,omitempty"` + Type *MCPServerConfigHTTPType `json:"type,omitempty"` // URL of the remote MCP server endpoint. URL string `json:"url"` } -func (McpServerConfigHTTP) mcpServerConfig() {} +func (MCPServerConfigHTTP) mcpServerConfig() {} // Stdio MCP server configuration launched as a child process. -type McpServerConfigStdio struct { +// Experimental: MCPServerConfigStdio is part of an experimental API and may change or be +// removed. +type MCPServerConfigStdio struct { // Command-line arguments passed to the Stdio MCP server process. - Args []string `json:"args,omitempty"` + Args []string `json:"args,omitzero"` // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - Auth McpServerAuthConfig `json:"auth,omitempty"` + Auth MCPServerAuthConfig `json:"auth,omitempty"` // Executable command used to start the Stdio MCP server process. Command string `json:"command"` // Working directory for the Stdio MCP server process. Cwd *string `json:"cwd,omitempty"` + // Controls if tools provided by this server can be loaded on demand via tool search (auto) + // or always included in the initial tool list (never) + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + // Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + // is unaffected. + DisableToolCache *bool `json:"disableToolCache,omitempty"` // Environment variables to pass to the Stdio MCP server process. - Env map[string]string `json:"env,omitempty"` + Env map[string]string `json:"env,omitzero"` // Content filtering mode to apply to all tools, or a map of tool name to content filtering // mode. FilterMapping FilterMapping `json:"filterMapping,omitempty"` @@ -2108,40 +4881,158 @@ type McpServerConfigStdio struct { // own server. IsDefaultServer *bool `json:"isDefaultServer,omitempty"` // Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - Oidc McpServerAuthConfig `json:"oidc,omitempty"` + Oidc MCPServerAuthConfig `json:"oidc,omitempty"` // Timeout in milliseconds for tool calls to this server. Timeout *int64 `json:"timeout,omitempty"` // Tools to include. Defaults to all tools if not specified. - Tools []string `json:"tools,omitempty"` + Tools []string `json:"tools,omitzero"` } -func (McpServerConfigStdio) mcpServerConfig() {} +func (MCPServerConfigStdio) mcpServerConfig() {} -// MCP servers configured for the session, with their connection status. -// Experimental: McpServerList is part of an experimental API and may change or be removed. -type McpServerList struct { +// Recorded MCP server connection failure. +// Experimental: MCPServerFailureInfo is part of an experimental API and may change or be +// removed. +type MCPServerFailureInfo struct { + // Failure message produced when the MCP server connection failed. + Message string `json:"message"` + // epoch-ms timestamp at which the failure was recorded. + Timestamp int64 `json:"timestamp"` +} + +// MCP servers configured for the session, with their connection status and host-level state. +// Experimental: MCPServerList is part of an experimental API and may change or be removed. +type MCPServerList struct { + // Host-level state, omitted when no MCP host is initialized. + Host *MCPHostState `json:"host,omitempty"` // Configured MCP servers - Servers []McpServer `json:"servers"` + Servers []MCPServer `json:"servers"` +} + +// Recorded MCP server pending-auth state. +// Experimental: MCPServerNeedsAuthInfo is part of an experimental API and may change or be +// removed. +type MCPServerNeedsAuthInfo struct { + // epoch-ms timestamp at which the server signalled it needs authentication. + Timestamp int64 `json:"timestamp"` } // Mode controlling how MCP server env values are resolved (`direct` or `indirect`). -// Experimental: McpSetEnvValueModeParams is part of an experimental API and may change or +// Experimental: MCPSetEnvValueModeParams is part of an experimental API and may change or // be removed. -type McpSetEnvValueModeParams struct { +type MCPSetEnvValueModeParams struct { // How environment-variable values supplied to MCP servers are resolved. "direct" passes // literal string values; "indirect" treats values as references (e.g. names of environment // variables on the host) that the runtime resolves before launch. Defaults to the runtime's // startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI // prompt mode and ACP) set this to "direct". - Mode McpSetEnvValueModeDetails `json:"mode"` + Mode MCPSetEnvValueModeDetails `json:"mode"` } // Env-value mode recorded on the session after the update. -// Experimental: McpSetEnvValueModeResult is part of an experimental API and may change or +// Experimental: MCPSetEnvValueModeResult is part of an experimental API and may change or // be removed. -type McpSetEnvValueModeResult struct { +type MCPSetEnvValueModeResult struct { // Mode recorded on the session after the update - Mode McpSetEnvValueModeDetails `json:"mode"` + Mode MCPSetEnvValueModeDetails `json:"mode"` +} + +// Server name and optional configuration for an individual MCP server start. Omit `config` +// for a config-free start-by-name of an already-configured server. +// Experimental: MCPStartServerRequest is part of an experimental API and may change or be +// removed. +type MCPStartServerRequest struct { + // MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server + // with its already-registered configuration (config-free start-by-name). + Config MCPServerConfig `json:"config,omitempty"` + // Name of the MCP server to start + ServerName string `json:"serverName"` +} + +// MCP server startup filtering result. +// Experimental: MCPStartServersResult is part of an experimental API and may change or be +// removed. +type MCPStartServersResult struct { + // Non-default servers allowed by policy + AllowedServers []MCPAllowedServer `json:"allowedServers,omitzero"` + // Servers filtered out before startup + FilteredServers []MCPFilteredServer `json:"filteredServers"` +} + +// Server name for an individual MCP server stop. +// Experimental: MCPStopServerRequest is part of an experimental API and may change or be +// removed. +type MCPStopServerRequest struct { + // Name of the MCP server to stop + ServerName string `json:"serverName"` +} + +// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery +// metadata. +// Experimental: MCPTools is part of an experimental API and may change or be removed. +type MCPTools struct { + // Tool description, when provided. + Description *string `json:"description,omitempty"` + // Tool name. + Name string `json:"name"` + // Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` + // block was present without recognized fields. + UI *MCPToolUI `json:"ui,omitempty"` +} + +// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. +// Experimental: MCPToolUI is part of an experimental API and may change or be removed. +type MCPToolUI struct { + // URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use + // `session.mcp.resources.read` to fetch its HTML and resource metadata. + ResourceURI *string `json:"resourceUri,omitempty"` + // Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + Visibility []MCPToolUIVisibility `json:"visibility,omitzero"` +} + +// Server name identifying the external client to remove. +// Experimental: MCPUnregisterExternalClientRequest is part of an experimental API and may +// change or be removed. +type MCPUnregisterExternalClientRequest struct { + // Server name of the external client to unregister + ServerName string `json:"serverName"` +} + +// Memory configuration for this session. +// Experimental: MemoryConfiguration is part of an experimental API and may change or be +// removed. +type MemoryConfiguration struct { + // Whether memory is enabled for the session. + Enabled bool `json:"enabled"` +} + +// Per-source attribution breakdown for the session's current context window, or null if +// uninitialized. +// Experimental: MetadataContextAttributionResult is part of an experimental API and may +// change or be removed. +type MetadataContextAttributionResult struct { + // Per-source context-window attribution, or null if the session has not yet been + // initialized (no system prompt or tool metadata cached). + ContextAttribution *SessionContextAttribution `json:"contextAttribution,omitempty"` +} + +// Parameters for the heaviest-messages query. +// Experimental: MetadataContextHeaviestMessagesRequest is part of an experimental API and +// may change or be removed. +type MetadataContextHeaviestMessagesRequest struct { + // Maximum number of messages to return, most-expensive first. Omit for the server default. + Limit *int64 `json:"limit,omitempty"` +} + +// The heaviest individual messages in the session's context window, most-expensive first. +// Experimental: MetadataContextHeaviestMessagesResult is part of an experimental API and +// may change or be removed. +type MetadataContextHeaviestMessagesResult struct { + // Heaviest messages, most-expensive first. + Messages []ContextHeaviestMessage `json:"messages"` + // Total token count of the current context window, so callers can compute each message's + // share without a second call. + TotalTokens int64 `json:"totalTokens"` } // Model identifier and token limits used to compute the context-info breakdown. @@ -2214,13 +5105,19 @@ type MetadataRecordContextChangeRequest struct { // Notify the session that its working directory context has changed. Emits a // `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline // UI) can react. Use this when the host has detected a cwd/branch/repo change outside the -// session's normal lifecycle (e.g., after a shell command in interactive mode). +// session's normal lifecycle (e.g., after a shell command in interactive mode). For a local +// session, a report whose `cwd` diverges from the session's current working directory is +// ignored (the call still succeeds but records nothing and emits no event); move a local +// session's working directory via `metadata.setWorkingDirectory` instead. // Experimental: MetadataRecordContextChangeResult is part of an experimental API and may // change or be removed. type MetadataRecordContextChangeResult struct { } -// Absolute path to set as the session's new working directory. +// Absolute path to set as the session's new working directory. For local sessions the path +// must be absolute and exist on disk: it is validated before any session state changes, and +// a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote +// sessions record the path as-is. // Experimental: MetadataSetWorkingDirectoryRequest is part of an experimental API and may // change or be removed. type MetadataSetWorkingDirectoryRequest struct { @@ -2231,9 +5128,13 @@ type MetadataSetWorkingDirectoryRequest struct { } // Update the session's working directory. Used by the host when the user explicitly changes -// cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any -// related side-effects (file index, etc.); this method only updates the session's own -// recorded path. +// cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects +// (file index, etc.); it does NOT change the process working directory (a session's cwd is +// per-session, not process-global). For local sessions the runtime validates the target +// first (an absolute path that exists on disk) and re-bases the permission primary +// directory; a rejected validation fails the call before anything is mutated, persisted, or +// emitted. Location-scoped permission rules are then re-keyed to the new directory +// (best-effort). Remote sessions only record the path. // Experimental: MetadataSetWorkingDirectoryResult is part of an experimental API and may // change or be removed. type MetadataSetWorkingDirectoryResult struct { @@ -2270,14 +5171,14 @@ type MetadataSnapshotRemoteMetadataRepository struct { Owner string `json:"owner"` } -// Schema for the `Model` type. +// Copilot model metadata, including identifier, display name, capabilities, policy, +// billing, reasoning efforts, and picker categories. +// Experimental: Model is part of an experimental API and may change or be removed. type Model struct { // Billing information Billing *ModelBilling `json:"billing,omitempty"` // Model capabilities and limits Capabilities ModelCapabilities `json:"capabilities"` - // Default reasoning effort level (only present if model supports reasoning effort) - DefaultReasoningEffort *string `json:"defaultReasoningEffort,omitempty"` // Model identifier (e.g., "claude-sonnet-4.5") ID string `json:"id"` // Model capability category for grouping in the model picker @@ -2289,46 +5190,97 @@ type Model struct { // Policy state (if applicable) Policy *ModelPolicy `json:"policy,omitempty"` // Supported reasoning effort levels (only present if model supports reasoning effort) - SupportedReasoningEfforts []string `json:"supportedReasoningEfforts,omitempty"` + SupportedReasoningEfforts []string `json:"supportedReasoningEfforts,omitzero"` } // Billing information +// Experimental: ModelBilling is part of an experimental API and may change or be removed. type ModelBilling struct { + // Whole-number percentage discount (0-100) applied to usage billed through this model. + // Populated for the synthetic `auto` model, where requests routed by auto-mode are billed + // at a reduced rate; absent for concrete models. + DiscountPercent *int32 `json:"discountPercent,omitempty"` // Billing cost multiplier relative to the base rate Multiplier *float64 `json:"multiplier,omitempty"` + // Active server-driven promotion for this model, if any. Present when the model is being + // promoted with a discount, which may be time-boxed or open-ended. + Promo *ModelBillingPromo `json:"promo,omitempty"` // Token-level pricing information for this model TokenPrices *ModelBillingTokenPrices `json:"tokenPrices,omitempty"` } +// Active server-driven promotion for a model, including its discount and optional expiry. +// Experimental: ModelBillingPromo is part of an experimental API and may change or be +// removed. +type ModelBillingPromo struct { + // Percentage discount (0-100) applied while the promotion is active. May be fractional. + DiscountPercent *float64 `json:"discountPercent,omitempty"` + // UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion + // omits this field. When present, the API only surfaces a promo whose expiry parses and is + // in the future, so consumers should treat a past value as expired. + EndsAt *string `json:"endsAt,omitempty"` + // Stable identifier for the promotion campaign. + ID *string `json:"id,omitempty"` + // Human-readable promotion message. Does not include the expiry timestamp; consumers may + // format endsAt and append it when present. + Message *string `json:"message,omitempty"` +} + // Token-level pricing information for this model +// Experimental: ModelBillingTokenPrices is part of an experimental API and may change or be +// removed. type ModelBillingTokenPrices struct { // Number of tokens per standard billing batch BatchSize *int64 `json:"batchSize,omitempty"` - // AI Credits cost per billing batch of cached tokens + // Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + // Deprecated: CachePrice is deprecated. CachePrice *float64 `json:"cachePrice,omitempty"` - // Maximum context window tokens for the default tier + // AI Credits cost per billing batch of cached (read) tokens + CacheReadPrice *float64 `json:"cacheReadPrice,omitempty"` + // AI Credits cost per billing batch of cache-write (cache creation) tokens. + CacheWritePrice *float64 `json:"cacheWritePrice,omitempty"` + // Use maxPromptTokens instead. Prompt token budget for the default tier. The total context + // window is this value plus the model's max_output_tokens. + // Deprecated: ContextMax is deprecated. ContextMax *int64 `json:"contextMax,omitempty"` // AI Credits cost per billing batch of input tokens InputPrice *float64 `json:"inputPrice,omitempty"` // Long context tier pricing (available for models with extended context windows) LongContext *ModelBillingTokenPricesLongContext `json:"longContext,omitempty"` + // Prompt token budget for the default tier. The total context window is this value plus the + // model's max_output_tokens. + MaxPromptTokens *int64 `json:"maxPromptTokens,omitempty"` // AI Credits cost per billing batch of output tokens OutputPrice *float64 `json:"outputPrice,omitempty"` } // Long context tier pricing (available for models with extended context windows) +// Experimental: ModelBillingTokenPricesLongContext is part of an experimental API and may +// change or be removed. type ModelBillingTokenPricesLongContext struct { - // AI Credits cost per billing batch of cached tokens + // Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + // Deprecated: CachePrice is deprecated. CachePrice *float64 `json:"cachePrice,omitempty"` - // Maximum context window tokens for the long context tier + // AI Credits cost per billing batch of cached (read) tokens + CacheReadPrice *float64 `json:"cacheReadPrice,omitempty"` + // AI Credits cost per billing batch of cache-write (cache creation) tokens. + CacheWritePrice *float64 `json:"cacheWritePrice,omitempty"` + // Use maxPromptTokens instead. Prompt token budget for the long context tier. The total + // context window is this value plus the model's max_output_tokens. + // Deprecated: ContextMax is deprecated. ContextMax *int64 `json:"contextMax,omitempty"` // AI Credits cost per billing batch of input tokens InputPrice *float64 `json:"inputPrice,omitempty"` + // Prompt token budget for the long context tier. The total context window is this value + // plus the model's max_output_tokens. + MaxPromptTokens *int64 `json:"maxPromptTokens,omitempty"` // AI Credits cost per billing batch of output tokens OutputPrice *float64 `json:"outputPrice,omitempty"` } // Model capabilities and limits +// Experimental: ModelCapabilities is part of an experimental API and may change or be +// removed. type ModelCapabilities struct { // Token limits for prompts, outputs, and context window Limits *ModelCapabilitiesLimits `json:"limits,omitempty"` @@ -2337,6 +5289,8 @@ type ModelCapabilities struct { } // Token limits for prompts, outputs, and context window +// Experimental: ModelCapabilitiesLimits is part of an experimental API and may change or be +// removed. type ModelCapabilitiesLimits struct { // Maximum total context window size in tokens MaxContextWindowTokens *int64 `json:"max_context_window_tokens,omitempty"` @@ -2349,6 +5303,8 @@ type ModelCapabilitiesLimits struct { } // Vision-specific limits +// Experimental: ModelCapabilitiesLimitsVision is part of an experimental API and may change +// or be removed. type ModelCapabilitiesLimitsVision struct { // Maximum number of images per prompt MaxPromptImages int64 `json:"max_prompt_images"` @@ -2358,7 +5314,7 @@ type ModelCapabilitiesLimitsVision struct { SupportedMediaTypes []string `json:"supported_media_types"` } -// Override individual model capabilities resolved by the runtime +// Optional capability overrides (vision, tool_calls, reasoning, etc.). // Experimental: ModelCapabilitiesOverride is part of an experimental API and may change or // be removed. type ModelCapabilitiesOverride struct { @@ -2391,13 +5347,16 @@ type ModelCapabilitiesOverrideLimitsVision struct { // Maximum image size in bytes MaxPromptImageSize *int64 `json:"max_prompt_image_size,omitempty"` // MIME types the model accepts - SupportedMediaTypes []string `json:"supported_media_types,omitempty"` + SupportedMediaTypes []string `json:"supported_media_types,omitzero"` } // Feature flags indicating what the model supports // Experimental: ModelCapabilitiesOverrideSupports is part of an experimental API and may // change or be removed. type ModelCapabilitiesOverrideSupports struct { + // Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. + // 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + AdaptiveThinking *AdaptiveThinkingSupport `json:"adaptive_thinking,omitempty"` // Whether this model supports reasoning effort configuration ReasoningEffort *bool `json:"reasoningEffort,omitempty"` // Whether this model supports vision/image input @@ -2405,7 +5364,12 @@ type ModelCapabilitiesOverrideSupports struct { } // Feature flags indicating what the model supports +// Experimental: ModelCapabilitiesSupports is part of an experimental API and may change or +// be removed. type ModelCapabilitiesSupports struct { + // Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. + // 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + AdaptiveThinking *AdaptiveThinkingSupport `json:"adaptive_thinking,omitempty"` // Whether this model supports reasoning effort configuration ReasoningEffort *bool `json:"reasoningEffort,omitempty"` // Whether this model supports vision/image input @@ -2414,20 +5378,19 @@ type ModelCapabilitiesSupports struct { // List of Copilot models available to the resolved user, including capabilities and billing // metadata. +// Experimental: ModelList is part of an experimental API and may change or be removed. type ModelList struct { // List of available models with full metadata Models []Model `json:"models"` } -// Optional listing options. -// Experimental: ModelListRequest is part of an experimental API and may change or be -// removed. type ModelListRequest struct { // If true, bypasses the per-session model list cache and re-fetches from CAPI. SkipCache *bool `json:"skipCache,omitempty"` } // Policy state (if applicable) +// Experimental: ModelPolicy is part of an experimental API and may change or be removed. type ModelPolicy struct { // Current policy state for this model State ModelPolicyState `json:"state"` @@ -2454,6 +5417,8 @@ type ModelSetReasoningEffortResult struct { ReasoningEffort string `json:"reasoningEffort"` } +// Experimental: ModelsListRequest is part of an experimental API and may change or be +// removed. type ModelsListRequest struct { // 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. @@ -2465,24 +5430,40 @@ type ModelsListRequest struct { // Experimental: ModelSwitchToRequest is part of an experimental API and may change or be // removed. type ModelSwitchToRequest struct { - // Explicit context tier for the selected model. `"default"` / `"long_context"` pin the - // tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier - // untouched. - ContextTier *ModelSwitchToRequestContextTier `json:"contextTier,omitempty"` + // Explicit context tier for the selected model. `"default"` / `"long_context"` apply the + // requested tier; omit this field to use normal model behavior with no explicit tier. + ContextTier *ContextTier `json:"contextTier,omitempty"` + // When true, defer this switch (enqueue it) if another model change is already queued, even + // when no turn is active — so it drains last (FIFO) and wins over the already-queued + // change. Intended for genuine user-initiated model selections; internal restore/reapply + // switches omit it and apply immediately when no turn is active. When no other model change + // is queued this has no effect (a switch still applies immediately unless a turn is active). + DeferIfModelChangeQueued *bool `json:"deferIfModelChangeQueued,omitempty"` // Override individual model capabilities resolved by the runtime ModelCapabilities *ModelCapabilitiesOverride `json:"modelCapabilities,omitempty"` - // Model identifier to switch to + // Model selection id to switch to, as returned by `list`. A bare id (e.g. + // `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id + // (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. ModelID string `json:"modelId"` - // Reasoning effort level to use for the model. "none" disables reasoning. + // Reasoning effort level to use for the model. CAPI values are model-defined and validated + // against the selected model; BYOK providers may define additional values. "none" disables + // reasoning. When omitted, no effort override is applied. ReasoningEffort *string `json:"reasoningEffort,omitempty"` // Reasoning summary mode to request for supported model clients ReasoningSummary *ReasoningSummary `json:"reasoningSummary,omitempty"` + // Output verbosity level to request for supported models + Verbosity *Verbosity `json:"verbosity,omitempty"` } // The model identifier active on the session after the switch. // Experimental: ModelSwitchToResult is part of an experimental API and may change or be // removed. type ModelSwitchToResult struct { + // True when the switch was deferred (enqueued as a cancellable `/model` command) because a + // turn was active or another model change was already queued, rather than applied + // immediately. When true, the session's live model is unchanged until the queued change + // drains. + Deferred *bool `json:"deferred,omitempty"` // Currently active model identifier after the switch ModelID *string `json:"modelId,omitempty"` } @@ -2494,6 +5475,42 @@ type ModeSetRequest struct { Mode SessionMode `json:"mode"` } +// A named BYOK provider connection (transport + credentials). +// Experimental: NamedProviderConfig is part of an experimental API and may change or be +// removed. +type NamedProviderConfig struct { + // API key. Optional for local providers like Ollama. + APIKey *string `json:"apiKey,omitempty"` + // Azure-specific provider options. + Azure *ProviderConfigAzure `json:"azure,omitempty"` + // API endpoint URL. + BaseURL string `json:"baseUrl"` + // Bearer token for authentication. Sets the Authorization header directly. Takes precedence + // over apiKey when both are set. + BearerToken *string `json:"bearerToken,omitempty"` + // When true, the SDK client supplies bearer tokens on demand: the runtime calls the + // client-session `providerToken.getToken` callback before each request and applies the + // returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth + // scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens + // (including Anthropic's), not a provider-specific API-key header such as Anthropic's + // `x-api-key`. The token-acquiring function itself stays on the SDK side and is never + // serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, + // the callback takes precedence: the runtime applies the token returned by + // `providerToken.getToken` as the `Authorization: Bearer` header for each request and does + // not send the static credential. + HasBearerTokenProvider *bool `json:"hasBearerTokenProvider,omitempty"` + // Custom HTTP headers to include in all outbound requests to the provider. + Headers map[string]string `json:"headers,omitzero"` + // Stable identifier referenced by BYOK model definitions. Must not contain '/'. + Name string `json:"name"` + // Provider transport. Defaults to "http". + Transport *ProviderConfigTransport `json:"transport,omitempty"` + // Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + Type *ProviderConfigType `json:"type,omitempty"` + // Wire API format (openai/azure only). Defaults to "completions". + WireAPI *ProviderConfigWireAPI `json:"wireApi,omitempty"` +} + // The session's friendly name, or null when not yet set. // Experimental: NameGetResult is part of an experimental API and may change or be removed. type NameGetResult struct { @@ -2531,20 +5548,18 @@ type NameSetRequest struct { // Experimental: OpenCanvasInstance is part of an experimental API and may change or be // removed. type OpenCanvasInstance struct { - // Runtime-controlled routing state for an open canvas instance. - Availability CanvasInstanceAvailability `json:"availability"` // Provider-local canvas identifier CanvasID string `json:"canvasId"` // Owning provider identifier ExtensionID string `json:"extensionId"` // Owning extension display name, when available ExtensionName *string `json:"extensionName,omitempty"` + // Host-local PNG path for the canvas icon, when supplied + Icon *string `json:"icon,omitempty"` // Input supplied when the instance was opened Input any `json:"input,omitempty"` // Stable caller-supplied canvas instance identifier InstanceID string `json:"instanceId"` - // Whether this snapshot came from an idempotent reopen - Reopen bool `json:"reopen"` // Provider-supplied status text Status *string `json:"status,omitempty"` // Rendered title @@ -2553,7 +5568,41 @@ type OpenCanvasInstance struct { URL *string `json:"url,omitempty"` } -// Schema for the `PendingPermissionRequest` type. +// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated +// data, and scope. +// Experimental: OptionsUpdateAdditionalContentExclusionPolicy is part of an experimental +// API and may change or be removed. +type OptionsUpdateAdditionalContentExclusionPolicy struct { + LastUpdatedAt any `json:"last_updated_at"` + Rules []OptionsUpdateAdditionalContentExclusionPolicyRule `json:"rules"` + // Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + Scope OptionsUpdateAdditionalContentExclusionPolicyScope `json:"scope"` +} + +// Single content-exclusion rule supplied to `session.options.update`, with paths, match +// conditions, and source. +// Experimental: OptionsUpdateAdditionalContentExclusionPolicyRule is part of an +// experimental API and may change or be removed. +type OptionsUpdateAdditionalContentExclusionPolicyRule struct { + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + IfNoneMatch []string `json:"ifNoneMatch,omitzero"` + Paths []string `json:"paths"` + // Source descriptor for a `session.options.update` content-exclusion rule, with source name + // and type. + Source OptionsUpdateAdditionalContentExclusionPolicyRuleSource `json:"source"` +} + +// Source descriptor for a `session.options.update` content-exclusion rule, with source name +// and type. +// Experimental: OptionsUpdateAdditionalContentExclusionPolicyRuleSource is part of an +// experimental API and may change or be removed. +type OptionsUpdateAdditionalContentExclusionPolicyRuleSource struct { + Name string `json:"name"` + Type string `json:"type"` +} + +// Pending permission prompt reconstructed from event history, with request ID and +// user-facing prompt details. // Experimental: PendingPermissionRequest is part of an experimental API and may change or // be removed. type PendingPermissionRequest struct { @@ -2593,7 +5642,7 @@ func (r RawPermissionDecisionData) Kind() PermissionDecisionKind { return r.Discriminator } -// Schema for the `PermissionDecisionApproved` type. +// Permission-decision variant indicating the request was approved. // Experimental: PermissionDecisionApproved is part of an experimental API and may change or // be removed. type PermissionDecisionApproved struct { @@ -2604,7 +5653,8 @@ func (PermissionDecisionApproved) Kind() PermissionDecisionKind { return PermissionDecisionKindApproved } -// Schema for the `PermissionDecisionApprovedForLocation` type. +// Permission-decision variant indicating approval was persisted for a project location, +// with approval details and location key. // Experimental: PermissionDecisionApprovedForLocation is part of an experimental API and // may change or be removed. type PermissionDecisionApprovedForLocation struct { @@ -2619,7 +5669,8 @@ func (PermissionDecisionApprovedForLocation) Kind() PermissionDecisionKind { return PermissionDecisionKindApprovedForLocation } -// Schema for the `PermissionDecisionApprovedForSession` type. +// Permission-decision variant indicating approval was remembered for the session, with +// approval details. // Experimental: PermissionDecisionApprovedForSession is part of an experimental API and may // change or be removed. type PermissionDecisionApprovedForSession struct { @@ -2632,7 +5683,8 @@ func (PermissionDecisionApprovedForSession) Kind() PermissionDecisionKind { return PermissionDecisionKindApprovedForSession } -// Schema for the `PermissionDecisionApproveForLocation` type. +// Permission-decision request variant to approve and persist a permission for a project +// location, with approval details and location key. // Experimental: PermissionDecisionApproveForLocation is part of an experimental API and may // change or be removed. type PermissionDecisionApproveForLocation struct { @@ -2647,7 +5699,8 @@ func (PermissionDecisionApproveForLocation) Kind() PermissionDecisionKind { return PermissionDecisionKindApproveForLocation } -// Schema for the `PermissionDecisionApproveForSession` type. +// Permission-decision request variant to approve for the rest of the session, with optional +// tool approval or URL domain. // Experimental: PermissionDecisionApproveForSession is part of an experimental API and may // change or be removed. type PermissionDecisionApproveForSession struct { @@ -2662,10 +5715,12 @@ func (PermissionDecisionApproveForSession) Kind() PermissionDecisionKind { return PermissionDecisionKindApproveForSession } -// Schema for the `PermissionDecisionApproveOnce` type. +// Permission-decision request variant to approve only the current permission request. // Experimental: PermissionDecisionApproveOnce is part of an experimental API and may change // or be removed. type PermissionDecisionApproveOnce struct { + // True only when a host surfaced this request to a user who approved it. + ApprovedInteractively *bool `json:"approvedInteractively,omitempty"` } func (PermissionDecisionApproveOnce) permissionDecision() {} @@ -2673,7 +5728,7 @@ func (PermissionDecisionApproveOnce) Kind() PermissionDecisionKind { return PermissionDecisionKindApproveOnce } -// Schema for the `PermissionDecisionApprovePermanently` type. +// Permission-decision request variant to permanently approve a URL domain across sessions. // Experimental: PermissionDecisionApprovePermanently is part of an experimental API and may // change or be removed. type PermissionDecisionApprovePermanently struct { @@ -2686,7 +5741,8 @@ func (PermissionDecisionApprovePermanently) Kind() PermissionDecisionKind { return PermissionDecisionKindApprovePermanently } -// Schema for the `PermissionDecisionCancelled` type. +// Permission-decision variant indicating the request was cancelled before use, with an +// optional reason. // Experimental: PermissionDecisionCancelled is part of an experimental API and may change // or be removed. type PermissionDecisionCancelled struct { @@ -2699,7 +5755,8 @@ func (PermissionDecisionCancelled) Kind() PermissionDecisionKind { return PermissionDecisionKindCancelled } -// Schema for the `PermissionDecisionDeniedByContentExclusionPolicy` type. +// Permission-decision variant indicating denial by content-exclusion policy, with path and +// message. // Experimental: PermissionDecisionDeniedByContentExclusionPolicy is part of an experimental // API and may change or be removed. type PermissionDecisionDeniedByContentExclusionPolicy struct { @@ -2714,7 +5771,8 @@ func (PermissionDecisionDeniedByContentExclusionPolicy) Kind() PermissionDecisio return PermissionDecisionKindDeniedByContentExclusionPolicy } -// Schema for the `PermissionDecisionDeniedByPermissionRequestHook` type. +// Permission-decision variant indicating denial by a permission request hook, with optional +// message and interrupt flag. // Experimental: PermissionDecisionDeniedByPermissionRequestHook is part of an experimental // API and may change or be removed. type PermissionDecisionDeniedByPermissionRequestHook struct { @@ -2729,7 +5787,8 @@ func (PermissionDecisionDeniedByPermissionRequestHook) Kind() PermissionDecision return PermissionDecisionKindDeniedByPermissionRequestHook } -// Schema for the `PermissionDecisionDeniedByRules` type. +// Permission-decision variant indicating explicit denial by permission rules, with the +// matching rules. // Experimental: PermissionDecisionDeniedByRules is part of an experimental API and may // change or be removed. type PermissionDecisionDeniedByRules struct { @@ -2742,7 +5801,8 @@ func (PermissionDecisionDeniedByRules) Kind() PermissionDecisionKind { return PermissionDecisionKindDeniedByRules } -// Schema for the `PermissionDecisionDeniedInteractivelyByUser` type. +// Permission-decision variant indicating the user denied an interactive prompt, with +// optional feedback and force-reject flag. // Experimental: PermissionDecisionDeniedInteractivelyByUser is part of an experimental API // and may change or be removed. type PermissionDecisionDeniedInteractivelyByUser struct { @@ -2757,7 +5817,8 @@ func (PermissionDecisionDeniedInteractivelyByUser) Kind() PermissionDecisionKind return PermissionDecisionKindDeniedInteractivelyByUser } -// Schema for the `PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. +// Permission-decision variant indicating no approval rule matched and user confirmation was +// unavailable. // Experimental: PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser is part of // an experimental API and may change or be removed. type PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser struct { @@ -2768,7 +5829,8 @@ func (PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser) Kind() P return PermissionDecisionKindDeniedNoApprovalRuleAndCouldNotRequestFromUser } -// Schema for the `PermissionDecisionReject` type. +// Permission-decision request variant to reject a pending permission request, with optional +// feedback. // Experimental: PermissionDecisionReject is part of an experimental API and may change or // be removed. type PermissionDecisionReject struct { @@ -2781,7 +5843,7 @@ func (PermissionDecisionReject) Kind() PermissionDecisionKind { return PermissionDecisionKindReject } -// Schema for the `PermissionDecisionUserNotAvailable` type. +// Permission-decision variant indicating no user was available to confirm the request. // Experimental: PermissionDecisionUserNotAvailable is part of an experimental API and may // change or be removed. type PermissionDecisionUserNotAvailable struct { @@ -2811,7 +5873,7 @@ func (r RawPermissionDecisionApproveForLocationApprovalData) Kind() PermissionDe return r.Discriminator } -// Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type. +// Location-scoped approval details for specific command identifiers. // Experimental: PermissionDecisionApproveForLocationApprovalCommands is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalCommands struct { @@ -2825,7 +5887,7 @@ func (PermissionDecisionApproveForLocationApprovalCommands) Kind() PermissionDec return PermissionDecisionApproveForLocationApprovalKindCommands } -// Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type. +// Location-scoped approval details for a custom tool, keyed by tool name. // Experimental: PermissionDecisionApproveForLocationApprovalCustomTool is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalCustomTool struct { @@ -2839,7 +5901,8 @@ func (PermissionDecisionApproveForLocationApprovalCustomTool) Kind() PermissionD return PermissionDecisionApproveForLocationApprovalKindCustomTool } -// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type. +// Location-scoped approval details for extension-management operations, optionally narrowed +// by operation. // Experimental: PermissionDecisionApproveForLocationApprovalExtensionManagement is part of // an experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalExtensionManagement struct { @@ -2854,8 +5917,8 @@ func (PermissionDecisionApproveForLocationApprovalExtensionManagement) Kind() Pe return PermissionDecisionApproveForLocationApprovalKindExtensionManagement } -// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` -// type. +// Location-scoped approval details for an extension's permission-gated capability access, +// keyed by extension name. // Experimental: PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess is // part of an experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess struct { @@ -2869,37 +5932,53 @@ func (PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) Kin return PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess } -// Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type. -// Experimental: PermissionDecisionApproveForLocationApprovalMcp is part of an experimental +// Location-scoped factory approval, optionally narrowed by approval key. +// Experimental: PermissionDecisionApproveForLocationApprovalFactory is part of an +// experimental API and may change or be removed. +type PermissionDecisionApproveForLocationApprovalFactory struct { + // Optional factory operation name or canonical approval key; when omitted, the approval + // covers all factory operations. + ApprovalKey *string `json:"approvalKey,omitempty"` +} + +func (PermissionDecisionApproveForLocationApprovalFactory) permissionDecisionApproveForLocationApproval() { +} +func (PermissionDecisionApproveForLocationApprovalFactory) Kind() PermissionDecisionApproveForLocationApprovalKind { + return PermissionDecisionApproveForLocationApprovalKindFactory +} + +// Location-scoped approval details for an MCP server tool, or all tools on the server when +// `toolName` is null. +// Experimental: PermissionDecisionApproveForLocationApprovalMCP is part of an experimental // API and may change or be removed. -type PermissionDecisionApproveForLocationApprovalMcp struct { +type PermissionDecisionApproveForLocationApprovalMCP struct { // MCP server name. ServerName string `json:"serverName"` // MCP tool name, or null to cover every tool on the server. ToolName *string `json:"toolName"` } -func (PermissionDecisionApproveForLocationApprovalMcp) permissionDecisionApproveForLocationApproval() { +func (PermissionDecisionApproveForLocationApprovalMCP) permissionDecisionApproveForLocationApproval() { } -func (PermissionDecisionApproveForLocationApprovalMcp) Kind() PermissionDecisionApproveForLocationApprovalKind { - return PermissionDecisionApproveForLocationApprovalKindMcp +func (PermissionDecisionApproveForLocationApprovalMCP) Kind() PermissionDecisionApproveForLocationApprovalKind { + return PermissionDecisionApproveForLocationApprovalKindMCP } -// Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type. -// Experimental: PermissionDecisionApproveForLocationApprovalMcpSampling is part of an +// Location-scoped approval details for MCP sampling requests from a server. +// Experimental: PermissionDecisionApproveForLocationApprovalMCPSampling is part of an // experimental API and may change or be removed. -type PermissionDecisionApproveForLocationApprovalMcpSampling struct { +type PermissionDecisionApproveForLocationApprovalMCPSampling struct { // MCP server name. ServerName string `json:"serverName"` } -func (PermissionDecisionApproveForLocationApprovalMcpSampling) permissionDecisionApproveForLocationApproval() { +func (PermissionDecisionApproveForLocationApprovalMCPSampling) permissionDecisionApproveForLocationApproval() { } -func (PermissionDecisionApproveForLocationApprovalMcpSampling) Kind() PermissionDecisionApproveForLocationApprovalKind { - return PermissionDecisionApproveForLocationApprovalKindMcpSampling +func (PermissionDecisionApproveForLocationApprovalMCPSampling) Kind() PermissionDecisionApproveForLocationApprovalKind { + return PermissionDecisionApproveForLocationApprovalKindMCPSampling } -// Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type. +// Location-scoped approval details for writes to long-term memory. // Experimental: PermissionDecisionApproveForLocationApprovalMemory is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalMemory struct { @@ -2911,7 +5990,7 @@ func (PermissionDecisionApproveForLocationApprovalMemory) Kind() PermissionDecis return PermissionDecisionApproveForLocationApprovalKindMemory } -// Schema for the `PermissionDecisionApproveForLocationApprovalRead` type. +// Location-scoped approval details for read-only filesystem operations. // Experimental: PermissionDecisionApproveForLocationApprovalRead is part of an experimental // API and may change or be removed. type PermissionDecisionApproveForLocationApprovalRead struct { @@ -2923,7 +6002,7 @@ func (PermissionDecisionApproveForLocationApprovalRead) Kind() PermissionDecisio return PermissionDecisionApproveForLocationApprovalKindRead } -// Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type. +// Location-scoped approval details for filesystem write operations. // Experimental: PermissionDecisionApproveForLocationApprovalWrite is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForLocationApprovalWrite struct { @@ -2954,7 +6033,7 @@ func (r RawPermissionDecisionApproveForSessionApprovalData) Kind() PermissionDec return r.Discriminator } -// Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type. +// Session-scoped approval details for specific command identifiers. // Experimental: PermissionDecisionApproveForSessionApprovalCommands is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForSessionApprovalCommands struct { @@ -2968,7 +6047,7 @@ func (PermissionDecisionApproveForSessionApprovalCommands) Kind() PermissionDeci return PermissionDecisionApproveForSessionApprovalKindCommands } -// Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type. +// Session-scoped approval details for a custom tool, keyed by tool name. // Experimental: PermissionDecisionApproveForSessionApprovalCustomTool is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForSessionApprovalCustomTool struct { @@ -2982,7 +6061,8 @@ func (PermissionDecisionApproveForSessionApprovalCustomTool) Kind() PermissionDe return PermissionDecisionApproveForSessionApprovalKindCustomTool } -// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type. +// Session-scoped approval details for extension-management operations, optionally narrowed +// by operation. // Experimental: PermissionDecisionApproveForSessionApprovalExtensionManagement is part of // an experimental API and may change or be removed. type PermissionDecisionApproveForSessionApprovalExtensionManagement struct { @@ -2997,8 +6077,8 @@ func (PermissionDecisionApproveForSessionApprovalExtensionManagement) Kind() Per return PermissionDecisionApproveForSessionApprovalKindExtensionManagement } -// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` -// type. +// Session-scoped approval details for an extension's permission-gated capability access, +// keyed by extension name. // Experimental: PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess is // part of an experimental API and may change or be removed. type PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess struct { @@ -3012,36 +6092,52 @@ func (PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess) Kind return PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess } -// Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type. -// Experimental: PermissionDecisionApproveForSessionApprovalMcp is part of an experimental +// Session-scoped factory approval, optionally narrowed by approval key. +// Experimental: PermissionDecisionApproveForSessionApprovalFactory is part of an +// experimental API and may change or be removed. +type PermissionDecisionApproveForSessionApprovalFactory struct { + // Optional factory operation name or canonical approval key; when omitted, the approval + // covers all factory operations. + ApprovalKey *string `json:"approvalKey,omitempty"` +} + +func (PermissionDecisionApproveForSessionApprovalFactory) permissionDecisionApproveForSessionApproval() { +} +func (PermissionDecisionApproveForSessionApprovalFactory) Kind() PermissionDecisionApproveForSessionApprovalKind { + return PermissionDecisionApproveForSessionApprovalKindFactory +} + +// Session-scoped approval details for an MCP server tool, or all tools on the server when +// `toolName` is null. +// Experimental: PermissionDecisionApproveForSessionApprovalMCP is part of an experimental // API and may change or be removed. -type PermissionDecisionApproveForSessionApprovalMcp struct { +type PermissionDecisionApproveForSessionApprovalMCP struct { // MCP server name. ServerName string `json:"serverName"` // MCP tool name, or null to cover every tool on the server. ToolName *string `json:"toolName"` } -func (PermissionDecisionApproveForSessionApprovalMcp) permissionDecisionApproveForSessionApproval() {} -func (PermissionDecisionApproveForSessionApprovalMcp) Kind() PermissionDecisionApproveForSessionApprovalKind { - return PermissionDecisionApproveForSessionApprovalKindMcp +func (PermissionDecisionApproveForSessionApprovalMCP) permissionDecisionApproveForSessionApproval() {} +func (PermissionDecisionApproveForSessionApprovalMCP) Kind() PermissionDecisionApproveForSessionApprovalKind { + return PermissionDecisionApproveForSessionApprovalKindMCP } -// Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type. -// Experimental: PermissionDecisionApproveForSessionApprovalMcpSampling is part of an +// Session-scoped approval details for MCP sampling requests from a server. +// Experimental: PermissionDecisionApproveForSessionApprovalMCPSampling is part of an // experimental API and may change or be removed. -type PermissionDecisionApproveForSessionApprovalMcpSampling struct { +type PermissionDecisionApproveForSessionApprovalMCPSampling struct { // MCP server name. ServerName string `json:"serverName"` } -func (PermissionDecisionApproveForSessionApprovalMcpSampling) permissionDecisionApproveForSessionApproval() { +func (PermissionDecisionApproveForSessionApprovalMCPSampling) permissionDecisionApproveForSessionApproval() { } -func (PermissionDecisionApproveForSessionApprovalMcpSampling) Kind() PermissionDecisionApproveForSessionApprovalKind { - return PermissionDecisionApproveForSessionApprovalKindMcpSampling +func (PermissionDecisionApproveForSessionApprovalMCPSampling) Kind() PermissionDecisionApproveForSessionApprovalKind { + return PermissionDecisionApproveForSessionApprovalKindMCPSampling } -// Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type. +// Session-scoped approval details for writes to long-term memory. // Experimental: PermissionDecisionApproveForSessionApprovalMemory is part of an // experimental API and may change or be removed. type PermissionDecisionApproveForSessionApprovalMemory struct { @@ -3053,7 +6149,7 @@ func (PermissionDecisionApproveForSessionApprovalMemory) Kind() PermissionDecisi return PermissionDecisionApproveForSessionApprovalKindMemory } -// Schema for the `PermissionDecisionApproveForSessionApprovalRead` type. +// Session-scoped approval details for read-only filesystem operations. // Experimental: PermissionDecisionApproveForSessionApprovalRead is part of an experimental // API and may change or be removed. type PermissionDecisionApproveForSessionApprovalRead struct { @@ -3065,7 +6161,7 @@ func (PermissionDecisionApproveForSessionApprovalRead) Kind() PermissionDecision return PermissionDecisionApproveForSessionApprovalKindRead } -// Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type. +// Session-scoped approval details for filesystem write operations. // Experimental: PermissionDecisionApproveForSessionApprovalWrite is part of an experimental // API and may change or be removed. type PermissionDecisionApproveForSessionApprovalWrite struct { @@ -3077,10 +6173,26 @@ func (PermissionDecisionApproveForSessionApprovalWrite) Kind() PermissionDecisio return PermissionDecisionApproveForSessionApprovalKindWrite } +// Optional informational context describing how and where the permission decision was made. +// This does not affect permission behavior. +// Experimental: PermissionDecisionContext is part of an experimental API and may change or +// be removed. +type PermissionDecisionContext struct { + // Disposition of the permission request as observed by the responding client. + Outcome PermissionDecisionOutcome `json:"outcome"` + // Controlled reason or actor responsible for the response. + Source PermissionDecisionSource `json:"source"` + // Client surface that submitted the response. + Surface PermissionDecisionSurface `json:"surface"` +} + // Pending permission request ID and the decision to apply (approve/reject and scope). // Experimental: PermissionDecisionRequest is part of an experimental API and may change or // be removed. type PermissionDecisionRequest struct { + // Optional informational context describing how and where this response was made. Omit it + // to preserve legacy behavior without attributing an origin. + DecisionContext *PermissionDecisionContext `json:"decisionContext,omitempty"` // Request ID of the pending permission request RequestID string `json:"requestId"` // The client's response to the pending permission prompt @@ -3176,7 +6288,7 @@ type PermissionPathsConfig struct { // directory). When `unrestricted` is true, these are still pre-populated on the // UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention // completion). - AdditionalDirectories []string `json:"additionalDirectories,omitempty"` + AdditionalDirectories []string `json:"additionalDirectories,omitzero"` // Whether to include the system temp directory in the allowed list (defaults to true). // Ignored when `unrestricted` is true. IncludeTempDirectory *bool `json:"includeTempDirectory,omitempty"` @@ -3241,7 +6353,8 @@ type PermissionRequestResult struct { Success bool `json:"success"` } -// Schema for the `PermissionRule` type. +// A permission approval or denial rule matched against a tool request, identified by a rule +// kind with an optional argument value. // Experimental: PermissionRule is part of an experimental API and may change or be removed. type PermissionRule struct { // Argument value matched against the request, or null when the rule kind has no argument @@ -3262,7 +6375,8 @@ type PermissionRulesSet struct { Denied []PermissionRule `json:"denied"` } -// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type. +// Content-exclusion policy supplied to `session.permissions.configure`, with rules, +// last-updated data, and scope. // Experimental: PermissionsConfigureAdditionalContentExclusionPolicy is part of an // experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicy struct { @@ -3273,18 +6387,21 @@ type PermissionsConfigureAdditionalContentExclusionPolicy struct { Scope PermissionsConfigureAdditionalContentExclusionPolicyScope `json:"scope"` } -// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type. +// Single content-exclusion rule supplied to `session.permissions.configure`, with paths, +// match conditions, and source. // Experimental: PermissionsConfigureAdditionalContentExclusionPolicyRule is part of an // experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicyRule struct { - IfAnyMatch []string `json:"ifAnyMatch,omitempty"` - IfNoneMatch []string `json:"ifNoneMatch,omitempty"` + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + IfNoneMatch []string `json:"ifNoneMatch,omitzero"` Paths []string `json:"paths"` - // Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. + // Source descriptor for a `session.permissions.configure` content-exclusion rule, with + // source name and type. Source PermissionsConfigureAdditionalContentExclusionPolicyRuleSource `json:"source"` } -// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. +// Source descriptor for a `session.permissions.configure` content-exclusion rule, with +// source name and type. // Experimental: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource is part of // an experimental API and may change or be removed. type PermissionsConfigureAdditionalContentExclusionPolicyRuleSource struct { @@ -3299,7 +6416,7 @@ type PermissionsConfigureParams struct { // If specified, replaces the host-supplied GitHub Content Exclusion policies on the session // (combined with natively-discovered policies when evaluating tool/file access). Omit to // leave the current policies unchanged. - AdditionalContentExclusionPolicies []PermissionsConfigureAdditionalContentExclusionPolicy `json:"additionalContentExclusionPolicies,omitempty"` + AdditionalContentExclusionPolicies []PermissionsConfigureAdditionalContentExclusionPolicy `json:"additionalContentExclusionPolicies,omitzero"` // If specified, sets whether path/URL read permission requests are auto-approved. Omit to // leave the current value unchanged. ApproveAllReadPermissionRequests *bool `json:"approveAllReadPermissionRequests,omitempty"` @@ -3316,7 +6433,7 @@ type PermissionsConfigureParams struct { // If specified, replaces the session's URL-permission policy. The runtime constructs a // fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy // unchanged. - Urls *PermissionUrlsConfig `json:"urls,omitempty"` + URLs *PermissionURLsConfig `json:"urls,omitempty"` } // Indicates whether the operation succeeded. @@ -3360,7 +6477,7 @@ func (r RawPermissionsLocationsAddToolApprovalDetailsData) Kind() PermissionsLoc return r.Discriminator } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsCommands` type. +// Location-persisted tool approval details for specific command identifiers. // Experimental: PermissionsLocationsAddToolApprovalDetailsCommands is part of an // experimental API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsCommands struct { @@ -3374,7 +6491,7 @@ func (PermissionsLocationsAddToolApprovalDetailsCommands) Kind() PermissionsLoca return PermissionsLocationsAddToolApprovalDetailsKindCommands } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsCustomTool` type. +// Location-persisted tool approval details for a custom tool, keyed by tool name. // Experimental: PermissionsLocationsAddToolApprovalDetailsCustomTool is part of an // experimental API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsCustomTool struct { @@ -3388,7 +6505,8 @@ func (PermissionsLocationsAddToolApprovalDetailsCustomTool) Kind() PermissionsLo return PermissionsLocationsAddToolApprovalDetailsKindCustomTool } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionManagement` type. +// Location-persisted tool approval details for extension-management operations, optionally +// narrowed by operation. // Experimental: PermissionsLocationsAddToolApprovalDetailsExtensionManagement is part of an // experimental API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsExtensionManagement struct { @@ -3403,7 +6521,8 @@ func (PermissionsLocationsAddToolApprovalDetailsExtensionManagement) Kind() Perm return PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess` type. +// Location-persisted tool approval details for an extension's permission-gated capability +// access, keyed by extension name. // Experimental: PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess is part // of an experimental API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess struct { @@ -3417,36 +6536,52 @@ func (PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) Kind( return PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcp` type. -// Experimental: PermissionsLocationsAddToolApprovalDetailsMcp is part of an experimental +// Location-persisted factory approval, optionally narrowed by approval key. +// Experimental: PermissionsLocationsAddToolApprovalDetailsFactory is part of an +// experimental API and may change or be removed. +type PermissionsLocationsAddToolApprovalDetailsFactory struct { + // Optional factory operation name or canonical approval key; when omitted, the approval + // covers all factory operations. + ApprovalKey *string `json:"approvalKey,omitempty"` +} + +func (PermissionsLocationsAddToolApprovalDetailsFactory) permissionsLocationsAddToolApprovalDetails() { +} +func (PermissionsLocationsAddToolApprovalDetailsFactory) Kind() PermissionsLocationsAddToolApprovalDetailsKind { + return PermissionsLocationsAddToolApprovalDetailsKindFactory +} + +// Location-persisted tool approval details for an MCP server tool, or all tools when +// `toolName` is null. +// Experimental: PermissionsLocationsAddToolApprovalDetailsMCP is part of an experimental // API and may change or be removed. -type PermissionsLocationsAddToolApprovalDetailsMcp struct { +type PermissionsLocationsAddToolApprovalDetailsMCP struct { // MCP server name. ServerName string `json:"serverName"` // MCP tool name, or null to cover every tool on the server. ToolName *string `json:"toolName"` } -func (PermissionsLocationsAddToolApprovalDetailsMcp) permissionsLocationsAddToolApprovalDetails() {} -func (PermissionsLocationsAddToolApprovalDetailsMcp) Kind() PermissionsLocationsAddToolApprovalDetailsKind { - return PermissionsLocationsAddToolApprovalDetailsKindMcp +func (PermissionsLocationsAddToolApprovalDetailsMCP) permissionsLocationsAddToolApprovalDetails() {} +func (PermissionsLocationsAddToolApprovalDetailsMCP) Kind() PermissionsLocationsAddToolApprovalDetailsKind { + return PermissionsLocationsAddToolApprovalDetailsKindMCP } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcpSampling` type. -// Experimental: PermissionsLocationsAddToolApprovalDetailsMcpSampling is part of an +// Location-persisted tool approval details for MCP sampling requests from a server. +// Experimental: PermissionsLocationsAddToolApprovalDetailsMCPSampling is part of an // experimental API and may change or be removed. -type PermissionsLocationsAddToolApprovalDetailsMcpSampling struct { +type PermissionsLocationsAddToolApprovalDetailsMCPSampling struct { // MCP server name. ServerName string `json:"serverName"` } -func (PermissionsLocationsAddToolApprovalDetailsMcpSampling) permissionsLocationsAddToolApprovalDetails() { +func (PermissionsLocationsAddToolApprovalDetailsMCPSampling) permissionsLocationsAddToolApprovalDetails() { } -func (PermissionsLocationsAddToolApprovalDetailsMcpSampling) Kind() PermissionsLocationsAddToolApprovalDetailsKind { - return PermissionsLocationsAddToolApprovalDetailsKindMcpSampling +func (PermissionsLocationsAddToolApprovalDetailsMCPSampling) Kind() PermissionsLocationsAddToolApprovalDetailsKind { + return PermissionsLocationsAddToolApprovalDetailsKindMCPSampling } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsMemory` type. +// Location-persisted tool approval details for writes to long-term memory. // Experimental: PermissionsLocationsAddToolApprovalDetailsMemory is part of an experimental // API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsMemory struct { @@ -3458,7 +6593,7 @@ func (PermissionsLocationsAddToolApprovalDetailsMemory) Kind() PermissionsLocati return PermissionsLocationsAddToolApprovalDetailsKindMemory } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsRead` type. +// Location-persisted tool approval details for read-only filesystem operations. // Experimental: PermissionsLocationsAddToolApprovalDetailsRead is part of an experimental // API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsRead struct { @@ -3469,7 +6604,7 @@ func (PermissionsLocationsAddToolApprovalDetailsRead) Kind() PermissionsLocation return PermissionsLocationsAddToolApprovalDetailsKindRead } -// Schema for the `PermissionsLocationsAddToolApprovalDetailsWrite` type. +// Location-persisted tool approval details for filesystem write operations. // Experimental: PermissionsLocationsAddToolApprovalDetailsWrite is part of an experimental // API and may change or be removed. type PermissionsLocationsAddToolApprovalDetailsWrite struct { @@ -3494,9 +6629,9 @@ type PermissionsLocationsAddToolApprovalResult struct { // or be removed. type PermissionsModifyRulesParams struct { // Rules to add to the scope. Applied before `remove`/`removeAll`. - Add []PermissionRule `json:"add,omitempty"` + Add []PermissionRule `json:"add,omitzero"` // Specific rules to remove from the scope. Ignored when `removeAll` is true. - Remove []PermissionRule `json:"remove,omitempty"` + Remove []PermissionRule `json:"remove,omitzero"` // When true, removes every rule currently in the scope (after any `add` is applied). Useful // for clearing the location scope wholesale. RemoveAll *bool `json:"removeAll,omitempty"` @@ -3549,10 +6684,12 @@ type PermissionsPathsUpdatePrimaryResult struct { type PermissionsPendingRequestsRequest struct { } -// No parameters; clears all session-scoped tool permission approvals. +// Clears session-scoped tool permission approvals, and optionally the location-scoped ones. // Experimental: PermissionsResetSessionApprovalsRequest is part of an experimental API and // may change or be removed. type PermissionsResetSessionApprovalsRequest struct { + // Whether location-scoped approvals are cleared too. Defaults to `true`. + IncludeLocation *bool `json:"includeLocation,omitempty"` } // Indicates whether the operation succeeded. @@ -3563,12 +6700,20 @@ type PermissionsResetSessionApprovalsResult struct { Success bool `json:"success"` } -// Whether to enable full allow-all permissions for the session. +// Allow-all mode to apply for the session. // Experimental: PermissionsSetAllowAllRequest is part of an experimental API and may change // or be removed. type PermissionsSetAllowAllRequest struct { - // Whether to enable full allow-all permissions - Enabled bool `json:"enabled"` + // Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is + // treated as `mode: "on"` and any other value is treated as `mode: "off"`. + Enabled *bool `json:"enabled,omitempty"` + // Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM + // auto-approval; `off` disables both. + Mode *PermissionsAllowAllMode `json:"mode,omitempty"` + // Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when + // `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge + // model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. + Model *string `json:"model,omitempty"` // Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. Source *PermissionsSetAllowAllSource `json:"source,omitempty"` } @@ -3610,9 +6755,9 @@ type PermissionsSetRequiredResult struct { } // Indicates whether the operation succeeded. -// Experimental: PermissionsUrlsSetUnrestrictedModeResult is part of an experimental API and +// Experimental: PermissionsURLsSetUnrestrictedModeResult is part of an experimental API and // may change or be removed. -type PermissionsUrlsSetUnrestrictedModeResult struct { +type PermissionsURLsSetUnrestrictedModeResult struct { // Whether the operation succeeded Success bool `json:"success"` } @@ -3620,27 +6765,28 @@ type PermissionsUrlsSetUnrestrictedModeResult struct { // If specified, replaces the session's URL-permission policy. The runtime constructs a // fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy // unchanged. -// Experimental: PermissionUrlsConfig is part of an experimental API and may change or be +// Experimental: PermissionURLsConfig is part of an experimental API and may change or be // removed. -type PermissionUrlsConfig struct { +type PermissionURLsConfig struct { // Initial list of allowed URL/domain patterns. Patterns may include path components. // Ignored when `unrestricted` is true. - InitialAllowed []string `json:"initialAllowed,omitempty"` + InitialAllowed []string `json:"initialAllowed,omitzero"` // If true, the runtime allows access to all URLs without prompting. Initial allow-list is // ignored when this is true. Unrestricted *bool `json:"unrestricted,omitempty"` } // Whether the URL-permission policy should run in unrestricted mode. -// Experimental: PermissionUrlsSetUnrestrictedModeParams is part of an experimental API and +// Experimental: PermissionURLsSetUnrestrictedModeParams is part of an experimental API and // may change or be removed. -type PermissionUrlsSetUnrestrictedModeParams struct { +type PermissionURLsSetUnrestrictedModeParams struct { // Whether to allow access to all URLs without prompting. Toggles the runtime's // URL-permission policy in place. Enabled bool `json:"enabled"` } // Optional message to echo back to the caller. +// Experimental: PingRequest is part of an experimental API and may change or be removed. type PingRequest struct { // Optional message to echo back Message *string `json:"message,omitempty"` @@ -3648,6 +6794,7 @@ type PingRequest struct { // Server liveness response, including the echoed message, current server timestamp, and // protocol version. +// Experimental: PingResult is part of an experimental API and may change or be removed. type PingResult struct { // Echoed message (or default greeting) Message string `json:"message"` @@ -3668,6 +6815,52 @@ type PlanReadResult struct { Path *string `json:"path"` } +// Todo rows read from the session SQL database. Empty when no session database is available. +// Experimental: PlanReadSQLTodosResult is part of an experimental API and may change or be +// removed. +type PlanReadSQLTodosResult struct { + // Rows from the session SQL todos table, ordered by creation time and id. + Rows []PlanSQLTodosRow `json:"rows"` +} + +// Todo rows + dependency edges read from the session SQL database. +// Experimental: PlanReadSQLTodosWithDependenciesResult is part of an experimental API and +// may change or be removed. +type PlanReadSQLTodosWithDependenciesResult struct { + // Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, + // or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does + // not affect the rows result and vice versa. + Dependencies []PlanSQLTodoDependency `json:"dependencies"` + // Rows from the session SQL todos table, ordered by creation time and id. Empty when no + // database, no todos table, or the SELECT failed. + Rows []PlanSQLTodosRow `json:"rows"` +} + +// A single dependency edge read from the session SQL `todo_deps` table, indicating that one +// todo must complete before another. +// Experimental: PlanSQLTodoDependency is part of an experimental API and may change or be +// removed. +type PlanSQLTodoDependency struct { + // ID of the todo it depends on. + DependsOn string `json:"dependsOn"` + // ID of the todo that has the dependency. + TodoID string `json:"todoId"` +} + +// A single todo row read from the session SQL `todos` table. All fields are optional +// because the SQL schema is best-effort and the agent may not have populated every column. +// Experimental: PlanSQLTodosRow is part of an experimental API and may change or be removed. +type PlanSQLTodosRow struct { + // Todo description. + Description *string `json:"description,omitempty"` + // Todo identifier. + ID *string `json:"id,omitempty"` + // Todo status. + Status *string `json:"status,omitempty"` + // Todo title. + Title *string `json:"title,omitempty"` +} + // Replacement contents to write to the session plan file. // Experimental: PlanUpdateRequest is part of an experimental API and may change or be // removed. @@ -3676,7 +6869,7 @@ type PlanUpdateRequest struct { Content string `json:"content"` } -// Schema for the `Plugin` type. +// Session plugin metadata, with name, marketplace, optional version, and enabled state. // Experimental: Plugin is part of an experimental API and may change or be removed. type Plugin struct { // Whether the plugin is currently enabled @@ -3689,6 +6882,21 @@ type Plugin struct { Version *string `json:"version,omitempty"` } +// Result of installing a plugin. +// Experimental: PluginInstallResult is part of an experimental API and may change or be +// removed. +type PluginInstallResult struct { + // Set when the install path is deprecated (e.g. direct repo / URL / local installs). + // Callers should surface this to end users. + DeprecationWarning *string `json:"deprecationWarning,omitempty"` + // The newly installed plugin's metadata + Plugin InstalledPluginInfo `json:"plugin"` + // Optional post-install message provided by the plugin (e.g. setup instructions) + PostInstallMessage *string `json:"postInstallMessage,omitempty"` + // Number of skills discovered and installed from the plugin + SkillsInstalled int64 `json:"skillsInstalled"` +} + // Plugins installed for the session, with their enabled state and version metadata. // Experimental: PluginList is part of an experimental API and may change or be removed. type PluginList struct { @@ -3696,234 +6904,390 @@ type PluginList struct { Plugins []Plugin `json:"plugins"` } -// Result of the queued command execution. -// Experimental: QueuedCommandResult is part of an experimental API and may change or be +// Plugins installed in user/global state. +// Experimental: PluginListResult is part of an experimental API and may change or be // removed. -type QueuedCommandResult interface { - queuedCommandResult() - Handled() bool +type PluginListResult struct { + // Installed plugins + Plugins []InstalledPluginInfo `json:"plugins"` } -// Schema for the `QueuedCommandHandled` type. -// Experimental: QueuedCommandHandled is part of an experimental API and may change or be +// Plugin names (or specs) to disable. +// Experimental: PluginsDisableRequest is part of an experimental API and may change or be // removed. -type QueuedCommandHandled struct { - // When true, the runtime will not process subsequent queued commands until a new request - // comes in. - StopProcessingQueue *bool `json:"stopProcessingQueue,omitempty"` +type PluginsDisableRequest struct { + // Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. + // Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. + // Plugin-owned MCP servers are stopped in active sessions immediately; other plugin + // contributions remain available until each session reloads plugins. + Names []string `json:"names"` } -func (QueuedCommandHandled) queuedCommandResult() {} -func (QueuedCommandHandled) Handled() bool { - return true +// Experimental: PluginsDisableResult is part of an experimental API and may change or be +// removed. +type PluginsDisableResult struct { } -// Schema for the `QueuedCommandNotHandled` type. -// Experimental: QueuedCommandNotHandled is part of an experimental API and may change or be +// Plugin names (or specs) to enable. +// Experimental: PluginsEnableRequest is part of an experimental API and may change or be // removed. -type QueuedCommandNotHandled struct { +type PluginsEnableRequest struct { + // Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. + // Non-marketplace direct installs are always enabled and cannot be toggled via this API. + Names []string `json:"names"` } -func (QueuedCommandNotHandled) queuedCommandResult() {} -func (QueuedCommandNotHandled) Handled() bool { - return false +// Experimental: PluginsEnableResult is part of an experimental API and may change or be +// removed. +type PluginsEnableResult struct { } -// Schema for the `QueuePendingItems` type. -// Experimental: QueuePendingItems is part of an experimental API and may change or be +// Plugin source and optional working directory for relative-path resolution. +// Experimental: PluginsInstallRequest is part of an experimental API and may change or be // removed. -type QueuePendingItems struct { - // Human-readable text to display for this queue entry in the UI - DisplayText string `json:"displayText"` - // Whether this item is a queued user message or a queued slash command / model change - Kind QueuePendingItemsKind `json:"kind"` +type PluginsInstallRequest struct { + // Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace + // install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or + // a local path. Direct (non-marketplace) installs are deprecated and will produce a + // deprecationWarning in the result. + Source string `json:"source"` + // Working directory used to resolve relative local paths in `source`. Defaults to the + // server's current working directory. + WorkingDirectory *string `json:"workingDirectory,omitempty"` } -// Snapshot of the session's pending queued items and immediate-steering messages. -// Experimental: QueuePendingItemsResult is part of an experimental API and may change or be -// removed. -type QueuePendingItemsResult struct { - // Pending queued items in submission order. Includes user messages, queued slash commands, - // and queued model changes; omits internal system items. - Items []QueuePendingItems `json:"items"` - // Display text for messages currently in the immediate steering queue (interjections sent - // during a running turn). - SteeringMessages []string `json:"steeringMessages"` -} - -// Indicates whether a user-facing pending item was removed. -// Experimental: QueueRemoveMostRecentResult is part of an experimental API and may change +// Marketplace source and optional working directory for relative-path resolution. +// Experimental: PluginsMarketplacesAddRequest is part of an experimental API and may change // or be removed. -type QueueRemoveMostRecentResult struct { - // True if a user-facing pending item was removed (LIFO across both queues); false when no - // removable items remained. - Removed bool `json:"removed"` +type PluginsMarketplacesAddRequest struct { + // Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" + // (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL + // (user@host:path), or a local path. The marketplace's own name (from its manifest) is used + // as the registration key. + Source string `json:"source"` + // Working directory used to resolve relative local paths in `source`. Defaults to the + // server's current working directory. + WorkingDirectory *string `json:"workingDirectory,omitempty"` } -// Event type to register consumer interest for, used by runtime gating logic. -// Experimental: RegisterEventInterestParams is part of an experimental API and may change -// or be removed. -type RegisterEventInterestParams struct { - // The event type the consumer wants the runtime to treat as 'observed' for - // behavior-switching gating. Some runtime code paths inspect whether any consumer is - // interested in a specific event type and choose a different implementation accordingly - // (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full - // interactive OAuth flow to the consumer; when no interest is registered the runtime - // installs a browserless fallback that silently reuses cached tokens). SDK clients that - // long-poll events do NOT automatically appear as listeners to these gating checks — they - // must explicitly call `registerInterest` for each event type they want the runtime to - // count as having a consumer. Multiple registrations for the same event type from the same - // or different consumers are tracked independently and must each be released. See: - // `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, - // `user_input.requested`, `elicitation.requested`, `command.queued`, - // `exit_plan_mode.requested`. - EventType string `json:"eventType"` +// Name of the marketplace whose plugin catalog to fetch. +// Experimental: PluginsMarketplacesBrowseRequest is part of an experimental API and may +// change or be removed. +type PluginsMarketplacesBrowseRequest struct { + // Marketplace name to browse + Name string `json:"name"` } -// Opaque handle representing an event-type interest registration. -// Experimental: RegisterEventInterestResult is part of an experimental API and may change -// or be removed. -type RegisterEventInterestResult struct { - // Opaque handle for this registration. Pass to releaseInterest to release. Each call to - // registerInterest produces a fresh handle, even when the same eventType is registered - // multiple times. - Handle string `json:"handle"` +// Experimental: PluginsMarketplacesRefreshRequest is part of an experimental API and may +// change or be removed. +type PluginsMarketplacesRefreshRequest struct { + // Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + Name *string `json:"name,omitempty"` } -// Opaque handle previously returned by `registerInterest` to release. -// Experimental: ReleaseEventInterestParams is part of an experimental API and may change or -// be removed. -type ReleaseEventInterestParams struct { - // Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown - // or already-released handle is a no-op (returns success). When the last outstanding handle - // for an event type is released, the runtime reverts to its 'no consumer' code path for - // that event type. - Handle string `json:"handle"` +// Name of the marketplace to remove and an optional force flag. +// Experimental: PluginsMarketplacesRemoveRequest is part of an experimental API and may +// change or be removed. +type PluginsMarketplacesRemoveRequest struct { + // When true, also uninstall every plugin sourced from this marketplace. When false + // (default), removal is a no-op if any plugin from this marketplace is installed and the + // dependent plugin names are returned in the result. + Force *bool `json:"force,omitempty"` + // Marketplace name to remove + Name string `json:"name"` } -// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export -// and remote steering. -// Experimental: RemoteEnableRequest is part of an experimental API and may change or be +type PluginsReloadRequest struct { + // When true, skip repo-level hooks during the hook reload. Use before folder trust is + // confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + DeferRepoHooks *bool `json:"deferRepoHooks,omitempty"` + // Re-run custom-agent discovery after refreshing plugins. Defaults to true. + ReloadCustomAgents *bool `json:"reloadCustomAgents,omitempty"` + // Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) + // after refreshing plugins. Defaults to true. Has no effect when the session has no active + // extension controller (e.g. extensions were not requested for the session). + ReloadExtensions *bool `json:"reloadExtensions,omitempty"` + // Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has + // no effect when the host has not registered a hook reloader (e.g. remote sessions). + ReloadHooks *bool `json:"reloadHooks,omitempty"` + // Reload MCP server connections after refreshing plugins. Defaults to true. + ReloadMCP *bool `json:"reloadMcp,omitempty"` +} + +// Name (or spec) of the plugin to uninstall. +// Experimental: PluginsUninstallRequest is part of an experimental API and may change or be // removed. -type RemoteEnableRequest struct { - // Per-session remote mode. "off" disables remote, "export" exports session events to GitHub - // without enabling remote steering, "on" enables both export and remote steering. - Mode *RemoteSessionMode `json:"mode,omitempty"` +type PluginsUninstallRequest struct { + // Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall + // when multiple installed plugins share the same name. + DirectSourceID *string `json:"directSourceId,omitempty"` + // Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the + // fully-qualified spec. + Name string `json:"name"` } -// GitHub URL for the session and a flag indicating whether remote steering is enabled. -// Experimental: RemoteEnableResult is part of an experimental API and may change or be +// Experimental: PluginsUninstallResult is part of an experimental API and may change or be // removed. -type RemoteEnableResult struct { - // Whether remote steering is enabled - RemoteSteerable bool `json:"remoteSteerable"` - // GitHub frontend URL for this session - URL *string `json:"url,omitempty"` +type PluginsUninstallResult struct { } -// New remote-steerability state to persist as a `session.remote_steerable_changed` event. -// Experimental: RemoteNotifySteerableChangedRequest is part of an experimental API and may -// change or be removed. -type RemoteNotifySteerableChangedRequest struct { - // Whether the session now supports remote steering via GitHub. The runtime persists this as - // a `session.remote_steerable_changed` event so resume/replay sees the up-to-date - // capability. - RemoteSteerable bool `json:"remoteSteerable"` +// Name (or spec) of the plugin to update. +// Experimental: PluginsUpdateRequest is part of an experimental API and may change or be +// removed. +type PluginsUpdateRequest struct { + // Plugin name or "plugin@marketplace" spec to update. + Name string `json:"name"` } -// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the -// host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a -// remote exporter that the runtime does not directly own. -// Experimental: RemoteNotifySteerableChangedResult is part of an experimental API and may -// change or be removed. -type RemoteNotifySteerableChangedResult struct { +// Per-plugin result from updating all plugins, with versions, skills installed, success +// flag, and optional error. +// Experimental: PluginUpdateAllEntry is part of an experimental API and may change or be +// removed. +type PluginUpdateAllEntry struct { + // Error message (failure only) + Error *string `json:"error,omitempty"` + // Marketplace the plugin came from. Empty string ("") for direct installs. + Marketplace string `json:"marketplace"` + // Plugin name that was updated + Name string `json:"name"` + // Version after the update, when available + NewVersion *string `json:"newVersion,omitempty"` + // Previously installed version, when available + PreviousVersion *string `json:"previousVersion,omitempty"` + // Number of skills installed after the update (success only) + SkillsInstalled *int64 `json:"skillsInstalled,omitempty"` + // Whether the update succeeded for this plugin + Success bool `json:"success"` } -// Remote session connection result. -// Experimental: RemoteSessionConnectionResult is part of an experimental API and may change -// or be removed. -type RemoteSessionConnectionResult struct { - // Metadata for a connected remote session. - Metadata ConnectedRemoteSessionMetadata `json:"metadata"` - // SDK session ID for the connected remote session. - SessionID string `json:"sessionId"` +// Result of updating all installed plugins. +// Experimental: PluginUpdateAllResult is part of an experimental API and may change or be +// removed. +type PluginUpdateAllResult struct { + // Per-plugin update results in deterministic order. + Results []PluginUpdateAllEntry `json:"results"` } -// Schema for the `ScheduleEntry` type. -// Experimental: ScheduleEntry is part of an experimental API and may change or be removed. -type ScheduleEntry struct { - // Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a - // skill-invocation schedule). The actual enqueued prompt is `prompt`. - DisplayPrompt *string `json:"displayPrompt,omitempty"` - // Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt - // from the event log). - ID int64 `json:"id"` - // Interval between scheduled ticks, in milliseconds. - IntervalMs int64 `json:"intervalMs"` - // ISO 8601 timestamp when the next tick is scheduled to fire. - NextRunAt time.Time `json:"nextRunAt"` - // Prompt text that gets enqueued on every tick. - Prompt string `json:"prompt"` - // Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). - Recurring bool `json:"recurring"` +// Result of updating a single plugin. +// Experimental: PluginUpdateResult is part of an experimental API and may change or be +// removed. +type PluginUpdateResult struct { + // Version after the update, when reported by the plugin manifest + NewVersion *string `json:"newVersion,omitempty"` + // Version that was previously installed, when available + PreviousVersion *string `json:"previousVersion,omitempty"` + // Number of skills discovered and installed after the update + SkillsInstalled int64 `json:"skillsInstalled"` +} + +// BYOK providers and/or models to add to the session's registry at runtime. Both fields are +// optional; provide providers, models, or both. +// Experimental: ProviderAddRequest is part of an experimental API and may change or be +// removed. +type ProviderAddRequest struct { + // BYOK model definitions to register. Each must reference a provider that is already + // registered or included in this same call. Selection ids (`provider/id`) must be unique + // across the registry. + Models []ProviderModelConfig `json:"models,omitzero"` + // Named BYOK provider connections to register, additive to any providers already in the + // registry. Each name must be unique across the registry and must not contain '/'. + Providers []NamedProviderConfig `json:"providers,omitzero"` +} + +// The selectable model entries synthesized for the models added by this call. +// Experimental: ProviderAddResult is part of an experimental API and may change or be +// removed. +type ProviderAddResult struct { + // Synthesized selectable model entries for the newly added BYOK models, each under its + // provider-qualified selection id (`provider/id`). Empty when only providers were added. + Models []any `json:"models"` +} + +// Custom model-provider configuration (BYOK). +// Experimental: ProviderConfig is part of an experimental API and may change or be removed. +type ProviderConfig struct { + // API key. Optional for local providers like Ollama. + APIKey *string `json:"apiKey,omitempty"` + // Azure-specific provider options. + Azure *ProviderConfigAzure `json:"azure,omitempty"` + // API endpoint URL. + BaseURL string `json:"baseUrl"` + // Bearer token for authentication. Sets the Authorization header directly. Takes precedence + // over apiKey when both are set. + BearerToken *string `json:"bearerToken,omitempty"` + // When true, the SDK client supplies bearer tokens on demand: the runtime calls the + // client-session `providerToken.getToken` callback before each request and applies the + // returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth + // scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens + // (including Anthropic's), not a provider-specific API-key header such as Anthropic's + // `x-api-key`. The token-acquiring function itself stays on the SDK side and is never + // serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, + // the callback takes precedence: the runtime applies the token returned by + // `providerToken.getToken` as the `Authorization: Bearer` header for each request and does + // not send the static credential. + HasBearerTokenProvider *bool `json:"hasBearerTokenProvider,omitempty"` + // Custom HTTP headers to include in all outbound requests to the provider. + Headers map[string]string `json:"headers,omitzero"` + // Maximum context window tokens for the model. + MaxContextWindowTokens *float64 `json:"maxContextWindowTokens,omitempty"` + // Maximum output tokens for the model. + MaxOutputTokens *float64 `json:"maxOutputTokens,omitempty"` + // Maximum prompt/input tokens for the model. + MaxPromptTokens *float64 `json:"maxPromptTokens,omitempty"` + // Well-known model ID used for capability lookup. When set, agent behavior config and token + // limits are inferred from this model. + ModelID *string `json:"modelId,omitempty"` + // Provider transport. Defaults to "http". + Transport *ProviderConfigTransport `json:"transport,omitempty"` + // Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + Type *ProviderConfigType `json:"type,omitempty"` + // Wire API format (openai/azure only). Defaults to "completions". + WireAPI *ProviderConfigWireAPI `json:"wireApi,omitempty"` + // The model identifier sent to the provider API for inference (the "wire" model), as + // opposed to modelId which is the well-known base. + WireModel *string `json:"wireModel,omitempty"` +} + +// Azure-specific provider options. +// Experimental: ProviderConfigAzure is part of an experimental API and may change or be +// removed. +type ProviderConfigAzure struct { + // API version. When set, uses the versioned deployment route. When omitted, uses the GA + // versionless v1 route. + APIVersion *string `json:"apiVersion,omitempty"` } -// Snapshot of the currently active recurring prompts for this session. -// Experimental: ScheduleList is part of an experimental API and may change or be removed. -type ScheduleList struct { - // Active scheduled prompts, ordered by id. - Entries []ScheduleEntry `json:"entries"` +// A snapshot of the provider endpoint the session is currently configured to talk to. +// Experimental: ProviderEndpoint is part of an experimental API and may change or be +// removed. +type ProviderEndpoint struct { + // A credential the caller should use with this endpoint. Omitted only when the endpoint + // accepts unauthenticated requests. + APIKey *string `json:"apiKey,omitempty"` + // Base URL to pass to the LLM client library. + BaseURL string `json:"baseUrl"` + // HTTP headers the caller must include on every outbound request. + Headers map[string]string `json:"headers"` + // Short-lived, rotating credential the caller must send on every request, in addition to + // `apiKey` if one is present. Omitted when the endpoint does not require one. + SessionToken *ProviderSessionToken `json:"sessionToken,omitempty"` + // Transport to be used for provider requests. + Transport *ProviderEndpointTransport `json:"transport,omitempty"` + // Provider family. Matches the `type` field of a BYOK provider config. + Type ProviderEndpointType `json:"type"` + // Wire API to be used, when required for the provider type. + WireAPI *ProviderEndpointWireAPI `json:"wireApi,omitempty"` +} + +type ProviderGetEndpointRequest struct { + // Model identifier the caller intends to use against the returned endpoint. Used to pick + // the correct wire shape. Omit to use whichever model the session is currently using. + ModelID *string `json:"modelId,omitempty"` } -// Identifier of the scheduled prompt to remove. -// Experimental: ScheduleStopRequest is part of an experimental API and may change or be +// A BYOK model definition referencing a named provider. +// Experimental: ProviderModelConfig is part of an experimental API and may change or be // removed. -type ScheduleStopRequest struct { - // Id of the scheduled prompt to remove. - ID int64 `json:"id"` +type ProviderModelConfig struct { + // Optional capability overrides (vision, tool_calls, reasoning, etc.). + Capabilities *ModelCapabilitiesOverride `json:"capabilities,omitempty"` + // Provider-local model id, unique within its provider. The session-wide selection id (shown + // in the model list and passed to switchTo) is the provider-qualified `provider/id`. + ID string `json:"id"` + // Maximum context window tokens for the model. + MaxContextWindowTokens *float64 `json:"maxContextWindowTokens,omitempty"` + // Maximum output tokens for the model. + MaxOutputTokens *float64 `json:"maxOutputTokens,omitempty"` + // Maximum prompt/input tokens for the model. + MaxPromptTokens *float64 `json:"maxPromptTokens,omitempty"` + // Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. + ModelID *string `json:"modelId,omitempty"` + // Display name for model pickers. Defaults to the provider-qualified selection id + // (`provider/id`). + Name *string `json:"name,omitempty"` + // Name of the NamedProviderConfig that serves this model. + Provider string `json:"provider"` + // The model name sent to the provider API for inference. Defaults to `id`. + WireModel *string `json:"wireModel,omitempty"` } -// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. -// Experimental: ScheduleStopResult is part of an experimental API and may change or be +// Short-lived, rotating credential the caller must send on every request, in addition to +// `apiKey` if one is present. Omitted when the endpoint does not require one. +// Experimental: ProviderSessionToken is part of an experimental API and may change or be // removed. -type ScheduleStopResult struct { - // The removed entry, or omitted if no entry matched. - Entry *ScheduleEntry `json:"entry,omitempty"` +type ProviderSessionToken struct { + // When the token expires, if known. Callers should refresh by calling `getEndpoint` again + // before this time, or reactively on any 401/403 response from `baseUrl`. + ExpiresAt *time.Time `json:"expiresAt,omitempty"` + // HTTP header name the token must be sent under. + Header string `json:"header"` + // The model the token is bound to, when applicable. When set, the token is only valid for + // requests against this model. + Model *string `json:"model,omitempty"` + // The short-lived token value. + Token string `json:"token"` } -// Secret values to add to the redaction filter. -type SecretsAddFilterValuesRequest struct { - // Raw secret values to register for redaction - Values []string `json:"values"` +// Asks the SDK client to acquire a bearer token for a BYOK provider whose config set +// `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; +// the runtime does no caching, so this is sent once per request. +// Experimental: ProviderTokenAcquireRequest is part of an experimental API and may change +// or be removed. +type ProviderTokenAcquireRequest struct { + // Name of the BYOK provider needing a token. For the legacy whole-session `provider` this + // is the implicit provider name; for named providers it is `NamedProviderConfig.name`. + ProviderName string `json:"providerName"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Confirmation that the secret values were registered. -type SecretsAddFilterValuesResult struct { - // Whether the values were successfully registered - Ok bool `json:"ok"` +// A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as +// `Authorization: Bearer ` on the outbound request and does no caching; the SDK +// consumer owns token caching and refresh. +// Experimental: ProviderTokenAcquireResult is part of an experimental API and may change or +// be removed. +type ProviderTokenAcquireResult struct { + // The bearer token value (without the `Bearer ` prefix). + Token string `json:"token"` } -// A user message attachment — a file, directory, code selection, blob, or GitHub reference -// Experimental: SendAttachment is part of an experimental API and may change or be removed. -type SendAttachment interface { - sendAttachment() - Type() SendAttachmentType +// Attachment union accepted by push input, covering files, directories, GitHub objects, +// blobs, snippets, and extension context. +// Experimental: PushAttachment is part of an experimental API and may change or be removed. +type PushAttachment interface { + pushAttachment() + Type() PushAttachmentType } -type RawSendAttachmentData struct { - Discriminator SendAttachmentType +type RawPushAttachmentData struct { + Discriminator PushAttachmentType Raw json.RawMessage } -func (RawSendAttachmentData) sendAttachment() {} -func (r RawSendAttachmentData) Type() SendAttachmentType { +func (RawPushAttachmentData) pushAttachment() {} +func (r RawPushAttachmentData) Type() PushAttachmentType { return r.Discriminator } +// Slim input shape for extension_context attachments; identity fields are runtime-derived. +// Experimental: ExtensionContextPushInput is part of an experimental API and may change or +// be removed. +type ExtensionContextPushInput struct { + // Caller-supplied JSON payload (required, may be null but not undefined) + Payload any `json:"payload"` + // Human-readable composer pill label + Title string `json:"title"` +} + +func (ExtensionContextPushInput) pushAttachment() {} +func (ExtensionContextPushInput) Type() PushAttachmentType { + return PushAttachmentTypeExtensionContext +} + // Blob attachment with inline base64-encoded data -// Experimental: SendAttachmentBlob is part of an experimental API and may change or be +// Experimental: PushAttachmentBlob is part of an experimental API and may change or be // removed. -type SendAttachmentBlob struct { +type PushAttachmentBlob struct { // Base64-encoded content Data string `json:"data"` // User-facing display name for the attachment @@ -3932,51 +7296,130 @@ type SendAttachmentBlob struct { MIMEType string `json:"mimeType"` } -func (SendAttachmentBlob) sendAttachment() {} -func (SendAttachmentBlob) Type() SendAttachmentType { - return SendAttachmentTypeBlob +func (PushAttachmentBlob) pushAttachment() {} +func (PushAttachmentBlob) Type() PushAttachmentType { + return PushAttachmentTypeBlob } // Directory attachment -// Experimental: SendAttachmentDirectory is part of an experimental API and may change or be +// Experimental: PushAttachmentDirectory is part of an experimental API and may change or be // removed. -type SendAttachmentDirectory struct { +type PushAttachmentDirectory struct { // User-facing display name for the attachment DisplayName string `json:"displayName"` // Absolute directory path Path string `json:"path"` } -func (SendAttachmentDirectory) sendAttachment() {} -func (SendAttachmentDirectory) Type() SendAttachmentType { - return SendAttachmentTypeDirectory +func (PushAttachmentDirectory) pushAttachment() {} +func (PushAttachmentDirectory) Type() PushAttachmentType { + return PushAttachmentTypeDirectory } // File attachment -// Experimental: SendAttachmentFile is part of an experimental API and may change or be +// Experimental: PushAttachmentFile is part of an experimental API and may change or be // removed. -type SendAttachmentFile struct { +type PushAttachmentFile struct { // User-facing display name for the attachment DisplayName string `json:"displayName"` // Optional line range to scope the attachment to a specific section of the file - LineRange *SendAttachmentFileLineRange `json:"lineRange,omitempty"` + LineRange *PushAttachmentFileLineRange `json:"lineRange,omitempty"` // Absolute file path Path string `json:"path"` } -func (SendAttachmentFile) sendAttachment() {} -func (SendAttachmentFile) Type() SendAttachmentType { - return SendAttachmentTypeFile +func (PushAttachmentFile) pushAttachment() {} +func (PushAttachmentFile) Type() PushAttachmentType { + return PushAttachmentTypeFile +} + +// Pointer to a GitHub Actions job. +// Experimental: PushAttachmentGitHubActionsJob is part of an experimental API and may +// change or be removed. +type PushAttachmentGitHubActionsJob struct { + // Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent + // for in-progress jobs. + Conclusion *string `json:"conclusion,omitempty"` + // Job id within the workflow run + JobID int64 `json:"jobId"` + // Display name of the job + JobName string `json:"jobName"` + // Repository the workflow run belongs to + Repo PushGitHubRepoRef `json:"repo"` + // URL to the job on GitHub + URL string `json:"url"` + // Display name of the workflow the job ran in + WorkflowName string `json:"workflowName"` +} + +func (PushAttachmentGitHubActionsJob) pushAttachment() {} +func (PushAttachmentGitHubActionsJob) Type() PushAttachmentType { + return PushAttachmentTypeGitHubActionsJob +} + +// Pointer to a GitHub commit. +// Experimental: PushAttachmentGitHubCommit is part of an experimental API and may change or +// be removed. +type PushAttachmentGitHubCommit struct { + // First line of the commit message + Message string `json:"message"` + // Full commit SHA + Oid string `json:"oid"` + // Repository the commit belongs to + Repo PushGitHubRepoRef `json:"repo"` + // URL to the commit on GitHub + URL string `json:"url"` +} + +func (PushAttachmentGitHubCommit) pushAttachment() {} +func (PushAttachmentGitHubCommit) Type() PushAttachmentType { + return PushAttachmentTypeGitHubCommit +} + +// Pointer to a file in a GitHub repository at a specific ref. +// Experimental: PushAttachmentGitHubFile is part of an experimental API and may change or +// be removed. +type PushAttachmentGitHubFile struct { + // Repository-relative path to the file + Path string `json:"path"` + // Git ref the file is read at (branch, tag, or commit SHA) + Ref string `json:"ref"` + // Repository the file lives in + Repo PushGitHubRepoRef `json:"repo"` + // URL to the file on GitHub + URL string `json:"url"` +} + +func (PushAttachmentGitHubFile) pushAttachment() {} +func (PushAttachmentGitHubFile) Type() PushAttachmentType { + return PushAttachmentTypeGitHubFile +} + +// Pointer to a single-file diff. At least one of `head` and `base` must be present. +// Experimental: PushAttachmentGitHubFileDiff is part of an experimental API and may change +// or be removed. +type PushAttachmentGitHubFileDiff struct { + // File location on the base side of the diff. Absent for additions. + Base *PushAttachmentGitHubFileDiffSide `json:"base,omitempty"` + // File location on the head side of the diff. Absent for deletions. + Head *PushAttachmentGitHubFileDiffSide `json:"head,omitempty"` + // URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + URL string `json:"url"` +} + +func (PushAttachmentGitHubFileDiff) pushAttachment() {} +func (PushAttachmentGitHubFileDiff) Type() PushAttachmentType { + return PushAttachmentTypeGitHubFileDiff } // GitHub issue, pull request, or discussion reference -// Experimental: SendAttachmentGithubReference is part of an experimental API and may change +// Experimental: PushAttachmentGitHubReference is part of an experimental API and may change // or be removed. -type SendAttachmentGithubReference struct { +type PushAttachmentGitHubReference struct { // Issue, pull request, or discussion number Number int64 `json:"number"` // Type of GitHub reference - ReferenceType SendAttachmentGithubReferenceType `json:"referenceType"` + ReferenceType PushAttachmentGitHubReferenceType `json:"referenceType"` // Current state of the referenced item (e.g., open, closed, merged) State string `json:"state"` // Title of the referenced item @@ -3985,54 +7428,166 @@ type SendAttachmentGithubReference struct { URL string `json:"url"` } -func (SendAttachmentGithubReference) sendAttachment() {} -func (SendAttachmentGithubReference) Type() SendAttachmentType { - return SendAttachmentTypeGithubReference +func (PushAttachmentGitHubReference) pushAttachment() {} +func (PushAttachmentGitHubReference) Type() PushAttachmentType { + return PushAttachmentTypeGitHubReference +} + +// Pointer to a GitHub release. +// Experimental: PushAttachmentGitHubRelease is part of an experimental API and may change +// or be removed. +type PushAttachmentGitHubRelease struct { + // Human-readable release name + Name string `json:"name"` + // Repository the release belongs to + Repo PushGitHubRepoRef `json:"repo"` + // Git tag the release is anchored to + TagName string `json:"tagName"` + // URL to the release on GitHub + URL string `json:"url"` +} + +func (PushAttachmentGitHubRelease) pushAttachment() {} +func (PushAttachmentGitHubRelease) Type() PushAttachmentType { + return PushAttachmentTypeGitHubRelease +} + +// Pointer to a GitHub repository. +// Experimental: PushAttachmentGitHubRepository is part of an experimental API and may +// change or be removed. +type PushAttachmentGitHubRepository struct { + // Short description of the repository + Description *string `json:"description,omitempty"` + // Git ref this attachment is anchored at (branch, tag, or commit). When absent the default + // branch is implied. + Ref *string `json:"ref,omitempty"` + // Repository pointer + Repo PushGitHubRepoRef `json:"repo"` + // URL to the repository on GitHub + URL string `json:"url"` +} + +func (PushAttachmentGitHubRepository) pushAttachment() {} +func (PushAttachmentGitHubRepository) Type() PushAttachmentType { + return PushAttachmentTypeGitHubRepository +} + +// Pointer to a line range inside a file in a GitHub repository. +// Experimental: PushAttachmentGitHubSnippet is part of an experimental API and may change +// or be removed. +type PushAttachmentGitHubSnippet struct { + // Line range the snippet covers + LineRange PushAttachmentFileLineRange `json:"lineRange"` + // Repository-relative path to the file + Path string `json:"path"` + // Git ref the file is read at (branch, tag, or commit SHA) + Ref string `json:"ref"` + // Repository the file lives in + Repo PushGitHubRepoRef `json:"repo"` + // URL to the snippet on GitHub (with line anchor) + URL string `json:"url"` +} + +func (PushAttachmentGitHubSnippet) pushAttachment() {} +func (PushAttachmentGitHubSnippet) Type() PushAttachmentType { + return PushAttachmentTypeGitHubSnippet +} + +// Pointer to a comparison between two git revisions. +// Experimental: PushAttachmentGitHubTreeComparison is part of an experimental API and may +// change or be removed. +type PushAttachmentGitHubTreeComparison struct { + // Base side of the comparison + Base PushAttachmentGitHubTreeComparisonSide `json:"base"` + // Head side of the comparison + Head PushAttachmentGitHubTreeComparisonSide `json:"head"` + // URL to the comparison on GitHub + URL string `json:"url"` +} + +func (PushAttachmentGitHubTreeComparison) pushAttachment() {} +func (PushAttachmentGitHubTreeComparison) Type() PushAttachmentType { + return PushAttachmentTypeGitHubTreeComparison +} + +// Generic GitHub URL reference. +// Experimental: PushAttachmentGitHubURL is part of an experimental API and may change or be +// removed. +type PushAttachmentGitHubURL struct { + // URL to the GitHub resource + URL string `json:"url"` +} + +func (PushAttachmentGitHubURL) pushAttachment() {} +func (PushAttachmentGitHubURL) Type() PushAttachmentType { + return PushAttachmentTypeGitHubURL } // Code selection attachment from an editor -// Experimental: SendAttachmentSelection is part of an experimental API and may change or be +// Experimental: PushAttachmentSelection is part of an experimental API and may change or be // removed. -type SendAttachmentSelection struct { +type PushAttachmentSelection struct { // User-facing display name for the selection DisplayName string `json:"displayName"` // Absolute path to the file containing the selection FilePath string `json:"filePath"` // Position range of the selection within the file - Selection SendAttachmentSelectionDetails `json:"selection"` + Selection PushAttachmentSelectionDetails `json:"selection"` // The selected text content Text string `json:"text"` } -func (SendAttachmentSelection) sendAttachment() {} -func (SendAttachmentSelection) Type() SendAttachmentType { - return SendAttachmentTypeSelection +func (PushAttachmentSelection) pushAttachment() {} +func (PushAttachmentSelection) Type() PushAttachmentType { + return PushAttachmentTypeSelection } // Optional line range to scope the attachment to a specific section of the file -// Experimental: SendAttachmentFileLineRange is part of an experimental API and may change +// Experimental: PushAttachmentFileLineRange is part of an experimental API and may change // or be removed. -type SendAttachmentFileLineRange struct { +type PushAttachmentFileLineRange struct { // End line number (1-based, inclusive) End int64 `json:"end"` // Start line number (1-based) Start int64 `json:"start"` } +// One side of a file diff (head or base) +// Experimental: PushAttachmentGitHubFileDiffSide is part of an experimental API and may +// change or be removed. +type PushAttachmentGitHubFileDiffSide struct { + // Repository-relative path to the file + Path string `json:"path"` + // Git ref (branch, tag, or commit SHA) the file is read at + Ref string `json:"ref"` + // Repository the file lives in + Repo PushGitHubRepoRef `json:"repo"` +} + +// One side of a tree comparison (head or base) +// Experimental: PushAttachmentGitHubTreeComparisonSide is part of an experimental API and +// may change or be removed. +type PushAttachmentGitHubTreeComparisonSide struct { + // Repository the revision belongs to + Repo PushGitHubRepoRef `json:"repo"` + // Git revision (branch, tag, or commit SHA) + Revision string `json:"revision"` +} + // Position range of the selection within the file -// Experimental: SendAttachmentSelectionDetails is part of an experimental API and may +// Experimental: PushAttachmentSelectionDetails is part of an experimental API and may // change or be removed. -type SendAttachmentSelectionDetails struct { +type PushAttachmentSelectionDetails struct { // End position of the selection - End SendAttachmentSelectionDetailsEnd `json:"end"` + End PushAttachmentSelectionDetailsEnd `json:"end"` // Start position of the selection - Start SendAttachmentSelectionDetailsStart `json:"start"` + Start PushAttachmentSelectionDetailsStart `json:"start"` } // End position of the selection -// Experimental: SendAttachmentSelectionDetailsEnd is part of an experimental API and may +// Experimental: PushAttachmentSelectionDetailsEnd is part of an experimental API and may // change or be removed. -type SendAttachmentSelectionDetailsEnd struct { +type PushAttachmentSelectionDetailsEnd struct { // End character offset within the line (0-based) Character int64 `json:"character"` // End line number (0-based) @@ -4040,8575 +7595,16073 @@ type SendAttachmentSelectionDetailsEnd struct { } // Start position of the selection -// Experimental: SendAttachmentSelectionDetailsStart is part of an experimental API and may +// Experimental: PushAttachmentSelectionDetailsStart is part of an experimental API and may // change or be removed. -type SendAttachmentSelectionDetailsStart struct { +type PushAttachmentSelectionDetailsStart struct { // Start character offset within the line (0-based) Character int64 `json:"character"` // Start line number (0-based) Line int64 `json:"line"` } -// Parameters for sending a user message to the session -// Experimental: SendRequest is part of an experimental API and may change or be removed. -type SendRequest struct { - // The UI mode the agent was in when this message was sent. Defaults to the session's - // current mode. - AgentMode *SendAgentMode `json:"agentMode,omitempty"` - // Optional attachments (files, directories, selections, blobs, GitHub references) to - // include with the message - Attachments []SendAttachment `json:"attachments,omitempty"` - // If false, this message will not trigger a Premium Request Unit charge. User messages - // default to billable. - Billable *bool `json:"billable,omitempty"` - // If provided, this is shown in the timeline instead of `prompt` - DisplayPrompt *string `json:"displayPrompt,omitempty"` - // How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` - // interjects during an in-progress turn. - Mode *SendMode `json:"mode,omitempty"` - // If true, adds the message to the front of the queue instead of the end - Prepend *bool `json:"prepend,omitempty"` - // The user message text - Prompt string `json:"prompt"` - // Custom HTTP headers to include in outbound model requests for this turn. Merged with - // session-level provider headers; per-turn headers augment and overwrite session-level - // headers with the same key. - RequestHeaders map[string]string `json:"requestHeaders,omitempty"` - // If set, the request will fail if the named tool is not available when this message is - // among the user messages at the start of the current exchange - RequiredTool *string `json:"requiredTool,omitempty"` - // Optional provenance tag copied to the resulting user.message event. Supported values are - // `system`, `command-*`, and `schedule-*`. - // Internal: Source is part of the SDK's internal API surface and is not intended for - // external use. - Source any `json:"source,omitempty"` - // W3C Trace Context traceparent header for distributed tracing of this agent turn - Traceparent *string `json:"traceparent,omitempty"` - // W3C Trace Context tracestate header for distributed tracing - Tracestate *string `json:"tracestate,omitempty"` - // If true, await completion of the agentic loop for this message before returning. Defaults - // to false (fire-and-forget). When true, the result still contains the same `messageId`; - // the caller can rely on the agent having processed the message before the call resolves. - Wait *bool `json:"wait,omitempty"` +// Pointer to a GitHub repository. +// Experimental: PushGitHubRepoRef is part of an experimental API and may change or be +// removed. +type PushGitHubRepoRef struct { + // Numeric GitHub repository id + ID *int64 `json:"id,omitempty"` + // Repository name (without owner) + Name string `json:"name"` + // Repository owner login (user or organization) + Owner string `json:"owner"` } -// Result of sending a user message -// Experimental: SendResult is part of an experimental API and may change or be removed. -type SendResult struct { - // Unique identifier assigned to the message - MessageID string `json:"messageId"` +// Inputs for starting a deferred-idle drain. +// Experimental: QueueBeginDeferredIdleDrainRequest is part of an experimental API and may +// change or be removed. +type QueueBeginDeferredIdleDrainRequest struct { + // Whether the host still has active background work. + ActiveBackgroundWork bool `json:"activeBackgroundWork"` } -// Schema for the `ServerSkill` type. -type ServerSkill struct { - // Description of what the skill does - Description string `json:"description"` - // Whether the skill is currently enabled (based on global config) - Enabled bool `json:"enabled"` - // Unique identifier for the skill - Name string `json:"name"` - // Absolute path to the skill file - Path *string `json:"path,omitempty"` - // The project path this skill belongs to (only for project/inherited skills) - ProjectPath *string `json:"projectPath,omitempty"` - // Source location type (e.g., project, personal-copilot, plugin, builtin) - Source SkillSource `json:"source"` - // Whether the skill can be invoked by the user as a slash command - UserInvocable bool `json:"userInvocable"` +// Whether a deferred-idle drain should run. +// Experimental: QueueBeginDeferredIdleDrainResult is part of an experimental API and may +// change or be removed. +type QueueBeginDeferredIdleDrainResult struct { + // True when the host should run finishDeferredIdleDrain asynchronously. + ShouldDrain bool `json:"shouldDrain"` } -// Skills discovered across global and project sources. -type ServerSkillList struct { - // All discovered skills across all sources - Skills []ServerSkill `json:"skills"` +// Internal filter for consuming queued system notifications. +// Experimental: QueueConsumeSystemNotificationsRequest is part of an experimental API and +// may change or be removed. +type QueueConsumeSystemNotificationsRequest struct { + // Opaque runtime-owned filter object. + Filter any `json:"filter"` } -// Experimental: SessionAgentDeselectResult is part of an experimental API and may change or -// be removed. -type SessionAgentDeselectResult struct { +// Result of the queued command execution. +// Experimental: QueuedCommandResult is part of an experimental API and may change or be +// removed. +type QueuedCommandResult interface { + queuedCommandResult() + Handled() bool } -// Authentication status and account metadata for the session. -// Experimental: SessionAuthStatus is part of an experimental API and may change or be +// Queued-command response indicating the host executed the command, with an optional flag +// to stop queue processing. +// Experimental: QueuedCommandHandled is part of an experimental API and may change or be // removed. -type SessionAuthStatus struct { - // Authentication type - AuthType *AuthInfoType `json:"authType,omitempty"` - // Copilot plan tier (e.g., individual_pro, business) - CopilotPlan *string `json:"copilotPlan,omitempty"` - // Authentication host URL - Host *string `json:"host,omitempty"` - // Whether the session has resolved authentication - IsAuthenticated bool `json:"isAuthenticated"` - // Authenticated login/username, if available - Login *string `json:"login,omitempty"` - // Human-readable authentication status description - StatusMessage *string `json:"statusMessage,omitempty"` +type QueuedCommandHandled struct { + // When true, the runtime will not process subsequent queued commands until a new request + // comes in. + StopProcessingQueue *bool `json:"stopProcessingQueue,omitempty"` } -// Map of sessionId -> bytes freed by removing the session's workspace directory. -// Experimental: SessionBulkDeleteResult is part of an experimental API and may change or be +func (QueuedCommandHandled) queuedCommandResult() {} +func (QueuedCommandHandled) Handled() bool { + return true +} + +// Queued-command response indicating the host did not execute the command and the queue may +// continue. +// Experimental: QueuedCommandNotHandled is part of an experimental API and may change or be // removed. -type SessionBulkDeleteResult struct { - // Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions - // whose deletion failed are omitted from this map (failures are logged on the server but - // not surfaced per-id; check the map for absent IDs to detect them). - FreedBytes map[string]int64 `json:"freedBytes"` +type QueuedCommandNotHandled struct { } -// Experimental: SessionCanvasCloseResult is part of an experimental API and may change or -// be removed. -type SessionCanvasCloseResult struct { +func (QueuedCommandNotHandled) queuedCommandResult() {} +func (QueuedCommandNotHandled) Handled() bool { + return false } -// Schema for the `SessionContext` type. -// Experimental: SessionContext is part of an experimental API and may change or be removed. -type SessionContext struct { - // Active git branch - Branch *string `json:"branch,omitempty"` - // Most recent working directory for this session - Cwd string `json:"cwd"` - // Git repository root, if the cwd was inside a git repo - GitRoot *string `json:"gitRoot,omitempty"` - // Repository host type - HostType *SessionContextHostType `json:"hostType,omitempty"` - // Repository slug in `owner/name` form, when known - Repository *string `json:"repository,omitempty"` +// Inputs for marking session.idle deferred in native state. +// Experimental: QueueDeferSessionIdleRequest is part of an experimental API and may change +// or be removed. +type QueueDeferSessionIdleRequest struct { + // Whether the deferred idle was caused by an aborted foreground turn. + Aborted bool `json:"aborted"` } -// Token-usage breakdown for the session's current context window -// Experimental: SessionContextInfo is part of an experimental API and may change or be +// Parameters for duplicating a queued item. +// Experimental: QueueDuplicateAtRequest is part of an experimental API and may change or be // removed. -type SessionContextInfo struct { - // Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) - BufferTokens int64 `json:"bufferTokens"` - // Token count at which background compaction starts (configurable percentage of - // promptTokenLimit) - CompactionThreshold int64 `json:"compactionThreshold"` - // Tokens consumed by user/assistant/tool messages - ConversationTokens int64 `json:"conversationTokens"` - // Total context limit for /context display. promptTokenLimit + min(32k or 64k, - // outputTokenLimit) depending on model. - Limit int64 `json:"limit"` - // Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes - // deferred tools) - McpToolsTokens int64 `json:"mcpToolsTokens"` - // The model used for token counting - ModelName string `json:"modelName"` - // Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) - PromptTokenLimit int64 `json:"promptTokenLimit"` - // Tokens consumed by the system prompt - SystemTokens int64 `json:"systemTokens"` - // Tokens consumed by tool definitions sent to the model (excludes deferred tools) - ToolDefinitionsTokens int64 `json:"toolDefinitionsTokens"` - // Sum of system, conversation and tool-definition tokens - TotalTokens int64 `json:"totalTokens"` +type QueueDuplicateAtRequest struct { + ID string `json:"id"` } -// The enriched metadata records, with summary and context fields backfilled where -// available. Sessions confirmed empty and unnamed are omitted. -// Experimental: SessionEnrichMetadataResult is part of an experimental API and may change -// or be removed. -type SessionEnrichMetadataResult struct { - // Enriched records, with summary and context backfilled. Sessions confirmed empty and - // unnamed may be omitted. - Sessions []SessionMetadata `json:"sessions"` +// Result of duplicating a queued item. +// Experimental: QueueDuplicateAtResult is part of an experimental API and may change or be +// removed. +type QueueDuplicateAtResult struct { + // Fresh stable opaque id assigned to the duplicate. + ID string `json:"id"` } -// Experimental: SessionExtensionsDisableResult is part of an experimental API and may +// Result of enqueueing the resume-pending wake item. +// Experimental: QueueEnqueueResumePendingResult is part of an experimental API and may // change or be removed. -type SessionExtensionsDisableResult struct { +type QueueEnqueueResumePendingResult struct { + // True when a wake item was newly queued. + Queued bool `json:"queued"` } -// Experimental: SessionExtensionsEnableResult is part of an experimental API and may change -// or be removed. -type SessionExtensionsEnableResult struct { +// Inputs for completing a deferred-idle drain. +// Experimental: QueueFinishDeferredIdleDrainRequest is part of an experimental API and may +// change or be removed. +type QueueFinishDeferredIdleDrainRequest struct { + // Whether the host still has active background work. + ActiveBackgroundWork bool `json:"activeBackgroundWork"` + // Whether native queued work remains. + HasPending bool `json:"hasPending"` } -// Experimental: SessionExtensionsReloadResult is part of an experimental API and may change -// or be removed. -type SessionExtensionsReloadResult struct { +// Action selected by the native deferred-idle drain. +// Experimental: QueueFinishDeferredIdleDrainResult is part of an experimental API and may +// change or be removed. +type QueueFinishDeferredIdleDrainResult struct { + // Whether the deferred idle was caused by an aborted foreground turn. + Aborted bool `json:"aborted"` + // One of none, processQueue, or emitSessionIdle. + Action string `json:"action"` } -// File path, content to append, and optional mode for the client-provided session -// filesystem. -// Experimental: SessionFsAppendFileRequest is part of an experimental API and may change or -// be removed. -type SessionFsAppendFileRequest struct { - // Content to append - Content string `json:"content"` - // Optional POSIX-style mode for newly created files - Mode *int64 `json:"mode,omitempty"` - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +// Whether the native queue has pending work. +// Experimental: QueueHasPendingResult is part of an experimental API and may change or be +// removed. +type QueueHasPendingResult struct { + // True when queued or immediate native work is pending. + HasPending bool `json:"hasPending"` } -// Describes a filesystem error. -// Experimental: SessionFsError is part of an experimental API and may change or be removed. -type SessionFsError struct { - // Error classification - Code SessionFsErrorCode `json:"code"` - // Free-form detail about the error, for logging/diagnostics - Message *string `json:"message,omitempty"` +// Parameters for inserting a queued message at a public visible position. +// Experimental: QueueInsertAtRequest is part of an experimental API and may change or be +// removed. +type QueueInsertAtRequest struct { + Message QueueInsertMessage `json:"message"` + // Zero-based position in the public visible queue. Values outside the queue clamp to an end. + Position int64 `json:"position"` } -// Path to test for existence in the client-provided session filesystem. -// Experimental: SessionFsExistsRequest is part of an experimental API and may change or be +// Result of inserting a queued message. +// Experimental: QueueInsertAtResult is part of an experimental API and may change or be // removed. -type SessionFsExistsRequest struct { - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +type QueueInsertAtResult struct { + // Fresh stable opaque id assigned to the inserted item. + ID string `json:"id"` } -// Indicates whether the requested path exists in the client-provided session filesystem. -// Experimental: SessionFsExistsResult is part of an experimental API and may change or be +// Serializable message fields accepted by queue.insertAt. +// Experimental: QueueInsertMessage is part of an experimental API and may change or be // removed. -type SessionFsExistsResult struct { - // Whether the path exists - Exists bool `json:"exists"` +type QueueInsertMessage struct { + // Optional explicit agent mode. When omitted, the session's current mode is assigned. + AgentMode *SendAgentMode `json:"agentMode,omitempty"` + // Optional attachments for the message. + Attachments []Attachment `json:"attachments,omitzero"` + // Whether the message is billable. + Billable *bool `json:"billable,omitempty"` + // Accepted for internal SendOptions compatibility but ignored; delivery is derived from + // current session activity. + Delivery *string `json:"delivery,omitempty"` + // Optional user-facing display text. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Accepted for SendOptions compatibility but ignored; inserted items always use queued + // delivery semantics. + Mode *SendMode `json:"mode,omitempty"` + // Accepted for SendOptions compatibility but ignored; the requested public position + // controls placement. + Prepend *bool `json:"prepend,omitempty"` + // The user message text. + Prompt string `json:"prompt"` + // Per-turn request headers. + RequestHeaders map[string]string `json:"requestHeaders,omitzero"` + // Required tool name for the turn, when any. + RequiredTool *string `json:"requiredTool,omitempty"` + // Optional provenance source. `system` is rejected: it would hide the inserted row from + // `pendingItems` and make it unaddressable while still executing, so inserted items must + // stay visible. + Source *string `json:"source,omitempty"` + // Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by + // the queue drain state. + Wait *bool `json:"wait,omitempty"` } -// Directory path to create in the client-provided session filesystem, with options for -// recursive creation and POSIX mode. -// Experimental: SessionFsMkdirRequest is part of an experimental API and may change or be +// Parameters for moving a queued item by stable id. +// Experimental: QueueMoveItemRequest is part of an experimental API and may change or be // removed. -type SessionFsMkdirRequest struct { - // Optional POSIX-style mode for newly created directories - Mode *int64 `json:"mode,omitempty"` - // Path using SessionFs conventions - Path string `json:"path"` - // Create parent directories as needed - Recursive *bool `json:"recursive,omitempty"` - // Target session identifier - SessionID string `json:"sessionId"` +type QueueMoveItemRequest struct { + // Stable opaque queued-item id. + ID string `json:"id"` + // Zero-based target position in the public visible queue. Values outside the queue clamp to + // an end. + ToPosition int64 `json:"toPosition"` } -// Directory path whose entries should be listed from the client-provided session filesystem. -// Experimental: SessionFsReaddirRequest is part of an experimental API and may change or be +// Result of moving a queued item. +// Experimental: QueueMoveItemResult is part of an experimental API and may change or be // removed. -type SessionFsReaddirRequest struct { - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +type QueueMoveItemResult struct { + // True when the item changed position; false when it was already at the requested position. + Changed bool `json:"changed"` } -// Names of entries in the requested directory, or a filesystem error if the read failed. -// Experimental: SessionFsReaddirResult is part of an experimental API and may change or be +// User-facing pending queue entry, with kind and display text for a queued message, slash +// command, or model change. +// Experimental: QueuePendingItems is part of an experimental API and may change or be // removed. -type SessionFsReaddirResult struct { - // Entry names in the directory - Entries []string `json:"entries"` - // Describes a filesystem error. - Error *SessionFsError `json:"error,omitempty"` +type QueuePendingItems struct { + // Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an + // explicit mode report interactive. This is not necessarily the mode that will constrain + // the turn: a plan or autopilot session applies its own write gate, continuation loop and + // permission posture to every drained item regardless of the mode stored here. + AgentMode SendAgentMode `json:"agentMode"` + // Human-readable text to display for this queue entry in the UI + DisplayText string `json:"displayText"` + // Stable opaque id for the canonical queued item. Batch rows share one id. + ID string `json:"id"` + // Whether this item is a queued user message or a queued slash command / model change + Kind QueuePendingItemsKind `json:"kind"` } -// Schema for the `SessionFsReaddirWithTypesEntry` type. -// Experimental: SessionFsReaddirWithTypesEntry is part of an experimental API and may -// change or be removed. -type SessionFsReaddirWithTypesEntry struct { - // Entry name - Name string `json:"name"` - // Entry type - Type SessionFsReaddirWithTypesEntryType `json:"type"` +// Snapshot of the session's pending queued items and immediate-steering messages. +// Experimental: QueuePendingItemsResult is part of an experimental API and may change or be +// removed. +type QueuePendingItemsResult struct { + // Pending queued items in submission order. Includes user messages, queued slash commands, + // and queued model changes; omits internal system items. + Items []QueuePendingItems `json:"items"` + // Display text for messages currently in the immediate steering queue (interjections sent + // during a running turn). + SteeringMessages []string `json:"steeringMessages"` } -// Directory path whose entries (with type information) should be listed from the -// client-provided session filesystem. -// Experimental: SessionFsReaddirWithTypesRequest is part of an experimental API and may -// change or be removed. -type SessionFsReaddirWithTypesRequest struct { - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +// Parameters for removing a queued item by stable id. +// Experimental: QueueRemoveAtRequest is part of an experimental API and may change or be +// removed. +type QueueRemoveAtRequest struct { + ID string `json:"id"` } -// Entries in the requested directory paired with file/directory type information, or a -// filesystem error if the read failed. -// Experimental: SessionFsReaddirWithTypesResult is part of an experimental API and may -// change or be removed. -type SessionFsReaddirWithTypesResult struct { - // Directory entries with type information - Entries []SessionFsReaddirWithTypesEntry `json:"entries"` - // Describes a filesystem error. - Error *SessionFsError `json:"error,omitempty"` +// Result of removing a queued item. +// Experimental: QueueRemoveAtResult is part of an experimental API and may change or be +// removed. +type QueueRemoveAtResult struct { + // True when the addressed item was removed. + Removed bool `json:"removed"` } -// Path of the file to read from the client-provided session filesystem. -// Experimental: SessionFsReadFileRequest is part of an experimental API and may change or -// be removed. -type SessionFsReadFileRequest struct { - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +// Indicates whether a user-facing pending item was removed. +// Experimental: QueueRemoveMostRecentResult is part of an experimental API and may change +// or be removed. +type QueueRemoveMostRecentResult struct { + // True if a user-facing pending item was removed (LIFO across both queues); false when no + // removable items remained. + Removed bool `json:"removed"` } -// File content as a UTF-8 string, or a filesystem error if the read failed. -// Experimental: SessionFsReadFileResult is part of an experimental API and may change or be +// Parameters for steering a queued message into a live turn. +// Experimental: QueueSendNowRequest is part of an experimental API and may change or be // removed. -type SessionFsReadFileResult struct { - // File content as UTF-8 string - Content string `json:"content"` - // Describes a filesystem error. - Error *SessionFsError `json:"error,omitempty"` +type QueueSendNowRequest struct { + ID string `json:"id"` } -// Source and destination paths for renaming or moving an entry in the client-provided -// session filesystem. -// Experimental: SessionFsRenameRequest is part of an experimental API and may change or be +// Result of trying to steer a queued message into a live turn. +// Experimental: QueueSendNowResult is part of an experimental API and may change or be // removed. -type SessionFsRenameRequest struct { - // Destination path using SessionFs conventions - Dest string `json:"dest"` - // Target session identifier - SessionID string `json:"sessionId"` - // Source path using SessionFs conventions - Src string `json:"src"` +type QueueSendNowResult struct { + // True when the item was accepted into the steering lane; false when no main turn was live. + Steered bool `json:"steered"` +} + +// Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is +// exclusive and non-idempotent: `paused: true` against an already-paused session fails with +// `queue_already_paused`. The pause is never released automatically — it is not tied to the +// caller's lifetime, so a client that exits without sending `paused: false` leaves the lane +// frozen. Release is unowned: `paused: false` clears the pause for any caller, including +// one that never acquired it. +// Experimental: QueueSetDrainPausedRequest is part of an experimental API and may change or +// be removed. +type QueueSetDrainPausedRequest struct { + Paused bool `json:"paused"` } -// Path to remove from the client-provided session filesystem, with options for recursive -// removal and force. -// Experimental: SessionFsRmRequest is part of an experimental API and may change or be +// Internal snapshot of native queue state for local session orchestration. +// Experimental: QueueSnapshotResult is part of an experimental API and may change or be // removed. -type SessionFsRmRequest struct { - // Ignore errors if the path does not exist - Force *bool `json:"force,omitempty"` - // Path using SessionFs conventions - Path string `json:"path"` - // Remove directories and their contents recursively - Recursive *bool `json:"recursive,omitempty"` - // Target session identifier - SessionID string `json:"sessionId"` +type QueueSnapshotResult struct { + // Insertion orders for queued items, aligned with `items`. + ItemOrders []int64 `json:"itemOrders,omitzero"` + // User-facing pending items in FIFO order. + Items []QueuePendingItems `json:"items"` + // Insertion orders for immediate steering messages, aligned with `steeringMessages`. + SteeringMessageOrders []int64 `json:"steeringMessageOrders,omitzero"` + // Immediate steering messages waiting for an active turn. + SteeringMessages []string `json:"steeringMessages"` } -// Optional capabilities declared by the provider -type SessionFsSetProviderCapabilities struct { - // Whether the provider supports SQLite query/exists operations - Sqlite *bool `json:"sqlite,omitempty"` +// Parameters for editing a single queued message. +// Experimental: QueueUpdateTextRequest is part of an experimental API and may change or be +// removed. +type QueueUpdateTextRequest struct { + DisplayPrompt *string `json:"displayPrompt,omitempty"` + ID string `json:"id"` + Prompt string `json:"prompt"` } -// Initial working directory, session-state path layout, and path conventions used to -// register the calling SDK client as the session filesystem provider. -type SessionFsSetProviderRequest struct { - // Optional capabilities declared by the provider - Capabilities *SessionFsSetProviderCapabilities `json:"capabilities,omitempty"` - // Path conventions used by this filesystem - Conventions SessionFsSetProviderConventions `json:"conventions"` - // Initial working directory for sessions - InitialCwd string `json:"initialCwd"` - // Path within each session's SessionFs where the runtime stores files for that session - SessionStatePath string `json:"sessionStatePath"` +// Result of editing a queued message. +// Experimental: QueueUpdateTextResult is part of an experimental API and may change or be +// removed. +type QueueUpdateTextResult struct { + // True when the stored text changed. + Updated bool `json:"updated"` } -// Indicates whether the calling client was registered as the session filesystem provider. -type SessionFsSetProviderResult struct { - // Whether the provider was set successfully - Success bool `json:"success"` +// Event type to register consumer interest for, used by runtime gating logic. +// Experimental: RegisterEventInterestParams is part of an experimental API and may change +// or be removed. +type RegisterEventInterestParams struct { + // The event type the consumer wants the runtime to treat as 'observed' for + // behavior-switching gating. Some runtime code paths inspect whether any consumer is + // interested in a specific event type and choose a different implementation accordingly + // (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive + // OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest + // is registered the runtime still attempts non-interactive reconnect from cached or + // refreshable tokens, and only marks the server `needs-auth` if usable credentials are + // unavailable — it does not open a browser or start interactive OAuth without a consumer). + // SDK clients that long-poll events do NOT automatically appear as listeners to these + // gating checks — they must explicitly call `registerInterest` for each event type they + // want the runtime to count as having a consumer. Multiple registrations for the same event + // type from the same or different consumers are tracked independently and must each be + // released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, + // `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, + // `command.queued`, `exit_plan_mode.requested`. + EventType string `json:"eventType"` } -// Identifies the target session. -// Experimental: SessionFsSqliteExistsRequest is part of an experimental API and may change +// Opaque handle representing an event-type interest registration. +// Experimental: RegisterEventInterestResult is part of an experimental API and may change // or be removed. -type SessionFsSqliteExistsRequest struct { - // Target session identifier - SessionID string `json:"sessionId"` +type RegisterEventInterestResult struct { + // Opaque handle for this registration. Pass to releaseInterest to release. Each call to + // registerInterest produces a fresh handle, even when the same eventType is registered + // multiple times. + Handle string `json:"handle"` } -// Indicates whether the per-session SQLite database already exists. -// Experimental: SessionFsSqliteExistsResult is part of an experimental API and may change -// or be removed. -type SessionFsSqliteExistsResult struct { - // Whether the session database already exists - Exists bool `json:"exists"` +// Experimental: RegisterExtensionLaunchProviderResult is part of an experimental API and +// may change or be removed. +type RegisterExtensionLaunchProviderResult struct { } -// SQL query, query type, and optional bind parameters for executing a SQLite query against -// the per-session database. -// Experimental: SessionFsSqliteQueryRequest is part of an experimental API and may change +// Params to attach an extension loader's tools to a session. +// Experimental: RegisterExtensionToolsParams is part of an experimental API and may change // or be removed. -type SessionFsSqliteQueryRequest struct { - // Optional named bind parameters - Params map[string]any `json:"params,omitempty"` - // SQL query to execute - Query string `json:"query"` - // How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT - // (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) - QueryType SessionFsSqliteQueryType `json:"queryType"` - // Target session identifier +// Internal: RegisterExtensionToolsParams is an internal SDK API and is not part of the +// public surface. +type RegisterExtensionToolsParams struct { + // In-process ExtensionLoader handle (CLI-only optimization). Marked internal: this field is + // excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, + // extension discovery/launch moves entirely into the runtime — the CLI passes pure config + // (search paths, disabled ids) via SessionOptions instead. + // Internal: Loader is part of the SDK's internal API surface and is not intended for + // external use. + Loader any `json:"loader"` + // Optional registration options. + Options *SessionsRegisterExtensionToolsOnSessionOptions `json:"options,omitempty"` + // Session to register extension tools on. SessionID string `json:"sessionId"` } -// Query results including rows, columns, and rows affected, or a filesystem error if -// execution failed. -// Experimental: SessionFsSqliteQueryResult is part of an experimental API and may change or +// Handle for releasing the extension tool registration. +// Experimental: RegisterExtensionToolsResult is part of an experimental API and may change +// or be removed. +// Internal: RegisterExtensionToolsResult is an internal SDK API and is not part of the +// public surface. +type RegisterExtensionToolsResult struct { + // In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an + // explicit `extensions.unregister` RPC in the SDK migration. + // Internal: Unsubscribe is part of the SDK's internal API surface and is not intended for + // external use. + Unsubscribe any `json:"unsubscribe"` +} + +// Opaque handle previously returned by `registerInterest` to release. +// Experimental: ReleaseEventInterestParams is part of an experimental API and may change or // be removed. -type SessionFsSqliteQueryResult struct { - // Column names from the result set - Columns []string `json:"columns"` - // Describes a filesystem error. - Error *SessionFsError `json:"error,omitempty"` - // SQLite last_insert_rowid() value for INSERT. - LastInsertRowid *int64 `json:"lastInsertRowid,omitempty"` - // For SELECT: array of row objects. For others: empty array. - Rows []map[string]any `json:"rows"` - // Number of rows affected (for INSERT/UPDATE/DELETE) - RowsAffected int64 `json:"rowsAffected"` +type ReleaseEventInterestParams struct { + // Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown + // or already-released handle is a no-op (returns success). When the last outstanding handle + // for an event type is released, the runtime reverts to its 'no consumer' code path for + // that event type. + Handle string `json:"handle"` } -// Path whose metadata should be returned from the client-provided session filesystem. -// Experimental: SessionFsStatRequest is part of an experimental API and may change or be +// Configuration for the runtime-managed remote-control singleton. +// Experimental: RemoteControlConfig is part of an experimental API and may change or be // removed. -type SessionFsStatRequest struct { - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +type RemoteControlConfig struct { + // Reattach to an existing MC session without creating a new one. + ExistingMcSession *RemoteControlConfigExistingMcSession `json:"existingMcSession,omitempty"` + // Whether the user explicitly requested remote (vs. implicit session-sync). Controls + // warning surfacing for missing-repo cases. + Explicit bool `json:"explicit"` + // Whether remote export should be enabled. + Remote bool `json:"remote"` + // When true, suppresses timeline messages on successful setup. + Silent bool `json:"silent"` + // Whether the MC session may steer the local session (write mode). + Steerable bool `json:"steerable"` + // Existing Mission Control task ID to attach the exported session to. + TaskID *string `json:"taskId,omitempty"` +} + +// Reattach to an existing MC session without creating a new one. +// Experimental: RemoteControlConfigExistingMcSession is part of an experimental API and may +// change or be removed. +type RemoteControlConfigExistingMcSession struct { + // Existing MC session ID to reattach to. + McSessionID string `json:"mcSessionId"` + // Existing MC task ID for the reattached session. + McTaskID string `json:"mcTaskId"` } -// Filesystem metadata for the requested path, or a filesystem error if the stat failed. -// Experimental: SessionFsStatResult is part of an experimental API and may change or be +// State of the runtime-managed remote-control singleton. +// Experimental: RemoteControlStatus is part of an experimental API and may change or be // removed. -type SessionFsStatResult struct { - // ISO 8601 timestamp of creation - Birthtime time.Time `json:"birthtime"` - // Describes a filesystem error. - Error *SessionFsError `json:"error,omitempty"` - // Whether the path is a directory - IsDirectory bool `json:"isDirectory"` - // Whether the path is a file - IsFile bool `json:"isFile"` - // ISO 8601 timestamp of last modification - Mtime time.Time `json:"mtime"` - // File size in bytes - Size int64 `json:"size"` +type RemoteControlStatus interface { + remoteControlStatus() + State() RemoteControlStatusState } -// File path, content to write, and optional mode for the client-provided session filesystem. -// Experimental: SessionFsWriteFileRequest is part of an experimental API and may change or +type RawRemoteControlStatusData struct { + Discriminator RemoteControlStatusState + Raw json.RawMessage +} + +func (RawRemoteControlStatusData) remoteControlStatus() {} +func (r RawRemoteControlStatusData) State() RemoteControlStatusState { + return r.Discriminator +} + +// Remote control is connected to a local session. +// Experimental: RemoteControlStatusActive is part of an experimental API and may change or // be removed. -type SessionFsWriteFileRequest struct { - // Content to write - Content string `json:"content"` - // Optional POSIX-style mode for newly created files - Mode *int64 `json:"mode,omitempty"` - // Path using SessionFs conventions - Path string `json:"path"` - // Target session identifier - SessionID string `json:"sessionId"` +type RemoteControlStatusActive struct { + // Session id remote control is pointed at. + AttachedSessionID string `json:"attachedSessionId"` + // True while a read-only/session-sync export is deferred, awaiting the first `user.message` + // before its MC session exists. Marked internal: this field is excluded from the public SDK + // surface and is populated only on the CLI in-process path. + // Internal: AwaitingFirstMessage is part of the SDK's internal API surface and is not + // intended for external use. + AwaitingFirstMessage *bool `json:"awaitingFirstMessage,omitempty"` + // MC frontend URL for this session, when known. + FrontendURL *string `json:"frontendUrl,omitempty"` + // Whether the MC session may steer this session. + IsSteerable bool `json:"isSteerable"` + // In-process prompt-manager handle (CLI-only optimization). Marked internal: this field is + // excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, + // the same bidirectional prompt-routing handshake is expressed via dedicated remote-control + // RPCs (register/resolve) rather than a shared in-process object. + // Internal: PromptManager is part of the SDK's internal API surface and is not intended for + // external use. + PromptManager any `json:"promptManager,omitempty"` } -// Schema for the `SessionInstalledPlugin` type. -// Experimental: SessionInstalledPlugin is part of an experimental API and may change or be -// removed. -type SessionInstalledPlugin struct { - // Path where the plugin is cached locally - CachePath *string `json:"cache_path,omitempty"` - // Whether the plugin is currently enabled - Enabled bool `json:"enabled"` - // Installation timestamp (ISO-8601) - InstalledAt string `json:"installed_at"` - // Marketplace the plugin came from (empty string for direct repo installs) - Marketplace string `json:"marketplace"` - // Plugin name - Name string `json:"name"` - // Source descriptor for direct repo installs (when marketplace is empty) - Source *SessionInstalledPluginSource `json:"source,omitempty"` - // Installed version, if known - Version *string `json:"version,omitempty"` +func (RemoteControlStatusActive) remoteControlStatus() {} +func (RemoteControlStatusActive) State() RemoteControlStatusState { + return RemoteControlStatusStateActive } -// Source descriptor for direct repo installs (when marketplace is empty) -// Experimental: SessionInstalledPluginSource is part of an experimental API and may change +// Remote control is in the middle of initial setup. +// Experimental: RemoteControlStatusConnecting is part of an experimental API and may change // or be removed. -type SessionInstalledPluginSource struct { - SessionInstalledPluginSourceGithub *SessionInstalledPluginSourceGithub - SessionInstalledPluginSourceLocal *SessionInstalledPluginSourceLocal - SessionInstalledPluginSourceURL *SessionInstalledPluginSourceURL - String *string +type RemoteControlStatusConnecting struct { + // Session id the connection is attaching to. + AttachedSessionID string `json:"attachedSessionId"` } -// Schema for the `SessionInstalledPluginSourceGithub` type. -// Experimental: SessionInstalledPluginSourceGithub is part of an experimental API and may -// change or be removed. -type SessionInstalledPluginSourceGithub struct { - Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` - Repo string `json:"repo"` - // Constant value. Always "github". - Source SessionInstalledPluginSourceGithubSource `json:"source"` +func (RemoteControlStatusConnecting) remoteControlStatus() {} +func (RemoteControlStatusConnecting) State() RemoteControlStatusState { + return RemoteControlStatusStateConnecting } -// Schema for the `SessionInstalledPluginSourceLocal` type. -// Experimental: SessionInstalledPluginSourceLocal is part of an experimental API and may -// change or be removed. -type SessionInstalledPluginSourceLocal struct { - Path string `json:"path"` - // Constant value. Always "local". - Source SessionInstalledPluginSourceLocalSource `json:"source"` +// The last setup attempt failed. The singleton is otherwise off. +// Experimental: RemoteControlStatusError is part of an experimental API and may change or +// be removed. +type RemoteControlStatusError struct { + // Session id the failing setup attempt targeted, when known. + AttachedSessionID *string `json:"attachedSessionId,omitempty"` + // Human-readable error message from the last setup attempt. + Error string `json:"error"` } -// Schema for the `SessionInstalledPluginSourceUrl` type. -// Experimental: SessionInstalledPluginSourceURL is part of an experimental API and may -// change or be removed. -type SessionInstalledPluginSourceURL struct { - Path *string `json:"path,omitempty"` - Ref *string `json:"ref,omitempty"` - // Constant value. Always "url". - Source SessionInstalledPluginSourceURLSource `json:"source"` - URL string `json:"url"` +func (RemoteControlStatusError) remoteControlStatus() {} +func (RemoteControlStatusError) State() RemoteControlStatusState { + return RemoteControlStatusStateError } -// Persisted sessions matching the filter, ordered most-recently-modified first. -// Experimental: SessionList is part of an experimental API and may change or be removed. -type SessionList struct { - // Sessions ordered most-recently-modified first - Sessions []SessionMetadata `json:"sessions"` +// Remote control is not connected. +// Experimental: RemoteControlStatusOff is part of an experimental API and may change or be +// removed. +type RemoteControlStatusOff struct { } -// Optional filter applied to the returned sessions -// Experimental: SessionListFilter is part of an experimental API and may change or be +func (RemoteControlStatusOff) remoteControlStatus() {} +func (RemoteControlStatusOff) State() RemoteControlStatusState { + return RemoteControlStatusStateOff +} + +// Wrapper for the singleton's current status. +// Experimental: RemoteControlStatusResult is part of an experimental API and may change or +// be removed. +type RemoteControlStatusResult struct { + // State of the runtime-managed remote-control singleton. + Status RemoteControlStatus `json:"status"` +} + +// Outcome of a stopRemoteControl call. +// Experimental: RemoteControlStopResult is part of an experimental API and may change or be // removed. -type SessionListFilter struct { - // Match sessions whose context.branch equals this value - Branch *string `json:"branch,omitempty"` - // Match sessions whose context.cwd equals this value - Cwd *string `json:"cwd,omitempty"` - // Match sessions whose context.gitRoot equals this value - GitRoot *string `json:"gitRoot,omitempty"` - // Match sessions whose context.repository equals this value - Repository *string `json:"repository,omitempty"` +type RemoteControlStopResult struct { + // State of the runtime-managed remote-control singleton. + Status RemoteControlStatus `json:"status"` + // Whether the singleton was actually torn down by this call. + Stopped bool `json:"stopped"` } -// Queued repo-level startup prompts and the total hook command count after loading. -// Experimental: SessionLoadDeferredRepoHooksResult is part of an experimental API and may +// Outcome of a transferRemoteControl call. +// Experimental: RemoteControlTransferResult is part of an experimental API and may change +// or be removed. +type RemoteControlTransferResult struct { + // State of the runtime-managed remote-control singleton. + Status RemoteControlStatus `json:"status"` + // Whether the rebinding actually happened. + Transferred bool `json:"transferred"` +} + +// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export +// and remote steering. +// Experimental: RemoteEnableRequest is part of an experimental API and may change or be +// removed. +type RemoteEnableRequest struct { + // Per-session remote mode. "off" disables remote, "export" exports session events to GitHub + // without enabling remote steering, "on" enables both export and remote steering. + Mode *RemoteSessionMode `json:"mode,omitempty"` +} + +// GitHub URL for the session and a flag indicating whether remote steering is enabled. +// Experimental: RemoteEnableResult is part of an experimental API and may change or be +// removed. +type RemoteEnableResult struct { + // Whether remote steering is enabled + RemoteSteerable bool `json:"remoteSteerable"` + // GitHub frontend URL for this session + URL *string `json:"url,omitempty"` +} + +// New remote-steerability state to persist as a `session.remote_steerable_changed` event. +// Experimental: RemoteNotifySteerableChangedRequest is part of an experimental API and may // change or be removed. -type SessionLoadDeferredRepoHooksResult struct { - // Total hook command count (user + plugin + repo) loaded for the session by this call. - // Captured atomically with startupPrompts so callers don't need to read a separate counter. - HookCount int64 `json:"hookCount"` - // Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo - // configs were pending, or when disableAllHooks is set. - StartupPrompts []string `json:"startupPrompts"` +type RemoteNotifySteerableChangedRequest struct { + // Whether the session now supports remote steering via GitHub. The runtime persists this as + // a `session.remote_steerable_changed` event so resume/replay sees the up-to-date + // capability. + RemoteSteerable bool `json:"remoteSteerable"` } -// Experimental: SessionLspInitializeResult is part of an experimental API and may change or -// be removed. -type SessionLspInitializeResult struct { +// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the +// host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a +// remote exporter that the runtime does not directly own. +// Experimental: RemoteNotifySteerableChangedResult is part of an experimental API and may +// change or be removed. +type RemoteNotifySteerableChangedResult struct { } -// Standard MCP CallToolResult -// Experimental: SessionMcpAppsCallToolResult is part of an experimental API and may change +// Remote session connection result. +// Experimental: RemoteSessionConnectionResult is part of an experimental API and may change // or be removed. -type SessionMcpAppsCallToolResult map[string]any +type RemoteSessionConnectionResult struct { + // Metadata for a connected remote session. + Metadata ConnectedRemoteSessionMetadata `json:"metadata"` + // SDK session ID for the connected remote session. + SessionID string `json:"sessionId"` +} -// Experimental: SessionMcpAppsSetHostContextResult is part of an experimental API and may +// GitHub repository the remote session belongs to. +// Experimental: RemoteSessionMetadataRepository is part of an experimental API and may // change or be removed. -type SessionMcpAppsSetHostContextResult struct { +type RemoteSessionMetadataRepository struct { + // Branch associated with the remote session. + Branch string `json:"branch"` + // Repository name. + Name string `json:"name"` + // Repository owner. + Owner string `json:"owner"` } -// Experimental: SessionMcpDisableResult is part of an experimental API and may change or be +// Repository context for the remote session. +// Experimental: RemoteSessionRepository is part of an experimental API and may change or be // removed. -type SessionMcpDisableResult struct { +type RemoteSessionRepository struct { + // Optional branch associated with the remote session. + Branch *string `json:"branch,omitempty"` + // Repository name. + Name string `json:"name"` + // Repository owner or organization login. + Owner string `json:"owner"` } -// Experimental: SessionMcpEnableResult is part of an experimental API and may change or be +// Options controlling factory invocation. +// Experimental: RunOptions is part of an experimental API and may change or be removed. +type RunOptions struct { + // Per-invocation resource ceiling overrides. + Limits *FactoryRunLimits `json:"limits,omitempty"` + // Run identifier whose journal and progress should seed this resumed run. + ResumeFromRunID *string `json:"resumeFromRunId,omitempty"` +} + +// Experimental: RuntimeShutdownResult is part of an experimental API and may change or be // removed. -type SessionMcpEnableResult struct { +type RuntimeShutdownResult struct { +} + +// Resolved sandbox configuration. +// Experimental: SandboxConfig is part of an experimental API and may change or be removed. +type SandboxConfig struct { + // Whether to auto-add the current working directory to readwritePaths. Default: true. + AddCurrentWorkingDirectory *bool `json:"addCurrentWorkingDirectory,omitempty"` + // Whether to auto-grant read access to common developer-tool caches, registries, and + // toolchains in their default home locations (cargo, go, npm, Maven, and more), plus + // read-write access to (and, on Unix, up-front creation of) the scratch caches builds write + // on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so + // builds work without extra configuration; a relocated CARGO_HOME additionally gets its + // Cargo lock files granted read-write. Default: true (enabled by default; set to false to + // opt out). + AllowDevToolAccess *bool `json:"allowDevToolAccess,omitempty"` + // Credential-injection capability flags. + Auth *SandboxConfigAuth `json:"auth,omitempty"` + // Whether sandboxing is enabled for the session. + Enabled bool `json:"enabled"` + // User-managed sandbox policy fragment merged into the auto-discovered base policy. + UserPolicy *SandboxConfigUserPolicy `json:"userPolicy,omitempty"` } -// Experimental: SessionMcpReloadResult is part of an experimental API and may change or be +// Credential-injection capability flags applied while the sandbox is enabled. +// Experimental: SandboxConfigAuth is part of an experimental API and may change or be +// removed. +type SandboxConfigAuth struct { + // Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the + // OS keyring the sandbox blocks. Default: false (opt-in). + Gh *bool `json:"gh,omitempty"` + // Whether to inject git credentials as an `http..extraheader` so authenticated HTTPS + // git works inside the sandbox without the shell-based credential helper the sandbox + // blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, + // GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's + // own helper before the sandbox is applied. Default: false (opt-in). + Git *bool `json:"git,omitempty"` +} + +// User-managed sandbox policy fragment merged into the auto-discovered base policy. +// Experimental: SandboxConfigUserPolicy is part of an experimental API and may change or be // removed. -type SessionMcpReloadResult struct { +type SandboxConfigUserPolicy struct { + // Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is + // absent. + Experimental *SandboxConfigUserPolicyExperimental `json:"experimental,omitempty"` + // Filesystem rules to merge into the base policy. + Filesystem *SandboxConfigUserPolicyFilesystem `json:"filesystem,omitempty"` + // Network rules to merge into the base policy. + Network *SandboxConfigUserPolicyNetwork `json:"network,omitempty"` + // macOS seatbelt options to merge into the base policy. + Seatbelt *SandboxConfigUserPolicySeatbelt `json:"seatbelt,omitempty"` +} + +// Platform-specific experimental policy fields. +// Experimental: SandboxConfigUserPolicyExperimental is part of an experimental API and may +// change or be removed. +type SandboxConfigUserPolicyExperimental struct { + // macOS seatbelt experimental options. + Seatbelt *SandboxConfigUserPolicyExperimentalSeatbelt `json:"seatbelt,omitempty"` } -// Schema for the `SessionMetadata` type. -// Experimental: SessionMetadata is part of an experimental API and may change or be removed. -type SessionMetadata struct { - // Runtime client name that created/last resumed this session - ClientName *string `json:"clientName,omitempty"` - // Schema for the `SessionContext` type. - Context *SessionContext `json:"context,omitempty"` - // True for detached maintenance sessions that should be hidden from normal resume lists. - IsDetached *bool `json:"isDetached,omitempty"` - // True for remote (GitHub) sessions; false for local - IsRemote bool `json:"isRemote"` - // GitHub task ID, when this local session is bound to one. Only present for local sessions - // exported to remote control. - McTaskID *string `json:"mcTaskId,omitempty"` - // Last-modified time of the session's persisted state, as ISO 8601 - ModifiedTime string `json:"modifiedTime"` - // Optional human-friendly name set via /rename - Name *string `json:"name,omitempty"` - // Stable session identifier - SessionID string `json:"sessionId"` - // Session creation time as an ISO 8601 timestamp - StartTime string `json:"startTime"` - // Short summary of the session, when one has been derived - Summary *string `json:"summary,omitempty"` -} - -// Point-in-time snapshot of slow-changing session identifier and state fields -// Experimental: SessionMetadataSnapshot is part of an experimental API and may change or be -// removed. -type SessionMetadataSnapshot struct { - // True when the session was detected to be in use by another process at construction time. - // Local consumers may surface a confirmation prompt before fully attaching. Always false - // for new sessions. - AlreadyInUse bool `json:"alreadyInUse"` - // Runtime client name associated with the session (telemetry identifier). - ClientName *string `json:"clientName,omitempty"` - // The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') - CurrentMode MetadataSnapshotCurrentMode `json:"currentMode"` - // User-provided name supplied at session construction (via `--name`), if any. Immutable - // after construction. - InitialName *string `json:"initialName,omitempty"` - // Whether this is a remote session (i.e., one whose runtime executes elsewhere and is - // steered through this process) - IsRemote bool `json:"isRemote"` - // ISO 8601 timestamp of when the session's persisted state was last modified on disk. For - // new sessions, equals startTime. For resumed sessions, reflects the previous modification - // time at construction. - ModifiedTime time.Time `json:"modifiedTime"` - // Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are - // immutable for the lifetime of the session. - RemoteMetadata *MetadataSnapshotRemoteMetadata `json:"remoteMetadata,omitempty"` - // Currently selected model identifier, if any - SelectedModel *string `json:"selectedModel,omitempty"` - // The unique identifier of the session - SessionID string `json:"sessionId"` - // ISO 8601 timestamp of when the session started - StartTime time.Time `json:"startTime"` - // Short human-readable summary of the session, if known. Omitted when no summary has been - // generated. - Summary *string `json:"summary,omitempty"` - // Absolute path to the session's current working directory - WorkingDirectory string `json:"workingDirectory"` - // Public-facing workspace metadata for this session, or null if the session has no - // associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, - // internal flags). - Workspace *WorkspaceSummary `json:"workspace,omitempty"` - // Absolute path to the session's workspace directory on disk, or null if the session has no - // associated workspace - WorkspacePath *string `json:"workspacePath"` +// macOS seatbelt experimental options. +// Experimental: SandboxConfigUserPolicyExperimentalSeatbelt is part of an experimental API +// and may change or be removed. +type SandboxConfigUserPolicyExperimentalSeatbelt struct { + // Whether the macOS seatbelt profile may access the keychain. + KeychainAccess *bool `json:"keychainAccess,omitempty"` } -// The list of models available to this session. -// Experimental: SessionModelList is part of an experimental API and may change or be -// removed. -type SessionModelList struct { - // Available models, ordered with the most preferred default first. - List []any `json:"list"` - // Per-quota snapshots returned alongside the model list, keyed by quota type. - QuotaSnapshots map[string]any `json:"quotaSnapshots,omitempty"` +// Filesystem rules to merge into the base policy. +// Experimental: SandboxConfigUserPolicyFilesystem is part of an experimental API and may +// change or be removed. +type SandboxConfigUserPolicyFilesystem struct { + // Whether to clear the policy when the session exits. + ClearPolicyOnExit *bool `json:"clearPolicyOnExit,omitempty"` + // Paths explicitly denied. + DeniedPaths []string `json:"deniedPaths,omitzero"` + // Paths granted read-only access. + ReadonlyPaths []string `json:"readonlyPaths,omitzero"` + // Paths granted read/write access. + ReadwritePaths []string `json:"readwritePaths,omitzero"` +} + +// Network rules to merge into the base policy. +// Experimental: SandboxConfigUserPolicyNetwork is part of an experimental API and may +// change or be removed. +type SandboxConfigUserPolicyNetwork struct { + // Whether traffic to local/loopback addresses is allowed. + AllowLocalNetwork *bool `json:"allowLocalNetwork,omitempty"` + // Whether outbound network traffic is allowed at all. + AllowOutbound *bool `json:"allowOutbound,omitempty"` + // HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and + // cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. + // Credentials go in the separate `username`/`password` fields. A credential-free http:// + // loopback proxy URL is routed through the localhost proxy automatically; an https:// or + // authenticated loopback URL is used as-is. + Proxy *SandboxConfigUserPolicyNetworkProxy `json:"proxy,omitempty"` +} + +// HTTP proxy configuration for sandboxed traffic. +// Experimental: SandboxConfigUserPolicyNetworkProxy is part of an experimental API and may +// change or be removed. +type SandboxConfigUserPolicyNetworkProxy struct { + // Optional password for proxy authentication, combined with the URL at spawn time. The + // persisted value may be a literal password, a `${secret:…}` reference resolved from the OS + // keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the + // sandboxed process routes through the proxy. The /sandbox dialog stores a real password in + // the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in + // settings.json); the field is masked in the dialog and redacted by /settings show. + Password *string `json:"password,omitempty"` + // Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the + // scheme's standard port when omitted. Credentials must not be embedded here — a + // `user:pass@` authority is rejected; put them in the separate `username`/`password` + // fields. A credential-free http:// loopback URL is routed through the localhost proxy + // automatically; loopback covers localhost and any *.localhost subdomain, the whole + // 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or + // one with a username/password set, is used as-is. + URL string `json:"url"` + // Optional username for proxy authentication. Combined with the URL (and `password`) into + // `user:pass@host` when the sandboxed process routes through the proxy. + Username *string `json:"username,omitempty"` } -// Experimental: SessionModeSetResult is part of an experimental API and may change or be -// removed. -type SessionModeSetResult struct { +// macOS seatbelt-specific options. +// Experimental: SandboxConfigUserPolicySeatbelt is part of an experimental API and may +// change or be removed. +type SandboxConfigUserPolicySeatbelt struct { + // Whether the macOS seatbelt profile may access the keychain. + KeychainAccess *bool `json:"keychainAccess,omitempty"` } -// Experimental: SessionNameSetResult is part of an experimental API and may change or be +// Register an absolute-time scheduled prompt. +// Experimental: ScheduleAddAtRequest is part of an experimental API and may change or be // removed. -type SessionNameSetResult struct { +type ScheduleAddAtRequest struct { + // Epoch milliseconds when the prompt should fire. + At int64 `json:"at"` + // Optional display-only prompt label. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Prompt text to enqueue when the schedule fires. + Prompt string `json:"prompt"` + // Whether the schedule should re-arm after each tick. Defaults to false. + Recurring *bool `json:"recurring,omitempty"` } -// Experimental: SessionPlanDeleteResult is part of an experimental API and may change or be +// Register a cron scheduled prompt. +// Experimental: ScheduleAddCronRequest is part of an experimental API and may change or be // removed. -type SessionPlanDeleteResult struct { +type ScheduleAddCronRequest struct { + // 5-field cron expression. + Cron string `json:"cron"` + // Optional display-only prompt label. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Prompt text to enqueue when the schedule fires. + Prompt string `json:"prompt"` + // Whether the schedule should re-arm after each tick. Defaults to true. + Recurring *bool `json:"recurring,omitempty"` + // IANA timezone for evaluating the cron expression. + Tz *string `json:"tz,omitempty"` } -// Experimental: SessionPlanUpdateResult is part of an experimental API and may change or be +// Register a relative-interval scheduled prompt. +// Experimental: ScheduleAddRequest is part of an experimental API and may change or be // removed. -type SessionPlanUpdateResult struct { +type ScheduleAddRequest struct { + // Optional display-only prompt label. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Human-readable interval such as `30s`, `5m`, or `2h`. + Interval string `json:"interval"` + // Prompt text to enqueue when the schedule fires. + Prompt string `json:"prompt"` + // Whether the schedule should re-arm after each tick. Defaults to true. + Recurring *bool `json:"recurring,omitempty"` } -// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes -// freed, and the dry-run flag. -// Experimental: SessionPruneResult is part of an experimental API and may change or be +// Result of registering or re-arming a scheduled prompt. +// Experimental: ScheduleAddResult is part of an experimental API and may change or be // removed. -type SessionPruneResult struct { - // Session IDs that would be deleted in dry-run mode (always empty otherwise) - Candidates []string `json:"candidates"` - // Session IDs that were deleted (always empty in dry-run mode) - Deleted []string `json:"deleted"` - // True when no deletions were actually performed - DryRun bool `json:"dryRun"` - // Total bytes freed (actual when not dry-run, projected when dry-run) - FreedBytes int64 `json:"freedBytes"` - // Session IDs that were skipped (e.g., named sessions) - Skipped []string `json:"skipped"` +type ScheduleAddResult struct { + // The registered or updated schedule entry. + Entry *ScheduleEntry `json:"entry,omitempty"` + // User-facing validation error, when registration failed. + Error *string `json:"error,omitempty"` } -// Experimental: SessionQueueClearResult is part of an experimental API and may change or be -// removed. -type SessionQueueClearResult struct { +// Register a self-paced scheduled prompt. +// Experimental: ScheduleAddSelfPacedRequest is part of an experimental API and may change +// or be removed. +type ScheduleAddSelfPacedRequest struct { + // Optional display-only prompt label. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Prompt text to enqueue when the schedule fires. + Prompt string `json:"prompt"` } -// Experimental: SessionRemoteDisableResult is part of an experimental API and may change or -// be removed. -type SessionRemoteDisableResult struct { +// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, +// recurrence, and next run time. +// Experimental: ScheduleEntry is part of an experimental API and may change or be removed. +type ScheduleEntry struct { + // Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. + At *int64 `json:"at,omitempty"` + // 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. + Cron *string `json:"cron,omitempty"` + // Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a + // skill-invocation schedule). The actual enqueued prompt is `prompt`. + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt + // from the event log). + ID int64 `json:"id"` + // Interval between scheduled ticks, in milliseconds (relative-interval schedules). + IntervalMs *int64 `json:"intervalMs,omitempty"` + // ISO 8601 timestamp when the next tick is scheduled to fire. + NextRunAt time.Time `json:"nextRunAt"` + // Prompt text that gets enqueued on every tick. + Prompt string `json:"prompt"` + // Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). + Recurring bool `json:"recurring"` + // True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next + // run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. + SelfPaced *bool `json:"selfPaced,omitempty"` + // IANA timezone the `cron` expression is evaluated in. + Tz *string `json:"tz,omitempty"` } -// Session IDs to close, deactivate, and delete from disk. -// Experimental: SessionsBulkDeleteRequest is part of an experimental API and may change or +// Whether the session currently has an active self-paced schedule. +// Experimental: ScheduleHasSelfPacedResult is part of an experimental API and may change or // be removed. -type SessionsBulkDeleteRequest struct { - // Session IDs to close, deactivate, and delete from disk - SessionIds []string `json:"sessionIds"` +type ScheduleHasSelfPacedResult struct { + // True when at least one active schedule is self-paced. + HasSelfPaced bool `json:"hasSelfPaced"` } -// Session IDs to test for live in-use locks. -// Experimental: SessionsCheckInUseRequest is part of an experimental API and may change or -// be removed. -type SessionsCheckInUseRequest struct { - // Session IDs to test for live in-use locks - SessionIds []string `json:"sessionIds"` +// Snapshot of the currently active recurring prompts for this session. +// Experimental: ScheduleList is part of an experimental API and may change or be removed. +type ScheduleList struct { + // Active scheduled prompts, ordered by id. + Entries []ScheduleEntry `json:"entries"` } -// Session IDs from the input set that are currently in use by another process. -// Experimental: SessionsCheckInUseResult is part of an experimental API and may change or -// be removed. -type SessionsCheckInUseResult struct { - // Session IDs from the input set that are currently held by another running process via an - // alive lock file - InUse []string `json:"inUse"` +// Re-arm a self-paced scheduled prompt. +// Experimental: ScheduleRearmSelfPacedRequest is part of an experimental API and may change +// or be removed. +type ScheduleRearmSelfPacedRequest struct { + // Epoch milliseconds when the prompt should next fire. + At int64 `json:"at"` + // Id of the self-paced scheduled prompt. + ID int64 `json:"id"` } -// Session ID to close. -// Experimental: SessionsCloseRequest is part of an experimental API and may change or be +// Identifier of the scheduled prompt to remove. +// Experimental: ScheduleStopRequest is part of an experimental API and may change or be // removed. -type SessionsCloseRequest struct { - // Session ID to close - SessionID string `json:"sessionId"` +type ScheduleStopRequest struct { + // Id of the scheduled prompt to remove. + ID int64 `json:"id"` } -// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use -// lock, disposes the active session. Idempotent: succeeds even if the session is not -// currently active. -// Experimental: SessionsCloseResult is part of an experimental API and may change or be +// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +// Experimental: ScheduleStopResult is part of an experimental API and may change or be // removed. -type SessionsCloseResult struct { -} - -// Session metadata records to enrich with summary and context information. -// Experimental: SessionsEnrichMetadataRequest is part of an experimental API and may change -// or be removed. -type SessionsEnrichMetadataRequest struct { - // Session metadata records to enrich. Records that already have summary and context are - // returned unchanged. - Sessions []SessionMetadata `json:"sessions"` -} - -// New auth credentials to install on the session. Omit to leave credentials unchanged. -// Experimental: SessionSetCredentialsParams is part of an experimental API and may change -// or be removed. -type SessionSetCredentialsParams struct { - // The new auth credentials to install on the session. When omitted or `undefined`, the call - // is a no-op and the session's existing credentials are preserved. The runtime stores the - // value verbatim and uses it for outbound model/API requests; it does NOT re-validate or - // re-fetch the associated Copilot user response. Several variants carry secret material; - // treat this method's params as containing secrets at rest and in transit. - Credentials AuthInfo `json:"credentials,omitempty"` +type ScheduleStopResult struct { + // The removed entry, or omitted if no entry matched. + Entry *ScheduleEntry `json:"entry,omitempty"` } -// Indicates whether the credential update succeeded. -// Experimental: SessionSetCredentialsResult is part of an experimental API and may change +// Secret values to add to the redaction filter. +// Experimental: SecretsAddFilterValuesRequest is part of an experimental API and may change // or be removed. -type SessionSetCredentialsResult struct { - // Whether the operation succeeded - Success bool `json:"success"` +type SecretsAddFilterValuesRequest struct { + // Raw secret values to register for redaction + Values []string `json:"values"` } -// UUID prefix to resolve to a unique session ID. -// Experimental: SessionsFindByPrefixRequest is part of an experimental API and may change +// Confirmation that the secret values were registered. +// Experimental: SecretsAddFilterValuesResult is part of an experimental API and may change // or be removed. -type SessionsFindByPrefixRequest struct { - // UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when - // there is no match or the prefix matches multiple sessions. - Prefix string `json:"prefix"` +type SecretsAddFilterValuesResult struct { + // Whether the values were successfully registered + Ok bool `json:"ok"` } -// Session ID matching the prefix, omitted when no unique match exists. -// Experimental: SessionsFindByPrefixResult is part of an experimental API and may change or -// be removed. -type SessionsFindByPrefixResult struct { - // Omitted when no unique session matches the prefix (no match or ambiguous) - SessionID *string `json:"sessionId,omitempty"` +// Parameters for session.extensions.sendAttachmentsToMessage. +// Experimental: SendAttachmentsToMessageParams is part of an experimental API and may +// change or be removed. +type SendAttachmentsToMessageParams struct { + // Attachments to push into the next user-message turn. extension_context entries take the + // slim shape; standard variants take their full AttachmentSchema shape. + Attachments []PushAttachment `json:"attachments"` + // Optional canvas instance binding the push for provenance. When supplied, the runtime + // resolves the canvas, verifies it is owned by the calling extension, and stamps + // canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs + // and those fields stay unset on the attachment. + InstanceID *string `json:"instanceId,omitempty"` +} + +// A single user message to append to the session as part of a `session.sendMessages` turn +// Experimental: SendMessageItem is part of an experimental API and may change or be removed. +type SendMessageItem struct { + // Optional attachments (files, directories, selections, blobs, GitHub references) to + // include with this message + Attachments []Attachment `json:"attachments,omitzero"` + // If false, this message will not trigger a Premium Request Unit charge. User messages + // default to billable. + // Internal: Billable is part of the SDK's internal API surface and is not intended for + // external use. + Billable *bool `json:"billable,omitempty"` + // If provided, this is shown in the timeline instead of `prompt` + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // The user message text + Prompt string `json:"prompt"` + // If set, the request will fail if the named tool is not available when this message is + // among the user messages at the start of the current exchange + RequiredTool *string `json:"requiredTool,omitempty"` + // Optional provenance tag copied to the resulting user.message event. Must be `user`, + // `system`, `command-` for command-originated messages, `schedule-` + // for scheduled prompts, or `agent-` for prompts sent by another agent. + // Internal: Source is part of the SDK's internal API surface and is not intended for + // external use. + Source *string `json:"source,omitempty"` } -// GitHub task ID to look up. -// Experimental: SessionsFindByTaskIDRequest is part of an experimental API and may change -// or be removed. -type SessionsFindByTaskIDRequest struct { - // GitHub task ID to look up - TaskID string `json:"taskId"` +// Parameters for sending zero or more user messages to the session in a single turn. +// Remote-backed (Mission Control) sessions do not support this method and will return an +// error. +// Experimental: SendMessagesRequest is part of an experimental API and may change or be +// removed. +type SendMessagesRequest struct { + // The UI mode the agent was in when these messages were sent. Defaults to the session's + // current mode. + AgentMode *SendAgentMode `json:"agentMode,omitempty"` + // The user messages to append to the conversation, in order. May be empty, in which case a + // single turn runs over the existing history with no new user message. + Messages []SendMessageItem `json:"messages"` + // How to deliver the messages. `enqueue` (default) appends to the message queue. + // `immediate` interjects during an in-progress turn. + Mode *SendMode `json:"mode,omitempty"` + // If true, adds the messages to the front of the queue instead of the end + Prepend *bool `json:"prepend,omitempty"` + // Custom HTTP headers to include in outbound model requests for this turn. Merged with + // session-level provider headers; per-turn headers augment and overwrite session-level + // headers with the same key. + RequestHeaders map[string]string `json:"requestHeaders,omitzero"` + // W3C Trace Context traceparent header for distributed tracing of this agent turn + Traceparent *string `json:"traceparent,omitempty"` + // W3C Trace Context tracestate header for distributed tracing + Tracestate *string `json:"tracestate,omitempty"` + // If true, await completion of the agentic loop for this turn before returning. Defaults to + // false (fire-and-forget). When true, the result still contains the same `messageIds`; the + // caller can rely on the agent having processed the messages before the call resolves. + // Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally + // blocks until the completed turn's event tail has been dispatched to this session's + // in-process subscribers, so a subsequent read of subscriber state already reflects the + // turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery + // follows over the wire. Callers that need the stronger local guarantee on remote sessions + // should await the event stream explicitly. + Wait *bool `json:"wait,omitempty"` } -// ID of the local session bound to the given GitHub task, or omitted when none. -// Experimental: SessionsFindByTaskIDResult is part of an experimental API and may change or -// be removed. -type SessionsFindByTaskIDResult struct { - // Omitted when no local session is bound to that GitHub task - SessionID *string `json:"sessionId,omitempty"` +// Result of sending zero or more user messages +// Experimental: SendMessagesResult is part of an experimental API and may change or be +// removed. +type SendMessagesResult struct { + // Unique identifiers assigned to the messages, one per provided message in order. Empty + // when no messages were provided. + MessageIDs []string `json:"messageIds"` } -// Source session identifier to fork from, optional event-ID boundary, and optional friendly -// name for the new session. -// Experimental: SessionsForkRequest is part of an experimental API and may change or be -// removed. -type SessionsForkRequest struct { - // Optional friendly name to assign to the forked session. - Name *string `json:"name,omitempty"` - // Source session ID to fork from - SessionID string `json:"sessionId"` - // Optional event ID boundary. When provided, the fork includes only events before this ID - // (exclusive). When omitted, all events are included. - ToEventID *string `json:"toEventId,omitempty"` -} - -// Identifier and optional friendly name assigned to the newly forked session. -// Experimental: SessionsForkResult is part of an experimental API and may change or be -// removed. -type SessionsForkResult struct { - // Friendly name assigned to the forked session, if any. - Name *string `json:"name,omitempty"` - // The new forked session's ID - SessionID string `json:"sessionId"` -} - -// Session ID whose event-log file path to compute. -// Experimental: SessionsGetEventFilePathRequest is part of an experimental API and may -// change or be removed. -type SessionsGetEventFilePathRequest struct { - // Session ID whose event-log file path to compute - SessionID string `json:"sessionId"` +// Parameters for sending a user message to the session +// Experimental: SendRequest is part of an experimental API and may change or be removed. +type SendRequest struct { + // The UI mode the agent was in when this message was sent. Defaults to the session's + // current mode. + AgentMode *SendAgentMode `json:"agentMode,omitempty"` + // Optional attachments (files, directories, selections, blobs, GitHub references) to + // include with the message + Attachments []Attachment `json:"attachments,omitzero"` + // If false, this message will not trigger a Premium Request Unit charge. User messages + // default to billable. + Billable *bool `json:"billable,omitempty"` + // If provided, this is shown in the timeline instead of `prompt` + DisplayPrompt *string `json:"displayPrompt,omitempty"` + // How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` + // interjects during an in-progress turn. + Mode *SendMode `json:"mode,omitempty"` + // If true, adds the message to the front of the queue instead of the end + Prepend *bool `json:"prepend,omitempty"` + // The user message text + Prompt string `json:"prompt"` + // Custom HTTP headers to include in outbound model requests for this turn. Merged with + // session-level provider headers; per-turn headers augment and overwrite session-level + // headers with the same key. + RequestHeaders map[string]string `json:"requestHeaders,omitzero"` + // If set, the request will fail if the named tool is not available when this message is + // among the user messages at the start of the current exchange + RequiredTool *string `json:"requiredTool,omitempty"` + // Optional provenance tag copied to the resulting user.message event. Must be `user`, + // `system`, `command-` for command-originated messages, `schedule-` + // for scheduled prompts, or `agent-` for prompts sent by another agent. + // Internal: Source is part of the SDK's internal API surface and is not intended for + // external use. + Source *string `json:"source,omitempty"` + // W3C Trace Context traceparent header for distributed tracing of this agent turn + Traceparent *string `json:"traceparent,omitempty"` + // W3C Trace Context tracestate header for distributed tracing + Tracestate *string `json:"tracestate,omitempty"` + // If true, await completion of the agentic loop for this message before returning. Defaults + // to false (fire-and-forget). When true, the result still contains the same `messageId`; + // the caller can rely on the agent having processed the message before the call resolves. + // Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally + // blocks until the completed turn's event tail has been dispatched to this session's + // in-process subscribers, so a subsequent read of subscriber state already reflects the + // turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery + // follows over the wire. Callers that need the stronger local guarantee on remote sessions + // should await the event stream explicitly. + Wait *bool `json:"wait,omitempty"` } -// Absolute path to the session's events.jsonl file on disk. -// Experimental: SessionsGetEventFilePathResult is part of an experimental API and may -// change or be removed. -type SessionsGetEventFilePathResult struct { - // Absolute path to the session's events.jsonl file - FilePath string `json:"filePath"` +// Result of sending a user message +// Experimental: SendResult is part of an experimental API and may change or be removed. +type SendResult struct { + // Unique identifier assigned to the message + MessageID string `json:"messageId"` } -// Optional working-directory context used to score session relevance. -// Experimental: SessionsGetLastForContextRequest is part of an experimental API and may -// change or be removed. -type SessionsGetLastForContextRequest struct { - // Optional working-directory context used to score session relevance. When omitted the - // most-recently-modified session wins. - Context *SessionContext `json:"context,omitempty"` +// Internal request for sending a system notification. +// Experimental: SendSystemNotificationRequest is part of an experimental API and may change +// or be removed. +type SendSystemNotificationRequest struct { + // Optional structured notification kind. + Kind any `json:"kind,omitempty"` + // Notification text to deliver to the model. + Message string `json:"message"` + // Internal delivery options, including passive policy. + Options any `json:"options,omitempty"` } -// Most-relevant session ID for the supplied context, or omitted when no sessions exist. -// Experimental: SessionsGetLastForContextResult is part of an experimental API and may -// change or be removed. -type SessionsGetLastForContextResult struct { - // Most-relevant session ID for the supplied context, or omitted when no sessions exist - SessionID *string `json:"sessionId,omitempty"` +// Agents discovered across user, project, plugin, and remote sources. +// Experimental: ServerAgentList is part of an experimental API and may change or be removed. +type ServerAgentList struct { + // All discovered agents across all sources + Agents []AgentInfo `json:"agents"` } -// Session ID to look up the persisted remote-steerable flag for. -// Experimental: SessionsGetPersistedRemoteSteerableRequest is part of an experimental API -// and may change or be removed. -type SessionsGetPersistedRemoteSteerableRequest struct { - // Session ID to look up the persisted remote-steerable flag for - SessionID string `json:"sessionId"` +// Instruction sources discovered across user, repository, and plugin sources. +// Experimental: ServerInstructionSourceList is part of an experimental API and may change +// or be removed. +type ServerInstructionSourceList struct { + // All discovered instruction sources + Sources []InstructionSource `json:"sources"` } -// The session's persisted remote-steerable flag, or omitted when no value has been -// persisted. -// Experimental: SessionsGetPersistedRemoteSteerableResult is part of an experimental API -// and may change or be removed. -type SessionsGetPersistedRemoteSteerableResult struct { - // The session's persisted remote-steerable flag if recorded; omitted when no value has been - // persisted - RemoteSteerable *bool `json:"remoteSteerable,omitempty"` +// Server-side skill metadata, including name, description, source, enabled/invocable state, +// path, project path, and argument hint. +// Experimental: ServerSkill is part of an experimental API and may change or be removed. +type ServerSkill struct { + // Optional freeform hint describing the skill's expected arguments, from the + // `argument-hint` frontmatter field + ArgumentHint *string `json:"argumentHint,omitempty"` + // Canonical slash command name used to invoke the skill, without the leading '/' + CommandName *string `json:"commandName,omitempty"` + // Description of what the skill does + Description string `json:"description"` + // Whether the skill is currently enabled (based on global config) + Enabled bool `json:"enabled"` + // Unique identifier for the skill + Name string `json:"name"` + // Absolute path to the skill file + Path *string `json:"path,omitempty"` + // The project path this skill belongs to (only for project/inherited skills) + ProjectPath *string `json:"projectPath,omitempty"` + // Source location type (e.g., project, personal-copilot, plugin, builtin) + Source SkillSource `json:"source"` + // Whether the skill can be invoked by the user as a slash command + UserInvocable bool `json:"userInvocable"` } -// Experimental: SessionShutdownResult is part of an experimental API and may change or be -// removed. -type SessionShutdownResult struct { +// Skills discovered across global and project sources. +// Experimental: ServerSkillList is part of an experimental API and may change or be removed. +type ServerSkillList struct { + // Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills + // are excluded so host-local paths are not disclosed to multitenant callers. + Errors []string `json:"errors,omitzero"` + // All discovered skills across all sources + Skills []ServerSkill `json:"skills"` } -// Map of sessionId -> on-disk size in bytes for each session's workspace directory. -// Experimental: SessionSizes is part of an experimental API and may change or be removed. -type SessionSizes struct { - // Map of sessionId -> on-disk size in bytes for the session's workspace directory - Sizes map[string]int64 `json:"sizes"` +// Current activity flags for the session. +// Experimental: SessionActivity is part of an experimental API and may change or be removed. +type SessionActivity struct { + // Whether an in-flight operation can currently be aborted. + Abortable bool `json:"abortable"` + // Whether the session currently has active work, including running turns or tasks. + HasActiveWork bool `json:"hasActiveWork"` } -// Experimental: SessionSkillsDisableResult is part of an experimental API and may change or +// Experimental: SessionAgentDeselectResult is part of an experimental API and may change or // be removed. -type SessionSkillsDisableResult struct { +type SessionAgentDeselectResult struct { } -// Experimental: SessionSkillsEnableResult is part of an experimental API and may change or -// be removed. -type SessionSkillsEnableResult struct { +// Experimental: SessionAgentListRequest is part of an experimental API and may change or be +// removed. +type SessionAgentListRequest struct { + // When true, request the session's configured built-in agents alongside custom agents. + // Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, + // but does not evaluate transient invocation requirements such as model availability. + // Built-in metadata may be omitted when the session cannot project it, such as a relay + // session. + IncludeBuiltInAgents *bool `json:"includeBuiltInAgents,omitempty"` + // When true, request authored base prompt text on each AgentInfo. Prompt text may be + // omitted when unavailable, such as for agents projected through a relay session. + IncludePrompt *bool `json:"includePrompt,omitempty"` } -// Experimental: SessionSkillsEnsureLoadedResult is part of an experimental API and may -// change or be removed. -type SessionSkillsEnsureLoadedResult struct { +// Experimental: SessionAgentSetPromptResult is part of an experimental API and may change +// or be removed. +type SessionAgentSetPromptResult struct { } -// Optional metadata-load limit and filters applied to the returned sessions. -// Experimental: SessionsListRequest is part of an experimental API and may change or be +// Authentication status and account metadata for the session. +// Experimental: SessionAuthStatus is part of an experimental API and may change or be // removed. -type SessionsListRequest struct { - // Optional filter applied to the returned sessions - Filter *SessionListFilter `json:"filter,omitempty"` - // When true, include detached maintenance sessions. Defaults to false for user-facing - // session lists. - IncludeDetached *bool `json:"includeDetached,omitempty"` - // When provided, only the first N sessions (sorted by modification time, newest first) load - // full metadata; remaining sessions return basic info only. Use 0 to return only basic info - // for every session. - MetadataLimit *int64 `json:"metadataLimit,omitempty"` -} - -// Active session ID whose deferred repo-level hooks should be loaded. -// Experimental: SessionsLoadDeferredRepoHooksRequest is part of an experimental API and may -// change or be removed. -type SessionsLoadDeferredRepoHooksRequest struct { - // Active session ID whose deferred repo-level hooks should be loaded - SessionID string `json:"sessionId"` +type SessionAuthStatus struct { + // Authentication type + AuthType *AuthInfoType `json:"authType,omitempty"` + // Copilot plan tier (e.g., individual_pro, business) + CopilotPlan *string `json:"copilotPlan,omitempty"` + // Authentication host URL + Host *string `json:"host,omitempty"` + // Whether the session has resolved authentication + IsAuthenticated bool `json:"isAuthenticated"` + // Authenticated login/username, if available + Login *string `json:"login,omitempty"` + // Human-readable authentication status description + StatusMessage *string `json:"statusMessage,omitempty"` } -// Age threshold and optional flags controlling which old sessions are pruned (or simulated -// when dryRun is true). -// Experimental: SessionsPruneOldRequest is part of an experimental API and may change or be +// Map of sessionId -> bytes freed by removing the session's workspace directory. +// Experimental: SessionBulkDeleteResult is part of an experimental API and may change or be // removed. -type SessionsPruneOldRequest struct { - // When true, only report what would be deleted without performing any deletion - DryRun *bool `json:"dryRun,omitempty"` - // Session IDs that should never be considered for pruning - ExcludeSessionIds []string `json:"excludeSessionIds,omitempty"` - // When true, named sessions (set via /rename) are also eligible for pruning - IncludeNamed *bool `json:"includeNamed,omitempty"` - // Delete sessions whose modifiedTime is at least this many days old - OlderThanDays int64 `json:"olderThanDays"` +type SessionBulkDeleteResult struct { + // Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions + // whose deletion failed are omitted from this map (failures are logged on the server but + // not surfaced per-id; check the map for absent IDs to detect them). + FreedBytes map[string]int64 `json:"freedBytes"` } -// Session ID whose in-use lock should be released. -// Experimental: SessionsReleaseLockRequest is part of an experimental API and may change or +// The number of running background agents (task-registry agents) that were cancelled. +// Experimental: SessionCancelAllBackgroundAgentsResult is part of an experimental API and +// may change or be removed. +type SessionCancelAllBackgroundAgentsResult int64 + +// Experimental: SessionCanvasCloseResult is part of an experimental API and may change or // be removed. -type SessionsReleaseLockRequest struct { - // Session ID whose in-use lock should be released - SessionID string `json:"sessionId"` +type SessionCanvasCloseResult struct { } -// Release the in-use lock held by this process for the given session. No-op when this -// process does not currently hold a lock for the session. -// Experimental: SessionsReleaseLockResult is part of an experimental API and may change or +// Experimental: SessionCommandsListRequest is part of an experimental API and may change or // be removed. -type SessionsReleaseLockResult struct { +type SessionCommandsListRequest struct { + // Include runtime built-in commands + IncludeBuiltins *bool `json:"includeBuiltins,omitempty"` + // Include commands registered by protocol clients, including SDK clients and extensions + IncludeClientCommands *bool `json:"includeClientCommands,omitempty"` + // Include enabled user-invocable skills and commands + IncludeSkills *bool `json:"includeSkills,omitempty"` } -// Active session ID and an optional flag for deferring repo-level hooks until folder trust. -// Experimental: SessionsReloadPluginHooksRequest is part of an experimental API and may -// change or be removed. -type SessionsReloadPluginHooksRequest struct { - // When true, skip repo-level hooks. Use before folder trust is confirmed; - // loadDeferredRepoHooks loads them post-trust. - DeferRepoHooks *bool `json:"deferRepoHooks,omitempty"` - // Active session ID to reload hooks for - SessionID string `json:"sessionId"` +// A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` +// (UTF-16 code units) in the composer with `insertText`; when the range is absent, the +// active token around the cursor is replaced. +// Experimental: SessionCompletionItem is part of an experimental API and may change or be +// removed. +type SessionCompletionItem struct { + // Text spliced into the composer when the item is accepted. + InsertText string `json:"insertText"` + // Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the + // host's display kind. + Kind *string `json:"kind,omitempty"` + // Primary display label for the picker row. Falls back to `insertText` when absent. + Label *string `json:"label,omitempty"` + // End (exclusive) of the replacement range in `text`, in UTF-16 code units. + RangeEnd *int64 `json:"rangeEnd,omitempty"` + // Start of the replacement range in `text`, in UTF-16 code units. + RangeStart *int64 `json:"rangeStart,omitempty"` +} + +// Pre-resolved working-directory context for session startup. +// Experimental: SessionContext is part of an experimental API and may change or be removed. +type SessionContext struct { + // Active git branch + Branch *string `json:"branch,omitempty"` + // Most recent working directory for this session + Cwd string `json:"cwd"` + // Git repository root, if the cwd was inside a git repo + GitRoot *string `json:"gitRoot,omitempty"` + // Repository host type + HostType *SessionContextHostType `json:"hostType,omitempty"` + // Repository slug in `owner/name` form, when known + Repository *string `json:"repository,omitempty"` } -// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. -// Call after installing or removing plugins so their hooks take effect immediately. No-op -// when no active session matches the given sessionId. -// Experimental: SessionsReloadPluginHooksResult is part of an experimental API and may -// change or be removed. -type SessionsReloadPluginHooksResult struct { +// Per-source token attribution snapshot for the current context window. The heaviest +// individual messages are available separately via `metadata.getContextHeaviestMessages`. +// Experimental: SessionContextAttribution is part of an experimental API and may change or +// be removed. +type SessionContextAttribution struct { + // Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors + // `SessionContextInfo.bufferTokens`. + BufferTokens int64 `json:"bufferTokens"` + // The six normalized `/context` header buckets, computed from the same tokenization as + // `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` + // describe window capacity rather than occupied context, so the values do not sum to + // `totalTokens`. + Categories SessionContextAttributionCategories `json:"categories"` + // Successful compaction history for the session. + Compactions SessionContextAttributionCompactions `json:"compactions"` + // Token count at which background compaction starts. Mirrors + // `SessionContextInfo.compactionThreshold`. + CompactionThreshold int64 `json:"compactionThreshold"` + // Flat list of per-source attribution entries. Group by `kind` and render unrecognized + // kinds generically. Nesting and rollups are expressed via `parentId`. + Entries []SessionContextAttributionEntriesItem `json:"entries"` + // Prompt limit plus the model's output reserve: the full context window + // `categories.freeSpace` and `categories.buffer` are measured against. Mirrors + // `SessionContextInfo.limit`. + Limit int64 `json:"limit"` + // The concrete model id the entire breakdown was tokenized against (feeds the per-model + // token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the + // literal `auto` sentinel, so totals are not undercounted. A single-model approximation of + // a potentially multi-model Auto session. + ModelID string `json:"modelId"` + // How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: + // `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected + // model), `default` (a fallback before any model is known). + ModelSource string `json:"modelSource"` + // Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` + // context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + PromptTokenLimit int64 `json:"promptTokenLimit"` + // Total token count of the current context window the entries are measured against (system + // message + conversation messages + tool definitions — the same total reported by + // /context). Divide an entry's `tokens` by this to derive its share. + TotalTokens int64 `json:"totalTokens"` } -// Session ID whose pending events should be flushed to disk. -// Experimental: SessionsSaveRequest is part of an experimental API and may change or be -// removed. -type SessionsSaveRequest struct { - // Session ID whose pending events should be flushed to disk - SessionID string `json:"sessionId"` +// The six normalized `/context` header buckets, computed from the same tokenization as +// `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` +// describe window capacity rather than occupied context, so the values do not sum to +// `totalTokens`. +type SessionContextAttributionCategories struct { + // Output reserve plus post-blocking-threshold buffer. + Buffer int64 `json:"buffer"` + // Custom-instructions tokens (0 when none are configured). + CustomInstructions int64 `json:"customInstructions"` + // Remaining unused window capacity (clamped at 0). + FreeSpace int64 `json:"freeSpace"` + // MCP tool-definition tokens. + MCPTools int64 `json:"mcpTools"` + // Conversation (user/assistant/tool) message tokens. + Messages int64 `json:"messages"` + // System prompt tokens, excluding custom instructions. + SystemPrompt int64 `json:"systemPrompt"` + // Non-MCP tool-definition tokens. + SystemTools int64 `json:"systemTools"` +} + +// Successful compaction history for the session. +type SessionContextAttributionCompactions struct { + // Number of successful compactions in this session. + Count int64 `json:"count"` } -// Flush a session's pending events to disk. No-op when no writer exists for the session -// (e.g., already closed). -// Experimental: SessionsSaveResult is part of an experimental API and may change or be +type SessionContextAttributionEntriesItem struct { + // Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, + // `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + Attributes map[string]string `json:"attributes,omitzero"` + // Identifier for this entry, formed by joining its `kind` and source name (e.g. + // `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to + // match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP + // registries), and as the `parentId` target for nesting. Distinct from the human-facing + // `label`. + ID string `json:"id"` + // Source category for this entry. Not a closed set — tolerate unknown values. Known values + // today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + Kind string `json:"kind"` + // Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be + // localized/reformatted without notice — do not key off it. + Label string `json:"label"` + // Optional `id` of the parent entry: e.g. a `plugin` entry parenting its + // `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. + // Omitted for top-level entries. + ParentID *string `json:"parentId,omitempty"` + // Token count currently in context attributable to this entry. + Tokens int64 `json:"tokens"` +} + +// Token-usage breakdown for the session's current context window +// Experimental: SessionContextInfo is part of an experimental API and may change or be // removed. -type SessionsSaveResult struct { +type SessionContextInfo struct { + // Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) + BufferTokens int64 `json:"bufferTokens"` + // Token count at which background compaction starts (configurable percentage of + // promptTokenLimit) + CompactionThreshold int64 `json:"compactionThreshold"` + // Tokens consumed by user/assistant/tool messages + ConversationTokens int64 `json:"conversationTokens"` + // Prompt token limit plus the model's full output token limit. + Limit int64 `json:"limit"` + // Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes + // deferred tools) + MCPToolsTokens int64 `json:"mcpToolsTokens"` + // The model used for token counting + ModelName string `json:"modelName"` + // Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) + PromptTokenLimit int64 `json:"promptTokenLimit"` + // Tokens consumed by the system prompt + SystemTokens int64 `json:"systemTokens"` + // Tokens consumed by tool definitions sent to the model (excludes deferred tools) + ToolDefinitionsTokens int64 `json:"toolDefinitionsTokens"` + // Sum of system, conversation and tool-definition tokens + TotalTokens int64 `json:"totalTokens"` } -// Manager-wide additional plugins to register; replaces any previously-configured set. -// Experimental: SessionsSetAdditionalPluginsRequest is part of an experimental API and may -// change or be removed. -type SessionsSetAdditionalPluginsRequest struct { - // Manager-wide additional plugins to register. Replaces any previously-configured set. Pass - // an empty array to clear. - Plugins []InstalledPlugin `json:"plugins"` +// The enriched metadata records, with summary and context fields backfilled where +// available. Sessions confirmed empty and unnamed are omitted. +// Experimental: SessionEnrichMetadataResult is part of an experimental API and may change +// or be removed. +type SessionEnrichMetadataResult struct { + // Enriched records, with summary and context backfilled. Sessions confirmed empty and + // unnamed may be omitted. + Sessions []LocalSessionMetadataValue `json:"sessions"` } -// Replace the manager-wide additional plugins. New session creations and subsequent hook -// reloads see the new set; already-running sessions keep their existing hook installation -// until the next reload. -// Experimental: SessionsSetAdditionalPluginsResult is part of an experimental API and may +// Experimental: SessionExtensionsDisableResult is part of an experimental API and may // change or be removed. -type SessionsSetAdditionalPluginsResult struct { +type SessionExtensionsDisableResult struct { } -// Experimental: SessionSuspendResult is part of an experimental API and may change or be -// removed. -type SessionSuspendResult struct { +// Experimental: SessionExtensionsEnableResult is part of an experimental API and may change +// or be removed. +type SessionExtensionsEnableResult struct { } -// Experimental: SessionTelemetrySetFeatureOverridesResult is part of an experimental API -// and may change or be removed. -type SessionTelemetrySetFeatureOverridesResult struct { +// Experimental: SessionExtensionsReloadResult is part of an experimental API and may change +// or be removed. +type SessionExtensionsReloadResult struct { } -// Patch of mutable session options to apply to the running session. -// Experimental: SessionUpdateOptionsParams is part of an experimental API and may change or -// be removed. -type SessionUpdateOptionsParams struct { - // Additional content-exclusion policies to merge into the session's policy set. Opaque - // shape; see `ContentExclusionApiResponse` in the runtime. - // Experimental: AdditionalContentExclusionPolicies is part of an experimental API and may - // change or be removed. - AdditionalContentExclusionPolicies []any `json:"additionalContentExclusionPolicies,omitempty"` - // Runtime context discriminator (e.g., `cli`, `actions`). - AgentContext *string `json:"agentContext,omitempty"` - // Whether to disable the `ask_user` tool (encourages autonomous behavior). - AskUserDisabled *bool `json:"askUserDisabled,omitempty"` - // Allowlist of tool names available to this session. - AvailableTools []string `json:"availableTools,omitempty"` - // Identifier of the client driving the session. - ClientName *string `json:"clientName,omitempty"` - // Whether to include the `Co-authored-by` trailer in commit messages. - CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` - // Whether to allow auto-mode continuation across turns. - ContinueOnAutoMode *bool `json:"continueOnAutoMode,omitempty"` - // Override URL for the Copilot API endpoint. - CopilotURL *string `json:"copilotUrl,omitempty"` - // Whether to default custom agents to local-only execution. - CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` - // Instruction source IDs to exclude from the system prompt. - DisabledInstructionSources []string `json:"disabledInstructionSources,omitempty"` - // Skill IDs that should be excluded from this session. - DisabledSkills []string `json:"disabledSkills,omitempty"` - // Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK - // callback hook mechanism. - EnableFileHooks *bool `json:"enableFileHooks,omitempty"` - // Whether to enable host git operations (context resolution, child repo scanning, git info - // in system prompt). - EnableHostGitOperations *bool `json:"enableHostGitOperations,omitempty"` - // Whether to discover custom instructions on demand after successful file views (AGENTS.md - // / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with - // `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. - EnableOnDemandInstructionDiscovery *bool `json:"enableOnDemandInstructionDiscovery,omitempty"` - // Whether to surface reasoning-summary events from the model. - EnableReasoningSummaries *bool `json:"enableReasoningSummaries,omitempty"` - // Whether shell-script safety heuristics are enabled. - EnableScriptSafety *bool `json:"enableScriptSafety,omitempty"` - // Whether to enable cross-session store writes and reads. - EnableSessionStore *bool `json:"enableSessionStore,omitempty"` - // Whether to enable skill directory scanning and loading. Falls back to - // enableConfigDiscovery when unset. - EnableSkills *bool `json:"enableSkills,omitempty"` - // Whether to stream model responses. - EnableStreaming *bool `json:"enableStreaming,omitempty"` - // How env values are passed to MCP servers (`direct` inlines literal values; `indirect` - // resolves at launch). - EnvValueMode *OptionsUpdateEnvValueMode `json:"envValueMode,omitempty"` - // Override directory for the session-events log. When unset, the runtime's default events - // log directory is used. - EventsLogDirectory *string `json:"eventsLogDirectory,omitempty"` - // Denylist of tool names for this session. - ExcludedTools []string `json:"excludedTools,omitempty"` - // Map of feature-flag IDs to their boolean enabled state. - FeatureFlags map[string]bool `json:"featureFlags,omitempty"` - // Full set of installed plugins for the session. Replaces the existing list; the runtime - // invalidates the skills cache only when the list materially changes. - InstalledPlugins []SessionInstalledPlugin `json:"installedPlugins,omitempty"` - // Stable integration identifier used for analytics and rate-limit attribution. - IntegrationID *string `json:"integrationId,omitempty"` - // Whether experimental capabilities are enabled. - IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` - // Whether interactive shell sessions are logged. - LogInteractiveShells *bool `json:"logInteractiveShells,omitempty"` - // Identifier sent to LSP-style integrations. - LspClientName *string `json:"lspClientName,omitempty"` - // Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the - // per-session schedule registry; this flag only controls tool exposure (typically gated to - // staff users). - ManageScheduleEnabled *bool `json:"manageScheduleEnabled,omitempty"` - // The model ID to use for assistant turns. - Model *string `json:"model,omitempty"` - // Organization-level custom instructions to inject into the system prompt. - OrganizationCustomInstructions *string `json:"organizationCustomInstructions,omitempty"` - // Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the - // runtime. - // Experimental: Provider is part of an experimental API and may change or be removed. - Provider any `json:"provider,omitempty"` - // Reasoning effort for the selected model (model-defined enum). - ReasoningEffort *string `json:"reasoningEffort,omitempty"` - // Whether the session is running in an interactive UI. - RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` - // Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. - // Experimental: SandboxConfig is part of an experimental API and may change or be removed. - SandboxConfig any `json:"sandboxConfig,omitempty"` - // Shell init profile (`None` or `NonInteractive`). - ShellInitProfile *string `json:"shellInitProfile,omitempty"` - // Per-shell process flags (e.g., `pwsh` arguments). - ShellProcessFlags []string `json:"shellProcessFlags,omitempty"` - // Additional directories to search for skills. - SkillDirectories []string `json:"skillDirectories,omitempty"` - // Whether to skip loading custom instruction sources. - SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` - // Whether to skip embedding retrieval pipeline initialization and execution. - SkipEmbeddingRetrieval *bool `json:"skipEmbeddingRetrieval,omitempty"` - // Controls how availableTools (allowlist) and excludedTools (denylist) combine when both - // are set. - ToolFilterPrecedence *OptionsUpdateToolFilterPrecedence `json:"toolFilterPrecedence,omitempty"` - // Optional path for trajectory output. - TrajectoryFile *string `json:"trajectoryFile,omitempty"` - // Absolute working-directory path for shell tools. - WorkingDirectory *string `json:"workingDirectory,omitempty"` +// Experimental: SessionExtensionsSendAttachmentsToMessageResult is part of an experimental +// API and may change or be removed. +type SessionExtensionsSendAttachmentsToMessageResult struct { } -// Indicates whether the session options patch was applied successfully. -// Experimental: SessionUpdateOptionsResult is part of an experimental API and may change or +// File path, content to append, and optional mode for the client-provided session +// filesystem. +// Experimental: SessionFSAppendFileRequest is part of an experimental API and may change or // be removed. -type SessionUpdateOptionsResult struct { - // Whether the operation succeeded - Success bool `json:"success"` +type SessionFSAppendFileRequest struct { + // Content to append + Content string `json:"content"` + // Optional POSIX-style mode for newly created files + Mode *int64 `json:"mode,omitempty"` + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Updated working directory and git context. Emitted as the new payload of -// `session.context_changed`. -// Experimental: SessionWorkingDirectoryContext is part of an experimental API and may -// change or be removed. -type SessionWorkingDirectoryContext struct { - // Merge-base commit SHA (fork point from the remote default branch) - BaseCommit *string `json:"baseCommit,omitempty"` - // Current git branch name - Branch *string `json:"branch,omitempty"` - // Current working directory path - Cwd string `json:"cwd"` - // Root directory of the git repository, resolved via git rev-parse - GitRoot *string `json:"gitRoot,omitempty"` - // Head commit of the current git branch - HeadCommit *string `json:"headCommit,omitempty"` - // Hosting platform type of the repository - HostType *SessionWorkingDirectoryContextHostType `json:"hostType,omitempty"` - // Repository identifier derived from the git remote URL ("owner/name" for GitHub, - // "org/project/repo" for Azure DevOps) - Repository *string `json:"repository,omitempty"` - // Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") - RepositoryHost *string `json:"repositoryHost,omitempty"` +// Describes a filesystem error. +// Experimental: SessionFSError is part of an experimental API and may change or be removed. +type SessionFSError struct { + // Error classification + Code SessionFSErrorCode `json:"code"` + // Free-form detail about the error, for logging/diagnostics + Message *string `json:"message,omitempty"` } -// Experimental: SessionWorkspacesCreateFileResult is part of an experimental API and may -// change or be removed. -type SessionWorkspacesCreateFileResult struct { +// Path to test for existence in the client-provided session filesystem. +// Experimental: SessionFSExistsRequest is part of an experimental API and may change or be +// removed. +type SessionFSExistsRequest struct { + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Shell command to run, with optional working directory and timeout in milliseconds. -// Experimental: ShellExecRequest is part of an experimental API and may change or be +// Indicates whether the requested path exists in the client-provided session filesystem. +// Experimental: SessionFSExistsResult is part of an experimental API and may change or be // removed. -type ShellExecRequest struct { - // Shell command to execute - Command string `json:"command"` - // Working directory (defaults to session working directory) - Cwd *string `json:"cwd,omitempty"` - // Timeout in milliseconds (default: 30000) - Timeout *int64 `json:"timeout,omitempty"` +type SessionFSExistsResult struct { + // Whether the path exists + Exists bool `json:"exists"` } -// Identifier of the spawned process, used to correlate streamed output and exit -// notifications. -// Experimental: ShellExecResult is part of an experimental API and may change or be removed. -type ShellExecResult struct { - // Unique identifier for tracking streamed output - ProcessID string `json:"processId"` +// Directory path to create in the client-provided session filesystem, with options for +// recursive creation and POSIX mode. +// Experimental: SessionFSMkdirRequest is part of an experimental API and may change or be +// removed. +type SessionFSMkdirRequest struct { + // Optional POSIX-style mode for newly created directories + Mode *int64 `json:"mode,omitempty"` + // Path using SessionFs conventions + Path string `json:"path"` + // Create parent directories as needed + Recursive *bool `json:"recursive,omitempty"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Identifier of a process previously returned by "shell.exec" and the signal to send. -// Experimental: ShellKillRequest is part of an experimental API and may change or be +// Directory path whose entries should be listed from the client-provided session filesystem. +// Experimental: SessionFSReaddirRequest is part of an experimental API and may change or be // removed. -type ShellKillRequest struct { - // Process identifier returned by shell.exec - ProcessID string `json:"processId"` - // Signal to send (default: SIGTERM) - Signal *ShellKillSignal `json:"signal,omitempty"` +type SessionFSReaddirRequest struct { + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Indicates whether the signal was delivered; false if the process was unknown or already -// exited. -// Experimental: ShellKillResult is part of an experimental API and may change or be removed. -type ShellKillResult struct { - // Whether the signal was sent successfully - Killed bool `json:"killed"` +// Names of entries in the requested directory, or a filesystem error if the read failed. +// Experimental: SessionFSReaddirResult is part of an experimental API and may change or be +// removed. +type SessionFSReaddirResult struct { + // Entry names in the directory + Entries []string `json:"entries"` + // Describes a filesystem error. + Error *SessionFSError `json:"error,omitempty"` } -// Parameters for shutting down the session -// Experimental: ShutdownRequest is part of an experimental API and may change or be removed. -type ShutdownRequest struct { - // Optional human-readable reason. Typically the message of the error that triggered - // shutdown when type is 'error'. - Reason *string `json:"reason,omitempty"` - // Why the session is being shut down. Defaults to "routine" when omitted. - Type *ShutdownType `json:"type,omitempty"` -} - -// Schema for the `Skill` type. -// Experimental: Skill is part of an experimental API and may change or be removed. -type Skill struct { - // Description of what the skill does - Description string `json:"description"` - // Whether the skill is currently enabled - Enabled bool `json:"enabled"` - // Unique identifier for the skill +// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry +// type. +// Experimental: SessionFSReaddirWithTypesEntry is part of an experimental API and may +// change or be removed. +type SessionFSReaddirWithTypesEntry struct { + // Entry name Name string `json:"name"` - // Absolute path to the skill file - Path *string `json:"path,omitempty"` - // Name of the plugin that provides the skill, when source is 'plugin' - PluginName *string `json:"pluginName,omitempty"` - // Source location type (e.g., project, personal-copilot, plugin, builtin) - Source SkillSource `json:"source"` - // Whether the skill can be invoked by the user as a slash command - UserInvocable bool `json:"userInvocable"` -} - -// Skills available to the session, with their enabled state. -// Experimental: SkillList is part of an experimental API and may change or be removed. -type SkillList struct { - // Available skills - Skills []Skill `json:"skills"` -} - -// Skill names to mark as disabled in global configuration, replacing any previous list. -type SkillsConfigSetDisabledSkillsRequest struct { - // List of skill names to disable - DisabledSkills []string `json:"disabledSkills"` + // Entry type + Type SessionFSReaddirWithTypesEntryType `json:"type"` } -type SkillsConfigSetDisabledSkillsResult struct { +// Directory path whose entries (with type information) should be listed from the +// client-provided session filesystem. +// Experimental: SessionFSReaddirWithTypesRequest is part of an experimental API and may +// change or be removed. +type SessionFSReaddirWithTypesRequest struct { + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Name of the skill to disable for the session. -// Experimental: SkillsDisableRequest is part of an experimental API and may change or be -// removed. -type SkillsDisableRequest struct { - // Name of the skill to disable - Name string `json:"name"` +// Entries in the requested directory paired with file/directory type information, or a +// filesystem error if the read failed. +// Experimental: SessionFSReaddirWithTypesResult is part of an experimental API and may +// change or be removed. +type SessionFSReaddirWithTypesResult struct { + // Directory entries with type information + Entries []SessionFSReaddirWithTypesEntry `json:"entries"` + // Describes a filesystem error. + Error *SessionFSError `json:"error,omitempty"` } -// Optional project paths and additional skill directories to include in discovery. -type SkillsDiscoverRequest struct { - // Optional list of project directory paths to scan for project-scoped skills - ProjectPaths []string `json:"projectPaths,omitempty"` - // Optional list of additional skill directory paths to include - SkillDirectories []string `json:"skillDirectories,omitempty"` +// Path of the file to read from the client-provided session filesystem. +// Experimental: SessionFSReadFileRequest is part of an experimental API and may change or +// be removed. +type SessionFSReadFileRequest struct { + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Name of the skill to enable for the session. -// Experimental: SkillsEnableRequest is part of an experimental API and may change or be +// File content as a UTF-8 string, or a filesystem error if the read failed. +// Experimental: SessionFSReadFileResult is part of an experimental API and may change or be // removed. -type SkillsEnableRequest struct { - // Name of the skill to enable - Name string `json:"name"` +type SessionFSReadFileResult struct { + // File content as UTF-8 string + Content string `json:"content"` + // Describes a filesystem error. + Error *SessionFSError `json:"error,omitempty"` } -// Skills invoked during this session, ordered by invocation time (most recent last). -// Experimental: SkillsGetInvokedResult is part of an experimental API and may change or be +// Source and destination paths for renaming or moving an entry in the client-provided +// session filesystem. +// Experimental: SessionFSRenameRequest is part of an experimental API and may change or be // removed. -type SkillsGetInvokedResult struct { - // Skills invoked during this session, ordered by invocation time (most recent last) - Skills []SkillsInvokedSkill `json:"skills"` +type SessionFSRenameRequest struct { + // Destination path using SessionFs conventions + Dest string `json:"dest"` + // Target session identifier + SessionID string `json:"sessionId"` + // Source path using SessionFs conventions + Src string `json:"src"` } -// Schema for the `SkillsInvokedSkill` type. -// Experimental: SkillsInvokedSkill is part of an experimental API and may change or be +// Path to remove from the client-provided session filesystem, with options for recursive +// removal and force. +// Experimental: SessionFSRmRequest is part of an experimental API and may change or be // removed. -type SkillsInvokedSkill struct { - // Tools that should be auto-approved when this skill is active, captured at invocation time - AllowedTools []string `json:"allowedTools,omitempty"` - // Full content of the skill file - Content string `json:"content"` - // Turn number when the skill was invoked - InvokedAtTurn int64 `json:"invokedAtTurn"` - // Unique identifier for the skill - Name string `json:"name"` - // Path to the SKILL.md file +type SessionFSRmRequest struct { + // Ignore errors if the path does not exist + Force *bool `json:"force,omitempty"` + // Path using SessionFs conventions Path string `json:"path"` + // Remove directories and their contents recursively + Recursive *bool `json:"recursive,omitempty"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. -// Experimental: SkillsLoadDiagnostics is part of an experimental API and may change or be -// removed. -type SkillsLoadDiagnostics struct { - // Errors emitted while loading skills (e.g. skills that failed to load entirely) - Errors []string `json:"errors"` - // Warnings emitted while loading skills (e.g. skills that loaded but had issues) - Warnings []string `json:"warnings"` +// Optional capabilities declared by the provider +// Experimental: SessionFSSetProviderCapabilities is part of an experimental API and may +// change or be removed. +type SessionFSSetProviderCapabilities struct { + // Whether the provider supports SQLite query/exists operations + Sqlite *bool `json:"sqlite,omitempty"` } -// Schema for the `SlashCommandInfo` type. -// Experimental: SlashCommandInfo is part of an experimental API and may change or be -// removed. -type SlashCommandInfo struct { - // Canonical aliases without leading slashes - Aliases []string `json:"aliases,omitempty"` - // Whether the command may run while an agent turn is active - AllowDuringAgentExecution bool `json:"allowDuringAgentExecution"` - // Human-readable command description - Description string `json:"description"` - // Whether the command is experimental - Experimental *bool `json:"experimental,omitempty"` - // Optional unstructured input hint - Input *SlashCommandInput `json:"input,omitempty"` - // Coarse command category for grouping and behavior: runtime built-in, skill-backed - // command, or SDK/client-owned command - Kind SlashCommandKind `json:"kind"` - // Canonical command name without a leading slash - Name string `json:"name"` +// Initial working directory, session-state path layout, and path conventions used to +// register the calling SDK client as the session filesystem provider. +// Experimental: SessionFSSetProviderRequest is part of an experimental API and may change +// or be removed. +type SessionFSSetProviderRequest struct { + // Optional capabilities declared by the provider + Capabilities *SessionFSSetProviderCapabilities `json:"capabilities,omitempty"` + // Path conventions used by this filesystem + Conventions SessionFSSetProviderConventions `json:"conventions"` + // Initial working directory for sessions + InitialCwd string `json:"initialCwd"` + // Path within each session's SessionFs where the runtime stores files for that session + SessionStatePath string `json:"sessionStatePath"` } -// Optional unstructured input hint -// Experimental: SlashCommandInput is part of an experimental API and may change or be -// removed. -type SlashCommandInput struct { - // Optional completion hint for the input (e.g. 'directory' for filesystem path completion) - Completion *SlashCommandInputCompletion `json:"completion,omitempty"` - // Hint to display when command input has not been provided - Hint string `json:"hint"` - // When true, clients should pass the full text after the command name as a single argument - // rather than splitting on whitespace - PreserveMultilineInput *bool `json:"preserveMultilineInput,omitempty"` - // When true, the command requires non-empty input; clients should render the input hint as - // required - Required *bool `json:"required,omitempty"` +// Indicates whether the calling client was registered as the session filesystem provider. +// Experimental: SessionFSSetProviderResult is part of an experimental API and may change or +// be removed. +type SessionFSSetProviderResult struct { + // Whether the provider was set successfully + Success bool `json:"success"` } -// Result of invoking the slash command (text output, prompt to send to the agent, or -// completion). -// Experimental: SlashCommandInvocationResult is part of an experimental API and may change +// Identifies the target session. +// Experimental: SessionFSSqliteExistsRequest is part of an experimental API and may change // or be removed. -type SlashCommandInvocationResult interface { - slashCommandInvocationResult() - Kind() SlashCommandInvocationResultKind +type SessionFSSqliteExistsRequest struct { + // Target session identifier + SessionID string `json:"sessionId"` } -type RawSlashCommandInvocationResultData struct { - Discriminator SlashCommandInvocationResultKind - Raw json.RawMessage +// Indicates whether the per-session SQLite database already exists. +// Experimental: SessionFSSqliteExistsResult is part of an experimental API and may change +// or be removed. +type SessionFSSqliteExistsResult struct { + // Whether the session database already exists + Exists bool `json:"exists"` } -func (RawSlashCommandInvocationResultData) slashCommandInvocationResult() {} -func (r RawSlashCommandInvocationResultData) Kind() SlashCommandInvocationResultKind { - return r.Discriminator +// SQL query, query type, and optional bind parameters for executing a SQLite query against +// the per-session database. The provider applies its SQLite busy timeout for every call. +// Experimental: SessionFSSqliteQueryRequest is part of an experimental API and may change +// or be removed. +type SessionFSSqliteQueryRequest struct { + // Optional named bind parameters + Params map[string]any `json:"params,omitzero"` + // SQL query to execute + Query string `json:"query"` + // How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT + // (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) + QueryType SessionFSSqliteQueryType `json:"queryType"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Schema for the `SlashCommandAgentPromptResult` type. -// Experimental: SlashCommandAgentPromptResult is part of an experimental API and may change -// or be removed. -type SlashCommandAgentPromptResult struct { - // Prompt text to display to the user - DisplayPrompt string `json:"displayPrompt"` - // Optional target session mode for the agent prompt - Mode *SessionMode `json:"mode,omitempty"` - // Prompt to submit to the agent - Prompt string `json:"prompt"` - // True when the invocation mutated user runtime settings; consumers caching settings should - // refresh - RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +// Query results including rows, columns, and rows affected, or a filesystem error if +// execution failed. +// Experimental: SessionFSSqliteQueryResult is part of an experimental API and may change or +// be removed. +type SessionFSSqliteQueryResult struct { + // Column names from the result set + Columns []string `json:"columns"` + // Describes a filesystem error. + Error *SessionFSError `json:"error,omitempty"` + // SQLite last_insert_rowid() value for INSERT. + LastInsertRowid *int64 `json:"lastInsertRowid,omitempty"` + // For SELECT: array of row objects. For others: empty array. + Rows []map[string]any `json:"rows"` + // Number of rows affected (for INSERT/UPDATE/DELETE) + RowsAffected int64 `json:"rowsAffected"` } -func (SlashCommandAgentPromptResult) slashCommandInvocationResult() {} -func (SlashCommandAgentPromptResult) Kind() SlashCommandInvocationResultKind { - return SlashCommandInvocationResultKindAgentPrompt +// Classified SQLite transaction failure. busyOrLocked guarantees rollback; +// postCommitAmbiguous must never be retried. +// Experimental: SessionFSSqliteTransactionError is part of an experimental API and may +// change or be removed. +type SessionFSSqliteTransactionError struct { + ErrorClass SessionFSSqliteTransactionErrorClass `json:"errorClass"` + Message string `json:"message"` } -// Schema for the `SlashCommandCompletedResult` type. -// Experimental: SlashCommandCompletedResult is part of an experimental API and may change -// or be removed. -type SlashCommandCompletedResult struct { - // Optional user-facing message describing the completed command - Message *string `json:"message,omitempty"` - // True when the invocation mutated user runtime settings; consumers caching settings should - // refresh - RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +// Statements to execute atomically. Providers apply busy handling for every call. +// Experimental: SessionFSSqliteTransactionRequest is part of an experimental API and may +// change or be removed. +type SessionFSSqliteTransactionRequest struct { + // Target session identifier + SessionID string `json:"sessionId"` + Statements []SessionFSSqliteTransactionStatement `json:"statements"` } -func (SlashCommandCompletedResult) slashCommandInvocationResult() {} -func (SlashCommandCompletedResult) Kind() SlashCommandInvocationResultKind { - return SlashCommandInvocationResultKindCompleted +// Per-statement results, or a classified transaction error. +// Experimental: SessionFSSqliteTransactionResult is part of an experimental API and may +// change or be removed. +type SessionFSSqliteTransactionResult struct { + Error *SessionFSSqliteTransactionError `json:"error,omitempty"` + Results []SessionFSSqliteQueryResult `json:"results"` } -// Schema for the `SlashCommandSelectSubcommandResult` type. -// Experimental: SlashCommandSelectSubcommandResult is part of an experimental API and may +// One statement in an atomic SQLite transaction. +// Experimental: SessionFSSqliteTransactionStatement is part of an experimental API and may // change or be removed. -type SlashCommandSelectSubcommandResult struct { - // Parent command name that requires subcommand selection - Command string `json:"command"` - // Available subcommand options for the client to present - Options []SlashCommandSelectSubcommandOption `json:"options"` - // True when the invocation mutated user runtime settings; consumers caching settings should - // refresh - RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` - // Human-readable title for the selection UI - Title string `json:"title"` +type SessionFSSqliteTransactionStatement struct { + // Optional named bind parameters. + Params map[string]any `json:"params,omitzero"` + // SQL statement to execute. + Query string `json:"query"` + // How to execute the statement. + QueryType SessionFSSqliteQueryType `json:"queryType"` } -func (SlashCommandSelectSubcommandResult) slashCommandInvocationResult() {} -func (SlashCommandSelectSubcommandResult) Kind() SlashCommandInvocationResultKind { - return SlashCommandInvocationResultKindSelectSubcommand +// Path whose metadata should be returned from the client-provided session filesystem. +// Experimental: SessionFSStatRequest is part of an experimental API and may change or be +// removed. +type SessionFSStatRequest struct { + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Schema for the `SlashCommandTextResult` type. -// Experimental: SlashCommandTextResult is part of an experimental API and may change or be +// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +// Experimental: SessionFSStatResult is part of an experimental API and may change or be // removed. -type SlashCommandTextResult struct { - // Whether text contains Markdown - Markdown *bool `json:"markdown,omitempty"` - // Whether ANSI sequences should be preserved - PreserveAnsi *bool `json:"preserveAnsi,omitempty"` - // True when the invocation mutated user runtime settings; consumers caching settings should - // refresh - RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` - // Text output for the client to render - Text string `json:"text"` +type SessionFSStatResult struct { + // ISO 8601 timestamp of creation + Birthtime time.Time `json:"birthtime"` + // Describes a filesystem error. + Error *SessionFSError `json:"error,omitempty"` + // Whether the path is a directory + IsDirectory bool `json:"isDirectory"` + // Whether the path is a file + IsFile bool `json:"isFile"` + // ISO 8601 timestamp of last modification + Mtime time.Time `json:"mtime"` + // File size in bytes + Size int64 `json:"size"` } -func (SlashCommandTextResult) slashCommandInvocationResult() {} -func (SlashCommandTextResult) Kind() SlashCommandInvocationResultKind { - return SlashCommandInvocationResultKindText +// File path, content to write, and optional mode for the client-provided session filesystem. +// Experimental: SessionFSWriteFileRequest is part of an experimental API and may change or +// be removed. +type SessionFSWriteFileRequest struct { + // Content to write + Content string `json:"content"` + // Optional POSIX-style mode for newly created files + Mode *int64 `json:"mode,omitempty"` + // Path using SessionFs conventions + Path string `json:"path"` + // Target session identifier + SessionID string `json:"sessionId"` } -// Schema for the `SlashCommandSelectSubcommandOption` type. -// Experimental: SlashCommandSelectSubcommandOption is part of an experimental API and may -// change or be removed. -type SlashCommandSelectSubcommandOption struct { - // Human-readable description of the subcommand - Description string `json:"description"` - // Optional group label for organizing options - Group *string `json:"group,omitempty"` - // Subcommand name to invoke +// Experimental: SessionHistoryCompactRequest is part of an experimental API and may change +// or be removed. +type SessionHistoryCompactRequest struct { + // Optional user-provided instructions to focus the compaction summary + CustomInstructions *string `json:"customInstructions,omitempty"` + // Context window token limit this compaction is targeting, recorded as the `tokenLimit` on + // the persisted `session.compaction_start` / `session.compaction_complete` events. Set it + // when the compaction targets a window other than the compacting model's own, e.g. + // switching to a model with a smaller context window: the compaction still runs on the + // current model, so the limit that motivated it would otherwise be lost. When absent, the + // events record the compacting model's own resolved limit. Attribution metadata only - it + // does not change how much the compaction removes. + TokenLimit *int64 `json:"tokenLimit,omitempty"` + // What initiated this compaction request, recorded as the `trigger` on the persisted + // `session.compaction_start` / `session.compaction_complete` events. When absent, the + // compaction is persisted without trigger attribution (initiator unknown). + Trigger *SessionHistoryCompactRequestTrigger `json:"trigger,omitempty"` +} + +// Installed plugin record for a session, with marketplace, version, install time, enabled +// state, cache path, and source. +// Experimental: SessionInstalledPlugin is part of an experimental API and may change or be +// removed. +type SessionInstalledPlugin struct { + // Path where the plugin is cached locally + CachePath *string `json:"cache_path,omitempty"` + // Whether the plugin is currently enabled + Enabled bool `json:"enabled"` + // Installation timestamp (ISO-8601) + InstalledAt string `json:"installed_at"` + // Marketplace the plugin came from (empty string for direct repo installs) + Marketplace string `json:"marketplace"` + // Plugin name Name string `json:"name"` + // Source descriptor for direct repo installs (when marketplace is empty) + Source *SessionInstalledPluginSource `json:"source,omitempty"` + // Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus + // its resolved source subtree — NOT a Git commit SHA) captured at marketplace + // install/update time. Auto-update compares it against the freshly recomputed fingerprint + // to detect a content change that does not bump the version. Absent for pre-existing + // installs and for direct (non-marketplace) installs. + SourceSha *string `json:"source_sha,omitempty"` + // Installed version, if known + Version *string `json:"version,omitempty"` } -// Schema for the `TaskInfo` type. -// Experimental: TaskInfo is part of an experimental API and may change or be removed. -type TaskInfo interface { - taskInfo() - Type() TaskInfoType -} - -type RawTaskInfoData struct { - Discriminator TaskInfoType - Raw json.RawMessage +// Source descriptor for direct repo installs (when marketplace is empty) +// Experimental: SessionInstalledPluginSource is part of an experimental API and may change +// or be removed. +type SessionInstalledPluginSource struct { + SessionInstalledPluginSourceGitHub *SessionInstalledPluginSourceGitHub + SessionInstalledPluginSourceLocal *SessionInstalledPluginSourceLocal + SessionInstalledPluginSourceURL *SessionInstalledPluginSourceURL + String *string } -func (RawTaskInfoData) taskInfo() {} -func (r RawTaskInfoData) Type() TaskInfoType { - return r.Discriminator +// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or +// full commit SHA, and optional subpath. +// Experimental: SessionInstalledPluginSourceGitHub is part of an experimental API and may +// change or be removed. +type SessionInstalledPluginSourceGitHub struct { + Path *string `json:"path,omitempty"` + Ref *string `json:"ref,omitempty"` + Repo string `json:"repo"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` + // Constant value. Always "github". + Source SessionInstalledPluginSourceGitHubSource `json:"source"` } -// Schema for the `TaskAgentInfo` type. -// Experimental: TaskAgentInfo is part of an experimental API and may change or be removed. -type TaskAgentInfo struct { - // ISO 8601 timestamp when the current active period began - ActiveStartedAt *time.Time `json:"activeStartedAt,omitempty"` - // Accumulated active execution time in milliseconds - ActiveTimeMs *int64 `json:"activeTimeMs,omitempty"` - // Type of agent running this task - AgentType string `json:"agentType"` - // 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. - CanPromoteToBackground *bool `json:"canPromoteToBackground,omitempty"` - // ISO 8601 timestamp when the task finished - CompletedAt *time.Time `json:"completedAt,omitempty"` - // Short description of the task - Description string `json:"description"` - // Error message when the task failed - Error *string `json:"error,omitempty"` - // Whether task execution is synchronously awaited or managed in the background - ExecutionMode *TaskExecutionMode `json:"executionMode,omitempty"` - // Unique task identifier - ID string `json:"id"` - // ISO 8601 timestamp when the agent entered idle state - IdleSince *time.Time `json:"idleSince,omitempty"` - // Most recent response text from the agent - LatestResponse *string `json:"latestResponse,omitempty"` - // Model used for the task when specified - Model *string `json:"model,omitempty"` - // Prompt passed to the agent - Prompt string `json:"prompt"` - // Result text from the task when available - Result *string `json:"result,omitempty"` - // ISO 8601 timestamp when the task was started - StartedAt time.Time `json:"startedAt"` - // Current lifecycle status of the task - Status TaskStatus `json:"status"` - // Tool call ID associated with this agent task - ToolCallID string `json:"toolCallId"` +// Source descriptor for a direct local plugin install, with a local filesystem path. +// Experimental: SessionInstalledPluginSourceLocal is part of an experimental API and may +// change or be removed. +type SessionInstalledPluginSourceLocal struct { + Path string `json:"path"` + // Constant value. Always "local". + Source SessionInstalledPluginSourceLocalSource `json:"source"` } -func (TaskAgentInfo) taskInfo() {} -func (TaskAgentInfo) Type() TaskInfoType { - return TaskInfoTypeAgent +// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit +// SHA, and optional subpath. +// Experimental: SessionInstalledPluginSourceURL is part of an experimental API and may +// change or be removed. +type SessionInstalledPluginSourceURL struct { + Path *string `json:"path,omitempty"` + Ref *string `json:"ref,omitempty"` + // Optional full 40-character hexadecimal commit SHA. + Sha *string `json:"sha,omitempty"` + // Constant value. Always "url". + Source SessionInstalledPluginSourceURLSource `json:"source"` + URL string `json:"url"` } -// Schema for the `TaskShellInfo` type. -// Experimental: TaskShellInfo is part of an experimental API and may change or be removed. -type TaskShellInfo struct { - // Whether the shell runs inside a managed PTY session or as an independent background - // process - AttachmentMode TaskShellInfoAttachmentMode `json:"attachmentMode"` - // Whether this shell task can be promoted to background mode - CanPromoteToBackground *bool `json:"canPromoteToBackground,omitempty"` - // Command being executed - Command string `json:"command"` - // ISO 8601 timestamp when the task finished - CompletedAt *time.Time `json:"completedAt,omitempty"` - // Short description of the task - Description string `json:"description"` - // Whether task execution is synchronously awaited or managed in the background - ExecutionMode *TaskExecutionMode `json:"executionMode,omitempty"` - // Unique task identifier - ID string `json:"id"` - // Path to the detached shell log, when available - LogPath *string `json:"logPath,omitempty"` - // Process ID when available - Pid *int64 `json:"pid,omitempty"` - // ISO 8601 timestamp when the task was started - StartedAt time.Time `json:"startedAt"` - // Current lifecycle status of the task - Status TaskStatus `json:"status"` +// Baseline data provenance for a prediction. +// Experimental: SessionLimitPredictionBaselineData is part of an experimental API and may +// change or be removed. +type SessionLimitPredictionBaselineData struct { + // End of the baseline data slice. + WindowEnd string `json:"windowEnd"` + // Start of the baseline data slice. + WindowStart string `json:"windowStart"` } -func (TaskShellInfo) taskInfo() {} -func (TaskShellInfo) Type() TaskInfoType { - return TaskInfoTypeShell +// Explainable AI-credit session-limit prediction. +// Experimental: SessionLimitPredictionDetails is part of an experimental API and may change +// or be removed. +type SessionLimitPredictionDetails struct { + // Baseline data provenance. + BaselineData SessionLimitPredictionBaselineData `json:"baselineData"` + // Client population used for the prediction. + ClientType SessionLimitPredictionClientType `json:"clientType"` + // Resolved model family when known. + Family *string `json:"family,omitempty"` + // Model identifier used for lookup. + ModelID string `json:"modelId"` + // Recommended maximum AI credits for this session. + RecommendedCap float64 `json:"recommendedCap"` + // Tier chosen as the recommended cap. + RecommendedTier SessionLimitPredictionTier `json:"recommendedTier"` + // Baseline fallback level used to create the prediction. + Source SessionLimitPredictionSource `json:"source"` + // Key matched at the source level, such as a model id, family id, or `global`. + SourceKey string `json:"sourceKey"` + // Ordered usage tiers and their AI-credit caps. + Tiers []SessionLimitPredictionTierOption `json:"tiers"` +} + +// Experimental: SessionLimitPredictionPredictRequest is part of an experimental API and may +// change or be removed. +type SessionLimitPredictionPredictRequest struct { + // Client type to size for. Defaults to `cli-interactive`. + ClientType *SessionLimitPredictionClientType `json:"clientType,omitempty"` + // Optional model identifier override. If omitted, the session's current model is used. + ModelID *string `json:"modelId,omitempty"` } -// Background tasks currently tracked by the session. -// Experimental: TaskList is part of an experimental API and may change or be removed. -type TaskList struct { - // Currently tracked tasks - Tasks []TaskInfo `json:"tasks"` +type SessionLimitPredictionRequest struct { + // Client type to size for. Defaults to `cli-interactive`. + ClientType *SessionLimitPredictionClientType `json:"clientType,omitempty"` + // Optional model identifier override. If omitted, the session's current model is used. + ModelID *string `json:"modelId,omitempty"` } -// Experimental: TaskProgress is part of an experimental API and may change or be removed. -type TaskProgress interface { - taskProgress() - Type() TaskProgressType +// Prediction result. Available results include prediction details; unavailable results +// include an explicit reason. +// Experimental: SessionLimitPredictionResult is part of an experimental API and may change +// or be removed. +type SessionLimitPredictionResult interface { + sessionLimitPredictionResult() + Kind() SessionLimitPredictionResultKind } -type RawTaskProgressData struct { - Discriminator TaskProgressType +type RawSessionLimitPredictionResultData struct { + Discriminator SessionLimitPredictionResultKind Raw json.RawMessage } -func (RawTaskProgressData) taskProgress() {} -func (r RawTaskProgressData) Type() TaskProgressType { +func (RawSessionLimitPredictionResultData) sessionLimitPredictionResult() {} +func (r RawSessionLimitPredictionResultData) Kind() SessionLimitPredictionResultKind { return r.Discriminator } -// Schema for the `TaskAgentProgress` type. -// Experimental: TaskAgentProgress is part of an experimental API and may change or be -// removed. -type TaskAgentProgress struct { - // The most recent intent reported by the agent - LatestIntent *string `json:"latestIntent,omitempty"` - // Recent tool execution events converted to display lines - RecentActivity []TaskProgressLine `json:"recentActivity"` -} - -func (TaskAgentProgress) taskProgress() {} -func (TaskAgentProgress) Type() TaskProgressType { - return TaskProgressTypeAgent +type SessionLimitPredictionResultAvailable struct { + // Predicted session limit details. + Prediction SessionLimitPredictionDetails `json:"prediction"` } -// Schema for the `TaskShellProgress` type. -// Experimental: TaskShellProgress is part of an experimental API and may change or be -// removed. -type TaskShellProgress struct { - // Process ID when available - Pid *int64 `json:"pid,omitempty"` - // Recent stdout/stderr lines from the running shell command - RecentOutput string `json:"recentOutput"` +func (SessionLimitPredictionResultAvailable) sessionLimitPredictionResult() {} +func (SessionLimitPredictionResultAvailable) Kind() SessionLimitPredictionResultKind { + return SessionLimitPredictionResultKindAvailable } -func (TaskShellProgress) taskProgress() {} -func (TaskShellProgress) Type() TaskProgressType { - return TaskProgressTypeShell +type SessionLimitPredictionResultUnavailable struct { + // Reason no prediction is available. + Reason SessionLimitPredictionUnavailableReason `json:"reason"` } -// Schema for the `TaskProgressLine` type. -// Experimental: TaskProgressLine is part of an experimental API and may change or be -// removed. -type TaskProgressLine struct { - // Display message, e.g., "▸ bash", "✓ edit src/foo.ts" - Message string `json:"message"` - // ISO 8601 timestamp when this event occurred - Timestamp time.Time `json:"timestamp"` +func (SessionLimitPredictionResultUnavailable) sessionLimitPredictionResult() {} +func (SessionLimitPredictionResultUnavailable) Kind() SessionLimitPredictionResultKind { + return SessionLimitPredictionResultKindUnavailable } -// Identifier of the background task to cancel. -// Experimental: TasksCancelRequest is part of an experimental API and may change or be -// removed. -type TasksCancelRequest struct { - // Task identifier - ID string `json:"id"` +// Semantic usage tier and its AI-credit cap. +// Experimental: SessionLimitPredictionTierOption is part of an experimental API and may +// change or be removed. +type SessionLimitPredictionTierOption struct { + // AI-credit cap for this tier. + Cap float64 `json:"cap"` + Tier SessionLimitPredictionTier `json:"tier"` } -// Indicates whether the background task was successfully cancelled. -// Experimental: TasksCancelResult is part of an experimental API and may change or be +// Optional session limits. +// Experimental: SessionLimitsConfig is part of an experimental API and may change or be // removed. -type TasksCancelResult struct { - // Whether the task was successfully cancelled - Cancelled bool `json:"cancelled"` +type SessionLimitsConfig struct { + // Maximum AI Credits allowed across the session's current accounting window. + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` } -// The first sync-waiting task that can currently be promoted to background mode. -// Experimental: TasksGetCurrentPromotableResult is part of an experimental API and may -// change or be removed. -type TasksGetCurrentPromotableResult struct { - // The first sync-waiting task (agent first, then shell) that can currently be promoted to - // background mode. Omitted if no such task exists. The returned task is guaranteed to have - // executionMode='sync' and canPromoteToBackground=true at the time of the call. - Task TaskInfo `json:"task,omitempty"` +// Sessions matching the filter, ordered most-recently-modified first. +// Experimental: SessionList is part of an experimental API and may change or be removed. +type SessionList struct { + // Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + Sessions []SessionListEntry `json:"sessions"` } -// Identifier of the background task to fetch progress for. -// Experimental: TasksGetProgressRequest is part of an experimental API and may change or be +// Local or remote session metadata entry. Narrow on `isRemote` to access source-specific +// fields. +// Experimental: SessionListEntry is part of an experimental API and may change or be // removed. -type TasksGetProgressRequest struct { - // Task identifier (agent ID or shell ID) - ID string `json:"id"` +type SessionListEntry interface { + sessionListEntry() + sessionListEntryIsRemote() bool } -// Progress information for the task, or null when no task with that ID is tracked. -// Experimental: TasksGetProgressResult is part of an experimental API and may change or be -// removed. -type TasksGetProgressResult struct { - // Progress information for the task, discriminated by type. Returns null when no task with - // this ID is currently tracked. - Progress TaskProgress `json:"progress,omitempty"` +func (LocalSessionMetadataValue) sessionListEntry() {} +func (LocalSessionMetadataValue) sessionListEntryIsRemote() bool { + return false } -// The promoted task as it now exists in background mode, omitted if no promotable task was -// waiting. -// Experimental: TasksPromoteCurrentToBackgroundResult is part of an experimental API and -// may change or be removed. -type TasksPromoteCurrentToBackgroundResult struct { - // The promoted task as it now exists in background mode, omitted if no promotable task was - // waiting. Atomic operation: avoids the race window of getCurrentPromotable + - // promoteToBackground. - Task TaskInfo `json:"task,omitempty"` -} - -// Identifier of the task to promote to background mode. -// Experimental: TasksPromoteToBackgroundRequest is part of an experimental API and may -// change or be removed. -type TasksPromoteToBackgroundRequest struct { - // Task identifier - ID string `json:"id"` +// Remote session metadata for the session to hand off (typically obtained from +// `sessions.list` with `source: "remote"`). +// Experimental: RemoteSessionMetadataValue is part of an experimental API and may change or +// be removed. +type RemoteSessionMetadataValue struct { + // Most recent working directory context. + Context *SessionContext `json:"context,omitempty"` + // Last-modified time as an ISO 8601 timestamp. + ModifiedTime string `json:"modifiedTime"` + // Optional human-friendly name set via /rename. + Name *string `json:"name,omitempty"` + // Pull request number associated with the session. + PullRequestNumber *int64 `json:"pullRequestNumber,omitempty"` + // Backing remote session IDs (most recent first). + RemoteSessionIDs []string `json:"remoteSessionIds"` + // GitHub repository the remote session belongs to. + Repository RemoteSessionMetadataRepository `json:"repository"` + // Original remote resource identifier (task ID or PR node ID). + ResourceID *string `json:"resourceId,omitempty"` + // Stable session identifier. + SessionID string `json:"sessionId"` + // Deadline (ISO 8601) at which a CLI remote session becomes stale without further + // heartbeats. + StaleAt *string `json:"staleAt,omitempty"` + // Session creation time as an ISO 8601 timestamp. + StartTime string `json:"startTime"` + // Server-side task state returned by GitHub. + State *string `json:"state,omitempty"` + // Short summary of the session, when one has been derived. + Summary *string `json:"summary,omitempty"` + // Whether the remote task originated from CCA or CLI `--remote`. + TaskType *RemoteSessionMetadataTaskType `json:"taskType,omitempty"` } -// Indicates whether the task was successfully promoted to background mode. -// Experimental: TasksPromoteToBackgroundResult is part of an experimental API and may -// change or be removed. -type TasksPromoteToBackgroundResult struct { - // Whether the task was successfully promoted to background mode - Promoted bool `json:"promoted"` +func (RemoteSessionMetadataValue) sessionListEntry() {} +func (RemoteSessionMetadataValue) sessionListEntryIsRemote() bool { + return true } -// Refresh metadata for any detached background shells the runtime knows about. Use after a -// long pause to pick up exit/output state for shells running outside the agent loop. -// Experimental: TasksRefreshResult is part of an experimental API and may change or be +// Optional filter applied to the returned sessions +// Experimental: SessionListFilter is part of an experimental API and may change or be // removed. -type TasksRefreshResult struct { +type SessionListFilter struct { + // Match sessions whose context.branch equals this value + Branch *string `json:"branch,omitempty"` + // Match sessions whose context.cwd equals this value + Cwd *string `json:"cwd,omitempty"` + // Match sessions whose context.gitRoot equals this value + GitRoot *string `json:"gitRoot,omitempty"` + // Match sessions whose context.repository equals this value + Repository *string `json:"repository,omitempty"` } -// Identifier of the completed or cancelled task to remove from tracking. -// Experimental: TasksRemoveRequest is part of an experimental API and may change or be -// removed. -type TasksRemoveRequest struct { - // Task identifier - ID string `json:"id"` +// Queued repo-level startup prompts and the total hook command count after loading. +// Experimental: SessionLoadDeferredRepoHooksResult is part of an experimental API and may +// change or be removed. +type SessionLoadDeferredRepoHooksResult struct { + // Total hook command count (user + plugin + repo) loaded for the session by this call. + // Captured atomically with startupPrompts so callers don't need to read a separate counter. + HookCount int64 `json:"hookCount"` + // Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo + // configs were pending, or when disableAllHooks is set. + StartupPrompts []string `json:"startupPrompts"` } -// Indicates whether the task was removed. False when the task does not exist or is still -// running/idle. -// Experimental: TasksRemoveResult is part of an experimental API and may change or be -// removed. -type TasksRemoveResult struct { - // Whether the task was removed. Returns false if the task does not exist or is still - // running/idle (cancel it first). - Removed bool `json:"removed"` +// Experimental: SessionLspInitializeResult is part of an experimental API and may change or +// be removed. +type SessionLspInitializeResult struct { } -// Identifier of the target agent task, message content, and optional sender agent ID. -// Experimental: TasksSendMessageRequest is part of an experimental API and may change or be +// Enterprise permission policy expressed with the runtime's managed permission-rule syntax. +// Experimental: SessionManagedPermissions is part of an experimental API and may change or +// be removed. +type SessionManagedPermissions struct { + // Permission rules that allow matching operations unless another managed source, deny, or + // ask rule restricts them. + Allow []string `json:"allow,omitzero"` + // Permission rules that require explicit human approval. + Ask []string `json:"ask,omitzero"` + // Permission rules that block matching operations. Deny has highest precedence. + Deny []string `json:"deny,omitzero"` + // When set to `disable`, prevents bypass/allow-all permission modes. + DisableBypassPermissionsMode *DisableBypassPermissionsMode `json:"disableBypassPermissionsMode,omitempty"` +} + +// Managed settings an SDK host may inject at session startup. Only permissions are accepted +// in this initial contract. +// Experimental: SessionManagedSettings is part of an experimental API and may change or be // removed. -type TasksSendMessageRequest struct { - // Agent ID of the sender, if sent on behalf of another agent - FromAgentID *string `json:"fromAgentId,omitempty"` - // Agent task identifier - ID string `json:"id"` - // Message content to send to the agent - Message string `json:"message"` +type SessionManagedSettings struct { + Permissions *SessionManagedPermissions `json:"permissions,omitempty"` } -// Indicates whether the message was delivered, with an error message when delivery failed. -// Experimental: TasksSendMessageResult is part of an experimental API and may change or be -// removed. -type TasksSendMessageResult struct { - // Error message if delivery failed - Error *string `json:"error,omitempty"` - // Whether the message was successfully delivered or steered - Sent bool `json:"sent"` -} +// Standard MCP CallToolResult +// Experimental: SessionMCPAppsCallToolResult is part of an experimental API and may change +// or be removed. +type SessionMCPAppsCallToolResult map[string]any -// Agent type, prompt, name, and optional description and model override for the new task. -// Experimental: TasksStartAgentRequest is part of an experimental API and may change or be -// removed. -type TasksStartAgentRequest struct { - // Type of agent to start (e.g., 'explore', 'task', 'general-purpose') - AgentType string `json:"agentType"` - // Short description of the task - Description *string `json:"description,omitempty"` - // Optional model override - Model *string `json:"model,omitempty"` - // Short name for the agent, used to generate a human-readable ID - Name string `json:"name"` - // Task prompt for the agent - Prompt string `json:"prompt"` +// Experimental: SessionMCPAppsSetHostContextResult is part of an experimental API and may +// change or be removed. +type SessionMCPAppsSetHostContextResult struct { } -// Identifier assigned to the newly started background agent task. -// Experimental: TasksStartAgentResult is part of an experimental API and may change or be +// Experimental: SessionMCPDisableResult is part of an experimental API and may change or be // removed. -type TasksStartAgentResult struct { - // Generated agent ID for the background task - AgentID string `json:"agentId"` +type SessionMCPDisableResult struct { } -// Wait until all in-flight background tasks (agents + shells) and any follow-up turns -// scheduled by their completions have settled. Returns when the runtime is fully drained or -// after an internal timeout (default 10 minutes; configurable via -// COPILOT_TASK_WAIT_TIMEOUT_SECONDS). -// Experimental: TasksWaitForPendingResult is part of an experimental API and may change or -// be removed. -type TasksWaitForPendingResult struct { +// Experimental: SessionMCPEnableResult is part of an experimental API and may change or be +// removed. +type SessionMCPEnableResult struct { } -// Feature override key/value pairs to attach to subsequent telemetry events from this -// session. -// Experimental: TelemetrySetFeatureOverridesRequest is part of an experimental API and may -// change or be removed. -type TelemetrySetFeatureOverridesRequest struct { - // Override key/value pairs to attach to subsequent telemetry events from this session. - // Replaces any previously-set overrides. - Features map[string]string `json:"features"` +// Experimental: SessionMCPOauthAuthenticationStateChangedResult is part of an experimental +// API and may change or be removed. +type SessionMCPOauthAuthenticationStateChangedResult struct { } -// Schema for the `Tool` type. -type Tool struct { - // Description of what the tool does - Description string `json:"description"` - // Optional instructions for how to use this tool effectively - Instructions *string `json:"instructions,omitempty"` - // Tool identifier (e.g., "bash", "grep", "str_replace_editor") - Name string `json:"name"` - // Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP - // tools) - NamespacedName *string `json:"namespacedName,omitempty"` - // JSON Schema for the tool's input parameters - Parameters map[string]any `json:"parameters,omitempty"` +// Experimental: SessionMCPRegisterExternalClientResult is part of an experimental API and +// may change or be removed. +type SessionMCPRegisterExternalClientResult struct { } -// Built-in tools available for the requested model, with their parameters and instructions. -type ToolList struct { - // List of available built-in tools with metadata - Tools []Tool `json:"tools"` +// Experimental: SessionMCPReloadResult is part of an experimental API and may change or be +// removed. +type SessionMCPReloadResult struct { } -// Current lightweight tool metadata snapshot for the session. -// Experimental: ToolsGetCurrentMetadataResult is part of an experimental API and may change +// Experimental: SessionMCPRestartServerResult is part of an experimental API and may change // or be removed. -type ToolsGetCurrentMetadataResult struct { - // Current tool metadata, or null when tools have not been initialized yet - Tools []CurrentToolMetadata `json:"tools"` -} - -// Resolve, build, and validate the runtime tool list for this session. Subagent sessions -// and consumer flows that need an initialized tool set before `send` invoke this. Default -// base-class implementation is a no-op for sessions that don't support tool validation. -// Experimental: ToolsInitializeAndValidateResult is part of an experimental API and may -// change or be removed. -type ToolsInitializeAndValidateResult struct { +type SessionMCPRestartServerResult struct { } -// Optional model identifier whose tool overrides should be applied to the listing. -type ToolsListRequest struct { - // Optional model ID — when provided, the returned tool list reflects model-specific - // overrides - Model *string `json:"model,omitempty"` +// Experimental: SessionMCPStartServerResult is part of an experimental API and may change +// or be removed. +type SessionMCPStartServerResult struct { } -// Schema applied to each item in the array. -// Experimental: UIElicitationArrayAnyOfFieldItems is part of an experimental API and may -// change or be removed. -type UIElicitationArrayAnyOfFieldItems struct { - // Selectable options, each with a value and a display label. - AnyOf []UIElicitationArrayAnyOfFieldItemsAnyOf `json:"anyOf"` +// Experimental: SessionMCPStopServerResult is part of an experimental API and may change or +// be removed. +type SessionMCPStopServerResult struct { } -// Schema for the `UIElicitationArrayAnyOfFieldItemsAnyOf` type. -// Experimental: UIElicitationArrayAnyOfFieldItemsAnyOf is part of an experimental API and +// Experimental: SessionMCPUnregisterExternalClientResult is part of an experimental API and // may change or be removed. -type UIElicitationArrayAnyOfFieldItemsAnyOf struct { - // Value submitted when this option is selected. - Const string `json:"const"` - // Display label for this option. - Title string `json:"title"` +type SessionMCPUnregisterExternalClientResult struct { } -// Schema applied to each item in the array. -// Experimental: UIElicitationArrayEnumFieldItems is part of an experimental API and may -// change or be removed. -type UIElicitationArrayEnumFieldItems struct { - // Allowed string values for each selected item. - Enum []string `json:"enum"` - // Type discriminator. Always "string". - Type UIElicitationArrayEnumFieldItemsType `json:"type"` +// Point-in-time snapshot of slow-changing session identifier and state fields +// Experimental: SessionMetadataSnapshot is part of an experimental API and may change or be +// removed. +type SessionMetadataSnapshot struct { + // True when the session was detected to be in use by another process at construction time. + // Local consumers may surface a confirmation prompt before fully attaching. Always false + // for new sessions. + AlreadyInUse bool `json:"alreadyInUse"` + // Runtime client name associated with the session (telemetry identifier). + ClientName *string `json:"clientName,omitempty"` + // The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') + CurrentMode MetadataSnapshotCurrentMode `json:"currentMode"` + // User-provided name supplied at session construction (via `--name`), if any. Immutable + // after construction. + InitialName *string `json:"initialName,omitempty"` + // Whether this is a remote session (i.e., one whose runtime executes elsewhere and is + // steered through this process) + IsRemote bool `json:"isRemote"` + // ISO 8601 timestamp of when the session's persisted state was last modified on disk. For + // new sessions, equals startTime. For resumed sessions, reflects the previous modification + // time at construction. + ModifiedTime time.Time `json:"modifiedTime"` + // Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are + // immutable for the lifetime of the session. + RemoteMetadata *MetadataSnapshotRemoteMetadata `json:"remoteMetadata,omitempty"` + // Currently selected model identifier, if any + SelectedModel *string `json:"selectedModel,omitempty"` + // The unique identifier of the session + SessionID string `json:"sessionId"` + // Current session limits, or null when no limits are active + SessionLimits *SessionLimitsConfig `json:"sessionLimits"` + // ISO 8601 timestamp of when the session started + StartTime time.Time `json:"startTime"` + // Short human-readable summary of the session, if known. Omitted when no summary has been + // generated. + Summary *string `json:"summary,omitempty"` + // Absolute path to the session's current working directory + WorkingDirectory string `json:"workingDirectory"` + // Public-facing workspace metadata for this session, or null if the session has no + // associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, + // internal flags). + Workspace *WorkspaceSummary `json:"workspace,omitempty"` + // Absolute path to the session's workspace directory on disk, or null if the session has no + // associated workspace + WorkspacePath *string `json:"workspacePath"` } -// Schema for the `UIElicitationFieldValue` type. -// Experimental: UIElicitationFieldValue is part of an experimental API and may change or be +// The list of models available to this session. +// Experimental: SessionModelList is part of an experimental API and may change or be // removed. -type UIElicitationFieldValue interface { - uIElicitationFieldValue() +type SessionModelList struct { + // Available models, ordered with the most preferred default first. Includes both Copilot + // (CAPI) models and any registry BYOK models; a BYOK model appears under its + // provider-qualified selection id (`provider/id`). + List []any `json:"list"` + // Cost categories for the full CAPI catalog, including picker-disabled models that Auto may + // select. Metadata only; entries absent from `list` are not manually selectable. + ModelPriceCategories []SessionModelPriceCategory `json:"modelPriceCategories,omitzero"` + // Per-quota snapshots returned alongside the model list, keyed by quota type. + QuotaSnapshots map[string]any `json:"quotaSnapshots,omitzero"` } -type UIElicitationBooleanValue bool - -func (UIElicitationBooleanValue) uIElicitationFieldValue() {} - -type UIElicitationNumberValue float64 - -func (UIElicitationNumberValue) uIElicitationFieldValue() {} - -type UIElicitationStringArrayValue []string - -func (UIElicitationStringArrayValue) uIElicitationFieldValue() {} +// Experimental: SessionModelListRequest is part of an experimental API and may change or be +// removed. +type SessionModelListRequest struct { + // If true, bypasses the per-session model list cache and re-fetches from CAPI. + SkipCache *bool `json:"skipCache,omitempty"` +} -type UIElicitationStringValue string +// Cost-category metadata for a CAPI model. +// Experimental: SessionModelPriceCategory is part of an experimental API and may change or +// be removed. +type SessionModelPriceCategory struct { + ID string `json:"id"` + PriceCategory ModelPickerPriceCategory `json:"priceCategory"` +} -func (UIElicitationStringValue) uIElicitationFieldValue() {} +// Experimental: SessionModeSetResult is part of an experimental API and may change or be +// removed. +type SessionModeSetResult struct { +} -// Prompt message and JSON schema describing the form fields to elicit from the user. -// Experimental: UIElicitationRequest is part of an experimental API and may change or be +// Experimental: SessionNameSetResult is part of an experimental API and may change or be // removed. -type UIElicitationRequest struct { - // Message describing what information is needed from the user - Message string `json:"message"` - // JSON Schema describing the form fields to present to the user - RequestedSchema UIElicitationSchema `json:"requestedSchema"` +type SessionNameSetResult struct { } -// The elicitation response (accept with form values, decline, or cancel) -// Experimental: UIElicitationResponse is part of an experimental API and may change or be +// Session construction options. +// Experimental: SessionOpenOptions is part of an experimental API and may change or be // removed. -type UIElicitationResponse struct { - // The user's response: accept (submitted), decline (rejected), or cancel (dismissed) - Action UIElicitationResponseAction `json:"action"` - // The form values submitted by the user (present when action is 'accept') - Content map[string]UIElicitationFieldValue `json:"content,omitempty"` +type SessionOpenOptions struct { + // Additional content-exclusion policies to merge into the session policy set. + // Experimental: AdditionalContentExclusionPolicies is part of an experimental API and may + // change or be removed. + AdditionalContentExclusionPolicies []SessionOpenOptionsAdditionalContentExclusionPolicy `json:"additionalContentExclusionPolicies,omitzero"` + // Additional directories the agent may access beyond the working directory. Each entry is + // granted to the session's file-access allow-list and surfaced to the model (system prompt + // context and `@`-mention completion). Absolute paths are recommended; a relative path is + // resolved against the session's working directory. Nonexistent or unresolvable entries are + // skipped with a warning. This is applied on both session creation and resume, and is not + // persisted: a resumed session that omits this option does not retain previously supplied + // directories (re-supply them, exactly as the CLI re-passes `--add-dir`). + AdditionalDirectories []string `json:"additionalDirectories,omitzero"` + // Runtime context discriminator for agent filtering. + AgentContext *string `json:"agentContext,omitempty"` + // Whether to include instructions from every MCP server in the system prompt instead of + // only allowlisted servers. + AllowAllMCPServerInstructions *bool `json:"allowAllMcpServerInstructions,omitempty"` + // Whether ask_user is explicitly disabled. + AskUserDisabled *bool `json:"askUserDisabled,omitempty"` + // Initial authentication info for the session. + AuthInfo AuthInfo `json:"authInfo,omitempty"` + // Allowlist of available tool names. + AvailableTools []string `json:"availableTools,omitzero"` + // Options scoped to the built-in CAPI (Copilot API) provider. + Capi *CapiSessionOptions `json:"capi,omitempty"` + // Structured client kind used for runtime behavior gates. + ClientKind *string `json:"clientKind,omitempty"` + // Identifier of the client driving the session. + ClientName *string `json:"clientName,omitempty"` + // Whether commit-message coauthor trailers are enabled. + CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` + // Override Copilot configuration directory. + ConfigDir *string `json:"configDir,omitempty"` + // Whether auto-mode continuation is enabled. + ContinueOnAutoMode *bool `json:"continueOnAutoMode,omitempty"` + // Override URL for the Copilot API endpoint. + CopilotURL *string `json:"copilotUrl,omitempty"` + // Whether custom agents default to local-only execution. + CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` + // Parent engagement ID for detached child telemetry rollup. + DetachedFromSpawningParentEngagementID *string `json:"detachedFromSpawningParentEngagementId,omitempty"` + // Parent session ID for detached child telemetry rollup. + DetachedFromSpawningParentSessionID *string `json:"detachedFromSpawningParentSessionId,omitempty"` + // Instruction source IDs disabled for this session. + DisabledInstructionSources []string `json:"disabledInstructionSources,omitzero"` + // MCP server names disabled for this session. Disabled servers are not started or + // authenticated on create or cold resume. + DisabledMCPServers []string `json:"disabledMcpServers,omitzero"` + // Skill IDs disabled for this session. + DisabledSkills []string `json:"disabledSkills,omitzero"` + // Experimental: enable native model citations (Anthropic models today), normalized onto the + // `assistant.message` event. Off by default; may change or be removed while the citations + // surface is experimental. + // Experimental: EnableCitations is part of an experimental API and may change or be removed. + EnableCitations *bool `json:"enableCitations,omitempty"` + // Opt in to capturing file changes for session rewind and session diff. Capture cannot + // reconstruct changes made before it was enabled. On create it starts capture from the + // first turn. It is also honored on resume: for a session that already has tracked prior + // turns, tracking continues automatically even if this is omitted; passing it on resume + // additionally enables tracking for an eligible session that has no prior root turn yet. + // Resuming a session whose prior root turns were never tracked has no restorable baseline, + // so tracking stays disabled for it and rewind reports file change tracking as unavailable; + // the resume itself still succeeds, so sessions that predate tracking remain loadable. The + // opt-in is only rejected when the session can never track (a subagent session, or one + // without local session storage). It is intentionally absent from the mutable options + // update because enabling it after edits have occurred would create an incomplete, + // misleading baseline. Subagents share the parent session's capture store and are not + // tracked as separate rewind points: a file a subagent writes is attributed to whichever + // root user turn was open when the capture was staged, just before the tool body ran. A + // turn cannot open while a staged capture is still in flight, so a subagent tool that + // staged under the spawning turn stays attributed to it however late the write lands, while + // a capture it stages after the user's next message belongs to that later turn. Attribution + // decides which turn's rewind point counts and file preview include that write; it does not + // narrow which rewinds revert it, because a rewind restores every capture from the selected + // turn onward, so the earlier spawning turn reverts it as well. + EnableFileChangeTracking *bool `json:"enableFileChangeTracking,omitempty"` + // Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap. + EnableManagedSettings *bool `json:"enableManagedSettings,omitempty"` + // Whether on-demand custom instruction discovery is enabled. + EnableOnDemandInstructionDiscovery *bool `json:"enableOnDemandInstructionDiscovery,omitempty"` + // Whether shell-script safety heuristics are enabled. + EnableScriptSafety *bool `json:"enableScriptSafety,omitempty"` + // Whether model responses stream as delta events. + EnableStreaming *bool `json:"enableStreaming,omitempty"` + // How MCP server environment values are interpreted. + EnvValueMode *SessionOpenOptionsEnvValueMode `json:"envValueMode,omitempty"` + // Override directory for session event logs. + EventsLogDirectory *string `json:"eventsLogDirectory,omitempty"` + // Whether subagent callback events should be forwarded into the session event log sink. + EventsLogIncludesSubagents *bool `json:"eventsLogIncludesSubagents,omitempty"` + // Built-in subagent names to exclude from this session. Excluded built-ins are hidden from + // agent discovery and cannot be dispatched unless a custom agent with the same name is + // available. + ExcludedBuiltinAgents []string `json:"excludedBuiltinAgents,omitzero"` + // Denylist of tool names. + ExcludedTools []string `json:"excludedTools,omitzero"` + // ExP assignment ('flight') data injected by an SDK integrator, in the same JSON shape the + // Copilot CLI fetches from the experimentation service (CopilotExpAssignmentResponse). When + // supplied this is fed into the FeatureFlagService exactly like CLI-fetched assignments and + // ExP-backed flags wait for it. When absent the session does not block on ExP. + // Internal: ExpAssignments is part of the SDK's internal API surface and is not intended + // for external use. + ExpAssignments any `json:"expAssignments,omitempty"` + // Feature-flag values resolved by the host. + FeatureFlags map[string]bool `json:"featureFlags,omitzero"` + // Built-in subagent names to include in this session. When specified, only these built-ins + // are available, subject to runtime availability and exclusions. Custom agents with the + // same name remain available. + IncludedBuiltinAgents []string `json:"includedBuiltinAgents,omitzero"` + // Installed plugins visible to the session. + InstalledPlugins []InstalledPlugin `json:"installedPlugins,omitzero"` + // Stable integration identifier for analytics. + IntegrationID *string `json:"integrationId,omitempty"` + // Whether experimental behavior is enabled. + IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` + // Whether interactive shell sessions are logged. + LogInteractiveShells *bool `json:"logInteractiveShells,omitempty"` + // Identifier sent to LSP-style integrations. + LspClientName *string `json:"lspClientName,omitempty"` + // Permissions-only enterprise policy injected by the SDK host at session create or resume. + // Composes restrictively with self-fetched and device policy and is not persisted. + ManagedSettings *SessionManagedSettings `json:"managedSettings,omitempty"` + // Maximum decoded byte size of a single inline model-facing binary tool result persisted in + // session events (default 10 MB). + MaxInlineBinaryBytes *int64 `json:"maxInlineBinaryBytes,omitempty"` + // Memory configuration for this session. + Memory *MemoryConfiguration `json:"memory,omitempty"` + // Initial model identifier. + Model *string `json:"model,omitempty"` + // Initial model capability overrides. + ModelCapabilitiesOverrides *ModelCapabilitiesOverride `json:"modelCapabilitiesOverrides,omitempty"` + // BYOK model definitions added to the selectable model list, each referencing a provider + // name. + // Experimental: Models is part of an experimental API and may change or be removed. + Models []ProviderModelConfig `json:"models,omitzero"` + // Optional human-friendly session name. + Name *string `json:"name,omitempty"` + // Custom model-provider configuration (BYOK). + Provider *ProviderConfig `json:"provider,omitempty"` + // Named BYOK provider connections, additive to CAPI auth. Combining with `provider` is + // rejected. + // Experimental: Providers is part of an experimental API and may change or be removed. + Providers []NamedProviderConfig `json:"providers,omitzero"` + // Initial reasoning effort level. CAPI values are model-defined and validated against the + // selected model; BYOK providers may define additional values. When omitted, no effort + // override is applied. + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Initial reasoning summary mode for supported model clients. + ReasoningSummary *SessionOpenOptionsReasoningSummary `json:"reasoningSummary,omitempty"` + // Telemetry-only remote-defaulted flag. + RemoteDefaultedOn *bool `json:"remoteDefaultedOn,omitempty"` + // Telemetry-only remote exporting flag. + RemoteExporting *bool `json:"remoteExporting,omitempty"` + // Whether this session supports remote steering. + RemoteSteerable *bool `json:"remoteSteerable,omitempty"` + // Whether the host is an interactive UI. + RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` + // Resolved sandbox configuration. + SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + // Capabilities enabled for this session. + SessionCapabilities []SessionCapability `json:"sessionCapabilities,omitzero"` + // Optional stable session identifier to use for a new session. + SessionID *string `json:"sessionId,omitempty"` + // Initial session limits. + SessionLimits *SessionLimitsConfig `json:"sessionLimits,omitempty"` + // Per-session settings for built-in shell tools. + Shell *ShellOptions `json:"shell,omitempty"` + // Use shell.initProfile instead. Shell init profile. + // Deprecated: ShellInitProfile is deprecated. + ShellInitProfile *string `json:"shellInitProfile,omitempty"` + // PowerShell process flags applied to built-in and user-requested shell commands. + ShellProcessFlags []string `json:"shellProcessFlags,omitzero"` + // Additional directories to search for skills. + SkillDirectories []string `json:"skillDirectories,omitzero"` + // Whether to skip custom instruction sources. + SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` + // Optional trajectory output file path. + TrajectoryFile *string `json:"trajectoryFile,omitempty"` + // Initial output verbosity level for supported models. + Verbosity *Verbosity `json:"verbosity,omitempty"` + // Working directory to anchor the session. + WorkingDirectory *string `json:"workingDirectory,omitempty"` + // Pre-resolved working-directory context for session startup. + WorkingDirectoryContext *SessionContext `json:"workingDirectoryContext,omitempty"` } -// The form values submitted by the user (present when action is 'accept') -// Experimental: UIElicitationResponseContent is part of an experimental API and may change -// or be removed. -type UIElicitationResponseContent map[string]UIElicitationFieldValue +// Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated +// data, and scope. +// Experimental: SessionOpenOptionsAdditionalContentExclusionPolicy is part of an +// experimental API and may change or be removed. +type SessionOpenOptionsAdditionalContentExclusionPolicy struct { + LastUpdatedAt any `json:"last_updated_at"` + Rules []SessionOpenOptionsAdditionalContentExclusionPolicyRule `json:"rules"` + // Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` + // enumeration. + Scope SessionOpenOptionsAdditionalContentExclusionPolicyScope `json:"scope"` +} -// Indicates whether the elicitation response was accepted; false if it was already resolved -// by another client. -// Experimental: UIElicitationResult is part of an experimental API and may change or be -// removed. -type UIElicitationResult struct { - // Whether the response was accepted. False if the request was already resolved by another - // client. - Success bool `json:"success"` +// Single content-exclusion rule supplied to `sessions.open` options, with paths, match +// conditions, and source. +// Experimental: SessionOpenOptionsAdditionalContentExclusionPolicyRule is part of an +// experimental API and may change or be removed. +type SessionOpenOptionsAdditionalContentExclusionPolicyRule struct { + IfAnyMatch []string `json:"ifAnyMatch,omitzero"` + IfNoneMatch []string `json:"ifNoneMatch,omitzero"` + Paths []string `json:"paths"` + // Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. + Source SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource `json:"source"` } -// JSON Schema describing the form fields to present to the user -// Experimental: UIElicitationSchema is part of an experimental API and may change or be -// removed. -type UIElicitationSchema struct { - // Form field definitions, keyed by field name - Properties map[string]UIElicitationSchemaProperty `json:"properties"` - // List of required field names - Required []string `json:"required,omitempty"` - // Schema type indicator (always 'object') - Type UIElicitationSchemaType `json:"type"` +// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. +// Experimental: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource is part of an +// experimental API and may change or be removed. +type SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource struct { + Name string `json:"name"` + Type string `json:"type"` } -// Definition for a single elicitation form field. -// Experimental: UIElicitationSchemaProperty is part of an experimental API and may change -// or be removed. -type UIElicitationSchemaProperty interface { - uIElicitationSchemaProperty() - Type() UIElicitationSchemaPropertyType +// Open a session by creating, resuming, attaching, connecting to a remote, or handing off. +// Experimental: SessionOpenParams is part of an experimental API and may change or be +// removed. +type SessionOpenParams interface { + sessionOpenParams() + Kind() SessionOpenParamsKind } -type RawUIElicitationSchemaPropertyData struct { - Discriminator UIElicitationSchemaPropertyType +type RawSessionOpenParamsData struct { + Discriminator SessionOpenParamsKind Raw json.RawMessage } -func (RawUIElicitationSchemaPropertyData) uIElicitationSchemaProperty() {} -func (r RawUIElicitationSchemaPropertyData) Type() UIElicitationSchemaPropertyType { +func (RawSessionOpenParamsData) sessionOpenParams() {} +func (r RawSessionOpenParamsData) Kind() SessionOpenParamsKind { return r.Discriminator } -// Multi-select string field where each option pairs a value with a display label. -// Experimental: UIElicitationArrayAnyOfField is part of an experimental API and may change -// or be removed. -type UIElicitationArrayAnyOfField struct { - // Default values selected when the form is first shown. - Default []string `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Schema applied to each item in the array. - Items UIElicitationArrayAnyOfFieldItems `json:"items"` - // Maximum number of items the user may select. - MaxItems *int64 `json:"maxItems,omitempty"` - // Minimum number of items the user must select. - MinItems *int64 `json:"minItems,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for attaching to an already-active session by ID. +// Experimental: SessionsOpenAttach is part of an experimental API and may change or be +// removed. +type SessionsOpenAttach struct { + // Session ID to attach to. + SessionID string `json:"sessionId"` } -func (UIElicitationArrayAnyOfField) uIElicitationSchemaProperty() {} -func (UIElicitationArrayAnyOfField) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeArray +func (SessionsOpenAttach) sessionOpenParams() {} +func (SessionsOpenAttach) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindAttach } -// Multi-select string field whose allowed values are defined inline. -// Experimental: UIElicitationArrayEnumField is part of an experimental API and may change -// or be removed. -type UIElicitationArrayEnumField struct { - // Default values selected when the form is first shown. - Default []string `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Schema applied to each item in the array. - Items UIElicitationArrayEnumFieldItems `json:"items"` - // Maximum number of items the user may select. - MaxItems *int64 `json:"maxItems,omitempty"` - // Minimum number of items the user must select. - MinItems *int64 `json:"minItems,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for creating a new cloud session. +// Experimental: SessionsOpenCloud is part of an experimental API and may change or be +// removed. +type SessionsOpenCloud struct { + // In-process callback invoked when the cloud task is created (before connection). Marked + // internal because a function reference cannot cross the JSON-RPC boundary. Disappears in + // the SDK migration: the field is purely cosmetic (it flips a single CLI phase label from + // 'creating' to 'connecting') and the wire-clean version just drops the intermediate phase. + // Internal: OnTaskCreated is part of the SDK's internal API surface and is not intended for + // external use. + OnTaskCreated any `json:"onTaskCreated,omitempty"` + // Session options for cloud session creation. + Options *SessionOpenOptions `json:"options,omitempty"` + // Optional owner (user or organization login) to associate with the cloud session when no + // repository is provided. Ignored when `repository` is set (the repo's owner takes + // precedence). + Owner *string `json:"owner,omitempty"` + // Repository for the cloud session. + Repository *RemoteSessionRepository `json:"repository,omitempty"` } -func (UIElicitationArrayEnumField) uIElicitationSchemaProperty() {} -func (UIElicitationArrayEnumField) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeArray +func (SessionsOpenCloud) sessionOpenParams() {} +func (SessionsOpenCloud) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindCloud } -// Boolean field rendered as a yes/no toggle. -// Experimental: UIElicitationSchemaPropertyBoolean is part of an experimental API and may -// change or be removed. -type UIElicitationSchemaPropertyBoolean struct { - // Default value selected when the form is first shown. - Default *bool `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for creating a new local session. +// Experimental: SessionsOpenCreate is part of an experimental API and may change or be +// removed. +type SessionsOpenCreate struct { + // Whether to emit session.start during creation. Defaults to true. + EmitStart *bool `json:"emitStart,omitempty"` + // Session construction options. + Options *SessionOpenOptions `json:"options,omitempty"` } -func (UIElicitationSchemaPropertyBoolean) uIElicitationSchemaProperty() {} -func (UIElicitationSchemaPropertyBoolean) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeBoolean +func (SessionsOpenCreate) sessionOpenParams() {} +func (SessionsOpenCreate) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindCreate } -// Numeric field accepting either a number or an integer. -// Experimental: UIElicitationSchemaPropertyNumber is part of an experimental API and may -// change or be removed. -type UIElicitationSchemaPropertyNumber struct { - // Default value populated in the input when the form is first shown. - Default *float64 `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Maximum allowed value (inclusive). - Maximum *float64 `json:"maximum,omitempty"` - // Minimum allowed value (inclusive). - Minimum *float64 `json:"minimum,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` - Discriminator UIElicitationSchemaPropertyNumberType `json:"type,omitempty"` +// Parameters for fetching a remote session and handing it off to a new local session. +// Experimental: SessionsOpenHandoff is part of an experimental API and may change or be +// removed. +type SessionsOpenHandoff struct { + // Remote session metadata for the session to hand off (typically obtained from + // `sessions.list` with `source: "remote"`). + Metadata RemoteSessionMetadataValue `json:"metadata"` + // In-process confirmation callback `(request) => boolean | Promise` invoked when + // the handoff needs the caller to confirm a non-fatal blocker (e.g. a repository mismatch + // between the current working directory and the remote session). Returning `true` proceeds + // with the handoff; returning `false` (or omitting the callback) aborts it. Marked internal + // because a function reference cannot cross the JSON-RPC boundary, for the same reasons as + // `onProgress`. + // Internal: OnConfirm is part of the SDK's internal API surface and is not intended for + // external use. + OnConfirm any `json:"onConfirm,omitempty"` + // In-process progress callback `(update) => void` invoked for each handoff step. Marked + // internal because a function reference cannot cross the JSON-RPC boundary. The host-side + // `handoffSession` is already declared as `AsyncGenerator`; + // the schema layer flattens it because it does not yet support streaming methods. The + // wire-clean replacement is to expose the AsyncGenerator directly (or use vscode-jsonrpc + // `$/progress` notifications) once the schema/transport layer supports it. + // Internal: OnProgress is part of the SDK's internal API surface and is not intended for + // external use. + OnProgress any `json:"onProgress,omitempty"` + // Session construction options for the new local session. + Options *SessionOpenOptions `json:"options,omitempty"` + // Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient + // session). + TaskType *SessionsOpenHandoffTaskType `json:"taskType,omitempty"` } -func (UIElicitationSchemaPropertyNumber) uIElicitationSchemaProperty() {} -func (r UIElicitationSchemaPropertyNumber) Type() UIElicitationSchemaPropertyType { - if r.Discriminator == "" { - return UIElicitationSchemaPropertyTypeNumber - } - return UIElicitationSchemaPropertyType(r.Discriminator) +func (SessionsOpenHandoff) sessionOpenParams() {} +func (SessionsOpenHandoff) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindHandoff } -// Free-text string field with optional length and format constraints. -// Experimental: UIElicitationSchemaPropertyString is part of an experimental API and may -// change or be removed. -type UIElicitationSchemaPropertyString struct { - // Default value populated in the input when the form is first shown. - Default *string `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Optional format hint that constrains the accepted input. - Format *UIElicitationSchemaPropertyStringFormat `json:"format,omitempty"` - // Maximum number of characters allowed. - MaxLength *int64 `json:"maxLength,omitempty"` - // Minimum number of characters required. - MinLength *int64 `json:"minLength,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for connecting to a live remote session. +// Experimental: SessionsOpenRemote is part of an experimental API and may change or be +// removed. +type SessionsOpenRemote struct { + // Session options for the connection. + Options *SessionOpenOptions `json:"options,omitempty"` + // Remote session identifier to connect to. + RemoteSessionID string `json:"remoteSessionId"` + // Repository context for the remote session. + Repository *RemoteSessionRepository `json:"repository,omitempty"` } -func (UIElicitationSchemaPropertyString) uIElicitationSchemaProperty() {} -func (UIElicitationSchemaPropertyString) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeString +func (SessionsOpenRemote) sessionOpenParams() {} +func (SessionsOpenRemote) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindRemote } -// Single-select string field whose allowed values are defined inline. -// Experimental: UIElicitationStringEnumField is part of an experimental API and may change -// or be removed. -type UIElicitationStringEnumField struct { - // Default value selected when the form is first shown. - Default *string `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Allowed string values. - Enum []string `json:"enum"` - // Optional display labels for each enum value, in the same order as `enum`. - EnumNames []string `json:"enumNames,omitempty"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for resuming a specific local session. +// Experimental: SessionsOpenResume is part of an experimental API and may change or be +// removed. +type SessionsOpenResume struct { + // Session resume options. + Options *SessionOpenOptions `json:"options,omitempty"` + // Whether to emit session.resume after loading. Defaults to true. + Resume *bool `json:"resume,omitempty"` + // Session ID or unique prefix to resume. + SessionID string `json:"sessionId"` + // Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + SuppressResumeWorkspaceMetadataWriteback *bool `json:"suppressResumeWorkspaceMetadataWriteback,omitempty"` } -func (UIElicitationStringEnumField) uIElicitationSchemaProperty() {} -func (UIElicitationStringEnumField) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeString +func (SessionsOpenResume) sessionOpenParams() {} +func (SessionsOpenResume) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindResume } -// Single-select string field where each option pairs a value with a display label. -// Experimental: UIElicitationStringOneOfField is part of an experimental API and may change -// or be removed. -type UIElicitationStringOneOfField struct { - // Default value selected when the form is first shown. - Default *string `json:"default,omitempty"` - // Help text describing the field. - Description *string `json:"description,omitempty"` - // Selectable options, each with a value and a display label. - OneOf []UIElicitationStringOneOfFieldOneOf `json:"oneOf"` - // Human-readable label for the field. - Title *string `json:"title,omitempty"` +// Parameters for resuming the most relevant local session. +// Experimental: SessionsOpenResumeLast is part of an experimental API and may change or be +// removed. +type SessionsOpenResumeLast struct { + // Working-directory context used to choose the most relevant session. + Context *SessionContext `json:"context,omitempty"` + // Session resume options. + Options *SessionOpenOptions `json:"options,omitempty"` + // Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + SuppressResumeWorkspaceMetadataWriteback *bool `json:"suppressResumeWorkspaceMetadataWriteback,omitempty"` } -func (UIElicitationStringOneOfField) uIElicitationSchemaProperty() {} -func (UIElicitationStringOneOfField) Type() UIElicitationSchemaPropertyType { - return UIElicitationSchemaPropertyTypeString +func (SessionsOpenResumeLast) sessionOpenParams() {} +func (SessionsOpenResumeLast) Kind() SessionOpenParamsKind { + return SessionOpenParamsKindResumeLast } -// Schema for the `UIElicitationStringOneOfFieldOneOf` type. -// Experimental: UIElicitationStringOneOfFieldOneOf is part of an experimental API and may -// change or be removed. -type UIElicitationStringOneOfFieldOneOf struct { - // Value submitted when this option is selected. - Const string `json:"const"` - // Display label for this option. - Title string `json:"title"` +// Result of opening a session. +// Experimental: SessionOpenResult is part of an experimental API and may change or be +// removed. +type SessionOpenResult struct { + // Remote session metadata, present when status is `connected`. + Metadata *RemoteSessionMetadataValue `json:"metadata,omitempty"` + // Handoff progress steps, present when status is `handed_off`. + Progress []SessionsOpenProgress `json:"progress,omitzero"` + // Remote session ID, present when status is `connected`. + RemoteSessionID *string `json:"remoteSessionId,omitempty"` + // In-process SessionClientApi handle for the opened session, returned to CLI callers as a + // transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK + // consumers should construct per-session clients from `sessionId` instead. + // Internal: SessionAPI is part of the SDK's internal API surface and is not intended for + // external use. + SessionAPI any `json:"sessionApi,omitempty"` + // Opened session ID. Omitted when status is `not_found`. + SessionID *string `json:"sessionId,omitempty"` + // Startup prompts queued by user-level hook configs at session creation. Only populated + // when status is `created`; resumed sessions return an empty array. + StartupPrompts []string `json:"startupPrompts,omitzero"` + // Outcome of the open request. + Status SessionsOpenStatus `json:"status"` } -// Schema for the `UIExitPlanModeResponse` type. -// Experimental: UIExitPlanModeResponse is part of an experimental API and may change or be +// Experimental: SessionPlanDeleteResult is part of an experimental API and may change or be // removed. -type UIExitPlanModeResponse struct { - // Whether the plan was approved. - Approved bool `json:"approved"` - // Whether subsequent edits should be auto-approved without confirmation. - AutoApproveEdits *bool `json:"autoApproveEdits,omitempty"` - // Feedback from the user when they declined the plan or requested changes. - Feedback *string `json:"feedback,omitempty"` - // The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, - // otherwise 'interactive'. - SelectedAction *UIExitPlanModeAction `json:"selectedAction,omitempty"` +type SessionPlanDeleteResult struct { } -// Request ID of a pending `auto_mode_switch.requested` event and the user's response. -// Experimental: UIHandlePendingAutoModeSwitchRequest is part of an experimental API and may -// change or be removed. -type UIHandlePendingAutoModeSwitchRequest struct { - // The unique request ID from the auto_mode_switch.requested event - RequestID string `json:"requestId"` - // User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist - // as setting), or no (decline). - Response UIAutoModeSwitchResponse `json:"response"` +// Experimental: SessionPlanUpdateResult is part of an experimental API and may change or be +// removed. +type SessionPlanUpdateResult struct { } -// Pending elicitation request ID and the user's response (accept/decline/cancel + form -// values). -// Experimental: UIHandlePendingElicitationRequest is part of an experimental API and may -// change or be removed. -type UIHandlePendingElicitationRequest struct { - // The unique request ID from the elicitation.requested event - RequestID string `json:"requestId"` - // The elicitation response (accept with form values, decline, or cancel) - Result UIElicitationResponse `json:"result"` +// Experimental: SessionPluginsReloadRequest is part of an experimental API and may change +// or be removed. +type SessionPluginsReloadRequest struct { + // When true, skip repo-level hooks during the hook reload. Use before folder trust is + // confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + DeferRepoHooks *bool `json:"deferRepoHooks,omitempty"` + // Re-run custom-agent discovery after refreshing plugins. Defaults to true. + ReloadCustomAgents *bool `json:"reloadCustomAgents,omitempty"` + // Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) + // after refreshing plugins. Defaults to true. Has no effect when the session has no active + // extension controller (e.g. extensions were not requested for the session). + ReloadExtensions *bool `json:"reloadExtensions,omitempty"` + // Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has + // no effect when the host has not registered a hook reloader (e.g. remote sessions). + ReloadHooks *bool `json:"reloadHooks,omitempty"` + // Reload MCP server connections after refreshing plugins. Defaults to true. + ReloadMCP *bool `json:"reloadMcp,omitempty"` +} + +// Experimental: SessionPluginsReloadResult is part of an experimental API and may change or +// be removed. +type SessionPluginsReloadResult struct { } -// Request ID of a pending `exit_plan_mode.requested` event and the user's response. -// Experimental: UIHandlePendingExitPlanModeRequest is part of an experimental API and may +// Experimental: SessionProviderGetEndpointRequest is part of an experimental API and may // change or be removed. -type UIHandlePendingExitPlanModeRequest struct { - // The unique request ID from the exit_plan_mode.requested event - RequestID string `json:"requestId"` - // Schema for the `UIExitPlanModeResponse` type. - Response UIExitPlanModeResponse `json:"response"` +type SessionProviderGetEndpointRequest struct { + // Model identifier the caller intends to use against the returned endpoint. Used to pick + // the correct wire shape. Omit to use whichever model the session is currently using. + ModelID *string `json:"modelId,omitempty"` } -// Indicates whether the pending UI request was resolved by this call. -// Experimental: UIHandlePendingResult is part of an experimental API and may change or be +// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes +// freed, and the dry-run flag. +// Experimental: SessionPruneResult is part of an experimental API and may change or be // removed. -type UIHandlePendingResult struct { - // True if the request was still pending and was resolved by this call. False if the request - // ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise - // no longer pending. - Success bool `json:"success"` +type SessionPruneResult struct { + // Session IDs that would be deleted in dry-run mode (always empty otherwise) + Candidates []string `json:"candidates"` + // Session IDs that were deleted (always empty in dry-run mode) + Deleted []string `json:"deleted"` + // True when no deletions were actually performed + DryRun bool `json:"dryRun"` + // Total bytes freed (actual when not dry-run, projected when dry-run) + FreedBytes int64 `json:"freedBytes"` + // Session IDs that were skipped (e.g., named sessions) + Skipped []string `json:"skipped"` } -// Request ID of a pending `sampling.requested` event and an optional sampling result -// payload (omit to reject). -// Experimental: UIHandlePendingSamplingRequest is part of an experimental API and may -// change or be removed. -type UIHandlePendingSamplingRequest struct { - // The unique request ID from the sampling.requested event - RequestID string `json:"requestId"` - // Optional sampling result payload. Omit to reject/cancel the sampling request without - // providing a result. - Response *UIHandlePendingSamplingResponse `json:"response,omitempty"` +// Experimental: SessionQueueClearResult is part of an experimental API and may change or be +// removed. +type SessionQueueClearResult struct { } -// Optional sampling result payload. Omit to reject/cancel the sampling request without -// providing a result. -// Experimental: UIHandlePendingSamplingResponse is part of an experimental API and may +// Experimental: SessionQueueDeferSessionIdleResult is part of an experimental API and may // change or be removed. -type UIHandlePendingSamplingResponse struct { +type SessionQueueDeferSessionIdleResult struct { } -// Request ID of a pending `user_input.requested` event and the user's response. -// Experimental: UIHandlePendingUserInputRequest is part of an experimental API and may +// Experimental: SessionQueueProcessResult is part of an experimental API and may change or +// be removed. +type SessionQueueProcessResult struct { +} + +// Experimental: SessionQueueSetDrainPausedResult is part of an experimental API and may // change or be removed. -type UIHandlePendingUserInputRequest struct { - // The unique request ID from the user_input.requested event - RequestID string `json:"requestId"` - // Schema for the `UIUserInputResponse` type. - Response UIUserInputResponse `json:"response"` +type SessionQueueSetDrainPausedResult struct { } -// Register an in-process handler for `auto_mode_switch.requested` events. The caller still -// attaches the actual listener via the standard event-subscription mechanism; this -// registration solely tells the server bridge to skip its own dispatch (so a remote client -// doesn't race the in-process handler for the same requestId). -// Experimental: UIRegisterDirectAutoModeSwitchHandlerResult is part of an experimental API -// and may change or be removed. -type UIRegisterDirectAutoModeSwitchHandlerResult struct { - // Opaque handle representing the registration. Pass this same handle to - // `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. - // Multiple registrations are reference-counted; the server bridge will only dispatch - // auto-mode-switch requests when no handles are active. - Handle string `json:"handle"` +// Experimental: SessionRemoteDisableResult is part of an experimental API and may change or +// be removed. +type SessionRemoteDisableResult struct { } -// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. -// Experimental: UIUnregisterDirectAutoModeSwitchHandlerRequest is part of an experimental -// API and may change or be removed. -type UIUnregisterDirectAutoModeSwitchHandlerRequest struct { - // Handle previously returned by `registerDirectAutoModeSwitchHandler` - Handle string `json:"handle"` +// Session IDs to close, deactivate, and delete from disk. +// Experimental: SessionsBulkDeleteRequest is part of an experimental API and may change or +// be removed. +type SessionsBulkDeleteRequest struct { + // Session IDs to close, deactivate, and delete from disk + SessionIDs []string `json:"sessionIds"` } -// Indicates whether the handle was active and the registration count was decremented. -// Experimental: UIUnregisterDirectAutoModeSwitchHandlerResult is part of an experimental -// API and may change or be removed. -type UIUnregisterDirectAutoModeSwitchHandlerResult struct { - // True if the handle was active and decremented the counter; false if the handle was - // unknown. - Unregistered bool `json:"unregistered"` +// Session IDs to test for live in-use locks. +// Experimental: SessionsCheckInUseRequest is part of an experimental API and may change or +// be removed. +type SessionsCheckInUseRequest struct { + // Session IDs to test for live in-use locks + SessionIDs []string `json:"sessionIds"` } -// Schema for the `UIUserInputResponse` type. -// Experimental: UIUserInputResponse is part of an experimental API and may change or be +// Session IDs from the input set that are currently in use by another process. +// Experimental: SessionsCheckInUseResult is part of an experimental API and may change or +// be removed. +type SessionsCheckInUseResult struct { + // Session IDs from the input set that are currently held by another running process via an + // alive lock file + InUse []string `json:"inUse"` +} + +// Experimental: SessionScheduleHydrateResult is part of an experimental API and may change +// or be removed. +type SessionScheduleHydrateResult struct { +} + +// Session ID to close. +// Experimental: SessionsCloseRequest is part of an experimental API and may change or be // removed. -type UIUserInputResponse struct { - // The user's answer text - Answer string `json:"answer"` - // True if the user typed a freeform response, false if they selected a presented choice. - // Used by telemetry to differentiate between free text input and choice selection. - WasFreeform bool `json:"wasFreeform"` +type SessionsCloseRequest struct { + // Session ID to close + SessionID string `json:"sessionId"` } -// Accumulated session usage metrics, including premium request cost, token counts, model -// breakdown, and code-change totals. -// Experimental: UsageGetMetricsResult is part of an experimental API and may change or be +// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use +// lock, disposes the active session. Idempotent: succeeds even if the session is not +// currently active. +// Experimental: SessionsCloseResult is part of an experimental API and may change or be // removed. -type UsageGetMetricsResult struct { - // Aggregated code change metrics - CodeChanges UsageMetricsCodeChanges `json:"codeChanges"` - // Currently active model identifier - CurrentModel *string `json:"currentModel,omitempty"` - // Input tokens from the most recent main-agent API call - LastCallInputTokens int64 `json:"lastCallInputTokens"` - // Output tokens from the most recent main-agent API call - LastCallOutputTokens int64 `json:"lastCallOutputTokens"` - // Per-model token and request metrics, keyed by model identifier - ModelMetrics map[string]UsageMetricsModelMetric `json:"modelMetrics"` - // ISO 8601 timestamp when the session started - SessionStartTime time.Time `json:"sessionStartTime"` - // Session-wide per-token-type accumulated token counts - TokenDetails map[string]UsageMetricsTokenDetail `json:"tokenDetails,omitempty"` - // Total time spent in model API calls (milliseconds) - TotalAPIDurationMs int64 `json:"totalApiDurationMs"` - // Session-wide accumulated nano-AI units cost - TotalNanoAiu *float64 `json:"totalNanoAiu,omitempty"` - // Total user-initiated premium request cost across all models (may be fractional due to - // multipliers) - TotalPremiumRequestCost float64 `json:"totalPremiumRequestCost"` - // Raw count of user-initiated API requests - TotalUserRequests int64 `json:"totalUserRequests"` +type SessionsCloseResult struct { } -// Aggregated code change metrics -// Experimental: UsageMetricsCodeChanges is part of an experimental API and may change or be +// Experimental: SessionsConfigureSessionExtensionsResult is part of an experimental API and +// may change or be removed. +type SessionsConfigureSessionExtensionsResult struct { +} + +// Session ID to delete from disk. +// Experimental: SessionsDeleteRequest is part of an experimental API and may change or be // removed. -type UsageMetricsCodeChanges struct { - // Distinct file paths modified during the session - FilesModified []string `json:"filesModified"` - // Number of distinct files modified - FilesModifiedCount int64 `json:"filesModifiedCount"` - // Total lines of code added - LinesAdded int64 `json:"linesAdded"` - // Total lines of code removed - LinesRemoved int64 `json:"linesRemoved"` +type SessionsDeleteRequest struct { + // Session ID to delete + SessionID string `json:"sessionId"` + // Internal resolved session directory path to delete + SessionPath *string `json:"sessionPath,omitempty"` } -// Schema for the `UsageMetricsModelMetric` type. -// Experimental: UsageMetricsModelMetric is part of an experimental API and may change or be +// Experimental: SessionsDeleteResult is part of an experimental API and may change or be // removed. -type UsageMetricsModelMetric struct { - // Request count and cost metrics for this model - Requests UsageMetricsModelMetricRequests `json:"requests"` - // Token count details per type - TokenDetails map[string]UsageMetricsModelMetricTokenDetail `json:"tokenDetails,omitempty"` - // Accumulated nano-AI units cost for this model - TotalNanoAiu *float64 `json:"totalNanoAiu,omitempty"` - // Token usage metrics for this model - Usage UsageMetricsModelMetricUsage `json:"usage"` +type SessionsDeleteResult struct { } -// Request count and cost metrics for this model -// Experimental: UsageMetricsModelMetricRequests is part of an experimental API and may +// Experimental: SessionSendSystemNotificationResult is part of an experimental API and may // change or be removed. -type UsageMetricsModelMetricRequests struct { - // User-initiated premium request cost (with multiplier applied) - Cost float64 `json:"cost"` - // Number of API requests made with this model - Count int64 `json:"count"` +type SessionSendSystemNotificationResult struct { } -// Schema for the `UsageMetricsModelMetricTokenDetail` type. -// Experimental: UsageMetricsModelMetricTokenDetail is part of an experimental API and may -// change or be removed. -type UsageMetricsModelMetricTokenDetail struct { - // Accumulated token count for this token type - TokenCount int64 `json:"tokenCount"` +// Session metadata records to enrich with summary and context information. +// Experimental: SessionsEnrichMetadataRequest is part of an experimental API and may change +// or be removed. +type SessionsEnrichMetadataRequest struct { + // Session metadata records to enrich. Records that already have summary and context are + // returned unchanged. + Sessions []LocalSessionMetadataValue `json:"sessions"` } -// Token usage metrics for this model -// Experimental: UsageMetricsModelMetricUsage is part of an experimental API and may change +// New auth credentials to install on the session. Omit to leave credentials unchanged. +// Experimental: SessionSetCredentialsParams is part of an experimental API and may change // or be removed. -type UsageMetricsModelMetricUsage struct { - // Total tokens read from prompt cache - CacheReadTokens int64 `json:"cacheReadTokens"` - // Total tokens written to prompt cache - CacheWriteTokens int64 `json:"cacheWriteTokens"` - // Total input tokens consumed - InputTokens int64 `json:"inputTokens"` - // Total output tokens produced - OutputTokens int64 `json:"outputTokens"` - // Total output tokens used for reasoning - ReasoningTokens *int64 `json:"reasoningTokens,omitempty"` +type SessionSetCredentialsParams struct { + // The new auth credentials to install on the session. When omitted or `undefined`, the call + // is a no-op and the session's existing credentials are preserved. The runtime installs the + // supplied value immediately for outbound model/API requests. When the credential carries a + // raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally + // re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous + // install) so plan/quota/billing metadata regains fidelity; on resolution failure the + // verbatim credential remains installed. It does NOT otherwise validate the credential. + // Several variants carry secret material; treat this method's params as containing secrets + // at rest and in transit. + Credentials AuthInfo `json:"credentials,omitempty"` } -// Schema for the `UsageMetricsTokenDetail` type. -// Experimental: UsageMetricsTokenDetail is part of an experimental API and may change or be -// removed. -type UsageMetricsTokenDetail struct { - // Accumulated token count for this token type - TokenCount int64 `json:"tokenCount"` +// Indicates whether the credential update succeeded. +// Experimental: SessionSetCredentialsResult is part of an experimental API and may change +// or be removed. +type SessionSetCredentialsResult struct { + // Whether the session ended up with a populated `copilotUser` for the installed + // credentials. `true` when the supplied credential already carried `copilotUser` or it was + // successfully re-resolved server-side. `false` when the credential is installed without + // `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from + // the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In + // both `false` cases the token swap still applied, but plan/quota/billing metadata is + // degraded. Present whenever a credential was supplied; omitted only when no credential was + // supplied (no-op call). + CopilotUserResolved *bool `json:"copilotUserResolved,omitempty"` + // Whether the operation succeeded + Success bool `json:"success"` } -type UserSettingsReloadResult struct { +// Availability of built-in job tools surfaced to boundary consumers. +// Experimental: SessionSettingsBuiltInToolAvailabilitySnapshot is part of an experimental +// API and may change or be removed. +type SessionSettingsBuiltInToolAvailabilitySnapshot struct { + CreatePullRequest *bool `json:"createPullRequest,omitempty"` + ReportProgress *bool `json:"reportProgress,omitempty"` } -// The approval to add as a session-scoped rule -// Experimental: UserToolSessionApproval is part of an experimental API and may change or be -// removed. -type UserToolSessionApproval interface { - userToolSessionApproval() - Kind() UserToolSessionApprovalKind +// Named Rust-owned settings predicate to evaluate for this session. +// Experimental: SessionSettingsEvaluatePredicateRequest is part of an experimental API and +// may change or be removed. +type SessionSettingsEvaluatePredicateRequest struct { + // Predicate name. The runtime owns the raw feature-flag names and composition logic. + Name SessionSettingsPredicateName `json:"name"` + // Tool name for tool-scoped predicates such as trivial-change handling. + ToolName *string `json:"toolName,omitempty"` } -type RawUserToolSessionApprovalData struct { - Discriminator UserToolSessionApprovalKind - Raw json.RawMessage +// Result of evaluating a Rust-owned settings predicate. +// Experimental: SessionSettingsEvaluatePredicateResult is part of an experimental API and +// may change or be removed. +type SessionSettingsEvaluatePredicateResult struct { + Enabled bool `json:"enabled"` } -func (RawUserToolSessionApprovalData) userToolSessionApproval() {} -func (r RawUserToolSessionApprovalData) Kind() UserToolSessionApprovalKind { - return r.Discriminator +// Redacted job settings for a session. The job nonce is excluded. +// Experimental: SessionSettingsJobSnapshot is part of an experimental API and may change or +// be removed. +type SessionSettingsJobSnapshot struct { + BuiltInToolAvailability *SessionSettingsBuiltInToolAvailabilitySnapshot `json:"builtInToolAvailability,omitempty"` + EventType *string `json:"eventType,omitempty"` + IsTriggerJob *bool `json:"isTriggerJob,omitempty"` } -// Schema for the `UserToolSessionApprovalCommands` type. -// Experimental: UserToolSessionApprovalCommands is part of an experimental API and may -// change or be removed. -type UserToolSessionApprovalCommands struct { - // Command identifiers approved by the user - CommandIdentifiers []string `json:"commandIdentifiers"` +// Redacted model routing settings for a session. +// Experimental: SessionSettingsModelSnapshot is part of an experimental API and may change +// or be removed. +type SessionSettingsModelSnapshot struct { + CallbackURL *string `json:"callbackUrl,omitempty"` + DefaultReasoningEffort *string `json:"defaultReasoningEffort,omitempty"` + InstanceID *string `json:"instanceId,omitempty"` + Model *string `json:"model,omitempty"` } -func (UserToolSessionApprovalCommands) userToolSessionApproval() {} -func (UserToolSessionApprovalCommands) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindCommands +// Online-evaluation settings safe to expose across the SDK boundary. +// Experimental: SessionSettingsOnlineEvaluationSnapshot is part of an experimental API and +// may change or be removed. +type SessionSettingsOnlineEvaluationSnapshot struct { + DisableOnlineEvaluation *bool `json:"disableOnlineEvaluation,omitempty"` + EnableOnlineEvaluationOutputFile *bool `json:"enableOnlineEvaluationOutputFile,omitempty"` } -// Schema for the `UserToolSessionApprovalCustomTool` type. -// Experimental: UserToolSessionApprovalCustomTool is part of an experimental API and may +// Redacted repository and GitHub host settings for a session. +// Experimental: SessionSettingsRepoSnapshot is part of an experimental API and may change +// or be removed. +type SessionSettingsRepoSnapshot struct { + Branch *string `json:"branch,omitempty"` + Commit *string `json:"commit,omitempty"` + Host *string `json:"host,omitempty"` + HostProtocol *string `json:"hostProtocol,omitempty"` + ID *float64 `json:"id,omitempty"` + Name *string `json:"name,omitempty"` + OwnerID *float64 `json:"ownerId,omitempty"` + OwnerName *string `json:"ownerName,omitempty"` + PrCommitCount *float64 `json:"prCommitCount,omitempty"` + ReadWrite *bool `json:"readWrite,omitempty"` + SecretScanningURL *string `json:"secretScanningUrl,omitempty"` + ServerURL *string `json:"serverUrl,omitempty"` +} + +// Redacted, serializable view of session runtime settings for SDK boundary consumers. +// Secrets and raw feature flags are intentionally excluded. +// Experimental: SessionSettingsSnapshot is part of an experimental API and may change or be +// removed. +type SessionSettingsSnapshot struct { + ClientName *string `json:"clientName,omitempty"` + Job SessionSettingsJobSnapshot `json:"job"` + Model SessionSettingsModelSnapshot `json:"model"` + OnlineEvaluation SessionSettingsOnlineEvaluationSnapshot `json:"onlineEvaluation"` + Repo SessionSettingsRepoSnapshot `json:"repo"` + StartTimeMs *float64 `json:"startTimeMs,omitempty"` + TimeoutMs *float64 `json:"timeoutMs,omitempty"` + Validation SessionSettingsValidationSnapshot `json:"validation"` + Version *string `json:"version,omitempty"` +} + +// Redacted validation and memory-tool settings for a session. +// Experimental: SessionSettingsValidationSnapshot is part of an experimental API and may // change or be removed. -type UserToolSessionApprovalCustomTool struct { - // Custom tool name - ToolName string `json:"toolName"` +type SessionSettingsValidationSnapshot struct { + AdvisoryEnabled *bool `json:"advisoryEnabled,omitempty"` + CodeqlEnabled *bool `json:"codeqlEnabled,omitempty"` + CodeReviewEnabled *bool `json:"codeReviewEnabled,omitempty"` + CodeReviewModel *string `json:"codeReviewModel,omitempty"` + DependabotTimeout *float64 `json:"dependabotTimeout,omitempty"` + MemoryStoreEnabled *bool `json:"memoryStoreEnabled,omitempty"` + MemoryVoteEnabled *bool `json:"memoryVoteEnabled,omitempty"` + SecretScanningEnabled *bool `json:"secretScanningEnabled,omitempty"` + Timeout *float64 `json:"timeout,omitempty"` } -func (UserToolSessionApprovalCustomTool) userToolSessionApproval() {} -func (UserToolSessionApprovalCustomTool) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindCustomTool +// UUID prefix to resolve to a unique session ID. +// Experimental: SessionsFindByPrefixRequest is part of an experimental API and may change +// or be removed. +type SessionsFindByPrefixRequest struct { + // UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when + // there is no match or the prefix matches multiple sessions. + Prefix string `json:"prefix"` } -// Schema for the `UserToolSessionApprovalExtensionManagement` type. -// Experimental: UserToolSessionApprovalExtensionManagement is part of an experimental API -// and may change or be removed. -type UserToolSessionApprovalExtensionManagement struct { - // Optional operation identifier - Operation *string `json:"operation,omitempty"` +// Session ID matching the prefix, omitted when no unique match exists. +// Experimental: SessionsFindByPrefixResult is part of an experimental API and may change or +// be removed. +type SessionsFindByPrefixResult struct { + // Omitted when no unique session matches the prefix (no match or ambiguous) + SessionID *string `json:"sessionId,omitempty"` } -func (UserToolSessionApprovalExtensionManagement) userToolSessionApproval() {} -func (UserToolSessionApprovalExtensionManagement) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindExtensionManagement +// GitHub task ID to look up. +// Experimental: SessionsFindByTaskIDRequest is part of an experimental API and may change +// or be removed. +type SessionsFindByTaskIDRequest struct { + // GitHub task ID to look up + TaskID string `json:"taskId"` } -// Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type. -// Experimental: UserToolSessionApprovalExtensionPermissionAccess is part of an experimental -// API and may change or be removed. -type UserToolSessionApprovalExtensionPermissionAccess struct { - // Extension name - ExtensionName string `json:"extensionName"` +// ID of the local session bound to the given GitHub task, or omitted when none. +// Experimental: SessionsFindByTaskIDResult is part of an experimental API and may change or +// be removed. +type SessionsFindByTaskIDResult struct { + // Omitted when no local session is bound to that GitHub task + SessionID *string `json:"sessionId,omitempty"` } -func (UserToolSessionApprovalExtensionPermissionAccess) userToolSessionApproval() {} -func (UserToolSessionApprovalExtensionPermissionAccess) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindExtensionPermissionAccess +// Source session identifier to fork from, optional event-ID boundary, and optional friendly +// name for the new session. +// Experimental: SessionsForkRequest is part of an experimental API and may change or be +// removed. +type SessionsForkRequest struct { + // Optional friendly name to assign to the forked session. + Name *string `json:"name,omitempty"` + // Source session ID to fork from + SessionID string `json:"sessionId"` + // Optional event ID boundary. When provided, the fork includes only events before this ID + // (exclusive). When omitted, all events are included. + ToEventID *string `json:"toEventId,omitempty"` } -// Schema for the `UserToolSessionApprovalMcp` type. -// Experimental: UserToolSessionApprovalMcp is part of an experimental API and may change or -// be removed. -type UserToolSessionApprovalMcp struct { - // MCP server name - ServerName string `json:"serverName"` - // Optional MCP tool name, or null for all tools on the server - ToolName *string `json:"toolName"` +// Identifier and optional friendly name assigned to the newly forked session. +// Experimental: SessionsForkResult is part of an experimental API and may change or be +// removed. +type SessionsForkResult struct { + // Friendly name assigned to the forked session, if any. + Name *string `json:"name,omitempty"` + // The new forked session's ID + SessionID string `json:"sessionId"` } -func (UserToolSessionApprovalMcp) userToolSessionApproval() {} -func (UserToolSessionApprovalMcp) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindMcp +// Session ID whose board entry count should be returned. +// Experimental: SessionsGetBoardEntryCountRequest is part of an experimental API and may +// change or be removed. +type SessionsGetBoardEntryCountRequest struct { + // Session ID whose board entry count should be returned. + SessionID string `json:"sessionId"` } -// Schema for the `UserToolSessionApprovalMemory` type. -// Experimental: UserToolSessionApprovalMemory is part of an experimental API and may change -// or be removed. -type UserToolSessionApprovalMemory struct { +// Dynamic-context board entry count, when available. +// Experimental: SessionsGetBoardEntryCountResult is part of an experimental API and may +// change or be removed. +type SessionsGetBoardEntryCountResult struct { + // Board entry count, when available. + Count *int64 `json:"count,omitempty"` } -func (UserToolSessionApprovalMemory) userToolSessionApproval() {} -func (UserToolSessionApprovalMemory) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindMemory +// Session ID whose event-log file path to compute. +// Experimental: SessionsGetEventFilePathRequest is part of an experimental API and may +// change or be removed. +type SessionsGetEventFilePathRequest struct { + // Session ID whose event-log file path to compute + SessionID string `json:"sessionId"` } -// Schema for the `UserToolSessionApprovalRead` type. -// Experimental: UserToolSessionApprovalRead is part of an experimental API and may change -// or be removed. -type UserToolSessionApprovalRead struct { +// Absolute path to the session's events.jsonl file on disk. +// Experimental: SessionsGetEventFilePathResult is part of an experimental API and may +// change or be removed. +type SessionsGetEventFilePathResult struct { + // Absolute path to the session's events.jsonl file + FilePath string `json:"filePath"` } -func (UserToolSessionApprovalRead) userToolSessionApproval() {} -func (UserToolSessionApprovalRead) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindRead +// Optional working-directory context used to score session relevance. +// Experimental: SessionsGetLastForContextRequest is part of an experimental API and may +// change or be removed. +type SessionsGetLastForContextRequest struct { + // Optional working-directory context used to score session relevance. When omitted the + // most-recently-modified session wins. + Context *SessionContext `json:"context,omitempty"` } -// Schema for the `UserToolSessionApprovalWrite` type. -// Experimental: UserToolSessionApprovalWrite is part of an experimental API and may change -// or be removed. -type UserToolSessionApprovalWrite struct { +// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +// Experimental: SessionsGetLastForContextResult is part of an experimental API and may +// change or be removed. +type SessionsGetLastForContextResult struct { + // Most-relevant session ID for the supplied context, or omitted when no sessions exist + SessionID *string `json:"sessionId,omitempty"` } -func (UserToolSessionApprovalWrite) userToolSessionApproval() {} -func (UserToolSessionApprovalWrite) Kind() UserToolSessionApprovalKind { - return UserToolSessionApprovalKindWrite +// Session ID whose persisted metadata should be read. +// Experimental: SessionsGetMetadataRequest is part of an experimental API and may change or +// be removed. +type SessionsGetMetadataRequest struct { + // Session ID to inspect + SessionID string `json:"sessionId"` } -// A single changed file and its unified diff. -// Experimental: WorkspaceDiffFileChange is part of an experimental API and may change or be -// removed. -type WorkspaceDiffFileChange struct { - // Type of change represented by this file diff. - ChangeType WorkspaceDiffFileChangeType `json:"changeType"` - // Unified diff content for the file. Empty when the diff was truncated. - Diff string `json:"diff"` - // Whether the diff content was omitted because it exceeded the per-file size limit. - IsTruncated *bool `json:"isTruncated,omitempty"` - // Original file path for renamed files. - OldPath *string `json:"oldPath,omitempty"` - // Path to the changed file, relative to the workspace root. - Path string `json:"path"` +// Persisted local session metadata when the session exists. +// Experimental: SessionsGetMetadataResult is part of an experimental API and may change or +// be removed. +type SessionsGetMetadataResult struct { + // Local session metadata, omitted when the session does not exist. + Session *LocalSessionMetadataValue `json:"session,omitempty"` } -// Workspace diff result for the requested mode. -// Experimental: WorkspaceDiffResult is part of an experimental API and may change or be -// removed. -type WorkspaceDiffResult struct { - // Default branch used for a branch diff, when branch mode was requested. - BaseBranch *string `json:"baseBranch,omitempty"` - // Changed files and their unified diffs. - Changes []WorkspaceDiffFileChange `json:"changes"` - // Whether a requested branch diff fell back to unstaged changes because branch diff failed. - IsFallback bool `json:"isFallback"` - // Effective mode used for the returned changes. - Mode WorkspaceDiffMode `json:"mode"` - // Diff mode requested by the client. - RequestedMode WorkspaceDiffMode `json:"requestedMode"` +// Session ID to look up the persisted remote-steerable flag for. +// Experimental: SessionsGetPersistedRemoteSteerableRequest is part of an experimental API +// and may change or be removed. +type SessionsGetPersistedRemoteSteerableRequest struct { + // Session ID to look up the persisted remote-steerable flag for + SessionID string `json:"sessionId"` } -// Schema for the `WorkspacesCheckpoints` type. -// Experimental: WorkspacesCheckpoints is part of an experimental API and may change or be -// removed. -type WorkspacesCheckpoints struct { - // Filename of the checkpoint within the workspace checkpoints directory - Filename string `json:"filename"` - // Checkpoint number assigned by the workspace manager - Number int64 `json:"number"` - // Human-readable checkpoint title - Title string `json:"title"` +// The session's persisted remote-steerable flag, or omitted when no value has been +// persisted. +// Experimental: SessionsGetPersistedRemoteSteerableResult is part of an experimental API +// and may change or be removed. +type SessionsGetPersistedRemoteSteerableResult struct { + // The session's persisted remote-steerable flag if recorded; omitted when no value has been + // persisted + RemoteSteerable *bool `json:"remoteSteerable,omitempty"` } -// Relative path and UTF-8 content for the workspace file to create or overwrite. -// Experimental: WorkspacesCreateFileRequest is part of an experimental API and may change -// or be removed. -type WorkspacesCreateFileRequest struct { - // File content to write as a UTF-8 string - Content string `json:"content"` - // Relative path within the workspace files directory - Path string `json:"path"` +// Experimental: SessionShutdownResult is part of an experimental API and may change or be +// removed. +type SessionShutdownResult struct { } -// Parameters for computing a workspace diff. -// Experimental: WorkspacesDiffRequest is part of an experimental API and may change or be -// removed. -type WorkspacesDiffRequest struct { - // Diff mode requested by the client. - Mode WorkspaceDiffMode `json:"mode"` +// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +// Experimental: SessionSizes is part of an experimental API and may change or be removed. +type SessionSizes struct { + // Map of sessionId -> on-disk size in bytes for the session's workspace directory + Sizes map[string]int64 `json:"sizes"` } -// Current workspace metadata for the session, including its absolute filesystem path when -// available. -// Experimental: WorkspacesGetWorkspaceResult is part of an experimental API and may change -// or be removed. -type WorkspacesGetWorkspaceResult struct { - // Absolute filesystem path to the workspace directory. Omitted when the session has no - // workspace (e.g. remote sessions). - Path *string `json:"path,omitempty"` - // Current workspace metadata, or null if not available - Workspace *WorkspacesGetWorkspaceResultWorkspace `json:"workspace"` +// Experimental: SessionSkillsDisableResult is part of an experimental API and may change or +// be removed. +type SessionSkillsDisableResult struct { } -type WorkspacesGetWorkspaceResultWorkspace struct { - Branch *string `json:"branch,omitempty"` - ChronicleSyncDismissed *bool `json:"chronicle_sync_dismissed,omitempty"` - ClientName *string `json:"client_name,omitempty"` - CreatedAt *time.Time `json:"created_at,omitempty"` - Cwd *string `json:"cwd,omitempty"` - GitRoot *string `json:"git_root,omitempty"` - // Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - HostType *WorkspacesWorkspaceDetailsHostType `json:"host_type,omitempty"` - ID string `json:"id"` - McLastEventID *string `json:"mc_last_event_id,omitempty"` - McSessionID *string `json:"mc_session_id,omitempty"` - McTaskID *string `json:"mc_task_id,omitempty"` - Name *string `json:"name,omitempty"` - RemoteSteerable *bool `json:"remote_steerable,omitempty"` - Repository *string `json:"repository,omitempty"` - SummaryCount *int64 `json:"summary_count,omitempty"` - UpdatedAt *time.Time `json:"updated_at,omitempty"` - UserNamed *bool `json:"user_named,omitempty"` +// Experimental: SessionSkillsEnableResult is part of an experimental API and may change or +// be removed. +type SessionSkillsEnableResult struct { } -// Workspace checkpoints in chronological order; empty when the workspace is not enabled. -// Experimental: WorkspacesListCheckpointsResult is part of an experimental API and may +// Experimental: SessionSkillsEnsureLoadedResult is part of an experimental API and may // change or be removed. -type WorkspacesListCheckpointsResult struct { - // Workspace checkpoints in chronological order. Empty when workspace is not enabled. - Checkpoints []WorkspacesCheckpoints `json:"checkpoints"` +type SessionSkillsEnsureLoadedResult struct { } -// Relative paths of files stored in the session workspace files directory. -// Experimental: WorkspacesListFilesResult is part of an experimental API and may change or -// be removed. -type WorkspacesListFilesResult struct { - // Relative file paths in the workspace files directory - Files []string `json:"files"` +// Limit for non-empty local session IDs. +// Experimental: SessionsListNonEmptySessionIDsRequest is part of an experimental API and +// may change or be removed. +type SessionsListNonEmptySessionIDsRequest struct { + // Maximum number of session IDs to return. + Limit *int64 `json:"limit,omitempty"` } -// Checkpoint number to read. -// Experimental: WorkspacesReadCheckpointRequest is part of an experimental API and may +// Recent local session IDs that contain user-visible history. +// Experimental: SessionsListNonEmptySessionIDsResult is part of an experimental API and may // change or be removed. -type WorkspacesReadCheckpointRequest struct { - // Checkpoint number to read - Number int64 `json:"number"` +type SessionsListNonEmptySessionIDsResult struct { + // Session IDs ordered newest-first. + SessionIDs []string `json:"sessionIds"` } -// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. -// Experimental: WorkspacesReadCheckpointResult is part of an experimental API and may -// change or be removed. -type WorkspacesReadCheckpointResult struct { - // Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing - Content *string `json:"content"` +// Optional source filter, metadata-load limit, and context filter applied to the returned +// sessions. +// Experimental: SessionsListRequest is part of an experimental API and may change or be +// removed. +type SessionsListRequest struct { + // Optional filter applied to the returned sessions + Filter *SessionListFilter `json:"filter,omitempty"` + // When true, include detached maintenance sessions. Defaults to false for user-facing + // session lists. + IncludeDetached *bool `json:"includeDetached,omitempty"` + // When provided, only the first N local sessions (sorted by modification time, newest + // first) load full metadata; remaining sessions return basic info only. Use 0 to return + // only basic info for every local session. Has no effect on remote entries (which always + // carry their full shape). + MetadataLimit *int64 `json:"metadataLimit,omitempty"` + // Which session sources to include. Defaults to `local` for backward compatibility. + Source *SessionSource `json:"source,omitempty"` + // Only meaningful when `source` includes remote. When true, propagates errors from the + // remote service instead of silently returning an empty remote list. Defaults to false. + ThrowOnError *bool `json:"throwOnError,omitempty"` } -// Relative path of the workspace file to read. -// Experimental: WorkspacesReadFileRequest is part of an experimental API and may change or +// Active session ID whose deferred repo-level hooks should be loaded. +// Experimental: SessionsLoadDeferredRepoHooksRequest is part of an experimental API and may +// change or be removed. +type SessionsLoadDeferredRepoHooksRequest struct { + // Active session ID whose deferred repo-level hooks should be loaded + SessionID string `json:"sessionId"` +} + +// `sessions.open` handoff progress update with step, status, and optional message. +// Experimental: SessionsOpenProgress is part of an experimental API and may change or be +// removed. +type SessionsOpenProgress struct { + // Optional step message. + Message *string `json:"message,omitempty"` + // Step status. + Status SessionsOpenProgressStatus `json:"status"` + // Handoff step. + Step SessionsOpenProgressStep `json:"step"` +} + +// Age threshold and optional flags controlling which old sessions are pruned (or simulated +// when dryRun is true). +// Experimental: SessionsPruneOldRequest is part of an experimental API and may change or be +// removed. +type SessionsPruneOldRequest struct { + // When true, only report what would be deleted without performing any deletion + DryRun *bool `json:"dryRun,omitempty"` + // Session IDs that should never be considered for pruning + ExcludeSessionIDs []string `json:"excludeSessionIds,omitzero"` + // When true, named sessions (set via /rename) are also eligible for pruning + IncludeNamed *bool `json:"includeNamed,omitempty"` + // Delete sessions whose modifiedTime is at least this many days old + OlderThanDays int64 `json:"olderThanDays"` +} + +// Optional registration options. +// Experimental: SessionsRegisterExtensionToolsOnSessionOptions is part of an experimental +// API and may change or be removed. +type SessionsRegisterExtensionToolsOnSessionOptions struct { + // In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: + // replaced by runtime-side enable/disable RPCs in the SDK migration. + // Internal: Enabled is part of the SDK's internal API surface and is not intended for + // external use. + Enabled any `json:"enabled,omitempty"` +} + +// Session ID whose in-use lock should be released. +// Experimental: SessionsReleaseLockRequest is part of an experimental API and may change or // be removed. -type WorkspacesReadFileRequest struct { - // Relative path within the workspace files directory - Path string `json:"path"` +type SessionsReleaseLockRequest struct { + // Session ID whose in-use lock should be released + SessionID string `json:"sessionId"` } -// Contents of the requested workspace file as a UTF-8 string. -// Experimental: WorkspacesReadFileResult is part of an experimental API and may change or +// Release the in-use lock held by this process for the given session. No-op when this +// process does not currently hold a lock for the session. +// Experimental: SessionsReleaseLockResult is part of an experimental API and may change or // be removed. -type WorkspacesReadFileResult struct { - // File content as a UTF-8 string - Content string `json:"content"` +type SessionsReleaseLockResult struct { } -// Pasted content to save as a UTF-8 file in the session workspace. -// Experimental: WorkspacesSaveLargePasteRequest is part of an experimental API and may +// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +// Experimental: SessionsReloadPluginHooksRequest is part of an experimental API and may // change or be removed. -type WorkspacesSaveLargePasteRequest struct { - // Pasted content to save as a UTF-8 file - Content string `json:"content"` +type SessionsReloadPluginHooksRequest struct { + // When true, skip repo-level hooks. Use before folder trust is confirmed; + // loadDeferredRepoHooks loads them post-trust. + DeferRepoHooks *bool `json:"deferRepoHooks,omitempty"` + // Active session ID to reload hooks for + SessionID string `json:"sessionId"` } -// Descriptor for the saved paste file, or null when the workspace is unavailable. -// Experimental: WorkspacesSaveLargePasteResult is part of an experimental API and may +// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. +// Call after installing or removing plugins so their hooks take effect immediately. No-op +// when no active session matches the given sessionId. +// Experimental: SessionsReloadPluginHooksResult is part of an experimental API and may // change or be removed. -type WorkspacesSaveLargePasteResult struct { - // Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, - // non-infinite sessions, remote sessions) - Saved *WorkspacesSaveLargePasteResultSaved `json:"saved"` +type SessionsReloadPluginHooksResult struct { } -type WorkspacesSaveLargePasteResultSaved struct { - // Filename within the workspace files directory - Filename string `json:"filename"` - // Absolute filesystem path to the saved paste file - FilePath string `json:"filePath"` - // Size of the saved file in bytes - SizeBytes int64 `json:"sizeBytes"` +// Session ID whose pending events should be flushed to disk. +// Experimental: SessionsSaveRequest is part of an experimental API and may change or be +// removed. +type SessionsSaveRequest struct { + // Session ID whose pending events should be flushed to disk + SessionID string `json:"sessionId"` } -// Public-facing projection of workspace metadata for SDK / TUI consumers -// Experimental: WorkspaceSummary is part of an experimental API and may change or be +// Flush a session's pending events to disk. No-op when no writer exists for the session +// (e.g., already closed). +// Experimental: SessionsSaveResult is part of an experimental API and may change or be // removed. -type WorkspaceSummary struct { - // Branch checked out at session start, if any - Branch *string `json:"branch,omitempty"` - // ISO 8601 timestamp when the workspace was created - CreatedAt *time.Time `json:"created_at,omitempty"` - // Current working directory at session start - Cwd *string `json:"cwd,omitempty"` - // Resolved git root for cwd, if any - GitRoot *string `json:"git_root,omitempty"` - // Repository host type, if known - HostType *WorkspaceSummaryHostType `json:"host_type,omitempty"` - // Workspace identifier (1:1 with sessionId) - ID string `json:"id"` - // Display name for the session, if set - Name *string `json:"name,omitempty"` - // Repository identifier in 'owner/repo' or 'org/project/repo' format, if any - Repository *string `json:"repository,omitempty"` - // ISO 8601 timestamp when the workspace was last updated - UpdatedAt *time.Time `json:"updated_at,omitempty"` +type SessionsSaveResult struct { } -// Finite reason code describing why the current turn was aborted -// Experimental: AbortReason is part of an experimental API and may change or be removed. -type AbortReason string - -const ( - // A remote command requested the abort. - AbortReasonRemoteCommand AbortReason = "remote_command" - // An MCP server delivered a user.abort notification. - AbortReasonUserAbort AbortReason = "user_abort" - // The local user requested the abort, for example by pressing Ctrl+C in the CLI. - AbortReasonUserInitiated AbortReason = "user_initiated" -) - -// Where the agent definition was loaded from -// Experimental: AgentInfoSource is part of an experimental API and may change or be removed. -type AgentInfoSource string - -const ( - // Agent built into the Copilot runtime. - AgentInfoSourceBuiltin AgentInfoSource = "builtin" - // Agent inherited from a parent project or workspace. - AgentInfoSourceInherited AgentInfoSource = "inherited" - // Agent contributed by an installed plugin. - AgentInfoSourcePlugin AgentInfoSource = "plugin" - // Agent loaded from the current project's repository configuration. - AgentInfoSourceProject AgentInfoSource = "project" - // Agent provided by a remote runtime or service. - AgentInfoSourceRemote AgentInfoSource = "remote" - // Agent loaded from the user's personal agent configuration. - AgentInfoSourceUser AgentInfoSource = "user" -) - -// Kind of attention required when status === "attention". Meaningful only when status === -// "attention". -// Experimental: AgentRegistryLiveTargetEntryAttentionKind is part of an experimental API -// and may change or be removed. -type AgentRegistryLiveTargetEntryAttentionKind string - -const ( - // Session is waiting on an elicitation prompt - AgentRegistryLiveTargetEntryAttentionKindElicitation AgentRegistryLiveTargetEntryAttentionKind = "elicitation" - // Session is blocked on an unrecoverable error - AgentRegistryLiveTargetEntryAttentionKindError AgentRegistryLiveTargetEntryAttentionKind = "error" - // Session is waiting for the user to approve or reject a plan - AgentRegistryLiveTargetEntryAttentionKindExitPlan AgentRegistryLiveTargetEntryAttentionKind = "exit_plan" - // Session is waiting for a tool-permission decision - AgentRegistryLiveTargetEntryAttentionKindPermission AgentRegistryLiveTargetEntryAttentionKind = "permission" - // Session is waiting for free-form user input - AgentRegistryLiveTargetEntryAttentionKindUserInput AgentRegistryLiveTargetEntryAttentionKind = "user_input" -) - -// Process kind tag for the registry entry -// Experimental: AgentRegistryLiveTargetEntryKind is part of an experimental API and may +// Manager-wide additional plugins to register; replaces any previously-configured set. +// Experimental: SessionsSetAdditionalPluginsRequest is part of an experimental API and may // change or be removed. -type AgentRegistryLiveTargetEntryKind string - -const ( - // Headless `--server --managed-server` child spawned by a controller - AgentRegistryLiveTargetEntryKindManagedServer AgentRegistryLiveTargetEntryKind = "managed-server" - // Interactive Copilot CLI exposing a UI server (legacy/normal CLI process) - AgentRegistryLiveTargetEntryKindUIServer AgentRegistryLiveTargetEntryKind = "ui-server" -) - -// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done -// from done_cancelled. -// Experimental: AgentRegistryLiveTargetEntryLastTerminalEvent is part of an experimental -// API and may change or be removed. -type AgentRegistryLiveTargetEntryLastTerminalEvent string - -const ( - // Last turn was aborted (e.g. user interrupted) - AgentRegistryLiveTargetEntryLastTerminalEventAbort AgentRegistryLiveTargetEntryLastTerminalEvent = "abort" - // Last turn ended cleanly (model returned a final assistant message) - AgentRegistryLiveTargetEntryLastTerminalEventTurnEnd AgentRegistryLiveTargetEntryLastTerminalEvent = "turn_end" -) +type SessionsSetAdditionalPluginsRequest struct { + // Manager-wide additional plugins to register. Replaces any previously-configured set. Pass + // an empty array to clear. + Plugins []InstalledPlugin `json:"plugins"` +} -// Coarse lifecycle status of the foreground session -// Experimental: AgentRegistryLiveTargetEntryStatus is part of an experimental API and may +// Replace the manager-wide additional plugins. New session creations and subsequent hook +// reloads see the new set; already-running sessions keep their existing hook installation +// until the next reload. +// Experimental: SessionsSetAdditionalPluginsResult is part of an experimental API and may // change or be removed. -type AgentRegistryLiveTargetEntryStatus string - -const ( - // Session needs user attention (see attentionKind for the specific reason) - AgentRegistryLiveTargetEntryStatusAttention AgentRegistryLiveTargetEntryStatus = "attention" - // Last turn completed successfully - AgentRegistryLiveTargetEntryStatusDone AgentRegistryLiveTargetEntryStatus = "done" - // Session is idle, waiting for input - AgentRegistryLiveTargetEntryStatusWaiting AgentRegistryLiveTargetEntryStatus = "waiting" - // Session is actively processing a turn - AgentRegistryLiveTargetEntryStatusWorking AgentRegistryLiveTargetEntryStatus = "working" -) +type SessionsSetAdditionalPluginsResult struct { +} -// Categorized reason for log-open failure -// Experimental: AgentRegistryLogCaptureOpenErrorReason is part of an experimental API and +// Patch for the singleton's steering state. +// Experimental: SessionsSetRemoteControlSteeringRequest is part of an experimental API and // may change or be removed. -type AgentRegistryLogCaptureOpenErrorReason string +type SessionsSetRemoteControlSteeringRequest struct { + // Target steering state. Today only `true` is actionable on the underlying exporter; + // `false` is reserved for future use. + Enabled bool `json:"enabled"` +} -const ( - // No space left on device - AgentRegistryLogCaptureOpenErrorReasonDiskFull AgentRegistryLogCaptureOpenErrorReason = "disk_full" - // Other / uncategorized open failure - AgentRegistryLogCaptureOpenErrorReasonOther AgentRegistryLogCaptureOpenErrorReason = "other" - // Filesystem permission denied opening the log file - AgentRegistryLogCaptureOpenErrorReasonPermission AgentRegistryLogCaptureOpenErrorReason = "permission" -) +// Parameters for attaching the remote-control singleton to a session. +// Experimental: SessionsStartRemoteControlRequest is part of an experimental API and may +// change or be removed. +type SessionsStartRemoteControlRequest struct { + // Configuration for the runtime-managed remote-control singleton. + Config RemoteControlConfig `json:"config"` + // Local session id to attach remote control to. + SessionID string `json:"sessionId"` +} -// Permission posture for the new session. 'yolo' requires the controller-local session to -// currently be in allow-all mode. -// Experimental: AgentRegistrySpawnPermissionMode is part of an experimental API and may +// Experimental: SessionsStopRemoteControlRequest is part of an experimental API and may // change or be removed. -type AgentRegistrySpawnPermissionMode string +type SessionsStopRemoteControlRequest struct { + // When provided, the stop is rejected unless the singleton currently points at this session + // id (compare-and-swap semantics). + ExpectedSessionID *string `json:"expectedSessionId,omitempty"` + // When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. + // Use during shutdown or explicit `/remote off`. + Force *bool `json:"force,omitempty"` +} -const ( - // Standard permission posture (prompts for each request) - AgentRegistrySpawnPermissionModeDefault AgentRegistrySpawnPermissionMode = "default" - // Full allow-all (requires the controller-local session to currently be in allow-all mode) - AgentRegistrySpawnPermissionModeYolo AgentRegistrySpawnPermissionMode = "yolo" -) +// Parameters for atomically rebinding the remote-control singleton. +// Experimental: SessionsTransferRemoteControlRequest is part of an experimental API and may +// change or be removed. +type SessionsTransferRemoteControlRequest struct { + // When provided, the transfer is rejected unless the singleton currently points at this + // session id (compare-and-swap semantics to avoid clobbering newer state). + ExpectedFromSessionID *string `json:"expectedFromSessionId,omitempty"` + // Local session id to point remote control at. + ToSessionID string `json:"toSessionId"` +} -// Kind discriminator for AgentRegistrySpawnResult. -type AgentRegistrySpawnResultKind string +// Experimental: SessionSuspendResult is part of an experimental API and may change or be +// removed. +type SessionSuspendResult struct { +} -const ( - AgentRegistrySpawnResultKindRegistryTimeout AgentRegistrySpawnResultKind = "registry-timeout" - AgentRegistrySpawnResultKindSpawned AgentRegistrySpawnResultKind = "spawned" - AgentRegistrySpawnResultKindSpawnError AgentRegistrySpawnResultKind = "spawn-error" - AgentRegistrySpawnResultKindValidationError AgentRegistrySpawnResultKind = "validation-error" -) +// Telemetry engagement ID for the session, when available. +// Experimental: SessionTelemetryEngagement is part of an experimental API and may change or +// be removed. +type SessionTelemetryEngagement struct { + // Current telemetry engagement ID, when available. + EngagementID *string `json:"engagementId,omitempty"` +} -// Which parameter field was invalid. Omitted when the rejection is not field-specific. -// Experimental: AgentRegistrySpawnValidationErrorField is part of an experimental API and -// may change or be removed. -type AgentRegistrySpawnValidationErrorField string - -const ( - // The agentName parameter - AgentRegistrySpawnValidationErrorFieldAgentName AgentRegistrySpawnValidationErrorField = "agentName" - // The cwd parameter - AgentRegistrySpawnValidationErrorFieldCwd AgentRegistrySpawnValidationErrorField = "cwd" - // The model parameter - AgentRegistrySpawnValidationErrorFieldModel AgentRegistrySpawnValidationErrorField = "model" - // The session name parameter - AgentRegistrySpawnValidationErrorFieldName AgentRegistrySpawnValidationErrorField = "name" - // The permissionMode parameter - AgentRegistrySpawnValidationErrorFieldPermissionMode AgentRegistrySpawnValidationErrorField = "permissionMode" -) - -// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by -// reason without leaking raw paths or agent/model names. -// Experimental: AgentRegistrySpawnValidationErrorReason is part of an experimental API and -// may change or be removed. -type AgentRegistrySpawnValidationErrorReason string - -const ( - // Provided cwd exists but is not a directory - AgentRegistrySpawnValidationErrorReasonCwdNotDirectory AgentRegistrySpawnValidationErrorReason = "cwd-not-directory" - // Provided cwd does not exist on disk - AgentRegistrySpawnValidationErrorReasonCwdNotFound AgentRegistrySpawnValidationErrorReason = "cwd-not-found" - // Session name failed validateSessionName - AgentRegistrySpawnValidationErrorReasonInvalidName AgentRegistrySpawnValidationErrorReason = "invalid-name" - // Requested agent name was not found in builtin or custom agents - AgentRegistrySpawnValidationErrorReasonUnknownAgent AgentRegistrySpawnValidationErrorReason = "unknown-agent" - // Requested model is not available to this session - AgentRegistrySpawnValidationErrorReasonUnknownModel AgentRegistrySpawnValidationErrorReason = "unknown-model" - // Caller asked for permissionMode='yolo' but the controller is not currently in allow-all - // mode - AgentRegistrySpawnValidationErrorReasonYoloNotAllowed AgentRegistrySpawnValidationErrorReason = "yolo-not-allowed" -) - -// Type discriminator for AuthInfo. -// Experimental: AuthInfoType is part of an experimental API and may change or be removed. -type AuthInfoType string - -const ( - AuthInfoTypeAPIKey AuthInfoType = "api-key" - AuthInfoTypeCopilotAPIToken AuthInfoType = "copilot-api-token" - AuthInfoTypeEnv AuthInfoType = "env" - AuthInfoTypeGhCli AuthInfoType = "gh-cli" - AuthInfoTypeHmac AuthInfoType = "hmac" - AuthInfoTypeToken AuthInfoType = "token" - AuthInfoTypeUser AuthInfoType = "user" -) +// Experimental: SessionTelemetrySetFeatureOverridesResult is part of an experimental API +// and may change or be removed. +type SessionTelemetrySetFeatureOverridesResult struct { +} -// Runtime-controlled routing state for an open canvas instance. -// Experimental: CanvasInstanceAvailability is part of an experimental API and may change or +// Patch of mutable session options to apply to the running session. +// Experimental: SessionUpdateOptionsParams is part of an experimental API and may change or // be removed. -type CanvasInstanceAvailability string +type SessionUpdateOptionsParams struct { + // Additional content-exclusion policies to merge into the session's policy set. + // Experimental: AdditionalContentExclusionPolicies is part of an experimental API and may + // change or be removed. + AdditionalContentExclusionPolicies []OptionsUpdateAdditionalContentExclusionPolicy `json:"additionalContentExclusionPolicies,omitzero"` + // Runtime context discriminator (e.g., `cli`, `actions`). + AgentContext *string `json:"agentContext,omitempty"` + // Whether to include instructions from every MCP server in the system prompt instead of + // only allowlisted servers. + AllowAllMCPServerInstructions *bool `json:"allowAllMcpServerInstructions,omitempty"` + // Whether to disable the `ask_user` tool (encourages autonomous behavior). + AskUserDisabled *bool `json:"askUserDisabled,omitempty"` + // Allowlist of tool names available to this session. + AvailableTools []string `json:"availableTools,omitzero"` + // Options scoped to the built-in CAPI (Copilot API) provider. + Capi *CapiSessionOptions `json:"capi,omitempty"` + // Identifier of the client driving the session. + ClientName *string `json:"clientName,omitempty"` + // Whether to include the `Co-authored-by` trailer in commit messages. + CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` + // Context tier for models with tiered pricing. The session uses this to derive effective + // `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits + // honor the selected tier. + ContextTier *OptionsUpdateContextTier `json:"contextTier,omitempty"` + // Whether to allow auto-mode continuation across turns. + ContinueOnAutoMode *bool `json:"continueOnAutoMode,omitempty"` + // Override URL for the Copilot API endpoint. + CopilotURL *string `json:"copilotUrl,omitempty"` + // Whether to default custom agents to local-only execution. + CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` + // Instruction source IDs to exclude from the system prompt. + DisabledInstructionSources []string `json:"disabledInstructionSources,omitzero"` + // Skill IDs that should be excluded from this session. + DisabledSkills []string `json:"disabledSkills,omitzero"` + // Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK + // callback hook mechanism. + EnableFileHooks *bool `json:"enableFileHooks,omitempty"` + // Whether to enable host git operations (context resolution, child repo scanning, git info + // in system prompt). + EnableHostGitOperations *bool `json:"enableHostGitOperations,omitempty"` + // Whether to discover custom instructions on demand after successful file views (AGENTS.md + // / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with + // `skipCustomInstructions`. + EnableOnDemandInstructionDiscovery *bool `json:"enableOnDemandInstructionDiscovery,omitempty"` + // Whether to surface reasoning-summary events from the model. + EnableReasoningSummaries *bool `json:"enableReasoningSummaries,omitempty"` + // Whether shell-script safety heuristics are enabled. + EnableScriptSafety *bool `json:"enableScriptSafety,omitempty"` + // Whether to enable cross-session store writes and reads. + EnableSessionStore *bool `json:"enableSessionStore,omitempty"` + // Whether to enable skill directory scanning and loading. Falls back to + // enableConfigDiscovery when unset. + EnableSkills *bool `json:"enableSkills,omitempty"` + // Whether to stream model responses. + EnableStreaming *bool `json:"enableStreaming,omitempty"` + // How env values are passed to MCP servers (`direct` inlines literal values; `indirect` + // resolves at launch). + EnvValueMode *OptionsUpdateEnvValueMode `json:"envValueMode,omitempty"` + // Override directory for the session-events log. When unset, the runtime's default events + // log directory is used. + EventsLogDirectory *string `json:"eventsLogDirectory,omitempty"` + // Whether subagent callback events should be forwarded into the session event log sink. + EventsLogIncludesSubagents *bool `json:"eventsLogIncludesSubagents,omitempty"` + // Built-in subagent names to exclude from this session. Excluded built-ins are hidden from + // agent discovery and cannot be dispatched unless a custom agent with the same name is + // available. + ExcludedBuiltinAgents []string `json:"excludedBuiltinAgents,omitzero"` + // Denylist of tool names for this session. + ExcludedTools []string `json:"excludedTools,omitzero"` + // Map of feature-flag IDs to their boolean enabled state. + FeatureFlags map[string]bool `json:"featureFlags,omitzero"` + // Built-in subagent names to include in this session. When specified, only these built-ins + // are available, subject to runtime availability and exclusions. Custom agents with the + // same name remain available. Set to null to remove the allowlist restriction. + IncludedBuiltinAgents []string `json:"includedBuiltinAgents,omitzero"` + // Full set of installed plugins for the session. Replaces the existing list; the runtime + // invalidates the skills cache only when the list materially changes. + InstalledPlugins []SessionInstalledPlugin `json:"installedPlugins,omitzero"` + // Stable integration identifier used for analytics and rate-limit attribution. + IntegrationID *string `json:"integrationId,omitempty"` + // Whether experimental capabilities are enabled. + IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` + // Whether interactive shell sessions are logged. + LogInteractiveShells *bool `json:"logInteractiveShells,omitempty"` + // Identifier sent to LSP-style integrations. + LspClientName *string `json:"lspClientName,omitempty"` + // Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the + // per-session schedule registry; this flag only controls tool exposure (typically gated to + // staff users). + ManageScheduleEnabled *bool `json:"manageScheduleEnabled,omitempty"` + // Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) + // persisted inline in session events and re-presented to the model on later turns / resume. + // Larger results are persisted as a metadata-only marker and shown to the model as a short + // text note. Defaults to 10 MB. + MaxInlineBinaryBytes *int64 `json:"maxInlineBinaryBytes,omitempty"` + // The model ID to use for assistant turns. + Model *string `json:"model,omitempty"` + // Per-property model capability overrides for the selected model. + ModelCapabilitiesOverrides *ModelCapabilitiesOverride `json:"modelCapabilitiesOverrides,omitempty"` + // Organization-level custom instructions to inject into the system prompt. + OrganizationCustomInstructions *string `json:"organizationCustomInstructions,omitempty"` + // Custom model-provider configuration (BYOK). + Provider *ProviderConfig `json:"provider,omitempty"` + // Reasoning effort for the selected model. CAPI values are model-defined and validated + // against the selected model; BYOK providers may define additional values. When omitted, no + // effort override is applied. + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Reasoning summary mode for supported model clients. + ReasoningSummary *OptionsUpdateReasoningSummary `json:"reasoningSummary,omitempty"` + // Whether the session is running in an interactive UI. + RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` + // Resolved sandbox configuration. + SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + // Replaces the session's capability set with the given list. Use to enable or disable + // capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the + // field to leave the existing capability set unchanged. + SessionCapabilities []SessionCapability `json:"sessionCapabilities,omitzero"` + // Optional session limits. Pass null to clear the session limits. + SessionLimits *SessionLimitsConfig `json:"sessionLimits,omitempty"` + // Per-session settings for built-in shell tools. + Shell *ShellOptions `json:"shell,omitempty"` + // Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). + // Deprecated: ShellInitProfile is deprecated. + ShellInitProfile *string `json:"shellInitProfile,omitempty"` + // PowerShell process flags applied to built-in and user-requested shell commands. + ShellProcessFlags []string `json:"shellProcessFlags,omitzero"` + // Additional directories to search for skills. + SkillDirectories []string `json:"skillDirectories,omitzero"` + // Whether to skip loading custom instruction sources. + SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` + // Whether to skip embedding retrieval pipeline initialization and execution. + SkipEmbeddingRetrieval *bool `json:"skipEmbeddingRetrieval,omitempty"` + // When true, the selected custom agent's prompt is not injected into the user message + // (skill context is still injected). Used by automation triggers where the agent prompt is + // already in the problem statement. + SuppressCustomAgentPrompt *bool `json:"suppressCustomAgentPrompt,omitempty"` + // Controls how availableTools (allowlist) and excludedTools (denylist) combine when both + // are set. + ToolFilterPrecedence *OptionsUpdateToolFilterPrecedence `json:"toolFilterPrecedence,omitempty"` + // Optional path for trajectory output. + TrajectoryFile *string `json:"trajectoryFile,omitempty"` + // Output verbosity level for supported models. + Verbosity *Verbosity `json:"verbosity,omitempty"` + // Absolute working-directory path for shell tools. + WorkingDirectory *string `json:"workingDirectory,omitempty"` +} -const ( - // The owning provider is currently connected and routing calls will be dispatched normally. - CanvasInstanceAvailabilityReady CanvasInstanceAvailability = "ready" - // The owning provider is not currently connected. Routing calls fail with - // canvas_provider_unavailable until the agent re-issues open_canvas (which rehydrates via a - // fresh canvas.open) or the provider reconnects. - CanvasInstanceAvailabilityStale CanvasInstanceAvailability = "stale" -) +// Indicates whether the session options patch was applied successfully. +// Experimental: SessionUpdateOptionsResult is part of an experimental API and may change or +// be removed. +type SessionUpdateOptionsResult struct { + // Number of hooks loaded from installed plugins, returned when installedPlugins is updated + PluginHookCount *int64 `json:"pluginHookCount,omitempty"` + // Whether the operation succeeded + Success bool `json:"success"` +} -// Neutral SDK discriminator for the connected remote session kind. -// Experimental: ConnectedRemoteSessionMetadataKind is part of an experimental API and may +// Updated working directory and git context. Emitted as the new payload of +// `session.context_changed`. +// Experimental: SessionWorkingDirectoryContext is part of an experimental API and may // change or be removed. -type ConnectedRemoteSessionMetadataKind string +type SessionWorkingDirectoryContext struct { + // Merge-base commit SHA (fork point from the remote default branch) + BaseCommit *string `json:"baseCommit,omitempty"` + // Current git branch name + Branch *string `json:"branch,omitempty"` + // Current working directory path + Cwd string `json:"cwd"` + // Root directory of the git repository, resolved via git rev-parse + GitRoot *string `json:"gitRoot,omitempty"` + // Head commit of the current git branch + HeadCommit *string `json:"headCommit,omitempty"` + // Hosting platform type of the repository + HostType *SessionWorkingDirectoryContextHostType `json:"hostType,omitempty"` + // Repository identifier derived from the git remote URL ("owner/name" for GitHub, + // "org/project/repo" for Azure DevOps) + Repository *string `json:"repository,omitempty"` + // Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + RepositoryHost *string `json:"repositoryHost,omitempty"` +} -const ( - // GitHub Copilot coding agent session. - ConnectedRemoteSessionMetadataKindCodingAgent ConnectedRemoteSessionMetadataKind = "coding-agent" - // Remote CLI session. - ConnectedRemoteSessionMetadataKindRemoteSession ConnectedRemoteSessionMetadataKind = "remote-session" -) +// Experimental: SessionWorkspacesCreateFileResult is part of an experimental API and may +// change or be removed. +type SessionWorkspacesCreateFileResult struct { +} -// Controls how MCP tool result content is filtered: none leaves content unchanged, markdown -// sanitizes HTML while preserving Markdown-friendly output, and hidden_characters removes -// characters that can hide directives. -type ContentFilterMode string +// User-requested shell execution cancellation handle. +// Experimental: ShellCancelUserRequestedRequest is part of an experimental API and may +// change or be removed. +type ShellCancelUserRequestedRequest struct { + // Request ID previously passed to executeUserRequested + RequestID string `json:"requestId"` +} -const ( - // Remove characters that can hide directives. - ContentFilterModeHiddenCharacters ContentFilterMode = "hidden_characters" - // Sanitize HTML while preserving Markdown-friendly output. - ContentFilterModeMarkdown ContentFilterMode = "markdown" - // Leave MCP tool result content unchanged. - ContentFilterModeNone ContentFilterMode = "none" -) +// Shell command to run, with optional working directory and timeout in milliseconds. +// Experimental: ShellExecRequest is part of an experimental API and may change or be +// removed. +type ShellExecRequest struct { + // Shell command to execute + Command string `json:"command"` + // Working directory (defaults to session working directory) + Cwd *string `json:"cwd,omitempty"` + // Timeout in milliseconds (default: 30000) + Timeout *int64 `json:"timeout,omitempty"` +} -// Authentication host (always the public GitHub host). -type CopilotAPITokenAuthInfoHost string +// Identifier of the spawned process, used to correlate streamed output and exit +// notifications. +// Experimental: ShellExecResult is part of an experimental API and may change or be removed. +type ShellExecResult struct { + // Unique identifier for tracking streamed output + ProcessID string `json:"processId"` +} -const ( - CopilotAPITokenAuthInfoHostHTTPSGithubCom CopilotAPITokenAuthInfoHost = "https://github.com" -) +// User-requested shell command and cancellation handle. +// Experimental: ShellExecuteUserRequestedRequest is part of an experimental API and may +// change or be removed. +type ShellExecuteUserRequestedRequest struct { + // Shell command to execute + Command string `json:"command"` + // Caller-provided cancellation handle for this execution + RequestID string `json:"requestId"` +} -// Server transport type: stdio, http, sse (deprecated), or memory -type DiscoveredMcpServerType string +// A host-provided script sourced before each built-in shell command when its shell target +// matches the active shell. +// Experimental: ShellInitScript is part of an experimental API and may change or be removed. +type ShellInitScript struct { + // Path to the script to source. + Path string `json:"path"` + // Built-in shell that may source this script. + Shell ShellInitScriptShell `json:"shell"` +} -const ( - // Server communicates over streamable HTTP. - DiscoveredMcpServerTypeHTTP DiscoveredMcpServerType = "http" - // Server is backed by an in-memory runtime implementation. - DiscoveredMcpServerTypeMemory DiscoveredMcpServerType = "memory" - // Server communicates over Server-Sent Events (deprecated). - DiscoveredMcpServerTypeSse DiscoveredMcpServerType = "sse" - // Server communicates over stdio with a local child process. - DiscoveredMcpServerTypeStdio DiscoveredMcpServerType = "stdio" -) +// Identifier of a process previously returned by "shell.exec" and the signal to send. +// Experimental: ShellKillRequest is part of an experimental API and may change or be +// removed. +type ShellKillRequest struct { + // Process identifier returned by shell.exec + ProcessID string `json:"processId"` + // Signal to send (default: SIGTERM) + Signal *ShellKillSignal `json:"signal,omitempty"` +} -type EventLogTypesString string +// Indicates whether the signal was delivered; false if the process was unknown or already +// exited. +// Experimental: ShellKillResult is part of an experimental API and may change or be removed. +type ShellKillResult struct { + // Whether the signal was sent successfully + Killed bool `json:"killed"` +} -const ( - EventLogTypesStringValue EventLogTypesString = "*" -) +// Per-session settings for built-in shell tools. +// Experimental: ShellOptions is part of an experimental API and may change or be removed. +type ShellOptions struct { + // Controls automatic non-interactive profile loading where supported. Explicit initScripts + // are unaffected. + InitProfile *ShellInitProfile `json:"initProfile,omitempty"` + // Ordered host-provided script paths sourced before each built-in shell command when the + // entry's shell target matches the active shell. Use these for rc files, environment setup + // scripts, + // or other custom scripts. A script that returns a nonzero status is reported, and later + // scripts + // and the user command continue while the shell remains running. Because scripts are + // sourced into + // the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating + // behavior + // can prevent continuation. Script standard output is preserved; Bash script stderr is + // discarded, + // PowerShell exception messages are replaced, and runtime-generated failure notices omit + // configured script paths. When sandboxing is enabled, each script must already be readable + // under + // the active sandbox filesystem policy. Pass an empty array to clear the list. + InitScripts []ShellInitScript `json:"initScripts,omitzero"` + // Flags passed to the active built-in shell process on startup, replacing its default flags. + // When omitted, the built-in Bash shell uses `--norc --noprofile`, + // and the built-in PowerShell shell uses `-NoProfile -NoLogo`. + ProcessFlags []string `json:"processFlags,omitzero"` +} -// Agent-scope filter: 'primary' returns only main-agent events plus events whose type -// starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns -// events from all agents (matching wildcard-subscription behavior). Default is 'all' to -// preserve wildcard semantics for catch-up callers. -// Experimental: EventsAgentScope is part of an experimental API and may change or be -// removed. -type EventsAgentScope string +// Parameters for shutting down the session +// Experimental: ShutdownRequest is part of an experimental API and may change or be removed. +type ShutdownRequest struct { + // Optional human-readable reason. Typically the message of the error that triggered + // shutdown when type is 'error'. + Reason *string `json:"reason,omitempty"` + // Why the session is being shut down. Defaults to "routine" when omitted. + Type *ShutdownType `json:"type,omitempty"` +} -const ( - // Return events from all agents. - EventsAgentScopeAll EventsAgentScope = "all" - // Return main-agent events and typed subagent lifecycle events. - EventsAgentScopePrimary EventsAgentScope = "primary" -) +// Skill metadata available to a session, with name, description, source, enabled/invocable +// state, path, plugin, and argument hint. +// Experimental: Skill is part of an experimental API and may change or be removed. +type Skill struct { + // Optional freeform hint describing the skill's expected arguments, from the + // `argument-hint` frontmatter field + ArgumentHint *string `json:"argumentHint,omitempty"` + // Canonical slash command name used to invoke the skill, without the leading '/' + CommandName *string `json:"commandName,omitempty"` + // Description of what the skill does + Description string `json:"description"` + // Whether the skill is currently enabled + Enabled bool `json:"enabled"` + // Unique identifier for the skill + Name string `json:"name"` + // Absolute path to the skill file + Path *string `json:"path,omitempty"` + // Name of the plugin that provides the skill, when source is 'plugin' + PluginName *string `json:"pluginName,omitempty"` + // Source location type (e.g., project, personal-copilot, plugin, builtin) + Source SkillSource `json:"source"` + // Whether the skill can be invoked by the user as a slash command + UserInvocable bool `json:"userInvocable"` +} -// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor -// referred to an event that no longer exists in history (e.g. truncated or compacted away) -// and the read started from the beginning of the remaining history. -// Experimental: EventsCursorStatus is part of an experimental API and may change or be +// Canonical directory where skills can be discovered or created, with scope, preference, +// and optional project path. +// Experimental: SkillDiscoveryPath is part of an experimental API and may change or be // removed. -type EventsCursorStatus string - -const ( - // The cursor referred to history that is no longer available. - EventsCursorStatusExpired EventsCursorStatus = "expired" - // The cursor was applied successfully. - EventsCursorStatusOk EventsCursorStatus = "ok" -) - -// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) -// Experimental: ExtensionSource is part of an experimental API and may change or be removed. -type ExtensionSource string +type SkillDiscoveryPath struct { + // Absolute path of the create/discovery target (may not exist on disk yet) + Path string `json:"path"` + // Whether this is the canonical directory to create a new skill in its tier. At most one + // entry per tier is preferred; the `personal-agents` and `custom` scopes are never + // preferred. + PreferredForCreation bool `json:"preferredForCreation"` + // The input project path this directory was derived from (only for project scope) + ProjectPath *string `json:"projectPath,omitempty"` + // Which tier this directory belongs to + Scope SkillDiscoveryScope `json:"scope"` +} -const ( - // Extension discovered from the current project's .github/extensions directory. - ExtensionSourceProject ExtensionSource = "project" - // Extension discovered from the user's ~/.copilot/extensions directory. - ExtensionSourceUser ExtensionSource = "user" -) +// Canonical locations where skills can be created so the runtime will recognize them. +// Experimental: SkillDiscoveryPathList is part of an experimental API and may change or be +// removed. +type SkillDiscoveryPathList struct { + // Canonical skill create/discovery directories, in priority order + Paths []SkillDiscoveryPath `json:"paths"` +} -// Current status: running, disabled, failed, or starting -// Experimental: ExtensionStatus is part of an experimental API and may change or be removed. -type ExtensionStatus string +// Skills available to the session, with their enabled state. +// Experimental: SkillList is part of an experimental API and may change or be removed. +type SkillList struct { + // Available skills + Skills []Skill `json:"skills"` +} -const ( - // The extension is installed but disabled. - ExtensionStatusDisabled ExtensionStatus = "disabled" - // The extension failed to start or crashed. - ExtensionStatusFailed ExtensionStatus = "failed" - // The extension process is running. - ExtensionStatusRunning ExtensionStatus = "running" - // The extension process is starting. - ExtensionStatusStarting ExtensionStatus = "starting" -) +// Skill names to mark as disabled in global configuration, replacing any previous list. +// Experimental: SkillsConfigSetDisabledSkillsRequest is part of an experimental API and may +// change or be removed. +type SkillsConfigSetDisabledSkillsRequest struct { + // List of skill names to disable + DisabledSkills []string `json:"disabledSkills"` +} -// Binary result type discriminator. Use "image" for images and "resource" for other binary -// data. -// Experimental: ExternalToolTextResultForLlmBinaryResultsForLlmType is part of an -// experimental API and may change or be removed. -type ExternalToolTextResultForLlmBinaryResultsForLlmType string +// Experimental: SkillsConfigSetDisabledSkillsResult is part of an experimental API and may +// change or be removed. +type SkillsConfigSetDisabledSkillsResult struct { +} -const ( - // Binary image data. - ExternalToolTextResultForLlmBinaryResultsForLlmTypeImage ExternalToolTextResultForLlmBinaryResultsForLlmType = "image" - // Other binary resource data. - ExternalToolTextResultForLlmBinaryResultsForLlmTypeResource ExternalToolTextResultForLlmBinaryResultsForLlmType = "resource" -) +// Name of the skill to disable for the session. +// Experimental: SkillsDisableRequest is part of an experimental API and may change or be +// removed. +type SkillsDisableRequest struct { + // Name of the skill to disable + Name string `json:"name"` +} -// Theme variant this icon is intended for -// Experimental: ExternalToolTextResultForLlmContentResourceLinkIconTheme is part of an -// experimental API and may change or be removed. -type ExternalToolTextResultForLlmContentResourceLinkIconTheme string +// Optional project paths and additional skill directories to include in discovery. +// Experimental: SkillsDiscoverRequest is part of an experimental API and may change or be +// removed. +type SkillsDiscoverRequest struct { + // When true, omit skills from the host's global sources (personal, custom, plugin, and + // built-in), returning only project-scoped skills. For multitenant deployments. + ExcludeHostSkills *bool `json:"excludeHostSkills,omitempty"` + // Optional list of project directory paths to scan for project-scoped skills + ProjectPaths []string `json:"projectPaths,omitzero"` + // Optional list of additional skill directory paths to include + SkillDirectories []string `json:"skillDirectories,omitzero"` +} -const ( - // Icon intended for dark themes. - ExternalToolTextResultForLlmContentResourceLinkIconThemeDark ExternalToolTextResultForLlmContentResourceLinkIconTheme = "dark" - // Icon intended for light themes. - ExternalToolTextResultForLlmContentResourceLinkIconThemeLight ExternalToolTextResultForLlmContentResourceLinkIconTheme = "light" -) +// Name of the skill to enable for the session. +// Experimental: SkillsEnableRequest is part of an experimental API and may change or be +// removed. +type SkillsEnableRequest struct { + // Name of the skill to enable + Name string `json:"name"` +} -// Type discriminator for ExternalToolTextResultForLlmContent. -type ExternalToolTextResultForLlmContentType string +// Optional project paths to enumerate. +// Experimental: SkillsGetDiscoveryPathsRequest is part of an experimental API and may +// change or be removed. +type SkillsGetDiscoveryPathsRequest struct { + // When true, omit the host's personal and custom skill directories, leaving only project + // directories. For multitenant deployments. + ExcludeHostSkills *bool `json:"excludeHostSkills,omitempty"` + // Optional list of project directory paths. When omitted or empty, only personal and custom + // directories are returned. + ProjectPaths []string `json:"projectPaths,omitzero"` +} -const ( - ExternalToolTextResultForLlmContentTypeAudio ExternalToolTextResultForLlmContentType = "audio" - ExternalToolTextResultForLlmContentTypeImage ExternalToolTextResultForLlmContentType = "image" - ExternalToolTextResultForLlmContentTypeResource ExternalToolTextResultForLlmContentType = "resource" - ExternalToolTextResultForLlmContentTypeResourceLink ExternalToolTextResultForLlmContentType = "resource_link" - ExternalToolTextResultForLlmContentTypeTerminal ExternalToolTextResultForLlmContentType = "terminal" - ExternalToolTextResultForLlmContentTypeText ExternalToolTextResultForLlmContentType = "text" -) +// Skills invoked during this session, ordered by invocation time (most recent last). +// Experimental: SkillsGetInvokedResult is part of an experimental API and may change or be +// removed. +type SkillsGetInvokedResult struct { + // Skills invoked during this session, ordered by invocation time (most recent last) + Skills []SkillsInvokedSkill `json:"skills"` +} -// Authentication host. HMAC auth always targets the public GitHub host. -type HMACAuthInfoHost string +// Skill invocation record with name, path, content, allowed tools, and turn number. +// Experimental: SkillsInvokedSkill is part of an experimental API and may change or be +// removed. +type SkillsInvokedSkill struct { + // Tools that should be auto-approved when this skill is active, captured at invocation time + AllowedTools []string `json:"allowedTools,omitzero"` + // Full content of the skill file + Content string `json:"content"` + // Turn number when the skill was invoked + InvokedAtTurn int64 `json:"invokedAtTurn"` + // Unique identifier for the skill + Name string `json:"name"` + // Path to the SKILL.md file + Path string `json:"path"` +} -const ( - HMACAuthInfoHostHTTPSGithubCom HMACAuthInfoHost = "https://github.com" -) +// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +// Experimental: SkillsLoadDiagnostics is part of an experimental API and may change or be +// removed. +type SkillsLoadDiagnostics struct { + // Errors emitted while loading skills (e.g. skills that failed to load entirely) + Errors []string `json:"errors"` + // Warnings emitted while loading skills (e.g. skills that loaded but had issues) + Warnings []string `json:"warnings"` +} -// Constant value. Always "github". -type InstalledPluginSourceGithubSource string +// Slash-command metadata with name, aliases, description, kind, input hint, execution +// allowance, and schedulability. +// Experimental: SlashCommandInfo is part of an experimental API and may change or be +// removed. +type SlashCommandInfo struct { + // Canonical aliases without leading slashes + Aliases []string `json:"aliases,omitzero"` + // Whether the command may run while an agent turn is active + AllowDuringAgentExecution bool `json:"allowDuringAgentExecution"` + // Human-readable command description + Description string `json:"description"` + // Whether the command is experimental + Experimental *bool `json:"experimental,omitempty"` + // Optional unstructured input hint + Input *SlashCommandInput `json:"input,omitempty"` + // Coarse command category for grouping and behavior: runtime built-in, skill-backed + // command, or SDK/client-owned command + Kind SlashCommandKind `json:"kind"` + // Canonical command name without a leading slash + Name string `json:"name"` + // Whether the command may be the target of `/every` / `/after` schedules. Resolution + // happens at every tick, so only set this when the command is safe to re-invoke and + // produces an agent prompt. + Schedulable *bool `json:"schedulable,omitempty"` +} -const ( - InstalledPluginSourceGithubSourceGithub InstalledPluginSourceGithubSource = "github" -) +// Optional unstructured input hint +// Experimental: SlashCommandInput is part of an experimental API and may change or be +// removed. +type SlashCommandInput struct { + // Optional literal choices the input accepts, each with a human-facing description; clients + // may render these as selectable options + Choices []SlashCommandInputChoice `json:"choices,omitzero"` + // Optional completion hint for the input (e.g. 'directory' for filesystem path completion) + Completion *SlashCommandInputCompletion `json:"completion,omitempty"` + // Hint to display when command input has not been provided + Hint string `json:"hint"` + // When true, clients should pass the full text after the command name as a single argument + // rather than splitting on whitespace + PreserveMultilineInput *bool `json:"preserveMultilineInput,omitempty"` + // When true, the command requires non-empty input; clients should render the input hint as + // required + Required *bool `json:"required,omitempty"` +} -// Constant value. Always "local". -type InstalledPluginSourceLocalSource string +// A literal choice the command input accepts, with a human-facing description +// Experimental: SlashCommandInputChoice is part of an experimental API and may change or be +// removed. +type SlashCommandInputChoice struct { + // Human-readable description shown alongside the choice + Description string `json:"description"` + // The literal choice value (e.g. 'on', 'off', 'show') + Name string `json:"name"` +} -const ( - InstalledPluginSourceLocalSourceLocal InstalledPluginSourceLocalSource = "local" -) +// Result of invoking the slash command (text output, prompt to send to the agent, +// completion, or subcommand selection). +// Experimental: SlashCommandInvocationResult is part of an experimental API and may change +// or be removed. +type SlashCommandInvocationResult interface { + slashCommandInvocationResult() + Kind() SlashCommandInvocationResultKind +} -// Constant value. Always "url". -type InstalledPluginSourceURLSource string +type RawSlashCommandInvocationResultData struct { + Discriminator SlashCommandInvocationResultKind + Raw json.RawMessage +} -const ( - InstalledPluginSourceURLSourceURL InstalledPluginSourceURLSource = "url" -) +func (RawSlashCommandInvocationResultData) slashCommandInvocationResult() {} +func (r RawSlashCommandInvocationResultData) Kind() SlashCommandInvocationResultKind { + return r.Discriminator +} -// Where this source lives — used for UI grouping -// Experimental: InstructionsSourcesLocation is part of an experimental API and may change +// Slash-command invocation result that submits an agent prompt, with display prompt, +// optional mode, optional user-facing notice, and settings-change flag. +// Experimental: SlashCommandAgentPromptResult is part of an experimental API and may change // or be removed. -type InstructionsSourcesLocation string +type SlashCommandAgentPromptResult struct { + // Prompt text to display to the user + DisplayPrompt string `json:"displayPrompt"` + // Optional target session mode for the agent prompt + Mode *SessionMode `json:"mode,omitempty"` + // Optional user-facing notice to show before the prompt is submitted + Notice *string `json:"notice,omitempty"` + // Prompt to submit to the agent + Prompt string `json:"prompt"` + // True when the invocation mutated user runtime settings; consumers caching settings should + // refresh + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +} -const ( - // Instructions live in plugin-provided configuration. - InstructionsSourcesLocationPlugin InstructionsSourcesLocation = "plugin" - // Instructions live in repository-level configuration. - InstructionsSourcesLocationRepository InstructionsSourcesLocation = "repository" - // Instructions live in user-level configuration. - InstructionsSourcesLocationUser InstructionsSourcesLocation = "user" - // Instructions live under the current working directory. - InstructionsSourcesLocationWorkingDirectory InstructionsSourcesLocation = "working-directory" -) - -// Category of instruction source — used for merge logic -// Experimental: InstructionsSourcesType is part of an experimental API and may change or be -// removed. -type InstructionsSourcesType string - -const ( - // Instructions inherited from child instruction files. - InstructionsSourcesTypeChildInstructions InstructionsSourcesType = "child-instructions" - // Instructions loaded from the user's home configuration. - InstructionsSourcesTypeHome InstructionsSourcesType = "home" - // Instructions loaded from model-specific files. - InstructionsSourcesTypeModel InstructionsSourcesType = "model" - // Instructions discovered from nested agent files. - InstructionsSourcesTypeNestedAgents InstructionsSourcesType = "nested-agents" - // Instructions supplied by an installed plugin. - InstructionsSourcesTypePlugin InstructionsSourcesType = "plugin" - // Instructions loaded from repository-scoped files. - InstructionsSourcesTypeRepo InstructionsSourcesType = "repo" - // Instructions loaded from VS Code instruction files. - InstructionsSourcesTypeVscode InstructionsSourcesType = "vscode" -) +func (SlashCommandAgentPromptResult) slashCommandInvocationResult() {} +func (SlashCommandAgentPromptResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindAgentPrompt +} -// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. -// Experimental: McpAppsHostContextDetailsAvailableDisplayMode is part of an experimental -// API and may change or be removed. -type McpAppsHostContextDetailsAvailableDisplayMode string +// Slash-command invocation result indicating completion, with optional message and +// settings-change flag. +// Experimental: SlashCommandCompletedResult is part of an experimental API and may change +// or be removed. +type SlashCommandCompletedResult struct { + // Optional user-facing message describing the completed command + Message *string `json:"message,omitempty"` + // True when the invocation mutated user runtime settings; consumers caching settings should + // refresh + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` +} -const ( - // Rendered as a fullscreen overlay - McpAppsHostContextDetailsAvailableDisplayModeFullscreen McpAppsHostContextDetailsAvailableDisplayMode = "fullscreen" - // Rendered inline within the host conversation surface - McpAppsHostContextDetailsAvailableDisplayModeInline McpAppsHostContextDetailsAvailableDisplayMode = "inline" - // Rendered as a picture-in-picture floating panel - McpAppsHostContextDetailsAvailableDisplayModePip McpAppsHostContextDetailsAvailableDisplayMode = "pip" -) +func (SlashCommandCompletedResult) slashCommandInvocationResult() {} +func (SlashCommandCompletedResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindCompleted +} -// Current display mode (SEP-1865) -// Experimental: McpAppsHostContextDetailsDisplayMode is part of an experimental API and may +// Slash-command invocation result asking the client to present subcommand options for a +// parent command. +// Experimental: SlashCommandSelectSubcommandResult is part of an experimental API and may // change or be removed. -type McpAppsHostContextDetailsDisplayMode string +type SlashCommandSelectSubcommandResult struct { + // Parent command name that requires subcommand selection + Command string `json:"command"` + // Available subcommand options for the client to present + Options []SlashCommandSelectSubcommandOption `json:"options"` + // True when the invocation mutated user runtime settings; consumers caching settings should + // refresh + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` + // Human-readable title for the selection UI + Title string `json:"title"` +} -const ( - // Rendered as a fullscreen overlay - McpAppsHostContextDetailsDisplayModeFullscreen McpAppsHostContextDetailsDisplayMode = "fullscreen" - // Rendered inline within the host conversation surface - McpAppsHostContextDetailsDisplayModeInline McpAppsHostContextDetailsDisplayMode = "inline" - // Rendered as a picture-in-picture floating panel - McpAppsHostContextDetailsDisplayModePip McpAppsHostContextDetailsDisplayMode = "pip" -) +func (SlashCommandSelectSubcommandResult) slashCommandInvocationResult() {} +func (SlashCommandSelectSubcommandResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindSelectSubcommand +} -// Platform type for responsive design -// Experimental: McpAppsHostContextDetailsPlatform is part of an experimental API and may -// change or be removed. -type McpAppsHostContextDetailsPlatform string +// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. +// Experimental: SlashCommandTextResult is part of an experimental API and may change or be +// removed. +type SlashCommandTextResult struct { + // Whether text contains Markdown + Markdown *bool `json:"markdown,omitempty"` + // Whether ANSI sequences should be preserved + PreserveAnsi *bool `json:"preserveAnsi,omitempty"` + // True when the invocation mutated user runtime settings; consumers caching settings should + // refresh + RuntimeSettingsChanged *bool `json:"runtimeSettingsChanged,omitempty"` + // Text output for the client to render + Text string `json:"text"` +} -const ( - // Host runs as a desktop application - McpAppsHostContextDetailsPlatformDesktop McpAppsHostContextDetailsPlatform = "desktop" - // Host runs on a mobile device - McpAppsHostContextDetailsPlatformMobile McpAppsHostContextDetailsPlatform = "mobile" - // Host runs in a web browser - McpAppsHostContextDetailsPlatformWeb McpAppsHostContextDetailsPlatform = "web" -) +func (SlashCommandTextResult) slashCommandInvocationResult() {} +func (SlashCommandTextResult) Kind() SlashCommandInvocationResultKind { + return SlashCommandInvocationResultKindText +} -// UI theme preference per SEP-1865 -// Experimental: McpAppsHostContextDetailsTheme is part of an experimental API and may +// Selectable slash-command subcommand option with name, description, and optional group +// label. +// Experimental: SlashCommandSelectSubcommandOption is part of an experimental API and may // change or be removed. -type McpAppsHostContextDetailsTheme string - -const ( - // Dark UI theme - McpAppsHostContextDetailsThemeDark McpAppsHostContextDetailsTheme = "dark" - // Light UI theme - McpAppsHostContextDetailsThemeLight McpAppsHostContextDetailsTheme = "light" -) - -// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. -// Experimental: McpAppsSetHostContextDetailsAvailableDisplayMode is part of an experimental -// API and may change or be removed. -type McpAppsSetHostContextDetailsAvailableDisplayMode string +type SlashCommandSelectSubcommandOption struct { + // Human-readable description of the subcommand + Description string `json:"description"` + // Optional group label for organizing options + Group *string `json:"group,omitempty"` + // Subcommand name to invoke + Name string `json:"name"` +} -const ( - // Rendered as a fullscreen overlay - McpAppsSetHostContextDetailsAvailableDisplayModeFullscreen McpAppsSetHostContextDetailsAvailableDisplayMode = "fullscreen" - // Rendered inline within the host conversation surface - McpAppsSetHostContextDetailsAvailableDisplayModeInline McpAppsSetHostContextDetailsAvailableDisplayMode = "inline" - // Rendered as a picture-in-picture floating panel - McpAppsSetHostContextDetailsAvailableDisplayModePip McpAppsSetHostContextDetailsAvailableDisplayMode = "pip" -) +// Configured per-agent subagent overrides +// Experimental: SubagentSettings is part of an experimental API and may change or be +// removed. +type SubagentSettings struct { + // Per-agent settings keyed by subagent agent_type + Agents map[string]SubagentSettingsEntry `json:"agents,omitzero"` + // Names of subagents the user has turned off; they cannot be dispatched + DisabledSubagents []string `json:"disabledSubagents,omitzero"` + // Maximum number of subagents that can run concurrently; applies to usage-based billing + // users only + MaxConcurrency *int32 `json:"maxConcurrency,omitempty"` + // Maximum subagent nesting depth; applies to usage-based billing users only + MaxDepth *int32 `json:"maxDepth,omitempty"` +} + +// Subagent model, reasoning effort, and context tier settings +// Experimental: SubagentSettingsEntry is part of an experimental API and may change or be +// removed. +type SubagentSettingsEntry struct { + // Context tier override for matching subagents + ContextTier *SubagentSettingsEntryContextTier `json:"contextTier,omitempty"` + // Reasoning effort override for matching subagents + EffortLevel *string `json:"effortLevel,omitempty"` + // Model override for matching subagents + Model *string `json:"model,omitempty"` +} -// Current display mode (SEP-1865) -// Experimental: McpAppsSetHostContextDetailsDisplayMode is part of an experimental API and -// may change or be removed. -type McpAppsSetHostContextDetailsDisplayMode string +// Tracked task union returned by task APIs, containing either an agent task or a shell task. +// Experimental: TaskInfo is part of an experimental API and may change or be removed. +type TaskInfo interface { + taskInfo() + Type() TaskInfoType +} -const ( - // Rendered as a fullscreen overlay - McpAppsSetHostContextDetailsDisplayModeFullscreen McpAppsSetHostContextDetailsDisplayMode = "fullscreen" - // Rendered inline within the host conversation surface - McpAppsSetHostContextDetailsDisplayModeInline McpAppsSetHostContextDetailsDisplayMode = "inline" - // Rendered as a picture-in-picture floating panel - McpAppsSetHostContextDetailsDisplayModePip McpAppsSetHostContextDetailsDisplayMode = "pip" -) +type RawTaskInfoData struct { + Discriminator TaskInfoType + Raw json.RawMessage +} -// Platform type for responsive design -// Experimental: McpAppsSetHostContextDetailsPlatform is part of an experimental API and may -// change or be removed. -type McpAppsSetHostContextDetailsPlatform string +func (RawTaskInfoData) taskInfo() {} +func (r RawTaskInfoData) Type() TaskInfoType { + return r.Discriminator +} -const ( - // Host runs as a desktop application - McpAppsSetHostContextDetailsPlatformDesktop McpAppsSetHostContextDetailsPlatform = "desktop" - // Host runs on a mobile device - McpAppsSetHostContextDetailsPlatformMobile McpAppsSetHostContextDetailsPlatform = "mobile" - // Host runs in a web browser - McpAppsSetHostContextDetailsPlatformWeb McpAppsSetHostContextDetailsPlatform = "web" -) +// Tracked background agent task metadata, including IDs, status, timing, agent type, +// prompt, model, result, and latest response. +// Experimental: TaskAgentInfo is part of an experimental API and may change or be removed. +type TaskAgentInfo struct { + // ISO 8601 timestamp when the current active period began + ActiveStartedAt *time.Time `json:"activeStartedAt,omitempty"` + // Accumulated active execution time in milliseconds + ActiveTimeMs *int64 `json:"activeTimeMs,omitempty"` + // Type of agent running this task + AgentType string `json:"agentType"` + // 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. + CanPromoteToBackground *bool `json:"canPromoteToBackground,omitempty"` + // ISO 8601 timestamp when the task finished + CompletedAt *time.Time `json:"completedAt,omitempty"` + // Short description of the task + Description string `json:"description"` + // Error message when the task failed + Error *string `json:"error,omitempty"` + // Whether task execution is synchronously awaited or managed in the background + ExecutionMode *TaskExecutionMode `json:"executionMode,omitempty"` + // Unique task identifier + ID string `json:"id"` + // ISO 8601 timestamp when the agent entered idle state + IdleSince *time.Time `json:"idleSince,omitempty"` + // Most recent response text from the agent + LatestResponse *string `json:"latestResponse,omitempty"` + // Requested model override for the task when specified + Model *string `json:"model,omitempty"` + // Most recent prompt delivered to the agent. Updated whenever the agent receives a + // follow-up message. + Prompt string `json:"prompt"` + // Runtime model resolved for the task when available + ResolvedModel *string `json:"resolvedModel,omitempty"` + // Result text from the task when available + Result *string `json:"result,omitempty"` + // ISO 8601 timestamp when the task was started + StartedAt time.Time `json:"startedAt"` + // Current lifecycle status of the task + Status TaskStatus `json:"status"` + // Tool call ID associated with this agent task + ToolCallID string `json:"toolCallId"` +} -// UI theme preference per SEP-1865 -// Experimental: McpAppsSetHostContextDetailsTheme is part of an experimental API and may -// change or be removed. -type McpAppsSetHostContextDetailsTheme string +func (TaskAgentInfo) taskInfo() {} +func (TaskAgentInfo) Type() TaskInfoType { + return TaskInfoTypeAgent +} -const ( - // Dark UI theme - McpAppsSetHostContextDetailsThemeDark McpAppsSetHostContextDetailsTheme = "dark" - // Light UI theme - McpAppsSetHostContextDetailsThemeLight McpAppsSetHostContextDetailsTheme = "light" -) +// Tracked shell task metadata, including ID, command, status, timing, attachment/execution +// mode, log path, and PID. +// Experimental: TaskShellInfo is part of an experimental API and may change or be removed. +type TaskShellInfo struct { + // Whether the shell runs inside a managed PTY session or as an independent background + // process + AttachmentMode TaskShellInfoAttachmentMode `json:"attachmentMode"` + // Whether this shell task can be promoted to background mode + CanPromoteToBackground *bool `json:"canPromoteToBackground,omitempty"` + // Command being executed + Command string `json:"command"` + // ISO 8601 timestamp when the task finished + CompletedAt *time.Time `json:"completedAt,omitempty"` + // Short description of the task + Description string `json:"description"` + // Whether task execution is synchronously awaited or managed in the background + ExecutionMode *TaskExecutionMode `json:"executionMode,omitempty"` + // Unique task identifier + ID string `json:"id"` + // Path to the detached shell log, when available + LogPath *string `json:"logPath,omitempty"` + // Process ID when available + Pid *int64 `json:"pid,omitempty"` + // ISO 8601 timestamp when the task was started + StartedAt time.Time `json:"startedAt"` + // Current lifecycle status of the task + Status TaskStatus `json:"status"` +} -// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered -// an error (including agent-side rejection by content filter or criteria); 'cancelled' the -// caller cancelled this execution via cancelSamplingExecution. -// Experimental: McpSamplingExecutionAction is part of an experimental API and may change or -// be removed. -type McpSamplingExecutionAction string +func (TaskShellInfo) taskInfo() {} +func (TaskShellInfo) Type() TaskInfoType { + return TaskInfoTypeShell +} -const ( - // The sampling inference was cancelled before completion. - McpSamplingExecutionActionCancelled McpSamplingExecutionAction = "cancelled" - // The sampling inference failed or was rejected. - McpSamplingExecutionActionFailure McpSamplingExecutionAction = "failure" - // The sampling inference completed and produced a result. - McpSamplingExecutionActionSuccess McpSamplingExecutionAction = "success" -) +// Background tasks currently tracked by the session. +// Experimental: TaskList is part of an experimental API and may change or be removed. +type TaskList struct { + // Currently tracked tasks + Tasks []TaskInfo `json:"tasks"` +} -// OAuth grant type to use when authenticating to the remote MCP server. -type McpServerConfigHTTPOauthGrantType string +// Experimental: TaskProgress is part of an experimental API and may change or be removed. +type TaskProgress interface { + taskProgress() + Type() TaskProgressType +} -const ( - // Interactive browser-based authorization code flow with PKCE. - McpServerConfigHTTPOauthGrantTypeAuthorizationCode McpServerConfigHTTPOauthGrantType = "authorization_code" - // Headless client credentials flow using the configured OAuth client. - McpServerConfigHTTPOauthGrantTypeClientCredentials McpServerConfigHTTPOauthGrantType = "client_credentials" -) +type RawTaskProgressData struct { + Discriminator TaskProgressType + Raw json.RawMessage +} -// Remote transport type. Defaults to "http" when omitted. -type McpServerConfigHTTPType string +func (RawTaskProgressData) taskProgress() {} +func (r RawTaskProgressData) Type() TaskProgressType { + return r.Discriminator +} -const ( - // Streamable HTTP transport. - McpServerConfigHTTPTypeHTTP McpServerConfigHTTPType = "http" - // Server-Sent Events transport. - McpServerConfigHTTPTypeSse McpServerConfigHTTPType = "sse" -) - -// Configuration source: user, workspace, plugin, or builtin -type McpServerSource string - -const ( - // Server bundled with the runtime. - McpServerSourceBuiltin McpServerSource = "builtin" - // Server contributed by an installed plugin. - McpServerSourcePlugin McpServerSource = "plugin" - // Server configured in the user's global MCP configuration. - McpServerSourceUser McpServerSource = "user" - // Server configured by the current workspace. - McpServerSourceWorkspace McpServerSource = "workspace" -) +// Progress snapshot for an agent task, with recent activity lines and optional latest +// intent. +// Experimental: TaskAgentProgress is part of an experimental API and may change or be +// removed. +type TaskAgentProgress struct { + // The most recent intent reported by the agent + LatestIntent *string `json:"latestIntent,omitempty"` + // Recent tool execution events converted to display lines + RecentActivity []TaskProgressLine `json:"recentActivity"` +} -// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured -// Experimental: McpServerStatus is part of an experimental API and may change or be removed. -type McpServerStatus string +func (TaskAgentProgress) taskProgress() {} +func (TaskAgentProgress) Type() TaskProgressType { + return TaskProgressTypeAgent +} -const ( - // The server is connected and available. - McpServerStatusConnected McpServerStatus = "connected" - // The server is configured but disabled. - McpServerStatusDisabled McpServerStatus = "disabled" - // The server failed to connect or initialize. - McpServerStatusFailed McpServerStatus = "failed" - // The server requires authentication before it can connect. - McpServerStatusNeedsAuth McpServerStatus = "needs-auth" - // The server is not configured for this session. - McpServerStatusNotConfigured McpServerStatus = "not_configured" - // The server connection is still being established. - McpServerStatusPending McpServerStatus = "pending" -) +// Progress snapshot for a shell task, with recent stdout/stderr output and optional process +// ID. +// Experimental: TaskShellProgress is part of an experimental API and may change or be +// removed. +type TaskShellProgress struct { + // Process ID when available + Pid *int64 `json:"pid,omitempty"` + // Recent stdout/stderr lines from the running shell command + RecentOutput string `json:"recentOutput"` +} -// How environment-variable values supplied to MCP servers are resolved. "direct" passes -// literal string values; "indirect" treats values as references (e.g. names of environment -// variables on the host) that the runtime resolves before launch. Defaults to the runtime's -// startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI -// prompt mode and ACP) set this to "direct". -// Experimental: McpSetEnvValueModeDetails is part of an experimental API and may change or -// be removed. -type McpSetEnvValueModeDetails string +func (TaskShellProgress) taskProgress() {} +func (TaskShellProgress) Type() TaskProgressType { + return TaskProgressTypeShell +} -const ( - // Treat MCP server environment values as literal strings. - McpSetEnvValueModeDetailsDirect McpSetEnvValueModeDetails = "direct" - // Treat MCP server environment values as host-side references to resolve before launch. - McpSetEnvValueModeDetailsIndirect McpSetEnvValueModeDetails = "indirect" -) +// Timestamped display line for task progress output or recent agent activity. +// Experimental: TaskProgressLine is part of an experimental API and may change or be +// removed. +type TaskProgressLine struct { + // Display message, e.g., "▸ bash", "✓ edit src/foo.ts" + Message string `json:"message"` + // ISO 8601 timestamp when this event occurred + Timestamp time.Time `json:"timestamp"` +} -// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') -// Experimental: MetadataSnapshotCurrentMode is part of an experimental API and may change -// or be removed. -type MetadataSnapshotCurrentMode string +// Identifier of the background task to cancel. +// Experimental: TasksCancelRequest is part of an experimental API and may change or be +// removed. +type TasksCancelRequest struct { + // Task identifier + ID string `json:"id"` +} -const ( - // The agent is working autonomously toward task completion. - MetadataSnapshotCurrentModeAutopilot MetadataSnapshotCurrentMode = "autopilot" - // The agent is responding interactively to the user. - MetadataSnapshotCurrentModeInteractive MetadataSnapshotCurrentMode = "interactive" - // The agent is preparing a plan before making changes. - MetadataSnapshotCurrentModePlan MetadataSnapshotCurrentMode = "plan" -) +// Indicates whether the background task was successfully cancelled. +// Experimental: TasksCancelResult is part of an experimental API and may change or be +// removed. +type TasksCancelResult struct { + // Whether the task was successfully cancelled + Cancelled bool `json:"cancelled"` +} -// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` -// invocation. -// Experimental: MetadataSnapshotRemoteMetadataTaskType is part of an experimental API and -// may change or be removed. -type MetadataSnapshotRemoteMetadataTaskType string +// The first sync-waiting task that can currently be promoted to background mode. +// Experimental: TasksGetCurrentPromotableResult is part of an experimental API and may +// change or be removed. +type TasksGetCurrentPromotableResult struct { + // The first sync-waiting task (agent first, then shell) that can currently be promoted to + // background mode. Omitted if no such task exists. The returned task is guaranteed to have + // executionMode='sync' and canPromoteToBackground=true at the time of the call. + Task TaskInfo `json:"task,omitempty"` +} -const ( - // Remote task originated from Copilot Coding Agent. - MetadataSnapshotRemoteMetadataTaskTypeCca MetadataSnapshotRemoteMetadataTaskType = "cca" - // Remote task originated from a CLI remote-session invocation. - MetadataSnapshotRemoteMetadataTaskTypeCli MetadataSnapshotRemoteMetadataTaskType = "cli" -) +// Identifier of the background task to fetch progress for. +// Experimental: TasksGetProgressRequest is part of an experimental API and may change or be +// removed. +type TasksGetProgressRequest struct { + // Task identifier (agent ID or shell ID) + ID string `json:"id"` +} -// Context tier currently pinned for the session, when one is set. Reflects -// `Session.getContextTier()`, restored from the session journal on resume. -// Experimental: ModelCurrentContextTier is part of an experimental API and may change or be +// Progress information for the task, or null when no task with that ID is tracked. +// Experimental: TasksGetProgressResult is part of an experimental API and may change or be // removed. -type ModelCurrentContextTier string +type TasksGetProgressResult struct { + // Progress information for the task, discriminated by type. Returns null when no task with + // this ID is currently tracked. + Progress TaskProgress `json:"progress,omitempty"` +} -const ( - // Use the model's default context window. - ModelCurrentContextTierDefault ModelCurrentContextTier = "default" - // Pin the session to the long-context tier when supported. - ModelCurrentContextTierLongContext ModelCurrentContextTier = "long_context" -) +// The promoted task as it now exists in background mode, omitted if no promotable task was +// waiting. +// Experimental: TasksPromoteCurrentToBackgroundResult is part of an experimental API and +// may change or be removed. +type TasksPromoteCurrentToBackgroundResult struct { + // The promoted task as it now exists in background mode, omitted if no promotable task was + // waiting. Atomic operation: avoids the race window of getCurrentPromotable + + // promoteToBackground. + Task TaskInfo `json:"task,omitempty"` +} -// Model capability category for grouping in the model picker -type ModelPickerCategory string +// Identifier of the task to promote to background mode. +// Experimental: TasksPromoteToBackgroundRequest is part of an experimental API and may +// change or be removed. +type TasksPromoteToBackgroundRequest struct { + // Task identifier + ID string `json:"id"` +} -const ( - // Lightweight model category optimized for faster, lower-cost interactions. - ModelPickerCategoryLightweight ModelPickerCategory = "lightweight" - // Powerful model category optimized for complex tasks. - ModelPickerCategoryPowerful ModelPickerCategory = "powerful" - // Versatile model category suitable for a broad range of tasks. - ModelPickerCategoryVersatile ModelPickerCategory = "versatile" -) +// Indicates whether the task was successfully promoted to background mode. +// Experimental: TasksPromoteToBackgroundResult is part of an experimental API and may +// change or be removed. +type TasksPromoteToBackgroundResult struct { + // Whether the task was successfully promoted to background mode + Promoted bool `json:"promoted"` +} -// Relative cost tier for token-based billing users -type ModelPickerPriceCategory string +// Refresh metadata for any detached background shells the runtime knows about. Use after a +// long pause to pick up exit/output state for shells running outside the agent loop. +// Experimental: TasksRefreshResult is part of an experimental API and may change or be +// removed. +type TasksRefreshResult struct { +} -const ( - // High relative token cost tier. - ModelPickerPriceCategoryHigh ModelPickerPriceCategory = "high" - // Lowest relative token cost tier. - ModelPickerPriceCategoryLow ModelPickerPriceCategory = "low" - // Medium relative token cost tier. - ModelPickerPriceCategoryMedium ModelPickerPriceCategory = "medium" - // Highest relative token cost tier. - ModelPickerPriceCategoryVeryHigh ModelPickerPriceCategory = "very_high" -) +// Identifier of the completed or cancelled task to remove from tracking. +// Experimental: TasksRemoveRequest is part of an experimental API and may change or be +// removed. +type TasksRemoveRequest struct { + // Task identifier + ID string `json:"id"` +} -// Current policy state for this model -type ModelPolicyState string +// Indicates whether the task was removed. False when the task does not exist or is still +// running/idle. +// Experimental: TasksRemoveResult is part of an experimental API and may change or be +// removed. +type TasksRemoveResult struct { + // Whether the task was removed. Returns false if the task does not exist or is still + // running/idle (cancel it first). + Removed bool `json:"removed"` +} -const ( - // The model is disabled by policy. - ModelPolicyStateDisabled ModelPolicyState = "disabled" - // The model is enabled by policy. - ModelPolicyStateEnabled ModelPolicyState = "enabled" - // No explicit policy is configured for the model. - ModelPolicyStateUnconfigured ModelPolicyState = "unconfigured" -) +// Identifier of the target agent task, message content, and optional sender agent ID. +// Experimental: TasksSendMessageRequest is part of an experimental API and may change or be +// removed. +type TasksSendMessageRequest struct { + // Agent ID of the sender, if sent on behalf of another agent + FromAgentID *string `json:"fromAgentId,omitempty"` + // Agent task identifier + ID string `json:"id"` + // Message content to send to the agent + Message string `json:"message"` +} -type ModelSwitchToRequestContextTier string +// Indicates whether the message was delivered, with an error message when delivery failed. +// Experimental: TasksSendMessageResult is part of an experimental API and may change or be +// removed. +type TasksSendMessageResult struct { + // Error message if delivery failed + Error *string `json:"error,omitempty"` + // Whether the message was successfully delivered or steered + Sent bool `json:"sent"` +} -const ( - // Use the model's default context window. - ModelSwitchToRequestContextTierDefault ModelSwitchToRequestContextTier = "default" - // Pin the session to the long-context tier when supported. - ModelSwitchToRequestContextTierLongContext ModelSwitchToRequestContextTier = "long_context" -) +// Agent type, prompt, name, and optional description and model override for the new task. +// Experimental: TasksStartAgentRequest is part of an experimental API and may change or be +// removed. +type TasksStartAgentRequest struct { + // Type of agent to start (e.g., 'explore', 'task', 'general-purpose') + AgentType string `json:"agentType"` + // Short description of the task + Description *string `json:"description,omitempty"` + // Optional model override + Model *string `json:"model,omitempty"` + // Short name for the agent, used to generate a human-readable ID + Name string `json:"name"` + // Task prompt for the agent + Prompt string `json:"prompt"` +} -// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` -// resolves at launch). -// Experimental: OptionsUpdateEnvValueMode is part of an experimental API and may change or -// be removed. -type OptionsUpdateEnvValueMode string +// Identifier assigned to the newly started background agent task. +// Experimental: TasksStartAgentResult is part of an experimental API and may change or be +// removed. +type TasksStartAgentResult struct { + // Generated agent ID for the background task + AgentID string `json:"agentId"` +} -const ( - // Pass MCP server environment values as literal strings. - OptionsUpdateEnvValueModeDirect OptionsUpdateEnvValueMode = "direct" - // Resolve MCP server environment values from host-side references. - OptionsUpdateEnvValueModeIndirect OptionsUpdateEnvValueMode = "indirect" -) +// Wait until all in-flight background tasks (agents + shells) and any follow-up turns +// scheduled by their completions have settled. Returns when the runtime is fully drained or +// after an internal timeout (default 10 minutes; configurable via +// COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +// Experimental: TasksWaitForPendingResult is part of an experimental API and may change or +// be removed. +type TasksWaitForPendingResult struct { +} -// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both -// are set. -// Experimental: OptionsUpdateToolFilterPrecedence is part of an experimental API and may +// Feature override key/value pairs to attach to subsequent telemetry events from this +// session. +// Experimental: TelemetrySetFeatureOverridesRequest is part of an experimental API and may // change or be removed. -type OptionsUpdateToolFilterPrecedence string +type TelemetrySetFeatureOverridesRequest struct { + // Override key/value pairs to attach to subsequent telemetry events from this session. + // Replaces any previously-set overrides. + Features map[string]string `json:"features"` +} -const ( - // If availableTools is set, it is the only constraint that applies (excludedTools is - // ignored). Preserves CLI / pre-existing client behavior. Default. - OptionsUpdateToolFilterPrecedenceAvailable OptionsUpdateToolFilterPrecedence = "available" - // A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND - // it does not match the denylist. Makes 'all except X' expressible by combining the two - // lists. - OptionsUpdateToolFilterPrecedenceExcluded OptionsUpdateToolFilterPrecedence = "excluded" -) +// Built-in tool metadata with identifier, optional namespaced name, description, +// input-parameter schema, and usage instructions. +// Experimental: Tool is part of an experimental API and may change or be removed. +type Tool struct { + // Description of what the tool does + Description string `json:"description"` + // Optional instructions for how to use this tool effectively + Instructions *string `json:"instructions,omitempty"` + // Tool identifier (e.g., "bash", "grep", "str_replace_editor") + Name string `json:"name"` + // Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP + // tools) + NamespacedName *string `json:"namespacedName,omitempty"` + // JSON Schema for the tool's input parameters + Parameters map[string]any `json:"parameters,omitzero"` +} -// Kind discriminator for PermissionDecisionApproveForLocationApproval. -type PermissionDecisionApproveForLocationApprovalKind string +// Built-in tools available for the requested model, with their parameters and instructions. +// Experimental: ToolList is part of an experimental API and may change or be removed. +type ToolList struct { + // List of available built-in tools with metadata + Tools []Tool `json:"tools"` +} -const ( - PermissionDecisionApproveForLocationApprovalKindCommands PermissionDecisionApproveForLocationApprovalKind = "commands" - PermissionDecisionApproveForLocationApprovalKindCustomTool PermissionDecisionApproveForLocationApprovalKind = "custom-tool" - PermissionDecisionApproveForLocationApprovalKindExtensionManagement PermissionDecisionApproveForLocationApprovalKind = "extension-management" - PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess PermissionDecisionApproveForLocationApprovalKind = "extension-permission-access" - PermissionDecisionApproveForLocationApprovalKindMcp PermissionDecisionApproveForLocationApprovalKind = "mcp" - PermissionDecisionApproveForLocationApprovalKindMcpSampling PermissionDecisionApproveForLocationApprovalKind = "mcp-sampling" - PermissionDecisionApproveForLocationApprovalKindMemory PermissionDecisionApproveForLocationApprovalKind = "memory" - PermissionDecisionApproveForLocationApprovalKindRead PermissionDecisionApproveForLocationApprovalKind = "read" - PermissionDecisionApproveForLocationApprovalKindWrite PermissionDecisionApproveForLocationApprovalKind = "write" -) +// Current lightweight tool metadata snapshot for the session. +// Experimental: ToolsGetCurrentMetadataResult is part of an experimental API and may change +// or be removed. +type ToolsGetCurrentMetadataResult struct { + // Current tool metadata, or null when tools have not been initialized yet + Tools []CurrentToolMetadata `json:"tools"` +} -// Kind discriminator for PermissionDecisionApproveForSessionApproval. -type PermissionDecisionApproveForSessionApprovalKind string +// Resolve, build, and validate the runtime tool list for this session. Subagent sessions +// and consumer flows that need an initialized tool set before `send` invoke this. Default +// base-class implementation is a no-op for sessions that don't support tool validation. +// Experimental: ToolsInitializeAndValidateResult is part of an experimental API and may +// change or be removed. +type ToolsInitializeAndValidateResult struct { +} -const ( - PermissionDecisionApproveForSessionApprovalKindCommands PermissionDecisionApproveForSessionApprovalKind = "commands" - PermissionDecisionApproveForSessionApprovalKindCustomTool PermissionDecisionApproveForSessionApprovalKind = "custom-tool" - PermissionDecisionApproveForSessionApprovalKindExtensionManagement PermissionDecisionApproveForSessionApprovalKind = "extension-management" - PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess PermissionDecisionApproveForSessionApprovalKind = "extension-permission-access" - PermissionDecisionApproveForSessionApprovalKindMcp PermissionDecisionApproveForSessionApprovalKind = "mcp" - PermissionDecisionApproveForSessionApprovalKindMcpSampling PermissionDecisionApproveForSessionApprovalKind = "mcp-sampling" - PermissionDecisionApproveForSessionApprovalKindMemory PermissionDecisionApproveForSessionApprovalKind = "memory" - PermissionDecisionApproveForSessionApprovalKindRead PermissionDecisionApproveForSessionApprovalKind = "read" - PermissionDecisionApproveForSessionApprovalKindWrite PermissionDecisionApproveForSessionApprovalKind = "write" -) +// Optional model identifier whose tool overrides should be applied to the listing. +// Experimental: ToolsListRequest is part of an experimental API and may change or be +// removed. +type ToolsListRequest struct { + // Optional model ID — when provided, the returned tool list reflects model-specific + // overrides + Model *string `json:"model,omitempty"` +} -// Kind discriminator for PermissionDecision. -type PermissionDecisionKind string +// Empty result after applying subagent settings +// Experimental: ToolsUpdateSubagentSettingsResult is part of an experimental API and may +// change or be removed. +type ToolsUpdateSubagentSettingsResult struct { +} -const ( - PermissionDecisionKindApproved PermissionDecisionKind = "approved" - PermissionDecisionKindApprovedForLocation PermissionDecisionKind = "approved-for-location" - PermissionDecisionKindApprovedForSession PermissionDecisionKind = "approved-for-session" - PermissionDecisionKindApproveForLocation PermissionDecisionKind = "approve-for-location" - PermissionDecisionKindApproveForSession PermissionDecisionKind = "approve-for-session" - PermissionDecisionKindApproveOnce PermissionDecisionKind = "approve-once" - PermissionDecisionKindApprovePermanently PermissionDecisionKind = "approve-permanently" - PermissionDecisionKindCancelled PermissionDecisionKind = "cancelled" - PermissionDecisionKindDeniedByContentExclusionPolicy PermissionDecisionKind = "denied-by-content-exclusion-policy" - PermissionDecisionKindDeniedByPermissionRequestHook PermissionDecisionKind = "denied-by-permission-request-hook" - PermissionDecisionKindDeniedByRules PermissionDecisionKind = "denied-by-rules" - PermissionDecisionKindDeniedInteractivelyByUser PermissionDecisionKind = "denied-interactively-by-user" - PermissionDecisionKindDeniedNoApprovalRuleAndCouldNotRequestFromUser PermissionDecisionKind = "denied-no-approval-rule-and-could-not-request-from-user" - PermissionDecisionKindReject PermissionDecisionKind = "reject" - PermissionDecisionKindUserNotAvailable PermissionDecisionKind = "user-not-available" -) +// Schema applied to each item in the array. +// Experimental: UIElicitationArrayAnyOfFieldItems is part of an experimental API and may +// change or be removed. +type UIElicitationArrayAnyOfFieldItems struct { + // Selectable options, each with a value and a display label. + AnyOf []UIElicitationArrayAnyOfFieldItemsAnyOf `json:"anyOf"` +} -// Whether the location is a git repo or directory -// Experimental: PermissionLocationType is part of an experimental API and may change or be -// removed. -type PermissionLocationType string +// Selectable option for a UI elicitation multi-select array item, with submitted value and +// display label. +// Experimental: UIElicitationArrayAnyOfFieldItemsAnyOf is part of an experimental API and +// may change or be removed. +type UIElicitationArrayAnyOfFieldItemsAnyOf struct { + // Value submitted when this option is selected. + Const string `json:"const"` + // Display label for this option. + Title string `json:"title"` +} -const ( - // The permission location is persisted at the working directory. - PermissionLocationTypeDir PermissionLocationType = "dir" - // The permission location is persisted at the git repository root. - PermissionLocationTypeRepo PermissionLocationType = "repo" -) +// Schema applied to each item in the array. +// Experimental: UIElicitationArrayEnumFieldItems is part of an experimental API and may +// change or be removed. +type UIElicitationArrayEnumFieldItems struct { + // Allowed string values for each selected item. + Enum []string `json:"enum"` + // Type discriminator. Always "string". + Type UIElicitationArrayEnumFieldItemsType `json:"type"` +} -// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` -// enumeration. -// Experimental: PermissionsConfigureAdditionalContentExclusionPolicyScope is part of an -// experimental API and may change or be removed. -type PermissionsConfigureAdditionalContentExclusionPolicyScope string +// Submitted UI elicitation field value: string, number, boolean, or an array of strings. +// Experimental: UIElicitationFieldValue is part of an experimental API and may change or be +// removed. +type UIElicitationFieldValue interface { + uiElicitationFieldValue() +} -const ( - // The content exclusion policy applies across all repositories. - PermissionsConfigureAdditionalContentExclusionPolicyScopeAll PermissionsConfigureAdditionalContentExclusionPolicyScope = "all" - // The content exclusion policy applies to the current repository. - PermissionsConfigureAdditionalContentExclusionPolicyScopeRepo PermissionsConfigureAdditionalContentExclusionPolicyScope = "repo" -) +type UIElicitationBooleanValue bool -// Kind discriminator for PermissionsLocationsAddToolApprovalDetails. -type PermissionsLocationsAddToolApprovalDetailsKind string +func (UIElicitationBooleanValue) uiElicitationFieldValue() {} -const ( - PermissionsLocationsAddToolApprovalDetailsKindCommands PermissionsLocationsAddToolApprovalDetailsKind = "commands" - PermissionsLocationsAddToolApprovalDetailsKindCustomTool PermissionsLocationsAddToolApprovalDetailsKind = "custom-tool" - PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement PermissionsLocationsAddToolApprovalDetailsKind = "extension-management" - PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess PermissionsLocationsAddToolApprovalDetailsKind = "extension-permission-access" - PermissionsLocationsAddToolApprovalDetailsKindMcp PermissionsLocationsAddToolApprovalDetailsKind = "mcp" - PermissionsLocationsAddToolApprovalDetailsKindMcpSampling PermissionsLocationsAddToolApprovalDetailsKind = "mcp-sampling" - PermissionsLocationsAddToolApprovalDetailsKindMemory PermissionsLocationsAddToolApprovalDetailsKind = "memory" - PermissionsLocationsAddToolApprovalDetailsKindRead PermissionsLocationsAddToolApprovalDetailsKind = "read" - PermissionsLocationsAddToolApprovalDetailsKindWrite PermissionsLocationsAddToolApprovalDetailsKind = "write" -) +type UIElicitationNumberValue float64 -// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or -// to location-scoped rules persisted via the location-permissions config file. -// Experimental: PermissionsModifyRulesScope is part of an experimental API and may change -// or be removed. -type PermissionsModifyRulesScope string +func (UIElicitationNumberValue) uiElicitationFieldValue() {} -const ( - // Persist the rule change for this project location. - PermissionsModifyRulesScopeLocation PermissionsModifyRulesScope = "location" - // Apply the rule change only to this session. - PermissionsModifyRulesScopeSession PermissionsModifyRulesScope = "session" -) +type UIElicitationStringArrayValue []string -// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. -// Experimental: PermissionsSetAllowAllSource is part of an experimental API and may change -// or be removed. -type PermissionsSetAllowAllSource string +func (UIElicitationStringArrayValue) uiElicitationFieldValue() {} -const ( - // Allow-all was enabled by confirming autopilot behavior. - PermissionsSetAllowAllSourceAutopilotConfirmation PermissionsSetAllowAllSource = "autopilot_confirmation" - // Allow-all was enabled from a CLI command-line flag. - PermissionsSetAllowAllSourceCliFlag PermissionsSetAllowAllSource = "cli_flag" - // Allow-all was enabled through an RPC caller. - PermissionsSetAllowAllSourceRPC PermissionsSetAllowAllSource = "rpc" - // Allow-all was enabled by a slash command. - PermissionsSetAllowAllSourceSlashCommand PermissionsSetAllowAllSource = "slash_command" -) +type UIElicitationStringValue string -// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. -// Experimental: PermissionsSetApproveAllSource is part of an experimental API and may -// change or be removed. -type PermissionsSetApproveAllSource string +func (UIElicitationStringValue) uiElicitationFieldValue() {} -const ( - // Allow-all was enabled by confirming autopilot behavior. - PermissionsSetApproveAllSourceAutopilotConfirmation PermissionsSetApproveAllSource = "autopilot_confirmation" - // Allow-all was enabled from a CLI command-line flag. - PermissionsSetApproveAllSourceCliFlag PermissionsSetApproveAllSource = "cli_flag" - // Allow-all was enabled through an RPC caller. - PermissionsSetApproveAllSourceRPC PermissionsSetApproveAllSource = "rpc" - // Allow-all was enabled by a slash command. - PermissionsSetApproveAllSourceSlashCommand PermissionsSetApproveAllSource = "slash_command" -) +// Prompt message and JSON schema describing the form fields to elicit from the user. +// Experimental: UIElicitationRequest is part of an experimental API and may change or be +// removed. +type UIElicitationRequest struct { + // Message describing what information is needed from the user + Message string `json:"message"` + // JSON Schema describing the form fields to present to the user + RequestedSchema UIElicitationSchema `json:"requestedSchema"` +} -// Whether this item is a queued user message or a queued slash command / model change -// Experimental: QueuePendingItemsKind is part of an experimental API and may change or be +// The elicitation response (accept with form values, decline, or cancel) +// Experimental: UIElicitationResponse is part of an experimental API and may change or be // removed. -type QueuePendingItemsKind string +type UIElicitationResponse struct { + // The user's response: accept (submitted), decline (rejected), or cancel (dismissed) + Action UIElicitationResponseAction `json:"action"` + // The form values submitted by the user (present when action is 'accept') + Content map[string]UIElicitationFieldValue `json:"content,omitzero"` +} -const ( - // A queued slash command or model-change command. - QueuePendingItemsKindCommand QueuePendingItemsKind = "command" - // A queued user message. - QueuePendingItemsKindMessage QueuePendingItemsKind = "message" -) +// The form values submitted by the user (present when action is 'accept') +// Experimental: UIElicitationResponseContent is part of an experimental API and may change +// or be removed. +type UIElicitationResponseContent map[string]UIElicitationFieldValue -// Reasoning summary mode to request for supported model clients -// Experimental: ReasoningSummary is part of an experimental API and may change or be +// Indicates whether the elicitation response was accepted; false if it was already resolved +// by another client. +// Experimental: UIElicitationResult is part of an experimental API and may change or be // removed. -type ReasoningSummary string +type UIElicitationResult struct { + // Whether the response was accepted. False if the request was already resolved by another + // client. + Success bool `json:"success"` +} -const ( - // Request a concise summary of the model's reasoning. - ReasoningSummaryConcise ReasoningSummary = "concise" - // Request a detailed summary of the model's reasoning. - ReasoningSummaryDetailed ReasoningSummary = "detailed" - // Do not request reasoning summaries from the model. - ReasoningSummaryNone ReasoningSummary = "none" -) - -// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub -// without enabling remote steering, "on" enables both export and remote steering. -// Experimental: RemoteSessionMode is part of an experimental API and may change or be +// JSON Schema describing the form fields to present to the user +// Experimental: UIElicitationSchema is part of an experimental API and may change or be // removed. -type RemoteSessionMode string - -const ( - // Export session events to GitHub without enabling remote steering. - RemoteSessionModeExport RemoteSessionMode = "export" - // Disable remote session export and steering. - RemoteSessionModeOff RemoteSessionMode = "off" - // Enable both remote session export and remote steering. - RemoteSessionModeOn RemoteSessionMode = "on" -) - -// The UI mode the agent was in when this message was sent. Defaults to the session's -// current mode. -// Experimental: SendAgentMode is part of an experimental API and may change or be removed. -type SendAgentMode string +type UIElicitationSchema struct { + // Form field definitions, keyed by field name + Properties map[string]UIElicitationSchemaProperty `json:"properties"` + // List of required field names + Required []string `json:"required,omitzero"` + // Schema type indicator (always 'object') + Type UIElicitationSchemaType `json:"type"` +} -const ( - // The agent is working autonomously toward task completion. - SendAgentModeAutopilot SendAgentMode = "autopilot" - // The agent is responding interactively to the user. - SendAgentModeInteractive SendAgentMode = "interactive" - // The agent is preparing a plan before making changes. - SendAgentModePlan SendAgentMode = "plan" - // The agent is in shell-focused UI mode. - SendAgentModeShell SendAgentMode = "shell" -) +// Definition for a single elicitation form field. +// Experimental: UIElicitationSchemaProperty is part of an experimental API and may change +// or be removed. +type UIElicitationSchemaProperty interface { + uiElicitationSchemaProperty() + Type() UIElicitationSchemaPropertyType +} -// Type of GitHub reference -// Experimental: SendAttachmentGithubReferenceType is part of an experimental API and may -// change or be removed. -type SendAttachmentGithubReferenceType string +type RawUIElicitationSchemaPropertyData struct { + Discriminator UIElicitationSchemaPropertyType + Raw json.RawMessage +} -const ( - // GitHub discussion reference. - SendAttachmentGithubReferenceTypeDiscussion SendAttachmentGithubReferenceType = "discussion" - // GitHub issue reference. - SendAttachmentGithubReferenceTypeIssue SendAttachmentGithubReferenceType = "issue" - // GitHub pull request reference. - SendAttachmentGithubReferenceTypePr SendAttachmentGithubReferenceType = "pr" -) +func (RawUIElicitationSchemaPropertyData) uiElicitationSchemaProperty() {} +func (r RawUIElicitationSchemaPropertyData) Type() UIElicitationSchemaPropertyType { + return r.Discriminator +} -// Type discriminator for SendAttachment. -type SendAttachmentType string +// Multi-select string field where each option pairs a value with a display label. +// Experimental: UIElicitationArrayAnyOfField is part of an experimental API and may change +// or be removed. +type UIElicitationArrayAnyOfField struct { + // Default values selected when the form is first shown. + Default []string `json:"default,omitzero"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Schema applied to each item in the array. + Items UIElicitationArrayAnyOfFieldItems `json:"items"` + // Maximum number of items the user may select. + MaxItems *int64 `json:"maxItems,omitempty"` + // Minimum number of items the user must select. + MinItems *int64 `json:"minItems,omitempty"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -const ( - SendAttachmentTypeBlob SendAttachmentType = "blob" - SendAttachmentTypeDirectory SendAttachmentType = "directory" - SendAttachmentTypeFile SendAttachmentType = "file" - SendAttachmentTypeGithubReference SendAttachmentType = "github_reference" - SendAttachmentTypeSelection SendAttachmentType = "selection" -) +func (UIElicitationArrayAnyOfField) uiElicitationSchemaProperty() {} +func (UIElicitationArrayAnyOfField) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeArray +} -// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` -// interjects during an in-progress turn. -// Experimental: SendMode is part of an experimental API and may change or be removed. -type SendMode string +// Multi-select string field whose allowed values are defined inline. +// Experimental: UIElicitationArrayEnumField is part of an experimental API and may change +// or be removed. +type UIElicitationArrayEnumField struct { + // Default values selected when the form is first shown. + Default []string `json:"default,omitzero"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Schema applied to each item in the array. + Items UIElicitationArrayEnumFieldItems `json:"items"` + // Maximum number of items the user may select. + MaxItems *int64 `json:"maxItems,omitempty"` + // Minimum number of items the user must select. + MinItems *int64 `json:"minItems,omitempty"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -const ( - // Append the message to the normal session queue. - SendModeEnqueue SendMode = "enqueue" - // Interject the message during the in-progress turn. - SendModeImmediate SendMode = "immediate" -) +func (UIElicitationArrayEnumField) uiElicitationSchemaProperty() {} +func (UIElicitationArrayEnumField) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeArray +} -// Repository host type -// Experimental: SessionContextHostType is part of an experimental API and may change or be -// removed. -type SessionContextHostType string +// Boolean field rendered as a yes/no toggle. +// Experimental: UIElicitationSchemaPropertyBoolean is part of an experimental API and may +// change or be removed. +type UIElicitationSchemaPropertyBoolean struct { + // Default value selected when the form is first shown. + Default *bool `json:"default,omitempty"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -const ( - // Session repository is hosted on Azure DevOps. - SessionContextHostTypeAdo SessionContextHostType = "ado" - // Session repository is hosted on GitHub. - SessionContextHostTypeGithub SessionContextHostType = "github" -) +func (UIElicitationSchemaPropertyBoolean) uiElicitationSchemaProperty() {} +func (UIElicitationSchemaPropertyBoolean) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeBoolean +} -// Error classification -// Experimental: SessionFsErrorCode is part of an experimental API and may change or be -// removed. -type SessionFsErrorCode string +// Numeric field accepting either a number or an integer. +// Experimental: UIElicitationSchemaPropertyNumber is part of an experimental API and may +// change or be removed. +type UIElicitationSchemaPropertyNumber struct { + // Default value populated in the input when the form is first shown. + Default *float64 `json:"default,omitempty"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Maximum allowed value (inclusive). + Maximum *float64 `json:"maximum,omitempty"` + // Minimum allowed value (inclusive). + Minimum *float64 `json:"minimum,omitempty"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` + Discriminator UIElicitationSchemaPropertyNumberType `json:"type,omitempty"` +} -const ( - // The requested path does not exist. - SessionFsErrorCodeENOENT SessionFsErrorCode = "ENOENT" - // The filesystem operation failed for an unspecified reason. - SessionFsErrorCodeUNKNOWN SessionFsErrorCode = "UNKNOWN" -) +func (UIElicitationSchemaPropertyNumber) uiElicitationSchemaProperty() {} +func (r UIElicitationSchemaPropertyNumber) Type() UIElicitationSchemaPropertyType { + if r.Discriminator == "" { + return UIElicitationSchemaPropertyTypeNumber + } + return UIElicitationSchemaPropertyType(r.Discriminator) +} -// Entry type -// Experimental: SessionFsReaddirWithTypesEntryType is part of an experimental API and may +// Free-text string field with optional length and format constraints. +// Experimental: UIElicitationSchemaPropertyString is part of an experimental API and may // change or be removed. -type SessionFsReaddirWithTypesEntryType string - -const ( - // The entry is a directory. - SessionFsReaddirWithTypesEntryTypeDirectory SessionFsReaddirWithTypesEntryType = "directory" - // The entry is a file. - SessionFsReaddirWithTypesEntryTypeFile SessionFsReaddirWithTypesEntryType = "file" -) +type UIElicitationSchemaPropertyString struct { + // Default value populated in the input when the form is first shown. + Default *string `json:"default,omitempty"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Optional format hint that constrains the accepted input. + Format *UIElicitationSchemaPropertyStringFormat `json:"format,omitempty"` + // Maximum number of characters allowed. + MaxLength *int64 `json:"maxLength,omitempty"` + // Minimum number of characters required. + MinLength *int64 `json:"minLength,omitempty"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -// Path conventions used by this filesystem -type SessionFsSetProviderConventions string +func (UIElicitationSchemaPropertyString) uiElicitationSchemaProperty() {} +func (UIElicitationSchemaPropertyString) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeString +} -const ( - // Paths use POSIX path conventions. - SessionFsSetProviderConventionsPosix SessionFsSetProviderConventions = "posix" - // Paths use Windows path conventions. - SessionFsSetProviderConventionsWindows SessionFsSetProviderConventions = "windows" -) +// Single-select string field whose allowed values are defined inline. +// Experimental: UIElicitationStringEnumField is part of an experimental API and may change +// or be removed. +type UIElicitationStringEnumField struct { + // Default value selected when the form is first shown. + Default *string `json:"default,omitempty"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Allowed string values. + Enum []string `json:"enum"` + // Optional display labels for each enum value, in the same order as `enum`. + EnumNames []string `json:"enumNames,omitzero"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT -// (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) -// Experimental: SessionFsSqliteQueryType is part of an experimental API and may change or -// be removed. -type SessionFsSqliteQueryType string +func (UIElicitationStringEnumField) uiElicitationSchemaProperty() {} +func (UIElicitationStringEnumField) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeString +} -const ( - // Execute DDL or multi-statement SQL without returning rows. - SessionFsSqliteQueryTypeExec SessionFsSqliteQueryType = "exec" - // Execute a SELECT-style query and return rows. - SessionFsSqliteQueryTypeQuery SessionFsSqliteQueryType = "query" - // Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. - SessionFsSqliteQueryTypeRun SessionFsSqliteQueryType = "run" -) +// Single-select string field where each option pairs a value with a display label. +// Experimental: UIElicitationStringOneOfField is part of an experimental API and may change +// or be removed. +type UIElicitationStringOneOfField struct { + // Default value selected when the form is first shown. + Default *string `json:"default,omitempty"` + // Help text describing the field. + Description *string `json:"description,omitempty"` + // Selectable options, each with a value and a display label. + OneOf []UIElicitationStringOneOfFieldOneOf `json:"oneOf"` + // Human-readable label for the field. + Title *string `json:"title,omitempty"` +} -// Constant value. Always "github". -type SessionInstalledPluginSourceGithubSource string +func (UIElicitationStringOneOfField) uiElicitationSchemaProperty() {} +func (UIElicitationStringOneOfField) Type() UIElicitationSchemaPropertyType { + return UIElicitationSchemaPropertyTypeString +} -const ( - SessionInstalledPluginSourceGithubSourceGithub SessionInstalledPluginSourceGithubSource = "github" -) +// Selectable option for a UI elicitation single-select string field, with submitted value +// and display label. +// Experimental: UIElicitationStringOneOfFieldOneOf is part of an experimental API and may +// change or be removed. +type UIElicitationStringOneOfFieldOneOf struct { + // Value submitted when this option is selected. + Const string `json:"const"` + // Display label for this option. + Title string `json:"title"` +} -// Constant value. Always "local". -type SessionInstalledPluginSourceLocalSource string +// Transient question to answer without adding it to conversation history. +// Experimental: UIEphemeralQueryRequest is part of an experimental API and may change or be +// removed. +type UIEphemeralQueryRequest struct { + // In-process `AbortSignal` forwarded to the model client to cancel an in-flight request. + // Marked internal: excluded from the public SDK surface. Replaced by an explicit + // cancellation token + cancel RPC in the SDK migration. + // Internal: AbortSignal is part of the SDK's internal API surface and is not intended for + // external use. + AbortSignal any `json:"abortSignal,omitempty"` + // In-process streaming callback `(text) => void` invoked with each token as the model emits + // it. Marked internal: excluded from the public SDK surface. In a process-separated SDK + // this is replaced by a streaming RPC that yields chunks and a final answer. + // Internal: OnChunk is part of the SDK's internal API surface and is not intended for + // external use. + OnChunk any `json:"onChunk,omitempty"` + // Question to answer from the current conversation context. + Question string `json:"question"` +} -const ( - SessionInstalledPluginSourceLocalSourceLocal SessionInstalledPluginSourceLocalSource = "local" -) +// Transient answer generated from current conversation context. +// Experimental: UIEphemeralQueryResult is part of an experimental API and may change or be +// removed. +type UIEphemeralQueryResult struct { + // Full assistant response text. + Answer string `json:"answer"` +} -// Constant value. Always "url". -type SessionInstalledPluginSourceURLSource string +// User response for a pending exit-plan-mode request, with approval state, selected action, +// auto-approve flag, and feedback. +// Experimental: UIExitPlanModeResponse is part of an experimental API and may change or be +// removed. +type UIExitPlanModeResponse struct { + // Whether the plan was approved. + Approved bool `json:"approved"` + // Whether subsequent edits should be auto-approved without confirmation. + AutoApproveEdits *bool `json:"autoApproveEdits,omitempty"` + // When true, the agent is instructed to end its turn without starting implementation so the + // client can restore the session model and auto-submit a fresh implementation turn on it. + // Set only when a distinct plan configuration (a different model, reasoning effort, or + // context tier) actually ran the planning turn. + DeferImplementation *bool `json:"deferImplementation,omitempty"` + // Feedback from the user when they declined the plan or requested changes. + Feedback *string `json:"feedback,omitempty"` + // The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, + // otherwise 'interactive'. + SelectedAction *UIExitPlanModeAction `json:"selectedAction,omitempty"` +} -const ( - SessionInstalledPluginSourceURLSourceURL SessionInstalledPluginSourceURLSource = "url" -) +// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +// Experimental: UIHandlePendingAutoModeSwitchRequest is part of an experimental API and may +// change or be removed. +type UIHandlePendingAutoModeSwitchRequest struct { + // The unique request ID from the auto_mode_switch.requested event + RequestID string `json:"requestId"` + // User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist + // as setting), or no (decline). + Response UIAutoModeSwitchResponse `json:"response"` +} -// Log severity level. Determines how the message is displayed in the timeline. Defaults to -// "info". -// Experimental: SessionLogLevel is part of an experimental API and may change or be removed. -type SessionLogLevel string +// Pending elicitation request ID and the user's response (accept/decline/cancel + form +// values). +// Experimental: UIHandlePendingElicitationRequest is part of an experimental API and may +// change or be removed. +type UIHandlePendingElicitationRequest struct { + // The unique request ID from the elicitation.requested event + RequestID string `json:"requestId"` + // The elicitation response (accept with form values, decline, or cancel) + Result UIElicitationResponse `json:"result"` +} -const ( - // Error message describing a failure. - SessionLogLevelError SessionLogLevel = "error" - // Informational message. - SessionLogLevelInfo SessionLogLevel = "info" - // Warning message that may require attention. - SessionLogLevelWarning SessionLogLevel = "warning" -) +// Request ID of a pending `exit_plan_mode.requested` event and the user's response. +// Experimental: UIHandlePendingExitPlanModeRequest is part of an experimental API and may +// change or be removed. +type UIHandlePendingExitPlanModeRequest struct { + // The unique request ID from the exit_plan_mode.requested event + RequestID string `json:"requestId"` + // User response for a pending exit-plan-mode request, with approval state, selected action, + // auto-approve flag, and feedback. + Response UIExitPlanModeResponse `json:"response"` +} -// The session mode the agent is operating in -// Experimental: SessionMode is part of an experimental API and may change or be removed. -type SessionMode string +// Indicates whether the pending UI request was resolved by this call. +// Experimental: UIHandlePendingResult is part of an experimental API and may change or be +// removed. +type UIHandlePendingResult struct { + // True if the request was still pending and was resolved by this call. False if the request + // ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise + // no longer pending. + Success bool `json:"success"` +} -const ( - // The agent is working autonomously toward task completion. - SessionModeAutopilot SessionMode = "autopilot" - // The agent is responding interactively to the user. - SessionModeInteractive SessionMode = "interactive" - // The agent is preparing a plan before making changes. - SessionModePlan SessionMode = "plan" -) +// Request ID of a pending `sampling.requested` event and an optional sampling result +// payload (omit to reject). +// Experimental: UIHandlePendingSamplingRequest is part of an experimental API and may +// change or be removed. +type UIHandlePendingSamplingRequest struct { + // The unique request ID from the sampling.requested event + RequestID string `json:"requestId"` + // Optional sampling result payload. Omit to reject/cancel the sampling request without + // providing a result. + Response *UIHandlePendingSamplingResponse `json:"response,omitempty"` +} -// Hosting platform type of the repository -// Experimental: SessionWorkingDirectoryContextHostType is part of an experimental API and -// may change or be removed. -type SessionWorkingDirectoryContextHostType string +// Optional sampling result payload. Omit to reject/cancel the sampling request without +// providing a result. +// Experimental: UIHandlePendingSamplingResponse is part of an experimental API and may +// change or be removed. +type UIHandlePendingSamplingResponse struct { +} -const ( - // The working directory repository is hosted on Azure DevOps. - SessionWorkingDirectoryContextHostTypeAdo SessionWorkingDirectoryContextHostType = "ado" - // The working directory repository is hosted on GitHub. - SessionWorkingDirectoryContextHostTypeGithub SessionWorkingDirectoryContextHostType = "github" -) +// Request ID of a pending `session_limits_exhausted.requested` event and the user's +// selected limit action. +// Experimental: UIHandlePendingSessionLimitsExhaustedRequest is part of an experimental API +// and may change or be removed. +type UIHandlePendingSessionLimitsExhaustedRequest struct { + // The unique request ID from the session_limits_exhausted.requested event + RequestID string `json:"requestId"` + // The selected session-limit action. + Response UISessionLimitsExhaustedResponse `json:"response"` +} -// Signal to send (default: SIGTERM) -// Experimental: ShellKillSignal is part of an experimental API and may change or be removed. -type ShellKillSignal string +// Request ID of a pending `user_input.requested` event and the user's response. +// Experimental: UIHandlePendingUserInputRequest is part of an experimental API and may +// change or be removed. +type UIHandlePendingUserInputRequest struct { + // The unique request ID from the user_input.requested event + RequestID string `json:"requestId"` + // User response for a pending user-input request, with answer text and whether it was typed + // freeform. + Response UIUserInputResponse `json:"response"` +} -const ( - // Send an interrupt signal to the process. - ShellKillSignalSIGINT ShellKillSignal = "SIGINT" - // Forcefully terminate the process. - ShellKillSignalSIGKILL ShellKillSignal = "SIGKILL" - // Request graceful process termination. - ShellKillSignalSIGTERM ShellKillSignal = "SIGTERM" -) +// Register an in-process handler for `auto_mode_switch.requested` events. The caller still +// attaches the actual listener via the standard event-subscription mechanism; this +// registration solely tells the server bridge to skip its own dispatch (so a remote client +// doesn't race the in-process handler for the same requestId). +// Experimental: UIRegisterDirectAutoModeSwitchHandlerResult is part of an experimental API +// and may change or be removed. +type UIRegisterDirectAutoModeSwitchHandlerResult struct { + // Opaque handle representing the registration. Pass this same handle to + // `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. + // Multiple registrations are reference-counted; the server bridge will only dispatch + // auto-mode-switch requests when no handles are active. + Handle string `json:"handle"` +} -// Why the session is being shut down. Defaults to "routine" when omitted. -// Experimental: ShutdownType is part of an experimental API and may change or be removed. -type ShutdownType string +// The user's selected action for an exhausted session limit. +// Experimental: UISessionLimitsExhaustedResponse is part of an experimental API and may +// change or be removed. +type UISessionLimitsExhaustedResponse struct { + // Action selected by the user. + Action UISessionLimitsExhaustedResponseAction `json:"action"` + // AI Credits to add to the current max when action is 'add'. + AdditionalAiCredits *float64 `json:"additionalAiCredits,omitempty"` + // New absolute max AI Credits when action is 'set'. + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` +} -const ( - // The session is shutting down because of an error. - ShutdownTypeError ShutdownType = "error" - // The session is shutting down normally. - ShutdownTypeRoutine ShutdownType = "routine" -) +// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +// Experimental: UIUnregisterDirectAutoModeSwitchHandlerRequest is part of an experimental +// API and may change or be removed. +type UIUnregisterDirectAutoModeSwitchHandlerRequest struct { + // Handle previously returned by `registerDirectAutoModeSwitchHandler` + Handle string `json:"handle"` +} -// Source location type (e.g., project, personal-copilot, plugin, builtin) -type SkillSource string +// Indicates whether the handle was active and the registration count was decremented. +// Experimental: UIUnregisterDirectAutoModeSwitchHandlerResult is part of an experimental +// API and may change or be removed. +type UIUnregisterDirectAutoModeSwitchHandlerResult struct { + // True if the handle was active and decremented the counter; false if the handle was + // unknown. + Unregistered bool `json:"unregistered"` +} -const ( - // Skill bundled with the runtime. - SkillSourceBuiltin SkillSource = "builtin" - // Skill loaded from a configured custom skill directory. - SkillSourceCustom SkillSource = "custom" - // Skill discovered from a parent directory in the current workspace tree. - SkillSourceInherited SkillSource = "inherited" - // Skill defined in the user's personal agents skill directory. - SkillSourcePersonalAgents SkillSource = "personal-agents" - // Skill defined in the user's Copilot skill directory. - SkillSourcePersonalCopilot SkillSource = "personal-copilot" - // Skill provided by an installed plugin. - SkillSourcePlugin SkillSource = "plugin" - // Skill defined in the current project's skill directories. - SkillSourceProject SkillSource = "project" -) +// User response for a pending user-input request, with answer text and whether it was typed +// freeform. +// Experimental: UIUserInputResponse is part of an experimental API and may change or be +// removed. +type UIUserInputResponse struct { + // The user's answer text + Answer string `json:"answer"` + // True if the user typed a freeform response, false if they selected a presented choice. + // Used by telemetry to differentiate between free text input and choice selection. + WasFreeform bool `json:"wasFreeform"` +} -// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) -// Experimental: SlashCommandInputCompletion is part of an experimental API and may change +// Subagent settings to apply to the current session +// Experimental: UpdateSubagentSettingsRequest is part of an experimental API and may change // or be removed. -type SlashCommandInputCompletion string - -const ( - // Input should complete filesystem directories. - SlashCommandInputCompletionDirectory SlashCommandInputCompletion = "directory" -) - -// Kind discriminator for SlashCommandInvocationResult. -type SlashCommandInvocationResultKind string - -const ( - SlashCommandInvocationResultKindAgentPrompt SlashCommandInvocationResultKind = "agent-prompt" - SlashCommandInvocationResultKindCompleted SlashCommandInvocationResultKind = "completed" - SlashCommandInvocationResultKindSelectSubcommand SlashCommandInvocationResultKind = "select-subcommand" - SlashCommandInvocationResultKindText SlashCommandInvocationResultKind = "text" -) +type UpdateSubagentSettingsRequest struct { + // Subagent settings to apply, or null to clear the live session override + Subagents *SubagentSettings `json:"subagents,omitempty"` +} -// Coarse command category for grouping and behavior: runtime built-in, skill-backed -// command, or SDK/client-owned command -// Experimental: SlashCommandKind is part of an experimental API and may change or be +// Accumulated session usage metrics, including premium request cost, token counts, model +// breakdown, and code-change totals. +// Experimental: UsageGetMetricsResult is part of an experimental API and may change or be // removed. -type SlashCommandKind string - -const ( - // Command implemented by the runtime. - SlashCommandKindBuiltin SlashCommandKind = "builtin" - // Command registered by an SDK client or extension. - SlashCommandKindClient SlashCommandKind = "client" - // Command backed by a skill. - SlashCommandKindSkill SlashCommandKind = "skill" -) +type UsageGetMetricsResult struct { + // Aggregated code change metrics + CodeChanges UsageMetricsCodeChanges `json:"codeChanges"` + // Currently active model identifier + CurrentModel *string `json:"currentModel,omitempty"` + // Input tokens from the most recent main-agent API call + LastCallInputTokens int64 `json:"lastCallInputTokens"` + // Output tokens from the most recent main-agent API call + LastCallOutputTokens int64 `json:"lastCallOutputTokens"` + // Per-model token and request metrics, keyed by model identifier + ModelMetrics map[string]UsageMetricsModelMetric `json:"modelMetrics"` + // ISO 8601 timestamp when the session started + SessionStartTime time.Time `json:"sessionStartTime"` + // Session-wide per-token-type accumulated token counts + TokenDetails map[string]UsageMetricsTokenDetail `json:"tokenDetails,omitzero"` + // Total time spent in model API calls (milliseconds) + TotalAPIDurationMs int64 `json:"totalApiDurationMs"` + // Session-wide accumulated nano-AI units cost + TotalNanoAiu *float64 `json:"totalNanoAiu,omitempty"` + // Total user-initiated premium request cost across all models (may be fractional due to + // multipliers) + TotalPremiumRequestCost float64 `json:"totalPremiumRequestCost"` + // Raw count of user-initiated API requests + TotalUserRequests int64 `json:"totalUserRequests"` +} -// Whether task execution is synchronously awaited or managed in the background -// Experimental: TaskExecutionMode is part of an experimental API and may change or be +// Aggregated code change metrics +// Experimental: UsageMetricsCodeChanges is part of an experimental API and may change or be // removed. -type TaskExecutionMode string - -const ( - // The task is managed in the background. - TaskExecutionModeBackground TaskExecutionMode = "background" - // The task was started with synchronous waiting. - TaskExecutionModeSync TaskExecutionMode = "sync" -) - -// Type discriminator for TaskInfo. -type TaskInfoType string +type UsageMetricsCodeChanges struct { + // Distinct file paths modified during the session + FilesModified []string `json:"filesModified"` + // Number of distinct files modified + FilesModifiedCount int64 `json:"filesModifiedCount"` + // Total lines of code added + LinesAdded int64 `json:"linesAdded"` + // Total lines of code removed + LinesRemoved int64 `json:"linesRemoved"` +} -const ( - TaskInfoTypeAgent TaskInfoType = "agent" - TaskInfoTypeShell TaskInfoType = "shell" -) +// Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and +// per-token-type details. +// Experimental: UsageMetricsModelMetric is part of an experimental API and may change or be +// removed. +type UsageMetricsModelMetric struct { + // Latest known prompt-cache expiration for this model. A timestamp in the past indicates + // that the observed cache has expired. + CacheExpiresAt *time.Time `json:"cacheExpiresAt,omitempty"` + // Request count and cost metrics for this model + Requests UsageMetricsModelMetricRequests `json:"requests"` + // Token count details per type + TokenDetails map[string]UsageMetricsModelMetricTokenDetail `json:"tokenDetails,omitzero"` + // Accumulated nano-AI units cost for this model + TotalNanoAiu *float64 `json:"totalNanoAiu,omitempty"` + // Token usage metrics for this model + Usage UsageMetricsModelMetricUsage `json:"usage"` +} -// Type discriminator for TaskProgress. -type TaskProgressType string +// Request count and cost metrics for this model +// Experimental: UsageMetricsModelMetricRequests is part of an experimental API and may +// change or be removed. +type UsageMetricsModelMetricRequests struct { + // User-initiated premium request cost (with multiplier applied) + Cost float64 `json:"cost"` + // Number of API requests made with this model + Count int64 `json:"count"` +} -const ( - TaskProgressTypeAgent TaskProgressType = "agent" - TaskProgressTypeShell TaskProgressType = "shell" -) +// Per-model token-detail entry containing the accumulated token count for one token type. +// Experimental: UsageMetricsModelMetricTokenDetail is part of an experimental API and may +// change or be removed. +type UsageMetricsModelMetricTokenDetail struct { + // Accumulated token count for this token type + TokenCount int64 `json:"tokenCount"` +} -// Whether the shell runs inside a managed PTY session or as an independent background -// process -// Experimental: TaskShellInfoAttachmentMode is part of an experimental API and may change +// Token usage metrics for this model +// Experimental: UsageMetricsModelMetricUsage is part of an experimental API and may change // or be removed. -type TaskShellInfoAttachmentMode string +type UsageMetricsModelMetricUsage struct { + // Total tokens read from prompt cache + CacheReadTokens int64 `json:"cacheReadTokens"` + // Total tokens written to prompt cache + CacheWriteTokens int64 `json:"cacheWriteTokens"` + // Total input tokens consumed + InputTokens int64 `json:"inputTokens"` + // Total output tokens produced + OutputTokens int64 `json:"outputTokens"` + // Total output tokens used for reasoning + ReasoningTokens *int64 `json:"reasoningTokens,omitempty"` +} -const ( - // The shell runs in a managed PTY session. - TaskShellInfoAttachmentModeAttached TaskShellInfoAttachmentMode = "attached" - // The shell runs as an independent background process. - TaskShellInfoAttachmentModeDetached TaskShellInfoAttachmentMode = "detached" -) +// Session-wide token-detail entry containing the accumulated token count for one token type. +// Experimental: UsageMetricsTokenDetail is part of an experimental API and may change or be +// removed. +type UsageMetricsTokenDetail struct { + // Accumulated token count for this token type + TokenCount int64 `json:"tokenCount"` +} -// Current lifecycle status of the task -// Experimental: TaskStatus is part of an experimental API and may change or be removed. -type TaskStatus string +// Result of a user-requested shell command. +// Experimental: UserRequestedShellCommandResult is part of an experimental API and may +// change or be removed. +type UserRequestedShellCommandResult struct { + // Error output when the execution failed + Error *string `json:"error,omitempty"` + // Process exit code, when available + ExitCode *int64 `json:"exitCode,omitempty"` + // Captured command output + Output string `json:"output"` + // Whether the command completed successfully + Success bool `json:"success"` + // Tool call id emitted for the shell execution + ToolCallID string `json:"toolCallId"` +} -const ( - // The task was cancelled before completion. - TaskStatusCancelled TaskStatus = "cancelled" - // The task finished successfully. - TaskStatusCompleted TaskStatus = "completed" - // The task finished with an error. - TaskStatusFailed TaskStatus = "failed" - // The task is waiting for additional input. - TaskStatusIdle TaskStatus = "idle" - // The task is actively executing. - TaskStatusRunning TaskStatus = "running" -) +// A single user setting's effective value alongside its default, so consumers can render +// settings left at their default. +// Experimental: UserSettingMetadata is part of an experimental API and may change or be +// removed. +type UserSettingMetadata struct { + // The centrally-known default for this setting (null when no default is registered). + Default any `json:"default"` + // True when the user has not set an explicit value for this setting (i.e. it is left at its + // default). Reflects whether the user has overridden the key, not whether the effective + // value happens to equal the default — a key explicitly set to a value identical to the + // default still reports false. + IsDefault bool `json:"isDefault"` + // The effective value: the user's value if set, otherwise the default. + Value any `json:"value"` +} + +// Per-key metadata for every known user setting (settings.json overlaid with the legacy +// config.json, config.json wins), including settings left at their default. Excludes +// repository- and enterprise-managed overrides. +// Experimental: UserSettingsGetResult is part of an experimental API and may change or be +// removed. +type UserSettingsGetResult struct { + // Every known user setting keyed by setting name, each with its effective value, default, + // and whether it is at the default. + Settings map[string]UserSettingMetadata `json:"settings"` +} -// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist -// as setting), or no (decline). -// Experimental: UIAutoModeSwitchResponse is part of an experimental API and may change or +// Experimental: UserSettingsReloadResult is part of an experimental API and may change or // be removed. -type UIAutoModeSwitchResponse string +type UserSettingsReloadResult struct { +} -const ( - // Decline the automatic mode switch. - UIAutoModeSwitchResponseNo UIAutoModeSwitchResponse = "no" - // Allow the automatic mode switch for this turn. - UIAutoModeSwitchResponseYes UIAutoModeSwitchResponse = "yes" - // Allow this mode switch and persist the preference. - UIAutoModeSwitchResponseYesAlways UIAutoModeSwitchResponse = "yes_always" -) +// Partial user settings to write to settings.json. Each top-level key is written +// individually, replacing the existing value; a key whose value is null is removed. +// Experimental: UserSettingsSetRequest is part of an experimental API and may change or be +// removed. +type UserSettingsSetRequest struct { + // Partial user settings to write, as a free-form object keyed by setting name + Settings any `json:"settings"` +} -// Type discriminator. Always "string". -type UIElicitationArrayEnumFieldItemsType string +// Outcome of writing user settings. +// Experimental: UserSettingsSetResult is part of an experimental API and may change or be +// removed. +type UserSettingsSetResult struct { + // Top-level keys whose write landed in settings.json but is shadowed by a value still + // present in the legacy config.json (config.json wins on read). The write does not take + // effect until the legacy value is removed. + ShadowedKeys []string `json:"shadowedKeys"` +} -const ( - UIElicitationArrayEnumFieldItemsTypeString UIElicitationArrayEnumFieldItemsType = "string" -) +// The approval to add as a session-scoped rule +// Experimental: UserToolSessionApproval is part of an experimental API and may change or be +// removed. +type UserToolSessionApproval interface { + userToolSessionApproval() + Kind() UserToolSessionApprovalKind +} -// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) -// Experimental: UIElicitationResponseAction is part of an experimental API and may change +type RawUserToolSessionApprovalData struct { + Discriminator UserToolSessionApprovalKind + Raw json.RawMessage +} + +func (RawUserToolSessionApprovalData) userToolSessionApproval() {} +func (r RawUserToolSessionApprovalData) Kind() UserToolSessionApprovalKind { + return r.Discriminator +} + +// Session-scoped tool-approval rule for specific shell command identifiers. +// Experimental: UserToolSessionApprovalCommands is part of an experimental API and may +// change or be removed. +type UserToolSessionApprovalCommands struct { + // Command identifiers approved by the user + CommandIdentifiers []string `json:"commandIdentifiers"` +} + +func (UserToolSessionApprovalCommands) userToolSessionApproval() {} +func (UserToolSessionApprovalCommands) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindCommands +} + +// Session-scoped tool-approval rule for a custom tool, keyed by tool name. +// Experimental: UserToolSessionApprovalCustomTool is part of an experimental API and may +// change or be removed. +type UserToolSessionApprovalCustomTool struct { + // Custom tool name + ToolName string `json:"toolName"` +} + +func (UserToolSessionApprovalCustomTool) userToolSessionApproval() {} +func (UserToolSessionApprovalCustomTool) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindCustomTool +} + +// Session-scoped tool-approval rule for extension-management operations, optionally +// narrowed by operation. +// Experimental: UserToolSessionApprovalExtensionManagement is part of an experimental API +// and may change or be removed. +type UserToolSessionApprovalExtensionManagement struct { + // Optional operation identifier + Operation *string `json:"operation,omitempty"` +} + +func (UserToolSessionApprovalExtensionManagement) userToolSessionApproval() {} +func (UserToolSessionApprovalExtensionManagement) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindExtensionManagement +} + +// Session-scoped tool-approval rule for an extension's permission-gated capability access, +// keyed by extension name. +// Experimental: UserToolSessionApprovalExtensionPermissionAccess is part of an experimental +// API and may change or be removed. +type UserToolSessionApprovalExtensionPermissionAccess struct { + // Extension name + ExtensionName string `json:"extensionName"` +} + +func (UserToolSessionApprovalExtensionPermissionAccess) userToolSessionApproval() {} +func (UserToolSessionApprovalExtensionPermissionAccess) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindExtensionPermissionAccess +} + +// Session-scoped factory approval, optionally narrowed by approval key. +// Experimental: UserToolSessionApprovalFactory is part of an experimental API and may +// change or be removed. +type UserToolSessionApprovalFactory struct { + // Optional factory operation name or canonical approval key + ApprovalKey *string `json:"approvalKey,omitempty"` +} + +func (UserToolSessionApprovalFactory) userToolSessionApproval() {} +func (UserToolSessionApprovalFactory) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindFactory +} + +// Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when +// `toolName` is null. +// Experimental: UserToolSessionApprovalMCP is part of an experimental API and may change or +// be removed. +type UserToolSessionApprovalMCP struct { + // MCP server name + ServerName string `json:"serverName"` + // Optional MCP tool name, or null for all tools on the server + ToolName *string `json:"toolName"` +} + +func (UserToolSessionApprovalMCP) userToolSessionApproval() {} +func (UserToolSessionApprovalMCP) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindMCP +} + +// Session-scoped tool-approval rule for writes to long-term memory. +// Experimental: UserToolSessionApprovalMemory is part of an experimental API and may change // or be removed. -type UIElicitationResponseAction string +type UserToolSessionApprovalMemory struct { +} -const ( - // The user submitted the requested form values. - UIElicitationResponseActionAccept UIElicitationResponseAction = "accept" - // The user dismissed the elicitation request. - UIElicitationResponseActionCancel UIElicitationResponseAction = "cancel" - // The user explicitly declined to provide the requested input. - UIElicitationResponseActionDecline UIElicitationResponseAction = "decline" -) +func (UserToolSessionApprovalMemory) userToolSessionApproval() {} +func (UserToolSessionApprovalMemory) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindMemory +} -// Numeric type accepted by the field. -// Experimental: UIElicitationSchemaPropertyNumberType is part of an experimental API and -// may change or be removed. -type UIElicitationSchemaPropertyNumberType string +// Session-scoped tool-approval rule for read-only filesystem operations. +// Experimental: UserToolSessionApprovalRead is part of an experimental API and may change +// or be removed. +type UserToolSessionApprovalRead struct { +} + +func (UserToolSessionApprovalRead) userToolSessionApproval() {} +func (UserToolSessionApprovalRead) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindRead +} + +// Session-scoped tool-approval rule for filesystem write operations. +// Experimental: UserToolSessionApprovalWrite is part of an experimental API and may change +// or be removed. +type UserToolSessionApprovalWrite struct { +} + +func (UserToolSessionApprovalWrite) userToolSessionApproval() {} +func (UserToolSessionApprovalWrite) Kind() UserToolSessionApprovalKind { + return UserToolSessionApprovalKindWrite +} + +// Current sharing status and shareable GitHub URL for a session. +// Experimental: VisibilityGetResult is part of an experimental API and may change or be +// removed. +type VisibilityGetResult struct { + // Shareable GitHub URL for the session. Present when the session is synced and the URL can + // be resolved. + ShareURL *string `json:"shareUrl,omitempty"` + // Current sharing status. Absent when the session is not synced or the status could not be + // retrieved (e.g. the user is not authenticated). + Status *SessionVisibilityStatus `json:"status,omitempty"` + // Whether the session has been synced to Mission Control (i.e. has a GitHub task). When + // false, the session cannot be shared and `status`/`shareUrl` are absent. + Synced bool `json:"synced"` +} + +// Desired sharing status for the session. +// Experimental: VisibilitySetRequest is part of an experimental API and may change or be +// removed. +type VisibilitySetRequest struct { + // Sharing status to apply. "repo" makes the session visible to repository readers; + // "unshared" restricts it to the creator and collaborators. + Status SessionVisibilityStatus `json:"status"` +} + +// Effective sharing status and shareable GitHub URL after updating session visibility. +// Experimental: VisibilitySetResult is part of an experimental API and may change or be +// removed. +type VisibilitySetResult struct { + // Shareable GitHub URL for the session. Present when the session is synced and the URL can + // be resolved. + ShareURL *string `json:"shareUrl,omitempty"` + // Effective sharing status after the update. May differ from the requested status for task + // types that are already visible to repository readers by default. Absent when the update + // could not be applied (e.g. the session is not synced or the user is not authenticated). + Status *SessionVisibilityStatus `json:"status,omitempty"` + // Whether the session has been synced to Mission Control (i.e. has a GitHub task). When + // false, the visibility change could not be applied and `status`/`shareUrl` are absent. + Synced bool `json:"synced"` +} + +// A single changed file and its unified diff. +// Experimental: WorkspaceDiffFileChange is part of an experimental API and may change or be +// removed. +type WorkspaceDiffFileChange struct { + // Type of change represented by this file diff. + ChangeType WorkspaceDiffFileChangeType `json:"changeType"` + // Unified diff content for the file. Empty when the diff was truncated. + Diff string `json:"diff"` + // Whether the diff content was omitted because it exceeded the per-file size limit. + IsTruncated *bool `json:"isTruncated,omitempty"` + // Original file path for renamed files. + OldPath *string `json:"oldPath,omitempty"` + // Path to the changed file, relative to the workspace root when the file lives under it. A + // file changed outside the workspace root keeps a `../`-relative path, or an absolute path + // when no relative path exists (for example a different Windows drive). + Path string `json:"path"` +} + +// Workspace diff result for the requested mode. +// Experimental: WorkspaceDiffResult is part of an experimental API and may change or be +// removed. +type WorkspaceDiffResult struct { + // Default branch used for a branch diff, when branch mode was requested. + BaseBranch *string `json:"baseBranch,omitempty"` + // Changed files and their unified diffs. + Changes []WorkspaceDiffFileChange `json:"changes"` + // Whether the requested diff fell back to unstaged changes, either because branch diff + // failed or session diff was unavailable. + IsFallback bool `json:"isFallback"` + // Effective mode used for the returned changes. + Mode WorkspaceDiffMode `json:"mode"` + // Diff mode requested by the client. + RequestedMode WorkspaceDiffMode `json:"requestedMode"` + // Why the session diff could not be produced, when applicable. Set only when `session` mode + // was requested and `isFallback` is true, so a client can tell the permanent + // `file-change-tracking-disabled` apart from the transient `session-busy`, which the same + // request answers once the session settles. Never set for `unstaged` or `branch` mode, and + // never `unsupported-remote-session`: a remote session's captures live on its own host, so + // a `session`-mode diff is rejected for one rather than answered with a controller-side + // fallback. + UnavailableReason *HistoryRewindUnavailableReason `json:"unavailableReason,omitempty"` +} + +// Compaction summary checkpoint to persist. +// Experimental: WorkspacesAddSummaryRequest is part of an experimental API and may change +// or be removed. +type WorkspacesAddSummaryRequest struct { + // Markdown summary content to persist. + Content string `json:"content"` + // Summary title shown in checkpoint listings. + Title string `json:"title"` +} + +// Persisted summary metadata and refreshed workspace metadata. +// Experimental: WorkspacesAddSummaryResult is part of an experimental API and may change or +// be removed. +type WorkspacesAddSummaryResult struct { + Summary any `json:"summary,omitempty"` + Workspace any `json:"workspace,omitempty"` +} + +// Whether the autopilot objective file exists. +// Experimental: WorkspacesAutopilotObjectiveExistsResult is part of an experimental API and +// may change or be removed. +type WorkspacesAutopilotObjectiveExistsResult struct { + // True when the objective file exists. + Exists bool `json:"exists"` +} + +// Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint +// filename. +// Experimental: WorkspacesCheckpoints is part of an experimental API and may change or be +// removed. +type WorkspacesCheckpoints struct { + // Filename of the checkpoint within the workspace checkpoints directory + Filename string `json:"filename"` + // Checkpoint number assigned by the workspace manager + Number int64 `json:"number"` + // Human-readable checkpoint title + Title string `json:"title"` +} + +// Relative path and UTF-8 content for the workspace file to create or overwrite. +// Experimental: WorkspacesCreateFileRequest is part of an experimental API and may change +// or be removed. +type WorkspacesCreateFileRequest struct { + // File content to write as a UTF-8 string + Content string `json:"content"` + // Relative path within the workspace files directory + Path string `json:"path"` +} + +// Result of deleting the autopilot objective file. +// Experimental: WorkspacesDeleteAutopilotObjectiveResult is part of an experimental API and +// may change or be removed. +type WorkspacesDeleteAutopilotObjectiveResult struct { + // True when a file was deleted. + Deleted bool `json:"deleted"` +} + +// Parameters for computing a workspace diff. +// Experimental: WorkspacesDiffRequest is part of an experimental API and may change or be +// removed. +type WorkspacesDiffRequest struct { + // When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. + IgnoreWhitespace *bool `json:"ignoreWhitespace,omitempty"` + // Diff mode requested by the client. + Mode WorkspaceDiffMode `json:"mode"` +} + +// Optional session context used when creating a local workspace. +// Experimental: WorkspacesEnsureRequest is part of an experimental API and may change or be +// removed. +type WorkspacesEnsureRequest struct { + // Opaque workspace context supplied by the session host. + Context any `json:"context,omitempty"` +} + +// Current workspace metadata for the session, including its absolute filesystem path when +// available. +// Experimental: WorkspacesGetWorkspaceResult is part of an experimental API and may change +// or be removed. +type WorkspacesGetWorkspaceResult struct { + // Absolute filesystem path to the workspace directory. Omitted when the session has no + // workspace (e.g. remote sessions). + Path *string `json:"path,omitempty"` + // Current workspace metadata, or null if not available + Workspace *WorkspacesGetWorkspaceResultWorkspace `json:"workspace"` +} + +type WorkspacesGetWorkspaceResultWorkspace struct { + Branch *string `json:"branch,omitempty"` + ChronicleSyncDismissed *bool `json:"chronicle_sync_dismissed,omitempty"` + ClientName *string `json:"client_name,omitempty"` + CreatedAt *time.Time `json:"created_at,omitempty"` + Cwd *string `json:"cwd,omitempty"` + GitRoot *string `json:"git_root,omitempty"` + // Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + HostType *WorkspacesWorkspaceDetailsHostType `json:"host_type,omitempty"` + ID string `json:"id"` + McLastEventID *string `json:"mc_last_event_id,omitempty"` + McSessionID *string `json:"mc_session_id,omitempty"` + McTaskID *string `json:"mc_task_id,omitempty"` + Name *string `json:"name,omitempty"` + RemoteSteerable *bool `json:"remote_steerable,omitempty"` + Repository *string `json:"repository,omitempty"` + SummaryCount *int64 `json:"summary_count,omitempty"` + UpdatedAt *time.Time `json:"updated_at,omitempty"` + UserNamed *bool `json:"user_named,omitempty"` +} + +// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +// Experimental: WorkspacesListCheckpointsResult is part of an experimental API and may +// change or be removed. +type WorkspacesListCheckpointsResult struct { + // Workspace checkpoints in chronological order. Empty when workspace is not enabled. + Checkpoints []WorkspacesCheckpoints `json:"checkpoints"` +} + +// Relative paths of files stored in the session workspace files directory. +// Experimental: WorkspacesListFilesResult is part of an experimental API and may change or +// be removed. +type WorkspacesListFilesResult struct { + // Relative file paths in the workspace files directory + Files []string `json:"files"` +} + +// Autopilot objective file content, or null when missing. +// Experimental: WorkspacesReadAutopilotObjectiveResult is part of an experimental API and +// may change or be removed. +type WorkspacesReadAutopilotObjectiveResult struct { + // Autopilot objective file content, or null when missing. + Content *string `json:"content"` +} + +// Checkpoint number to read. +// Experimental: WorkspacesReadCheckpointRequest is part of an experimental API and may +// change or be removed. +type WorkspacesReadCheckpointRequest struct { + // Checkpoint number to read + Number int64 `json:"number"` +} + +// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +// Experimental: WorkspacesReadCheckpointResult is part of an experimental API and may +// change or be removed. +type WorkspacesReadCheckpointResult struct { + // Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing + Content *string `json:"content"` +} + +// Relative path of the workspace file to read. +// Experimental: WorkspacesReadFileRequest is part of an experimental API and may change or +// be removed. +type WorkspacesReadFileRequest struct { + // Relative path within the workspace files directory + Path string `json:"path"` +} + +// Contents of the requested workspace file as a UTF-8 string. +// Experimental: WorkspacesReadFileResult is part of an experimental API and may change or +// be removed. +type WorkspacesReadFileResult struct { + // File content as a UTF-8 string + Content string `json:"content"` +} + +// Pasted content to save as a UTF-8 file in the session workspace. +// Experimental: WorkspacesSaveLargePasteRequest is part of an experimental API and may +// change or be removed. +type WorkspacesSaveLargePasteRequest struct { + // Pasted content to save as a UTF-8 file + Content string `json:"content"` +} + +// Descriptor for the saved paste file, or null when the workspace is unavailable. +// Experimental: WorkspacesSaveLargePasteResult is part of an experimental API and may +// change or be removed. +type WorkspacesSaveLargePasteResult struct { + // Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, + // non-infinite sessions, remote sessions) + Saved *WorkspacesSaveLargePasteResultSaved `json:"saved"` +} + +type WorkspacesSaveLargePasteResultSaved struct { + // Filename within the workspace files directory + Filename string `json:"filename"` + // Absolute filesystem path to the saved paste file + FilePath string `json:"filePath"` + // Size of the saved file in bytes + SizeBytes int64 `json:"sizeBytes"` +} + +// Rollback point for local workspace summaries. +// Experimental: WorkspacesTruncateSummariesRequest is part of an experimental API and may +// change or be removed. +type WorkspacesTruncateSummariesRequest struct { + // Number of newest summaries to keep. + KeepCount int64 `json:"keepCount"` +} + +// Public-facing projection of workspace metadata for SDK / TUI consumers +// Experimental: WorkspaceSummary is part of an experimental API and may change or be +// removed. +type WorkspaceSummary struct { + // Branch checked out at session start, if any + Branch *string `json:"branch,omitempty"` + // ISO 8601 timestamp when the workspace was created + CreatedAt *time.Time `json:"created_at,omitempty"` + // Current working directory at session start + Cwd *string `json:"cwd,omitempty"` + // Resolved git root for cwd, if any + GitRoot *string `json:"git_root,omitempty"` + // Repository host type, if known + HostType *WorkspaceSummaryHostType `json:"host_type,omitempty"` + // Workspace identifier (1:1 with sessionId) + ID string `json:"id"` + // Display name for the session, if set + Name *string `json:"name,omitempty"` + // Repository identifier in 'owner/repo' or 'org/project/repo' format, if any + Repository *string `json:"repository,omitempty"` + // ISO 8601 timestamp when the workspace was last updated + UpdatedAt *time.Time `json:"updated_at,omitempty"` + // Whether the display name was explicitly set by the user + UserNamed *bool `json:"user_named,omitempty"` +} + +// Workspace metadata fields to update. +// Experimental: WorkspacesUpdateMetadataRequest is part of an experimental API and may +// change or be removed. +type WorkspacesUpdateMetadataRequest struct { + // Opaque workspace context supplied by the session host. + Context any `json:"context,omitempty"` + // Optional workspace display name override. + Name *string `json:"name,omitempty"` +} + +// Autopilot objective file content to persist. +// Experimental: WorkspacesWriteAutopilotObjectiveRequest is part of an experimental API and +// may change or be removed. +type WorkspacesWriteAutopilotObjectiveRequest struct { + // Autopilot objective file content. + Content string `json:"content"` +} + +// Result of writing the autopilot objective file. +// Experimental: WorkspacesWriteAutopilotObjectiveResult is part of an experimental API and +// may change or be removed. +type WorkspacesWriteAutopilotObjectiveResult struct { + // Filesystem operation performed. + Operation string `json:"operation"` +} + +// Finite reason code describing why the current turn was aborted +// Experimental: AbortReason is part of an experimental API and may change or be removed. +type AbortReason string + +const ( + // Autopilot stopped the run because the active objective reached its user-set + // --max-ai-credits limit. + AbortReasonAutopilotCreditLimit AbortReason = "autopilot_credit_limit" + // A remote command requested the abort. + AbortReasonRemoteCommand AbortReason = "remote_command" + // An MCP server delivered a user.abort notification. + AbortReasonUserAbort AbortReason = "user_abort" + // The local user requested the abort, for example by pressing Ctrl+C in the CLI. + AbortReasonUserInitiated AbortReason = "user_initiated" +) + +// Resolved Anthropic adaptive-thinking capability for a model. +// Experimental: AdaptiveThinkingSupport is part of an experimental API and may change or be +// removed. +type AdaptiveThinkingSupport string + +const ( + // The model accepts adaptive thinking but also accepts thinking.type='enabled' + AdaptiveThinkingSupportOptional AdaptiveThinkingSupport = "optional" + // The model only accepts adaptive thinking and rejects thinking.type='enabled' with HTTP + // 400 (e.g. opus-4.7/4.8) + AdaptiveThinkingSupportRequired AdaptiveThinkingSupport = "required" + // The model does not accept thinking.type='adaptive' + AdaptiveThinkingSupportUnsupported AdaptiveThinkingSupport = "unsupported" +) + +// Which tier this directory belongs to +// Experimental: AgentDiscoveryPathScope is part of an experimental API and may change or be +// removed. +type AgentDiscoveryPathScope string + +const ( + // A project's repository agent directory. + AgentDiscoveryPathScopeProject AgentDiscoveryPathScope = "project" + // The user's personal agent configuration directory. + AgentDiscoveryPathScopeUser AgentDiscoveryPathScope = "user" +) + +// Where the agent definition was loaded from +// Experimental: AgentInfoSource is part of an experimental API and may change or be removed. +type AgentInfoSource string + +const ( + // Agent built into the Copilot runtime. + AgentInfoSourceBuiltin AgentInfoSource = "builtin" + // Agent inherited from a parent project or workspace. + AgentInfoSourceInherited AgentInfoSource = "inherited" + // Agent contributed by an installed plugin. + AgentInfoSourcePlugin AgentInfoSource = "plugin" + // Agent loaded from the current project's repository configuration. + AgentInfoSourceProject AgentInfoSource = "project" + // Agent provided by a remote runtime or service. + AgentInfoSourceRemote AgentInfoSource = "remote" + // Agent loaded from the user's personal agent configuration. + AgentInfoSourceUser AgentInfoSource = "user" +) + +// Kind of attention required when status === "attention". Meaningful only when status === +// "attention". +// Experimental: AgentRegistryLiveTargetEntryAttentionKind is part of an experimental API +// and may change or be removed. +type AgentRegistryLiveTargetEntryAttentionKind string + +const ( + // Session is waiting on an elicitation prompt + AgentRegistryLiveTargetEntryAttentionKindElicitation AgentRegistryLiveTargetEntryAttentionKind = "elicitation" + // Session is blocked on an unrecoverable error + AgentRegistryLiveTargetEntryAttentionKindError AgentRegistryLiveTargetEntryAttentionKind = "error" + // Session is waiting for the user to approve or reject a plan + AgentRegistryLiveTargetEntryAttentionKindExitPlan AgentRegistryLiveTargetEntryAttentionKind = "exit_plan" + // Session is waiting for a tool-permission decision + AgentRegistryLiveTargetEntryAttentionKindPermission AgentRegistryLiveTargetEntryAttentionKind = "permission" + // Session is waiting for free-form user input + AgentRegistryLiveTargetEntryAttentionKindUserInput AgentRegistryLiveTargetEntryAttentionKind = "user_input" +) + +// Process kind tag for the registry entry +// Experimental: AgentRegistryLiveTargetEntryKind is part of an experimental API and may +// change or be removed. +type AgentRegistryLiveTargetEntryKind string + +const ( + // Headless `--server --managed-server` child spawned by a controller + AgentRegistryLiveTargetEntryKindManagedServer AgentRegistryLiveTargetEntryKind = "managed-server" + // Interactive Copilot CLI exposing a UI server (legacy/normal CLI process) + AgentRegistryLiveTargetEntryKindUIServer AgentRegistryLiveTargetEntryKind = "ui-server" +) + +// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done +// from done_cancelled. +// Experimental: AgentRegistryLiveTargetEntryLastTerminalEvent is part of an experimental +// API and may change or be removed. +type AgentRegistryLiveTargetEntryLastTerminalEvent string + +const ( + // Last turn was aborted (e.g. user interrupted) + AgentRegistryLiveTargetEntryLastTerminalEventAbort AgentRegistryLiveTargetEntryLastTerminalEvent = "abort" + // Last turn ended cleanly (model returned a final assistant message) + AgentRegistryLiveTargetEntryLastTerminalEventTurnEnd AgentRegistryLiveTargetEntryLastTerminalEvent = "turn_end" +) + +// Coarse lifecycle status of the foreground session +// Experimental: AgentRegistryLiveTargetEntryStatus is part of an experimental API and may +// change or be removed. +type AgentRegistryLiveTargetEntryStatus string + +const ( + // Session needs user attention (see attentionKind for the specific reason) + AgentRegistryLiveTargetEntryStatusAttention AgentRegistryLiveTargetEntryStatus = "attention" + // Last turn completed successfully + AgentRegistryLiveTargetEntryStatusDone AgentRegistryLiveTargetEntryStatus = "done" + // Session is idle, waiting for input + AgentRegistryLiveTargetEntryStatusWaiting AgentRegistryLiveTargetEntryStatus = "waiting" + // Session is actively processing a turn + AgentRegistryLiveTargetEntryStatusWorking AgentRegistryLiveTargetEntryStatus = "working" +) + +// Categorized reason for log-open failure +// Experimental: AgentRegistryLogCaptureOpenErrorReason is part of an experimental API and +// may change or be removed. +type AgentRegistryLogCaptureOpenErrorReason string + +const ( + // No space left on device + AgentRegistryLogCaptureOpenErrorReasonDiskFull AgentRegistryLogCaptureOpenErrorReason = "disk_full" + // Other / uncategorized open failure + AgentRegistryLogCaptureOpenErrorReasonOther AgentRegistryLogCaptureOpenErrorReason = "other" + // Filesystem permission denied opening the log file + AgentRegistryLogCaptureOpenErrorReasonPermission AgentRegistryLogCaptureOpenErrorReason = "permission" +) + +// Permission posture for the new session. 'yolo' requires the controller-local session to +// currently be in allow-all mode. +// Experimental: AgentRegistrySpawnPermissionMode is part of an experimental API and may +// change or be removed. +type AgentRegistrySpawnPermissionMode string + +const ( + // Standard permission posture (prompts for each request) + AgentRegistrySpawnPermissionModeDefault AgentRegistrySpawnPermissionMode = "default" + // Full allow-all (requires the controller-local session to currently be in allow-all mode) + AgentRegistrySpawnPermissionModeYolo AgentRegistrySpawnPermissionMode = "yolo" +) + +// Kind discriminator for AgentRegistrySpawnResult. +type AgentRegistrySpawnResultKind string + +const ( + AgentRegistrySpawnResultKindRegistryTimeout AgentRegistrySpawnResultKind = "registry-timeout" + AgentRegistrySpawnResultKindSpawned AgentRegistrySpawnResultKind = "spawned" + AgentRegistrySpawnResultKindSpawnError AgentRegistrySpawnResultKind = "spawn-error" + AgentRegistrySpawnResultKindValidationError AgentRegistrySpawnResultKind = "validation-error" +) + +// Which parameter field was invalid. Omitted when the rejection is not field-specific. +// Experimental: AgentRegistrySpawnValidationErrorField is part of an experimental API and +// may change or be removed. +type AgentRegistrySpawnValidationErrorField string + +const ( + // The agentName parameter + AgentRegistrySpawnValidationErrorFieldAgentName AgentRegistrySpawnValidationErrorField = "agentName" + // The cwd parameter + AgentRegistrySpawnValidationErrorFieldCwd AgentRegistrySpawnValidationErrorField = "cwd" + // The model parameter + AgentRegistrySpawnValidationErrorFieldModel AgentRegistrySpawnValidationErrorField = "model" + // The session name parameter + AgentRegistrySpawnValidationErrorFieldName AgentRegistrySpawnValidationErrorField = "name" + // The permissionMode parameter + AgentRegistrySpawnValidationErrorFieldPermissionMode AgentRegistrySpawnValidationErrorField = "permissionMode" +) + +// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by +// reason without leaking raw paths or agent/model names. +// Experimental: AgentRegistrySpawnValidationErrorReason is part of an experimental API and +// may change or be removed. +type AgentRegistrySpawnValidationErrorReason string + +const ( + // Provided cwd exists but is not a directory + AgentRegistrySpawnValidationErrorReasonCwdNotDirectory AgentRegistrySpawnValidationErrorReason = "cwd-not-directory" + // Provided cwd does not exist on disk + AgentRegistrySpawnValidationErrorReasonCwdNotFound AgentRegistrySpawnValidationErrorReason = "cwd-not-found" + // Session name failed validateSessionName + AgentRegistrySpawnValidationErrorReasonInvalidName AgentRegistrySpawnValidationErrorReason = "invalid-name" + // Requested agent name was not found in builtin or custom agents + AgentRegistrySpawnValidationErrorReasonUnknownAgent AgentRegistrySpawnValidationErrorReason = "unknown-agent" + // Requested model is not available to this session + AgentRegistrySpawnValidationErrorReasonUnknownModel AgentRegistrySpawnValidationErrorReason = "unknown-model" + // Caller asked for permissionMode='yolo' but the controller is not currently in allow-all + // mode + AgentRegistrySpawnValidationErrorReasonYoloNotAllowed AgentRegistrySpawnValidationErrorReason = "yolo-not-allowed" +) + +// Type of GitHub reference +// Experimental: AttachmentGitHubReferenceType is part of an experimental API and may change +// or be removed. +type AttachmentGitHubReferenceType string + +const ( + // GitHub discussion reference. + AttachmentGitHubReferenceTypeDiscussion AttachmentGitHubReferenceType = "discussion" + // GitHub issue reference. + AttachmentGitHubReferenceTypeIssue AttachmentGitHubReferenceType = "issue" + // GitHub pull request reference. + AttachmentGitHubReferenceTypePr AttachmentGitHubReferenceType = "pr" +) + +// Type discriminator for Attachment. +type AttachmentType string + +const ( + AttachmentTypeBlob AttachmentType = "blob" + AttachmentTypeDirectory AttachmentType = "directory" + AttachmentTypeExtensionContext AttachmentType = "extension_context" + AttachmentTypeFile AttachmentType = "file" + AttachmentTypeGitHubActionsJob AttachmentType = "github_actions_job" + AttachmentTypeGitHubCommit AttachmentType = "github_commit" + AttachmentTypeGitHubFile AttachmentType = "github_file" + AttachmentTypeGitHubFileDiff AttachmentType = "github_file_diff" + AttachmentTypeGitHubReference AttachmentType = "github_reference" + AttachmentTypeGitHubRelease AttachmentType = "github_release" + AttachmentTypeGitHubRepository AttachmentType = "github_repository" + AttachmentTypeGitHubSnippet AttachmentType = "github_snippet" + AttachmentTypeGitHubTreeComparison AttachmentType = "github_tree_comparison" + AttachmentTypeGitHubURL AttachmentType = "github_url" + AttachmentTypeSelection AttachmentType = "selection" +) + +// Type discriminator for AuthInfo. +// Experimental: AuthInfoType is part of an experimental API and may change or be removed. +type AuthInfoType string + +const ( + AuthInfoTypeAPIKey AuthInfoType = "api-key" + AuthInfoTypeCopilotAPIToken AuthInfoType = "copilot-api-token" + AuthInfoTypeEnv AuthInfoType = "env" + AuthInfoTypeGhCLI AuthInfoType = "gh-cli" + AuthInfoTypeHMAC AuthInfoType = "hmac" + AuthInfoTypeToken AuthInfoType = "token" + AuthInfoTypeUser AuthInfoType = "user" +) + +// Neutral SDK discriminator for the connected remote session kind. +// Experimental: ConnectedRemoteSessionMetadataKind is part of an experimental API and may +// change or be removed. +type ConnectedRemoteSessionMetadataKind string + +const ( + // GitHub Copilot coding agent session. + ConnectedRemoteSessionMetadataKindCodingAgent ConnectedRemoteSessionMetadataKind = "coding-agent" + // Remote CLI session. + ConnectedRemoteSessionMetadataKindRemoteSession ConnectedRemoteSessionMetadataKind = "remote-session" +) + +// Controls how MCP tool result content is filtered: none leaves content unchanged, markdown +// sanitizes HTML while preserving Markdown-friendly output, and hidden_characters removes +// characters that can hide directives. +// Experimental: ContentFilterMode is part of an experimental API and may change or be +// removed. +type ContentFilterMode string + +const ( + // Remove characters that can hide directives. + ContentFilterModeHiddenCharacters ContentFilterMode = "hidden_characters" + // Sanitize HTML while preserving Markdown-friendly output. + ContentFilterModeMarkdown ContentFilterMode = "markdown" + // Leave MCP tool result content unchanged. + ContentFilterModeNone ContentFilterMode = "none" +) + +// Context tier for models that support multiple context-window sizes. +// Experimental: ContextTier is part of an experimental API and may change or be removed. +type ContextTier string + +const ( + // Use the model's default context window. + ContextTierDefault ContextTier = "default" + // Pin the session to the long-context tier when supported. + ContextTierLongContext ContextTier = "long_context" +) + +// Authentication host (always the public GitHub host). +type CopilotAPITokenAuthInfoHost string + +const ( + CopilotAPITokenAuthInfoHostHTTPSGitHubCom CopilotAPITokenAuthInfoHost = "https://github.com" +) + +// Kind discriminator for DebugCollectLogsDestination. +type DebugCollectLogsDestinationKind string + +const ( + DebugCollectLogsDestinationKindArchive DebugCollectLogsDestinationKind = "archive" + DebugCollectLogsDestinationKindDirectory DebugCollectLogsDestinationKind = "directory" +) + +// Kind of caller-provided debug log entry. +// Experimental: DebugCollectLogsEntryKind is part of an experimental API and may change or +// be removed. +type DebugCollectLogsEntryKind string + +const ( + // Include files from a server-local directory recursively. + DebugCollectLogsEntryKindDirectory DebugCollectLogsEntryKind = "directory" + // Include a single server-local file. + DebugCollectLogsEntryKindFile DebugCollectLogsEntryKind = "file" +) + +// How a collected debug entry should be redacted before being staged. +// Experimental: DebugCollectLogsRedaction is part of an experimental API and may change or +// be removed. +type DebugCollectLogsRedaction string + +const ( + // Redact each non-empty line as a session event JSON object, falling back to plain-text + // redaction for malformed lines. + DebugCollectLogsRedactionEventsJsonl DebugCollectLogsRedaction = "events-jsonl" + // Redact the file as plain UTF-8 log text. + DebugCollectLogsRedactionPlainText DebugCollectLogsRedaction = "plain-text" +) + +// Destination kind that was written. +// Experimental: DebugCollectLogsResultKind is part of an experimental API and may change or +// be removed. +type DebugCollectLogsResultKind string + +const ( + // A .tgz archive was written. + DebugCollectLogsResultKindArchive DebugCollectLogsResultKind = "archive" + // A directory containing redacted files was written. + DebugCollectLogsResultKindDirectory DebugCollectLogsResultKind = "directory" +) + +// Source category for a collected debug bundle entry. +// Experimental: DebugCollectLogsSource is part of an experimental API and may change or be +// removed. +type DebugCollectLogsSource string + +const ( + // Caller-provided diagnostic entry. + DebugCollectLogsSourceAdditional DebugCollectLogsSource = "additional" + // Session event log. + DebugCollectLogsSourceEvents DebugCollectLogsSource = "events" + // Process log for the session. + DebugCollectLogsSourceProcessLog DebugCollectLogsSource = "process-log" + // Interactive shell log for the session. + DebugCollectLogsSourceShellLog DebugCollectLogsSource = "shell-log" +) + +// Experimental: DisableBypassPermissionsMode is part of an experimental API and may change +// or be removed. +type DisableBypassPermissionsMode string + +const ( + DisableBypassPermissionsModeDisable DisableBypassPermissionsMode = "disable" +) + +// Effective extension loading and agent-management mode +// Experimental: DiscoveredExtensionMode is part of an experimental API and may change or be +// removed. +type DiscoveredExtensionMode string + +const ( + // Extensions are not loaded. + DiscoveredExtensionModeDisabled DiscoveredExtensionMode = "disabled" + // Extensions are loaded and the agent can create, reload, and manage them. + DiscoveredExtensionModeLoadAndAugment DiscoveredExtensionMode = "load_and_augment" + // Extensions are loaded, but the agent cannot create, reload, or manage them. + DiscoveredExtensionModeLoadOnly DiscoveredExtensionMode = "load_only" +) + +// Persisted extension discovery source +// Experimental: DiscoveredExtensionSource is part of an experimental API and may change or +// be removed. +type DiscoveredExtensionSource string + +const ( + // Extension contributed by an installed plugin. + DiscoveredExtensionSourcePlugin DiscoveredExtensionSource = "plugin" + // Extension discovered from the user's extensions directory. + DiscoveredExtensionSourceUser DiscoveredExtensionSource = "user" +) + +// Server transport type: stdio, http, sse (deprecated), or memory +// Experimental: DiscoveredMCPServerType is part of an experimental API and may change or be +// removed. +type DiscoveredMCPServerType string + +const ( + // Server communicates over streamable HTTP. + DiscoveredMCPServerTypeHTTP DiscoveredMCPServerType = "http" + // Server is backed by an in-memory runtime implementation. + DiscoveredMCPServerTypeMemory DiscoveredMCPServerType = "memory" + // Server communicates over Server-Sent Events (deprecated). + DiscoveredMCPServerTypeSSE DiscoveredMCPServerType = "sse" + // Server communicates over stdio with a local child process. + DiscoveredMCPServerTypeStdio DiscoveredMCPServerType = "stdio" +) + +type EventLogTypesString string + +const ( + EventLogTypesStringValue EventLogTypesString = "*" +) + +// Agent-scope filter: 'primary' returns only main-agent events plus events whose type +// starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns +// events from all agents (matching wildcard-subscription behavior). Default is 'all' to +// preserve wildcard semantics for catch-up callers. +// Experimental: EventsAgentScope is part of an experimental API and may change or be +// removed. +type EventsAgentScope string + +const ( + // Return events from all agents. + EventsAgentScopeAll EventsAgentScope = "all" + // Return main-agent events and typed subagent lifecycle events. + EventsAgentScopePrimary EventsAgentScope = "primary" +) + +// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor +// referred to an event that no longer exists in history (e.g. truncated or compacted away) +// and the read fell back to a boundary of the remaining history (the beginning for a +// forward read, the tail for a backward read). The fallback page is a fresh boundary +// snapshot, not a continuation of the requested cursor, so it may overlap already-rendered +// events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate +// by event id) before continuing from the returned cursor. +// Experimental: EventsCursorStatus is part of an experimental API and may change or be +// removed. +type EventsCursorStatus string + +const ( + // The cursor referred to history that is no longer available. + EventsCursorStatusExpired EventsCursorStatus = "expired" + // The cursor was applied successfully. + EventsCursorStatusOk EventsCursorStatus = "ok" +) + +// Direction to page through the session's persisted event history. 'forward' pages from the +// cursor toward newer events; 'backward' returns the newest window first (tail-first) and +// pages toward older events. Events within a returned batch are always chronological +// (oldest-to-newest), even for a backward read. +// Experimental: EventsReadDirection is part of an experimental API and may change or be +// removed. +type EventsReadDirection string + +const ( + // Tail-first: return the newest events and page toward older events. + EventsReadDirectionBackward EventsReadDirection = "backward" + // Page from the cursor toward newer events (default). + EventsReadDirectionForward EventsReadDirection = "forward" +) + +// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin +// (installed plugin), or session (session-state//extensions/) +// Experimental: ExtensionSource is part of an experimental API and may change or be removed. +type ExtensionSource string + +const ( + // Extension contributed by an installed plugin. + ExtensionSourcePlugin ExtensionSource = "plugin" + // Extension discovered from the current project's .github/extensions directory. + ExtensionSourceProject ExtensionSource = "project" + // Extension discovered from the current session's state directory (loaded only for this + // session). + ExtensionSourceSession ExtensionSource = "session" + // Extension discovered from the user's ~/.copilot/extensions directory. + ExtensionSourceUser ExtensionSource = "user" +) + +// Current status: running, disabled, failed, or starting +// Experimental: ExtensionStatus is part of an experimental API and may change or be removed. +type ExtensionStatus string + +const ( + // The extension is installed but disabled. + ExtensionStatusDisabled ExtensionStatus = "disabled" + // The extension failed to start or crashed. + ExtensionStatusFailed ExtensionStatus = "failed" + // The extension process is running. + ExtensionStatusRunning ExtensionStatus = "running" + // The extension process is starting. + ExtensionStatusStarting ExtensionStatus = "starting" +) + +// Binary result type discriminator. Use "image" for images and "resource" for other binary +// data. +// Experimental: ExternalToolTextResultForLlmBinaryResultsForLlmType is part of an +// experimental API and may change or be removed. +type ExternalToolTextResultForLlmBinaryResultsForLlmType string + +const ( + // Binary image data. + ExternalToolTextResultForLlmBinaryResultsForLlmTypeImage ExternalToolTextResultForLlmBinaryResultsForLlmType = "image" + // Other binary resource data. + ExternalToolTextResultForLlmBinaryResultsForLlmTypeResource ExternalToolTextResultForLlmBinaryResultsForLlmType = "resource" +) + +// Theme variant this icon is intended for +// Experimental: ExternalToolTextResultForLlmContentResourceLinkIconTheme is part of an +// experimental API and may change or be removed. +type ExternalToolTextResultForLlmContentResourceLinkIconTheme string + +const ( + // Icon intended for dark themes. + ExternalToolTextResultForLlmContentResourceLinkIconThemeDark ExternalToolTextResultForLlmContentResourceLinkIconTheme = "dark" + // Icon intended for light themes. + ExternalToolTextResultForLlmContentResourceLinkIconThemeLight ExternalToolTextResultForLlmContentResourceLinkIconTheme = "light" +) + +// Type discriminator for ExternalToolTextResultForLlmContent. +type ExternalToolTextResultForLlmContentType string + +const ( + ExternalToolTextResultForLlmContentTypeAudio ExternalToolTextResultForLlmContentType = "audio" + ExternalToolTextResultForLlmContentTypeImage ExternalToolTextResultForLlmContentType = "image" + ExternalToolTextResultForLlmContentTypeResource ExternalToolTextResultForLlmContentType = "resource" + ExternalToolTextResultForLlmContentTypeResourceLink ExternalToolTextResultForLlmContentType = "resource_link" + ExternalToolTextResultForLlmContentTypeShellExit ExternalToolTextResultForLlmContentType = "shell_exit" + ExternalToolTextResultForLlmContentTypeTerminal ExternalToolTextResultForLlmContentType = "terminal" + ExternalToolTextResultForLlmContentTypeText ExternalToolTextResultForLlmContentType = "text" +) + +// Execution-critical factory storage operation. +// Experimental: FactoryDurableOperation is part of an experimental API and may change or be +// removed. +type FactoryDurableOperation string + +const ( + // Persisting active execution time. + FactoryDurableOperationAddElapsed FactoryDurableOperation = "addElapsed" + // Persisting an idempotent model-usage charge. + FactoryDurableOperationChargeCredit FactoryDurableOperation = "chargeCredit" + // Creating the durable run and declared phases. + FactoryDurableOperationCreateRun FactoryDurableOperation = "createRun" + // Persisting the terminal run envelope. + FactoryDurableOperationFinishRun FactoryDurableOperation = "finishRun" + // Reading a journal entry without treating storage failure as a cache miss. + FactoryDurableOperationJournalGet FactoryDurableOperation = "journalGet" + // Persisting a journal entry before reporting success. + FactoryDurableOperationJournalPut FactoryDurableOperation = "journalPut" + // Persisting the transition to running. + FactoryDurableOperationMarkRunStarted FactoryDurableOperation = "markRunStarted" + // Reading the authoritative AI-credit total. + FactoryDurableOperationReconcileCreditTotal FactoryDurableOperation = "reconcileCreditTotal" + // Rolling back an uncommitted subagent admission. + FactoryDurableOperationReleaseAgent FactoryDurableOperation = "releaseAgent" + // Persisting subagent admission accounting. + FactoryDurableOperationReserveAgent FactoryDurableOperation = "reserveAgent" +) + +// Kind of factory progress line. +// Experimental: FactoryLogLineKind is part of an experimental API and may change or be +// removed. +type FactoryLogLineKind string + +const ( + // A narrator log line. + FactoryLogLineKindLog FactoryLogLineKind = "log" + // A named factory phase marker. + FactoryLogLineKindPhase FactoryLogLineKind = "phase" +) + +// Derived lifecycle state of a factory phase. +// Experimental: FactoryPhaseStatus is part of an experimental API and may change or be +// removed. +type FactoryPhaseStatus string + +const ( + // The phase is currently entered and accumulating active time. + FactoryPhaseStatusActive FactoryPhaseStatus = "active" + // The phase was entered and has since been closed. + FactoryPhaseStatusCompleted FactoryPhaseStatus = "completed" + // The phase has not been entered yet. + FactoryPhaseStatusPending FactoryPhaseStatus = "pending" + // The phase was never entered because a later phase was entered or the run reached a + // terminal state. + FactoryPhaseStatusSkipped FactoryPhaseStatus = "skipped" +) + +// Cumulative resource ceiling that stopped a factory run. +// Experimental: FactoryRunFailureKind is part of an experimental API and may change or be +// removed. +type FactoryRunFailureKind string + +const ( + // The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no + // headroom remained for another subagent. + FactoryRunFailureKindMaxAiCredits FactoryRunFailureKind = "maxAiCredits" + // The run admitted the approved maximum total number of subagents. + FactoryRunFailureKindMaxTotalSubagents FactoryRunFailureKind = "maxTotalSubagents" + // The run reached the approved accumulated active-execution time in seconds. + FactoryRunFailureKindTimeoutSeconds FactoryRunFailureKind = "timeoutSeconds" +) + +// Type discriminator for FactoryRunFailure. +type FactoryRunFailureType string + +const ( + FactoryRunFailureTypeFactoryAccountingIncomplete FactoryRunFailureType = "factory_accounting_incomplete" + FactoryRunFailureTypeFactoryDurableFailure FactoryRunFailureType = "factory_durable_failure" + FactoryRunFailureTypeFactoryLimitReached FactoryRunFailureType = "factory_limit_reached" + FactoryRunFailureTypeFactoryResumeDeclined FactoryRunFailureType = "factory_resume_declined" +) + +// Current or terminal state of a factory run. +// Experimental: FactoryRunStatus is part of an experimental API and may change or be +// removed. +type FactoryRunStatus string + +const ( + // The run was cancelled before completion. + FactoryRunStatusCancelled FactoryRunStatus = "cancelled" + // The run completed successfully. + FactoryRunStatusCompleted FactoryRunStatus = "completed" + // The factory body failed or reached a cumulative resource ceiling. + FactoryRunStatusError FactoryRunStatus = "error" + // The run was interrupted while resource budget remained. + FactoryRunStatusHalted FactoryRunStatus = "halted" + // The run was minted and is awaiting approval. + FactoryRunStatusPending FactoryRunStatus = "pending" + // The run is executing. + FactoryRunStatusRunning FactoryRunStatus = "running" +) + +// What initiated this compaction request, recorded as the `trigger` on the persisted +// `session.compaction_start` / `session.compaction_complete` events. When absent, the +// compaction is persisted without trigger attribution (initiator unknown). +type HistoryCompactRequestTrigger string + +const ( + // User-requested compaction, e.g. the /compact command or a direct history.compact call. + HistoryCompactRequestTriggerManual HistoryCompactRequestTrigger = "manual" + // Compaction requested while switching to a model with a smaller context window. + HistoryCompactRequestTriggerModelSwitch HistoryCompactRequestTrigger = "model_switch" +) + +// Reason a captured file was not restored. +// Experimental: HistoryFileRestoreSkipReason is part of an experimental API and may change +// or be removed. +type HistoryFileRestoreSkipReason string + +const ( + // A faithful preimage was not captured. + HistoryFileRestoreSkipReasonSkippedCapture HistoryFileRestoreSkipReason = "skipped-capture" + // The file changed after Copilot's last captured write. + HistoryFileRestoreSkipReasonUserModified HistoryFileRestoreSkipReason = "user-modified" +) + +// Aggregate file change represented by a rewind preview. +// Experimental: HistoryRewindChangeType is part of an experimental API and may change or be +// removed. +type HistoryRewindChangeType string + +const ( + // The discarded turns created the file. + HistoryRewindChangeTypeCreated HistoryRewindChangeType = "created" + // The discarded turns deleted the file. + HistoryRewindChangeTypeDeleted HistoryRewindChangeType = "deleted" + // The discarded turns modified the file. + HistoryRewindChangeTypeModified HistoryRewindChangeType = "modified" +) + +// Scope of a rewind operation. +// Experimental: HistoryRewindMode is part of an experimental API and may change or be +// removed. +type HistoryRewindMode string + +const ( + // Discard conversation events while leaving files unchanged. + HistoryRewindModeConversation HistoryRewindMode = "conversation" + // Discard conversation events and restore captured files changed by those turns. + HistoryRewindModeConversationAndFiles HistoryRewindMode = "conversation-and-files" +) + +// Outcome of a rewind request. +// Experimental: HistoryRewindOutcome is part of an experimental API and may change or be +// removed. +type HistoryRewindOutcome string + +const ( + // The conversation was rewound (and, in conversation-and-files mode, captured files were + // restored), but persisted checkpoints could not be cleaned up; reachable in either mode. + HistoryRewindOutcomeCheckpointCleanupFailed HistoryRewindOutcome = "checkpoint-cleanup-failed" + // A conversation-and-files rewind was requested for a session that did not enable capture; + // conversation-only rewinds never produce this. + HistoryRewindOutcomeFileChangeTrackingDisabled HistoryRewindOutcome = "file-change-tracking-disabled" + // File restore failed and all applied file changes were rolled back; only + // conversation-and-files rewinds produce this. + HistoryRewindOutcomeFilesRolledBack HistoryRewindOutcome = "files-rolled-back" + // File restore failed and its rollback could not fully restore the pre-rewind state; only + // conversation-and-files rewinds produce this. + HistoryRewindOutcomeRollbackIncomplete HistoryRewindOutcome = "rollback-incomplete" + // The session still has work that may mutate files or history; reachable in either mode. + HistoryRewindOutcomeSessionBusy HistoryRewindOutcome = "session-busy" + // Files and conversation were rewound, but obsolete file snapshots could not be removed; + // only conversation-and-files rewinds produce this. + HistoryRewindOutcomeSnapshotPruneFailed HistoryRewindOutcome = "snapshot-prune-failed" + // The requested rewind completed; reachable in either mode. + HistoryRewindOutcomeSuccess HistoryRewindOutcome = "success" + // Conversation truncation failed. In conversation-and-files mode any files that were + // restored are left in place because conversation history cannot be un-truncated; in + // conversation-only mode no files are restored. Consult restoredFiles for what, if + // anything, was applied. + HistoryRewindOutcomeTruncationFailed HistoryRewindOutcome = "truncation-failed" + // Remote-backed rewind routing is not supported; reachable in either mode. + HistoryRewindOutcomeUnsupportedRemoteSession HistoryRewindOutcome = "unsupported-remote-session" +) + +// Reason a rewind read (rewind points, file-restore preview, or session diff) could not be +// answered from the session's file-change captures. +// Experimental: HistoryRewindUnavailableReason is part of an experimental API and may +// change or be removed. +type HistoryRewindUnavailableReason string + +const ( + // The session did not opt into file-change tracking before its first turn. + HistoryRewindUnavailableReasonFileChangeTrackingDisabled HistoryRewindUnavailableReason = "file-change-tracking-disabled" + // The session still has work that may mutate files or history. Transient: the same request + // succeeds once the session settles, so callers should retry rather than treat it as a + // failure. + HistoryRewindUnavailableReasonSessionBusy HistoryRewindUnavailableReason = "session-busy" + // Remote-backed rewind routing is not supported. + HistoryRewindUnavailableReasonUnsupportedRemoteSession HistoryRewindUnavailableReason = "unsupported-remote-session" +) + +// Authentication host. HMAC auth always targets the public GitHub host. +type HMACAuthInfoHost string + +const ( + HMACAuthInfoHostHTTPSGitHubCom HMACAuthInfoHost = "https://github.com" +) + +// Hook event name dispatched through the SDK callback transport. +// Experimental: HookType is part of an experimental API and may change or be removed. +type HookType string + +const ( + // Runs when the agent stops. + HookTypeAgentStop HookType = "agentStop" + // Runs when the agent encounters an error. + HookTypeErrorOccurred HookType = "errorOccurred" + // Runs when the agent emits a notification. + HookTypeNotification HookType = "notification" + // Runs when the agent requests permission. + HookTypePermissionRequest HookType = "permissionRequest" + // Runs after an agent result is produced. + HookTypePostResult HookType = "postResult" + // Runs after a tool completes successfully. + HookTypePostToolUse HookType = "postToolUse" + // Runs after a tool fails. + HookTypePostToolUseFailure HookType = "postToolUseFailure" + // Runs before conversation context is compacted. + HookTypePreCompact HookType = "preCompact" + // Runs before an MCP tool is invoked. + HookTypePreMCPToolCall HookType = "preMcpToolCall" + // Runs before a pull request description is generated. + HookTypePrePRDescription HookType = "prePRDescription" + // Runs before a tool is invoked. + HookTypePreToolUse HookType = "preToolUse" + // Runs when a session ends. + HookTypeSessionEnd HookType = "sessionEnd" + // Runs when a session starts. + HookTypeSessionStart HookType = "sessionStart" + // Runs when a subagent starts. + HookTypeSubagentStart HookType = "subagentStart" + // Runs when a subagent stops. + HookTypeSubagentStop HookType = "subagentStop" + // Runs after the user submits a prompt. + HookTypeUserPromptSubmitted HookType = "userPromptSubmitted" + // Runs after the runtime transforms the submitted prompt for the model, before it is added + // to session history. + HookTypeUserPromptTransformed HookType = "userPromptTransformed" +) + +// Constant value. Always "github". +type InstalledPluginSourceGitHubSource string + +const ( + InstalledPluginSourceGitHubSourceGitHub InstalledPluginSourceGitHubSource = "github" +) + +// Constant value. Always "local". +type InstalledPluginSourceLocalSource string + +const ( + InstalledPluginSourceLocalSourceLocal InstalledPluginSourceLocalSource = "local" +) + +// Constant value. Always "url". +type InstalledPluginSourceURLSource string + +const ( + InstalledPluginSourceURLSourceURL InstalledPluginSourceURLSource = "url" +) + +// Whether the target is a single file or a directory of instruction files +// Experimental: InstructionDiscoveryPathKind is part of an experimental API and may change +// or be removed. +type InstructionDiscoveryPathKind string + +const ( + // The target is a directory that holds instruction files. + InstructionDiscoveryPathKindDirectory InstructionDiscoveryPathKind = "directory" + // The target is a single instruction file. + InstructionDiscoveryPathKindFile InstructionDiscoveryPathKind = "file" +) + +// Which tier this target belongs to +// Experimental: InstructionDiscoveryPathLocation is part of an experimental API and may +// change or be removed. +type InstructionDiscoveryPathLocation string + +const ( + // Instructions live in plugin-provided configuration. + InstructionDiscoveryPathLocationPlugin InstructionDiscoveryPathLocation = "plugin" + // Instructions live in repository-level configuration. + InstructionDiscoveryPathLocationRepository InstructionDiscoveryPathLocation = "repository" + // Instructions live in user-level configuration. + InstructionDiscoveryPathLocationUser InstructionDiscoveryPathLocation = "user" + // Instructions live under the current working directory. + InstructionDiscoveryPathLocationWorkingDirectory InstructionDiscoveryPathLocation = "working-directory" +) + +// Where this source lives — used for UI grouping +// Experimental: InstructionSourceLocation is part of an experimental API and may change or +// be removed. +type InstructionSourceLocation string + +const ( + // Instructions live in plugin-provided configuration. + InstructionSourceLocationPlugin InstructionSourceLocation = "plugin" + // Instructions live in repository-level configuration. + InstructionSourceLocationRepository InstructionSourceLocation = "repository" + // Instructions live in user-level configuration. + InstructionSourceLocationUser InstructionSourceLocation = "user" + // Instructions live under the current working directory. + InstructionSourceLocationWorkingDirectory InstructionSourceLocation = "working-directory" +) + +// Category of instruction source — used for merge logic +// Experimental: InstructionSourceType is part of an experimental API and may change or be +// removed. +type InstructionSourceType string + +const ( + // Instructions inherited from child instruction files. + InstructionSourceTypeChildInstructions InstructionSourceType = "child-instructions" + // Instructions loaded from the user's home configuration. + InstructionSourceTypeHome InstructionSourceType = "home" + // Instructions loaded from model-specific files. + InstructionSourceTypeModel InstructionSourceType = "model" + // Instructions discovered from nested agent files. + InstructionSourceTypeNestedAgents InstructionSourceType = "nested-agents" + // Instructions supplied by an installed plugin. + InstructionSourceTypePlugin InstructionSourceType = "plugin" + // Instructions loaded from repository-scoped files. + InstructionSourceTypeRepo InstructionSourceType = "repo" + // Instructions loaded from VS Code instruction files. + InstructionSourceTypeVscode InstructionSourceType = "vscode" +) + +// Transport the runtime would otherwise use for this request. `http` (the default when +// absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message +// channel where each body chunk maps to one WebSocket message and the `binary` flag +// distinguishes text from binary frames. The SDK consumer uses this to decide whether to +// service the request with an HTTP client or a WebSocket client. It is the one piece of +// request metadata the consumer cannot reliably infer from the URL or headers alone. +// Experimental: LlmInferenceHTTPRequestStartTransport is part of an experimental API and +// may change or be removed. +type LlmInferenceHTTPRequestStartTransport string + +const ( + // Plain HTTP or SSE response. Each body chunk is an opaque byte range; the response is a + // status line, headers, and a (possibly streamed) body. + LlmInferenceHTTPRequestStartTransportHTTP LlmInferenceHTTPRequestStartTransport = "http" + // Full-duplex WebSocket channel. Each body chunk maps to exactly one WebSocket message and + // the `binary` flag distinguishes text from binary frames; request and response chunks flow + // concurrently. + LlmInferenceHTTPRequestStartTransportWebsocket LlmInferenceHTTPRequestStartTransport = "websocket" +) + +// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +// Experimental: MCPAppsHostContextDetailsAvailableDisplayMode is part of an experimental +// API and may change or be removed. +type MCPAppsHostContextDetailsAvailableDisplayMode string + +const ( + // Rendered as a fullscreen overlay + MCPAppsHostContextDetailsAvailableDisplayModeFullscreen MCPAppsHostContextDetailsAvailableDisplayMode = "fullscreen" + // Rendered inline within the host conversation surface + MCPAppsHostContextDetailsAvailableDisplayModeInline MCPAppsHostContextDetailsAvailableDisplayMode = "inline" + // Rendered as a picture-in-picture floating panel + MCPAppsHostContextDetailsAvailableDisplayModePip MCPAppsHostContextDetailsAvailableDisplayMode = "pip" +) + +// Current display mode (SEP-1865) +// Experimental: MCPAppsHostContextDetailsDisplayMode is part of an experimental API and may +// change or be removed. +type MCPAppsHostContextDetailsDisplayMode string + +const ( + // Rendered as a fullscreen overlay + MCPAppsHostContextDetailsDisplayModeFullscreen MCPAppsHostContextDetailsDisplayMode = "fullscreen" + // Rendered inline within the host conversation surface + MCPAppsHostContextDetailsDisplayModeInline MCPAppsHostContextDetailsDisplayMode = "inline" + // Rendered as a picture-in-picture floating panel + MCPAppsHostContextDetailsDisplayModePip MCPAppsHostContextDetailsDisplayMode = "pip" +) + +// Platform type for responsive design +// Experimental: MCPAppsHostContextDetailsPlatform is part of an experimental API and may +// change or be removed. +type MCPAppsHostContextDetailsPlatform string + +const ( + // Host runs as a desktop application + MCPAppsHostContextDetailsPlatformDesktop MCPAppsHostContextDetailsPlatform = "desktop" + // Host runs on a mobile device + MCPAppsHostContextDetailsPlatformMobile MCPAppsHostContextDetailsPlatform = "mobile" + // Host runs in a web browser + MCPAppsHostContextDetailsPlatformWeb MCPAppsHostContextDetailsPlatform = "web" +) + +// UI theme preference per SEP-1865 +// Experimental: MCPAppsHostContextDetailsTheme is part of an experimental API and may +// change or be removed. +type MCPAppsHostContextDetailsTheme string + +const ( + // Dark UI theme + MCPAppsHostContextDetailsThemeDark MCPAppsHostContextDetailsTheme = "dark" + // Light UI theme + MCPAppsHostContextDetailsThemeLight MCPAppsHostContextDetailsTheme = "light" +) + +// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. +// Experimental: MCPAppsSetHostContextDetailsAvailableDisplayMode is part of an experimental +// API and may change or be removed. +type MCPAppsSetHostContextDetailsAvailableDisplayMode string + +const ( + // Rendered as a fullscreen overlay + MCPAppsSetHostContextDetailsAvailableDisplayModeFullscreen MCPAppsSetHostContextDetailsAvailableDisplayMode = "fullscreen" + // Rendered inline within the host conversation surface + MCPAppsSetHostContextDetailsAvailableDisplayModeInline MCPAppsSetHostContextDetailsAvailableDisplayMode = "inline" + // Rendered as a picture-in-picture floating panel + MCPAppsSetHostContextDetailsAvailableDisplayModePip MCPAppsSetHostContextDetailsAvailableDisplayMode = "pip" +) + +// Current display mode (SEP-1865) +// Experimental: MCPAppsSetHostContextDetailsDisplayMode is part of an experimental API and +// may change or be removed. +type MCPAppsSetHostContextDetailsDisplayMode string + +const ( + // Rendered as a fullscreen overlay + MCPAppsSetHostContextDetailsDisplayModeFullscreen MCPAppsSetHostContextDetailsDisplayMode = "fullscreen" + // Rendered inline within the host conversation surface + MCPAppsSetHostContextDetailsDisplayModeInline MCPAppsSetHostContextDetailsDisplayMode = "inline" + // Rendered as a picture-in-picture floating panel + MCPAppsSetHostContextDetailsDisplayModePip MCPAppsSetHostContextDetailsDisplayMode = "pip" +) + +// Platform type for responsive design +// Experimental: MCPAppsSetHostContextDetailsPlatform is part of an experimental API and may +// change or be removed. +type MCPAppsSetHostContextDetailsPlatform string + +const ( + // Host runs as a desktop application + MCPAppsSetHostContextDetailsPlatformDesktop MCPAppsSetHostContextDetailsPlatform = "desktop" + // Host runs on a mobile device + MCPAppsSetHostContextDetailsPlatformMobile MCPAppsSetHostContextDetailsPlatform = "mobile" + // Host runs in a web browser + MCPAppsSetHostContextDetailsPlatformWeb MCPAppsSetHostContextDetailsPlatform = "web" +) + +// UI theme preference per SEP-1865 +// Experimental: MCPAppsSetHostContextDetailsTheme is part of an experimental API and may +// change or be removed. +type MCPAppsSetHostContextDetailsTheme string + +const ( + // Dark UI theme + MCPAppsSetHostContextDetailsThemeDark MCPAppsSetHostContextDetailsTheme = "dark" + // Light UI theme + MCPAppsSetHostContextDetailsThemeLight MCPAppsSetHostContextDetailsTheme = "light" +) + +// Kind discriminator for MCPHeadersHandlePendingHeadersRefreshRequest. +type MCPHeadersHandlePendingHeadersRefreshRequestKind string + +const ( + MCPHeadersHandlePendingHeadersRefreshRequestKindHeaders MCPHeadersHandlePendingHeadersRefreshRequestKind = "headers" + MCPHeadersHandlePendingHeadersRefreshRequestKindNone MCPHeadersHandlePendingHeadersRefreshRequestKind = "none" +) + +// OAuth grant type override for this login. +// Experimental: MCPOauthLoginGrantType is part of an experimental API and may change or be +// removed. +type MCPOauthLoginGrantType string + +const ( + // Interactive browser-based OAuth flow using an authorization code, typically with PKCE. + MCPOauthLoginGrantTypeAuthorizationCode MCPOauthLoginGrantType = "authorization_code" + // Headless OAuth flow where a confidential client authenticates directly with a client + // secret. + MCPOauthLoginGrantTypeClientCredentials MCPOauthLoginGrantType = "client_credentials" +) + +// Kind discriminator for MCPOauthPendingRequestResponse. +type MCPOauthPendingRequestResponseKind string + +const ( + MCPOauthPendingRequestResponseKindCancelled MCPOauthPendingRequestResponseKind = "cancelled" + MCPOauthPendingRequestResponseKindToken MCPOauthPendingRequestResponseKind = "token" +) + +// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered +// an error (including agent-side rejection by content filter or criteria); 'cancelled' the +// caller cancelled this execution via cancelSamplingExecution. +// Experimental: MCPSamplingExecutionAction is part of an experimental API and may change or +// be removed. +type MCPSamplingExecutionAction string + +const ( + // The sampling inference was cancelled before completion. + MCPSamplingExecutionActionCancelled MCPSamplingExecutionAction = "cancelled" + // The sampling inference failed or was rejected. + MCPSamplingExecutionActionFailure MCPSamplingExecutionAction = "failure" + // The sampling inference completed and produced a result. + MCPSamplingExecutionActionSuccess MCPSamplingExecutionAction = "success" +) + +// Controls if tools provided by this server can be loaded on demand via tool search (auto) +// or always included in the initial tool list (never) +// Experimental: MCPServerConfigDeferTools is part of an experimental API and may change or +// be removed. +type MCPServerConfigDeferTools string + +const ( + // Tools may be deferred under certain conditions + MCPServerConfigDeferToolsAuto MCPServerConfigDeferTools = "auto" + // Tools are always included in the initial tool list, even when tool search is enabled. + MCPServerConfigDeferToolsNever MCPServerConfigDeferTools = "never" +) + +// OAuth grant type to use when authenticating to the remote MCP server. +// Experimental: MCPServerConfigHTTPOauthGrantType is part of an experimental API and may +// change or be removed. +type MCPServerConfigHTTPOauthGrantType string + +const ( + // Interactive browser-based authorization code flow with PKCE. + MCPServerConfigHTTPOauthGrantTypeAuthorizationCode MCPServerConfigHTTPOauthGrantType = "authorization_code" + // Headless client credentials flow using the configured OAuth client. + MCPServerConfigHTTPOauthGrantTypeClientCredentials MCPServerConfigHTTPOauthGrantType = "client_credentials" +) + +// Remote transport type. Defaults to "http" when omitted. +// Experimental: MCPServerConfigHTTPType is part of an experimental API and may change or be +// removed. +type MCPServerConfigHTTPType string + +const ( + // Streamable HTTP transport. + MCPServerConfigHTTPTypeHTTP MCPServerConfigHTTPType = "http" + // Server-Sent Events transport. + MCPServerConfigHTTPTypeSSE MCPServerConfigHTTPType = "sse" +) + +// Configuration source: user, workspace, plugin, or builtin +// Experimental: MCPServerSource is part of an experimental API and may change or be removed. +type MCPServerSource string + +const ( + // Server bundled with the runtime. + MCPServerSourceBuiltin MCPServerSource = "builtin" + // Server contributed by an installed plugin. + MCPServerSourcePlugin MCPServerSource = "plugin" + // Server configured in the user's global MCP configuration. + MCPServerSourceUser MCPServerSource = "user" + // Server configured by the current workspace. + MCPServerSourceWorkspace MCPServerSource = "workspace" +) + +// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or +// not_configured +// Experimental: MCPServerStatus is part of an experimental API and may change or be removed. +type MCPServerStatus string + +const ( + // The server is connected and available. + MCPServerStatusConnected MCPServerStatus = "connected" + // The server is configured but disabled. + MCPServerStatusDisabled MCPServerStatus = "disabled" + // The server failed to connect or initialize. + MCPServerStatusFailed MCPServerStatus = "failed" + // The server requires authentication before it can connect. + MCPServerStatusNeedsAuth MCPServerStatus = "needs-auth" + // The server is not configured for this session. + MCPServerStatusNotConfigured MCPServerStatus = "not_configured" + // The server connection is still being established. + MCPServerStatusPending MCPServerStatus = "pending" + // The server was intentionally stopped and can be restarted on demand when policy permits; + // a server quarantined by restrictive managed policy stays stopped and cannot be restarted + // until the policy allows it. + MCPServerStatusStopped MCPServerStatus = "stopped" +) + +// How environment-variable values supplied to MCP servers are resolved. "direct" passes +// literal string values; "indirect" treats values as references (e.g. names of environment +// variables on the host) that the runtime resolves before launch. Defaults to the runtime's +// startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI +// prompt mode and ACP) set this to "direct". +// Experimental: MCPSetEnvValueModeDetails is part of an experimental API and may change or +// be removed. +type MCPSetEnvValueModeDetails string + +const ( + // Treat MCP server environment values as literal strings. + MCPSetEnvValueModeDetailsDirect MCPSetEnvValueModeDetails = "direct" + // Treat MCP server environment values as host-side references to resolve before launch. + MCPSetEnvValueModeDetailsIndirect MCPSetEnvValueModeDetails = "indirect" +) + +// Consumer allowed to call an MCP tool. +// Experimental: MCPToolUIVisibility is part of an experimental API and may change or be +// removed. +type MCPToolUIVisibility string + +const ( + // An MCP App view may call the tool. + MCPToolUIVisibilityApp MCPToolUIVisibility = "app" + // The model may call the tool. + MCPToolUIVisibilityModel MCPToolUIVisibility = "model" +) + +// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') +// Experimental: MetadataSnapshotCurrentMode is part of an experimental API and may change +// or be removed. +type MetadataSnapshotCurrentMode string + +const ( + // The agent is working autonomously toward task completion. + MetadataSnapshotCurrentModeAutopilot MetadataSnapshotCurrentMode = "autopilot" + // The agent is responding interactively to the user. + MetadataSnapshotCurrentModeInteractive MetadataSnapshotCurrentMode = "interactive" + // The agent is preparing a plan before making changes. + MetadataSnapshotCurrentModePlan MetadataSnapshotCurrentMode = "plan" +) + +// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` +// invocation. +// Experimental: MetadataSnapshotRemoteMetadataTaskType is part of an experimental API and +// may change or be removed. +type MetadataSnapshotRemoteMetadataTaskType string + +const ( + // Remote task originated from Copilot Coding Agent. + MetadataSnapshotRemoteMetadataTaskTypeCca MetadataSnapshotRemoteMetadataTaskType = "cca" + // Remote task originated from a CLI remote-session invocation. + MetadataSnapshotRemoteMetadataTaskTypeCLI MetadataSnapshotRemoteMetadataTaskType = "cli" +) + +// Model capability category for grouping in the model picker +// Experimental: ModelPickerCategory is part of an experimental API and may change or be +// removed. +type ModelPickerCategory string + +const ( + // Lightweight model category optimized for faster, lower-cost interactions. + ModelPickerCategoryLightweight ModelPickerCategory = "lightweight" + // Powerful model category optimized for complex tasks. + ModelPickerCategoryPowerful ModelPickerCategory = "powerful" + // Versatile model category suitable for a broad range of tasks. + ModelPickerCategoryVersatile ModelPickerCategory = "versatile" +) + +// Relative cost tier for token-based billing users +// Experimental: ModelPickerPriceCategory is part of an experimental API and may change or +// be removed. +type ModelPickerPriceCategory string + +const ( + // High relative token cost tier. + ModelPickerPriceCategoryHigh ModelPickerPriceCategory = "high" + // Lowest relative token cost tier. + ModelPickerPriceCategoryLow ModelPickerPriceCategory = "low" + // Medium relative token cost tier. + ModelPickerPriceCategoryMedium ModelPickerPriceCategory = "medium" + // Highest relative token cost tier. + ModelPickerPriceCategoryVeryHigh ModelPickerPriceCategory = "very_high" +) + +// Current policy state for this model +// Experimental: ModelPolicyState is part of an experimental API and may change or be +// removed. +type ModelPolicyState string + +const ( + // The model is disabled by policy. + ModelPolicyStateDisabled ModelPolicyState = "disabled" + // The model is enabled by policy. + ModelPolicyStateEnabled ModelPolicyState = "enabled" + // No explicit policy is configured for the model. + ModelPolicyStateUnconfigured ModelPolicyState = "unconfigured" +) + +// Why the binary data is absent: it exceeded the inline size limit, or its asset was +// unavailable +// Experimental: OmittedBinaryOmittedReason is part of an experimental API and may change or +// be removed. +type OmittedBinaryOmittedReason string + +const ( + // The referenced binary asset could not be found (e.g. a truncated log). + OmittedBinaryOmittedReasonAssetUnavailable OmittedBinaryOmittedReason = "asset_unavailable" + // Bytes exceeded the session's inline size limit. + OmittedBinaryOmittedReasonTooLarge OmittedBinaryOmittedReason = "too_large" +) + +// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. +// Experimental: OptionsUpdateAdditionalContentExclusionPolicyScope is part of an +// experimental API and may change or be removed. +type OptionsUpdateAdditionalContentExclusionPolicyScope string + +const ( + // The content exclusion policy applies across all repositories. + OptionsUpdateAdditionalContentExclusionPolicyScopeAll OptionsUpdateAdditionalContentExclusionPolicyScope = "all" + // The content exclusion policy applies to the current repository. + OptionsUpdateAdditionalContentExclusionPolicyScopeRepo OptionsUpdateAdditionalContentExclusionPolicyScope = "repo" +) + +// Context tier for models with tiered pricing. The session uses this to derive effective +// `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits +// honor the selected tier. +// Experimental: OptionsUpdateContextTier is part of an experimental API and may change or +// be removed. +type OptionsUpdateContextTier string + +const ( + // Use the model's default context tier and its standard token limits / pricing. + OptionsUpdateContextTierDefault OptionsUpdateContextTier = "default" + // Use the model's long-context tier (when available) so larger inputs are accepted and + // tier-specific pricing applies. + OptionsUpdateContextTierLongContext OptionsUpdateContextTier = "long_context" +) + +// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` +// resolves at launch). +// Experimental: OptionsUpdateEnvValueMode is part of an experimental API and may change or +// be removed. +type OptionsUpdateEnvValueMode string + +const ( + // Pass MCP server environment values as literal strings. + OptionsUpdateEnvValueModeDirect OptionsUpdateEnvValueMode = "direct" + // Resolve MCP server environment values from host-side references. + OptionsUpdateEnvValueModeIndirect OptionsUpdateEnvValueMode = "indirect" +) + +// Reasoning summary mode for supported model clients. +// Experimental: OptionsUpdateReasoningSummary is part of an experimental API and may change +// or be removed. +type OptionsUpdateReasoningSummary string + +const ( + // Request a concise summary of model reasoning. + OptionsUpdateReasoningSummaryConcise OptionsUpdateReasoningSummary = "concise" + // Request a detailed summary of model reasoning. + OptionsUpdateReasoningSummaryDetailed OptionsUpdateReasoningSummary = "detailed" + // Do not request reasoning summaries from the model. + OptionsUpdateReasoningSummaryNone OptionsUpdateReasoningSummary = "none" +) + +// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both +// are set. +// Experimental: OptionsUpdateToolFilterPrecedence is part of an experimental API and may +// change or be removed. +type OptionsUpdateToolFilterPrecedence string + +const ( + // If availableTools is set, it is the only constraint that applies (excludedTools is + // ignored). Preserves CLI / pre-existing client behavior. Default. + OptionsUpdateToolFilterPrecedenceAvailable OptionsUpdateToolFilterPrecedence = "available" + // A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND + // it does not match the denylist. Makes 'all except X' expressible by combining the two + // lists. + OptionsUpdateToolFilterPrecedenceExcluded OptionsUpdateToolFilterPrecedence = "excluded" +) + +// Kind discriminator for PermissionDecisionApproveForLocationApproval. +type PermissionDecisionApproveForLocationApprovalKind string + +const ( + PermissionDecisionApproveForLocationApprovalKindCommands PermissionDecisionApproveForLocationApprovalKind = "commands" + PermissionDecisionApproveForLocationApprovalKindCustomTool PermissionDecisionApproveForLocationApprovalKind = "custom-tool" + PermissionDecisionApproveForLocationApprovalKindExtensionManagement PermissionDecisionApproveForLocationApprovalKind = "extension-management" + PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess PermissionDecisionApproveForLocationApprovalKind = "extension-permission-access" + PermissionDecisionApproveForLocationApprovalKindFactory PermissionDecisionApproveForLocationApprovalKind = "factory" + PermissionDecisionApproveForLocationApprovalKindMCP PermissionDecisionApproveForLocationApprovalKind = "mcp" + PermissionDecisionApproveForLocationApprovalKindMCPSampling PermissionDecisionApproveForLocationApprovalKind = "mcp-sampling" + PermissionDecisionApproveForLocationApprovalKindMemory PermissionDecisionApproveForLocationApprovalKind = "memory" + PermissionDecisionApproveForLocationApprovalKindRead PermissionDecisionApproveForLocationApprovalKind = "read" + PermissionDecisionApproveForLocationApprovalKindWrite PermissionDecisionApproveForLocationApprovalKind = "write" +) + +// Kind discriminator for PermissionDecisionApproveForSessionApproval. +type PermissionDecisionApproveForSessionApprovalKind string + +const ( + PermissionDecisionApproveForSessionApprovalKindCommands PermissionDecisionApproveForSessionApprovalKind = "commands" + PermissionDecisionApproveForSessionApprovalKindCustomTool PermissionDecisionApproveForSessionApprovalKind = "custom-tool" + PermissionDecisionApproveForSessionApprovalKindExtensionManagement PermissionDecisionApproveForSessionApprovalKind = "extension-management" + PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess PermissionDecisionApproveForSessionApprovalKind = "extension-permission-access" + PermissionDecisionApproveForSessionApprovalKindFactory PermissionDecisionApproveForSessionApprovalKind = "factory" + PermissionDecisionApproveForSessionApprovalKindMCP PermissionDecisionApproveForSessionApprovalKind = "mcp" + PermissionDecisionApproveForSessionApprovalKindMCPSampling PermissionDecisionApproveForSessionApprovalKind = "mcp-sampling" + PermissionDecisionApproveForSessionApprovalKindMemory PermissionDecisionApproveForSessionApprovalKind = "memory" + PermissionDecisionApproveForSessionApprovalKindRead PermissionDecisionApproveForSessionApprovalKind = "read" + PermissionDecisionApproveForSessionApprovalKindWrite PermissionDecisionApproveForSessionApprovalKind = "write" +) + +// Kind discriminator for PermissionDecision. +type PermissionDecisionKind string + +const ( + PermissionDecisionKindApproved PermissionDecisionKind = "approved" + PermissionDecisionKindApprovedForLocation PermissionDecisionKind = "approved-for-location" + PermissionDecisionKindApprovedForSession PermissionDecisionKind = "approved-for-session" + PermissionDecisionKindApproveForLocation PermissionDecisionKind = "approve-for-location" + PermissionDecisionKindApproveForSession PermissionDecisionKind = "approve-for-session" + PermissionDecisionKindApproveOnce PermissionDecisionKind = "approve-once" + PermissionDecisionKindApprovePermanently PermissionDecisionKind = "approve-permanently" + PermissionDecisionKindCancelled PermissionDecisionKind = "cancelled" + PermissionDecisionKindDeniedByContentExclusionPolicy PermissionDecisionKind = "denied-by-content-exclusion-policy" + PermissionDecisionKindDeniedByPermissionRequestHook PermissionDecisionKind = "denied-by-permission-request-hook" + PermissionDecisionKindDeniedByRules PermissionDecisionKind = "denied-by-rules" + PermissionDecisionKindDeniedInteractivelyByUser PermissionDecisionKind = "denied-interactively-by-user" + PermissionDecisionKindDeniedNoApprovalRuleAndCouldNotRequestFromUser PermissionDecisionKind = "denied-no-approval-rule-and-could-not-request-from-user" + PermissionDecisionKindReject PermissionDecisionKind = "reject" + PermissionDecisionKindUserNotAvailable PermissionDecisionKind = "user-not-available" +) + +// Disposition of a permission request as observed by the responding client. +// Experimental: PermissionDecisionOutcome is part of an experimental API and may change or +// be removed. +type PermissionDecisionOutcome string + +const ( + // The request was approved automatically without a new human decision. + PermissionDecisionOutcomeAutoApproved PermissionDecisionOutcome = "auto_approved" + // The request was denied without an interactive user decision; source records why. + PermissionDecisionOutcomeAutopilotDenied PermissionDecisionOutcome = "autopilot_denied" + // The response came from an interactive user prompt. + PermissionDecisionOutcomePromptedUser PermissionDecisionOutcome = "prompted_user" +) + +// Controlled reason or actor responsible for a permission response. +// Experimental: PermissionDecisionSource is part of an experimental API and may change or +// be removed. +type PermissionDecisionSource string + +const ( + // The host applied a standing policy or override rather than a judge recommendation or + // human decision. + PermissionDecisionSourceHostPolicy PermissionDecisionSource = "host_policy" + // A human supplied the response through an interactive prompt. + PermissionDecisionSourceHumanResponse PermissionDecisionSource = "human_response" + // The response followed the auto-approval judge recommendation. + PermissionDecisionSourceJudgeRecommendation PermissionDecisionSource = "judge_recommendation" + // The host denied the request because no interactive user response was available. + PermissionDecisionSourceUnattendedFallback PermissionDecisionSource = "unattended_fallback" +) + +// Client surface that submitted a permission response. +// Experimental: PermissionDecisionSurface is part of an experimental API and may change or +// be removed. +type PermissionDecisionSurface string + +const ( + // The Copilot App client. + PermissionDecisionSurfaceCopilotApp PermissionDecisionSurface = "copilot_app" + // The non-interactive Copilot CLI prompt mode. + PermissionDecisionSurfacePromptMode PermissionDecisionSurface = "prompt_mode" + // A generic Copilot SDK client. + PermissionDecisionSurfaceSDK PermissionDecisionSurface = "sdk" + // The interactive Copilot CLI terminal UI. + PermissionDecisionSurfaceTui PermissionDecisionSurface = "tui" +) + +// Whether the location is a git repo or directory +// Experimental: PermissionLocationType is part of an experimental API and may change or be +// removed. +type PermissionLocationType string + +const ( + // The permission location is persisted at the working directory. + PermissionLocationTypeDir PermissionLocationType = "dir" + // The permission location is persisted at the git repository root. + PermissionLocationTypeRepo PermissionLocationType = "repo" +) + +// Current or requested allow-all mode. +// Experimental: PermissionsAllowAllMode is part of an experimental API and may change or be +// removed. +type PermissionsAllowAllMode string + +const ( + // Permission requests follow the normal approval flow with an LLM advisory recommendation + // attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + PermissionsAllowAllModeAuto PermissionsAllowAllMode = "auto" + // Permission requests follow the normal approval flow. + PermissionsAllowAllModeOff PermissionsAllowAllMode = "off" + // Tool, path, and URL permission requests are automatically approved. + PermissionsAllowAllModeOn PermissionsAllowAllMode = "on" +) + +// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` +// enumeration. +// Experimental: PermissionsConfigureAdditionalContentExclusionPolicyScope is part of an +// experimental API and may change or be removed. +type PermissionsConfigureAdditionalContentExclusionPolicyScope string + +const ( + // The content exclusion policy applies across all repositories. + PermissionsConfigureAdditionalContentExclusionPolicyScopeAll PermissionsConfigureAdditionalContentExclusionPolicyScope = "all" + // The content exclusion policy applies to the current repository. + PermissionsConfigureAdditionalContentExclusionPolicyScopeRepo PermissionsConfigureAdditionalContentExclusionPolicyScope = "repo" +) + +// Kind discriminator for PermissionsLocationsAddToolApprovalDetails. +type PermissionsLocationsAddToolApprovalDetailsKind string + +const ( + PermissionsLocationsAddToolApprovalDetailsKindCommands PermissionsLocationsAddToolApprovalDetailsKind = "commands" + PermissionsLocationsAddToolApprovalDetailsKindCustomTool PermissionsLocationsAddToolApprovalDetailsKind = "custom-tool" + PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement PermissionsLocationsAddToolApprovalDetailsKind = "extension-management" + PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess PermissionsLocationsAddToolApprovalDetailsKind = "extension-permission-access" + PermissionsLocationsAddToolApprovalDetailsKindFactory PermissionsLocationsAddToolApprovalDetailsKind = "factory" + PermissionsLocationsAddToolApprovalDetailsKindMCP PermissionsLocationsAddToolApprovalDetailsKind = "mcp" + PermissionsLocationsAddToolApprovalDetailsKindMCPSampling PermissionsLocationsAddToolApprovalDetailsKind = "mcp-sampling" + PermissionsLocationsAddToolApprovalDetailsKindMemory PermissionsLocationsAddToolApprovalDetailsKind = "memory" + PermissionsLocationsAddToolApprovalDetailsKindRead PermissionsLocationsAddToolApprovalDetailsKind = "read" + PermissionsLocationsAddToolApprovalDetailsKindWrite PermissionsLocationsAddToolApprovalDetailsKind = "write" +) + +// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or +// to location-scoped rules persisted via the location-permissions config file. +// Experimental: PermissionsModifyRulesScope is part of an experimental API and may change +// or be removed. +type PermissionsModifyRulesScope string + +const ( + // Persist the rule change for this project location. + PermissionsModifyRulesScopeLocation PermissionsModifyRulesScope = "location" + // Apply the rule change only to this session. + PermissionsModifyRulesScopeSession PermissionsModifyRulesScope = "session" +) + +// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +// Experimental: PermissionsSetAllowAllSource is part of an experimental API and may change +// or be removed. +type PermissionsSetAllowAllSource string + +const ( + // Allow-all was enabled by confirming autopilot behavior. + PermissionsSetAllowAllSourceAutopilotConfirmation PermissionsSetAllowAllSource = "autopilot_confirmation" + // Allow-all was enabled from a CLI command-line flag. + PermissionsSetAllowAllSourceCLIFlag PermissionsSetAllowAllSource = "cli_flag" + // Allow-all was enabled through an RPC caller. + PermissionsSetAllowAllSourceRPC PermissionsSetAllowAllSource = "rpc" + // Allow-all was enabled by a slash command. + PermissionsSetAllowAllSourceSlashCommand PermissionsSetAllowAllSource = "slash_command" +) + +// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +// Experimental: PermissionsSetApproveAllSource is part of an experimental API and may +// change or be removed. +type PermissionsSetApproveAllSource string + +const ( + // Allow-all was enabled by confirming autopilot behavior. + PermissionsSetApproveAllSourceAutopilotConfirmation PermissionsSetApproveAllSource = "autopilot_confirmation" + // Allow-all was enabled from a CLI command-line flag. + PermissionsSetApproveAllSourceCLIFlag PermissionsSetApproveAllSource = "cli_flag" + // Allow-all was enabled through an RPC caller. + PermissionsSetApproveAllSourceRPC PermissionsSetApproveAllSource = "rpc" + // Allow-all was enabled by a slash command. + PermissionsSetApproveAllSourceSlashCommand PermissionsSetApproveAllSource = "slash_command" +) + +// Provider transport. Defaults to "http". +// Experimental: ProviderConfigTransport is part of an experimental API and may change or be +// removed. +type ProviderConfigTransport string + +const ( + // HTTP request/streaming transport. + ProviderConfigTransportHTTP ProviderConfigTransport = "http" + // WebSocket transport. + ProviderConfigTransportWebsockets ProviderConfigTransport = "websockets" +) + +// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. +// Experimental: ProviderConfigType is part of an experimental API and may change or be +// removed. +type ProviderConfigType string + +const ( + // Anthropic API endpoint. + ProviderConfigTypeAnthropic ProviderConfigType = "anthropic" + // Azure OpenAI Service endpoint. + ProviderConfigTypeAzure ProviderConfigType = "azure" + // Generic OpenAI-compatible API. + ProviderConfigTypeOpenai ProviderConfigType = "openai" +) + +// Wire API format (openai/azure only). Defaults to "completions". +// Experimental: ProviderConfigWireAPI is part of an experimental API and may change or be +// removed. +type ProviderConfigWireAPI string + +const ( + // OpenAI Chat Completions wire format. + ProviderConfigWireAPICompletions ProviderConfigWireAPI = "completions" + // OpenAI Responses API wire format. + ProviderConfigWireAPIResponses ProviderConfigWireAPI = "responses" +) + +// Transport to be used for provider requests. +// Experimental: ProviderEndpointTransport is part of an experimental API and may change or +// be removed. +type ProviderEndpointTransport string + +const ( + // HTTP request/streaming transport. + ProviderEndpointTransportHTTP ProviderEndpointTransport = "http" + // WebSocket transport. + ProviderEndpointTransportWebsockets ProviderEndpointTransport = "websockets" +) + +// Provider family. Matches the `type` field of a BYOK provider config. +// Experimental: ProviderEndpointType is part of an experimental API and may change or be +// removed. +type ProviderEndpointType string + +const ( + // Anthropic endpoint (use the Anthropic client library). + ProviderEndpointTypeAnthropic ProviderEndpointType = "anthropic" + // Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). + ProviderEndpointTypeAzure ProviderEndpointType = "azure" + // OpenAI-compatible endpoint (use the OpenAI client library). + ProviderEndpointTypeOpenai ProviderEndpointType = "openai" +) + +// Wire API to be used, when required for the provider type. +// Experimental: ProviderEndpointWireAPI is part of an experimental API and may change or be +// removed. +type ProviderEndpointWireAPI string + +const ( + // Classic chat-completions request shape. + ProviderEndpointWireAPICompletions ProviderEndpointWireAPI = "completions" + // Newer responses request shape. + ProviderEndpointWireAPIResponses ProviderEndpointWireAPI = "responses" +) + +// Type of GitHub reference +// Experimental: PushAttachmentGitHubReferenceType is part of an experimental API and may +// change or be removed. +type PushAttachmentGitHubReferenceType string + +const ( + // GitHub discussion reference. + PushAttachmentGitHubReferenceTypeDiscussion PushAttachmentGitHubReferenceType = "discussion" + // GitHub issue reference. + PushAttachmentGitHubReferenceTypeIssue PushAttachmentGitHubReferenceType = "issue" + // GitHub pull request reference. + PushAttachmentGitHubReferenceTypePr PushAttachmentGitHubReferenceType = "pr" +) + +// Type discriminator for PushAttachment. +type PushAttachmentType string + +const ( + PushAttachmentTypeBlob PushAttachmentType = "blob" + PushAttachmentTypeDirectory PushAttachmentType = "directory" + PushAttachmentTypeExtensionContext PushAttachmentType = "extension_context" + PushAttachmentTypeFile PushAttachmentType = "file" + PushAttachmentTypeGitHubActionsJob PushAttachmentType = "github_actions_job" + PushAttachmentTypeGitHubCommit PushAttachmentType = "github_commit" + PushAttachmentTypeGitHubFile PushAttachmentType = "github_file" + PushAttachmentTypeGitHubFileDiff PushAttachmentType = "github_file_diff" + PushAttachmentTypeGitHubReference PushAttachmentType = "github_reference" + PushAttachmentTypeGitHubRelease PushAttachmentType = "github_release" + PushAttachmentTypeGitHubRepository PushAttachmentType = "github_repository" + PushAttachmentTypeGitHubSnippet PushAttachmentType = "github_snippet" + PushAttachmentTypeGitHubTreeComparison PushAttachmentType = "github_tree_comparison" + PushAttachmentTypeGitHubURL PushAttachmentType = "github_url" + PushAttachmentTypeSelection PushAttachmentType = "selection" +) + +// Whether this item is a queued user message or a queued slash command / model change +// Experimental: QueuePendingItemsKind is part of an experimental API and may change or be +// removed. +type QueuePendingItemsKind string + +const ( + // A queued slash command or model-change command. + QueuePendingItemsKindCommand QueuePendingItemsKind = "command" + // A queued user message. + QueuePendingItemsKindMessage QueuePendingItemsKind = "message" +) + +// Reasoning summary mode to request for supported model clients +// Experimental: ReasoningSummary is part of an experimental API and may change or be +// removed. +type ReasoningSummary string + +const ( + // Request a concise summary of the model's reasoning. + ReasoningSummaryConcise ReasoningSummary = "concise" + // Request a detailed summary of the model's reasoning. + ReasoningSummaryDetailed ReasoningSummary = "detailed" + // Do not request reasoning summaries from the model. + ReasoningSummaryNone ReasoningSummary = "none" +) + +// State discriminator for RemoteControlStatus. +type RemoteControlStatusState string + +const ( + RemoteControlStatusStateActive RemoteControlStatusState = "active" + RemoteControlStatusStateConnecting RemoteControlStatusState = "connecting" + RemoteControlStatusStateError RemoteControlStatusState = "error" + RemoteControlStatusStateOff RemoteControlStatusState = "off" +) + +// Whether the remote task originated from CCA or CLI `--remote`. +// Experimental: RemoteSessionMetadataTaskType is part of an experimental API and may change +// or be removed. +type RemoteSessionMetadataTaskType string + +const ( + // GitHub Copilot coding agent task. + RemoteSessionMetadataTaskTypeCca RemoteSessionMetadataTaskType = "cca" + // CLI remote task. + RemoteSessionMetadataTaskTypeCLI RemoteSessionMetadataTaskType = "cli" +) + +// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub +// without enabling remote steering, "on" enables both export and remote steering. +// Experimental: RemoteSessionMode is part of an experimental API and may change or be +// removed. +type RemoteSessionMode string + +const ( + // Export session events to GitHub without enabling remote steering. + RemoteSessionModeExport RemoteSessionMode = "export" + // Disable remote session export and steering. + RemoteSessionModeOff RemoteSessionMode = "off" + // Enable both remote session export and remote steering. + RemoteSessionModeOn RemoteSessionMode = "on" +) + +// The UI mode the agent was in when this message was sent. Defaults to the session's +// current mode. +// Experimental: SendAgentMode is part of an experimental API and may change or be removed. +type SendAgentMode string + +const ( + // The agent is working autonomously toward task completion. + SendAgentModeAutopilot SendAgentMode = "autopilot" + // The agent is responding interactively to the user. + SendAgentModeInteractive SendAgentMode = "interactive" + // The agent is preparing a plan before making changes. + SendAgentModePlan SendAgentMode = "plan" + // The agent is in shell-focused UI mode. + SendAgentModeShell SendAgentMode = "shell" +) + +// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` +// interjects during an in-progress turn. +// Experimental: SendMode is part of an experimental API and may change or be removed. +type SendMode string + +const ( + // Append the message to the normal session queue. + SendModeEnqueue SendMode = "enqueue" + // Interject the message during the in-progress turn. + SendModeImmediate SendMode = "immediate" +) + +// Session capability enabled for this session +// Experimental: SessionCapability is part of an experimental API and may change or be +// removed. +type SessionCapability string + +const ( + // Interactive ask_user tool support. + SessionCapabilityAskUser SessionCapability = "ask-user" + // Host-provided canvas rendering support. + SessionCapabilityCanvasRenderer SessionCapability = "canvas-renderer" + // Copilot CLI documentation tool and prompt section. + SessionCapabilityCLIDocumentation SessionCapability = "cli-documentation" + // SDK elicitation support. + SessionCapabilityElicitation SessionCapability = "elicitation" + // Interactive CLI identity and behavior. + SessionCapabilityInteractiveMode SessionCapability = "interactive-mode" + // MCP Apps UI passthrough. + SessionCapabilityMCPApps SessionCapability = "mcp-apps" + // Memory tool and memories prompt section. + SessionCapabilityMemory SessionCapability = "memory" + // Plan-mode handling and instructions. + SessionCapabilityPlanMode SessionCapability = "plan-mode" + // Cross-session history tools and session-store SQL prompt/tool metadata. + SessionCapabilitySessionStore SessionCapability = "session-store" + // Automatic hidden system notifications. + SessionCapabilitySystemNotifications SessionCapability = "system-notifications" + // TUI-specific prompt hints such as keyboard shortcuts. + SessionCapabilityTuiHints SessionCapability = "tui-hints" +) + +// Repository host type +// Experimental: SessionContextHostType is part of an experimental API and may change or be +// removed. +type SessionContextHostType string + +const ( + // Session repository is hosted on Azure DevOps. + SessionContextHostTypeADO SessionContextHostType = "ado" + // Session repository is hosted on GitHub. + SessionContextHostTypeGitHub SessionContextHostType = "github" +) + +// Error classification +// Experimental: SessionFSErrorCode is part of an experimental API and may change or be +// removed. +type SessionFSErrorCode string + +const ( + // The requested path does not exist. + SessionFSErrorCodeENOENT SessionFSErrorCode = "ENOENT" + // The filesystem operation failed for an unspecified reason. + SessionFSErrorCodeUNKNOWN SessionFSErrorCode = "UNKNOWN" +) + +// Entry type +// Experimental: SessionFSReaddirWithTypesEntryType is part of an experimental API and may +// change or be removed. +type SessionFSReaddirWithTypesEntryType string + +const ( + // The entry is a directory. + SessionFSReaddirWithTypesEntryTypeDirectory SessionFSReaddirWithTypesEntryType = "directory" + // The entry is a file. + SessionFSReaddirWithTypesEntryTypeFile SessionFSReaddirWithTypesEntryType = "file" +) + +// Path conventions used by this filesystem +// Experimental: SessionFSSetProviderConventions is part of an experimental API and may +// change or be removed. +type SessionFSSetProviderConventions string + +const ( + // Paths use POSIX path conventions. + SessionFSSetProviderConventionsPosix SessionFSSetProviderConventions = "posix" + // Paths use Windows path conventions. + SessionFSSetProviderConventionsWindows SessionFSSetProviderConventions = "windows" +) + +// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT +// (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) +// Experimental: SessionFSSqliteQueryType is part of an experimental API and may change or +// be removed. +type SessionFSSqliteQueryType string + +const ( + // Execute DDL or multi-statement SQL without returning rows. + SessionFSSqliteQueryTypeExec SessionFSSqliteQueryType = "exec" + // Execute a SELECT-style query and return rows. + SessionFSSqliteQueryTypeQuery SessionFSSqliteQueryType = "query" + // Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. + SessionFSSqliteQueryTypeRun SessionFSSqliteQueryType = "run" +) + +// SQLite transaction failure classification. +// Experimental: SessionFSSqliteTransactionErrorClass is part of an experimental API and may +// change or be removed. +type SessionFSSqliteTransactionErrorClass string + +const ( + // SQLite reported BUSY or LOCKED before commit; the transaction was rolled back and may be + // retried. + SessionFSSqliteTransactionErrorClassBusyOrLocked SessionFSSqliteTransactionErrorClass = "busyOrLocked" + // The statement, database, or provider failed definitively and must not be retried + // automatically. + SessionFSSqliteTransactionErrorClassFatal SessionFSSqliteTransactionErrorClass = "fatal" + // The transport failed after the provider may have committed; retrying could duplicate + // effects. + SessionFSSqliteTransactionErrorClassPostCommitAmbiguous SessionFSSqliteTransactionErrorClass = "postCommitAmbiguous" +) + +// What initiated this compaction request, recorded as the `trigger` on the persisted +// `session.compaction_start` / `session.compaction_complete` events. When absent, the +// compaction is persisted without trigger attribution (initiator unknown). +type SessionHistoryCompactRequestTrigger string + +const ( + // User-requested compaction, e.g. the /compact command or a direct history.compact call. + SessionHistoryCompactRequestTriggerManual SessionHistoryCompactRequestTrigger = "manual" + // Compaction requested while switching to a model with a smaller context window. + SessionHistoryCompactRequestTriggerModelSwitch SessionHistoryCompactRequestTrigger = "model_switch" +) + +// Constant value. Always "github". +type SessionInstalledPluginSourceGitHubSource string + +const ( + SessionInstalledPluginSourceGitHubSourceGitHub SessionInstalledPluginSourceGitHubSource = "github" +) + +// Constant value. Always "local". +type SessionInstalledPluginSourceLocalSource string + +const ( + SessionInstalledPluginSourceLocalSourceLocal SessionInstalledPluginSourceLocalSource = "local" +) + +// Constant value. Always "url". +type SessionInstalledPluginSourceURLSource string + +const ( + SessionInstalledPluginSourceURLSourceURL SessionInstalledPluginSourceURLSource = "url" +) + +// Client population used for the prediction baseline. +// Experimental: SessionLimitPredictionClientType is part of an experimental API and may +// change or be removed. +type SessionLimitPredictionClientType string + +const ( + // Interactive CLI sessions where a user can accept, edit, or top up the limit. + SessionLimitPredictionClientTypeCLIInteractive SessionLimitPredictionClientType = "cli-interactive" + // Prompt/non-interactive CLI sessions where the initial limit must cover more of the run. + SessionLimitPredictionClientTypeCLIPrompt SessionLimitPredictionClientType = "cli-prompt" +) + +// Kind discriminator for SessionLimitPredictionResult. +type SessionLimitPredictionResultKind string + +const ( + SessionLimitPredictionResultKindAvailable SessionLimitPredictionResultKind = "available" + SessionLimitPredictionResultKindUnavailable SessionLimitPredictionResultKind = "unavailable" +) + +// Baseline fallback level used to create the prediction. +// Experimental: SessionLimitPredictionSource is part of an experimental API and may change +// or be removed. +type SessionLimitPredictionSource string + +const ( + // The exact model was unavailable, so the prediction used the model family's baseline cell. + SessionLimitPredictionSourceFamily SessionLimitPredictionSource = "family" + // No model or family cell was available, so the prediction used the global client-type + // baseline cell. + SessionLimitPredictionSourceGlobal SessionLimitPredictionSource = "global" + // The prediction used the exact resolved model's baseline cell. + SessionLimitPredictionSourceModel SessionLimitPredictionSource = "model" +) + +// Semantic usage tier used for a recommended cap or additional headroom. +// Experimental: SessionLimitPredictionTier is part of an experimental API and may change or +// be removed. +type SessionLimitPredictionTier string + +const ( + // Additional headroom for longer-running sessions. + SessionLimitPredictionTierAdditionalHeadroom SessionLimitPredictionTier = "additional_headroom" + // Generous headroom for unusually high usage. + SessionLimitPredictionTierGenerousHeadroom SessionLimitPredictionTier = "generous_headroom" + // Maximum available headroom tier. + SessionLimitPredictionTierMaximumHeadroom SessionLimitPredictionTier = "maximum_headroom" + // Recommended starting tier. + SessionLimitPredictionTierRecommended SessionLimitPredictionTier = "recommended" +) + +// Reason a prediction could not be computed. +// Experimental: SessionLimitPredictionUnavailableReason is part of an experimental API and +// may change or be removed. +type SessionLimitPredictionUnavailableReason string + +const ( + // The current model is auto and has not resolved to a concrete model yet. + SessionLimitPredictionUnavailableReasonAutoUnresolved SessionLimitPredictionUnavailableReason = "auto_unresolved" + // No model was provided and the session does not currently have a selected model. + SessionLimitPredictionUnavailableReasonNoModel SessionLimitPredictionUnavailableReason = "no_model" +) + +// Log severity level. Determines how the message is displayed in the timeline. Defaults to +// "info". +// Experimental: SessionLogLevel is part of an experimental API and may change or be removed. +type SessionLogLevel string + +const ( + // Error message describing a failure. + SessionLogLevelError SessionLogLevel = "error" + // Informational message. + SessionLogLevelInfo SessionLogLevel = "info" + // Warning message that may require attention. + SessionLogLevelWarning SessionLogLevel = "warning" +) + +// The session mode the agent is operating in +// Experimental: SessionMode is part of an experimental API and may change or be removed. +type SessionMode string + +const ( + // The agent is working autonomously toward task completion. + SessionModeAutopilot SessionMode = "autopilot" + // The agent is responding interactively to the user. + SessionModeInteractive SessionMode = "interactive" + // The agent is preparing a plan before making changes. + SessionModePlan SessionMode = "plan" +) + +// Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` +// enumeration. +// Experimental: SessionOpenOptionsAdditionalContentExclusionPolicyScope is part of an +// experimental API and may change or be removed. +type SessionOpenOptionsAdditionalContentExclusionPolicyScope string + +const ( + // The content exclusion policy applies across all repositories. + SessionOpenOptionsAdditionalContentExclusionPolicyScopeAll SessionOpenOptionsAdditionalContentExclusionPolicyScope = "all" + // The content exclusion policy applies to the current repository. + SessionOpenOptionsAdditionalContentExclusionPolicyScopeRepo SessionOpenOptionsAdditionalContentExclusionPolicyScope = "repo" +) + +// How MCP server environment values are interpreted. +// Experimental: SessionOpenOptionsEnvValueMode is part of an experimental API and may +// change or be removed. +type SessionOpenOptionsEnvValueMode string + +const ( + // Pass MCP server environment values as literal strings. + SessionOpenOptionsEnvValueModeDirect SessionOpenOptionsEnvValueMode = "direct" + // Resolve MCP server environment values from host-side references. + SessionOpenOptionsEnvValueModeIndirect SessionOpenOptionsEnvValueMode = "indirect" +) + +// Initial reasoning summary mode for supported model clients. +// Experimental: SessionOpenOptionsReasoningSummary is part of an experimental API and may +// change or be removed. +type SessionOpenOptionsReasoningSummary string + +const ( + // Request a concise summary of model reasoning. + SessionOpenOptionsReasoningSummaryConcise SessionOpenOptionsReasoningSummary = "concise" + // Request a detailed summary of model reasoning. + SessionOpenOptionsReasoningSummaryDetailed SessionOpenOptionsReasoningSummary = "detailed" + // Do not request reasoning summaries from the model. + SessionOpenOptionsReasoningSummaryNone SessionOpenOptionsReasoningSummary = "none" +) + +// Kind discriminator for SessionOpenParams. +type SessionOpenParamsKind string + +const ( + SessionOpenParamsKindAttach SessionOpenParamsKind = "attach" + SessionOpenParamsKindCloud SessionOpenParamsKind = "cloud" + SessionOpenParamsKindCreate SessionOpenParamsKind = "create" + SessionOpenParamsKindHandoff SessionOpenParamsKind = "handoff" + SessionOpenParamsKindRemote SessionOpenParamsKind = "remote" + SessionOpenParamsKindResume SessionOpenParamsKind = "resume" + SessionOpenParamsKindResumeLast SessionOpenParamsKind = "resumeLast" +) + +// Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names +// are intentionally not part of the contract. +// Experimental: SessionSettingsPredicateName is part of an experimental API and may change +// or be removed. +type SessionSettingsPredicateName string + +const ( + // Whether Claude Opus token-limit caps should be applied. + SessionSettingsPredicateNameCapClaudeOpusTokenLimitsEnabled SessionSettingsPredicateName = "capClaudeOpusTokenLimitsEnabled" + // Whether CCA should use the TypeScript autofind behavior. + SessionSettingsPredicateNameCcaUseTsAutofindEnabled SessionSettingsPredicateName = "ccaUseTsAutofindEnabled" + // Whether Chronicle integration is enabled. + SessionSettingsPredicateNameChronicleEnabled SessionSettingsPredicateName = "chronicleEnabled" + // Whether the co-author hook is enabled. + SessionSettingsPredicateNameCoAuthorHookEnabled SessionSettingsPredicateName = "coAuthorHookEnabled" + // Whether the CodeQL checker is enabled. + SessionSettingsPredicateNameCodeqlCheckerEnabled SessionSettingsPredicateName = "codeqlCheckerEnabled" + // Whether code-review behavior is enabled. + SessionSettingsPredicateNameCodeReviewFeatureEnabled SessionSettingsPredicateName = "codeReviewFeatureEnabled" + // Whether content-exclusion policy may self-fetch data. + SessionSettingsPredicateNameContentExclusionSelfFetchEnabled SessionSettingsPredicateName = "contentExclusionSelfFetchEnabled" + // Whether the Dependabot checker is enabled. + SessionSettingsPredicateNameDependabotCheckerEnabled SessionSettingsPredicateName = "dependabotCheckerEnabled" + // Whether the dependency checker is enabled. + SessionSettingsPredicateNameDependencyCheckerEnabled SessionSettingsPredicateName = "dependencyCheckerEnabled" + // Whether validation may run in parallel. + SessionSettingsPredicateNameParallelValidationEnabled SessionSettingsPredicateName = "parallelValidationEnabled" + // Whether runtime timing telemetry is enabled. + SessionSettingsPredicateNameRuntimeTimingTelemetryEnabled SessionSettingsPredicateName = "runtimeTimingTelemetryEnabled" + // Whether the security-tools feature flag enables security tool wiring. + SessionSettingsPredicateNameSecurityToolsEnabled SessionSettingsPredicateName = "securityToolsEnabled" + // Whether third-party security tools should receive the security prompt. + SessionSettingsPredicateNameThirdPartySecurityPromptEnabled SessionSettingsPredicateName = "thirdPartySecurityPromptEnabled" + // Whether trivial-change handling is enabled. + SessionSettingsPredicateNameTrivialChangeEnabled SessionSettingsPredicateName = "trivialChangeEnabled" + // Whether trivial-change handling is enabled for code review. + SessionSettingsPredicateNameTrivialChangeEnabledForCodeReview SessionSettingsPredicateName = "trivialChangeEnabledForCodeReview" + // Whether trivial-change handling is enabled for a specific tool. + SessionSettingsPredicateNameTrivialChangeEnabledForTool SessionSettingsPredicateName = "trivialChangeEnabledForTool" + // Whether trivial-change skip behavior is enabled. + SessionSettingsPredicateNameTrivialChangeSkipEnabled SessionSettingsPredicateName = "trivialChangeSkipEnabled" + // Whether trivial-change skip behavior is enabled for code review. + SessionSettingsPredicateNameTrivialChangeSkipEnabledForCodeReview SessionSettingsPredicateName = "trivialChangeSkipEnabledForCodeReview" + // Whether trivial-change skip behavior is enabled for a specific tool. + SessionSettingsPredicateNameTrivialChangeSkipEnabledForTool SessionSettingsPredicateName = "trivialChangeSkipEnabledForTool" +) + +// Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient +// session). +// Experimental: SessionsOpenHandoffTaskType is part of an experimental API and may change +// or be removed. +type SessionsOpenHandoffTaskType string + +const ( + // GitHub Copilot coding agent task. + SessionsOpenHandoffTaskTypeCca SessionsOpenHandoffTaskType = "cca" + // CLI remote task. + SessionsOpenHandoffTaskTypeCLI SessionsOpenHandoffTaskType = "cli" +) + +// Step status. +// Experimental: SessionsOpenProgressStatus is part of an experimental API and may change or +// be removed. +type SessionsOpenProgressStatus string + +const ( + // The step has completed successfully. + SessionsOpenProgressStatusComplete SessionsOpenProgressStatus = "complete" + // The step has started and has not yet finished. + SessionsOpenProgressStatusInProgress SessionsOpenProgressStatus = "in-progress" +) + +// Handoff step. +// Experimental: SessionsOpenProgressStep is part of an experimental API and may change or +// be removed. +type SessionsOpenProgressStep string + +const ( + // Checking the local working tree for uncommitted changes that would block the handoff. + SessionsOpenProgressStepCheckChanges SessionsOpenProgressStep = "check-changes" + // Checking out the branch associated with the remote session in the local working tree. + SessionsOpenProgressStepCheckoutBranch SessionsOpenProgressStep = "checkout-branch" + // Creating the new local session and seeding it with the source session's events. + SessionsOpenProgressStepCreateSession SessionsOpenProgressStep = "create-session" + // Loading the source session's events from the remote service. + SessionsOpenProgressStepLoadSession SessionsOpenProgressStep = "load-session" + // Persisting the newly-created local session to disk. + SessionsOpenProgressStepSaveSession SessionsOpenProgressStep = "save-session" + // Validating that the local repository matches the remote session's repository. + SessionsOpenProgressStepValidateRepo SessionsOpenProgressStep = "validate-repo" +) + +// Outcome of the open request. +// Experimental: SessionsOpenStatus is part of an experimental API and may change or be +// removed. +type SessionsOpenStatus string + +const ( + // Connected to an existing remote session. + SessionsOpenStatusConnected SessionsOpenStatus = "connected" + // A new session was created. + SessionsOpenStatusCreated SessionsOpenStatus = "created" + // Remote session was handed off to a new local session. + SessionsOpenStatusHandedOff SessionsOpenStatus = "handed_off" + // No matching persisted session was found. + SessionsOpenStatusNotFound SessionsOpenStatus = "not_found" + // An existing session was loaded or reattached. + SessionsOpenStatusResumed SessionsOpenStatus = "resumed" +) + +// Which session sources to include. Defaults to `local` for backward compatibility. +// Experimental: SessionSource is part of an experimental API and may change or be removed. +type SessionSource string + +const ( + // Return both local and remote sessions. + SessionSourceAll SessionSource = "all" + // Return only local sessions. + SessionSourceLocal SessionSource = "local" + // Return only remote sessions. + SessionSourceRemote SessionSource = "remote" +) + +// Sharing status for a synced session. "repo" makes the session visible to anyone with read +// access to the repository; "unshared" restricts it to the creator and collaborators. +// Experimental: SessionVisibilityStatus is part of an experimental API and may change or be +// removed. +type SessionVisibilityStatus string + +const ( + // The session is visible to repository readers. + SessionVisibilityStatusRepo SessionVisibilityStatus = "repo" + // The session is restricted to its creator and collaborators. + SessionVisibilityStatusUnshared SessionVisibilityStatus = "unshared" +) + +// Hosting platform type of the repository +// Experimental: SessionWorkingDirectoryContextHostType is part of an experimental API and +// may change or be removed. +type SessionWorkingDirectoryContextHostType string + +const ( + // The working directory repository is hosted on Azure DevOps. + SessionWorkingDirectoryContextHostTypeADO SessionWorkingDirectoryContextHostType = "ado" + // The working directory repository is hosted on GitHub. + SessionWorkingDirectoryContextHostTypeGitHub SessionWorkingDirectoryContextHostType = "github" +) + +// Controls automatic non-interactive profile loading where supported. Explicit initScripts +// are unaffected. +// Experimental: ShellInitProfile is part of an experimental API and may change or be +// removed. +type ShellInitProfile string + +const ( + // Disable automatic non-interactive profile loading. Explicit initScripts still run. + ShellInitProfileNone ShellInitProfile = "none" + // Allow automatic non-interactive profile loading when supported. Explicit initScripts + // still run. + ShellInitProfileNonInteractive ShellInitProfile = "non-interactive" +) + +// Supported built-in shells for initialization scripts. +// Experimental: ShellInitScriptShell is part of an experimental API and may change or be +// removed. +type ShellInitScriptShell string + +const ( + // Source the script in the built-in Bash shell on macOS and Linux. + ShellInitScriptShellBash ShellInitScriptShell = "bash" + // Source the script in the built-in PowerShell shell on Windows. + ShellInitScriptShellPowershell ShellInitScriptShell = "powershell" +) + +// Signal to send (default: SIGTERM) +// Experimental: ShellKillSignal is part of an experimental API and may change or be removed. +type ShellKillSignal string + +const ( + // Send an interrupt signal to the process. + ShellKillSignalSIGINT ShellKillSignal = "SIGINT" + // Forcefully terminate the process. + ShellKillSignalSIGKILL ShellKillSignal = "SIGKILL" + // Request graceful process termination. + ShellKillSignalSIGTERM ShellKillSignal = "SIGTERM" +) + +// Why the session is being shut down. Defaults to "routine" when omitted. +// Experimental: ShutdownType is part of an experimental API and may change or be removed. +type ShutdownType string + +const ( + // The session is shutting down because of an error. + ShutdownTypeError ShutdownType = "error" + // The session is shutting down normally. + ShutdownTypeRoutine ShutdownType = "routine" +) + +// Which tier this directory belongs to +// Experimental: SkillDiscoveryScope is part of an experimental API and may change or be +// removed. +type SkillDiscoveryScope string + +const ( + // A configured custom skill directory. + SkillDiscoveryScopeCustom SkillDiscoveryScope = "custom" + // The user's personal agents skill directory. + SkillDiscoveryScopePersonalAgents SkillDiscoveryScope = "personal-agents" + // The user's personal Copilot skill directory. + SkillDiscoveryScopePersonalCopilot SkillDiscoveryScope = "personal-copilot" + // A project's repository skill directory. + SkillDiscoveryScopeProject SkillDiscoveryScope = "project" +) + +// Source location type (e.g., project, personal-copilot, plugin, builtin) +// Experimental: SkillSource is part of an experimental API and may change or be removed. +type SkillSource string + +const ( + // Skill bundled with the runtime. + SkillSourceBuiltin SkillSource = "builtin" + // Skill loaded from a configured custom skill directory. + SkillSourceCustom SkillSource = "custom" + // Skill discovered from a parent directory in the current workspace tree. + SkillSourceInherited SkillSource = "inherited" + // Skill defined in the user's personal agents skill directory. + SkillSourcePersonalAgents SkillSource = "personal-agents" + // Skill defined in the user's Copilot skill directory. + SkillSourcePersonalCopilot SkillSource = "personal-copilot" + // Skill provided by an installed plugin. + SkillSourcePlugin SkillSource = "plugin" + // Skill defined in the current project's skill directories. + SkillSourceProject SkillSource = "project" +) + +// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) +// Experimental: SlashCommandInputCompletion is part of an experimental API and may change +// or be removed. +type SlashCommandInputCompletion string + +const ( + // Input should complete filesystem directories. + SlashCommandInputCompletionDirectory SlashCommandInputCompletion = "directory" +) + +// Kind discriminator for SlashCommandInvocationResult. +type SlashCommandInvocationResultKind string + +const ( + SlashCommandInvocationResultKindAgentPrompt SlashCommandInvocationResultKind = "agent-prompt" + SlashCommandInvocationResultKindCompleted SlashCommandInvocationResultKind = "completed" + SlashCommandInvocationResultKindSelectSubcommand SlashCommandInvocationResultKind = "select-subcommand" + SlashCommandInvocationResultKindText SlashCommandInvocationResultKind = "text" +) + +// Coarse command category for grouping and behavior: runtime built-in, skill-backed +// command, or SDK/client-owned command +// Experimental: SlashCommandKind is part of an experimental API and may change or be +// removed. +type SlashCommandKind string + +const ( + // Command implemented by the runtime. + SlashCommandKindBuiltin SlashCommandKind = "builtin" + // Command registered by an SDK client or extension. + SlashCommandKindClient SlashCommandKind = "client" + // Command backed by a skill. + SlashCommandKindSkill SlashCommandKind = "skill" +) + +// Context tier override for matching subagents +// Experimental: SubagentSettingsEntryContextTier is part of an experimental API and may +// change or be removed. +type SubagentSettingsEntryContextTier string + +const ( + // Use the model's default context window. + SubagentSettingsEntryContextTierDefault SubagentSettingsEntryContextTier = "default" + // Inherit the parent session's effective context tier at dispatch time. + SubagentSettingsEntryContextTierInherit SubagentSettingsEntryContextTier = "inherit" + // Pin the subagent to the long-context tier when supported. + SubagentSettingsEntryContextTierLongContext SubagentSettingsEntryContextTier = "long_context" +) + +// Whether task execution is synchronously awaited or managed in the background +// Experimental: TaskExecutionMode is part of an experimental API and may change or be +// removed. +type TaskExecutionMode string + +const ( + // The task is managed in the background. + TaskExecutionModeBackground TaskExecutionMode = "background" + // The task was started with synchronous waiting. + TaskExecutionModeSync TaskExecutionMode = "sync" +) + +// Type discriminator for TaskInfo. +type TaskInfoType string + +const ( + TaskInfoTypeAgent TaskInfoType = "agent" + TaskInfoTypeShell TaskInfoType = "shell" +) + +// Type discriminator for TaskProgress. +type TaskProgressType string + +const ( + TaskProgressTypeAgent TaskProgressType = "agent" + TaskProgressTypeShell TaskProgressType = "shell" +) + +// Whether the shell runs inside a managed PTY session or as an independent background +// process +// Experimental: TaskShellInfoAttachmentMode is part of an experimental API and may change +// or be removed. +type TaskShellInfoAttachmentMode string + +const ( + // The shell runs in a managed PTY session. + TaskShellInfoAttachmentModeAttached TaskShellInfoAttachmentMode = "attached" + // The shell runs as an independent background process. + TaskShellInfoAttachmentModeDetached TaskShellInfoAttachmentMode = "detached" +) + +// Current lifecycle status of the task +// Experimental: TaskStatus is part of an experimental API and may change or be removed. +type TaskStatus string + +const ( + // The task was cancelled before completion. + TaskStatusCancelled TaskStatus = "cancelled" + // The task finished successfully. + TaskStatusCompleted TaskStatus = "completed" + // The task finished with an error. + TaskStatusFailed TaskStatus = "failed" + // The task is waiting for additional input. + TaskStatusIdle TaskStatus = "idle" + // The task is actively executing. + TaskStatusRunning TaskStatus = "running" +) + +// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist +// as setting), or no (decline). +// Experimental: UIAutoModeSwitchResponse is part of an experimental API and may change or +// be removed. +type UIAutoModeSwitchResponse string + +const ( + // Decline the automatic mode switch. + UIAutoModeSwitchResponseNo UIAutoModeSwitchResponse = "no" + // Allow the automatic mode switch for this turn. + UIAutoModeSwitchResponseYes UIAutoModeSwitchResponse = "yes" + // Allow this mode switch and persist the preference. + UIAutoModeSwitchResponseYesAlways UIAutoModeSwitchResponse = "yes_always" +) + +// Type discriminator. Always "string". +type UIElicitationArrayEnumFieldItemsType string + +const ( + UIElicitationArrayEnumFieldItemsTypeString UIElicitationArrayEnumFieldItemsType = "string" +) + +// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) +// Experimental: UIElicitationResponseAction is part of an experimental API and may change +// or be removed. +type UIElicitationResponseAction string + +const ( + // The user submitted the requested form values. + UIElicitationResponseActionAccept UIElicitationResponseAction = "accept" + // The user dismissed the elicitation request. + UIElicitationResponseActionCancel UIElicitationResponseAction = "cancel" + // The user explicitly declined to provide the requested input. + UIElicitationResponseActionDecline UIElicitationResponseAction = "decline" +) + +// Numeric type accepted by the field. +// Experimental: UIElicitationSchemaPropertyNumberType is part of an experimental API and +// may change or be removed. +type UIElicitationSchemaPropertyNumberType string + +const ( + // Integer JSON number. + UIElicitationSchemaPropertyNumberTypeInteger UIElicitationSchemaPropertyNumberType = "integer" + // Any JSON number. + UIElicitationSchemaPropertyNumberTypeNumber UIElicitationSchemaPropertyNumberType = "number" +) + +// Optional format hint that constrains the accepted input. +// Experimental: UIElicitationSchemaPropertyStringFormat is part of an experimental API and +// may change or be removed. +type UIElicitationSchemaPropertyStringFormat string + +const ( + // Calendar date string format. + UIElicitationSchemaPropertyStringFormatDate UIElicitationSchemaPropertyStringFormat = "date" + // Date-time string format. + UIElicitationSchemaPropertyStringFormatDateTime UIElicitationSchemaPropertyStringFormat = "date-time" + // Email address string format. + UIElicitationSchemaPropertyStringFormatEmail UIElicitationSchemaPropertyStringFormat = "email" + // URI string format. + UIElicitationSchemaPropertyStringFormatURI UIElicitationSchemaPropertyStringFormat = "uri" +) + +// Type discriminator for UIElicitationSchemaProperty. +type UIElicitationSchemaPropertyType string + +const ( + UIElicitationSchemaPropertyTypeArray UIElicitationSchemaPropertyType = "array" + UIElicitationSchemaPropertyTypeBoolean UIElicitationSchemaPropertyType = "boolean" + UIElicitationSchemaPropertyTypeInteger UIElicitationSchemaPropertyType = "integer" + UIElicitationSchemaPropertyTypeNumber UIElicitationSchemaPropertyType = "number" + UIElicitationSchemaPropertyTypeString UIElicitationSchemaPropertyType = "string" +) + +// Schema type indicator (always 'object') +type UIElicitationSchemaType string + +const ( + UIElicitationSchemaTypeObject UIElicitationSchemaType = "object" +) + +// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, +// otherwise 'interactive'. +// Experimental: UIExitPlanModeAction is part of an experimental API and may change or be +// removed. +type UIExitPlanModeAction string + +const ( + // Exit plan mode and continue in autopilot mode. + UIExitPlanModeActionAutopilot UIExitPlanModeAction = "autopilot" + // Exit plan mode and continue in autopilot mode with parallel subagent execution. + UIExitPlanModeActionAutopilotFleet UIExitPlanModeAction = "autopilot_fleet" + // Exit plan mode without starting implementation. + UIExitPlanModeActionExitOnly UIExitPlanModeAction = "exit_only" + // Exit plan mode and continue interactively. + UIExitPlanModeActionInteractive UIExitPlanModeAction = "interactive" +) + +// User action selected for an exhausted session limit. +// Experimental: UISessionLimitsExhaustedResponseAction is part of an experimental API and +// may change or be removed. +type UISessionLimitsExhaustedResponseAction string + +const ( + // Increase the current max by an exact AI Credits amount. + UISessionLimitsExhaustedResponseActionAdd UISessionLimitsExhaustedResponseAction = "add" + // Leave the limit unchanged and cancel the blocked model request. + UISessionLimitsExhaustedResponseActionCancel UISessionLimitsExhaustedResponseAction = "cancel" + // Set a new absolute max AI Credits value. + UISessionLimitsExhaustedResponseActionSet UISessionLimitsExhaustedResponseAction = "set" + // Remove the current session limit. + UISessionLimitsExhaustedResponseActionUnset UISessionLimitsExhaustedResponseAction = "unset" +) + +// Kind discriminator for UserToolSessionApproval. +type UserToolSessionApprovalKind string + +const ( + UserToolSessionApprovalKindCommands UserToolSessionApprovalKind = "commands" + UserToolSessionApprovalKindCustomTool UserToolSessionApprovalKind = "custom-tool" + UserToolSessionApprovalKindExtensionManagement UserToolSessionApprovalKind = "extension-management" + UserToolSessionApprovalKindExtensionPermissionAccess UserToolSessionApprovalKind = "extension-permission-access" + UserToolSessionApprovalKindFactory UserToolSessionApprovalKind = "factory" + UserToolSessionApprovalKindMCP UserToolSessionApprovalKind = "mcp" + UserToolSessionApprovalKindMemory UserToolSessionApprovalKind = "memory" + UserToolSessionApprovalKindRead UserToolSessionApprovalKind = "read" + UserToolSessionApprovalKindWrite UserToolSessionApprovalKind = "write" +) + +// Output verbosity level for supported models +// Experimental: Verbosity is part of an experimental API and may change or be removed. +type Verbosity string + +const ( + // Request a more detailed response. + VerbosityHigh Verbosity = "high" + // Request a terse response. + VerbosityLow Verbosity = "low" + // Request a medium amount of response detail. + VerbosityMedium Verbosity = "medium" +) + +// Type of change represented by this file diff. +// Experimental: WorkspaceDiffFileChangeType is part of an experimental API and may change +// or be removed. +type WorkspaceDiffFileChangeType string + +const ( + // The file was added. + WorkspaceDiffFileChangeTypeAdded WorkspaceDiffFileChangeType = "added" + // The file was deleted. + WorkspaceDiffFileChangeTypeDeleted WorkspaceDiffFileChangeType = "deleted" + // The file was modified. + WorkspaceDiffFileChangeTypeModified WorkspaceDiffFileChangeType = "modified" + // The file was renamed. + WorkspaceDiffFileChangeTypeRenamed WorkspaceDiffFileChangeType = "renamed" +) + +// Diff mode requested by the client. +// Experimental: WorkspaceDiffMode is part of an experimental API and may change or be +// removed. +type WorkspaceDiffMode string + +const ( + // Return changes compared with the default branch. + WorkspaceDiffModeBranch WorkspaceDiffMode = "branch" + // Return the cumulative diff of files Copilot changed this session (used in non-git + // workspaces). + WorkspaceDiffModeSession WorkspaceDiffMode = "session" + // Return staged, unstaged, and untracked working tree changes. + WorkspaceDiffModeUnstaged WorkspaceDiffMode = "unstaged" +) + +// Repository host type, if known +// Experimental: WorkspaceSummaryHostType is part of an experimental API and may change or +// be removed. +type WorkspaceSummaryHostType string + +const ( + // Workspace summary repository is hosted on Azure DevOps. + WorkspaceSummaryHostTypeADO WorkspaceSummaryHostType = "ado" + // Workspace summary repository is hosted on GitHub. + WorkspaceSummaryHostTypeGitHub WorkspaceSummaryHostType = "github" +) + +// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. +// Experimental: WorkspacesWorkspaceDetailsHostType is part of an experimental API and may +// change or be removed. +type WorkspacesWorkspaceDetailsHostType string + +const ( + // Workspace repository is hosted on Azure DevOps. + WorkspacesWorkspaceDetailsHostTypeADO WorkspacesWorkspaceDetailsHostType = "ado" + // Workspace repository is hosted on GitHub. + WorkspacesWorkspaceDetailsHostTypeGitHub WorkspacesWorkspaceDetailsHostType = "github" +) + +type serverAPI struct { + client *jsonrpc2.Client +} + +// Experimental: ServerAccountAPI contains experimental APIs that may change or be removed. +type ServerAccountAPI serverAPI + +// GetAllUsers gets all authenticated users available for account switching. +// +// RPC method: account.getAllUsers. +// +// Returns: List of all authenticated users +func (a *ServerAccountAPI) GetAllUsers(ctx context.Context) (*AccountGetAllUsersResult, error) { + raw, err := a.client.Request(ctx, "account.getAllUsers", nil) + if err != nil { + return nil, err + } + var result AccountGetAllUsersResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetCurrentAuth gets the currently active authentication credentials from the global auth +// manager. +// +// RPC method: account.getCurrentAuth. +// +// Returns: Current authentication state +func (a *ServerAccountAPI) GetCurrentAuth(ctx context.Context) (*AccountGetCurrentAuthResult, error) { + raw, err := a.client.Request(ctx, "account.getCurrentAuth", nil) + if err != nil { + return nil, err + } + var result AccountGetCurrentAuthResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetQuota gets Copilot quota usage for the authenticated user or supplied GitHub token. +// +// RPC method: account.getQuota. +// +// Parameters: Optional GitHub token used to look up quota for a specific user instead of +// the global auth context. +// +// Returns: Quota usage snapshots for the resolved user, keyed by quota type. +func (a *ServerAccountAPI) GetQuota(ctx context.Context, params *AccountGetQuotaRequest) (*AccountGetQuotaResult, error) { + raw, err := a.client.Request(ctx, "account.getQuota", params) + if err != nil { + return nil, err + } + var result AccountGetQuotaResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Login stores authentication credentials after successful login (e.g., device code flow). +// +// RPC method: account.login. +// +// Parameters: Credentials to store after successful authentication +// +// Returns: Result of a successful login; throws on failure +func (a *ServerAccountAPI) Login(ctx context.Context, params *AccountLoginRequest) (*AccountLoginResult, error) { + raw, err := a.client.Request(ctx, "account.login", params) + if err != nil { + return nil, err + } + var result AccountLoginResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Logout removes user authentication from keychain and persisted state. +// +// RPC method: account.logout. +// +// Parameters: User to log out +// +// Returns: Logout result indicating if more users remain +func (a *ServerAccountAPI) Logout(ctx context.Context, params *AccountLogoutRequest) (*AccountLogoutResult, error) { + raw, err := a.client.Request(ctx, "account.logout", params) + if err != nil { + return nil, err + } + var result AccountLogoutResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerAgentRegistryAPI contains experimental APIs that may change or be +// removed. +type ServerAgentRegistryAPI serverAPI + +// Spawns a managed-server child with the supplied configuration and returns a +// discriminated-union result. The caller (typically the CLI controller) is responsible for +// attaching to the spawned child and sending any follow-up prompt. When the +// controller-local spawn gate is closed the server returns JSON-RPC MethodNotFound. +// +// RPC method: agentRegistry.spawn. +// +// Parameters: Inputs to spawn a managed-server child via the controller's spawn delegate. +// +// Returns: Outcome of an agentRegistry.spawn call. +func (a *ServerAgentRegistryAPI) Spawn(ctx context.Context, params *AgentRegistrySpawnRequest) (AgentRegistrySpawnResult, error) { + raw, err := a.client.Request(ctx, "agentRegistry.spawn", params) + if err != nil { + return nil, err + } + result, err := unmarshalAgentRegistrySpawnResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + +// Experimental: ServerAgentsAPI contains experimental APIs that may change or be removed. +type ServerAgentsAPI serverAPI + +// Discovers custom agents across user, project, plugin, and remote sources. +// +// RPC method: agents.discover. +// +// Parameters: Optional project paths to include in agent discovery. +// +// Returns: Agents discovered across user, project, plugin, and remote sources. +func (a *ServerAgentsAPI) Discover(ctx context.Context, params *AgentsDiscoverRequest) (*ServerAgentList, error) { + raw, err := a.client.Request(ctx, "agents.discover", params) + if err != nil { + return nil, err + } + var result ServerAgentList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetDiscoveryPaths returns the canonical directories where a client may create custom +// agents that the runtime will recognize, including ones that do not exist yet. Project +// directories become active once created. +// +// RPC method: agents.getDiscoveryPaths. +// +// Parameters: Optional project paths to include when enumerating agent discovery +// directories. +// +// Returns: Canonical locations where custom agents can be created so the runtime will +// recognize them. +func (a *ServerAgentsAPI) GetDiscoveryPaths(ctx context.Context, params *AgentsGetDiscoveryPathsRequest) (*AgentDiscoveryPathList, error) { + raw, err := a.client.Request(ctx, "agents.getDiscoveryPaths", params) + if err != nil { + return nil, err + } + var result AgentDiscoveryPathList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerCommandsAPI contains experimental APIs that may change or be removed. +type ServerCommandsAPI serverAPI + +// Lists the well-known built-in slash commands that work as the first message in a new +// session (e.g. /plan, /env), without requiring an active session. Commands that depend on +// session state, authentication, or a synced session are omitted. +// +// RPC method: commands.list. +// +// Returns: Slash commands available in the session, after applying any include/exclude +// filters. +func (a *ServerCommandsAPI) List(ctx context.Context) (*CommandList, error) { + raw, err := a.client.Request(ctx, "commands.list", nil) + if err != nil { + return nil, err + } + var result CommandList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerExtensionsAPI contains experimental APIs that may change or be +// removed. +type ServerExtensionsAPI serverAPI + +// Disable persistently disables extension IDs for future sessions. Active sessions are +// unchanged; use session.extensions.disable to update them. +// +// RPC method: extensions.disable. +// +// Parameters: Source-qualified extension identifiers to persistently disable for future +// sessions. +func (a *ServerExtensionsAPI) Disable(ctx context.Context, params *DiscoveredExtensionsDisableRequest) (*ExtensionsDisableResult, error) { + raw, err := a.client.Request(ctx, "extensions.disable", params) + if err != nil { + return nil, err + } + var result ExtensionsDisableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Discovers user and enabled installed-plugin extensions from persisted Copilot home state, +// including enablement preferences. Launch-scoped additional plugins are not included. +// +// RPC method: extensions.discover. +// +// Returns: Extensions discovered from persisted Copilot home state and their effective +// loading mode. Launch-scoped additional plugins are not included. +func (a *ServerExtensionsAPI) Discover(ctx context.Context) (*DiscoveredExtensions, error) { + raw, err := a.client.Request(ctx, "extensions.discover", nil) + if err != nil { + return nil, err + } + var result DiscoveredExtensions + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Enable persistently enables extension IDs for future sessions. Active sessions are +// unchanged; use session.extensions.enable to update them. +// +// RPC method: extensions.enable. +// +// Parameters: Source-qualified extension identifiers to persistently enable for future +// sessions. +func (a *ServerExtensionsAPI) Enable(ctx context.Context, params *DiscoveredExtensionsEnableRequest) (*ExtensionsEnableResult, error) { + raw, err := a.client.Request(ctx, "extensions.enable", params) + if err != nil { + return nil, err + } + var result ExtensionsEnableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerInstructionsAPI contains experimental APIs that may change or be +// removed. +type ServerInstructionsAPI serverAPI + +// Discovers instruction sources across user, repository, and plugin sources. +// +// RPC method: instructions.discover. +// +// Parameters: Optional project paths to include in instruction discovery. +// +// Returns: Instruction sources discovered across user, repository, and plugin sources. +func (a *ServerInstructionsAPI) Discover(ctx context.Context, params *InstructionsDiscoverRequest) (*ServerInstructionSourceList, error) { + raw, err := a.client.Request(ctx, "instructions.discover", params) + if err != nil { + return nil, err + } + var result ServerInstructionSourceList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetDiscoveryPaths returns the canonical files and directories where a client may create +// custom instructions that the runtime will recognize, including ones that do not exist +// yet. Repository targets become active once created. +// +// RPC method: instructions.getDiscoveryPaths. +// +// Parameters: Optional project paths to include when enumerating instruction discovery +// targets. +// +// Returns: Canonical files and directories where custom instructions can be created so the +// runtime will recognize them. +func (a *ServerInstructionsAPI) GetDiscoveryPaths(ctx context.Context, params *InstructionsGetDiscoveryPathsRequest) (*InstructionDiscoveryPathList, error) { + raw, err := a.client.Request(ctx, "instructions.getDiscoveryPaths", params) + if err != nil { + return nil, err + } + var result InstructionDiscoveryPathList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerLlmInferenceAPI contains experimental APIs that may change or be +// removed. +type ServerLlmInferenceAPI serverAPI + +// HttpResponseChunk delivers a body byte range (or a terminal transport error) for an +// in-flight response, correlated by requestId. Set `end` true on the last chunk. When +// `error` is set the response terminates with a transport-level failure and the runtime +// raises an APIConnectionError. +// +// RPC method: llmInference.httpResponseChunk. +// +// Parameters: A response body chunk or terminal error. +// +// Returns: Whether the chunk was accepted. +func (a *ServerLlmInferenceAPI) HttpResponseChunk(ctx context.Context, params *LlmInferenceHTTPResponseChunkRequest) (*LlmInferenceHTTPResponseChunkResult, error) { + raw, err := a.client.Request(ctx, "llmInference.httpResponseChunk", params) + if err != nil { + return nil, err + } + var result LlmInferenceHTTPResponseChunkResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// HttpResponseStart delivers the response head (status + headers) for an in-flight request, +// correlated by the requestId the runtime supplied in httpRequestStart. Must be called +// exactly once per request before any httpResponseChunk frames. +// +// RPC method: llmInference.httpResponseStart. +// +// Parameters: Response head. +// +// Returns: Whether the start frame was accepted. +func (a *ServerLlmInferenceAPI) HttpResponseStart(ctx context.Context, params *LlmInferenceHTTPResponseStartRequest) (*LlmInferenceHTTPResponseStartResult, error) { + raw, err := a.client.Request(ctx, "llmInference.httpResponseStart", params) + if err != nil { + return nil, err + } + var result LlmInferenceHTTPResponseStartResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SetProvider registers an SDK client as the LLM inference callback provider. +// +// RPC method: llmInference.setProvider. +// +// Returns: Indicates whether the calling client was registered as the LLM inference +// provider. +func (a *ServerLlmInferenceAPI) SetProvider(ctx context.Context) (*LlmInferenceSetProviderResult, error) { + raw, err := a.client.Request(ctx, "llmInference.setProvider", nil) + if err != nil { + return nil, err + } + var result LlmInferenceSetProviderResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerManagedSettingsAPI contains experimental APIs that may change or be +// removed. +type ServerManagedSettingsAPI serverAPI + +// Read discovers device-managed settings from production MDM and managed-file sources, +// validates them against the runtime-owned managed-settings schema, and returns the +// canonical JSON without requiring a session. +// +// RPC method: managedSettings.read. +// +// Returns: Validated device-managed settings discovered before a session exists. +func (a *ServerManagedSettingsAPI) Read(ctx context.Context) (*ManagedSettingsReadResult, error) { + raw, err := a.client.Request(ctx, "managedSettings.read", nil) + if err != nil { + return nil, err + } + var result ManagedSettingsReadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerMCPAPI contains experimental APIs that may change or be removed. +type ServerMCPAPI serverAPI + +// Discovers MCP servers from user, workspace, plugin, and builtin sources. +// +// RPC method: mcp.discover. +// +// Parameters: Optional working directory used as context for MCP server discovery. +// +// Returns: MCP servers discovered from user, workspace, plugin, and built-in sources. +func (a *ServerMCPAPI) Discover(ctx context.Context, params *MCPDiscoverRequest) (*MCPDiscoverResult, error) { + raw, err := a.client.Request(ctx, "mcp.discover", params) + if err != nil { + return nil, err + } + var result MCPDiscoverResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerMCPConfigAPI contains experimental APIs that may change or be removed. +type ServerMCPConfigAPI serverAPI + +// Adds an MCP server to user configuration. +// +// RPC method: mcp.config.add. +// +// Parameters: MCP server name and configuration to add to user configuration. +func (a *ServerMCPConfigAPI) Add(ctx context.Context, params *MCPConfigAddRequest) (*MCPConfigAddResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.add", params) + if err != nil { + return nil, err + } + var result MCPConfigAddResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Disables MCP servers in user configuration for new sessions. +// +// RPC method: mcp.config.disable. +// +// Parameters: MCP server names to disable for new sessions. +func (a *ServerMCPConfigAPI) Disable(ctx context.Context, params *MCPConfigDisableRequest) (*MCPConfigDisableResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.disable", params) + if err != nil { + return nil, err + } + var result MCPConfigDisableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Enables MCP servers in user configuration for new sessions. +// +// RPC method: mcp.config.enable. +// +// Parameters: MCP server names to enable for new sessions. +func (a *ServerMCPConfigAPI) Enable(ctx context.Context, params *MCPConfigEnableRequest) (*MCPConfigEnableResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.enable", params) + if err != nil { + return nil, err + } + var result MCPConfigEnableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists MCP servers from user configuration. +// +// RPC method: mcp.config.list. +// +// Returns: User-configured MCP servers, keyed by server name. +func (a *ServerMCPConfigAPI) List(ctx context.Context) (*MCPConfigList, error) { + raw, err := a.client.Request(ctx, "mcp.config.list", nil) + if err != nil { + return nil, err + } + var result MCPConfigList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Reload drops this runtime process's in-memory MCP server-definition cache so the next MCP +// config read observes disk. +// +// RPC method: mcp.config.reload. +func (a *ServerMCPConfigAPI) Reload(ctx context.Context) (*MCPConfigReloadResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.reload", nil) + if err != nil { + return nil, err + } + var result MCPConfigReloadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Removes an MCP server from user configuration. +// +// RPC method: mcp.config.remove. +// +// Parameters: MCP server name to remove from user configuration. +func (a *ServerMCPConfigAPI) Remove(ctx context.Context, params *MCPConfigRemoveRequest) (*MCPConfigRemoveResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.remove", params) + if err != nil { + return nil, err + } + var result MCPConfigRemoveResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Updates an MCP server in user configuration. +// +// RPC method: mcp.config.update. +// +// Parameters: MCP server name and replacement configuration to write to user configuration. +func (a *ServerMCPConfigAPI) Update(ctx context.Context, params *MCPConfigUpdateRequest) (*MCPConfigUpdateResult, error) { + raw, err := a.client.Request(ctx, "mcp.config.update", params) + if err != nil { + return nil, err + } + var result MCPConfigUpdateResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Config returns experimental APIs that may change or be removed. +func (s *ServerMCPAPI) Config() *ServerMCPConfigAPI { + return (*ServerMCPConfigAPI)(s) +} + +// Experimental: ServerModelsAPI contains experimental APIs that may change or be removed. +type ServerModelsAPI serverAPI + +// GetBuiltInCatalog returns the running runtime's complete catalog of well-known built-in +// model IDs without authentication or network access. +// +// RPC method: models.getBuiltInCatalog. +// +// Returns: The running runtime's complete catalog of well-known built-in model IDs, +// including supported models and additional IDs with built-in metadata. +func (a *ServerModelsAPI) GetBuiltInCatalog(ctx context.Context) (*BuiltInModelCatalog, error) { + raw, err := a.client.Request(ctx, "models.getBuiltInCatalog", nil) + if err != nil { + return nil, err + } + var result BuiltInModelCatalog + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists Copilot models available to the authenticated user. +// +// RPC method: models.list. +// +// Parameters: Optional GitHub token used to list models for a specific user instead of the +// global auth context. +// +// Returns: List of Copilot models available to the resolved user, including capabilities +// and billing metadata. +func (a *ServerModelsAPI) List(ctx context.Context, params *ModelsListRequest) (*ModelList, error) { + raw, err := a.client.Request(ctx, "models.list", params) + if err != nil { + return nil, err + } + var result ModelList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerPluginsAPI contains experimental APIs that may change or be removed. +type ServerPluginsAPI serverAPI + +// Disables installed plugins for new sessions. +// +// RPC method: plugins.disable. +// +// Parameters: Plugin names (or specs) to disable. +func (a *ServerPluginsAPI) Disable(ctx context.Context, params *PluginsDisableRequest) (*PluginsDisableResult, error) { + raw, err := a.client.Request(ctx, "plugins.disable", params) + if err != nil { + return nil, err + } + var result PluginsDisableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Enables installed plugins for new sessions. +// +// RPC method: plugins.enable. +// +// Parameters: Plugin names (or specs) to enable. +func (a *ServerPluginsAPI) Enable(ctx context.Context, params *PluginsEnableRequest) (*PluginsEnableResult, error) { + raw, err := a.client.Request(ctx, "plugins.enable", params) + if err != nil { + return nil, err + } + var result PluginsEnableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Installs a plugin from a marketplace, GitHub repo, URL, or local path. +// +// RPC method: plugins.install. +// +// Parameters: Plugin source and optional working directory for relative-path resolution. +// +// Returns: Result of installing a plugin. +func (a *ServerPluginsAPI) Install(ctx context.Context, params *PluginsInstallRequest) (*PluginInstallResult, error) { + raw, err := a.client.Request(ctx, "plugins.install", params) + if err != nil { + return nil, err + } + var result PluginInstallResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists plugins installed in user/global state. +// +// RPC method: plugins.list. +// +// Returns: Plugins installed in user/global state. +func (a *ServerPluginsAPI) List(ctx context.Context) (*PluginListResult, error) { + raw, err := a.client.Request(ctx, "plugins.list", nil) + if err != nil { + return nil, err + } + var result PluginListResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Uninstalls an installed plugin. +// +// RPC method: plugins.uninstall. +// +// Parameters: Name (or spec) of the plugin to uninstall. +func (a *ServerPluginsAPI) Uninstall(ctx context.Context, params *PluginsUninstallRequest) (*PluginsUninstallResult, error) { + raw, err := a.client.Request(ctx, "plugins.uninstall", params) + if err != nil { + return nil, err + } + var result PluginsUninstallResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Updates an installed plugin to its latest published version. +// +// RPC method: plugins.update. +// +// Parameters: Name (or spec) of the plugin to update. +// +// Returns: Result of updating a single plugin. +func (a *ServerPluginsAPI) Update(ctx context.Context, params *PluginsUpdateRequest) (*PluginUpdateResult, error) { + raw, err := a.client.Request(ctx, "plugins.update", params) + if err != nil { + return nil, err + } + var result PluginUpdateResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// UpdateAll updates every installed plugin to its latest published version. +// +// RPC method: plugins.updateAll. +// +// Returns: Result of updating all installed plugins. +func (a *ServerPluginsAPI) UpdateAll(ctx context.Context) (*PluginUpdateAllResult, error) { + raw, err := a.client.Request(ctx, "plugins.updateAll", nil) + if err != nil { + return nil, err + } + var result PluginUpdateAllResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerPluginsMarketplacesAPI contains experimental APIs that may change or +// be removed. +type ServerPluginsMarketplacesAPI serverAPI + +// Add registers a new marketplace from a source (owner/repo, URL, or local path). +// +// RPC method: plugins.marketplaces.add. +// +// Parameters: Marketplace source and optional working directory for relative-path +// resolution. +// +// Returns: Result of registering a new marketplace. +func (a *ServerPluginsMarketplacesAPI) Add(ctx context.Context, params *PluginsMarketplacesAddRequest) (*MarketplaceAddResult, error) { + raw, err := a.client.Request(ctx, "plugins.marketplaces.add", params) + if err != nil { + return nil, err + } + var result MarketplaceAddResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Browse lists plugins advertised by a registered marketplace. +// +// RPC method: plugins.marketplaces.browse. +// +// Parameters: Name of the marketplace whose plugin catalog to fetch. +// +// Returns: Plugins advertised by the marketplace. +func (a *ServerPluginsMarketplacesAPI) Browse(ctx context.Context, params *PluginsMarketplacesBrowseRequest) (*MarketplaceBrowseResult, error) { + raw, err := a.client.Request(ctx, "plugins.marketplaces.browse", params) + if err != nil { + return nil, err + } + var result MarketplaceBrowseResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists all registered marketplaces (defaults + user-added). +// +// RPC method: plugins.marketplaces.list. +// +// Returns: All registered marketplaces, including built-in defaults. +func (a *ServerPluginsMarketplacesAPI) List(ctx context.Context) (*MarketplaceListResult, error) { + raw, err := a.client.Request(ctx, "plugins.marketplaces.list", nil) + if err != nil { + return nil, err + } + var result MarketplaceListResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Refresh re-fetches one or all registered marketplace catalogs. +// +// RPC method: plugins.marketplaces.refresh. +// +// Parameters: Optional marketplace name; omit to refresh all. +// +// Returns: Result of refreshing one or more marketplace catalogs. +func (a *ServerPluginsMarketplacesAPI) Refresh(ctx context.Context, params *PluginsMarketplacesRefreshRequest) (*MarketplaceRefreshResult, error) { + raw, err := a.client.Request(ctx, "plugins.marketplaces.refresh", params) + if err != nil { + return nil, err + } + var result MarketplaceRefreshResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Removes a previously-registered marketplace. When the marketplace has dependent plugins +// and `force` is not set, the marketplace is left intact and the result lists the +// dependents so the caller can decide whether to retry with `force=true`. +// +// RPC method: plugins.marketplaces.remove. +// +// Parameters: Name of the marketplace to remove and an optional force flag. +// +// Returns: Outcome of the remove attempt, including dependent-plugin info when applicable. +func (a *ServerPluginsMarketplacesAPI) Remove(ctx context.Context, params *PluginsMarketplacesRemoveRequest) (*MarketplaceRemoveResult, error) { + raw, err := a.client.Request(ctx, "plugins.marketplaces.remove", params) + if err != nil { + return nil, err + } + var result MarketplaceRemoveResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Marketplaces returns experimental APIs that may change or be removed. +func (s *ServerPluginsAPI) Marketplaces() *ServerPluginsMarketplacesAPI { + return (*ServerPluginsMarketplacesAPI)(s) +} + +// Experimental: ServerRuntimeAPI contains experimental APIs that may change or be removed. +type ServerRuntimeAPI serverAPI + +// Shutdown gracefully shuts down an SDK-owned runtime. The response is sent only after +// cleanup completes; callers may then terminate the owned runtime process. +// +// RPC method: runtime.shutdown. +func (a *ServerRuntimeAPI) Shutdown(ctx context.Context) (*RuntimeShutdownResult, error) { + raw, err := a.client.Request(ctx, "runtime.shutdown", nil) + if err != nil { + return nil, err + } + var result RuntimeShutdownResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerSecretsAPI contains experimental APIs that may change or be removed. +type ServerSecretsAPI serverAPI + +// AddFilterValues registers secret values for redaction in session logs and exports. The +// SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens). +// +// RPC method: secrets.addFilterValues. +// +// Parameters: Secret values to add to the redaction filter. +// +// Returns: Confirmation that the secret values were registered. +func (a *ServerSecretsAPI) AddFilterValues(ctx context.Context, params *SecretsAddFilterValuesRequest) (*SecretsAddFilterValuesResult, error) { + raw, err := a.client.Request(ctx, "secrets.addFilterValues", params) + if err != nil { + return nil, err + } + var result SecretsAddFilterValuesResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerSessionFSAPI contains experimental APIs that may change or be removed. +type ServerSessionFSAPI serverAPI + +// SetProvider registers an SDK client as the session filesystem provider. +// +// RPC method: sessionFs.setProvider. +// +// Parameters: Initial working directory, session-state path layout, and path conventions +// used to register the calling SDK client as the session filesystem provider. +// +// Returns: Indicates whether the calling client was registered as the session filesystem +// provider. +func (a *ServerSessionFSAPI) SetProvider(ctx context.Context, params *SessionFSSetProviderRequest) (*SessionFSSetProviderResult, error) { + raw, err := a.client.Request(ctx, "sessionFs.setProvider", params) + if err != nil { + return nil, err + } + var result SessionFSSetProviderResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerSessionsAPI contains experimental APIs that may change or be removed. +type ServerSessionsAPI serverAPI + +// BulkDelete closes, deactivates, and deletes a set of sessions, returning the bytes freed +// per session. +// +// RPC method: sessions.bulkDelete. +// +// Parameters: Session IDs to close, deactivate, and delete from disk. +// +// Returns: Map of sessionId -> bytes freed by removing the session's workspace directory. +func (a *ServerSessionsAPI) BulkDelete(ctx context.Context, params *SessionsBulkDeleteRequest) (*SessionBulkDeleteResult, error) { + raw, err := a.client.Request(ctx, "sessions.bulkDelete", params) + if err != nil { + return nil, err + } + var result SessionBulkDeleteResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// CheckInUse returns the subset of the supplied session IDs that are currently held by +// another running process. +// +// RPC method: sessions.checkInUse. +// +// Parameters: Session IDs to test for live in-use locks. +// +// Returns: Session IDs from the input set that are currently in use by another process. +func (a *ServerSessionsAPI) CheckInUse(ctx context.Context, params *SessionsCheckInUseRequest) (*SessionsCheckInUseResult, error) { + raw, err := a.client.Request(ctx, "sessions.checkInUse", params) + if err != nil { + return nil, err + } + var result SessionsCheckInUseResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and +// disposes the active session. +// +// RPC method: sessions.close. +// +// Parameters: Session ID to close. +// +// Returns: Closes a session: emits shutdown, flushes pending events to disk, releases the +// in-use lock, disposes the active session. Idempotent: succeeds even if the session is not +// currently active. +func (a *ServerSessionsAPI) Close(ctx context.Context, params *SessionsCloseRequest) (*SessionsCloseResult, error) { + raw, err := a.client.Request(ctx, "sessions.close", params) + if err != nil { + return nil, err + } + var result SessionsCloseResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Connects to an existing remote session and exposes it as an SDK session. +// +// RPC method: sessions.connect. +// +// Parameters: Remote session connection parameters. +// +// Returns: Remote session connection result. +func (a *ServerSessionsAPI) Connect(ctx context.Context, params *ConnectRemoteSessionParams) (*RemoteSessionConnectionResult, error) { + raw, err := a.client.Request(ctx, "sessions.connect", params) + if err != nil { + return nil, err + } + var result RemoteSessionConnectionResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// EnrichMetadata backfills missing summary and context fields on the supplied session +// metadata records. +// +// RPC method: sessions.enrichMetadata. +// +// Parameters: Session metadata records to enrich with summary and context information. +// +// Returns: The enriched metadata records, with summary and context fields backfilled where +// available. Sessions confirmed empty and unnamed are omitted. +func (a *ServerSessionsAPI) EnrichMetadata(ctx context.Context, params *SessionsEnrichMetadataRequest) (*SessionEnrichMetadataResult, error) { + raw, err := a.client.Request(ctx, "sessions.enrichMetadata", params) + if err != nil { + return nil, err + } + var result SessionEnrichMetadataResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// FindByPrefix resolves a UUID prefix to a unique session ID, if exactly one session +// matches. +// +// RPC method: sessions.findByPrefix. +// +// Parameters: UUID prefix to resolve to a unique session ID. +// +// Returns: Session ID matching the prefix, omitted when no unique match exists. +func (a *ServerSessionsAPI) FindByPrefix(ctx context.Context, params *SessionsFindByPrefixRequest) (*SessionsFindByPrefixResult, error) { + raw, err := a.client.Request(ctx, "sessions.findByPrefix", params) + if err != nil { + return nil, err + } + var result SessionsFindByPrefixResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// FindByTaskId finds the local session bound to a GitHub task ID, if any. +// +// RPC method: sessions.findByTaskId. +// +// Parameters: GitHub task ID to look up. +// +// Returns: ID of the local session bound to the given GitHub task, or omitted when none. +func (a *ServerSessionsAPI) FindByTaskId(ctx context.Context, params *SessionsFindByTaskIDRequest) (*SessionsFindByTaskIDResult, error) { + raw, err := a.client.Request(ctx, "sessions.findByTaskId", params) + if err != nil { + return nil, err + } + var result SessionsFindByTaskIDResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Fork creates a new session by forking persisted history from an existing session. +// +// RPC method: sessions.fork. +// +// Parameters: Source session identifier to fork from, optional event-ID boundary, and +// optional friendly name for the new session. +// +// Returns: Identifier and optional friendly name assigned to the newly forked session. +func (a *ServerSessionsAPI) Fork(ctx context.Context, params *SessionsForkRequest) (*SessionsForkResult, error) { + raw, err := a.client.Request(ctx, "sessions.fork", params) + if err != nil { + return nil, err + } + var result SessionsForkResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetLastForContext returns the most-relevant prior session for a given working-directory +// context. +// +// RPC method: sessions.getLastForContext. +// +// Parameters: Optional working-directory context used to score session relevance. +// +// Returns: Most-relevant session ID for the supplied context, or omitted when no sessions +// exist. +func (a *ServerSessionsAPI) GetLastForContext(ctx context.Context, params *SessionsGetLastForContextRequest) (*SessionsGetLastForContextResult, error) { + raw, err := a.client.Request(ctx, "sessions.getLastForContext", params) + if err != nil { + return nil, err + } + var result SessionsGetLastForContextResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetRemoteControlStatus returns the current state of the remote-control singleton, +// including the attached session id and frontend URL when active. +// +// RPC method: sessions.getRemoteControlStatus. +// +// Returns: Wrapper for the singleton's current status. +func (a *ServerSessionsAPI) GetRemoteControlStatus(ctx context.Context) (*RemoteControlStatusResult, error) { + raw, err := a.client.Request(ctx, "sessions.getRemoteControlStatus", nil) + if err != nil { + return nil, err + } + var result RemoteControlStatusResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetSizes returns the on-disk byte size of each session's workspace directory. +// +// RPC method: sessions.getSizes. +// +// Returns: Map of sessionId -> on-disk size in bytes for each session's workspace directory. +func (a *ServerSessionsAPI) GetSizes(ctx context.Context) (*SessionSizes, error) { + raw, err := a.client.Request(ctx, "sessions.getSizes", nil) + if err != nil { + return nil, err + } + var result SessionSizes + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists sessions, optionally filtered by source and working-directory context. Returned +// entries are discriminated by `isRemote`: local entries carry only the lightweight +// `LocalSessionMetadataValue` shape; remote entries carry the full +// `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.). +// +// RPC method: sessions.list. +// +// Parameters: Optional source filter, metadata-load limit, and context filter applied to +// the returned sessions. +// +// Returns: Sessions matching the filter, ordered most-recently-modified first. +func (a *ServerSessionsAPI) List(ctx context.Context, params *SessionsListRequest) (*SessionList, error) { + raw, err := a.client.Request(ctx, "sessions.list", params) + if err != nil { + return nil, err + } + var result SessionList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// LoadDeferredRepoHooks loads previously-deferred repo-level hooks on the active session, +// returning queued startup prompts. +// +// RPC method: sessions.loadDeferredRepoHooks. +// +// Parameters: Active session ID whose deferred repo-level hooks should be loaded. +// +// Returns: Queued repo-level startup prompts and the total hook command count after loading. +func (a *ServerSessionsAPI) LoadDeferredRepoHooks(ctx context.Context, params *SessionsLoadDeferredRepoHooksRequest) (*SessionLoadDeferredRepoHooksResult, error) { + raw, err := a.client.Request(ctx, "sessions.loadDeferredRepoHooks", params) + if err != nil { + return nil, err + } + var result SessionLoadDeferredRepoHooksResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Open creates or resumes a local session and returns the opened session ID. +// +// RPC method: sessions.open. +// +// Parameters: Open a session by creating, resuming, attaching, connecting to a remote, or +// handing off. +// +// Returns: Result of opening a session. +func (a *ServerSessionsAPI) Open(ctx context.Context, params *SessionOpenParams) (*SessionOpenResult, error) { + raw, err := a.client.Request(ctx, "sessions.open", params) + if err != nil { + return nil, err + } + var result SessionOpenResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// PruneOld deletes sessions older than the given threshold, with optional dry-run and +// exclusion list. +// +// RPC method: sessions.pruneOld. +// +// Parameters: Age threshold and optional flags controlling which old sessions are pruned +// (or simulated when dryRun is true). +// +// Returns: Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, +// total bytes freed, and the dry-run flag. +func (a *ServerSessionsAPI) PruneOld(ctx context.Context, params *SessionsPruneOldRequest) (*SessionPruneResult, error) { + raw, err := a.client.Request(ctx, "sessions.pruneOld", params) + if err != nil { + return nil, err + } + var result SessionPruneResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ReleaseLock releases the in-use lock held by this process for a session. +// +// RPC method: sessions.releaseLock. +// +// Parameters: Session ID whose in-use lock should be released. +// +// Returns: Release the in-use lock held by this process for the given session. No-op when +// this process does not currently hold a lock for the session. +func (a *ServerSessionsAPI) ReleaseLock(ctx context.Context, params *SessionsReleaseLockRequest) (*SessionsReleaseLockResult, error) { + raw, err := a.client.Request(ctx, "sessions.releaseLock", params) + if err != nil { + return nil, err + } + var result SessionsReleaseLockResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ReloadPluginHooks reloads user, plugin, and (optionally) repo hooks on the active session. +// +// RPC method: sessions.reloadPluginHooks. +// +// Parameters: Active session ID and an optional flag for deferring repo-level hooks until +// folder trust. +// +// Returns: Reload all hooks (user, plugin, optionally repo) and apply them to the active +// session. Call after installing or removing plugins so their hooks take effect +// immediately. No-op when no active session matches the given sessionId. +func (a *ServerSessionsAPI) ReloadPluginHooks(ctx context.Context, params *SessionsReloadPluginHooksRequest) (*SessionsReloadPluginHooksResult, error) { + raw, err := a.client.Request(ctx, "sessions.reloadPluginHooks", params) + if err != nil { + return nil, err + } + var result SessionsReloadPluginHooksResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Save flushes a session's pending events to disk. +// +// RPC method: sessions.save. +// +// Parameters: Session ID whose pending events should be flushed to disk. +// +// Returns: Flush a session's pending events to disk. No-op when no writer exists for the +// session (e.g., already closed). +func (a *ServerSessionsAPI) Save(ctx context.Context, params *SessionsSaveRequest) (*SessionsSaveResult, error) { + raw, err := a.client.Request(ctx, "sessions.save", params) + if err != nil { + return nil, err + } + var result SessionsSaveResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SetAdditionalPlugins replaces the manager-wide additional plugins registered with the +// session manager. +// +// RPC method: sessions.setAdditionalPlugins. +// +// Parameters: Manager-wide additional plugins to register; replaces any +// previously-configured set. +// +// Returns: Replace the manager-wide additional plugins. New session creations and +// subsequent hook reloads see the new set; already-running sessions keep their existing +// hook installation until the next reload. +func (a *ServerSessionsAPI) SetAdditionalPlugins(ctx context.Context, params *SessionsSetAdditionalPluginsRequest) (*SessionsSetAdditionalPluginsResult, error) { + raw, err := a.client.Request(ctx, "sessions.setAdditionalPlugins", params) + if err != nil { + return nil, err + } + var result SessionsSetAdditionalPluginsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SetRemoteControlSteering patches the steering state of the active remote-control +// singleton. When remote control is off, this is a no-op and the off status is returned. +// Today only `enabled: true` is actionable on the underlying exporter; passing `false` is +// reserved for future use. +// +// RPC method: sessions.setRemoteControlSteering. +// +// Parameters: Patch for the singleton's steering state. +// +// Returns: Wrapper for the singleton's current status. +func (a *ServerSessionsAPI) SetRemoteControlSteering(ctx context.Context, params *SessionsSetRemoteControlSteeringRequest) (*RemoteControlStatusResult, error) { + raw, err := a.client.Request(ctx, "sessions.setRemoteControlSteering", params) + if err != nil { + return nil, err + } + var result RemoteControlStatusResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// StartRemoteControl attaches the runtime-managed remote-control singleton to a session, +// awaiting initial setup. If remote control is already attached to a different session, the +// singleton is transferred (preserving the underlying Mission Control connection). Returns +// the final status. +// +// RPC method: sessions.startRemoteControl. +// +// Parameters: Parameters for attaching the remote-control singleton to a session. +// +// Returns: Wrapper for the singleton's current status. +func (a *ServerSessionsAPI) StartRemoteControl(ctx context.Context, params *SessionsStartRemoteControlRequest) (*RemoteControlStatusResult, error) { + raw, err := a.client.Request(ctx, "sessions.startRemoteControl", params) + if err != nil { + return nil, err + } + var result RemoteControlStatusResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// StopRemoteControl stops the remote-control singleton. When `expectedSessionId` is +// provided and does not match the singleton's current `attachedSessionId`, the stop is +// rejected with `stopped: false` and the current status is returned unchanged (unless +// `force` is set, in which case the singleton is unconditionally torn down). +// +// RPC method: sessions.stopRemoteControl. +// +// Parameters: Parameters for stopping the remote-control singleton. +// +// Returns: Outcome of a stopRemoteControl call. +func (a *ServerSessionsAPI) StopRemoteControl(ctx context.Context, params *SessionsStopRemoteControlRequest) (*RemoteControlStopResult, error) { + raw, err := a.client.Request(ctx, "sessions.stopRemoteControl", params) + if err != nil { + return nil, err + } + var result RemoteControlStopResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// TransferRemoteControl atomically rebinds the remote-control singleton to a different +// session, preserving the underlying Mission Control connection. When +// `expectedFromSessionId` is provided and does not match the singleton's current +// `attachedSessionId`, the transfer is rejected with `transferred: false` and the current +// status is returned unchanged. +// +// RPC method: sessions.transferRemoteControl. +// +// Parameters: Parameters for atomically rebinding the remote-control singleton. +// +// Returns: Outcome of a transferRemoteControl call. +func (a *ServerSessionsAPI) TransferRemoteControl(ctx context.Context, params *SessionsTransferRemoteControlRequest) (*RemoteControlTransferResult, error) { + raw, err := a.client.Request(ctx, "sessions.transferRemoteControl", params) + if err != nil { + return nil, err + } + var result RemoteControlTransferResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerSkillsAPI contains experimental APIs that may change or be removed. +type ServerSkillsAPI serverAPI + +// Discovers skills across global and project sources. +// +// RPC method: skills.discover. +// +// Parameters: Optional project paths and additional skill directories to include in +// discovery. +// +// Returns: Skills discovered across global and project sources. +func (a *ServerSkillsAPI) Discover(ctx context.Context, params *SkillsDiscoverRequest) (*ServerSkillList, error) { + raw, err := a.client.Request(ctx, "skills.discover", params) + if err != nil { + return nil, err + } + var result ServerSkillList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetDiscoveryPaths returns the canonical directories where a client may create skills that +// the runtime will recognize, including ones that do not exist yet. Project directories +// become active once created. +// +// RPC method: skills.getDiscoveryPaths. +// +// Parameters: Optional project paths to enumerate. +// +// Returns: Canonical locations where skills can be created so the runtime will recognize +// them. +func (a *ServerSkillsAPI) GetDiscoveryPaths(ctx context.Context, params *SkillsGetDiscoveryPathsRequest) (*SkillDiscoveryPathList, error) { + raw, err := a.client.Request(ctx, "skills.getDiscoveryPaths", params) + if err != nil { + return nil, err + } + var result SkillDiscoveryPathList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerSkillsConfigAPI contains experimental APIs that may change or be +// removed. +type ServerSkillsConfigAPI serverAPI + +// SetDisabledSkills replaces the global list of disabled skills. +// +// RPC method: skills.config.setDisabledSkills. +// +// Parameters: Skill names to mark as disabled in global configuration, replacing any +// previous list. +func (a *ServerSkillsConfigAPI) SetDisabledSkills(ctx context.Context, params *SkillsConfigSetDisabledSkillsRequest) (*SkillsConfigSetDisabledSkillsResult, error) { + raw, err := a.client.Request(ctx, "skills.config.setDisabledSkills", params) + if err != nil { + return nil, err + } + var result SkillsConfigSetDisabledSkillsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Config returns experimental APIs that may change or be removed. +func (s *ServerSkillsAPI) Config() *ServerSkillsConfigAPI { + return (*ServerSkillsConfigAPI)(s) +} + +// Experimental: ServerToolsAPI contains experimental APIs that may change or be removed. +type ServerToolsAPI serverAPI + +// Lists built-in tools available for a model. +// +// RPC method: tools.list. +// +// Parameters: Optional model identifier whose tool overrides should be applied to the +// listing. +// +// Returns: Built-in tools available for the requested model, with their parameters and +// instructions. +func (a *ServerToolsAPI) List(ctx context.Context, params *ToolsListRequest) (*ToolList, error) { + raw, err := a.client.Request(ctx, "tools.list", params) + if err != nil { + return nil, err + } + var result ToolList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ServerUserAPI contains experimental APIs that may change or be removed. +type ServerUserAPI serverAPI + +// Experimental: ServerUserSettingsAPI contains experimental APIs that may change or be +// removed. +type ServerUserSettingsAPI serverAPI + +// Get lists every known user setting (settings.json overlaid with the legacy config.json, +// config.json wins), each with its effective value, its default, and whether it is at the +// default — so settings the user has never set still appear with their default value. Does +// not include repository- or enterprise-managed overrides that the runtime layers on top at +// session time. +// +// RPC method: user.settings.get. +// +// Returns: Per-key metadata for every known user setting (settings.json overlaid with the +// legacy config.json, config.json wins), including settings left at their default. Excludes +// repository- and enterprise-managed overrides. +func (a *ServerUserSettingsAPI) Get(ctx context.Context) (*UserSettingsGetResult, error) { + raw, err := a.client.Request(ctx, "user.settings.get", nil) + if err != nil { + return nil, err + } + var result UserSettingsGetResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Reload drops this runtime process's in-memory user settings cache so the next settings +// read observes disk. +// +// RPC method: user.settings.reload. +func (a *ServerUserSettingsAPI) Reload(ctx context.Context) (*UserSettingsReloadResult, error) { + raw, err := a.client.Request(ctx, "user.settings.reload", nil) + if err != nil { + return nil, err + } + var result UserSettingsReloadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Set writes one or more user settings to settings.json, replacing each provided top-level +// key. A key whose value is null is removed. Returns the keys whose new value is shadowed +// by a legacy config.json entry (config.json wins on read), which the runtime leaves in +// place — such writes do not take effect until the legacy value is removed. +// +// RPC method: user.settings.set. +// +// Parameters: Partial user settings to write to settings.json. Each top-level key is +// written individually, replacing the existing value; a key whose value is null is removed. +// +// Returns: Outcome of writing user settings. +func (a *ServerUserSettingsAPI) Set(ctx context.Context, params *UserSettingsSetRequest) (*UserSettingsSetResult, error) { + raw, err := a.client.Request(ctx, "user.settings.set", params) + if err != nil { + return nil, err + } + var result UserSettingsSetResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Settings returns experimental APIs that may change or be removed. +func (s *ServerUserAPI) Settings() *ServerUserSettingsAPI { + return (*ServerUserSettingsAPI)(s) +} + +// ServerRPC provides typed server-scoped RPC methods. +type ServerRPC struct { + // Reuse a single struct instead of allocating one for each service on the heap. + common serverAPI + + Account *ServerAccountAPI + AgentRegistry *ServerAgentRegistryAPI + Agents *ServerAgentsAPI + Commands *ServerCommandsAPI + Extensions *ServerExtensionsAPI + Instructions *ServerInstructionsAPI + LlmInference *ServerLlmInferenceAPI + ManagedSettings *ServerManagedSettingsAPI + MCP *ServerMCPAPI + Models *ServerModelsAPI + Plugins *ServerPluginsAPI + Runtime *ServerRuntimeAPI + Secrets *ServerSecretsAPI + SessionFS *ServerSessionFSAPI + Sessions *ServerSessionsAPI + Skills *ServerSkillsAPI + Tools *ServerToolsAPI + User *ServerUserAPI +} + +// Ping checks server responsiveness and returns protocol information. +// +// RPC method: ping. +// +// Parameters: Optional message to echo back to the caller. +// +// Returns: Server liveness response, including the echoed message, current server +// timestamp, and protocol version. +// Experimental: Ping is an experimental API and may change or be removed in future versions. +func (a *ServerRPC) Ping(ctx context.Context, params *PingRequest) (*PingResult, error) { + raw, err := a.common.client.Request(ctx, "ping", params) + if err != nil { + return nil, err + } + var result PingResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RegisterExtensionLaunchProvider registers the calling SDK client as the per-entrypoint +// extension launch provider. Call before creating any sessions. When omitted, the runtime +// temporarily falls back to its built-in Node launcher for backward compatibility. +// +// RPC method: registerExtensionLaunchProvider. +// Experimental: RegisterExtensionLaunchProvider is an experimental API and may change or be +// removed in future versions. +func (a *ServerRPC) RegisterExtensionLaunchProvider(ctx context.Context) (*RegisterExtensionLaunchProviderResult, error) { + raw, err := a.common.client.Request(ctx, "registerExtensionLaunchProvider", nil) + if err != nil { + return nil, err + } + var result RegisterExtensionLaunchProviderResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +func NewServerRPC(client *jsonrpc2.Client) *ServerRPC { + r := &ServerRPC{} + r.common = serverAPI{client: client} + r.Account = (*ServerAccountAPI)(&r.common) + r.AgentRegistry = (*ServerAgentRegistryAPI)(&r.common) + r.Agents = (*ServerAgentsAPI)(&r.common) + r.Commands = (*ServerCommandsAPI)(&r.common) + r.Extensions = (*ServerExtensionsAPI)(&r.common) + r.Instructions = (*ServerInstructionsAPI)(&r.common) + r.LlmInference = (*ServerLlmInferenceAPI)(&r.common) + r.ManagedSettings = (*ServerManagedSettingsAPI)(&r.common) + r.MCP = (*ServerMCPAPI)(&r.common) + r.Models = (*ServerModelsAPI)(&r.common) + r.Plugins = (*ServerPluginsAPI)(&r.common) + r.Runtime = (*ServerRuntimeAPI)(&r.common) + r.Secrets = (*ServerSecretsAPI)(&r.common) + r.SessionFS = (*ServerSessionFSAPI)(&r.common) + r.Sessions = (*ServerSessionsAPI)(&r.common) + r.Skills = (*ServerSkillsAPI)(&r.common) + r.Tools = (*ServerToolsAPI)(&r.common) + r.User = (*ServerUserAPI)(&r.common) + return r +} + +type internalServerAPI struct { + client *jsonrpc2.Client +} + +// Experimental: InternalServerSessionsAPI contains experimental APIs that may change or be +// removed. +type InternalServerSessionsAPI internalServerAPI + +// ConfigureSessionExtensions attaches (or detaches) an in-process ExtensionController +// delegate for the given session, used by shared-API surfaces that need to query or modify +// the session's extension state. Pass `controller: undefined` to detach. Marked internal +// because the controller is an in-process object that cannot cross the JSON-RPC boundary. +// Disappears alongside `registerExtensionToolsOnSession`: once the runtime owns extension +// management, the public surface exposes list/enable/disable/reload as dedicated RPCs +// served by the runtime. +// +// RPC method: sessions.configureSessionExtensions. +// +// Parameters: Params to attach or detach an in-process ExtensionController delegate. +// Internal: ConfigureSessionExtensions is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalServerSessionsAPI) ConfigureSessionExtensions(ctx context.Context, params *ConfigureSessionExtensionsParams) (*SessionsConfigureSessionExtensionsResult, error) { + raw, err := a.client.Request(ctx, "sessions.configureSessionExtensions", params) + if err != nil { + return nil, err + } + var result SessionsConfigureSessionExtensionsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Deletes one local session from disk after running the same lifecycle hooks as the session +// manager. +// +// RPC method: sessions.delete. +// +// Parameters: Session ID to delete from disk. +// Internal: Delete is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalServerSessionsAPI) Delete(ctx context.Context, params *SessionsDeleteRequest) (*SessionsDeleteResult, error) { + raw, err := a.client.Request(ctx, "sessions.delete", params) + if err != nil { + return nil, err + } + var result SessionsDeleteResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetBoardEntryCount gets the dynamic-context board entry count associated with a session, +// when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, +// `rem_consolidation_complete`) can pair START / END board counts around the detached +// rem-agent spawn. "Dynamic context board" is a runtime-internal concept that is not part +// of the public SDK contract; the long-term plan is to relocate the telemetry emission into +// the runtime so this method can be deleted entirely. +// +// RPC method: sessions.getBoardEntryCount. +// +// Parameters: Session ID whose board entry count should be returned. +// +// Returns: Dynamic-context board entry count, when available. +// Internal: GetBoardEntryCount is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalServerSessionsAPI) GetBoardEntryCount(ctx context.Context, params *SessionsGetBoardEntryCountRequest) (*SessionsGetBoardEntryCountResult, error) { + raw, err := a.client.Request(ctx, "sessions.getBoardEntryCount", params) + if err != nil { + return nil, err + } + var result SessionsGetBoardEntryCountResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetEventFilePath computes the absolute path to a session's persisted events.jsonl file. +// Internal: filesystem paths are only meaningful in-process (CLI and runtime share a +// filesystem). Currently used by the CLI's contribution-graph feature to read historical +// events directly. Remote SDK consumers must not depend on this; a proper event-query API +// would replace it if the contribution graph ever needed to work over the wire. +// +// RPC method: sessions.getEventFilePath. +// +// Parameters: Session ID whose event-log file path to compute. +// +// Returns: Absolute path to the session's events.jsonl file on disk. +// Internal: GetEventFilePath is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalServerSessionsAPI) GetEventFilePath(ctx context.Context, params *SessionsGetEventFilePathRequest) (*SessionsGetEventFilePathResult, error) { + raw, err := a.client.Request(ctx, "sessions.getEventFilePath", params) + if err != nil { + return nil, err + } + var result SessionsGetEventFilePathResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetMetadata reads lightweight persisted metadata for one local session without opening it. +// +// RPC method: sessions.getMetadata. +// +// Parameters: Session ID whose persisted metadata should be read. +// +// Returns: Persisted local session metadata when the session exists. +// Internal: GetMetadata is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalServerSessionsAPI) GetMetadata(ctx context.Context, params *SessionsGetMetadataRequest) (*SessionsGetMetadataResult, error) { + raw, err := a.client.Request(ctx, "sessions.getMetadata", params) + if err != nil { + return nil, err + } + var result SessionsGetMetadataResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetPersistedRemoteSteerable returns a session's persisted remote-steerable flag, if any +// has been recorded. Internal: this is CLI-specific book-keeping used by `--continue` / +// `--resume` to inherit the prior session's remote-steerable preference. SDK consumers that +// want similar behavior should manage their own persistence around start/stop calls rather +// than relying on this runtime-side flag. +// +// RPC method: sessions.getPersistedRemoteSteerable. +// +// Parameters: Session ID to look up the persisted remote-steerable flag for. +// +// Returns: The session's persisted remote-steerable flag, or omitted when no value has been +// persisted. +// Internal: GetPersistedRemoteSteerable is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalServerSessionsAPI) GetPersistedRemoteSteerable(ctx context.Context, params *SessionsGetPersistedRemoteSteerableRequest) (*SessionsGetPersistedRemoteSteerableResult, error) { + raw, err := a.client.Request(ctx, "sessions.getPersistedRemoteSteerable", params) + if err != nil { + return nil, err + } + var result SessionsGetPersistedRemoteSteerableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ListNonEmptySessionIds lists recent local session IDs that contain user-visible history, +// omitting housekeeping-only sessions. +// +// RPC method: sessions.listNonEmptySessionIds. +// +// Parameters: Limit for non-empty local session IDs. +// +// Returns: Recent local session IDs that contain user-visible history. +// Internal: ListNonEmptySessionIds is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalServerSessionsAPI) ListNonEmptySessionIds(ctx context.Context, params *SessionsListNonEmptySessionIDsRequest) (*SessionsListNonEmptySessionIDsResult, error) { + raw, err := a.client.Request(ctx, "sessions.listNonEmptySessionIds", params) + if err != nil { + return nil, err + } + var result SessionsListNonEmptySessionIDsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RegisterExtensionToolsOnSession registers extension-provided tools on the given session, +// gated by an optional `enabled` callback. Returns an opaque unsubscribe function the +// caller must invoke to deregister the tools when the extension is torn down. Marked +// internal because `loader`, `enabled`, and the returned `unsubscribe` are in-process +// handles that cannot cross the JSON-RPC boundary. Disappears once extension discovery / +// launch / tool registration are owned by the runtime: SDK consumers will pass pure config +// (search paths, disabled ids) via `SessionOptions` and the runtime will resolve, launch, +// register, and tear down extensions itself. +// +// RPC method: sessions.registerExtensionToolsOnSession. +// +// Parameters: Params to attach an extension loader's tools to a session. +// +// Returns: Handle for releasing the extension tool registration. +// Internal: RegisterExtensionToolsOnSession is part of the SDK's internal +// handshake/plumbing; external callers should not use it. +func (a *InternalServerSessionsAPI) RegisterExtensionToolsOnSession(ctx context.Context, params *RegisterExtensionToolsParams) (*RegisterExtensionToolsResult, error) { + raw, err := a.client.Request(ctx, "sessions.registerExtensionToolsOnSession", params) + if err != nil { + return nil, err + } + var result RegisterExtensionToolsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// InternalServerRPC provides internal SDK server-scoped RPC methods (handshake helpers +// etc.). Not part of the public API. +type InternalServerRPC struct { + // Reuse a single struct instead of allocating one for each service on the heap. + common internalServerAPI + + Sessions *InternalServerSessionsAPI +} + +// Connect performs the SDK server connection handshake and validates the optional +// connection token. Marked internal because this is JSON-RPC transport plumbing invoked +// automatically by an SDK client's own `connect()` wrapper, not a user-facing method. Stays +// internal as long as the SDK client owns the handshake; would only become public if the +// SDK ever exposed the raw schema surface to consumers without a connection wrapper. +// +// RPC method: connect. +// +// Parameters: Parameters for the `server.connect` handshake: an optional connection token +// and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). +// +// Returns: Handshake result reporting the server's protocol version and package version on +// success. +// Experimental: Connect is an experimental API and may change or be removed in future +// versions. +// Internal: Connect is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalServerRPC) Connect(ctx context.Context, params *ConnectRequest) (*ConnectResult, error) { + raw, err := a.common.client.Request(ctx, "connect", params) + if err != nil { + return nil, err + } + var result ConnectResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +func NewInternalServerRPC(client *jsonrpc2.Client) *InternalServerRPC { + r := &InternalServerRPC{} + r.common = internalServerAPI{client: client} + r.Sessions = (*InternalServerSessionsAPI)(&r.common) + return r +} + +type sessionAPI struct { + client *jsonrpc2.Client + sessionID string +} + +// Experimental: AgentAPI contains experimental APIs that may change or be removed. +type AgentAPI sessionAPI + +// Deselect clears the selected custom agent and returns the session to the default agent. +// +// RPC method: session.agent.deselect. +func (a *AgentAPI) Deselect(ctx context.Context) (*SessionAgentDeselectResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.agent.deselect", req) + if err != nil { + return nil, err + } + var result SessionAgentDeselectResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetCurrent gets the currently selected custom agent for the session. +// +// RPC method: session.agent.getCurrent. +// +// Returns: The currently selected custom agent, or null when using the default agent. +func (a *AgentAPI) GetCurrent(ctx context.Context) (*AgentGetCurrentResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.agent.getCurrent", req) + if err != nil { + return nil, err + } + var result AgentGetCurrentResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists agents available to the session. Defaults to custom agents only; pass +// includeBuiltInAgents to include the effective built-in agents. +// +// RPC method: session.agent.list. +// +// Parameters: Controls whether built-in agents and authored prompt text are included. +// +// Returns: Agents available to the session. +func (a *AgentAPI) List(ctx context.Context, params ...*SessionAgentListRequest) (*AgentList, error) { + var requestParams *SessionAgentListRequest + if len(params) > 0 { + requestParams = params[0] + } + req := map[string]any{"sessionId": a.sessionID} + if requestParams != nil { + if requestParams.IncludeBuiltInAgents != nil { + req["includeBuiltInAgents"] = *requestParams.IncludeBuiltInAgents + } + if requestParams.IncludePrompt != nil { + req["includePrompt"] = *requestParams.IncludePrompt + } + } + raw, err := a.client.Request(ctx, "session.agent.list", req) + if err != nil { + return nil, err + } + var result AgentList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Reloads custom agent definitions and returns the refreshed list. +// +// RPC method: session.agent.reload. +// +// Returns: Custom agents available to the session after reloading definitions from disk. +func (a *AgentAPI) Reload(ctx context.Context) (*AgentReloadResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.agent.reload", req) + if err != nil { + return nil, err + } + var result AgentReloadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Selects a custom agent for subsequent turns in the session. +// +// RPC method: session.agent.select. +// +// Parameters: Name of the custom agent to select for subsequent turns. +// +// Returns: The newly selected custom agent. +func (a *AgentAPI) Select(ctx context.Context, params *AgentSelectRequest) (*AgentSelectResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["name"] = params.Name + } + raw, err := a.client.Request(ctx, "session.agent.select", req) + if err != nil { + return nil, err + } + var result AgentSelectResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SetPrompt sets an in-memory authored prompt override for an available agent. For built-in +// agents, this replaces only the static base prompt while preserving runtime-owned dynamic +// prompt composition and behavior. The special `general-purpose` agent is not overrideable. +// Overrides are not persisted; resumed and forked sessions start without them, so the host +// must re-apply them. +// +// RPC method: session.agent.setPrompt. +// +// Parameters: An in-memory authored prompt override for an available agent. +func (a *AgentAPI) SetPrompt(ctx context.Context, params *AgentSetPromptRequest) (*SessionAgentSetPromptResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["id"] = params.ID + req["prompt"] = params.Prompt + } + raw, err := a.client.Request(ctx, "session.agent.setPrompt", req) + if err != nil { + return nil, err + } + var result SessionAgentSetPromptResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: CanvasAPI contains experimental APIs that may change or be removed. +type CanvasAPI sessionAPI + +// Closes an open canvas instance. +// +// RPC method: session.canvas.close. +// +// Parameters: Canvas close parameters. +func (a *CanvasAPI) Close(ctx context.Context, params *CanvasCloseRequest) (*SessionCanvasCloseResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["instanceId"] = params.InstanceID + } + raw, err := a.client.Request(ctx, "session.canvas.close", req) + if err != nil { + return nil, err + } + var result SessionCanvasCloseResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists canvases declared for the session. +// +// RPC method: session.canvas.list. +// +// Returns: Declared canvases available in this session. +func (a *CanvasAPI) List(ctx context.Context) (*CanvasList, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.canvas.list", req) + if err != nil { + return nil, err + } + var result CanvasList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ListOpen lists currently open canvas instances for the live session. +// +// RPC method: session.canvas.listOpen. +// +// Returns: Live open-canvas snapshot. +func (a *CanvasAPI) ListOpen(ctx context.Context) (*CanvasListOpenResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.canvas.listOpen", req) + if err != nil { + return nil, err + } + var result CanvasListOpenResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Opens or focuses a canvas instance. +// +// RPC method: session.canvas.open. +// +// Parameters: Canvas open parameters. +// +// Returns: Open canvas instance snapshot. +func (a *CanvasAPI) Open(ctx context.Context, params *CanvasOpenRequest) (*OpenCanvasInstance, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["canvasId"] = params.CanvasID + if params.ExtensionID != nil { + req["extensionId"] = *params.ExtensionID + } + if params.Input != nil { + req["input"] = params.Input + } + req["instanceId"] = params.InstanceID + } + raw, err := a.client.Request(ctx, "session.canvas.open", req) + if err != nil { + return nil, err + } + var result OpenCanvasInstance + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: CanvasActionAPI contains experimental APIs that may change or be removed. +type CanvasActionAPI sessionAPI + +// Invokes an action on an open canvas instance. +// +// RPC method: session.canvas.action.invoke. +// +// Parameters: Canvas action invocation parameters. +// +// Returns: Canvas action invocation result. +func (a *CanvasActionAPI) Invoke(ctx context.Context, params *CanvasActionInvokeRequest) (*CanvasActionInvokeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["actionName"] = params.ActionName + if params.Input != nil { + req["input"] = params.Input + } + req["instanceId"] = params.InstanceID + } + raw, err := a.client.Request(ctx, "session.canvas.action.invoke", req) + if err != nil { + return nil, err + } + var result CanvasActionInvokeResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: Action returns experimental APIs that may change or be removed. +func (s *CanvasAPI) Action() *CanvasActionAPI { + return (*CanvasActionAPI)(s) +} + +// Experimental: CommandsAPI contains experimental APIs that may change or be removed. +type CommandsAPI sessionAPI + +// Enqueues a slash command for FIFO processing on the local session. +// +// RPC method: session.commands.enqueue. +// +// Parameters: Slash-prefixed command string to enqueue for FIFO processing. +// +// Returns: Indicates whether the command was accepted into the local execution queue. +func (a *CommandsAPI) Enqueue(ctx context.Context, params *EnqueueCommandParams) (*EnqueueCommandResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["command"] = params.Command + } + raw, err := a.client.Request(ctx, "session.commands.enqueue", req) + if err != nil { + return nil, err + } + var result EnqueueCommandResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Executes a slash command synchronously and returns any error. +// +// RPC method: session.commands.execute. +// +// Parameters: Slash command name and argument string to execute synchronously. +// +// Returns: Error message produced while executing the command, if any. +func (a *CommandsAPI) Execute(ctx context.Context, params *ExecuteCommandParams) (*ExecuteCommandResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["args"] = params.Args + req["commandName"] = params.CommandName + } + raw, err := a.client.Request(ctx, "session.commands.execute", req) + if err != nil { + return nil, err + } + var result ExecuteCommandResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// HandlePendingCommand reports completion of a pending client-handled slash command. +// +// RPC method: session.commands.handlePendingCommand. +// +// Parameters: Pending command request ID and an optional error if the client handler failed. +// +// Returns: Indicates whether the pending client-handled command was completed successfully. +func (a *CommandsAPI) HandlePendingCommand(ctx context.Context, params *CommandsHandlePendingCommandRequest) (*CommandsHandlePendingCommandResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Error != nil { + req["error"] = *params.Error + } + req["requestId"] = params.RequestID + } + raw, err := a.client.Request(ctx, "session.commands.handlePendingCommand", req) + if err != nil { + return nil, err + } + var result CommandsHandlePendingCommandResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Invokes a slash command in the session. +// +// RPC method: session.commands.invoke. +// +// Parameters: Slash command name and optional raw input string to invoke. +// +// Returns: Result of invoking the slash command (text output, prompt to send to the agent, +// completion, or subcommand selection). +func (a *CommandsAPI) Invoke(ctx context.Context, params *CommandsInvokeRequest) (SlashCommandInvocationResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Input != nil { + req["input"] = *params.Input + } + req["name"] = params.Name + } + raw, err := a.client.Request(ctx, "session.commands.invoke", req) + if err != nil { + return nil, err + } + result, err := unmarshalSlashCommandInvocationResult(raw) + if err != nil { + return nil, err + } + return result, nil +} + +// Lists slash commands available in the session. +// +// RPC method: session.commands.list. +// +// Parameters: Optional filters controlling which command sources to include in the listing. +// +// Returns: Slash commands available in the session, after applying any include/exclude +// filters. +func (a *CommandsAPI) List(ctx context.Context, params ...*SessionCommandsListRequest) (*CommandList, error) { + var requestParams *SessionCommandsListRequest + if len(params) > 0 { + requestParams = params[0] + } + req := map[string]any{"sessionId": a.sessionID} + if requestParams != nil { + if requestParams.IncludeBuiltins != nil { + req["includeBuiltins"] = *requestParams.IncludeBuiltins + } + if requestParams.IncludeClientCommands != nil { + req["includeClientCommands"] = *requestParams.IncludeClientCommands + } + if requestParams.IncludeSkills != nil { + req["includeSkills"] = *requestParams.IncludeSkills + } + } + raw, err := a.client.Request(ctx, "session.commands.list", req) + if err != nil { + return nil, err + } + var result CommandList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RespondToQueuedCommand reports whether the host actually executed a queued command and +// whether to continue processing. +// +// RPC method: session.commands.respondToQueuedCommand. +// +// Parameters: Queued-command request ID and the result indicating whether the host executed +// it (and whether to stop processing further queued commands). +// +// Returns: Indicates whether the queued-command response was matched to a pending request. +func (a *CommandsAPI) RespondToQueuedCommand(ctx context.Context, params *CommandsRespondToQueuedCommandRequest) (*CommandsRespondToQueuedCommandResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["requestId"] = params.RequestID + req["result"] = params.Result + } + raw, err := a.client.Request(ctx, "session.commands.respondToQueuedCommand", req) + if err != nil { + return nil, err + } + var result CommandsRespondToQueuedCommandResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: CompletionsAPI contains experimental APIs that may change or be removed. +type CompletionsAPI sessionAPI + +// GetTriggerCharacters gets the characters that should trigger host-driven completions for +// the session. Empty disables host-driven completions (e.g. local sessions, or a relay host +// that does not advertise them). +// +// RPC method: session.completions.getTriggerCharacters. +// +// Returns: Characters that, when typed in the composer, should trigger a +// `completions.request`. Empty when the session has no host-driven completions (e.g. local +// sessions, or a relay host that does not advertise `completionTriggerCharacters`). +func (a *CompletionsAPI) GetTriggerCharacters(ctx context.Context) (*CompletionsGetTriggerCharactersResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.completions.getTriggerCharacters", req) + if err != nil { + return nil, err + } + var result CompletionsGetTriggerCharactersResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Requests host-driven completion items for the current composer input. Returns an empty +// list when the host has no items or does not support completions. +// +// RPC method: session.completions.request. +// +// Parameters: Request host-driven completions for the current composer input. +// +// Returns: Host-driven completion items for the current composer input. Empty when the host +// returns no items or does not support completions. +func (a *CompletionsAPI) Request(ctx context.Context, params *CompletionsRequestRequest) (*CompletionsRequestResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["offset"] = params.Offset + req["text"] = params.Text + } + raw, err := a.client.Request(ctx, "session.completions.request", req) + if err != nil { + return nil, err + } + var result CompletionsRequestResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ContentExclusionAPI contains experimental APIs that may change or be +// removed. +type ContentExclusionAPI sessionAPI + +// CheckPaths checks local file system absolute paths within the session working directory +// against its content-exclusion policy. Results preserve input order. Unsupported +// paths/filesystems and unavailable policy evaluation return available false, and callers +// must treat every requested path as excluded. +// +// RPC method: session.contentExclusion.checkPaths. +// +// Parameters: Local file system absolute paths within the session working directory to +// check against its content-exclusion policy. +// +// Returns: Batch content-exclusion result. Callers must fail closed when policy evaluation +// is unavailable. +func (a *ContentExclusionAPI) CheckPaths(ctx context.Context, params *ContentExclusionCheckPathsRequest) (*ContentExclusionCheckPathsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["paths"] = params.Paths + } + raw, err := a.client.Request(ctx, "session.contentExclusion.checkPaths", req) + if err != nil { + return nil, err + } + var result ContentExclusionCheckPathsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: DebugAPI contains experimental APIs that may change or be removed. +type DebugAPI sessionAPI + +// CollectLogs collects a redacted session debug log bundle into a local archive or staging +// directory. The runtime includes session-owned logs by default and accepts caller-provided +// diagnostic entries so host applications can add their own files without changing this API +// shape. +// +// RPC method: session.debug.collectLogs. +// +// Parameters: Options for collecting a redacted session debug bundle. +// +// Returns: Result of collecting a redacted debug bundle. +func (a *DebugAPI) CollectLogs(ctx context.Context, params *DebugCollectLogsRequest) (*DebugCollectLogsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.AdditionalEntries != nil { + req["additionalEntries"] = params.AdditionalEntries + } + req["destination"] = params.Destination + if params.Include != nil { + req["include"] = *params.Include + } + } + raw, err := a.client.Request(ctx, "session.debug.collectLogs", req) + if err != nil { + return nil, err + } + var result DebugCollectLogsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: EventLogAPI contains experimental APIs that may change or be removed. +type EventLogAPI sessionAPI + +// Reads a batch of session events from a cursor, optionally waiting for new events. +// Supports tail-first reads via `direction: backward`. +// +// RPC method: session.eventLog.read. +// +// Parameters: Cursor, batch size, and optional long-poll/filter parameters for reading +// session events. +// +// Returns: Batch of session events returned by a read, with cursor and continuation +// metadata. +func (a *EventLogAPI) Read(ctx context.Context, params *EventLogReadRequest) (*EventsReadResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.AgentIDs != nil { + req["agentIds"] = params.AgentIDs + } + if params.AgentScope != nil { + req["agentScope"] = *params.AgentScope + } + if params.Cursor != nil { + req["cursor"] = *params.Cursor + } + if params.Direction != nil { + req["direction"] = *params.Direction + } + if params.IncludeEphemeral != nil { + req["includeEphemeral"] = *params.IncludeEphemeral + } + if params.Max != nil { + req["max"] = *params.Max + } + if params.Types != nil { + req["types"] = *params.Types + } + if params.WaitMs != nil { + req["waitMs"] = *params.WaitMs + } + } + raw, err := a.client.Request(ctx, "session.eventLog.read", req) + if err != nil { + return nil, err + } + var result EventsReadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// RegisterInterest registers consumer interest in an event type for runtime gating purposes. +// +// RPC method: session.eventLog.registerInterest. +// +// Parameters: Event type to register consumer interest for, used by runtime gating logic. +// +// Returns: Opaque handle representing an event-type interest registration. +func (a *EventLogAPI) RegisterInterest(ctx context.Context, params *RegisterEventInterestParams) (*RegisterEventInterestResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["eventType"] = params.EventType + } + raw, err := a.client.Request(ctx, "session.eventLog.registerInterest", req) + if err != nil { + return nil, err + } + var result RegisterEventInterestResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ReleaseInterest releases a consumer's previously-registered interest in an event type. +// +// RPC method: session.eventLog.releaseInterest. +// +// Parameters: Opaque handle previously returned by `registerInterest` to release. +// +// Returns: Indicates whether the operation succeeded. +func (a *EventLogAPI) ReleaseInterest(ctx context.Context, params *ReleaseEventInterestParams) (*EventLogReleaseInterestResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["handle"] = params.Handle + } + raw, err := a.client.Request(ctx, "session.eventLog.releaseInterest", req) + if err != nil { + return nil, err + } + var result EventLogReleaseInterestResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Tail returns a snapshot of the current tail cursor without consuming events. +// +// RPC method: session.eventLog.tail. +// +// Returns: Snapshot of the current tail cursor without returning any events. Use this when +// a consumer wants to subscribe to live events going forward without first paginating +// through the entire persisted history (which would happen if `read` were called without a +// cursor on a long-lived session). +func (a *EventLogAPI) Tail(ctx context.Context) (*EventLogTailResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.eventLog.tail", req) + if err != nil { + return nil, err + } + var result EventLogTailResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: ExtensionsAPI contains experimental APIs that may change or be removed. +type ExtensionsAPI sessionAPI + +// Disables an extension for the session. +// +// RPC method: session.extensions.disable. +// +// Parameters: Source-qualified extension identifier to disable for the session. +func (a *ExtensionsAPI) Disable(ctx context.Context, params *ExtensionsDisableRequest) (*SessionExtensionsDisableResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.extensions.disable", req) + if err != nil { + return nil, err + } + var result SessionExtensionsDisableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Enables an extension for the session. +// +// RPC method: session.extensions.enable. +// +// Parameters: Source-qualified extension identifier to enable for the session. +func (a *ExtensionsAPI) Enable(ctx context.Context, params *ExtensionsEnableRequest) (*SessionExtensionsEnableResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.extensions.enable", req) + if err != nil { + return nil, err + } + var result SessionExtensionsEnableResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Lists extensions discovered for the session and their current status. +// +// RPC method: session.extensions.list. +// +// Returns: Extensions discovered for the session, with their current status. +func (a *ExtensionsAPI) List(ctx context.Context) (*ExtensionList, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.extensions.list", req) + if err != nil { + return nil, err + } + var result ExtensionList + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Reloads extension definitions and processes for the session. +// +// RPC method: session.extensions.reload. +func (a *ExtensionsAPI) Reload(ctx context.Context) (*SessionExtensionsReloadResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.extensions.reload", req) + if err != nil { + return nil, err + } + var result SessionExtensionsReloadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// SendAttachmentsToMessage push attachments into the next user-message turn from an +// extension. The host should surface them as composer pills and forward them via the next +// session.send call. Callable only by extension-owned connections. +// +// RPC method: session.extensions.sendAttachmentsToMessage. +// +// Parameters: Parameters for session.extensions.sendAttachmentsToMessage. +func (a *ExtensionsAPI) SendAttachmentsToMessage(ctx context.Context, params *SendAttachmentsToMessageParams) (*SessionExtensionsSendAttachmentsToMessageResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["attachments"] = params.Attachments + if params.InstanceID != nil { + req["instanceId"] = *params.InstanceID + } + } + raw, err := a.client.Request(ctx, "session.extensions.sendAttachmentsToMessage", req) + if err != nil { + return nil, err + } + var result SessionExtensionsSendAttachmentsToMessageResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Experimental: FactoryAPI contains experimental APIs that may change or be removed. +type FactoryAPI sessionAPI + +// Agent runs one factory-scoped subagent and returns its result. +// +// RPC method: session.factory.agent. +// +// Parameters: Parameters for one factory-scoped subagent call. +// +// Returns: Result of one factory-scoped subagent call. +func (a *FactoryAPI) Agent(ctx context.Context, params *FactoryAgentRequest) (*FactoryAgentResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["executionToken"] = params.ExecutionToken + req["factoryRunId"] = params.FactoryRunID + req["opts"] = params.Opts + req["prompt"] = params.Prompt + } + raw, err := a.client.Request(ctx, "session.factory.agent", req) + if err != nil { + return nil, err + } + var result FactoryAgentResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Cancel requests cancellation of a factory run and returns its run envelope. +// +// RPC method: session.factory.cancel. +// +// Parameters: Parameters for cancelling a factory run. +// +// Returns: Complete current or terminal factory run envelope. +func (a *FactoryAPI) Cancel(ctx context.Context, params *FactoryCancelRequest) (*FactoryRunResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.cancel", req) + if err != nil { + return nil, err + } + var result FactoryRunResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetRun gets the current or settled envelope for a factory run. +// +// RPC method: session.factory.getRun. +// +// Parameters: Parameters for retrieving a factory run. +// +// Returns: Complete current or terminal factory run envelope. +func (a *FactoryAPI) GetRun(ctx context.Context, params *FactoryGetRunRequest) (*FactoryRunResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.getRun", req) + if err != nil { + return nil, err + } + var result FactoryRunResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetRunDetail gets durable and live observability detail for one factory run. +// +// RPC method: session.factory.getRunDetail. +// +// Parameters: Parameters for retrieving a factory run. +// +// Returns: Full factory run observability detail. +func (a *FactoryAPI) GetRunDetail(ctx context.Context, params *FactoryGetRunRequest) (*FactoryRunDetail, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.getRunDetail", req) + if err != nil { + return nil, err + } + var result FactoryRunDetail + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// GetRunProgress pages durable progress for one factory run. +// +// RPC method: session.factory.getRunProgress. +// +// Parameters: Parameters for paging factory progress. +// +// Returns: A bidirectional page of factory progress. +func (a *FactoryAPI) GetRunProgress(ctx context.Context, params *FactoryGetRunProgressRequest) (*FactoryProgressPage, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.AfterSeq != nil { + req["afterSeq"] = *params.AfterSeq + } + if params.BeforeSeq != nil { + req["beforeSeq"] = *params.BeforeSeq + } + if params.Limit != nil { + req["limit"] = *params.Limit + } + if params.PhaseID != nil { + req["phaseId"] = *params.PhaseID + } + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.getRunProgress", req) + if err != nil { + return nil, err + } + var result FactoryProgressPage + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// ListRuns lists durable factory runs for this session in creation order. +// +// RPC method: session.factory.listRuns. +// +// Parameters: Parameters for paging factory runs. +// +// Returns: A page of factory runs in durable creation order. +func (a *FactoryAPI) ListRuns(ctx context.Context, params *FactoryListRunsRequest) (*FactoryListRunsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.AfterSeq != nil { + req["afterSeq"] = *params.AfterSeq + } + if params.BeforeSeq != nil { + req["beforeSeq"] = *params.BeforeSeq + } + if params.Limit != nil { + req["limit"] = *params.Limit + } + } + raw, err := a.client.Request(ctx, "session.factory.listRuns", req) + if err != nil { + return nil, err + } + var result FactoryListRunsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Log records a batch of ordered factory progress lines. +// +// RPC method: session.factory.log. +// +// Parameters: Parameters for recording factory progress. +// +// Returns: Acknowledgement that a factory request was accepted. +func (a *FactoryAPI) Log(ctx context.Context, params *FactoryLogRequest) (*FactoryAckResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["executionToken"] = params.ExecutionToken + req["lines"] = params.Lines + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.log", req) + if err != nil { + return nil, err + } + var result FactoryAckResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} + +// Resumes a factory run using its persisted name, arguments, journal, and accounting. +// +// RPC method: session.factory.resume. +// +// Parameters: Parameters for resuming a factory run from its persisted identity. +// +// Returns: Resolved persisted factory identity and resumed run envelope. +func (a *FactoryAPI) Resume(ctx context.Context, params *FactoryResumeRequest) (*FactoryResumeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Limits != nil { + req["limits"] = *params.Limits + } + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.resume", req) + if err != nil { + return nil, err + } + var result FactoryResumeResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - // Integer JSON number. - UIElicitationSchemaPropertyNumberTypeInteger UIElicitationSchemaPropertyNumberType = "integer" - // Any JSON number. - UIElicitationSchemaPropertyNumberTypeNumber UIElicitationSchemaPropertyNumberType = "number" -) +// Runs a registered factory by name at the top level. +// +// RPC method: session.factory.run. +// +// Parameters: Parameters for invoking a registered factory. +// +// Returns: Complete current or terminal factory run envelope. +func (a *FactoryAPI) Run(ctx context.Context, params *FactoryRunRequest) (*FactoryRunResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["args"] = params.Args + req["name"] = params.Name + if params.Options != nil { + req["options"] = *params.Options + } + } + raw, err := a.client.Request(ctx, "session.factory.run", req) + if err != nil { + return nil, err + } + var result FactoryRunResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Optional format hint that constrains the accepted input. -// Experimental: UIElicitationSchemaPropertyStringFormat is part of an experimental API and -// may change or be removed. -type UIElicitationSchemaPropertyStringFormat string +// Experimental: FactoryJournalAPI contains experimental APIs that may change or be removed. +type FactoryJournalAPI sessionAPI -const ( - // Calendar date string format. - UIElicitationSchemaPropertyStringFormatDate UIElicitationSchemaPropertyStringFormat = "date" - // Date-time string format. - UIElicitationSchemaPropertyStringFormatDateTime UIElicitationSchemaPropertyStringFormat = "date-time" - // Email address string format. - UIElicitationSchemaPropertyStringFormatEmail UIElicitationSchemaPropertyStringFormat = "email" - // URI string format. - UIElicitationSchemaPropertyStringFormatURI UIElicitationSchemaPropertyStringFormat = "uri" -) +// Get reads a memoized factory journal entry. +// +// RPC method: session.factory.journal.get. +// +// Parameters: Parameters for reading a factory journal entry. +// +// Returns: Result of reading a factory journal entry. +func (a *FactoryJournalAPI) Get(ctx context.Context, params *FactoryJournalGetRequest) (*FactoryJournalGetResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["executionToken"] = params.ExecutionToken + req["key"] = params.Key + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.journal.get", req) + if err != nil { + return nil, err + } + var result FactoryJournalGetResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Type discriminator for UIElicitationSchemaProperty. -type UIElicitationSchemaPropertyType string +// Put stores a memoized factory journal entry. +// +// RPC method: session.factory.journal.put. +// +// Parameters: Parameters for storing a factory journal entry. +// +// Returns: Acknowledgement that a factory request was accepted. +func (a *FactoryJournalAPI) Put(ctx context.Context, params *FactoryJournalPutRequest) (*FactoryAckResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["executionToken"] = params.ExecutionToken + req["key"] = params.Key + req["resultJson"] = params.ResultJSON + req["runId"] = params.RunID + } + raw, err := a.client.Request(ctx, "session.factory.journal.put", req) + if err != nil { + return nil, err + } + var result FactoryAckResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - UIElicitationSchemaPropertyTypeArray UIElicitationSchemaPropertyType = "array" - UIElicitationSchemaPropertyTypeBoolean UIElicitationSchemaPropertyType = "boolean" - UIElicitationSchemaPropertyTypeInteger UIElicitationSchemaPropertyType = "integer" - UIElicitationSchemaPropertyTypeNumber UIElicitationSchemaPropertyType = "number" - UIElicitationSchemaPropertyTypeString UIElicitationSchemaPropertyType = "string" -) +// Experimental: Journal returns experimental APIs that may change or be removed. +func (s *FactoryAPI) Journal() *FactoryJournalAPI { + return (*FactoryJournalAPI)(s) +} -// Schema type indicator (always 'object') -type UIElicitationSchemaType string +// Experimental: FleetAPI contains experimental APIs that may change or be removed. +type FleetAPI sessionAPI -const ( - UIElicitationSchemaTypeObject UIElicitationSchemaType = "object" -) +// Starts fleet mode by submitting the fleet orchestration prompt to the session. +// +// RPC method: session.fleet.start. +// +// Parameters: Optional user prompt to combine with the fleet orchestration instructions. +// +// Returns: Indicates whether fleet mode was successfully activated. +func (a *FleetAPI) Start(ctx context.Context, params *FleetStartRequest) (*FleetStartResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Prompt != nil { + req["prompt"] = *params.Prompt + } + } + raw, err := a.client.Request(ctx, "session.fleet.start", req) + if err != nil { + return nil, err + } + var result FleetStartResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, -// otherwise 'interactive'. -// Experimental: UIExitPlanModeAction is part of an experimental API and may change or be -// removed. -type UIExitPlanModeAction string +// Experimental: GitHubAuthAPI contains experimental APIs that may change or be removed. +type GitHubAuthAPI sessionAPI -const ( - // Exit plan mode and continue in autopilot mode. - UIExitPlanModeActionAutopilot UIExitPlanModeAction = "autopilot" - // Exit plan mode and continue in autopilot mode with parallel subagent execution. - UIExitPlanModeActionAutopilotFleet UIExitPlanModeAction = "autopilot_fleet" - // Exit plan mode without starting implementation. - UIExitPlanModeActionExitOnly UIExitPlanModeAction = "exit_only" - // Exit plan mode and continue interactively. - UIExitPlanModeActionInteractive UIExitPlanModeAction = "interactive" -) +// GetStatus gets authentication status and account metadata for the session. +// +// RPC method: session.gitHubAuth.getStatus. +// +// Returns: Authentication status and account metadata for the session. +func (a *GitHubAuthAPI) GetStatus(ctx context.Context) (*SessionAuthStatus, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.gitHubAuth.getStatus", req) + if err != nil { + return nil, err + } + var result SessionAuthStatus + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Kind discriminator for UserToolSessionApproval. -type UserToolSessionApprovalKind string +// SetCredentials updates the session's auth credentials used for outbound model and API +// requests. +// +// RPC method: session.gitHubAuth.setCredentials. +// +// Parameters: New auth credentials to install on the session. Omit to leave credentials +// unchanged. +// +// Returns: Indicates whether the credential update succeeded. +func (a *GitHubAuthAPI) SetCredentials(ctx context.Context, params *SessionSetCredentialsParams) (*SessionSetCredentialsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Credentials != nil { + req["credentials"] = params.Credentials + } + } + raw, err := a.client.Request(ctx, "session.gitHubAuth.setCredentials", req) + if err != nil { + return nil, err + } + var result SessionSetCredentialsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - UserToolSessionApprovalKindCommands UserToolSessionApprovalKind = "commands" - UserToolSessionApprovalKindCustomTool UserToolSessionApprovalKind = "custom-tool" - UserToolSessionApprovalKindExtensionManagement UserToolSessionApprovalKind = "extension-management" - UserToolSessionApprovalKindExtensionPermissionAccess UserToolSessionApprovalKind = "extension-permission-access" - UserToolSessionApprovalKindMcp UserToolSessionApprovalKind = "mcp" - UserToolSessionApprovalKindMemory UserToolSessionApprovalKind = "memory" - UserToolSessionApprovalKindRead UserToolSessionApprovalKind = "read" - UserToolSessionApprovalKindWrite UserToolSessionApprovalKind = "write" -) +// Experimental: HistoryAPI contains experimental APIs that may change or be removed. +type HistoryAPI sessionAPI -// Type of change represented by this file diff. -// Experimental: WorkspaceDiffFileChangeType is part of an experimental API and may change -// or be removed. -type WorkspaceDiffFileChangeType string +// AbortManualCompaction aborts any in-progress manual compaction on a local session. +// +// RPC method: session.history.abortManualCompaction. +// +// Returns: Indicates whether an in-progress manual compaction was aborted. +func (a *HistoryAPI) AbortManualCompaction(ctx context.Context) (*HistoryAbortManualCompactionResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.history.abortManualCompaction", req) + if err != nil { + return nil, err + } + var result HistoryAbortManualCompactionResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - // The file was added. - WorkspaceDiffFileChangeTypeAdded WorkspaceDiffFileChangeType = "added" - // The file was deleted. - WorkspaceDiffFileChangeTypeDeleted WorkspaceDiffFileChangeType = "deleted" - // The file was modified. - WorkspaceDiffFileChangeTypeModified WorkspaceDiffFileChangeType = "modified" - // The file was renamed. - WorkspaceDiffFileChangeTypeRenamed WorkspaceDiffFileChangeType = "renamed" -) +// CancelBackgroundCompaction cancels any in-progress background compaction on a local +// session. +// +// RPC method: session.history.cancelBackgroundCompaction. +// +// Returns: Indicates whether an in-progress background compaction was cancelled. +func (a *HistoryAPI) CancelBackgroundCompaction(ctx context.Context) (*HistoryCancelBackgroundCompactionResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.history.cancelBackgroundCompaction", req) + if err != nil { + return nil, err + } + var result HistoryCancelBackgroundCompactionResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Diff mode requested by the client. -// Experimental: WorkspaceDiffMode is part of an experimental API and may change or be -// removed. -type WorkspaceDiffMode string +// ClearContext clears the session's conversation history, keeping only system and developer +// messages, and seeds the fresh context window with a first user message. Must be called +// from inside a tool handler: the clear has to drop the results of the tool calls its wipe +// orphans, and it rejects when no tool call is in flight. +// +// RPC method: session.history.clearContext. +// +// Parameters: Parameters for clearing the conversation and seeding the window that replaces +// it. +// +// Returns: What a successful clear removed. A clear that could not be applied rejects +// instead of reporting a count. +func (a *HistoryAPI) ClearContext(ctx context.Context, params *HistoryClearContextRequest) (*HistoryClearContextResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["prompt"] = params.Prompt + } + raw, err := a.client.Request(ctx, "session.history.clearContext", req) + if err != nil { + return nil, err + } + var result HistoryClearContextResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - // Return changes compared with the default branch. - WorkspaceDiffModeBranch WorkspaceDiffMode = "branch" - // Return staged, unstaged, and untracked working tree changes. - WorkspaceDiffModeUnstaged WorkspaceDiffMode = "unstaged" -) +// Compacts the session history to reduce context usage. +// +// RPC method: session.history.compact. +// +// Parameters: Optional compaction parameters. +// +// Returns: Compaction outcome with the number of tokens and messages removed, summary text, +// and the resulting context window breakdown. +func (a *HistoryAPI) Compact(ctx context.Context, params ...*SessionHistoryCompactRequest) (*HistoryCompactResult, error) { + var requestParams *SessionHistoryCompactRequest + if len(params) > 0 { + requestParams = params[0] + } + req := map[string]any{"sessionId": a.sessionID} + if requestParams != nil { + if requestParams.CustomInstructions != nil { + req["customInstructions"] = *requestParams.CustomInstructions + } + if requestParams.TokenLimit != nil { + req["tokenLimit"] = *requestParams.TokenLimit + } + if requestParams.Trigger != nil { + req["trigger"] = *requestParams.Trigger + } + } + raw, err := a.client.Request(ctx, "session.history.compact", req) + if err != nil { + return nil, err + } + var result HistoryCompactResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Repository host type, if known -// Experimental: WorkspaceSummaryHostType is part of an experimental API and may change or -// be removed. -type WorkspaceSummaryHostType string +// ListRewindPoints lists the user turns that the session can rewind to. Never rejects for a +// busy session: rewind reads need the session's file-change captures to be settled, so a +// session that still holds active work answers with `unavailableReason: "session-busy"` and +// no points, which the caller can retry. +// +// RPC method: session.history.listRewindPoints. +// +// Returns: Rewind points and file-change-tracking availability for the session. +func (a *HistoryAPI) ListRewindPoints(ctx context.Context) (*HistoryListRewindPointsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.history.listRewindPoints", req) + if err != nil { + return nil, err + } + var result HistoryListRewindPointsResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - // Workspace summary repository is hosted on Azure DevOps. - WorkspaceSummaryHostTypeAdo WorkspaceSummaryHostType = "ado" - // Workspace summary repository is hosted on GitHub. - WorkspaceSummaryHostTypeGithub WorkspaceSummaryHostType = "github" -) +// PreviewRewind previews the files that a conversation-and-files rewind would restore. +// +// RPC method: session.history.previewRewind. +// +// Parameters: Event boundary to preview for conversation-and-files rewind. +// +// Returns: Files and aggregate changes for a prospective rewind. +func (a *HistoryAPI) PreviewRewind(ctx context.Context, params *HistoryPreviewRewindRequest) (*HistoryPreviewRewindResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["eventId"] = params.EventID + } + raw, err := a.client.Request(ctx, "session.history.previewRewind", req) + if err != nil { + return nil, err + } + var result HistoryPreviewRewindResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. -// Experimental: WorkspacesWorkspaceDetailsHostType is part of an experimental API and may -// change or be removed. -type WorkspacesWorkspaceDetailsHostType string +// Rewinds the session conversation, optionally restoring files changed by the discarded +// turns. Not crash-atomic: file restore and conversation truncation are separate stores, +// applied in that order, so a process crash between them can leave the workspace rewound +// while the conversation still contains the discarded turns. There is no recovery journal; +// re-running the same rewind is the recovery path for a crash before truncation lands, +// since file restore is idempotent (already-restored files are reported as skipped) and +// truncation is re-derived from the still-retained boundary event. After truncation lands +// that boundary no longer exists, so the same request is rejected; the only stage that can +// still be outstanding is snapshot pruning, whose failure leaves orphan snapshots the +// capture store tolerates. The reverse inconsistency cannot occur, because truncation is +// never applied before file restore succeeds. +// +// RPC method: session.history.rewind. +// +// Parameters: Boundary and mode for rewinding session history. +// +// Returns: Structured outcome of a rewind request. +func (a *HistoryAPI) Rewind(ctx context.Context, params *HistoryRewindRequest) (*HistoryRewindResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["eventId"] = params.EventID + req["mode"] = params.Mode + } + raw, err := a.client.Request(ctx, "session.history.rewind", req) + if err != nil { + return nil, err + } + var result HistoryRewindResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -const ( - // Workspace repository is hosted on Azure DevOps. - WorkspacesWorkspaceDetailsHostTypeAdo WorkspacesWorkspaceDetailsHostType = "ado" - // Workspace repository is hosted on GitHub. - WorkspacesWorkspaceDetailsHostTypeGithub WorkspacesWorkspaceDetailsHostType = "github" -) +// SummarizeForHandoff produces a markdown summary of the session's conversation context for +// hand-off scenarios. +// +// RPC method: session.history.summarizeForHandoff. +// +// Returns: Markdown summary of the conversation context (empty when not available). +func (a *HistoryAPI) SummarizeForHandoff(ctx context.Context) (*HistorySummarizeForHandoffResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.history.summarizeForHandoff", req) + if err != nil { + return nil, err + } + var result HistorySummarizeForHandoffResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil +} -type serverApi struct { - client *jsonrpc2.Client +// Truncates persisted session history to a specific event. +// +// RPC method: session.history.truncate. +// +// Parameters: Identifier of the event to truncate to; this event and all later events are +// removed. +// +// Returns: Number of events that were removed by the truncation. +func (a *HistoryAPI) Truncate(ctx context.Context, params *HistoryTruncateRequest) (*HistoryTruncateResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["eventId"] = params.EventID + } + raw, err := a.client.Request(ctx, "session.history.truncate", req) + if err != nil { + return nil, err + } + var result HistoryTruncateResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil } -type ServerAccountApi serverApi +// Experimental: InstructionsAPI contains experimental APIs that may change or be removed. +type InstructionsAPI sessionAPI -// GetQuota gets Copilot quota usage for the authenticated user or supplied GitHub token. -// -// RPC method: account.getQuota. +// GetSources gets instruction sources loaded for the session. // -// Parameters: Optional GitHub token used to look up quota for a specific user instead of -// the global auth context. +// RPC method: session.instructions.getSources. // -// Returns: Quota usage snapshots for the resolved user, keyed by quota type. -func (a *ServerAccountApi) GetQuota(ctx context.Context, params *AccountGetQuotaRequest) (*AccountGetQuotaResult, error) { - raw, err := a.client.Request("account.getQuota", params) +// Returns: Instruction sources loaded for the session, in merge order. +func (a *InstructionsAPI) GetSources(ctx context.Context) (*InstructionsGetSourcesResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.instructions.getSources", req) if err != nil { return nil, err } - var result AccountGetQuotaResult + var result InstructionsGetSourcesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ServerAgentRegistryApi contains experimental APIs that may change or be -// removed. -type ServerAgentRegistryApi serverApi +// Experimental: LimitPredictionAPI contains experimental APIs that may change or be removed. +type LimitPredictionAPI sessionAPI -// Spawns a managed-server child with the supplied configuration and returns a -// discriminated-union result. The caller (typically the CLI controller) is responsible for -// attaching to the spawned child and sending any follow-up prompt. When the -// controller-local spawn gate is closed the server returns JSON-RPC MethodNotFound. +// Predicts an AI-credit session limit for the session's resolved model. Returns an +// unavailable result instead of falling back when the current model is unresolved auto. // -// RPC method: agentRegistry.spawn. +// RPC method: session.limitPrediction.predict. // -// Parameters: Inputs to spawn a managed-server child via the controller's spawn delegate. +// Parameters: Parameters for predicting an AI-credit session limit. Omitting `modelId` uses +// the session's currently selected model. // -// Returns: Outcome of an agentRegistry.spawn call. -func (a *ServerAgentRegistryApi) Spawn(ctx context.Context, params *AgentRegistrySpawnRequest) (AgentRegistrySpawnResult, error) { - raw, err := a.client.Request("agentRegistry.spawn", params) +// Returns: Prediction result. Available results include prediction details; unavailable +// results include an explicit reason. +func (a *LimitPredictionAPI) Predict(ctx context.Context, params ...*SessionLimitPredictionPredictRequest) (SessionLimitPredictionResult, error) { + var requestParams *SessionLimitPredictionPredictRequest + if len(params) > 0 { + requestParams = params[0] + } + req := map[string]any{"sessionId": a.sessionID} + if requestParams != nil { + if requestParams.ClientType != nil { + req["clientType"] = *requestParams.ClientType + } + if requestParams.ModelID != nil { + req["modelId"] = *requestParams.ModelID + } + } + raw, err := a.client.Request(ctx, "session.limitPrediction.predict", req) if err != nil { return nil, err } - result, err := unmarshalAgentRegistrySpawnResult(raw) + result, err := unmarshalSessionLimitPredictionResult(raw) if err != nil { return nil, err } return result, nil } -type ServerMcpApi serverApi +// Experimental: LspAPI contains experimental APIs that may change or be removed. +type LspAPI sessionAPI -// Discovers MCP servers from user, workspace, plugin, and builtin sources. -// -// RPC method: mcp.discover. +// Initialize loads the merged LSP configuration set for the session's working directory. // -// Parameters: Optional working directory used as context for MCP server discovery. +// RPC method: session.lsp.initialize. // -// Returns: MCP servers discovered from user, workspace, plugin, and built-in sources. -func (a *ServerMcpApi) Discover(ctx context.Context, params *McpDiscoverRequest) (*McpDiscoverResult, error) { - raw, err := a.client.Request("mcp.discover", params) +// Parameters: Parameters for (re)loading the merged LSP configuration set. +func (a *LspAPI) Initialize(ctx context.Context, params *LspInitializeRequest) (*SessionLspInitializeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Force != nil { + req["force"] = *params.Force + } + if params.GitRoot != nil { + req["gitRoot"] = *params.GitRoot + } + if params.WorkingDirectory != nil { + req["workingDirectory"] = *params.WorkingDirectory + } + } + raw, err := a.client.Request(ctx, "session.lsp.initialize", req) if err != nil { return nil, err } - var result McpDiscoverResult + var result SessionLspInitializeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerMcpConfigApi serverApi +// Experimental: MCPAPI contains experimental APIs that may change or be removed. +type MCPAPI sessionAPI -// Adds an MCP server to user configuration. +// CancelSamplingExecution cancels an in-flight MCP sampling execution by request ID. // -// RPC method: mcp.config.add. +// RPC method: session.mcp.cancelSamplingExecution. // -// Parameters: MCP server name and configuration to add to user configuration. -func (a *ServerMcpConfigApi) Add(ctx context.Context, params *McpConfigAddRequest) (*McpConfigAddResult, error) { - raw, err := a.client.Request("mcp.config.add", params) +// Parameters: The requestId previously passed to executeSampling that should be cancelled. +// +// Returns: Indicates whether an in-flight sampling execution with the given requestId was +// found and cancelled. +func (a *MCPAPI) CancelSamplingExecution(ctx context.Context, params *MCPCancelSamplingExecutionParams) (*MCPCancelSamplingExecutionResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["requestId"] = params.RequestID + } + raw, err := a.client.Request(ctx, "session.mcp.cancelSamplingExecution", req) if err != nil { return nil, err } - var result McpConfigAddResult + var result MCPCancelSamplingExecutionResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Disables MCP servers in user configuration for new sessions. +// Disables an MCP server for the session. // -// RPC method: mcp.config.disable. +// RPC method: session.mcp.disable. // -// Parameters: MCP server names to disable for new sessions. -func (a *ServerMcpConfigApi) Disable(ctx context.Context, params *McpConfigDisableRequest) (*McpConfigDisableResult, error) { - raw, err := a.client.Request("mcp.config.disable", params) +// Parameters: Name of the MCP server to disable for the session. +func (a *MCPAPI) Disable(ctx context.Context, params *MCPDisableRequest) (*SessionMCPDisableResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.disable", req) if err != nil { return nil, err } - var result McpConfigDisableResult + var result SessionMCPDisableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Enables MCP servers in user configuration for new sessions. +// Enables an MCP server for the session. // -// RPC method: mcp.config.enable. +// RPC method: session.mcp.enable. // -// Parameters: MCP server names to enable for new sessions. -func (a *ServerMcpConfigApi) Enable(ctx context.Context, params *McpConfigEnableRequest) (*McpConfigEnableResult, error) { - raw, err := a.client.Request("mcp.config.enable", params) +// Parameters: Name of the MCP server to enable for the session. +func (a *MCPAPI) Enable(ctx context.Context, params *MCPEnableRequest) (*SessionMCPEnableResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.enable", req) if err != nil { return nil, err } - var result McpConfigEnableResult + var result SessionMCPEnableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists MCP servers from user configuration. +// ExecuteSampling runs an MCP sampling inference on behalf of an MCP server. // -// RPC method: mcp.config.list. +// RPC method: session.mcp.executeSampling. // -// Returns: User-configured MCP servers, keyed by server name. -func (a *ServerMcpConfigApi) List(ctx context.Context) (*McpConfigList, error) { - raw, err := a.client.Request("mcp.config.list", nil) +// Parameters: Identifiers and raw MCP CreateMessageRequest params used to run a sampling +// inference. +// +// Returns: Outcome of an MCP sampling execution: success result, failure error, or +// cancellation. +func (a *MCPAPI) ExecuteSampling(ctx context.Context, params *MCPExecuteSamplingParams) (*MCPSamplingExecutionResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["mcpRequestId"] = params.MCPRequestID + req["request"] = params.Request + req["requestId"] = params.RequestID + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.executeSampling", req) if err != nil { return nil, err } - var result McpConfigList + var result MCPSamplingExecutionResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reload drops this runtime process's in-memory MCP server-definition cache so the next MCP -// config read observes disk. +// IsServerRunning checks whether a named MCP server is currently running on the session's +// host. // -// RPC method: mcp.config.reload. -func (a *ServerMcpConfigApi) Reload(ctx context.Context) (*McpConfigReloadResult, error) { - raw, err := a.client.Request("mcp.config.reload", nil) +// RPC method: session.mcp.isServerRunning. +// +// Parameters: Server name to check running status for. +// +// Returns: Whether the named MCP server is running. +func (a *MCPAPI) IsServerRunning(ctx context.Context, params *MCPIsServerRunningRequest) (*MCPIsServerRunningResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.isServerRunning", req) if err != nil { return nil, err } - var result McpConfigReloadResult + var result MCPIsServerRunningResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Removes an MCP server from user configuration. +// Lists MCP servers configured for the session, their connection status, and host-level +// state. The host-level state (disabled/filtered servers, failed/needs-auth/pending +// connections, mcp3p policy, full config) is empty/zero when no MCP host has been +// initialized for the session. // -// RPC method: mcp.config.remove. +// RPC method: session.mcp.list. // -// Parameters: MCP server name to remove from user configuration. -func (a *ServerMcpConfigApi) Remove(ctx context.Context, params *McpConfigRemoveRequest) (*McpConfigRemoveResult, error) { - raw, err := a.client.Request("mcp.config.remove", params) +// Returns: MCP servers configured for the session, with their connection status and +// host-level state. +func (a *MCPAPI) List(ctx context.Context) (*MCPServerList, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.mcp.list", req) if err != nil { return nil, err } - var result McpConfigRemoveResult + var result MCPServerList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Updates an MCP server in user configuration. +// ListTools lists the tools exposed by a connected MCP server on this session's host. This +// performs a live `tools/list` request. Tool UI metadata is returned independently of +// whether MCP Apps rendering is enabled for the session. // -// RPC method: mcp.config.update. +// RPC method: session.mcp.listTools. // -// Parameters: MCP server name and replacement configuration to write to user configuration. -func (a *ServerMcpConfigApi) Update(ctx context.Context, params *McpConfigUpdateRequest) (*McpConfigUpdateResult, error) { - raw, err := a.client.Request("mcp.config.update", params) +// Parameters: Server name whose tool list should be returned. +// +// Returns: Tools exposed by the connected MCP server. Throws when the server is not +// connected. +func (a *MCPAPI) ListTools(ctx context.Context, params *MCPListToolsRequest) (*MCPListToolsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.listTools", req) if err != nil { return nil, err } - var result McpConfigUpdateResult + var result MCPListToolsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func (s *ServerMcpApi) Config() *ServerMcpConfigApi { - return (*ServerMcpConfigApi)(s) +// Reloads MCP server connections for the session. +// +// RPC method: session.mcp.reload. +func (a *MCPAPI) Reload(ctx context.Context) (*SessionMCPReloadResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.mcp.reload", req) + if err != nil { + return nil, err + } + var result SessionMCPReloadResult + if err := json.Unmarshal(raw, &result); err != nil { + return nil, err + } + return &result, nil } -type ServerModelsApi serverApi - -// Lists Copilot models available to the authenticated user. -// -// RPC method: models.list. +// RemoveGitHub removes the auto-managed `github` MCP server when present. // -// Parameters: Optional GitHub token used to list models for a specific user instead of the -// global auth context. +// RPC method: session.mcp.removeGitHub. // -// Returns: List of Copilot models available to the resolved user, including capabilities -// and billing metadata. -func (a *ServerModelsApi) List(ctx context.Context, params *ModelsListRequest) (*ModelList, error) { - raw, err := a.client.Request("models.list", params) +// Returns: Indicates whether the auto-managed `github` MCP server was removed (false when +// nothing to remove). +func (a *MCPAPI) RemoveGitHub(ctx context.Context) (*MCPRemoveGitHubResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.mcp.removeGitHub", req) if err != nil { return nil, err } - var result ModelList + var result MCPRemoveGitHubResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerSecretsApi serverApi - -// AddFilterValues registers secret values for redaction in session logs and exports. The -// SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens). -// -// RPC method: secrets.addFilterValues. +// RestartServer restarts an individual MCP server on the live session (stops then starts). +// Omit `config` for a config-free restart-by-name of an already-configured server; supply +// `config` to restart with a replacement configuration. Session-scoped and ephemeral: does +// NOT modify persistent user configuration (`mcp.config.*`). // -// Parameters: Secret values to add to the redaction filter. +// RPC method: session.mcp.restartServer. // -// Returns: Confirmation that the secret values were registered. -func (a *ServerSecretsApi) AddFilterValues(ctx context.Context, params *SecretsAddFilterValuesRequest) (*SecretsAddFilterValuesResult, error) { - raw, err := a.client.Request("secrets.addFilterValues", params) +// Parameters: Server name and optional replacement configuration for an individual MCP +// server restart. Omit `config` for a config-free restart-by-name of an already-configured +// server. +func (a *MCPAPI) RestartServer(ctx context.Context, params *MCPRestartServerRequest) (*SessionMCPRestartServerResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Config != nil { + req["config"] = params.Config + } + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.restartServer", req) if err != nil { return nil, err } - var result SecretsAddFilterValuesResult + var result SessionMCPRestartServerResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerSessionFsApi serverApi - -// SetProvider registers an SDK client as the session filesystem provider. +// SetEnvValueMode sets how environment-variable values supplied to MCP servers are resolved +// (direct or indirect). // -// RPC method: sessionFs.setProvider. +// RPC method: session.mcp.setEnvValueMode. // -// Parameters: Initial working directory, session-state path layout, and path conventions -// used to register the calling SDK client as the session filesystem provider. +// Parameters: Mode controlling how MCP server env values are resolved (`direct` or +// `indirect`). // -// Returns: Indicates whether the calling client was registered as the session filesystem -// provider. -func (a *ServerSessionFsApi) SetProvider(ctx context.Context, params *SessionFsSetProviderRequest) (*SessionFsSetProviderResult, error) { - raw, err := a.client.Request("sessionFs.setProvider", params) +// Returns: Env-value mode recorded on the session after the update. +func (a *MCPAPI) SetEnvValueMode(ctx context.Context, params *MCPSetEnvValueModeParams) (*MCPSetEnvValueModeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["mode"] = params.Mode + } + raw, err := a.client.Request(ctx, "session.mcp.setEnvValueMode", req) if err != nil { return nil, err } - var result SessionFsSetProviderResult + var result MCPSetEnvValueModeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ServerSessionsApi contains experimental APIs that may change or be removed. -type ServerSessionsApi serverApi - -// BulkDelete closes, deactivates, and deletes a set of sessions, returning the bytes freed -// per session. +// StartServer starts an individual MCP server on the live session. Omit `config` for a +// config-free start-by-name of an already-configured server (reuses the server's +// already-registered configuration); supply `config` to start from a caller-supplied +// configuration. Session-scoped and ephemeral: the server is added to this session's +// running set only and is reaped when the session ends. Does NOT modify persistent user +// configuration (`mcp.config.*`), so it does not affect future sessions. The server +// surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / +// `session.mcp_server_status_changed` events like any other server. // -// RPC method: sessions.bulkDelete. -// -// Parameters: Session IDs to close, deactivate, and delete from disk. +// RPC method: session.mcp.startServer. // -// Returns: Map of sessionId -> bytes freed by removing the session's workspace directory. -func (a *ServerSessionsApi) BulkDelete(ctx context.Context, params *SessionsBulkDeleteRequest) (*SessionBulkDeleteResult, error) { - raw, err := a.client.Request("sessions.bulkDelete", params) +// Parameters: Server name and optional configuration for an individual MCP server start. +// Omit `config` for a config-free start-by-name of an already-configured server. +func (a *MCPAPI) StartServer(ctx context.Context, params *MCPStartServerRequest) (*SessionMCPStartServerResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Config != nil { + req["config"] = params.Config + } + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.startServer", req) if err != nil { return nil, err } - var result SessionBulkDeleteResult + var result SessionMCPStartServerResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// CheckInUse returns the subset of the supplied session IDs that are currently held by -// another running process. +// StopServer stops an individual MCP server on the session's host. // -// RPC method: sessions.checkInUse. -// -// Parameters: Session IDs to test for live in-use locks. +// RPC method: session.mcp.stopServer. // -// Returns: Session IDs from the input set that are currently in use by another process. -func (a *ServerSessionsApi) CheckInUse(ctx context.Context, params *SessionsCheckInUseRequest) (*SessionsCheckInUseResult, error) { - raw, err := a.client.Request("sessions.checkInUse", params) +// Parameters: Server name for an individual MCP server stop. +func (a *MCPAPI) StopServer(ctx context.Context, params *MCPStopServerRequest) (*SessionMCPStopServerResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.stopServer", req) if err != nil { return nil, err } - var result SessionsCheckInUseResult + var result SessionMCPStopServerResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and -// disposes the active session. +// Experimental: MCPAppsAPI contains experimental APIs that may change or be removed. +type MCPAppsAPI sessionAPI + +// CallTool call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check +// that prevents an app iframe from invoking model-only tools. Returns the standard MCP +// `CallToolResult`. // -// RPC method: sessions.close. +// RPC method: session.mcp.apps.callTool. // -// Parameters: Session ID to close. +// Parameters: MCP server, tool name, and arguments to invoke from an MCP App view. // -// Returns: Closes a session: emits shutdown, flushes pending events to disk, releases the -// in-use lock, disposes the active session. Idempotent: succeeds even if the session is not -// currently active. -func (a *ServerSessionsApi) Close(ctx context.Context, params *SessionsCloseRequest) (*SessionsCloseResult, error) { - raw, err := a.client.Request("sessions.close", params) +// Returns: Standard MCP CallToolResult +func (a *MCPAppsAPI) CallTool(ctx context.Context, params *MCPAppsCallToolRequest) (*SessionMCPAppsCallToolResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Arguments != nil { + req["arguments"] = params.Arguments + } + req["originServerName"] = params.OriginServerName + req["serverName"] = params.ServerName + req["toolName"] = params.ToolName + } + raw, err := a.client.Request(ctx, "session.mcp.apps.callTool", req) if err != nil { return nil, err } - var result SessionsCloseResult + var result SessionMCPAppsCallToolResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Connects to an existing remote session and exposes it as an SDK session. +// Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, +// feature-flag state, advertised extension, and how many tools have `_meta.ui` populated. // -// RPC method: sessions.connect. +// RPC method: session.mcp.apps.diagnose. // -// Parameters: Remote session connection parameters. +// Parameters: MCP server to diagnose MCP Apps wiring for. // -// Returns: Remote session connection result. -func (a *ServerSessionsApi) Connect(ctx context.Context, params *ConnectRemoteSessionParams) (*RemoteSessionConnectionResult, error) { - raw, err := a.client.Request("sessions.connect", params) +// Returns: Diagnostic snapshot of MCP Apps wiring for the named server. +func (a *MCPAppsAPI) Diagnose(ctx context.Context, params *MCPAppsDiagnoseRequest) (*MCPAppsDiagnoseResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.apps.diagnose", req) if err != nil { return nil, err } - var result RemoteSessionConnectionResult + var result MCPAppsDiagnoseResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// EnrichMetadata backfills missing summary and context fields on the supplied session -// metadata records. -// -// RPC method: sessions.enrichMetadata. +// GetHostContext read the current host context advertised to MCP App guests. // -// Parameters: Session metadata records to enrich with summary and context information. +// RPC method: session.mcp.apps.getHostContext. // -// Returns: The enriched metadata records, with summary and context fields backfilled where -// available. Sessions confirmed empty and unnamed are omitted. -func (a *ServerSessionsApi) EnrichMetadata(ctx context.Context, params *SessionsEnrichMetadataRequest) (*SessionEnrichMetadataResult, error) { - raw, err := a.client.Request("sessions.enrichMetadata", params) +// Returns: Current host context advertised to MCP App guests. +func (a *MCPAppsAPI) GetHostContext(ctx context.Context) (*MCPAppsHostContext, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.mcp.apps.getHostContext", req) if err != nil { return nil, err } - var result SessionEnrichMetadataResult + var result MCPAppsHostContext if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// FindByPrefix resolves a UUID prefix to a unique session ID, if exactly one session -// matches. +// ListTools list tools that an MCP App view is allowed to call (SEP-1865 visibility +// filter). Returns tools whose `_meta.ui.visibility` is unset (default `["model","app"]`) +// or includes `"app"`. // -// RPC method: sessions.findByPrefix. +// RPC method: session.mcp.apps.listTools. // -// Parameters: UUID prefix to resolve to a unique session ID. +// Parameters: MCP server to list app-callable tools for. // -// Returns: Session ID matching the prefix, omitted when no unique match exists. -func (a *ServerSessionsApi) FindByPrefix(ctx context.Context, params *SessionsFindByPrefixRequest) (*SessionsFindByPrefixResult, error) { - raw, err := a.client.Request("sessions.findByPrefix", params) +// Returns: App-callable tools from the named MCP server. +func (a *MCPAppsAPI) ListTools(ctx context.Context, params *MCPAppsListToolsRequest) (*MCPAppsListToolsResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["originServerName"] = params.OriginServerName + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.apps.listTools", req) if err != nil { return nil, err } - var result SessionsFindByPrefixResult + var result MCPAppsListToolsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// FindByTaskId finds the local session bound to a GitHub task ID, if any. +// ReadResource fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) +// from a connected server. Requires the `mcp-apps` session capability. // -// RPC method: sessions.findByTaskId. +// RPC method: session.mcp.apps.readResource. // -// Parameters: GitHub task ID to look up. +// Parameters: MCP server and resource URI to fetch. // -// Returns: ID of the local session bound to the given GitHub task, or omitted when none. -func (a *ServerSessionsApi) FindByTaskId(ctx context.Context, params *SessionsFindByTaskIDRequest) (*SessionsFindByTaskIDResult, error) { - raw, err := a.client.Request("sessions.findByTaskId", params) +// Returns: Resource contents returned by the MCP server. +func (a *MCPAppsAPI) ReadResource(ctx context.Context, params *MCPAppsReadResourceRequest) (*MCPAppsReadResourceResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + req["uri"] = params.URI + } + raw, err := a.client.Request(ctx, "session.mcp.apps.readResource", req) if err != nil { return nil, err } - var result SessionsFindByTaskIDResult + var result MCPAppsReadResourceResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Fork creates a new session by forking persisted history from an existing session. -// -// RPC method: sessions.fork. +// SetHostContext replace the host context returned to MCP App guests on `ui/initialize`. +// Hosts use this to advertise theme, locale, or other metadata to the guest UI. // -// Parameters: Source session identifier to fork from, optional event-ID boundary, and -// optional friendly name for the new session. +// RPC method: session.mcp.apps.setHostContext. // -// Returns: Identifier and optional friendly name assigned to the newly forked session. -func (a *ServerSessionsApi) Fork(ctx context.Context, params *SessionsForkRequest) (*SessionsForkResult, error) { - raw, err := a.client.Request("sessions.fork", params) +// Parameters: Host context to advertise to MCP App guests. +func (a *MCPAppsAPI) SetHostContext(ctx context.Context, params *MCPAppsSetHostContextRequest) (*SessionMCPAppsSetHostContextResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["context"] = params.Context + } + raw, err := a.client.Request(ctx, "session.mcp.apps.setHostContext", req) if err != nil { return nil, err } - var result SessionsForkResult + var result SessionMCPAppsSetHostContextResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetEventFilePath computes the absolute path to a session's persisted events.jsonl file. +// Experimental: Apps returns experimental APIs that may change or be removed. +func (s *MCPAPI) Apps() *MCPAppsAPI { + return (*MCPAppsAPI)(s) +} + +// Experimental: MCPHeadersAPI contains experimental APIs that may change or be removed. +type MCPHeadersAPI sessionAPI + +// HandlePendingHeadersRefreshRequest responds to a pending MCP dynamic headers refresh +// request. Hosts that subscribe to `mcp.headers_refresh_required` use this to provide +// short-lived per-server headers or to indicate that no dynamic headers are available for +// this refresh. // -// RPC method: sessions.getEventFilePath. +// RPC method: session.mcp.headers.handlePendingHeadersRefreshRequest. // -// Parameters: Session ID whose event-log file path to compute. +// Parameters: MCP headers refresh request id and the host response. // -// Returns: Absolute path to the session's events.jsonl file on disk. -func (a *ServerSessionsApi) GetEventFilePath(ctx context.Context, params *SessionsGetEventFilePathRequest) (*SessionsGetEventFilePathResult, error) { - raw, err := a.client.Request("sessions.getEventFilePath", params) +// Returns: Indicates whether the pending MCP headers refresh response was accepted. +func (a *MCPHeadersAPI) HandlePendingHeadersRefreshRequest(ctx context.Context, params *MCPHeadersHandlePendingHeadersRefreshRequestRequest) (*MCPHeadersHandlePendingHeadersRefreshRequestResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["requestId"] = params.RequestID + req["result"] = params.Result + } + raw, err := a.client.Request(ctx, "session.mcp.headers.handlePendingHeadersRefreshRequest", req) if err != nil { return nil, err } - var result SessionsGetEventFilePathResult + var result MCPHeadersHandlePendingHeadersRefreshRequestResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetLastForContext returns the most-relevant prior session for a given working-directory -// context. -// -// RPC method: sessions.getLastForContext. +// Experimental: Headers returns experimental APIs that may change or be removed. +func (s *MCPAPI) Headers() *MCPHeadersAPI { + return (*MCPHeadersAPI)(s) +} + +// Experimental: MCPOauthAPI contains experimental APIs that may change or be removed. +type MCPOauthAPI sessionAPI + +// AuthenticationStateChanged notifies the session that MCP OAuth authentication succeeded +// and updated credentials were persisted, so cached tool definitions can be refreshed. // -// Parameters: Optional working-directory context used to score session relevance. +// RPC method: session.mcp.oauth.authenticationStateChanged. // -// Returns: Most-relevant session ID for the supplied context, or omitted when no sessions -// exist. -func (a *ServerSessionsApi) GetLastForContext(ctx context.Context, params *SessionsGetLastForContextRequest) (*SessionsGetLastForContextResult, error) { - raw, err := a.client.Request("sessions.getLastForContext", params) +// Parameters: Identifies the MCP server whose persisted OAuth credentials were updated. +func (a *MCPOauthAPI) AuthenticationStateChanged(ctx context.Context, params *MCPOauthAuthenticationStateChangedRequest) (*SessionMCPOauthAuthenticationStateChangedResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.RefreshSessionToken != nil { + req["refreshSessionToken"] = *params.RefreshSessionToken + } + if params.ServerName != nil { + req["serverName"] = *params.ServerName + } + } + raw, err := a.client.Request(ctx, "session.mcp.oauth.authenticationStateChanged", req) if err != nil { return nil, err } - var result SessionsGetLastForContextResult + var result SessionMCPOauthAuthenticationStateChangedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetPersistedRemoteSteerable returns a session's persisted remote-steerable flag, if any -// has been recorded. +// HandlePendingRequest resolves a pending MCP OAuth request with a host-provided token or +// cancellation. The pending request is emitted as mcp.oauth_required with the data +// necessary to authorize the request. // -// RPC method: sessions.getPersistedRemoteSteerable. +// RPC method: session.mcp.oauth.handlePendingRequest. // -// Parameters: Session ID to look up the persisted remote-steerable flag for. +// Parameters: Pending MCP OAuth request ID and host-provided token or cancellation response. // -// Returns: The session's persisted remote-steerable flag, or omitted when no value has been -// persisted. -func (a *ServerSessionsApi) GetPersistedRemoteSteerable(ctx context.Context, params *SessionsGetPersistedRemoteSteerableRequest) (*SessionsGetPersistedRemoteSteerableResult, error) { - raw, err := a.client.Request("sessions.getPersistedRemoteSteerable", params) +// Returns: Indicates whether the pending MCP OAuth response was accepted. +func (a *MCPOauthAPI) HandlePendingRequest(ctx context.Context, params *MCPOauthHandlePendingRequest) (*MCPOauthHandlePendingResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["requestId"] = params.RequestID + req["result"] = params.Result + } + raw, err := a.client.Request(ctx, "session.mcp.oauth.handlePendingRequest", req) if err != nil { return nil, err } - var result SessionsGetPersistedRemoteSteerableResult + var result MCPOauthHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetSizes returns the on-disk byte size of each session's workspace directory. +// Login starts OAuth authentication for a remote MCP server. // -// RPC method: sessions.getSizes. +// RPC method: session.mcp.oauth.login. // -// Returns: Map of sessionId -> on-disk size in bytes for each session's workspace directory. -func (a *ServerSessionsApi) GetSizes(ctx context.Context) (*SessionSizes, error) { - raw, err := a.client.Request("sessions.getSizes", nil) +// Parameters: Remote MCP server name and optional overrides controlling reauthentication, +// OAuth client display name, callback success-page copy, and static OAuth client selection. +// +// Returns: OAuth authorization URL the caller should open, or empty when cached tokens +// already authenticated the server. +func (a *MCPOauthAPI) Login(ctx context.Context, params *MCPOauthLoginRequest) (*MCPOauthLoginResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.CallbackSuccessMessage != nil { + req["callbackSuccessMessage"] = *params.CallbackSuccessMessage + } + if params.ClientID != nil { + req["clientId"] = *params.ClientID + } + if params.ClientName != nil { + req["clientName"] = *params.ClientName + } + if params.ClientSecret != nil { + req["clientSecret"] = *params.ClientSecret + } + if params.ForceReauth != nil { + req["forceReauth"] = *params.ForceReauth + } + if params.GrantType != nil { + req["grantType"] = *params.GrantType + } + if params.PublicClient != nil { + req["publicClient"] = *params.PublicClient + } + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.oauth.login", req) if err != nil { return nil, err } - var result SessionSizes + var result MCPOauthLoginResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists persisted sessions, optionally filtered by working-directory context. +// Responds to a pending MCP OAuth authorization request by its request id. // -// RPC method: sessions.list. +// RPC method: session.mcp.oauth.respond. // -// Parameters: Optional metadata-load limit and filters applied to the returned sessions. +// Parameters: Pending MCP OAuth request id to respond to. // -// Returns: Persisted sessions matching the filter, ordered most-recently-modified first. -func (a *ServerSessionsApi) List(ctx context.Context, params *SessionsListRequest) (*SessionList, error) { - raw, err := a.client.Request("sessions.list", params) +// Returns: Indicates whether the pending MCP OAuth response was accepted. +func (a *MCPOauthAPI) Respond(ctx context.Context, params *MCPOauthRespondRequest) (*MCPOauthRespondResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["requestId"] = params.RequestID + } + raw, err := a.client.Request(ctx, "session.mcp.oauth.respond", req) if err != nil { return nil, err } - var result SessionList + var result MCPOauthRespondResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// LoadDeferredRepoHooks loads previously-deferred repo-level hooks on the active session, -// returning queued startup prompts. +// Experimental: Oauth returns experimental APIs that may change or be removed. +func (s *MCPAPI) Oauth() *MCPOauthAPI { + return (*MCPOauthAPI)(s) +} + +// Experimental: MCPResourcesAPI contains experimental APIs that may change or be removed. +type MCPResourcesAPI sessionAPI + +// List enumerate one page of resources a connected MCP server exposes (proxies MCP +// `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`. // -// RPC method: sessions.loadDeferredRepoHooks. +// RPC method: session.mcp.resources.list. // -// Parameters: Active session ID whose deferred repo-level hooks should be loaded. +// Parameters: MCP server whose resources to enumerate. // -// Returns: Queued repo-level startup prompts and the total hook command count after loading. -func (a *ServerSessionsApi) LoadDeferredRepoHooks(ctx context.Context, params *SessionsLoadDeferredRepoHooksRequest) (*SessionLoadDeferredRepoHooksResult, error) { - raw, err := a.client.Request("sessions.loadDeferredRepoHooks", params) +// Returns: One page of resources advertised by the named MCP server. +func (a *MCPResourcesAPI) List(ctx context.Context, params *MCPResourcesListRequest) (*MCPResourcesListResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Cursor != nil { + req["cursor"] = *params.Cursor + } + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.resources.list", req) if err != nil { return nil, err } - var result SessionLoadDeferredRepoHooksResult + var result MCPResourcesListResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// PruneOld deletes sessions older than the given threshold, with optional dry-run and -// exclusion list. +// ListTemplates enumerate one page of resource templates a connected MCP server exposes +// (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's +// `nextCursor`. // -// RPC method: sessions.pruneOld. +// RPC method: session.mcp.resources.listTemplates. // -// Parameters: Age threshold and optional flags controlling which old sessions are pruned -// (or simulated when dryRun is true). +// Parameters: MCP server whose resource templates to enumerate. // -// Returns: Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, -// total bytes freed, and the dry-run flag. -func (a *ServerSessionsApi) PruneOld(ctx context.Context, params *SessionsPruneOldRequest) (*SessionPruneResult, error) { - raw, err := a.client.Request("sessions.pruneOld", params) +// Returns: One page of resource templates advertised by the named MCP server. +func (a *MCPResourcesAPI) ListTemplates(ctx context.Context, params *MCPResourcesListTemplatesRequest) (*MCPResourcesListTemplatesResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Cursor != nil { + req["cursor"] = *params.Cursor + } + req["serverName"] = params.ServerName + } + raw, err := a.client.Request(ctx, "session.mcp.resources.listTemplates", req) if err != nil { return nil, err } - var result SessionPruneResult + var result MCPResourcesListTemplatesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReleaseLock releases the in-use lock held by this process for a session. +// Read fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`). // -// RPC method: sessions.releaseLock. +// RPC method: session.mcp.resources.read. // -// Parameters: Session ID whose in-use lock should be released. +// Parameters: MCP server and resource URI to fetch. // -// Returns: Release the in-use lock held by this process for the given session. No-op when -// this process does not currently hold a lock for the session. -func (a *ServerSessionsApi) ReleaseLock(ctx context.Context, params *SessionsReleaseLockRequest) (*SessionsReleaseLockResult, error) { - raw, err := a.client.Request("sessions.releaseLock", params) +// Returns: Resource contents returned by the MCP server. +func (a *MCPResourcesAPI) Read(ctx context.Context, params *MCPResourcesReadRequest) (*MCPResourcesReadResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["serverName"] = params.ServerName + req["uri"] = params.URI + } + raw, err := a.client.Request(ctx, "session.mcp.resources.read", req) if err != nil { return nil, err } - var result SessionsReleaseLockResult + var result MCPResourcesReadResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReloadPluginHooks reloads user, plugin, and (optionally) repo hooks on the active session. -// -// RPC method: sessions.reloadPluginHooks. +// Experimental: Resources returns experimental APIs that may change or be removed. +func (s *MCPAPI) Resources() *MCPResourcesAPI { + return (*MCPResourcesAPI)(s) +} + +// Experimental: MetadataAPI contains experimental APIs that may change or be removed. +type MetadataAPI sessionAPI + +// Activity returns a snapshot of activity flags for the session. // -// Parameters: Active session ID and an optional flag for deferring repo-level hooks until -// folder trust. +// RPC method: session.metadata.activity. // -// Returns: Reload all hooks (user, plugin, optionally repo) and apply them to the active -// session. Call after installing or removing plugins so their hooks take effect -// immediately. No-op when no active session matches the given sessionId. -func (a *ServerSessionsApi) ReloadPluginHooks(ctx context.Context, params *SessionsReloadPluginHooksRequest) (*SessionsReloadPluginHooksResult, error) { - raw, err := a.client.Request("sessions.reloadPluginHooks", params) +// Returns: Current activity flags for the session. +func (a *MetadataAPI) Activity(ctx context.Context) (*SessionActivity, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.metadata.activity", req) if err != nil { return nil, err } - var result SessionsReloadPluginHooksResult + var result SessionActivity if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Save flushes a session's pending events to disk. +// ContextInfo returns the token breakdown for the session's current context window for a +// given model. // -// RPC method: sessions.save. +// RPC method: session.metadata.contextInfo. // -// Parameters: Session ID whose pending events should be flushed to disk. +// Parameters: Model identifier and token limits used to compute the context-info breakdown. // -// Returns: Flush a session's pending events to disk. No-op when no writer exists for the -// session (e.g., already closed). -func (a *ServerSessionsApi) Save(ctx context.Context, params *SessionsSaveRequest) (*SessionsSaveResult, error) { - raw, err := a.client.Request("sessions.save", params) +// Returns: Token breakdown for the session's current context window, or null if +// uninitialized. +func (a *MetadataAPI) ContextInfo(ctx context.Context, params *MetadataContextInfoRequest) (*MetadataContextInfoResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["outputTokenLimit"] = params.OutputTokenLimit + req["promptTokenLimit"] = params.PromptTokenLimit + if params.SelectedModel != nil { + req["selectedModel"] = *params.SelectedModel + } + } + raw, err := a.client.Request(ctx, "session.metadata.contextInfo", req) if err != nil { return nil, err } - var result SessionsSaveResult + var result MetadataContextInfoResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetAdditionalPlugins replaces the manager-wide additional plugins registered with the -// session manager. -// -// RPC method: sessions.setAdditionalPlugins. +// GetContextAttribution returns the experimental per-source attribution breakdown of the +// session's current context window as a flat list of entries (skills, subagents, MCP +// servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via +// parentId), plus the successful compaction count. The heaviest individual messages are +// available separately via `metadata.getContextHeaviestMessages`. Returns null until the +// session has initialized its system prompt and tool metadata. // -// Parameters: Manager-wide additional plugins to register; replaces any -// previously-configured set. +// RPC method: session.metadata.getContextAttribution. // -// Returns: Replace the manager-wide additional plugins. New session creations and -// subsequent hook reloads see the new set; already-running sessions keep their existing -// hook installation until the next reload. -func (a *ServerSessionsApi) SetAdditionalPlugins(ctx context.Context, params *SessionsSetAdditionalPluginsRequest) (*SessionsSetAdditionalPluginsResult, error) { - raw, err := a.client.Request("sessions.setAdditionalPlugins", params) +// Returns: Per-source attribution breakdown for the session's current context window, or +// null if uninitialized. +func (a *MetadataAPI) GetContextAttribution(ctx context.Context) (*MetadataContextAttributionResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.metadata.getContextAttribution", req) if err != nil { return nil, err } - var result SessionsSetAdditionalPluginsResult + var result MetadataContextAttributionResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerSkillsApi serverApi - -// Discovers skills across global and project sources. +// GetContextHeaviestMessages returns the largest individual messages currently in the +// session's context window, most-expensive first. Companion to +// `metadata.getContextAttribution`. Returns an empty list until the session has initialized. // -// RPC method: skills.discover. +// RPC method: session.metadata.getContextHeaviestMessages. // -// Parameters: Optional project paths and additional skill directories to include in -// discovery. +// Parameters: Parameters for the heaviest-messages query. // -// Returns: Skills discovered across global and project sources. -func (a *ServerSkillsApi) Discover(ctx context.Context, params *SkillsDiscoverRequest) (*ServerSkillList, error) { - raw, err := a.client.Request("skills.discover", params) +// Returns: The heaviest individual messages in the session's context window, most-expensive +// first. +func (a *MetadataAPI) GetContextHeaviestMessages(ctx context.Context, params *MetadataContextHeaviestMessagesRequest) (*MetadataContextHeaviestMessagesResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + if params.Limit != nil { + req["limit"] = *params.Limit + } + } + raw, err := a.client.Request(ctx, "session.metadata.getContextHeaviestMessages", req) if err != nil { return nil, err } - var result ServerSkillList + var result MetadataContextHeaviestMessagesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerSkillsConfigApi serverApi - -// SetDisabledSkills replaces the global list of disabled skills. +// IsProcessing reports whether the local session is currently processing user/agent +// messages. // -// RPC method: skills.config.setDisabledSkills. +// RPC method: session.metadata.isProcessing. // -// Parameters: Skill names to mark as disabled in global configuration, replacing any -// previous list. -func (a *ServerSkillsConfigApi) SetDisabledSkills(ctx context.Context, params *SkillsConfigSetDisabledSkillsRequest) (*SkillsConfigSetDisabledSkillsResult, error) { - raw, err := a.client.Request("skills.config.setDisabledSkills", params) +// Returns: Indicates whether the local session is currently processing a turn or background +// continuation. +func (a *MetadataAPI) IsProcessing(ctx context.Context) (*MetadataIsProcessingResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.metadata.isProcessing", req) if err != nil { return nil, err } - var result SkillsConfigSetDisabledSkillsResult + var result MetadataIsProcessingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func (s *ServerSkillsApi) Config() *ServerSkillsConfigApi { - return (*ServerSkillsConfigApi)(s) -} - -type ServerToolsApi serverApi - -// Lists built-in tools available for a model. +// RecomputeContextTokens re-tokenizes the session's existing messages against a model and +// returns aggregate token totals. // -// RPC method: tools.list. +// RPC method: session.metadata.recomputeContextTokens. // -// Parameters: Optional model identifier whose tool overrides should be applied to the -// listing. +// Parameters: Model identifier to use when re-tokenizing the session's existing messages. // -// Returns: Built-in tools available for the requested model, with their parameters and -// instructions. -func (a *ServerToolsApi) List(ctx context.Context, params *ToolsListRequest) (*ToolList, error) { - raw, err := a.client.Request("tools.list", params) +// Returns: Re-tokenize the session's existing messages against `modelId` and return the +// token totals. Useful for hosts that want an initial estimate of context usage on session +// resume, before the next agent turn fires `session.context_info_changed` events. Returns +// zeros for an empty session. +func (a *MetadataAPI) RecomputeContextTokens(ctx context.Context, params *MetadataRecomputeContextTokensRequest) (*MetadataRecomputeContextTokensResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["modelId"] = params.ModelID + } + raw, err := a.client.Request(ctx, "session.metadata.recomputeContextTokens", req) if err != nil { return nil, err } - var result ToolList + var result MetadataRecomputeContextTokensResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -type ServerUserApi serverApi - -type ServerUserSettingsApi serverApi - -// Reload drops this runtime process's in-memory user settings cache so the next settings -// read observes disk. +// RecordContextChange records a working-directory/git context change and emits a +// `session.context_changed` event. For a local session, a report whose `cwd` diverges from +// the session's current working directory is ignored (the call still succeeds but records +// nothing and emits no event): a local session's working directory is authoritative and is +// moved via `metadata.setWorkingDirectory` (or an SDK `session.resume` that supplies a +// `workingDirectory`), not by this method. // -// RPC method: user.settings.reload. -func (a *ServerUserSettingsApi) Reload(ctx context.Context) (*UserSettingsReloadResult, error) { - raw, err := a.client.Request("user.settings.reload", nil) +// RPC method: session.metadata.recordContextChange. +// +// Parameters: Updated working-directory/git context to record on the session. +// +// Returns: Notify the session that its working directory context has changed. Emits a +// `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline +// UI) can react. Use this when the host has detected a cwd/branch/repo change outside the +// session's normal lifecycle (e.g., after a shell command in interactive mode). For a local +// session, a report whose `cwd` diverges from the session's current working directory is +// ignored (the call still succeeds but records nothing and emits no event); move a local +// session's working directory via `metadata.setWorkingDirectory` instead. +func (a *MetadataAPI) RecordContextChange(ctx context.Context, params *MetadataRecordContextChangeRequest) (*MetadataRecordContextChangeResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["context"] = params.Context + } + raw, err := a.client.Request(ctx, "session.metadata.recordContextChange", req) if err != nil { return nil, err } - var result UserSettingsReloadResult + var result MetadataRecordContextChangeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func (s *ServerUserApi) Settings() *ServerUserSettingsApi { - return (*ServerUserSettingsApi)(s) -} - -// ServerRpc provides typed server-scoped RPC methods. -type ServerRpc struct { - // Reuse a single struct instead of allocating one for each service on the heap. - common serverApi - - Account *ServerAccountApi - AgentRegistry *ServerAgentRegistryApi - Mcp *ServerMcpApi - Models *ServerModelsApi - Secrets *ServerSecretsApi - SessionFs *ServerSessionFsApi - Sessions *ServerSessionsApi - Skills *ServerSkillsApi - Tools *ServerToolsApi - User *ServerUserApi -} - -// Ping checks server responsiveness and returns protocol information. +// SetWorkingDirectory updates the session's working directory. For local sessions the +// target is validated first (an absolute path that exists on disk) and the permission +// primary directory is re-based; a rejected validation fails the call before any session +// state changes. // -// RPC method: ping. +// RPC method: session.metadata.setWorkingDirectory. // -// Parameters: Optional message to echo back to the caller. +// Parameters: Absolute path to set as the session's new working directory. For local +// sessions the path must be absolute and exist on disk: it is validated before any session +// state changes, and a failing validation rejects the call with nothing mutated, persisted, +// or emitted. Remote sessions record the path as-is. // -// Returns: Server liveness response, including the echoed message, current server -// timestamp, and protocol version. -func (a *ServerRpc) Ping(ctx context.Context, params *PingRequest) (*PingResult, error) { - raw, err := a.common.client.Request("ping", params) +// Returns: Update the session's working directory. Used by the host when the user +// explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any +// related side-effects (file index, etc.); it does NOT change the process working directory +// (a session's cwd is per-session, not process-global). For local sessions the runtime +// validates the target first (an absolute path that exists on disk) and re-bases the +// permission primary directory; a rejected validation fails the call before anything is +// mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the +// new directory (best-effort). Remote sessions only record the path. +func (a *MetadataAPI) SetWorkingDirectory(ctx context.Context, params *MetadataSetWorkingDirectoryRequest) (*MetadataSetWorkingDirectoryResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["workingDirectory"] = params.WorkingDirectory + } + raw, err := a.client.Request(ctx, "session.metadata.setWorkingDirectory", req) if err != nil { return nil, err } - var result PingResult + var result MetadataSetWorkingDirectoryResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func NewServerRpc(client *jsonrpc2.Client) *ServerRpc { - r := &ServerRpc{} - r.common = serverApi{client: client} - r.Account = (*ServerAccountApi)(&r.common) - r.AgentRegistry = (*ServerAgentRegistryApi)(&r.common) - r.Mcp = (*ServerMcpApi)(&r.common) - r.Models = (*ServerModelsApi)(&r.common) - r.Secrets = (*ServerSecretsApi)(&r.common) - r.SessionFs = (*ServerSessionFsApi)(&r.common) - r.Sessions = (*ServerSessionsApi)(&r.common) - r.Skills = (*ServerSkillsApi)(&r.common) - r.Tools = (*ServerToolsApi)(&r.common) - r.User = (*ServerUserApi)(&r.common) - return r -} - -type internalServerApi struct { - client *jsonrpc2.Client -} - -// InternalServerRpc provides internal SDK server-scoped RPC methods (handshake helpers -// etc.). Not part of the public API. -type InternalServerRpc struct { - // Reuse a single struct instead of allocating one for each service on the heap. - common internalServerApi -} - -// Connect performs the SDK server connection handshake and validates the optional -// connection token. -// -// RPC method: connect. +// Snapshot returns a snapshot of the session's identifying metadata, mode, agent, and +// remote info. // -// Parameters: Optional connection token presented by the SDK client during the handshake. +// RPC method: session.metadata.snapshot. // -// Returns: Handshake result reporting the server's protocol version and package version on -// success. -// Internal: Connect is part of the SDK's internal handshake/plumbing; external callers -// should not use it. -func (a *InternalServerRpc) Connect(ctx context.Context, params *ConnectRequest) (*ConnectResult, error) { - raw, err := a.common.client.Request("connect", params) +// Returns: Point-in-time snapshot of slow-changing session identifier and state fields +func (a *MetadataAPI) Snapshot(ctx context.Context) (*SessionMetadataSnapshot, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.metadata.snapshot", req) if err != nil { return nil, err } - var result ConnectResult + var result SessionMetadataSnapshot if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func NewInternalServerRpc(client *jsonrpc2.Client) *InternalServerRpc { - r := &InternalServerRpc{} - r.common = internalServerApi{client: client} - return r -} - -type sessionApi struct { - client *jsonrpc2.Client - sessionID string -} - -// Experimental: AgentApi contains experimental APIs that may change or be removed. -type AgentApi sessionApi +// Experimental: ModeAPI contains experimental APIs that may change or be removed. +type ModeAPI sessionAPI -// Deselect clears the selected custom agent and returns the session to the default agent. +// Gets the current agent interaction mode. // -// RPC method: session.agent.deselect. -func (a *AgentApi) Deselect(ctx context.Context) (*SessionAgentDeselectResult, error) { +// RPC method: session.mode.get. +// +// Returns: The session mode the agent is operating in +func (a *ModeAPI) Get(ctx context.Context) (*SessionMode, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.agent.deselect", req) + raw, err := a.client.Request(ctx, "session.mode.get", req) if err != nil { return nil, err } - var result SessionAgentDeselectResult + var result SessionMode if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetCurrent gets the currently selected custom agent for the session. +// Sets the current agent interaction mode. // -// RPC method: session.agent.getCurrent. +// RPC method: session.mode.set. // -// Returns: The currently selected custom agent, or null when using the default agent. -func (a *AgentApi) GetCurrent(ctx context.Context) (*AgentGetCurrentResult, error) { +// Parameters: Agent interaction mode to apply to the session. +func (a *ModeAPI) Set(ctx context.Context, params *ModeSetRequest) (*SessionModeSetResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.agent.getCurrent", req) + if params != nil { + req["mode"] = params.Mode + } + raw, err := a.client.Request(ctx, "session.mode.set", req) if err != nil { return nil, err } - var result AgentGetCurrentResult + var result SessionModeSetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists custom agents available to the session. +// Experimental: ModelAPI contains experimental APIs that may change or be removed. +type ModelAPI sessionAPI + +// GetCurrent gets the currently selected model for the session. // -// RPC method: session.agent.list. +// RPC method: session.model.getCurrent. // -// Returns: Custom agents available to the session. -func (a *AgentApi) List(ctx context.Context) (*AgentList, error) { +// Returns: The currently selected model, reasoning effort, and context tier for the +// session. The context tier reflects `Session.getContextTier()`, restored from the session +// journal on resume. +func (a *ModelAPI) GetCurrent(ctx context.Context) (*CurrentModel, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.agent.list", req) + raw, err := a.client.Request(ctx, "session.model.getCurrent", req) if err != nil { return nil, err } - var result AgentList + var result CurrentModel if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reloads custom agent definitions and returns the refreshed list. +// Lists models available to this session using its own auth and integration context. +// Connected hosts (CLI TUI, GitHub App) should call this through the session client so +// remote sessions return the remote CLI's available models rather than the caller's. // -// RPC method: session.agent.reload. +// RPC method: session.model.list. // -// Returns: Custom agents available to the session after reloading definitions from disk. -func (a *AgentApi) Reload(ctx context.Context) (*AgentReloadResult, error) { +// Parameters: Optional listing options. +// +// Returns: The list of models available to this session. +func (a *ModelAPI) List(ctx context.Context, params ...*SessionModelListRequest) (*SessionModelList, error) { + var requestParams *SessionModelListRequest + if len(params) > 0 { + requestParams = params[0] + } req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.agent.reload", req) + if requestParams != nil { + if requestParams.SkipCache != nil { + req["skipCache"] = *requestParams.SkipCache + } + } + raw, err := a.client.Request(ctx, "session.model.list", req) if err != nil { return nil, err } - var result AgentReloadResult + var result SessionModelList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Selects a custom agent for subsequent turns in the session. +// SetReasoningEffort updates the session's reasoning effort without changing the selected +// model. // -// RPC method: session.agent.select. +// RPC method: session.model.setReasoningEffort. // -// Parameters: Name of the custom agent to select for subsequent turns. +// Parameters: Reasoning effort level to apply to the currently selected model. // -// Returns: The newly selected custom agent. -func (a *AgentApi) Select(ctx context.Context, params *AgentSelectRequest) (*AgentSelectResult, error) { +// Returns: Update the session's reasoning effort without changing the selected model. Use +// `switchTo` instead when you also need to change the model. The runtime stores the effort +// on the session and applies it to subsequent turns. +func (a *ModelAPI) SetReasoningEffort(ctx context.Context, params *ModelSetReasoningEffortRequest) (*ModelSetReasoningEffortResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["name"] = params.Name + req["reasoningEffort"] = params.ReasoningEffort } - raw, err := a.client.Request("session.agent.select", req) + raw, err := a.client.Request(ctx, "session.model.setReasoningEffort", req) if err != nil { return nil, err } - var result AgentSelectResult + var result ModelSetReasoningEffortResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: AuthApi contains experimental APIs that may change or be removed. -type AuthApi sessionApi - -// GetStatus gets authentication status and account metadata for the session. +// SwitchTo switches the session to a model and optional reasoning configuration. // -// RPC method: session.auth.getStatus. +// RPC method: session.model.switchTo. // -// Returns: Authentication status and account metadata for the session. -func (a *AuthApi) GetStatus(ctx context.Context) (*SessionAuthStatus, error) { +// Parameters: Target model identifier and optional reasoning effort, summary, capability +// overrides, and context tier. +// +// Returns: The model identifier active on the session after the switch. +func (a *ModelAPI) SwitchTo(ctx context.Context, params *ModelSwitchToRequest) (*ModelSwitchToResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.auth.getStatus", req) + if params != nil { + if params.ContextTier != nil { + req["contextTier"] = *params.ContextTier + } + if params.DeferIfModelChangeQueued != nil { + req["deferIfModelChangeQueued"] = *params.DeferIfModelChangeQueued + } + if params.ModelCapabilities != nil { + req["modelCapabilities"] = *params.ModelCapabilities + } + req["modelId"] = params.ModelID + if params.ReasoningEffort != nil { + req["reasoningEffort"] = *params.ReasoningEffort + } + if params.ReasoningSummary != nil { + req["reasoningSummary"] = *params.ReasoningSummary + } + if params.Verbosity != nil { + req["verbosity"] = *params.Verbosity + } + } + raw, err := a.client.Request(ctx, "session.model.switchTo", req) if err != nil { return nil, err } - var result SessionAuthStatus + var result ModelSwitchToResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetCredentials updates the session's auth credentials used for outbound model and API -// requests. -// -// RPC method: session.auth.setCredentials. +// Experimental: NameAPI contains experimental APIs that may change or be removed. +type NameAPI sessionAPI + +// Gets the session's friendly name. // -// Parameters: New auth credentials to install on the session. Omit to leave credentials -// unchanged. +// RPC method: session.name.get. // -// Returns: Indicates whether the credential update succeeded. -func (a *AuthApi) SetCredentials(ctx context.Context, params *SessionSetCredentialsParams) (*SessionSetCredentialsResult, error) { +// Returns: The session's friendly name, or null when not yet set. +func (a *NameAPI) Get(ctx context.Context) (*NameGetResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.Credentials != nil { - req["credentials"] = params.Credentials - } - } - raw, err := a.client.Request("session.auth.setCredentials", req) + raw, err := a.client.Request(ctx, "session.name.get", req) if err != nil { return nil, err } - var result SessionSetCredentialsResult + var result NameGetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: CanvasApi contains experimental APIs that may change or be removed. -type CanvasApi sessionApi - -// Closes an open canvas instance. +// Sets the session's friendly name. // -// RPC method: session.canvas.close. +// RPC method: session.name.set. // -// Parameters: Canvas close parameters. -func (a *CanvasApi) Close(ctx context.Context, params *CanvasCloseRequest) (*SessionCanvasCloseResult, error) { +// Parameters: New friendly name to apply to the session. +func (a *NameAPI) Set(ctx context.Context, params *NameSetRequest) (*SessionNameSetResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["instanceId"] = params.InstanceID + req["name"] = params.Name } - raw, err := a.client.Request("session.canvas.close", req) + raw, err := a.client.Request(ctx, "session.name.set", req) if err != nil { return nil, err } - var result SessionCanvasCloseResult + var result SessionNameSetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists canvases declared for the session. +// SetAuto persists an auto-generated session summary as the session's name when no user-set +// name exists. // -// RPC method: session.canvas.list. +// RPC method: session.name.setAuto. // -// Returns: Declared canvases available in this session. -func (a *CanvasApi) List(ctx context.Context) (*CanvasList, error) { +// Parameters: Auto-generated session summary to apply as the session's name when no +// user-set name exists. +// +// Returns: Indicates whether the auto-generated summary was applied as the session's name. +func (a *NameAPI) SetAuto(ctx context.Context, params *NameSetAutoRequest) (*NameSetAutoResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.canvas.list", req) + if params != nil { + req["summary"] = params.Summary + } + raw, err := a.client.Request(ctx, "session.name.setAuto", req) if err != nil { return nil, err } - var result CanvasList + var result NameSetAutoResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ListOpen lists currently open canvas instances for the live session. +// Experimental: OptionsAPI contains experimental APIs that may change or be removed. +type OptionsAPI sessionAPI + +// Update patches the genuinely-mutable subset of session options. // -// RPC method: session.canvas.listOpen. +// RPC method: session.options.update. // -// Returns: Live open-canvas snapshot. -func (a *CanvasApi) ListOpen(ctx context.Context) (*CanvasListOpenResult, error) { +// Parameters: Patch of mutable session options to apply to the running session. +// +// Returns: Indicates whether the session options patch was applied successfully. +func (a *OptionsAPI) Update(ctx context.Context, params *SessionUpdateOptionsParams) (*SessionUpdateOptionsResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.canvas.listOpen", req) + if params != nil { + if params.AdditionalContentExclusionPolicies != nil { + req["additionalContentExclusionPolicies"] = params.AdditionalContentExclusionPolicies + } + if params.AgentContext != nil { + req["agentContext"] = *params.AgentContext + } + if params.AllowAllMCPServerInstructions != nil { + req["allowAllMcpServerInstructions"] = *params.AllowAllMCPServerInstructions + } + if params.AskUserDisabled != nil { + req["askUserDisabled"] = *params.AskUserDisabled + } + if params.AvailableTools != nil { + req["availableTools"] = params.AvailableTools + } + if params.Capi != nil { + req["capi"] = *params.Capi + } + if params.ClientName != nil { + req["clientName"] = *params.ClientName + } + if params.CoauthorEnabled != nil { + req["coauthorEnabled"] = *params.CoauthorEnabled + } + if params.ContextTier != nil { + req["contextTier"] = *params.ContextTier + } + if params.ContinueOnAutoMode != nil { + req["continueOnAutoMode"] = *params.ContinueOnAutoMode + } + if params.CopilotURL != nil { + req["copilotUrl"] = *params.CopilotURL + } + if params.CustomAgentsLocalOnly != nil { + req["customAgentsLocalOnly"] = *params.CustomAgentsLocalOnly + } + if params.DisabledInstructionSources != nil { + req["disabledInstructionSources"] = params.DisabledInstructionSources + } + if params.DisabledSkills != nil { + req["disabledSkills"] = params.DisabledSkills + } + if params.EnableFileHooks != nil { + req["enableFileHooks"] = *params.EnableFileHooks + } + if params.EnableHostGitOperations != nil { + req["enableHostGitOperations"] = *params.EnableHostGitOperations + } + if params.EnableOnDemandInstructionDiscovery != nil { + req["enableOnDemandInstructionDiscovery"] = *params.EnableOnDemandInstructionDiscovery + } + if params.EnableReasoningSummaries != nil { + req["enableReasoningSummaries"] = *params.EnableReasoningSummaries + } + if params.EnableScriptSafety != nil { + req["enableScriptSafety"] = *params.EnableScriptSafety + } + if params.EnableSessionStore != nil { + req["enableSessionStore"] = *params.EnableSessionStore + } + if params.EnableSkills != nil { + req["enableSkills"] = *params.EnableSkills + } + if params.EnableStreaming != nil { + req["enableStreaming"] = *params.EnableStreaming + } + if params.EnvValueMode != nil { + req["envValueMode"] = *params.EnvValueMode + } + if params.EventsLogDirectory != nil { + req["eventsLogDirectory"] = *params.EventsLogDirectory + } + if params.EventsLogIncludesSubagents != nil { + req["eventsLogIncludesSubagents"] = *params.EventsLogIncludesSubagents + } + if params.ExcludedBuiltinAgents != nil { + req["excludedBuiltinAgents"] = params.ExcludedBuiltinAgents + } + if params.ExcludedTools != nil { + req["excludedTools"] = params.ExcludedTools + } + if params.FeatureFlags != nil { + req["featureFlags"] = params.FeatureFlags + } + if params.IncludedBuiltinAgents != nil { + req["includedBuiltinAgents"] = params.IncludedBuiltinAgents + } + if params.InstalledPlugins != nil { + req["installedPlugins"] = params.InstalledPlugins + } + if params.IntegrationID != nil { + req["integrationId"] = *params.IntegrationID + } + if params.IsExperimentalMode != nil { + req["isExperimentalMode"] = *params.IsExperimentalMode + } + if params.LogInteractiveShells != nil { + req["logInteractiveShells"] = *params.LogInteractiveShells + } + if params.LspClientName != nil { + req["lspClientName"] = *params.LspClientName + } + if params.ManageScheduleEnabled != nil { + req["manageScheduleEnabled"] = *params.ManageScheduleEnabled + } + if params.MaxInlineBinaryBytes != nil { + req["maxInlineBinaryBytes"] = *params.MaxInlineBinaryBytes + } + if params.Model != nil { + req["model"] = *params.Model + } + if params.ModelCapabilitiesOverrides != nil { + req["modelCapabilitiesOverrides"] = *params.ModelCapabilitiesOverrides + } + if params.OrganizationCustomInstructions != nil { + req["organizationCustomInstructions"] = *params.OrganizationCustomInstructions + } + if params.Provider != nil { + req["provider"] = *params.Provider + } + if params.ReasoningEffort != nil { + req["reasoningEffort"] = *params.ReasoningEffort + } + if params.ReasoningSummary != nil { + req["reasoningSummary"] = *params.ReasoningSummary + } + if params.RunningInInteractiveMode != nil { + req["runningInInteractiveMode"] = *params.RunningInInteractiveMode + } + if params.SandboxConfig != nil { + req["sandboxConfig"] = *params.SandboxConfig + } + if params.SessionCapabilities != nil { + req["sessionCapabilities"] = params.SessionCapabilities + } + if params.SessionLimits != nil { + req["sessionLimits"] = *params.SessionLimits + } + if params.Shell != nil { + req["shell"] = *params.Shell + } + if params.ShellInitProfile != nil { + req["shellInitProfile"] = *params.ShellInitProfile + } + if params.ShellProcessFlags != nil { + req["shellProcessFlags"] = params.ShellProcessFlags + } + if params.SkillDirectories != nil { + req["skillDirectories"] = params.SkillDirectories + } + if params.SkipCustomInstructions != nil { + req["skipCustomInstructions"] = *params.SkipCustomInstructions + } + if params.SkipEmbeddingRetrieval != nil { + req["skipEmbeddingRetrieval"] = *params.SkipEmbeddingRetrieval + } + if params.SuppressCustomAgentPrompt != nil { + req["suppressCustomAgentPrompt"] = *params.SuppressCustomAgentPrompt + } + if params.ToolFilterPrecedence != nil { + req["toolFilterPrecedence"] = *params.ToolFilterPrecedence + } + if params.TrajectoryFile != nil { + req["trajectoryFile"] = *params.TrajectoryFile + } + if params.Verbosity != nil { + req["verbosity"] = *params.Verbosity + } + if params.WorkingDirectory != nil { + req["workingDirectory"] = *params.WorkingDirectory + } + } + raw, err := a.client.Request(ctx, "session.options.update", req) if err != nil { return nil, err } - var result CanvasListOpenResult + var result SessionUpdateOptionsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Opens or focuses a canvas instance. +// Experimental: PermissionsAPI contains experimental APIs that may change or be removed. +type PermissionsAPI sessionAPI + +// Configure replaces selected permission policy fields (rules, paths, URLs, exclusions, +// allow-all flags) on the session. // -// RPC method: session.canvas.open. +// RPC method: session.permissions.configure. // -// Parameters: Canvas open parameters. +// Parameters: Patch of permission policy fields to apply (omit a field to leave it +// unchanged). // -// Returns: Open canvas instance snapshot. -func (a *CanvasApi) Open(ctx context.Context, params *CanvasOpenRequest) (*OpenCanvasInstance, error) { +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) Configure(ctx context.Context, params *PermissionsConfigureParams) (*PermissionsConfigureResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["canvasId"] = params.CanvasID - if params.ExtensionID != nil { - req["extensionId"] = *params.ExtensionID + if params.AdditionalContentExclusionPolicies != nil { + req["additionalContentExclusionPolicies"] = params.AdditionalContentExclusionPolicies } - if params.Input != nil { - req["input"] = params.Input + if params.ApproveAllReadPermissionRequests != nil { + req["approveAllReadPermissionRequests"] = *params.ApproveAllReadPermissionRequests + } + if params.ApproveAllToolPermissionRequests != nil { + req["approveAllToolPermissionRequests"] = *params.ApproveAllToolPermissionRequests + } + if params.Paths != nil { + req["paths"] = *params.Paths + } + if params.Rules != nil { + req["rules"] = *params.Rules + } + if params.URLs != nil { + req["urls"] = *params.URLs } - req["instanceId"] = params.InstanceID } - raw, err := a.client.Request("session.canvas.open", req) + raw, err := a.client.Request(ctx, "session.permissions.configure", req) if err != nil { return nil, err } - var result OpenCanvasInstance + var result PermissionsConfigureResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: CanvasActionApi contains experimental APIs that may change or be removed. -type CanvasActionApi sessionApi - -// Invokes an action on an open canvas instance. -// -// RPC method: session.canvas.action.invoke. +// GetAllowAll returns the current allow-all permission mode for the session. // -// Parameters: Canvas action invocation parameters. +// RPC method: session.permissions.getAllowAll. // -// Returns: Canvas action invocation result. -func (a *CanvasActionApi) Invoke(ctx context.Context, params *CanvasActionInvokeRequest) (*CanvasActionInvokeResult, error) { +// Returns: Current allow-all permission mode. +func (a *PermissionsAPI) GetAllowAll(ctx context.Context) (*AllowAllPermissionState, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["actionName"] = params.ActionName - if params.Input != nil { - req["input"] = params.Input - } - req["instanceId"] = params.InstanceID - } - raw, err := a.client.Request("session.canvas.action.invoke", req) + raw, err := a.client.Request(ctx, "session.permissions.getAllowAll", req) if err != nil { return nil, err } - var result CanvasActionInvokeResult + var result AllowAllPermissionState if err := json.Unmarshal(raw, &result); err != nil { return nil, err } - return &result, nil -} - -// Experimental: Action returns experimental APIs that may change or be removed. -func (s *CanvasApi) Action() *CanvasActionApi { - return (*CanvasActionApi)(s) + return &result, nil } -// Experimental: CommandsApi contains experimental APIs that may change or be removed. -type CommandsApi sessionApi - -// Enqueues a slash command for FIFO processing on the local session. +// HandlePendingPermissionRequest provides a decision for a pending tool permission request. // -// RPC method: session.commands.enqueue. +// RPC method: session.permissions.handlePendingPermissionRequest. // -// Parameters: Slash-prefixed command string to enqueue for FIFO processing. +// Parameters: Pending permission request ID and the decision to apply (approve/reject and +// scope). // -// Returns: Indicates whether the command was accepted into the local execution queue. -func (a *CommandsApi) Enqueue(ctx context.Context, params *EnqueueCommandParams) (*EnqueueCommandResult, error) { +// Returns: Indicates whether the permission decision was applied; false when the request +// was already resolved. +func (a *PermissionsAPI) HandlePendingPermissionRequest(ctx context.Context, params *PermissionDecisionRequest) (*PermissionRequestResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["command"] = params.Command + if params.DecisionContext != nil { + req["decisionContext"] = *params.DecisionContext + } + req["requestId"] = params.RequestID + req["result"] = params.Result } - raw, err := a.client.Request("session.commands.enqueue", req) + raw, err := a.client.Request(ctx, "session.permissions.handlePendingPermissionRequest", req) if err != nil { return nil, err } - var result EnqueueCommandResult + var result PermissionRequestResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Executes a slash command synchronously and returns any error. +// ModifyRules adds or removes session-scoped or location-scoped permission rules. // -// RPC method: session.commands.execute. +// RPC method: session.permissions.modifyRules. // -// Parameters: Slash command name and argument string to execute synchronously. +// Parameters: Scope and add/remove instructions for modifying session- or location-scoped +// permission rules. // -// Returns: Error message produced while executing the command, if any. -func (a *CommandsApi) Execute(ctx context.Context, params *ExecuteCommandParams) (*ExecuteCommandResult, error) { +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) ModifyRules(ctx context.Context, params *PermissionsModifyRulesParams) (*PermissionsModifyRulesResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["args"] = params.Args - req["commandName"] = params.CommandName + if params.Add != nil { + req["add"] = params.Add + } + if params.Remove != nil { + req["remove"] = params.Remove + } + if params.RemoveAll != nil { + req["removeAll"] = *params.RemoveAll + } + req["scope"] = params.Scope } - raw, err := a.client.Request("session.commands.execute", req) + raw, err := a.client.Request(ctx, "session.permissions.modifyRules", req) if err != nil { return nil, err } - var result ExecuteCommandResult + var result PermissionsModifyRulesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingCommand reports completion of a pending client-handled slash command. +// NotifyPromptShown notifies the runtime that a permission prompt UI has been shown to the +// user. // -// RPC method: session.commands.handlePendingCommand. +// RPC method: session.permissions.notifyPromptShown. // -// Parameters: Pending command request ID and an optional error if the client handler failed. +// Parameters: Notification payload describing the permission prompt that the client just +// rendered. // -// Returns: Indicates whether the pending client-handled command was completed successfully. -func (a *CommandsApi) HandlePendingCommand(ctx context.Context, params *CommandsHandlePendingCommandRequest) (*CommandsHandlePendingCommandResult, error) { +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) NotifyPromptShown(ctx context.Context, params *PermissionPromptShownNotification) (*PermissionsNotifyPromptShownResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.Error != nil { - req["error"] = *params.Error - } - req["requestId"] = params.RequestID + req["message"] = params.Message } - raw, err := a.client.Request("session.commands.handlePendingCommand", req) + raw, err := a.client.Request(ctx, "session.permissions.notifyPromptShown", req) if err != nil { return nil, err } - var result CommandsHandlePendingCommandResult + var result PermissionsNotifyPromptShownResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Invokes a slash command in the session. -// -// RPC method: session.commands.invoke. +// PendingRequests reconstructs the set of pending tool permission requests from the +// session's event history. // -// Parameters: Slash command name and optional raw input string to invoke. +// RPC method: session.permissions.pendingRequests. // -// Returns: Result of invoking the slash command (text output, prompt to send to the agent, -// or completion). -func (a *CommandsApi) Invoke(ctx context.Context, params *CommandsInvokeRequest) (SlashCommandInvocationResult, error) { +// Returns: List of pending permission requests reconstructed from event history. +func (a *PermissionsAPI) PendingRequests(ctx context.Context) (*PendingPermissionRequestList, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.Input != nil { - req["input"] = *params.Input - } - req["name"] = params.Name - } - raw, err := a.client.Request("session.commands.invoke", req) + raw, err := a.client.Request(ctx, "session.permissions.pendingRequests", req) if err != nil { return nil, err } - result, err := unmarshalSlashCommandInvocationResult(raw) - if err != nil { + var result PendingPermissionRequestList + if err := json.Unmarshal(raw, &result); err != nil { return nil, err } - return result, nil + return &result, nil } -// Lists slash commands available in the session. +// ResetSessionApprovals clears session-scoped tool permission approvals. // -// RPC method: session.commands.list. +// RPC method: session.permissions.resetSessionApprovals. // -// Parameters: Optional filters controlling which command sources to include in the listing. +// Parameters: Clears session-scoped tool permission approvals, and optionally the +// location-scoped ones. // -// Returns: Slash commands available in the session, after applying any include/exclude -// filters. -func (a *CommandsApi) List(ctx context.Context, params ...*CommandsListRequest) (*CommandList, error) { - var requestParams *CommandsListRequest - if len(params) > 0 { - requestParams = params[0] - } +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) ResetSessionApprovals(ctx context.Context, params *PermissionsResetSessionApprovalsRequest) (*PermissionsResetSessionApprovalsResult, error) { req := map[string]any{"sessionId": a.sessionID} - if requestParams != nil { - if requestParams.IncludeBuiltins != nil { - req["includeBuiltins"] = *requestParams.IncludeBuiltins - } - if requestParams.IncludeClientCommands != nil { - req["includeClientCommands"] = *requestParams.IncludeClientCommands - } - if requestParams.IncludeSkills != nil { - req["includeSkills"] = *requestParams.IncludeSkills + if params != nil { + if params.IncludeLocation != nil { + req["includeLocation"] = *params.IncludeLocation } } - raw, err := a.client.Request("session.commands.list", req) + raw, err := a.client.Request(ctx, "session.permissions.resetSessionApprovals", req) if err != nil { return nil, err } - var result CommandList + var result PermissionsResetSessionApprovalsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RespondToQueuedCommand reports whether the host actually executed a queued command and -// whether to continue processing. +// SetAllowAll sets the allow-all permission mode for the session. Used by attach-mode +// clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's +// permission state. The `on` mode swaps in unrestricted path and URL managers and emits +// `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths +// active while attaching LLM safety recommendations. The result returns the authoritative +// post-mutation state so callers can update their local mirrors without racing the +// `session.permissions_changed` notification on the same wire. // -// RPC method: session.commands.respondToQueuedCommand. +// RPC method: session.permissions.setAllowAll. // -// Parameters: Queued-command request ID and the result indicating whether the host executed -// it (and whether to stop processing further queued commands). +// Parameters: Allow-all mode to apply for the session. // -// Returns: Indicates whether the queued-command response was matched to a pending request. -func (a *CommandsApi) RespondToQueuedCommand(ctx context.Context, params *CommandsRespondToQueuedCommandRequest) (*CommandsRespondToQueuedCommandResult, error) { +// Returns: Indicates whether the operation succeeded and reports the post-mutation state. +func (a *PermissionsAPI) SetAllowAll(ctx context.Context, params *PermissionsSetAllowAllRequest) (*AllowAllPermissionSetResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["result"] = params.Result + if params.Enabled != nil { + req["enabled"] = *params.Enabled + } + if params.Mode != nil { + req["mode"] = *params.Mode + } + if params.Model != nil { + req["model"] = *params.Model + } + if params.Source != nil { + req["source"] = *params.Source + } } - raw, err := a.client.Request("session.commands.respondToQueuedCommand", req) + raw, err := a.client.Request(ctx, "session.permissions.setAllowAll", req) if err != nil { return nil, err } - var result CommandsRespondToQueuedCommandResult + var result AllowAllPermissionSetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: EventLogApi contains experimental APIs that may change or be removed. -type EventLogApi sessionApi - -// Reads a batch of session events from a cursor, optionally waiting for new events. +// SetApproveAll enables or disables automatic approval of tool permission requests for the +// session. // -// RPC method: session.eventLog.read. +// RPC method: session.permissions.setApproveAll. // -// Parameters: Cursor, batch size, and optional long-poll/filter parameters for reading -// session events. +// Parameters: Allow-all toggle for tool permission requests, with an optional telemetry +// source. // -// Returns: Batch of session events returned by a read, with cursor and continuation -// metadata. -func (a *EventLogApi) Read(ctx context.Context, params *EventLogReadRequest) (*EventsReadResult, error) { +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) SetApproveAll(ctx context.Context, params *PermissionsSetApproveAllRequest) (*PermissionsSetApproveAllResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.AgentScope != nil { - req["agentScope"] = *params.AgentScope - } - if params.Cursor != nil { - req["cursor"] = *params.Cursor - } - if params.Max != nil { - req["max"] = *params.Max - } - if params.Types != nil { - req["types"] = *params.Types - } - if params.WaitMs != nil { - req["waitMs"] = *params.WaitMs + req["enabled"] = params.Enabled + if params.Source != nil { + req["source"] = *params.Source } } - raw, err := a.client.Request("session.eventLog.read", req) + raw, err := a.client.Request(ctx, "session.permissions.setApproveAll", req) if err != nil { return nil, err } - var result EventsReadResult + var result PermissionsSetApproveAllResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RegisterInterest registers consumer interest in an event type for runtime gating purposes. +// SetRequired sets whether the client wants permission prompts bridged into session events. // -// RPC method: session.eventLog.registerInterest. +// RPC method: session.permissions.setRequired. // -// Parameters: Event type to register consumer interest for, used by runtime gating logic. +// Parameters: Toggles whether permission prompts should be bridged into session events for +// this client. // -// Returns: Opaque handle representing an event-type interest registration. -func (a *EventLogApi) RegisterInterest(ctx context.Context, params *RegisterEventInterestParams) (*RegisterEventInterestResult, error) { +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsAPI) SetRequired(ctx context.Context, params *PermissionsSetRequiredRequest) (*PermissionsSetRequiredResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["eventType"] = params.EventType + req["required"] = params.Required } - raw, err := a.client.Request("session.eventLog.registerInterest", req) + raw, err := a.client.Request(ctx, "session.permissions.setRequired", req) if err != nil { return nil, err } - var result RegisterEventInterestResult + var result PermissionsSetRequiredResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReleaseInterest releases a consumer's previously-registered interest in an event type. +// Experimental: PermissionsFolderTrustAPI contains experimental APIs that may change or be +// removed. +type PermissionsFolderTrustAPI sessionAPI + +// AddTrusted adds a folder to the user's trusted folders list. // -// RPC method: session.eventLog.releaseInterest. +// RPC method: session.permissions.folderTrust.addTrusted. // -// Parameters: Opaque handle previously returned by `registerInterest` to release. +// Parameters: Folder path to add to trusted folders. // // Returns: Indicates whether the operation succeeded. -func (a *EventLogApi) ReleaseInterest(ctx context.Context, params *ReleaseEventInterestParams) (*EventLogReleaseInterestResult, error) { +func (a *PermissionsFolderTrustAPI) AddTrusted(ctx context.Context, params *FolderTrustAddParams) (*PermissionsFolderTrustAddTrustedResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["handle"] = params.Handle + req["path"] = params.Path } - raw, err := a.client.Request("session.eventLog.releaseInterest", req) + raw, err := a.client.Request(ctx, "session.permissions.folderTrust.addTrusted", req) if err != nil { return nil, err } - var result EventLogReleaseInterestResult + var result PermissionsFolderTrustAddTrustedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Tail returns a snapshot of the current tail cursor without consuming events. +// IsTrusted reports whether a folder is trusted according to the user's folder trust state. // -// RPC method: session.eventLog.tail. +// RPC method: session.permissions.folderTrust.isTrusted. // -// Returns: Snapshot of the current tail cursor without returning any events. Use this when -// a consumer wants to subscribe to live events going forward without first paginating -// through the entire persisted history (which would happen if `read` were called without a -// cursor on a long-lived session). -func (a *EventLogApi) Tail(ctx context.Context) (*EventLogTailResult, error) { +// Parameters: Folder path to check for trust. +// +// Returns: Folder trust check result. +func (a *PermissionsFolderTrustAPI) IsTrusted(ctx context.Context, params *FolderTrustCheckParams) (*FolderTrustCheckResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.eventLog.tail", req) + if params != nil { + req["path"] = params.Path + } + raw, err := a.client.Request(ctx, "session.permissions.folderTrust.isTrusted", req) if err != nil { return nil, err } - var result EventLogTailResult + var result FolderTrustCheckResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ExtensionsApi contains experimental APIs that may change or be removed. -type ExtensionsApi sessionApi +// Experimental: FolderTrust returns experimental APIs that may change or be removed. +func (s *PermissionsAPI) FolderTrust() *PermissionsFolderTrustAPI { + return (*PermissionsFolderTrustAPI)(s) +} -// Disables an extension for the session. +// Experimental: PermissionsLocationsAPI contains experimental APIs that may change or be +// removed. +type PermissionsLocationsAPI sessionAPI + +// AddToolApproval persists a tool approval for a permission location and applies its rules +// to this session's live permission service. // -// RPC method: session.extensions.disable. +// RPC method: session.permissions.locations.addToolApproval. // -// Parameters: Source-qualified extension identifier to disable for the session. -func (a *ExtensionsApi) Disable(ctx context.Context, params *ExtensionsDisableRequest) (*SessionExtensionsDisableResult, error) { +// Parameters: Location-scoped tool approval to persist. +// +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsLocationsAPI) AddToolApproval(ctx context.Context, params *PermissionLocationAddToolApprovalParams) (*PermissionsLocationsAddToolApprovalResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID + req["approval"] = params.Approval + req["locationKey"] = params.LocationKey } - raw, err := a.client.Request("session.extensions.disable", req) + raw, err := a.client.Request(ctx, "session.permissions.locations.addToolApproval", req) if err != nil { return nil, err } - var result SessionExtensionsDisableResult + var result PermissionsLocationsAddToolApprovalResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Enables an extension for the session. +// Apply applies persisted location-scoped tool approvals and allowed directories for a +// working directory to this session's permission service. // -// RPC method: session.extensions.enable. +// RPC method: session.permissions.locations.apply. // -// Parameters: Source-qualified extension identifier to enable for the session. -func (a *ExtensionsApi) Enable(ctx context.Context, params *ExtensionsEnableRequest) (*SessionExtensionsEnableResult, error) { +// Parameters: Working directory to load persisted location permissions for. +// +// Returns: Summary of persisted location permissions applied to the session. +func (a *PermissionsLocationsAPI) Apply(ctx context.Context, params *PermissionLocationApplyParams) (*PermissionLocationApplyResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID + req["workingDirectory"] = params.WorkingDirectory } - raw, err := a.client.Request("session.extensions.enable", req) + raw, err := a.client.Request(ctx, "session.permissions.locations.apply", req) if err != nil { return nil, err } - var result SessionExtensionsEnableResult + var result PermissionLocationApplyResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists extensions discovered for the session and their current status. +// Resolves the permission location key and type for a working directory. // -// RPC method: session.extensions.list. +// RPC method: session.permissions.locations.resolve. // -// Returns: Extensions discovered for the session, with their current status. -func (a *ExtensionsApi) List(ctx context.Context) (*ExtensionList, error) { +// Parameters: Working directory to resolve into a location-permissions key. +// +// Returns: Resolved location-permissions key and type. +func (a *PermissionsLocationsAPI) Resolve(ctx context.Context, params *PermissionLocationResolveParams) (*PermissionLocationResolveResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.extensions.list", req) + if params != nil { + req["workingDirectory"] = params.WorkingDirectory + } + raw, err := a.client.Request(ctx, "session.permissions.locations.resolve", req) if err != nil { return nil, err } - var result ExtensionList + var result PermissionLocationResolveResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reloads extension definitions and processes for the session. +// Experimental: Locations returns experimental APIs that may change or be removed. +func (s *PermissionsAPI) Locations() *PermissionsLocationsAPI { + return (*PermissionsLocationsAPI)(s) +} + +// Experimental: PermissionsPathsAPI contains experimental APIs that may change or be +// removed. +type PermissionsPathsAPI sessionAPI + +// Adds a directory to the session's allow-list. // -// RPC method: session.extensions.reload. -func (a *ExtensionsApi) Reload(ctx context.Context) (*SessionExtensionsReloadResult, error) { +// RPC method: session.permissions.paths.add. +// +// Parameters: Directory path to add to the session's allowed directories. +// +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsPathsAPI) Add(ctx context.Context, params *PermissionPathsAddParams) (*PermissionsPathsAddResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.extensions.reload", req) + if params != nil { + req["path"] = params.Path + } + raw, err := a.client.Request(ctx, "session.permissions.paths.add", req) if err != nil { return nil, err } - var result SessionExtensionsReloadResult + var result PermissionsPathsAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: FleetApi contains experimental APIs that may change or be removed. -type FleetApi sessionApi - -// Starts fleet mode by submitting the fleet orchestration prompt to the session. +// IsPathWithinAllowedDirectories reports whether a path falls within any of the session's +// allowed directories. // -// RPC method: session.fleet.start. +// RPC method: session.permissions.paths.isPathWithinAllowedDirectories. // -// Parameters: Optional user prompt to combine with the fleet orchestration instructions. +// Parameters: Path to evaluate against the session's allowed directories. // -// Returns: Indicates whether fleet mode was successfully activated. -func (a *FleetApi) Start(ctx context.Context, params *FleetStartRequest) (*FleetStartResult, error) { +// Returns: Indicates whether the supplied path is within the session's allowed directories. +func (a *PermissionsPathsAPI) IsPathWithinAllowedDirectories(ctx context.Context, params *PermissionPathsAllowedCheckParams) (*PermissionPathsAllowedCheckResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.Prompt != nil { - req["prompt"] = *params.Prompt - } + req["path"] = params.Path } - raw, err := a.client.Request("session.fleet.start", req) + raw, err := a.client.Request(ctx, "session.permissions.paths.isPathWithinAllowedDirectories", req) if err != nil { return nil, err } - var result FleetStartResult + var result PermissionPathsAllowedCheckResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: HistoryApi contains experimental APIs that may change or be removed. -type HistoryApi sessionApi - -// AbortManualCompaction aborts any in-progress manual compaction on a local session. +// IsPathWithinWorkspace reports whether a path falls within the session's workspace +// (primary) directory. // -// RPC method: session.history.abortManualCompaction. +// RPC method: session.permissions.paths.isPathWithinWorkspace. // -// Returns: Indicates whether an in-progress manual compaction was aborted. -func (a *HistoryApi) AbortManualCompaction(ctx context.Context) (*HistoryAbortManualCompactionResult, error) { +// Parameters: Path to evaluate against the session's workspace (primary) directory. +// +// Returns: Indicates whether the supplied path is within the session's workspace directory. +func (a *PermissionsPathsAPI) IsPathWithinWorkspace(ctx context.Context, params *PermissionPathsWorkspaceCheckParams) (*PermissionPathsWorkspaceCheckResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.history.abortManualCompaction", req) + if params != nil { + req["path"] = params.Path + } + raw, err := a.client.Request(ctx, "session.permissions.paths.isPathWithinWorkspace", req) if err != nil { return nil, err } - var result HistoryAbortManualCompactionResult + var result PermissionPathsWorkspaceCheckResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// CancelBackgroundCompaction cancels any in-progress background compaction on a local -// session. +// List returns the session's allowed directories and primary working directory. // -// RPC method: session.history.cancelBackgroundCompaction. +// RPC method: session.permissions.paths.list. // -// Returns: Indicates whether an in-progress background compaction was cancelled. -func (a *HistoryApi) CancelBackgroundCompaction(ctx context.Context) (*HistoryCancelBackgroundCompactionResult, error) { +// Returns: Snapshot of the session's allow-listed directories and primary working directory. +func (a *PermissionsPathsAPI) List(ctx context.Context) (*PermissionPathsList, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.history.cancelBackgroundCompaction", req) + raw, err := a.client.Request(ctx, "session.permissions.paths.list", req) if err != nil { return nil, err } - var result HistoryCancelBackgroundCompactionResult + var result PermissionPathsList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Compacts the session history to reduce context usage. +// UpdatePrimary updates the session's primary working directory used by the permission +// policy. // -// RPC method: session.history.compact. +// RPC method: session.permissions.paths.updatePrimary. // -// Parameters: Optional compaction parameters. +// Parameters: Directory path to set as the session's new primary working directory. // -// Returns: Compaction outcome with the number of tokens and messages removed, summary text, -// and the resulting context window breakdown. -func (a *HistoryApi) Compact(ctx context.Context, params ...*HistoryCompactRequest) (*HistoryCompactResult, error) { - var requestParams *HistoryCompactRequest - if len(params) > 0 { - requestParams = params[0] - } +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsPathsAPI) UpdatePrimary(ctx context.Context, params *PermissionPathsUpdatePrimaryParams) (*PermissionsPathsUpdatePrimaryResult, error) { req := map[string]any{"sessionId": a.sessionID} - if requestParams != nil { - if requestParams.CustomInstructions != nil { - req["customInstructions"] = *requestParams.CustomInstructions - } + if params != nil { + req["path"] = params.Path } - raw, err := a.client.Request("session.history.compact", req) + raw, err := a.client.Request(ctx, "session.permissions.paths.updatePrimary", req) if err != nil { return nil, err } - var result HistoryCompactResult + var result PermissionsPathsUpdatePrimaryResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SummarizeForHandoff produces a markdown summary of the session's conversation context for -// hand-off scenarios. +// Experimental: Paths returns experimental APIs that may change or be removed. +func (s *PermissionsAPI) Paths() *PermissionsPathsAPI { + return (*PermissionsPathsAPI)(s) +} + +// Experimental: PermissionsURLsAPI contains experimental APIs that may change or be removed. +type PermissionsURLsAPI sessionAPI + +// SetUnrestrictedMode toggles the runtime's URL-permission policy between unrestricted and +// restricted modes. // -// RPC method: session.history.summarizeForHandoff. +// RPC method: session.permissions.urls.setUnrestrictedMode. // -// Returns: Markdown summary of the conversation context (empty when not available). -func (a *HistoryApi) SummarizeForHandoff(ctx context.Context) (*HistorySummarizeForHandoffResult, error) { +// Parameters: Whether the URL-permission policy should run in unrestricted mode. +// +// Returns: Indicates whether the operation succeeded. +func (a *PermissionsURLsAPI) SetUnrestrictedMode(ctx context.Context, params *PermissionURLsSetUnrestrictedModeParams) (*PermissionsURLsSetUnrestrictedModeResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.history.summarizeForHandoff", req) + if params != nil { + req["enabled"] = params.Enabled + } + raw, err := a.client.Request(ctx, "session.permissions.urls.setUnrestrictedMode", req) if err != nil { return nil, err } - var result HistorySummarizeForHandoffResult + var result PermissionsURLsSetUnrestrictedModeResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Truncates persisted session history to a specific event. -// -// RPC method: session.history.truncate. -// -// Parameters: Identifier of the event to truncate to; this event and all later events are -// removed. +// Experimental: URLs returns experimental APIs that may change or be removed. +func (s *PermissionsAPI) URLs() *PermissionsURLsAPI { + return (*PermissionsURLsAPI)(s) +} + +// Experimental: PlanAPI contains experimental APIs that may change or be removed. +type PlanAPI sessionAPI + +// Deletes the session plan file from the workspace. // -// Returns: Number of events that were removed by the truncation. -func (a *HistoryApi) Truncate(ctx context.Context, params *HistoryTruncateRequest) (*HistoryTruncateResult, error) { +// RPC method: session.plan.delete. +func (a *PlanAPI) Delete(ctx context.Context) (*SessionPlanDeleteResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["eventId"] = params.EventID - } - raw, err := a.client.Request("session.history.truncate", req) + raw, err := a.client.Request(ctx, "session.plan.delete", req) if err != nil { return nil, err } - var result HistoryTruncateResult + var result SessionPlanDeleteResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: InstructionsApi contains experimental APIs that may change or be removed. -type InstructionsApi sessionApi - -// GetSources gets instruction sources loaded for the session. +// Reads the session plan file from the workspace. // -// RPC method: session.instructions.getSources. +// RPC method: session.plan.read. // -// Returns: Instruction sources loaded for the session, in merge order. -func (a *InstructionsApi) GetSources(ctx context.Context) (*InstructionsGetSourcesResult, error) { +// Returns: Existence, contents, and resolved path of the session plan file. +func (a *PlanAPI) Read(ctx context.Context) (*PlanReadResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.instructions.getSources", req) + raw, err := a.client.Request(ctx, "session.plan.read", req) if err != nil { return nil, err } - var result InstructionsGetSourcesResult + var result PlanReadResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: LspApi contains experimental APIs that may change or be removed. -type LspApi sessionApi - -// Initialize loads the merged LSP configuration set for the session's working directory. +// ReadSqlTodos reads todo rows from the session SQL database for plan rendering. // -// RPC method: session.lsp.initialize. +// RPC method: session.plan.readSqlTodos. // -// Parameters: Parameters for (re)loading the merged LSP configuration set. -func (a *LspApi) Initialize(ctx context.Context, params *LspInitializeRequest) (*SessionLspInitializeResult, error) { +// Returns: Todo rows read from the session SQL database. Empty when no session database is +// available. +func (a *PlanAPI) ReadSqlTodos(ctx context.Context) (*PlanReadSQLTodosResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.Force != nil { - req["force"] = *params.Force - } - if params.GitRoot != nil { - req["gitRoot"] = *params.GitRoot - } - if params.WorkingDirectory != nil { - req["workingDirectory"] = *params.WorkingDirectory - } - } - raw, err := a.client.Request("session.lsp.initialize", req) + raw, err := a.client.Request(ctx, "session.plan.readSqlTodos", req) if err != nil { return nil, err } - var result SessionLspInitializeResult + var result PlanReadSQLTodosResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: McpApi contains experimental APIs that may change or be removed. -type McpApi sessionApi - -// CancelSamplingExecution cancels an in-flight MCP sampling execution by request ID. -// -// RPC method: session.mcp.cancelSamplingExecution. +// ReadSqlTodosWithDependencies reads todo rows AND dependency edges from the session SQL +// database for structured progress UI. Same defensive behavior as readSqlTodos — returns +// empty arrays when the database, tables, or columns aren't available. Clients should call +// this on session start and after every `session.todos_changed` event to refresh +// structured-UI rendering. // -// Parameters: The requestId previously passed to executeSampling that should be cancelled. +// RPC method: session.plan.readSqlTodosWithDependencies. // -// Returns: Indicates whether an in-flight sampling execution with the given requestId was -// found and cancelled. -func (a *McpApi) CancelSamplingExecution(ctx context.Context, params *McpCancelSamplingExecutionParams) (*McpCancelSamplingExecutionResult, error) { +// Returns: Todo rows + dependency edges read from the session SQL database. +func (a *PlanAPI) ReadSqlTodosWithDependencies(ctx context.Context) (*PlanReadSQLTodosWithDependenciesResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["requestId"] = params.RequestID - } - raw, err := a.client.Request("session.mcp.cancelSamplingExecution", req) + raw, err := a.client.Request(ctx, "session.plan.readSqlTodosWithDependencies", req) if err != nil { return nil, err } - var result McpCancelSamplingExecutionResult + var result PlanReadSQLTodosWithDependenciesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Disables an MCP server for the session. +// Update writes new content to the session plan file. // -// RPC method: session.mcp.disable. +// RPC method: session.plan.update. // -// Parameters: Name of the MCP server to disable for the session. -func (a *McpApi) Disable(ctx context.Context, params *McpDisableRequest) (*SessionMcpDisableResult, error) { +// Parameters: Replacement contents to write to the session plan file. +func (a *PlanAPI) Update(ctx context.Context, params *PlanUpdateRequest) (*SessionPlanUpdateResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["serverName"] = params.ServerName + req["content"] = params.Content } - raw, err := a.client.Request("session.mcp.disable", req) + raw, err := a.client.Request(ctx, "session.plan.update", req) if err != nil { return nil, err } - var result SessionMcpDisableResult + var result SessionPlanUpdateResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Enables an MCP server for the session. +// Experimental: PluginsAPI contains experimental APIs that may change or be removed. +type PluginsAPI sessionAPI + +// Lists plugins installed for the session. // -// RPC method: session.mcp.enable. +// RPC method: session.plugins.list. // -// Parameters: Name of the MCP server to enable for the session. -func (a *McpApi) Enable(ctx context.Context, params *McpEnableRequest) (*SessionMcpEnableResult, error) { +// Returns: Plugins installed for the session, with their enabled state and version metadata. +func (a *PluginsAPI) List(ctx context.Context) (*PluginList, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["serverName"] = params.ServerName - } - raw, err := a.client.Request("session.mcp.enable", req) + raw, err := a.client.Request(ctx, "session.plugins.list", req) if err != nil { return nil, err } - var result SessionMcpEnableResult + var result PluginList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ExecuteSampling runs an MCP sampling inference on behalf of an MCP server. +// Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and +// skills cache so SDK-driven changes via `server.plugins.*` take effect immediately. // -// RPC method: session.mcp.executeSampling. -// -// Parameters: Identifiers and raw MCP CreateMessageRequest params used to run a sampling -// inference. +// RPC method: session.plugins.reload. // -// Returns: Outcome of an MCP sampling execution: success result, failure error, or -// cancellation. -func (a *McpApi) ExecuteSampling(ctx context.Context, params *McpExecuteSamplingParams) (*McpSamplingExecutionResult, error) { +// Parameters: Optional flags controlling which side effects the reload performs. +func (a *PluginsAPI) Reload(ctx context.Context, params ...*SessionPluginsReloadRequest) (*SessionPluginsReloadResult, error) { + var requestParams *SessionPluginsReloadRequest + if len(params) > 0 { + requestParams = params[0] + } req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["mcpRequestId"] = params.McpRequestID - req["request"] = params.Request - req["requestId"] = params.RequestID - req["serverName"] = params.ServerName + if requestParams != nil { + if requestParams.DeferRepoHooks != nil { + req["deferRepoHooks"] = *requestParams.DeferRepoHooks + } + if requestParams.ReloadCustomAgents != nil { + req["reloadCustomAgents"] = *requestParams.ReloadCustomAgents + } + if requestParams.ReloadExtensions != nil { + req["reloadExtensions"] = *requestParams.ReloadExtensions + } + if requestParams.ReloadHooks != nil { + req["reloadHooks"] = *requestParams.ReloadHooks + } + if requestParams.ReloadMCP != nil { + req["reloadMcp"] = *requestParams.ReloadMCP + } } - raw, err := a.client.Request("session.mcp.executeSampling", req) + raw, err := a.client.Request(ctx, "session.plugins.reload", req) if err != nil { return nil, err } - var result McpSamplingExecutionResult + var result SessionPluginsReloadResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists MCP servers configured for the session and their connection status. +// Experimental: ProviderAPI contains experimental APIs that may change or be removed. +type ProviderAPI sessionAPI + +// Adds BYOK providers and/or models to the session's registry at runtime, extending the +// additive registry built from the session's `providers`/`models` options. Both fields are +// optional, so a call may add providers only, models only, or both. Within a single call +// providers are registered before models, so a model may reference a provider added in the +// same call; across calls a model may reference any provider already registered (from +// session creation or a prior add). A model whose referenced provider is not registered by +// the end of the call is rejected. Newly added models become selectable via `model.list` / +// `model.switchTo` and are inherited by sub-agents spawned afterwards. // -// RPC method: session.mcp.list. +// RPC method: session.provider.add. +// +// Parameters: BYOK providers and/or models to add to the session's registry at runtime. +// Both fields are optional; provide providers, models, or both. // -// Returns: MCP servers configured for the session, with their connection status. -func (a *McpApi) List(ctx context.Context) (*McpServerList, error) { +// Returns: The selectable model entries synthesized for the models added by this call. +func (a *ProviderAPI) Add(ctx context.Context, params *ProviderAddRequest) (*ProviderAddResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.mcp.list", req) + if params != nil { + if params.Models != nil { + req["models"] = params.Models + } + if params.Providers != nil { + req["providers"] = params.Providers + } + } + raw, err := a.client.Request(ctx, "session.provider.add", req) if err != nil { return nil, err } - var result McpServerList + var result ProviderAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reloads MCP server connections for the session. +// GetEndpoint returns the provider endpoint and credentials the session is currently +// configured to talk to, so the caller can make inference calls directly against the same +// backend the session uses. // -// RPC method: session.mcp.reload. -func (a *McpApi) Reload(ctx context.Context) (*SessionMcpReloadResult, error) { +// RPC method: session.provider.getEndpoint. +// +// Parameters: Optional model identifier to scope the endpoint snapshot to. +// +// Returns: A snapshot of the provider endpoint the session is currently configured to talk +// to. +func (a *ProviderAPI) GetEndpoint(ctx context.Context, params ...*SessionProviderGetEndpointRequest) (*ProviderEndpoint, error) { + var requestParams *SessionProviderGetEndpointRequest + if len(params) > 0 { + requestParams = params[0] + } req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.mcp.reload", req) + if requestParams != nil { + if requestParams.ModelID != nil { + req["modelId"] = *requestParams.ModelID + } + } + raw, err := a.client.Request(ctx, "session.provider.getEndpoint", req) if err != nil { return nil, err } - var result SessionMcpReloadResult + var result ProviderEndpoint if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RemoveGitHub removes the auto-managed `github` MCP server when present. -// -// RPC method: session.mcp.removeGitHub. +// Experimental: QueueAPI contains experimental APIs that may change or be removed. +type QueueAPI sessionAPI + +// Clears all pending queued items on the local session. // -// Returns: Indicates whether the auto-managed `github` MCP server was removed (false when -// nothing to remove). -func (a *McpApi) RemoveGitHub(ctx context.Context) (*McpRemoveGitHubResult, error) { +// RPC method: session.queue.clear. +func (a *QueueAPI) Clear(ctx context.Context) (*SessionQueueClearResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.mcp.removeGitHub", req) + raw, err := a.client.Request(ctx, "session.queue.clear", req) if err != nil { return nil, err } - var result McpRemoveGitHubResult + var result SessionQueueClearResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetEnvValueMode sets how environment-variable values supplied to MCP servers are resolved -// (direct or indirect). +// DuplicateAt duplicates an addressable queued item immediately after its source. // -// RPC method: session.mcp.setEnvValueMode. +// RPC method: session.queue.duplicateAt. // -// Parameters: Mode controlling how MCP server env values are resolved (`direct` or -// `indirect`). +// Parameters: Parameters for duplicating a queued item. // -// Returns: Env-value mode recorded on the session after the update. -func (a *McpApi) SetEnvValueMode(ctx context.Context, params *McpSetEnvValueModeParams) (*McpSetEnvValueModeResult, error) { +// Returns: Result of duplicating a queued item. +func (a *QueueAPI) DuplicateAt(ctx context.Context, params *QueueDuplicateAtRequest) (*QueueDuplicateAtResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["mode"] = params.Mode + req["id"] = params.ID } - raw, err := a.client.Request("session.mcp.setEnvValueMode", req) + raw, err := a.client.Request(ctx, "session.queue.duplicateAt", req) if err != nil { return nil, err } - var result McpSetEnvValueModeResult + var result QueueDuplicateAtResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: McpAppsApi contains experimental APIs that may change or be removed. -type McpAppsApi sessionApi - -// CallTool call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check -// that prevents an app iframe from invoking model-only tools. Returns the standard MCP -// `CallToolResult`. +// InsertAt inserts a new queued message at a public visible position. // -// RPC method: session.mcp.apps.callTool. +// RPC method: session.queue.insertAt. // -// Parameters: MCP server, tool name, and arguments to invoke from an MCP App view. +// Parameters: Parameters for inserting a queued message at a public visible position. // -// Returns: Standard MCP CallToolResult -func (a *McpAppsApi) CallTool(ctx context.Context, params *McpAppsCallToolRequest) (*SessionMcpAppsCallToolResult, error) { +// Returns: Result of inserting a queued message. +func (a *QueueAPI) InsertAt(ctx context.Context, params *QueueInsertAtRequest) (*QueueInsertAtResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.Arguments != nil { - req["arguments"] = params.Arguments - } - req["originServerName"] = params.OriginServerName - req["serverName"] = params.ServerName - req["toolName"] = params.ToolName + req["message"] = params.Message + req["position"] = params.Position } - raw, err := a.client.Request("session.mcp.apps.callTool", req) + raw, err := a.client.Request(ctx, "session.queue.insertAt", req) if err != nil { return nil, err } - var result SessionMcpAppsCallToolResult + var result QueueInsertAtResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, -// feature-flag state, advertised extension, and how many tools have `_meta.ui` populated. +// MoveItem moves an addressable queued item to a public visible position. // -// RPC method: session.mcp.apps.diagnose. +// RPC method: session.queue.moveItem. // -// Parameters: MCP server to diagnose MCP Apps wiring for. +// Parameters: Parameters for moving a queued item by stable id. // -// Returns: Diagnostic snapshot of MCP Apps wiring for the named server. -func (a *McpAppsApi) Diagnose(ctx context.Context, params *McpAppsDiagnoseRequest) (*McpAppsDiagnoseResult, error) { +// Returns: Result of moving a queued item. +func (a *QueueAPI) MoveItem(ctx context.Context, params *QueueMoveItemRequest) (*QueueMoveItemResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["serverName"] = params.ServerName + req["id"] = params.ID + req["toPosition"] = params.ToPosition } - raw, err := a.client.Request("session.mcp.apps.diagnose", req) + raw, err := a.client.Request(ctx, "session.queue.moveItem", req) if err != nil { return nil, err } - var result McpAppsDiagnoseResult + var result QueueMoveItemResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetHostContext read the current host context advertised to MCP App guests. +// PendingItems returns the local session's pending user-facing queued items and steering +// messages. // -// RPC method: session.mcp.apps.getHostContext. +// RPC method: session.queue.pendingItems. // -// Returns: Current host context advertised to MCP App guests. -func (a *McpAppsApi) GetHostContext(ctx context.Context) (*McpAppsHostContext, error) { +// Returns: Snapshot of the session's pending queued items and immediate-steering messages. +func (a *QueueAPI) PendingItems(ctx context.Context) (*QueuePendingItemsResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.mcp.apps.getHostContext", req) + raw, err := a.client.Request(ctx, "session.queue.pendingItems", req) if err != nil { return nil, err } - var result McpAppsHostContext + var result QueuePendingItemsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ListTools list tools that an MCP App view is allowed to call (SEP-1865 visibility -// filter). Returns tools whose `_meta.ui.visibility` is unset (default `["model","app"]`) -// or includes `"app"`. +// RemoveAt removes an addressable queued item by its stable id. // -// RPC method: session.mcp.apps.listTools. +// RPC method: session.queue.removeAt. // -// Parameters: MCP server to list app-callable tools for. +// Parameters: Parameters for removing a queued item by stable id. // -// Returns: App-callable tools from the named MCP server. -func (a *McpAppsApi) ListTools(ctx context.Context, params *McpAppsListToolsRequest) (*McpAppsListToolsResult, error) { +// Returns: Result of removing a queued item. +func (a *QueueAPI) RemoveAt(ctx context.Context, params *QueueRemoveAtRequest) (*QueueRemoveAtResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["originServerName"] = params.OriginServerName - req["serverName"] = params.ServerName + req["id"] = params.ID } - raw, err := a.client.Request("session.mcp.apps.listTools", req) + raw, err := a.client.Request(ctx, "session.queue.removeAt", req) if err != nil { return nil, err } - var result McpAppsListToolsResult + var result QueueRemoveAtResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReadResource fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) -// from a connected server. Requires the `mcp-apps` session capability. -// -// RPC method: session.mcp.apps.readResource. +// RemoveMostRecent removes the most recently queued user-facing item (LIFO). // -// Parameters: MCP server and resource URI to fetch. +// RPC method: session.queue.removeMostRecent. // -// Returns: Resource contents returned by the MCP server. -func (a *McpAppsApi) ReadResource(ctx context.Context, params *McpAppsReadResourceRequest) (*McpAppsReadResourceResult, error) { +// Returns: Indicates whether a user-facing pending item was removed. +func (a *QueueAPI) RemoveMostRecent(ctx context.Context) (*QueueRemoveMostRecentResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["serverName"] = params.ServerName - req["uri"] = params.URI - } - raw, err := a.client.Request("session.mcp.apps.readResource", req) + raw, err := a.client.Request(ctx, "session.queue.removeMostRecent", req) if err != nil { return nil, err } - var result McpAppsReadResourceResult + var result QueueRemoveMostRecentResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetHostContext replace the host context returned to MCP App guests on `ui/initialize`. -// Hosts use this to advertise theme, locale, or other metadata to the guest UI. +// SendNow moves an addressable queued message into the live turn's steering lane. // -// RPC method: session.mcp.apps.setHostContext. +// RPC method: session.queue.sendNow. // -// Parameters: Host context to advertise to MCP App guests. -func (a *McpAppsApi) SetHostContext(ctx context.Context, params *McpAppsSetHostContextRequest) (*SessionMcpAppsSetHostContextResult, error) { +// Parameters: Parameters for steering a queued message into a live turn. +// +// Returns: Result of trying to steer a queued message into a live turn. +func (a *QueueAPI) SendNow(ctx context.Context, params *QueueSendNowRequest) (*QueueSendNowResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["context"] = params.Context + req["id"] = params.ID } - raw, err := a.client.Request("session.mcp.apps.setHostContext", req) + raw, err := a.client.Request(ctx, "session.queue.sendNow", req) if err != nil { return nil, err } - var result SessionMcpAppsSetHostContextResult + var result QueueSendNowResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: Apps returns experimental APIs that may change or be removed. -func (s *McpApi) Apps() *McpAppsApi { - return (*McpAppsApi)(s) -} - -// Experimental: McpOauthApi contains experimental APIs that may change or be removed. -type McpOauthApi sessionApi - -// Login starts OAuth authentication for a remote MCP server. -// -// RPC method: session.mcp.oauth.login. +// SetDrainPaused acquires or releases the queued-lane drain pause. // -// Parameters: Remote MCP server name and optional overrides controlling reauthentication, -// OAuth client display name, and the callback success-page copy. +// RPC method: session.queue.setDrainPaused. // -// Returns: OAuth authorization URL the caller should open, or empty when cached tokens -// already authenticated the server. -func (a *McpOauthApi) Login(ctx context.Context, params *McpOauthLoginRequest) (*McpOauthLoginResult, error) { +// Parameters: Parameters for acquiring or releasing the queued-lane drain pause. +// Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused +// session fails with `queue_already_paused`. The pause is never released automatically — it +// is not tied to the caller's lifetime, so a client that exits without sending `paused: +// false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for +// any caller, including one that never acquired it. +func (a *QueueAPI) SetDrainPaused(ctx context.Context, params *QueueSetDrainPausedRequest) (*SessionQueueSetDrainPausedResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.CallbackSuccessMessage != nil { - req["callbackSuccessMessage"] = *params.CallbackSuccessMessage - } - if params.ClientName != nil { - req["clientName"] = *params.ClientName - } - if params.ForceReauth != nil { - req["forceReauth"] = *params.ForceReauth - } - req["serverName"] = params.ServerName + req["paused"] = params.Paused } - raw, err := a.client.Request("session.mcp.oauth.login", req) + raw, err := a.client.Request(ctx, "session.queue.setDrainPaused", req) if err != nil { return nil, err } - var result McpOauthLoginResult + var result SessionQueueSetDrainPausedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: Oauth returns experimental APIs that may change or be removed. -func (s *McpApi) Oauth() *McpOauthApi { - return (*McpOauthApi)(s) -} - -// Experimental: MetadataApi contains experimental APIs that may change or be removed. -type MetadataApi sessionApi - -// ContextInfo returns the token breakdown for the session's current context window for a -// given model. +// UpdateText updates the text of an addressable single-message queue item. // -// RPC method: session.metadata.contextInfo. +// RPC method: session.queue.updateText. // -// Parameters: Model identifier and token limits used to compute the context-info breakdown. +// Parameters: Parameters for editing a single queued message. // -// Returns: Token breakdown for the session's current context window, or null if -// uninitialized. -func (a *MetadataApi) ContextInfo(ctx context.Context, params *MetadataContextInfoRequest) (*MetadataContextInfoResult, error) { +// Returns: Result of editing a queued message. +func (a *QueueAPI) UpdateText(ctx context.Context, params *QueueUpdateTextRequest) (*QueueUpdateTextResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["outputTokenLimit"] = params.OutputTokenLimit - req["promptTokenLimit"] = params.PromptTokenLimit - if params.SelectedModel != nil { - req["selectedModel"] = *params.SelectedModel + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt } + req["id"] = params.ID + req["prompt"] = params.Prompt } - raw, err := a.client.Request("session.metadata.contextInfo", req) + raw, err := a.client.Request(ctx, "session.queue.updateText", req) if err != nil { return nil, err } - var result MetadataContextInfoResult + var result QueueUpdateTextResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// IsProcessing reports whether the local session is currently processing user/agent -// messages. -// -// RPC method: session.metadata.isProcessing. +// Experimental: RemoteAPI contains experimental APIs that may change or be removed. +type RemoteAPI sessionAPI + +// Disables remote session export and steering. // -// Returns: Indicates whether the local session is currently processing a turn or background -// continuation. -func (a *MetadataApi) IsProcessing(ctx context.Context) (*MetadataIsProcessingResult, error) { +// RPC method: session.remote.disable. +func (a *RemoteAPI) Disable(ctx context.Context) (*SessionRemoteDisableResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.metadata.isProcessing", req) + raw, err := a.client.Request(ctx, "session.remote.disable", req) if err != nil { return nil, err } - var result MetadataIsProcessingResult + var result SessionRemoteDisableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RecomputeContextTokens re-tokenizes the session's existing messages against a model and -// returns aggregate token totals. +// Enables remote session export or steering. // -// RPC method: session.metadata.recomputeContextTokens. +// RPC method: session.remote.enable. // -// Parameters: Model identifier to use when re-tokenizing the session's existing messages. +// Parameters: Optional remote session mode ("off", "export", or "on"); defaults to enabling +// both export and remote steering. // -// Returns: Re-tokenize the session's existing messages against `modelId` and return the -// token totals. Useful for hosts that want an initial estimate of context usage on session -// resume, before the next agent turn fires `session.context_info_changed` events. Returns -// zeros for an empty session. -func (a *MetadataApi) RecomputeContextTokens(ctx context.Context, params *MetadataRecomputeContextTokensRequest) (*MetadataRecomputeContextTokensResult, error) { +// Returns: GitHub URL for the session and a flag indicating whether remote steering is +// enabled. +func (a *RemoteAPI) Enable(ctx context.Context, params *RemoteEnableRequest) (*RemoteEnableResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["modelId"] = params.ModelID + if params.Mode != nil { + req["mode"] = *params.Mode + } } - raw, err := a.client.Request("session.metadata.recomputeContextTokens", req) + raw, err := a.client.Request(ctx, "session.remote.enable", req) if err != nil { return nil, err } - var result MetadataRecomputeContextTokensResult + var result RemoteEnableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RecordContextChange records a working-directory/git context change and emits a -// `session.context_changed` event. +// NotifySteerableChanged persists a remote-steerability change emitted by the host as a +// session event. // -// RPC method: session.metadata.recordContextChange. +// RPC method: session.remote.notifySteerableChanged. // -// Parameters: Updated working-directory/git context to record on the session. +// Parameters: New remote-steerability state to persist as a +// `session.remote_steerable_changed` event. // -// Returns: Notify the session that its working directory context has changed. Emits a -// `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline -// UI) can react. Use this when the host has detected a cwd/branch/repo change outside the -// session's normal lifecycle (e.g., after a shell command in interactive mode). -func (a *MetadataApi) RecordContextChange(ctx context.Context, params *MetadataRecordContextChangeRequest) (*MetadataRecordContextChangeResult, error) { +// Returns: Persist a steerability change as a `session.remote_steerable_changed` event. +// Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling +// steering on a remote exporter that the runtime does not directly own. +func (a *RemoteAPI) NotifySteerableChanged(ctx context.Context, params *RemoteNotifySteerableChangedRequest) (*RemoteNotifySteerableChangedResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["context"] = params.Context + req["remoteSteerable"] = params.RemoteSteerable } - raw, err := a.client.Request("session.metadata.recordContextChange", req) + raw, err := a.client.Request(ctx, "session.remote.notifySteerableChanged", req) if err != nil { return nil, err } - var result MetadataRecordContextChangeResult + var result RemoteNotifySteerableChangedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetWorkingDirectory updates the session's recorded working directory. -// -// RPC method: session.metadata.setWorkingDirectory. +// Experimental: ScheduleAPI contains experimental APIs that may change or be removed. +type ScheduleAPI sessionAPI + +// Lists the session's currently active scheduled prompts. // -// Parameters: Absolute path to set as the session's new working directory. +// RPC method: session.schedule.list. // -// Returns: Update the session's working directory. Used by the host when the user -// explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for -// `process.chdir` and any related side-effects (file index, etc.); this method only updates -// the session's own recorded path. -func (a *MetadataApi) SetWorkingDirectory(ctx context.Context, params *MetadataSetWorkingDirectoryRequest) (*MetadataSetWorkingDirectoryResult, error) { +// Returns: Snapshot of the currently active recurring prompts for this session. +func (a *ScheduleAPI) List(ctx context.Context) (*ScheduleList, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["workingDirectory"] = params.WorkingDirectory - } - raw, err := a.client.Request("session.metadata.setWorkingDirectory", req) + raw, err := a.client.Request(ctx, "session.schedule.list", req) if err != nil { return nil, err } - var result MetadataSetWorkingDirectoryResult + var result ScheduleList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Snapshot returns a snapshot of the session's identifying metadata, mode, agent, and -// remote info. +// Stop removes a scheduled prompt by id. // -// RPC method: session.metadata.snapshot. +// RPC method: session.schedule.stop. // -// Returns: Point-in-time snapshot of slow-changing session identifier and state fields -func (a *MetadataApi) Snapshot(ctx context.Context) (*SessionMetadataSnapshot, error) { +// Parameters: Identifier of the scheduled prompt to remove. +// +// Returns: Remove a scheduled prompt by id. The result entry is omitted if the id was +// unknown. +func (a *ScheduleAPI) Stop(ctx context.Context, params *ScheduleStopRequest) (*ScheduleStopResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.metadata.snapshot", req) + if params != nil { + req["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.schedule.stop", req) if err != nil { return nil, err } - var result SessionMetadataSnapshot + var result ScheduleStopResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ModeApi contains experimental APIs that may change or be removed. -type ModeApi sessionApi +// Experimental: ShellAPI contains experimental APIs that may change or be removed. +type ShellAPI sessionAPI -// Gets the current agent interaction mode. +// CancelUserRequested cancels a user-requested shell command by request ID. // -// RPC method: session.mode.get. +// RPC method: session.shell.cancelUserRequested. // -// Returns: The session mode the agent is operating in -func (a *ModeApi) Get(ctx context.Context) (*SessionMode, error) { +// Parameters: User-requested shell execution cancellation handle. +// +// Returns: Cancellation result for a user-requested shell command. +func (a *ShellAPI) CancelUserRequested(ctx context.Context, params *ShellCancelUserRequestedRequest) (*CancelUserRequestedShellCommandResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.mode.get", req) + if params != nil { + req["requestId"] = params.RequestID + } + raw, err := a.client.Request(ctx, "session.shell.cancelUserRequested", req) if err != nil { return nil, err } - var result SessionMode + var result CancelUserRequestedShellCommandResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Sets the current agent interaction mode. +// Exec starts a shell command and streams output through session notifications. The command +// runs as the leader of its own process group (POSIX) or in a dedicated job object +// (Windows), so a forced termination — via "shell.kill", the request timeout, or session +// disposal — signals that whole group/job rather than only the direct child. Two gaps are +// worth planning for: a command that exits on its own does not trigger that teardown, and +// on POSIX a descendant that moves itself into a new session or process group (for example +// via "setsid") leaves the signalled group, so either can leave a background process +// running. // -// RPC method: session.mode.set. +// RPC method: session.shell.exec. // -// Parameters: Agent interaction mode to apply to the session. -func (a *ModeApi) Set(ctx context.Context, params *ModeSetRequest) (*SessionModeSetResult, error) { +// Parameters: Shell command to run, with optional working directory and timeout in +// milliseconds. +// +// Returns: Identifier of the spawned process, used to correlate streamed output and exit +// notifications. +func (a *ShellAPI) Exec(ctx context.Context, params *ShellExecRequest) (*ShellExecResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["mode"] = params.Mode + req["command"] = params.Command + if params.Cwd != nil { + req["cwd"] = *params.Cwd + } + if params.Timeout != nil { + req["timeout"] = *params.Timeout + } } - raw, err := a.client.Request("session.mode.set", req) + raw, err := a.client.Request(ctx, "session.shell.exec", req) if err != nil { return nil, err } - var result SessionModeSetResult + var result ShellExecResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ModelApi contains experimental APIs that may change or be removed. -type ModelApi sessionApi - -// GetCurrent gets the currently selected model for the session. +// ExecuteUserRequested executes a user-requested shell command through the session runtime. // -// RPC method: session.model.getCurrent. +// RPC method: session.shell.executeUserRequested. +// +// Parameters: User-requested shell command and cancellation handle. // -// Returns: The currently selected model, reasoning effort, and context tier for the session. -func (a *ModelApi) GetCurrent(ctx context.Context) (*CurrentModel, error) { +// Returns: Result of a user-requested shell command. +func (a *ShellAPI) ExecuteUserRequested(ctx context.Context, params *ShellExecuteUserRequestedRequest) (*UserRequestedShellCommandResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.model.getCurrent", req) + if params != nil { + req["command"] = params.Command + req["requestId"] = params.RequestID + } + raw, err := a.client.Request(ctx, "session.shell.executeUserRequested", req) if err != nil { return nil, err } - var result CurrentModel + var result UserRequestedShellCommandResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists models available to this session using its own auth and integration context. -// Connected hosts (CLI TUI, GitHub App) should call this through the session client so -// remote sessions return the remote CLI's available models rather than the caller's. +// Kill sends a signal to a shell process previously started via "shell.exec". The signal +// targets the command's whole process group (POSIX) or job object (Windows), so descendants +// still in that group are signalled too, not just the direct child. On POSIX a descendant +// that moved itself into a new session or process group (for example via "setsid") is no +// longer in the signalled group and survives. // -// RPC method: session.model.list. +// RPC method: session.shell.kill. // -// Parameters: Optional listing options. +// Parameters: Identifier of a process previously returned by "shell.exec" and the signal to +// send. // -// Returns: The list of models available to this session. -func (a *ModelApi) List(ctx context.Context, params ...*ModelListRequest) (*SessionModelList, error) { - var requestParams *ModelListRequest - if len(params) > 0 { - requestParams = params[0] - } +// Returns: Indicates whether the signal was delivered; false if the process was unknown or +// already exited. +func (a *ShellAPI) Kill(ctx context.Context, params *ShellKillRequest) (*ShellKillResult, error) { req := map[string]any{"sessionId": a.sessionID} - if requestParams != nil { - if requestParams.SkipCache != nil { - req["skipCache"] = *requestParams.SkipCache + if params != nil { + req["processId"] = params.ProcessID + if params.Signal != nil { + req["signal"] = *params.Signal } } - raw, err := a.client.Request("session.model.list", req) + raw, err := a.client.Request(ctx, "session.shell.kill", req) if err != nil { return nil, err } - var result SessionModelList + var result ShellKillResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetReasoningEffort updates the session's reasoning effort without changing the selected -// model. -// -// RPC method: session.model.setReasoningEffort. +// Experimental: SkillsAPI contains experimental APIs that may change or be removed. +type SkillsAPI sessionAPI + +// Disables a skill for the session. // -// Parameters: Reasoning effort level to apply to the currently selected model. +// RPC method: session.skills.disable. // -// Returns: Update the session's reasoning effort without changing the selected model. Use -// `switchTo` instead when you also need to change the model. The runtime stores the effort -// on the session and applies it to subsequent turns. -func (a *ModelApi) SetReasoningEffort(ctx context.Context, params *ModelSetReasoningEffortRequest) (*ModelSetReasoningEffortResult, error) { +// Parameters: Name of the skill to disable for the session. +func (a *SkillsAPI) Disable(ctx context.Context, params *SkillsDisableRequest) (*SessionSkillsDisableResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["reasoningEffort"] = params.ReasoningEffort + req["name"] = params.Name } - raw, err := a.client.Request("session.model.setReasoningEffort", req) + raw, err := a.client.Request(ctx, "session.skills.disable", req) if err != nil { return nil, err } - var result ModelSetReasoningEffortResult + var result SessionSkillsDisableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SwitchTo switches the session to a model and optional reasoning configuration. -// -// RPC method: session.model.switchTo. +// Enables a skill for the session. // -// Parameters: Target model identifier and optional reasoning effort, summary, capability -// overrides, and context tier. +// RPC method: session.skills.enable. // -// Returns: The model identifier active on the session after the switch. -func (a *ModelApi) SwitchTo(ctx context.Context, params *ModelSwitchToRequest) (*ModelSwitchToResult, error) { +// Parameters: Name of the skill to enable for the session. +func (a *SkillsAPI) Enable(ctx context.Context, params *SkillsEnableRequest) (*SessionSkillsEnableResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.ContextTier != nil { - req["contextTier"] = *params.ContextTier - } - if params.ModelCapabilities != nil { - req["modelCapabilities"] = *params.ModelCapabilities - } - req["modelId"] = params.ModelID - if params.ReasoningEffort != nil { - req["reasoningEffort"] = *params.ReasoningEffort - } - if params.ReasoningSummary != nil { - req["reasoningSummary"] = *params.ReasoningSummary - } + req["name"] = params.Name } - raw, err := a.client.Request("session.model.switchTo", req) + raw, err := a.client.Request(ctx, "session.skills.enable", req) if err != nil { return nil, err } - var result ModelSwitchToResult + var result SessionSkillsEnableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: NameApi contains experimental APIs that may change or be removed. -type NameApi sessionApi - -// Gets the session's friendly name. -// -// RPC method: session.name.get. +// EnsureLoaded ensures the session's skill definitions have been loaded from disk. // -// Returns: The session's friendly name, or null when not yet set. -func (a *NameApi) Get(ctx context.Context) (*NameGetResult, error) { +// RPC method: session.skills.ensureLoaded. +func (a *SkillsAPI) EnsureLoaded(ctx context.Context) (*SessionSkillsEnsureLoadedResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.name.get", req) + raw, err := a.client.Request(ctx, "session.skills.ensureLoaded", req) if err != nil { return nil, err } - var result NameGetResult + var result SessionSkillsEnsureLoadedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Sets the session's friendly name. +// GetInvoked returns the skills that have been invoked during this session. // -// RPC method: session.name.set. +// RPC method: session.skills.getInvoked. // -// Parameters: New friendly name to apply to the session. -func (a *NameApi) Set(ctx context.Context, params *NameSetRequest) (*SessionNameSetResult, error) { +// Returns: Skills invoked during this session, ordered by invocation time (most recent +// last). +func (a *SkillsAPI) GetInvoked(ctx context.Context) (*SkillsGetInvokedResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["name"] = params.Name - } - raw, err := a.client.Request("session.name.set", req) + raw, err := a.client.Request(ctx, "session.skills.getInvoked", req) if err != nil { return nil, err } - var result SessionNameSetResult + var result SkillsGetInvokedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetAuto persists an auto-generated session summary as the session's name when no user-set -// name exists. -// -// RPC method: session.name.setAuto. +// Lists skills available to the session. // -// Parameters: Auto-generated session summary to apply as the session's name when no -// user-set name exists. +// RPC method: session.skills.list. // -// Returns: Indicates whether the auto-generated summary was applied as the session's name. -func (a *NameApi) SetAuto(ctx context.Context, params *NameSetAutoRequest) (*NameSetAutoResult, error) { +// Returns: Skills available to the session, with their enabled state. +func (a *SkillsAPI) List(ctx context.Context) (*SkillList, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["summary"] = params.Summary - } - raw, err := a.client.Request("session.name.setAuto", req) + raw, err := a.client.Request(ctx, "session.skills.list", req) if err != nil { return nil, err } - var result NameSetAutoResult + var result SkillList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: OptionsApi contains experimental APIs that may change or be removed. -type OptionsApi sessionApi - -// Update patches the genuinely-mutable subset of session options. -// -// RPC method: session.options.update. +// Reloads skill definitions for the session. // -// Parameters: Patch of mutable session options to apply to the running session. +// RPC method: session.skills.reload. // -// Returns: Indicates whether the session options patch was applied successfully. -func (a *OptionsApi) Update(ctx context.Context, params *SessionUpdateOptionsParams) (*SessionUpdateOptionsResult, error) { +// Returns: Diagnostics from reloading skill definitions, with warnings and errors as +// separate lists. +func (a *SkillsAPI) Reload(ctx context.Context) (*SkillsLoadDiagnostics, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.AdditionalContentExclusionPolicies != nil { - req["additionalContentExclusionPolicies"] = params.AdditionalContentExclusionPolicies - } - if params.AgentContext != nil { - req["agentContext"] = *params.AgentContext - } - if params.AskUserDisabled != nil { - req["askUserDisabled"] = *params.AskUserDisabled - } - if params.AvailableTools != nil { - req["availableTools"] = params.AvailableTools - } - if params.ClientName != nil { - req["clientName"] = *params.ClientName - } - if params.CoauthorEnabled != nil { - req["coauthorEnabled"] = *params.CoauthorEnabled - } - if params.ContinueOnAutoMode != nil { - req["continueOnAutoMode"] = *params.ContinueOnAutoMode - } - if params.CopilotURL != nil { - req["copilotUrl"] = *params.CopilotURL - } - if params.CustomAgentsLocalOnly != nil { - req["customAgentsLocalOnly"] = *params.CustomAgentsLocalOnly - } - if params.DisabledInstructionSources != nil { - req["disabledInstructionSources"] = params.DisabledInstructionSources - } - if params.DisabledSkills != nil { - req["disabledSkills"] = params.DisabledSkills - } - if params.EnableFileHooks != nil { - req["enableFileHooks"] = *params.EnableFileHooks - } - if params.EnableHostGitOperations != nil { - req["enableHostGitOperations"] = *params.EnableHostGitOperations - } - if params.EnableOnDemandInstructionDiscovery != nil { - req["enableOnDemandInstructionDiscovery"] = *params.EnableOnDemandInstructionDiscovery - } - if params.EnableReasoningSummaries != nil { - req["enableReasoningSummaries"] = *params.EnableReasoningSummaries - } - if params.EnableScriptSafety != nil { - req["enableScriptSafety"] = *params.EnableScriptSafety - } - if params.EnableSessionStore != nil { - req["enableSessionStore"] = *params.EnableSessionStore - } - if params.EnableSkills != nil { - req["enableSkills"] = *params.EnableSkills - } - if params.EnableStreaming != nil { - req["enableStreaming"] = *params.EnableStreaming - } - if params.EnvValueMode != nil { - req["envValueMode"] = *params.EnvValueMode - } - if params.EventsLogDirectory != nil { - req["eventsLogDirectory"] = *params.EventsLogDirectory - } - if params.ExcludedTools != nil { - req["excludedTools"] = params.ExcludedTools - } - if params.FeatureFlags != nil { - req["featureFlags"] = params.FeatureFlags - } - if params.InstalledPlugins != nil { - req["installedPlugins"] = params.InstalledPlugins - } - if params.IntegrationID != nil { - req["integrationId"] = *params.IntegrationID - } - if params.IsExperimentalMode != nil { - req["isExperimentalMode"] = *params.IsExperimentalMode - } - if params.LogInteractiveShells != nil { - req["logInteractiveShells"] = *params.LogInteractiveShells - } - if params.LspClientName != nil { - req["lspClientName"] = *params.LspClientName - } - if params.ManageScheduleEnabled != nil { - req["manageScheduleEnabled"] = *params.ManageScheduleEnabled - } - if params.Model != nil { - req["model"] = *params.Model - } - if params.OrganizationCustomInstructions != nil { - req["organizationCustomInstructions"] = *params.OrganizationCustomInstructions - } - if params.Provider != nil { - req["provider"] = params.Provider - } - if params.ReasoningEffort != nil { - req["reasoningEffort"] = *params.ReasoningEffort - } - if params.RunningInInteractiveMode != nil { - req["runningInInteractiveMode"] = *params.RunningInInteractiveMode - } - if params.SandboxConfig != nil { - req["sandboxConfig"] = params.SandboxConfig - } - if params.ShellInitProfile != nil { - req["shellInitProfile"] = *params.ShellInitProfile - } - if params.ShellProcessFlags != nil { - req["shellProcessFlags"] = params.ShellProcessFlags - } - if params.SkillDirectories != nil { - req["skillDirectories"] = params.SkillDirectories - } - if params.SkipCustomInstructions != nil { - req["skipCustomInstructions"] = *params.SkipCustomInstructions - } - if params.SkipEmbeddingRetrieval != nil { - req["skipEmbeddingRetrieval"] = *params.SkipEmbeddingRetrieval - } - if params.ToolFilterPrecedence != nil { - req["toolFilterPrecedence"] = *params.ToolFilterPrecedence - } - if params.TrajectoryFile != nil { - req["trajectoryFile"] = *params.TrajectoryFile - } - if params.WorkingDirectory != nil { - req["workingDirectory"] = *params.WorkingDirectory - } - } - raw, err := a.client.Request("session.options.update", req) + raw, err := a.client.Request(ctx, "session.skills.reload", req) if err != nil { return nil, err } - var result SessionUpdateOptionsResult + var result SkillsLoadDiagnostics if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: PermissionsApi contains experimental APIs that may change or be removed. -type PermissionsApi sessionApi +// Experimental: TasksAPI contains experimental APIs that may change or be removed. +type TasksAPI sessionAPI -// Configure replaces selected permission policy fields (rules, paths, URLs, exclusions, -// allow-all flags) on the session. +// Cancels a background task. // -// RPC method: session.permissions.configure. +// RPC method: session.tasks.cancel. // -// Parameters: Patch of permission policy fields to apply (omit a field to leave it -// unchanged). +// Parameters: Identifier of the background task to cancel. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) Configure(ctx context.Context, params *PermissionsConfigureParams) (*PermissionsConfigureResult, error) { +// Returns: Indicates whether the background task was successfully cancelled. +func (a *TasksAPI) Cancel(ctx context.Context, params *TasksCancelRequest) (*TasksCancelResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.AdditionalContentExclusionPolicies != nil { - req["additionalContentExclusionPolicies"] = params.AdditionalContentExclusionPolicies - } - if params.ApproveAllReadPermissionRequests != nil { - req["approveAllReadPermissionRequests"] = *params.ApproveAllReadPermissionRequests - } - if params.ApproveAllToolPermissionRequests != nil { - req["approveAllToolPermissionRequests"] = *params.ApproveAllToolPermissionRequests - } - if params.Paths != nil { - req["paths"] = *params.Paths - } - if params.Rules != nil { - req["rules"] = *params.Rules - } - if params.Urls != nil { - req["urls"] = *params.Urls - } + req["id"] = params.ID } - raw, err := a.client.Request("session.permissions.configure", req) + raw, err := a.client.Request(ctx, "session.tasks.cancel", req) if err != nil { return nil, err } - var result PermissionsConfigureResult + var result TasksCancelResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetAllowAll returns whether full allow-all permissions are currently active for the -// session. +// GetCurrentPromotable returns the first sync-waiting task that can currently be promoted +// to background mode. // -// RPC method: session.permissions.getAllowAll. +// RPC method: session.tasks.getCurrentPromotable. // -// Returns: Current full allow-all permission state. -func (a *PermissionsApi) GetAllowAll(ctx context.Context) (*AllowAllPermissionState, error) { +// Returns: The first sync-waiting task that can currently be promoted to background mode. +func (a *TasksAPI) GetCurrentPromotable(ctx context.Context) (*TasksGetCurrentPromotableResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.permissions.getAllowAll", req) + raw, err := a.client.Request(ctx, "session.tasks.getCurrentPromotable", req) if err != nil { return nil, err } - var result AllowAllPermissionState + var result TasksGetCurrentPromotableResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingPermissionRequest provides a decision for a pending tool permission request. +// GetProgress returns progress information for a background task by ID. // -// RPC method: session.permissions.handlePendingPermissionRequest. +// RPC method: session.tasks.getProgress. // -// Parameters: Pending permission request ID and the decision to apply (approve/reject and -// scope). +// Parameters: Identifier of the background task to fetch progress for. // -// Returns: Indicates whether the permission decision was applied; false when the request -// was already resolved. -func (a *PermissionsApi) HandlePendingPermissionRequest(ctx context.Context, params *PermissionDecisionRequest) (*PermissionRequestResult, error) { +// Returns: Progress information for the task, or null when no task with that ID is tracked. +func (a *TasksAPI) GetProgress(ctx context.Context, params *TasksGetProgressRequest) (*TasksGetProgressResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["result"] = params.Result + req["id"] = params.ID } - raw, err := a.client.Request("session.permissions.handlePendingPermissionRequest", req) + raw, err := a.client.Request(ctx, "session.tasks.getProgress", req) if err != nil { return nil, err } - var result PermissionRequestResult + var result TasksGetProgressResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ModifyRules adds or removes session-scoped or location-scoped permission rules. -// -// RPC method: session.permissions.modifyRules. +// Lists background tasks tracked by the session. // -// Parameters: Scope and add/remove instructions for modifying session- or location-scoped -// permission rules. +// RPC method: session.tasks.list. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) ModifyRules(ctx context.Context, params *PermissionsModifyRulesParams) (*PermissionsModifyRulesResult, error) { +// Returns: Background tasks currently tracked by the session. +func (a *TasksAPI) List(ctx context.Context) (*TaskList, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.Add != nil { - req["add"] = params.Add - } - if params.Remove != nil { - req["remove"] = params.Remove - } - if params.RemoveAll != nil { - req["removeAll"] = *params.RemoveAll - } - req["scope"] = params.Scope - } - raw, err := a.client.Request("session.permissions.modifyRules", req) + raw, err := a.client.Request(ctx, "session.tasks.list", req) if err != nil { return nil, err } - var result PermissionsModifyRulesResult + var result TaskList if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// NotifyPromptShown notifies the runtime that a permission prompt UI has been shown to the -// user. -// -// RPC method: session.permissions.notifyPromptShown. +// PromoteCurrentToBackground atomically promotes the first promotable sync-waiting task to +// background mode and returns it. // -// Parameters: Notification payload describing the permission prompt that the client just -// rendered. +// RPC method: session.tasks.promoteCurrentToBackground. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) NotifyPromptShown(ctx context.Context, params *PermissionPromptShownNotification) (*PermissionsNotifyPromptShownResult, error) { +// Returns: The promoted task as it now exists in background mode, omitted if no promotable +// task was waiting. +func (a *TasksAPI) PromoteCurrentToBackground(ctx context.Context) (*TasksPromoteCurrentToBackgroundResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["message"] = params.Message - } - raw, err := a.client.Request("session.permissions.notifyPromptShown", req) + raw, err := a.client.Request(ctx, "session.tasks.promoteCurrentToBackground", req) if err != nil { return nil, err } - var result PermissionsNotifyPromptShownResult + var result TasksPromoteCurrentToBackgroundResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// PendingRequests reconstructs the set of pending tool permission requests from the -// session's event history. +// PromoteToBackground promotes an eligible synchronously-waited task so it continues +// running in the background. // -// RPC method: session.permissions.pendingRequests. +// RPC method: session.tasks.promoteToBackground. // -// Returns: List of pending permission requests reconstructed from event history. -func (a *PermissionsApi) PendingRequests(ctx context.Context) (*PendingPermissionRequestList, error) { +// Parameters: Identifier of the task to promote to background mode. +// +// Returns: Indicates whether the task was successfully promoted to background mode. +func (a *TasksAPI) PromoteToBackground(ctx context.Context, params *TasksPromoteToBackgroundRequest) (*TasksPromoteToBackgroundResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.permissions.pendingRequests", req) + if params != nil { + req["id"] = params.ID + } + raw, err := a.client.Request(ctx, "session.tasks.promoteToBackground", req) if err != nil { return nil, err } - var result PendingPermissionRequestList + var result TasksPromoteToBackgroundResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ResetSessionApprovals clears session-scoped tool permission approvals. +// Refreshes metadata for any detached background shells the runtime knows about. // -// RPC method: session.permissions.resetSessionApprovals. +// RPC method: session.tasks.refresh. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) ResetSessionApprovals(ctx context.Context) (*PermissionsResetSessionApprovalsResult, error) { +// Returns: Refresh metadata for any detached background shells the runtime knows about. Use +// after a long pause to pick up exit/output state for shells running outside the agent loop. +func (a *TasksAPI) Refresh(ctx context.Context) (*TasksRefreshResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.permissions.resetSessionApprovals", req) + raw, err := a.client.Request(ctx, "session.tasks.refresh", req) if err != nil { return nil, err } - var result PermissionsResetSessionApprovalsResult + var result TasksRefreshResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetAllowAll enables or disables full allow-all permissions (tools, paths, and URLs) for -// the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) -// to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the -// unrestricted path and URL managers and emits `session.permissions_changed` on transition. -// The result returns the authoritative post-mutation state so callers can update their -// local mirrors without racing the `session.permissions_changed` notification on the same -// wire. +// Removes a completed or cancelled background task from tracking. // -// RPC method: session.permissions.setAllowAll. +// RPC method: session.tasks.remove. // -// Parameters: Whether to enable full allow-all permissions for the session. +// Parameters: Identifier of the completed or cancelled task to remove from tracking. // -// Returns: Indicates whether the operation succeeded and reports the post-mutation state. -func (a *PermissionsApi) SetAllowAll(ctx context.Context, params *PermissionsSetAllowAllRequest) (*AllowAllPermissionSetResult, error) { +// Returns: Indicates whether the task was removed. False when the task does not exist or is +// still running/idle. +func (a *TasksAPI) Remove(ctx context.Context, params *TasksRemoveRequest) (*TasksRemoveResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["enabled"] = params.Enabled - if params.Source != nil { - req["source"] = *params.Source - } + req["id"] = params.ID } - raw, err := a.client.Request("session.permissions.setAllowAll", req) + raw, err := a.client.Request(ctx, "session.tasks.remove", req) if err != nil { return nil, err } - var result AllowAllPermissionSetResult + var result TasksRemoveResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetApproveAll enables or disables automatic approval of tool permission requests for the -// session. +// SendMessage sends a message to a background agent task. // -// RPC method: session.permissions.setApproveAll. +// RPC method: session.tasks.sendMessage. // -// Parameters: Allow-all toggle for tool permission requests, with an optional telemetry -// source. +// Parameters: Identifier of the target agent task, message content, and optional sender +// agent ID. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) SetApproveAll(ctx context.Context, params *PermissionsSetApproveAllRequest) (*PermissionsSetApproveAllResult, error) { +// Returns: Indicates whether the message was delivered, with an error message when delivery +// failed. +func (a *TasksAPI) SendMessage(ctx context.Context, params *TasksSendMessageRequest) (*TasksSendMessageResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["enabled"] = params.Enabled - if params.Source != nil { - req["source"] = *params.Source + if params.FromAgentID != nil { + req["fromAgentId"] = *params.FromAgentID } + req["id"] = params.ID + req["message"] = params.Message } - raw, err := a.client.Request("session.permissions.setApproveAll", req) + raw, err := a.client.Request(ctx, "session.tasks.sendMessage", req) if err != nil { return nil, err } - var result PermissionsSetApproveAllResult + var result TasksSendMessageResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SetRequired sets whether the client wants permission prompts bridged into session events. +// StartAgent starts a background agent task in the session. // -// RPC method: session.permissions.setRequired. +// RPC method: session.tasks.startAgent. // -// Parameters: Toggles whether permission prompts should be bridged into session events for -// this client. +// Parameters: Agent type, prompt, name, and optional description and model override for the +// new task. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsApi) SetRequired(ctx context.Context, params *PermissionsSetRequiredRequest) (*PermissionsSetRequiredResult, error) { +// Returns: Identifier assigned to the newly started background agent task. +func (a *TasksAPI) StartAgent(ctx context.Context, params *TasksStartAgentRequest) (*TasksStartAgentResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["required"] = params.Required + req["agentType"] = params.AgentType + if params.Description != nil { + req["description"] = *params.Description + } + if params.Model != nil { + req["model"] = *params.Model + } + req["name"] = params.Name + req["prompt"] = params.Prompt } - raw, err := a.client.Request("session.permissions.setRequired", req) + raw, err := a.client.Request(ctx, "session.tasks.startAgent", req) if err != nil { return nil, err } - var result PermissionsSetRequiredResult + var result TasksStartAgentResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: PermissionsFolderTrustApi contains experimental APIs that may change or be -// removed. -type PermissionsFolderTrustApi sessionApi - -// AddTrusted adds a folder to the user's trusted folders list. -// -// RPC method: session.permissions.folderTrust.addTrusted. +// WaitForPending waits for all in-flight background tasks and any follow-up turns to settle. // -// Parameters: Folder path to add to trusted folders. +// RPC method: session.tasks.waitForPending. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsFolderTrustApi) AddTrusted(ctx context.Context, params *FolderTrustAddParams) (*PermissionsFolderTrustAddTrustedResult, error) { +// Returns: Wait until all in-flight background tasks (agents + shells) and any follow-up +// turns scheduled by their completions have settled. Returns when the runtime is fully +// drained or after an internal timeout (default 10 minutes; configurable via +// COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +func (a *TasksAPI) WaitForPending(ctx context.Context) (*TasksWaitForPendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["path"] = params.Path - } - raw, err := a.client.Request("session.permissions.folderTrust.addTrusted", req) + raw, err := a.client.Request(ctx, "session.tasks.waitForPending", req) if err != nil { return nil, err } - var result PermissionsFolderTrustAddTrustedResult + var result TasksWaitForPendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// IsTrusted reports whether a folder is trusted according to the user's folder trust state. -// -// RPC method: session.permissions.folderTrust.isTrusted. +// Experimental: TelemetryAPI contains experimental APIs that may change or be removed. +type TelemetryAPI sessionAPI + +// GetEngagementId gets the telemetry engagement ID currently associated with the session, +// when available. // -// Parameters: Folder path to check for trust. +// RPC method: session.telemetry.getEngagementId. // -// Returns: Folder trust check result. -func (a *PermissionsFolderTrustApi) IsTrusted(ctx context.Context, params *FolderTrustCheckParams) (*FolderTrustCheckResult, error) { +// Returns: Telemetry engagement ID for the session, when available. +func (a *TelemetryAPI) GetEngagementId(ctx context.Context) (*SessionTelemetryEngagement, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["path"] = params.Path - } - raw, err := a.client.Request("session.permissions.folderTrust.isTrusted", req) + raw, err := a.client.Request(ctx, "session.telemetry.getEngagementId", req) if err != nil { return nil, err } - var result FolderTrustCheckResult + var result SessionTelemetryEngagement if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: FolderTrust returns experimental APIs that may change or be removed. -func (s *PermissionsApi) FolderTrust() *PermissionsFolderTrustApi { - return (*PermissionsFolderTrustApi)(s) -} - -// Experimental: PermissionsLocationsApi contains experimental APIs that may change or be -// removed. -type PermissionsLocationsApi sessionApi - -// AddToolApproval persists a tool approval for a permission location and applies its rules -// to this session's live permission service. -// -// RPC method: session.permissions.locations.addToolApproval. +// SetFeatureOverrides sets feature override key/value pairs to attach to subsequent +// telemetry events for the session. // -// Parameters: Location-scoped tool approval to persist. +// RPC method: session.telemetry.setFeatureOverrides. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsLocationsApi) AddToolApproval(ctx context.Context, params *PermissionLocationAddToolApprovalParams) (*PermissionsLocationsAddToolApprovalResult, error) { +// Parameters: Feature override key/value pairs to attach to subsequent telemetry events +// from this session. +func (a *TelemetryAPI) SetFeatureOverrides(ctx context.Context, params *TelemetrySetFeatureOverridesRequest) (*SessionTelemetrySetFeatureOverridesResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["approval"] = params.Approval - req["locationKey"] = params.LocationKey + req["features"] = params.Features } - raw, err := a.client.Request("session.permissions.locations.addToolApproval", req) + raw, err := a.client.Request(ctx, "session.telemetry.setFeatureOverrides", req) if err != nil { return nil, err } - var result PermissionsLocationsAddToolApprovalResult + var result SessionTelemetrySetFeatureOverridesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Apply applies persisted location-scoped tool approvals and allowed directories for a -// working directory to this session's permission service. -// -// RPC method: session.permissions.locations.apply. +// Experimental: ToolsAPI contains experimental APIs that may change or be removed. +type ToolsAPI sessionAPI + +// GetCurrentMetadata returns lightweight metadata for the session's currently initialized +// tools. // -// Parameters: Working directory to load persisted location permissions for. +// RPC method: session.tools.getCurrentMetadata. // -// Returns: Summary of persisted location permissions applied to the session. -func (a *PermissionsLocationsApi) Apply(ctx context.Context, params *PermissionLocationApplyParams) (*PermissionLocationApplyResult, error) { +// Returns: Current lightweight tool metadata snapshot for the session. +func (a *ToolsAPI) GetCurrentMetadata(ctx context.Context) (*ToolsGetCurrentMetadataResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["workingDirectory"] = params.WorkingDirectory - } - raw, err := a.client.Request("session.permissions.locations.apply", req) + raw, err := a.client.Request(ctx, "session.tools.getCurrentMetadata", req) if err != nil { return nil, err } - var result PermissionLocationApplyResult + var result ToolsGetCurrentMetadataResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Resolves the permission location key and type for a working directory. +// HandlePendingToolCall provides the result for a pending external tool call. // -// RPC method: session.permissions.locations.resolve. +// RPC method: session.tools.handlePendingToolCall. // -// Parameters: Working directory to resolve into a location-permissions key. +// Parameters: Pending external tool call request ID, with the tool result or an error +// describing why it failed. // -// Returns: Resolved location-permissions key and type. -func (a *PermissionsLocationsApi) Resolve(ctx context.Context, params *PermissionLocationResolveParams) (*PermissionLocationResolveResult, error) { +// Returns: Indicates whether the external tool call result was handled successfully. +func (a *ToolsAPI) HandlePendingToolCall(ctx context.Context, params *HandlePendingToolCallRequest) (*HandlePendingToolCallResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["workingDirectory"] = params.WorkingDirectory + if params.Error != nil { + req["error"] = *params.Error + } + req["requestId"] = params.RequestID + if params.Result != nil { + req["result"] = params.Result + } } - raw, err := a.client.Request("session.permissions.locations.resolve", req) + raw, err := a.client.Request(ctx, "session.tools.handlePendingToolCall", req) if err != nil { return nil, err } - var result PermissionLocationResolveResult + var result HandlePendingToolCallResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: Locations returns experimental APIs that may change or be removed. -func (s *PermissionsApi) Locations() *PermissionsLocationsApi { - return (*PermissionsLocationsApi)(s) -} - -// Experimental: PermissionsPathsApi contains experimental APIs that may change or be -// removed. -type PermissionsPathsApi sessionApi - -// Adds a directory to the session's allow-list. -// -// RPC method: session.permissions.paths.add. +// InitializeAndValidate resolves, builds, and validates the runtime tool list for the +// session. // -// Parameters: Directory path to add to the session's allowed directories. +// RPC method: session.tools.initializeAndValidate. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsPathsApi) Add(ctx context.Context, params *PermissionPathsAddParams) (*PermissionsPathsAddResult, error) { +// Returns: Resolve, build, and validate the runtime tool list for this session. Subagent +// sessions and consumer flows that need an initialized tool set before `send` invoke this. +// Default base-class implementation is a no-op for sessions that don't support tool +// validation. +func (a *ToolsAPI) InitializeAndValidate(ctx context.Context) (*ToolsInitializeAndValidateResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["path"] = params.Path - } - raw, err := a.client.Request("session.permissions.paths.add", req) + raw, err := a.client.Request(ctx, "session.tools.initializeAndValidate", req) if err != nil { return nil, err } - var result PermissionsPathsAddResult + var result ToolsInitializeAndValidateResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// IsPathWithinAllowedDirectories reports whether a path falls within any of the session's -// allowed directories. +// UpdateSubagentSettings updates the current session's live subagent settings after user +// settings change. The persisted user settings remain the source of truth for future +// sessions. // -// RPC method: session.permissions.paths.isPathWithinAllowedDirectories. +// RPC method: session.tools.updateSubagentSettings. // -// Parameters: Path to evaluate against the session's allowed directories. +// Parameters: Subagent settings to apply to the current session // -// Returns: Indicates whether the supplied path is within the session's allowed directories. -func (a *PermissionsPathsApi) IsPathWithinAllowedDirectories(ctx context.Context, params *PermissionPathsAllowedCheckParams) (*PermissionPathsAllowedCheckResult, error) { +// Returns: Empty result after applying subagent settings +func (a *ToolsAPI) UpdateSubagentSettings(ctx context.Context, params *UpdateSubagentSettingsRequest) (*ToolsUpdateSubagentSettingsResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["path"] = params.Path + if params.Subagents != nil { + req["subagents"] = *params.Subagents + } } - raw, err := a.client.Request("session.permissions.paths.isPathWithinAllowedDirectories", req) + raw, err := a.client.Request(ctx, "session.tools.updateSubagentSettings", req) if err != nil { return nil, err } - var result PermissionPathsAllowedCheckResult + var result ToolsUpdateSubagentSettingsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// IsPathWithinWorkspace reports whether a path falls within the session's workspace -// (primary) directory. +// Experimental: UIAPI contains experimental APIs that may change or be removed. +type UIAPI sessionAPI + +// Elicitation requests structured input from a UI-capable client. // -// RPC method: session.permissions.paths.isPathWithinWorkspace. +// RPC method: session.ui.elicitation. // -// Parameters: Path to evaluate against the session's workspace (primary) directory. +// Parameters: Prompt message and JSON schema describing the form fields to elicit from the +// user. // -// Returns: Indicates whether the supplied path is within the session's workspace directory. -func (a *PermissionsPathsApi) IsPathWithinWorkspace(ctx context.Context, params *PermissionPathsWorkspaceCheckParams) (*PermissionPathsWorkspaceCheckResult, error) { +// Returns: The elicitation response (accept with form values, decline, or cancel) +func (a *UIAPI) Elicitation(ctx context.Context, params *UIElicitationRequest) (*UIElicitationResponse, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["path"] = params.Path + req["message"] = params.Message + req["requestedSchema"] = params.RequestedSchema } - raw, err := a.client.Request("session.permissions.paths.isPathWithinWorkspace", req) + raw, err := a.client.Request(ctx, "session.ui.elicitation", req) if err != nil { return nil, err } - var result PermissionPathsWorkspaceCheckResult + var result UIElicitationResponse if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// List returns the session's allowed directories and primary working directory. +// EphemeralQuery runs a transient no-tools model query against the current conversation +// context. // -// RPC method: session.permissions.paths.list. +// RPC method: session.ui.ephemeralQuery. // -// Returns: Snapshot of the session's allow-listed directories and primary working directory. -func (a *PermissionsPathsApi) List(ctx context.Context) (*PermissionPathsList, error) { +// Parameters: Transient question to answer without adding it to conversation history. +// +// Returns: Transient answer generated from current conversation context. +func (a *UIAPI) EphemeralQuery(ctx context.Context, params *UIEphemeralQueryRequest) (*UIEphemeralQueryResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.permissions.paths.list", req) + if params != nil { + if params.AbortSignal != nil { + req["abortSignal"] = params.AbortSignal + } + if params.OnChunk != nil { + req["onChunk"] = params.OnChunk + } + req["question"] = params.Question + } + raw, err := a.client.Request(ctx, "session.ui.ephemeralQuery", req) if err != nil { return nil, err } - var result PermissionPathsList + var result UIEphemeralQueryResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// UpdatePrimary updates the session's primary working directory used by the permission -// policy. +// HandlePendingAutoModeSwitch resolves a pending `auto_mode_switch.requested` event with +// the user's accept/decline decision. // -// RPC method: session.permissions.paths.updatePrimary. +// RPC method: session.ui.handlePendingAutoModeSwitch. // -// Parameters: Directory path to set as the session's new primary working directory. +// Parameters: Request ID of a pending `auto_mode_switch.requested` event and the user's +// response. // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsPathsApi) UpdatePrimary(ctx context.Context, params *PermissionPathsUpdatePrimaryParams) (*PermissionsPathsUpdatePrimaryResult, error) { +// Returns: Indicates whether the pending UI request was resolved by this call. +func (a *UIAPI) HandlePendingAutoModeSwitch(ctx context.Context, params *UIHandlePendingAutoModeSwitchRequest) (*UIHandlePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["path"] = params.Path + req["requestId"] = params.RequestID + req["response"] = params.Response } - raw, err := a.client.Request("session.permissions.paths.updatePrimary", req) + raw, err := a.client.Request(ctx, "session.ui.handlePendingAutoModeSwitch", req) if err != nil { return nil, err } - var result PermissionsPathsUpdatePrimaryResult + var result UIHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: Paths returns experimental APIs that may change or be removed. -func (s *PermissionsApi) Paths() *PermissionsPathsApi { - return (*PermissionsPathsApi)(s) -} - -// Experimental: PermissionsUrlsApi contains experimental APIs that may change or be removed. -type PermissionsUrlsApi sessionApi - -// SetUnrestrictedMode toggles the runtime's URL-permission policy between unrestricted and -// restricted modes. +// HandlePendingElicitation provides the user response for a pending elicitation request. // -// RPC method: session.permissions.urls.setUnrestrictedMode. +// RPC method: session.ui.handlePendingElicitation. // -// Parameters: Whether the URL-permission policy should run in unrestricted mode. +// Parameters: Pending elicitation request ID and the user's response (accept/decline/cancel +// + form values). // -// Returns: Indicates whether the operation succeeded. -func (a *PermissionsUrlsApi) SetUnrestrictedMode(ctx context.Context, params *PermissionUrlsSetUnrestrictedModeParams) (*PermissionsUrlsSetUnrestrictedModeResult, error) { +// Returns: Indicates whether the elicitation response was accepted; false if it was already +// resolved by another client. +func (a *UIAPI) HandlePendingElicitation(ctx context.Context, params *UIHandlePendingElicitationRequest) (*UIElicitationResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["enabled"] = params.Enabled + req["requestId"] = params.RequestID + req["result"] = params.Result } - raw, err := a.client.Request("session.permissions.urls.setUnrestrictedMode", req) + raw, err := a.client.Request(ctx, "session.ui.handlePendingElicitation", req) if err != nil { return nil, err } - var result PermissionsUrlsSetUnrestrictedModeResult + var result UIElicitationResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: Urls returns experimental APIs that may change or be removed. -func (s *PermissionsApi) Urls() *PermissionsUrlsApi { - return (*PermissionsUrlsApi)(s) -} - -// Experimental: PlanApi contains experimental APIs that may change or be removed. -type PlanApi sessionApi - -// Deletes the session plan file from the workspace. +// HandlePendingExitPlanMode resolves a pending `exit_plan_mode.requested` event with the +// user's response. // -// RPC method: session.plan.delete. -func (a *PlanApi) Delete(ctx context.Context) (*SessionPlanDeleteResult, error) { +// RPC method: session.ui.handlePendingExitPlanMode. +// +// Parameters: Request ID of a pending `exit_plan_mode.requested` event and the user's +// response. +// +// Returns: Indicates whether the pending UI request was resolved by this call. +func (a *UIAPI) HandlePendingExitPlanMode(ctx context.Context, params *UIHandlePendingExitPlanModeRequest) (*UIHandlePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.plan.delete", req) + if params != nil { + req["requestId"] = params.RequestID + req["response"] = params.Response + } + raw, err := a.client.Request(ctx, "session.ui.handlePendingExitPlanMode", req) if err != nil { return nil, err } - var result SessionPlanDeleteResult + var result UIHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reads the session plan file from the workspace. +// HandlePendingSampling resolves a pending `sampling.requested` event with a sampling +// result, or rejects it. // -// RPC method: session.plan.read. +// RPC method: session.ui.handlePendingSampling. // -// Returns: Existence, contents, and resolved path of the session plan file. -func (a *PlanApi) Read(ctx context.Context) (*PlanReadResult, error) { +// Parameters: Request ID of a pending `sampling.requested` event and an optional sampling +// result payload (omit to reject). +// +// Returns: Indicates whether the pending UI request was resolved by this call. +func (a *UIAPI) HandlePendingSampling(ctx context.Context, params *UIHandlePendingSamplingRequest) (*UIHandlePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.plan.read", req) + if params != nil { + req["requestId"] = params.RequestID + if params.Response != nil { + req["response"] = *params.Response + } + } + raw, err := a.client.Request(ctx, "session.ui.handlePendingSampling", req) if err != nil { return nil, err } - var result PlanReadResult + var result UIHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Update writes new content to the session plan file. +// HandlePendingSessionLimitsExhausted resolves a pending +// `session_limits_exhausted.requested` event with the user's selected limit action. // -// RPC method: session.plan.update. +// RPC method: session.ui.handlePendingSessionLimitsExhausted. // -// Parameters: Replacement contents to write to the session plan file. -func (a *PlanApi) Update(ctx context.Context, params *PlanUpdateRequest) (*SessionPlanUpdateResult, error) { +// Parameters: Request ID of a pending `session_limits_exhausted.requested` event and the +// user's selected limit action. +// +// Returns: Indicates whether the pending UI request was resolved by this call. +func (a *UIAPI) HandlePendingSessionLimitsExhausted(ctx context.Context, params *UIHandlePendingSessionLimitsExhaustedRequest) (*UIHandlePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["content"] = params.Content + req["requestId"] = params.RequestID + req["response"] = params.Response } - raw, err := a.client.Request("session.plan.update", req) + raw, err := a.client.Request(ctx, "session.ui.handlePendingSessionLimitsExhausted", req) if err != nil { return nil, err } - var result SessionPlanUpdateResult + var result UIHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: PluginsApi contains experimental APIs that may change or be removed. -type PluginsApi sessionApi - -// Lists plugins installed for the session. +// HandlePendingUserInput resolves a pending `user_input.requested` event with the user's +// response. // -// RPC method: session.plugins.list. +// RPC method: session.ui.handlePendingUserInput. // -// Returns: Plugins installed for the session, with their enabled state and version metadata. -func (a *PluginsApi) List(ctx context.Context) (*PluginList, error) { +// Parameters: Request ID of a pending `user_input.requested` event and the user's response. +// +// Returns: Indicates whether the pending UI request was resolved by this call. +func (a *UIAPI) HandlePendingUserInput(ctx context.Context, params *UIHandlePendingUserInputRequest) (*UIHandlePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.plugins.list", req) + if params != nil { + req["requestId"] = params.RequestID + req["response"] = params.Response + } + raw, err := a.client.Request(ctx, "session.ui.handlePendingUserInput", req) if err != nil { return nil, err } - var result PluginList + var result UIHandlePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: QueueApi contains experimental APIs that may change or be removed. -type QueueApi sessionApi - -// Clears all pending queued items on the local session. +// RegisterDirectAutoModeSwitchHandler registers an in-process handler for auto-mode-switch +// requests so the server bridge skips dispatch. // -// RPC method: session.queue.clear. -func (a *QueueApi) Clear(ctx context.Context) (*SessionQueueClearResult, error) { +// RPC method: session.ui.registerDirectAutoModeSwitchHandler. +// +// Returns: Register an in-process handler for `auto_mode_switch.requested` events. The +// caller still attaches the actual listener via the standard event-subscription mechanism; +// this registration solely tells the server bridge to skip its own dispatch (so a remote +// client doesn't race the in-process handler for the same requestId). +func (a *UIAPI) RegisterDirectAutoModeSwitchHandler(ctx context.Context) (*UIRegisterDirectAutoModeSwitchHandlerResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.queue.clear", req) + raw, err := a.client.Request(ctx, "session.ui.registerDirectAutoModeSwitchHandler", req) if err != nil { return nil, err } - var result SessionQueueClearResult + var result UIRegisterDirectAutoModeSwitchHandlerResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// PendingItems returns the local session's pending user-facing queued items and steering -// messages. +// UnregisterDirectAutoModeSwitchHandler unregisters a previously-registered in-process +// auto-mode-switch handler by its opaque handle. // -// RPC method: session.queue.pendingItems. +// RPC method: session.ui.unregisterDirectAutoModeSwitchHandler. // -// Returns: Snapshot of the session's pending queued items and immediate-steering messages. -func (a *QueueApi) PendingItems(ctx context.Context) (*QueuePendingItemsResult, error) { +// Parameters: Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to +// release. +// +// Returns: Indicates whether the handle was active and the registration count was +// decremented. +func (a *UIAPI) UnregisterDirectAutoModeSwitchHandler(ctx context.Context, params *UIUnregisterDirectAutoModeSwitchHandlerRequest) (*UIUnregisterDirectAutoModeSwitchHandlerResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.queue.pendingItems", req) + if params != nil { + req["handle"] = params.Handle + } + raw, err := a.client.Request(ctx, "session.ui.unregisterDirectAutoModeSwitchHandler", req) if err != nil { return nil, err } - var result QueuePendingItemsResult + var result UIUnregisterDirectAutoModeSwitchHandlerResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RemoveMostRecent removes the most recently queued user-facing item (LIFO). +// Experimental: UsageAPI contains experimental APIs that may change or be removed. +type UsageAPI sessionAPI + +// GetMetrics gets accumulated usage metrics for the session. // -// RPC method: session.queue.removeMostRecent. +// RPC method: session.usage.getMetrics. // -// Returns: Indicates whether a user-facing pending item was removed. -func (a *QueueApi) RemoveMostRecent(ctx context.Context) (*QueueRemoveMostRecentResult, error) { +// Returns: Accumulated session usage metrics, including premium request cost, token counts, +// model breakdown, and code-change totals. +func (a *UsageAPI) GetMetrics(ctx context.Context) (*UsageGetMetricsResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.queue.removeMostRecent", req) + raw, err := a.client.Request(ctx, "session.usage.getMetrics", req) if err != nil { return nil, err } - var result QueueRemoveMostRecentResult + var result UsageGetMetricsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: RemoteApi contains experimental APIs that may change or be removed. -type RemoteApi sessionApi +// Experimental: VisibilityAPI contains experimental APIs that may change or be removed. +type VisibilityAPI sessionAPI -// Disables remote session export and steering. +// Get returns the session's current Mission Control sharing status and shareable GitHub +// URL. Reflects whether the synced session is visible to repository readers ("repo") or +// restricted to its creator and collaborators ("unshared"). // -// RPC method: session.remote.disable. -func (a *RemoteApi) Disable(ctx context.Context) (*SessionRemoteDisableResult, error) { +// RPC method: session.visibility.get. +// +// Returns: Current sharing status and shareable GitHub URL for a session. +func (a *VisibilityAPI) Get(ctx context.Context) (*VisibilityGetResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.remote.disable", req) + raw, err := a.client.Request(ctx, "session.visibility.get", req) if err != nil { return nil, err } - var result SessionRemoteDisableResult + var result VisibilityGetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Enables remote session export or steering. +// Sets the session's Mission Control sharing status, controlling whether the synced session +// is visible to repository readers. Returns the effective status and shareable GitHub URL +// after the change. // -// RPC method: session.remote.enable. +// RPC method: session.visibility.set. // -// Parameters: Optional remote session mode ("off", "export", or "on"); defaults to enabling -// both export and remote steering. +// Parameters: Desired sharing status for the session. // -// Returns: GitHub URL for the session and a flag indicating whether remote steering is -// enabled. -func (a *RemoteApi) Enable(ctx context.Context, params *RemoteEnableRequest) (*RemoteEnableResult, error) { +// Returns: Effective sharing status and shareable GitHub URL after updating session +// visibility. +func (a *VisibilityAPI) Set(ctx context.Context, params *VisibilitySetRequest) (*VisibilitySetResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.Mode != nil { - req["mode"] = *params.Mode - } + req["status"] = params.Status } - raw, err := a.client.Request("session.remote.enable", req) + raw, err := a.client.Request(ctx, "session.visibility.set", req) if err != nil { return nil, err } - var result RemoteEnableResult + var result VisibilitySetResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// NotifySteerableChanged persists a remote-steerability change emitted by the host as a -// session event. +// Experimental: WorkspacesAPI contains experimental APIs that may change or be removed. +type WorkspacesAPI sessionAPI + +// AddSummary adds a compaction summary checkpoint to the local session workspace. // -// RPC method: session.remote.notifySteerableChanged. +// RPC method: session.workspaces.addSummary. // -// Parameters: New remote-steerability state to persist as a -// `session.remote_steerable_changed` event. +// Parameters: Compaction summary checkpoint to persist. // -// Returns: Persist a steerability change as a `session.remote_steerable_changed` event. -// Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling -// steering on a remote exporter that the runtime does not directly own. -func (a *RemoteApi) NotifySteerableChanged(ctx context.Context, params *RemoteNotifySteerableChangedRequest) (*RemoteNotifySteerableChangedResult, error) { +// Returns: Persisted summary metadata and refreshed workspace metadata. +func (a *WorkspacesAPI) AddSummary(ctx context.Context, params *WorkspacesAddSummaryRequest) (*WorkspacesAddSummaryResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["remoteSteerable"] = params.RemoteSteerable + req["content"] = params.Content + req["title"] = params.Title } - raw, err := a.client.Request("session.remote.notifySteerableChanged", req) + raw, err := a.client.Request(ctx, "session.workspaces.addSummary", req) if err != nil { return nil, err } - var result RemoteNotifySteerableChangedResult + var result WorkspacesAddSummaryResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ScheduleApi contains experimental APIs that may change or be removed. -type ScheduleApi sessionApi - -// Lists the session's currently active scheduled prompts. +// AutopilotObjectiveExists checks whether the local session workspace has an autopilot +// objective state file. // -// RPC method: session.schedule.list. +// RPC method: session.workspaces.autopilotObjectiveExists. // -// Returns: Snapshot of the currently active recurring prompts for this session. -func (a *ScheduleApi) List(ctx context.Context) (*ScheduleList, error) { +// Returns: Whether the autopilot objective file exists. +func (a *WorkspacesAPI) AutopilotObjectiveExists(ctx context.Context) (*WorkspacesAutopilotObjectiveExistsResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.schedule.list", req) + raw, err := a.client.Request(ctx, "session.workspaces.autopilotObjectiveExists", req) if err != nil { return nil, err } - var result ScheduleList + var result WorkspacesAutopilotObjectiveExistsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Stop removes a scheduled prompt by id. -// -// RPC method: session.schedule.stop. +// CreateFile creates or overwrites a file in the session workspace files directory. // -// Parameters: Identifier of the scheduled prompt to remove. +// RPC method: session.workspaces.createFile. // -// Returns: Remove a scheduled prompt by id. The result entry is omitted if the id was -// unknown. -func (a *ScheduleApi) Stop(ctx context.Context, params *ScheduleStopRequest) (*ScheduleStopResult, error) { +// Parameters: Relative path and UTF-8 content for the workspace file to create or overwrite. +func (a *WorkspacesAPI) CreateFile(ctx context.Context, params *WorkspacesCreateFileRequest) (*SessionWorkspacesCreateFileResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID + req["content"] = params.Content + req["path"] = params.Path } - raw, err := a.client.Request("session.schedule.stop", req) + raw, err := a.client.Request(ctx, "session.workspaces.createFile", req) if err != nil { return nil, err } - var result ScheduleStopResult + var result SessionWorkspacesCreateFileResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ShellApi contains experimental APIs that may change or be removed. -type ShellApi sessionApi - -// Exec starts a shell command and streams output through session notifications. -// -// RPC method: session.shell.exec. +// DeleteAutopilotObjective deletes the autopilot objective state file from the local +// session workspace. // -// Parameters: Shell command to run, with optional working directory and timeout in -// milliseconds. +// RPC method: session.workspaces.deleteAutopilotObjective. // -// Returns: Identifier of the spawned process, used to correlate streamed output and exit -// notifications. -func (a *ShellApi) Exec(ctx context.Context, params *ShellExecRequest) (*ShellExecResult, error) { +// Returns: Result of deleting the autopilot objective file. +func (a *WorkspacesAPI) DeleteAutopilotObjective(ctx context.Context) (*WorkspacesDeleteAutopilotObjectiveResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["command"] = params.Command - if params.Cwd != nil { - req["cwd"] = *params.Cwd - } - if params.Timeout != nil { - req["timeout"] = *params.Timeout - } - } - raw, err := a.client.Request("session.shell.exec", req) + raw, err := a.client.Request(ctx, "session.workspaces.deleteAutopilotObjective", req) if err != nil { return nil, err } - var result ShellExecResult + var result WorkspacesDeleteAutopilotObjectiveResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Kill sends a signal to a shell process previously started via "shell.exec". +// Diff computes a diff for the session workspace. Never rejects for a busy session: a +// `session`-mode diff that cannot read the session's file-change captures falls back to an +// unstaged git diff with `isFallback: true` and reports why in `unavailableReason`. // -// RPC method: session.shell.kill. +// RPC method: session.workspaces.diff. // -// Parameters: Identifier of a process previously returned by "shell.exec" and the signal to -// send. +// Parameters: Parameters for computing a workspace diff. // -// Returns: Indicates whether the signal was delivered; false if the process was unknown or -// already exited. -func (a *ShellApi) Kill(ctx context.Context, params *ShellKillRequest) (*ShellKillResult, error) { +// Returns: Workspace diff result for the requested mode. +func (a *WorkspacesAPI) Diff(ctx context.Context, params *WorkspacesDiffRequest) (*WorkspaceDiffResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["processId"] = params.ProcessID - if params.Signal != nil { - req["signal"] = *params.Signal + if params.IgnoreWhitespace != nil { + req["ignoreWhitespace"] = *params.IgnoreWhitespace } + req["mode"] = params.Mode } - raw, err := a.client.Request("session.shell.kill", req) + raw, err := a.client.Request(ctx, "session.workspaces.diff", req) if err != nil { return nil, err } - var result ShellKillResult + var result WorkspaceDiffResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: SkillsApi contains experimental APIs that may change or be removed. -type SkillsApi sessionApi - -// Disables a skill for the session. -// -// RPC method: session.skills.disable. +// Ensures a local session workspace exists and returns it. // -// Parameters: Name of the skill to disable for the session. -func (a *SkillsApi) Disable(ctx context.Context, params *SkillsDisableRequest) (*SessionSkillsDisableResult, error) { - req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["name"] = params.Name - } - raw, err := a.client.Request("session.skills.disable", req) - if err != nil { - return nil, err - } - var result SessionSkillsDisableResult - if err := json.Unmarshal(raw, &result); err != nil { - return nil, err - } - return &result, nil -} - -// Enables a skill for the session. +// RPC method: session.workspaces.ensure. // -// RPC method: session.skills.enable. +// Parameters: Optional session context used when creating a local workspace. // -// Parameters: Name of the skill to enable for the session. -func (a *SkillsApi) Enable(ctx context.Context, params *SkillsEnableRequest) (*SessionSkillsEnableResult, error) { +// Returns: Current workspace metadata for the session, including its absolute filesystem +// path when available. +func (a *WorkspacesAPI) Ensure(ctx context.Context, params *WorkspacesEnsureRequest) (*WorkspacesGetWorkspaceResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["name"] = params.Name + if params.Context != nil { + req["context"] = params.Context + } } - raw, err := a.client.Request("session.skills.enable", req) + raw, err := a.client.Request(ctx, "session.workspaces.ensure", req) if err != nil { return nil, err } - var result SessionSkillsEnableResult + var result WorkspacesGetWorkspaceResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// EnsureLoaded ensures the session's skill definitions have been loaded from disk. +// GetWorkspace gets current workspace metadata for the session. // -// RPC method: session.skills.ensureLoaded. -func (a *SkillsApi) EnsureLoaded(ctx context.Context) (*SessionSkillsEnsureLoadedResult, error) { +// RPC method: session.workspaces.getWorkspace. +// +// Returns: Current workspace metadata for the session, including its absolute filesystem +// path when available. +func (a *WorkspacesAPI) GetWorkspace(ctx context.Context) (*WorkspacesGetWorkspaceResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.skills.ensureLoaded", req) + raw, err := a.client.Request(ctx, "session.workspaces.getWorkspace", req) if err != nil { return nil, err } - var result SessionSkillsEnsureLoadedResult + var result WorkspacesGetWorkspaceResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetInvoked returns the skills that have been invoked during this session. +// ListCheckpoints lists workspace checkpoints in chronological order. // -// RPC method: session.skills.getInvoked. +// RPC method: session.workspaces.listCheckpoints. // -// Returns: Skills invoked during this session, ordered by invocation time (most recent -// last). -func (a *SkillsApi) GetInvoked(ctx context.Context) (*SkillsGetInvokedResult, error) { +// Returns: Workspace checkpoints in chronological order; empty when the workspace is not +// enabled. +func (a *WorkspacesAPI) ListCheckpoints(ctx context.Context) (*WorkspacesListCheckpointsResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.skills.getInvoked", req) + raw, err := a.client.Request(ctx, "session.workspaces.listCheckpoints", req) if err != nil { return nil, err } - var result SkillsGetInvokedResult + var result WorkspacesListCheckpointsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists skills available to the session. +// ListFiles lists files stored in the session workspace files directory. // -// RPC method: session.skills.list. +// RPC method: session.workspaces.listFiles. // -// Returns: Skills available to the session, with their enabled state. -func (a *SkillsApi) List(ctx context.Context) (*SkillList, error) { +// Returns: Relative paths of files stored in the session workspace files directory. +func (a *WorkspacesAPI) ListFiles(ctx context.Context) (*WorkspacesListFilesResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.skills.list", req) + raw, err := a.client.Request(ctx, "session.workspaces.listFiles", req) if err != nil { return nil, err } - var result SkillList + var result WorkspacesListFilesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Reloads skill definitions for the session. +// ReadAutopilotObjective reads the autopilot objective state file from the local session +// workspace. // -// RPC method: session.skills.reload. +// RPC method: session.workspaces.readAutopilotObjective. // -// Returns: Diagnostics from reloading skill definitions, with warnings and errors as -// separate lists. -func (a *SkillsApi) Reload(ctx context.Context) (*SkillsLoadDiagnostics, error) { +// Returns: Autopilot objective file content, or null when missing. +func (a *WorkspacesAPI) ReadAutopilotObjective(ctx context.Context) (*WorkspacesReadAutopilotObjectiveResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.skills.reload", req) + raw, err := a.client.Request(ctx, "session.workspaces.readAutopilotObjective", req) if err != nil { return nil, err } - var result SkillsLoadDiagnostics + var result WorkspacesReadAutopilotObjectiveResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: TasksApi contains experimental APIs that may change or be removed. -type TasksApi sessionApi - -// Cancels a background task. +// ReadCheckpoint reads the content of a workspace checkpoint by number. // -// RPC method: session.tasks.cancel. +// RPC method: session.workspaces.readCheckpoint. // -// Parameters: Identifier of the background task to cancel. +// Parameters: Checkpoint number to read. // -// Returns: Indicates whether the background task was successfully cancelled. -func (a *TasksApi) Cancel(ctx context.Context, params *TasksCancelRequest) (*TasksCancelResult, error) { +// Returns: Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace +// is missing. +func (a *WorkspacesAPI) ReadCheckpoint(ctx context.Context, params *WorkspacesReadCheckpointRequest) (*WorkspacesReadCheckpointResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID - } - raw, err := a.client.Request("session.tasks.cancel", req) - if err != nil { - return nil, err - } - var result TasksCancelResult - if err := json.Unmarshal(raw, &result); err != nil { - return nil, err + req["number"] = params.Number } - return &result, nil -} - -// GetCurrentPromotable returns the first sync-waiting task that can currently be promoted -// to background mode. -// -// RPC method: session.tasks.getCurrentPromotable. -// -// Returns: The first sync-waiting task that can currently be promoted to background mode. -func (a *TasksApi) GetCurrentPromotable(ctx context.Context) (*TasksGetCurrentPromotableResult, error) { - req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tasks.getCurrentPromotable", req) + raw, err := a.client.Request(ctx, "session.workspaces.readCheckpoint", req) if err != nil { return nil, err } - var result TasksGetCurrentPromotableResult + var result WorkspacesReadCheckpointResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetProgress returns progress information for a background task by ID. +// ReadFile reads a file from the session workspace files directory. // -// RPC method: session.tasks.getProgress. +// RPC method: session.workspaces.readFile. // -// Parameters: Identifier of the background task to fetch progress for. +// Parameters: Relative path of the workspace file to read. // -// Returns: Progress information for the task, or null when no task with that ID is tracked. -func (a *TasksApi) GetProgress(ctx context.Context, params *TasksGetProgressRequest) (*TasksGetProgressResult, error) { +// Returns: Contents of the requested workspace file as a UTF-8 string. +func (a *WorkspacesAPI) ReadFile(ctx context.Context, params *WorkspacesReadFileRequest) (*WorkspacesReadFileResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID + req["path"] = params.Path } - raw, err := a.client.Request("session.tasks.getProgress", req) + raw, err := a.client.Request(ctx, "session.workspaces.readFile", req) if err != nil { return nil, err } - var result TasksGetProgressResult + var result WorkspacesReadFileResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Lists background tasks tracked by the session. +// SaveLargePaste saves pasted content as a UTF-8 file in the session workspace. // -// RPC method: session.tasks.list. +// RPC method: session.workspaces.saveLargePaste. // -// Returns: Background tasks currently tracked by the session. -func (a *TasksApi) List(ctx context.Context) (*TaskList, error) { +// Parameters: Pasted content to save as a UTF-8 file in the session workspace. +// +// Returns: Descriptor for the saved paste file, or null when the workspace is unavailable. +func (a *WorkspacesAPI) SaveLargePaste(ctx context.Context, params *WorkspacesSaveLargePasteRequest) (*WorkspacesSaveLargePasteResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tasks.list", req) + if params != nil { + req["content"] = params.Content + } + raw, err := a.client.Request(ctx, "session.workspaces.saveLargePaste", req) if err != nil { return nil, err } - var result TaskList + var result WorkspacesSaveLargePasteResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// PromoteCurrentToBackground atomically promotes the first promotable sync-waiting task to -// background mode and returns it. +// TruncateSummaries truncates local workspace compaction summaries after a rollback. // -// RPC method: session.tasks.promoteCurrentToBackground. +// RPC method: session.workspaces.truncateSummaries. // -// Returns: The promoted task as it now exists in background mode, omitted if no promotable -// task was waiting. -func (a *TasksApi) PromoteCurrentToBackground(ctx context.Context) (*TasksPromoteCurrentToBackgroundResult, error) { +// Parameters: Rollback point for local workspace summaries. +// +// Returns: Current workspace metadata for the session, including its absolute filesystem +// path when available. +func (a *WorkspacesAPI) TruncateSummaries(ctx context.Context, params *WorkspacesTruncateSummariesRequest) (*WorkspacesGetWorkspaceResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tasks.promoteCurrentToBackground", req) + if params != nil { + req["keepCount"] = params.KeepCount + } + raw, err := a.client.Request(ctx, "session.workspaces.truncateSummaries", req) if err != nil { return nil, err } - var result TasksPromoteCurrentToBackgroundResult + var result WorkspacesGetWorkspaceResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// PromoteToBackground promotes an eligible synchronously-waited task so it continues -// running in the background. +// UpdateMetadata updates workspace metadata for a local session and returns the refreshed +// workspace. // -// RPC method: session.tasks.promoteToBackground. +// RPC method: session.workspaces.updateMetadata. // -// Parameters: Identifier of the task to promote to background mode. +// Parameters: Workspace metadata fields to update. // -// Returns: Indicates whether the task was successfully promoted to background mode. -func (a *TasksApi) PromoteToBackground(ctx context.Context, params *TasksPromoteToBackgroundRequest) (*TasksPromoteToBackgroundResult, error) { +// Returns: Current workspace metadata for the session, including its absolute filesystem +// path when available. +func (a *WorkspacesAPI) UpdateMetadata(ctx context.Context, params *WorkspacesUpdateMetadataRequest) (*WorkspacesGetWorkspaceResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["id"] = params.ID + if params.Context != nil { + req["context"] = params.Context + } + if params.Name != nil { + req["name"] = *params.Name + } } - raw, err := a.client.Request("session.tasks.promoteToBackground", req) + raw, err := a.client.Request(ctx, "session.workspaces.updateMetadata", req) if err != nil { return nil, err } - var result TasksPromoteToBackgroundResult + var result WorkspacesGetWorkspaceResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Refreshes metadata for any detached background shells the runtime knows about. +// WriteAutopilotObjective writes the autopilot objective state file in the local session +// workspace. // -// RPC method: session.tasks.refresh. +// RPC method: session.workspaces.writeAutopilotObjective. // -// Returns: Refresh metadata for any detached background shells the runtime knows about. Use -// after a long pause to pick up exit/output state for shells running outside the agent loop. -func (a *TasksApi) Refresh(ctx context.Context) (*TasksRefreshResult, error) { +// Parameters: Autopilot objective file content to persist. +// +// Returns: Result of writing the autopilot objective file. +func (a *WorkspacesAPI) WriteAutopilotObjective(ctx context.Context, params *WorkspacesWriteAutopilotObjectiveRequest) (*WorkspacesWriteAutopilotObjectiveResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tasks.refresh", req) + if params != nil { + req["content"] = params.Content + } + raw, err := a.client.Request(ctx, "session.workspaces.writeAutopilotObjective", req) if err != nil { return nil, err } - var result TasksRefreshResult + var result WorkspacesWriteAutopilotObjectiveResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Removes a completed or cancelled background task from tracking. +// SessionRPC provides typed session-scoped RPC methods. +type SessionRPC struct { + // Reuse a single struct instead of allocating one for each service on the heap. + common sessionAPI + + Agent *AgentAPI + Canvas *CanvasAPI + Commands *CommandsAPI + Completions *CompletionsAPI + ContentExclusion *ContentExclusionAPI + Debug *DebugAPI + EventLog *EventLogAPI + Extensions *ExtensionsAPI + Factory *FactoryAPI + Fleet *FleetAPI + GitHubAuth *GitHubAuthAPI + History *HistoryAPI + Instructions *InstructionsAPI + LimitPrediction *LimitPredictionAPI + Lsp *LspAPI + MCP *MCPAPI + Metadata *MetadataAPI + Mode *ModeAPI + Model *ModelAPI + Name *NameAPI + Options *OptionsAPI + Permissions *PermissionsAPI + Plan *PlanAPI + Plugins *PluginsAPI + Provider *ProviderAPI + Queue *QueueAPI + Remote *RemoteAPI + Schedule *ScheduleAPI + Shell *ShellAPI + Skills *SkillsAPI + Tasks *TasksAPI + Telemetry *TelemetryAPI + Tools *ToolsAPI + UI *UIAPI + Usage *UsageAPI + Visibility *VisibilityAPI + Workspaces *WorkspacesAPI +} + +// Aborts the current agent turn. // -// RPC method: session.tasks.remove. +// RPC method: session.abort. // -// Parameters: Identifier of the completed or cancelled task to remove from tracking. +// Parameters: Parameters for aborting the current turn // -// Returns: Indicates whether the task was removed. False when the task does not exist or is -// still running/idle. -func (a *TasksApi) Remove(ctx context.Context, params *TasksRemoveRequest) (*TasksRemoveResult, error) { - req := map[string]any{"sessionId": a.sessionID} +// Returns: Result of aborting the current turn +// Experimental: Abort is an experimental API and may change or be removed in future +// versions. +func (a *SessionRPC) Abort(ctx context.Context, params *AbortRequest) (*AbortResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} if params != nil { - req["id"] = params.ID + if params.Reason != nil { + req["reason"] = *params.Reason + } } - raw, err := a.client.Request("session.tasks.remove", req) + raw, err := a.common.client.Request(ctx, "session.abort", req) if err != nil { return nil, err } - var result TasksRemoveResult + var result AbortResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SendMessage sends a message to a background agent task. -// -// RPC method: session.tasks.sendMessage. +// CancelAllBackgroundAgents cancels every running background agent (task-registry subagents +// plus sidekick agents) without interrupting the main agent loop. Promoted attached shells +// are left running. // -// Parameters: Identifier of the target agent task, message content, and optional sender -// agent ID. +// RPC method: session.cancelAllBackgroundAgents. // -// Returns: Indicates whether the message was delivered, with an error message when delivery -// failed. -func (a *TasksApi) SendMessage(ctx context.Context, params *TasksSendMessageRequest) (*TasksSendMessageResult, error) { - req := map[string]any{"sessionId": a.sessionID} - if params != nil { - if params.FromAgentID != nil { - req["fromAgentId"] = *params.FromAgentID - } - req["id"] = params.ID - req["message"] = params.Message - } - raw, err := a.client.Request("session.tasks.sendMessage", req) +// Returns: The number of running background agents (task-registry agents) that were +// cancelled. +// Experimental: CancelAllBackgroundAgents is an experimental API and may change or be +// removed in future versions. +func (a *SessionRPC) CancelAllBackgroundAgents(ctx context.Context) (*SessionCancelAllBackgroundAgentsResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} + raw, err := a.common.client.Request(ctx, "session.cancelAllBackgroundAgents", req) if err != nil { return nil, err } - var result TasksSendMessageResult + var result SessionCancelAllBackgroundAgentsResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// StartAgent starts a background agent task in the session. +// InterruptMainTurn interrupts the current main agent turn while leaving running background +// work (subagents, sidekicks, and promoted attached shells) alive. No-op when the main loop +// is not processing. // -// RPC method: session.tasks.startAgent. +// RPC method: session.interruptMainTurn. // -// Parameters: Agent type, prompt, name, and optional description and model override for the -// new task. +// Parameters: Parameters for interrupting the main agent turn. // -// Returns: Identifier assigned to the newly started background agent task. -func (a *TasksApi) StartAgent(ctx context.Context, params *TasksStartAgentRequest) (*TasksStartAgentResult, error) { - req := map[string]any{"sessionId": a.sessionID} +// Returns: Result of interrupting the main agent turn. +// Experimental: InterruptMainTurn is an experimental API and may change or be removed in +// future versions. +func (a *SessionRPC) InterruptMainTurn(ctx context.Context, params *InterruptMainTurnRequest) (*InterruptMainTurnResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} if params != nil { - req["agentType"] = params.AgentType - if params.Description != nil { - req["description"] = *params.Description - } - if params.Model != nil { - req["model"] = *params.Model + if params.FlushQueued != nil { + req["flushQueued"] = *params.FlushQueued } - req["name"] = params.Name - req["prompt"] = params.Prompt } - raw, err := a.client.Request("session.tasks.startAgent", req) + raw, err := a.common.client.Request(ctx, "session.interruptMainTurn", req) if err != nil { return nil, err } - var result TasksStartAgentResult + var result InterruptMainTurnResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// WaitForPending waits for all in-flight background tasks and any follow-up turns to settle. +// Log emits a user-visible session log event. // -// RPC method: session.tasks.waitForPending. +// RPC method: session.log. // -// Returns: Wait until all in-flight background tasks (agents + shells) and any follow-up -// turns scheduled by their completions have settled. Returns when the runtime is fully -// drained or after an internal timeout (default 10 minutes; configurable via -// COPILOT_TASK_WAIT_TIMEOUT_SECONDS). -func (a *TasksApi) WaitForPending(ctx context.Context) (*TasksWaitForPendingResult, error) { - req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tasks.waitForPending", req) +// Parameters: Message text, optional severity level, persistence flag, optional follow-up +// URL, and optional tip. +// +// Returns: Identifier of the session event that was emitted for the log message. +// Experimental: Log is an experimental API and may change or be removed in future versions. +func (a *SessionRPC) Log(ctx context.Context, params *LogRequest) (*LogResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} + if params != nil { + if params.Ephemeral != nil { + req["ephemeral"] = *params.Ephemeral + } + if params.Level != nil { + req["level"] = *params.Level + } + req["message"] = params.Message + if params.Tip != nil { + req["tip"] = *params.Tip + } + if params.Type != nil { + req["type"] = *params.Type + } + if params.URL != nil { + req["url"] = *params.URL + } + } + raw, err := a.common.client.Request(ctx, "session.log", req) if err != nil { return nil, err } - var result TasksWaitForPendingResult + var result LogResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: TelemetryApi contains experimental APIs that may change or be removed. -type TelemetryApi sessionApi - -// SetFeatureOverrides sets feature override key/value pairs to attach to subsequent -// telemetry events for the session. +// Sends a user message to the session and returns its message ID. // -// RPC method: session.telemetry.setFeatureOverrides. +// RPC method: session.send. // -// Parameters: Feature override key/value pairs to attach to subsequent telemetry events -// from this session. -func (a *TelemetryApi) SetFeatureOverrides(ctx context.Context, params *TelemetrySetFeatureOverridesRequest) (*SessionTelemetrySetFeatureOverridesResult, error) { - req := map[string]any{"sessionId": a.sessionID} +// Parameters: Parameters for sending a user message to the session +// +// Returns: Result of sending a user message +// Experimental: Send is an experimental API and may change or be removed in future versions. +func (a *SessionRPC) Send(ctx context.Context, params *SendRequest) (*SendResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} if params != nil { - req["features"] = params.Features + if params.AgentMode != nil { + req["agentMode"] = *params.AgentMode + } + if params.Attachments != nil { + req["attachments"] = params.Attachments + } + if params.Billable != nil { + req["billable"] = *params.Billable + } + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + if params.Mode != nil { + req["mode"] = *params.Mode + } + if params.Prepend != nil { + req["prepend"] = *params.Prepend + } + req["prompt"] = params.Prompt + if params.RequestHeaders != nil { + req["requestHeaders"] = params.RequestHeaders + } + if params.RequiredTool != nil { + req["requiredTool"] = *params.RequiredTool + } + if params.Source != nil { + req["source"] = *params.Source + } + if params.Traceparent != nil { + req["traceparent"] = *params.Traceparent + } + if params.Tracestate != nil { + req["tracestate"] = *params.Tracestate + } + if params.Wait != nil { + req["wait"] = *params.Wait + } } - raw, err := a.client.Request("session.telemetry.setFeatureOverrides", req) + raw, err := a.common.client.Request(ctx, "session.send", req) if err != nil { return nil, err } - var result SessionTelemetrySetFeatureOverridesResult + var result SendResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: ToolsApi contains experimental APIs that may change or be removed. -type ToolsApi sessionApi - -// GetCurrentMetadata returns lightweight metadata for the session's currently initialized -// tools. +// SendMessages sends zero or more user messages to the session in a single turn and returns +// their message IDs. All provided messages are appended to the conversation in order, then +// exactly one agent turn runs over the resulting history. When the list is empty, one turn +// runs over the existing history with no new user message. Remote-backed (Mission Control) +// sessions do not support this method and will return an error. // -// RPC method: session.tools.getCurrentMetadata. +// RPC method: session.sendMessages. // -// Returns: Current lightweight tool metadata snapshot for the session. -func (a *ToolsApi) GetCurrentMetadata(ctx context.Context) (*ToolsGetCurrentMetadataResult, error) { - req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tools.getCurrentMetadata", req) +// Parameters: Parameters for sending zero or more user messages to the session in a single +// turn. Remote-backed (Mission Control) sessions do not support this method and will return +// an error. +// +// Returns: Result of sending zero or more user messages +// Experimental: SendMessages is an experimental API and may change or be removed in future +// versions. +func (a *SessionRPC) SendMessages(ctx context.Context, params *SendMessagesRequest) (*SendMessagesResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} + if params != nil { + if params.AgentMode != nil { + req["agentMode"] = *params.AgentMode + } + req["messages"] = params.Messages + if params.Mode != nil { + req["mode"] = *params.Mode + } + if params.Prepend != nil { + req["prepend"] = *params.Prepend + } + if params.RequestHeaders != nil { + req["requestHeaders"] = params.RequestHeaders + } + if params.Traceparent != nil { + req["traceparent"] = *params.Traceparent + } + if params.Tracestate != nil { + req["tracestate"] = *params.Tracestate + } + if params.Wait != nil { + req["wait"] = *params.Wait + } + } + raw, err := a.common.client.Request(ctx, "session.sendMessages", req) if err != nil { return nil, err } - var result ToolsGetCurrentMetadataResult + var result SendMessagesResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingToolCall provides the result for a pending external tool call. -// -// RPC method: session.tools.handlePendingToolCall. +// Shutdown shuts down the session and persists its final state. Awaits any deferred +// sessionEnd hooks before resolving so user-supplied hook scripts complete before the +// runtime tears down. // -// Parameters: Pending external tool call request ID, with the tool result or an error -// describing why it failed. +// RPC method: session.shutdown. // -// Returns: Indicates whether the external tool call result was handled successfully. -func (a *ToolsApi) HandlePendingToolCall(ctx context.Context, params *HandlePendingToolCallRequest) (*HandlePendingToolCallResult, error) { - req := map[string]any{"sessionId": a.sessionID} +// Parameters: Parameters for shutting down the session +// Experimental: Shutdown is an experimental API and may change or be removed in future +// versions. +func (a *SessionRPC) Shutdown(ctx context.Context, params *ShutdownRequest) (*SessionShutdownResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} if params != nil { - if params.Error != nil { - req["error"] = *params.Error - } - req["requestId"] = params.RequestID - if params.Result != nil { - req["result"] = params.Result + if params.Reason != nil { + req["reason"] = *params.Reason + } + if params.Type != nil { + req["type"] = *params.Type } } - raw, err := a.client.Request("session.tools.handlePendingToolCall", req) + raw, err := a.common.client.Request(ctx, "session.shutdown", req) if err != nil { return nil, err } - var result HandlePendingToolCallResult + var result SessionShutdownResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// InitializeAndValidate resolves, builds, and validates the runtime tool list for the -// session. -// -// RPC method: session.tools.initializeAndValidate. +// Suspends the session while preserving persisted state for later resume. // -// Returns: Resolve, build, and validate the runtime tool list for this session. Subagent -// sessions and consumer flows that need an initialized tool set before `send` invoke this. -// Default base-class implementation is a no-op for sessions that don't support tool -// validation. -func (a *ToolsApi) InitializeAndValidate(ctx context.Context) (*ToolsInitializeAndValidateResult, error) { - req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.tools.initializeAndValidate", req) +// RPC method: session.suspend. +// Experimental: Suspend is an experimental API and may change or be removed in future +// versions. +func (a *SessionRPC) Suspend(ctx context.Context) (*SessionSuspendResult, error) { + req := map[string]any{"sessionId": a.common.sessionID} + raw, err := a.common.client.Request(ctx, "session.suspend", req) if err != nil { return nil, err } - var result ToolsInitializeAndValidateResult + var result SessionSuspendResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: UIApi contains experimental APIs that may change or be removed. -type UIApi sessionApi +func NewSessionRPC(client *jsonrpc2.Client, sessionID string) *SessionRPC { + r := &SessionRPC{} + r.common = sessionAPI{client: client, sessionID: sessionID} + r.Agent = (*AgentAPI)(&r.common) + r.Canvas = (*CanvasAPI)(&r.common) + r.Commands = (*CommandsAPI)(&r.common) + r.Completions = (*CompletionsAPI)(&r.common) + r.ContentExclusion = (*ContentExclusionAPI)(&r.common) + r.Debug = (*DebugAPI)(&r.common) + r.EventLog = (*EventLogAPI)(&r.common) + r.Extensions = (*ExtensionsAPI)(&r.common) + r.Factory = (*FactoryAPI)(&r.common) + r.Fleet = (*FleetAPI)(&r.common) + r.GitHubAuth = (*GitHubAuthAPI)(&r.common) + r.History = (*HistoryAPI)(&r.common) + r.Instructions = (*InstructionsAPI)(&r.common) + r.LimitPrediction = (*LimitPredictionAPI)(&r.common) + r.Lsp = (*LspAPI)(&r.common) + r.MCP = (*MCPAPI)(&r.common) + r.Metadata = (*MetadataAPI)(&r.common) + r.Mode = (*ModeAPI)(&r.common) + r.Model = (*ModelAPI)(&r.common) + r.Name = (*NameAPI)(&r.common) + r.Options = (*OptionsAPI)(&r.common) + r.Permissions = (*PermissionsAPI)(&r.common) + r.Plan = (*PlanAPI)(&r.common) + r.Plugins = (*PluginsAPI)(&r.common) + r.Provider = (*ProviderAPI)(&r.common) + r.Queue = (*QueueAPI)(&r.common) + r.Remote = (*RemoteAPI)(&r.common) + r.Schedule = (*ScheduleAPI)(&r.common) + r.Shell = (*ShellAPI)(&r.common) + r.Skills = (*SkillsAPI)(&r.common) + r.Tasks = (*TasksAPI)(&r.common) + r.Telemetry = (*TelemetryAPI)(&r.common) + r.Tools = (*ToolsAPI)(&r.common) + r.UI = (*UIAPI)(&r.common) + r.Usage = (*UsageAPI)(&r.common) + r.Visibility = (*VisibilityAPI)(&r.common) + r.Workspaces = (*WorkspacesAPI)(&r.common) + return r +} + +type internalSessionAPI struct { + client *jsonrpc2.Client + sessionID string +} + +// Experimental: InternalMCPAPI contains experimental APIs that may change or be removed. +type InternalMCPAPI internalSessionAPI -// Elicitation requests structured input from a UI-capable client. +// ConfigureGitHub configures the built-in GitHub MCP server for the session's current auth +// context. // -// RPC method: session.ui.elicitation. +// RPC method: session.mcp.configureGitHub. // -// Parameters: Prompt message and JSON schema describing the form fields to elicit from the -// user. +// Parameters: Opaque auth info used to configure GitHub MCP. // -// Returns: The elicitation response (accept with form values, decline, or cancel) -func (a *UIApi) Elicitation(ctx context.Context, params *UIElicitationRequest) (*UIElicitationResponse, error) { +// Returns: Result of configuring GitHub MCP. +// Internal: ConfigureGitHub is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalMCPAPI) ConfigureGitHub(ctx context.Context, params *MCPConfigureGitHubRequest) (*MCPConfigureGitHubResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["message"] = params.Message - req["requestedSchema"] = params.RequestedSchema + req["authInfo"] = params.AuthInfo } - raw, err := a.client.Request("session.ui.elicitation", req) + raw, err := a.client.Request(ctx, "session.mcp.configureGitHub", req) if err != nil { return nil, err } - var result UIElicitationResponse + var result MCPConfigureGitHubResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingAutoModeSwitch resolves a pending `auto_mode_switch.requested` event with -// the user's accept/decline decision. +// RegisterExternalClient registers a pre-connected external MCP client (e.g. IDE) on the +// session's host. The caller retains lifecycle ownership of the client and transport. +// Marked internal because the `client` and `transport` arguments are in-process MCP SDK +// instances that cannot be serialized across the JSON-RPC boundary; once the CLI moves on +// top of the SDK, external clients will be expressed as transport configs the runtime can +// construct itself. // -// RPC method: session.ui.handlePendingAutoModeSwitch. -// -// Parameters: Request ID of a pending `auto_mode_switch.requested` event and the user's -// response. +// RPC method: session.mcp.registerExternalClient. // -// Returns: Indicates whether the pending UI request was resolved by this call. -func (a *UIApi) HandlePendingAutoModeSwitch(ctx context.Context, params *UIHandlePendingAutoModeSwitchRequest) (*UIHandlePendingResult, error) { +// Parameters: Registration parameters for an external MCP client. +// Internal: RegisterExternalClient is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalMCPAPI) RegisterExternalClient(ctx context.Context, params *MCPRegisterExternalClientRequest) (*SessionMCPRegisterExternalClientResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["response"] = params.Response + req["client"] = params.Client + req["config"] = params.Config + req["serverName"] = params.ServerName + req["transport"] = params.Transport } - raw, err := a.client.Request("session.ui.handlePendingAutoModeSwitch", req) + raw, err := a.client.Request(ctx, "session.mcp.registerExternalClient", req) if err != nil { return nil, err } - var result UIHandlePendingResult + var result SessionMCPRegisterExternalClientResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingElicitation provides the user response for a pending elicitation request. +// ReloadWithConfig reloads MCP server connections for the session with an explicit +// host-provided configuration. // -// RPC method: session.ui.handlePendingElicitation. +// RPC method: session.mcp.reloadWithConfig. // -// Parameters: Pending elicitation request ID and the user's response (accept/decline/cancel -// + form values). +// Parameters: Opaque MCP reload configuration. // -// Returns: Indicates whether the elicitation response was accepted; false if it was already -// resolved by another client. -func (a *UIApi) HandlePendingElicitation(ctx context.Context, params *UIHandlePendingElicitationRequest) (*UIElicitationResult, error) { +// Returns: MCP server startup filtering result. +// Internal: ReloadWithConfig is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalMCPAPI) ReloadWithConfig(ctx context.Context, params *MCPReloadWithConfigRequest) (*MCPStartServersResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["result"] = params.Result + req["config"] = params.Config } - raw, err := a.client.Request("session.ui.handlePendingElicitation", req) + raw, err := a.client.Request(ctx, "session.mcp.reloadWithConfig", req) if err != nil { return nil, err } - var result UIElicitationResult + var result MCPStartServersResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingExitPlanMode resolves a pending `exit_plan_mode.requested` event with the -// user's response. +// UnregisterExternalClient unregisters a previously registered external MCP client by +// server name. Marked internal as the paired companion of `registerExternalClient`: only +// in-process callers that registered a client this way can meaningfully unregister it. +// Disappears alongside `registerExternalClient`: once external clients are described to the +// runtime as config rather than handed in as instances, lifecycle (including +// deregistration) is owned entirely by the runtime. // -// RPC method: session.ui.handlePendingExitPlanMode. -// -// Parameters: Request ID of a pending `exit_plan_mode.requested` event and the user's -// response. +// RPC method: session.mcp.unregisterExternalClient. // -// Returns: Indicates whether the pending UI request was resolved by this call. -func (a *UIApi) HandlePendingExitPlanMode(ctx context.Context, params *UIHandlePendingExitPlanModeRequest) (*UIHandlePendingResult, error) { +// Parameters: Server name identifying the external client to remove. +// Internal: UnregisterExternalClient is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalMCPAPI) UnregisterExternalClient(ctx context.Context, params *MCPUnregisterExternalClientRequest) (*SessionMCPUnregisterExternalClientResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["response"] = params.Response + req["serverName"] = params.ServerName } - raw, err := a.client.Request("session.ui.handlePendingExitPlanMode", req) + raw, err := a.client.Request(ctx, "session.mcp.unregisterExternalClient", req) if err != nil { return nil, err } - var result UIHandlePendingResult + var result SessionMCPUnregisterExternalClientResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingSampling resolves a pending `sampling.requested` event with a sampling -// result, or rejects it. +// Experimental: InternalQueueAPI contains experimental APIs that may change or be removed. +type InternalQueueAPI internalSessionAPI + +// BeginDeferredIdleDrain begins a native deferred-idle drain when background work has +// quiesced. // -// RPC method: session.ui.handlePendingSampling. +// RPC method: session.queue.beginDeferredIdleDrain. // -// Parameters: Request ID of a pending `sampling.requested` event and an optional sampling -// result payload (omit to reject). +// Parameters: Inputs for starting a deferred-idle drain. // -// Returns: Indicates whether the pending UI request was resolved by this call. -func (a *UIApi) HandlePendingSampling(ctx context.Context, params *UIHandlePendingSamplingRequest) (*UIHandlePendingResult, error) { +// Returns: Whether a deferred-idle drain should run. +// Internal: BeginDeferredIdleDrain is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalQueueAPI) BeginDeferredIdleDrain(ctx context.Context, params *QueueBeginDeferredIdleDrainRequest) (*QueueBeginDeferredIdleDrainResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - if params.Response != nil { - req["response"] = *params.Response - } + req["activeBackgroundWork"] = params.ActiveBackgroundWork } - raw, err := a.client.Request("session.ui.handlePendingSampling", req) + raw, err := a.client.Request(ctx, "session.queue.beginDeferredIdleDrain", req) if err != nil { return nil, err } - var result UIHandlePendingResult + var result QueueBeginDeferredIdleDrainResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// HandlePendingUserInput resolves a pending `user_input.requested` event with the user's -// response. +// ConsumeSystemNotifications consumes queued native system notifications matching an +// internal filter. // -// RPC method: session.ui.handlePendingUserInput. +// RPC method: session.queue.consumeSystemNotifications. // -// Parameters: Request ID of a pending `user_input.requested` event and the user's response. +// Parameters: Internal filter for consuming queued system notifications. // -// Returns: Indicates whether the pending UI request was resolved by this call. -func (a *UIApi) HandlePendingUserInput(ctx context.Context, params *UIHandlePendingUserInputRequest) (*UIHandlePendingResult, error) { +// Returns: Indicates whether a user-facing pending item was removed. +// Internal: ConsumeSystemNotifications is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalQueueAPI) ConsumeSystemNotifications(ctx context.Context, params *QueueConsumeSystemNotificationsRequest) (*QueueRemoveMostRecentResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["requestId"] = params.RequestID - req["response"] = params.Response + req["filter"] = params.Filter } - raw, err := a.client.Request("session.ui.handlePendingUserInput", req) + raw, err := a.client.Request(ctx, "session.queue.consumeSystemNotifications", req) if err != nil { return nil, err } - var result UIHandlePendingResult + var result QueueRemoveMostRecentResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// RegisterDirectAutoModeSwitchHandler registers an in-process handler for auto-mode-switch -// requests so the server bridge skips dispatch. +// DeferSessionIdle marks session.idle as deferred by native background work state. // -// RPC method: session.ui.registerDirectAutoModeSwitchHandler. +// RPC method: session.queue.deferSessionIdle. // -// Returns: Register an in-process handler for `auto_mode_switch.requested` events. The -// caller still attaches the actual listener via the standard event-subscription mechanism; -// this registration solely tells the server bridge to skip its own dispatch (so a remote -// client doesn't race the in-process handler for the same requestId). -func (a *UIApi) RegisterDirectAutoModeSwitchHandler(ctx context.Context) (*UIRegisterDirectAutoModeSwitchHandlerResult, error) { +// Parameters: Inputs for marking session.idle deferred in native state. +// Internal: DeferSessionIdle is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalQueueAPI) DeferSessionIdle(ctx context.Context, params *QueueDeferSessionIdleRequest) (*SessionQueueDeferSessionIdleResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.ui.registerDirectAutoModeSwitchHandler", req) + if params != nil { + req["aborted"] = params.Aborted + } + raw, err := a.client.Request(ctx, "session.queue.deferSessionIdle", req) if err != nil { return nil, err } - var result UIRegisterDirectAutoModeSwitchHandlerResult + var result SessionQueueDeferSessionIdleResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// UnregisterDirectAutoModeSwitchHandler unregisters a previously-registered in-process -// auto-mode-switch handler by its opaque handle. -// -// RPC method: session.ui.unregisterDirectAutoModeSwitchHandler. +// EnqueueResumePending enqueues the internal resume-pending wake item when orphan handling +// needs a follow-up turn. // -// Parameters: Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to -// release. +// RPC method: session.queue.enqueueResumePending. // -// Returns: Indicates whether the handle was active and the registration count was -// decremented. -func (a *UIApi) UnregisterDirectAutoModeSwitchHandler(ctx context.Context, params *UIUnregisterDirectAutoModeSwitchHandlerRequest) (*UIUnregisterDirectAutoModeSwitchHandlerResult, error) { +// Returns: Result of enqueueing the resume-pending wake item. +// Internal: EnqueueResumePending is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalQueueAPI) EnqueueResumePending(ctx context.Context) (*QueueEnqueueResumePendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["handle"] = params.Handle - } - raw, err := a.client.Request("session.ui.unregisterDirectAutoModeSwitchHandler", req) + raw, err := a.client.Request(ctx, "session.queue.enqueueResumePending", req) if err != nil { return nil, err } - var result UIUnregisterDirectAutoModeSwitchHandlerResult + var result QueueEnqueueResumePendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: UsageApi contains experimental APIs that may change or be removed. -type UsageApi sessionApi - -// GetMetrics gets accumulated usage metrics for the session. +// FinishDeferredIdleDrain finishes a native deferred-idle drain and reports whether to +// drain queue work or emit idle. // -// RPC method: session.usage.getMetrics. +// RPC method: session.queue.finishDeferredIdleDrain. // -// Returns: Accumulated session usage metrics, including premium request cost, token counts, -// model breakdown, and code-change totals. -func (a *UsageApi) GetMetrics(ctx context.Context) (*UsageGetMetricsResult, error) { +// Parameters: Inputs for completing a deferred-idle drain. +// +// Returns: Action selected by the native deferred-idle drain. +// Internal: FinishDeferredIdleDrain is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalQueueAPI) FinishDeferredIdleDrain(ctx context.Context, params *QueueFinishDeferredIdleDrainRequest) (*QueueFinishDeferredIdleDrainResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.usage.getMetrics", req) + if params != nil { + req["activeBackgroundWork"] = params.ActiveBackgroundWork + req["hasPending"] = params.HasPending + } + raw, err := a.client.Request(ctx, "session.queue.finishDeferredIdleDrain", req) if err != nil { return nil, err } - var result UsageGetMetricsResult + var result QueueFinishDeferredIdleDrainResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Experimental: WorkspacesApi contains experimental APIs that may change or be removed. -type WorkspacesApi sessionApi - -// CreateFile creates or overwrites a file in the session workspace files directory. +// HasPending reports whether the local session has native queued work pending. // -// RPC method: session.workspaces.createFile. +// RPC method: session.queue.hasPending. // -// Parameters: Relative path and UTF-8 content for the workspace file to create or overwrite. -func (a *WorkspacesApi) CreateFile(ctx context.Context, params *WorkspacesCreateFileRequest) (*SessionWorkspacesCreateFileResult, error) { +// Returns: Whether the native queue has pending work. +// Internal: HasPending is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalQueueAPI) HasPending(ctx context.Context) (*QueueHasPendingResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["content"] = params.Content - req["path"] = params.Path - } - raw, err := a.client.Request("session.workspaces.createFile", req) + raw, err := a.client.Request(ctx, "session.queue.hasPending", req) if err != nil { return nil, err } - var result SessionWorkspacesCreateFileResult + var result QueueHasPendingResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Diff computes a diff for the session workspace. -// -// RPC method: session.workspaces.diff. -// -// Parameters: Parameters for computing a workspace diff. +// Process drains the native local-session work queue for in-process session orchestration. // -// Returns: Workspace diff result for the requested mode. -func (a *WorkspacesApi) Diff(ctx context.Context, params *WorkspacesDiffRequest) (*WorkspaceDiffResult, error) { +// RPC method: session.queue.process. +// Internal: Process is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalQueueAPI) Process(ctx context.Context) (*SessionQueueProcessResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["mode"] = params.Mode - } - raw, err := a.client.Request("session.workspaces.diff", req) + raw, err := a.client.Request(ctx, "session.queue.process", req) if err != nil { return nil, err } - var result WorkspaceDiffResult + var result SessionQueueProcessResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// GetWorkspace gets current workspace metadata for the session. +// Snapshot returns the internal native queue snapshot for in-process session orchestration. // -// RPC method: session.workspaces.getWorkspace. +// RPC method: session.queue.snapshot. // -// Returns: Current workspace metadata for the session, including its absolute filesystem -// path when available. -func (a *WorkspacesApi) GetWorkspace(ctx context.Context) (*WorkspacesGetWorkspaceResult, error) { +// Returns: Internal snapshot of native queue state for local session orchestration. +// Internal: Snapshot is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalQueueAPI) Snapshot(ctx context.Context) (*QueueSnapshotResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.workspaces.getWorkspace", req) + raw, err := a.client.Request(ctx, "session.queue.snapshot", req) if err != nil { return nil, err } - var result WorkspacesGetWorkspaceResult + var result QueueSnapshotResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ListCheckpoints lists workspace checkpoints in chronological order. +// Experimental: InternalScheduleAPI contains experimental APIs that may change or be +// removed. +type InternalScheduleAPI internalSessionAPI + +// Add registers a relative-interval scheduled prompt. // -// RPC method: session.workspaces.listCheckpoints. +// RPC method: session.schedule.add. // -// Returns: Workspace checkpoints in chronological order; empty when the workspace is not -// enabled. -func (a *WorkspacesApi) ListCheckpoints(ctx context.Context) (*WorkspacesListCheckpointsResult, error) { +// Parameters: Register a relative-interval scheduled prompt. +// +// Returns: Result of registering or re-arming a scheduled prompt. +// Internal: Add is part of the SDK's internal handshake/plumbing; external callers should +// not use it. +func (a *InternalScheduleAPI) Add(ctx context.Context, params *ScheduleAddRequest) (*ScheduleAddResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.workspaces.listCheckpoints", req) + if params != nil { + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["interval"] = params.Interval + req["prompt"] = params.Prompt + if params.Recurring != nil { + req["recurring"] = *params.Recurring + } + } + raw, err := a.client.Request(ctx, "session.schedule.add", req) if err != nil { return nil, err } - var result WorkspacesListCheckpointsResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ListFiles lists files stored in the session workspace files directory. +// AddAt registers an absolute-time scheduled prompt. // -// RPC method: session.workspaces.listFiles. +// RPC method: session.schedule.addAt. // -// Returns: Relative paths of files stored in the session workspace files directory. -func (a *WorkspacesApi) ListFiles(ctx context.Context) (*WorkspacesListFilesResult, error) { +// Parameters: Register an absolute-time scheduled prompt. +// +// Returns: Result of registering or re-arming a scheduled prompt. +// Internal: AddAt is part of the SDK's internal handshake/plumbing; external callers should +// not use it. +func (a *InternalScheduleAPI) AddAt(ctx context.Context, params *ScheduleAddAtRequest) (*ScheduleAddResult, error) { req := map[string]any{"sessionId": a.sessionID} - raw, err := a.client.Request("session.workspaces.listFiles", req) + if params != nil { + req["at"] = params.At + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["prompt"] = params.Prompt + if params.Recurring != nil { + req["recurring"] = *params.Recurring + } + } + raw, err := a.client.Request(ctx, "session.schedule.addAt", req) if err != nil { return nil, err } - var result WorkspacesListFilesResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReadCheckpoint reads the content of a workspace checkpoint by number. +// AddCron registers a recurring cron scheduled prompt. // -// RPC method: session.workspaces.readCheckpoint. +// RPC method: session.schedule.addCron. // -// Parameters: Checkpoint number to read. +// Parameters: Register a cron scheduled prompt. // -// Returns: Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace -// is missing. -func (a *WorkspacesApi) ReadCheckpoint(ctx context.Context, params *WorkspacesReadCheckpointRequest) (*WorkspacesReadCheckpointResult, error) { +// Returns: Result of registering or re-arming a scheduled prompt. +// Internal: AddCron is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalScheduleAPI) AddCron(ctx context.Context, params *ScheduleAddCronRequest) (*ScheduleAddResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["number"] = params.Number + req["cron"] = params.Cron + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["prompt"] = params.Prompt + if params.Recurring != nil { + req["recurring"] = *params.Recurring + } + if params.Tz != nil { + req["tz"] = *params.Tz + } } - raw, err := a.client.Request("session.workspaces.readCheckpoint", req) + raw, err := a.client.Request(ctx, "session.schedule.addCron", req) if err != nil { return nil, err } - var result WorkspacesReadCheckpointResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// ReadFile reads a file from the session workspace files directory. +// AddSelfPaced registers a self-paced scheduled prompt. // -// RPC method: session.workspaces.readFile. +// RPC method: session.schedule.addSelfPaced. // -// Parameters: Relative path of the workspace file to read. +// Parameters: Register a self-paced scheduled prompt. // -// Returns: Contents of the requested workspace file as a UTF-8 string. -func (a *WorkspacesApi) ReadFile(ctx context.Context, params *WorkspacesReadFileRequest) (*WorkspacesReadFileResult, error) { +// Returns: Result of registering or re-arming a scheduled prompt. +// Internal: AddSelfPaced is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalScheduleAPI) AddSelfPaced(ctx context.Context, params *ScheduleAddSelfPacedRequest) (*ScheduleAddResult, error) { req := map[string]any{"sessionId": a.sessionID} if params != nil { - req["path"] = params.Path + if params.DisplayPrompt != nil { + req["displayPrompt"] = *params.DisplayPrompt + } + req["prompt"] = params.Prompt } - raw, err := a.client.Request("session.workspaces.readFile", req) + raw, err := a.client.Request(ctx, "session.schedule.addSelfPaced", req) if err != nil { return nil, err } - var result WorkspacesReadFileResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SaveLargePaste saves pasted content as a UTF-8 file in the session workspace. -// -// RPC method: session.workspaces.saveLargePaste. +// HasSelfPaced reports whether the session has an active self-paced scheduled prompt. // -// Parameters: Pasted content to save as a UTF-8 file in the session workspace. +// RPC method: session.schedule.hasSelfPaced. // -// Returns: Descriptor for the saved paste file, or null when the workspace is unavailable. -func (a *WorkspacesApi) SaveLargePaste(ctx context.Context, params *WorkspacesSaveLargePasteRequest) (*WorkspacesSaveLargePasteResult, error) { +// Returns: Whether the session currently has an active self-paced schedule. +// Internal: HasSelfPaced is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalScheduleAPI) HasSelfPaced(ctx context.Context) (*ScheduleHasSelfPacedResult, error) { req := map[string]any{"sessionId": a.sessionID} - if params != nil { - req["content"] = params.Content - } - raw, err := a.client.Request("session.workspaces.saveLargePaste", req) + raw, err := a.client.Request(ctx, "session.schedule.hasSelfPaced", req) if err != nil { return nil, err } - var result WorkspacesSaveLargePasteResult + var result ScheduleHasSelfPacedResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// SessionRpc provides typed session-scoped RPC methods. -type SessionRpc struct { - // Reuse a single struct instead of allocating one for each service on the heap. - common sessionApi - - Agent *AgentApi - Auth *AuthApi - Canvas *CanvasApi - Commands *CommandsApi - EventLog *EventLogApi - Extensions *ExtensionsApi - Fleet *FleetApi - History *HistoryApi - Instructions *InstructionsApi - Lsp *LspApi - Mcp *McpApi - Metadata *MetadataApi - Mode *ModeApi - Model *ModelApi - Name *NameApi - Options *OptionsApi - Permissions *PermissionsApi - Plan *PlanApi - Plugins *PluginsApi - Queue *QueueApi - Remote *RemoteApi - Schedule *ScheduleApi - Shell *ShellApi - Skills *SkillsApi - Tasks *TasksApi - Telemetry *TelemetryApi - Tools *ToolsApi - UI *UIApi - Usage *UsageApi - Workspaces *WorkspacesApi -} - -// Aborts the current agent turn. -// -// RPC method: session.abort. +// Hydrates the native schedule registry from persisted session events. // -// Parameters: Parameters for aborting the current turn -// -// Returns: Result of aborting the current turn -// Experimental: Abort is an experimental API and may change or be removed in future -// versions. -func (a *SessionRpc) Abort(ctx context.Context, params *AbortRequest) (*AbortResult, error) { - req := map[string]any{"sessionId": a.common.sessionID} - if params != nil { - if params.Reason != nil { - req["reason"] = *params.Reason - } - } - raw, err := a.common.client.Request("session.abort", req) +// RPC method: session.schedule.hydrate. +// Internal: Hydrate is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalScheduleAPI) Hydrate(ctx context.Context) (*SessionScheduleHydrateResult, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.schedule.hydrate", req) if err != nil { return nil, err } - var result AbortResult + var result SessionScheduleHydrateResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Log emits a user-visible session log event. -// -// RPC method: session.log. -// -// Parameters: Message text, optional severity level, persistence flag, optional follow-up -// URL, and optional tip. +// RearmSelfPaced re-arms an active self-paced scheduled prompt. // -// Returns: Identifier of the session event that was emitted for the log message. -// Experimental: Log is an experimental API and may change or be removed in future versions. -func (a *SessionRpc) Log(ctx context.Context, params *LogRequest) (*LogResult, error) { - req := map[string]any{"sessionId": a.common.sessionID} - if params != nil { - if params.Ephemeral != nil { - req["ephemeral"] = *params.Ephemeral - } - if params.Level != nil { - req["level"] = *params.Level - } - req["message"] = params.Message - if params.Tip != nil { - req["tip"] = *params.Tip - } - if params.Type != nil { - req["type"] = *params.Type - } - if params.URL != nil { - req["url"] = *params.URL - } +// RPC method: session.schedule.rearmSelfPaced. +// +// Parameters: Re-arm a self-paced scheduled prompt. +// +// Returns: Result of registering or re-arming a scheduled prompt. +// Internal: RearmSelfPaced is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalScheduleAPI) RearmSelfPaced(ctx context.Context, params *ScheduleRearmSelfPacedRequest) (*ScheduleAddResult, error) { + req := map[string]any{"sessionId": a.sessionID} + if params != nil { + req["at"] = params.At + req["id"] = params.ID } - raw, err := a.common.client.Request("session.log", req) + raw, err := a.client.Request(ctx, "session.schedule.rearmSelfPaced", req) if err != nil { return nil, err } - var result LogResult + var result ScheduleAddResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Sends a user message to the session and returns its message ID. +// Experimental: InternalSettingsAPI contains experimental APIs that may change or be +// removed. +type InternalSettingsAPI internalSessionAPI + +// EvaluatePredicate evaluates a named Rust-owned settings predicate without exposing raw +// feature flags. Internal: the raw feature-flag names and composition are runtime-internal, +// so this predicate-evaluation helper is kept out of the public SDK surface and is callable +// in-process only. // -// RPC method: session.send. +// RPC method: session.settings.evaluatePredicate. // -// Parameters: Parameters for sending a user message to the session +// Parameters: Named Rust-owned settings predicate to evaluate for this session. // -// Returns: Result of sending a user message -// Experimental: Send is an experimental API and may change or be removed in future versions. -func (a *SessionRpc) Send(ctx context.Context, params *SendRequest) (*SendResult, error) { - req := map[string]any{"sessionId": a.common.sessionID} +// Returns: Result of evaluating a Rust-owned settings predicate. +// Internal: EvaluatePredicate is part of the SDK's internal handshake/plumbing; external +// callers should not use it. +func (a *InternalSettingsAPI) EvaluatePredicate(ctx context.Context, params *SessionSettingsEvaluatePredicateRequest) (*SessionSettingsEvaluatePredicateResult, error) { + req := map[string]any{"sessionId": a.sessionID} if params != nil { - if params.AgentMode != nil { - req["agentMode"] = *params.AgentMode - } - if params.Attachments != nil { - req["attachments"] = params.Attachments - } - if params.Billable != nil { - req["billable"] = *params.Billable - } - if params.DisplayPrompt != nil { - req["displayPrompt"] = *params.DisplayPrompt - } - if params.Mode != nil { - req["mode"] = *params.Mode - } - if params.Prepend != nil { - req["prepend"] = *params.Prepend - } - req["prompt"] = params.Prompt - if params.RequestHeaders != nil { - req["requestHeaders"] = params.RequestHeaders - } - if params.RequiredTool != nil { - req["requiredTool"] = *params.RequiredTool - } - if params.Source != nil { - req["source"] = params.Source - } - if params.Traceparent != nil { - req["traceparent"] = *params.Traceparent - } - if params.Tracestate != nil { - req["tracestate"] = *params.Tracestate - } - if params.Wait != nil { - req["wait"] = *params.Wait + req["name"] = params.Name + if params.ToolName != nil { + req["toolName"] = *params.ToolName } } - raw, err := a.common.client.Request("session.send", req) + raw, err := a.client.Request(ctx, "session.settings.evaluatePredicate", req) if err != nil { return nil, err } - var result SendResult + var result SessionSettingsEvaluatePredicateResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Shutdown shuts down the session and persists its final state. Awaits any deferred -// sessionEnd hooks before resolving so user-supplied hook scripts complete before the -// runtime tears down. +// Snapshot returns a redacted snapshot of session runtime settings, with secrets and raw +// feature flags excluded. Internal: the runtime settings shape is a runtime-internal +// surface and is deliberately kept out of the public SDK, because consumers should not +// depend on the runtime's internal settings layout. It remains callable in-process and is +// expected to be reworked as the runtime internals are consolidated. // -// RPC method: session.shutdown. +// RPC method: session.settings.snapshot. // -// Parameters: Parameters for shutting down the session -// Experimental: Shutdown is an experimental API and may change or be removed in future -// versions. -func (a *SessionRpc) Shutdown(ctx context.Context, params *ShutdownRequest) (*SessionShutdownResult, error) { - req := map[string]any{"sessionId": a.common.sessionID} - if params != nil { - if params.Reason != nil { - req["reason"] = *params.Reason - } - if params.Type != nil { - req["type"] = *params.Type - } - } - raw, err := a.common.client.Request("session.shutdown", req) +// Returns: Redacted, serializable view of session runtime settings for SDK boundary +// consumers. Secrets and raw feature flags are intentionally excluded. +// Internal: Snapshot is part of the SDK's internal handshake/plumbing; external callers +// should not use it. +func (a *InternalSettingsAPI) Snapshot(ctx context.Context) (*SessionSettingsSnapshot, error) { + req := map[string]any{"sessionId": a.sessionID} + raw, err := a.client.Request(ctx, "session.settings.snapshot", req) if err != nil { return nil, err } - var result SessionShutdownResult + var result SessionSettingsSnapshot if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -// Suspends the session while preserving persisted state for later resume. +// InternalSessionRPC provides internal SDK session-scoped RPC methods (handshake helpers +// etc.). Not part of the public API. +type InternalSessionRPC struct { + // Reuse a single struct instead of allocating one for each service on the heap. + common internalSessionAPI + + MCP *InternalMCPAPI + Queue *InternalQueueAPI + Schedule *InternalScheduleAPI + Settings *InternalSettingsAPI +} + +// SendSystemNotification queues or sends an internal system notification to the session +// according to its passive policy. // -// RPC method: session.suspend. -// Experimental: Suspend is an experimental API and may change or be removed in future -// versions. -func (a *SessionRpc) Suspend(ctx context.Context) (*SessionSuspendResult, error) { +// RPC method: session.sendSystemNotification. +// +// Parameters: Internal request for sending a system notification. +// Experimental: SendSystemNotification is an experimental API and may change or be removed +// in future versions. +// Internal: SendSystemNotification is part of the SDK's internal handshake/plumbing; +// external callers should not use it. +func (a *InternalSessionRPC) SendSystemNotification(ctx context.Context, params *SendSystemNotificationRequest) (*SessionSendSystemNotificationResult, error) { req := map[string]any{"sessionId": a.common.sessionID} - raw, err := a.common.client.Request("session.suspend", req) + if params != nil { + if params.Kind != nil { + req["kind"] = params.Kind + } + req["message"] = params.Message + if params.Options != nil { + req["options"] = params.Options + } + } + raw, err := a.common.client.Request(ctx, "session.sendSystemNotification", req) if err != nil { return nil, err } - var result SessionSuspendResult + var result SessionSendSystemNotificationResult if err := json.Unmarshal(raw, &result); err != nil { return nil, err } return &result, nil } -func NewSessionRpc(client *jsonrpc2.Client, sessionID string) *SessionRpc { - r := &SessionRpc{} - r.common = sessionApi{client: client, sessionID: sessionID} - r.Agent = (*AgentApi)(&r.common) - r.Auth = (*AuthApi)(&r.common) - r.Canvas = (*CanvasApi)(&r.common) - r.Commands = (*CommandsApi)(&r.common) - r.EventLog = (*EventLogApi)(&r.common) - r.Extensions = (*ExtensionsApi)(&r.common) - r.Fleet = (*FleetApi)(&r.common) - r.History = (*HistoryApi)(&r.common) - r.Instructions = (*InstructionsApi)(&r.common) - r.Lsp = (*LspApi)(&r.common) - r.Mcp = (*McpApi)(&r.common) - r.Metadata = (*MetadataApi)(&r.common) - r.Mode = (*ModeApi)(&r.common) - r.Model = (*ModelApi)(&r.common) - r.Name = (*NameApi)(&r.common) - r.Options = (*OptionsApi)(&r.common) - r.Permissions = (*PermissionsApi)(&r.common) - r.Plan = (*PlanApi)(&r.common) - r.Plugins = (*PluginsApi)(&r.common) - r.Queue = (*QueueApi)(&r.common) - r.Remote = (*RemoteApi)(&r.common) - r.Schedule = (*ScheduleApi)(&r.common) - r.Shell = (*ShellApi)(&r.common) - r.Skills = (*SkillsApi)(&r.common) - r.Tasks = (*TasksApi)(&r.common) - r.Telemetry = (*TelemetryApi)(&r.common) - r.Tools = (*ToolsApi)(&r.common) - r.UI = (*UIApi)(&r.common) - r.Usage = (*UsageApi)(&r.common) - r.Workspaces = (*WorkspacesApi)(&r.common) +func NewInternalSessionRPC(client *jsonrpc2.Client, sessionID string) *InternalSessionRPC { + r := &InternalSessionRPC{} + r.common = internalSessionAPI{client: client, sessionID: sessionID} + r.MCP = (*InternalMCPAPI)(&r.common) + r.Queue = (*InternalQueueAPI)(&r.common) + r.Schedule = (*InternalScheduleAPI)(&r.common) + r.Settings = (*InternalSettingsAPI)(&r.common) return r } @@ -12638,8 +23691,52 @@ type CanvasHandler interface { Open(request *CanvasProviderOpenRequest) (*CanvasProviderOpenResult, error) } -// Experimental: SessionFsHandler contains experimental APIs that may change or be removed. -type SessionFsHandler interface { +// Experimental: FactoryHandler contains experimental APIs that may change or be removed. +type FactoryHandler interface { + // Abort asks the owning extension connection to abort a running factory cooperatively. + // + // RPC method: factory.abort. + // + // Parameters: Parameters for cooperatively aborting a factory body. + // + // Returns: Acknowledgement that a factory request was accepted. + Abort(request *FactoryAbortRequest) (*FactoryAckResult, error) + // Execute asks the owning extension connection to execute a registered factory closure. + // + // RPC method: factory.execute. + // + // Parameters: Parameters sent to the owning extension to execute a factory closure. + // + // Returns: Result returned by an extension factory closure. + Execute(request *FactoryExecuteRequest) (*FactoryExecuteResult, error) +} + +// Experimental: ProviderTokenHandler contains experimental APIs that may change or be +// removed. +type ProviderTokenHandler interface { + // GetToken asks the SDK client to get a bearer token for a BYOK provider whose config set + // `hasBearerTokenProvider: true`. Session-scoped: the runtime calls it back on the + // connection that most recently supplied that provider's config for the session (the + // creating connection, or a resuming connection if the session was resumed — distinct + // providers may be owned by different connections), passing the provider name, and uses the + // returned token as the Authorization header for the outbound model request. The runtime + // does no caching — it calls this once per outbound request; the SDK consumer owns token + // acquisition, caching, and refresh. + // + // RPC method: providerToken.getToken. + // + // Parameters: Asks the SDK client to acquire a bearer token for a BYOK provider whose + // config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound + // model request; the runtime does no caching, so this is sent once per request. + // + // Returns: A bearer token supplied by the SDK client for a BYOK provider. The runtime sets + // it as `Authorization: Bearer ` on the outbound request and does no caching; the + // SDK consumer owns token caching and refresh. + GetToken(request *ProviderTokenAcquireRequest) (*ProviderTokenAcquireResult, error) +} + +// Experimental: SessionFSHandler contains experimental APIs that may change or be removed. +type SessionFSHandler interface { // AppendFile appends content to a file in the client-provided session filesystem. // // RPC method: sessionFs.appendFile. @@ -12648,7 +23745,7 @@ type SessionFsHandler interface { // session filesystem. // // Returns: Describes a filesystem error. - AppendFile(request *SessionFsAppendFileRequest) (*SessionFsError, error) + AppendFile(request *SessionFSAppendFileRequest) (*SessionFSError, error) // Exists checks whether a path exists in the client-provided session filesystem. // // RPC method: sessionFs.exists. @@ -12657,7 +23754,7 @@ type SessionFsHandler interface { // // Returns: Indicates whether the requested path exists in the client-provided session // filesystem. - Exists(request *SessionFsExistsRequest) (*SessionFsExistsResult, error) + Exists(request *SessionFSExistsRequest) (*SessionFSExistsResult, error) // Mkdir creates a directory in the client-provided session filesystem. // // RPC method: sessionFs.mkdir. @@ -12666,7 +23763,7 @@ type SessionFsHandler interface { // options for recursive creation and POSIX mode. // // Returns: Describes a filesystem error. - Mkdir(request *SessionFsMkdirRequest) (*SessionFsError, error) + Mkdir(request *SessionFSMkdirRequest) (*SessionFSError, error) // Readdir lists entry names in a directory from the client-provided session filesystem. // // RPC method: sessionFs.readdir. @@ -12676,7 +23773,7 @@ type SessionFsHandler interface { // // Returns: Names of entries in the requested directory, or a filesystem error if the read // failed. - Readdir(request *SessionFsReaddirRequest) (*SessionFsReaddirResult, error) + Readdir(request *SessionFSReaddirRequest) (*SessionFSReaddirResult, error) // ReaddirWithTypes lists directory entries with type information from the client-provided // session filesystem. // @@ -12687,7 +23784,7 @@ type SessionFsHandler interface { // // Returns: Entries in the requested directory paired with file/directory type information, // or a filesystem error if the read failed. - ReaddirWithTypes(request *SessionFsReaddirWithTypesRequest) (*SessionFsReaddirWithTypesResult, error) + ReaddirWithTypes(request *SessionFSReaddirWithTypesRequest) (*SessionFSReaddirWithTypesResult, error) // ReadFile reads a file from the client-provided session filesystem. // // RPC method: sessionFs.readFile. @@ -12695,7 +23792,7 @@ type SessionFsHandler interface { // Parameters: Path of the file to read from the client-provided session filesystem. // // Returns: File content as a UTF-8 string, or a filesystem error if the read failed. - ReadFile(request *SessionFsReadFileRequest) (*SessionFsReadFileResult, error) + ReadFile(request *SessionFSReadFileRequest) (*SessionFSReadFileResult, error) // Renames or moves a path in the client-provided session filesystem. // // RPC method: sessionFs.rename. @@ -12704,7 +23801,7 @@ type SessionFsHandler interface { // client-provided session filesystem. // // Returns: Describes a filesystem error. - Rename(request *SessionFsRenameRequest) (*SessionFsError, error) + Rename(request *SessionFSRenameRequest) (*SessionFSError, error) // Rm removes a file or directory from the client-provided session filesystem. // // RPC method: sessionFs.rm. @@ -12713,7 +23810,7 @@ type SessionFsHandler interface { // recursive removal and force. // // Returns: Describes a filesystem error. - Rm(request *SessionFsRmRequest) (*SessionFsError, error) + Rm(request *SessionFSRmRequest) (*SessionFSError, error) // SqliteExists checks whether the per-session SQLite database already exists, without // creating it. // @@ -12722,17 +23819,28 @@ type SessionFsHandler interface { // Parameters: Identifies the target session. // // Returns: Indicates whether the per-session SQLite database already exists. - SqliteExists(request *SessionFsSqliteExistsRequest) (*SessionFsSqliteExistsResult, error) - // SqliteQuery executes a SQLite query against the per-session database. + SqliteExists(request *SessionFSSqliteExistsRequest) (*SessionFSSqliteExistsResult, error) + // SqliteQuery executes a SQLite query against the per-session database. Providers apply + // busy handling for every call. // // RPC method: sessionFs.sqliteQuery. // // Parameters: SQL query, query type, and optional bind parameters for executing a SQLite - // query against the per-session database. + // query against the per-session database. The provider applies its SQLite busy timeout for + // every call. // // Returns: Query results including rows, columns, and rows affected, or a filesystem error // if execution failed. - SqliteQuery(request *SessionFsSqliteQueryRequest) (*SessionFsSqliteQueryResult, error) + SqliteQuery(request *SessionFSSqliteQueryRequest) (*SessionFSSqliteQueryResult, error) + // SqliteTransaction executes SQLite statements atomically on the provider-owned connection. + // + // RPC method: sessionFs.sqliteTransaction. + // + // Parameters: Statements to execute atomically. Providers apply busy handling for every + // call. + // + // Returns: Per-statement results, or a classified transaction error. + SqliteTransaction(request *SessionFSSqliteTransactionRequest) (*SessionFSSqliteTransactionResult, error) // Stat gets metadata for a path in the client-provided session filesystem. // // RPC method: sessionFs.stat. @@ -12742,7 +23850,7 @@ type SessionFsHandler interface { // // Returns: Filesystem metadata for the requested path, or a filesystem error if the stat // failed. - Stat(request *SessionFsStatRequest) (*SessionFsStatResult, error) + Stat(request *SessionFSStatRequest) (*SessionFSStatResult, error) // WriteFile writes a file in the client-provided session filesystem. // // RPC method: sessionFs.writeFile. @@ -12751,13 +23859,15 @@ type SessionFsHandler interface { // session filesystem. // // Returns: Describes a filesystem error. - WriteFile(request *SessionFsWriteFileRequest) (*SessionFsError, error) + WriteFile(request *SessionFSWriteFileRequest) (*SessionFSError, error) } -// ClientSessionApiHandlers provides all client session API handler groups for a session. -type ClientSessionApiHandlers struct { - Canvas CanvasHandler - SessionFs SessionFsHandler +// ClientSessionAPIHandlers provides all client session API handler groups for a session. +type ClientSessionAPIHandlers struct { + Canvas CanvasHandler + Factory FactoryHandler + ProviderToken ProviderTokenHandler + SessionFS SessionFSHandler } func clientSessionHandlerError(err error) *jsonrpc2.Error { @@ -12771,9 +23881,9 @@ func clientSessionHandlerError(err error) *jsonrpc2.Error { return &jsonrpc2.Error{Code: -32603, Message: err.Error()} } -// RegisterClientSessionApiHandlers registers handlers for server-to-client session API +// RegisterClientSessionAPIHandlers registers handlers for server-to-client session API // calls. -func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionApiHandlers) { +func RegisterClientSessionAPIHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionAPIHandlers) { client.SetRequestHandler("canvas.close", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { var request CanvasProviderCloseRequest if err := json.Unmarshal(params, &request); err != nil { @@ -12831,16 +23941,73 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( } return raw, nil }) + client.SetRequestHandler("factory.abort", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request FactoryAbortRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + handlers := getHandlers(request.SessionID) + if handlers == nil || handlers.Factory == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No factory handler registered for session: %s", request.SessionID)} + } + result, err := handlers.Factory.Abort(&request) + if err != nil { + return nil, clientSessionHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("factory.execute", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request FactoryExecuteRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + handlers := getHandlers(request.SessionID) + if handlers == nil || handlers.Factory == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No factory handler registered for session: %s", request.SessionID)} + } + result, err := handlers.Factory.Execute(&request) + if err != nil { + return nil, clientSessionHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("providerToken.getToken", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request ProviderTokenAcquireRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + handlers := getHandlers(request.SessionID) + if handlers == nil || handlers.ProviderToken == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No providerToken handler registered for session: %s", request.SessionID)} + } + result, err := handlers.ProviderToken.GetToken(&request) + if err != nil { + return nil, clientSessionHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) client.SetRequestHandler("sessionFs.appendFile", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsAppendFileRequest + var request SessionFSAppendFileRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.AppendFile(&request) + result, err := handlers.SessionFS.AppendFile(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12851,15 +24018,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.exists", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsExistsRequest + var request SessionFSExistsRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Exists(&request) + result, err := handlers.SessionFS.Exists(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12870,15 +24037,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.mkdir", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsMkdirRequest + var request SessionFSMkdirRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Mkdir(&request) + result, err := handlers.SessionFS.Mkdir(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12889,15 +24056,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.readdir", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsReaddirRequest + var request SessionFSReaddirRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Readdir(&request) + result, err := handlers.SessionFS.Readdir(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12908,15 +24075,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.readdirWithTypes", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsReaddirWithTypesRequest + var request SessionFSReaddirWithTypesRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.ReaddirWithTypes(&request) + result, err := handlers.SessionFS.ReaddirWithTypes(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12927,15 +24094,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.readFile", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsReadFileRequest + var request SessionFSReadFileRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.ReadFile(&request) + result, err := handlers.SessionFS.ReadFile(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12946,15 +24113,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.rename", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsRenameRequest + var request SessionFSRenameRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Rename(&request) + result, err := handlers.SessionFS.Rename(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12965,15 +24132,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.rm", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsRmRequest + var request SessionFSRmRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Rm(&request) + result, err := handlers.SessionFS.Rm(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -12984,15 +24151,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.sqliteExists", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsSqliteExistsRequest + var request SessionFSSqliteExistsRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.SqliteExists(&request) + result, err := handlers.SessionFS.SqliteExists(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -13003,15 +24170,34 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.sqliteQuery", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsSqliteQueryRequest + var request SessionFSSqliteQueryRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + handlers := getHandlers(request.SessionID) + if handlers == nil || handlers.SessionFS == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} + } + result, err := handlers.SessionFS.SqliteQuery(&request) + if err != nil { + return nil, clientSessionHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("sessionFs.sqliteTransaction", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request SessionFSSqliteTransactionRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.SqliteQuery(&request) + result, err := handlers.SessionFS.SqliteTransaction(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -13022,15 +24208,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.stat", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsStatRequest + var request SessionFSStatRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.Stat(&request) + result, err := handlers.SessionFS.Stat(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -13041,15 +24227,15 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) client.SetRequestHandler("sessionFs.writeFile", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { - var request SessionFsWriteFileRequest + var request SessionFSWriteFileRequest if err := json.Unmarshal(params, &request); err != nil { return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} } handlers := getHandlers(request.SessionID) - if handlers == nil || handlers.SessionFs == nil { + if handlers == nil || handlers.SessionFS == nil { return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("No sessionFs handler registered for session: %s", request.SessionID)} } - result, err := handlers.SessionFs.WriteFile(&request) + result, err := handlers.SessionFS.WriteFile(&request) if err != nil { return nil, clientSessionHandlerError(err) } @@ -13060,3 +24246,193 @@ func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func( return raw, nil }) } + +// Experimental: ExtensionLaunchProviderHandler contains experimental APIs that may change +// or be removed. +type ExtensionLaunchProviderHandler interface { + // Resolve asks the registered SDK client to resolve an opaque process launch profile for + // one discovered extension entrypoint immediately before launch or reload. The provider + // must respond within 15 seconds. + // + // RPC method: extensionLaunchProvider.resolve. + // + // Parameters: A discovered extension entrypoint that the registered integrator may classify + // and resolve to an opaque launch profile. + // + // Returns: The launch profile for a supported entrypoint. Omit launch when the provider + // does not support the entrypoint. + Resolve(request *ExtensionLaunchProviderResolveRequest) (*ExtensionLaunchProviderResolveResult, error) +} + +// Experimental: GitHubTelemetryHandler contains experimental APIs that may change or be +// removed. +type GitHubTelemetryHandler interface { + // Event forwards a single GitHub telemetry event to a host connection that opted into + // telemetry forwarding during the `server.connect` handshake. Opted-in connections receive + // every event the runtime emits after the handshake — across all sessions, plus sessionless + // events (for example, `server.sendTelemetry` calls with no session id). + // + // RPC method: gitHubTelemetry.event. + // + // Parameters: Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry + // event the runtime forwards to a host connection that opted into telemetry forwarding + // during the `server.connect` handshake. + Event(request *GitHubTelemetryNotification) error +} + +// Experimental: HooksHandler contains experimental APIs that may change or be removed. +type HooksHandler interface { + // Invoke dispatches one SDK callback hook from the runtime to the connection that + // registered it. Internal transport plumbing: clients opt in through session initialization + // and the Rust hook processor owns ordering, policy, timeout, and callback routing. + // + // RPC method: hooks.invoke. + // + // Parameters: Runtime-owned wire payload for a server-to-client hook callback invocation. + // + // Returns: Optional output returned by an SDK callback hook. + Invoke(request *HookInvokeRequest) (*HookInvokeResponse, error) +} + +// Experimental: LlmInferenceHandler contains experimental APIs that may change or be +// removed. +type LlmInferenceHandler interface { + // HttpRequestChunk delivers a body byte range (or a cancellation signal) for a request + // previously announced via httpRequestStart, correlated by requestId. The runtime fires at + // least one chunk per request — when there is no body, a single chunk with empty data and + // end=true. Mid-stream the runtime may send a chunk with cancel=true to abort the request; + // the SDK then stops issuing httpResponseChunk frames and may emit a terminal + // httpResponseChunk with error set. + // + // RPC method: llmInference.httpRequestChunk. + // + // Parameters: A request body chunk or cancellation signal. + // + // Returns: Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as + // fire-and-forget. + HttpRequestChunk(request *LlmInferenceHTTPRequestChunkRequest) (*LlmInferenceHTTPRequestChunkResult, error) + // HttpRequestStart announces an outbound model-layer HTTP request the runtime wants the SDK + // client to service. Carries the request head only; the body always follows as one or more + // httpRequestChunk frames keyed by the same requestId, even when the body is empty (a + // single chunk with end=true). + // + // RPC method: llmInference.httpRequestStart. + // + // Parameters: The head of an outbound model-layer HTTP request. + // + // Returns: Acknowledgement. Returning successfully simply means the SDK accepted the start + // frame; it does not imply the request will succeed. + HttpRequestStart(request *LlmInferenceHTTPRequestStartRequest) (*LlmInferenceHTTPRequestStartResult, error) +} + +// ClientGlobalAPIHandlers provides all client-global API handler groups. +// +// Unlike client-session handlers these carry no implicit session id dispatch +// key; a single set of handlers serves the entire connection. +type ClientGlobalAPIHandlers struct { + ExtensionLaunchProvider ExtensionLaunchProviderHandler + GitHubTelemetry GitHubTelemetryHandler + Hooks HooksHandler + LlmInference LlmInferenceHandler +} + +func clientGlobalHandlerError(err error) *jsonrpc2.Error { + if err == nil { + return nil + } + var rpcErr *jsonrpc2.Error + if errors.As(err, &rpcErr) { + return rpcErr + } + return &jsonrpc2.Error{Code: -32603, Message: err.Error()} +} + +// RegisterClientGlobalAPIHandlers registers handlers for server-to-client client-global API +// calls. +func RegisterClientGlobalAPIHandlers(client *jsonrpc2.Client, handlers *ClientGlobalAPIHandlers) { + client.SetRequestHandler("extensionLaunchProvider.resolve", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request ExtensionLaunchProviderResolveRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + if handlers == nil || handlers.ExtensionLaunchProvider == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: "No extensionLaunchProvider client-global handler registered"} + } + result, err := handlers.ExtensionLaunchProvider.Resolve(&request) + if err != nil { + return nil, clientGlobalHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("gitHubTelemetry.event", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request GitHubTelemetryNotification + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + if handlers == nil || handlers.GitHubTelemetry == nil { + return nil, nil + } + if err := handlers.GitHubTelemetry.Event(&request); err != nil { + return nil, clientGlobalHandlerError(err) + } + return nil, nil + }) + client.SetRequestHandler("hooks.invoke", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request HookInvokeRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + if handlers == nil || handlers.Hooks == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: "No hooks client-global handler registered"} + } + result, err := handlers.Hooks.Invoke(&request) + if err != nil { + return nil, clientGlobalHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("llmInference.httpRequestChunk", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request LlmInferenceHTTPRequestChunkRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + if handlers == nil || handlers.LlmInference == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: "No llmInference client-global handler registered"} + } + result, err := handlers.LlmInference.HttpRequestChunk(&request) + if err != nil { + return nil, clientGlobalHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) + client.SetRequestHandler("llmInference.httpRequestStart", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + var request LlmInferenceHTTPRequestStartRequest + if err := json.Unmarshal(params, &request); err != nil { + return nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)} + } + if handlers == nil || handlers.LlmInference == nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: "No llmInference client-global handler registered"} + } + result, err := handlers.LlmInference.HttpRequestStart(&request) + if err != nil { + return nil, clientGlobalHandlerError(err) + } + raw, err := json.Marshal(result) + if err != nil { + return nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)} + } + return raw, nil + }) +} diff --git a/go/rpc/zrpc_encoding.go b/go/rpc/zrpc_encoding.go index 370a2df91..29c253e1c 100644 --- a/go/rpc/zrpc_encoding.go +++ b/go/rpc/zrpc_encoding.go @@ -8,103 +8,6 @@ import ( "errors" ) -func unmarshalAgentRegistrySpawnResult(data []byte) (AgentRegistrySpawnResult, error) { - if string(data) == "null" { - return nil, nil - } - type rawUnion struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - } - var raw rawUnion - if err := json.Unmarshal(data, &raw); err != nil { - return nil, err - } - - switch raw.Kind { - case AgentRegistrySpawnResultKindRegistryTimeout: - var d AgentRegistrySpawnRegistryTimeout - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case AgentRegistrySpawnResultKindSpawnError: - var d AgentRegistrySpawnError - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case AgentRegistrySpawnResultKindSpawned: - var d AgentRegistrySpawnSpawned - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case AgentRegistrySpawnResultKindValidationError: - var d AgentRegistrySpawnValidationError - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - default: - return &RawAgentRegistrySpawnResultData{Discriminator: raw.Kind, Raw: data}, nil - } -} - -func (r RawAgentRegistrySpawnResultData) MarshalJSON() ([]byte, error) { - if r.Raw != nil { - return r.Raw, nil - } - return json.Marshal(struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - }{ - Kind: r.Discriminator, - }) -} - -func (r AgentRegistrySpawnError) MarshalJSON() ([]byte, error) { - type alias AgentRegistrySpawnError - return json.Marshal(struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r AgentRegistrySpawnRegistryTimeout) MarshalJSON() ([]byte, error) { - type alias AgentRegistrySpawnRegistryTimeout - return json.Marshal(struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r AgentRegistrySpawnSpawned) MarshalJSON() ([]byte, error) { - type alias AgentRegistrySpawnSpawned - return json.Marshal(struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r AgentRegistrySpawnValidationError) MarshalJSON() ([]byte, error) { - type alias AgentRegistrySpawnValidationError - return json.Marshal(struct { - Kind AgentRegistrySpawnResultKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - func unmarshalAuthInfo(data []byte) (AuthInfo, error) { if string(data) == "null" { return nil, nil @@ -136,13 +39,13 @@ func unmarshalAuthInfo(data []byte) (AuthInfo, error) { return nil, err } return &d, nil - case AuthInfoTypeGhCli: - var d GhCliAuthInfo + case AuthInfoTypeGhCLI: + var d GhCLIAuthInfo if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case AuthInfoTypeHmac: + case AuthInfoTypeHMAC: var d HMACAuthInfo if err := json.Unmarshal(data, &d); err != nil { return nil, err @@ -209,8 +112,8 @@ func (r EnvAuthInfo) MarshalJSON() ([]byte, error) { }) } -func (r GhCliAuthInfo) MarshalJSON() ([]byte, error) { - type alias GhCliAuthInfo +func (r GhCLIAuthInfo) MarshalJSON() ([]byte, error) { + type alias GhCLIAuthInfo return json.Marshal(struct { Type AuthInfoType `json:"type"` alias @@ -253,277 +156,295 @@ func (r UserAuthInfo) MarshalJSON() ([]byte, error) { }) } -func unmarshalQueuedCommandResult(data []byte) (QueuedCommandResult, error) { - if string(data) == "null" { - return nil, nil +func (r *AccountAllUsers) UnmarshalJSON(data []byte) error { + type rawAccountAllUsers struct { + AuthInfo json.RawMessage `json:"authInfo"` + Token *string `json:"token,omitempty"` } - type rawUnion struct { - Handled *bool `json:"handled"` - } - var raw rawUnion + var raw rawAccountAllUsers if err := json.Unmarshal(data, &raw); err != nil { - return nil, err - } - if raw.Handled == nil { - return nil, errors.New("data did not match any union variant for QueuedCommandResult") + return err } - - switch *raw.Handled { - case false: - var d QueuedCommandNotHandled - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case true: - var d QueuedCommandHandled - if err := json.Unmarshal(data, &d); err != nil { - return nil, err + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) + if err != nil { + return err } - return &d, nil + r.AuthInfo = value } - return nil, errors.New("data did not match any union variant for QueuedCommandResult") -} - -func (r QueuedCommandHandled) MarshalJSON() ([]byte, error) { - type alias QueuedCommandHandled - return json.Marshal(struct { - Handled bool `json:"handled"` - alias - }{ - Handled: r.Handled(), - alias: alias(r), - }) -} - -func (r QueuedCommandNotHandled) MarshalJSON() ([]byte, error) { - type alias QueuedCommandNotHandled - return json.Marshal(struct { - Handled bool `json:"handled"` - alias - }{ - Handled: r.Handled(), - alias: alias(r), - }) + r.Token = raw.Token + return nil } -func (r *CommandsRespondToQueuedCommandRequest) UnmarshalJSON(data []byte) error { - type rawCommandsRespondToQueuedCommandRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` +func (r *AccountGetCurrentAuthResult) UnmarshalJSON(data []byte) error { + type rawAccountGetCurrentAuthResult struct { + AuthErrors []string `json:"authErrors,omitzero"` + AuthInfo json.RawMessage `json:"authInfo,omitempty"` } - var raw rawCommandsRespondToQueuedCommandRequest + var raw rawAccountGetCurrentAuthResult if err := json.Unmarshal(data, &raw); err != nil { return err } - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalQueuedCommandResult(raw.Result) + r.AuthErrors = raw.AuthErrors + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) if err != nil { return err } - r.Result = value + r.AuthInfo = value } return nil } -func (r EventLogTypes) MarshalJSON() ([]byte, error) { - if r.String != nil { - return json.Marshal(r.String) - } - if r.StringArray != nil { - return json.Marshal(r.StringArray) - } - return []byte("null"), nil -} - -func (r *EventLogTypes) UnmarshalJSON(data []byte) error { - if string(data) == "null" { - *r = EventLogTypes{} - return nil +func (r *AccountLogoutRequest) UnmarshalJSON(data []byte) error { + type rawAccountLogoutRequest struct { + AuthInfo json.RawMessage `json:"authInfo"` } - { - var value EventLogTypesString - if err := json.Unmarshal(data, &value); err == nil { - *r = EventLogTypes{String: &value} - return nil - } + var raw rawAccountLogoutRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err } - { - var value []string - if err := json.Unmarshal(data, &value); err == nil { - *r = EventLogTypes{StringArray: value} - return nil + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) + if err != nil { + return err } + r.AuthInfo = value } - return errors.New("data did not match any union variant for EventLogTypes") + return nil } -func unmarshalExternalToolTextResultForLlmContent(data []byte) (ExternalToolTextResultForLlmContent, error) { +func unmarshalAgentRegistrySpawnResult(data []byte) (AgentRegistrySpawnResult, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind AgentRegistrySpawnResultKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Type { - case ExternalToolTextResultForLlmContentTypeAudio: - var d ExternalToolTextResultForLlmContentAudio - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case ExternalToolTextResultForLlmContentTypeImage: - var d ExternalToolTextResultForLlmContentImage - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case ExternalToolTextResultForLlmContentTypeResource: - var d ExternalToolTextResultForLlmContentResource + switch raw.Kind { + case AgentRegistrySpawnResultKindRegistryTimeout: + var d AgentRegistrySpawnRegistryTimeout if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeResourceLink: - var d ExternalToolTextResultForLlmContentResourceLink + case AgentRegistrySpawnResultKindSpawnError: + var d AgentRegistrySpawnError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeTerminal: - var d ExternalToolTextResultForLlmContentTerminal + case AgentRegistrySpawnResultKindSpawned: + var d AgentRegistrySpawnSpawned if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case ExternalToolTextResultForLlmContentTypeText: - var d ExternalToolTextResultForLlmContentText + case AgentRegistrySpawnResultKindValidationError: + var d AgentRegistrySpawnValidationError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawExternalToolTextResultForLlmContentData{Discriminator: raw.Type, Raw: data}, nil + return &RawAgentRegistrySpawnResultData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawExternalToolTextResultForLlmContentData) MarshalJSON() ([]byte, error) { +func (r RawAgentRegistrySpawnResultData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind AgentRegistrySpawnResultKind `json:"kind"` }{ - Type: r.Discriminator, + Kind: r.Discriminator, }) } -func (r ExternalToolTextResultForLlmContentAudio) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentAudio +func (r AgentRegistrySpawnError) MarshalJSON() ([]byte, error) { + type alias AgentRegistrySpawnError return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind AgentRegistrySpawnResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r ExternalToolTextResultForLlmContentImage) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentImage +func (r AgentRegistrySpawnRegistryTimeout) MarshalJSON() ([]byte, error) { + type alias AgentRegistrySpawnRegistryTimeout return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Kind AgentRegistrySpawnResultKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func matchesEmbeddedBlobResourceContents(data []byte) bool { - var rawGroup0 struct { - Blob json.RawMessage `json:"blob"` - Text json.RawMessage `json:"text"` - } - if err := json.Unmarshal(data, &rawGroup0); err != nil { - return false - } - if rawGroup0.Blob == nil { - return false - } - return rawGroup0.Text == nil +func (r AgentRegistrySpawnSpawned) MarshalJSON() ([]byte, error) { + type alias AgentRegistrySpawnSpawned + return json.Marshal(struct { + Kind AgentRegistrySpawnResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func matchesEmbeddedTextResourceContents(data []byte) bool { - var rawGroup0 struct { - Blob json.RawMessage `json:"blob"` - Text json.RawMessage `json:"text"` - } - if err := json.Unmarshal(data, &rawGroup0); err != nil { - return false - } - if rawGroup0.Text == nil { - return false - } - return rawGroup0.Blob == nil +func (r AgentRegistrySpawnValidationError) MarshalJSON() ([]byte, error) { + type alias AgentRegistrySpawnValidationError + return json.Marshal(struct { + Kind AgentRegistrySpawnResultKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func unmarshalExternalToolTextResultForLlmContentResourceDetails(data []byte) (ExternalToolTextResultForLlmContentResourceDetails, error) { +func unmarshalAttachment(data []byte) (Attachment, error) { if string(data) == "null" { return nil, nil } - if matchesEmbeddedBlobResourceContents(data) { - var d EmbeddedBlobResourceContents + type rawUnion struct { + Type AttachmentType `json:"type"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Type { + case AttachmentTypeBlob: + var d AttachmentBlob if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - } - if matchesEmbeddedTextResourceContents(data) { - var d EmbeddedTextResourceContents + case AttachmentTypeDirectory: + var d AttachmentDirectory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeExtensionContext: + var d AttachmentExtensionContext + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeFile: + var d AttachmentFile + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubActionsJob: + var d AttachmentGitHubActionsJob + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubCommit: + var d AttachmentGitHubCommit + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubFile: + var d AttachmentGitHubFile + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubFileDiff: + var d AttachmentGitHubFileDiff + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubReference: + var d AttachmentGitHubReference + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubRelease: + var d AttachmentGitHubRelease + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubRepository: + var d AttachmentGitHubRepository + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubSnippet: + var d AttachmentGitHubSnippet + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubTreeComparison: + var d AttachmentGitHubTreeComparison + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeGitHubURL: + var d AttachmentGitHubURL + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case AttachmentTypeSelection: + var d AttachmentSelection if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil + default: + return &RawAttachmentData{Discriminator: raw.Type, Raw: data}, nil } - return &RawExternalToolTextResultForLlmContentResourceDetailsData{Raw: data}, nil } -func (r RawExternalToolTextResultForLlmContentResourceDetailsData) MarshalJSON() ([]byte, error) { +func (r RawAttachmentData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } - return []byte("null"), nil + return json.Marshal(struct { + Type AttachmentType `json:"type"` + }{ + Type: r.Discriminator, + }) } -func (r *ExternalToolTextResultForLlmContentResource) UnmarshalJSON(data []byte) error { - type rawExternalToolTextResultForLlmContentResource struct { - Resource json.RawMessage `json:"resource"` - } - var raw rawExternalToolTextResultForLlmContentResource - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - if raw.Resource != nil { - value, err := unmarshalExternalToolTextResultForLlmContentResourceDetails(raw.Resource) - if err != nil { - return err - } - r.Resource = value - } - return nil +func (r AttachmentBlob) MarshalJSON() ([]byte, error) { + type alias AttachmentBlob + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func (r ExternalToolTextResultForLlmContentResource) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentResource +func (r AttachmentDirectory) MarshalJSON() ([]byte, error) { + type alias AttachmentDirectory return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Type AttachmentType `json:"type"` alias }{ Type: r.Type(), @@ -531,10 +452,10 @@ func (r ExternalToolTextResultForLlmContentResource) MarshalJSON() ([]byte, erro }) } -func (r ExternalToolTextResultForLlmContentResourceLink) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentResourceLink +func (r AttachmentExtensionContext) MarshalJSON() ([]byte, error) { + type alias AttachmentExtensionContext return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Type AttachmentType `json:"type"` alias }{ Type: r.Type(), @@ -542,10 +463,10 @@ func (r ExternalToolTextResultForLlmContentResourceLink) MarshalJSON() ([]byte, }) } -func (r ExternalToolTextResultForLlmContentTerminal) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentTerminal +func (r AttachmentFile) MarshalJSON() ([]byte, error) { + type alias AttachmentFile return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Type AttachmentType `json:"type"` alias }{ Type: r.Type(), @@ -553,10 +474,10 @@ func (r ExternalToolTextResultForLlmContentTerminal) MarshalJSON() ([]byte, erro }) } -func (r ExternalToolTextResultForLlmContentText) MarshalJSON() ([]byte, error) { - type alias ExternalToolTextResultForLlmContentText +func (r AttachmentGitHubActionsJob) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubActionsJob return json.Marshal(struct { - Type ExternalToolTextResultForLlmContentType `json:"type"` + Type AttachmentType `json:"type"` alias }{ Type: r.Type(), @@ -564,393 +485,1655 @@ func (r ExternalToolTextResultForLlmContentText) MarshalJSON() ([]byte, error) { }) } -func (r *ExternalToolTextResultForLlm) UnmarshalJSON(data []byte) error { - type rawExternalToolTextResultForLlm struct { - BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitempty"` - Contents []json.RawMessage `json:"contents,omitempty"` - Error *string `json:"error,omitempty"` - ResultType *string `json:"resultType,omitempty"` - SessionLog *string `json:"sessionLog,omitempty"` - TextResultForLlm string `json:"textResultForLlm"` - ToolTelemetry map[string]any `json:"toolTelemetry,omitempty"` - } - var raw rawExternalToolTextResultForLlm - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - r.BinaryResultsForLlm = raw.BinaryResultsForLlm - if raw.Contents != nil { - r.Contents = make([]ExternalToolTextResultForLlmContent, 0, len(raw.Contents)) - for _, rawItem := range raw.Contents { - value, err := unmarshalExternalToolTextResultForLlmContent(rawItem) - if err != nil { - return err - } - r.Contents = append(r.Contents, value) - } - } - r.Error = raw.Error - r.ResultType = raw.ResultType - r.SessionLog = raw.SessionLog - r.TextResultForLlm = raw.TextResultForLlm - r.ToolTelemetry = raw.ToolTelemetry - return nil +func (r AttachmentGitHubCommit) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubCommit + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func unmarshalExternalToolResult(data []byte) (ExternalToolResult, error) { - if string(data) == "null" { - return nil, nil - } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - return ExternalToolStringResult(value), nil - } - } - { - var value ExternalToolTextResultForLlm - if err := json.Unmarshal(data, &value); err == nil { - return &value, nil - } - } - return nil, errors.New("data did not match any union variant for ExternalToolResult") +func (r AttachmentGitHubFile) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubFile + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func unmarshalFilterMapping(data []byte) (FilterMapping, error) { - if string(data) == "null" { - return nil, nil - } - { - var value FilterMappingEnumMap - if err := json.Unmarshal(data, &value); err == nil { - return value, nil - } - } - { - var value ContentFilterMode - if err := json.Unmarshal(data, &value); err == nil { - return value, nil - } - } - return nil, errors.New("data did not match any union variant for FilterMapping") +func (r AttachmentGitHubFileDiff) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubFileDiff + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func (r *HandlePendingToolCallRequest) UnmarshalJSON(data []byte) error { - type rawHandlePendingToolCallRequest struct { - Error *string `json:"error,omitempty"` - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result,omitempty"` - } - var raw rawHandlePendingToolCallRequest - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - r.Error = raw.Error - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalExternalToolResult(raw.Result) - if err != nil { - return err - } - r.Result = value - } - return nil +func (r AttachmentGitHubReference) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubReference + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func (r InstalledPluginSource) MarshalJSON() ([]byte, error) { - if r.InstalledPluginSourceGithub != nil { - return json.Marshal(r.InstalledPluginSourceGithub) - } - if r.InstalledPluginSourceLocal != nil { - return json.Marshal(r.InstalledPluginSourceLocal) - } - if r.InstalledPluginSourceURL != nil { - return json.Marshal(r.InstalledPluginSourceURL) - } - if r.String != nil { - return json.Marshal(r.String) - } - return []byte("null"), nil +func (r AttachmentGitHubRelease) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubRelease + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } -func (r *InstalledPluginSource) UnmarshalJSON(data []byte) error { +func (r AttachmentGitHubRepository) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubRepository + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r AttachmentGitHubSnippet) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubSnippet + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r AttachmentGitHubTreeComparison) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubTreeComparison + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r AttachmentGitHubURL) MarshalJSON() ([]byte, error) { + type alias AttachmentGitHubURL + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r AttachmentSelection) MarshalJSON() ([]byte, error) { + type alias AttachmentSelection + return json.Marshal(struct { + Type AttachmentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func unmarshalQueuedCommandResult(data []byte) (QueuedCommandResult, error) { if string(data) == "null" { - *r = InstalledPluginSource{} - return nil + return nil, nil } - { - var value InstalledPluginSourceGithub - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceGithub: &value} - return nil - } + type rawUnion struct { + Handled *bool `json:"handled"` } - { - var value InstalledPluginSourceLocal - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceLocal: &value} - return nil - } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err } - { - var value InstalledPluginSourceURL - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{InstalledPluginSourceURL: &value} - return nil - } + if raw.Handled == nil { + return nil, errors.New("data did not match any union variant for QueuedCommandResult") } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - *r = InstalledPluginSource{String: &value} - return nil + + switch *raw.Handled { + case false: + var d QueuedCommandNotHandled + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case true: + var d QueuedCommandHandled + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } + return &d, nil } - return errors.New("data did not match any union variant for InstalledPluginSource") + return nil, errors.New("data did not match any union variant for QueuedCommandResult") } -func matchesMcpServerConfigHTTP(data []byte) bool { - var rawGroup0 struct { - Command json.RawMessage `json:"command"` - URL json.RawMessage `json:"url"` - } - if err := json.Unmarshal(data, &rawGroup0); err != nil { - return false - } - if rawGroup0.URL == nil { - return false - } - return rawGroup0.Command == nil +func (r QueuedCommandHandled) MarshalJSON() ([]byte, error) { + type alias QueuedCommandHandled + return json.Marshal(struct { + Handled bool `json:"handled"` + alias + }{ + Handled: r.Handled(), + alias: alias(r), + }) } -func matchesMcpServerConfigStdio(data []byte) bool { - var rawGroup0 struct { - Command json.RawMessage `json:"command"` - URL json.RawMessage `json:"url"` +func (r QueuedCommandNotHandled) MarshalJSON() ([]byte, error) { + type alias QueuedCommandNotHandled + return json.Marshal(struct { + Handled bool `json:"handled"` + alias + }{ + Handled: r.Handled(), + alias: alias(r), + }) +} + +func (r *CommandsRespondToQueuedCommandRequest) UnmarshalJSON(data []byte) error { + type rawCommandsRespondToQueuedCommandRequest struct { + RequestID string `json:"requestId"` + Result json.RawMessage `json:"result"` } - if err := json.Unmarshal(data, &rawGroup0); err != nil { - return false + var raw rawCommandsRespondToQueuedCommandRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err } - if rawGroup0.Command == nil { - return false + r.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalQueuedCommandResult(raw.Result) + if err != nil { + return err + } + r.Result = value } - return rawGroup0.URL == nil + return nil } -func unmarshalMcpServerConfig(data []byte) (McpServerConfig, error) { +func unmarshalDebugCollectLogsDestination(data []byte) (DebugCollectLogsDestination, error) { if string(data) == "null" { return nil, nil } - if matchesMcpServerConfigHTTP(data) { - var d McpServerConfigHTTP + type rawUnion struct { + Kind DebugCollectLogsDestinationKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case DebugCollectLogsDestinationKindArchive: + var d DebugCollectLogsDestinationArchive if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - } - if matchesMcpServerConfigStdio(data) { - var d McpServerConfigStdio + case DebugCollectLogsDestinationKindDirectory: + var d DebugCollectLogsDestinationDirectory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil + default: + return &RawDebugCollectLogsDestinationData{Discriminator: raw.Kind, Raw: data}, nil } - return &RawMcpServerConfigData{Raw: data}, nil } -func (r RawMcpServerConfigData) MarshalJSON() ([]byte, error) { +func (r RawDebugCollectLogsDestinationData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } - return []byte("null"), nil + return json.Marshal(struct { + Kind DebugCollectLogsDestinationKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) } -func unmarshalMcpServerAuthConfig(data []byte) (McpServerAuthConfig, error) { - if string(data) == "null" { - return nil, nil - } - { - var value bool - if err := json.Unmarshal(data, &value); err == nil { - return McpServerAuthConfigBoolean(value), nil - } - } - { - var value McpServerAuthConfigRedirectPort - if err := json.Unmarshal(data, &value); err == nil { - return &value, nil - } - } - return nil, errors.New("data did not match any union variant for McpServerAuthConfig") +func (r DebugCollectLogsDestinationArchive) MarshalJSON() ([]byte, error) { + type alias DebugCollectLogsDestinationArchive + return json.Marshal(struct { + Kind DebugCollectLogsDestinationKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r *McpServerConfigHTTP) UnmarshalJSON(data []byte) error { - type rawMcpServerConfigHTTP struct { - Auth json.RawMessage `json:"auth,omitempty"` - FilterMapping json.RawMessage `json:"filterMapping,omitempty"` - Headers map[string]string `json:"headers,omitempty"` - IsDefaultServer *bool `json:"isDefaultServer,omitempty"` - OauthClientID *string `json:"oauthClientId,omitempty"` - OauthGrantType *McpServerConfigHTTPOauthGrantType `json:"oauthGrantType,omitempty"` - OauthPublicClient *bool `json:"oauthPublicClient,omitempty"` - Oidc json.RawMessage `json:"oidc,omitempty"` - Timeout *int64 `json:"timeout,omitempty"` - Tools []string `json:"tools,omitempty"` - Type *McpServerConfigHTTPType `json:"type,omitempty"` - URL string `json:"url"` +func (r DebugCollectLogsDestinationDirectory) MarshalJSON() ([]byte, error) { + type alias DebugCollectLogsDestinationDirectory + return json.Marshal(struct { + Kind DebugCollectLogsDestinationKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *DebugCollectLogsRequest) UnmarshalJSON(data []byte) error { + type rawDebugCollectLogsRequest struct { + AdditionalEntries []DebugCollectLogsEntry `json:"additionalEntries,omitzero"` + Destination json.RawMessage `json:"destination"` + Include *DebugCollectLogsInclude `json:"include,omitempty"` } - var raw rawMcpServerConfigHTTP + var raw rawDebugCollectLogsRequest if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Auth != nil { - value, err := unmarshalMcpServerAuthConfig(raw.Auth) + r.AdditionalEntries = raw.AdditionalEntries + if raw.Destination != nil { + value, err := unmarshalDebugCollectLogsDestination(raw.Destination) if err != nil { return err } - r.Auth = value + r.Destination = value } - if raw.FilterMapping != nil { - value, err := unmarshalFilterMapping(raw.FilterMapping) - if err != nil { - return err - } - r.FilterMapping = value + r.Include = raw.Include + return nil +} + +func (r EventLogTypes) MarshalJSON() ([]byte, error) { + if r.String != nil { + return json.Marshal(r.String) } - r.Headers = raw.Headers - r.IsDefaultServer = raw.IsDefaultServer - r.OauthClientID = raw.OauthClientID - r.OauthGrantType = raw.OauthGrantType - r.OauthPublicClient = raw.OauthPublicClient - if raw.Oidc != nil { - value, err := unmarshalMcpServerAuthConfig(raw.Oidc) - if err != nil { - return err - } - r.Oidc = value + if r.StringArray != nil { + return json.Marshal(r.StringArray) } - r.Timeout = raw.Timeout - r.Tools = raw.Tools - r.Type = raw.Type - r.URL = raw.URL - return nil + return []byte("null"), nil } -func (r *McpServerConfigStdio) UnmarshalJSON(data []byte) error { - type rawMcpServerConfigStdio struct { - Args []string `json:"args,omitempty"` - Auth json.RawMessage `json:"auth,omitempty"` - Command string `json:"command"` - Cwd *string `json:"cwd,omitempty"` - Env map[string]string `json:"env,omitempty"` - FilterMapping json.RawMessage `json:"filterMapping,omitempty"` - IsDefaultServer *bool `json:"isDefaultServer,omitempty"` - Oidc json.RawMessage `json:"oidc,omitempty"` - Timeout *int64 `json:"timeout,omitempty"` - Tools []string `json:"tools,omitempty"` +func (r *EventLogTypes) UnmarshalJSON(data []byte) error { + if string(data) == "null" { + *r = EventLogTypes{} + return nil } - var raw rawMcpServerConfigStdio - if err := json.Unmarshal(data, &raw); err != nil { - return err + { + var value EventLogTypesString + if err := json.Unmarshal(data, &value); err == nil { + *r = EventLogTypes{String: &value} + return nil + } } - r.Args = raw.Args - if raw.Auth != nil { - value, err := unmarshalMcpServerAuthConfig(raw.Auth) - if err != nil { - return err + { + var value []string + if err := json.Unmarshal(data, &value); err == nil { + *r = EventLogTypes{StringArray: value} + return nil } - r.Auth = value } - r.Command = raw.Command - r.Cwd = raw.Cwd - r.Env = raw.Env - if raw.FilterMapping != nil { - value, err := unmarshalFilterMapping(raw.FilterMapping) - if err != nil { - return err + return errors.New("data did not match any union variant for EventLogTypes") +} + +func unmarshalExternalToolTextResultForLlmContent(data []byte) (ExternalToolTextResultForLlmContent, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Type { + case ExternalToolTextResultForLlmContentTypeAudio: + var d ExternalToolTextResultForLlmContentAudio + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } - r.FilterMapping = value + return &d, nil + case ExternalToolTextResultForLlmContentTypeImage: + var d ExternalToolTextResultForLlmContentImage + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case ExternalToolTextResultForLlmContentTypeResource: + var d ExternalToolTextResultForLlmContentResource + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case ExternalToolTextResultForLlmContentTypeResourceLink: + var d ExternalToolTextResultForLlmContentResourceLink + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case ExternalToolTextResultForLlmContentTypeShellExit: + var d ExternalToolTextResultForLlmContentShellExit + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case ExternalToolTextResultForLlmContentTypeTerminal: + var d ExternalToolTextResultForLlmContentTerminal + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case ExternalToolTextResultForLlmContentTypeText: + var d ExternalToolTextResultForLlmContentText + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawExternalToolTextResultForLlmContentData{Discriminator: raw.Type, Raw: data}, nil } - r.IsDefaultServer = raw.IsDefaultServer - if raw.Oidc != nil { - value, err := unmarshalMcpServerAuthConfig(raw.Oidc) - if err != nil { - return err +} + +func (r RawExternalToolTextResultForLlmContentData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + }{ + Type: r.Discriminator, + }) +} + +func (r ExternalToolTextResultForLlmContentAudio) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentAudio + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r ExternalToolTextResultForLlmContentImage) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentImage + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func matchesEmbeddedBlobResourceContents(data []byte) bool { + var rawGroup0 struct { + Blob json.RawMessage `json:"blob"` + Text json.RawMessage `json:"text"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.Blob == nil { + return false + } + return rawGroup0.Text == nil +} + +func matchesEmbeddedTextResourceContents(data []byte) bool { + var rawGroup0 struct { + Blob json.RawMessage `json:"blob"` + Text json.RawMessage `json:"text"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.Text == nil { + return false + } + return rawGroup0.Blob == nil +} + +func unmarshalExternalToolTextResultForLlmContentResourceDetails(data []byte) (ExternalToolTextResultForLlmContentResourceDetails, error) { + if string(data) == "null" { + return nil, nil + } + if matchesEmbeddedBlobResourceContents(data) { + var d EmbeddedBlobResourceContents + if err := json.Unmarshal(data, &d); err != nil { + return nil, err } - r.Oidc = value + return &d, nil } - r.Timeout = raw.Timeout - r.Tools = raw.Tools - return nil + if matchesEmbeddedTextResourceContents(data) { + var d EmbeddedTextResourceContents + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return &RawExternalToolTextResultForLlmContentResourceDetailsData{Raw: data}, nil } -func (r *McpConfigAddRequest) UnmarshalJSON(data []byte) error { - type rawMcpConfigAddRequest struct { - Config json.RawMessage `json:"config"` - Name string `json:"name"` +func (r RawExternalToolTextResultForLlmContentResourceDetailsData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return []byte("null"), nil +} + +func (r *ExternalToolTextResultForLlmContentResource) UnmarshalJSON(data []byte) error { + type rawExternalToolTextResultForLlmContentResource struct { + Resource json.RawMessage `json:"resource"` } - var raw rawMcpConfigAddRequest + var raw rawExternalToolTextResultForLlmContentResource if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Config != nil { - value, err := unmarshalMcpServerConfig(raw.Config) + if raw.Resource != nil { + value, err := unmarshalExternalToolTextResultForLlmContentResourceDetails(raw.Resource) if err != nil { return err } - r.Config = value + r.Resource = value } - r.Name = raw.Name return nil } -func (r *McpConfigList) UnmarshalJSON(data []byte) error { - type rawMcpConfigList struct { - Servers map[string]json.RawMessage `json:"servers"` +func (r ExternalToolTextResultForLlmContentResource) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentResource + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r ExternalToolTextResultForLlmContentResourceLink) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentResourceLink + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r ExternalToolTextResultForLlmContentShellExit) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentShellExit + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r ExternalToolTextResultForLlmContentTerminal) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentTerminal + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r ExternalToolTextResultForLlmContentText) MarshalJSON() ([]byte, error) { + type alias ExternalToolTextResultForLlmContentText + return json.Marshal(struct { + Type ExternalToolTextResultForLlmContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r *ExternalToolTextResultForLlm) UnmarshalJSON(data []byte) error { + type rawExternalToolTextResultForLlm struct { + BinaryResultsForLlm []ExternalToolTextResultForLlmBinaryResultsForLlm `json:"binaryResultsForLlm,omitzero"` + Contents []json.RawMessage `json:"contents,omitzero"` + Error *string `json:"error,omitempty"` + ResultType *string `json:"resultType,omitempty"` + SessionLog *string `json:"sessionLog,omitempty"` + TextResultForLlm string `json:"textResultForLlm"` + ToolReferences []string `json:"toolReferences,omitzero"` + ToolTelemetry map[string]any `json:"toolTelemetry,omitzero"` } - var raw rawMcpConfigList + var raw rawExternalToolTextResultForLlm if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Servers != nil { - r.Servers = make(map[string]McpServerConfig, len(raw.Servers)) - for key, rawValue := range raw.Servers { - value, err := unmarshalMcpServerConfig(rawValue) + r.BinaryResultsForLlm = raw.BinaryResultsForLlm + if raw.Contents != nil { + r.Contents = make([]ExternalToolTextResultForLlmContent, 0, len(raw.Contents)) + for _, rawItem := range raw.Contents { + value, err := unmarshalExternalToolTextResultForLlmContent(rawItem) if err != nil { return err } - r.Servers[key] = value + r.Contents = append(r.Contents, value) } } + r.Error = raw.Error + r.ResultType = raw.ResultType + r.SessionLog = raw.SessionLog + r.TextResultForLlm = raw.TextResultForLlm + r.ToolReferences = raw.ToolReferences + r.ToolTelemetry = raw.ToolTelemetry return nil } -func (r *McpConfigUpdateRequest) UnmarshalJSON(data []byte) error { - type rawMcpConfigUpdateRequest struct { - Config json.RawMessage `json:"config"` - Name string `json:"name"` +func unmarshalExternalToolResult(data []byte) (ExternalToolResult, error) { + if string(data) == "null" { + return nil, nil + } + { + var value string + if err := json.Unmarshal(data, &value); err == nil { + return ExternalToolStringResult(value), nil + } } - var raw rawMcpConfigUpdateRequest + { + var value ExternalToolTextResultForLlm + if err := json.Unmarshal(data, &value); err == nil { + return &value, nil + } + } + return nil, errors.New("data did not match any union variant for ExternalToolResult") +} + +func unmarshalFactoryRunFailure(data []byte) (FactoryRunFailure, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Type FactoryRunFailureType `json:"type"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Type { + case FactoryRunFailureTypeFactoryAccountingIncomplete: + var d FactoryRunFailureFactoryAccountingIncomplete + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case FactoryRunFailureTypeFactoryDurableFailure: + var d FactoryRunFailureFactoryDurableFailure + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case FactoryRunFailureTypeFactoryLimitReached: + var d FactoryRunFailureFactoryLimitReached + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case FactoryRunFailureTypeFactoryResumeDeclined: + var d FactoryRunFailureFactoryResumeDeclined + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawFactoryRunFailureData{Discriminator: raw.Type, Raw: data}, nil + } +} + +func (r RawFactoryRunFailureData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Type FactoryRunFailureType `json:"type"` + }{ + Type: r.Discriminator, + }) +} + +func (r FactoryRunFailureFactoryAccountingIncomplete) MarshalJSON() ([]byte, error) { + type alias FactoryRunFailureFactoryAccountingIncomplete + return json.Marshal(struct { + Type FactoryRunFailureType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r FactoryRunFailureFactoryDurableFailure) MarshalJSON() ([]byte, error) { + type alias FactoryRunFailureFactoryDurableFailure + return json.Marshal(struct { + Type FactoryRunFailureType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r FactoryRunFailureFactoryLimitReached) MarshalJSON() ([]byte, error) { + type alias FactoryRunFailureFactoryLimitReached + return json.Marshal(struct { + Type FactoryRunFailureType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r FactoryRunFailureFactoryResumeDeclined) MarshalJSON() ([]byte, error) { + type alias FactoryRunFailureFactoryResumeDeclined + return json.Marshal(struct { + Type FactoryRunFailureType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + +func (r *FactoryRunTerminal) UnmarshalJSON(data []byte) error { + type rawFactoryRunTerminal struct { + Error *string `json:"error,omitempty"` + Failure json.RawMessage `json:"failure,omitempty"` + Reason *string `json:"reason,omitempty"` + ResultPreview *string `json:"resultPreview,omitempty"` + } + var raw rawFactoryRunTerminal + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.Error = raw.Error + if raw.Failure != nil { + value, err := unmarshalFactoryRunFailure(raw.Failure) + if err != nil { + return err + } + r.Failure = value + } + r.Reason = raw.Reason + r.ResultPreview = raw.ResultPreview + return nil +} + +func (r *FactoryRunResult) UnmarshalJSON(data []byte) error { + type rawFactoryRunResult struct { + Error *string `json:"error,omitempty"` + Failure json.RawMessage `json:"failure,omitempty"` + Reason *string `json:"reason,omitempty"` + Result any `json:"result,omitempty"` + RunID string `json:"runId"` + Snapshot any `json:"snapshot,omitempty"` + Status FactoryRunStatus `json:"status"` + } + var raw rawFactoryRunResult + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.Error = raw.Error + if raw.Failure != nil { + value, err := unmarshalFactoryRunFailure(raw.Failure) + if err != nil { + return err + } + r.Failure = value + } + r.Reason = raw.Reason + r.Result = raw.Result + r.RunID = raw.RunID + r.Snapshot = raw.Snapshot + r.Status = raw.Status + return nil +} + +func unmarshalFilterMapping(data []byte) (FilterMapping, error) { + if string(data) == "null" { + return nil, nil + } + { + var value FilterMappingEnumMap + if err := json.Unmarshal(data, &value); err == nil { + return value, nil + } + } + { + var value ContentFilterMode + if err := json.Unmarshal(data, &value); err == nil { + return value, nil + } + } + return nil, errors.New("data did not match any union variant for FilterMapping") +} + +func (r *HandlePendingToolCallRequest) UnmarshalJSON(data []byte) error { + type rawHandlePendingToolCallRequest struct { + Error *string `json:"error,omitempty"` + RequestID string `json:"requestId"` + Result json.RawMessage `json:"result,omitempty"` + } + var raw rawHandlePendingToolCallRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.Error = raw.Error + r.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalExternalToolResult(raw.Result) + if err != nil { + return err + } + r.Result = value + } + return nil +} + +func (r InstalledPluginSource) MarshalJSON() ([]byte, error) { + if r.InstalledPluginSourceGitHub != nil { + return json.Marshal(r.InstalledPluginSourceGitHub) + } + if r.InstalledPluginSourceLocal != nil { + return json.Marshal(r.InstalledPluginSourceLocal) + } + if r.InstalledPluginSourceURL != nil { + return json.Marshal(r.InstalledPluginSourceURL) + } + if r.String != nil { + return json.Marshal(r.String) + } + return []byte("null"), nil +} + +func (r *InstalledPluginSource) UnmarshalJSON(data []byte) error { + if string(data) == "null" { + *r = InstalledPluginSource{} + return nil + } + { + var value InstalledPluginSourceGitHub + if err := json.Unmarshal(data, &value); err == nil { + *r = InstalledPluginSource{InstalledPluginSourceGitHub: &value} + return nil + } + } + { + var value InstalledPluginSourceLocal + if err := json.Unmarshal(data, &value); err == nil { + *r = InstalledPluginSource{InstalledPluginSourceLocal: &value} + return nil + } + } + { + var value InstalledPluginSourceURL + if err := json.Unmarshal(data, &value); err == nil { + *r = InstalledPluginSource{InstalledPluginSourceURL: &value} + return nil + } + } + { + var value string + if err := json.Unmarshal(data, &value); err == nil { + *r = InstalledPluginSource{String: &value} + return nil + } + } + return errors.New("data did not match any union variant for InstalledPluginSource") +} + +func matchesMCPServerConfigHTTP(data []byte) bool { + var rawGroup0 struct { + Command json.RawMessage `json:"command"` + URL json.RawMessage `json:"url"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.URL == nil { + return false + } + return rawGroup0.Command == nil +} + +func matchesMCPServerConfigStdio(data []byte) bool { + var rawGroup0 struct { + Command json.RawMessage `json:"command"` + URL json.RawMessage `json:"url"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.Command == nil { + return false + } + return rawGroup0.URL == nil +} + +func unmarshalMCPServerConfig(data []byte) (MCPServerConfig, error) { + if string(data) == "null" { + return nil, nil + } + if matchesMCPServerConfigHTTP(data) { + var d MCPServerConfigHTTP + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesMCPServerConfigStdio(data) { + var d MCPServerConfigStdio + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return &RawMCPServerConfigData{Raw: data}, nil +} + +func (r RawMCPServerConfigData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return []byte("null"), nil +} + +func unmarshalMCPServerAuthConfig(data []byte) (MCPServerAuthConfig, error) { + if string(data) == "null" { + return nil, nil + } + { + var value bool + if err := json.Unmarshal(data, &value); err == nil { + return MCPServerAuthConfigBoolean(value), nil + } + } + { + var value MCPServerAuthConfigRedirectPort + if err := json.Unmarshal(data, &value); err == nil { + return &value, nil + } + } + return nil, errors.New("data did not match any union variant for MCPServerAuthConfig") +} + +func (r *MCPServerConfigHTTP) UnmarshalJSON(data []byte) error { + type rawMCPServerConfigHTTP struct { + Auth json.RawMessage `json:"auth,omitempty"` + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + DisableToolCache *bool `json:"disableToolCache,omitempty"` + FilterMapping json.RawMessage `json:"filterMapping,omitempty"` + Headers map[string]string `json:"headers,omitzero"` + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + OauthClientID *string `json:"oauthClientId,omitempty"` + OauthGrantType *MCPServerConfigHTTPOauthGrantType `json:"oauthGrantType,omitempty"` + OauthPublicClient *bool `json:"oauthPublicClient,omitempty"` + Oidc json.RawMessage `json:"oidc,omitempty"` + Timeout *int64 `json:"timeout,omitempty"` + Tools []string `json:"tools,omitzero"` + Type *MCPServerConfigHTTPType `json:"type,omitempty"` + URL string `json:"url"` + } + var raw rawMCPServerConfigHTTP + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Auth != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Auth) + if err != nil { + return err + } + r.Auth = value + } + r.DeferTools = raw.DeferTools + r.DisableToolCache = raw.DisableToolCache + if raw.FilterMapping != nil { + value, err := unmarshalFilterMapping(raw.FilterMapping) + if err != nil { + return err + } + r.FilterMapping = value + } + r.Headers = raw.Headers + r.IsDefaultServer = raw.IsDefaultServer + r.OauthClientID = raw.OauthClientID + r.OauthGrantType = raw.OauthGrantType + r.OauthPublicClient = raw.OauthPublicClient + if raw.Oidc != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Oidc) + if err != nil { + return err + } + r.Oidc = value + } + r.Timeout = raw.Timeout + r.Tools = raw.Tools + r.Type = raw.Type + r.URL = raw.URL + return nil +} + +func (r *MCPServerConfigStdio) UnmarshalJSON(data []byte) error { + type rawMCPServerConfigStdio struct { + Args []string `json:"args,omitzero"` + Auth json.RawMessage `json:"auth,omitempty"` + Command string `json:"command"` + Cwd *string `json:"cwd,omitempty"` + DeferTools *MCPServerConfigDeferTools `json:"deferTools,omitempty"` + DisableToolCache *bool `json:"disableToolCache,omitempty"` + Env map[string]string `json:"env,omitzero"` + FilterMapping json.RawMessage `json:"filterMapping,omitempty"` + IsDefaultServer *bool `json:"isDefaultServer,omitempty"` + Oidc json.RawMessage `json:"oidc,omitempty"` + Timeout *int64 `json:"timeout,omitempty"` + Tools []string `json:"tools,omitzero"` + } + var raw rawMCPServerConfigStdio + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.Args = raw.Args + if raw.Auth != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Auth) + if err != nil { + return err + } + r.Auth = value + } + r.Command = raw.Command + r.Cwd = raw.Cwd + r.DeferTools = raw.DeferTools + r.DisableToolCache = raw.DisableToolCache + r.Env = raw.Env + if raw.FilterMapping != nil { + value, err := unmarshalFilterMapping(raw.FilterMapping) + if err != nil { + return err + } + r.FilterMapping = value + } + r.IsDefaultServer = raw.IsDefaultServer + if raw.Oidc != nil { + value, err := unmarshalMCPServerAuthConfig(raw.Oidc) + if err != nil { + return err + } + r.Oidc = value + } + r.Timeout = raw.Timeout + r.Tools = raw.Tools + return nil +} + +func (r *MCPConfigAddRequest) UnmarshalJSON(data []byte) error { + type rawMCPConfigAddRequest struct { + Config json.RawMessage `json:"config"` + Name string `json:"name"` + } + var raw rawMCPConfigAddRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Config != nil { + value, err := unmarshalMCPServerConfig(raw.Config) + if err != nil { + return err + } + r.Config = value + } + r.Name = raw.Name + return nil +} + +func (r *MCPConfigList) UnmarshalJSON(data []byte) error { + type rawMCPConfigList struct { + Servers map[string]json.RawMessage `json:"servers"` + } + var raw rawMCPConfigList + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Servers != nil { + r.Servers = make(map[string]MCPServerConfig, len(raw.Servers)) + for key, rawValue := range raw.Servers { + value, err := unmarshalMCPServerConfig(rawValue) + if err != nil { + return err + } + r.Servers[key] = value + } + } + return nil +} + +func (r *MCPConfigUpdateRequest) UnmarshalJSON(data []byte) error { + type rawMCPConfigUpdateRequest struct { + Config json.RawMessage `json:"config"` + Name string `json:"name"` + } + var raw rawMCPConfigUpdateRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Config != nil { + value, err := unmarshalMCPServerConfig(raw.Config) + if err != nil { + return err + } + r.Config = value + } + r.Name = raw.Name + return nil +} + +func unmarshalMCPHeadersHandlePendingHeadersRefreshRequest(data []byte) (MCPHeadersHandlePendingHeadersRefreshRequest, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case MCPHeadersHandlePendingHeadersRefreshRequestKindHeaders: + var d MCPHeadersHandlePendingHeadersRefreshRequestHeaders + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPHeadersHandlePendingHeadersRefreshRequestKindNone: + var d MCPHeadersHandlePendingHeadersRefreshRequestNone + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPHeadersHandlePendingHeadersRefreshRequestData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawMCPHeadersHandlePendingHeadersRefreshRequestData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r MCPHeadersHandlePendingHeadersRefreshRequestHeaders) MarshalJSON() ([]byte, error) { + type alias MCPHeadersHandlePendingHeadersRefreshRequestHeaders + return json.Marshal(struct { + Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r MCPHeadersHandlePendingHeadersRefreshRequestNone) MarshalJSON() ([]byte, error) { + type alias MCPHeadersHandlePendingHeadersRefreshRequestNone + return json.Marshal(struct { + Kind MCPHeadersHandlePendingHeadersRefreshRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *MCPHeadersHandlePendingHeadersRefreshRequestRequest) UnmarshalJSON(data []byte) error { + type rawMCPHeadersHandlePendingHeadersRefreshRequestRequest struct { + RequestID string `json:"requestId"` + Result json.RawMessage `json:"result"` + } + var raw rawMCPHeadersHandlePendingHeadersRefreshRequestRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalMCPHeadersHandlePendingHeadersRefreshRequest(raw.Result) + if err != nil { + return err + } + r.Result = value + } + return nil +} + +func unmarshalMCPOauthPendingRequestResponse(data []byte) (MCPOauthPendingRequestResponse, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind MCPOauthPendingRequestResponseKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case MCPOauthPendingRequestResponseKindCancelled: + var d MCPOauthPendingRequestResponseCancelled + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case MCPOauthPendingRequestResponseKindToken: + var d MCPOauthPendingRequestResponseToken + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawMCPOauthPendingRequestResponseData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawMCPOauthPendingRequestResponseData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind MCPOauthPendingRequestResponseKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r MCPOauthPendingRequestResponseCancelled) MarshalJSON() ([]byte, error) { + type alias MCPOauthPendingRequestResponseCancelled + return json.Marshal(struct { + Kind MCPOauthPendingRequestResponseKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r MCPOauthPendingRequestResponseToken) MarshalJSON() ([]byte, error) { + type alias MCPOauthPendingRequestResponseToken + return json.Marshal(struct { + Kind MCPOauthPendingRequestResponseKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *MCPOauthHandlePendingRequest) UnmarshalJSON(data []byte) error { + type rawMCPOauthHandlePendingRequest struct { + RequestID string `json:"requestId"` + Result json.RawMessage `json:"result"` + } + var raw rawMCPOauthHandlePendingRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalMCPOauthPendingRequestResponse(raw.Result) + if err != nil { + return err + } + r.Result = value + } + return nil +} + +func (r *MCPRestartServerRequest) UnmarshalJSON(data []byte) error { + type rawMCPRestartServerRequest struct { + Config json.RawMessage `json:"config,omitempty"` + ServerName string `json:"serverName"` + } + var raw rawMCPRestartServerRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Config != nil { + value, err := unmarshalMCPServerConfig(raw.Config) + if err != nil { + return err + } + r.Config = value + } + r.ServerName = raw.ServerName + return nil +} + +func (r *MCPStartServerRequest) UnmarshalJSON(data []byte) error { + type rawMCPStartServerRequest struct { + Config json.RawMessage `json:"config,omitempty"` + ServerName string `json:"serverName"` + } + var raw rawMCPStartServerRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Config != nil { + value, err := unmarshalMCPServerConfig(raw.Config) + if err != nil { + return err + } + r.Config = value + } + r.ServerName = raw.ServerName + return nil +} + +func unmarshalPermissionDecision(data []byte) (PermissionDecision, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind PermissionDecisionKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case PermissionDecisionKindApproveForLocation: + var d PermissionDecisionApproveForLocation + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApproveForSession: + var d PermissionDecisionApproveForSession + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApproveOnce: + var d PermissionDecisionApproveOnce + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApprovePermanently: + var d PermissionDecisionApprovePermanently + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApproved: + var d PermissionDecisionApproved + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApprovedForLocation: + var d PermissionDecisionApprovedForLocation + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindApprovedForSession: + var d PermissionDecisionApprovedForSession + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindCancelled: + var d PermissionDecisionCancelled + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindDeniedByContentExclusionPolicy: + var d PermissionDecisionDeniedByContentExclusionPolicy + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindDeniedByPermissionRequestHook: + var d PermissionDecisionDeniedByPermissionRequestHook + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindDeniedByRules: + var d PermissionDecisionDeniedByRules + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindDeniedInteractivelyByUser: + var d PermissionDecisionDeniedInteractivelyByUser + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindDeniedNoApprovalRuleAndCouldNotRequestFromUser: + var d PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindReject: + var d PermissionDecisionReject + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionKindUserNotAvailable: + var d PermissionDecisionUserNotAvailable + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawPermissionDecisionData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawPermissionDecisionData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r PermissionDecisionApproved) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproved + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func unmarshalUserToolSessionApproval(data []byte) (UserToolSessionApproval, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind UserToolSessionApprovalKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case UserToolSessionApprovalKindCommands: + var d UserToolSessionApprovalCommands + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindCustomTool: + var d UserToolSessionApprovalCustomTool + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindExtensionManagement: + var d UserToolSessionApprovalExtensionManagement + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindExtensionPermissionAccess: + var d UserToolSessionApprovalExtensionPermissionAccess + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindFactory: + var d UserToolSessionApprovalFactory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindMCP: + var d UserToolSessionApprovalMCP + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindMemory: + var d UserToolSessionApprovalMemory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindRead: + var d UserToolSessionApprovalRead + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case UserToolSessionApprovalKindWrite: + var d UserToolSessionApprovalWrite + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + default: + return &RawUserToolSessionApprovalData{Discriminator: raw.Kind, Raw: data}, nil + } +} + +func (r RawUserToolSessionApprovalData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + }{ + Kind: r.Discriminator, + }) +} + +func (r UserToolSessionApprovalCommands) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalCommands + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalCustomTool + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalExtensionManagement) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalExtensionManagement + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalExtensionPermissionAccess + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalFactory) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalFactory + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalMCP) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalMCP + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalMemory) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalMemory + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalRead) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalRead + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r UserToolSessionApprovalWrite) MarshalJSON() ([]byte, error) { + type alias UserToolSessionApprovalWrite + return json.Marshal(struct { + Kind UserToolSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionDecisionApprovedForLocation) UnmarshalJSON(data []byte) error { + type rawPermissionDecisionApprovedForLocation struct { + Approval json.RawMessage `json:"approval"` + LocationKey string `json:"locationKey"` + } + var raw rawPermissionDecisionApprovedForLocation + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Approval != nil { + value, err := unmarshalUserToolSessionApproval(raw.Approval) + if err != nil { + return err + } + r.Approval = value + } + r.LocationKey = raw.LocationKey + return nil +} + +func (r PermissionDecisionApprovedForLocation) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApprovedForLocation + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionDecisionApprovedForSession) UnmarshalJSON(data []byte) error { + type rawPermissionDecisionApprovedForSession struct { + Approval json.RawMessage `json:"approval"` + } + var raw rawPermissionDecisionApprovedForSession if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Config != nil { - value, err := unmarshalMcpServerConfig(raw.Config) + if raw.Approval != nil { + value, err := unmarshalUserToolSessionApproval(raw.Approval) if err != nil { return err } - r.Config = value + r.Approval = value } - r.Name = raw.Name return nil } -func unmarshalPermissionDecision(data []byte) (PermissionDecision, error) { +func (r PermissionDecisionApprovedForSession) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApprovedForSession + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func unmarshalPermissionDecisionApproveForLocationApproval(data []byte) (PermissionDecisionApproveForLocationApproval, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind PermissionDecisionKind `json:"kind"` + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -958,114 +2141,214 @@ func unmarshalPermissionDecision(data []byte) (PermissionDecision, error) { } switch raw.Kind { - case PermissionDecisionKindApproveForLocation: - var d PermissionDecisionApproveForLocation - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case PermissionDecisionKindApproveForSession: - var d PermissionDecisionApproveForSession - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case PermissionDecisionKindApproveOnce: - var d PermissionDecisionApproveOnce - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case PermissionDecisionKindApprovePermanently: - var d PermissionDecisionApprovePermanently - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case PermissionDecisionKindApproved: - var d PermissionDecisionApproved - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case PermissionDecisionKindApprovedForLocation: - var d PermissionDecisionApprovedForLocation + case PermissionDecisionApproveForLocationApprovalKindCommands: + var d PermissionDecisionApproveForLocationApprovalCommands if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindApprovedForSession: - var d PermissionDecisionApprovedForSession + case PermissionDecisionApproveForLocationApprovalKindCustomTool: + var d PermissionDecisionApproveForLocationApprovalCustomTool if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindCancelled: - var d PermissionDecisionCancelled + case PermissionDecisionApproveForLocationApprovalKindExtensionManagement: + var d PermissionDecisionApproveForLocationApprovalExtensionManagement if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindDeniedByContentExclusionPolicy: - var d PermissionDecisionDeniedByContentExclusionPolicy + case PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess: + var d PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindDeniedByPermissionRequestHook: - var d PermissionDecisionDeniedByPermissionRequestHook + case PermissionDecisionApproveForLocationApprovalKindFactory: + var d PermissionDecisionApproveForLocationApprovalFactory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindDeniedByRules: - var d PermissionDecisionDeniedByRules + case PermissionDecisionApproveForLocationApprovalKindMCP: + var d PermissionDecisionApproveForLocationApprovalMCP if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindDeniedInteractivelyByUser: - var d PermissionDecisionDeniedInteractivelyByUser + case PermissionDecisionApproveForLocationApprovalKindMCPSampling: + var d PermissionDecisionApproveForLocationApprovalMCPSampling if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindDeniedNoApprovalRuleAndCouldNotRequestFromUser: - var d PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser + case PermissionDecisionApproveForLocationApprovalKindMemory: + var d PermissionDecisionApproveForLocationApprovalMemory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindReject: - var d PermissionDecisionReject + case PermissionDecisionApproveForLocationApprovalKindRead: + var d PermissionDecisionApproveForLocationApprovalRead if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionKindUserNotAvailable: - var d PermissionDecisionUserNotAvailable + case PermissionDecisionApproveForLocationApprovalKindWrite: + var d PermissionDecisionApproveForLocationApprovalWrite if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawPermissionDecisionData{Discriminator: raw.Kind, Raw: data}, nil + return &RawPermissionDecisionApproveForLocationApprovalData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawPermissionDecisionData) MarshalJSON() ([]byte, error) { +func (r RawPermissionDecisionApproveForLocationApprovalData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r PermissionDecisionApproved) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproved +func (r PermissionDecisionApproveForLocationApprovalCommands) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalCommands + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalCustomTool) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalCustomTool + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalExtensionManagement) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalExtensionManagement + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalFactory) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalFactory + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalMCP) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalMCP + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalMCPSampling) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalMCPSampling + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalMemory) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalMemory + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalRead) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalRead + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForLocationApprovalWrite) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocationApprovalWrite + return json.Marshal(struct { + Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionDecisionApproveForLocation) UnmarshalJSON(data []byte) error { + type rawPermissionDecisionApproveForLocation struct { + Approval json.RawMessage `json:"approval"` + LocationKey string `json:"locationKey"` + } + var raw rawPermissionDecisionApproveForLocation + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Approval != nil { + value, err := unmarshalPermissionDecisionApproveForLocationApproval(raw.Approval) + if err != nil { + return err + } + r.Approval = value + } + r.LocationKey = raw.LocationKey + return nil +} + +func (r PermissionDecisionApproveForLocation) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForLocation return json.Marshal(struct { Kind PermissionDecisionKind `json:"kind"` alias @@ -1075,12 +2358,12 @@ func (r PermissionDecisionApproved) MarshalJSON() ([]byte, error) { }) } -func unmarshalUserToolSessionApproval(data []byte) (UserToolSessionApproval, error) { +func unmarshalPermissionDecisionApproveForSessionApproval(data []byte) (PermissionDecisionApproveForSessionApproval, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -1088,74 +2371,86 @@ func unmarshalUserToolSessionApproval(data []byte) (UserToolSessionApproval, err } switch raw.Kind { - case UserToolSessionApprovalKindCommands: - var d UserToolSessionApprovalCommands + case PermissionDecisionApproveForSessionApprovalKindCommands: + var d PermissionDecisionApproveForSessionApprovalCommands if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindCustomTool: - var d UserToolSessionApprovalCustomTool + case PermissionDecisionApproveForSessionApprovalKindCustomTool: + var d PermissionDecisionApproveForSessionApprovalCustomTool if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindExtensionManagement: - var d UserToolSessionApprovalExtensionManagement + case PermissionDecisionApproveForSessionApprovalKindExtensionManagement: + var d PermissionDecisionApproveForSessionApprovalExtensionManagement if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindExtensionPermissionAccess: - var d UserToolSessionApprovalExtensionPermissionAccess + case PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess: + var d PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindMcp: - var d UserToolSessionApprovalMcp + case PermissionDecisionApproveForSessionApprovalKindFactory: + var d PermissionDecisionApproveForSessionApprovalFactory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindMemory: - var d UserToolSessionApprovalMemory + case PermissionDecisionApproveForSessionApprovalKindMCP: + var d PermissionDecisionApproveForSessionApprovalMCP if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindRead: - var d UserToolSessionApprovalRead + case PermissionDecisionApproveForSessionApprovalKindMCPSampling: + var d PermissionDecisionApproveForSessionApprovalMCPSampling if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserToolSessionApprovalKindWrite: - var d UserToolSessionApprovalWrite + case PermissionDecisionApproveForSessionApprovalKindMemory: + var d PermissionDecisionApproveForSessionApprovalMemory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionApproveForSessionApprovalKindRead: + var d PermissionDecisionApproveForSessionApprovalRead + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionDecisionApproveForSessionApprovalKindWrite: + var d PermissionDecisionApproveForSessionApprovalWrite if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawUserToolSessionApprovalData{Discriminator: raw.Kind, Raw: data}, nil + return &RawPermissionDecisionApproveForSessionApprovalData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawUserToolSessionApprovalData) MarshalJSON() ([]byte, error) { +func (r RawPermissionDecisionApproveForSessionApprovalData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r UserToolSessionApprovalCommands) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalCommands +func (r PermissionDecisionApproveForSessionApprovalCommands) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalCommands return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1163,10 +2458,10 @@ func (r UserToolSessionApprovalCommands) MarshalJSON() ([]byte, error) { }) } -func (r UserToolSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalCustomTool +func (r PermissionDecisionApproveForSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalCustomTool return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1174,10 +2469,10 @@ func (r UserToolSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { }) } -func (r UserToolSessionApprovalExtensionManagement) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalExtensionManagement +func (r PermissionDecisionApproveForSessionApprovalExtensionManagement) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalExtensionManagement return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1185,10 +2480,10 @@ func (r UserToolSessionApprovalExtensionManagement) MarshalJSON() ([]byte, error }) } -func (r UserToolSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalExtensionPermissionAccess +func (r PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1196,10 +2491,10 @@ func (r UserToolSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, }) } -func (r UserToolSessionApprovalMcp) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalMcp +func (r PermissionDecisionApproveForSessionApprovalFactory) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalFactory return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1207,10 +2502,10 @@ func (r UserToolSessionApprovalMcp) MarshalJSON() ([]byte, error) { }) } -func (r UserToolSessionApprovalMemory) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalMemory +func (r PermissionDecisionApproveForSessionApprovalMCP) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalMCP return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1218,10 +2513,10 @@ func (r UserToolSessionApprovalMemory) MarshalJSON() ([]byte, error) { }) } -func (r UserToolSessionApprovalRead) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalRead +func (r PermissionDecisionApproveForSessionApprovalMCPSampling) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalMCPSampling return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1229,10 +2524,10 @@ func (r UserToolSessionApprovalRead) MarshalJSON() ([]byte, error) { }) } -func (r UserToolSessionApprovalWrite) MarshalJSON() ([]byte, error) { - type alias UserToolSessionApprovalWrite +func (r PermissionDecisionApproveForSessionApprovalMemory) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalMemory return json.Marshal(struct { - Kind UserToolSessionApprovalKind `json:"kind"` + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1240,28 +2535,50 @@ func (r UserToolSessionApprovalWrite) MarshalJSON() ([]byte, error) { }) } -func (r *PermissionDecisionApprovedForLocation) UnmarshalJSON(data []byte) error { - type rawPermissionDecisionApprovedForLocation struct { - Approval json.RawMessage `json:"approval"` - LocationKey string `json:"locationKey"` +func (r PermissionDecisionApproveForSessionApprovalRead) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalRead + return json.Marshal(struct { + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionApproveForSessionApprovalWrite) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSessionApprovalWrite + return json.Marshal(struct { + Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionDecisionApproveForSession) UnmarshalJSON(data []byte) error { + type rawPermissionDecisionApproveForSession struct { + Approval json.RawMessage `json:"approval,omitempty"` + Domain *string `json:"domain,omitempty"` } - var raw rawPermissionDecisionApprovedForLocation + var raw rawPermissionDecisionApproveForSession if err := json.Unmarshal(data, &raw); err != nil { return err } if raw.Approval != nil { - value, err := unmarshalUserToolSessionApproval(raw.Approval) + value, err := unmarshalPermissionDecisionApproveForSessionApproval(raw.Approval) if err != nil { return err } r.Approval = value } - r.LocationKey = raw.LocationKey + r.Domain = raw.Domain return nil } -func (r PermissionDecisionApprovedForLocation) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApprovedForLocation +func (r PermissionDecisionApproveForSession) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveForSession return json.Marshal(struct { Kind PermissionDecisionKind `json:"kind"` alias @@ -1271,26 +2588,19 @@ func (r PermissionDecisionApprovedForLocation) MarshalJSON() ([]byte, error) { }) } -func (r *PermissionDecisionApprovedForSession) UnmarshalJSON(data []byte) error { - type rawPermissionDecisionApprovedForSession struct { - Approval json.RawMessage `json:"approval"` - } - var raw rawPermissionDecisionApprovedForSession - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - if raw.Approval != nil { - value, err := unmarshalUserToolSessionApproval(raw.Approval) - if err != nil { - return err - } - r.Approval = value - } - return nil +func (r PermissionDecisionApproveOnce) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApproveOnce + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r PermissionDecisionApprovedForSession) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApprovedForSession +func (r PermissionDecisionApprovePermanently) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionApprovePermanently return json.Marshal(struct { Kind PermissionDecisionKind `json:"kind"` alias @@ -1300,12 +2610,122 @@ func (r PermissionDecisionApprovedForSession) MarshalJSON() ([]byte, error) { }) } -func unmarshalPermissionDecisionApproveForLocationApproval(data []byte) (PermissionDecisionApproveForLocationApproval, error) { +func (r PermissionDecisionCancelled) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionCancelled + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionDeniedByContentExclusionPolicy) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionDeniedByContentExclusionPolicy + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionDeniedByPermissionRequestHook) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionDeniedByPermissionRequestHook + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionDeniedByRules) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionDeniedByRules + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionDeniedInteractivelyByUser) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionDeniedInteractivelyByUser + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionReject) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionReject + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r PermissionDecisionUserNotAvailable) MarshalJSON() ([]byte, error) { + type alias PermissionDecisionUserNotAvailable + return json.Marshal(struct { + Kind PermissionDecisionKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionDecisionRequest) UnmarshalJSON(data []byte) error { + type rawPermissionDecisionRequest struct { + DecisionContext *PermissionDecisionContext `json:"decisionContext,omitempty"` + RequestID string `json:"requestId"` + Result json.RawMessage `json:"result"` + } + var raw rawPermissionDecisionRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.DecisionContext = raw.DecisionContext + r.RequestID = raw.RequestID + if raw.Result != nil { + value, err := unmarshalPermissionDecision(raw.Result) + if err != nil { + return err + } + r.Result = value + } + return nil +} + +func unmarshalPermissionsLocationsAddToolApprovalDetails(data []byte) (PermissionsLocationsAddToolApprovalDetails, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -1313,80 +2733,86 @@ func unmarshalPermissionDecisionApproveForLocationApproval(data []byte) (Permiss } switch raw.Kind { - case PermissionDecisionApproveForLocationApprovalKindCommands: - var d PermissionDecisionApproveForLocationApprovalCommands + case PermissionsLocationsAddToolApprovalDetailsKindCommands: + var d PermissionsLocationsAddToolApprovalDetailsCommands if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindCustomTool: - var d PermissionDecisionApproveForLocationApprovalCustomTool + case PermissionsLocationsAddToolApprovalDetailsKindCustomTool: + var d PermissionsLocationsAddToolApprovalDetailsCustomTool if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindExtensionManagement: - var d PermissionDecisionApproveForLocationApprovalExtensionManagement + case PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement: + var d PermissionsLocationsAddToolApprovalDetailsExtensionManagement if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindExtensionPermissionAccess: - var d PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess + case PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess: + var d PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindMcp: - var d PermissionDecisionApproveForLocationApprovalMcp + case PermissionsLocationsAddToolApprovalDetailsKindFactory: + var d PermissionsLocationsAddToolApprovalDetailsFactory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindMcpSampling: - var d PermissionDecisionApproveForLocationApprovalMcpSampling + case PermissionsLocationsAddToolApprovalDetailsKindMCP: + var d PermissionsLocationsAddToolApprovalDetailsMCP if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindMemory: - var d PermissionDecisionApproveForLocationApprovalMemory + case PermissionsLocationsAddToolApprovalDetailsKindMCPSampling: + var d PermissionsLocationsAddToolApprovalDetailsMCPSampling if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindRead: - var d PermissionDecisionApproveForLocationApprovalRead + case PermissionsLocationsAddToolApprovalDetailsKindMemory: + var d PermissionsLocationsAddToolApprovalDetailsMemory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PermissionsLocationsAddToolApprovalDetailsKindRead: + var d PermissionsLocationsAddToolApprovalDetailsRead if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForLocationApprovalKindWrite: - var d PermissionDecisionApproveForLocationApprovalWrite + case PermissionsLocationsAddToolApprovalDetailsKindWrite: + var d PermissionsLocationsAddToolApprovalDetailsWrite if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawPermissionDecisionApproveForLocationApprovalData{Discriminator: raw.Kind, Raw: data}, nil + return &RawPermissionsLocationsAddToolApprovalDetailsData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawPermissionDecisionApproveForLocationApprovalData) MarshalJSON() ([]byte, error) { +func (r RawPermissionsLocationsAddToolApprovalDetailsData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r PermissionDecisionApproveForLocationApprovalCommands) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalCommands +func (r PermissionsLocationsAddToolApprovalDetailsCommands) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsCommands return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1394,10 +2820,10 @@ func (r PermissionDecisionApproveForLocationApprovalCommands) MarshalJSON() ([]b }) } -func (r PermissionDecisionApproveForLocationApprovalCustomTool) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalCustomTool +func (r PermissionsLocationsAddToolApprovalDetailsCustomTool) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsCustomTool return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1405,10 +2831,10 @@ func (r PermissionDecisionApproveForLocationApprovalCustomTool) MarshalJSON() ([ }) } -func (r PermissionDecisionApproveForLocationApprovalExtensionManagement) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalExtensionManagement +func (r PermissionsLocationsAddToolApprovalDetailsExtensionManagement) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsExtensionManagement return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1416,10 +2842,10 @@ func (r PermissionDecisionApproveForLocationApprovalExtensionManagement) Marshal }) } -func (r PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess +func (r PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1427,10 +2853,10 @@ func (r PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess) M }) } -func (r PermissionDecisionApproveForLocationApprovalMcp) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalMcp +func (r PermissionsLocationsAddToolApprovalDetailsFactory) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsFactory return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1438,10 +2864,10 @@ func (r PermissionDecisionApproveForLocationApprovalMcp) MarshalJSON() ([]byte, }) } -func (r PermissionDecisionApproveForLocationApprovalMcpSampling) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalMcpSampling +func (r PermissionsLocationsAddToolApprovalDetailsMCP) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsMCP return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1449,10 +2875,10 @@ func (r PermissionDecisionApproveForLocationApprovalMcpSampling) MarshalJSON() ( }) } -func (r PermissionDecisionApproveForLocationApprovalMemory) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalMemory +func (r PermissionsLocationsAddToolApprovalDetailsMCPSampling) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsMCPSampling return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1460,10 +2886,10 @@ func (r PermissionDecisionApproveForLocationApprovalMemory) MarshalJSON() ([]byt }) } -func (r PermissionDecisionApproveForLocationApprovalRead) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalRead +func (r PermissionsLocationsAddToolApprovalDetailsMemory) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsMemory return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1471,10 +2897,10 @@ func (r PermissionDecisionApproveForLocationApprovalRead) MarshalJSON() ([]byte, }) } -func (r PermissionDecisionApproveForLocationApprovalWrite) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocationApprovalWrite +func (r PermissionsLocationsAddToolApprovalDetailsRead) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsRead return json.Marshal(struct { - Kind PermissionDecisionApproveForLocationApprovalKind `json:"kind"` + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1482,17 +2908,28 @@ func (r PermissionDecisionApproveForLocationApprovalWrite) MarshalJSON() ([]byte }) } -func (r *PermissionDecisionApproveForLocation) UnmarshalJSON(data []byte) error { - type rawPermissionDecisionApproveForLocation struct { +func (r PermissionsLocationsAddToolApprovalDetailsWrite) MarshalJSON() ([]byte, error) { + type alias PermissionsLocationsAddToolApprovalDetailsWrite + return json.Marshal(struct { + Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + +func (r *PermissionLocationAddToolApprovalParams) UnmarshalJSON(data []byte) error { + type rawPermissionLocationAddToolApprovalParams struct { Approval json.RawMessage `json:"approval"` LocationKey string `json:"locationKey"` } - var raw rawPermissionDecisionApproveForLocation + var raw rawPermissionLocationAddToolApprovalParams if err := json.Unmarshal(data, &raw); err != nil { return err } if raw.Approval != nil { - value, err := unmarshalPermissionDecisionApproveForLocationApproval(raw.Approval) + value, err := unmarshalPermissionsLocationsAddToolApprovalDetails(raw.Approval) if err != nil { return err } @@ -1502,469 +2939,684 @@ func (r *PermissionDecisionApproveForLocation) UnmarshalJSON(data []byte) error return nil } -func (r PermissionDecisionApproveForLocation) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForLocation - return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func unmarshalPermissionDecisionApproveForSessionApproval(data []byte) (PermissionDecisionApproveForSessionApproval, error) { +func unmarshalPushAttachment(data []byte) (PushAttachment, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + Type PushAttachmentType `json:"type"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Kind { - case PermissionDecisionApproveForSessionApprovalKindCommands: - var d PermissionDecisionApproveForSessionApprovalCommands + switch raw.Type { + case PushAttachmentTypeBlob: + var d PushAttachmentBlob if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindCustomTool: - var d PermissionDecisionApproveForSessionApprovalCustomTool + case PushAttachmentTypeDirectory: + var d PushAttachmentDirectory if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindExtensionManagement: - var d PermissionDecisionApproveForSessionApprovalExtensionManagement + case PushAttachmentTypeExtensionContext: + var d ExtensionContextPushInput if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindExtensionPermissionAccess: - var d PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess + case PushAttachmentTypeFile: + var d PushAttachmentFile if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindMcp: - var d PermissionDecisionApproveForSessionApprovalMcp + case PushAttachmentTypeGitHubActionsJob: + var d PushAttachmentGitHubActionsJob if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindMcpSampling: - var d PermissionDecisionApproveForSessionApprovalMcpSampling + case PushAttachmentTypeGitHubCommit: + var d PushAttachmentGitHubCommit if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindMemory: - var d PermissionDecisionApproveForSessionApprovalMemory + case PushAttachmentTypeGitHubFile: + var d PushAttachmentGitHubFile if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindRead: - var d PermissionDecisionApproveForSessionApprovalRead + case PushAttachmentTypeGitHubFileDiff: + var d PushAttachmentGitHubFileDiff if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionDecisionApproveForSessionApprovalKindWrite: - var d PermissionDecisionApproveForSessionApprovalWrite + case PushAttachmentTypeGitHubReference: + var d PushAttachmentGitHubReference + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeGitHubRelease: + var d PushAttachmentGitHubRelease + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeGitHubRepository: + var d PushAttachmentGitHubRepository + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeGitHubSnippet: + var d PushAttachmentGitHubSnippet + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeGitHubTreeComparison: + var d PushAttachmentGitHubTreeComparison + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeGitHubURL: + var d PushAttachmentGitHubURL + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case PushAttachmentTypeSelection: + var d PushAttachmentSelection if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawPermissionDecisionApproveForSessionApprovalData{Discriminator: raw.Kind, Raw: data}, nil + return &RawPushAttachmentData{Discriminator: raw.Type, Raw: data}, nil } } -func (r RawPermissionDecisionApproveForSessionApprovalData) MarshalJSON() ([]byte, error) { +func (r RawPushAttachmentData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - }{ - Kind: r.Discriminator, - }) -} - -func (r PermissionDecisionApproveForSessionApprovalCommands) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalCommands - return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionDecisionApproveForSessionApprovalCustomTool) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalCustomTool - return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionDecisionApproveForSessionApprovalExtensionManagement) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalExtensionManagement - return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess - return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionDecisionApproveForSessionApprovalMcp) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalMcp - return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` - alias + Type PushAttachmentType `json:"type"` }{ - Kind: r.Kind(), - alias: alias(r), + Type: r.Discriminator, }) } -func (r PermissionDecisionApproveForSessionApprovalMcpSampling) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalMcpSampling +func (r ExtensionContextPushInput) MarshalJSON() ([]byte, error) { + type alias ExtensionContextPushInput return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionApproveForSessionApprovalMemory) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalMemory +func (r PushAttachmentBlob) MarshalJSON() ([]byte, error) { + type alias PushAttachmentBlob return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionApproveForSessionApprovalRead) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalRead +func (r PushAttachmentDirectory) MarshalJSON() ([]byte, error) { + type alias PushAttachmentDirectory return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionApproveForSessionApprovalWrite) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSessionApprovalWrite +func (r PushAttachmentFile) MarshalJSON() ([]byte, error) { + type alias PushAttachmentFile return json.Marshal(struct { - Kind PermissionDecisionApproveForSessionApprovalKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r *PermissionDecisionApproveForSession) UnmarshalJSON(data []byte) error { - type rawPermissionDecisionApproveForSession struct { - Approval json.RawMessage `json:"approval,omitempty"` - Domain *string `json:"domain,omitempty"` - } - var raw rawPermissionDecisionApproveForSession - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - if raw.Approval != nil { - value, err := unmarshalPermissionDecisionApproveForSessionApproval(raw.Approval) - if err != nil { - return err - } - r.Approval = value - } - r.Domain = raw.Domain - return nil -} - -func (r PermissionDecisionApproveForSession) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveForSession +func (r PushAttachmentGitHubActionsJob) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubActionsJob return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionApproveOnce) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApproveOnce +func (r PushAttachmentGitHubCommit) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubCommit return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionApprovePermanently) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionApprovePermanently +func (r PushAttachmentGitHubFile) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubFile return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionCancelled) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionCancelled +func (r PushAttachmentGitHubFileDiff) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubFileDiff return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionDeniedByContentExclusionPolicy) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionDeniedByContentExclusionPolicy +func (r PushAttachmentGitHubReference) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubReference return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionDeniedByPermissionRequestHook) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionDeniedByPermissionRequestHook +func (r PushAttachmentGitHubRelease) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubRelease return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionDeniedByRules) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionDeniedByRules +func (r PushAttachmentGitHubRepository) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubRepository return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionDeniedInteractivelyByUser) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionDeniedInteractivelyByUser +func (r PushAttachmentGitHubSnippet) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubSnippet return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser +func (r PushAttachmentGitHubTreeComparison) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubTreeComparison return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionReject) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionReject +func (r PushAttachmentGitHubURL) MarshalJSON() ([]byte, error) { + type alias PushAttachmentGitHubURL return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r PermissionDecisionUserNotAvailable) MarshalJSON() ([]byte, error) { - type alias PermissionDecisionUserNotAvailable +func (r PushAttachmentSelection) MarshalJSON() ([]byte, error) { + type alias PushAttachmentSelection return json.Marshal(struct { - Kind PermissionDecisionKind `json:"kind"` + Type PushAttachmentType `json:"type"` alias }{ - Kind: r.Kind(), + Type: r.Type(), alias: alias(r), }) } -func (r *PermissionDecisionRequest) UnmarshalJSON(data []byte) error { - type rawPermissionDecisionRequest struct { - RequestID string `json:"requestId"` - Result json.RawMessage `json:"result"` +func (r *QueueInsertMessage) UnmarshalJSON(data []byte) error { + type rawQueueInsertMessage struct { + AgentMode *SendAgentMode `json:"agentMode,omitempty"` + Attachments []json.RawMessage `json:"attachments,omitzero"` + Billable *bool `json:"billable,omitempty"` + Delivery *string `json:"delivery,omitempty"` + DisplayPrompt *string `json:"displayPrompt,omitempty"` + Mode *SendMode `json:"mode,omitempty"` + Prepend *bool `json:"prepend,omitempty"` + Prompt string `json:"prompt"` + RequestHeaders map[string]string `json:"requestHeaders,omitzero"` + RequiredTool *string `json:"requiredTool,omitempty"` + Source *string `json:"source,omitempty"` + Wait *bool `json:"wait,omitempty"` } - var raw rawPermissionDecisionRequest + var raw rawQueueInsertMessage if err := json.Unmarshal(data, &raw); err != nil { return err } - r.RequestID = raw.RequestID - if raw.Result != nil { - value, err := unmarshalPermissionDecision(raw.Result) - if err != nil { - return err + r.AgentMode = raw.AgentMode + if raw.Attachments != nil { + r.Attachments = make([]Attachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalAttachment(rawItem) + if err != nil { + return err + } + r.Attachments = append(r.Attachments, value) } - r.Result = value } + r.Billable = raw.Billable + r.Delivery = raw.Delivery + r.DisplayPrompt = raw.DisplayPrompt + r.Mode = raw.Mode + r.Prepend = raw.Prepend + r.Prompt = raw.Prompt + r.RequestHeaders = raw.RequestHeaders + r.RequiredTool = raw.RequiredTool + r.Source = raw.Source + r.Wait = raw.Wait return nil } -func unmarshalPermissionsLocationsAddToolApprovalDetails(data []byte) (PermissionsLocationsAddToolApprovalDetails, error) { +func unmarshalRemoteControlStatus(data []byte) (RemoteControlStatus, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + State RemoteControlStatusState `json:"state"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Kind { - case PermissionsLocationsAddToolApprovalDetailsKindCommands: - var d PermissionsLocationsAddToolApprovalDetailsCommands + switch raw.State { + case RemoteControlStatusStateActive: + var d RemoteControlStatusActive if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindCustomTool: - var d PermissionsLocationsAddToolApprovalDetailsCustomTool + case RemoteControlStatusStateConnecting: + var d RemoteControlStatusConnecting if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindExtensionManagement: - var d PermissionsLocationsAddToolApprovalDetailsExtensionManagement + case RemoteControlStatusStateError: + var d RemoteControlStatusError if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindExtensionPermissionAccess: - var d PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess + case RemoteControlStatusStateOff: + var d RemoteControlStatusOff if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindMcp: - var d PermissionsLocationsAddToolApprovalDetailsMcp - if err := json.Unmarshal(data, &d); err != nil { - return nil, err + default: + return &RawRemoteControlStatusData{Discriminator: raw.State, Raw: data}, nil + } +} + +func (r RawRemoteControlStatusData) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } + return json.Marshal(struct { + State RemoteControlStatusState `json:"state"` + }{ + State: r.Discriminator, + }) +} + +func (r RemoteControlStatusActive) MarshalJSON() ([]byte, error) { + type alias RemoteControlStatusActive + return json.Marshal(struct { + State RemoteControlStatusState `json:"state"` + alias + }{ + State: r.State(), + alias: alias(r), + }) +} + +func (r RemoteControlStatusConnecting) MarshalJSON() ([]byte, error) { + type alias RemoteControlStatusConnecting + return json.Marshal(struct { + State RemoteControlStatusState `json:"state"` + alias + }{ + State: r.State(), + alias: alias(r), + }) +} + +func (r RemoteControlStatusError) MarshalJSON() ([]byte, error) { + type alias RemoteControlStatusError + return json.Marshal(struct { + State RemoteControlStatusState `json:"state"` + alias + }{ + State: r.State(), + alias: alias(r), + }) +} + +func (r RemoteControlStatusOff) MarshalJSON() ([]byte, error) { + type alias RemoteControlStatusOff + return json.Marshal(struct { + State RemoteControlStatusState `json:"state"` + alias + }{ + State: r.State(), + alias: alias(r), + }) +} + +func (r *RemoteControlStatusResult) UnmarshalJSON(data []byte) error { + type rawRemoteControlStatusResult struct { + Status json.RawMessage `json:"status"` + } + var raw rawRemoteControlStatusResult + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Status != nil { + value, err := unmarshalRemoteControlStatus(raw.Status) + if err != nil { + return err } - return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindMcpSampling: - var d PermissionsLocationsAddToolApprovalDetailsMcpSampling - if err := json.Unmarshal(data, &d); err != nil { - return nil, err + r.Status = value + } + return nil +} + +func (r *RemoteControlStopResult) UnmarshalJSON(data []byte) error { + type rawRemoteControlStopResult struct { + Status json.RawMessage `json:"status"` + Stopped bool `json:"stopped"` + } + var raw rawRemoteControlStopResult + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Status != nil { + value, err := unmarshalRemoteControlStatus(raw.Status) + if err != nil { + return err } - return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindMemory: - var d PermissionsLocationsAddToolApprovalDetailsMemory - if err := json.Unmarshal(data, &d); err != nil { - return nil, err + r.Status = value + } + r.Stopped = raw.Stopped + return nil +} + +func (r *RemoteControlTransferResult) UnmarshalJSON(data []byte) error { + type rawRemoteControlTransferResult struct { + Status json.RawMessage `json:"status"` + Transferred bool `json:"transferred"` + } + var raw rawRemoteControlTransferResult + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Status != nil { + value, err := unmarshalRemoteControlStatus(raw.Status) + if err != nil { + return err + } + r.Status = value + } + r.Transferred = raw.Transferred + return nil +} + +func (r *SendAttachmentsToMessageParams) UnmarshalJSON(data []byte) error { + type rawSendAttachmentsToMessageParams struct { + Attachments []json.RawMessage `json:"attachments"` + InstanceID *string `json:"instanceId,omitempty"` + } + var raw rawSendAttachmentsToMessageParams + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Attachments != nil { + r.Attachments = make([]PushAttachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalPushAttachment(rawItem) + if err != nil { + return err + } + r.Attachments = append(r.Attachments, value) + } + } + r.InstanceID = raw.InstanceID + return nil +} + +func (r *SendMessageItem) UnmarshalJSON(data []byte) error { + type rawSendMessageItem struct { + Attachments []json.RawMessage `json:"attachments,omitzero"` + Billable *bool `json:"billable,omitempty"` + DisplayPrompt *string `json:"displayPrompt,omitempty"` + Prompt string `json:"prompt"` + RequiredTool *string `json:"requiredTool,omitempty"` + Source *string `json:"source,omitempty"` + } + var raw rawSendMessageItem + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Attachments != nil { + r.Attachments = make([]Attachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalAttachment(rawItem) + if err != nil { + return err + } + r.Attachments = append(r.Attachments, value) + } + } + r.Billable = raw.Billable + r.DisplayPrompt = raw.DisplayPrompt + r.Prompt = raw.Prompt + r.RequiredTool = raw.RequiredTool + r.Source = raw.Source + return nil +} + +func (r *SendRequest) UnmarshalJSON(data []byte) error { + type rawSendRequest struct { + AgentMode *SendAgentMode `json:"agentMode,omitempty"` + Attachments []json.RawMessage `json:"attachments,omitzero"` + Billable *bool `json:"billable,omitempty"` + DisplayPrompt *string `json:"displayPrompt,omitempty"` + Mode *SendMode `json:"mode,omitempty"` + Prepend *bool `json:"prepend,omitempty"` + Prompt string `json:"prompt"` + RequestHeaders map[string]string `json:"requestHeaders,omitzero"` + RequiredTool *string `json:"requiredTool,omitempty"` + Source *string `json:"source,omitempty"` + Traceparent *string `json:"traceparent,omitempty"` + Tracestate *string `json:"tracestate,omitempty"` + Wait *bool `json:"wait,omitempty"` + } + var raw rawSendRequest + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.AgentMode = raw.AgentMode + if raw.Attachments != nil { + r.Attachments = make([]Attachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalAttachment(rawItem) + if err != nil { + return err + } + r.Attachments = append(r.Attachments, value) + } + } + r.Billable = raw.Billable + r.DisplayPrompt = raw.DisplayPrompt + r.Mode = raw.Mode + r.Prepend = raw.Prepend + r.Prompt = raw.Prompt + r.RequestHeaders = raw.RequestHeaders + r.RequiredTool = raw.RequiredTool + r.Source = raw.Source + r.Traceparent = raw.Traceparent + r.Tracestate = raw.Tracestate + r.Wait = raw.Wait + return nil +} + +func (r SessionInstalledPluginSource) MarshalJSON() ([]byte, error) { + if r.SessionInstalledPluginSourceGitHub != nil { + return json.Marshal(r.SessionInstalledPluginSourceGitHub) + } + if r.SessionInstalledPluginSourceLocal != nil { + return json.Marshal(r.SessionInstalledPluginSourceLocal) + } + if r.SessionInstalledPluginSourceURL != nil { + return json.Marshal(r.SessionInstalledPluginSourceURL) + } + if r.String != nil { + return json.Marshal(r.String) + } + return []byte("null"), nil +} + +func (r *SessionInstalledPluginSource) UnmarshalJSON(data []byte) error { + if string(data) == "null" { + *r = SessionInstalledPluginSource{} + return nil + } + { + var value SessionInstalledPluginSourceGitHub + if err := json.Unmarshal(data, &value); err == nil { + *r = SessionInstalledPluginSource{SessionInstalledPluginSourceGitHub: &value} + return nil + } + } + { + var value SessionInstalledPluginSourceLocal + if err := json.Unmarshal(data, &value); err == nil { + *r = SessionInstalledPluginSource{SessionInstalledPluginSourceLocal: &value} + return nil + } + } + { + var value SessionInstalledPluginSourceURL + if err := json.Unmarshal(data, &value); err == nil { + *r = SessionInstalledPluginSource{SessionInstalledPluginSourceURL: &value} + return nil } - return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindRead: - var d PermissionsLocationsAddToolApprovalDetailsRead + } + { + var value string + if err := json.Unmarshal(data, &value); err == nil { + *r = SessionInstalledPluginSource{String: &value} + return nil + } + } + return errors.New("data did not match any union variant for SessionInstalledPluginSource") +} + +func unmarshalSessionLimitPredictionResult(data []byte) (SessionLimitPredictionResult, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Kind SessionLimitPredictionResultKind `json:"kind"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Kind { + case SessionLimitPredictionResultKindAvailable: + var d SessionLimitPredictionResultAvailable if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionsLocationsAddToolApprovalDetailsKindWrite: - var d PermissionsLocationsAddToolApprovalDetailsWrite + case SessionLimitPredictionResultKindUnavailable: + var d SessionLimitPredictionResultUnavailable if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawPermissionsLocationsAddToolApprovalDetailsData{Discriminator: raw.Kind, Raw: data}, nil + return &RawSessionLimitPredictionResultData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawPermissionsLocationsAddToolApprovalDetailsData) MarshalJSON() ([]byte, error) { +func (r RawSessionLimitPredictionResultData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + Kind SessionLimitPredictionResultKind `json:"kind"` }{ Kind: r.Discriminator, }) } -func (r PermissionsLocationsAddToolApprovalDetailsCommands) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsCommands - return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionsLocationsAddToolApprovalDetailsCustomTool) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsCustomTool - return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} - -func (r PermissionsLocationsAddToolApprovalDetailsExtensionManagement) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsExtensionManagement +func (r SessionLimitPredictionResultAvailable) MarshalJSON() ([]byte, error) { + type alias SessionLimitPredictionResultAvailable return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + Kind SessionLimitPredictionResultKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1972,10 +3624,10 @@ func (r PermissionsLocationsAddToolApprovalDetailsExtensionManagement) MarshalJS }) } -func (r PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess +func (r SessionLimitPredictionResultUnavailable) MarshalJSON() ([]byte, error) { + type alias SessionLimitPredictionResultUnavailable return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + Kind SessionLimitPredictionResultKind `json:"kind"` alias }{ Kind: r.Kind(), @@ -1983,290 +3635,377 @@ func (r PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess) Mar }) } -func (r PermissionsLocationsAddToolApprovalDetailsMcp) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsMcp - return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) -} +func unmarshalSessionListEntry(data []byte) (SessionListEntry, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + IsRemote *bool `json:"isRemote"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + if raw.IsRemote == nil { + return nil, errors.New("data did not match any union variant for SessionListEntry") + } -func (r PermissionsLocationsAddToolApprovalDetailsMcpSampling) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsMcpSampling - return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) + switch *raw.IsRemote { + case false: + var d LocalSessionMetadataValue + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case true: + var d RemoteSessionMetadataValue + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return nil, errors.New("data did not match any union variant for SessionListEntry") } -func (r PermissionsLocationsAddToolApprovalDetailsMemory) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsMemory +func (r LocalSessionMetadataValue) MarshalJSON() ([]byte, error) { + type alias LocalSessionMetadataValue return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + IsRemote bool `json:"isRemote"` alias }{ - Kind: r.Kind(), - alias: alias(r), + IsRemote: r.sessionListEntryIsRemote(), + alias: alias(r), }) } -func (r PermissionsLocationsAddToolApprovalDetailsRead) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsRead +func (r RemoteSessionMetadataValue) MarshalJSON() ([]byte, error) { + type alias RemoteSessionMetadataValue return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` + IsRemote bool `json:"isRemote"` alias }{ - Kind: r.Kind(), - alias: alias(r), + IsRemote: r.sessionListEntryIsRemote(), + alias: alias(r), }) } -func (r PermissionsLocationsAddToolApprovalDetailsWrite) MarshalJSON() ([]byte, error) { - type alias PermissionsLocationsAddToolApprovalDetailsWrite - return json.Marshal(struct { - Kind PermissionsLocationsAddToolApprovalDetailsKind `json:"kind"` - alias - }{ - Kind: r.Kind(), - alias: alias(r), - }) +func (r *SessionList) UnmarshalJSON(data []byte) error { + type rawSessionList struct { + Sessions []json.RawMessage `json:"sessions"` + } + var raw rawSessionList + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Sessions != nil { + r.Sessions = make([]SessionListEntry, 0, len(raw.Sessions)) + for _, rawItem := range raw.Sessions { + value, err := unmarshalSessionListEntry(rawItem) + if err != nil { + return err + } + r.Sessions = append(r.Sessions, value) + } + } + return nil } -func (r *PermissionLocationAddToolApprovalParams) UnmarshalJSON(data []byte) error { - type rawPermissionLocationAddToolApprovalParams struct { - Approval json.RawMessage `json:"approval"` - LocationKey string `json:"locationKey"` - } - var raw rawPermissionLocationAddToolApprovalParams +func (r *SessionOpenOptions) UnmarshalJSON(data []byte) error { + type rawSessionOpenOptions struct { + AdditionalContentExclusionPolicies []SessionOpenOptionsAdditionalContentExclusionPolicy `json:"additionalContentExclusionPolicies,omitzero"` + AdditionalDirectories []string `json:"additionalDirectories,omitzero"` + AgentContext *string `json:"agentContext,omitempty"` + AllowAllMCPServerInstructions *bool `json:"allowAllMcpServerInstructions,omitempty"` + AskUserDisabled *bool `json:"askUserDisabled,omitempty"` + AuthInfo json.RawMessage `json:"authInfo,omitempty"` + AvailableTools []string `json:"availableTools,omitzero"` + Capi *CapiSessionOptions `json:"capi,omitempty"` + ClientKind *string `json:"clientKind,omitempty"` + ClientName *string `json:"clientName,omitempty"` + CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` + ConfigDir *string `json:"configDir,omitempty"` + ContinueOnAutoMode *bool `json:"continueOnAutoMode,omitempty"` + CopilotURL *string `json:"copilotUrl,omitempty"` + CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` + DetachedFromSpawningParentEngagementID *string `json:"detachedFromSpawningParentEngagementId,omitempty"` + DetachedFromSpawningParentSessionID *string `json:"detachedFromSpawningParentSessionId,omitempty"` + DisabledInstructionSources []string `json:"disabledInstructionSources,omitzero"` + DisabledMCPServers []string `json:"disabledMcpServers,omitzero"` + DisabledSkills []string `json:"disabledSkills,omitzero"` + EnableCitations *bool `json:"enableCitations,omitempty"` + EnableFileChangeTracking *bool `json:"enableFileChangeTracking,omitempty"` + EnableManagedSettings *bool `json:"enableManagedSettings,omitempty"` + EnableOnDemandInstructionDiscovery *bool `json:"enableOnDemandInstructionDiscovery,omitempty"` + EnableScriptSafety *bool `json:"enableScriptSafety,omitempty"` + EnableStreaming *bool `json:"enableStreaming,omitempty"` + EnvValueMode *SessionOpenOptionsEnvValueMode `json:"envValueMode,omitempty"` + EventsLogDirectory *string `json:"eventsLogDirectory,omitempty"` + EventsLogIncludesSubagents *bool `json:"eventsLogIncludesSubagents,omitempty"` + ExcludedBuiltinAgents []string `json:"excludedBuiltinAgents,omitzero"` + ExcludedTools []string `json:"excludedTools,omitzero"` + ExpAssignments any `json:"expAssignments,omitempty"` + FeatureFlags map[string]bool `json:"featureFlags,omitzero"` + IncludedBuiltinAgents []string `json:"includedBuiltinAgents,omitzero"` + InstalledPlugins []InstalledPlugin `json:"installedPlugins,omitzero"` + IntegrationID *string `json:"integrationId,omitempty"` + IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` + LogInteractiveShells *bool `json:"logInteractiveShells,omitempty"` + LspClientName *string `json:"lspClientName,omitempty"` + ManagedSettings *SessionManagedSettings `json:"managedSettings,omitempty"` + MaxInlineBinaryBytes *int64 `json:"maxInlineBinaryBytes,omitempty"` + Memory *MemoryConfiguration `json:"memory,omitempty"` + Model *string `json:"model,omitempty"` + ModelCapabilitiesOverrides *ModelCapabilitiesOverride `json:"modelCapabilitiesOverrides,omitempty"` + Models []ProviderModelConfig `json:"models,omitzero"` + Name *string `json:"name,omitempty"` + Provider *ProviderConfig `json:"provider,omitempty"` + Providers []NamedProviderConfig `json:"providers,omitzero"` + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + ReasoningSummary *SessionOpenOptionsReasoningSummary `json:"reasoningSummary,omitempty"` + RemoteDefaultedOn *bool `json:"remoteDefaultedOn,omitempty"` + RemoteExporting *bool `json:"remoteExporting,omitempty"` + RemoteSteerable *bool `json:"remoteSteerable,omitempty"` + RunningInInteractiveMode *bool `json:"runningInInteractiveMode,omitempty"` + SandboxConfig *SandboxConfig `json:"sandboxConfig,omitempty"` + SessionCapabilities []SessionCapability `json:"sessionCapabilities,omitzero"` + SessionID *string `json:"sessionId,omitempty"` + SessionLimits *SessionLimitsConfig `json:"sessionLimits,omitempty"` + Shell *ShellOptions `json:"shell,omitempty"` + ShellInitProfile *string `json:"shellInitProfile,omitempty"` + ShellProcessFlags []string `json:"shellProcessFlags,omitzero"` + SkillDirectories []string `json:"skillDirectories,omitzero"` + SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` + TrajectoryFile *string `json:"trajectoryFile,omitempty"` + Verbosity *Verbosity `json:"verbosity,omitempty"` + WorkingDirectory *string `json:"workingDirectory,omitempty"` + WorkingDirectoryContext *SessionContext `json:"workingDirectoryContext,omitempty"` + } + var raw rawSessionOpenOptions if err := json.Unmarshal(data, &raw); err != nil { return err } - if raw.Approval != nil { - value, err := unmarshalPermissionsLocationsAddToolApprovalDetails(raw.Approval) + r.AdditionalContentExclusionPolicies = raw.AdditionalContentExclusionPolicies + r.AdditionalDirectories = raw.AdditionalDirectories + r.AgentContext = raw.AgentContext + r.AllowAllMCPServerInstructions = raw.AllowAllMCPServerInstructions + r.AskUserDisabled = raw.AskUserDisabled + if raw.AuthInfo != nil { + value, err := unmarshalAuthInfo(raw.AuthInfo) if err != nil { return err } - r.Approval = value - } - r.LocationKey = raw.LocationKey + r.AuthInfo = value + } + r.AvailableTools = raw.AvailableTools + r.Capi = raw.Capi + r.ClientKind = raw.ClientKind + r.ClientName = raw.ClientName + r.CoauthorEnabled = raw.CoauthorEnabled + r.ConfigDir = raw.ConfigDir + r.ContinueOnAutoMode = raw.ContinueOnAutoMode + r.CopilotURL = raw.CopilotURL + r.CustomAgentsLocalOnly = raw.CustomAgentsLocalOnly + r.DetachedFromSpawningParentEngagementID = raw.DetachedFromSpawningParentEngagementID + r.DetachedFromSpawningParentSessionID = raw.DetachedFromSpawningParentSessionID + r.DisabledInstructionSources = raw.DisabledInstructionSources + r.DisabledMCPServers = raw.DisabledMCPServers + r.DisabledSkills = raw.DisabledSkills + r.EnableCitations = raw.EnableCitations + r.EnableFileChangeTracking = raw.EnableFileChangeTracking + r.EnableManagedSettings = raw.EnableManagedSettings + r.EnableOnDemandInstructionDiscovery = raw.EnableOnDemandInstructionDiscovery + r.EnableScriptSafety = raw.EnableScriptSafety + r.EnableStreaming = raw.EnableStreaming + r.EnvValueMode = raw.EnvValueMode + r.EventsLogDirectory = raw.EventsLogDirectory + r.EventsLogIncludesSubagents = raw.EventsLogIncludesSubagents + r.ExcludedBuiltinAgents = raw.ExcludedBuiltinAgents + r.ExcludedTools = raw.ExcludedTools + r.ExpAssignments = raw.ExpAssignments + r.FeatureFlags = raw.FeatureFlags + r.IncludedBuiltinAgents = raw.IncludedBuiltinAgents + r.InstalledPlugins = raw.InstalledPlugins + r.IntegrationID = raw.IntegrationID + r.IsExperimentalMode = raw.IsExperimentalMode + r.LogInteractiveShells = raw.LogInteractiveShells + r.LspClientName = raw.LspClientName + r.ManagedSettings = raw.ManagedSettings + r.MaxInlineBinaryBytes = raw.MaxInlineBinaryBytes + r.Memory = raw.Memory + r.Model = raw.Model + r.ModelCapabilitiesOverrides = raw.ModelCapabilitiesOverrides + r.Models = raw.Models + r.Name = raw.Name + r.Provider = raw.Provider + r.Providers = raw.Providers + r.ReasoningEffort = raw.ReasoningEffort + r.ReasoningSummary = raw.ReasoningSummary + r.RemoteDefaultedOn = raw.RemoteDefaultedOn + r.RemoteExporting = raw.RemoteExporting + r.RemoteSteerable = raw.RemoteSteerable + r.RunningInInteractiveMode = raw.RunningInInteractiveMode + r.SandboxConfig = raw.SandboxConfig + r.SessionCapabilities = raw.SessionCapabilities + r.SessionID = raw.SessionID + r.SessionLimits = raw.SessionLimits + r.Shell = raw.Shell + r.ShellInitProfile = raw.ShellInitProfile + r.ShellProcessFlags = raw.ShellProcessFlags + r.SkillDirectories = raw.SkillDirectories + r.SkipCustomInstructions = raw.SkipCustomInstructions + r.TrajectoryFile = raw.TrajectoryFile + r.Verbosity = raw.Verbosity + r.WorkingDirectory = raw.WorkingDirectory + r.WorkingDirectoryContext = raw.WorkingDirectoryContext return nil } -func unmarshalSendAttachment(data []byte) (SendAttachment, error) { +func unmarshalSessionOpenParams(data []byte) (SessionOpenParams, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { return nil, err } - switch raw.Type { - case SendAttachmentTypeBlob: - var d SendAttachmentBlob + switch raw.Kind { + case SessionOpenParamsKindAttach: + var d SessionsOpenAttach + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SessionOpenParamsKindCloud: + var d SessionsOpenCloud if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case SendAttachmentTypeDirectory: - var d SendAttachmentDirectory + case SessionOpenParamsKindCreate: + var d SessionsOpenCreate if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case SendAttachmentTypeFile: - var d SendAttachmentFile + case SessionOpenParamsKindHandoff: + var d SessionsOpenHandoff if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case SendAttachmentTypeGithubReference: - var d SendAttachmentGithubReference + case SessionOpenParamsKindRemote: + var d SessionsOpenRemote if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case SendAttachmentTypeSelection: - var d SendAttachmentSelection + case SessionOpenParamsKindResume: + var d SessionsOpenResume + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + case SessionOpenParamsKindResumeLast: + var d SessionsOpenResumeLast if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawSendAttachmentData{Discriminator: raw.Type, Raw: data}, nil + return &RawSessionOpenParamsData{Discriminator: raw.Kind, Raw: data}, nil } } -func (r RawSendAttachmentData) MarshalJSON() ([]byte, error) { +func (r RawSessionOpenParamsData) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` }{ - Type: r.Discriminator, + Kind: r.Discriminator, }) } -func (r SendAttachmentBlob) MarshalJSON() ([]byte, error) { - type alias SendAttachmentBlob +func (r SessionsOpenAttach) MarshalJSON() ([]byte, error) { + type alias SessionsOpenAttach return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r SendAttachmentDirectory) MarshalJSON() ([]byte, error) { - type alias SendAttachmentDirectory +func (r SessionsOpenCloud) MarshalJSON() ([]byte, error) { + type alias SessionsOpenCloud return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r SendAttachmentFile) MarshalJSON() ([]byte, error) { - type alias SendAttachmentFile +func (r SessionsOpenCreate) MarshalJSON() ([]byte, error) { + type alias SessionsOpenCreate return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r SendAttachmentGithubReference) MarshalJSON() ([]byte, error) { - type alias SendAttachmentGithubReference +func (r SessionsOpenHandoff) MarshalJSON() ([]byte, error) { + type alias SessionsOpenHandoff return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r SendAttachmentSelection) MarshalJSON() ([]byte, error) { - type alias SendAttachmentSelection +func (r SessionsOpenRemote) MarshalJSON() ([]byte, error) { + type alias SessionsOpenRemote return json.Marshal(struct { - Type SendAttachmentType `json:"type"` + Kind SessionOpenParamsKind `json:"kind"` alias }{ - Type: r.Type(), + Kind: r.Kind(), alias: alias(r), }) } -func (r *SendRequest) UnmarshalJSON(data []byte) error { - type rawSendRequest struct { - AgentMode *SendAgentMode `json:"agentMode,omitempty"` - Attachments []json.RawMessage `json:"attachments,omitempty"` - Billable *bool `json:"billable,omitempty"` - DisplayPrompt *string `json:"displayPrompt,omitempty"` - Mode *SendMode `json:"mode,omitempty"` - Prepend *bool `json:"prepend,omitempty"` - Prompt string `json:"prompt"` - RequestHeaders map[string]string `json:"requestHeaders,omitempty"` - RequiredTool *string `json:"requiredTool,omitempty"` - Source any `json:"source,omitempty"` - Traceparent *string `json:"traceparent,omitempty"` - Tracestate *string `json:"tracestate,omitempty"` - Wait *bool `json:"wait,omitempty"` - } - var raw rawSendRequest - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - r.AgentMode = raw.AgentMode - if raw.Attachments != nil { - r.Attachments = make([]SendAttachment, 0, len(raw.Attachments)) - for _, rawItem := range raw.Attachments { - value, err := unmarshalSendAttachment(rawItem) - if err != nil { - return err - } - r.Attachments = append(r.Attachments, value) - } - } - r.Billable = raw.Billable - r.DisplayPrompt = raw.DisplayPrompt - r.Mode = raw.Mode - r.Prepend = raw.Prepend - r.Prompt = raw.Prompt - r.RequestHeaders = raw.RequestHeaders - r.RequiredTool = raw.RequiredTool - r.Source = raw.Source - r.Traceparent = raw.Traceparent - r.Tracestate = raw.Tracestate - r.Wait = raw.Wait - return nil -} - -func (r SessionInstalledPluginSource) MarshalJSON() ([]byte, error) { - if r.SessionInstalledPluginSourceGithub != nil { - return json.Marshal(r.SessionInstalledPluginSourceGithub) - } - if r.SessionInstalledPluginSourceLocal != nil { - return json.Marshal(r.SessionInstalledPluginSourceLocal) - } - if r.SessionInstalledPluginSourceURL != nil { - return json.Marshal(r.SessionInstalledPluginSourceURL) - } - if r.String != nil { - return json.Marshal(r.String) - } - return []byte("null"), nil +func (r SessionsOpenResume) MarshalJSON() ([]byte, error) { + type alias SessionsOpenResume + return json.Marshal(struct { + Kind SessionOpenParamsKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } -func (r *SessionInstalledPluginSource) UnmarshalJSON(data []byte) error { - if string(data) == "null" { - *r = SessionInstalledPluginSource{} - return nil - } - { - var value SessionInstalledPluginSourceGithub - if err := json.Unmarshal(data, &value); err == nil { - *r = SessionInstalledPluginSource{SessionInstalledPluginSourceGithub: &value} - return nil - } - } - { - var value SessionInstalledPluginSourceLocal - if err := json.Unmarshal(data, &value); err == nil { - *r = SessionInstalledPluginSource{SessionInstalledPluginSourceLocal: &value} - return nil - } - } - { - var value SessionInstalledPluginSourceURL - if err := json.Unmarshal(data, &value); err == nil { - *r = SessionInstalledPluginSource{SessionInstalledPluginSourceURL: &value} - return nil - } - } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - *r = SessionInstalledPluginSource{String: &value} - return nil - } - } - return errors.New("data did not match any union variant for SessionInstalledPluginSource") +func (r SessionsOpenResumeLast) MarshalJSON() ([]byte, error) { + type alias SessionsOpenResumeLast + return json.Marshal(struct { + Kind SessionOpenParamsKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) } func (r *SessionSetCredentialsParams) UnmarshalJSON(data []byte) error { @@ -2887,7 +4626,7 @@ func (r UIElicitationStringOneOfField) MarshalJSON() ([]byte, error) { func (r *UIElicitationSchema) UnmarshalJSON(data []byte) error { type rawUIElicitationSchema struct { Properties map[string]json.RawMessage `json:"properties"` - Required []string `json:"required,omitempty"` + Required []string `json:"required,omitzero"` Type UIElicitationSchemaType `json:"type"` } var raw rawUIElicitationSchema @@ -2912,7 +4651,7 @@ func (r *UIElicitationSchema) UnmarshalJSON(data []byte) error { func (r *UIElicitationResponse) UnmarshalJSON(data []byte) error { type rawUIElicitationResponse struct { Action UIElicitationResponseAction `json:"action"` - Content map[string]json.RawMessage `json:"content,omitempty"` + Content map[string]json.RawMessage `json:"content,omitzero"` } var raw rawUIElicitationResponse if err := json.Unmarshal(data, &raw); err != nil { diff --git a/go/rpc/zsession_encoding.go b/go/rpc/zsession_encoding.go index f06e3b398..05e466012 100644 --- a/go/rpc/zsession_encoding.go +++ b/go/rpc/zsession_encoding.go @@ -41,6 +41,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeAssistantIdle: + var d AssistantIdleData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeAssistantIntent: var d AssistantIntentData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -77,18 +83,36 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeAssistantServerToolProgress: + var d AssistantServerToolProgressData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeAssistantStreamingDelta: var d AssistantStreamingDeltaData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d + case SessionEventTypeAssistantToolCallDelta: + var d AssistantToolCallDeltaData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeAssistantTurnEnd: var d AssistantTurnEndData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d + case SessionEventTypeAssistantTurnRetry: + var d AssistantTurnRetryData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeAssistantTurnStart: var d AssistantTurnStartData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -179,6 +203,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeFactoryRunUpdated: + var d FactoryRunUpdatedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeHookEnd: var d HookEndData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -197,20 +227,50 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d - case SessionEventTypeMcpAppToolCallComplete: - var d McpAppToolCallCompleteData + case SessionEventTypeMCPAppToolCallComplete: + var d MCPAppToolCallCompleteData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeMCPHeadersRefreshCompleted: + var d MCPHeadersRefreshCompletedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeMCPHeadersRefreshRequired: + var d MCPHeadersRefreshRequiredData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeMCPOauthCompleted: + var d MCPOauthCompletedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeMCPOauthRequired: + var d MCPOauthRequiredData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeMCPPromptsListChanged: + var d MCPPromptsListChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d - case SessionEventTypeMcpOauthCompleted: - var d McpOauthCompletedData + case SessionEventTypeMCPResourcesListChanged: + var d MCPResourcesListChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d - case SessionEventTypeMcpOauthRequired: - var d McpOauthRequiredData + case SessionEventTypeMCPToolsListChanged: + var d MCPToolsListChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } @@ -221,6 +281,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeModelCallStart: + var d ModelCallStartData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypePendingMessagesModified: var d PendingMessagesModifiedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -251,6 +317,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionAutoModeResolved: + var d SessionAutoModeResolvedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionAutopilotObjectiveChanged: var d SessionAutopilotObjectiveChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -263,18 +335,48 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionBinaryAsset: + var d SessionBinaryAssetData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionCanvasClosed: + var d SessionCanvasClosedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionCanvasOpened: var d SessionCanvasOpenedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d + case SessionEventTypeSessionCanvasRecorded: + var d SessionCanvasRecordedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionCanvasRegistryChanged: var d SessionCanvasRegistryChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d + case SessionEventTypeSessionCanvasRemoved: + var d SessionCanvasRemovedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionCanvasUnavailable: + var d SessionCanvasUnavailableData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionCompactionComplete: var d SessionCompactionCompleteData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -293,6 +395,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionContextCleared: + var d SessionContextClearedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionCustomAgentsUpdated: var d SessionCustomAgentsUpdatedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -311,6 +419,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionExtensionsAttachmentsPushed: + var d SessionExtensionsAttachmentsPushedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionExtensionsLoaded: var d SessionExtensionsLoadedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -335,14 +449,38 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d - case SessionEventTypeSessionMcpServersLoaded: - var d SessionMcpServersLoadedData + case SessionEventTypeSessionLimitsExhaustedCompleted: + var d SessionLimitsExhaustedCompletedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } e.Data = &d - case SessionEventTypeSessionMcpServerStatusChanged: - var d SessionMcpServerStatusChangedData + case SessionEventTypeSessionLimitsExhaustedRequested: + var d SessionLimitsExhaustedRequestedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionManagedSettingsEnforced: + var d SessionManagedSettingsEnforcedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionManagedSettingsResolved: + var d SessionManagedSettingsResolvedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionMCPServersLoaded: + var d SessionMCPServersLoadedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionMCPServerStatusChanged: + var d SessionMCPServerStatusChangedData if err := json.Unmarshal(raw.Data, &d); err != nil { return err } @@ -395,6 +533,18 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionScheduleRearmed: + var d SessionScheduleRearmedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d + case SessionEventTypeSessionSessionLimitsChanged: + var d SessionSessionLimitsChangedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionShutdown: var d SessionShutdownData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -431,6 +581,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionTodosChanged: + var d SessionTodosChangedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionToolsUpdated: var d SessionToolsUpdatedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -443,6 +599,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeSessionUsageCheckpoint: + var d SessionUsageCheckpointData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeSessionUsageInfo: var d SessionUsageInfoData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -533,6 +695,12 @@ func (e *SessionEvent) UnmarshalJSON(data []byte) error { return err } e.Data = &d + case SessionEventTypeToolSearchActivated: + var d ToolSearchActivatedData + if err := json.Unmarshal(raw.Data, &d); err != nil { + return err + } + e.Data = &d case SessionEventTypeToolUserRequested: var d ToolUserRequestedData if err := json.Unmarshal(raw.Data, &d); err != nil { @@ -592,12 +760,53 @@ func (r RawSessionEventData) MarshalJSON() ([]byte, error) { return r.Raw, nil } -func unmarshalUserMessageAttachment(data []byte) (UserMessageAttachment, error) { +func (r *UserMessageData) UnmarshalJSON(data []byte) error { + type rawUserMessageData struct { + AgentMode *UserMessageAgentMode `json:"agentMode,omitempty"` + Attachments []json.RawMessage `json:"attachments,omitzero"` + Content string `json:"content"` + Delivery *UserMessageDelivery `json:"delivery,omitempty"` + InteractionID *string `json:"interactionId,omitempty"` + IsAutopilotContinuation *bool `json:"isAutopilotContinuation,omitempty"` + NativeDocumentPathFallbackPaths []string `json:"nativeDocumentPathFallbackPaths,omitzero"` + ParentAgentTaskID *string `json:"parentAgentTaskId,omitempty"` + Source *string `json:"source,omitempty"` + SupportedNativeDocumentMIMETypes []string `json:"supportedNativeDocumentMimeTypes,omitzero"` + TransformedContent *string `json:"transformedContent,omitempty"` + } + var raw rawUserMessageData + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.AgentMode = raw.AgentMode + if raw.Attachments != nil { + r.Attachments = make([]Attachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalAttachment(rawItem) + if err != nil { + return err + } + r.Attachments = append(r.Attachments, value) + } + } + r.Content = raw.Content + r.Delivery = raw.Delivery + r.InteractionID = raw.InteractionID + r.IsAutopilotContinuation = raw.IsAutopilotContinuation + r.NativeDocumentPathFallbackPaths = raw.NativeDocumentPathFallbackPaths + r.ParentAgentTaskID = raw.ParentAgentTaskID + r.Source = raw.Source + r.SupportedNativeDocumentMIMETypes = raw.SupportedNativeDocumentMIMETypes + r.TransformedContent = raw.TransformedContent + return nil +} + +func unmarshalCitationLocation(data []byte) (CitationLocation, error) { if string(data) == "null" { return nil, nil } type rawUnion struct { - Type UserMessageAttachmentType `json:"type"` + Type CitationLocationType `json:"type"` } var raw rawUnion if err := json.Unmarshal(data, &raw); err != nil { @@ -605,56 +814,44 @@ func unmarshalUserMessageAttachment(data []byte) (UserMessageAttachment, error) } switch raw.Type { - case UserMessageAttachmentTypeBlob: - var d UserMessageAttachmentBlob - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case UserMessageAttachmentTypeDirectory: - var d UserMessageAttachmentDirectory - if err := json.Unmarshal(data, &d); err != nil { - return nil, err - } - return &d, nil - case UserMessageAttachmentTypeFile: - var d UserMessageAttachmentFile + case CitationLocationTypeBlock: + var d CitationLocationBlock if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserMessageAttachmentTypeGithubReference: - var d UserMessageAttachmentGithubReference + case CitationLocationTypeChar: + var d CitationLocationChar if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case UserMessageAttachmentTypeSelection: - var d UserMessageAttachmentSelection + case CitationLocationTypePage: + var d CitationLocationPage if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil default: - return &RawUserMessageAttachment{Discriminator: raw.Type, Raw: data}, nil + return &RawCitationLocation{Discriminator: raw.Type, Raw: data}, nil } } -func (r RawUserMessageAttachment) MarshalJSON() ([]byte, error) { +func (r RawCitationLocation) MarshalJSON() ([]byte, error) { if r.Raw != nil { return r.Raw, nil } return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type CitationLocationType `json:"type"` }{ Type: r.Discriminator, }) } -func (r UserMessageAttachmentBlob) MarshalJSON() ([]byte, error) { - type alias UserMessageAttachmentBlob +func (r CitationLocationBlock) MarshalJSON() ([]byte, error) { + type alias CitationLocationBlock return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type CitationLocationType `json:"type"` alias }{ Type: r.Type(), @@ -662,10 +859,10 @@ func (r UserMessageAttachmentBlob) MarshalJSON() ([]byte, error) { }) } -func (r UserMessageAttachmentDirectory) MarshalJSON() ([]byte, error) { - type alias UserMessageAttachmentDirectory +func (r CitationLocationChar) MarshalJSON() ([]byte, error) { + type alias CitationLocationChar return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type CitationLocationType `json:"type"` alias }{ Type: r.Type(), @@ -673,10 +870,10 @@ func (r UserMessageAttachmentDirectory) MarshalJSON() ([]byte, error) { }) } -func (r UserMessageAttachmentFile) MarshalJSON() ([]byte, error) { - type alias UserMessageAttachmentFile +func (r CitationLocationPage) MarshalJSON() ([]byte, error) { + type alias CitationLocationPage return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type CitationLocationType `json:"type"` alias }{ Type: r.Type(), @@ -684,10 +881,175 @@ func (r UserMessageAttachmentFile) MarshalJSON() ([]byte, error) { }) } -func (r UserMessageAttachmentGithubReference) MarshalJSON() ([]byte, error) { - type alias UserMessageAttachmentGithubReference +func (r *CitationReference) UnmarshalJSON(data []byte) error { + type rawCitationReference struct { + CitedText *string `json:"citedText,omitempty"` + Location json.RawMessage `json:"location,omitempty"` + ProviderMetadata any `json:"providerMetadata,omitempty"` + SourceID string `json:"sourceId"` + } + var raw rawCitationReference + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + r.CitedText = raw.CitedText + if raw.Location != nil { + value, err := unmarshalCitationLocation(raw.Location) + if err != nil { + return err + } + r.Location = value + } + r.ProviderMetadata = raw.ProviderMetadata + r.SourceID = raw.SourceID + return nil +} + +func matchesBinaryAssetReference(data []byte) bool { + var rawGroup0 struct { + AssetID json.RawMessage `json:"assetId"` + ByteLength json.RawMessage `json:"byteLength"` + Data json.RawMessage `json:"data"` + OmittedReason json.RawMessage `json:"omittedReason"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.AssetID == nil { + return false + } + if rawGroup0.ByteLength == nil { + return false + } + if rawGroup0.Data != nil { + return false + } + return rawGroup0.OmittedReason == nil +} + +func matchesOmittedBinaryResult(data []byte) bool { + var rawGroup0 struct { + AssetID json.RawMessage `json:"assetId"` + ByteLength json.RawMessage `json:"byteLength"` + Data json.RawMessage `json:"data"` + OmittedReason json.RawMessage `json:"omittedReason"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.ByteLength == nil { + return false + } + if rawGroup0.OmittedReason == nil { + return false + } + if rawGroup0.AssetID != nil { + return false + } + return rawGroup0.Data == nil +} + +func matchesPersistedBinaryImage(data []byte) bool { + var rawGroup0 struct { + AssetID json.RawMessage `json:"assetId"` + ByteLength json.RawMessage `json:"byteLength"` + Data json.RawMessage `json:"data"` + OmittedReason json.RawMessage `json:"omittedReason"` + } + if err := json.Unmarshal(data, &rawGroup0); err != nil { + return false + } + if rawGroup0.Data == nil { + return false + } + if rawGroup0.AssetID != nil { + return false + } + if rawGroup0.ByteLength != nil { + return false + } + return rawGroup0.OmittedReason == nil +} + +func unmarshalPersistedBinaryResult(data []byte) (PersistedBinaryResult, error) { + if string(data) == "null" { + return nil, nil + } + type rawUnion struct { + Type PersistedBinaryResultType `json:"type"` + } + var raw rawUnion + if err := json.Unmarshal(data, &raw); err != nil { + return nil, err + } + + switch raw.Type { + case PersistedBinaryResultTypeImage: + if matchesBinaryAssetReference(data) { + var d BinaryAssetReference + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesOmittedBinaryResult(data) { + var d OmittedBinaryResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesPersistedBinaryImage(data) { + var d PersistedBinaryImage + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return &RawPersistedBinaryResult{Discriminator: raw.Type, Raw: data}, nil + case PersistedBinaryResultTypeResource: + if matchesBinaryAssetReference(data) { + var d BinaryAssetReference + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesOmittedBinaryResult(data) { + var d OmittedBinaryResult + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + if matchesPersistedBinaryImage(data) { + var d PersistedBinaryImage + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil + } + return &RawPersistedBinaryResult{Discriminator: raw.Type, Raw: data}, nil + default: + return &RawPersistedBinaryResult{Discriminator: raw.Type, Raw: data}, nil + } +} + +func (r RawPersistedBinaryResult) MarshalJSON() ([]byte, error) { + if r.Raw != nil { + return r.Raw, nil + } return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type PersistedBinaryResultType `json:"type"` + }{ + Type: r.Discriminator, + }) +} + +func (r BinaryAssetReference) MarshalJSON() ([]byte, error) { + type alias BinaryAssetReference + return json.Marshal(struct { + Type PersistedBinaryResultType `json:"type"` alias }{ Type: r.Type(), @@ -695,10 +1057,10 @@ func (r UserMessageAttachmentGithubReference) MarshalJSON() ([]byte, error) { }) } -func (r UserMessageAttachmentSelection) MarshalJSON() ([]byte, error) { - type alias UserMessageAttachmentSelection +func (r OmittedBinaryResult) MarshalJSON() ([]byte, error) { + type alias OmittedBinaryResult return json.Marshal(struct { - Type UserMessageAttachmentType `json:"type"` + Type PersistedBinaryResultType `json:"type"` alias }{ Type: r.Type(), @@ -706,43 +1068,15 @@ func (r UserMessageAttachmentSelection) MarshalJSON() ([]byte, error) { }) } -func (r *UserMessageData) UnmarshalJSON(data []byte) error { - type rawUserMessageData struct { - AgentMode *UserMessageAgentMode `json:"agentMode,omitempty"` - Attachments []json.RawMessage `json:"attachments,omitempty"` - Content string `json:"content"` - InteractionID *string `json:"interactionId,omitempty"` - IsAutopilotContinuation *bool `json:"isAutopilotContinuation,omitempty"` - NativeDocumentPathFallbackPaths []string `json:"nativeDocumentPathFallbackPaths,omitempty"` - ParentAgentTaskID *string `json:"parentAgentTaskId,omitempty"` - Source *string `json:"source,omitempty"` - SupportedNativeDocumentMIMETypes []string `json:"supportedNativeDocumentMimeTypes,omitempty"` - TransformedContent *string `json:"transformedContent,omitempty"` - } - var raw rawUserMessageData - if err := json.Unmarshal(data, &raw); err != nil { - return err - } - r.AgentMode = raw.AgentMode - if raw.Attachments != nil { - r.Attachments = make([]UserMessageAttachment, 0, len(raw.Attachments)) - for _, rawItem := range raw.Attachments { - value, err := unmarshalUserMessageAttachment(rawItem) - if err != nil { - return err - } - r.Attachments = append(r.Attachments, value) - } - } - r.Content = raw.Content - r.InteractionID = raw.InteractionID - r.IsAutopilotContinuation = raw.IsAutopilotContinuation - r.NativeDocumentPathFallbackPaths = raw.NativeDocumentPathFallbackPaths - r.ParentAgentTaskID = raw.ParentAgentTaskID - r.Source = raw.Source - r.SupportedNativeDocumentMIMETypes = raw.SupportedNativeDocumentMIMETypes - r.TransformedContent = raw.TransformedContent - return nil +func (r PersistedBinaryImage) MarshalJSON() ([]byte, error) { + type alias PersistedBinaryImage + return json.Marshal(struct { + Type PersistedBinaryResultType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) } func unmarshalToolExecutionCompleteContent(data []byte) (ToolExecutionCompleteContent, error) { @@ -782,6 +1116,12 @@ func unmarshalToolExecutionCompleteContent(data []byte) (ToolExecutionCompleteCo return nil, err } return &d, nil + case ToolExecutionCompleteContentTypeShellExit: + var d ToolExecutionCompleteContentShellExit + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case ToolExecutionCompleteContentTypeTerminal: var d ToolExecutionCompleteContentTerminal if err := json.Unmarshal(data, &d); err != nil { @@ -916,6 +1256,17 @@ func (r ToolExecutionCompleteContentResourceLink) MarshalJSON() ([]byte, error) }) } +func (r ToolExecutionCompleteContentShellExit) MarshalJSON() ([]byte, error) { + type alias ToolExecutionCompleteContentShellExit + return json.Marshal(struct { + Type ToolExecutionCompleteContentType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + func (r ToolExecutionCompleteContentTerminal) MarshalJSON() ([]byte, error) { type alias ToolExecutionCompleteContentTerminal return json.Marshal(struct { @@ -940,15 +1291,30 @@ func (r ToolExecutionCompleteContentText) MarshalJSON() ([]byte, error) { func (r *ToolExecutionCompleteResult) UnmarshalJSON(data []byte) error { type rawToolExecutionCompleteResult struct { - Content string `json:"content"` - Contents []json.RawMessage `json:"contents,omitempty"` - DetailedContent *string `json:"detailedContent,omitempty"` - UIResource *ToolExecutionCompleteUIResource `json:"uiResource,omitempty"` + BinaryResultsForLlm []json.RawMessage `json:"binaryResultsForLlm,omitzero"` + CitableSources []CitableSource `json:"citableSources,omitzero"` + Content string `json:"content"` + Contents []json.RawMessage `json:"contents,omitzero"` + DetailedContent *string `json:"detailedContent,omitempty"` + MCPMeta any `json:"mcpMeta,omitempty"` + StructuredContent any `json:"structuredContent,omitempty"` + UIResource *ToolExecutionCompleteUIResource `json:"uiResource,omitempty"` } var raw rawToolExecutionCompleteResult if err := json.Unmarshal(data, &raw); err != nil { return err } + if raw.BinaryResultsForLlm != nil { + r.BinaryResultsForLlm = make([]PersistedBinaryResult, 0, len(raw.BinaryResultsForLlm)) + for _, rawItem := range raw.BinaryResultsForLlm { + value, err := unmarshalPersistedBinaryResult(rawItem) + if err != nil { + return err + } + r.BinaryResultsForLlm = append(r.BinaryResultsForLlm, value) + } + } + r.CitableSources = raw.CitableSources r.Content = raw.Content if raw.Contents != nil { r.Contents = make([]ToolExecutionCompleteContent, 0, len(raw.Contents)) @@ -961,6 +1327,8 @@ func (r *ToolExecutionCompleteResult) UnmarshalJSON(data []byte) error { } } r.DetailedContent = raw.DetailedContent + r.MCPMeta = raw.MCPMeta + r.StructuredContent = raw.StructuredContent r.UIResource = raw.UIResource return nil } @@ -990,6 +1358,12 @@ func unmarshalSystemNotification(data []byte) (SystemNotification, error) { return nil, err } return &d, nil + case SystemNotificationTypeFactoryCompleted: + var d SystemNotificationFactoryCompleted + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case SystemNotificationTypeInstructionDiscovered: var d SystemNotificationInstructionDiscovered if err := json.Unmarshal(data, &d); err != nil { @@ -1014,6 +1388,12 @@ func unmarshalSystemNotification(data []byte) (SystemNotification, error) { return nil, err } return &d, nil + case SystemNotificationTypeUnclassified: + var d SystemNotificationUnclassified + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil default: return &RawSystemNotification{Discriminator: raw.Type, Raw: data}, nil } @@ -1052,6 +1432,17 @@ func (r SystemNotificationAgentIdle) MarshalJSON() ([]byte, error) { }) } +func (r SystemNotificationFactoryCompleted) MarshalJSON() ([]byte, error) { + type alias SystemNotificationFactoryCompleted + return json.Marshal(struct { + Type SystemNotificationType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + func (r SystemNotificationInstructionDiscovered) MarshalJSON() ([]byte, error) { type alias SystemNotificationInstructionDiscovered return json.Marshal(struct { @@ -1096,6 +1487,17 @@ func (r SystemNotificationShellDetachedCompleted) MarshalJSON() ([]byte, error) }) } +func (r SystemNotificationUnclassified) MarshalJSON() ([]byte, error) { + type alias SystemNotificationUnclassified + return json.Marshal(struct { + Type SystemNotificationType `json:"type"` + alias + }{ + Type: r.Type(), + alias: alias(r), + }) +} + func (r *SystemNotificationData) UnmarshalJSON(data []byte) error { type rawSystemNotificationData struct { Content string `json:"content"` @@ -1147,14 +1549,20 @@ func unmarshalPermissionRequest(data []byte) (PermissionRequest, error) { return nil, err } return &d, nil + case PermissionRequestKindFactory: + var d PermissionRequestFactory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionRequestKindHook: var d PermissionRequestHook if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionRequestKindMcp: - var d PermissionRequestMcp + case PermissionRequestKindMCP: + var d PermissionRequestMCP if err := json.Unmarshal(data, &d); err != nil { return nil, err } @@ -1238,6 +1646,17 @@ func (r PermissionRequestExtensionPermissionAccess) MarshalJSON() ([]byte, error }) } +func (r PermissionRequestFactory) MarshalJSON() ([]byte, error) { + type alias PermissionRequestFactory + return json.Marshal(struct { + Kind PermissionRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionRequestHook) MarshalJSON() ([]byte, error) { type alias PermissionRequestHook return json.Marshal(struct { @@ -1249,8 +1668,8 @@ func (r PermissionRequestHook) MarshalJSON() ([]byte, error) { }) } -func (r PermissionRequestMcp) MarshalJSON() ([]byte, error) { - type alias PermissionRequestMcp +func (r PermissionRequestMCP) MarshalJSON() ([]byte, error) { + type alias PermissionRequestMCP return json.Marshal(struct { Kind PermissionRequestKind `json:"kind"` alias @@ -1352,14 +1771,20 @@ func unmarshalPermissionPromptRequest(data []byte) (PermissionPromptRequest, err return nil, err } return &d, nil + case PermissionPromptRequestKindFactory: + var d PermissionPromptRequestFactory + if err := json.Unmarshal(data, &d); err != nil { + return nil, err + } + return &d, nil case PermissionPromptRequestKindHook: var d PermissionPromptRequestHook if err := json.Unmarshal(data, &d); err != nil { return nil, err } return &d, nil - case PermissionPromptRequestKindMcp: - var d PermissionPromptRequestMcp + case PermissionPromptRequestKindMCP: + var d PermissionPromptRequestMCP if err := json.Unmarshal(data, &d); err != nil { return nil, err } @@ -1454,6 +1879,17 @@ func (r PermissionPromptRequestExtensionPermissionAccess) MarshalJSON() ([]byte, }) } +func (r PermissionPromptRequestFactory) MarshalJSON() ([]byte, error) { + type alias PermissionPromptRequestFactory + return json.Marshal(struct { + Kind PermissionPromptRequestKind `json:"kind"` + alias + }{ + Kind: r.Kind(), + alias: alias(r), + }) +} + func (r PermissionPromptRequestHook) MarshalJSON() ([]byte, error) { type alias PermissionPromptRequestHook return json.Marshal(struct { @@ -1465,8 +1901,8 @@ func (r PermissionPromptRequestHook) MarshalJSON() ([]byte, error) { }) } -func (r PermissionPromptRequestMcp) MarshalJSON() ([]byte, error) { - type alias PermissionPromptRequestMcp +func (r PermissionPromptRequestMCP) MarshalJSON() ([]byte, error) { + type alias PermissionPromptRequestMCP return json.Marshal(struct { Kind PermissionPromptRequestKind `json:"kind"` alias @@ -1537,6 +1973,7 @@ func (r *PermissionRequestedData) UnmarshalJSON(data []byte) error { PromptRequest json.RawMessage `json:"promptRequest,omitempty"` RequestID string `json:"requestId"` ResolvedByHook *bool `json:"resolvedByHook,omitempty"` + RiskAssessment any `json:"riskAssessment,omitempty"` } var raw rawPermissionRequestedData if err := json.Unmarshal(data, &raw); err != nil { @@ -1558,6 +1995,7 @@ func (r *PermissionRequestedData) UnmarshalJSON(data []byte) error { } r.RequestID = raw.RequestID r.ResolvedByHook = raw.ResolvedByHook + r.RiskAssessment = raw.RiskAssessment return nil } @@ -1655,6 +2093,26 @@ func (r PermissionApproved) MarshalJSON() ([]byte, error) { }) } +func (r *PermissionApprovedForLocation) UnmarshalJSON(data []byte) error { + type rawPermissionApprovedForLocation struct { + Approval json.RawMessage `json:"approval"` + LocationKey string `json:"locationKey"` + } + var raw rawPermissionApprovedForLocation + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Approval != nil { + value, err := unmarshalUserToolSessionApproval(raw.Approval) + if err != nil { + return err + } + r.Approval = value + } + r.LocationKey = raw.LocationKey + return nil +} + func (r PermissionApprovedForLocation) MarshalJSON() ([]byte, error) { type alias PermissionApprovedForLocation return json.Marshal(struct { @@ -1666,6 +2124,24 @@ func (r PermissionApprovedForLocation) MarshalJSON() ([]byte, error) { }) } +func (r *PermissionApprovedForSession) UnmarshalJSON(data []byte) error { + type rawPermissionApprovedForSession struct { + Approval json.RawMessage `json:"approval"` + } + var raw rawPermissionApprovedForSession + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if raw.Approval != nil { + value, err := unmarshalUserToolSessionApproval(raw.Approval) + if err != nil { + return err + } + r.Approval = value + } + return nil +} + func (r PermissionApprovedForSession) MarshalJSON() ([]byte, error) { type alias PermissionApprovedForSession return json.Marshal(struct { @@ -1765,120 +2241,23 @@ func (r *PermissionCompletedData) UnmarshalJSON(data []byte) error { return nil } -func unmarshalElicitationCompletedContent(data []byte) (ElicitationCompletedContent, error) { - if string(data) == "null" { - return nil, nil - } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - return ElicitationCompletedStringContent(value), nil - } - } - { - var value float64 - if err := json.Unmarshal(data, &value); err == nil { - return ElicitationCompletedNumberContent(value), nil - } - } - { - var value bool - if err := json.Unmarshal(data, &value); err == nil { - return ElicitationCompletedBooleanContent(value), nil - } - } - { - var value []string - if err := json.Unmarshal(data, &value); err == nil { - return ElicitationCompletedStringArrayContent(value), nil - } - } - return nil, errors.New("data did not match any union variant for ElicitationCompletedContent") -} - -func (r *ElicitationCompletedData) UnmarshalJSON(data []byte) error { - type rawElicitationCompletedData struct { - Action *ElicitationCompletedAction `json:"action,omitempty"` - Content map[string]json.RawMessage `json:"content,omitempty"` - RequestID string `json:"requestId"` +func (r *SessionExtensionsAttachmentsPushedData) UnmarshalJSON(data []byte) error { + type rawSessionExtensionsAttachmentsPushedData struct { + Attachments []json.RawMessage `json:"attachments"` } - var raw rawElicitationCompletedData + var raw rawSessionExtensionsAttachmentsPushedData if err := json.Unmarshal(data, &raw); err != nil { return err } - r.Action = raw.Action - if raw.Content != nil { - r.Content = make(map[string]ElicitationCompletedContent, len(raw.Content)) - for key, rawValue := range raw.Content { - value, err := unmarshalElicitationCompletedContent(rawValue) + if raw.Attachments != nil { + r.Attachments = make([]Attachment, 0, len(raw.Attachments)) + for _, rawItem := range raw.Attachments { + value, err := unmarshalAttachment(rawItem) if err != nil { return err } - r.Content[key] = value + r.Attachments = append(r.Attachments, value) } } - r.RequestID = raw.RequestID return nil } - -func (r CustomNotificationPayload) MarshalJSON() ([]byte, error) { - if r.AnyArray != nil { - return json.Marshal(r.AnyArray) - } - if r.AnyMap != nil { - return json.Marshal(r.AnyMap) - } - if r.Bool != nil { - return json.Marshal(r.Bool) - } - if r.Double != nil { - return json.Marshal(r.Double) - } - if r.String != nil { - return json.Marshal(r.String) - } - return []byte("null"), nil -} - -func (r *CustomNotificationPayload) UnmarshalJSON(data []byte) error { - if string(data) == "null" { - *r = CustomNotificationPayload{} - return nil - } - { - var value []any - if err := json.Unmarshal(data, &value); err == nil { - *r = CustomNotificationPayload{AnyArray: value} - return nil - } - } - { - var value map[string]any - if err := json.Unmarshal(data, &value); err == nil { - *r = CustomNotificationPayload{AnyMap: value} - return nil - } - } - { - var value bool - if err := json.Unmarshal(data, &value); err == nil { - *r = CustomNotificationPayload{Bool: &value} - return nil - } - } - { - var value float64 - if err := json.Unmarshal(data, &value); err == nil { - *r = CustomNotificationPayload{Double: &value} - return nil - } - } - { - var value string - if err := json.Unmarshal(data, &value); err == nil { - *r = CustomNotificationPayload{String: &value} - return nil - } - } - return errors.New("data did not match any union variant for CustomNotificationPayload") -} diff --git a/go/rpc/zsession_events.go b/go/rpc/zsession_events.go index d991c2429..05c8fd548 100644 --- a/go/rpc/zsession_events.go +++ b/go/rpc/zsession_events.go @@ -53,93 +53,143 @@ func (r RawSessionEventData) Type() SessionEventType { type SessionEventType string const ( - SessionEventTypeAbort SessionEventType = "abort" - SessionEventTypeAssistantIntent SessionEventType = "assistant.intent" - SessionEventTypeAssistantMessage SessionEventType = "assistant.message" - SessionEventTypeAssistantMessageDelta SessionEventType = "assistant.message_delta" - SessionEventTypeAssistantMessageStart SessionEventType = "assistant.message_start" - SessionEventTypeAssistantReasoning SessionEventType = "assistant.reasoning" - SessionEventTypeAssistantReasoningDelta SessionEventType = "assistant.reasoning_delta" - SessionEventTypeAssistantStreamingDelta SessionEventType = "assistant.streaming_delta" - SessionEventTypeAssistantTurnEnd SessionEventType = "assistant.turn_end" - SessionEventTypeAssistantTurnStart SessionEventType = "assistant.turn_start" - SessionEventTypeAssistantUsage SessionEventType = "assistant.usage" - SessionEventTypeAutoModeSwitchCompleted SessionEventType = "auto_mode_switch.completed" - SessionEventTypeAutoModeSwitchRequested SessionEventType = "auto_mode_switch.requested" - SessionEventTypeCapabilitiesChanged SessionEventType = "capabilities.changed" - SessionEventTypeCommandCompleted SessionEventType = "command.completed" - SessionEventTypeCommandExecute SessionEventType = "command.execute" - SessionEventTypeCommandQueued SessionEventType = "command.queued" - SessionEventTypeCommandsChanged SessionEventType = "commands.changed" - SessionEventTypeElicitationCompleted SessionEventType = "elicitation.completed" - SessionEventTypeElicitationRequested SessionEventType = "elicitation.requested" - SessionEventTypeExitPlanModeCompleted SessionEventType = "exit_plan_mode.completed" - SessionEventTypeExitPlanModeRequested SessionEventType = "exit_plan_mode.requested" - SessionEventTypeExternalToolCompleted SessionEventType = "external_tool.completed" - SessionEventTypeExternalToolRequested SessionEventType = "external_tool.requested" - SessionEventTypeHookEnd SessionEventType = "hook.end" - SessionEventTypeHookProgress SessionEventType = "hook.progress" - SessionEventTypeHookStart SessionEventType = "hook.start" - SessionEventTypeMcpAppToolCallComplete SessionEventType = "mcp_app.tool_call_complete" - SessionEventTypeMcpOauthCompleted SessionEventType = "mcp.oauth_completed" - SessionEventTypeMcpOauthRequired SessionEventType = "mcp.oauth_required" - SessionEventTypeModelCallFailure SessionEventType = "model.call_failure" - SessionEventTypePendingMessagesModified SessionEventType = "pending_messages.modified" - SessionEventTypePermissionCompleted SessionEventType = "permission.completed" - SessionEventTypePermissionRequested SessionEventType = "permission.requested" - SessionEventTypeSamplingCompleted SessionEventType = "sampling.completed" - SessionEventTypeSamplingRequested SessionEventType = "sampling.requested" + SessionEventTypeAbort SessionEventType = "abort" + SessionEventTypeAssistantIdle SessionEventType = "assistant.idle" + SessionEventTypeAssistantIntent SessionEventType = "assistant.intent" + SessionEventTypeAssistantMessage SessionEventType = "assistant.message" + SessionEventTypeAssistantMessageDelta SessionEventType = "assistant.message_delta" + SessionEventTypeAssistantMessageStart SessionEventType = "assistant.message_start" + SessionEventTypeAssistantReasoning SessionEventType = "assistant.reasoning" + SessionEventTypeAssistantReasoningDelta SessionEventType = "assistant.reasoning_delta" + SessionEventTypeAssistantServerToolProgress SessionEventType = "assistant.server_tool_progress" + SessionEventTypeAssistantStreamingDelta SessionEventType = "assistant.streaming_delta" + SessionEventTypeAssistantToolCallDelta SessionEventType = "assistant.tool_call_delta" + SessionEventTypeAssistantTurnEnd SessionEventType = "assistant.turn_end" + SessionEventTypeAssistantTurnRetry SessionEventType = "assistant.turn_retry" + SessionEventTypeAssistantTurnStart SessionEventType = "assistant.turn_start" + SessionEventTypeAssistantUsage SessionEventType = "assistant.usage" + SessionEventTypeAutoModeSwitchCompleted SessionEventType = "auto_mode_switch.completed" + SessionEventTypeAutoModeSwitchRequested SessionEventType = "auto_mode_switch.requested" + SessionEventTypeCapabilitiesChanged SessionEventType = "capabilities.changed" + SessionEventTypeCommandCompleted SessionEventType = "command.completed" + SessionEventTypeCommandExecute SessionEventType = "command.execute" + SessionEventTypeCommandQueued SessionEventType = "command.queued" + SessionEventTypeCommandsChanged SessionEventType = "commands.changed" + SessionEventTypeElicitationCompleted SessionEventType = "elicitation.completed" + SessionEventTypeElicitationRequested SessionEventType = "elicitation.requested" + SessionEventTypeExitPlanModeCompleted SessionEventType = "exit_plan_mode.completed" + SessionEventTypeExitPlanModeRequested SessionEventType = "exit_plan_mode.requested" + SessionEventTypeExternalToolCompleted SessionEventType = "external_tool.completed" + SessionEventTypeExternalToolRequested SessionEventType = "external_tool.requested" + // Experimental: SessionEventTypeFactoryRunUpdated identifies an experimental event that may + // change or be removed. + SessionEventTypeFactoryRunUpdated SessionEventType = "factory.run_updated" + SessionEventTypeHookEnd SessionEventType = "hook.end" + SessionEventTypeHookProgress SessionEventType = "hook.progress" + SessionEventTypeHookStart SessionEventType = "hook.start" + SessionEventTypeMCPAppToolCallComplete SessionEventType = "mcp_app.tool_call_complete" + SessionEventTypeMCPHeadersRefreshCompleted SessionEventType = "mcp.headers_refresh_completed" + SessionEventTypeMCPHeadersRefreshRequired SessionEventType = "mcp.headers_refresh_required" + SessionEventTypeMCPOauthCompleted SessionEventType = "mcp.oauth_completed" + SessionEventTypeMCPOauthRequired SessionEventType = "mcp.oauth_required" + SessionEventTypeMCPPromptsListChanged SessionEventType = "mcp.prompts.list_changed" + SessionEventTypeMCPResourcesListChanged SessionEventType = "mcp.resources.list_changed" + SessionEventTypeMCPToolsListChanged SessionEventType = "mcp.tools.list_changed" + SessionEventTypeModelCallFailure SessionEventType = "model.call_failure" + SessionEventTypeModelCallStart SessionEventType = "model.call_start" + SessionEventTypePendingMessagesModified SessionEventType = "pending_messages.modified" + SessionEventTypePermissionCompleted SessionEventType = "permission.completed" + SessionEventTypePermissionRequested SessionEventType = "permission.requested" + SessionEventTypeSamplingCompleted SessionEventType = "sampling.completed" + SessionEventTypeSamplingRequested SessionEventType = "sampling.requested" + // Experimental: SessionEventTypeSessionAutoModeResolved identifies an experimental event + // that may change or be removed. + SessionEventTypeSessionAutoModeResolved SessionEventType = "session.auto_mode_resolved" SessionEventTypeSessionAutopilotObjectiveChanged SessionEventType = "session.autopilot_objective_changed" SessionEventTypeSessionBackgroundTasksChanged SessionEventType = "session.background_tasks_changed" - SessionEventTypeSessionCanvasOpened SessionEventType = "session.canvas.opened" - SessionEventTypeSessionCanvasRegistryChanged SessionEventType = "session.canvas.registry_changed" - SessionEventTypeSessionCompactionComplete SessionEventType = "session.compaction_complete" - SessionEventTypeSessionCompactionStart SessionEventType = "session.compaction_start" - SessionEventTypeSessionContextChanged SessionEventType = "session.context_changed" - SessionEventTypeSessionCustomAgentsUpdated SessionEventType = "session.custom_agents_updated" - SessionEventTypeSessionCustomNotification SessionEventType = "session.custom_notification" - SessionEventTypeSessionError SessionEventType = "session.error" - SessionEventTypeSessionExtensionsLoaded SessionEventType = "session.extensions_loaded" - SessionEventTypeSessionHandoff SessionEventType = "session.handoff" - SessionEventTypeSessionIdle SessionEventType = "session.idle" - SessionEventTypeSessionInfo SessionEventType = "session.info" - SessionEventTypeSessionMcpServersLoaded SessionEventType = "session.mcp_servers_loaded" - SessionEventTypeSessionMcpServerStatusChanged SessionEventType = "session.mcp_server_status_changed" - SessionEventTypeSessionModeChanged SessionEventType = "session.mode_changed" - SessionEventTypeSessionModelChange SessionEventType = "session.model_change" - SessionEventTypeSessionPermissionsChanged SessionEventType = "session.permissions_changed" - SessionEventTypeSessionPlanChanged SessionEventType = "session.plan_changed" - SessionEventTypeSessionRemoteSteerableChanged SessionEventType = "session.remote_steerable_changed" - SessionEventTypeSessionResume SessionEventType = "session.resume" - SessionEventTypeSessionScheduleCancelled SessionEventType = "session.schedule_cancelled" - SessionEventTypeSessionScheduleCreated SessionEventType = "session.schedule_created" - SessionEventTypeSessionShutdown SessionEventType = "session.shutdown" - SessionEventTypeSessionSkillsLoaded SessionEventType = "session.skills_loaded" - SessionEventTypeSessionSnapshotRewind SessionEventType = "session.snapshot_rewind" - SessionEventTypeSessionStart SessionEventType = "session.start" - SessionEventTypeSessionTaskComplete SessionEventType = "session.task_complete" - SessionEventTypeSessionTitleChanged SessionEventType = "session.title_changed" - SessionEventTypeSessionToolsUpdated SessionEventType = "session.tools_updated" - SessionEventTypeSessionTruncation SessionEventType = "session.truncation" - SessionEventTypeSessionUsageInfo SessionEventType = "session.usage_info" - SessionEventTypeSessionWarning SessionEventType = "session.warning" - SessionEventTypeSessionWorkspaceFileChanged SessionEventType = "session.workspace_file_changed" - SessionEventTypeSkillInvoked SessionEventType = "skill.invoked" - SessionEventTypeSubagentCompleted SessionEventType = "subagent.completed" - SessionEventTypeSubagentDeselected SessionEventType = "subagent.deselected" - SessionEventTypeSubagentFailed SessionEventType = "subagent.failed" - SessionEventTypeSubagentSelected SessionEventType = "subagent.selected" - SessionEventTypeSubagentStarted SessionEventType = "subagent.started" - SessionEventTypeSystemMessage SessionEventType = "system.message" - SessionEventTypeSystemNotification SessionEventType = "system.notification" - SessionEventTypeToolExecutionComplete SessionEventType = "tool.execution_complete" - SessionEventTypeToolExecutionPartialResult SessionEventType = "tool.execution_partial_result" - SessionEventTypeToolExecutionProgress SessionEventType = "tool.execution_progress" - SessionEventTypeToolExecutionStart SessionEventType = "tool.execution_start" - SessionEventTypeToolUserRequested SessionEventType = "tool.user_requested" - SessionEventTypeUserInputCompleted SessionEventType = "user_input.completed" - SessionEventTypeUserInputRequested SessionEventType = "user_input.requested" - SessionEventTypeUserMessage SessionEventType = "user.message" + // Experimental: SessionEventTypeSessionBinaryAsset identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionBinaryAsset SessionEventType = "session.binary_asset" + // Experimental: SessionEventTypeSessionCanvasClosed identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionCanvasClosed SessionEventType = "session.canvas.closed" + // Experimental: SessionEventTypeSessionCanvasOpened identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionCanvasOpened SessionEventType = "session.canvas.opened" + // Experimental: SessionEventTypeSessionCanvasRecorded identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionCanvasRecorded SessionEventType = "session.canvas.recorded" + // Experimental: SessionEventTypeSessionCanvasRegistryChanged identifies an experimental + // event that may change or be removed. + SessionEventTypeSessionCanvasRegistryChanged SessionEventType = "session.canvas.registry_changed" + // Experimental: SessionEventTypeSessionCanvasRemoved identifies an experimental event that + // may change or be removed. + SessionEventTypeSessionCanvasRemoved SessionEventType = "session.canvas.removed" + // Experimental: SessionEventTypeSessionCanvasUnavailable identifies an experimental event + // that may change or be removed. + SessionEventTypeSessionCanvasUnavailable SessionEventType = "session.canvas.unavailable" + SessionEventTypeSessionCompactionComplete SessionEventType = "session.compaction_complete" + SessionEventTypeSessionCompactionStart SessionEventType = "session.compaction_start" + SessionEventTypeSessionContextChanged SessionEventType = "session.context_changed" + SessionEventTypeSessionContextCleared SessionEventType = "session.context_cleared" + SessionEventTypeSessionCustomAgentsUpdated SessionEventType = "session.custom_agents_updated" + SessionEventTypeSessionCustomNotification SessionEventType = "session.custom_notification" + SessionEventTypeSessionError SessionEventType = "session.error" + SessionEventTypeSessionExtensionsAttachmentsPushed SessionEventType = "session.extensions.attachments_pushed" + SessionEventTypeSessionExtensionsLoaded SessionEventType = "session.extensions_loaded" + SessionEventTypeSessionHandoff SessionEventType = "session.handoff" + SessionEventTypeSessionIdle SessionEventType = "session.idle" + SessionEventTypeSessionInfo SessionEventType = "session.info" + SessionEventTypeSessionLimitsExhaustedCompleted SessionEventType = "session_limits_exhausted.completed" + SessionEventTypeSessionLimitsExhaustedRequested SessionEventType = "session_limits_exhausted.requested" + // Experimental: SessionEventTypeSessionManagedSettingsEnforced identifies an experimental + // event that may change or be removed. + SessionEventTypeSessionManagedSettingsEnforced SessionEventType = "session.managed_settings_enforced" + // Experimental: SessionEventTypeSessionManagedSettingsResolved identifies an experimental + // event that may change or be removed. + SessionEventTypeSessionManagedSettingsResolved SessionEventType = "session.managed_settings_resolved" + SessionEventTypeSessionMCPServersLoaded SessionEventType = "session.mcp_servers_loaded" + SessionEventTypeSessionMCPServerStatusChanged SessionEventType = "session.mcp_server_status_changed" + SessionEventTypeSessionModeChanged SessionEventType = "session.mode_changed" + SessionEventTypeSessionModelChange SessionEventType = "session.model_change" + SessionEventTypeSessionPermissionsChanged SessionEventType = "session.permissions_changed" + SessionEventTypeSessionPlanChanged SessionEventType = "session.plan_changed" + SessionEventTypeSessionRemoteSteerableChanged SessionEventType = "session.remote_steerable_changed" + SessionEventTypeSessionResume SessionEventType = "session.resume" + SessionEventTypeSessionScheduleCancelled SessionEventType = "session.schedule_cancelled" + SessionEventTypeSessionScheduleCreated SessionEventType = "session.schedule_created" + SessionEventTypeSessionScheduleRearmed SessionEventType = "session.schedule_rearmed" + SessionEventTypeSessionSessionLimitsChanged SessionEventType = "session.session_limits_changed" + SessionEventTypeSessionShutdown SessionEventType = "session.shutdown" + SessionEventTypeSessionSkillsLoaded SessionEventType = "session.skills_loaded" + SessionEventTypeSessionSnapshotRewind SessionEventType = "session.snapshot_rewind" + SessionEventTypeSessionStart SessionEventType = "session.start" + SessionEventTypeSessionTaskComplete SessionEventType = "session.task_complete" + SessionEventTypeSessionTitleChanged SessionEventType = "session.title_changed" + SessionEventTypeSessionTodosChanged SessionEventType = "session.todos_changed" + SessionEventTypeSessionToolsUpdated SessionEventType = "session.tools_updated" + SessionEventTypeSessionTruncation SessionEventType = "session.truncation" + SessionEventTypeSessionUsageCheckpoint SessionEventType = "session.usage_checkpoint" + SessionEventTypeSessionUsageInfo SessionEventType = "session.usage_info" + SessionEventTypeSessionWarning SessionEventType = "session.warning" + SessionEventTypeSessionWorkspaceFileChanged SessionEventType = "session.workspace_file_changed" + SessionEventTypeSkillInvoked SessionEventType = "skill.invoked" + SessionEventTypeSubagentCompleted SessionEventType = "subagent.completed" + SessionEventTypeSubagentDeselected SessionEventType = "subagent.deselected" + SessionEventTypeSubagentFailed SessionEventType = "subagent.failed" + SessionEventTypeSubagentSelected SessionEventType = "subagent.selected" + SessionEventTypeSubagentStarted SessionEventType = "subagent.started" + SessionEventTypeSystemMessage SessionEventType = "system.message" + SessionEventTypeSystemNotification SessionEventType = "system.notification" + SessionEventTypeToolExecutionComplete SessionEventType = "tool.execution_complete" + SessionEventTypeToolExecutionPartialResult SessionEventType = "tool.execution_partial_result" + SessionEventTypeToolExecutionProgress SessionEventType = "tool.execution_progress" + SessionEventTypeToolExecutionStart SessionEventType = "tool.execution_start" + SessionEventTypeToolSearchActivated SessionEventType = "tool_search.activated" + SessionEventTypeToolUserRequested SessionEventType = "tool.user_requested" + SessionEventTypeUserInputCompleted SessionEventType = "user_input.completed" + SessionEventTypeUserInputRequested SessionEventType = "user_input.requested" + SessionEventTypeUserMessage SessionEventType = "user.message" ) // Agent intent description for current activity or plan @@ -168,6 +218,7 @@ type AssistantReasoningData struct { Content string `json:"content"` // Unique identifier for this reasoning block ReasoningID string `json:"reasoningId"` + Rte *bool `json:"rte,omitempty"` } func (*AssistantReasoningData) sessionEventData() {} @@ -175,12 +226,17 @@ func (*AssistantReasoningData) Type() SessionEventType { return SessionEventType // Assistant response containing text content, optional tool requests, and interaction metadata type AssistantMessageData struct { - // Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping - // Experimental: AnthropicAdvisorBlocks is part of an experimental API and may change or be removed. - AnthropicAdvisorBlocks []any `json:"anthropicAdvisorBlocks,omitempty"` - // Anthropic advisor model ID used for this response, for timeline display on replay - // Experimental: AnthropicAdvisorModel is part of an experimental API and may change or be removed. - AnthropicAdvisorModel *string `json:"anthropicAdvisorModel,omitempty"` + // Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. + APICallID *string `json:"apiCallId,omitempty"` + // Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1. + ChunkCount *int64 `json:"chunkCount,omitempty"` + // Zero-based position of this message within its model call's response. Absent when the response was not split into chunks. + ChunkIndex *int64 `json:"chunkIndex,omitempty"` + // Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. + // Experimental: Citations is part of an experimental API and may change or be removed. + Citations *Citations `json:"citations,omitempty"` + // Client-minted request id (x-request-id header) echoed by the server. Distinct from requestId (x-github-request-id) and serviceRequestId (x-copilot-service-request-id). + ClientRequestID *string `json:"clientRequestId,omitempty"` // The assistant's text response content Content string `json:"content"` // Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. @@ -202,12 +258,17 @@ type AssistantMessageData struct { ReasoningOpaque *string `json:"reasoningOpaque,omitempty"` // Readable reasoning text from the model's extended thinking ReasoningText *string `json:"reasoningText,omitempty"` + // OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns. + ReasoningWireField *string `json:"reasoningWireField,omitempty"` // GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs RequestID *string `json:"requestId,omitempty"` + Rte *bool `json:"rte,omitempty"` + // Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping + ServerTools *AssistantMessageServerTools `json:"serverTools,omitempty"` // Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation ServiceRequestID *string `json:"serviceRequestId,omitempty"` // Tool invocations requested by the assistant in this message - ToolRequests []AssistantMessageToolRequest `json:"toolRequests,omitempty"` + ToolRequests []AssistantMessageToolRequest `json:"toolRequests,omitzero"` // Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event TurnID *string `json:"turnId,omitempty"` } @@ -215,6 +276,46 @@ type AssistantMessageData struct { func (*AssistantMessageData) sessionEventData() {} func (*AssistantMessageData) Type() SessionEventType { return SessionEventTypeAssistantMessage } +// Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. +// Experimental: SessionAutoModeResolvedData is part of an experimental API and may change or be removed. +type SessionAutoModeResolvedData struct { + // Models offered to the router for this resolution + AvailableModels []string `json:"availableModels,omitzero"` + // Ordered candidate model list the router returned, when not a fallback + CandidateModels []string `json:"candidateModels,omitzero"` + // Per-category classifier scores (0-1) behind the bucket: the granular HYDRA capability scores (reasoning, code_gen, debugging, tool_use), or the binary needs_reasoning/no_reasoning scores when HYDRA didn't run. Lets clients show a breakdown rather than just the bucket. + CategoryScores map[string]float64 `json:"categoryScores,omitzero"` + // The concrete model the session will use after any intent refinement + ChosenModel string `json:"chosenModel"` + // The chosen model's score shortfall relative to the top candidate + ChosenShortfall *float64 `json:"chosenShortfall,omitempty"` + // Classifier confidence for the predicted label, when available + Confidence *float64 `json:"confidence,omitempty"` + // End-to-end client wait time for the router request in milliseconds + EndToEndLatencyMs *float64 `json:"endToEndLatencyMs,omitempty"` + // Whether the router fell back to the standard Auto selection + Fallback *bool `json:"fallback,omitempty"` + // Server-provided reason for falling back, when available + FallbackReason *string `json:"fallbackReason,omitempty"` + // Whether the routed prompt contained an image + HasImage *bool `json:"hasImage,omitempty"` + // The predicted classifier label (e.g. `needs_reasoning`), when available + PredictedLabel *string `json:"predictedLabel,omitempty"` + // Coarse request-difficulty bucket, for explaining why a model was chosen ("picked X because this looks like high-reasoning work") + ReasoningBucket *AutoModeResolvedReasoningBucket `json:"reasoningBucket,omitempty"` + // Server-reported router processing time in milliseconds + RouterLatencyMs *float64 `json:"routerLatencyMs,omitempty"` + // The routing method the server applied, when Auto Intent ran + RoutingMethod *string `json:"routingMethod,omitempty"` + // Whether a sticky model choice overrode the router result + StickyOverride *bool `json:"stickyOverride,omitempty"` +} + +func (*SessionAutoModeResolvedData) sessionEventData() {} +func (*SessionAutoModeResolvedData) Type() SessionEventType { + return SessionEventTypeSessionAutoModeResolved +} + // Auto mode switch completion notification type AutoModeSwitchCompletedData struct { // Request ID of the resolved request; clients should dismiss any UI for this request @@ -258,14 +359,43 @@ func (*SessionAutopilotObjectiveChangedData) Type() SessionEventType { return SessionEventTypeSessionAutopilotObjectiveChanged } +// Canonical bytes for a content-addressed binary asset shared by reference across events +type SessionBinaryAssetData struct { + // Content-addressed id for this binary asset (e.g. "sha256:..."). + AssetID string `json:"assetId"` + // Decoded byte length of the binary asset + ByteLength int64 `json:"byteLength"` + // Base64-encoded binary data + Data string `json:"data"` + // Human-readable description of the binary data + Description *string `json:"description,omitempty"` + // Optional metadata from the producing tool. + Metadata map[string]any `json:"metadata,omitzero"` + // MIME type of the binary asset + MIMEType string `json:"mimeType"` + // Binary asset type discriminator. Use "image" for images and "resource" otherwise. + Discriminator BinaryAssetType `json:"type"` +} + +func (*SessionBinaryAssetData) sessionEventData() {} +func (*SessionBinaryAssetData) Type() SessionEventType { return SessionEventTypeSessionBinaryAsset } + // Context window breakdown at the start of LLM-powered conversation compaction type SessionCompactionStartData struct { // Token count from non-system messages (user, assistant, tool) at compaction start ConversationTokens *int64 `json:"conversationTokens,omitempty"` + // Total context tokens (system + conversation + tool definitions) at compaction start, when known + CurrentTokens *int64 `json:"currentTokens,omitempty"` + // Model identifier used for compaction, when known + Model *string `json:"model,omitempty"` // Token count from system message(s) at compaction start SystemTokens *int64 `json:"systemTokens,omitempty"` + // Model context window token limit the compaction is targeting, when known + TokenLimit *int64 `json:"tokenLimit,omitempty"` // Token count from tool definitions at compaction start ToolDefinitionsTokens *int64 `json:"toolDefinitionsTokens,omitempty"` + // What initiated this compaction, when known + Trigger *CompactionTrigger `json:"trigger,omitempty"` } func (*SessionCompactionStartData) sessionEventData() {} @@ -273,6 +403,19 @@ func (*SessionCompactionStartData) Type() SessionEventType { return SessionEventTypeSessionCompactionStart } +// Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) +type SessionContextClearedData struct { + // Optional initial message set after clearing + InitialMessage *string `json:"initialMessage,omitempty"` + // Number of conversation messages that were cleared + MessagesCleared int64 `json:"messagesCleared"` +} + +func (*SessionContextClearedData) sessionEventData() {} +func (*SessionContextClearedData) Type() SessionEventType { + return SessionEventTypeSessionContextCleared +} + // Conversation compaction results including success status, metrics, and optional error details type SessionCompactionCompleteData struct { // Checkpoint snapshot number created for recovery @@ -299,16 +442,22 @@ type SessionCompactionCompleteData struct { RequestID *string `json:"requestId,omitempty"` // Copilot service request ID (x-copilot-service-request-id header) for the compaction LLM call ServiceRequestID *string `json:"serviceRequestId,omitempty"` + // For failed compaction only: the HTTP status code of the compaction LLM call failure, when it carried one. Absent for successful compaction and for failures without an HTTP status (e.g. an empty model response or a transport error). + StatusCode *int64 `json:"statusCode,omitempty"` // Whether compaction completed successfully Success bool `json:"success"` // LLM-generated summary of the compacted conversation history SummaryContent *string `json:"summaryContent,omitempty"` // Token count from system message(s) after compaction SystemTokens *int64 `json:"systemTokens,omitempty"` + // Model context window token limit the compaction was targeting, when known + TokenLimit *int64 `json:"tokenLimit,omitempty"` // Number of tokens removed during compaction TokensRemoved *int64 `json:"tokensRemoved,omitempty"` // Token count from tool definitions after compaction ToolDefinitionsTokens *int64 `json:"toolDefinitionsTokens,omitempty"` + // What initiated this compaction, when known + Trigger *CompactionTrigger `json:"trigger,omitempty"` } func (*SessionCompactionCompleteData) sessionEventData() {} @@ -373,12 +522,80 @@ type SubagentSelectedData struct { func (*SubagentSelectedData) sessionEventData() {} func (*SubagentSelectedData) Type() SessionEventType { return SessionEventTypeSubagentSelected } +// Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. +// Experimental: SessionCanvasRecordedData is part of an experimental API and may change or be removed. +type SessionCanvasRecordedData struct { + // Provider-local canvas identifier + CanvasID string `json:"canvasId"` + // Owning provider identifier + ExtensionID string `json:"extensionId"` + // Input supplied when the instance was opened + Input any `json:"input,omitempty"` + // Stable caller-supplied canvas instance identifier + InstanceID string `json:"instanceId"` + // Rendered title + Title *string `json:"title,omitempty"` +} + +func (*SessionCanvasRecordedData) sessionEventData() {} +func (*SessionCanvasRecordedData) Type() SessionEventType { + return SessionEventTypeSessionCanvasRecorded +} + +// Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. +// Experimental: SessionCanvasRemovedData is part of an experimental API and may change or be removed. +type SessionCanvasRemovedData struct { + // Provider-local canvas identifier + CanvasID string `json:"canvasId"` + // Owning provider identifier + ExtensionID string `json:"extensionId"` + // Stable caller-supplied identifier of the canvas instance that was closed + InstanceID string `json:"instanceId"` +} + +func (*SessionCanvasRemovedData) sessionEventData() {} +func (*SessionCanvasRemovedData) Type() SessionEventType { return SessionEventTypeSessionCanvasRemoved } + +// Durable session usage checkpoint for reconstructing aggregate accounting on resume +type SessionUsageCheckpointData struct { + // Internal per-model prompt-cache state used to restore expiration tracking on resume + // Internal: ModelCacheState is part of the SDK's internal API surface and is not intended for external use. + ModelCacheState []UsageCheckpointModelCacheState `json:"modelCacheState,omitzero"` + // Session-wide accumulated nano-AI units cost at checkpoint time + TotalNanoAiu float64 `json:"totalNanoAiu"` + // Total number of premium API requests used at checkpoint time + // Internal: TotalPremiumRequests is part of the SDK's internal API surface and is not intended for external use. + TotalPremiumRequests *float64 `json:"totalPremiumRequests,omitempty"` +} + +func (*SessionUsageCheckpointData) sessionEventData() {} +func (*SessionUsageCheckpointData) Type() SessionEventType { + return SessionEventTypeSessionUsageCheckpoint +} + +// Dynamic headers refresh request for a remote MCP server +type MCPHeadersRefreshRequiredData struct { + // Why dynamic headers are being requested. + Reason MCPHeadersRefreshRequiredReason `json:"reason"` + // Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest() + RequestID string `json:"requestId"` + // Display name of the remote MCP server requesting headers + ServerName string `json:"serverName"` + // URL of the remote MCP server requesting headers + ServerURL string `json:"serverUrl"` +} + +func (*MCPHeadersRefreshRequiredData) sessionEventData() {} +func (*MCPHeadersRefreshRequiredData) Type() SessionEventType { + return SessionEventTypeMCPHeadersRefreshRequired +} + // Elicitation request completion with the user's response type ElicitationCompletedData struct { // The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed) Action *ElicitationCompletedAction `json:"action,omitempty"` // The submitted form data when action is 'accept'; keys match the requested schema fields - Content map[string]ElicitationCompletedContent `json:"content,omitempty"` + Content map[string]any `json:"content,omitzero"` // Request ID of the resolved elicitation request; clients should dismiss any UI for this request RequestID string `json:"requestId"` } @@ -407,6 +624,15 @@ type ElicitationRequestedData struct { func (*ElicitationRequestedData) sessionEventData() {} func (*ElicitationRequestedData) Type() SessionEventType { return SessionEventTypeElicitationRequested } +// Empty payload for `session.background_tasks_changed`, indicating background task state changed. +type SessionBackgroundTasksChangedData struct { +} + +func (*SessionBackgroundTasksChangedData) sessionEventData() {} +func (*SessionBackgroundTasksChangedData) Type() SessionEventType { + return SessionEventTypeSessionBackgroundTasksChanged +} + // Empty payload; the event signals that the custom agent was deselected, returning to the default agent type SubagentDeselectedData struct { } @@ -423,10 +649,51 @@ func (*PendingMessagesModifiedData) Type() SessionEventType { return SessionEventTypePendingMessagesModified } +// Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. +// Experimental: SessionManagedSettingsResolvedData is part of an experimental API and may change or be removed. +type SessionManagedSettingsResolvedData struct { + // Whether enterprise policy disables bypass-permissions ("yolo") mode for this session. Deny-wins across layers, and forced on when `failClosed` is true. + BypassPermissionsDisabled bool `json:"bypassPermissionsDisabled"` + // Whether a session-local permissions layer injected by the SDK host was present + ClientManaged *bool `json:"clientManaged,omitempty"` + // Whether an actual device MDM/plist/registry/file managed-settings layer was present + DeviceManaged bool `json:"deviceManaged"` + // Whether managed policy could not be determined (e.g. a failed server fetch) and the session fell back to the fail-closed restriction. When true, restrictions such as disabling bypass-permissions are enforced even though `settings` may be absent. + FailClosed bool `json:"failClosed"` + // The setting keys under enterprise management in the effective managed settings (e.g. `model`, `enabledPlugins`, `permissions`). Empty when no managed settings are in force. + ManagedKeys []string `json:"managedKeys"` + // Whether at least two managed sources supplied permission allowlists, so enforcement intersects them and the flattened settings payload omits `permissions.allow`. + PermissionsAllowIntersected *bool `json:"permissionsAllowIntersected,omitempty"` + // Whether the server (account/org) managed-settings layer was present + ServerManaged bool `json:"serverManaged"` + // The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. + Settings any `json:"settings,omitempty"` + // Channel summary: `server`, `device`, or `client` when exactly one channel contributed; `mixed` when multiple channels contributed; otherwise `none`. Consult the per-channel booleans for exact provenance. + Source ManagedSettingsResolvedSource `json:"source"` +} + +func (*SessionManagedSettingsResolvedData) sessionEventData() {} +func (*SessionManagedSettingsResolvedData) Type() SessionEventType { + return SessionEventTypeSessionManagedSettingsResolved +} + +// Ephemeral invalidation signal for a changed factory run. +// Experimental: FactoryRunUpdatedData is part of an experimental API and may change or be removed. +type FactoryRunUpdatedData struct { + // Monotonic revision now available for the run. + Revision int64 `json:"revision"` + RunID string `json:"runId"` +} + +func (*FactoryRunUpdatedData) sessionEventData() {} +func (*FactoryRunUpdatedData) Type() SessionEventType { return SessionEventTypeFactoryRunUpdated } + // Ephemeral progress update from a running hook process type HookProgressData struct { // Human-readable progress message from the hook process Message string `json:"message"` + // When true, this status message replaces the previous temporary one instead of accumulating + Temporary *bool `json:"temporary,omitempty"` } func (*HookProgressData) sessionEventData() {} @@ -497,22 +764,50 @@ func (*ExternalToolRequestedData) Type() SessionEventType { type ModelCallFailureData struct { // Completion ID from the model provider (e.g., chatcmpl-abc123) APICallID *string `json:"apiCallId,omitempty"` + // API endpoint used for this model call, matching CAPI supported_endpoints vocabulary + APIEndpoint *AssistantUsageAPIEndpoint `json:"apiEndpoint,omitempty"` + // For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. + BadRequestKind *ModelCallFailureBadRequestKind `json:"badRequestKind,omitempty"` // Duration of the failed API call in milliseconds DurationMs *int64 `json:"durationMs,omitempty"` + // For HTTP 400 failures only: the `code` from the CAPI error envelope (e.g. 'model_max_prompt_tokens_exceeded') identifying which deterministic validation failure occurred. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + ErrorCode *string `json:"errorCode,omitempty"` // Raw provider/runtime error message for restricted telemetry ErrorMessage *string `json:"errorMessage,omitempty"` + // For HTTP 400 failures only: the `type` from the CAPI error envelope (e.g. 'websocket_error'), a coarser companion to errorCode for envelopes that carry no code. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + ErrorType *string `json:"errorType,omitempty"` + // Whether the failure originated from an API response or the request transport + FailureKind *ModelCallFailureKind `json:"failureKind,omitempty"` // What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls Initiator *string `json:"initiator,omitempty"` + // Whether the session selected Auto mode for the failed call + IsAuto *bool `json:"isAuto,omitempty"` + // Whether the failed call used a bring-your-own-key provider + IsByok *bool `json:"isByok,omitempty"` + // Effective maximum output-token limit for the failed call + MaxOutputTokens *int64 `json:"maxOutputTokens,omitempty"` + // Effective maximum prompt-token limit for the failed call + MaxPromptTokens *int64 `json:"maxPromptTokens,omitempty"` // Model identifier used for the failed API call Model *string `json:"model,omitempty"` // GitHub request tracing ID (x-github-request-id header) for server-side log correlation ProviderCallID *string `json:"providerCallId,omitempty"` + // Per-quota usage snapshots parsed from the failed response's quota headers, keyed by quota identifier. Present when the error response carried quota headers (e.g. a 402 once the additional spend limit is reached) so the UI can refresh the quota display on failure. + // Internal: QuotaSnapshots is part of the SDK's internal API surface and is not intended for external use. + QuotaSnapshots map[string]AssistantUsageQuotaSnapshot `json:"quotaSnapshots,omitzero"` + // Reasoning effort level used for the failed model call, if applicable + ReasoningEffort *string `json:"reasoningEffort,omitempty"` + // Content-free structural summary of the failing request. Contains only counts and shape flags (no prompt content), so it is safe for unrestricted telemetry. Populated only for client-error (4xx) failures. + RequestFingerprint *ModelCallFailureRequestFingerprint `json:"requestFingerprint,omitempty"` + Rte *bool `json:"rte,omitempty"` // Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation ServiceRequestID *string `json:"serviceRequestId,omitempty"` // Where the failed model call originated Source ModelCallFailureSource `json:"source"` // HTTP status code from the failed request StatusCode *int32 `json:"statusCode,omitempty"` + // Transport used for the failed model call (http or websocket) + Transport *ModelCallFailureTransport `json:"transport,omitempty"` } func (*ModelCallFailureData) sessionEventData() {} @@ -569,26 +864,39 @@ type AssistantUsageData struct { APICallID *string `json:"apiCallId,omitempty"` // API endpoint used for this model call, matching CAPI supported_endpoints vocabulary APIEndpoint *AssistantUsageAPIEndpoint `json:"apiEndpoint,omitempty"` + // Number of tools available to the model for this call + // Internal: AvailableToolCount is part of the SDK's internal API surface and is not intended for external use. + AvailableToolCount *int64 `json:"availableToolCount,omitempty"` + // Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. + CacheExpiresAt *time.Time `json:"cacheExpiresAt,omitempty"` // Number of tokens read from prompt cache CacheReadTokens *int64 `json:"cacheReadTokens,omitempty"` // Number of tokens written to prompt cache CacheWriteTokens *int64 `json:"cacheWriteTokens,omitempty"` + // Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason. + ContentFilterTriggered *bool `json:"contentFilterTriggered,omitempty"` // Per-request cost and usage data from the CAPI copilot_usage response field - // Internal: CopilotUsage is part of the SDK's internal API surface and is not intended for external use. CopilotUsage *AssistantUsageCopilotUsage `json:"copilotUsage,omitempty"` // Model multiplier cost for billing purposes // Experimental: Cost is part of an experimental API and may change or be removed. Cost *float64 `json:"cost,omitempty"` // Duration of the API call in milliseconds Duration *int64 `json:"duration,omitempty"` + // Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter". + FinishReason *string `json:"finishReason,omitempty"` // What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls Initiator *string `json:"initiator,omitempty"` // Number of input tokens consumed InputTokens *int64 `json:"inputTokens,omitempty"` + // Coarse classification of the interaction that produced this call, mirroring the session's per-request agent context (e.g. `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, `conversation-user`). Non-billing; lets consumers attribute a model call to a call class (e.g. sub-agent/sidekick) independently of the billing initiator. Absent when the runtime did not classify the request. + InteractionType *string `json:"interactionType,omitempty"` // Average inter-token latency in milliseconds. Only available for streaming requests InterTokenLatencyMs *float64 `json:"interTokenLatencyMs,omitempty"` // Model identifier used for this API call Model string `json:"model"` + // Number of tool calls returned by the model + // Internal: NumToolCalls is part of the SDK's internal API surface and is not intended for external use. + NumToolCalls *int64 `json:"numToolCalls,omitempty"` // Number of output tokens produced OutputTokens *int64 `json:"outputTokens,omitempty"` // Parent tool call ID when this usage originates from a sub-agent @@ -598,60 +906,124 @@ type AssistantUsageData struct { ProviderCallID *string `json:"providerCallId,omitempty"` // Per-quota resource usage snapshots, keyed by quota identifier // Internal: QuotaSnapshots is part of the SDK's internal API surface and is not intended for external use. - QuotaSnapshots map[string]AssistantUsageQuotaSnapshot `json:"quotaSnapshots,omitempty"` + QuotaSnapshots map[string]AssistantUsageQuotaSnapshot `json:"quotaSnapshots,omitzero"` // Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") ReasoningEffort *string `json:"reasoningEffort,omitempty"` // Number of output tokens used for reasoning (e.g., chain-of-thought) ReasoningTokens *int64 `json:"reasoningTokens,omitempty"` + Rte *bool `json:"rte,omitempty"` // Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation ServiceRequestID *string `json:"serviceRequestId,omitempty"` // Time to first token in milliseconds. Only available for streaming requests - TimeToFirstTokenMs *int64 `json:"timeToFirstTokenMs,omitempty"` + TimeToFirstTokenMs *float64 `json:"timeToFirstTokenMs,omitempty"` + // Tool-call counts keyed by tool name + // Internal: ToolCounts is part of the SDK's internal API surface and is not intended for external use. + ToolCounts map[string]int64 `json:"toolCounts,omitzero"` + // Number of tokens used by tool definitions for this call + // Internal: ToolTokenCount is part of the SDK's internal API surface and is not intended for external use. + ToolTokenCount *int64 `json:"toolTokenCount,omitempty"` } func (*AssistantUsageData) sessionEventData() {} func (*AssistantUsageData) Type() SessionEventType { return SessionEventTypeAssistantUsage } +// Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message +type AssistantServerToolProgressData struct { + // Kind of hosted server tool that is running. Only `web_search` is emitted today. + Kind string `json:"kind"` + // Position of the hosted tool call in the response output. Stable across the call's lifecycle events (unlike the provider's per-event item id, which CAPI rotates), so the host keys the live in-progress row on it. + OutputIndex int64 `json:"outputIndex"` + // Lifecycle status of the hosted call: `in_progress`, `searching`, or `completed`. + Status string `json:"status"` +} + +func (*AssistantServerToolProgressData) sessionEventData() {} +func (*AssistantServerToolProgressData) Type() SessionEventType { + return SessionEventTypeAssistantServerToolProgress +} + // MCP App view called a tool on a connected MCP server (SEP-1865) -type McpAppToolCallCompleteData struct { +type MCPAppToolCallCompleteData struct { // Arguments passed to the tool by the app view, if any - Arguments map[string]any `json:"arguments,omitempty"` + Arguments map[string]any `json:"arguments,omitzero"` // Wall-clock duration of the underlying tools/call in milliseconds DurationMs float64 `json:"durationMs"` // Set when the underlying tools/call threw an error before returning a CallToolResult - Error *McpAppToolCallCompleteError `json:"error,omitempty"` + Error *MCPAppToolCallCompleteError `json:"error,omitempty"` // Standard MCP CallToolResult returned by the server. Present whether or not the call set isError. - Result map[string]any `json:"result,omitempty"` + Result map[string]any `json:"result,omitzero"` // Name of the MCP server hosting the tool ServerName string `json:"serverName"` // True when the call completed without throwing AND the MCP CallToolResult did not set isError Success bool `json:"success"` // The tool's `_meta.ui` block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools. - ToolMeta *McpAppToolCallCompleteToolMeta `json:"toolMeta,omitempty"` + ToolMeta *MCPAppToolCallCompleteToolMeta `json:"toolMeta,omitempty"` // MCP tool name that was invoked ToolName string `json:"toolName"` } -func (*McpAppToolCallCompleteData) sessionEventData() {} -func (*McpAppToolCallCompleteData) Type() SessionEventType { - return SessionEventTypeMcpAppToolCallComplete +func (*MCPAppToolCallCompleteData) sessionEventData() {} +func (*MCPAppToolCallCompleteData) Type() SessionEventType { + return SessionEventTypeMCPAppToolCallComplete } // MCP OAuth request completion notification -type McpOauthCompletedData struct { +type MCPOauthCompletedData struct { + // How the pending OAuth request was completed + Outcome MCPOauthCompletionOutcome `json:"outcome"` // Request ID of the resolved OAuth request RequestID string `json:"requestId"` } -func (*McpOauthCompletedData) sessionEventData() {} -func (*McpOauthCompletedData) Type() SessionEventType { return SessionEventTypeMcpOauthCompleted } +func (*MCPOauthCompletedData) sessionEventData() {} +func (*MCPOauthCompletedData) Type() SessionEventType { return SessionEventTypeMCPOauthCompleted } + +// MCP headers refresh request completion notification +type MCPHeadersRefreshCompletedData struct { + // How the pending MCP headers refresh request resolved. + Outcome MCPHeadersRefreshCompletedOutcome `json:"outcome"` + // Request ID of the resolved headers refresh request + RequestID string `json:"requestId"` +} + +func (*MCPHeadersRefreshCompletedData) sessionEventData() {} +func (*MCPHeadersRefreshCompletedData) Type() SessionEventType { + return SessionEventTypeMCPHeadersRefreshCompleted +} + +// Metadata for an additional model inference attempt within an existing assistant turn +type AssistantTurnRetryData struct { + // Model identifier used for this retry, when known + Model *string `json:"model,omitempty"` + // Provider or runtime classification that caused the retry, when known + Reason *string `json:"reason,omitempty"` + // Identifier of the turn whose model inference is being retried + TurnID string `json:"turnId"` +} + +func (*AssistantTurnRetryData) sessionEventData() {} +func (*AssistantTurnRetryData) Type() SessionEventType { return SessionEventTypeAssistantTurnRetry } + +// Model API dispatch metadata for internal telemetry +type ModelCallStartData struct { + // Model identifier used for this API call, when known + Model *string `json:"model,omitempty"` + // Previous response or interaction identifier included in the model request, when present + // Internal: PreviousResponseID is part of the SDK's internal API surface and is not intended for external use. + PreviousResponseID *string `json:"previousResponseId,omitempty"` + // Identifier of the assistant turn that initiated the model call + TurnID string `json:"turnId"` +} + +func (*ModelCallStartData) sessionEventData() {} +func (*ModelCallStartData) Type() SessionEventType { return SessionEventTypeModelCallStart } // Model change details including previous and new model identifiers type SessionModelChangeData struct { - // 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. + // Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy. Cause *string `json:"cause,omitempty"` // Context tier after the model change; null explicitly clears a previously selected tier - ContextTier *SessionModelChangeDataContextTier `json:"contextTier,omitempty"` + ContextTier *ContextTier `json:"contextTier,omitempty"` // Newly selected model identifier NewModel string `json:"newModel"` // Model that was previously selected, if any @@ -660,10 +1032,14 @@ type SessionModelChangeData struct { PreviousReasoningEffort *string `json:"previousReasoningEffort,omitempty"` // Reasoning summary mode before the model change, if applicable PreviousReasoningSummary *ReasoningSummary `json:"previousReasoningSummary,omitempty"` + // Output verbosity level before the model change, if applicable + PreviousVerbosity *Verbosity `json:"previousVerbosity,omitempty"` // Reasoning effort level after the model change, if applicable ReasoningEffort *string `json:"reasoningEffort,omitempty"` // Reasoning summary mode after the model change, if applicable ReasoningSummary *ReasoningSummary `json:"reasoningSummary,omitempty"` + // Output verbosity level after the model change, if applicable + Verbosity *Verbosity `json:"verbosity,omitempty"` } func (*SessionModelChangeData) sessionEventData() {} @@ -681,30 +1057,38 @@ func (*SessionRemoteSteerableChangedData) Type() SessionEventType { } // OAuth authentication request for an MCP server -type McpOauthRequiredData struct { - // Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth() +type MCPOauthRequiredData struct { + // Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. Header order and casing are transport-dependent, and duplicate header names may appear multiple times. + HTTPResponse *MCPOauthHTTPResponse `json:"httpResponse,omitempty"` + // Why the runtime is requesting host-provided OAuth credentials. + Reason MCPOauthRequestReason `json:"reason"` + // Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest RequestID string `json:"requestId"` + // Raw OAuth protected-resource metadata document fetched for the MCP server, if available + ResourceMetadata *string `json:"resourceMetadata,omitempty"` // Display name of the MCP server that requires OAuth ServerName string `json:"serverName"` // URL of the MCP server that requires OAuth ServerURL string `json:"serverUrl"` // Static OAuth client configuration, if the server specifies one - StaticClientConfig *McpOauthRequiredStaticClientConfig `json:"staticClientConfig,omitempty"` + StaticClientConfig *MCPOauthRequiredStaticClientConfig `json:"staticClientConfig,omitempty"` + // OAuth WWW-Authenticate parameters parsed from the auth challenge, if available + WwwAuthenticateParams *MCPOauthWwwAuthenticateParams `json:"wwwAuthenticateParams,omitempty"` } -func (*McpOauthRequiredData) sessionEventData() {} -func (*McpOauthRequiredData) Type() SessionEventType { return SessionEventTypeMcpOauthRequired } +func (*MCPOauthRequiredData) sessionEventData() {} +func (*MCPOauthRequiredData) Type() SessionEventType { return SessionEventTypeMCPOauthRequired } // Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. type SessionCustomNotificationData struct { // Source-defined custom notification name Name string `json:"name"` // Source-defined JSON payload for the custom notification - Payload CustomNotificationPayload `json:"payload"` + Payload any `json:"payload"` // Namespace for the custom notification producer Source string `json:"source"` // Optional source-defined string identifiers describing the payload subject - Subject map[string]string `json:"subject,omitempty"` + Subject map[string]string `json:"subject,omitzero"` // Optional source-defined payload schema version Version *int64 `json:"version,omitempty"` } @@ -714,7 +1098,47 @@ func (*SessionCustomNotificationData) Type() SessionEventType { return SessionEventTypeSessionCustomNotification } -// Payload indicating the session is idle with no background agents in flight +// Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred +type AssistantIdleData struct { + // True when the preceding agentic loop was cancelled via abort signal + Aborted *bool `json:"aborted,omitempty"` +} + +func (*AssistantIdleData) sessionEventData() {} +func (*AssistantIdleData) Type() SessionEventType { return SessionEventTypeAssistantIdle } + +// Payload identifying the MCP server associated with a list change. +type MCPPromptsListChangedData struct { + // Name of the MCP server whose list changed + ServerName string `json:"serverName"` +} + +func (*MCPPromptsListChangedData) sessionEventData() {} +func (*MCPPromptsListChangedData) Type() SessionEventType { + return SessionEventTypeMCPPromptsListChanged +} + +// Payload identifying the MCP server associated with a list change. +type MCPResourcesListChangedData struct { + // Name of the MCP server whose list changed + ServerName string `json:"serverName"` +} + +func (*MCPResourcesListChangedData) sessionEventData() {} +func (*MCPResourcesListChangedData) Type() SessionEventType { + return SessionEventTypeMCPResourcesListChanged +} + +// Payload identifying the MCP server associated with a list change. +type MCPToolsListChangedData struct { + // Name of the MCP server whose list changed + ServerName string `json:"serverName"` +} + +func (*MCPToolsListChangedData) sessionEventData() {} +func (*MCPToolsListChangedData) Type() SessionEventType { return SessionEventTypeMCPToolsListChanged } + +// Payload indicating the session is idle with no background agents or attached shell commands in flight type SessionIdleData struct { // True when the preceding agentic loop was cancelled via abort signal Aborted *bool `json:"aborted,omitempty"` @@ -723,6 +1147,168 @@ type SessionIdleData struct { func (*SessionIdleData) sessionEventData() {} func (*SessionIdleData) Type() SessionEventType { return SessionEventTypeSessionIdle } +// Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. +// Experimental: SessionCanvasClosedData is part of an experimental API and may change or be removed. +type SessionCanvasClosedData struct { + // Provider-local canvas identifier + CanvasID string `json:"canvasId"` + // Owning provider identifier + ExtensionID string `json:"extensionId"` + // Stable caller-supplied identifier of the canvas instance that was closed + InstanceID string `json:"instanceId"` +} + +func (*SessionCanvasClosedData) sessionEventData() {} +func (*SessionCanvasClosedData) Type() SessionEventType { return SessionEventTypeSessionCanvasClosed } + +// Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. +// Experimental: SessionCanvasOpenedData is part of an experimental API and may change or be removed. +type SessionCanvasOpenedData struct { + // Provider-local canvas identifier + CanvasID string `json:"canvasId"` + // Owning provider identifier + ExtensionID string `json:"extensionId"` + // Owning extension display name, when available + ExtensionName *string `json:"extensionName,omitempty"` + // Host-local PNG path for the canvas icon, when supplied + Icon *string `json:"icon,omitempty"` + // Input supplied when the instance was opened + Input any `json:"input,omitempty"` + // Stable caller-supplied canvas instance identifier + InstanceID string `json:"instanceId"` + // Provider-supplied status text + Status *string `json:"status,omitempty"` + // Rendered title + Title *string `json:"title,omitempty"` + // URL for web-rendered canvases + URL *string `json:"url,omitempty"` +} + +func (*SessionCanvasOpenedData) sessionEventData() {} +func (*SessionCanvasOpenedData) Type() SessionEventType { return SessionEventTypeSessionCanvasOpened } + +// Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. +// Experimental: SessionCanvasRegistryChangedData is part of an experimental API and may change or be removed. +type SessionCanvasRegistryChangedData struct { + // Canvas declarations currently available + Canvases []CanvasRegistryChangedCanvas `json:"canvases"` +} + +func (*SessionCanvasRegistryChangedData) sessionEventData() {} +func (*SessionCanvasRegistryChangedData) Type() SessionEventType { + return SessionEventTypeSessionCanvasRegistryChanged +} + +// Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. +type SessionCustomAgentsUpdatedData struct { + // Array of loaded custom agent metadata + Agents []CustomAgentsUpdatedAgent `json:"agents"` + // Fatal errors from agent loading + Errors []string `json:"errors"` + // Non-fatal warnings from agent loading + Warnings []string `json:"warnings"` +} + +func (*SessionCustomAgentsUpdatedData) sessionEventData() {} +func (*SessionCustomAgentsUpdatedData) Type() SessionEventType { + return SessionEventTypeSessionCustomAgentsUpdated +} + +// Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. +type SessionExtensionsAttachmentsPushedData struct { + // Attachments contributed by an extension; the host should surface these as composer pills and forward them via the next session.send call. + Attachments []Attachment `json:"attachments"` +} + +func (*SessionExtensionsAttachmentsPushedData) sessionEventData() {} +func (*SessionExtensionsAttachmentsPushedData) Type() SessionEventType { + return SessionEventTypeSessionExtensionsAttachmentsPushed +} + +// Payload of `session.extensions_loaded` listing discovered extensions and their statuses. +type SessionExtensionsLoadedData struct { + // Array of discovered extensions and their status + Extensions []ExtensionsLoadedExtension `json:"extensions"` +} + +func (*SessionExtensionsLoadedData) sessionEventData() {} +func (*SessionExtensionsLoadedData) Type() SessionEventType { + return SessionEventTypeSessionExtensionsLoaded +} + +// Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. +type SessionMCPServerStatusChangedData struct { + // Error message if the server entered a failed state + Error *string `json:"error,omitempty"` + // Name of the MCP server whose status changed + ServerName string `json:"serverName"` + // Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured + Status MCPServerStatus `json:"status"` +} + +func (*SessionMCPServerStatusChangedData) sessionEventData() {} +func (*SessionMCPServerStatusChangedData) Type() SessionEventType { + return SessionEventTypeSessionMCPServerStatusChanged +} + +// Payload of `session.mcp_servers_loaded` listing MCP server status summaries. +type SessionMCPServersLoadedData struct { + // Array of MCP server status summaries + Servers []MCPServersLoadedServer `json:"servers"` +} + +func (*SessionMCPServersLoadedData) sessionEventData() {} +func (*SessionMCPServersLoadedData) Type() SessionEventType { + return SessionEventTypeSessionMCPServersLoaded +} + +// Payload of `session.skills_loaded` listing resolved skill metadata. +type SessionSkillsLoadedData struct { + // Array of resolved skill metadata + Skills []SkillsLoadedSkill `json:"skills"` +} + +func (*SessionSkillsLoadedData) sessionEventData() {} +func (*SessionSkillsLoadedData) Type() SessionEventType { return SessionEventTypeSessionSkillsLoaded } + +// Payload of `session.tools_updated` identifying the model whose resolved tools were updated. +type SessionToolsUpdatedData struct { + // Identifier of the model the resolved tools apply to. + Model string `json:"model"` +} + +func (*SessionToolsUpdatedData) sessionEventData() {} +func (*SessionToolsUpdatedData) Type() SessionEventType { return SessionEventTypeSessionToolsUpdated } + +// Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. +type UserMessageData struct { + // The agent mode that was active when this message was sent + AgentMode *UserMessageAgentMode `json:"agentMode,omitempty"` + // Files, selections, or GitHub references attached to the message + Attachments []Attachment `json:"attachments,omitzero"` + // The user's message text as displayed in the timeline + Content string `json:"content"` + // How this message was delivered to the agentic loop relative to loop state (idle-start vs. steering/queued while busy). The timing axis; combine with `source` (origin) for the full picture. Used for telemetry attribution. + Delivery *UserMessageDelivery `json:"delivery,omitempty"` + // CAPI interaction ID for correlating this user message with its turn + InteractionID *string `json:"interactionId,omitempty"` + // True when this user message was auto-injected by autopilot's continuation loop rather than typed by the user; used to distinguish autopilot-driven turns in telemetry. + IsAutopilotContinuation *bool `json:"isAutopilotContinuation,omitempty"` + // Path-backed native document attachments that stayed on the tagged_files path flow because native upload could not read them or would exceed the request size limit + NativeDocumentPathFallbackPaths []string `json:"nativeDocumentPathFallbackPaths,omitzero"` + // Parent agent task ID for background telemetry correlated to this user turn + ParentAgentTaskID *string `json:"parentAgentTaskId,omitempty"` + // Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-` for an inter-agent prompt) + Source *string `json:"source,omitempty"` + // Normalized document MIME types that were sent natively instead of through tagged_files XML + SupportedNativeDocumentMIMETypes []string `json:"supportedNativeDocumentMimeTypes,omitzero"` + // Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching + TransformedContent *string `json:"transformedContent,omitempty"` +} + +func (*UserMessageData) sessionEventData() {} +func (*UserMessageData) Type() SessionEventType { return SessionEventTypeUserMessage } + // Permission request completion notification signaling UI dismissal type PermissionCompletedData struct { // Request ID of the resolved permission request; clients should dismiss any UI for this request @@ -746,15 +1332,23 @@ type PermissionRequestedData struct { RequestID string `json:"requestId"` // When true, this permission was already resolved by a permissionRequest hook and requires no client action ResolvedByHook *bool `json:"resolvedByHook,omitempty"` + // Neutral risk metadata supplied by the tool host. Consumers may display this value but must not use it to bypass the permission decision. + RiskAssessment any `json:"riskAssessment,omitempty"` } func (*PermissionRequestedData) sessionEventData() {} func (*PermissionRequestedData) Type() SessionEventType { return SessionEventTypePermissionRequested } -// Permissions change details carrying the aggregate allow-all boolean transition. +// Permissions change details carrying the aggregate allow-all transition. type SessionPermissionsChangedData struct { + // Allow-all mode after the change + // Experimental: AllowAllPermissionMode is part of an experimental API and may change or be removed. + AllowAllPermissionMode *PermissionAllowAllMode `json:"allowAllPermissionMode,omitempty"` // Aggregate allow-all flag after the change AllowAllPermissions bool `json:"allowAllPermissions"` + // Allow-all mode before the change + // Experimental: PreviousAllowAllPermissionMode is part of an experimental API and may change or be removed. + PreviousAllowAllPermissionMode *PermissionAllowAllMode `json:"previousAllowAllPermissionMode,omitempty"` // Aggregate allow-all flag before the change PreviousAllowAllPermissions bool `json:"previousAllowAllPermissions"` } @@ -764,6 +1358,17 @@ func (*SessionPermissionsChangedData) Type() SessionEventType { return SessionEventTypeSessionPermissionsChanged } +// Persisted generic client-side tool activations restored when a session resumes. +type ToolSearchActivatedData struct { + // Tool-search strategy that activated the definitions. + Strategy string `json:"strategy"` + // Names of tool definitions activated by this search invocation. + ToolNames []string `json:"toolNames"` +} + +func (*ToolSearchActivatedData) sessionEventData() {} +func (*ToolSearchActivatedData) Type() SessionEventType { return SessionEventTypeToolSearchActivated } + // Plan approval request with plan content and available user actions type ExitPlanModeRequestedData struct { // Available actions the user can take @@ -846,6 +1451,26 @@ type CommandExecuteData struct { func (*CommandExecuteData) sessionEventData() {} func (*CommandExecuteData) Type() SessionEventType { return SessionEventTypeCommandExecute } +// Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. +// Experimental: SessionManagedSettingsEnforcedData is part of an experimental API and may change or be removed. +type SessionManagedSettingsEnforcedData struct { + // The category of runtime action that managed policy governed. + Action ManagedSettingsEnforcedAction `json:"action"` + // For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused. Absent for actions without a specific escalation primitive. + Escalation *ManagedSettingsEnforcedEscalation `json:"escalation,omitempty"` + // Whether the enforcement was forced by fail-closed handling (managed policy could not be determined) rather than an explicit managed setting. When true, `setting` still names the restriction that was applied. + FailClosed bool `json:"failClosed"` + // A human-readable explanation of why the action was governed, suitable for surfacing to the user. + Message string `json:"message"` + // The managed setting key responsible for the enforcement (e.g. `permissions.disableBypassPermissionsMode`). + Setting string `json:"setting"` +} + +func (*SessionManagedSettingsEnforcedData) sessionEventData() {} +func (*SessionManagedSettingsEnforcedData) Type() SessionEventType { + return SessionEventTypeSessionManagedSettingsEnforced +} + // SDK command registration change notification type CommandsChangedData struct { // Current list of registered SDK commands @@ -867,7 +1492,7 @@ func (*SamplingCompletedData) Type() SessionEventType { return SessionEventTypeS // Sampling request from an MCP server; contains the server name and a requestId for correlation type SamplingRequestedData struct { // The JSON-RPC request ID from the MCP protocol - McpRequestID any `json:"mcpRequestId"` + MCPRequestID any `json:"mcpRequestId"` // Unique identifier for this sampling request; used to respond via session.respondToSampling() RequestID string `json:"requestId"` // Name of the MCP server that initiated the sampling request @@ -890,16 +1515,26 @@ func (*SessionScheduleCancelledData) Type() SessionEventType { // Scheduled prompt registered via /every or /after type SessionScheduleCreatedData struct { + // Absolute fire time (epoch milliseconds) for a one-shot calendar schedule + At *int64 `json:"at,omitempty"` + // 5-field cron expression for a recurring calendar schedule, evaluated in `tz` + Cron *string `json:"cron,omitempty"` // Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion) DisplayPrompt *string `json:"displayPrompt,omitempty"` // Sequential id assigned to the scheduled prompt within the session ID int64 `json:"id"` - // Interval between ticks in milliseconds - IntervalMs int64 `json:"intervalMs"` + // Interval between ticks in milliseconds (relative-interval schedules) + IntervalMs *int64 `json:"intervalMs,omitempty"` + // Who created the schedule (`user` or `model`). Persisted so a resumed session keeps gating non-user schedules from firing skills that opted out of model invocation. Absent on entries created before this field existed; a missing origin fails closed (treated the same as a non-user origin), so such a schedule may not resolve a `disable-model-invocation` skill. + Origin *ScheduleOrigin `json:"origin,omitempty"` // Prompt text that gets enqueued on every tick Prompt string `json:"prompt"` // Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`) Recurring *bool `json:"recurring,omitempty"` + // True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled rather than auto-computed. + SelfPaced *bool `json:"selfPaced,omitempty"` + // IANA timezone the `cron` expression is evaluated in + Tz *string `json:"tz,omitempty"` } func (*SessionScheduleCreatedData) sessionEventData() {} @@ -907,150 +1542,19 @@ func (*SessionScheduleCreatedData) Type() SessionEventType { return SessionEventTypeSessionScheduleCreated } -// Schema for the `BackgroundTasksChangedData` type. -type SessionBackgroundTasksChangedData struct { -} - -func (*SessionBackgroundTasksChangedData) sessionEventData() {} -func (*SessionBackgroundTasksChangedData) Type() SessionEventType { - return SessionEventTypeSessionBackgroundTasksChanged -} - -// Schema for the `CanvasOpenedData` type. -type SessionCanvasOpenedData struct { - // Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. - Availability CanvasOpenedAvailability `json:"availability"` - // Provider-local canvas identifier - CanvasID string `json:"canvasId"` - // Owning provider identifier - ExtensionID string `json:"extensionId"` - // Owning extension display name, when available - ExtensionName *string `json:"extensionName,omitempty"` - // Input supplied when the instance was opened - Input any `json:"input,omitempty"` - // Stable caller-supplied canvas instance identifier - InstanceID string `json:"instanceId"` - // Whether this notification represents an idempotent reopen - Reopen bool `json:"reopen"` - // Provider-supplied status text - Status *string `json:"status,omitempty"` - // Rendered title - Title *string `json:"title,omitempty"` - // URL for web-rendered canvases - URL *string `json:"url,omitempty"` -} - -func (*SessionCanvasOpenedData) sessionEventData() {} -func (*SessionCanvasOpenedData) Type() SessionEventType { return SessionEventTypeSessionCanvasOpened } - -// Schema for the `CanvasRegistryChangedData` type. -type SessionCanvasRegistryChangedData struct { - // Canvas declarations currently available - Canvases []CanvasRegistryChangedCanvas `json:"canvases"` -} - -func (*SessionCanvasRegistryChangedData) sessionEventData() {} -func (*SessionCanvasRegistryChangedData) Type() SessionEventType { - return SessionEventTypeSessionCanvasRegistryChanged -} - -// Schema for the `CustomAgentsUpdatedData` type. -type SessionCustomAgentsUpdatedData struct { - // Array of loaded custom agent metadata - Agents []CustomAgentsUpdatedAgent `json:"agents"` - // Fatal errors from agent loading - Errors []string `json:"errors"` - // Non-fatal warnings from agent loading - Warnings []string `json:"warnings"` -} - -func (*SessionCustomAgentsUpdatedData) sessionEventData() {} -func (*SessionCustomAgentsUpdatedData) Type() SessionEventType { - return SessionEventTypeSessionCustomAgentsUpdated -} - -// Schema for the `ExtensionsLoadedData` type. -type SessionExtensionsLoadedData struct { - // Array of discovered extensions and their status - Extensions []ExtensionsLoadedExtension `json:"extensions"` -} - -func (*SessionExtensionsLoadedData) sessionEventData() {} -func (*SessionExtensionsLoadedData) Type() SessionEventType { - return SessionEventTypeSessionExtensionsLoaded -} - -// Schema for the `McpServerStatusChangedData` type. -type SessionMcpServerStatusChangedData struct { - // Error message if the server entered a failed state - Error *string `json:"error,omitempty"` - // Name of the MCP server whose status changed - ServerName string `json:"serverName"` - // Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - Status McpServerStatus `json:"status"` -} - -func (*SessionMcpServerStatusChangedData) sessionEventData() {} -func (*SessionMcpServerStatusChangedData) Type() SessionEventType { - return SessionEventTypeSessionMcpServerStatusChanged -} - -// Schema for the `McpServersLoadedData` type. -type SessionMcpServersLoadedData struct { - // Array of MCP server status summaries - Servers []McpServersLoadedServer `json:"servers"` -} - -func (*SessionMcpServersLoadedData) sessionEventData() {} -func (*SessionMcpServersLoadedData) Type() SessionEventType { - return SessionEventTypeSessionMcpServersLoaded -} - -// Schema for the `SkillsLoadedData` type. -type SessionSkillsLoadedData struct { - // Array of resolved skill metadata - Skills []SkillsLoadedSkill `json:"skills"` -} - -func (*SessionSkillsLoadedData) sessionEventData() {} -func (*SessionSkillsLoadedData) Type() SessionEventType { return SessionEventTypeSessionSkillsLoaded } - -// Schema for the `ToolsUpdatedData` type. -type SessionToolsUpdatedData struct { - // Identifier of the model the resolved tools apply to. - Model string `json:"model"` +// Self-paced schedule re-armed for its next run +type SessionScheduleRearmedData struct { + // Id of the self-paced schedule that was re-armed + ID int64 `json:"id"` + // Absolute time (epoch milliseconds) the model armed the next run to fire + NextRunAt int64 `json:"nextRunAt"` } -func (*SessionToolsUpdatedData) sessionEventData() {} -func (*SessionToolsUpdatedData) Type() SessionEventType { return SessionEventTypeSessionToolsUpdated } - -// Schema for the `UserMessageData` type. -type UserMessageData struct { - // The agent mode that was active when this message was sent - AgentMode *UserMessageAgentMode `json:"agentMode,omitempty"` - // Files, selections, or GitHub references attached to the message - Attachments []UserMessageAttachment `json:"attachments,omitempty"` - // The user's message text as displayed in the timeline - Content string `json:"content"` - // CAPI interaction ID for correlating this user message with its turn - InteractionID *string `json:"interactionId,omitempty"` - // True when this user message was auto-injected by autopilot's continuation loop rather than typed by the user; used to distinguish autopilot-driven turns in telemetry. - IsAutopilotContinuation *bool `json:"isAutopilotContinuation,omitempty"` - // Path-backed native document attachments that stayed on the tagged_files path flow because native upload could not read them or would exceed the request size limit - NativeDocumentPathFallbackPaths []string `json:"nativeDocumentPathFallbackPaths,omitempty"` - // Parent agent task ID for background telemetry correlated to this user turn - ParentAgentTaskID *string `json:"parentAgentTaskId,omitempty"` - // Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user) - Source *string `json:"source,omitempty"` - // Normalized document MIME types that were sent natively instead of through tagged_files XML - SupportedNativeDocumentMIMETypes []string `json:"supportedNativeDocumentMimeTypes,omitempty"` - // Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching - TransformedContent *string `json:"transformedContent,omitempty"` +func (*SessionScheduleRearmedData) sessionEventData() {} +func (*SessionScheduleRearmedData) Type() SessionEventType { + return SessionEventTypeSessionScheduleRearmed } -func (*UserMessageData) sessionEventData() {} -func (*UserMessageData) Type() SessionEventType { return SessionEventTypeUserMessage } - // Session capability change notification type CapabilitiesChangedData struct { // UI capability changes @@ -1088,11 +1592,13 @@ type SessionStartData struct { // Working directory and git context at session start Context *WorkingDirectoryContext `json:"context,omitempty"` // Context tier selected at session creation time for models with tiered context pricing; null when no tier is selected (e.g., non-tiered model) - ContextTier *SessionStartDataContextTier `json:"contextTier,omitempty"` + ContextTier *ContextTier `json:"contextTier,omitempty"` // Version string of the Copilot application CopilotVersion string `json:"copilotVersion"` // When set, identifies a parent session whose context this session continues — e.g., a detached headless rem-agent run launched on the parent's interactive shutdown. Telemetry from this session is reported under the parent's session_id. DetachedFromSpawningParentSessionID *string `json:"detachedFromSpawningParentSessionId,omitempty"` + // Per-session GitHub MCP override persisted for cold resume + GitHubMCPToolConfig *GitHubMCPToolConfig `json:"githubMcpToolConfig,omitempty"` // Identifier of the software producing the events (e.g., "copilot-agent") Producer string `json:"producer"` // Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") @@ -1105,8 +1611,12 @@ type SessionStartData struct { SelectedModel *string `json:"selectedModel,omitempty"` // Unique identifier for the session SessionID string `json:"sessionId"` + // Session limits configured at session creation time, if any + SessionLimits *SessionLimitsConfig `json:"sessionLimits,omitempty"` // ISO 8601 timestamp when the session was created StartTime time.Time `json:"startTime"` + // Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") + Verbosity *Verbosity `json:"verbosity,omitempty"` // Schema version number for the session event format Version int64 `json:"version"` } @@ -1114,6 +1624,45 @@ type SessionStartData struct { func (*SessionStartData) sessionEventData() {} func (*SessionStartData) Type() SessionEventType { return SessionEventTypeSessionStart } +// Session limit exhaustion notification requiring user action. +type SessionLimitsExhaustedRequestedData struct { + // Configured max AI Credits for the current accounting window. + MaxAiCredits float64 `json:"maxAiCredits"` + // Unique identifier for this request; used to respond via session.ui.handlePendingSessionLimitsExhausted(). + RequestID string `json:"requestId"` + // AI Credits already consumed in the current accounting window. + UsedAiCredits float64 `json:"usedAiCredits"` +} + +func (*SessionLimitsExhaustedRequestedData) sessionEventData() {} +func (*SessionLimitsExhaustedRequestedData) Type() SessionEventType { + return SessionEventTypeSessionLimitsExhaustedRequested +} + +// Session limit exhaustion prompt completion notification. +type SessionLimitsExhaustedCompletedData struct { + // Request ID of the resolved request; clients should dismiss any UI for this request. + RequestID string `json:"requestId"` + // The user's selected session-limit action. + Response SessionLimitsExhaustedResponse `json:"response"` +} + +func (*SessionLimitsExhaustedCompletedData) sessionEventData() {} +func (*SessionLimitsExhaustedCompletedData) Type() SessionEventType { + return SessionEventTypeSessionLimitsExhaustedCompleted +} + +// Session limits update details. Null clears the limits. +type SessionSessionLimitsChangedData struct { + // Current session limits, or null when no limits are active + SessionLimits *SessionLimitsConfig `json:"sessionLimits"` +} + +func (*SessionSessionLimitsChangedData) sessionEventData() {} +func (*SessionSessionLimitsChangedData) Type() SessionEventType { + return SessionEventTypeSessionSessionLimitsChanged +} + // Session resume metadata including current context and event count type SessionResumeData struct { // Whether the session was already in use by another client at resume time @@ -1121,11 +1670,13 @@ type SessionResumeData struct { // Updated working directory and git context at resume time Context *WorkingDirectoryContext `json:"context,omitempty"` // Context tier currently selected at resume time; null when no tier is active - ContextTier *SessionResumeDataContextTier `json:"contextTier,omitempty"` - // 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. + ContextTier *ContextTier `json:"contextTier,omitempty"` + // 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 or omitted, pending work is normally marked as interrupted unless the resume passively joined live work owned by another client; sessionWasActive distinguishes that case. ContinuePendingWork *bool `json:"continuePendingWork,omitempty"` // Total number of persisted events in the session at the time of resume EventCount int64 `json:"eventCount"` + // On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd + EventsFileSizeBytes *int64 `json:"eventsFileSizeBytes,omitempty"` // Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") ReasoningEffort *string `json:"reasoningEffort,omitempty"` // Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed") @@ -1136,8 +1687,12 @@ type SessionResumeData struct { ResumeTime time.Time `json:"resumeTime"` // Model currently selected at resume time SelectedModel *string `json:"selectedModel,omitempty"` - // 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. + // Session limits currently configured at resume time; null when no limits are active + SessionLimits *SessionLimitsConfig `json:"sessionLimits,omitempty"` + // True when this resume passively joined a session that already had live work running in the runtime - an agent turn, a native queue run, a queued resume continuation, or an in-flight send (for example, an extension joining a session another client was actively driving). False (or omitted) when the session had no live work or when the resume explicitly abandoned pending work, including cold resumes and suspended sessions that remain resident in memory. SessionWasActive *bool `json:"sessionWasActive,omitempty"` + // Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") + Verbosity *Verbosity `json:"verbosity,omitempty"` } func (*SessionResumeData) sessionEventData() {} @@ -1168,6 +1723,8 @@ type SessionShutdownData struct { CurrentTokens *int64 `json:"currentTokens,omitempty"` // Error description when shutdownType is "error" ErrorReason *string `json:"errorReason,omitempty"` + // On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd + EventsFileSizeBytes *int64 `json:"eventsFileSizeBytes,omitempty"` // Per-model usage breakdown, keyed by model identifier ModelMetrics map[string]ShutdownModelMetric `json:"modelMetrics"` // Unix timestamp (milliseconds) when the session started @@ -1177,7 +1734,7 @@ type SessionShutdownData struct { // System message token count at shutdown SystemTokens *int64 `json:"systemTokens,omitempty"` // Session-wide per-token-type accumulated token counts - TokenDetails map[string]ShutdownTokenDetail `json:"tokenDetails,omitempty"` + TokenDetails map[string]ShutdownTokenDetail `json:"tokenDetails,omitzero"` // Tool definitions token count at shutdown ToolDefinitionsTokens *int64 `json:"toolDefinitionsTokens,omitempty"` // Cumulative time spent in API calls during the session, in milliseconds @@ -1202,14 +1759,23 @@ type SessionTitleChangedData struct { func (*SessionTitleChangedData) sessionEventData() {} func (*SessionTitleChangedData) Type() SessionEventType { return SessionEventTypeSessionTitleChanged } +// Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. +type SessionTodosChangedData struct { +} + +func (*SessionTodosChangedData) sessionEventData() {} +func (*SessionTodosChangedData) Type() SessionEventType { return SessionEventTypeSessionTodosChanged } + // Skill invocation details including content, allowed tools, and plugin metadata type SkillInvokedData struct { // Tool names that should be auto-approved when this skill is active - AllowedTools []string `json:"allowedTools,omitempty"` + AllowedTools []string `json:"allowedTools,omitzero"` // Full content of the skill file, injected into the conversation for the model Content string `json:"content"` // Description of the skill from its SKILL.md frontmatter Description *string `json:"description,omitempty"` + // Model identifier active when the skill was invoked, when known + Model *string `json:"model,omitempty"` // Name of the invoked skill Name string `json:"name"` // File path to the SKILL.md definition @@ -1218,7 +1784,7 @@ type SkillInvokedData struct { PluginName *string `json:"pluginName,omitempty"` // Version of the plugin this skill originated from, when applicable PluginVersion *string `json:"pluginVersion,omitempty"` - // Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) + // Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) Source *string `json:"source,omitempty"` // What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent) Trigger *SkillInvokedTrigger `json:"trigger,omitempty"` @@ -1293,12 +1859,31 @@ func (*ToolExecutionPartialResultData) Type() SessionEventType { return SessionEventTypeToolExecutionPartialResult } +// Streaming tool-call input delta for incremental tool-call updates +type AssistantToolCallDeltaData struct { + // Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input. + InputDelta string `json:"inputDelta"` + // Tool call ID this delta belongs to, matching the corresponding assistant.message tool request + ToolCallID string `json:"toolCallId"` + // Name of the tool being invoked, when known from the stream + ToolName *string `json:"toolName,omitempty"` + // Tool call type, when known from the stream + ToolType *AssistantMessageToolRequestType `json:"toolType,omitempty"` +} + +func (*AssistantToolCallDeltaData) sessionEventData() {} +func (*AssistantToolCallDeltaData) Type() SessionEventType { + return SessionEventTypeAssistantToolCallDelta +} + // Sub-agent completion details for successful execution type SubagentCompletedData struct { // Human-readable display name of the sub-agent AgentDisplayName string `json:"agentDisplayName"` // Internal name of the sub-agent AgentName string `json:"agentName"` + // Whether the sub-agent was torn down by cancellation - its own abort, or an ancestor being killed - instead of finishing its work. Cancellation is not a failure, so the run still reports completion; this distinguishes a torn-down sub-agent from one that ran to the end. + Cancelled *bool `json:"cancelled,omitempty"` // Wall-clock duration of the sub-agent execution in milliseconds DurationMs *int64 `json:"durationMs,omitempty"` // Model used by the sub-agent @@ -1324,7 +1909,7 @@ type SubagentFailedData struct { DurationMs *int64 `json:"durationMs,omitempty"` // Error message describing why the sub-agent failed Error string `json:"error"` - // Model used by the sub-agent (if any model calls succeeded before failure) + // Model selected for the sub-agent, when known Model *string `json:"model,omitempty"` // Tool call ID of the parent tool invocation that spawned this sub-agent ToolCallID string `json:"toolCallId"` @@ -1345,7 +1930,7 @@ type SubagentStartedData struct { AgentDisplayName string `json:"agentDisplayName"` // Internal name of the sub-agent AgentName string `json:"agentName"` - // Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck). + // Model the sub-agent will run with, when known at start. Model *string `json:"model,omitempty"` // Tool call ID of the parent tool invocation that spawned this sub-agent ToolCallID string `json:"toolCallId"` @@ -1369,6 +1954,8 @@ func (*SystemNotificationData) Type() SessionEventType { return SessionEventType type SystemMessageData struct { // The system or developer prompt text sent as model input Content string `json:"content"` + // Logical interaction identifier for the model run receiving this prompt + InteractionID *string `json:"interactionId,omitempty"` // Metadata about the prompt template and its construction Metadata *SystemMessageMetadata `json:"metadata,omitempty"` // Optional name identifier for the message source @@ -1382,7 +1969,13 @@ func (*SystemMessageData) Type() SessionEventType { return SessionEventTypeSyste // Task completion notification with summary from the agent type SessionTaskCompleteData struct { - // Whether the tool call succeeded. False when validation failed (e.g., invalid arguments) + // Active autopilot objective ID evaluated by the completion reviewer + ObjectiveID *int64 `json:"objectiveId,omitempty"` + // Semantic completion decision. Absent on legacy events and invalid tool calls + Outcome *TaskCompletionOutcome `json:"outcome,omitempty"` + // Label-safe runtime rationale for the completion decision (e.g. a cancellation or pause/resume downgrade), when one applies. Reviewer-authored rationale is intentionally omitted here because this event has no IFC label channel; the reviewer's findings remain available through its own labeled sub-agent events + Reason *string `json:"reason,omitempty"` + // Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer Success *bool `json:"success,omitempty"` // Summary of the completed task, provided by the agent Summary *string `json:"summary,omitempty"` @@ -1399,6 +1992,9 @@ type ToolExecutionCompleteData struct { InteractionID *string `json:"interactionId,omitempty"` // Whether this tool call was explicitly requested by the user rather than the assistant IsUserRequested *bool `json:"isUserRequested,omitempty"` + // FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels). Persisted as `{ ifc: ... }` so the label survives session resume, including model-visible failure results. Experimental. + // Experimental: MCPMeta is part of an experimental API and may change or be removed. + MCPMeta any `json:"mcpMeta,omitempty"` // Model identifier that generated this tool call Model *string `json:"model,omitempty"` // Tool call ID of the parent tool invocation when this event originates from a sub-agent @@ -1406,6 +2002,7 @@ type ToolExecutionCompleteData struct { ParentToolCallID *string `json:"parentToolCallId,omitempty"` // Tool execution result on success Result *ToolExecutionCompleteResult `json:"result,omitempty"` + Rte *bool `json:"rte,omitempty"` // Whether this tool execution ran inside a sandbox container Sandboxed *bool `json:"sandboxed,omitempty"` // Whether the tool execution completed successfully @@ -1415,7 +2012,7 @@ type ToolExecutionCompleteData struct { // Tool definition metadata, present for MCP tools with MCP Apps support ToolDescription *ToolExecutionCompleteToolDescription `json:"toolDescription,omitempty"` // Tool-specific telemetry data (e.g., CodeQL check counts, grep match counts) - ToolTelemetry map[string]any `json:"toolTelemetry,omitempty"` + ToolTelemetry map[string]any `json:"toolTelemetry,omitzero"` // Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event TurnID *string `json:"turnId,omitempty"` } @@ -1445,14 +2042,21 @@ type ToolExecutionStartData struct { // When true, the tool output should be displayed expanded (verbatim) in the CLI timeline DisplayVerbatim *bool `json:"displayVerbatim,omitempty"` // Name of the MCP server hosting this tool, when the tool is an MCP tool - McpServerName *string `json:"mcpServerName,omitempty"` + MCPServerName *string `json:"mcpServerName,omitempty"` // Original tool name on the MCP server, when the tool is an MCP tool - McpToolName *string `json:"mcpToolName,omitempty"` + MCPToolName *string `json:"mcpToolName,omitempty"` + // Model identifier that generated this tool call + Model *string `json:"model,omitempty"` // Tool call ID of the parent tool invocation when this event originates from a sub-agent // Deprecated: ParentToolCallID is deprecated. ParentToolCallID *string `json:"parentToolCallId,omitempty"` + Rte *bool `json:"rte,omitempty"` + // Shell-tool path hints derived from the command at start time for shell tools (bash/powershell/local_shell). Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. Absent for non-shell tools. + ShellToolInfo *ToolExecutionStartShellToolInfo `json:"shellToolInfo,omitempty"` // Unique identifier for this tool call ToolCallID string `json:"toolCallId"` + // Tool definition metadata, present for MCP tools with MCP Apps support + ToolDescription *ToolExecutionStartToolDescription `json:"toolDescription,omitempty"` // Name of the tool being executed ToolName string `json:"toolName"` // Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event @@ -1462,6 +2066,22 @@ type ToolExecutionStartData struct { func (*ToolExecutionStartData) sessionEventData() {} func (*ToolExecutionStartData) Type() SessionEventType { return SessionEventTypeToolExecutionStart } +// Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. +// Experimental: SessionCanvasUnavailableData is part of an experimental API and may change or be removed. +type SessionCanvasUnavailableData struct { + // Provider-local canvas identifier + CanvasID string `json:"canvasId"` + // Owning provider identifier + ExtensionID string `json:"extensionId"` + // Stable caller-supplied identifier of the canvas instance whose provider became unavailable + InstanceID string `json:"instanceId"` +} + +func (*SessionCanvasUnavailableData) sessionEventData() {} +func (*SessionCanvasUnavailableData) Type() SessionEventType { + return SessionEventTypeSessionCanvasUnavailable +} + // Turn abort information including the reason for termination type AbortData struct { // Finite reason code describing why the current turn was aborted @@ -1473,6 +2093,8 @@ func (*AbortData) Type() SessionEventType { return SessionEventTypeAbort } // Turn completion metadata including the turn identifier type AssistantTurnEndData struct { + // Model identifier used for this turn, when known + Model *string `json:"model,omitempty"` // Identifier of the turn that has ended, matching the corresponding assistant.turn_start event TurnID string `json:"turnId"` } @@ -1484,6 +2106,8 @@ func (*AssistantTurnEndData) Type() SessionEventType { return SessionEventTypeAs type AssistantTurnStartData struct { // CAPI interaction ID for correlating this turn with upstream telemetry InteractionID *string `json:"interactionId,omitempty"` + // Model identifier used for this turn, when known + Model *string `json:"model,omitempty"` // Identifier for this turn within the agentic loop, typically a stringified turn number TurnID string `json:"turnId"` } @@ -1509,7 +2133,7 @@ type UserInputRequestedData struct { // Whether the user can provide a free-form text response in addition to predefined choices AllowFreeform *bool `json:"allowFreeform,omitempty"` // Predefined choices for the user to select from, if applicable - Choices []string `json:"choices,omitempty"` + Choices []string `json:"choices,omitzero"` // The question or prompt to present to the user Question string `json:"question"` // Unique identifier for this input request; used to respond via session.respondToUserInput() @@ -1561,6 +2185,8 @@ type SessionContextChangedData struct { HeadCommit *string `json:"headCommit,omitempty"` // Hosting platform type of the repository (github or ado) HostType *WorkingDirectoryContextHostType `json:"hostType,omitempty"` + // Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + PendingGitContext *bool `json:"pendingGitContext,omitempty"` // Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) Repository *string `json:"repository,omitempty"` // Raw host string from the git remote URL (e.g. "github.com", "mycompany.ghe.com", "dev.azure.com") @@ -1585,6 +2211,16 @@ func (*SessionWorkspaceFileChangedData) Type() SessionEventType { return SessionEventTypeSessionWorkspaceFileChanged } +// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping +// Experimental: AssistantMessageServerTools is part of an experimental API and may change or be removed. +type AssistantMessageServerTools struct { + AdvisorModel *string `json:"advisorModel,omitempty"` + FunctionCallNamespaces map[string]string `json:"functionCallNamespaces,omitzero"` + Items []any `json:"items,omitzero"` + Provider string `json:"provider"` + RawContentBlocks []any `json:"rawContentBlocks,omitzero"` +} + // A tool invocation request from the assistant type AssistantMessageToolRequest struct { // Arguments to pass to the tool, format depends on the tool @@ -1592,9 +2228,9 @@ type AssistantMessageToolRequest struct { // Resolved intention summary describing what this specific call does IntentionSummary *string `json:"intentionSummary,omitempty"` // Name of the MCP server hosting this tool, when the tool is an MCP tool - McpServerName *string `json:"mcpServerName,omitempty"` + MCPServerName *string `json:"mcpServerName,omitempty"` // Original tool name on the MCP server, when the tool is an MCP tool - McpToolName *string `json:"mcpToolName,omitempty"` + MCPToolName *string `json:"mcpToolName,omitempty"` // Name of the tool being invoked Name string `json:"name"` // Unique identifier for this tool call @@ -1606,10 +2242,10 @@ type AssistantMessageToolRequest struct { } // Per-request cost and usage data from the CAPI copilot_usage response field -// Internal: AssistantUsageCopilotUsage is an internal SDK API and is not part of the public surface. type AssistantUsageCopilotUsage struct { // Itemized token usage breakdown - TokenDetails []AssistantUsageCopilotUsageTokenDetail `json:"tokenDetails"` + // Internal: TokenDetails is part of the SDK's internal API surface and is not intended for external use. + TokenDetails []AssistantUsageCopilotUsageTokenDetail `json:"tokenDetails,omitzero"` // Total cost in nano-AI units for this request TotalNanoAiu float64 `json:"totalNanoAiu"` } @@ -1626,12 +2262,15 @@ type AssistantUsageCopilotUsageTokenDetail struct { TokenType string `json:"tokenType"` } -// Schema for the `AssistantUsageQuotaSnapshot` type. +// Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota. // Internal: AssistantUsageQuotaSnapshot is an internal SDK API and is not part of the public surface. type AssistantUsageQuotaSnapshot struct { // Total requests allowed by the entitlement // Internal: EntitlementRequests is part of the SDK's internal API surface and is not intended for external use. EntitlementRequests int64 `json:"entitlementRequests"` + // Whether the user currently has quota available for use + // Internal: HasQuota is part of the SDK's internal API surface and is not intended for external use. + HasQuota *bool `json:"hasQuota,omitempty"` // Whether the user has an unlimited usage entitlement // Internal: IsUnlimitedEntitlement is part of the SDK's internal API surface and is not intended for external use. IsUnlimitedEntitlement bool `json:"isUnlimitedEntitlement"` @@ -1641,12 +2280,18 @@ type AssistantUsageQuotaSnapshot struct { // Whether additional usage is allowed when quota is exhausted // Internal: OverageAllowedWithExhaustedQuota is part of the SDK's internal API surface and is not intended for external use. OverageAllowedWithExhaustedQuota bool `json:"overageAllowedWithExhaustedQuota"` + // Pay-as-you-go additional-usage budget cap in AI credits (1 credit = $0.01); present only when CAPI emits a finite value + // Internal: OverageEntitlement is part of the SDK's internal API surface and is not intended for external use. + OverageEntitlement *float64 `json:"overageEntitlement,omitempty"` // Percentage of quota remaining (0 to 100) // Internal: RemainingPercentage is part of the SDK's internal API surface and is not intended for external use. RemainingPercentage float64 `json:"remainingPercentage"` // Date when the quota resets // Internal: ResetDate is part of the SDK's internal API surface and is not intended for external use. ResetDate *time.Time `json:"resetDate,omitempty"` + // Whether this snapshot uses token-based billing (AI-credits allocation) + // Internal: TokenBasedBilling is part of the SDK's internal API surface and is not intended for external use. + TokenBasedBilling *bool `json:"tokenBasedBilling,omitempty"` // Whether usage is still permitted after quota exhaustion // Internal: UsageAllowedWithExhaustedQuota is part of the SDK's internal API surface and is not intended for external use. UsageAllowedWithExhaustedQuota bool `json:"usageAllowedWithExhaustedQuota"` @@ -1655,10 +2300,11 @@ type AssistantUsageQuotaSnapshot struct { UsedRequests int64 `json:"usedRequests"` } -// Schema for the `CanvasRegistryChangedCanvas` type. +// A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions. +// Experimental: CanvasRegistryChangedCanvas is part of an experimental API and may change or be removed. type CanvasRegistryChangedCanvas struct { // Actions the agent or host may invoke - Actions []CanvasRegistryChangedCanvasAction `json:"actions,omitempty"` + Actions []CanvasRegistryChangedCanvasAction `json:"actions,omitzero"` // Provider-local canvas identifier CanvasID string `json:"canvasId"` // Short, single-sentence description shown to the agent in canvas catalogs. @@ -1669,16 +2315,19 @@ type CanvasRegistryChangedCanvas struct { ExtensionID string `json:"extensionId"` // Owning extension display name, when available ExtensionName *string `json:"extensionName,omitempty"` + // Host-local PNG path for the canvas icon, when supplied + Icon *string `json:"icon,omitempty"` // JSON Schema for canvas open input - InputSchema map[string]any `json:"inputSchema,omitempty"` + InputSchema any `json:"inputSchema,omitempty"` } -// Schema for the `CanvasRegistryChangedCanvasAction` type. +// A single action within a canvas declaration, with its name, optional description, and optional input schema. +// Experimental: CanvasRegistryChangedCanvasAction is part of an experimental API and may change or be removed. type CanvasRegistryChangedCanvasAction struct { // Action description Description *string `json:"description,omitempty"` // JSON Schema for action input - InputSchema map[string]any `json:"inputSchema,omitempty"` + InputSchema any `json:"inputSchema,omitempty"` // Action name Name string `json:"name"` } @@ -1690,10 +2339,129 @@ type CapabilitiesChangedUI struct { // Whether elicitation is now supported Elicitation *bool `json:"elicitation,omitempty"` // Whether MCP Apps (SEP-1865) UI passthrough is now supported - McpApps *bool `json:"mcpApps,omitempty"` + MCPApps *bool `json:"mcpApps,omitempty"` +} + +// A source supplied by a tool that should be made available to the model as citable content. +// Experimental: CitableSource is part of an experimental API and may change or be removed. +type CitableSource struct { + // The source text made available to the model as citable content. + Content string `json:"content"` + // Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source. + ID string `json:"id"` + // File path relative to the agent's workspace root, when the source is a file. + Path *string `json:"path,omitempty"` + // Human-readable title of the source. + Title *string `json:"title,omitempty"` + // URL of the source, when it is a web resource. + URL *string `json:"url,omitempty"` +} + +// Location within a cited source (character, page, or content-block range) that supports a span. +// Experimental: CitationLocation is part of an experimental API and may change or be removed. +type CitationLocation interface { + citationLocation() + Type() CitationLocationType +} + +type RawCitationLocation struct { + Discriminator CitationLocationType + Raw json.RawMessage +} + +func (RawCitationLocation) citationLocation() {} +func (r RawCitationLocation) Type() CitationLocationType { + return r.Discriminator +} + +// A content-block range within a structured source document. +type CitationLocationBlock struct { + // Index of the last content block of the cited range (zero-based, exclusive). + EndBlock int64 `json:"endBlock"` + // Index of the first content block of the cited range (zero-based, inclusive). + StartBlock int64 `json:"startBlock"` +} + +func (CitationLocationBlock) citationLocation() {} +func (CitationLocationBlock) Type() CitationLocationType { + return CitationLocationTypeBlock +} + +// A character range within the source's text content. +type CitationLocationChar struct { + // End character offset within the source text (zero-based, exclusive). + EndIndex int64 `json:"endIndex"` + // Start character offset within the source text (zero-based, inclusive). + StartIndex int64 `json:"startIndex"` +} + +func (CitationLocationChar) citationLocation() {} +func (CitationLocationChar) Type() CitationLocationType { + return CitationLocationTypeChar +} + +// A page range within a paginated source document. +type CitationLocationPage struct { + // Last page number of the cited range (inclusive). + EndPage int64 `json:"endPage"` + // First page number of the cited range. + StartPage int64 `json:"startPage"` +} + +func (CitationLocationPage) citationLocation() {} +func (CitationLocationPage) Type() CitationLocationType { + return CitationLocationTypePage +} + +// A single citation occurrence linking a span of generated text to a supporting source. +// Experimental: CitationReference is part of an experimental API and may change or be removed. +type CitationReference struct { + // The exact text from the source that supports the cited span, when provided by the model. + CitedText *string `json:"citedText,omitempty"` + // Location within the source that supports the cited span, when the provider reports one. + Location CitationLocation `json:"location,omitempty"` + // Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. + ProviderMetadata any `json:"providerMetadata,omitempty"` + // Identifier of the CitationSource this reference points to (CitationSource.id). + SourceID string `json:"sourceId"` +} + +// Provider-agnostic citations linking spans of the assistant's response to their supporting sources. +// Experimental: Citations is part of an experimental API and may change or be removed. +type Citations struct { + // Deduplicated set of sources referenced by the citation spans. + Sources []CitationSource `json:"sources"` + // Spans of generated text annotated with the sources that support them. + Spans []CitationSpan `json:"spans"` +} + +// A source that backs one or more cited spans in the assistant's response. +// Experimental: CitationSource is part of an experimental API and may change or be removed. +type CitationSource struct { + // Stable, turn-scoped identifier for this source, referenced by CitationReference.sourceId. + ID string `json:"id"` + // File path relative to the agent's workspace root, when the source is a file. + Path *string `json:"path,omitempty"` + // The system that produced this citation. + Provider CitationProvider `json:"provider"` + // Human-readable title of the source. + Title *string `json:"title,omitempty"` + // URL of the source, when it is a web resource. + URL *string `json:"url,omitempty"` +} + +// A contiguous span of generated assistant text and the source references that support it. +// Experimental: CitationSpan is part of an experimental API and may change or be removed. +type CitationSpan struct { + // End offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, exclusive). + EndIndex int64 `json:"endIndex"` + // The sources that support this span of generated text. + References []CitationReference `json:"references"` + // Start offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, inclusive). + StartIndex int64 `json:"startIndex"` } -// Schema for the `CommandsChangedCommand` type. +// A single slash command available in the session, as listed by the `commands.changed` event. type CommandsChangedCommand struct { // Optional human-readable command description. Description *string `json:"description,omitempty"` @@ -1724,7 +2492,8 @@ type CompactionCompleteCompactionTokensUsed struct { // Internal: CompactionCompleteCompactionTokensUsedCopilotUsage is an internal SDK API and is not part of the public surface. type CompactionCompleteCompactionTokensUsedCopilotUsage struct { // Itemized token usage breakdown - TokenDetails []CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail `json:"tokenDetails"` + // Internal: TokenDetails is part of the SDK's internal API surface and is not intended for external use. + TokenDetails []CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail `json:"tokenDetails,omitzero"` // Total cost in nano-AI units for this request TotalNanoAiu float64 `json:"totalNanoAiu"` } @@ -1741,7 +2510,7 @@ type CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail struct { TokenType string `json:"tokenType"` } -// Schema for the `CustomAgentsUpdatedAgent` type. +// A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override. type CustomAgentsUpdatedAgent struct { // Description of what the agent does Description string `json:"description"` @@ -1761,49 +2530,19 @@ type CustomAgentsUpdatedAgent struct { UserInvocable bool `json:"userInvocable"` } -// Source-defined JSON payload for the custom notification -type CustomNotificationPayload struct { - AnyArray []any - AnyMap map[string]any - Bool *bool - Double *float64 - String *string -} - -// Schema for the `ElicitationCompletedContent` type. -type ElicitationCompletedContent interface { - elicitationCompletedContent() -} - -type ElicitationCompletedBooleanContent bool - -func (ElicitationCompletedBooleanContent) elicitationCompletedContent() {} - -type ElicitationCompletedNumberContent float64 - -func (ElicitationCompletedNumberContent) elicitationCompletedContent() {} - -type ElicitationCompletedStringArrayContent []string - -func (ElicitationCompletedStringArrayContent) elicitationCompletedContent() {} - -type ElicitationCompletedStringContent string - -func (ElicitationCompletedStringContent) elicitationCompletedContent() {} - // JSON Schema describing the form fields to present to the user (form mode only) type ElicitationRequestedSchema struct { // Form field definitions, keyed by field name Properties map[string]any `json:"properties"` // List of required field names - Required []string `json:"required,omitempty"` + Required []string `json:"required,omitzero"` // Schema type indicator (always 'object') Type ElicitationRequestedSchemaType `json:"type"` } -// Schema for the `ExtensionsLoadedExtension` type. +// A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status. type ExtensionsLoadedExtension struct { - // Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper') + // Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') ID string `json:"id"` // Extension name (directory name) Name string `json:"name"` @@ -1813,6 +2552,26 @@ type ExtensionsLoadedExtension struct { Status ExtensionsLoadedExtensionStatus `json:"status"` } +// A declared phase shown in a factory permission prompt. +type FactoryPermissionPhase struct { + // Optional phase detail + Detail *string `json:"detail,omitempty"` + // Phase title + Title string `json:"title"` +} + +// Per-session configuration for the built-in GitHub MCP server +type GitHubMCPToolConfig struct { + // Additional GitHub MCP tools requested by the session + AdditionalTools []string `json:"additionalTools,omitzero"` + // Additional GitHub MCP toolsets requested by the session + AdditionalToolsets []string `json:"additionalToolsets,omitzero"` + // Whether to use the read-write endpoint and request all toolsets + EnableAllTools *bool `json:"enableAllTools,omitempty"` + // Whether to request the GitHub MCP insiders build + EnableInsidersMode *bool `json:"enableInsidersMode,omitempty"` +} + // Repository context for the handed-off session type HandoffRepository struct { // Git branch name, if applicable @@ -1823,46 +2582,78 @@ type HandoffRepository struct { Owner string `json:"owner"` } +// Single HTTP header entry as a name/value pair. +type HeaderEntry struct { + // HTTP response header name as observed by the runtime. + Name string `json:"name"` + // HTTP response header value as observed by the runtime. + Value string `json:"value"` +} + // Error details when the hook failed type HookEndError struct { // Human-readable error message Message string `json:"message"` + // Source label of the hook that errored (e.g. the plugin it was loaded from), when known + Source *string `json:"source,omitempty"` // Error stack trace, when available Stack *string `json:"stack,omitempty"` } // Set when the underlying tools/call threw an error before returning a CallToolResult -type McpAppToolCallCompleteError struct { +type MCPAppToolCallCompleteError struct { // Human-readable error message Message string `json:"message"` } // The tool's `_meta.ui` block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools. -type McpAppToolCallCompleteToolMeta struct { - // Schema for the `McpAppToolCallCompleteToolMetaUI` type. - UI *McpAppToolCallCompleteToolMetaUI `json:"ui,omitempty"` +type MCPAppToolCallCompleteToolMeta struct { + // MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. + UI *MCPAppToolCallCompleteToolMetaUI `json:"ui,omitempty"` } -// Schema for the `McpAppToolCallCompleteToolMetaUI` type. -type McpAppToolCallCompleteToolMetaUI struct { +// MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. +type MCPAppToolCallCompleteToolMetaUI struct { // `ui://` URI declared by the tool's `_meta.ui.resourceUri` ResourceURI *string `json:"resourceUri,omitempty"` // Tool visibility per SEP-1865 (typically a subset of `["model","app"]`) - Visibility []string `json:"visibility,omitempty"` + Visibility []string `json:"visibility,omitzero"` +} + +// Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. +type MCPOauthHTTPResponse struct { + // Complete UTF-8 response body for host-specific challenge handling, including an empty string for an empty body. Omitted when the complete body is not valid UTF-8; body read failures fail the HTTP operation rather than exposing a partial response. + Body *string `json:"body,omitempty"` + // HTTP response headers as observed by the runtime. Order and casing are transport-dependent, and duplicate header names may appear multiple times. + Headers []HeaderEntry `json:"headers"` + // HTTP status code returned with the auth challenge. + StatusCode int32 `json:"statusCode"` } // Static OAuth client configuration, if the server specifies one -type McpOauthRequiredStaticClientConfig struct { +type MCPOauthRequiredStaticClientConfig struct { // OAuth client ID for the server ClientID string `json:"clientId"` + // Optional OAuth client secret for confidential static clients, when the runtime can resolve one + ClientSecret *string `json:"clientSecret,omitempty"` // 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). - GrantType *McpOauthRequiredStaticClientConfigGrantType `json:"grantType,omitempty"` + GrantType *MCPOauthRequiredStaticClientConfigGrantType `json:"grantType,omitempty"` // Whether this is a public OAuth client PublicClient *bool `json:"publicClient,omitempty"` } -// Schema for the `McpServersLoadedServer` type. -type McpServersLoadedServer struct { +// OAuth WWW-Authenticate parameters parsed from an MCP auth challenge +type MCPOauthWwwAuthenticateParams struct { + // OAuth error from the WWW-Authenticate error parameter, if present + Error *string `json:"error,omitempty"` + // Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present + ResourceMetadataURL *string `json:"resourceMetadataUrl,omitempty"` + // Requested OAuth scopes from the WWW-Authenticate scope parameter, if present + Scope *string `json:"scope,omitempty"` +} + +// A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata. +type MCPServersLoadedServer struct { // Error message if the server failed to connect Error *string `json:"error,omitempty"` // Server name (config key) @@ -1872,11 +2663,42 @@ type McpServersLoadedServer struct { // Version of the plugin that supplied the effective MCP server config, only when source is plugin PluginVersion *string `json:"pluginVersion,omitempty"` // Configuration source: user, workspace, plugin, or builtin - Source *McpServerSource `json:"source,omitempty"` - // Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - Status McpServerStatus `json:"status"` + Source *MCPServerSource `json:"source,omitempty"` + // Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured + Status MCPServerStatus `json:"status"` // Transport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server) - Transport *McpServerTransport `json:"transport,omitempty"` + Transport *MCPServerTransport `json:"transport,omitempty"` +} + +// Content-free structural summary of the failing request for diagnosing malformed 4xx calls +type ModelCallFailureRequestFingerprint struct { + // Total number of image content parts + ImagePartCount int64 `json:"imagePartCount"` + // Image parts whose media type cannot be determined (rejected by strict providers) + ImagePartsMissingMediaType int64 `json:"imagePartsMissingMediaType"` + // Role of the final message in the request + LastMessageRole *string `json:"lastMessageRole,omitempty"` + // Total number of messages in the request + MessageCount int64 `json:"messageCount"` + // Tool calls whose name is missing or empty (rejected by strict providers) + NamelessToolCallCount int64 `json:"namelessToolCallCount"` + // Total number of tool calls across assistant messages + ToolCallCount int64 `json:"toolCallCount"` + // Number of "tool" result messages in the request + ToolResultMessageCount int64 `json:"toolResultMessageCount"` +} + +// Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is "auto"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. +// Experimental: PermissionAutoApproval is part of an experimental API and may change or be removed. +type PermissionAutoApproval struct { + // Classified cause of an `error` recommendation. Absent for every other recommendation. + FailureReason *AutoApprovalJudgeFailureReason `json:"failureReason,omitempty"` + // Model id that produced the recommendation, when the judge was consulted and reported one. Absent for `excluded` (the judge was not consulted) and for failures that occurred before a model was selected. + Model *string `json:"model,omitempty"` + // Human-readable reason for the judge's recommendation, when available. + Reason *string `json:"reason,omitempty"` + // The auto-approval safety judge's outcome for this request. + Recommendation AutoApprovalRecommendation `json:"recommendation"` } // Derived user-facing permission prompt details for UI consumers @@ -1897,6 +2719,9 @@ func (r RawPermissionPromptRequest) Kind() PermissionPromptRequestKind { // Shell command permission prompt type PermissionPromptRequestCommands struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Whether the UI can offer session-wide approval for this command pattern CanOfferSessionApproval bool `json:"canOfferSessionApproval"` // Command identifiers covered by this approval prompt @@ -1905,6 +2730,8 @@ type PermissionPromptRequestCommands struct { FullCommandText string `json:"fullCommandText"` // Human-readable description of what the command intends to do Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Optional warning message about risks of running this command @@ -1920,6 +2747,9 @@ func (PermissionPromptRequestCommands) Kind() PermissionPromptRequestKind { type PermissionPromptRequestCustomTool struct { // Arguments to pass to the custom tool Args any `json:"args,omitempty"` + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Description of what the custom tool does @@ -1935,6 +2765,9 @@ func (PermissionPromptRequestCustomTool) Kind() PermissionPromptRequestKind { // Extension management permission prompt type PermissionPromptRequestExtensionManagement struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Name of the extension being managed ExtensionName *string `json:"extensionName,omitempty"` // The extension management operation (scaffold, reload) @@ -1950,6 +2783,9 @@ func (PermissionPromptRequestExtensionManagement) Kind() PermissionPromptRequest // Extension permission access prompt type PermissionPromptRequestExtensionPermissionAccess struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Capabilities the extension is requesting Capabilities []string `json:"capabilities"` // Name of the extension requesting permission access @@ -1963,8 +2799,51 @@ func (PermissionPromptRequestExtensionPermissionAccess) Kind() PermissionPromptR return PermissionPromptRequestKindExtensionPermissionAccess } +// Factory run or authoring permission prompt +type PermissionPromptRequestFactory struct { + // Canonical key used for scoped factory approvals + ApprovalKey string `json:"approvalKey"` + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` + // Whether this factory is eligible for persistent approval + CanPersistApproval bool `json:"canPersistApproval"` + DeclaredMaxAiCredits *float64 `json:"declaredMaxAiCredits,omitempty"` + DeclaredMaxConcurrentSubagents *int64 `json:"declaredMaxConcurrentSubagents,omitempty"` + DeclaredMaxTotalSubagents *int64 `json:"declaredMaxTotalSubagents,omitempty"` + DeclaredTimeoutSeconds *float64 `json:"declaredTimeoutSeconds,omitempty"` + // Factory description + Description string `json:"description"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` + // Effective AI-credit limit; omitted means unlimited + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` + // Effective concurrent-subagent limit; omitted means unlimited + MaxConcurrentSubagents *int64 `json:"maxConcurrentSubagents,omitempty"` + // Effective total-subagent limit; omitted means unlimited + MaxTotalSubagents *int64 `json:"maxTotalSubagents,omitempty"` + // Factory name + Name string `json:"name"` + // Factory operation, either run or author + Operation FactoryPermissionOperation `json:"operation"` + // Declared factory phases + Phases []FactoryPermissionPhase `json:"phases"` + // Effective active-time limit in seconds; omitted means unlimited + TimeoutSeconds *float64 `json:"timeoutSeconds,omitempty"` + // Tool call ID that triggered this permission request + ToolCallID *string `json:"toolCallId,omitempty"` +} + +func (PermissionPromptRequestFactory) permissionPromptRequest() {} +func (PermissionPromptRequestFactory) Kind() PermissionPromptRequestKind { + return PermissionPromptRequestKindFactory +} + // Hook confirmation permission prompt type PermissionPromptRequestHook struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Optional message from the hook explaining why confirmation is needed HookMessage *string `json:"hookMessage,omitempty"` // Arguments of the tool call being gated @@ -1981,9 +2860,12 @@ func (PermissionPromptRequestHook) Kind() PermissionPromptRequestKind { } // MCP tool invocation permission prompt -type PermissionPromptRequestMcp struct { +type PermissionPromptRequestMCP struct { // Arguments to pass to the MCP tool - Args *any `json:"args,omitempty"` + Args any `json:"args,omitempty"` + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Name of the MCP server providing the tool ServerName string `json:"serverName"` // Tool call ID that triggered this permission request @@ -1994,15 +2876,18 @@ type PermissionPromptRequestMcp struct { ToolTitle string `json:"toolTitle"` } -func (PermissionPromptRequestMcp) permissionPromptRequest() {} -func (PermissionPromptRequestMcp) Kind() PermissionPromptRequestKind { - return PermissionPromptRequestKindMcp +func (PermissionPromptRequestMCP) permissionPromptRequest() {} +func (PermissionPromptRequestMCP) Kind() PermissionPromptRequestKind { + return PermissionPromptRequestKindMCP } // Memory operation permission prompt type PermissionPromptRequestMemory struct { // Whether this is a store or vote memory operation Action *PermissionRequestMemoryAction `json:"action,omitempty"` + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Source references for the stored fact (store only) Citations *string `json:"citations,omitempty"` // Vote direction (vote only) @@ -2026,6 +2911,9 @@ func (PermissionPromptRequestMemory) Kind() PermissionPromptRequestKind { type PermissionPromptRequestPath struct { // Underlying permission kind that needs path approval AccessKind PermissionPromptRequestPathAccessKind `json:"accessKind"` + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // File paths that require explicit approval Paths []string `json:"paths"` // Tool call ID that triggered this permission request @@ -2039,8 +2927,13 @@ func (PermissionPromptRequestPath) Kind() PermissionPromptRequestKind { // File read permission prompt type PermissionPromptRequestRead struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Human-readable description of why the file is being read Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Path of the file or directory being read Path string `json:"path"` // Tool call ID that triggered this permission request @@ -2054,8 +2947,19 @@ func (PermissionPromptRequestRead) Kind() PermissionPromptRequestKind { // URL access permission prompt type PermissionPromptRequestURL struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Human-readable description of why the URL is being accessed Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` + // Immediately preceding URL when this prompt is for a redirect target + RedirectedFrom *string `json:"redirectedFrom,omitempty"` + // True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + RequestSandboxBypass *bool `json:"requestSandboxBypass,omitempty"` + // Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + RequestSandboxBypassReason *string `json:"requestSandboxBypassReason,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // URL to be fetched @@ -2069,6 +2973,9 @@ func (PermissionPromptRequestURL) Kind() PermissionPromptRequestKind { // File write permission prompt type PermissionPromptRequestWrite struct { + // Auto-approval judge information for this request; present only when auto mode is enabled. + // Experimental: AutoApproval is part of an experimental API and may change or be removed. + AutoApproval *PermissionAutoApproval `json:"autoApproval,omitempty"` // Whether the UI can offer session-wide approval for file write operations CanOfferSessionApproval bool `json:"canOfferSessionApproval"` // Unified diff showing the proposed changes @@ -2077,6 +2984,8 @@ type PermissionPromptRequestWrite struct { FileName string `json:"fileName"` // Human-readable description of the intended file change Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Complete new file contents for newly created files NewFileContents *string `json:"newFileContents,omitempty"` // Tool call ID that triggered this permission request @@ -2092,6 +3001,7 @@ func (PermissionPromptRequestWrite) Kind() PermissionPromptRequestKind { type PermissionRequest interface { permissionRequest() Kind() PermissionRequestKind + RequiresManagedApproval() bool } type RawPermissionRequest struct { @@ -2108,6 +3018,8 @@ func (r RawPermissionRequest) Kind() PermissionRequestKind { type PermissionRequestCustomTool struct { // Arguments to pass to the custom tool Args any `json:"args,omitempty"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Description of what the custom tool does @@ -2125,6 +3037,8 @@ func (PermissionRequestCustomTool) Kind() PermissionRequestKind { type PermissionRequestExtensionManagement struct { // Name of the extension being managed ExtensionName *string `json:"extensionName,omitempty"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // The extension management operation (scaffold, reload) Operation string `json:"operation"` // Tool call ID that triggered this permission request @@ -2142,6 +3056,8 @@ type PermissionRequestExtensionPermissionAccess struct { Capabilities []string `json:"capabilities"` // Name of the extension requesting permission access ExtensionName string `json:"extensionName"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` } @@ -2151,10 +3067,49 @@ func (PermissionRequestExtensionPermissionAccess) Kind() PermissionRequestKind { return PermissionRequestKindExtensionPermissionAccess } +// Factory run or authoring permission request +type PermissionRequestFactory struct { + // Canonical key used for scoped factory approvals + ApprovalKey string `json:"approvalKey"` + // Whether this factory is eligible for persistent approval + CanPersistApproval bool `json:"canPersistApproval"` + DeclaredMaxAiCredits *float64 `json:"declaredMaxAiCredits,omitempty"` + DeclaredMaxConcurrentSubagents *int64 `json:"declaredMaxConcurrentSubagents,omitempty"` + DeclaredMaxTotalSubagents *int64 `json:"declaredMaxTotalSubagents,omitempty"` + DeclaredTimeoutSeconds *float64 `json:"declaredTimeoutSeconds,omitempty"` + // Factory description + Description string `json:"description"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` + // Effective AI-credit limit; omitted means unlimited + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` + // Effective concurrent-subagent limit; omitted means unlimited + MaxConcurrentSubagents *int64 `json:"maxConcurrentSubagents,omitempty"` + // Effective total-subagent limit; omitted means unlimited + MaxTotalSubagents *int64 `json:"maxTotalSubagents,omitempty"` + // Factory name + Name string `json:"name"` + // Factory operation, either run or author + Operation FactoryPermissionOperation `json:"operation"` + // Declared factory phases + Phases []FactoryPermissionPhase `json:"phases"` + // Effective active-time limit in seconds; omitted means unlimited + TimeoutSeconds *float64 `json:"timeoutSeconds,omitempty"` + // Tool call ID that triggered this permission request + ToolCallID *string `json:"toolCallId,omitempty"` +} + +func (PermissionRequestFactory) permissionRequest() {} +func (PermissionRequestFactory) Kind() PermissionRequestKind { + return PermissionRequestKindFactory +} + // Hook confirmation permission request type PermissionRequestHook struct { // Optional message from the hook explaining why confirmation is needed HookMessage *string `json:"hookMessage,omitempty"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Arguments of the tool call being gated ToolArgs any `json:"toolArgs,omitempty"` // Tool call ID that triggered this permission request @@ -2169,9 +3124,11 @@ func (PermissionRequestHook) Kind() PermissionRequestKind { } // MCP tool invocation permission request -type PermissionRequestMcp struct { +type PermissionRequestMCP struct { // Arguments to pass to the MCP tool Args any `json:"args,omitempty"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Whether this MCP tool is read-only (no side effects) ReadOnly bool `json:"readOnly"` // Name of the MCP server providing the tool @@ -2184,9 +3141,9 @@ type PermissionRequestMcp struct { ToolTitle string `json:"toolTitle"` } -func (PermissionRequestMcp) permissionRequest() {} -func (PermissionRequestMcp) Kind() PermissionRequestKind { - return PermissionRequestKindMcp +func (PermissionRequestMCP) permissionRequest() {} +func (PermissionRequestMCP) Kind() PermissionRequestKind { + return PermissionRequestKindMCP } // Memory operation permission request @@ -2199,6 +3156,8 @@ type PermissionRequestMemory struct { Direction *PermissionRequestMemoryDirection `json:"direction,omitempty"` // The fact being stored or voted on Fact string `json:"fact"` + // When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Reason for the vote (vote only) Reason *string `json:"reason,omitempty"` // Topic or subject of the memory (store only) @@ -2216,8 +3175,14 @@ func (PermissionRequestMemory) Kind() PermissionRequestKind { type PermissionRequestRead struct { // Human-readable description of why the file is being read Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Path of the file or directory being read Path string `json:"path"` + // True when the model has requested to run this search outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + RequestSandboxBypass *bool `json:"requestSandboxBypass,omitempty"` + // Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + RequestSandboxBypassReason *string `json:"requestSandboxBypassReason,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` } @@ -2233,16 +3198,24 @@ type PermissionRequestShell struct { CanOfferSessionApproval bool `json:"canOfferSessionApproval"` // Parsed command identifiers found in the command text Commands []PermissionRequestShellCommand `json:"commands"` + // Parsed command segments, including arguments, used for managed policy matching + CommandSegments []PermissionRequestShellCommandSegment `json:"commandSegments,omitzero"` // The complete shell command text to be executed FullCommandText string `json:"fullCommandText"` // Whether the command includes a file write redirection (e.g., > or >>) HasWriteFileRedirection bool `json:"hasWriteFileRedirection"` // Human-readable description of what the command intends to do Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // File paths that may be read or written by the command PossiblePaths []string `json:"possiblePaths"` // URLs that may be accessed by the command - PossibleUrls []PermissionRequestShellPossibleURL `json:"possibleUrls"` + PossibleURLs []PermissionRequestShellPossibleURL `json:"possibleUrls"` + // True when the model has requested to run this command outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + RequestSandboxBypass *bool `json:"requestSandboxBypass,omitempty"` + // Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + RequestSandboxBypassReason *string `json:"requestSandboxBypassReason,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // Optional warning message about risks of running this command @@ -2258,6 +3231,14 @@ func (PermissionRequestShell) Kind() PermissionRequestKind { type PermissionRequestURL struct { // Human-readable description of why the URL is being accessed Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` + // Immediately preceding URL when this request is for a redirect target + RedirectedFrom *string `json:"redirectedFrom,omitempty"` + // True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + RequestSandboxBypass *bool `json:"requestSandboxBypass,omitempty"` + // Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + RequestSandboxBypassReason *string `json:"requestSandboxBypassReason,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` // URL to be fetched @@ -2279,8 +3260,14 @@ type PermissionRequestWrite struct { FileName string `json:"fileName"` // Human-readable description of the intended file change Intention string `json:"intention"` + // Whether managed policy requires a human response and forbids host auto-approval + ManagedApprovalRequired *bool `json:"managedApprovalRequired,omitempty"` // Complete new file contents for newly created files NewFileContents *string `json:"newFileContents,omitempty"` + // True when a built-in file tool (apply_patch / str_replace_editor) asked to write a path the sandbox filesystem policy would block, and the host opted in via sandbox.allowBypass. This is a request, not a grant: the write happens unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + RequestSandboxBypass *bool `json:"requestSandboxBypass,omitempty"` + // Justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + RequestSandboxBypassReason *string `json:"requestSandboxBypassReason,omitempty"` // Tool call ID that triggered this permission request ToolCallID *string `json:"toolCallId,omitempty"` } @@ -2290,7 +3277,7 @@ func (PermissionRequestWrite) Kind() PermissionRequestKind { return PermissionRequestKindWrite } -// Schema for the `PermissionRequestShellCommand` type. +// A parsed command identifier in a shell permission request, including whether it is read-only. type PermissionRequestShellCommand struct { // Command identifier (e.g., executable name) Identifier string `json:"identifier"` @@ -2298,7 +3285,15 @@ type PermissionRequestShellCommand struct { ReadOnly bool `json:"readOnly"` } -// Schema for the `PermissionRequestShellPossibleUrl` type. +// A parsed shell command segment used for argument-aware managed policy matching. +type PermissionRequestShellCommandSegment struct { + // Full text of this command segment, including arguments + FullCommandText string `json:"fullCommandText"` + // Command identifier (e.g., executable name) + Identifier string `json:"identifier"` +} + +// A URL that may be accessed by a command in a shell permission request. type PermissionRequestShellPossibleURL struct { // URL that may be accessed by the command URL string `json:"url"` @@ -2320,7 +3315,7 @@ func (r RawPermissionResult) Kind() PermissionResultKind { return r.Discriminator } -// Schema for the `PermissionApproved` type. +// Permission response variant indicating the request was approved without persisting an approval rule. type PermissionApproved struct { } @@ -2329,7 +3324,7 @@ func (PermissionApproved) Kind() PermissionResultKind { return PermissionResultKindApproved } -// Schema for the `PermissionApprovedForLocation` type. +// Permission response variant that approves a request and persists the provided approval to a project location key. type PermissionApprovedForLocation struct { // The approval to persist for this location Approval UserToolSessionApproval `json:"approval"` @@ -2342,7 +3337,7 @@ func (PermissionApprovedForLocation) Kind() PermissionResultKind { return PermissionResultKindApprovedForLocation } -// Schema for the `PermissionApprovedForSession` type. +// Permission response variant that approves a request and remembers the provided approval for the rest of the session. type PermissionApprovedForSession struct { // The approval to add as a session-scoped rule Approval UserToolSessionApproval `json:"approval"` @@ -2353,7 +3348,7 @@ func (PermissionApprovedForSession) Kind() PermissionResultKind { return PermissionResultKindApprovedForSession } -// Schema for the `PermissionCancelled` type. +// Permission response variant indicating the request was cancelled before use, with an optional reason. type PermissionCancelled struct { // Optional explanation of why the request was cancelled Reason *string `json:"reason,omitempty"` @@ -2364,7 +3359,7 @@ func (PermissionCancelled) Kind() PermissionResultKind { return PermissionResultKindCancelled } -// Schema for the `PermissionDeniedByContentExclusionPolicy` type. +// Permission response variant denying a path under content exclusion policy, with the path and message. type PermissionDeniedByContentExclusionPolicy struct { // Human-readable explanation of why the path was excluded Message string `json:"message"` @@ -2377,7 +3372,7 @@ func (PermissionDeniedByContentExclusionPolicy) Kind() PermissionResultKind { return PermissionResultKindDeniedByContentExclusionPolicy } -// Schema for the `PermissionDeniedByPermissionRequestHook` type. +// Permission response variant denied by a permission-request hook, with optional message and interrupt flag. type PermissionDeniedByPermissionRequestHook struct { // Whether to interrupt the current agent turn Interrupt *bool `json:"interrupt,omitempty"` @@ -2390,7 +3385,7 @@ func (PermissionDeniedByPermissionRequestHook) Kind() PermissionResultKind { return PermissionResultKindDeniedByPermissionRequestHook } -// Schema for the `PermissionDeniedByRules` type. +// Permission response variant denied because matching approval rules explicitly blocked the request. type PermissionDeniedByRules struct { // Rules that denied the request Rules []PermissionRule `json:"rules"` @@ -2401,7 +3396,7 @@ func (PermissionDeniedByRules) Kind() PermissionResultKind { return PermissionResultKindDeniedByRules } -// Schema for the `PermissionDeniedInteractivelyByUser` type. +// Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag. type PermissionDeniedInteractivelyByUser struct { // Optional feedback from the user explaining the denial Feedback *string `json:"feedback,omitempty"` @@ -2414,7 +3409,7 @@ func (PermissionDeniedInteractivelyByUser) Kind() PermissionResultKind { return PermissionResultKindDeniedInteractivelyByUser } -// Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. +// Permission response variant denied because no approval rule matched and user confirmation was unavailable. type PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser struct { } @@ -2423,6 +3418,100 @@ func (PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser) Kind() Permissio return PermissionResultKindDeniedNoApprovalRuleAndCouldNotRequestFromUser } +// A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset reference +// Experimental: PersistedBinaryResult is part of an experimental API and may change or be removed. +type PersistedBinaryResult interface { + persistedBinaryResult() + Type() PersistedBinaryResultType +} + +type RawPersistedBinaryResult struct { + Discriminator PersistedBinaryResultType + Raw json.RawMessage +} + +func (RawPersistedBinaryResult) persistedBinaryResult() {} +func (r RawPersistedBinaryResult) Type() PersistedBinaryResultType { + return r.Discriminator +} + +// A reference to binary data persisted once on a session.binary_asset event and shared by id +type BinaryAssetReference struct { + // Content-addressed id of the session.binary_asset event that holds this binary's bytes (e.g. "sha256:..."). + AssetID string `json:"assetId"` + // Decoded byte length of the referenced binary data + ByteLength int64 `json:"byteLength"` + // Human-readable description of the binary data + Description *string `json:"description,omitempty"` + // Optional metadata from the producing tool. + Metadata map[string]any `json:"metadata,omitzero"` + // MIME type of the referenced binary data + MIMEType string `json:"mimeType"` + Discriminator BinaryAssetReferenceType `json:"type,omitempty"` +} + +func (BinaryAssetReference) persistedBinaryResult() {} +func (r BinaryAssetReference) Type() PersistedBinaryResultType { + if r.Discriminator == "" { + return PersistedBinaryResultTypeImage + } + return PersistedBinaryResultType(r.Discriminator) +} + +// A binary result whose data was omitted from persistence due to the inline size limit +type OmittedBinaryResult struct { + // Decoded byte length of the omitted binary data + ByteLength int64 `json:"byteLength"` + // Human-readable description of the binary data + Description *string `json:"description,omitempty"` + // Optional metadata from the producing tool. + Metadata map[string]any `json:"metadata,omitzero"` + // MIME type of the omitted binary data + MIMEType string `json:"mimeType"` + // Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable + OmittedReason OmittedBinaryOmittedReason `json:"omittedReason"` + Discriminator OmittedBinaryType `json:"type,omitempty"` +} + +func (OmittedBinaryResult) persistedBinaryResult() {} +func (r OmittedBinaryResult) Type() PersistedBinaryResultType { + if r.Discriminator == "" { + return PersistedBinaryResultTypeImage + } + return PersistedBinaryResultType(r.Discriminator) +} + +// Binary result returned by a tool for the model +type PersistedBinaryImage struct { + // Base64-encoded binary data + Data string `json:"data"` + // Human-readable description of the binary data + Description *string `json:"description,omitempty"` + // Optional metadata from the producing tool. + Metadata map[string]any `json:"metadata,omitzero"` + // MIME type of the binary data + MIMEType string `json:"mimeType"` + Discriminator PersistedBinaryImageType `json:"type,omitempty"` +} + +func (PersistedBinaryImage) persistedBinaryResult() {} +func (r PersistedBinaryImage) Type() PersistedBinaryResultType { + if r.Discriminator == "" { + return PersistedBinaryResultTypeImage + } + return PersistedBinaryResultType(r.Discriminator) +} + +// The user's selected action for an exhausted session limit. +type SessionLimitsExhaustedResponse struct { + // Action selected by the user. + Action SessionLimitsExhaustedResponseAction `json:"action"` + // AI Credits to add to the current max when action is 'add'. + AdditionalAiCredits *float64 `json:"additionalAiCredits,omitempty"` + // New absolute max AI Credits when action is 'set'. + MaxAiCredits *float64 `json:"maxAiCredits,omitempty"` +} + // Aggregate code change metrics for the session type ShutdownCodeChanges struct { // List of file paths that were modified during the session @@ -2433,12 +3522,12 @@ type ShutdownCodeChanges struct { LinesRemoved int64 `json:"linesRemoved"` } -// Schema for the `ShutdownModelMetric` type. +// Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. type ShutdownModelMetric struct { // Request count and cost metrics Requests ShutdownModelMetricRequests `json:"requests"` // Token count details per type - TokenDetails map[string]ShutdownModelMetricTokenDetail `json:"tokenDetails,omitempty"` + TokenDetails map[string]ShutdownModelMetricTokenDetail `json:"tokenDetails,omitzero"` // Accumulated nano-AI units cost for this model // Experimental: TotalNanoAiu is part of an experimental API and may change or be removed. TotalNanoAiu *float64 `json:"totalNanoAiu,omitempty"` @@ -2456,7 +3545,7 @@ type ShutdownModelMetricRequests struct { Count *int64 `json:"count,omitempty"` } -// Schema for the `ShutdownModelMetricTokenDetail` type. +// A token-type entry in a shutdown model metric, storing the accumulated token count. type ShutdownModelMetricTokenDetail struct { // Accumulated token count for this token type TokenCount int64 `json:"tokenCount"` @@ -2476,14 +3565,18 @@ type ShutdownModelMetricUsage struct { ReasoningTokens *int64 `json:"reasoningTokens,omitempty"` } -// Schema for the `ShutdownTokenDetail` type. +// A session-wide shutdown token-type entry storing the accumulated token count. type ShutdownTokenDetail struct { // Accumulated token count for this token type TokenCount int64 `json:"tokenCount"` } -// Schema for the `SkillsLoadedSkill` type. +// A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint. type SkillsLoadedSkill struct { + // Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + ArgumentHint *string `json:"argumentHint,omitempty"` + // Canonical slash command name used to invoke the skill, without the leading '/' + CommandName *string `json:"commandName,omitempty"` // Description of what the skill does Description string `json:"description"` // Whether the skill is currently enabled @@ -2503,7 +3596,7 @@ type SystemMessageMetadata struct { // Version identifier of the prompt template used PromptVersion *string `json:"promptVersion,omitempty"` // Template variables used when constructing the prompt - Variables map[string]any `json:"variables,omitempty"` + Variables map[string]any `json:"variables,omitzero"` } // Structured metadata identifying what triggered this notification @@ -2522,7 +3615,7 @@ func (r RawSystemNotification) Type() SystemNotificationType { return r.Discriminator } -// Schema for the `SystemNotificationAgentCompleted` type. +// System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt. type SystemNotificationAgentCompleted struct { // Unique identifier of the background agent AgentID string `json:"agentId"` @@ -2541,7 +3634,7 @@ func (SystemNotificationAgentCompleted) Type() SystemNotificationType { return SystemNotificationTypeAgentCompleted } -// Schema for the `SystemNotificationAgentIdle` type. +// System notification metadata for a background agent that became idle, including agent ID, type, and description. type SystemNotificationAgentIdle struct { // Unique identifier of the background agent AgentID string `json:"agentId"` @@ -2556,7 +3649,36 @@ func (SystemNotificationAgentIdle) Type() SystemNotificationType { return SystemNotificationTypeAgentIdle } -// Schema for the `SystemNotificationInstructionDiscovered` type. +// System notification metadata for a factory execution attempt that reached a terminal state. +type SystemNotificationFactoryCompleted struct { + // Execution attempt that reached this terminal state. + Attempt int64 `json:"attempt"` + // Consumed AI usage in nano-AIU. + ConsumedNanoAiu int64 `json:"consumedNanoAiu"` + // Subagents consumed by the run across all attempts. + ConsumedSubagents int64 `json:"consumedSubagents"` + // Accumulated active execution time in milliseconds. + ElapsedMs int64 `json:"elapsedMs"` + // Persisted factory name. + FactoryName string `json:"factoryName"` + // Machine-readable terminal failure details, when present. + Failure any `json:"failure,omitempty"` + // Bounded prompt-safe preview of the completed result. + ResultPreview *string `json:"resultPreview,omitempty"` + // Actionable run_factory resume guidance for a resource-limit failure. + RetryGuidance *string `json:"retryGuidance,omitempty"` + // Factory run identifier. + RunID string `json:"runId"` + // Terminal status reached by this execution attempt. + Status SystemNotificationFactoryCompletedStatus `json:"status"` +} + +func (SystemNotificationFactoryCompleted) systemNotification() {} +func (SystemNotificationFactoryCompleted) Type() SystemNotificationType { + return SystemNotificationTypeFactoryCompleted +} + +// System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool. type SystemNotificationInstructionDiscovered struct { // Human-readable label for the timeline (e.g., 'AGENTS.md from packages/billing/') Description *string `json:"description,omitempty"` @@ -2573,7 +3695,7 @@ func (SystemNotificationInstructionDiscovered) Type() SystemNotificationType { return SystemNotificationTypeInstructionDiscovered } -// Schema for the `SystemNotificationNewInboxMessage` type. +// System notification metadata for a new inbox message, including entry ID, sender details, and summary. type SystemNotificationNewInboxMessage struct { // Unique identifier of the inbox entry EntryID string `json:"entryId"` @@ -2590,7 +3712,7 @@ func (SystemNotificationNewInboxMessage) Type() SystemNotificationType { return SystemNotificationTypeNewInboxMessage } -// Schema for the `SystemNotificationShellCompleted` type. +// System notification metadata for a shell session that completed, including shell ID, optional exit code, and description. type SystemNotificationShellCompleted struct { // Human-readable description of the command Description *string `json:"description,omitempty"` @@ -2605,7 +3727,7 @@ func (SystemNotificationShellCompleted) Type() SystemNotificationType { return SystemNotificationTypeShellCompleted } -// Schema for the `SystemNotificationShellDetachedCompleted` type. +// System notification metadata for a detached shell session that completed, including shell ID and description. type SystemNotificationShellDetachedCompleted struct { // Human-readable description of the command Description *string `json:"description,omitempty"` @@ -2618,6 +3740,17 @@ func (SystemNotificationShellDetachedCompleted) Type() SystemNotificationType { return SystemNotificationTypeShellDetachedCompleted } +// System notification metadata from an external host that does not match a runtime-owned notification kind. +type SystemNotificationUnclassified struct { + // Opaque metadata supplied by the external host, when present. + Metadata any `json:"metadata,omitempty"` +} + +func (SystemNotificationUnclassified) systemNotification() {} +func (SystemNotificationUnclassified) Type() SystemNotificationType { + return SystemNotificationTypeUnclassified +} + // A content block within a tool result, which may be text, terminal output, image, audio, or a resource type ToolExecutionCompleteContent interface { toolExecutionCompleteContent() @@ -2676,7 +3809,7 @@ type ToolExecutionCompleteContentResourceLink struct { // Human-readable description of the resource Description *string `json:"description,omitempty"` // Icons associated with this resource - Icons []ToolExecutionCompleteContentResourceLinkIcon `json:"icons,omitempty"` + Icons []ToolExecutionCompleteContentResourceLinkIcon `json:"icons,omitzero"` // MIME type of the resource content MIMEType *string `json:"mimeType,omitempty"` // Resource name identifier @@ -2694,7 +3827,26 @@ func (ToolExecutionCompleteContentResourceLink) Type() ToolExecutionCompleteCont return ToolExecutionCompleteContentTypeResourceLink } -// Terminal/shell output content block with optional exit code and working directory +// Shell command exit metadata with optional output preview +type ToolExecutionCompleteContentShellExit struct { + // Working directory where the shell command was executed + Cwd *string `json:"cwd,omitempty"` + // Exit code from the completed shell command + ExitCode int64 `json:"exitCode"` + // Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + OutputPreview *string `json:"outputPreview,omitempty"` + // Whether outputPreview is known to be incomplete or truncated + OutputTruncated *bool `json:"outputTruncated,omitempty"` + // Shell id, as assigned by Copilot runtime + ShellID string `json:"shellId"` +} + +func (ToolExecutionCompleteContentShellExit) toolExecutionCompleteContent() {} +func (ToolExecutionCompleteContentShellExit) Type() ToolExecutionCompleteContentType { + return ToolExecutionCompleteContentTypeShellExit +} + +// Deprecated for shell command exit metadata. Use ToolExecutionCompleteContentShellExit instead. type ToolExecutionCompleteContentTerminal struct { // Working directory where the command was executed Cwd *string `json:"cwd,omitempty"` @@ -2731,7 +3883,7 @@ type ToolExecutionCompleteContentResourceLinkIcon struct { // MIME type of the icon image MIMEType *string `json:"mimeType,omitempty"` // Available icon sizes (e.g., ['16x16', '32x32']) - Sizes []string `json:"sizes,omitempty"` + Sizes []string `json:"sizes,omitzero"` // URL or path to the icon image Src string `json:"src"` // Theme variant this icon is intended for @@ -2748,12 +3900,23 @@ type ToolExecutionCompleteError struct { // Tool execution result on success type ToolExecutionCompleteResult struct { + // Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call + // Experimental: BinaryResultsForLlm is part of an experimental API and may change or be removed. + BinaryResultsForLlm []PersistedBinaryResult `json:"binaryResultsForLlm,omitzero"` + // Provider-neutral source material this tool makes available to the model as citable content. Persisted so it survives session resume. Experimental. + // Experimental: CitableSources is part of an experimental API and may change or be removed. + CitableSources []CitableSource `json:"citableSources,omitzero"` // Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency Content string `json:"content"` // Structured content blocks (text, images, audio, resources) returned by the tool in their native format - Contents []ToolExecutionCompleteContent `json:"contents,omitempty"` + Contents []ToolExecutionCompleteContent `json:"contents,omitzero"` // Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent. DetailedContent *string `json:"detailedContent,omitempty"` + // FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels) — persisted as `{ ifc: ... }` (only the `ifc` key, not the whole `_meta`). Persisted so the FIDES IFC label survives session resume: the engine rehydrates accumulated taint by replaying these on load. Populated for ingress sources when FIDES IFC is on. Experimental. + // Experimental: MCPMeta is part of an experimental API and may change or be removed. + MCPMeta any `json:"mcpMeta,omitempty"` + // Structured content (arbitrary JSON) returned verbatim by the MCP tool + StructuredContent any `json:"structuredContent,omitempty"` // MCP Apps UI resource content for rendering in a sandboxed iframe UIResource *ToolExecutionCompleteUIResource `json:"uiResource,omitempty"` } @@ -2770,16 +3933,16 @@ type ToolExecutionCompleteToolDescription struct { // MCP Apps metadata for UI resource association type ToolExecutionCompleteToolDescriptionMeta struct { - // Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. + // MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. UI *ToolExecutionCompleteToolDescriptionMetaUI `json:"ui,omitempty"` } -// Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. +// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. type ToolExecutionCompleteToolDescriptionMetaUI struct { // URI of the UI resource ResourceURI *string `json:"resourceUri,omitempty"` // Who can access this tool - Visibility []ToolExecutionCompleteToolDescriptionMetaUIVisibility `json:"visibility,omitempty"` + Visibility []ToolExecutionCompleteToolDescriptionMetaUIVisibility `json:"visibility,omitzero"` } // MCP Apps UI resource content for rendering in a sandboxed iframe @@ -2798,181 +3961,101 @@ type ToolExecutionCompleteUIResource struct { // Resource-level UI metadata (CSP, permissions, visual preferences) type ToolExecutionCompleteUIResourceMeta struct { - // Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. + // MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. UI *ToolExecutionCompleteUIResourceMetaUI `json:"ui,omitempty"` } -// Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. +// MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. type ToolExecutionCompleteUIResourceMetaUI struct { - // Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. + // CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. Csp *ToolExecutionCompleteUIResourceMetaUICsp `json:"csp,omitempty"` Domain *string `json:"domain,omitempty"` - // Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. + // Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. Permissions *ToolExecutionCompleteUIResourceMetaUIPermissions `json:"permissions,omitempty"` PrefersBorder *bool `json:"prefersBorder,omitempty"` } -// Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. +// CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. type ToolExecutionCompleteUIResourceMetaUICsp struct { - BaseURIDomains []string `json:"baseUriDomains,omitempty"` - ConnectDomains []string `json:"connectDomains,omitempty"` - FrameDomains []string `json:"frameDomains,omitempty"` - ResourceDomains []string `json:"resourceDomains,omitempty"` + BaseURIDomains []string `json:"baseUriDomains,omitzero"` + ConnectDomains []string `json:"connectDomains,omitzero"` + FrameDomains []string `json:"frameDomains,omitzero"` + ResourceDomains []string `json:"resourceDomains,omitzero"` } -// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. +// Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. type ToolExecutionCompleteUIResourceMetaUIPermissions struct { - // Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. + // Marker object for camera permission on an MCP Apps UI resource. Camera *ToolExecutionCompleteUIResourceMetaUIPermissionsCamera `json:"camera,omitempty"` - // Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. + // Marker object for clipboard-write permission on an MCP Apps UI resource. ClipboardWrite *ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite `json:"clipboardWrite,omitempty"` - // Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. + // Marker object for geolocation permission on an MCP Apps UI resource. Geolocation *ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation `json:"geolocation,omitempty"` - // Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. + // Marker object for microphone permission on an MCP Apps UI resource. Microphone *ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone `json:"microphone,omitempty"` } -// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. +// Marker object for camera permission on an MCP Apps UI resource. type ToolExecutionCompleteUIResourceMetaUIPermissionsCamera struct { } -// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. +// Marker object for clipboard-write permission on an MCP Apps UI resource. type ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite struct { } -// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. +// Marker object for geolocation permission on an MCP Apps UI resource. type ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation struct { } -// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. +// Marker object for microphone permission on an MCP Apps UI resource. type ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone struct { } -// A user message attachment — a file, directory, code selection, blob, or GitHub reference -type UserMessageAttachment interface { - userMessageAttachment() - Type() UserMessageAttachmentType -} - -type RawUserMessageAttachment struct { - Discriminator UserMessageAttachmentType - Raw json.RawMessage -} - -func (RawUserMessageAttachment) userMessageAttachment() {} -func (r RawUserMessageAttachment) Type() UserMessageAttachmentType { - return r.Discriminator -} - -// Blob attachment with inline base64-encoded data -type UserMessageAttachmentBlob struct { - // Base64-encoded content - Data string `json:"data"` - // User-facing display name for the attachment - DisplayName *string `json:"displayName,omitempty"` - // MIME type of the inline data - MIMEType string `json:"mimeType"` -} - -func (UserMessageAttachmentBlob) userMessageAttachment() {} -func (UserMessageAttachmentBlob) Type() UserMessageAttachmentType { - return UserMessageAttachmentTypeBlob -} - -// Directory attachment -type UserMessageAttachmentDirectory struct { - // User-facing display name for the attachment - DisplayName string `json:"displayName"` - // Absolute directory path - Path string `json:"path"` -} - -func (UserMessageAttachmentDirectory) userMessageAttachment() {} -func (UserMessageAttachmentDirectory) Type() UserMessageAttachmentType { - return UserMessageAttachmentTypeDirectory -} - -// File attachment -type UserMessageAttachmentFile struct { - // User-facing display name for the attachment - DisplayName string `json:"displayName"` - // Optional line range to scope the attachment to a specific section of the file - LineRange *UserMessageAttachmentFileLineRange `json:"lineRange,omitempty"` - // Absolute file path - Path string `json:"path"` -} - -func (UserMessageAttachmentFile) userMessageAttachment() {} -func (UserMessageAttachmentFile) Type() UserMessageAttachmentType { - return UserMessageAttachmentTypeFile -} - -// GitHub issue, pull request, or discussion reference -type UserMessageAttachmentGithubReference struct { - // Issue, pull request, or discussion number - Number int64 `json:"number"` - // Type of GitHub reference - ReferenceType UserMessageAttachmentGithubReferenceType `json:"referenceType"` - // Current state of the referenced item (e.g., open, closed, merged) - State string `json:"state"` - // Title of the referenced item - Title string `json:"title"` - // URL to the referenced item on GitHub - URL string `json:"url"` -} - -func (UserMessageAttachmentGithubReference) userMessageAttachment() {} -func (UserMessageAttachmentGithubReference) Type() UserMessageAttachmentType { - return UserMessageAttachmentTypeGithubReference -} - -// Code selection attachment from an editor -type UserMessageAttachmentSelection struct { - // User-facing display name for the selection - DisplayName string `json:"displayName"` - // Absolute path to the file containing the selection - FilePath string `json:"filePath"` - // Position range of the selection within the file - Selection UserMessageAttachmentSelectionDetails `json:"selection"` - // The selected text content - Text string `json:"text"` -} - -func (UserMessageAttachmentSelection) userMessageAttachment() {} -func (UserMessageAttachmentSelection) Type() UserMessageAttachmentType { - return UserMessageAttachmentTypeSelection +// Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs. +type ToolExecutionStartShellToolInfo struct { + // The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand. + // Experimental: DisplayCommand is part of an experimental API and may change or be removed. + DisplayCommand *string `json:"displayCommand,omitempty"` + // Whether the command includes a file write redirection (e.g., > or >>). + HasWriteFileRedirection bool `json:"hasWriteFileRedirection"` + // File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. + PossiblePaths []string `json:"possiblePaths"` } -// Optional line range to scope the attachment to a specific section of the file -type UserMessageAttachmentFileLineRange struct { - // End line number (1-based, inclusive) - End int64 `json:"end"` - // Start line number (1-based) - Start int64 `json:"start"` +// Tool definition metadata, present for MCP tools with MCP Apps support +type ToolExecutionStartToolDescription struct { + // Tool description + Description *string `json:"description,omitempty"` + // MCP Apps metadata for UI resource association + Meta *ToolExecutionStartToolDescriptionMeta `json:"_meta,omitempty"` + // Tool name + Name string `json:"name"` } -// Position range of the selection within the file -type UserMessageAttachmentSelectionDetails struct { - // End position of the selection - End UserMessageAttachmentSelectionDetailsEnd `json:"end"` - // Start position of the selection - Start UserMessageAttachmentSelectionDetailsStart `json:"start"` +// MCP Apps metadata for UI resource association +type ToolExecutionStartToolDescriptionMeta struct { + // MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. + UI *ToolExecutionStartToolDescriptionMetaUI `json:"ui,omitempty"` } -// End position of the selection -type UserMessageAttachmentSelectionDetailsEnd struct { - // End character offset within the line (0-based) - Character int64 `json:"character"` - // End line number (0-based) - Line int64 `json:"line"` +// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. +type ToolExecutionStartToolDescriptionMetaUI struct { + // URI of the UI resource + ResourceURI *string `json:"resourceUri,omitempty"` + // Who can access this tool + Visibility []ToolExecutionStartToolDescriptionMetaUIVisibility `json:"visibility,omitzero"` } -// Start position of the selection -type UserMessageAttachmentSelectionDetailsStart struct { - // Start character offset within the line (0-based) - Character int64 `json:"character"` - // Start line number (0-based) - Line int64 `json:"line"` +// Internal prompt-cache expiration state for one model +// Internal: UsageCheckpointModelCacheState is an internal SDK API and is not part of the public surface. +type UsageCheckpointModelCacheState struct { + // Latest known prompt-cache expiration + CacheExpiresAt time.Time `json:"cacheExpiresAt"` + // Retained cache lifetime in seconds, used to refresh expiration after a cache read + // Internal: CacheTtlSeconds is part of the SDK's internal API surface and is not intended for external use. + CacheTtlSeconds int64 `json:"cacheTtlSeconds"` + // Model identifier associated with this cache state + ModelID string `json:"modelId"` } // Working directory and git context at session start @@ -2989,6 +4072,8 @@ type WorkingDirectoryContext struct { HeadCommit *string `json:"headCommit,omitempty"` // Hosting platform type of the repository (github or ado) HostType *WorkingDirectoryContextHostType `json:"hostType,omitempty"` + // Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + PendingGitContext *bool `json:"pendingGitContext,omitempty"` // Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) Repository *string `json:"repository,omitempty"` // Raw host string from the git remote URL (e.g. "github.com", "mycompany.ghe.com", "dev.azure.com") @@ -3019,6 +4104,50 @@ const ( AssistantUsageAPIEndpointWsResponses AssistantUsageAPIEndpoint = "ws:/responses" ) +// Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs. +// Experimental: AutoApprovalJudgeFailureReason is part of an experimental API and may change or be removed. +type AutoApprovalJudgeFailureReason string + +const ( + // The judge model call was cancelled before it returned. + AutoApprovalJudgeFailureReasonAbort AutoApprovalJudgeFailureReason = "abort" + // The judge model call completed but returned no content. + AutoApprovalJudgeFailureReasonEmptyResponse AutoApprovalJudgeFailureReason = "empty_response" + // The judge model call failed (for example a transport, authentication, or rate-limit error). + AutoApprovalJudgeFailureReasonModelError AutoApprovalJudgeFailureReason = "model_error" + // The judge model replied, but the reply carried no ALLOW/DENY verdict. + AutoApprovalJudgeFailureReasonParseError AutoApprovalJudgeFailureReason = "parse_error" + // The judge model call exceeded its deadline. + AutoApprovalJudgeFailureReasonTimeout AutoApprovalJudgeFailureReason = "timeout" +) + +// Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off). +// Experimental: AutoApprovalRecommendation is part of an experimental API and may change or be removed. +type AutoApprovalRecommendation string + +const ( + // The judge evaluated the request and recommends automatically approving it. + AutoApprovalRecommendationApprove AutoApprovalRecommendation = "approve" + // The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. + AutoApprovalRecommendationError AutoApprovalRecommendation = "error" + // Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. + AutoApprovalRecommendationExcluded AutoApprovalRecommendation = "excluded" + // The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + AutoApprovalRecommendationRequireApproval AutoApprovalRecommendation = "requireApproval" +) + +// Coarse request-difficulty bucket for UX explainability +type AutoModeResolvedReasoningBucket string + +const ( + // The request looks high-reasoning; a stronger model is appropriate. + AutoModeResolvedReasoningBucketHigh AutoModeResolvedReasoningBucket = "high" + // The request looks low-reasoning; a lighter model is appropriate. + AutoModeResolvedReasoningBucketLow AutoModeResolvedReasoningBucket = "low" + // The request needs a moderate amount of reasoning. + AutoModeResolvedReasoningBucketMedium AutoModeResolvedReasoningBucket = "medium" +) + // The user's auto-mode-switch choice type AutoModeSwitchResponse string @@ -3057,14 +4186,63 @@ const ( AutopilotObjectiveChangedStatusPaused AutopilotObjectiveChangedStatus = "paused" ) -// Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. -type CanvasOpenedAvailability string +// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +type BinaryAssetReferenceType string + +const ( + // Binary image data. + BinaryAssetReferenceTypeImage BinaryAssetReferenceType = "image" + // Other binary resource data. + BinaryAssetReferenceTypeResource BinaryAssetReferenceType = "resource" +) + +// Binary asset type discriminator. Use "image" for images and "resource" otherwise. +type BinaryAssetType string + +const ( + // Binary image data. + BinaryAssetTypeImage BinaryAssetType = "image" + // Other binary resource data. + BinaryAssetTypeResource BinaryAssetType = "resource" +) + +// Type discriminator for CitationLocation. +// Experimental: CitationLocationType is part of an experimental API and may change or be removed. +type CitationLocationType string + +const ( + CitationLocationTypeBlock CitationLocationType = "block" + CitationLocationTypeChar CitationLocationType = "char" + CitationLocationTypePage CitationLocationType = "page" +) + +// The system that produced a citation. +// Experimental: CitationProvider is part of an experimental API and may change or be removed. +type CitationProvider string + +const ( + // Citation produced by an Anthropic (Claude) model response. + CitationProviderAnthropic CitationProvider = "anthropic" + // Citation synthesized client-side by the runtime from tool output. + CitationProviderClient CitationProvider = "client" + // Citation produced by an OpenAI model response. + CitationProviderOpenai CitationProvider = "openai" +) + +// What initiated a conversation compaction +type CompactionTrigger string const ( - // Provider connection is live; actions can be invoked. - CanvasOpenedAvailabilityReady CanvasOpenedAvailability = "ready" - // Provider has gone away; the instance is awaiting rebinding. - CanvasOpenedAvailabilityStale CanvasOpenedAvailability = "stale" + // Compaction forced by a context-limit model response (e.g. HTTP 413) before retrying the request. + CompactionTriggerContextLimitRetry CompactionTrigger = "context_limit_retry" + // User-requested compaction, e.g. the /compact command or the history.compact API. + CompactionTriggerManual CompactionTrigger = "manual" + // Emergency compaction triggered by high process memory usage. + CompactionTriggerMemoryPressure CompactionTrigger = "memory_pressure" + // Compaction requested while switching to a model with a smaller context window. + CompactionTriggerModelSwitch CompactionTrigger = "model_switch" + // Background compaction started automatically because context utilization crossed the background threshold. + CompactionTriggerThreshold CompactionTrigger = "threshold" ) // The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed) @@ -3114,8 +4292,12 @@ const ( type ExtensionsLoadedExtensionSource string const ( + // Extension contributed by an installed plugin. + ExtensionsLoadedExtensionSourcePlugin ExtensionsLoadedExtensionSource = "plugin" // Extension discovered from the current project. ExtensionsLoadedExtensionSourceProject ExtensionsLoadedExtensionSource = "project" + // Extension discovered from the current session's state directory. + ExtensionsLoadedExtensionSourceSession ExtensionsLoadedExtensionSource = "session" // Extension discovered from the user's extension directory. ExtensionsLoadedExtensionSourceUser ExtensionsLoadedExtensionSource = "user" ) @@ -3134,6 +4316,16 @@ const ( ExtensionsLoadedExtensionStatusStarting ExtensionsLoadedExtensionStatus = "starting" ) +// Operation gated by a factory permission request. +type FactoryPermissionOperation string + +const ( + // Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. + FactoryPermissionOperationAuthor FactoryPermissionOperation = "author" + // Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. + FactoryPermissionOperationRun FactoryPermissionOperation = "run" +) + // Origin type of the session being handed off type HandoffSourceType string @@ -3144,25 +4336,133 @@ const ( HandoffSourceTypeRemote HandoffSourceType = "remote" ) +// The category of runtime action that enterprise managed settings governed (blocked or capped) +type ManagedSettingsEnforcedAction string + +const ( + // An attempt to turn on a bypass-permissions ("yolo") escalation was refused or capped because policy disables bypass-permissions mode. + ManagedSettingsEnforcedActionBypassPermissionsBlocked ManagedSettingsEnforcedAction = "bypass_permissions_blocked" +) + +// For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused +type ManagedSettingsEnforcedEscalation string + +const ( + // Full allow-all ("/allow-all on") permissions — auto-approving tools, paths, and URLs. + ManagedSettingsEnforcedEscalationAllowAll ManagedSettingsEnforcedEscalation = "allow_all" + // Auto-approval of all tool permission requests. + ManagedSettingsEnforcedEscalationApproveAll ManagedSettingsEnforcedEscalation = "approve_all" + // Advisory auto-approval ("/allow-all auto") mode — keeps normal prompt paths and adds LLM-advised approval, distinct from full allow-all. + ManagedSettingsEnforcedEscalationAutoApproval ManagedSettingsEnforcedEscalation = "auto_approval" + // Unrestricted filesystem access outside the session's allowed directories. + ManagedSettingsEnforcedEscalationUnrestrictedPaths ManagedSettingsEnforcedEscalation = "unrestricted_paths" + // Unrestricted URL fetch access. + ManagedSettingsEnforcedEscalationUnrestrictedURLs ManagedSettingsEnforcedEscalation = "unrestricted_urls" +) + +// Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. +type ManagedSettingsResolvedSource string + +const ( + // Only session-local SDK-host injection contributed. + ManagedSettingsResolvedSourceClient ManagedSettingsResolvedSource = "client" + // Only the device MDM/plist/registry/file channel contributed. + ManagedSettingsResolvedSourceDevice ManagedSettingsResolvedSource = "device" + // More than one channel contributed. Ordinary keys resolve device over server per key, while permissions compose restrictively across all present layers. + ManagedSettingsResolvedSourceMixed ManagedSettingsResolvedSource = "mixed" + // No managed policy is in force (no channel contributed). + ManagedSettingsResolvedSourceNone ManagedSettingsResolvedSource = "none" + // Only the server/account channel contributed. + ManagedSettingsResolvedSourceServer ManagedSettingsResolvedSource = "server" +) + +// How the pending MCP headers refresh request resolved. +type MCPHeadersRefreshCompletedOutcome string + +const ( + // The host supplied dynamic headers. + MCPHeadersRefreshCompletedOutcomeHeaders MCPHeadersRefreshCompletedOutcome = "headers" + // The host responded with no dynamic headers. + MCPHeadersRefreshCompletedOutcomeNone MCPHeadersRefreshCompletedOutcome = "none" + // No response arrived within the bounded window. + MCPHeadersRefreshCompletedOutcomeTimeout MCPHeadersRefreshCompletedOutcome = "timeout" +) + +// Why dynamic headers are being requested. +type MCPHeadersRefreshRequiredReason string + +const ( + // The server returned 401 and stale dynamic headers were invalidated. + MCPHeadersRefreshRequiredReasonAuthFailed MCPHeadersRefreshRequiredReason = "auth-failed" + // The transport is making its first dynamic header request for this server. + MCPHeadersRefreshRequiredReasonStartup MCPHeadersRefreshRequiredReason = "startup" + // The previously cached dynamic headers expired. + MCPHeadersRefreshRequiredReasonTtlExpired MCPHeadersRefreshRequiredReason = "ttl-expired" +) + +// How the pending MCP OAuth request was completed +type MCPOauthCompletionOutcome string + +const ( + // The request completed without an OAuth provider. + MCPOauthCompletionOutcomeCancelled MCPOauthCompletionOutcome = "cancelled" + // The request completed with a token-backed OAuth provider. + MCPOauthCompletionOutcomeToken MCPOauthCompletionOutcome = "token" +) + +// Reason the runtime is requesting host-provided MCP OAuth credentials +type MCPOauthRequestReason string + +const ( + // Initial credentials are required before connecting to the MCP server. + MCPOauthRequestReasonInitial MCPOauthRequestReason = "initial" + // The server requires a new host authorization flow before continuing. + MCPOauthRequestReasonReauth MCPOauthRequestReason = "reauth" + // The current host-provided credential was rejected and a replacement is requested. + MCPOauthRequestReasonRefresh MCPOauthRequestReason = "refresh" + // The server requires a credential with additional scope or audience. + MCPOauthRequestReasonUpscope MCPOauthRequestReason = "upscope" +) + // 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). -type McpOauthRequiredStaticClientConfigGrantType string +type MCPOauthRequiredStaticClientConfigGrantType string const ( - McpOauthRequiredStaticClientConfigGrantTypeClientCredentials McpOauthRequiredStaticClientConfigGrantType = "client_credentials" + MCPOauthRequiredStaticClientConfigGrantTypeClientCredentials MCPOauthRequiredStaticClientConfigGrantType = "client_credentials" ) // Transport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server) -type McpServerTransport string +type MCPServerTransport string const ( // Server communicates over streamable HTTP. - McpServerTransportHTTP McpServerTransport = "http" + MCPServerTransportHTTP MCPServerTransport = "http" // Server is backed by an in-memory runtime implementation. - McpServerTransportMemory McpServerTransport = "memory" + MCPServerTransportMemory MCPServerTransport = "memory" // Server communicates over Server-Sent Events (deprecated). - McpServerTransportSse McpServerTransport = "sse" + MCPServerTransportSSE MCPServerTransport = "sse" // Server communicates over stdio with a local child process. - McpServerTransportStdio McpServerTransport = "stdio" + MCPServerTransportStdio MCPServerTransport = "stdio" +) + +// For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. +type ModelCallFailureBadRequestKind string + +const ( + // The 400 response carried no error body (transient gateway/proxy signature). + ModelCallFailureBadRequestKindBodyless ModelCallFailureBadRequestKind = "bodyless" + // The 400 response carried a structured CAPI error envelope (deterministic validation failure). + ModelCallFailureBadRequestKindStructuredError ModelCallFailureBadRequestKind = "structured_error" +) + +// Boundary that produced a model call failure +type ModelCallFailureKind string + +const ( + // The provider returned an API error response. + ModelCallFailureKindAPI ModelCallFailureKind = "api" + // The request transport failed before a usable API response completed. + ModelCallFailureKindTransport ModelCallFailureKind = "transport" ) // Where the failed model call originated @@ -3170,13 +4470,46 @@ type ModelCallFailureSource string const ( // Model call from MCP sampling. - ModelCallFailureSourceMcpSampling ModelCallFailureSource = "mcp_sampling" + ModelCallFailureSourceMCPSampling ModelCallFailureSource = "mcp_sampling" // Model call from a sub-agent. ModelCallFailureSourceSubagent ModelCallFailureSource = "subagent" // Model call from the top-level agent. ModelCallFailureSourceTopLevel ModelCallFailureSource = "top_level" ) +// Transport used for a failed model call +type ModelCallFailureTransport string + +const ( + // HTTP transport, including SSE streams. + ModelCallFailureTransportHTTP ModelCallFailureTransport = "http" + // WebSocket transport. + ModelCallFailureTransportWebsocket ModelCallFailureTransport = "websocket" +) + +// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +type OmittedBinaryType string + +const ( + // Binary image data. + OmittedBinaryTypeImage OmittedBinaryType = "image" + // Other binary resource data. + OmittedBinaryTypeResource OmittedBinaryType = "resource" +) + +// Allow-all mode for the session. +// Experimental: PermissionAllowAllMode is part of an experimental API and may change or be removed. +type PermissionAllowAllMode string + +const ( + // Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + PermissionAllowAllModeAuto PermissionAllowAllMode = "auto" + // Permission requests follow the normal approval flow. + PermissionAllowAllModeOff PermissionAllowAllMode = "off" + // Tool, path, and URL permission requests are automatically approved. + PermissionAllowAllModeOn PermissionAllowAllMode = "on" +) + // Kind discriminator for PermissionPromptRequest. type PermissionPromptRequestKind string @@ -3185,8 +4518,9 @@ const ( PermissionPromptRequestKindCustomTool PermissionPromptRequestKind = "custom-tool" PermissionPromptRequestKindExtensionManagement PermissionPromptRequestKind = "extension-management" PermissionPromptRequestKindExtensionPermissionAccess PermissionPromptRequestKind = "extension-permission-access" + PermissionPromptRequestKindFactory PermissionPromptRequestKind = "factory" PermissionPromptRequestKindHook PermissionPromptRequestKind = "hook" - PermissionPromptRequestKindMcp PermissionPromptRequestKind = "mcp" + PermissionPromptRequestKindMCP PermissionPromptRequestKind = "mcp" PermissionPromptRequestKindMemory PermissionPromptRequestKind = "memory" PermissionPromptRequestKindPath PermissionPromptRequestKind = "path" PermissionPromptRequestKindRead PermissionPromptRequestKind = "read" @@ -3213,8 +4547,9 @@ const ( PermissionRequestKindCustomTool PermissionRequestKind = "custom-tool" PermissionRequestKindExtensionManagement PermissionRequestKind = "extension-management" PermissionRequestKindExtensionPermissionAccess PermissionRequestKind = "extension-permission-access" + PermissionRequestKindFactory PermissionRequestKind = "factory" PermissionRequestKindHook PermissionRequestKind = "hook" - PermissionRequestKindMcp PermissionRequestKind = "mcp" + PermissionRequestKindMCP PermissionRequestKind = "mcp" PermissionRequestKindMemory PermissionRequestKind = "memory" PermissionRequestKindRead PermissionRequestKind = "read" PermissionRequestKindShell PermissionRequestKind = "shell" @@ -3257,6 +4592,25 @@ const ( PermissionResultKindDeniedNoApprovalRuleAndCouldNotRequestFromUser PermissionResultKind = "denied-no-approval-rule-and-could-not-request-from-user" ) +// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +type PersistedBinaryImageType string + +const ( + // Binary image data. + PersistedBinaryImageTypeImage PersistedBinaryImageType = "image" + // Other binary resource data. + PersistedBinaryImageTypeResource PersistedBinaryImageType = "resource" +) + +// Type discriminator for PersistedBinaryResult. +// Experimental: PersistedBinaryResultType is part of an experimental API and may change or be removed. +type PersistedBinaryResultType string + +const ( + PersistedBinaryResultTypeImage PersistedBinaryResultType = "image" + PersistedBinaryResultTypeResource PersistedBinaryResultType = "resource" +) + // The type of operation performed on the plan file type PlanChangedOperation string @@ -3269,31 +4623,28 @@ const ( PlanChangedOperationUpdate PlanChangedOperation = "update" ) -type SessionModelChangeDataContextTier string - -const ( - // Default context tier with standard context window size. - SessionModelChangeDataContextTierDefault SessionModelChangeDataContextTier = "default" - // Extended context tier with a larger context window. - SessionModelChangeDataContextTierLongContext SessionModelChangeDataContextTier = "long_context" -) - -type SessionResumeDataContextTier string +// Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may. +type ScheduleOrigin string const ( - // Default context tier with standard context window size. - SessionResumeDataContextTierDefault SessionResumeDataContextTier = "default" - // Extended context tier with a larger context window. - SessionResumeDataContextTierLongContext SessionResumeDataContextTier = "long_context" + // The schedule was created by the agent via the `manage_schedule` tool. + ScheduleOriginModel ScheduleOrigin = "model" + // The schedule was created by an explicit user action, such as `/every` or `/after`. + ScheduleOriginUser ScheduleOrigin = "user" ) -type SessionStartDataContextTier string +// User action selected for an exhausted session limit. +type SessionLimitsExhaustedResponseAction string const ( - // Default context tier with standard context window size. - SessionStartDataContextTierDefault SessionStartDataContextTier = "default" - // Extended context tier with a larger context window. - SessionStartDataContextTierLongContext SessionStartDataContextTier = "long_context" + // Increase the current max by an exact AI Credits amount. + SessionLimitsExhaustedResponseActionAdd SessionLimitsExhaustedResponseAction = "add" + // Leave the limit unchanged and cancel the blocked model request. + SessionLimitsExhaustedResponseActionCancel SessionLimitsExhaustedResponseAction = "cancel" + // Set a new absolute max AI Credits value. + SessionLimitsExhaustedResponseActionSet SessionLimitsExhaustedResponseAction = "set" + // Remove the current session limit. + SessionLimitsExhaustedResponseActionUnset SessionLimitsExhaustedResponseAction = "unset" ) // What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent) @@ -3328,16 +4679,44 @@ const ( SystemNotificationAgentCompletedStatusFailed SystemNotificationAgentCompletedStatus = "failed" ) +// Terminal status reached by a factory execution attempt. +type SystemNotificationFactoryCompletedStatus string + +const ( + // The factory was cancelled. + SystemNotificationFactoryCompletedStatusCancelled SystemNotificationFactoryCompletedStatus = "cancelled" + // The factory completed successfully. + SystemNotificationFactoryCompletedStatusCompleted SystemNotificationFactoryCompletedStatus = "completed" + // The factory failed. + SystemNotificationFactoryCompletedStatusError SystemNotificationFactoryCompletedStatus = "error" + // The factory was halted. + SystemNotificationFactoryCompletedStatusHalted SystemNotificationFactoryCompletedStatus = "halted" +) + // Type discriminator for SystemNotification. type SystemNotificationType string const ( SystemNotificationTypeAgentCompleted SystemNotificationType = "agent_completed" SystemNotificationTypeAgentIdle SystemNotificationType = "agent_idle" + SystemNotificationTypeFactoryCompleted SystemNotificationType = "factory_completed" SystemNotificationTypeInstructionDiscovered SystemNotificationType = "instruction_discovered" SystemNotificationTypeNewInboxMessage SystemNotificationType = "new_inbox_message" SystemNotificationTypeShellCompleted SystemNotificationType = "shell_completed" SystemNotificationTypeShellDetachedCompleted SystemNotificationType = "shell_detached_completed" + SystemNotificationTypeUnclassified SystemNotificationType = "unclassified" +) + +// Semantic result of evaluating a task completion request +type TaskCompletionOutcome string + +const ( + // Completion cannot proceed without intervention; the active objective is paused when one is identified. + TaskCompletionOutcomeBlocked TaskCompletionOutcome = "blocked" + // The completion request was accepted and the objective is complete. + TaskCompletionOutcomeCompleted TaskCompletionOutcome = "completed" + // The completion request was rejected because more work or validation remains. + TaskCompletionOutcomeContinue TaskCompletionOutcome = "continue" ) // Theme variant this icon is intended for @@ -3358,6 +4737,7 @@ const ( ToolExecutionCompleteContentTypeImage ToolExecutionCompleteContentType = "image" ToolExecutionCompleteContentTypeResource ToolExecutionCompleteContentType = "resource" ToolExecutionCompleteContentTypeResourceLink ToolExecutionCompleteContentType = "resource_link" + ToolExecutionCompleteContentTypeShellExit ToolExecutionCompleteContentType = "shell_exit" ToolExecutionCompleteContentTypeTerminal ToolExecutionCompleteContentType = "terminal" ToolExecutionCompleteContentTypeText ToolExecutionCompleteContentType = "text" ) @@ -3372,6 +4752,16 @@ const ( ToolExecutionCompleteToolDescriptionMetaUIVisibilityModel ToolExecutionCompleteToolDescriptionMetaUIVisibility = "model" ) +// Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration. +type ToolExecutionStartToolDescriptionMetaUIVisibility string + +const ( + // Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool + ToolExecutionStartToolDescriptionMetaUIVisibilityApp ToolExecutionStartToolDescriptionMetaUIVisibility = "app" + // Tool is callable by the model (LLM tool surface) + ToolExecutionStartToolDescriptionMetaUIVisibilityModel ToolExecutionStartToolDescriptionMetaUIVisibility = "model" +) + // The agent mode that was active when this message was sent type UserMessageAgentMode string @@ -3386,27 +4776,16 @@ const ( UserMessageAgentModeShell UserMessageAgentMode = "shell" ) -// Type of GitHub reference -type UserMessageAttachmentGithubReferenceType string - -const ( - // GitHub discussion reference. - UserMessageAttachmentGithubReferenceTypeDiscussion UserMessageAttachmentGithubReferenceType = "discussion" - // GitHub issue reference. - UserMessageAttachmentGithubReferenceTypeIssue UserMessageAttachmentGithubReferenceType = "issue" - // GitHub pull request reference. - UserMessageAttachmentGithubReferenceTypePr UserMessageAttachmentGithubReferenceType = "pr" -) - -// Type discriminator for UserMessageAttachment. -type UserMessageAttachmentType string +// How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn. +type UserMessageDelivery string const ( - UserMessageAttachmentTypeBlob UserMessageAttachmentType = "blob" - UserMessageAttachmentTypeDirectory UserMessageAttachmentType = "directory" - UserMessageAttachmentTypeFile UserMessageAttachmentType = "file" - UserMessageAttachmentTypeGithubReference UserMessageAttachmentType = "github_reference" - UserMessageAttachmentTypeSelection UserMessageAttachmentType = "selection" + // Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). + UserMessageDeliveryIdle UserMessageDelivery = "idle" + // Enqueued while the agent was busy; processed as its own run afterward. + UserMessageDeliveryQueued UserMessageDelivery = "queued" + // Injected into the current in-flight run while the agent was busy (immediate mode). + UserMessageDeliverySteering UserMessageDelivery = "steering" ) // Hosting platform type of the repository (github or ado) @@ -3414,9 +4793,9 @@ type WorkingDirectoryContextHostType string const ( // Repository is hosted on Azure DevOps. - WorkingDirectoryContextHostTypeAdo WorkingDirectoryContextHostType = "ado" + WorkingDirectoryContextHostTypeADO WorkingDirectoryContextHostType = "ado" // Repository is hosted on GitHub. - WorkingDirectoryContextHostTypeGithub WorkingDirectoryContextHostType = "github" + WorkingDirectoryContextHostTypeGitHub WorkingDirectoryContextHostType = "github" ) // Whether the file was newly created or updated @@ -3431,17 +4810,6 @@ const ( // Type aliases for convenience. type ( - Attachment = UserMessageAttachment - AttachmentType = UserMessageAttachmentType PermissionRequestCommand = PermissionRequestShellCommand PossibleURL = PermissionRequestShellPossibleURL ) - -// Constant aliases for convenience. -const ( - AttachmentTypeBlob = UserMessageAttachmentTypeBlob - AttachmentTypeDirectory = UserMessageAttachmentTypeDirectory - AttachmentTypeFile = UserMessageAttachmentTypeFile - AttachmentTypeGithubReference = UserMessageAttachmentTypeGithubReference - AttachmentTypeSelection = UserMessageAttachmentTypeSelection -) diff --git a/go/samples/manual_tool_resume/main.go b/go/samples/manual_tool_resume/main.go index 1e0a23f5b..a7391ff40 100644 --- a/go/samples/manual_tool_resume/main.go +++ b/go/samples/manual_tool_resume/main.go @@ -143,7 +143,7 @@ func main() { } session2, err := client2.ResumeSession(ctx, sessionID, &copilot.ResumeSessionConfig{ Tools: []copilot.Tool{tool}, - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), }) if err != nil { panic(err) @@ -177,7 +177,7 @@ func main() { } session3, err := client3.ResumeSession(ctx, sessionID, &copilot.ResumeSessionConfig{ Tools: []copilot.Tool{tool}, - ContinuePendingWork: true, + ContinuePendingWork: copilot.Bool(true), }) if err != nil { panic(err) diff --git a/go/sdk_protocol_version.go b/go/sdk_protocol_version.go index 95249568b..eb17c7bbd 100644 --- a/go/sdk_protocol_version.go +++ b/go/sdk_protocol_version.go @@ -2,11 +2,11 @@ package copilot -// SdkProtocolVersion is the SDK protocol version. +// SDKProtocolVersion is the SDK protocol version. // This must match the version expected by the copilot-agent-runtime server. -const SdkProtocolVersion = 3 +const SDKProtocolVersion = 3 -// GetSdkProtocolVersion returns the SDK protocol version. -func GetSdkProtocolVersion() int { - return SdkProtocolVersion +// GetSDKProtocolVersion returns the SDK protocol version. +func GetSDKProtocolVersion() int { + return SDKProtocolVersion } diff --git a/go/session.go b/go/session.go index fa03f5cc7..600a4bbeb 100644 --- a/go/session.go +++ b/go/session.go @@ -5,6 +5,7 @@ import ( "context" "encoding/json" "fmt" + "log" "sync" "time" @@ -12,6 +13,11 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) +// toolSearchToolName is the fixed name of the runtime's built-in tool-search +// tool. A client can replace its behavior by registering a [Tool] with this +// exact name and OverridesBuiltInTool set to true. +const toolSearchToolName = "tool_search_tool" + type sessionHandler struct { id uint64 fn SessionEventHandler @@ -53,7 +59,7 @@ type Session struct { SessionID string workspacePath string client *jsonrpc2.Client - clientSessionApis *rpc.ClientSessionApiHandlers + clientSessionAPIs *rpc.ClientSessionAPIHandlers handlers []sessionHandler nextHandlerID uint64 handlerMutex sync.RWMutex @@ -61,6 +67,9 @@ type Session struct { toolHandlersM sync.RWMutex permissionHandler PermissionHandlerFunc permissionMux sync.RWMutex + managedSettings bool + mcpAuthHandler MCPAuthHandler + mcpAuthMu sync.RWMutex userInputHandler UserInputHandler userInputMux sync.RWMutex exitPlanModeHandler ExitPlanModeRequestHandler @@ -77,6 +86,8 @@ type Session struct { elicitationMu sync.RWMutex canvasHandler CanvasHandler canvasMu sync.RWMutex + bearerTokenProviders map[string]BearerTokenProvider + bearerTokenMu sync.RWMutex openCanvases []rpc.OpenCanvasInstance openCanvasesMu sync.RWMutex capabilities SessionCapabilities @@ -88,7 +99,7 @@ type Session struct { closeOnce sync.Once // guards eventCh close so Disconnect is safe to call more than once // RPC provides typed session-scoped RPC methods. - RPC *rpc.SessionRpc + RPC *rpc.SessionRPC } // WorkspacePath returns the path to the session workspace directory when infinite @@ -100,7 +111,8 @@ func (s *Session) WorkspacePath() string { // OpenCanvases returns the open-canvas snapshot last reported by the runtime. // The snapshot is populated from session.resume and live session.canvas.opened -// events. The returned slice is a copy and is safe to mutate by the caller. +// and session.canvas.closed events. The returned slice is a copy and is safe to +// mutate by the caller. func (s *Session) OpenCanvases() []rpc.OpenCanvasInstance { s.openCanvasesMu.RLock() defer s.openCanvasesMu.RUnlock() @@ -130,27 +142,43 @@ func (s *Session) upsertOpenCanvas(canvas rpc.OpenCanvasInstance) { s.openCanvases = append(s.openCanvases, canvas) } -func (s *Session) updateOpenCanvasesFromEvent(event SessionEvent) { - data, ok := event.Data.(*SessionCanvasOpenedData) - if !ok { - return +func (s *Session) removeOpenCanvas(instanceID string) { + s.openCanvasesMu.Lock() + defer s.openCanvasesMu.Unlock() + filtered := make([]rpc.OpenCanvasInstance, 0, len(s.openCanvases)) + for _, canvas := range s.openCanvases { + if canvas.InstanceID != instanceID { + filtered = append(filtered, canvas) + } } - if data.InstanceID == "" || data.CanvasID == "" || data.ExtensionID == "" || data.Availability == "" { - fmt.Printf("failed to deserialize session.canvas.opened payload\n") - return + s.openCanvases = filtered +} + +func (s *Session) updateOpenCanvasesFromEvent(event SessionEvent) { + switch data := event.Data.(type) { + case *SessionCanvasOpenedData: + if data.InstanceID == "" || data.CanvasID == "" || data.ExtensionID == "" { + fmt.Printf("failed to deserialize session.canvas.opened payload\n") + return + } + s.upsertOpenCanvas(rpc.OpenCanvasInstance{ + CanvasID: data.CanvasID, + ExtensionID: data.ExtensionID, + ExtensionName: data.ExtensionName, + Input: data.Input, + InstanceID: data.InstanceID, + Status: data.Status, + Title: data.Title, + Icon: data.Icon, + URL: data.URL, + }) + case *SessionCanvasClosedData: + if data.InstanceID == "" { + fmt.Printf("failed to deserialize session.canvas.closed payload\n") + return + } + s.removeOpenCanvas(data.InstanceID) } - s.upsertOpenCanvas(rpc.OpenCanvasInstance{ - Availability: rpc.CanvasInstanceAvailability(data.Availability), - CanvasID: data.CanvasID, - ExtensionID: data.ExtensionID, - ExtensionName: data.ExtensionName, - Input: data.Input, - InstanceID: data.InstanceID, - Reopen: data.Reopen, - Status: data.Status, - Title: data.Title, - URL: data.URL, - }) } func (s *Session) registerCanvasHandler(handler CanvasHandler) { @@ -165,6 +193,66 @@ func (s *Session) getCanvasHandler() CanvasHandler { return s.canvasHandler } +// registerBearerTokenProviders installs per-provider [BearerTokenProvider] callbacks +// for BYOK providers configured with managed-identity / on-demand bearer-token +// auth, keyed by provider name. +// +// The runtime never receives the callback itself; the SDK strips it from the +// provider config and instead sends `hasBearerTokenProvider: true`. When the +// runtime needs a token it issues a session-scoped `providerToken.getToken` +// request, which the session's provider-token adapter routes to the matching +// per-provider callback. +func (s *Session) registerBearerTokenProviders(providers map[string]BearerTokenProvider) { + s.bearerTokenMu.Lock() + defer s.bearerTokenMu.Unlock() + s.bearerTokenProviders = make(map[string]BearerTokenProvider, len(providers)) + for name, callback := range providers { + if callback == nil { + continue + } + s.bearerTokenProviders[name] = callback + } +} + +func (s *Session) getBearerTokenProvider(providerName string) BearerTokenProvider { + s.bearerTokenMu.RLock() + defer s.bearerTokenMu.RUnlock() + return s.bearerTokenProviders[providerName] +} + +type providerTokenClientSessionAdapter struct { + session *Session +} + +func newProviderTokenClientSessionAdapter(session *Session) rpc.ProviderTokenHandler { + return &providerTokenClientSessionAdapter{session: session} +} + +func (a *providerTokenClientSessionAdapter) GetToken(request *rpc.ProviderTokenAcquireRequest) (*rpc.ProviderTokenAcquireResult, error) { + if request == nil { + return nil, providerTokenJSONRPCError("missing provider token request") + } + if a.session == nil || a.session.SessionID != request.SessionID { + return nil, providerTokenJSONRPCError(fmt.Sprintf("unknown session %s", request.SessionID)) + } + callback := a.session.getBearerTokenProvider(request.ProviderName) + if callback == nil { + return nil, providerTokenJSONRPCError(fmt.Sprintf("No bearer-token provider registered for provider %q", request.ProviderName)) + } + token, err := callback(ProviderTokenArgs{ProviderName: request.ProviderName, SessionID: request.SessionID}) + if err != nil { + return nil, providerTokenJSONRPCError(err.Error()) + } + return &rpc.ProviderTokenAcquireResult{Token: token}, nil +} + +func providerTokenJSONRPCError(message string) *jsonrpc2.Error { + return &jsonrpc2.Error{ + Code: -32603, + Message: message, + } +} + type canvasClientSessionAdapter struct { session *Session } @@ -278,19 +366,26 @@ func canvasResultError(err error) error { } // newSession creates a new session wrapper with the given session ID and client. -func newSession(sessionID string, client *jsonrpc2.Client, workspacePath string) *Session { +func newSession( + sessionID string, + client *jsonrpc2.Client, + workspacePath string, + managedSettings bool, +) *Session { s := &Session{ SessionID: sessionID, workspacePath: workspacePath, + managedSettings: managedSettings, client: client, - clientSessionApis: &rpc.ClientSessionApiHandlers{}, + clientSessionAPIs: &rpc.ClientSessionAPIHandlers{}, handlers: make([]sessionHandler, 0), toolHandlers: make(map[string]ToolHandler), commandHandlers: make(map[string]CommandHandler), eventCh: make(chan SessionEvent, 128), - RPC: rpc.NewSessionRpc(client, sessionID), + RPC: rpc.NewSessionRPC(client, sessionID), } - s.clientSessionApis.Canvas = newCanvasClientSessionAdapter(s) + s.clientSessionAPIs.Canvas = newCanvasClientSessionAdapter(s) + s.clientSessionAPIs.ProviderToken = newProviderTokenClientSessionAdapter(s) go s.processEvents() return s } @@ -311,7 +406,7 @@ func newSession(sessionID string, client *jsonrpc2.Client, workspacePath string) // messageID, err := session.Send(context.Background(), copilot.MessageOptions{ // Prompt: "Explain this code", // Attachments: []copilot.Attachment{ -// &copilot.UserMessageAttachmentFile{DisplayName: "main.go", Path: "./main.go"}, +// &copilot.AttachmentFile{DisplayName: "main.go", Path: "./main.go"}, // }, // }) // if err != nil { @@ -331,7 +426,7 @@ func (s *Session) Send(ctx context.Context, options MessageOptions) (string, err RequestHeaders: options.RequestHeaders, } - result, err := s.client.Request("session.send", req) + result, err := s.client.Request(ctx, "session.send", req) if err != nil { return "", fmt.Errorf("failed to send message: %w", err) } @@ -426,7 +521,7 @@ func (s *Session) SendAndWait(ctx context.Context, options MessageOptions) (*Ses return result, nil case err := <-errCh: return nil, err - case <-ctx.Done(): // TODO: remove once session.Send honors the context + case <-ctx.Done(): return nil, fmt.Errorf("waiting for session.idle: %w", ctx.Err()) } } @@ -652,14 +747,14 @@ func (s *Session) handleHooksInvoke(hookType string, rawInput json.RawMessage) ( return hooks.OnPreToolUse(input, invocation) case "preMcpToolCall": - if hooks.OnPreMcpToolCall == nil { + if hooks.OnPreMCPToolCall == nil { return nil, nil } - var input PreMcpToolCallHookInput + var input PreMCPToolCallHookInput if err := json.Unmarshal(rawInput, &input); err != nil { return nil, fmt.Errorf("invalid hook input: %w", err) } - return hooks.OnPreMcpToolCall(input, invocation) + return hooks.OnPreMCPToolCall(input, invocation) case "postToolUse": if hooks.OnPostToolUse == nil { @@ -691,6 +786,16 @@ func (s *Session) handleHooksInvoke(hookType string, rawInput json.RawMessage) ( } return hooks.OnUserPromptSubmitted(input, invocation) + case "userPromptTransformed": + if hooks.OnUserPromptTransformed == nil { + return nil, nil + } + var input UserPromptTransformedHookInput + if err := json.Unmarshal(rawInput, &input); err != nil { + return nil, fmt.Errorf("invalid hook input: %w", err) + } + return hooks.OnUserPromptTransformed(input, invocation) + case "sessionStart": if hooks.OnSessionStart == nil { return nil, nil @@ -720,6 +825,17 @@ func (s *Session) handleHooksInvoke(hookType string, rawInput json.RawMessage) ( return nil, fmt.Errorf("invalid hook input: %w", err) } return hooks.OnErrorOccurred(input, invocation) + + case "agentStop": + if hooks.OnAgentStop == nil { + return nil, nil + } + var input AgentStopHookInput + if err := json.Unmarshal(rawInput, &input); err != nil { + return nil, fmt.Errorf("invalid hook input: %w", err) + } + return hooks.OnAgentStop(input, invocation) + default: return nil, nil } @@ -845,6 +961,53 @@ func (s *Session) getElicitationHandler() ElicitationHandler { return s.elicitationHandler } +func (s *Session) registerMCPAuthHandler(handler MCPAuthHandler) { + s.mcpAuthMu.Lock() + defer s.mcpAuthMu.Unlock() + s.mcpAuthHandler = handler +} + +func (s *Session) getMCPAuthHandler() MCPAuthHandler { + s.mcpAuthMu.RLock() + defer s.mcpAuthMu.RUnlock() + return s.mcpAuthHandler +} + +func (s *Session) handleMCPAuthRequest(request MCPAuthRequest) { + handler := s.getMCPAuthHandler() + if handler == nil { + return + } + + ctx := context.Background() + cancel := &rpc.MCPOauthPendingRequestResponseCancelled{} + result, err := handler(request, MCPAuthInvocation{SessionID: s.SessionID}) + if err != nil { + log.Printf( + "MCP OAuth handler failed. SessionId=%s, RequestId=%s, Error=%v", + s.SessionID, + request.RequestID, + err, + ) + } + if err != nil || result == nil || result.Kind == MCPAuthResultKindCancelled || result.Token == nil { + s.RPC.MCP.Oauth().HandlePendingRequest(ctx, &rpc.MCPOauthHandlePendingRequest{ + RequestID: request.RequestID, + Result: cancel, + }) + return + } + + s.RPC.MCP.Oauth().HandlePendingRequest(ctx, &rpc.MCPOauthHandlePendingRequest{ + RequestID: request.RequestID, + Result: &rpc.MCPOauthPendingRequestResponseToken{ + AccessToken: result.Token.AccessToken, + TokenType: result.Token.TokenType, + ExpiresIn: result.Token.ExpiresIn, + }, + }) +} + // handleElicitationRequest dispatches an elicitation.requested event to the registered handler // and sends the result back via the RPC layer. Auto-cancels on error. func (s *Session) handleElicitationRequest(elicitCtx ElicitationContext, requestID string) { @@ -867,25 +1030,28 @@ func (s *Session) handleElicitationRequest(elicitCtx ElicitationContext, request return } - rpcContent := make(map[string]rpc.UIElicitationFieldValue) - for k, v := range result.Content { - contentValue, err := toRPCContent(v) - if err != nil { - s.RPC.UI.HandlePendingElicitation(ctx, &rpc.UIHandlePendingElicitationRequest{ - RequestID: requestID, - Result: rpc.UIElicitationResponse{ - Action: rpc.UIElicitationResponseActionCancel, - }, - }) - return + var rpcContent map[string]rpc.UIElicitationFieldValue + if result.Content != nil { + rpcContent = make(map[string]rpc.UIElicitationFieldValue, len(result.Content)) + for k, v := range result.Content { + contentValue, err := toRPCContent(v) + if err != nil { + s.RPC.UI.HandlePendingElicitation(ctx, &rpc.UIHandlePendingElicitationRequest{ + RequestID: requestID, + Result: rpc.UIElicitationResponse{ + Action: rpc.UIElicitationResponseActionCancel, + }, + }) + return + } + rpcContent[k] = contentValue } - rpcContent[k] = contentValue } s.RPC.UI.HandlePendingElicitation(ctx, &rpc.UIHandlePendingElicitationRequest{ RequestID: requestID, Result: rpc.UIElicitationResponse{ - Action: rpc.UIElicitationResponseAction(result.Action), + Action: result.Action, Content: rpcContent, }, }) @@ -983,13 +1149,17 @@ func (s *Session) assertElicitation() error { } // Elicitation shows a generic elicitation dialog with a custom schema. -func (ui *SessionUI) Elicitation(ctx context.Context, message string, requestedSchema rpc.UIElicitationSchema) (*ElicitationResult, error) { +func (ui *SessionUI) Elicitation(ctx context.Context, message string, requestedSchema ElicitationSchema) (*ElicitationResult, error) { if err := ui.session.assertElicitation(); err != nil { return nil, err } + rpcSchema, err := toRPCUIElicitationSchema(requestedSchema) + if err != nil { + return nil, err + } rpcResult, err := ui.session.RPC.UI.Elicitation(ctx, &rpc.UIElicitationRequest{ Message: message, - RequestedSchema: requestedSchema, + RequestedSchema: rpcSchema, }) if err != nil { return nil, err @@ -997,6 +1167,60 @@ func (ui *SessionUI) Elicitation(ctx context.Context, message string, requestedS return fromRPCElicitationResult(rpcResult), nil } +func toRPCUIElicitationSchema(schema ElicitationSchema) (rpc.UIElicitationSchema, error) { + var properties map[string]rpc.UIElicitationSchemaProperty + if schema.Properties != nil { + properties = make(map[string]rpc.UIElicitationSchemaProperty, len(schema.Properties)) + for name, property := range schema.Properties { + rpcProperty, err := toRPCUIElicitationSchemaProperty(name, property) + if err != nil { + return rpc.UIElicitationSchema{}, err + } + properties[name] = rpcProperty + } + } + + return rpc.UIElicitationSchema{ + Properties: properties, + Required: append([]string(nil), schema.Required...), + Type: rpc.UIElicitationSchemaTypeObject, + }, nil +} + +func toRPCUIElicitationSchemaProperty(name string, property any) (rpc.UIElicitationSchemaProperty, error) { + if property == nil { + return nil, fmt.Errorf("elicitation schema property %q is nil", name) + } + if rpcProperty, ok := property.(rpc.UIElicitationSchemaProperty); ok { + return rpcProperty, nil + } + + data, err := json.Marshal(property) + if err != nil { + return nil, fmt.Errorf("marshal elicitation schema property %q: %w", name, err) + } + wrapperData, err := json.Marshal(struct { + Properties map[string]json.RawMessage `json:"properties"` + Type rpc.UIElicitationSchemaType `json:"type"` + }{ + Properties: map[string]json.RawMessage{name: data}, + Type: rpc.UIElicitationSchemaTypeObject, + }) + if err != nil { + return nil, fmt.Errorf("marshal elicitation schema wrapper for property %q: %w", name, err) + } + + var rpcSchema rpc.UIElicitationSchema + if err := json.Unmarshal(wrapperData, &rpcSchema); err != nil { + return nil, fmt.Errorf("decode elicitation schema property %q: %w", name, err) + } + rpcProperty, ok := rpcSchema.Properties[name] + if !ok { + return nil, fmt.Errorf("decode elicitation schema property %q: property missing after conversion", name) + } + return rpcProperty, nil +} + // Confirm shows a confirmation dialog and returns the user's boolean answer. // Returns false if the user declines or cancels. func (ui *SessionUI) Confirm(ctx context.Context, message string) (bool, error) { @@ -1057,7 +1281,7 @@ func (ui *SessionUI) Select(ctx context.Context, message string, options []strin // Input shows a text input dialog. Returns the entered text, or empty string and // false if the user declines/cancels. -func (ui *SessionUI) Input(ctx context.Context, message string, opts *UiInputOptions) (string, bool, error) { +func (ui *SessionUI) Input(ctx context.Context, message string, opts *UIInputOptions) (string, bool, error) { if err := ui.session.assertElicitation(); err != nil { return "", false, err } @@ -1111,17 +1335,20 @@ func fromRPCElicitationResult(r *rpc.UIElicitationResponse) *ElicitationResult { if r == nil { return nil } - content := make(map[string]any) - for k, v := range r.Content { - content[k] = fromRPCContent(v) + var content map[string]ElicitationFieldValue + if r.Content != nil { + content = make(map[string]ElicitationFieldValue, len(r.Content)) + for k, v := range r.Content { + content[k] = fromRPCContent(v) + } } return &ElicitationResult{ - Action: string(r.Action), + Action: r.Action, Content: content, } } -func fromRPCContent(value rpc.UIElicitationFieldValue) any { +func fromRPCContent(value rpc.UIElicitationFieldValue) ElicitationFieldValue { switch v := value.(type) { case nil: return nil @@ -1137,6 +1364,16 @@ func fromRPCContent(value rpc.UIElicitationFieldValue) any { return nil } +func fromRPCElicitationRequestedSchema(schema *rpc.ElicitationRequestedSchema) *ElicitationSchema { + if schema == nil { + return nil + } + return &ElicitationSchema{ + Properties: schema.Properties, + Required: schema.Required, + } +} + // dispatchEvent enqueues an event for delivery to user handlers and fires // broadcast handlers concurrently. // @@ -1217,43 +1454,67 @@ func (s *Session) handleBroadcastEvent(event SessionEvent) { } s.executePermissionAndRespond(d.RequestID, d.PermissionRequest, handler) - case *CommandExecuteData: - s.executeCommandAndRespond(d.RequestID, d.CommandName, d.Command, d.Args) - - case *ElicitationRequestedData: - handler := s.getElicitationHandler() + case *MCPOauthRequiredData: + handler := s.getMCPAuthHandler() + if d.RequestID == "" { + return + } if handler == nil { + log.Printf( + "Received MCP OAuth request without a registered MCP auth handler. SessionId=%s, RequestId=%s", + s.SessionID, + d.RequestID, + ) return } - var requestedSchema map[string]any - if d.RequestedSchema != nil { - requestedSchema = map[string]any{ - "type": string(d.RequestedSchema.Type), - "properties": d.RequestedSchema.Properties, + var staticClientConfig *MCPAuthStaticClientConfig + if d.StaticClientConfig != nil { + var grantType *string + if d.StaticClientConfig.GrantType != nil { + value := string(*d.StaticClientConfig.GrantType) + grantType = &value } - if len(d.RequestedSchema.Required) > 0 { - requestedSchema["required"] = d.RequestedSchema.Required + staticClientConfig = &MCPAuthStaticClientConfig{ + ClientID: d.StaticClientConfig.ClientID, + ClientSecret: d.StaticClientConfig.ClientSecret, + GrantType: grantType, + PublicClient: d.StaticClientConfig.PublicClient, } } - mode := "" - if d.Mode != nil { - mode = string(*d.Mode) + request := MCPAuthRequest{ + RequestID: d.RequestID, + ServerName: d.ServerName, + ServerURL: d.ServerURL, + Reason: d.Reason, + StaticClientConfig: staticClientConfig, } - elicitationSource := "" - if d.ElicitationSource != nil { - elicitationSource = *d.ElicitationSource + if d.ResourceMetadata != nil { + request.ResourceMetadata = d.ResourceMetadata + } + if d.WwwAuthenticateParams != nil { + request.WwwAuthenticateParams = &MCPAuthWwwAuthenticateParams{ + ResourceMetadataURL: d.WwwAuthenticateParams.ResourceMetadataURL, + Scope: d.WwwAuthenticateParams.Scope, + Error: d.WwwAuthenticateParams.Error, + } } - url := "" - if d.URL != nil { - url = *d.URL + s.handleMCPAuthRequest(request) + + case *CommandExecuteData: + s.executeCommandAndRespond(d.RequestID, d.CommandName, d.Command, d.Args) + + case *ElicitationRequestedData: + handler := s.getElicitationHandler() + if handler == nil { + return } s.handleElicitationRequest(ElicitationContext{ SessionID: s.SessionID, Message: d.Message, - RequestedSchema: requestedSchema, - Mode: mode, - ElicitationSource: elicitationSource, - URL: url, + RequestedSchema: fromRPCElicitationRequestedSchema(d.RequestedSchema), + Mode: d.Mode, + ElicitationSource: d.ElicitationSource, + URL: d.URL, }, d.RequestID) case *CapabilitiesChangedData: @@ -1286,6 +1547,17 @@ func (s *Session) executeToolAndRespond(requestID, toolName, toolCallID string, TraceContext: ctx, } + // The built-in tool-search tool receives a snapshot of the session's + // currently initialized tools so an override can filter the live catalog + // without issuing its own RPC. Fetch it only for that tool to avoid a + // round-trip on every tool call; a failed fetch leaves the snapshot nil + // rather than failing the tool. + if toolName == toolSearchToolName { + if metadata, mErr := s.RPC.Tools.GetCurrentMetadata(ctx); mErr == nil && metadata != nil { + invocation.AvailableTools = metadata.Tools + } + } + result, err := handler(invocation) if err != nil { errMsg := err.Error() @@ -1315,10 +1587,25 @@ func (s *Session) executeToolAndRespond(requestID, toolName, toolCallID string, TextResultForLlm: textResultForLLM, ToolTelemetry: result.ToolTelemetry, ResultType: &effectiveResultType, + ToolReferences: result.ToolReferences, } if result.Error != "" { rpcResult.Error = &result.Error } + if result.SessionLog != "" { + rpcResult.SessionLog = &result.SessionLog + } + for _, b := range result.BinaryResultsForLLM { + entry := rpc.ExternalToolTextResultForLlmBinaryResultsForLlm{ + Data: b.Data, + MIMEType: b.MIMEType, + Type: rpc.ExternalToolTextResultForLlmBinaryResultsForLlmType(b.Type), + } + if b.Description != "" { + entry.Description = &b.Description + } + rpcResult.BinaryResultsForLlm = append(rpcResult.BinaryResultsForLlm, entry) + } s.RPC.Tools.HandlePendingToolCall(ctx, &rpc.HandlePendingToolCallRequest{ RequestID: requestID, Result: rpcResult, @@ -1337,11 +1624,13 @@ func (s *Session) executePermissionAndRespond(requestID string, permissionReques }() invocation := PermissionInvocation{ - SessionID: s.SessionID, + SessionID: s.SessionID, + ManagedSettingsEnabled: s.managedSettings, } decision, err := handler(permissionRequest, invocation) if err != nil { + log.Printf("permission handler failed: session_id=%s request_id=%s error=%v", s.SessionID, requestID, err) s.RPC.Permissions.HandlePendingPermissionRequest(context.Background(), &rpc.PermissionDecisionRequest{ RequestID: requestID, Result: &rpc.PermissionDecisionUserNotAvailable{}, @@ -1357,6 +1646,10 @@ func (s *Session) executePermissionAndRespond(requestID string, permissionReques }) return } + // Unwrap any attribution so decisionContext travels as a sibling of result, + // not nested inside it. The suppression and send logic below operates on the + // underlying decision. + decision, decisionContext := splitAttribution(decision) if _, ok := decision.(*rpc.PermissionDecisionNoResult); ok { return } @@ -1365,8 +1658,9 @@ func (s *Session) executePermissionAndRespond(requestID string, permissionReques } s.RPC.Permissions.HandlePendingPermissionRequest(context.Background(), &rpc.PermissionDecisionRequest{ - RequestID: requestID, - Result: decision, + RequestID: requestID, + Result: decision, + DecisionContext: decisionContext, }) } @@ -1392,7 +1686,7 @@ func (s *Session) executePermissionAndRespond(requestID string, permissionReques // } func (s *Session) GetEvents(ctx context.Context) ([]SessionEvent, error) { - result, err := s.client.Request("session.getMessages", sessionGetMessagesRequest{SessionID: s.SessionID}) + result, err := s.client.Request(ctx, "session.getMessages", sessionGetMessagesRequest{SessionID: s.SessionID}) if err != nil { return nil, fmt.Errorf("failed to get events: %w", err) } @@ -1427,7 +1721,7 @@ func (s *Session) GetEvents(ctx context.Context) ([]SessionEvent, error) { // log.Printf("Failed to disconnect session: %v", err) // } func (s *Session) Disconnect() error { - _, err := s.client.Request("session.destroy", sessionDestroyRequest{SessionID: s.SessionID}) + _, err := s.client.Request(context.Background(), "session.destroy", sessionDestroyRequest{SessionID: s.SessionID}) if err != nil { return fmt.Errorf("failed to disconnect session: %w", err) } @@ -1480,7 +1774,7 @@ func (s *Session) Disconnect() error { // log.Printf("Failed to abort: %v", err) // } func (s *Session) Abort(ctx context.Context) error { - _, err := s.client.Request("session.abort", sessionAbortRequest{SessionID: s.SessionID}) + _, err := s.client.Request(ctx, "session.abort", sessionAbortRequest{SessionID: s.SessionID}) if err != nil { return fmt.Errorf("failed to abort session: %w", err) } @@ -1490,11 +1784,14 @@ func (s *Session) Abort(ctx context.Context) error { // SetModelOptions configures optional parameters for SetModel. type SetModelOptions struct { - // ReasoningEffort sets the reasoning effort level for the new model (e.g., "low", "medium", "high", "xhigh"). + // ReasoningEffort sets the reasoning effort level for the new model (e.g., "low", "medium", "high", "xhigh", "max"). ReasoningEffort *string // ReasoningSummary sets the reasoning summary mode for the new model. // Use ReasoningSummaryNone to suppress summary output regardless of whether reasoning is enabled. ReasoningSummary *ReasoningSummary + // ContextTier explicitly selects a context window tier for models that support it. + // Leave nil to use normal model behavior with no explicit tier. + ContextTier *ContextTier // ModelCapabilities overrides individual model capabilities resolved by the runtime. // Only non-nil fields are applied over the runtime-resolved capabilities. ModelCapabilities *rpc.ModelCapabilitiesOverride @@ -1505,7 +1802,7 @@ type SetModelOptions struct { // // Example: // -// if err := session.SetModel(context.Background(), "gpt-4.1", nil); err != nil { +// if err := session.SetModel(context.Background(), "gpt-5.4", nil); err != nil { // log.Printf("Failed to set model: %v", err) // } // if err := session.SetModel(context.Background(), "claude-sonnet-4.6", &SetModelOptions{ReasoningEffort: new("high")}); err != nil { @@ -1516,6 +1813,7 @@ func (s *Session) SetModel(ctx context.Context, model string, opts *SetModelOpti if opts != nil { params.ReasoningEffort = opts.ReasoningEffort params.ReasoningSummary = opts.ReasoningSummary + params.ContextTier = opts.ContextTier params.ModelCapabilities = opts.ModelCapabilities } _, err := s.RPC.Model.SwitchTo(ctx, params) diff --git a/go/session_event_serialization_test.go b/go/session_event_serialization_test.go index 5f8855336..ee9258b22 100644 --- a/go/session_event_serialization_test.go +++ b/go/session_event_serialization_test.go @@ -145,6 +145,26 @@ func TestSessionEventAgentIDRoundTripsUnknownEvent(t *testing.T) { } } +func TestInternalSessionEventUsesRawFallback(t *testing.T) { + var event SessionEvent + if err := json.Unmarshal([]byte(`{ + "id": "00000000-0000-0000-0000-000000000003", + "timestamp": "2026-01-01T00:00:00Z", + "parentId": null, + "type": "session.memory_changed", + "data": {} + }`), &event); err != nil { + t.Fatalf("failed to unmarshal internal session event: %v", err) + } + + if _, ok := event.Data.(*RawSessionEventData); !ok { + t.Fatalf("expected internal event to use raw session event data, got %T", event.Data) + } + if event.Type() != "session.memory_changed" { + t.Fatalf("expected internal event type to be preserved, got %q", event.Type()) + } +} + func TestRawSessionEventDataWithNilRawMarshalsAsNull(t *testing.T) { event := SessionEvent{ Data: &RawSessionEventData{EventType: "future.event"}, @@ -169,3 +189,69 @@ func TestRawSessionEventDataWithNilRawMarshalsAsNull(t *testing.T) { t.Fatalf("expected missing raw data to marshal as null, got %v", serialized["data"]) } } + +func TestManagedSettingsResolvedProvenanceRoundTrips(t *testing.T) { + sources := []ManagedSettingsResolvedSource{ + ManagedSettingsResolvedSourceServer, + ManagedSettingsResolvedSourceDevice, + ManagedSettingsResolvedSourceClient, + ManagedSettingsResolvedSourceMixed, + ManagedSettingsResolvedSourceNone, + } + expectedSources := []string{"server", "device", "client", "mixed", "none"} + for i, source := range sources { + if string(source) != expectedSources[i] { + t.Fatalf("expected source %q, got %q", expectedSources[i], source) + } + } + + clientManaged := true + resolved := SessionManagedSettingsResolvedData{ + BypassPermissionsDisabled: true, + ClientManaged: &clientManaged, + DeviceManaged: false, + FailClosed: false, + ManagedKeys: []string{"permissions"}, + ServerManaged: false, + Source: ManagedSettingsResolvedSourceClient, + } + data, err := json.Marshal(resolved) + if err != nil { + t.Fatalf("failed to marshal managed settings resolution: %v", err) + } + + var serialized map[string]any + if err := json.Unmarshal(data, &serialized); err != nil { + t.Fatalf("failed to inspect managed settings resolution: %v", err) + } + if serialized["source"] != "client" || serialized["clientManaged"] != true { + t.Fatalf("expected client provenance, got %v", serialized) + } + + var roundTripped SessionManagedSettingsResolvedData + if err := json.Unmarshal(data, &roundTripped); err != nil { + t.Fatalf("failed to round-trip managed settings resolution: %v", err) + } + if roundTripped.Source != ManagedSettingsResolvedSourceClient || + roundTripped.ClientManaged == nil || + !*roundTripped.ClientManaged { + t.Fatalf("expected client provenance to round-trip, got %#v", roundTripped) + } + + resolved.Source = ManagedSettingsResolvedSourceMixed + resolved.ClientManaged = nil + data, err = json.Marshal(resolved) + if err != nil { + t.Fatalf("failed to marshal mixed managed settings resolution: %v", err) + } + serialized = nil + if err := json.Unmarshal(data, &serialized); err != nil { + t.Fatalf("failed to inspect mixed managed settings resolution: %v", err) + } + if serialized["source"] != "mixed" { + t.Fatalf("expected mixed provenance, got %v", serialized["source"]) + } + if _, ok := serialized["clientManaged"]; ok { + t.Fatalf("expected absent clientManaged to be omitted, got %v", serialized) + } +} diff --git a/go/session_fs_provider.go b/go/session_fs_provider.go index 50922d7bc..0f653f1a0 100644 --- a/go/session_fs_provider.go +++ b/go/session_fs_provider.go @@ -12,12 +12,12 @@ import ( "github.com/github/copilot-sdk/go/rpc" ) -// SessionFsProvider is the interface that SDK users implement to provide +// SessionFSProvider is the interface that SDK users implement to provide // a session filesystem. Methods use idiomatic Go error handling: return an // error for failures (the adapter maps os.ErrNotExist → ENOENT automatically). // -// To add SQLite support, also implement [SessionFsSqliteProvider] on the same type. -type SessionFsProvider interface { +// To add SQLite support, also implement [SessionFSSqliteProvider] on the same type. +type SessionFSProvider interface { // ReadFile reads the full content of a file. Return os.ErrNotExist (or wrap it) // if the file does not exist. ReadFile(path string) (string, error) @@ -31,7 +31,7 @@ type SessionFsProvider interface { Exists(path string) (bool, error) // Stat returns metadata about a file or directory. // Return os.ErrNotExist if the path does not exist. - Stat(path string) (*SessionFsFileInfo, error) + Stat(path string) (*SessionFSFileInfo, error) // Mkdir creates a directory. If recursive is true, create parent directories as needed. // mode is an optional POSIX-style permission mode (e.g., 0o755). Pass nil to use the OS default. MakeDirectory(path string, recursive bool, mode *int) error @@ -40,7 +40,7 @@ type SessionFsProvider interface { ReadDirectory(path string) ([]string, error) // ReaddirWithTypes lists entries with type information. // Return os.ErrNotExist if the directory does not exist. - ReadDirectoryWithTypes(path string) ([]rpc.SessionFsReaddirWithTypesEntry, error) + ReadDirectoryWithTypes(path string) ([]rpc.SessionFSReaddirWithTypesEntry, error) // Rm removes a file or directory. If recursive is true, remove contents too. // If force is true, do not return an error when the path does not exist. Remove(path string, recursive bool, force bool) error @@ -48,32 +48,62 @@ type SessionFsProvider interface { Rename(src string, dest string) error } -// SessionFsSqliteProvider is an optional interface that a [SessionFsProvider] +// SessionFSSqliteProvider is an optional interface that a [SessionFSProvider] // may also implement to support per-session SQLite databases. The adapter // checks for this interface at runtime using a type assertion. If the // provider does not implement it, SQLite requests return an "unsupported" error. // // Providers are already session-scoped (created per session by the factory), // so these methods do not take a session ID parameter. -type SessionFsSqliteProvider interface { +type SessionFSSqliteProvider interface { // SqliteQuery executes a SQLite query against the provider's per-session database. - SqliteQuery(queryType rpc.SessionFsSqliteQueryType, query string, params map[string]any) (*SessionFsSqliteQueryResult, error) + SqliteQuery(queryType rpc.SessionFSSqliteQueryType, query string, params map[string]any) (*SessionFSSqliteQueryResult, error) // SqliteExists checks whether the provider has a SQLite database for the session. SqliteExists() (bool, error) } -// SessionFsSqliteQueryResult holds the result of a SQLite query execution. +// SessionFSSqliteTransactionProvider is an optional interface that a +// [SessionFSSqliteProvider] may also implement to support atomic transactions. +type SessionFSSqliteTransactionProvider interface { + // SqliteTransaction executes statements atomically against the provider's + // per-session database, applying busy handling to every statement and rolling + // the whole batch back if any statement fails. It returns one result per + // statement, in the same order. + // + // Return a [*SessionFSSqliteTransactionFailure] to classify the failure for + // the runtime; any other error is reported as + // [rpc.SessionFSSqliteTransactionErrorClassFatal]. + SqliteTransaction(statements []rpc.SessionFSSqliteTransactionStatement) ([]SessionFSSqliteQueryResult, error) +} + +// SessionFSSqliteTransactionFailure classifies a SQLite transaction failure for +// the runtime. Return it from [SessionFSSqliteTransactionProvider.SqliteTransaction] with +// [rpc.SessionFSSqliteTransactionErrorClassBusyOrLocked] when SQLite reported +// BUSY or LOCKED before commit and the transaction was rolled back, so the +// runtime knows the call is safe to retry. +type SessionFSSqliteTransactionFailure struct { + // Class is the failure classification reported to the runtime. + Class rpc.SessionFSSqliteTransactionErrorClass + // Message describes the failure. + Message string +} + +func (e *SessionFSSqliteTransactionFailure) Error() string { + return e.Message +} + +// SessionFSSqliteQueryResult holds the result of a SQLite query execution. // Same shape as the generated RPC type but without the Error field, // since providers signal errors by returning a Go error. -type SessionFsSqliteQueryResult struct { +type SessionFSSqliteQueryResult struct { Columns []string `json:"columns"` Rows []map[string]any `json:"rows"` RowsAffected int64 `json:"rowsAffected"` LastInsertRowid *int64 `json:"lastInsertRowid,omitempty"` } -// SessionFsFileInfo holds file metadata returned by SessionFsProvider.Stat. -type SessionFsFileInfo struct { +// SessionFSFileInfo holds file metadata returned by SessionFSProvider.Stat. +type SessionFSFileInfo struct { IsFile bool IsDirectory bool Size int64 @@ -81,62 +111,62 @@ type SessionFsFileInfo struct { Birthtime time.Time } -// sessionFsAdapter wraps a SessionFsProvider to implement rpc.SessionFsHandler, -// converting idiomatic Go errors into SessionFsError results. -type sessionFsAdapter struct { - provider SessionFsProvider +// sessionFSAdapter wraps a SessionFSProvider to implement rpc.SessionFSHandler, +// converting idiomatic Go errors into SessionFSError results. +type sessionFSAdapter struct { + provider SessionFSProvider } -func newSessionFsAdapter(provider SessionFsProvider) rpc.SessionFsHandler { - return &sessionFsAdapter{provider: provider} +func newSessionFSAdapter(provider SessionFSProvider) rpc.SessionFSHandler { + return &sessionFSAdapter{provider: provider} } -func (a *sessionFsAdapter) ReadFile(request *rpc.SessionFsReadFileRequest) (*rpc.SessionFsReadFileResult, error) { +func (a *sessionFSAdapter) ReadFile(request *rpc.SessionFSReadFileRequest) (*rpc.SessionFSReadFileResult, error) { content, err := a.provider.ReadFile(request.Path) if err != nil { - return &rpc.SessionFsReadFileResult{Error: toSessionFsError(err)}, nil + return &rpc.SessionFSReadFileResult{Error: toSessionFSError(err)}, nil } - return &rpc.SessionFsReadFileResult{Content: content}, nil + return &rpc.SessionFSReadFileResult{Content: content}, nil } -func (a *sessionFsAdapter) WriteFile(request *rpc.SessionFsWriteFileRequest) (*rpc.SessionFsError, error) { +func (a *sessionFSAdapter) WriteFile(request *rpc.SessionFSWriteFileRequest) (*rpc.SessionFSError, error) { var mode *int if request.Mode != nil { m := int(*request.Mode) mode = &m } if err := a.provider.WriteFile(request.Path, request.Content, mode); err != nil { - return toSessionFsError(err), nil + return toSessionFSError(err), nil } return nil, nil } -func (a *sessionFsAdapter) AppendFile(request *rpc.SessionFsAppendFileRequest) (*rpc.SessionFsError, error) { +func (a *sessionFSAdapter) AppendFile(request *rpc.SessionFSAppendFileRequest) (*rpc.SessionFSError, error) { var mode *int if request.Mode != nil { m := int(*request.Mode) mode = &m } if err := a.provider.AppendFile(request.Path, request.Content, mode); err != nil { - return toSessionFsError(err), nil + return toSessionFSError(err), nil } return nil, nil } -func (a *sessionFsAdapter) Exists(request *rpc.SessionFsExistsRequest) (*rpc.SessionFsExistsResult, error) { +func (a *sessionFSAdapter) Exists(request *rpc.SessionFSExistsRequest) (*rpc.SessionFSExistsResult, error) { exists, err := a.provider.Exists(request.Path) if err != nil { - return &rpc.SessionFsExistsResult{Exists: false}, nil + return &rpc.SessionFSExistsResult{Exists: false}, nil } - return &rpc.SessionFsExistsResult{Exists: exists}, nil + return &rpc.SessionFSExistsResult{Exists: exists}, nil } -func (a *sessionFsAdapter) Stat(request *rpc.SessionFsStatRequest) (*rpc.SessionFsStatResult, error) { +func (a *sessionFSAdapter) Stat(request *rpc.SessionFSStatRequest) (*rpc.SessionFSStatResult, error) { info, err := a.provider.Stat(request.Path) if err != nil { - return &rpc.SessionFsStatResult{Error: toSessionFsError(err)}, nil + return &rpc.SessionFSStatResult{Error: toSessionFSError(err)}, nil } - return &rpc.SessionFsStatResult{ + return &rpc.SessionFSStatResult{ IsFile: info.IsFile, IsDirectory: info.IsDirectory, Size: info.Size, @@ -145,7 +175,7 @@ func (a *sessionFsAdapter) Stat(request *rpc.SessionFsStatRequest) (*rpc.Session }, nil } -func (a *sessionFsAdapter) Mkdir(request *rpc.SessionFsMkdirRequest) (*rpc.SessionFsError, error) { +func (a *sessionFSAdapter) Mkdir(request *rpc.SessionFSMkdirRequest) (*rpc.SessionFSError, error) { recursive := request.Recursive != nil && *request.Recursive var mode *int if request.Mode != nil { @@ -153,100 +183,147 @@ func (a *sessionFsAdapter) Mkdir(request *rpc.SessionFsMkdirRequest) (*rpc.Sessi mode = &m } if err := a.provider.MakeDirectory(request.Path, recursive, mode); err != nil { - return toSessionFsError(err), nil + return toSessionFSError(err), nil } return nil, nil } -func (a *sessionFsAdapter) Readdir(request *rpc.SessionFsReaddirRequest) (*rpc.SessionFsReaddirResult, error) { +func (a *sessionFSAdapter) Readdir(request *rpc.SessionFSReaddirRequest) (*rpc.SessionFSReaddirResult, error) { entries, err := a.provider.ReadDirectory(request.Path) if err != nil { - return &rpc.SessionFsReaddirResult{Error: toSessionFsError(err)}, nil + return &rpc.SessionFSReaddirResult{Error: toSessionFSError(err)}, nil } - return &rpc.SessionFsReaddirResult{Entries: entries}, nil + return &rpc.SessionFSReaddirResult{Entries: entries}, nil } -func (a *sessionFsAdapter) ReaddirWithTypes(request *rpc.SessionFsReaddirWithTypesRequest) (*rpc.SessionFsReaddirWithTypesResult, error) { +func (a *sessionFSAdapter) ReaddirWithTypes(request *rpc.SessionFSReaddirWithTypesRequest) (*rpc.SessionFSReaddirWithTypesResult, error) { entries, err := a.provider.ReadDirectoryWithTypes(request.Path) if err != nil { - return &rpc.SessionFsReaddirWithTypesResult{Error: toSessionFsError(err)}, nil + return &rpc.SessionFSReaddirWithTypesResult{Error: toSessionFSError(err)}, nil } - return &rpc.SessionFsReaddirWithTypesResult{Entries: entries}, nil + return &rpc.SessionFSReaddirWithTypesResult{Entries: entries}, nil } -func (a *sessionFsAdapter) Rm(request *rpc.SessionFsRmRequest) (*rpc.SessionFsError, error) { +func (a *sessionFSAdapter) Rm(request *rpc.SessionFSRmRequest) (*rpc.SessionFSError, error) { recursive := request.Recursive != nil && *request.Recursive force := request.Force != nil && *request.Force if err := a.provider.Remove(request.Path, recursive, force); err != nil { - return toSessionFsError(err), nil + return toSessionFSError(err), nil } return nil, nil } -func (a *sessionFsAdapter) Rename(request *rpc.SessionFsRenameRequest) (*rpc.SessionFsError, error) { +func (a *sessionFSAdapter) Rename(request *rpc.SessionFSRenameRequest) (*rpc.SessionFSError, error) { if err := a.provider.Rename(request.Src, request.Dest); err != nil { - return toSessionFsError(err), nil + return toSessionFSError(err), nil } return nil, nil } -func (a *sessionFsAdapter) SqliteQuery(request *rpc.SessionFsSqliteQueryRequest) (*rpc.SessionFsSqliteQueryResult, error) { - sp, ok := a.provider.(SessionFsSqliteProvider) +func (a *sessionFSAdapter) SqliteQuery(request *rpc.SessionFSSqliteQueryRequest) (*rpc.SessionFSSqliteQueryResult, error) { + sp, ok := a.provider.(SessionFSSqliteProvider) if !ok { msg := "SQLite is not supported by this session filesystem provider" - return &rpc.SessionFsSqliteQueryResult{ + return &rpc.SessionFSSqliteQueryResult{ Columns: []string{}, Rows: []map[string]any{}, RowsAffected: 0, - Error: &rpc.SessionFsError{Code: rpc.SessionFsErrorCodeUNKNOWN, Message: &msg}, + Error: &rpc.SessionFSError{Code: rpc.SessionFSErrorCodeUNKNOWN, Message: &msg}, }, nil } result, err := sp.SqliteQuery(request.QueryType, request.Query, request.Params) if err != nil { - return &rpc.SessionFsSqliteQueryResult{ + return &rpc.SessionFSSqliteQueryResult{ Columns: []string{}, Rows: []map[string]any{}, RowsAffected: 0, - Error: toSessionFsError(err), + Error: toSessionFSError(err), }, nil } if result == nil { - return &rpc.SessionFsSqliteQueryResult{ + return &rpc.SessionFSSqliteQueryResult{ Columns: []string{}, Rows: []map[string]any{}, RowsAffected: 0, }, nil } - var wireRowid *int64 - if result.LastInsertRowid != nil { - rowid := *result.LastInsertRowid - wireRowid = &rowid + wireResult := toWireSqliteQueryResult(*result) + return &wireResult, nil +} + +func (a *sessionFSAdapter) SqliteTransaction(request *rpc.SessionFSSqliteTransactionRequest) (*rpc.SessionFSSqliteTransactionResult, error) { + sp, ok := a.provider.(SessionFSSqliteTransactionProvider) + if !ok { + return &rpc.SessionFSSqliteTransactionResult{ + Results: []rpc.SessionFSSqliteQueryResult{}, + Error: &rpc.SessionFSSqliteTransactionError{ + ErrorClass: rpc.SessionFSSqliteTransactionErrorClassFatal, + Message: "SQLite is not supported by this session filesystem provider", + }, + }, nil + } + results, err := sp.SqliteTransaction(request.Statements) + if err != nil { + return &rpc.SessionFSSqliteTransactionResult{ + Results: []rpc.SessionFSSqliteQueryResult{}, + Error: toSessionFSSqliteTransactionError(err), + }, nil + } + wireResults := make([]rpc.SessionFSSqliteQueryResult, 0, len(results)) + for _, result := range results { + wireResults = append(wireResults, toWireSqliteQueryResult(result)) + } + return &rpc.SessionFSSqliteTransactionResult{Results: wireResults}, nil +} + +func toWireSqliteQueryResult(result SessionFSSqliteQueryResult) rpc.SessionFSSqliteQueryResult { + columns := result.Columns + if columns == nil { + columns = []string{} + } + rows := result.Rows + if rows == nil { + rows = []map[string]any{} } - return &rpc.SessionFsSqliteQueryResult{ - Columns: result.Columns, - Rows: result.Rows, + return rpc.SessionFSSqliteQueryResult{ + Columns: columns, + Rows: rows, RowsAffected: result.RowsAffected, - LastInsertRowid: wireRowid, - }, nil + LastInsertRowid: result.LastInsertRowid, + } } -func (a *sessionFsAdapter) SqliteExists(request *rpc.SessionFsSqliteExistsRequest) (*rpc.SessionFsSqliteExistsResult, error) { - sp, ok := a.provider.(SessionFsSqliteProvider) +func (a *sessionFSAdapter) SqliteExists(request *rpc.SessionFSSqliteExistsRequest) (*rpc.SessionFSSqliteExistsResult, error) { + sp, ok := a.provider.(SessionFSSqliteProvider) if !ok { - return &rpc.SessionFsSqliteExistsResult{Exists: false}, nil + return &rpc.SessionFSSqliteExistsResult{Exists: false}, nil } exists, err := sp.SqliteExists() if err != nil { - return &rpc.SessionFsSqliteExistsResult{Exists: false}, nil + return &rpc.SessionFSSqliteExistsResult{Exists: false}, nil } - return &rpc.SessionFsSqliteExistsResult{Exists: exists}, nil + return &rpc.SessionFSSqliteExistsResult{Exists: exists}, nil } -func toSessionFsError(err error) *rpc.SessionFsError { - code := rpc.SessionFsErrorCodeUNKNOWN +func toSessionFSError(err error) *rpc.SessionFSError { + code := rpc.SessionFSErrorCodeUNKNOWN if errors.Is(err, os.ErrNotExist) { - code = rpc.SessionFsErrorCodeENOENT + code = rpc.SessionFSErrorCodeENOENT } msg := err.Error() - return &rpc.SessionFsError{Code: code, Message: &msg} + return &rpc.SessionFSError{Code: code, Message: &msg} +} + +func toSessionFSSqliteTransactionError(err error) *rpc.SessionFSSqliteTransactionError { + var failure *SessionFSSqliteTransactionFailure + if errors.As(err, &failure) { + return &rpc.SessionFSSqliteTransactionError{ + ErrorClass: failure.Class, + Message: failure.Message, + } + } + return &rpc.SessionFSSqliteTransactionError{ + ErrorClass: rpc.SessionFSSqliteTransactionErrorClassFatal, + Message: err.Error(), + } } diff --git a/go/session_test.go b/go/session_test.go index 405d7bf7c..9c5f4df8c 100644 --- a/go/session_test.go +++ b/go/session_test.go @@ -1,13 +1,20 @@ package copilot import ( + "bufio" + "context" "encoding/json" "fmt" + "io" + "strconv" "strings" "sync" "sync/atomic" "testing" "time" + + "github.com/github/copilot-sdk/go/internal/jsonrpc2" + "github.com/github/copilot-sdk/go/rpc" ) // newTestSession creates a session with an event channel and starts the consumer goroutine. @@ -30,6 +37,335 @@ func ptr[T any](value T) *T { return &value } +func TestSession_SetModelForwardsContextTier(t *testing.T) { + tier := ContextTierLongContext + params := captureSetModelRequest(t, &SetModelOptions{ContextTier: &tier}) + + if params["sessionId"] != "session-1" { + t.Fatalf("expected sessionId session-1, got %v", params["sessionId"]) + } + if params["modelId"] != "gpt-4.1" { + t.Fatalf("expected modelId gpt-4.1, got %v", params["modelId"]) + } + if params["contextTier"] != "long_context" { + t.Fatalf("expected contextTier long_context, got %v", params["contextTier"]) + } +} + +func TestSession_SetModelOmitsContextTierWhenUnset(t *testing.T) { + params := captureSetModelRequest(t, nil) + + if _, ok := params["contextTier"]; ok { + t.Fatalf("expected contextTier to be omitted, got %v", params["contextTier"]) + } +} + +func TestSession_MCPAuthRequestSendsHostToken(t *testing.T) { + stdinR, stdinW := io.Pipe() + stdoutR, stdoutW := io.Pipe() + defer stdinR.Close() + defer stdinW.Close() + defer stdoutR.Close() + defer stdoutW.Close() + + client := jsonrpc2.NewClient(stdinW, stdoutR) + client.Start() + defer client.Stop() + + paramsCh := make(chan map[string]any, 1) + errCh := make(chan error, 1) + + go func() { + frame, err := readTestJSONRPCFrame(stdinR) + if err != nil { + errCh <- err + return + } + + var request struct { + ID json.RawMessage `json:"id"` + Method string `json:"method"` + Params map[string]any `json:"params"` + } + if err := json.Unmarshal(frame, &request); err != nil { + errCh <- err + return + } + if request.Method != "session.mcp.oauth.handlePendingRequest" { + errCh <- fmt.Errorf("expected session.mcp.oauth.handlePendingRequest, got %s", request.Method) + return + } + + paramsCh <- request.Params + + response := map[string]any{ + "jsonrpc": "2.0", + "id": json.RawMessage(request.ID), + "result": map[string]any{"success": true}, + } + data, err := json.Marshal(response) + if err != nil { + errCh <- err + return + } + if _, err := fmt.Fprintf(stdoutW, "Content-Length: %d\r\n\r\n%s", len(data), data); err != nil { + errCh <- err + } + }() + + session := &Session{ + SessionID: "session-1", + client: client, + RPC: rpc.NewSessionRPC(client, "session-1"), + } + var observedRequest MCPAuthRequest + session.registerMCPAuthHandler(func(request MCPAuthRequest, invocation MCPAuthInvocation) (*MCPAuthResult, error) { + observedRequest = request + if invocation.SessionID != "session-1" { + t.Fatalf("expected invocation session-1, got %s", invocation.SessionID) + } + if request.RequestID != "oauth-request" { + t.Fatalf("expected oauth-request, got %s", request.RequestID) + } + tokenType := "Bearer" + return MCPAuthResultToken(&MCPAuthToken{ + AccessToken: "host-token", + TokenType: &tokenType, + }), nil + }) + resourceMetadataURL := "https://example.com/.well-known/oauth-protected-resource" + resourceMetadata := `{"resource":"https://example.com/mcp"}` + clientSecret := "static-secret" + grantType := rpc.MCPOauthRequiredStaticClientConfigGrantTypeClientCredentials + publicClient := false + session.handleBroadcastEvent(SessionEvent{ + Data: &MCPOauthRequiredData{ + RequestID: "oauth-request", + Reason: rpc.MCPOauthRequestReasonInitial, + ServerName: "oauth-server", + ServerURL: "https://example.com/mcp", + ResourceMetadata: &resourceMetadata, + StaticClientConfig: &MCPOauthRequiredStaticClientConfig{ + ClientID: "static-client", + ClientSecret: &clientSecret, + GrantType: &grantType, + PublicClient: &publicClient, + }, + WwwAuthenticateParams: &MCPOauthWwwAuthenticateParams{ + ResourceMetadataURL: &resourceMetadataURL, + }, + }, + }) + if observedRequest.ResourceMetadata == nil || *observedRequest.ResourceMetadata != `{"resource":"https://example.com/mcp"}` { + t.Fatalf("expected resource metadata to be propagated, got %#v", observedRequest.ResourceMetadata) + } + if observedRequest.Reason != MCPOauthRequestReasonInitial { + t.Fatalf("expected initial reason, got %q", observedRequest.Reason) + } + if observedRequest.WwwAuthenticateParams == nil { + t.Fatal("expected WWW-Authenticate params to be propagated") + } + if observedRequest.StaticClientConfig == nil { + t.Fatal("expected static client config to be propagated") + } + if observedRequest.StaticClientConfig.ClientSecret == nil || *observedRequest.StaticClientConfig.ClientSecret != "static-secret" { + t.Fatalf("expected static client secret to be propagated, got %#v", observedRequest.StaticClientConfig.ClientSecret) + } + if observedRequest.StaticClientConfig.GrantType == nil || *observedRequest.StaticClientConfig.GrantType != "client_credentials" { + t.Fatalf("expected static client grant type to be propagated, got %#v", observedRequest.StaticClientConfig.GrantType) + } + + select { + case params := <-paramsCh: + if params["sessionId"] != "session-1" { + t.Fatalf("expected sessionId session-1, got %v", params["sessionId"]) + } + if params["requestId"] != "oauth-request" { + t.Fatalf("expected requestId oauth-request, got %v", params["requestId"]) + } + result, ok := params["result"].(map[string]any) + if !ok { + t.Fatalf("expected result object, got %T", params["result"]) + } + if result["kind"] != "token" { + t.Fatalf("expected token kind, got %v", result["kind"]) + } + if result["accessToken"] != "host-token" { + t.Fatalf("expected accessToken host-token, got %v", result["accessToken"]) + } + if result["tokenType"] != "Bearer" { + t.Fatalf("expected tokenType Bearer, got %v", result["tokenType"]) + } + case err := <-errCh: + t.Fatal(err) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for MCP OAuth request") + } +} + +func TestMCPAuthRequestAllowsMissingOptionalMetadata(t *testing.T) { + request := MCPAuthRequest{RequestID: "oauth-request"} + if request.ResourceMetadata != nil { + t.Fatalf("expected no resource metadata, got %#v", request.ResourceMetadata) + } + if request.WwwAuthenticateParams != nil { + t.Fatalf("expected no WWW-Authenticate params, got %#v", request.WwwAuthenticateParams) + } +} + +func TestMCPOauthRequiredDataAllowsOptionalMetadata(t *testing.T) { + var withMetadata rpc.MCPOauthRequiredData + if err := json.Unmarshal([]byte(`{ + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp", + "wwwAuthenticateParams": { + "resourceMetadataUrl": "https://example.com/.well-known/oauth-protected-resource" + }, + "resourceMetadata": "{\"resource\":\"https://example.com/mcp\"}", + "staticClientConfig": { + "clientId": "static-client", + "clientSecret": "static-secret", + "publicClient": false + } + }`), &withMetadata); err != nil { + t.Fatal(err) + } + if withMetadata.ResourceMetadata == nil || *withMetadata.ResourceMetadata != `{"resource":"https://example.com/mcp"}` { + t.Fatalf("expected resource metadata, got %#v", withMetadata.ResourceMetadata) + } + if withMetadata.WwwAuthenticateParams == nil { + t.Fatal("expected WWW-Authenticate params") + } + if withMetadata.StaticClientConfig == nil || withMetadata.StaticClientConfig.ClientSecret == nil || *withMetadata.StaticClientConfig.ClientSecret != "static-secret" { + t.Fatalf("expected static client secret, got %#v", withMetadata.StaticClientConfig) + } + + var withoutMetadata rpc.MCPOauthRequiredData + if err := json.Unmarshal([]byte(`{ + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp" + }`), &withoutMetadata); err != nil { + t.Fatal(err) + } + if withoutMetadata.ResourceMetadata != nil { + t.Fatalf("expected no resource metadata, got %#v", withoutMetadata.ResourceMetadata) + } + if withoutMetadata.WwwAuthenticateParams != nil { + t.Fatalf("expected no WWW-Authenticate params, got %#v", withoutMetadata.WwwAuthenticateParams) + } +} + +func captureSetModelRequest(t *testing.T, opts *SetModelOptions) map[string]any { + t.Helper() + + stdinR, stdinW := io.Pipe() + stdoutR, stdoutW := io.Pipe() + defer stdinR.Close() + defer stdinW.Close() + defer stdoutR.Close() + defer stdoutW.Close() + + client := jsonrpc2.NewClient(stdinW, stdoutR) + client.Start() + defer client.Stop() + + paramsCh := make(chan map[string]any, 1) + errCh := make(chan error, 1) + + go func() { + frame, err := readTestJSONRPCFrame(stdinR) + if err != nil { + errCh <- err + return + } + + var request struct { + ID json.RawMessage `json:"id"` + Method string `json:"method"` + Params map[string]any `json:"params"` + } + if err := json.Unmarshal(frame, &request); err != nil { + errCh <- err + return + } + if request.Method != "session.model.switchTo" { + errCh <- fmt.Errorf("expected session.model.switchTo, got %s", request.Method) + return + } + + paramsCh <- request.Params + + response := map[string]any{ + "jsonrpc": "2.0", + "id": json.RawMessage(request.ID), + "result": map[string]any{}, + } + data, err := json.Marshal(response) + if err != nil { + errCh <- err + return + } + if _, err := fmt.Fprintf(stdoutW, "Content-Length: %d\r\n\r\n%s", len(data), data); err != nil { + errCh <- err + return + } + }() + + session := &Session{ + SessionID: "session-1", + client: client, + RPC: rpc.NewSessionRPC(client, "session-1"), + } + if err := session.SetModel(context.Background(), "gpt-4.1", opts); err != nil { + t.Fatalf("SetModel failed: %v", err) + } + + select { + case params := <-paramsCh: + return params + case err := <-errCh: + t.Fatal(err) + case <-time.After(2 * time.Second): + t.Fatal("timed out waiting for session.model.switchTo request") + } + return nil +} + +func readTestJSONRPCFrame(r io.Reader) ([]byte, error) { + reader := bufio.NewReader(r) + var contentLength int + for { + line, err := reader.ReadString('\n') + if err != nil { + return nil, err + } + line = strings.TrimSpace(line) + if line == "" { + break + } + name, value, ok := strings.Cut(line, ":") + if !ok { + return nil, fmt.Errorf("invalid header line %q", line) + } + if name == "Content-Length" { + contentLength, err = strconv.Atoi(strings.TrimSpace(value)) + if err != nil { + return nil, err + } + } + } + if contentLength == 0 { + return nil, fmt.Errorf("missing Content-Length header") + } + data := make([]byte, contentLength) + _, err := io.ReadFull(reader, data) + return data, err +} + func TestSession_On(t *testing.T) { t.Run("multiple handlers all receive events", func(t *testing.T) { session, cleanup := newTestSession() @@ -446,9 +782,8 @@ func TestSession_Capabilities(t *testing.T) { session.dispatchEvent(SessionEvent{ Data: &SessionCanvasOpenedData{ - InstanceID: "missing-canvas-id", - ExtensionID: "project:counter", - Availability: CanvasOpenedAvailabilityReady, + InstanceID: "missing-canvas-id", + ExtensionID: "project:counter", }, }) session.dispatchEvent(SessionEvent{ @@ -458,21 +793,18 @@ func TestSession_Capabilities(t *testing.T) { CanvasID: "counter", InstanceID: "counter-1", Title: ptr("Counter"), + Icon: ptr("beaker"), Status: ptr("ready"), URL: ptr("https://example.test/counter"), Input: map[string]any{"seed": float64(1)}, - Reopen: false, - Availability: CanvasOpenedAvailabilityReady, }, }) session.dispatchEvent(SessionEvent{ Data: &SessionCanvasOpenedData{ - ExtensionID: "project:logs", - CanvasID: "logs", - InstanceID: "logs-1", - Title: ptr("Logs"), - Reopen: false, - Availability: CanvasOpenedAvailabilityStale, + ExtensionID: "project:logs", + CanvasID: "logs", + InstanceID: "logs-1", + Title: ptr("Logs"), }, }) @@ -491,11 +823,10 @@ func TestSession_Capabilities(t *testing.T) { CanvasID: "counter", InstanceID: "counter-1", Title: ptr("Counter Updated"), + Icon: ptr("beaker-filled"), Status: ptr("reconnected"), URL: ptr("https://example.test/counter-updated"), Input: map[string]any{"seed": float64(2)}, - Reopen: true, - Availability: CanvasOpenedAvailabilityStale, }, }) @@ -509,17 +840,78 @@ func TestSession_Capabilities(t *testing.T) { if open[0].Title == nil || *open[0].Title != "Counter Updated" { t.Fatalf("expected updated title, got %+v", open[0].Title) } + if open[0].Icon == nil || *open[0].Icon != "beaker-filled" { + t.Fatalf("expected updated icon, got %+v", open[0].Icon) + } if open[0].Status == nil || *open[0].Status != "reconnected" { t.Fatalf("expected updated status, got %+v", open[0].Status) } if open[0].URL == nil || *open[0].URL != "https://example.test/counter-updated" { t.Fatalf("expected updated URL, got %+v", open[0].URL) } - if !open[0].Reopen { - t.Fatal("expected reopen to be true") + }) + + t.Run("session.canvas.closed event removes open canvas snapshots", func(t *testing.T) { + session, cleanup := newTestSession() + defer cleanup() + + session.dispatchEvent(SessionEvent{ + Data: &SessionCanvasOpenedData{ + ExtensionID: "project:counter", + CanvasID: "counter", + InstanceID: "counter-1", + Title: ptr("Counter"), + }, + }) + session.dispatchEvent(SessionEvent{ + Data: &SessionCanvasOpenedData{ + ExtensionID: "project:logs", + CanvasID: "logs", + InstanceID: "logs-1", + Title: ptr("Logs"), + }, + }) + + if open := session.OpenCanvases(); len(open) != 2 { + t.Fatalf("expected 2 open canvases, got %d", len(open)) + } + + // Closing one instance removes it; the other remains. + session.dispatchEvent(SessionEvent{ + Data: &SessionCanvasClosedData{ + ExtensionID: "project:counter", + CanvasID: "counter", + InstanceID: "counter-1", + }, + }) + open := session.OpenCanvases() + if len(open) != 1 || open[0].InstanceID != "logs-1" { + t.Fatalf("expected only logs-1 to remain, got %+v", open) + } + + // Closing an absent instance is a no-op (idempotent). + session.dispatchEvent(SessionEvent{ + Data: &SessionCanvasClosedData{ + ExtensionID: "project:counter", + CanvasID: "counter", + InstanceID: "counter-1", + }, + }) + open = session.OpenCanvases() + if len(open) != 1 || open[0].InstanceID != "logs-1" { + t.Fatalf("idempotent close should leave logs-1, got %+v", open) } - if string(open[0].Availability) != string(CanvasOpenedAvailabilityStale) { - t.Fatalf("expected stale availability, got %q", open[0].Availability) + + // A closed event missing instanceID leaves the snapshot intact. + session.dispatchEvent(SessionEvent{ + Data: &SessionCanvasClosedData{ + ExtensionID: "project:logs", + CanvasID: "logs", + }, + }) + open = session.OpenCanvases() + if len(open) != 1 || open[0].InstanceID != "logs-1" { + t.Fatalf("invalid close should leave logs-1, got %+v", open) } }) } @@ -581,7 +973,7 @@ func TestSession_ElicitationHandler(t *testing.T) { } session.registerElicitationHandler(func(ctx ElicitationContext) (ElicitationResult, error) { - return ElicitationResult{Action: "accept"}, nil + return ElicitationResult{Action: ElicitationActionAccept}, nil }) if session.getElicitationHandler() == nil { @@ -619,7 +1011,7 @@ func TestSession_ElicitationHandler(t *testing.T) { session.registerElicitationHandler(func(ctx ElicitationContext) (ElicitationResult, error) { return ElicitationResult{ - Action: "accept", + Action: ElicitationActionAccept, Content: map[string]any{"color": "blue"}, }, nil }) @@ -631,7 +1023,7 @@ func TestSession_ElicitationHandler(t *testing.T) { if err != nil { t.Fatalf("Expected no error, got %v", err) } - if result.Action != "accept" { + if result.Action != ElicitationActionAccept { t.Errorf("Expected action 'accept', got %q", result.Action) } if result.Content["color"] != "blue" { @@ -706,6 +1098,63 @@ func TestSession_PostToolUseFailureHook(t *testing.T) { }) } +func TestSession_AgentStopHook(t *testing.T) { + session, cleanup := newTestSession() + defer cleanup() + + var captured AgentStopHookInput + session.registerHooks(&SessionHooks{ + OnAgentStop: func(input AgentStopHookInput, invocation HookInvocation) (*AgentStopHookOutput, error) { + captured = input + if invocation.SessionID != session.SessionID { + t.Errorf("expected invocation session ID %q, got %q", session.SessionID, invocation.SessionID) + } + return &AgentStopHookOutput{ + Decision: "block", + Reason: "finish the remaining work", + }, nil + }, + }) + + raw := json.RawMessage(`{ + "sessionId": "sess-1", + "timestamp": 1700000000, + "cwd": "/work", + "stopReason": "end_turn", + "transcriptPath": "/tmp/transcript.jsonl", + "stop_hook_active": true + }`) + output, err := session.handleHooksInvoke("agentStop", raw) + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + if captured.SessionID != "sess-1" { + t.Errorf("expected sessionId 'sess-1', got %q", captured.SessionID) + } + if captured.StopReason != "end_turn" { + t.Errorf("expected stopReason 'end_turn', got %q", captured.StopReason) + } + if captured.TranscriptPath != "/tmp/transcript.jsonl" { + t.Errorf("expected transcriptPath '/tmp/transcript.jsonl', got %q", captured.TranscriptPath) + } + if !captured.StopHookActive { + t.Error("expected StopHookActive to be true") + } + if !captured.Timestamp.Equal(time.UnixMilli(1700000000)) { + t.Errorf("expected timestamp %v, got %v", time.UnixMilli(1700000000), captured.Timestamp) + } + if captured.WorkingDirectory != "/work" { + t.Errorf("expected WorkingDirectory '/work', got %q", captured.WorkingDirectory) + } + out, ok := output.(*AgentStopHookOutput) + if !ok { + t.Fatalf("expected *AgentStopHookOutput, got %T", output) + } + if out.Decision != "block" || out.Reason != "finish the remaining work" { + t.Errorf("unexpected output: %#v", out) + } +} + func TestSession_HookForwardCompatibility(t *testing.T) { t.Run("unknown hook type returns nil without error when known hooks are registered", func(t *testing.T) { session, cleanup := newTestSession() @@ -746,6 +1195,16 @@ func TestSession_HookForwardCompatibility(t *testing.T) { } func TestSession_ElicitationRequestSchema(t *testing.T) { + t.Run("nil content values are allowed", func(t *testing.T) { + value, err := toRPCContent(nil) + if err != nil { + t.Fatalf("Expected nil content to be accepted, got %v", err) + } + if value != nil { + t.Fatalf("Expected nil RPC content, got %T", value) + } + }) + t.Run("elicitation.requested passes full schema to handler", func(t *testing.T) { // Verify the schema extraction logic from handleBroadcastEvent // preserves type, properties, and required. @@ -755,28 +1214,20 @@ func TestSession_ElicitationRequestSchema(t *testing.T) { } required := []string{"name", "age"} - // Replicate the schema extraction logic from handleBroadcastEvent - requestedSchema := map[string]any{ - "type": "object", - "properties": properties, - } - if len(required) > 0 { - requestedSchema["required"] = required + requestedSchema := ElicitationSchema{ + Properties: properties, + Required: required, } - if requestedSchema["type"] != "object" { - t.Errorf("Expected schema type 'object', got %v", requestedSchema["type"]) - } - props, ok := requestedSchema["properties"].(map[string]any) - if !ok || props == nil { + props := requestedSchema.Properties + if props == nil { t.Fatal("Expected schema properties map") } if len(props) != 2 { t.Errorf("Expected 2 properties, got %d", len(props)) } - req, ok := requestedSchema["required"].([]string) - if !ok || len(req) != 2 { - t.Errorf("Expected required [name, age], got %v", requestedSchema["required"]) + if len(requestedSchema.Required) != 2 { + t.Errorf("Expected required [name, age], got %v", requestedSchema.Required) } }) @@ -785,18 +1236,44 @@ func TestSession_ElicitationRequestSchema(t *testing.T) { "optional_field": map[string]any{"type": "string"}, } - requestedSchema := map[string]any{ - "type": "object", - "properties": properties, + requestedSchema := ElicitationSchema{ + Properties: properties, } - // Simulate: if len(schema.Required) > 0 { ... } — with empty required - var required []string - if len(required) > 0 { - requestedSchema["required"] = required + + if requestedSchema.Required != nil { + t.Error("Expected Required to be nil when omitted") } + }) - if _, exists := requestedSchema["required"]; exists { - t.Error("Expected no 'required' key when Required is empty") + t.Run("schema conversion adds object type", func(t *testing.T) { + requestedSchema := ElicitationSchema{ + Properties: map[string]any{ + "name": map[string]any{"type": "string"}, + }, + } + + rpcSchema, err := toRPCUIElicitationSchema(requestedSchema) + if err != nil { + t.Fatalf("toRPCUIElicitationSchema failed: %v", err) + } + if rpcSchema.Type != rpc.UIElicitationSchemaTypeObject { + t.Errorf("Expected RPC schema type object, got %q", rpcSchema.Type) + } + if _, ok := rpcSchema.Properties["name"].(*rpc.UIElicitationSchemaPropertyString); !ok { + t.Fatalf("Expected name property to decode as string schema, got %T", rpcSchema.Properties["name"]) + } + }) + + t.Run("schema conversion preserves typed properties", func(t *testing.T) { + property := &rpc.UIElicitationSchemaPropertyString{} + rpcSchema, err := toRPCUIElicitationSchema(ElicitationSchema{ + Properties: map[string]any{"name": property}, + }) + if err != nil { + t.Fatalf("toRPCUIElicitationSchema failed: %v", err) + } + if rpcSchema.Properties["name"] != property { + t.Fatalf("Expected typed property to be preserved, got %T", rpcSchema.Properties["name"]) } }) } diff --git a/go/test.sh b/go/test.sh index 15fc35c30..dfb7bac1d 100755 --- a/go/test.sh +++ b/go/test.sh @@ -15,10 +15,12 @@ fi # Determine COPILOT_CLI_PATH if [ -z "$COPILOT_CLI_PATH" ]; then - # Try to find it relative to the SDK + # Try to find it relative to the SDK. As of CLI 1.0.64-1 the @github/copilot + # package is a thin loader; the runnable index.js ships in the installed + # platform package (e.g. @github/copilot-linux-x64). Exactly one is installed. SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" - POTENTIAL_PATH="$SCRIPT_DIR/../nodejs/node_modules/@github/copilot/index.js" - if [ -f "$POTENTIAL_PATH" ]; then + POTENTIAL_PATH="$(ls "$SCRIPT_DIR"/../nodejs/node_modules/@github/copilot-*/index.js 2>/dev/null | head -n1)" + if [ -n "$POTENTIAL_PATH" ] && [ -f "$POTENTIAL_PATH" ]; then export COPILOT_CLI_PATH="$POTENTIAL_PATH" echo "📍 Auto-detected CLI path: $COPILOT_CLI_PATH" else diff --git a/go/toolset.go b/go/toolset.go index c64e8b7fd..f9b60eccf 100644 --- a/go/toolset.go +++ b/go/toolset.go @@ -69,9 +69,9 @@ func (s *ToolSet) AddCustom(name string) *ToolSet { return s } -// AddMcp adds an MCP tool pattern. Matches tools advertised by any configured +// AddMCP adds an MCP tool pattern. Matches tools advertised by any configured // MCP server. -func (s *ToolSet) AddMcp(toolName string) *ToolSet { +func (s *ToolSet) AddMCP(toolName string) *ToolSet { validateToolName("mcp", toolName) s.items = append(s.items, "mcp:"+toolName) return s diff --git a/go/toolset_test.go b/go/toolset_test.go index babe63502..270d5b757 100644 --- a/go/toolset_test.go +++ b/go/toolset_test.go @@ -17,8 +17,8 @@ func TestToolSet_emitsSourceQualifiedStrings(t *testing.T) { AddBuiltIn("*"). AddCustom("my_tool"). AddCustom("*"). - AddMcp("github-list_issues"). - AddMcp("*"). + AddMCP("github-list_issues"). + AddMCP("*"). ToSlice() want := []string{ "builtin:bash", @@ -56,7 +56,7 @@ func TestToolSet_rejectsInvalidNames(t *testing.T) { fn func() }{ {"colon in builtin", func() { NewToolSet().AddBuiltIn("has:colon") }}, - {"space in mcp", func() { NewToolSet().AddMcp("has space") }}, + {"space in mcp", func() { NewToolSet().AddMCP("has space") }}, {"empty custom", func() { NewToolSet().AddCustom("") }}, } for _, c := range cases { @@ -111,10 +111,10 @@ func TestNewClient_modeEmptyAcceptsBaseDirectory(t *testing.T) { } } -func TestNewClient_modeEmptyAcceptsUriConnection(t *testing.T) { +func TestNewClient_modeEmptyAcceptsURIConnection(t *testing.T) { c := NewClient(&ClientOptions{ Mode: ModeEmpty, - Connection: UriConnection{URL: "8080"}, + Connection: URIConnection{URL: "8080"}, }) if c.options.Mode != ModeEmpty { t.Errorf("expected ModeEmpty, got %q", c.options.Mode) @@ -229,6 +229,24 @@ func TestApplyConfigDefaultsForMode_emptyDefaultsTelemetryFalse(t *testing.T) { } } +func TestApplyConfigDefaultsForMode_emptyDefaultsExperimentalModeFalse(t *testing.T) { + c := NewClient(&ClientOptions{Mode: ModeEmpty, BaseDirectory: t.TempDir()}) + cfg := &SessionConfig{} + c.applyConfigDefaultsForMode(cfg) + if cfg.EnableExperimentalMode == nil || *cfg.EnableExperimentalMode != false { + t.Errorf("expected experimental mode default false in empty mode, got %v", cfg.EnableExperimentalMode) + } +} + +func TestApplyConfigDefaultsForMode_copilotCliLeavesExperimentalModeNil(t *testing.T) { + c := NewClient(&ClientOptions{Mode: ModeCopilotCli}) + cfg := &SessionConfig{} + c.applyConfigDefaultsForMode(cfg) + if cfg.EnableExperimentalMode != nil { + t.Errorf("non-empty mode must not default experimental mode") + } +} + func TestApplyConfigDefaultsForMode_emptyHonorsCallerTelemetry(t *testing.T) { c := NewClient(&ClientOptions{Mode: ModeEmpty, BaseDirectory: t.TempDir()}) trueVal := true @@ -273,6 +291,12 @@ func TestApplyConfigDefaultsForMode_emptyDefaultsGranularFlags(t *testing.T) { if cfg.EnableSkills == nil || *cfg.EnableSkills != false { t.Errorf("expected EnableSkills=false in empty mode, got %v", cfg.EnableSkills) } + if cfg.Memory == nil || cfg.Memory.Enabled != false { + t.Errorf("expected Memory.Enabled=false in empty mode, got %v", cfg.Memory) + } + if cfg.CustomAgentsLocalOnly == nil || !*cfg.CustomAgentsLocalOnly { + t.Errorf("expected CustomAgentsLocalOnly=true in empty mode, got %v", cfg.CustomAgentsLocalOnly) + } } func TestApplyConfigDefaultsForMode_emptyHonorsCallerGranularFlags(t *testing.T) { @@ -287,6 +311,8 @@ func TestApplyConfigDefaultsForMode_emptyHonorsCallerGranularFlags(t *testing.T) EnableHostGitOperations: &trueVal, EnableSessionStore: &trueVal, EnableSkills: &trueVal, + Memory: &MemoryConfiguration{Enabled: true}, + CustomAgentsLocalOnly: &falseVal, } c.applyConfigDefaultsForMode(cfg) if *cfg.SkipEmbeddingRetrieval != false { @@ -310,6 +336,12 @@ func TestApplyConfigDefaultsForMode_emptyHonorsCallerGranularFlags(t *testing.T) if *cfg.EnableSkills != true { t.Errorf("caller-supplied EnableSkills must win") } + if cfg.Memory == nil || cfg.Memory.Enabled != true { + t.Errorf("caller-supplied Memory must win") + } + if cfg.CustomAgentsLocalOnly == nil || *cfg.CustomAgentsLocalOnly { + t.Errorf("caller-supplied CustomAgentsLocalOnly must win") + } } func TestApplyConfigDefaultsForMode_copilotCliLeavesGranularFlagsNil(t *testing.T) { @@ -334,6 +366,28 @@ func TestApplyConfigDefaultsForMode_copilotCliLeavesGranularFlagsNil(t *testing. if cfg.EnableSkills != nil { t.Errorf("non-empty mode must not default EnableSkills") } + if cfg.Memory != nil { + t.Errorf("non-empty mode must not default Memory") + } + if cfg.CustomAgentsLocalOnly != nil { + t.Errorf("non-empty mode must not default CustomAgentsLocalOnly") + } +} + +func TestApplyResumeDefaultsForMode_customAgentsLocalOnly(t *testing.T) { + c := NewClient(&ClientOptions{Mode: ModeEmpty, BaseDirectory: t.TempDir()}) + + cfg := &ResumeSessionConfig{} + c.applyResumeDefaultsForMode(cfg) + if cfg.CustomAgentsLocalOnly == nil || !*cfg.CustomAgentsLocalOnly { + t.Errorf("expected CustomAgentsLocalOnly=true in empty mode, got %v", cfg.CustomAgentsLocalOnly) + } + + cfg = &ResumeSessionConfig{CustomAgentsLocalOnly: Bool(false)} + c.applyResumeDefaultsForMode(cfg) + if cfg.CustomAgentsLocalOnly == nil || *cfg.CustomAgentsLocalOnly { + t.Errorf("caller-supplied CustomAgentsLocalOnly must win") + } } func TestApplyConfigDefaultsForMode_emptyDefaultsMCPOAuthTokenStorage(t *testing.T) { @@ -362,3 +416,21 @@ func TestApplyConfigDefaultsForMode_copilotCliLeavesMCPOAuthTokenStorageEmpty(t t.Errorf("non-empty mode must not default MCPOAuthTokenStorage, got %q", cfg.MCPOAuthTokenStorage) } } + +func TestApplyResumeDefaultsForMode_emptyDefaultsExperimentalModeFalse(t *testing.T) { + c := NewClient(&ClientOptions{Mode: ModeEmpty, BaseDirectory: t.TempDir()}) + cfg := &ResumeSessionConfig{} + c.applyResumeDefaultsForMode(cfg) + if cfg.EnableExperimentalMode == nil || *cfg.EnableExperimentalMode != false { + t.Errorf("expected experimental mode default false in empty mode, got %v", cfg.EnableExperimentalMode) + } +} + +func TestApplyResumeDefaultsForMode_copilotCliLeavesExperimentalModeNil(t *testing.T) { + c := NewClient(&ClientOptions{Mode: ModeCopilotCli}) + cfg := &ResumeSessionConfig{} + c.applyResumeDefaultsForMode(cfg) + if cfg.EnableExperimentalMode != nil { + t.Errorf("non-empty mode must not default experimental mode") + } +} diff --git a/go/types.go b/go/types.go index 9dcb61602..2241d2b5f 100644 --- a/go/types.go +++ b/go/types.go @@ -20,14 +20,23 @@ const ( // RuntimeConnection describes how a [Client] connects to the Copilot runtime. // -// Construct one with a [StdioConnection], [TcpConnection], or [UriConnection] -// literal and pass it via [ClientOptions.Connection]. When [ClientOptions.Connection] -// is nil, the default is an empty [StdioConnection] (the SDK spawns the bundled -// runtime and communicates over stdin/stdout). +// Construct one with a [StdioConnection], [TCPConnection], [URIConnection], or +// [InProcessConnection] literal and pass it via [ClientOptions.Connection]. When +// [ClientOptions.Connection] is nil, COPILOT_SDK_DEFAULT_CONNECTION may select +// "inprocess" or "stdio"; when unset, the default is an empty [StdioConnection]. type RuntimeConnection interface { runtimeConnection() } +// childProcessConnection is implemented by the connection types that spawn a +// runtime child process ([StdioConnection] and [TCPConnection]). It exposes the +// per-connection environment so the client can resolve and validate it uniformly +// regardless of the specific child-process transport. +type childProcessConnection interface { + RuntimeConnection + connEnv() []string +} + // StdioConnection spawns a runtime child process and communicates over its // stdin/stdout pipes. This is the default when no connection is configured. type StdioConnection struct { @@ -35,13 +44,20 @@ type StdioConnection struct { Path string // Args are extra command-line arguments inserted before SDK-managed args. Args []string + // Env are the environment variables for the runtime process, each of the + // form "KEY=VALUE". When set, these take precedence over + // [ClientOptions.Env]; setting both is rejected. When nil, the client-level + // env (or the current process environment) is used. + Env []string } func (StdioConnection) runtimeConnection() {} -// TcpConnection spawns a runtime child process that listens on a TCP socket +func (c StdioConnection) connEnv() []string { return c.Env } + +// TCPConnection spawns a runtime child process that listens on a TCP socket // and connects to it. -type TcpConnection struct { +type TCPConnection struct { // Port is the TCP port the runtime listens on. 0 (the default) lets the // runtime pick a free port; the chosen port is then available via // [Client.RuntimePort] after [Client.Start] returns. @@ -54,13 +70,20 @@ type TcpConnection struct { Path string // Args are extra command-line arguments inserted before SDK-managed args. Args []string + // Env are the environment variables for the runtime process, each of the + // form "KEY=VALUE". When set, these take precedence over + // [ClientOptions.Env]; setting both is rejected. When nil, the client-level + // env (or the current process environment) is used. + Env []string } -func (TcpConnection) runtimeConnection() {} +func (TCPConnection) runtimeConnection() {} + +func (c TCPConnection) connEnv() []string { return c.Env } -// UriConnection connects to an already-running runtime at the given URL. +// URIConnection connects to an already-running runtime at the given URL. // The SDK does not spawn a process in this mode. -type UriConnection struct { +type URIConnection struct { // URL of the runtime. Accepts "port", "host:port", or a full URL such // as "http://host:port". URL string @@ -69,13 +92,31 @@ type UriConnection struct { ConnectionToken string } -func (UriConnection) runtimeConnection() {} +func (URIConnection) runtimeConnection() {} + +// InProcessConnection hosts the Copilot runtime in-process by loading its native +// runtime library (a Rust cdylib) and driving JSON-RPC over the library's C ABI, +// instead of spawning a runtime child process. +// +// Because the runtime is loaded into the calling process, per-client +// environment, working directory, and telemetry cannot be represented and are +// rejected by [NewClient] (see [ClientOptions]). Set those via the host process +// environment instead, or use a child-process transport ([StdioConnection] / +// [TCPConnection]). +// +// Experimental: the in-process transport is experimental and its API and +// behavior may change in a future release. Build the application with the +// copilot_inprocess build tag to enable this transport. +type InProcessConnection struct { +} + +func (InProcessConnection) runtimeConnection() {} // ClientOptions configures the [Client]. type ClientOptions struct { // Connection describes how to connect to the Copilot runtime. When nil, - // defaults to an empty [StdioConnection] (spawn the bundled runtime over - // stdio). + // COPILOT_SDK_DEFAULT_CONNECTION may select "inprocess" or "stdio"; + // when unset, defaults to an empty [StdioConnection]. Connection RuntimeConnection // WorkingDirectory is the working directory for the runtime process. // If empty, inherits the current process's working directory. @@ -86,8 +127,13 @@ type ClientOptions struct { // This does not affect where the Go SDK extracts the embedded CLI // binary; use embeddedcli.Config.Dir to control that install/cache // location. - // Ignored when connecting to an existing runtime via [UriConnection]. + // Ignored when connecting to an existing runtime via [URIConnection]. BaseDirectory string + // BuiltinPluginDirectories contains absolute paths to trusted plugin + // directories bundled by the host. When non-empty, Start replaces the + // runtime's complete trusted built-in plugin directory set before sessions + // can be created. + BuiltinPluginDirectories []string // LogLevel for the runtime. When empty (the default), the runtime // uses its own default level; the SDK does not pass --log-level. // Recognized values: "none", "error", "warning", "info", "debug", "all". @@ -95,6 +141,12 @@ type ClientOptions struct { // Env are the environment variables for the runtime process (default: // inherits from current process). Each entry is of the form "KEY=VALUE". // If Env contains duplicate keys, only the last value for each key is used. + // + // For child-process transports ([StdioConnection] / [TCPConnection]) the + // per-connection Env, when set, takes precedence over this field; setting + // both is rejected. Env is not supported with [InProcessConnection] (the + // runtime shares this process's single environment block) and is rejected + // by [NewClient]. Env []string // GitHubToken is the GitHub token to use for authentication. // When provided, the token is passed to the runtime via environment @@ -111,11 +163,22 @@ type ClientOptions struct { // querying the runtime. Useful in BYOK mode to return models available // from your custom provider. OnListModels func(ctx context.Context) ([]ModelInfo, error) - // SessionFs configures a custom session filesystem provider. + // SessionFS configures a custom session filesystem provider. // When provided, the client registers as the session filesystem provider // on connection, routing session-scoped file I/O through per-session // handlers. - SessionFs *SessionFsConfig + SessionFS *SessionFSConfig + // RequestHandler registers a connection-level LLM inference callback. When + // non-nil, the client registers as the inference provider on connect, and + // the runtime routes its model-layer HTTP and WebSocket traffic through + // this handler instead of issuing the calls itself. Works for both CAPI + // and BYOK sessions. + RequestHandler *CopilotRequestHandler + // OnGitHubTelemetry registers a connection-level callback (experimental) + // that receives GitHub telemetry events the runtime forwards for sessions + // opened by this client. When non-nil, every session created or resumed by + // this client opts into telemetry forwarding (enableGitHubTelemetryForwarding). + OnGitHubTelemetry func(notification *rpc.GitHubTelemetryNotification) // Telemetry configures OpenTelemetry integration for the runtime. // When non-nil, COPILOT_OTEL_ENABLED=true is set and any populated // fields are mapped to the corresponding environment variables. @@ -123,12 +186,12 @@ type ClientOptions struct { // SessionIdleTimeoutSeconds configures the server-wide session idle // timeout in seconds. Sessions without activity for this duration are // automatically cleaned up. Set to 0 or leave unset to disable. - // Ignored when connecting to an existing runtime via [UriConnection]. + // Ignored when connecting to an existing runtime via [URIConnection]. SessionIdleTimeoutSeconds int // EnableRemoteSessions enables remote session support (Mission Control // integration). When true, sessions in a GitHub repository working // directory are accessible from GitHub web and mobile. - // Ignored when connecting to an existing runtime via [UriConnection]. + // Ignored when connecting to an existing runtime via [URIConnection]. EnableRemoteSessions bool // Mode controls the default tool surface and feature flags presented to // sessions created by this client. The zero value ([ModeCopilotCli]) @@ -136,7 +199,7 @@ type ClientOptions struct { // multi-tenant safe defaults — see [ClientMode] for details. // // When Mode is [ModeEmpty], NewClient requires either BaseDirectory, - // SessionFs, or a [UriConnection] so the runtime has persistent storage + // SessionFS, or a [URIConnection] so the runtime has persistent storage // for session state. Mode ClientMode } @@ -159,6 +222,10 @@ type TelemetryConfig struct { // Sets OTEL_EXPORTER_OTLP_ENDPOINT. OTLPEndpoint string + // OTLPProtocol is the OTLP HTTP protocol for all signals. + // Sets OTEL_EXPORTER_OTLP_PROTOCOL. + OTLPProtocol string + // FilePath is the file path for JSON-lines trace output. // Sets COPILOT_OTEL_FILE_EXPORTER_PATH. FilePath string @@ -205,7 +272,10 @@ func Int(v int) *int { // Known system message section identifiers for the "customize" mode. const ( - // SectionIdentity is the agent identity preamble and mode statement. + // SectionPreamble is the agent identity preamble and mode statement. + SectionPreamble = "preamble" + // SectionIdentity is the section group covering the identity preamble and its + // sibling sub-sections (tone, tool efficiency, etc.). SectionIdentity = "identity" // SectionTone covers response style, conciseness rules, and output formatting preferences. SectionTone = "tone" @@ -244,6 +314,10 @@ const ( SectionActionAppend SectionOverrideAction = "append" // SectionActionPrepend prepends to existing section content. SectionActionPrepend SectionOverrideAction = "prepend" + // SectionActionPreserve is a no-op marker that opts an individually-addressable + // section out of a group-level "remove" (e.g. keep "tone" when removing the + // "identity" group). + SectionActionPreserve SectionOverrideAction = "preserve" ) // SectionTransformFn is a callback that receives the current content of a system message section @@ -306,9 +380,115 @@ type PermissionHandlerFunc func(request PermissionRequest, invocation Permission // PermissionInvocation provides context about a permission request type PermissionInvocation struct { + SessionID string + ManagedSettingsEnabled bool +} + +// PermissionDecisionContext describes how and where a permission decision was +// reached. Attach it to a decision with [NewAttributedPermissionResult] so the runtime +// can attribute auto-approval telemetry to the responding surface. It is +// informational only and never changes permission behavior. +// +// Experimental: PermissionDecisionContext is part of an experimental API and +// may change or be removed. +type PermissionDecisionContext = rpc.PermissionDecisionContext + +// PermissionDecisionOutcome describes the disposition of a permission request +// as observed by the responding client. +type PermissionDecisionOutcome = rpc.PermissionDecisionOutcome + +const ( + PermissionDecisionOutcomeAutoApproved = rpc.PermissionDecisionOutcomeAutoApproved + PermissionDecisionOutcomeAutopilotDenied = rpc.PermissionDecisionOutcomeAutopilotDenied + PermissionDecisionOutcomePromptedUser = rpc.PermissionDecisionOutcomePromptedUser +) + +// PermissionDecisionSource identifies the controlled reason or actor +// responsible for a permission response. +type PermissionDecisionSource = rpc.PermissionDecisionSource + +const ( + PermissionDecisionSourceHostPolicy = rpc.PermissionDecisionSourceHostPolicy + PermissionDecisionSourceHumanResponse = rpc.PermissionDecisionSourceHumanResponse + PermissionDecisionSourceJudgeRecommendation = rpc.PermissionDecisionSourceJudgeRecommendation + PermissionDecisionSourceUnattendedFallback = rpc.PermissionDecisionSourceUnattendedFallback +) + +// PermissionDecisionSurface identifies the client surface that submitted a +// permission response. +type PermissionDecisionSurface = rpc.PermissionDecisionSurface + +const ( + PermissionDecisionSurfaceCopilotApp = rpc.PermissionDecisionSurfaceCopilotApp + PermissionDecisionSurfacePromptMode = rpc.PermissionDecisionSurfacePromptMode + PermissionDecisionSurfaceSDK = rpc.PermissionDecisionSurfaceSDK + PermissionDecisionSurfaceTui = rpc.PermissionDecisionSurfaceTui +) + +// MCPAuthWwwAuthenticateParams contains parsed parameters from an MCP server's WWW-Authenticate response. +type MCPAuthWwwAuthenticateParams struct { + ResourceMetadataURL *string `json:"resourceMetadataUrl,omitempty"` + Scope *string `json:"scope,omitempty"` + Error *string `json:"error,omitempty"` +} + +// MCPAuthStaticClientConfig is static OAuth client configuration supplied by an MCP server. +type MCPAuthStaticClientConfig struct { + ClientID string `json:"clientId"` + ClientSecret *string `json:"clientSecret,omitempty"` + GrantType *string `json:"grantType,omitempty"` + PublicClient *bool `json:"publicClient,omitempty"` +} + +// MCPAuthRequest describes an MCP OAuth request that the SDK host can satisfy with a token. +type MCPAuthRequest struct { + RequestID string `json:"requestId"` + ServerName string `json:"serverName"` + ServerURL string `json:"serverUrl"` + Reason MCPOauthRequestReason `json:"reason"` + WwwAuthenticateParams *MCPAuthWwwAuthenticateParams `json:"wwwAuthenticateParams,omitempty"` + ResourceMetadata *string `json:"resourceMetadata,omitempty"` + StaticClientConfig *MCPAuthStaticClientConfig `json:"staticClientConfig,omitempty"` +} + +// MCPAuthToken is host-provided OAuth token data for a pending MCP OAuth request. +type MCPAuthToken struct { + AccessToken string `json:"accessToken"` + TokenType *string `json:"tokenType,omitempty"` + ExpiresIn *int64 `json:"expiresIn,omitempty"` +} + +// MCPAuthResult is the result returned by an MCP auth request handler. +type MCPAuthResult struct { + Kind string + Token *MCPAuthToken +} + +const ( + // MCPAuthResultKindToken indicates that the host provided token data. + MCPAuthResultKindToken = "token" + // MCPAuthResultKindCancelled indicates that the host declined the request. + MCPAuthResultKindCancelled = "cancelled" +) + +// MCPAuthResultToken returns a token result for an MCP OAuth request. +func MCPAuthResultToken(token *MCPAuthToken) *MCPAuthResult { + return &MCPAuthResult{Kind: MCPAuthResultKindToken, Token: token} +} + +// MCPAuthResultCancelled returns a cancelled result for an MCP OAuth request. +func MCPAuthResultCancelled() *MCPAuthResult { + return &MCPAuthResult{Kind: MCPAuthResultKindCancelled} +} + +// MCPAuthInvocation provides context about an MCP auth handler invocation. +type MCPAuthInvocation struct { SessionID string } +// MCPAuthHandler handles MCP OAuth requests from the runtime. +type MCPAuthHandler func(request MCPAuthRequest, invocation MCPAuthInvocation) (*MCPAuthResult, error) + // UserInputRequest represents a request for user input from the agent type UserInputRequest struct { Question string @@ -545,6 +725,46 @@ type UserPromptSubmittedHookOutput struct { // UserPromptSubmittedHandler handles user-prompt-submitted hook invocations type UserPromptSubmittedHandler func(input UserPromptSubmittedHookInput, invocation HookInvocation) (*UserPromptSubmittedHookOutput, error) +// UserPromptTransformedHookInput is the input for a user-prompt-transformed hook. +type UserPromptTransformedHookInput struct { + SessionID string `json:"sessionId"` + Timestamp time.Time `json:"-"` + WorkingDirectory string `json:"cwd"` + Prompt string `json:"prompt"` + TransformedPrompt string `json:"transformedPrompt"` +} + +// MarshalJSON implements json.Marshaler, emitting Timestamp as Unix milliseconds. +func (h UserPromptTransformedHookInput) MarshalJSON() ([]byte, error) { + type alias UserPromptTransformedHookInput + return json.Marshal(&struct { + Timestamp int64 `json:"timestamp"` + alias + }{Timestamp: h.Timestamp.UnixMilli(), alias: alias(h)}) +} + +// UnmarshalJSON implements json.Unmarshaler, parsing Timestamp from Unix milliseconds. +func (h *UserPromptTransformedHookInput) UnmarshalJSON(data []byte) error { + type alias UserPromptTransformedHookInput + aux := &struct { + Timestamp int64 `json:"timestamp"` + *alias + }{alias: (*alias)(h)} + if err := json.Unmarshal(data, aux); err != nil { + return err + } + h.Timestamp = time.UnixMilli(aux.Timestamp) + return nil +} + +// UserPromptTransformedHookOutput is the output for a user-prompt-transformed hook. +type UserPromptTransformedHookOutput struct { + ModifiedTransformedPrompt *string `json:"modifiedTransformedPrompt,omitempty"` +} + +// UserPromptTransformedHandler handles user-prompt-transformed hook invocations. +type UserPromptTransformedHandler func(input UserPromptTransformedHookInput, invocation HookInvocation) (*UserPromptTransformedHookOutput, error) + // SessionStartHookInput is the input for a session-start hook type SessionStartHookInput struct { SessionID string `json:"sessionId"` @@ -673,8 +893,50 @@ type ErrorOccurredHookOutput struct { // ErrorOccurredHandler handles error-occurred hook invocations type ErrorOccurredHandler func(input ErrorOccurredHookInput, invocation HookInvocation) (*ErrorOccurredHookOutput, error) -// PreMcpToolCallHookInput is the input for a pre-mcp-tool-call hook -type PreMcpToolCallHookInput struct { +// AgentStopHookInput is the input for an agent-stop hook. +type AgentStopHookInput struct { + SessionID string `json:"sessionId"` + Timestamp time.Time `json:"-"` + WorkingDirectory string `json:"cwd"` + StopReason string `json:"stopReason,omitempty"` + TranscriptPath string `json:"transcriptPath,omitempty"` + StopHookActive bool `json:"stop_hook_active,omitempty"` +} + +// MarshalJSON implements json.Marshaler, emitting Timestamp as Unix milliseconds. +func (h AgentStopHookInput) MarshalJSON() ([]byte, error) { + type alias AgentStopHookInput + return json.Marshal(&struct { + Timestamp int64 `json:"timestamp"` + alias + }{Timestamp: h.Timestamp.UnixMilli(), alias: alias(h)}) +} + +// UnmarshalJSON implements json.Unmarshaler, parsing Timestamp from Unix milliseconds. +func (h *AgentStopHookInput) UnmarshalJSON(data []byte) error { + type alias AgentStopHookInput + aux := &struct { + Timestamp int64 `json:"timestamp"` + *alias + }{alias: (*alias)(h)} + if err := json.Unmarshal(data, aux); err != nil { + return err + } + h.Timestamp = time.UnixMilli(aux.Timestamp) + return nil +} + +// AgentStopHookOutput is the output for an agent-stop hook. +type AgentStopHookOutput struct { + Decision string `json:"decision,omitempty"` + Reason string `json:"reason,omitempty"` +} + +// AgentStopHandler handles agent-stop hook invocations. +type AgentStopHandler func(input AgentStopHookInput, invocation HookInvocation) (*AgentStopHookOutput, error) + +// PreMCPToolCallHookInput is the input for a pre-mcp-tool-call hook +type PreMCPToolCallHookInput struct { SessionID string `json:"sessionId"` Timestamp time.Time `json:"-"` WorkingDirectory string `json:"cwd"` @@ -686,8 +948,8 @@ type PreMcpToolCallHookInput struct { } // MarshalJSON implements json.Marshaler, emitting Timestamp as Unix milliseconds. -func (h PreMcpToolCallHookInput) MarshalJSON() ([]byte, error) { - type alias PreMcpToolCallHookInput +func (h PreMCPToolCallHookInput) MarshalJSON() ([]byte, error) { + type alias PreMCPToolCallHookInput return json.Marshal(&struct { Timestamp int64 `json:"timestamp"` alias @@ -695,8 +957,8 @@ func (h PreMcpToolCallHookInput) MarshalJSON() ([]byte, error) { } // UnmarshalJSON implements json.Unmarshaler, parsing Timestamp from Unix milliseconds. -func (h *PreMcpToolCallHookInput) UnmarshalJSON(data []byte) error { - type alias PreMcpToolCallHookInput +func (h *PreMCPToolCallHookInput) UnmarshalJSON(data []byte) error { + type alias PreMCPToolCallHookInput aux := &struct { Timestamp int64 `json:"timestamp"` *alias @@ -708,13 +970,13 @@ func (h *PreMcpToolCallHookInput) UnmarshalJSON(data []byte) error { return nil } -// PreMcpToolCallHookOutput is the output for a pre-mcp-tool-call hook -type PreMcpToolCallHookOutput struct { +// PreMCPToolCallHookOutput is the output for a pre-mcp-tool-call hook +type PreMCPToolCallHookOutput struct { MetaToUse any `json:"metaToUse"` } -// PreMcpToolCallHandler handles pre-mcp-tool-call hook invocations -type PreMcpToolCallHandler func(input PreMcpToolCallHookInput, invocation HookInvocation) (*PreMcpToolCallHookOutput, error) +// PreMCPToolCallHandler handles pre-mcp-tool-call hook invocations +type PreMCPToolCallHandler func(input PreMCPToolCallHookInput, invocation HookInvocation) (*PreMCPToolCallHookOutput, error) // HookInvocation provides context about a hook invocation type HookInvocation struct { @@ -723,14 +985,16 @@ type HookInvocation struct { // SessionHooks configures hook handlers for a session type SessionHooks struct { - OnPreToolUse PreToolUseHandler - OnPostToolUse PostToolUseHandler - OnPostToolUseFailure PostToolUseFailureHandler - OnUserPromptSubmitted UserPromptSubmittedHandler - OnSessionStart SessionStartHandler - OnSessionEnd SessionEndHandler - OnErrorOccurred ErrorOccurredHandler - OnPreMcpToolCall PreMcpToolCallHandler + OnPreToolUse PreToolUseHandler + OnPostToolUse PostToolUseHandler + OnPostToolUseFailure PostToolUseFailureHandler + OnUserPromptSubmitted UserPromptSubmittedHandler + OnUserPromptTransformed UserPromptTransformedHandler + OnSessionStart SessionStartHandler + OnSessionEnd SessionEndHandler + OnErrorOccurred ErrorOccurredHandler + OnAgentStop AgentStopHandler + OnPreMCPToolCall PreMCPToolCallHandler } // MCPServerConfig is implemented by MCP server configuration types. @@ -743,19 +1007,15 @@ type MCPServerConfig interface { // // The Tools field controls which tools from the server are exposed: // - nil (omitted from the wire): all tools (CLI default) -// - &[]string{"*"}: explicit "all tools" -// - &[]string{}: no tools -// - &[]string{"foo","bar"}: only those tools -// -// The pointer-to-slice form is required so that a nil pointer (omitted from -// the wire) is distinguishable from a non-nil pointer to an empty slice -// (sent as `"tools": []`). +// - []string{"*"}: explicit "all tools" +// - []string{}: no tools +// - []string{"foo","bar"}: only those tools type MCPStdioServerConfig struct { - Tools *[]string `json:"tools,omitempty"` + Tools []string `json:"tools,omitzero"` Timeout int `json:"timeout,omitempty"` Command string `json:"command"` - Args []string `json:"args,omitempty"` - Env map[string]string `json:"env,omitempty"` + Args []string `json:"args,omitzero"` + Env map[string]string `json:"env,omitzero"` WorkingDirectory string `json:"cwd,omitempty"` } @@ -777,10 +1037,10 @@ func (c MCPStdioServerConfig) MarshalJSON() ([]byte, error) { // // See [MCPStdioServerConfig] for the semantics of the Tools field. type MCPHTTPServerConfig struct { - Tools *[]string `json:"tools,omitempty"` + Tools []string `json:"tools,omitzero"` Timeout int `json:"timeout,omitempty"` URL string `json:"url"` - Headers map[string]string `json:"headers,omitempty"` + Headers map[string]string `json:"headers,omitzero"` } func (MCPHTTPServerConfig) mcpServerConfig() {} @@ -797,7 +1057,7 @@ func (c MCPHTTPServerConfig) MarshalJSON() ([]byte, error) { }) } -// CustomAgentConfig configures a custom agent +// CustomAgentConfig configures a custom agent. type CustomAgentConfig struct { // Name is the unique name of the custom agent Name string `json:"name"` @@ -805,8 +1065,9 @@ type CustomAgentConfig struct { DisplayName string `json:"displayName,omitempty"` // Description of what the agent does Description string `json:"description,omitempty"` - // Tools is the list of tool names the agent can use (nil for all tools) - Tools []string `json:"tools,omitempty"` + // Tools is the list of tool names the agent can use. Nil omits the field + // (all tools); an empty non-nil slice sends "tools": [] (no tools). + Tools []string `json:"tools,omitzero"` // Prompt is the prompt content for the agent Prompt string `json:"prompt"` // MCPServers are MCP servers specific to this agent @@ -819,6 +1080,10 @@ type CustomAgentConfig struct { // When set, the runtime will attempt to use this model for the agent, // falling back to the parent session model if unavailable. Model string `json:"model,omitempty"` + // ReasoningEffort is the reasoning effort level for this agent's model. + // When empty, the runtime resolves model configuration, then inherits the + // parent effort only for the same model. + ReasoningEffort string `json:"reasoningEffort,omitempty"` } // DefaultAgentConfig configures the default agent (the built-in agent that handles turns when no custom agent is selected). @@ -844,6 +1109,12 @@ type InfiniteSessionConfig struct { BufferExhaustionThreshold *float64 `json:"bufferExhaustionThreshold,omitempty"` } +// MemoryConfiguration configures the memory feature for a session. +type MemoryConfiguration struct { + // Enabled controls whether the memory feature is enabled for this session. + Enabled bool `json:"enabled"` +} + // LargeToolOutputConfig configures handling of large tool outputs. When a tool // produces output exceeding the configured size, the output is written to a // temp file and a reference is returned to the model instead of the full @@ -859,33 +1130,114 @@ type LargeToolOutputConfig struct { OutputDirectory string `json:"outputDir,omitempty"` } -// ContextTier identifies a context window tier for models that support tiered context windows. -type ContextTier string - -const ( - // ContextTierDefault is the default context tier with standard context window size. - ContextTierDefault ContextTier = "default" - // ContextTierLongContext is the extended context tier with a larger context window. - ContextTierLongContext ContextTier = "long_context" -) +// ToolSearchConfig allows to configure tool search behavior. +// Tool search defers tools to keep the model's active tool set small. +// To override the tool-search tool's implementation, register a +// [Tool] named "tool_search_tool" with OverridesBuiltInTool set to true. +type ToolSearchConfig struct { + // Controls whether tool search is enabled. + Enabled *bool `json:"enabled,omitempty"` + // DeferThreshold is the tool count above which MCP and external tools are + // deferred behind tool search. When nil, the runtime default (30) applies. + DeferThreshold *int `json:"deferThreshold,omitempty"` +} -// SessionFsCapabilities declares optional provider capabilities. -type SessionFsCapabilities struct { +// SessionFSCapabilities declares optional provider capabilities. +type SessionFSCapabilities struct { // Sqlite indicates whether the provider supports SQLite query/exists operations. Sqlite bool } -// SessionFsConfig configures a custom session filesystem provider. -type SessionFsConfig struct { +// SessionFSConfig configures a custom session filesystem provider. +type SessionFSConfig struct { // InitialWorkingDirectory is the initial working directory for sessions. InitialWorkingDirectory string // SessionStatePath is the path within each session's filesystem where the runtime stores // session-scoped files such as events, checkpoints, and temp files. SessionStatePath string // Conventions identifies the path conventions used by this filesystem provider. - Conventions rpc.SessionFsSetProviderConventions + Conventions rpc.SessionFSSetProviderConventions // Capabilities declares optional provider capabilities such as SQLite support. - Capabilities *SessionFsCapabilities + Capabilities *SessionFSCapabilities +} + +// ExpFlagValue is a single ExP (Experiment Platform) flag value. ExP +// assignments resolve to a string, number (float64/int), bool, or nil. +type ExpFlagValue any + +// ExpConfigEntry is a single configuration entry in a +// [CopilotExpAssignmentResponse]. Each entry carries an identifier and a bag of +// typed parameter values. +type ExpConfigEntry struct { + // ID identifies the configuration entry. Serialized on the wire as "Id". + ID string `json:"Id"` + // Parameters holds parameter values keyed by parameter name. + Parameters map[string]ExpFlagValue `json:"Parameters"` +} + +// CopilotExpAssignmentResponse is ExP ("flight") assignment data, in the same +// JSON shape the Copilot CLI fetches from the experimentation service. Field +// names are PascalCase to match the on-the-wire contract consumed by the +// runtime. +type CopilotExpAssignmentResponse struct { + // Features lists the enabled feature names. + Features []string `json:"Features"` + // Flights holds the assigned flights keyed by flight name. + Flights map[string]string `json:"Flights"` + // Configs holds configuration entries carrying typed parameter values. + Configs []ExpConfigEntry `json:"Configs"` + // ParameterGroups is an opaque parameter-group payload passed through + // untouched. Optional. + ParameterGroups any `json:"ParameterGroups,omitempty"` + // FlightingVersion is the version of the flighting configuration. Optional. + FlightingVersion *int `json:"FlightingVersion,omitempty"` + // ImpressionID is the impression identifier for the assignment. Optional. + // Serialized on the wire as "ImpressionId". + ImpressionID *string `json:"ImpressionId,omitempty"` + // AssignmentContext is the assignment context string forwarded to CAPI and + // telemetry. + AssignmentContext string `json:"AssignmentContext"` +} + +// MarshalJSON normalizes the required collection fields so a zero-value +// response serializes them as JSON arrays/objects rather than null, which the +// runtime can otherwise treat as a malformed assignment payload and drop. +func (r CopilotExpAssignmentResponse) MarshalJSON() ([]byte, error) { + type wire CopilotExpAssignmentResponse + w := wire(r) + if w.Features == nil { + w.Features = []string{} + } + if w.Flights == nil { + w.Flights = map[string]string{} + } + if w.Configs == nil { + w.Configs = []ExpConfigEntry{} + } + return json.Marshal(w) +} + +// MarshalJSON normalizes the required Parameters map so an entry serializes it +// as a JSON object rather than null. +func (e ExpConfigEntry) MarshalJSON() ([]byte, error) { + type wire ExpConfigEntry + w := wire(e) + if w.Parameters == nil { + w.Parameters = map[string]ExpFlagValue{} + } + return json.Marshal(w) +} + +// GitHubMCPToolConfig configures the built-in GitHub MCP server. +// +// DisableFormDeferral only applies to the built-in GitHub MCP server and only +// has an effect when MCP Apps and form-backed GitHub tools are enabled. +type GitHubMCPToolConfig struct { + EnableAllTools *bool `json:"enableAllTools,omitempty"` + AdditionalToolsets []string `json:"additionalToolsets,omitempty"` + AdditionalTools []string `json:"additionalTools,omitempty"` + EnableInsidersMode *bool `json:"enableInsidersMode,omitempty"` + DisableFormDeferral *bool `json:"disableFormDeferral,omitempty"` } // SessionConfig configures a new session @@ -898,7 +1250,7 @@ type SessionConfig struct { // Model to use for this session Model string // ReasoningEffort level for models that support it. - // Valid values: "low", "medium", "high", "xhigh" + // Valid values: "low", "medium", "high", "xhigh", "max" // Only applies to models where capabilities.supports.reasoningEffort is true. ReasoningEffort string // ReasoningSummary mode for models that support configurable reasoning summaries. @@ -910,13 +1262,10 @@ type SessionConfig struct { // ConfigDirectory overrides the default configuration directory location. // When specified, the session will use this directory for storing config and state. ConfigDirectory string - // EnableConfigDiscovery, when true, automatically discovers MCP server configurations - // (e.g. .mcp.json, .vscode/mcp.json) and skill directories from the working directory - // and merges them with any explicitly provided MCPServers and SkillDirectories, with - // explicit values taking precedence on name collision. - // Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are - // always loaded from the working directory regardless of this setting. - EnableConfigDiscovery bool + // EnableConfigDiscovery enables runtime discovery of supported configuration. + // Explicitly supplied configuration takes precedence over discovered values. + // Nil leaves the runtime default unchanged; use Bool(false) to explicitly disable discovery. + EnableConfigDiscovery *bool // SkipEmbeddingRetrieval, when non-nil, controls embedding-based retrieval // for this session. Use in multitenant deployments to prevent cross-session // information leakage through the shared embedding cache. @@ -960,10 +1309,19 @@ type SessionConfig struct { // ExcludedTools is a list of tool names to disable. All other tools remain available. // Ignored if AvailableTools is specified. ExcludedTools []string + // ExcludedBuiltInAgents is a list of built-in agent names to exclude from + // the session. Excluded built-in agents are hidden from discovery and cannot + // be selected or invoked unless a custom agent with the same name is + // configured. + ExcludedBuiltInAgents []string // OnPermissionRequest is an optional handler for permission requests from the server. // When nil, permission requests are surfaced as events and left pending for the // consumer to resolve via pending permission RPCs. OnPermissionRequest PermissionHandlerFunc + // OnMCPAuthRequest is an optional handler for MCP OAuth requests from MCP servers. + // When provided, the SDK can satisfy MCP server OAuth requests with host-provided + // token data or cancellation. + OnMCPAuthRequest MCPAuthHandler // OnUserInputRequest is a handler for user input requests from the agent (enables ask_user tool) OnUserInputRequest UserInputHandler // Hooks configures hook handlers for session lifecycle events @@ -971,6 +1329,9 @@ type SessionConfig struct { // WorkingDirectory is the working directory for the session. // Tool operations will be relative to this directory. WorkingDirectory string + // AdditionalDirectories are directories the agent may access beyond WorkingDirectory. + // Relative paths are resolved against WorkingDirectory. Re-supply them when resuming. + AdditionalDirectories []string // Streaming enables streaming of assistant message and reasoning chunks. // When non-nil and true, assistant.message_delta and assistant.reasoning_delta // events with deltaContent are sent as the response is generated. @@ -985,6 +1346,20 @@ type SessionConfig struct { IncludeSubAgentStreamingEvents *bool // Provider configures a custom model provider (BYOK) Provider *ProviderConfig + // Capi configures provider-scoped CAPI (Copilot API) session options. + Capi *CapiSessionOptions + // Providers configures named BYOK provider connections. Additive to Copilot + // API auth (unlike Provider); combine with Models. Cannot be combined with Provider. + // + // Experimental: Providers is part of an experimental multi-provider BYOK + // surface and may change or be removed in future SDK or CLI releases. + Providers []NamedProviderConfig + // Models adds BYOK model definitions to the session's selectable model list, + // each referencing a Providers entry by name. + // + // Experimental: Models is part of an experimental multi-provider BYOK + // surface and may change or be removed in future SDK or CLI releases. + Models []ProviderModelConfig // EnableSessionTelemetry enables or disables internal session telemetry for this session. // When false, disables session telemetry. When nil (the default) or true, // telemetry is enabled for GitHub-authenticated sessions. When a custom @@ -992,6 +1367,23 @@ type SessionConfig struct { // regardless of this setting. This is independent of the OpenTelemetry // configuration in ClientOptions.Telemetry. EnableSessionTelemetry *bool + // EnableCitations enables native model citations for supported providers. + // + // Experimental: EnableCitations is part of an experimental model capability + // surface and may change or be removed in future SDK or CLI releases. + EnableCitations *bool + // EnableFileChangeTracking opts in to capturing file changes from the first + // turn for session rewind and cumulative session diff. + EnableFileChangeTracking *bool + // SessionLimits applies limits to this session's current accounting window. + // + // Experimental: SessionLimits is part of an experimental runtime accounting + // surface and may change or be removed in future SDK or CLI releases. + SessionLimits *rpc.SessionLimitsConfig + // EnableExperimentalMode controls whether the session enables experimental + // features. When nil, it defaults to false in [ModeEmpty]; otherwise the + // runtime decides. + EnableExperimentalMode *bool // SkipCustomInstructions, when non-nil, controls whether the runtime loads // custom instruction files. See also [ClientOptions.Mode] = [ModeEmpty]. SkipCustomInstructions *bool @@ -1033,6 +1425,10 @@ type SessionConfig struct { InstructionDirectories []string // DisabledSkills is a list of skill names to disable DisabledSkills []string + // DisabledMCPServers is a list of exact MCP server names to disable for this session. + // Disabled servers are not started or authenticated on create or cold resume. + // A resident resume cannot stop servers that are already running. + DisabledMCPServers []string // InfiniteSessions configures infinite sessions for persistent workspaces and automatic compaction. // When enabled (default), sessions automatically manage context limits and persist state. InfiniteSessions *InfiniteSessionConfig @@ -1040,15 +1436,22 @@ type SessionConfig struct { // output exceeding the configured size, the output is written to a temp file // and a reference is returned to the model instead of the full payload. LargeOutput *LargeToolOutputConfig + // ToolSearch overrides the runtime's built-in tool-search behavior, which + // defers rarely used tools behind a searchable index. When nil, the runtime + // default applies. + ToolSearch *ToolSearchConfig + // Memory configures the memory feature for the session. When omitted, the + // runtime default applies. + Memory *MemoryConfiguration // OnEvent is an optional event handler that is registered on the session before // the session.create RPC is issued. This guarantees that early events emitted // by the CLI during session creation (e.g. session.start) are delivered to the // handler. Equivalent to calling session.On(handler) immediately after creation, // but executes earlier in the lifecycle so no events are missed. OnEvent SessionEventHandler - // CreateSessionFsProvider supplies a handler for session filesystem operations. - // This takes effect only when ClientOptions.SessionFs is configured. - CreateSessionFsProvider func(session *Session) SessionFsProvider + // CreateSessionFSProvider supplies a handler for session filesystem operations. + // This takes effect only when ClientOptions.SessionFS is configured. + CreateSessionFSProvider func(session *Session) SessionFSProvider // Commands registers slash-commands for this session. Each command appears as // /name in the CLI TUI for the user to invoke. The Handler is called when the // command is executed. @@ -1063,9 +1466,9 @@ type SessionConfig struct { // OnAutoModeSwitchRequest is a handler for auto-mode-switch requests from the server. // When provided, enables autoModeSwitch.request callbacks for the session. OnAutoModeSwitchRequest AutoModeSwitchRequestHandler - // EnableMcpApps enables MCP Apps (SEP-1865) UI passthrough on this session. + // EnableMCPApps enables MCP Apps (SEP-1865) UI passthrough on this session. // - // Experimental: EnableMcpApps is part of an experimental wire-protocol + // Experimental: EnableMCPApps is part of an experimental wire-protocol // surface (SEP-1865) and may change or be removed in a future release. // // When true AND the runtime has MCP Apps enabled (via the MCP_APPS feature @@ -1085,7 +1488,11 @@ type SessionConfig struct { // that can display ui:// MCP App bundles. Setting it without a renderer will // cause MCP servers to register UI-enabled tool variants the consumer cannot // display. - EnableMcpApps bool + EnableMCPApps bool + // GitHubMCPToolConfig configures the built-in GitHub MCP server. + // DisableFormDeferral only applies to that server and only has an effect + // when MCP Apps and form-backed GitHub tools are enabled. + GitHubMCPToolConfig *GitHubMCPToolConfig // GitHubToken is an optional per-session GitHub token used for authentication. // When provided, the session authenticates as the token's owner instead of // using the global client-level auth. @@ -1107,25 +1514,116 @@ type SessionConfig struct { RequestCanvasRenderer *bool // RequestExtensions asks the host to surface declared canvases as agent-visible extensions. RequestExtensions *bool - // ExtensionSdkPath optionally overrides the bundled `@github/copilot-sdk` drop + // ExtensionSDKPath optionally overrides the bundled `@github/copilot-sdk` drop // injected into extension subprocesses. When set to an absolute path containing // a valid `copilot-sdk/` folder (with `index.js` and `extension.js` at the // root), the host injects the override into every forked extension; invalid or // missing paths fall back to the bundled SDK silently. - ExtensionSdkPath *string + ExtensionSDKPath *string // CanvasHandler receives inbound canvas.open / canvas.close / canvas.action.invoke // requests for this session. The SDK does not maintain a per-canvas registry; // the handler must dispatch on CanvasProviderOpenRequest.CanvasID itself. CanvasHandler CanvasHandler `json:"-"` // ExtensionInfo identifies the stable extension providing this session's canvases. ExtensionInfo *ExtensionInfo -} + // CanvasProvider is the stable identity for a host/SDK connection that + // supplies built-in canvases, so they survive reconnect and CLI restart. + CanvasProvider *CanvasProviderIdentity + // ExpAssignments injects ExP assignment ("flight") data for this session, + // in the same JSON shape the Copilot CLI fetches from the experimentation + // service (CopilotExpAssignmentResponse). When supplied, the runtime feeds + // it into the same feature-flag path as CLI-fetched assignments and stamps + // it onto telemetry and the CAPI request header. When absent, the session + // does not block on ExP. Malformed payloads are dropped by the runtime + // (fail-open). + // + // Internal: ExpAssignments is part of the SDK's internal API surface, + // intended for trusted out-of-process integrators, and is not intended for + // general external use. + ExpAssignments *CopilotExpAssignmentResponse + // EnableManagedSettings, when set to true, opts the runtime into + // self-fetching enterprise managed settings (bypass-permissions policy) at + // session bootstrap using the session's GitHubToken. Requires GitHubToken to + // be set; if omitted, the runtime is expected to reject session creation + // (fail-closed). Unset behaves exactly as before. + EnableManagedSettings *bool + // ManagedSettings supplies host-injected enterprise managed settings for + // the session. Unlike EnableManagedSettings (which asks the runtime to + // self-fetch account/org and device policy), this provides the managed + // policy directly. The runtime validates it with the same + // managed-permission parser it uses for fetched policy and composes it + // restrictively with any self-fetched (server) and device-managed (MDM) + // layers. It is startup-only and not persisted: re-supply it on resume, + // where it replaces the prior injected layer (omitting it clears the + // layer). It may be combined with EnableManagedSettings. Requires a runtime + // whose RPC schema includes managedSettings. + ManagedSettings *ManagedSettings +} + +// ManagedSettings is host-injected enterprise managed settings for a session. +// The first supported contract is permissions-only; unknown sibling keys are +// rejected by the runtime. Serialized on the wire as managedSettings. +type ManagedSettings struct { + // Permissions is the managed permission policy for the session. + Permissions *ManagedSettingsPermissions `json:"permissions,omitempty"` +} + +// DisableBypassPermissionsMode is the managed bypass-permissions policy. +type DisableBypassPermissionsMode = rpc.DisableBypassPermissionsMode + +const ( + // DisableBypassPermissionsModeDisable turns off bypass-permissions mode. + DisableBypassPermissionsModeDisable = rpc.DisableBypassPermissionsModeDisable +) + +// ManagedSettingsPermissions is the permissions-only managed policy injected +// via ManagedSettings. Rule strings use the same vocabulary the runtime +// accepts for fetched managed policy (e.g. "Read(**)", "Shell(git push *)"); +// malformed rules are rejected by the runtime at session creation. +type ManagedSettingsPermissions struct { + // DisableBypassPermissionsMode, when set to "disable", turns off + // bypass-permissions ("yolo") mode for the session. Deny-wins: no other + // layer can re-enable it. + DisableBypassPermissionsMode DisableBypassPermissionsMode `json:"disableBypassPermissionsMode,omitempty"` + // Deny lists operations that must always be denied. Unioned across layers. + Deny []string `json:"deny,omitzero"` + // Ask lists operations that must prompt for approval. Unioned across layers. + Ask []string `json:"ask,omitzero"` + // Allow lists operations permitted without prompting. Every declared allow + // list across managed layers must admit an operation for it to be allowed. + Allow []string `json:"allow,omitzero"` +} + +// ToolDefer controls whether a tool may be deferred (loaded lazily via tool +// search) rather than always pre-loaded. +type ToolDefer string + +const ( + // ToolDeferAuto allows the tool to be deferred and surfaced through tool search. + ToolDeferAuto ToolDefer = "auto" + // ToolDeferNever forces the tool to always be pre-loaded. + ToolDeferNever ToolDefer = "never" +) + type Tool struct { Name string `json:"name"` Description string `json:"description,omitempty"` - Parameters map[string]any `json:"parameters,omitempty"` + Parameters map[string]any `json:"parameters,omitzero"` OverridesBuiltInTool bool `json:"overridesBuiltInTool,omitempty"` SkipPermission bool `json:"skipPermission,omitempty"` + // IsTerminal reports that a successful call to this tool ends the agent + // turn: the runtime halts instead of feeding the result back to the model + // for another round. A failed call leaves the loop running so the model can + // read the error and retry. + IsTerminal bool `json:"isTerminal,omitempty"` + // Defer controls whether the tool may be deferred (loaded lazily via tool + // search) rather than always pre-loaded. When empty, the runtime decides. + Defer ToolDefer `json:"defer,omitempty"` + // Metadata is opaque, host-defined metadata associated with the tool + // definition. Keys are namespaced and not part of the stable public API; + // values are not interpreted and may be recognized to inform host-specific + // behavior. Unknown keys are preserved and round-tripped untouched. + Metadata map[string]any `json:"metadata,omitempty"` // Handler is optional. When nil, the SDK exposes the tool declaration but does // not automatically invoke it. Handler ToolHandler `json:"-"` @@ -1138,6 +1636,14 @@ type ToolInvocation struct { ToolName string Arguments any + // AvailableTools is a snapshot of the session's currently initialized + // tools. The SDK populates it only when this invocation targets the + // built-in tool-search tool ("tool_search_tool"), so a tool-search + // override can rank/filter the live catalog -- including MCP tools + // configured in settings -- without issuing its own RPC. It is nil for + // every other tool invocation. + AvailableTools []rpc.CurrentToolMetadata + // TraceContext carries the W3C Trace Context propagated from the CLI's // execute_tool span. Pass this to OpenTelemetry-aware code so that // child spans created inside the handler are parented to the CLI span. @@ -1157,6 +1663,8 @@ type ToolResult struct { Error string `json:"error,omitempty"` SessionLog string `json:"sessionLog,omitempty"` ToolTelemetry map[string]any `json:"toolTelemetry,omitempty"` + // ToolReferences lists names of tools returned by a tool-search tool. + ToolReferences []string `json:"toolReferences,omitempty"` } // CommandContext provides context about a slash-command invocation. @@ -1194,23 +1702,45 @@ type SessionCapabilities struct { type UICapabilities struct { // Elicitation indicates whether the host supports interactive elicitation dialogs. Elicitation bool `json:"elicitation,omitempty"` - // McpApps indicates whether the runtime has accepted the session's MCP Apps - // (SEP-1865) opt-in. True when the consumer set EnableMcpApps=true on + // MCPApps indicates whether the runtime has accepted the session's MCP Apps + // (SEP-1865) opt-in. True when the consumer set EnableMCPApps=true on // create/resume AND the runtime's MCP_APPS feature flag (or // COPILOT_MCP_APPS=true env override) is on. Otherwise false, indicating // the runtime silently dropped the opt-in. // - // Experimental: McpApps is part of an experimental wire-protocol surface + // Experimental: MCPApps is part of an experimental wire-protocol surface // (SEP-1865) and may change or be removed in a future release. - McpApps bool `json:"mcpApps,omitempty"` + MCPApps bool `json:"mcpApps,omitempty"` } +// ElicitationAction is the user response to an elicitation request. +type ElicitationAction = rpc.UIElicitationResponseAction + +// Elicitation action values. +const ( + ElicitationActionAccept ElicitationAction = rpc.UIElicitationResponseActionAccept + ElicitationActionCancel ElicitationAction = rpc.UIElicitationResponseActionCancel + ElicitationActionDecline ElicitationAction = rpc.UIElicitationResponseActionDecline +) + +// ElicitationFieldValue is a primitive value submitted for an elicitation form field. +// Supported values are string, numeric types, bool, []string, and []any containing strings. +type ElicitationFieldValue = any + // ElicitationResult is the user's response to an elicitation dialog. type ElicitationResult struct { - // Action is the user response: "accept" (submitted), "decline" (rejected), or "cancel" (dismissed). - Action string `json:"action"` - // Content holds form values submitted by the user (present when Action is "accept"). - Content map[string]any `json:"content,omitempty"` + // Action is the user response: accept, decline, or cancel. + Action ElicitationAction `json:"action"` + // Content holds form values submitted by the user when Action is accept. + Content map[string]ElicitationFieldValue `json:"content,omitzero"` +} + +// ElicitationSchema describes the form fields for an elicitation request. +type ElicitationSchema struct { + // Properties contains form field definitions keyed by field name. + Properties map[string]any `json:"properties"` + // Required lists field names that must be submitted. + Required []string `json:"required,omitzero"` } // ElicitationContext describes an elicitation request from the server, @@ -1222,13 +1752,13 @@ type ElicitationContext struct { // Message describes what information is needed from the user. Message string // RequestedSchema is a JSON Schema describing the form fields (form mode only). - RequestedSchema map[string]any + RequestedSchema *ElicitationSchema // Mode is "form" for structured input, "url" for browser redirect. - Mode string + Mode *ElicitationRequestedMode // ElicitationSource is the source that initiated the request (e.g. MCP server name). - ElicitationSource string + ElicitationSource *string // URL to open in the user's browser (url mode only). - URL string + URL *string } // ElicitationHandler handles elicitation requests from the server (e.g. from MCP tools). @@ -1236,8 +1766,8 @@ type ElicitationContext struct { // If the handler returns an error the SDK auto-cancels the request. type ElicitationHandler func(ctx ElicitationContext) (ElicitationResult, error) -// UiInputOptions configures a text input field for the Input convenience method. -type UiInputOptions struct { +// UIInputOptions configures a text input field for the Input convenience method. +type UIInputOptions struct { // Title label for the input field. Title string // Description text shown below the field. @@ -1276,8 +1806,27 @@ type ResumeSessionConfig struct { // ExcludedTools is a list of tool names to disable. All other tools remain available. // Ignored if AvailableTools is specified. ExcludedTools []string + // ExcludedBuiltInAgents is a list of built-in agent names to exclude from + // the session. Excluded built-in agents are hidden from discovery and cannot + // be selected or invoked unless a custom agent with the same name is + // configured. + ExcludedBuiltInAgents []string // Provider configures a custom model provider Provider *ProviderConfig + // Capi configures provider-scoped CAPI (Copilot API) session options. + Capi *CapiSessionOptions + // Providers configures named BYOK provider connections. Additive to Copilot + // API auth (unlike Provider); combine with Models. Cannot be combined with Provider. + // + // Experimental: Providers is part of an experimental multi-provider BYOK + // surface and may change or be removed in future SDK or CLI releases. + Providers []NamedProviderConfig + // Models adds BYOK model definitions to the session's selectable model list, + // each referencing a Providers entry by name. + // + // Experimental: Models is part of an experimental multi-provider BYOK + // surface and may change or be removed in future SDK or CLI releases. + Models []ProviderModelConfig // EnableSessionTelemetry enables or disables internal session telemetry for this session. // When false, disables session telemetry. When nil (the default) or true, // telemetry is enabled for GitHub-authenticated sessions. When a custom @@ -1285,6 +1834,24 @@ type ResumeSessionConfig struct { // regardless of this setting. This is independent of the OpenTelemetry // configuration in ClientOptions.Telemetry. EnableSessionTelemetry *bool + // EnableCitations enables native model citations for supported providers. + // + // Experimental: EnableCitations is part of an experimental model capability + // surface and may change or be removed in future SDK or CLI releases. + EnableCitations *bool + // EnableFileChangeTracking opts in to capturing file changes for session + // rewind and cumulative session diff when the resumed session has a valid + // baseline. Earlier untracked changes cannot be reconstructed. + EnableFileChangeTracking *bool + // SessionLimits applies limits to this session's current accounting window. + // + // Experimental: SessionLimits is part of an experimental runtime accounting + // surface and may change or be removed in future SDK or CLI releases. + SessionLimits *rpc.SessionLimitsConfig + // EnableExperimentalMode controls whether the session enables experimental + // features. When nil, it defaults to false in [ModeEmpty]; otherwise the + // runtime decides. + EnableExperimentalMode *bool // SkipCustomInstructions, when non-nil, controls whether the runtime loads // custom instruction files. See also [ClientOptions.Mode] = [ModeEmpty]. SkipCustomInstructions *bool @@ -1302,7 +1869,7 @@ type ResumeSessionConfig struct { // Only non-nil fields are applied over the runtime-resolved capabilities. ModelCapabilities *rpc.ModelCapabilitiesOverride // ReasoningEffort level for models that support it. - // Valid values: "low", "medium", "high", "xhigh" + // Valid values: "low", "medium", "high", "xhigh", "max" ReasoningEffort string // ReasoningSummary mode for models that support configurable reasoning summaries. // Use ReasoningSummaryNone to suppress summary output regardless of whether reasoning is enabled. @@ -1314,6 +1881,9 @@ type ResumeSessionConfig struct { // When nil, permission requests are surfaced as events and left pending for the // consumer to resolve via pending permission RPCs. OnPermissionRequest PermissionHandlerFunc + // OnMCPAuthRequest is an optional handler for MCP OAuth requests from MCP servers. + // See SessionConfig.OnMCPAuthRequest. + OnMCPAuthRequest MCPAuthHandler // OnUserInputRequest is a handler for user input requests from the agent (enables ask_user tool) OnUserInputRequest UserInputHandler // Hooks configures hook handlers for session lifecycle events @@ -1321,15 +1891,15 @@ type ResumeSessionConfig struct { // WorkingDirectory is the working directory for the session. // Tool operations will be relative to this directory. WorkingDirectory string + // AdditionalDirectories are directories the agent may access beyond WorkingDirectory. + // Relative paths are resolved against WorkingDirectory. Re-supply them when resuming. + AdditionalDirectories []string // ConfigDirectory overrides the default configuration directory location. ConfigDirectory string - // EnableConfigDiscovery, when true, automatically discovers MCP server configurations - // (e.g. .mcp.json, .vscode/mcp.json) and skill directories from the working directory - // and merges them with any explicitly provided MCPServers and SkillDirectories, with - // explicit values taking precedence on name collision. - // Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are - // always loaded from the working directory regardless of this setting. - EnableConfigDiscovery bool + // EnableConfigDiscovery enables runtime discovery of supported configuration. + // Explicitly supplied configuration takes precedence over discovered values. + // Nil leaves the runtime default unchanged; use Bool(false) to explicitly disable discovery. + EnableConfigDiscovery *bool // SkipEmbeddingRetrieval, when non-nil, controls embedding-based retrieval // for this session. Use in multitenant deployments to prevent cross-session // information leakage through the shared embedding cache. @@ -1392,12 +1962,23 @@ type ResumeSessionConfig struct { InstructionDirectories []string // DisabledSkills is a list of skill names to disable DisabledSkills []string + // DisabledMCPServers is a list of exact MCP server names to disable for this session. + // Disabled servers are not started or authenticated on create or cold resume. + // A resident resume cannot stop servers that are already running. + DisabledMCPServers []string // InfiniteSessions configures infinite sessions for persistent workspaces and automatic compaction. InfiniteSessions *InfiniteSessionConfig // LargeOutput configures handling of large tool outputs. When a tool produces // output exceeding the configured size, the output is written to a temp file // and a reference is returned to the model instead of the full payload. LargeOutput *LargeToolOutputConfig + // ToolSearch overrides the runtime's built-in tool-search behavior, which + // defers rarely used tools behind a searchable index. When nil, the runtime + // default applies. + ToolSearch *ToolSearchConfig + // Memory configures the memory feature for the session. When omitted, the + // runtime default applies. + Memory *MemoryConfiguration // GitHubToken is an optional per-session GitHub token used for authentication. // When provided, the session authenticates as the token's owner instead of // using the global client-level auth. @@ -1408,21 +1989,22 @@ type ResumeSessionConfig struct { // SuppressResumeEvent, when true, skips emitting the session.resume event. // Useful for reconnecting to a session without triggering resume-related side effects. SuppressResumeEvent bool - // ContinuePendingWork, when true, instructs the runtime to continue any tool calls - // or permission prompts that were still pending when the session was last suspended. - // When false (the default), the runtime treats pending work as interrupted on resume. + // ContinuePendingWork, when non-nil, controls whether the runtime continues any + // tool calls or permission prompts that were still pending when the session was + // last suspended. Nil leaves the runtime default unchanged; use Bool(false) to + // explicitly treat pending work as interrupted on resume. // // For permission requests, the runtime re-emits permission.requested so the // registered OnPermissionRequest handler can re-prompt; for external tool calls, // the consumer is expected to supply the result via the corresponding low-level // RPC method. - ContinuePendingWork bool + ContinuePendingWork *bool // OnEvent is an optional event handler registered before the session.resume RPC // is issued, ensuring early events are delivered. See SessionConfig.OnEvent. OnEvent SessionEventHandler - // CreateSessionFsProvider supplies a handler for session filesystem operations. - // This takes effect only when ClientOptions.SessionFs is configured. - CreateSessionFsProvider func(session *Session) SessionFsProvider + // CreateSessionFSProvider supplies a handler for session filesystem operations. + // This takes effect only when ClientOptions.SessionFS is configured. + CreateSessionFSProvider func(session *Session) SessionFSProvider // Commands registers slash-commands for this session. See SessionConfig.Commands. Commands []CommandDefinition // OnElicitationRequest is a handler for elicitation requests from the server. @@ -1434,12 +2016,16 @@ type ResumeSessionConfig struct { // OnAutoModeSwitchRequest is a handler for auto-mode-switch requests from the server. // See SessionConfig.OnAutoModeSwitchRequest. OnAutoModeSwitchRequest AutoModeSwitchRequestHandler - // EnableMcpApps enables MCP Apps (SEP-1865) UI passthrough on resume. - // See SessionConfig.EnableMcpApps. + // EnableMCPApps enables MCP Apps (SEP-1865) UI passthrough on resume. + // See SessionConfig.EnableMCPApps. // - // Experimental: EnableMcpApps is part of an experimental wire-protocol + // Experimental: EnableMCPApps is part of an experimental wire-protocol // surface (SEP-1865) and may change or be removed in a future release. - EnableMcpApps bool + EnableMCPApps bool + // GitHubMCPToolConfig configures the built-in GitHub MCP server. + // DisableFormDeferral only applies to that server and only has an effect + // when MCP Apps and form-backed GitHub tools are enabled. + GitHubMCPToolConfig *GitHubMCPToolConfig // Canvases declares canvases this session provides. Sent over the wire on // `session.resume`. See SessionConfig.Canvases. Canvases []CanvasDeclaration @@ -1451,19 +2037,80 @@ type ResumeSessionConfig struct { RequestCanvasRenderer *bool // RequestExtensions asks the host to surface declared canvases as agent-visible extensions. RequestExtensions *bool - // ExtensionSdkPath optionally overrides the bundled `@github/copilot-sdk` drop - // injected into extension subprocesses. See SessionConfig.ExtensionSdkPath. - ExtensionSdkPath *string + // ExtensionSDKPath optionally overrides the bundled `@github/copilot-sdk` drop + // injected into extension subprocesses. See SessionConfig.ExtensionSDKPath. + ExtensionSDKPath *string // CanvasHandler receives inbound canvas.* requests for this session. See SessionConfig.CanvasHandler. CanvasHandler CanvasHandler `json:"-"` // ExtensionInfo identifies the stable extension providing this session's canvases. ExtensionInfo *ExtensionInfo + // CanvasProvider is the stable identity for a host/SDK connection that + // supplies built-in canvases. See SessionConfig.CanvasProvider. + CanvasProvider *CanvasProviderIdentity + // ExpAssignments injects ExP assignment ("flight") data on resume. See + // SessionConfig.ExpAssignments. Re-supply on resume so the runtime + // re-applies the assignments after a CLI process restart. + // + // Internal: ExpAssignments is part of the SDK's internal API surface, + // intended for trusted out-of-process integrators, and is not intended for + // general external use. + ExpAssignments *CopilotExpAssignmentResponse + // EnableManagedSettings injects the same opt-in flag on resume. See + // SessionConfig.EnableManagedSettings. Re-supply on resume so the runtime + // re-applies the managed-settings self-fetch after a CLI process restart. + EnableManagedSettings *bool + // ManagedSettings re-injects host-provided managed settings on resume. See + // SessionConfig.ManagedSettings. It must be re-supplied on resume: it + // replaces the prior injected layer, and omitting it clears that layer so + // warm and cold resume behave identically. + ManagedSettings *ManagedSettings +} + +// ProviderTokenArgs carries the context passed to a [BearerTokenProvider] callback +// when the runtime needs a fresh bearer token for a BYOK provider. +// +// Experimental: ProviderTokenArgs is part of the experimental managed-identity / +// bearer-token-provider surface and may change or be removed in future SDK or CLI +// releases. +type ProviderTokenArgs struct { + // ProviderName is the name of the BYOK provider needing a token. For the + // singular, whole-session [ProviderConfig] this is the implicit provider name + // ("default"); for [NamedProviderConfig] entries it is + // [NamedProviderConfig.Name]. + // + // The callback closes over its own token scope/audience; the runtime is + // provider-agnostic and forwards only the provider name. + ProviderName string + + // SessionID is the id of the session that triggered this token request. A + // client-level shared callback registered for many sessions can use this to + // resolve the owning session and scope token acquisition or caching per + // session. + SessionID string } + +// BearerTokenProvider is a per-provider callback that resolves a bearer token on +// demand, returning the raw token string (without the "Bearer " prefix). The +// Copilot SDK itself takes no Azure dependency: the consumer supplies this +// callback backed by their own identity library (for example azidentity's +// DefaultAzureCredential.GetToken), and the runtime calls it once before each +// outbound model request. The runtime does no caching of its own, so the callback +// (or the identity library it wraps) owns token caching and refresh. +// +// Experimental: BearerTokenProvider is part of the experimental managed-identity / +// bearer-token-provider surface and may change or be removed in future SDK or CLI +// releases. +type BearerTokenProvider func(args ProviderTokenArgs) (string, error) + type ProviderConfig struct { // Type is the provider type: "openai", "azure", or "anthropic". Defaults to "openai". Type string `json:"type,omitempty"` - // WireApi is the API format (openai/azure only): "completions" or "responses". Defaults to "completions". - WireApi string `json:"wireApi,omitempty"` + // WireAPI is the API format (openai/azure only): "completions" or "responses". Defaults to "completions". + WireAPI string `json:"wireApi,omitempty"` + // Transport for OpenAI Responses requests: "http" or "websockets". Defaults to "http". + // Set "websockets" to deliver Responses API requests over a persistent WebSocket + // connection instead of HTTP. Applies to OpenAI-compatible providers using WireAPI "responses". + Transport string `json:"transport,omitempty"` // BaseURL is the API endpoint URL BaseURL string `json:"baseUrl"` // APIKey is the API key. Optional for local providers like Ollama. @@ -1495,18 +2142,156 @@ type ProviderConfig struct { // tokens. When hit, the model stops generating and returns a truncated // response. MaxOutputTokens int `json:"maxOutputTokens,omitempty"` + // BearerTokenProvider resolves a bearer token on demand for this provider + // (managed-identity / on-demand auth). When set, the SDK strips the callback + // from the wire config and instead sends `hasBearerTokenProvider: true`; the + // runtime calls back over the session-scoped `providerToken.getToken` RPC + // before each outbound model request and applies the returned token as the + // Authorization header. Never serialized. + // + // When set alongside APIKey/BearerToken, this callback takes precedence: the + // runtime applies the token it returns as the Authorization: Bearer header for + // each request and does not send the static credential. + // + // Experimental: part of the experimental managed-identity / bearer-token-provider + // surface and may change or be removed in future SDK or CLI releases. + BearerTokenProvider BearerTokenProvider `json:"-"` +} + +// MarshalJSON serializes the provider config, deriving the wire-only +// `hasBearerTokenProvider` flag from the presence of [ProviderConfig.BearerTokenProvider]. +// The non-serializable callback never crosses the RPC boundary; the runtime only +// learns that a token provider exists and forwards the provider name back when it +// needs a token. +func (p ProviderConfig) MarshalJSON() ([]byte, error) { + type wire ProviderConfig + aux := struct { + wire + HasBearerTokenProvider *bool `json:"hasBearerTokenProvider,omitempty"` + }{wire: wire(p)} + if p.BearerTokenProvider != nil { + aux.HasBearerTokenProvider = Bool(true) + } + return json.Marshal(aux) +} + +// CapiSessionOptions configures provider-scoped Copilot API (CAPI) session behavior. +// +// WebSocket transport is the default for the CAPI Responses API whenever the +// model advertises the ws:/responses endpoint. Set EnableWebSocketResponses to +// Bool(false) to force the HTTP Responses transport, which is useful behind +// proxies where WebSockets fail. This is equivalent to setting the +// COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES environment variable. These options +// are provider-scoped under the capi namespace because a single session can host +// multiple providers, such as CAPI and BYOK, so transport choice is provider-level. +type CapiSessionOptions struct { + // EnableWebSocketResponses controls whether the CAPI Responses API uses + // WebSocket transport. Enabled by default when the model advertises + // ws:/responses support; set to Bool(false) to force HTTP Responses transport. + EnableWebSocketResponses *bool `json:"enableWebSocketResponses,omitempty"` } // AzureProviderOptions contains Azure-specific provider configuration type AzureProviderOptions struct { - // APIVersion is the Azure API version. Defaults to "2024-10-21". + // APIVersion is the Azure API version. When empty, the runtime uses the GA + // versionless v1 route. APIVersion string `json:"apiVersion,omitempty"` } +// NamedProviderConfig is a named BYOK provider connection (transport + +// credentials), referenced by ProviderModelConfig entries via Name. +// +// Unlike the singular Provider (which makes the whole session BYOK and bypasses +// Copilot API authentication), named providers are additive: they coexist with +// Copilot API auth so models from CAPI and one or more BYOK providers can be +// mixed within a single session and across sub-agents. Combining Providers and +// Models with Provider is rejected. +// +// Experimental: NamedProviderConfig is part of an experimental multi-provider +// BYOK surface and may change or be removed in future SDK or CLI releases. +type NamedProviderConfig struct { + // Name is the stable identifier referenced by ProviderModelConfig.Provider. + // Must not contain "/". + Name string `json:"name"` + // Type is the provider type: "openai", "azure", or "anthropic". Defaults to "openai". + Type string `json:"type,omitempty"` + // WireAPI is the API format (openai/azure only): "completions" or "responses". Defaults to "completions". + WireAPI string `json:"wireApi,omitempty"` + // BaseURL is the API endpoint URL. + BaseURL string `json:"baseUrl"` + // APIKey is the API key. Optional for local providers like Ollama. + APIKey string `json:"apiKey,omitempty"` + // BearerToken for authentication. Sets the Authorization header directly. + // Takes precedence over APIKey when both are set. + BearerToken string `json:"bearerToken,omitempty"` + // Azure contains Azure-specific options. + Azure *AzureProviderOptions `json:"azure,omitempty"` + // Headers are custom HTTP headers included in all outbound provider requests. + Headers map[string]string `json:"headers,omitempty"` + // BearerTokenProvider resolves a bearer token on demand for this provider + // (managed-identity / on-demand auth). When set, the SDK strips the callback + // from the wire config and instead sends `hasBearerTokenProvider: true`; the + // runtime calls back over the session-scoped `providerToken.getToken` RPC + // before each outbound model request and applies the returned token as the + // Authorization header. Never serialized. + // + // When set alongside APIKey/BearerToken, this callback takes precedence: the + // runtime applies the token it returns as the Authorization: Bearer header for + // each request and does not send the static credential. + // + // Experimental: part of the experimental managed-identity / bearer-token-provider + // surface and may change or be removed in future SDK or CLI releases. + BearerTokenProvider BearerTokenProvider `json:"-"` +} + +// MarshalJSON serializes the named provider config, deriving the wire-only +// `hasBearerTokenProvider` flag from the presence of +// [NamedProviderConfig.BearerTokenProvider]. The non-serializable callback never +// crosses the RPC boundary; the runtime only learns that a token provider exists +// and forwards the provider name back when it needs a token. +func (p NamedProviderConfig) MarshalJSON() ([]byte, error) { + type wire NamedProviderConfig + aux := struct { + wire + HasBearerTokenProvider *bool `json:"hasBearerTokenProvider,omitempty"` + }{wire: wire(p)} + if p.BearerTokenProvider != nil { + aux.HasBearerTokenProvider = Bool(true) + } + return json.Marshal(aux) +} + +// ProviderModelConfig is a BYOK model definition that references a +// NamedProviderConfig by name and is added to the session's selectable model +// list. The session-wide selection id is the provider-qualified "provider/id". +// +// Experimental: ProviderModelConfig is part of an experimental multi-provider +// BYOK surface and may change or be removed in future SDK or CLI releases. +type ProviderModelConfig struct { + // ID is the provider-local model id, unique within its provider. + ID string `json:"id"` + // Provider is the name of the NamedProviderConfig that serves this model. + Provider string `json:"provider"` + // WireModel is the model name sent to the provider API for inference. Defaults to ID. + WireModel string `json:"wireModel,omitempty"` + // ModelID is the well-known base model id used for behavior/capability/config lookup. Defaults to ID. + ModelID string `json:"modelId,omitempty"` + // Name is the display name for model pickers. Defaults to the provider-qualified selection id. + Name string `json:"name,omitempty"` + // MaxPromptTokens is the maximum prompt/input tokens for the model. + MaxPromptTokens int `json:"maxPromptTokens,omitempty"` + // MaxContextWindowTokens is the maximum context window tokens for the model. + MaxContextWindowTokens int `json:"maxContextWindowTokens,omitempty"` + // MaxOutputTokens is the maximum output tokens for the model. + MaxOutputTokens int `json:"maxOutputTokens,omitempty"` + // Capabilities holds optional capability overrides for the synthesized model. + Capabilities *rpc.ModelCapabilitiesOverride `json:"capabilities,omitempty"` +} + // ToolBinaryResult represents binary payloads returned by tools. type ToolBinaryResult struct { Data string `json:"data"` - MimeType string `json:"mimeType"` + MIMEType string `json:"mimeType"` Type string `json:"type"` Description string `json:"description,omitempty"` } @@ -1554,7 +2339,7 @@ type ModelVisionLimits struct { // ModelLimits contains model limits type ModelLimits struct { MaxPromptTokens *int `json:"max_prompt_tokens,omitempty"` - MaxContextWindowTokens int `json:"max_context_window_tokens"` + MaxContextWindowTokens *int `json:"max_context_window_tokens,omitempty"` Vision *ModelVisionLimits `json:"vision,omitempty"` } @@ -1587,7 +2372,8 @@ type ModelPolicy struct { // ModelBilling contains model billing information type ModelBilling struct { - Multiplier *float64 `json:"multiplier,omitempty"` + Multiplier *float64 `json:"multiplier,omitempty"` + TokenPrices *rpc.ModelBillingTokenPrices `json:"tokenPrices,omitempty"` } // ModelInfo contains information about an available model @@ -1676,8 +2462,16 @@ type createSessionRequest struct { AvailableTools []string `json:"availableTools"` ExcludedTools []string `json:"excludedTools,omitempty"` ToolFilterPrecedence *rpc.OptionsUpdateToolFilterPrecedence `json:"toolFilterPrecedence,omitempty"` + ExcludedBuiltInAgents []string `json:"excludedBuiltinAgents,omitempty"` Provider *ProviderConfig `json:"provider,omitempty"` + Capi *CapiSessionOptions `json:"capi,omitempty"` + Providers []NamedProviderConfig `json:"providers,omitempty"` + Models []ProviderModelConfig `json:"models,omitempty"` EnableSessionTelemetry *bool `json:"enableSessionTelemetry,omitempty"` + EnableCitations *bool `json:"enableCitations,omitempty"` + EnableFileChangeTracking *bool `json:"enableFileChangeTracking,omitempty"` + SessionLimits *rpc.SessionLimitsConfig `json:"sessionLimits,omitempty"` + IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` @@ -1689,8 +2483,10 @@ type createSessionRequest struct { RequestAutoModeSwitch *bool `json:"requestAutoModeSwitch,omitempty"` Hooks *bool `json:"hooks,omitempty"` WorkingDirectory string `json:"workingDirectory,omitempty"` + AdditionalDirectories []string `json:"additionalDirectories,omitempty"` Streaming *bool `json:"streaming,omitempty"` IncludeSubAgentStreamingEvents *bool `json:"includeSubAgentStreamingEvents,omitempty"` + EnableGitHubTelemetryForwarding *bool `json:"enableGitHubTelemetryForwarding,omitempty"` MCPServers map[string]MCPServerConfig `json:"mcpServers,omitempty"` MCPOAuthTokenStorage string `json:"mcpOAuthTokenStorage,omitempty"` EnvValueMode string `json:"envValueMode,omitempty"` @@ -1711,19 +2507,27 @@ type createSessionRequest struct { PluginDirectories []string `json:"pluginDirectories,omitempty"` InstructionDirectories []string `json:"instructionDirectories,omitempty"` DisabledSkills []string `json:"disabledSkills,omitempty"` + DisabledMCPServers *[]string `json:"disabledMcpServers,omitempty"` InfiniteSessions *InfiniteSessionConfig `json:"infiniteSessions,omitempty"` LargeOutput *LargeToolOutputConfig `json:"largeOutput,omitempty"` + ToolSearch *ToolSearchConfig `json:"toolSearch,omitempty"` + Memory *MemoryConfiguration `json:"memory,omitempty"` Commands []wireCommand `json:"commands,omitempty"` RequestElicitation *bool `json:"requestElicitation,omitempty"` - RequestMcpApps *bool `json:"requestMcpApps,omitempty"` + RequestMCPApps *bool `json:"requestMcpApps,omitempty"` + GitHubMCPToolConfig *GitHubMCPToolConfig `json:"githubMcpToolConfig,omitempty"` GitHubToken string `json:"gitHubToken,omitempty"` RemoteSession rpc.RemoteSessionMode `json:"remoteSession,omitempty"` Cloud *CloudSessionOptions `json:"cloud,omitempty"` Canvases []CanvasDeclaration `json:"canvases,omitempty"` RequestCanvasRenderer *bool `json:"requestCanvasRenderer,omitempty"` RequestExtensions *bool `json:"requestExtensions,omitempty"` - ExtensionSdkPath *string `json:"extensionSdkPath,omitempty"` + ExtensionSDKPath *string `json:"extensionSdkPath,omitempty"` ExtensionInfo *ExtensionInfo `json:"extensionInfo,omitempty"` + CanvasProvider *CanvasProviderIdentity `json:"canvasProvider,omitempty"` + ExpAssignments *CopilotExpAssignmentResponse `json:"expAssignments,omitempty"` + EnableManagedSettings *bool `json:"enableManagedSettings,omitempty"` + ManagedSettings *ManagedSettings `json:"managedSettings,omitempty"` Traceparent string `json:"traceparent,omitempty"` Tracestate string `json:"tracestate,omitempty"` } @@ -1754,8 +2558,16 @@ type resumeSessionRequest struct { AvailableTools []string `json:"availableTools"` ExcludedTools []string `json:"excludedTools,omitempty"` ToolFilterPrecedence *rpc.OptionsUpdateToolFilterPrecedence `json:"toolFilterPrecedence,omitempty"` + ExcludedBuiltInAgents []string `json:"excludedBuiltinAgents,omitempty"` Provider *ProviderConfig `json:"provider,omitempty"` + Capi *CapiSessionOptions `json:"capi,omitempty"` + Providers []NamedProviderConfig `json:"providers,omitempty"` + Models []ProviderModelConfig `json:"models,omitempty"` EnableSessionTelemetry *bool `json:"enableSessionTelemetry,omitempty"` + EnableCitations *bool `json:"enableCitations,omitempty"` + EnableFileChangeTracking *bool `json:"enableFileChangeTracking,omitempty"` + SessionLimits *rpc.SessionLimitsConfig `json:"sessionLimits,omitempty"` + IsExperimentalMode *bool `json:"isExperimentalMode,omitempty"` SkipCustomInstructions *bool `json:"skipCustomInstructions,omitempty"` CustomAgentsLocalOnly *bool `json:"customAgentsLocalOnly,omitempty"` CoauthorEnabled *bool `json:"coauthorEnabled,omitempty"` @@ -1767,6 +2579,7 @@ type resumeSessionRequest struct { RequestAutoModeSwitch *bool `json:"requestAutoModeSwitch,omitempty"` Hooks *bool `json:"hooks,omitempty"` WorkingDirectory string `json:"workingDirectory,omitempty"` + AdditionalDirectories []string `json:"additionalDirectories,omitempty"` ConfigDir string `json:"configDir,omitempty"` EnableConfigDiscovery *bool `json:"enableConfigDiscovery,omitempty"` SkipEmbeddingRetrieval *bool `json:"skipEmbeddingRetrieval,omitempty"` @@ -1781,6 +2594,7 @@ type resumeSessionRequest struct { ContinuePendingWork *bool `json:"continuePendingWork,omitempty"` Streaming *bool `json:"streaming,omitempty"` IncludeSubAgentStreamingEvents *bool `json:"includeSubAgentStreamingEvents,omitempty"` + EnableGitHubTelemetryForwarding *bool `json:"enableGitHubTelemetryForwarding,omitempty"` MCPServers map[string]MCPServerConfig `json:"mcpServers,omitempty"` MCPOAuthTokenStorage string `json:"mcpOAuthTokenStorage,omitempty"` EnvValueMode string `json:"envValueMode,omitempty"` @@ -1791,19 +2605,27 @@ type resumeSessionRequest struct { PluginDirectories []string `json:"pluginDirectories,omitempty"` InstructionDirectories []string `json:"instructionDirectories,omitempty"` DisabledSkills []string `json:"disabledSkills,omitempty"` + DisabledMCPServers *[]string `json:"disabledMcpServers,omitempty"` InfiniteSessions *InfiniteSessionConfig `json:"infiniteSessions,omitempty"` LargeOutput *LargeToolOutputConfig `json:"largeOutput,omitempty"` + ToolSearch *ToolSearchConfig `json:"toolSearch,omitempty"` + Memory *MemoryConfiguration `json:"memory,omitempty"` Commands []wireCommand `json:"commands,omitempty"` RequestElicitation *bool `json:"requestElicitation,omitempty"` - RequestMcpApps *bool `json:"requestMcpApps,omitempty"` + RequestMCPApps *bool `json:"requestMcpApps,omitempty"` + GitHubMCPToolConfig *GitHubMCPToolConfig `json:"githubMcpToolConfig,omitempty"` GitHubToken string `json:"gitHubToken,omitempty"` RemoteSession rpc.RemoteSessionMode `json:"remoteSession,omitempty"` Canvases []CanvasDeclaration `json:"canvases,omitempty"` OpenCanvases []rpc.OpenCanvasInstance `json:"openCanvases,omitempty"` RequestCanvasRenderer *bool `json:"requestCanvasRenderer,omitempty"` RequestExtensions *bool `json:"requestExtensions,omitempty"` - ExtensionSdkPath *string `json:"extensionSdkPath,omitempty"` + ExtensionSDKPath *string `json:"extensionSdkPath,omitempty"` ExtensionInfo *ExtensionInfo `json:"extensionInfo,omitempty"` + CanvasProvider *CanvasProviderIdentity `json:"canvasProvider,omitempty"` + ExpAssignments *CopilotExpAssignmentResponse `json:"expAssignments,omitempty"` + EnableManagedSettings *bool `json:"enableManagedSettings,omitempty"` + ManagedSettings *ManagedSettings `json:"managedSettings,omitempty"` Traceparent string `json:"traceparent,omitempty"` Tracestate string `json:"tracestate,omitempty"` } diff --git a/go/types_test.go b/go/types_test.go index 6d83c8ec0..4195464b3 100644 --- a/go/types_test.go +++ b/go/types_test.go @@ -5,6 +5,18 @@ import ( "testing" ) +func TestUserPromptTransformedHookOutput_PreservesEmptyReplacement(t *testing.T) { + data, err := json.Marshal(UserPromptTransformedHookOutput{ + ModifiedTransformedPrompt: String(""), + }) + if err != nil { + t.Fatalf("failed to marshal hook output: %v", err) + } + if string(data) != `{"modifiedTransformedPrompt":""}` { + t.Fatalf("expected empty replacement to be preserved, got %s", data) + } +} + func TestProviderConfig_JSONIncludesHeaders(t *testing.T) { config := ProviderConfig{ BaseURL: "https://example.com/provider", @@ -152,6 +164,130 @@ func TestCustomAgentConfig_JSONIncludesModel(t *testing.T) { } } +func TestCustomAgentConfig_JSONIncludesReasoningEffort(t *testing.T) { + cfg := CustomAgentConfig{ + Name: "reasoning-agent", + Prompt: "Think carefully.", + ReasoningEffort: "high", + } + + data, err := json.Marshal(cfg) + if err != nil { + t.Fatalf("failed to marshal CustomAgentConfig: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal CustomAgentConfig: %v", err) + } + + if decoded["reasoningEffort"] != "high" { + t.Errorf("expected reasoningEffort 'high', got %v", decoded["reasoningEffort"]) + } +} + +func TestCustomAgentConfig_JSONIncludesEmptyTools(t *testing.T) { + cfg := CustomAgentConfig{ + Name: "no-tools-agent", + Prompt: "You are an agent without tools.", + Tools: []string{}, + } + + data, err := json.Marshal(cfg) + if err != nil { + t.Fatalf("failed to marshal CustomAgentConfig: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal CustomAgentConfig: %v", err) + } + + rawTools, present := decoded["tools"] + if !present { + t.Fatal("expected tools to be present for an empty non-nil slice") + } + tools, ok := rawTools.([]any) + if !ok { + t.Fatalf("expected tools array, got %T", rawTools) + } + if len(tools) != 0 { + t.Fatalf("expected empty tools array, got %v", tools) + } +} + +func TestCustomAgentConfig_JSONOmitsNilTools(t *testing.T) { + cfg := CustomAgentConfig{ + Name: "all-tools-agent", + Prompt: "You are an agent with default tools.", + } + + data, err := json.Marshal(cfg) + if err != nil { + t.Fatalf("failed to marshal CustomAgentConfig: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal CustomAgentConfig: %v", err) + } + + if _, present := decoded["tools"]; present { + t.Errorf("expected tools to be omitted for nil slice, got %v", decoded["tools"]) + } +} + +func TestToolResult_JSONIncludesToolReferences(t *testing.T) { + result := ToolResult{ + TextResultForLLM: "found 2 tools", + ResultType: "success", + ToolReferences: []string{"get_weather", "check_status"}, + } + + data, err := json.Marshal(result) + if err != nil { + t.Fatalf("failed to marshal ToolResult: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal ToolResult: %v", err) + } + + rawRefs, present := decoded["toolReferences"] + if !present { + t.Fatal("expected toolReferences to be present") + } + refs, ok := rawRefs.([]any) + if !ok { + t.Fatalf("expected toolReferences array, got %T", rawRefs) + } + if len(refs) != 2 || refs[0] != "get_weather" || refs[1] != "check_status" { + t.Errorf("unexpected toolReferences: %v", refs) + } +} + +func TestToolResult_JSONOmitsNilToolReferences(t *testing.T) { + result := ToolResult{ + TextResultForLLM: "ok", + ResultType: "success", + } + + data, err := json.Marshal(result) + if err != nil { + t.Fatalf("failed to marshal ToolResult: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal ToolResult: %v", err) + } + + if _, present := decoded["toolReferences"]; present { + t.Errorf("expected toolReferences to be omitted for nil slice, got %v", decoded["toolReferences"]) + } +} + func TestCustomAgentConfig_JSONOmitsModelWhenEmpty(t *testing.T) { cfg := CustomAgentConfig{ Name: "no-model-agent", @@ -171,4 +307,154 @@ func TestCustomAgentConfig_JSONOmitsModelWhenEmpty(t *testing.T) { if _, present := decoded["model"]; present { t.Errorf("expected model to be omitted when empty, got %v", decoded["model"]) } + if _, present := decoded["reasoningEffort"]; present { + t.Errorf("expected reasoningEffort to be omitted when empty, got %v", decoded["reasoningEffort"]) + } +} + +func TestTool_JSONIncludesEmptyParameters(t *testing.T) { + tool := Tool{ + Name: "accept_anything", + Parameters: map[string]any{}, + } + + data, err := json.Marshal(tool) + if err != nil { + t.Fatalf("failed to marshal Tool: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal Tool: %v", err) + } + + rawParameters, present := decoded["parameters"] + if !present { + t.Fatal("expected parameters to be present for an empty non-nil map") + } + parameters, ok := rawParameters.(map[string]any) + if !ok { + t.Fatalf("expected parameters object, got %T", rawParameters) + } + if len(parameters) != 0 { + t.Fatalf("expected empty parameters object, got %v", parameters) + } +} + +func TestTool_JSONOmitsNilParameters(t *testing.T) { + tool := Tool{Name: "no_parameters"} + + data, err := json.Marshal(tool) + if err != nil { + t.Fatalf("failed to marshal Tool: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal Tool: %v", err) + } + + if _, present := decoded["parameters"]; present { + t.Errorf("expected parameters to be omitted for nil map, got %v", decoded["parameters"]) + } +} + +func TestCanvasDeclaration_JSONIncludesEmptyInputSchema(t *testing.T) { + canvas := CanvasDeclaration{ + ID: "empty-input", + DisplayName: "Empty input", + Description: "Accepts any input.", + InputSchema: map[string]any{}, + } + + data, err := json.Marshal(canvas) + if err != nil { + t.Fatalf("failed to marshal CanvasDeclaration: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal CanvasDeclaration: %v", err) + } + + rawInputSchema, present := decoded["inputSchema"] + if !present { + t.Fatal("expected inputSchema to be present for an empty non-nil map") + } + inputSchema, ok := rawInputSchema.(map[string]any) + if !ok { + t.Fatalf("expected inputSchema object, got %T", rawInputSchema) + } + if len(inputSchema) != 0 { + t.Fatalf("expected empty inputSchema object, got %v", inputSchema) + } +} + +func TestCanvasDeclaration_JSONOmitsNilInputSchema(t *testing.T) { + canvas := CanvasDeclaration{ + ID: "no-input-schema", + DisplayName: "No input schema", + Description: "Does not declare input.", + } + + data, err := json.Marshal(canvas) + if err != nil { + t.Fatalf("failed to marshal CanvasDeclaration: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal CanvasDeclaration: %v", err) + } + + if _, present := decoded["inputSchema"]; present { + t.Errorf("expected inputSchema to be omitted for nil map, got %v", decoded["inputSchema"]) + } +} + +func TestElicitationResult_JSONIncludesEmptyContent(t *testing.T) { + result := ElicitationResult{ + Action: ElicitationActionAccept, + Content: map[string]any{}, + } + + data, err := json.Marshal(result) + if err != nil { + t.Fatalf("failed to marshal ElicitationResult: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal ElicitationResult: %v", err) + } + + rawContent, present := decoded["content"] + if !present { + t.Fatal("expected content to be present for an empty non-nil map") + } + content, ok := rawContent.(map[string]any) + if !ok { + t.Fatalf("expected content object, got %T", rawContent) + } + if len(content) != 0 { + t.Fatalf("expected empty content object, got %v", content) + } +} + +func TestElicitationResult_JSONOmitsNilContent(t *testing.T) { + result := ElicitationResult{Action: ElicitationActionCancel} + + data, err := json.Marshal(result) + if err != nil { + t.Fatalf("failed to marshal ElicitationResult: %v", err) + } + + var decoded map[string]any + if err := json.Unmarshal(data, &decoded); err != nil { + t.Fatalf("failed to unmarshal ElicitationResult: %v", err) + } + + if _, present := decoded["content"]; present { + t.Errorf("expected content to be omitted for nil map, got %v", decoded["content"]) + } } diff --git a/go/zsession_events.go b/go/zsession_events.go index cb7a10b22..48ad42849 100644 --- a/go/zsession_events.go +++ b/go/zsession_events.go @@ -9,32 +9,76 @@ import "github.com/github/copilot-sdk/go/rpc" type ( AbortData = rpc.AbortData AbortReason = rpc.AbortReason + AssistantIdleData = rpc.AssistantIdleData AssistantIntentData = rpc.AssistantIntentData AssistantMessageData = rpc.AssistantMessageData AssistantMessageDeltaData = rpc.AssistantMessageDeltaData + AssistantMessageServerTools = rpc.AssistantMessageServerTools AssistantMessageStartData = rpc.AssistantMessageStartData AssistantMessageToolRequest = rpc.AssistantMessageToolRequest AssistantMessageToolRequestType = rpc.AssistantMessageToolRequestType AssistantReasoningData = rpc.AssistantReasoningData AssistantReasoningDeltaData = rpc.AssistantReasoningDeltaData + AssistantServerToolProgressData = rpc.AssistantServerToolProgressData AssistantStreamingDeltaData = rpc.AssistantStreamingDeltaData + AssistantToolCallDeltaData = rpc.AssistantToolCallDeltaData AssistantTurnEndData = rpc.AssistantTurnEndData + AssistantTurnRetryData = rpc.AssistantTurnRetryData AssistantTurnStartData = rpc.AssistantTurnStartData AssistantUsageAPIEndpoint = rpc.AssistantUsageAPIEndpoint + AssistantUsageCopilotUsage = rpc.AssistantUsageCopilotUsage AssistantUsageCopilotUsageTokenDetail = rpc.AssistantUsageCopilotUsageTokenDetail AssistantUsageData = rpc.AssistantUsageData Attachment = rpc.Attachment + AttachmentBlob = rpc.AttachmentBlob + AttachmentDirectory = rpc.AttachmentDirectory + AttachmentExtensionContext = rpc.AttachmentExtensionContext + AttachmentFile = rpc.AttachmentFile + AttachmentFileLineRange = rpc.AttachmentFileLineRange + AttachmentGitHubActionsJob = rpc.AttachmentGitHubActionsJob + AttachmentGitHubCommit = rpc.AttachmentGitHubCommit + AttachmentGitHubFile = rpc.AttachmentGitHubFile + AttachmentGitHubFileDiff = rpc.AttachmentGitHubFileDiff + AttachmentGitHubFileDiffSide = rpc.AttachmentGitHubFileDiffSide + AttachmentGitHubReference = rpc.AttachmentGitHubReference + AttachmentGitHubReferenceType = rpc.AttachmentGitHubReferenceType + AttachmentGitHubRelease = rpc.AttachmentGitHubRelease + AttachmentGitHubRepository = rpc.AttachmentGitHubRepository + AttachmentGitHubSnippet = rpc.AttachmentGitHubSnippet + AttachmentGitHubTreeComparison = rpc.AttachmentGitHubTreeComparison + AttachmentGitHubTreeComparisonSide = rpc.AttachmentGitHubTreeComparisonSide + AttachmentGitHubURL = rpc.AttachmentGitHubURL + AttachmentSelection = rpc.AttachmentSelection + AttachmentSelectionDetails = rpc.AttachmentSelectionDetails + AttachmentSelectionDetailsEnd = rpc.AttachmentSelectionDetailsEnd + AttachmentSelectionDetailsStart = rpc.AttachmentSelectionDetailsStart AttachmentType = rpc.AttachmentType + AutoApprovalJudgeFailureReason = rpc.AutoApprovalJudgeFailureReason + AutoApprovalRecommendation = rpc.AutoApprovalRecommendation + AutoModeResolvedReasoningBucket = rpc.AutoModeResolvedReasoningBucket AutoModeSwitchCompletedData = rpc.AutoModeSwitchCompletedData AutoModeSwitchRequestedData = rpc.AutoModeSwitchRequestedData AutoModeSwitchResponse = rpc.AutoModeSwitchResponse AutopilotObjectiveChangedOperation = rpc.AutopilotObjectiveChangedOperation AutopilotObjectiveChangedStatus = rpc.AutopilotObjectiveChangedStatus - CanvasOpenedAvailability = rpc.CanvasOpenedAvailability + BinaryAssetReference = rpc.BinaryAssetReference + BinaryAssetReferenceType = rpc.BinaryAssetReferenceType + BinaryAssetType = rpc.BinaryAssetType CanvasRegistryChangedCanvas = rpc.CanvasRegistryChangedCanvas CanvasRegistryChangedCanvasAction = rpc.CanvasRegistryChangedCanvasAction CapabilitiesChangedData = rpc.CapabilitiesChangedData CapabilitiesChangedUI = rpc.CapabilitiesChangedUI + CitableSource = rpc.CitableSource + CitationLocation = rpc.CitationLocation + CitationLocationBlock = rpc.CitationLocationBlock + CitationLocationChar = rpc.CitationLocationChar + CitationLocationPage = rpc.CitationLocationPage + CitationLocationType = rpc.CitationLocationType + CitationProvider = rpc.CitationProvider + CitationReference = rpc.CitationReference + Citations = rpc.Citations + CitationSource = rpc.CitationSource + CitationSpan = rpc.CitationSpan CommandCompletedData = rpc.CommandCompletedData CommandExecuteData = rpc.CommandExecuteData CommandQueuedData = rpc.CommandQueuedData @@ -42,15 +86,11 @@ type ( CommandsChangedData = rpc.CommandsChangedData CompactionCompleteCompactionTokensUsed = rpc.CompactionCompleteCompactionTokensUsed CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail = rpc.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail + CompactionTrigger = rpc.CompactionTrigger + ContextTier = rpc.ContextTier CustomAgentsUpdatedAgent = rpc.CustomAgentsUpdatedAgent - CustomNotificationPayload = rpc.CustomNotificationPayload ElicitationCompletedAction = rpc.ElicitationCompletedAction - ElicitationCompletedBooleanContent = rpc.ElicitationCompletedBooleanContent - ElicitationCompletedContent = rpc.ElicitationCompletedContent ElicitationCompletedData = rpc.ElicitationCompletedData - ElicitationCompletedNumberContent = rpc.ElicitationCompletedNumberContent - ElicitationCompletedStringArrayContent = rpc.ElicitationCompletedStringArrayContent - ElicitationCompletedStringContent = rpc.ElicitationCompletedStringContent ElicitationRequestedData = rpc.ElicitationRequestedData ElicitationRequestedMode = rpc.ElicitationRequestedMode ElicitationRequestedSchema = rpc.ElicitationRequestedSchema @@ -65,30 +105,59 @@ type ( ExtensionsLoadedExtensionStatus = rpc.ExtensionsLoadedExtensionStatus ExternalToolCompletedData = rpc.ExternalToolCompletedData ExternalToolRequestedData = rpc.ExternalToolRequestedData + FactoryPermissionOperation = rpc.FactoryPermissionOperation + FactoryPermissionPhase = rpc.FactoryPermissionPhase + FactoryRunUpdatedData = rpc.FactoryRunUpdatedData + GitHubRepoRef = rpc.GitHubRepoRef HandoffRepository = rpc.HandoffRepository HandoffSourceType = rpc.HandoffSourceType + HeaderEntry = rpc.HeaderEntry HookEndData = rpc.HookEndData HookEndError = rpc.HookEndError HookProgressData = rpc.HookProgressData HookStartData = rpc.HookStartData - McpAppToolCallCompleteData = rpc.McpAppToolCallCompleteData - McpAppToolCallCompleteError = rpc.McpAppToolCallCompleteError - McpAppToolCallCompleteToolMeta = rpc.McpAppToolCallCompleteToolMeta - McpAppToolCallCompleteToolMetaUI = rpc.McpAppToolCallCompleteToolMetaUI - McpOauthCompletedData = rpc.McpOauthCompletedData - McpOauthRequiredData = rpc.McpOauthRequiredData - McpOauthRequiredStaticClientConfig = rpc.McpOauthRequiredStaticClientConfig - McpOauthRequiredStaticClientConfigGrantType = rpc.McpOauthRequiredStaticClientConfigGrantType - McpServersLoadedServer = rpc.McpServersLoadedServer - McpServerSource = rpc.McpServerSource - McpServerStatus = rpc.McpServerStatus - McpServerTransport = rpc.McpServerTransport + ManagedSettingsEnforcedAction = rpc.ManagedSettingsEnforcedAction + ManagedSettingsEnforcedEscalation = rpc.ManagedSettingsEnforcedEscalation + ManagedSettingsResolvedSource = rpc.ManagedSettingsResolvedSource + MCPAppToolCallCompleteData = rpc.MCPAppToolCallCompleteData + MCPAppToolCallCompleteError = rpc.MCPAppToolCallCompleteError + MCPAppToolCallCompleteToolMeta = rpc.MCPAppToolCallCompleteToolMeta + MCPAppToolCallCompleteToolMetaUI = rpc.MCPAppToolCallCompleteToolMetaUI + MCPHeadersRefreshCompletedData = rpc.MCPHeadersRefreshCompletedData + MCPHeadersRefreshCompletedOutcome = rpc.MCPHeadersRefreshCompletedOutcome + MCPHeadersRefreshRequiredData = rpc.MCPHeadersRefreshRequiredData + MCPHeadersRefreshRequiredReason = rpc.MCPHeadersRefreshRequiredReason + MCPOauthCompletedData = rpc.MCPOauthCompletedData + MCPOauthCompletionOutcome = rpc.MCPOauthCompletionOutcome + MCPOauthHTTPResponse = rpc.MCPOauthHTTPResponse + MCPOauthRequestReason = rpc.MCPOauthRequestReason + MCPOauthRequiredData = rpc.MCPOauthRequiredData + MCPOauthRequiredStaticClientConfig = rpc.MCPOauthRequiredStaticClientConfig + MCPOauthRequiredStaticClientConfigGrantType = rpc.MCPOauthRequiredStaticClientConfigGrantType + MCPOauthWwwAuthenticateParams = rpc.MCPOauthWwwAuthenticateParams + MCPPromptsListChangedData = rpc.MCPPromptsListChangedData + MCPResourcesListChangedData = rpc.MCPResourcesListChangedData + MCPServersLoadedServer = rpc.MCPServersLoadedServer + MCPServerSource = rpc.MCPServerSource + MCPServerStatus = rpc.MCPServerStatus + MCPServerTransport = rpc.MCPServerTransport + MCPToolsListChangedData = rpc.MCPToolsListChangedData + ModelCallFailureBadRequestKind = rpc.ModelCallFailureBadRequestKind ModelCallFailureData = rpc.ModelCallFailureData + ModelCallFailureKind = rpc.ModelCallFailureKind + ModelCallFailureRequestFingerprint = rpc.ModelCallFailureRequestFingerprint ModelCallFailureSource = rpc.ModelCallFailureSource + ModelCallFailureTransport = rpc.ModelCallFailureTransport + ModelCallStartData = rpc.ModelCallStartData + OmittedBinaryOmittedReason = rpc.OmittedBinaryOmittedReason + OmittedBinaryResult = rpc.OmittedBinaryResult + OmittedBinaryType = rpc.OmittedBinaryType PendingMessagesModifiedData = rpc.PendingMessagesModifiedData + PermissionAllowAllMode = rpc.PermissionAllowAllMode PermissionApproved = rpc.PermissionApproved PermissionApprovedForLocation = rpc.PermissionApprovedForLocation PermissionApprovedForSession = rpc.PermissionApprovedForSession + PermissionAutoApproval = rpc.PermissionAutoApproval PermissionCancelled = rpc.PermissionCancelled PermissionCompletedData = rpc.PermissionCompletedData PermissionDeniedByContentExclusionPolicy = rpc.PermissionDeniedByContentExclusionPolicy @@ -101,9 +170,10 @@ type ( PermissionPromptRequestCustomTool = rpc.PermissionPromptRequestCustomTool PermissionPromptRequestExtensionManagement = rpc.PermissionPromptRequestExtensionManagement PermissionPromptRequestExtensionPermissionAccess = rpc.PermissionPromptRequestExtensionPermissionAccess + PermissionPromptRequestFactory = rpc.PermissionPromptRequestFactory PermissionPromptRequestHook = rpc.PermissionPromptRequestHook PermissionPromptRequestKind = rpc.PermissionPromptRequestKind - PermissionPromptRequestMcp = rpc.PermissionPromptRequestMcp + PermissionPromptRequestMCP = rpc.PermissionPromptRequestMCP PermissionPromptRequestMemory = rpc.PermissionPromptRequestMemory PermissionPromptRequestPath = rpc.PermissionPromptRequestPath PermissionPromptRequestPathAccessKind = rpc.PermissionPromptRequestPathAccessKind @@ -116,72 +186,96 @@ type ( PermissionRequestedData = rpc.PermissionRequestedData PermissionRequestExtensionManagement = rpc.PermissionRequestExtensionManagement PermissionRequestExtensionPermissionAccess = rpc.PermissionRequestExtensionPermissionAccess + PermissionRequestFactory = rpc.PermissionRequestFactory PermissionRequestHook = rpc.PermissionRequestHook PermissionRequestKind = rpc.PermissionRequestKind - PermissionRequestMcp = rpc.PermissionRequestMcp + PermissionRequestMCP = rpc.PermissionRequestMCP PermissionRequestMemory = rpc.PermissionRequestMemory PermissionRequestMemoryAction = rpc.PermissionRequestMemoryAction PermissionRequestMemoryDirection = rpc.PermissionRequestMemoryDirection PermissionRequestRead = rpc.PermissionRequestRead PermissionRequestShell = rpc.PermissionRequestShell PermissionRequestShellCommand = rpc.PermissionRequestShellCommand + PermissionRequestShellCommandSegment = rpc.PermissionRequestShellCommandSegment PermissionRequestShellPossibleURL = rpc.PermissionRequestShellPossibleURL PermissionRequestURL = rpc.PermissionRequestURL PermissionRequestWrite = rpc.PermissionRequestWrite PermissionResult = rpc.PermissionResult PermissionResultKind = rpc.PermissionResultKind PermissionRule = rpc.PermissionRule + PersistedBinaryImage = rpc.PersistedBinaryImage + PersistedBinaryImageType = rpc.PersistedBinaryImageType + PersistedBinaryResult = rpc.PersistedBinaryResult + PersistedBinaryResultType = rpc.PersistedBinaryResultType PlanChangedOperation = rpc.PlanChangedOperation PossibleURL = rpc.PossibleURL + RawCitationLocation = rpc.RawCitationLocation RawPermissionPromptRequest = rpc.RawPermissionPromptRequest RawPermissionRequest = rpc.RawPermissionRequest RawPermissionResult = rpc.RawPermissionResult + RawPersistedBinaryResult = rpc.RawPersistedBinaryResult RawSessionEventData = rpc.RawSessionEventData RawSystemNotification = rpc.RawSystemNotification RawToolExecutionCompleteContent = rpc.RawToolExecutionCompleteContent - RawUserMessageAttachment = rpc.RawUserMessageAttachment ReasoningSummary = rpc.ReasoningSummary SamplingCompletedData = rpc.SamplingCompletedData SamplingRequestedData = rpc.SamplingRequestedData + ScheduleOrigin = rpc.ScheduleOrigin + SessionAutoModeResolvedData = rpc.SessionAutoModeResolvedData SessionAutopilotObjectiveChangedData = rpc.SessionAutopilotObjectiveChangedData SessionBackgroundTasksChangedData = rpc.SessionBackgroundTasksChangedData + SessionBinaryAssetData = rpc.SessionBinaryAssetData + SessionCanvasClosedData = rpc.SessionCanvasClosedData SessionCanvasOpenedData = rpc.SessionCanvasOpenedData + SessionCanvasRecordedData = rpc.SessionCanvasRecordedData SessionCanvasRegistryChangedData = rpc.SessionCanvasRegistryChangedData + SessionCanvasRemovedData = rpc.SessionCanvasRemovedData + SessionCanvasUnavailableData = rpc.SessionCanvasUnavailableData SessionCompactionCompleteData = rpc.SessionCompactionCompleteData SessionCompactionStartData = rpc.SessionCompactionStartData SessionContextChangedData = rpc.SessionContextChangedData + SessionContextClearedData = rpc.SessionContextClearedData SessionCustomAgentsUpdatedData = rpc.SessionCustomAgentsUpdatedData SessionCustomNotificationData = rpc.SessionCustomNotificationData SessionErrorData = rpc.SessionErrorData SessionEvent = rpc.SessionEvent SessionEventData = rpc.SessionEventData SessionEventType = rpc.SessionEventType + SessionExtensionsAttachmentsPushedData = rpc.SessionExtensionsAttachmentsPushedData SessionExtensionsLoadedData = rpc.SessionExtensionsLoadedData SessionHandoffData = rpc.SessionHandoffData SessionIdleData = rpc.SessionIdleData SessionInfoData = rpc.SessionInfoData - SessionMcpServersLoadedData = rpc.SessionMcpServersLoadedData - SessionMcpServerStatusChangedData = rpc.SessionMcpServerStatusChangedData + SessionLimitsConfig = rpc.SessionLimitsConfig + SessionLimitsExhaustedCompletedData = rpc.SessionLimitsExhaustedCompletedData + SessionLimitsExhaustedRequestedData = rpc.SessionLimitsExhaustedRequestedData + SessionLimitsExhaustedResponse = rpc.SessionLimitsExhaustedResponse + SessionLimitsExhaustedResponseAction = rpc.SessionLimitsExhaustedResponseAction + SessionManagedSettingsEnforcedData = rpc.SessionManagedSettingsEnforcedData + SessionManagedSettingsResolvedData = rpc.SessionManagedSettingsResolvedData + SessionMCPServersLoadedData = rpc.SessionMCPServersLoadedData + SessionMCPServerStatusChangedData = rpc.SessionMCPServerStatusChangedData SessionMode = rpc.SessionMode SessionModeChangedData = rpc.SessionModeChangedData SessionModelChangeData = rpc.SessionModelChangeData - SessionModelChangeDataContextTier = rpc.SessionModelChangeDataContextTier SessionPermissionsChangedData = rpc.SessionPermissionsChangedData SessionPlanChangedData = rpc.SessionPlanChangedData SessionRemoteSteerableChangedData = rpc.SessionRemoteSteerableChangedData SessionResumeData = rpc.SessionResumeData - SessionResumeDataContextTier = rpc.SessionResumeDataContextTier SessionScheduleCancelledData = rpc.SessionScheduleCancelledData SessionScheduleCreatedData = rpc.SessionScheduleCreatedData + SessionScheduleRearmedData = rpc.SessionScheduleRearmedData + SessionSessionLimitsChangedData = rpc.SessionSessionLimitsChangedData SessionShutdownData = rpc.SessionShutdownData SessionSkillsLoadedData = rpc.SessionSkillsLoadedData SessionSnapshotRewindData = rpc.SessionSnapshotRewindData SessionStartData = rpc.SessionStartData - SessionStartDataContextTier = rpc.SessionStartDataContextTier SessionTaskCompleteData = rpc.SessionTaskCompleteData SessionTitleChangedData = rpc.SessionTitleChangedData + SessionTodosChangedData = rpc.SessionTodosChangedData SessionToolsUpdatedData = rpc.SessionToolsUpdatedData SessionTruncationData = rpc.SessionTruncationData + SessionUsageCheckpointData = rpc.SessionUsageCheckpointData SessionUsageInfoData = rpc.SessionUsageInfoData SessionWarningData = rpc.SessionWarningData SessionWorkspaceFileChangedData = rpc.SessionWorkspaceFileChangedData @@ -209,11 +303,15 @@ type ( SystemNotificationAgentCompletedStatus = rpc.SystemNotificationAgentCompletedStatus SystemNotificationAgentIdle = rpc.SystemNotificationAgentIdle SystemNotificationData = rpc.SystemNotificationData + SystemNotificationFactoryCompleted = rpc.SystemNotificationFactoryCompleted + SystemNotificationFactoryCompletedStatus = rpc.SystemNotificationFactoryCompletedStatus SystemNotificationInstructionDiscovered = rpc.SystemNotificationInstructionDiscovered SystemNotificationNewInboxMessage = rpc.SystemNotificationNewInboxMessage SystemNotificationShellCompleted = rpc.SystemNotificationShellCompleted SystemNotificationShellDetachedCompleted = rpc.SystemNotificationShellDetachedCompleted SystemNotificationType = rpc.SystemNotificationType + SystemNotificationUnclassified = rpc.SystemNotificationUnclassified + TaskCompletionOutcome = rpc.TaskCompletionOutcome ToolExecutionCompleteContent = rpc.ToolExecutionCompleteContent ToolExecutionCompleteContentAudio = rpc.ToolExecutionCompleteContentAudio ToolExecutionCompleteContentImage = rpc.ToolExecutionCompleteContentImage @@ -222,6 +320,7 @@ type ( ToolExecutionCompleteContentResourceLink = rpc.ToolExecutionCompleteContentResourceLink ToolExecutionCompleteContentResourceLinkIcon = rpc.ToolExecutionCompleteContentResourceLinkIcon ToolExecutionCompleteContentResourceLinkIconTheme = rpc.ToolExecutionCompleteContentResourceLinkIconTheme + ToolExecutionCompleteContentShellExit = rpc.ToolExecutionCompleteContentShellExit ToolExecutionCompleteContentTerminal = rpc.ToolExecutionCompleteContentTerminal ToolExecutionCompleteContentText = rpc.ToolExecutionCompleteContentText ToolExecutionCompleteContentType = rpc.ToolExecutionCompleteContentType @@ -244,32 +343,30 @@ type ( ToolExecutionPartialResultData = rpc.ToolExecutionPartialResultData ToolExecutionProgressData = rpc.ToolExecutionProgressData ToolExecutionStartData = rpc.ToolExecutionStartData + ToolExecutionStartShellToolInfo = rpc.ToolExecutionStartShellToolInfo + ToolExecutionStartToolDescription = rpc.ToolExecutionStartToolDescription + ToolExecutionStartToolDescriptionMeta = rpc.ToolExecutionStartToolDescriptionMeta + ToolExecutionStartToolDescriptionMetaUI = rpc.ToolExecutionStartToolDescriptionMetaUI + ToolExecutionStartToolDescriptionMetaUIVisibility = rpc.ToolExecutionStartToolDescriptionMetaUIVisibility + ToolSearchActivatedData = rpc.ToolSearchActivatedData ToolUserRequestedData = rpc.ToolUserRequestedData UserInputCompletedData = rpc.UserInputCompletedData UserInputRequestedData = rpc.UserInputRequestedData UserMessageAgentMode = rpc.UserMessageAgentMode - UserMessageAttachment = rpc.UserMessageAttachment - UserMessageAttachmentBlob = rpc.UserMessageAttachmentBlob - UserMessageAttachmentDirectory = rpc.UserMessageAttachmentDirectory - UserMessageAttachmentFile = rpc.UserMessageAttachmentFile - UserMessageAttachmentFileLineRange = rpc.UserMessageAttachmentFileLineRange - UserMessageAttachmentGithubReference = rpc.UserMessageAttachmentGithubReference - UserMessageAttachmentGithubReferenceType = rpc.UserMessageAttachmentGithubReferenceType - UserMessageAttachmentSelection = rpc.UserMessageAttachmentSelection - UserMessageAttachmentSelectionDetails = rpc.UserMessageAttachmentSelectionDetails - UserMessageAttachmentSelectionDetailsEnd = rpc.UserMessageAttachmentSelectionDetailsEnd - UserMessageAttachmentSelectionDetailsStart = rpc.UserMessageAttachmentSelectionDetailsStart - UserMessageAttachmentType = rpc.UserMessageAttachmentType UserMessageData = rpc.UserMessageData + UserMessageDelivery = rpc.UserMessageDelivery UserToolSessionApproval = rpc.UserToolSessionApproval UserToolSessionApprovalCommands = rpc.UserToolSessionApprovalCommands UserToolSessionApprovalCustomTool = rpc.UserToolSessionApprovalCustomTool UserToolSessionApprovalExtensionManagement = rpc.UserToolSessionApprovalExtensionManagement UserToolSessionApprovalExtensionPermissionAccess = rpc.UserToolSessionApprovalExtensionPermissionAccess - UserToolSessionApprovalMcp = rpc.UserToolSessionApprovalMcp + UserToolSessionApprovalFactory = rpc.UserToolSessionApprovalFactory + UserToolSessionApprovalKind = rpc.UserToolSessionApprovalKind + UserToolSessionApprovalMCP = rpc.UserToolSessionApprovalMCP UserToolSessionApprovalMemory = rpc.UserToolSessionApprovalMemory UserToolSessionApprovalRead = rpc.UserToolSessionApprovalRead UserToolSessionApprovalWrite = rpc.UserToolSessionApprovalWrite + Verbosity = rpc.Verbosity WorkingDirectoryContext = rpc.WorkingDirectoryContext WorkingDirectoryContextHostType = rpc.WorkingDirectoryContextHostType WorkspaceFileChangedOperation = rpc.WorkspaceFileChangedOperation @@ -277,6 +374,7 @@ type ( // Session-event constants are generated in the rpc package and re-exported here for source compatibility. const ( + AbortReasonAutopilotCreditLimit = rpc.AbortReasonAutopilotCreditLimit AbortReasonRemoteCommand = rpc.AbortReasonRemoteCommand AbortReasonUserAbort = rpc.AbortReasonUserAbort AbortReasonUserInitiated = rpc.AbortReasonUserInitiated @@ -286,11 +384,36 @@ const ( AssistantUsageAPIEndpointResponses = rpc.AssistantUsageAPIEndpointResponses AssistantUsageAPIEndpointV1Messages = rpc.AssistantUsageAPIEndpointV1Messages AssistantUsageAPIEndpointWsResponses = rpc.AssistantUsageAPIEndpointWsResponses + AttachmentGitHubReferenceTypeDiscussion = rpc.AttachmentGitHubReferenceTypeDiscussion + AttachmentGitHubReferenceTypeIssue = rpc.AttachmentGitHubReferenceTypeIssue + AttachmentGitHubReferenceTypePr = rpc.AttachmentGitHubReferenceTypePr AttachmentTypeBlob = rpc.AttachmentTypeBlob AttachmentTypeDirectory = rpc.AttachmentTypeDirectory + AttachmentTypeExtensionContext = rpc.AttachmentTypeExtensionContext AttachmentTypeFile = rpc.AttachmentTypeFile - AttachmentTypeGithubReference = rpc.AttachmentTypeGithubReference + AttachmentTypeGitHubActionsJob = rpc.AttachmentTypeGitHubActionsJob + AttachmentTypeGitHubCommit = rpc.AttachmentTypeGitHubCommit + AttachmentTypeGitHubFile = rpc.AttachmentTypeGitHubFile + AttachmentTypeGitHubFileDiff = rpc.AttachmentTypeGitHubFileDiff + AttachmentTypeGitHubReference = rpc.AttachmentTypeGitHubReference + AttachmentTypeGitHubRelease = rpc.AttachmentTypeGitHubRelease + AttachmentTypeGitHubRepository = rpc.AttachmentTypeGitHubRepository + AttachmentTypeGitHubSnippet = rpc.AttachmentTypeGitHubSnippet + AttachmentTypeGitHubTreeComparison = rpc.AttachmentTypeGitHubTreeComparison + AttachmentTypeGitHubURL = rpc.AttachmentTypeGitHubURL AttachmentTypeSelection = rpc.AttachmentTypeSelection + AutoApprovalJudgeFailureReasonAbort = rpc.AutoApprovalJudgeFailureReasonAbort + AutoApprovalJudgeFailureReasonEmptyResponse = rpc.AutoApprovalJudgeFailureReasonEmptyResponse + AutoApprovalJudgeFailureReasonModelError = rpc.AutoApprovalJudgeFailureReasonModelError + AutoApprovalJudgeFailureReasonParseError = rpc.AutoApprovalJudgeFailureReasonParseError + AutoApprovalJudgeFailureReasonTimeout = rpc.AutoApprovalJudgeFailureReasonTimeout + AutoApprovalRecommendationApprove = rpc.AutoApprovalRecommendationApprove + AutoApprovalRecommendationError = rpc.AutoApprovalRecommendationError + AutoApprovalRecommendationExcluded = rpc.AutoApprovalRecommendationExcluded + AutoApprovalRecommendationRequireApproval = rpc.AutoApprovalRecommendationRequireApproval + AutoModeResolvedReasoningBucketHigh = rpc.AutoModeResolvedReasoningBucketHigh + AutoModeResolvedReasoningBucketLow = rpc.AutoModeResolvedReasoningBucketLow + AutoModeResolvedReasoningBucketMedium = rpc.AutoModeResolvedReasoningBucketMedium AutoModeSwitchResponseNo = rpc.AutoModeSwitchResponseNo AutoModeSwitchResponseYes = rpc.AutoModeSwitchResponseYes AutoModeSwitchResponseYesAlways = rpc.AutoModeSwitchResponseYesAlways @@ -301,8 +424,23 @@ const ( AutopilotObjectiveChangedStatusCapReached = rpc.AutopilotObjectiveChangedStatusCapReached AutopilotObjectiveChangedStatusCompleted = rpc.AutopilotObjectiveChangedStatusCompleted AutopilotObjectiveChangedStatusPaused = rpc.AutopilotObjectiveChangedStatusPaused - CanvasOpenedAvailabilityReady = rpc.CanvasOpenedAvailabilityReady - CanvasOpenedAvailabilityStale = rpc.CanvasOpenedAvailabilityStale + BinaryAssetReferenceTypeImage = rpc.BinaryAssetReferenceTypeImage + BinaryAssetReferenceTypeResource = rpc.BinaryAssetReferenceTypeResource + BinaryAssetTypeImage = rpc.BinaryAssetTypeImage + BinaryAssetTypeResource = rpc.BinaryAssetTypeResource + CitationLocationTypeBlock = rpc.CitationLocationTypeBlock + CitationLocationTypeChar = rpc.CitationLocationTypeChar + CitationLocationTypePage = rpc.CitationLocationTypePage + CitationProviderAnthropic = rpc.CitationProviderAnthropic + CitationProviderClient = rpc.CitationProviderClient + CitationProviderOpenai = rpc.CitationProviderOpenai + CompactionTriggerContextLimitRetry = rpc.CompactionTriggerContextLimitRetry + CompactionTriggerManual = rpc.CompactionTriggerManual + CompactionTriggerMemoryPressure = rpc.CompactionTriggerMemoryPressure + CompactionTriggerModelSwitch = rpc.CompactionTriggerModelSwitch + CompactionTriggerThreshold = rpc.CompactionTriggerThreshold + ContextTierDefault = rpc.ContextTierDefault + ContextTierLongContext = rpc.ContextTierLongContext ElicitationCompletedActionAccept = rpc.ElicitationCompletedActionAccept ElicitationCompletedActionCancel = rpc.ElicitationCompletedActionCancel ElicitationCompletedActionDecline = rpc.ElicitationCompletedActionDecline @@ -313,38 +451,80 @@ const ( ExitPlanModeActionAutopilotFleet = rpc.ExitPlanModeActionAutopilotFleet ExitPlanModeActionExitOnly = rpc.ExitPlanModeActionExitOnly ExitPlanModeActionInteractive = rpc.ExitPlanModeActionInteractive + ExtensionsLoadedExtensionSourcePlugin = rpc.ExtensionsLoadedExtensionSourcePlugin ExtensionsLoadedExtensionSourceProject = rpc.ExtensionsLoadedExtensionSourceProject + ExtensionsLoadedExtensionSourceSession = rpc.ExtensionsLoadedExtensionSourceSession ExtensionsLoadedExtensionSourceUser = rpc.ExtensionsLoadedExtensionSourceUser ExtensionsLoadedExtensionStatusDisabled = rpc.ExtensionsLoadedExtensionStatusDisabled ExtensionsLoadedExtensionStatusFailed = rpc.ExtensionsLoadedExtensionStatusFailed ExtensionsLoadedExtensionStatusRunning = rpc.ExtensionsLoadedExtensionStatusRunning ExtensionsLoadedExtensionStatusStarting = rpc.ExtensionsLoadedExtensionStatusStarting + FactoryPermissionOperationAuthor = rpc.FactoryPermissionOperationAuthor + FactoryPermissionOperationRun = rpc.FactoryPermissionOperationRun HandoffSourceTypeLocal = rpc.HandoffSourceTypeLocal HandoffSourceTypeRemote = rpc.HandoffSourceTypeRemote - McpOauthRequiredStaticClientConfigGrantTypeClientCredentials = rpc.McpOauthRequiredStaticClientConfigGrantTypeClientCredentials - McpServerSourceBuiltin = rpc.McpServerSourceBuiltin - McpServerSourcePlugin = rpc.McpServerSourcePlugin - McpServerSourceUser = rpc.McpServerSourceUser - McpServerSourceWorkspace = rpc.McpServerSourceWorkspace - McpServerStatusConnected = rpc.McpServerStatusConnected - McpServerStatusDisabled = rpc.McpServerStatusDisabled - McpServerStatusFailed = rpc.McpServerStatusFailed - McpServerStatusNeedsAuth = rpc.McpServerStatusNeedsAuth - McpServerStatusNotConfigured = rpc.McpServerStatusNotConfigured - McpServerStatusPending = rpc.McpServerStatusPending - McpServerTransportHTTP = rpc.McpServerTransportHTTP - McpServerTransportMemory = rpc.McpServerTransportMemory - McpServerTransportSse = rpc.McpServerTransportSse - McpServerTransportStdio = rpc.McpServerTransportStdio - ModelCallFailureSourceMcpSampling = rpc.ModelCallFailureSourceMcpSampling + ManagedSettingsEnforcedActionBypassPermissionsBlocked = rpc.ManagedSettingsEnforcedActionBypassPermissionsBlocked + ManagedSettingsEnforcedEscalationAllowAll = rpc.ManagedSettingsEnforcedEscalationAllowAll + ManagedSettingsEnforcedEscalationApproveAll = rpc.ManagedSettingsEnforcedEscalationApproveAll + ManagedSettingsEnforcedEscalationAutoApproval = rpc.ManagedSettingsEnforcedEscalationAutoApproval + ManagedSettingsEnforcedEscalationUnrestrictedPaths = rpc.ManagedSettingsEnforcedEscalationUnrestrictedPaths + ManagedSettingsEnforcedEscalationUnrestrictedURLs = rpc.ManagedSettingsEnforcedEscalationUnrestrictedURLs + ManagedSettingsResolvedSourceClient = rpc.ManagedSettingsResolvedSourceClient + ManagedSettingsResolvedSourceDevice = rpc.ManagedSettingsResolvedSourceDevice + ManagedSettingsResolvedSourceMixed = rpc.ManagedSettingsResolvedSourceMixed + ManagedSettingsResolvedSourceNone = rpc.ManagedSettingsResolvedSourceNone + ManagedSettingsResolvedSourceServer = rpc.ManagedSettingsResolvedSourceServer + MCPHeadersRefreshCompletedOutcomeHeaders = rpc.MCPHeadersRefreshCompletedOutcomeHeaders + MCPHeadersRefreshCompletedOutcomeNone = rpc.MCPHeadersRefreshCompletedOutcomeNone + MCPHeadersRefreshCompletedOutcomeTimeout = rpc.MCPHeadersRefreshCompletedOutcomeTimeout + MCPHeadersRefreshRequiredReasonAuthFailed = rpc.MCPHeadersRefreshRequiredReasonAuthFailed + MCPHeadersRefreshRequiredReasonStartup = rpc.MCPHeadersRefreshRequiredReasonStartup + MCPHeadersRefreshRequiredReasonTtlExpired = rpc.MCPHeadersRefreshRequiredReasonTtlExpired + MCPOauthCompletionOutcomeCancelled = rpc.MCPOauthCompletionOutcomeCancelled + MCPOauthCompletionOutcomeToken = rpc.MCPOauthCompletionOutcomeToken + MCPOauthRequestReasonInitial = rpc.MCPOauthRequestReasonInitial + MCPOauthRequestReasonReauth = rpc.MCPOauthRequestReasonReauth + MCPOauthRequestReasonRefresh = rpc.MCPOauthRequestReasonRefresh + MCPOauthRequestReasonUpscope = rpc.MCPOauthRequestReasonUpscope + MCPOauthRequiredStaticClientConfigGrantTypeClientCredentials = rpc.MCPOauthRequiredStaticClientConfigGrantTypeClientCredentials + MCPServerSourceBuiltin = rpc.MCPServerSourceBuiltin + MCPServerSourcePlugin = rpc.MCPServerSourcePlugin + MCPServerSourceUser = rpc.MCPServerSourceUser + MCPServerSourceWorkspace = rpc.MCPServerSourceWorkspace + MCPServerStatusConnected = rpc.MCPServerStatusConnected + MCPServerStatusDisabled = rpc.MCPServerStatusDisabled + MCPServerStatusFailed = rpc.MCPServerStatusFailed + MCPServerStatusNeedsAuth = rpc.MCPServerStatusNeedsAuth + MCPServerStatusNotConfigured = rpc.MCPServerStatusNotConfigured + MCPServerStatusPending = rpc.MCPServerStatusPending + MCPServerStatusStopped = rpc.MCPServerStatusStopped + MCPServerTransportHTTP = rpc.MCPServerTransportHTTP + MCPServerTransportMemory = rpc.MCPServerTransportMemory + MCPServerTransportSSE = rpc.MCPServerTransportSSE + MCPServerTransportStdio = rpc.MCPServerTransportStdio + ModelCallFailureBadRequestKindBodyless = rpc.ModelCallFailureBadRequestKindBodyless + ModelCallFailureBadRequestKindStructuredError = rpc.ModelCallFailureBadRequestKindStructuredError + ModelCallFailureKindAPI = rpc.ModelCallFailureKindAPI + ModelCallFailureKindTransport = rpc.ModelCallFailureKindTransport + ModelCallFailureSourceMCPSampling = rpc.ModelCallFailureSourceMCPSampling ModelCallFailureSourceSubagent = rpc.ModelCallFailureSourceSubagent ModelCallFailureSourceTopLevel = rpc.ModelCallFailureSourceTopLevel + ModelCallFailureTransportHTTP = rpc.ModelCallFailureTransportHTTP + ModelCallFailureTransportWebsocket = rpc.ModelCallFailureTransportWebsocket + OmittedBinaryOmittedReasonAssetUnavailable = rpc.OmittedBinaryOmittedReasonAssetUnavailable + OmittedBinaryOmittedReasonTooLarge = rpc.OmittedBinaryOmittedReasonTooLarge + OmittedBinaryTypeImage = rpc.OmittedBinaryTypeImage + OmittedBinaryTypeResource = rpc.OmittedBinaryTypeResource + PermissionAllowAllModeAuto = rpc.PermissionAllowAllModeAuto + PermissionAllowAllModeOff = rpc.PermissionAllowAllModeOff + PermissionAllowAllModeOn = rpc.PermissionAllowAllModeOn PermissionPromptRequestKindCommands = rpc.PermissionPromptRequestKindCommands PermissionPromptRequestKindCustomTool = rpc.PermissionPromptRequestKindCustomTool PermissionPromptRequestKindExtensionManagement = rpc.PermissionPromptRequestKindExtensionManagement PermissionPromptRequestKindExtensionPermissionAccess = rpc.PermissionPromptRequestKindExtensionPermissionAccess + PermissionPromptRequestKindFactory = rpc.PermissionPromptRequestKindFactory PermissionPromptRequestKindHook = rpc.PermissionPromptRequestKindHook - PermissionPromptRequestKindMcp = rpc.PermissionPromptRequestKindMcp + PermissionPromptRequestKindMCP = rpc.PermissionPromptRequestKindMCP PermissionPromptRequestKindMemory = rpc.PermissionPromptRequestKindMemory PermissionPromptRequestKindPath = rpc.PermissionPromptRequestKindPath PermissionPromptRequestKindRead = rpc.PermissionPromptRequestKindRead @@ -356,8 +536,9 @@ const ( PermissionRequestKindCustomTool = rpc.PermissionRequestKindCustomTool PermissionRequestKindExtensionManagement = rpc.PermissionRequestKindExtensionManagement PermissionRequestKindExtensionPermissionAccess = rpc.PermissionRequestKindExtensionPermissionAccess + PermissionRequestKindFactory = rpc.PermissionRequestKindFactory PermissionRequestKindHook = rpc.PermissionRequestKindHook - PermissionRequestKindMcp = rpc.PermissionRequestKindMcp + PermissionRequestKindMCP = rpc.PermissionRequestKindMCP PermissionRequestKindMemory = rpc.PermissionRequestKindMemory PermissionRequestKindRead = rpc.PermissionRequestKindRead PermissionRequestKindShell = rpc.PermissionRequestKindShell @@ -376,21 +557,31 @@ const ( PermissionResultKindDeniedByRules = rpc.PermissionResultKindDeniedByRules PermissionResultKindDeniedInteractivelyByUser = rpc.PermissionResultKindDeniedInteractivelyByUser PermissionResultKindDeniedNoApprovalRuleAndCouldNotRequestFromUser = rpc.PermissionResultKindDeniedNoApprovalRuleAndCouldNotRequestFromUser + PersistedBinaryImageTypeImage = rpc.PersistedBinaryImageTypeImage + PersistedBinaryImageTypeResource = rpc.PersistedBinaryImageTypeResource + PersistedBinaryResultTypeImage = rpc.PersistedBinaryResultTypeImage + PersistedBinaryResultTypeResource = rpc.PersistedBinaryResultTypeResource PlanChangedOperationCreate = rpc.PlanChangedOperationCreate PlanChangedOperationDelete = rpc.PlanChangedOperationDelete PlanChangedOperationUpdate = rpc.PlanChangedOperationUpdate ReasoningSummaryConcise = rpc.ReasoningSummaryConcise ReasoningSummaryDetailed = rpc.ReasoningSummaryDetailed ReasoningSummaryNone = rpc.ReasoningSummaryNone + ScheduleOriginModel = rpc.ScheduleOriginModel + ScheduleOriginUser = rpc.ScheduleOriginUser SessionEventTypeAbort = rpc.SessionEventTypeAbort + SessionEventTypeAssistantIdle = rpc.SessionEventTypeAssistantIdle SessionEventTypeAssistantIntent = rpc.SessionEventTypeAssistantIntent SessionEventTypeAssistantMessage = rpc.SessionEventTypeAssistantMessage SessionEventTypeAssistantMessageDelta = rpc.SessionEventTypeAssistantMessageDelta SessionEventTypeAssistantMessageStart = rpc.SessionEventTypeAssistantMessageStart SessionEventTypeAssistantReasoning = rpc.SessionEventTypeAssistantReasoning SessionEventTypeAssistantReasoningDelta = rpc.SessionEventTypeAssistantReasoningDelta + SessionEventTypeAssistantServerToolProgress = rpc.SessionEventTypeAssistantServerToolProgress SessionEventTypeAssistantStreamingDelta = rpc.SessionEventTypeAssistantStreamingDelta + SessionEventTypeAssistantToolCallDelta = rpc.SessionEventTypeAssistantToolCallDelta SessionEventTypeAssistantTurnEnd = rpc.SessionEventTypeAssistantTurnEnd + SessionEventTypeAssistantTurnRetry = rpc.SessionEventTypeAssistantTurnRetry SessionEventTypeAssistantTurnStart = rpc.SessionEventTypeAssistantTurnStart SessionEventTypeAssistantUsage = rpc.SessionEventTypeAssistantUsage SessionEventTypeAutoModeSwitchCompleted = rpc.SessionEventTypeAutoModeSwitchCompleted @@ -406,34 +597,53 @@ const ( SessionEventTypeExitPlanModeRequested = rpc.SessionEventTypeExitPlanModeRequested SessionEventTypeExternalToolCompleted = rpc.SessionEventTypeExternalToolCompleted SessionEventTypeExternalToolRequested = rpc.SessionEventTypeExternalToolRequested + SessionEventTypeFactoryRunUpdated = rpc.SessionEventTypeFactoryRunUpdated SessionEventTypeHookEnd = rpc.SessionEventTypeHookEnd SessionEventTypeHookProgress = rpc.SessionEventTypeHookProgress SessionEventTypeHookStart = rpc.SessionEventTypeHookStart - SessionEventTypeMcpAppToolCallComplete = rpc.SessionEventTypeMcpAppToolCallComplete - SessionEventTypeMcpOauthCompleted = rpc.SessionEventTypeMcpOauthCompleted - SessionEventTypeMcpOauthRequired = rpc.SessionEventTypeMcpOauthRequired + SessionEventTypeMCPAppToolCallComplete = rpc.SessionEventTypeMCPAppToolCallComplete + SessionEventTypeMCPHeadersRefreshCompleted = rpc.SessionEventTypeMCPHeadersRefreshCompleted + SessionEventTypeMCPHeadersRefreshRequired = rpc.SessionEventTypeMCPHeadersRefreshRequired + SessionEventTypeMCPOauthCompleted = rpc.SessionEventTypeMCPOauthCompleted + SessionEventTypeMCPOauthRequired = rpc.SessionEventTypeMCPOauthRequired + SessionEventTypeMCPPromptsListChanged = rpc.SessionEventTypeMCPPromptsListChanged + SessionEventTypeMCPResourcesListChanged = rpc.SessionEventTypeMCPResourcesListChanged + SessionEventTypeMCPToolsListChanged = rpc.SessionEventTypeMCPToolsListChanged SessionEventTypeModelCallFailure = rpc.SessionEventTypeModelCallFailure + SessionEventTypeModelCallStart = rpc.SessionEventTypeModelCallStart SessionEventTypePendingMessagesModified = rpc.SessionEventTypePendingMessagesModified SessionEventTypePermissionCompleted = rpc.SessionEventTypePermissionCompleted SessionEventTypePermissionRequested = rpc.SessionEventTypePermissionRequested SessionEventTypeSamplingCompleted = rpc.SessionEventTypeSamplingCompleted SessionEventTypeSamplingRequested = rpc.SessionEventTypeSamplingRequested + SessionEventTypeSessionAutoModeResolved = rpc.SessionEventTypeSessionAutoModeResolved SessionEventTypeSessionAutopilotObjectiveChanged = rpc.SessionEventTypeSessionAutopilotObjectiveChanged SessionEventTypeSessionBackgroundTasksChanged = rpc.SessionEventTypeSessionBackgroundTasksChanged + SessionEventTypeSessionBinaryAsset = rpc.SessionEventTypeSessionBinaryAsset + SessionEventTypeSessionCanvasClosed = rpc.SessionEventTypeSessionCanvasClosed SessionEventTypeSessionCanvasOpened = rpc.SessionEventTypeSessionCanvasOpened + SessionEventTypeSessionCanvasRecorded = rpc.SessionEventTypeSessionCanvasRecorded SessionEventTypeSessionCanvasRegistryChanged = rpc.SessionEventTypeSessionCanvasRegistryChanged + SessionEventTypeSessionCanvasRemoved = rpc.SessionEventTypeSessionCanvasRemoved + SessionEventTypeSessionCanvasUnavailable = rpc.SessionEventTypeSessionCanvasUnavailable SessionEventTypeSessionCompactionComplete = rpc.SessionEventTypeSessionCompactionComplete SessionEventTypeSessionCompactionStart = rpc.SessionEventTypeSessionCompactionStart SessionEventTypeSessionContextChanged = rpc.SessionEventTypeSessionContextChanged + SessionEventTypeSessionContextCleared = rpc.SessionEventTypeSessionContextCleared SessionEventTypeSessionCustomAgentsUpdated = rpc.SessionEventTypeSessionCustomAgentsUpdated SessionEventTypeSessionCustomNotification = rpc.SessionEventTypeSessionCustomNotification SessionEventTypeSessionError = rpc.SessionEventTypeSessionError + SessionEventTypeSessionExtensionsAttachmentsPushed = rpc.SessionEventTypeSessionExtensionsAttachmentsPushed SessionEventTypeSessionExtensionsLoaded = rpc.SessionEventTypeSessionExtensionsLoaded SessionEventTypeSessionHandoff = rpc.SessionEventTypeSessionHandoff SessionEventTypeSessionIdle = rpc.SessionEventTypeSessionIdle SessionEventTypeSessionInfo = rpc.SessionEventTypeSessionInfo - SessionEventTypeSessionMcpServersLoaded = rpc.SessionEventTypeSessionMcpServersLoaded - SessionEventTypeSessionMcpServerStatusChanged = rpc.SessionEventTypeSessionMcpServerStatusChanged + SessionEventTypeSessionLimitsExhaustedCompleted = rpc.SessionEventTypeSessionLimitsExhaustedCompleted + SessionEventTypeSessionLimitsExhaustedRequested = rpc.SessionEventTypeSessionLimitsExhaustedRequested + SessionEventTypeSessionManagedSettingsEnforced = rpc.SessionEventTypeSessionManagedSettingsEnforced + SessionEventTypeSessionManagedSettingsResolved = rpc.SessionEventTypeSessionManagedSettingsResolved + SessionEventTypeSessionMCPServersLoaded = rpc.SessionEventTypeSessionMCPServersLoaded + SessionEventTypeSessionMCPServerStatusChanged = rpc.SessionEventTypeSessionMCPServerStatusChanged SessionEventTypeSessionModeChanged = rpc.SessionEventTypeSessionModeChanged SessionEventTypeSessionModelChange = rpc.SessionEventTypeSessionModelChange SessionEventTypeSessionPermissionsChanged = rpc.SessionEventTypeSessionPermissionsChanged @@ -442,14 +652,18 @@ const ( SessionEventTypeSessionResume = rpc.SessionEventTypeSessionResume SessionEventTypeSessionScheduleCancelled = rpc.SessionEventTypeSessionScheduleCancelled SessionEventTypeSessionScheduleCreated = rpc.SessionEventTypeSessionScheduleCreated + SessionEventTypeSessionScheduleRearmed = rpc.SessionEventTypeSessionScheduleRearmed + SessionEventTypeSessionSessionLimitsChanged = rpc.SessionEventTypeSessionSessionLimitsChanged SessionEventTypeSessionShutdown = rpc.SessionEventTypeSessionShutdown SessionEventTypeSessionSkillsLoaded = rpc.SessionEventTypeSessionSkillsLoaded SessionEventTypeSessionSnapshotRewind = rpc.SessionEventTypeSessionSnapshotRewind SessionEventTypeSessionStart = rpc.SessionEventTypeSessionStart SessionEventTypeSessionTaskComplete = rpc.SessionEventTypeSessionTaskComplete SessionEventTypeSessionTitleChanged = rpc.SessionEventTypeSessionTitleChanged + SessionEventTypeSessionTodosChanged = rpc.SessionEventTypeSessionTodosChanged SessionEventTypeSessionToolsUpdated = rpc.SessionEventTypeSessionToolsUpdated SessionEventTypeSessionTruncation = rpc.SessionEventTypeSessionTruncation + SessionEventTypeSessionUsageCheckpoint = rpc.SessionEventTypeSessionUsageCheckpoint SessionEventTypeSessionUsageInfo = rpc.SessionEventTypeSessionUsageInfo SessionEventTypeSessionWarning = rpc.SessionEventTypeSessionWarning SessionEventTypeSessionWorkspaceFileChanged = rpc.SessionEventTypeSessionWorkspaceFileChanged @@ -465,19 +679,18 @@ const ( SessionEventTypeToolExecutionPartialResult = rpc.SessionEventTypeToolExecutionPartialResult SessionEventTypeToolExecutionProgress = rpc.SessionEventTypeToolExecutionProgress SessionEventTypeToolExecutionStart = rpc.SessionEventTypeToolExecutionStart + SessionEventTypeToolSearchActivated = rpc.SessionEventTypeToolSearchActivated SessionEventTypeToolUserRequested = rpc.SessionEventTypeToolUserRequested SessionEventTypeUserInputCompleted = rpc.SessionEventTypeUserInputCompleted SessionEventTypeUserInputRequested = rpc.SessionEventTypeUserInputRequested SessionEventTypeUserMessage = rpc.SessionEventTypeUserMessage + SessionLimitsExhaustedResponseActionAdd = rpc.SessionLimitsExhaustedResponseActionAdd + SessionLimitsExhaustedResponseActionCancel = rpc.SessionLimitsExhaustedResponseActionCancel + SessionLimitsExhaustedResponseActionSet = rpc.SessionLimitsExhaustedResponseActionSet + SessionLimitsExhaustedResponseActionUnset = rpc.SessionLimitsExhaustedResponseActionUnset SessionModeAutopilot = rpc.SessionModeAutopilot SessionModeInteractive = rpc.SessionModeInteractive - SessionModelChangeDataContextTierDefault = rpc.SessionModelChangeDataContextTierDefault - SessionModelChangeDataContextTierLongContext = rpc.SessionModelChangeDataContextTierLongContext SessionModePlan = rpc.SessionModePlan - SessionResumeDataContextTierDefault = rpc.SessionResumeDataContextTierDefault - SessionResumeDataContextTierLongContext = rpc.SessionResumeDataContextTierLongContext - SessionStartDataContextTierDefault = rpc.SessionStartDataContextTierDefault - SessionStartDataContextTierLongContext = rpc.SessionStartDataContextTierLongContext ShutdownTypeError = rpc.ShutdownTypeError ShutdownTypeRoutine = rpc.ShutdownTypeRoutine SkillInvokedTriggerAgentInvoked = rpc.SkillInvokedTriggerAgentInvoked @@ -494,36 +707,55 @@ const ( SystemMessageRoleSystem = rpc.SystemMessageRoleSystem SystemNotificationAgentCompletedStatusCompleted = rpc.SystemNotificationAgentCompletedStatusCompleted SystemNotificationAgentCompletedStatusFailed = rpc.SystemNotificationAgentCompletedStatusFailed + SystemNotificationFactoryCompletedStatusCancelled = rpc.SystemNotificationFactoryCompletedStatusCancelled + SystemNotificationFactoryCompletedStatusCompleted = rpc.SystemNotificationFactoryCompletedStatusCompleted + SystemNotificationFactoryCompletedStatusError = rpc.SystemNotificationFactoryCompletedStatusError + SystemNotificationFactoryCompletedStatusHalted = rpc.SystemNotificationFactoryCompletedStatusHalted SystemNotificationTypeAgentCompleted = rpc.SystemNotificationTypeAgentCompleted SystemNotificationTypeAgentIdle = rpc.SystemNotificationTypeAgentIdle + SystemNotificationTypeFactoryCompleted = rpc.SystemNotificationTypeFactoryCompleted SystemNotificationTypeInstructionDiscovered = rpc.SystemNotificationTypeInstructionDiscovered SystemNotificationTypeNewInboxMessage = rpc.SystemNotificationTypeNewInboxMessage SystemNotificationTypeShellCompleted = rpc.SystemNotificationTypeShellCompleted SystemNotificationTypeShellDetachedCompleted = rpc.SystemNotificationTypeShellDetachedCompleted + SystemNotificationTypeUnclassified = rpc.SystemNotificationTypeUnclassified + TaskCompletionOutcomeBlocked = rpc.TaskCompletionOutcomeBlocked + TaskCompletionOutcomeCompleted = rpc.TaskCompletionOutcomeCompleted + TaskCompletionOutcomeContinue = rpc.TaskCompletionOutcomeContinue ToolExecutionCompleteContentResourceLinkIconThemeDark = rpc.ToolExecutionCompleteContentResourceLinkIconThemeDark ToolExecutionCompleteContentResourceLinkIconThemeLight = rpc.ToolExecutionCompleteContentResourceLinkIconThemeLight ToolExecutionCompleteContentTypeAudio = rpc.ToolExecutionCompleteContentTypeAudio ToolExecutionCompleteContentTypeImage = rpc.ToolExecutionCompleteContentTypeImage ToolExecutionCompleteContentTypeResource = rpc.ToolExecutionCompleteContentTypeResource ToolExecutionCompleteContentTypeResourceLink = rpc.ToolExecutionCompleteContentTypeResourceLink + ToolExecutionCompleteContentTypeShellExit = rpc.ToolExecutionCompleteContentTypeShellExit ToolExecutionCompleteContentTypeTerminal = rpc.ToolExecutionCompleteContentTypeTerminal ToolExecutionCompleteContentTypeText = rpc.ToolExecutionCompleteContentTypeText ToolExecutionCompleteToolDescriptionMetaUIVisibilityApp = rpc.ToolExecutionCompleteToolDescriptionMetaUIVisibilityApp ToolExecutionCompleteToolDescriptionMetaUIVisibilityModel = rpc.ToolExecutionCompleteToolDescriptionMetaUIVisibilityModel + ToolExecutionStartToolDescriptionMetaUIVisibilityApp = rpc.ToolExecutionStartToolDescriptionMetaUIVisibilityApp + ToolExecutionStartToolDescriptionMetaUIVisibilityModel = rpc.ToolExecutionStartToolDescriptionMetaUIVisibilityModel UserMessageAgentModeAutopilot = rpc.UserMessageAgentModeAutopilot UserMessageAgentModeInteractive = rpc.UserMessageAgentModeInteractive UserMessageAgentModePlan = rpc.UserMessageAgentModePlan UserMessageAgentModeShell = rpc.UserMessageAgentModeShell - UserMessageAttachmentGithubReferenceTypeDiscussion = rpc.UserMessageAttachmentGithubReferenceTypeDiscussion - UserMessageAttachmentGithubReferenceTypeIssue = rpc.UserMessageAttachmentGithubReferenceTypeIssue - UserMessageAttachmentGithubReferenceTypePr = rpc.UserMessageAttachmentGithubReferenceTypePr - UserMessageAttachmentTypeBlob = rpc.UserMessageAttachmentTypeBlob - UserMessageAttachmentTypeDirectory = rpc.UserMessageAttachmentTypeDirectory - UserMessageAttachmentTypeFile = rpc.UserMessageAttachmentTypeFile - UserMessageAttachmentTypeGithubReference = rpc.UserMessageAttachmentTypeGithubReference - UserMessageAttachmentTypeSelection = rpc.UserMessageAttachmentTypeSelection - WorkingDirectoryContextHostTypeAdo = rpc.WorkingDirectoryContextHostTypeAdo - WorkingDirectoryContextHostTypeGithub = rpc.WorkingDirectoryContextHostTypeGithub + UserMessageDeliveryIdle = rpc.UserMessageDeliveryIdle + UserMessageDeliveryQueued = rpc.UserMessageDeliveryQueued + UserMessageDeliverySteering = rpc.UserMessageDeliverySteering + UserToolSessionApprovalKindCommands = rpc.UserToolSessionApprovalKindCommands + UserToolSessionApprovalKindCustomTool = rpc.UserToolSessionApprovalKindCustomTool + UserToolSessionApprovalKindExtensionManagement = rpc.UserToolSessionApprovalKindExtensionManagement + UserToolSessionApprovalKindExtensionPermissionAccess = rpc.UserToolSessionApprovalKindExtensionPermissionAccess + UserToolSessionApprovalKindFactory = rpc.UserToolSessionApprovalKindFactory + UserToolSessionApprovalKindMCP = rpc.UserToolSessionApprovalKindMCP + UserToolSessionApprovalKindMemory = rpc.UserToolSessionApprovalKindMemory + UserToolSessionApprovalKindRead = rpc.UserToolSessionApprovalKindRead + UserToolSessionApprovalKindWrite = rpc.UserToolSessionApprovalKindWrite + VerbosityHigh = rpc.VerbosityHigh + VerbosityLow = rpc.VerbosityLow + VerbosityMedium = rpc.VerbosityMedium + WorkingDirectoryContextHostTypeADO = rpc.WorkingDirectoryContextHostTypeADO + WorkingDirectoryContextHostTypeGitHub = rpc.WorkingDirectoryContextHostTypeGitHub WorkspaceFileChangedOperationCreate = rpc.WorkspaceFileChangedOperationCreate WorkspaceFileChangedOperationUpdate = rpc.WorkspaceFileChangedOperationUpdate ) diff --git a/java/.lastmerge b/java/.lastmerge deleted file mode 100644 index 97be84d7e..000000000 --- a/java/.lastmerge +++ /dev/null @@ -1 +0,0 @@ -60104052cd914949ddf8c7a31e1856cd6db0a57c diff --git a/java/README.md b/java/README.md index 6bac7167d..57700a1e9 100644 --- a/java/README.md +++ b/java/README.md @@ -13,31 +13,33 @@ ## Background -> ℹ️ **Public Preview:** This SDK tracks the [GitHub Copilot SDKs](https://github.com/github/copilot-sdk) for [.NET](https://github.com/github/copilot-sdk/tree/main/dotnet) and [Node.js](https://github.com/github/copilot-sdk/tree/main/nodejs). While in public preview, minor breaking changes may still occur between releases. +Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build AI-powered applications and agentic workflows. The Java SDK tracks the official GitHub Copilot SDK family (TypeScript, Python, Go, .NET, and Rust). -Java SDK for programmatic control of GitHub Copilot CLI, enabling you to build AI-powered applications and agentic workflows. +## Prerequisites -## Installation - -### Runtime requirements +To use the SDK, you'll need: - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor. -- GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`) +- GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`) + +## Installation ### Maven +Replace `${copilot.sdk.version}` with the latest release from Maven Central. + ```xml com.github copilot-sdk-java - 1.0.0-beta-10-java.5 + 1.0.11 ``` ### Gradle ```groovy -implementation 'com.github:copilot-sdk-java:1.0.0-beta-10-java.5' +implementation 'com.github:copilot-sdk-java:1.0.11' ``` #### Snapshot Builds @@ -56,14 +58,62 @@ Snapshot builds of the next development version are published to Maven Central S com.github copilot-sdk-java - 1.0.0-beta-10-java.6-SNAPSHOT + 1.0.12-SNAPSHOT ``` ### Gradle +Replace `${copilot.sdk.version}` with the latest release from Maven Central. + ```groovy -implementation 'com.github:copilot-sdk-java:1.0.0-beta-10-java.5-SNAPSHOT' +implementation 'com.github:copilot-sdk-java:1.0.12-SNAPSHOT' +``` + +## In-process mode (experimental) + +The SDK supports running the Copilot runtime **in-process** as a native library instead of spawning a separate CLI process. This eliminates process management overhead and simplifies deployment. In-process mode is currently experimental and only supported on **linux-x64**. + +Because in-process mode is experimental, see the [Using experimental APIs](#using-experimental-apis) section for how to opt in. + +### Additional dependency + +Add both the SDK and the platform-specific native runtime to your project: + +```xml + + + + com.github + copilot-sdk-java + ${copilot.version} + + + + com.github + copilot-sdk-java-runtime + ${copilot.version} + linux-x64 + + + + net.java.dev.jna + jna + 5.19.1 + + +``` + +### Usage + +Configure the client to use the in-process connection: + +```java +CopilotClientOptions options = new CopilotClientOptions() + .setConnection(RuntimeConnection.forInProcess()); + +CopilotClient client = new CopilotClient(options); +client.start().get(); ``` ## Quick Start @@ -116,50 +166,309 @@ public class CopilotSDK { } ``` +When targeting MCP tools configured through `setMcpServers(...)`, remember the +runtime tool name is `-`. For `setAvailableTools(...)` +and `setExcludedTools(...)`, prefer the source-qualified filter form +`mcp:-`. For `CustomAgentConfig.setTools(...)` and +`DefaultAgentConfig.setExcludedTools(...)`, use `-` +directly. + +`CopilotClientOptions.setCwd(...)` sets the runtime process working directory, which otherwise inherits the current process working directory. `SessionConfig.setWorkingDirectory(...)` sets the session working directory, which otherwise defaults to the runtime process working directory. + +## Permission Handling + +`PermissionHandler.APPROVE_ALL` approves requests when managed settings are disabled. When `enableManagedSettings` is true, it completes exceptionally. Custom handlers can inspect `request.getManagedApprovalRequired()` for human-facing confirmation logic. + +When handling `PermissionRequestedEvent` directly, convert its generated event value with `PermissionRequest.fromJsonValue(event.getData().permissionRequest())` to access the typed metadata. + +Custom handlers must check managed approval before applying kind-specific automatic decisions: + +```java +import java.util.concurrent.CompletableFuture; + +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.PermissionRequestResult; + +PermissionHandler handler = (request, invocation) -> { + if (Boolean.TRUE.equals(request.getManagedApprovalRequired())) { + return CompletableFuture.completedFuture(PermissionRequestResult.noResult()); + } + + return CompletableFuture.completedFuture(PermissionRequestResult.approveOnce()); +}; +``` + ## Try it with JBang You can run the SDK without setting up a full Java project, by using [JBang](https://www.jbang.dev/). -See the full source of [`jbang-example.java`](jbang-example.java) for a complete example with more features like session idle handling and usage info events. +See the full source of [`jbang-example.java`](sdk/jbang-example.java) for a complete example with more features like session idle handling and usage info events. Or run it directly from the repository: ```bash -jbang https://github.com/github/copilot-sdk/blob/main/java/jbang-example.java +jbang https://github.com/github/copilot-sdk/blob/main/java/sdk/jbang-example.java ``` -## Projects Using This SDK +## Annotation-based tools and `ToolInvocation` context -| Project | Description | -| ----------------------------------------------------------------------------- | ------------------------------------------ | -| [JMeter Copilot Plugin](https://github.com/brunoborges/jmeter-copilot-plugin) | JMeter plugin for AI-assisted load testing | +When you define tools with `@CopilotTool`, parameters of type `ToolInvocation` are injected as runtime context and are not exposed in the tool schema. +`ToolInvocation` can appear before, between, or after schema-visible parameters. -> Want to add your project? Open a PR! +```java +import com.github.copilot.rpc.ToolInvocation; +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +class ProgressTools { + @CopilotTool("Reports the current phase and session") + public String reportProgress( + @CopilotToolParam("Current phase") String phase, + ToolInvocation invocation) { + return "phase=" + phase + ", sessionId=" + invocation.getSessionId(); + } +} +``` + +Position examples: + +```java +@CopilotTool("Invocation first") +public String report(ToolInvocation invocation, @CopilotToolParam("Phase") String phase) { ... } + +@CopilotTool("Invocation only") +public String onlyContext(ToolInvocation invocation) { ... } + +@CopilotTool("Invocation middle") +public String report(@CopilotToolParam("Phase") String phase, ToolInvocation invocation, @CopilotToolParam("Limit") int limit) { ... } +``` + +## Inline lambda tool definitions (experimental) + +For inline tool authoring at the session construction site, use `ToolDefinition.from(...)` with explicit parameter metadata: + +```java +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.rpc.ToolDefer; +import com.github.copilot.tool.Param; + +ToolDefinition search = ToolDefinition + .from( + "search_items", + "Searches indexed items by keyword", + Param.of(String.class, "keyword", "Search keyword"), + keyword -> "Searching for: " + keyword) + .skipPermission(true) + .defer(ToolDefer.AUTO); +``` -## CI/CD Workflows +### Parameter metadata with `Param.of(...)` -This project uses several GitHub Actions workflows for building, testing, releasing, and syncing with the reference implementation SDK. +`Param.of(type, name, description)` creates a required parameter. For optional parameters with defaults: -See [WORKFLOWS.md](docs/WORKFLOWS.md) for a full overview and details on each workflow. +```java +Param limit = Param.of(Integer.class, "limit", "Max results", false, "10"); +``` -## Contributing +### Async handlers -Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details. +Use `fromAsync` for asynchronous tool handlers: -### Agentic Reference Implementation Merge and Sync +```java +import java.util.concurrent.CompletableFuture; + +ToolDefinition fetchData = ToolDefinition.fromAsync( + "fetch_data", + "Fetches data from remote source", + Param.of(String.class, "url", "Data source URL"), + url -> CompletableFuture.supplyAsync(() -> fetchRemote(url)) +); +``` + +### ToolInvocation context injection -This SDK tracks the official [Copilot SDK](https://github.com/github/copilot-sdk) (.NET reference implementation) and ports changes to Java. The reference implementation merge process is automated with AI assistance: +Inline tools can access `ToolInvocation` runtime context using `fromWithToolInvocation`: -**Automated sync** — A [scheduled GitHub Actions workflow](.github/workflows/reference-impl-sync.yml) runs on the schedule specified in that file. It checks for new reference implementation commits since the last merge (tracked in [`.lastmerge`](.lastmerge)), and if changes are found, creates an issue labeled `reference-impl-sync` and assigns it to the GitHub Copilot coding agent. Any previously open `reference-impl-sync` issues are automatically closed. The sync also updates the `@github/copilot` version in both `pom.xml` and `scripts/codegen/package.json` to keep schemas and test CLI in lockstep. +```java +ToolDefinition reportPhase = ToolDefinition.fromWithToolInvocation( + "report_phase", + "Reports the current phase with invocation context", + Param.of(String.class, "phase", "The current phase"), + (phase, invocation) -> "phase=" + phase + ", toolCallId=" + invocation.getToolCallId() +); +``` -**Reusable prompt** — The merge workflow is defined in [`agentic-merge-reference-impl.prompt.md`](.github/prompts/agentic-merge-reference-impl.prompt.md). It can be triggered manually from: +For async with `ToolInvocation`, use `fromAsyncWithToolInvocation`. -- **VS Code Copilot Chat** — type `/agentic-merge-reference-impl` -- **GitHub Copilot CLI** — use `copilot` CLI with the same skill reference +### Fluent option modifiers + +Chain fluent modifiers to set tool options: + +- `.skipPermission(boolean)` — bypass permission prompts +- `.defer(ToolDefer)` — control deferred execution (`AUTO`, `NEVER`) +- `.overridesBuiltInTool(boolean)` — shadow built-in tools + +For design context and decision rationale, see [ADR-006](docs/adr/adr-006-tool-definition-inline.md). + +## Session Store + +`enableSessionStore` on `SessionConfig` enables the cross-session store for search and retrieval across sessions. When unset in the default `CopilotClientMode.COPILOT_CLI` mode, the runtime default applies (enabled). In `CopilotClientMode.EMPTY` mode, defaults to disabled. + +## Memory + +Sessions can opt into persistent memory, allowing the agent to read and write memory across turns. Memory is configured per session and applies to both `createSession` and `resumeSession`. +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```java +import com.github.copilot.rpc.MemoryConfiguration; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +// Enable memory for a new session +var session = client.createSession(new SessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setModel("gpt-5") + .setMemory(new MemoryConfiguration().setEnabled(true)) +).get(); + +// Disable memory for a new session +var sessionNoMemory = client.createSession(new SessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setModel("gpt-5") + .setMemory(new MemoryConfiguration().setEnabled(false)) +).get(); + +// Configure memory while resuming +var resumed = client.resumeSession(sessionId, new ResumeSessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setMemory(new MemoryConfiguration().setEnabled(true)) +).get(); +``` + +When `memory` is left unset, no memory configuration is sent and the runtime default applies. In the default `CopilotClientMode.COPILOT_CLI` the SDK leaves `memory` unset so the runtime applies its own default, while `CopilotClientMode.EMPTY` defaults `memory` to disabled unless you set it explicitly. + +## Using experimental APIs + +Some SDK APIs are marked as experimental with `@CopilotExperimental`. These APIs may change or be removed in future versions without notice. + +By default, referencing an experimental API from your code causes a **compile-time error**: + +``` +error: Use of experimental API 'ExperimentalType' in field type is not allowed. + Add @AllowCopilotExperimental or compiler option -Acopilot.experimental.allowed=true to opt in. +``` + +To opt in and use experimental APIs, either: + +- annotate the consuming class, method, or constructor with `@AllowCopilotExperimental`, or +- pass the annotation processor option `-Acopilot.experimental.allowed=true` to the Java compiler. + +### In code + +```java +import com.github.copilot.AllowCopilotExperimental; +import test.ExperimentalType; + +@AllowCopilotExperimental +public class Consumer { + private ExperimentalType field; + + public ExperimentalType getIt() { + return field; + } + + @AllowCopilotExperimental + public ExperimentalType echo(ExperimentalType value) { + return value; + } +} +``` + +### Maven + +```xml + + org.apache.maven.plugins + maven-compiler-plugin + + + -Acopilot.experimental.allowed=true + + + +``` + +### Gradle + +```groovy +tasks.withType(JavaCompile) { + options.compilerArgs += ['-Acopilot.experimental.allowed=true'] +} +``` + +### What the processor catches + +The processor detects usage of experimental types in **declarations**: + +| Usage pattern | Caught? | +|---|---| +| Field declared with experimental type | ✅ | +| Method parameter of experimental type | ✅ | +| Method return type is experimental | ✅ | +| `extends` / `implements` experimental type | ✅ | +| `throws` an experimental exception type | ✅ | +| Generic type argument is experimental (e.g., `List`) | ✅ | + +### Known limitations + +The processor uses standard JSR 269 annotation processing APIs for maximum portability (works with javac, ECJ/Eclipse, and any compliant compiler). This means it inspects **declarations only**, not expressions inside method bodies. The following patterns are **not caught** by the processor: + +| Usage pattern | Caught? | Workaround | +|---|---|---| +| `new ExperimentalType()` in a method body (no field/param declaration) | ❌ | Use the compiler flag for a whole-compilation opt-in | +| `ExperimentalType.staticMethod()` inline call | ❌ | Use the compiler flag for a whole-compilation opt-in | +| Method reference `ExperimentalType::method` | ❌ | Use the compiler flag for a whole-compilation opt-in | +| Local variable with experimental type (including `var` inference) | ❌ | Move the usage into a declaration the processor can see, or use the compiler flag | +| Cast to experimental type | ❌ | Use the compiler flag for a whole-compilation opt-in | + +In practice, these gaps rarely matter: any meaningful use of an experimental SDK type almost always appears in a field declaration, method signature, or type hierarchy — all of which are caught. A purely inline expression with no declaration footprint (e.g., `session.rpc().experimental.foo().join()`) is the only case that would slip through. See [ADR-004](docs/adr/adr-004-copilotexperimental.md) for the design rationale. + +### Example + +```java +import com.github.copilot.CopilotExperimental; + +// This type is experimental — consumer code that references it +// in declarations will fail to compile unless the opt-in flag is provided. +@CopilotExperimental +public class ExperimentalType { + public void doSomething() {} +} + +// Consumer code — compiles only with -Acopilot.experimental.allowed=true +import test.ExperimentalType; + +public class Consumer { + private ExperimentalType field; // ← caught: field type + public ExperimentalType getIt() { return field; } // ← caught: return type + public void setIt(ExperimentalType v) { } // ← caught: parameter type +} +``` + +The gate also applies to individual methods annotated with `@CopilotExperimental` on otherwise stable types. When a type-level annotation is present, all member accesses through that type are considered experimental. `@AllowCopilotExperimental` mirrors the same declaration-level boundary: annotating a class opts in that class and its enclosed declarations, while annotating a method or constructor opts in just that executable signature. + +## Projects Using This SDK + +| Project | Description | +| ----------------------------------------------------------------------------- | ------------------------------------------ | +| [JMeter Copilot Plugin](https://github.com/brunoborges/jmeter-copilot-plugin) | JMeter plugin for AI-assisted load testing | + +> Want to add your project? Open a PR! ### Development Setup -Requires JDK 25 or later for development. +Requires JDK 25 or later and a supported [Node.js version](../nodejs/README.md#prerequisites) for development. The following steps validate the artifact built with JDK 25 runs on both 25 and 17, preserving the MR-JAR behavior. ```bash # Clone the repository @@ -170,28 +479,14 @@ cd copilot-sdk/java git config core.hooksPath .githooks # Build and test with JDK 25 -mvn clean verify +mvn test-compile jar:jar +mvn verify -Dskip.test.harness=true # Set your paths for JDK 17 # Run the JDK 25 built jar with JDK 17 JVM for tests. Do not re-compile the jar. mvn jacoco:prepare-agent@wire-up-coverage-instrumentation antrun:run@print-test-jdk-banner surefire:test failsafe:integration-test failsafe:verify jacoco:report@build-coverage-report-from-tests -Denforcer.skip=true ``` -The tests require the official [copilot-sdk](https://github.com/github/copilot-sdk) test harness, which is automatically cloned during build. - -## Support - -See [SUPPORT.md](SUPPORT.md) for how to file issues and get help. - -## Code of Conduct - -This project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details. - -## Security - -See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities. - ## License -MIT — see [LICENSE](LICENSE) for details. - +MIT — see [LICENSE](sdk/LICENSE) for details. diff --git a/java/copilot-native/pom.xml b/java/copilot-native/pom.xml new file mode 100644 index 000000000..7c36801a5 --- /dev/null +++ b/java/copilot-native/pom.xml @@ -0,0 +1,269 @@ + + + + 4.0.0 + + + com.github + copilot-sdk-java-parent + 1.0.12-SNAPSHOT + ../pom.xml + + + com.github + copilot-sdk-java-runtime + jar + + GitHub Copilot SDK :: Java :: Native Runtime + Native runtime binaries for the GitHub Copilot Java SDK, published as per-platform classifier JARs + https://github.com/github/copilot-sdk + + + scm:git:https://github.com/github/copilot-sdk.git + scm:git:https://github.com/github/copilot-sdk.git + https://github.com/github/copilot-sdk + HEAD + + + + + ${project.basedir}/../.. + + linux-x64 + ${project.build.directory}/native-staging + + false + + + + + + + src/main/resources + true + + + + + + org.codehaus.mojo + exec-maven-plugin + + + fetch-native-linux-x64 + generate-resources + + exec + + + node + + ${project.basedir}/scripts/fetch-native.mjs + ${copilot.sdk.root} + ${copilot.native.staging} + ${copilot.native.classifier} + + + + + test-fetch-native + test + + exec + + + node + + --test + ${project.basedir}/scripts/fetch-native.test.mjs + + + + + + + org.apache.maven.plugins + maven-jar-plugin + + + + jar-linux-x64 + package + + jar + + + ${copilot.native.classifier} + ${copilot.native.staging}/${copilot.native.classifier} + + .version + + + + + + empty-javadoc-jar + package + + jar + + + javadoc + ${project.basedir}/src/main/javadoc + + + + + empty-sources-jar + package + + jar + + + sources + ${project.basedir}/src/main/java + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + package + + run + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.sonatype.central + central-publishing-maven-plugin + true + + central + true + + + + + + + + + skip-native-download + + + copilot.native.skip.download + true + + + + + + org.codehaus.mojo + exec-maven-plugin + + true + + + + org.apache.maven.plugins + maven-jar-plugin + + + jar-linux-x64 + none + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-native-jars + none + + + + + + + + diff --git a/java/copilot-native/scripts/fetch-native.mjs b/java/copilot-native/scripts/fetch-native.mjs new file mode 100644 index 000000000..7b68f0406 --- /dev/null +++ b/java/copilot-native/scripts/fetch-native.mjs @@ -0,0 +1,134 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * Downloads the `runtime.node` native binary for a single platform classifier + * and stages it for packaging into a classifier JAR. + * + * Steps: + * 1. Read the pinned version and the SHA-512 `integrity` value for + * `@github/copilot-` from `nodejs/package-lock.json`. + * 2. `npm pack` that exact version into the staging directory. + * 3. Verify the downloaded tarball against the `integrity` value. + * 4. Extract `package/prebuilds//runtime.node` to + * `//native//runtime.node`. + * 5. Extract `package/copilot` (or `package/copilot.exe` on Windows) to + * `//native//copilot`. + * 6. Write `//native//platform.properties`. + * + * Usage: node fetch-native.mjs + */ + +import { createHash } from 'node:crypto'; +import { execFileSync } from 'node:child_process'; +import fs from 'node:fs'; +import path from 'node:path'; + +const [repoRoot, stagingDir, classifier] = process.argv.slice(2); + +if (!repoRoot || !stagingDir || !classifier) { + console.error('Usage: node fetch-native.mjs '); + process.exit(1); +} + +const lockPath = path.join(repoRoot, 'nodejs', 'package-lock.json'); +const packageName = `@github/copilot-${classifier}`; +const lock = JSON.parse(fs.readFileSync(lockPath, 'utf8')); +const entry = lock.packages?.[`node_modules/${packageName}`]; + +if (!entry?.version || !entry?.integrity) { + console.error(`Could not find version/integrity for ${packageName} in ${lockPath}`); + process.exit(1); +} + +const { version, integrity } = entry; +if (!integrity.startsWith('sha512-')) { + console.error(`Unsupported integrity algorithm for ${packageName}: ${integrity}`); + process.exit(1); +} + +const outDir = path.join(stagingDir, classifier); +const resourceDir = path.join(outDir, 'native', classifier); +const runtimePath = path.join(resourceDir, 'runtime.node'); +const isWindows = classifier.startsWith('win32'); +const cliTarballMember = isWindows ? 'package/copilot.exe' : 'package/copilot'; +const cliFilename = isWindows ? 'copilot.exe' : 'copilot'; +const cliPath = path.join(resourceDir, cliFilename); +const platformPropertiesPath = path.join(resourceDir, 'platform.properties'); +const expectedPlatformProperties = `classifier=${classifier}\nversion=${version}\n`; +const stampPath = path.join(outDir, '.version'); + +// Idempotence: skip the download only when every required staged artifact +// matches the package identity recorded in the stamp. +if ( + fs.existsSync(runtimePath) && + fs.existsSync(cliPath) && + fs.existsSync(platformPropertiesPath) && + fs.existsSync(stampPath) +) { + const stampLines = fs.readFileSync(stampPath, 'utf8').trim().split('\n'); + const stampVersion = stampLines[0] || ''; + const stampIntegrity = stampLines[1] || ''; + const stampRuntimeDigest = stampLines[2] || ''; + const stampCliDigest = stampLines[3] || ''; + const currentRuntimeDigest = digestFile(runtimePath); + const currentCliDigest = digestFile(cliPath); + const currentPlatformProperties = fs.readFileSync(platformPropertiesPath, 'utf8'); + if ( + stampVersion === version && + stampIntegrity === integrity && + stampRuntimeDigest === currentRuntimeDigest && + stampCliDigest === currentCliDigest && + currentPlatformProperties === expectedPlatformProperties + ) { + console.log(`${packageName}@${version} already staged at ${runtimePath}`); + process.exit(0); + } +} + +fs.rmSync(outDir, { recursive: true, force: true }); +fs.mkdirSync(resourceDir, { recursive: true }); + +console.log(`Downloading ${packageName}@${version} ...`); +const packOutput = execFileSync('npm', ['pack', `${packageName}@${version}`, '--pack-destination', outDir], { + encoding: 'utf8', + shell: process.platform === 'win32', +}); +const tarballName = packOutput.trim().split('\n').pop().trim(); +const tarballPath = path.join(outDir, tarballName); + +const actual = `sha512-${createHash('sha512').update(fs.readFileSync(tarballPath)).digest('base64')}`; +if (actual !== integrity) { + console.error(`Integrity verification failed for ${tarballPath}`); + console.error(` expected: ${integrity}`); + console.error(` actual: ${actual}`); + process.exit(1); +} +console.log(`Integrity verified (${integrity.slice(0, 20)}...).`); + +const memberPath = `package/prebuilds/${classifier}/runtime.node`; +execFileSync('tar', ['-xzf', tarballPath, '-C', outDir, memberPath], { stdio: 'inherit' }); +fs.renameSync(path.join(outDir, memberPath), runtimePath); + +// Extract the copilot CLI executable (necessary-and-sufficient runtime artifact invariant: +// host_start needs both runtime.node and the copilot CLI from the same package version). +execFileSync('tar', ['-xzf', tarballPath, '-C', outDir, cliTarballMember], { stdio: 'inherit' }); +fs.renameSync(path.join(outDir, cliTarballMember), cliPath); +if (!isWindows) { + fs.chmodSync(cliPath, 0o755); +} + +fs.rmSync(path.join(outDir, 'package'), { recursive: true, force: true }); +fs.rmSync(tarballPath, { force: true }); + +fs.writeFileSync(platformPropertiesPath, expectedPlatformProperties); +const runtimeDigest = digestFile(runtimePath); +const cliDigest = digestFile(cliPath); +fs.writeFileSync(stampPath, `${version}\n${integrity}\n${runtimeDigest}\n${cliDigest}\n`); + +console.log(`Staged ${runtimePath}`); + +function digestFile(filePath) { + return `sha512-${createHash('sha512').update(fs.readFileSync(filePath)).digest('base64')}`; +} diff --git a/java/copilot-native/scripts/fetch-native.test.mjs b/java/copilot-native/scripts/fetch-native.test.mjs new file mode 100644 index 000000000..a80cd0387 --- /dev/null +++ b/java/copilot-native/scripts/fetch-native.test.mjs @@ -0,0 +1,124 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import assert from 'node:assert/strict'; +import { createHash } from 'node:crypto'; +import fs from 'node:fs'; +import os from 'node:os'; +import path from 'node:path'; +import { spawnSync } from 'node:child_process'; +import { fileURLToPath } from 'node:url'; +import test from 'node:test'; + +const classifier = 'linux-x64'; +const version = '1.0.79'; +const integrity = 'sha512-test-integrity'; +const runtimeContent = 'runtime content'; +const cliContent = 'cli content'; +const scriptPath = fileURLToPath(new URL('./fetch-native.mjs', import.meta.url)); + +test('missing CLI does not use incremental fast path', (t) => { + const fixture = createFixture(t); + fs.rmSync(fixture.cliPath); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); +}); + +test('stale CLI does not use incremental fast path', (t) => { + const fixture = createFixture(t); + fs.writeFileSync(fixture.cliPath, 'stale CLI content'); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); +}); + +test('missing platform metadata does not use incremental fast path', (t) => { + const fixture = createFixture(t); + fs.rmSync(fixture.platformPropertiesPath); + + const result = runScript(fixture); + + assertRestagingAttempted(fixture, result); +}); + +test('complete matching artifacts use incremental fast path', (t) => { + const fixture = createFixture(t); + + const result = runScript(fixture); + + assert.equal(result.status, 0, result.stderr); + assert.match(result.stdout, /already staged/); + assert.equal(fs.existsSync(fixture.npmMarkerPath), false); +}); + +function createFixture(t) { + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'fetch-native-test-')); + t.after(() => fs.rmSync(root, { recursive: true, force: true })); + + const repoRoot = path.join(root, 'repo'); + const stagingDir = path.join(root, 'staging'); + const resourceDir = path.join(stagingDir, classifier, 'native', classifier); + const fakeBinDir = path.join(root, 'bin'); + const npmMarkerPath = path.join(root, 'npm-invoked'); + fs.mkdirSync(path.join(repoRoot, 'nodejs'), { recursive: true }); + fs.mkdirSync(resourceDir, { recursive: true }); + fs.mkdirSync(fakeBinDir); + + fs.writeFileSync( + path.join(repoRoot, 'nodejs', 'package-lock.json'), + JSON.stringify({ + packages: { + [`node_modules/@github/copilot-${classifier}`]: { version, integrity }, + }, + }), + ); + + const runtimePath = path.join(resourceDir, 'runtime.node'); + const cliPath = path.join(resourceDir, 'copilot'); + const platformPropertiesPath = path.join(resourceDir, 'platform.properties'); + fs.writeFileSync(runtimePath, runtimeContent); + fs.writeFileSync(cliPath, cliContent); + fs.writeFileSync(platformPropertiesPath, `classifier=${classifier}\nversion=${version}\n`); + fs.writeFileSync( + path.join(stagingDir, classifier, '.version'), + `${version}\n${integrity}\n${digest(runtimeContent)}\n${digest(cliContent)}\n`, + ); + + const fakeNpmPath = path.join(fakeBinDir, 'npm'); + fs.writeFileSync(fakeNpmPath, '#!/bin/sh\nprintf invoked > \"$FETCH_NATIVE_NPM_MARKER\"\nexit 42\n'); + fs.chmodSync(fakeNpmPath, 0o755); + + return { + repoRoot, + stagingDir, + fakeBinDir, + npmMarkerPath, + runtimePath, + cliPath, + platformPropertiesPath, + }; +} + +function runScript(fixture) { + return spawnSync(process.execPath, [scriptPath, fixture.repoRoot, fixture.stagingDir, classifier], { + encoding: 'utf8', + env: { + ...process.env, + PATH: `${fixture.fakeBinDir}${path.delimiter}${process.env.PATH}`, + FETCH_NATIVE_NPM_MARKER: fixture.npmMarkerPath, + }, + }); +} + +function assertRestagingAttempted(fixture, result) { + assert.notEqual(result.status, 0, 'The fake npm command should make restaging fail'); + assert.equal(fs.readFileSync(fixture.npmMarkerPath, 'utf8'), 'invoked'); +} + +function digest(content) { + return `sha512-${createHash('sha512').update(content).digest('base64')}`; +} diff --git a/java/copilot-native/src/main/java/.gitkeep b/java/copilot-native/src/main/java/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/java/copilot-native/src/main/javadoc/.gitkeep b/java/copilot-native/src/main/javadoc/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/java/copilot-native/src/main/resources/native/lib/copilot-runtime.properties b/java/copilot-native/src/main/resources/native/lib/copilot-runtime.properties new file mode 100644 index 000000000..0f3230898 --- /dev/null +++ b/java/copilot-native/src/main/resources/native/lib/copilot-runtime.properties @@ -0,0 +1,12 @@ +# Placeholder marker for the primary (classifier-less) artifact of +# com.github:copilot-sdk-java-runtime. +# +# The real native binaries ship in per-platform classifier JARs +# (e.g. copilot-sdk-java-runtime--linux-x64.jar) under +# native//runtime.node. This primary JAR exists only to satisfy +# Maven Central's requirement for a main artifact and intentionally contains +# no native binaries. +# +# This file is processed by Maven resource filtering. +placeholder=true +version=${project.version} diff --git a/java/docs/adr/adr-001-semver-pre-general-availability.md b/java/docs/adr/adr-001-semver-pre-general-availability.md index 25008b0f5..b081e1fe3 100644 --- a/java/docs/adr/adr-001-semver-pre-general-availability.md +++ b/java/docs/adr/adr-001-semver-pre-general-availability.md @@ -1,3 +1,5 @@ +Status: This ADR's pre-general-availability SemVer policy is superseded by the generally available release; see CHANGELOG and the README for the current SemVer policy. + # SemVer requirements pre general-availability of Reference Implementation ## Context and Problem Statement diff --git a/java/docs/adr/adr-003-sub-module-for-generated-code.md b/java/docs/adr/adr-003-sub-module-for-generated-code.md new file mode 100644 index 000000000..a43a7cee4 --- /dev/null +++ b/java/docs/adr/adr-003-sub-module-for-generated-code.md @@ -0,0 +1,35 @@ +# Sub-module for generated code + +## Context and Problem Statement + +Regarding the goal of more effectively passing on the stability and deprecation metadata from the `@github/copilot` Zod schema to end consumers of `copilot-sdk-java`, Partner Software Engineer Stephen Toub stated, "The ideal is to do the best each language has to offer." + +## Considered Options + +* Status quo: keep generated code in the same `copilot-sdk-java` module. + +* Option 1: Move all generated code (both `com.github.copilot.generated` and `com.github.copilot.generated.rpc`) to a single internal Maven module (`copilot-sdk-generated`), bundled back into the published `copilot-sdk-java` artifact via `maven-dependency-plugin`. + +* Option 2: Move generated code into two internal Maven modules (`copilot-sdk-events` for session-event types, `copilot-sdk-rpc-generated` for RPC types), bundled back into the published artifact. + +### Analysis + +The generated code is deeply embedded in the public API surface of `copilot-sdk-java`: `CopilotSession.getRpc()` returns `SessionRpc`, `CopilotClient.getRpc()` returns `ServerRpc`, `sendAndWait()` returns `AssistantMessageEvent`, and the event handler API accepts all generated event subclasses. Approximately 730 of 914 generated classes are part of the externally-visible API. Any module split is therefore a build-time concern only — it cannot reduce the consumer-facing footprint. + +The dependency direction is clean (hand-written → generated, never reverse), making a split technically feasible without circular dependencies. + +However, the specific goal of conveying stability/deprecation metadata requires a `@CopilotExperimental` annotation visible at compile time to both the generated and hand-written code. In the status quo, this annotation lives in `src/main/java/` and is freely importable by `src/generated/java/` since they compile together. In a split-module reactor, the generated module compiles *before* the hand-written module, so the annotation must either be emitted by the codegen script as another generated file, or extracted into a third annotations-only module. Both add complexity without advancing the stability-metadata goal. + +Module separation is orthogonal to — and slightly complicates — the stability/deprecation work. The codegen script changes to read and propagate `stability`/`deprecated` from schema nodes are identical regardless of module structure. + +## Decision Outcome + +Keep the status quo: keep the generated code in the same `copilot-sdk-java` module. + +The primary benefit of module separation (compile-time isolation, cleaner PR diffs) does not justify the added reactor complexity, `maven-dependency-plugin` configuration, and annotation-placement constraints — particularly given that the immediate priority is implementing stability/deprecation metadata propagation, which is simpler in a single-module build. + +## Related work items + +- https://devdiv.visualstudio.com/DevDiv/_workitems/edit/3013416 + +- https://github.com/github/copilot-sdk/issues/1573 diff --git a/java/docs/adr/adr-004-copilotexperimental.md b/java/docs/adr/adr-004-copilotexperimental.md new file mode 100644 index 000000000..5661d122f --- /dev/null +++ b/java/docs/adr/adr-004-copilotexperimental.md @@ -0,0 +1,80 @@ +# ADR-004: @CopilotExperimental annotation processor — pure JSR 269 approach + +## Context and Problem Statement + +The Java SDK needs a compile-time gate that prevents accidental use of experimental APIs (types and methods marked with `@CopilotExperimental`). The annotation processor must detect consumer-side references to experimental elements and emit a compilation error unless the consumer explicitly opts in with `-Acopilot.experimental.allowed=true`. + +The fundamental question is: should the processor use the Compiler Tree API (`com.sun.source.util.Trees`, `TreePathScanner`) for full expression-level coverage, or restrict itself to standard JSR 269 (`javax.lang.model.*`) for portability at the cost of reduced detection scope? + +## Considered Options + +### Option 1: Compiler Tree API (`com.sun.source.*`) + +Uses `Trees.instance(processingEnv)` and `TreePathScanner` to walk the full AST of every compilation unit, resolving symbols at expression level. + +**What it catches additionally:** +- `new ExperimentalType()` inside method bodies +- `ExperimentalType.staticMethod()` inline calls +- Method references (`ExperimentalType::method`) +- Local variable types +- Casts to experimental types + +**Drawbacks:** +- Depends on `jdk.compiler` module — ties the processor to javac specifically. +- Does not work with ECJ (Eclipse Compiler for Java), which has its own AST. +- Requires `requires static jdk.compiler` in module-info.java. +- Requires `--add-modules jdk.compiler --add-exports jdk.compiler/com.sun.source.util=ALL-UNNAMED --add-exports jdk.compiler/com.sun.source.tree=ALL-UNNAMED` in surefire test configuration. +- The `com.sun.source.*` package, while more stable than `com.sun.tools.javac.*`, is still not part of the Java SE specification. It is a JDK-specific API. + +### Option 2: Pure JSR 269 (`javax.lang.model.*`) — declaration-level only + +Uses only standard annotation processing APIs to walk declared elements (types, methods, fields) and inspect their type mirrors. + +**What it catches:** +- Field types referencing experimental classes +- Method parameter types +- Method return types +- Superclass / implemented interfaces +- Thrown exception types +- Generic type arguments and bounds + +**What it cannot catch:** +- `new ExperimentalType()` purely inside a method body with no declaration footprint +- Inline static method calls with no stored result +- Method references to experimental methods +- Local variable types (not visible to processors) + +**Advantages:** +- Works with any compliant Java compiler (javac, ECJ, IntelliJ's compiler, etc.) +- No dependency on JDK-internal modules +- No `--add-exports` hacks in build configuration +- Simpler module-info (no `requires static jdk.compiler`) +- Easier to maintain and less fragile across JDK versions + +## Decision Outcome + +**Chosen: Option 2 — Pure JSR 269.** + +### Rationale + +1. **The SDK's experimental APIs are predominantly types (records, classes).** Table `apiNote` from the codegen analysis shows 316 experimental types vs. 159 experimental methods. Any meaningful use of an experimental record (params, results, events) requires declaring it somewhere — a field, a method parameter, a return type, or a superclass. Pure body-level usage with zero declaration footprint is a degenerate edge case for this SDK. + +2. **Portability matters for a published library.** The SDK is distributed on Maven Central. Consumers may use Eclipse (ECJ), IntelliJ's compiler, or other toolchains where `com.sun.source.*` is unavailable. A processor that silently does nothing on non-javac compilers provides false confidence. + +3. **Build simplicity.** Avoiding `jdk.compiler` eliminates module-system friction: no `requires static jdk.compiler`, no `--add-exports` in surefire, no risk of `IllegalAccessError` on future JDK versions that further restrict internal APIs. + +4. **The gap is well-documented and acceptable.** The README explicitly lists what the processor does and does not catch, with suggested workarounds. This transparency is preferable to a fragile implementation with full coverage. + +5. **Error Prone or similar tools can fill the gap later.** If full expression-level enforcement becomes necessary in the future, it can be implemented as a separate Error Prone check (which is already designed for AST-level analysis) without changing the annotation or the processor's declaration-level behavior. + +## Consequences + +- Consumers who use experimental APIs only in fully-inline expressions (no field, no parameter, no return type) will not receive a compile error. This is expected and documented. +- The processor works identically across javac, ECJ, and any JSR 269-compliant compiler. +- No JDK-internal API dependency in the module descriptor or test infrastructure. +- Future enhancement path is clear: add an optional Error Prone check for body-level coverage without changing the existing processor. + +## Related work items + +- https://github.com/github/copilot-sdk/pull/1601 +- https://devdiv.visualstudio.com/DevDiv/_workitems/edit/3012835 diff --git a/java/docs/adr/adr-005-tool-definition.md b/java/docs/adr/adr-005-tool-definition.md new file mode 100644 index 000000000..dc1eb3614 --- /dev/null +++ b/java/docs/adr/adr-005-tool-definition.md @@ -0,0 +1,267 @@ +# ADR-005: Ergonomic tool definition API — annotation-on-method approach + +## Context and Problem Statement + +The Java SDK's current tool definition API requires developers to manually provide every piece of tool metadata: name, description, JSON Schema (as a `Map`), and a handler lambda. This results in highly verbose, error-prone code: + +```java +ToolDefinition.create("set_current_phase", + "Sets the current phase of the agent. Use this to report progress.", + Map.of("type", "object", + "properties", Map.of("phase", Map.of("type", "string", "enum", + List.of("searching", "analyzing", "done"))), + "required", List.of("phase")), + invocation -> { + Phase phase = invocation.getArgumentsAs(PhaseArgs.class).phase(); + this.phase = phase; + updateUi(); + return CompletableFuture.completedFuture("Phase set to " + phase); + }) +``` + +Compare this with the C# SDK where reflection on `[DisplayName]`, `[Description]`, and method parameters auto-generates everything: + +```csharp +CopilotTool.DefineTool(SetCurrentPhase) +``` + +Or with Go, where generics derive the schema from the input type: + +```go +DefineTool[PhaseArgs, string]("set_current_phase", "Sets phase", handler) +``` + +The Java SDK needs a higher-level API that is idiomatic Java while dramatically reducing boilerplate. + +## Considered Options + +### Option 1: Current API (status quo) + +Explicit `ToolDefinition.create(name, description, schema, handler)` with a hand-written `Map` JSON Schema and a `ToolHandler` lambda. + +**Advantages:** +- No reflection or annotation processing at runtime. +- Full explicit control over every aspect of the tool spec. + +**Drawbacks:** +- Extremely verbose — a single tool definition can span 10+ lines. +- Error-prone — typos in schema keys (`"tpye"` instead of `"type"`) produce runtime failures, not compile-time errors. +- No type safety on arguments — developers must call `invocation.getArgumentsAs(T.class)` manually inside the handler. +- Inconsistent with every other SDK in the mono-repo, all of which offer a higher-level path. + +### Option 2: Record-as-schema with generic factory + +Define a record for the tool's arguments and use a generic factory method to auto-generate the schema from the record's `RecordComponent[]` metadata. Because `@CopilotToolParam` targets `ElementType.PARAMETER` (method parameters only), it cannot be placed on record components; per-field descriptions are not supported in this option: + +```java +record PhaseArgs(Phase phase) {} + +ToolDefinition.define("set_current_phase", + "Sets the current phase of the agent.", + PhaseArgs.class, + (args, invocation) -> { + this.phase = args.phase(); + updateUi(); + return CompletableFuture.completedFuture("Phase set to " + args.phase()); + }); +``` + +**Advantages:** +- Schema is auto-generated from the record — no hand-written `Map`. +- Type-safe handler — the lambda receives the deserialized record directly. +- Closest analog to Go's `DefineTool[T, U]`. +- No classpath scanning or special framework plumbing. + +**Drawbacks:** +- Tool name and description are still explicit string arguments. +- Requires a separate record class for every tool's args (even trivial single-param tools). +- The handler is still an explicit lambda — the "tool" is not the method itself. +- Per-field descriptions cannot be provided: `@CopilotToolParam` targets method parameters only, not record components. +- Nested or complex schemas (arrays of objects, polymorphic types) need additional mapping logic. +- No analog in the broader Java ecosystem; Java developers are not accustomed to defining a record per function call. + +### Option 3: Annotation-on-method (langchain4j-style) + +Annotate existing Java methods with `@Tool` (or a Copilot-specific equivalent) and annotate parameters with `@P`/`@CopilotToolParam`. The framework discovers tools by scanning methods on a given object, auto-generates `ToolSpecification` / `ToolDefinition` from the method signature, and dispatches invocations directly to the annotated method. + +```java +class MyTools { + + @CopilotTool("Sets the current phase of the agent. Use this to report progress.") + String setCurrentPhase(@CopilotToolParam("The phase to transition to") Phase phase) { + this.phase = phase; + updateUi(); + return "Phase set to " + phase; + } + + @CopilotTool(name = "report_intent", value = "Reports the agent's intent", + overridesBuiltInTool = true) + String reportIntent(@CopilotToolParam("The intent") String intent) { + // ... + } +} + +// Registration: +var tools = ToolDefinition.fromObject(myToolsInstance); +// → List with schema, description, and handler wired automatically. +``` + +This is the approach used by [langchain4j](https://github.com/langchain4j/langchain4j) (see [High Level Tool API](https://github.com/langchain4j/langchain4j/blob/main/docs/docs/tutorials/tools.md#high-level-tool-api)), which is the most widely adopted Java AI framework. + +**What the framework does automatically:** +1. **Name** — derived from `@CopilotTool(name=...)` or the method name (converted to snake_case). +2. **Description** — from `@CopilotTool("...")` or `@CopilotTool(value="...")`. +3. **Parameter schema** — generated by reflecting on method parameters: types map to JSON Schema types; `@CopilotToolParam` provides descriptions; `Optional` or `@CopilotToolParam(required=false)` marks optional params. +4. **Handler** — the method itself. The framework deserializes JSON arguments into the method's parameter types and invokes the method reflectively. The return value is serialized back to a string result. + +**Advantages:** +- **Minimal boilerplate** — a tool is just an annotated method. No records, no lambdas, no schema maps. +- **Idiomatic Java** — this pattern is familiar from JAX-RS (`@Path`/`@GET`), Spring MVC (`@RequestMapping`), and CDI (`@Inject`). Java developers are accustomed to annotation-driven frameworks. +- **The method IS the handler** — no separation between "tool definition" and "tool implementation". Everything is co-located. +- **Proven at scale** — langchain4j has validated this design across thousands of production deployments. +- **Inheritance and discovery** — tools can be inherited from superclasses, composed from multiple objects, and discovered dynamically. +- **Ecosystem alignment** — closest to what C#'s `CopilotTool.DefineTool(MethodGroup)` achieves via reflection, adapted to Java idioms. +- **Parameter-level type safety** — each parameter is a method argument with its own Java type. No single "args" record needed. + +**Drawbacks:** +- Requires runtime reflection for method invocation and schema generation. +- One-time scanning cost at registration time (negligible for typical tool counts). +- Return type handling needs a policy: `String` → sent as-is; `void` → "Success"; other types → JSON-serialized. +- Async story: methods could return `CompletableFuture` for async tools, or the framework could invoke synchronous methods on a configurable executor. +- New annotation(s) added to the public API surface (`@CopilotTool`, `@CopilotToolParam`). +- Requires `-parameters` javac flag for parameter name preservation (or explicit `@CopilotToolParam(name=...)` — same constraint as langchain4j). + +## Decision Outcome + +**Chosen: Option 3 — Annotation-on-method (langchain4j-style).** + +### Rationale + +1. **Java developers expect annotation-driven APIs.** Every major Java framework (Spring, Jakarta EE, Quarkus, Micronaut, langchain4j) uses annotations on methods/parameters as the primary developer-facing abstraction. This is idiomatic Java; records-as-schema is not. + +2. **Minimum viable tool is one annotated method.** With Option 3, the absolute minimum code to define a tool is: + ```java + @CopilotTool("Gets the weather") + String getWeather(@CopilotToolParam("City") String city) { return weatherApi.get(city); } + ``` + With Option 2, you need a record class *and* a lambda. With Option 1, you need a record class, a Map schema, *and* a lambda. + +3. **The method IS the tool.** Co-locating metadata (name, description, parameter descriptions) with implementation eliminates drift between the spec and the code. When someone adds a parameter, the schema updates automatically. + +4. **Proven design.** langchain4j's `@Tool` / `@P` design has been adopted by thousands of Java projects and validated against real LLM providers. We can learn from their design decisions (handling of `Optional`, `void` returns, `@Description` on nested types, inheritance rules) rather than inventing from scratch. + +5. **Closes the ergonomics gap with C# and Go.** The C# SDK's `CopilotTool.DefineTool(SetCurrentPhase)` achieves one-line tool definition via reflection. Option 3 is the Java equivalent — the annotation-on-method pattern is Java's analog to C#'s attribute-on-method + method-group-to-delegate pattern. + +6. **Option 1 remains available as the low-level API.** Users who need full control (dynamic tools, computed schemas, tools from external config) can still use `ToolDefinition.create(...)`. Option 3 is a higher-level convenience that delegates to Option 1 under the hood — the same two-level architecture langchain4j uses (Low Level Tool API vs High Level Tool API). + +## Implementation: JSR 269 annotation processor for compile-time metadata generation + +A key improvement over langchain4j's pure-runtime-reflection approach: we will use a **JSR 269 annotation processor** (the same mechanism used for `@CopilotExperimental`) to generate tool metadata at compile time. This eliminates the `-parameters` javac flag requirement entirely. + +### Why this works + +`javax.lang.model.element.VariableElement.getSimpleName()` always returns the real parameter name at compile time, regardless of whether `-parameters` is passed to `javac`. The `-parameters` flag only controls whether those names survive into `.class` bytecode for runtime reflection. An annotation processor sees the source-level names unconditionally. + +### How it works + +The processor runs at compile time, finds all `@CopilotTool`-annotated methods, and generates a companion metadata class per tool-bearing class: + +```java +// GENERATED — do not edit +final class MyTools$$CopilotToolMeta { + static List definitions(MyTools instance) { + return List.of( + new ToolDefinition("set_current_phase", + "Sets the current phase of the agent.", + Map.of("type", "object", + "properties", Map.of("phase", Map.of("type", "string", + "description", "The phase to transition to")), + "required", List.of("phase")), + invocation -> { + Phase phase = invocation.getArgumentsAs(Phase.class); + return CompletableFuture.completedFuture( + instance.setCurrentPhase(phase)); + }, null, null, null, null) + ); + } +} +``` + +The trailing constructor arguments are `overridesBuiltInTool`, `skipPermission`, `defer`, and `metadata` — all `null` here because none were set on the annotation. + +At runtime, `ToolDefinition.fromObject(myTools)` loads the generated `$$CopilotToolMeta` class — zero reflection, zero dependency on `-parameters`. + +### Host-defined metadata + +`@CopilotTool` also accepts an opaque `metadata` bag via nested annotations. Because annotation members can't express arbitrary maps, the representation is deliberately shallow: each entry maps a namespaced key to a boolean, a string, or a one-level map of named boolean flags. + +```java +@CopilotTool( + value = "Reports phase", + metadata = { + @CopilotTool.MetadataEntry( + key = "github.com/copilot:safeForTelemetry", + value = @CopilotTool.MetadataValue(flags = { + @CopilotTool.MetadataFlag(name = "name", value = true), + @CopilotTool.MetadataFlag(name = "inputsNames", value = false) + })) + }) +public String reportPhase(@CopilotToolParam("Phase") String phase) { + return phase; +} +``` + +The processor emits this as the `metadata` constructor argument: + +```java +Map.of("github.com/copilot:safeForTelemetry", + Map.of("name", true, "inputsNames", false)) +``` + +For richer values (numbers, arrays, deeper nesting), use the programmatic `ToolDefinition.createWithMetadata(...)` / `ToolDefinition.metadata(...)` API instead. + +### Compile-time validation + +Because the processor has full access to the source AST, it can emit compile errors for: +- Missing `@CopilotToolParam` on parameters (when descriptions are required by policy). +- Unsupported parameter types (types without a clear JSON Schema mapping). +- Duplicate tool names within the same class hierarchy. +- Invalid annotation combinations (e.g., `overridesBuiltInTool` on a tool with `skipPermission`). + +### Precedent + +| Framework | Approach | +|-----------|----------| +| **Micronaut** | Annotation processor generates all DI metadata at compile time — no runtime reflection, no `-parameters` needed | +| **Dagger 2** | Processor generates `_Factory` / `_MembersInjector` classes | +| **MapStruct** | Processor generates mapper implementations from interface method signatures | +| **Our own `@CopilotExperimental`** | Processor walks declared elements via JSR 269 (see ADR-004) | + +### Comparison: annotation processor vs. runtime reflection + +| | Annotation processor (our approach) | Runtime reflection (langchain4j default) | +|---|---|---| +| Requires `-parameters`? | **No** | Yes (or `@P(name=...)`) | +| GraalVM native-image friendly? | **Yes** | Needs reflection config | +| Compile-time error checking? | **Yes** | Fails at runtime | +| Extra generated source files? | Yes | None | +| Works without running the processor? | No — but fails loudly at compile time | Yes (degraded) | + +## Consequences + +- New public annotations: `@CopilotTool` and `@CopilotToolParam` (in `com.github.copilot.rpc` or a new `com.github.copilot.tool` package). +- New JSR 269 annotation processor that generates `$$CopilotToolMeta` companion classes at compile time. +- New utility: `ToolDefinition.fromObject(Object)` / `ToolDefinition.fromClass(Class)` that loads the generated metadata class (falling back to runtime reflection if the processor was not run). +- The existing `ToolDefinition.create(...)` / `ToolDefinition.createOverride(...)` APIs remain unchanged — they become the "low-level" path. +- No `-parameters` javac flag requirement for users who run the annotation processor (which happens automatically when the SDK is on the compile classpath). +- Async support: methods returning `CompletableFuture` are handled natively; synchronous methods are wrapped in `CompletableFuture.completedFuture(...)` (or dispatched to an executor, TBD). +- GraalVM native-image compatibility without additional reflection configuration. +- **Experimental designation:** `@CopilotTool`, `@CopilotToolParam`, `ToolDefinition.fromObject(Object)`, and `ToolDefinition.fromClass(Class)` will all be annotated with `@CopilotExperimental`. This gates adoption behind an explicit opt-in (`-Acopilot.experimental.allowed=true`) until the API surface stabilizes, consistent with the policy established in ADR-004. + +## Related work items + +- https://github.com/github/copilot-sdk/issues/1682 +- langchain4j reference: https://github.com/langchain4j/langchain4j/blob/main/docs/docs/tutorials/tools.md#high-level-tool-api +- langchain4j `@Tool` source: https://github.com/langchain4j/langchain4j/blob/main/langchain4j-core/src/main/java/dev/langchain4j/agent/tool/Tool.java +- langchain4j `@P` source: https://github.com/langchain4j/langchain4j/blob/main/langchain4j-core/src/main/java/dev/langchain4j/agent/tool/P.java +- langchain4j `ToolSpecifications` (schema generation from methods): https://github.com/langchain4j/langchain4j/blob/main/langchain4j-core/src/main/java/dev/langchain4j/agent/tool/ToolSpecifications.java diff --git a/java/docs/adr/adr-006-tool-definition-inline.md b/java/docs/adr/adr-006-tool-definition-inline.md new file mode 100644 index 000000000..ad48527c1 --- /dev/null +++ b/java/docs/adr/adr-006-tool-definition-inline.md @@ -0,0 +1,118 @@ +# ADR-006: Inline tool definition with lambdas + +## Context and problem statement + +[ADR-005](adr-005-tool-definition.md) introduced an ergonomic Java tools API based on `@CopilotTool` method annotations, `@CopilotToolParam` parameter annotations, and `ToolDefinition.fromObject(...)` for reflection-based tool registration. That model works well when teams define tools as methods on a class. + +The next ergonomics goal is an inline style comparable to C# `CopilotTool.DefineTool(...)`, where developers can define a tool at the call site without creating a separate tool container class. + +For this decision, we evaluated two alternatives: + +* Method-reference registration (`ToolDefinition.from(tools::setCurrentPhase)`) +* Inline lambda registration (`ToolDefinition.from(..., phase -> ...)`) + +The key factor is metadata quality: tool name, description, parameter names, parameter descriptions, required/default semantics, and schema stability. + +## Considered options + +### Option 1: Method-reference API + +Example: + +```java +ToolDefinition setPhase = ToolDefinition.from(tools::setCurrentPhase); +``` + +In this model, metadata is sourced from existing method-level annotations (`@CopilotTool`, `@Param`) on the referenced method. + +Advantages: + +* Closest Java analog to C# method-group ergonomics +* High-quality metadata with minimal additional API surface +* Reuses ADR-005 metadata and invocation behavior directly + +Drawbacks: + +* Not truly inline: still requires a declared method (and usually annotations) elsewhere +* Does not solve the "define the whole tool at the call site" use case +* Method-reference resolution adds runtime/reflection complexity + +### Option 2: Inline lambda API with explicit metadata + +Example: + +```java +ToolDefinition setPhase = ToolDefinition.from( + "set_current_phase", + "Sets the current phase of the agent", + Param.of(String.class, "phase", "The phase to transition to"), + (String phase) -> { + currentPhase = phase; + return "Phase set to " + phase; + }); +``` + +In this model, handler logic is inline, and metadata is provided explicitly through `Param.of(...)` parameter definitions. + +Advantages: + +* True inline authoring at the session construction site +* No dependence on lambda parameter-name reflection or `-parameters` +* Deterministic metadata and schema generation +* Independent from annotation processing and generated companion classes + +Drawbacks: + +* Slightly more verbose than method-reference style because metadata is explicit +* Introduces new public API types for parameter definitions and typed lambda overloads +* Requires careful API design to stay concise for common one-parameter tools + +## Decision outcome + +Chosen: **Option 2 for ADR-006 scope** — inline lambda API with explicit metadata. + +Rationale: + +1. The primary requirement for this ADR is inline definition. Option 2 satisfies it directly; Option 1 does not. +1. Metadata quality is the critical requirement. Option 2 keeps metadata explicit and stable, instead of relying on fragile lambda introspection. +1. Option 2 can ship independently of method-reference support and without changes to annotation processing. +1. Option 2 preserves behavior parity with existing tool execution by delegating to `ToolDefinition` construction and current invocation semantics. + +Option 1 remains valuable and can be added independently as a separate ergonomic layer. It is not blocked by this decision. + +## Design constraints and non-goals + +Constraints for the inline lambda API: + +* Require explicit tool name and description. +* Require explicit parameter metadata (at minimum name and type, with optional description/required/default). +* Support both sync and async handlers (`R` and `CompletableFuture`). +* Keep result semantics aligned with existing behavior (`String` passthrough, `void` maps to `"Success"`, non-string objects serialized to JSON). +* Keep override/permission/defer flags available through options, consistent with existing `ToolDefinition` fields. + +Non-goals for this ADR: + +* Replacing `@CopilotTool`/`fromObject` APIs. +* Defining method-reference registration behavior in detail. +* Introducing compile-time code generation for lambda metadata. + +## Consequences + +The SDK now provides an explicit inline path for developers who prefer to keep tool declarations at session creation while preserving high-quality schema metadata. Implemented API families include: + +- `ToolDefinition.from(name, description, [params...], handler)` — sync handlers +- `ToolDefinition.fromAsync(name, description, [params...], asyncHandler)` — async handlers returning `CompletableFuture` +- `ToolDefinition.fromWithToolInvocation(...)` — sync with `ToolInvocation` context injection +- `ToolDefinition.fromAsyncWithToolInvocation(...)` — async with `ToolInvocation` context injection + +Parameter metadata is defined using `Param.of(type, name, description)` for required parameters and `Param.of(type, name, description, required, defaultValue)` for optional parameters with defaults. + +Fluent option modifiers (`.skipPermission(boolean)`, `.defer(ToolDefer)`, `.overridesBuiltInTool(boolean)`) allow post-construction customization. + +The annotation-driven API from [ADR-005](adr-005-tool-definition.md) remains the recommended path for larger tool surfaces where co-locating metadata with method implementations improves maintainability. For usage examples and complete API coverage, see the Java SDK README. + +## Related work items + +* #1682 +* #1792 +* #1810 diff --git a/java/docs/adr/adr-007-native-bundling-strategy.md b/java/docs/adr/adr-007-native-bundling-strategy.md new file mode 100644 index 000000000..f561842fe --- /dev/null +++ b/java/docs/adr/adr-007-native-bundling-strategy.md @@ -0,0 +1,403 @@ +# ADR-007: Native runtime bundling strategy: per-platform classifier JARs + +## Context and problem statement + +The Copilot SDK for Java supports an experimental in-process connection that loads the Copilot agent runtime as a native shared library. The existing stdio, TCP, and URI connections remain the default behavior unless the user explicitly selects the in-process connection. + +### The runtime artifact + +The artifact to be embedded is `runtime.node`, a Rust [`cdylib`](#references) produced by the `src/runtime` crate in `github/copilot-agent-runtime` using the [napi-rs](#references) build toolchain. Despite the `.node` file extension (a naming convention of napi-rs), this is an ordinary platform-specific shared library (`.so` on Linux, `.dylib` on macOS, `.dll` on Windows). It exposes two front doors built over the same internal engine: + +* **[napi](#references) front door**: loaded by a Node.js process as a native addon for the current CLI path. +* **[C ABI](#references) front door**: a fixed set of 5 `extern "C"` lifecycle and transport entry points that any language can call in-process via [FFI](#references) ([JNA](#references) for Java, Python/cffi, C#/`DllImport`, Go/purego). All API methods travel as JSON-RPC data through this fixed transport; the export list does not change as the method set grows. + + | Entry point | C signature | Purpose | + | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `copilot_runtime_host_start` | `(const uint8_t* argv_json, size_t argv_json_len, const uint8_t* env_json, size_t env_json_len) → uint32_t` | Start the runtime host; `argv_json` is a JSON array (e.g., `["copilot","--embedded-host"]`), `env_json` is an optional JSON object of environment overrides. Returns a server handle (0 = failure). | + | `copilot_runtime_host_shutdown` | `(uint32_t server_id) → bool` | Shut down the runtime host identified by `server_id`. | + | `copilot_runtime_connection_open` | `(uint32_t server_id, void(*on_outbound)(void* user_data, const uint8_t* data, size_t len), void* user_data, const uint8_t* ext_source, size_t ext_source_len, const uint8_t* ext_name, size_t ext_name_len, const uint8_t* conn_token, size_t conn_token_len) → uint32_t` | Open a bidirectional connection on the server; registers the `on_outbound` callback for runtime→SDK data delivery. `ext_source`, `ext_name`, and `conn_token` are nullable metadata buffers. Returns a connection handle (0 = failure). | + | `copilot_runtime_connection_write` | `(uint32_t connection_id, const uint8_t* data, size_t len) → bool` | Write a JSON-RPC frame from the SDK into the runtime. The native side copies the buffer synchronously before returning. | + | `copilot_runtime_connection_close` | `(uint32_t connection_id) → bool` | Close a connection. | + + The outbound callback signature: `void on_outbound(void* user_data, const uint8_t* data, size_t len)` — invoked by native code (potentially on native threads) to deliver JSON-RPC responses and notifications back to the SDK. + +The `cli-native.node` addon — a separate, smaller artifact that provides ICU4X text segmentation, Win32 API wrappers, and terminal UI helpers — is a CLI-only artifact used by the Ink/React terminal interface. It is **not needed** by the Java SDK. + +### Note on the active Rust migration + +As of 2026-08, the `runtime.node` binary is being built up iteratively as TypeScript runtime code is ported into it. It is **not** being reduced; it is growing with each port PR. The `embedded_host.rs` module currently starts a child `copilot --embedded-host` process to service method bodies not yet ported to Rust. + +The classifier JAR therefore contains a version-matched pair during the migration: + +* `runtime.node`: loaded into the Java process through JNA +* `copilot` or `copilot.exe`: started internally by `copilot_runtime_host_start` +* `platform.properties`: classifier and runtime version metadata + +The Java SDK does not independently spawn this child for JSON-RPC transport. The native runtime owns the transitional embedded-host process. The bundled CLI requirement disappears after the Rust migration is complete, while the C ABI and Java loading mechanism remain stable. + +### Platform dimensions + +The runtime must be built for each unique combination of OS, CPU architecture, and (on Linux) C runtime variant. The build system in `github/copilot-agent-runtime` produces eight Rust target triples: + +| Platform label | Rust triple | Constraint | +| ----------------- | ---------------------------- | ---------------------------------------------------------------- | +| `linux-x64` | `x86_64-unknown-linux-gnu` | [glibc](#references) ≥ 2.28 (Debian 10+, Ubuntu 20.04+, RHEL 8+) | +| `linux-arm64` | `aarch64-unknown-linux-gnu` | glibc ≥ 2.28 | +| `linuxmusl-x64` | `x86_64-unknown-linux-musl` | dynamically links [musl libc](#references) (Alpine Linux) | +| `linuxmusl-arm64` | `aarch64-unknown-linux-musl` | dynamically links musl libc | +| `darwin-x64` | `x86_64-apple-darwin` | macOS, Intel | +| `darwin-arm64` | `aarch64-apple-darwin` | macOS, Apple Silicon | +| `win32-x64` | `x86_64-pc-windows-msvc` | [MSVC CRT](#references) statically linked (`+crt-static`) | +| `win32-arm64` | `aarch64-pc-windows-msvc` | MSVC CRT statically linked (`+crt-static`) | + +The GNU/Linux glibc minimum of 2.28 is enforced at build time via a Microsoft/vscode-linux-build-agent sysroot and verified post-build by `script/linux/verify-glibc-requirements.sh`. The musl binaries are **not** fully statically linked; they dynamically link musl libc (`-C target-feature=-crt-static` is explicitly set at build time). + +The **common case** (Windows × 2 + macOS × 2 + GNU/Linux × 2) requires **6 binaries**. Supporting Alpine Linux adds 2 more musl binaries for a total of **8**. + +### Platform selection + +The loader selects a classifier at runtime using standard Java and OS APIs: + +1. **OS**: `System.getProperty("os.name")` distinguishes Windows, macOS, and Linux. +1. **Architecture**: `System.getProperty("os.arch")` maps `"amd64"`, `"x86_64"`, and `"x64"` to `x64`, and maps `"aarch64"` and `"arm64"` to `arm64`. +1. **Linux libc variant**: The loader reads the first 2 KB of `/proc/self/exe` and parses the [ELF](#references) PT_INTERP segment. An interpreter containing `/ld-musl-` selects musl, while `/ld-linux-` selects glibc. + +If the Linux executable cannot be read or its interpreter is not recognized, the implementation falls back to the GNU/Linux classifier for the detected architecture. Unsupported operating systems and architectures fail with `IllegalStateException`. + +### Size baseline + +Measured from `github/copilot-agent-runtime` release `cli-1.0.69-2` (2026-07-06): + +| Platform | `runtime.node` (uncompressed) | Compressed (~40% deflate) | +| ----------------- | ----------------------------- | ------------------------- | +| `linux-x64` | 64.7 MB | ~25.9 MB | +| `linux-arm64` | 55.5 MB | ~22.2 MB | +| `linuxmusl-x64` | 64.4 MB | ~25.8 MB | +| `linuxmusl-arm64` | 55.3 MB | ~22.1 MB | +| `darwin-x64` | 57.3 MB | ~22.9 MB | +| `darwin-arm64` | 48.1 MB | ~19.2 MB | +| `win32-x64` | 55.9 MB | ~22.4 MB | +| `win32-arm64` | 48.4 MB | ~19.4 MB | + +The published Java SDK JAR (`copilot-sdk-java-1.0.6-preview.1.jar`) is currently **1.53 MB**. A future runtime-only monolithic JAR containing all 6 common-case native binaries would be approximately **132 MB** compressed; all 8 including musl would be approximately **180 MB** compressed. + +These runtime-only estimates do not describe the current migration artifact. The current development `linux-x64` classifier JAR also contains the version-matched CLI executable and is approximately **152 MB compressed**. Its staged contents are approximately **133 MB** for `runtime.node` and **170 MB** for `copilot` before JAR compression. + +All native dependencies within the runtime (`rustls`/`aws-lc-rs` for TLS, `rusqlite` with `bundled` feature for SQLite, `zlib-rs` for compression) are statically compiled into the binary. There are no dependencies on system OpenSSL, libgit2, or libz. + +## Considered options + +### Option 1: Monolithic JAR with all platform binaries + +All 6 (or 8) platform artifact sets are bundled inside a single monolithic artifact. At runtime the SDK extracts and loads the one matching the current platform; the remaining 5–7 are carried silently. + +**Advantages:** + +- Single `` in `pom.xml`; zero extra configuration for users. +- Familiar pattern: [ONNX Runtime](#references) (`onnxruntime-1.21.0.jar`, **130 MB**, all platforms) demonstrates this is an accepted norm in the Java ML ecosystem. + +**Drawbacks:** + +- Every user downloads every platform regardless of their target. A developer on Apple Silicon downloads 105+ MB of Linux and Windows binaries they will never use. +- Build tooling (thin Docker layers, incremental CI caches, artifact registries) penalises large JARs. A single 132–180 MB JAR invalidates the entire cache whenever any platform's binary changes. +- Maven's dependency resolution has no mechanism to supply platform-appropriate variants automatically; platform selection must happen entirely at runtime inside the JAR. +- Conflicts with the principle that Maven artifacts should be reproducible and minimal. + +### Option 2: Per-platform classifier JARs + +A small, pure-Java coordination artifact (`copilot-sdk-java`, ~1.5 MB) is published alongside separate per-platform native artifacts differentiated by Maven classifier: + +``` +com.github:copilot-sdk-java-runtime:VERSION:linux-x64 +com.github:copilot-sdk-java-runtime:VERSION:linux-arm64 +com.github:copilot-sdk-java-runtime:VERSION:linuxmusl-x64 +com.github:copilot-sdk-java-runtime:VERSION:linuxmusl-arm64 +com.github:copilot-sdk-java-runtime:VERSION:darwin-x64 +com.github:copilot-sdk-java-runtime:VERSION:darwin-arm64 +com.github:copilot-sdk-java-runtime:VERSION:win32-x64 +com.github:copilot-sdk-java-runtime:VERSION:win32-arm64 +``` + +Each classifier JAR contains `runtime.node`, `platform.properties`, and, during the active Rust migration, the version-matched `copilot` or `copilot.exe` embedded-host executable. The coordination artifact selects and loads the matching native when the user selects the in-process connection. + +This is the same pattern used by DJL's PyTorch native artifacts (`pytorch-native-cpu-2.5.1-linux-x86_64.jar`, `pytorch-native-cpu-2.5.1-osx-aarch64.jar`, etc.), Netty's `netty-tcnative-boringssl-static` per-platform JARs, and others. + +Build tools can be configured to resolve the correct classifier automatically: + +- **Maven**: `${os.detected.classifier}` via [os-maven-plugin](#references). +- **Gradle**: variant-aware dependency resolution with attribute matching. +- **Uber-jar builds**: include all classifiers; the coordination artifact picks the right one at runtime. + +**Advantages:** + +* The long-term runtime-only download is the coordination artifact plus one platform JAR instead of every platform binary. +- Each platform JAR changes independently; CI caches and Docker layers for unchanged platforms are preserved across releases. +- Users building for a single known platform (most production deployments) pay exactly the cost of that platform. +- Follows well-established Maven ecosystem conventions; standard tooling ([os-maven-plugin](#references), Gradle variant resolution) handles classifier selection. +- Aligns with DJL's proven distribution strategy for large native ML runtimes. + +**Drawbacks:** + +- Requires publishing 6–8 additional Maven artifacts per release. +- Users building portable über-JARs must explicitly include all classifiers they wish to support. +- Slightly more complex `pom.xml` / `build.gradle` for users who need cross-platform packaging. + +### Option 3: Download on demand + +The SDK ships a minimal placeholder that detects the current platform at runtime and downloads the correct `runtime.node` binary from a distribution endpoint (GitHub Releases or a CDN) on first use, caching it locally (e.g., `~/.copilot/runtime-cache/`). + +**Advantages:** + +- Zero native binary content in any published Maven artifact; total download at `mvn install` is negligible. +- Identical user experience to the current "externally provided runtime" model during the download, which most CLI users already accept. + +**Drawbacks:** + +- Requires internet access on first run. Offline environments (air-gapped enterprise, CI without outbound HTTP) break silently or require manual pre-seeding. +- Introduces a network dependency into an otherwise pure library artifact, which violates Maven Central's expectations for reproducible builds. +- Adds an operational concern: distribution endpoint availability, CDN costs, URL stability across versions. +- Makes JVM startup non-deterministic in latency (first run downloads 20–26 MB). +- Cannot be pre-warmed by dependency management tooling; no `mvn dependency:resolve` analogue works for a runtime download. + +## Decision outcome + +**Chosen: Option 2, per-platform classifier JARs, with Option 1 available through a consumer-built monolithic JAR.** Consumers can use `maven-assembly-plugin` to merge the platform classifiers they need. + +### Rationale + +1. **User download cost matches actual need.** Most users run on one OS and architecture. Option 2 avoids downloading every platform artifact. During the active migration, each classifier also carries the embedded-host executable and is larger than the runtime-only target. + +2. **Proven ecosystem pattern.** DJL, Netty, and others have established the per-classifier pattern as the correct Maven idiom for large native binaries. Build tooling already knows how to handle it; users and framework integrations (Spring Boot, Quarkus, Micronaut) are familiar with it. + +3. **Cache efficiency.** Individual platform JARs change only when that platform's binary changes. Unchanged platform JARs are never re-downloaded or re-cached by CI or developer machines. + +4. **No operational dependencies.** Unlike Option 3, no external download service is required at runtime. The artifact is self-contained once resolved by Maven/Gradle. + +5. **The distribution model remains valid as artifact size changes.** The current transitional classifier is large because it contains both the runtime and CLI. The classifier model still prevents users from downloading artifacts for unrelated platforms, and its size decreases when the embedded-host executable is no longer required. + +6. **Option 3 remains composable.** A download-on-demand fallback can be layered on top of Option 2 for users who prefer it without changing the primary distribution model. The coordination artifact can attempt classpath lookup first, then fall back to a cached download if no matching classifier JAR is present. + +7. See [How to support classifier and monolithic JARs](#how-to-support-classifier-and-monolithic-jars) for more details. + +### Transport selection and failure behavior + +Adding a classifier JAR does not change the client's connection automatically. Users opt in with: + +```java +CopilotClientOptions options = new CopilotClientOptions() + .setConnection(RuntimeConnection.forInProcess()); +``` + +The `COPILOT_SDK_DEFAULT_CONNECTION=inprocess` environment variable also selects the in-process connection when no explicit or legacy subprocess options override it. + +The selected connection is strict: + +* If the user selects in-process and native resolution or startup fails, `CopilotClient.start()` fails. +* The SDK does not silently retry with stdio or TCP. +* If the user does not select in-process, classifier JARs are ignored and the existing stdio, TCP, or URI behavior remains unchanged. + +### Runtime resolution order + +When the in-process connection is selected, the Java loader resolves `runtime.node` in this order: + +1. `COPILOT_CLI_PATH`: accept either a flat sibling `runtime.node` or the npm `prebuilds//runtime.node` layout. +1. Classpath resource: extract `native//runtime.node` and the bundled CLI from the classifier or monolithic JAR into a cache keyed by SDK version, native package version, and classifier. +1. PATH compatibility fallback: find `copilot` on `PATH` and accept a flat sibling `runtime.node`. + +If none succeeds, startup fails. The PATH fallback does not claim to support every npm or Homebrew installation layout. + +### Current platform scope + +The platform detector recognizes the 8 classifiers listed in this ADR. The current Maven packaging and documented experimental support publish only `linux-x64`. Additional classifier artifacts remain follow-up work. + +## Binding technology: JNA over Panama FFM + +A secondary decision within the scope of this ADR is _how_ the coordination artifact calls the C ABI entry points once the correct `runtime.node` binary has been loaded. Two candidates were considered: [JNA](#references) and the [Foreign Function & Memory API](#references) (FFM, the product of [Project Panama](#references), final since Java 22 via [JEP 454](#references)). + +**Chosen: JNA.** FFM was considered and deliberately deferred, for the following reasons: + +1. **Java baseline.** The SDK supports Java 17, where FFM does not exist (it finalized in Java 22). A JNA-based binding is therefore required regardless; adopting FFM today would mean maintaining two parallel binding implementations, not replacing one with the other. + +2. **Consumer-side configuration burden.** FFM downcalls and upcalls are restricted operations under the JDK's integrity-by-default direction ([JEP 472](#references)). An FFM-based SDK would require every consumer to grant native access explicitly — `--enable-native-access=` (or `ALL-UNNAMED` for classpath applications) on the launcher, or an `Enable-Native-Access` manifest attribute. JNA requires no consumer-side configuration today. For an SDK, this flag becomes every downstream application's problem and a predictable source of support issues. (JNA is on the same enforcement trajectory eventually, as it uses JNI internally; this consideration buys time, not immunity.) + +3. **No realizable performance benefit.** FFM's principal advantage over JNA is the elimination of per-call reflective marshalling overhead. The C ABI surface here is a fixed set of 5 entry points carrying JSON-RPC bytes; JSON serialization and deserialization cost dominates the call path, and call frequency is bounded by agent-interaction rates rather than tight loops. The latency difference between JNA and FFM is expected to be unmeasurable in end-to-end SDK usage. This calculus would change only if the transport moved to a high-frequency or shared-memory framing model. + +4. **Upcall lifetime complexity.** The transport is bidirectional: the runtime delivers JSON-RPC responses and server-initiated requests back into Java from native threads. JNA's `Callback` mechanism handles foreign-thread attachment with well-established semantics. FFM upcall stubs require explicit `Arena` lifetime management, where a stub whose arena is closed while the Rust side still holds the function pointer results in a JVM crash. This shifts lifetime reasoning that JNA encapsulates onto the binding layer. + +5. **GraalVM native-image maturity.** JNA's behavior under GraalVM native-image is well established with mature reachability metadata. FFM support in native-image (particularly for upcalls) is newer and varies by GraalVM release. Plausible SDK consumers (e.g., Quarkus/Micronaut-based CLI tools) compile to native images, so this is a compatibility surface the SDK should not destabilize without verification. + +6. **FFM's safety advantages do not apply to this ABI shape.** FFM's `MemorySegment` bounds and lifetime checking pays off when Java code performs structural manipulation of native memory. This surface passes strings through a fixed transport; there is little structural memory work to make safe. + +### Preserving the FFM migration path + +FFM is regarded as the likely eventual binding technology: the JEP 472 endgame applies enforcement pressure to JNA as well, and a 5-function stable C ABI makes a future migration inexpensive. To keep that path open at low cost: + +- The binding layer is abstracted behind a small internal interface (native load + downcall + upcall registration), so that an FFM implementation can be introduced later — for example, as a multi-release JAR selecting FFM on Java 22+ — without changes to the transport or API layers. +- The decision should be revisited when (a) the SDK's minimum Java baseline moves past 17, or (b) JDK releases begin enforcing `--illegal-native-access=deny` by default, whichever comes first. + +## How to support classifier and monolithic JARs + +### Classpath resource convention and platform detection + +#### Each classifier JAR uses a well-known resource path + +Each per-platform JAR places its artifacts under a deterministic path: + +``` +native/darwin-arm64/runtime.node +native/darwin-arm64/platform.properties +native/darwin-arm64/copilot +``` + +Windows classifiers use `copilot.exe`. The CLI entrypoint remains in the classifier while the runtime requires the transitional embedded host. + +When `maven-assembly-plugin` creates the uber-JAR, it unpacks all dependencies and merges them. The resulting uber-JAR contains the selected platforms: + +``` +com/github/copilot/sdk/... (Java classes) +native/linux-x64/runtime.node +native/linux-x64/copilot +native/linux-arm64/runtime.node +native/linux-arm64/copilot +native/linuxmusl-x64/runtime.node +native/linuxmusl-x64/copilot +native/linuxmusl-arm64/runtime.node +native/linuxmusl-arm64/copilot +native/darwin-x64/runtime.node +native/darwin-x64/copilot +native/darwin-arm64/runtime.node +native/darwin-arm64/copilot +native/win32-x64/runtime.node +native/win32-x64/copilot.exe +native/win32-arm64/runtime.node +native/win32-arm64/copilot.exe +``` + +#### The coordination artifact selects at runtime through the classloader + +`NativeRuntimeLoader` detects the current classifier and requests `native//runtime.node`, `native//platform.properties`, and `native//copilot` from the classloader. It uses the native package version from `platform.properties` as part of the cache identity, writes each executable artifact to a unique sibling temporary file, forces the file contents to storage, and atomically publishes the completed file into `~/.copilot/runtime-cache////`. + +On non-Windows platforms, the loader makes the temporary CLI executable and verifies its executable status before atomic publication. A nonempty but non-executable cached CLI is repaired instead of being accepted as valid. + +#### JNA loads from the extracted path + +Once extracted to a known filesystem path, JNA loads it directly: + +```java +CopilotRuntimeLibrary runtime = + Native.load(extractedPath.toString(), CopilotRuntimeLibrary.class); +``` + +#### The same code works in both modes + +Classloader resource lookup works identically whether: + +* The native artifacts live in a separate classifier JAR on the classpath. +* The artifacts have been merged into an uber-JAR by `maven-assembly-plugin`. + +The classloader searches the entire classpath, so the Java loading code does not change between the two consumption models. + +### Consumer-side assembly plugin configuration + +A consumer building a portable uber-jar would configure: + +```xml + + maven-assembly-plugin + + + jar-with-dependencies + + + +``` + +With all classifier JARs declared as dependencies: + +```xml + + + com.github + copilot-sdk-java + ${copilot.version} + + + + com.github + copilot-sdk-java-runtime + ${copilot.version} + linux-x64 + + + com.github + copilot-sdk-java-runtime + ${copilot.version} + darwin-arm64 + + + +``` + +### Why this works cleanly + +| Concern | How it's handled | +| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| No resource path collisions | Each platform has its own subdirectory (`native//`) | +| Extraction only happens once | Cached to `~/.copilot/runtime-cache////` | +| Works without uber-JAR too | The classloader finds the same resource in a separate classifier JAR | +| Subset selection | Consumer declares only the classifiers they need; missing platforms get a clear error at runtime | +| JNA loading | `Native.load(path, interface)` loads from an absolute filesystem path after extraction | + +The pattern follows DJL's `LibUtils.loadLibrary()` approach: detect the platform, construct the resource path, extract when needed, and load from an absolute path. + +## Consequences + +* The `copilot-sdk-java-runtime` Maven module holds the per-platform classifier JARs. Users add the classifier for each platform they intend to run. +* Users selecting in-process mode also add JNA. The coordination artifact does not force native dependencies on users who keep the default subprocess connection. +* The coordination artifact includes platform detection and native loading code that: + 1. Detects OS, architecture, and Linux libc variant deterministically as described above. + 2. Locates the matching `runtime.node` binary on the classpath (via `getResourceAsStream` from the classifier JAR). + 3. Extracts `runtime.node` and the transitional CLI entrypoint into `~/.copilot/runtime-cache/` if valid cached files are not already present. + 4. Loads it via [JNA](#references) using the C ABI entry points, per the [binding technology decision](#binding-technology-jna-over-panama-ffm) above. The JNA-specific code is confined behind an internal binding interface to preserve a future FFM migration path. +* The Java build fetches the pinned `@github/copilot-` npm package, verifies its SHA-512 integrity from `nodejs/package-lock.json`, and packages the version-matched runtime and CLI files. +* The current release work publishes the `linux-x64` classifier. The planned classifier set expands to the other detected platforms. +* `cli-native.node` is not bundled. It provides terminal UI features that are irrelevant to the Java SDK's programmatic API surface. + +## Related work items + +* https://github.com/github/copilot-sdk/issues/1917: Epic to embed the Rust-based Copilot CLI runtime +* https://devdiv.visualstudio.com/DevDiv/_workitems/edit/3028097 +* https://github.com/github/copilot-sdk/pull/1901: .NET in-process FFI runtime hosting +* https://github.com/github/copilot-sdk/pull/1915: In-process FFI transport for Rust and TypeScript SDKs + +### References + +| Term | Definition | Link | +| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| **FFI** (Foreign Function Interface) | A mechanism by which code written in one language can call functions defined in another. In this ADR, Java calls into the Rust runtime shared library via JNA's FFI layer. | https://en.wikipedia.org/wiki/Foreign_function_interface | +| **JNA** (Java Native Access) | A Java library that provides easy access to native shared libraries without requiring the JNI boilerplate. Used here to call the `extern "C"` C ABI entry points exported by `runtime.node`. | https://github.com/java-native-access/jna | +| **napi-rs** | A Rust framework for building native Node.js addons using the Node-API (napi) stable ABI. Produces the `.node` file and generates TypeScript type declarations automatically. | https://napi.rs/ | +| **cdylib** | A Rust `crate-type` that produces a C-compatible dynamic shared library (`.so` / `.dylib` / `.dll`). Distinct from `dylib` (Rust-to-Rust only) and `staticlib`. | https://doc.rust-lang.org/reference/linkage.html | +| **napi (Node-API)** | A stable C ABI provided by Node.js for building native addons that remain binary-compatible across Node.js versions. `napi-rs` generates Rust code against this interface. | https://nodejs.org/api/n-api.html | +| **C ABI** (Application Binary Interface) | The low-level contract between a compiled binary and its callers: calling conventions, data type layouts, symbol naming. An `extern "C"` ABI uses C's conventions, making a library callable from any language that speaks C FFI. | https://en.wikipedia.org/wiki/Application_binary_interface | +| **ELF PT_INTERP** | A segment in an [ELF](https://man7.org/linux/man-pages/man5/elf.5.html) binary (the Linux/Unix executable format) that records the path of the dynamic linker/interpreter. On glibc systems this path is `/lib64/ld-linux-x86-64.so.2`; on musl systems it is `/lib/ld-musl-x86_64.so.1`. Inspecting it is the most reliable way to detect glibc vs. musl at runtime without executing a subprocess. | https://man7.org/linux/man-pages/man5/elf.5.html | +| **glibc** (GNU C Library) | The standard C runtime library on most mainstream Linux distributions (Debian, Ubuntu, RHEL, Fedora, SLES). Binaries linked against glibc require the same version or newer to be present at runtime. The `runtime.node` glibc build requires glibc ≥ 2.28. | https://www.gnu.org/software/libc/ | +| **musl libc** | An alternative C standard library optimised for static linking and used as the default libc on Alpine Linux. Not binary-compatible with glibc; a separate `runtime.node` build is required. | https://musl.libc.org/ | +| **MSVC CRT** (Microsoft Visual C++ Runtime) | The C runtime library shipped with Visual Studio. When compiled with `+crt-static` (as `runtime.node` is on Windows), it is statically linked into the binary and the end-user does not need to install the Visual C++ Redistributable. | https://learn.microsoft.com/en-us/cpp/c-runtime-library/c-run-time-library-reference | +| **Project Panama** | The OpenJDK project that produced the Foreign Function & Memory API as the modern, supported replacement for JNI-based native interop. | https://openjdk.org/projects/panama/ | +| **FFM** (Foreign Function & Memory API) | The `java.lang.foreign` API for calling native functions and managing native memory from Java, finalized in Java 22. Considered and deferred as the binding technology for this SDK; see [Binding technology](#binding-technology-jna-over-panama-ffm). | https://docs.oracle.com/en/java/javase/22/core/foreign-function-and-memory-api.html | +| **JEP 454** | The JDK Enhancement Proposal that finalized the FFM API in Java 22. | https://openjdk.org/jeps/454 | +| **JEP 472** | "Prepare to Restrict the Use of JNI" — part of the JDK's integrity-by-default direction under which native access (via JNI or FFM) requires explicit consumer opt-in (`--enable-native-access`). Drives both the FFM configuration-burden concern and the expectation that JNA itself will eventually require the same opt-in. | https://openjdk.org/jeps/472 | +| **DJL** (Deep Java Library) | Amazon's open-source Java framework for ML inference, used here as a reference for the per-platform classifier JAR distribution pattern. Its PyTorch native artifacts (`pytorch-native-cpu-*-.jar`) are the direct model for the proposed `copilot-sdk-java-runtime:VERSION:` artifacts. | https://djl.ai/ | +| **os-maven-plugin** | A Maven extension that detects the current OS and architecture and exposes them as properties (e.g., `${os.detected.classifier}`) so that `` values can be resolved at build time rather than hardcoded. | https://github.com/trustin/os-maven-plugin | +| **ONNX Runtime** | Microsoft's cross-platform ML inference runtime, used in this ADR as the size comparable for a monolithic all-platform JAR (~130 MB, Option 1). | https://onnxruntime.ai/ | + +Additional source references: + +- DJL native distribution pattern: https://github.com/deepjavalibrary/djl/tree/master/engines/pytorch/pytorch-native +- DJL `Platform.fromSystem()` (OS/arch detection): https://github.com/deepjavalibrary/djl/blob/master/api/src/main/java/ai/djl/util/Platform.java +- `detect-libc` npm package (ELF PT_INTERP libc detection): https://github.com/lovell/detect-libc +- `github/copilot-agent-runtime` C ABI front door (`cabi.rs`): `src/runtime/src/interop/cabi.rs` +- `github/copilot-agent-runtime` build target definitions: `script/build-runtime.ts` +- `github/copilot-agent-runtime` glibc sysroot and verification: `script/linux/install-sysroot.cjs`, `script/linux/verify-glibc-requirements.sh` +- ONNX Runtime Java on Maven Central (size comparable): https://repo1.maven.org/maven2/com/microsoft/onnxruntime/onnxruntime/1.21.0/ diff --git a/java/mvnw b/java/mvnw old mode 100644 new mode 100755 diff --git a/java/pom.xml b/java/pom.xml index 74973526a..40e998b8c 100644 --- a/java/pom.xml +++ b/java/pom.xml @@ -6,12 +6,12 @@ 4.0.0 com.github - copilot-sdk-java - 1.0.0-beta-10-java.5 - jar + copilot-sdk-java-parent + 1.0.12-SNAPSHOT + pom - GitHub Copilot SDK :: Java - SDK for programmatic control of GitHub Copilot CLI + GitHub Copilot SDK :: Java :: Parent + Parent POM for the GitHub Copilot Java SDK multi-module reactor https://github.com/github/copilot-sdk @@ -23,8 +23,8 @@ - GitHub Copilot SDK - GitHub Copilot SDK + GitHub Copilot SDK Team + GitHub https://github.com/github @@ -33,115 +33,59 @@ scm:git:https://github.com/github/copilot-sdk.git scm:git:https://github.com/github/copilot-sdk.git https://github.com/github/copilot-sdk - java/v1.0.0-beta-10-java.5 + HEAD - - - central - https://central.sonatype.com/repository/maven-snapshots/ - - + + sdk + copilot-native + + + 17 UTF-8 - - ${project.build.directory}/copilot-sdk - ${copilot.sdk.clone.dir}/test - - ${copilot.sdk.clone.dir}/nodejs/node_modules/@github/copilot/index.js - - false - ${skip.test.harness} - - + ${project.basedir}/.. - ^1.0.55-5 - + ^1.0.80 + + true - - - - com.fasterxml.jackson.core - jackson-databind - 2.21.3 - - - com.fasterxml.jackson.core - jackson-annotations - 2.21 - - - com.fasterxml.jackson.datatype - jackson-datatype-jsr310 - 2.21.3 - - - - - com.github.spotbugs - spotbugs-annotations - 4.9.8 - provided - - - - - org.junit.jupiter - junit-jupiter - 5.14.4 - test - - - org.mockito - mockito-core - 5.23.0 - test - - - + + org.apache.maven.plugins + maven-clean-plugin + 3.5.0 + + + org.apache.maven.plugins + maven-compiler-plugin + 3.15.0 + + + org.apache.maven.plugins + maven-jar-plugin + 3.5.1 + org.apache.maven.plugins maven-javadoc-plugin @@ -152,580 +96,111 @@ none + + org.apache.maven.plugins + maven-source-plugin + 3.4.0 + + + org.apache.maven.plugins + maven-surefire-plugin + 3.5.6 + + + org.apache.maven.plugins + maven-failsafe-plugin + 3.5.6 + + + org.apache.maven.plugins + maven-antrun-plugin + 3.2.0 + + + org.apache.maven.plugins + maven-enforcer-plugin + 3.6.3 + + + org.apache.maven.plugins + maven-gpg-plugin + 3.2.8 + + + org.apache.maven.plugins + maven-release-plugin + 3.1.1 + + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.6.0 + com.github.spotbugs spotbugs-maven-plugin - 4.9.8.3 + 4.10.3.0 + + + com.diffplug.spotless + spotless-maven-plugin + 2.46.1 + + + org.jacoco + jacoco-maven-plugin + 0.8.15 + + + org.codehaus.mojo + exec-maven-plugin + 3.6.3 + + + org.codehaus.mojo + build-helper-maven-plugin + 3.6.1 + + + org.sonatype.central + central-publishing-maven-plugin + 0.11.0 + + + org.codehaus.mojo + flatten-maven-plugin + 1.7.0 - config/spotbugs/spotbugs-exclude.xml + ossrh + + + flatten + process-resources + + flatten + + + + flatten-clean + clean + + clean + + + - - org.apache.maven.plugins - maven-compiler-plugin - 3.15.0 - - - org.apache.maven.plugins - maven-jar-plugin - 3.5.0 - - - - org.apache.maven.plugins - maven-antrun-plugin - 3.2.0 - - - clone-or-update-copilot-sdk - generate-test-resources - - run - - - ${skip.test.harness} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - print-test-jdk-banner - process-test-classes - - run - - - - - - - - - - - - org.apache.ant - ant - 1.10.17 - - - - org.codehaus.mojo - exec-maven-plugin - 3.6.3 - - - install-harness-dependencies - generate-test-resources - - exec - - - ${skip.test.harness} - npm - ${copilot.sdk.clone.dir}/test/harness - - install - - - - - - install-nodejs-cli-dependencies - generate-test-resources - - exec - - - ${skip.cli.install} - npm - ${copilot.sdk.clone.dir}/nodejs - - ci - --ignore-scripts - - - - - - - - org.apache.maven.plugins - maven-failsafe-plugin - 3.5.5 - - - - integration-test - verify - - - - - - ${project.build.directory} - ${project.build.finalName} - ${project.build.testOutputDirectory} - - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.5.5 - - alphabetical - - ${testExecutionAgentArgs} ${surefire.jvm.args} - - 2 - - ${copilot.tests.dir} - ${copilot.sdk.clone.dir} - - - - ${copilot.cli.path} - - - - - - isolated-resume-tests - test - - test - - - isolated-resume - - ${project.build.directory}/surefire-reports-isolated - - - - - default-test - - isolated-resume - - - - - - - org.codehaus.mojo - build-helper-maven-plugin - 3.6.1 - - - add-generated-source - generate-sources - - add-source - - - - ${project.basedir}/src/generated/java - - - - - - - com.diffplug.spotless - spotless-maven-plugin - 2.46.1 - - - - src/generated/java/**/*.java - - - 4.33 - - - - - - true - 4 - - - - - - - org.jacoco - jacoco-maven-plugin - 0.8.14 - - - - wire-up-coverage-instrumentation - - prepare-agent - - - - ${project.build.directory}/jacoco-test-results/sdk-tests.exec - - testExecutionAgentArgs - - - com/github/copilot/** - - - com/github/copilot/E2ETestContext* - com/github/copilot/CapiProxy* - - - - - - build-coverage-report-from-tests - - report - - verify - - ${project.build.directory}/jacoco-test-results/sdk-tests.exec - ${project.reporting.outputDirectory}/jacoco-coverage - - - META-INF/versions/**/*.class - - - - - - - org.apache.maven.plugins - maven-checkstyle-plugin - 3.6.0 - - config/checkstyle/checkstyle.xml - true - true - false - - - - validate - validate - - check - - - - - - com.puppycrawl.tools - checkstyle - 10.26.1 - - - - - - org.sonatype.central - central-publishing-maven-plugin - 0.10.0 - true - - central - true - - - - org.apache.maven.plugins - maven-enforcer-plugin - 3.5.0 - - - enforce-jdk25 - - enforce - - - - - [25,) - JDK 25+ is required to build the Multi-Release JAR with the virtual-thread overlay. - - - - - - verify-multi-release-overlay - verify - - enforce - - - - - - ${project.build.outputDirectory}/META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class - - Multi-Release JAR overlay missing: META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class was not compiled. Ensure the build runs on JDK 25+. - - - - - + flatten-maven-plugin - - - - - jdk21+ - - [21,) - - - -XX:+EnableDynamicAgentLoading - - - - java25-multi-release - - [25,) - - - - - org.apache.maven.plugins - maven-compiler-plugin - - - compile-java25 - compile - - compile - - - 25 - false - - ${project.basedir}/src/main/java25 - - true - - - - - - org.apache.maven.plugins - maven-jar-plugin - - - - true - - - - - - - org.apache.maven.plugins - maven-antrun-plugin - - - verify-java25-overlay - package - - run - - - - - - - - - -JDK 25 multi-release overlay class is missing from the packaged JAR. -Expected entry: META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class -JAR: ${project.build.directory}/${project.build.finalName}.jar - -This usually means the 'java25-multi-release' Maven profile did not activate -(e.g. the build is running on a JDK older than 25) or maven-compiler-plugin -did not produce the multi-release output. Re-build on JDK 25+ and verify the -'compile-java25' execution ran during the 'compile' phase. - - - - - - - - - - - - skip-test-harness - - true - - - - - skip-cli-install-when-tests-skipped - - - skipTests - true - - - - true - - - - - skip-cli-install-when-maven-test-skip - - - maven.test.skip - true - - - - true - - - - - debug - - - - org.apache.maven.plugins - maven-surefire-plugin - - - ${project.basedir}/src/test/resources/logging-debug.properties - - - - - - release @@ -733,7 +208,6 @@ did not produce the multi-release output. Re-build on JDK 25+ and verify the org.apache.maven.plugins maven-source-plugin - 3.4.0 attach-sources @@ -758,7 +232,6 @@ did not produce the multi-release output. Re-build on JDK 25+ and verify the org.apache.maven.plugins maven-gpg-plugin - 3.2.8 sign-artifacts @@ -772,103 +245,5 @@ did not produce the multi-release output. Re-build on JDK 25+ and verify the - - - update-schemas-from-npm-artifact - - - - org.codehaus.mojo - exec-maven-plugin - 3.6.3 - - - update-copilot-schema-version - generate-sources - - exec - - - npm - ${project.basedir}/scripts/codegen - - install - @github/copilot@${copilot.schema.version} - - - - - - - org.apache.maven.plugins - maven-enforcer-plugin - 3.6.3 - - - require-schema-version - validate - - enforce - - - - - copilot.schema.version - You must specify -Dcopilot.schema.version=VERSION (e.g. 1.0.25) - - - - - - - - - - - - codegen - - - - org.codehaus.mojo - exec-maven-plugin - 3.6.3 - - - codegen-npm-install - generate-sources - - exec - - - npm - ${project.basedir}/scripts/codegen - - ci - - - - - codegen-generate - generate-sources - - exec - - - npm - ${project.basedir}/scripts/codegen - - run - generate - - - - - - - - diff --git a/java/scripts/codegen/java.ts b/java/scripts/codegen/java.ts index 64fc463a0..3bdc51d03 100644 --- a/java/scripts/codegen/java.ts +++ b/java/scripts/codegen/java.ts @@ -4,13 +4,13 @@ /** * Java code generator for session-events and RPC types. - * Generates Java source files under src/generated/java/ from JSON Schema files. + * Generates Java source files under sdk/src/generated/java/ from JSON Schema files. */ import fs from "fs/promises"; +import type { JSONSchema7 } from "json-schema"; import path from "path"; import { fileURLToPath } from "url"; -import type { JSONSchema7 } from "json-schema"; const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); @@ -21,6 +21,12 @@ const REPO_ROOT = path.resolve(__dirname, "../.."); /** Event types to exclude from generation (internal/legacy types) */ const EXCLUDED_EVENT_TYPES = new Set(["session.import_legacy"]); +function isSchemaInternal(schema: JSONSchema7 | null | undefined): boolean { + return typeof schema === "object" && + schema !== null && + (schema as Record).visibility === "internal"; +} + const AUTO_GENERATED_HEADER = `// AUTO-GENERATED FILE - DO NOT EDIT`; const GENERATED_FROM_SESSION_EVENTS = `// Generated from: session-events.schema.json`; const GENERATED_FROM_API = `// Generated from: api.schema.json`; @@ -29,12 +35,96 @@ const COPYRIGHT = `/*----------------------------------------------------------- // ── Naming utilities ───────────────────────────────────────────────────────── +/** + * Correct the GitHub brand casing in a generated identifier or documentation + * string. Schema titles/definition names and value-derived identifiers may + * render the brand as "Github"; the correct casing is "GitHub". Lowercase + * wire/protocol values (e.g. "github") are left untouched. Idempotent. + */ +function fixBrandCasing(value: string): string { + return value.replace(/Github/g, "GitHub"); +} + +const BRAND_NORMALIZED_STRING_KEYS = new Set(["title", "description", "markdownDescription"]); + +/** + * Recursively normalize GitHub brand casing within a parsed JSON schema: + * definition-map keys, `$ref` pointers (definition-name segment only), and + * documentation strings. Wire-level values (`const`, `enum`, `default`, ...) are + * left untouched. Mutates in place and returns the schema. + */ +function normalizeSchemaBrandCasing(schema: T): T { + normalizeBrandCasingNode(schema); + return schema; +} + +function normalizeBrandCasingNode(node: unknown): void { + if (Array.isArray(node)) { + for (const item of node) normalizeBrandCasingNode(item); + return; + } + if (node === null || typeof node !== "object") return; + const obj = node as Record; + + for (const defsKey of ["definitions", "$defs"] as const) { + const defs = obj[defsKey]; + if (defs && typeof defs === "object" && !Array.isArray(defs)) { + renameBrandDefinitionKeys(defs as Record); + } + } + + for (const [key, value] of Object.entries(obj)) { + if (typeof value === "string") { + if (key === "$ref") { + obj[key] = fixBrandRef(value); + } else if (BRAND_NORMALIZED_STRING_KEYS.has(key)) { + obj[key] = fixBrandCasing(value); + } + } else { + normalizeBrandCasingNode(value); + } + } +} + +function fixBrandRef(ref: string): string { + const lastSlash = ref.lastIndexOf("/"); + if (lastSlash === -1) return ref; + return `${ref.slice(0, lastSlash + 1)}${fixBrandCasing(ref.slice(lastSlash + 1))}`; +} + +function stableStringify(value: unknown): string { + if (Array.isArray(value)) { + return `[${value.map((item) => stableStringify(item)).join(",")}]`; + } + + if (value && typeof value === "object") { + const entries = Object.entries(value as Record).sort(([a], [b]) => a.localeCompare(b)); + return `{${entries.map(([key, entryValue]) => `${JSON.stringify(key)}:${stableStringify(entryValue)}`).join(",")}}`; + } + + return JSON.stringify(value) ?? "undefined"; +} + +function renameBrandDefinitionKeys(defs: Record): void { + for (const oldKey of Object.keys(defs)) { + const newKey = fixBrandCasing(oldKey); + if (newKey === oldKey) continue; + if (newKey in defs && stableStringify(defs[newKey]) !== stableStringify(defs[oldKey])) { + throw new Error( + `Brand-casing normalization collision: "${oldKey}" -> "${newKey}" but a different definition already exists under "${newKey}".` + ); + } + defs[newKey] = defs[oldKey]; + delete defs[oldKey]; + } +} + function toPascalCase(name: string): string { - return name.split(/[-_.]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(""); + return fixBrandCasing(name.split(/[-_.]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join("")); } function toJavaClassName(typeName: string): string { - return typeName.split(/[._]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(""); + return fixBrandCasing(typeName.split(/[._]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join("")); } /** Java reserved keywords and Object method names that cannot be used as record component names. */ @@ -64,36 +154,61 @@ function toEnumConstant(value: string): string { // ── Schema path resolution ─────────────────────────────────────────────────── -async function getSessionEventsSchemaPath(): Promise { - const candidates = [ - path.join(REPO_ROOT, "scripts/codegen/node_modules/@github/copilot/schemas/session-events.schema.json"), - path.join(REPO_ROOT, "nodejs/node_modules/@github/copilot/schemas/session-events.schema.json"), +/** + * Resolve a JSON schema shipped by the `@github/copilot` CLI package. + * + * The CLI package layout changed in 1.0.64-1: the umbrella `@github/copilot` + * package became a thin loader and its bundled assets (including the JSON + * schemas) moved into the platform-specific packages installed as optional + * dependencies, e.g. `@github/copilot-linux-x64` or `@github/copilot-win32-x64`. + * + * We search both the Java codegen install (`scripts/codegen/node_modules`) and + * the Node SDK install (`nodejs/node_modules`), checking the umbrella package + * first (older versions) and then whichever platform package is present. + */ +async function resolveCopilotSchemaPath(fileName: string): Promise { + const nodeModulesDirs = [ + path.join(REPO_ROOT, "scripts/codegen/node_modules"), + path.join(REPO_ROOT, "nodejs/node_modules"), ]; - for (const p of candidates) { + + const candidates: string[] = []; + for (const nodeModulesDir of nodeModulesDirs) { + candidates.push(path.join(nodeModulesDir, "@github/copilot/schemas", fileName)); + const githubScopeDir = path.join(nodeModulesDir, "@github"); try { - await fs.access(p); - return p; - } catch { - // try next + for (const entry of await fs.readdir(githubScopeDir)) { + if (entry.startsWith("copilot-")) { + candidates.push(path.join(githubScopeDir, entry, "schemas", fileName)); + } + } + } catch (err) { + const code = (err as NodeJS.ErrnoException).code; + if (code !== "ENOENT" && code !== "ENOTDIR") { + throw err; + } + // @github scope directory may not exist; try the next location. } } - throw new Error("session-events.schema.json not found. Run 'npm ci' in scripts/codegen first."); -} -async function getApiSchemaPath(): Promise { - const candidates = [ - path.join(REPO_ROOT, "scripts/codegen/node_modules/@github/copilot/schemas/api.schema.json"), - path.join(REPO_ROOT, "nodejs/node_modules/@github/copilot/schemas/api.schema.json"), - ]; - for (const p of candidates) { + for (const candidate of candidates) { try { - await fs.access(p); - return p; + await fs.access(candidate); + return candidate; } catch { - // try next + // Try the next candidate. } } - throw new Error("api.schema.json not found. Run 'npm ci' in scripts/codegen first."); + + throw new Error(`${fileName} not found. Run 'npm ci' in java/scripts/codegen or java/nodejs first.`); +} + +async function getSessionEventsSchemaPath(): Promise { + return resolveCopilotSchemaPath("session-events.schema.json"); +} + +async function getApiSchemaPath(): Promise { + return resolveCopilotSchemaPath("api.schema.json"); } // ── File writing ───────────────────────────────────────────────────────────── @@ -141,6 +256,307 @@ function resolveRef(schema: JSONSchema7 | undefined): JSONSchema7 | undefined { return schema; } +function hasOmissionSentinel(schema: JSONSchema7): boolean { + return (schema.anyOf ?? []).some( + (variant) => + typeof variant === "object" + && variant !== null + && typeof (variant as JSONSchema7).not === "object" + && (variant as JSONSchema7).not !== null + && Object.keys((variant as JSONSchema7).not as object).length === 0 + ); +} + +/** + * Resolve a method's params schema to the object schema that carries its properties. + * + * Methods whose params object is entirely optional are published as + * `anyOf: [{ not: {} }, { ...object }]`, so the properties live on a variant + * rather than on the schema itself. + */ +function resolveMethodParamsSchema(method: RpcMethodNode): JSONSchema7 | undefined { + const params = resolveRef(method.params ?? undefined); + if (!params || typeof params !== "object") return undefined; + if (params.properties) return params; + if (!Array.isArray(params.anyOf)) return undefined; + const objectVariants = resolveAnyOfVariants(params.anyOf as JSONSchema7[]).filter((variant) => !!variant.properties); + return hasOmissionSentinel(params) && objectVariants.length === 1 ? objectVariants[0] : undefined; +} + +function resolveMethodParamsUnionSchema(method: RpcMethodNode): JSONSchema7 | undefined { + const params = resolveRef(method.params ?? undefined); + if (!params || typeof params !== "object" || !Array.isArray(params.anyOf)) return undefined; + const variants = resolveAnyOfVariants(params.anyOf as JSONSchema7[]); + return variants.length > 1 && findDiscriminator(variants) ? params : undefined; +} + +/** Extract the definition name from a $ref string (e.g., "#/definitions/Foo" → "Foo") */ +function extractRefName(schema: JSONSchema7 | null | undefined): string | null { + if (!schema?.$ref) return null; + // Handle cross-schema refs + const crossMatch = schema.$ref.match(/^[^#]+#\/definitions\/(.+)$/); + if (crossMatch) return crossMatch[1]; + return schema.$ref.replace(/^#\/definitions\//, ""); +} + +// ── Discriminated union support ───────────────────────────────────────────── + +interface DiscriminatorInfo { + property: string; + mapping: Map; +} + +/** + * Find a discriminator property shared by all variants in an anyOf. + * A discriminator is a property with a `const` value that uniquely identifies each variant. + */ +function findDiscriminator(variants: JSONSchema7[]): DiscriminatorInfo | null { + if (variants.length === 0) return null; + const firstVariant = variants[0]; + if (!firstVariant.properties) return null; + + for (const [propName, propSchema] of Object.entries(firstVariant.properties).sort(([a], [b]) => a.localeCompare(b))) { + if (typeof propSchema !== "object") continue; + const schema = propSchema as JSONSchema7; + if (schema.const === undefined) continue; + + const mapping = new Map(); + let isValidDiscriminator = true; + + for (const variant of variants) { + if (!variant.properties) { isValidDiscriminator = false; break; } + const variantProp = variant.properties[propName]; + if (typeof variantProp !== "object") { isValidDiscriminator = false; break; } + const variantSchema = variantProp as JSONSchema7; + if (variantSchema.const === undefined) { isValidDiscriminator = false; break; } + const key = String(variantSchema.const); + if (mapping.has(key)) { isValidDiscriminator = false; break; } + mapping.set(key, { value: variantSchema.const, schema: variant }); + } + + if (isValidDiscriminator && mapping.size === variants.length) { + return { property: propName, mapping }; + } + } + return null; +} + +/** + * Resolve anyOf variants, handling $ref to definitions. + */ +function resolveAnyOfVariants(anyOf: JSONSchema7[]): JSONSchema7[] { + return anyOf + .map((v) => { + if (v.$ref) { + const name = v.$ref.replace(/^#\/definitions\//, ""); + return currentDefinitions[name] ?? v; + } + return v; + }) + .filter((v) => v.type !== "null"); +} + +/** + * Generate a polymorphic base class and variant subclasses for a discriminated union result type. + */ +async function generatePolymorphicResultClass( + className: string, + schema: JSONSchema7, + packageName: string, + packageDir: string +): Promise { + const anyOf = schema.anyOf as JSONSchema7[]; + const variants = resolveAnyOfVariants(anyOf); + const discriminator = findDiscriminator(variants); + + if (!discriminator) { + console.warn(`[codegen] Cannot find discriminator for ${className} — skipping polymorphic generation`); + return; + } + + // Collect variant info + interface VariantInfo { + discriminatorValue: string; + variantClassName: string; + schema: JSONSchema7; + } + + const variantInfos: VariantInfo[] = []; + for (const [discValue, { schema: variantSchema }] of discriminator.mapping) { + const variantClassName = (variantSchema as JSONSchema7 & { title?: string }).title ?? `${className}${toPascalCase(discValue)}`; + variantInfos.push({ discriminatorValue: discValue, variantClassName, schema: variantSchema }); + } + + // Generate the abstract base class + const baseLines: string[] = []; + baseLines.push(COPYRIGHT); + baseLines.push(""); + baseLines.push(AUTO_GENERATED_HEADER); + baseLines.push(GENERATED_FROM_API); + baseLines.push(""); + baseLines.push(`package ${packageName};`); + baseLines.push(""); + baseLines.push(`import com.fasterxml.jackson.annotation.JsonIgnoreProperties;`); + baseLines.push(`import com.fasterxml.jackson.annotation.JsonSubTypes;`); + baseLines.push(`import com.fasterxml.jackson.annotation.JsonTypeInfo;`); + baseLines.push(`import javax.annotation.processing.Generated;`); + baseLines.push(""); + if (schema.description) { + baseLines.push(`/**`); + baseLines.push(` * ${schema.description}`); + baseLines.push(` *`); + baseLines.push(` * @since 1.0.0`); + baseLines.push(` */`); + } + baseLines.push(`@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "${discriminator.property}", visible = true)`); + baseLines.push(`@JsonSubTypes({`); + for (let i = 0; i < variantInfos.length; i++) { + const v = variantInfos[i]; + const comma = i < variantInfos.length - 1 ? "," : ""; + baseLines.push(` @JsonSubTypes.Type(value = ${v.variantClassName}.class, name = "${v.discriminatorValue}")${comma}`); + } + baseLines.push(`})`); + baseLines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`); + baseLines.push(GENERATED_ANNOTATION); + baseLines.push(`public abstract class ${className} {`); + baseLines.push(""); + baseLines.push(` /**`); + baseLines.push(` * Returns the discriminator value for this variant.`); + baseLines.push(` *`); + baseLines.push(` * @return the ${discriminator.property} discriminator`); + baseLines.push(` */`); + baseLines.push(` public abstract String get${toPascalCase(discriminator.property)}();`); + baseLines.push(`}`); + baseLines.push(""); + + await writeGeneratedFile(`${packageDir}/${className}.java`, baseLines.join("\n")); + + // Generate each variant subclass + for (const variant of variantInfos) { + await generatePolymorphicVariantClass(variant.variantClassName, variant.schema, variant.discriminatorValue, discriminator.property, className, packageName, packageDir); + } +} + +/** + * Generate a single variant subclass of a polymorphic result type. + */ +async function generatePolymorphicVariantClass( + className: string, + schema: JSONSchema7, + discriminatorValue: string, + discriminatorProperty: string, + baseClassName: string, + packageName: string, + packageDir: string +): Promise { + const allImports = new Set([ + "com.fasterxml.jackson.annotation.JsonIgnoreProperties", + "com.fasterxml.jackson.annotation.JsonInclude", + "com.fasterxml.jackson.annotation.JsonProperty", + "javax.annotation.processing.Generated", + ]); + const nestedTypes = new Map(); + + // Collect fields (excluding the discriminator property) + interface FieldInfo { + jsonName: string; + javaName: string; + javaType: string; + description?: string; + } + + const fields: FieldInfo[] = []; + if (schema.properties) { + for (const [propName, propSchema] of Object.entries(schema.properties)) { + if (propName === discriminatorProperty) continue; + if (typeof propSchema !== "object") continue; + const prop = propSchema as JSONSchema7; + const result = schemaTypeToJava(prop, false, className, propName, nestedTypes); + for (const imp of result.imports) allImports.add(imp); + fields.push({ + jsonName: propName, + javaName: toCamelCase(propName), + javaType: result.javaType, + description: prop.description, + }); + } + } + + const lines: string[] = []; + lines.push(COPYRIGHT); + lines.push(""); + lines.push(AUTO_GENERATED_HEADER); + lines.push(GENERATED_FROM_API); + lines.push(""); + lines.push(`package ${packageName};`); + lines.push(""); + + // Placeholder for imports + const importPlaceholderIdx = lines.length; + lines.push("__IMPORTS__"); + lines.push(""); + + if (schema.description) { + lines.push(`/**`); + lines.push(` * ${schema.description}`); + lines.push(` *`); + lines.push(` * @since 1.0.0`); + lines.push(` */`); + } else { + lines.push(`/**`); + lines.push(` * Variant {@code ${discriminatorValue}} of {@link ${baseClassName}}.`); + lines.push(` *`); + lines.push(` * @since 1.0.0`); + lines.push(` */`); + } + lines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`); + lines.push(`@JsonInclude(JsonInclude.Include.NON_NULL)`); + lines.push(GENERATED_ANNOTATION); + lines.push(`public final class ${className} extends ${baseClassName} {`); + lines.push(""); + + // Discriminator field + lines.push(` @JsonProperty("${discriminatorProperty}")`); + lines.push(` private final String ${toCamelCase(discriminatorProperty)} = "${discriminatorValue}";`); + lines.push(""); + lines.push(` @Override`); + lines.push(` public String get${toPascalCase(discriminatorProperty)}() { return ${toCamelCase(discriminatorProperty)}; }`); + lines.push(""); + + // Other fields + for (const field of fields) { + if (field.description) { + lines.push(` /** ${field.description} */`); + } + lines.push(` @JsonProperty("${field.jsonName}")`); + lines.push(` private ${field.javaType} ${field.javaName};`); + lines.push(""); + } + + // Getters and setters + for (const field of fields) { + lines.push(` public ${field.javaType} get${field.javaName.charAt(0).toUpperCase() + field.javaName.slice(1)}() { return ${field.javaName}; }`); + lines.push(` public void set${field.javaName.charAt(0).toUpperCase() + field.javaName.slice(1)}(${field.javaType} ${field.javaName}) { this.${field.javaName} = ${field.javaName}; }`); + lines.push(""); + } + + // Render nested types + for (const [, nested] of nestedTypes) { + lines.push(...renderNestedType(nested, 1, new Map(), allImports)); + } + + if (lines[lines.length - 1] === "") lines.pop(); + lines.push(`}`); + lines.push(""); + + // Replace import placeholder + const sortedImports = [...allImports].sort(); + const importLines = sortedImports.map((i) => `import ${i};`).join("\n"); + lines[importPlaceholderIdx] = importLines; + + await writeGeneratedFile(`${packageDir}/${className}.java`, lines.join("\n")); +} + function schemaTypeToJava( schema: JSONSchema7, required: boolean, @@ -312,6 +728,8 @@ interface EventVariant { className: string; dataSchema: JSONSchema7 | null; description?: string; + stability?: string; + deprecated?: boolean; } function extractEventVariants(schema: JSONSchema7): EventVariant[] { @@ -343,15 +761,17 @@ function extractEventVariants(schema: JSONSchema7): EventVariant[] { className: `${baseName}Event`, dataSchema: dataSchema ?? null, description: resolved.description, + stability: (variant as unknown as Record).stability as string | undefined, + deprecated: (variant as unknown as Record).deprecated === true, }; }) - .filter((v) => !EXCLUDED_EVENT_TYPES.has(v.typeName)); + .filter((v) => !EXCLUDED_EVENT_TYPES.has(v.typeName) && !isSchemaInternal(v.dataSchema)); } async function generateSessionEvents(schemaPath: string): Promise { console.log("\n📋 Generating session event classes..."); const schemaContent = await fs.readFile(schemaPath, "utf-8"); - const schema = JSON.parse(schemaContent) as JSONSchema7; + const schema = normalizeSchemaBrandCasing(JSON.parse(schemaContent) as JSONSchema7); // Set module-level definitions for $ref resolution currentDefinitions = (schema.definitions ?? {}) as Record; @@ -359,7 +779,7 @@ async function generateSessionEvents(schemaPath: string): Promise { const variants = extractEventVariants(schema); const packageName = "com.github.copilot.generated"; - const packageDir = `src/generated/java/com/github/copilot/generated`; + const packageDir = `sdk/src/generated/java/com/github/copilot/generated`; // Generate base SessionEvent class await generateSessionEventBaseClass(variants, packageName, packageDir); @@ -434,6 +854,10 @@ async function generateSessionEventBaseClass( lines.push(` @JsonProperty("parentId")`); lines.push(` private UUID parentId;`); lines.push(""); + lines.push(` /** Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */`); + lines.push(` @JsonProperty("agentId")`); + lines.push(` private String agentId;`); + lines.push(""); lines.push(` /** When true, the event is transient and not persisted to the session event log on disk. */`); lines.push(` @JsonProperty("ephemeral")`); lines.push(` private Boolean ephemeral;`); @@ -454,6 +878,9 @@ async function generateSessionEventBaseClass( lines.push(` public UUID getParentId() { return parentId; }`); lines.push(` public void setParentId(UUID parentId) { this.parentId = parentId; }`); lines.push(""); + lines.push(` public String getAgentId() { return agentId; }`); + lines.push(` public void setAgentId(String agentId) { this.agentId = agentId; }`); + lines.push(""); lines.push(` public Boolean getEphemeral() { return ephemeral; }`); lines.push(` public void setEphemeral(Boolean ephemeral) { this.ephemeral = ephemeral; }`); lines.push(`}`); @@ -634,15 +1061,22 @@ async function generateEventVariantClass( if (variant.description) { lines.push(`/**`); lines.push(` * ${variant.description}`); - lines.push(` *`); - lines.push(` * @since 1.0.0`); - lines.push(` */`); } else { lines.push(`/**`); lines.push(` * The {@code ${variant.typeName}} session event.`); + } + if (variant.stability === "experimental") { lines.push(` *`); - lines.push(` * @since 1.0.0`); - lines.push(` */`); + lines.push(` * @apiNote This method is experimental and may change in a future version.`); + } + lines.push(` * @since 1.0.0`); + lines.push(` */`); + if (variant.deprecated) { + lines.push(`@Deprecated`); + } + if (variant.stability === "experimental") { + allImports.add("com.github.copilot.CopilotExperimental"); + lines.push(`@CopilotExperimental`); } lines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`); lines.push(`@JsonInclude(JsonInclude.Include.NON_NULL)`); @@ -727,6 +1161,13 @@ async function generatePendingStandaloneTypes( await generateStandaloneEnum(name, schema, packageName, packageDir, headerComment); } else if (schema.type === "object" && schema.properties) { await generateStandaloneRecord(name, schema, packageName, packageDir, headerComment); + } else if (schema.anyOf && Array.isArray(schema.anyOf)) { + const variants = resolveAnyOfVariants(schema.anyOf as JSONSchema7[]); + if (variants.length > 1 && findDiscriminator(variants)) { + await generatePolymorphicResultClass(name, schema, packageName, packageDir); + } else { + console.warn(`[codegen] Cannot generate standalone type for ${name}: anyOf without discriminator`); + } } else { console.warn(`[codegen] Cannot generate standalone type for ${name}: type=${schema.type}`); } @@ -839,6 +1280,7 @@ interface RpcMethod { params: JSONSchema7 | null; result: JSONSchema7 | null; stability?: string; + deprecated?: boolean; } function isRpcMethod(node: unknown): node is RpcMethod { @@ -916,10 +1358,11 @@ function generateRpcClass( async function generateRpcTypes(schemaPath: string): Promise { console.log("\n🔌 Generating RPC types..."); const schemaContent = await fs.readFile(schemaPath, "utf-8"); - const schema = JSON.parse(schemaContent) as Record & { + const schema = normalizeSchemaBrandCasing(JSON.parse(schemaContent)) as Record & { server?: Record; session?: Record; clientSession?: Record; + clientGlobal?: Record; definitions?: Record; }; @@ -933,7 +1376,7 @@ async function generateRpcTypes(schemaPath: string): Promise { try { const sessionEventsSchemaPath = await getSessionEventsSchemaPath(); const sessionEventsContent = await fs.readFile(sessionEventsSchemaPath, "utf-8"); - const sessionEventsSchema = JSON.parse(sessionEventsContent) as JSONSchema7; + const sessionEventsSchema = normalizeSchemaBrandCasing(JSON.parse(sessionEventsContent) as JSONSchema7); crossSchemaDefinitions.set("session-events.schema.json", (sessionEventsSchema.definitions ?? {}) as Record); } catch (e) { @@ -941,41 +1384,98 @@ async function generateRpcTypes(schemaPath: string): Promise { } const packageName = "com.github.copilot.generated.rpc"; - const packageDir = `src/generated/java/com/github/copilot/generated/rpc`; + const packageDir = `sdk/src/generated/java/com/github/copilot/generated/rpc`; // Collect all RPC methods from all sections const sections: [string, Record][] = []; if (schema.server) sections.push(["server", schema.server]); if (schema.session) sections.push(["session", schema.session]); if (schema.clientSession) sections.push(["clientSession", schema.clientSession]); + if (schema.clientGlobal) sections.push(["clientGlobal", schema.clientGlobal]); const generatedClasses = new Map(); const allFiles: string[] = []; - for (const [, sectionNode] of sections) { + for (const [sectionName, sectionNode] of sections) { const methods = collectRpcMethods(sectionNode); for (const [, method] of methods) { const className = rpcMethodToClassName(method.rpcMethod); // Generate params class — resolve $ref if params is a reference let paramsSchema = method.params as JSONSchema7 | null; - if (paramsSchema?.$ref) paramsSchema = resolveRef(paramsSchema) as JSONSchema7; + const paramsRefName = extractRefName(paramsSchema); + if (paramsRefName && sectionName === "clientGlobal") { + const resolvedParamsSchema = resolveRef(paramsSchema ?? undefined); + if (resolvedParamsSchema?.type === "object" && resolvedParamsSchema.properties) { + pendingStandaloneTypes.set(paramsRefName, resolvedParamsSchema); + } + paramsSchema = null; + } else if (paramsSchema?.$ref) { + paramsSchema = resolveRef(paramsSchema) as JSONSchema7; + } + const paramsUnionSchema = resolveMethodParamsUnionSchema(method); + if (paramsUnionSchema) { + const paramsClassName = `${className}Params`; + if (!generatedClasses.has(paramsClassName)) { + generatedClasses.set(paramsClassName, true); + await generatePolymorphicResultClass(paramsClassName, paramsUnionSchema, packageName, packageDir); + allFiles.push(`${paramsClassName}.java`); + } + paramsSchema = null; + } + if (paramsSchema && !paramsSchema.properties) { + paramsSchema = resolveMethodParamsSchema(method) ?? paramsSchema; + } if (paramsSchema && typeof paramsSchema === "object" && paramsSchema.properties) { const paramsClassName = `${className}Params`; if (!generatedClasses.has(paramsClassName)) { generatedClasses.set(paramsClassName, true); - allFiles.push(await generateRpcDataClass(paramsClassName, paramsSchema, packageName, packageDir, method.rpcMethod, "params")); + allFiles.push(await generateRpcDataClass(paramsClassName, paramsSchema, packageName, packageDir, method.rpcMethod, "params", method.stability, method.deprecated === true)); } } // Generate result class — resolve $ref if result is a reference let resultSchema = method.result as JSONSchema7 | null; + const resultRefName = extractRefName(resultSchema); if (resultSchema?.$ref) resultSchema = resolveRef(resultSchema) as JSONSchema7; - if (resultSchema && typeof resultSchema === "object" && resultSchema.properties) { - const resultClassName = `${className}Result`; - if (!generatedClasses.has(resultClassName)) { - generatedClasses.set(resultClassName, true); - allFiles.push(await generateRpcDataClass(resultClassName, resultSchema, packageName, packageDir, method.rpcMethod, "result")); + if (resultSchema && typeof resultSchema === "object") { + if ( + resultSchema.properties && + (Object.keys(resultSchema.properties).length > 0 || + (resultRefName && sectionName === "clientGlobal")) + ) { + // Object with properties → generate a record class + const resultClassName = `${className}Result`; + if (!generatedClasses.has(resultClassName)) { + generatedClasses.set(resultClassName, true); + allFiles.push(await generateRpcDataClass(resultClassName, resultSchema, packageName, packageDir, method.rpcMethod, "result", method.stability, method.deprecated === true)); + } + } else if (resultRefName && resultSchema.type === "string" && resultSchema.enum) { + // String enum → register for standalone generation + pendingStandaloneTypes.set(resultRefName, resultSchema); + } else if (resultRefName && resultSchema.anyOf && Array.isArray(resultSchema.anyOf)) { + // anyOf discriminated union → generate polymorphic hierarchy + const variants = resolveAnyOfVariants(resultSchema.anyOf as JSONSchema7[]); + if (variants.length > 1 && findDiscriminator(variants)) { + if (!generatedClasses.has(resultRefName)) { + generatedClasses.set(resultRefName, true); + await generatePolymorphicResultClass(resultRefName, resultSchema, packageName, packageDir); + } + } + } else if (resultRefName && resultSchema.type === "object" && !resultSchema.properties) { + // Empty named object → generate empty record + if (!generatedClasses.has(resultRefName)) { + generatedClasses.set(resultRefName, true); + allFiles.push(await generateRpcDataClass(resultRefName, resultSchema, packageName, packageDir, method.rpcMethod, "result")); + } + } else if (resultRefName && resultSchema.type === "array") { + // Named array aliases (e.g. AccountGetAllUsersResult) are returned + // as List by wrappers, but resolving them here discovers any + // referenced item records that need standalone generation. + schemaTypeToJava(resultSchema, false, resultRefName, "item", new Map()); + } else if (resultSchema.type === "array") { + // Inline arrays also need their referenced item records generated. + schemaTypeToJava(resultSchema, false, `${className}Result`, "item", new Map()); } } } @@ -993,7 +1493,9 @@ async function generateRpcDataClass( packageName: string, packageDir: string, rpcMethod: string, - kind: "params" | "result" + kind: "params" | "result", + stability?: string, + deprecated?: boolean ): Promise { const nestedTypes = new Map(); const { code, imports } = generateRpcClass(className, schema, nestedTypes, packageName); @@ -1014,6 +1516,9 @@ async function generateRpcDataClass( "javax.annotation.processing.Generated", ...imports, ]); + if (stability === "experimental") { + allImports.add("com.github.copilot.CopilotExperimental"); + } const sortedImports = [...allImports].sort(); for (const imp of sortedImports) { lines.push(`import ${imp};`); @@ -1023,15 +1528,21 @@ async function generateRpcDataClass( if (schema.description) { lines.push(`/**`); lines.push(` * ${schema.description}`); - lines.push(` *`); - lines.push(` * @since 1.0.0`); - lines.push(` */`); } else { lines.push(`/**`); lines.push(` * ${kind === "params" ? "Request parameters" : "Result"} for the {@code ${rpcMethod}} RPC method.`); + } + if (stability === "experimental") { lines.push(` *`); - lines.push(` * @since 1.0.0`); - lines.push(` */`); + lines.push(` * @apiNote This method is experimental and may change in a future version.`); + } + lines.push(` * @since 1.0.0`); + lines.push(` */`); + if (deprecated) { + lines.push(`@Deprecated`); + } + if (stability === "experimental") { + lines.push(`@CopilotExperimental`); } lines.push(GENERATED_ANNOTATION); lines.push(code); @@ -1047,6 +1558,7 @@ async function generateRpcDataClass( interface RpcMethodNode { rpcMethod: string; stability: string; + deprecated: boolean; params: JSONSchema7 | null; result: JSONSchema7 | null; } @@ -1067,6 +1579,7 @@ function buildNamespaceTree(node: Record): NamespaceTree { tree.methods.set(key, { rpcMethod: String(obj.rpcMethod), stability: String(obj.stability ?? "stable"), + deprecated: obj.deprecated === true, params: (obj.params as JSONSchema7) ?? null, result: (obj.result as JSONSchema7) ?? null, }); @@ -1091,12 +1604,49 @@ function apiClassName(prefix: string, path: string[]): string { } /** - * Derive the result class name for an RPC method. - * If the result schema has no properties we use Void; if no result schema we also use Void. + * Derive the Java result type for an RPC method. + * Handles $ref to named definitions (enums, anyOf unions, objects with properties, arrays). + * Falls back to Void for null results or schemas with no meaningful type. */ function wrapperResultClassName(method: RpcMethodNode): string { - let result = method.result; - if (result?.$ref) result = resolveRef(result) as JSONSchema7; + const originalResult = method.result; + if (!originalResult) return "Void"; + + // If result is a $ref, use the definition name directly + const refName = extractRefName(originalResult); + if (refName) { + const resolved = currentDefinitions[refName]; + if (resolved) { + // String enum → use the definition name + if (resolved.type === "string" && resolved.enum) { + return refName; + } + // anyOf discriminated union → use the definition name + if (resolved.anyOf && Array.isArray(resolved.anyOf)) { + const variants = resolveAnyOfVariants(resolved.anyOf as JSONSchema7[]); + if (variants.length > 1 && findDiscriminator(variants)) { + return refName; + } + } + // Object with properties → use MethodNameResult + if (resolved.type === "object" && resolved.properties && Object.keys(resolved.properties).length > 0) { + return rpcMethodToClassName(method.rpcMethod) + "Result"; + } + // Empty object (no properties) that is a named definition → use definition name + if (resolved.type === "object" && !resolved.properties) { + return refName; + } + // Named array aliases → use the underlying List Java type. + if (resolved.type === "array") { + const result = schemaTypeToJava(resolved, false, refName, "item", new Map()); + return result.javaType; + } + } + } + + // Inline result schema with properties + let result = originalResult; + if (result.$ref) result = resolveRef(result) as JSONSchema7; if ( result && typeof result === "object" && @@ -1105,30 +1655,90 @@ function wrapperResultClassName(method: RpcMethodNode): string { ) { return rpcMethodToClassName(method.rpcMethod) + "Result"; } + + if (result && typeof result === "object" && result.type === "array") { + const javaResult = schemaTypeToJava(result, false, `${rpcMethodToClassName(method.rpcMethod)}Result`, "item", new Map()); + return javaResult.javaType; + } + + // Free-form object with additionalProperties (e.g., x-opaque-json) → JsonNode + if ( + result && + typeof result === "object" && + result.type === "object" && + result.additionalProperties && + !result.properties + ) { + return "JsonNode"; + } + return "Void"; } +function wrapperResultTypeExpression(resultType: string): string { + const listMatch = resultType.match(/^List<([^<>]+)>$/); + if (listMatch) { + return `RpcMapper.INSTANCE.getTypeFactory().constructCollectionType(List.class, ${javaClassLiteral(listMatch[1])})`; + } + + return javaClassLiteral(resultType); +} + +function javaClassLiteral(javaType: string): string { + return javaType === "Void" ? "Void.class" : `${javaType}.class`; +} + +function addWrapperResultImports(resultType: string, allImports: Set, packageName: string): void { + if (resultType === "Void") { + return; + } + + if (resultType === "JsonNode") { + allImports.add("com.fasterxml.jackson.databind.JsonNode"); + return; + } + + if (resultType.startsWith("List<")) { + allImports.add("java.util.List"); + } + + const builtInTypes = new Set(["Boolean", "Double", "Long", "List", "Object", "String", "Void"]); + for (const typeName of resultType.match(/\b[A-Z][A-Za-z0-9_]*\b/g) ?? []) { + if (!builtInTypes.has(typeName)) { + allImports.add(`${packageName}.${typeName}`); + } + } +} + /** - * Return the params class name if the method has a params schema with properties - * other than sessionId (i.e. there are user-supplied parameters). + * Return the params class name if the method has a params schema with user-supplied properties. + * Session-scoped wrappers inject sessionId automatically, but server-scoped wrappers must let + * callers supply it explicitly. */ -function wrapperParamsClassName(method: RpcMethodNode): string | null { - let params = method.params; - if (params?.$ref) params = resolveRef(params) as JSONSchema7; - if (!params || typeof params !== "object") return null; +function wrapperParamsClassName(method: RpcMethodNode, isSession: boolean): string | null { + if (resolveMethodParamsUnionSchema(method)) { + return rpcMethodToClassName(method.rpcMethod) + "Params"; + } + const params = resolveMethodParamsSchema(method); + if (!params) return null; const props = params.properties ?? {}; - const userProps = Object.keys(props).filter((k) => k !== "sessionId"); + const userProps = Object.keys(props).filter((k) => !isSession || k !== "sessionId"); if (userProps.length === 0) return null; return rpcMethodToClassName(method.rpcMethod) + "Params"; } /** True if the method's params schema contains a "sessionId" property */ function methodHasSessionId(method: RpcMethodNode): boolean { - let params = method.params; - if (params?.$ref) params = resolveRef(params) as JSONSchema7; + const params = resolveMethodParamsSchema(method); return !!params?.properties && "sessionId" in params.properties; } +/** True if the method's params object may be omitted entirely */ +function methodParamsAreOptional(method: RpcMethodNode): boolean { + const params = resolveRef(method.params ?? undefined); + return !!params && typeof params === "object" && hasOmissionSentinel(params); +} + /** * Generate the Java source for a single method in a wrapper API class. * Returns the Java source lines and whether an ObjectMapper is required. @@ -1138,11 +1748,12 @@ function generateApiMethod( method: RpcMethodNode, isSession: boolean, sessionIdExpr: string -): { lines: string[]; needsMapper: boolean } { +): { lines: string[]; needsMapper: boolean; needsExperimentalImport: boolean } { const resultClass = wrapperResultClassName(method); - const paramsClass = wrapperParamsClassName(method); + const paramsClass = wrapperParamsClassName(method, isSession); const hasSessionId = methodHasSessionId(method); const hasExtraParams = paramsClass !== null; + const paramsOptional = hasExtraParams && methodParamsAreOptional(method); let needsMapper = false; const lines: string[] = []; @@ -1151,19 +1762,38 @@ function generateApiMethod( const description = (method.params as JSONSchema7 | null)?.description ?? (method.result as JSONSchema7 | null)?.description ?? `Invokes {@code ${method.rpcMethod}}.`; - lines.push(` /**`); - lines.push(` * ${description}`); - if (isSession && hasExtraParams && hasSessionId) { - lines.push(` *

`); - lines.push(` * Note: the {@code sessionId} field in the params record is overridden`); - lines.push(` * by the session-scoped wrapper; any value provided is ignored.`); - } - if (method.stability === "experimental") { - lines.push(` *`); - lines.push(` * @apiNote This method is experimental and may change in a future version.`); + const pushJavadoc = (extraLines: string[] = [], includeSessionIdNote = true): void => { + lines.push(` /**`); + lines.push(` * ${description}`); + if (includeSessionIdNote && isSession && hasExtraParams && hasSessionId) { + lines.push(` *

`); + lines.push(` * Note: the {@code sessionId} field in the params record is overridden`); + lines.push(` * by the session-scoped wrapper; any value provided is ignored.`); + } + lines.push(...extraLines); + if (method.stability === "experimental") { + lines.push(` *`); + lines.push(` * @apiNote This method is experimental and may change in a future version.`); + } + lines.push(` * @since 1.0.0`); + lines.push(` */`); + if (method.deprecated) { + lines.push(` @Deprecated`); + } + if (method.stability === "experimental") { + lines.push(` @CopilotExperimental`); + } + }; + + if (paramsOptional) { + pushJavadoc([` *

`, ` * Invokes the method with no params, applying the runtime defaults.`], false); + lines.push(` public CompletableFuture<${resultClass}> ${key}() {`); + lines.push(` return ${key}(null);`); + lines.push(` }`); + lines.push(``); } - lines.push(` * @since 1.0.0`); - lines.push(` */`); + + pushJavadoc(); // Signature if (hasExtraParams) { @@ -1177,27 +1807,31 @@ function generateApiMethod( if (hasExtraParams) { // Merge sessionId into the params using Jackson ObjectNode needsMapper = true; - lines.push(` com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params);`); + const paramsNode = paramsOptional + ? `params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params)` + : `MAPPER.valueToTree(params)`; + lines.push(` com.fasterxml.jackson.databind.node.ObjectNode _p = ${paramsNode};`); lines.push(` _p.put("sessionId", ${sessionIdExpr});`); - lines.push(` return caller.invoke("${method.rpcMethod}", _p, ${resultClass}.class);`); + lines.push(` return caller.invoke("${method.rpcMethod}", _p, ${wrapperResultTypeExpression(resultClass)});`); } else if (hasSessionId) { - lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of("sessionId", ${sessionIdExpr}), ${resultClass}.class);`); + lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of("sessionId", ${sessionIdExpr}), ${wrapperResultTypeExpression(resultClass)});`); } else { - lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of(), ${resultClass}.class);`); + lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of(), ${wrapperResultTypeExpression(resultClass)});`); } } else { // Server-side: pass params directly (or empty map if no params) if (hasExtraParams) { - lines.push(` return caller.invoke("${method.rpcMethod}", params, ${resultClass}.class);`); + const paramsArg = paramsOptional ? `params == null ? java.util.Map.of() : params` : `params`; + lines.push(` return caller.invoke("${method.rpcMethod}", ${paramsArg}, ${wrapperResultTypeExpression(resultClass)});`); } else { - lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of(), ${resultClass}.class);`); + lines.push(` return caller.invoke("${method.rpcMethod}", java.util.Map.of(), ${wrapperResultTypeExpression(resultClass)});`); } } lines.push(` }`); lines.push(``); - return { lines, needsMapper }; + return { lines, needsMapper, needsExperimentalImport: method.stability === "experimental" }; } /** @@ -1242,13 +1876,14 @@ async function generateNamespaceApiFile( const methodLines: string[] = []; for (const [key, method] of tree.methods) { const resultClass = wrapperResultClassName(method); - const paramsClass = wrapperParamsClassName(method); - if (resultClass !== "Void") allImports.add(`${packageName}.${resultClass}`); + const paramsClass = wrapperParamsClassName(method, isSession); + addWrapperResultImports(resultClass, allImports, packageName); if (paramsClass) allImports.add(`${packageName}.${paramsClass}`); - const { lines, needsMapper: nm } = generateApiMethod(key, method, isSession, sessionIdExpr); + const { lines, needsMapper: nm, needsExperimentalImport } = generateApiMethod(key, method, isSession, sessionIdExpr); methodLines.push(...lines); if (nm) needsMapper = true; + if (needsExperimentalImport) allImports.add("com.github.copilot.CopilotExperimental"); } // Build class body @@ -1361,13 +1996,14 @@ async function generateRpcRootFile( const methodLines: string[] = []; for (const [key, method] of tree.methods) { const resultClass = wrapperResultClassName(method); - const paramsClass = wrapperParamsClassName(method); - if (resultClass !== "Void") allImports.add(`${packageName}.${resultClass}`); + const paramsClass = wrapperParamsClassName(method, isSession); + addWrapperResultImports(resultClass, allImports, packageName); if (paramsClass) allImports.add(`${packageName}.${paramsClass}`); - const { lines, needsMapper: nm } = generateApiMethod(key, method, isSession, sessionIdExpr); + const { lines, needsMapper: nm, needsExperimentalImport } = generateApiMethod(key, method, isSession, sessionIdExpr); methodLines.push(...lines); if (nm) needsMapper = true; + if (needsExperimentalImport) allImports.add("com.github.copilot.CopilotExperimental"); } // Build file content @@ -1465,7 +2101,10 @@ async function generateRpcCallerInterface(packageName: string, packageDir: strin lines.push(``); lines.push(`package ${packageName};`); lines.push(``); + lines.push(`import com.fasterxml.jackson.databind.JavaType;`); + lines.push(`import com.fasterxml.jackson.databind.JsonNode;`); lines.push(`import java.util.concurrent.CompletableFuture;`); + lines.push(`import java.util.concurrent.CompletionException;`); lines.push(`import javax.annotation.processing.Generated;`); lines.push(``); lines.push(`/**`); @@ -1493,6 +2132,28 @@ async function generateRpcCallerInterface(packageName: string, packageDir: strin lines.push(` * @return a {@link CompletableFuture} that completes with the deserialized result`); lines.push(` */`); lines.push(` CompletableFuture invoke(String method, Object params, Class resultType);`); + lines.push(``); + lines.push(` /**`); + lines.push(` * Invokes a JSON-RPC method and returns a future for the typed response.`); + lines.push(` *`); + lines.push(` * @param the expected response type`); + lines.push(` * @param method the JSON-RPC method name`); + lines.push(` * @param params the request parameters (may be a {@code Map}, DTO record, or {@code JsonNode})`); + lines.push(` * @param resultType the Jackson {@link JavaType} of the expected response type`); + lines.push(` * @return a {@link CompletableFuture} that completes with the deserialized result`); + lines.push(` */`); + lines.push(` default CompletableFuture invoke(String method, Object params, JavaType resultType) {`); + lines.push(` if (resultType.hasRawClass(Void.class) || resultType.hasRawClass(Void.TYPE)) {`); + lines.push(` return invoke(method, params, Void.class).thenApply(ignored -> null);`); + lines.push(` }`); + lines.push(` return invoke(method, params, JsonNode.class).thenApply(result -> {`); + lines.push(` try {`); + lines.push(` return RpcMapper.INSTANCE.readerFor(resultType).readValue(result);`); + lines.push(` } catch (java.io.IOException e) {`); + lines.push(` throw new CompletionException(e);`); + lines.push(` }`); + lines.push(` });`); + lines.push(` }`); lines.push(`}`); lines.push(``); @@ -1552,7 +2213,7 @@ async function generateRpcWrappers(schemaPath: string): Promise { console.log("\n🔧 Generating RPC wrapper classes..."); const schemaContent = await fs.readFile(schemaPath, "utf-8"); - const schema = JSON.parse(schemaContent) as { + const schema = normalizeSchemaBrandCasing(JSON.parse(schemaContent)) as { server?: Record; session?: Record; clientSession?: Record; @@ -1563,7 +2224,7 @@ async function generateRpcWrappers(schemaPath: string): Promise { currentDefinitions = (schema.definitions ?? {}) as Record; const packageName = "com.github.copilot.generated.rpc"; - const packageDir = `src/generated/java/com/github/copilot/generated/rpc`; + const packageDir = `sdk/src/generated/java/com/github/copilot/generated/rpc`; // RpcCaller interface and shared ObjectMapper holder await generateRpcCallerInterface(packageName, packageDir); @@ -1584,12 +2245,113 @@ async function generateRpcWrappers(schemaPath: string): Promise { console.log(`✅ RPC wrapper classes generated`); } +// ── Package-info generation ────────────────────────────────────────────────── + +async function generateGeneratedPackageInfo(packageDir: string): Promise { + const lines: string[] = []; + lines.push(COPYRIGHT); + lines.push(""); + lines.push(AUTO_GENERATED_HEADER); + lines.push(GENERATED_FROM_SESSION_EVENTS); + lines.push(""); + lines.push(`/**`); + lines.push(` * Auto-generated session event types for the GitHub Copilot SDK.`); + lines.push(` *`); + lines.push(` *

`); + lines.push(` * This package contains Java classes generated from the Copilot CLI's`); + lines.push(` * {@code session-events.schema.json}. Each event type corresponds to a`); + lines.push(` * notification emitted during a {@link com.github.copilot.CopilotSession}`); + lines.push(` * interaction.`); + lines.push(` *`); + lines.push(` *

Key Classes

`); + lines.push(` *
    `); + lines.push(` *
  • {@link com.github.copilot.generated.SessionEvent} - Abstract sealed base`); + lines.push(` * class for all session events. Deserialized polymorphically via the`); + lines.push(` * {@code type} discriminator.
    • `); + lines.push(` *
  • {@link com.github.copilot.generated.UnknownSessionEvent} - Fallback for`); + lines.push(` * event types not yet known to this SDK version, preserving forward`); + lines.push(` * compatibility.
    • `); + lines.push(` *
`); + lines.push(` *`); + lines.push(` *

Example Usage

`); + lines.push(` *`); + lines.push(` * 
{@code`);
+    lines.push(` * session.on(AssistantMessageEvent.class, msg -> {`);
+    lines.push(` *     System.out.println(msg.getData().content());`);
+    lines.push(` * });`);
+    lines.push(` * }
`); + lines.push(` *`); + lines.push(` *

Related Packages

`); + lines.push(` *
    `); + lines.push(` *
  • {@link com.github.copilot} - Core SDK classes
    • `); + lines.push(` *
  • {@link com.github.copilot.generated.rpc} - Auto-generated RPC`); + lines.push(` * parameter and result types
    • `); + lines.push(` *
`); + lines.push(` *`); + lines.push(` * @see com.github.copilot.CopilotSession`); + lines.push(` * @see com.github.copilot.generated.SessionEvent`); + lines.push(` */`); + lines.push(`package com.github.copilot.generated;`); + lines.push(""); + + await writeGeneratedFile(`${packageDir}/package-info.java`, lines.join("\n")); +} + +async function generateRpcPackageInfo(packageDir: string): Promise { + const lines: string[] = []; + lines.push(COPYRIGHT); + lines.push(""); + lines.push(AUTO_GENERATED_HEADER); + lines.push(GENERATED_FROM_API); + lines.push(""); + lines.push(`/**`); + lines.push(` * Auto-generated RPC parameter and result types for the GitHub Copilot SDK.`); + lines.push(` *`); + lines.push(` *

`); + lines.push(` * This package contains Java records and classes generated from the Copilot`); + lines.push(` * CLI's {@code api.schema.json}. These types represent the request parameters`); + lines.push(` * and response payloads for all JSON-RPC methods exposed by the CLI.`); + lines.push(` *`); + lines.push(` *

Key Classes

`); + lines.push(` *
    `); + lines.push(` *
  • {@link com.github.copilot.generated.rpc.RpcCaller} - Functional interface`); + lines.push(` * for invoking JSON-RPC methods with typed responses.
    • `); + lines.push(` *
  • {@link com.github.copilot.generated.rpc.ServerRpc} - Typed client for`); + lines.push(` * server-level RPC methods (session management, model listing, etc.).
    • `); + lines.push(` *
  • {@link com.github.copilot.generated.rpc.SessionRpc} - Typed client for`); + lines.push(` * session-scoped RPC methods (send messages, manage tools, etc.). Automatically`); + lines.push(` * injects the {@code sessionId} into every call.
    • `); + lines.push(` *
`); + lines.push(` *`); + lines.push(` *

Related Packages

`); + lines.push(` *
    `); + lines.push(` *
  • {@link com.github.copilot} - Core SDK classes
    • `); + lines.push(` *
  • {@link com.github.copilot.generated} - Auto-generated session event`); + lines.push(` * types
    • `); + lines.push(` *
`); + lines.push(` *`); + lines.push(` * @see com.github.copilot.CopilotClient`); + lines.push(` * @see com.github.copilot.generated.rpc.ServerRpc`); + lines.push(` * @see com.github.copilot.generated.rpc.SessionRpc`); + lines.push(` */`); + lines.push(`package com.github.copilot.generated.rpc;`); + lines.push(""); + + await writeGeneratedFile(`${packageDir}/package-info.java`, lines.join("\n")); +} + // ── Main entry point ────────────────────────────────────────────────────────── async function main(): Promise { console.log("🚀 Java SDK code generator"); console.log("============================"); + // Clean the generated output directory to remove orphaned files from previous runs + const generatedOutputDir = path.join(REPO_ROOT, "sdk/src/generated/java/com/github/copilot/generated"); + console.log(`🧹 Cleaning output directory: ${generatedOutputDir}`); + await fs.rm(generatedOutputDir, { recursive: true, force: true }); + await fs.mkdir(generatedOutputDir, { recursive: true }); + const sessionEventsSchemaPath = await getSessionEventsSchemaPath(); console.log(`📄 Session events schema: ${sessionEventsSchemaPath}`); const apiSchemaPath = await getApiSchemaPath(); @@ -1599,6 +2361,12 @@ async function main(): Promise { await generateRpcTypes(apiSchemaPath); await generateRpcWrappers(apiSchemaPath); + // Generate package-info.java for each generated package + const generatedPkgDir = `sdk/src/generated/java/com/github/copilot/generated`; + const rpcPkgDir = `sdk/src/generated/java/com/github/copilot/generated/rpc`; + await generateGeneratedPackageInfo(generatedPkgDir); + await generateRpcPackageInfo(rpcPkgDir); + console.log("\n✅ Java code generation complete!"); } diff --git a/java/scripts/codegen/package-lock.json b/java/scripts/codegen/package-lock.json index a0c6c648f..69b854f4f 100644 --- a/java/scripts/codegen/package-lock.json +++ b/java/scripts/codegen/package-lock.json @@ -6,15 +6,15 @@ "": { "name": "copilot-sdk-java-codegen", "dependencies": { - "@github/copilot": "^1.0.55-5", + "@github/copilot": "^1.0.80", "json-schema": "^0.4.0", - "tsx": "^4.20.6" + "tsx": "^4.23.1" } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.7.tgz", - "integrity": "sha512-EKX3Qwmhz1eMdEJokhALr0YiD0lhQNwDqkPYyPhiSwKrh7/4KRjQc04sZ8db+5DVVnZ1LmbNDI1uAMPEUBnQPg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -28,9 +28,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.7.tgz", - "integrity": "sha512-jbPXvB4Yj2yBV7HUfE2KHe4GJX51QplCN1pGbYjvsyCZbQmies29EoJbkEc+vYuU5o45AfQn37vZlyXy4YJ8RQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -44,9 +44,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.7.tgz", - "integrity": "sha512-62dPZHpIXzvChfvfLJow3q5dDtiNMkwiRzPylSCfriLvZeq0a1bWChrGx/BbUbPwOrsWKMn8idSllklzBy+dgQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -60,9 +60,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.7.tgz", - "integrity": "sha512-x5VpMODneVDb70PYV2VQOmIUUiBtY3D3mPBG8NxVk5CogneYhkR7MmM3yR/uMdITLrC1ml/NV1rj4bMJuy9MCg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -76,9 +76,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.7.tgz", - "integrity": "sha512-5lckdqeuBPlKUwvoCXIgI2D9/ABmPq3Rdp7IfL70393YgaASt7tbju3Ac+ePVi3KDH6N2RqePfHnXkaDtY9fkw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -92,9 +92,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.7.tgz", - "integrity": "sha512-rYnXrKcXuT7Z+WL5K980jVFdvVKhCHhUwid+dDYQpH+qu+TefcomiMAJpIiC2EM3Rjtq0sO3StMV/+3w3MyyqQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -108,9 +108,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.7.tgz", - "integrity": "sha512-B48PqeCsEgOtzME2GbNM2roU29AMTuOIN91dsMO30t+Ydis3z/3Ngoj5hhnsOSSwNzS+6JppqWsuhTp6E82l2w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -124,9 +124,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.7.tgz", - "integrity": "sha512-jOBDK5XEjA4m5IJK3bpAQF9/Lelu/Z9ZcdhTRLf4cajlB+8VEhFFRjWgfy3M1O4rO2GQ/b2dLwCUGpiF/eATNQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -140,9 +140,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.7.tgz", - "integrity": "sha512-RkT/YXYBTSULo3+af8Ib0ykH8u2MBh57o7q/DAs3lTJlyVQkgQvlrPTnjIzzRPQyavxtPtfg0EopvDyIt0j1rA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -156,9 +156,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.7.tgz", - "integrity": "sha512-RZPHBoxXuNnPQO9rvjh5jdkRmVizktkT7TCDkDmQ0W2SwHInKCAV95GRuvdSvA7w4VMwfCjUiPwDi0ZO6Nfe9A==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -172,9 +172,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.7.tgz", - "integrity": "sha512-GA48aKNkyQDbd3KtkplYWT102C5sn/EZTY4XROkxONgruHPU72l+gW+FfF8tf2cFjeHaRbWpOYa/uRBz/Xq1Pg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -188,9 +188,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.7.tgz", - "integrity": "sha512-a4POruNM2oWsD4WKvBSEKGIiWQF8fZOAsycHOt6JBpZ+JN2n2JH9WAv56SOyu9X5IqAjqSIPTaJkqN8F7XOQ5Q==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -204,9 +204,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.7.tgz", - "integrity": "sha512-KabT5I6StirGfIz0FMgl1I+R1H73Gp0ofL9A3nG3i/cYFJzKHhouBV5VWK1CSgKvVaG4q1RNpCTR2LuTVB3fIw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -220,9 +220,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.7.tgz", - "integrity": "sha512-gRsL4x6wsGHGRqhtI+ifpN/vpOFTQtnbsupUF5R5YTAg+y/lKelYR1hXbnBdzDjGbMYjVJLJTd2OFmMewAgwlQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -236,9 +236,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.7.tgz", - "integrity": "sha512-hL25LbxO1QOngGzu2U5xeXtxXcW+/GvMN3ejANqXkxZ/opySAZMrc+9LY/WyjAan41unrR3YrmtTsUpwT66InQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -252,9 +252,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.7.tgz", - "integrity": "sha512-2k8go8Ycu1Kb46vEelhu1vqEP+UeRVj2zY1pSuPdgvbd5ykAw82Lrro28vXUrRmzEsUV0NzCf54yARIK8r0fdw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -268,9 +268,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.7.tgz", - "integrity": "sha512-hzznmADPt+OmsYzw1EE33ccA+HPdIqiCRq7cQeL1Jlq2gb1+OyWBkMCrYGBJ+sxVzve2ZJEVeePbLM2iEIZSxA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -284,9 +284,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.7.tgz", - "integrity": "sha512-b6pqtrQdigZBwZxAn1UpazEisvwaIDvdbMbmrly7cDTMFnw/+3lVxxCTGOrkPVnsYIosJJXAsILG9XcQS+Yu6w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -300,9 +300,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.7.tgz", - "integrity": "sha512-OfatkLojr6U+WN5EDYuoQhtM+1xco+/6FSzJJnuWiUw5eVcicbyK3dq5EeV/QHT1uy6GoDhGbFpprUiHUYggrw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -316,9 +316,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.7.tgz", - "integrity": "sha512-AFuojMQTxAz75Fo8idVcqoQWEHIXFRbOc1TrVcFSgCZtQfSdc1RXgB3tjOn/krRHENUB4j00bfGjyl2mJrU37A==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -332,9 +332,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.7.tgz", - "integrity": "sha512-+A1NJmfM8WNDv5CLVQYJ5PshuRm/4cI6WMZRg1by1GwPIQPCTs1GLEUHwiiQGT5zDdyLiRM/l1G0Pv54gvtKIg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -348,9 +348,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.7.tgz", - "integrity": "sha512-+KrvYb/C8zA9CU/g0sR6w2RBw7IGc5J2BPnc3dYc5VJxHCSF1yNMxTV5LQ7GuKteQXZtspjFbiuW5/dOj7H4Yw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -364,9 +364,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.7.tgz", - "integrity": "sha512-ikktIhFBzQNt/QDyOL580ti9+5mL/YZeUPKU2ivGtGjdTYoqz6jObj6nOMfhASpS4GU4Q/Clh1QtxWAvcYKamA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -380,9 +380,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.7.tgz", - "integrity": "sha512-7yRhbHvPqSpRUV7Q20VuDwbjW5kIMwTHpptuUzV+AA46kiPze5Z7qgt6CLCK3pWFrHeNfDd1VKgyP4O+ng17CA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -396,9 +396,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.7.tgz", - "integrity": "sha512-SmwKXe6VHIyZYbBLJrhOoCJRB/Z1tckzmgTLfFYOfpMAx63BJEaL9ExI8x7v0oAO3Zh6D/Oi1gVxEYr5oUCFhw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -412,9 +412,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.7.tgz", - "integrity": "sha512-56hiAJPhwQ1R4i+21FVF7V8kSD5zZTdHcVuRFMW0hn753vVfQN8xlx4uOPT4xoGH0Z/oVATuR82AiqSTDIpaHg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -428,9 +428,9 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.55-5.tgz", - "integrity": "sha512-n6Vr876Iz41PW8pSpOa7SbrNCqaV+6HDLNf/n8V4gIwwlOlIz7Jb00r/fboXZFIT+0dyAGGLoGgd7xUujVL/Xw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.80.tgz", + "integrity": "sha512-6tf93ZF56KOiTTAjK/UhLZkl1W543IzaTQly288kockJZFswpRTnQEI00Yvacpb39DTvTYu3/ha9SeKpo/pgZQ==", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "detect-libc": "^2.1.2" @@ -439,20 +439,20 @@ "copilot": "npm-loader.js" }, "optionalDependencies": { - "@github/copilot-darwin-arm64": "1.0.55-5", - "@github/copilot-darwin-x64": "1.0.55-5", - "@github/copilot-linux-arm64": "1.0.55-5", - "@github/copilot-linux-x64": "1.0.55-5", - "@github/copilot-linuxmusl-arm64": "1.0.55-5", - "@github/copilot-linuxmusl-x64": "1.0.55-5", - "@github/copilot-win32-arm64": "1.0.55-5", - "@github/copilot-win32-x64": "1.0.55-5" + "@github/copilot-darwin-arm64": "1.0.80", + "@github/copilot-darwin-x64": "1.0.80", + "@github/copilot-linux-arm64": "1.0.80", + "@github/copilot-linux-x64": "1.0.80", + "@github/copilot-linuxmusl-arm64": "1.0.80", + "@github/copilot-linuxmusl-x64": "1.0.80", + "@github/copilot-win32-arm64": "1.0.80", + "@github/copilot-win32-x64": "1.0.80" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.55-5.tgz", - "integrity": "sha512-Mult62GJVnxR3MOP2QNiVU5RRGXPJ+7BpjEMIvkoaMuWX6J7F4bz7N+HUXVHJUiGUp3hnL3M16kjkewWfNdoNg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.80.tgz", + "integrity": "sha512-fzn4PnSx3+O/a3ip72KVsjnzORsEygK+0i21bFAnFBYS+0Wi1Pk+o/CmNsJ7aRbf1enSJrcH8UDVkyc9pMGEBg==", "cpu": [ "arm64" ], @@ -466,9 +466,9 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.55-5.tgz", - "integrity": "sha512-IfY3WhNvHwXHldI2ARsiAYuPlKWlI07Fo1ALq+SViHhn0Zfp2yIr9laJRofyj0G1EbyUxkbNlqQm7UrXhkEVeg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.80.tgz", + "integrity": "sha512-PKsyGk5DccNzR3bYXcYTGB9N6sHzhzGqEwq/2t1qBwqPbrC98Zo2dOT2G40/QYpJ4XdrGmTmdmfPJQ9PJknlIQ==", "cpu": [ "x64" ], @@ -482,9 +482,9 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.55-5.tgz", - "integrity": "sha512-UPZ5Y5QotcZvo3f4yFwJVOtAgUT3mq+q2fim82kWa/MA0+EkkADZ3kb+R4OnV1Nqv5EaoZiCFh0Ukk++IMSYwQ==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.80.tgz", + "integrity": "sha512-8oXwN2luyHEjIoSk8AkATBjXDhRoQtuiUvC93GpfQKFHI+I1eoOVwIsAq5fKP8jNCF2rOrYFIcTjwmRt38kCcQ==", "cpu": [ "arm64" ], @@ -498,9 +498,9 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.55-5.tgz", - "integrity": "sha512-Fdwiir53Ogg8C9xv6sTc7/C4vFfQHt6VWFB74kojbDgIbYEpm57wNygQVwJvrwtVW3w/b1MLtGGTp7pEvUBACQ==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.80.tgz", + "integrity": "sha512-qv1ytVNwA3IDK7kcQow+fAikD67t42+AQ8X42bK/7oudNiv4frVZMO0yh1DYIebVRcmEhmPvbVPY/ptVUK3cbA==", "cpu": [ "x64" ], @@ -514,9 +514,9 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.55-5.tgz", - "integrity": "sha512-NqPmeAA1+iI8Xd4wJUHNNCmVTmHCl+R3nqdXhEVQDLIau9ouGqGGay/91d2ZIgFXJn7J0UTAEdHbdBcfhbnhvg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.80.tgz", + "integrity": "sha512-Qjyi+OlVnPC4Lkuy7blDMMwMUQI/yELl7gDnqQlaN8TEbhZqZueuf3p0a+kEjXcNsw4XtNYQc0eMJqSIYy/Pjg==", "cpu": [ "arm64" ], @@ -530,9 +530,9 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.55-5.tgz", - "integrity": "sha512-bOB4vKw1R7Mekn8z34xpNViYUQ4LQAEFzpkyxhc0uOliFmfku/YcIgo42aMWFzf/Bi3iBazBNfCN+L2lz/Jc9A==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.80.tgz", + "integrity": "sha512-rBg8pugf+5FhiZxi2zkOr+rlcOVF6Xg63j1FvryfwPT4DJ2w5Na7O3lpS4sgu8QmsP5H+dAqjlXYLYsvSoVQ0g==", "cpu": [ "x64" ], @@ -546,9 +546,9 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.55-5.tgz", - "integrity": "sha512-pR2KaiXUanjxolaWgRPlFdeTEpb7jcN1Rk8xVnBCD2ORwERXdYrqXaLCyDbgdplI9mI6IjM+kkUbyXzXoWz/HQ==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.80.tgz", + "integrity": "sha512-+f7Vkd3vt2DYOxRnS8dStvYu3DY638N/AuLuIjxZp1F9GgwCUZK69wspqIxg2L59PmRRQcH4AGTrRDR60ENIZA==", "cpu": [ "arm64" ], @@ -562,9 +562,9 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.55-5", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.55-5.tgz", - "integrity": "sha512-EuQBgqSnRFjavgeFifbnSYUJ4elTQBLC/kf+WHolrHR2oUGyiqCQZz/cV2DYVSLP1TGxDKAV4AQCM1AdUT1xEA==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.80.tgz", + "integrity": "sha512-PO0kPqhRTWQfsqGaj4UN3cj8ttkcJYy4wmXiArtFm+03AIFu8xTvuhQDPn2xEOsUome7m7t2XomKoavcrCcRsw==", "cpu": [ "x64" ], @@ -587,9 +587,9 @@ } }, "node_modules/esbuild": { - "version": "0.27.7", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.7.tgz", - "integrity": "sha512-IxpibTjyVnmrIQo5aqNpCgoACA/dTKLTlhMHihVHhdkxKyPO1uBBthumT0rdHmcsk9uMonIWS0m4FljWzILh3w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "hasInstallScript": true, "license": "MIT", "bin": { @@ -599,32 +599,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.7", - "@esbuild/android-arm": "0.27.7", - "@esbuild/android-arm64": "0.27.7", - "@esbuild/android-x64": "0.27.7", - "@esbuild/darwin-arm64": "0.27.7", - "@esbuild/darwin-x64": "0.27.7", - "@esbuild/freebsd-arm64": "0.27.7", - "@esbuild/freebsd-x64": "0.27.7", - "@esbuild/linux-arm": "0.27.7", - "@esbuild/linux-arm64": "0.27.7", - "@esbuild/linux-ia32": "0.27.7", - "@esbuild/linux-loong64": "0.27.7", - "@esbuild/linux-mips64el": "0.27.7", - "@esbuild/linux-ppc64": "0.27.7", - "@esbuild/linux-riscv64": "0.27.7", - "@esbuild/linux-s390x": "0.27.7", - "@esbuild/linux-x64": "0.27.7", - "@esbuild/netbsd-arm64": "0.27.7", - "@esbuild/netbsd-x64": "0.27.7", - "@esbuild/openbsd-arm64": "0.27.7", - "@esbuild/openbsd-x64": "0.27.7", - "@esbuild/openharmony-arm64": "0.27.7", - "@esbuild/sunos-x64": "0.27.7", - "@esbuild/win32-arm64": "0.27.7", - "@esbuild/win32-ia32": "0.27.7", - "@esbuild/win32-x64": "0.27.7" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/fsevents": { @@ -641,41 +641,19 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-tsconfig": { - "version": "4.13.7", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.7.tgz", - "integrity": "sha512-7tN6rFgBlMgpBML5j8typ92BKFi2sFQvIdpAqLA2beia5avZDrMs0FLZiM5etShWq5irVyGcGMEA1jcDaK7A/Q==", - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, "node_modules/json-schema": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==", "license": "(AFL-2.1 OR BSD-3-Clause)" }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.23.1", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.23.1.tgz", + "integrity": "sha512-GQHnkIfxyx1wYCOS/wonik5MVRZU9hi1TEZmzGZSCJB1y9YgoZ8H6itNE/u4suE+yLmOzuE4E5S4TZ/ZX2wcWQ==", "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" diff --git a/java/scripts/codegen/package.json b/java/scripts/codegen/package.json index 6664dd8f2..af331f03a 100644 --- a/java/scripts/codegen/package.json +++ b/java/scripts/codegen/package.json @@ -7,8 +7,8 @@ "generate:java": "tsx java.ts" }, "dependencies": { - "@github/copilot": "^1.0.55-5", + "@github/copilot": "^1.0.80", "json-schema": "^0.4.0", - "tsx": "^4.20.6" + "tsx": "^4.23.1" } } diff --git a/java/scripts/test-update-documentation-versions.sh b/java/scripts/test-update-documentation-versions.sh new file mode 100755 index 000000000..606e2f7f8 --- /dev/null +++ b/java/scripts/test-update-documentation-versions.sh @@ -0,0 +1,58 @@ +#!/usr/bin/env bash + +set -euo pipefail + +SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) +UPDATER="${SCRIPT_DIR}/update-documentation-versions.sh" +TEMP_DIR=$(mktemp -d) +trap 'rm -rf "$TEMP_DIR"' EXIT + +run_case() { + local name=$1 + local old_version=$2 + local old_dev_version=$3 + local version=$4 + local dev_version=$5 + local old_jbang_version=$6 + local case_dir="${TEMP_DIR}/${name}" + + mkdir "$case_dir" + printf '%s\n' \ + '' \ + ' copilot-sdk-java' \ + " ${old_version}" \ + '' \ + "implementation 'com.github:copilot-sdk-java:${old_version}'" \ + '' \ + ' copilot-sdk-java' \ + " ${old_dev_version}" \ + '' \ + "implementation 'com.github:copilot-sdk-java:${old_dev_version}'" \ + '' \ + ' jna' \ + ' 5.19.1' \ + '' \ + > "${case_dir}/README.md" + printf '%s\n' \ + "///usr/bin/env jbang \"\$0\" \"\$@\" ; exit \$?" \ + "//DEPS com.github:copilot-sdk-java:${old_jbang_version}" \ + > "${case_dir}/jbang-example.java" + + "$UPDATER" "$version" "$dev_version" "${case_dir}/README.md" "${case_dir}/jbang-example.java" + + grep -Fqx " ${version}" "${case_dir}/README.md" + grep -Fqx "implementation 'com.github:copilot-sdk-java:${version}'" "${case_dir}/README.md" + grep -Fqx " ${dev_version}" "${case_dir}/README.md" + grep -Fqx "implementation 'com.github:copilot-sdk-java:${dev_version}'" "${case_dir}/README.md" + grep -Fqx ' 5.19.1' "${case_dir}/README.md" + grep -Fqx "//DEPS com.github:copilot-sdk-java:${version}" "${case_dir}/jbang-example.java" + + if grep -Fq "$old_version" "${case_dir}/README.md" "${case_dir}/jbang-example.java" || + grep -Fq "$old_dev_version" "${case_dir}/README.md"; then + echo "Stale version remained in ${name} test output" >&2 + exit 1 + fi +} + +run_case stable 1.0.8 1.0.9-SNAPSHOT 1.0.9 1.0.10-SNAPSHOT "\${project.version}" +run_case preview 1.0.9-preview.2-01 1.0.10-preview.2-SNAPSHOT 1.0.10-preview.2 1.0.11-preview.2-SNAPSHOT 1.0.9-preview.2-01 diff --git a/java/scripts/update-documentation-versions.sh b/java/scripts/update-documentation-versions.sh new file mode 100755 index 000000000..5280f55d5 --- /dev/null +++ b/java/scripts/update-documentation-versions.sh @@ -0,0 +1,81 @@ +#!/usr/bin/env bash + +set -euo pipefail + +if [[ $# -ne 4 ]]; then + echo "Usage: $0 " >&2 + exit 2 +fi + +VERSION=$1 +DEV_VERSION=$2 +README=$3 +JBANG_EXAMPLE=$4 +VERSION_FORMAT='[0-9]+\.[0-9]+\.[0-9]+(-(preview|(beta-)?java(-preview)?)\.[0-9]+)?' + +if [[ ! "$VERSION" =~ ^${VERSION_FORMAT}$ ]]; then + echo "Invalid release version: $VERSION" >&2 + exit 2 +fi +if [[ ! "$DEV_VERSION" =~ ^${VERSION_FORMAT}-SNAPSHOT$ ]]; then + echo "Invalid development version: $DEV_VERSION" >&2 + exit 2 +fi +if [[ ! -f "$README" || ! -f "$JBANG_EXAMPLE" ]]; then + echo "README and JBang example files must exist" >&2 + exit 2 +fi + +export VERSION DEV_VERSION + +perl -0 - "$README" <<'PERL' +use strict; +use warnings; + +my ($path) = @ARGV; +open my $input, '<', $path or die "Cannot read $path: $!\n"; +my $content = do { local $/; <$input> }; +close $input or die "Cannot close $path: $!\n"; + +# Match accepted release versions plus numeric suffixes left by the former broken updater. +my $version = qr/[0-9]+\.[0-9]+\.[0-9]+(?:-(?:preview|(?:beta-)?java(?:-preview)?)\.[0-9]+)?(?:-[0-9]+)*/; +my $sdk_dependency_version = qr{(copilot-sdk-java(?:(?!).)*?)}s; +my $snapshot_xml = ($content =~ s{$sdk_dependency_version$version-SNAPSHOT}{$1$ENV{DEV_VERSION}}g); +my $snapshot_gradle = ($content =~ s{(copilot-sdk-java:)$version-SNAPSHOT(?![-A-Za-z0-9.])}{$1 . $ENV{DEV_VERSION}}ge); +my $release_xml = ($content =~ s{$sdk_dependency_version$version}{$1$ENV{VERSION}}g); +my $release_gradle = ($content =~ s{(copilot-sdk-java:)$version(?![-A-Za-z0-9.])}{$1 . $ENV{VERSION}}ge); + +die "Expected one release and one snapshot example for both Maven and Gradle in $path\n" + unless $snapshot_xml == 1 && $snapshot_gradle == 1 && $release_xml == 1 && $release_gradle == 1; + +open my $output, '>', $path or die "Cannot write $path: $!\n"; +print {$output} $content; +close $output or die "Cannot close $path: $!\n"; +PERL + +perl -0 - "$JBANG_EXAMPLE" <<'PERL' +use strict; +use warnings; + +my ($path) = @ARGV; +open my $input, '<', $path or die "Cannot read $path: $!\n"; +my $content = do { local $/; <$input> }; +close $input or die "Cannot close $path: $!\n"; + +my $version = qr/[0-9]+\.[0-9]+\.[0-9]+(?:-(?:preview|(?:beta-)?java(?:-preview)?)\.[0-9]+)?(?:-[0-9]+)*/; +my $version_count = ($content =~ s{(copilot-sdk-java:)$version(?![-A-Za-z0-9.])}{$1 . $ENV{VERSION}}ge); +my $placeholder_count = ($content =~ s{copilot-sdk-java:\$\{project\.version\}}{copilot-sdk-java:$ENV{VERSION}}g); + +die "Expected exactly one Copilot SDK dependency in $path\n" + unless $version_count + $placeholder_count == 1; + +open my $output, '>', $path or die "Cannot write $path: $!\n"; +print {$output} $content; +close $output or die "Cannot close $path: $!\n"; +PERL + +grep -Fqx " ${VERSION}" "$README" +grep -Fqx "implementation 'com.github:copilot-sdk-java:${VERSION}'" "$README" +grep -Fqx " ${DEV_VERSION}" "$README" +grep -Fqx "implementation 'com.github:copilot-sdk-java:${DEV_VERSION}'" "$README" +grep -Fqx "//DEPS com.github:copilot-sdk-java:${VERSION}" "$JBANG_EXAMPLE" diff --git a/java/config/checkstyle/checkstyle.xml b/java/sdk/config/checkstyle/checkstyle.xml similarity index 100% rename from java/config/checkstyle/checkstyle.xml rename to java/sdk/config/checkstyle/checkstyle.xml diff --git a/java/config/spotbugs/spotbugs-exclude.xml b/java/sdk/config/spotbugs/spotbugs-exclude.xml similarity index 100% rename from java/config/spotbugs/spotbugs-exclude.xml rename to java/sdk/config/spotbugs/spotbugs-exclude.xml diff --git a/java/jbang-example.java b/java/sdk/jbang-example.java similarity index 96% rename from java/jbang-example.java rename to java/sdk/jbang-example.java index f4675dff7..79225cfe7 100644 --- a/java/jbang-example.java +++ b/java/sdk/jbang-example.java @@ -1,5 +1,5 @@ ///usr/bin/env jbang "$0" "$@" ; exit $? -//DEPS com.github:copilot-sdk-java:1.0.0-beta-10-java.5 +//DEPS com.github:copilot-sdk-java:1.0.11 import com.github.copilot.CopilotClient; import com.github.copilot.generated.AssistantMessageEvent; import com.github.copilot.generated.SessionUsageInfoEvent; diff --git a/java/sdk/pom.xml b/java/sdk/pom.xml new file mode 100644 index 000000000..27478a978 --- /dev/null +++ b/java/sdk/pom.xml @@ -0,0 +1,800 @@ + + + + 4.0.0 + + + com.github + copilot-sdk-java-parent + 1.0.12-SNAPSHOT + ../pom.xml + + + com.github + copilot-sdk-java + jar + + GitHub Copilot SDK :: Java + Official SDK for programmatic control of GitHub Copilot CLI + https://github.com/github/copilot-sdk + + + scm:git:https://github.com/github/copilot-sdk.git + scm:git:https://github.com/github/copilot-sdk.git + https://github.com/github/copilot-sdk + HEAD + + + + + central + https://central.sonatype.com/repository/maven-snapshots/ + + + + + + ${project.basedir}/../.. + ${copilot.sdk.root}/test + + ${copilot.sdk.root}/nodejs/node_modules/@github/copilot/npm-loader.js + + ${copilot.sdk.root}/nodejs/node_modules/@github/copilot-linux-x64/copilot + + false + + ${skip.test.harness} + + notice + + + + false + + 5.19.1 + + + + + + com.fasterxml.jackson.core + jackson-databind + 2.22.1 + + + com.fasterxml.jackson.core + jackson-annotations + 2.22 + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + 2.22.1 + + + + + com.github.spotbugs + spotbugs-annotations + 4.10.3 + provided + + + + + net.java.dev.jna + jna + ${jna.version} + true + + + + + org.junit.jupiter + junit-jupiter + 5.14.4 + test + + + org.mockito + mockito-core + 5.23.0 + test + + + + + + + src/main/resources + true + + + + + + com.github.spotbugs + spotbugs-maven-plugin + + config/spotbugs/spotbugs-exclude.xml + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + -Acopilot.experimental.allowed=true + + none + + + + org.apache.maven.plugins + maven-antrun-plugin + + + print-test-jdk-banner + process-test-classes + + run + + + + + + + + + + + + org.codehaus.mojo + exec-maven-plugin + + + install-harness-dependencies + generate-test-resources + + exec + + + ${skip.test.harness} + npm + ${copilot.sdk.root}/test/harness + + ci + --omit-lockfile-registry-resolved=true + --loglevel + ${npm.loglevel} + + + + + + install-nodejs-cli-dependencies + generate-test-resources + + exec + + + ${skip.cli.install} + npm + ${copilot.sdk.root}/nodejs + + ci + --ignore-scripts + --omit-lockfile-registry-resolved=true + --loglevel + ${npm.loglevel} + + + + + + + + org.apache.maven.plugins + maven-failsafe-plugin + + + + integration-test + verify + + + + + + + ${project.build.directory} + ${project.build.finalName} + ${project.build.testOutputDirectory} + + + + ${copilot.cli.path} + + + + + org.apache.maven.plugins + maven-surefire-plugin + + alphabetical + + + ${testExecutionAgentArgs} ${surefire.jvm.args} --add-opens com.github.copilot.java/com.github.copilot.e2e=ALL-UNNAMED + + 2 + + ${copilot.tests.dir} + ${copilot.sdk.root} + + + + ${copilot.cli.path} + + + + + + isolated-resume-tests + test + + test + + + isolated-resume + + ${project.build.directory}/surefire-reports-isolated + + + + + default-test + + isolated-resume + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + add-generated-source + generate-sources + + add-source + + + + ${project.basedir}/src/generated/java + + + + + + + com.diffplug.spotless + spotless-maven-plugin + + + + src/generated/java/**/*.java + + + 4.33 + + + + + + true + 4 + + + + + + + org.jacoco + jacoco-maven-plugin + + + + wire-up-coverage-instrumentation + + prepare-agent + + + + ${project.build.directory}/jacoco-test-results/sdk-tests.exec + + testExecutionAgentArgs + + + com/github/copilot/** + + + com/github/copilot/E2ETestContext* + com/github/copilot/CapiProxy* + + + + + + build-coverage-report-from-tests + + report + + verify + + ${project.build.directory}/jacoco-test-results/sdk-tests.exec + ${project.reporting.outputDirectory}/jacoco-coverage + + + META-INF/versions/**/*.class + + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + config/checkstyle/checkstyle.xml + true + true + false + + + + validate + validate + + check + + + + + + com.puppycrawl.tools + checkstyle + 10.26.1 + + + + + + org.sonatype.central + central-publishing-maven-plugin + true + + central + true + + + + org.apache.maven.plugins + maven-enforcer-plugin + + + enforce-jdk25 + + enforce + + + + + [25,) + JDK 25+ is required to build the Multi-Release JAR with the virtual-thread overlay. + + + + + + verify-multi-release-overlay + verify + + enforce + + + + + + ${project.build.outputDirectory}/META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class + + Multi-Release JAR overlay missing: META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class was not compiled. Ensure the build runs on JDK 25+. + + + + + + + + + + + + + jdk21+ + + [21,) + + + -XX:+EnableDynamicAgentLoading + + + + java25-multi-release + + [25,) + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + compile-java25 + compile + + compile + + + 25 + false + + ${project.basedir}/src/main/java25 + + true + + + + + + org.apache.maven.plugins + maven-jar-plugin + + + + true + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + verify-java25-overlay + package + + run + + + + + + + + + +JDK 25 multi-release overlay class is missing from the packaged JAR. +Expected entry: META-INF/versions/25/com/github/copilot/InternalExecutorProvider.class +JAR: ${project.build.directory}/${project.build.finalName}.jar + +This usually means the 'java25-multi-release' Maven profile did not activate +(e.g. the build is running on a JDK older than 25) or maven-compiler-plugin +did not produce the multi-release output. Re-build on JDK 25+ and verify the +'compile-java25' execution ran during the 'compile' phase. + + + + + + + + + + + + skip-test-harness + + true + + + + + inprocess + + inprocess + + + + + com.github + copilot-sdk-java-runtime + ${project.version} + linux-x64 + test + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + false + 1 + none + + inprocess + + + + + org.apache.maven.plugins + maven-failsafe-plugin + + 1 + none + + ${copilot.inprocess.cli.path} + inprocess + + + + + + + + + skip-cli-install-when-tests-skipped + + + skipTests + true + + + + true + + + + + skip-cli-install-when-maven-test-skip + + + maven.test.skip + true + + + + true + + + + + debug + + + + org.apache.maven.plugins + maven-surefire-plugin + + + ${project.basedir}/src/test/resources/logging-debug.properties + + + + + + + + + update-schemas-from-npm-artifact + + + + org.codehaus.mojo + exec-maven-plugin + + + update-copilot-schema-version + generate-sources + + exec + + + npm + ${project.parent.basedir}/scripts/codegen + + install + @github/copilot@${copilot.schema.version} + + + + + + + org.apache.maven.plugins + maven-enforcer-plugin + + + require-schema-version + validate + + enforce + + + + + copilot.schema.version + You must specify -Dcopilot.schema.version=VERSION (e.g. 1.0.25) + + + + + + + + + + + + codegen + + + + org.codehaus.mojo + exec-maven-plugin + + + codegen-npm-install + generate-sources + + exec + + + npm + ${project.parent.basedir}/scripts/codegen + + ci + + + + + codegen-generate + generate-sources + + exec + + + npm + ${project.parent.basedir}/scripts/codegen + + run + generate + + + + + + + + + + diff --git a/java/src/generated/java/com/github/copilot/generated/AbortEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AbortEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AbortEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AbortEvent.java index e58922aa0..459bdfe04 100644 --- a/java/src/generated/java/com/github/copilot/generated/AbortEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AbortEvent.java @@ -14,7 +14,6 @@ /** * Session event "abort". Turn abort information including the reason for termination - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java new file mode 100644 index 000000000..c1ba2119a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AbortReason.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Finite reason code describing why the current turn was aborted + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AbortReason { + /** The {@code user_initiated} variant. */ + USER_INITIATED("user_initiated"), + /** The {@code remote_command} variant. */ + REMOTE_COMMAND("remote_command"), + /** The {@code user_abort} variant. */ + USER_ABORT("user_abort"), + /** The {@code autopilot_credit_limit} variant. */ + AUTOPILOT_CREDIT_LIMIT("autopilot_credit_limit"); + + private final String value; + AbortReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AbortReason fromValue(String value) { + for (AbortReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AbortReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java new file mode 100644 index 000000000..3b79b8d50 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIdleEvent.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.idle". Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantIdleEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.idle"; } + + @JsonProperty("data") + private AssistantIdleEventData data; + + public AssistantIdleEventData getData() { return data; } + public void setData(AssistantIdleEventData data) { this.data = data; } + + /** Data payload for {@link AssistantIdleEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantIdleEventData( + /** True when the preceding agentic loop was cancelled via abort signal */ + @JsonProperty("aborted") Boolean aborted + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java index 49de4cda2..b722775a8 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantIntentEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.intent". Agent intent description for current activity or plan - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java index cdc0e3e26..2d5458d46 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageDeltaEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.message_delta". Streaming assistant message delta for incremental response updates - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java new file mode 100644 index 000000000..fee236ed2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java @@ -0,0 +1,83 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.message". Assistant response containing text content, optional tool requests, and interaction metadata + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantMessageEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.message"; } + + @JsonProperty("data") + private AssistantMessageEventData data; + + public AssistantMessageEventData getData() { return data; } + public void setData(AssistantMessageEventData data) { this.data = data; } + + /** Data payload for {@link AssistantMessageEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantMessageEventData( + /** Unique identifier for this assistant message */ + @JsonProperty("messageId") String messageId, + /** Model that produced this assistant message, if known */ + @JsonProperty("model") String model, + /** The assistant's text response content */ + @JsonProperty("content") String content, + /** Tool invocations requested by the assistant in this message */ + @JsonProperty("toolRequests") List toolRequests, + /** Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. */ + @JsonProperty("reasoningOpaque") String reasoningOpaque, + /** Readable reasoning text from the model's extended thinking */ + @JsonProperty("reasoningText") String reasoningText, + /** OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns. */ + @JsonProperty("reasoningWireField") String reasoningWireField, + /** Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. */ + @JsonProperty("encryptedContent") String encryptedContent, + /** Generation phase for phased-output models (e.g., thinking vs. response phases) */ + @JsonProperty("phase") String phase, + /** Zero-based position of this message within its model call's response. Absent when the response was not split into chunks. */ + @JsonProperty("chunkIndex") Long chunkIndex, + /** Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1. */ + @JsonProperty("chunkCount") Long chunkCount, + /** Actual output token count from the API response (completion_tokens), used for accurate token accounting */ + @JsonProperty("outputTokens") Long outputTokens, + /** CAPI interaction ID for correlating this message with upstream telemetry */ + @JsonProperty("interactionId") String interactionId, + /** GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs */ + @JsonProperty("requestId") String requestId, + /** Client-minted request id (x-request-id header) echoed by the server. Distinct from requestId (x-github-request-id) and serviceRequestId (x-copilot-service-request-id). */ + @JsonProperty("clientRequestId") String clientRequestId, + /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ + @JsonProperty("serviceRequestId") String serviceRequestId, + @JsonProperty("rte") Boolean rte, + /** Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. */ + @JsonProperty("apiCallId") String apiCallId, + /** Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping */ + @JsonProperty("serverTools") AssistantMessageServerTools serverTools, + /** Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event */ + @JsonProperty("turnId") String turnId, + /** Tool call ID of the parent tool invocation when this event originates from a sub-agent */ + @JsonProperty("parentToolCallId") String parentToolCallId, + /** Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. */ + @JsonProperty("citations") Citations citations + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java new file mode 100644 index 000000000..72d685037 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageServerTools.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AssistantMessageServerTools( + @JsonProperty("provider") String provider, + @JsonProperty("items") List items, + @JsonProperty("functionCallNamespaces") Map functionCallNamespaces, + @JsonProperty("rawContentBlocks") List rawContentBlocks, + @JsonProperty("advisorModel") String advisorModel +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java index f85e33b88..dd5b6a749 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageStartEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.message_start". Streaming assistant message start metadata - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequest.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequest.java diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequestType.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequestType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequestType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantMessageToolRequestType.java diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java index f9d8b25b4..77687ed41 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningDeltaEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java index d84b40058..52996aeee 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantReasoningEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.reasoning". Assistant reasoning content for timeline display with complete thinking text - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -38,7 +37,8 @@ public record AssistantReasoningEventData( /** Unique identifier for this reasoning block */ @JsonProperty("reasoningId") String reasoningId, /** The complete extended thinking text from the model */ - @JsonProperty("content") String content + @JsonProperty("content") String content, + @JsonProperty("rte") Boolean rte ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java new file mode 100644 index 000000000..462a573b3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantServerToolProgressEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.server_tool_progress". Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantServerToolProgressEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.server_tool_progress"; } + + @JsonProperty("data") + private AssistantServerToolProgressEventData data; + + public AssistantServerToolProgressEventData getData() { return data; } + public void setData(AssistantServerToolProgressEventData data) { this.data = data; } + + /** Data payload for {@link AssistantServerToolProgressEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantServerToolProgressEventData( + /** Position of the hosted tool call in the response output. Stable across the call's lifecycle events (unlike the provider's per-event item id, which CAPI rotates), so the host keys the live in-progress row on it. */ + @JsonProperty("outputIndex") Long outputIndex, + /** Kind of hosted server tool that is running. Only `web_search` is emitted today. */ + @JsonProperty("kind") String kind, + /** Lifecycle status of the hosted call: `in_progress`, `searching`, or `completed`. */ + @JsonProperty("status") String status + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java index e5eae1897..21d9f22b9 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantStreamingDeltaEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.streaming_delta". Streaming response progress with cumulative byte count - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java new file mode 100644 index 000000000..72b629c0c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantToolCallDeltaEvent.java @@ -0,0 +1,47 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.tool_call_delta". Streaming tool-call input delta for incremental tool-call updates + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantToolCallDeltaEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.tool_call_delta"; } + + @JsonProperty("data") + private AssistantToolCallDeltaEventData data; + + public AssistantToolCallDeltaEventData getData() { return data; } + public void setData(AssistantToolCallDeltaEventData data) { this.data = data; } + + /** Data payload for {@link AssistantToolCallDeltaEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantToolCallDeltaEventData( + /** Tool call ID this delta belongs to, matching the corresponding assistant.message tool request */ + @JsonProperty("toolCallId") String toolCallId, + /** Name of the tool being invoked, when known from the stream */ + @JsonProperty("toolName") String toolName, + /** Tool call type, when known from the stream */ + @JsonProperty("toolType") AssistantMessageToolRequestType toolType, + /** Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input. */ + @JsonProperty("inputDelta") String inputDelta + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java index fa245915b..082f62b47 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnEndEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.turn_end". Turn completion metadata including the turn identifier - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -36,7 +35,9 @@ public final class AssistantTurnEndEvent extends SessionEvent { @JsonInclude(JsonInclude.Include.NON_NULL) public record AssistantTurnEndEventData( /** Identifier of the turn that has ended, matching the corresponding assistant.turn_start event */ - @JsonProperty("turnId") String turnId + @JsonProperty("turnId") String turnId, + /** Model identifier used for this turn, when known */ + @JsonProperty("model") String model ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java new file mode 100644 index 000000000..e4c127d42 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnRetryEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.turn_retry". Metadata for an additional model inference attempt within an existing assistant turn + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantTurnRetryEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.turn_retry"; } + + @JsonProperty("data") + private AssistantTurnRetryEventData data; + + public AssistantTurnRetryEventData getData() { return data; } + public void setData(AssistantTurnRetryEventData data) { this.data = data; } + + /** Data payload for {@link AssistantTurnRetryEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantTurnRetryEventData( + /** Identifier of the turn whose model inference is being retried */ + @JsonProperty("turnId") String turnId, + /** Model identifier used for this retry, when known */ + @JsonProperty("model") String model, + /** Provider or runtime classification that caused the retry, when known */ + @JsonProperty("reason") String reason + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java index f090117bf..a9c6b2932 100644 --- a/java/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantTurnStartEvent.java @@ -14,7 +14,6 @@ /** * Session event "assistant.turn_start". Turn initialization metadata including identifier and interaction tracking - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -37,6 +36,8 @@ public final class AssistantTurnStartEvent extends SessionEvent { public record AssistantTurnStartEventData( /** Identifier for this turn within the agentic loop, typically a stringified turn number */ @JsonProperty("turnId") String turnId, + /** Model identifier used for this turn, when known */ + @JsonProperty("model") String model, /** CAPI interaction ID for correlating this turn with upstream telemetry */ @JsonProperty("interactionId") String interactionId ) { diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageApiEndpoint.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageApiEndpoint.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantUsageApiEndpoint.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageApiEndpoint.java diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsage.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsage.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsage.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsage.java diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsageTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsageTokenDetail.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsageTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageCopilotUsageTokenDetail.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java new file mode 100644 index 000000000..85bd81d3c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java @@ -0,0 +1,96 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Session event "assistant.usage". LLM API call usage metrics including tokens, costs, quotas, and billing information + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AssistantUsageEvent extends SessionEvent { + + @Override + public String getType() { return "assistant.usage"; } + + @JsonProperty("data") + private AssistantUsageEventData data; + + public AssistantUsageEventData getData() { return data; } + public void setData(AssistantUsageEventData data) { this.data = data; } + + /** Data payload for {@link AssistantUsageEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record AssistantUsageEventData( + /** Model identifier used for this API call */ + @JsonProperty("model") String model, + /** Number of input tokens consumed */ + @JsonProperty("inputTokens") Long inputTokens, + /** Number of output tokens produced */ + @JsonProperty("outputTokens") Long outputTokens, + /** Number of tokens read from prompt cache */ + @JsonProperty("cacheReadTokens") Long cacheReadTokens, + /** Number of tokens written to prompt cache */ + @JsonProperty("cacheWriteTokens") Long cacheWriteTokens, + /** Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. */ + @JsonProperty("cacheExpiresAt") OffsetDateTime cacheExpiresAt, + /** Number of output tokens used for reasoning (e.g., chain-of-thought) */ + @JsonProperty("reasoningTokens") Long reasoningTokens, + /** Model multiplier cost for billing purposes */ + @JsonProperty("cost") Double cost, + /** Duration of the API call in milliseconds */ + @JsonProperty("duration") Long duration, + /** Time to first token in milliseconds. Only available for streaming requests */ + @JsonProperty("timeToFirstTokenMs") Double timeToFirstTokenMs, + /** Average inter-token latency in milliseconds. Only available for streaming requests */ + @JsonProperty("interTokenLatencyMs") Double interTokenLatencyMs, + /** What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ + @JsonProperty("initiator") String initiator, + /** Coarse classification of the interaction that produced this call, mirroring the session's per-request agent context (e.g. `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, `conversation-user`). Non-billing; lets consumers attribute a model call to a call class (e.g. sub-agent/sidekick) independently of the billing initiator. Absent when the runtime did not classify the request. */ + @JsonProperty("interactionType") String interactionType, + /** Completion ID from the model provider (e.g., chatcmpl-abc123) */ + @JsonProperty("apiCallId") String apiCallId, + /** GitHub request tracing ID (x-github-request-id header) for server-side log correlation */ + @JsonProperty("providerCallId") String providerCallId, + /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ + @JsonProperty("serviceRequestId") String serviceRequestId, + @JsonProperty("rte") Boolean rte, + /** API endpoint used for this model call, matching CAPI supported_endpoints vocabulary */ + @JsonProperty("apiEndpoint") AssistantUsageApiEndpoint apiEndpoint, + /** Parent tool call ID when this usage originates from a sub-agent */ + @JsonProperty("parentToolCallId") String parentToolCallId, + /** Per-quota resource usage snapshots, keyed by quota identifier */ + @JsonProperty("quotaSnapshots") Map quotaSnapshots, + /** Per-request cost and usage data from the CAPI copilot_usage response field */ + @JsonProperty("copilotUsage") AssistantUsageCopilotUsage copilotUsage, + /** Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Number of tools available to the model for this call */ + @JsonProperty("availableToolCount") Long availableToolCount, + /** Number of tokens used by tool definitions for this call */ + @JsonProperty("toolTokenCount") Long toolTokenCount, + /** Number of tool calls returned by the model */ + @JsonProperty("numToolCalls") Long numToolCalls, + /** Tool-call counts keyed by tool name */ + @JsonProperty("toolCounts") Map toolCounts, + /** Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter". */ + @JsonProperty("finishReason") String finishReason, + /** Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason. */ + @JsonProperty("contentFilterTriggered") Boolean contentFilterTriggered + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java new file mode 100644 index 000000000..f32dacdee --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java @@ -0,0 +1,48 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AssistantUsageQuotaSnapshot( + /** Whether the user has an unlimited usage entitlement */ + @JsonProperty("isUnlimitedEntitlement") Boolean isUnlimitedEntitlement, + /** Total requests allowed by the entitlement */ + @JsonProperty("entitlementRequests") Long entitlementRequests, + /** Number of requests already consumed */ + @JsonProperty("usedRequests") Long usedRequests, + /** Whether usage is still permitted after quota exhaustion */ + @JsonProperty("usageAllowedWithExhaustedQuota") Boolean usageAllowedWithExhaustedQuota, + /** Number of additional usage requests made this period */ + @JsonProperty("overage") Double overage, + /** Whether additional usage is allowed when quota is exhausted */ + @JsonProperty("overageAllowedWithExhaustedQuota") Boolean overageAllowedWithExhaustedQuota, + /** Percentage of quota remaining (0 to 100) */ + @JsonProperty("remainingPercentage") Double remainingPercentage, + /** Date when the quota resets */ + @JsonProperty("resetDate") OffsetDateTime resetDate, + /** Whether the user currently has quota available for use */ + @JsonProperty("hasQuota") Boolean hasQuota, + /** Whether this snapshot uses token-based billing (AI-credits allocation) */ + @JsonProperty("tokenBasedBilling") Boolean tokenBasedBilling, + /** Pay-as-you-go additional-usage budget cap in AI credits (1 credit = $0.01); present only when CAPI emits a finite value */ + @JsonProperty("overageEntitlement") Double overageEntitlement +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java new file mode 100644 index 000000000..3034b0bf1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeResolvedReasoningBucket.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Coarse request-difficulty bucket for UX explainability + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AutoModeResolvedReasoningBucket { + /** The {@code low} variant. */ + LOW("low"), + /** The {@code medium} variant. */ + MEDIUM("medium"), + /** The {@code high} variant. */ + HIGH("high"); + + private final String value; + AutoModeResolvedReasoningBucket(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AutoModeResolvedReasoningBucket fromValue(String value) { + for (AutoModeResolvedReasoningBucket v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AutoModeResolvedReasoningBucket value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java index 76a35dbb7..8a408d411 100644 --- a/java/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "auto_mode_switch.completed". Auto mode switch completion notification - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java index 79fc5c316..d182b5493 100644 --- a/java/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "auto_mode_switch.requested". Auto mode switch request notification requiring user approval - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/AutoModeSwitchResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AutoModeSwitchResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutoModeSwitchResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedOperation.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedOperation.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedOperation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedOperation.java diff --git a/java/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/AutopilotObjectiveChangedStatus.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/BinaryAssetType.java b/java/sdk/src/generated/java/com/github/copilot/generated/BinaryAssetType.java new file mode 100644 index 000000000..e707bcddf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/BinaryAssetType.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Binary asset type discriminator. Use "image" for images and "resource" otherwise. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum BinaryAssetType { + /** The {@code image} variant. */ + IMAGE("image"), + /** The {@code resource} variant. */ + RESOURCE("resource"); + + private final String value; + BinaryAssetType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static BinaryAssetType fromValue(String value) { + for (BinaryAssetType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown BinaryAssetType value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java b/java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java index 17d1477c1..12518491e 100644 --- a/java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvas.java @@ -11,11 +11,10 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; -import java.util.Map; import javax.annotation.processing.Generated; /** - * Schema for the `CanvasRegistryChangedCanvas` type. + * A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions. * * @since 1.0.0 */ @@ -33,8 +32,10 @@ public record CanvasRegistryChangedCanvas( @JsonProperty("displayName") String displayName, /** Short, single-sentence description shown to the agent in canvas catalogs. */ @JsonProperty("description") String description, + /** Host-local PNG path for the canvas icon, when supplied */ + @JsonProperty("icon") String icon, /** JSON Schema for canvas open input */ - @JsonProperty("inputSchema") Map inputSchema, + @JsonProperty("inputSchema") Object inputSchema, /** Actions the agent or host may invoke */ @JsonProperty("actions") List actions ) { diff --git a/java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java index 34e30d3f2..99c390efb 100644 --- a/java/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CanvasRegistryChangedCanvasAction.java @@ -10,11 +10,10 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.Map; import javax.annotation.processing.Generated; /** - * Schema for the `CanvasRegistryChangedCanvasAction` type. + * A single action within a canvas declaration, with its name, optional description, and optional input schema. * * @since 1.0.0 */ @@ -27,6 +26,6 @@ public record CanvasRegistryChangedCanvasAction( /** Action description */ @JsonProperty("description") String description, /** JSON Schema for action input */ - @JsonProperty("inputSchema") Map inputSchema + @JsonProperty("inputSchema") Object inputSchema ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java index 8f0d0809f..ddea208c5 100644 --- a/java/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CapabilitiesChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "capabilities.changed". Session capability change notification - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/CapabilitiesChangedUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/CapabilitiesChangedUI.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CapabilitiesChangedUI.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CapabilitiesChangedUI.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CitableSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitableSource.java new file mode 100644 index 000000000..c66809fc1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CitableSource.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A source supplied by a tool that should be made available to the model as citable content. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CitableSource( + /** Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source. */ + @JsonProperty("id") String id, + /** Human-readable title of the source. */ + @JsonProperty("title") String title, + /** The source text made available to the model as citable content. */ + @JsonProperty("content") String content, + /** URL of the source, when it is a web resource. */ + @JsonProperty("url") String url, + /** File path relative to the agent's workspace root, when the source is a file. */ + @JsonProperty("path") String path +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CitationProvider.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationProvider.java new file mode 100644 index 000000000..46a02b256 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CitationProvider.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * The system that produced a citation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CitationProvider { + /** The {@code anthropic} variant. */ + ANTHROPIC("anthropic"), + /** The {@code openai} variant. */ + OPENAI("openai"), + /** The {@code client} variant. */ + CLIENT("client"); + + private final String value; + CitationProvider(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CitationProvider fromValue(String value) { + for (CitationProvider v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CitationProvider value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CitationReference.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationReference.java new file mode 100644 index 000000000..e9ad222c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CitationReference.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single citation occurrence linking a span of generated text to a supporting source. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CitationReference( + /** Identifier of the CitationSource this reference points to (CitationSource.id). */ + @JsonProperty("sourceId") String sourceId, + /** The exact text from the source that supports the cited span, when provided by the model. */ + @JsonProperty("citedText") String citedText, + /** Location within the source that supports the cited span, when the provider reports one. */ + @JsonProperty("location") Object location, + /** Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. */ + @JsonProperty("providerMetadata") Object providerMetadata +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CitationSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSource.java new file mode 100644 index 000000000..561c5eced --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSource.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A source that backs one or more cited spans in the assistant's response. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CitationSource( + /** Stable, turn-scoped identifier for this source, referenced by CitationReference.sourceId. */ + @JsonProperty("id") String id, + /** The system that produced this citation. */ + @JsonProperty("provider") CitationProvider provider, + /** Human-readable title of the source. */ + @JsonProperty("title") String title, + /** URL of the source, when it is a web resource. */ + @JsonProperty("url") String url, + /** File path relative to the agent's workspace root, when the source is a file. */ + @JsonProperty("path") String path +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CitationSpan.java b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSpan.java new file mode 100644 index 000000000..aaa8647a6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CitationSpan.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * A contiguous span of generated assistant text and the source references that support it. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CitationSpan( + /** Start offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, inclusive). */ + @JsonProperty("startIndex") Long startIndex, + /** End offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, exclusive). */ + @JsonProperty("endIndex") Long endIndex, + /** The sources that support this span of generated text. */ + @JsonProperty("references") List references +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/Citations.java b/java/sdk/src/generated/java/com/github/copilot/generated/Citations.java new file mode 100644 index 000000000..c153c39a7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/Citations.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Provider-agnostic citations linking spans of the assistant's response to their supporting sources. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record Citations( + /** Deduplicated set of sources referenced by the citation spans. */ + @JsonProperty("sources") List sources, + /** Spans of generated text annotated with the sources that support them. */ + @JsonProperty("spans") List spans +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java index a334edbb1..196846ed1 100644 --- a/java/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CommandCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "command.completed". Queued command completion notification signaling UI dismissal - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java index efd840bbd..15f2b93d4 100644 --- a/java/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CommandExecuteEvent.java @@ -14,7 +14,6 @@ /** * Session event "command.execute". Registered command dispatch request routed to the owning client - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java index 518248aa9..c454cfb64 100644 --- a/java/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CommandQueuedEvent.java @@ -14,7 +14,6 @@ /** * Session event "command.queued". Queued slash command dispatch request for client execution - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java b/java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java index 383f141fc..76a30b920 100644 --- a/java/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedCommand.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `CommandsChangedCommand` type. + * A single slash command available in the session, as listed by the `commands.changed` event. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java index a3f8fba19..055832818 100644 --- a/java/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CommandsChangedEvent.java @@ -15,7 +15,6 @@ /** * Session event "commands.changed". SDK command registration change notification - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsed.java b/java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsed.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsed.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsed.java diff --git a/java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsage.java b/java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsage.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsage.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsage.java diff --git a/java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/CompactionTrigger.java b/java/sdk/src/generated/java/com/github/copilot/generated/CompactionTrigger.java new file mode 100644 index 000000000..1c77861dc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CompactionTrigger.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * What initiated a conversation compaction + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum CompactionTrigger { + /** The {@code threshold} variant. */ + THRESHOLD("threshold"), + /** The {@code context_limit_retry} variant. */ + CONTEXT_LIMIT_RETRY("context_limit_retry"), + /** The {@code manual} variant. */ + MANUAL("manual"), + /** The {@code memory_pressure} variant. */ + MEMORY_PRESSURE("memory_pressure"), + /** The {@code model_switch} variant. */ + MODEL_SWITCH("model_switch"); + + private final String value; + CompactionTrigger(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static CompactionTrigger fromValue(String value) { + for (CompactionTrigger v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown CompactionTrigger value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/ContextTier.java new file mode 100644 index 000000000..0ecd7319c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ContextTier.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Allowed values for the `ContextTier` enumeration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ContextTier { + /** The {@code default} variant. */ + DEFAULT("default"), + /** The {@code long_context} variant. */ + LONG_CONTEXT("long_context"); + + private final String value; + ContextTier(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ContextTier fromValue(String value) { + for (ContextTier v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ContextTier value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java b/java/sdk/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java index 642be8694..c2f195e48 100644 --- a/java/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/CustomAgentsUpdatedAgent.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `CustomAgentsUpdatedAgent` type. + * A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ElicitationCompletedAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationCompletedAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ElicitationCompletedAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ElicitationCompletedAction.java diff --git a/java/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java index 454cc43a0..fa0e8c21b 100644 --- a/java/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationCompletedEvent.java @@ -15,7 +15,6 @@ /** * Session event "elicitation.completed". Elicitation request completion with the user's response - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java index 6c8aa2547..cf4e35b1c 100644 --- a/java/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "elicitation.requested". Elicitation request; may be form-based (structured input) or URL-based (browser redirect) - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ElicitationRequestedMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ElicitationRequestedMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/ElicitationRequestedSchema.java b/java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedSchema.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ElicitationRequestedSchema.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ElicitationRequestedSchema.java diff --git a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ExitPlanModeAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeAction.java diff --git a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java index 6056a570e..4f3ac7623 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "exit_plan_mode.completed". Plan mode exit completion with the user's approval decision and optional feedback - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java index 134e01cbb..4242b4b65 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExitPlanModeRequestedEvent.java @@ -15,7 +15,6 @@ /** * Session event "exit_plan_mode.requested". Plan approval request with plan content and available user actions - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java index b47f308c8..d8c65f455 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtension.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ExtensionsLoadedExtension` type. + * A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status. * * @since 1.0.0 */ @@ -21,7 +21,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record ExtensionsLoadedExtension( - /** Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper') */ + /** Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') */ @JsonProperty("id") String id, /** Extension name (directory name) */ @JsonProperty("name") String name, diff --git a/java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java index abf991a01..e9a36b6c4 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionSource.java @@ -19,7 +19,11 @@ public enum ExtensionsLoadedExtensionSource { /** The {@code project} variant. */ PROJECT("project"), /** The {@code user} variant. */ - USER("user"); + USER("user"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"), + /** The {@code session} variant. */ + SESSION("session"); private final String value; ExtensionsLoadedExtensionSource(String value) { this.value = value; } diff --git a/java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExtensionsLoadedExtensionStatus.java diff --git a/java/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java index cfd9828e7..fc705b7bc 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "external_tool.completed". External tool completion notification signaling UI dismissal - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java index 39eacd44f..903f01f1e 100644 --- a/java/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ExternalToolRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "external_tool.requested". External tool invocation request for client-side tool execution - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunUpdatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunUpdatedEvent.java new file mode 100644 index 000000000..e9abb1053 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/FactoryRunUpdatedEvent.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "factory.run_updated". Ephemeral invalidation signal for a changed factory run. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class FactoryRunUpdatedEvent extends SessionEvent { + + @Override + public String getType() { return "factory.run_updated"; } + + @JsonProperty("data") + private FactoryRunUpdatedEventData data; + + public FactoryRunUpdatedEventData getData() { return data; } + public void setData(FactoryRunUpdatedEventData data) { this.data = data; } + + /** Data payload for {@link FactoryRunUpdatedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record FactoryRunUpdatedEventData( + @JsonProperty("runId") String runId, + /** Monotonic revision now available for the run. */ + @JsonProperty("revision") Long revision + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/GitHubMcpToolConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/GitHubMcpToolConfig.java new file mode 100644 index 000000000..afa69b985 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/GitHubMcpToolConfig.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Per-session configuration for the built-in GitHub MCP server + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record GitHubMcpToolConfig( + /** Whether to use the read-write endpoint and request all toolsets */ + @JsonProperty("enableAllTools") Boolean enableAllTools, + /** Additional GitHub MCP toolsets requested by the session */ + @JsonProperty("additionalToolsets") List additionalToolsets, + /** Additional GitHub MCP tools requested by the session */ + @JsonProperty("additionalTools") List additionalTools, + /** Whether to request the GitHub MCP insiders build */ + @JsonProperty("enableInsidersMode") Boolean enableInsidersMode +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/HandoffRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/HandoffRepository.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/HandoffRepository.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HandoffRepository.java diff --git a/java/src/generated/java/com/github/copilot/generated/HandoffSourceType.java b/java/sdk/src/generated/java/com/github/copilot/generated/HandoffSourceType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/HandoffSourceType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HandoffSourceType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/HeaderEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/HeaderEntry.java new file mode 100644 index 000000000..14828d32e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HeaderEntry.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Single HTTP header entry as a name/value pair. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HeaderEntry( + /** HTTP response header name as observed by the runtime. */ + @JsonProperty("name") String name, + /** HTTP response header value as observed by the runtime. */ + @JsonProperty("value") String value +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/HookEndError.java b/java/sdk/src/generated/java/com/github/copilot/generated/HookEndError.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/HookEndError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HookEndError.java index 59646b3cc..f70b34b52 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookEndError.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookEndError.java @@ -24,6 +24,8 @@ public record HookEndError( /** Human-readable error message */ @JsonProperty("message") String message, /** Error stack trace, when available */ - @JsonProperty("stack") String stack + @JsonProperty("stack") String stack, + /** Source label of the hook that errored (e.g. the plugin it was loaded from), when known */ + @JsonProperty("source") String source ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/HookEndEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/HookEndEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/HookEndEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HookEndEvent.java index 1b90f5fa9..cd081dc87 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookEndEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookEndEvent.java @@ -14,7 +14,6 @@ /** * Session event "hook.end". Hook invocation completion details including output, success status, and error information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/HookProgressEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/HookProgressEvent.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/HookProgressEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HookProgressEvent.java index 4ea3bd2ea..b4d96764f 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookProgressEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookProgressEvent.java @@ -14,7 +14,6 @@ /** * Session event "hook.progress". Ephemeral progress update from a running hook process - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -36,7 +35,9 @@ public final class HookProgressEvent extends SessionEvent { @JsonInclude(JsonInclude.Include.NON_NULL) public record HookProgressEventData( /** Human-readable progress message from the hook process */ - @JsonProperty("message") String message + @JsonProperty("message") String message, + /** When true, this status message replaces the previous temporary one instead of accumulating */ + @JsonProperty("temporary") Boolean temporary ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/HookStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/HookStartEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/HookStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/HookStartEvent.java index f4605ce25..4c5de1a1d 100644 --- a/java/src/generated/java/com/github/copilot/generated/HookStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/HookStartEvent.java @@ -14,7 +14,6 @@ /** * Session event "hook.start". Hook invocation start details including type and input data - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java new file mode 100644 index 000000000..afe1c3db2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedAction.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * The category of runtime action that enterprise managed settings governed (blocked or capped) + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ManagedSettingsEnforcedAction { + /** The {@code bypass_permissions_blocked} variant. */ + BYPASS_PERMISSIONS_BLOCKED("bypass_permissions_blocked"); + + private final String value; + ManagedSettingsEnforcedAction(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ManagedSettingsEnforcedAction fromValue(String value) { + for (ManagedSettingsEnforcedAction v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ManagedSettingsEnforcedAction value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java new file mode 100644 index 000000000..cdeea72b4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsEnforcedEscalation.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ManagedSettingsEnforcedEscalation { + /** The {@code allow_all} variant. */ + ALLOW_ALL("allow_all"), + /** The {@code approve_all} variant. */ + APPROVE_ALL("approve_all"), + /** The {@code auto_approval} variant. */ + AUTO_APPROVAL("auto_approval"), + /** The {@code unrestricted_paths} variant. */ + UNRESTRICTED_PATHS("unrestricted_paths"), + /** The {@code unrestricted_urls} variant. */ + UNRESTRICTED_URLS("unrestricted_urls"); + + private final String value; + ManagedSettingsEnforcedEscalation(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ManagedSettingsEnforcedEscalation fromValue(String value) { + for (ManagedSettingsEnforcedEscalation v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ManagedSettingsEnforcedEscalation value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java new file mode 100644 index 000000000..32386f898 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ManagedSettingsResolvedSource.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ManagedSettingsResolvedSource { + /** The {@code server} variant. */ + SERVER("server"), + /** The {@code device} variant. */ + DEVICE("device"), + /** The {@code client} variant. */ + CLIENT("client"), + /** The {@code mixed} variant. */ + MIXED("mixed"), + /** The {@code none} variant. */ + NONE("none"); + + private final String value; + ManagedSettingsResolvedSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ManagedSettingsResolvedSource fromValue(String value) { + for (ManagedSettingsResolvedSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ManagedSettingsResolvedSource value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteError.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteError.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java index ea4f517c4..79b0894d0 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteEvent.java @@ -15,7 +15,6 @@ /** * Session event "mcp_app.tool_call_complete". MCP App view called a tool on a connected MCP server (SEP-1865) - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java index 33b9a3725..335f3694a 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMeta.java @@ -21,7 +21,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record McpAppToolCallCompleteToolMeta( - /** Schema for the `McpAppToolCallCompleteToolMetaUI` type. */ + /** MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. */ @JsonProperty("ui") McpAppToolCallCompleteToolMetaUI ui ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java index eb960434a..47708eaaa 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpAppToolCallCompleteToolMetaUI.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `McpAppToolCallCompleteToolMetaUI` type. + * MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java new file mode 100644 index 000000000..a3ba903ae --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedEvent.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.headers_refresh_completed". MCP headers refresh request completion notification + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpHeadersRefreshCompletedEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.headers_refresh_completed"; } + + @JsonProperty("data") + private McpHeadersRefreshCompletedEventData data; + + public McpHeadersRefreshCompletedEventData getData() { return data; } + public void setData(McpHeadersRefreshCompletedEventData data) { this.data = data; } + + /** Data payload for {@link McpHeadersRefreshCompletedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpHeadersRefreshCompletedEventData( + /** Request ID of the resolved headers refresh request */ + @JsonProperty("requestId") String requestId, + /** How the pending MCP headers refresh request resolved. */ + @JsonProperty("outcome") McpHeadersRefreshCompletedOutcome outcome + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java new file mode 100644 index 000000000..7980dd0a6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshCompletedOutcome.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * How the pending MCP headers refresh request resolved. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpHeadersRefreshCompletedOutcome { + /** The {@code headers} variant. */ + HEADERS("headers"), + /** The {@code none} variant. */ + NONE("none"), + /** The {@code timeout} variant. */ + TIMEOUT("timeout"); + + private final String value; + McpHeadersRefreshCompletedOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpHeadersRefreshCompletedOutcome fromValue(String value) { + for (McpHeadersRefreshCompletedOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpHeadersRefreshCompletedOutcome value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java new file mode 100644 index 000000000..d8774bb32 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredEvent.java @@ -0,0 +1,47 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.headers_refresh_required". Dynamic headers refresh request for a remote MCP server + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpHeadersRefreshRequiredEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.headers_refresh_required"; } + + @JsonProperty("data") + private McpHeadersRefreshRequiredEventData data; + + public McpHeadersRefreshRequiredEventData getData() { return data; } + public void setData(McpHeadersRefreshRequiredEventData data) { this.data = data; } + + /** Data payload for {@link McpHeadersRefreshRequiredEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpHeadersRefreshRequiredEventData( + /** Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest() */ + @JsonProperty("requestId") String requestId, + /** Display name of the remote MCP server requesting headers */ + @JsonProperty("serverName") String serverName, + /** URL of the remote MCP server requesting headers */ + @JsonProperty("serverUrl") String serverUrl, + /** Why dynamic headers are being requested. */ + @JsonProperty("reason") McpHeadersRefreshRequiredReason reason + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java new file mode 100644 index 000000000..86c8f8b2d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpHeadersRefreshRequiredReason.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Why dynamic headers are being requested. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpHeadersRefreshRequiredReason { + /** The {@code startup} variant. */ + STARTUP("startup"), + /** The {@code ttl-expired} variant. */ + TTL_EXPIRED("ttl-expired"), + /** The {@code auth-failed} variant. */ + AUTH_FAILED("auth-failed"); + + private final String value; + McpHeadersRefreshRequiredReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpHeadersRefreshRequiredReason fromValue(String value) { + for (McpHeadersRefreshRequiredReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpHeadersRefreshRequiredReason value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java index f02c7d42a..0cbe1b0a8 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "mcp.oauth_completed". MCP OAuth request completion notification - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -36,7 +35,9 @@ public final class McpOauthCompletedEvent extends SessionEvent { @JsonInclude(JsonInclude.Include.NON_NULL) public record McpOauthCompletedEventData( /** Request ID of the resolved OAuth request */ - @JsonProperty("requestId") String requestId + @JsonProperty("requestId") String requestId, + /** How the pending OAuth request was completed */ + @JsonProperty("outcome") McpOauthCompletionOutcome outcome ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java new file mode 100644 index 000000000..6352224da --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthCompletionOutcome.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * How the pending MCP OAuth request was completed + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpOauthCompletionOutcome { + /** The {@code token} variant. */ + TOKEN("token"), + /** The {@code cancelled} variant. */ + CANCELLED("cancelled"); + + private final String value; + McpOauthCompletionOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpOauthCompletionOutcome fromValue(String value) { + for (McpOauthCompletionOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpOauthCompletionOutcome value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java new file mode 100644 index 000000000..bed8e0ac6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthHttpResponse.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpOauthHttpResponse( + /** HTTP status code returned with the auth challenge. */ + @JsonProperty("statusCode") Long statusCode, + /** HTTP response headers as observed by the runtime. Order and casing are transport-dependent, and duplicate header names may appear multiple times. */ + @JsonProperty("headers") List headers, + /** Complete UTF-8 response body for host-specific challenge handling, including an empty string for an empty body. Omitted when the complete body is not valid UTF-8; body read failures fail the HTTP operation rather than exposing a partial response. */ + @JsonProperty("body") String body +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java new file mode 100644 index 000000000..2a6eec706 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequestReason.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Reason the runtime is requesting host-provided MCP OAuth credentials + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpOauthRequestReason { + /** The {@code initial} variant. */ + INITIAL("initial"), + /** The {@code refresh} variant. */ + REFRESH("refresh"), + /** The {@code reauth} variant. */ + REAUTH("reauth"), + /** The {@code upscope} variant. */ + UPSCOPE("upscope"); + + private final String value; + McpOauthRequestReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpOauthRequestReason fromValue(String value) { + for (McpOauthRequestReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpOauthRequestReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java new file mode 100644 index 000000000..f21f84cd4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java @@ -0,0 +1,55 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.oauth_required". OAuth authentication request for an MCP server + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpOauthRequiredEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.oauth_required"; } + + @JsonProperty("data") + private McpOauthRequiredEventData data; + + public McpOauthRequiredEventData getData() { return data; } + public void setData(McpOauthRequiredEventData data) { this.data = data; } + + /** Data payload for {@link McpOauthRequiredEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpOauthRequiredEventData( + /** Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest */ + @JsonProperty("requestId") String requestId, + /** Display name of the MCP server that requires OAuth */ + @JsonProperty("serverName") String serverName, + /** URL of the MCP server that requires OAuth */ + @JsonProperty("serverUrl") String serverUrl, + /** Static OAuth client configuration, if the server specifies one */ + @JsonProperty("staticClientConfig") McpOauthRequiredStaticClientConfig staticClientConfig, + /** OAuth WWW-Authenticate parameters parsed from the auth challenge, if available */ + @JsonProperty("wwwAuthenticateParams") McpOauthWWWAuthenticateParams wwwAuthenticateParams, + /** Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. Header order and casing are transport-dependent, and duplicate header names may appear multiple times. */ + @JsonProperty("httpResponse") McpOauthHttpResponse httpResponse, + /** Raw OAuth protected-resource metadata document fetched for the MCP server, if available */ + @JsonProperty("resourceMetadata") String resourceMetadata, + /** Why the runtime is requesting host-provided OAuth credentials. */ + @JsonProperty("reason") McpOauthRequestReason reason + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java index 764f8b7fc..5f42ec90c 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthRequiredStaticClientConfig.java @@ -23,6 +23,8 @@ public record McpOauthRequiredStaticClientConfig( /** OAuth client ID for the server */ @JsonProperty("clientId") String clientId, + /** Optional OAuth client secret for confidential static clients, when the runtime can resolve one */ + @JsonProperty("clientSecret") String clientSecret, /** Whether this is a public OAuth client */ @JsonProperty("publicClient") Boolean publicClient, /** 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). */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java new file mode 100644 index 000000000..3e1fdb0d1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpOauthWWWAuthenticateParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * OAuth WWW-Authenticate parameters parsed from an MCP auth challenge + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpOauthWWWAuthenticateParams( + /** Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present */ + @JsonProperty("resourceMetadataUrl") String resourceMetadataUrl, + /** Requested OAuth scopes from the WWW-Authenticate scope parameter, if present */ + @JsonProperty("scope") String scope, + /** OAuth error from the WWW-Authenticate error parameter, if present */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java new file mode 100644 index 000000000..805328d3c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpPromptsListChangedEvent.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.prompts.list_changed". Payload identifying the MCP server associated with a list change. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpPromptsListChangedEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.prompts.list_changed"; } + + @JsonProperty("data") + private McpPromptsListChangedEventData data; + + public McpPromptsListChangedEventData getData() { return data; } + public void setData(McpPromptsListChangedEventData data) { this.data = data; } + + /** Data payload for {@link McpPromptsListChangedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpPromptsListChangedEventData( + /** Name of the MCP server whose list changed */ + @JsonProperty("serverName") String serverName + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java new file mode 100644 index 000000000..f1a613b6f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpResourcesListChangedEvent.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.resources.list_changed". Payload identifying the MCP server associated with a list change. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpResourcesListChangedEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.resources.list_changed"; } + + @JsonProperty("data") + private McpResourcesListChangedEventData data; + + public McpResourcesListChangedEventData getData() { return data; } + public void setData(McpResourcesListChangedEventData data) { this.data = data; } + + /** Data payload for {@link McpResourcesListChangedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpResourcesListChangedEventData( + /** Name of the MCP server whose list changed */ + @JsonProperty("serverName") String serverName + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/McpServerSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpServerSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpServerSource.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java new file mode 100644 index 000000000..f11cebdc9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerStatus.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpServerStatus { + /** The {@code connected} variant. */ + CONNECTED("connected"), + /** The {@code failed} variant. */ + FAILED("failed"), + /** The {@code needs-auth} variant. */ + NEEDS_AUTH("needs-auth"), + /** The {@code pending} variant. */ + PENDING("pending"), + /** The {@code disabled} variant. */ + DISABLED("disabled"), + /** The {@code stopped} variant. */ + STOPPED("stopped"), + /** The {@code not_configured} variant. */ + NOT_CONFIGURED("not_configured"); + + private final String value; + McpServerStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpServerStatus fromValue(String value) { + for (McpServerStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpServerStatus value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/McpServerTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpServerTransport.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/McpServerTransport.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpServerTransport.java diff --git a/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java index 9c5d52081..c4567f30f 100644 --- a/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpServersLoadedServer.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `McpServersLoadedServer` type. + * A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata. * * @since 1.0.0 */ @@ -23,7 +23,7 @@ public record McpServersLoadedServer( /** Server name (config key) */ @JsonProperty("name") String name, - /** Connection status: connected, failed, needs-auth, pending, disabled, or not_configured */ + /** Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured */ @JsonProperty("status") McpServerStatus status, /** Configuration source: user, workspace, plugin, or builtin */ @JsonProperty("source") McpServerSource source, diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java new file mode 100644 index 000000000..4255b8544 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/McpToolsListChangedEvent.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "mcp.tools.list_changed". Payload identifying the MCP server associated with a list change. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class McpToolsListChangedEvent extends SessionEvent { + + @Override + public String getType() { return "mcp.tools.list_changed"; } + + @JsonProperty("data") + private McpToolsListChangedEventData data; + + public McpToolsListChangedEventData getData() { return data; } + public void setData(McpToolsListChangedEventData data) { this.data = data; } + + /** Data payload for {@link McpToolsListChangedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record McpToolsListChangedEventData( + /** Name of the MCP server whose list changed */ + @JsonProperty("serverName") String serverName + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java new file mode 100644 index 000000000..1f17ed5e9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureBadRequestKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelCallFailureBadRequestKind { + /** The {@code bodyless} variant. */ + BODYLESS("bodyless"), + /** The {@code structured_error} variant. */ + STRUCTURED_ERROR("structured_error"); + + private final String value; + ModelCallFailureBadRequestKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelCallFailureBadRequestKind fromValue(String value) { + for (ModelCallFailureBadRequestKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelCallFailureBadRequestKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java new file mode 100644 index 000000000..f6c399b4c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java @@ -0,0 +1,85 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Session event "model.call_failure". Failed LLM API call metadata for telemetry + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ModelCallFailureEvent extends SessionEvent { + + @Override + public String getType() { return "model.call_failure"; } + + @JsonProperty("data") + private ModelCallFailureEventData data; + + public ModelCallFailureEventData getData() { return data; } + public void setData(ModelCallFailureEventData data) { this.data = data; } + + /** Data payload for {@link ModelCallFailureEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record ModelCallFailureEventData( + /** Model identifier used for the failed API call */ + @JsonProperty("model") String model, + /** What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ + @JsonProperty("initiator") String initiator, + /** Completion ID from the model provider (e.g., chatcmpl-abc123) */ + @JsonProperty("apiCallId") String apiCallId, + /** GitHub request tracing ID (x-github-request-id header) for server-side log correlation */ + @JsonProperty("providerCallId") String providerCallId, + /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ + @JsonProperty("serviceRequestId") String serviceRequestId, + @JsonProperty("rte") Boolean rte, + /** HTTP status code from the failed request */ + @JsonProperty("statusCode") Long statusCode, + /** Duration of the failed API call in milliseconds */ + @JsonProperty("durationMs") Long durationMs, + /** API endpoint used for this model call, matching CAPI supported_endpoints vocabulary */ + @JsonProperty("apiEndpoint") AssistantUsageApiEndpoint apiEndpoint, + /** Transport used for the failed model call (http or websocket) */ + @JsonProperty("transport") ModelCallFailureTransport transport, + /** Whether the failure originated from an API response or the request transport */ + @JsonProperty("failureKind") ModelCallFailureKind failureKind, + /** Effective maximum prompt-token limit for the failed call */ + @JsonProperty("maxPromptTokens") Long maxPromptTokens, + /** Effective maximum output-token limit for the failed call */ + @JsonProperty("maxOutputTokens") Long maxOutputTokens, + /** Whether the failed call used a bring-your-own-key provider */ + @JsonProperty("isByok") Boolean isByok, + /** Whether the session selected Auto mode for the failed call */ + @JsonProperty("isAuto") Boolean isAuto, + /** Reasoning effort level used for the failed model call, if applicable */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Where the failed model call originated */ + @JsonProperty("source") ModelCallFailureSource source, + /** Raw provider/runtime error message for restricted telemetry */ + @JsonProperty("errorMessage") String errorMessage, + /** For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. */ + @JsonProperty("badRequestKind") ModelCallFailureBadRequestKind badRequestKind, + /** For HTTP 400 failures only: the `code` from the CAPI error envelope (e.g. 'model_max_prompt_tokens_exceeded') identifying which deterministic validation failure occurred. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. */ + @JsonProperty("errorCode") String errorCode, + /** For HTTP 400 failures only: the `type` from the CAPI error envelope (e.g. 'websocket_error'), a coarser companion to errorCode for envelopes that carry no code. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. */ + @JsonProperty("errorType") String errorType, + /** Per-quota usage snapshots parsed from the failed response's quota headers, keyed by quota identifier. Present when the error response carried quota headers (e.g. a 402 once the additional spend limit is reached) so the UI can refresh the quota display on failure. */ + @JsonProperty("quotaSnapshots") Map quotaSnapshots, + /** Content-free structural summary of the failing request. Contains only counts and shape flags (no prompt content), so it is safe for unrestricted telemetry. Populated only for client-error (4xx) failures. */ + @JsonProperty("requestFingerprint") ModelCallFailureRequestFingerprint requestFingerprint + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java new file mode 100644 index 000000000..917bc270f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Boundary that produced a model call failure + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelCallFailureKind { + /** The {@code api} variant. */ + API("api"), + /** The {@code transport} variant. */ + TRANSPORT("transport"); + + private final String value; + ModelCallFailureKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelCallFailureKind fromValue(String value) { + for (ModelCallFailureKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelCallFailureKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java new file mode 100644 index 000000000..b8d0622b6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureRequestFingerprint.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Content-free structural summary of the failing request for diagnosing malformed 4xx calls + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelCallFailureRequestFingerprint( + /** Total number of messages in the request */ + @JsonProperty("messageCount") Long messageCount, + /** Number of "tool" result messages in the request */ + @JsonProperty("toolResultMessageCount") Long toolResultMessageCount, + /** Total number of tool calls across assistant messages */ + @JsonProperty("toolCallCount") Long toolCallCount, + /** Tool calls whose name is missing or empty (rejected by strict providers) */ + @JsonProperty("namelessToolCallCount") Long namelessToolCallCount, + /** Total number of image content parts */ + @JsonProperty("imagePartCount") Long imagePartCount, + /** Image parts whose media type cannot be determined (rejected by strict providers) */ + @JsonProperty("imagePartsMissingMediaType") Long imagePartsMissingMediaType, + /** Role of the final message in the request */ + @JsonProperty("lastMessageRole") String lastMessageRole +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ModelCallFailureSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureSource.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java new file mode 100644 index 000000000..6f656f837 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallFailureTransport.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Transport used for a failed model call + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ModelCallFailureTransport { + /** The {@code http} variant. */ + HTTP("http"), + /** The {@code websocket} variant. */ + WEBSOCKET("websocket"); + + private final String value; + ModelCallFailureTransport(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ModelCallFailureTransport fromValue(String value) { + for (ModelCallFailureTransport v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ModelCallFailureTransport value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java new file mode 100644 index 000000000..9f00e2ac2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ModelCallStartEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "model.call_start". Model API dispatch metadata for internal telemetry + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ModelCallStartEvent extends SessionEvent { + + @Override + public String getType() { return "model.call_start"; } + + @JsonProperty("data") + private ModelCallStartEventData data; + + public ModelCallStartEventData getData() { return data; } + public void setData(ModelCallStartEventData data) { this.data = data; } + + /** Data payload for {@link ModelCallStartEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record ModelCallStartEventData( + /** Identifier of the assistant turn that initiated the model call */ + @JsonProperty("turnId") String turnId, + /** Model identifier used for this API call, when known */ + @JsonProperty("model") String model, + /** Previous response or interaction identifier included in the model request, when present */ + @JsonProperty("previousResponseId") String previousResponseId + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java index 2b7fecee0..77e74d21f 100644 --- a/java/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PendingMessagesModifiedEvent.java @@ -14,7 +14,6 @@ /** * Session event "pending_messages.modified". Empty payload; the event signals that the pending message queue has changed - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java new file mode 100644 index 000000000..d05b936e6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionAllowAllMode.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Allow-all mode for the session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionAllowAllMode { + /** The {@code off} variant. */ + OFF("off"), + /** The {@code on} variant. */ + ON("on"), + /** The {@code auto} variant. */ + AUTO("auto"); + + private final String value; + PermissionAllowAllMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionAllowAllMode fromValue(String value) { + for (PermissionAllowAllMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionAllowAllMode value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java index e389863d3..a21c25e8d 100644 --- a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "permission.completed". Permission request completion notification signaling UI dismissal - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java index 2d7988062..b7aae9ec8 100644 --- a/java/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/PermissionRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "permission.requested". Permission request notification requiring client approval with request details - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -41,6 +40,8 @@ public record PermissionRequestedEventData( @JsonProperty("permissionRequest") Object permissionRequest, /** Derived user-facing permission prompt details for UI consumers */ @JsonProperty("promptRequest") Object promptRequest, + /** Neutral risk metadata supplied by the tool host. Consumers may display this value but must not use it to bypass the permission decision. */ + @JsonProperty("riskAssessment") Object riskAssessment, /** When true, this permission was already resolved by a permissionRequest hook and requires no client action */ @JsonProperty("resolvedByHook") Boolean resolvedByHook ) { diff --git a/java/src/generated/java/com/github/copilot/generated/PlanChangedOperation.java b/java/sdk/src/generated/java/com/github/copilot/generated/PlanChangedOperation.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/PlanChangedOperation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/PlanChangedOperation.java diff --git a/java/src/generated/java/com/github/copilot/generated/ReasoningSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/ReasoningSummary.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ReasoningSummary.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ReasoningSummary.java diff --git a/java/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java index 0cf0e9daa..41d1c61a4 100644 --- a/java/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SamplingCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "sampling.completed". Sampling request completion notification signaling UI dismissal - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java index 1982f552c..3eb53827b 100644 --- a/java/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SamplingRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "sampling.requested". Sampling request from an MCP server; contains the server name and a requestId for correlation - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ScheduleOrigin.java b/java/sdk/src/generated/java/com/github/copilot/generated/ScheduleOrigin.java new file mode 100644 index 000000000..cba65eadb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ScheduleOrigin.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ScheduleOrigin { + /** The {@code user} variant. */ + USER("user"), + /** The {@code model} variant. */ + MODEL("model"); + + private final String value; + ScheduleOrigin(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ScheduleOrigin fromValue(String value) { + for (ScheduleOrigin v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ScheduleOrigin value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java new file mode 100644 index 000000000..88b06f447 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutoModeResolvedEvent.java @@ -0,0 +1,71 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Session event "session.auto_mode_resolved". Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionAutoModeResolvedEvent extends SessionEvent { + + @Override + public String getType() { return "session.auto_mode_resolved"; } + + @JsonProperty("data") + private SessionAutoModeResolvedEventData data; + + public SessionAutoModeResolvedEventData getData() { return data; } + public void setData(SessionAutoModeResolvedEventData data) { this.data = data; } + + /** Data payload for {@link SessionAutoModeResolvedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionAutoModeResolvedEventData( + /** The concrete model the session will use after any intent refinement */ + @JsonProperty("chosenModel") String chosenModel, + /** Coarse request-difficulty bucket, for explaining why a model was chosen ("picked X because this looks like high-reasoning work") */ + @JsonProperty("reasoningBucket") AutoModeResolvedReasoningBucket reasoningBucket, + /** Per-category classifier scores (0-1) behind the bucket: the granular HYDRA capability scores (reasoning, code_gen, debugging, tool_use), or the binary needs_reasoning/no_reasoning scores when HYDRA didn't run. Lets clients show a breakdown rather than just the bucket. */ + @JsonProperty("categoryScores") Map categoryScores, + /** The predicted classifier label (e.g. `needs_reasoning`), when available */ + @JsonProperty("predictedLabel") String predictedLabel, + /** Classifier confidence for the predicted label, when available */ + @JsonProperty("confidence") Double confidence, + /** Ordered candidate model list the router returned, when not a fallback */ + @JsonProperty("candidateModels") List candidateModels, + /** The routing method the server applied, when Auto Intent ran */ + @JsonProperty("routingMethod") String routingMethod, + /** Models offered to the router for this resolution */ + @JsonProperty("availableModels") List availableModels, + /** Whether the router fell back to the standard Auto selection */ + @JsonProperty("fallback") Boolean fallback, + /** Server-provided reason for falling back, when available */ + @JsonProperty("fallbackReason") String fallbackReason, + /** Whether a sticky model choice overrode the router result */ + @JsonProperty("stickyOverride") Boolean stickyOverride, + /** Server-reported router processing time in milliseconds */ + @JsonProperty("routerLatencyMs") Double routerLatencyMs, + /** End-to-end client wait time for the router request in milliseconds */ + @JsonProperty("endToEndLatencyMs") Double endToEndLatencyMs, + /** The chosen model's score shortfall relative to the top candidate */ + @JsonProperty("chosenShortfall") Double chosenShortfall, + /** Whether the routed prompt contained an image */ + @JsonProperty("hasImage") Boolean hasImage + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java index 62f49184c..06f348d9d 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionAutopilotObjectiveChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.autopilot_objective_changed". Autopilot objective state file operation details indicating what changed - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java index 2a712ae49..6058e18c3 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionBackgroundTasksChangedEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.background_tasks_changed". - * + * Session event "session.background_tasks_changed". Empty payload for `session.background_tasks_changed`, indicating background task state changed. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java new file mode 100644 index 000000000..e925f2320 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionBinaryAssetEvent.java @@ -0,0 +1,54 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Session event "session.binary_asset". Canonical bytes for a content-addressed binary asset shared by reference across events + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionBinaryAssetEvent extends SessionEvent { + + @Override + public String getType() { return "session.binary_asset"; } + + @JsonProperty("data") + private SessionBinaryAssetEventData data; + + public SessionBinaryAssetEventData getData() { return data; } + public void setData(SessionBinaryAssetEventData data) { this.data = data; } + + /** Data payload for {@link SessionBinaryAssetEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionBinaryAssetEventData( + /** Content-addressed id for this binary asset (e.g. "sha256:..."). */ + @JsonProperty("assetId") String assetId, + /** Binary asset type discriminator. Use "image" for images and "resource" otherwise. */ + @JsonProperty("type") BinaryAssetType type, + /** MIME type of the binary asset */ + @JsonProperty("mimeType") String mimeType, + /** Decoded byte length of the binary asset */ + @JsonProperty("byteLength") Long byteLength, + /** Base64-encoded binary data */ + @JsonProperty("data") String data, + /** Human-readable description of the binary data */ + @JsonProperty("description") String description, + /** Optional metadata from the producing tool. */ + @JsonProperty("metadata") Map metadata + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java new file mode 100644 index 000000000..b660c0be6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasClosedEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.canvas.closed". Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCanvasClosedEvent extends SessionEvent { + + @Override + public String getType() { return "session.canvas.closed"; } + + @JsonProperty("data") + private SessionCanvasClosedEventData data; + + public SessionCanvasClosedEventData getData() { return data; } + public void setData(SessionCanvasClosedEventData data) { this.data = data; } + + /** Data payload for {@link SessionCanvasClosedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionCanvasClosedEventData( + /** Stable caller-supplied identifier of the canvas instance that was closed */ + @JsonProperty("instanceId") String instanceId, + /** Owning provider identifier */ + @JsonProperty("extensionId") String extensionId, + /** Provider-local canvas identifier */ + @JsonProperty("canvasId") String canvasId + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java similarity index 81% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java index ea32bd479..018e6a234 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasOpenedEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.canvas.opened". - * + * Session event "session.canvas.opened". Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -43,6 +42,8 @@ public record SessionCanvasOpenedEventData( @JsonProperty("extensionName") String extensionName, /** Provider-local canvas identifier */ @JsonProperty("canvasId") String canvasId, + /** Host-local PNG path for the canvas icon, when supplied */ + @JsonProperty("icon") String icon, /** Rendered title */ @JsonProperty("title") String title, /** Provider-supplied status text */ @@ -50,11 +51,7 @@ public record SessionCanvasOpenedEventData( /** URL for web-rendered canvases */ @JsonProperty("url") String url, /** Input supplied when the instance was opened */ - @JsonProperty("input") Object input, - /** Whether this notification represents an idempotent reopen */ - @JsonProperty("reopen") Boolean reopen, - /** Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. */ - @JsonProperty("availability") CanvasOpenedAvailability availability + @JsonProperty("input") Object input ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java new file mode 100644 index 000000000..6f2fb4259 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRecordedEvent.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.canvas.recorded". Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCanvasRecordedEvent extends SessionEvent { + + @Override + public String getType() { return "session.canvas.recorded"; } + + @JsonProperty("data") + private SessionCanvasRecordedEventData data; + + public SessionCanvasRecordedEventData getData() { return data; } + public void setData(SessionCanvasRecordedEventData data) { this.data = data; } + + /** Data payload for {@link SessionCanvasRecordedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionCanvasRecordedEventData( + /** Stable caller-supplied canvas instance identifier */ + @JsonProperty("instanceId") String instanceId, + /** Owning provider identifier */ + @JsonProperty("extensionId") String extensionId, + /** Provider-local canvas identifier */ + @JsonProperty("canvasId") String canvasId, + /** Rendered title */ + @JsonProperty("title") String title, + /** Input supplied when the instance was opened */ + @JsonProperty("input") Object input + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java index 4fb2a034b..0a6a9b62d 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRegistryChangedEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.canvas.registry_changed". - * + * Session event "session.canvas.registry_changed". Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java new file mode 100644 index 000000000..cea7ab09a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasRemovedEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.canvas.removed". Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCanvasRemovedEvent extends SessionEvent { + + @Override + public String getType() { return "session.canvas.removed"; } + + @JsonProperty("data") + private SessionCanvasRemovedEventData data; + + public SessionCanvasRemovedEventData getData() { return data; } + public void setData(SessionCanvasRemovedEventData data) { this.data = data; } + + /** Data payload for {@link SessionCanvasRemovedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionCanvasRemovedEventData( + /** Stable caller-supplied identifier of the canvas instance that was closed */ + @JsonProperty("instanceId") String instanceId, + /** Owning provider identifier */ + @JsonProperty("extensionId") String extensionId, + /** Provider-local canvas identifier */ + @JsonProperty("canvasId") String canvasId + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java new file mode 100644 index 000000000..4e4397ecb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCanvasUnavailableEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.canvas.unavailable". Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCanvasUnavailableEvent extends SessionEvent { + + @Override + public String getType() { return "session.canvas.unavailable"; } + + @JsonProperty("data") + private SessionCanvasUnavailableEventData data; + + public SessionCanvasUnavailableEventData getData() { return data; } + public void setData(SessionCanvasUnavailableEventData data) { this.data = data; } + + /** Data payload for {@link SessionCanvasUnavailableEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionCanvasUnavailableEventData( + /** Stable caller-supplied identifier of the canvas instance whose provider became unavailable */ + @JsonProperty("instanceId") String instanceId, + /** Owning provider identifier */ + @JsonProperty("extensionId") String extensionId, + /** Provider-local canvas identifier */ + @JsonProperty("canvasId") String canvasId + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java index d64979195..d05110abc 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionCompleteEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.compaction_complete". Conversation compaction results including success status, metrics, and optional error details - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -68,7 +67,13 @@ public record SessionCompactionCompleteEventData( /** Token count from non-system messages (user, assistant, tool) after compaction */ @JsonProperty("conversationTokens") Long conversationTokens, /** Token count from tool definitions after compaction */ - @JsonProperty("toolDefinitionsTokens") Long toolDefinitionsTokens + @JsonProperty("toolDefinitionsTokens") Long toolDefinitionsTokens, + /** For failed compaction only: the HTTP status code of the compaction LLM call failure, when it carried one. Absent for successful compaction and for failures without an HTTP status (e.g. an empty model response or a transport error). */ + @JsonProperty("statusCode") Long statusCode, + /** Model context window token limit the compaction was targeting, when known */ + @JsonProperty("tokenLimit") Long tokenLimit, + /** What initiated this compaction, when known */ + @JsonProperty("trigger") CompactionTrigger trigger ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java index 90fcd76b6..076a12426 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCompactionStartEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.compaction_start". Context window breakdown at the start of LLM-powered conversation compaction - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -35,12 +34,20 @@ public final class SessionCompactionStartEvent extends SessionEvent { @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_NULL) public record SessionCompactionStartEventData( + /** Model identifier used for compaction, when known */ + @JsonProperty("model") String model, /** Token count from system message(s) at compaction start */ @JsonProperty("systemTokens") Long systemTokens, /** Token count from non-system messages (user, assistant, tool) at compaction start */ @JsonProperty("conversationTokens") Long conversationTokens, /** Token count from tool definitions at compaction start */ - @JsonProperty("toolDefinitionsTokens") Long toolDefinitionsTokens + @JsonProperty("toolDefinitionsTokens") Long toolDefinitionsTokens, + /** Total context tokens (system + conversation + tool definitions) at compaction start, when known */ + @JsonProperty("currentTokens") Long currentTokens, + /** Model context window token limit the compaction is targeting, when known */ + @JsonProperty("tokenLimit") Long tokenLimit, + /** What initiated this compaction, when known */ + @JsonProperty("trigger") CompactionTrigger trigger ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java index 1fc5ef0ea..fc96eff67 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.context_changed". Updated working directory and git context after the change - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -50,7 +49,9 @@ public record SessionContextChangedEventData( /** Head commit of current git branch at session start time */ @JsonProperty("headCommit") String headCommit, /** Base commit of current git branch at session start time */ - @JsonProperty("baseCommit") String baseCommit + @JsonProperty("baseCommit") String baseCommit, + /** Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). */ + @JsonProperty("pendingGitContext") Boolean pendingGitContext ) { } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextClearedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextClearedEvent.java new file mode 100644 index 000000000..7a4e9cd00 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionContextClearedEvent.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.context_cleared". Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionContextClearedEvent extends SessionEvent { + + @Override + public String getType() { return "session.context_cleared"; } + + @JsonProperty("data") + private SessionContextClearedEventData data; + + public SessionContextClearedEventData getData() { return data; } + public void setData(SessionContextClearedEventData data) { this.data = data; } + + /** Data payload for {@link SessionContextClearedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionContextClearedEventData( + /** Optional initial message set after clearing */ + @JsonProperty("initialMessage") String initialMessage, + /** Number of conversation messages that were cleared */ + @JsonProperty("messagesCleared") Long messagesCleared + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java index 9ceed8c65..6d7ed6611 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomAgentsUpdatedEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.custom_agents_updated". - * + * Session event "session.custom_agents_updated". Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java index 499d143d4..40b1ff3a6 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionCustomNotificationEvent.java @@ -15,7 +15,6 @@ /** * Session event "session.custom_notification". Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java index 12fa20ac1..cd7f34365 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionErrorEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.error". Error details for timeline display including message and optional diagnostic information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionEvent.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/SessionEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionEvent.java index 570fe3a9e..582ecd3d4 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionEvent.java @@ -33,42 +33,53 @@ @JsonSubTypes.Type(value = SessionTitleChangedEvent.class, name = "session.title_changed"), @JsonSubTypes.Type(value = SessionScheduleCreatedEvent.class, name = "session.schedule_created"), @JsonSubTypes.Type(value = SessionScheduleCancelledEvent.class, name = "session.schedule_cancelled"), + @JsonSubTypes.Type(value = SessionScheduleRearmedEvent.class, name = "session.schedule_rearmed"), @JsonSubTypes.Type(value = SessionAutopilotObjectiveChangedEvent.class, name = "session.autopilot_objective_changed"), @JsonSubTypes.Type(value = SessionInfoEvent.class, name = "session.info"), @JsonSubTypes.Type(value = SessionWarningEvent.class, name = "session.warning"), @JsonSubTypes.Type(value = SessionModelChangeEvent.class, name = "session.model_change"), @JsonSubTypes.Type(value = SessionModeChangedEvent.class, name = "session.mode_changed"), + @JsonSubTypes.Type(value = SessionSessionLimitsChangedEvent.class, name = "session.session_limits_changed"), @JsonSubTypes.Type(value = SessionPermissionsChangedEvent.class, name = "session.permissions_changed"), @JsonSubTypes.Type(value = SessionPlanChangedEvent.class, name = "session.plan_changed"), + @JsonSubTypes.Type(value = SessionTodosChangedEvent.class, name = "session.todos_changed"), @JsonSubTypes.Type(value = SessionWorkspaceFileChangedEvent.class, name = "session.workspace_file_changed"), @JsonSubTypes.Type(value = SessionHandoffEvent.class, name = "session.handoff"), @JsonSubTypes.Type(value = SessionTruncationEvent.class, name = "session.truncation"), @JsonSubTypes.Type(value = SessionSnapshotRewindEvent.class, name = "session.snapshot_rewind"), @JsonSubTypes.Type(value = SessionShutdownEvent.class, name = "session.shutdown"), + @JsonSubTypes.Type(value = SessionUsageCheckpointEvent.class, name = "session.usage_checkpoint"), @JsonSubTypes.Type(value = SessionContextChangedEvent.class, name = "session.context_changed"), @JsonSubTypes.Type(value = SessionUsageInfoEvent.class, name = "session.usage_info"), + @JsonSubTypes.Type(value = SessionContextClearedEvent.class, name = "session.context_cleared"), @JsonSubTypes.Type(value = SessionCompactionStartEvent.class, name = "session.compaction_start"), @JsonSubTypes.Type(value = SessionCompactionCompleteEvent.class, name = "session.compaction_complete"), @JsonSubTypes.Type(value = SessionTaskCompleteEvent.class, name = "session.task_complete"), @JsonSubTypes.Type(value = UserMessageEvent.class, name = "user.message"), @JsonSubTypes.Type(value = PendingMessagesModifiedEvent.class, name = "pending_messages.modified"), @JsonSubTypes.Type(value = AssistantTurnStartEvent.class, name = "assistant.turn_start"), + @JsonSubTypes.Type(value = AssistantTurnRetryEvent.class, name = "assistant.turn_retry"), @JsonSubTypes.Type(value = AssistantIntentEvent.class, name = "assistant.intent"), + @JsonSubTypes.Type(value = AssistantServerToolProgressEvent.class, name = "assistant.server_tool_progress"), @JsonSubTypes.Type(value = AssistantReasoningEvent.class, name = "assistant.reasoning"), @JsonSubTypes.Type(value = AssistantReasoningDeltaEvent.class, name = "assistant.reasoning_delta"), + @JsonSubTypes.Type(value = AssistantToolCallDeltaEvent.class, name = "assistant.tool_call_delta"), @JsonSubTypes.Type(value = AssistantStreamingDeltaEvent.class, name = "assistant.streaming_delta"), @JsonSubTypes.Type(value = AssistantMessageEvent.class, name = "assistant.message"), @JsonSubTypes.Type(value = AssistantMessageStartEvent.class, name = "assistant.message_start"), @JsonSubTypes.Type(value = AssistantMessageDeltaEvent.class, name = "assistant.message_delta"), @JsonSubTypes.Type(value = AssistantTurnEndEvent.class, name = "assistant.turn_end"), + @JsonSubTypes.Type(value = AssistantIdleEvent.class, name = "assistant.idle"), @JsonSubTypes.Type(value = AssistantUsageEvent.class, name = "assistant.usage"), @JsonSubTypes.Type(value = ModelCallFailureEvent.class, name = "model.call_failure"), + @JsonSubTypes.Type(value = ModelCallStartEvent.class, name = "model.call_start"), @JsonSubTypes.Type(value = AbortEvent.class, name = "abort"), @JsonSubTypes.Type(value = ToolUserRequestedEvent.class, name = "tool.user_requested"), @JsonSubTypes.Type(value = ToolExecutionStartEvent.class, name = "tool.execution_start"), @JsonSubTypes.Type(value = ToolExecutionPartialResultEvent.class, name = "tool.execution_partial_result"), @JsonSubTypes.Type(value = ToolExecutionProgressEvent.class, name = "tool.execution_progress"), @JsonSubTypes.Type(value = ToolExecutionCompleteEvent.class, name = "tool.execution_complete"), + @JsonSubTypes.Type(value = ToolSearchActivatedEvent.class, name = "tool_search.activated"), @JsonSubTypes.Type(value = SkillInvokedEvent.class, name = "skill.invoked"), @JsonSubTypes.Type(value = SubagentStartedEvent.class, name = "subagent.started"), @JsonSubTypes.Type(value = SubagentCompletedEvent.class, name = "subagent.completed"), @@ -78,6 +89,7 @@ @JsonSubTypes.Type(value = HookStartEvent.class, name = "hook.start"), @JsonSubTypes.Type(value = HookEndEvent.class, name = "hook.end"), @JsonSubTypes.Type(value = HookProgressEvent.class, name = "hook.progress"), + @JsonSubTypes.Type(value = SessionBinaryAssetEvent.class, name = "session.binary_asset"), @JsonSubTypes.Type(value = SystemMessageEvent.class, name = "system.message"), @JsonSubTypes.Type(value = SystemNotificationEvent.class, name = "system.notification"), @JsonSubTypes.Type(value = PermissionRequestedEvent.class, name = "permission.requested"), @@ -90,6 +102,8 @@ @JsonSubTypes.Type(value = SamplingCompletedEvent.class, name = "sampling.completed"), @JsonSubTypes.Type(value = McpOauthRequiredEvent.class, name = "mcp.oauth_required"), @JsonSubTypes.Type(value = McpOauthCompletedEvent.class, name = "mcp.oauth_completed"), + @JsonSubTypes.Type(value = McpHeadersRefreshRequiredEvent.class, name = "mcp.headers_refresh_required"), + @JsonSubTypes.Type(value = McpHeadersRefreshCompletedEvent.class, name = "mcp.headers_refresh_completed"), @JsonSubTypes.Type(value = SessionCustomNotificationEvent.class, name = "session.custom_notification"), @JsonSubTypes.Type(value = ExternalToolRequestedEvent.class, name = "external_tool.requested"), @JsonSubTypes.Type(value = ExternalToolCompletedEvent.class, name = "external_tool.completed"), @@ -98,19 +112,33 @@ @JsonSubTypes.Type(value = CommandCompletedEvent.class, name = "command.completed"), @JsonSubTypes.Type(value = AutoModeSwitchRequestedEvent.class, name = "auto_mode_switch.requested"), @JsonSubTypes.Type(value = AutoModeSwitchCompletedEvent.class, name = "auto_mode_switch.completed"), + @JsonSubTypes.Type(value = SessionLimitsExhaustedRequestedEvent.class, name = "session_limits_exhausted.requested"), + @JsonSubTypes.Type(value = SessionLimitsExhaustedCompletedEvent.class, name = "session_limits_exhausted.completed"), + @JsonSubTypes.Type(value = SessionAutoModeResolvedEvent.class, name = "session.auto_mode_resolved"), + @JsonSubTypes.Type(value = SessionManagedSettingsResolvedEvent.class, name = "session.managed_settings_resolved"), + @JsonSubTypes.Type(value = SessionManagedSettingsEnforcedEvent.class, name = "session.managed_settings_enforced"), @JsonSubTypes.Type(value = CommandsChangedEvent.class, name = "commands.changed"), @JsonSubTypes.Type(value = CapabilitiesChangedEvent.class, name = "capabilities.changed"), @JsonSubTypes.Type(value = ExitPlanModeRequestedEvent.class, name = "exit_plan_mode.requested"), @JsonSubTypes.Type(value = ExitPlanModeCompletedEvent.class, name = "exit_plan_mode.completed"), @JsonSubTypes.Type(value = SessionToolsUpdatedEvent.class, name = "session.tools_updated"), @JsonSubTypes.Type(value = SessionBackgroundTasksChangedEvent.class, name = "session.background_tasks_changed"), + @JsonSubTypes.Type(value = FactoryRunUpdatedEvent.class, name = "factory.run_updated"), @JsonSubTypes.Type(value = SessionSkillsLoadedEvent.class, name = "session.skills_loaded"), @JsonSubTypes.Type(value = SessionCustomAgentsUpdatedEvent.class, name = "session.custom_agents_updated"), @JsonSubTypes.Type(value = SessionMcpServersLoadedEvent.class, name = "session.mcp_servers_loaded"), @JsonSubTypes.Type(value = SessionMcpServerStatusChangedEvent.class, name = "session.mcp_server_status_changed"), + @JsonSubTypes.Type(value = McpToolsListChangedEvent.class, name = "mcp.tools.list_changed"), + @JsonSubTypes.Type(value = McpResourcesListChangedEvent.class, name = "mcp.resources.list_changed"), + @JsonSubTypes.Type(value = McpPromptsListChangedEvent.class, name = "mcp.prompts.list_changed"), @JsonSubTypes.Type(value = SessionExtensionsLoadedEvent.class, name = "session.extensions_loaded"), @JsonSubTypes.Type(value = SessionCanvasOpenedEvent.class, name = "session.canvas.opened"), @JsonSubTypes.Type(value = SessionCanvasRegistryChangedEvent.class, name = "session.canvas.registry_changed"), + @JsonSubTypes.Type(value = SessionCanvasClosedEvent.class, name = "session.canvas.closed"), + @JsonSubTypes.Type(value = SessionCanvasUnavailableEvent.class, name = "session.canvas.unavailable"), + @JsonSubTypes.Type(value = SessionCanvasRecordedEvent.class, name = "session.canvas.recorded"), + @JsonSubTypes.Type(value = SessionCanvasRemovedEvent.class, name = "session.canvas.removed"), + @JsonSubTypes.Type(value = SessionExtensionsAttachmentsPushedEvent.class, name = "session.extensions.attachments_pushed"), @JsonSubTypes.Type(value = McpAppToolCallCompleteEvent.class, name = "mcp_app.tool_call_complete") }) @javax.annotation.processing.Generated("copilot-sdk-codegen") @@ -123,42 +151,53 @@ public abstract sealed class SessionEvent permits SessionTitleChangedEvent, SessionScheduleCreatedEvent, SessionScheduleCancelledEvent, + SessionScheduleRearmedEvent, SessionAutopilotObjectiveChangedEvent, SessionInfoEvent, SessionWarningEvent, SessionModelChangeEvent, SessionModeChangedEvent, + SessionSessionLimitsChangedEvent, SessionPermissionsChangedEvent, SessionPlanChangedEvent, + SessionTodosChangedEvent, SessionWorkspaceFileChangedEvent, SessionHandoffEvent, SessionTruncationEvent, SessionSnapshotRewindEvent, SessionShutdownEvent, + SessionUsageCheckpointEvent, SessionContextChangedEvent, SessionUsageInfoEvent, + SessionContextClearedEvent, SessionCompactionStartEvent, SessionCompactionCompleteEvent, SessionTaskCompleteEvent, UserMessageEvent, PendingMessagesModifiedEvent, AssistantTurnStartEvent, + AssistantTurnRetryEvent, AssistantIntentEvent, + AssistantServerToolProgressEvent, AssistantReasoningEvent, AssistantReasoningDeltaEvent, + AssistantToolCallDeltaEvent, AssistantStreamingDeltaEvent, AssistantMessageEvent, AssistantMessageStartEvent, AssistantMessageDeltaEvent, AssistantTurnEndEvent, + AssistantIdleEvent, AssistantUsageEvent, ModelCallFailureEvent, + ModelCallStartEvent, AbortEvent, ToolUserRequestedEvent, ToolExecutionStartEvent, ToolExecutionPartialResultEvent, ToolExecutionProgressEvent, ToolExecutionCompleteEvent, + ToolSearchActivatedEvent, SkillInvokedEvent, SubagentStartedEvent, SubagentCompletedEvent, @@ -168,6 +207,7 @@ public abstract sealed class SessionEvent permits HookStartEvent, HookEndEvent, HookProgressEvent, + SessionBinaryAssetEvent, SystemMessageEvent, SystemNotificationEvent, PermissionRequestedEvent, @@ -180,6 +220,8 @@ public abstract sealed class SessionEvent permits SamplingCompletedEvent, McpOauthRequiredEvent, McpOauthCompletedEvent, + McpHeadersRefreshRequiredEvent, + McpHeadersRefreshCompletedEvent, SessionCustomNotificationEvent, ExternalToolRequestedEvent, ExternalToolCompletedEvent, @@ -188,19 +230,33 @@ public abstract sealed class SessionEvent permits CommandCompletedEvent, AutoModeSwitchRequestedEvent, AutoModeSwitchCompletedEvent, + SessionLimitsExhaustedRequestedEvent, + SessionLimitsExhaustedCompletedEvent, + SessionAutoModeResolvedEvent, + SessionManagedSettingsResolvedEvent, + SessionManagedSettingsEnforcedEvent, CommandsChangedEvent, CapabilitiesChangedEvent, ExitPlanModeRequestedEvent, ExitPlanModeCompletedEvent, SessionToolsUpdatedEvent, SessionBackgroundTasksChangedEvent, + FactoryRunUpdatedEvent, SessionSkillsLoadedEvent, SessionCustomAgentsUpdatedEvent, SessionMcpServersLoadedEvent, SessionMcpServerStatusChangedEvent, + McpToolsListChangedEvent, + McpResourcesListChangedEvent, + McpPromptsListChangedEvent, SessionExtensionsLoadedEvent, SessionCanvasOpenedEvent, SessionCanvasRegistryChangedEvent, + SessionCanvasClosedEvent, + SessionCanvasUnavailableEvent, + SessionCanvasRecordedEvent, + SessionCanvasRemovedEvent, + SessionExtensionsAttachmentsPushedEvent, McpAppToolCallCompleteEvent, UnknownSessionEvent { @@ -216,6 +272,10 @@ public abstract sealed class SessionEvent permits @JsonProperty("parentId") private UUID parentId; + /** Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ + @JsonProperty("agentId") + private String agentId; + /** When true, the event is transient and not persisted to the session event log on disk. */ @JsonProperty("ephemeral") private Boolean ephemeral; @@ -236,6 +296,9 @@ public abstract sealed class SessionEvent permits public UUID getParentId() { return parentId; } public void setParentId(UUID parentId) { this.parentId = parentId; } + public String getAgentId() { return agentId; } + public void setAgentId(String agentId) { this.agentId = agentId; } + public Boolean getEphemeral() { return ephemeral; } public void setEphemeral(Boolean ephemeral) { this.ephemeral = ephemeral; } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java new file mode 100644 index 000000000..72d0a9def --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsAttachmentsPushedEvent.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Session event "session.extensions.attachments_pushed". Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionExtensionsAttachmentsPushedEvent extends SessionEvent { + + @Override + public String getType() { return "session.extensions.attachments_pushed"; } + + @JsonProperty("data") + private SessionExtensionsAttachmentsPushedEventData data; + + public SessionExtensionsAttachmentsPushedEventData getData() { return data; } + public void setData(SessionExtensionsAttachmentsPushedEventData data) { this.data = data; } + + /** Data payload for {@link SessionExtensionsAttachmentsPushedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionExtensionsAttachmentsPushedEventData( + /** Attachments contributed by an extension; the host should surface these as composer pills and forward them via the next session.send call. */ + @JsonProperty("attachments") List attachments + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java index 0165be5d2..6ec3ec274 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionExtensionsLoadedEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.extensions_loaded". - * + * Session event "session.extensions_loaded". Payload of `session.extensions_loaded` listing discovered extensions and their statuses. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java index 7edba44c0..32736fb42 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionHandoffEvent.java @@ -15,7 +15,6 @@ /** * Session event "session.handoff". Session handoff metadata including source, context, and repository information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java index dc7136c20..e51a26e5a 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionIdleEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.idle". Payload indicating the session is idle with no background agents in flight - * + * Session event "session.idle". Payload indicating the session is idle with no background agents or attached shell commands in flight * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java index 2d9ac3690..f2d3d61b6 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionInfoEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.info". Informational message for timeline display with categorization - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java new file mode 100644 index 000000000..e566d630b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsConfig.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Optional session limits. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitsConfig( + /** Maximum AI Credits allowed across the session's current accounting window. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java new file mode 100644 index 000000000..f23ae9a73 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedCompletedEvent.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session_limits_exhausted.completed". Session limit exhaustion prompt completion notification. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionLimitsExhaustedCompletedEvent extends SessionEvent { + + @Override + public String getType() { return "session_limits_exhausted.completed"; } + + @JsonProperty("data") + private SessionLimitsExhaustedCompletedEventData data; + + public SessionLimitsExhaustedCompletedEventData getData() { return data; } + public void setData(SessionLimitsExhaustedCompletedEventData data) { this.data = data; } + + /** Data payload for {@link SessionLimitsExhaustedCompletedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionLimitsExhaustedCompletedEventData( + /** Request ID of the resolved request; clients should dismiss any UI for this request. */ + @JsonProperty("requestId") String requestId, + /** The user's selected session-limit action. */ + @JsonProperty("response") SessionLimitsExhaustedResponse response + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java new file mode 100644 index 000000000..3bde1f334 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedRequestedEvent.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session_limits_exhausted.requested". Session limit exhaustion notification requiring user action. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionLimitsExhaustedRequestedEvent extends SessionEvent { + + @Override + public String getType() { return "session_limits_exhausted.requested"; } + + @JsonProperty("data") + private SessionLimitsExhaustedRequestedEventData data; + + public SessionLimitsExhaustedRequestedEventData getData() { return data; } + public void setData(SessionLimitsExhaustedRequestedEventData data) { this.data = data; } + + /** Data payload for {@link SessionLimitsExhaustedRequestedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionLimitsExhaustedRequestedEventData( + /** Unique identifier for this request; used to respond via session.ui.handlePendingSessionLimitsExhausted(). */ + @JsonProperty("requestId") String requestId, + /** AI Credits already consumed in the current accounting window. */ + @JsonProperty("usedAiCredits") Double usedAiCredits, + /** Configured max AI Credits for the current accounting window. */ + @JsonProperty("maxAiCredits") Double maxAiCredits + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java new file mode 100644 index 000000000..5bbc7ffef --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponse.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * The user's selected action for an exhausted session limit. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitsExhaustedResponse( + /** Action selected by the user. */ + @JsonProperty("action") SessionLimitsExhaustedResponseAction action, + /** AI Credits to add to the current max when action is 'add'. */ + @JsonProperty("additionalAiCredits") Double additionalAiCredits, + /** New absolute max AI Credits when action is 'set'. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java new file mode 100644 index 000000000..706d3bf9d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionLimitsExhaustedResponseAction.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * User action selected for an exhausted session limit. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionLimitsExhaustedResponseAction { + /** The {@code add} variant. */ + ADD("add"), + /** The {@code set} variant. */ + SET("set"), + /** The {@code unset} variant. */ + UNSET("unset"), + /** The {@code cancel} variant. */ + CANCEL("cancel"); + + private final String value; + SessionLimitsExhaustedResponseAction(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionLimitsExhaustedResponseAction fromValue(String value) { + for (SessionLimitsExhaustedResponseAction v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionLimitsExhaustedResponseAction value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java new file mode 100644 index 000000000..c712a220a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsEnforcedEvent.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.managed_settings_enforced". Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionManagedSettingsEnforcedEvent extends SessionEvent { + + @Override + public String getType() { return "session.managed_settings_enforced"; } + + @JsonProperty("data") + private SessionManagedSettingsEnforcedEventData data; + + public SessionManagedSettingsEnforcedEventData getData() { return data; } + public void setData(SessionManagedSettingsEnforcedEventData data) { this.data = data; } + + /** Data payload for {@link SessionManagedSettingsEnforcedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionManagedSettingsEnforcedEventData( + /** The category of runtime action that managed policy governed. */ + @JsonProperty("action") ManagedSettingsEnforcedAction action, + /** For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused. Absent for actions without a specific escalation primitive. */ + @JsonProperty("escalation") ManagedSettingsEnforcedEscalation escalation, + /** The managed setting key responsible for the enforcement (e.g. `permissions.disableBypassPermissionsMode`). */ + @JsonProperty("setting") String setting, + /** Whether the enforcement was forced by fail-closed handling (managed policy could not be determined) rather than an explicit managed setting. When true, `setting` still names the restriction that was applied. */ + @JsonProperty("failClosed") Boolean failClosed, + /** A human-readable explanation of why the action was governed, suitable for surfacing to the user. */ + @JsonProperty("message") String message + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java new file mode 100644 index 000000000..f935f4462 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionManagedSettingsResolvedEvent.java @@ -0,0 +1,58 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Session event "session.managed_settings_resolved". Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionManagedSettingsResolvedEvent extends SessionEvent { + + @Override + public String getType() { return "session.managed_settings_resolved"; } + + @JsonProperty("data") + private SessionManagedSettingsResolvedEventData data; + + public SessionManagedSettingsResolvedEventData getData() { return data; } + public void setData(SessionManagedSettingsResolvedEventData data) { this.data = data; } + + /** Data payload for {@link SessionManagedSettingsResolvedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionManagedSettingsResolvedEventData( + /** Channel summary: `server`, `device`, or `client` when exactly one channel contributed; `mixed` when multiple channels contributed; otherwise `none`. Consult the per-channel booleans for exact provenance. */ + @JsonProperty("source") ManagedSettingsResolvedSource source, + /** Whether the server (account/org) managed-settings layer was present */ + @JsonProperty("serverManaged") Boolean serverManaged, + /** Whether an actual device MDM/plist/registry/file managed-settings layer was present */ + @JsonProperty("deviceManaged") Boolean deviceManaged, + /** Whether a session-local permissions layer injected by the SDK host was present */ + @JsonProperty("clientManaged") Boolean clientManaged, + /** Whether managed policy could not be determined (e.g. a failed server fetch) and the session fell back to the fail-closed restriction. When true, restrictions such as disabling bypass-permissions are enforced even though `settings` may be absent. */ + @JsonProperty("failClosed") Boolean failClosed, + /** Whether enterprise policy disables bypass-permissions ("yolo") mode for this session. Deny-wins across layers, and forced on when `failClosed` is true. */ + @JsonProperty("bypassPermissionsDisabled") Boolean bypassPermissionsDisabled, + /** Whether at least two managed sources supplied permission allowlists, so enforcement intersects them and the flattened settings payload omits `permissions.allow`. */ + @JsonProperty("permissionsAllowIntersected") Boolean permissionsAllowIntersected, + /** The setting keys under enterprise management in the effective managed settings (e.g. `model`, `enabledPlugins`, `permissions`). Empty when no managed settings are in force. */ + @JsonProperty("managedKeys") List managedKeys, + /** The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. */ + @JsonProperty("settings") Object settings + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java index 1567a2f35..b084652db 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServerStatusChangedEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.mcp_server_status_changed". - * + * Session event "session.mcp_server_status_changed". Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -37,7 +36,7 @@ public final class SessionMcpServerStatusChangedEvent extends SessionEvent { public record SessionMcpServerStatusChangedEventData( /** Name of the MCP server whose status changed */ @JsonProperty("serverName") String serverName, - /** Connection status: connected, failed, needs-auth, pending, disabled, or not_configured */ + /** Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured */ @JsonProperty("status") McpServerStatus status, /** Error message if the server entered a failed state */ @JsonProperty("error") String error diff --git a/java/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java index d97875513..98ddc5b19 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMcpServersLoadedEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.mcp_servers_loaded". - * + * Session event "session.mcp_servers_loaded". Payload of `session.mcp_servers_loaded` listing MCP server status summaries. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SessionMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java index 28fb3e9e4..8b2cfbd25 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModeChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.mode_changed". Agent mode change details including previous and new modes - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java new file mode 100644 index 000000000..e53c1594a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java @@ -0,0 +1,59 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.model_change". Model change details including previous and new model identifiers + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionModelChangeEvent extends SessionEvent { + + @Override + public String getType() { return "session.model_change"; } + + @JsonProperty("data") + private SessionModelChangeEventData data; + + public SessionModelChangeEventData getData() { return data; } + public void setData(SessionModelChangeEventData data) { this.data = data; } + + /** Data payload for {@link SessionModelChangeEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionModelChangeEventData( + /** Model that was previously selected, if any */ + @JsonProperty("previousModel") String previousModel, + /** Newly selected model identifier */ + @JsonProperty("newModel") String newModel, + /** Reasoning effort level before the model change, if applicable */ + @JsonProperty("previousReasoningEffort") String previousReasoningEffort, + /** Reasoning effort level after the model change, if applicable */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Reasoning summary mode before the model change, if applicable */ + @JsonProperty("previousReasoningSummary") ReasoningSummary previousReasoningSummary, + /** Reasoning summary mode after the model change, if applicable */ + @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, + /** Output verbosity level before the model change, if applicable */ + @JsonProperty("previousVerbosity") Verbosity previousVerbosity, + /** Output verbosity level after the model change, if applicable */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Context tier after the model change; null explicitly clears a previously selected tier */ + @JsonProperty("contextTier") ContextTier contextTier, + /** Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy. */ + @JsonProperty("cause") String cause + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java index 91ac1d3c8..c1f82f5af 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionPermissionsChangedEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all boolean transition. - * + * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -38,7 +37,11 @@ public record SessionPermissionsChangedEventData( /** Aggregate allow-all flag before the change */ @JsonProperty("previousAllowAllPermissions") Boolean previousAllowAllPermissions, /** Aggregate allow-all flag after the change */ - @JsonProperty("allowAllPermissions") Boolean allowAllPermissions + @JsonProperty("allowAllPermissions") Boolean allowAllPermissions, + /** Allow-all mode before the change */ + @JsonProperty("previousAllowAllPermissionMode") PermissionAllowAllMode previousAllowAllPermissionMode, + /** Allow-all mode after the change */ + @JsonProperty("allowAllPermissionMode") PermissionAllowAllMode allowAllPermissionMode ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java index cf9f4706d..9eaef5dc7 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionPlanChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.plan_changed". Plan file operation details indicating what changed - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java index adcc3aeb7..79f2ab7e0 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionRemoteSteerableChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.remote_steerable_changed". Notifies that the session's remote steering capability has changed - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java new file mode 100644 index 000000000..a3f39d769 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java @@ -0,0 +1,68 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Session event "session.resume". Session resume metadata including current context and event count + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionResumeEvent extends SessionEvent { + + @Override + public String getType() { return "session.resume"; } + + @JsonProperty("data") + private SessionResumeEventData data; + + public SessionResumeEventData getData() { return data; } + public void setData(SessionResumeEventData data) { this.data = data; } + + /** Data payload for {@link SessionResumeEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionResumeEventData( + /** ISO 8601 timestamp when the session was resumed */ + @JsonProperty("resumeTime") OffsetDateTime resumeTime, + /** Total number of persisted events in the session at the time of resume */ + @JsonProperty("eventCount") Long eventCount, + /** On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd */ + @JsonProperty("eventsFileSizeBytes") Long eventsFileSizeBytes, + /** Model currently selected at resume time */ + @JsonProperty("selectedModel") String selectedModel, + /** Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed") */ + @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, + /** Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Context tier currently selected at resume time; null when no tier is active */ + @JsonProperty("contextTier") ContextTier contextTier, + /** Session limits currently configured at resume time; null when no limits are active */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits, + /** Updated working directory and git context at resume time */ + @JsonProperty("context") WorkingDirectoryContext context, + /** Whether the session was already in use by another client at resume time */ + @JsonProperty("alreadyInUse") Boolean alreadyInUse, + /** True when this resume passively joined a session that already had live work running in the runtime - an agent turn, a native queue run, a queued resume continuation, or an in-flight send (for example, an extension joining a session another client was actively driving). False (or omitted) when the session had no live work or when the resume explicitly abandoned pending work, including cold resumes and suspended sessions that remain resident in memory. */ + @JsonProperty("sessionWasActive") Boolean sessionWasActive, + /** Whether this session supports remote steering via GitHub */ + @JsonProperty("remoteSteerable") Boolean remoteSteerable, + /** 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 or omitted, pending work is normally marked as interrupted unless the resume passively joined live work owned by another client; sessionWasActive distinguishes that case. */ + @JsonProperty("continuePendingWork") Boolean continuePendingWork + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java index 51aba5d4c..f89ac0ea8 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCancelledEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.schedule_cancelled". Scheduled prompt cancelled from the schedule manager dialog - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java new file mode 100644 index 000000000..cc0b3b165 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java @@ -0,0 +1,59 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.schedule_created". Scheduled prompt registered via /every or /after + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionScheduleCreatedEvent extends SessionEvent { + + @Override + public String getType() { return "session.schedule_created"; } + + @JsonProperty("data") + private SessionScheduleCreatedEventData data; + + public SessionScheduleCreatedEventData getData() { return data; } + public void setData(SessionScheduleCreatedEventData data) { this.data = data; } + + /** Data payload for {@link SessionScheduleCreatedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionScheduleCreatedEventData( + /** Sequential id assigned to the scheduled prompt within the session */ + @JsonProperty("id") Long id, + /** Interval between ticks in milliseconds (relative-interval schedules) */ + @JsonProperty("intervalMs") Long intervalMs, + /** 5-field cron expression for a recurring calendar schedule, evaluated in `tz` */ + @JsonProperty("cron") String cron, + /** IANA timezone the `cron` expression is evaluated in */ + @JsonProperty("tz") String tz, + /** Absolute fire time (epoch milliseconds) for a one-shot calendar schedule */ + @JsonProperty("at") Long at, + /** Prompt text that gets enqueued on every tick */ + @JsonProperty("prompt") String prompt, + /** Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`) */ + @JsonProperty("recurring") Boolean recurring, + /** True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled rather than auto-computed. */ + @JsonProperty("selfPaced") Boolean selfPaced, + /** Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion) */ + @JsonProperty("displayPrompt") String displayPrompt, + /** Who created the schedule (`user` or `model`). Persisted so a resumed session keeps gating non-user schedules from firing skills that opted out of model invocation. Absent on entries created before this field existed; a missing origin fails closed (treated the same as a non-user origin), so such a schedule may not resolve a `disable-model-invocation` skill. */ + @JsonProperty("origin") ScheduleOrigin origin + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java new file mode 100644 index 000000000..271edd7ae --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionScheduleRearmedEvent.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.schedule_rearmed". Self-paced schedule re-armed for its next run + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionScheduleRearmedEvent extends SessionEvent { + + @Override + public String getType() { return "session.schedule_rearmed"; } + + @JsonProperty("data") + private SessionScheduleRearmedEventData data; + + public SessionScheduleRearmedEventData getData() { return data; } + public void setData(SessionScheduleRearmedEventData data) { this.data = data; } + + /** Data payload for {@link SessionScheduleRearmedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionScheduleRearmedEventData( + /** Id of the self-paced schedule that was re-armed */ + @JsonProperty("id") Long id, + /** Absolute time (epoch milliseconds) the model armed the next run to fire */ + @JsonProperty("nextRunAt") Long nextRunAt + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java new file mode 100644 index 000000000..1612aa74f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSessionLimitsChangedEvent.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.session_limits_changed". Session limits update details. Null clears the limits. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionSessionLimitsChangedEvent extends SessionEvent { + + @Override + public String getType() { return "session.session_limits_changed"; } + + @JsonProperty("data") + private SessionSessionLimitsChangedEventData data; + + public SessionSessionLimitsChangedEventData getData() { return data; } + public void setData(SessionSessionLimitsChangedEventData data) { this.data = data; } + + /** Data payload for {@link SessionSessionLimitsChangedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionSessionLimitsChangedEventData( + /** Current session limits, or null when no limits are active */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java index 03ad8e027..84c302306 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionShutdownEvent.java @@ -15,7 +15,6 @@ /** * Session event "session.shutdown". Session termination metrics including usage statistics, code changes, and shutdown reason - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -50,6 +49,8 @@ public record SessionShutdownEventData( @JsonProperty("totalApiDurationMs") Long totalApiDurationMs, /** Unix timestamp (milliseconds) when the session started */ @JsonProperty("sessionStartTime") Long sessionStartTime, + /** On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd */ + @JsonProperty("eventsFileSizeBytes") Long eventsFileSizeBytes, /** Aggregate code change metrics for the session */ @JsonProperty("codeChanges") ShutdownCodeChanges codeChanges, /** Per-model usage breakdown, keyed by model identifier */ diff --git a/java/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java index f04118435..efe356670 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSkillsLoadedEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.skills_loaded". - * + * Session event "session.skills_loaded". Payload of `session.skills_loaded` listing resolved skill metadata. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java index 9c7e8765b..0eb678adb 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionSnapshotRewindEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.snapshot_rewind". Session rewind details including target event and count of removed events - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionStartEvent.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/SessionStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionStartEvent.java index 0bb4b800f..bf8b4e91c 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionStartEvent.java @@ -15,7 +15,6 @@ /** * Session event "session.start". Session initialization metadata including context and configuration - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -52,8 +51,16 @@ public record SessionStartEventData( @JsonProperty("reasoningEffort") String reasoningEffort, /** Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed") */ @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, + /** Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Context tier selected at session creation time for models with tiered context pricing; null when no tier is selected (e.g., non-tiered model) */ + @JsonProperty("contextTier") ContextTier contextTier, + /** Session limits configured at session creation time, if any */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits, /** Working directory and git context at session start */ @JsonProperty("context") WorkingDirectoryContext context, + /** Per-session GitHub MCP override persisted for cold resume */ + @JsonProperty("githubMcpToolConfig") GitHubMcpToolConfig gitHubMcpToolConfig, /** Whether the session was already in use by another client at start time */ @JsonProperty("alreadyInUse") Boolean alreadyInUse, /** Whether this session supports remote steering via GitHub */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java new file mode 100644 index 000000000..c44c682b1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.task_complete". Task completion notification with summary from the agent + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionTaskCompleteEvent extends SessionEvent { + + @Override + public String getType() { return "session.task_complete"; } + + @JsonProperty("data") + private SessionTaskCompleteEventData data; + + public SessionTaskCompleteEventData getData() { return data; } + public void setData(SessionTaskCompleteEventData data) { this.data = data; } + + /** Data payload for {@link SessionTaskCompleteEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionTaskCompleteEventData( + /** Summary of the completed task, provided by the agent */ + @JsonProperty("summary") String summary, + /** Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer */ + @JsonProperty("success") Boolean success, + /** Semantic completion decision. Absent on legacy events and invalid tool calls */ + @JsonProperty("outcome") TaskCompletionOutcome outcome, + /** Label-safe runtime rationale for the completion decision (e.g. a cancellation or pause/resume downgrade), when one applies. Reviewer-authored rationale is intentionally omitted here because this event has no IFC label channel; the reviewer's findings remain available through its own labeled sub-agent events */ + @JsonProperty("reason") String reason, + /** Active autopilot objective ID evaluated by the completion reviewer */ + @JsonProperty("objectiveId") Long objectiveId + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java index e835e8ae5..77224380b 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTitleChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.title_changed". Session title change payload containing the new display title - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java new file mode 100644 index 000000000..28432ddf8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTodosChangedEvent.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Session event "session.todos_changed". Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionTodosChangedEvent extends SessionEvent { + + @Override + public String getType() { return "session.todos_changed"; } + + @JsonProperty("data") + private SessionTodosChangedEventData data; + + public SessionTodosChangedEventData getData() { return data; } + public void setData(SessionTodosChangedEventData data) { this.data = data; } + + /** Data payload for {@link SessionTodosChangedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionTodosChangedEventData() { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java index 1d80e5b60..f69954ee5 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionToolsUpdatedEvent.java @@ -13,8 +13,7 @@ import javax.annotation.processing.Generated; /** - * Session event "session.tools_updated". - * + * Session event "session.tools_updated". Payload of `session.tools_updated` identifying the model whose resolved tools were updated. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java index 0a96601b6..03826b403 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionTruncationEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.truncation". Conversation truncation statistics including token counts and removed content metrics - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java new file mode 100644 index 000000000..1a400c013 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageCheckpointEvent.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Session event "session.usage_checkpoint". Durable session usage checkpoint for reconstructing aggregate accounting on resume + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionUsageCheckpointEvent extends SessionEvent { + + @Override + public String getType() { return "session.usage_checkpoint"; } + + @JsonProperty("data") + private SessionUsageCheckpointEventData data; + + public SessionUsageCheckpointEventData getData() { return data; } + public void setData(SessionUsageCheckpointEventData data) { this.data = data; } + + /** Data payload for {@link SessionUsageCheckpointEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionUsageCheckpointEventData( + /** Session-wide accumulated nano-AI units cost at checkpoint time */ + @JsonProperty("totalNanoAiu") Double totalNanoAiu, + /** Total number of premium API requests used at checkpoint time */ + @JsonProperty("totalPremiumRequests") Double totalPremiumRequests, + /** Internal per-model prompt-cache state used to restore expiration tracking on resume */ + @JsonProperty("modelCacheState") List modelCacheState + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java index 70ecfe01a..8125e0665 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionUsageInfoEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.usage_info". Current context window usage statistics including token and message counts - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java index 42b2eb8df..a253f246e 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionWarningEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.warning". Warning message for timeline display with categorization - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java index 85447d567..166236f20 100644 --- a/java/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SessionWorkspaceFileChangedEvent.java @@ -14,7 +14,6 @@ /** * Session event "session.workspace_file_changed". Workspace file change details including path and operation type - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownCodeChanges.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownCodeChanges.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ShutdownCodeChanges.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownCodeChanges.java diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java index b7eb37fd9..1ba45d90b 100644 --- a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetric.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ShutdownModelMetric` type. + * Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricRequests.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricRequests.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricRequests.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricRequests.java diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java index fe18de6c6..cd0e67d70 100644 --- a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricTokenDetail.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ShutdownModelMetricTokenDetail` type. + * A token-type entry in a shutdown model metric, storing the accumulated token count. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricUsage.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricUsage.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ShutdownModelMetricUsage.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownModelMetricUsage.java diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java index 75db095c5..dfc986e83 100644 --- a/java/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownTokenDetail.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ShutdownTokenDetail` type. + * A session-wide shutdown token-type entry storing the accumulated token count. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ShutdownType.java b/java/sdk/src/generated/java/com/github/copilot/generated/ShutdownType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ShutdownType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ShutdownType.java diff --git a/java/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java index 681ad3f0a..6ad04f969 100644 --- a/java/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SkillInvokedEvent.java @@ -15,7 +15,6 @@ /** * Session event "skill.invoked". Skill invocation details including content, allowed tools, and plugin metadata - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -38,13 +37,15 @@ public final class SkillInvokedEvent extends SessionEvent { public record SkillInvokedEventData( /** Name of the invoked skill */ @JsonProperty("name") String name, + /** Model identifier active when the skill was invoked, when known */ + @JsonProperty("model") String model, /** File path to the SKILL.md definition */ @JsonProperty("path") String path, /** Full content of the skill file, injected into the conversation for the model */ @JsonProperty("content") String content, /** Tool names that should be auto-approved when this skill is active */ @JsonProperty("allowedTools") List allowedTools, - /** Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) */ + /** Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) */ @JsonProperty("source") String source, /** Name of the plugin this skill originated from, when applicable */ @JsonProperty("pluginName") String pluginName, diff --git a/java/src/generated/java/com/github/copilot/generated/SkillInvokedTrigger.java b/java/sdk/src/generated/java/com/github/copilot/generated/SkillInvokedTrigger.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SkillInvokedTrigger.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SkillInvokedTrigger.java diff --git a/java/src/generated/java/com/github/copilot/generated/SkillSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/SkillSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SkillSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SkillSource.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java b/java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java new file mode 100644 index 000000000..932d9affe --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillsLoadedSkill( + /** Unique identifier for the skill */ + @JsonProperty("name") String name, + /** Canonical slash command name used to invoke the skill, without the leading '/' */ + @JsonProperty("commandName") String commandName, + /** Description of what the skill does */ + @JsonProperty("description") String description, + /** Source location type (e.g., project, personal-copilot, plugin, builtin) */ + @JsonProperty("source") SkillSource source, + /** Whether the skill can be invoked by the user as a slash command */ + @JsonProperty("userInvocable") Boolean userInvocable, + /** Whether the skill is currently enabled */ + @JsonProperty("enabled") Boolean enabled, + /** Absolute path to the skill file, if available */ + @JsonProperty("path") String path, + /** Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field */ + @JsonProperty("argumentHint") String argumentHint +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java similarity index 85% rename from java/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java index 98924809f..f7300ddbf 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "subagent.completed". Sub-agent completion details for successful execution - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -48,7 +47,9 @@ public record SubagentCompletedEventData( /** Total tokens (input + output) consumed by the sub-agent */ @JsonProperty("totalTokens") Long totalTokens, /** Wall-clock duration of the sub-agent execution in milliseconds */ - @JsonProperty("durationMs") Long durationMs + @JsonProperty("durationMs") Long durationMs, + /** Whether the sub-agent was torn down by cancellation - its own abort, or an ancestor being killed - instead of finishing its work. Cancellation is not a failure, so the run still reports completion; this distinguishes a torn-down sub-agent from one that ran to the end. */ + @JsonProperty("cancelled") Boolean cancelled ) { } } diff --git a/java/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java index 2274ba66e..32e50eeed 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentDeselectedEvent.java @@ -14,7 +14,6 @@ /** * Session event "subagent.deselected". Empty payload; the event signals that the custom agent was deselected, returning to the default agent - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java index 9264b5b0e..6a48544ce 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentFailedEvent.java @@ -14,7 +14,6 @@ /** * Session event "subagent.failed". Sub-agent failure details including error message and agent information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -43,7 +42,7 @@ public record SubagentFailedEventData( @JsonProperty("agentDisplayName") String agentDisplayName, /** Error message describing why the sub-agent failed */ @JsonProperty("error") String error, - /** Model used by the sub-agent (if any model calls succeeded before failure) */ + /** Model selected for the sub-agent, when known */ @JsonProperty("model") String model, /** Total number of tool calls made before the sub-agent failed */ @JsonProperty("totalToolCalls") Long totalToolCalls, diff --git a/java/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java index 7eb82019b..6d0d88d24 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentSelectedEvent.java @@ -15,7 +15,6 @@ /** * Session event "subagent.selected". Custom agent selection details including name and available tools - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java index 647bc824d..fb94f97cf 100644 --- a/java/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SubagentStartedEvent.java @@ -14,7 +14,6 @@ /** * Session event "subagent.started". Sub-agent startup details including parent tool call and agent information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -43,7 +42,7 @@ public record SubagentStartedEventData( @JsonProperty("agentDisplayName") String agentDisplayName, /** Description of what the sub-agent does */ @JsonProperty("agentDescription") String agentDescription, - /** Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck). */ + /** Model the sub-agent will run with, when known at start. */ @JsonProperty("model") String model ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java index 09d39a199..315e9e8bb 100644 --- a/java/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageEvent.java @@ -14,7 +14,6 @@ /** * Session event "system.message". System/developer instruction content with role and optional template metadata - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -37,6 +36,8 @@ public final class SystemMessageEvent extends SessionEvent { public record SystemMessageEventData( /** The system or developer prompt text sent as model input */ @JsonProperty("content") String content, + /** Logical interaction identifier for the model run receiving this prompt */ + @JsonProperty("interactionId") String interactionId, /** Message role: "system" for system prompts, "developer" for developer-injected instructions */ @JsonProperty("role") SystemMessageRole role, /** Optional name identifier for the message source */ diff --git a/java/src/generated/java/com/github/copilot/generated/SystemMessageMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageMetadata.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SystemMessageMetadata.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageMetadata.java diff --git a/java/src/generated/java/com/github/copilot/generated/SystemMessageRole.java b/java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageRole.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/SystemMessageRole.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SystemMessageRole.java diff --git a/java/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java index 5a8a0fdfb..784a3a8bc 100644 --- a/java/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/SystemNotificationEvent.java @@ -14,7 +14,6 @@ /** * Session event "system.notification". System-generated notification for runtime events like background task completion - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/TaskCompletionOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/TaskCompletionOutcome.java new file mode 100644 index 000000000..827cf2b77 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/TaskCompletionOutcome.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Semantic result of evaluating a task completion request + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum TaskCompletionOutcome { + /** The {@code completed} variant. */ + COMPLETED("completed"), + /** The {@code continue} variant. */ + CONTINUE("continue"), + /** The {@code blocked} variant. */ + BLOCKED("blocked"); + + private final String value; + TaskCompletionOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static TaskCompletionOutcome fromValue(String value) { + for (TaskCompletionOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown TaskCompletionOutcome value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteError.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteError.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java index 3cfa45189..a265b5305 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteEvent.java @@ -15,7 +15,6 @@ /** * Session event "tool.execution_complete". Tool execution completion results including success status, detailed output, and error information - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -42,8 +41,11 @@ public record ToolExecutionCompleteEventData( @JsonProperty("success") Boolean success, /** Model identifier that generated this tool call */ @JsonProperty("model") String model, + /** FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels). Persisted as `{ ifc: ... }` so the label survives session resume, including model-visible failure results. Experimental. */ + @JsonProperty("mcpMeta") Object mcpMeta, /** CAPI interaction ID for correlating this tool execution with upstream telemetry */ @JsonProperty("interactionId") String interactionId, + @JsonProperty("rte") Boolean rte, /** Whether this tool call was explicitly requested by the user rather than the assistant */ @JsonProperty("isUserRequested") Boolean isUserRequested, /** Tool execution result on success */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java new file mode 100644 index 000000000..f7f08d93c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Tool execution result on success + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionCompleteResult( + /** Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency */ + @JsonProperty("content") String content, + /** Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent. */ + @JsonProperty("detailedContent") String detailedContent, + /** Structured content blocks (text, images, audio, resources) returned by the tool in their native format */ + @JsonProperty("contents") List contents, + /** Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call */ + @JsonProperty("binaryResultsForLlm") List binaryResultsForLlm, + /** MCP Apps UI resource content for rendering in a sandboxed iframe */ + @JsonProperty("uiResource") ToolExecutionCompleteUIResource uiResource, + /** Structured content (arbitrary JSON) returned verbatim by the MCP tool */ + @JsonProperty("structuredContent") Object structuredContent, + /** Provider-neutral source material this tool makes available to the model as citable content. Persisted so it survives session resume. Experimental. */ + @JsonProperty("citableSources") List citableSources, + /** FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels) — persisted as `{ ifc: ... }` (only the `ifc` key, not the whole `_meta`). Persisted so the FIDES IFC label survives session resume: the engine rehydrates accumulated taint by replaying these on load. Populated for ingress sources when FIDES IFC is on. Experimental. */ + @JsonProperty("mcpMeta") Object mcpMeta +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescription.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescription.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescription.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescription.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java index 563358cfa..f9af397a7 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMeta.java @@ -21,7 +21,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record ToolExecutionCompleteToolDescriptionMeta( - /** Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. */ + /** MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. */ @JsonProperty("ui") ToolExecutionCompleteToolDescriptionMetaUI ui ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java index 9acf435bc..1cbe17d49 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUI.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. + * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUIVisibility.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUIVisibility.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUIVisibility.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteToolDescriptionMetaUIVisibility.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResource.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResource.java diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java index 6375222cc..897f0ff39 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMeta.java @@ -21,7 +21,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record ToolExecutionCompleteUIResourceMeta( - /** Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. */ + /** MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. */ @JsonProperty("ui") ToolExecutionCompleteUIResourceMetaUI ui ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java new file mode 100644 index 000000000..6679b85ae --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionCompleteUIResourceMetaUI( + /** CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. */ + @JsonProperty("csp") ToolExecutionCompleteUIResourceMetaUICsp csp, + /** Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. */ + @JsonProperty("permissions") ToolExecutionCompleteUIResourceMetaUIPermissions permissions, + @JsonProperty("domain") String domain, + @JsonProperty("prefersBorder") Boolean prefersBorder +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java index 0ccb8a3db..41e799cf0 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUICsp.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. + * CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java new file mode 100644 index 000000000..d9adf5579 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionCompleteUIResourceMetaUIPermissions( + /** Marker object for camera permission on an MCP Apps UI resource. */ + @JsonProperty("camera") ToolExecutionCompleteUIResourceMetaUIPermissionsCamera camera, + /** Marker object for microphone permission on an MCP Apps UI resource. */ + @JsonProperty("microphone") ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone microphone, + /** Marker object for geolocation permission on an MCP Apps UI resource. */ + @JsonProperty("geolocation") ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation geolocation, + /** Marker object for clipboard-write permission on an MCP Apps UI resource. */ + @JsonProperty("clipboardWrite") ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite clipboardWrite +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java index 300967e8c..9a0235535 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsCamera.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. + * Marker object for camera permission on an MCP Apps UI resource. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java index 485a6946c..0c4e8dad1 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. + * Marker object for clipboard-write permission on an MCP Apps UI resource. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java index 30ed9bb54..d68147473 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. + * Marker object for geolocation permission on an MCP Apps UI resource. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java index 1748ccb48..4caa88ede 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. + * Marker object for microphone permission on an MCP Apps UI resource. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java index 9c43aa2ec..e78d4d2a7 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionPartialResultEvent.java @@ -14,7 +14,6 @@ /** * Session event "tool.execution_partial_result". Streaming tool execution output for incremental result display - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java index f3a7c1158..51be39519 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionProgressEvent.java @@ -14,7 +14,6 @@ /** * Session event "tool.execution_progress". Tool execution progress notification with status message - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java index 7a46ea88c..782e93931 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartEvent.java @@ -14,7 +14,6 @@ /** * Session event "tool.execution_start". Tool execution startup details including MCP server information when applicable - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -41,6 +40,11 @@ public record ToolExecutionStartEventData( @JsonProperty("toolName") String toolName, /** Arguments passed to the tool */ @JsonProperty("arguments") Object arguments, + /** Shell-tool path hints derived from the command at start time for shell tools (bash/powershell/local_shell). Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. Absent for non-shell tools. */ + @JsonProperty("shellToolInfo") ToolExecutionStartShellToolInfo shellToolInfo, + /** Model identifier that generated this tool call */ + @JsonProperty("model") String model, + @JsonProperty("rte") Boolean rte, /** Name of the MCP server hosting this tool, when the tool is an MCP tool */ @JsonProperty("mcpServerName") String mcpServerName, /** Original tool name on the MCP server, when the tool is an MCP tool */ @@ -49,6 +53,8 @@ public record ToolExecutionStartEventData( @JsonProperty("turnId") String turnId, /** When true, the tool output should be displayed expanded (verbatim) in the CLI timeline */ @JsonProperty("displayVerbatim") Boolean displayVerbatim, + /** Tool definition metadata, present for MCP tools with MCP Apps support */ + @JsonProperty("toolDescription") ToolExecutionStartToolDescription toolDescription, /** Tool call ID of the parent tool invocation when this event originates from a sub-agent */ @JsonProperty("parentToolCallId") String parentToolCallId ) { diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java new file mode 100644 index 000000000..967dab4c3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartShellToolInfo.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionStartShellToolInfo( + /** File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. */ + @JsonProperty("possiblePaths") List possiblePaths, + /** Whether the command includes a file write redirection (e.g., > or >>). */ + @JsonProperty("hasWriteFileRedirection") Boolean hasWriteFileRedirection, + /** The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand. */ + @JsonProperty("displayCommand") String displayCommand +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java new file mode 100644 index 000000000..4c12ca981 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescription.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Tool definition metadata, present for MCP tools with MCP Apps support + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionStartToolDescription( + /** Tool name */ + @JsonProperty("name") String name, + /** Tool description */ + @JsonProperty("description") String description, + /** MCP Apps metadata for UI resource association */ + @JsonProperty("_meta") ToolExecutionStartToolDescriptionMeta meta +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java new file mode 100644 index 000000000..e93bf998a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMeta.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP Apps metadata for UI resource association + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionStartToolDescriptionMeta( + /** MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. */ + @JsonProperty("ui") ToolExecutionStartToolDescriptionMetaUI ui +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java new file mode 100644 index 000000000..954edf210 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUI.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ToolExecutionStartToolDescriptionMetaUI( + /** URI of the UI resource */ + @JsonProperty("resourceUri") String resourceUri, + /** Who can access this tool */ + @JsonProperty("visibility") List visibility +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java new file mode 100644 index 000000000..078d1d89f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolExecutionStartToolDescriptionMetaUIVisibility.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ToolExecutionStartToolDescriptionMetaUIVisibility { + /** The {@code model} variant. */ + MODEL("model"), + /** The {@code app} variant. */ + APP("app"); + + private final String value; + ToolExecutionStartToolDescriptionMetaUIVisibility(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ToolExecutionStartToolDescriptionMetaUIVisibility fromValue(String value) { + for (ToolExecutionStartToolDescriptionMetaUIVisibility v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ToolExecutionStartToolDescriptionMetaUIVisibility value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java new file mode 100644 index 000000000..9dfca4a95 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolSearchActivatedEvent.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Session event "tool_search.activated". Persisted generic client-side tool activations restored when a session resumes. + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ToolSearchActivatedEvent extends SessionEvent { + + @Override + public String getType() { return "tool_search.activated"; } + + @JsonProperty("data") + private ToolSearchActivatedEventData data; + + public ToolSearchActivatedEventData getData() { return data; } + public void setData(ToolSearchActivatedEventData data) { this.data = data; } + + /** Data payload for {@link ToolSearchActivatedEvent}. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record ToolSearchActivatedEventData( + /** Tool-search strategy that activated the definitions. */ + @JsonProperty("strategy") String strategy, + /** Names of tool definitions activated by this search invocation. */ + @JsonProperty("toolNames") List toolNames + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java index 1b4d519a9..76aac12e8 100644 --- a/java/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/ToolUserRequestedEvent.java @@ -14,7 +14,6 @@ /** * Session event "tool.user_requested". User-initiated tool invocation request with tool name and arguments - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/UnknownSessionEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/UnknownSessionEvent.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/UnknownSessionEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UnknownSessionEvent.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java b/java/sdk/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java new file mode 100644 index 000000000..802ac5cef --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UsageCheckpointModelCacheState.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Internal prompt-cache expiration state for one model + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UsageCheckpointModelCacheState( + /** Model identifier associated with this cache state */ + @JsonProperty("modelId") String modelId, + /** Latest known prompt-cache expiration */ + @JsonProperty("cacheExpiresAt") OffsetDateTime cacheExpiresAt, + /** Retained cache lifetime in seconds, used to refresh expiration after a cache read */ + @JsonProperty("cacheTtlSeconds") Long cacheTtlSeconds +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java index 7750c9e70..c5e1c81fe 100644 --- a/java/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UserInputCompletedEvent.java @@ -14,7 +14,6 @@ /** * Session event "user_input.completed". User input request completion with the user's response - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java similarity index 99% rename from java/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java index e7ddb2859..dcba33f61 100644 --- a/java/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UserInputRequestedEvent.java @@ -15,7 +15,6 @@ /** * Session event "user_input.requested". User input request notification with question and optional predefined choices - * * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/UserMessageAgentMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageAgentMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/UserMessageAgentMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UserMessageAgentMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java new file mode 100644 index 000000000..ab64a8859 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageDelivery.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum UserMessageDelivery { + /** The {@code idle} variant. */ + IDLE("idle"), + /** The {@code steering} variant. */ + STEERING("steering"), + /** The {@code queued} variant. */ + QUEUED("queued"); + + private final String value; + UserMessageDelivery(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static UserMessageDelivery fromValue(String value) { + for (UserMessageDelivery v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown UserMessageDelivery value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/UserMessageEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageEvent.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/UserMessageEvent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/UserMessageEvent.java index 3e8e7520f..bc579968b 100644 --- a/java/src/generated/java/com/github/copilot/generated/UserMessageEvent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/UserMessageEvent.java @@ -14,8 +14,7 @@ import javax.annotation.processing.Generated; /** - * Session event "user.message". - * + * Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. * @since 1.0.0 */ @JsonIgnoreProperties(ignoreUnknown = true) @@ -46,8 +45,10 @@ public record UserMessageEventData( @JsonProperty("supportedNativeDocumentMimeTypes") List supportedNativeDocumentMimeTypes, /** Path-backed native document attachments that stayed on the tagged_files path flow because native upload could not read them or would exceed the request size limit */ @JsonProperty("nativeDocumentPathFallbackPaths") List nativeDocumentPathFallbackPaths, - /** Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user) */ + /** Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-` for an inter-agent prompt) */ @JsonProperty("source") String source, + /** How this message was delivered to the agentic loop relative to loop state (idle-start vs. steering/queued while busy). The timing axis; combine with `source` (origin) for the full picture. Used for telemetry attribution. */ + @JsonProperty("delivery") UserMessageDelivery delivery, /** The agent mode that was active when this message was sent */ @JsonProperty("agentMode") UserMessageAgentMode agentMode, /** True when this user message was auto-injected by autopilot's continuation loop rather than typed by the user; used to distinguish autopilot-driven turns in telemetry. */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/Verbosity.java b/java/sdk/src/generated/java/com/github/copilot/generated/Verbosity.java new file mode 100644 index 000000000..9db84f185 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/Verbosity.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +package com.github.copilot.generated; + +import javax.annotation.processing.Generated; + +/** + * Output verbosity level used for supported model calls (e.g. "low", "medium", "high") + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum Verbosity { + /** The {@code low} variant. */ + LOW("low"), + /** The {@code medium} variant. */ + MEDIUM("medium"), + /** The {@code high} variant. */ + HIGH("high"); + + private final String value; + Verbosity(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static Verbosity fromValue(String value) { + for (Verbosity v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown Verbosity value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java index 813cd5e02..e22fc461d 100644 --- a/java/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/WorkingDirectoryContext.java @@ -36,6 +36,8 @@ public record WorkingDirectoryContext( /** Head commit of current git branch at session start time */ @JsonProperty("headCommit") String headCommit, /** Base commit of current git branch at session start time */ - @JsonProperty("baseCommit") String baseCommit + @JsonProperty("baseCommit") String baseCommit, + /** Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). */ + @JsonProperty("pendingGitContext") Boolean pendingGitContext ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/WorkingDirectoryContextHostType.java b/java/sdk/src/generated/java/com/github/copilot/generated/WorkingDirectoryContextHostType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/WorkingDirectoryContextHostType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/WorkingDirectoryContextHostType.java diff --git a/java/src/generated/java/com/github/copilot/generated/WorkspaceFileChangedOperation.java b/java/sdk/src/generated/java/com/github/copilot/generated/WorkspaceFileChangedOperation.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/WorkspaceFileChangedOperation.java rename to java/sdk/src/generated/java/com/github/copilot/generated/WorkspaceFileChangedOperation.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/package-info.java b/java/sdk/src/generated/java/com/github/copilot/generated/package-info.java new file mode 100644 index 000000000..f2bfcd269 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/package-info.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: session-events.schema.json + +/** + * Auto-generated session event types for the GitHub Copilot SDK. + * + *

+ * This package contains Java classes generated from the Copilot CLI's + * {@code session-events.schema.json}. Each event type corresponds to a + * notification emitted during a {@link com.github.copilot.CopilotSession} + * interaction. + * + *

Key Classes

+ *
    + *
  • {@link com.github.copilot.generated.SessionEvent} - Abstract sealed base + * class for all session events. Deserialized polymorphically via the + * {@code type} discriminator.
    • + *
  • {@link com.github.copilot.generated.UnknownSessionEvent} - Fallback for + * event types not yet known to this SDK version, preserving forward + * compatibility.
    • + *
+ * + *

Example Usage

+ * + * 
{@code
+ * session.on(AssistantMessageEvent.class, msg -> {
+ *     System.out.println(msg.getData().content());
+ * });
+ * }
+ * + *

Related Packages

+ *
    + *
  • {@link com.github.copilot} - Core SDK classes
    • + *
  • {@link com.github.copilot.generated.rpc} - Auto-generated RPC + * parameter and result types
    • + *
+ * + * @see com.github.copilot.CopilotSession + * @see com.github.copilot.generated.SessionEvent + */ +package com.github.copilot.generated; diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java new file mode 100644 index 000000000..8d26959e8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Finite reason code describing why the current turn was aborted + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AbortReason { + /** The {@code user_initiated} variant. */ + USER_INITIATED("user_initiated"), + /** The {@code remote_command} variant. */ + REMOTE_COMMAND("remote_command"), + /** The {@code user_abort} variant. */ + USER_ABORT("user_abort"), + /** The {@code autopilot_credit_limit} variant. */ + AUTOPILOT_CREDIT_LIMIT("autopilot_credit_limit"); + + private final String value; + AbortReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AbortReason fromValue(String value) { + for (AbortReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AbortReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java new file mode 100644 index 000000000..eecdad01e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountAllUsers.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountAllUsers( + /** Authentication information for this user */ + @JsonProperty("authInfo") Object authInfo, + /** Associated token, if available */ + @JsonProperty("token") String token +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java new file mode 100644 index 000000000..eb577fcc2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetCurrentAuthResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Current authentication state + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountGetCurrentAuthResult( + /** Current authentication information, if authenticated */ + @JsonProperty("authInfo") Object authInfo, + /** Authentication errors from the last auth attempt, if any */ + @JsonProperty("authErrors") List authErrors +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaParams.java new file mode 100644 index 000000000..cea523551 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code account.getQuota} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountGetQuotaParams( + /** GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. */ + @JsonProperty("gitHubToken") String gitHubToken +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java index 257a08756..6e5929dfd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountGetQuotaResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * Quota usage snapshots for the resolved user, keyed by quota type. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java new file mode 100644 index 000000000..bd8e69734 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Credentials to store after successful authentication + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountLoginParams( + /** GitHub host URL */ + @JsonProperty("host") String host, + /** User login/username */ + @JsonProperty("login") String login, + /** GitHub authentication token */ + @JsonProperty("token") String token +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java new file mode 100644 index 000000000..111983557 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLoginResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of a successful login; throws on failure + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountLoginResult( + /** Whether the credential was persisted to a secure store (system keychain, or the config file when plaintext storage is enabled). False when no secure store was available and the token was not saved, so the consumer can decide how to proceed. */ + @JsonProperty("storedInVault") Boolean storedInVault +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java new file mode 100644 index 000000000..b5e93e185 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * User to log out + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountLogoutParams( + /** Authentication information for the user to log out */ + @JsonProperty("authInfo") Object authInfo +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java new file mode 100644 index 000000000..296227e5b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountLogoutResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Logout result indicating if more users remain + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AccountLogoutResult( + /** Whether other authenticated users remain after logout */ + @JsonProperty("hasMoreUsers") Boolean hasMoreUsers +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java index 88e7ba9c6..fe4baf3fd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AccountQuotaSnapshot.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `AccountQuotaSnapshot` type. + * Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java new file mode 100644 index 000000000..6ec806fb1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AdaptiveThinkingSupport.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Resolved Anthropic adaptive-thinking capability for a model. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AdaptiveThinkingSupport { + /** The {@code unsupported} variant. */ + UNSUPPORTED("unsupported"), + /** The {@code optional} variant. */ + OPTIONAL("optional"), + /** The {@code required} variant. */ + REQUIRED("required"); + + private final String value; + AdaptiveThinkingSupport(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AdaptiveThinkingSupport fromValue(String value) { + for (AdaptiveThinkingSupport v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AdaptiveThinkingSupport value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java new file mode 100644 index 000000000..53d48904f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPath.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentDiscoveryPath( + /** Absolute path of the search/create directory (may not exist on disk yet) */ + @JsonProperty("path") String path, + /** Which tier this directory belongs to */ + @JsonProperty("scope") AgentDiscoveryPathScope scope, + /** Whether this is the canonical directory to create a new agent in its tier. At most one entry per tier is preferred. */ + @JsonProperty("preferredForCreation") Boolean preferredForCreation, + /** The input project path this directory was derived from (only for project scope) */ + @JsonProperty("projectPath") String projectPath +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java new file mode 100644 index 000000000..51615ec95 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentDiscoveryPathScope.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Which tier this directory belongs to + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentDiscoveryPathScope { + /** The {@code user} variant. */ + USER("user"), + /** The {@code project} variant. */ + PROJECT("project"); + + private final String value; + AgentDiscoveryPathScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentDiscoveryPathScope fromValue(String value) { + for (AgentDiscoveryPathScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentDiscoveryPathScope value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java new file mode 100644 index 000000000..f239c82e6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentInfo( + /** Name of the agent. Use `id` as the stable selection identifier. */ + @JsonProperty("name") String name, + /** Human-readable display name */ + @JsonProperty("displayName") String displayName, + /** Description of the agent's purpose */ + @JsonProperty("description") String description, + /** Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. */ + @JsonProperty("path") String path, + /** Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. */ + @JsonProperty("id") String id, + /** Where the agent definition was loaded from */ + @JsonProperty("source") AgentInfoSource source, + /** Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. */ + @JsonProperty("userInvocable") Boolean userInvocable, + /** Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. */ + @JsonProperty("tools") List tools, + /** Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference. */ + @JsonProperty("model") String model, + /** MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. */ + @JsonProperty("mcpServers") Map mcpServers, + /** Skill names preloaded into this agent's context. Omitted means none. */ + @JsonProperty("skills") List skills, + /** Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. */ + @JsonProperty("prompt") String prompt +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfoSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfoSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentInfoSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentInfoSource.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java new file mode 100644 index 000000000..3e44993b9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntry.java @@ -0,0 +1,61 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentRegistryLiveTargetEntry( + /** Registry entry schema version (1 = ui-server, 2 = managed-server) */ + @JsonProperty("schemaVersion") Long schemaVersion, + /** Process kind tag for the registry entry */ + @JsonProperty("kind") AgentRegistryLiveTargetEntryKind kind, + /** Operating-system pid of the process owning this entry */ + @JsonProperty("pid") Long pid, + /** Bind host for the entry's JSON-RPC server */ + @JsonProperty("host") String host, + /** TCP port the entry's JSON-RPC server is listening on */ + @JsonProperty("port") Long port, + /** Connection token (null when the target is unauthenticated) */ + @JsonProperty("token") String token, + /** Session ID of the foreground session for this entry */ + @JsonProperty("sessionId") String sessionId, + /** Friendly session name (when set) */ + @JsonProperty("sessionName") String sessionName, + /** Working directory of the session (when known) */ + @JsonProperty("cwd") String cwd, + /** Git branch of the session (when known) */ + @JsonProperty("branch") String branch, + /** Model identifier currently selected for the session */ + @JsonProperty("model") String model, + /** Coarse lifecycle status of the foreground session */ + @JsonProperty("status") AgentRegistryLiveTargetEntryStatus status, + /** Kind of attention required when status === "attention". Meaningful only when status === "attention". */ + @JsonProperty("attentionKind") AgentRegistryLiveTargetEntryAttentionKind attentionKind, + /** Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. */ + @JsonProperty("statusRevision") Long statusRevision, + /** How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. */ + @JsonProperty("lastTerminalEvent") AgentRegistryLiveTargetEntryLastTerminalEvent lastTerminalEvent, + /** ISO 8601 timestamp captured at registration */ + @JsonProperty("startedAt") String startedAt, + /** Copilot CLI version that wrote the entry */ + @JsonProperty("copilotVersion") String copilotVersion, + /** Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) */ + @JsonProperty("lastSeenMs") Long lastSeenMs +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java new file mode 100644 index 000000000..9ceb89521 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryAttentionKind.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Kind of attention required when status === "attention". Meaningful only when status === "attention". + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistryLiveTargetEntryAttentionKind { + /** The {@code error} variant. */ + ERROR("error"), + /** The {@code permission} variant. */ + PERMISSION("permission"), + /** The {@code exit_plan} variant. */ + EXIT_PLAN("exit_plan"), + /** The {@code elicitation} variant. */ + ELICITATION("elicitation"), + /** The {@code user_input} variant. */ + USER_INPUT("user_input"); + + private final String value; + AgentRegistryLiveTargetEntryAttentionKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistryLiveTargetEntryAttentionKind fromValue(String value) { + for (AgentRegistryLiveTargetEntryAttentionKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistryLiveTargetEntryAttentionKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java new file mode 100644 index 000000000..0c4f5eb2c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Process kind tag for the registry entry + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistryLiveTargetEntryKind { + /** The {@code ui-server} variant. */ + UI_SERVER("ui-server"), + /** The {@code managed-server} variant. */ + MANAGED_SERVER("managed-server"); + + private final String value; + AgentRegistryLiveTargetEntryKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistryLiveTargetEntryKind fromValue(String value) { + for (AgentRegistryLiveTargetEntryKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistryLiveTargetEntryKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java new file mode 100644 index 000000000..2da782aff --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryLastTerminalEvent.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistryLiveTargetEntryLastTerminalEvent { + /** The {@code turn_end} variant. */ + TURN_END("turn_end"), + /** The {@code abort} variant. */ + ABORT("abort"); + + private final String value; + AgentRegistryLiveTargetEntryLastTerminalEvent(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistryLiveTargetEntryLastTerminalEvent fromValue(String value) { + for (AgentRegistryLiveTargetEntryLastTerminalEvent v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistryLiveTargetEntryLastTerminalEvent value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java new file mode 100644 index 000000000..957d364b0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLiveTargetEntryStatus.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Coarse lifecycle status of the foreground session + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistryLiveTargetEntryStatus { + /** The {@code working} variant. */ + WORKING("working"), + /** The {@code waiting} variant. */ + WAITING("waiting"), + /** The {@code done} variant. */ + DONE("done"), + /** The {@code attention} variant. */ + ATTENTION("attention"); + + private final String value; + AgentRegistryLiveTargetEntryStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistryLiveTargetEntryStatus fromValue(String value) { + for (AgentRegistryLiveTargetEntryStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistryLiveTargetEntryStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java new file mode 100644 index 000000000..be5643cff --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCapture.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Per-spawn log-capture outcome; populated from spawnLiveTarget. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentRegistryLogCapture( + /** Whether per-spawn log capture is on (false when env-disabled or open failed) */ + @JsonProperty("enabled") Boolean enabled, + /** Absolute path to the per-spawn log file (only set when enabled) */ + @JsonProperty("path") String path, + /** Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used) */ + @JsonProperty("openError") String openError, + /** Categorized reason for log-open failure */ + @JsonProperty("openErrorReason") AgentRegistryLogCaptureOpenErrorReason openErrorReason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java new file mode 100644 index 000000000..a202129df --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistryLogCaptureOpenErrorReason.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Categorized reason for log-open failure + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistryLogCaptureOpenErrorReason { + /** The {@code permission} variant. */ + PERMISSION("permission"), + /** The {@code disk_full} variant. */ + DISK_FULL("disk_full"), + /** The {@code other} variant. */ + OTHER("other"); + + private final String value; + AgentRegistryLogCaptureOpenErrorReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistryLogCaptureOpenErrorReason fromValue(String value) { + for (AgentRegistryLogCaptureOpenErrorReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistryLogCaptureOpenErrorReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java new file mode 100644 index 000000000..60a82f6cd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnError.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * `child_process.spawn` itself failed before the child entered the registry. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AgentRegistrySpawnError extends AgentRegistrySpawnResult { + + @JsonProperty("kind") + private final String kind = "spawn-error"; + + @Override + public String getKind() { return kind; } + + /** Human-readable error message */ + @JsonProperty("message") + private String message; + + /** Underlying errno code (e.g. ENOENT, EACCES) when available */ + @JsonProperty("code") + private String code; + + public String getMessage() { return message; } + public void setMessage(String message) { this.message = message; } + + public String getCode() { return code; } + public void setCode(String code) { this.code = code; } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java index 964aaede6..eaa55f187 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Inputs to spawn a managed-server child via the controller's spawn delegate. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnPermissionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnPermissionMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnPermissionMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnPermissionMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java new file mode 100644 index 000000000..c8d6aa10d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnRegistryTimeout.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AgentRegistrySpawnRegistryTimeout extends AgentRegistrySpawnResult { + + @JsonProperty("kind") + private final String kind = "registry-timeout"; + + @Override + public String getKind() { return kind; } + + /** Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance) */ + @JsonProperty("childPid") + private Long childPid; + + /** Per-spawn log-capture outcome; populated from spawnLiveTarget. */ + @JsonProperty("logCapture") + private AgentRegistryLogCapture logCapture; + + public Long getChildPid() { return childPid; } + public void setChildPid(Long childPid) { this.childPid = childPid; } + + public AgentRegistryLogCapture getLogCapture() { return logCapture; } + public void setLogCapture(AgentRegistryLogCapture logCapture) { this.logCapture = logCapture; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java new file mode 100644 index 000000000..ddcd50ed1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Outcome of an agentRegistry.spawn call. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = AgentRegistrySpawnSpawned.class, name = "spawned"), + @JsonSubTypes.Type(value = AgentRegistrySpawnError.class, name = "spawn-error"), + @JsonSubTypes.Type(value = AgentRegistrySpawnRegistryTimeout.class, name = "registry-timeout"), + @JsonSubTypes.Type(value = AgentRegistrySpawnValidationError.class, name = "validation-error") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class AgentRegistrySpawnResult { + + /** + * Returns the discriminator value for this variant. + * + * @return the kind discriminator + */ + public abstract String getKind(); +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java new file mode 100644 index 000000000..388c473db --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnSpawned.java @@ -0,0 +1,58 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Managed-server child was spawned and registered successfully. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AgentRegistrySpawnSpawned extends AgentRegistrySpawnResult { + + @JsonProperty("kind") + private final String kind = "spawned"; + + @Override + public String getKind() { return kind; } + + /** Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). */ + @JsonProperty("entry") + private AgentRegistryLiveTargetEntry entry; + + /** Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path. */ + @JsonProperty("initialPromptSent") + private Boolean initialPromptSent; + + /** If the delegate attempted to send the initial prompt and failed, the categorized error message. */ + @JsonProperty("initialPromptError") + private String initialPromptError; + + /** Per-spawn log-capture outcome; populated from spawnLiveTarget. */ + @JsonProperty("logCapture") + private AgentRegistryLogCapture logCapture; + + public AgentRegistryLiveTargetEntry getEntry() { return entry; } + public void setEntry(AgentRegistryLiveTargetEntry entry) { this.entry = entry; } + + public Boolean getInitialPromptSent() { return initialPromptSent; } + public void setInitialPromptSent(Boolean initialPromptSent) { this.initialPromptSent = initialPromptSent; } + + public String getInitialPromptError() { return initialPromptError; } + public void setInitialPromptError(String initialPromptError) { this.initialPromptError = initialPromptError; } + + public AgentRegistryLogCapture getLogCapture() { return logCapture; } + public void setLogCapture(AgentRegistryLogCapture logCapture) { this.logCapture = logCapture; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java new file mode 100644 index 000000000..9cee6b5dd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationError.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Synchronous pre-validation rejected the spawn request. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class AgentRegistrySpawnValidationError extends AgentRegistrySpawnResult { + + @JsonProperty("kind") + private final String kind = "validation-error"; + + @Override + public String getKind() { return kind; } + + /** Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. */ + @JsonProperty("reason") + private AgentRegistrySpawnValidationErrorReason reason; + + /** Which parameter field was invalid. Omitted when the rejection is not field-specific. */ + @JsonProperty("field") + private AgentRegistrySpawnValidationErrorField field; + + /** Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. */ + @JsonProperty("message") + private String message; + + public AgentRegistrySpawnValidationErrorReason getReason() { return reason; } + public void setReason(AgentRegistrySpawnValidationErrorReason reason) { this.reason = reason; } + + public AgentRegistrySpawnValidationErrorField getField() { return field; } + public void setField(AgentRegistrySpawnValidationErrorField field) { this.field = field; } + + public String getMessage() { return message; } + public void setMessage(String message) { this.message = message; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java new file mode 100644 index 000000000..6cdcaa3cb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorField.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Which parameter field was invalid. Omitted when the rejection is not field-specific. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistrySpawnValidationErrorField { + /** The {@code cwd} variant. */ + CWD("cwd"), + /** The {@code name} variant. */ + NAME("name"), + /** The {@code agentName} variant. */ + AGENTNAME("agentName"), + /** The {@code model} variant. */ + MODEL("model"), + /** The {@code permissionMode} variant. */ + PERMISSIONMODE("permissionMode"); + + private final String value; + AgentRegistrySpawnValidationErrorField(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistrySpawnValidationErrorField fromValue(String value) { + for (AgentRegistrySpawnValidationErrorField v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistrySpawnValidationErrorField value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java new file mode 100644 index 000000000..15800abf8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentRegistrySpawnValidationErrorReason.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum AgentRegistrySpawnValidationErrorReason { + /** The {@code cwd-not-found} variant. */ + CWD_NOT_FOUND("cwd-not-found"), + /** The {@code cwd-not-directory} variant. */ + CWD_NOT_DIRECTORY("cwd-not-directory"), + /** The {@code invalid-name} variant. */ + INVALID_NAME("invalid-name"), + /** The {@code unknown-agent} variant. */ + UNKNOWN_AGENT("unknown-agent"), + /** The {@code unknown-model} variant. */ + UNKNOWN_MODEL("unknown-model"), + /** The {@code yolo-not-allowed} variant. */ + YOLO_NOT_ALLOWED("yolo-not-allowed"); + + private final String value; + AgentRegistrySpawnValidationErrorReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static AgentRegistrySpawnValidationErrorReason fromValue(String value) { + for (AgentRegistrySpawnValidationErrorReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown AgentRegistrySpawnValidationErrorReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java new file mode 100644 index 000000000..ff9790c27 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Optional project paths to include in agent discovery. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentsDiscoverParams( + /** Optional list of project directory paths to scan for project-scoped agents. When omitted or empty, only user/plugin/remote-independent agents are returned (no project scan). */ + @JsonProperty("projectPaths") List projectPaths, + /** When true, omit the host's agents (the user-level agent directory and all plugin agents), leaving only project and remote agents. For multitenant deployments. */ + @JsonProperty("excludeHostAgents") Boolean excludeHostAgents +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java new file mode 100644 index 000000000..50791127e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsDiscoverResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Agents discovered across user, project, plugin, and remote sources. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentsDiscoverResult( + /** All discovered agents across all sources */ + @JsonProperty("agents") List agents +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java new file mode 100644 index 000000000..b8420d1ad --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Optional project paths to include when enumerating agent discovery directories. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentsGetDiscoveryPathsParams( + /** Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. */ + @JsonProperty("projectPaths") List projectPaths, + /** When true, omit the host's user-level agent directory, leaving only project directories. For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). */ + @JsonProperty("excludeHostAgents") Boolean excludeHostAgents +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java new file mode 100644 index 000000000..cfb16c175 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AgentsGetDiscoveryPathsResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Canonical locations where custom agents can be created so the runtime will recognize them. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record AgentsGetDiscoveryPathsResult( + /** Canonical agent create/discovery directories, in priority order */ + @JsonProperty("paths") List paths +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AuthInfoType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthInfoType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/AuthInfoType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/AuthInfoType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltInModelCatalogEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltInModelCatalogEntry.java new file mode 100644 index 000000000..679278356 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/BuiltInModelCatalogEntry.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A well-known model in the runtime's built-in catalog. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record BuiltInModelCatalogEntry( + /** Well-known runtime model ID suitable for `ProviderConfig.modelId` or `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. */ + @JsonProperty("id") String id +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasAction.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java new file mode 100644 index 000000000..e4e6828ca --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasActionInvokeParams.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Canvas action invocation parameters sent to the provider. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CanvasActionInvokeParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Owning provider identifier */ + @JsonProperty("extensionId") String extensionId, + /** Provider-local canvas identifier */ + @JsonProperty("canvasId") String canvasId, + /** Canvas instance identifier */ + @JsonProperty("instanceId") String instanceId, + /** Action name to invoke */ + @JsonProperty("actionName") String actionName, + /** Action input */ + @JsonProperty("input") Object input, + /** Host context supplied by the runtime. */ + @JsonProperty("host") CanvasHostContext host, + /** Session context supplied by the runtime. */ + @JsonProperty("session") CanvasSessionContext session +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java index d692c07e7..13462b685 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasCloseParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Canvas close parameters sent to the provider. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContext.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContext.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContextCapabilities.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContextCapabilities.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContextCapabilities.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasHostContextCapabilities.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java index 95b0d8e64..defd29b8c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Canvas open parameters sent to the provider. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java index 9ce3aeede..829529c71 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasOpenResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Canvas open result returned by the provider. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasSessionContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasSessionContext.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/CanvasSessionContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/CanvasSessionContext.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java new file mode 100644 index 000000000..27fd29128 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CapiSessionOptions.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Options scoped to the built-in CAPI (Copilot API) provider. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CapiSessionOptions( + /** Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. */ + @JsonProperty("enableWebSocketResponses") Boolean enableWebSocketResponses +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java new file mode 100644 index 000000000..9873fa7ff --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CommandsListResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Slash commands available in the session, after applying any include/exclude filters. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CommandsListResult( + /** Commands available in this session */ + @JsonProperty("commands") List commands +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java new file mode 100644 index 000000000..19172cb1b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ConnectParams( + /** Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN */ + @JsonProperty("token") String token, + /** Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the runtime forwards every internal telemetry event it emits — across all sessions, plus sessionless events — to this connection over the `gitHubTelemetry.event` notification. Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); host-only compatibility events are forward-only and intentionally skip that path. Intended for first-party hosts that re-emit the events into their own telemetry stores. Both unrestricted and restricted events are forwarded, each tagged with a `restricted` discriminator; a backstop drops restricted events when restricted telemetry is disabled — using the process-global gate for ordinary events and an explicit session-scoped decision for host-only events. */ + @JsonProperty("enableGitHubTelemetryForwarding") Boolean enableGitHubTelemetryForwarding +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java index d24d120e1..8c12b57a8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Handshake result reporting the server's protocol version and package version on success. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadata.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadata.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadata.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataRepository.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataRepository.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ConnectedRemoteSessionMetadataRepository.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContentExclusionPathCheck.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContentExclusionPathCheck.java new file mode 100644 index 000000000..ba48326c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContentExclusionPathCheck.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Content-exclusion decision for one requested path. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ContentExclusionPathCheck( + /** The path supplied by the caller. */ + @JsonProperty("path") String path, + /** Whether the session's complete content-exclusion policy excludes the path. */ + @JsonProperty("excluded") Boolean excluded +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java new file mode 100644 index 000000000..818841a3c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextHeaviestMessage.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single large message currently in context. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ContextHeaviestMessage( + /** Stable identifier for this message within the snapshot. */ + @JsonProperty("id") String id, + /** Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. */ + @JsonProperty("label") String label, + /** Role of the chat message (`user`, `assistant`, or `tool`). */ + @JsonProperty("role") String role, + /** Token count currently in context for this individual message. */ + @JsonProperty("tokens") Long tokens +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java new file mode 100644 index 000000000..fc5e14dc6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ContextTier.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Context tier for models that support multiple context-window sizes. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ContextTier { + /** The {@code default} variant. */ + DEFAULT("default"), + /** The {@code long_context} variant. */ + LONG_CONTEXT("long_context"); + + private final String value; + ContextTier(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ContextTier fromValue(String value) { + for (ContextTier v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ContextTier value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java new file mode 100644 index 000000000..d198c2f94 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/CurrentToolMetadata.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Lightweight metadata for a currently initialized session tool + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record CurrentToolMetadata( + /** Model-facing tool name */ + @JsonProperty("name") String name, + /** Optional MCP/config namespaced tool name */ + @JsonProperty("namespacedName") String namespacedName, + /** MCP server name for MCP-backed tools */ + @JsonProperty("mcpServerName") String mcpServerName, + /** Raw MCP tool name for MCP-backed tools */ + @JsonProperty("mcpToolName") String mcpToolName, + /** Tool description */ + @JsonProperty("description") String description, + /** JSON Schema for tool input */ + @JsonProperty("input_schema") Map inputSchema, + /** Whether the tool is loaded on demand via tool search */ + @JsonProperty("deferLoading") Boolean deferLoading +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java new file mode 100644 index 000000000..9d8592220 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsCollectedEntry.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A file included in the redacted debug bundle. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DebugCollectLogsCollectedEntry( + /** Relative path of the file in the staged bundle/archive. */ + @JsonProperty("bundlePath") String bundlePath, + /** Source category for this entry. */ + @JsonProperty("source") DebugCollectLogsSource source, + /** Redacted output size in bytes. */ + @JsonProperty("sizeBytes") Long sizeBytes +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java new file mode 100644 index 000000000..285b1ef6e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntry.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A caller-provided server-local file or directory to include in the debug bundle. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DebugCollectLogsEntry( + /** Kind of source path to include. */ + @JsonProperty("kind") DebugCollectLogsEntryKind kind, + /** Server-local source path to read. */ + @JsonProperty("path") String path, + /** Relative path to use inside the staged bundle/archive. */ + @JsonProperty("bundlePath") String bundlePath, + /** How text content from this entry should be redacted. Defaults to plain-text. */ + @JsonProperty("redaction") DebugCollectLogsRedaction redaction, + /** When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. */ + @JsonProperty("required") Boolean required +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java new file mode 100644 index 000000000..316b6dcd5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsEntryKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Kind of caller-provided debug log entry. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DebugCollectLogsEntryKind { + /** The {@code file} variant. */ + FILE("file"), + /** The {@code directory} variant. */ + DIRECTORY("directory"); + + private final String value; + DebugCollectLogsEntryKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DebugCollectLogsEntryKind fromValue(String value) { + for (DebugCollectLogsEntryKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DebugCollectLogsEntryKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java new file mode 100644 index 000000000..0cab63830 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsInclude.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Built-in session diagnostics to include in the bundle. Omitted fields default to true. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DebugCollectLogsInclude( + /** Include the session event log (`events.jsonl`). Defaults to true. */ + @JsonProperty("events") Boolean events, + /** Include process logs for the session. Defaults to true. */ + @JsonProperty("processLogs") Boolean processLogs, + /** Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. */ + @JsonProperty("shellLogs") Boolean shellLogs, + /** Server-local path to the session's events.jsonl file. Internal callers normally omit this and let the runtime derive it from the session. */ + @JsonProperty("eventsPath") String eventsPath, + /** Server-local path to the current process log. When set, it is included as `process.log` and its directory is searched for prior logs from the same session. */ + @JsonProperty("currentProcessLogPath") String currentProcessLogPath, + /** Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions. */ + @JsonProperty("processLogDirectory") String processLogDirectory, + /** Maximum number of previous process logs to include. Defaults to 5. */ + @JsonProperty("previousProcessLogLimit") Long previousProcessLogLimit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java new file mode 100644 index 000000000..5f57e3737 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsRedaction.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * How a collected debug entry should be redacted before being staged. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DebugCollectLogsRedaction { + /** The {@code plain-text} variant. */ + PLAIN_TEXT("plain-text"), + /** The {@code events-jsonl} variant. */ + EVENTS_JSONL("events-jsonl"); + + private final String value; + DebugCollectLogsRedaction(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DebugCollectLogsRedaction fromValue(String value) { + for (DebugCollectLogsRedaction v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DebugCollectLogsRedaction value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java new file mode 100644 index 000000000..00986bd3f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsResultKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Destination kind that was written. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DebugCollectLogsResultKind { + /** The {@code archive} variant. */ + ARCHIVE("archive"), + /** The {@code directory} variant. */ + DIRECTORY("directory"); + + private final String value; + DebugCollectLogsResultKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DebugCollectLogsResultKind fromValue(String value) { + for (DebugCollectLogsResultKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DebugCollectLogsResultKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java new file mode 100644 index 000000000..a5a702bcd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSkippedEntry.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * An optional debug bundle entry that could not be included. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DebugCollectLogsSkippedEntry( + /** Relative path requested for this bundle entry. */ + @JsonProperty("bundlePath") String bundlePath, + /** Server-local source path that could not be read. */ + @JsonProperty("path") String path, + /** Reason the entry was skipped. */ + @JsonProperty("reason") String reason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java new file mode 100644 index 000000000..989059f45 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DebugCollectLogsSource.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Source category for a collected debug bundle entry. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DebugCollectLogsSource { + /** The {@code events} variant. */ + EVENTS("events"), + /** The {@code process-log} variant. */ + PROCESS_LOG("process-log"), + /** The {@code shell-log} variant. */ + SHELL_LOG("shell-log"), + /** The {@code additional} variant. */ + ADDITIONAL("additional"); + + private final String value; + DebugCollectLogsSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DebugCollectLogsSource fromValue(String value) { + for (DebugCollectLogsSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DebugCollectLogsSource value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DisableBypassPermissionsMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DisableBypassPermissionsMode.java new file mode 100644 index 000000000..1e6b1e7db --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DisableBypassPermissionsMode.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DisableBypassPermissionsMode { + /** The {@code disable} variant. */ + DISABLE("disable"); + + private final String value; + DisableBypassPermissionsMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DisableBypassPermissionsMode fromValue(String value) { + for (DisableBypassPermissionsMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DisableBypassPermissionsMode value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java index e6e02745c..0b0c51804 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredCanvas.java @@ -26,6 +26,8 @@ public record DiscoveredCanvas( @JsonProperty("displayName") String displayName, /** Short, single-sentence description shown to the agent in canvas catalogs. */ @JsonProperty("description") String description, + /** Host-local PNG path for the canvas icon, when supplied */ + @JsonProperty("icon") String icon, /** JSON Schema for canvas open input */ @JsonProperty("inputSchema") Object inputSchema, /** Actions the agent or host may invoke on an open instance */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtension.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtension.java new file mode 100644 index 000000000..7bb2531fe --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtension.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Discovered extension metadata and persistent enablement state. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DiscoveredExtension( + /** Source-qualified ID accepted by both server and session extension enablement methods */ + @JsonProperty("id") String id, + /** Human-readable extension name */ + @JsonProperty("name") String name, + /** Absolute path to the extension entry module, suitable for revealing it in a file manager */ + @JsonProperty("path") String path, + /** Discovery source */ + @JsonProperty("source") DiscoveredExtensionSource source, + /** Whether this extension's persistent per-ID preference is enabled */ + @JsonProperty("enabled") Boolean enabled, + /** Containing plugin metadata for plugin-contributed extensions */ + @JsonProperty("plugin") DiscoveredExtensionPlugin plugin +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionMode.java new file mode 100644 index 000000000..23bc32778 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionMode.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Effective extension loading and agent-management mode + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DiscoveredExtensionMode { + /** The {@code disabled} variant. */ + DISABLED("disabled"), + /** The {@code load_only} variant. */ + LOAD_ONLY("load_only"), + /** The {@code load_and_augment} variant. */ + LOAD_AND_AUGMENT("load_and_augment"); + + private final String value; + DiscoveredExtensionMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DiscoveredExtensionMode fromValue(String value) { + for (DiscoveredExtensionMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DiscoveredExtensionMode value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionPlugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionPlugin.java new file mode 100644 index 000000000..8df0018ef --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionPlugin.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Installed plugin that contributes a discovered extension. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record DiscoveredExtensionPlugin( + /** Installed plugin name */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionSource.java new file mode 100644 index 000000000..c38225167 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredExtensionSource.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Persisted extension discovery source + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum DiscoveredExtensionSource { + /** The {@code user} variant. */ + USER("user"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"); + + private final String value; + DiscoveredExtensionSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static DiscoveredExtensionSource fromValue(String value) { + for (DiscoveredExtensionSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown DiscoveredExtensionSource value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java similarity index 75% rename from java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java index 4f8fb22ac..3262994c1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServer.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `DiscoveredMcpServer` type. + * MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. * * @since 1.0.0 */ @@ -27,6 +27,10 @@ public record DiscoveredMcpServer( @JsonProperty("type") DiscoveredMcpServerType type, /** Configuration source: user, workspace, plugin, or builtin */ @JsonProperty("source") McpServerSource source, + /** Plugin name that provided this server, when source is plugin. */ + @JsonProperty("sourcePlugin") String sourcePlugin, + /** Plugin version that provided this server, when source is plugin. */ + @JsonProperty("sourcePluginVersion") String sourcePluginVersion, /** Whether the server is enabled (not in the disabled list) */ @JsonProperty("enabled") Boolean enabled ) { diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/EventsAgentScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsAgentScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/EventsAgentScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsAgentScope.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java index 31c1fcab0..20f37bdfa 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsCursorStatus.java @@ -10,7 +10,7 @@ import javax.annotation.processing.Generated; /** - * Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. + * Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history (the beginning for a forward read, the tail for a backward read). The fallback page is a fresh boundary snapshot, not a continuation of the requested cursor, so it may overlap already-rendered events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate by event id) before continuing from the returned cursor. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsReadDirection.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsReadDirection.java new file mode 100644 index 000000000..1df0ac8f7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/EventsReadDirection.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Direction to page through the session's persisted event history. 'forward' pages from the cursor toward newer events; 'backward' returns the newest window first (tail-first) and pages toward older events. Events within a returned batch are always chronological (oldest-to-newest), even for a backward read. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum EventsReadDirection { + /** The {@code forward} variant. */ + FORWARD("forward"), + /** The {@code backward} variant. */ + BACKWARD("backward"); + + private final String value; + EventsReadDirection(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static EventsReadDirection fromValue(String value) { + for (EventsReadDirection v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown EventsReadDirection value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Extension.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Extension.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/rpc/Extension.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Extension.java index 13bb851b4..4d3e357cd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Extension.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Extension.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `Extension` type. + * Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. * * @since 1.0.0 */ @@ -21,11 +21,11 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record Extension( - /** Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper') */ + /** Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') */ @JsonProperty("id") String id, /** Extension name (directory name) */ @JsonProperty("name") String name, - /** Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) */ + /** Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) */ @JsonProperty("source") ExtensionSource source, /** Current status: running, disabled, failed, or starting */ @JsonProperty("status") ExtensionStatus status, diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProfile.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProfile.java new file mode 100644 index 000000000..e7590c7f9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProfile.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Opaque integrator-owned process launch profile for one extension entrypoint. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionLaunchProfile( + /** Executable used to launch the extension entrypoint. */ + @JsonProperty("executable") String executable, + /** Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint. */ + @JsonProperty("args") List args, + /** Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. */ + @JsonProperty("env") Map env +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveRequest.java new file mode 100644 index 000000000..7b520f906 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveRequest.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionLaunchProviderResolveRequest( + /** Source-qualified extension identifier. */ + @JsonProperty("id") String id, + /** Human-readable extension name. */ + @JsonProperty("name") String name, + /** Absolute path to the discovered extension entrypoint. */ + @JsonProperty("modulePath") String modulePath, + /** Discovery source for the extension entrypoint. */ + @JsonProperty("source") ExtensionSource source +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveResult.java new file mode 100644 index 000000000..8a43ad4af --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionLaunchProviderResolveResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionLaunchProviderResolveResult( + /** Opaque launch profile, omitted when this provider does not support the entrypoint. */ + @JsonProperty("launch") ExtensionLaunchProfile launch +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java similarity index 79% rename from java/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java index aeb7a144f..7ddd18615 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionSource.java @@ -10,7 +10,7 @@ import javax.annotation.processing.Generated; /** - * Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) + * Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) * * @since 1.0.0 */ @@ -19,7 +19,11 @@ public enum ExtensionSource { /** The {@code project} variant. */ PROJECT("project"), /** The {@code user} variant. */ - USER("user"); + USER("user"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"), + /** The {@code session} variant. */ + SESSION("session"); private final String value; ExtensionSource(String value) { this.value = value; } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ExtensionStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionStatus.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ExtensionStatus.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionStatus.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDisableParams.java new file mode 100644 index 000000000..dc4ef9d6c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDisableParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Source-qualified extension identifiers to persistently disable for future sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionsDisableParams( + /** Source-qualified user or plugin extension IDs to disable */ + @JsonProperty("ids") List ids +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDiscoverResult.java new file mode 100644 index 000000000..fa319d7fe --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsDiscoverResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionsDiscoverResult( + /** Discovered user and enabled installed-plugin extensions from persisted Copilot home state */ + @JsonProperty("extensions") List extensions, + /** Effective extension loading mode. Defaults to load_and_augment when unset. */ + @JsonProperty("mode") DiscoveredExtensionMode mode +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsEnableParams.java new file mode 100644 index 000000000..2e4351d3d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ExtensionsEnableParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Source-qualified extension identifiers to persistently enable for future sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ExtensionsEnableParams( + /** Source-qualified user or plugin extension IDs to enable */ + @JsonProperty("ids") List ids +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java new file mode 100644 index 000000000..35e0f276e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAbortParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for cooperatively aborting a factory body. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryAbortParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java new file mode 100644 index 000000000..9910d4f7f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentOptions.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Options for one factory-scoped subagent call. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryAgentOptions( + /** Optional label distinguishing otherwise identical memoized agent calls. */ + @JsonProperty("label") String label, + /** Optional JSON Schema for structured agent output. */ + @JsonProperty("schema") Object schema, + /** Optional model identifier for the subagent. */ + @JsonProperty("model") String model, + /** Optional reasoning effort for the subagent. This field is accepted but not yet honored. */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Optional context tier for the subagent. This field is accepted but not yet honored. */ + @JsonProperty("contextTier") ContextTier contextTier, + /** Optional custom agent name for the subagent. This field is accepted but not yet honored. */ + @JsonProperty("agent") String agent +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentSummary.java new file mode 100644 index 000000000..af20d8e81 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryAgentSummary.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Prompt-safe durable identity and live status for a direct factory agent. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryAgentSummary( + @JsonProperty("agentId") String agentId, + @JsonProperty("toolCallId") String toolCallId, + @JsonProperty("runId") String runId, + @JsonProperty("phaseId") String phaseId, + @JsonProperty("label") String label, + @JsonProperty("agentType") String agentType, + @JsonProperty("status") String status, + @JsonProperty("requestedModel") String requestedModel, + @JsonProperty("resolvedModel") String resolvedModel, + @JsonProperty("startedAt") Long startedAt, + @JsonProperty("completedAt") Long completedAt, + @JsonProperty("activeMs") Long activeMs, + @JsonProperty("activity") String activity +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryCurrentPhase.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryCurrentPhase.java new file mode 100644 index 000000000..6a8de8e82 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryCurrentPhase.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Current factory phase identity. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryCurrentPhase( + @JsonProperty("id") String id, + @JsonProperty("ordinal") Long ordinal +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryDeclaredLimits.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryDeclaredLimits.java new file mode 100644 index 000000000..21f74646f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryDeclaredLimits.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Declared or approved factory resource ceilings. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryDeclaredLimits( + @JsonProperty("maxConcurrentSubagents") Long maxConcurrentSubagents, + @JsonProperty("maxTotalSubagents") Long maxTotalSubagents, + @JsonProperty("timeoutSeconds") Double timeoutSeconds, + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java new file mode 100644 index 000000000..6834dd4b1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters sent to the owning extension to execute a factory closure. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryExecuteParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Registered factory name. */ + @JsonProperty("name") String name, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Opaque token identifying this factory execution attempt. */ + @JsonProperty("executionToken") String executionToken, + /** Factory input value. */ + @JsonProperty("args") Object args +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java new file mode 100644 index 000000000..b47b9fb07 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryExecuteResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result returned by an extension factory closure. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryExecuteResult( + /** Factory result value. */ + @JsonProperty("result") Object result +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java new file mode 100644 index 000000000..28a969045 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLine.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * One ordered factory progress line. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryLogLine( + /** Monotonic sequence number within the factory run. */ + @JsonProperty("seq") Long seq, + /** Progress line kind. */ + @JsonProperty("kind") FactoryLogLineKind kind, + /** Progress text. */ + @JsonProperty("text") String text +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java new file mode 100644 index 000000000..1064f1691 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryLogLineKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Kind of factory progress line. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FactoryLogLineKind { + /** The {@code log} variant. */ + LOG("log"), + /** The {@code phase} variant. */ + PHASE("phase"); + + private final String value; + FactoryLogLineKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FactoryLogLineKind fromValue(String value) { + for (FactoryLogLineKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FactoryLogLineKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseObservation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseObservation.java new file mode 100644 index 000000000..aa04ef5ba --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseObservation.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Durable lifecycle and timing for one factory phase. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryPhaseObservation( + @JsonProperty("id") String id, + @JsonProperty("ordinal") Long ordinal, + @JsonProperty("title") String title, + @JsonProperty("detail") String detail, + @JsonProperty("status") FactoryPhaseStatus status, + @JsonProperty("lastEnteredRunAttempt") Long lastEnteredRunAttempt, + @JsonProperty("entryCount") Long entryCount, + @JsonProperty("startedAt") Long startedAt, + @JsonProperty("completedAt") Long completedAt, + @JsonProperty("accumulatedActiveMs") Long accumulatedActiveMs, + @JsonProperty("currentActiveMs") Long currentActiveMs, + @JsonProperty("totalAgentCount") Long totalAgentCount, + @JsonProperty("liveAgentCount") Long liveAgentCount +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseStatus.java new file mode 100644 index 000000000..d9fea0bc3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryPhaseStatus.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Derived lifecycle state of a factory phase. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FactoryPhaseStatus { + /** The {@code pending} variant. */ + PENDING("pending"), + /** The {@code active} variant. */ + ACTIVE("active"), + /** The {@code completed} variant. */ + COMPLETED("completed"), + /** The {@code skipped} variant. */ + SKIPPED("skipped"); + + private final String value; + FactoryPhaseStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FactoryPhaseStatus fromValue(String value) { + for (FactoryPhaseStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FactoryPhaseStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressLine.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressLine.java new file mode 100644 index 000000000..3a26b67d7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressLine.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * One durable factory progress record. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryProgressLine( + /** Global monotonic sequence number within the run. */ + @JsonProperty("seq") Long seq, + /** Resume attempt that emitted this record. */ + @JsonProperty("attempt") Long attempt, + /** Phase active when the record was emitted, or null before any phase. */ + @JsonProperty("phaseId") String phaseId, + /** Epoch milliseconds when the record was persisted. */ + @JsonProperty("recordedAt") Long recordedAt, + /** Progress record kind. */ + @JsonProperty("kind") FactoryLogLineKind kind, + /** Prompt-safe progress text. */ + @JsonProperty("text") String text +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressPage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressPage.java new file mode 100644 index 000000000..56732d8f4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryProgressPage.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * A bidirectional page of factory progress. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryProgressPage( + @JsonProperty("records") List records, + @JsonProperty("oldestSeq") Long oldestSeq, + @JsonProperty("newestSeq") Long newestSeq, + @JsonProperty("hasMoreOlder") Boolean hasMoreOlder, + @JsonProperty("hasMoreNewer") Boolean hasMoreNewer, + /** Run revision reflected by this page. */ + @JsonProperty("revision") Long revision +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunConsumed.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunConsumed.java new file mode 100644 index 000000000..62cec5f73 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunConsumed.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Durable factory resource consumption. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryRunConsumed( + @JsonProperty("activeMs") Long activeMs, + @JsonProperty("subagents") Long subagents, + @JsonProperty("nanoAiu") Long nanoAiu +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java new file mode 100644 index 000000000..79304772a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunLimits.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Wire-only per-invocation factory resource ceiling overrides. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryRunLimits( + /** Maximum number of factory subagents that may run concurrently. */ + @JsonProperty("maxConcurrentSubagents") Long maxConcurrentSubagents, + /** Maximum total number of factory subagents that may be admitted. */ + @JsonProperty("maxTotalSubagents") Long maxTotalSubagents, + /** Maximum accumulated active-execution time in seconds. Active execution includes the entire extension body, subprocess waits, queued-agent waits, and sleeps; time between resumed attempts is not counted. */ + @JsonProperty("timeoutSeconds") Double timeoutSeconds, + /** Maximum AI credits consumed by factory subagents and their descendants. The post-paid ceiling is soft: parallel turns can settle beyond it before the run stops. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunResult.java new file mode 100644 index 000000000..bb28f4088 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunResult.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Complete current or terminal factory run envelope. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryRunResult( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Current or terminal factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Completed factory result. */ + @JsonProperty("result") Object result, + /** Error message for an errored run. */ + @JsonProperty("error") String error, + /** Machine-readable failure details for an errored run. */ + @JsonProperty("failure") Object failure, + /** Reason for a halted or cancelled run. */ + @JsonProperty("reason") String reason, + /** Partial journal and progress snapshot for a halted, cancelled, or errored run. */ + @JsonProperty("snapshot") Object snapshot +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java new file mode 100644 index 000000000..5d2348ec9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunStatus.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Current or terminal state of a factory run. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum FactoryRunStatus { + /** The {@code pending} variant. */ + PENDING("pending"), + /** The {@code running} variant. */ + RUNNING("running"), + /** The {@code completed} variant. */ + COMPLETED("completed"), + /** The {@code halted} variant. */ + HALTED("halted"), + /** The {@code cancelled} variant. */ + CANCELLED("cancelled"), + /** The {@code error} variant. */ + ERROR("error"); + + private final String value; + FactoryRunStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static FactoryRunStatus fromValue(String value) { + for (FactoryRunStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown FactoryRunStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunSummary.java new file mode 100644 index 000000000..fb90885ee --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunSummary.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Durable factory run summary with read-time live overlays. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryRunSummary( + @JsonProperty("runId") String runId, + @JsonProperty("factoryName") String factoryName, + @JsonProperty("description") String description, + @JsonProperty("status") FactoryRunStatus status, + @JsonProperty("revision") Long revision, + @JsonProperty("createdAt") Long createdAt, + @JsonProperty("startedAt") Long startedAt, + @JsonProperty("updatedAt") Long updatedAt, + @JsonProperty("completedAt") Long completedAt, + @JsonProperty("currentPhase") FactoryCurrentPhase currentPhase, + @JsonProperty("declaredPhaseCount") Long declaredPhaseCount, + @JsonProperty("liveAgentCount") Long liveAgentCount, + @JsonProperty("totalSpawnedAgentCount") Long totalSpawnedAgentCount, + @JsonProperty("consumed") FactoryRunConsumed consumed, + @JsonProperty("declaredLimits") FactoryDeclaredLimits declaredLimits, + @JsonProperty("approved") FactoryDeclaredLimits approved, + @JsonProperty("observedAt") Long observedAt, + @JsonProperty("activeSegmentStartedAt") Long activeSegmentStartedAt, + @JsonProperty("terminal") FactoryRunTerminal terminal +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunTerminal.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunTerminal.java new file mode 100644 index 000000000..231c1b8a1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/FactoryRunTerminal.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Prompt-safe terminal factory outcome. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record FactoryRunTerminal( + @JsonProperty("reason") String reason, + @JsonProperty("failure") Object failure, + @JsonProperty("error") String error, + @JsonProperty("resultPreview") String resultPreview +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java new file mode 100644 index 000000000..7d7a1eaf7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryClientInfo.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Client environment metadata describing the process that produced a telemetry event. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record GitHubTelemetryClientInfo( + /** Copilot CLI version string. */ + @JsonProperty("cli_version") String cliVersion, + /** Operating system platform (e.g. darwin, linux, win32). */ + @JsonProperty("os_platform") String osPlatform, + /** Operating system version string. */ + @JsonProperty("os_version") String osVersion, + /** Operating system architecture (e.g. arm64, x64). */ + @JsonProperty("os_arch") String osArch, + /** Node.js runtime version string. */ + @JsonProperty("node_version") String nodeVersion, + /** Copilot subscription plan, when known. */ + @JsonProperty("copilot_plan") String copilotPlan, + /** Type of client. */ + @JsonProperty("client_type") String clientType, + /** Name of the client application. */ + @JsonProperty("client_name") String clientName, + /** Whether the user is a GitHub/Microsoft staff member. */ + @JsonProperty("is_staff") Boolean isStaff, + /** Stable machine identifier for the device. */ + @JsonProperty("dev_device_id") String devDeviceId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java new file mode 100644 index 000000000..efbf920b4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryEvent.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing GitHubTelemetryNotification distinguishes standard from restricted events; the payload shape is identical for both. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record GitHubTelemetryEvent( + /** Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). */ + @JsonProperty("kind") String kind, + /** Timestamp when the event was created (ISO 8601 format). */ + @JsonProperty("created_at") String createdAt, + /** Reference to the model call that produced this event. */ + @JsonProperty("model_call_id") String modelCallId, + /** String-valued properties as a map from key to value. */ + @JsonProperty("properties") Map properties, + /** Numeric metrics as a map from key to value. */ + @JsonProperty("metrics") Map metrics, + /** Experiment assignment context. */ + @JsonProperty("exp_assignment_context") String expAssignmentContext, + /** Feature flags enabled for this session, as a map from flag to value. */ + @JsonProperty("features") Map features, + /** Session identifier the event belongs to. */ + @JsonProperty("session_id") String sessionId, + /** Copilot tracking ID for user-level attribution. */ + @JsonProperty("copilot_tracking_id") String copilotTrackingId, + /** Client environment metadata. */ + @JsonProperty("client") GitHubTelemetryClientInfo client +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java new file mode 100644 index 000000000..6059f1ff6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/GitHubTelemetryNotification.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record GitHubTelemetryNotification( + /** Session the telemetry event belongs to, when it is session-scoped. Omitted for sessionless events (for example, `server.sendTelemetry` calls with no session id), which are still forwarded to opted-in connections. */ + @JsonProperty("sessionId") String sessionId, + /** Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only. */ + @JsonProperty("restricted") Boolean restricted, + /** The telemetry event, in the runtime's native GitHub-shaped telemetry format. */ + @JsonProperty("event") GitHubTelemetryEvent event +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/HistoryCompactContextWindow.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryCompactContextWindow.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/HistoryCompactContextWindow.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryCompactContextWindow.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryFileRestoreSkipReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryFileRestoreSkipReason.java new file mode 100644 index 000000000..46e943e01 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryFileRestoreSkipReason.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Reason a captured file was not restored. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HistoryFileRestoreSkipReason { + /** The {@code user-modified} variant. */ + USER_MODIFIED("user-modified"), + /** The {@code skipped-capture} variant. */ + SKIPPED_CAPTURE("skipped-capture"); + + private final String value; + HistoryFileRestoreSkipReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HistoryFileRestoreSkipReason fromValue(String value) { + for (HistoryFileRestoreSkipReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HistoryFileRestoreSkipReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindChangeType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindChangeType.java new file mode 100644 index 000000000..85b12b873 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindChangeType.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Aggregate file change represented by a rewind preview. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HistoryRewindChangeType { + /** The {@code created} variant. */ + CREATED("created"), + /** The {@code deleted} variant. */ + DELETED("deleted"), + /** The {@code modified} variant. */ + MODIFIED("modified"); + + private final String value; + HistoryRewindChangeType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HistoryRewindChangeType fromValue(String value) { + for (HistoryRewindChangeType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HistoryRewindChangeType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindFilePreview.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindFilePreview.java new file mode 100644 index 000000000..7733246dd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindFilePreview.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A file that a conversation-and-files rewind would restore. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HistoryRewindFilePreview( + /** Absolute path of the captured file. */ + @JsonProperty("path") String path, + /** Aggregate change made across the discarded turns. */ + @JsonProperty("changeType") HistoryRewindChangeType changeType, + /** Lines added across the discarded turns. */ + @JsonProperty("linesAdded") Long linesAdded, + /** Lines removed across the discarded turns. */ + @JsonProperty("linesRemoved") Long linesRemoved +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindMode.java new file mode 100644 index 000000000..f72ded947 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindMode.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Scope of a rewind operation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HistoryRewindMode { + /** The {@code conversation} variant. */ + CONVERSATION("conversation"), + /** The {@code conversation-and-files} variant. */ + CONVERSATION_AND_FILES("conversation-and-files"); + + private final String value; + HistoryRewindMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HistoryRewindMode fromValue(String value) { + for (HistoryRewindMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HistoryRewindMode value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindOutcome.java new file mode 100644 index 000000000..624795ee4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindOutcome.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Outcome of a rewind request. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HistoryRewindOutcome { + /** The {@code success} variant. */ + SUCCESS("success"), + /** The {@code session-busy} variant. */ + SESSION_BUSY("session-busy"), + /** The {@code file-change-tracking-disabled} variant. */ + FILE_CHANGE_TRACKING_DISABLED("file-change-tracking-disabled"), + /** The {@code unsupported-remote-session} variant. */ + UNSUPPORTED_REMOTE_SESSION("unsupported-remote-session"), + /** The {@code files-rolled-back} variant. */ + FILES_ROLLED_BACK("files-rolled-back"), + /** The {@code rollback-incomplete} variant. */ + ROLLBACK_INCOMPLETE("rollback-incomplete"), + /** The {@code truncation-failed} variant. */ + TRUNCATION_FAILED("truncation-failed"), + /** The {@code checkpoint-cleanup-failed} variant. */ + CHECKPOINT_CLEANUP_FAILED("checkpoint-cleanup-failed"), + /** The {@code snapshot-prune-failed} variant. */ + SNAPSHOT_PRUNE_FAILED("snapshot-prune-failed"); + + private final String value; + HistoryRewindOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HistoryRewindOutcome fromValue(String value) { + for (HistoryRewindOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HistoryRewindOutcome value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindPoint.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindPoint.java new file mode 100644 index 000000000..84926c74e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindPoint.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A root user turn that the session can rewind to. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HistoryRewindPoint( + /** ID of the user.message event that begins the discarded suffix. */ + @JsonProperty("eventId") String eventId, + /** User-visible message text for the turn. */ + @JsonProperty("userMessage") String userMessage, + /** ISO timestamp of the user turn. */ + @JsonProperty("timestamp") String timestamp, + /** Whether at least one file in this turn or a later turn can be restored. */ + @JsonProperty("canRestoreFiles") Boolean canRestoreFiles, + /** Number of unique files in this turn and all later turns that have captured changes. */ + @JsonProperty("fileCount") Long fileCount, + /** Whether this turn itself captured any file changes. */ + @JsonProperty("turnChangedFiles") Boolean turnChangedFiles, + /** Lines added by this turn's captured file changes. */ + @JsonProperty("linesAdded") Long linesAdded, + /** Lines removed by this turn's captured file changes. */ + @JsonProperty("linesRemoved") Long linesRemoved, + /** Whether this turn was an automatically injected autopilot continuation. */ + @JsonProperty("isAutopilotContinuation") Boolean isAutopilotContinuation +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindUnavailableReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindUnavailableReason.java new file mode 100644 index 000000000..ae6b029ac --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistoryRewindUnavailableReason.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HistoryRewindUnavailableReason { + /** The {@code file-change-tracking-disabled} variant. */ + FILE_CHANGE_TRACKING_DISABLED("file-change-tracking-disabled"), + /** The {@code session-busy} variant. */ + SESSION_BUSY("session-busy"), + /** The {@code unsupported-remote-session} variant. */ + UNSUPPORTED_REMOTE_SESSION("unsupported-remote-session"); + + private final String value; + HistoryRewindUnavailableReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HistoryRewindUnavailableReason fromValue(String value) { + for (HistoryRewindUnavailableReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HistoryRewindUnavailableReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistorySkippedFileRestore.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistorySkippedFileRestore.java new file mode 100644 index 000000000..60c8c2d40 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HistorySkippedFileRestore.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A captured file that rewind intentionally left unchanged. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HistorySkippedFileRestore( + /** Absolute path of the skipped file. */ + @JsonProperty("path") String path, + /** Reason the file was not restored. */ + @JsonProperty("reason") HistoryFileRestoreSkipReason reason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java new file mode 100644 index 000000000..9ed02d28b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookInvokeRequest.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Runtime-owned wire payload for a server-to-client hook callback invocation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HookInvokeRequest( + @JsonProperty("sessionId") String sessionId, + @JsonProperty("hookType") HookType hookType, + @JsonProperty("input") Object input +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookType.java new file mode 100644 index 000000000..8d7cd913c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HookType.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Hook event name dispatched through the SDK callback transport. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum HookType { + /** The {@code preToolUse} variant. */ + PRETOOLUSE("preToolUse"), + /** The {@code preMcpToolCall} variant. */ + PREMCPTOOLCALL("preMcpToolCall"), + /** The {@code postToolUse} variant. */ + POSTTOOLUSE("postToolUse"), + /** The {@code postToolUseFailure} variant. */ + POSTTOOLUSEFAILURE("postToolUseFailure"), + /** The {@code userPromptSubmitted} variant. */ + USERPROMPTSUBMITTED("userPromptSubmitted"), + /** The {@code userPromptTransformed} variant. */ + USERPROMPTTRANSFORMED("userPromptTransformed"), + /** The {@code sessionStart} variant. */ + SESSIONSTART("sessionStart"), + /** The {@code sessionEnd} variant. */ + SESSIONEND("sessionEnd"), + /** The {@code postResult} variant. */ + POSTRESULT("postResult"), + /** The {@code prePRDescription} variant. */ + PREPRDESCRIPTION("prePRDescription"), + /** The {@code errorOccurred} variant. */ + ERROROCCURRED("errorOccurred"), + /** The {@code agentStop} variant. */ + AGENTSTOP("agentStop"), + /** The {@code subagentStart} variant. */ + SUBAGENTSTART("subagentStart"), + /** The {@code subagentStop} variant. */ + SUBAGENTSTOP("subagentStop"), + /** The {@code preCompact} variant. */ + PRECOMPACT("preCompact"), + /** The {@code permissionRequest} variant. */ + PERMISSIONREQUEST("permissionRequest"), + /** The {@code notification} variant. */ + NOTIFICATION("notification"); + + private final String value; + HookType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static HookType fromValue(String value) { + for (HookType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown HookType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java new file mode 100644 index 000000000..a111b7af4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/HooksInvokeResult.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Optional output returned by an SDK callback hook. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record HooksInvokeResult( + @JsonProperty("output") Object output +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java new file mode 100644 index 000000000..3da690f47 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstalledPlugin( + /** Plugin name */ + @JsonProperty("name") String name, + /** Marketplace the plugin came from (empty string for direct repo installs) */ + @JsonProperty("marketplace") String marketplace, + /** Version installed (if available) */ + @JsonProperty("version") String version, + /** Installation timestamp */ + @JsonProperty("installed_at") String installedAt, + /** Whether the plugin is currently enabled */ + @JsonProperty("enabled") Boolean enabled, + /** Path where the plugin is cached locally */ + @JsonProperty("cache_path") String cachePath, + /** Source for direct repo installs (when marketplace is empty) */ + @JsonProperty("source") Object source, + /** Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. */ + @JsonProperty("source_sha") String sourceSha +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java new file mode 100644 index 000000000..2f4895690 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstalledPluginInfo.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Information about an installed plugin tracked in global state. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstalledPluginInfo( + /** Plugin name */ + @JsonProperty("name") String name, + /** Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. */ + @JsonProperty("marketplace") String marketplace, + /** Opaque, stable hash identifying a direct (non-marketplace) install source. Present only for direct repo / URL / local installs; absent for marketplace plugins. Same source yields the same id; distinct sources never collide. */ + @JsonProperty("directSourceId") String directSourceId, + /** Installed version (when reported by the plugin manifest) */ + @JsonProperty("version") String version, + /** Whether the plugin is currently enabled for new sessions */ + @JsonProperty("enabled") Boolean enabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java new file mode 100644 index 000000000..213b003c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPath.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionDiscoveryPath( + /** Absolute path of the file or directory (may not exist on disk yet) */ + @JsonProperty("path") String path, + /** Which tier this target belongs to */ + @JsonProperty("location") InstructionDiscoveryPathLocation location, + /** Whether the target is a single file or a directory of instruction files */ + @JsonProperty("kind") InstructionDiscoveryPathKind kind, + /** Whether this is the canonical target to create new instructions in its tier. At most one entry per tier is preferred. */ + @JsonProperty("preferredForCreation") Boolean preferredForCreation, + /** The input project path this target was derived from (only for repository targets) */ + @JsonProperty("projectPath") String projectPath +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java new file mode 100644 index 000000000..172d015d3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathKind.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Whether the target is a single file or a directory of instruction files + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum InstructionDiscoveryPathKind { + /** The {@code file} variant. */ + FILE("file"), + /** The {@code directory} variant. */ + DIRECTORY("directory"); + + private final String value; + InstructionDiscoveryPathKind(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static InstructionDiscoveryPathKind fromValue(String value) { + for (InstructionDiscoveryPathKind v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown InstructionDiscoveryPathKind value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java new file mode 100644 index 000000000..9c6fcc1ee --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionDiscoveryPathLocation.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Which tier this target belongs to + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum InstructionDiscoveryPathLocation { + /** The {@code user} variant. */ + USER("user"), + /** The {@code repository} variant. */ + REPOSITORY("repository"), + /** The {@code working-directory} variant. */ + WORKING_DIRECTORY("working-directory"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"); + + private final String value; + InstructionDiscoveryPathLocation(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static InstructionDiscoveryPathLocation fromValue(String value) { + for (InstructionDiscoveryPathLocation v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown InstructionDiscoveryPathLocation value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java new file mode 100644 index 000000000..496e1eadc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSource.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionSource( + /** Unique identifier for this source (used for toggling) */ + @JsonProperty("id") String id, + /** Human-readable label */ + @JsonProperty("label") String label, + /** File path relative to repo or absolute for home */ + @JsonProperty("sourcePath") String sourcePath, + /** Raw content of the instruction file */ + @JsonProperty("content") String content, + /** Category of instruction source — used for merge logic */ + @JsonProperty("type") InstructionSourceType type, + /** Where this source lives — used for UI grouping */ + @JsonProperty("location") InstructionSourceLocation location, + /** Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files */ + @JsonProperty("applyTo") List applyTo, + /** Short description (body after frontmatter) for use in instruction tables */ + @JsonProperty("description") String description, + /** When true, this source starts disabled and must be toggled on by the user */ + @JsonProperty("defaultDisabled") Boolean defaultDisabled, + /** The project path this source was discovered from. Only set by sessionless discovery for repository, working-directory, and project-scoped plugin sources, where it disambiguates sources across multiple workspace roots. The session-scoped getSources leaves it unset. */ + @JsonProperty("projectPath") String projectPath +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java new file mode 100644 index 000000000..261327cfb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceLocation.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Where this source lives — used for UI grouping + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum InstructionSourceLocation { + /** The {@code user} variant. */ + USER("user"), + /** The {@code repository} variant. */ + REPOSITORY("repository"), + /** The {@code working-directory} variant. */ + WORKING_DIRECTORY("working-directory"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"); + + private final String value; + InstructionSourceLocation(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static InstructionSourceLocation fromValue(String value) { + for (InstructionSourceLocation v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown InstructionSourceLocation value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java new file mode 100644 index 000000000..d267e249f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionSourceType.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Category of instruction source — used for merge logic + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum InstructionSourceType { + /** The {@code home} variant. */ + HOME("home"), + /** The {@code repo} variant. */ + REPO("repo"), + /** The {@code model} variant. */ + MODEL("model"), + /** The {@code vscode} variant. */ + VSCODE("vscode"), + /** The {@code nested-agents} variant. */ + NESTED_AGENTS("nested-agents"), + /** The {@code child-instructions} variant. */ + CHILD_INSTRUCTIONS("child-instructions"), + /** The {@code plugin} variant. */ + PLUGIN("plugin"); + + private final String value; + InstructionSourceType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static InstructionSourceType fromValue(String value) { + for (InstructionSourceType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown InstructionSourceType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java new file mode 100644 index 000000000..1a0b84051 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Optional project paths to include in instruction discovery. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionsDiscoverParams( + /** Optional list of project directory paths to scan for repository/working-directory instruction sources. When omitted or empty, only user-level and plugin instruction sources are returned (no project scan). */ + @JsonProperty("projectPaths") List projectPaths, + /** When true, omit the host's instruction sources (user/home-level files and plugin rules), leaving only repository and working-directory sources. For multitenant deployments. */ + @JsonProperty("excludeHostInstructions") Boolean excludeHostInstructions +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java new file mode 100644 index 000000000..e8cdee9e0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsDiscoverResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Instruction sources discovered across user, repository, and plugin sources. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionsDiscoverResult( + /** All discovered instruction sources */ + @JsonProperty("sources") List sources +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java new file mode 100644 index 000000000..eedc7eb7a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Optional project paths to include when enumerating instruction discovery targets. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionsGetDiscoveryPathsParams( + /** Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. */ + @JsonProperty("projectPaths") List projectPaths, + /** When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). */ + @JsonProperty("excludeHostInstructions") Boolean excludeHostInstructions +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java new file mode 100644 index 000000000..3736f64d4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/InstructionsGetDiscoveryPathsResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Canonical files and directories where custom instructions can be created so the runtime will recognize them. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record InstructionsGetDiscoveryPathsResult( + /** Canonical instruction create/discovery files and directories, in priority order */ + @JsonProperty("paths") List paths +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java new file mode 100644 index 000000000..6f024b6e1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkRequest.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A request body chunk or cancellation signal. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpRequestChunkRequest( + /** Matches the requestId from the originating httpRequestStart frame. */ + @JsonProperty("requestId") String requestId, + /** Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty. */ + @JsonProperty("data") String data, + /** When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. */ + @JsonProperty("binary") Boolean binary, + /** When true, this is the final body chunk for the request. The SDK may rely on having received an end-marked chunk before treating the request body as complete. */ + @JsonProperty("end") Boolean end, + /** When true, the runtime is cancelling the in-flight request (e.g. upstream consumer aborted). `data` is ignored. Implies end-of-request. */ + @JsonProperty("cancel") Boolean cancel, + /** Optional human-readable reason for the cancellation, propagated for logging. */ + @JsonProperty("cancelReason") String cancelReason, + /** Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent transport can attribute successive turns correctly: when a WebSocket connection is reused across turns, the httpRequestStart identity reflects only the turn that opened the connection, so each later turn stamps its own invocation id here. Absent when the runtime has no invocation context for the request, or on the plain-HTTP transport where every request has its own httpRequestStart. */ + @JsonProperty("agentInvocationId") String agentInvocationId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java new file mode 100644 index 000000000..f866fa70c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestChunkResult.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpRequestChunkResult() { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java new file mode 100644 index 000000000..b846fcf37 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartRequest.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * The head of an outbound model-layer HTTP request. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpRequestStartRequest( + /** Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies back to the runtime. */ + @JsonProperty("requestId") String requestId, + /** Id of the runtime session that triggered this request, when one is in scope. Absent for requests issued outside any session (e.g. startup model-catalog or capability resolution). This is a payload field — not a dispatch key — because the client-global API is registered process-wide rather than per session. */ + @JsonProperty("sessionId") String sessionId, + /** HTTP method, e.g. GET, POST. */ + @JsonProperty("method") String method, + /** Absolute request URL. */ + @JsonProperty("url") String url, + @JsonProperty("headers") Map> headers, + /** Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. */ + @JsonProperty("transport") LlmInferenceHttpRequestStartTransport transport, + /** Stable identity of the agent trajectory that issued this request. Present when the request originates from an agent turn; absent for requests outside any agent context. This is the same identity used by lifecycle and bridged session events and remains constant across turns and retries. */ + @JsonProperty("agentId") String agentId, + /** Stable identity of the immediate parent trajectory. Present for child trajectories such as subagents and conversation-sampling requests; absent for root-agent and non-agent requests. */ + @JsonProperty("parentAgentId") String parentAgentId, + /** Identity of the agent invocation (one agentic loop) that issued this request. It remains fixed across physical retries within the invocation and is distinct from the stable trajectory `agentId`. A caller-supplied invocation id always takes precedence (this covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests fall back to the runtime's agent task id — the same value the runtime emits as the `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. */ + @JsonProperty("agentInvocationId") String agentInvocationId, + /** Coarse classification of the interaction that produced this request. Open string for forward-compatibility; known values include `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, and `conversation-user`. Absent when the runtime did not classify the request. Comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` header from this same context. */ + @JsonProperty("interactionType") String interactionType +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java new file mode 100644 index 000000000..28016dcb8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartResult.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpRequestStartResult() { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java new file mode 100644 index 000000000..1b5aa9a2d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpRequestStartTransport.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum LlmInferenceHttpRequestStartTransport { + /** The {@code http} variant. */ + HTTP("http"), + /** The {@code websocket} variant. */ + WEBSOCKET("websocket"); + + private final String value; + LlmInferenceHttpRequestStartTransport(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static LlmInferenceHttpRequestStartTransport fromValue(String value) { + for (LlmInferenceHttpRequestStartTransport v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown LlmInferenceHttpRequestStartTransport value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java new file mode 100644 index 000000000..551c534a1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkError.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpResponseChunkError( + /** Human-readable failure description. */ + @JsonProperty("message") String message, + /** Optional machine-readable error code. */ + @JsonProperty("code") String code +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java new file mode 100644 index 000000000..2a381d827 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * A response body chunk or terminal error. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpResponseChunkParams( + /** Matches the requestId from the originating httpRequestStart frame. */ + @JsonProperty("requestId") String requestId, + /** Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk with empty data and end=true). */ + @JsonProperty("data") String data, + /** When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. */ + @JsonProperty("binary") Boolean binary, + /** When true, this is the final body chunk for the response. The runtime treats the response body as complete after receiving an end-marked chunk. */ + @JsonProperty("end") Boolean end, + /** Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. */ + @JsonProperty("error") LlmInferenceHttpResponseChunkError error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java new file mode 100644 index 000000000..2ffddc1d3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseChunkResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the chunk was accepted. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpResponseChunkResult( + /** True when the chunk was matched to a pending request; false when unknown. */ + @JsonProperty("accepted") Boolean accepted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java new file mode 100644 index 000000000..69c26221b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartParams.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Response head. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpResponseStartParams( + /** Matches the requestId from the originating httpRequestStart frame. */ + @JsonProperty("requestId") String requestId, + /** HTTP status code. */ + @JsonProperty("status") Long status, + /** Optional HTTP status reason phrase. */ + @JsonProperty("statusText") String statusText, + @JsonProperty("headers") Map> headers +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java new file mode 100644 index 000000000..05692013a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceHttpResponseStartResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the start frame was accepted. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceHttpResponseStartResult( + /** True when the response start was matched to a pending request; false when unknown. */ + @JsonProperty("accepted") Boolean accepted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java new file mode 100644 index 000000000..33c8fb722 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LlmInferenceSetProviderResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the calling client was registered as the LLM inference provider. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LlmInferenceSetProviderResult( + /** Whether the provider was set successfully */ + @JsonProperty("success") Boolean success +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java new file mode 100644 index 000000000..c7970940a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/LocalSessionMetadataValue.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record LocalSessionMetadataValue( + /** Stable session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Session creation time as an ISO 8601 timestamp */ + @JsonProperty("startTime") String startTime, + /** Last-modified time of the session's persisted state, as ISO 8601 */ + @JsonProperty("modifiedTime") String modifiedTime, + /** Short summary of the session, when one has been derived */ + @JsonProperty("summary") String summary, + /** Optional human-friendly name set via /rename */ + @JsonProperty("name") String name, + /** Runtime client name that created/last resumed this session */ + @JsonProperty("clientName") String clientName, + /** Always false for local sessions. */ + @JsonProperty("isRemote") Boolean isRemote, + /** True for detached maintenance sessions that should be hidden from normal resume lists. */ + @JsonProperty("isDetached") Boolean isDetached, + /** Pre-resolved working-directory context for session startup. */ + @JsonProperty("context") SessionContext context, + /** GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. */ + @JsonProperty("mcTaskId") String mcTaskId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ManagedSettingsReadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ManagedSettingsReadResult.java new file mode 100644 index 000000000..2018f62ce --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ManagedSettingsReadResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Validated device-managed settings discovered before a session exists. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ManagedSettingsReadResult( + /** Validated, canonical managed-settings JSON. Omitted when no managed settings were discovered or when discovered settings failed validation. */ + @JsonProperty("settingsJson") Object settingsJson, + /** Discovery or validation error text when managed settings could not be read safely. */ + @JsonProperty("errorMessage") String errorMessage +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java new file mode 100644 index 000000000..5c7b8b865 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceInfo.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Registered marketplace summary. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record MarketplaceInfo( + /** Marketplace name (matches the @marketplace suffix in plugin specs) */ + @JsonProperty("name") String name, + /** Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: owner/repo"). */ + @JsonProperty("source") String source, + /** True when this is a default marketplace shipped with the runtime. Defaults are not removable. */ + @JsonProperty("isDefault") Boolean isDefault +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java new file mode 100644 index 000000000..829b80de9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplacePluginInfo.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Plugin entry advertised by a marketplace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record MarketplacePluginInfo( + /** Plugin name as listed in the marketplace catalog */ + @JsonProperty("name") String name, + /** Short description from the marketplace catalog, when present */ + @JsonProperty("description") String description +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java new file mode 100644 index 000000000..31d6310e1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MarketplaceRefreshEntry.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record MarketplaceRefreshEntry( + /** Marketplace name that was refreshed */ + @JsonProperty("name") String name, + /** Whether the refresh succeeded */ + @JsonProperty("success") Boolean success, + /** Error message (failure only) */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java new file mode 100644 index 000000000..1d0a17cc9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAllowedServer.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP server allowed by policy, with server name and optional PII-free explanatory note. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpAllowedServer( + /** Allowed server name */ + @JsonProperty("name") String name, + /** PII-free note explaining why the server was allowed */ + @JsonProperty("redactedNote") String redactedNote +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseCapability.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseCapability.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseCapability.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseCapability.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseServer.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseServer.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsDiagnoseServer.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetails.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetails.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetails.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetails.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsAvailableDisplayMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsAvailableDisplayMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsAvailableDisplayMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsAvailableDisplayMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsDisplayMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsDisplayMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsDisplayMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsDisplayMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsPlatform.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsPlatform.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsPlatform.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsPlatform.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsTheme.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsTheme.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsTheme.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsHostContextDetailsTheme.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java index 25850f372..0a0f977ff 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsResourceContent.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `McpAppsResourceContent` type. + * MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetails.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetails.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetails.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetails.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsAvailableDisplayMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsAvailableDisplayMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsAvailableDisplayMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsAvailableDisplayMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsDisplayMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsDisplayMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsDisplayMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsDisplayMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsPlatform.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsPlatform.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsPlatform.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsPlatform.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsTheme.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsTheme.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsTheme.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpAppsSetHostContextDetailsTheme.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java index 64ffd3951..4c8baff2c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigAddParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server name and configuration to add to user configuration. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java index e71c12f93..81fab3e4c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigDisableParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * MCP server names to disable for new sessions. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java index 952d6fb68..57e882acb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigEnableParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * MCP server names to enable for new sessions. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java index 4d6644228..810081861 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * User-configured MCP servers, keyed by server name. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java index 840b72abf..81a0aa0e2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigRemoveParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server name to remove from user configuration. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java index f2c2b0faa..082d98318 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpConfigUpdateParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server name and replacement configuration to write to user configuration. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java index ed7b32bb7..a9e029da3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional working directory used as context for MCP server discovery. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java index b000b16ff..e5131e36d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpDiscoverResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * MCP servers discovered from user, workspace, plugin, and built-in sources. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingRequest.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingRequest.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpExecuteSamplingResult.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java new file mode 100644 index 000000000..e0ecefae7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpFilteredServer.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP server filtered by policy, with name, reason, and optional redacted reason. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpFilteredServer( + /** Filtered server name */ + @JsonProperty("name") String name, + /** Human-readable filter reason */ + @JsonProperty("reason") String reason, + /** PII-free filter reason */ + @JsonProperty("redactedReason") String redactedReason, + /** Deprecated. This field is no longer populated. */ + @JsonProperty("enterpriseName") String enterpriseName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java new file mode 100644 index 000000000..152bd8556 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpHostState.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Host-level state, omitted when no MCP host is initialized. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpHostState( + /** Whether third-party MCP servers are policy-enabled for this session. */ + @JsonProperty("mcp3pEnabled") Boolean mcp3pEnabled, + /** Configured servers that are explicitly disabled. */ + @JsonProperty("disabledServers") List disabledServers, + /** Configured servers filtered out by MCP server policy. */ + @JsonProperty("filteredServers") List filteredServers, + /** Names of currently-connected MCP clients. */ + @JsonProperty("clients") List clients, + /** Names of servers with in-flight connection attempts. */ + @JsonProperty("pendingConnections") List pendingConnections, + /** Map of server name to recorded connection failure. */ + @JsonProperty("failedServers") Map failedServers, + /** Map of server name to recorded pending-auth state. */ + @JsonProperty("needsAuthServers") Map needsAuthServers +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java new file mode 100644 index 000000000..4c835d293 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpOauthLoginGrantType.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * OAuth grant type override for this login. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpOauthLoginGrantType { + /** The {@code authorization_code} variant. */ + AUTHORIZATION_CODE("authorization_code"), + /** The {@code client_credentials} variant. */ + CLIENT_CREDENTIALS("client_credentials"); + + private final String value; + McpOauthLoginGrantType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpOauthLoginGrantType fromValue(String value) { + for (McpOauthLoginGrantType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpOauthLoginGrantType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResource.java new file mode 100644 index 000000000..92302772c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResource.java @@ -0,0 +1,47 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpResource( + /** The resource URI (e.g. ui://... or file:///...) */ + @JsonProperty("uri") String uri, + /** The programmatic name of the resource */ + @JsonProperty("name") String name, + /** Optional human-readable display title */ + @JsonProperty("title") String title, + /** Optional description of what this resource represents */ + @JsonProperty("description") String description, + /** MIME type of the resource, if known */ + @JsonProperty("mimeType") String mimeType, + /** Resource size in bytes, when known */ + @JsonProperty("size") Long size, + /** Icons associated with this resource */ + @JsonProperty("icons") List icons, + /** Model/client annotations associated with this resource */ + @JsonProperty("annotations") McpResourceAnnotations annotations, + /** Resource-level metadata */ + @JsonProperty("_meta") Map meta, + /** Server-provided non-standard descriptor fields preserved from the MCP response */ + @JsonProperty("additionalProperties") Map additionalProperties +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java new file mode 100644 index 000000000..6cae65957 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceAnnotations.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Standard MCP resource annotations plus preserved non-standard annotation fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpResourceAnnotations( + /** Intended audience roles for this resource */ + @JsonProperty("audience") List audience, + /** Priority hint for model/client use */ + @JsonProperty("priority") Double priority, + /** Last-modified timestamp hint */ + @JsonProperty("lastModified") String lastModified, + /** Server-provided non-standard annotation fields preserved from the MCP response */ + @JsonProperty("additionalProperties") Map additionalProperties +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java new file mode 100644 index 000000000..4967286f1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceContent.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpResourceContent( + /** The resource URI */ + @JsonProperty("uri") String uri, + /** MIME type of the content */ + @JsonProperty("mimeType") String mimeType, + /** Text content (e.g. HTML) */ + @JsonProperty("text") String text, + /** Base64-encoded binary content */ + @JsonProperty("blob") String blob, + /** Resource-level metadata (CSP, permissions, etc.) */ + @JsonProperty("_meta") Map meta +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java new file mode 100644 index 000000000..f5a8c68d3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceIcon.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * A resource icon descriptor plus preserved non-standard icon fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpResourceIcon( + /** Icon URI */ + @JsonProperty("src") String src, + /** Icon MIME type, when known */ + @JsonProperty("mimeType") String mimeType, + /** Icon sizes hint */ + @JsonProperty("sizes") String sizes, + /** Theme hint for this icon */ + @JsonProperty("theme") String theme, + /** Server-provided non-standard icon fields preserved from the MCP response */ + @JsonProperty("additionalProperties") Map additionalProperties +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java new file mode 100644 index 000000000..14ffca372 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpResourceTemplate.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpResourceTemplate( + /** An RFC 6570 URI template for constructing resource URIs */ + @JsonProperty("uriTemplate") String uriTemplate, + /** The programmatic name of the resource template */ + @JsonProperty("name") String name, + /** Optional human-readable display title */ + @JsonProperty("title") String title, + /** Optional description of what this template is for */ + @JsonProperty("description") String description, + /** MIME type for resources matching this template, if uniform */ + @JsonProperty("mimeType") String mimeType, + /** Icons associated with resources matching this template */ + @JsonProperty("icons") List icons, + /** Model/client annotations associated with this template */ + @JsonProperty("annotations") McpResourceAnnotations annotations, + /** Resource-template-level metadata */ + @JsonProperty("_meta") Map meta, + /** Server-provided non-standard descriptor fields preserved from the MCP response */ + @JsonProperty("additionalProperties") Map additionalProperties +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpSamplingExecutionAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpSamplingExecutionAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpSamplingExecutionAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpSamplingExecutionAction.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java new file mode 100644 index 000000000..14a9118d0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServer.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP server status entry, including config source/plugin source and any connection error. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpServer( + /** Server name (config key) */ + @JsonProperty("name") String name, + /** Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured */ + @JsonProperty("status") McpServerStatus status, + /** Configuration source: user, workspace, plugin, or builtin */ + @JsonProperty("source") McpServerSource source, + /** Plugin name that provided this server, when source is plugin. */ + @JsonProperty("sourcePlugin") String sourcePlugin, + /** Plugin version that provided this server, when source is plugin. */ + @JsonProperty("sourcePluginVersion") String sourcePluginVersion, + /** Error message if the server failed to connect */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java new file mode 100644 index 000000000..d929212ff --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerFailureInfo.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Recorded MCP server connection failure. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpServerFailureInfo( + /** Failure message produced when the MCP server connection failed. */ + @JsonProperty("message") String message, + /** epoch-ms timestamp at which the failure was recorded. */ + @JsonProperty("timestamp") Long timestamp +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java new file mode 100644 index 000000000..1026c582b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerNeedsAuthInfo.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Recorded MCP server pending-auth state. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpServerNeedsAuthInfo( + /** epoch-ms timestamp at which the server signalled it needs authentication. */ + @JsonProperty("timestamp") Long timestamp +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpServerSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerSource.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java new file mode 100644 index 000000000..4c1fb46b2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java @@ -0,0 +1,45 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpServerStatus { + /** The {@code connected} variant. */ + CONNECTED("connected"), + /** The {@code failed} variant. */ + FAILED("failed"), + /** The {@code needs-auth} variant. */ + NEEDS_AUTH("needs-auth"), + /** The {@code pending} variant. */ + PENDING("pending"), + /** The {@code disabled} variant. */ + DISABLED("disabled"), + /** The {@code stopped} variant. */ + STOPPED("stopped"), + /** The {@code not_configured} variant. */ + NOT_CONFIGURED("not_configured"); + + private final String value; + McpServerStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpServerStatus fromValue(String value) { + for (McpServerStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpServerStatus value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpSetEnvValueModeDetails.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpSetEnvValueModeDetails.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/McpSetEnvValueModeDetails.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpSetEnvValueModeDetails.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java new file mode 100644 index 000000000..2f4436ca4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUi.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpToolUi( + /** URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use `session.mcp.resources.read` to fetch its HTML and resource metadata. */ + @JsonProperty("resourceUri") String resourceUri, + /** Tool visibility advertised by the server. When absent, MCP Apps defaults apply. */ + @JsonProperty("visibility") List visibility +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java new file mode 100644 index 000000000..9e73f0c90 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpToolUiVisibility.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Consumer allowed to call an MCP tool. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum McpToolUiVisibility { + /** The {@code model} variant. */ + MODEL("model"), + /** The {@code app} variant. */ + APP("app"); + + private final String value; + McpToolUiVisibility(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static McpToolUiVisibility fromValue(String value) { + for (McpToolUiVisibility v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown McpToolUiVisibility value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTools.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTools.java new file mode 100644 index 000000000..37782f6d3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/McpTools.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record McpTools( + /** Tool name. */ + @JsonProperty("name") String name, + /** Tool description, when provided. */ + @JsonProperty("description") String description, + /** Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` block was present without recognized fields. */ + @JsonProperty("ui") McpToolUi ui +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MemoryConfiguration.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MemoryConfiguration.java new file mode 100644 index 000000000..63d327a41 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MemoryConfiguration.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Memory configuration for this session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record MemoryConfiguration( + /** Whether memory is enabled for the session. */ + @JsonProperty("enabled") Boolean enabled +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotCurrentMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotCurrentMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotCurrentMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotCurrentMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadata.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadata.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadata.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataRepository.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataRepository.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataRepository.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataTaskType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataTaskType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataTaskType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/MetadataSnapshotRemoteMetadataTaskType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Model.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Model.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/Model.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Model.java index 090451916..f002df540 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Model.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Model.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `Model` type. + * Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. * * @since 1.0.0 */ @@ -34,8 +34,6 @@ public record Model( @JsonProperty("billing") ModelBilling billing, /** Supported reasoning effort levels (only present if model supports reasoning effort) */ @JsonProperty("supportedReasoningEfforts") List supportedReasoningEfforts, - /** Default reasoning effort level (only present if model supports reasoning effort) */ - @JsonProperty("defaultReasoningEffort") String defaultReasoningEffort, /** Model capability category for grouping in the model picker */ @JsonProperty("modelPickerCategory") ModelPickerCategory modelPickerCategory, /** Relative cost tier for token-based billing users */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java new file mode 100644 index 000000000..f72f4b5cf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Billing information + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelBilling( + /** Billing cost multiplier relative to the base rate */ + @JsonProperty("multiplier") Double multiplier, + /** Token-level pricing information for this model */ + @JsonProperty("tokenPrices") ModelBillingTokenPrices tokenPrices, + /** Whole-number percentage discount (0-100) applied to usage billed through this model. Populated for the synthetic `auto` model, where requests routed by auto-mode are billed at a reduced rate; absent for concrete models. */ + @JsonProperty("discountPercent") Long discountPercent, + /** Active server-driven promotion for this model, if any. Present when the model is being promoted with a discount, which may be time-boxed or open-ended. */ + @JsonProperty("promo") ModelBillingPromo promo +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java new file mode 100644 index 000000000..087ca1c15 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingPromo.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Active server-driven promotion for a model, including its discount and optional expiry. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelBillingPromo( + /** Stable identifier for the promotion campaign. */ + @JsonProperty("id") String id, + /** Percentage discount (0-100) applied while the promotion is active. May be fractional. */ + @JsonProperty("discountPercent") Double discountPercent, + /** UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion omits this field. When present, the API only surfaces a promo whose expiry parses and is in the future, so consumers should treat a past value as expired. */ + @JsonProperty("endsAt") String endsAt, + /** Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present. */ + @JsonProperty("message") String message +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java new file mode 100644 index 000000000..56e06fe22 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Token-level pricing information for this model + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelBillingTokenPrices( + /** AI Credits cost per billing batch of input tokens */ + @JsonProperty("inputPrice") Double inputPrice, + /** AI Credits cost per billing batch of output tokens */ + @JsonProperty("outputPrice") Double outputPrice, + /** Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens */ + @JsonProperty("cachePrice") Double cachePrice, + /** AI Credits cost per billing batch of cached (read) tokens */ + @JsonProperty("cacheReadPrice") Double cacheReadPrice, + /** AI Credits cost per billing batch of cache-write (cache creation) tokens. */ + @JsonProperty("cacheWritePrice") Double cacheWritePrice, + /** Number of tokens per standard billing batch */ + @JsonProperty("batchSize") Long batchSize, + /** Use maxPromptTokens instead. Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. */ + @JsonProperty("contextMax") Long contextMax, + /** Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. */ + @JsonProperty("maxPromptTokens") Long maxPromptTokens, + /** Long context tier pricing (available for models with extended context windows) */ + @JsonProperty("longContext") ModelBillingTokenPricesLongContext longContext +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java new file mode 100644 index 000000000..bb6751579 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Long context tier pricing (available for models with extended context windows) + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelBillingTokenPricesLongContext( + /** AI Credits cost per billing batch of input tokens */ + @JsonProperty("inputPrice") Double inputPrice, + /** AI Credits cost per billing batch of output tokens */ + @JsonProperty("outputPrice") Double outputPrice, + /** Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens */ + @JsonProperty("cachePrice") Double cachePrice, + /** AI Credits cost per billing batch of cached (read) tokens */ + @JsonProperty("cacheReadPrice") Double cacheReadPrice, + /** AI Credits cost per billing batch of cache-write (cache creation) tokens. */ + @JsonProperty("cacheWritePrice") Double cacheWritePrice, + /** Use maxPromptTokens instead. Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. */ + @JsonProperty("contextMax") Long contextMax, + /** Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. */ + @JsonProperty("maxPromptTokens") Long maxPromptTokens +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilities.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilities.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilities.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilities.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimits.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimits.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimits.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimits.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimitsVision.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimitsVision.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimitsVision.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesLimitsVision.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java index 1433a7b5e..ef9d78a39 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverride.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Override individual model capabilities resolved by the runtime + * Optional capability overrides (vision, tool_calls, reasoning, etc.). * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimits.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimits.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimits.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimits.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimitsVision.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimitsVision.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimitsVision.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideLimitsVision.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java index ec1da750d..d210460d7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesOverrideSupports.java @@ -24,6 +24,8 @@ public record ModelCapabilitiesOverrideSupports( /** Whether this model supports vision/image input */ @JsonProperty("vision") Boolean vision, /** Whether this model supports reasoning effort configuration */ - @JsonProperty("reasoningEffort") Boolean reasoningEffort + @JsonProperty("reasoningEffort") Boolean reasoningEffort, + /** Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). */ + @JsonProperty("adaptive_thinking") AdaptiveThinkingSupport adaptiveThinking ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java similarity index 76% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java index 91a98b423..b66ba8aa7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelCapabilitiesSupports.java @@ -24,6 +24,8 @@ public record ModelCapabilitiesSupports( /** Whether this model supports vision/image input */ @JsonProperty("vision") Boolean vision, /** Whether this model supports reasoning effort configuration */ - @JsonProperty("reasoningEffort") Boolean reasoningEffort + @JsonProperty("reasoningEffort") Boolean reasoningEffort, + /** Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). */ + @JsonProperty("adaptive_thinking") AdaptiveThinkingSupport adaptiveThinking ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelPickerCategory.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerCategory.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelPickerCategory.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerCategory.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPriceCategory.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPriceCategory.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPriceCategory.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPickerPriceCategory.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPolicy.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelPolicy.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPolicy.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelPolicyState.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPolicyState.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelPolicyState.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelPolicyState.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsGetBuiltInCatalogResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsGetBuiltInCatalogResult.java new file mode 100644 index 000000000..9797a2d67 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsGetBuiltInCatalogResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelsGetBuiltInCatalogResult( + /** Built-in model entries. */ + @JsonProperty("models") List models +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListParams.java new file mode 100644 index 000000000..3366ff61c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code models.list} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ModelsListParams( + /** 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. */ + @JsonProperty("gitHubToken") String gitHubToken +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java index 0ae1acfce..5a88a01db 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ModelsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * List of Copilot models available to the resolved user, including capabilities and billing metadata. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/NamedProviderConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/NamedProviderConfig.java new file mode 100644 index 000000000..9ee1c5a95 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/NamedProviderConfig.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * A named BYOK provider connection (transport + credentials). + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record NamedProviderConfig( + /** Stable identifier referenced by BYOK model definitions. Must not contain '/'. */ + @JsonProperty("name") String name, + /** Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. */ + @JsonProperty("type") ProviderConfigType type, + /** Wire API format (openai/azure only). Defaults to "completions". */ + @JsonProperty("wireApi") ProviderConfigWireApi wireApi, + /** Provider transport. Defaults to "http". */ + @JsonProperty("transport") ProviderConfigTransport transport, + /** API endpoint URL. */ + @JsonProperty("baseUrl") String baseUrl, + /** API key. Optional for local providers like Ollama. */ + @JsonProperty("apiKey") String apiKey, + /** Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. */ + @JsonProperty("bearerToken") String bearerToken, + /** Azure-specific provider options. */ + @JsonProperty("azure") ProviderConfigAzure azure, + /** Custom HTTP headers to include in all outbound requests to the provider. */ + @JsonProperty("headers") Map headers, + /** When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. */ + @JsonProperty("hasBearerTokenProvider") Boolean hasBearerTokenProvider +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java index 5b373ee23..f38ba82c4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OpenCanvasInstance.java @@ -29,6 +29,8 @@ public record OpenCanvasInstance( @JsonProperty("extensionName") String extensionName, /** Provider-local canvas identifier */ @JsonProperty("canvasId") String canvasId, + /** Host-local PNG path for the canvas icon, when supplied */ + @JsonProperty("icon") String icon, /** Rendered title */ @JsonProperty("title") String title, /** Provider-supplied status text */ @@ -36,10 +38,6 @@ public record OpenCanvasInstance( /** URL for web-rendered canvases */ @JsonProperty("url") String url, /** Input supplied when the instance was opened */ - @JsonProperty("input") Object input, - /** Whether this snapshot came from an idempotent reopen */ - @JsonProperty("reopen") Boolean reopen, - /** Runtime-controlled routing state for an open canvas instance. */ - @JsonProperty("availability") CanvasInstanceAvailability availability + @JsonProperty("input") Object input ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java new file mode 100644 index 000000000..2864bbd99 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicy.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record OptionsUpdateAdditionalContentExclusionPolicy( + @JsonProperty("rules") List rules, + @JsonProperty("last_updated_at") Object lastUpdatedAt, + /** Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. */ + @JsonProperty("scope") OptionsUpdateAdditionalContentExclusionPolicyScope scope +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java new file mode 100644 index 000000000..135a7c7f8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRule.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record OptionsUpdateAdditionalContentExclusionPolicyRule( + @JsonProperty("paths") List paths, + @JsonProperty("ifAnyMatch") List ifAnyMatch, + @JsonProperty("ifNoneMatch") List ifNoneMatch, + /** Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. */ + @JsonProperty("source") OptionsUpdateAdditionalContentExclusionPolicyRuleSource source +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java new file mode 100644 index 000000000..a36372280 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyRuleSource.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record OptionsUpdateAdditionalContentExclusionPolicyRuleSource( + @JsonProperty("name") String name, + @JsonProperty("type") String type +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java new file mode 100644 index 000000000..28fbd2a6f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateAdditionalContentExclusionPolicyScope.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum OptionsUpdateAdditionalContentExclusionPolicyScope { + /** The {@code repo} variant. */ + REPO("repo"), + /** The {@code all} variant. */ + ALL("all"); + + private final String value; + OptionsUpdateAdditionalContentExclusionPolicyScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static OptionsUpdateAdditionalContentExclusionPolicyScope fromValue(String value) { + for (OptionsUpdateAdditionalContentExclusionPolicyScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown OptionsUpdateAdditionalContentExclusionPolicyScope value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java new file mode 100644 index 000000000..41d3e1c6c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateContextTier.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum OptionsUpdateContextTier { + /** The {@code default} variant. */ + DEFAULT("default"), + /** The {@code long_context} variant. */ + LONG_CONTEXT("long_context"); + + private final String value; + OptionsUpdateContextTier(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static OptionsUpdateContextTier fromValue(String value) { + for (OptionsUpdateContextTier v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown OptionsUpdateContextTier value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateEnvValueMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateEnvValueMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateEnvValueMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateEnvValueMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java new file mode 100644 index 000000000..ee0f68052 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateReasoningSummary.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Reasoning summary mode for supported model clients. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum OptionsUpdateReasoningSummary { + /** The {@code none} variant. */ + NONE("none"), + /** The {@code concise} variant. */ + CONCISE("concise"), + /** The {@code detailed} variant. */ + DETAILED("detailed"); + + private final String value; + OptionsUpdateReasoningSummary(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static OptionsUpdateReasoningSummary fromValue(String value) { + for (OptionsUpdateReasoningSummary v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown OptionsUpdateReasoningSummary value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateToolFilterPrecedence.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateToolFilterPrecedence.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateToolFilterPrecedence.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/OptionsUpdateToolFilterPrecedence.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java index de370ca5d..7042864b0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PendingPermissionRequest.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `PendingPermissionRequest` type. + * Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionContext.java new file mode 100644 index 000000000..73934eea6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionContext.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Optional informational context describing how and where the permission decision was made. This does not affect permission behavior. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PermissionDecisionContext( + /** Disposition of the permission request as observed by the responding client. */ + @JsonProperty("outcome") PermissionDecisionOutcome outcome, + /** Controlled reason or actor responsible for the response. */ + @JsonProperty("source") PermissionDecisionSource source, + /** Client surface that submitted the response. */ + @JsonProperty("surface") PermissionDecisionSurface surface +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionOutcome.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionOutcome.java new file mode 100644 index 000000000..d46c460a2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionOutcome.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Disposition of a permission request as observed by the responding client. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionDecisionOutcome { + /** The {@code auto_approved} variant. */ + AUTO_APPROVED("auto_approved"), + /** The {@code autopilot_denied} variant. */ + AUTOPILOT_DENIED("autopilot_denied"), + /** The {@code prompted_user} variant. */ + PROMPTED_USER("prompted_user"); + + private final String value; + PermissionDecisionOutcome(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionDecisionOutcome fromValue(String value) { + for (PermissionDecisionOutcome v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionDecisionOutcome value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSource.java new file mode 100644 index 000000000..ee807b095 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSource.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Controlled reason or actor responsible for a permission response. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionDecisionSource { + /** The {@code judge_recommendation} variant. */ + JUDGE_RECOMMENDATION("judge_recommendation"), + /** The {@code human_response} variant. */ + HUMAN_RESPONSE("human_response"), + /** The {@code host_policy} variant. */ + HOST_POLICY("host_policy"), + /** The {@code unattended_fallback} variant. */ + UNATTENDED_FALLBACK("unattended_fallback"); + + private final String value; + PermissionDecisionSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionDecisionSource fromValue(String value) { + for (PermissionDecisionSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionDecisionSource value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSurface.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSurface.java new file mode 100644 index 000000000..2cf634879 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionDecisionSurface.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Client surface that submitted a permission response. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionDecisionSurface { + /** The {@code tui} variant. */ + TUI("tui"), + /** The {@code prompt_mode} variant. */ + PROMPT_MODE("prompt_mode"), + /** The {@code copilot_app} variant. */ + COPILOT_APP("copilot_app"), + /** The {@code sdk} variant. */ + SDK("sdk"); + + private final String value; + PermissionDecisionSurface(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionDecisionSurface fromValue(String value) { + for (PermissionDecisionSurface v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionDecisionSurface value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionLocationType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionLocationType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionLocationType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionLocationType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionPathsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionPathsConfig.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionPathsConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionPathsConfig.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java index 7980e0e83..8e7a6c769 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionRule.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `PermissionRule` type. + * A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionRulesSet.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionRulesSet.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionRulesSet.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionRulesSet.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionUrlsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionUrlsConfig.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionUrlsConfig.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionUrlsConfig.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java new file mode 100644 index 000000000..db24a2bad --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsAllowAllMode.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Current or requested allow-all mode. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionsAllowAllMode { + /** The {@code off} variant. */ + OFF("off"), + /** The {@code on} variant. */ + ON("on"), + /** The {@code auto} variant. */ + AUTO("auto"); + + private final String value; + PermissionsAllowAllMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionsAllowAllMode fromValue(String value) { + for (PermissionsAllowAllMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionsAllowAllMode value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java index 61108c16b..249c7598d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicy.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type. + * Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java index c6c7f649a..b1afc50fc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRule.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type. + * Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. * * @since 1.0.0 */ @@ -25,7 +25,7 @@ public record PermissionsConfigureAdditionalContentExclusionPolicyRule( @JsonProperty("paths") List paths, @JsonProperty("ifAnyMatch") List ifAnyMatch, @JsonProperty("ifNoneMatch") List ifNoneMatch, - /** Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. */ + /** Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. */ @JsonProperty("source") PermissionsConfigureAdditionalContentExclusionPolicyRuleSource source ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java index a5d4a45f3..f592ae799 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. + * Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsConfigureAdditionalContentExclusionPolicyScope.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsModifyRulesScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsModifyRulesScope.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsModifyRulesScope.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsModifyRulesScope.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java new file mode 100644 index 000000000..a7ff9ae9a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetAllowAllSource.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum PermissionsSetAllowAllSource { + /** The {@code cli_flag} variant. */ + CLI_FLAG("cli_flag"), + /** The {@code slash_command} variant. */ + SLASH_COMMAND("slash_command"), + /** The {@code autopilot_confirmation} variant. */ + AUTOPILOT_CONFIRMATION("autopilot_confirmation"), + /** The {@code rpc} variant. */ + RPC("rpc"); + + private final String value; + PermissionsSetAllowAllSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static PermissionsSetAllowAllSource fromValue(String value) { + for (PermissionsSetAllowAllSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown PermissionsSetAllowAllSource value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetApproveAllSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetApproveAllSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetApproveAllSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PermissionsSetApproveAllSource.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/PingParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingParams.java index 2e00e6cac..841688e1b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PingParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional message to echo back to the caller. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/PingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/PingResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingResult.java index ded50ecbd..3199f706d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/PingResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PingResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.time.OffsetDateTime; import javax.annotation.processing.Generated; /** * Server liveness response, including the echoed message, current server timestamp, and protocol version. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java new file mode 100644 index 000000000..91c637478 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodoDependency.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PlanSqlTodoDependency( + /** ID of the todo that has the dependency. */ + @JsonProperty("todoId") String todoId, + /** ID of the todo it depends on. */ + @JsonProperty("dependsOn") String dependsOn +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java new file mode 100644 index 000000000..bee0a4854 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PlanSqlTodosRow.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single todo row read from the session SQL `todos` table. All fields are optional because the SQL schema is best-effort and the agent may not have populated every column. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PlanSqlTodosRow( + /** Todo identifier. */ + @JsonProperty("id") String id, + /** Todo title. */ + @JsonProperty("title") String title, + /** Todo description. */ + @JsonProperty("description") String description, + /** Todo status. */ + @JsonProperty("status") String status +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Plugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Plugin.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/Plugin.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Plugin.java index b10cd31cf..65268ab6e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Plugin.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Plugin.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `Plugin` type. + * Session plugin metadata, with name, marketplace, optional version, and enabled state. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java new file mode 100644 index 000000000..dab44f168 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginUpdateAllEntry.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginUpdateAllEntry( + /** Plugin name that was updated */ + @JsonProperty("name") String name, + /** Marketplace the plugin came from. Empty string ("") for direct installs. */ + @JsonProperty("marketplace") String marketplace, + /** Whether the update succeeded for this plugin */ + @JsonProperty("success") Boolean success, + /** Previously installed version, when available */ + @JsonProperty("previousVersion") String previousVersion, + /** Version after the update, when available */ + @JsonProperty("newVersion") String newVersion, + /** Number of skills installed after the update (success only) */ + @JsonProperty("skillsInstalled") Long skillsInstalled, + /** Error message (failure only) */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java new file mode 100644 index 000000000..661e998b7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsDisableParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Plugin names (or specs) to disable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsDisableParams( + /** Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins. */ + @JsonProperty("names") List names +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java new file mode 100644 index 000000000..24404eee4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsEnableParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Plugin names (or specs) to enable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsEnableParams( + /** Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API. */ + @JsonProperty("names") List names +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java new file mode 100644 index 000000000..87c29cbc5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Plugin source and optional working directory for relative-path resolution. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsInstallParams( + /** Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result. */ + @JsonProperty("source") String source, + /** Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. */ + @JsonProperty("workingDirectory") String workingDirectory +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java new file mode 100644 index 000000000..82152cfe4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsInstallResult.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of installing a plugin. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsInstallResult( + /** The newly installed plugin's metadata */ + @JsonProperty("plugin") InstalledPluginInfo plugin, + /** Number of skills discovered and installed from the plugin */ + @JsonProperty("skillsInstalled") Long skillsInstalled, + /** Optional post-install message provided by the plugin (e.g. setup instructions) */ + @JsonProperty("postInstallMessage") String postInstallMessage, + /** Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. */ + @JsonProperty("deprecationWarning") String deprecationWarning +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java new file mode 100644 index 000000000..e0f46b63e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsListResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Plugins installed in user/global state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsListResult( + /** Installed plugins */ + @JsonProperty("plugins") List plugins +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java new file mode 100644 index 000000000..f4d00d7c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Marketplace source and optional working directory for relative-path resolution. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesAddParams( + /** Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL (user@host:path), or a local path. The marketplace's own name (from its manifest) is used as the registration key. */ + @JsonProperty("source") String source, + /** Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. */ + @JsonProperty("workingDirectory") String workingDirectory +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java new file mode 100644 index 000000000..2e5145042 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesAddResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering a new marketplace. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesAddResult( + /** Final name of the marketplace as resolved from its manifest */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java new file mode 100644 index 000000000..935e1afa2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Name of the marketplace whose plugin catalog to fetch. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesBrowseParams( + /** Marketplace name to browse */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java new file mode 100644 index 000000000..b10ac9f32 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesBrowseResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Plugins advertised by the marketplace. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesBrowseResult( + /** Plugins advertised by the marketplace */ + @JsonProperty("plugins") List plugins +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java new file mode 100644 index 000000000..450589bad --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesListResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * All registered marketplaces, including built-in defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesListResult( + /** Registered marketplaces */ + @JsonProperty("marketplaces") List marketplaces +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshParams.java new file mode 100644 index 000000000..a390962b5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code plugins.marketplaces.refresh} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesRefreshParams( + /** Marketplace name to refresh. When omitted, every registered marketplace is refreshed. */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java new file mode 100644 index 000000000..d09cdb9d1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRefreshResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Result of refreshing one or more marketplace catalogs. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesRefreshResult( + /** Per-marketplace refresh results in deterministic order. */ + @JsonProperty("results") List results +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java new file mode 100644 index 000000000..c29533e3f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Name of the marketplace to remove and an optional force flag. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesRemoveParams( + /** Marketplace name to remove */ + @JsonProperty("name") String name, + /** When true, also uninstall every plugin sourced from this marketplace. When false (default), removal is a no-op if any plugin from this marketplace is installed and the dependent plugin names are returned in the result. */ + @JsonProperty("force") Boolean force +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java new file mode 100644 index 000000000..d4c74ec35 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsMarketplacesRemoveResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Outcome of the remove attempt, including dependent-plugin info when applicable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsMarketplacesRemoveResult( + /** True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. */ + @JsonProperty("removed") Boolean removed, + /** Names of installed plugins that prevented removal. Populated only when `removed=false`. */ + @JsonProperty("dependentPlugins") List dependentPlugins +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java new file mode 100644 index 000000000..fb1fbeb8c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUninstallParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Name (or spec) of the plugin to uninstall. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsUninstallParams( + /** Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. */ + @JsonProperty("name") String name, + /** Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. */ + @JsonProperty("directSourceId") String directSourceId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java new file mode 100644 index 000000000..432eb8196 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateAllResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Result of updating all installed plugins. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsUpdateAllResult( + /** Per-plugin update results in deterministic order. */ + @JsonProperty("results") List results +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java new file mode 100644 index 000000000..58d105432 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Name (or spec) of the plugin to update. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsUpdateParams( + /** Plugin name or "plugin@marketplace" spec to update. */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java new file mode 100644 index 000000000..e07f97791 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/PluginsUpdateResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of updating a single plugin. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record PluginsUpdateResult( + /** Version that was previously installed, when available */ + @JsonProperty("previousVersion") String previousVersion, + /** Version after the update, when reported by the plugin manifest */ + @JsonProperty("newVersion") String newVersion, + /** Number of skills discovered and installed after the update */ + @JsonProperty("skillsInstalled") Long skillsInstalled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java new file mode 100644 index 000000000..ee21c07d1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfig.java @@ -0,0 +1,54 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Custom model-provider configuration (BYOK). + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderConfig( + /** Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. */ + @JsonProperty("type") ProviderConfigType type, + /** Wire API format (openai/azure only). Defaults to "completions". */ + @JsonProperty("wireApi") ProviderConfigWireApi wireApi, + /** Provider transport. Defaults to "http". */ + @JsonProperty("transport") ProviderConfigTransport transport, + /** API endpoint URL. */ + @JsonProperty("baseUrl") String baseUrl, + /** API key. Optional for local providers like Ollama. */ + @JsonProperty("apiKey") String apiKey, + /** Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. */ + @JsonProperty("bearerToken") String bearerToken, + /** Azure-specific provider options. */ + @JsonProperty("azure") ProviderConfigAzure azure, + /** Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model. */ + @JsonProperty("modelId") String modelId, + /** The model identifier sent to the provider API for inference (the "wire" model), as opposed to modelId which is the well-known base. */ + @JsonProperty("wireModel") String wireModel, + /** Maximum prompt/input tokens for the model. */ + @JsonProperty("maxPromptTokens") Double maxPromptTokens, + /** Maximum context window tokens for the model. */ + @JsonProperty("maxContextWindowTokens") Double maxContextWindowTokens, + /** Maximum output tokens for the model. */ + @JsonProperty("maxOutputTokens") Double maxOutputTokens, + /** Custom HTTP headers to include in all outbound requests to the provider. */ + @JsonProperty("headers") Map headers, + /** When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. */ + @JsonProperty("hasBearerTokenProvider") Boolean hasBearerTokenProvider +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java new file mode 100644 index 000000000..02653c657 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigAzure.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Azure-specific provider options. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderConfigAzure( + /** API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. */ + @JsonProperty("apiVersion") String apiVersion +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java new file mode 100644 index 000000000..f0f32c078 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigTransport.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Provider transport. Defaults to "http". + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderConfigTransport { + /** The {@code http} variant. */ + HTTP("http"), + /** The {@code websockets} variant. */ + WEBSOCKETS("websockets"); + + private final String value; + ProviderConfigTransport(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderConfigTransport fromValue(String value) { + for (ProviderConfigTransport v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderConfigTransport value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java new file mode 100644 index 000000000..6df0aaccc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigType.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderConfigType { + /** The {@code openai} variant. */ + OPENAI("openai"), + /** The {@code azure} variant. */ + AZURE("azure"), + /** The {@code anthropic} variant. */ + ANTHROPIC("anthropic"); + + private final String value; + ProviderConfigType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderConfigType fromValue(String value) { + for (ProviderConfigType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderConfigType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java new file mode 100644 index 000000000..cf66b3e61 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderConfigWireApi.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Wire API format (openai/azure only). Defaults to "completions". + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderConfigWireApi { + /** The {@code completions} variant. */ + COMPLETIONS("completions"), + /** The {@code responses} variant. */ + RESPONSES("responses"); + + private final String value; + ProviderConfigWireApi(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderConfigWireApi fromValue(String value) { + for (ProviderConfigWireApi v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderConfigWireApi value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java new file mode 100644 index 000000000..ef0e20348 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointTransport.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Transport to be used for provider requests. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderEndpointTransport { + /** The {@code http} variant. */ + HTTP("http"), + /** The {@code websockets} variant. */ + WEBSOCKETS("websockets"); + + private final String value; + ProviderEndpointTransport(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderEndpointTransport fromValue(String value) { + for (ProviderEndpointTransport v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderEndpointTransport value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java new file mode 100644 index 000000000..1d4c377bb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointType.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Provider family. Matches the `type` field of a BYOK provider config. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderEndpointType { + /** The {@code openai} variant. */ + OPENAI("openai"), + /** The {@code azure} variant. */ + AZURE("azure"), + /** The {@code anthropic} variant. */ + ANTHROPIC("anthropic"); + + private final String value; + ProviderEndpointType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderEndpointType fromValue(String value) { + for (ProviderEndpointType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderEndpointType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java new file mode 100644 index 000000000..72a5c4d61 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderEndpointWireApi.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Wire API to be used, when required for the provider type. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ProviderEndpointWireApi { + /** The {@code completions} variant. */ + COMPLETIONS("completions"), + /** The {@code responses} variant. */ + RESPONSES("responses"); + + private final String value; + ProviderEndpointWireApi(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ProviderEndpointWireApi fromValue(String value) { + for (ProviderEndpointWireApi v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ProviderEndpointWireApi value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java new file mode 100644 index 000000000..c9f2630ed --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderModelConfig.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A BYOK model definition referencing a named provider. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderModelConfig( + /** Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified `provider/id`. */ + @JsonProperty("id") String id, + /** Name of the NamedProviderConfig that serves this model. */ + @JsonProperty("provider") String provider, + /** The model name sent to the provider API for inference. Defaults to `id`. */ + @JsonProperty("wireModel") String wireModel, + /** Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. */ + @JsonProperty("modelId") String modelId, + /** Display name for model pickers. Defaults to the provider-qualified selection id (`provider/id`). */ + @JsonProperty("name") String name, + /** Maximum prompt/input tokens for the model. */ + @JsonProperty("maxPromptTokens") Double maxPromptTokens, + /** Maximum context window tokens for the model. */ + @JsonProperty("maxContextWindowTokens") Double maxContextWindowTokens, + /** Maximum output tokens for the model. */ + @JsonProperty("maxOutputTokens") Double maxOutputTokens, + /** Optional capability overrides (vision, tool_calls, reasoning, etc.). */ + @JsonProperty("capabilities") ModelCapabilitiesOverride capabilities +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java new file mode 100644 index 000000000..0ca81941a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderSessionToken.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderSessionToken( + /** The short-lived token value. */ + @JsonProperty("token") String token, + /** HTTP header name the token must be sent under. */ + @JsonProperty("header") String header, + /** The model the token is bound to, when applicable. When set, the token is only valid for requests against this model. */ + @JsonProperty("model") String model, + /** When the token expires, if known. Callers should refresh by calling `getEndpoint` again before this time, or reactively on any 401/403 response from `baseUrl`. */ + @JsonProperty("expiresAt") OffsetDateTime expiresAt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java new file mode 100644 index 000000000..a3e3cad7e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderTokenGetTokenParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the BYOK provider needing a token. For the legacy whole-session `provider` this is the implicit provider name; for named providers it is `NamedProviderConfig.name`. */ + @JsonProperty("providerName") String providerName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java new file mode 100644 index 000000000..a2a0acd6a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ProviderTokenGetTokenResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ProviderTokenGetTokenResult( + /** The bearer token value (without the `Bearer ` prefix). */ + @JsonProperty("token") String token +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueueInsertMessage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueueInsertMessage.java new file mode 100644 index 000000000..d1056f872 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueueInsertMessage.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Serializable message fields accepted by queue.insertAt. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record QueueInsertMessage( + /** The user message text. */ + @JsonProperty("prompt") String prompt, + /** Optional user-facing display text. */ + @JsonProperty("displayPrompt") String displayPrompt, + /** Optional attachments for the message. */ + @JsonProperty("attachments") List attachments, + /** Optional explicit agent mode. When omitted, the session's current mode is assigned. */ + @JsonProperty("agentMode") SendAgentMode agentMode, + /** Optional provenance source. `system` is rejected: it would hide the inserted row from `pendingItems` and make it unaddressable while still executing, so inserted items must stay visible. */ + @JsonProperty("source") String source, + /** Whether the message is billable. */ + @JsonProperty("billable") Boolean billable, + /** Required tool name for the turn, when any. */ + @JsonProperty("requiredTool") String requiredTool, + /** Per-turn request headers. */ + @JsonProperty("requestHeaders") Map requestHeaders, + /** Accepted for SendOptions compatibility but ignored; inserted items always use queued delivery semantics. */ + @JsonProperty("mode") SendMode mode, + /** Accepted for SendOptions compatibility but ignored; the requested public position controls placement. */ + @JsonProperty("prepend") Boolean prepend, + /** Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state. */ + @JsonProperty("wait") Boolean wait_, + /** Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity. */ + @JsonProperty("delivery") String delivery +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java new file mode 100644 index 000000000..f3b2f9918 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record QueuePendingItems( + /** Stable opaque id for the canonical queued item. Batch rows share one id. */ + @JsonProperty("id") String id, + /** Whether this item is a queued user message or a queued slash command / model change */ + @JsonProperty("kind") QueuePendingItemsKind kind, + /** Human-readable text to display for this queue entry in the UI */ + @JsonProperty("displayText") String displayText, + /** Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an explicit mode report interactive. This is not necessarily the mode that will constrain the turn: a plan or autopilot session applies its own write gate, continuation loop and permission posture to every drained item regardless of the mode stored here. */ + @JsonProperty("agentMode") SendAgentMode agentMode +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItemsKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItemsKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItemsKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItemsKind.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ReasoningSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ReasoningSummary.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ReasoningSummary.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ReasoningSummary.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java new file mode 100644 index 000000000..e65184802 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfig.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Configuration for the runtime-managed remote-control singleton. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RemoteControlConfig( + /** Whether remote export should be enabled. */ + @JsonProperty("remote") Boolean remote, + /** Whether the MC session may steer the local session (write mode). */ + @JsonProperty("steerable") Boolean steerable, + /** Whether the user explicitly requested remote (vs. implicit session-sync). Controls warning surfacing for missing-repo cases. */ + @JsonProperty("explicit") Boolean explicit, + /** When true, suppresses timeline messages on successful setup. */ + @JsonProperty("silent") Boolean silent, + /** Existing Mission Control task ID to attach the exported session to. */ + @JsonProperty("taskId") String taskId, + /** Reattach to an existing MC session without creating a new one. */ + @JsonProperty("existingMcSession") RemoteControlConfigExistingMcSession existingMcSession +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java new file mode 100644 index 000000000..6bea2c133 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteControlConfigExistingMcSession.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Reattach to an existing MC session without creating a new one. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RemoteControlConfigExistingMcSession( + /** Existing MC session ID to reattach to. */ + @JsonProperty("mcSessionId") String mcSessionId, + /** Existing MC task ID for the reattached session. */ + @JsonProperty("mcTaskId") String mcTaskId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java new file mode 100644 index 000000000..c5fce60b3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataRepository.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * GitHub repository the remote session belongs to. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RemoteSessionMetadataRepository( + /** Repository owner. */ + @JsonProperty("owner") String owner, + /** Repository name. */ + @JsonProperty("name") String name, + /** Branch associated with the remote session. */ + @JsonProperty("branch") String branch +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java new file mode 100644 index 000000000..062b43e7f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataTaskType.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Whether the remote task originated from CCA or CLI `--remote`. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum RemoteSessionMetadataTaskType { + /** The {@code cca} variant. */ + CCA("cca"), + /** The {@code cli} variant. */ + CLI("cli"); + + private final String value; + RemoteSessionMetadataTaskType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static RemoteSessionMetadataTaskType fromValue(String value) { + for (RemoteSessionMetadataTaskType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown RemoteSessionMetadataTaskType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java new file mode 100644 index 000000000..46f1077d9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMetadataValue.java @@ -0,0 +1,54 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RemoteSessionMetadataValue( + /** Stable session identifier. */ + @JsonProperty("sessionId") String sessionId, + /** Session creation time as an ISO 8601 timestamp. */ + @JsonProperty("startTime") String startTime, + /** Last-modified time as an ISO 8601 timestamp. */ + @JsonProperty("modifiedTime") String modifiedTime, + /** Short summary of the session, when one has been derived. */ + @JsonProperty("summary") String summary, + /** Optional human-friendly name set via /rename. */ + @JsonProperty("name") String name, + /** Always true for remote sessions. */ + @JsonProperty("isRemote") Boolean isRemote, + /** Most recent working directory context. */ + @JsonProperty("context") SessionContext context, + /** GitHub repository the remote session belongs to. */ + @JsonProperty("repository") RemoteSessionMetadataRepository repository, + /** Backing remote session IDs (most recent first). */ + @JsonProperty("remoteSessionIds") List remoteSessionIds, + /** Pull request number associated with the session. */ + @JsonProperty("pullRequestNumber") Long pullRequestNumber, + /** Original remote resource identifier (task ID or PR node ID). */ + @JsonProperty("resourceId") String resourceId, + /** Whether the remote task originated from CCA or CLI `--remote`. */ + @JsonProperty("taskType") RemoteSessionMetadataTaskType taskType, + /** Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. */ + @JsonProperty("staleAt") String staleAt, + /** Server-side task state returned by GitHub. */ + @JsonProperty("state") String state +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionRepository.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionRepository.java new file mode 100644 index 000000000..1ab906bb1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RemoteSessionRepository.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Repository context for the remote session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RemoteSessionRepository( + /** Repository owner or organization login. */ + @JsonProperty("owner") String owner, + /** Repository name. */ + @JsonProperty("name") String name, + /** Optional branch associated with the remote session. */ + @JsonProperty("branch") String branch +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java new file mode 100644 index 000000000..eec46d688 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java @@ -0,0 +1,63 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.databind.JavaType; +import com.fasterxml.jackson.databind.JsonNode; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import javax.annotation.processing.Generated; + +/** + * Interface for invoking JSON-RPC methods with typed responses. + *

+ * Implementations delegate to the underlying transport layer + * (e.g., a {@code JsonRpcClient} instance). A method reference is typically the clearest + * way to adapt a generic {@code invoke} method to this interface: + * 

{@code
+ * RpcCaller caller = jsonRpcClient::invoke;
+ * }
+ * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public interface RpcCaller { + + /** + * Invokes a JSON-RPC method and returns a future for the typed response. + * + * @param the expected response type + * @param method the JSON-RPC method name + * @param params the request parameters (may be a {@code Map}, DTO record, or {@code JsonNode}) + * @param resultType the {@link Class} of the expected response type + * @return a {@link CompletableFuture} that completes with the deserialized result + */ + CompletableFuture invoke(String method, Object params, Class resultType); + + /** + * Invokes a JSON-RPC method and returns a future for the typed response. + * + * @param the expected response type + * @param method the JSON-RPC method name + * @param params the request parameters (may be a {@code Map}, DTO record, or {@code JsonNode}) + * @param resultType the Jackson {@link JavaType} of the expected response type + * @return a {@link CompletableFuture} that completes with the deserialized result + */ + default CompletableFuture invoke(String method, Object params, JavaType resultType) { + if (resultType.hasRawClass(Void.class) || resultType.hasRawClass(Void.TYPE)) { + return invoke(method, params, Void.class).thenApply(ignored -> null); + } + return invoke(method, params, JsonNode.class).thenApply(result -> { + try { + return RpcMapper.INSTANCE.readerFor(resultType).readValue(result); + } catch (java.io.IOException e) { + throw new CompletionException(e); + } + }); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RpcMapper.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcMapper.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/RpcMapper.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/RpcMapper.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java new file mode 100644 index 000000000..92e4c401f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/RunOptions.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Options controlling factory invocation. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record RunOptions( + /** Per-invocation resource ceiling overrides. */ + @JsonProperty("limits") FactoryRunLimits limits, + /** Run identifier whose journal and progress should seed this resumed run. */ + @JsonProperty("resumeFromRunId") String resumeFromRunId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java new file mode 100644 index 000000000..d9130eb81 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfig.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Resolved sandbox configuration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfig( + /** Whether sandboxing is enabled for the session. */ + @JsonProperty("enabled") Boolean enabled, + /** User-managed sandbox policy fragment merged into the auto-discovered base policy. */ + @JsonProperty("userPolicy") SandboxConfigUserPolicy userPolicy, + /** Whether to auto-add the current working directory to readwritePaths. Default: true. */ + @JsonProperty("addCurrentWorkingDirectory") Boolean addCurrentWorkingDirectory, + /** Credential-injection capability flags. */ + @JsonProperty("auth") SandboxConfigAuth auth, + /** Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without extra configuration; a relocated CARGO_HOME additionally gets its Cargo lock files granted read-write. Default: true (enabled by default; set to false to opt out). */ + @JsonProperty("allowDevToolAccess") Boolean allowDevToolAccess +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigAuth.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigAuth.java new file mode 100644 index 000000000..4a3612e0b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigAuth.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Credential-injection capability flags applied while the sandbox is enabled. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigAuth( + /** Whether to inject git credentials as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's own helper before the sandbox is applied. Default: false (opt-in). */ + @JsonProperty("git") Boolean git, + /** Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in). */ + @JsonProperty("gh") Boolean gh +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java new file mode 100644 index 000000000..2755261c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicy.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * User-managed sandbox policy fragment merged into the auto-discovered base policy. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicy( + /** Filesystem rules to merge into the base policy. */ + @JsonProperty("filesystem") SandboxConfigUserPolicyFilesystem filesystem, + /** Network rules to merge into the base policy. */ + @JsonProperty("network") SandboxConfigUserPolicyNetwork network, + /** macOS seatbelt options to merge into the base policy. */ + @JsonProperty("seatbelt") SandboxConfigUserPolicySeatbelt seatbelt, + /** Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is absent. */ + @JsonProperty("experimental") SandboxConfigUserPolicyExperimental experimental +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java new file mode 100644 index 000000000..d1cf1f0b2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimental.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Platform-specific experimental policy fields. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicyExperimental( + /** macOS seatbelt experimental options. */ + @JsonProperty("seatbelt") SandboxConfigUserPolicyExperimentalSeatbelt seatbelt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java new file mode 100644 index 000000000..888a50443 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyExperimentalSeatbelt.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * macOS seatbelt experimental options. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicyExperimentalSeatbelt( + /** Whether the macOS seatbelt profile may access the keychain. */ + @JsonProperty("keychainAccess") Boolean keychainAccess +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java new file mode 100644 index 000000000..d5e7612dc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyFilesystem.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Filesystem rules to merge into the base policy. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicyFilesystem( + /** Paths granted read/write access. */ + @JsonProperty("readwritePaths") List readwritePaths, + /** Paths granted read-only access. */ + @JsonProperty("readonlyPaths") List readonlyPaths, + /** Paths explicitly denied. */ + @JsonProperty("deniedPaths") List deniedPaths, + /** Whether to clear the policy when the session exits. */ + @JsonProperty("clearPolicyOnExit") Boolean clearPolicyOnExit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java new file mode 100644 index 000000000..1e56acb53 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetwork.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Network rules to merge into the base policy. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicyNetwork( + /** Whether outbound network traffic is allowed at all. */ + @JsonProperty("allowOutbound") Boolean allowOutbound, + /** Whether traffic to local/loopback addresses is allowed. */ + @JsonProperty("allowLocalNetwork") Boolean allowLocalNetwork, + /** HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. Credentials go in the separate `username`/`password` fields. A credential-free http:// loopback proxy URL is routed through the localhost proxy automatically; an https:// or authenticated loopback URL is used as-is. */ + @JsonProperty("proxy") SandboxConfigUserPolicyNetworkProxy proxy +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetworkProxy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetworkProxy.java new file mode 100644 index 000000000..74ff86919 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicyNetworkProxy.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * HTTP proxy configuration for sandboxed traffic. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicyNetworkProxy( + /** Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is. */ + @JsonProperty("url") String url, + /** Optional username for proxy authentication. Combined with the URL (and `password`) into `user:pass@host` when the sandboxed process routes through the proxy. */ + @JsonProperty("username") String username, + /** Optional password for proxy authentication, combined with the URL at spawn time. The persisted value may be a literal password, a `${secret:…}` reference resolved from the OS keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the sandboxed process routes through the proxy. The /sandbox dialog stores a real password in the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in settings.json); the field is masked in the dialog and redacted by /settings show. */ + @JsonProperty("password") String password +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java new file mode 100644 index 000000000..480b2fb9b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SandboxConfigUserPolicySeatbelt.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * macOS seatbelt-specific options. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SandboxConfigUserPolicySeatbelt( + /** Whether the macOS seatbelt profile may access the keychain. */ + @JsonProperty("keychainAccess") Boolean keychainAccess +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java new file mode 100644 index 000000000..b88a79cca --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ScheduleEntry( + /** Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). */ + @JsonProperty("id") Long id, + /** Interval between scheduled ticks, in milliseconds (relative-interval schedules). */ + @JsonProperty("intervalMs") Long intervalMs, + /** 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. */ + @JsonProperty("cron") String cron, + /** IANA timezone the `cron` expression is evaluated in. */ + @JsonProperty("tz") String tz, + /** Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. */ + @JsonProperty("at") Long at, + /** Prompt text that gets enqueued on every tick. */ + @JsonProperty("prompt") String prompt, + /** Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). */ + @JsonProperty("recurring") Boolean recurring, + /** True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. */ + @JsonProperty("selfPaced") Boolean selfPaced, + /** Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. */ + @JsonProperty("displayPrompt") String displayPrompt, + /** ISO 8601 timestamp when the next tick is scheduled to fire. */ + @JsonProperty("nextRunAt") OffsetDateTime nextRunAt +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java index 364377311..6616a3d6d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Secret values to add to the redaction filter. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java index f6261b638..b2e3251c7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SecretsAddFilterValuesResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Confirmation that the secret values were registered. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SendAgentMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendAgentMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SendAgentMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendAgentMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java new file mode 100644 index 000000000..4a6696c01 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMessageItem.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * A single user message to append to the session as part of a `session.sendMessages` turn + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SendMessageItem( + /** The user message text */ + @JsonProperty("prompt") String prompt, + /** If provided, this is shown in the timeline instead of `prompt` */ + @JsonProperty("displayPrompt") String displayPrompt, + /** Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message */ + @JsonProperty("attachments") List attachments, + /** If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. */ + @JsonProperty("billable") Boolean billable, + /** If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange */ + @JsonProperty("requiredTool") String requiredTool, + /** Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. */ + @JsonProperty("source") String source +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SendMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SendMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SendMode.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java new file mode 100644 index 000000000..a6ecb0554 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java @@ -0,0 +1,98 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code account} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerAccountApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerAccountApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Optional GitHub token used to look up quota for a specific user instead of the global auth context. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getQuota() { + return getQuota(null); + } + + /** + * Optional GitHub token used to look up quota for a specific user instead of the global auth context. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getQuota(AccountGetQuotaParams params) { + return caller.invoke("account.getQuota", params == null ? java.util.Map.of() : params, AccountGetQuotaResult.class); + } + + /** + * Current authentication state + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getCurrentAuth() { + return caller.invoke("account.getCurrentAuth", java.util.Map.of(), AccountGetCurrentAuthResult.class); + } + + /** + * List of all authenticated users + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture> getAllUsers() { + return caller.invoke("account.getAllUsers", java.util.Map.of(), RpcMapper.INSTANCE.getTypeFactory().constructCollectionType(List.class, AccountAllUsers.class)); + } + + /** + * Credentials to store after successful authentication + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture login(AccountLoginParams params) { + return caller.invoke("account.login", params, AccountLoginResult.class); + } + + /** + * User to log out + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture logout(AccountLogoutParams params) { + return caller.invoke("account.logout", params, AccountLogoutResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java index f1a0d4bb5..f398fb2dc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentRegistryApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -31,8 +32,9 @@ public final class ServerAgentRegistryApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ - public CompletableFuture spawn(AgentRegistrySpawnParams params) { - return caller.invoke("agentRegistry.spawn", params, Void.class); + @CopilotExperimental + public CompletableFuture spawn(AgentRegistrySpawnParams params) { + return caller.invoke("agentRegistry.spawn", params, AgentRegistrySpawnResult.class); } } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java new file mode 100644 index 000000000..0c621a362 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerAgentsApi.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code agents} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerAgentsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerAgentsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Optional project paths to include in agent discovery. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture discover(AgentsDiscoverParams params) { + return caller.invoke("agents.discover", params, AgentsDiscoverResult.class); + } + + /** + * Optional project paths to include when enumerating agent discovery directories. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getDiscoveryPaths(AgentsGetDiscoveryPathsParams params) { + return caller.invoke("agents.getDiscoveryPaths", params, AgentsGetDiscoveryPathsResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java new file mode 100644 index 000000000..efa5317ea --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerCommandsApi.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code commands} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerCommandsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerCommandsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Slash commands available in the session, after applying any include/exclude filters. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("commands.list", java.util.Map.of(), CommandsListResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java new file mode 100644 index 000000000..7bc74b441 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerExtensionsApi.java @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code extensions} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerExtensionsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerExtensionsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture discover() { + return caller.invoke("extensions.discover", java.util.Map.of(), ExtensionsDiscoverResult.class); + } + + /** + * Source-qualified extension identifiers to persistently enable for future sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enable(ExtensionsEnableParams params) { + return caller.invoke("extensions.enable", params, Void.class); + } + + /** + * Source-qualified extension identifiers to persistently disable for future sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture disable(ExtensionsDisableParams params) { + return caller.invoke("extensions.disable", params, Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java new file mode 100644 index 000000000..70eb5b021 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerInstructionsApi.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code instructions} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerInstructionsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerInstructionsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Optional project paths to include in instruction discovery. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture discover(InstructionsDiscoverParams params) { + return caller.invoke("instructions.discover", params, InstructionsDiscoverResult.class); + } + + /** + * Optional project paths to include when enumerating instruction discovery targets. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getDiscoveryPaths(InstructionsGetDiscoveryPathsParams params) { + return caller.invoke("instructions.getDiscoveryPaths", params, InstructionsGetDiscoveryPathsResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java new file mode 100644 index 000000000..4b7663f1f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerLlmInferenceApi.java @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code llmInference} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerLlmInferenceApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerLlmInferenceApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Indicates whether the calling client was registered as the LLM inference provider. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setProvider() { + return caller.invoke("llmInference.setProvider", java.util.Map.of(), LlmInferenceSetProviderResult.class); + } + + /** + * Response head. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture httpResponseStart(LlmInferenceHttpResponseStartParams params) { + return caller.invoke("llmInference.httpResponseStart", params, LlmInferenceHttpResponseStartResult.class); + } + + /** + * A response body chunk or terminal error. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture httpResponseChunk(LlmInferenceHttpResponseChunkParams params) { + return caller.invoke("llmInference.httpResponseChunk", params, LlmInferenceHttpResponseChunkResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerManagedSettingsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerManagedSettingsApi.java new file mode 100644 index 000000000..e85b7b987 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerManagedSettingsApi.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code managedSettings} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerManagedSettingsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerManagedSettingsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Validated device-managed settings discovered before a session exists. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture read() { + return caller.invoke("managedSettings.read", java.util.Map.of(), ManagedSettingsReadResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java index 6ff26e80d..b29c27fa4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -31,8 +32,11 @@ public final class ServerMcpApi { /** * Optional working directory used as context for MCP server discovery. + * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture discover(McpDiscoverParams params) { return caller.invoke("mcp.discover", params, McpDiscoverResult.class); } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java new file mode 100644 index 000000000..6d3510f51 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java @@ -0,0 +1,106 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code mcp.config} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerMcpConfigApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerMcpConfigApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * User-configured MCP servers, keyed by server name. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("mcp.config.list", java.util.Map.of(), McpConfigListResult.class); + } + + /** + * MCP server name and configuration to add to user configuration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture add(McpConfigAddParams params) { + return caller.invoke("mcp.config.add", params, Void.class); + } + + /** + * MCP server name and replacement configuration to write to user configuration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture update(McpConfigUpdateParams params) { + return caller.invoke("mcp.config.update", params, Void.class); + } + + /** + * MCP server name to remove from user configuration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture remove(McpConfigRemoveParams params) { + return caller.invoke("mcp.config.remove", params, Void.class); + } + + /** + * MCP server names to enable for new sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enable(McpConfigEnableParams params) { + return caller.invoke("mcp.config.enable", params, Void.class); + } + + /** + * MCP server names to disable for new sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture disable(McpConfigDisableParams params) { + return caller.invoke("mcp.config.disable", params, Void.class); + } + + /** + * Invokes {@code mcp.config.reload}. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload() { + return caller.invoke("mcp.config.reload", java.util.Map.of(), Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java new file mode 100644 index 000000000..0b1497970 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java @@ -0,0 +1,64 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code models} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerModelsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerModelsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Optional GitHub token used to list models for a specific user instead of the global auth context. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return list(null); + } + + /** + * Optional GitHub token used to list models for a specific user instead of the global auth context. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(ModelsListParams params) { + return caller.invoke("models.list", params == null ? java.util.Map.of() : params, ModelsListResult.class); + } + + /** + * The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getBuiltInCatalog() { + return caller.invoke("models.getBuiltInCatalog", java.util.Map.of(), ModelsGetBuiltInCatalogResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java new file mode 100644 index 000000000..20dc6ab15 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsApi.java @@ -0,0 +1,110 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code plugins} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerPluginsApi { + + private final RpcCaller caller; + + /** API methods for the {@code plugins.marketplaces} sub-namespace. */ + public final ServerPluginsMarketplacesApi marketplaces; + + /** @param caller the RPC transport function */ + ServerPluginsApi(RpcCaller caller) { + this.caller = caller; + this.marketplaces = new ServerPluginsMarketplacesApi(caller); + } + + /** + * Plugins installed in user/global state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("plugins.list", java.util.Map.of(), PluginsListResult.class); + } + + /** + * Plugin source and optional working directory for relative-path resolution. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture install(PluginsInstallParams params) { + return caller.invoke("plugins.install", params, PluginsInstallResult.class); + } + + /** + * Name (or spec) of the plugin to uninstall. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture uninstall(PluginsUninstallParams params) { + return caller.invoke("plugins.uninstall", params, Void.class); + } + + /** + * Name (or spec) of the plugin to update. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture update(PluginsUpdateParams params) { + return caller.invoke("plugins.update", params, PluginsUpdateResult.class); + } + + /** + * Result of updating all installed plugins. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture updateAll() { + return caller.invoke("plugins.updateAll", java.util.Map.of(), PluginsUpdateAllResult.class); + } + + /** + * Plugin names (or specs) to enable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enable(PluginsEnableParams params) { + return caller.invoke("plugins.enable", params, Void.class); + } + + /** + * Plugin names (or specs) to disable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture disable(PluginsDisableParams params) { + return caller.invoke("plugins.disable", params, Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java new file mode 100644 index 000000000..e01bbeeec --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerPluginsMarketplacesApi.java @@ -0,0 +1,97 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code plugins.marketplaces} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerPluginsMarketplacesApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerPluginsMarketplacesApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * All registered marketplaces, including built-in defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("plugins.marketplaces.list", java.util.Map.of(), PluginsMarketplacesListResult.class); + } + + /** + * Marketplace source and optional working directory for relative-path resolution. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture add(PluginsMarketplacesAddParams params) { + return caller.invoke("plugins.marketplaces.add", params, PluginsMarketplacesAddResult.class); + } + + /** + * Name of the marketplace to remove and an optional force flag. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture remove(PluginsMarketplacesRemoveParams params) { + return caller.invoke("plugins.marketplaces.remove", params, PluginsMarketplacesRemoveResult.class); + } + + /** + * Name of the marketplace whose plugin catalog to fetch. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture browse(PluginsMarketplacesBrowseParams params) { + return caller.invoke("plugins.marketplaces.browse", params, PluginsMarketplacesBrowseResult.class); + } + + /** + * Optional marketplace name; omit to refresh all. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture refresh() { + return refresh(null); + } + + /** + * Optional marketplace name; omit to refresh all. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture refresh(PluginsMarketplacesRefreshParams params) { + return caller.invoke("plugins.marketplaces.refresh", params == null ? java.util.Map.of() : params, PluginsMarketplacesRefreshResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java new file mode 100644 index 000000000..c01545a18 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java @@ -0,0 +1,125 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * Typed client for server-level RPC methods. + *

+ * Provides strongly-typed access to all server-level API namespaces. + *

+ * Obtain an instance by calling {@code new ServerRpc(caller)}. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerRpc { + + private final RpcCaller caller; + + /** API methods for the {@code models} namespace. */ + public final ServerModelsApi models; + /** API methods for the {@code tools} namespace. */ + public final ServerToolsApi tools; + /** API methods for the {@code account} namespace. */ + public final ServerAccountApi account; + /** API methods for the {@code secrets} namespace. */ + public final ServerSecretsApi secrets; + /** API methods for the {@code mcp} namespace. */ + public final ServerMcpApi mcp; + /** API methods for the {@code extensions} namespace. */ + public final ServerExtensionsApi extensions; + /** API methods for the {@code plugins} namespace. */ + public final ServerPluginsApi plugins; + /** API methods for the {@code skills} namespace. */ + public final ServerSkillsApi skills; + /** API methods for the {@code agents} namespace. */ + public final ServerAgentsApi agents; + /** API methods for the {@code instructions} namespace. */ + public final ServerInstructionsApi instructions; + /** API methods for the {@code commands} namespace. */ + public final ServerCommandsApi commands; + /** API methods for the {@code user} namespace. */ + public final ServerUserApi user; + /** API methods for the {@code managedSettings} namespace. */ + public final ServerManagedSettingsApi managedSettings; + /** API methods for the {@code runtime} namespace. */ + public final ServerRuntimeApi runtime; + /** API methods for the {@code sessionFs} namespace. */ + public final ServerSessionFsApi sessionFs; + /** API methods for the {@code llmInference} namespace. */ + public final ServerLlmInferenceApi llmInference; + /** API methods for the {@code sessions} namespace. */ + public final ServerSessionsApi sessions; + /** API methods for the {@code agentRegistry} namespace. */ + public final ServerAgentRegistryApi agentRegistry; + + /** + * Creates a new server RPC client. + * + * @param caller the RPC transport function (e.g., {@code jsonRpcClient::invoke}) + */ + public ServerRpc(RpcCaller caller) { + this.caller = caller; + this.models = new ServerModelsApi(caller); + this.tools = new ServerToolsApi(caller); + this.account = new ServerAccountApi(caller); + this.secrets = new ServerSecretsApi(caller); + this.mcp = new ServerMcpApi(caller); + this.extensions = new ServerExtensionsApi(caller); + this.plugins = new ServerPluginsApi(caller); + this.skills = new ServerSkillsApi(caller); + this.agents = new ServerAgentsApi(caller); + this.instructions = new ServerInstructionsApi(caller); + this.commands = new ServerCommandsApi(caller); + this.user = new ServerUserApi(caller); + this.managedSettings = new ServerManagedSettingsApi(caller); + this.runtime = new ServerRuntimeApi(caller); + this.sessionFs = new ServerSessionFsApi(caller); + this.llmInference = new ServerLlmInferenceApi(caller); + this.sessions = new ServerSessionsApi(caller); + this.agentRegistry = new ServerAgentRegistryApi(caller); + } + + /** + * Optional message to echo back to the caller. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture ping(PingParams params) { + return caller.invoke("ping", params, PingResult.class); + } + + /** + * Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture connect(ConnectParams params) { + return caller.invoke("connect", params, ConnectResult.class); + } + + /** + * Invokes {@code registerExtensionLaunchProvider}. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture registerExtensionLaunchProvider() { + return caller.invoke("registerExtensionLaunchProvider", java.util.Map.of(), Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java new file mode 100644 index 000000000..e57db7094 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerRuntimeApi.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code runtime} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerRuntimeApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerRuntimeApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Invokes {@code runtime.shutdown}. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture shutdown() { + return caller.invoke("runtime.shutdown", java.util.Map.of(), Void.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java index 800722c85..7f1768781 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSecretsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -27,8 +28,11 @@ public final class ServerSecretsApi { /** * Secret values to add to the redaction filter. + * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture addFilterValues(SecretsAddFilterValuesParams params) { return caller.invoke("secrets.addFilterValues", params, SecretsAddFilterValuesResult.class); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java index 93022becf..5f540897e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionFsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -27,8 +28,11 @@ public final class ServerSessionFsApi { /** * Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. + * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setProvider(SessionFsSetProviderParams params) { return caller.invoke("sessionFs.setProvider", params, SessionFsSetProviderResult.class); } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java new file mode 100644 index 000000000..52481a7d7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java @@ -0,0 +1,396 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code sessions} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerSessionsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerSessionsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Open a session by creating, resuming, attaching, connecting to a remote, or handing off. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture open(SessionsOpenParams params) { + return caller.invoke("sessions.open", params, SessionsOpenResult.class); + } + + /** + * Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture fork(SessionsForkParams params) { + return caller.invoke("sessions.fork", params, SessionsForkResult.class); + } + + /** + * Remote session connection parameters. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture connect(SessionsConnectParams params) { + return caller.invoke("sessions.connect", params, SessionsConnectResult.class); + } + + /** + * Optional source filter, metadata-load limit, and context filter applied to the returned sessions. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return list(null); + } + + /** + * Optional source filter, metadata-load limit, and context filter applied to the returned sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(SessionsListParams params) { + return caller.invoke("sessions.list", params == null ? java.util.Map.of() : params, SessionsListResult.class); + } + + /** + * Session ID whose persisted metadata should be read. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getMetadata(SessionsGetMetadataParams params) { + return caller.invoke("sessions.getMetadata", params, SessionsGetMetadataResult.class); + } + + /** + * Limit for non-empty local session IDs. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listNonEmptySessionIds(SessionsListNonEmptySessionIdsParams params) { + return caller.invoke("sessions.listNonEmptySessionIds", params, SessionsListNonEmptySessionIdsResult.class); + } + + /** + * GitHub task ID to look up. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture findByTaskId(SessionsFindByTaskIdParams params) { + return caller.invoke("sessions.findByTaskId", params, SessionsFindByTaskIdResult.class); + } + + /** + * UUID prefix to resolve to a unique session ID. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture findByPrefix(SessionsFindByPrefixParams params) { + return caller.invoke("sessions.findByPrefix", params, SessionsFindByPrefixResult.class); + } + + /** + * Optional working-directory context used to score session relevance. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getLastForContext(SessionsGetLastForContextParams params) { + return caller.invoke("sessions.getLastForContext", params, SessionsGetLastForContextResult.class); + } + + /** + * Session ID whose event-log file path to compute. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getEventFilePath(SessionsGetEventFilePathParams params) { + return caller.invoke("sessions.getEventFilePath", params, SessionsGetEventFilePathResult.class); + } + + /** + * Map of sessionId -> on-disk size in bytes for each session's workspace directory. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getSizes() { + return caller.invoke("sessions.getSizes", java.util.Map.of(), SessionsGetSizesResult.class); + } + + /** + * Session IDs to test for live in-use locks. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture checkInUse(SessionsCheckInUseParams params) { + return caller.invoke("sessions.checkInUse", params, SessionsCheckInUseResult.class); + } + + /** + * Session ID to look up the persisted remote-steerable flag for. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getPersistedRemoteSteerable(SessionsGetPersistedRemoteSteerableParams params) { + return caller.invoke("sessions.getPersistedRemoteSteerable", params, SessionsGetPersistedRemoteSteerableResult.class); + } + + /** + * Session ID to close. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture close(SessionsCloseParams params) { + return caller.invoke("sessions.close", params, Void.class); + } + + /** + * Session IDs to close, deactivate, and delete from disk. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture bulkDelete(SessionsBulkDeleteParams params) { + return caller.invoke("sessions.bulkDelete", params, SessionsBulkDeleteResult.class); + } + + /** + * Session ID to delete from disk. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture delete(SessionsDeleteParams params) { + return caller.invoke("sessions.delete", params, Void.class); + } + + /** + * Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture pruneOld(SessionsPruneOldParams params) { + return caller.invoke("sessions.pruneOld", params, SessionsPruneOldResult.class); + } + + /** + * Session ID whose pending events should be flushed to disk. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture save(SessionsSaveParams params) { + return caller.invoke("sessions.save", params, Void.class); + } + + /** + * Session ID whose in-use lock should be released. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture releaseLock(SessionsReleaseLockParams params) { + return caller.invoke("sessions.releaseLock", params, Void.class); + } + + /** + * Session metadata records to enrich with summary and context information. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enrichMetadata(SessionsEnrichMetadataParams params) { + return caller.invoke("sessions.enrichMetadata", params, SessionsEnrichMetadataResult.class); + } + + /** + * Active session ID and an optional flag for deferring repo-level hooks until folder trust. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reloadPluginHooks(SessionsReloadPluginHooksParams params) { + return caller.invoke("sessions.reloadPluginHooks", params, Void.class); + } + + /** + * Active session ID whose deferred repo-level hooks should be loaded. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture loadDeferredRepoHooks(SessionsLoadDeferredRepoHooksParams params) { + return caller.invoke("sessions.loadDeferredRepoHooks", params, SessionsLoadDeferredRepoHooksResult.class); + } + + /** + * Manager-wide additional plugins to register; replaces any previously-configured set. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setAdditionalPlugins(SessionsSetAdditionalPluginsParams params) { + return caller.invoke("sessions.setAdditionalPlugins", params, Void.class); + } + + /** + * Session ID whose board entry count should be returned. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getBoardEntryCount(SessionsGetBoardEntryCountParams params) { + return caller.invoke("sessions.getBoardEntryCount", params, SessionsGetBoardEntryCountResult.class); + } + + /** + * Parameters for attaching the remote-control singleton to a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture startRemoteControl(SessionsStartRemoteControlParams params) { + return caller.invoke("sessions.startRemoteControl", params, SessionsStartRemoteControlResult.class); + } + + /** + * Parameters for atomically rebinding the remote-control singleton. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture transferRemoteControl(SessionsTransferRemoteControlParams params) { + return caller.invoke("sessions.transferRemoteControl", params, SessionsTransferRemoteControlResult.class); + } + + /** + * Patch for the singleton's steering state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params) { + return caller.invoke("sessions.setRemoteControlSteering", params, SessionsSetRemoteControlSteeringResult.class); + } + + /** + * Parameters for stopping the remote-control singleton. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture stopRemoteControl() { + return stopRemoteControl(null); + } + + /** + * Parameters for stopping the remote-control singleton. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture stopRemoteControl(SessionsStopRemoteControlParams params) { + return caller.invoke("sessions.stopRemoteControl", params == null ? java.util.Map.of() : params, SessionsStopRemoteControlResult.class); + } + + /** + * Wrapper for the singleton's current status. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getRemoteControlStatus() { + return caller.invoke("sessions.getRemoteControlStatus", java.util.Map.of(), SessionsGetRemoteControlStatusResult.class); + } + + /** + * Params to attach an extension loader's tools to a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture registerExtensionToolsOnSession(SessionsRegisterExtensionToolsOnSessionParams params) { + return caller.invoke("sessions.registerExtensionToolsOnSession", params, SessionsRegisterExtensionToolsOnSessionResult.class); + } + + /** + * Params to attach or detach an in-process ExtensionController delegate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture configureSessionExtensions(SessionsConfigureSessionExtensionsParams params) { + return caller.invoke("sessions.configureSessionExtensions", params, Void.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java similarity index 75% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java index ba02ea28d..b1d409d9d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkill.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `ServerSkill` type. + * Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. * * @since 1.0.0 */ @@ -23,6 +23,8 @@ public record ServerSkill( /** Unique identifier for the skill */ @JsonProperty("name") String name, + /** Canonical slash command name used to invoke the skill, without the leading '/' */ + @JsonProperty("commandName") String commandName, /** Description of what the skill does */ @JsonProperty("description") String description, /** Source location type (e.g., project, personal-copilot, plugin, builtin) */ @@ -34,6 +36,8 @@ public record ServerSkill( /** Absolute path to the skill file */ @JsonProperty("path") String path, /** The project path this skill belongs to (only for project/inherited skills) */ - @JsonProperty("projectPath") String projectPath + @JsonProperty("projectPath") String projectPath, + /** Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field */ + @JsonProperty("argumentHint") String argumentHint ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java new file mode 100644 index 000000000..a7328dd56 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java @@ -0,0 +1,55 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code skills} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerSkillsApi { + + private final RpcCaller caller; + + /** API methods for the {@code skills.config} sub-namespace. */ + public final ServerSkillsConfigApi config; + + /** @param caller the RPC transport function */ + ServerSkillsApi(RpcCaller caller) { + this.caller = caller; + this.config = new ServerSkillsConfigApi(caller); + } + + /** + * Optional project paths and additional skill directories to include in discovery. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture discover(SkillsDiscoverParams params) { + return caller.invoke("skills.discover", params, SkillsDiscoverResult.class); + } + + /** + * Optional project paths to enumerate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getDiscoveryPaths(SkillsGetDiscoveryPathsParams params) { + return caller.invoke("skills.getDiscoveryPaths", params, SkillsGetDiscoveryPathsResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java index e552227cc..688288a11 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsConfigApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -27,8 +28,11 @@ public final class ServerSkillsConfigApi { /** * Skill names to mark as disabled in global configuration, replacing any previous list. + * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setDisabledSkills(SkillsConfigSetDisabledSkillsParams params) { return caller.invoke("skills.config.setDisabledSkills", params, Void.class); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java index 10e64747e..293801001 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerToolsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -27,8 +28,11 @@ public final class ServerToolsApi { /** * Optional model identifier whose tool overrides should be applied to the listing. + * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list(ToolsListParams params) { return caller.invoke("tools.list", params, ToolsListResult.class); } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java new file mode 100644 index 000000000..e80155f95 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserApi.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code user} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerUserApi { + + private final RpcCaller caller; + + /** API methods for the {@code user.settings} sub-namespace. */ + public final ServerUserSettingsApi settings; + + /** @param caller the RPC transport function */ + ServerUserApi(RpcCaller caller) { + this.caller = caller; + this.settings = new ServerUserSettingsApi(caller); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java new file mode 100644 index 000000000..665cfb107 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ServerUserSettingsApi.java @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code user.settings} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class ServerUserSettingsApi { + + private final RpcCaller caller; + + /** @param caller the RPC transport function */ + ServerUserSettingsApi(RpcCaller caller) { + this.caller = caller; + } + + /** + * Invokes {@code user.settings.reload}. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload() { + return caller.invoke("user.settings.reload", java.util.Map.of(), Void.class); + } + + /** + * Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture get() { + return caller.invoke("user.settings.get", java.util.Map.of(), UserSettingsGetResult.class); + } + + /** + * Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture set(UserSettingsSetParams params) { + return caller.invoke("user.settings.set", params, UserSettingsSetResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java index 4738643b8..440b5cf0f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Parameters for aborting the current turn * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java index 9d75b5db5..d57b1ad43 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAbortResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Result of aborting the current turn * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java new file mode 100644 index 000000000..d2499fe3a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java @@ -0,0 +1,127 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code agent} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionAgentApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionAgentApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Controls whether built-in agents and authored prompt text are included. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return list(null); + } + + /** + * Controls whether built-in agents and authored prompt text are included. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(SessionAgentListParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.agent.list", _p, SessionAgentListResult.class); + } + + /** + * An in-memory authored prompt override for an available agent. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setPrompt(SessionAgentSetPromptParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.agent.setPrompt", _p, Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getCurrent() { + return caller.invoke("session.agent.getCurrent", java.util.Map.of("sessionId", this.sessionId), SessionAgentGetCurrentResult.class); + } + + /** + * Name of the custom agent to select for subsequent turns. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture select(SessionAgentSelectParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.agent.select", _p, SessionAgentSelectResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture deselect() { + return caller.invoke("session.agent.deselect", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload() { + return caller.invoke("session.agent.reload", java.util.Map.of("sessionId", this.sessionId), SessionAgentReloadResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java index 1b1094713..fac0acab6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java index 59774974f..0565cc799 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java index d4dfe25b4..1305fe8b1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentGetCurrentResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The currently selected custom agent, or null when using the default agent. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java new file mode 100644 index 000000000..00743cff6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.agent.list} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionAgentListParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. */ + @JsonProperty("includeBuiltInAgents") Boolean includeBuiltInAgents, + /** When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. */ + @JsonProperty("includePrompt") Boolean includePrompt +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java index d7cdd1127..3eefc2fd8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListResult.java @@ -10,19 +10,22 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** - * Custom agents available to the session. + * Agents available to the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionAgentListResult( - /** Available custom agents */ + /** Available agents */ @JsonProperty("agents") List agents ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java index c3467c5e9..43989eb69 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java index 47eec9eae..3cef04c38 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentReloadResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Custom agents available to the session after reloading definitions from disk. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java index 372d1d1f6..52fe5966e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Name of the custom agent to select for subsequent turns. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java index 927352e2d..b593bb03a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSelectResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The newly selected custom agent. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSetPromptParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSetPromptParams.java new file mode 100644 index 000000000..4395a195e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionAgentSetPromptParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * An in-memory authored prompt override for an available agent. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionAgentSetPromptParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Stable effective agent id. Plugin namespace separators are normalized. */ + @JsonProperty("id") String id, + /** Replacement authored prompt. Empty text is valid. */ + @JsonProperty("prompt") String prompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java new file mode 100644 index 000000000..0851f331e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCancelAllBackgroundAgentsParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCancelAllBackgroundAgentsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java new file mode 100644 index 000000000..8c6ce4b79 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionApi.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code canvas.action} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCanvasActionApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionCanvasActionApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Canvas action invocation parameters. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture invoke(SessionCanvasActionInvokeParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.canvas.action.invoke", _p, SessionCanvasActionInvokeResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java new file mode 100644 index 000000000..fc793b2cd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Canvas action invocation parameters. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCanvasActionInvokeParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Open canvas instance identifier */ + @JsonProperty("instanceId") String instanceId, + /** Action name to invoke */ + @JsonProperty("actionName") String actionName, + /** Action input */ + @JsonProperty("input") Object input +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java new file mode 100644 index 000000000..06a59b99c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasActionInvokeResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Canvas action invocation result. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCanvasActionInvokeResult( + /** Provider-supplied action result */ + @JsonProperty("result") Object result +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java similarity index 81% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java index 8388c82a2..88a320e0b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -23,10 +24,14 @@ public final class SessionCanvasApi { private final RpcCaller caller; private final String sessionId; + /** API methods for the {@code canvas.action} sub-namespace. */ + public final SessionCanvasActionApi action; + /** @param caller the RPC transport function */ SessionCanvasApi(RpcCaller caller, String sessionId) { this.caller = caller; this.sessionId = sessionId; + this.action = new SessionCanvasActionApi(caller, sessionId); } /** @@ -35,6 +40,7 @@ public final class SessionCanvasApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { return caller.invoke("session.canvas.list", java.util.Map.of("sessionId", this.sessionId), SessionCanvasListResult.class); } @@ -45,6 +51,7 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture listOpen() { return caller.invoke("session.canvas.listOpen", java.util.Map.of("sessionId", this.sessionId), SessionCanvasListOpenResult.class); } @@ -58,6 +65,7 @@ public CompletableFuture listOpen() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture open(SessionCanvasOpenParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -73,25 +81,11 @@ public CompletableFuture open(SessionCanvasOpenParams p * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture close(SessionCanvasCloseParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); return caller.invoke("session.canvas.close", _p, Void.class); } - /** - * Canvas action invocation parameters. - *

- * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture invokeAction(SessionCanvasInvokeActionParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.canvas.invokeAction", _p, SessionCanvasInvokeActionResult.class); - } - } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java index d87e83770..aee10a5fa 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasCloseParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Canvas close parameters. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java index 6015d9bd6..2db1397cc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java index f9af151e2..852a85f94 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListOpenResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Live open-canvas snapshot. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java index d49d90e6c..2a87236a6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java index a4d33998a..5ece51566 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Declared canvases available in this session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java index 8b56ad50a..607267f3f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Canvas open parameters. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java index 38f3a5f55..7678d1d6a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasOpenResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Open canvas instance snapshot. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -29,6 +32,8 @@ public record SessionCanvasOpenResult( @JsonProperty("extensionName") String extensionName, /** Provider-local canvas identifier */ @JsonProperty("canvasId") String canvasId, + /** Host-local PNG path for the canvas icon, when supplied */ + @JsonProperty("icon") String icon, /** Rendered title */ @JsonProperty("title") String title, /** Provider-supplied status text */ @@ -36,10 +41,6 @@ public record SessionCanvasOpenResult( /** URL for web-rendered canvases */ @JsonProperty("url") String url, /** Input supplied when the instance was opened */ - @JsonProperty("input") Object input, - /** Whether this snapshot came from an idempotent reopen */ - @JsonProperty("reopen") Boolean reopen, - /** Runtime-controlled routing state for an open canvas instance. */ - @JsonProperty("availability") CanvasInstanceAvailability availability + @JsonProperty("input") Object input ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java new file mode 100644 index 000000000..3611b0680 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCapability.java @@ -0,0 +1,53 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Session capability enabled for this session + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionCapability { + /** The {@code tui-hints} variant. */ + TUI_HINTS("tui-hints"), + /** The {@code plan-mode} variant. */ + PLAN_MODE("plan-mode"), + /** The {@code memory} variant. */ + MEMORY("memory"), + /** The {@code cli-documentation} variant. */ + CLI_DOCUMENTATION("cli-documentation"), + /** The {@code ask-user} variant. */ + ASK_USER("ask-user"), + /** The {@code interactive-mode} variant. */ + INTERACTIVE_MODE("interactive-mode"), + /** The {@code system-notifications} variant. */ + SYSTEM_NOTIFICATIONS("system-notifications"), + /** The {@code elicitation} variant. */ + ELICITATION("elicitation"), + /** The {@code session-store} variant. */ + SESSION_STORE("session-store"), + /** The {@code mcp-apps} variant. */ + MCP_APPS("mcp-apps"), + /** The {@code canvas-renderer} variant. */ + CANVAS_RENDERER("canvas-renderer"); + + private final String value; + SessionCapability(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionCapability fromValue(String value) { + for (SessionCapability v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionCapability value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java index b0bc291e6..facb3fcfc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -31,12 +32,31 @@ public final class SessionCommandsApi { /** * Optional filters controlling which command sources to include in the listing. + *

+ * Invokes the method with no params, applying the runtime defaults. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { - return caller.invoke("session.commands.list", java.util.Map.of("sessionId", this.sessionId), SessionCommandsListResult.class); + return list(null); + } + + /** + * Optional filters controlling which command sources to include in the listing. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(SessionCommandsListParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.commands.list", _p, SessionCommandsListResult.class); } /** @@ -48,10 +68,11 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ - public CompletableFuture invoke(SessionCommandsInvokeParams params) { + @CopilotExperimental + public CompletableFuture invoke(SessionCommandsInvokeParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); - return caller.invoke("session.commands.invoke", _p, Void.class); + return caller.invoke("session.commands.invoke", _p, SlashCommandInvocationResult.class); } /** @@ -63,6 +84,7 @@ public CompletableFuture invoke(SessionCommandsInvokeParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingCommand(SessionCommandsHandlePendingCommandParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -78,6 +100,7 @@ public CompletableFuture handlePendin * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture execute(SessionCommandsExecuteParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -93,6 +116,7 @@ public CompletableFuture execute(SessionCommandsEx * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture enqueue(SessionCommandsEnqueueParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -108,6 +132,7 @@ public CompletableFuture enqueue(SessionCommandsEn * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java index f4ca14dfa..d7725bc9c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Slash-prefixed command string to enqueue for FIFO processing. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java index 649f01ca4..aee75dddb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsEnqueueResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the command was accepted into the local execution queue. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java index f88ac4c03..08abe2d2d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Slash command name and argument string to execute synchronously. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java index 1b1c44299..f1461395a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsExecuteResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Error message produced while executing the command, if any. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java index 9b9c12514..c9a871b08 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Pending command request ID and an optional error if the client handler failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java index 9e3698702..f4cb5b843 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsHandlePendingCommandResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the pending client-handled command was completed successfully. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java index 21d92ebab..01d948825 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsInvokeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Slash command name and optional raw input string to invoke. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java new file mode 100644 index 000000000..0e2dd73aa --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.commands.list} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCommandsListParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Include runtime built-in commands */ + @JsonProperty("includeBuiltins") Boolean includeBuiltins, + /** Include enabled user-invocable skills and commands */ + @JsonProperty("includeSkills") Boolean includeSkills, + /** Include commands registered by protocol clients, including SDK clients and extensions */ + @JsonProperty("includeClientCommands") Boolean includeClientCommands +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java index 8d532352a..7945d0409 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Slash commands available in the session, after applying any include/exclude filters. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java index 22b89f364..234d06f0c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java index 1cc396139..607d8060a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the queued-command response was matched to a pending request. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java new file mode 100644 index 000000000..107e43d64 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionItem.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` (UTF-16 code units) in the composer with `insertText`; when the range is absent, the active token around the cursor is replaced. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCompletionItem( + /** Text spliced into the composer when the item is accepted. */ + @JsonProperty("insertText") String insertText, + /** Start of the replacement range in `text`, in UTF-16 code units. */ + @JsonProperty("rangeStart") Long rangeStart, + /** End (exclusive) of the replacement range in `text`, in UTF-16 code units. */ + @JsonProperty("rangeEnd") Long rangeEnd, + /** Primary display label for the picker row. Falls back to `insertText` when absent. */ + @JsonProperty("label") String label, + /** Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. */ + @JsonProperty("kind") String kind +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java new file mode 100644 index 000000000..6b9d8aa25 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsApi.java @@ -0,0 +1,60 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code completions} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionCompletionsApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionCompletionsApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getTriggerCharacters() { + return caller.invoke("session.completions.getTriggerCharacters", java.util.Map.of("sessionId", this.sessionId), SessionCompletionsGetTriggerCharactersResult.class); + } + + /** + * Request host-driven completions for the current composer input. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture request(SessionCompletionsRequestParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.completions.request", _p, SessionCompletionsRequestResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java new file mode 100644 index 000000000..6a40aa402 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCompletionsGetTriggerCharactersParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java new file mode 100644 index 000000000..03c28665e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsGetTriggerCharactersResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCompletionsGetTriggerCharactersResult( + /** Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. */ + @JsonProperty("triggerCharacters") List triggerCharacters +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java new file mode 100644 index 000000000..02ccd7b12 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request host-driven completions for the current composer input. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCompletionsRequestParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The full composed composer input. */ + @JsonProperty("text") String text, + /** Cursor offset within `text`, in UTF-16 code units. */ + @JsonProperty("offset") Long offset +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java new file mode 100644 index 000000000..ff450a8c9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionCompletionsRequestResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionCompletionsRequestResult( + /** Completion items in host-ranked order. */ + @JsonProperty("items") List items +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java new file mode 100644 index 000000000..eb621e6b4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionApi.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code contentExclusion} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionContentExclusionApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionContentExclusionApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Local file system absolute paths within the session working directory to check against its content-exclusion policy. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture checkPaths(SessionContentExclusionCheckPathsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.contentExclusion.checkPaths", _p, SessionContentExclusionCheckPathsResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsParams.java new file mode 100644 index 000000000..0c61f6c91 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Local file system absolute paths within the session working directory to check against its content-exclusion policy. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionContentExclusionCheckPathsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. */ + @JsonProperty("paths") List paths +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsResult.java new file mode 100644 index 000000000..956ffc44d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContentExclusionCheckPathsResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionContentExclusionCheckPathsResult( + /** Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded. */ + @JsonProperty("available") Boolean available, + /** Per-path decisions in request order. Empty when available is false. */ + @JsonProperty("checks") List checks +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java index 50376a0f0..12ef324c6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContext.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `SessionContext` type. + * Pre-resolved working-directory context for session startup. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionContextHostType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContextHostType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionContextHostType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionContextHostType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java new file mode 100644 index 000000000..e0ca94374 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugApi.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code debug} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionDebugApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionDebugApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Options for collecting a redacted session debug bundle. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture collectLogs(SessionDebugCollectLogsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.debug.collectLogs", _p, SessionDebugCollectLogsResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java new file mode 100644 index 000000000..2076e2ad7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsParams.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Options for collecting a redacted session debug bundle. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionDebugCollectLogsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Where the redacted bundle should be written. Use `archive` to produce a .tgz, or `directory` to stage redacted files for caller-managed upload/post-processing. */ + @JsonProperty("destination") Object destination, + /** Which built-in session diagnostics to include. Omitted fields default to true. */ + @JsonProperty("include") DebugCollectLogsInclude include, + /** Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape. */ + @JsonProperty("additionalEntries") List additionalEntries +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java new file mode 100644 index 000000000..623792b02 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionDebugCollectLogsResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Result of collecting a redacted debug bundle. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionDebugCollectLogsResult( + /** Destination kind that was written. */ + @JsonProperty("kind") DebugCollectLogsResultKind kind, + /** Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed. */ + @JsonProperty("path") String path, + /** Files included in the redacted bundle. */ + @JsonProperty("entries") List entries, + /** Optional files or directories that could not be included. */ + @JsonProperty("skippedEntries") List skippedEntries +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java index eac102aef..8ad9b3b1f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionEventLogApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture read(SessionEventLogReadParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -50,6 +52,7 @@ public CompletableFuture read(SessionEventLogReadPara * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture tail() { return caller.invoke("session.eventLog.tail", java.util.Map.of("sessionId", this.sessionId), SessionEventLogTailResult.class); } @@ -63,6 +66,7 @@ public CompletableFuture tail() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture registerInterest(SessionEventLogRegisterInterestParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -78,6 +82,7 @@ public CompletableFuture registerInterest * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture releaseInterest(SessionEventLogReleaseInterestParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java new file mode 100644 index 000000000..bbc5abb7c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java @@ -0,0 +1,47 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Cursor, batch size, and optional long-poll/filter parameters for reading session events. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionEventLogReadParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. */ + @JsonProperty("cursor") String cursor, + /** Maximum number of events to return in this batch (1–1000, default 200). */ + @JsonProperty("max") Long max, + /** Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). This applies to forward reads only: a backward read always returns immediately and ignores `waitMs`, because backward paging covers persisted history only while new events append at the tail (the opposite end from a backward page), so no blocking or ephemeral delivery can occur. */ + @JsonProperty("waitMs") Long waitMs, + /** Either '*' to receive all event types, or a non-empty list of event types to receive */ + @JsonProperty("types") Object types, + /** Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. */ + @JsonProperty("agentScope") EventsAgentScope agentScope, + /** Optional non-empty list of subagent identifiers. When provided, only events owned by one of these agents are returned; ownership recognizes the event envelope's agentId plus legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over agentScope. */ + @JsonProperty("agentIds") List agentIds, + /** Direction to page through the session's persisted event history. 'forward' (default) pages from the cursor toward newer events (or from the start of history when no cursor is given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` events, and the returned cursor pages toward OLDER events on subsequent backward reads. Events within a returned batch are always in chronological (oldest-to-newest) order, even for a backward read. Backward reads cover PERSISTED history only; ephemeral events are never returned by a backward read. `direction` selects the INITIAL read only: the returned cursor is self-describing, so a continuation read pages in the cursor's own direction regardless of the `direction` passed alongside it — a forward cursor always pages forward and a backward cursor always pages backward. Pass the direction that matches the cursor to avoid confusion. */ + @JsonProperty("direction") EventsReadDirection direction, + /** When false, skip ephemeral events entirely and return only durable (persisted) events. History-backfill callers that discard ephemerals anyway should set this so the read is bounded by the durable log length instead of racing the ephemeral ring on a busy session. Defaults to true (ephemerals are interleaved with durable events in creation order). Ignored by backward reads, which always cover persisted history only. */ + @JsonProperty("includeEphemeral") Boolean includeEphemeral +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java new file mode 100644 index 000000000..767acc879 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Batch of session events returned by a read, with cursor and continuation metadata. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionEventLogReadResult( + /** Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set `includeEphemeral: false` to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order. */ + @JsonProperty("events") List events, + /** Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing `direction: backward` with it (the cursor is also self-describing, so backward paging continues correctly). */ + @JsonProperty("cursor") String cursor, + /** True when more events are available in the read's direction. For a forward read, true means the batch returned `max` events and more are available immediately. For a backward read, true means older persisted events remain before the returned window. */ + @JsonProperty("hasMore") Boolean hasMore, + /** Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history. For a forward read the fallback starts from the beginning of the remaining history; for a backward read it falls back to the tail (the newest window). Because the fallback page is a fresh boundary snapshot rather than a continuation of the requested cursor, it may overlap events the consumer has already rendered — a backward fallback to the tail in particular can repeat the newest window. On 'expired', consumers should reset or rebase their local pagination state (or deduplicate by event id) before continuing from the returned cursor rather than blindly appending/prepending the fallback page. */ + @JsonProperty("cursorStatus") EventsCursorStatus cursorStatus +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java new file mode 100644 index 000000000..567156cc5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Event type to register consumer interest for, used by runtime gating logic. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionEventLogRegisterInterestParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest is registered the runtime still attempts non-interactive reconnect from cached or refreshable tokens, and only marks the server `needs-auth` if usable credentials are unavailable — it does not open a browser or start interactive OAuth without a consumer). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. */ + @JsonProperty("eventType") String eventType +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java index ac4da49d0..83d9aeddf 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Opaque handle representing an event-type interest registration. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java index 1eea25f44..ac180cd2a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Opaque handle previously returned by `registerInterest` to release. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java index 39cf07afa..8c15e7bb7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReleaseInterestResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java index 3906d7e6e..05e3f6bfe 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java index 1b29827d3..13f359e6b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogTailResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java index 337ba15cc..e21c10968 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -35,6 +36,7 @@ public final class SessionExtensionsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { return caller.invoke("session.extensions.list", java.util.Map.of("sessionId", this.sessionId), SessionExtensionsListResult.class); } @@ -48,6 +50,7 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture enable(SessionExtensionsEnableParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -63,6 +66,7 @@ public CompletableFuture enable(SessionExtensionsEnableParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture disable(SessionExtensionsDisableParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -75,8 +79,25 @@ public CompletableFuture disable(SessionExtensionsDisableParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture reload() { return caller.invoke("session.extensions.reload", java.util.Map.of("sessionId", this.sessionId), Void.class); } + /** + * Parameters for session.extensions.sendAttachmentsToMessage. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture sendAttachmentsToMessage(SessionExtensionsSendAttachmentsToMessageParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.extensions.sendAttachmentsToMessage", _p, Void.class); + } + } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java index f4bf4d5b3..34af17d5b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Source-qualified extension identifier to disable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java index 5e00268af..605488e91 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Source-qualified extension identifier to enable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java index 52f9c08f9..b71711cbe 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java index ba5ea94f1..a46a9e997 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Extensions discovered for the session, with their current status. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java index ceaa990f1..07bd18c1e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java new file mode 100644 index 000000000..b2293a09f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsSendAttachmentsToMessageParams.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Parameters for session.extensions.sendAttachmentsToMessage. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionExtensionsSendAttachmentsToMessageParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment. */ + @JsonProperty("instanceId") String instanceId, + /** Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape. */ + @JsonProperty("attachments") List attachments +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java new file mode 100644 index 000000000..6ab02c27e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for one factory-scoped subagent call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryAgentParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier that owns the subagent. */ + @JsonProperty("factoryRunId") String factoryRunId, + /** Opaque token identifying the current factory execution attempt. */ + @JsonProperty("executionToken") String executionToken, + /** Prompt to send to the subagent. */ + @JsonProperty("prompt") String prompt, + /** Subagent execution options. */ + @JsonProperty("opts") FactoryAgentOptions opts +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java new file mode 100644 index 000000000..dcd31fd34 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryAgentResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of one factory-scoped subagent call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryAgentResult( + /** Agent result, omitted when the agent produced no result. */ + @JsonProperty("result") Object result +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java new file mode 100644 index 000000000..e0628ea3d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryApi.java @@ -0,0 +1,181 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code factory} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFactoryApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** API methods for the {@code factory.journal} sub-namespace. */ + public final SessionFactoryJournalApi journal; + + /** @param caller the RPC transport function */ + SessionFactoryApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + this.journal = new SessionFactoryJournalApi(caller, sessionId); + } + + /** + * Parameters for invoking a registered factory. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture run(SessionFactoryRunParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.run", _p, SessionFactoryRunResult.class); + } + + /** + * Parameters for resuming a factory run from its persisted identity. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture resume(SessionFactoryResumeParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.resume", _p, SessionFactoryResumeResult.class); + } + + /** + * Parameters for retrieving a factory run. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getRun(SessionFactoryGetRunParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.getRun", _p, SessionFactoryGetRunResult.class); + } + + /** + * Parameters for paging factory runs. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listRuns(SessionFactoryListRunsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.listRuns", _p, SessionFactoryListRunsResult.class); + } + + /** + * Parameters for retrieving a factory run. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getRunDetail(SessionFactoryGetRunDetailParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.getRunDetail", _p, SessionFactoryGetRunDetailResult.class); + } + + /** + * Parameters for paging factory progress. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getRunProgress(SessionFactoryGetRunProgressParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.getRunProgress", _p, SessionFactoryGetRunProgressResult.class); + } + + /** + * Parameters for cancelling a factory run. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture cancel(SessionFactoryCancelParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.cancel", _p, SessionFactoryCancelResult.class); + } + + /** + * Parameters for recording factory progress. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture log(SessionFactoryLogParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.log", _p, Void.class); + } + + /** + * Parameters for one factory-scoped subagent call. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture agent(SessionFactoryAgentParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.agent", _p, SessionFactoryAgentResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java new file mode 100644 index 000000000..8ed7e4aa3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for cancelling a factory run. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryCancelParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java new file mode 100644 index 000000000..0cb66280c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryCancelResult.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Complete current or terminal factory run envelope. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryCancelResult( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Current or terminal factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Completed factory result. */ + @JsonProperty("result") Object result, + /** Error message for an errored run. */ + @JsonProperty("error") String error, + /** Machine-readable failure details for an errored run. */ + @JsonProperty("failure") Object failure, + /** Reason for a halted or cancelled run. */ + @JsonProperty("reason") String reason, + /** Partial journal and progress snapshot for a halted, cancelled, or errored run. */ + @JsonProperty("snapshot") Object snapshot +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailParams.java new file mode 100644 index 000000000..b4563d4b3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for retrieving a factory run. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunDetailParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailResult.java new file mode 100644 index 000000000..5da6f4979 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunDetailResult.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Full factory run observability detail. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunDetailResult( + @JsonProperty("runId") String runId, + @JsonProperty("factoryName") String factoryName, + @JsonProperty("description") String description, + @JsonProperty("status") FactoryRunStatus status, + @JsonProperty("revision") Long revision, + @JsonProperty("createdAt") Long createdAt, + @JsonProperty("startedAt") Long startedAt, + @JsonProperty("updatedAt") Long updatedAt, + @JsonProperty("completedAt") Long completedAt, + @JsonProperty("currentPhase") FactoryCurrentPhase currentPhase, + @JsonProperty("declaredPhaseCount") Long declaredPhaseCount, + @JsonProperty("liveAgentCount") Long liveAgentCount, + @JsonProperty("totalSpawnedAgentCount") Long totalSpawnedAgentCount, + @JsonProperty("consumed") FactoryRunConsumed consumed, + @JsonProperty("declaredLimits") FactoryDeclaredLimits declaredLimits, + @JsonProperty("approved") FactoryDeclaredLimits approved, + @JsonProperty("observedAt") Long observedAt, + @JsonProperty("activeSegmentStartedAt") Long activeSegmentStartedAt, + @JsonProperty("terminal") FactoryRunTerminal terminal, + @JsonProperty("phases") List phases, + @JsonProperty("agents") List agents, + @JsonProperty("progress") FactoryProgressPage progress +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java new file mode 100644 index 000000000..f98e1f0d7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for retrieving a factory run. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressParams.java new file mode 100644 index 000000000..8445943cb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressParams.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for paging factory progress. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunProgressParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Optional phase identifier used to scope records and cursors. */ + @JsonProperty("phaseId") String phaseId, + /** Exclusive forward cursor. */ + @JsonProperty("afterSeq") Long afterSeq, + /** Exclusive backward cursor. */ + @JsonProperty("beforeSeq") Long beforeSeq, + /** Maximum records to return. Defaults to 200 and is capped at 500. */ + @JsonProperty("limit") Long limit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressResult.java new file mode 100644 index 000000000..369fa07c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunProgressResult.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * A bidirectional page of factory progress. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunProgressResult( + @JsonProperty("records") List records, + @JsonProperty("oldestSeq") Long oldestSeq, + @JsonProperty("newestSeq") Long newestSeq, + @JsonProperty("hasMoreOlder") Boolean hasMoreOlder, + @JsonProperty("hasMoreNewer") Boolean hasMoreNewer, + /** Run revision reflected by this page. */ + @JsonProperty("revision") Long revision +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java new file mode 100644 index 000000000..6742faf03 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryGetRunResult.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Complete current or terminal factory run envelope. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryGetRunResult( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Current or terminal factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Completed factory result. */ + @JsonProperty("result") Object result, + /** Error message for an errored run. */ + @JsonProperty("error") String error, + /** Machine-readable failure details for an errored run. */ + @JsonProperty("failure") Object failure, + /** Reason for a halted or cancelled run. */ + @JsonProperty("reason") String reason, + /** Partial journal and progress snapshot for a halted, cancelled, or errored run. */ + @JsonProperty("snapshot") Object snapshot +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java new file mode 100644 index 000000000..e5bfb4e66 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalApi.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code factory.journal} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionFactoryJournalApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionFactoryJournalApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Parameters for reading a factory journal entry. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture get(SessionFactoryJournalGetParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.journal.get", _p, SessionFactoryJournalGetResult.class); + } + + /** + * Parameters for storing a factory journal entry. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture put(SessionFactoryJournalPutParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.factory.journal.put", _p, Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java new file mode 100644 index 000000000..251ca946c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for reading a factory journal entry. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryJournalGetParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Opaque token identifying the current factory execution attempt. */ + @JsonProperty("executionToken") String executionToken, + /** Namespaced journal key. */ + @JsonProperty("key") String key +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java new file mode 100644 index 000000000..4b97e1029 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalGetResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of reading a factory journal entry. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryJournalGetResult( + /** Whether the journal contained the requested key. */ + @JsonProperty("hit") Boolean hit, + /** Cached JSON result. The hit field distinguishes a cached JSON null from a miss. */ + @JsonProperty("resultJson") Object resultJson +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java new file mode 100644 index 000000000..06467b265 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryJournalPutParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for storing a factory journal entry. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryJournalPutParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Opaque token identifying the current factory execution attempt. */ + @JsonProperty("executionToken") String executionToken, + /** Namespaced journal key. */ + @JsonProperty("key") String key, + /** JSON result to memoize. */ + @JsonProperty("resultJson") Object resultJson +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsParams.java new file mode 100644 index 000000000..41de4ae4a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for paging factory runs. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryListRunsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Exclusive forward cursor. */ + @JsonProperty("afterSeq") Long afterSeq, + /** Exclusive backward cursor. */ + @JsonProperty("beforeSeq") Long beforeSeq, + /** Maximum terminal runs to return. Defaults to 200 and is capped at 500. */ + @JsonProperty("limit") Long limit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsResult.java new file mode 100644 index 000000000..3a23bc369 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryListRunsResult.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * A page of factory runs in durable creation order. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryListRunsResult( + @JsonProperty("runs") List runs, + /** Oldest terminal-run cursor in this page, or null when the terminal window is empty. */ + @JsonProperty("oldestSeq") Long oldestSeq, + /** Newest terminal-run cursor in this page, or null when the terminal window is empty. */ + @JsonProperty("newestSeq") Long newestSeq, + /** Whether terminal runs newer than this page exist. */ + @JsonProperty("hasMoreNewer") Boolean hasMoreNewer, + /** Number of terminal runs older than this page. */ + @JsonProperty("omittedOlder") Long omittedOlder +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java new file mode 100644 index 000000000..b4f52617f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryLogParams.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Parameters for recording factory progress. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryLogParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Opaque token identifying the current factory execution attempt. */ + @JsonProperty("executionToken") String executionToken, + /** Ordered progress lines to append. */ + @JsonProperty("lines") List lines +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeParams.java new file mode 100644 index 000000000..9c264284f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for resuming a factory run from its persisted identity. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryResumeParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Optional per-invocation resource ceiling overrides. */ + @JsonProperty("limits") FactoryRunLimits limits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeResult.java new file mode 100644 index 000000000..b4cfcae11 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryResumeResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Resolved persisted factory identity and resumed run envelope. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryResumeResult( + /** Persisted factory name resolved for the resumed run. */ + @JsonProperty("factoryName") String factoryName, + /** Terminal resumed run envelope. */ + @JsonProperty("run") FactoryRunResult run +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java new file mode 100644 index 000000000..fd60b9643 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for invoking a registered factory. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryRunParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Registered factory name. */ + @JsonProperty("name") String name, + /** Factory input value. */ + @JsonProperty("args") Object args, + /** Factory invocation options. */ + @JsonProperty("options") RunOptions options +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java new file mode 100644 index 000000000..46083f228 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFactoryRunResult.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Complete current or terminal factory run envelope. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFactoryRunResult( + /** Factory run identifier. */ + @JsonProperty("runId") String runId, + /** Current or terminal factory run status. */ + @JsonProperty("status") FactoryRunStatus status, + /** Completed factory result. */ + @JsonProperty("result") Object result, + /** Error message for an errored run. */ + @JsonProperty("error") String error, + /** Machine-readable failure details for an errored run. */ + @JsonProperty("failure") Object failure, + /** Reason for a halted or cancelled run. */ + @JsonProperty("reason") String reason, + /** Partial journal and progress snapshot for a halted, cancelled, or errored run. */ + @JsonProperty("snapshot") Object snapshot +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java index 27023dc89..183117612 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionFleetApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture start(SessionFleetStartParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java index 5d5e2c88c..c2f0471cd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional user prompt to combine with the fleet orchestration instructions. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java index c89f377d7..5f66277ac 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFleetStartResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether fleet mode was successfully activated. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java index a3db24a0d..1751167ee 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsAppendFileParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * File path, content to append, and optional mode for the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsError.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsError.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsError.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsErrorCode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsErrorCode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsErrorCode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsErrorCode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java index 29b510798..7312db7cd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path to test for existence in the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java index 0068ae3a3..1d305d397 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsExistsResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the requested path exists in the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java index c1ed1aec7..91b1a122a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsMkdirParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java index d040129cc..904e69361 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path of the file to read from the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java index c71e1a514..9dfa9f966 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReadFileResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * File content as a UTF-8 string, or a filesystem error if the read failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java index 00b865c33..beb1e22f6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Directory path whose entries should be listed from the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java index 745118beb..10c50d2f9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Names of entries in the requested directory, or a filesystem error if the read failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java index f4c755951..3afa7fe12 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntry.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `SessionFsReaddirWithTypesEntry` type. + * Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntryType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntryType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntryType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesEntryType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java index a6b80481d..7f1b8b229 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Directory path whose entries (with type information) should be listed from the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java index 3fb693c80..e4d04bbe5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsReaddirWithTypesResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java index 76dbc8cfb..5970138a8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRenameParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Source and destination paths for renaming or moving an entry in the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java index ed50649a3..c40bfe8fd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsRmParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path to remove from the client-provided session filesystem, with options for recursive removal and force. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderCapabilities.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderCapabilities.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderCapabilities.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderCapabilities.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderConventions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderConventions.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderConventions.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderConventions.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java index d99a14862..bcc1d964e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java index 6088729f5..4809f5302 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSetProviderResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the calling client was registered as the session filesystem provider. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java index 1956f804b..00bea41f9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java index 6c1328e9e..841c09d3b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteExistsResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the per-session SQLite database already exists. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java similarity index 84% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java index e489bb122..925863588 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** - * SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. + * SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryResult.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryResult.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteQueryType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionError.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionError.java new file mode 100644 index 000000000..cbe170a29 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionError.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFsSqliteTransactionError( + @JsonProperty("errorClass") SessionFsSqliteTransactionErrorClass errorClass, + @JsonProperty("message") String message +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionErrorClass.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionErrorClass.java new file mode 100644 index 000000000..4e184a19a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionErrorClass.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * SQLite transaction failure classification. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionFsSqliteTransactionErrorClass { + /** The {@code busyOrLocked} variant. */ + BUSYORLOCKED("busyOrLocked"), + /** The {@code fatal} variant. */ + FATAL("fatal"), + /** The {@code postCommitAmbiguous} variant. */ + POSTCOMMITAMBIGUOUS("postCommitAmbiguous"); + + private final String value; + SessionFsSqliteTransactionErrorClass(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionFsSqliteTransactionErrorClass fromValue(String value) { + for (SessionFsSqliteTransactionErrorClass v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionFsSqliteTransactionErrorClass value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionParams.java new file mode 100644 index 000000000..f834d5595 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Statements to execute atomically. Providers apply busy handling for every call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFsSqliteTransactionParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("statements") List statements +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionResult.java new file mode 100644 index 000000000..f9c799b9b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Per-statement results, or a classified transaction error. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFsSqliteTransactionResult( + @JsonProperty("results") List results, + @JsonProperty("error") SessionFsSqliteTransactionError error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionStatement.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionStatement.java new file mode 100644 index 000000000..f56f268ba --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsSqliteTransactionStatement.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * One statement in an atomic SQLite transaction. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionFsSqliteTransactionStatement( + /** SQL statement to execute. */ + @JsonProperty("query") String query, + /** How to execute the statement. */ + @JsonProperty("queryType") SessionFsSqliteQueryType queryType, + /** Optional named bind parameters. */ + @JsonProperty("params") Map params +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java index 2e6ccfdea..324b23c85 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path whose metadata should be returned from the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java index 56d883d10..25663b61c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsStatResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.time.OffsetDateTime; import javax.annotation.processing.Generated; /** * Filesystem metadata for the requested path, or a filesystem error if the stat failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java index 4f4e02636..4004cf4c4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionFsWriteFileParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * File path, content to write, and optional mode for the client-provided session filesystem. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java new file mode 100644 index 000000000..93fb87150 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthApi.java @@ -0,0 +1,60 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code gitHubAuth} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionGitHubAuthApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionGitHubAuthApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getStatus() { + return caller.invoke("session.gitHubAuth.getStatus", java.util.Map.of("sessionId", this.sessionId), SessionGitHubAuthGetStatusResult.class); + } + + /** + * New auth credentials to install on the session. Omit to leave credentials unchanged. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setCredentials(SessionGitHubAuthSetCredentialsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.gitHubAuth.setCredentials", _p, SessionGitHubAuthSetCredentialsResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java new file mode 100644 index 000000000..f959105c9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionGitHubAuthGetStatusParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java new file mode 100644 index 000000000..9357f0079 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthGetStatusResult.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Authentication status and account metadata for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionGitHubAuthGetStatusResult( + /** Whether the session has resolved authentication */ + @JsonProperty("isAuthenticated") Boolean isAuthenticated, + /** Authentication type */ + @JsonProperty("authType") AuthInfoType authType, + /** Authentication host URL */ + @JsonProperty("host") String host, + /** Authenticated login/username, if available */ + @JsonProperty("login") String login, + /** Human-readable authentication status description */ + @JsonProperty("statusMessage") String statusMessage, + /** Copilot plan tier (e.g., individual_pro, business) */ + @JsonProperty("copilotPlan") String copilotPlan +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java new file mode 100644 index 000000000..1d41404d4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * New auth credentials to install on the session. Omit to leave credentials unchanged. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionGitHubAuthSetCredentialsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime installs the supplied value immediately for outbound model/API requests. When the credential carries a raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous install) so plan/quota/billing metadata regains fidelity; on resolution failure the verbatim credential remains installed. It does NOT otherwise validate the credential. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. */ + @JsonProperty("credentials") Object credentials +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java new file mode 100644 index 000000000..50715193a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionGitHubAuthSetCredentialsResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the credential update succeeded. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionGitHubAuthSetCredentialsResult( + /** Whether the operation succeeded */ + @JsonProperty("success") Boolean success, + /** Whether the session ended up with a populated `copilotUser` for the installed credentials. `true` when the supplied credential already carried `copilotUser` or it was successfully re-resolved server-side. `false` when the credential is installed without `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In both `false` cases the token swap still applied, but plan/quota/billing metadata is degraded. Present whenever a credential was supplied; omitted only when no credential was supplied (no-op call). */ + @JsonProperty("copilotUserResolved") Boolean copilotUserResolved +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java index 04749d2b6..f0afbcdd5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java index 7767202d7..3caaad366 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryAbortManualCompactionResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether an in-progress manual compaction was aborted. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java new file mode 100644 index 000000000..ad44d864d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java @@ -0,0 +1,170 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code history} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionHistoryApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionHistoryApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Optional compaction parameters. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture compact() { + return compact(null); + } + + /** + * Optional compaction parameters. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture compact(SessionHistoryCompactParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.history.compact", _p, SessionHistoryCompactResult.class); + } + + /** + * Identifier of the event to truncate to; this event and all later events are removed. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture truncate(SessionHistoryTruncateParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.history.truncate", _p, SessionHistoryTruncateResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listRewindPoints() { + return caller.invoke("session.history.listRewindPoints", java.util.Map.of("sessionId", this.sessionId), SessionHistoryListRewindPointsResult.class); + } + + /** + * Event boundary to preview for conversation-and-files rewind. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture previewRewind(SessionHistoryPreviewRewindParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.history.previewRewind", _p, SessionHistoryPreviewRewindResult.class); + } + + /** + * Boundary and mode for rewinding session history. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture rewind(SessionHistoryRewindParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.history.rewind", _p, SessionHistoryRewindResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture cancelBackgroundCompaction() { + return caller.invoke("session.history.cancelBackgroundCompaction", java.util.Map.of("sessionId", this.sessionId), SessionHistoryCancelBackgroundCompactionResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture abortManualCompaction() { + return caller.invoke("session.history.abortManualCompaction", java.util.Map.of("sessionId", this.sessionId), SessionHistoryAbortManualCompactionResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture summarizeForHandoff() { + return caller.invoke("session.history.summarizeForHandoff", java.util.Map.of("sessionId", this.sessionId), SessionHistorySummarizeForHandoffResult.class); + } + + /** + * Parameters for clearing the conversation and seeding the window that replaces it. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture clearContext(SessionHistoryClearContextParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.history.clearContext", _p, SessionHistoryClearContextResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java index 56adc34ae..19997fdff 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java index c22fdd092..6fb5d7be7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCancelBackgroundCompactionResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether an in-progress background compaction was cancelled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextParams.java new file mode 100644 index 000000000..e52c27ece --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for clearing the conversation and seeding the window that replaces it. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryClearContextParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** First user message of the fresh context window. Required: a cleared window holding only system and developer messages is not a conversation a model can answer, so every clear seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop exits, which is why the call must be made from inside a tool handler. */ + @JsonProperty("prompt") String prompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextResult.java new file mode 100644 index 000000000..4b3d8502c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryClearContextResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryClearContextResult( + /** Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. */ + @JsonProperty("messagesCleared") Long messagesCleared +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java new file mode 100644 index 000000000..d25c80b55 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java @@ -0,0 +1,56 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.history.compact} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryCompactParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Optional user-provided instructions to focus the compaction summary */ + @JsonProperty("customInstructions") String customInstructions, + /** What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). */ + @JsonProperty("trigger") SessionHistoryCompactParamsTrigger trigger, + /** Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. */ + @JsonProperty("tokenLimit") Long tokenLimit +) { + + /** What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). */ + public enum SessionHistoryCompactParamsTrigger { + /** The {@code manual} variant. */ + MANUAL("manual"), + /** The {@code model_switch} variant. */ + MODEL_SWITCH("model_switch"); + + private final String value; + SessionHistoryCompactParamsTrigger(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionHistoryCompactParamsTrigger fromValue(String value) { + for (SessionHistoryCompactParamsTrigger v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionHistoryCompactParamsTrigger value: " + value); + } + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java index 46a52f425..eee3b078c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsParams.java new file mode 100644 index 000000000..d780d76b3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryListRewindPointsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsResult.java new file mode 100644 index 000000000..99dcc0fab --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryListRewindPointsResult.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Rewind points and file-change-tracking availability for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryListRewindPointsResult( + /** Whether this session captured file changes from its first turn. */ + @JsonProperty("fileChangeTrackingEnabled") Boolean fileChangeTrackingEnabled, + /** Why the listed points could not be produced, when applicable; the points list is empty whenever it is set. `unsupported-remote-session` is permanent for the session and comes with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the file-change captures cannot be read while work that may still mutate them is in flight; the same request succeeds once the session settles, so a client that wants points should retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an untracked local session still lists conversation-only points and reports that through `fileChangeTrackingEnabled: false`. */ + @JsonProperty("unavailableReason") HistoryRewindUnavailableReason unavailableReason, + /** Root user turns in chronological order. Empty when `unavailableReason` is set. */ + @JsonProperty("points") List points +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindParams.java new file mode 100644 index 000000000..dd92709e2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Event boundary to preview for conversation-and-files rewind. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryPreviewRewindParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** ID of the user.message event that begins the discarded suffix. */ + @JsonProperty("eventId") String eventId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindResult.java new file mode 100644 index 000000000..976597c4f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryPreviewRewindResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Files and aggregate changes for a prospective rewind. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryPreviewRewindResult( + /** Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. */ + @JsonProperty("available") Boolean available, + /** Why file restore is unavailable, when applicable. Populated only when `available` is false and never set when `available` is true. */ + @JsonProperty("reason") HistoryRewindUnavailableReason reason, + /** Number of unique files in the preview. */ + @JsonProperty("fileCount") Long fileCount, + /** Files ordered by path. */ + @JsonProperty("files") List files +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindParams.java new file mode 100644 index 000000000..bf93f3e24 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Boundary and mode for rewinding session history. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryRewindParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** ID of the user.message event that begins the discarded suffix. */ + @JsonProperty("eventId") String eventId, + /** Whether to rewind only conversation history or also restore captured files. */ + @JsonProperty("mode") HistoryRewindMode mode +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindResult.java new file mode 100644 index 000000000..d069ca992 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryRewindResult.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Structured outcome of a rewind request. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryRewindResult( + /** Overall rewind outcome. This discriminates the result: it governs which of the remaining fields are populated, so consumers must switch on it before reading `eventsRemoved`, `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that populate it. */ + @JsonProperty("outcome") HistoryRewindOutcome outcome, + /** Number of persisted events removed by conversation truncation. Present only when truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`) and for `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. */ + @JsonProperty("eventsRemoved") Long eventsRemoved, + /** Absolute paths restored to their captured preimages. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. */ + @JsonProperty("restoredFiles") List restoredFiles, + /** Captured files intentionally left unchanged. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. */ + @JsonProperty("skippedFiles") List skippedFiles, + /** Failure detail. Set only for the failure and partial-failure outcomes (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`). */ + @JsonProperty("error") String error +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java index 816af2cd1..31eb7ad9c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java index 3723aae25..81536f650 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistorySummarizeForHandoffResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Markdown summary of the conversation context (empty when not available). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java index 70b1331e4..d2905fc4c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the event to truncate to; this event and all later events are removed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java new file mode 100644 index 000000000..f5ae17d62 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Number of events that were removed by the truncation. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionHistoryTruncateResult( + /** Number of events that were removed */ + @JsonProperty("eventsRemoved") Long eventsRemoved, + /** True when conversation truncation succeeded but post-truncation workspace checkpoint cleanup failed. History is already truncated; callers may still prune snapshots but should report a checkpoint-cleanup rather than a truncation failure. */ + @JsonProperty("checkpointCleanupFailed") Boolean checkpointCleanupFailed, + /** Failure detail when checkpointCleanupFailed is true. */ + @JsonProperty("checkpointCleanupError") String checkpointCleanupError +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java new file mode 100644 index 000000000..1109f5f23 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionInstalledPlugin( + /** Plugin name */ + @JsonProperty("name") String name, + /** Marketplace the plugin came from (empty string for direct repo installs) */ + @JsonProperty("marketplace") String marketplace, + /** Installed version, if known */ + @JsonProperty("version") String version, + /** Installation timestamp (ISO-8601) */ + @JsonProperty("installed_at") String installedAt, + /** Whether the plugin is currently enabled */ + @JsonProperty("enabled") Boolean enabled, + /** Path where the plugin is cached locally */ + @JsonProperty("cache_path") String cachePath, + /** Source descriptor for direct repo installs (when marketplace is empty) */ + @JsonProperty("source") Object source, + /** Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. */ + @JsonProperty("source_sha") String sourceSha +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java index 15f3fce68..92490f863 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -33,6 +34,7 @@ public final class SessionInstructionsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getSources() { return caller.invoke("session.instructions.getSources", java.util.Map.of("sessionId", this.sessionId), SessionInstructionsGetSourcesResult.class); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java index f9b683147..10b162d2e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java index 4d62780da..b798c1d65 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInstructionsGetSourcesResult.java @@ -10,19 +10,22 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Instruction sources loaded for the session, in merge order. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionInstructionsGetSourcesResult( /** Instruction sources for the session */ - @JsonProperty("sources") List sources + @JsonProperty("sources") List sources ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnParams.java new file mode 100644 index 000000000..6e16ad1dd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for interrupting the main agent turn. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionInterruptMainTurnParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** When true, the user's queued prompts are preserved and run as the next turn once the interrupted turn unwinds; when false (the default), the queue is cleared like a plain abort. */ + @JsonProperty("flushQueued") Boolean flushQueued +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnResult.java new file mode 100644 index 000000000..a57804cf8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionInterruptMainTurnResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of interrupting the main agent turn. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionInterruptMainTurnResult( + /** Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. */ + @JsonProperty("interrupted") Boolean interrupted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java new file mode 100644 index 000000000..a64f82afa --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionApi.java @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code limitPrediction} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionLimitPredictionApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionLimitPredictionApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture predict() { + return predict(null); + } + + /** + * Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture predict(SessionLimitPredictionPredictParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.limitPrediction.predict", _p, SessionLimitPredictionResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionBaselineData.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionBaselineData.java new file mode 100644 index 000000000..2387c5498 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionBaselineData.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Baseline data provenance for a prediction. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitPredictionBaselineData( + /** Start of the baseline data slice. */ + @JsonProperty("windowStart") String windowStart, + /** End of the baseline data slice. */ + @JsonProperty("windowEnd") String windowEnd +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionClientType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionClientType.java new file mode 100644 index 000000000..539602931 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionClientType.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Client population used for the prediction baseline. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionLimitPredictionClientType { + /** The {@code cli-interactive} variant. */ + CLI_INTERACTIVE("cli-interactive"), + /** The {@code cli-prompt} variant. */ + CLI_PROMPT("cli-prompt"); + + private final String value; + SessionLimitPredictionClientType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionLimitPredictionClientType fromValue(String value) { + for (SessionLimitPredictionClientType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionLimitPredictionClientType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionDetails.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionDetails.java new file mode 100644 index 000000000..f4329bb71 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionDetails.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Explainable AI-credit session-limit prediction. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitPredictionDetails( + /** Client population used for the prediction. */ + @JsonProperty("clientType") SessionLimitPredictionClientType clientType, + /** Model identifier used for lookup. */ + @JsonProperty("modelId") String modelId, + /** Baseline fallback level used to create the prediction. */ + @JsonProperty("source") SessionLimitPredictionSource source, + /** Key matched at the source level, such as a model id, family id, or `global`. */ + @JsonProperty("sourceKey") String sourceKey, + /** Resolved model family when known. */ + @JsonProperty("family") String family, + /** Ordered usage tiers and their AI-credit caps. */ + @JsonProperty("tiers") List tiers, + /** Baseline data provenance. */ + @JsonProperty("baselineData") SessionLimitPredictionBaselineData baselineData, + /** Tier chosen as the recommended cap. */ + @JsonProperty("recommendedTier") SessionLimitPredictionTier recommendedTier, + /** Recommended maximum AI credits for this session. */ + @JsonProperty("recommendedCap") Double recommendedCap +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionPredictParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionPredictParams.java new file mode 100644 index 000000000..b02e82ca8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionPredictParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.limitPrediction.predict} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitPredictionPredictParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Optional model identifier override. If omitted, the session's current model is used. */ + @JsonProperty("modelId") String modelId, + /** Client type to size for. Defaults to `cli-interactive`. */ + @JsonProperty("clientType") SessionLimitPredictionClientType clientType +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResult.java new file mode 100644 index 000000000..0c2f489d9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResult.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Prediction result. Available results include prediction details; unavailable results include an explicit reason. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = SessionLimitPredictionResultAvailable.class, name = "available"), + @JsonSubTypes.Type(value = SessionLimitPredictionResultUnavailable.class, name = "unavailable") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class SessionLimitPredictionResult { + + /** + * Returns the discriminator value for this variant. + * + * @return the kind discriminator + */ + public abstract String getKind(); +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultAvailable.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultAvailable.java new file mode 100644 index 000000000..632018f4d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultAvailable.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Variant {@code available} of {@link SessionLimitPredictionResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionLimitPredictionResultAvailable extends SessionLimitPredictionResult { + + @JsonProperty("kind") + private final String kind = "available"; + + @Override + public String getKind() { return kind; } + + /** Predicted session limit details. */ + @JsonProperty("prediction") + private SessionLimitPredictionDetails prediction; + + public SessionLimitPredictionDetails getPrediction() { return prediction; } + public void setPrediction(SessionLimitPredictionDetails prediction) { this.prediction = prediction; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultUnavailable.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultUnavailable.java new file mode 100644 index 000000000..3f4b3ebe2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionResultUnavailable.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Variant {@code unavailable} of {@link SessionLimitPredictionResult}. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionLimitPredictionResultUnavailable extends SessionLimitPredictionResult { + + @JsonProperty("kind") + private final String kind = "unavailable"; + + @Override + public String getKind() { return kind; } + + /** Reason no prediction is available. */ + @JsonProperty("reason") + private SessionLimitPredictionUnavailableReason reason; + + public SessionLimitPredictionUnavailableReason getReason() { return reason; } + public void setReason(SessionLimitPredictionUnavailableReason reason) { this.reason = reason; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionSource.java new file mode 100644 index 000000000..c22baa118 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionSource.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Baseline fallback level used to create the prediction. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionLimitPredictionSource { + /** The {@code model} variant. */ + MODEL("model"), + /** The {@code family} variant. */ + FAMILY("family"), + /** The {@code global} variant. */ + GLOBAL("global"); + + private final String value; + SessionLimitPredictionSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionLimitPredictionSource fromValue(String value) { + for (SessionLimitPredictionSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionLimitPredictionSource value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTier.java new file mode 100644 index 000000000..21d3de43c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTier.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Semantic usage tier used for a recommended cap or additional headroom. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionLimitPredictionTier { + /** The {@code recommended} variant. */ + RECOMMENDED("recommended"), + /** The {@code additional_headroom} variant. */ + ADDITIONAL_HEADROOM("additional_headroom"), + /** The {@code generous_headroom} variant. */ + GENEROUS_HEADROOM("generous_headroom"), + /** The {@code maximum_headroom} variant. */ + MAXIMUM_HEADROOM("maximum_headroom"); + + private final String value; + SessionLimitPredictionTier(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionLimitPredictionTier fromValue(String value) { + for (SessionLimitPredictionTier v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionLimitPredictionTier value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTierOption.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTierOption.java new file mode 100644 index 000000000..f468e53e0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionTierOption.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Semantic usage tier and its AI-credit cap. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitPredictionTierOption( + @JsonProperty("tier") SessionLimitPredictionTier tier, + /** AI-credit cap for this tier. */ + @JsonProperty("cap") Double cap +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionUnavailableReason.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionUnavailableReason.java new file mode 100644 index 000000000..76ee7c882 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitPredictionUnavailableReason.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Reason a prediction could not be computed. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionLimitPredictionUnavailableReason { + /** The {@code auto_unresolved} variant. */ + AUTO_UNRESOLVED("auto_unresolved"), + /** The {@code no_model} variant. */ + NO_MODEL("no_model"); + + private final String value; + SessionLimitPredictionUnavailableReason(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionLimitPredictionUnavailableReason fromValue(String value) { + for (SessionLimitPredictionUnavailableReason v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionLimitPredictionUnavailableReason value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java new file mode 100644 index 000000000..10b625f8a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLimitsConfig.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Optional session limits. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionLimitsConfig( + /** Maximum AI Credits allowed across the session's current accounting window. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionListFilter.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionListFilter.java new file mode 100644 index 000000000..c5b92cb04 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionListFilter.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Optional filter applied to the returned sessions + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionListFilter( + /** Match sessions whose context.cwd equals this value */ + @JsonProperty("cwd") String cwd, + /** Match sessions whose context.gitRoot equals this value */ + @JsonProperty("gitRoot") String gitRoot, + /** Match sessions whose context.repository equals this value */ + @JsonProperty("repository") String repository, + /** Match sessions whose context.branch equals this value */ + @JsonProperty("branch") String branch +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLogLevel.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogLevel.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLogLevel.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogLevel.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java index edd160f82..80caaaaaa 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java index 7d9d79d71..63356d5c2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLogResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.UUID; import javax.annotation.processing.Generated; /** * Identifier of the session event that was emitted for the log message. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java index 76678266c..c965007d4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionLspApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture initialize(SessionLspInitializeParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java index bd0387b88..4734a4502 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionLspInitializeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Parameters for (re)loading the merged LSP configuration set. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedPermissions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedPermissions.java new file mode 100644 index 000000000..79698b27c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedPermissions.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Enterprise permission policy expressed with the runtime's managed permission-rule syntax. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionManagedPermissions( + /** When set to `disable`, prevents bypass/allow-all permission modes. */ + @JsonProperty("disableBypassPermissionsMode") DisableBypassPermissionsMode disableBypassPermissionsMode, + /** Permission rules that block matching operations. Deny has highest precedence. */ + @JsonProperty("deny") List deny, + /** Permission rules that require explicit human approval. */ + @JsonProperty("ask") List ask, + /** Permission rules that allow matching operations unless another managed source, deny, or ask rule restricts them. */ + @JsonProperty("allow") List allow +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedSettings.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedSettings.java new file mode 100644 index 000000000..ddba69d8b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionManagedSettings.java @@ -0,0 +1,26 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Managed settings an SDK host may inject at session startup. Only permissions are accepted in this initial contract. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionManagedSettings( + @JsonProperty("permissions") SessionManagedPermissions permissions +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java new file mode 100644 index 000000000..1a75b92c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java @@ -0,0 +1,303 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code mcp} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionMcpApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** API methods for the {@code mcp.oauth} sub-namespace. */ + public final SessionMcpOauthApi oauth; + /** API methods for the {@code mcp.headers} sub-namespace. */ + public final SessionMcpHeadersApi headers; + /** API methods for the {@code mcp.apps} sub-namespace. */ + public final SessionMcpAppsApi apps; + /** API methods for the {@code mcp.resources} sub-namespace. */ + public final SessionMcpResourcesApi resources; + + /** @param caller the RPC transport function */ + SessionMcpApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + this.oauth = new SessionMcpOauthApi(caller, sessionId); + this.headers = new SessionMcpHeadersApi(caller, sessionId); + this.apps = new SessionMcpAppsApi(caller, sessionId); + this.resources = new SessionMcpResourcesApi(caller, sessionId); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("session.mcp.list", java.util.Map.of("sessionId", this.sessionId), SessionMcpListResult.class); + } + + /** + * Server name whose tool list should be returned. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listTools(SessionMcpListToolsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.listTools", _p, SessionMcpListToolsResult.class); + } + + /** + * Name of the MCP server to enable for the session. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enable(SessionMcpEnableParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.enable", _p, Void.class); + } + + /** + * Name of the MCP server to disable for the session. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture disable(SessionMcpDisableParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.disable", _p, Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload() { + return caller.invoke("session.mcp.reload", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Opaque MCP reload configuration. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reloadWithConfig(SessionMcpReloadWithConfigParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.reloadWithConfig", _p, SessionMcpReloadWithConfigResult.class); + } + + /** + * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture executeSampling(SessionMcpExecuteSamplingParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.executeSampling", _p, SessionMcpExecuteSamplingResult.class); + } + + /** + * The requestId previously passed to executeSampling that should be cancelled. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.cancelSamplingExecution", _p, SessionMcpCancelSamplingExecutionResult.class); + } + + /** + * Mode controlling how MCP server env values are resolved (`direct` or `indirect`). + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setEnvValueMode(SessionMcpSetEnvValueModeParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.setEnvValueMode", _p, SessionMcpSetEnvValueModeResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture removeGitHub() { + return caller.invoke("session.mcp.removeGitHub", java.util.Map.of("sessionId", this.sessionId), SessionMcpRemoveGitHubResult.class); + } + + /** + * Opaque auth info used to configure GitHub MCP. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture configureGitHub(SessionMcpConfigureGitHubParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.configureGitHub", _p, SessionMcpConfigureGitHubResult.class); + } + + /** + * Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture startServer(SessionMcpStartServerParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.startServer", _p, Void.class); + } + + /** + * Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture restartServer(SessionMcpRestartServerParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.restartServer", _p, Void.class); + } + + /** + * Server name for an individual MCP server stop. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture stopServer(SessionMcpStopServerParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.stopServer", _p, Void.class); + } + + /** + * Registration parameters for an external MCP client. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture registerExternalClient(SessionMcpRegisterExternalClientParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.registerExternalClient", _p, Void.class); + } + + /** + * Server name identifying the external client to remove. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture unregisterExternalClient(SessionMcpUnregisterExternalClientParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.unregisterExternalClient", _p, Void.class); + } + + /** + * Server name to check running status for. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture isServerRunning(SessionMcpIsServerRunningParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.isServerRunning", _p, SessionMcpIsServerRunningResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java index b6c131a6a..6b932855b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsApi.java @@ -7,6 +7,8 @@ package com.github.copilot.generated.rpc; +import com.fasterxml.jackson.databind.JsonNode; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +40,7 @@ public final class SessionMcpAppsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture readResource(SessionMcpAppsReadResourceParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -53,6 +56,7 @@ public CompletableFuture readResource(SessionM * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture listTools(SessionMcpAppsListToolsParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -68,10 +72,11 @@ public CompletableFuture listTools(SessionMcpApps * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ - public CompletableFuture callTool(SessionMcpAppsCallToolParams params) { + @CopilotExperimental + public CompletableFuture callTool(SessionMcpAppsCallToolParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.apps.callTool", _p, Void.class); + return caller.invoke("session.mcp.apps.callTool", _p, JsonNode.class); } /** @@ -83,6 +88,7 @@ public CompletableFuture callTool(SessionMcpAppsCallToolParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setHostContext(SessionMcpAppsSetHostContextParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -95,6 +101,7 @@ public CompletableFuture setHostContext(SessionMcpAppsSetHostContextParams * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getHostContext() { return caller.invoke("session.mcp.apps.getHostContext", java.util.Map.of("sessionId", this.sessionId), SessionMcpAppsGetHostContextResult.class); } @@ -108,6 +115,7 @@ public CompletableFuture getHostContext() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture diagnose(SessionMcpAppsDiagnoseParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java index 8c4788e47..6b0108d54 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsCallToolParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * MCP server, tool name, and arguments to invoke from an MCP App view. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java index cf700a341..c4e9a8fb3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server to diagnose MCP Apps wiring for. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java index 144081f48..3d1936969 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsDiagnoseResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Diagnostic snapshot of MCP Apps wiring for the named server. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java index 380164b3c..cb6730b6b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java index a543b4820..2417258ce 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsGetHostContextResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Current host context advertised to MCP App guests. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java index d5e0c578a..85ac63c63 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server to list app-callable tools for. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java index 054ce56a8..5736086c0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsListToolsResult.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import java.util.Map; import javax.annotation.processing.Generated; @@ -17,8 +18,10 @@ /** * App-callable tools from the named MCP server. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java index 26b29ee3d..34e5828aa 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * MCP server and resource URI to fetch. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java index e0f9810a3..31da3f2be 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsReadResourceResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Resource contents returned by the MCP server. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java index 19c9347b7..0e026ad13 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpAppsSetHostContextParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Host context to advertise to MCP App guests. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java index c00459e4b..3c3ecf4bb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The requestId previously passed to executeSampling that should be cancelled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java index 9495602f6..17a4a9406 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpCancelSamplingExecutionResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java new file mode 100644 index 000000000..2f709a8dd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Opaque auth info used to configure GitHub MCP. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpConfigureGitHubParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). */ + @JsonProperty("authInfo") Object authInfo +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java new file mode 100644 index 000000000..a22656359 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpConfigureGitHubResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of configuring GitHub MCP. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpConfigureGitHubResult( + /** Whether GitHub MCP configuration changed. */ + @JsonProperty("changed") Boolean changed +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java index adee20ceb..0bd4bd20b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Name of the MCP server to disable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java index 53b23f9ee..668c5ecd9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Name of the MCP server to enable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java index b6f995971..54950ec4f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java index 578cb10f2..418630d7f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpExecuteSamplingResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Outcome of an MCP sampling execution: success result, failure error, or cancellation. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java new file mode 100644 index 000000000..45679f83a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersApi.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code mcp.headers} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionMcpHeadersApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionMcpHeadersApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * MCP headers refresh request id and the host response. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture handlePendingHeadersRefreshRequest(SessionMcpHeadersHandlePendingHeadersRefreshRequestParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.headers.handlePendingHeadersRefreshRequest", _p, SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java new file mode 100644 index 000000000..77ce6f732 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * MCP headers refresh request id and the host response. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpHeadersHandlePendingHeadersRefreshRequestParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Headers refresh request identifier from mcp.headers_refresh_required */ + @JsonProperty("requestId") String requestId, + /** Host response: supply dynamic headers or decline this refresh. */ + @JsonProperty("result") Object result +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java new file mode 100644 index 000000000..a89071306 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpHeadersHandlePendingHeadersRefreshRequestResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the pending MCP headers refresh response was accepted. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpHeadersHandlePendingHeadersRefreshRequestResult( + /** Whether the response was accepted. False if the request was unknown, timed out, or already resolved. */ + @JsonProperty("success") Boolean success +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java new file mode 100644 index 000000000..5a2035be9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name to check running status for. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpIsServerRunningParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server to check */ + @JsonProperty("serverName") String serverName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java new file mode 100644 index 000000000..87730dda3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpIsServerRunningResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the named MCP server is running. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpIsServerRunningResult( + /** True if the server has an active client and transport. */ + @JsonProperty("running") Boolean running +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java index 4ae5d6a2c..81fa48bdb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java new file mode 100644 index 000000000..1050b363d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * MCP servers configured for the session, with their connection status and host-level state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpListResult( + /** Configured MCP servers */ + @JsonProperty("servers") List servers, + /** Host-level state, omitted when no MCP host is initialized. */ + @JsonProperty("host") McpHostState host +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java new file mode 100644 index 000000000..67ea7f264 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name whose tool list should be returned. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpListToolsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the connected MCP server whose tools to list. */ + @JsonProperty("serverName") String serverName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java new file mode 100644 index 000000000..88e13f992 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListToolsResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Tools exposed by the connected MCP server. Throws when the server is not connected. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpListToolsResult( + /** Tools exposed by the server. */ + @JsonProperty("tools") List tools +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java new file mode 100644 index 000000000..1fdb292f8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java @@ -0,0 +1,97 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code mcp.oauth} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionMcpOauthApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionMcpOauthApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Pending MCP OAuth request ID and host-provided token or cancellation response. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.oauth.handlePendingRequest", _p, SessionMcpOauthHandlePendingRequestResult.class); + } + + /** + * Identifies the MCP server whose persisted OAuth credentials were updated. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.oauth.authenticationStateChanged", _p, Void.class); + } + + /** + * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture login(SessionMcpOauthLoginParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.oauth.login", _p, SessionMcpOauthLoginResult.class); + } + + /** + * Pending MCP OAuth request id to respond to. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture respond(SessionMcpOauthRespondParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.oauth.respond", _p, SessionMcpOauthRespondResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthAuthenticationStateChangedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthAuthenticationStateChangedParams.java new file mode 100644 index 000000000..b773e1bf7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthAuthenticationStateChangedParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the MCP server whose persisted OAuth credentials were updated. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthAuthenticationStateChangedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server whose OAuth credentials were updated. Omit only when the host cannot identify the server. */ + @JsonProperty("serverName") String serverName, + /** Whether the target session must mint a session-scoped access token instead of reusing a shared access token persisted by another session. */ + @JsonProperty("refreshSessionToken") Boolean refreshSessionToken +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java new file mode 100644 index 000000000..403bd548a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Pending MCP OAuth request ID and host-provided token or cancellation response. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthHandlePendingRequestParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** OAuth request identifier from the mcp.oauth_required event */ + @JsonProperty("requestId") String requestId, + /** Host response to the pending OAuth request. */ + @JsonProperty("result") Object result +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java new file mode 100644 index 000000000..a7bca646e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthHandlePendingRequestResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the pending MCP OAuth response was accepted. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthHandlePendingRequestResult( + /** Whether the response was accepted. False if the request was unknown, timed out, or already resolved. */ + @JsonProperty("success") Boolean success +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java new file mode 100644 index 000000000..d9234d558 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthLoginParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the remote MCP server to authenticate */ + @JsonProperty("serverName") String serverName, + /** 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. */ + @JsonProperty("forceReauth") Boolean forceReauth, + /** 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. */ + @JsonProperty("clientName") String clientName, + /** 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. */ + @JsonProperty("callbackSuccessMessage") String callbackSuccessMessage, + /** Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. */ + @JsonProperty("clientId") String clientId, + /** Optional OAuth client secret override for this login. The runtime treats this as an ephemeral host-owned secret, uses it for this authentication attempt and does not persist it. */ + @JsonProperty("clientSecret") String clientSecret, + /** Optional override indicating whether the static OAuth client is public. When false, the runtime treats it as confidential and uses the per-login clientSecret if provided, otherwise retrieving the client secret from the MCP OAuth secret store. */ + @JsonProperty("publicClient") Boolean publicClient, + /** Optional OAuth grant type override for this login. Defaults to the server configuration, or authorization_code when no grant type is specified. */ + @JsonProperty("grantType") McpOauthLoginGrantType grantType +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java index e3d9071f7..d5f635dd5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondParams.java new file mode 100644 index 000000000..ca79468c1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Pending MCP OAuth request id to respond to. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthRespondParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** OAuth request identifier from the mcp.oauth_required event */ + @JsonProperty("requestId") String requestId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondResult.java new file mode 100644 index 000000000..1b1267cb5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthRespondResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the pending MCP OAuth response was accepted. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpOauthRespondResult( + /** Whether the response was accepted. False if the request was unknown, timed out, or already resolved. */ + @JsonProperty("success") Boolean success +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java new file mode 100644 index 000000000..ba5cdc353 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRegisterExternalClientParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Registration parameters for an external MCP client. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpRegisterExternalClientParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Logical server name for the external client */ + @JsonProperty("serverName") String serverName, + /** In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. */ + @JsonProperty("client") Object client, + /** In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. */ + @JsonProperty("transport") Object transport, + /** In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. */ + @JsonProperty("config") Object config +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java index 6df56c453..2427036dc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java new file mode 100644 index 000000000..b93733f0e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Opaque MCP reload configuration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpReloadWithConfigParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). */ + @JsonProperty("config") Object config +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java new file mode 100644 index 000000000..ba4fcf3b7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadWithConfigResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * MCP server startup filtering result. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpReloadWithConfigResult( + /** Servers filtered out before startup */ + @JsonProperty("filteredServers") List filteredServers, + /** Non-default servers allowed by policy */ + @JsonProperty("allowedServers") List allowedServers +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java index 0213c76f5..0ff09eb49 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java index 1845649bc..a26e99fec 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRemoveGitHubResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java new file mode 100644 index 000000000..c1a30e135 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesApi.java @@ -0,0 +1,81 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code mcp.resources} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionMcpResourcesApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionMcpResourcesApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * MCP server and resource URI to fetch. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture read(SessionMcpResourcesReadParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.resources.read", _p, SessionMcpResourcesReadResult.class); + } + + /** + * MCP server whose resources to enumerate. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(SessionMcpResourcesListParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.resources.list", _p, SessionMcpResourcesListResult.class); + } + + /** + * MCP server whose resource templates to enumerate. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listTemplates(SessionMcpResourcesListTemplatesParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.mcp.resources.listTemplates", _p, SessionMcpResourcesListTemplatesResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java new file mode 100644 index 000000000..bd8a9de64 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * MCP server whose resources to enumerate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesListParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server whose resources to enumerate */ + @JsonProperty("serverName") String serverName, + /** Opaque MCP pagination cursor from a prior `nextCursor` value */ + @JsonProperty("cursor") String cursor +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java new file mode 100644 index 000000000..b7e1042cf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * One page of resources advertised by the named MCP server. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesListResult( + /** Resources advertised by the server (proxied MCP `resources/list`) */ + @JsonProperty("resources") List resources, + /** Opaque cursor for the next page, if the server has more resources */ + @JsonProperty("nextCursor") String nextCursor +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java new file mode 100644 index 000000000..a58252c76 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * MCP server whose resource templates to enumerate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesListTemplatesParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server whose resource templates to enumerate */ + @JsonProperty("serverName") String serverName, + /** Opaque MCP pagination cursor from a prior `nextCursor` value */ + @JsonProperty("cursor") String cursor +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java new file mode 100644 index 000000000..9cb3ff056 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesListTemplatesResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * One page of resource templates advertised by the named MCP server. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesListTemplatesResult( + /** Resource templates advertised by the server (proxied MCP `resources/templates/list`) */ + @JsonProperty("resourceTemplates") List resourceTemplates, + /** Opaque cursor for the next page, if the server has more resource templates */ + @JsonProperty("nextCursor") String nextCursor +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java new file mode 100644 index 000000000..5c7b9d803 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * MCP server and resource URI to fetch. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesReadParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server hosting the resource */ + @JsonProperty("serverName") String serverName, + /** Resource URI */ + @JsonProperty("uri") String uri +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java new file mode 100644 index 000000000..7e85574ee --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpResourcesReadResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Resource contents returned by the MCP server. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpResourcesReadResult( + /** Resource contents returned by the server */ + @JsonProperty("contents") List contents +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java new file mode 100644 index 000000000..b51780256 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpRestartServerParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpRestartServerParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server to restart */ + @JsonProperty("serverName") String serverName, + /** Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart the server with its already-registered configuration (config-free restart-by-name). */ + @JsonProperty("config") Object config +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java index 5a524cfb0..16b444612 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Mode controlling how MCP server env values are resolved (`direct` or `indirect`). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java index 300ef08e7..fd1b47d54 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpSetEnvValueModeResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Env-value mode recorded on the session after the update. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java new file mode 100644 index 000000000..9f6d5d73e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStartServerParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpStartServerParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server to start */ + @JsonProperty("serverName") String serverName, + /** MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server with its already-registered configuration (config-free start-by-name). */ + @JsonProperty("config") Object config +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java new file mode 100644 index 000000000..4a31ccf36 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpStopServerParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name for an individual MCP server stop. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpStopServerParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Name of the MCP server to stop */ + @JsonProperty("serverName") String serverName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java new file mode 100644 index 000000000..390e99852 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMcpUnregisterExternalClientParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Server name identifying the external client to remove. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMcpUnregisterExternalClientParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Server name of the external client to unregister */ + @JsonProperty("serverName") String serverName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java new file mode 100644 index 000000000..97fe88cdd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataActivityParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java new file mode 100644 index 000000000..66a16debb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataActivityResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Current activity flags for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataActivityResult( + /** Whether an in-flight operation can currently be aborted. */ + @JsonProperty("abortable") Boolean abortable, + /** Whether the session currently has active work, including running turns or tasks. */ + @JsonProperty("hasActiveWork") Boolean hasActiveWork +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java new file mode 100644 index 000000000..0b15df5d4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java @@ -0,0 +1,157 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code metadata} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionMetadataApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionMetadataApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture snapshot() { + return caller.invoke("session.metadata.snapshot", java.util.Map.of("sessionId", this.sessionId), SessionMetadataSnapshotResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture isProcessing() { + return caller.invoke("session.metadata.isProcessing", java.util.Map.of("sessionId", this.sessionId), SessionMetadataIsProcessingResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture activity() { + return caller.invoke("session.metadata.activity", java.util.Map.of("sessionId", this.sessionId), SessionMetadataActivityResult.class); + } + + /** + * Model identifier and token limits used to compute the context-info breakdown. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture contextInfo(SessionMetadataContextInfoParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.metadata.contextInfo", _p, SessionMetadataContextInfoResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getContextAttribution() { + return caller.invoke("session.metadata.getContextAttribution", java.util.Map.of("sessionId", this.sessionId), SessionMetadataGetContextAttributionResult.class); + } + + /** + * Parameters for the heaviest-messages query. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getContextHeaviestMessages(SessionMetadataGetContextHeaviestMessagesParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.metadata.getContextHeaviestMessages", _p, SessionMetadataGetContextHeaviestMessagesResult.class); + } + + /** + * Updated working-directory/git context to record on the session. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture recordContextChange(SessionMetadataRecordContextChangeParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.metadata.recordContextChange", _p, Void.class); + } + + /** + * Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setWorkingDirectory(SessionMetadataSetWorkingDirectoryParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.metadata.setWorkingDirectory", _p, SessionMetadataSetWorkingDirectoryResult.class); + } + + /** + * Model identifier to use when re-tokenizing the session's existing messages. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.metadata.recomputeContextTokens", _p, SessionMetadataRecomputeContextTokensResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java index 4b6bccf7e..0c5b909db 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Model identifier and token limits used to compute the context-info breakdown. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java index de9074e8c..647295602 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataContextInfoResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Token breakdown for the session's current context window, or null if uninitialized. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -37,13 +40,15 @@ public record SessionMetadataContextInfoResultContextInfo( @JsonProperty("conversationTokens") Long conversationTokens, /** Tokens consumed by tool definitions sent to the model (excludes deferred tools) */ @JsonProperty("toolDefinitionsTokens") Long toolDefinitionsTokens, + /** Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) */ + @JsonProperty("mcpToolsTokens") Long mcpToolsTokens, /** Sum of system, conversation and tool-definition tokens */ @JsonProperty("totalTokens") Long totalTokens, /** Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) */ @JsonProperty("promptTokenLimit") Long promptTokenLimit, /** Token count at which background compaction starts (configurable percentage of promptTokenLimit) */ @JsonProperty("compactionThreshold") Long compactionThreshold, - /** Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. */ + /** Prompt token limit plus the model's full output token limit. */ @JsonProperty("limit") Long limit, /** Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) */ @JsonProperty("bufferTokens") Long bufferTokens diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java new file mode 100644 index 000000000..c0fc0e912 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataGetContextAttributionParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java new file mode 100644 index 000000000..c27f37afb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextAttributionResult.java @@ -0,0 +1,107 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Per-source attribution breakdown for the session's current context window, or null if uninitialized. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataGetContextAttributionResult( + /** Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). */ + @JsonProperty("contextAttribution") SessionMetadataGetContextAttributionResultContextAttribution contextAttribution +) { + + /** Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionMetadataGetContextAttributionResultContextAttribution( + /** Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. */ + @JsonProperty("totalTokens") Long totalTokens, + /** The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. */ + @JsonProperty("modelId") String modelId, + /** How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). */ + @JsonProperty("modelSource") String modelSource, + /** Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. */ + @JsonProperty("promptTokenLimit") Long promptTokenLimit, + /** Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. */ + @JsonProperty("limit") Long limit, + /** Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. */ + @JsonProperty("bufferTokens") Long bufferTokens, + /** Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. */ + @JsonProperty("compactionThreshold") Long compactionThreshold, + /** The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. */ + @JsonProperty("categories") SessionMetadataGetContextAttributionResultContextAttributionCategories categories, + /** Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. */ + @JsonProperty("entries") List entries, + /** Successful compaction history for the session. */ + @JsonProperty("compactions") SessionMetadataGetContextAttributionResultContextAttributionCompactions compactions + ) { + + /** The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionMetadataGetContextAttributionResultContextAttributionCategories( + /** System prompt tokens, excluding custom instructions. */ + @JsonProperty("systemPrompt") Long systemPrompt, + /** Custom-instructions tokens (0 when none are configured). */ + @JsonProperty("customInstructions") Long customInstructions, + /** Non-MCP tool-definition tokens. */ + @JsonProperty("systemTools") Long systemTools, + /** MCP tool-definition tokens. */ + @JsonProperty("mcpTools") Long mcpTools, + /** Conversation (user/assistant/tool) message tokens. */ + @JsonProperty("messages") Long messages, + /** Remaining unused window capacity (clamped at 0). */ + @JsonProperty("freeSpace") Long freeSpace, + /** Output reserve plus post-blocking-threshold buffer. */ + @JsonProperty("buffer") Long buffer + ) { + } + + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionMetadataGetContextAttributionResultContextAttributionEntriesItem( + /** Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. */ + @JsonProperty("kind") String kind, + /** Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. */ + @JsonProperty("id") String id, + /** Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. */ + @JsonProperty("label") String label, + /** Token count currently in context attributable to this entry. */ + @JsonProperty("tokens") Long tokens, + /** Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. */ + @JsonProperty("parentId") String parentId, + /** Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. */ + @JsonProperty("attributes") Map attributes + ) { + } + + /** Successful compaction history for the session. */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionMetadataGetContextAttributionResultContextAttributionCompactions( + /** Number of successful compactions in this session. */ + @JsonProperty("count") Long count + ) { + } + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java new file mode 100644 index 000000000..cacdd4ccb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for the heaviest-messages query. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataGetContextHeaviestMessagesParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Maximum number of messages to return, most-expensive first. Omit for the server default. */ + @JsonProperty("limit") Long limit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java new file mode 100644 index 000000000..90b5c3160 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataGetContextHeaviestMessagesResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * The heaviest individual messages in the session's context window, most-expensive first. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataGetContextHeaviestMessagesResult( + /** Total token count of the current context window, so callers can compute each message's share without a second call. */ + @JsonProperty("totalTokens") Long totalTokens, + /** Heaviest messages, most-expensive first. */ + @JsonProperty("messages") List messages +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java index 329dbea10..7f563b6dc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java index e496bb662..ca13dcbde 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataIsProcessingResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the local session is currently processing a turn or background continuation. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java index 979f8808d..6c966280d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Model identifier to use when re-tokenizing the session's existing messages. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java index 4aab3841a..561ec2eef 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecomputeContextTokensResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java index 6b42c822c..d72a83977 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Updated working-directory/git context to record on the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java new file mode 100644 index 000000000..968cf5d8b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataSetWorkingDirectoryParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. */ + @JsonProperty("workingDirectory") String workingDirectory +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java new file mode 100644 index 000000000..b0dff14ed --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionMetadataSetWorkingDirectoryResult( + /** Working directory after the update */ + @JsonProperty("workingDirectory") String workingDirectory +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java index d3e94df43..2e4c923a4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java index 5b6ae7b8c..6c29e07b6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSnapshotResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.time.OffsetDateTime; import javax.annotation.processing.Generated; /** * Point-in-time snapshot of slow-changing session identifier and state fields * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -48,6 +51,8 @@ public record SessionMetadataSnapshotResult( @JsonProperty("currentMode") MetadataSnapshotCurrentMode currentMode, /** Currently selected model identifier, if any */ @JsonProperty("selectedModel") String selectedModel, + /** Current session limits, or null when no limits are active */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits, /** Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). */ @JsonProperty("workspace") SessionMetadataSnapshotResultWorkspace workspace ) { @@ -70,6 +75,8 @@ public record SessionMetadataSnapshotResultWorkspace( @JsonProperty("branch") String branch, /** Display name for the session, if set */ @JsonProperty("name") String name, + /** Whether the display name was explicitly set by the user */ + @JsonProperty("user_named") Boolean userNamed, /** ISO 8601 timestamp when the workspace was created */ @JsonProperty("created_at") OffsetDateTime createdAt, /** ISO 8601 timestamp when the workspace was last updated */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMode.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionMode.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java index e5201bd6a..58311ff65 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -35,8 +36,9 @@ public final class SessionModeApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ - public CompletableFuture get() { - return caller.invoke("session.mode.get", java.util.Map.of("sessionId", this.sessionId), Void.class); + @CopilotExperimental + public CompletableFuture get() { + return caller.invoke("session.mode.get", java.util.Map.of("sessionId", this.sessionId), SessionMode.class); } /** @@ -48,6 +50,7 @@ public CompletableFuture get() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture set(SessionModeSetParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java index c1a493621..8e4a26d56 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java index b12bea9ff..4ea732727 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Agent interaction mode to apply to the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java new file mode 100644 index 000000000..9d20e8627 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java @@ -0,0 +1,105 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code model} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionModelApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionModelApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getCurrent() { + return caller.invoke("session.model.getCurrent", java.util.Map.of("sessionId", this.sessionId), SessionModelGetCurrentResult.class); + } + + /** + * Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture switchTo(SessionModelSwitchToParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.model.switchTo", _p, SessionModelSwitchToResult.class); + } + + /** + * Reasoning effort level to apply to the currently selected model. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setReasoningEffort(SessionModelSetReasoningEffortParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.model.setReasoningEffort", _p, SessionModelSetReasoningEffortResult.class); + } + + /** + * Optional listing options. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return list(null); + } + + /** + * Optional listing options. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list(SessionModelListParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.model.list", _p, SessionModelListResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java index abcf1c2ab..141f51233 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java new file mode 100644 index 000000000..21afab2fa --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelGetCurrentResult( + /** Currently active model identifier */ + @JsonProperty("modelId") String modelId, + /** Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Context tier for models that support multiple context-window sizes. */ + @JsonProperty("contextTier") ContextTier contextTier +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java new file mode 100644 index 000000000..dc521fe2e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.model.list} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelListParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** If true, bypasses the per-session model list cache and re-fetches from CAPI. */ + @JsonProperty("skipCache") Boolean skipCache +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java new file mode 100644 index 000000000..8951499ef --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelListResult.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * The list of models available to this session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelListResult( + /** Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`). */ + @JsonProperty("list") List list, + /** Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable. */ + @JsonProperty("modelPriceCategories") List modelPriceCategories, + /** Per-quota snapshots returned alongside the model list, keyed by quota type. */ + @JsonProperty("quotaSnapshots") Map quotaSnapshots +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java new file mode 100644 index 000000000..295f6a01f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelPriceCategory.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Cost-category metadata for a CAPI model. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelPriceCategory( + @JsonProperty("id") String id, + @JsonProperty("priceCategory") ModelPickerPriceCategory priceCategory +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java index 6135c2e0a..d76c3e4e7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Reasoning effort level to apply to the currently selected model. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java index 2d6cbd0a6..7dfc3b6a6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSetReasoningEffortResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java new file mode 100644 index 000000000..fe49e2976 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelSwitchToParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Model selection id to switch to, as returned by `list`. A bare id (e.g. `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. */ + @JsonProperty("modelId") String modelId, + /** Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted, no effort override is applied. */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Reasoning summary mode to request for supported model clients */ + @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, + /** Output verbosity level to request for supported models */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Override individual model capabilities resolved by the runtime */ + @JsonProperty("modelCapabilities") ModelCapabilitiesOverride modelCapabilities, + /** Explicit context tier for the selected model. `"default"` / `"long_context"` apply the requested tier; omit this field to use normal model behavior with no explicit tier. */ + @JsonProperty("contextTier") ContextTier contextTier, + /** When true, defer this switch (enqueue it) if another model change is already queued, even when no turn is active — so it drains last (FIFO) and wins over the already-queued change. Intended for genuine user-initiated model selections; internal restore/reapply switches omit it and apply immediately when no turn is active. When no other model change is queued this has no effect (a switch still applies immediately unless a turn is active). */ + @JsonProperty("deferIfModelChangeQueued") Boolean deferIfModelChangeQueued +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java new file mode 100644 index 000000000..030324a94 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * The model identifier active on the session after the switch. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionModelSwitchToResult( + /** Currently active model identifier after the switch */ + @JsonProperty("modelId") String modelId, + /** True when the switch was deferred (enqueued as a cancellable `/model` command) because a turn was active or another model change was already queued, rather than applied immediately. When true, the session's live model is unchanged until the queued change drains. */ + @JsonProperty("deferred") Boolean deferred +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java index e7e1be58a..9bfc5bea5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -35,6 +36,7 @@ public final class SessionNameApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture get() { return caller.invoke("session.name.get", java.util.Map.of("sessionId", this.sessionId), SessionNameGetResult.class); } @@ -48,6 +50,7 @@ public CompletableFuture get() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture set(SessionNameSetParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -63,6 +66,7 @@ public CompletableFuture set(SessionNameSetParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setAuto(SessionNameSetAutoParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java index d3728d06d..05fe4e9da 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java index b3e459967..4743adaed 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameGetResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The session's friendly name, or null when not yet set. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java index 8c69e0d5d..11d495b0d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Auto-generated session summary to apply as the session's name when no user-set name exists. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java index e84407d89..1499778f8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetAutoResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the auto-generated summary was applied as the session's name. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java index 7fd348c36..bbacd7f33 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionNameSetParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * New friendly name to apply to the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptions.java new file mode 100644 index 000000000..cf253bff0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptions.java @@ -0,0 +1,161 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Session construction options. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOpenOptions( + /** Optional stable session identifier to use for a new session. */ + @JsonProperty("sessionId") String sessionId, + /** Optional human-friendly session name. */ + @JsonProperty("name") String name, + /** Initial model identifier. */ + @JsonProperty("model") String model, + /** Initial reasoning effort level. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Initial reasoning summary mode for supported model clients. */ + @JsonProperty("reasoningSummary") SessionOpenOptionsReasoningSummary reasoningSummary, + /** Initial output verbosity level for supported models. */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Identifier of the client driving the session. */ + @JsonProperty("clientName") String clientName, + /** Structured client kind used for runtime behavior gates. */ + @JsonProperty("clientKind") String clientKind, + /** Identifier sent to LSP-style integrations. */ + @JsonProperty("lspClientName") String lspClientName, + /** Stable integration identifier for analytics. */ + @JsonProperty("integrationId") String integrationId, + /** ExP assignment ('flight') data injected by an SDK integrator, in the same JSON shape the Copilot CLI fetches from the experimentation service (CopilotExpAssignmentResponse). When supplied this is fed into the FeatureFlagService exactly like CLI-fetched assignments and ExP-backed flags wait for it. When absent the session does not block on ExP. */ + @JsonProperty("expAssignments") Object expAssignments, + /** Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap. */ + @JsonProperty("enableManagedSettings") Boolean enableManagedSettings, + /** Permissions-only enterprise policy injected by the SDK host at session create or resume. Composes restrictively with self-fetched and device policy and is not persisted. */ + @JsonProperty("managedSettings") SessionManagedSettings managedSettings, + /** Opt in to capturing file changes for session rewind and session diff. Capture cannot reconstruct changes made before it was enabled. On create it starts capture from the first turn. It is also honored on resume: for a session that already has tracked prior turns, tracking continues automatically even if this is omitted; passing it on resume additionally enables tracking for an eligible session that has no prior root turn yet. Resuming a session whose prior root turns were never tracked has no restorable baseline, so tracking stays disabled for it and rewind reports file change tracking as unavailable; the resume itself still succeeds, so sessions that predate tracking remain loadable. The opt-in is only rejected when the session can never track (a subagent session, or one without local session storage). It is intentionally absent from the mutable options update because enabling it after edits have occurred would create an incomplete, misleading baseline. Subagents share the parent session's capture store and are not tracked as separate rewind points: a file a subagent writes is attributed to whichever root user turn was open when the capture was staged, just before the tool body ran. A turn cannot open while a staged capture is still in flight, so a subagent tool that staged under the spawning turn stays attributed to it however late the write lands, while a capture it stages after the user's next message belongs to that later turn. Attribution decides which turn's rewind point counts and file preview include that write; it does not narrow which rewinds revert it, because a rewind restores every capture from the selected turn onward, so the earlier spawning turn reverts it as well. */ + @JsonProperty("enableFileChangeTracking") Boolean enableFileChangeTracking, + /** Feature-flag values resolved by the host. */ + @JsonProperty("featureFlags") Map featureFlags, + /** Whether experimental behavior is enabled. */ + @JsonProperty("isExperimentalMode") Boolean isExperimentalMode, + /** Initial authentication info for the session. */ + @JsonProperty("authInfo") Object authInfo, + /** Custom model-provider configuration (BYOK). */ + @JsonProperty("provider") ProviderConfig provider, + /** Options scoped to the built-in CAPI (Copilot API) provider. */ + @JsonProperty("capi") CapiSessionOptions capi, + /** Named BYOK provider connections, additive to CAPI auth. Combining with `provider` is rejected. */ + @JsonProperty("providers") List providers, + /** BYOK model definitions added to the selectable model list, each referencing a provider name. */ + @JsonProperty("models") List models, + /** Working directory to anchor the session. */ + @JsonProperty("workingDirectory") String workingDirectory, + /** Additional directories the agent may access beyond the working directory. Each entry is granted to the session's file-access allow-list and surfaced to the model (system prompt context and `@`-mention completion). Absolute paths are recommended; a relative path is resolved against the session's working directory. Nonexistent or unresolvable entries are skipped with a warning. This is applied on both session creation and resume, and is not persisted: a resumed session that omits this option does not retain previously supplied directories (re-supply them, exactly as the CLI re-passes `--add-dir`). */ + @JsonProperty("additionalDirectories") List additionalDirectories, + /** Pre-resolved working-directory context for session startup. */ + @JsonProperty("workingDirectoryContext") SessionContext workingDirectoryContext, + /** Whether this session supports remote steering. */ + @JsonProperty("remoteSteerable") Boolean remoteSteerable, + /** Telemetry-only remote exporting flag. */ + @JsonProperty("remoteExporting") Boolean remoteExporting, + /** Telemetry-only remote-defaulted flag. */ + @JsonProperty("remoteDefaultedOn") Boolean remoteDefaultedOn, + /** Parent session ID for detached child telemetry rollup. */ + @JsonProperty("detachedFromSpawningParentSessionId") String detachedFromSpawningParentSessionId, + /** Parent engagement ID for detached child telemetry rollup. */ + @JsonProperty("detachedFromSpawningParentEngagementId") String detachedFromSpawningParentEngagementId, + /** Allowlist of available tool names. */ + @JsonProperty("availableTools") List availableTools, + /** Denylist of tool names. */ + @JsonProperty("excludedTools") List excludedTools, + /** Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. */ + @JsonProperty("includedBuiltinAgents") List includedBuiltinAgents, + /** Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. */ + @JsonProperty("excludedBuiltinAgents") List excludedBuiltinAgents, + /** Whether shell-script safety heuristics are enabled. */ + @JsonProperty("enableScriptSafety") Boolean enableScriptSafety, + /** Per-session settings for built-in shell tools. */ + @JsonProperty("shell") ShellOptions shell, + /** Use shell.initProfile instead. Shell init profile. */ + @JsonProperty("shellInitProfile") String shellInitProfile, + /** PowerShell process flags applied to built-in and user-requested shell commands. */ + @JsonProperty("shellProcessFlags") List shellProcessFlags, + /** Resolved sandbox configuration. */ + @JsonProperty("sandboxConfig") SandboxConfig sandboxConfig, + /** Whether interactive shell sessions are logged. */ + @JsonProperty("logInteractiveShells") Boolean logInteractiveShells, + /** How MCP server environment values are interpreted. */ + @JsonProperty("envValueMode") SessionOpenOptionsEnvValueMode envValueMode, + /** MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume. */ + @JsonProperty("disabledMcpServers") List disabledMcpServers, + /** Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. */ + @JsonProperty("allowAllMcpServerInstructions") Boolean allowAllMcpServerInstructions, + /** Additional directories to search for skills. */ + @JsonProperty("skillDirectories") List skillDirectories, + /** Skill IDs disabled for this session. */ + @JsonProperty("disabledSkills") List disabledSkills, + /** Installed plugins visible to the session. */ + @JsonProperty("installedPlugins") List installedPlugins, + /** Whether custom agents default to local-only execution. */ + @JsonProperty("customAgentsLocalOnly") Boolean customAgentsLocalOnly, + /** Whether to skip custom instruction sources. */ + @JsonProperty("skipCustomInstructions") Boolean skipCustomInstructions, + /** Instruction source IDs disabled for this session. */ + @JsonProperty("disabledInstructionSources") List disabledInstructionSources, + /** Whether commit-message coauthor trailers are enabled. */ + @JsonProperty("coauthorEnabled") Boolean coauthorEnabled, + /** Optional trajectory output file path. */ + @JsonProperty("trajectoryFile") String trajectoryFile, + /** Whether model responses stream as delta events. */ + @JsonProperty("enableStreaming") Boolean enableStreaming, + /** Experimental: enable native model citations (Anthropic models today), normalized onto the `assistant.message` event. Off by default; may change or be removed while the citations surface is experimental. */ + @JsonProperty("enableCitations") Boolean enableCitations, + /** Override URL for the Copilot API endpoint. */ + @JsonProperty("copilotUrl") String copilotUrl, + /** Whether ask_user is explicitly disabled. */ + @JsonProperty("askUserDisabled") Boolean askUserDisabled, + /** Whether auto-mode continuation is enabled. */ + @JsonProperty("continueOnAutoMode") Boolean continueOnAutoMode, + /** Whether the host is an interactive UI. */ + @JsonProperty("runningInInteractiveMode") Boolean runningInInteractiveMode, + /** Whether on-demand custom instruction discovery is enabled. */ + @JsonProperty("enableOnDemandInstructionDiscovery") Boolean enableOnDemandInstructionDiscovery, + /** Maximum decoded byte size of a single inline model-facing binary tool result persisted in session events (default 10 MB). */ + @JsonProperty("maxInlineBinaryBytes") Long maxInlineBinaryBytes, + /** Initial model capability overrides. */ + @JsonProperty("modelCapabilitiesOverrides") ModelCapabilitiesOverride modelCapabilitiesOverrides, + /** Initial session limits. */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits, + /** Runtime context discriminator for agent filtering. */ + @JsonProperty("agentContext") String agentContext, + /** Override directory for session event logs. */ + @JsonProperty("eventsLogDirectory") String eventsLogDirectory, + /** Whether subagent callback events should be forwarded into the session event log sink. */ + @JsonProperty("eventsLogIncludesSubagents") Boolean eventsLogIncludesSubagents, + /** Override Copilot configuration directory. */ + @JsonProperty("configDir") String configDir, + /** Additional content-exclusion policies to merge into the session policy set. */ + @JsonProperty("additionalContentExclusionPolicies") List additionalContentExclusionPolicies, + /** Memory configuration for this session. */ + @JsonProperty("memory") MemoryConfiguration memory, + /** Capabilities enabled for this session. */ + @JsonProperty("sessionCapabilities") List sessionCapabilities +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicy.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicy.java new file mode 100644 index 000000000..bbc53711a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicy.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOpenOptionsAdditionalContentExclusionPolicy( + @JsonProperty("rules") List rules, + @JsonProperty("last_updated_at") Object lastUpdatedAt, + /** Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. */ + @JsonProperty("scope") SessionOpenOptionsAdditionalContentExclusionPolicyScope scope +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRule.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRule.java new file mode 100644 index 000000000..403550ae2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRule.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOpenOptionsAdditionalContentExclusionPolicyRule( + @JsonProperty("paths") List paths, + @JsonProperty("ifAnyMatch") List ifAnyMatch, + @JsonProperty("ifNoneMatch") List ifNoneMatch, + /** Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. */ + @JsonProperty("source") SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource source +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.java new file mode 100644 index 000000000..9cfa5894c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource( + @JsonProperty("name") String name, + @JsonProperty("type") String type +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyScope.java new file mode 100644 index 000000000..66296cd19 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsAdditionalContentExclusionPolicyScope.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionOpenOptionsAdditionalContentExclusionPolicyScope { + /** The {@code repo} variant. */ + REPO("repo"), + /** The {@code all} variant. */ + ALL("all"); + + private final String value; + SessionOpenOptionsAdditionalContentExclusionPolicyScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionOpenOptionsAdditionalContentExclusionPolicyScope fromValue(String value) { + for (SessionOpenOptionsAdditionalContentExclusionPolicyScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionOpenOptionsAdditionalContentExclusionPolicyScope value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsEnvValueMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsEnvValueMode.java new file mode 100644 index 000000000..cfbfeaa74 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsEnvValueMode.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * How MCP server environment values are interpreted. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionOpenOptionsEnvValueMode { + /** The {@code direct} variant. */ + DIRECT("direct"), + /** The {@code indirect} variant. */ + INDIRECT("indirect"); + + private final String value; + SessionOpenOptionsEnvValueMode(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionOpenOptionsEnvValueMode fromValue(String value) { + for (SessionOpenOptionsEnvValueMode v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionOpenOptionsEnvValueMode value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsReasoningSummary.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsReasoningSummary.java new file mode 100644 index 000000000..391e45a29 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOpenOptionsReasoningSummary.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Initial reasoning summary mode for supported model clients. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionOpenOptionsReasoningSummary { + /** The {@code none} variant. */ + NONE("none"), + /** The {@code concise} variant. */ + CONCISE("concise"), + /** The {@code detailed} variant. */ + DETAILED("detailed"); + + private final String value; + SessionOpenOptionsReasoningSummary(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionOpenOptionsReasoningSummary fromValue(String value) { + for (SessionOpenOptionsReasoningSummary v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionOpenOptionsReasoningSummary value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java index 4e46d346a..32d4b7690 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionOptionsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture update(SessionOptionsUpdateParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java new file mode 100644 index 000000000..080b47866 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java @@ -0,0 +1,146 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Patch of mutable session options to apply to the running session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOptionsUpdateParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The model ID to use for assistant turns. */ + @JsonProperty("model") String model, + /** Per-property model capability overrides for the selected model. */ + @JsonProperty("modelCapabilitiesOverrides") ModelCapabilitiesOverride modelCapabilitiesOverrides, + /** Reasoning effort for the selected model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. */ + @JsonProperty("reasoningEffort") String reasoningEffort, + /** Reasoning summary mode for supported model clients. */ + @JsonProperty("reasoningSummary") OptionsUpdateReasoningSummary reasoningSummary, + /** Output verbosity level for supported models. */ + @JsonProperty("verbosity") Verbosity verbosity, + /** Identifier of the client driving the session. */ + @JsonProperty("clientName") String clientName, + /** Identifier sent to LSP-style integrations. */ + @JsonProperty("lspClientName") String lspClientName, + /** Stable integration identifier used for analytics and rate-limit attribution. */ + @JsonProperty("integrationId") String integrationId, + /** Map of feature-flag IDs to their boolean enabled state. */ + @JsonProperty("featureFlags") Map featureFlags, + /** Whether experimental capabilities are enabled. */ + @JsonProperty("isExperimentalMode") Boolean isExperimentalMode, + /** Custom model-provider configuration (BYOK). */ + @JsonProperty("provider") ProviderConfig provider, + /** Options scoped to the built-in CAPI (Copilot API) provider. */ + @JsonProperty("capi") CapiSessionOptions capi, + /** Absolute working-directory path for shell tools. */ + @JsonProperty("workingDirectory") String workingDirectory, + /** Allowlist of tool names available to this session. */ + @JsonProperty("availableTools") List availableTools, + /** Denylist of tool names for this session. */ + @JsonProperty("excludedTools") List excludedTools, + /** Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. */ + @JsonProperty("includedBuiltinAgents") List includedBuiltinAgents, + /** Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. */ + @JsonProperty("excludedBuiltinAgents") List excludedBuiltinAgents, + /** Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. */ + @JsonProperty("toolFilterPrecedence") OptionsUpdateToolFilterPrecedence toolFilterPrecedence, + /** Whether shell-script safety heuristics are enabled. */ + @JsonProperty("enableScriptSafety") Boolean enableScriptSafety, + /** Per-session settings for built-in shell tools. */ + @JsonProperty("shell") ShellOptions shell, + /** Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). */ + @JsonProperty("shellInitProfile") String shellInitProfile, + /** PowerShell process flags applied to built-in and user-requested shell commands. */ + @JsonProperty("shellProcessFlags") List shellProcessFlags, + /** Resolved sandbox configuration. */ + @JsonProperty("sandboxConfig") SandboxConfig sandboxConfig, + /** Whether interactive shell sessions are logged. */ + @JsonProperty("logInteractiveShells") Boolean logInteractiveShells, + /** How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). */ + @JsonProperty("envValueMode") OptionsUpdateEnvValueMode envValueMode, + /** Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. */ + @JsonProperty("allowAllMcpServerInstructions") Boolean allowAllMcpServerInstructions, + /** Additional directories to search for skills. */ + @JsonProperty("skillDirectories") List skillDirectories, + /** Skill IDs that should be excluded from this session. */ + @JsonProperty("disabledSkills") List disabledSkills, + /** Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`. */ + @JsonProperty("enableOnDemandInstructionDiscovery") Boolean enableOnDemandInstructionDiscovery, + /** Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB. */ + @JsonProperty("maxInlineBinaryBytes") Long maxInlineBinaryBytes, + /** Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. */ + @JsonProperty("installedPlugins") List installedPlugins, + /** Whether to default custom agents to local-only execution. */ + @JsonProperty("customAgentsLocalOnly") Boolean customAgentsLocalOnly, + /** When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement. */ + @JsonProperty("suppressCustomAgentPrompt") Boolean suppressCustomAgentPrompt, + /** Whether to skip loading custom instruction sources. */ + @JsonProperty("skipCustomInstructions") Boolean skipCustomInstructions, + /** Instruction source IDs to exclude from the system prompt. */ + @JsonProperty("disabledInstructionSources") List disabledInstructionSources, + /** Whether to include the `Co-authored-by` trailer in commit messages. */ + @JsonProperty("coauthorEnabled") Boolean coauthorEnabled, + /** Optional path for trajectory output. */ + @JsonProperty("trajectoryFile") String trajectoryFile, + /** Whether to stream model responses. */ + @JsonProperty("enableStreaming") Boolean enableStreaming, + /** Override URL for the Copilot API endpoint. */ + @JsonProperty("copilotUrl") String copilotUrl, + /** Whether to disable the `ask_user` tool (encourages autonomous behavior). */ + @JsonProperty("askUserDisabled") Boolean askUserDisabled, + /** Whether to allow auto-mode continuation across turns. */ + @JsonProperty("continueOnAutoMode") Boolean continueOnAutoMode, + /** Whether the session is running in an interactive UI. */ + @JsonProperty("runningInInteractiveMode") Boolean runningInInteractiveMode, + /** Whether to surface reasoning-summary events from the model. */ + @JsonProperty("enableReasoningSummaries") Boolean enableReasoningSummaries, + /** Runtime context discriminator (e.g., `cli`, `actions`). */ + @JsonProperty("agentContext") String agentContext, + /** Override directory for the session-events log. When unset, the runtime's default events log directory is used. */ + @JsonProperty("eventsLogDirectory") String eventsLogDirectory, + /** Whether subagent callback events should be forwarded into the session event log sink. */ + @JsonProperty("eventsLogIncludesSubagents") Boolean eventsLogIncludesSubagents, + /** Additional content-exclusion policies to merge into the session's policy set. */ + @JsonProperty("additionalContentExclusionPolicies") List additionalContentExclusionPolicies, + /** Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). */ + @JsonProperty("manageScheduleEnabled") Boolean manageScheduleEnabled, + /** Replaces the session's capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the field to leave the existing capability set unchanged. */ + @JsonProperty("sessionCapabilities") List sessionCapabilities, + /** Whether to skip embedding retrieval pipeline initialization and execution. */ + @JsonProperty("skipEmbeddingRetrieval") Boolean skipEmbeddingRetrieval, + /** Organization-level custom instructions to inject into the system prompt. */ + @JsonProperty("organizationCustomInstructions") String organizationCustomInstructions, + /** Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. */ + @JsonProperty("enableFileHooks") Boolean enableFileHooks, + /** Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). */ + @JsonProperty("enableHostGitOperations") Boolean enableHostGitOperations, + /** Whether to enable cross-session store writes and reads. */ + @JsonProperty("enableSessionStore") Boolean enableSessionStore, + /** Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. */ + @JsonProperty("enableSkills") Boolean enableSkills, + /** Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. */ + @JsonProperty("contextTier") OptionsUpdateContextTier contextTier, + /** Optional session limits. Pass null to clear the session limits. */ + @JsonProperty("sessionLimits") SessionLimitsConfig sessionLimits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java new file mode 100644 index 000000000..3d7d27461 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the session options patch was applied successfully. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionOptionsUpdateResult( + /** Whether the operation succeeded */ + @JsonProperty("success") Boolean success, + /** Number of hooks loaded from installed plugins, returned when installedPlugins is updated */ + @JsonProperty("pluginHookCount") Long pluginHookCount +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java index 506f1ce31..25d2e3666 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -51,6 +52,7 @@ public final class SessionPermissionsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture configure(SessionPermissionsConfigureParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -66,6 +68,7 @@ public CompletableFuture configure(SessionPer * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -78,6 +81,7 @@ public CompletableFuture * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture pendingRequests() { return caller.invoke("session.permissions.pendingRequests", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsPendingRequestsResult.class); } @@ -91,6 +95,7 @@ public CompletableFuture pendingRequest * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setApproveAll(SessionPermissionsSetApproveAllParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -98,7 +103,7 @@ public CompletableFuture setApproveAll(Se } /** - * Whether to enable full allow-all permissions for the session. + * Allow-all mode to apply for the session. *

* Note: the {@code sessionId} field in the params record is overridden * by the session-scoped wrapper; any value provided is ignored. @@ -106,6 +111,7 @@ public CompletableFuture setApproveAll(Se * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setAllowAll(SessionPermissionsSetAllowAllParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -118,6 +124,7 @@ public CompletableFuture setAllowAll(Sessio * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getAllowAll() { return caller.invoke("session.permissions.getAllowAll", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsGetAllowAllResult.class); } @@ -131,6 +138,7 @@ public CompletableFuture getAllowAll() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture modifyRules(SessionPermissionsModifyRulesParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -146,6 +154,7 @@ public CompletableFuture modifyRules(Sessio * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setRequired(SessionPermissionsSetRequiredParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -153,13 +162,19 @@ public CompletableFuture setRequired(Sessio } /** - * No parameters; clears all session-scoped tool permission approvals. + * Clears session-scoped tool permission approvals, and optionally the location-scoped ones. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. * * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ - public CompletableFuture resetSessionApprovals() { - return caller.invoke("session.permissions.resetSessionApprovals", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsResetSessionApprovalsResult.class); + @CopilotExperimental + public CompletableFuture resetSessionApprovals(SessionPermissionsResetSessionApprovalsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.permissions.resetSessionApprovals", _p, SessionPermissionsResetSessionApprovalsResult.class); } /** @@ -171,6 +186,7 @@ public CompletableFuture resetSes * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture notifyPromptShown(SessionPermissionsNotifyPromptShownParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java index 0ae82cd21..c11f46fdb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Patch of permission policy fields to apply (omit a field to leave it unchanged). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java index 267403f09..74fa82327 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsConfigureResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java index 27544af71..ac3badb6c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Folder path to add to trusted folders. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java index d7181cd86..33d0d1f54 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustAddTrustedResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java index 00191e5c4..55bac0894 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionPermissionsFolderTrustApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture isTrusted(SessionPermissionsFolderTrustIsTrustedParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -53,6 +55,7 @@ public CompletableFuture isTrusted * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture addTrusted(SessionPermissionsFolderTrustAddTrustedParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java index f8d666a88..cdd27ce5c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Folder path to check for trust. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java index c969d324b..547bf2dfa 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsFolderTrustIsTrustedResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Folder trust check result. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java index ff74dc08d..761640a4f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * No parameters. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java new file mode 100644 index 000000000..28d9915df --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Current allow-all permission mode. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPermissionsGetAllowAllResult( + /** Whether full allow-all permissions are currently active */ + @JsonProperty("enabled") Boolean enabled, + /** Current allow-all mode */ + @JsonProperty("mode") PermissionsAllowAllMode mode +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java new file mode 100644 index 000000000..a4d2ba67e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Pending permission request ID and the decision to apply (approve/reject and scope). + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPermissionsHandlePendingPermissionRequestParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Request ID of the pending permission request */ + @JsonProperty("requestId") String requestId, + /** The client's response to the pending permission prompt */ + @JsonProperty("result") Object result, + /** Optional informational context describing how and where this response was made. Omit it to preserve legacy behavior without attributing an origin. */ + @JsonProperty("decisionContext") PermissionDecisionContext decisionContext +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java index 07bcc16e7..b6bbd9853 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the permission decision was applied; false when the request was already resolved. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java index bb99721ab..f7850d8fc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Location-scoped tool approval to persist. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java index 044851720..51a05abb3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsAddToolApprovalResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java index c40877b6b..46ce8ef4d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionPermissionsLocationsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture resolve(SessionPermissionsLocationsResolveParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -53,6 +55,7 @@ public CompletableFuture resolve(Sessi * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture apply(SessionPermissionsLocationsApplyParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -68,6 +71,7 @@ public CompletableFuture apply(SessionPe * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture addToolApproval(SessionPermissionsLocationsAddToolApprovalParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java index aa40ddb2a..3581c0509 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Working directory to load persisted location permissions for. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java index 842226b32..9e6299067 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsApplyResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Summary of persisted location permissions applied to the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java index 2e4f5cf2f..9d5bac2af 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Working directory to resolve into a location-permissions key. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java index ff22dcafe..9def3d6a5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsLocationsResolveResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Resolved location-permissions key and type. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java similarity index 92% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java index 3243aea8b..ee8c29ef7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Scope and add/remove instructions for modifying session- or location-scoped permission rules. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java index 6c5c83675..edea0927a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsModifyRulesResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java index 8c4b25c72..d2f1404df 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Notification payload describing the permission prompt that the client just rendered. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java index 092d8abf8..39edeb457 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsNotifyPromptShownResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java index 272408cce..e5f35a226 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Directory path to add to the session's allowed directories. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java index 182c39b6f..306c13b09 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsAddResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java index f4fc1a770..a2a465266 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -35,6 +36,7 @@ public final class SessionPermissionsPathsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { return caller.invoke("session.permissions.paths.list", java.util.Map.of("sessionId", this.sessionId), SessionPermissionsPathsListResult.class); } @@ -48,6 +50,7 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture add(SessionPermissionsPathsAddParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -63,6 +66,7 @@ public CompletableFuture add(SessionPermission * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -78,6 +82,7 @@ public CompletableFuture updatePrima * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -93,6 +98,7 @@ public CompletableFuture isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java index c9d43aeb2..a0636492f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path to evaluate against the session's allowed directories. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java index 6e876bcca..3c1c0c468 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the supplied path is within the session's allowed directories. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java index c8fafd90c..615d6b686 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Path to evaluate against the session's workspace (primary) directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java index 3eaf87052..c3eb92bec 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsIsPathWithinWorkspaceResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the supplied path is within the session's workspace directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java index 43ae1f040..336a303fc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * No parameters; returns the session's allow-listed directories. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java index 78d86e370..6208f0d07 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Snapshot of the session's allow-listed directories and primary working directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java index 98a7ccfb2..862c8af35 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Directory path to set as the session's new primary working directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java index 7be298132..53d4e7fca 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPathsUpdatePrimaryResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java index 4e3f24cb7..84853943f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * No parameters; returns currently-pending permission requests for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java index 33769fa8b..a66bc1ddd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsPendingRequestsResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * List of pending permission requests reconstructed from event history. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java new file mode 100644 index 000000000..68ef9814d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Clears session-scoped tool permission approvals, and optionally the location-scoped ones. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPermissionsResetSessionApprovalsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Whether location-scoped approvals are cleared too. Defaults to `true`. */ + @JsonProperty("includeLocation") Boolean includeLocation +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java index 2097ed064..9dd70ec98 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java new file mode 100644 index 000000000..f31646f76 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Allow-all mode to apply for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPermissionsSetAllowAllParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM auto-approval; `off` disables both. */ + @JsonProperty("mode") PermissionsAllowAllMode mode, + /** Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`. */ + @JsonProperty("enabled") Boolean enabled, + /** Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. */ + @JsonProperty("model") String model, + /** Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. */ + @JsonProperty("source") PermissionsSetAllowAllSource source +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java new file mode 100644 index 000000000..9b14d8f6a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the operation succeeded and reports the post-mutation state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPermissionsSetAllowAllResult( + /** Whether the operation succeeded */ + @JsonProperty("success") Boolean success, + /** Authoritative full allow-all state after the mutation */ + @JsonProperty("enabled") Boolean enabled, + /** Authoritative allow-all mode after the mutation */ + @JsonProperty("mode") PermissionsAllowAllMode mode +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java index 0517a5d86..c963060fe 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Allow-all toggle for tool permission requests, with an optional telemetry source. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java index 7504cac18..68f1225b1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetApproveAllResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java index e3c3e0e34..d2aaa7466 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Toggles whether permission prompts should be bridged into session events for this client. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java index eaab9e378..14dfa223a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetRequiredResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java similarity index 96% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java index 71b97adff..5ca15960d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionPermissionsUrlsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setUnrestrictedMode(SessionPermissionsUrlsSetUnrestrictedModeParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java index 6579489eb..b4095243a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Whether the URL-permission policy should run in unrestricted mode. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java index beef183a7..9bed13ca2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsUrlsSetUnrestrictedModeResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the operation succeeded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java new file mode 100644 index 000000000..7805183dd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java @@ -0,0 +1,93 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code plan} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionPlanApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionPlanApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture read() { + return caller.invoke("session.plan.read", java.util.Map.of("sessionId", this.sessionId), SessionPlanReadResult.class); + } + + /** + * Replacement contents to write to the session plan file. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture update(SessionPlanUpdateParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.plan.update", _p, Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture delete() { + return caller.invoke("session.plan.delete", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture readSqlTodos() { + return caller.invoke("session.plan.readSqlTodos", java.util.Map.of("sessionId", this.sessionId), SessionPlanReadSqlTodosResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture readSqlTodosWithDependencies() { + return caller.invoke("session.plan.readSqlTodosWithDependencies", java.util.Map.of("sessionId", this.sessionId), SessionPlanReadSqlTodosWithDependenciesResult.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java index d47bd774e..3066bce52 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java index 57949be2b..230c76560 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java index 65a1ba75f..5fd82d3e1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Existence, contents, and resolved path of the session plan file. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java new file mode 100644 index 000000000..8a6419e15 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPlanReadSqlTodosParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java new file mode 100644 index 000000000..1230bbc02 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Todo rows read from the session SQL database. Empty when no session database is available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPlanReadSqlTodosResult( + /** Rows from the session SQL todos table, ordered by creation time and id. */ + @JsonProperty("rows") List rows +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java new file mode 100644 index 000000000..c0b49a960 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPlanReadSqlTodosWithDependenciesParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java new file mode 100644 index 000000000..505d08303 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanReadSqlTodosWithDependenciesResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Todo rows + dependency edges read from the session SQL database. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPlanReadSqlTodosWithDependenciesResult( + /** Rows from the session SQL todos table, ordered by creation time and id. Empty when no database, no todos table, or the SELECT failed. */ + @JsonProperty("rows") List rows, + /** Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does not affect the rows result and vice versa. */ + @JsonProperty("dependencies") List dependencies +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java index 128a7b814..c16c50e92 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Replacement contents to write to the session plan file. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java new file mode 100644 index 000000000..fa4da43dc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java @@ -0,0 +1,73 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code plugins} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionPluginsApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionPluginsApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("session.plugins.list", java.util.Map.of("sessionId", this.sessionId), SessionPluginsListResult.class); + } + + /** + * Optional flags controlling which side effects the reload performs. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload() { + return reload(null); + } + + /** + * Optional flags controlling which side effects the reload performs. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture reload(SessionPluginsReloadParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.plugins.reload", _p, Void.class); + } + +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java index 7229b23a0..5691b70e1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java index bdf3e6dd8..6e437eb16 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Plugins installed for the session, with their enabled state and version metadata. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsReloadParams.java new file mode 100644 index 000000000..b844a21c8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsReloadParams.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.plugins.reload} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionPluginsReloadParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Reload MCP server connections after refreshing plugins. Defaults to true. */ + @JsonProperty("reloadMcp") Boolean reloadMcp, + /** Re-run custom-agent discovery after refreshing plugins. Defaults to true. */ + @JsonProperty("reloadCustomAgents") Boolean reloadCustomAgents, + /** Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). */ + @JsonProperty("reloadHooks") Boolean reloadHooks, + /** Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). */ + @JsonProperty("reloadExtensions") Boolean reloadExtensions, + /** When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. */ + @JsonProperty("deferRepoHooks") Boolean deferRepoHooks +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java new file mode 100644 index 000000000..371c9d10d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddParams.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionProviderAddParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'. */ + @JsonProperty("providers") List providers, + /** BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry. */ + @JsonProperty("models") List models +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java new file mode 100644 index 000000000..c0a04eb8c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderAddResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * The selectable model entries synthesized for the models added by this call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionProviderAddResult( + /** Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added. */ + @JsonProperty("models") List models +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java new file mode 100644 index 000000000..b4c6b8ccd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderApi.java @@ -0,0 +1,78 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code provider} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionProviderApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionProviderApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Optional model identifier to scope the endpoint snapshot to. + *

+ * Invokes the method with no params, applying the runtime defaults. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getEndpoint() { + return getEndpoint(null); + } + + /** + * Optional model identifier to scope the endpoint snapshot to. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getEndpoint(SessionProviderGetEndpointParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = params == null ? MAPPER.createObjectNode() : MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.provider.getEndpoint", _p, SessionProviderGetEndpointResult.class); + } + + /** + * BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture add(SessionProviderAddParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.provider.add", _p, SessionProviderAddResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java new file mode 100644 index 000000000..c885b47cd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code session.provider.getEndpoint} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionProviderGetEndpointParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. */ + @JsonProperty("modelId") String modelId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java new file mode 100644 index 000000000..59ca8bca8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionProviderGetEndpointResult.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * A snapshot of the provider endpoint the session is currently configured to talk to. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionProviderGetEndpointResult( + /** Provider family. Matches the `type` field of a BYOK provider config. */ + @JsonProperty("type") ProviderEndpointType type, + /** Wire API to be used, when required for the provider type. */ + @JsonProperty("wireApi") ProviderEndpointWireApi wireApi, + /** Transport to be used for provider requests. */ + @JsonProperty("transport") ProviderEndpointTransport transport, + /** Base URL to pass to the LLM client library. */ + @JsonProperty("baseUrl") String baseUrl, + /** A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. */ + @JsonProperty("apiKey") String apiKey, + /** HTTP headers the caller must include on every outbound request. */ + @JsonProperty("headers") Map headers, + /** Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. */ + @JsonProperty("sessionToken") ProviderSessionToken sessionToken +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java new file mode 100644 index 000000000..6e40bdfeb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java @@ -0,0 +1,286 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code queue} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionQueueApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionQueueApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture pendingItems() { + return caller.invoke("session.queue.pendingItems", java.util.Map.of("sessionId", this.sessionId), SessionQueuePendingItemsResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture snapshot() { + return caller.invoke("session.queue.snapshot", java.util.Map.of("sessionId", this.sessionId), SessionQueueSnapshotResult.class); + } + + /** + * Parameters for moving a queued item by stable id. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture moveItem(SessionQueueMoveItemParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.moveItem", _p, SessionQueueMoveItemResult.class); + } + + /** + * Parameters for inserting a queued message at a public visible position. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture insertAt(SessionQueueInsertAtParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.insertAt", _p, SessionQueueInsertAtResult.class); + } + + /** + * Parameters for removing a queued item by stable id. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture removeAt(SessionQueueRemoveAtParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.removeAt", _p, SessionQueueRemoveAtResult.class); + } + + /** + * Parameters for editing a single queued message. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture updateText(SessionQueueUpdateTextParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.updateText", _p, SessionQueueUpdateTextResult.class); + } + + /** + * Parameters for duplicating a queued item. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture duplicateAt(SessionQueueDuplicateAtParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.duplicateAt", _p, SessionQueueDuplicateAtResult.class); + } + + /** + * Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture setDrainPaused(SessionQueueSetDrainPausedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.setDrainPaused", _p, Void.class); + } + + /** + * Parameters for steering a queued message into a live turn. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture sendNow(SessionQueueSendNowParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.sendNow", _p, SessionQueueSendNowResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture hasPending() { + return caller.invoke("session.queue.hasPending", java.util.Map.of("sessionId", this.sessionId), SessionQueueHasPendingResult.class); + } + + /** + * Inputs for starting a deferred-idle drain. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture beginDeferredIdleDrain(SessionQueueBeginDeferredIdleDrainParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.beginDeferredIdleDrain", _p, SessionQueueBeginDeferredIdleDrainResult.class); + } + + /** + * Inputs for completing a deferred-idle drain. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture finishDeferredIdleDrain(SessionQueueFinishDeferredIdleDrainParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.finishDeferredIdleDrain", _p, SessionQueueFinishDeferredIdleDrainResult.class); + } + + /** + * Inputs for marking session.idle deferred in native state. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture deferSessionIdle(SessionQueueDeferSessionIdleParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.deferSessionIdle", _p, Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture removeMostRecent() { + return caller.invoke("session.queue.removeMostRecent", java.util.Map.of("sessionId", this.sessionId), SessionQueueRemoveMostRecentResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture clear() { + return caller.invoke("session.queue.clear", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Internal filter for consuming queued system notifications. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture consumeSystemNotifications(SessionQueueConsumeSystemNotificationsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.queue.consumeSystemNotifications", _p, SessionQueueConsumeSystemNotificationsResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture enqueueResumePending() { + return caller.invoke("session.queue.enqueueResumePending", java.util.Map.of("sessionId", this.sessionId), SessionQueueEnqueueResumePendingResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture process() { + return caller.invoke("session.queue.process", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainParams.java new file mode 100644 index 000000000..4973e3107 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Inputs for starting a deferred-idle drain. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueBeginDeferredIdleDrainParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Whether the host still has active background work. */ + @JsonProperty("activeBackgroundWork") Boolean activeBackgroundWork +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainResult.java new file mode 100644 index 000000000..77e6decb9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueBeginDeferredIdleDrainResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether a deferred-idle drain should run. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueBeginDeferredIdleDrainResult( + /** True when the host should run finishDeferredIdleDrain asynchronously. */ + @JsonProperty("shouldDrain") Boolean shouldDrain +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java index 38d4404c7..0609819ed 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueClearParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsParams.java new file mode 100644 index 000000000..6449ce766 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Internal filter for consuming queued system notifications. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueConsumeSystemNotificationsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque runtime-owned filter object. */ + @JsonProperty("filter") Object filter +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsResult.java new file mode 100644 index 000000000..bbc371588 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueConsumeSystemNotificationsResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether a user-facing pending item was removed. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueConsumeSystemNotificationsResult( + /** True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. */ + @JsonProperty("removed") Boolean removed +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDeferSessionIdleParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDeferSessionIdleParams.java new file mode 100644 index 000000000..7b3dff9ef --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDeferSessionIdleParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Inputs for marking session.idle deferred in native state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueDeferSessionIdleParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Whether the deferred idle was caused by an aborted foreground turn. */ + @JsonProperty("aborted") Boolean aborted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtParams.java new file mode 100644 index 000000000..bf16f9d35 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for duplicating a queued item. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueDuplicateAtParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("id") String id +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtResult.java new file mode 100644 index 000000000..0be932f95 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueDuplicateAtResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of duplicating a queued item. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueDuplicateAtResult( + /** Fresh stable opaque id assigned to the duplicate. */ + @JsonProperty("id") String id +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingParams.java new file mode 100644 index 000000000..1a0ec546a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueEnqueueResumePendingParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingResult.java new file mode 100644 index 000000000..324765b4a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueEnqueueResumePendingResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of enqueueing the resume-pending wake item. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueEnqueueResumePendingResult( + /** True when a wake item was newly queued. */ + @JsonProperty("queued") Boolean queued +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainParams.java new file mode 100644 index 000000000..b6b29057d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Inputs for completing a deferred-idle drain. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueFinishDeferredIdleDrainParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Whether the host still has active background work. */ + @JsonProperty("activeBackgroundWork") Boolean activeBackgroundWork, + /** Whether native queued work remains. */ + @JsonProperty("hasPending") Boolean hasPending +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainResult.java new file mode 100644 index 000000000..1e6cc5257 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueFinishDeferredIdleDrainResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Action selected by the native deferred-idle drain. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueFinishDeferredIdleDrainResult( + /** One of none, processQueue, or emitSessionIdle. */ + @JsonProperty("action") String action, + /** Whether the deferred idle was caused by an aborted foreground turn. */ + @JsonProperty("aborted") Boolean aborted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java new file mode 100644 index 000000000..e587fec4c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueHasPendingParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingResult.java new file mode 100644 index 000000000..5373856a4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueHasPendingResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the native queue has pending work. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueHasPendingResult( + /** True when queued or immediate native work is pending. */ + @JsonProperty("hasPending") Boolean hasPending +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtParams.java new file mode 100644 index 000000000..981aefb5f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for inserting a queued message at a public visible position. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueInsertAtParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Zero-based position in the public visible queue. Values outside the queue clamp to an end. */ + @JsonProperty("position") Long position, + @JsonProperty("message") QueueInsertMessage message +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtResult.java new file mode 100644 index 000000000..1d4805e8c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueInsertAtResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of inserting a queued message. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueInsertAtResult( + /** Fresh stable opaque id assigned to the inserted item. */ + @JsonProperty("id") String id +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemParams.java new file mode 100644 index 000000000..0a584f50c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for moving a queued item by stable id. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueMoveItemParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Stable opaque queued-item id. */ + @JsonProperty("id") String id, + /** Zero-based target position in the public visible queue. Values outside the queue clamp to an end. */ + @JsonProperty("toPosition") Long toPosition +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java new file mode 100644 index 000000000..431a08175 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueMoveItemResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of moving a queued item. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueMoveItemResult( + /** True when the item changed position; false when it was already at the requested position. */ + @JsonProperty("changed") Boolean changed +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java index a4e2b10c2..c1d86d73f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java index 0a8e6540e..7b096480c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueuePendingItemsResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Snapshot of the session's pending queued items and immediate-steering messages. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java new file mode 100644 index 000000000..8c8edfe55 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueProcessParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueProcessParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtParams.java new file mode 100644 index 000000000..bc7cd3e12 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for removing a queued item by stable id. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueRemoveAtParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("id") String id +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtResult.java new file mode 100644 index 000000000..0f5d95487 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveAtResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of removing a queued item. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueRemoveAtResult( + /** True when the addressed item was removed. */ + @JsonProperty("removed") Boolean removed +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java index 26419bcea..00295c6e1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java index ecd428322..0746fe3b7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueRemoveMostRecentResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether a user-facing pending item was removed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowParams.java new file mode 100644 index 000000000..6381636a8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for steering a queued message into a live turn. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueSendNowParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("id") String id +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowResult.java new file mode 100644 index 000000000..584bd59d1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSendNowResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of trying to steer a queued message into a live turn. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueSendNowResult( + /** True when the item was accepted into the steering lane; false when no main turn was live. */ + @JsonProperty("steered") Boolean steered +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSetDrainPausedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSetDrainPausedParams.java new file mode 100644 index 000000000..f51e33ea1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSetDrainPausedParams.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueSetDrainPausedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("paused") Boolean paused +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotParams.java new file mode 100644 index 000000000..dff5db8a8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueSnapshotParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotResult.java new file mode 100644 index 000000000..7ae1076d6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueSnapshotResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Internal snapshot of native queue state for local session orchestration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueSnapshotResult( + /** User-facing pending items in FIFO order. */ + @JsonProperty("items") List items, + /** Immediate steering messages waiting for an active turn. */ + @JsonProperty("steeringMessages") List steeringMessages, + /** Insertion orders for queued items, aligned with `items`. */ + @JsonProperty("itemOrders") List itemOrders, + /** Insertion orders for immediate steering messages, aligned with `steeringMessages`. */ + @JsonProperty("steeringMessageOrders") List steeringMessageOrders +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextParams.java new file mode 100644 index 000000000..139a5ba2a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for editing a single queued message. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueUpdateTextParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + @JsonProperty("id") String id, + @JsonProperty("prompt") String prompt, + @JsonProperty("displayPrompt") String displayPrompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextResult.java new file mode 100644 index 000000000..3809f5bd6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionQueueUpdateTextResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of editing a queued message. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionQueueUpdateTextResult( + /** True when the stored text changed. */ + @JsonProperty("updated") Boolean updated +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java index 3e4f2ce8c..bb1cfa0e2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionRemoteApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture enable(SessionRemoteEnableParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -50,6 +52,7 @@ public CompletableFuture enable(SessionRemoteEnablePa * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture disable() { return caller.invoke("session.remote.disable", java.util.Map.of("sessionId", this.sessionId), Void.class); } @@ -63,6 +66,7 @@ public CompletableFuture disable() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java index a49197aa1..b406128db 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteDisableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java index 20c3db98a..59c7793c7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java index 5b282f91b..f86558eb6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteEnableResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * GitHub URL for the session and a flag indicating whether remote steering is enabled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java index 13df7f676..4e4e99d86 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * New remote-steerability state to persist as a `session.remote_steerable_changed` event. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java new file mode 100644 index 000000000..05cfd396d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java @@ -0,0 +1,292 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * Typed client for session-scoped RPC methods. + *

+ * Provides strongly-typed access to all session-level API namespaces. + * The {@code sessionId} is injected automatically into every call. + *

+ * Obtain an instance by calling {@code new SessionRpc(caller, sessionId)}. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionRpc { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** API methods for the {@code gitHubAuth} namespace. */ + public final SessionGitHubAuthApi gitHubAuth; + /** API methods for the {@code debug} namespace. */ + public final SessionDebugApi debug; + /** API methods for the {@code canvas} namespace. */ + public final SessionCanvasApi canvas; + /** API methods for the {@code factory} namespace. */ + public final SessionFactoryApi factory; + /** API methods for the {@code model} namespace. */ + public final SessionModelApi model; + /** API methods for the {@code mode} namespace. */ + public final SessionModeApi mode; + /** API methods for the {@code name} namespace. */ + public final SessionNameApi name; + /** API methods for the {@code plan} namespace. */ + public final SessionPlanApi plan; + /** API methods for the {@code workspaces} namespace. */ + public final SessionWorkspacesApi workspaces; + /** API methods for the {@code completions} namespace. */ + public final SessionCompletionsApi completions; + /** API methods for the {@code instructions} namespace. */ + public final SessionInstructionsApi instructions; + /** API methods for the {@code fleet} namespace. */ + public final SessionFleetApi fleet; + /** API methods for the {@code agent} namespace. */ + public final SessionAgentApi agent; + /** API methods for the {@code tasks} namespace. */ + public final SessionTasksApi tasks; + /** API methods for the {@code skills} namespace. */ + public final SessionSkillsApi skills; + /** API methods for the {@code mcp} namespace. */ + public final SessionMcpApi mcp; + /** API methods for the {@code plugins} namespace. */ + public final SessionPluginsApi plugins; + /** API methods for the {@code provider} namespace. */ + public final SessionProviderApi provider; + /** API methods for the {@code options} namespace. */ + public final SessionOptionsApi options; + /** API methods for the {@code lsp} namespace. */ + public final SessionLspApi lsp; + /** API methods for the {@code extensions} namespace. */ + public final SessionExtensionsApi extensions; + /** API methods for the {@code tools} namespace. */ + public final SessionToolsApi tools; + /** API methods for the {@code commands} namespace. */ + public final SessionCommandsApi commands; + /** API methods for the {@code telemetry} namespace. */ + public final SessionTelemetryApi telemetry; + /** API methods for the {@code ui} namespace. */ + public final SessionUiApi ui; + /** API methods for the {@code permissions} namespace. */ + public final SessionPermissionsApi permissions; + /** API methods for the {@code metadata} namespace. */ + public final SessionMetadataApi metadata; + /** API methods for the {@code settings} namespace. */ + public final SessionSettingsApi settings; + /** API methods for the {@code contentExclusion} namespace. */ + public final SessionContentExclusionApi contentExclusion; + /** API methods for the {@code shell} namespace. */ + public final SessionShellApi shell; + /** API methods for the {@code history} namespace. */ + public final SessionHistoryApi history; + /** API methods for the {@code queue} namespace. */ + public final SessionQueueApi queue; + /** API methods for the {@code eventLog} namespace. */ + public final SessionEventLogApi eventLog; + /** API methods for the {@code usage} namespace. */ + public final SessionUsageApi usage; + /** API methods for the {@code limitPrediction} namespace. */ + public final SessionLimitPredictionApi limitPrediction; + /** API methods for the {@code remote} namespace. */ + public final SessionRemoteApi remote; + /** API methods for the {@code visibility} namespace. */ + public final SessionVisibilityApi visibility; + /** API methods for the {@code schedule} namespace. */ + public final SessionScheduleApi schedule; + + /** + * Creates a new session RPC client. + * + * @param caller the RPC transport function (e.g., {@code jsonRpcClient::invoke}) + * @param sessionId the session ID to inject into every request + */ + public SessionRpc(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + this.gitHubAuth = new SessionGitHubAuthApi(caller, sessionId); + this.debug = new SessionDebugApi(caller, sessionId); + this.canvas = new SessionCanvasApi(caller, sessionId); + this.factory = new SessionFactoryApi(caller, sessionId); + this.model = new SessionModelApi(caller, sessionId); + this.mode = new SessionModeApi(caller, sessionId); + this.name = new SessionNameApi(caller, sessionId); + this.plan = new SessionPlanApi(caller, sessionId); + this.workspaces = new SessionWorkspacesApi(caller, sessionId); + this.completions = new SessionCompletionsApi(caller, sessionId); + this.instructions = new SessionInstructionsApi(caller, sessionId); + this.fleet = new SessionFleetApi(caller, sessionId); + this.agent = new SessionAgentApi(caller, sessionId); + this.tasks = new SessionTasksApi(caller, sessionId); + this.skills = new SessionSkillsApi(caller, sessionId); + this.mcp = new SessionMcpApi(caller, sessionId); + this.plugins = new SessionPluginsApi(caller, sessionId); + this.provider = new SessionProviderApi(caller, sessionId); + this.options = new SessionOptionsApi(caller, sessionId); + this.lsp = new SessionLspApi(caller, sessionId); + this.extensions = new SessionExtensionsApi(caller, sessionId); + this.tools = new SessionToolsApi(caller, sessionId); + this.commands = new SessionCommandsApi(caller, sessionId); + this.telemetry = new SessionTelemetryApi(caller, sessionId); + this.ui = new SessionUiApi(caller, sessionId); + this.permissions = new SessionPermissionsApi(caller, sessionId); + this.metadata = new SessionMetadataApi(caller, sessionId); + this.settings = new SessionSettingsApi(caller, sessionId); + this.contentExclusion = new SessionContentExclusionApi(caller, sessionId); + this.shell = new SessionShellApi(caller, sessionId); + this.history = new SessionHistoryApi(caller, sessionId); + this.queue = new SessionQueueApi(caller, sessionId); + this.eventLog = new SessionEventLogApi(caller, sessionId); + this.usage = new SessionUsageApi(caller, sessionId); + this.limitPrediction = new SessionLimitPredictionApi(caller, sessionId); + this.remote = new SessionRemoteApi(caller, sessionId); + this.visibility = new SessionVisibilityApi(caller, sessionId); + this.schedule = new SessionScheduleApi(caller, sessionId); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture suspend() { + return caller.invoke("session.suspend", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Parameters for sending a user message to the session + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture send(SessionSendParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.send", _p, SessionSendResult.class); + } + + /** + * Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture sendMessages(SessionSendMessagesParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.sendMessages", _p, SessionSendMessagesResult.class); + } + + /** + * Internal request for sending a system notification. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture sendSystemNotification(SessionSendSystemNotificationParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.sendSystemNotification", _p, Void.class); + } + + /** + * Parameters for aborting the current turn + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture abort(SessionAbortParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.abort", _p, SessionAbortResult.class); + } + + /** + * Parameters for interrupting the main agent turn. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture interruptMainTurn(SessionInterruptMainTurnParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.interruptMainTurn", _p, SessionInterruptMainTurnResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture cancelAllBackgroundAgents() { + return caller.invoke("session.cancelAllBackgroundAgents", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Parameters for shutting down the session + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture shutdown(SessionShutdownParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.shutdown", _p, Void.class); + } + + /** + * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture log(SessionLogParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.log", _p, SessionLogResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtParams.java new file mode 100644 index 000000000..0a099bdf4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Register an absolute-time scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddAtParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Epoch milliseconds when the prompt should fire. */ + @JsonProperty("at") Long at, + /** Prompt text to enqueue when the schedule fires. */ + @JsonProperty("prompt") String prompt, + /** Whether the schedule should re-arm after each tick. Defaults to false. */ + @JsonProperty("recurring") Boolean recurring, + /** Optional display-only prompt label. */ + @JsonProperty("displayPrompt") String displayPrompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtResult.java new file mode 100644 index 000000000..7952fdc88 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddAtResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering or re-arming a scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddAtResult( + /** The registered or updated schedule entry. */ + @JsonProperty("entry") ScheduleEntry entry, + /** User-facing validation error, when registration failed. */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronParams.java new file mode 100644 index 000000000..08a9cd33b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronParams.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Register a cron scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddCronParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** 5-field cron expression. */ + @JsonProperty("cron") String cron, + /** Prompt text to enqueue when the schedule fires. */ + @JsonProperty("prompt") String prompt, + /** Whether the schedule should re-arm after each tick. Defaults to true. */ + @JsonProperty("recurring") Boolean recurring, + /** Optional display-only prompt label. */ + @JsonProperty("displayPrompt") String displayPrompt, + /** IANA timezone for evaluating the cron expression. */ + @JsonProperty("tz") String tz +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronResult.java new file mode 100644 index 000000000..193dea1b4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddCronResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering or re-arming a scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddCronResult( + /** The registered or updated schedule entry. */ + @JsonProperty("entry") ScheduleEntry entry, + /** User-facing validation error, when registration failed. */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddParams.java new file mode 100644 index 000000000..31580758c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Register a relative-interval scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Human-readable interval such as `30s`, `5m`, or `2h`. */ + @JsonProperty("interval") String interval, + /** Prompt text to enqueue when the schedule fires. */ + @JsonProperty("prompt") String prompt, + /** Whether the schedule should re-arm after each tick. Defaults to true. */ + @JsonProperty("recurring") Boolean recurring, + /** Optional display-only prompt label. */ + @JsonProperty("displayPrompt") String displayPrompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java new file mode 100644 index 000000000..021c784c3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering or re-arming a scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddResult( + /** The registered or updated schedule entry. */ + @JsonProperty("entry") ScheduleEntry entry, + /** User-facing validation error, when registration failed. */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedParams.java new file mode 100644 index 000000000..17a89c1b2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Register a self-paced scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddSelfPacedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Prompt text to enqueue when the schedule fires. */ + @JsonProperty("prompt") String prompt, + /** Optional display-only prompt label. */ + @JsonProperty("displayPrompt") String displayPrompt +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedResult.java new file mode 100644 index 000000000..65f8745ba --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleAddSelfPacedResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering or re-arming a scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleAddSelfPacedResult( + /** The registered or updated schedule entry. */ + @JsonProperty("entry") ScheduleEntry entry, + /** User-facing validation error, when registration failed. */ + @JsonProperty("error") String error +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java new file mode 100644 index 000000000..f983f84f7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java @@ -0,0 +1,162 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code schedule} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionScheduleApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionScheduleApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture list() { + return caller.invoke("session.schedule.list", java.util.Map.of("sessionId", this.sessionId), SessionScheduleListResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture hydrate() { + return caller.invoke("session.schedule.hydrate", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture hasSelfPaced() { + return caller.invoke("session.schedule.hasSelfPaced", java.util.Map.of("sessionId", this.sessionId), SessionScheduleHasSelfPacedResult.class); + } + + /** + * Register a relative-interval scheduled prompt. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture add(SessionScheduleAddParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.add", _p, SessionScheduleAddResult.class); + } + + /** + * Register a cron scheduled prompt. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture addCron(SessionScheduleAddCronParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.addCron", _p, SessionScheduleAddCronResult.class); + } + + /** + * Register an absolute-time scheduled prompt. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture addAt(SessionScheduleAddAtParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.addAt", _p, SessionScheduleAddAtResult.class); + } + + /** + * Register a self-paced scheduled prompt. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture addSelfPaced(SessionScheduleAddSelfPacedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.addSelfPaced", _p, SessionScheduleAddSelfPacedResult.class); + } + + /** + * Re-arm a self-paced scheduled prompt. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture rearmSelfPaced(SessionScheduleRearmSelfPacedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.rearmSelfPaced", _p, SessionScheduleRearmSelfPacedResult.class); + } + + /** + * Identifier of the scheduled prompt to remove. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture stop(SessionScheduleStopParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.schedule.stop", _p, SessionScheduleStopResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedParams.java new file mode 100644 index 000000000..7eb31df7f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleHasSelfPacedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedResult.java new file mode 100644 index 000000000..84c8e7a50 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHasSelfPacedResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the session currently has an active self-paced schedule. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleHasSelfPacedResult( + /** True when at least one active schedule is self-paced. */ + @JsonProperty("hasSelfPaced") Boolean hasSelfPaced +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHydrateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHydrateParams.java new file mode 100644 index 000000000..32ec85c7d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleHydrateParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleHydrateParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java index 3dda01502..f8b3f9dcd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java index 6a5ec101c..18372faa0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Snapshot of the currently active recurring prompts for this session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedParams.java new file mode 100644 index 000000000..d1999311c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Re-arm a self-paced scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleRearmSelfPacedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Id of the self-paced scheduled prompt. */ + @JsonProperty("id") Long id, + /** Epoch milliseconds when the prompt should next fire. */ + @JsonProperty("at") Long at +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedResult.java new file mode 100644 index 000000000..0280fbacc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleRearmSelfPacedResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of registering or re-arming a scheduled prompt. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionScheduleRearmSelfPacedResult( + /** The registered or updated schedule entry. */ + @JsonProperty("entry") ScheduleEntry entry, + /** User-facing validation error, when registration failed. */ + @JsonProperty("error") String error +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java index 321599991..c2656f0fc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the scheduled prompt to remove. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java index b61b0bb9e..fe7b9d414 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleStopResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java new file mode 100644 index 000000000..294319204 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesParams.java @@ -0,0 +1,48 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSendMessagesParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message. */ + @JsonProperty("messages") List messages, + /** How to deliver the messages. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. */ + @JsonProperty("mode") SendMode mode, + /** If true, adds the messages to the front of the queue instead of the end */ + @JsonProperty("prepend") Boolean prepend, + /** The UI mode the agent was in when these messages were sent. Defaults to the session's current mode. */ + @JsonProperty("agentMode") SendAgentMode agentMode, + /** Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. */ + @JsonProperty("requestHeaders") Map requestHeaders, + /** W3C Trace Context traceparent header for distributed tracing of this agent turn */ + @JsonProperty("traceparent") String traceparent, + /** W3C Trace Context tracestate header for distributed tracing */ + @JsonProperty("tracestate") String tracestate, + /** If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. */ + @JsonProperty("wait") Boolean wait_ +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java new file mode 100644 index 000000000..aeb556ba0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendMessagesResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Result of sending zero or more user messages + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSendMessagesResult( + /** Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided. */ + @JsonProperty("messageIds") List messageIds +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java index 42177c82d..f19c85ebe 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendParams.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import java.util.Map; import javax.annotation.processing.Generated; @@ -17,8 +18,10 @@ /** * Parameters for sending a user message to the session * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -39,8 +42,8 @@ public record SessionSendParams( @JsonProperty("billable") Boolean billable, /** If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange */ @JsonProperty("requiredTool") String requiredTool, - /** Optional provenance tag copied to the resulting user.message event. Supported values are `system`, `command-*`, and `schedule-*`. */ - @JsonProperty("source") Object source, + /** Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. */ + @JsonProperty("source") String source, /** The UI mode the agent was in when this message was sent. Defaults to the session's current mode. */ @JsonProperty("agentMode") SendAgentMode agentMode, /** Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. */ @@ -49,7 +52,7 @@ public record SessionSendParams( @JsonProperty("traceparent") String traceparent, /** W3C Trace Context tracestate header for distributed tracing */ @JsonProperty("tracestate") String tracestate, - /** If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. */ + /** If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. */ @JsonProperty("wait") Boolean wait_ ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java index 747435e18..45fe54fca 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Result of sending a user message * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendSystemNotificationParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendSystemNotificationParams.java new file mode 100644 index 000000000..762fe6ef3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSendSystemNotificationParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Internal request for sending a system notification. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSendSystemNotificationParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Notification text to deliver to the model. */ + @JsonProperty("message") String message, + /** Optional structured notification kind. */ + @JsonProperty("kind") Object kind, + /** Internal delivery options, including passive policy. */ + @JsonProperty("options") Object options +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java new file mode 100644 index 000000000..dd4acfdb5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsApi.java @@ -0,0 +1,60 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code settings} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionSettingsApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionSettingsApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture snapshot() { + return caller.invoke("session.settings.snapshot", java.util.Map.of("sessionId", this.sessionId), SessionSettingsSnapshotResult.class); + } + + /** + * Named Rust-owned settings predicate to evaluate for this session. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture evaluatePredicate(SessionSettingsEvaluatePredicateParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.settings.evaluatePredicate", _p, SessionSettingsEvaluatePredicateResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java new file mode 100644 index 000000000..98e6df29f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsBuiltInToolAvailabilitySnapshot.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Availability of built-in job tools surfaced to boundary consumers. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsBuiltInToolAvailabilitySnapshot( + @JsonProperty("reportProgress") Boolean reportProgress, + @JsonProperty("createPullRequest") Boolean createPullRequest +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java new file mode 100644 index 000000000..a7c1663e2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Named Rust-owned settings predicate to evaluate for this session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsEvaluatePredicateParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Predicate name. The runtime owns the raw feature-flag names and composition logic. */ + @JsonProperty("name") SessionSettingsPredicateName name, + /** Tool name for tool-scoped predicates such as trivial-change handling. */ + @JsonProperty("toolName") String toolName +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java new file mode 100644 index 000000000..1f4a7ed32 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsEvaluatePredicateResult.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of evaluating a Rust-owned settings predicate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsEvaluatePredicateResult( + @JsonProperty("enabled") Boolean enabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java new file mode 100644 index 000000000..463660d8a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsJobSnapshot.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Redacted job settings for a session. The job nonce is excluded. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsJobSnapshot( + @JsonProperty("eventType") String eventType, + @JsonProperty("isTriggerJob") Boolean isTriggerJob, + @JsonProperty("builtInToolAvailability") SessionSettingsBuiltInToolAvailabilitySnapshot builtInToolAvailability +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java new file mode 100644 index 000000000..ce515c74d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsModelSnapshot.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Redacted model routing settings for a session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsModelSnapshot( + @JsonProperty("model") String model, + @JsonProperty("defaultReasoningEffort") String defaultReasoningEffort, + @JsonProperty("instanceId") String instanceId, + @JsonProperty("callbackUrl") String callbackUrl +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java new file mode 100644 index 000000000..b1a5be6f3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsOnlineEvaluationSnapshot.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Online-evaluation settings safe to expose across the SDK boundary. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsOnlineEvaluationSnapshot( + @JsonProperty("disableOnlineEvaluation") Boolean disableOnlineEvaluation, + @JsonProperty("enableOnlineEvaluationOutputFile") Boolean enableOnlineEvaluationOutputFile +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java new file mode 100644 index 000000000..6c99c214a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsPredicateName.java @@ -0,0 +1,69 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionSettingsPredicateName { + /** The {@code securityToolsEnabled} variant. */ + SECURITYTOOLSENABLED("securityToolsEnabled"), + /** The {@code thirdPartySecurityPromptEnabled} variant. */ + THIRDPARTYSECURITYPROMPTENABLED("thirdPartySecurityPromptEnabled"), + /** The {@code parallelValidationEnabled} variant. */ + PARALLELVALIDATIONENABLED("parallelValidationEnabled"), + /** The {@code runtimeTimingTelemetryEnabled} variant. */ + RUNTIMETIMINGTELEMETRYENABLED("runtimeTimingTelemetryEnabled"), + /** The {@code coAuthorHookEnabled} variant. */ + COAUTHORHOOKENABLED("coAuthorHookEnabled"), + /** The {@code chronicleEnabled} variant. */ + CHRONICLEENABLED("chronicleEnabled"), + /** The {@code contentExclusionSelfFetchEnabled} variant. */ + CONTENTEXCLUSIONSELFFETCHENABLED("contentExclusionSelfFetchEnabled"), + /** The {@code capClaudeOpusTokenLimitsEnabled} variant. */ + CAPCLAUDEOPUSTOKENLIMITSENABLED("capClaudeOpusTokenLimitsEnabled"), + /** The {@code codeReviewFeatureEnabled} variant. */ + CODEREVIEWFEATUREENABLED("codeReviewFeatureEnabled"), + /** The {@code ccaUseTsAutofindEnabled} variant. */ + CCAUSETSAUTOFINDENABLED("ccaUseTsAutofindEnabled"), + /** The {@code dependencyCheckerEnabled} variant. */ + DEPENDENCYCHECKERENABLED("dependencyCheckerEnabled"), + /** The {@code dependabotCheckerEnabled} variant. */ + DEPENDABOTCHECKERENABLED("dependabotCheckerEnabled"), + /** The {@code codeqlCheckerEnabled} variant. */ + CODEQLCHECKERENABLED("codeqlCheckerEnabled"), + /** The {@code trivialChangeEnabled} variant. */ + TRIVIALCHANGEENABLED("trivialChangeEnabled"), + /** The {@code trivialChangeSkipEnabled} variant. */ + TRIVIALCHANGESKIPENABLED("trivialChangeSkipEnabled"), + /** The {@code trivialChangeEnabledForCodeReview} variant. */ + TRIVIALCHANGEENABLEDFORCODEREVIEW("trivialChangeEnabledForCodeReview"), + /** The {@code trivialChangeSkipEnabledForCodeReview} variant. */ + TRIVIALCHANGESKIPENABLEDFORCODEREVIEW("trivialChangeSkipEnabledForCodeReview"), + /** The {@code trivialChangeEnabledForTool} variant. */ + TRIVIALCHANGEENABLEDFORTOOL("trivialChangeEnabledForTool"), + /** The {@code trivialChangeSkipEnabledForTool} variant. */ + TRIVIALCHANGESKIPENABLEDFORTOOL("trivialChangeSkipEnabledForTool"); + + private final String value; + SessionSettingsPredicateName(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionSettingsPredicateName fromValue(String value) { + for (SessionSettingsPredicateName v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionSettingsPredicateName value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java new file mode 100644 index 000000000..960853c52 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsRepoSnapshot.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Redacted repository and GitHub host settings for a session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsRepoSnapshot( + @JsonProperty("name") String name, + @JsonProperty("id") Double id, + @JsonProperty("branch") String branch, + @JsonProperty("commit") String commit, + @JsonProperty("readWrite") Boolean readWrite, + @JsonProperty("ownerName") String ownerName, + @JsonProperty("ownerId") Double ownerId, + @JsonProperty("serverUrl") String serverUrl, + @JsonProperty("host") String host, + @JsonProperty("hostProtocol") String hostProtocol, + @JsonProperty("secretScanningUrl") String secretScanningUrl, + @JsonProperty("prCommitCount") Double prCommitCount +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java new file mode 100644 index 000000000..8bad93152 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsSnapshotParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java new file mode 100644 index 000000000..0851474d6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsSnapshotResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsSnapshotResult( + @JsonProperty("version") String version, + @JsonProperty("clientName") String clientName, + @JsonProperty("timeoutMs") Double timeoutMs, + @JsonProperty("startTimeMs") Double startTimeMs, + @JsonProperty("repo") SessionSettingsRepoSnapshot repo, + @JsonProperty("model") SessionSettingsModelSnapshot model, + @JsonProperty("validation") SessionSettingsValidationSnapshot validation, + @JsonProperty("job") SessionSettingsJobSnapshot job, + @JsonProperty("onlineEvaluation") SessionSettingsOnlineEvaluationSnapshot onlineEvaluation +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java new file mode 100644 index 000000000..375cfdfec --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSettingsValidationSnapshot.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Redacted validation and memory-tool settings for a session. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionSettingsValidationSnapshot( + @JsonProperty("timeout") Double timeout, + @JsonProperty("dependabotTimeout") Double dependabotTimeout, + @JsonProperty("codeqlEnabled") Boolean codeqlEnabled, + @JsonProperty("codeReviewEnabled") Boolean codeReviewEnabled, + @JsonProperty("codeReviewModel") String codeReviewModel, + @JsonProperty("advisoryEnabled") Boolean advisoryEnabled, + @JsonProperty("secretScanningEnabled") Boolean secretScanningEnabled, + @JsonProperty("memoryStoreEnabled") Boolean memoryStoreEnabled, + @JsonProperty("memoryVoteEnabled") Boolean memoryVoteEnabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java new file mode 100644 index 000000000..b96ac87ea --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java @@ -0,0 +1,97 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code shell} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionShellApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionShellApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Shell command to run, with optional working directory and timeout in milliseconds. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture exec(SessionShellExecParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.shell.exec", _p, SessionShellExecResult.class); + } + + /** + * Identifier of a process previously returned by "shell.exec" and the signal to send. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture kill(SessionShellKillParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.shell.kill", _p, SessionShellKillResult.class); + } + + /** + * User-requested shell command and cancellation handle. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture executeUserRequested(SessionShellExecuteUserRequestedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.shell.executeUserRequested", _p, SessionShellExecuteUserRequestedResult.class); + } + + /** + * User-requested shell execution cancellation handle. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture cancelUserRequested(SessionShellCancelUserRequestedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.shell.cancelUserRequested", _p, SessionShellCancelUserRequestedResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java new file mode 100644 index 000000000..d3ac50173 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * User-requested shell execution cancellation handle. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionShellCancelUserRequestedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Request ID previously passed to executeUserRequested */ + @JsonProperty("requestId") String requestId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java new file mode 100644 index 000000000..6284ce290 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellCancelUserRequestedResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Cancellation result for a user-requested shell command. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionShellCancelUserRequestedResult( + /** Whether an in-flight execution was found and signalled to cancel */ + @JsonProperty("cancelled") Boolean cancelled +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java index 817adc93c..5ef68032d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Shell command to run, with optional working directory and timeout in milliseconds. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java index 28a756535..145d5cbb8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the spawned process, used to correlate streamed output and exit notifications. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java new file mode 100644 index 000000000..35d34295e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * User-requested shell command and cancellation handle. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionShellExecuteUserRequestedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Caller-provided cancellation handle for this execution */ + @JsonProperty("requestId") String requestId, + /** Shell command to execute */ + @JsonProperty("command") String command +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java new file mode 100644 index 000000000..eba71bb6c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellExecuteUserRequestedResult.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of a user-requested shell command. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionShellExecuteUserRequestedResult( + /** Tool call id emitted for the shell execution */ + @JsonProperty("toolCallId") String toolCallId, + /** Whether the command completed successfully */ + @JsonProperty("success") Boolean success, + /** Captured command output */ + @JsonProperty("output") String output, + /** Process exit code, when available */ + @JsonProperty("exitCode") Long exitCode, + /** Error output when the execution failed */ + @JsonProperty("error") String error +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java index 1b26f1cb4..2df40c1e5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of a process previously returned by "shell.exec" and the signal to send. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java index db3ff08cf..26fe140ea 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShellKillResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the signal was delivered; false if the process was unknown or already exited. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java index c17bef956..bf5303750 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionShutdownParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Parameters for shutting down the session * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java index 0d6a2fec3..f6cceb98b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -35,6 +36,7 @@ public final class SessionSkillsApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { return caller.invoke("session.skills.list", java.util.Map.of("sessionId", this.sessionId), SessionSkillsListResult.class); } @@ -45,6 +47,7 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getInvoked() { return caller.invoke("session.skills.getInvoked", java.util.Map.of("sessionId", this.sessionId), SessionSkillsGetInvokedResult.class); } @@ -58,6 +61,7 @@ public CompletableFuture getInvoked() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture enable(SessionSkillsEnableParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -73,6 +77,7 @@ public CompletableFuture enable(SessionSkillsEnableParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture disable(SessionSkillsDisableParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -85,6 +90,7 @@ public CompletableFuture disable(SessionSkillsDisableParams params) { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture reload() { return caller.invoke("session.skills.reload", java.util.Map.of("sessionId", this.sessionId), SessionSkillsReloadResult.class); } @@ -95,6 +101,7 @@ public CompletableFuture reload() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture ensureLoaded() { return caller.invoke("session.skills.ensureLoaded", java.util.Map.of("sessionId", this.sessionId), Void.class); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java index ba1df8ea2..f422f9d32 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Name of the skill to disable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java index 6e6a7fd62..a2202cbc9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Name of the skill to enable for the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java index 1d5a7f102..b60f393f7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnsureLoadedParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java index c17c00d07..0df5c9a8a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java index ed62e0fc7..f9e3ae4d1 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsGetInvokedResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Skills invoked during this session, ordered by invocation time (most recent last). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java index 1d45d8fa9..8b8e33719 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java index ded58a52f..7c6048170 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Skills available to the session, with their enabled state. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java index 3d580001c..2b0001e8a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java index 38c426e5b..70a90cf36 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsReloadResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Diagnostics from reloading skill definitions, with warnings and errors as separate lists. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSource.java new file mode 100644 index 000000000..2914e3c30 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSource.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Which session sources to include. Defaults to `local` for backward compatibility. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionSource { + /** The {@code local} variant. */ + LOCAL("local"), + /** The {@code remote} variant. */ + REMOTE("remote"), + /** The {@code all} variant. */ + ALL("all"); + + private final String value; + SessionSource(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionSource fromValue(String value) { + for (SessionSource v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionSource value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java index 4ca1c33ab..52db09864 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionSuspendParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java similarity index 95% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java index f203c536c..68f038eb4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -38,6 +39,7 @@ public final class SessionTasksApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture startAgent(SessionTasksStartAgentParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -50,6 +52,7 @@ public CompletableFuture startAgent(SessionTasksSt * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture list() { return caller.invoke("session.tasks.list", java.util.Map.of("sessionId", this.sessionId), SessionTasksListResult.class); } @@ -60,6 +63,7 @@ public CompletableFuture list() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture refresh() { return caller.invoke("session.tasks.refresh", java.util.Map.of("sessionId", this.sessionId), Void.class); } @@ -70,6 +74,7 @@ public CompletableFuture refresh() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture waitForPending() { return caller.invoke("session.tasks.waitForPending", java.util.Map.of("sessionId", this.sessionId), Void.class); } @@ -83,6 +88,7 @@ public CompletableFuture waitForPending() { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getProgress(SessionTasksGetProgressParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -95,6 +101,7 @@ public CompletableFuture getProgress(SessionTasks * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getCurrentPromotable() { return caller.invoke("session.tasks.getCurrentPromotable", java.util.Map.of("sessionId", this.sessionId), SessionTasksGetCurrentPromotableResult.class); } @@ -108,6 +115,7 @@ public CompletableFuture getCurrentPromo * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture promoteToBackground(SessionTasksPromoteToBackgroundParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -120,6 +128,7 @@ public CompletableFuture promoteToBackgro * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture promoteCurrentToBackground() { return caller.invoke("session.tasks.promoteCurrentToBackground", java.util.Map.of("sessionId", this.sessionId), SessionTasksPromoteCurrentToBackgroundResult.class); } @@ -133,6 +142,7 @@ public CompletableFuture promoteCu * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture cancel(SessionTasksCancelParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -148,6 +158,7 @@ public CompletableFuture cancel(SessionTasksCancelPara * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture remove(SessionTasksRemoveParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -163,6 +174,7 @@ public CompletableFuture remove(SessionTasksRemovePara * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture sendMessage(SessionTasksSendMessageParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java index 56fab2d64..70437a93a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the background task to cancel. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java index ffb17a6f0..9e654bad0 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksCancelResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the background task was successfully cancelled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java index 25a78bbc7..08d95da52 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java index 4ca2200ec..d987595b8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetCurrentPromotableResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The first sync-waiting task that can currently be promoted to background mode. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java index 0081430c5..98b2f88e3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the background task to fetch progress for. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java index 6f24e4bc9..7f09aa5af 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksGetProgressResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Progress information for the task, or null when no task with that ID is tracked. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java index d645ee348..9c7acf9a4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java index ec52af751..f3ef98142 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Background tasks currently tracked by the session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java index b7ec7e39e..e4d8eb847 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java index 702aa1c4e..ca66927b9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteCurrentToBackgroundResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The promoted task as it now exists in background mode, omitted if no promotable task was waiting. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java index f75e97f39..a6d5d3efd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the task to promote to background mode. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java index 5ed332b17..7bdf927bb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksPromoteToBackgroundResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the task was successfully promoted to background mode. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java index da6e164df..d7bb504c9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java index 66a730590..e5264b22d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the completed or cancelled task to remove from tracking. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java index 0d4173cac..4bb6dfd26 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRemoveResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the task was removed. False when the task does not exist or is still running/idle. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java index 841ad104a..54c1ed4ac 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier of the target agent task, message content, and optional sender agent ID. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java index dee710d95..4bdf603fb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksSendMessageResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the message was delivered, with an error message when delivery failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java index f146e6e91..82daeec5e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Agent type, prompt, name, and optional description and model override for the new task. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java index 24cd051ce..46dbb0bdc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksStartAgentResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier assigned to the newly started background agent task. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java index 916c9f424..260d43de9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java similarity index 77% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java index 92c24b4e8..42589661e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -29,6 +30,17 @@ public final class SessionTelemetryApi { this.sessionId = sessionId; } + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getEngagementId() { + return caller.invoke("session.telemetry.getEngagementId", java.util.Map.of("sessionId", this.sessionId), SessionTelemetryGetEngagementIdResult.class); + } + /** * Feature override key/value pairs to attach to subsequent telemetry events from this session. *

@@ -38,6 +50,7 @@ public final class SessionTelemetryApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture setFeatureOverrides(SessionTelemetrySetFeatureOverridesParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java new file mode 100644 index 000000000..ed6e736a6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionTelemetryGetEngagementIdParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java new file mode 100644 index 000000000..a538455c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetryGetEngagementIdResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Telemetry engagement ID for the session, when available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionTelemetryGetEngagementIdResult( + /** Current telemetry engagement ID, when available. */ + @JsonProperty("engagementId") String engagementId +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java index d0f364e23..a46aae93b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionTelemetrySetFeatureOverridesParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * Feature override key/value pairs to attach to subsequent telemetry events from this session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java new file mode 100644 index 000000000..0f4b05882 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java @@ -0,0 +1,87 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code tools} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionToolsApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionToolsApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Pending external tool call request ID, with the tool result or an error describing why it failed. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture handlePendingToolCall(SessionToolsHandlePendingToolCallParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.handlePendingToolCall", _p, SessionToolsHandlePendingToolCallResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture initializeAndValidate() { + return caller.invoke("session.tools.initializeAndValidate", java.util.Map.of("sessionId", this.sessionId), Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getCurrentMetadata() { + return caller.invoke("session.tools.getCurrentMetadata", java.util.Map.of("sessionId", this.sessionId), SessionToolsGetCurrentMetadataResult.class); + } + + /** + * Subagent settings to apply to the current session + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.tools.updateSubagentSettings", _p, Void.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java new file mode 100644 index 000000000..bb704cde6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsGetCurrentMetadataParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java new file mode 100644 index 000000000..8f3bf9912 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsGetCurrentMetadataResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Current lightweight tool metadata snapshot for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsGetCurrentMetadataResult( + /** Current tool metadata, or null when tools have not been initialized yet */ + @JsonProperty("tools") List tools +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java index a5bfa4cca..fa58c07ad 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Pending external tool call request ID, with the tool result or an error describing why it failed. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java index fefaa652e..d0b5e2bbd 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsHandlePendingToolCallResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the external tool call result was handled successfully. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java index f605cb817..0a77823c7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java new file mode 100644 index 000000000..d8c0c64fd --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionToolsUpdateSubagentSettingsParams.java @@ -0,0 +1,49 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Subagent settings to apply to the current session + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionToolsUpdateSubagentSettingsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Subagent settings to apply, or null to clear the live session override */ + @JsonProperty("subagents") SessionToolsUpdateSubagentSettingsParamsSubagents subagents +) { + + /** Configured per-agent subagent overrides */ + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionToolsUpdateSubagentSettingsParamsSubagents( + /** Per-agent settings keyed by subagent agent_type */ + @JsonProperty("agents") Map agents, + /** Names of subagents the user has turned off; they cannot be dispatched */ + @JsonProperty("disabledSubagents") List disabledSubagents, + /** Maximum number of subagents that can run concurrently; applies to usage-based billing users only */ + @JsonProperty("maxConcurrency") Long maxConcurrency, + /** Maximum subagent nesting depth; applies to usage-based billing users only */ + @JsonProperty("maxDepth") Long maxDepth + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java index c3116fe58..b3e16d7c2 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -29,6 +30,22 @@ public final class SessionUiApi { this.sessionId = sessionId; } + /** + * Transient question to answer without adding it to conversation history. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture ephemeralQuery(SessionUiEphemeralQueryParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.ui.ephemeralQuery", _p, SessionUiEphemeralQueryResult.class); + } + /** * Prompt message and JSON schema describing the form fields to elicit from the user. *

@@ -38,6 +55,7 @@ public final class SessionUiApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture elicitation(SessionUiElicitationParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -53,6 +71,7 @@ public CompletableFuture elicitation(SessionUiElicit * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingElicitation(SessionUiHandlePendingElicitationParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -68,6 +87,7 @@ public CompletableFuture handlePendingE * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingUserInput(SessionUiHandlePendingUserInputParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -83,6 +103,7 @@ public CompletableFuture handlePendingUse * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingSampling(SessionUiHandlePendingSamplingParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -98,12 +119,29 @@ public CompletableFuture handlePendingSamp * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); return caller.invoke("session.ui.handlePendingAutoModeSwitch", _p, SessionUiHandlePendingAutoModeSwitchResult.class); } + /** + * Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture handlePendingSessionLimitsExhausted(SessionUiHandlePendingSessionLimitsExhaustedParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.ui.handlePendingSessionLimitsExhausted", _p, SessionUiHandlePendingSessionLimitsExhaustedResult.class); + } + /** * Request ID of a pending `exit_plan_mode.requested` event and the user's response. *

@@ -113,6 +151,7 @@ public CompletableFuture handlePendi * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); @@ -125,6 +164,7 @@ public CompletableFuture handlePending * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture registerDirectAutoModeSwitchHandler() { return caller.invoke("session.ui.registerDirectAutoModeSwitchHandler", java.util.Map.of("sessionId", this.sessionId), SessionUiRegisterDirectAutoModeSwitchHandlerResult.class); } @@ -138,6 +178,7 @@ public CompletableFuture reg * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params) { com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); _p.put("sessionId", this.sessionId); diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java index d68416704..ad754767e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Prompt message and JSON schema describing the form fields to elicit from the user. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java index d08d7453e..b290cc7c6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiElicitationResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * The elicitation response (accept with form values, decline, or cancel) * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java new file mode 100644 index 000000000..b384238b2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryParams.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Transient question to answer without adding it to conversation history. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionUiEphemeralQueryParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Question to answer from the current conversation context. */ + @JsonProperty("question") String question, + /** In-process streaming callback `(text) => void` invoked with each token as the model emits it. Marked internal: excluded from the public SDK surface. In a process-separated SDK this is replaced by a streaming RPC that yields chunks and a final answer. */ + @JsonProperty("onChunk") Object onChunk, + /** In-process `AbortSignal` forwarded to the model client to cancel an in-flight request. Marked internal: excluded from the public SDK surface. Replaced by an explicit cancellation token + cancel RPC in the SDK migration. */ + @JsonProperty("abortSignal") Object abortSignal +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java new file mode 100644 index 000000000..6ac9058b0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiEphemeralQueryResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Transient answer generated from current conversation context. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionUiEphemeralQueryResult( + /** Full assistant response text. */ + @JsonProperty("answer") String answer +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java index 1afe7d5e7..9a6212aae 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Request ID of a pending `auto_mode_switch.requested` event and the user's response. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java index 335f5d894..800186908 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingAutoModeSwitchResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the pending UI request was resolved by this call. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java index 73d97220f..d6848ac23 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Pending elicitation request ID and the user's response (accept/decline/cancel + form values). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java index bb2c91b6e..8a3c242dc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingElicitationResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the elicitation response was accepted; false if it was already resolved by another client. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java similarity index 80% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java index 87c492bdb..2142a98f3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Request ID of a pending `exit_plan_mode.requested` event and the user's response. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -25,7 +28,7 @@ public record SessionUiHandlePendingExitPlanModeParams( @JsonProperty("sessionId") String sessionId, /** The unique request ID from the exit_plan_mode.requested event */ @JsonProperty("requestId") String requestId, - /** Schema for the `UIExitPlanModeResponse` type. */ + /** User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. */ @JsonProperty("response") UIExitPlanModeResponse response ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java index 69fc6586d..1eec3437e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingExitPlanModeResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the pending UI request was resolved by this call. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java index 8ce2ad2e1..cddcde19c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java index ced26ad66..8e2306197 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSamplingResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the pending UI request was resolved by this call. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java new file mode 100644 index 000000000..93ff19537 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionUiHandlePendingSessionLimitsExhaustedParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** The unique request ID from the session_limits_exhausted.requested event */ + @JsonProperty("requestId") String requestId, + /** The selected session-limit action. */ + @JsonProperty("response") UISessionLimitsExhaustedResponse response +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java new file mode 100644 index 000000000..79eeeebbf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingSessionLimitsExhaustedResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Indicates whether the pending UI request was resolved by this call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionUiHandlePendingSessionLimitsExhaustedResult( + /** True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. */ + @JsonProperty("success") Boolean success +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java index 89034cbd2..999a8738d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Request ID of a pending `user_input.requested` event and the user's response. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -25,7 +28,7 @@ public record SessionUiHandlePendingUserInputParams( @JsonProperty("sessionId") String sessionId, /** The unique request ID from the user_input.requested event */ @JsonProperty("requestId") String requestId, - /** Schema for the `UIUserInputResponse` type. */ + /** User response for a pending user-input request, with answer text and whether it was typed freeform. */ @JsonProperty("response") UIUserInputResponse response ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java index ae6369ee0..cb24bdf98 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiHandlePendingUserInputResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the pending UI request was resolved by this call. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java index f778d3164..8e6131e1e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java index 991954a26..96ad2041c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiRegisterDirectAutoModeSwitchHandlerResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java index beab56aa2..21c0870f4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java index 0836c5c16..63aa54bc5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUiUnregisterDirectAutoModeSwitchHandlerResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Indicates whether the handle was active and the registration count was decremented. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java index b9a5a14a8..16ded9d6b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageApi.java @@ -7,6 +7,7 @@ package com.github.copilot.generated.rpc; +import com.github.copilot.CopilotExperimental; import java.util.concurrent.CompletableFuture; import javax.annotation.processing.Generated; @@ -33,6 +34,7 @@ public final class SessionUsageApi { * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ + @CopilotExperimental public CompletableFuture getMetrics() { return caller.invoke("session.usage.getMetrics", java.util.Map.of("sessionId", this.sessionId), SessionUsageGetMetricsResult.class); } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java index 035bf6498..317a8050d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java index e51b9453f..69db5a56d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionUsageGetMetricsResult.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.time.OffsetDateTime; import java.util.Map; import javax.annotation.processing.Generated; @@ -17,8 +18,10 @@ /** * Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java new file mode 100644 index 000000000..54f38c261 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityApi.java @@ -0,0 +1,60 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code visibility} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionVisibilityApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionVisibilityApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture get() { + return caller.invoke("session.visibility.get", java.util.Map.of("sessionId", this.sessionId), SessionVisibilityGetResult.class); + } + + /** + * Desired sharing status for the session. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture set(SessionVisibilitySetParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.visibility.set", _p, SessionVisibilitySetResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java new file mode 100644 index 000000000..e3c4a2370 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionVisibilityGetParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java new file mode 100644 index 000000000..86c37cf6f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityGetResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Current sharing status and shareable GitHub URL for a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionVisibilityGetResult( + /** Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent. */ + @JsonProperty("synced") Boolean synced, + /** Current sharing status. Absent when the session is not synced or the status could not be retrieved (e.g. the user is not authenticated). */ + @JsonProperty("status") SessionVisibilityStatus status, + /** Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. */ + @JsonProperty("shareUrl") String shareUrl +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java new file mode 100644 index 000000000..c5287ac7c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Desired sharing status for the session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionVisibilitySetParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Sharing status to apply. "repo" makes the session visible to repository readers; "unshared" restricts it to the creator and collaborators. */ + @JsonProperty("status") SessionVisibilityStatus status +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java new file mode 100644 index 000000000..dda88be42 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilitySetResult.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Effective sharing status and shareable GitHub URL after updating session visibility. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionVisibilitySetResult( + /** Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent. */ + @JsonProperty("synced") Boolean synced, + /** Effective sharing status after the update. May differ from the requested status for task types that are already visible to repository readers by default. Absent when the update could not be applied (e.g. the session is not synced or the user is not authenticated). */ + @JsonProperty("status") SessionVisibilityStatus status, + /** Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. */ + @JsonProperty("shareUrl") String shareUrl +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java new file mode 100644 index 000000000..46ba78511 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionVisibilityStatus.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Sharing status for a synced session. "repo" makes the session visible to anyone with read access to the repository; "unshared" restricts it to the creator and collaborators. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionVisibilityStatus { + /** The {@code repo} variant. */ + REPO("repo"), + /** The {@code unshared} variant. */ + UNSHARED("unshared"); + + private final String value; + SessionVisibilityStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionVisibilityStatus fromValue(String value) { + for (SessionVisibilityStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionVisibilityStatus value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContext.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContext.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContext.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContext.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContextHostType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContextHostType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContextHostType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkingDirectoryContextHostType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryParams.java new file mode 100644 index 000000000..2a1c247bf --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Compaction summary checkpoint to persist. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesAddSummaryParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Summary title shown in checkpoint listings. */ + @JsonProperty("title") String title, + /** Markdown summary content to persist. */ + @JsonProperty("content") String content +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryResult.java new file mode 100644 index 000000000..a50a0b5f5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAddSummaryResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Persisted summary metadata and refreshed workspace metadata. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesAddSummaryResult( + @JsonProperty("summary") Map summary, + @JsonProperty("workspace") Map workspace +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java new file mode 100644 index 000000000..aaacb046f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java @@ -0,0 +1,259 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.github.copilot.CopilotExperimental; +import java.util.concurrent.CompletableFuture; +import javax.annotation.processing.Generated; + +/** + * API methods for the {@code workspaces} namespace. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionWorkspacesApi { + + private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; + + private final RpcCaller caller; + private final String sessionId; + + /** @param caller the RPC transport function */ + SessionWorkspacesApi(RpcCaller caller, String sessionId) { + this.caller = caller; + this.sessionId = sessionId; + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture getWorkspace() { + return caller.invoke("session.workspaces.getWorkspace", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesGetWorkspaceResult.class); + } + + /** + * Workspace metadata fields to update. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture updateMetadata(SessionWorkspacesUpdateMetadataParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.updateMetadata", _p, SessionWorkspacesUpdateMetadataResult.class); + } + + /** + * Optional session context used when creating a local workspace. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture ensure(SessionWorkspacesEnsureParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.ensure", _p, SessionWorkspacesEnsureResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listFiles() { + return caller.invoke("session.workspaces.listFiles", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListFilesResult.class); + } + + /** + * Relative path of the workspace file to read. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture readFile(SessionWorkspacesReadFileParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.readFile", _p, SessionWorkspacesReadFileResult.class); + } + + /** + * Relative path and UTF-8 content for the workspace file to create or overwrite. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture createFile(SessionWorkspacesCreateFileParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.createFile", _p, Void.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture listCheckpoints() { + return caller.invoke("session.workspaces.listCheckpoints", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListCheckpointsResult.class); + } + + /** + * Checkpoint number to read. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture readCheckpoint(SessionWorkspacesReadCheckpointParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.readCheckpoint", _p, SessionWorkspacesReadCheckpointResult.class); + } + + /** + * Compaction summary checkpoint to persist. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture addSummary(SessionWorkspacesAddSummaryParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.addSummary", _p, SessionWorkspacesAddSummaryResult.class); + } + + /** + * Rollback point for local workspace summaries. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture truncateSummaries(SessionWorkspacesTruncateSummariesParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.truncateSummaries", _p, SessionWorkspacesTruncateSummariesResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture readAutopilotObjective() { + return caller.invoke("session.workspaces.readAutopilotObjective", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesReadAutopilotObjectiveResult.class); + } + + /** + * Autopilot objective file content to persist. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture writeAutopilotObjective(SessionWorkspacesWriteAutopilotObjectiveParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.writeAutopilotObjective", _p, SessionWorkspacesWriteAutopilotObjectiveResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture deleteAutopilotObjective() { + return caller.invoke("session.workspaces.deleteAutopilotObjective", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesDeleteAutopilotObjectiveResult.class); + } + + /** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture autopilotObjectiveExists() { + return caller.invoke("session.workspaces.autopilotObjectiveExists", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesAutopilotObjectiveExistsResult.class); + } + + /** + * Pasted content to save as a UTF-8 file in the session workspace. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture saveLargePaste(SessionWorkspacesSaveLargePasteParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.saveLargePaste", _p, SessionWorkspacesSaveLargePasteResult.class); + } + + /** + * Parameters for computing a workspace diff. + *

+ * Note: the {@code sessionId} field in the params record is overridden + * by the session-scoped wrapper; any value provided is ignored. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ + @CopilotExperimental + public CompletableFuture diff(SessionWorkspacesDiffParams params) { + com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); + _p.put("sessionId", this.sessionId); + return caller.invoke("session.workspaces.diff", _p, SessionWorkspacesDiffResult.class); + } + +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsParams.java new file mode 100644 index 000000000..fc4b25c9d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesAutopilotObjectiveExistsParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsResult.java new file mode 100644 index 000000000..8fe0a849d --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesAutopilotObjectiveExistsResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Whether the autopilot objective file exists. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesAutopilotObjectiveExistsResult( + /** True when the objective file exists. */ + @JsonProperty("exists") Boolean exists +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java index 3d757f852..c0c42c502 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesCreateFileParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Relative path and UTF-8 content for the workspace file to create or overwrite. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveParams.java new file mode 100644 index 000000000..81f59d7a0 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesDeleteAutopilotObjectiveParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java new file mode 100644 index 000000000..3fa3f35f2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDeleteAutopilotObjectiveResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of deleting the autopilot objective file. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesDeleteAutopilotObjectiveResult( + /** True when a file was deleted. */ + @JsonProperty("deleted") Boolean deleted +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java new file mode 100644 index 000000000..f6b763494 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for computing a workspace diff. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesDiffParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Diff mode requested by the client. */ + @JsonProperty("mode") WorkspaceDiffMode mode, + /** When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. */ + @JsonProperty("ignoreWhitespace") Boolean ignoreWhitespace +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java new file mode 100644 index 000000000..21beab3ea --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Workspace diff result for the requested mode. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesDiffResult( + /** Diff mode requested by the client. */ + @JsonProperty("requestedMode") WorkspaceDiffMode requestedMode, + /** Effective mode used for the returned changes. */ + @JsonProperty("mode") WorkspaceDiffMode mode, + /** Changed files and their unified diffs. */ + @JsonProperty("changes") List changes, + /** Default branch used for a branch diff, when branch mode was requested. */ + @JsonProperty("baseBranch") String baseBranch, + /** Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable. */ + @JsonProperty("isFallback") Boolean isFallback, + /** Why the session diff could not be produced, when applicable. Set only when `session` mode was requested and `isFallback` is true, so a client can tell the permanent `file-change-tracking-disabled` apart from the transient `session-busy`, which the same request answers once the session settles. Never set for `unstaged` or `branch` mode, and never `unsupported-remote-session`: a remote session's captures live on its own host, so a `session`-mode diff is rejected for one rather than answered with a controller-side fallback. */ + @JsonProperty("unavailableReason") HistoryRewindUnavailableReason unavailableReason +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureParams.java new file mode 100644 index 000000000..aaa71621f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Optional session context used when creating a local workspace. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesEnsureParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque workspace context supplied by the session host. */ + @JsonProperty("context") Object context +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureResult.java new file mode 100644 index 000000000..4a810fe12 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesEnsureResult.java @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Current workspace metadata for the session, including its absolute filesystem path when available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesEnsureResult( + /** Current workspace metadata, or null if not available */ + @JsonProperty("workspace") SessionWorkspacesEnsureResultWorkspace workspace, + /** Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). */ + @JsonProperty("path") String path +) { + + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionWorkspacesEnsureResultWorkspace( + @JsonProperty("id") String id, + @JsonProperty("cwd") String cwd, + @JsonProperty("git_root") String gitRoot, + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + @JsonProperty("branch") String branch, + @JsonProperty("name") String name, + @JsonProperty("client_name") String clientName, + @JsonProperty("user_named") Boolean userNamed, + @JsonProperty("summary_count") Long summaryCount, + @JsonProperty("created_at") OffsetDateTime createdAt, + @JsonProperty("updated_at") OffsetDateTime updatedAt, + @JsonProperty("remote_steerable") Boolean remoteSteerable, + @JsonProperty("mc_task_id") String mcTaskId, + @JsonProperty("mc_session_id") String mcSessionId, + @JsonProperty("mc_last_event_id") String mcLastEventId, + @JsonProperty("chronicle_sync_dismissed") Boolean chronicleSyncDismissed + ) { + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java index 6a7482af7..571e833e3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java index 8e79a82a1..217ac7d44 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesGetWorkspaceResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.time.OffsetDateTime; import javax.annotation.processing.Generated; /** * Current workspace metadata for the session, including its absolute filesystem path when available. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java index 3d55cf43a..1cd7e0d06 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java index b6f562c66..c91230c2e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListCheckpointsResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Workspace checkpoints in chronological order; empty when the workspace is not enabled. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java index 7fd4771a1..7db9b48dc 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifies the target session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java index 90a7cf2ce..90fd2691d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesListFilesResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Relative paths of files stored in the session workspace files directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveParams.java new file mode 100644 index 000000000..67d03a954 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Identifies the target session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesReadAutopilotObjectiveParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveResult.java new file mode 100644 index 000000000..7b2e157b5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadAutopilotObjectiveResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Autopilot objective file content, or null when missing. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesReadAutopilotObjectiveResult( + /** Autopilot objective file content, or null when missing. */ + @JsonProperty("content") String content +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java index 8266acab4..0a18688b8 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Checkpoint number to read. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java index 1b4322994..21aa5009f 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadCheckpointResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java index 85f44b608..b9f21c516 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Relative path of the workspace file to read. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java index b85ce3f6e..f441936a7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesReadFileResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Contents of the requested workspace file as a UTF-8 string. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java index 23def325c..1551f7456 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Pasted content to save as a UTF-8 file in the session workspace. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java index 523b12488..08df378c9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesSaveLargePasteResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Descriptor for the saved paste file, or null when the workspace is unavailable. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesParams.java new file mode 100644 index 000000000..43d392e48 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Rollback point for local workspace summaries. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesTruncateSummariesParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Number of newest summaries to keep. */ + @JsonProperty("keepCount") Long keepCount +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesResult.java new file mode 100644 index 000000000..caa44d0b7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesTruncateSummariesResult.java @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Current workspace metadata for the session, including its absolute filesystem path when available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesTruncateSummariesResult( + /** Current workspace metadata, or null if not available */ + @JsonProperty("workspace") SessionWorkspacesTruncateSummariesResultWorkspace workspace, + /** Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). */ + @JsonProperty("path") String path +) { + + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionWorkspacesTruncateSummariesResultWorkspace( + @JsonProperty("id") String id, + @JsonProperty("cwd") String cwd, + @JsonProperty("git_root") String gitRoot, + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + @JsonProperty("branch") String branch, + @JsonProperty("name") String name, + @JsonProperty("client_name") String clientName, + @JsonProperty("user_named") Boolean userNamed, + @JsonProperty("summary_count") Long summaryCount, + @JsonProperty("created_at") OffsetDateTime createdAt, + @JsonProperty("updated_at") OffsetDateTime updatedAt, + @JsonProperty("remote_steerable") Boolean remoteSteerable, + @JsonProperty("mc_task_id") String mcTaskId, + @JsonProperty("mc_session_id") String mcSessionId, + @JsonProperty("mc_last_event_id") String mcLastEventId, + @JsonProperty("chronicle_sync_dismissed") Boolean chronicleSyncDismissed + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataParams.java new file mode 100644 index 000000000..af45fead5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Workspace metadata fields to update. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesUpdateMetadataParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Opaque workspace context supplied by the session host. */ + @JsonProperty("context") Object context, + /** Optional workspace display name override. */ + @JsonProperty("name") String name +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataResult.java new file mode 100644 index 000000000..84ec13661 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesUpdateMetadataResult.java @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.time.OffsetDateTime; +import javax.annotation.processing.Generated; + +/** + * Current workspace metadata for the session, including its absolute filesystem path when available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesUpdateMetadataResult( + /** Current workspace metadata, or null if not available */ + @JsonProperty("workspace") SessionWorkspacesUpdateMetadataResultWorkspace workspace, + /** Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). */ + @JsonProperty("path") String path +) { + + @JsonIgnoreProperties(ignoreUnknown = true) + @JsonInclude(JsonInclude.Include.NON_NULL) + public record SessionWorkspacesUpdateMetadataResultWorkspace( + @JsonProperty("id") String id, + @JsonProperty("cwd") String cwd, + @JsonProperty("git_root") String gitRoot, + @JsonProperty("repository") String repository, + /** Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. */ + @JsonProperty("host_type") WorkspacesWorkspaceDetailsHostType hostType, + @JsonProperty("branch") String branch, + @JsonProperty("name") String name, + @JsonProperty("client_name") String clientName, + @JsonProperty("user_named") Boolean userNamed, + @JsonProperty("summary_count") Long summaryCount, + @JsonProperty("created_at") OffsetDateTime createdAt, + @JsonProperty("updated_at") OffsetDateTime updatedAt, + @JsonProperty("remote_steerable") Boolean remoteSteerable, + @JsonProperty("mc_task_id") String mcTaskId, + @JsonProperty("mc_session_id") String mcSessionId, + @JsonProperty("mc_last_event_id") String mcLastEventId, + @JsonProperty("chronicle_sync_dismissed") Boolean chronicleSyncDismissed + ) { + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveParams.java new file mode 100644 index 000000000..fb116ed30 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Autopilot objective file content to persist. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesWriteAutopilotObjectiveParams( + /** Target session identifier */ + @JsonProperty("sessionId") String sessionId, + /** Autopilot objective file content. */ + @JsonProperty("content") String content +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveResult.java new file mode 100644 index 000000000..9b69713e9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesWriteAutopilotObjectiveResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Result of writing the autopilot objective file. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionWorkspacesWriteAutopilotObjectiveResult( + /** Filesystem operation performed. */ + @JsonProperty("operation") String operation +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java index e1aa50697..5a8d5149c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Session IDs to close, deactivate, and delete from disk. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java index 2447d409d..4f43afa27 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsBulkDeleteResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * Map of sessionId -> bytes freed by removing the session's workspace directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java index 4be30632d..30702ce70 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Session IDs to test for live in-use locks. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java index 1ab7edab7..934ef89c3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCheckInUseResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Session IDs from the input set that are currently in use by another process. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java index 667e18a4c..21496a72b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID to close. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java new file mode 100644 index 000000000..83d2d9c61 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConfigureSessionExtensionsParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Params to attach or detach an in-process ExtensionController delegate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsConfigureSessionExtensionsParams( + /** Session to attach the extension controller delegate to. */ + @JsonProperty("sessionId") String sessionId, + /** In-process ExtensionController delegate (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. The post-SDK extension surface exposes list/enable/disable/reload via dedicated RPCs served by the runtime. */ + @JsonProperty("controller") Object controller +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java index 5d0dfffeb..d750b3e5d 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Remote session connection parameters. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java index 42c5d7e2e..885787743 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsConnectResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Remote session connection result. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsDeleteParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsDeleteParams.java new file mode 100644 index 000000000..788811e34 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsDeleteParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Session ID to delete from disk. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsDeleteParams( + /** Session ID to delete */ + @JsonProperty("sessionId") String sessionId, + /** Internal resolved session directory path to delete */ + @JsonProperty("sessionPath") String sessionPath +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java similarity index 82% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java index 973c952e9..c76bba25a 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataParams.java @@ -10,19 +10,22 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Session metadata records to enrich with summary and context information. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionsEnrichMetadataParams( /** Session metadata records to enrich. Records that already have summary and context are returned unchanged. */ - @JsonProperty("sessions") List sessions + @JsonProperty("sessions") List sessions ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java similarity index 83% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java index 7457b8489..aaa56bc47 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsEnrichMetadataResult.java @@ -10,19 +10,22 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record SessionsEnrichMetadataResult( /** Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. */ - @JsonProperty("sessions") List sessions + @JsonProperty("sessions") List sessions ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java index 285876be0..e38f775a4 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * UUID prefix to resolve to a unique session ID. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java index 27ceb2950..4b28cec69 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByPrefixResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID matching the prefix, omitted when no unique match exists. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java index cd643796c..0a2dd865e 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * GitHub task ID to look up. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java index d27634058..fb2fe56c6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsFindByTaskIdResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * ID of the local session bound to the given GitHub task, or omitted when none. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java index 33bfb3a81..b9fa2ff67 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java index 5e67f101e..ec0899335 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsForkResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Identifier and optional friendly name assigned to the newly forked session. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java new file mode 100644 index 000000000..28ea6d8c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Session ID whose board entry count should be returned. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsGetBoardEntryCountParams( + /** Session ID whose board entry count should be returned. */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java new file mode 100644 index 000000000..b0c70169e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetBoardEntryCountResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Dynamic-context board entry count, when available. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsGetBoardEntryCountResult( + /** Board entry count, when available. */ + @JsonProperty("count") Long count +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java index a0d19b5a4..0b8c72e58 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID whose event-log file path to compute. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java index 9d77f105f..c403264a9 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetEventFilePathResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Absolute path to the session's events.jsonl file on disk. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java index 43a23a89b..6aa08397b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional working-directory context used to score session relevance. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java index 018b96f71..e45a89fed 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetLastForContextResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Most-relevant session ID for the supplied context, or omitted when no sessions exist. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataParams.java new file mode 100644 index 000000000..cfa2e6326 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Session ID whose persisted metadata should be read. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsGetMetadataParams( + /** Session ID to inspect */ + @JsonProperty("sessionId") String sessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataResult.java new file mode 100644 index 000000000..6546b00fe --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetMetadataResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Persisted local session metadata when the session exists. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsGetMetadataResult( + /** Local session metadata, omitted when the session does not exist. */ + @JsonProperty("session") LocalSessionMetadataValue session +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java index 21f26bfcd..976efd675 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID to look up the persisted remote-steerable flag for. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java index 9dedef981..97127d856 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetPersistedRemoteSteerableResult.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * The session's persisted remote-steerable flag, or omitted when no value has been persisted. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java new file mode 100644 index 000000000..844d4338c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetRemoteControlStatusResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Wrapper for the singleton's current status. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsGetRemoteControlStatusResult( + /** State of the runtime-managed remote-control singleton. */ + @JsonProperty("status") Object status +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java index 958f6e242..8864f1a26 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsGetSizesResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.Map; import javax.annotation.processing.Generated; /** * Map of sessionId -> on-disk size in bytes for each session's workspace directory. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsParams.java new file mode 100644 index 000000000..4e453121b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Limit for non-empty local session IDs. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsListNonEmptySessionIdsParams( + /** Maximum number of session IDs to return. */ + @JsonProperty("limit") Long limit +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsResult.java new file mode 100644 index 000000000..51cc266e6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListNonEmptySessionIdsResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Recent local session IDs that contain user-visible history. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsListNonEmptySessionIdsResult( + /** Session IDs ordered newest-first. */ + @JsonProperty("sessionIds") List sessionIds +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListParams.java new file mode 100644 index 000000000..61e01b1c7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListParams.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Optional source filter, metadata-load limit, and context filter applied to the returned sessions. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsListParams( + /** Which session sources to include. Defaults to `local` for backward compatibility. */ + @JsonProperty("source") SessionSource source, + /** When provided, only the first N local sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every local session. Has no effect on remote entries (which always carry their full shape). */ + @JsonProperty("metadataLimit") Long metadataLimit, + /** Optional filter applied to the returned sessions */ + @JsonProperty("filter") SessionListFilter filter, + /** When true, include detached maintenance sessions. Defaults to false for user-facing session lists. */ + @JsonProperty("includeDetached") Boolean includeDetached, + /** Only meaningful when `source` includes remote. When true, propagates errors from the remote service instead of silently returning an empty remote list. Defaults to false. */ + @JsonProperty("throwOnError") Boolean throwOnError +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java new file mode 100644 index 000000000..6d65c6c41 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Sessions matching the filter, ordered most-recently-modified first. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsListResult( + /** Sessions ordered most-recently-modified first. Discriminated by `isRemote`. */ + @JsonProperty("sessions") List sessions +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java index 347b7c7e7..eb5cd51df 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Active session ID whose deferred repo-level hooks should be loaded. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java index 194ce088d..01f9288fb 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsLoadDeferredRepoHooksResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Queued repo-level startup prompts and the total hook command count after loading. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenAttach.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenAttach.java new file mode 100644 index 000000000..1554425a7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenAttach.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for attaching to an already-active session by ID. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenAttach extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "attach"; + + @Override + public String getKind() { return kind; } + + /** Session ID to attach to. */ + @JsonProperty("sessionId") + private String sessionId; + + public String getSessionId() { return sessionId; } + public void setSessionId(String sessionId) { this.sessionId = sessionId; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCloud.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCloud.java new file mode 100644 index 000000000..8e4a74bd8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCloud.java @@ -0,0 +1,58 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for creating a new cloud session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenCloud extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "cloud"; + + @Override + public String getKind() { return kind; } + + /** Repository for the cloud session. */ + @JsonProperty("repository") + private RemoteSessionRepository repository; + + /** Optional owner (user or organization login) to associate with the cloud session when no repository is provided. Ignored when `repository` is set (the repo's owner takes precedence). */ + @JsonProperty("owner") + private String owner; + + /** Session options for cloud session creation. */ + @JsonProperty("options") + private SessionOpenOptions options; + + /** In-process callback invoked when the cloud task is created (before connection). Marked internal because a function reference cannot cross the JSON-RPC boundary. Disappears in the SDK migration: the field is purely cosmetic (it flips a single CLI phase label from 'creating' to 'connecting') and the wire-clean version just drops the intermediate phase. */ + @JsonProperty("onTaskCreated") + private Object onTaskCreated; + + public RemoteSessionRepository getRepository() { return repository; } + public void setRepository(RemoteSessionRepository repository) { this.repository = repository; } + + public String getOwner() { return owner; } + public void setOwner(String owner) { this.owner = owner; } + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } + + public Object getOnTaskCreated() { return onTaskCreated; } + public void setOnTaskCreated(Object onTaskCreated) { this.onTaskCreated = onTaskCreated; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCreate.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCreate.java new file mode 100644 index 000000000..0394cffa6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenCreate.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for creating a new local session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenCreate extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "create"; + + @Override + public String getKind() { return kind; } + + /** Session construction options. */ + @JsonProperty("options") + private SessionOpenOptions options; + + /** Whether to emit session.start during creation. Defaults to true. */ + @JsonProperty("emitStart") + private Boolean emitStart; + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } + + public Boolean getEmitStart() { return emitStart; } + public void setEmitStart(Boolean emitStart) { this.emitStart = emitStart; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoff.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoff.java new file mode 100644 index 000000000..bb67c4338 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoff.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for fetching a remote session and handing it off to a new local session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenHandoff extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "handoff"; + + @Override + public String getKind() { return kind; } + + /** Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). */ + @JsonProperty("metadata") + private RemoteSessionMetadataValue metadata; + + /** Session construction options for the new local session. */ + @JsonProperty("options") + private SessionOpenOptions options; + + /** Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session). */ + @JsonProperty("taskType") + private SessionsOpenHandoffTaskType taskType; + + /** In-process progress callback `(update) => void` invoked for each handoff step. Marked internal because a function reference cannot cross the JSON-RPC boundary. The host-side `handoffSession` is already declared as `AsyncGenerator`; the schema layer flattens it because it does not yet support streaming methods. The wire-clean replacement is to expose the AsyncGenerator directly (or use vscode-jsonrpc `$/progress` notifications) once the schema/transport layer supports it. */ + @JsonProperty("onProgress") + private Object onProgress; + + /** In-process confirmation callback `(request) => boolean | Promise` invoked when the handoff needs the caller to confirm a non-fatal blocker (e.g. a repository mismatch between the current working directory and the remote session). Returning `true` proceeds with the handoff; returning `false` (or omitting the callback) aborts it. Marked internal because a function reference cannot cross the JSON-RPC boundary, for the same reasons as `onProgress`. */ + @JsonProperty("onConfirm") + private Object onConfirm; + + public RemoteSessionMetadataValue getMetadata() { return metadata; } + public void setMetadata(RemoteSessionMetadataValue metadata) { this.metadata = metadata; } + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } + + public SessionsOpenHandoffTaskType getTaskType() { return taskType; } + public void setTaskType(SessionsOpenHandoffTaskType taskType) { this.taskType = taskType; } + + public Object getOnProgress() { return onProgress; } + public void setOnProgress(Object onProgress) { this.onProgress = onProgress; } + + public Object getOnConfirm() { return onConfirm; } + public void setOnConfirm(Object onConfirm) { this.onConfirm = onConfirm; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoffTaskType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoffTaskType.java new file mode 100644 index 000000000..39d7eff42 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenHandoffTaskType.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session). + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionsOpenHandoffTaskType { + /** The {@code cca} variant. */ + CCA("cca"), + /** The {@code cli} variant. */ + CLI("cli"); + + private final String value; + SessionsOpenHandoffTaskType(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionsOpenHandoffTaskType fromValue(String value) { + for (SessionsOpenHandoffTaskType v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionsOpenHandoffTaskType value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenParams.java new file mode 100644 index 000000000..dd9795024 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenParams.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Open a session by creating, resuming, attaching, connecting to a remote, or handing off. + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = SessionsOpenCreate.class, name = "create"), + @JsonSubTypes.Type(value = SessionsOpenResume.class, name = "resume"), + @JsonSubTypes.Type(value = SessionsOpenResumeLast.class, name = "resumeLast"), + @JsonSubTypes.Type(value = SessionsOpenAttach.class, name = "attach"), + @JsonSubTypes.Type(value = SessionsOpenRemote.class, name = "remote"), + @JsonSubTypes.Type(value = SessionsOpenCloud.class, name = "cloud"), + @JsonSubTypes.Type(value = SessionsOpenHandoff.class, name = "handoff") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class SessionsOpenParams { + + /** + * Returns the discriminator value for this variant. + * + * @return the kind discriminator + */ + public abstract String getKind(); +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java new file mode 100644 index 000000000..8509295cb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgress.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * `sessions.open` handoff progress update with step, status, and optional message. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsOpenProgress( + /** Handoff step. */ + @JsonProperty("step") SessionsOpenProgressStep step, + /** Step status. */ + @JsonProperty("status") SessionsOpenProgressStatus status, + /** Optional step message. */ + @JsonProperty("message") String message +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java new file mode 100644 index 000000000..86a7798c9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStatus.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Step status. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionsOpenProgressStatus { + /** The {@code in-progress} variant. */ + IN_PROGRESS("in-progress"), + /** The {@code complete} variant. */ + COMPLETE("complete"); + + private final String value; + SessionsOpenProgressStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionsOpenProgressStatus fromValue(String value) { + for (SessionsOpenProgressStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionsOpenProgressStatus value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java new file mode 100644 index 000000000..73465a3eb --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenProgressStep.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Handoff step. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionsOpenProgressStep { + /** The {@code load-session} variant. */ + LOAD_SESSION("load-session"), + /** The {@code validate-repo} variant. */ + VALIDATE_REPO("validate-repo"), + /** The {@code check-changes} variant. */ + CHECK_CHANGES("check-changes"), + /** The {@code checkout-branch} variant. */ + CHECKOUT_BRANCH("checkout-branch"), + /** The {@code create-session} variant. */ + CREATE_SESSION("create-session"), + /** The {@code save-session} variant. */ + SAVE_SESSION("save-session"); + + private final String value; + SessionsOpenProgressStep(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionsOpenProgressStep fromValue(String value) { + for (SessionsOpenProgressStep v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionsOpenProgressStep value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenRemote.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenRemote.java new file mode 100644 index 000000000..a51660d80 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenRemote.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for connecting to a live remote session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenRemote extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "remote"; + + @Override + public String getKind() { return kind; } + + /** Remote session identifier to connect to. */ + @JsonProperty("remoteSessionId") + private String remoteSessionId; + + /** Repository context for the remote session. */ + @JsonProperty("repository") + private RemoteSessionRepository repository; + + /** Session options for the connection. */ + @JsonProperty("options") + private SessionOpenOptions options; + + public String getRemoteSessionId() { return remoteSessionId; } + public void setRemoteSessionId(String remoteSessionId) { this.remoteSessionId = remoteSessionId; } + + public RemoteSessionRepository getRepository() { return repository; } + public void setRepository(RemoteSessionRepository repository) { this.repository = repository; } + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java new file mode 100644 index 000000000..0e5d268ff --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResult.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Result of opening a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsOpenResult( + /** Outcome of the open request. */ + @JsonProperty("status") SessionsOpenStatus status, + /** Opened session ID. Omitted when status is `not_found`. */ + @JsonProperty("sessionId") String sessionId, + /** In-process SessionClientApi handle for the opened session, returned to CLI callers as a transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK consumers should construct per-session clients from `sessionId` instead. */ + @JsonProperty("sessionApi") Object sessionApi, + /** Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. */ + @JsonProperty("startupPrompts") List startupPrompts, + /** Remote session ID, present when status is `connected`. */ + @JsonProperty("remoteSessionId") String remoteSessionId, + /** Remote session metadata, present when status is `connected`. */ + @JsonProperty("metadata") RemoteSessionMetadataValue metadata, + /** Handoff progress steps, present when status is `handed_off`. */ + @JsonProperty("progress") List progress +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResume.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResume.java new file mode 100644 index 000000000..664e5a005 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResume.java @@ -0,0 +1,58 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for resuming a specific local session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenResume extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "resume"; + + @Override + public String getKind() { return kind; } + + /** Session ID or unique prefix to resume. */ + @JsonProperty("sessionId") + private String sessionId; + + /** Session resume options. */ + @JsonProperty("options") + private SessionOpenOptions options; + + /** Whether to emit session.resume after loading. Defaults to true. */ + @JsonProperty("resume") + private Boolean resume; + + /** Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. */ + @JsonProperty("suppressResumeWorkspaceMetadataWriteback") + private Boolean suppressResumeWorkspaceMetadataWriteback; + + public String getSessionId() { return sessionId; } + public void setSessionId(String sessionId) { this.sessionId = sessionId; } + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } + + public Boolean getResume() { return resume; } + public void setResume(Boolean resume) { this.resume = resume; } + + public Boolean getSuppressResumeWorkspaceMetadataWriteback() { return suppressResumeWorkspaceMetadataWriteback; } + public void setSuppressResumeWorkspaceMetadataWriteback(Boolean suppressResumeWorkspaceMetadataWriteback) { this.suppressResumeWorkspaceMetadataWriteback = suppressResumeWorkspaceMetadataWriteback; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResumeLast.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResumeLast.java new file mode 100644 index 000000000..a93afe774 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenResumeLast.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Parameters for resuming the most relevant local session. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SessionsOpenResumeLast extends SessionsOpenParams { + + @JsonProperty("kind") + private final String kind = "resumeLast"; + + @Override + public String getKind() { return kind; } + + /** Working-directory context used to choose the most relevant session. */ + @JsonProperty("context") + private SessionContext context; + + /** Session resume options. */ + @JsonProperty("options") + private SessionOpenOptions options; + + /** Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. */ + @JsonProperty("suppressResumeWorkspaceMetadataWriteback") + private Boolean suppressResumeWorkspaceMetadataWriteback; + + public SessionContext getContext() { return context; } + public void setContext(SessionContext context) { this.context = context; } + + public SessionOpenOptions getOptions() { return options; } + public void setOptions(SessionOpenOptions options) { this.options = options; } + + public Boolean getSuppressResumeWorkspaceMetadataWriteback() { return suppressResumeWorkspaceMetadataWriteback; } + public void setSuppressResumeWorkspaceMetadataWriteback(Boolean suppressResumeWorkspaceMetadataWriteback) { this.suppressResumeWorkspaceMetadataWriteback = suppressResumeWorkspaceMetadataWriteback; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java new file mode 100644 index 000000000..1ebab5484 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsOpenStatus.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Outcome of the open request. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SessionsOpenStatus { + /** The {@code created} variant. */ + CREATED("created"), + /** The {@code resumed} variant. */ + RESUMED("resumed"), + /** The {@code not_found} variant. */ + NOT_FOUND("not_found"), + /** The {@code connected} variant. */ + CONNECTED("connected"), + /** The {@code handed_off} variant. */ + HANDED_OFF("handed_off"); + + private final String value; + SessionsOpenStatus(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SessionsOpenStatus fromValue(String value) { + for (SessionsOpenStatus v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SessionsOpenStatus value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java index d85438730..ec0325042 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java index c04389b0c..192cc1419 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsPruneOldResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java new file mode 100644 index 000000000..440c01b2a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionOptions.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Optional registration options. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsRegisterExtensionToolsOnSessionOptions( + /** In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: replaced by runtime-side enable/disable RPCs in the SDK migration. */ + @JsonProperty("enabled") Object enabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java new file mode 100644 index 000000000..d7eb48f2b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionParams.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Params to attach an extension loader's tools to a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsRegisterExtensionToolsOnSessionParams( + /** Session to register extension tools on. */ + @JsonProperty("sessionId") String sessionId, + /** In-process ExtensionLoader handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, extension discovery/launch moves entirely into the runtime — the CLI passes pure config (search paths, disabled ids) via SessionOptions instead. */ + @JsonProperty("loader") Object loader, + /** Optional registration options. */ + @JsonProperty("options") SessionsRegisterExtensionToolsOnSessionOptions options +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java new file mode 100644 index 000000000..63cc5fb0f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsRegisterExtensionToolsOnSessionResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Handle for releasing the extension tool registration. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsRegisterExtensionToolsOnSessionResult( + /** In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an explicit `extensions.unregister` RPC in the SDK migration. */ + @JsonProperty("unsubscribe") Object unsubscribe +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java index 76add5bcb..1481483c6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID whose in-use lock should be released. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java similarity index 89% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java index 82978334f..c7c0f63c3 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Active session ID and an optional flag for deferring repo-level hooks until folder trust. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java index 27f49addd..1e9c8eb15 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Session ID whose pending events should be flushed to disk. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java index d03706e3a..066f86fe6 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Manager-wide additional plugins to register; replaces any previously-configured set. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java new file mode 100644 index 000000000..8335bde39 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Patch for the singleton's steering state. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsSetRemoteControlSteeringParams( + /** Target steering state. Today only `true` is actionable on the underlying exporter; `false` is reserved for future use. */ + @JsonProperty("enabled") Boolean enabled +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java new file mode 100644 index 000000000..1ef9f2554 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsSetRemoteControlSteeringResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Wrapper for the singleton's current status. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsSetRemoteControlSteeringResult( + /** State of the runtime-managed remote-control singleton. */ + @JsonProperty("status") Object status +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java new file mode 100644 index 000000000..66b3d941b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for attaching the remote-control singleton to a session. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsStartRemoteControlParams( + /** Local session id to attach remote control to. */ + @JsonProperty("sessionId") String sessionId, + /** Configuration for the runtime-managed remote-control singleton. */ + @JsonProperty("config") RemoteControlConfig config +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java new file mode 100644 index 000000000..51c6984a6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStartRemoteControlResult.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Wrapper for the singleton's current status. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsStartRemoteControlResult( + /** State of the runtime-managed remote-control singleton. */ + @JsonProperty("status") Object status +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlParams.java new file mode 100644 index 000000000..3cd2065d6 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Request parameters for the {@code sessions.stopRemoteControl} RPC method. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsStopRemoteControlParams( + /** When provided, the stop is rejected unless the singleton currently points at this session id (compare-and-swap semantics). */ + @JsonProperty("expectedSessionId") String expectedSessionId, + /** When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. Use during shutdown or explicit `/remote off`. */ + @JsonProperty("force") Boolean force +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java new file mode 100644 index 000000000..ef3bad0c5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsStopRemoteControlResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Outcome of a stopRemoteControl call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsStopRemoteControlResult( + /** State of the runtime-managed remote-control singleton. */ + @JsonProperty("status") Object status, + /** Whether the singleton was actually torn down by this call. */ + @JsonProperty("stopped") Boolean stopped +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java new file mode 100644 index 000000000..13327239e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlParams.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Parameters for atomically rebinding the remote-control singleton. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsTransferRemoteControlParams( + /** Local session id to point remote control at. */ + @JsonProperty("toSessionId") String toSessionId, + /** When provided, the transfer is rejected unless the singleton currently points at this session id (compare-and-swap semantics to avoid clobbering newer state). */ + @JsonProperty("expectedFromSessionId") String expectedFromSessionId +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java new file mode 100644 index 000000000..c9ca654a1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SessionsTransferRemoteControlResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Outcome of a transferRemoteControl call. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SessionsTransferRemoteControlResult( + /** State of the runtime-managed remote-control singleton. */ + @JsonProperty("status") Object status, + /** Whether the rebinding actually happened. */ + @JsonProperty("transferred") Boolean transferred +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitProfile.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitProfile.java new file mode 100644 index 000000000..7d27a55b5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitProfile.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ShellInitProfile { + /** The {@code none} variant. */ + NONE("none"), + /** The {@code non-interactive} variant. */ + NON_INTERACTIVE("non-interactive"); + + private final String value; + ShellInitProfile(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ShellInitProfile fromValue(String value) { + for (ShellInitProfile v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ShellInitProfile value: " + value); + } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScript.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScript.java new file mode 100644 index 000000000..31789619e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScript.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A host-provided script sourced before each built-in shell command when its shell target matches the active shell. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ShellInitScript( + /** Path to the script to source. */ + @JsonProperty("path") String path, + /** Built-in shell that may source this script. */ + @JsonProperty("shell") ShellInitScriptShell shell +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScriptShell.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScriptShell.java new file mode 100644 index 000000000..63d7ba7dc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellInitScriptShell.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Supported built-in shells for initialization scripts. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum ShellInitScriptShell { + /** The {@code bash} variant. */ + BASH("bash"), + /** The {@code powershell} variant. */ + POWERSHELL("powershell"); + + private final String value; + ShellInitScriptShell(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static ShellInitScriptShell fromValue(String value) { + for (ShellInitScriptShell v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown ShellInitScriptShell value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ShellKillSignal.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellKillSignal.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ShellKillSignal.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellKillSignal.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellOptions.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellOptions.java new file mode 100644 index 000000000..596de0ef9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShellOptions.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Per-session settings for built-in shell tools. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record ShellOptions( + /** Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. */ + @JsonProperty("initProfile") ShellInitProfile initProfile, + /** Ordered host-provided script paths sourced before each built-in shell command when the +entry's shell target matches the active shell. Use these for rc files, environment setup scripts, +or other custom scripts. A script that returns a nonzero status is reported, and later scripts +and the user command continue while the shell remains running. Because scripts are sourced into +the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating behavior +can prevent continuation. Script standard output is preserved; Bash script stderr is discarded, +PowerShell exception messages are replaced, and runtime-generated failure notices omit +configured script paths. When sandboxing is enabled, each script must already be readable under +the active sandbox filesystem policy. Pass an empty array to clear the list. */ + @JsonProperty("initScripts") List initScripts, + /** Flags passed to the active built-in shell process on startup, replacing its default flags. +When omitted, the built-in Bash shell uses `--norc --noprofile`, +and the built-in PowerShell shell uses `-NoProfile -NoLogo`. */ + @JsonProperty("processFlags") List processFlags +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ShutdownType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShutdownType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/ShutdownType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ShutdownType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java new file mode 100644 index 000000000..88e7eb116 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Skill.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record Skill( + /** Unique identifier for the skill */ + @JsonProperty("name") String name, + /** Canonical slash command name used to invoke the skill, without the leading '/' */ + @JsonProperty("commandName") String commandName, + /** Description of what the skill does */ + @JsonProperty("description") String description, + /** Source location type (e.g., project, personal-copilot, plugin, builtin) */ + @JsonProperty("source") SkillSource source, + /** Whether the skill can be invoked by the user as a slash command */ + @JsonProperty("userInvocable") Boolean userInvocable, + /** Whether the skill is currently enabled */ + @JsonProperty("enabled") Boolean enabled, + /** Absolute path to the skill file */ + @JsonProperty("path") String path, + /** Name of the plugin that provides the skill, when source is 'plugin' */ + @JsonProperty("pluginName") String pluginName, + /** Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field */ + @JsonProperty("argumentHint") String argumentHint +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java new file mode 100644 index 000000000..feea2794f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryPath.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillDiscoveryPath( + /** Absolute path of the create/discovery target (may not exist on disk yet) */ + @JsonProperty("path") String path, + /** Which tier this directory belongs to */ + @JsonProperty("scope") SkillDiscoveryScope scope, + /** Whether this is the canonical directory to create a new skill in its tier. At most one entry per tier is preferred; the `personal-agents` and `custom` scopes are never preferred. */ + @JsonProperty("preferredForCreation") Boolean preferredForCreation, + /** The input project path this directory was derived from (only for project scope) */ + @JsonProperty("projectPath") String projectPath +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java new file mode 100644 index 000000000..6dbe19bd5 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillDiscoveryScope.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Which tier this directory belongs to + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SkillDiscoveryScope { + /** The {@code project} variant. */ + PROJECT("project"), + /** The {@code personal-copilot} variant. */ + PERSONAL_COPILOT("personal-copilot"), + /** The {@code personal-agents} variant. */ + PERSONAL_AGENTS("personal-agents"), + /** The {@code custom} variant. */ + CUSTOM("custom"); + + private final String value; + SkillDiscoveryScope(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SkillDiscoveryScope fromValue(String value) { + for (SkillDiscoveryScope v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SkillDiscoveryScope value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillSource.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillSource.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillSource.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillSource.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java index 200e88cd7..1ba81d7b7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsConfigSetDisabledSkillsParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Skill names to mark as disabled in global configuration, replacing any previous list. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java similarity index 75% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java index 117680699..85cf09fad 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverParams.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Optional project paths and additional skill directories to include in discovery. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) @@ -25,6 +28,8 @@ public record SkillsDiscoverParams( /** Optional list of project directory paths to scan for project-scoped skills */ @JsonProperty("projectPaths") List projectPaths, /** Optional list of additional skill directory paths to include */ - @JsonProperty("skillDirectories") List skillDirectories + @JsonProperty("skillDirectories") List skillDirectories, + /** When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments. */ + @JsonProperty("excludeHostSkills") Boolean excludeHostSkills ) { } diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java new file mode 100644 index 000000000..78b1f1eb9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Skills discovered across global and project sources. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillsDiscoverResult( + /** All discovered skills across all sources */ + @JsonProperty("skills") List skills, + /** Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills are excluded so host-local paths are not disclosed to multitenant callers. */ + @JsonProperty("errors") List errors +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java new file mode 100644 index 000000000..987533b79 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsParams.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Optional project paths to enumerate. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillsGetDiscoveryPathsParams( + /** Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. */ + @JsonProperty("projectPaths") List projectPaths, + /** When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments. */ + @JsonProperty("excludeHostSkills") Boolean excludeHostSkills +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java new file mode 100644 index 000000000..0e12afdbe --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsGetDiscoveryPathsResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Canonical locations where skills can be created so the runtime will recognize them. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SkillsGetDiscoveryPathsResult( + /** Canonical skill create/discovery directories, in priority order */ + @JsonProperty("paths") List paths +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java similarity index 94% rename from java/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java index 697e18fa4..a020c89ec 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SkillsInvokedSkill.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `SkillsInvokedSkill` type. + * Skill invocation record with name, path, content, allowed tools, and turn number. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java new file mode 100644 index 000000000..4c454a55a --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandAgentPromptResult.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandAgentPromptResult extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "agent-prompt"; + + @Override + public String getKind() { return kind; } + + /** Prompt to submit to the agent */ + @JsonProperty("prompt") + private String prompt; + + /** Prompt text to display to the user */ + @JsonProperty("displayPrompt") + private String displayPrompt; + + /** Optional target session mode for the agent prompt */ + @JsonProperty("mode") + private SessionMode mode; + + /** Optional user-facing notice to show before the prompt is submitted */ + @JsonProperty("notice") + private String notice; + + /** True when the invocation mutated user runtime settings; consumers caching settings should refresh */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getPrompt() { return prompt; } + public void setPrompt(String prompt) { this.prompt = prompt; } + + public String getDisplayPrompt() { return displayPrompt; } + public void setDisplayPrompt(String displayPrompt) { this.displayPrompt = displayPrompt; } + + public SessionMode getMode() { return mode; } + public void setMode(SessionMode mode) { this.mode = mode; } + + public String getNotice() { return notice; } + public void setNotice(String notice) { this.notice = notice; } + + public Boolean getRuntimeSettingsChanged() { return runtimeSettingsChanged; } + public void setRuntimeSettingsChanged(Boolean runtimeSettingsChanged) { this.runtimeSettingsChanged = runtimeSettingsChanged; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java new file mode 100644 index 000000000..b2a1970a3 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandCompletedResult.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Slash-command invocation result indicating completion, with optional message and settings-change flag. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandCompletedResult extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "completed"; + + @Override + public String getKind() { return kind; } + + /** Optional user-facing message describing the completed command */ + @JsonProperty("message") + private String message; + + /** True when the invocation mutated user runtime settings; consumers caching settings should refresh */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getMessage() { return message; } + public void setMessage(String message) { this.message = message; } + + public Boolean getRuntimeSettingsChanged() { return runtimeSettingsChanged; } + public void setRuntimeSettingsChanged(Boolean runtimeSettingsChanged) { this.runtimeSettingsChanged = runtimeSettingsChanged; } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java index 722274524..9a725ecec 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInfo.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `SlashCommandInfo` type. + * Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. * * @since 1.0.0 */ @@ -35,6 +35,8 @@ public record SlashCommandInfo( /** Whether the command may run while an agent turn is active */ @JsonProperty("allowDuringAgentExecution") Boolean allowDuringAgentExecution, /** Whether the command is experimental */ - @JsonProperty("experimental") Boolean experimental + @JsonProperty("experimental") Boolean experimental, + /** Whether the command may be the target of `/every` / `/after` schedules. Resolution happens at every tick, so only set this when the command is safe to re-invoke and produces an agent prompt. */ + @JsonProperty("schedulable") Boolean schedulable ) { } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java similarity index 86% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java index dcfc2a36e..f0df78448 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInput.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; import javax.annotation.processing.Generated; /** @@ -23,6 +24,8 @@ public record SlashCommandInput( /** Hint to display when command input has not been provided */ @JsonProperty("hint") String hint, + /** Optional literal choices the input accepts, each with a human-facing description; clients may render these as selectable options */ + @JsonProperty("choices") List choices, /** When true, the command requires non-empty input; clients should render the input hint as required */ @JsonProperty("required") Boolean required, /** Optional completion hint for the input (e.g. 'directory' for filesystem path completion) */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java new file mode 100644 index 000000000..2afc51015 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputChoice.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A literal choice the command input accepts, with a human-facing description + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SlashCommandInputChoice( + /** The literal choice value (e.g. 'on', 'off', 'show') */ + @JsonProperty("name") String name, + /** Human-readable description shown alongside the choice */ + @JsonProperty("description") String description +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputCompletion.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputCompletion.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputCompletion.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInputCompletion.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java new file mode 100644 index 000000000..336c0eda8 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandInvocationResult.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import javax.annotation.processing.Generated; + +/** + * Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). + * + * @since 1.0.0 + */ +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = SlashCommandTextResult.class, name = "text"), + @JsonSubTypes.Type(value = SlashCommandAgentPromptResult.class, name = "agent-prompt"), + @JsonSubTypes.Type(value = SlashCommandCompletedResult.class, name = "completed"), + @JsonSubTypes.Type(value = SlashCommandSelectSubcommandResult.class, name = "select-subcommand") +}) +@JsonIgnoreProperties(ignoreUnknown = true) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public abstract class SlashCommandInvocationResult { + + /** + * Returns the discriminator value for this variant. + * + * @return the kind discriminator + */ + public abstract String getKind(); +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandKind.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandKind.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/SlashCommandKind.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandKind.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java new file mode 100644 index 000000000..00d8b423e --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandOption.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Selectable slash-command subcommand option with name, description, and optional group label. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SlashCommandSelectSubcommandOption( + /** Subcommand name to invoke */ + @JsonProperty("name") String name, + /** Human-readable description of the subcommand */ + @JsonProperty("description") String description, + /** Optional group label for organizing options */ + @JsonProperty("group") String group +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java new file mode 100644 index 000000000..5c151954b --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandSelectSubcommandResult.java @@ -0,0 +1,59 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Slash-command invocation result asking the client to present subcommand options for a parent command. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandSelectSubcommandResult extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "select-subcommand"; + + @Override + public String getKind() { return kind; } + + /** Parent command name that requires subcommand selection */ + @JsonProperty("command") + private String command; + + /** Human-readable title for the selection UI */ + @JsonProperty("title") + private String title; + + /** Available subcommand options for the client to present */ + @JsonProperty("options") + private List options; + + /** True when the invocation mutated user runtime settings; consumers caching settings should refresh */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getCommand() { return command; } + public void setCommand(String command) { this.command = command; } + + public String getTitle() { return title; } + public void setTitle(String title) { this.title = title; } + + public List getOptions() { return options; } + public void setOptions(List options) { this.options = options; } + + public Boolean getRuntimeSettingsChanged() { return runtimeSettingsChanged; } + public void setRuntimeSettingsChanged(Boolean runtimeSettingsChanged) { this.runtimeSettingsChanged = runtimeSettingsChanged; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java new file mode 100644 index 000000000..5f232e8b9 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SlashCommandTextResult.java @@ -0,0 +1,58 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. + * + * @since 1.0.0 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@JsonInclude(JsonInclude.Include.NON_NULL) +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public final class SlashCommandTextResult extends SlashCommandInvocationResult { + + @JsonProperty("kind") + private final String kind = "text"; + + @Override + public String getKind() { return kind; } + + /** Text output for the client to render */ + @JsonProperty("text") + private String text; + + /** Whether text contains Markdown */ + @JsonProperty("markdown") + private Boolean markdown; + + /** Whether ANSI sequences should be preserved */ + @JsonProperty("preserveAnsi") + private Boolean preserveAnsi; + + /** True when the invocation mutated user runtime settings; consumers caching settings should refresh */ + @JsonProperty("runtimeSettingsChanged") + private Boolean runtimeSettingsChanged; + + public String getText() { return text; } + public void setText(String text) { this.text = text; } + + public Boolean getMarkdown() { return markdown; } + public void setMarkdown(Boolean markdown) { this.markdown = markdown; } + + public Boolean getPreserveAnsi() { return preserveAnsi; } + public void setPreserveAnsi(Boolean preserveAnsi) { this.preserveAnsi = preserveAnsi; } + + public Boolean getRuntimeSettingsChanged() { return runtimeSettingsChanged; } + public void setRuntimeSettingsChanged(Boolean runtimeSettingsChanged) { this.runtimeSettingsChanged = runtimeSettingsChanged; } +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java new file mode 100644 index 000000000..29426d931 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntry.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * Subagent model, reasoning effort, and context tier settings + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record SubagentSettingsEntry( + /** Model override for matching subagents */ + @JsonProperty("model") String model, + /** Reasoning effort override for matching subagents */ + @JsonProperty("effortLevel") String effortLevel, + /** Context tier override for matching subagents */ + @JsonProperty("contextTier") SubagentSettingsEntryContextTier contextTier +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java new file mode 100644 index 000000000..ae6261a9c --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/SubagentSettingsEntryContextTier.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Context tier override for matching subagents + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum SubagentSettingsEntryContextTier { + /** The {@code inherit} variant. */ + INHERIT("inherit"), + /** The {@code default} variant. */ + DEFAULT("default"), + /** The {@code long_context} variant. */ + LONG_CONTEXT("long_context"); + + private final String value; + SubagentSettingsEntryContextTier(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static SubagentSettingsEntryContextTier fromValue(String value) { + for (SubagentSettingsEntryContextTier v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown SubagentSettingsEntryContextTier value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Tool.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Tool.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/Tool.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/Tool.java index e4b1361c8..51fe65e6b 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Tool.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Tool.java @@ -14,7 +14,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `Tool` type. + * Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java index 6523f4bdc..caee391ea 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListParams.java @@ -10,13 +10,16 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import javax.annotation.processing.Generated; /** * Optional model identifier whose tool overrides should be applied to the listing. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java similarity index 87% rename from java/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java index 5127277fb..099628aed 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/ToolsListResult.java @@ -10,14 +10,17 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; import java.util.List; import javax.annotation.processing.Generated; /** * Built-in tools available for the requested model, with their parameters and instructions. * + * @apiNote This method is experimental and may change in a future version. * @since 1.0.0 */ +@CopilotExperimental @javax.annotation.processing.Generated("copilot-sdk-codegen") @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIAutoModeSwitchResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIAutoModeSwitchResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIAutoModeSwitchResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIAutoModeSwitchResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponse.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponseAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponseAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponseAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationResponseAction.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationSchema.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationSchema.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIElicitationSchema.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIElicitationSchema.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeAction.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeAction.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeAction.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java new file mode 100644 index 000000000..b65b28fc1 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java @@ -0,0 +1,35 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UIExitPlanModeResponse( + /** Whether the plan was approved. */ + @JsonProperty("approved") Boolean approved, + /** The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. */ + @JsonProperty("selectedAction") UIExitPlanModeAction selectedAction, + /** Whether subsequent edits should be auto-approved without confirmation. */ + @JsonProperty("autoApproveEdits") Boolean autoApproveEdits, + /** Feedback from the user when they declined the plan or requested changes. */ + @JsonProperty("feedback") String feedback, + /** When true, the agent is instructed to end its turn without starting implementation so the client can restore the session model and auto-submit a fresh implementation turn on it. Set only when a distinct plan configuration (a different model, reasoning effort, or context tier) actually ran the planning turn. */ + @JsonProperty("deferImplementation") Boolean deferImplementation +) { +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIHandlePendingSamplingResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIHandlePendingSamplingResponse.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIHandlePendingSamplingResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIHandlePendingSamplingResponse.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java new file mode 100644 index 000000000..53991d9d7 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponse.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * The user's selected action for an exhausted session limit. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UISessionLimitsExhaustedResponse( + /** Action selected by the user. */ + @JsonProperty("action") UISessionLimitsExhaustedResponseAction action, + /** AI Credits to add to the current max when action is 'add'. */ + @JsonProperty("additionalAiCredits") Double additionalAiCredits, + /** New absolute max AI Credits when action is 'set'. */ + @JsonProperty("maxAiCredits") Double maxAiCredits +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java new file mode 100644 index 000000000..6f4e48e6f --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UISessionLimitsExhaustedResponseAction.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * User action selected for an exhausted session limit. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum UISessionLimitsExhaustedResponseAction { + /** The {@code add} variant. */ + ADD("add"), + /** The {@code set} variant. */ + SET("set"), + /** The {@code unset} variant. */ + UNSET("unset"), + /** The {@code cancel} variant. */ + CANCEL("cancel"); + + private final String value; + UISessionLimitsExhaustedResponseAction(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static UISessionLimitsExhaustedResponseAction fromValue(String value) { + for (UISessionLimitsExhaustedResponseAction v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown UISessionLimitsExhaustedResponseAction value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java index d4ce9899d..9abc82505 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UIUserInputResponse.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `UIUserInputResponse` type. + * User response for a pending user-input request, with answer text and whether it was typed freeform. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsCodeChanges.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsCodeChanges.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsCodeChanges.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsCodeChanges.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java similarity index 78% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java index 7e34f43b3..ed5f09305 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetric.java @@ -10,11 +10,12 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; import java.util.Map; import javax.annotation.processing.Generated; /** - * Schema for the `UsageMetricsModelMetric` type. + * Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details. * * @since 1.0.0 */ @@ -26,6 +27,8 @@ public record UsageMetricsModelMetric( @JsonProperty("requests") UsageMetricsModelMetricRequests requests, /** Token usage metrics for this model */ @JsonProperty("usage") UsageMetricsModelMetricUsage usage, + /** Latest known prompt-cache expiration for this model. A timestamp in the past indicates that the observed cache has expired. */ + @JsonProperty("cacheExpiresAt") OffsetDateTime cacheExpiresAt, /** Accumulated nano-AI units cost for this model */ @JsonProperty("totalNanoAiu") Double totalNanoAiu, /** Token count details per type */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricRequests.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricRequests.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricRequests.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricRequests.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java index e47a45fde..90af60c84 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricTokenDetail.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `UsageMetricsModelMetricTokenDetail` type. + * Per-model token-detail entry containing the accumulated token count for one token type. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricUsage.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricUsage.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricUsage.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsModelMetricUsage.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java similarity index 90% rename from java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java index 55d0b81c8..32149bfa7 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UsageMetricsTokenDetail.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `UsageMetricsTokenDetail` type. + * Session-wide token-detail entry containing the accumulated token count for one token type. * * @since 1.0.0 */ diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java new file mode 100644 index 000000000..fb6412f20 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingMetadata.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import javax.annotation.processing.Generated; + +/** + * A single user setting's effective value alongside its default, so consumers can render settings left at their default. + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UserSettingMetadata( + /** The effective value: the user's value if set, otherwise the default. */ + @JsonProperty("value") Object value, + /** The centrally-known default for this setting (null when no default is registered). */ + @JsonProperty("default") Object default_, + /** True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false. */ + @JsonProperty("isDefault") Boolean isDefault +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java new file mode 100644 index 000000000..c94e90fcc --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsGetResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.Map; +import javax.annotation.processing.Generated; + +/** + * Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UserSettingsGetResult( + /** Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default. */ + @JsonProperty("settings") Map settings +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java new file mode 100644 index 000000000..ba19886c2 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetParams.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import javax.annotation.processing.Generated; + +/** + * Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UserSettingsSetParams( + /** Partial user settings to write, as a free-form object keyed by setting name */ + @JsonProperty("settings") Object settings +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java new file mode 100644 index 000000000..c5ab98621 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/UserSettingsSetResult.java @@ -0,0 +1,31 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.CopilotExperimental; +import java.util.List; +import javax.annotation.processing.Generated; + +/** + * Outcome of writing user settings. + * + * @apiNote This method is experimental and may change in a future version. + * @since 1.0.0 + */ +@CopilotExperimental +@javax.annotation.processing.Generated("copilot-sdk-codegen") +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public record UserSettingsSetResult( + /** Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed. */ + @JsonProperty("shadowedKeys") List shadowedKeys +) { +} diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java new file mode 100644 index 000000000..188ce23b4 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/Verbosity.java @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +package com.github.copilot.generated.rpc; + +import javax.annotation.processing.Generated; + +/** + * Output verbosity level for supported models + * + * @since 1.0.0 + */ +@javax.annotation.processing.Generated("copilot-sdk-codegen") +public enum Verbosity { + /** The {@code low} variant. */ + LOW("low"), + /** The {@code medium} variant. */ + MEDIUM("medium"), + /** The {@code high} variant. */ + HIGH("high"); + + private final String value; + Verbosity(String value) { this.value = value; } + @com.fasterxml.jackson.annotation.JsonValue + public String getValue() { return value; } + @com.fasterxml.jackson.annotation.JsonCreator + public static Verbosity fromValue(String value) { + for (Verbosity v : values()) { + if (v.value.equals(value)) return v; + } + throw new IllegalArgumentException("Unknown Verbosity value: " + value); + } +} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java similarity index 88% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java index f091bc279..e63b92b56 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChange.java @@ -21,7 +21,7 @@ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public record WorkspaceDiffFileChange( - /** Path to the changed file, relative to the workspace root. */ + /** Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive). */ @JsonProperty("path") String path, /** Unified diff content for the file. Empty when the diff was truncated. */ @JsonProperty("diff") String diff, diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChangeType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChangeType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChangeType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffFileChangeType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java similarity index 93% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java index a2762954b..7cc33e3c5 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceDiffMode.java @@ -19,7 +19,9 @@ public enum WorkspaceDiffMode { /** The {@code unstaged} variant. */ UNSTAGED("unstaged"), /** The {@code branch} variant. */ - BRANCH("branch"); + BRANCH("branch"), + /** The {@code session} variant. */ + SESSION("session"); private final String value; WorkspaceDiffMode(String value) { this.value = value; } diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceSummaryHostType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceSummaryHostType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspaceSummaryHostType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspaceSummaryHostType.java diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java similarity index 91% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java index 07de034a9..c3696236c 100644 --- a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspacesCheckpoints.java @@ -13,7 +13,7 @@ import javax.annotation.processing.Generated; /** - * Schema for the `WorkspacesCheckpoints` type. + * Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. * * @since 1.0.0 */ diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/WorkspacesWorkspaceDetailsHostType.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspacesWorkspaceDetailsHostType.java similarity index 100% rename from java/src/generated/java/com/github/copilot/generated/rpc/WorkspacesWorkspaceDetailsHostType.java rename to java/sdk/src/generated/java/com/github/copilot/generated/rpc/WorkspacesWorkspaceDetailsHostType.java diff --git a/java/sdk/src/generated/java/com/github/copilot/generated/rpc/package-info.java b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/package-info.java new file mode 100644 index 000000000..8248ee188 --- /dev/null +++ b/java/sdk/src/generated/java/com/github/copilot/generated/rpc/package-info.java @@ -0,0 +1,38 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +// AUTO-GENERATED FILE - DO NOT EDIT +// Generated from: api.schema.json + +/** + * Auto-generated RPC parameter and result types for the GitHub Copilot SDK. + * + *

+ * This package contains Java records and classes generated from the Copilot + * CLI's {@code api.schema.json}. These types represent the request parameters + * and response payloads for all JSON-RPC methods exposed by the CLI. + * + *

Key Classes

+ *
    + *
  • {@link com.github.copilot.generated.rpc.RpcCaller} - Functional interface + * for invoking JSON-RPC methods with typed responses.
    • + *
  • {@link com.github.copilot.generated.rpc.ServerRpc} - Typed client for + * server-level RPC methods (session management, model listing, etc.).
    • + *
  • {@link com.github.copilot.generated.rpc.SessionRpc} - Typed client for + * session-scoped RPC methods (send messages, manage tools, etc.). Automatically + * injects the {@code sessionId} into every call.
    • + *
+ * + *

Related Packages

+ *
    + *
  • {@link com.github.copilot} - Core SDK classes
    • + *
  • {@link com.github.copilot.generated} - Auto-generated session event + * types
    • + *
+ * + * @see com.github.copilot.CopilotClient + * @see com.github.copilot.generated.rpc.ServerRpc + * @see com.github.copilot.generated.rpc.SessionRpc + */ +package com.github.copilot.generated.rpc; diff --git a/java/sdk/src/main/java/com/github/copilot/AllowCopilotExperimental.java b/java/sdk/src/main/java/com/github/copilot/AllowCopilotExperimental.java new file mode 100644 index 000000000..fc33b31dc --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/AllowCopilotExperimental.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Opts a declaration into using {@link CopilotExperimental} APIs. + * + *

+ * Apply this annotation to a type to allow declaration-level references to + * experimental APIs anywhere within that type, or apply it to a method or + * constructor to allow experimental API usage in that executable's signature. + * This is a code-level alternative to the compiler option + * {@code -Acopilot.experimental.allowed=true}. + * + *

+ * This opt-in has the same declaration-level scope as the processor itself. It + * does not affect expression-only usages inside method bodies that are not + * visible to standard JSR 269 annotation processing. + * + * @since 1.0.0 + */ +@Documented +@Retention(RetentionPolicy.CLASS) +@Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR}) +public @interface AllowCopilotExperimental { +} diff --git a/java/src/main/java/com/github/copilot/CliServerManager.java b/java/sdk/src/main/java/com/github/copilot/CliServerManager.java similarity index 98% rename from java/src/main/java/com/github/copilot/CliServerManager.java rename to java/sdk/src/main/java/com/github/copilot/CliServerManager.java index a6a08a848..acc683a72 100644 --- a/java/src/main/java/com/github/copilot/CliServerManager.java +++ b/java/sdk/src/main/java/com/github/copilot/CliServerManager.java @@ -150,6 +150,9 @@ ProcessInfo startCliServer() throws IOException, InterruptedException { if (telemetry.getOtlpEndpoint() != null) { pb.environment().put("OTEL_EXPORTER_OTLP_ENDPOINT", telemetry.getOtlpEndpoint()); } + if (telemetry.getOtlpProtocol() != null) { + pb.environment().put("OTEL_EXPORTER_OTLP_PROTOCOL", telemetry.getOtlpProtocol()); + } if (telemetry.getFilePath() != null) { pb.environment().put("COPILOT_OTEL_FILE_EXPORTER_PATH", telemetry.getFilePath()); } diff --git a/java/src/main/java/com/github/copilot/ConnectionState.java b/java/sdk/src/main/java/com/github/copilot/ConnectionState.java similarity index 100% rename from java/src/main/java/com/github/copilot/ConnectionState.java rename to java/sdk/src/main/java/com/github/copilot/ConnectionState.java diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotClient.java b/java/sdk/src/main/java/com/github/copilot/CopilotClient.java new file mode 100644 index 000000000..cdd1b9ff3 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotClient.java @@ -0,0 +1,1734 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.Executor; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.github.copilot.ffi.FfiRuntimeHost; +import com.github.copilot.ffi.NativeRuntimeLoader; +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.InProcessRuntimeConnection; +import com.github.copilot.rpc.RuntimeConnection; +import com.github.copilot.rpc.StdioRuntimeConnection; +import com.github.copilot.rpc.TcpRuntimeConnection; +import com.github.copilot.rpc.UriRuntimeConnection; +import com.github.copilot.rpc.CreateSessionResponse; +import com.github.copilot.generated.rpc.SessionOptionsUpdateParams; +import com.github.copilot.generated.rpc.SessionInstalledPlugin; +import com.github.copilot.generated.rpc.ConnectResult; +import com.github.copilot.generated.rpc.GitHubTelemetryNotification; +import com.github.copilot.generated.rpc.ServerRpc; +import com.github.copilot.generated.rpc.SessionEventLogRegisterInterestParams; +import com.github.copilot.rpc.DeleteSessionResponse; +import com.github.copilot.rpc.GetAuthStatusResponse; +import com.github.copilot.rpc.GetLastSessionIdResponse; +import com.github.copilot.rpc.GetSessionMetadataResponse; +import com.github.copilot.rpc.GetModelsResponse; +import com.github.copilot.rpc.GetStatusResponse; +import com.github.copilot.rpc.ListSessionsResponse; +import com.github.copilot.rpc.MemoryConfiguration; +import com.github.copilot.rpc.ModelInfo; +import com.github.copilot.rpc.PingResponse; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.ResumeSessionResponse; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SessionLifecycleHandler; +import com.github.copilot.rpc.SessionListFilter; +import com.github.copilot.rpc.SessionMetadata; + +/** + * Provides a client for interacting with the Copilot CLI server. + *

+ * The CopilotClient manages the connection to the Copilot CLI server and + * provides methods to create and manage conversation sessions. It can either + * spawn a CLI server process or connect to an existing server. + *

+ * Example usage: + * + * 

{@code
+ * try (var client = new CopilotClient()) {
+ * 	client.start().get();
+ *
+ * 	var session = client
+ * 			.createSession(
+ * 					new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5"))
+ * 			.get();
+ *
+ * 	session.on(AssistantMessageEvent.class, msg -> {
+ * 		System.out.println(msg.getData().content());
+ * 	});
+ *
+ * 	session.send(new MessageOptions().setPrompt("Hello!")).get();
+ * }
+ * }
+ * + * @since 1.0.0 + */ +public final class CopilotClient implements AutoCloseable { + + private static final Logger LOG = Logger.getLogger(CopilotClient.class.getName()); + + /** + * Timeout, in seconds, used by {@link #close()} when waiting for graceful + * shutdown via {@link #stop()}. + */ + public static final int AUTOCLOSEABLE_TIMEOUT_SECONDS = 10; + private static final int RUNTIME_SHUTDOWN_TIMEOUT_SECONDS = 10; + private static final int FORCE_KILL_TIMEOUT_SECONDS = 10; + + /** + * One-shot dispatcher used to run the owned-executor shutdown off any caller + * thread that might itself belong to that executor (e.g. the + * {@link #forceStop()} continuation, which is chained off async work scheduled + * on the internal executor). Spawning a fresh daemon thread guarantees + * {@link java.util.concurrent.ExecutorService#awaitTermination(long, TimeUnit)} + * is never called from inside the very executor it is waiting on. + */ + private static final Executor SHUTDOWN_DISPATCHER = runnable -> { + Thread t = new Thread(runnable, "copilot-client-shutdown"); + t.setDaemon(true); + t.start(); + }; + + private final CopilotClientOptions options; + private final Executor executor; + private final boolean executorCanBeShutdown; + private final CliServerManager serverManager; + private final LifecycleEventManager lifecycleManager = new LifecycleEventManager(); + private final Map sessions = new ConcurrentHashMap<>(); + private volatile CompletableFuture connectionFuture; + private volatile boolean disposed = false; + private final String optionsHost; + private final Integer optionsPort; + private final RuntimeConnection runtimeConnection; + private final String effectiveConnectionToken; + private final Runnable closeHook; + private volatile List modelsCache; + private final Object modelsCacheLock = new Object(); + + /** + * Creates a new CopilotClient with default options. + */ + public CopilotClient() { + this(new CopilotClientOptions()); + } + + /** + * Creates a new CopilotClient with the specified options. + * + * @param options + * Options for creating the client + * @throws IllegalArgumentException + * if mutually exclusive options are provided + */ + public CopilotClient(CopilotClientOptions options) { + this(options, null); + } + + CopilotClient(CopilotClientOptions options, Runnable closeHook) { + this.options = options != null ? options : new CopilotClientOptions(); + this.closeHook = closeHook; + + // Resolve the transport: an explicit RuntimeConnection wins; otherwise the + // COPILOT_SDK_DEFAULT_CONNECTION env var, or the individual transport options. + RuntimeConnection requestedConnection = this.options.getConnection(); + if (requestedConnection != null) { + validateEnvironmentOptions(this.options, requestedConnection); + validateConnectionConflicts(this.options, requestedConnection); + applyConnection(this.options, requestedConnection); + } else { + requestedConnection = resolveDefaultConnection(this.options); + validateEnvironmentOptions(this.options, requestedConnection); + // When the env var overrides inference (e.g. inprocess), validate that + // no legacy transport options conflict with the resolved connection. + if (requestedConnection != null) { + validateConnectionConflicts(this.options, requestedConnection); + } + } + this.runtimeConnection = requestedConnection; + + // When cliUrl is set, auto-correct useStdio since we're connecting via TCP + if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()) { + this.options.setUseStdio(false); + } + + // Validate mutually exclusive options: cliUrl and cliPath cannot both be set + if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty() + && this.options.getCliPath() != null) { + throw new IllegalArgumentException("CliUrl is mutually exclusive with CliPath"); + } + + // Validate auth options with external server + if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty() + && (this.options.getGitHubToken() != null || this.options.getUseLoggedInUser().isPresent())) { + throw new IllegalArgumentException( + "GitHubToken and UseLoggedInUser cannot be used with CliUrl (external server manages its own auth)"); + } + + // Validate tcpConnectionToken + if (this.options.getTcpConnectionToken() != null) { + if (this.options.getTcpConnectionToken().isEmpty()) { + throw new IllegalArgumentException("TcpConnectionToken must be a non-empty string"); + } + if (this.options.isUseStdio()) { + throw new IllegalArgumentException("TcpConnectionToken cannot be used with UseStdio = true"); + } + } + + // Compute effective connection token: use provided, or auto-generate for + // SDK-spawned TCP mode, or null for stdio/external server + boolean sdkSpawnsCli = !this.options.isUseStdio() + && (this.options.getCliUrl() == null || this.options.getCliUrl().isEmpty()); + this.effectiveConnectionToken = this.options.getTcpConnectionToken() != null + ? this.options.getTcpConnectionToken() + : (sdkSpawnsCli ? java.util.UUID.randomUUID().toString() : null); + + // Empty mode: validate at construction time that the app supplied a + // per-session persistence location. + if (this.options.getMode() == CopilotClientMode.EMPTY) { + boolean hasPersistence = (this.options.getCopilotHome() != null && !this.options.getCopilotHome().isEmpty()) + || (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()); + if (!hasPersistence) { + throw new IllegalArgumentException( + "CopilotClient was created with Mode = EMPTY but neither CopilotHome nor CliUrl was set. " + + "Empty mode requires an explicit per-session persistence location."); + } + } + + // Parse CliUrl if provided + if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()) { + URI uri = CliServerManager.parseCliUrl(this.options.getCliUrl()); + this.optionsHost = uri.getHost(); + this.optionsPort = uri.getPort(); + } else { + this.optionsHost = null; + this.optionsPort = null; + } + + InternalExecutorProvider executorProvider = new InternalExecutorProvider(this.options.getExecutor()); + this.executor = executorProvider.get(); + this.executorCanBeShutdown = executorProvider.canBeShutdown(); + + this.serverManager = new CliServerManager(this.options); + this.serverManager.setConnectionToken(this.effectiveConnectionToken); + } + + /** + * Environment variable that overrides the transport used when the caller does + * not set {@link CopilotClientOptions#setConnection(RuntimeConnection)}. + * Accepts {@code "inprocess"} or {@code "stdio"} (case-insensitive); unset + * keeps the transport selected by the individual transport options. Any other + * value is an error. Ignored when a connection is set explicitly. + */ + static final String DEFAULT_CONNECTION_ENV_VAR = "COPILOT_SDK_DEFAULT_CONNECTION"; + + /** + * Resolves the connection to use when the caller did not set one, honoring + * {@link #DEFAULT_CONNECTION_ENV_VAR} and otherwise inferring the transport + * from the individual transport options. + */ + private static RuntimeConnection resolveDefaultConnection(CopilotClientOptions options) { + return resolveDefaultConnection(options, System.getenv(DEFAULT_CONNECTION_ENV_VAR)); + } + + /** + * Resolves the default connection from an explicit environment-variable value. + * Package-private so tests can supply the value directly. + */ + static RuntimeConnection resolveDefaultConnection(CopilotClientOptions options, String envValue) { + if (envValue != null && !envValue.isEmpty()) { + if ("inprocess".equalsIgnoreCase(envValue)) { + // Explicit subprocess options take precedence over the env var default. + if (options.getCliUrl() != null && !options.getCliUrl().isEmpty()) { + return inferConnectionFromOptions(options); + } + if (options.getCliPath() != null && !options.getCliPath().isEmpty()) { + return inferConnectionFromOptions(options); + } + if (options.getPort() != 0) { + return inferConnectionFromOptions(options); + } + if (!options.isUseStdio() || options.getTcpConnectionToken() != null) { + return inferConnectionFromOptions(options); + } + return RuntimeConnection.forInProcess(); + } + if (!"stdio".equalsIgnoreCase(envValue)) { + throw new IllegalArgumentException("Invalid " + DEFAULT_CONNECTION_ENV_VAR + " value '" + envValue + + "'. Expected 'inprocess', 'stdio', or unset."); + } + } + + return inferConnectionFromOptions(options); + } + + /** + * Maps the individual transport options onto the equivalent + * {@link RuntimeConnection}, preserving the behavior of clients written before + * connections existed. + */ + private static RuntimeConnection inferConnectionFromOptions(CopilotClientOptions options) { + String cliUrl = options.getCliUrl(); + List args = options.getCliArgs() != null ? Arrays.asList(options.getCliArgs()) : null; + if (cliUrl != null && !cliUrl.isEmpty()) { + return RuntimeConnection.forUri(cliUrl).setConnectionToken(options.getTcpConnectionToken()); + } + if (options.isUseStdio()) { + StdioRuntimeConnection stdio = RuntimeConnection.forStdio(options.getCliPath()); + if (args != null) { + stdio.setArgs(args); + } + return stdio; + } + TcpRuntimeConnection tcp = RuntimeConnection.forTcp().setPath(options.getCliPath()).setPort(options.getPort()) + .setConnectionToken(options.getTcpConnectionToken()); + if (args != null) { + tcp.setArgs(args); + } + return tcp; + } + + /** + * Rejects transport options that contradict the configured connection. Values + * that match what the connection implies are accepted so that constructing + * several clients from the same options instance stays valid. + */ + private static void validateConnectionConflicts(CopilotClientOptions options, RuntimeConnection connection) { + String impliedPath = null; + String impliedUrl = null; + String impliedToken = null; + int impliedPort = 0; + boolean impliedUseStdio = true; + List impliedArgs = null; + + if (connection instanceof StdioRuntimeConnection stdio) { + impliedPath = stdio.getPath(); + impliedArgs = stdio.getArgs(); + } else if (connection instanceof TcpRuntimeConnection tcp) { + impliedPath = tcp.getPath(); + impliedPort = tcp.getPort(); + impliedToken = tcp.getConnectionToken(); + impliedArgs = tcp.getArgs(); + impliedUseStdio = false; + } else if (connection instanceof UriRuntimeConnection uri) { + impliedUrl = uri.getUrl(); + impliedToken = uri.getConnectionToken(); + impliedUseStdio = false; + } + + rejectConflict("CliPath", options.getCliPath() != null && !options.getCliPath().equals(impliedPath)); + rejectConflict("CliUrl", options.getCliUrl() != null && !options.getCliUrl().isEmpty() + && !options.getCliUrl().equals(impliedUrl)); + rejectConflict("Port", options.getPort() != 0 && options.getPort() != impliedPort); + rejectConflict("TcpConnectionToken", + options.getTcpConnectionToken() != null && !options.getTcpConnectionToken().equals(impliedToken)); + rejectConflict("UseStdio", !options.isUseStdio() && impliedUseStdio); + rejectConflict("CliArgs", options.getCliArgs() != null + && !Arrays.asList(options.getCliArgs()).equals(impliedArgs == null ? List.of() : impliedArgs)); + } + + private static void rejectConflict(String optionName, boolean conflicting) { + if (conflicting) { + throw new IllegalArgumentException("CopilotClientOptions." + optionName + + " cannot be combined with CopilotClientOptions.setConnection(); configure the transport on the" + + " RuntimeConnection instead."); + } + } + + /** + * Projects the configured connection onto the individual transport options so + * that the rest of the client sees a single, consistent view of the transport. + */ + private static void applyConnection(CopilotClientOptions options, RuntimeConnection connection) { + if (connection instanceof StdioRuntimeConnection stdio) { + options.setUseStdio(true); + if (stdio.getPath() != null) { + options.setCliPath(stdio.getPath()); + } + applyConnectionArgs(options, stdio.getArgs()); + } else if (connection instanceof TcpRuntimeConnection tcp) { + options.setUseStdio(false); + if (tcp.getPath() != null) { + options.setCliPath(tcp.getPath()); + } + options.setPort(tcp.getPort()); + if (tcp.getConnectionToken() != null) { + options.setTcpConnectionToken(tcp.getConnectionToken()); + } + applyConnectionArgs(options, tcp.getArgs()); + } else if (connection instanceof UriRuntimeConnection uri) { + options.setUseStdio(false); + options.setCliUrl(uri.getUrl()); + if (uri.getConnectionToken() != null) { + options.setTcpConnectionToken(uri.getConnectionToken()); + } + } + } + + private static void applyConnectionArgs(CopilotClientOptions options, List args) { + if (args != null) { + options.setCliArgs(args.toArray(new String[0])); + } + } + + /** + * Rejects per-process options that the in-process transport cannot honor. These + * options are lowered onto a child process, but the in-process runtime runs + * inside the shared host process, whose single environment and working + * directory cannot carry per-client values. + */ + private static void validateEnvironmentOptions(CopilotClientOptions options, RuntimeConnection connection) { + if (!(connection instanceof InProcessRuntimeConnection)) { + return; + } + + rejectInProcessOption("Environment", options.getEnvironment() != null && !options.getEnvironment().isEmpty(), + "set the variables on the host process environment instead"); + rejectInProcessOption("Telemetry", options.getTelemetry() != null, + "configure telemetry through the host process environment instead"); + rejectInProcessOption("Cwd", options.getCwd() != null, + "set the process working directory before creating the client instead"); + rejectInProcessOption("CliArgs", options.getCliArgs() != null && options.getCliArgs().length > 0, + "use the typed client options instead"); + } + + private static void rejectInProcessOption(String optionName, boolean present, String remedy) { + if (present) { + throw new IllegalArgumentException("CopilotClientOptions." + optionName + + " is not supported with RuntimeConnection.forInProcess(): the in-process runtime shares the host" + + " process, so per-client values cannot be honored; " + remedy + "."); + } + } + + /** + * Duplex streams of an in-process runtime, together with the resource that owns + * its lifetime. + * + * @param receiveStream + * stream carrying messages from the runtime + * @param sendStream + * stream carrying messages to the runtime + * @param host + * resource closed when the client stops + */ + record InProcessTransport(InputStream receiveStream, OutputStream sendStream, AutoCloseable host) { + } + + /** + * Opens the transport for the in-process runtime. Package-private so tests can + * substitute a fake for the native runtime. + */ + @FunctionalInterface + interface InProcessTransportFactory { + /** + * Opens the in-process transport. + * + * @param options + * client options used to configure the runtime + * @return the opened transport + * @throws IOException + * if the runtime cannot be started + */ + InProcessTransport open(CopilotClientOptions options) throws IOException; + } + + private volatile InProcessTransportFactory inProcessTransportFactory = CopilotClient::openInProcessTransport; + + /** + * Returns the resolved connection describing how this client reaches the + * runtime. Package-private test seam. + * + * @return the resolved connection + */ + RuntimeConnection getRuntimeConnection() { + return runtimeConnection; + } + + /** + * Replaces the in-process transport factory. Package-private test seam. + * + * @param factory + * the factory to use + */ + void setInProcessTransportFactory(InProcessTransportFactory factory) { + this.inProcessTransportFactory = java.util.Objects.requireNonNull(factory, "factory must not be null"); + } + + private static InProcessTransport openInProcessTransport(CopilotClientOptions options) throws IOException { + FfiRuntimeHost host = new FfiRuntimeHost(); + try { + host.start(resolveInProcessEntrypoint(), options); + } catch (RuntimeException | Error e) { + host.close(); + throw e; + } + return new InProcessTransport(host.getReceiveStream(), host.getSendStream(), host); + } + + /** + * Resolves the runtime entrypoint handed to the in-process host. The copilot + * CLI executable is resolved from the same bundled location as + * {@code runtime.node} — no environment variables or PATH search. + */ + private static String resolveInProcessEntrypoint() throws IOException { + return NativeRuntimeLoader.resolveEntrypoint().toString(); + } + + private static void closeRuntimeHost(AutoCloseable host) { + try { + host.close(); + } catch (Exception e) { + LOG.log(Level.FINE, "Error closing in-process runtime host", e); + } + } + + /** + * Starts the Copilot client and connects to the server. + * + * @return A future that completes when the connection is established + */ + public CompletableFuture start() { + if (connectionFuture == null) { + synchronized (this) { + if (connectionFuture == null) { + connectionFuture = startCore(); + } + } + } + return connectionFuture.thenApply(c -> null); + } + + private CompletableFuture startCore() { + LOG.fine("Starting Copilot client"); + + try { + return CompletableFuture.supplyAsync(this::startCoreBody, executor); + } catch (RejectedExecutionException e) { + return CompletableFuture.failedFuture(e); + } + } + + private Connection startCoreBody() { + Process process = null; + JsonRpcClient rpc = null; + InProcessTransport inProcessTransport = null; + long startNanos = System.nanoTime(); + try { + if (runtimeConnection instanceof InProcessRuntimeConnection) { + // In-process runtime hosted in this process (no child process) + inProcessTransport = inProcessTransportFactory.open(options); + rpc = JsonRpcClient.fromStreams(inProcessTransport.receiveStream(), inProcessTransport.sendStream()); + } else if (optionsHost != null && optionsPort != null) { + // External server (TCP) + rpc = serverManager.connectToServer(null, optionsHost, optionsPort); + } else { + // Child process (stdio or TCP) + CliServerManager.ProcessInfo processInfo = serverManager.startCliServer(); + process = processInfo.process(); + rpc = serverManager.connectToServer(process, processInfo.port() != null ? "localhost" : null, + processInfo.port()); + } + + LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.start transport setup complete. Elapsed={Elapsed}", + startNanos); + + JsonRpcClient connectedRpc = rpc; + Connection connection = new Connection(connectedRpc, process, new ServerRpc(connectedRpc::invoke), + inProcessTransport == null ? null : inProcessTransport.host()); + + // Register handlers for server-to-client calls + RpcHandlerDispatcher dispatcher = new RpcHandlerDispatcher(sessions, lifecycleManager::dispatch, executor); + dispatcher.registerHandlers(connectedRpc); + + // Register the LLM inference request handler when configured. + com.github.copilot.CopilotRequestHandler requestHandler = this.options.getRequestHandler(); + boolean hasLlmInference = requestHandler != null; + if (hasLlmInference) { + LlmInferenceAdapter llmAdapter = new LlmInferenceAdapter(requestHandler, + () -> connection.serverRpc().llmInference, executor); + llmAdapter.registerHandlers(connectedRpc); + } + + // Register the GitHub telemetry forwarding handler when configured. + Function> onGitHubTelemetry = this.options + .getOnGitHubTelemetry(); + if (onGitHubTelemetry != null) { + GitHubTelemetryAdapter telemetryAdapter = new GitHubTelemetryAdapter(onGitHubTelemetry); + telemetryAdapter.registerHandlers(connectedRpc); + } + + // Verify protocol version + verifyProtocolVersion(connection); + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.start protocol verification complete. Elapsed={Elapsed}", startNanos); + + var builtinPluginDirectories = options.getBuiltinPluginDirectories(); + if (builtinPluginDirectories != null && !builtinPluginDirectories.isEmpty()) { + var paths = new ArrayList(builtinPluginDirectories.size()); + for (var path : builtinPluginDirectories) { + paths.add(path.toString()); + } + connection.rpc.invoke("plugins.builtin.set", Map.of("paths", paths), Void.class).join(); + } + + // Register as the runtime's LLM inference provider once connected. + if (hasLlmInference) { + connection.serverRpc().llmInference.setProvider().join(); + } + + LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.start complete. Elapsed={Elapsed}", startNanos); + return connection; + } catch (Exception e) { + if (!(e instanceof java.util.concurrent.CancellationException)) { + LoggingHelpers.logTiming(LOG, Level.WARNING, e, "CopilotClient.start failed. Elapsed={Elapsed}", + startNanos); + } + // Clean up the spawned process if connection setup failed + if (process != null) { + cleanupCliProcess(process, true); + } + if (rpc != null) { + try { + rpc.close(); + } catch (Exception closeError) { + LOG.log(Level.FINE, "Error closing RPC after failed startup", closeError); + } + } + if (inProcessTransport != null) { + closeRuntimeHost(inProcessTransport.host()); + } + String stderr = serverManager.getStderrOutput(); + if (!stderr.isEmpty()) { + throw new CompletionException(new IOException( + CliServerManager.formatCliExitedMessage("CLI process exited unexpectedly.", stderr), e)); + } + throw new CompletionException(e); + } + } + + private static final int MIN_PROTOCOL_VERSION = 2; + private static final int METHOD_NOT_FOUND_ERROR_CODE = -32601; + + private void verifyProtocolVersion(Connection connection) throws Exception { + int expectedVersion = SdkProtocolVersion.get(); + Integer serverVersion; + + try { + // Try the new 'connect' RPC which supports connection tokens. + var connectParams = new HashMap(); + if (effectiveConnectionToken != null) { + connectParams.put("token", effectiveConnectionToken); + } + // Opt into GitHub telemetry forwarding at the connection level when a handler + // is registered, so the runtime can forward the first session's un-replayable + // start event. Also sent on session create/resume for backward compatibility + // with servers that read the flag there instead. + if (this.options.getOnGitHubTelemetry() != null) { + connectParams.put("enableGitHubTelemetryForwarding", true); + } + var connectResponse = connection.rpc.invoke("connect", connectParams, ConnectResult.class).get(30, + TimeUnit.SECONDS); + serverVersion = connectResponse.protocolVersion() != null + ? connectResponse.protocolVersion().intValue() + : null; + } catch (Exception e) { + // Unwrap CompletionException/ExecutionException to check inner cause + Throwable cause = e; + while (cause instanceof java.util.concurrent.ExecutionException || cause instanceof CompletionException) { + cause = cause.getCause(); + } + if (cause instanceof JsonRpcException rpcEx && isUnsupportedConnectMethod(rpcEx)) { + // Legacy server without 'connect'; fall back to 'ping'. + // A token, if any, is silently dropped — the legacy server can't enforce one. + var params = new HashMap(); + params.put("message", null); + PingResponse pingResponse = connection.rpc.invoke("ping", params, PingResponse.class).get(30, + TimeUnit.SECONDS); + serverVersion = pingResponse.protocolVersion(); + } else { + throw e; + } + } + + if (serverVersion == null) { + throw new RuntimeException("SDK protocol version mismatch: SDK supports versions " + MIN_PROTOCOL_VERSION + + "-" + expectedVersion + ", but server does not report a protocol version. " + + "Please update your server to ensure compatibility."); + } + + if (serverVersion < MIN_PROTOCOL_VERSION || serverVersion > expectedVersion) { + throw new RuntimeException("SDK protocol version mismatch: SDK supports versions " + MIN_PROTOCOL_VERSION + + "-" + expectedVersion + ", but server reports version " + serverVersion + ". " + + "Please update your SDK or server to ensure compatibility."); + } + } + + private static boolean isUnsupportedConnectMethod(JsonRpcException ex) { + return ex.getCode() == METHOD_NOT_FOUND_ERROR_CODE || "Unhandled method connect".equals(ex.getMessage()); + } + + /** + * Disconnects from the Copilot server and closes all active sessions. + *

+ * This method performs graceful cleanup: + *

    + *
  1. Closes all active sessions (releases in-memory resources)
    2. + *
  2. Requests runtime shutdown for SDK-owned CLI processes
    3. + *
  3. Closes the JSON-RPC connection
    4. + *
  4. Terminates the CLI server process (if spawned by this client)
    5. + *
+ *

+ * Note: session data on disk is preserved, so sessions can be resumed later. To + * permanently remove session data before stopping, call + * {@link #deleteSession(String)} for each session first. + * + * @return A future that completes when the client is stopped + */ + public CompletableFuture stop() { + var closeFutures = new ArrayList>(); + + for (CopilotSession session : new ArrayList<>(sessions.values())) { + Runnable closeTask = () -> { + try { + session.close(); + } catch (Exception e) { + LOG.log(Level.WARNING, "Error closing session " + session.getSessionId(), e); + } + }; + CompletableFuture future; + try { + future = CompletableFuture.runAsync(closeTask, executor); + } catch (RejectedExecutionException e) { + LOG.log(Level.WARNING, "Executor rejected session close task; closing inline", e); + closeTask.run(); + future = CompletableFuture.completedFuture(null); + } + closeFutures.add(future); + } + sessions.clear(); + + return CompletableFuture.allOf(closeFutures.toArray(new CompletableFuture[0])) + .thenCompose(v -> cleanupConnection(true)); + } + + /** + * Forces an immediate stop of the client without graceful cleanup. + * + * @return A future that completes when the client is stopped + */ + public CompletableFuture forceStop() { + disposed = true; + sessions.clear(); + // Dispatch the blocking shutdownOwnedExecutor() on a dedicated thread: + // cleanupConnection() is chained off async work running on the owned + // executor, so a plain whenComplete(...) here could land the awaitTermination + // call on one of the very threads it is waiting to drain, forcing the full + // AUTOCLOSEABLE_TIMEOUT_SECONDS timeout followed by shutdownNow(). + return cleanupConnection(false).whenCompleteAsync((ignored, error) -> shutdownOwnedExecutor(), + SHUTDOWN_DISPATCHER); + } + + private CompletableFuture cleanupConnection(boolean gracefulRuntimeShutdown) { + CompletableFuture future = connectionFuture; + connectionFuture = null; + + // Clear models cache + modelsCache = null; + + if (future == null) { + return CompletableFuture.completedFuture(null); + } + + return future.handle((connection, startupError) -> { + if (startupError != null) { + LOG.log(Level.FINE, "Ignoring failed Copilot client startup during cleanup", startupError); + return CompletableFuture.completedFuture(null); + } + + CompletableFuture shutdownFuture = CompletableFuture.completedFuture(null); + if (gracefulRuntimeShutdown && (connection.process != null || connection.runtimeHost != null)) { + long runtimeShutdownStartNanos = System.nanoTime(); + shutdownFuture = connection.rpc.invoke("runtime.shutdown", Map.of(), Void.class) + .orTimeout(RUNTIME_SHUTDOWN_TIMEOUT_SECONDS, TimeUnit.SECONDS) + .whenComplete((ignored, error) -> { + if (error == null) { + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.stop runtime shutdown complete. Elapsed={Elapsed}", + runtimeShutdownStartNanos); + } else { + LoggingHelpers.logTiming(LOG, Level.FINE, error, + "CopilotClient.stop runtime shutdown failed. Elapsed={Elapsed}", + runtimeShutdownStartNanos); + } + }); + } + + return shutdownFuture.handle((ignored, error) -> { + try { + connection.rpc.close(); + } catch (Exception e) { + LOG.log(Level.FINE, "Error closing RPC", e); + } + + if (connection.process != null) { + cleanupCliProcess(connection.process, !gracefulRuntimeShutdown || error != null); + } + if (connection.runtimeHost != null) { + closeRuntimeHost(connection.runtimeHost); + } + return (Void) null; + }); + }).thenCompose(result -> result); + } + + private static void cleanupCliProcess(Process process, boolean forceImmediately) { + try { + if (process.isAlive()) { + // The runtime completes all cleanup before responding to + // runtime.shutdown and then leaves termination to us; it + // deliberately keeps its JSON-RPC server alive to send the + // response and never self-exits. Waiting for a self-exit that + // will never come just wastes time, so terminate the child + // immediately and only wait to reap it. + if (forceImmediately) { + process.destroyForcibly(); + if (!process.waitFor(FORCE_KILL_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + LOG.fine("Process did not terminate within force kill timeout"); + } + return; + } + + process.destroy(); + if (process.waitFor(FORCE_KILL_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + return; + } + + process.destroyForcibly(); + if (!process.waitFor(FORCE_KILL_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + LOG.fine("Process did not terminate within force kill timeout"); + } + } + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + LOG.log(Level.FINE, "Interrupted while killing process", e); + } catch (Exception e) { + LOG.log(Level.FINE, "Error killing process", e); + } + } + + /** + * Creates a new Copilot session with the specified configuration. + *

+ * The session maintains conversation state and can be used to send messages and + * receive responses. Remember to close the session when done. + *

+ * A permission handler is required when creating a session. Use + * {@link com.github.copilot.rpc.PermissionHandler#APPROVE_ALL} to approve all + * permission requests, or provide a custom handler to control permissions + * selectively. + * + *

+ * Example: + * + * 

{@code
+     * var session = client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get();
+     * }
+ * + * @param config + * configuration for the session, including the required + * {@link SessionConfig#setOnPermissionRequest(com.github.copilot.rpc.PermissionHandler)} + * handler + * @return a future that resolves with the created CopilotSession + * @throws IllegalArgumentException + * if {@code config} is {@code null} or does not have a permission + * handler set + * @see SessionConfig + * @see com.github.copilot.rpc.PermissionHandler#APPROVE_ALL + */ + public CompletableFuture createSession(SessionConfig config) { + if (config == null || config.getOnPermissionRequest() == null) { + return CompletableFuture.failedFuture( + new IllegalArgumentException("An onPermissionRequest handler is required when creating a session. " + + "For example, to allow all permissions, use: " + + "new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); + } + return ensureConnected().thenCompose(connection -> { + long totalNanos = System.nanoTime(); + // For cloud sessions, let the CLI/server assign the session id + // and register the session lazily once the response arrives. For + // non-cloud sessions we generate the id client-side (when the + // caller didn't supply one) so the session can be registered + // BEFORE the RPC — the CLI may issue session-scoped requests + // (e.g. sessionFs.writeFile for workspace metadata) during + // session.create processing, before it has sent the response. + String callerSessionId = config.getSessionId(); + boolean useServerGeneratedId = config.getCloud() != null + && (callerSessionId == null || callerSessionId.isEmpty()); + String localSessionId = useServerGeneratedId + ? null + : (callerSessionId != null && !callerSessionId.isEmpty() + ? callerSessionId + : java.util.UUID.randomUUID().toString()); + + // Extract transform callbacks from the system message config. Callbacks + // are registered with the session; a wire-safe copy of the system + // message (with transform sections replaced by action="transform") is + // used in the RPC request. + var extracted = SessionRequestBuilder.extractTransformCallbacks(config.getSystemMessage()); + + // Creates the session, wires up handlers, and registers it in the + // sessions map. + java.util.function.Function initializeSession = sid -> { + long setupNanos = System.nanoTime(); + var s = new CopilotSession(sid, connection.rpc); + s.setExecutor(executor); + SessionRequestBuilder.configureSession(s, config); + if (extracted.transformCallbacks() != null) { + s.registerTransformCallbacks(extracted.transformCallbacks()); + } + sessions.put(sid, s); + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.createSession local setup complete. Elapsed={Elapsed}, SessionId=" + sid, + setupNanos); + return s; + }; + + String[] registeredIdHolder = new String[1]; + CopilotSession[] preRegisteredSessionHolder = new CopilotSession[1]; + + // Pre-register non-cloud sessions BEFORE issuing the RPC so any + // session-scoped requests the CLI emits during session.create + // processing can be routed to the correct handlers. + if (localSessionId != null) { + preRegisteredSessionHolder[0] = initializeSession.apply(localSessionId); + registeredIdHolder[0] = localSessionId; + } + + var request = SessionRequestBuilder.buildCreateRequest(config, localSessionId, options.getMode()); + if (extracted.wireSystemMessage() != config.getSystemMessage()) { + request.setSystemMessage(extracted.wireSystemMessage()); + } + + // Opt this session into GitHub telemetry forwarding when a + // connection-level handler is registered (mirrors the runtime's + // hand-written capability flag, not part of the codegen'd contract). + if (options.getOnGitHubTelemetry() != null) { + request.setEnableGitHubTelemetryForwarding(true); + } + + // Empty mode: validate availableTools and set toolFilterPrecedence + if (options.getMode() == CopilotClientMode.EMPTY) { + if (config.getAvailableTools() == null) { + if (registeredIdHolder[0] != null) { + sessions.remove(registeredIdHolder[0]); + } + throw new IllegalArgumentException( + "CopilotClient is in Mode = EMPTY but the session config did not specify " + + "availableTools. Empty mode requires every session to explicitly opt into " + + "the tools it wants — e.g. setAvailableTools(new ToolSet().addBuiltIn(BuiltInTools.ISOLATED))."); + } + request.setToolFilterPrecedence("excluded"); + if (request.getSkipEmbeddingRetrieval() == null) { + request.setSkipEmbeddingRetrieval(true); + } + if (request.getEmbeddingCacheStorage() == null) { + request.setEmbeddingCacheStorage("in-memory"); + } + if (request.getEnableOnDemandInstructionDiscovery() == null) { + request.setEnableOnDemandInstructionDiscovery(false); + } + if (request.getEnableFileHooks() == null) { + request.setEnableFileHooks(false); + } + if (request.getEnableHostGitOperations() == null) { + request.setEnableHostGitOperations(false); + } + if (request.getEnableSessionStore() == null) { + request.setEnableSessionStore(false); + } + if (request.getEnableSkills() == null) { + request.setEnableSkills(false); + } + if (request.getMemory() == null) { + request.setMemory(new MemoryConfiguration().setEnabled(false)); + } + if (request.getMcpOAuthTokenStorage() == null) { + request.setMcpOAuthTokenStorage("in-memory"); + } + } + + long rpcNanos = System.nanoTime(); + return connection.rpc.invoke("session.create", request, CreateSessionResponse.class) + .thenCompose(response -> { + String returnedId = response.sessionId(); + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.createSession session creation request completed. Elapsed={Elapsed}, SessionId=" + + (returnedId != null ? returnedId : localSessionId), + rpcNanos); + if (returnedId == null || returnedId.isEmpty()) { + throw new RuntimeException("session.create response did not include a sessionId"); + } + if (localSessionId != null && !localSessionId.equals(returnedId)) { + throw new RuntimeException("session.create returned sessionId " + returnedId + + " but the caller requested " + localSessionId); + } + CopilotSession session = preRegisteredSessionHolder[0] != null + ? preRegisteredSessionHolder[0] + : initializeSession.apply(returnedId); + registeredIdHolder[0] = returnedId; + CompletableFuture interest = config.getOnMcpAuthRequest() != null + ? session.getRpc().eventLog.registerInterest( + new SessionEventLogRegisterInterestParams(returnedId, "mcp.oauth_required")) + : CompletableFuture.completedFuture(null); + session.setWorkspacePath(response.workspacePath()); + session.setCapabilities(response.capabilities()); + session.setOpenCanvases(response.openCanvases()); + + return interest.thenCompose(interestResult -> { + logMcpAuthInterestRegistration(interestResult); + return updateSessionOptionsForMode(session, config.getSkipCustomInstructions().orElse(null), + config.getCustomAgentsLocalOnly().orElse(null), + config.getCoauthorEnabled().orElse(null), + config.getManageScheduleEnabled().orElse(null)); + }).thenApply(v -> { + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.createSession complete. Elapsed={Elapsed}, SessionId=" + + session.getSessionId(), + totalNanos); + return session; + }); + }).exceptionally(ex -> { + if (registeredIdHolder[0] != null) { + sessions.remove(registeredIdHolder[0]); + } + LoggingHelpers.logTiming(LOG, Level.WARNING, ex, + "CopilotClient.createSession failed. Elapsed={Elapsed}, SessionId=" + + (registeredIdHolder[0] != null ? registeredIdHolder[0] : ""), + totalNanos); + throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); + }); + }); + } + + private static void logMcpAuthInterestRegistration(Object interestResult) { + if (interestResult != null && LOG.isLoggable(Level.FINEST)) { + LOG.finest("MCP OAuth event interest registered"); + } + } + + /** + * Resumes an existing Copilot session. + *

+ * This restores a previously saved session, allowing you to continue a + * conversation. The session's history is preserved. + *

+ * A permission handler is required when resuming a session. Use + * {@link com.github.copilot.rpc.PermissionHandler#APPROVE_ALL} to approve all + * permission requests, or provide a custom handler to control permissions + * selectively. + * + * @param sessionId + * the ID of the session to resume + * @param config + * configuration for the resumed session, including the required + * {@link ResumeSessionConfig#setOnPermissionRequest(com.github.copilot.rpc.PermissionHandler)} + * handler + * @return a future that resolves with the resumed CopilotSession + * @throws IllegalArgumentException + * if {@code config} is {@code null} or does not have a permission + * handler set + * @see #listSessions() + * @see #getLastSessionId() + * @see com.github.copilot.rpc.PermissionHandler#APPROVE_ALL + */ + public CompletableFuture resumeSession(String sessionId, ResumeSessionConfig config) { + if (config == null || config.getOnPermissionRequest() == null) { + return CompletableFuture.failedFuture( + new IllegalArgumentException("An onPermissionRequest handler is required when resuming a session. " + + "For example, to allow all permissions, use: " + + "new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); + } + return ensureConnected().thenCompose(connection -> { + long totalNanos = System.nanoTime(); + // Register the session before the RPC call to avoid missing early events. + long setupNanos = System.nanoTime(); + var session = new CopilotSession(sessionId, connection.rpc); + session.setExecutor(executor); + SessionRequestBuilder.configureSession(session, config); + sessions.put(sessionId, session); + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.resumeSession local setup complete. Elapsed={Elapsed}, SessionId=" + sessionId, + setupNanos); + + // Extract transform callbacks from the system message config. + var extracted = SessionRequestBuilder.extractTransformCallbacks(config.getSystemMessage()); + if (extracted.transformCallbacks() != null) { + session.registerTransformCallbacks(extracted.transformCallbacks()); + } + var request = SessionRequestBuilder.buildResumeRequest(sessionId, config, options.getMode()); + if (extracted.wireSystemMessage() != config.getSystemMessage()) { + request.setSystemMessage(extracted.wireSystemMessage()); + } + + // Opt this session into GitHub telemetry forwarding when a + // connection-level handler is registered (mirrors the runtime's + // hand-written capability flag, not part of the codegen'd contract). + if (options.getOnGitHubTelemetry() != null) { + request.setEnableGitHubTelemetryForwarding(true); + } + + // Empty mode: validate availableTools and set toolFilterPrecedence for resume + // path + if (options.getMode() == CopilotClientMode.EMPTY) { + if (config.getAvailableTools() == null) { + throw new IllegalArgumentException( + "CopilotClient is in Mode = EMPTY but the resume session config did not specify " + + "availableTools. Empty mode requires every session to explicitly opt into " + + "the tools it wants — e.g. setAvailableTools(new ToolSet().addBuiltIn(BuiltInTools.ISOLATED))."); + } + request.setToolFilterPrecedence("excluded"); + if (request.getSkipEmbeddingRetrieval() == null) { + request.setSkipEmbeddingRetrieval(true); + } + if (request.getEmbeddingCacheStorage() == null) { + request.setEmbeddingCacheStorage("in-memory"); + } + if (request.getEnableOnDemandInstructionDiscovery() == null) { + request.setEnableOnDemandInstructionDiscovery(false); + } + if (request.getEnableFileHooks() == null) { + request.setEnableFileHooks(false); + } + if (request.getEnableHostGitOperations() == null) { + request.setEnableHostGitOperations(false); + } + if (request.getEnableSessionStore() == null) { + request.setEnableSessionStore(false); + } + if (request.getEnableSkills() == null) { + request.setEnableSkills(false); + } + if (request.getMemory() == null) { + request.setMemory(new MemoryConfiguration().setEnabled(false)); + } + if (request.getMcpOAuthTokenStorage() == null) { + request.setMcpOAuthTokenStorage("in-memory"); + } + } + + long rpcNanos = System.nanoTime(); + return connection.rpc.invoke("session.resume", request, ResumeSessionResponse.class) + .thenCompose(response -> { + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.resumeSession session resume request completed. Elapsed={Elapsed}, SessionId=" + + sessionId, + rpcNanos); + String returnedId = response.sessionId(); + String interestSessionId = returnedId != null ? returnedId : sessionId; + CompletableFuture interest = config.getOnMcpAuthRequest() != null + ? session.getRpc().eventLog.registerInterest(new SessionEventLogRegisterInterestParams( + interestSessionId, "mcp.oauth_required")) + : CompletableFuture.completedFuture(null); + return interest.thenApply(interestResult -> { + logMcpAuthInterestRegistration(interestResult); + return response; + }); + }).thenCompose(response -> { + session.setWorkspacePath(response.workspacePath()); + session.setCapabilities(response.capabilities()); + session.setOpenCanvases(response.openCanvases()); + // If the server returned a different sessionId than what was requested, + // re-key. + String returnedId = response.sessionId(); + if (returnedId != null && !returnedId.equals(sessionId)) { + sessions.remove(sessionId); + session.setActiveSessionId(returnedId); + sessions.put(returnedId, session); + } + + return updateSessionOptionsForMode(session, config.getSkipCustomInstructions().orElse(null), + config.getCustomAgentsLocalOnly().orElse(null), + config.getCoauthorEnabled().orElse(null), + config.getManageScheduleEnabled().orElse(null)).thenApply(v -> { + LoggingHelpers.logTiming(LOG, Level.FINE, + "CopilotClient.resumeSession complete. Elapsed={Elapsed}, SessionId=" + + sessionId, + totalNanos); + return session; + }); + }).exceptionally(ex -> { + sessions.remove(sessionId); + // Also remove the re-keyed entry if the server returned a different ID + String activeId = session.getSessionId(); + if (!sessionId.equals(activeId)) { + sessions.remove(activeId); + } + LoggingHelpers.logTiming(LOG, Level.WARNING, ex, + "CopilotClient.resumeSession failed. Elapsed={Elapsed}, SessionId=" + sessionId, + totalNanos); + throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); + }); + }); + } + + /** + * Applies the post-create / post-resume {@code session.options.update} patch. + *

+ * In {@link CopilotClientMode#EMPTY EMPTY} mode this defaults the four + * overridable feature flags to safe values (caller values from the config win); + * {@code installedPlugins=[]} is unconditional under empty mode so apps that + * need plugins must switch modes. In {@link CopilotClientMode#COPILOT_CLI + * COPILOT_CLI} mode only explicitly-set fields are forwarded. + * + * @param session + * the session to patch + * @param skipCustomInstructions + * caller-supplied value, or {@code null} if not set + * @param customAgentsLocalOnly + * caller-supplied value, or {@code null} if not set + * @param coauthorEnabled + * caller-supplied value, or {@code null} if not set + * @param manageScheduleEnabled + * caller-supplied value, or {@code null} if not set + * @return a future that completes when the patch has been applied + */ + CompletableFuture updateSessionOptionsForMode(CopilotSession session, Boolean skipCustomInstructions, + Boolean customAgentsLocalOnly, Boolean coauthorEnabled, Boolean manageScheduleEnabled) { + + Boolean patchSkip = null; + Boolean patchAgents = null; + Boolean patchCoauthor = null; + Boolean patchSchedule = null; + List patchPlugins = null; + boolean hasAnyPatch = false; + + if (options.getMode() == CopilotClientMode.EMPTY) { + patchSkip = skipCustomInstructions != null ? skipCustomInstructions : true; + patchAgents = customAgentsLocalOnly != null ? customAgentsLocalOnly : true; + patchCoauthor = coauthorEnabled != null ? coauthorEnabled : false; + patchSchedule = manageScheduleEnabled != null ? manageScheduleEnabled : false; + patchPlugins = List.of(); + hasAnyPatch = true; + } else { + if (skipCustomInstructions != null) { + patchSkip = skipCustomInstructions; + hasAnyPatch = true; + } + if (customAgentsLocalOnly != null) { + patchAgents = customAgentsLocalOnly; + hasAnyPatch = true; + } + if (coauthorEnabled != null) { + patchCoauthor = coauthorEnabled; + hasAnyPatch = true; + } + if (manageScheduleEnabled != null) { + patchSchedule = manageScheduleEnabled; + hasAnyPatch = true; + } + } + + if (!hasAnyPatch) { + return CompletableFuture.completedFuture(null); + } + + var params = new SessionOptionsUpdateParams(null, // sessionId - set by SessionOptionsApi + null, // model + null, // modelCapabilitiesOverrides + null, // reasoningEffort + null, // reasoningSummary + null, // verbosity + null, // clientName + null, // lspClientName + null, // integrationId + null, // featureFlags + null, // isExperimentalMode + null, // provider + null, // capi + null, // workingDirectory + null, // availableTools + null, // excludedTools + null, // includedBuiltinAgents + null, // excludedBuiltinAgents + null, // toolFilterPrecedence + null, // enableScriptSafety + null, // shell + null, // shellInitProfile + null, // shellProcessFlags + null, // sandboxConfig + null, // logInteractiveShells + null, // envValueMode + null, // allowAllMcpServerInstructions + null, // skillDirectories + null, // disabledSkills + null, // enableOnDemandInstructionDiscovery + null, // maxInlineBinaryBytes + patchPlugins, // installedPlugins + patchAgents, // customAgentsLocalOnly + null, // suppressCustomAgentPrompt + patchSkip, // skipCustomInstructions + null, // disabledInstructionSources + patchCoauthor, // coauthorEnabled + null, // trajectoryFile + null, // enableStreaming + null, // copilotUrl + null, // askUserDisabled + null, // continueOnAutoMode + null, // runningInInteractiveMode + null, // enableReasoningSummaries + null, // agentContext + null, // eventsLogDirectory + null, // eventsLogIncludesSubagents + null, // additionalContentExclusionPolicies + patchSchedule, // manageScheduleEnabled + null, // sessionCapabilities + null, // skipEmbeddingRetrieval + null, // organizationCustomInstructions + null, // enableFileHooks + null, // enableHostGitOperations + null, // enableSessionStore + null, // enableSkills + null, // contextTier + null // sessionLimits + ); + + return session.getRpc().options.update(params).thenCompose(result -> { + LOG.fine("session.options.update applied for session " + session.getSessionId()); + return CompletableFuture.completedFuture(null); + }).exceptionally(ex -> { + // The runtime session exists but the post-create options patch failed. + // Best-effort disconnect so we don't leak it (in empty mode it would + // otherwise stay alive with permissive defaults). + LOG.log(Level.WARNING, "session.options.update failed for session " + session.getSessionId(), ex); + sessions.remove(session.getSessionId()); + try { + session.close(); + } catch (Exception closeEx) { + // Swallow: original error is the one the caller needs. + } + throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); + }); + } + + /** + * Gets the current connection state. + * + * @return the current connection state + * @see ConnectionState + */ + public ConnectionState getState() { + if (connectionFuture == null) + return ConnectionState.DISCONNECTED; + if (connectionFuture.isCompletedExceptionally()) + return ConnectionState.ERROR; + if (!connectionFuture.isDone()) + return ConnectionState.CONNECTING; + return ConnectionState.CONNECTED; + } + + /** + * Returns the typed RPC client for server-level methods. + *

+ * Provides strongly-typed access to all server-level API namespaces such as + * {@code models}, {@code tools}, {@code account}, and {@code mcp}. + *

+ * Example usage: + * + * 

{@code
+     * client.start().get();
+     * var models = client.getRpc().models.list().get();
+     * }
+ * + * @return the server-level typed RPC client + * @throws IllegalStateException + * if the client is not connected; call {@link #start()} first + * @since 1.0.0 + */ + public ServerRpc getRpc() { + CompletableFuture future = connectionFuture; + if (future == null || !future.isDone() || future.isCompletedExceptionally()) { + throw new IllegalStateException("Client not connected; call start() first"); + } + return future.join().serverRpc(); + } + + /** + * Pings the server to check connectivity. + *

+ * This can be used to verify that the server is responsive and to check the + * protocol version. + * + * @param message + * an optional message to echo back + * @return a future that resolves with the ping response + * @see PingResponse + */ + public CompletableFuture ping(String message) { + return ensureConnected().thenCompose(connection -> connection.rpc.invoke("ping", + Map.of("message", message != null ? message : ""), PingResponse.class)); + } + + /** + * Gets CLI status including version and protocol information. + * + * @return a future that resolves with the status response containing version + * and protocol version + * @see GetStatusResponse + */ + public CompletableFuture getStatus() { + return ensureConnected() + .thenCompose(connection -> connection.rpc.invoke("status.get", Map.of(), GetStatusResponse.class)); + } + + /** + * Gets current authentication status. + * + * @return a future that resolves with the authentication status + * @see GetAuthStatusResponse + */ + public CompletableFuture getAuthStatus() { + return ensureConnected().thenCompose( + connection -> connection.rpc.invoke("auth.getStatus", Map.of(), GetAuthStatusResponse.class)); + } + + /** + * Lists available models with their metadata. + *

+ * Results are cached after the first successful call to avoid rate limiting. + * The cache is cleared when the client disconnects. + *

+ * If an {@code onListModels} handler was provided in + * {@link com.github.copilot.rpc.CopilotClientOptions}, it is called instead of + * querying the CLI server. This is useful in BYOK mode. + * + * @return a future that resolves with a list of available models + * @see ModelInfo + */ + public CompletableFuture> listModels() { + // Check cache first + List cached = modelsCache; + if (cached != null) { + return CompletableFuture.completedFuture(new ArrayList<>(cached)); + } + + // If a custom handler is configured, use it instead of querying the CLI server + var onListModels = options.getOnListModels(); + if (onListModels != null) { + synchronized (modelsCacheLock) { + if (modelsCache != null) { + return CompletableFuture.completedFuture(new ArrayList<>(modelsCache)); + } + } + return onListModels.get().thenApply(models -> { + synchronized (modelsCacheLock) { + modelsCache = models; + } + return new ArrayList<>(models); + }); + } + + return ensureConnected().thenCompose(connection -> { + // Double-check cache inside lock + synchronized (modelsCacheLock) { + if (modelsCache != null) { + return CompletableFuture.completedFuture(new ArrayList<>(modelsCache)); + } + } + + return connection.rpc.invoke("models.list", Map.of(), GetModelsResponse.class).thenApply(response -> { + List models = response.getModels(); + synchronized (modelsCacheLock) { + modelsCache = models; + } + return new ArrayList<>(models); // Return a copy to prevent cache mutation + }); + }); + } + + /** + * Gets the ID of the most recently used session. + *

+ * This is useful for resuming the last conversation without needing to list all + * sessions. + * + * @return a future that resolves with the last session ID, or {@code null} if + * no sessions exist + * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) + */ + public CompletableFuture getLastSessionId() { + return ensureConnected().thenCompose( + connection -> connection.rpc.invoke("session.getLastId", Map.of(), GetLastSessionIdResponse.class) + .thenApply(GetLastSessionIdResponse::sessionId)); + } + + /** + * Permanently deletes a session and all its data from disk, including + * conversation history, planning state, and artifacts. + *

+ * Unlike {@link CopilotSession#close()}, which only releases in-memory + * resources and preserves session data for later resumption, this method is + * irreversible. The session cannot be resumed after deletion. + * + * @param sessionId + * the ID of the session to delete + * @return a future that completes when the session is deleted + * @throws RuntimeException + * if the deletion fails + */ + public CompletableFuture deleteSession(String sessionId) { + return ensureConnected().thenCompose(connection -> connection.rpc + .invoke("session.delete", Map.of("sessionId", sessionId), DeleteSessionResponse.class) + .thenAccept(response -> { + if (!response.success()) { + throw new RuntimeException("Failed to delete session " + sessionId + ": " + response.error()); + } + sessions.remove(sessionId); + })); + } + + /** + * Lists all available sessions. + *

+ * Returns metadata about all sessions that can be resumed, including their IDs, + * start times, and summaries. + * + * @return a future that resolves with a list of session metadata + * @see SessionMetadata + * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) + */ + public CompletableFuture> listSessions() { + return listSessions(null); + } + + /** + * Lists all available sessions with optional filtering. + *

+ * Returns metadata about all sessions that can be resumed, including their IDs, + * start times, summaries, and context information. Use the filter parameter to + * narrow down sessions by working directory, git repository, or branch. + * + *

Example Usage

+ * + * 
{@code
+     * // List all sessions
+     * var allSessions = client.listSessions().get();
+     *
+     * // Filter by repository
+     * var filter = new SessionListFilter().setRepository("owner/repo");
+     * var repoSessions = client.listSessions(filter).get();
+     * }
+ * + * @param filter + * optional filter to narrow down sessions by context fields, or + * {@code null} to list all sessions + * @return a future that resolves with a list of session metadata + * @see SessionMetadata + * @see SessionListFilter + * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) + */ + public CompletableFuture> listSessions(SessionListFilter filter) { + return ensureConnected().thenCompose(connection -> { + Map params = filter != null ? Map.of("filter", filter) : Map.of(); + return connection.rpc.invoke("session.list", params, ListSessionsResponse.class) + .thenApply(ListSessionsResponse::sessions); + }); + } + + /** + * Gets metadata for a specific session by ID. + *

+ * This provides an efficient O(1) lookup of a single session's metadata instead + * of listing all sessions. + * + *

Example Usage

+ * + * 
{@code
+     * var metadata = client.getSessionMetadata("session-123").get();
+     * if (metadata != null) {
+     * 	System.out.println("Session started at: " + metadata.getStartTime());
+     * }
+     * }
+ * + * @param sessionId + * the ID of the session to look up + * @return a future that resolves with the {@link SessionMetadata}, or + * {@code null} if the session was not found + * @see SessionMetadata + * @since 1.0.0 + */ + public CompletableFuture getSessionMetadata(String sessionId) { + return ensureConnected().thenCompose(connection -> connection.rpc + .invoke("session.getMetadata", Map.of("sessionId", sessionId), GetSessionMetadataResponse.class) + .thenApply(GetSessionMetadataResponse::session)); + } + + /** + * Gets the ID of the session currently displayed in the TUI. + *

+ * This is only available when connecting to a server running in TUI+server mode + * (--ui-server). + * + * @return a future that resolves with the session ID, or null if no foreground + * session is set + */ + public CompletableFuture getForegroundSessionId() { + return ensureConnected().thenCompose(connection -> connection.rpc + .invoke("session.getForeground", Map.of(), com.github.copilot.rpc.GetForegroundSessionResponse.class) + .thenApply(com.github.copilot.rpc.GetForegroundSessionResponse::sessionId)); + } + + /** + * Requests the TUI to switch to displaying the specified session. + *

+ * This is only available when connecting to a server running in TUI+server mode + * (--ui-server). + * + * @param sessionId + * the ID of the session to display in the TUI + * @return a future that completes when the operation is done + * @throws RuntimeException + * if the operation fails + */ + public CompletableFuture setForegroundSessionId(String sessionId) { + return ensureConnected().thenCompose(connection -> connection.rpc + .invoke("session.setForeground", new com.github.copilot.rpc.SetForegroundSessionRequest(sessionId), + com.github.copilot.rpc.SetForegroundSessionResponse.class) + .thenAccept(response -> { + if (!response.success()) { + throw new RuntimeException( + response.error() != null ? response.error() : "Failed to set foreground session"); + } + })); + } + + /** + * Subscribes to all session lifecycle events. + *

+ * Lifecycle events are emitted when sessions are created, deleted, updated, or + * change foreground/background state (in TUI+server mode). + * + * @param handler + * a callback that receives lifecycle events + * @return an AutoCloseable that, when closed, unsubscribes the handler + */ + public AutoCloseable onLifecycle(SessionLifecycleHandler handler) { + return lifecycleManager.subscribe(handler); + } + + /** + * Subscribes to a specific session lifecycle event type. + * + * @param eventType + * the event type to listen for (use + * {@link com.github.copilot.rpc.SessionLifecycleEventTypes} + * constants) + * @param handler + * a callback that receives events of the specified type + * @return an AutoCloseable that, when closed, unsubscribes the handler + */ + public AutoCloseable onLifecycle(String eventType, SessionLifecycleHandler handler) { + return lifecycleManager.subscribe(eventType, handler); + } + + private CompletableFuture ensureConnected() { + if (connectionFuture == null && !options.isAutoStart()) { + throw new IllegalStateException("Client not connected. Call start() first."); + } + + start(); + return connectionFuture; + } + + /** + * Closes this client using graceful shutdown semantics. + *

+ * This method is intended for {@code try-with-resources} usage and blocks while + * waiting for {@link #stop()} to complete, up to + * {@link #AUTOCLOSEABLE_TIMEOUT_SECONDS} seconds. If shutdown fails or times + * out, the error is logged at {@link Level#FINE} and the method returns. + *

+ * This method is idempotent. + * + * @see #stop() + * @see #forceStop() + * @see #AUTOCLOSEABLE_TIMEOUT_SECONDS + */ + @Override + public void close() { + if (disposed) + return; + disposed = true; + try { + stop().get(AUTOCLOSEABLE_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (Exception e) { + LOG.log(Level.FINE, "Error during close", e); + } finally { + shutdownOwnedExecutor(); + if (closeHook != null) { + closeHook.run(); + } + } + } + + private void shutdownOwnedExecutor() { + if (!executorCanBeShutdown) { + return; + } + + ExecutorService serviceToShutdown = executor instanceof ExecutorService es ? es : null; + if (serviceToShutdown == null) { + LOG.log(Level.FINE, "Executor is not an ExecutorService; skipping shutdown"); + return; + } + + // Short-circuit when the owned executor is already shut down. close() and + // forceStop() can each call this method (e.g. forceStop() invoked before a + // subsequent close() in user code), and re-entering shutdown() + + // awaitTermination() + // is redundant. Logging at FINE aids diagnostics without spamming normal + // output. + if (serviceToShutdown.isShutdown()) { + LOG.log(Level.FINE, "Owned executor was already shut down; skipping redundant shutdown call."); + return; + } + + serviceToShutdown.shutdown(); + try { + if (!serviceToShutdown.awaitTermination(AUTOCLOSEABLE_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + LOG.log(Level.FINE, "Owned executor did not terminate within {0} seconds; forcing shutdown.", + AUTOCLOSEABLE_TIMEOUT_SECONDS); + serviceToShutdown.shutdownNow(); + } + } catch (InterruptedException e) { + serviceToShutdown.shutdownNow(); + Thread.currentThread().interrupt(); + LOG.log(Level.FINE, "Interrupted while waiting for owned executor to terminate", e); + } + } + + private static record Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc, + AutoCloseable runtimeHost) { + }; + +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotExperimental.java b/java/sdk/src/main/java/com/github/copilot/CopilotExperimental.java new file mode 100644 index 000000000..f798692f9 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotExperimental.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marks a type or method as experimental. Experimental APIs may change or be + * removed in future versions without notice. + * + *

+ * By default, referencing an experimental API from consumer code causes a + * compile-time error. To opt in, either annotate the consuming declaration with + * {@link AllowCopilotExperimental} or pass the compiler option: + * + * 

+ * -Acopilot.experimental.allowed=true
+ *
+ * + * @since 1.0.0 + */ +@Documented +@Retention(RetentionPolicy.CLASS) +@Target({ElementType.TYPE, ElementType.METHOD}) +public @interface CopilotExperimental { +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java b/java/sdk/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java new file mode 100644 index 000000000..26ec555d1 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotExperimentalProcessor.java @@ -0,0 +1,164 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.Messager; +import javax.annotation.processing.ProcessingEnvironment; +import javax.annotation.processing.RoundEnvironment; +import javax.annotation.processing.SupportedAnnotationTypes; +import javax.annotation.processing.SupportedOptions; +import javax.annotation.processing.SupportedSourceVersion; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.Element; +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.TypeElement; +import javax.lang.model.element.VariableElement; +import javax.lang.model.type.DeclaredType; +import javax.lang.model.type.TypeMirror; +import javax.tools.Diagnostic; +import java.util.Set; + +/** + * Annotation processor that enforces compile-time gating of experimental APIs. + * + *

+ * Any declaration-level reference to a type or method annotated with + * {@link CopilotExperimental} in consumer source code causes a compilation + * error unless the compiler option {@code -Acopilot.experimental.allowed=true} + * is provided or the consuming declaration is annotated with + * {@link AllowCopilotExperimental}. + * + *

+ * This processor uses only standard JSR 269 APIs ({@code javax.lang.model.*}) + * and works with any Java compiler (javac, ECJ, etc.). It checks declarations + * (field types, method parameters, return types, supertypes, thrown types) but + * does not inspect method body expressions. + * + * @since 1.0.0 + */ +@SupportedAnnotationTypes("*") +@SupportedOptions("copilot.experimental.allowed") +@SupportedSourceVersion(SourceVersion.RELEASE_17) +public class CopilotExperimentalProcessor extends AbstractProcessor { + + private boolean allowed; + + @Override + public synchronized void init(ProcessingEnvironment processingEnv) { + super.init(processingEnv); + String value = processingEnv.getOptions().get("copilot.experimental.allowed"); + this.allowed = "true".equals(value); + } + + @Override + public boolean process(Set annotations, RoundEnvironment roundEnv) { + if (allowed) { + return false; + } + for (Element rootElement : roundEnv.getRootElements()) { + checkElement(rootElement); + } + return false; + } + + private void checkElement(Element element) { + // Skip elements that are themselves annotated @CopilotExperimental + // (they are the definitions, not consumers), or that explicitly opt in. + if (isExperimental(element) || isAllowListed(element)) { + return; + } + + switch (element.getKind()) { + case CLASS, INTERFACE, ENUM, RECORD -> checkTypeElement((TypeElement) element); + case METHOD, CONSTRUCTOR -> checkExecutable((ExecutableElement) element); + case FIELD, ENUM_CONSTANT -> checkField((VariableElement) element); + default -> { + } + } + + // Recurse into enclosed elements + for (Element enclosed : element.getEnclosedElements()) { + checkElement(enclosed); + } + } + + private void checkTypeElement(TypeElement typeElement) { + // Check superclass + TypeMirror superclass = typeElement.getSuperclass(); + checkTypeMirror(superclass, typeElement, "extends"); + + // Check implemented interfaces + for (TypeMirror iface : typeElement.getInterfaces()) { + checkTypeMirror(iface, typeElement, "implements"); + } + } + + private void checkExecutable(ExecutableElement method) { + // Check return type + checkTypeMirror(method.getReturnType(), method, "return type"); + + // Check parameter types + for (VariableElement param : method.getParameters()) { + checkTypeMirror(param.asType(), method, "parameter '" + param.getSimpleName() + "'"); + } + + // Check thrown types + for (TypeMirror thrown : method.getThrownTypes()) { + checkTypeMirror(thrown, method, "throws"); + } + } + + private void checkField(VariableElement field) { + checkTypeMirror(field.asType(), field, "field type"); + } + + private void checkTypeMirror(TypeMirror typeMirror, Element usageSite, String context) { + if (typeMirror == null) { + return; + } + if (typeMirror instanceof DeclaredType declaredType) { + Element typeElement = declaredType.asElement(); + if (isExperimental(typeElement)) { + reportError(typeElement, usageSite, context); + } + // Check type arguments (generics) + for (TypeMirror typeArg : declaredType.getTypeArguments()) { + checkTypeMirror(typeArg, usageSite, context); + } + } + } + + private boolean isExperimental(Element element) { + if (element == null) { + return false; + } + if (element.getAnnotation(CopilotExperimental.class) != null) { + return true; + } + // If the enclosing type is experimental, members are implicitly experimental + Element enclosing = element.getEnclosingElement(); + return enclosing != null && enclosing.getAnnotation(CopilotExperimental.class) != null; + } + + private boolean isAllowListed(Element element) { + Element current = element; + while (current != null) { + if (current.getAnnotation(AllowCopilotExperimental.class) != null) { + return true; + } + current = current.getEnclosingElement(); + } + return false; + } + + private void reportError(Element experimentalElement, Element usageSite, String context) { + Messager messager = processingEnv.getMessager(); + messager.printMessage(Diagnostic.Kind.ERROR, "Use of experimental API '" + experimentalElement.getSimpleName() + + "' in " + context + + " is not allowed. Add @AllowCopilotExperimental or compiler option -Acopilot.experimental.allowed=true to opt in.", + usageSite); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotRequestContext.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestContext.java new file mode 100644 index 000000000..610fb56c6 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotRequestContext.java @@ -0,0 +1,193 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +import edu.umd.cs.findbugs.annotations.Nullable; + +/** + * The per-request context handed to every {@link CopilotRequestHandler} hook. + * It exposes the routing and cancellation details of a single intercepted + * request so overrides can observe or rewrite it. + * + * @since 1.0.0 + */ +public final class CopilotRequestContext { + + private final String requestId; + @Nullable + private final String sessionId; + @Nullable + private final String agentId; + @Nullable + private final String parentAgentId; + @Nullable + private final String interactionType; + private final CopilotRequestTransport transport; + private final String url; + private final Map> headers; + private final CompletableFuture cancellation; + + private LlmWebSocketResponseBridge webSocketResponse; + + CopilotRequestContext(String requestId, @Nullable String sessionId, @Nullable String agentId, + @Nullable String parentAgentId, @Nullable String interactionType, CopilotRequestTransport transport, + String url, Map> headers, CompletableFuture cancellation) { + this.requestId = requestId; + this.sessionId = sessionId; + this.agentId = agentId; + this.parentAgentId = parentAgentId; + this.interactionType = interactionType; + this.transport = transport; + this.url = url; + this.headers = headers; + this.cancellation = cancellation; + } + + private CopilotRequestContext(String requestId, @Nullable String sessionId, @Nullable String agentId, + @Nullable String parentAgentId, @Nullable String interactionType, CopilotRequestTransport transport, + String url, Map> headers, CompletableFuture cancellation, + LlmWebSocketResponseBridge webSocketResponse) { + this(requestId, sessionId, agentId, parentAgentId, interactionType, transport, url, headers, cancellation); + this.webSocketResponse = webSocketResponse; + } + + /** + * Gets the opaque runtime-minted request id, stable across the request + * lifecycle. + * + * @return the request id + */ + public String requestId() { + return requestId; + } + + /** + * Gets the id of the runtime session that triggered this request, or + * {@code null} when the request was issued outside any session (for example the + * startup model catalog). + * + * @return the session id, or {@code null} + */ + @Nullable + public String sessionId() { + return sessionId; + } + + /** + * Gets the stable per-agent-instance id for the agent trajectory that issued + * this request, or {@code null} when no agent is in scope. + * + * @return the agent id, or {@code null} + */ + @Nullable + public String agentId() { + return agentId; + } + + /** + * Gets the id of the parent agent when this request was issued by a subagent, + * or {@code null} for root-agent and non-agent requests. + * + * @return the parent agent id, or {@code null} + */ + @Nullable + public String parentAgentId() { + return parentAgentId; + } + + /** + * Gets the runtime classification for the interaction that produced this + * request, or {@code null} when the runtime did not classify it. + * + * @return the interaction type, or {@code null} + */ + @Nullable + public String interactionType() { + return interactionType; + } + + /** + * Gets the transport the runtime would otherwise use. + * + * @return the transport + */ + public CopilotRequestTransport transport() { + return transport; + } + + /** + * Gets the absolute request URL. + * + * @return the URL + */ + public String url() { + return url; + } + + /** + * Gets the request headers, multi-valued. + * + * @return the headers (never {@code null}) + */ + public Map> headers() { + return headers; + } + + /** + * Returns a copy of this context with a different request URL. + * + * @param url + * the replacement request URL + * @return the copied context + */ + public CopilotRequestContext withUrl(String url) { + return new CopilotRequestContext(requestId, sessionId, agentId, parentAgentId, interactionType, transport, url, + headers, cancellation, webSocketResponse); + } + + /** + * Returns a copy of this context with different request headers. + * + * @param headers + * the replacement request headers + * @return the copied context + */ + public CopilotRequestContext withHeaders(Map> headers) { + return new CopilotRequestContext(requestId, sessionId, agentId, parentAgentId, interactionType, transport, url, + headers, cancellation, webSocketResponse); + } + + /** + * A future that completes when the runtime cancels this in-flight request (for + * example because the agent turn was aborted upstream). Subclasses that issue + * their own I/O should pass it through so the upstream call is torn down too. + * + * @return the cancellation future + */ + public CompletableFuture cancellation() { + return cancellation; + } + + /** + * Whether the runtime has cancelled this in-flight request. + * + * @return {@code true} once the request has been cancelled + */ + public boolean isCancelled() { + return cancellation.isDone(); + } + + LlmWebSocketResponseBridge webSocketResponse() { + return webSocketResponse; + } + + void setWebSocketResponse(LlmWebSocketResponseBridge webSocketResponse) { + this.webSocketResponse = webSocketResponse; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotRequestHandler.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestHandler.java new file mode 100644 index 000000000..7b34b20e7 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotRequestHandler.java @@ -0,0 +1,227 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CancellationException; +import java.util.concurrent.CompletableFuture; + +/** + * The base class for SDK consumers who want to observe or replace the LLM + * inference requests the runtime issues (for both CAPI and BYOK providers). + *

+ * When set as the {@code requestHandler} on + * {@link com.github.copilot.rpc.CopilotClientOptions}, the runtime routes its + * model-layer HTTP and WebSocket traffic through this handler instead of + * issuing the calls itself. Subclass and override {@link #sendRequest} to + * mutate or replace HTTP calls, or {@link #openWebSocket} to mutate the + * handshake or return a fully custom {@link CopilotWebSocketHandler}. + * + * @since 1.0.0 + */ +public class CopilotRequestHandler { + + private static final Set FORBIDDEN_REQUEST_HEADERS = Set.of("host", "connection", "content-length", + "transfer-encoding", "keep-alive", "upgrade", "proxy-connection", "te", "trailer"); + + private static final HttpClient SHARED_HTTP_CLIENT = HttpClient.newBuilder() + .followRedirects(HttpClient.Redirect.NEVER).build(); + + private static final int RESPONSE_CHUNK_SIZE = 32 * 1024; + + static boolean isForbiddenRequestHeader(String name) { + String lower = name.toLowerCase(Locale.ROOT); + return FORBIDDEN_REQUEST_HEADERS.contains(lower) || lower.startsWith("sec-websocket-"); + } + + /** + * The {@link HttpClient} used to forward HTTP requests. Override to supply a + * custom client (proxy, TLS, timeouts). The default never follows redirects, so + * 3xx responses are forwarded verbatim. + * + * @return the HTTP client + */ + protected HttpClient httpClient() { + return SHARED_HTTP_CLIENT; + } + + /** + * Forwards an HTTP request and returns the upstream response. The default sends + * {@code request} through {@link #httpClient()} and cancels the in-flight call + * when the runtime cancels the request. Override to mutate the request before + * sending, post-process the response, or replace the call entirely. + * + * @param request + * the request built from the runtime's inference request + * @param ctx + * the per-request context + * @return the upstream response, with the body as an {@link InputStream} + * @throws Exception + * if the request could not be completed + */ + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext ctx) throws Exception { + CompletableFuture> future = httpClient().sendAsync(request, + HttpResponse.BodyHandlers.ofInputStream()); + ctx.cancellation().whenComplete((v, t) -> future.cancel(true)); + return future.get(); + } + + /** + * Returns a per-connection WebSocket handler for a WebSocket request. The + * default opens a transparent forwarding connection to the request URL. + * Override to mutate the handshake (via {@code ctx}) or return a fully custom + * handler. + * + * @param ctx + * the per-request context + * @return the WebSocket handler + * @throws Exception + * if the handler could not be created + */ + protected CopilotWebSocketHandler openWebSocket(CopilotRequestContext ctx) throws Exception { + return new CopilotWebSocketForwarder(ctx); + } + + /** + * Entry point invoked by the adapter once per intercepted request. Routes to + * the HTTP or WebSocket flow and drives the consumer's overridable hooks. + */ + void handle(LlmInferenceExchange exchange) throws Exception { + if (exchange.context().transport() == CopilotRequestTransport.WEBSOCKET) { + handleWebSocket(exchange); + } else { + handleHttp(exchange); + } + } + + private void handleHttp(LlmInferenceExchange exchange) throws Exception { + HttpRequest httpRequest = buildHttpRequest(exchange); + HttpResponse response = sendRequest(httpRequest, exchange.context()); + streamResponse(response, exchange); + } + + private static HttpRequest buildHttpRequest(LlmInferenceExchange exchange) throws InterruptedException { + CopilotRequestContext ctx = exchange.context(); + String method = exchange.method() == null ? "GET" : exchange.method().toUpperCase(Locale.ROOT); + boolean bodyless = method.equals("GET") || method.equals("HEAD"); + byte[] body = bodyless ? new byte[0] : exchange.drainBody(); + HttpRequest.BodyPublisher publisher = body.length > 0 + ? HttpRequest.BodyPublishers.ofByteArray(body) + : HttpRequest.BodyPublishers.noBody(); + + HttpRequest.Builder builder = HttpRequest.newBuilder().uri(URI.create(ctx.url())).method(method, publisher); + Map> headers = ctx.headers(); + if (headers != null) { + for (Map.Entry> entry : headers.entrySet()) { + if (isForbiddenRequestHeader(entry.getKey()) || entry.getValue() == null) { + continue; + } + for (String value : entry.getValue()) { + builder.header(entry.getKey(), value); + } + } + } + return builder.build(); + } + + private static void streamResponse(HttpResponse response, LlmInferenceExchange exchange) + throws IOException { + exchange.startResponse(response.statusCode(), null, response.headers().map()); + try (InputStream body = response.body()) { + byte[] buffer = new byte[RESPONSE_CHUNK_SIZE]; + int n; + while ((n = body.read(buffer)) != -1) { + if (n > 0) { + exchange.writeResponseBinary(buffer, 0, n); + } + } + } catch (IOException e) { + exchange.errorResponse(e.getMessage(), null); + return; + } + exchange.endResponse(); + } + + private void handleWebSocket(LlmInferenceExchange exchange) throws Exception { + CopilotRequestContext ctx = exchange.context(); + LlmWebSocketResponseBridge bridge = new LlmWebSocketResponseBridge(exchange); + ctx.setWebSocketResponse(bridge); + + CopilotWebSocketHandler handler = openWebSocket(ctx); + try { + handler.open(); + + // The runtime blocks the WebSocket connect until it receives the 101 + // response head (the upgrade acknowledgement) and only then begins + // forwarding inbound messages as request-body chunks. Emit it eagerly + // here — waiting for the first upstream message would deadlock, since the + // upstream stays silent until it receives a request message the runtime + // won't send before the upgrade completes. + bridge.start(); + + CompletableFuture pumpDone = new CompletableFuture<>(); + Thread pump = new Thread(() -> { + try { + LlmInferenceExchange.BodyFrame frame; + while ((frame = exchange.readFrame()) != null) { + handler.sendRequestMessage(new CopilotWebSocketMessage(frame.data(), frame.binary())); + } + pumpDone.complete(null); + } catch (Exception e) { + pumpDone.completeExceptionally(e); + } + }, "llm-ws-request-pump"); + pump.setDaemon(true); + pump.start(); + + CompletableFuture.anyOf(pumpDone, handler.completion()).handle((v, t) -> null).join(); + + if (pumpDone.isDone() && !handler.completion().isDone()) { + if (isPumpFault(pumpDone)) { + handler.suppressCloseOnDispose(); + awaitPump(pumpDone); + return; + } + handler.close(CopilotWebSocketCloseStatus.NORMAL_CLOSURE); + handler.completion().join(); + return; + } + + CopilotWebSocketCloseStatus status = handler.completion().join(); + if (status.error() != null) { + throw asException(status.error()); + } + } finally { + handler.close(); + } + } + + private static boolean isPumpFault(CompletableFuture pumpDone) { + return pumpDone.isCompletedExceptionally(); + } + + private static void awaitPump(CompletableFuture pumpDone) throws Exception { + try { + pumpDone.join(); + } catch (CancellationException e) { + throw e; + } catch (Exception e) { + throw asException(e.getCause() != null ? e.getCause() : e); + } + } + + private static Exception asException(Throwable t) { + return t instanceof Exception e ? e : new RuntimeException(t); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotRequestTransport.java b/java/sdk/src/main/java/com/github/copilot/CopilotRequestTransport.java new file mode 100644 index 000000000..e1069de0b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotRequestTransport.java @@ -0,0 +1,44 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +/** + * The transport the runtime would otherwise use to issue an intercepted + * model-layer request. + * + * @since 1.0.0 + */ +public enum CopilotRequestTransport { + + /** + * Plain HTTP or a streamed SSE response. Each request/response body chunk is an + * opaque byte range. + */ + HTTP, + + /** + * Full-duplex WebSocket channel. Each request-body chunk is one inbound + * WebSocket message and each response-body write is one outbound message. + */ + WEBSOCKET; + + /** The wire value for the plain HTTP and SSE transport. */ + static final String WIRE_HTTP = "http"; + + /** The wire value for the full-duplex WebSocket transport. */ + static final String WIRE_WEBSOCKET = "websocket"; + + /** + * Maps a wire transport string onto the enum, defaulting to {@link #HTTP} for + * {@code null} or any unrecognised value. + * + * @param wire + * the wire transport value + * @return the transport + */ + static CopilotRequestTransport fromWire(String wire) { + return WIRE_WEBSOCKET.equals(wire) ? WEBSOCKET : HTTP; + } +} diff --git a/java/src/main/java/com/github/copilot/CopilotSession.java b/java/sdk/src/main/java/com/github/copilot/CopilotSession.java similarity index 85% rename from java/src/main/java/com/github/copilot/CopilotSession.java rename to java/sdk/src/main/java/com/github/copilot/CopilotSession.java index 64c02d8b8..ca2adf462 100644 --- a/java/src/main/java/com/github/copilot/CopilotSession.java +++ b/java/sdk/src/main/java/com/github/copilot/CopilotSession.java @@ -33,6 +33,7 @@ import com.github.copilot.generated.rpc.SessionCommandsHandlePendingCommandParams; import com.github.copilot.generated.rpc.SessionLogParams; import com.github.copilot.generated.rpc.SessionLogLevel; +import com.github.copilot.generated.rpc.SessionMcpOauthHandlePendingRequestParams; import com.github.copilot.generated.rpc.ModelCapabilitiesOverride; import com.github.copilot.generated.rpc.ModelCapabilitiesOverrideLimits; import com.github.copilot.generated.rpc.ModelCapabilitiesOverrideSupports; @@ -49,10 +50,14 @@ import com.github.copilot.generated.CommandExecuteEvent; import com.github.copilot.generated.ElicitationRequestedEvent; import com.github.copilot.generated.ExternalToolRequestedEvent; +import com.github.copilot.generated.McpOauthRequiredEvent; import com.github.copilot.generated.PermissionRequestedEvent; +import com.github.copilot.generated.SessionCanvasClosedEvent; +import com.github.copilot.generated.SessionCanvasOpenedEvent; import com.github.copilot.generated.SessionErrorEvent; import com.github.copilot.generated.SessionEvent; import com.github.copilot.generated.SessionIdleEvent; +import com.github.copilot.generated.rpc.OpenCanvasInstance; import com.github.copilot.rpc.AgentInfo; import com.github.copilot.rpc.AutoModeSwitchHandler; import com.github.copilot.rpc.AutoModeSwitchInvocation; @@ -71,10 +76,16 @@ import com.github.copilot.rpc.ExitPlanModeRequest; import com.github.copilot.rpc.ExitPlanModeResult; import com.github.copilot.rpc.ElicitationSchema; +import com.github.copilot.rpc.BearerTokenProvider; import com.github.copilot.rpc.GetMessagesResponse; +import com.github.copilot.rpc.AgentStopHookInput; import com.github.copilot.rpc.HookInvocation; import com.github.copilot.rpc.InputOptions; import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.McpAuthHandler; +import com.github.copilot.rpc.McpAuthInvocation; +import com.github.copilot.rpc.McpAuthRequest; +import com.github.copilot.rpc.McpAuthResult; import com.github.copilot.rpc.PermissionHandler; import com.github.copilot.rpc.PermissionInvocation; import com.github.copilot.rpc.PermissionRequest; @@ -99,6 +110,7 @@ import com.github.copilot.rpc.UserInputRequest; import com.github.copilot.rpc.UserInputResponse; import com.github.copilot.rpc.UserPromptSubmittedHookInput; +import com.github.copilot.rpc.UserPromptTransformedHookInput; /** * Represents a single conversation session with the Copilot CLI. @@ -148,6 +160,13 @@ public final class CopilotSession implements AutoCloseable { private static final Logger LOG = Logger.getLogger(CopilotSession.class.getName()); private static final ObjectMapper MAPPER = JsonRpcClient.getObjectMapper(); + /** + * Fixed name of the runtime's built-in tool-search tool. A client can replace + * its behavior by registering a tool with this exact name and + * {@code overridesBuiltInTool} set to {@code true}. + */ + private static final String TOOL_SEARCH_TOOL_NAME = "tool_search_tool"; + /** * The current active session ID. Initialized to the pre-generated value and may * be updated after session.create / session.resume if the server returns a @@ -157,13 +176,18 @@ public final class CopilotSession implements AutoCloseable { private volatile String sessionId; private volatile String workspacePath; private volatile SessionCapabilities capabilities = new SessionCapabilities(); + private final Object openCanvasesLock = new Object(); + private final List openCanvases = new ArrayList<>(); private final SessionUiApi ui; private final JsonRpcClient rpc; private volatile SessionRpc sessionRpc; private final Set> eventHandlers = ConcurrentHashMap.newKeySet(); private final Map toolHandlers = new ConcurrentHashMap<>(); private final Map commandHandlers = new ConcurrentHashMap<>(); + private final Map bearerTokenProviders = new ConcurrentHashMap<>(); private final AtomicReference permissionHandler = new AtomicReference<>(); + private volatile boolean managedSettingsEnabled; + private final AtomicReference mcpAuthHandler = new AtomicReference<>(); private final AtomicReference userInputHandler = new AtomicReference<>(); private final AtomicReference elicitationHandler = new AtomicReference<>(); private final AtomicReference exitPlanModeHandler = new AtomicReference<>(); @@ -761,8 +785,9 @@ public Closeable on(Class eventType, Consumer han * @see #setEventErrorPolicy(EventErrorPolicy) */ void dispatchEvent(SessionEvent event) { - // Handle broadcast request events (protocol v3) before dispatching to user - // handlers. These are fire-and-forget: the response is sent asynchronously. + // Handle broadcast request events (protocol v3) and passive in-memory state + // updates (capabilities, open-canvases snapshot) before dispatching to user + // handlers. Fire-and-forget: any RPC response is sent asynchronously. handleBroadcastEventAsync(event); for (Consumer handler : eventHandlers) { @@ -788,14 +813,24 @@ void dispatchEvent(SessionEvent event) { /** * Handles broadcast request events by executing local handlers and responding - * via RPC (protocol v3). + * via RPC (protocol v3), and applies passive in-memory state updates such as + * the open-canvases snapshot. *

- * Fire-and-forget: the response is sent asynchronously. + * Fire-and-forget: any RPC response is sent asynchronously. * * @param event * the event to handle */ private void handleBroadcastEventAsync(SessionEvent event) { + // Maintain the in-memory open-canvases snapshot before user handlers run so + // they observe the freshest state. Best-effort: snapshot upkeep must never + // disrupt event delivery, so failures are logged and swallowed. + try { + updateOpenCanvasesFromEvent(event); + } catch (Exception e) { + LOG.log(Level.WARNING, "Failed to update open-canvases snapshot", e); + } + if (event instanceof ExternalToolRequestedEvent toolEvent) { var data = toolEvent.getData(); if (data == null || data.requestId() == null || data.toolName() == null) { @@ -821,6 +856,20 @@ private void handleBroadcastEventAsync(SessionEvent event) { } executePermissionAndRespondAsync(data.requestId(), MAPPER.convertValue(data.permissionRequest(), PermissionRequest.class), handler); + } else if (event instanceof McpOauthRequiredEvent authEvent) { + var data = authEvent.getData(); + if (data == null || data.requestId() == null) { + return; + } + McpAuthHandler handler = mcpAuthHandler.get(); + if (handler == null) { + LOG.warning(() -> "Received MCP OAuth request without a registered MCP auth handler. SessionId=" + + sessionId + ", RequestId=" + data.requestId()); + return; + } + executeMcpAuthAndRespondAsync(new McpAuthRequest(data.requestId(), data.serverName(), data.serverUrl(), + data.reason(), data.wwwAuthenticateParams(), data.resourceMetadata(), data.staticClientConfig()), + handler); } else if (event instanceof CommandExecuteEvent cmdEvent) { var data = cmdEvent.getData(); if (data == null || data.requestId() == null || data.commandName() == null) { @@ -859,6 +908,32 @@ private void handleBroadcastEventAsync(SessionEvent event) { } } + /** + * Populates the invocation's available-tools snapshot when it targets the + * built-in tool-search tool, so an override can filter the live catalog without + * issuing its own RPC. The snapshot is fetched only for that tool to avoid a + * round-trip on every ordinary tool call; a failed fetch leaves the snapshot + * {@code null} rather than failing the tool. Shared by both server-to-client + * tool dispatch paths ({@link RpcHandlerDispatcher} and + * {@link #executeToolAndRespondAsync}). + * + * @param toolName + * the name of the tool being invoked + * @param invocation + * the invocation to populate in place + */ + void populateToolSearchMetadata(String toolName, com.github.copilot.rpc.ToolInvocation invocation) { + if (!TOOL_SEARCH_TOOL_NAME.equals(toolName)) { + return; + } + try { + var metadata = getRpc().tools.getCurrentMetadata().join(); + invocation.setAvailableTools(metadata.tools()); + } catch (Exception e) { + LOG.log(Level.FINE, "Failed to fetch tool metadata for tool search", e); + } + } + /** * Executes a tool handler and sends the result back via * {@code session.tools.handlePendingToolCall}. @@ -873,6 +948,8 @@ private void executeToolAndRespondAsync(String requestId, String toolName, Strin var invocation = new com.github.copilot.rpc.ToolInvocation().setSessionId(sessionId) .setToolCallId(toolCallId).setToolName(toolName).setArguments(argumentsNode); + populateToolSearchMetadata(toolName, invocation); + tool.handler().invoke(invocation).thenAccept(result -> { try { ToolResultObject toolResult; @@ -938,6 +1015,7 @@ private void executePermissionAndRespondAsync(String requestId, PermissionReques try { var invocation = new PermissionInvocation(); invocation.setSessionId(sessionId); + invocation.setManagedSettingsEnabled(managedSettingsEnabled); handler.handle(permissionRequest, invocation).thenAccept(result -> { try { PermissionRequestResultKind kind = new PermissionRequestResultKind(result.getKind()); @@ -947,18 +1025,19 @@ private void executePermissionAndRespondAsync(String requestId, PermissionReques return; } getRpc().permissions.handlePendingPermissionRequest( - new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, - result)); + new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, result, + result.getDecisionContext())); } catch (Exception e) { LOG.log(Level.WARNING, "Error sending permission result for requestId=" + requestId, e); } }).exceptionally(ex -> { + LOG.log(Level.SEVERE, "Permission handler failed for requestId=" + requestId, ex); try { PermissionRequestResult denied = new PermissionRequestResult(); denied.setKind(PermissionRequestResultKind.DENIED_COULD_NOT_REQUEST_FROM_USER); getRpc().permissions.handlePendingPermissionRequest( - new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, - denied)); + new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, denied, + null)); } catch (Exception e) { LOG.log(Level.WARNING, "Error sending permission denied for requestId=" + requestId, e); } @@ -970,7 +1049,8 @@ private void executePermissionAndRespondAsync(String requestId, PermissionReques PermissionRequestResult denied = new PermissionRequestResult(); denied.setKind(PermissionRequestResultKind.DENIED_COULD_NOT_REQUEST_FROM_USER); getRpc().permissions.handlePendingPermissionRequest( - new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, denied)); + new SessionPermissionsHandlePendingPermissionRequestParams(sessionId, requestId, denied, + null)); } catch (Exception sendEx) { LOG.log(Level.WARNING, "Error sending permission denied for requestId=" + requestId, sendEx); } @@ -988,6 +1068,58 @@ private void executePermissionAndRespondAsync(String requestId, PermissionReques } } + private void executeMcpAuthAndRespondAsync(McpAuthRequest request, McpAuthHandler handler) { + Runnable task = () -> { + try { + var invocation = new McpAuthInvocation().setSessionId(sessionId); + handler.handle(request, invocation) + .thenAccept(result -> sendMcpAuthResponse(request.requestId(), result)).exceptionally(ex -> { + sendMcpAuthResponse(request.requestId(), McpAuthResult.cancelled()); + return null; + }); + } catch (Exception e) { + LOG.log(Level.WARNING, "Error executing MCP auth handler for requestId=" + request.requestId(), e); + sendMcpAuthResponse(request.requestId(), McpAuthResult.cancelled()); + } + }; + try { + if (executor != null) { + CompletableFuture.runAsync(task, executor); + } else { + CompletableFuture.runAsync(task); + } + } catch (RejectedExecutionException e) { + LOG.log(Level.WARNING, + "Executor rejected MCP auth task for requestId=" + request.requestId() + "; running inline", e); + task.run(); + } + } + + private void sendMcpAuthResponse(String requestId, McpAuthResult result) { + try { + Object response; + if (result == null || result.isCancelled() || result.token() == null) { + response = Map.of("kind", "cancelled"); + } else { + var token = result.token(); + var tokenResponse = new java.util.HashMap(); + tokenResponse.put("kind", "token"); + tokenResponse.put("accessToken", token.accessToken()); + if (token.tokenType() != null) { + tokenResponse.put("tokenType", token.tokenType()); + } + if (token.expiresIn() != null) { + tokenResponse.put("expiresIn", token.expiresIn()); + } + response = tokenResponse; + } + getRpc().mcp.oauth.handlePendingRequest( + new SessionMcpOauthHandlePendingRequestParams(sessionId, requestId, response)); + } catch (Exception e) { + LOG.log(Level.WARNING, "Error sending MCP auth response for requestId=" + requestId, e); + } + } + /** * Registers custom tool handlers for this session. *

@@ -1251,6 +1383,14 @@ void registerPermissionHandler(PermissionHandler handler) { permissionHandler.set(handler); } + void setManagedSettingsEnabled(boolean managedSettingsEnabled) { + this.managedSettingsEnabled = managedSettingsEnabled; + } + + void registerMcpAuthHandler(McpAuthHandler handler) { + mcpAuthHandler.set(handler); + } + /** * Handles a permission request from the Copilot CLI. *

@@ -1272,6 +1412,7 @@ CompletableFuture handlePermissionRequest(JsonNode perm PermissionRequest request = MAPPER.treeToValue(permissionRequestData, PermissionRequest.class); var invocation = new PermissionInvocation(); invocation.setSessionId(sessionId); + invocation.setManagedSettingsEnabled(managedSettingsEnabled); return handler.handle(request, invocation).exceptionally(ex -> { LOG.log(Level.SEVERE, "Permission handler threw an exception", ex); PermissionRequestResult result = new PermissionRequestResult(); @@ -1331,6 +1472,33 @@ void registerElicitationHandler(ElicitationHandler handler) { elicitationHandler.set(handler); } + /** + * Registers bearer-token provider callbacks for this session. + *

+ * Called internally when creating or resuming a session with BYOK providers + * that use managed-identity token callbacks. + * + * @param providers + * the callbacks keyed by provider name + */ + void registerBearerTokenProviders(Map providers) { + bearerTokenProviders.clear(); + if (providers != null) { + bearerTokenProviders.putAll(providers); + } + } + + /** + * Gets the bearer-token provider callback for the given provider name. + * + * @param providerName + * the provider name + * @return the registered callback, or {@code null} if none is registered + */ + BearerTokenProvider getBearerTokenProvider(String providerName) { + return bearerTokenProviders.get(providerName); + } + /** * Registers an exit-plan-mode handler for this session. *

@@ -1369,6 +1537,113 @@ void setCapabilities(SessionCapabilities sessionCapabilities) { this.capabilities = sessionCapabilities != null ? sessionCapabilities : new SessionCapabilities(); } + /** + * Returns a snapshot of the canvas instances currently known to be open for + * this session. + *

+ * The snapshot is seeded from the {@code session.create} / + * {@code session.resume} response and kept up to date by + * {@code session.canvas.opened} (upsert) and {@code session.canvas.closed} + * (remove) events. The returned list is an immutable defensive copy; mutating + * it has no effect on the session. + * + * @return an immutable list of the currently open canvas instances, never + * {@code null} + * @since 1.0.1 + */ + public List getOpenCanvases() { + synchronized (openCanvasesLock) { + return List.copyOf(openCanvases); + } + } + + /** + * Replaces the open-canvases snapshot for this session. + *

+ * Called internally after a {@code session.create} / {@code session.resume} + * response to seed the snapshot. {@code null} entries are ignored. + * + * @param instances + * the open canvas instances from the create/resume response, or + * {@code null} to clear the snapshot + */ + void setOpenCanvases(List instances) { + synchronized (openCanvasesLock) { + openCanvases.clear(); + if (instances != null) { + for (OpenCanvasInstance instance : instances) { + if (instance != null) { + openCanvases.add(instance); + } + } + } + } + } + + /** + * Updates the in-memory open-canvases snapshot in response to a session event. + *

+ * {@code session.canvas.opened} upserts by {@code instanceId}; a stale re-emit + * (provider unregister) arrives as another {@code opened} event and replaces + * the prior entry rather than removing it. {@code session.canvas.closed} + * removes the matching entry. Invalid payloads are logged and ignored. + * + * @param event + * the dispatched session event + */ + private void updateOpenCanvasesFromEvent(SessionEvent event) { + if (event instanceof SessionCanvasClosedEvent closedEvent) { + var data = closedEvent.getData(); + if (data == null || isNullOrEmpty(data.instanceId())) { + LOG.warning("failed to deserialize session.canvas.closed payload"); + return; + } + removeOpenCanvas(data.instanceId()); + return; + } + + if (event instanceof SessionCanvasOpenedEvent openedEvent) { + var data = openedEvent.getData(); + if (data == null || isNullOrEmpty(data.instanceId()) || isNullOrEmpty(data.canvasId()) + || isNullOrEmpty(data.extensionId())) { + LOG.warning("failed to deserialize session.canvas.opened payload"); + return; + } + upsertOpenCanvas(new OpenCanvasInstance(data.instanceId(), data.extensionId(), data.extensionName(), + data.canvasId(), data.icon(), data.title(), data.status(), data.url(), data.input())); + } + } + + /** + * Inserts or replaces a canvas instance in the snapshot, matching by + * {@code instanceId}. + */ + private void upsertOpenCanvas(OpenCanvasInstance instance) { + synchronized (openCanvasesLock) { + for (int i = 0; i < openCanvases.size(); i++) { + if (instance.instanceId().equals(openCanvases.get(i).instanceId())) { + openCanvases.set(i, instance); + return; + } + } + openCanvases.add(instance); + } + } + + /** + * Removes the canvas instance matching {@code instanceId} from the snapshot. + * Idempotent: removing an absent instance is a no-op. + */ + private void removeOpenCanvas(String instanceId) { + synchronized (openCanvasesLock) { + openCanvases.removeIf(open -> instanceId.equals(open.instanceId())); + } + } + + private static boolean isNullOrEmpty(String value) { + return value == null || value.isEmpty(); + } + /** * Handles a user input request from the Copilot CLI. *

@@ -1596,6 +1871,17 @@ CompletableFuture handleHooksInvoke(String hookType, JsonNode input) { return promptResult.thenApply(output -> (Object) output); } break; + case "userPromptTransformed" : + if (hooks.getOnUserPromptTransformed() != null) { + UserPromptTransformedHookInput transformedInput = MAPPER.treeToValue(input, + UserPromptTransformedHookInput.class); + var transformedResult = hooks.getOnUserPromptTransformed().handle(transformedInput, invocation); + if (transformedResult == null) { + return CompletableFuture.completedFuture(null); + } + return transformedResult.thenApply(output -> (Object) output); + } + break; case "sessionStart" : if (hooks.getOnSessionStart() != null) { SessionStartHookInput startInput = MAPPER.treeToValue(input, SessionStartHookInput.class); @@ -1616,6 +1902,16 @@ CompletableFuture handleHooksInvoke(String hookType, JsonNode input) { return endResult.thenApply(output -> (Object) output); } break; + case "agentStop" : + if (hooks.getOnAgentStop() != null) { + AgentStopHookInput stopInput = MAPPER.treeToValue(input, AgentStopHookInput.class); + var stopResult = hooks.getOnAgentStop().handle(stopInput, invocation); + if (stopResult == null) { + return CompletableFuture.completedFuture(null); + } + return stopResult.thenApply(output -> (Object) output); + } + break; default : LOG.fine("Unhandled hook type: " + hookType); } @@ -1681,23 +1977,26 @@ public CompletableFuture abort() { * preserved. * * 
{@code
-     * session.setModel("gpt-4.1").get();
+     * session.setModel("gpt-5.4").get();
      * session.setModel("claude-sonnet-4.6", "high").get();
      * }
* * @param model - * the model ID to switch to (e.g., {@code "gpt-4.1"}) + * the model ID to switch to (e.g., {@code "gpt-5.4"}) * @param reasoningEffort * reasoning effort level (e.g., {@code "low"}, {@code "medium"}, - * {@code "high"}, {@code "xhigh"}); {@code null} to use default + * {@code "high"}, {@code "xhigh"}, {@code "max"}); {@code null} to + * use default * @return a future that completes when the model switch is acknowledged * @throws IllegalStateException * if this session has been terminated - * @since 1.2.0 + * @since 1.0.0 */ public CompletableFuture setModel(String model, String reasoningEffort) { ensureNotTerminated(); - return getRpc().model.switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, null, null)) + return getRpc().model + .switchTo( + new SessionModelSwitchToParams(sessionId, model, reasoningEffort, null, null, null, null, null)) .thenApply(r -> null); } @@ -1715,10 +2014,11 @@ public CompletableFuture setModel(String model, String reasoningEffort) { * } * * @param model - * the model ID to switch to (e.g., {@code "gpt-4.1"}) + * the model ID to switch to (e.g., {@code "gpt-5.4"}) * @param reasoningEffort * reasoning effort level (e.g., {@code "low"}, {@code "medium"}, - * {@code "high"}, {@code "xhigh"}); {@code null} to use default + * {@code "high"}, {@code "xhigh"}, {@code "max"}); {@code null} to + * use default * @param modelCapabilities * per-property overrides for model capabilities; {@code null} to use * runtime defaults @@ -1740,7 +2040,7 @@ public CompletableFuture setModel(String model, String reasoningEffort, * preserved. * * @param model - * the model ID to switch to (e.g., {@code "gpt-4.1"}) + * the model ID to switch to (e.g., {@code "gpt-5.4"}) * @param reasoningEffort * reasoning effort level; {@code null} to use default * @param reasoningSummary @@ -1765,7 +2065,7 @@ public CompletableFuture setModel(String model, String reasoningEffort, St if (modelCapabilities.getSupports() != null) { var s = modelCapabilities.getSupports(); supports = new ModelCapabilitiesOverrideSupports(s.getVision().orElse(null), - s.getReasoningEffort().orElse(null)); + s.getReasoningEffort().orElse(null), null); } ModelCapabilitiesOverrideLimits limits = null; if (modelCapabilities.getLimits() != null) { @@ -1778,7 +2078,7 @@ public CompletableFuture setModel(String model, String reasoningEffort, St ? null : com.github.copilot.generated.rpc.ReasoningSummary.fromValue(reasoningSummary); return getRpc().model.switchTo(new SessionModelSwitchToParams(sessionId, model, reasoningEffort, - generatedReasoningSummary, generatedCapabilities)).thenApply(r -> null); + generatedReasoningSummary, null, generatedCapabilities, null, null)).thenApply(r -> null); } /** @@ -1788,11 +2088,11 @@ public CompletableFuture setModel(String model, String reasoningEffort, St * preserved. * * 
{@code
-     * session.setModel("gpt-4.1").get();
+     * session.setModel("gpt-5.4").get();
      * }
* * @param model - * the model ID to switch to (e.g., {@code "gpt-4.1"}) + * the model ID to switch to (e.g., {@code "gpt-5.4"}) * @return a future that completes when the model switch is acknowledged * @throws IllegalStateException * if this session has been terminated @@ -1832,7 +2132,7 @@ public CompletableFuture setModel(String model) { * @return a future that completes when the message is logged * @throws IllegalStateException * if this session has been terminated - * @since 1.2.0 + * @since 1.0.0 */ public CompletableFuture log(String message, String level, Boolean ephemeral, String url) { ensureNotTerminated(); diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java new file mode 100644 index 000000000..6ced0182e --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketCloseStatus.java @@ -0,0 +1,66 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +/** + * The terminal status for a callback-owned WebSocket connection. + * + * @since 1.0.0 + */ +public final class CopilotWebSocketCloseStatus { + + /** A shared normal-closure (clean end-of-stream) instance. */ + public static final CopilotWebSocketCloseStatus NORMAL_CLOSURE = new CopilotWebSocketCloseStatus(null, null, null); + + private final String description; + private final String errorCode; + private final Throwable error; + + /** + * Creates a close status. + * + * @param description + * the close description, or {@code null} + * @param errorCode + * an optional machine-readable error code surfaced to the runtime + * when the close is a failure, or {@code null} + * @param error + * the error that terminated the connection, or {@code null} for a + * clean close + */ + public CopilotWebSocketCloseStatus(String description, String errorCode, Throwable error) { + this.description = description; + this.errorCode = errorCode; + this.error = error; + } + + /** + * Gets the close description, if any. + * + * @return the description, or {@code null} + */ + public String description() { + return description; + } + + /** + * Gets the optional error code surfaced to the runtime when the close is a + * failure rather than a clean end-of-stream. + * + * @return the error code, or {@code null} + */ + public String errorCode() { + return errorCode; + } + + /** + * Gets the error that terminated the connection, if any. + * + * @return the error, or {@code null} for a clean close + */ + public Throwable error() { + return error; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java new file mode 100644 index 000000000..f7d9dbf22 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java @@ -0,0 +1,165 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.ByteArrayOutputStream; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.WebSocket; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletionStage; + +/** + * The default pass-through {@link CopilotWebSocketHandler}: it dials the real + * upstream using {@link java.net.http.WebSocket} and relays upstream-to-runtime + * messages into the runtime response unchanged. + *

+ * Subclass and override {@link #sendRequestMessage} or + * {@link #sendResponseMessage} (calling {@code super}) to observe, transform, + * or drop messages in either direction. + * + * @since 1.0.0 + */ +public class CopilotWebSocketForwarder extends CopilotWebSocketHandler { + + private volatile WebSocket webSocket; + + /** + * Creates a forwarding handler targeting the request URL and headers from + * {@code context}. + * + * @param context + * the per-request context + */ + public CopilotWebSocketForwarder(CopilotRequestContext context) { + super(context); + } + + @Override + void open() throws Exception { + if (webSocket != null) { + return; + } + WebSocket.Builder builder = HttpClient.newHttpClient().newWebSocketBuilder(); + Map> headers = context.headers(); + if (headers != null) { + for (Map.Entry> entry : headers.entrySet()) { + if (CopilotRequestHandler.isForbiddenRequestHeader(entry.getKey()) || entry.getValue() == null) { + continue; + } + for (String value : entry.getValue()) { + builder.header(entry.getKey(), value); + } + } + } + try { + this.webSocket = builder + .buildAsync(URI.create(normalizeWebSocketScheme(context.url())), new ForwardingListener()).join(); + } catch (Exception e) { + throw unwrap(e); + } + } + + @Override + public void sendRequestMessage(CopilotWebSocketMessage message) throws Exception { + WebSocket ws = this.webSocket; + if (ws == null) { + return; + } + if (message.binary()) { + ws.sendBinary(ByteBuffer.wrap(message.data()), true).join(); + } else { + ws.sendText(message.text(), true).join(); + } + } + + @Override + public void close(CopilotWebSocketCloseStatus status) throws Exception { + WebSocket ws = this.webSocket; + if (ws != null && !ws.isOutputClosed()) { + ws.sendClose(WebSocket.NORMAL_CLOSURE, "").exceptionally(ex -> null); + } + super.close(status); + } + + private void forward(byte[] data, boolean binary) { + try { + sendResponseMessage(new CopilotWebSocketMessage(data, binary)); + } catch (Exception e) { + completion().completeExceptionally(e); + } + } + + private static String normalizeWebSocketScheme(String url) { + if (url.startsWith("http://")) { + return "ws://" + url.substring("http://".length()); + } + if (url.startsWith("https://")) { + return "wss://" + url.substring("https://".length()); + } + return url; + } + + private static Exception unwrap(Exception e) { + Throwable cause = e.getCause(); + if (cause instanceof Exception ex) { + return ex; + } + return e; + } + + private final class ForwardingListener implements WebSocket.Listener { + + private final StringBuilder textBuffer = new StringBuilder(); + private final ByteArrayOutputStream binaryBuffer = new ByteArrayOutputStream(); + + @Override + public void onOpen(WebSocket webSocket) { + webSocket.request(Long.MAX_VALUE); + } + + @Override + public CompletionStage onText(WebSocket webSocket, CharSequence data, boolean last) { + textBuffer.append(data); + if (last) { + byte[] message = textBuffer.toString().getBytes(StandardCharsets.UTF_8); + textBuffer.setLength(0); + forward(message, false); + } + return null; + } + + @Override + public CompletionStage onBinary(WebSocket webSocket, ByteBuffer data, boolean last) { + byte[] chunk = new byte[data.remaining()]; + data.get(chunk); + binaryBuffer.writeBytes(chunk); + if (last) { + byte[] message = binaryBuffer.toByteArray(); + binaryBuffer.reset(); + forward(message, true); + } + return null; + } + + @Override + public CompletionStage onClose(WebSocket webSocket, int statusCode, String reason) { + close(); + return null; + } + + @Override + public void onError(WebSocket webSocket, Throwable error) { + try { + close(new CopilotWebSocketCloseStatus(error.getMessage(), null, error)); + } catch (Exception e) { + completion().completeExceptionally(e); + } + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketHandler.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketHandler.java new file mode 100644 index 000000000..203e77d5a --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketHandler.java @@ -0,0 +1,119 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.util.Objects; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.atomic.AtomicBoolean; + +/** + * A per-connection WebSocket handler returned by + * {@link CopilotRequestHandler#openWebSocket}. + *

+ * The default implementation is {@link CopilotWebSocketForwarder}, which dials + * the real upstream and transparently relays messages in both directions. A + * full transport replacement subclasses this type directly and brings its own + * transport and receive loop, forwarding upstream-to-runtime messages by + * calling {@link #sendResponseMessage} and finishing with + * {@link #close(CopilotWebSocketCloseStatus)}. + * + * @since 1.0.0 + */ +public abstract class CopilotWebSocketHandler implements AutoCloseable { + + private final LlmWebSocketResponseBridge response; + private final CompletableFuture completion = new CompletableFuture<>(); + private final AtomicBoolean closed = new AtomicBoolean(); + private volatile boolean suppressCloseOnDispose; + + /** The request context for this WebSocket connection. */ + protected final CopilotRequestContext context; + + /** + * Initializes a per-connection handler for the supplied request context. + * + * @param context + * the per-request context + */ + protected CopilotWebSocketHandler(CopilotRequestContext context) { + this.context = context; + this.response = Objects.requireNonNull(context.webSocketResponse(), + "WebSocket response bridge is not attached"); + } + + /** + * Sends a message from the runtime to the upstream connection. + * + * @param message + * the message to forward upstream + * @throws Exception + * if the message could not be forwarded + */ + public abstract void sendRequestMessage(CopilotWebSocketMessage message) throws Exception; + + /** + * Sends a message from the upstream connection back to the runtime. Override to + * mutate or duplicate messages; call {@code super} to emit. + * + * @param message + * the upstream-to-runtime message + * @throws Exception + * if the message could not be delivered + */ + public void sendResponseMessage(CopilotWebSocketMessage message) throws Exception { + response.write(message); + } + + /** + * Closes the connection and finalises the runtime-facing response. Idempotent. + * + * @param status + * the terminal status; a non-null + * {@link CopilotWebSocketCloseStatus#error()} surfaces a transport + * failure, otherwise a clean end-of-stream + * @throws Exception + * if the terminal frame could not be delivered + */ + public void close(CopilotWebSocketCloseStatus status) throws Exception { + if (!closed.compareAndSet(false, true)) { + return; + } + if (status.error() != null) { + response.error(status.description() != null ? status.description() : status.error().getMessage(), + status.errorCode()); + } else { + response.end(); + } + completion.complete(status); + } + + /** + * Tears down the connection, finalising with a normal closure unless the + * connection has already been closed or close-on-dispose was suppressed. + */ + @Override + public void close() { + if (!suppressCloseOnDispose && !closed.get()) { + try { + close(CopilotWebSocketCloseStatus.NORMAL_CLOSURE); + } catch (Exception ignored) { + // Best-effort teardown; the connection may already be gone. + } + } + } + + CompletableFuture completion() { + return completion; + } + + void suppressCloseOnDispose() { + suppressCloseOnDispose = true; + } + + void open() throws Exception { + // Default: nothing to establish. CopilotWebSocketForwarder dials + // the upstream here. + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketMessage.java b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketMessage.java new file mode 100644 index 000000000..87ffaf7fe --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/CopilotWebSocketMessage.java @@ -0,0 +1,41 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.nio.charset.StandardCharsets; + +/** + * A single WebSocket message exchanged through a + * {@link CopilotWebSocketHandler} hook. + * + * @param data + * the message payload bytes + * @param binary + * {@code true} for a binary frame, {@code false} for a UTF-8 text + * frame + * @since 1.0.0 + */ +public record CopilotWebSocketMessage(byte[] data, boolean binary) { + + /** + * Decodes the payload as UTF-8 text. + * + * @return the payload as text + */ + public String text() { + return new String(data, StandardCharsets.UTF_8); + } + + /** + * Creates a text message from a UTF-8 string. + * + * @param text + * the text payload + * @return a text message + */ + public static CopilotWebSocketMessage fromText(String text) { + return new CopilotWebSocketMessage(text.getBytes(StandardCharsets.UTF_8), false); + } +} diff --git a/java/src/main/java/com/github/copilot/EventErrorHandler.java b/java/sdk/src/main/java/com/github/copilot/EventErrorHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/EventErrorHandler.java rename to java/sdk/src/main/java/com/github/copilot/EventErrorHandler.java diff --git a/java/src/main/java/com/github/copilot/EventErrorPolicy.java b/java/sdk/src/main/java/com/github/copilot/EventErrorPolicy.java similarity index 100% rename from java/src/main/java/com/github/copilot/EventErrorPolicy.java rename to java/sdk/src/main/java/com/github/copilot/EventErrorPolicy.java diff --git a/java/src/main/java/com/github/copilot/ExtractedTransforms.java b/java/sdk/src/main/java/com/github/copilot/ExtractedTransforms.java similarity index 100% rename from java/src/main/java/com/github/copilot/ExtractedTransforms.java rename to java/sdk/src/main/java/com/github/copilot/ExtractedTransforms.java diff --git a/java/sdk/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java b/java/sdk/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java new file mode 100644 index 000000000..1fdb2a473 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/GitHubTelemetryAdapter.java @@ -0,0 +1,54 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.util.concurrent.CompletableFuture; +import java.util.function.Function; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.GitHubTelemetryNotification; + +/** + * Bridges the runtime's {@code gitHubTelemetry.event} client-global + * notification to a consumer's async {@code onGitHubTelemetry} callback. The + * notification carries per-session GitHub (hydro) telemetry the runtime + * forwards to connections that opted into telemetry forwarding. + */ +final class GitHubTelemetryAdapter { + + private static final Logger LOG = Logger.getLogger(GitHubTelemetryAdapter.class.getName()); + private static final ObjectMapper MAPPER = JsonRpcClient.getObjectMapper(); + + private final Function> callback; + + GitHubTelemetryAdapter(Function> callback) { + this.callback = callback; + } + + void registerHandlers(JsonRpcClient rpc) { + rpc.registerMethodHandler("gitHubTelemetry.event", (rpcId, params) -> handleEvent(params)); + } + + private void handleEvent(JsonNode params) { + try { + GitHubTelemetryNotification notification = MAPPER.treeToValue(params, GitHubTelemetryNotification.class); + if (notification != null) { + CompletableFuture result = callback.apply(notification); + if (result != null) { + result.whenComplete((unused, error) -> { + if (error != null) { + LOG.log(Level.WARNING, "Error handling gitHubTelemetry.event notification", error); + } + }); + } + } + } catch (Exception e) { + LOG.log(Level.WARNING, "Error handling gitHubTelemetry.event notification", e); + } + } +} diff --git a/java/src/main/java/com/github/copilot/InternalExecutorProvider.java b/java/sdk/src/main/java/com/github/copilot/InternalExecutorProvider.java similarity index 100% rename from java/src/main/java/com/github/copilot/InternalExecutorProvider.java rename to java/sdk/src/main/java/com/github/copilot/InternalExecutorProvider.java diff --git a/java/src/main/java/com/github/copilot/JsonRpcClient.java b/java/sdk/src/main/java/com/github/copilot/JsonRpcClient.java similarity index 88% rename from java/src/main/java/com/github/copilot/JsonRpcClient.java rename to java/sdk/src/main/java/com/github/copilot/JsonRpcClient.java index a7cd0e120..550bd4ca4 100644 --- a/java/src/main/java/com/github/copilot/JsonRpcClient.java +++ b/java/sdk/src/main/java/com/github/copilot/JsonRpcClient.java @@ -18,6 +18,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.atomic.AtomicLong; import java.util.function.BiConsumer; +import java.util.function.Consumer; import java.util.logging.Level; import java.util.logging.Logger; @@ -46,6 +47,7 @@ class JsonRpcClient implements AutoCloseable { private final OutputStream outputStream; private final Socket socket; private final Process process; + private final boolean ownsStreams; private final AtomicLong requestIdCounter = new AtomicLong(0); private final Map> pendingRequests = new ConcurrentHashMap<>(); private final Map> notificationHandlers = new ConcurrentHashMap<>(); @@ -53,15 +55,29 @@ class JsonRpcClient implements AutoCloseable { private volatile boolean running = true; private JsonRpcClient(InputStream inputStream, OutputStream outputStream, Socket socket, Process process) { + this(inputStream, outputStream, socket, process, false); + } + + private JsonRpcClient(InputStream inputStream, OutputStream outputStream, Socket socket, Process process, + boolean ownsStreams) { + this(inputStream, outputStream, socket, process, ownsStreams, null); + } + + private JsonRpcClient(InputStream inputStream, OutputStream outputStream, Socket socket, Process process, + boolean ownsStreams, Consumer initializer) { this.inputStream = inputStream; this.outputStream = outputStream; this.socket = socket; this.process = process; + this.ownsStreams = ownsStreams; this.readerExecutor = Executors.newSingleThreadExecutor(r -> { Thread t = new Thread(r, "jsonrpc-reader"); t.setDaemon(true); return t; }); + if (initializer != null) { + initializer.accept(this); + } startReader(); } @@ -70,7 +86,8 @@ static ObjectMapper createObjectMapper() { mapper.registerModule(new JavaTimeModule()); mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); - mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL); + mapper.setDefaultPropertyInclusion( + JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.ALWAYS)); return mapper; } @@ -92,6 +109,19 @@ public static JsonRpcClient fromSocket(Socket socket) throws IOException { return new JsonRpcClient(socket.getInputStream(), socket.getOutputStream(), socket, null); } + static JsonRpcClient fromSocket(Socket socket, Consumer initializer) throws IOException { + return new JsonRpcClient(socket.getInputStream(), socket.getOutputStream(), socket, null, false, initializer); + } + + /** + * Creates a JSON-RPC client over arbitrary input/output streams. The client + * takes ownership of the streams and closes them when {@link #close()} is + * called. + */ + public static JsonRpcClient fromStreams(InputStream inputStream, OutputStream outputStream) { + return new JsonRpcClient(inputStream, outputStream, null, null, true); + } + /** * Registers a handler for JSON-RPC method calls (requests/notifications from * server). @@ -343,6 +373,19 @@ public void close() { if (process != null) { process.destroy(); } + + if (ownsStreams) { + try { + inputStream.close(); + } catch (IOException e) { + LOG.log(Level.FINE, "Error closing input stream", e); + } + try { + outputStream.close(); + } catch (IOException e) { + LOG.log(Level.FINE, "Error closing output stream", e); + } + } } public boolean isConnected() { diff --git a/java/src/main/java/com/github/copilot/JsonRpcException.java b/java/sdk/src/main/java/com/github/copilot/JsonRpcException.java similarity index 100% rename from java/src/main/java/com/github/copilot/JsonRpcException.java rename to java/sdk/src/main/java/com/github/copilot/JsonRpcException.java diff --git a/java/src/main/java/com/github/copilot/LifecycleEventManager.java b/java/sdk/src/main/java/com/github/copilot/LifecycleEventManager.java similarity index 100% rename from java/src/main/java/com/github/copilot/LifecycleEventManager.java rename to java/sdk/src/main/java/com/github/copilot/LifecycleEventManager.java diff --git a/java/sdk/src/main/java/com/github/copilot/LlmInferenceAdapter.java b/java/sdk/src/main/java/com/github/copilot/LlmInferenceAdapter.java new file mode 100644 index 000000000..3e741a56b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/LlmInferenceAdapter.java @@ -0,0 +1,206 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Base64; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.Executor; +import java.util.concurrent.RejectedExecutionException; +import java.util.function.Supplier; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.fasterxml.jackson.databind.JsonNode; +import com.github.copilot.generated.rpc.ServerLlmInferenceApi; + +/** + * Adapts the generated {@code llmInference.*} reverse-RPC entry points onto a + * consumer's {@link CopilotRequestHandler}. Each {@code httpRequestStart} + * allocates an {@link LlmInferenceExchange} and runs the handler in the + * background; subsequent {@code httpRequestChunk} frames feed its request body + * stream. + */ +final class LlmInferenceAdapter { + + private static final Logger LOG = Logger.getLogger(LlmInferenceAdapter.class.getName()); + + private final CopilotRequestHandler handler; + private final Supplier rpcSupplier; + private final Executor executor; + + private final Map pending = new ConcurrentHashMap<>(); + + LlmInferenceAdapter(CopilotRequestHandler handler, Supplier rpcSupplier, Executor executor) { + this.handler = handler; + this.rpcSupplier = rpcSupplier; + this.executor = executor; + } + + void registerHandlers(JsonRpcClient rpc) { + rpc.registerMethodHandler("llmInference.httpRequestStart", + (rpcId, params) -> handleRequestStart(rpc, rpcId, params)); + rpc.registerMethodHandler("llmInference.httpRequestChunk", + (rpcId, params) -> handleRequestChunk(rpc, rpcId, params)); + } + + private LlmInferenceExchange getOrCreateExchange(String requestId) { + // The runtime dispatches httpRequestStart and httpRequestChunk frames + // independently. Even though the current reader dispatches them in + // order, get-or-create keeps the adapter correct regardless: a body + // chunk (including the terminal end frame) that races ahead of its + // start frame is buffered into the same exchange rather than dropped, + // which would otherwise hang the body drain forever. + return pending.computeIfAbsent(requestId, id -> new LlmInferenceExchange(id, rpcSupplier)); + } + + private void handleRequestStart(JsonRpcClient rpc, String rpcId, JsonNode params) { + String requestId = params.get("requestId").asText(); + String sessionId = textOrNull(params, "sessionId"); + String agentId = textOrNull(params, "agentId"); + String parentAgentId = textOrNull(params, "parentAgentId"); + String interactionType = textOrNull(params, "interactionType"); + String method = textOrNull(params, "method"); + String url = textOrNull(params, "url"); + CopilotRequestTransport transport = CopilotRequestTransport.fromWire(textOrNull(params, "transport")); + Map> headers = parseHeaders(params.get("headers")); + + // Adopt any exchange a racing chunk already created — with its buffered + // body — rather than dropping those frames. + LlmInferenceExchange exchange = getOrCreateExchange(requestId); + exchange.setMethod(method); + exchange.setContext(new CopilotRequestContext(requestId, sessionId, agentId, parentAgentId, interactionType, + transport, url, headers, exchange.cancellation())); + + // Return from httpRequestStart immediately (after registering state) so the + // runtime's RPC reply is not gated on the consumer's I/O. The actual handler + // work runs asynchronously. + runAsync(() -> runHandler(exchange)); + + ack(rpc, rpcId); + } + + private void handleRequestChunk(JsonRpcClient rpc, String rpcId, JsonNode params) { + String requestId = params.get("requestId").asText(); + // May arrive before the matching start frame; get-or-create so the body + // is buffered, never lost. + LlmInferenceExchange exchange = getOrCreateExchange(requestId); + routeChunk(exchange, params); + ack(rpc, rpcId); + } + + private static void routeChunk(LlmInferenceExchange exchange, JsonNode params) { + if (boolOr(params, "cancel")) { + exchange.pushCancel(); + return; + } + String data = textOr(params, "data", ""); + boolean binary = boolOr(params, "binary"); + if (!data.isEmpty()) { + byte[] bytes = binary ? Base64.getDecoder().decode(data) : data.getBytes(StandardCharsets.UTF_8); + exchange.pushChunk(bytes, binary); + } + if (boolOr(params, "end")) { + exchange.pushEnd(); + } + } + + private void runHandler(LlmInferenceExchange exchange) { + try { + handler.handle(exchange); + if (!exchange.finished()) { + finalizeError(exchange, 502, "LLM inference handler returned without finalising the response " + + "(call endResponse() or errorResponse())", null); + } + } catch (Exception e) { + if (exchange.cancelled() || exchange.cancellation().isDone()) { + // The runtime already cancelled this request; the handler's throw is + // just the abort propagating out of its upstream call. + finalizeError(exchange, 499, "Request cancelled by runtime", "cancelled"); + } else { + String message = e.getMessage() != null ? e.getMessage() : e.toString(); + finalizeError(exchange, 502, message, null); + } + } finally { + pending.remove(exchange.requestId()); + } + } + + private static void finalizeError(LlmInferenceExchange exchange, int status, String message, String code) { + if (exchange.finished()) { + return; + } + try { + if (!exchange.started()) { + exchange.startResponse(status, null, null); + } + exchange.errorResponse(message, code); + } catch (IOException e) { + LOG.log(Level.FINE, "Failed to deliver LLM inference failure", e); + } + } + + private void ack(JsonRpcClient rpc, String rpcId) { + long id; + try { + id = Long.parseLong(rpcId); + } catch (NumberFormatException e) { + return; + } + try { + rpc.sendResponse(id, Map.of()); + } catch (IOException e) { + LOG.log(Level.FINE, "Failed to acknowledge LLM inference frame", e); + } + } + + private void runAsync(Runnable task) { + try { + if (executor != null) { + CompletableFuture.runAsync(task, executor); + } else { + CompletableFuture.runAsync(task); + } + } catch (RejectedExecutionException e) { + LOG.log(Level.WARNING, "Executor rejected LLM inference task; running inline", e); + task.run(); + } + } + + private static String textOrNull(JsonNode params, String field) { + return params.has(field) && !params.get(field).isNull() ? params.get(field).asText() : null; + } + + private static String textOr(JsonNode params, String field, String fallback) { + return params.has(field) && !params.get(field).isNull() ? params.get(field).asText() : fallback; + } + + private static boolean boolOr(JsonNode params, String field) { + return params.has(field) && !params.get(field).isNull() && params.get(field).asBoolean(); + } + + private static Map> parseHeaders(JsonNode node) { + Map> result = new LinkedHashMap<>(); + if (node != null && node.isObject()) { + node.properties().forEach(entry -> { + List values = new ArrayList<>(); + JsonNode value = entry.getValue(); + if (value.isArray()) { + value.forEach(item -> values.add(item.asText())); + } else if (!value.isNull()) { + values.add(value.asText()); + } + result.put(entry.getKey(), values); + }); + } + return result; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/LlmInferenceExchange.java b/java/sdk/src/main/java/com/github/copilot/LlmInferenceExchange.java new file mode 100644 index 000000000..67933e40b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/LlmInferenceExchange.java @@ -0,0 +1,263 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.List; +import java.util.Map; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.CancellationException; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.function.Supplier; + +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseChunkError; +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseChunkParams; +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseStartParams; +import com.github.copilot.generated.rpc.ServerLlmInferenceApi; + +/** + * One intercepted request in flight. Carries the request context plus the body + * byte stream the runtime feeds in via {@code httpRequestChunk} frames, and + * emits the consumer's response straight back to the runtime through the + * generated {@code llmInference} server API. + *

+ * This is the single object the {@link LlmInferenceAdapter} owns and the + * {@link CopilotRequestHandler} writes to, replacing the former + * provider/sink/request-body/response-channel indirection. The response state + * machine is strict: {@link #startResponse} once, then zero or more + * {@code writeResponse*} calls, finishing with exactly one of + * {@link #endResponse} or {@link #errorResponse}. + */ +final class LlmInferenceExchange { + + /** + * A single request body frame. + * + * @param data + * the frame bytes + * @param binary + * {@code true} when delivered as binary, {@code false} for UTF-8 + * text + */ + record BodyFrame(byte[] data, boolean binary) { + } + + private enum ItemKind { + CHUNK, END, CANCEL + } + + private record BodyItem(ItemKind kind, byte[] data, boolean binary) { + } + + private final String requestId; + private String method; + private final Supplier rpcSupplier; + + private final BlockingQueue body = new LinkedBlockingQueue<>(); + private final CompletableFuture cancellation = new CompletableFuture<>(); + + private final Object lock = new Object(); + private boolean started; + private boolean finished; + private boolean cancelled; + + private CopilotRequestContext context; + + LlmInferenceExchange(String requestId, Supplier rpcSupplier) { + this.requestId = requestId; + this.rpcSupplier = rpcSupplier; + } + + String requestId() { + return requestId; + } + + String method() { + return method; + } + + void setMethod(String method) { + this.method = method; + } + + CompletableFuture cancellation() { + return cancellation; + } + + CopilotRequestContext context() { + return context; + } + + void setContext(CopilotRequestContext context) { + this.context = context; + } + + boolean started() { + synchronized (lock) { + return started; + } + } + + boolean finished() { + synchronized (lock) { + return finished; + } + } + + boolean cancelled() { + synchronized (lock) { + return cancelled; + } + } + + // --- Request body feed (driven by the adapter as chunk frames arrive) --- + + void pushChunk(byte[] data, boolean binary) { + body.add(new BodyItem(ItemKind.CHUNK, data, binary)); + } + + void pushEnd() { + body.add(new BodyItem(ItemKind.END, null, false)); + } + + void pushCancel() { + synchronized (lock) { + cancelled = true; + } + if (!cancellation.isDone()) { + cancellation.complete(null); + } + body.add(new BodyItem(ItemKind.CANCEL, null, false)); + } + + /** + * Reads the next request body frame, blocking until one is available. + * + * @return the next frame, or {@code null} when the body has ended + * @throws InterruptedException + * if interrupted while waiting + * @throws CancellationException + * if the runtime cancelled the request + */ + BodyFrame readFrame() throws InterruptedException { + BodyItem item = body.take(); + switch (item.kind()) { + case CANCEL -> { + // Re-arm the sentinel so subsequent reads keep failing fast. + body.add(item); + throw new CancellationException("Request cancelled by runtime"); + } + case END -> { + body.add(item); + return null; + } + default -> { + return new BodyFrame(item.data(), item.binary()); + } + } + } + + byte[] drainBody() throws InterruptedException { + ByteArrayOutputStream out = new ByteArrayOutputStream(); + BodyFrame frame; + while ((frame = readFrame()) != null) { + out.writeBytes(frame.data()); + } + return out.toByteArray(); + } + + // --- Response emit (driven by the handler) --- + + void startResponse(int status, String statusText, Map> headers) throws IOException { + synchronized (lock) { + if (started) { + throw new IOException("LLM inference response startResponse() called twice"); + } + if (finished) { + throw new IOException("LLM inference response already finished"); + } + started = true; + } + var params = new LlmInferenceHttpResponseStartParams(requestId, (long) status, statusText, headers); + join(api().httpResponseStart(params)); + } + + void writeResponseText(String text) throws IOException { + writeChunk(text, false); + } + + void writeResponseBinary(byte[] data) throws IOException { + writeChunk(Base64.getEncoder().encodeToString(data), true); + } + + void writeResponseBinary(byte[] data, int offset, int length) throws IOException { + ByteBuffer encoded = Base64.getEncoder().encode(ByteBuffer.wrap(data, offset, length)); + writeChunk(new String(encoded.array(), 0, encoded.limit(), StandardCharsets.ISO_8859_1), true); + } + + void endResponse() throws IOException { + synchronized (lock) { + if (finished) { + return; + } + finished = true; + } + var params = new LlmInferenceHttpResponseChunkParams(requestId, "", null, Boolean.TRUE, null); + join(api().httpResponseChunk(params)); + } + + void errorResponse(String message, String code) throws IOException { + synchronized (lock) { + if (finished) { + return; + } + finished = true; + } + var error = new LlmInferenceHttpResponseChunkError(message, code); + var params = new LlmInferenceHttpResponseChunkParams(requestId, "", null, Boolean.TRUE, error); + join(api().httpResponseChunk(params)); + } + + private void writeChunk(String data, boolean binary) throws IOException { + synchronized (lock) { + if (cancelled) { + throw new IOException("LLM inference request was cancelled by the runtime"); + } + if (!started) { + throw new IOException("LLM inference response writeResponse() called before startResponse()"); + } + if (finished) { + throw new IOException( + "LLM inference response writeResponse() called after endResponse()/errorResponse()"); + } + } + var params = new LlmInferenceHttpResponseChunkParams(requestId, data, binary ? Boolean.TRUE : null, + Boolean.FALSE, null); + join(api().httpResponseChunk(params)); + } + + private ServerLlmInferenceApi api() throws IOException { + ServerLlmInferenceApi api = rpcSupplier.get(); + if (api == null) { + throw new IOException("LLM inference response used after RPC connection closed"); + } + return api; + } + + private static T join(CompletableFuture future) throws IOException { + try { + return future.join(); + } catch (CompletionException | CancellationException e) { + Throwable cause = e.getCause() != null ? e.getCause() : e; + throw new IOException(cause.getMessage(), cause); + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java b/java/sdk/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java new file mode 100644 index 000000000..b7bbbd8c7 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/LlmWebSocketResponseBridge.java @@ -0,0 +1,73 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.IOException; + +/** + * Forwards upstream WebSocket messages back to the owning + * {@link LlmInferenceExchange}. The {@code 101} upgrade head is emitted eagerly + * via {@link #start()} (the runtime gates the WebSocket connect on it); + * thereafter writes are serialised so the head always precedes any body or + * terminal frame. + */ +final class LlmWebSocketResponseBridge { + + private final LlmInferenceExchange exchange; + private final Object lock = new Object(); + private boolean started; + private boolean completed; + + LlmWebSocketResponseBridge(LlmInferenceExchange exchange) { + this.exchange = exchange; + } + + /** + * Emits the {@code 101} upgrade head now, acknowledging the WebSocket connect. + */ + void start() throws IOException { + run(false, () -> { + }); + } + + void write(CopilotWebSocketMessage message) throws IOException { + run(false, () -> { + if (message.binary()) { + exchange.writeResponseBinary(message.data()); + } else { + exchange.writeResponseText(message.text()); + } + }); + } + + void end() throws IOException { + run(true, exchange::endResponse); + } + + void error(String message, String code) throws IOException { + run(true, () -> exchange.errorResponse(message, code)); + } + + private void run(boolean terminal, IoAction action) throws IOException { + synchronized (lock) { + if (completed) { + return; + } + if (!started) { + started = true; + exchange.startResponse(101, null, null); + } + if (terminal) { + completed = true; + } + action.run(); + } + } + + @FunctionalInterface + private interface IoAction { + void run() throws IOException; + } +} diff --git a/java/src/main/java/com/github/copilot/LoggingHelpers.java b/java/sdk/src/main/java/com/github/copilot/LoggingHelpers.java similarity index 100% rename from java/src/main/java/com/github/copilot/LoggingHelpers.java rename to java/sdk/src/main/java/com/github/copilot/LoggingHelpers.java diff --git a/java/src/main/java/com/github/copilot/RpcHandlerDispatcher.java b/java/sdk/src/main/java/com/github/copilot/RpcHandlerDispatcher.java similarity index 87% rename from java/src/main/java/com/github/copilot/RpcHandlerDispatcher.java rename to java/sdk/src/main/java/com/github/copilot/RpcHandlerDispatcher.java index 391f270db..d2dff958d 100644 --- a/java/src/main/java/com/github/copilot/RpcHandlerDispatcher.java +++ b/java/sdk/src/main/java/com/github/copilot/RpcHandlerDispatcher.java @@ -19,6 +19,8 @@ import com.github.copilot.generated.SessionEvent; import com.github.copilot.rpc.AutoModeSwitchRequest; import com.github.copilot.rpc.ExitPlanModeRequest; +import com.github.copilot.rpc.BearerTokenProvider; +import com.github.copilot.rpc.ProviderTokenArgs; import com.github.copilot.rpc.PermissionRequestResult; import com.github.copilot.rpc.PermissionRequestResultKind; import com.github.copilot.rpc.SessionLifecycleEvent; @@ -88,6 +90,8 @@ void registerHandlers(JsonRpcClient rpc) { rpc.registerMethodHandler("hooks.invoke", (requestId, params) -> handleHooksInvoke(rpc, requestId, params)); rpc.registerMethodHandler("systemMessage.transform", (requestId, params) -> handleSystemMessageTransform(rpc, requestId, params)); + rpc.registerMethodHandler("providerToken.getToken", + (requestId, params) -> handleProviderTokenGetToken(rpc, requestId, params)); } private void handleSessionEvent(JsonNode params) { @@ -158,6 +162,8 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params var invocation = new ToolInvocation().setSessionId(sessionId).setToolCallId(toolCallId) .setToolName(toolName).setArguments(arguments); + session.populateToolSearchMetadata(toolName, invocation); + tool.handler().invoke(invocation).thenAccept(result -> { try { ToolResultObject toolResult; @@ -300,6 +306,69 @@ private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNod }); } + private void handleProviderTokenGetToken(JsonRpcClient rpc, String requestId, JsonNode params) { + LOG.fine("Received providerToken.getToken: " + params); + runAsync(() -> { + final long requestIdLong = parseRequestId(requestId, "providerToken.getToken"); + if (requestIdLong == -1) { + return; + } + try { + String sessionId = params.get("sessionId").asText(); + String providerName = params.get("providerName").asText(); + + CopilotSession session = sessions.get(sessionId); + if (session == null) { + rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId); + return; + } + + BearerTokenProvider provider = session.getBearerTokenProvider(providerName); + if (provider == null) { + rpc.sendErrorResponse(requestIdLong, -32603, + "No bearer-token provider registered for provider " + providerName); + return; + } + + CompletableFuture tokenFuture = provider + .getToken(new ProviderTokenArgs(providerName, sessionId)); + if (tokenFuture == null) { + rpc.sendErrorResponse(requestIdLong, -32603, + "Bearer-token provider returned null future for provider " + providerName); + return; + } + + tokenFuture.thenAccept(token -> { + try { + if (token == null) { + rpc.sendErrorResponse(requestIdLong, -32603, + "Bearer-token provider returned null token for provider " + providerName); + return; + } + rpc.sendResponse(requestIdLong, Map.of("token", token)); + } catch (IOException e) { + LOG.log(Level.SEVERE, "Error sending provider token response", e); + } + }).exceptionally(ex -> { + LOG.log(Level.WARNING, "Bearer-token provider exception", ex); + try { + rpc.sendErrorResponse(requestIdLong, -32603, "Bearer-token provider error: " + ex.getMessage()); + } catch (IOException e) { + LOG.log(Level.SEVERE, "Error sending provider token error", e); + } + return null; + }); + } catch (Exception e) { + LOG.log(Level.SEVERE, "Error handling providerToken.getToken", e); + try { + rpc.sendErrorResponse(requestIdLong, -32603, "Provider token handler error: " + e.getMessage()); + } catch (IOException ioException) { + LOG.log(Level.SEVERE, "Error sending provider token handler error", ioException); + } + } + }); + } + private void handleExitPlanModeRequest(JsonRpcClient rpc, String requestId, JsonNode params) { runAsync(() -> { final long requestIdLong = parseRequestId(requestId, "exitPlanMode.request"); diff --git a/java/src/main/java/com/github/copilot/SdkProtocolVersion.java b/java/sdk/src/main/java/com/github/copilot/SdkProtocolVersion.java similarity index 100% rename from java/src/main/java/com/github/copilot/SdkProtocolVersion.java rename to java/sdk/src/main/java/com/github/copilot/SdkProtocolVersion.java diff --git a/java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java b/java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java new file mode 100644 index 000000000..4254c04ec --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/SessionRequestBuilder.java @@ -0,0 +1,482 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.function.Function; + +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.CreateSessionRequest; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.NamedProviderConfig; +import com.github.copilot.rpc.BearerTokenProvider; +import com.github.copilot.rpc.CommandWireDefinition; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.ResumeSessionRequest; +import com.github.copilot.rpc.SectionOverride; +import com.github.copilot.rpc.SectionOverrideAction; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SystemMessageConfig; + +/** + * Builds JSON-RPC request objects from session configuration. + *

+ * This class handles the conversion of SDK configuration objects + * ({@link SessionConfig}, {@link ResumeSessionConfig}) to JSON-RPC request + * objects for session creation and resumption. + */ +final class SessionRequestBuilder { + + private SessionRequestBuilder() { + // Utility class + } + + /** + * Extracts transform callbacks from a {@link SystemMessageConfig} and returns a + * wire-safe copy of the config alongside the extracted callbacks. + *

+ * When the system message mode is {@link SystemMessageMode#CUSTOMIZE} and some + * sections have {@link SectionOverride#getTransform() transform} callbacks set, + * this method: + *

    + *
  1. Removes the callbacks from the wire config (they must not be + * serialized).
    2. + *
  2. Replaces each transform section with + * {@link SectionOverrideAction#TRANSFORM} in the wire config.
    3. + *
  3. Returns the callbacks so they can be registered with the session.
    4. + *
+ * + * @param systemMessage + * the system message config, may be {@code null} + * @return an {@link ExtractedTransforms} containing the wire-safe config and + * any extracted callbacks + */ + static ExtractedTransforms extractTransformCallbacks(SystemMessageConfig systemMessage) { + if (systemMessage == null || systemMessage.getMode() != SystemMessageMode.CUSTOMIZE + || systemMessage.getSections() == null) { + return new ExtractedTransforms(systemMessage, null); + } + + Map>> callbacks = new HashMap<>(); + Map wireSections = new HashMap<>(); + + for (Map.Entry entry : systemMessage.getSections().entrySet()) { + String sectionId = entry.getKey(); + SectionOverride override = entry.getValue(); + + if (override.getTransform() != null) { + callbacks.put(sectionId, override.getTransform()); + wireSections.put(sectionId, new SectionOverride().setAction(SectionOverrideAction.TRANSFORM)); + } else { + wireSections.put(sectionId, override); + } + } + + if (callbacks.isEmpty()) { + return new ExtractedTransforms(systemMessage, null); + } + + // Build a wire-safe copy of the system message with callbacks removed + var wireConfig = new SystemMessageConfig().setMode(systemMessage.getMode()) + .setContent(systemMessage.getContent()).setSections(wireSections); + + return new ExtractedTransforms(wireConfig, callbacks); + } + + /** + * Builds a CreateSessionRequest from the given configuration. + * + * @param config + * the session configuration (may be null) + * @param sessionId + * the pre-generated session ID to use + * @return the built request object + */ + static CreateSessionRequest buildCreateRequest(SessionConfig config, String sessionId) { + return buildCreateRequest(config, sessionId, CopilotClientMode.COPILOT_CLI); + } + + static CreateSessionRequest buildCreateRequest(SessionConfig config, String sessionId, CopilotClientMode mode) { + var request = new CreateSessionRequest(); + // Always request permission callbacks to enable deny-by-default behavior + request.setRequestPermission(true); + // Always send envValueMode=direct for MCP servers + request.setEnvValueMode("direct"); + request.setSessionId(sessionId); + if (config == null) { + request.setCustomAgentsLocalOnly(resolveCustomAgentsLocalOnly(null, mode)); + return request; + } + + request.setModel(config.getModel()); + request.setClientName(config.getClientName()); + request.setReasoningEffort(config.getReasoningEffort()); + request.setReasoningSummary(config.getReasoningSummary()); + request.setContextTier(config.getContextTier()); + request.setTools(config.getTools()); + request.setSystemMessage(config.getSystemMessage()); + request.setAvailableTools(config.getAvailableTools()); + request.setExcludedTools(config.getExcludedTools()); + request.setExcludedBuiltInAgents(config.getExcludedBuiltInAgents()); + request.setProvider(config.getProvider()); + request.setCapi(config.getCapi()); + request.setProviders(config.getProviders()); + request.setModels(config.getModels()); + config.getEnableSessionTelemetry().ifPresent(request::setEnableSessionTelemetry); + config.getEnableCitations().ifPresent(request::setEnableCitations); + config.getEnableFileChangeTracking().ifPresent(request::setEnableFileChangeTracking); + request.setSessionLimits(config.getSessionLimits()); + experimentalModeForMode(mode, config.getEnableExperimentalMode().orElse(null)) + .ifPresent(request::setIsExperimentalMode); + if (config.getOnUserInputRequest() != null) { + request.setRequestUserInput(true); + } + if (config.getHooks() != null && config.getHooks().hasHooks()) { + request.setHooks(true); + } + request.setWorkingDirectory(config.getWorkingDirectory()); + request.setAdditionalDirectories(config.getAdditionalDirectories()); + if (config.isStreaming()) { + request.setStreaming(true); + } + config.getIncludeSubAgentStreamingEvents().ifPresent(request::setIncludeSubAgentStreamingEvents); + request.setMcpServers(config.getMcpServers()); + request.setMcpOAuthTokenStorage(config.getMcpOAuthTokenStorage()); + request.setCustomAgents(config.getCustomAgents()); + request.setCustomAgentsLocalOnly( + resolveCustomAgentsLocalOnly(config.getCustomAgentsLocalOnly().orElse(null), mode)); + request.setDefaultAgent(config.getDefaultAgent()); + request.setAgent(config.getAgent()); + request.setInfiniteSessions(config.getInfiniteSessions()); + request.setSkillDirectories(config.getSkillDirectories()); + request.setInstructionDirectories(config.getInstructionDirectories()); + request.setPluginDirectories(config.getPluginDirectories()); + request.setLargeOutput(config.getLargeOutput()); + request.setToolSearch(config.getToolSearch()); + request.setMemory(config.getMemory()); + request.setDisabledSkills(config.getDisabledSkills()); + request.setDisabledMcpServers(config.getDisabledMcpServers()); + request.setConfigDirectory(config.getConfigDirectory()); + config.getEnableConfigDiscovery().ifPresent(request::setEnableConfigDiscovery); + config.getSkipEmbeddingRetrieval().ifPresent(request::setSkipEmbeddingRetrieval); + if (config.getOrganizationCustomInstructions() != null) { + request.setOrganizationCustomInstructions(config.getOrganizationCustomInstructions()); + } + config.getEnableOnDemandInstructionDiscovery().ifPresent(request::setEnableOnDemandInstructionDiscovery); + config.getEnableFileHooks().ifPresent(request::setEnableFileHooks); + config.getEnableHostGitOperations().ifPresent(request::setEnableHostGitOperations); + config.getEnableSessionStore().ifPresent(request::setEnableSessionStore); + config.getEnableSkills().ifPresent(request::setEnableSkills); + if (config.getEmbeddingCacheStorage() != null) { + request.setEmbeddingCacheStorage(config.getEmbeddingCacheStorage()); + } + request.setModelCapabilities(config.getModelCapabilities()); + + if (config.getCommands() != null && !config.getCommands().isEmpty()) { + var wireCommands = config.getCommands().stream() + .map(c -> new CommandWireDefinition(c.getName(), c.getDescription())) + .collect(java.util.stream.Collectors.toList()); + request.setCommands(wireCommands); + } + if (config.getOnElicitationRequest() != null) { + request.setRequestElicitation(true); + } + if (config.isEnableMcpApps()) { + request.setRequestMcpApps(true); + } + request.setGitHubMcpToolConfig(config.getGitHubMcpToolConfig()); + if (config.getOnExitPlanMode() != null) { + request.setRequestExitPlanMode(true); + } + if (config.getOnAutoModeSwitch() != null) { + request.setRequestAutoModeSwitch(true); + } + request.setGitHubToken(config.getGitHubToken()); + request.setRemoteSession(config.getRemoteSession()); + request.setCloud(config.getCloud()); + request.setExpAssignments(config.getExpAssignments()); + config.getEnableManagedSettings().ifPresent(request::setEnableManagedSettings); + request.setManagedSettings(config.getManagedSettings()); + + return request; + } + + /** + * Builds a CreateSessionRequest from the given configuration. + * + * @param config + * the session configuration (may be null) + * @return the built request object + * @deprecated Use {@link #buildCreateRequest(SessionConfig, String)} instead. + */ + @Deprecated + static CreateSessionRequest buildCreateRequest(SessionConfig config) { + String sessionId = (config != null && config.getSessionId() != null) + ? config.getSessionId() + : java.util.UUID.randomUUID().toString(); + return buildCreateRequest(config, sessionId); + } + + /** + * Builds a ResumeSessionRequest from the given session ID and configuration. + * + * @param sessionId + * the ID of the session to resume + * @param config + * the resume configuration (may be null) + * @return the built request object + */ + static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionConfig config) { + return buildResumeRequest(sessionId, config, CopilotClientMode.COPILOT_CLI); + } + + static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionConfig config, + CopilotClientMode mode) { + var request = new ResumeSessionRequest(); + request.setSessionId(sessionId); + // Always request permission callbacks to enable deny-by-default behavior + request.setRequestPermission(true); + // Always send envValueMode=direct for MCP servers + request.setEnvValueMode("direct"); + + if (config == null) { + request.setCustomAgentsLocalOnly(resolveCustomAgentsLocalOnly(null, mode)); + return request; + } + + request.setModel(config.getModel()); + request.setClientName(config.getClientName()); + request.setReasoningEffort(config.getReasoningEffort()); + request.setReasoningSummary(config.getReasoningSummary()); + request.setContextTier(config.getContextTier()); + request.setTools(config.getTools()); + request.setSystemMessage(config.getSystemMessage()); + request.setAvailableTools(config.getAvailableTools()); + request.setExcludedTools(config.getExcludedTools()); + request.setExcludedBuiltInAgents(config.getExcludedBuiltInAgents()); + request.setProvider(config.getProvider()); + request.setCapi(config.getCapi()); + request.setProviders(config.getProviders()); + request.setModels(config.getModels()); + config.getEnableSessionTelemetry().ifPresent(request::setEnableSessionTelemetry); + config.getEnableCitations().ifPresent(request::setEnableCitations); + config.getEnableFileChangeTracking().ifPresent(request::setEnableFileChangeTracking); + request.setSessionLimits(config.getSessionLimits()); + experimentalModeForMode(mode, config.getEnableExperimentalMode().orElse(null)) + .ifPresent(request::setIsExperimentalMode); + if (config.getOnUserInputRequest() != null) { + request.setRequestUserInput(true); + } + if (config.getHooks() != null && config.getHooks().hasHooks()) { + request.setHooks(true); + } + request.setWorkingDirectory(config.getWorkingDirectory()); + request.setAdditionalDirectories(config.getAdditionalDirectories()); + request.setConfigDirectory(config.getConfigDirectory()); + config.getEnableConfigDiscovery().ifPresent(request::setEnableConfigDiscovery); + config.getSkipEmbeddingRetrieval().ifPresent(request::setSkipEmbeddingRetrieval); + if (config.getOrganizationCustomInstructions() != null) { + request.setOrganizationCustomInstructions(config.getOrganizationCustomInstructions()); + } + config.getEnableOnDemandInstructionDiscovery().ifPresent(request::setEnableOnDemandInstructionDiscovery); + config.getEnableFileHooks().ifPresent(request::setEnableFileHooks); + config.getEnableHostGitOperations().ifPresent(request::setEnableHostGitOperations); + config.getEnableSessionStore().ifPresent(request::setEnableSessionStore); + config.getEnableSkills().ifPresent(request::setEnableSkills); + if (config.getEmbeddingCacheStorage() != null) { + request.setEmbeddingCacheStorage(config.getEmbeddingCacheStorage()); + } + if (config.isDisableResume()) { + request.setDisableResume(true); + } + if (config.isStreaming()) { + request.setStreaming(true); + } + config.getIncludeSubAgentStreamingEvents().ifPresent(request::setIncludeSubAgentStreamingEvents); + request.setMcpServers(config.getMcpServers()); + request.setMcpOAuthTokenStorage(config.getMcpOAuthTokenStorage()); + request.setCustomAgents(config.getCustomAgents()); + request.setCustomAgentsLocalOnly( + resolveCustomAgentsLocalOnly(config.getCustomAgentsLocalOnly().orElse(null), mode)); + request.setDefaultAgent(config.getDefaultAgent()); + request.setAgent(config.getAgent()); + request.setSkillDirectories(config.getSkillDirectories()); + request.setInstructionDirectories(config.getInstructionDirectories()); + request.setPluginDirectories(config.getPluginDirectories()); + request.setLargeOutput(config.getLargeOutput()); + request.setToolSearch(config.getToolSearch()); + request.setMemory(config.getMemory()); + request.setDisabledSkills(config.getDisabledSkills()); + request.setDisabledMcpServers(config.getDisabledMcpServers()); + request.setInfiniteSessions(config.getInfiniteSessions()); + request.setModelCapabilities(config.getModelCapabilities()); + + if (config.getCommands() != null && !config.getCommands().isEmpty()) { + var wireCommands = config.getCommands().stream() + .map(c -> new CommandWireDefinition(c.getName(), c.getDescription())) + .collect(java.util.stream.Collectors.toList()); + request.setCommands(wireCommands); + } + if (config.getOnElicitationRequest() != null) { + request.setRequestElicitation(true); + } + if (config.isEnableMcpApps()) { + request.setRequestMcpApps(true); + } + request.setGitHubMcpToolConfig(config.getGitHubMcpToolConfig()); + if (config.getOnExitPlanMode() != null) { + request.setRequestExitPlanMode(true); + } + if (config.getOnAutoModeSwitch() != null) { + request.setRequestAutoModeSwitch(true); + } + request.setGitHubToken(config.getGitHubToken()); + request.setRemoteSession(config.getRemoteSession()); + request.setExpAssignments(config.getExpAssignments()); + config.getEnableManagedSettings().ifPresent(request::setEnableManagedSettings); + request.setManagedSettings(config.getManagedSettings()); + + return request; + } + + private static Boolean resolveCustomAgentsLocalOnly(Boolean customAgentsLocalOnly, CopilotClientMode mode) { + if (customAgentsLocalOnly != null) { + return customAgentsLocalOnly; + } + return mode == CopilotClientMode.EMPTY ? true : null; + } + + private static Optional experimentalModeForMode(CopilotClientMode mode, Boolean supplied) { + if (mode == CopilotClientMode.EMPTY) { + return Optional.of(supplied != null ? supplied : false); + } + return Optional.ofNullable(supplied); + } + + /** + * Configures a session with handlers from the given config. + * + * @param session + * the session to configure + * @param config + * the session configuration + */ + static void configureSession(CopilotSession session, SessionConfig config) { + if (config == null) { + return; + } + + if (config.getTools() != null) { + session.registerTools(config.getTools()); + } + if (config.getOnPermissionRequest() != null) { + session.registerPermissionHandler(config.getOnPermissionRequest()); + } + session.setManagedSettingsEnabled( + config.getEnableManagedSettings().orElse(false) || config.getManagedSettings() != null); + if (config.getOnMcpAuthRequest() != null) { + session.registerMcpAuthHandler(config.getOnMcpAuthRequest()); + } + if (config.getOnUserInputRequest() != null) { + session.registerUserInputHandler(config.getOnUserInputRequest()); + } + if (config.getHooks() != null) { + session.registerHooks(config.getHooks()); + } + if (config.getCommands() != null) { + session.registerCommands(config.getCommands()); + } + if (config.getOnElicitationRequest() != null) { + session.registerElicitationHandler(config.getOnElicitationRequest()); + } + Map bearerTokenProviders = collectBearerTokenProviders(config.getProvider(), + config.getProviders()); + if (!bearerTokenProviders.isEmpty()) { + session.registerBearerTokenProviders(bearerTokenProviders); + } + if (config.getOnExitPlanMode() != null) { + session.registerExitPlanModeHandler(config.getOnExitPlanMode()); + } + if (config.getOnAutoModeSwitch() != null) { + session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch()); + } + if (config.getOnEvent() != null) { + session.on(config.getOnEvent()); + } + } + + /** + * Configures a resumed session with handlers from the given config. + * + * @param session + * the session to configure + * @param config + * the resume session configuration + */ + static void configureSession(CopilotSession session, ResumeSessionConfig config) { + if (config == null) { + return; + } + + if (config.getTools() != null) { + session.registerTools(config.getTools()); + } + if (config.getOnPermissionRequest() != null) { + session.registerPermissionHandler(config.getOnPermissionRequest()); + } + session.setManagedSettingsEnabled( + config.getEnableManagedSettings().orElse(false) || config.getManagedSettings() != null); + if (config.getOnMcpAuthRequest() != null) { + session.registerMcpAuthHandler(config.getOnMcpAuthRequest()); + } + if (config.getOnUserInputRequest() != null) { + session.registerUserInputHandler(config.getOnUserInputRequest()); + } + if (config.getHooks() != null) { + session.registerHooks(config.getHooks()); + } + if (config.getCommands() != null) { + session.registerCommands(config.getCommands()); + } + if (config.getOnElicitationRequest() != null) { + session.registerElicitationHandler(config.getOnElicitationRequest()); + } + Map bearerTokenProviders = collectBearerTokenProviders(config.getProvider(), + config.getProviders()); + if (!bearerTokenProviders.isEmpty()) { + session.registerBearerTokenProviders(bearerTokenProviders); + } + if (config.getOnExitPlanMode() != null) { + session.registerExitPlanModeHandler(config.getOnExitPlanMode()); + } + if (config.getOnAutoModeSwitch() != null) { + session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch()); + } + if (config.getOnEvent() != null) { + session.on(config.getOnEvent()); + } + } + + private static Map collectBearerTokenProviders(ProviderConfig provider, + List providers) { + Map bearerTokenProviders = new HashMap<>(); + if (provider != null && provider.getBearerTokenProvider() != null) { + bearerTokenProviders.put("default", provider.getBearerTokenProvider()); + } + if (providers != null) { + for (NamedProviderConfig namedProvider : providers) { + if (namedProvider != null && namedProvider.getName() != null + && namedProvider.getBearerTokenProvider() != null) { + bearerTokenProviders.put(namedProvider.getName(), namedProvider.getBearerTokenProvider()); + } + } + } + return bearerTokenProviders; + } +} diff --git a/java/src/main/java/com/github/copilot/SystemMessageMode.java b/java/sdk/src/main/java/com/github/copilot/SystemMessageMode.java similarity index 98% rename from java/src/main/java/com/github/copilot/SystemMessageMode.java rename to java/sdk/src/main/java/com/github/copilot/SystemMessageMode.java index d693535f9..4e90dca36 100644 --- a/java/src/main/java/com/github/copilot/SystemMessageMode.java +++ b/java/sdk/src/main/java/com/github/copilot/SystemMessageMode.java @@ -42,7 +42,7 @@ public enum SystemMessageMode { * default system prompt. An optional {@code content} string is appended after * all sections when provided. * - * @since 1.2.0 + * @since 1.0.0 */ CUSTOMIZE("customize"); diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/FfiOutputStream.java b/java/sdk/src/main/java/com/github/copilot/ffi/FfiOutputStream.java new file mode 100644 index 000000000..4198f08f0 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/FfiOutputStream.java @@ -0,0 +1,63 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.io.IOException; +import java.io.OutputStream; +import java.util.Arrays; +import java.util.Objects; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.locks.ReentrantLock; + +final class FfiOutputStream extends OutputStream { + + private final NativeBinding nativeBinding; + private final AtomicInteger connectionId; + private final AtomicBoolean closing; + private final ReentrantLock operationLock; + + FfiOutputStream(NativeBinding nativeBinding, AtomicInteger connectionId, AtomicBoolean closing, + ReentrantLock operationLock) { + this.nativeBinding = Objects.requireNonNull(nativeBinding, "nativeBinding must not be null"); + this.connectionId = Objects.requireNonNull(connectionId, "connectionId must not be null"); + this.closing = Objects.requireNonNull(closing, "closing must not be null"); + this.operationLock = Objects.requireNonNull(operationLock, "operationLock must not be null"); + } + + @Override + public void write(int b) throws IOException { + write(new byte[]{(byte) b}, 0, 1); + } + + @Override + public void write(byte[] b, int off, int len) throws IOException { + Objects.requireNonNull(b, "buffer must not be null"); + if (off < 0 || len < 0 || off + len > b.length) { + throw new IndexOutOfBoundsException("Invalid off/len for buffer of length " + b.length); + } + if (len == 0) { + return; + } + + operationLock.lock(); + try { + if (closing.get()) { + throw new IOException("The in-process runtime connection is closed."); + } + int id = connectionId.get(); + if (id == 0) { + throw new IOException("The in-process runtime connection is closed."); + } + + byte[] payload = (off == 0 && len == b.length) ? b : Arrays.copyOfRange(b, off, off + len); + if (!nativeBinding.connectionWrite(id, payload, payload.length)) { + throw new IOException("Failed to write a frame to the in-process runtime connection."); + } + } finally { + operationLock.unlock(); + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/FfiRuntimeHost.java b/java/sdk/src/main/java/com/github/copilot/ffi/FfiRuntimeHost.java new file mode 100644 index 000000000..5e7d2d461 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/FfiRuntimeHost.java @@ -0,0 +1,347 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.locks.ReentrantLock; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.CopilotClientOptions; + +import com.sun.jna.Pointer; + +/** + * Manages the in-process FFI runtime lifecycle. + */ +public final class FfiRuntimeHost implements AutoCloseable { + + private static final Logger LOG = Logger.getLogger(FfiRuntimeHost.class.getName()); + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private final NativeBinding nativeBinding; + private final QueueInputStream receiveStream; + private final AtomicBoolean closing = new AtomicBoolean(false); + private final AtomicBoolean disposed = new AtomicBoolean(false); + private final AtomicInteger serverId = new AtomicInteger(0); + private final AtomicInteger connectionId = new AtomicInteger(0); + private final AtomicInteger activeCallbacks = new AtomicInteger(0); + private final Object callbackDrainMonitor = new Object(); + private final ReentrantLock operationLock = new ReentrantLock(); + private final FfiOutputStream sendStream; + private final String libraryPath; + + private volatile OutboundCallback callbackRef; + + /** + * Creates an FFI runtime host using the resolved bundled native library. + * + * @throws IOException + * if the runtime library cannot be resolved + */ + public FfiRuntimeHost() throws IOException { + this(resolveLibraryPath(), null, new QueueInputStream()); + } + + FfiRuntimeHost(NativeBinding nativeBinding, String libraryPath) { + this(nativeBinding, libraryPath, new QueueInputStream()); + } + + FfiRuntimeHost(NativeBinding nativeBinding, String libraryPath, QueueInputStream receiveStream) { + this.nativeBinding = Objects.requireNonNull(nativeBinding, "nativeBinding must not be null"); + this.receiveStream = Objects.requireNonNull(receiveStream, "receiveStream must not be null"); + this.sendStream = new FfiOutputStream(this.nativeBinding, this.connectionId, this.closing, this.operationLock); + this.libraryPath = libraryPath; + } + + private FfiRuntimeHost(Path libraryPath, NativeBinding nativeBinding, QueueInputStream receiveStream) { + this(nativeBinding == null ? new JnaNativeBinding(libraryPath) : nativeBinding, libraryPath.toString(), + receiveStream); + } + + private static Path resolveLibraryPath() throws IOException { + return NativeRuntimeLoader.resolve(); + } + + /** + * Starts the in-process runtime and opens a connection. + * + * @param entrypointPath + * runtime entrypoint path passed in {@code argv_json} + * @param options + * client options used to construct {@code argv_json} and + * {@code env_json} + */ + public void start(String entrypointPath, CopilotClientOptions options) { + Objects.requireNonNull(entrypointPath, "entrypointPath must not be null"); + Objects.requireNonNull(options, "options must not be null"); + if (disposed.get()) { + throw new IllegalStateException("FfiRuntimeHost is already closed."); + } + if (serverId.get() != 0 || connectionId.get() != 0) { + throw new IllegalStateException("FfiRuntimeHost has already been started."); + } + + byte[] argvJson = buildArgvJson(entrypointPath, options); + byte[] envJson = buildEnvJson(options); + int hostHandle = runHostStartOnBlockingThread(argvJson, envJson); + if (hostHandle == 0) { + String lib = libraryPath != null ? libraryPath : ""; + throw new IllegalStateException( + "copilot_runtime_host_start failed (library '" + lib + "', entrypoint '" + entrypointPath + "')."); + } + + // Hold operationLock while publishing handles to serialize with close(). + // Recheck disposed in case close() ran while hostStart was blocking. + operationLock.lock(); + try { + if (disposed.get()) { + try { + nativeBinding.hostShutdown(hostHandle); + } catch (Throwable ignored) { + // Best effort + } + throw new IllegalStateException("FfiRuntimeHost was closed during startup."); + } + serverId.set(hostHandle); + + OutboundCallback callback = createOutboundCallback(); + callbackRef = callback; + int connHandle = nativeBinding.connectionOpen(hostHandle, callback, Pointer.NULL, null, 0, null, 0, null, + 0); + if (connHandle == 0) { + try { + nativeBinding.hostShutdown(hostHandle); + } catch (Throwable ignored) { + // Best effort + } + serverId.set(0); + callbackRef = null; + throw new IllegalStateException("copilot_runtime_connection_open failed."); + } + connectionId.set(connHandle); + LOG.fine(() -> "Started FFI runtime host. Library=" + libraryPath + ", serverId=" + hostHandle + + ", connectionId=" + connHandle); + } finally { + operationLock.unlock(); + } + } + + public InputStream getReceiveStream() { + return receiveStream; + } + + public OutputStream getSendStream() { + return sendStream; + } + + @Override + public void close() { + if (!disposed.compareAndSet(false, true)) { + return; + } + + closing.set(true); + + operationLock.lock(); + try { + int connHandle = connectionId.getAndSet(0); + if (connHandle != 0) { + try { + nativeBinding.connectionClose(connHandle); + } catch (Throwable t) { + LOG.log(Level.FINE, "Failed to close FFI connection", t); + } + } + } finally { + operationLock.unlock(); + } + + drainActiveCallbacks(); + + int hostHandle = serverId.getAndSet(0); + if (hostHandle != 0) { + try { + nativeBinding.hostShutdown(hostHandle); + } catch (Throwable t) { + LOG.log(Level.FINE, "Failed to shut down FFI host", t); + } + } + + try { + receiveStream.close(); + } catch (Throwable ignored) { + // never throw from close + } + + callbackRef = null; + } + + private void drainActiveCallbacks() { + while (activeCallbacks.get() > 0) { + synchronized (callbackDrainMonitor) { + if (activeCallbacks.get() == 0) { + return; + } + try { + callbackDrainMonitor.wait(10L); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + return; + } + } + } + } + + private OutboundCallback createOutboundCallback() { + return (userData, data, len) -> { + if (closing.get()) { + return; + } + activeCallbacks.incrementAndGet(); + try { + int length = len.intValue(); + if (closing.get() || data == null || length <= 0) { + return; + } + byte[] bytes = data.getByteArray(0, length); + if (!closing.get()) { + receiveStream.enqueue(bytes); + } + } catch (Throwable t) { + LOG.log(Level.WARNING, "Exception in FFI outbound callback", t); + } finally { + if (activeCallbacks.decrementAndGet() == 0) { + synchronized (callbackDrainMonitor) { + callbackDrainMonitor.notifyAll(); + } + } + } + }; + } + + private int runHostStartOnBlockingThread(byte[] argvJson, byte[] envJson) { + ReaderThreadFactory readerThreadFactory = new ReaderThreadFactory(); + ExecutorService executor = Executors + .newSingleThreadExecutor(runnable -> readerThreadFactory.create(runnable, "copilot-ffi-host-start")); + try { + Future future = executor.submit(() -> nativeBinding.hostStart(argvJson, argvJson.length, envJson, + envJson == null ? 0 : envJson.length)); + return future.get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new IllegalStateException("Interrupted while starting in-process runtime host.", e); + } catch (ExecutionException e) { + Throwable cause = e.getCause(); + if (cause instanceof RuntimeException runtimeException) { + throw runtimeException; + } + throw new IllegalStateException("Failed to start in-process runtime host.", cause); + } finally { + executor.shutdownNow(); + try { + executor.awaitTermination(5, TimeUnit.SECONDS); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + } + } + + private static byte[] buildArgvJson(String entrypointPath, CopilotClientOptions options) { + List argv = new ArrayList<>(); + if (entrypointPath.toLowerCase().endsWith(".js")) { + argv.add("node"); + } + argv.add(entrypointPath); + argv.add("--embedded-host"); + argv.add("--no-auto-update"); + + String logLevel = options.getLogLevel(); + if (logLevel != null && !logLevel.isBlank()) { + argv.add("--log-level"); + argv.add(logLevel); + } + + String gitHubToken = options.getGitHubToken(); + if (gitHubToken != null && !gitHubToken.isEmpty()) { + argv.add("--auth-token-env"); + argv.add("COPILOT_SDK_AUTH_TOKEN"); + } + + boolean useLoggedInUser = options.getUseLoggedInUser().orElse(gitHubToken == null || gitHubToken.isEmpty()); + if (!useLoggedInUser) { + argv.add("--no-auto-login"); + } + + if (options.getSessionIdleTimeoutSeconds().isPresent() + && options.getSessionIdleTimeoutSeconds().getAsInt() > 0) { + argv.add("--session-idle-timeout"); + argv.add(String.valueOf(options.getSessionIdleTimeoutSeconds().getAsInt())); + } + + if (options.isRemote()) { + argv.add("--remote"); + } + + String[] cliArgs = options.getCliArgs(); + if (cliArgs != null && cliArgs.length > 0) { + for (String arg : cliArgs) { + if (arg != null && !arg.isBlank()) { + argv.add(arg); + } + } + } + + return jsonBytes(argv); + } + + private static byte[] buildEnvJson(CopilotClientOptions options) { + Map env = new LinkedHashMap<>(); + + String token = options.getGitHubToken(); + if (token != null && !token.isEmpty()) { + env.put("COPILOT_SDK_AUTH_TOKEN", token); + } + String copilotHome = options.getCopilotHome(); + if (copilotHome != null && !copilotHome.isEmpty()) { + env.put("COPILOT_HOME", copilotHome); + } + if (options.getMode() == CopilotClientMode.EMPTY) { + env.put("COPILOT_DISABLE_KEYTAR", "1"); + } + + if (env.isEmpty()) { + return null; + } + return jsonBytes(env); + } + + private static byte[] jsonBytes(Object value) { + try { + return MAPPER.writeValueAsString(value).getBytes(StandardCharsets.UTF_8); + } catch (JsonProcessingException e) { + throw new IllegalStateException("Failed to serialize FFI JSON parameter.", e); + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/JnaNativeBinding.java b/java/sdk/src/main/java/com/github/copilot/ffi/JnaNativeBinding.java new file mode 100644 index 000000000..ba3c3c40a --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/JnaNativeBinding.java @@ -0,0 +1,295 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import com.sun.jna.Library; +import com.sun.jna.Native; +import com.sun.jna.Pointer; + +import java.nio.file.Path; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Logger; + +/** + * JNA-backed implementation of {@link NativeBinding}. + * + *

+ * Loads the {@code runtime.node} native library by absolute path and delegates + * each {@link NativeBinding} method to the corresponding + * {@code copilot_runtime_*} C ABI export. + * + *

Library-never-unloads pattern

+ *

+ * The loaded JNA library handle is held in a {@code static} field and is never + * released. Native worker threads spawned by the runtime outlive any individual + * {@code FfiRuntimeHost} instance; unloading the library while those threads + * are active would cause a crash. This mirrors the Rust runtime's own + * {@code OnceLock>>} pattern. + * + *

Duplicate-load guard

+ *

+ * Loading a library from a different absolute path in the same JVM + * process is rejected with {@link IllegalStateException}. Loading from the + * same path more than once is silently accepted. + * + *

Active-callback tracking

+ *

+ * The {@link #activeCallbacks} counter is incremented when the native runtime + * enters the outbound callback and decremented when the callback returns. + * Callers (e.g. {@code FfiRuntimeHost}) must drain this counter to zero before + * calling {@link #connectionClose} or {@link #hostShutdown}. + * + *

Callback lifetime

+ *

+ * The native runtime can invoke an outbound callback after connection close and + * host shutdown return. Each JNA callback wrapper is therefore retained for the + * lifetime of the JVM. After host shutdown, its Java delegate is detached so a + * late native invocation safely becomes a no-op without retaining the complete + * host object graph. + * + *

GraalVM Native Image

+ *

+ * JNA callback upcalls are not supported under GraalVM Native Image. InProcess + * transport is not available in native-image executables; use subprocess + * transport instead. + */ +final class JnaNativeBinding implements NativeBinding { + + private static final Logger LOG = Logger.getLogger(JnaNativeBinding.class.getName()); + + /** + * JNA inner interface mapping the five {@code copilot_runtime_*} C ABI exports. + */ + interface CopilotRuntimeLibrary extends Library { + /** Corresponds to {@code copilot_runtime_host_start}. */ + int copilot_runtime_host_start(byte[] argvJson, SizeT argvJsonLen, byte[] envJson, SizeT envJsonLen); + + /** + * Corresponds to {@code copilot_runtime_host_shutdown}. + * + *

+ * Returns {@code byte} (not Java {@code boolean}) because the Rust ABI exports + * a one-byte {@code bool}. JNA maps Java {@code boolean} as a 32-bit C + * {@code int}, which would read three extra bytes. + */ + byte copilot_runtime_host_shutdown(int serverId); + + /** Corresponds to {@code copilot_runtime_connection_open}. */ + int copilot_runtime_connection_open(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + SizeT extSourceLen, byte[] extName, SizeT extNameLen, byte[] connToken, SizeT connTokenLen); + + /** + * Corresponds to {@code copilot_runtime_connection_write}. + * + * @see #copilot_runtime_host_shutdown for why this returns {@code byte} + */ + byte copilot_runtime_connection_write(int connectionId, byte[] data, SizeT dataLen); + + /** + * Corresponds to {@code copilot_runtime_connection_close}. + * + * @see #copilot_runtime_host_shutdown for why this returns {@code byte} + */ + byte copilot_runtime_connection_close(int connectionId); + } + + // ------------------------------------------------------------------------- + // Process-wide singleton — never unloaded + // ------------------------------------------------------------------------- + + private static final Object LOAD_LOCK = new Object(); + + /** Absolute path of the library that was first loaded into this JVM process. */ + private static volatile Path loadedPath; + + /** The loaded JNA library interface. Never released after first set. */ + private static volatile CopilotRuntimeLibrary loadedLib; + + /** + * Process-lifetime roots for JNA callback trampolines. Native code can invoke a + * callback after connection and host teardown return, so entries are never + * removed in production. + */ + private static final Set RETAINED_CALLBACKS = ConcurrentHashMap.newKeySet(); + + // ------------------------------------------------------------------------- + // Instance state + // ------------------------------------------------------------------------- + + /** + * The library interface used by this instance for all delegated calls. + * + *

+ * For the production path ({@link #JnaNativeBinding(Path)}), this is always the + * same object as {@link #loadedLib} (the static singleton). For the test path + * ({@link #JnaNativeBinding(CopilotRuntimeLibrary)}), this may be a stub or + * mock without modifying the static singleton. + */ + private final CopilotRuntimeLibrary lib; + + /** + * Count of callbacks currently executing on native threads. Must reach zero + * before {@link #connectionClose} or {@link #hostShutdown} is called. + */ + final AtomicInteger activeCallbacks = new AtomicInteger(0); + + /** + * Callback registrations keyed by connection handle. + *

+ * Registrations remain here through connection close because native callbacks + * can still arrive. Successful host shutdown detaches their Java delegates; the + * wrappers themselves remain rooted by {@link #RETAINED_CALLBACKS}. + */ + private final Map callbackRegistrations = new ConcurrentHashMap<>(); + + private static final class CallbackRegistration { + private final int serverId; + private final AtomicReference delegate; + private final AtomicInteger activeCallbacks; + private final OutboundCallback wrapper; + + private CallbackRegistration(int serverId, OutboundCallback delegate, AtomicInteger activeCallbacks) { + this.serverId = serverId; + this.delegate = new AtomicReference<>(delegate); + this.activeCallbacks = activeCallbacks; + this.wrapper = this::invoke; + } + + private void invoke(Pointer userData, Pointer data, SizeT len) { + activeCallbacks.incrementAndGet(); + try { + OutboundCallback callback = delegate.get(); + if (callback != null) { + callback.invoke(userData, data, len); + } + } finally { + activeCallbacks.decrementAndGet(); + } + } + + private void detach() { + delegate.set(null); + } + } + + // ------------------------------------------------------------------------- + // Constructors + // ------------------------------------------------------------------------- + + /** + * Loads (or re-uses) the native library at the given absolute path. + * + * @param libraryPath + * absolute path to the {@code runtime.node} native library + * @throws IllegalStateException + * if a different library path has already been loaded in + * this JVM process + */ + JnaNativeBinding(Path libraryPath) { + Path absPath = libraryPath.toAbsolutePath().normalize(); + synchronized (LOAD_LOCK) { + if (loadedLib == null) { + LOG.fine(() -> "Loading native library from: " + absPath); + try { + loadedLib = Native.load(absPath.toString(), CopilotRuntimeLibrary.class); + } catch (UnsatisfiedLinkError e) { + throw new IllegalStateException("Failed to load native library from '" + absPath + "'", e); + } + loadedPath = absPath; + LOG.fine(() -> "Native library loaded: " + absPath); + } else if (!absPath.equals(loadedPath)) { + throw new IllegalStateException("An in-process FFI runtime library is already loaded from '" + + loadedPath + "'; loading a different library from '" + absPath + + "' in the same process is not supported."); + } + } + this.lib = loadedLib; + } + + /** + * Testing constructor — accepts a pre-built {@link CopilotRuntimeLibrary} + * directly, bypassing disk I/O and the static singleton guard. + * + *

+ * This constructor is package-private and intended solely for unit tests. + * + * @param library + * a {@link CopilotRuntimeLibrary} stub or mock for testing + */ + JnaNativeBinding(CopilotRuntimeLibrary library) { + // Testing seam — skip the static singleton guard. + this.lib = library; + } + + // ------------------------------------------------------------------------- + // NativeBinding delegation + // ------------------------------------------------------------------------- + + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return lib.copilot_runtime_host_start(argvJson, new SizeT(argvJsonLen), envJson, new SizeT(envJsonLen)); + } + + @Override + public boolean hostShutdown(int serverId) { + boolean shutdown = lib.copilot_runtime_host_shutdown(serverId) != 0; + if (shutdown) { + callbackRegistrations.forEach((connectionId, registration) -> { + if (registration.serverId == serverId && callbackRegistrations.remove(connectionId, registration)) { + registration.detach(); + } + }); + } + return shutdown; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + CallbackRegistration registration = new CallbackRegistration(serverId, callback, activeCallbacks); + int connectionId = lib.copilot_runtime_connection_open(serverId, registration.wrapper, userData, extSource, + new SizeT(extSourceLen), extName, new SizeT(extNameLen), connToken, new SizeT(connTokenLen)); + if (connectionId != 0) { + RETAINED_CALLBACKS.add(registration.wrapper); + callbackRegistrations.put(connectionId, registration); + } + return connectionId; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return lib.copilot_runtime_connection_write(connectionId, data, new SizeT(dataLen)) != 0; + } + + @Override + public boolean connectionClose(int connectionId) { + return lib.copilot_runtime_connection_close(connectionId) != 0; + } + + // ------------------------------------------------------------------------- + // Testing support + // ------------------------------------------------------------------------- + + /** + * Resets the process-wide static state for unit tests. + * + *

+ * Must only be called from test code. Resets + * {@link #loadedPath} and {@link #loadedLib} so that a subsequent + * {@link #JnaNativeBinding(Path)} call can load a different library. In + * production, the library is never unloaded. + */ + static void resetForTesting() { + synchronized (LOAD_LOCK) { + loadedPath = null; + loadedLib = null; + RETAINED_CALLBACKS.clear(); + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/NativeBinding.java b/java/sdk/src/main/java/com/github/copilot/ffi/NativeBinding.java new file mode 100644 index 000000000..3aa8ca9e4 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/NativeBinding.java @@ -0,0 +1,131 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import com.sun.jna.Pointer; + +/** + * Internal abstraction over the Copilot runtime C ABI. + * + *

+ * Defines the five {@code extern "C"} entry points exposed by the native + * {@code runtime.node} library. The JNA-backed implementation + * ({@link JnaNativeBinding}) delegates to these through JNA. A future FFM + * implementation may be substituted via the multi-release JAR mechanism without + * changing callers. + * + *

+ * All classes in {@code com.github.copilot.ffi} are internal; consumers must + * not reference them directly. + * + *

C ABI entry points

+ *
    + *
  • {@code copilot_runtime_host_start} — start the runtime host
    • + *
  • {@code copilot_runtime_host_shutdown} — shut down the runtime host
    • + *
  • {@code copilot_runtime_connection_open} — open a bidirectional + * connection
    • + *
  • {@code copilot_runtime_connection_write} — write a JSON-RPC frame to the + * runtime
    • + *
  • {@code copilot_runtime_connection_close} — close a connection
    • + *
+ * + *

Wire format

+ *

+ * All frames use LSP {@code Content-Length} header framing, identical to the + * stdio transport. No special encoding or decoding is needed at the FFI + * boundary. + */ +interface NativeBinding { + + /** + * Starts the runtime host. + * + *

+ * Blocks for up to ~30 s while the worker boots and connects back. Must not be + * called on an async/reactive executor thread. + * + * @param argvJson + * UTF-8 JSON array of strings: the entrypoint and required flags + * @param argvJsonLen + * byte length of {@code argvJson} + * @param envJson + * UTF-8 JSON object of environment overrides, or {@code null} when + * empty + * @param envJsonLen + * byte length of {@code envJson}, or {@code 0} when {@code envJson} + * is null + * @return server handle ({@code 0} on failure) + */ + int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen); + + /** + * Shuts down the runtime host. + * + * @param serverId + * non-zero server handle returned by {@link #hostStart} + * @return {@code true} on success + */ + boolean hostShutdown(int serverId); + + /** + * Opens a bidirectional connection and registers the outbound data callback. + * + *

+ * The {@code extSource}, {@code extName}, and {@code connToken} parameters are + * reserved extension points. All current SDK implementations pass + * {@code null}/0 for all three. + * + * @param serverId + * non-zero server handle returned by {@link #hostStart} + * @param callback + * JNA callback invoked by the runtime on native threads when + * outbound data is available; must be held as a strong reference by + * the caller + * @param userData + * opaque cookie passed back to {@code callback} unchanged; pass + * {@link Pointer#NULL} + * @param extSource + * reserved; pass {@code null} + * @param extSourceLen + * byte length of {@code extSource}; pass {@code 0} + * @param extName + * reserved; pass {@code null} + * @param extNameLen + * byte length of {@code extName}; pass {@code 0} + * @param connToken + * reserved; pass {@code null} + * @param connTokenLen + * byte length of {@code connToken}; pass {@code 0} + * @return connection handle ({@code 0} on failure) + */ + int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, int extSourceLen, + byte[] extName, int extNameLen, byte[] connToken, int connTokenLen); + + /** + * Writes a JSON-RPC frame to the runtime. + * + *

+ * The native side copies the buffer synchronously before returning; the byte + * array does not need to survive past this call. + * + * @param connectionId + * non-zero connection handle returned by {@link #connectionOpen} + * @param data + * frame bytes + * @param dataLen + * byte length of {@code data} + * @return {@code true} on success + */ + boolean connectionWrite(int connectionId, byte[] data, int dataLen); + + /** + * Closes a connection. + * + * @param connectionId + * non-zero connection handle returned by {@link #connectionOpen} + * @return {@code true} on success + */ + boolean connectionClose(int connectionId); +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/NativeRuntimeLoader.java b/java/sdk/src/main/java/com/github/copilot/ffi/NativeRuntimeLoader.java new file mode 100644 index 000000000..d2d06eb06 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/NativeRuntimeLoader.java @@ -0,0 +1,504 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.nio.channels.FileChannel; +import java.nio.file.AtomicMoveNotSupportedException; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.StandardOpenOption; +import java.util.Properties; + +/** + * Locates the {@code runtime.node} native binary, extracts it to a versioned + * cache directory, and returns the filesystem path for JNA to load. + * + *

+ * Resolution order: + *

    + *
  1. {@code COPILOT_CLI_PATH} — checks for + * {@code runtime.node} alongside the configured CLI or in its npm + * {@code prebuilds/} directory before any classpath or platform + * work.
    2. + *
  2. Classpath resource + * {@code native//runtime.node} — extracted atomically to + * {@code ~/.copilot/runtime-cache////runtime.node}.
    3. + *
  3. PATH compatibility fallback — finds {@code copilot} on + * {@code PATH} and accepts only a flat sibling {@code runtime.node}. This + * fallback does not support normal npm or Homebrew installation layouts.
    4. + *
+ */ +public final class NativeRuntimeLoader { + + static final String RUNTIME_FILENAME = "runtime.node"; + static final String CLI_FILENAME = "copilot"; + static final String CLI_FILENAME_WINDOWS = "copilot.exe"; + static final String PLATFORM_PROPERTIES_FILENAME = "platform.properties"; + /** Environment variable that overrides where the runtime is loaded from. */ + public static final String COPILOT_CLI_PATH_ENV = "COPILOT_CLI_PATH"; + static final String VERSION_RESOURCE = "copilot-runtime.properties"; + + /** + * Abstraction for the atomic publish step, enabling deterministic failure + * injection in tests while preserving {@link StandardCopyOption#ATOMIC_MOVE} in + * production. + */ + @FunctionalInterface + interface AtomicPublisher { + /** + * Atomically publishes {@code temp} to {@code cached}. + * + * @param temp + * fully-written temporary file in the same directory as + * {@code cached} + * @param cached + * intended final location + * @throws IOException + * if the move fails + */ + void publish(Path temp, Path cached) throws IOException; + } + + /** + * Production publisher: {@link Files#move} with + * {@link StandardCopyOption#ATOMIC_MOVE}. + */ + static final AtomicPublisher DEFAULT_PUBLISHER = (temp, cached) -> { + try { + Files.move(temp, cached, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING); + } catch (AtomicMoveNotSupportedException ex) { + throw new IllegalStateException("Filesystem does not support atomic moves; cannot safely publish " + + RUNTIME_FILENAME + " to " + cached, ex); + } catch (FileAlreadyExistsException ex) { + // Another process won the race — accept the winner if it is a valid file. + try { + if (isValidCachedFile(cached)) { + return; + } + } catch (IOException ignored) { + // fall through to the error below + } + throw new IllegalStateException( + "Concurrent extraction race: target already exists but is not a valid file: " + cached, ex); + } + }; + + private NativeRuntimeLoader() { + } + + /** + * Resolves the filesystem path to the {@code runtime.node} binary. + * + *

+ * Follows the three-step resolution order documented on this class. The + * returned path is guaranteed to refer to a regular, non-empty file at the time + * of return. + * + * @return absolute path to the {@code runtime.node} binary + * @throws IOException + * if the binary cannot be located or extracted + * @throws IllegalStateException + * if required resources are missing or extraction fails + */ + public static Path resolve() throws IOException { + String cliPathEnv = System.getenv(COPILOT_CLI_PATH_ENV); + Path cliOverride = resolveFromCliPath(cliPathEnv); + if (cliOverride != null) { + return cliOverride; + } + + ClassLoader loader = NativeRuntimeLoader.class.getClassLoader(); + String classifier = PlatformDetector.detectClassifier(); + String version = readVersion(loader); + Path cacheBase = defaultCacheBase(); + return resolve(null, findRuntimeOnPath(), cacheBase, loader, classifier, version); + } + + /** + * Resolves the copilot CLI executable from the same location as the bundled + * {@code runtime.node}. The CLI is used as {@code argv[0]} in + * {@code copilot_runtime_host_start} — the Rust runtime spawns it as a child + * process. + * + *

+ * This method calls {@link #resolve()} to locate {@code runtime.node}, then + * looks for the {@code copilot} executable in the same directory. Both + * artifacts are extracted from the classifier JAR together. + * + * @return absolute path to the {@code copilot} CLI executable + * @throws IOException + * if the CLI executable cannot be located + */ + public static Path resolveEntrypoint() throws IOException { + String configuredCli = System.getenv(COPILOT_CLI_PATH_ENV); + return resolveEntrypoint(configuredCli, resolve()); + } + + static Path resolveEntrypoint(String configuredCli, Path runtimePath) throws IOException { + if (configuredCli != null && !configuredCli.isBlank()) { + Path configuredPath = Path.of(configuredCli).toAbsolutePath().normalize(); + if (resolveFromCliPath(configuredCli) != null && Files.isRegularFile(configuredPath) + && Files.size(configuredPath) > 0) { + return configuredPath; + } + } + + Path parent = runtimePath.getParent(); + String cliName = isWindows() ? CLI_FILENAME_WINDOWS : CLI_FILENAME; + Path cliPath = parent.resolve(cliName); + if (Files.isRegularFile(cliPath) && Files.size(cliPath) > 0) { + return cliPath; + } + throw new IOException("Copilot CLI executable not found at " + cliPath + + " — the classifier JAR must contain both runtime.node and the copilot binary"); + } + + /** + * Reads the SDK version from the filtered {@code copilot-runtime.properties} + * resource. + * + * @return the version string + * @throws IOException + * if the resource cannot be read + * @throws IllegalStateException + * if the resource is missing or the version property is blank + */ + static String readVersion(ClassLoader loader) throws IOException { + URL resource = loader.getResource(VERSION_RESOURCE); + if (resource == null) { + throw new IllegalStateException("Missing version resource: " + VERSION_RESOURCE + + " — ensure Maven resource filtering has run (mvn process-resources)"); + } + Properties props = new Properties(); + try (InputStream in = resource.openStream()) { + props.load(in); + } + String version = props.getProperty("version"); + if (version == null || version.isBlank()) { + throw new IllegalStateException("Blank or missing 'version' property in " + VERSION_RESOURCE + + " — check Maven resource filtering configuration"); + } + return version; + } + + private static String readNativePackageVersion(ClassLoader loader, String classifier) throws IOException { + String resourcePath = "native/" + classifier + "/" + PLATFORM_PROPERTIES_FILENAME; + URL resource = loader.getResource(resourcePath); + if (resource == null) { + throw new FileNotFoundException("Native runtime metadata not found on classpath: " + resourcePath + + " — add the matching classifier JAR to the classpath"); + } + + Properties props = new Properties(); + try (InputStream in = resource.openStream()) { + props.load(in); + } + String version = props.getProperty("version"); + if (version == null || version.isBlank()) { + throw new IllegalStateException("Blank or missing 'version' property in " + resourcePath); + } + return version; + } + + /** + * Resolves the runtime binary path using the given parameters. Package-private + * to allow injection of test doubles in unit tests. + */ + static Path resolve(String cliPathEnv, Path cacheBase, ClassLoader loader, String classifier, String version) + throws IOException { + return resolve(cliPathEnv, cacheBase, loader, classifier, version, null, DEFAULT_PUBLISHER); + } + + static Path resolve(String cliPathEnv, String bundledCliPath, Path cacheBase, ClassLoader loader, String classifier, + String version) throws IOException { + Path bundledCliDir = bundledCliPath == null ? null : Path.of(bundledCliPath).toAbsolutePath().getParent(); + return resolve(cliPathEnv, cacheBase, loader, classifier, version, bundledCliDir, DEFAULT_PUBLISHER); + } + + static Path resolve(String cliPathEnv, Path cacheBase, ClassLoader loader, String classifier, String version, + Path bundledCliDir) throws IOException { + return resolve(cliPathEnv, cacheBase, loader, classifier, version, bundledCliDir, DEFAULT_PUBLISHER); + } + + static Path resolve(String cliPathEnv, Path cacheBase, ClassLoader loader, String classifier, String version, + Path bundledCliDir, AtomicPublisher publisher) throws IOException { + Path cliOverride = resolveFromCliPath(cliPathEnv); + if (cliOverride != null) { + return cliOverride; + } + + return resolveFromClasspathOrBundledCli(cacheBase, loader, classifier, version, bundledCliDir, publisher); + } + + /** + * Checks for {@code runtime.node} alongside the configured CLI. + * + *

+ * Checks, in order, the flat bundled layout ({@code runtime.node} directly next + * to the CLI) and the npm package layout + * ({@code prebuilds//runtime.node} next to the CLI), matching the + * two layouts the {@code @github/copilot-} packages may ship. + */ + static Path resolveFromCliPath(String cliPathStr) throws IOException { + if (cliPathStr == null || cliPathStr.isBlank()) { + return null; + } + Path cliPath = Path.of(cliPathStr).toAbsolutePath().normalize(); + Path parent = cliPath.getParent(); + + Path flat = parent.resolve(RUNTIME_FILENAME); + if (Files.isRegularFile(flat) && Files.size(flat) > 0) { + return flat; + } + + Path prebuilt = parent.resolve("prebuilds").resolve(PlatformDetector.detectClassifier()) + .resolve(RUNTIME_FILENAME); + if (Files.isRegularFile(prebuilt) && Files.size(prebuilt) > 0) { + return prebuilt; + } + + return null; + } + + /** + * Extracts the classpath resource {@code native//runtime.node} to + * the versioned cache directory, using an atomic publish sequence to prevent + * readers from observing a partially-written file. Uses + * {@link #DEFAULT_PUBLISHER}. + * + * @param cacheBase + * root cache directory (e.g. {@code ~/.copilot/runtime-cache}) + * @param loader + * class loader used to open the classpath resource + * @param classifier + * platform classifier (e.g. {@code linux-x64}) + * @param version + * SDK version used as part of the cache key + * @return path to the extracted {@code runtime.node} binary + * @throws IOException + * if I/O or the atomic rename fails + * @throws IllegalStateException + * if the classpath resource is missing or empty, or if the + * filesystem does not support atomic moves + */ + static Path extractToCache(Path cacheBase, ClassLoader loader, String classifier, String version) + throws IOException { + return extractToCache(cacheBase, loader, classifier, version, DEFAULT_PUBLISHER); + } + + /** + * Extracts the classpath resource to the versioned cache directory with an + * injectable publisher. Package-private for unit tests. + * + * @param cacheBase + * root cache directory + * @param loader + * class loader used to open the classpath resource + * @param classifier + * platform classifier + * @param version + * SDK version used as part of the cache key + * @param publisher + * atomic publish implementation + * @return path to the extracted {@code runtime.node} binary + * @throws IOException + * if I/O or the atomic rename fails + * @throws IllegalStateException + * if the classpath resource is missing or empty + */ + static Path extractToCache(Path cacheBase, ClassLoader loader, String classifier, String version, + AtomicPublisher publisher) throws IOException { + String resourcePath = "native/" + classifier + "/" + RUNTIME_FILENAME; + String nativeVersion = readNativePackageVersion(loader, classifier); + Path cacheDir = cacheBase.resolve(version).resolve(nativeVersion).resolve(classifier); + Path cached = cacheDir.resolve(RUNTIME_FILENAME); + + // Step 1 — fast path: return an existing valid cache entry. + if (isValidCachedFile(cached)) { + extractCliToCache(cacheDir, loader, classifier, publisher); + return cached; + } + + // Step 2 — locate the classpath resource before creating any files. + URL resource = loader.getResource(resourcePath); + if (resource == null) { + throw new FileNotFoundException("Native runtime not found on classpath: " + resourcePath + + " — add the matching classifier JAR to the classpath"); + } + + // Step 3 — ensure the cache directory exists. + Files.createDirectories(cacheDir); + + // Step 4 — write to a unique sibling temp file, then publish atomically. + Path temp = Files.createTempFile(cacheDir, "runtime-tmp-", ".node"); + try { + copyResourceToTemp(resource, resourcePath, temp); + publisher.publish(temp, cached); + } finally { + tryDelete(temp); + } + + // Step 5 — also extract the copilot CLI executable alongside runtime.node. + extractCliToCache(cacheDir, loader, classifier, publisher); + + return cached; + } + + /** + * Extracts the copilot CLI executable from the classpath to the same cache + * directory as {@code runtime.node}. Idempotent — skips extraction if already + * present and valid. + */ + static void extractCliToCache(Path cacheDir, ClassLoader loader, String classifier, AtomicPublisher publisher) + throws IOException { + String cliName = isWindows() ? CLI_FILENAME_WINDOWS : CLI_FILENAME; + String cliResourcePath = "native/" + classifier + "/" + cliName; + Path cachedCli = cacheDir.resolve(cliName); + + if (isValidCachedCli(cachedCli)) { + return; + } + + URL cliResource = loader.getResource(cliResourcePath); + if (cliResource == null) { + // CLI not on classpath — this is allowed for the COPILOT_CLI_PATH fallback + // path but will fail later in resolveEntrypoint() if InProcess is selected. + return; + } + + Files.createDirectories(cacheDir); + Path temp = Files.createTempFile(cacheDir, "cli-tmp-", ""); + try { + copyResourceToTemp(cliResource, cliResourcePath, temp); + makeExecutable(temp); + publisher.publish(temp, cachedCli); + } finally { + tryDelete(temp); + } + + if (!isValidCachedCli(cachedCli)) { + throw new IOException("Published Copilot CLI is not a non-empty executable file: " + cachedCli); + } + } + + /** + * Tries source 2 (classpath extraction) first and falls back to source 3 + * (bundled-CLI sibling) only when the classpath resource is absent. + */ + private static Path resolveFromClasspathOrBundledCli(Path cacheBase, ClassLoader loader, String classifier, + String version, Path bundledCliDir, AtomicPublisher publisher) throws IOException { + // Source 2: classpath resource. + try { + return extractToCache(cacheBase, loader, classifier, version, publisher); + } catch (FileNotFoundException ex) { + // Source 3: runtime.node alongside the bundled CLI binary. + if (bundledCliDir != null) { + Path candidate = bundledCliDir.resolve(RUNTIME_FILENAME); + try { + if (isValidCachedFile(candidate)) { + return candidate; + } + } catch (IOException ignored) { + // fall through and rethrow the original classpath error + } + } + throw ex; + } + } + + private static boolean isValidCachedFile(Path path) throws IOException { + if (!Files.isRegularFile(path)) { + return false; + } + return Files.size(path) > 0; + } + + private static boolean isValidCachedCli(Path path) throws IOException { + return isValidCachedFile(path) && (isWindows() || Files.isExecutable(path)); + } + + private static void makeExecutable(Path path) throws IOException { + if (isWindows()) { + return; + } + final boolean executableSet; + try { + executableSet = path.toFile().setExecutable(true, false); + } catch (SecurityException ex) { + throw new IOException("Failed to make Copilot CLI executable: " + path, ex); + } + if (!executableSet || !Files.isExecutable(path)) { + throw new IOException("Failed to make Copilot CLI executable: " + path); + } + } + + private static void copyResourceToTemp(URL resource, String resourcePath, Path temp) throws IOException { + try (InputStream in = resource.openStream()) { + long bytesWritten = Files.copy(in, temp, StandardCopyOption.REPLACE_EXISTING); + if (bytesWritten == 0) { + throw new IllegalStateException("Classpath resource is empty: " + resourcePath); + } + } + // Flush OS buffers to durable storage before the atomic rename. + try (FileChannel channel = FileChannel.open(temp, StandardOpenOption.WRITE)) { + channel.force(true); + } + } + + /** + * Finds the Copilot CLI executable on the {@code PATH}. + * + * @return the absolute CLI path, or {@code null} if none was found + */ + public static String findRuntimeOnPath() { + String pathValue = System.getenv("PATH"); + if (pathValue == null || pathValue.isBlank()) { + return null; + } + + String[] executableNames = isWindows() + ? new String[]{"copilot.exe", "copilot.cmd", "copilot.bat", "copilot"} + : new String[]{"copilot"}; + for (String directory : pathValue.split(java.io.File.pathSeparator)) { + if (directory.isBlank()) { + continue; + } + for (String executableName : executableNames) { + Path candidate = Path.of(directory, executableName); + if (Files.isRegularFile(candidate)) { + try { + return candidate.toRealPath().toString(); + } catch (IOException ignored) { + return candidate.toAbsolutePath().normalize().toString(); + } + } + } + } + return null; + } + + private static boolean isWindows() { + return System.getProperty("os.name", "").toLowerCase(java.util.Locale.ROOT).contains("win"); + } + + private static void tryDelete(Path path) { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + // Best-effort cleanup; an orphaned temp file in the cache directory is benign. + } + } + + private static Path defaultCacheBase() { + return Path.of(System.getProperty("user.home"), ".copilot", "runtime-cache"); + } + +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/OutboundCallback.java b/java/sdk/src/main/java/com/github/copilot/ffi/OutboundCallback.java new file mode 100644 index 000000000..597feea9e --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/OutboundCallback.java @@ -0,0 +1,46 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import com.sun.jna.Callback; +import com.sun.jna.Pointer; + +/** + * JNA callback interface for the runtime-to-Java outbound data path. + * + *

+ * The native runtime invokes this callback on a native thread when data is + * ready to be delivered to the Java side. JNA automatically attaches the native + * thread to the JVM before dispatching the callback. + * + *

+ * Buffer lifetime: The {@code data} pointer is only valid for + * the duration of the callback invocation. Implementations must copy the bytes + * out (e.g. {@code data.getByteArray(0, len)}) before returning. + * + *

+ * GC protection: Instances must be held as strong-reference + * fields for as long as native code may invoke the callback. If the instance is + * garbage-collected, the function pointer becomes dangling and the JVM will + * crash. + */ +@FunctionalInterface +interface OutboundCallback extends Callback { + + /** + * Invoked by the native runtime when outbound data is available. + * + * @param userData + * opaque cookie passed through unchanged from + * {@code copilot_runtime_connection_open}; always + * {@code Pointer.NULL} in this SDK + * @param data + * pointer to the outbound byte buffer; valid only for the duration + * of this invocation + * @param len + * byte length of the buffer pointed to by {@code data} + */ + void invoke(Pointer userData, Pointer data, SizeT len); +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/PlatformDetector.java b/java/sdk/src/main/java/com/github/copilot/ffi/PlatformDetector.java new file mode 100644 index 000000000..466cf794b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/PlatformDetector.java @@ -0,0 +1,303 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Locale; +import java.util.Map; +import java.util.Set; + +/** + * Detects the current platform and resolves the runtime classifier. + */ +public final class PlatformDetector { + private static final int ELF_HEADER_PROBE_BYTES = 2048; + private static final int ELF_MAGIC_0 = 0x7F; + private static final int ELF_MAGIC_1 = 'E'; + private static final int ELF_MAGIC_2 = 'L'; + private static final int ELF_MAGIC_3 = 'F'; + private static final int ELF_CLASS_32 = 1; + private static final int ELF_CLASS_64 = 2; + private static final int ELF_DATA_LITTLE_ENDIAN = 1; + private static final int ELF_DATA_BIG_ENDIAN = 2; + private static final int ELF32_PROGRAM_HEADER_SIZE = 32; + private static final int ELF64_PROGRAM_HEADER_SIZE = 56; + private static final int PT_INTERP = 3; + + private static final Set SUPPORTED_CLASSIFIERS = Set.of("linux-x64", "linux-arm64", "linuxmusl-x64", + "linuxmusl-arm64", "darwin-x64", "darwin-arm64", "win32-x64", "win32-arm64"); + + private static final Map CLASSIFIER_BY_KEY = Map.ofEntries( + Map.entry(new ClassifierKey("linux", "x64", LinuxLibc.GLIBC), "linux-x64"), + Map.entry(new ClassifierKey("linux", "arm64", LinuxLibc.GLIBC), "linux-arm64"), + Map.entry(new ClassifierKey("linux", "x64", LinuxLibc.MUSL), "linuxmusl-x64"), + Map.entry(new ClassifierKey("linux", "arm64", LinuxLibc.MUSL), "linuxmusl-arm64"), + Map.entry(new ClassifierKey("linux", "x64", LinuxLibc.UNKNOWN), "linux-x64"), + Map.entry(new ClassifierKey("linux", "arm64", LinuxLibc.UNKNOWN), "linux-arm64"), + Map.entry(new ClassifierKey("darwin", "x64", LinuxLibc.UNKNOWN), "darwin-x64"), + Map.entry(new ClassifierKey("darwin", "arm64", LinuxLibc.UNKNOWN), "darwin-arm64"), + Map.entry(new ClassifierKey("win32", "x64", LinuxLibc.UNKNOWN), "win32-x64"), + Map.entry(new ClassifierKey("win32", "arm64", LinuxLibc.UNKNOWN), "win32-arm64")); + + private PlatformDetector() { + } + + /** + * Linux C runtime classification. + */ + public enum LinuxLibc { + /** GNU libc runtime. */ + GLIBC, + + /** musl libc runtime. */ + MUSL, + + /** Unknown or undetectable runtime. */ + UNKNOWN + } + + /** + * Detects the normalized operating system identifier. + * + * @return {@code darwin}, {@code linux}, or {@code win32} + */ + public static String detectOs() { + return detectOs(System.getProperty("os.name", "")); + } + + /** + * Detects the normalized architecture identifier. + * + * @return {@code x64} or {@code arm64} + */ + public static String detectArch() { + return detectArch(System.getProperty("os.arch", "")); + } + + /** + * Detects the Linux libc variant using {@code /proc/self/exe} PT_INTERP. + * + * @return Linux libc classification; {@code UNKNOWN} on non-Linux or parse + * failures + */ + public static LinuxLibc detectLinuxLibc() { + if (!"linux".equals(detectOs())) { + return LinuxLibc.UNKNOWN; + } + return detectLinuxLibc(Path.of("/proc/self/exe")); + } + + /** + * Detects the runtime classifier for the current platform. + * + * @return platform classifier string + */ + public static String detectClassifier() { + return detectClassifier(detectOs(), detectArch(), detectLinuxLibc()); + } + + static String detectOs(String osName) { + String normalized = osName.toLowerCase(Locale.ROOT); + if (normalized.contains("mac") || normalized.contains("darwin")) { + return "darwin"; + } + if (normalized.contains("win")) { + return "win32"; + } + if (normalized.contains("linux")) { + return "linux"; + } + throw new IllegalStateException("Unsupported os.name: " + osName); + } + + static String detectArch(String osArch) { + String normalized = osArch.toLowerCase(Locale.ROOT).replace('-', '_'); + if (normalized.equals("amd64") || normalized.equals("x86_64") || normalized.equals("x64")) { + return "x64"; + } + if (normalized.equals("aarch64") || normalized.equals("arm64")) { + return "arm64"; + } + throw new IllegalStateException("Unsupported os.arch: " + osArch); + } + + static LinuxLibc detectLinuxLibc(Path executablePath) { + try { + return detectLinuxLibc(readPrefix(executablePath, ELF_HEADER_PROBE_BYTES)); + } catch (IOException ex) { + return LinuxLibc.UNKNOWN; + } + } + + static LinuxLibc detectLinuxLibc(byte[] elfPrefix) throws IOException { + String interpreter = readElfPtInterp(elfPrefix); + if (interpreter.contains("/ld-musl-")) { + return LinuxLibc.MUSL; + } + if (interpreter.contains("/ld-linux-")) { + return LinuxLibc.GLIBC; + } + return LinuxLibc.UNKNOWN; + } + + static String detectClassifier(String os, String arch, LinuxLibc linuxLibc) { + LinuxLibc classifierLibc = "linux".equals(os) ? linuxLibc : LinuxLibc.UNKNOWN; + String classifier = CLASSIFIER_BY_KEY.get(new ClassifierKey(os, arch, classifierLibc)); + if (classifier == null || !SUPPORTED_CLASSIFIERS.contains(classifier)) { + throw new IllegalStateException( + "Unsupported platform tuple: os=" + os + ", arch=" + arch + ", libc=" + classifierLibc); + } + return classifier; + } + + static Set supportedClassifiers() { + return SUPPORTED_CLASSIFIERS; + } + + private static String readElfPtInterp(byte[] probe) throws IOException { + int size = probe.length; + if (size < 64) { + throw new IOException("ELF probe too small: " + size + " bytes"); + } + if ((probe[0] & 0xFF) != ELF_MAGIC_0 || (probe[1] & 0xFF) != ELF_MAGIC_1 || (probe[2] & 0xFF) != ELF_MAGIC_2 + || (probe[3] & 0xFF) != ELF_MAGIC_3) { + throw new IOException("Not an ELF executable"); + } + + int elfClass = probe[4] & 0xFF; + int elfData = probe[5] & 0xFF; + if (elfData != ELF_DATA_LITTLE_ENDIAN && elfData != ELF_DATA_BIG_ENDIAN) { + throw new IOException("Unsupported ELF data encoding: " + elfData); + } + boolean littleEndian = elfData == ELF_DATA_LITTLE_ENDIAN; + + long phoff; + int phentsize; + int phnum; + int minimumPhentsize; + if (elfClass == ELF_CLASS_64) { + phoff = readUInt64(probe, 32, littleEndian); + phentsize = readUInt16(probe, 54, littleEndian); + phnum = readUInt16(probe, 56, littleEndian); + minimumPhentsize = ELF64_PROGRAM_HEADER_SIZE; + } else if (elfClass == ELF_CLASS_32) { + phoff = readUInt32(probe, 28, littleEndian); + phentsize = readUInt16(probe, 42, littleEndian); + phnum = readUInt16(probe, 44, littleEndian); + minimumPhentsize = ELF32_PROGRAM_HEADER_SIZE; + } else { + throw new IOException("Unsupported ELF class: " + elfClass); + } + + if (phoff < 0 || phoff >= size) { + throw new IOException("Program header table offset outside probe window: " + phoff); + } + if (phentsize < minimumPhentsize || phnum <= 0) { + throw new IOException("Invalid ELF program header metadata: phentsize=" + phentsize + ", phnum=" + phnum); + } + + for (int i = 0; i < phnum; i++) { + long baseLong = phoff + ((long) i * phentsize); + if (baseLong < 0 || baseLong > Integer.MAX_VALUE) { + break; + } + int base = (int) baseLong; + if (base + phentsize > size) { + break; + } + + long pType = readUInt32(probe, base, littleEndian); + if (pType != PT_INTERP) { + continue; + } + + long pOffset; + long pFileSize; + if (elfClass == ELF_CLASS_64) { + pOffset = readUInt64(probe, base + 8, littleEndian); + pFileSize = readUInt64(probe, base + 32, littleEndian); + } else { + pOffset = readUInt32(probe, base + 4, littleEndian); + pFileSize = readUInt32(probe, base + 16, littleEndian); + } + + if (pOffset < 0 || pFileSize <= 0 || pOffset > Integer.MAX_VALUE || pFileSize > Integer.MAX_VALUE) { + throw new IOException("Invalid PT_INTERP bounds"); + } + + int start = (int) pOffset; + int end = start + (int) pFileSize; + if (end > size) { + throw new IOException("PT_INTERP extends past probe window; increase probe size"); + } + + int nulIndex = start; + while (nulIndex < end && probe[nulIndex] != 0) { + nulIndex++; + } + if (nulIndex == start) { + throw new IOException("Empty PT_INTERP segment"); + } + return new String(probe, start, nulIndex - start, StandardCharsets.UTF_8); + } + + throw new IOException("ELF PT_INTERP segment not found"); + } + + private static byte[] readPrefix(Path path, int maxBytes) throws IOException { + byte[] buffer = new byte[maxBytes]; + int total = 0; + try (InputStream in = Files.newInputStream(path)) { + while (total < maxBytes) { + int read = in.read(buffer, total, maxBytes - total); + if (read < 0) { + break; + } + total += read; + } + } + byte[] resized = new byte[total]; + System.arraycopy(buffer, 0, resized, 0, total); + return resized; + } + + private static int readUInt16(byte[] data, int offset, boolean littleEndian) { + int b0 = data[offset] & 0xFF; + int b1 = data[offset + 1] & 0xFF; + return littleEndian ? (b0 | (b1 << 8)) : ((b0 << 8) | b1); + } + + private static long readUInt32(byte[] data, int offset, boolean littleEndian) { + long b0 = data[offset] & 0xFFL; + long b1 = data[offset + 1] & 0xFFL; + long b2 = data[offset + 2] & 0xFFL; + long b3 = data[offset + 3] & 0xFFL; + if (littleEndian) { + return b0 | (b1 << 8) | (b2 << 16) | (b3 << 24); + } + return (b0 << 24) | (b1 << 16) | (b2 << 8) | b3; + } + + private static long readUInt64(byte[] data, int offset, boolean littleEndian) { + long result = 0L; + if (littleEndian) { + for (int i = 7; i >= 0; i--) { + result = (result << 8) | (data[offset + i] & 0xFFL); + } + return result; + } + for (int i = 0; i < 8; i++) { + result = (result << 8) | (data[offset + i] & 0xFFL); + } + return result; + } + + private record ClassifierKey(String os, String arch, LinuxLibc libc) { + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/QueueInputStream.java b/java/sdk/src/main/java/com/github/copilot/ffi/QueueInputStream.java new file mode 100644 index 000000000..977182d5f --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/QueueInputStream.java @@ -0,0 +1,119 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Objects; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.atomic.AtomicBoolean; + +/** + * {@link InputStream} backed by a {@link BlockingQueue} of byte-array chunks. + * + *

+ * Used by the in-process FFI transport to bridge native callback frames into + * the JSON-RPC reader. + */ +public class QueueInputStream extends InputStream { + + private static final byte[] EOF_SENTINEL = new byte[0]; + + private final BlockingQueue queue; + private final AtomicBoolean closed = new AtomicBoolean(false); + + private byte[] currentChunk; + private int currentOffset; + private boolean eof; + + /** + * Creates a queue-backed input stream with an unbounded queue. + */ + public QueueInputStream() { + this(new LinkedBlockingQueue<>()); + } + + /** + * Testing constructor that injects a queue implementation. + * + * @param queue + * backing queue + */ + QueueInputStream(BlockingQueue queue) { + this.queue = Objects.requireNonNull(queue, "queue must not be null"); + } + + void enqueue(byte[] bytes) { + if (bytes == null || bytes.length == 0 || closed.get()) { + return; + } + queue.offer(bytes); + } + + @Override + public int read() throws IOException { + byte[] one = new byte[1]; + int read = read(one, 0, 1); + if (read == -1) { + return -1; + } + return one[0] & 0xFF; + } + + @Override + public int read(byte[] b, int off, int len) throws IOException { + Objects.requireNonNull(b, "buffer must not be null"); + if (off < 0 || len < 0 || off + len > b.length) { + throw new IndexOutOfBoundsException("Invalid off/len for buffer of length " + b.length); + } + if (len == 0) { + return 0; + } + if (eof) { + return -1; + } + + while (currentChunk == null || currentOffset >= currentChunk.length) { + byte[] next; + try { + next = queue.take(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new IOException("Interrupted while waiting for callback data", e); + } + if (next == EOF_SENTINEL) { + eof = true; + return -1; + } + if (next.length == 0) { + continue; + } + currentChunk = next; + currentOffset = 0; + } + + int available = currentChunk.length - currentOffset; + int toCopy = Math.min(available, len); + System.arraycopy(currentChunk, currentOffset, b, off, toCopy); + currentOffset += toCopy; + return toCopy; + } + + @Override + public int available() { + if (currentChunk == null || currentOffset >= currentChunk.length) { + return 0; + } + return currentChunk.length - currentOffset; + } + + @Override + public void close() { + if (closed.compareAndSet(false, true)) { + queue.offer(EOF_SENTINEL); + } + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/ReaderThreadFactory.java b/java/sdk/src/main/java/com/github/copilot/ffi/ReaderThreadFactory.java new file mode 100644 index 000000000..b0824fa9a --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/ReaderThreadFactory.java @@ -0,0 +1,22 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +/** + * Creates reader threads for FFI queue consumption. + * + *

+ * Baseline (JDK 17) implementation creates a daemon platform thread. The JDK 25 + * multi-release overlay switches this to a virtual thread with the same + * package-private API. + */ +final class ReaderThreadFactory { + + Thread create(Runnable task, String name) { + Thread thread = new Thread(task, name); + thread.setDaemon(true); + return thread; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/ffi/SizeT.java b/java/sdk/src/main/java/com/github/copilot/ffi/SizeT.java new file mode 100644 index 000000000..5bec1c327 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/ffi/SizeT.java @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import com.sun.jna.IntegerType; +import com.sun.jna.Native; + +/** + * JNA type mapping for the C {@code size_t} type. + * + *

+ * {@code size_t} is pointer-sized: 8 bytes on 64-bit platforms, 4 bytes on + * 32-bit. Using Java {@code int} (always 4 bytes) would silently truncate on + * 64-bit, and using {@link com.sun.jna.NativeLong} would be wrong on Windows + * x64 where C {@code long} is 4 bytes but {@code size_t} is 8 bytes. + * + *

+ * This class uses {@link Native#SIZE_T_SIZE} so JNA marshals the correct width + * on every platform. + */ +public final class SizeT extends IntegerType { + + /** Zero-valued instance; required by JNA for return-type instantiation. */ + public SizeT() { + this(0); + } + + /** + * Creates a {@code size_t} with the given value. + * + * @param value + * the numeric value (unsigned, but stored as signed long) + */ + public SizeT(long value) { + super(Native.SIZE_T_SIZE, value, true); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/package-info.java b/java/sdk/src/main/java/com/github/copilot/package-info.java new file mode 100644 index 000000000..0e0b2cf82 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/package-info.java @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * Core classes for the GitHub Copilot SDK for Java. + * + *

+ * This package provides the main entry points for interacting with GitHub + * Copilot programmatically. The SDK enables Java applications to leverage + * Copilot's agentic capabilities, including multi-turn conversations, tool + * execution, and AI-powered code generation. + * + *

Main Classes

+ *
    + *
  • {@link com.github.copilot.CopilotClient} - The main client for connecting + * to and communicating with the Copilot CLI. Manages the lifecycle of the CLI + * process and provides methods for creating sessions, querying models, and + * checking authentication status.
    • + *
  • {@link com.github.copilot.CopilotSession} - Represents a single + * conversation session with Copilot. Sessions maintain context across multiple + * messages and support streaming responses, tool invocations, and event + * handling.
    • + *
  • {@link com.github.copilot.JsonRpcClient} - Low-level JSON-RPC client for + * communication with the Copilot CLI process.
    • + *
+ * + *

Quick Start

+ * + * 
{@code
+ * try (var client = new CopilotClient()) {
+ * 	client.start().get();
+ *
+ * 	var session = client.createSession(new SessionConfig().setModel("gpt-5.4")).get();
+ *
+ * 	session.on(AssistantMessageEvent.class, msg -> {
+ * 		System.out.println(msg.getData().content());
+ * 	});
+ *
+ * 	session.send(new MessageOptions().setPrompt("Hello, Copilot!")).get();
+ * }
+ * }
+ * + *

Related Packages

+ *
    + *
  • {@link com.github.copilot.generated} - Auto-generated event types emitted + * during session processing
    • + *
  • {@link com.github.copilot.rpc} - Configuration and data transfer + * objects
    • + *
+ * + * @see com.github.copilot.CopilotClient + * @see com.github.copilot.CopilotSession + * @see GitHub + * Repository + */ +package com.github.copilot; diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/AgentInfo.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentInfo.java new file mode 100644 index 000000000..1f6f1688f --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/AgentInfo.java @@ -0,0 +1,114 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Represents a custom agent available for selection in a session. + * + * @since 1.0.11 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +public class AgentInfo { + + @JsonProperty("name") + private String name; + + @JsonProperty("displayName") + private String displayName; + + @JsonProperty("description") + private String description; + + @JsonProperty("model") + private String model; + + /** + * Gets the unique identifier of the agent. + * + * @return the agent name/identifier + */ + public String getName() { + return name; + } + + /** + * Sets the unique identifier of the agent. + * + * @param name + * the agent name/identifier + * @return this instance for chaining + */ + public AgentInfo setName(String name) { + this.name = name; + return this; + } + + /** + * Gets the human-readable display name of the agent. + * + * @return the display name + */ + public String getDisplayName() { + return displayName; + } + + /** + * Sets the human-readable display name of the agent. + * + * @param displayName + * the display name + * @return this instance for chaining + */ + public AgentInfo setDisplayName(String displayName) { + this.displayName = displayName; + return this; + } + + /** + * Gets the description of the agent's purpose. + * + * @return the description + */ + public String getDescription() { + return description; + } + + /** + * Sets the description of the agent's purpose. + * + * @param description + * the description + * @return this instance for chaining + */ + public AgentInfo setDescription(String description) { + this.description = description; + return this; + } + + /** + * Gets the preferred model id for this agent. When omitted, the agent inherits + * the outer agent's model. + * + * @return the preferred model id, or {@code null} if unset + */ + public String getModel() { + return model; + } + + /** + * Sets the preferred model id for this agent. + * + * @param model + * the preferred model id + * @return this instance for chaining + */ + public AgentInfo setModel(String model) { + this.model = model; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/AgentMode.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentMode.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AgentMode.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AgentMode.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHandler.java new file mode 100644 index 000000000..7f1577605 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHandler.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +/** + * Handler for agent-stop hooks. + * + * @since 1.0.9 + */ +@FunctionalInterface +public interface AgentStopHandler { + + /** + * Handles an agent-stop hook invocation. + * + * @param input + * the hook input + * @param invocation + * context information about the invocation + * @return a future that resolves with the hook output, or {@code null} to let + * the agent stop + */ + CompletableFuture handle(AgentStopHookInput input, HookInvocation invocation); +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java new file mode 100644 index 000000000..fceea8b72 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookInput.java @@ -0,0 +1,161 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Input for an agent-stop hook. + * + * @since 1.0.9 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +public class AgentStopHookInput { + + @JsonProperty("sessionId") + private String sessionId; + + @JsonProperty("timestamp") + private long timestamp; + + @JsonProperty("cwd") + private String cwd; + + @JsonProperty("stopReason") + private String stopReason; + + @JsonProperty("transcriptPath") + private String transcriptPath; + + @JsonProperty("stop_hook_active") + private Boolean stopHookActive; + + /** + * Gets the runtime session ID of the session that triggered the hook. + * + * @return the session ID + */ + public String getSessionId() { + return sessionId; + } + + /** + * Sets the runtime session ID of the session that triggered the hook. + * + * @param sessionId + * the session ID + * @return this instance for method chaining + */ + public AgentStopHookInput setSessionId(String sessionId) { + this.sessionId = sessionId; + return this; + } + + /** + * Gets the timestamp of the hook invocation. + * + * @return the timestamp in milliseconds + */ + public long getTimestamp() { + return timestamp; + } + + /** + * Sets the timestamp of the hook invocation. + * + * @param timestamp + * the timestamp in milliseconds + * @return this instance for method chaining + */ + public AgentStopHookInput setTimestamp(long timestamp) { + this.timestamp = timestamp; + return this; + } + + /** + * Gets the current working directory. + * + * @return the working directory path + */ + public String getCwd() { + return cwd; + } + + /** + * Sets the current working directory. + * + * @param cwd + * the working directory path + * @return this instance for method chaining + */ + public AgentStopHookInput setCwd(String cwd) { + this.cwd = cwd; + return this; + } + + /** + * Gets the reason the agent stopped. + * + * @return the stop reason + */ + public String getStopReason() { + return stopReason; + } + + /** + * Sets the reason the agent stopped. + * + * @param stopReason + * the stop reason + * @return this instance for method chaining + */ + public AgentStopHookInput setStopReason(String stopReason) { + this.stopReason = stopReason; + return this; + } + + /** + * Gets the path to the on-disk session transcript. + * + * @return the transcript path + */ + public String getTranscriptPath() { + return transcriptPath; + } + + /** + * Sets the path to the on-disk session transcript. + * + * @param transcriptPath + * the transcript path + * @return this instance for method chaining + */ + public AgentStopHookInput setTranscriptPath(String transcriptPath) { + this.transcriptPath = transcriptPath; + return this; + } + + /** + * Gets whether this stop follows a previous block decision. + * + * @return {@code true} when the stop hook is already active + */ + public Boolean getStopHookActive() { + return stopHookActive; + } + + /** + * Sets whether this stop follows a previous block decision. + * + * @param stopHookActive + * whether the stop hook is already active + * @return this instance for method chaining + */ + public AgentStopHookInput setStopHookActive(Boolean stopHookActive) { + this.stopHookActive = stopHookActive; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java new file mode 100644 index 000000000..293bb3138 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/AgentStopHookOutput.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Output for an agent-stop hook. + * + * @since 1.0.9 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class AgentStopHookOutput { + + @JsonProperty("decision") + private String decision; + + @JsonProperty("reason") + private String reason; + + /** + * Gets the stop decision. + * + * @return {@code "block"} to keep the agent running, or {@code null} + */ + public String getDecision() { + return decision; + } + + /** + * Sets the stop decision. + * + * @param decision + * {@code "block"} to keep the agent running + * @return this instance for method chaining + */ + public AgentStopHookOutput setDecision(String decision) { + this.decision = decision; + return this; + } + + /** + * Gets the follow-up instruction supplied when the stop is blocked. + * + * @return the follow-up instruction + */ + public String getReason() { + return reason; + } + + /** + * Sets the follow-up instruction supplied when the stop is blocked. + * + * @param reason + * the follow-up instruction + * @return this instance for method chaining + */ + public AgentStopHookOutput setReason(String reason) { + this.reason = reason; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/Attachment.java b/java/sdk/src/main/java/com/github/copilot/rpc/Attachment.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/Attachment.java rename to java/sdk/src/main/java/com/github/copilot/rpc/Attachment.java diff --git a/java/src/main/java/com/github/copilot/rpc/AutoModeSwitchHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AutoModeSwitchHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/AutoModeSwitchInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchInvocation.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AutoModeSwitchInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchInvocation.java diff --git a/java/src/main/java/com/github/copilot/rpc/AutoModeSwitchRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AutoModeSwitchRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/AutoModeSwitchResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/AutoModeSwitchResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AutoModeSwitchResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/AzureOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/AzureOptions.java similarity index 85% rename from java/src/main/java/com/github/copilot/rpc/AzureOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/AzureOptions.java index 7adbc5656..cd25e845e 100644 --- a/java/src/main/java/com/github/copilot/rpc/AzureOptions.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/AzureOptions.java @@ -12,6 +12,7 @@ *

* When using a BYOK (Bring Your Own Key) setup with Azure OpenAI, this class * allows you to specify Azure-specific settings such as the API version to use. + * When no API version is set, the runtime uses the GA versionless v1 route. * *

Example Usage

* @@ -32,7 +33,8 @@ public class AzureOptions { /** * Gets the Azure OpenAI API version. * - * @return the API version string + * @return the API version string, or {@code null} to use the GA versionless v1 + * route */ public String getApiVersion() { return apiVersion; @@ -41,7 +43,8 @@ public String getApiVersion() { /** * Sets the Azure OpenAI API version to use. *

- * Examples: {@code "2024-02-01"}, {@code "2023-12-01-preview"} + * Examples: {@code "2024-02-01"}, {@code "2023-12-01-preview"} When this option + * is not set, the runtime uses the GA versionless v1 route. * * @param apiVersion * the API version string diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java b/java/sdk/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java new file mode 100644 index 000000000..7b37925aa --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/BearerTokenProvider.java @@ -0,0 +1,40 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +import com.github.copilot.CopilotExperimental; + +/** + * Functional interface for supplying per-provider bearer tokens for BYOK + * provider requests. + *

+ * The callback returns the raw token without a {@code Bearer } prefix. The SDK + * keeps this callback client-side and the runtime requests a token via the + * session-scoped {@code providerToken.getToken} RPC before each outbound model + * request. + *

+ * Experimental. This managed-identity surface may change or be + * removed in future SDK or CLI releases. + * + * @see ProviderConfig#setBearerTokenProvider(BearerTokenProvider) + * @see NamedProviderConfig#setBearerTokenProvider(BearerTokenProvider) + * @since 1.0.0 + */ +@CopilotExperimental +@FunctionalInterface +public interface BearerTokenProvider { + + /** + * Gets a bearer token for the provider identified by {@code args}. + * + * @param args + * the provider token request arguments + * @return a future that completes with the raw token, without a {@code Bearer } + * prefix + */ + CompletableFuture getToken(ProviderTokenArgs args); +} diff --git a/java/src/main/java/com/github/copilot/rpc/BlobAttachment.java b/java/sdk/src/main/java/com/github/copilot/rpc/BlobAttachment.java similarity index 99% rename from java/src/main/java/com/github/copilot/rpc/BlobAttachment.java rename to java/sdk/src/main/java/com/github/copilot/rpc/BlobAttachment.java index fe15293c6..ea800f110 100644 --- a/java/src/main/java/com/github/copilot/rpc/BlobAttachment.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/BlobAttachment.java @@ -23,7 +23,7 @@ * } * * @see MessageOptions#setAttachments(java.util.List) - * @since 1.2.0 + * @since 1.0.0 */ @JsonInclude(JsonInclude.Include.NON_NULL) public final class BlobAttachment implements MessageAttachment { diff --git a/java/src/main/java/com/github/copilot/rpc/BuiltInTools.java b/java/sdk/src/main/java/com/github/copilot/rpc/BuiltInTools.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/BuiltInTools.java rename to java/sdk/src/main/java/com/github/copilot/rpc/BuiltInTools.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java new file mode 100644 index 000000000..d94d59f67 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CapiSessionOptions.java @@ -0,0 +1,63 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Provider-scoped session options for the Copilot API (CAPI) provider. + *

+ * WebSocket transport is the default for the CAPI Responses API whenever the + * model advertises the {@code ws:/responses} endpoint. Setting + * {@link #setEnableWebSocketResponses(Boolean)} to {@code false} forces the + * HTTP Responses transport instead, which is useful for users behind proxies + * where WebSockets fail. This is equivalent to setting the + * {@code COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES} environment variable. + *

+ * These options are scoped under the {@code capi} namespace because a single + * session can host multiple providers (for example, CAPI and BYOK), so + * transport choice is provider-level rather than top-level session state. All + * setter methods return {@code this} for method chaining. + * + * @see SessionConfig#setCapi(CapiSessionOptions) + * @see ResumeSessionConfig#setCapi(CapiSessionOptions) + * @since 1.5.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class CapiSessionOptions { + + @JsonProperty("enableWebSocketResponses") + private Boolean enableWebSocketResponses; + + /** + * Gets whether CAPI Responses API WebSocket transport is enabled. + * + * @return {@code false} to force the HTTP Responses transport, {@code true} to + * explicitly use WebSocket transport, or {@code null} to use the + * default behavior + */ + public Boolean getEnableWebSocketResponses() { + return enableWebSocketResponses; + } + + /** + * Sets whether to use CAPI Responses API WebSocket transport. + *

+ * WebSocket transport is the default for the CAPI Responses API whenever the + * model advertises the {@code ws:/responses} endpoint. Set this to + * {@code false} to force the HTTP Responses transport instead, which is useful + * for users behind proxies where WebSockets fail. This is equivalent to setting + * the {@code COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES} environment variable. + * + * @param enableWebSocketResponses + * {@code false} to force the HTTP Responses transport + * @return this config for method chaining + */ + public CapiSessionOptions setEnableWebSocketResponses(Boolean enableWebSocketResponses) { + this.enableWebSocketResponses = enableWebSocketResponses; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/CloudSessionOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/CloudSessionOptions.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CloudSessionOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CloudSessionOptions.java diff --git a/java/src/main/java/com/github/copilot/rpc/CloudSessionRepository.java b/java/sdk/src/main/java/com/github/copilot/rpc/CloudSessionRepository.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CloudSessionRepository.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CloudSessionRepository.java diff --git a/java/src/main/java/com/github/copilot/rpc/CommandContext.java b/java/sdk/src/main/java/com/github/copilot/rpc/CommandContext.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CommandContext.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CommandContext.java diff --git a/java/src/main/java/com/github/copilot/rpc/CommandDefinition.java b/java/sdk/src/main/java/com/github/copilot/rpc/CommandDefinition.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CommandDefinition.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CommandDefinition.java diff --git a/java/src/main/java/com/github/copilot/rpc/CommandHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/CommandHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CommandHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CommandHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java b/java/sdk/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CommandWireDefinition.java diff --git a/java/src/main/java/com/github/copilot/rpc/CopilotClientMode.java b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotClientMode.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/CopilotClientMode.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CopilotClientMode.java diff --git a/java/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java similarity index 78% rename from java/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java index 941467059..d3515509b 100644 --- a/java/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotClientOptions.java @@ -4,19 +4,25 @@ package com.github.copilot.rpc; +import java.nio.file.Path; +import java.util.ArrayList; import java.util.Arrays; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Objects; +import java.util.Optional; +import java.util.OptionalInt; import java.util.concurrent.CompletableFuture; import java.util.concurrent.Executor; +import java.util.function.Function; import java.util.function.Supplier; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonIgnore; -import java.util.Optional; -import java.util.OptionalInt; +import com.github.copilot.CopilotExperimental; +import com.github.copilot.CopilotRequestHandler; +import com.github.copilot.generated.rpc.GitHubTelemetryNotification; /** * Configuration options for creating a @@ -44,9 +50,11 @@ public class CopilotClientOptions { @Deprecated private boolean autoRestart; private boolean autoStart = true; + private List builtinPluginDirectories; private String[] cliArgs; private String cliPath; private String cliUrl; + private RuntimeConnection connection; private String copilotHome; private String cwd; private Map environment; @@ -55,6 +63,8 @@ public class CopilotClientOptions { private String logLevel = "info"; private CopilotClientMode mode = CopilotClientMode.COPILOT_CLI; private Supplier>> onListModels; + private CopilotRequestHandler requestHandler; + private Function> onGitHubTelemetry; private int port; private TelemetryConfig telemetry; private Integer sessionIdleTimeoutSeconds; @@ -113,6 +123,40 @@ public CopilotClientOptions setAutoStart(boolean autoStart) { return this; } + /** + * Gets the trusted plugin directories bundled by the host. + * + * @return a copy of the configured absolute paths, or {@code null} + */ + public List getBuiltinPluginDirectories() { + return builtinPluginDirectories != null ? new ArrayList<>(builtinPluginDirectories) : null; + } + + /** + * Sets trusted plugin directories bundled by the host. Every path must be + * absolute. When non-empty, the complete set is registered during startup + * before sessions can be created. + * + * @param paths + * absolute plugin directory paths, or {@code null}/empty to disable + * @return this options instance for method chaining + */ + public CopilotClientOptions setBuiltinPluginDirectories(List paths) { + if (paths == null || paths.isEmpty()) { + this.builtinPluginDirectories = null; + return this; + } + for (Path path : paths) { + Objects.requireNonNull(path, "builtin plugin directory path must not be null"); + if (!path.isAbsolute()) { + throw new IllegalArgumentException( + "BuiltinPluginDirectories must contain only absolute paths: " + path); + } + } + this.builtinPluginDirectories = new ArrayList<>(paths); + return this; + } + /** * Gets the extra CLI arguments. *

@@ -198,6 +242,41 @@ public CopilotClientOptions setCliUrl(String cliUrl) { return this; } + /** + * Gets the connection that selects how the client reaches the Copilot runtime. + * + * @return the connection, or {@code null} to infer the transport from + * {@link #isUseStdio()}, {@link #getCliUrl()} and {@link #getCliPath()} + */ + @JsonIgnore + @CopilotExperimental + public RuntimeConnection getConnection() { + return connection; + } + + /** + * Sets the connection that selects how the client reaches the Copilot runtime. + *

+ * When set, the connection takes precedence over the transport-selecting + * options {@link #setUseStdio(boolean)}, {@link #setCliUrl(String)}, + * {@link #setCliPath(String)}, {@link #setPort(int)} and + * {@link #setTcpConnectionToken(String)}; combining a connection with + * conflicting values for any of those options makes the client constructor + * throw {@link IllegalArgumentException}. Values that match what the connection + * implies are accepted, so the same options instance can be reused across + * multiple client constructions. + * + * @param connection + * the connection, or {@code null} to infer the transport from the + * individual transport options + * @return this options instance for method chaining + */ + @CopilotExperimental + public CopilotClientOptions setConnection(RuntimeConnection connection) { + this.connection = connection; + return this; + } + /** * Gets the base directory for Copilot data (session state, config, etc.). * @@ -242,13 +321,11 @@ public String getCwd() { * Sets the working directory for the CLI process. * * @param cwd - * the working directory path (must not be {@code null} or empty) + * the working directory path, or {@code null} to clear * @return this options instance for method chaining - * @throws IllegalArgumentException - * if {@code cwd} is {@code null} or empty */ public CopilotClientOptions setCwd(String cwd) { - this.cwd = Objects.requireNonNull(cwd, "cwd must not be null"); + this.cwd = cwd; return this; } @@ -454,6 +531,72 @@ public CopilotClientOptions setOnListModels(Supplier + * When provided, the client registers as the runtime's LLM inference provider + * on connect, and the runtime routes its model-layer HTTP and WebSocket traffic + * (both BYOK and CAPI) through the handler instead of issuing the calls itself. + * + * @param requestHandler + * the request handler (must not be {@code null}) + * @return this options instance for method chaining + * @throws IllegalArgumentException + * if {@code requestHandler} is {@code null} + */ + public CopilotClientOptions setRequestHandler(CopilotRequestHandler requestHandler) { + this.requestHandler = Objects.requireNonNull(requestHandler, "requestHandler must not be null"); + return this; + } + + /** + * Gets the connection-level GitHub telemetry forwarding handler. + * + *

+ * Experimental: this option may change or be removed without notice. + * + * @return the async telemetry handler, or {@code null} if not set + */ + @JsonIgnore + @CopilotExperimental + public Function> getOnGitHubTelemetry() { + return onGitHubTelemetry; + } + + /** + * Sets a connection-level handler for GitHub telemetry forwarding + * (experimental). + * + *

+ * When provided, the client opts every session it creates or resumes into + * telemetry forwarding, and the runtime forwards each per-session telemetry + * event to this handler via the {@code gitHubTelemetry.event} notification. The + * handler returns a {@link CompletableFuture} that completes when asynchronous + * processing is finished. + * + * @param onGitHubTelemetry + * the async telemetry handler (must not be {@code null}) + * @return this options instance for method chaining + * @throws IllegalArgumentException + * if {@code onGitHubTelemetry} is {@code null} + */ + @CopilotExperimental + public CopilotClientOptions setOnGitHubTelemetry( + Function> onGitHubTelemetry) { + this.onGitHubTelemetry = Objects.requireNonNull(onGitHubTelemetry, "onGitHubTelemetry must not be null"); + return this; + } + /** * Gets the TCP port for the CLI server. * @@ -512,7 +655,7 @@ public CopilotClientOptions setRemote(boolean remote) { * Gets the OpenTelemetry configuration for the CLI server. * * @return the telemetry config, or {@code null} - * @since 1.2.0 + * @since 1.0.0 */ public TelemetryConfig getTelemetry() { return telemetry; @@ -527,7 +670,7 @@ public TelemetryConfig getTelemetry() { * @param telemetry * the telemetry configuration * @return this options instance for method chaining - * @since 1.2.0 + * @since 1.0.0 */ public CopilotClientOptions setTelemetry(TelemetryConfig telemetry) { this.telemetry = Objects.requireNonNull(telemetry, "telemetry must not be null"); @@ -679,9 +822,13 @@ public CopilotClientOptions clone() { CopilotClientOptions copy = new CopilotClientOptions(); copy.autoRestart = this.autoRestart; copy.autoStart = this.autoStart; + copy.builtinPluginDirectories = this.builtinPluginDirectories != null + ? new ArrayList<>(this.builtinPluginDirectories) + : null; copy.cliArgs = this.cliArgs != null ? this.cliArgs.clone() : null; copy.cliPath = this.cliPath; copy.cliUrl = this.cliUrl; + copy.connection = this.connection; copy.copilotHome = this.copilotHome; copy.cwd = this.cwd; copy.environment = this.environment != null ? new java.util.HashMap<>(this.environment) : null; @@ -689,6 +836,8 @@ public CopilotClientOptions clone() { copy.gitHubToken = this.gitHubToken; copy.logLevel = this.logLevel; copy.onListModels = this.onListModels; + copy.requestHandler = this.requestHandler; + copy.onGitHubTelemetry = this.onGitHubTelemetry; copy.port = this.port; copy.remote = this.remote; copy.sessionIdleTimeoutSeconds = this.sessionIdleTimeoutSeconds; diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java new file mode 100644 index 000000000..c25497be9 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CopilotExpAssignmentResponse.java @@ -0,0 +1,195 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.JsonNode; + +/** + * ExP ("flight") assignment data, in the same JSON shape the Copilot CLI + * fetches from the experimentation service. + *

+ * Property names serialize as PascalCase ({@code Features}, {@code Flights}, + * {@code Configs}, ...) to match the on-the-wire contract consumed by the + * runtime. This is an internal/trusted-integrator option, not part of the + * broadly advertised public surface. + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class CopilotExpAssignmentResponse { + + @JsonProperty("Features") + private List features = new ArrayList<>(); + + @JsonProperty("Flights") + private Map flights = new LinkedHashMap<>(); + + @JsonProperty("Configs") + private List configs = new ArrayList<>(); + + @JsonProperty("ParameterGroups") + private JsonNode parameterGroups; + + @JsonProperty("FlightingVersion") + private Integer flightingVersion; + + @JsonProperty("ImpressionId") + private String impressionId; + + @JsonProperty("AssignmentContext") + private String assignmentContext = ""; + + /** + * Gets the enabled feature names. + * + * @return the feature list + */ + public List getFeatures() { + return features; + } + + /** + * Sets the enabled feature names. + * + * @param features + * the feature list + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setFeatures(List features) { + this.features = features; + return this; + } + + /** + * Gets the assigned flights keyed by flight name. + * + * @return the flights map + */ + public Map getFlights() { + return flights; + } + + /** + * Sets the assigned flights keyed by flight name. + * + * @param flights + * the flights map + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setFlights(Map flights) { + this.flights = flights; + return this; + } + + /** + * Gets the configuration entries carrying typed parameter values. + * + * @return the configuration entries + */ + public List getConfigs() { + return configs; + } + + /** + * Sets the configuration entries carrying typed parameter values. + * + * @param configs + * the configuration entries + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setConfigs(List configs) { + this.configs = configs; + return this; + } + + /** + * Gets the opaque parameter-group payload passed through untouched. + * + * @return the parameter groups, or {@code null} if not set + */ + public JsonNode getParameterGroups() { + return parameterGroups; + } + + /** + * Sets the opaque parameter-group payload passed through untouched. + * + * @param parameterGroups + * the parameter groups + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setParameterGroups(JsonNode parameterGroups) { + this.parameterGroups = parameterGroups; + return this; + } + + /** + * Gets the version of the flighting configuration. + * + * @return the flighting version, or {@code null} if not set + */ + public Integer getFlightingVersion() { + return flightingVersion; + } + + /** + * Sets the version of the flighting configuration. + * + * @param flightingVersion + * the flighting version + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setFlightingVersion(Integer flightingVersion) { + this.flightingVersion = flightingVersion; + return this; + } + + /** + * Gets the impression identifier for the assignment. + * + * @return the impression identifier, or {@code null} if not set + */ + public String getImpressionId() { + return impressionId; + } + + /** + * Sets the impression identifier for the assignment. + * + * @param impressionId + * the impression identifier + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setImpressionId(String impressionId) { + this.impressionId = impressionId; + return this; + } + + /** + * Gets the assignment context string forwarded to CAPI and telemetry. + * + * @return the assignment context (empty string when unset) + */ + public String getAssignmentContext() { + return assignmentContext; + } + + /** + * Sets the assignment context string forwarded to CAPI and telemetry. + * + * @param assignmentContext + * the assignment context + * @return this instance for method chaining + */ + public CopilotExpAssignmentResponse setAssignmentContext(String assignmentContext) { + this.assignmentContext = assignmentContext; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java new file mode 100644 index 000000000..2eab977db --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java @@ -0,0 +1,1133 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +import com.github.copilot.CopilotExperimental; +import com.github.copilot.generated.rpc.SessionLimitsConfig; + +/** + * Internal request object for creating a new session. + *

+ * This is a low-level class for JSON-RPC communication. For creating sessions, + * use {@link com.github.copilot.CopilotClient#createSession(SessionConfig)}. + * + * @see com.github.copilot.CopilotClient#createSession(SessionConfig) + * @see SessionConfig + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public final class CreateSessionRequest { + + @JsonProperty("model") + private String model; + + @JsonProperty("sessionId") + private String sessionId; + + @JsonProperty("clientName") + private String clientName; + + @JsonProperty("reasoningEffort") + private String reasoningEffort; + + @JsonProperty("reasoningSummary") + private String reasoningSummary; + + @JsonProperty("contextTier") + private String contextTier; + + @JsonProperty("tools") + private List tools; + + @JsonProperty("systemMessage") + private SystemMessageConfig systemMessage; + + @JsonProperty("availableTools") + private List availableTools; + + @JsonProperty("excludedTools") + private List excludedTools; + + @JsonProperty("excludedBuiltinAgents") + private List excludedBuiltInAgents; + + @JsonProperty("toolFilterPrecedence") + private String toolFilterPrecedence; + + @JsonProperty("provider") + private ProviderConfig provider; + + @JsonProperty("capi") + private CapiSessionOptions capi; + @JsonProperty("providers") + private List providers; + + @JsonProperty("models") + private List models; + + @JsonProperty("enableSessionTelemetry") + private Boolean enableSessionTelemetry; + + @JsonProperty("enableCitations") + private Boolean enableCitations; + + @JsonProperty("enableFileChangeTracking") + private Boolean enableFileChangeTracking; + + @JsonProperty("sessionLimits") + private SessionLimitsConfig sessionLimits; + + @JsonProperty("requestPermission") + private Boolean requestPermission; + + @JsonProperty("requestUserInput") + private Boolean requestUserInput; + + @JsonProperty("hooks") + private Boolean hooks; + + @JsonProperty("workingDirectory") + private String workingDirectory; + + @JsonProperty("additionalDirectories") + private List additionalDirectories; + + @JsonProperty("streaming") + private Boolean streaming; + + @JsonProperty("includeSubAgentStreamingEvents") + private Boolean includeSubAgentStreamingEvents; + + @JsonProperty("enableGitHubTelemetryForwarding") + private Boolean enableGitHubTelemetryForwarding; + + @JsonProperty("mcpServers") + private Map mcpServers; + + @JsonProperty("mcpOAuthTokenStorage") + private String mcpOAuthTokenStorage; + + @JsonProperty("envValueMode") + private String envValueMode; + + @JsonProperty("customAgents") + private List customAgents; + + @JsonProperty("customAgentsLocalOnly") + private Boolean customAgentsLocalOnly; + + @JsonProperty("defaultAgent") + private DefaultAgentConfig defaultAgent; + + @JsonProperty("agent") + private String agent; + + @JsonProperty("infiniteSessions") + private InfiniteSessionConfig infiniteSessions; + + @JsonProperty("skillDirectories") + private List skillDirectories; + + @JsonProperty("instructionDirectories") + private List instructionDirectories; + + @JsonProperty("pluginDirectories") + private List pluginDirectories; + + @JsonProperty("largeOutput") + private LargeToolOutputConfig largeOutput; + + @JsonProperty("toolSearch") + private ToolSearchConfig toolSearch; + + @JsonProperty("memory") + private MemoryConfiguration memory; + + @JsonProperty("disabledSkills") + private List disabledSkills; + + @JsonProperty("disabledMcpServers") + private List disabledMcpServers; + + @JsonProperty("configDir") + private String configDirectory; + + @JsonProperty("enableConfigDiscovery") + private Boolean enableConfigDiscovery; + + @JsonProperty("skipEmbeddingRetrieval") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean skipEmbeddingRetrieval; + + @JsonProperty("organizationCustomInstructions") + @JsonInclude(JsonInclude.Include.NON_NULL) + private String organizationCustomInstructions; + + @JsonProperty("enableOnDemandInstructionDiscovery") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableOnDemandInstructionDiscovery; + + @JsonProperty("enableFileHooks") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableFileHooks; + + @JsonProperty("enableHostGitOperations") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableHostGitOperations; + + @JsonProperty("enableSessionStore") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableSessionStore; + + @JsonProperty("enableSkills") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableSkills; + + @JsonProperty("embeddingCacheStorage") + @JsonInclude(JsonInclude.Include.NON_NULL) + private String embeddingCacheStorage; + + @JsonProperty("commands") + private List commands; + + @JsonProperty("requestElicitation") + private Boolean requestElicitation; + + @JsonProperty("requestMcpApps") + private Boolean requestMcpApps; + + @JsonProperty("githubMcpToolConfig") + private GitHubMcpToolConfig githubMcpToolConfig; + + @JsonProperty("isExperimentalMode") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean isExperimentalMode; + + @JsonProperty("requestExitPlanMode") + private Boolean requestExitPlanMode; + + @JsonProperty("requestAutoModeSwitch") + private Boolean requestAutoModeSwitch; + + @JsonProperty("modelCapabilities") + private ModelCapabilitiesOverride modelCapabilities; + + @JsonProperty("gitHubToken") + private String gitHubToken; + + @JsonProperty("remoteSession") + private String remoteSession; + + @JsonProperty("cloud") + private CloudSessionOptions cloud; + + @JsonProperty("expAssignments") + private CopilotExpAssignmentResponse expAssignments; + + @JsonProperty("enableManagedSettings") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableManagedSettings; + + @JsonProperty("managedSettings") + @JsonInclude(JsonInclude.Include.NON_NULL) + private ManagedSettings managedSettings; + + /** Gets the model name. @return the model */ + public String getModel() { + return model; + } + + /** Sets the model name. @param model the model */ + public void setModel(String model) { + this.model = model; + } + + /** Gets the session ID. @return the session ID */ + public String getSessionId() { + return sessionId; + } + + /** Sets the session ID. @param sessionId the session ID */ + public void setSessionId(String sessionId) { + this.sessionId = sessionId; + } + + /** Gets the client name. @return the client name */ + public String getClientName() { + return clientName; + } + + /** Sets the client name. @param clientName the client name */ + public void setClientName(String clientName) { + this.clientName = clientName; + } + + /** Gets the reasoning effort. @return the reasoning effort level */ + public String getReasoningEffort() { + return reasoningEffort; + } + + /** + * Sets the reasoning effort. @param reasoningEffort the reasoning effort level + */ + public void setReasoningEffort(String reasoningEffort) { + this.reasoningEffort = reasoningEffort; + } + + /** Gets the reasoning summary mode. @return the reasoning summary mode */ + public String getReasoningSummary() { + return reasoningSummary; + } + + /** + * Sets the reasoning summary mode. @param reasoningSummary the reasoning + * summary mode + */ + public void setReasoningSummary(String reasoningSummary) { + this.reasoningSummary = reasoningSummary; + } + + /** Gets the context window tier. @return the context window tier */ + public String getContextTier() { + return contextTier; + } + + /** Sets the context window tier. @param contextTier the context window tier */ + public void setContextTier(String contextTier) { + this.contextTier = contextTier; + } + + /** Gets the tools. @return the tool definitions */ + public List getTools() { + return tools == null ? null : Collections.unmodifiableList(tools); + } + + /** Sets the tools. @param tools the tool definitions */ + public void setTools(List tools) { + this.tools = tools; + } + + /** Gets the system message config. @return the config */ + public SystemMessageConfig getSystemMessage() { + return systemMessage; + } + + /** Sets the system message config. @param systemMessage the config */ + public void setSystemMessage(SystemMessageConfig systemMessage) { + this.systemMessage = systemMessage; + } + + /** Gets available tools. @return the tool names */ + public List getAvailableTools() { + return availableTools == null ? null : Collections.unmodifiableList(availableTools); + } + + /** Sets available tools. @param availableTools the tool names */ + public void setAvailableTools(List availableTools) { + this.availableTools = availableTools; + } + + /** Gets excluded tools. @return the tool names */ + public List getExcludedTools() { + return excludedTools == null ? null : Collections.unmodifiableList(excludedTools); + } + + /** Sets excluded tools. @param excludedTools the tool names */ + public void setExcludedTools(List excludedTools) { + this.excludedTools = excludedTools; + } + + /** Gets excluded built-in agents. @return the built-in agent names */ + public List getExcludedBuiltInAgents() { + return excludedBuiltInAgents == null ? null : Collections.unmodifiableList(excludedBuiltInAgents); + } + + /** + * Sets excluded built-in agents. @param excludedBuiltInAgents the agent names + */ + public void setExcludedBuiltInAgents(List excludedBuiltInAgents) { + this.excludedBuiltInAgents = excludedBuiltInAgents; + } + + /** Gets the tool filter precedence. @return the precedence value */ + public String getToolFilterPrecedence() { + return toolFilterPrecedence; + } + + /** + * Sets the tool filter precedence. @param toolFilterPrecedence the precedence + * ("excluded" or null) + */ + public void setToolFilterPrecedence(String toolFilterPrecedence) { + this.toolFilterPrecedence = toolFilterPrecedence; + } + + /** Gets the provider config. @return the provider */ + public ProviderConfig getProvider() { + return provider; + } + + /** Sets the provider config. @param provider the provider */ + public void setProvider(ProviderConfig provider) { + this.provider = provider; + } + + /** Gets the CAPI session options. @return the CAPI session options */ + public CapiSessionOptions getCapi() { + return capi; + } + + /** Sets the CAPI session options. @param capi the CAPI session options */ + public void setCapi(CapiSessionOptions capi) { + this.capi = capi; + } + + /** Gets the named provider connections. @return the named providers */ + @CopilotExperimental + public List getProviders() { + return providers; + } + + /** Sets the named provider connections. @param providers the named providers */ + @CopilotExperimental + public void setProviders(List providers) { + this.providers = providers; + } + + /** Gets the BYOK model definitions. @return the models */ + @CopilotExperimental + public List getModels() { + return models; + } + + /** Sets the BYOK model definitions. @param models the models */ + @CopilotExperimental + public void setModels(List models) { + this.models = models; + } + + /** Gets enable session telemetry flag. @return the flag */ + public Boolean getEnableSessionTelemetry() { + return enableSessionTelemetry; + } + + /** + * Sets enable session telemetry flag. @param enableSessionTelemetry the flag + */ + public void setEnableSessionTelemetry(boolean enableSessionTelemetry) { + this.enableSessionTelemetry = enableSessionTelemetry; + } + + /** Gets enable citations flag. @return the flag */ + public Boolean getEnableCitations() { + return enableCitations; + } + + /** Sets enable citations flag. @param enableCitations the flag */ + public void setEnableCitations(boolean enableCitations) { + this.enableCitations = enableCitations; + } + + /** Gets the file change tracking flag. @return the flag */ + public Boolean getEnableFileChangeTracking() { + return enableFileChangeTracking; + } + + /** + * Sets the file change tracking flag. + * + * @param enableFileChangeTracking + * the flag + */ + public void setEnableFileChangeTracking(boolean enableFileChangeTracking) { + this.enableFileChangeTracking = enableFileChangeTracking; + } + + /** Gets the session limits. @return the session limits */ + public SessionLimitsConfig getSessionLimits() { + return sessionLimits; + } + + /** Sets the session limits. @param sessionLimits the session limits */ + public void setSessionLimits(SessionLimitsConfig sessionLimits) { + this.sessionLimits = sessionLimits; + } + + /** + * Clears the enableSessionTelemetry setting, reverting to the default behavior. + */ + public void clearEnableSessionTelemetry() { + this.enableSessionTelemetry = null; + } + + /** Gets request permission flag. @return the flag */ + public Boolean getRequestPermission() { + return requestPermission; + } + + /** Sets request permission flag. @param requestPermission the flag */ + public void setRequestPermission(boolean requestPermission) { + this.requestPermission = requestPermission; + } + + /** + * Clears the requestPermission setting, reverting to the default behavior. + */ + public void clearRequestPermission() { + this.requestPermission = null; + } + + /** Gets request user input flag. @return the flag */ + public Boolean getRequestUserInput() { + return requestUserInput; + } + + /** Sets request user input flag. @param requestUserInput the flag */ + public void setRequestUserInput(boolean requestUserInput) { + this.requestUserInput = requestUserInput; + } + + /** + * Clears the requestUserInput setting, reverting to the default behavior. + */ + public void clearRequestUserInput() { + this.requestUserInput = null; + } + + /** Gets hooks flag. @return the flag */ + public Boolean getHooks() { + return hooks; + } + + /** Sets hooks flag. @param hooks the flag */ + public void setHooks(boolean hooks) { + this.hooks = hooks; + } + + /** + * Clears the hooks setting, reverting to the default behavior. + */ + public void clearHooks() { + this.hooks = null; + } + + /** Gets working directory. @return the working directory */ + public String getWorkingDirectory() { + return workingDirectory; + } + + /** Sets working directory. @param workingDirectory the working directory */ + public void setWorkingDirectory(String workingDirectory) { + this.workingDirectory = workingDirectory; + } + + /** Gets additional directories. @return the additional directories */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets additional directories. + * + * @param additionalDirectories + * the additional directories + */ + public void setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + } + + /** Gets streaming flag. @return the flag */ + public Boolean getStreaming() { + return streaming; + } + + /** Sets streaming flag. @param streaming the flag */ + public void setStreaming(boolean streaming) { + this.streaming = streaming; + } + + /** + * Clears the streaming setting, reverting to the default behavior. + */ + public void clearStreaming() { + this.streaming = null; + } + + /** Gets MCP servers. @return the servers map */ + public Map getMcpServers() { + return mcpServers == null ? null : Collections.unmodifiableMap(mcpServers); + } + + /** Sets MCP servers. @param mcpServers the servers map */ + public void setMcpServers(Map mcpServers) { + this.mcpServers = mcpServers; + } + + /** Gets MCP OAuth token storage mode. @return the storage mode */ + public String getMcpOAuthTokenStorage() { + return mcpOAuthTokenStorage; + } + + /** + * Sets MCP OAuth token storage mode. @param mcpOAuthTokenStorage the storage + * mode + */ + public void setMcpOAuthTokenStorage(String mcpOAuthTokenStorage) { + this.mcpOAuthTokenStorage = mcpOAuthTokenStorage; + } + + /** Gets MCP environment variable value mode. @return the mode */ + public String getEnvValueMode() { + return envValueMode; + } + + /** Sets MCP environment variable value mode. @param envValueMode the mode */ + public void setEnvValueMode(String envValueMode) { + this.envValueMode = envValueMode; + } + + /** Gets custom agents. @return the agents */ + public List getCustomAgents() { + return customAgents == null ? null : Collections.unmodifiableList(customAgents); + } + + /** Sets custom agents. @param customAgents the agents */ + public void setCustomAgents(List customAgents) { + this.customAgents = customAgents; + } + + /** Gets whether custom agents are local only. @return the flag */ + public Boolean getCustomAgentsLocalOnly() { + return customAgentsLocalOnly; + } + + /** + * Sets whether custom agents are local only. @param customAgentsLocalOnly the + * flag + */ + public void setCustomAgentsLocalOnly(Boolean customAgentsLocalOnly) { + this.customAgentsLocalOnly = customAgentsLocalOnly; + } + + /** Gets the default agent config. @return the default agent config */ + public DefaultAgentConfig getDefaultAgent() { + return defaultAgent; + } + + /** + * Sets the default agent config. @param defaultAgent the default agent config + */ + public void setDefaultAgent(DefaultAgentConfig defaultAgent) { + this.defaultAgent = defaultAgent; + } + + /** Gets the pre-selected agent name. @return the agent name */ + public String getAgent() { + return agent; + } + + /** Sets the pre-selected agent name. @param agent the agent name */ + public void setAgent(String agent) { + this.agent = agent; + } + + /** Gets infinite sessions config. @return the config */ + public InfiniteSessionConfig getInfiniteSessions() { + return infiniteSessions; + } + + /** Sets infinite sessions config. @param infiniteSessions the config */ + public void setInfiniteSessions(InfiniteSessionConfig infiniteSessions) { + this.infiniteSessions = infiniteSessions; + } + + /** Gets skill directories. @return the skill directories */ + public List getSkillDirectories() { + return skillDirectories == null ? null : Collections.unmodifiableList(skillDirectories); + } + + /** Sets skill directories. @param skillDirectories the directories */ + public void setSkillDirectories(List skillDirectories) { + this.skillDirectories = skillDirectories; + } + + /** Gets instruction directories. @return the instruction directories */ + public List getInstructionDirectories() { + return instructionDirectories == null ? null : Collections.unmodifiableList(instructionDirectories); + } + + /** + * Sets instruction directories. @param instructionDirectories the directories + */ + public void setInstructionDirectories(List instructionDirectories) { + this.instructionDirectories = instructionDirectories; + } + + /** Gets plugin directories. @return the plugin directories */ + public List getPluginDirectories() { + return pluginDirectories == null ? null : Collections.unmodifiableList(pluginDirectories); + } + + /** Sets plugin directories. @param pluginDirectories the directories */ + public void setPluginDirectories(List pluginDirectories) { + this.pluginDirectories = pluginDirectories; + } + + /** Gets large output config. @return the large output config */ + public LargeToolOutputConfig getLargeOutput() { + return largeOutput; + } + + /** Sets large output config. @param largeOutput the large output config */ + public void setLargeOutput(LargeToolOutputConfig largeOutput) { + this.largeOutput = largeOutput; + } + + /** Gets tool-search config. @return the tool-search config */ + public ToolSearchConfig getToolSearch() { + return toolSearch; + } + + /** Sets tool-search config. @param toolSearch the tool-search config */ + public void setToolSearch(ToolSearchConfig toolSearch) { + this.toolSearch = toolSearch; + } + + /** Gets memory config. @return the memory config */ + public MemoryConfiguration getMemory() { + return memory; + } + + /** Sets memory config. @param memory the memory config */ + public void setMemory(MemoryConfiguration memory) { + this.memory = memory; + } + + /** Gets disabled skills. @return the disabled skill names */ + public List getDisabledSkills() { + return disabledSkills == null ? null : Collections.unmodifiableList(disabledSkills); + } + + /** Sets disabled skills. @param disabledSkills the skill names to disable */ + public void setDisabledSkills(List disabledSkills) { + this.disabledSkills = disabledSkills; + } + + /** Gets disabled MCP server names. @return the server names */ + public List getDisabledMcpServers() { + return disabledMcpServers == null ? null : Collections.unmodifiableList(disabledMcpServers); + } + + /** + * Sets disabled MCP server names. @param disabledMcpServers the server names + */ + public void setDisabledMcpServers(List disabledMcpServers) { + this.disabledMcpServers = disabledMcpServers; + } + + /** Gets config directory. @return the config directory path */ + public String getConfigDirectory() { + return configDirectory; + } + + /** Sets config directory. @param configDirectory the config directory path */ + public void setConfigDirectory(String configDirectory) { + this.configDirectory = configDirectory; + } + + /** Gets enable config discovery flag. @return the flag */ + public Boolean getEnableConfigDiscovery() { + return enableConfigDiscovery; + } + + /** Sets enable config discovery flag. @param enableConfigDiscovery the flag */ + public void setEnableConfigDiscovery(boolean enableConfigDiscovery) { + this.enableConfigDiscovery = enableConfigDiscovery; + } + + /** + * Clears the enableConfigDiscovery setting, reverting to the default behavior. + */ + public void clearEnableConfigDiscovery() { + this.enableConfigDiscovery = null; + } + + /** Gets skip embedding retrieval flag. @return the flag */ + public Boolean getSkipEmbeddingRetrieval() { + return skipEmbeddingRetrieval; + } + + /** + * Sets skip embedding retrieval flag. @param skipEmbeddingRetrieval the flag + */ + public void setSkipEmbeddingRetrieval(boolean skipEmbeddingRetrieval) { + this.skipEmbeddingRetrieval = skipEmbeddingRetrieval; + } + + /** + * Clears the skipEmbeddingRetrieval setting, reverting to the default behavior. + */ + public void clearSkipEmbeddingRetrieval() { + this.skipEmbeddingRetrieval = null; + } + + /** Gets organization custom instructions. @return the instructions */ + public String getOrganizationCustomInstructions() { + return organizationCustomInstructions; + } + + /** + * Sets organization custom instructions. @param organizationCustomInstructions + * the instructions + */ + public void setOrganizationCustomInstructions(String organizationCustomInstructions) { + this.organizationCustomInstructions = organizationCustomInstructions; + } + + /** Gets enable on-demand instruction discovery flag. @return the flag */ + public Boolean getEnableOnDemandInstructionDiscovery() { + return enableOnDemandInstructionDiscovery; + } + + /** + * Sets enable on-demand instruction discovery flag. @param + * enableOnDemandInstructionDiscovery the flag + */ + public void setEnableOnDemandInstructionDiscovery(boolean enableOnDemandInstructionDiscovery) { + this.enableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery; + } + + /** + * Clears the enableOnDemandInstructionDiscovery setting, reverting to the + * default behavior. + */ + public void clearEnableOnDemandInstructionDiscovery() { + this.enableOnDemandInstructionDiscovery = null; + } + + /** Gets enable file hooks flag. @return the flag */ + public Boolean getEnableFileHooks() { + return enableFileHooks; + } + + /** Sets enable file hooks flag. @param enableFileHooks the flag */ + public void setEnableFileHooks(boolean enableFileHooks) { + this.enableFileHooks = enableFileHooks; + } + + /** Clears the enableFileHooks setting, reverting to the default behavior. */ + public void clearEnableFileHooks() { + this.enableFileHooks = null; + } + + /** Gets enable host git operations flag. @return the flag */ + public Boolean getEnableHostGitOperations() { + return enableHostGitOperations; + } + + /** + * Sets enable host git operations flag. @param enableHostGitOperations the flag + */ + public void setEnableHostGitOperations(boolean enableHostGitOperations) { + this.enableHostGitOperations = enableHostGitOperations; + } + + /** + * Clears the enableHostGitOperations setting, reverting to the default + * behavior. + */ + public void clearEnableHostGitOperations() { + this.enableHostGitOperations = null; + } + + /** Gets enable session store flag. @return the flag */ + public Boolean getEnableSessionStore() { + return enableSessionStore; + } + + /** Sets enable session store flag. @param enableSessionStore the flag */ + public void setEnableSessionStore(boolean enableSessionStore) { + this.enableSessionStore = enableSessionStore; + } + + /** Clears the enableSessionStore setting, reverting to the default behavior. */ + public void clearEnableSessionStore() { + this.enableSessionStore = null; + } + + /** Gets enable skills flag. @return the flag */ + public Boolean getEnableSkills() { + return enableSkills; + } + + /** Sets enable skills flag. @param enableSkills the flag */ + public void setEnableSkills(boolean enableSkills) { + this.enableSkills = enableSkills; + } + + /** Clears the enableSkills setting, reverting to the default behavior. */ + public void clearEnableSkills() { + this.enableSkills = null; + } + + /** Gets embedding cache storage mode. @return the mode */ + public String getEmbeddingCacheStorage() { + return embeddingCacheStorage; + } + + /** Sets embedding cache storage mode. @param embeddingCacheStorage the mode */ + public void setEmbeddingCacheStorage(String embeddingCacheStorage) { + this.embeddingCacheStorage = embeddingCacheStorage; + } + + /** + * Clears the embeddingCacheStorage setting, reverting to the default behavior. + */ + public void clearEmbeddingCacheStorage() { + this.embeddingCacheStorage = null; + } + + /** Gets include sub-agent streaming events flag. @return the flag */ + public Boolean getIncludeSubAgentStreamingEvents() { + return includeSubAgentStreamingEvents; + } + + /** + * Sets include sub-agent streaming events flag. @param + * includeSubAgentStreamingEvents the flag + */ + public void setIncludeSubAgentStreamingEvents(boolean includeSubAgentStreamingEvents) { + this.includeSubAgentStreamingEvents = includeSubAgentStreamingEvents; + } + + /** + * Clears the includeSubAgentStreamingEvents setting, reverting to the default + * behavior. + */ + public void clearIncludeSubAgentStreamingEvents() { + this.includeSubAgentStreamingEvents = null; + } + + /** Gets the GitHub telemetry forwarding flag. @return the flag */ + public Boolean getEnableGitHubTelemetryForwarding() { + return enableGitHubTelemetryForwarding; + } + + /** + * Sets the GitHub telemetry forwarding flag. @param + * enableGitHubTelemetryForwarding the flag + */ + public void setEnableGitHubTelemetryForwarding(boolean enableGitHubTelemetryForwarding) { + this.enableGitHubTelemetryForwarding = enableGitHubTelemetryForwarding; + } + + /** + * Clears the enableGitHubTelemetryForwarding setting, reverting to the default + * behavior. + */ + public void clearEnableGitHubTelemetryForwarding() { + this.enableGitHubTelemetryForwarding = null; + } + + /** Gets the commands wire definitions. @return the commands */ + public List getCommands() { + return commands == null ? null : Collections.unmodifiableList(commands); + } + + /** Sets the commands wire definitions. @param commands the commands */ + public void setCommands(List commands) { + this.commands = commands; + } + + /** Gets the requestElicitation flag. @return the flag */ + public Boolean getRequestElicitation() { + return requestElicitation; + } + + /** Sets the requestElicitation flag. @param requestElicitation the flag */ + public void setRequestElicitation(boolean requestElicitation) { + this.requestElicitation = requestElicitation; + } + + /** + * Clears the requestElicitation setting, reverting to the default behavior. + */ + public void clearRequestElicitation() { + this.requestElicitation = null; + } + + /** Gets the requestMcpApps flag. @return the flag */ + public Boolean getRequestMcpApps() { + return requestMcpApps; + } + + /** Sets the requestMcpApps flag. @param requestMcpApps the flag */ + public void setRequestMcpApps(boolean requestMcpApps) { + this.requestMcpApps = requestMcpApps; + } + + /** Clears the requestMcpApps setting, reverting to the default behavior. */ + public void clearRequestMcpApps() { + this.requestMcpApps = null; + } + + /** Gets the GitHub MCP tool configuration. @return the configuration */ + public GitHubMcpToolConfig getGitHubMcpToolConfig() { + return githubMcpToolConfig; + } + + /** Sets the GitHub MCP tool configuration. @param config the value */ + public void setGitHubMcpToolConfig(GitHubMcpToolConfig config) { + this.githubMcpToolConfig = config; + } + + /** + * Gets the isExperimentalMode flag. + * + * @return the flag + */ + public Boolean getIsExperimentalMode() { + return isExperimentalMode; + } + + /** + * Sets the isExperimentalMode flag. + * + * @param isExperimentalMode + * the flag + */ + public void setIsExperimentalMode(boolean isExperimentalMode) { + this.isExperimentalMode = isExperimentalMode; + } + + /** Clears the isExperimentalMode setting, reverting to the default behavior. */ + public void clearIsExperimentalMode() { + this.isExperimentalMode = null; + } + + /** Gets the requestExitPlanMode flag. @return the flag */ + public Boolean getRequestExitPlanMode() { + return requestExitPlanMode; + } + + /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */ + public void setRequestExitPlanMode(Boolean requestExitPlanMode) { + this.requestExitPlanMode = requestExitPlanMode; + } + + /** Gets the requestAutoModeSwitch flag. @return the flag */ + public Boolean getRequestAutoModeSwitch() { + return requestAutoModeSwitch; + } + + /** + * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag + */ + public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) { + this.requestAutoModeSwitch = requestAutoModeSwitch; + } + + /** Gets the model capabilities override. @return the override */ + public ModelCapabilitiesOverride getModelCapabilities() { + return modelCapabilities; + } + + /** + * Sets the model capabilities override. @param modelCapabilities the override + */ + public void setModelCapabilities(ModelCapabilitiesOverride modelCapabilities) { + this.modelCapabilities = modelCapabilities; + } + + /** Gets the GitHub token for per-session authentication. @return the token */ + public String getGitHubToken() { + return gitHubToken; + } + + /** + * Sets the GitHub token for per-session authentication. @param gitHubToken the + * token + */ + public void setGitHubToken(String gitHubToken) { + this.gitHubToken = gitHubToken; + } + + /** Gets the remote session mode. @return the remote session mode */ + public String getRemoteSession() { + return remoteSession; + } + + /** + * Sets the remote session mode. @param remoteSession the remote session mode + */ + public void setRemoteSession(String remoteSession) { + this.remoteSession = remoteSession; + } + + /** Gets the cloud session options. @return the cloud session options */ + public CloudSessionOptions getCloud() { + return cloud; + } + + /** Sets the cloud session options. @param cloud the cloud session options */ + public void setCloud(CloudSessionOptions cloud) { + this.cloud = cloud; + } + + /** Gets the ExP assignment data. @return the ExP assignment data */ + public CopilotExpAssignmentResponse getExpAssignments() { + return expAssignments; + } + + /** + * Sets the ExP assignment data. @param expAssignments the ExP assignment data + */ + public void setExpAssignments(CopilotExpAssignmentResponse expAssignments) { + this.expAssignments = expAssignments; + } + + /** + * Gets the self-fetch managed settings flag. @return the flag, or {@code null} + * if not set + */ + public Boolean getEnableManagedSettings() { + return enableManagedSettings; + } + + /** + * Sets the self-fetch managed settings flag. @param enableManagedSettings the + * flag + */ + public void setEnableManagedSettings(boolean enableManagedSettings) { + this.enableManagedSettings = enableManagedSettings; + } + + /** + * Clears the enableManagedSettings setting, reverting to the default behavior. + */ + public void clearEnableManagedSettings() { + this.enableManagedSettings = null; + } + + /** @return host-injected managed settings, or {@code null} when unset */ + public ManagedSettings getManagedSettings() { + return managedSettings; + } + + /** + * @param managedSettings + * host-injected managed settings + */ + public void setManagedSettings(ManagedSettings managedSettings) { + this.managedSettings = managedSettings; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java new file mode 100644 index 000000000..e899ce78e --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java @@ -0,0 +1,30 @@ +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.rpc.OpenCanvasInstance; +import java.util.List; + +/** + * Internal response object from creating a session. + *

+ * The {@code openCanvases} component was added in 1.0.1. + * + * @param sessionId + * the session ID assigned by the server + * @param workspacePath + * the workspace path, or {@code null} if infinite sessions are + * disabled + * @param capabilities + * the capabilities reported by the host, or {@code null} + * @param openCanvases + * the canvas instances open for the session, or {@code null} (since + * 1.0.1) + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public record CreateSessionResponse(@JsonProperty("sessionId") String sessionId, + @JsonProperty("workspacePath") String workspacePath, + @JsonProperty("capabilities") SessionCapabilities capabilities, + @JsonProperty("openCanvases") List openCanvases) { +} diff --git a/java/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java similarity index 90% rename from java/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java index 5136f7778..62de19b6a 100644 --- a/java/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/CustomAgentConfig.java @@ -63,6 +63,9 @@ public class CustomAgentConfig { @JsonProperty("model") private String model; + @JsonProperty("reasoningEffort") + private String reasoningEffort; + /** * Gets the unique identifier name for this agent. * @@ -282,4 +285,28 @@ public CustomAgentConfig setModel(String model) { this.model = model; return this; } + + /** + * Gets the reasoning effort level for this agent's model. + * + * @return the reasoning effort level, or {@code null} if not set + */ + public String getReasoningEffort() { + return reasoningEffort; + } + + /** + * Sets the reasoning effort level for this agent's model. + *

+ * When omitted, the runtime resolves model configuration, then inherits the + * parent effort only if this agent uses the same model. + * + * @param reasoningEffort + * the reasoning effort level + * @return this config for method chaining + */ + public CustomAgentConfig setReasoningEffort(String reasoningEffort) { + this.reasoningEffort = reasoningEffort; + return this; + } } diff --git a/java/src/main/java/com/github/copilot/rpc/DefaultAgentConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/DefaultAgentConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/DefaultAgentConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/DefaultAgentConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/DeleteSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/DeleteSessionResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/DeleteSessionResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/DeleteSessionResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationContext.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationContext.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationContext.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationContext.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationParams.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationParams.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationParams.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationParams.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationResult.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationResult.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationResult.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationResultAction.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationResultAction.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationResultAction.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationResultAction.java diff --git a/java/src/main/java/com/github/copilot/rpc/ElicitationSchema.java b/java/sdk/src/main/java/com/github/copilot/rpc/ElicitationSchema.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ElicitationSchema.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ElicitationSchema.java diff --git a/java/src/main/java/com/github/copilot/rpc/ExitPlanModeHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ExitPlanModeHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/ExitPlanModeInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeInvocation.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ExitPlanModeInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeInvocation.java diff --git a/java/src/main/java/com/github/copilot/rpc/ExitPlanModeRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ExitPlanModeRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/ExitPlanModeResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeResult.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ExitPlanModeResult.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ExitPlanModeResult.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java b/java/sdk/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java new file mode 100644 index 000000000..7905b2c06 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ExpConfigEntry.java @@ -0,0 +1,72 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.LinkedHashMap; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * A single configuration entry within a {@link CopilotExpAssignmentResponse}. + *

+ * Each entry carries an identifier and a bag of typed parameter values, where + * each value is a string, number, boolean, or {@code null}. Property names + * serialize as PascalCase to match the experimentation-service wire contract. + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class ExpConfigEntry { + + @JsonProperty("Id") + private String id = ""; + + @JsonProperty("Parameters") + private Map parameters = new LinkedHashMap<>(); + + /** + * Gets the identifier of this configuration entry. + * + * @return the entry identifier (empty string when unset) + */ + public String getId() { + return id; + } + + /** + * Sets the identifier of this configuration entry. + * + * @param id + * the entry identifier + * @return this instance for method chaining + */ + public ExpConfigEntry setId(String id) { + this.id = id; + return this; + } + + /** + * Gets the parameter values keyed by parameter name. Each value is a string, + * number, boolean, or {@code null}. + * + * @return the parameter map + */ + public Map getParameters() { + return parameters; + } + + /** + * Sets the parameter values keyed by parameter name. Each value is a string, + * number, boolean, or {@code null}. + * + * @param parameters + * the parameter map + * @return this instance for method chaining + */ + public ExpConfigEntry setParameters(Map parameters) { + this.parameters = parameters; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/GetAuthStatusResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetAuthStatusResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetAuthStatusResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetAuthStatusResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetForegroundSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetForegroundSessionResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetForegroundSessionResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetForegroundSessionResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetLastSessionIdResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetLastSessionIdResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetLastSessionIdResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetLastSessionIdResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetMessagesResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetMessagesResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetMessagesResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetMessagesResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetModelsResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetModelsResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetModelsResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetModelsResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetSessionMetadataResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetSessionMetadataResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetSessionMetadataResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetSessionMetadataResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/GetStatusResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/GetStatusResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/GetStatusResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/GetStatusResponse.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/GitHubMcpToolConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubMcpToolConfig.java new file mode 100644 index 000000000..75a8e3016 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/GitHubMcpToolConfig.java @@ -0,0 +1,82 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Configuration for the built-in GitHub MCP server. + * + *

+ * {@code disableFormDeferral} only applies to the built-in GitHub MCP server + * and only has an effect when MCP Apps and form-backed GitHub tools are + * enabled. + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class GitHubMcpToolConfig { + + @JsonProperty("enableAllTools") + private Boolean enableAllTools; + + @JsonProperty("additionalToolsets") + private List additionalToolsets; + + @JsonProperty("additionalTools") + private List additionalTools; + + @JsonProperty("enableInsidersMode") + private Boolean enableInsidersMode; + + @JsonProperty("disableFormDeferral") + private Boolean disableFormDeferral; + + public Boolean getEnableAllTools() { + return enableAllTools; + } + + public GitHubMcpToolConfig setEnableAllTools(Boolean enableAllTools) { + this.enableAllTools = enableAllTools; + return this; + } + + public List getAdditionalToolsets() { + return additionalToolsets; + } + + public GitHubMcpToolConfig setAdditionalToolsets(List additionalToolsets) { + this.additionalToolsets = additionalToolsets; + return this; + } + + public List getAdditionalTools() { + return additionalTools; + } + + public GitHubMcpToolConfig setAdditionalTools(List additionalTools) { + this.additionalTools = additionalTools; + return this; + } + + public Boolean getEnableInsidersMode() { + return enableInsidersMode; + } + + public GitHubMcpToolConfig setEnableInsidersMode(Boolean enableInsidersMode) { + this.enableInsidersMode = enableInsidersMode; + return this; + } + + public Boolean getDisableFormDeferral() { + return disableFormDeferral; + } + + public GitHubMcpToolConfig setDisableFormDeferral(Boolean disableFormDeferral) { + this.disableFormDeferral = disableFormDeferral; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/HookInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/HookInvocation.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/HookInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/HookInvocation.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/InProcessRuntimeConnection.java b/java/sdk/src/main/java/com/github/copilot/rpc/InProcessRuntimeConnection.java new file mode 100644 index 000000000..274f8b89d --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/InProcessRuntimeConnection.java @@ -0,0 +1,27 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.CopilotExperimental; + +/** + * Hosts the runtime in-process by loading its native library and communicating + * over the C ABI — no child process is spawned by the SDK for JSON-RPC + * transport. Construct with {@link RuntimeConnection#forInProcess()}. + *

+ * The in-process runtime is self-contained: it carries everything it needs and + * requires no external installation. Because it runs inside the host process, + * per-client process settings ({@code environment}, {@code telemetry}, + * {@code cwd}, and {@code cliArgs}) are rejected; configure those on the host + * process instead, or use a child-process connection. + * + * @since 1.0.0 + */ +@CopilotExperimental +public final class InProcessRuntimeConnection extends RuntimeConnection { + + InProcessRuntimeConnection() { + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/InfiniteSessionConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/InfiniteSessionConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/InfiniteSessionConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/InfiniteSessionConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/InputOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/InputOptions.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/InputOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/InputOptions.java diff --git a/java/src/main/java/com/github/copilot/rpc/JsonRpcError.java b/java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcError.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/JsonRpcError.java rename to java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcError.java diff --git a/java/src/main/java/com/github/copilot/rpc/JsonRpcRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/JsonRpcRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/JsonRpcResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/JsonRpcResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/JsonRpcResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/LargeToolOutputConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/LargeToolOutputConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/LargeToolOutputConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/LargeToolOutputConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/ListSessionsResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/ListSessionsResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ListSessionsResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ListSessionsResponse.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettings.java b/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettings.java new file mode 100644 index 000000000..39e8fcf55 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettings.java @@ -0,0 +1,34 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Managed settings an SDK host may inject at session create or resume. + * + *

+ * The initial public contract is permissions-only. + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public final class ManagedSettings { + @JsonProperty("permissions") + private ManagedSettingsPermissions permissions; + + /** @return the managed permission policy, or {@code null} when unset */ + public ManagedSettingsPermissions getPermissions() { + return permissions; + } + + /** + * @param permissions + * managed permission policy + * @return this settings object + */ + public ManagedSettings setPermissions(ManagedSettingsPermissions permissions) { + this.permissions = permissions; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettingsPermissions.java b/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettingsPermissions.java new file mode 100644 index 000000000..0923cea54 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ManagedSettingsPermissions.java @@ -0,0 +1,90 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.rpc.DisableBypassPermissionsMode; +import java.util.ArrayList; +import java.util.List; + +/** + * Enterprise permission policy injected by an SDK host at session startup. + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public final class ManagedSettingsPermissions { + @JsonProperty("disableBypassPermissionsMode") + private DisableBypassPermissionsMode disableBypassPermissionsMode; + + @JsonProperty("deny") + private List deny; + + @JsonProperty("ask") + private List ask; + + @JsonProperty("allow") + private List allow; + + /** @return the bypass-permissions policy, or {@code null} when unset */ + public DisableBypassPermissionsMode getDisableBypassPermissionsMode() { + return disableBypassPermissionsMode; + } + + /** + * Disables bypass/allow-all permission modes. + * + * @param value + * bypass-permissions policy + * @return this policy + */ + public ManagedSettingsPermissions setDisableBypassPermissionsMode(DisableBypassPermissionsMode value) { + this.disableBypassPermissionsMode = value; + return this; + } + + /** @return rules that deny matching operations, or {@code null} when unset */ + public List getDeny() { + return deny; + } + + /** + * @param rules + * deny rules + * @return this policy + */ + public ManagedSettingsPermissions setDeny(List rules) { + this.deny = rules == null ? null : new ArrayList<>(rules); + return this; + } + + /** @return rules that require approval, or {@code null} when unset */ + public List getAsk() { + return ask; + } + + /** + * @param rules + * ask rules + * @return this policy + */ + public ManagedSettingsPermissions setAsk(List rules) { + this.ask = rules == null ? null : new ArrayList<>(rules); + return this; + } + + /** @return rules that allow matching operations, or {@code null} when unset */ + public List getAllow() { + return allow; + } + + /** + * @param rules + * allow rules + * @return this policy + */ + public ManagedSettingsPermissions setAllow(List rules) { + this.allow = rules == null ? null : new ArrayList<>(rules); + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthHandler.java new file mode 100644 index 000000000..55c6a6f18 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthHandler.java @@ -0,0 +1,26 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +/** + * Handles MCP OAuth requests from the runtime. + * + * @since 1.0.0 + */ +@FunctionalInterface +public interface McpAuthHandler { + /** + * Handles an MCP OAuth request. + * + * @param request + * the MCP OAuth request details + * @param invocation + * the invocation context with session information + * @return a future resolving to token data or cancellation + */ + CompletableFuture handle(McpAuthRequest request, McpAuthInvocation invocation); +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java new file mode 100644 index 000000000..c7a80a96d --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthInvocation.java @@ -0,0 +1,36 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Context for an MCP OAuth request invocation. + * + * @since 1.0.0 + */ +public class McpAuthInvocation { + + private String sessionId; + + /** + * Gets the session ID. + * + * @return the session ID + */ + public String getSessionId() { + return sessionId; + } + + /** + * Sets the session ID. + * + * @param sessionId + * the session ID + * @return this instance for method chaining + */ + public McpAuthInvocation setSessionId(String sessionId) { + this.sessionId = sessionId; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthRequest.java new file mode 100644 index 000000000..a67268555 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthRequest.java @@ -0,0 +1,19 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.generated.McpOauthRequiredStaticClientConfig; +import com.github.copilot.generated.McpOauthRequestReason; +import com.github.copilot.generated.McpOauthWWWAuthenticateParams; + +/** + * MCP OAuth request that the SDK host can satisfy with a host-acquired token. + * + * @since 1.0.0 + */ +public record McpAuthRequest(String requestId, String serverName, String serverUrl, McpOauthRequestReason reason, + McpOauthWWWAuthenticateParams wwwAuthenticateParams, String resourceMetadata, + McpOauthRequiredStaticClientConfig staticClientConfig) { +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthResult.java new file mode 100644 index 000000000..6b7fda34f --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthResult.java @@ -0,0 +1,32 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Result returned by an MCP auth request handler. + * + * @since 1.0.0 + */ +public record McpAuthResult(boolean isCancelled, McpAuthToken token) { + /** + * Creates a token result. + * + * @param token + * the host-provided OAuth token data + * @return token result + */ + public static McpAuthResult token(McpAuthToken token) { + return new McpAuthResult(false, token); + } + + /** + * Creates a cancellation result. + * + * @return cancellation result + */ + public static McpAuthResult cancelled() { + return new McpAuthResult(true, null); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthToken.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthToken.java new file mode 100644 index 000000000..3cf6748fb --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/McpAuthToken.java @@ -0,0 +1,13 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Host-provided OAuth token data for a pending MCP OAuth request. + * + * @since 1.0.0 + */ +public record McpAuthToken(String accessToken, String tokenType, Long expiresIn) { +} diff --git a/java/src/main/java/com/github/copilot/rpc/McpHttpServerConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpHttpServerConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpHttpServerConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpHttpServerConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpServerConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpServerConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpServerConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpServerConfig.java diff --git a/java/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/McpStdioServerConfig.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java b/java/sdk/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java new file mode 100644 index 000000000..c04f6eaf7 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/MemoryConfiguration.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Configuration for session memory. + *

+ * Controls whether the session can read and write persistent memory. + * + * @since 1.6.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class MemoryConfiguration { + + @JsonProperty("enabled") + private boolean enabled; + + /** + * Gets whether memory is enabled for the session. + * + * @return {@code true} if memory is enabled, {@code false} otherwise + */ + public boolean getEnabled() { + return enabled; + } + + /** + * Sets whether memory is enabled for the session. + * + * @param enabled + * {@code true} to enable memory, {@code false} to disable + * @return this config for method chaining + */ + public MemoryConfiguration setEnabled(boolean enabled) { + this.enabled = enabled; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/MessageAttachment.java b/java/sdk/src/main/java/com/github/copilot/rpc/MessageAttachment.java similarity index 98% rename from java/src/main/java/com/github/copilot/rpc/MessageAttachment.java rename to java/sdk/src/main/java/com/github/copilot/rpc/MessageAttachment.java index e28c5da2e..9b2af3ee0 100644 --- a/java/src/main/java/com/github/copilot/rpc/MessageAttachment.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/MessageAttachment.java @@ -16,7 +16,7 @@ * @see Attachment * @see BlobAttachment * @see MessageOptions#setAttachments(java.util.List) - * @since 1.2.0 + * @since 1.0.0 */ @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type") @JsonSubTypes({@JsonSubTypes.Type(value = Attachment.class, name = "file"), diff --git a/java/src/main/java/com/github/copilot/rpc/MessageOptions.java b/java/sdk/src/main/java/com/github/copilot/rpc/MessageOptions.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/MessageOptions.java rename to java/sdk/src/main/java/com/github/copilot/rpc/MessageOptions.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ModelBilling.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelBilling.java new file mode 100644 index 000000000..f495e8747 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ModelBilling.java @@ -0,0 +1,60 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.rpc.ModelBillingTokenPrices; +import java.util.OptionalDouble; + +/** + * Model billing information. + * + * @since 1.0.1 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +public class ModelBilling { + + @JsonProperty("multiplier") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Double multiplier; + + @JsonProperty("tokenPrices") + private ModelBillingTokenPrices tokenPrices; + + @JsonIgnore + public double getMultiplier() { + return multiplier != null ? multiplier : 0.0; + } + + public ModelBilling setMultiplier(double multiplier) { + this.multiplier = multiplier; + return this; + } + + /** + * Returns the billing multiplier as an {@link java.util.OptionalDouble}, + * allowing callers to distinguish "absent" from "zero". + * + * @return an {@link java.util.OptionalDouble} containing the multiplier, or + * {@link java.util.OptionalDouble#empty()} if not set + * @since 1.0.2 + */ + @JsonIgnore + public OptionalDouble getMultiplierOpt() { + return multiplier == null ? OptionalDouble.empty() : OptionalDouble.of(multiplier); + } + + public ModelBillingTokenPrices getTokenPrices() { + return tokenPrices; + } + + public ModelBilling setTokenPrices(ModelBillingTokenPrices tokenPrices) { + this.tokenPrices = tokenPrices; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/ModelCapabilities.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelCapabilities.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelCapabilities.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelCapabilities.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelCapabilitiesOverride.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelCapabilitiesOverride.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelCapabilitiesOverride.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelCapabilitiesOverride.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelInfo.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelInfo.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelInfo.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelInfo.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelLimits.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelLimits.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelLimits.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelLimits.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelPolicy.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelPolicy.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelPolicy.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelPolicy.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelSupports.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelSupports.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelSupports.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelSupports.java diff --git a/java/src/main/java/com/github/copilot/rpc/ModelVisionLimits.java b/java/sdk/src/main/java/com/github/copilot/rpc/ModelVisionLimits.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ModelVisionLimits.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ModelVisionLimits.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java new file mode 100644 index 000000000..e3b090019 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/NamedProviderConfig.java @@ -0,0 +1,294 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Collections; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +import com.github.copilot.CopilotExperimental; + +/** + * A named BYOK (Bring Your Own Key) provider connection in the multi-provider + * registry. + *

+ * Unlike {@link ProviderConfig}, which routes the entire session through a + * single provider, named providers are additive: the session keeps its default + * Copilot routing and exposes these providers' models alongside it. Models are + * attached via {@link ProviderModelConfig}, which references a provider by + * {@link #getName() name}. All setter methods return {@code this} for method + * chaining. + *

+ * Experimental. Multi-provider BYOK configuration is + * experimental and may change or be removed in future SDK or CLI releases. + * + *

Example Usage

+ * + * 
{@code
+ * var provider = new NamedProviderConfig().setName("my-openai").setType("openai")
+ * 		.setBaseUrl("https://api.openai.com/v1").setApiKey("sk-...");
+ * }
+ * + * @see SessionConfig#setProviders(java.util.List) + * @see ProviderModelConfig + * @since 1.0.0 + */ +@CopilotExperimental +@JsonInclude(JsonInclude.Include.NON_NULL) +public class NamedProviderConfig { + + @JsonProperty("name") + private String name; + + @JsonProperty("type") + private String type; + + @JsonProperty("wireApi") + private String wireApi; + + @JsonProperty("baseUrl") + private String baseUrl; + + @JsonProperty("apiKey") + private String apiKey; + + @JsonProperty("bearerToken") + private String bearerToken; + + @JsonIgnore + private BearerTokenProvider bearerTokenProvider; + + @JsonProperty("azure") + private AzureOptions azure; + + @JsonProperty("headers") + private Map headers; + + /** + * Gets the unique provider name. + * + * @return the provider name + */ + public String getName() { + return name; + } + + /** + * Sets the unique provider name. + *

+ * Referenced by {@link ProviderModelConfig#setProvider(String)} to attach + * models to this connection. + * + * @param name + * the provider name + * @return this config for method chaining + */ + public NamedProviderConfig setName(String name) { + this.name = name; + return this; + } + + /** + * Gets the provider type. + * + * @return the provider type (e.g., "openai", "azure", "anthropic") + */ + public String getType() { + return type; + } + + /** + * Sets the provider type. + *

+ * Supported types include: + *

    + *
  • "openai" - OpenAI API
    • + *
  • "azure" - Azure OpenAI Service
    • + *
  • "anthropic" - Anthropic API
    • + *
+ * + * @param type + * the provider type + * @return this config for method chaining + */ + public NamedProviderConfig setType(String type) { + this.type = type; + return this; + } + + /** + * Gets the wire API format. + * + * @return the wire API format + */ + public String getWireApi() { + return wireApi; + } + + /** + * Sets the wire API format (openai/azure only). + *

+ * Either "completions" or "responses". Defaults to "completions". + * + * @param wireApi + * the wire API format + * @return this config for method chaining + */ + public NamedProviderConfig setWireApi(String wireApi) { + this.wireApi = wireApi; + return this; + } + + /** + * Gets the base URL for the API. + * + * @return the API base URL + */ + public String getBaseUrl() { + return baseUrl; + } + + /** + * Sets the base URL for the API. + *

+ * For OpenAI, this is typically "https://api.openai.com/v1". + * + * @param baseUrl + * the API base URL + * @return this config for method chaining + */ + public NamedProviderConfig setBaseUrl(String baseUrl) { + this.baseUrl = baseUrl; + return this; + } + + /** + * Gets the API key. + * + * @return the API key + */ + public String getApiKey() { + return apiKey; + } + + /** + * Sets the API key for authentication. Optional for local providers like + * Ollama. + * + * @param apiKey + * the API key + * @return this config for method chaining + */ + public NamedProviderConfig setApiKey(String apiKey) { + this.apiKey = apiKey; + return this; + } + + /** + * Gets the bearer token. + * + * @return the bearer token + */ + public String getBearerToken() { + return bearerToken; + } + + /** + * Sets a bearer token for authentication. + *

+ * Sets the {@code Authorization} header directly and takes precedence over + * {@link #setApiKey(String)} when both are set. + *

+ * Note: The bearer token is a static token + * string. The SDK does not refresh this token automatically. + * + * @param bearerToken + * the bearer token + * @return this config for method chaining + */ + public NamedProviderConfig setBearerToken(String bearerToken) { + this.bearerToken = bearerToken; + return this; + } + + /** + * Gets the bearer-token provider callback. + * + * @return the bearer-token provider callback, or {@code null} if not set + */ + public BearerTokenProvider getBearerTokenProvider() { + return bearerTokenProvider; + } + + /** + * Sets a callback that supplies bearer tokens for outbound provider requests. + *

+ * Experimental. The callback stays SDK-side and is not + * serialized. Instead, the runtime receives a {@code hasBearerTokenProvider} + * flag and calls back over the session-scoped {@code providerToken.getToken} + * RPC before each model request. Return the raw token without a {@code Bearer } + * prefix. + * + * @param bearerTokenProvider + * the bearer-token provider callback + * @return this config for method chaining + */ + public NamedProviderConfig setBearerTokenProvider(BearerTokenProvider bearerTokenProvider) { + this.bearerTokenProvider = bearerTokenProvider; + return this; + } + + @JsonProperty("hasBearerTokenProvider") + @JsonInclude(JsonInclude.Include.NON_NULL) + Boolean hasBearerTokenProviderWireFlag() { + return bearerTokenProvider != null ? Boolean.TRUE : null; + } + + /** + * Gets the Azure-specific options. + * + * @return the Azure options + */ + public AzureOptions getAzure() { + return azure; + } + + /** + * Sets Azure-specific options for Azure OpenAI Service. + * + * @param azure + * the Azure options + * @return this config for method chaining + * @see AzureOptions + */ + public NamedProviderConfig setAzure(AzureOptions azure) { + this.azure = azure; + return this; + } + + /** + * Gets the custom HTTP headers for outbound provider requests. + * + * @return the headers map, or {@code null} if not set + */ + public Map getHeaders() { + return headers == null ? null : Collections.unmodifiableMap(headers); + } + + /** + * Sets custom HTTP headers to include in outbound provider requests. + * + * @param headers + * the headers map + * @return this config for method chaining + */ + public NamedProviderConfig setHeaders(Map headers) { + this.headers = headers; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ParamCoercion.java b/java/sdk/src/main/java/com/github/copilot/rpc/ParamCoercion.java new file mode 100644 index 000000000..fc8274254 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ParamCoercion.java @@ -0,0 +1,197 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Map; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.tool.Param; + +/** + * Internal runtime helper: coerces raw invocation arguments to the typed values + * declared by {@link Param} descriptors. + * + *

+ * Reuses the SDK-configured {@link ObjectMapper} for complex type conversions, + * matching the coercion policy applied by existing ergonomic tooling. No + * bespoke conversion paths are introduced. + * + *

+ * Package-private: not part of the public API. + */ +class ParamCoercion { + + /** Utility class; do not instantiate. */ + private ParamCoercion() { + } + + /** + * Coerces the named argument from an invocation argument map to the Java type + * declared by {@code param}. + * + *

+ * Resolution order: + *

    + *
  1. If the argument is present, convert it to {@code T} via + * {@link ObjectMapper#convertValue}.
    2. + *
  2. If absent and a default value is set, parse the string default via + * {@link #coerceDefault}.
    3. + *
  3. If absent and the parameter is optional ({@code required=false}), return + * an empty Optional variant or {@code null}.
    4. + *
  4. If absent and required, throw {@link IllegalArgumentException} with the + * parameter name.
    5. + *
+ * + * @param + * the target Java type + * @param args + * the invocation argument map; may be {@code null} for zero-argument + * tools + * @param param + * the parameter descriptor + * @param mapper + * the configured {@link ObjectMapper} for complex type conversion + * @return the coerced argument value + * @throws IllegalArgumentException + * if a required parameter is missing or coercion fails + */ + @SuppressWarnings("unchecked") + static T coerce(Map args, Param param, ObjectMapper mapper) { + Object raw = (args != null) ? args.get(param.name()) : null; + + if (raw == null) { + if (param.hasDefaultValue()) { + return coerceDefault(param, mapper); + } else if (!param.required()) { + return (T) emptyOptionalOrNull(param.type()); + } else { + throw new IllegalArgumentException( + "Required parameter '" + param.name() + "' is missing from tool invocation"); + } + } + + Class type = param.type(); + + // Handle Optional* types explicitly before delegating to ObjectMapper + if (type == java.util.OptionalInt.class) { + try { + return (T) java.util.OptionalInt.of(((Number) raw).intValue()); + } catch (ClassCastException ex) { + throw new IllegalArgumentException("Parameter '" + param.name() + + "' expected a numeric value for OptionalInt, got: " + raw.getClass().getSimpleName(), ex); + } + } + if (type == java.util.OptionalLong.class) { + try { + return (T) java.util.OptionalLong.of(((Number) raw).longValue()); + } catch (ClassCastException ex) { + throw new IllegalArgumentException("Parameter '" + param.name() + + "' expected a numeric value for OptionalLong, got: " + raw.getClass().getSimpleName(), ex); + } + } + if (type == java.util.OptionalDouble.class) { + try { + return (T) java.util.OptionalDouble.of(((Number) raw).doubleValue()); + } catch (ClassCastException ex) { + throw new IllegalArgumentException("Parameter '" + param.name() + + "' expected a numeric value for OptionalDouble, got: " + raw.getClass().getSimpleName(), ex); + } + } + + try { + return mapper.convertValue(raw, type); + } catch (IllegalArgumentException ex) { + throw new IllegalArgumentException( + "Failed to coerce parameter '" + param.name() + "' to type " + type.getSimpleName(), ex); + } + } + + /** + * Parses a {@link Param}'s string default value into the declared Java type. + * + *

+ * Handles primitives, boxed types, {@link String}, {@link Boolean}, and enums + * explicitly, mirroring the validation logic in {@link Param}. The + * {@link ObjectMapper#readValue} fallback exists as a safety net but is not + * expected to be reached in practice, since {@link Param} construction rejects + * defaults for non-primitive/boxed/String/Boolean/enum types. + * + * @param + * the target Java type + * @param param + * the parameter descriptor carrying the default value + * @param mapper + * the configured {@link ObjectMapper} used as fallback for complex + * types + * @return the parsed default value + * @throws IllegalArgumentException + * if parsing fails + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + static T coerceDefault(Param param, ObjectMapper mapper) { + String defaultValue = param.defaultValue(); + Class type = param.type(); + try { + if (type == String.class) { + return type.cast(defaultValue); + } + if (type == Integer.class || type == int.class) { + return (T) Integer.valueOf(defaultValue); + } + if (type == Long.class || type == long.class) { + return (T) Long.valueOf(defaultValue); + } + if (type == Double.class || type == double.class) { + return (T) Double.valueOf(defaultValue); + } + if (type == Float.class || type == float.class) { + return (T) Float.valueOf(defaultValue); + } + if (type == Short.class || type == short.class) { + return (T) Short.valueOf(defaultValue); + } + if (type == Byte.class || type == byte.class) { + return (T) Byte.valueOf(defaultValue); + } + if (type == Boolean.class || type == boolean.class) { + return (T) Boolean.valueOf(defaultValue); + } + if (type.isEnum()) { + Class enumType = (Class) type; + return type.cast(Enum.valueOf(enumType, defaultValue)); + } + // Fallback: let ObjectMapper parse the JSON-encoded default string + return mapper.readValue(defaultValue, type); + } catch (IllegalArgumentException ex) { + throw ex; + } catch (Exception ex) { + throw new IllegalArgumentException("Failed to apply default value '" + defaultValue + "' for parameter '" + + param.name() + "' of type " + type.getSimpleName(), ex); + } + } + + /** + * Returns an empty Optional variant for Optional primitive types, or + * {@code null} for all other types. + * + * @param type + * the declared parameter type + * @return {@link java.util.OptionalInt#empty()}, + * {@link java.util.OptionalLong#empty()}, + * {@link java.util.OptionalDouble#empty()}, or {@code null} + */ + static Object emptyOptionalOrNull(Class type) { + if (type == java.util.OptionalInt.class) { + return java.util.OptionalInt.empty(); + } + if (type == java.util.OptionalLong.class) { + return java.util.OptionalLong.empty(); + } + if (type == java.util.OptionalDouble.class) { + return java.util.OptionalDouble.empty(); + } + return null; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ParamSchema.java b/java/sdk/src/main/java/com/github/copilot/rpc/ParamSchema.java new file mode 100644 index 000000000..bdb4f38ae --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ParamSchema.java @@ -0,0 +1,205 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; + +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.tool.Param; + +/** + * Internal runtime helper: maps {@link Param} metadata to JSON Schema + * {@code Map} objects. + * + *

+ * This class is a simplified runtime counterpart to the compile-time + * {@code SchemaGenerator}. It operates on {@code java.lang.reflect.Class} + * values instead of {@code javax.lang.model} mirrors, and produces {@link Map} + * instances rather than Java source-code literals. Unlike + * {@code SchemaGenerator}, it does not inspect generics or object members + * (records/POJOs) and therefore produces flat type mappings only (no + * {@code additionalProperties} or nested object {@code properties}). It does + * produce {@code items} for plain Java arrays via component-type recursion. + * + *

+ * Package-private: not part of the public API. + */ +class ParamSchema { + + /** Utility class; do not instantiate. */ + private ParamSchema() { + } + + /** + * Builds a JSON Schema {@code Map} from zero or more {@link Param} descriptors. + * + *

+ * Validation applied: + *

    + *
  • Each {@link Param} must be non-null.
    • + *
  • Parameter names must be unique; duplicates throw + * {@link IllegalArgumentException} with the tool name and duplicate name.
    • + *
+ * + * @param toolName + * the tool name, included in exception messages for clarity + * @param mapper + * the configured {@link ObjectMapper} used to coerce default values + * into their typed form for the schema + * @param params + * zero or more parameter descriptors + * @return a JSON Schema object map with {@code type=object}, + * {@code properties}, and {@code required} keys + * @throws IllegalArgumentException + * if a null param or duplicate parameter names are found + */ + static Map buildSchema(String toolName, ObjectMapper mapper, Param... params) { + if (params == null || params.length == 0) { + return Map.of("type", "object", "properties", Map.of(), "required", List.of()); + } + + // Validate: no null params, no duplicate names + Set seen = new HashSet<>(); + for (Param param : params) { + if (param == null) { + throw new IllegalArgumentException("A Param descriptor is null for tool '" + toolName + "'"); + } + if (!seen.add(param.name())) { + throw new IllegalArgumentException( + "Duplicate parameter name '" + param.name() + "' in tool '" + toolName + "'"); + } + } + + List requiredNames = new ArrayList<>(); + Map properties = new LinkedHashMap<>(); + + for (Param param : params) { + Map typeSchema; + if (!param.schema().isEmpty()) { + try { + @SuppressWarnings("unchecked") + Map parsed = mapper.readerFor(Map.class) + .with(DeserializationFeature.FAIL_ON_TRAILING_TOKENS) + .with(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS).readValue(param.schema()); + typeSchema = parsed; + } catch (Exception e) { + throw new IllegalArgumentException("Invalid schema JSON for parameter '" + param.name() + + "' in tool '" + toolName + "': " + e.getMessage(), e); + } + } else { + typeSchema = forType(param.type()); + } + Map enriched = new LinkedHashMap<>(typeSchema); + enriched.put("description", param.description()); + if (param.hasDefaultValue()) { + enriched.put("default", ParamCoercion.coerceDefault(param, mapper)); + } + properties.put(param.name(), Collections.unmodifiableMap(enriched)); + if (param.required()) { + requiredNames.add(param.name()); + } + } + + return Map.of("type", "object", "properties", Collections.unmodifiableMap(properties), "required", + Collections.unmodifiableList(requiredNames)); + } + + /** + * Maps a Java {@link Class} to a flat JSON Schema type descriptor. + * + *

+ * Covers primitives, boxed types, strings, UUIDs, date-time types, enums, + * collections, arrays, and maps. Does not resolve generic type parameters (e.g. + * {@code List} item schemas or {@code Map} additionalProperties) — + * those require the compile-time {@code SchemaGenerator} which operates on + * {@code TypeMirror}. + * + * @param type + * the Java type to map + * @return a JSON Schema type map (e.g. {@code Map.of("type", "string")}) + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + static Map forType(Class type) { + // Integer types + if (type == int.class || type == Integer.class || type == long.class || type == Long.class || type == byte.class + || type == Byte.class || type == short.class || type == Short.class) { + return Map.of("type", "integer"); + } + // Floating-point types + if (type == double.class || type == Double.class || type == float.class || type == Float.class) { + return Map.of("type", "number"); + } + // Boolean + if (type == boolean.class || type == Boolean.class) { + return Map.of("type", "boolean"); + } + // Char → string + if (type == char.class || type == Character.class) { + return Map.of("type", "string"); + } + // String + if (type == String.class) { + return Map.of("type", "string"); + } + // UUID + if (type == java.util.UUID.class) { + return Map.of("type", "string", "format", "uuid"); + } + // Optional primitive types + if (type == java.util.OptionalInt.class || type == java.util.OptionalLong.class) { + return Map.of("type", "integer"); + } + if (type == java.util.OptionalDouble.class) { + return Map.of("type", "number"); + } + // Date-time types + if (type == java.time.OffsetDateTime.class || type == java.time.LocalDateTime.class + || type == java.time.Instant.class || type == java.time.ZonedDateTime.class) { + return Map.of("type", "string", "format", "date-time"); + } + if (type == java.time.LocalDate.class) { + return Map.of("type", "string", "format", "date"); + } + if (type == java.time.LocalTime.class) { + return Map.of("type", "string", "format", "time"); + } + // JsonNode / Object → any (no type constraint) + if (type == com.fasterxml.jackson.databind.JsonNode.class || type == Object.class) { + return Map.of(); + } + // Enum types + if (type.isEnum()) { + Class enumType = (Class) type; + List constants = Arrays.stream(enumType.getEnumConstants()).map(Enum::name) + .collect(Collectors.toList()); + return Map.of("type", "string", "enum", Collections.unmodifiableList(constants)); + } + // List / Collection / Set → array (raw element type) + if (java.util.List.class.isAssignableFrom(type) || java.util.Collection.class.isAssignableFrom(type) + || java.util.Set.class.isAssignableFrom(type)) { + return Map.of("type", "array"); + } + // Plain array → array with items schema derived from component type + if (type.isArray()) { + Map itemsSchema = forType(type.getComponentType()); + return Map.of("type", "array", "items", itemsSchema); + } + // Map → object + if (java.util.Map.class.isAssignableFrom(type)) { + return Map.of("type", "object"); + } + // POJO / record → object + return Map.of("type", "object"); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java new file mode 100644 index 000000000..58639beda --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionHandler.java @@ -0,0 +1,85 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +/** + * Functional interface for handling permission requests from the AI assistant. + *

+ * When the assistant needs permission to perform certain actions (such as + * executing tools or accessing resources), this handler is invoked to approve + * or deny the request. + * + *

Example Implementation

+ * + * 
{@code
+ * PermissionHandler handler = (request, invocation) -> {
+ * 	if (Boolean.TRUE.equals(request.getManagedApprovalRequired())) {
+ * 		// Obtain an explicit human decision before approving this request.
+ * 		return requestHumanApproval(request);
+ * 	}
+ *
+ * 	// Check the permission kind
+ * 	if ("dangerous-action".equals(request.getKind())) {
+ * 		// Deny dangerous actions
+ * 		return CompletableFuture
+ * 				.completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.REJECTED));
+ * 	}
+ *
+ * 	// Approve other requests
+ * 	return CompletableFuture
+ * 			.completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED));
+ * };
+ * }
+ *

+ * Event-based permission dispatch can use + * {@link PermissionRequestResult#noResult()} to let another connected client + * answer a pending request. Legacy protocol-v2 callbacks require a decision and + * cannot abstain. + * + *

+ * A pre-built handler that approves all requests is available as + * {@link #APPROVE_ALL}. + * + * @see SessionConfig#setOnPermissionRequest(PermissionHandler) + * @see PermissionRequest + * @see PermissionRequestResult + * @since 1.0.0 + */ +@FunctionalInterface +public interface PermissionHandler { + + /** + * A pre-built handler that approves permission requests when managed settings + * are disabled. + * + * @since 1.0.11 + */ + PermissionHandler APPROVE_ALL = (request, invocation) -> { + if (invocation.isManagedSettingsEnabled()) { + return CompletableFuture.failedFuture( + new IllegalStateException("APPROVE_ALL cannot be used when managed settings are enabled")); + } + if (Boolean.TRUE.equals(request.getManagedApprovalRequired())) { + return CompletableFuture.completedFuture(PermissionRequestResult.noResult()); + } + return CompletableFuture.completedFuture(PermissionRequestResult.approveOnce()); + }; + + /** + * Handles a permission request from the assistant. + *

+ * The handler should evaluate the request and return a result indicating + * whether the permission is granted or denied. + * + * @param request + * the permission request details + * @param invocation + * the invocation context with session information + * @return a future that completes with the permission decision + */ + CompletableFuture handle(PermissionRequest request, PermissionInvocation invocation); +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java new file mode 100644 index 000000000..10988cc1b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionInvocation.java @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Context information for a permission request invocation. + *

+ * This object provides context about the session where the permission request + * originated. + * + * @see PermissionHandler + * @since 1.0.0 + */ +public final class PermissionInvocation { + + private String sessionId; + private boolean managedSettingsEnabled; + + /** + * Gets the session ID where the permission was requested. + * + * @return the session ID + */ + public String getSessionId() { + return sessionId; + } + + /** + * Sets the session ID. + * + * @param sessionId + * the session ID + * @return this invocation for method chaining + */ + public PermissionInvocation setSessionId(String sessionId) { + this.sessionId = sessionId; + return this; + } + + /** + * Gets whether managed settings are enabled for this session. + * + * @return whether managed settings are enabled + */ + public boolean isManagedSettingsEnabled() { + return managedSettingsEnabled; + } + + /** + * Sets whether managed settings are enabled for this session. + * + * @param managedSettingsEnabled + * whether managed settings are enabled + * @return this invocation for method chaining + */ + public PermissionInvocation setManagedSettingsEnabled(boolean managedSettingsEnabled) { + this.managedSettingsEnabled = managedSettingsEnabled; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequest.java new file mode 100644 index 000000000..fc49332b8 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequest.java @@ -0,0 +1,167 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.io.IOException; +import java.util.LinkedHashMap; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonToken; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; + +/** + * Represents a permission request from the AI assistant. + *

+ * When the assistant needs permission to perform certain actions, this object + * contains the details of the request, including the kind of permission and any + * associated tool call. + * + * @see PermissionHandler + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonIgnoreProperties(ignoreUnknown = true) +public class PermissionRequest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @JsonProperty("kind") + private String kind; + + @JsonProperty("toolCallId") + private String toolCallId; + + @JsonProperty("managedApprovalRequired") + @JsonDeserialize(using = ManagedApprovalRequiredDeserializer.class) + private Boolean managedApprovalRequired; + + private Map extensionData; + + @JsonAnySetter + private void setExtensionDataEntry(String key, Object value) { + if (extensionData == null) { + extensionData = new LinkedHashMap<>(); + } + extensionData.put(key, value); + } + + private static final class ManagedApprovalRequiredDeserializer extends JsonDeserializer { + + @Override + public Boolean deserialize(JsonParser parser, DeserializationContext context) throws IOException { + JsonToken token = parser.currentToken(); + if (token == JsonToken.VALUE_TRUE) { + return true; + } + if (token == JsonToken.VALUE_FALSE) { + return false; + } + parser.skipChildren(); + return true; + } + } + + /** + * Converts the value exposed by a {@code permission.requested} event into a + * typed permission request. + * + * @param value + * the event's {@code permissionRequest} value + * @return the typed permission request + * @throws IllegalArgumentException + * if the value cannot be converted + */ + public static PermissionRequest fromJsonValue(Object value) { + if (value instanceof PermissionRequest request) { + return request; + } + return MAPPER.convertValue(value, PermissionRequest.class); + } + + /** + * Gets the kind of permission being requested. + * + * @return the permission kind + */ + public String getKind() { + return kind; + } + + /** + * Sets the permission kind. + * + * @param kind + * the permission kind + */ + public void setKind(String kind) { + this.kind = kind; + } + + /** + * Gets the associated tool call ID, if applicable. + * + * @return the tool call ID, or {@code null} if not a tool-related request + */ + public String getToolCallId() { + return toolCallId; + } + + /** + * Sets the tool call ID. + * + * @param toolCallId + * the tool call ID + */ + public void setToolCallId(String toolCallId) { + this.toolCallId = toolCallId; + } + + /** + * Gets whether managed policy requires an explicit human decision. + * + * @return {@code true} when automatic approval must be bypassed, otherwise + * {@code false} or {@code null} + */ + public Boolean getManagedApprovalRequired() { + return managedApprovalRequired; + } + + /** + * Sets whether managed policy requires an explicit human decision. + * + * @param managedApprovalRequired + * whether managed approval is required + */ + public void setManagedApprovalRequired(Boolean managedApprovalRequired) { + this.managedApprovalRequired = managedApprovalRequired; + } + + /** + * Gets additional extension data for the request. + * + * @return the extension data map + */ + public Map getExtensionData() { + return extensionData; + } + + /** + * Sets additional extension data for the request. + * + * @param extensionData + * the extension data map + */ + public void setExtensionData(Map extensionData) { + this.extensionData = extensionData; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java new file mode 100644 index 000000000..6546291cf --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java @@ -0,0 +1,213 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.rpc.PermissionDecisionContext; + +/** + * Result of a permission request decision. + *

+ * This object indicates whether a permission request was approved or denied, + * and may include additional rules for future similar requests. + * + *

Common Result Kinds

+ *
    + *
  • {@link PermissionRequestResultKind#APPROVED} — approved
    • + *
  • {@link PermissionRequestResultKind#DENIED_BY_RULES} — denied by + * rules
    • + *
  • {@link PermissionRequestResultKind#DENIED_COULD_NOT_REQUEST_FROM_USER} — + * no handler and couldn't ask user
    • + *
  • {@link PermissionRequestResultKind#DENIED_INTERACTIVELY_BY_USER} — denied + * by the user interactively
    • + *
+ * + * @see PermissionHandler + * @see PermissionRequestResultKind + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public final class PermissionRequestResult { + + @JsonProperty("kind") + private String kind; + + @JsonProperty("rules") + private List rules; + + @JsonProperty("feedback") + private String feedback; + + /** + * Optional provenance describing how and where this decision was made. Never + * serialized inside the result — the SDK forwards it as a sibling of + * {@code result} so the runtime can attribute {@code auto_approval_decision} + * telemetry. + */ + @JsonIgnore + private PermissionDecisionContext decisionContext; + + /** + * Creates a result that approves this single request. + * + * @return a new approved result + * @since 1.3.0 + */ + public static PermissionRequestResult approveOnce() { + return new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED); + } + + /** + * Creates a result that rejects the request, optionally forwarding feedback to + * the LLM. + * + * @param feedback + * optional feedback message, or {@code null} + * @return a new rejected result + * @since 1.3.0 + */ + public static PermissionRequestResult reject(String feedback) { + var result = new PermissionRequestResult().setKind(PermissionRequestResultKind.REJECTED); + result.setFeedback(feedback); + return result; + } + + /** + * Creates a result denying the request because no user is available to confirm + * it. + * + * @return a new user-not-available result + * @since 1.3.0 + */ + public static PermissionRequestResult userNotAvailable() { + return new PermissionRequestResult().setKind(PermissionRequestResultKind.USER_NOT_AVAILABLE); + } + + /** + * Creates a result that declines to respond to this permission request, + * allowing another connected client to answer instead. + * + * @return a new no-result result + * @since 1.3.0 + */ + public static PermissionRequestResult noResult() { + return new PermissionRequestResult().setKind(PermissionRequestResultKind.NO_RESULT); + } + + /** + * Gets the result kind as a string. + * + * @return the result kind indicating approval or denial + */ + public String getKind() { + return kind; + } + + /** + * Sets the result kind using a {@link PermissionRequestResultKind} value. + * + * @param kind + * the result kind + * @return this result for method chaining + * @since 1.1.0 + */ + public PermissionRequestResult setKind(PermissionRequestResultKind kind) { + this.kind = kind != null ? kind.getValue() : null; + return this; + } + + /** + * Sets the result kind using a raw string value. + * + * @param kind + * the result kind string + * @return this result for method chaining + */ + public PermissionRequestResult setKind(String kind) { + this.kind = kind; + return this; + } + + /** + * Gets the approval rules. + * + * @return the list of rules for future similar requests + */ + public List getRules() { + return rules; + } + + /** + * Sets approval rules for future similar requests. + * + * @param rules + * the list of rules + * @return this result for method chaining + */ + public PermissionRequestResult setRules(List rules) { + this.rules = rules; + return this; + } + + /** + * Gets optional human-readable feedback to forward to the LLM along with the + * decision. + * + * @return the feedback message, or {@code null} + * @since 1.3.0 + */ + public String getFeedback() { + return feedback; + } + + /** + * Sets optional human-readable feedback to forward to the LLM along with the + * decision. + * + * @param feedback + * the feedback message + * @return this result for method chaining + * @since 1.3.0 + */ + public PermissionRequestResult setFeedback(String feedback) { + this.feedback = feedback; + return this; + } + + /** + * Gets the optional provenance describing how and where this decision was made. + *

+ * This value is never serialized inside the result JSON; the SDK forwards it as + * a sibling of {@code result} when responding to the runtime. + * + * @return the decision context, or {@code null} if none was attached + * @since 1.3.0 + */ + public PermissionDecisionContext getDecisionContext() { + return decisionContext; + } + + /** + * Sets provenance describing how and where this decision was made, so the + * runtime can attribute {@code auto_approval_decision} telemetry. + *

+ * Calling this method more than once replaces any previously set context. The + * context is never serialized inside the result; the SDK forwards it as a + * sibling of {@code result}. + * + * @param decisionContext + * the decision context, or {@code null} to attach none + * @return this result for method chaining + * @since 1.3.0 + */ + public PermissionRequestResult setDecisionContext(PermissionDecisionContext decisionContext) { + this.decisionContext = decisionContext; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionRequestResultKind.java b/java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResultKind.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PermissionRequestResultKind.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PermissionRequestResultKind.java diff --git a/java/src/main/java/com/github/copilot/rpc/PingResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/PingResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PingResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PingResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseFailureHookOutput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PostToolUseHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PostToolUseHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PostToolUseHookOutput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreMcpToolCallHookOutput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreToolUseHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreToolUseHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreToolUseHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreToolUseHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/PreToolUseHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/PreToolUseHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/PreToolUseHookOutput.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ProviderConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderConfig.java new file mode 100644 index 000000000..3d6faba34 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderConfig.java @@ -0,0 +1,436 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Collections; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.OptionalInt; + +/** + * Configuration for a custom API provider (BYOK - Bring Your Own Key). + *

+ * This allows using your own OpenAI, Azure OpenAI, or other compatible API + * endpoints instead of the default Copilot backend. All setter methods return + * {@code this} for method chaining. + * + *

Example Usage - OpenAI

+ * + * 
{@code
+ * var provider = new ProviderConfig().setType("openai").setBaseUrl("https://api.openai.com/v1").setApiKey("sk-...");
+ * }
+ * + *

Example Usage - Azure OpenAI

+ * + * 
{@code
+ * var provider = new ProviderConfig().setType("azure")
+ * 		.setAzure(new AzureOptions().setEndpoint("https://my-resource.openai.azure.com").setDeployment("gpt-4"));
+ * }
+ * + * @see SessionConfig#setProvider(ProviderConfig) + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class ProviderConfig { + + @JsonProperty("type") + private String type; + + @JsonProperty("wireApi") + private String wireApi; + + @JsonProperty("transport") + private String transport; + + @JsonProperty("baseUrl") + private String baseUrl; + + @JsonProperty("apiKey") + private String apiKey; + + @JsonProperty("bearerToken") + private String bearerToken; + + @JsonIgnore + private BearerTokenProvider bearerTokenProvider; + + @JsonProperty("azure") + private AzureOptions azure; + + @JsonProperty("headers") + private Map headers; + + @JsonProperty("modelId") + private String modelId; + + @JsonProperty("wireModel") + private String wireModel; + + @JsonProperty("maxPromptTokens") + private Integer maxPromptTokens; + + @JsonProperty("maxOutputTokens") + private Integer maxOutputTokens; + + /** + * Gets the provider type. + * + * @return the provider type (e.g., "openai", "azure") + */ + public String getType() { + return type; + } + + /** + * Sets the provider type. + *

+ * Supported types include: + *

    + *
  • "openai" - OpenAI API
    • + *
  • "azure" - Azure OpenAI Service
    • + *
+ * + * @param type + * the provider type + * @return this config for method chaining + */ + public ProviderConfig setType(String type) { + this.type = type; + return this; + } + + /** + * Gets the wire API format. + * + * @return the wire API format + */ + public String getWireApi() { + return wireApi; + } + + /** + * Sets the wire API format for custom providers. + *

+ * This specifies the API format when using a custom provider that has a + * different wire protocol. + * + * @param wireApi + * the wire API format + * @return this config for method chaining + */ + public ProviderConfig setWireApi(String wireApi) { + this.wireApi = wireApi; + return this; + } + + /** + * Gets the transport for OpenAI Responses requests. + * + * @return the transport ("http" or "websockets") + */ + public String getTransport() { + return transport; + } + + /** + * Sets the transport for OpenAI Responses requests. + *

+ * Defaults to "http". Set to "websockets" to deliver Responses API requests + * over a persistent WebSocket connection instead of HTTP. Applies to + * OpenAI-compatible providers using {@code wireApi} "responses". + * + * @param transport + * the transport ("http" or "websockets") + * @return this config for method chaining + */ + public ProviderConfig setTransport(String transport) { + this.transport = transport; + return this; + } + + /** + * Gets the base URL for the API. + * + * @return the API base URL + */ + public String getBaseUrl() { + return baseUrl; + } + + /** + * Sets the base URL for the API. + *

+ * For OpenAI, this is typically "https://api.openai.com/v1". + * + * @param baseUrl + * the API base URL + * @return this config for method chaining + */ + public ProviderConfig setBaseUrl(String baseUrl) { + this.baseUrl = baseUrl; + return this; + } + + /** + * Gets the API key. + * + * @return the API key + */ + public String getApiKey() { + return apiKey; + } + + /** + * Sets the API key for authentication. + * + * @param apiKey + * the API key + * @return this config for method chaining + */ + public ProviderConfig setApiKey(String apiKey) { + this.apiKey = apiKey; + return this; + } + + /** + * Gets the bearer token. + * + * @return the bearer token + */ + public String getBearerToken() { + return bearerToken; + } + + /** + * Sets a bearer token for authentication. + *

+ * This is an alternative to API key authentication. + *

+ * Note: The bearer token is a static token + * string. 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. + * + * @param bearerToken + * the bearer token + * @return this config for method chaining + */ + public ProviderConfig setBearerToken(String bearerToken) { + this.bearerToken = bearerToken; + return this; + } + + /** + * Gets the bearer-token provider callback. + * + * @return the bearer-token provider callback, or {@code null} if not set + */ + public BearerTokenProvider getBearerTokenProvider() { + return bearerTokenProvider; + } + + /** + * Sets a callback that supplies bearer tokens for outbound provider requests. + *

+ * Experimental. The callback stays SDK-side and is not + * serialized. Instead, the runtime receives a {@code hasBearerTokenProvider} + * flag and calls back over the session-scoped {@code providerToken.getToken} + * RPC before each model request. Return the raw token without a {@code Bearer } + * prefix. + * + * @param bearerTokenProvider + * the bearer-token provider callback + * @return this config for method chaining + */ + public ProviderConfig setBearerTokenProvider(BearerTokenProvider bearerTokenProvider) { + this.bearerTokenProvider = bearerTokenProvider; + return this; + } + + @JsonProperty("hasBearerTokenProvider") + @JsonInclude(JsonInclude.Include.NON_NULL) + Boolean hasBearerTokenProviderWireFlag() { + return bearerTokenProvider != null ? Boolean.TRUE : null; + } + + /** + * Gets the Azure-specific options. + * + * @return the Azure options + */ + public AzureOptions getAzure() { + return azure; + } + + /** + * Sets Azure-specific options for Azure OpenAI Service. + * + * @param azure + * the Azure options + * @return this config for method chaining + * @see AzureOptions + */ + public ProviderConfig setAzure(AzureOptions azure) { + this.azure = azure; + return this; + } + + /** + * Gets the custom HTTP headers for outbound provider requests. + * + * @return the headers map, or {@code null} if not set + */ + public Map getHeaders() { + return headers == null ? null : Collections.unmodifiableMap(headers); + } + + /** + * Sets custom HTTP headers to include in outbound provider requests. + *

+ * Use this to pass additional authentication headers or custom metadata to the + * provider API. + * + * @param headers + * the headers map + * @return this config for method chaining + */ + public ProviderConfig setHeaders(Map headers) { + this.headers = headers; + return this; + } + + /** + * Gets the well-known model name used by the runtime. + *

+ * Used to look up agent configuration (tools, prompts, reasoning behavior) and + * default token limits. Also used as the wire model when + * {@link #getWireModel()} is not set. + * + * @return the model ID, or {@code null} if not set + */ + public String getModelId() { + return modelId; + } + + /** + * Sets the well-known model name used by the runtime. + *

+ * Used to look up agent configuration (tools, prompts, reasoning behavior) and + * default token limits. Also used as the wire model when + * {@link #getWireModel()} is not set. Falls back to + * {@link SessionConfig#getModel()}. + * + * @param modelId + * the model ID + * @return this config for method chaining + */ + public ProviderConfig setModelId(String modelId) { + this.modelId = modelId; + return this; + } + + /** + * Gets the model name sent to the provider API for inference. + * + * @return the wire model name, or {@code null} if not set + */ + public String getWireModel() { + return wireModel; + } + + /** + * Sets the model name sent to the provider API for inference. + *

+ * Use this when the provider's model name (e.g. an Azure deployment name or a + * custom fine-tune name) differs from {@link #getModelId()}. Falls back to + * {@link #getModelId()}, then {@link SessionConfig#getModel()}. + * + * @param wireModel + * the wire model name + * @return this config for method chaining + */ + public ProviderConfig setWireModel(String wireModel) { + this.wireModel = wireModel; + return this; + } + + /** + * Gets the maximum prompt token override. + * + * @return an {@link java.util.OptionalInt} containing the max prompt tokens, or + * {@link java.util.OptionalInt#empty()} if not set + */ + @JsonIgnore + public OptionalInt getMaxPromptTokens() { + return maxPromptTokens == null ? OptionalInt.empty() : OptionalInt.of(maxPromptTokens); + } + + /** + * Sets the maximum prompt tokens override. + *

+ * Overrides the resolved model's default max prompt tokens. The runtime + * triggers conversation compaction before sending a request when the prompt + * (system message, history, tool definitions, user message) would exceed this + * limit. + * + * @param maxPromptTokens + * the max prompt tokens + * @return this config for method chaining + */ + public ProviderConfig setMaxPromptTokens(int maxPromptTokens) { + this.maxPromptTokens = maxPromptTokens; + return this; + } + + /** + * Clears the maxPromptTokens setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + public ProviderConfig clearMaxPromptTokens() { + this.maxPromptTokens = null; + return this; + } + + /** + * Gets the maximum output token override. + * + * @return an {@link java.util.OptionalInt} containing the max output tokens, or + * {@link java.util.OptionalInt#empty()} if not set + */ + @JsonIgnore + public OptionalInt getMaxOutputTokens() { + return maxOutputTokens == null ? OptionalInt.empty() : OptionalInt.of(maxOutputTokens); + } + + /** + * Sets the maximum output tokens override. + *

+ * Overrides the resolved model's default max output tokens. When hit, the model + * stops generating and returns a truncated response. + * + * @param maxOutputTokens + * the max output tokens + * @return this config for method chaining + */ + public ProviderConfig setMaxOutputTokens(int maxOutputTokens) { + this.maxOutputTokens = maxOutputTokens; + return this; + } + + /** + * Clears the maxOutputTokens setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + public ProviderConfig clearMaxOutputTokens() { + this.maxOutputTokens = null; + return this; + } + +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java new file mode 100644 index 000000000..e191e32d9 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderModelConfig.java @@ -0,0 +1,298 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.OptionalInt; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +import com.github.copilot.CopilotExperimental; + +/** + * A BYOK (Bring Your Own Key) model definition in the multi-provider registry. + *

+ * References a {@link NamedProviderConfig} by {@link #getProvider() provider} + * and becomes selectable under the provider-qualified id {@code provider/id}. + * All setter methods return {@code this} for method chaining. + *

+ * Experimental. Multi-provider BYOK configuration is + * experimental and may change or be removed in future SDK or CLI releases. + * + *

Example Usage

+ * + * 
{@code
+ * var model = new ProviderModelConfig().setId("gpt-x").setProvider("my-openai").setWireModel("gpt-x-2025");
+ * }
+ * + * @see SessionConfig#setModels(java.util.List) + * @see NamedProviderConfig + * @since 1.0.0 + */ +@CopilotExperimental +@JsonInclude(JsonInclude.Include.NON_NULL) +public class ProviderModelConfig { + + @JsonProperty("id") + private String id; + + @JsonProperty("provider") + private String provider; + + @JsonProperty("wireModel") + private String wireModel; + + @JsonProperty("modelId") + private String modelId; + + @JsonProperty("name") + private String name; + + @JsonProperty("maxPromptTokens") + private Integer maxPromptTokens; + + @JsonProperty("maxContextWindowTokens") + private Integer maxContextWindowTokens; + + @JsonProperty("maxOutputTokens") + private Integer maxOutputTokens; + + @JsonProperty("capabilities") + private ModelCapabilitiesOverride capabilities; + + /** + * Gets the model identifier. + * + * @return the model id + */ + public String getId() { + return id; + } + + /** + * Sets the model identifier, unique within its provider. + *

+ * Combined with {@link #getProvider() provider} to form the selection id + * {@code provider/id}. + * + * @param id + * the model id + * @return this config for method chaining + */ + public ProviderModelConfig setId(String id) { + this.id = id; + return this; + } + + /** + * Gets the name of the provider this model is served by. + * + * @return the provider name + */ + public String getProvider() { + return provider; + } + + /** + * Sets the name of the {@link NamedProviderConfig} this model is served by. + * + * @param provider + * the provider name + * @return this config for method chaining + */ + public ProviderModelConfig setProvider(String provider) { + this.provider = provider; + return this; + } + + /** + * Gets the model name sent to the provider API for inference. + * + * @return the wire model name, or {@code null} if not set + */ + public String getWireModel() { + return wireModel; + } + + /** + * Sets the model name sent to the provider API for inference. + *

+ * Use this when the provider's model name differs from {@link #getId() id}. + * + * @param wireModel + * the wire model name + * @return this config for method chaining + */ + public ProviderModelConfig setWireModel(String wireModel) { + this.wireModel = wireModel; + return this; + } + + /** + * Gets the well-known model ID used to look up agent config and default token + * limits. + * + * @return the model ID, or {@code null} if not set + */ + public String getModelId() { + return modelId; + } + + /** + * Sets the well-known model ID used to look up agent config and default token + * limits. + * + * @param modelId + * the model ID + * @return this config for method chaining + */ + public ProviderModelConfig setModelId(String modelId) { + this.modelId = modelId; + return this; + } + + /** + * Gets the human-readable display name. + * + * @return the display name, or {@code null} if not set + */ + public String getName() { + return name; + } + + /** + * Sets the human-readable display name. + * + * @param name + * the display name + * @return this config for method chaining + */ + public ProviderModelConfig setName(String name) { + this.name = name; + return this; + } + + /** + * Gets the maximum prompt token override. + * + * @return an {@link java.util.OptionalInt} containing the max prompt tokens, or + * {@link java.util.OptionalInt#empty()} if not set + */ + @JsonIgnore + public OptionalInt getMaxPromptTokens() { + return maxPromptTokens == null ? OptionalInt.empty() : OptionalInt.of(maxPromptTokens); + } + + /** + * Sets the maximum prompt tokens override. + * + * @param maxPromptTokens + * the max prompt tokens + * @return this config for method chaining + */ + public ProviderModelConfig setMaxPromptTokens(int maxPromptTokens) { + this.maxPromptTokens = maxPromptTokens; + return this; + } + + /** + * Clears the maxPromptTokens setting, reverting to the default behavior. + * + * @return this config for method chaining + */ + public ProviderModelConfig clearMaxPromptTokens() { + this.maxPromptTokens = null; + return this; + } + + /** + * Gets the maximum context window token override. + * + * @return an {@link java.util.OptionalInt} containing the max context window + * tokens, or {@link java.util.OptionalInt#empty()} if not set + */ + @JsonIgnore + public OptionalInt getMaxContextWindowTokens() { + return maxContextWindowTokens == null ? OptionalInt.empty() : OptionalInt.of(maxContextWindowTokens); + } + + /** + * Sets the maximum context window tokens override. + * + * @param maxContextWindowTokens + * the max context window tokens + * @return this config for method chaining + */ + public ProviderModelConfig setMaxContextWindowTokens(int maxContextWindowTokens) { + this.maxContextWindowTokens = maxContextWindowTokens; + return this; + } + + /** + * Clears the maxContextWindowTokens setting, reverting to the default behavior. + * + * @return this config for method chaining + */ + public ProviderModelConfig clearMaxContextWindowTokens() { + this.maxContextWindowTokens = null; + return this; + } + + /** + * Gets the maximum output token override. + * + * @return an {@link java.util.OptionalInt} containing the max output tokens, or + * {@link java.util.OptionalInt#empty()} if not set + */ + @JsonIgnore + public OptionalInt getMaxOutputTokens() { + return maxOutputTokens == null ? OptionalInt.empty() : OptionalInt.of(maxOutputTokens); + } + + /** + * Sets the maximum output tokens override. + * + * @param maxOutputTokens + * the max output tokens + * @return this config for method chaining + */ + public ProviderModelConfig setMaxOutputTokens(int maxOutputTokens) { + this.maxOutputTokens = maxOutputTokens; + return this; + } + + /** + * Clears the maxOutputTokens setting, reverting to the default behavior. + * + * @return this config for method chaining + */ + public ProviderModelConfig clearMaxOutputTokens() { + this.maxOutputTokens = null; + return this; + } + + /** + * Gets the per-property model capability overrides. + * + * @return the capabilities override, or {@code null} if not set + */ + public ModelCapabilitiesOverride getCapabilities() { + return capabilities; + } + + /** + * Sets per-property model capability overrides, deep-merged over runtime + * defaults. + * + * @param capabilities + * the capabilities override + * @return this config for method chaining + */ + public ProviderModelConfig setCapabilities(ModelCapabilitiesOverride capabilities) { + this.capabilities = capabilities; + return this; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java new file mode 100644 index 000000000..009734ad1 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ProviderTokenArgs.java @@ -0,0 +1,63 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.CopilotExperimental; + +/** + * Arguments passed to a BYOK bearer-token provider callback. + *

+ * Experimental. This managed-identity surface may change or be + * removed in future SDK or CLI releases. + * + * @since 1.0.0 + */ +@CopilotExperimental +public class ProviderTokenArgs { + + private final String providerName; + + private final String sessionId; + + /** + * Creates argument object for the named provider. + * + * @param providerName + * the name of the BYOK provider needing a token; {@code "default"} + * for the singular whole-session provider, otherwise the named + * provider's {@code name} + * @param sessionId + * the id of the session that triggered this token request + */ + public ProviderTokenArgs(String providerName, String sessionId) { + this.providerName = providerName; + this.sessionId = sessionId; + } + + /** + * Gets the name of the BYOK provider needing a token. + *

+ * The value is {@code "default"} for the singular whole-session provider, + * otherwise the named provider's {@code name}. + * + * @return the provider name + */ + public String getProviderName() { + return providerName; + } + + /** + * Gets the id of the session that triggered this token request. + *

+ * A client-level shared callback registered for many sessions can use this to + * resolve the owning session and scope token acquisition or caching per + * session. + * + * @return the session id + */ + public String getSessionId() { + return sessionId; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java similarity index 75% rename from java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java index aee27e1b1..a18803637 100644 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java @@ -8,13 +8,15 @@ import java.util.Collections; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.function.Consumer; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonIgnore; +import com.github.copilot.CopilotExperimental; import com.github.copilot.generated.SessionEvent; -import java.util.Optional; +import com.github.copilot.generated.rpc.SessionLimitsConfig; /** * Configuration for resuming an existing Copilot session. @@ -44,8 +46,16 @@ public class ResumeSessionConfig { private SystemMessageConfig systemMessage; private List availableTools; private List excludedTools; + private List excludedBuiltInAgents; private ProviderConfig provider; + private CapiSessionOptions capi; + private List providers; + private List models; private Boolean enableSessionTelemetry; + private Boolean enableCitations; + private Boolean enableFileChangeTracking; + private SessionLimitsConfig sessionLimits; + private Boolean enableExperimentalMode; private Boolean skipCustomInstructions; private Boolean customAgentsLocalOnly; private Boolean coauthorEnabled; @@ -55,9 +65,11 @@ public class ResumeSessionConfig { private String contextTier; private ModelCapabilitiesOverride modelCapabilities; private PermissionHandler onPermissionRequest; + private McpAuthHandler onMcpAuthRequest; private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private String configDirectory; private Boolean enableConfigDiscovery; private Boolean skipEmbeddingRetrieval; @@ -80,7 +92,10 @@ public class ResumeSessionConfig { private List instructionDirectories; private List pluginDirectories; private LargeToolOutputConfig largeOutput; + private ToolSearchConfig toolSearch; + private MemoryConfiguration memory; private List disabledSkills; + private List disabledMcpServers; private InfiniteSessionConfig infiniteSessions; private Consumer onEvent; private List commands; @@ -88,8 +103,12 @@ public class ResumeSessionConfig { private ExitPlanModeHandler onExitPlanMode; private AutoModeSwitchHandler onAutoModeSwitch; private boolean enableMcpApps; + private GitHubMcpToolConfig githubMcpToolConfig; private String gitHubToken; private String remoteSession; + private CopilotExpAssignmentResponse expAssignments; + private Boolean enableManagedSettings; + private ManagedSettings managedSettings; /** * Gets the AI model to use. @@ -231,6 +250,30 @@ public ResumeSessionConfig setExcludedTools(List excludedTools) { return this; } + /** + * Gets the built-in agent names excluded from the resumed session. + * + * @return the list of excluded built-in agent names + */ + public List getExcludedBuiltInAgents() { + return excludedBuiltInAgents == null ? null : Collections.unmodifiableList(excludedBuiltInAgents); + } + + /** + * Sets the built-in agent names to exclude from the resumed session. + *

+ * Excluded built-in agents are hidden from discovery and cannot be selected or + * invoked unless a custom agent with the same name is configured. + * + * @param excludedBuiltInAgents + * the built-in agent names to exclude + * @return this config instance for method chaining + */ + public ResumeSessionConfig setExcludedBuiltInAgents(List excludedBuiltInAgents) { + this.excludedBuiltInAgents = excludedBuiltInAgents != null ? new ArrayList<>(excludedBuiltInAgents) : null; + return this; + } + /** * Gets the custom API provider configuration. * @@ -253,6 +296,84 @@ public ResumeSessionConfig setProvider(ProviderConfig provider) { return this; } + /** + * Gets the CAPI provider-scoped session options. + * + * @return the CAPI session options + */ + public CapiSessionOptions getCapi() { + return capi; + } + + /** + * Sets CAPI provider-scoped session options. + *

+ * Use {@link CapiSessionOptions#setEnableWebSocketResponses(Boolean)} with + * {@code false} to force the HTTP Responses transport instead of the default + * CAPI Responses API WebSocket transport. + * + * @param capi + * the CAPI session options + * @return this config for method chaining + * @see CapiSessionOptions + */ + public ResumeSessionConfig setCapi(CapiSessionOptions capi) { + this.capi = capi; + return this; + } + + /** + * Gets the named BYOK provider connections. + * + * @return the named provider connections, or {@code null} if not set + */ + @CopilotExperimental + public List getProviders() { + return providers; + } + + /** + * Re-supplies the named BYOK provider connections on resume (additive + * multi-provider registry). + *

+ * Attach models referencing these connections with {@link #setModels(List)}. + * + * @param providers + * the named provider connections + * @return this config instance for method chaining + * @see NamedProviderConfig + */ + @CopilotExperimental + public ResumeSessionConfig setProviders(List providers) { + this.providers = providers; + return this; + } + + /** + * Gets the BYOK model definitions. + * + * @return the model definitions, or {@code null} if not set + */ + @CopilotExperimental + public List getModels() { + return models; + } + + /** + * Re-supplies the BYOK model definitions on resume, each referencing a named + * provider supplied via {@link #setProviders(List)}. + * + * @param models + * the model definitions + * @return this config instance for method chaining + * @see ProviderModelConfig + */ + @CopilotExperimental + public ResumeSessionConfig setModels(List models) { + this.models = models; + return this; + } + /** * Enables or disables internal session telemetry for this session. When * {@code false}, disables session telemetry. When unset (the default) or @@ -297,6 +418,146 @@ public ResumeSessionConfig clearEnableSessionTelemetry() { return this; } + /** + * Gets whether native model citations are enabled. + * + * @return an {@link java.util.Optional} containing whether citations are + * enabled, or {@link java.util.Optional#empty()} for the default + */ + @CopilotExperimental + @JsonIgnore + public Optional getEnableCitations() { + return Optional.ofNullable(enableCitations); + } + + /** + * Enables or disables native model citations for supported providers. + * + * @param enableCitations + * whether to enable citations + * @return this config instance for method chaining + */ + @CopilotExperimental + public ResumeSessionConfig setEnableCitations(boolean enableCitations) { + this.enableCitations = enableCitations; + return this; + } + + /** + * Clears the enableCitations setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + @CopilotExperimental + public ResumeSessionConfig clearEnableCitations() { + this.enableCitations = null; + return this; + } + + /** + * Gets whether file change tracking is enabled for rewind and cumulative + * session diff. + * + * @return an {@link java.util.Optional} containing the setting, or + * {@link java.util.Optional#empty()} for the default + */ + @JsonIgnore + public Optional getEnableFileChangeTracking() { + return Optional.ofNullable(enableFileChangeTracking); + } + + /** + * Enables or disables file change tracking when the resumed session has a valid + * baseline. Earlier untracked changes cannot be reconstructed. + * + * @param enableFileChangeTracking + * whether to enable file change tracking + * @return this config instance for method chaining + */ + public ResumeSessionConfig setEnableFileChangeTracking(boolean enableFileChangeTracking) { + this.enableFileChangeTracking = enableFileChangeTracking; + return this; + } + + /** + * Clears the file change tracking setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + public ResumeSessionConfig clearEnableFileChangeTracking() { + this.enableFileChangeTracking = null; + return this; + } + + /** + * Gets the limits for this session's current accounting window. + * + * @return the session limits, or {@code null} if not set + */ + @CopilotExperimental + public SessionLimitsConfig getSessionLimits() { + return sessionLimits; + } + + /** + * Sets limits for this session's current accounting window. + * + * @param sessionLimits + * the session limits + * @return this config instance for method chaining + */ + @CopilotExperimental + public ResumeSessionConfig setSessionLimits(SessionLimitsConfig sessionLimits) { + this.sessionLimits = sessionLimits; + return this; + } + + /** + * Clears the sessionLimits setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + @CopilotExperimental + public ResumeSessionConfig clearSessionLimits() { + this.sessionLimits = null; + return this; + } + + /** + * Controls whether the session enables experimental features. + * + * @return {@code true} when experimental features are enabled, {@code false} + * when they are disabled, or empty to use the mode-specific default + */ + @JsonIgnore + public Optional getEnableExperimentalMode() { + return Optional.ofNullable(enableExperimentalMode); + } + + /** + * Controls whether the session enables experimental features. + * + * @param enableExperimentalMode + * {@code true} to enable experimental features; {@code false} to + * disable them + * @return this config for method chaining + */ + public ResumeSessionConfig setEnableExperimentalMode(boolean enableExperimentalMode) { + this.enableExperimentalMode = enableExperimentalMode; + return this; + } + + /** + * Clears the enableExperimentalMode setting. In {@link CopilotClientMode#EMPTY + * EMPTY} mode this defaults to {@code false}; otherwise the runtime decides. + * + * @return this instance for method chaining + */ + public ResumeSessionConfig clearEnableExperimentalMode() { + this.enableExperimentalMode = null; + return this; + } + /** * Gets whether custom instruction file loading is suppressed. * @@ -352,11 +613,11 @@ public Optional getCustomAgentsLocalOnly() { * Sets whether custom-agent discovery is restricted to the session's local * working directory. *

- * This option is sent to the server via a {@code session.options.update} - * JSON-RPC call immediately after session resume. In - * {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true} (local - * only); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is - * forwarded only when explicitly set. + * This option is sent with the initial resume request and maintained via + * {@code session.options.update}. In {@link CopilotClientMode#EMPTY EMPTY} mode + * the default is {@code true} (local only); in + * {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is forwarded + * only when explicitly set. * * @param customAgentsLocalOnly * whether to restrict to local agents @@ -462,7 +723,8 @@ public ResumeSessionConfig clearManageScheduleEnabled() { /** * Gets the reasoning effort level. * - * @return the reasoning effort level ("low", "medium", "high", or "xhigh") + * @return the reasoning effort level ("low", "medium", "high", "xhigh", or + * "max") */ public String getReasoningEffort() { return reasoningEffort; @@ -471,7 +733,7 @@ public String getReasoningEffort() { /** * Sets the reasoning effort level for models that support it. *

- * Valid values: "low", "medium", "high", "xhigh". + * Valid values: "low", "medium", "high", "xhigh", "max". * * @param reasoningEffort * the reasoning effort level @@ -550,6 +812,28 @@ public ResumeSessionConfig setOnPermissionRequest(PermissionHandler onPermission return this; } + /** + * Gets the MCP OAuth request handler. + * + * @return the handler, or {@code null} if not set + */ + @JsonIgnore + public McpAuthHandler getOnMcpAuthRequest() { + return onMcpAuthRequest; + } + + /** + * Sets the MCP OAuth request handler. + * + * @param onMcpAuthRequest + * the handler + * @return this config instance for method chaining + */ + public ResumeSessionConfig setOnMcpAuthRequest(McpAuthHandler onMcpAuthRequest) { + this.onMcpAuthRequest = onMcpAuthRequest; + return this; + } + /** * Gets the user input request handler. * @@ -615,6 +899,27 @@ public ResumeSessionConfig setWorkingDirectory(String workingDirectory) { return this; } + /** + * Gets the directories the agent may access beyond the working directory. + * + * @return the additional directory paths + */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets directories the agent may access beyond the working directory. + * + * @param additionalDirectories + * the additional directory paths + * @return this config for method chaining + */ + public ResumeSessionConfig setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + return this; + } + /** * Gets the configuration directory path. * @@ -651,12 +956,8 @@ public Optional getEnableConfigDiscovery() { } /** - * Sets whether to automatically discover MCP server configurations and skill - * directories from the working directory. - *

- * When {@code true}, the CLI scans the working directory for {@code .mcp.json}, - * {@code .vscode/mcp.json} and skill directories, and merges them with - * explicitly provided configurations. + * Enables runtime discovery of supported configuration. Explicitly supplied + * configuration takes precedence over discovered values. * * @param enableConfigDiscovery * {@code true} to enable discovery, {@code false} to disable @@ -1251,6 +1552,48 @@ public ResumeSessionConfig setLargeOutput(LargeToolOutputConfig largeOutput) { return this; } + /** + * Gets the tool-search configuration. + * + * @return the tool-search config, or {@code null} for the runtime default + */ + public ToolSearchConfig getToolSearch() { + return toolSearch; + } + + /** + * Sets the tool-search configuration. + * + * @param toolSearch + * the tool-search config + * @return this config for method chaining + */ + public ResumeSessionConfig setToolSearch(ToolSearchConfig toolSearch) { + this.toolSearch = toolSearch; + return this; + } + + /** + * Gets the configuration for session memory. + * + * @return the memory config, or {@code null} for default + */ + public MemoryConfiguration getMemory() { + return memory; + } + + /** + * Sets the configuration for session memory. + * + * @param memory + * the memory config + * @return this config for method chaining + */ + public ResumeSessionConfig setMemory(MemoryConfiguration memory) { + this.memory = memory; + return this; + } + /** * Gets the disabled skills. * @@ -1272,6 +1615,29 @@ public ResumeSessionConfig setDisabledSkills(List disabledSkills) { return this; } + /** + * Gets exact MCP server names disabled for this session. + * + * @return the disabled MCP server names, or {@code null} when none are disabled + */ + public List getDisabledMcpServers() { + return disabledMcpServers == null ? null : Collections.unmodifiableList(disabledMcpServers); + } + + /** + * Sets exact MCP server names to disable for this session. Disabled servers are + * not started or authenticated on create or cold resume; a resident resume + * cannot stop servers already running. + * + * @param disabledMcpServers + * the server names to disable + * @return this config for method chaining + */ + public ResumeSessionConfig setDisabledMcpServers(List disabledMcpServers) { + this.disabledMcpServers = disabledMcpServers; + return this; + } + /** * Gets the infinite session configuration. * @@ -1396,6 +1762,27 @@ public ResumeSessionConfig setEnableMcpApps(boolean enableMcpApps) { return this; } + /** + * Gets the configuration for the built-in GitHub MCP server. + * + * @return the GitHub MCP configuration, or {@code null} + */ + public GitHubMcpToolConfig getGitHubMcpToolConfig() { + return githubMcpToolConfig; + } + + /** + * Sets the configuration for the built-in GitHub MCP server. + * + * @param githubMcpToolConfig + * the GitHub MCP configuration + * @return this config instance for method chaining + */ + public ResumeSessionConfig setGitHubMcpToolConfig(GitHubMcpToolConfig githubMcpToolConfig) { + this.githubMcpToolConfig = githubMcpToolConfig; + return this; + } + /** * Gets the exit-plan-mode request handler. * @@ -1505,6 +1892,79 @@ public ResumeSessionConfig setRemoteSession(String remoteSession) { return this; } + /** + * Gets the ExP assignment ("flight") data injected by a trusted integrator. + * + * @return the ExP assignment data, or {@code null} if not set + */ + public CopilotExpAssignmentResponse getExpAssignments() { + return expAssignments; + } + + /** + * Sets ExP assignment ("flight") data injected by a trusted integrator. + *

+ * See {@link SessionConfig#setExpAssignments(CopilotExpAssignmentResponse)} for + * details. The runtime supports injecting ExP assignments on resume as well as + * create. + * + * @param expAssignments + * the ExP assignment data + * @return this config for method chaining + */ + public ResumeSessionConfig setExpAssignments(CopilotExpAssignmentResponse expAssignments) { + this.expAssignments = expAssignments; + return this; + } + + /** + * Gets whether the runtime self-fetches enterprise managed settings at session + * bootstrap on resume. + * + * @return an {@link java.util.Optional} containing {@code true} to opt into + * self-fetching managed settings, or {@link java.util.Optional#empty()} + * to use the default behavior + */ + @JsonIgnore + public Optional getEnableManagedSettings() { + return Optional.ofNullable(enableManagedSettings); + } + + /** + * Opts the runtime into self-fetching enterprise managed settings on resume. + *

+ * See {@link SessionConfig#setEnableManagedSettings(boolean)} for details. + * Re-supply on resume so the runtime re-applies the managed-settings self-fetch + * after a CLI process restart. Serialized on the wire as + * {@code enableManagedSettings}. + * + * @param enableManagedSettings + * {@code true} to opt into self-fetching managed settings + * @return this config for method chaining + */ + public ResumeSessionConfig setEnableManagedSettings(boolean enableManagedSettings) { + this.enableManagedSettings = enableManagedSettings; + return this; + } + + /** @return host-injected managed settings, or {@code null} when unset */ + public ManagedSettings getManagedSettings() { + return managedSettings; + } + + /** + * Supplies permissions-only managed settings for this resume. The value + * replaces the prior injected layer and is not persisted. + * + * @param managedSettings + * the host-injected managed settings + * @return this config for method chaining + */ + public ResumeSessionConfig setManagedSettings(ManagedSettings managedSettings) { + this.managedSettings = managedSettings; + return this; + } + /** * Creates a shallow clone of this {@code ResumeSessionConfig} instance. *

@@ -1525,8 +1985,18 @@ public ResumeSessionConfig clone() { copy.systemMessage = this.systemMessage; copy.availableTools = this.availableTools != null ? new ArrayList<>(this.availableTools) : null; copy.excludedTools = this.excludedTools != null ? new ArrayList<>(this.excludedTools) : null; + copy.excludedBuiltInAgents = this.excludedBuiltInAgents != null + ? new ArrayList<>(this.excludedBuiltInAgents) + : null; copy.provider = this.provider; + copy.capi = this.capi; + copy.providers = this.providers != null ? new ArrayList<>(this.providers) : null; + copy.models = this.models != null ? new ArrayList<>(this.models) : null; copy.enableSessionTelemetry = this.enableSessionTelemetry; + copy.enableCitations = this.enableCitations; + copy.enableFileChangeTracking = this.enableFileChangeTracking; + copy.sessionLimits = this.sessionLimits; + copy.enableExperimentalMode = this.enableExperimentalMode; copy.reasoningEffort = this.reasoningEffort; copy.reasoningSummary = this.reasoningSummary; copy.contextTier = this.contextTier; @@ -1535,6 +2005,9 @@ public ResumeSessionConfig clone() { copy.onUserInputRequest = this.onUserInputRequest; copy.hooks = this.hooks; copy.workingDirectory = this.workingDirectory; + copy.additionalDirectories = this.additionalDirectories != null + ? new ArrayList<>(this.additionalDirectories) + : null; copy.configDirectory = this.configDirectory; copy.enableConfigDiscovery = this.enableConfigDiscovery; copy.skipEmbeddingRetrieval = this.skipEmbeddingRetrieval; @@ -1558,16 +2031,24 @@ public ResumeSessionConfig clone() { : null; copy.pluginDirectories = this.pluginDirectories != null ? new ArrayList<>(this.pluginDirectories) : null; copy.largeOutput = this.largeOutput; + copy.toolSearch = this.toolSearch; + copy.memory = this.memory; copy.disabledSkills = this.disabledSkills != null ? new ArrayList<>(this.disabledSkills) : null; + copy.disabledMcpServers = this.disabledMcpServers != null ? new ArrayList<>(this.disabledMcpServers) : null; copy.infiniteSessions = this.infiniteSessions; copy.onEvent = this.onEvent; copy.commands = this.commands != null ? new ArrayList<>(this.commands) : null; copy.onElicitationRequest = this.onElicitationRequest; + copy.onMcpAuthRequest = this.onMcpAuthRequest; copy.onExitPlanMode = this.onExitPlanMode; copy.onAutoModeSwitch = this.onAutoModeSwitch; copy.enableMcpApps = this.enableMcpApps; + copy.githubMcpToolConfig = this.githubMcpToolConfig; copy.gitHubToken = this.gitHubToken; copy.remoteSession = this.remoteSession; + copy.expAssignments = this.expAssignments; + copy.enableManagedSettings = this.enableManagedSettings; + copy.managedSettings = this.managedSettings; return copy; } } diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java new file mode 100644 index 000000000..e52892477 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java @@ -0,0 +1,1148 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +import com.github.copilot.CopilotExperimental; +import com.github.copilot.generated.rpc.SessionLimitsConfig; + +/** + * Internal request object for resuming an existing session. + *

+ * This is a low-level class for JSON-RPC communication. For resuming sessions, + * use + * {@link com.github.copilot.CopilotClient#resumeSession(String, ResumeSessionConfig)}. + * + * @see com.github.copilot.CopilotClient#resumeSession(String, + * ResumeSessionConfig) + * @see ResumeSessionConfig + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public final class ResumeSessionRequest { + + @JsonProperty("sessionId") + private String sessionId; + + @JsonProperty("clientName") + private String clientName; + + @JsonProperty("model") + private String model; + + @JsonProperty("reasoningEffort") + private String reasoningEffort; + + @JsonProperty("reasoningSummary") + private String reasoningSummary; + + @JsonProperty("contextTier") + private String contextTier; + + @JsonProperty("tools") + private List tools; + + @JsonProperty("systemMessage") + private SystemMessageConfig systemMessage; + + @JsonProperty("availableTools") + private List availableTools; + + @JsonProperty("excludedTools") + private List excludedTools; + + @JsonProperty("excludedBuiltinAgents") + private List excludedBuiltInAgents; + + @JsonProperty("toolFilterPrecedence") + private String toolFilterPrecedence; + + @JsonProperty("provider") + private ProviderConfig provider; + + @JsonProperty("capi") + private CapiSessionOptions capi; + @JsonProperty("providers") + private List providers; + + @JsonProperty("models") + private List models; + + @JsonProperty("enableSessionTelemetry") + private Boolean enableSessionTelemetry; + + @JsonProperty("enableCitations") + private Boolean enableCitations; + + @JsonProperty("enableFileChangeTracking") + private Boolean enableFileChangeTracking; + + @JsonProperty("sessionLimits") + private SessionLimitsConfig sessionLimits; + + @JsonProperty("requestPermission") + private Boolean requestPermission; + + @JsonProperty("requestUserInput") + private Boolean requestUserInput; + + @JsonProperty("hooks") + private Boolean hooks; + + @JsonProperty("workingDirectory") + private String workingDirectory; + + @JsonProperty("additionalDirectories") + private List additionalDirectories; + + @JsonProperty("configDir") + private String configDirectory; + + @JsonProperty("enableConfigDiscovery") + private Boolean enableConfigDiscovery; + + @JsonProperty("skipEmbeddingRetrieval") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean skipEmbeddingRetrieval; + + @JsonProperty("organizationCustomInstructions") + @JsonInclude(JsonInclude.Include.NON_NULL) + private String organizationCustomInstructions; + + @JsonProperty("enableOnDemandInstructionDiscovery") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableOnDemandInstructionDiscovery; + + @JsonProperty("enableFileHooks") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableFileHooks; + + @JsonProperty("enableHostGitOperations") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableHostGitOperations; + + @JsonProperty("enableSessionStore") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableSessionStore; + + @JsonProperty("enableSkills") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableSkills; + + @JsonProperty("embeddingCacheStorage") + @JsonInclude(JsonInclude.Include.NON_NULL) + private String embeddingCacheStorage; + + @JsonProperty("disableResume") + private Boolean disableResume; + + @JsonProperty("streaming") + private Boolean streaming; + + @JsonProperty("includeSubAgentStreamingEvents") + private Boolean includeSubAgentStreamingEvents; + + @JsonProperty("enableGitHubTelemetryForwarding") + private Boolean enableGitHubTelemetryForwarding; + + @JsonProperty("mcpServers") + private Map mcpServers; + + @JsonProperty("mcpOAuthTokenStorage") + private String mcpOAuthTokenStorage; + + @JsonProperty("envValueMode") + private String envValueMode; + + @JsonProperty("customAgents") + private List customAgents; + + @JsonProperty("customAgentsLocalOnly") + private Boolean customAgentsLocalOnly; + + @JsonProperty("defaultAgent") + private DefaultAgentConfig defaultAgent; + + @JsonProperty("agent") + private String agent; + + @JsonProperty("skillDirectories") + private List skillDirectories; + + @JsonProperty("instructionDirectories") + private List instructionDirectories; + + @JsonProperty("pluginDirectories") + private List pluginDirectories; + + @JsonProperty("largeOutput") + private LargeToolOutputConfig largeOutput; + + @JsonProperty("toolSearch") + private ToolSearchConfig toolSearch; + + @JsonProperty("memory") + private MemoryConfiguration memory; + + @JsonProperty("disabledSkills") + private List disabledSkills; + + @JsonProperty("disabledMcpServers") + private List disabledMcpServers; + + @JsonProperty("infiniteSessions") + private InfiniteSessionConfig infiniteSessions; + + @JsonProperty("commands") + private List commands; + + @JsonProperty("requestElicitation") + private Boolean requestElicitation; + + @JsonProperty("requestMcpApps") + private Boolean requestMcpApps; + + @JsonProperty("githubMcpToolConfig") + private GitHubMcpToolConfig githubMcpToolConfig; + + @JsonProperty("isExperimentalMode") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean isExperimentalMode; + + @JsonProperty("requestExitPlanMode") + private Boolean requestExitPlanMode; + + @JsonProperty("requestAutoModeSwitch") + private Boolean requestAutoModeSwitch; + + @JsonProperty("modelCapabilities") + private ModelCapabilitiesOverride modelCapabilities; + + @JsonProperty("gitHubToken") + private String gitHubToken; + + @JsonProperty("remoteSession") + private String remoteSession; + + @JsonProperty("expAssignments") + private CopilotExpAssignmentResponse expAssignments; + + @JsonProperty("enableManagedSettings") + @JsonInclude(JsonInclude.Include.NON_NULL) + private Boolean enableManagedSettings; + + @JsonProperty("managedSettings") + @JsonInclude(JsonInclude.Include.NON_NULL) + private ManagedSettings managedSettings; + + /** Gets the session ID. @return the session ID */ + public String getSessionId() { + return sessionId; + } + + /** Sets the session ID. @param sessionId the session ID */ + public void setSessionId(String sessionId) { + this.sessionId = sessionId; + } + + /** Gets the client name. @return the client name */ + public String getClientName() { + return clientName; + } + + /** Sets the client name. @param clientName the client name */ + public void setClientName(String clientName) { + this.clientName = clientName; + } + + /** Gets the model name. @return the model */ + public String getModel() { + return model; + } + + /** Sets the model name. @param model the model */ + public void setModel(String model) { + this.model = model; + } + + /** Gets the reasoning effort. @return the reasoning effort level */ + public String getReasoningEffort() { + return reasoningEffort; + } + + /** + * Sets the reasoning effort. @param reasoningEffort the reasoning effort level + */ + public void setReasoningEffort(String reasoningEffort) { + this.reasoningEffort = reasoningEffort; + } + + /** Gets the reasoning summary mode. @return the reasoning summary mode */ + public String getReasoningSummary() { + return reasoningSummary; + } + + /** + * Sets the reasoning summary mode. @param reasoningSummary the reasoning + * summary mode + */ + public void setReasoningSummary(String reasoningSummary) { + this.reasoningSummary = reasoningSummary; + } + + /** Gets the context window tier. @return the context window tier */ + public String getContextTier() { + return contextTier; + } + + /** Sets the context window tier. @param contextTier the context window tier */ + public void setContextTier(String contextTier) { + this.contextTier = contextTier; + } + + /** Gets the tools. @return the tool definitions */ + public List getTools() { + return tools == null ? null : Collections.unmodifiableList(tools); + } + + /** Sets the tools. @param tools the tool definitions */ + public void setTools(List tools) { + this.tools = tools; + } + + /** Gets the system message config. @return the system message config */ + public SystemMessageConfig getSystemMessage() { + return systemMessage; + } + + /** + * Sets the system message config. @param systemMessage the system message + * config + */ + public void setSystemMessage(SystemMessageConfig systemMessage) { + this.systemMessage = systemMessage; + } + + /** Gets available tools. @return the available tool names */ + public List getAvailableTools() { + return availableTools == null ? null : Collections.unmodifiableList(availableTools); + } + + /** Sets available tools. @param availableTools the available tool names */ + public void setAvailableTools(List availableTools) { + this.availableTools = availableTools; + } + + /** Gets excluded tools. @return the excluded tool names */ + public List getExcludedTools() { + return excludedTools == null ? null : Collections.unmodifiableList(excludedTools); + } + + /** Sets excluded tools. @param excludedTools the excluded tool names */ + public void setExcludedTools(List excludedTools) { + this.excludedTools = excludedTools; + } + + /** Gets excluded built-in agents. @return the built-in agent names */ + public List getExcludedBuiltInAgents() { + return excludedBuiltInAgents == null ? null : Collections.unmodifiableList(excludedBuiltInAgents); + } + + /** + * Sets excluded built-in agents. @param excludedBuiltInAgents the agent names + */ + public void setExcludedBuiltInAgents(List excludedBuiltInAgents) { + this.excludedBuiltInAgents = excludedBuiltInAgents; + } + + /** Gets the tool filter precedence. @return the precedence value */ + public String getToolFilterPrecedence() { + return toolFilterPrecedence; + } + + /** + * Sets the tool filter precedence. @param toolFilterPrecedence the precedence + * ("excluded" or null) + */ + public void setToolFilterPrecedence(String toolFilterPrecedence) { + this.toolFilterPrecedence = toolFilterPrecedence; + } + + /** Gets the provider config. @return the provider */ + public ProviderConfig getProvider() { + return provider; + } + + /** Sets the provider config. @param provider the provider */ + public void setProvider(ProviderConfig provider) { + this.provider = provider; + } + + /** Gets the CAPI session options. @return the CAPI session options */ + public CapiSessionOptions getCapi() { + return capi; + } + + /** Sets the CAPI session options. @param capi the CAPI session options */ + public void setCapi(CapiSessionOptions capi) { + this.capi = capi; + } + + /** Gets the named provider connections. @return the named providers */ + @CopilotExperimental + public List getProviders() { + return providers; + } + + /** Sets the named provider connections. @param providers the named providers */ + @CopilotExperimental + public void setProviders(List providers) { + this.providers = providers; + } + + /** Gets the BYOK model definitions. @return the models */ + @CopilotExperimental + public List getModels() { + return models; + } + + /** Sets the BYOK model definitions. @param models the models */ + @CopilotExperimental + public void setModels(List models) { + this.models = models; + } + + /** Gets enable session telemetry flag. @return the flag */ + public Boolean getEnableSessionTelemetry() { + return enableSessionTelemetry; + } + + /** + * Sets enable session telemetry flag. @param enableSessionTelemetry the flag + */ + public void setEnableSessionTelemetry(boolean enableSessionTelemetry) { + this.enableSessionTelemetry = enableSessionTelemetry; + } + + /** Gets enable citations flag. @return the flag */ + public Boolean getEnableCitations() { + return enableCitations; + } + + /** Sets enable citations flag. @param enableCitations the flag */ + public void setEnableCitations(boolean enableCitations) { + this.enableCitations = enableCitations; + } + + /** Gets the file change tracking flag. @return the flag */ + public Boolean getEnableFileChangeTracking() { + return enableFileChangeTracking; + } + + /** + * Sets the file change tracking flag. + * + * @param enableFileChangeTracking + * the flag + */ + public void setEnableFileChangeTracking(boolean enableFileChangeTracking) { + this.enableFileChangeTracking = enableFileChangeTracking; + } + + /** Gets the session limits. @return the session limits */ + public SessionLimitsConfig getSessionLimits() { + return sessionLimits; + } + + /** Sets the session limits. @param sessionLimits the session limits */ + public void setSessionLimits(SessionLimitsConfig sessionLimits) { + this.sessionLimits = sessionLimits; + } + + /** + * Clears the enableSessionTelemetry setting, reverting to the default behavior. + */ + public void clearEnableSessionTelemetry() { + this.enableSessionTelemetry = null; + } + + /** Gets request permission flag. @return the flag */ + public Boolean getRequestPermission() { + return requestPermission; + } + + /** Sets request permission flag. @param requestPermission the flag */ + public void setRequestPermission(boolean requestPermission) { + this.requestPermission = requestPermission; + } + + /** + * Clears the requestPermission setting, reverting to the default behavior. + */ + public void clearRequestPermission() { + this.requestPermission = null; + } + + /** Gets request user input flag. @return the flag */ + public Boolean getRequestUserInput() { + return requestUserInput; + } + + /** Sets request user input flag. @param requestUserInput the flag */ + public void setRequestUserInput(boolean requestUserInput) { + this.requestUserInput = requestUserInput; + } + + /** + * Clears the requestUserInput setting, reverting to the default behavior. + */ + public void clearRequestUserInput() { + this.requestUserInput = null; + } + + /** Gets hooks flag. @return the flag */ + public Boolean getHooks() { + return hooks; + } + + /** Sets hooks flag. @param hooks the flag */ + public void setHooks(boolean hooks) { + this.hooks = hooks; + } + + /** + * Clears the hooks setting, reverting to the default behavior. + */ + public void clearHooks() { + this.hooks = null; + } + + /** Gets working directory. @return the working directory */ + public String getWorkingDirectory() { + return workingDirectory; + } + + /** Sets working directory. @param workingDirectory the working directory */ + public void setWorkingDirectory(String workingDirectory) { + this.workingDirectory = workingDirectory; + } + + /** Gets additional directories. @return the additional directories */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets additional directories. + * + * @param additionalDirectories + * the additional directories + */ + public void setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + } + + /** Gets config directory. @return the config directory */ + public String getConfigDirectory() { + return configDirectory; + } + + /** Sets config directory. @param configDirectory the config directory */ + public void setConfigDirectory(String configDirectory) { + this.configDirectory = configDirectory; + } + + /** Gets enable config discovery flag. @return the flag */ + public Boolean getEnableConfigDiscovery() { + return enableConfigDiscovery; + } + + /** Sets enable config discovery flag. @param enableConfigDiscovery the flag */ + public void setEnableConfigDiscovery(boolean enableConfigDiscovery) { + this.enableConfigDiscovery = enableConfigDiscovery; + } + + /** + * Clears the enableConfigDiscovery setting, reverting to the default behavior. + */ + public void clearEnableConfigDiscovery() { + this.enableConfigDiscovery = null; + } + + /** Gets skip embedding retrieval flag. @return the flag */ + public Boolean getSkipEmbeddingRetrieval() { + return skipEmbeddingRetrieval; + } + + /** + * Sets skip embedding retrieval flag. @param skipEmbeddingRetrieval the flag + */ + public void setSkipEmbeddingRetrieval(boolean skipEmbeddingRetrieval) { + this.skipEmbeddingRetrieval = skipEmbeddingRetrieval; + } + + /** + * Clears the skipEmbeddingRetrieval setting, reverting to the default behavior. + */ + public void clearSkipEmbeddingRetrieval() { + this.skipEmbeddingRetrieval = null; + } + + /** Gets organization custom instructions. @return the instructions */ + public String getOrganizationCustomInstructions() { + return organizationCustomInstructions; + } + + /** + * Sets organization custom instructions. @param organizationCustomInstructions + * the instructions + */ + public void setOrganizationCustomInstructions(String organizationCustomInstructions) { + this.organizationCustomInstructions = organizationCustomInstructions; + } + + /** Gets enable on-demand instruction discovery flag. @return the flag */ + public Boolean getEnableOnDemandInstructionDiscovery() { + return enableOnDemandInstructionDiscovery; + } + + /** + * Sets enable on-demand instruction discovery flag. @param + * enableOnDemandInstructionDiscovery the flag + */ + public void setEnableOnDemandInstructionDiscovery(boolean enableOnDemandInstructionDiscovery) { + this.enableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery; + } + + /** + * Clears the enableOnDemandInstructionDiscovery setting, reverting to the + * default behavior. + */ + public void clearEnableOnDemandInstructionDiscovery() { + this.enableOnDemandInstructionDiscovery = null; + } + + /** Gets enable file hooks flag. @return the flag */ + public Boolean getEnableFileHooks() { + return enableFileHooks; + } + + /** Sets enable file hooks flag. @param enableFileHooks the flag */ + public void setEnableFileHooks(boolean enableFileHooks) { + this.enableFileHooks = enableFileHooks; + } + + /** Clears the enableFileHooks setting, reverting to the default behavior. */ + public void clearEnableFileHooks() { + this.enableFileHooks = null; + } + + /** Gets enable host git operations flag. @return the flag */ + public Boolean getEnableHostGitOperations() { + return enableHostGitOperations; + } + + /** + * Sets enable host git operations flag. @param enableHostGitOperations the flag + */ + public void setEnableHostGitOperations(boolean enableHostGitOperations) { + this.enableHostGitOperations = enableHostGitOperations; + } + + /** + * Clears the enableHostGitOperations setting, reverting to the default + * behavior. + */ + public void clearEnableHostGitOperations() { + this.enableHostGitOperations = null; + } + + /** Gets enable session store flag. @return the flag */ + public Boolean getEnableSessionStore() { + return enableSessionStore; + } + + /** Sets enable session store flag. @param enableSessionStore the flag */ + public void setEnableSessionStore(boolean enableSessionStore) { + this.enableSessionStore = enableSessionStore; + } + + /** Clears the enableSessionStore setting, reverting to the default behavior. */ + public void clearEnableSessionStore() { + this.enableSessionStore = null; + } + + /** Gets enable skills flag. @return the flag */ + public Boolean getEnableSkills() { + return enableSkills; + } + + /** Sets enable skills flag. @param enableSkills the flag */ + public void setEnableSkills(boolean enableSkills) { + this.enableSkills = enableSkills; + } + + /** Clears the enableSkills setting, reverting to the default behavior. */ + public void clearEnableSkills() { + this.enableSkills = null; + } + + /** Gets embedding cache storage mode. @return the mode */ + public String getEmbeddingCacheStorage() { + return embeddingCacheStorage; + } + + /** Sets embedding cache storage mode. @param embeddingCacheStorage the mode */ + public void setEmbeddingCacheStorage(String embeddingCacheStorage) { + this.embeddingCacheStorage = embeddingCacheStorage; + } + + /** + * Clears the embeddingCacheStorage setting, reverting to the default behavior. + */ + public void clearEmbeddingCacheStorage() { + this.embeddingCacheStorage = null; + } + + /** Gets disable resume flag. @return the flag */ + public Boolean getDisableResume() { + return disableResume; + } + + /** Sets disable resume flag. @param disableResume the flag */ + public void setDisableResume(boolean disableResume) { + this.disableResume = disableResume; + } + + /** + * Clears the disableResume setting, reverting to the default behavior. + */ + public void clearDisableResume() { + this.disableResume = null; + } + + /** Gets streaming flag. @return the flag */ + public Boolean getStreaming() { + return streaming; + } + + /** Sets streaming flag. @param streaming the flag */ + public void setStreaming(boolean streaming) { + this.streaming = streaming; + } + + /** + * Clears the streaming setting, reverting to the default behavior. + */ + public void clearStreaming() { + this.streaming = null; + } + + /** Gets include sub-agent streaming events flag. @return the flag */ + public Boolean getIncludeSubAgentStreamingEvents() { + return includeSubAgentStreamingEvents; + } + + /** + * Sets include sub-agent streaming events flag. @param + * includeSubAgentStreamingEvents the flag + */ + public void setIncludeSubAgentStreamingEvents(boolean includeSubAgentStreamingEvents) { + this.includeSubAgentStreamingEvents = includeSubAgentStreamingEvents; + } + + /** + * Clears the includeSubAgentStreamingEvents setting, reverting to the default + * behavior. + */ + public void clearIncludeSubAgentStreamingEvents() { + this.includeSubAgentStreamingEvents = null; + } + + /** Gets the GitHub telemetry forwarding flag. @return the flag */ + public Boolean getEnableGitHubTelemetryForwarding() { + return enableGitHubTelemetryForwarding; + } + + /** + * Sets the GitHub telemetry forwarding flag. @param + * enableGitHubTelemetryForwarding the flag + */ + public void setEnableGitHubTelemetryForwarding(boolean enableGitHubTelemetryForwarding) { + this.enableGitHubTelemetryForwarding = enableGitHubTelemetryForwarding; + } + + /** + * Clears the enableGitHubTelemetryForwarding setting, reverting to the default + * behavior. + */ + public void clearEnableGitHubTelemetryForwarding() { + this.enableGitHubTelemetryForwarding = null; + } + + /** Gets MCP servers. @return the servers map */ + public Map getMcpServers() { + return mcpServers == null ? null : Collections.unmodifiableMap(mcpServers); + } + + /** Sets MCP servers. @param mcpServers the servers map */ + public void setMcpServers(Map mcpServers) { + this.mcpServers = mcpServers; + } + + /** Gets MCP OAuth token storage mode. @return the storage mode */ + public String getMcpOAuthTokenStorage() { + return mcpOAuthTokenStorage; + } + + /** + * Sets MCP OAuth token storage mode. @param mcpOAuthTokenStorage the storage + * mode + */ + public void setMcpOAuthTokenStorage(String mcpOAuthTokenStorage) { + this.mcpOAuthTokenStorage = mcpOAuthTokenStorage; + } + + /** Gets MCP environment variable value mode. @return the mode */ + public String getEnvValueMode() { + return envValueMode; + } + + /** Sets MCP environment variable value mode. @param envValueMode the mode */ + public void setEnvValueMode(String envValueMode) { + this.envValueMode = envValueMode; + } + + /** Gets custom agents. @return the agents */ + public List getCustomAgents() { + return customAgents == null ? null : Collections.unmodifiableList(customAgents); + } + + /** Sets custom agents. @param customAgents the agents */ + public void setCustomAgents(List customAgents) { + this.customAgents = customAgents; + } + + /** Gets whether custom agents are local only. @return the flag */ + public Boolean getCustomAgentsLocalOnly() { + return customAgentsLocalOnly; + } + + /** + * Sets whether custom agents are local only. @param customAgentsLocalOnly the + * flag + */ + public void setCustomAgentsLocalOnly(Boolean customAgentsLocalOnly) { + this.customAgentsLocalOnly = customAgentsLocalOnly; + } + + /** Gets the default agent config. @return the default agent config */ + public DefaultAgentConfig getDefaultAgent() { + return defaultAgent; + } + + /** + * Sets the default agent config. @param defaultAgent the default agent config + */ + public void setDefaultAgent(DefaultAgentConfig defaultAgent) { + this.defaultAgent = defaultAgent; + } + + /** Gets the pre-selected agent name. @return the agent name */ + public String getAgent() { + return agent; + } + + /** Sets the pre-selected agent name. @param agent the agent name */ + public void setAgent(String agent) { + this.agent = agent; + } + + /** Gets skill directories. @return the directories */ + public List getSkillDirectories() { + return skillDirectories == null ? null : Collections.unmodifiableList(skillDirectories); + } + + /** Sets skill directories. @param skillDirectories the directories */ + public void setSkillDirectories(List skillDirectories) { + this.skillDirectories = skillDirectories; + } + + /** Gets instruction directories. @return the instruction directories */ + public List getInstructionDirectories() { + return instructionDirectories == null ? null : Collections.unmodifiableList(instructionDirectories); + } + + /** + * Sets instruction directories. @param instructionDirectories the directories + */ + public void setInstructionDirectories(List instructionDirectories) { + this.instructionDirectories = instructionDirectories; + } + + /** Gets plugin directories. @return the plugin directories */ + public List getPluginDirectories() { + return pluginDirectories == null ? null : Collections.unmodifiableList(pluginDirectories); + } + + /** Sets plugin directories. @param pluginDirectories the directories */ + public void setPluginDirectories(List pluginDirectories) { + this.pluginDirectories = pluginDirectories; + } + + /** Gets large output config. @return the large output config */ + public LargeToolOutputConfig getLargeOutput() { + return largeOutput; + } + + /** Sets large output config. @param largeOutput the large output config */ + public void setLargeOutput(LargeToolOutputConfig largeOutput) { + this.largeOutput = largeOutput; + } + + /** Gets tool-search config. @return the tool-search config */ + public ToolSearchConfig getToolSearch() { + return toolSearch; + } + + /** Sets tool-search config. @param toolSearch the tool-search config */ + public void setToolSearch(ToolSearchConfig toolSearch) { + this.toolSearch = toolSearch; + } + + /** Gets memory config. @return the memory config */ + public MemoryConfiguration getMemory() { + return memory; + } + + /** Sets memory config. @param memory the memory config */ + public void setMemory(MemoryConfiguration memory) { + this.memory = memory; + } + + /** Gets disabled skills. @return the disabled skill names */ + public List getDisabledSkills() { + return disabledSkills == null ? null : Collections.unmodifiableList(disabledSkills); + } + + /** Sets disabled skills. @param disabledSkills the skill names to disable */ + public void setDisabledSkills(List disabledSkills) { + this.disabledSkills = disabledSkills; + } + + /** Gets disabled MCP server names. @return the server names */ + public List getDisabledMcpServers() { + return disabledMcpServers == null ? null : Collections.unmodifiableList(disabledMcpServers); + } + + /** + * Sets disabled MCP server names. @param disabledMcpServers the server names + */ + public void setDisabledMcpServers(List disabledMcpServers) { + this.disabledMcpServers = disabledMcpServers; + } + + /** Gets infinite sessions config. @return the infinite sessions config */ + public InfiniteSessionConfig getInfiniteSessions() { + return infiniteSessions; + } + + /** + * Sets infinite sessions config. @param infiniteSessions the infinite sessions + * config + */ + public void setInfiniteSessions(InfiniteSessionConfig infiniteSessions) { + this.infiniteSessions = infiniteSessions; + } + + /** Gets the commands wire definitions. @return the commands */ + public List getCommands() { + return commands == null ? null : Collections.unmodifiableList(commands); + } + + /** Sets the commands wire definitions. @param commands the commands */ + public void setCommands(List commands) { + this.commands = commands; + } + + /** Gets the requestElicitation flag. @return the flag */ + public Boolean getRequestElicitation() { + return requestElicitation; + } + + /** Sets the requestElicitation flag. @param requestElicitation the flag */ + public void setRequestElicitation(boolean requestElicitation) { + this.requestElicitation = requestElicitation; + } + + /** + * Clears the requestElicitation setting, reverting to the default behavior. + */ + public void clearRequestElicitation() { + this.requestElicitation = null; + } + + /** Gets the requestMcpApps flag. @return the flag */ + public Boolean getRequestMcpApps() { + return requestMcpApps; + } + + /** Sets the requestMcpApps flag. @param requestMcpApps the flag */ + public void setRequestMcpApps(boolean requestMcpApps) { + this.requestMcpApps = requestMcpApps; + } + + /** Clears the requestMcpApps setting, reverting to the default behavior. */ + public void clearRequestMcpApps() { + this.requestMcpApps = null; + } + + /** Gets the GitHub MCP tool configuration. @return the configuration */ + public GitHubMcpToolConfig getGitHubMcpToolConfig() { + return githubMcpToolConfig; + } + + /** Sets the GitHub MCP tool configuration. @param config the value */ + public void setGitHubMcpToolConfig(GitHubMcpToolConfig config) { + this.githubMcpToolConfig = config; + } + + /** + * Gets the isExperimentalMode flag. + * + * @return the flag + */ + public Boolean getIsExperimentalMode() { + return isExperimentalMode; + } + + /** + * Sets the isExperimentalMode flag. + * + * @param isExperimentalMode + * the flag + */ + public void setIsExperimentalMode(boolean isExperimentalMode) { + this.isExperimentalMode = isExperimentalMode; + } + + /** Clears the isExperimentalMode setting, reverting to the default behavior. */ + public void clearIsExperimentalMode() { + this.isExperimentalMode = null; + } + + /** Gets the requestExitPlanMode flag. @return the flag */ + public Boolean getRequestExitPlanMode() { + return requestExitPlanMode; + } + + /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */ + public void setRequestExitPlanMode(Boolean requestExitPlanMode) { + this.requestExitPlanMode = requestExitPlanMode; + } + + /** Gets the requestAutoModeSwitch flag. @return the flag */ + public Boolean getRequestAutoModeSwitch() { + return requestAutoModeSwitch; + } + + /** + * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag + */ + public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) { + this.requestAutoModeSwitch = requestAutoModeSwitch; + } + + /** Gets the model capabilities override. @return the override */ + public ModelCapabilitiesOverride getModelCapabilities() { + return modelCapabilities; + } + + /** + * Sets the model capabilities override. @param modelCapabilities the override + */ + public void setModelCapabilities(ModelCapabilitiesOverride modelCapabilities) { + this.modelCapabilities = modelCapabilities; + } + + /** Gets the GitHub token for per-session authentication. @return the token */ + public String getGitHubToken() { + return gitHubToken; + } + + /** + * Sets the GitHub token for per-session authentication. @param gitHubToken the + * token + */ + public void setGitHubToken(String gitHubToken) { + this.gitHubToken = gitHubToken; + } + + /** Gets the remote session mode. @return the remote session mode */ + public String getRemoteSession() { + return remoteSession; + } + + /** + * Sets the remote session mode. @param remoteSession the remote session mode + */ + public void setRemoteSession(String remoteSession) { + this.remoteSession = remoteSession; + } + + /** Gets the ExP assignment data. @return the ExP assignment data */ + public CopilotExpAssignmentResponse getExpAssignments() { + return expAssignments; + } + + /** + * Sets the ExP assignment data. @param expAssignments the ExP assignment data + */ + public void setExpAssignments(CopilotExpAssignmentResponse expAssignments) { + this.expAssignments = expAssignments; + } + + /** + * Gets the self-fetch managed settings flag. @return the flag, or {@code null} + * if not set + */ + public Boolean getEnableManagedSettings() { + return enableManagedSettings; + } + + /** + * Sets the self-fetch managed settings flag. @param enableManagedSettings the + * flag + */ + public void setEnableManagedSettings(boolean enableManagedSettings) { + this.enableManagedSettings = enableManagedSettings; + } + + /** + * Clears the enableManagedSettings setting, reverting to the default behavior. + */ + public void clearEnableManagedSettings() { + this.enableManagedSettings = null; + } + + /** @return host-injected managed settings, or {@code null} when unset */ + public ManagedSettings getManagedSettings() { + return managedSettings; + } + + /** + * @param managedSettings + * host-injected managed settings + */ + public void setManagedSettings(ManagedSettings managedSettings) { + this.managedSettings = managedSettings; + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java new file mode 100644 index 000000000..0f74eb5ac --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java @@ -0,0 +1,30 @@ +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.github.copilot.generated.rpc.OpenCanvasInstance; +import java.util.List; + +/** + * Internal response object from resuming a session. + *

+ * The {@code openCanvases} component was added in 1.0.1. + * + * @param sessionId + * the session ID + * @param workspacePath + * the workspace path, or {@code null} if infinite sessions are + * disabled + * @param capabilities + * the capabilities reported by the host, or {@code null} + * @param openCanvases + * the canvas instances open for the session, or {@code null} (since + * 1.0.1) + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public record ResumeSessionResponse(@JsonProperty("sessionId") String sessionId, + @JsonProperty("workspacePath") String workspacePath, + @JsonProperty("capabilities") SessionCapabilities capabilities, + @JsonProperty("openCanvases") List openCanvases) { +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/RuntimeConnection.java b/java/sdk/src/main/java/com/github/copilot/rpc/RuntimeConnection.java new file mode 100644 index 000000000..a0c8eec5c --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/RuntimeConnection.java @@ -0,0 +1,94 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.CopilotExperimental; + +/** + * Configures how a {@link com.github.copilot.CopilotClient} connects to the + * Copilot runtime. + *

+ * Instances are created through the factory methods on this class and assigned + * with {@link CopilotClientOptions#setConnection(RuntimeConnection)}: + * + * 

{@code
+ * // Spawn a runtime child process and talk over stdin/stdout (the default).
+ * new CopilotClientOptions().setConnection(RuntimeConnection.forStdio());
+ *
+ * // Spawn a runtime child process listening on a TCP socket.
+ * new CopilotClientOptions().setConnection(RuntimeConnection.forTcp().setPath("/usr/local/bin/copilot"));
+ *
+ * // Connect to an already-running runtime.
+ * new CopilotClientOptions().setConnection(RuntimeConnection.forUri("localhost:3000"));
+ * }
+ * + * @since 1.0.0 + */ +@CopilotExperimental +public abstract sealed class RuntimeConnection + permits StdioRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, InProcessRuntimeConnection { + + RuntimeConnection() { + } + + /** + * Spawns a runtime child process and communicates over its stdin/stdout. This + * is the default when no connection is configured. + * + * @return a new stdio connection + */ + public static StdioRuntimeConnection forStdio() { + return new StdioRuntimeConnection(); + } + + /** + * Spawns a runtime child process at the given path and communicates over its + * stdin/stdout. + * + * @param path + * path to the runtime executable, or {@code null} to use the runtime + * discovered on the {@code PATH} + * @return a new stdio connection + */ + public static StdioRuntimeConnection forStdio(String path) { + return new StdioRuntimeConnection().setPath(path); + } + + /** + * Spawns a runtime child process that listens on a TCP socket and connects to + * it. + * + * @return a new TCP connection + */ + public static TcpRuntimeConnection forTcp() { + return new TcpRuntimeConnection(); + } + + /** + * Connects to an already-running runtime at the given URL. + * + * @param url + * URL of the runtime to connect to; accepts {@code "port"}, + * {@code "host:port"}, or a full URL + * @return a new URI connection + * @throws IllegalArgumentException + * if {@code url} is {@code null} or empty + */ + public static UriRuntimeConnection forUri(String url) { + return new UriRuntimeConnection(url); + } + + /** + * Hosts the runtime in-process by loading its native library and communicating + * over the C ABI — no child process is spawned by the SDK for JSON-RPC + * transport. + * + * @return a new in-process connection + */ + @CopilotExperimental + public static InProcessRuntimeConnection forInProcess() { + return new InProcessRuntimeConnection(); + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/SectionOverride.java b/java/sdk/src/main/java/com/github/copilot/rpc/SectionOverride.java similarity index 90% rename from java/src/main/java/com/github/copilot/rpc/SectionOverride.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SectionOverride.java index 0b4dd05ce..1c4a39b57 100644 --- a/java/src/main/java/com/github/copilot/rpc/SectionOverride.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SectionOverride.java @@ -12,34 +12,34 @@ import com.fasterxml.jackson.annotation.JsonProperty; /** - * Override operation for a single system prompt section in + * Override operation for a single system message section in * {@link SystemMessageMode#CUSTOMIZE} mode. *

* Each {@code SectionOverride} describes how one named section of the default - * system prompt should be modified. The section name keys come from - * {@link SystemPromptSections}. + * system message should be modified. The section name keys come from + * {@link SystemMessageSections}. * *

Static override example

* * 
{@code
  * var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE).setSections(Map.of(
- * 		SystemPromptSections.TONE,
+ * 		SystemMessageSections.TONE,
  * 		new SectionOverride().setAction(SectionOverrideAction.REPLACE).setContent("Be concise and formal."),
- * 		SystemPromptSections.CODE_CHANGE_RULES, new SectionOverride().setAction(SectionOverrideAction.REMOVE)));
+ * 		SystemMessageSections.CODE_CHANGE_RULES, new SectionOverride().setAction(SectionOverrideAction.REMOVE)));
  * }
* *

Transform callback example

* * 
{@code
  * var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE)
- * 		.setSections(Map.of(SystemPromptSections.IDENTITY, new SectionOverride().setTransform(
+ * 		.setSections(Map.of(SystemMessageSections.IDENTITY, new SectionOverride().setTransform(
  * 				content -> CompletableFuture.completedFuture(content + "\nAlways end replies with DONE."))));
  * }
* * @see SystemMessageConfig * @see SectionOverrideAction - * @see SystemPromptSections - * @since 1.2.0 + * @see SystemMessageSections + * @since 1.0.0 */ @JsonInclude(JsonInclude.Include.NON_NULL) public class SectionOverride { diff --git a/java/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java b/java/sdk/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java similarity index 84% rename from java/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java index f3569009b..a00958fdb 100644 --- a/java/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SectionOverrideAction.java @@ -12,7 +12,7 @@ * * @see SectionOverride * @see SystemMessageConfig - * @since 1.2.0 + * @since 1.0.0 */ public enum SectionOverrideAction { @@ -28,6 +28,13 @@ public enum SectionOverrideAction { /** Prepend content before the existing section. */ PREPEND("prepend"), + /** + * No-op marker that opts an individually-addressable section out of a + * group-level {@link #REMOVE} (e.g. keep {@link SystemMessageSections#TONE} + * when removing the {@link SystemMessageSections#IDENTITY} group). + */ + PRESERVE("preserve"), + /** * Transform the section content via a callback. *

diff --git a/java/src/main/java/com/github/copilot/rpc/SendMessageRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/SendMessageRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SendMessageRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SendMessageRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/SendMessageResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/SendMessageResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SendMessageResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SendMessageResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionCapabilities.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionCapabilities.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionCapabilities.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionCapabilities.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionConfig.java similarity index 75% rename from java/src/main/java/com/github/copilot/rpc/SessionConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionConfig.java index fa7fd2244..1127e6777 100644 --- a/java/src/main/java/com/github/copilot/rpc/SessionConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SessionConfig.java @@ -8,13 +8,15 @@ import java.util.Collections; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.function.Consumer; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonIgnore; +import com.github.copilot.CopilotExperimental; import com.github.copilot.generated.SessionEvent; -import java.util.Optional; +import com.github.copilot.generated.rpc.SessionLimitsConfig; /** * Configuration for creating a new Copilot session. @@ -48,16 +50,26 @@ public class SessionConfig { private SystemMessageConfig systemMessage; private List availableTools; private List excludedTools; + private List excludedBuiltInAgents; private ProviderConfig provider; + private CapiSessionOptions capi; + private List providers; + private List models; private Boolean enableSessionTelemetry; + private Boolean enableCitations; + private Boolean enableFileChangeTracking; + private SessionLimitsConfig sessionLimits; + private Boolean enableExperimentalMode; private Boolean skipCustomInstructions; private Boolean customAgentsLocalOnly; private Boolean coauthorEnabled; private Boolean manageScheduleEnabled; private PermissionHandler onPermissionRequest; + private McpAuthHandler onMcpAuthRequest; private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private boolean streaming; private Boolean includeSubAgentStreamingEvents; private Map mcpServers; @@ -70,7 +82,10 @@ public class SessionConfig { private List instructionDirectories; private List pluginDirectories; private LargeToolOutputConfig largeOutput; + private ToolSearchConfig toolSearch; + private MemoryConfiguration memory; private List disabledSkills; + private List disabledMcpServers; private String configDirectory; private Boolean enableConfigDiscovery; private Boolean skipEmbeddingRetrieval; @@ -88,9 +103,13 @@ public class SessionConfig { private ExitPlanModeHandler onExitPlanMode; private AutoModeSwitchHandler onAutoModeSwitch; private boolean enableMcpApps; + private GitHubMcpToolConfig githubMcpToolConfig; private String gitHubToken; private String remoteSession; private CloudSessionOptions cloud; + private CopilotExpAssignmentResponse expAssignments; + private Boolean enableManagedSettings; + private ManagedSettings managedSettings; /** * Gets the custom session ID. @@ -164,7 +183,8 @@ public SessionConfig setModel(String model) { /** * Gets the reasoning effort level. * - * @return the reasoning effort level ("low", "medium", "high", or "xhigh") + * @return the reasoning effort level ("low", "medium", "high", "xhigh", or + * "max") */ public String getReasoningEffort() { return reasoningEffort; @@ -173,8 +193,8 @@ public String getReasoningEffort() { /** * Sets the reasoning effort level for models that support it. *

- * Valid values: "low", "medium", "high", "xhigh". Only applies to models where - * {@code capabilities.supports.reasoningEffort} is true. + * Valid values: "low", "medium", "high", "xhigh", "max". Only applies to models + * where {@code capabilities.supports.reasoningEffort} is true. * * @param reasoningEffort * the reasoning effort level @@ -329,6 +349,30 @@ public SessionConfig setExcludedTools(List excludedTools) { return this; } + /** + * Gets the built-in agent names excluded from this session. + * + * @return the list of excluded built-in agent names + */ + public List getExcludedBuiltInAgents() { + return excludedBuiltInAgents == null ? null : Collections.unmodifiableList(excludedBuiltInAgents); + } + + /** + * Sets the built-in agent names to exclude from this session. + *

+ * Excluded built-in agents are hidden from discovery and cannot be selected or + * invoked unless a custom agent with the same name is configured. + * + * @param excludedBuiltInAgents + * the built-in agent names to exclude + * @return this config instance for method chaining + */ + public SessionConfig setExcludedBuiltInAgents(List excludedBuiltInAgents) { + this.excludedBuiltInAgents = excludedBuiltInAgents != null ? new ArrayList<>(excludedBuiltInAgents) : null; + return this; + } + /** * Gets the custom API provider configuration. * @@ -354,6 +398,85 @@ public SessionConfig setProvider(ProviderConfig provider) { return this; } + /** + * Gets the CAPI provider-scoped session options. + * + * @return the CAPI session options + */ + public CapiSessionOptions getCapi() { + return capi; + } + + /** + * Sets CAPI provider-scoped session options. + *

+ * Use {@link CapiSessionOptions#setEnableWebSocketResponses(Boolean)} with + * {@code false} to force the HTTP Responses transport instead of the default + * CAPI Responses API WebSocket transport. + * + * @param capi + * the CAPI session options + * @return this config instance for method chaining + * @see CapiSessionOptions + */ + public SessionConfig setCapi(CapiSessionOptions capi) { + this.capi = capi; + return this; + } + + /** + * Gets the named BYOK provider connections. + * + * @return the named provider connections, or {@code null} if not set + */ + @CopilotExperimental + public List getProviders() { + return providers; + } + + /** + * Sets the named BYOK provider connections (additive multi-provider registry). + *

+ * Unlike {@link #setProvider(ProviderConfig)}, these do not switch the whole + * session to BYOK; they are exposed alongside the default Copilot routing. + * Attach models referencing these connections with {@link #setModels(List)}. + * + * @param providers + * the named provider connections + * @return this config instance for method chaining + * @see NamedProviderConfig + */ + @CopilotExperimental + public SessionConfig setProviders(List providers) { + this.providers = providers; + return this; + } + + /** + * Gets the BYOK model definitions. + * + * @return the model definitions, or {@code null} if not set + */ + @CopilotExperimental + public List getModels() { + return models; + } + + /** + * Sets the BYOK model definitions, each referencing a named provider supplied + * via {@link #setProviders(List)}. + * + * @param models + * the model definitions + * @return this config instance for method chaining + * @see ProviderModelConfig + */ + @CopilotExperimental + public SessionConfig setModels(List models) { + this.models = models; + return this; + } + /** * Enables or disables internal session telemetry for this session. When * {@code false}, disables session telemetry. When unset (the default) or @@ -398,6 +521,145 @@ public SessionConfig clearEnableSessionTelemetry() { return this; } + /** + * Gets whether native model citations are enabled. + * + * @return an {@link java.util.Optional} containing whether citations are + * enabled, or {@link java.util.Optional#empty()} for the default + */ + @CopilotExperimental + @JsonIgnore + public Optional getEnableCitations() { + return Optional.ofNullable(enableCitations); + } + + /** + * Enables or disables native model citations for supported providers. + * + * @param enableCitations + * whether to enable citations + * @return this config instance for method chaining + */ + @CopilotExperimental + public SessionConfig setEnableCitations(boolean enableCitations) { + this.enableCitations = enableCitations; + return this; + } + + /** + * Clears the enableCitations setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + @CopilotExperimental + public SessionConfig clearEnableCitations() { + this.enableCitations = null; + return this; + } + + /** + * Gets whether file change tracking is enabled for rewind and cumulative + * session diff. + * + * @return an {@link java.util.Optional} containing the setting, or + * {@link java.util.Optional#empty()} for the default + */ + @JsonIgnore + public Optional getEnableFileChangeTracking() { + return Optional.ofNullable(enableFileChangeTracking); + } + + /** + * Enables or disables file change tracking from the first turn. + * + * @param enableFileChangeTracking + * whether to enable file change tracking + * @return this config instance for method chaining + */ + public SessionConfig setEnableFileChangeTracking(boolean enableFileChangeTracking) { + this.enableFileChangeTracking = enableFileChangeTracking; + return this; + } + + /** + * Clears the file change tracking setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + public SessionConfig clearEnableFileChangeTracking() { + this.enableFileChangeTracking = null; + return this; + } + + /** + * Gets the limits for this session's current accounting window. + * + * @return the session limits, or {@code null} if not set + */ + @CopilotExperimental + public SessionLimitsConfig getSessionLimits() { + return sessionLimits; + } + + /** + * Sets limits for this session's current accounting window. + * + * @param sessionLimits + * the session limits + * @return this config instance for method chaining + */ + @CopilotExperimental + public SessionConfig setSessionLimits(SessionLimitsConfig sessionLimits) { + this.sessionLimits = sessionLimits; + return this; + } + + /** + * Clears the sessionLimits setting, reverting to the default behavior. + * + * @return this instance for method chaining + */ + @CopilotExperimental + public SessionConfig clearSessionLimits() { + this.sessionLimits = null; + return this; + } + + /** + * Controls whether the session enables experimental features. + * + * @return {@code true} when experimental features are enabled, {@code false} + * when they are disabled, or empty to use the mode-specific default + */ + @JsonIgnore + public Optional getEnableExperimentalMode() { + return Optional.ofNullable(enableExperimentalMode); + } + + /** + * Controls whether the session enables experimental features. + * + * @param enableExperimentalMode + * {@code true} to enable experimental features; {@code false} to + * disable them + * @return this config instance for method chaining + */ + public SessionConfig setEnableExperimentalMode(boolean enableExperimentalMode) { + this.enableExperimentalMode = enableExperimentalMode; + return this; + } + + /** + * Clears the enableExperimentalMode setting. In {@link CopilotClientMode#EMPTY + * EMPTY} mode this defaults to {@code false}; otherwise the runtime decides. + * + * @return this instance for method chaining + */ + public SessionConfig clearEnableExperimentalMode() { + this.enableExperimentalMode = null; + return this; + } + /** * Gets whether custom instruction file loading is suppressed. * @@ -456,11 +718,11 @@ public Optional getCustomAgentsLocalOnly() { * Sets whether custom-agent discovery is restricted to the session's local * working directory (no organisation-level discovery). *

- * This option is sent to the server via a {@code session.options.update} - * JSON-RPC call immediately after session creation. In - * {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true} (local - * only); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is - * forwarded only when explicitly set. + * This option is sent with the initial create request and maintained via + * {@code session.options.update}. In {@link CopilotClientMode#EMPTY EMPTY} mode + * the default is {@code true} (local only); in + * {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is forwarded + * only when explicitly set. * * @param customAgentsLocalOnly * whether to restrict to local agents @@ -592,6 +854,31 @@ public SessionConfig setOnPermissionRequest(PermissionHandler onPermissionReques return this; } + /** + * Gets the MCP OAuth request handler. + * + * @return the handler, or {@code null} if not set + */ + @JsonIgnore + public McpAuthHandler getOnMcpAuthRequest() { + return onMcpAuthRequest; + } + + /** + * Sets the MCP OAuth request handler. + *

+ * When provided, the SDK can satisfy MCP server OAuth requests with + * host-provided token data or cancellation. + * + * @param onMcpAuthRequest + * the handler + * @return this config instance for method chaining + */ + public SessionConfig setOnMcpAuthRequest(McpAuthHandler onMcpAuthRequest) { + this.onMcpAuthRequest = onMcpAuthRequest; + return this; + } + /** * Gets the user input request handler. * @@ -661,6 +948,27 @@ public SessionConfig setWorkingDirectory(String workingDirectory) { return this; } + /** + * Gets the directories the agent may access beyond the working directory. + * + * @return the additional directory paths + */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets directories the agent may access beyond the working directory. + * + * @param additionalDirectories + * the additional directory paths + * @return this config instance for method chaining + */ + public SessionConfig setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + return this; + } + /** * Returns whether streaming is enabled. * @@ -930,6 +1238,49 @@ public SessionConfig setLargeOutput(LargeToolOutputConfig largeOutput) { return this; } + /** + * Gets the tool-search override configuration. + * + * @return the tool-search config, or {@code null} for the runtime default + */ + public ToolSearchConfig getToolSearch() { + return toolSearch; + } + + /** + * Sets the tool-search override configuration. When {@code null}, the runtime + * default tool-search behavior applies. + * + * @param toolSearch + * the tool-search config + * @return this config instance for method chaining + */ + public SessionConfig setToolSearch(ToolSearchConfig toolSearch) { + this.toolSearch = toolSearch; + return this; + } + + /** + * Gets the configuration for session memory. + * + * @return the memory config, or {@code null} for default + */ + public MemoryConfiguration getMemory() { + return memory; + } + + /** + * Sets the configuration for session memory. + * + * @param memory + * the memory config + * @return this config instance for method chaining + */ + public SessionConfig setMemory(MemoryConfiguration memory) { + this.memory = memory; + return this; + } + /** * Gets the disabled skill names. * @@ -954,6 +1305,29 @@ public SessionConfig setDisabledSkills(List disabledSkills) { return this; } + /** + * Gets exact MCP server names disabled for this session. + * + * @return the disabled MCP server names, or {@code null} when none are disabled + */ + public List getDisabledMcpServers() { + return disabledMcpServers == null ? null : Collections.unmodifiableList(disabledMcpServers); + } + + /** + * Sets exact MCP server names to disable for this session. Disabled servers are + * not started or authenticated on create or cold resume; a resident resume + * cannot stop servers already running. + * + * @param disabledMcpServers + * the server names to disable + * @return this config for method chaining + */ + public SessionConfig setDisabledMcpServers(List disabledMcpServers) { + this.disabledMcpServers = disabledMcpServers; + return this; + } + /** * Gets the custom configuration directory. * @@ -991,14 +1365,8 @@ public Optional getEnableConfigDiscovery() { } /** - * Sets whether to automatically discover MCP server configurations and skill - * directories from the working directory. - *

- * When {@code true}, the CLI scans the working directory for {@code .mcp.json}, - * {@code .vscode/mcp.json} and skill directories, and merges them with - * explicitly provided {@link #setMcpServers(Map)} and - * {@link #setSkillDirectories(List)}, with explicit values taking precedence on - * name collision. + * Enables runtime discovery of supported configuration. Explicitly supplied + * configuration takes precedence over discovered values. * * @param enableConfigDiscovery * {@code true} to enable discovery, {@code false} to disable @@ -1475,6 +1843,27 @@ public SessionConfig setEnableMcpApps(boolean enableMcpApps) { return this; } + /** + * Gets the configuration for the built-in GitHub MCP server. + * + * @return the GitHub MCP configuration, or {@code null} + */ + public GitHubMcpToolConfig getGitHubMcpToolConfig() { + return githubMcpToolConfig; + } + + /** + * Sets the configuration for the built-in GitHub MCP server. + * + * @param githubMcpToolConfig + * the GitHub MCP configuration + * @return this config instance for method chaining + */ + public SessionConfig setGitHubMcpToolConfig(GitHubMcpToolConfig githubMcpToolConfig) { + this.githubMcpToolConfig = githubMcpToolConfig; + return this; + } + /** * Gets the exit-plan-mode request handler. * @@ -1624,6 +2013,93 @@ public SessionConfig setCloud(CloudSessionOptions cloud) { return this; } + /** + * Gets the ExP assignment ("flight") data injected by a trusted integrator. + * + * @return the ExP assignment data, or {@code null} if not set + */ + public CopilotExpAssignmentResponse getExpAssignments() { + return expAssignments; + } + + /** + * Sets ExP assignment ("flight") data injected by a trusted integrator. + *

+ * The value is in the same shape the Copilot CLI fetches from the + * experimentation service ({@link CopilotExpAssignmentResponse}). When + * provided, the runtime feeds it into the same feature-flag path as CLI-fetched + * assignments and stamps it onto telemetry and the CAPI request header. When + * absent, the session does not block on ExP. Intended for out-of-process + * integrators that fetch ExP data themselves; malformed payloads are dropped by + * the runtime (fail-open). Serialized on the wire as {@code expAssignments}. + *

+ * This is an internal/trusted-integrator option, not part of the broadly + * advertised public surface. + * + * @param expAssignments + * the ExP assignment data + * @return this config instance for method chaining + */ + public SessionConfig setExpAssignments(CopilotExpAssignmentResponse expAssignments) { + this.expAssignments = expAssignments; + return this; + } + + /** + * Gets whether the runtime self-fetches enterprise managed settings at session + * bootstrap. + * + * @return an {@link java.util.Optional} containing {@code true} to opt into + * self-fetching managed settings, or {@link java.util.Optional#empty()} + * to use the default behavior + */ + @JsonIgnore + public Optional getEnableManagedSettings() { + return Optional.ofNullable(enableManagedSettings); + } + + /** + * Opts the runtime into self-fetching enterprise managed settings + * (bypass-permissions policy) at session bootstrap. + *

+ * When {@code true}, the runtime self-fetches enterprise managed settings using + * the session's {@link #getGitHubToken() gitHubToken}. Requires + * {@code gitHubToken} to be set; if omitted, the runtime is expected to reject + * session creation (fail-closed). When unset, behaves exactly as before. + * Serialized on the wire as {@code enableManagedSettings}. + * + * @param enableManagedSettings + * {@code true} to opt into self-fetching managed settings + * @return this config instance for method chaining + */ + public SessionConfig setEnableManagedSettings(boolean enableManagedSettings) { + this.enableManagedSettings = enableManagedSettings; + return this; + } + + /** + * Gets host-injected managed settings for this session. + * + * @return the managed settings, or {@code null} when unset + */ + public ManagedSettings getManagedSettings() { + return managedSettings; + } + + /** + * Supplies permissions-only managed settings at session startup. The runtime + * validates and composes this policy restrictively with self-fetched and device + * policy. Re-supply it on resume because it is not persisted. + * + * @param managedSettings + * the host-injected managed settings + * @return this config instance for method chaining + */ + public SessionConfig setManagedSettings(ManagedSettings managedSettings) { + this.managedSettings = managedSettings; + return this; + } + /** * Creates a shallow clone of this {@code SessionConfig} instance. *

@@ -1648,8 +2124,18 @@ public SessionConfig clone() { copy.systemMessage = this.systemMessage; copy.availableTools = this.availableTools != null ? new ArrayList<>(this.availableTools) : null; copy.excludedTools = this.excludedTools != null ? new ArrayList<>(this.excludedTools) : null; + copy.excludedBuiltInAgents = this.excludedBuiltInAgents != null + ? new ArrayList<>(this.excludedBuiltInAgents) + : null; copy.provider = this.provider; + copy.capi = this.capi; + copy.providers = this.providers != null ? new ArrayList<>(this.providers) : null; + copy.models = this.models != null ? new ArrayList<>(this.models) : null; copy.enableSessionTelemetry = this.enableSessionTelemetry; + copy.enableCitations = this.enableCitations; + copy.enableFileChangeTracking = this.enableFileChangeTracking; + copy.sessionLimits = this.sessionLimits; + copy.enableExperimentalMode = this.enableExperimentalMode; copy.skipCustomInstructions = this.skipCustomInstructions; copy.customAgentsLocalOnly = this.customAgentsLocalOnly; copy.coauthorEnabled = this.coauthorEnabled; @@ -1658,6 +2144,9 @@ public SessionConfig clone() { copy.onUserInputRequest = this.onUserInputRequest; copy.hooks = this.hooks; copy.workingDirectory = this.workingDirectory; + copy.additionalDirectories = this.additionalDirectories != null + ? new ArrayList<>(this.additionalDirectories) + : null; copy.streaming = this.streaming; copy.includeSubAgentStreamingEvents = this.includeSubAgentStreamingEvents; copy.mcpServers = this.mcpServers != null ? new java.util.HashMap<>(this.mcpServers) : null; @@ -1671,7 +2160,10 @@ public SessionConfig clone() { : null; copy.pluginDirectories = this.pluginDirectories != null ? new ArrayList<>(this.pluginDirectories) : null; copy.largeOutput = this.largeOutput; + copy.toolSearch = this.toolSearch; + copy.memory = this.memory; copy.disabledSkills = this.disabledSkills != null ? new ArrayList<>(this.disabledSkills) : null; + copy.disabledMcpServers = this.disabledMcpServers != null ? new ArrayList<>(this.disabledMcpServers) : null; copy.configDirectory = this.configDirectory; copy.enableConfigDiscovery = this.enableConfigDiscovery; copy.skipEmbeddingRetrieval = this.skipEmbeddingRetrieval; @@ -1686,12 +2178,17 @@ public SessionConfig clone() { copy.onEvent = this.onEvent; copy.commands = this.commands != null ? new ArrayList<>(this.commands) : null; copy.onElicitationRequest = this.onElicitationRequest; + copy.onMcpAuthRequest = this.onMcpAuthRequest; copy.onExitPlanMode = this.onExitPlanMode; copy.onAutoModeSwitch = this.onAutoModeSwitch; copy.enableMcpApps = this.enableMcpApps; + copy.githubMcpToolConfig = this.githubMcpToolConfig; copy.gitHubToken = this.gitHubToken; copy.remoteSession = this.remoteSession; copy.cloud = this.cloud; + copy.expAssignments = this.expAssignments; + copy.enableManagedSettings = this.enableManagedSettings; + copy.managedSettings = this.managedSettings; return copy; } } diff --git a/java/src/main/java/com/github/copilot/rpc/SessionContext.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionContext.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionContext.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionContext.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionEndHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionEndHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionEndHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionEndHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionEndHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionEndHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionEndHookOutput.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionHooks.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionHooks.java similarity index 80% rename from java/src/main/java/com/github/copilot/rpc/SessionHooks.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionHooks.java index f13e08131..e476f888e 100644 --- a/java/src/main/java/com/github/copilot/rpc/SessionHooks.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SessionHooks.java @@ -42,8 +42,10 @@ public class SessionHooks { private PostToolUseHandler onPostToolUse; private PostToolUseFailureHandler onPostToolUseFailure; private UserPromptSubmittedHandler onUserPromptSubmitted; + private UserPromptTransformedHandler onUserPromptTransformed; private SessionStartHandler onSessionStart; private SessionEndHandler onSessionEnd; + private AgentStopHandler onAgentStop; /** * Gets the pre-tool-use handler. @@ -160,6 +162,29 @@ public SessionHooks setOnUserPromptSubmitted(UserPromptSubmittedHandler onUserPr return this; } + /** + * Gets the user-prompt-transformed handler. + * + * @return the handler, or {@code null} if not set + * @since 1.0.11 + */ + public UserPromptTransformedHandler getOnUserPromptTransformed() { + return onUserPromptTransformed; + } + + /** + * Sets the handler called after the runtime transforms a submitted prompt. + * + * @param onUserPromptTransformed + * the handler + * @return this instance for method chaining + * @since 1.0.11 + */ + public SessionHooks setOnUserPromptTransformed(UserPromptTransformedHandler onUserPromptTransformed) { + this.onUserPromptTransformed = onUserPromptTransformed; + return this; + } + /** * Gets the session-start handler. * @@ -206,6 +231,29 @@ public SessionHooks setOnSessionEnd(SessionEndHandler onSessionEnd) { return this; } + /** + * Gets the agent-stop handler. + * + * @return the handler, or {@code null} if not set + * @since 1.0.9 + */ + public AgentStopHandler getOnAgentStop() { + return onAgentStop; + } + + /** + * Sets the handler called when the top-level agent reaches a natural stop. + * + * @param onAgentStop + * the handler + * @return this instance for method chaining + * @since 1.0.9 + */ + public SessionHooks setOnAgentStop(AgentStopHandler onAgentStop) { + this.onAgentStop = onAgentStop; + return this; + } + /** * Returns whether any hooks are registered. * @@ -213,6 +261,7 @@ public SessionHooks setOnSessionEnd(SessionEndHandler onSessionEnd) { */ public boolean hasHooks() { return onPreToolUse != null || onPreMcpToolCall != null || onPostToolUse != null || onPostToolUseFailure != null - || onUserPromptSubmitted != null || onSessionStart != null || onSessionEnd != null; + || onUserPromptSubmitted != null || onUserPromptTransformed != null || onSessionStart != null + || onSessionEnd != null || onAgentStop != null; } } diff --git a/java/src/main/java/com/github/copilot/rpc/SessionLifecycleEvent.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEvent.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionLifecycleEvent.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEvent.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionLifecycleEventMetadata.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEventMetadata.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionLifecycleEventMetadata.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEventMetadata.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionLifecycleEventTypes.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEventTypes.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionLifecycleEventTypes.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleEventTypes.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionLifecycleHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionLifecycleHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionLifecycleHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionListFilter.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionListFilter.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionListFilter.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionListFilter.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionMetadata.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionMetadata.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionMetadata.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionMetadata.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionStartHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionStartHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionStartHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionStartHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionStartHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionStartHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionStartHookOutput.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionUiApi.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionUiApi.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionUiApi.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionUiApi.java diff --git a/java/src/main/java/com/github/copilot/rpc/SessionUiCapabilities.java b/java/sdk/src/main/java/com/github/copilot/rpc/SessionUiCapabilities.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SessionUiCapabilities.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SessionUiCapabilities.java diff --git a/java/src/main/java/com/github/copilot/rpc/SetForegroundSessionRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/SetForegroundSessionRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SetForegroundSessionRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SetForegroundSessionRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/SetForegroundSessionResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/SetForegroundSessionResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/SetForegroundSessionResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SetForegroundSessionResponse.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/StdioRuntimeConnection.java b/java/sdk/src/main/java/com/github/copilot/rpc/StdioRuntimeConnection.java new file mode 100644 index 000000000..7d0923e0f --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/StdioRuntimeConnection.java @@ -0,0 +1,71 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.ArrayList; +import java.util.List; + +import com.github.copilot.CopilotExperimental; + +/** + * Spawns a runtime child process and communicates over its stdin/stdout. + * Construct with {@link RuntimeConnection#forStdio()} or + * {@link RuntimeConnection#forStdio(String)}. + * + * @since 1.0.0 + */ +@CopilotExperimental +public final class StdioRuntimeConnection extends RuntimeConnection { + + private String path; + private List args; + + StdioRuntimeConnection() { + } + + /** + * Returns the path to the runtime executable. + * + * @return the path, or {@code null} to use the runtime discovered on the + * {@code PATH} + */ + public String getPath() { + return path; + } + + /** + * Sets the path to the runtime executable. + * + * @param path + * the path, or {@code null} to use the runtime discovered on the + * {@code PATH} + * @return this instance for method chaining + */ + public StdioRuntimeConnection setPath(String path) { + this.path = path; + return this; + } + + /** + * Returns the extra command-line arguments passed to the runtime process. + * + * @return the arguments, or {@code null} if none are configured + */ + public List getArgs() { + return args; + } + + /** + * Sets extra command-line arguments passed to the runtime process. + * + * @param args + * the arguments, or {@code null} for none + * @return this instance for method chaining + */ + public StdioRuntimeConnection setArgs(List args) { + this.args = args == null ? null : new ArrayList<>(args); + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java similarity index 95% rename from java/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java index 973168f4d..c5e89acc1 100644 --- a/java/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageConfig.java @@ -35,10 +35,10 @@ * 

{@code
  * var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE)
  * 		.setSections(
- * 				Map.of(SystemPromptSections.TONE,
+ * 				Map.of(SystemMessageSections.TONE,
  * 						new SectionOverride().setAction(SectionOverrideAction.REPLACE)
  * 								.setContent("Be concise and formal."),
- * 						SystemPromptSections.CODE_CHANGE_RULES,
+ * 						SystemMessageSections.CODE_CHANGE_RULES,
  * 						new SectionOverride().setAction(SectionOverrideAction.REMOVE)))
  * 		.setContent("Additional instructions appended after all sections.");
  * }
@@ -46,7 +46,7 @@ * @see SessionConfig#setSystemMessage(SystemMessageConfig) * @see SystemMessageMode * @see SectionOverride - * @see SystemPromptSections + * @see SystemMessageSections * @since 1.0.0 */ @JsonInclude(JsonInclude.Include.NON_NULL) @@ -122,7 +122,7 @@ public Map getSections() { /** * Sets section-level overrides for {@link SystemMessageMode#CUSTOMIZE} mode. *

- * Keys are section identifiers from {@link SystemPromptSections}. Each value + * Keys are section identifiers from {@link SystemMessageSections}. Each value * describes how that section should be modified. Sections with a * {@link SectionOverride#getTransform() transform} callback are handled locally * by the SDK via a {@code systemMessage.transform} RPC call; the rest are sent @@ -131,7 +131,7 @@ public Map getSections() { * @param sections * a map of section identifier to override operation * @return this config for method chaining - * @since 1.2.0 + * @since 1.0.0 */ public SystemMessageConfig setSections(Map sections) { this.sections = sections; diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageSections.java b/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageSections.java new file mode 100644 index 000000000..ca410e497 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SystemMessageSections.java @@ -0,0 +1,81 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Well-known system message section identifiers for use with + * {@link SystemMessageMode#CUSTOMIZE} mode. + *

+ * Each constant names a section of the default Copilot system message. Pass + * these as keys in the {@code sections} map of {@link SystemMessageConfig} to + * override individual sections. + * + *

Example

+ * + * 
{@code
+ * var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE).setSections(Map.of(
+ * 		SystemMessageSections.TONE,
+ * 		new SectionOverride().setAction(SectionOverrideAction.REPLACE).setContent("Always be concise."),
+ * 		SystemMessageSections.CODE_CHANGE_RULES, new SectionOverride().setAction(SectionOverrideAction.REMOVE)));
+ * }
+ * + * @see SystemMessageConfig + * @see SectionOverride + * @since 1.0.2 + */ +public abstract sealed class SystemMessageSections permits SystemPromptSections { + + /** Agent identity preamble and mode statement. */ + public static final String PREAMBLE = "preamble"; + + /** + * Section group covering the identity preamble and its sibling sub-sections + * (tone, tool efficiency, etc.). + */ + public static final String IDENTITY = "identity"; + + /** Response style, conciseness rules, output formatting preferences. */ + public static final String TONE = "tone"; + + /** Tool usage patterns, parallel calling, batching guidelines. */ + public static final String TOOL_EFFICIENCY = "tool_efficiency"; + + /** CWD, OS, git root, directory listing, available tools. */ + public static final String ENVIRONMENT_CONTEXT = "environment_context"; + + /** Coding rules, linting/testing, ecosystem tools, style. */ + public static final String CODE_CHANGE_RULES = "code_change_rules"; + + /** Tips, behavioral best practices, behavioral guidelines. */ + public static final String GUIDELINES = "guidelines"; + + /** Environment limitations, prohibited actions, security policies. */ + public static final String SAFETY = "safety"; + + /** Per-tool usage instructions. */ + public static final String TOOL_INSTRUCTIONS = "tool_instructions"; + + /** Repository and organization custom instructions. */ + public static final String CUSTOM_INSTRUCTIONS = "custom_instructions"; + + /** + * Runtime-provided context and instructions (e.g. system notifications, + * memories, workspace context, mode-specific instructions, content-exclusion + * policy). + * + * @since 1.3.0 + */ + public static final String RUNTIME_INSTRUCTIONS = "runtime_instructions"; + + /** + * End-of-prompt instructions: parallel tool calling, persistence, task + * completion. + */ + public static final String LAST_INSTRUCTIONS = "last_instructions"; + + /** Package-private constructor for the sealed hierarchy. */ + SystemMessageSections() { + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/SystemPromptSections.java b/java/sdk/src/main/java/com/github/copilot/rpc/SystemPromptSections.java new file mode 100644 index 000000000..10941926c --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/SystemPromptSections.java @@ -0,0 +1,23 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +/** + * Deprecated: use {@link SystemMessageSections} instead. + *

+ * This class is retained for backward compatibility. All constants are + * inherited from {@link SystemMessageSections}. + * + * @deprecated Use {@link SystemMessageSections} — this class will be removed in + * a future major version. + * @see SystemMessageSections + * @since 1.0.2 + */ +@Deprecated(since = "1.0.2", forRemoval = true) +public final class SystemPromptSections extends SystemMessageSections { + + private SystemPromptSections() { + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/TcpRuntimeConnection.java b/java/sdk/src/main/java/com/github/copilot/rpc/TcpRuntimeConnection.java new file mode 100644 index 000000000..648321a21 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/TcpRuntimeConnection.java @@ -0,0 +1,116 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.ArrayList; +import java.util.List; + +import com.github.copilot.CopilotExperimental; + +/** + * Spawns a runtime child process listening on a TCP socket and connects to it. + * Construct with {@link RuntimeConnection#forTcp()}. + * + * @since 1.0.0 + */ +@CopilotExperimental +public final class TcpRuntimeConnection extends RuntimeConnection { + + private String path; + private int port; + private String connectionToken; + private List args; + + TcpRuntimeConnection() { + } + + /** + * Returns the path to the runtime executable. + * + * @return the path, or {@code null} to use the runtime discovered on the + * {@code PATH} + */ + public String getPath() { + return path; + } + + /** + * Sets the path to the runtime executable. + * + * @param path + * the path, or {@code null} to use the runtime discovered on the + * {@code PATH} + * @return this instance for method chaining + */ + public TcpRuntimeConnection setPath(String path) { + this.path = path; + return this; + } + + /** + * Returns the TCP port the spawned runtime listens on. + * + * @return the port, or {@code 0} to auto-allocate a free port + */ + public int getPort() { + return port; + } + + /** + * Sets the TCP port the spawned runtime listens on. + * + * @param port + * the port, or {@code 0} (the default) to auto-allocate a free port + * @return this instance for method chaining + */ + public TcpRuntimeConnection setPort(int port) { + this.port = port; + return this; + } + + /** + * Returns the shared secret the SDK sends to the spawned runtime to + * authenticate the TCP connection. + * + * @return the token, or {@code null} to generate one automatically + */ + public String getConnectionToken() { + return connectionToken; + } + + /** + * Sets the shared secret the SDK sends to the spawned runtime to authenticate + * the TCP connection. + * + * @param connectionToken + * the token, or {@code null} to generate one automatically + * @return this instance for method chaining + */ + public TcpRuntimeConnection setConnectionToken(String connectionToken) { + this.connectionToken = connectionToken; + return this; + } + + /** + * Returns the extra command-line arguments passed to the runtime process. + * + * @return the arguments, or {@code null} if none are configured + */ + public List getArgs() { + return args; + } + + /** + * Sets extra command-line arguments passed to the runtime process. + * + * @param args + * the arguments, or {@code null} for none + * @return this instance for method chaining + */ + public TcpRuntimeConnection setArgs(List args) { + this.args = args == null ? null : new ArrayList<>(args); + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/TelemetryConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/TelemetryConfig.java similarity index 87% rename from java/src/main/java/com/github/copilot/rpc/TelemetryConfig.java rename to java/sdk/src/main/java/com/github/copilot/rpc/TelemetryConfig.java index c0b75f29d..a8a0f664a 100644 --- a/java/src/main/java/com/github/copilot/rpc/TelemetryConfig.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/TelemetryConfig.java @@ -24,12 +24,13 @@ * } * * @see CopilotClientOptions#setTelemetry(TelemetryConfig) - * @since 1.2.0 + * @since 1.0.0 */ @JsonInclude(JsonInclude.Include.NON_NULL) public class TelemetryConfig { private String otlpEndpoint; + private String otlpProtocol; private String filePath; private String exporterType; private String sourceName; @@ -58,6 +59,29 @@ public TelemetryConfig setOtlpEndpoint(String otlpEndpoint) { return this; } + /** + * Gets the OTLP HTTP protocol for all signals. + *

+ * Maps to the {@code OTEL_EXPORTER_OTLP_PROTOCOL} environment variable. + * + * @return the OTLP HTTP protocol, or {@code null} + */ + public String getOtlpProtocol() { + return otlpProtocol; + } + + /** + * Sets the OTLP HTTP protocol for all signals. + * + * @param otlpProtocol + * the protocol ({@code "http/json"} or {@code "http/protobuf"}) + * @return this config for method chaining + */ + public TelemetryConfig setOtlpProtocol(String otlpProtocol) { + this.otlpProtocol = otlpProtocol; + return this; + } + /** * Gets the file path for the file exporter. *

diff --git a/java/src/main/java/com/github/copilot/rpc/ToolBinaryResult.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolBinaryResult.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolBinaryResult.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolBinaryResult.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefer.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefer.java new file mode 100644 index 000000000..ba888ca97 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefer.java @@ -0,0 +1,96 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Controls whether a {@link ToolDefinition} may be deferred (loaded lazily via + * tool search) rather than always pre-loaded. + *

+ * Set on + * {@link ToolDefinition#createWithDefer(String, String, java.util.Map, ToolHandler, ToolDefer)} + * to express the tool's deferral preference; defaults to letting the runtime + * decide when unset. + * + * @see ToolDefinition + * @since 1.0.0 + */ +public enum ToolDefer { + + /** + * No deferral preference set. This is an annotation-only sentinel used + * as the default for {@code @CopilotTool(defer = ToolDefer.NONE)}. + *

+ * This constant must not be passed to {@link ToolDefinition} factory + * methods. The annotation processor and {@code ToolDefinition.fromObject()} + * must map {@code NONE} to a {@code null} field reference so that + * {@code @JsonInclude(NON_NULL)} on {@link ToolDefinition} omits the + * {@code defer} key from the JSON-RPC wire payload entirely (matching the + * nullable/optional semantics used by all other SDKs). + *

+ * As a secondary safety net, {@link #getValue()} returns {@code null} for this + * constant. Note that this alone does not cause field omission: if a + * non-null {@code NONE} reference reaches a {@link ToolDefinition} field, + * Jackson's {@code @JsonInclude(NON_NULL)} will still emit the field (as + * {@code "defer": null}) because the field reference itself is not null. The + * primary protection is mapping {@code NONE} to a null field reference before + * constructing the {@link ToolDefinition}. + */ + NONE(""), + + /** The tool can be deferred and surfaced through tool search. */ + AUTO("auto"), + + /** The tool is always pre-loaded. */ + NEVER("never"); + + private final String value; + + ToolDefer(String value) { + this.value = value; + } + + /** + * Returns the JSON value for this deferral mode. + *

+ * Returns {@code null} for {@link #NONE} to avoid emitting an empty string + * ({@code "defer": ""}) if this sentinel accidentally reaches serialization. + * With {@code null}, the worst-case leak becomes {@code "defer": null} rather + * than an invalid empty string. + * + * @return the string value used in JSON serialization, or {@code null} for + * {@link #NONE} + */ + @JsonValue + public String getValue() { + return this == NONE ? null : value; + } + + /** + * Deserializes a JSON string value into the corresponding {@code ToolDefer} + * enum constant. + * + * @param value + * the JSON string value + * @return the matching {@code ToolDefer}, or {@code null} if value is + * {@code null} + * @throws IllegalArgumentException + * if the value does not match any known deferral mode + */ + @JsonCreator + public static ToolDefer fromValue(String value) { + if (value == null) { + return null; + } + for (ToolDefer mode : values()) { + if (mode.value.equals(value)) { + return mode; + } + } + throw new IllegalArgumentException("Unknown ToolDefer value: " + value); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java new file mode 100644 index 000000000..de274b66a --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolDefinition.java @@ -0,0 +1,967 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collectors; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import com.github.copilot.CopilotExperimental; +import com.github.copilot.tool.Param; + +/** + * Defines a tool that can be invoked by the AI assistant. + *

+ * Tools extend the assistant's capabilities by allowing it to call back into + * your application to perform actions or retrieve information. Each tool has a + * name, description, parameter schema, and a handler function that executes + * when the tool is invoked. + * + *

Example Usage

+ * + * 
{@code
+ * // Define a record for your tool's arguments
+ * record WeatherArgs(String location) {
+ * }
+ *
+ * var tool = ToolDefinition.create("get_weather", "Get the current weather for a location",
+ * 		Map.of("type", "object", "properties",
+ * 				Map.of("location", Map.of("type", "string", "description", "City name")), "required",
+ * 				List.of("location")),
+ * 		invocation -> {
+ * 			// Type-safe access with records (recommended)
+ * 			WeatherArgs args = invocation.getArgumentsAs(WeatherArgs.class);
+ * 			return CompletableFuture.completedFuture(getWeatherData(args.location()));
+ *
+ * 			// Or use Map-based access
+ * 			// Map args = invocation.getArguments();
+ * 			// String location = (String) args.get("location");
+ * 		});
+ * }
+ * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param parameters + * the JSON Schema defining the tool's parameters + * @param handler + * the handler function to execute when invoked + * @param overridesBuiltInTool + * when {@code true}, indicates that this tool intentionally + * overrides a built-in CLI tool with the same name; {@code null} or + * {@code false} means the tool is purely custom + * @param skipPermission + * when {@code true}, the CLI skips the permission request for this + * tool invocation; {@code null} or {@code false} uses normal + * permission handling + * @param defer + * controls whether the tool may be deferred (loaded lazily via tool + * search) rather than always pre-loaded; {@code null} lets the + * runtime decide + * @param metadata + * opaque, host-defined metadata; keys are namespaced and not part of + * the stable public API; {@code null} when unset + * @param isTerminal + * when {@code true}, a successful call to this tool ends the agent + * turn: the runtime's tool phase halts instead of feeding the result + * back to the model for another round; {@code null} or {@code false} + * leaves the turn running + * @see SessionConfig#setTools(java.util.List) + * @see ToolHandler + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public record ToolDefinition(@JsonProperty("name") String name, @JsonProperty("description") String description, + @JsonProperty("parameters") Object parameters, @JsonIgnore ToolHandler handler, + @JsonProperty("overridesBuiltInTool") Boolean overridesBuiltInTool, + @JsonProperty("skipPermission") Boolean skipPermission, @JsonProperty("defer") ToolDefer defer, + @JsonProperty("metadata") Map metadata, @JsonProperty("isTerminal") Boolean isTerminal) { + + /** + * Creates a tool definition without a {@code metadata} bag or terminality hint. + *

+ * Convenience overload equivalent to the canonical constructor with + * {@code metadata} and {@code isTerminal} set to {@code null}. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param parameters + * the JSON Schema for the tool's parameters + * @param handler + * the handler function to execute when invoked + * @param overridesBuiltInTool + * whether this tool overrides a built-in tool; {@code null} for the + * default + * @param skipPermission + * whether the tool may run without a permission check; {@code null} + * for the default + * @param defer + * the deferral mode; {@code null} lets the runtime decide + */ + public ToolDefinition(String name, String description, Object parameters, ToolHandler handler, + Boolean overridesBuiltInTool, Boolean skipPermission, ToolDefer defer) { + this(name, description, parameters, handler, overridesBuiltInTool, skipPermission, defer, null, null); + } + + /** + * Creates a tool definition without a terminality hint. + *

+ * Convenience overload equivalent to the canonical constructor with + * {@code isTerminal} set to {@code null}. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param parameters + * the JSON Schema for the tool's parameters + * @param handler + * the handler function to execute when invoked + * @param overridesBuiltInTool + * whether this tool overrides a built-in tool; {@code null} for the + * default + * @param skipPermission + * whether the tool may run without a permission check; {@code null} + * for the default + * @param defer + * the deferral mode; {@code null} lets the runtime decide + * @param metadata + * the opaque, host-defined metadata; {@code null} when unset + */ + public ToolDefinition(String name, String description, Object parameters, ToolHandler handler, + Boolean overridesBuiltInTool, Boolean skipPermission, ToolDefer defer, Map metadata) { + this(name, description, parameters, handler, overridesBuiltInTool, skipPermission, defer, metadata, null); + } + + /** + * Creates a tool definition with a JSON schema for parameters. + *

+ * This is a convenience factory method for creating tools with a + * {@code Map}-based parameter schema. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param schema + * the JSON Schema as a {@code Map} + * @param handler + * the handler function to execute when invoked + * @return a new tool definition + */ + public static ToolDefinition create(String name, String description, Map schema, + ToolHandler handler) { + return new ToolDefinition(name, description, schema, handler, null, null, null, null); + } + + /** + * Creates a tool definition that overrides a built-in CLI tool. + *

+ * Use this factory method when you want your custom tool to replace a built-in + * tool (e.g., {@code grep}, {@code read_file}) with the same name. Setting + * {@code overridesBuiltInTool} to {@code true} signals to the CLI that this is + * intentional. + * + * @param name + * the name of the built-in tool to override + * @param description + * a description of what the tool does + * @param schema + * the JSON Schema as a {@code Map} + * @param handler + * the handler function to execute when invoked + * @return a new tool definition with the override flag set + * @since 1.0.11 + */ + public static ToolDefinition createOverride(String name, String description, Map schema, + ToolHandler handler) { + return new ToolDefinition(name, description, schema, handler, true, null, null, null); + } + + /** + * Creates a tool definition that skips the permission request. + *

+ * Use this factory method when the tool is safe to invoke without user + * permission confirmation. Setting {@code skipPermission} to {@code true} + * signals to the CLI that no permission check is needed. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param schema + * the JSON Schema as a {@code Map} + * @param handler + * the handler function to execute when invoked + * @return a new tool definition with permission skipping enabled + * @since 1.0.0 + */ + public static ToolDefinition createSkipPermission(String name, String description, Map schema, + ToolHandler handler) { + return new ToolDefinition(name, description, schema, handler, null, true, null, null); + } + + /** + * Creates a tool definition with an explicit deferral mode. + *

+ * Use this factory method to control whether the tool may be deferred (loaded + * lazily via tool search) rather than always pre-loaded. Pass + * {@link ToolDefer#AUTO} to allow deferral and {@link ToolDefer#NEVER} to force + * the tool to always be pre-loaded. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param schema + * the JSON Schema as a {@code Map} + * @param handler + * the handler function to execute when invoked + * @param defer + * the deferral mode for the tool + * @return a new tool definition with the deferral mode set + * @since 1.0.0 + */ + public static ToolDefinition createWithDefer(String name, String description, Map schema, + ToolHandler handler, ToolDefer defer) { + return new ToolDefinition(name, description, schema, handler, null, null, defer, null); + } + + /** + * Creates a tool definition with opaque, host-defined metadata. + *

+ * Use this factory method to attach namespaced metadata to the tool. The keys + * are not part of the stable public API; specific keys may be recognized to + * inform host-specific behavior. + * + * @param name + * the unique name of the tool + * @param description + * a description of what the tool does + * @param schema + * the JSON Schema as a {@code Map} + * @param handler + * the handler function to execute when invoked + * @param metadata + * the opaque metadata map + * @return a new tool definition with the metadata set + * @since 1.0.7 + */ + public static ToolDefinition createWithMetadata(String name, String description, Map schema, + ToolHandler handler, Map metadata) { + return new ToolDefinition(name, description, schema, handler, null, null, null, metadata); + } + + /** + * Discovers tool definitions from an object whose methods are annotated with + * {@code @CopilotTool}. Requires that the {@code CopilotToolProcessor} + * annotation processor ran at compile time (generating the + * {@code $$CopilotToolMeta} companion class). + * + * @param instance + * the object containing {@code @CopilotTool}-annotated methods + * @return list of tool definitions with working invocation handlers + * @throws IllegalStateException + * if the generated {@code $$CopilotToolMeta} class is not found + * (annotation processor did not run) + * @since 1.0.6 + */ + @CopilotExperimental + public static List fromObject(Object instance) { + if (instance == null) { + throw new IllegalArgumentException("instance must not be null"); + } + Class clazz = instance.getClass(); + return loadDefinitions(clazz, instance); + } + + /** + * Discovers tool definitions from a class with static + * {@code @CopilotTool}-annotated methods. Requires that the + * {@code CopilotToolProcessor} annotation processor ran at compile time + * (generating the {@code $$CopilotToolMeta} companion class). + * + * @param clazz + * the class containing static {@code @CopilotTool}-annotated methods + * @return list of tool definitions with working invocation handlers + * @throws IllegalStateException + * if the generated {@code $$CopilotToolMeta} class is not found + * (annotation processor did not run) + * @since 1.0.6 + */ + @CopilotExperimental + public static List fromClass(Class clazz) { + if (clazz == null) { + throw new IllegalArgumentException("clazz must not be null"); + } + List instanceMethods = Arrays.stream(clazz.getDeclaredMethods()) + .filter(m -> m.isAnnotationPresent(com.github.copilot.tool.CopilotTool.class)) + .filter(m -> !Modifier.isStatic(m.getModifiers())).map(Method::getName).collect(Collectors.toList()); + if (!instanceMethods.isEmpty()) { + throw new IllegalArgumentException( + "fromClass() requires all @CopilotTool methods to be static, but found instance methods: " + + instanceMethods + ". Use fromObject(new " + clazz.getSimpleName() + "()) instead."); + } + return loadDefinitions(clazz, null); + } + + // ------------------------------------------------------------------ + // Fluent copy-style modifier methods for lambda-defined tools + // ------------------------------------------------------------------ + + /** + * Returns a copy with the {@code overridesBuiltInTool} flag set. + * + * @param value + * {@code true} to indicate this tool intentionally overrides a + * built-in CLI tool with the same name + * @return a new {@code ToolDefinition} with the flag applied + * @since 1.0.6 + */ + @CopilotExperimental + public ToolDefinition overridesBuiltInTool(boolean value) { + return new ToolDefinition(name, description, parameters, handler, value, skipPermission, defer, metadata, + isTerminal); + } + + /** + * Returns a copy with the {@code skipPermission} flag set. + * + * @param value + * {@code true} to skip the permission request for this tool + * invocation + * @return a new {@code ToolDefinition} with the flag applied + * @since 1.0.6 + */ + @CopilotExperimental + public ToolDefinition skipPermission(boolean value) { + return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, value, defer, metadata, + isTerminal); + } + + /** + * Returns a copy with the {@code defer} mode set. + * + * @param value + * the deferral mode; use {@link ToolDefer#AUTO} to allow deferral or + * {@link ToolDefer#NEVER} to force the tool to always be pre-loaded + * @return a new {@code ToolDefinition} with the defer mode applied + * @since 1.0.6 + */ + @CopilotExperimental + public ToolDefinition defer(ToolDefer value) { + return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, skipPermission, value, + metadata, isTerminal); + } + + /** + * Returns a copy with the opaque {@code metadata} bag set. + * + * @param value + * the opaque, host-defined metadata; keys are namespaced and not + * part of the stable public API + * @return a new {@code ToolDefinition} with the metadata applied + * @since 1.0.7 + */ + @CopilotExperimental + public ToolDefinition metadata(Map value) { + return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, skipPermission, defer, + value, isTerminal); + } + + /** + * Returns a copy with the {@code isTerminal} flag set. + * + * @param value + * {@code true} to end the agent turn after a successful call to this + * tool + * @return a new {@code ToolDefinition} with the flag applied + * @since 1.0.11 + */ + @CopilotExperimental + public ToolDefinition isTerminal(boolean value) { + return new ToolDefinition(name, description, parameters, handler, overridesBuiltInTool, skipPermission, defer, + metadata, value); + } + + // ------------------------------------------------------------------ + // from(...) — sync, no ToolInvocation + // ------------------------------------------------------------------ + + /** + * Creates a tool definition with a zero-argument synchronous handler. + * + *

+ * The handler is a {@link Supplier} that returns the tool result. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition ping = ToolDefinition.from("ping", "Returns a simple pong response", () -> "pong");
+     * }
+ * + * @param + * the return type of the handler + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param handler + * the zero-argument sync handler + * @return a new tool definition + * @throws IllegalArgumentException + * if {@code name} or {@code description} is blank, or if + * {@code handler} is null + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition from(String name, String description, Supplier handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper); + ToolHandler toolHandler = invocation -> { + R result = handler.get(); + return CompletableFuture.completedFuture(formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a one-argument synchronous handler. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition greet = ToolDefinition.from("greet", "Greets a user by name",
+     * 		Param.of(String.class, "name", "The user's name"), name -> "Hello, " + name + "!");
+     * }
+ * + * @param + * the type of the first parameter + * @param + * the return type of the handler + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param handler + * the one-argument sync handler + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition from(String name, String description, Param p1, Function handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + R result = handler.apply(arg1); + return CompletableFuture.completedFuture(formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a two-argument synchronous handler. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition add = ToolDefinition.from("add", "Adds two integers", Param.of(Integer.class, "a", "First number"),
+     * 		Param.of(Integer.class, "b", "Second number"), (a, b) -> a + b);
+     * }
+ * + * @param + * the type of the first parameter + * @param + * the type of the second parameter + * @param + * the return type of the handler + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param p2 + * the second parameter descriptor + * @param handler + * the two-argument sync handler + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition from(String name, String description, Param p1, Param p2, + BiFunction handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1, p2); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + T2 arg2 = ParamCoercion.coerce(invocation.getArguments(), p2, mapper); + R result = handler.apply(arg1, arg2); + return CompletableFuture.completedFuture(formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + // ------------------------------------------------------------------ + // fromAsync(...) — async, no ToolInvocation + // ------------------------------------------------------------------ + + /** + * Creates a tool definition with a zero-argument asynchronous handler. + * + *

+ * The handler is a {@link Supplier} returning a {@link CompletableFuture}. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition ping = ToolDefinition.fromAsync("ping", "Returns a pong response asynchronously",
+     * 		() -> CompletableFuture.completedFuture("pong"));
+     * }
+ * + * @param + * the return type wrapped in {@link CompletableFuture} + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param handler + * the zero-argument async handler + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromAsync(String name, String description, + Supplier> handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper); + ToolHandler toolHandler = invocation -> { + CompletableFuture future = handler.get(); + if (future == null) { + return CompletableFuture.failedFuture( + new NullPointerException("Async handler for tool '" + name + "' returned a null future")); + } + return future.thenApply(result -> formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a one-argument asynchronous handler. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition greet = ToolDefinition.fromAsync("greet_async", "Greets a user by name asynchronously",
+     * 		Param.of(String.class, "name", "The user's name"),
+     * 		name -> CompletableFuture.completedFuture("Hello, " + name + "!"));
+     * }
+ * + * @param + * the type of the first parameter + * @param + * the return type wrapped in {@link CompletableFuture} + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param handler + * the one-argument async handler + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromAsync(String name, String description, Param p1, + Function> handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + CompletableFuture future = handler.apply(arg1); + if (future == null) { + return CompletableFuture.failedFuture( + new NullPointerException("Async handler for tool '" + name + "' returned a null future")); + } + return future.thenApply(result -> formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a two-argument asynchronous handler. + * + * @param + * the type of the first parameter + * @param + * the type of the second parameter + * @param + * the return type wrapped in {@link CompletableFuture} + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param p2 + * the second parameter descriptor + * @param handler + * the two-argument async handler + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromAsync(String name, String description, Param p1, Param p2, + BiFunction> handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1, p2); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + T2 arg2 = ParamCoercion.coerce(invocation.getArguments(), p2, mapper); + CompletableFuture future = handler.apply(arg1, arg2); + if (future == null) { + return CompletableFuture.failedFuture( + new NullPointerException("Async handler for tool '" + name + "' returned a null future")); + } + return future.thenApply(result -> formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + // ------------------------------------------------------------------ + // fromWithToolInvocation(...) — sync, with ToolInvocation context + // ------------------------------------------------------------------ + + /** + * Creates a tool definition with a zero-argument synchronous handler that + * receives the {@link ToolInvocation} context. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition sessionInfo = ToolDefinition.fromWithToolInvocation("session_info", "Return the current session id",
+     * 		invocation -> "sessionId=" + invocation.getSessionId());
+     * }
+ * + * @param + * the return type of the handler + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param handler + * a function accepting the {@link ToolInvocation} context + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromWithToolInvocation(String name, String description, + Function handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper); + ToolHandler toolHandler = invocation -> { + R result = handler.apply(invocation); + return CompletableFuture.completedFuture(formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a one-argument synchronous handler that also + * receives the {@link ToolInvocation} context. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition reportPhase = ToolDefinition.fromWithToolInvocation("report_phase",
+     * 		"Report the current phase along with invocation context", Param.of(String.class, "phase", "Current phase"),
+     * 		(phase, invocation) -> "phase=" + phase + ", toolCallId=" + invocation.getToolCallId());
+     * }
+ * + * @param + * the type of the first parameter + * @param + * the return type of the handler + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param handler + * a function accepting the typed argument and the + * {@link ToolInvocation} context + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromWithToolInvocation(String name, String description, Param p1, + BiFunction handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + R result = handler.apply(arg1, invocation); + return CompletableFuture.completedFuture(formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + // ------------------------------------------------------------------ + // fromAsyncWithToolInvocation(...) — async, with ToolInvocation context + // ------------------------------------------------------------------ + + /** + * Creates a tool definition with a zero-argument asynchronous handler that + * receives the {@link ToolInvocation} context. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition sessionInfo = ToolDefinition.fromAsyncWithToolInvocation("session_info_async",
+     * 		"Return the current session id asynchronously",
+     * 		invocation -> CompletableFuture.completedFuture("sessionId=" + invocation.getSessionId()));
+     * }
+ * + * @param + * the return type wrapped in {@link CompletableFuture} + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param handler + * a function accepting the {@link ToolInvocation} context, returning + * a {@link CompletableFuture} + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromAsyncWithToolInvocation(String name, String description, + Function> handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper); + ToolHandler toolHandler = invocation -> { + CompletableFuture future = handler.apply(invocation); + if (future == null) { + return CompletableFuture.failedFuture( + new NullPointerException("Async handler for tool '" + name + "' returned a null future")); + } + return future.thenApply(result -> formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + /** + * Creates a tool definition with a one-argument asynchronous handler that also + * receives the {@link ToolInvocation} context. + * + *

Example

+ * + * 
{@code
+     * ToolDefinition reportPhase = ToolDefinition.fromAsyncWithToolInvocation("report_phase_async",
+     * 		"Report the current phase with invocation context asynchronously",
+     * 		Param.of(String.class, "phase", "The current phase"), (phase, invocation) -> CompletableFuture
+     * 				.completedFuture("phase=" + phase + ", toolCallId=" + invocation.getToolCallId()));
+     * }
+ * + * @param + * the type of the first parameter + * @param + * the return type wrapped in {@link CompletableFuture} + * @param name + * the unique name of the tool (must not be blank) + * @param description + * a description of what the tool does (must not be blank) + * @param p1 + * the first parameter descriptor + * @param handler + * a function accepting the typed argument and the + * {@link ToolInvocation} context, returning a + * {@link CompletableFuture} + * @return a new tool definition + * @throws IllegalArgumentException + * if validation fails + * @since 1.0.6 + */ + @CopilotExperimental + public static ToolDefinition fromAsyncWithToolInvocation(String name, String description, Param p1, + BiFunction> handler) { + requireNonBlankToolName(name); + requireNonBlankDescription(description); + requireNonNullHandler(handler, name); + final ObjectMapper mapper = getConfiguredMapper(); + Map schema = ParamSchema.buildSchema(name, mapper, p1); + ToolHandler toolHandler = invocation -> { + T1 arg1 = ParamCoercion.coerce(invocation.getArguments(), p1, mapper); + CompletableFuture future = handler.apply(arg1, invocation); + if (future == null) { + return CompletableFuture.failedFuture( + new NullPointerException("Async handler for tool '" + name + "' returned a null future")); + } + return future.thenApply(result -> formatResult(result, mapper)); + }; + return new ToolDefinition(name, description, schema, toolHandler, null, null, null, null); + } + + // ------------------------------------------------------------------ + // Internal helpers: result formatting, validation + // ------------------------------------------------------------------ + + /** + * Formats a handler return value according to the tool result contract: + *
    + *
  • {@link String} — returned as-is
    • + *
  • {@code null} — mapped to {@code "Success"} (covers handlers that return + * null to indicate a successful no-value result)
    • + *
  • any other value — JSON-serialized via {@link ObjectMapper}
    • + *
+ */ + private static Object formatResult(Object result, ObjectMapper mapper) { + if (result == null) { + return "Success"; + } + if (result instanceof String) { + return result; + } + if (result instanceof ToolResultObject) { + return result; + } + try { + return mapper.writeValueAsString(result); + } catch (com.fasterxml.jackson.core.JsonProcessingException ex) { + throw new IllegalStateException("Failed to serialize tool result to JSON", ex); + } + } + + // ------------------------------------------------------------------ + // Validation helpers + // ------------------------------------------------------------------ + + private static void requireNonBlankToolName(String name) { + if (name == null || name.isBlank()) { + throw new IllegalArgumentException("Tool name must not be null or blank"); + } + } + + private static void requireNonBlankDescription(String description) { + if (description == null || description.isBlank()) { + throw new IllegalArgumentException("Tool description must not be null or blank"); + } + } + + private static void requireNonNullHandler(Object handler, String toolName) { + if (handler == null) { + throw new IllegalArgumentException("handler must not be null for tool '" + toolName + "'"); + } + } + + @SuppressWarnings("unchecked") + private static List loadDefinitions(Class clazz, Object instance) { + String metaClassName = clazz.getName() + "$$CopilotToolMeta"; + try { + Class metaClass = Class.forName(metaClassName, true, clazz.getClassLoader()); + var provider = (com.github.copilot.tool.CopilotToolMetadataProvider) metaClass + .getDeclaredConstructor().newInstance(); + return provider.definitions(instance, getConfiguredMapper()); + } catch (ClassNotFoundException e) { + throw new IllegalStateException("Generated class " + metaClassName + " not found. " + + "Ensure the CopilotToolProcessor annotation processor ran during compilation. " + + "Add the copilot-sdk-java dependency to your annotation processor path.", e); + } catch (ReflectiveOperationException e) { + throw new IllegalStateException("Failed to invoke " + metaClassName + ".definitions()", e); + } + } + + /** + * Returns the SDK-configured ObjectMapper for tool argument/result + * serialization. Configuration mirrors + * {@code JsonRpcClient.createObjectMapper()}. + */ + private static ObjectMapper getConfiguredMapper() { + return ConfiguredMapperHolder.INSTANCE; + } + + /** + * Lazy holder for the configured ObjectMapper (thread-safe, initialized on + * first access). + */ + private static final class ConfiguredMapperHolder { + static final ObjectMapper INSTANCE = createMapper(); + + private static ObjectMapper createMapper() { + // Configuration must match JsonRpcClient.createObjectMapper() + var mapper = new ObjectMapper(); + mapper.registerModule(new JavaTimeModule()); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); + mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL); + return mapper; + } + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/ToolHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/ToolInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolInvocation.java similarity index 75% rename from java/src/main/java/com/github/copilot/rpc/ToolInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolInvocation.java index dddfdd06f..efe24fd6a 100644 --- a/java/src/main/java/com/github/copilot/rpc/ToolInvocation.java +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolInvocation.java @@ -4,6 +4,7 @@ package com.github.copilot.rpc; +import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonInclude; @@ -11,6 +12,7 @@ import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.CurrentToolMetadata; /** * Represents a tool invocation request from the AI assistant. @@ -18,6 +20,12 @@ * When the assistant invokes a tool, this object contains the context including * the session ID, tool call ID, tool name, and arguments parsed from the * assistant's request. + *

+ * In annotation-based tools, methods annotated with + * {@link com.github.copilot.tool.CopilotTool} may declare a + * {@code ToolInvocation} parameter in any position (before, between, or after + * schema-visible parameters). It is always injected as runtime context and is + * never included in the tool's JSON schema. * * @see ToolHandler * @see ToolDefinition @@ -34,6 +42,7 @@ public final class ToolInvocation { private String toolCallId; private String toolName; private JsonNode argumentsNode; + private List availableTools; /** * Gets the session ID where the tool was invoked. @@ -168,4 +177,35 @@ public ToolInvocation setArguments(JsonNode arguments) { this.argumentsNode = arguments; return this; } + + /** + * Gets a snapshot of the session's currently initialized tools. + *

+ * The SDK populates this only when the invocation targets the built-in + * tool-search tool ({@code "tool_search_tool"}), so a tool-search override can + * rank or filter the live catalog — including MCP tools configured in settings + * — without issuing its own RPC. It is {@code null} for every other tool + * invocation. + * + * @return the available tools snapshot, or {@code null} if not applicable + * @since 1.0.7 + */ + public List getAvailableTools() { + return availableTools; + } + + /** + * Sets the available tools snapshot. + *

+ * Note: This method is intended for internal SDK use. Users + * typically do not need to call this method directly. + * + * @param availableTools + * the available tools snapshot + * @return this invocation for method chaining + */ + public ToolInvocation setAvailableTools(List availableTools) { + this.availableTools = availableTools; + return this; + } } diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ToolResultObject.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolResultObject.java new file mode 100644 index 000000000..2e101acbd --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolResultObject.java @@ -0,0 +1,139 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.List; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Result object returned from a tool execution. + *

+ * This record represents the structured result of a tool invocation, including + * text output, binary data, error information, and telemetry. + * + *

Example: Success Result

+ * + * 
{@code
+ * return ToolResultObject.success("File contents: " + content);
+ * }
+ * + *

Example: Error Result

+ * + * 
{@code
+ * return ToolResultObject.error("File not found: " + path);
+ * }
+ * + *

Example: Custom Result

+ * + * 
{@code
+ * return new ToolResultObject("success", "Result text", null, null, null, null, null);
+ * }
+ * + * @param resultType + * the result type ("success" or "error"), defaults to "success" + * @param textResultForLlm + * the text result to be sent to the LLM + * @param binaryResultsForLlm + * the list of binary results to be sent to the LLM + * @param error + * the error message, or {@code null} if successful + * @param sessionLog + * the session log text + * @param toolTelemetry + * the tool telemetry data + * @param toolReferences + * names of tools returned by a tool-search tool + * @see ToolHandler + * @see ToolBinaryResult + * @since 1.0.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public record ToolResultObject(@JsonProperty("resultType") String resultType, + @JsonProperty("textResultForLlm") String textResultForLlm, + @JsonProperty("binaryResultsForLlm") List binaryResultsForLlm, + @JsonProperty("error") String error, @JsonProperty("sessionLog") String sessionLog, + @JsonProperty("toolTelemetry") Map toolTelemetry, + @JsonProperty("toolReferences") List toolReferences) { + + /** + * Creates a result without tool references. + *

+ * Provided for source and binary compatibility with callers written or compiled + * before the {@code toolReferences} component was added. Delegates to the + * canonical constructor with {@code toolReferences} set to {@code null}. + * + * @param resultType + * the result type ("success" or "error"), defaults to "success" + * @param textResultForLlm + * the text result to be sent to the LLM + * @param binaryResultsForLlm + * the list of binary results to be sent to the LLM + * @param error + * the error message, or {@code null} if successful + * @param sessionLog + * the session log text + * @param toolTelemetry + * the tool telemetry data + */ + public ToolResultObject(String resultType, String textResultForLlm, List binaryResultsForLlm, + String error, String sessionLog, Map toolTelemetry) { + this(resultType, textResultForLlm, binaryResultsForLlm, error, sessionLog, toolTelemetry, null); + } + + /** + * Creates a success result with the given text. + * + * @param textResultForLlm + * the text result to be sent to the LLM + * @return a success result + */ + public static ToolResultObject success(String textResultForLlm) { + return new ToolResultObject("success", textResultForLlm, null, null, null, null, null); + } + + /** + * Creates an error result with the given error message. + * + * @param error + * the error message + * @return an error result + */ + public static ToolResultObject error(String error) { + return new ToolResultObject("error", null, null, error, null, null, null); + } + + /** + * Creates an error result with both a text result and error message. + * + * @param textResultForLlm + * the text result to be sent to the LLM + * @param error + * the error message + * @return an error result + */ + public static ToolResultObject error(String textResultForLlm, String error) { + return new ToolResultObject("error", textResultForLlm, null, error, null, null, null); + } + + /** + * Creates a failure result with the given text and error message. + *

+ * The "failure" result type indicates that the tool execution itself failed + * (e.g., tool not found), while "error" indicates the tool executed but + * encountered an error during processing. + * + * @param textResultForLlm + * the text result to be sent to the LLM + * @param error + * the error message + * @return a failure result + */ + public static ToolResultObject failure(String textResultForLlm, String error) { + return new ToolResultObject("failure", textResultForLlm, null, error, null, null, null); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java new file mode 100644 index 000000000..dd27ddf86 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/ToolSearchConfig.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. + */ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Overrides the runtime's built-in tool-search behavior. + *

+ * Tool search defers tools to keep the model's active tool set small. To + * override the tool-search tool's implementation, register a tool named + * {@code "tool_search_tool"} with {@code overridesBuiltInTool} set to + * {@code true}. + * + * @since 1.3.0 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class ToolSearchConfig { + + @JsonProperty("enabled") + private Boolean enabled; + + @JsonProperty("deferThreshold") + private Integer deferThreshold; + + /** + * Gets whether tool search is enabled. + * + * @return {@code true} if enabled, {@code false} if disabled, or {@code null} + * for the runtime default + */ + public Boolean getEnabled() { + return enabled; + } + + /** + * Toggle that enables or disables tool search. + * + * @param enabled + * {@code true} to enable, {@code false} to disable + * @return this config for method chaining + */ + public ToolSearchConfig setEnabled(Boolean enabled) { + this.enabled = enabled; + return this; + } + + /** + * Gets the tool count above which MCP and external tools are deferred behind + * tool search. + * + * @return the defer threshold, or {@code null} for the runtime default (30) + */ + public Integer getDeferThreshold() { + return deferThreshold; + } + + /** + * Sets the tool count above which MCP and external tools are deferred behind + * tool search. Defaults to the runtime default (30) when unset. + * + * @param deferThreshold + * the threshold value + * @return this config for method chaining + */ + public ToolSearchConfig setDeferThreshold(Integer deferThreshold) { + this.deferThreshold = deferThreshold; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/ToolSet.java b/java/sdk/src/main/java/com/github/copilot/rpc/ToolSet.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/ToolSet.java rename to java/sdk/src/main/java/com/github/copilot/rpc/ToolSet.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/UriRuntimeConnection.java b/java/sdk/src/main/java/com/github/copilot/rpc/UriRuntimeConnection.java new file mode 100644 index 000000000..c26098584 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/UriRuntimeConnection.java @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.github.copilot.CopilotExperimental; + +/** + * Connects to an already-running runtime at the configured URL. Construct with + * {@link RuntimeConnection#forUri(String)}. + * + * @since 1.0.0 + */ +@CopilotExperimental +public final class UriRuntimeConnection extends RuntimeConnection { + + private final String url; + private String connectionToken; + + UriRuntimeConnection(String url) { + if (url == null || url.isEmpty()) { + throw new IllegalArgumentException("UriRuntimeConnection url must be a non-empty string"); + } + this.url = url; + } + + /** + * Returns the URL of the runtime to connect to. + * + * @return the URL; accepts {@code "port"}, {@code "host:port"}, or a full URL + */ + public String getUrl() { + return url; + } + + /** + * Returns the shared secret used to authenticate the connection. + * + * @return the token, or {@code null} if the runtime does not require one + */ + public String getConnectionToken() { + return connectionToken; + } + + /** + * Sets the shared secret used to authenticate the connection. + * + * @param connectionToken + * the token, or {@code null} if the runtime does not require one + * @return this instance for method chaining + */ + public UriRuntimeConnection setConnectionToken(String connectionToken) { + this.connectionToken = connectionToken; + return this; + } +} diff --git a/java/src/main/java/com/github/copilot/rpc/UserInputHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserInputHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserInputHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserInputHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserInputInvocation.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserInputInvocation.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserInputInvocation.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserInputInvocation.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserInputRequest.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserInputRequest.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserInputRequest.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserInputRequest.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserInputResponse.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserInputResponse.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserInputResponse.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserInputResponse.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHandler.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHandler.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHandler.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookInput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookInput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookInput.java diff --git a/java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookOutput.java similarity index 100% rename from java/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookOutput.java rename to java/sdk/src/main/java/com/github/copilot/rpc/UserPromptSubmittedHookOutput.java diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHandler.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHandler.java new file mode 100644 index 000000000..ac8496078 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHandler.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import java.util.concurrent.CompletableFuture; + +/** + * Handler for user-prompt-transformed hooks. + * + * @since 1.0.11 + */ +@FunctionalInterface +public interface UserPromptTransformedHandler { + + /** + * Handles a transformed user prompt before it is stored or sent to the model. + * + * @param input + * the hook input + * @param invocation + * metadata about the hook invocation + * @return a future resolving to the hook output, or {@code null} + */ + CompletableFuture handle(UserPromptTransformedHookInput input, + HookInvocation invocation); +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookInput.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookInput.java new file mode 100644 index 000000000..ea1759658 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookInput.java @@ -0,0 +1,29 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Input for user-prompt-transformed hooks. + * + * @param sessionId + * the runtime session ID + * @param timestamp + * Unix timestamp in milliseconds + * @param cwd + * the current working directory + * @param prompt + * the prompt after user-prompt-submitted hooks + * @param transformedPrompt + * the model-facing prompt after runtime transformations + * @since 1.0.11 + */ +@JsonIgnoreProperties(ignoreUnknown = true) +public record UserPromptTransformedHookInput(@JsonProperty("sessionId") String sessionId, + @JsonProperty("timestamp") long timestamp, @JsonProperty("cwd") String cwd, + @JsonProperty("prompt") String prompt, @JsonProperty("transformedPrompt") String transformedPrompt) { +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookOutput.java b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookOutput.java new file mode 100644 index 000000000..615f4ea7b --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/UserPromptTransformedHookOutput.java @@ -0,0 +1,20 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Output for user-prompt-transformed hooks. + * + * @param modifiedTransformedPrompt + * replacement model-facing prompt to persist and send to the model + * @since 1.0.11 + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public record UserPromptTransformedHookOutput( + @JsonProperty("modifiedTransformedPrompt") String modifiedTransformedPrompt) { +} diff --git a/java/sdk/src/main/java/com/github/copilot/rpc/package-info.java b/java/sdk/src/main/java/com/github/copilot/rpc/package-info.java new file mode 100644 index 000000000..83772cd04 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/rpc/package-info.java @@ -0,0 +1,95 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * Configuration classes and data transfer objects for the Copilot SDK. + * + *

+ * This package contains all the configuration, request, response, and data + * transfer objects used throughout the SDK. These classes are designed for JSON + * serialization with Jackson and provide fluent setter methods for convenient + * configuration. + * + *

Client Configuration

+ *
    + *
  • {@link com.github.copilot.rpc.CopilotClientOptions} - Options for + * configuring the {@link com.github.copilot.CopilotClient}, including CLI path, + * port, transport mode, and auto-start behavior.
    • + *
+ * + *

Session Configuration

+ *
    + *
  • {@link com.github.copilot.rpc.SessionConfig} - Configuration for creating + * a new session, including model selection, tools, system message, and MCP + * server configuration.
    • + *
  • {@link com.github.copilot.rpc.ResumeSessionConfig} - Configuration for + * resuming an existing session.
    • + *
  • {@link com.github.copilot.rpc.InfiniteSessionConfig} - Configuration for + * infinite sessions with automatic context compaction.
    • + *
  • {@link com.github.copilot.rpc.SystemMessageConfig} - System message + * customization options.
    • + *
+ * + *

Message and Tool Configuration

+ *
    + *
  • {@link com.github.copilot.rpc.MessageOptions} - Options for sending + * messages, including prompt text and attachments.
    • + *
  • {@link com.github.copilot.rpc.ToolDefinition} - Definition of a custom + * tool that can be invoked by the assistant.
    • + *
  • {@link com.github.copilot.rpc.ToolInvocation} - Represents a tool + * invocation request from the assistant.
    • + *
  • {@link com.github.copilot.rpc.Attachment} - File attachment for + * messages.
    • + *
+ * + *

Provider Configuration (BYOK)

+ *
    + *
  • {@link com.github.copilot.rpc.ProviderConfig} - Configuration for using + * your own API keys with custom providers (OpenAI, Azure, etc.).
    • + *
  • {@link com.github.copilot.rpc.AzureOptions} - Azure-specific + * configuration options.
    • + *
+ * + *

Model Information

+ *
    + *
  • {@link com.github.copilot.rpc.ModelInfo} - Information about an available + * AI model.
    • + *
  • {@link com.github.copilot.rpc.ModelCapabilities} - Model capabilities and + * limits.
    • + *
  • {@link com.github.copilot.rpc.ModelPolicy} - Model policy and state + * information.
    • + *
+ * + *

Custom Agents

+ *
    + *
  • {@link com.github.copilot.rpc.CustomAgentConfig} - Configuration for + * custom agents with specialized behaviors and tools.
    • + *
+ * + *

Permissions

+ *
    + *
  • {@link com.github.copilot.rpc.PermissionHandler} - Handler for permission + * requests from the assistant.
    • + *
  • {@link com.github.copilot.rpc.PermissionRequest} - A permission request + * from the assistant.
    • + *
  • {@link com.github.copilot.rpc.PermissionRequestResult} - Result of a + * permission request decision.
    • + *
+ * + *

Usage Example

+ * + * 
{@code
+ * var config = new SessionConfig().setModel("gpt-5.4").setStreaming(true)
+ * 		.setSystemMessage(new SystemMessageConfig().setMode(SystemMessageMode.APPEND)
+ * 				.setContent("Be concise in your responses."))
+ * 		.setTools(List.of(ToolDefinition.create("my_tool", "Description", schema, handler)));
+ *
+ * var session = client.createSession(config).get();
+ * }
+ * + * @see com.github.copilot.CopilotClient + * @see com.github.copilot.CopilotSession + */ +@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "DTOs for JSON deserialization - low risk") +package com.github.copilot.rpc; diff --git a/java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java new file mode 100644 index 000000000..28cd75928 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotTool.java @@ -0,0 +1,139 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import com.github.copilot.CopilotExperimental; +import com.github.copilot.rpc.ToolDefer; + +/** + * Marks a method as a Copilot tool. The annotated method will be exposed to the + * model as a callable tool during a session. + * + *

+ * Example usage: + * + * 

+ * @CopilotTool("Get weather for a location")
+ * public CompletableFuture<String> getWeather(
+ * 		@CopilotToolParam(value = "City name", required = true) String location) {
+ * 	return CompletableFuture.completedFuture("Sunny in " + location);
+ * }
+ *
+ * + * @since 1.0.2 + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@CopilotExperimental +public @interface CopilotTool { + + /** Tool description (sent to the model). */ + String value(); + + /** Tool name. Defaults to method name converted to snake_case. */ + String name() default ""; + + /** Whether this tool overrides a built-in tool. */ + boolean overridesBuiltInTool() default false; + + /** Whether to skip permission checks. */ + boolean skipPermission() default false; + + /** Whether a successful call to this tool ends the agent turn. */ + boolean isTerminal() default false; + + /** Defer configuration for this tool. */ + ToolDefer defer() default ToolDefer.NONE; + + /** + * Opaque, host-defined metadata for this tool. Keys are namespaced and not part + * of the stable public API; specific keys may be recognized to inform + * host-specific behavior. + * + *

+ * Because annotation members cannot express arbitrary maps, this uses a + * deliberately shallow representation: each {@link MetadataEntry} maps a string + * key to a single {@link MetadataValue} that is either a boolean, a string, or + * a one-level map of named boolean {@link MetadataFlag flags}. Numbers, arrays, + * and deeper nesting are not supported here; use the programmatic + * {@code ToolDefinition.createWithMetadata(...)} / + * {@code ToolDefinition.metadata(...)} API for richer values. + * + *

+ * Example emitted shape: + * + * 

+     * Map.of("github.com/copilot:safeForTelemetry", Map.of("name", true, "inputsNames", false))
+     *
+ */ + MetadataEntry[] metadata() default {}; + + /** + * A single metadata key/value pair. Used only as a member value of + * {@link CopilotTool#metadata()}. + */ + @Documented + @Retention(RetentionPolicy.RUNTIME) + @Target({}) + @interface MetadataEntry { + + /** The namespaced metadata key. */ + String key(); + + /** The value associated with {@link #key()}. */ + MetadataValue value(); + } + + /** + * A metadata value. Exactly one representation is intended per value: a map of + * named boolean {@link #flags()} (when non-empty), otherwise a {@link #str()} + * (when non-empty), otherwise a {@link #bool()}. + */ + @Documented + @Retention(RetentionPolicy.RUNTIME) + @Target({}) + @interface MetadataValue { + + /** + * Scalar boolean value. Used when {@link #flags()} and {@link #str()} are + * unset. + */ + boolean bool() default false; + + /** + * Scalar string value. Used when {@link #flags()} is empty and this is + * non-empty. + */ + String str() default ""; + + /** + * Object-like value: a one-level map of named boolean flags. Takes precedence + * when non-empty. + */ + MetadataFlag[] flags() default {}; + } + + /** + * A single named boolean flag within a {@link MetadataValue#flags()} map. + */ + @Documented + @Retention(RetentionPolicy.RUNTIME) + @Target({}) + @interface MetadataFlag { + + /** The flag name (map key). */ + String name(); + + /** The flag value. */ + boolean value(); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java new file mode 100644 index 000000000..25194626e --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolMetadataProvider.java @@ -0,0 +1,42 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.util.List; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.CopilotExperimental; +import com.github.copilot.rpc.ToolDefinition; + +/** + * Contract for classes that provide {@link ToolDefinition} metadata for + * {@code @CopilotTool}-annotated methods. + * + *

+ * The {@link CopilotToolProcessor} annotation processor generates an + * implementation of this interface as a {@code $$CopilotToolMeta} companion + * class. Users may also implement this interface directly for full manual + * control over tool registration without using annotation processing. + * + * @param + * the tool class whose methods are described by this provider + * @since 1.0.2 + */ +@CopilotExperimental +public interface CopilotToolMetadataProvider { + + /** + * Returns tool definitions for the given instance. + * + * @param instance + * the object containing tool methods, or {@code null} for static + * methods + * @param mapper + * the SDK-configured {@link ObjectMapper} for argument + * deserialization + * @return list of tool definitions with working invocation handlers + */ + List definitions(T instance, ObjectMapper mapper); +} diff --git a/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolParam.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolParam.java new file mode 100644 index 000000000..144ea2e61 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolParam.java @@ -0,0 +1,68 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import com.github.copilot.CopilotExperimental; + +/** + * Annotates a parameter of a {@link CopilotTool}-annotated method to provide + * metadata about the parameter that is sent to the model. + * + *

+ * Example usage: + * + * 

+ * @CopilotTool("Search for issues")
+ * public CompletableFuture<String> searchIssues(
+ * 		@CopilotToolParam(value = "Search query", required = true) String query,
+ * 		@CopilotToolParam(value = "Max results", required = false, defaultValue = "10") int limit) {
+ * 	// ...
+ * }
+ *
+ * + * @since 1.0.2 + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.PARAMETER) +@CopilotExperimental +public @interface CopilotToolParam { + + /** Parameter description (sent to the model). */ + String value() default ""; + + /** Parameter name override. Defaults to the actual parameter name. */ + String name() default ""; + + /** Whether this parameter is required. Default true. */ + boolean required() default true; + + /** Optional default value when the argument is omitted. */ + String defaultValue() default ""; + + /** + * Optional explicit JSON Schema for this parameter as a JSON string literal. + * When non-empty, bypasses automatic schema generation from the parameter type. + * The value must be a valid JSON object string. + * + *

+ * Example: + * + * 

+     * @CopilotTool("Schedule meeting")
+     * public String schedule(
+     * 		@CopilotToolParam(value = "When to meet", schema = "{\"type\":\"string\",\"format\":\"date-time\"}") MyCustomDateTime when) {
+     * 	// ...
+     * }
+     *
+ */ + String schema() default ""; +} diff --git a/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java new file mode 100644 index 000000000..f88c1ac7c --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/CopilotToolProcessor.java @@ -0,0 +1,1218 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.io.IOException; +import java.io.PrintWriter; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.RoundEnvironment; +import javax.annotation.processing.SupportedAnnotationTypes; +import javax.annotation.processing.SupportedSourceVersion; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.Element; +import javax.lang.model.element.ElementKind; +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.Modifier; +import javax.lang.model.element.TypeElement; +import javax.lang.model.element.VariableElement; +import javax.lang.model.type.DeclaredType; +import javax.lang.model.type.TypeKind; +import javax.lang.model.type.TypeMirror; +import javax.tools.Diagnostic; +import javax.tools.JavaFileObject; + +import com.github.copilot.CopilotExperimental; + +/** + * JSR 269 annotation processor that finds {@link CopilotTool}-annotated methods + * and generates {@code $$CopilotToolMeta} companion classes containing tool + * definitions, JSON Schema, and invocation lambdas. + * + *

+ * For a class {@code com.example.MyTools} containing {@code @CopilotTool} + * methods, this processor generates + * {@code com.example.MyTools$$CopilotToolMeta} in the same package. + * + * @since 1.0.2 + */ +@SupportedAnnotationTypes("com.github.copilot.tool.CopilotTool") +@SupportedSourceVersion(SourceVersion.RELEASE_17) +@CopilotExperimental +public class CopilotToolProcessor extends AbstractProcessor { + + private static final String TOOL_INVOCATION_TYPE = "com.github.copilot.rpc.ToolInvocation"; + + private final SchemaGenerator schemaGenerator = new SchemaGenerator(); + + @Override + public boolean process(Set annotations, RoundEnvironment roundEnv) { + List annotatedElements = getCopilotToolAnnotatedElements(roundEnv); + for (Element element : annotatedElements) { + if (element.getKind() != ElementKind.METHOD) { + continue; + } + ExecutableElement method = (ExecutableElement) element; + + // Validate: private methods are not allowed + if (method.getModifiers().contains(Modifier.PRIVATE)) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotTool methods must not be private", method); + continue; + } + + // Validate @CopilotToolParam conflicts + int toolInvocationParamCount = 0; + for (VariableElement param : method.getParameters()) { + if (isToolInvocationType(param.asType())) { + toolInvocationParamCount++; + if (param.getAnnotation(CopilotToolParam.class) != null) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam is not supported on ToolInvocation parameters because ToolInvocation is injected runtime context and not part of the tool schema", + param); + } + continue; + } + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null && paramAnnotation.required() + && !paramAnnotation.defaultValue().isEmpty()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam cannot have both required=true and a non-empty defaultValue", param); + } + if (paramAnnotation != null && !paramAnnotation.defaultValue().isEmpty()) { + String defaultValidationError = validateDefaultValueCompatibility(param.asType(), + paramAnnotation.defaultValue()); + if (defaultValidationError != null) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, defaultValidationError, param); + } + } + if (paramAnnotation != null && !paramAnnotation.required() && paramAnnotation.defaultValue().isEmpty() + && param.asType().getKind().isPrimitive()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam(required=false) primitive parameters must provide defaultValue or use a boxed/Optional type", + param); + } + if (paramAnnotation != null && !paramAnnotation.schema().isEmpty() + && !paramAnnotation.defaultValue().isEmpty()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam cannot have both schema and defaultValue — express defaults inside the schema if needed", + param); + } + if (paramAnnotation != null && !paramAnnotation.schema().isEmpty()) { + String schemaJson = paramAnnotation.schema().trim(); + if (!schemaJson.startsWith("{") || !schemaJson.endsWith("}")) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam schema must be a valid JSON object string (must start with '{' and end with '}')", + param); + } + } + } + if (toolInvocationParamCount > 1) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotTool methods may declare at most one ToolInvocation parameter; ToolInvocation is injected runtime context and not part of the tool schema", + method); + } + + // Validate single-record wrapper parameter metadata + List schemaParameters = getSchemaParameters(method.getParameters()); + if (schemaParameters.size() == 1) { + VariableElement singleParam = schemaParameters.get(0); + if (isRecord(singleParam.asType())) { + CopilotToolParam paramAnnotation = singleParam.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null) { + if (!paramAnnotation.defaultValue().isEmpty()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam(defaultValue=...) is not supported on single-record tool parameters; use record component defaults or a non-record parameter", + singleParam); + } + if (!paramAnnotation.schema().isEmpty()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam(schema=...) is not supported on single-record tool parameters", + singleParam); + } + if (!paramAnnotation.name().isEmpty() || !paramAnnotation.value().isEmpty() + || !paramAnnotation.required()) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam name/value/required are not supported on single-record tool parameters; annotate record components instead", + singleParam); + } + } + } + } + + // Validate blank @CopilotToolParam descriptions (exempt single-record wrappers) + boolean isSingleRecordWrapper = schemaParameters.size() == 1 && isRecord(schemaParameters.get(0).asType()); + for (VariableElement param : schemaParameters) { + if (isSingleRecordWrapper && param.equals(schemaParameters.get(0))) { + continue; + } + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null && paramAnnotation.value().isBlank()) { + TypeElement enclosingClass = (TypeElement) method.getEnclosingElement(); + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam on parameter '" + param.getSimpleName() + "' in '" + + enclosingClass.getSimpleName() + "." + method.getSimpleName() + + "' has a blank value (description). " + + "Descriptions are required so the LLM can correctly select and invoke the tool", + param); + } + } + } + + // Group methods by enclosing type + Map> methodsByClass = new LinkedHashMap<>(); + for (Element element : annotatedElements) { + if (element.getKind() != ElementKind.METHOD) { + continue; + } + ExecutableElement method = (ExecutableElement) element; + if (method.getModifiers().contains(Modifier.PRIVATE)) { + continue; + } + TypeElement enclosingType = (TypeElement) method.getEnclosingElement(); + methodsByClass.computeIfAbsent(enclosingType, k -> new ArrayList<>()).add(method); + } + + // Generate $$CopilotToolMeta for each class + for (Map.Entry> entry : methodsByClass.entrySet()) { + generateMetaClass(entry.getKey(), entry.getValue()); + } + + return false; + } + + private List getCopilotToolAnnotatedElements(RoundEnvironment roundEnv) { + TypeElement copilotToolType = processingEnv.getElementUtils() + .getTypeElement("com.github.copilot.tool.CopilotTool"); + if (copilotToolType != null) { + return new ArrayList<>(roundEnv.getElementsAnnotatedWith(copilotToolType)); + } + return new ArrayList<>(roundEnv.getElementsAnnotatedWith(CopilotTool.class)); + } + + private void generateMetaClass(TypeElement classElement, List methods) { + String packageName = processingEnv.getElementUtils().getPackageOf(classElement).getQualifiedName().toString(); + String simpleClassName = classElement.getSimpleName().toString(); + String metaClassName = simpleClassName + "$$CopilotToolMeta"; + String qualifiedMetaClassName = packageName.isEmpty() ? metaClassName : packageName + "." + metaClassName; + + try { + JavaFileObject sourceFile = processingEnv.getFiler().createSourceFile(qualifiedMetaClassName, classElement); + try (PrintWriter out = new PrintWriter(sourceFile.openWriter())) { + writeMetaClass(out, packageName, simpleClassName, metaClassName, methods); + } + } catch (IOException e) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "Failed to generate " + metaClassName + ": " + e.getMessage(), classElement); + } + } + + private void writeMetaClass(PrintWriter out, String packageName, String simpleClassName, String metaClassName, + List methods) { + out.println("// GENERATED by CopilotToolProcessor — do not edit"); + + if (!packageName.isEmpty()) { + out.println("package " + packageName + ";"); + out.println(); + } + + out.println("import com.github.copilot.rpc.ToolDefinition;"); + out.println("import com.github.copilot.rpc.ToolDefer;"); + out.println("import com.github.copilot.tool.CopilotToolMetadataProvider;"); + out.println("import com.fasterxml.jackson.databind.ObjectMapper;"); + out.println("import java.util.*;"); + out.println("import java.util.concurrent.CompletableFuture;"); + out.println(); + + out.println("public final class " + metaClassName + " implements CopilotToolMetadataProvider<" + simpleClassName + + "> {"); + out.println(); + + // Helper method for adding description/default to schema maps + if (needsWithMetaHelper(methods)) { + out.println( + " private static Map withMeta(Map base, String description, Object defaultValue) {"); + out.println(" var result = new LinkedHashMap(base);"); + out.println(" if (description != null) result.put(\"description\", description);"); + out.println(" if (defaultValue != null) result.put(\"default\", defaultValue);"); + out.println(" return Collections.unmodifiableMap(result);"); + out.println(" }"); + out.println(); + } + + if (needsJsonSourceHelpers(methods)) { + out.println(" private static Map mapOfNullable(Object... entries) {"); + out.println(" var result = new LinkedHashMap();"); + out.println(" for (int i = 0; i < entries.length; i += 2) {"); + out.println(" result.put((String) entries[i], entries[i + 1]);"); + out.println(" }"); + out.println(" return Collections.unmodifiableMap(result);"); + out.println(" }"); + out.println(); + out.println(" private static List listOfNullable(Object... items) {"); + out.println(" return Collections.unmodifiableList(Arrays.asList(items));"); + out.println(" }"); + out.println(); + } + + // definitions method + out.println(" @Override"); + out.println(" @SuppressWarnings({\"unchecked\", \"rawtypes\"})"); + out.println( + " public List definitions(" + simpleClassName + " instance, ObjectMapper mapper) {"); + out.println(" return List.of("); + + for (int i = 0; i < methods.size(); i++) { + ExecutableElement method = methods.get(i); + writeToolDefinition(out, method); + if (i < methods.size() - 1) { + out.println(","); + } else { + out.println(); + } + } + + out.println(" );"); + out.println(" }"); + out.println("}"); + } + + private boolean needsWithMetaHelper(List methods) { + for (ExecutableElement method : methods) { + for (VariableElement param : method.getParameters()) { + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null + && (!paramAnnotation.value().isEmpty() || !paramAnnotation.defaultValue().isEmpty())) { + return true; + } + } + } + return false; + } + + private boolean needsJsonSourceHelpers(List methods) { + for (ExecutableElement method : methods) { + for (VariableElement param : method.getParameters()) { + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null && !paramAnnotation.schema().isEmpty()) { + return true; + } + } + } + return false; + } + + private void writeToolDefinition(PrintWriter out, ExecutableElement method) { + CopilotTool annotation = method.getAnnotation(CopilotTool.class); + String toolName = annotation.name().isEmpty() + ? toSnakeCase(method.getSimpleName().toString()) + : annotation.name(); + String description = annotation.value(); + boolean overridesBuiltIn = annotation.overridesBuiltInTool(); + boolean skipPermission = annotation.skipPermission(); + boolean isTerminal = annotation.isTerminal(); + com.github.copilot.rpc.ToolDefer defer = annotation.defer(); + + // Generate schema with @CopilotToolParam metadata (descriptions, names, + // defaults) + String schemaSource = generateSchemaWithParamMetadata(method.getParameters()); + + // Generate invocation lambda + String lambdaBody = generateLambdaBody(method); + + // Use the record constructor directly so all flags apply independently + String overridesArg = overridesBuiltIn ? "Boolean.TRUE" : "null"; + String skipPermArg = skipPermission ? "Boolean.TRUE" : "null"; + String isTerminalArg = isTerminal ? "Boolean.TRUE" : "null"; + String deferArg = defer != com.github.copilot.rpc.ToolDefer.NONE ? "ToolDefer." + defer.name() : "null"; + + out.println(" new ToolDefinition("); + out.println(" \"" + escapeJava(toolName) + "\","); + out.println(" \"" + escapeJava(description) + "\","); + out.println(" " + schemaSource + ","); + out.println(" invocation -> {"); + out.println(" " + lambdaBody); + out.println(" },"); + out.println(" " + overridesArg + ","); + out.println(" " + skipPermArg + ","); + out.println(" " + deferArg + ","); + out.println(" " + metadataSource(annotation) + ","); + out.println(" " + isTerminalArg); + out.print(" )"); + } + + /** + * Converts the {@code @CopilotTool(metadata = ...)} entries into a Java source + * literal. Returns {@code "null"} when no metadata is present, otherwise a + * {@code Map.of(...)} expression. + */ + private String metadataSource(CopilotTool annotation) { + CopilotTool.MetadataEntry[] entries = annotation.metadata(); + if (entries.length == 0) { + return "null"; + } + List parts = new ArrayList<>(); + for (CopilotTool.MetadataEntry entry : entries) { + parts.add("\"" + escapeJava(entry.key()) + "\", " + metadataValueSource(entry.value())); + } + return "Map.of(" + String.join(", ", parts) + ")"; + } + + /** + * Converts a single {@link CopilotTool.MetadataValue} into a Java source + * literal. A non-empty {@code flags} map takes precedence, then a non-empty + * {@code str}, otherwise the {@code bool} scalar. + */ + private String metadataValueSource(CopilotTool.MetadataValue value) { + CopilotTool.MetadataFlag[] flags = value.flags(); + if (flags.length > 0) { + List flagParts = new ArrayList<>(); + for (CopilotTool.MetadataFlag flag : flags) { + flagParts.add("\"" + escapeJava(flag.name()) + "\", " + flag.value()); + } + return "Map.of(" + String.join(", ", flagParts) + ")"; + } + if (!value.str().isEmpty()) { + return "\"" + escapeJava(value.str()) + "\""; + } + return String.valueOf(value.bool()); + } + + private String generateSchemaWithParamMetadata(List parameters) { + List schemaParameters = getSchemaParameters(parameters); + + if (schemaParameters.isEmpty()) { + return "Map.of(\"type\", \"object\", \"properties\", Map.of(), \"required\", List.of())"; + } + if (schemaParameters.size() == 1 && isRecord(schemaParameters.get(0).asType())) { + return schemaGenerator.generateSchemaSource(schemaParameters.get(0).asType(), processingEnv.getTypeUtils(), + processingEnv.getElementUtils()); + } + + List propertyEntries = new ArrayList<>(); + List requiredNames = new ArrayList<>(); + + for (VariableElement param : schemaParameters) { + String paramName = getParamName(param); + TypeMirror paramType = param.asType(); + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + + // Generate the type schema for this parameter + String typeSchema; + if (paramAnnotation != null && !paramAnnotation.schema().isEmpty()) { + try { + typeSchema = jsonToMapOfSource(paramAnnotation.schema()); + } catch (IllegalArgumentException e) { + processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, + "@CopilotToolParam schema is not valid JSON: " + e.getMessage(), param); + continue; + } + } else { + typeSchema = schemaGenerator.generateSchemaSource(paramType, processingEnv.getTypeUtils(), + processingEnv.getElementUtils()); + } + + // Build property schema with description and default if present + String propertySchema = buildPropertySchema(typeSchema, paramAnnotation, paramType); + + // Cast to Map via raw type for consistent Map.ofEntries typing + propertyEntries.add("Map.entry(\"" + paramName + "\", (Map)(Map) " + propertySchema + ")"); + + // Determine if required (Optional* types are never required) + boolean isOptionalType = paramType.getKind() == TypeKind.DECLARED && Set + .of("java.util.Optional", "java.util.OptionalInt", "java.util.OptionalLong", + "java.util.OptionalDouble") + .contains(((TypeElement) ((DeclaredType) paramType).asElement()).getQualifiedName().toString()); + if (!isOptionalType && (paramAnnotation == null || paramAnnotation.required())) { + requiredNames.add("\"" + paramName + "\""); + } + } + + String properties = "Map.ofEntries(" + String.join(", ", propertyEntries) + ")"; + String required = "List.of(" + String.join(", ", requiredNames) + ")"; + + return "Map.of(\"type\", \"object\", \"properties\", " + properties + ", \"required\", " + required + ")"; + } + + private List getSchemaParameters(List parameters) { + List filtered = new ArrayList<>(); + for (VariableElement param : parameters) { + if (!isToolInvocationType(param.asType())) { + filtered.add(param); + } + } + return filtered; + } + + private boolean isToolInvocationType(TypeMirror type) { + return TOOL_INVOCATION_TYPE.equals(processingEnv.getTypeUtils().erasure(type).toString()); + } + + private String buildPropertySchema(String typeSchema, CopilotToolParam paramAnnotation, TypeMirror paramType) { + if (paramAnnotation == null) { + return typeSchema; + } + + String desc = paramAnnotation.value(); + String defaultValue = paramAnnotation.defaultValue(); + + boolean hasDescription = !desc.isEmpty(); + boolean hasDefault = !defaultValue.isEmpty(); + + if (!hasDescription && !hasDefault) { + return typeSchema; + } + + // Use the withMeta helper method in the generated class + String descArg = hasDescription ? "\"" + escapeJava(desc) + "\"" : "null"; + String defaultArg = hasDefault ? generateDefaultLiteral(paramType, defaultValue) : "null"; + + return "withMeta(" + typeSchema + ", " + descArg + ", " + defaultArg + ")"; + } + + private String generateLambdaBody(ExecutableElement method) { + List params = method.getParameters(); + List schemaParameters = getSchemaParameters(params); + StringBuilder sb = new StringBuilder(); + + // Generate argument extraction + if (!schemaParameters.isEmpty()) { + // Check if single-record-parameter shortcut applies + if (schemaParameters.size() == 1 && isRecord(schemaParameters.get(0).asType())) { + String typeName = getTypeString(schemaParameters.get(0).asType()); + String paramName = schemaParameters.get(0).getSimpleName().toString(); + sb.append(" ").append(typeName).append(" ").append(paramName) + .append(" = mapper.convertValue(invocation.getArguments(), ").append(typeName) + .append(".class);\n"); + } else { + sb.append("Map args = invocation.getArguments();\n"); + for (VariableElement param : schemaParameters) { + String paramName = getParamName(param); + String varName = param.getSimpleName().toString(); + TypeMirror paramType = param.asType(); + + // Handle default values + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + boolean hasDefault = paramAnnotation != null && !paramAnnotation.defaultValue().isEmpty(); + + if (hasDefault) { + String defaultValue = paramAnnotation.defaultValue(); + sb.append(" Object ").append(varName).append("Raw = args.containsKey(\"") + .append(paramName).append("\") ? args.get(\"").append(paramName).append("\") : ") + .append(generateDefaultLiteral(paramType, defaultValue)).append(";\n"); + sb.append(" ").append(getTypeString(paramType)).append(" ").append(varName) + .append(" = ").append(generateArgExtraction(varName + "Raw", paramType)).append(";\n"); + } else if (isOptionalType(paramType)) { + generateOptionalExtraction(sb, paramName, varName, paramType); + } else { + sb.append(" ").append(getTypeString(paramType)).append(" ").append(varName) + .append(" = ").append(generateArgExtractionFromMap(paramName, paramType)).append(";\n"); + } + } + } + } + + // Generate method invocation based on return type + TypeMirror returnType = method.getReturnType(); + String callTarget = method.getModifiers().contains(Modifier.STATIC) + ? ((TypeElement) method.getEnclosingElement()).getQualifiedName().toString() + : "instance"; + String methodCall = callTarget + "." + method.getSimpleName() + "(" + generateArgList(params) + ")"; + + if (returnType.getKind() == TypeKind.VOID) { + sb.append(" ").append(methodCall).append(";\n"); + sb.append(" return CompletableFuture.completedFuture(\"Success\");"); + } else if (isCompletableFuture(returnType)) { + TypeMirror typeArg = getCompletableFutureTypeArg(returnType); + if (typeArg != null && isStringType(typeArg)) { + // CompletableFuture -> CompletableFuture via thenApply + sb.append(" return ").append(methodCall).append(".thenApply(r -> (Object) r);"); + } else { + // CompletableFuture -> serialize to JSON + sb.append(" return ").append(methodCall) + .append(".thenApply(r -> { try { return (Object) mapper.writeValueAsString(r); }") + .append(" catch (Exception e) { throw new RuntimeException(e); } });"); + } + } else if (isStringType(returnType)) { + sb.append(" return CompletableFuture.completedFuture(").append(methodCall).append(");"); + } else { + sb.append(" try { return CompletableFuture.completedFuture(mapper.writeValueAsString(") + .append(methodCall).append(")); } catch (Exception e) { throw new RuntimeException(e); }"); + } + + return sb.toString(); + } + + private String generateArgList(List params) { + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < params.size(); i++) { + if (i > 0) { + sb.append(", "); + } + if (isToolInvocationType(params.get(i).asType())) { + sb.append("invocation"); + } else { + sb.append(params.get(i).getSimpleName().toString()); + } + } + return sb.toString(); + } + + private String generateArgExtractionFromMap(String paramName, TypeMirror type) { + if (type.getKind().isPrimitive()) { + return generatePrimitiveExtraction("args.get(\"" + paramName + "\")", type); + } + if (type.getKind() == TypeKind.ARRAY) { + return generateGenericTypeReferenceConversion("args.get(\"" + paramName + "\")", type); + } + if (type.getKind() == TypeKind.DECLARED) { + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + if ("java.lang.String".equals(qualifiedName)) { + return "(String) args.get(\"" + paramName + "\")"; + } + if (isBoxedNumeric(qualifiedName)) { + return generateBoxedNumericExtraction("args.get(\"" + paramName + "\")", qualifiedName); + } + if ("java.lang.Boolean".equals(qualifiedName)) { + return "(Boolean) args.get(\"" + paramName + "\")"; + } + if (hasTypeArguments(type)) { + return generateGenericTypeReferenceConversion("args.get(\"" + paramName + "\")", type); + } + // Complex types: enums, records, POJOs + return "mapper.convertValue(args.get(\"" + paramName + "\"), " + qualifiedName + ".class)"; + } + return "(Object) args.get(\"" + paramName + "\")"; + } + + private String generateArgExtraction(String varExpr, TypeMirror type) { + if (type.getKind().isPrimitive()) { + return generatePrimitiveExtraction(varExpr, type); + } + if (type.getKind() == TypeKind.ARRAY) { + return generateGenericTypeReferenceConversion(varExpr, type); + } + if (type.getKind() == TypeKind.DECLARED) { + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + if ("java.lang.String".equals(qualifiedName)) { + return "(String) " + varExpr; + } + if (isBoxedNumeric(qualifiedName)) { + return generateBoxedNumericExtraction(varExpr, qualifiedName); + } + if ("java.lang.Boolean".equals(qualifiedName)) { + return "(Boolean) " + varExpr; + } + if (hasTypeArguments(type)) { + return generateGenericTypeReferenceConversion(varExpr, type); + } + return "mapper.convertValue(" + varExpr + ", " + qualifiedName + ".class)"; + } + return "(Object) " + varExpr; + } + + private boolean hasTypeArguments(TypeMirror type) { + return type.getKind() == TypeKind.DECLARED && !((DeclaredType) type).getTypeArguments().isEmpty(); + } + + private String generateGenericTypeReferenceConversion(String expr, TypeMirror type) { + return "mapper.convertValue(" + expr + ", new com.fasterxml.jackson.core.type.TypeReference<" + type + + ">() {})"; + } + + private String generatePrimitiveExtraction(String expr, TypeMirror type) { + switch (type.getKind()) { + case INT : + return "((Number) " + expr + ").intValue()"; + case LONG : + return "((Number) " + expr + ").longValue()"; + case DOUBLE : + return "((Number) " + expr + ").doubleValue()"; + case FLOAT : + return "((Number) " + expr + ").floatValue()"; + case SHORT : + return "((Number) " + expr + ").shortValue()"; + case BYTE : + return "((Number) " + expr + ").byteValue()"; + case BOOLEAN : + return "(Boolean) " + expr; + case CHAR : + return "((String) " + expr + ").charAt(0)"; + default : + return "(" + type + ") " + expr; + } + } + + private boolean isOptionalType(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return false; + } + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + String name = typeElement.getQualifiedName().toString(); + return "java.util.Optional".equals(name) || "java.util.OptionalInt".equals(name) + || "java.util.OptionalLong".equals(name) || "java.util.OptionalDouble".equals(name); + } + + private void generateOptionalExtraction(StringBuilder sb, String paramName, String varName, TypeMirror paramType) { + TypeElement typeElement = (TypeElement) ((DeclaredType) paramType).asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + + sb.append(" Object ").append(varName).append("Raw = args.get(\"").append(paramName) + .append("\");\n"); + + switch (qualifiedName) { + case "java.util.OptionalInt" : + sb.append(" java.util.OptionalInt ").append(varName).append(" = ").append(varName) + .append("Raw != null ? java.util.OptionalInt.of(((Number) ").append(varName) + .append("Raw).intValue()) : java.util.OptionalInt.empty();\n"); + break; + case "java.util.OptionalLong" : + sb.append(" java.util.OptionalLong ").append(varName).append(" = ").append(varName) + .append("Raw != null ? java.util.OptionalLong.of(((Number) ").append(varName) + .append("Raw).longValue()) : java.util.OptionalLong.empty();\n"); + break; + case "java.util.OptionalDouble" : + sb.append(" java.util.OptionalDouble ").append(varName).append(" = ").append(varName) + .append("Raw != null ? java.util.OptionalDouble.of(((Number) ").append(varName) + .append("Raw).doubleValue()) : java.util.OptionalDouble.empty();\n"); + break; + default : + // java.util.Optional — unwrap the type argument + List typeArgs = ((DeclaredType) paramType).getTypeArguments(); + if (!typeArgs.isEmpty()) { + TypeMirror innerType = typeArgs.get(0); + String innerExtraction = generateArgExtraction(varName + "Raw", innerType); + sb.append(" java.util.Optional ").append(varName).append(" = ").append(varName) + .append("Raw != null ? java.util.Optional.of(").append(innerExtraction) + .append(") : java.util.Optional.empty();\n"); + } else { + sb.append(" java.util.Optional ").append(varName).append(" = ").append(varName) + .append("Raw != null ? java.util.Optional.of(").append(varName) + .append("Raw) : java.util.Optional.empty();\n"); + } + break; + } + } + + private boolean isBoxedNumeric(String qualifiedName) { + return "java.lang.Integer".equals(qualifiedName) || "java.lang.Long".equals(qualifiedName) + || "java.lang.Double".equals(qualifiedName) || "java.lang.Float".equals(qualifiedName) + || "java.lang.Short".equals(qualifiedName) || "java.lang.Byte".equals(qualifiedName); + } + + private String generateBoxedNumericExtraction(String expr, String qualifiedName) { + switch (qualifiedName) { + case "java.lang.Integer" : + return "((Number) " + expr + ").intValue()"; + case "java.lang.Long" : + return "((Number) " + expr + ").longValue()"; + case "java.lang.Double" : + return "((Number) " + expr + ").doubleValue()"; + case "java.lang.Float" : + return "((Number) " + expr + ").floatValue()"; + case "java.lang.Short" : + return "((Number) " + expr + ").shortValue()"; + case "java.lang.Byte" : + return "((Number) " + expr + ").byteValue()"; + default : + return "(" + qualifiedName + ") " + expr; + } + } + + private String generateDefaultLiteral(TypeMirror type, String defaultValue) { + if (type.getKind().isPrimitive()) { + switch (type.getKind()) { + case INT : + case LONG : + case SHORT : + case BYTE : + return defaultValue; + case DOUBLE : + case FLOAT : + return defaultValue; + case BOOLEAN : + return defaultValue; + case CHAR : + return "\"" + escapeJava(defaultValue) + "\""; + default : + return "\"" + escapeJava(defaultValue) + "\""; + } + } + if (type.getKind() == TypeKind.DECLARED) { + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + if ("java.lang.String".equals(qualifiedName)) { + return "\"" + escapeJava(defaultValue) + "\""; + } + if (isBoxedNumeric(qualifiedName) || "java.lang.Boolean".equals(qualifiedName)) { + return defaultValue; + } + } + return "\"" + escapeJava(defaultValue) + "\""; + } + + private String validateDefaultValueCompatibility(TypeMirror type, String defaultValue) { + if (type.getKind().isPrimitive()) { + return validatePrimitiveDefault(type.getKind(), defaultValue); + } + if (type.getKind() == TypeKind.DECLARED) { + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + if ("java.lang.String".equals(qualifiedName)) { + return null; + } + if ("java.lang.Boolean".equals(qualifiedName)) { + return validateBooleanDefault(defaultValue); + } + if ("java.lang.Character".equals(qualifiedName)) { + return validateCharacterDefault(defaultValue); + } + if (isBoxedNumeric(qualifiedName)) { + return validatePrimitiveDefault(boxedTypeKind(qualifiedName), defaultValue); + } + } + return null; + } + + private String validatePrimitiveDefault(TypeKind kind, String defaultValue) { + try { + switch (kind) { + case INT : + Integer.parseInt(defaultValue); + return null; + case LONG : + Long.parseLong(defaultValue); + return null; + case SHORT : + Short.parseShort(defaultValue); + return null; + case BYTE : + Byte.parseByte(defaultValue); + return null; + case DOUBLE : + Double.parseDouble(defaultValue); + return null; + case FLOAT : + Float.parseFloat(defaultValue); + return null; + case BOOLEAN : + return validateBooleanDefault(defaultValue); + case CHAR : + return validateCharacterDefault(defaultValue); + default : + return null; + } + } catch (NumberFormatException ex) { + return "@CopilotToolParam defaultValue '" + defaultValue + "' is not valid for " + kind.name().toLowerCase() + + " parameters"; + } + } + + private String validateBooleanDefault(String defaultValue) { + if ("true".equalsIgnoreCase(defaultValue) || "false".equalsIgnoreCase(defaultValue)) { + return null; + } + return "@CopilotToolParam defaultValue '" + defaultValue + "' is not valid for boolean parameters"; + } + + private String validateCharacterDefault(String defaultValue) { + return defaultValue != null && defaultValue.length() == 1 + ? null + : "@CopilotToolParam defaultValue '" + defaultValue + "' is not valid for char parameters"; + } + + private TypeKind boxedTypeKind(String qualifiedName) { + switch (qualifiedName) { + case "java.lang.Integer" : + return TypeKind.INT; + case "java.lang.Long" : + return TypeKind.LONG; + case "java.lang.Double" : + return TypeKind.DOUBLE; + case "java.lang.Float" : + return TypeKind.FLOAT; + case "java.lang.Short" : + return TypeKind.SHORT; + case "java.lang.Byte" : + return TypeKind.BYTE; + default : + return TypeKind.NONE; + } + } + + private String getParamName(VariableElement param) { + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation != null && !paramAnnotation.name().isEmpty()) { + return paramAnnotation.name(); + } + return param.getSimpleName().toString(); + } + + private String getTypeString(TypeMirror type) { + if (type.getKind().isPrimitive()) { + return type.toString(); + } + if (type.getKind() == TypeKind.DECLARED) { + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + return typeElement.getQualifiedName().toString(); + } + return type.toString(); + } + + private boolean isRecord(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return false; + } + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + return typeElement.getKind() == ElementKind.RECORD; + } + + private boolean isCompletableFuture(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return false; + } + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + return "java.util.concurrent.CompletableFuture".equals(typeElement.getQualifiedName().toString()); + } + + private TypeMirror getCompletableFutureTypeArg(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return null; + } + DeclaredType declaredType = (DeclaredType) type; + List typeArgs = declaredType.getTypeArguments(); + if (typeArgs.isEmpty()) { + return null; + } + return typeArgs.get(0); + } + + private boolean isStringType(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return false; + } + TypeElement typeElement = (TypeElement) ((DeclaredType) type).asElement(); + return "java.lang.String".equals(typeElement.getQualifiedName().toString()); + } + + /** + * Converts a camelCase method name to snake_case. + * + * @param name + * the method name + * @return the snake_case tool name + */ + static String toSnakeCase(String name) { + if (name == null || name.isEmpty()) { + return name; + } + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < name.length(); i++) { + char c = name.charAt(i); + if (Character.isUpperCase(c)) { + if (i > 0) { + sb.append('_'); + } + sb.append(Character.toLowerCase(c)); + } else { + sb.append(c); + } + } + return sb.toString(); + } + + // ------------------------------------------------------------------ + // JSON-to-Java source code conversion + // ------------------------------------------------------------------ + + /** + * Converts a JSON object string to a Java source expression. Supports nested + * objects, arrays, strings, numbers, booleans, and null. + */ + static String jsonToMapOfSource(String json) { + JsonToSourceConverter converter = new JsonToSourceConverter(json); + String result = converter.parseObject(); + converter.skipWhitespace(); + if (converter.pos < json.length()) { + throw new IllegalArgumentException("Unexpected trailing content at position " + converter.pos + ": '" + + json.substring(converter.pos) + "'"); + } + return result; + } + + /** + * Minimal recursive-descent JSON parser that produces helper calls and literal + * Java source expressions from a JSON string. Only used at compile time by the + * annotation processor. + */ + private static final class JsonToSourceConverter { + + private final String input; + private int pos; + + JsonToSourceConverter(String input) { + this.input = input; + this.pos = 0; + } + + String parseObject() { + skipWhitespace(); + expect('{'); + skipWhitespace(); + List entries = new ArrayList<>(); + if (peek() != '}') { + do { + skipWhitespace(); + String key = parseString(); + skipWhitespace(); + expect(':'); + skipWhitespace(); + String value = parseValue(); + entries.add("\"" + escapeJava(key) + "\", " + value); + skipWhitespace(); + } while (tryConsume(',')); + } + expect('}'); + return "mapOfNullable(" + String.join(", ", entries) + ")"; + } + + private String parseArray() { + expect('['); + skipWhitespace(); + List items = new ArrayList<>(); + if (peek() != ']') { + do { + skipWhitespace(); + items.add(parseValue()); + skipWhitespace(); + } while (tryConsume(',')); + } + expect(']'); + return "listOfNullable(" + String.join(", ", items) + ")"; + } + + private String parseValue() { + skipWhitespace(); + char c = peek(); + if (c == '{') { + return parseObject(); + } + if (c == '[') { + return parseArray(); + } + if (c == '"') { + return "\"" + escapeJava(parseString()) + "\""; + } + if (c == 't' || c == 'f') { + return parseBoolean(); + } + if (c == 'n') { + return parseNull(); + } + return parseNumber(); + } + + private String parseString() { + expect('"'); + StringBuilder sb = new StringBuilder(); + while (pos < input.length() && input.charAt(pos) != '"') { + char current = input.charAt(pos++); + if (current == '\\') { + sb.append(parseEscape()); + } else { + if (current < 0x20) { + throw new IllegalArgumentException("Unescaped control character at position " + (pos - 1)); + } + sb.append(current); + } + } + expect('"'); + return sb.toString(); + } + + private char parseEscape() { + if (pos >= input.length()) { + throw new IllegalArgumentException("Unterminated string escape at position " + pos); + } + char escaped = input.charAt(pos++); + return switch (escaped) { + case '"', '\\', '/' -> escaped; + case 'b' -> '\b'; + case 'f' -> '\f'; + case 'n' -> '\n'; + case 'r' -> '\r'; + case 't' -> '\t'; + case 'u' -> parseUnicodeEscape(); + default -> throw new IllegalArgumentException( + "Invalid escape sequence \\" + escaped + " at position " + (pos - 2)); + }; + } + + private char parseUnicodeEscape() { + if (pos + 4 > input.length()) { + throw new IllegalArgumentException("Incomplete Unicode escape at position " + (pos - 2)); + } + int value = 0; + for (int i = 0; i < 4; i++) { + char hex = input.charAt(pos++); + if (!isAsciiHexDigit(hex)) { + throw new IllegalArgumentException("Invalid Unicode escape at position " + (pos - 1)); + } + int digit = Character.digit(hex, 16); + value = (value << 4) | digit; + } + return (char) value; + } + + private boolean isAsciiHexDigit(char c) { + return (c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); + } + + private String parseBoolean() { + if (input.startsWith("true", pos)) { + pos += 4; + return "true"; + } + if (input.startsWith("false", pos)) { + pos += 5; + return "false"; + } + throw new IllegalArgumentException("Expected boolean at position " + pos); + } + + private String parseNull() { + if (input.startsWith("null", pos)) { + pos += 4; + return "(Object) null"; + } + throw new IllegalArgumentException("Expected null at position " + pos); + } + + private String parseNumber() { + int start = pos; + if (pos < input.length() && input.charAt(pos) == '-') { + pos++; + } + if (pos >= input.length()) { + throw new IllegalArgumentException("Expected number at position " + start); + } + if (input.charAt(pos) == '0') { + pos++; + } else if (isDigitOneToNine(input.charAt(pos))) { + consumeDigits(); + } else { + throw new IllegalArgumentException("Expected number at position " + pos); + } + if (pos < input.length() && input.charAt(pos) == '.') { + pos++; + requireDigit("fraction"); + consumeDigits(); + } + if (pos < input.length() && (input.charAt(pos) == 'e' || input.charAt(pos) == 'E')) { + pos++; + if (pos < input.length() && (input.charAt(pos) == '+' || input.charAt(pos) == '-')) { + pos++; + } + requireDigit("exponent"); + consumeDigits(); + } + String number = input.substring(start, pos); + try { + new java.math.BigDecimal(number); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Number cannot be represented at position " + start + ": " + number, + e); + } + return "new java.math.BigDecimal(\"" + number + "\")"; + } + + private void requireDigit(String part) { + if (pos >= input.length() || !isAsciiDigit(input.charAt(pos))) { + throw new IllegalArgumentException("Expected digit in number " + part + " at position " + pos); + } + } + + private void consumeDigits() { + while (pos < input.length() && isAsciiDigit(input.charAt(pos))) { + pos++; + } + } + + private boolean isAsciiDigit(char c) { + return c >= '0' && c <= '9'; + } + + private boolean isDigitOneToNine(char c) { + return c >= '1' && c <= '9'; + } + + private void skipWhitespace() { + while (pos < input.length() && isJsonWhitespace(input.charAt(pos))) { + pos++; + } + } + + private boolean isJsonWhitespace(char c) { + return c == ' ' || c == '\t' || c == '\r' || c == '\n'; + } + + private char peek() { + if (pos >= input.length()) { + throw new IllegalArgumentException("Unexpected end of JSON"); + } + return input.charAt(pos); + } + + private void expect(char c) { + if (pos >= input.length() || input.charAt(pos) != c) { + throw new IllegalArgumentException("Expected '" + c + "' at position " + pos + " but got '" + + (pos < input.length() ? input.charAt(pos) : "EOF") + "'"); + } + pos++; + } + + private boolean tryConsume(char c) { + if (pos < input.length() && input.charAt(pos) == c) { + pos++; + return true; + } + return false; + } + } + + private static String escapeJava(String s) { + if (s == null) { + return ""; + } + StringBuilder escaped = new StringBuilder(s.length()); + for (int i = 0; i < s.length(); i++) { + char current = s.charAt(i); + switch (current) { + case '\\' -> escaped.append("\\\\"); + case '"' -> escaped.append("\\\""); + case '\b' -> escaped.append("\\b"); + case '\f' -> escaped.append("\\f"); + case '\n' -> escaped.append("\\n"); + case '\r' -> escaped.append("\\r"); + case '\t' -> escaped.append("\\t"); + default -> { + if (Character.isISOControl(current)) { + escaped.append(String.format("\\%03o", (int) current)); + } else { + escaped.append(current); + } + } + } + } + return escaped.toString(); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/tool/Param.java b/java/sdk/src/main/java/com/github/copilot/tool/Param.java new file mode 100644 index 000000000..0060205f6 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/Param.java @@ -0,0 +1,295 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.util.Objects; + +import com.github.copilot.CopilotExperimental; + +/** + * Runtime parameter metadata for lambda-defined tools. + * + *

+ * Each {@code Param} instance describes a single parameter that a tool accepts, + * including its Java type, wire name, description, whether it is required, and + * an optional default value. Instances are immutable; fluent mutators return + * new copies. + * + *

Example Usage

+ * + * 
{@code
+ * Param query = Param.of(String.class, "query", "Search query text");
+ *
+ * Param limit = Param.of(Integer.class, "limit", "Max results", false, "10");
+ * }
+ * + * @param + * the Java type of the parameter value + * @since 1.0.6 + */ +@CopilotExperimental +public final class Param { + + private final Class type; + private final String name; + private final String description; + private final boolean required; + private final String defaultValue; + private final String schema; + + private Param(Class type, String name, String description, boolean required, String defaultValue, + String schema) { + this.type = Objects.requireNonNull(type, "type"); + this.name = requireNonBlank(name, "name"); + this.description = requireNonBlank(description, "description"); + this.defaultValue = defaultValue == null ? "" : defaultValue; + this.schema = schema == null ? "" : schema; + this.required = required; + + if (this.required && !this.defaultValue.isEmpty()) { + throw new IllegalArgumentException("required=true cannot be combined with a non-empty defaultValue"); + } + + if (!this.schema.isEmpty()) { + String trimmed = this.schema.trim(); + if (!trimmed.startsWith("{") || !trimmed.endsWith("}")) { + throw new IllegalArgumentException( + "schema must be a valid JSON object string (must start with '{' and end with '}')"); + } + if (!this.defaultValue.isEmpty()) { + throw new IllegalArgumentException( + "schema cannot be combined with defaultValue — express defaults inside the schema if needed"); + } + } + + validateDefaultValue(type, this.defaultValue); + } + + /** + * Creates a required parameter with no default value. + * + * @param + * the parameter type + * @param type + * the Java class of the parameter + * @param name + * the wire name sent to the model (must not be blank) + * @param description + * a human-readable description (must not be blank) + * @return a new {@code Param} instance + * @throws NullPointerException + * if {@code type} is null + * @throws IllegalArgumentException + * if {@code name} or {@code description} is blank + */ + public static Param of(Class type, String name, String description) { + return new Param<>(type, name, description, true, "", ""); + } + + /** + * Creates a parameter with explicit required/default settings. + * + * @param + * the parameter type + * @param type + * the Java class of the parameter + * @param name + * the wire name sent to the model (must not be blank) + * @param description + * a human-readable description (must not be blank) + * @param required + * whether the parameter is required + * @param defaultValue + * the default value as a string, or {@code null}/empty for none + * @return a new {@code Param} instance + * @throws NullPointerException + * if {@code type} is null + * @throws IllegalArgumentException + * if validation fails + */ + public static Param of(Class type, String name, String description, boolean required, + String defaultValue) { + return new Param<>(type, name, description, required, defaultValue, ""); + } + + /** + * Returns a copy with a different name. + * + * @param name + * the new parameter name + * @return a new {@code Param} with the updated name + */ + public Param name(String name) { + return new Param<>(this.type, name, this.description, this.required, this.defaultValue, this.schema); + } + + /** + * Returns a copy with a different description. + * + * @param description + * the new description + * @return a new {@code Param} with the updated description + */ + public Param description(String description) { + return new Param<>(this.type, this.name, description, this.required, this.defaultValue, this.schema); + } + + /** + * Returns a copy with a different required flag. + * + * @param required + * whether the parameter is required + * @return a new {@code Param} with the updated required flag + */ + public Param required(boolean required) { + return new Param<>(this.type, this.name, this.description, required, this.defaultValue, this.schema); + } + + /** + * Returns an optional copy with the given default value. Setting a default + * implicitly makes the parameter optional ({@code required=false}). + * + * @param defaultValue + * the default value as a string + * @return a new {@code Param} with the default applied and required set to + * false + */ + public Param defaultValue(String defaultValue) { + return new Param<>(this.type, this.name, this.description, false, defaultValue, this.schema); + } + + /** Returns the Java type of this parameter. */ + public Class type() { + return type; + } + + /** Returns the wire name of this parameter. */ + public String name() { + return name; + } + + /** Returns the human-readable description. */ + public String description() { + return description; + } + + /** Returns whether this parameter is required. */ + public boolean required() { + return required; + } + + /** Returns the default value string, or empty if none. */ + public String defaultValue() { + return defaultValue; + } + + /** Returns {@code true} if a non-empty default value is set. */ + public boolean hasDefaultValue() { + return !defaultValue.isEmpty(); + } + + /** + * Returns a copy with an explicit JSON Schema override. When set, bypasses + * automatic schema generation from the parameter type. + * + * @param schema + * a JSON object string (e.g., + * {@code "{\"type\":\"string\",\"format\":\"date-time\"}"} ) + * @return a new {@code Param} with the schema override + */ + public Param schema(String schema) { + return new Param<>(this.type, this.name, this.description, this.required, this.defaultValue, schema); + } + + /** Returns the explicit JSON Schema override, or empty if none. */ + public String schema() { + return schema; + } + + @Override + public boolean equals(Object o) { + if (!(o instanceof Param other)) { + return false; + } + return required == other.required && Objects.equals(type, other.type) && Objects.equals(name, other.name) + && Objects.equals(description, other.description) && Objects.equals(defaultValue, other.defaultValue) + && Objects.equals(schema, other.schema); + } + + @Override + public int hashCode() { + return Objects.hash(type, name, description, required, defaultValue, schema); + } + + @Override + public String toString() { + return "Param[name=" + name + ", type=" + type.getSimpleName() + ", required=" + required + "]"; + } + + // ------------------------------------------------------------------ + // Internal validation helpers + // ------------------------------------------------------------------ + + private static String requireNonBlank(String value, String fieldName) { + if (value == null || value.isBlank()) { + throw new IllegalArgumentException(fieldName + " must not be null or blank"); + } + return value; + } + + @SuppressWarnings({"rawtypes", "unchecked"}) + private static void validateDefaultValue(Class type, String defaultValue) { + if (defaultValue == null || defaultValue.isEmpty()) { + return; + } + + try { + if (type == String.class) { + return; + } + if (type == Integer.class || type == int.class) { + Integer.parseInt(defaultValue); + return; + } + if (type == Long.class || type == long.class) { + Long.parseLong(defaultValue); + return; + } + if (type == Double.class || type == double.class) { + Double.parseDouble(defaultValue); + return; + } + if (type == Float.class || type == float.class) { + Float.parseFloat(defaultValue); + return; + } + if (type == Short.class || type == short.class) { + Short.parseShort(defaultValue); + return; + } + if (type == Byte.class || type == byte.class) { + Byte.parseByte(defaultValue); + return; + } + if (type == Boolean.class || type == boolean.class) { + if (!"true".equalsIgnoreCase(defaultValue) && !"false".equalsIgnoreCase(defaultValue)) { + throw new IllegalArgumentException("must be 'true' or 'false'"); + } + return; + } + if (type.isEnum()) { + Class enumType = (Class) type; + Enum.valueOf(enumType, defaultValue); + return; + } + } catch (RuntimeException ex) { + throw new IllegalArgumentException( + "defaultValue '" + defaultValue + "' is not valid for type " + type.getSimpleName(), ex); + } + + throw new IllegalArgumentException( + "defaultValue is not supported for type " + type.getName() + " without a custom coercion policy"); + } +} diff --git a/java/sdk/src/main/java/com/github/copilot/tool/SchemaGenerator.java b/java/sdk/src/main/java/com/github/copilot/tool/SchemaGenerator.java new file mode 100644 index 000000000..59336a1e0 --- /dev/null +++ b/java/sdk/src/main/java/com/github/copilot/tool/SchemaGenerator.java @@ -0,0 +1,392 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; + +import javax.lang.model.element.Element; +import javax.lang.model.element.ElementKind; +import javax.lang.model.element.RecordComponentElement; +import javax.lang.model.element.TypeElement; +import javax.lang.model.element.VariableElement; +import javax.lang.model.type.ArrayType; +import javax.lang.model.type.DeclaredType; +import javax.lang.model.type.TypeKind; +import javax.lang.model.type.TypeMirror; +import javax.lang.model.util.Elements; +import javax.lang.model.util.Types; + +import com.github.copilot.CopilotExperimental; + +/** + * Compile-time utility that maps {@code javax.lang.model} types to JSON Schema + * represented as Java source code literals ({@code Map.of(...)} expressions). + * + *

+ * This class is invoked by the annotation processor and operates exclusively + * with the {@code javax.lang.model} API. It does NOT use + * {@code java.lang.reflect}. + * + * @since 1.0.2 + */ +@CopilotExperimental +public class SchemaGenerator { + + /** + * Given a {@link TypeMirror} from the annotation processing environment, + * returns a {@code String} containing Java source code for a {@code Map} + * literal representing the JSON Schema of that type. + * + * @param type + * the type to generate schema for + * @param typeUtils + * the {@link Types} utility from the processing environment + * @param elementUtils + * the {@link Elements} utility from the processing environment + * @return a Java source code string representing the JSON Schema + */ + public String generateSchemaSource(TypeMirror type, Types typeUtils, Elements elementUtils) { + return generateSchema(type, typeUtils, elementUtils); + } + + /** + * Generates the full "parameters" schema source for a method's parameters. + * Produces a + * {@code Map.of("type", "object", "properties", Map.of(...), "required", List.of(...))}. + * + * @param parameters + * the method parameters to generate schema for + * @param typeUtils + * the {@link Types} utility from the processing environment + * @param elementUtils + * the {@link Elements} utility from the processing environment + * @return a Java source code string representing the parameters JSON Schema + */ + public String generateParametersSchemaSource(List parameters, Types typeUtils, + Elements elementUtils) { + if (parameters.isEmpty()) { + return "Map.of(\"type\", \"object\", \"properties\", Map.of(), \"required\", List.of())"; + } + + List propertyEntries = new ArrayList<>(); + List requiredNames = new ArrayList<>(); + + for (VariableElement param : parameters) { + String paramName = param.getSimpleName().toString(); + TypeMirror paramType = param.asType(); + + boolean isOptional = isOptionalType(paramType); + String schema; + if (isOptional) { + schema = generateSchema(unwrapOptional(paramType, typeUtils), typeUtils, elementUtils); + } else { + schema = generateSchema(paramType, typeUtils, elementUtils); + } + + propertyEntries.add("Map.entry(\"" + paramName + "\", " + schema + ")"); + + if (!isOptional) { + CopilotToolParam paramAnnotation = param.getAnnotation(CopilotToolParam.class); + if (paramAnnotation == null || paramAnnotation.required()) { + requiredNames.add("\"" + paramName + "\""); + } + } + } + + String properties = "Map.ofEntries(" + String.join(", ", propertyEntries) + ")"; + String required = "List.of(" + String.join(", ", requiredNames) + ")"; + + return "Map.of(\"type\", \"object\", \"properties\", " + properties + ", \"required\", " + required + ")"; + } + + private String generateSchema(TypeMirror type, Types typeUtils, Elements elementUtils) { + // Handle primitive types + if (type.getKind().isPrimitive()) { + return generatePrimitiveSchema(type.getKind()); + } + + // Handle array types + if (type.getKind() == TypeKind.ARRAY) { + ArrayType arrayType = (ArrayType) type; + TypeMirror componentType = arrayType.getComponentType(); + String itemsSchema = generateSchema(componentType, typeUtils, elementUtils); + return "Map.of(\"type\", \"array\", \"items\", " + itemsSchema + ")"; + } + + // Handle declared types (classes, interfaces, enums, records) + if (type.getKind() == TypeKind.DECLARED) { + return generateDeclaredTypeSchema((DeclaredType) type, typeUtils, elementUtils); + } + + // Fallback: any + return "Map.of()"; + } + + private String generatePrimitiveSchema(TypeKind kind) { + switch (kind) { + case INT : + case LONG : + case BYTE : + case SHORT : + return "Map.of(\"type\", \"integer\")"; + case DOUBLE : + case FLOAT : + return "Map.of(\"type\", \"number\")"; + case BOOLEAN : + return "Map.of(\"type\", \"boolean\")"; + case CHAR : + return "Map.of(\"type\", \"string\")"; + default : + return "Map.of()"; + } + } + + private String generateDeclaredTypeSchema(DeclaredType type, Types typeUtils, Elements elementUtils) { + TypeElement typeElement = (TypeElement) type.asElement(); + String qualifiedName = typeElement.getQualifiedName().toString(); + + // String + if ("java.lang.String".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\")"; + } + + // Boxed primitives + if ("java.lang.Integer".equals(qualifiedName) || "java.lang.Long".equals(qualifiedName) + || "java.lang.Byte".equals(qualifiedName) || "java.lang.Short".equals(qualifiedName)) { + return "Map.of(\"type\", \"integer\")"; + } + if ("java.lang.Double".equals(qualifiedName) || "java.lang.Float".equals(qualifiedName)) { + return "Map.of(\"type\", \"number\")"; + } + if ("java.lang.Boolean".equals(qualifiedName)) { + return "Map.of(\"type\", \"boolean\")"; + } + if ("java.lang.Character".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\")"; + } + + // UUID + if ("java.util.UUID".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\", \"format\", \"uuid\")"; + } + + // Date-time types (ISO-8601 format hints for the model) + if ("java.time.OffsetDateTime".equals(qualifiedName) || "java.time.LocalDateTime".equals(qualifiedName) + || "java.time.Instant".equals(qualifiedName) || "java.time.ZonedDateTime".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\", \"format\", \"date-time\")"; + } + if ("java.time.LocalDate".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\", \"format\", \"date\")"; + } + if ("java.time.LocalTime".equals(qualifiedName)) { + return "Map.of(\"type\", \"string\", \"format\", \"time\")"; + } + + // JsonNode (any) + if ("com.fasterxml.jackson.databind.JsonNode".equals(qualifiedName)) { + return "Map.of()"; + } + + // Object (any) + if ("java.lang.Object".equals(qualifiedName)) { + return "Map.of()"; + } + + // Optional types + if ("java.util.Optional".equals(qualifiedName)) { + List typeArgs = type.getTypeArguments(); + if (!typeArgs.isEmpty()) { + return generateSchema(typeArgs.get(0), typeUtils, elementUtils); + } + return "Map.of()"; + } + if ("java.util.OptionalInt".equals(qualifiedName)) { + return "Map.of(\"type\", \"integer\")"; + } + if ("java.util.OptionalDouble".equals(qualifiedName)) { + return "Map.of(\"type\", \"number\")"; + } + if ("java.util.OptionalLong".equals(qualifiedName)) { + return "Map.of(\"type\", \"integer\")"; + } + + // List / Collection + if (isCollectionType(qualifiedName)) { + List typeArgs = type.getTypeArguments(); + if (!typeArgs.isEmpty()) { + String itemsSchema = generateSchema(typeArgs.get(0), typeUtils, elementUtils); + return "Map.of(\"type\", \"array\", \"items\", " + itemsSchema + ")"; + } + return "Map.of(\"type\", \"array\")"; + } + + // Map + if (isMapType(qualifiedName)) { + List typeArgs = type.getTypeArguments(); + if (typeArgs.size() == 2) { + TypeMirror valueType = typeArgs.get(1); + if (valueType.getKind() == TypeKind.DECLARED) { + TypeElement valueElement = (TypeElement) ((DeclaredType) valueType).asElement(); + String valueQName = valueElement.getQualifiedName().toString(); + if ("java.lang.Object".equals(valueQName)) { + return "Map.of(\"type\", \"object\")"; + } + } + String valueSchema = generateSchema(valueType, typeUtils, elementUtils); + return "Map.of(\"type\", \"object\", \"additionalProperties\", " + valueSchema + ")"; + } + return "Map.of(\"type\", \"object\")"; + } + + // Enum types + if (typeElement.getKind() == ElementKind.ENUM) { + List constants = typeElement.getEnclosedElements().stream() + .filter(e -> e.getKind() == ElementKind.ENUM_CONSTANT) + .map(e -> "\"" + e.getSimpleName().toString() + "\"").collect(Collectors.toList()); + return "Map.of(\"type\", \"string\", \"enum\", List.of(" + String.join(", ", constants) + "))"; + } + + // Record types + if (typeElement.getKind() == ElementKind.RECORD) { + return generateRecordSchema(typeElement, typeUtils, elementUtils); + } + + // POJO / class types — treat as object with fields + if (typeElement.getKind() == ElementKind.CLASS) { + return generateClassSchema(typeElement, typeUtils, elementUtils); + } + + // Sealed interfaces — oneOf via permitted subclasses + if (typeElement.getKind() == ElementKind.INTERFACE) { + return generateSealedSchema(typeElement, typeUtils, elementUtils); + } + + return "Map.of()"; + } + + private String generateRecordSchema(TypeElement typeElement, Types typeUtils, Elements elementUtils) { + List propertyEntries = new ArrayList<>(); + List requiredNames = new ArrayList<>(); + + for (Element enclosed : typeElement.getEnclosedElements()) { + if (enclosed.getKind() == ElementKind.RECORD_COMPONENT) { + RecordComponentElement component = (RecordComponentElement) enclosed; + String name = component.getSimpleName().toString(); + TypeMirror componentType = component.asType(); + + boolean isOptional = isOptionalType(componentType); + String schema; + if (isOptional) { + schema = generateSchema(unwrapOptional(componentType, typeUtils), typeUtils, elementUtils); + } else { + schema = generateSchema(componentType, typeUtils, elementUtils); + requiredNames.add("\"" + name + "\""); + } + + propertyEntries.add("Map.entry(\"" + name + "\", " + schema + ")"); + } + } + + String properties = "Map.ofEntries(" + String.join(", ", propertyEntries) + ")"; + String required = "List.of(" + String.join(", ", requiredNames) + ")"; + + return "Map.of(\"type\", \"object\", \"properties\", " + properties + ", \"required\", " + required + ")"; + } + + private String generateClassSchema(TypeElement typeElement, Types typeUtils, Elements elementUtils) { + List propertyEntries = new ArrayList<>(); + List requiredNames = new ArrayList<>(); + + for (Element enclosed : typeElement.getEnclosedElements()) { + if (enclosed.getKind() == ElementKind.FIELD) { + VariableElement field = (VariableElement) enclosed; + // Skip static fields + if (field.getModifiers().contains(javax.lang.model.element.Modifier.STATIC)) { + continue; + } + String name = field.getSimpleName().toString(); + TypeMirror fieldType = field.asType(); + + boolean isOptional = isOptionalType(fieldType); + String schema; + if (isOptional) { + schema = generateSchema(unwrapOptional(fieldType, typeUtils), typeUtils, elementUtils); + } else { + schema = generateSchema(fieldType, typeUtils, elementUtils); + requiredNames.add("\"" + name + "\""); + } + + propertyEntries.add("Map.entry(\"" + name + "\", " + schema + ")"); + } + } + + if (propertyEntries.isEmpty()) { + return "Map.of(\"type\", \"object\")"; + } + + String properties = "Map.ofEntries(" + String.join(", ", propertyEntries) + ")"; + String required = "List.of(" + String.join(", ", requiredNames) + ")"; + + return "Map.of(\"type\", \"object\", \"properties\", " + properties + ", \"required\", " + required + ")"; + } + + private String generateSealedSchema(TypeElement typeElement, Types typeUtils, Elements elementUtils) { + List permittedSubclasses = typeElement.getPermittedSubclasses(); + if (permittedSubclasses != null && !permittedSubclasses.isEmpty()) { + List schemas = permittedSubclasses.stream().map(sub -> generateSchema(sub, typeUtils, elementUtils)) + .collect(Collectors.toList()); + return "Map.of(\"oneOf\", List.of(" + String.join(", ", schemas) + "))"; + } + return "Map.of(\"type\", \"object\")"; + } + + private boolean isOptionalType(TypeMirror type) { + if (type.getKind() != TypeKind.DECLARED) { + return false; + } + DeclaredType declaredType = (DeclaredType) type; + TypeElement element = (TypeElement) declaredType.asElement(); + String name = element.getQualifiedName().toString(); + return "java.util.Optional".equals(name) || "java.util.OptionalInt".equals(name) + || "java.util.OptionalDouble".equals(name) || "java.util.OptionalLong".equals(name); + } + + private TypeMirror unwrapOptional(TypeMirror type, Types typeUtils) { + if (type.getKind() != TypeKind.DECLARED) { + return type; + } + DeclaredType declaredType = (DeclaredType) type; + TypeElement element = (TypeElement) declaredType.asElement(); + String name = element.getQualifiedName().toString(); + + if ("java.util.Optional".equals(name)) { + List typeArgs = declaredType.getTypeArguments(); + if (!typeArgs.isEmpty()) { + return typeArgs.get(0); + } + } + if ("java.util.OptionalInt".equals(name)) { + return typeUtils.getPrimitiveType(TypeKind.INT); + } + if ("java.util.OptionalDouble".equals(name)) { + return typeUtils.getPrimitiveType(TypeKind.DOUBLE); + } + if ("java.util.OptionalLong".equals(name)) { + return typeUtils.getPrimitiveType(TypeKind.LONG); + } + return type; + } + + private boolean isCollectionType(String qualifiedName) { + return "java.util.List".equals(qualifiedName) || "java.util.Collection".equals(qualifiedName) + || "java.util.Set".equals(qualifiedName); + } + + private boolean isMapType(String qualifiedName) { + return "java.util.Map".equals(qualifiedName); + } +} diff --git a/java/sdk/src/main/java/module-info.java b/java/sdk/src/main/java/module-info.java new file mode 100644 index 000000000..8bc2dbd55 --- /dev/null +++ b/java/sdk/src/main/java/module-info.java @@ -0,0 +1,33 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * GitHub Copilot SDK for Java. + */ +module com.github.copilot.java { + requires transitive com.fasterxml.jackson.annotation; + requires com.fasterxml.jackson.core; + requires transitive com.fasterxml.jackson.databind; + requires com.fasterxml.jackson.datatype.jsr310; + requires static com.github.spotbugs.annotations; + requires static java.compiler; + requires static com.sun.jna; + requires java.net.http; + requires java.logging; + + exports com.github.copilot; + exports com.github.copilot.generated; + exports com.github.copilot.generated.rpc; + exports com.github.copilot.rpc; + exports com.github.copilot.tool; + + opens com.github.copilot to com.fasterxml.jackson.databind; + opens com.github.copilot.generated to com.fasterxml.jackson.databind; + opens com.github.copilot.generated.rpc to com.fasterxml.jackson.databind; + opens com.github.copilot.rpc to com.fasterxml.jackson.databind; + opens com.github.copilot.ffi to com.sun.jna; + + provides javax.annotation.processing.Processor + with com.github.copilot.CopilotExperimentalProcessor, com.github.copilot.tool.CopilotToolProcessor; +} diff --git a/java/src/main/java25/com/github/copilot/InternalExecutorProvider.java b/java/sdk/src/main/java25/com/github/copilot/InternalExecutorProvider.java similarity index 100% rename from java/src/main/java25/com/github/copilot/InternalExecutorProvider.java rename to java/sdk/src/main/java25/com/github/copilot/InternalExecutorProvider.java diff --git a/java/sdk/src/main/java25/com/github/copilot/ffi/ReaderThreadFactory.java b/java/sdk/src/main/java25/com/github/copilot/ffi/ReaderThreadFactory.java new file mode 100644 index 000000000..a67346b88 --- /dev/null +++ b/java/sdk/src/main/java25/com/github/copilot/ffi/ReaderThreadFactory.java @@ -0,0 +1,15 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +/** + * JDK 25 multi-release variant of {@link ReaderThreadFactory}. + */ +final class ReaderThreadFactory { + + Thread create(Runnable task, String name) { + return Thread.ofVirtual().name(name).unstarted(task); + } +} diff --git a/java/sdk/src/main/resources/META-INF/services/javax.annotation.processing.Processor b/java/sdk/src/main/resources/META-INF/services/javax.annotation.processing.Processor new file mode 100644 index 000000000..3b2e17d2f --- /dev/null +++ b/java/sdk/src/main/resources/META-INF/services/javax.annotation.processing.Processor @@ -0,0 +1,2 @@ +com.github.copilot.CopilotExperimentalProcessor +com.github.copilot.tool.CopilotToolProcessor diff --git a/java/sdk/src/main/resources/copilot-runtime.properties b/java/sdk/src/main/resources/copilot-runtime.properties new file mode 100644 index 000000000..290046444 --- /dev/null +++ b/java/sdk/src/main/resources/copilot-runtime.properties @@ -0,0 +1,3 @@ +# This file is processed by Maven resource filtering. +# The ${project.version} placeholder is replaced at build time. +version=${project.version} diff --git a/java/src/test/java/com/github/copilot/AgentInfoTest.java b/java/sdk/src/test/java/com/github/copilot/AgentInfoTest.java similarity index 82% rename from java/src/test/java/com/github/copilot/AgentInfoTest.java rename to java/sdk/src/test/java/com/github/copilot/AgentInfoTest.java index 3b15f5582..40654292f 100644 --- a/java/src/test/java/com/github/copilot/AgentInfoTest.java +++ b/java/sdk/src/test/java/com/github/copilot/AgentInfoTest.java @@ -21,6 +21,7 @@ void defaultValuesAreNull() { assertNull(agent.getName()); assertNull(agent.getDisplayName()); assertNull(agent.getDescription()); + assertNull(agent.getModel()); } @Test @@ -44,14 +45,22 @@ void descriptionGetterSetter() { assertEquals("Helps with coding tasks", agent.getDescription()); } + @Test + void modelGetterSetter() { + var agent = new AgentInfo(); + agent.setModel("alpha/sonnet"); + assertEquals("alpha/sonnet", agent.getModel()); + } + @Test void fluentChainingReturnsThis() { var agent = new AgentInfo().setName("coder").setDisplayName("Code Assistant") - .setDescription("Helps with coding tasks"); + .setDescription("Helps with coding tasks").setModel("alpha/sonnet"); assertEquals("coder", agent.getName()); assertEquals("Code Assistant", agent.getDisplayName()); assertEquals("Helps with coding tasks", agent.getDescription()); + assertEquals("alpha/sonnet", agent.getModel()); } @Test @@ -60,5 +69,6 @@ void fluentChainingReturnsSameInstance() { assertSame(agent, agent.setName("test")); assertSame(agent, agent.setDisplayName("Test")); assertSame(agent, agent.setDescription("A test agent")); + assertSame(agent, agent.setModel("alpha/sonnet")); } } diff --git a/java/src/test/java/com/github/copilot/AgentModeTest.java b/java/sdk/src/test/java/com/github/copilot/AgentModeTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/AgentModeTest.java rename to java/sdk/src/test/java/com/github/copilot/AgentModeTest.java diff --git a/java/src/test/java/com/github/copilot/AskUserTest.java b/java/sdk/src/test/java/com/github/copilot/AskUserTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/AskUserTest.java rename to java/sdk/src/test/java/com/github/copilot/AskUserTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/BuiltinPluginDirectoriesTest.java b/java/sdk/src/test/java/com/github/copilot/BuiltinPluginDirectoriesTest.java new file mode 100644 index 000000000..fa353e627 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/BuiltinPluginDirectoriesTest.java @@ -0,0 +1,128 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; +import java.nio.file.Path; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.github.copilot.rpc.CopilotClientOptions; + +class BuiltinPluginDirectoriesTest { + + @Test + void defaultAndEmptyDoNotCallRpc() throws Exception { + assertDoesNotCallRpc(new CopilotClientOptions()); + assertDoesNotCallRpc(new CopilotClientOptions().setBuiltinPluginDirectories(List.of())); + } + + @Test + void configuredDirectoriesCallRpcOnceBeforeStartCompletes() throws Exception { + var paths = List.of(Path.of("").toAbsolutePath().resolve("plugins/core"), + Path.of("").toAbsolutePath().resolve("plugins/github")); + + try (var server = new FakeRuntimeServer(); + var client = new CopilotClient( + new CopilotClientOptions().setCliUrl(server.url()).setBuiltinPluginDirectories(paths))) { + client.start().get(15, TimeUnit.SECONDS); + + assertEquals(1, server.builtinSetCount()); + JsonNode params = server.awaitBuiltinParams(); + assertEquals(paths.get(0).toString(), params.path("paths").get(0).asText()); + assertEquals(paths.get(1).toString(), params.path("paths").get(1).asText()); + } + } + + @Test + void relativeDirectoryIsRejected() { + assertThrows(IllegalArgumentException.class, + () -> new CopilotClientOptions().setBuiltinPluginDirectories(List.of(Path.of("plugins/core")))); + } + + private static void assertDoesNotCallRpc(CopilotClientOptions options) throws Exception { + try (var server = new FakeRuntimeServer(); var client = new CopilotClient(options.setCliUrl(server.url()))) { + client.start().get(15, TimeUnit.SECONDS); + assertEquals(0, server.builtinSetCount()); + } + } + + private static final class FakeRuntimeServer implements AutoCloseable { + + private final ServerSocket serverSocket; + private final Thread acceptThread; + private final CompletableFuture ready = new CompletableFuture<>(); + private final CompletableFuture builtinParams = new CompletableFuture<>(); + private final AtomicInteger builtinSetCount = new AtomicInteger(); + + FakeRuntimeServer() throws IOException { + serverSocket = new ServerSocket(0); + acceptThread = new Thread(this::acceptLoop, "builtin-plugin-runtime"); + acceptThread.setDaemon(true); + acceptThread.start(); + } + + String url() { + return "127.0.0.1:" + serverSocket.getLocalPort(); + } + + int builtinSetCount() { + return builtinSetCount.get(); + } + + JsonNode awaitBuiltinParams() throws Exception { + return builtinParams.get(15, TimeUnit.SECONDS); + } + + private void acceptLoop() { + try { + Socket socket = serverSocket.accept(); + JsonRpcClient server = JsonRpcClient.fromSocket(socket); + server.registerMethodHandler("connect", (id, params) -> respond(server, id, + Map.of("ok", true, "protocolVersion", 3, "version", "test"))); + server.registerMethodHandler("plugins.builtin.set", (id, params) -> { + builtinSetCount.incrementAndGet(); + builtinParams.complete(params); + respond(server, id, Map.of()); + }); + ready.complete(server); + } catch (IOException e) { + ready.completeExceptionally(e); + builtinParams.completeExceptionally(e); + } + } + + private static void respond(JsonRpcClient server, String id, Object result) { + if (id == null) { + return; + } + try { + server.sendResponse(id, result); + } catch (IOException e) { + // Connection teardown can race the response during test cleanup. + } + } + + @Override + public void close() throws Exception { + JsonRpcClient server = ready.getNow(null); + if (server != null) { + server.close(); + } + serverSocket.close(); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java new file mode 100644 index 000000000..b035bd54d --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ByokBearerTokenProviderE2ETest.java @@ -0,0 +1,278 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static com.github.copilot.CopilotRequestTestSupport.buildNonInferenceResponse; +import static com.github.copilot.CopilotRequestTestSupport.newLlmClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpHeaders; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import javax.net.ssl.SSLSession; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.BearerTokenProvider; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.NamedProviderConfig; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderModelConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * End-to-end coverage for the experimental BYOK bearer-token-provider surface + * ({@code BearerTokenProvider} on a provider config). The callback stays + * entirely on the SDK/client side: the SDK keeps it off the wire, sends only + * the {@code hasBearerTokenProvider} flag, and the runtime calls back over the + * session-scoped {@code providerToken.getToken} RPC before each outbound model + * request. + */ +public class ByokBearerTokenProviderE2ETest { + + private static final String PRIMARY_HOST = "byok-endpoint.invalid"; + private static final String PRIMARY_BASE_URL = "https://" + PRIMARY_HOST + "/v1"; + private static final String RED_HOST = "byok-red.invalid"; + private static final String RED_BASE_URL = "https://" + RED_HOST + "/v1"; + private static final String BLUE_HOST = "byok-blue.invalid"; + private static final String BLUE_BASE_URL = "https://" + BLUE_HOST + "/v1"; + + private static E2ETestContext ctx; + private CapturingRequestHandler handler; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @BeforeEach + void resetHandler() { + handler = new CapturingRequestHandler(); + } + + @Test + void appliesCallbackTokenAsAuthorizationHeader() throws Exception { + String sentinel = "sentinel-bearer-token-abc123"; + AtomicInteger calls = new AtomicInteger(); + BearerTokenProvider tokenProvider = args -> { + calls.incrementAndGet(); + return CompletableFuture.completedFuture(sentinel); + }; + + List providers = List.of(new NamedProviderConfig().setName("mi").setType("openai") + .setWireApi("completions").setBaseUrl(PRIMARY_BASE_URL).setBearerTokenProvider(tokenProvider)); + List models = List + .of(new ProviderModelConfig().setId("default").setProvider("mi").setWireModel("byok-gpt-4o")); + + runTurn(providers, models, "mi/default", "What is 5+5?"); + + assertTrue(handler.authHeaders().contains("Bearer " + sentinel), + "Expected captured Authorization headers to contain the callback token: " + handler.authHeaders()); + assertTrue(calls.get() >= 1, "Expected the callback to be invoked at least once"); + } + + @Test + void reacquiresFreshTokenForEachRequest() throws Exception { + AtomicInteger calls = new AtomicInteger(); + BearerTokenProvider tokenProvider = args -> CompletableFuture + .completedFuture("rotating-token-" + calls.incrementAndGet()); + + List providers = List.of(new NamedProviderConfig().setName("mi").setType("openai") + .setWireApi("completions").setBaseUrl(PRIMARY_BASE_URL).setBearerTokenProvider(tokenProvider)); + List models = List + .of(new ProviderModelConfig().setId("default").setProvider("mi").setWireModel("byok-gpt-4o")); + + runTurn(providers, models, "mi/default", "What is 1+1?"); + runTurn(providers, models, "mi/default", "What is 2+2?"); + + List auths = handler.authHeaders(); + assertTrue(auths.size() >= 2, "Expected at least two captured Authorization headers, got " + auths); + assertTrue(auths.get(0).startsWith("Bearer rotating-token-"), "Expected rotating token, got " + auths); + assertTrue(auths.get(1).startsWith("Bearer rotating-token-"), "Expected rotating token, got " + auths); + assertNotEquals(auths.get(0), auths.get(1), "Expected distinct tokens per request"); + assertTrue(calls.get() >= 2, "Expected the callback to be invoked at least twice"); + } + + @Test + void dispatchesTokenAcquisitionPerProvider() throws Exception { + List acquiredFor = new ArrayList<>(); + BearerTokenProvider redCallback = args -> { + assertEquals("red", args.getProviderName(), "Expected providerName to be forwarded"); + assertTrue(args.getSessionId() != null && !args.getSessionId().isEmpty(), + "Expected a non-empty session id in token args"); + synchronized (acquiredFor) { + acquiredFor.add("red"); + } + return CompletableFuture.completedFuture("token-for-red"); + }; + BearerTokenProvider blueCallback = args -> { + assertEquals("blue", args.getProviderName(), "Expected providerName to be forwarded"); + assertTrue(args.getSessionId() != null && !args.getSessionId().isEmpty(), + "Expected a non-empty session id in token args"); + synchronized (acquiredFor) { + acquiredFor.add("blue"); + } + return CompletableFuture.completedFuture("token-for-blue"); + }; + + List providers = List.of( + new NamedProviderConfig().setName("red").setType("openai").setWireApi("completions") + .setBaseUrl(RED_BASE_URL).setBearerTokenProvider(redCallback), + new NamedProviderConfig().setName("blue").setType("openai").setWireApi("completions") + .setBaseUrl(BLUE_BASE_URL).setBearerTokenProvider(blueCallback)); + List models = List.of( + new ProviderModelConfig().setId("default").setProvider("red").setWireModel("byok-gpt-4o"), + new ProviderModelConfig().setId("default").setProvider("blue").setWireModel("byok-gpt-4o")); + + runTurn(providers, models, "red/default", "What is 3+3?"); + runTurn(providers, models, "blue/default", "What is 4+4?"); + + assertEquals("Bearer token-for-red", handler.authHeaderForHost(RED_HOST)); + assertEquals("Bearer token-for-blue", handler.authHeaderForHost(BLUE_HOST)); + synchronized (acquiredFor) { + assertTrue(acquiredFor.contains("red"), "Expected red provider to acquire a token"); + assertTrue(acquiredFor.contains("blue"), "Expected blue provider to acquire a token"); + } + } + + private void runTurn(List providers, List models, String selectionId, + String prompt) throws Exception { + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setModel(selectionId).setProviders(providers).setModels(models)) + .get(60, TimeUnit.SECONDS); + try { + session.sendAndWait(new MessageOptions().setPrompt(prompt)).get(60, TimeUnit.SECONDS); + } catch (Exception ignored) { + // The fake BYOK endpoint returns 404 after capturing the token-bearing request. + } finally { + try { + session.close(); + } catch (Exception ignored) { + // Ignore disconnect errors for the fake BYOK endpoint. + } + } + } + } + + private static final class CapturingRequestHandler extends CopilotRequestHandler { + + private final ConcurrentLinkedQueue captures = new ConcurrentLinkedQueue<>(); + + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext rctx) + throws Exception { + String host = request.uri().getHost(); + if (host != null && host.endsWith(".invalid")) { + captures.add(new CapturedRequest(request.uri().getHost(), + request.headers().firstValue("Authorization").orElse(null))); + return new StubHttpResponse(404, "{\"error\":{\"message\":\"fake byok endpoint\"}}"); + } + return buildNonInferenceResponse(request.uri().toString()); + } + + List authHeaders() { + List auths = new ArrayList<>(); + for (CapturedRequest capture : captures) { + if (capture.authorization() != null) { + auths.add(capture.authorization()); + } + } + return auths; + } + + String authHeaderForHost(String host) { + for (CapturedRequest capture : captures) { + if (host.equals(capture.host())) { + return capture.authorization(); + } + } + return null; + } + } + + private static final class StubHttpResponse implements HttpResponse { + + private final int status; + private final HttpHeaders headers; + private final byte[] body; + + StubHttpResponse(int status, String body) { + this.status = status; + this.body = body.getBytes(StandardCharsets.UTF_8); + this.headers = HttpHeaders.of(Map.of("content-type", List.of("application/json")), (k, v) -> true); + } + + @Override + public int statusCode() { + return status; + } + + @Override + public HttpRequest request() { + return null; + } + + @Override + public Optional> previousResponse() { + return Optional.empty(); + } + + @Override + public HttpHeaders headers() { + return headers; + } + + @Override + public InputStream body() { + return new ByteArrayInputStream(body); + } + + @Override + public Optional sslSession() { + return Optional.empty(); + } + + @Override + public URI uri() { + return null; + } + + @Override + public HttpClient.Version version() { + return HttpClient.Version.HTTP_1_1; + } + } + + private record CapturedRequest(String host, String authorization) { + } +} diff --git a/java/src/test/java/com/github/copilot/CapiProxy.java b/java/sdk/src/test/java/com/github/copilot/CapiProxy.java similarity index 85% rename from java/src/test/java/com/github/copilot/CapiProxy.java rename to java/sdk/src/test/java/com/github/copilot/CapiProxy.java index 90c2dd0a7..53d5e1166 100644 --- a/java/src/test/java/com/github/copilot/CapiProxy.java +++ b/java/sdk/src/test/java/com/github/copilot/CapiProxy.java @@ -93,9 +93,10 @@ public String start() throws IOException, InterruptedException { // Start the harness server using npx tsx // On Windows, npx is installed as npx.cmd which requires cmd /c to launch boolean isWindows = System.getProperty("os.name").toLowerCase().contains("win"); + String npxPath = resolveCommand(isWindows ? "npx.cmd" : "npx"); var pb = isWindows - ? new ProcessBuilder("cmd", "/c", "npx", "tsx", "server.ts") - : new ProcessBuilder("npx", "tsx", "server.ts"); + ? new ProcessBuilder(System.getenv("COMSPEC"), "/c", npxPath, "tsx", "server.ts") + : new ProcessBuilder(npxPath, "tsx", "server.ts"); pb.directory(harnessDir.toFile()); pb.redirectErrorStream(false); // Tell the replaying proxy to fail fast on unmatched requests rather than @@ -290,6 +291,53 @@ public void setCopilotUserByToken(String token, String login, String copilotPlan } } + /** + * Registers a raw Copilot user response for a given token on the + * {@code /copilot_internal/user} endpoint. + * + *

+ * Unlike + * {@link #setCopilotUserByToken(String, String, String, String, String, String)}, + * this posts the response object verbatim, so callers control the exact field + * names the proxy returns to the CLI. This matters because the CLI reads + * snake_case fields (e.g. {@code copilot_plan}, {@code is_mcp_enabled}) from + * the raw user JSON to gate MCP enablement. Use this to register the default + * e2e user with the same snake_case shape the Go, Node, Python, and .NET + * harnesses post, keeping MCP behavior hermetic and consistent across SDKs. + *

+ * + * @param token + * the GitHub token to configure + * @param response + * the raw user response object to return for the token (field names + * are sent verbatim) + * @throws IOException + * if the request fails + * @throws InterruptedException + * if the request is interrupted + */ + public void setCopilotUserByToken(String token, Map response) + throws IOException, InterruptedException { + if (proxyUrl == null) { + throw new IllegalStateException("Proxy not started"); + } + + Map payload = new java.util.HashMap<>(); + payload.put("token", token); + payload.put("response", response); + + String body = MAPPER.writeValueAsString(payload); + + HttpRequest request = HttpRequest.newBuilder().uri(URI.create(proxyUrl + "/copilot-user-config")) + .header("Content-Type", "application/json").POST(HttpRequest.BodyPublishers.ofString(body)).build(); + + HttpResponse response2 = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + if (response2.statusCode() != 200) { + throw new IOException( + "Failed to set copilot user config: " + response2.statusCode() + ": " + response2.body()); + } + } + /** * Stops the proxy server gracefully. * @@ -469,6 +517,24 @@ private Path findHarnessDirectory() { return null; } + /** + * Resolves a command name to its absolute path by searching the system + * {@code PATH}. Falls back to the original name if not found. + */ + private static String resolveCommand(String command) { + String pathEnv = System.getenv("PATH"); + if (pathEnv == null) { + return command; + } + for (String dir : pathEnv.split(java.io.File.pathSeparator)) { + Path candidate = Path.of(dir, command); + if (java.nio.file.Files.isExecutable(candidate)) { + return candidate.toAbsolutePath().toString(); + } + } + return command; + } + /** * Test information record for configuring the proxy. */ diff --git a/java/sdk/src/test/java/com/github/copilot/CapiSessionOptionsTest.java b/java/sdk/src/test/java/com/github/copilot/CapiSessionOptionsTest.java new file mode 100644 index 000000000..17e8f131f --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CapiSessionOptionsTest.java @@ -0,0 +1,131 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; + +import com.github.copilot.rpc.CapiSessionOptions; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * Tests for CAPI provider-scoped session options. + */ +class CapiSessionOptionsTest { + + @Test + void defaultsAreNull() { + var capi = new CapiSessionOptions(); + + assertNull(capi.getEnableWebSocketResponses()); + } + + @Test + void fluentSetterReturnsSameInstance() { + var capi = new CapiSessionOptions(); + + assertSame(capi, capi.setEnableWebSocketResponses(true)); + assertEquals(Boolean.TRUE, capi.getEnableWebSocketResponses()); + } + + @Test + void serializesEnableWebSocketResponses() { + var capi = new CapiSessionOptions().setEnableWebSocketResponses(true); + + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(capi); + + assertTrue(json.get("enableWebSocketResponses").asBoolean()); + } + + @Test + void omitsUnsetEnableWebSocketResponses() { + var capi = new CapiSessionOptions(); + + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(capi); + + assertTrue(json.path("enableWebSocketResponses").isMissingNode()); + assertEquals(0, json.size()); + } + + @Test + void createRequestIncludesCapiWhenSet() { + var config = new SessionConfig().setCapi(new CapiSessionOptions().setEnableWebSocketResponses(true)); + + var request = SessionRequestBuilder.buildCreateRequest(config, "session-1"); + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(request); + + assertNotNull(request.getCapi()); + assertTrue(json.get("capi").get("enableWebSocketResponses").asBoolean()); + } + + @Test + void createRequestOmitsCapiWhenUnset() { + var config = new SessionConfig(); + + var request = SessionRequestBuilder.buildCreateRequest(config, "session-1"); + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(request); + + assertNull(request.getCapi()); + assertTrue(json.path("capi").isMissingNode()); + } + + @Test + void resumeRequestIncludesCapiWhenSet() { + var config = new ResumeSessionConfig().setCapi(new CapiSessionOptions().setEnableWebSocketResponses(true)); + + var request = SessionRequestBuilder.buildResumeRequest("session-1", config); + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(request); + + assertNotNull(request.getCapi()); + assertTrue(json.get("capi").get("enableWebSocketResponses").asBoolean()); + } + + @Test + void resumeRequestOmitsCapiWhenUnset() { + var config = new ResumeSessionConfig(); + + var request = SessionRequestBuilder.buildResumeRequest("session-1", config); + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(request); + + assertNull(request.getCapi()); + assertTrue(json.path("capi").isMissingNode()); + } + + @Test + void sessionConfigCloneCopiesCapiReference() { + var capi = new CapiSessionOptions().setEnableWebSocketResponses(true); + + var clone = new SessionConfig().setCapi(capi).clone(); + + assertSame(capi, clone.getCapi()); + } + + @Test + void resumeSessionConfigCloneCopiesCapiReference() { + var capi = new CapiSessionOptions().setEnableWebSocketResponses(true); + + var clone = new ResumeSessionConfig().setCapi(capi).clone(); + + assertSame(capi, clone.getCapi()); + } + + @Test + void falseValueIsSerializedWhenExplicitlySet() { + var capi = new CapiSessionOptions().setEnableWebSocketResponses(false); + + JsonNode json = JsonRpcClient.getObjectMapper().valueToTree(capi); + + assertFalse(json.get("enableWebSocketResponses").asBoolean()); + } +} diff --git a/java/src/test/java/com/github/copilot/CliServerManagerTest.java b/java/sdk/src/test/java/com/github/copilot/CliServerManagerTest.java similarity index 95% rename from java/src/test/java/com/github/copilot/CliServerManagerTest.java rename to java/sdk/src/test/java/com/github/copilot/CliServerManagerTest.java index 2df5dafab..68555a35b 100644 --- a/java/src/test/java/com/github/copilot/CliServerManagerTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CliServerManagerTest.java @@ -70,18 +70,13 @@ void connectToServerTcpMode() throws Exception { } } - private static Process startBlockingProcess() throws IOException { - boolean isWindows = System.getProperty("os.name").toLowerCase().contains("windows"); - return (isWindows ? new ProcessBuilder("cmd", "/c", "more") : new ProcessBuilder("cat")).start(); - } - @Test void connectToServerStdioMode() throws Exception { var options = new CopilotClientOptions(); var manager = new CliServerManager(options); // Create a dummy process for stdio mode - Process process = startBlockingProcess(); + Process process = new TestProcess(); try { JsonRpcClient client = manager.connectToServer(process, null, null); assertNotNull(client); @@ -231,8 +226,9 @@ void startCliServerWithNullCliPath() throws Exception { void startCliServerWithTelemetryAllOptions() throws Exception { // The telemetry env vars are applied before ProcessBuilder.start() // so even with a nonexistent CLI path, the telemetry code path is exercised - var telemetry = new TelemetryConfig().setOtlpEndpoint("http://localhost:4318").setFilePath("/tmp/telemetry.log") - .setExporterType("otlp-http").setSourceName("test-app").setCaptureContent(true); + var telemetry = new TelemetryConfig().setOtlpEndpoint("http://localhost:4318").setOtlpProtocol("http/protobuf") + .setFilePath("/tmp/telemetry.log").setExporterType("otlp-http").setSourceName("test-app") + .setCaptureContent(true); var options = new CopilotClientOptions().setCliPath(NONEXISTENT_CLI).setTelemetry(telemetry).setUseStdio(true); var manager = new CliServerManager(options); diff --git a/java/sdk/src/test/java/com/github/copilot/ClientOptionsE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ClientOptionsE2ETest.java new file mode 100644 index 000000000..45056afdb --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ClientOptionsE2ETest.java @@ -0,0 +1,302 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.SessionLimitsConfig; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +class ClientOptionsE2ETest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @Test + void testShouldForwardAdvancedSessionCreationOptionsToTheCli() throws Exception { + try (var fake = FakeStdioCli.create()) { + var workDir = fake.path("create-work"); + var configDir = fake.path("create-config"); + + try (var client = fake.createClient()) { + var session = client.createSession(new SessionConfig().setSessionId("java-create-session") + .setClientName("java-e2e-client").setModel("gpt-5-mini").setReasoningEffort("low") + .setReasoningSummary("none").setContextTier("long_context") + .setAvailableTools(java.util.List.of("bash")).setExcludedTools(java.util.List.of("grep")) + .setExcludedBuiltInAgents(java.util.List.of("explore")).setEnableSessionTelemetry(true) + .setEnableCitations(true).setSessionLimits(new SessionLimitsConfig(42.0)) + .setWorkingDirectory(workDir.toString()).setStreaming(true) + .setIncludeSubAgentStreamingEvents(true).setConfigDirectory(configDir.toString()) + .setEnableConfigDiscovery(false).setSkipEmbeddingRetrieval(true) + .setOrganizationCustomInstructions("Use Java parity instructions.") + .setEnableOnDemandInstructionDiscovery(false).setEnableFileHooks(true) + .setEnableHostGitOperations(false).setEnableSessionStore(true).setEnableSkills(false) + .setEmbeddingCacheStorage("in-memory").setGitHubToken("java-session-token") + .setRemoteSession("export").setSkipCustomInstructions(true).setCustomAgentsLocalOnly(false) + .setCoauthorEnabled(true).setManageScheduleEnabled(true) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + session.close(); + } + + var create = fake.capturedRequest("session.create").path("params"); + assertEquals("java-create-session", create.path("sessionId").asText()); + assertEquals("java-e2e-client", create.path("clientName").asText()); + assertEquals("gpt-5-mini", create.path("model").asText()); + assertEquals("low", create.path("reasoningEffort").asText()); + assertEquals("none", create.path("reasoningSummary").asText()); + assertEquals("long_context", create.path("contextTier").asText()); + assertEquals("bash", create.path("availableTools").get(0).asText()); + assertEquals("grep", create.path("excludedTools").get(0).asText()); + assertEquals("explore", create.path("excludedBuiltinAgents").get(0).asText()); + assertTrue(create.path("enableSessionTelemetry").asBoolean()); + assertTrue(create.path("enableCitations").asBoolean()); + assertEquals(42.0, create.path("sessionLimits").path("maxAiCredits").asDouble()); + assertEquals(workDir.toString(), create.path("workingDirectory").asText()); + assertTrue(create.path("streaming").asBoolean()); + assertTrue(create.path("includeSubAgentStreamingEvents").asBoolean()); + assertEquals(configDir.toString(), create.path("configDir").asText()); + assertFalse(create.path("enableConfigDiscovery").asBoolean()); + assertTrue(create.path("skipEmbeddingRetrieval").asBoolean()); + assertEquals("Use Java parity instructions.", create.path("organizationCustomInstructions").asText()); + assertFalse(create.path("enableOnDemandInstructionDiscovery").asBoolean()); + assertTrue(create.path("enableFileHooks").asBoolean()); + assertFalse(create.path("enableHostGitOperations").asBoolean()); + assertTrue(create.path("enableSessionStore").asBoolean()); + assertFalse(create.path("enableSkills").asBoolean()); + assertEquals("in-memory", create.path("embeddingCacheStorage").asText()); + assertEquals("java-session-token", create.path("gitHubToken").asText()); + assertEquals("export", create.path("remoteSession").asText()); + assertEquals("direct", create.path("envValueMode").asText()); + assertTrue(create.path("requestPermission").asBoolean()); + + var update = fake.capturedRequest("session.options.update").path("params"); + assertEquals("java-create-session", update.path("sessionId").asText()); + assertTrue(update.path("skipCustomInstructions").asBoolean()); + assertFalse(update.path("customAgentsLocalOnly").asBoolean()); + assertTrue(update.path("coauthorEnabled").asBoolean()); + assertTrue(update.path("manageScheduleEnabled").asBoolean()); + } + } + + @Test + void testShouldForwardSingularProviderConfigurationOnSessionCreation() throws Exception { + try (var fake = FakeStdioCli.create()) { + try (var client = fake.createClient()) { + var session = client.createSession(new SessionConfig() + .setProvider(new ProviderConfig().setType("openai").setWireApi("responses") + .setTransport("websockets").setBaseUrl("https://models.example.test/v1") + .setApiKey("provider-key").setModelId("base-model").setWireModel("wire-model") + .setMaxPromptTokens(1000).setMaxOutputTokens(2000) + .setHeaders(Map.of("x-provider", "java"))) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + session.close(); + } + + var provider = fake.capturedRequest("session.create").path("params").path("provider"); + assertEquals("openai", provider.path("type").asText()); + assertEquals("responses", provider.path("wireApi").asText()); + assertEquals("websockets", provider.path("transport").asText()); + assertEquals("https://models.example.test/v1", provider.path("baseUrl").asText()); + assertEquals("provider-key", provider.path("apiKey").asText()); + assertEquals("base-model", provider.path("modelId").asText()); + assertEquals("wire-model", provider.path("wireModel").asText()); + assertEquals(1000, provider.path("maxPromptTokens").asInt()); + assertEquals(2000, provider.path("maxOutputTokens").asInt()); + assertEquals("java", provider.path("headers").path("x-provider").asText()); + } + } + + @Test + void testShouldForwardAdvancedSessionResumeOptionsToTheCli() throws Exception { + try (var fake = FakeStdioCli.create()) { + var workDir = fake.path("resume-work"); + var configDir = fake.path("resume-config"); + + try (var client = fake.createClient()) { + client.createSession(new SessionConfig().setSessionId("java-resume-session") + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + var session = client.resumeSession("java-resume-session", + new ResumeSessionConfig().setClientName("java-resume-client").setModel("gpt-5-mini") + .setReasoningEffort("medium").setReasoningSummary("none").setContextTier("long_context") + .setEnableCitations(true).setSessionLimits(new SessionLimitsConfig(84.0)) + .setWorkingDirectory(workDir.toString()).setConfigDirectory(configDir.toString()) + .setEnableConfigDiscovery(false).setSkipEmbeddingRetrieval(true) + .setOrganizationCustomInstructions("Use resumed Java instructions.") + .setEnableOnDemandInstructionDiscovery(false).setEnableFileHooks(true) + .setEnableHostGitOperations(false).setEnableSessionStore(true).setEnableSkills(false) + .setEmbeddingCacheStorage("in-memory").setGitHubToken("java-resume-token") + .setRemoteSession("export").setSkipCustomInstructions(false) + .setCustomAgentsLocalOnly(true).setCoauthorEnabled(false).setManageScheduleEnabled(true) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS); + session.close(); + } + + var resume = fake.capturedRequest("session.resume").path("params"); + assertEquals("java-resume-session", resume.path("sessionId").asText()); + assertEquals("java-resume-client", resume.path("clientName").asText()); + assertEquals("gpt-5-mini", resume.path("model").asText()); + assertEquals("medium", resume.path("reasoningEffort").asText()); + assertEquals("none", resume.path("reasoningSummary").asText()); + assertEquals("long_context", resume.path("contextTier").asText()); + assertTrue(resume.path("enableCitations").asBoolean()); + assertEquals(84.0, resume.path("sessionLimits").path("maxAiCredits").asDouble()); + assertEquals(workDir.toString(), resume.path("workingDirectory").asText()); + assertEquals(configDir.toString(), resume.path("configDir").asText()); + assertFalse(resume.path("enableConfigDiscovery").asBoolean()); + assertTrue(resume.path("skipEmbeddingRetrieval").asBoolean()); + assertEquals("Use resumed Java instructions.", resume.path("organizationCustomInstructions").asText()); + assertFalse(resume.path("enableOnDemandInstructionDiscovery").asBoolean()); + assertTrue(resume.path("enableFileHooks").asBoolean()); + assertFalse(resume.path("enableHostGitOperations").asBoolean()); + assertTrue(resume.path("enableSessionStore").asBoolean()); + assertFalse(resume.path("enableSkills").asBoolean()); + assertEquals("in-memory", resume.path("embeddingCacheStorage").asText()); + assertEquals("java-resume-token", resume.path("gitHubToken").asText()); + assertEquals("export", resume.path("remoteSession").asText()); + assertEquals("direct", resume.path("envValueMode").asText()); + assertTrue(resume.path("requestPermission").asBoolean()); + + var update = fake.capturedRequest("session.options.update").path("params"); + assertEquals("java-resume-session", update.path("sessionId").asText()); + assertFalse(update.path("skipCustomInstructions").asBoolean()); + assertTrue(update.path("customAgentsLocalOnly").asBoolean()); + assertFalse(update.path("coauthorEnabled").asBoolean()); + assertTrue(update.path("manageScheduleEnabled").asBoolean()); + } + } + + private record FakeStdioCli(Path dir, Path script, Path capture, Path workDir) implements AutoCloseable { + + static FakeStdioCli create() throws IOException { + var dir = Files.createTempDirectory("java-fake-copilot-cli-"); + var script = dir.resolve("fake-copilot-cli.js"); + var capture = dir.resolve("capture.json"); + var workDir = dir.resolve("work"); + Files.createDirectories(workDir); + Files.writeString(capture, "{\"requests\":[]}"); + Files.writeString(script, FAKE_STDIO_CLI_SCRIPT); + return new FakeStdioCli(dir, script, capture, workDir); + } + + CopilotClient createClient() { + var options = new CopilotClientOptions().setCliPath(script.toString()) + .setCliArgs(new String[]{"--capture-file", capture.toString()}).setCwd(workDir.toString()) + .setUseLoggedInUser(false); + return new CopilotClient(options); + } + + Path path(String name) throws IOException { + var path = workDir.resolve(name); + Files.createDirectories(path); + return path; + } + + JsonNode capturedRequest(String method) throws IOException { + for (JsonNode request : MAPPER.readTree(Files.readString(capture)).path("requests")) { + if (method.equals(request.path("method").asText())) { + return request; + } + } + fail("Expected captured request for " + method + " in " + Files.readString(capture)); + return null; + } + + @Override + public void close() throws IOException { + if (Files.exists(dir)) { + try (var paths = Files.walk(dir)) { + paths.sorted(Comparator.reverseOrder()).forEach(path -> { + try { + Files.deleteIfExists(path); + } catch (IOException ignored) { + } + }); + } + } + } + } + + private static final String FAKE_STDIO_CLI_SCRIPT = """ + const fs = require('fs'); + + const captureFileIndex = process.argv.indexOf('--capture-file'); + const captureFile = process.argv[captureFileIndex + 1]; + const capture = { requests: [] }; + fs.writeFileSync(captureFile, JSON.stringify(capture)); + + let buffer = Buffer.alloc(0); + + function persist() { + fs.writeFileSync(captureFile, JSON.stringify(capture)); + } + + function send(message) { + const body = Buffer.from(JSON.stringify(message), 'utf8'); + process.stdout.write(`Content-Length: ${body.length}\\r\\n\\r\\n`); + process.stdout.write(body); + } + + function resultFor(message) { + switch (message.method) { + case 'connect': + return { ok: true, protocolVersion: 3, version: 'fake' }; + case 'llmInference.setProvider': + return {}; + case 'session.create': + return { sessionId: message.params?.sessionId ?? 'fake-session', openCanvases: [] }; + case 'session.resume': + return { sessionId: message.params?.sessionId ?? 'fake-session', openCanvases: [] }; + case 'session.options.update': + return { success: true }; + default: + return {}; + } + } + + function handle(message) { + capture.requests.push({ method: message.method, params: message.params ?? null }); + persist(); + send({ jsonrpc: '2.0', id: message.id, result: resultFor(message) }); + } + + process.stdin.on('data', chunk => { + buffer = Buffer.concat([buffer, chunk]); + while (true) { + const headerEnd = buffer.indexOf('\\r\\n\\r\\n'); + if (headerEnd < 0) { + return; + } + const header = buffer.subarray(0, headerEnd).toString('utf8'); + const match = /Content-Length:\\s*(\\d+)/i.exec(header); + if (!match) { + throw new Error(`Missing Content-Length in ${header}`); + } + const length = Number(match[1]); + const bodyStart = headerEnd + 4; + if (buffer.length < bodyStart + length) { + return; + } + const body = buffer.subarray(bodyStart, bodyStart + length).toString('utf8'); + buffer = buffer.subarray(bodyStart + length); + handle(JSON.parse(body)); + } + }); + """; +} diff --git a/java/src/test/java/com/github/copilot/ClosedSessionGuardTest.java b/java/sdk/src/test/java/com/github/copilot/ClosedSessionGuardTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ClosedSessionGuardTest.java rename to java/sdk/src/test/java/com/github/copilot/ClosedSessionGuardTest.java diff --git a/java/src/test/java/com/github/copilot/CommandsTest.java b/java/sdk/src/test/java/com/github/copilot/CommandsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CommandsTest.java rename to java/sdk/src/test/java/com/github/copilot/CommandsTest.java diff --git a/java/src/test/java/com/github/copilot/CompactionTest.java b/java/sdk/src/test/java/com/github/copilot/CompactionTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CompactionTest.java rename to java/sdk/src/test/java/com/github/copilot/CompactionTest.java diff --git a/java/src/test/java/com/github/copilot/ConfigCloneTest.java b/java/sdk/src/test/java/com/github/copilot/ConfigCloneTest.java similarity index 85% rename from java/src/test/java/com/github/copilot/ConfigCloneTest.java rename to java/sdk/src/test/java/com/github/copilot/ConfigCloneTest.java index 81c937dbe..4c5a3fbef 100644 --- a/java/src/test/java/com/github/copilot/ConfigCloneTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ConfigCloneTest.java @@ -16,12 +16,14 @@ import org.junit.jupiter.api.Test; import com.github.copilot.generated.SessionEvent; +import com.github.copilot.generated.rpc.SessionLimitsConfig; import com.github.copilot.rpc.AutoModeSwitchResponse; import com.github.copilot.rpc.CopilotClientOptions; import com.github.copilot.rpc.DefaultAgentConfig; import com.github.copilot.rpc.ExitPlanModeResult; import com.github.copilot.rpc.InfiniteSessionConfig; import com.github.copilot.rpc.LargeToolOutputConfig; +import com.github.copilot.rpc.MemoryConfiguration; import com.github.copilot.rpc.MessageOptions; import com.github.copilot.rpc.ModelInfo; import com.github.copilot.rpc.ResumeSessionConfig; @@ -118,8 +120,10 @@ void sessionConfigCloneBasic() { original.setReasoningSummary("detailed"); original.setContextTier("long_context"); original.setPluginDirectories(List.of("/plugins/a", "/plugins/b")); + original.setDisabledMcpServers(List.of("local-files", "remote-github")); original.setLargeOutput( new LargeToolOutputConfig().setEnabled(true).setMaxSizeBytes(1024L).setOutputDirectory("/tmp/out")); + original.setMemory(new MemoryConfiguration().setEnabled(true)); original.setStreaming(true); SessionConfig cloned = original.clone(); @@ -130,7 +134,9 @@ void sessionConfigCloneBasic() { assertEquals(original.getReasoningSummary(), cloned.getReasoningSummary()); assertEquals(original.getContextTier(), cloned.getContextTier()); assertEquals(original.getPluginDirectories(), cloned.getPluginDirectories()); + assertEquals(original.getDisabledMcpServers(), cloned.getDisabledMcpServers()); assertEquals(original.getLargeOutput(), cloned.getLargeOutput()); + assertEquals(original.getMemory(), cloned.getMemory()); assertEquals(original.isStreaming(), cloned.isStreaming()); } @@ -142,6 +148,7 @@ void sessionConfigListIndependence() { toolList.add("bash"); original.setAvailableTools(toolList); original.setInstructionDirectories(new ArrayList<>(List.of("/path/a", "/path/b"))); + original.setDisabledMcpServers(new ArrayList<>(List.of("local-files"))); SessionConfig cloned = original.clone(); @@ -152,6 +159,7 @@ void sessionConfigListIndependence() { assertEquals(2, cloned.getAvailableTools().size()); assertEquals(3, original.getAvailableTools().size()); assertEquals(List.of("/path/a", "/path/b"), cloned.getInstructionDirectories()); + assertEquals(List.of("local-files"), cloned.getDisabledMcpServers()); } @Test @@ -168,6 +176,22 @@ void sessionConfigAgentAndOnEventCloned() { assertSame(handler, cloned.getOnEvent()); } + @Test + void sessionConfigSessionPolicyOptionsCloned() { + var sessionLimits = new SessionLimitsConfig(30.0); + var excludedAgents = new ArrayList<>(List.of("explore")); + SessionConfig original = new SessionConfig().setExcludedBuiltInAgents(excludedAgents).setEnableCitations(true) + .setEnableFileChangeTracking(true).setSessionLimits(sessionLimits); + + SessionConfig cloned = original.clone(); + excludedAgents.add("task"); + + assertEquals(List.of("explore"), cloned.getExcludedBuiltInAgents()); + assertTrue(cloned.getEnableCitations().orElse(false)); + assertTrue(cloned.getEnableFileChangeTracking().orElse(false)); + assertSame(sessionLimits, cloned.getSessionLimits()); + } + @Test void resumeSessionConfigCloneBasic() { ResumeSessionConfig original = new ResumeSessionConfig(); @@ -175,8 +199,10 @@ void resumeSessionConfigCloneBasic() { original.setReasoningSummary("none"); original.setContextTier("long_context"); original.setPluginDirectories(List.of("/plugins/r")); + original.setDisabledMcpServers(List.of("local-files-r")); original.setLargeOutput( new LargeToolOutputConfig().setEnabled(false).setMaxSizeBytes(2048L).setOutputDirectory("/tmp/resume")); + original.setMemory(new MemoryConfiguration().setEnabled(false)); original.setStreaming(false); ResumeSessionConfig cloned = original.clone(); @@ -185,7 +211,9 @@ void resumeSessionConfigCloneBasic() { assertEquals(original.getReasoningSummary(), cloned.getReasoningSummary()); assertEquals(original.getContextTier(), cloned.getContextTier()); assertEquals(original.getPluginDirectories(), cloned.getPluginDirectories()); + assertEquals(original.getDisabledMcpServers(), cloned.getDisabledMcpServers()); assertEquals(original.getLargeOutput(), cloned.getLargeOutput()); + assertEquals(original.getMemory(), cloned.getMemory()); assertEquals(original.isStreaming(), cloned.isStreaming()); } @@ -203,6 +231,22 @@ void resumeSessionConfigAgentAndOnEventCloned() { assertSame(handler, cloned.getOnEvent()); } + @Test + void resumeSessionConfigSessionPolicyOptionsCloned() { + var sessionLimits = new SessionLimitsConfig(30.0); + var excludedAgents = new ArrayList<>(List.of("explore")); + ResumeSessionConfig original = new ResumeSessionConfig().setExcludedBuiltInAgents(excludedAgents) + .setEnableCitations(true).setEnableFileChangeTracking(true).setSessionLimits(sessionLimits); + + ResumeSessionConfig cloned = original.clone(); + excludedAgents.add("task"); + + assertEquals(List.of("explore"), cloned.getExcludedBuiltInAgents()); + assertTrue(cloned.getEnableCitations().orElse(false)); + assertTrue(cloned.getEnableFileChangeTracking().orElse(false)); + assertSame(sessionLimits, cloned.getSessionLimits()); + } + @Test void messageOptionsCloneBasic() { MessageOptions original = new MessageOptions(); @@ -341,6 +385,15 @@ void copilotClientOptionsSetEnvironmentNullClearsExisting() { assertTrue(env == null || env.isEmpty()); } + @Test + void copilotClientOptionsSetCwdNullClearsExisting() { + CopilotClientOptions opts = new CopilotClientOptions().setCwd("/tmp"); + + opts.setCwd(null); + + assertNull(opts.getCwd()); + } + @Test @SuppressWarnings("deprecation") void copilotClientOptionsDeprecatedGithubToken() { @@ -404,12 +457,15 @@ void resumeSessionConfigAllSetters() { void sessionConfigNewFieldsCloned() { SessionConfig original = new SessionConfig(); original.setGitHubToken("ghp_per_session_token"); + original.setAdditionalDirectories(new java.util.ArrayList<>(List.of("/repo/shared"))); DefaultAgentConfig defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); original.setDefaultAgent(defaultAgent); SessionConfig cloned = original.clone(); assertEquals("ghp_per_session_token", cloned.getGitHubToken()); + assertEquals(List.of("/repo/shared"), cloned.getAdditionalDirectories()); + assertNotSame(original.getAdditionalDirectories(), cloned.getAdditionalDirectories()); assertSame(defaultAgent, cloned.getDefaultAgent()); } @@ -417,12 +473,15 @@ void sessionConfigNewFieldsCloned() { void resumeSessionConfigNewFieldsCloned() { ResumeSessionConfig original = new ResumeSessionConfig(); original.setGitHubToken("ghp_per_session_token"); + original.setAdditionalDirectories(new java.util.ArrayList<>(List.of("/repo/resumed"))); DefaultAgentConfig defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); original.setDefaultAgent(defaultAgent); ResumeSessionConfig cloned = original.clone(); assertEquals("ghp_per_session_token", cloned.getGitHubToken()); + assertEquals(List.of("/repo/resumed"), cloned.getAdditionalDirectories()); + assertNotSame(original.getAdditionalDirectories(), cloned.getAdditionalDirectories()); assertSame(defaultAgent, cloned.getDefaultAgent()); } diff --git a/java/src/test/java/com/github/copilot/CopilotClientModeTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotClientModeTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/CopilotClientModeTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotClientModeTest.java diff --git a/java/src/test/java/com/github/copilot/CopilotClientTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotClientTest.java similarity index 83% rename from java/src/test/java/com/github/copilot/CopilotClientTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotClientTest.java index 1d6bfc704..067571df1 100644 --- a/java/src/test/java/com/github/copilot/CopilotClientTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CopilotClientTest.java @@ -16,11 +16,15 @@ import java.lang.reflect.Field; import java.util.ArrayList; +import java.util.Map; +import java.util.Optional; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; import static org.junit.jupiter.api.Assertions.*; -import java.util.Optional; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; /** * Tests for CopilotClient. @@ -38,6 +42,75 @@ static void setup() { cliPath = TestUtil.findCliPath(); } + @Test + void testStopRequestsRuntimeShutdownForOwnedProcess() throws Exception { + var client = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); + var rpc = mock(JsonRpcClient.class); + when(rpc.invoke(eq("runtime.shutdown"), any(), eq(Void.class))) + .thenReturn(CompletableFuture.completedFuture(null)); + var process = mock(Process.class); + when(process.isAlive()).thenReturn(true); + when(process.waitFor(anyLong(), any(TimeUnit.class))).thenReturn(true); + + setConnectionFuture(client, rpc, process); + + client.stop().get(); + + verify(rpc).invoke(eq("runtime.shutdown"), eq(Map.of()), eq(Void.class)); + verify(rpc).close(); + // The runtime never self-exits after runtime.shutdown (it keeps its + // JSON-RPC server alive to send the response and leaves termination to + // the caller), so stop() terminates the owned process. The mocked + // process exits on the first SIGTERM (waitFor returns true), so we + // never escalate to destroyForcibly(). + verify(process).destroy(); + verify(process, never()).destroyForcibly(); + } + + @Test + void testStopDoesNotThrowWhenRuntimeShutdownFails() throws Exception { + var client = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); + var rpc = mock(JsonRpcClient.class); + when(rpc.invoke(eq("runtime.shutdown"), any(), eq(Void.class))) + .thenReturn(CompletableFuture.failedFuture(new RuntimeException("shutdown failed"))); + var process = mock(Process.class); + when(process.isAlive()).thenReturn(true); + when(process.destroyForcibly()).thenReturn(process); + when(process.waitFor(anyLong(), any(TimeUnit.class))).thenReturn(true); + + setConnectionFuture(client, rpc, process); + + assertDoesNotThrow(() -> client.stop().get()); + + verify(rpc).invoke(eq("runtime.shutdown"), eq(Map.of()), eq(Void.class)); + verify(rpc).close(); + verify(process).destroyForcibly(); + } + + @Test + void testForceStopAndExternalStopDoNotRequestRuntimeShutdown() throws Exception { + var forceClient = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); + var forceRpc = mock(JsonRpcClient.class); + var process = mock(Process.class); + when(process.isAlive()).thenReturn(true); + when(process.destroyForcibly()).thenReturn(process); + when(process.waitFor(anyLong(), any(TimeUnit.class))).thenReturn(true); + setConnectionFuture(forceClient, forceRpc, process); + + forceClient.forceStop().get(); + + verify(forceRpc, never()).invoke(eq("runtime.shutdown"), any(), eq(Void.class)); + verify(process).destroyForcibly(); + + var externalClient = new CopilotClient(new CopilotClientOptions().setAutoStart(false)); + var externalRpc = mock(JsonRpcClient.class); + setConnectionFuture(externalClient, externalRpc, null); + + externalClient.stop().get(); + + verify(externalRpc, never()).invoke(eq("runtime.shutdown"), any(), eq(Void.class)); + } + @Test void testClientConstruction() { var client = new CopilotClient(); @@ -533,4 +606,16 @@ void testListModels_WithCustomHandler_WorksWithoutStart() throws Exception { assertEquals("no-start-model", models.get(0).getId()); } } + + private static void setConnectionFuture(CopilotClient client, JsonRpcClient rpc, Process process) throws Exception { + var connectionClass = Class.forName("com.github.copilot.CopilotClient$Connection"); + var constructor = connectionClass.getDeclaredConstructor(JsonRpcClient.class, Process.class, + com.github.copilot.generated.rpc.ServerRpc.class, AutoCloseable.class); + constructor.setAccessible(true); + var connection = constructor.newInstance(rpc, process, null, null); + + Field field = CopilotClient.class.getDeclaredField("connectionFuture"); + field.setAccessible(true); + field.set(client, CompletableFuture.completedFuture(connection)); + } } diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotClientTransportTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotClientTransportTest.java new file mode 100644 index 000000000..46223d56d --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotClientTransportTest.java @@ -0,0 +1,387 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.ByteArrayOutputStream; +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.channels.Channels; +import java.nio.channels.Pipe; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.InProcessRuntimeConnection; +import com.github.copilot.rpc.RuntimeConnection; +import com.github.copilot.rpc.StdioRuntimeConnection; +import com.github.copilot.rpc.TcpRuntimeConnection; +import com.github.copilot.rpc.TelemetryConfig; +import com.github.copilot.rpc.UriRuntimeConnection; + +/** + * Unit tests for transport selection through {@link RuntimeConnection}: the + * in-process code path, {@code COPILOT_SDK_DEFAULT_CONNECTION} resolution, the + * backward-compatibility bridge from the individual transport options, and + * option validation. + */ +@AllowCopilotExperimental +class CopilotClientTransportTest { + + // ===== In-process routing ===== + + @Test + void inProcessConnectionStartsThroughInProcessRuntimeHost() throws Exception { + var options = new CopilotClientOptions().setConnection(RuntimeConnection.forInProcess()); + try (var runtime = new FakeInProcessRuntime(); var client = new CopilotClient(options)) { + client.setInProcessTransportFactory(runtime::open); + + client.start().get(30, TimeUnit.SECONDS); + + assertTrue(runtime.opened.get(), "The in-process runtime must be used for an in-process connection"); + assertInstanceOf(InProcessRuntimeConnection.class, client.getRuntimeConnection()); + + client.stop().get(30, TimeUnit.SECONDS); + assertTrue(runtime.closed.get(), "Stopping the client must close the in-process runtime host"); + } + } + + @Test + void inProcessStartupFailurePropagates() { + var options = new CopilotClientOptions().setConnection(RuntimeConnection.forInProcess()); + try (var client = new CopilotClient(options)) { + client.setInProcessTransportFactory(opts -> { + throw new IOException("no runtime available"); + }); + var failure = assertThrows(Exception.class, () -> client.start().get(30, TimeUnit.SECONDS)); + assertTrue(rootMessage(failure).contains("no runtime available")); + } + } + + @Test + void cliTransportDoesNotUseTheInProcessRuntime() throws Exception { + var options = new CopilotClientOptions().setCliUrl("127.0.0.1:1"); + try (var client = new CopilotClient(options)) { + client.setInProcessTransportFactory(opts -> { + throw new AssertionError("The in-process runtime must not be used for a CLI transport"); + }); + + assertThrows(Exception.class, () -> client.start().get(30, TimeUnit.SECONDS)); + assertInstanceOf(UriRuntimeConnection.class, client.getRuntimeConnection()); + } + } + + // ===== COPILOT_SDK_DEFAULT_CONNECTION resolution ===== + + @Test + void defaultConnectionEnvVarSelectsInProcess() { + var connection = CopilotClient.resolveDefaultConnection(new CopilotClientOptions(), "inprocess"); + assertInstanceOf(InProcessRuntimeConnection.class, connection); + assertInstanceOf(InProcessRuntimeConnection.class, + CopilotClient.resolveDefaultConnection(new CopilotClientOptions(), "InProcess")); + } + + @Test + void defaultConnectionEnvVarStdioAndUnsetKeepTheConfiguredTransport() { + assertInstanceOf(StdioRuntimeConnection.class, + CopilotClient.resolveDefaultConnection(new CopilotClientOptions(), "stdio")); + assertInstanceOf(StdioRuntimeConnection.class, + CopilotClient.resolveDefaultConnection(new CopilotClientOptions(), null)); + assertInstanceOf(TcpRuntimeConnection.class, + CopilotClient.resolveDefaultConnection(new CopilotClientOptions().setUseStdio(false), "")); + assertInstanceOf(TcpRuntimeConnection.class, CopilotClient.resolveDefaultConnection( + new CopilotClientOptions().setUseStdio(false).setTcpConnectionToken("secret"), "inprocess")); + } + + @Test + void defaultConnectionEnvVarRejectsUnknownValues() { + var error = assertThrows(IllegalArgumentException.class, + () -> CopilotClient.resolveDefaultConnection(new CopilotClientOptions(), "websocket")); + assertTrue(error.getMessage().contains(CopilotClient.DEFAULT_CONNECTION_ENV_VAR)); + } + + // ===== Backward-compatibility bridge ===== + + @Test + void legacyStdioOptionsInferStdioConnection() { + try (var client = new CopilotClient(new CopilotClientOptions().setCliPath("/usr/local/bin/copilot"))) { + var connection = assertInstanceOf(StdioRuntimeConnection.class, client.getRuntimeConnection()); + assertEquals("/usr/local/bin/copilot", connection.getPath()); + } + } + + @Test + void legacyTcpOptionsInferTcpConnection() { + var options = new CopilotClientOptions().setUseStdio(false).setPort(4321).setTcpConnectionToken("secret"); + try (var client = new CopilotClient(options)) { + var connection = assertInstanceOf(TcpRuntimeConnection.class, client.getRuntimeConnection()); + assertEquals(4321, connection.getPort()); + assertEquals("secret", connection.getConnectionToken()); + } + } + + @Test + void legacyCliUrlInfersUriConnection() { + try (var client = new CopilotClient(new CopilotClientOptions().setCliUrl("localhost:3000"))) { + var connection = assertInstanceOf(UriRuntimeConnection.class, client.getRuntimeConnection()); + assertEquals("localhost:3000", connection.getUrl()); + } + } + + // ===== Connection applied to the transport options ===== + + @Test + void connectionIsProjectedOntoTransportOptions() { + var stdio = new CopilotClientOptions().setConnection(RuntimeConnection.forStdio("/opt/copilot")); + try (var client = new CopilotClient(stdio)) { + assertTrue(stdio.isUseStdio()); + assertEquals("/opt/copilot", stdio.getCliPath()); + } + + var tcp = new CopilotClientOptions().setConnection( + RuntimeConnection.forTcp().setPort(4321).setConnectionToken("secret").setArgs(List.of("--extra"))); + try (var client = new CopilotClient(tcp)) { + assertFalse(tcp.isUseStdio()); + assertEquals(4321, tcp.getPort()); + assertEquals("secret", tcp.getTcpConnectionToken()); + assertEquals(List.of("--extra"), List.of(tcp.getCliArgs())); + } + + var uri = new CopilotClientOptions().setConnection(RuntimeConnection.forUri("localhost:3000")); + try (var client = new CopilotClient(uri)) { + assertFalse(uri.isUseStdio()); + assertEquals("localhost:3000", uri.getCliUrl()); + } + } + + // ===== Conflicting configuration ===== + + @Test + void connectionCannotBeCombinedWithTransportOptions() { + assertConflict(new CopilotClientOptions().setConnection(RuntimeConnection.forStdio()) + .setCliPath("/usr/local/bin/copilot"), "CliPath"); + assertConflict( + new CopilotClientOptions().setConnection(RuntimeConnection.forInProcess()).setCliUrl("localhost:3000"), + "CliUrl"); + assertConflict(new CopilotClientOptions().setConnection(RuntimeConnection.forStdio()).setUseStdio(false), + "UseStdio"); + assertConflict(new CopilotClientOptions().setConnection(RuntimeConnection.forTcp()).setPort(4321), "Port"); + assertConflict( + new CopilotClientOptions().setConnection(RuntimeConnection.forTcp()).setTcpConnectionToken("secret"), + "TcpConnectionToken"); + assertConflict(new CopilotClientOptions().setConnection(RuntimeConnection.forStdio()) + .setCliArgs(new String[]{"--extra"}), "CliArgs"); + } + + @Test + void connectionCanBeReusedForSeveralClients() { + var options = new CopilotClientOptions().setConnection(RuntimeConnection.forStdio("/opt/copilot")); + try (var first = new CopilotClient(options); var second = new CopilotClient(options)) { + assertInstanceOf(StdioRuntimeConnection.class, first.getRuntimeConnection()); + assertInstanceOf(StdioRuntimeConnection.class, second.getRuntimeConnection()); + } + } + + private static void assertConflict(CopilotClientOptions options, String optionName) { + var error = assertThrows(IllegalArgumentException.class, () -> new CopilotClient(options)); + assertTrue(error.getMessage().contains(optionName), "Expected '" + optionName + "' in: " + error.getMessage()); + } + + // ===== Options rejected for the in-process transport ===== + + @Test + void inProcessRejectsPerProcessOptions() { + assertInProcessRejected(new CopilotClientOptions().setEnvironment(Map.of("FOO", "bar")), "Environment"); + assertInProcessRejected(new CopilotClientOptions().setTelemetry(new TelemetryConfig()), "Telemetry"); + assertInProcessRejected(new CopilotClientOptions().setCwd("/tmp"), "Cwd"); + assertInProcessRejected(new CopilotClientOptions().setCliArgs(new String[]{"--extra"}), "CliArgs"); + } + + @Test + void e2eContextClearsInProcessIncompatibleOptions() throws Exception { + try (var context = E2ETestContext.create()) { + var options = new CopilotClientOptions().setConnection(RuntimeConnection.forInProcess()) + .setEnvironment(Map.of("TEST_KEY", "test-value")).setCwd(context.getWorkDir().toString()) + .setCliArgs(new String[]{"--subprocess-only"}); + + try (var client = context.createClient(options)) { + assertInstanceOf(InProcessRuntimeConnection.class, client.getRuntimeConnection()); + assertTrue(options.getEnvironment() == null || options.getEnvironment().isEmpty()); + assertEquals(null, options.getCwd()); + assertTrue(options.getCliArgs() == null || options.getCliArgs().length == 0); + } + } + } + + private static void assertInProcessRejected(CopilotClientOptions options, String optionName) { + options.setConnection(RuntimeConnection.forInProcess()); + var error = assertThrows(IllegalArgumentException.class, () -> new CopilotClient(options)); + assertTrue(error.getMessage().contains(optionName), "Expected '" + optionName + "' in: " + error.getMessage()); + assertTrue(error.getMessage().contains("forInProcess"), + "Expected the in-process transport to be named in: " + error.getMessage()); + } + + private static String rootMessage(Throwable error) { + Throwable cause = error; + while (cause.getCause() != null) { + cause = cause.getCause(); + } + return String.valueOf(cause.getMessage()); + } + + /** + * Minimal loopback stand-in for the in-process runtime: it speaks just enough + * JSON-RPC for {@link CopilotClient#start()} to complete, so the test can + * assert that the client wires its transport to the in-process host rather than + * to a child process. + */ + private static final class FakeInProcessRuntime implements AutoCloseable { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private final AtomicBoolean opened = new AtomicBoolean(); + private final AtomicBoolean closed = new AtomicBoolean(); + private final BytePipe toClient; + private final BytePipe toRuntime; + private final InputStream runtimeInput; + private final OutputStream runtimeOutput; + private final Thread responder; + + FakeInProcessRuntime() throws IOException { + this.toClient = new BytePipe(); + this.toRuntime = new BytePipe(); + this.runtimeInput = toRuntime.inputStream(); + this.runtimeOutput = toClient.outputStream(); + this.responder = new Thread(this::respondToRequests, "fake-inprocess-runtime"); + this.responder.setDaemon(true); + this.responder.start(); + } + + CopilotClient.InProcessTransport open(CopilotClientOptions options) { + opened.set(true); + return new CopilotClient.InProcessTransport(toClient.inputStream(), toRuntime.outputStream(), this::close); + } + + @Override + public void close() { + if (!closed.compareAndSet(false, true)) { + return; + } + toRuntime.close(); + toClient.close(); + } + + private void respondToRequests() { + try { + while (!closed.get()) { + JsonNode request = readMessage(runtimeInput); + if (request == null) { + return; + } + if (!request.hasNonNull("id")) { + continue; + } + var response = MAPPER.createObjectNode(); + response.put("jsonrpc", "2.0"); + response.set("id", request.get("id")); + var result = response.putObject("result"); + if ("connect".equals(request.path("method").asText())) { + result.put("protocolVersion", SdkProtocolVersion.get()); + } + writeMessage(runtimeOutput, response); + } + } catch (IOException e) { + // The streams are closed when the client shuts down. + } + } + + private static JsonNode readMessage(InputStream in) throws IOException { + int contentLength = -1; + var line = new ByteArrayOutputStream(); + while (true) { + int b = in.read(); + if (b == -1) { + return null; + } + if (b == '\n') { + String header = line.toString(StandardCharsets.UTF_8).trim(); + line.reset(); + if (header.isEmpty()) { + break; + } + if (header.toLowerCase(Locale.ROOT).startsWith("content-length:")) { + contentLength = Integer.parseInt(header.substring(header.indexOf(':') + 1).trim()); + } + } else if (b != '\r') { + line.write(b); + } + } + if (contentLength < 0) { + throw new IOException("Missing Content-Length header"); + } + byte[] body = in.readNBytes(contentLength); + if (body.length != contentLength) { + return null; + } + return MAPPER.readTree(body); + } + + private static void writeMessage(OutputStream out, JsonNode message) throws IOException { + byte[] body = MAPPER.writeValueAsBytes(message); + out.write(("Content-Length: " + body.length + "\r\n\r\n").getBytes(StandardCharsets.UTF_8)); + out.write(body); + out.flush(); + } + } + + /** + * Duplex byte channel used by {@link FakeInProcessRuntime} to emulate the + * streams of an in-process runtime. + */ + private static final class BytePipe { + + private final Pipe pipe; + + BytePipe() throws IOException { + this.pipe = Pipe.open(); + } + + InputStream inputStream() { + return Channels.newInputStream(pipe.source()); + } + + OutputStream outputStream() { + return Channels.newOutputStream(pipe.sink()); + } + + void close() { + closeQuietly(pipe.sink()); + closeQuietly(pipe.source()); + } + + private static void closeQuietly(Closeable closeable) { + try { + closeable.close(); + } catch (IOException e) { + // Nothing useful to do while tearing down a test pipe. + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java new file mode 100644 index 000000000..b7005c5d5 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotExperimentalProcessorTest.java @@ -0,0 +1,198 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import org.junit.jupiter.api.Test; + +import javax.tools.Diagnostic; +import javax.tools.DiagnosticCollector; +import javax.tools.JavaCompiler; +import javax.tools.JavaFileObject; +import javax.tools.SimpleJavaFileObject; +import javax.tools.ToolProvider; +import java.net.URI; +import java.net.URL; +import java.nio.file.Path; +import java.security.CodeSource; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Tests that {@link CopilotExperimentalProcessor} enforces compile-time gating + * of experimental APIs at the declaration level. + */ +class CopilotExperimentalProcessorTest { + + private static final String EXPERIMENTAL_TYPE_SOURCE = """ + package test; + import com.github.copilot.CopilotExperimental; + @CopilotExperimental + public class ExperimentalType { + public void doSomething() {} + } + """; + + private static final String EXPERIMENTAL_METHOD_SOURCE = """ + package test; + import com.github.copilot.CopilotExperimental; + public class StableType { + @CopilotExperimental + public static void experimentalMethod() {} + } + """; + + private static final String CONSUMER_USES_TYPE_IN_DECLARATIONS = """ + package consumer; + import test.ExperimentalType; + public class Consumer { + private ExperimentalType field; + public ExperimentalType getIt() { return field; } + public void setIt(ExperimentalType value) { this.field = value; } + } + """; + + private static final String CONSUMER_EXTENDS_TYPE = """ + package consumer; + import test.ExperimentalType; + public class Consumer extends ExperimentalType { + } + """; + + private static final String CLASS_ANNOTATED_CONSUMER = """ + package consumer; + import com.github.copilot.AllowCopilotExperimental; + import test.ExperimentalType; + @AllowCopilotExperimental + public class Consumer extends ExperimentalType { + private ExperimentalType field; + public ExperimentalType getIt() { return field; } + public void setIt(ExperimentalType value) { this.field = value; } + } + """; + + private static final String METHOD_ANNOTATED_CONSUMER = """ + package consumer; + import com.github.copilot.AllowCopilotExperimental; + import test.ExperimentalType; + public class Consumer { + @AllowCopilotExperimental + public ExperimentalType getIt(ExperimentalType value) { + return value; + } + } + """; + + @Test + void failsByDefault_whenFieldOrSignatureUsesExperimentalType() { + DiagnosticCollector diagnostics = compile( + List.of(inMemorySource("test.ExperimentalType", EXPERIMENTAL_TYPE_SOURCE), + inMemorySource("consumer.Consumer", CONSUMER_USES_TYPE_IN_DECLARATIONS)), + Collections.emptyList()); + + boolean hasError = diagnostics.getDiagnostics().stream() + .anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR && d.getMessage(null).contains("experimental API")); + assertTrue(hasError, + "Expected compile error for experimental type in declarations, got: " + diagnostics.getDiagnostics()); + } + + @Test + void failsByDefault_whenExtendingExperimentalType() { + DiagnosticCollector diagnostics = compile( + List.of(inMemorySource("test.ExperimentalType", EXPERIMENTAL_TYPE_SOURCE), + inMemorySource("consumer.Consumer", CONSUMER_EXTENDS_TYPE)), + Collections.emptyList()); + + boolean hasError = diagnostics.getDiagnostics().stream() + .anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR && d.getMessage(null).contains("experimental API")); + assertTrue(hasError, + "Expected compile error for extending experimental type, got: " + diagnostics.getDiagnostics()); + } + + @Test + void passes_whenAllowAnnotationIsOnType() { + DiagnosticCollector diagnostics = compile( + List.of(inMemorySource("test.ExperimentalType", EXPERIMENTAL_TYPE_SOURCE), + inMemorySource("consumer.Consumer", CLASS_ANNOTATED_CONSUMER)), + Collections.emptyList()); + + boolean hasError = diagnostics.getDiagnostics().stream().anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR); + assertFalse(hasError, "Expected no errors with type-level opt-in, got: " + diagnostics.getDiagnostics()); + } + + @Test + void passes_whenAllowAnnotationIsOnMethod() { + DiagnosticCollector diagnostics = compile( + List.of(inMemorySource("test.ExperimentalType", EXPERIMENTAL_TYPE_SOURCE), + inMemorySource("consumer.Consumer", METHOD_ANNOTATED_CONSUMER)), + Collections.emptyList()); + + boolean hasError = diagnostics.getDiagnostics().stream().anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR); + assertFalse(hasError, "Expected no errors with method-level opt-in, got: " + diagnostics.getDiagnostics()); + } + + @Test + void passes_whenOptInFlagIsProvided() { + DiagnosticCollector diagnostics = compile( + List.of(inMemorySource("test.ExperimentalType", EXPERIMENTAL_TYPE_SOURCE), + inMemorySource("test.StableType", EXPERIMENTAL_METHOD_SOURCE), + inMemorySource("consumer.Consumer", CONSUMER_USES_TYPE_IN_DECLARATIONS)), + List.of("-Acopilot.experimental.allowed=true")); + + boolean hasError = diagnostics.getDiagnostics().stream().anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR); + assertFalse(hasError, "Expected no errors with opt-in flag, got: " + diagnostics.getDiagnostics()); + } + + private DiagnosticCollector compile(List sources, List extraOptions) { + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + + String classpath = resolveClasspath(); + List options = new ArrayList<>(); + options.addAll(List.of("-classpath", classpath)); + // Direct output to temp dir to avoid polluting the working directory + options.addAll(List.of("-d", System.getProperty("java.io.tmpdir"))); + options.addAll(extraOptions); + + JavaCompiler.CompilationTask task = compiler.getTask(null, null, diagnostics, options, null, sources); + task.setProcessors(List.of(new CopilotExperimentalProcessor())); + task.call(); + + return diagnostics; + } + + /** + * Resolves the classpath containing {@link CopilotExperimental} so the + * in-memory compiler can find it. Works in both classpath and module-path + * environments. + */ + private static String resolveClasspath() { + CodeSource cs = CopilotExperimental.class.getProtectionDomain().getCodeSource(); + if (cs != null) { + URL location = cs.getLocation(); + if (location != null) { + try { + return Path.of(location.toURI()).toString(); + } catch (Exception ignored) { + // fall through + } + } + } + return System.getProperty("java.class.path", "."); + } + + private static JavaFileObject inMemorySource(String className, String code) { + return new SimpleJavaFileObject(URI.create("string:///" + className.replace('.', '/') + ".java"), + JavaFileObject.Kind.SOURCE) { + @Override + public CharSequence getCharContent(boolean ignoreEncodingErrors) { + return code; + } + }; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java new file mode 100644 index 000000000..7d7ae5d70 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotRequestCancelErrorE2ETest.java @@ -0,0 +1,152 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static com.github.copilot.CopilotRequestTestSupport.buildNonInferenceResponse; +import static com.github.copilot.CopilotRequestTestSupport.isInferenceUrl; +import static com.github.copilot.CopilotRequestTestSupport.newLlmClient; +import static com.github.copilot.CopilotRequestTestSupport.setupCapiAuth; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.InputStream; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.util.concurrent.CancellationException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +/** + * Cancellation and error coverage for {@link CopilotRequestHandler}. These two + * scenarios exercise the handler's terminal paths the happy-path session-id and + * forwarding tests never reach: + *
    + *
  • Error — the handler throws from + * {@link CopilotRequestHandler#sendRequest} for an inference request. The base + * adapter reports a transport error back to the runtime rather than + * hanging.
    • + *
  • Runtime cancel — the handler blocks an inference request + * indefinitely; when the consumer aborts the turn the runtime cancels the + * in-flight request, firing {@link CopilotRequestContext#cancellation()}. The + * handler observes the abort instead of leaking a stuck request.
    • + *
+ */ +public class CopilotRequestCancelErrorE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + /** Throws from every inference request to exercise the error-reporting path. */ + private static final class ThrowingRequestHandler extends CopilotRequestHandler { + + private final AtomicInteger inferenceAttempts = new AtomicInteger(); + + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext rctx) { + String url = request.uri().toString(); + if (!isInferenceUrl(url)) { + return buildNonInferenceResponse(url); + } + inferenceAttempts.incrementAndGet(); + throw new IllegalStateException("synthetic-callback-transport-failure"); + } + } + + /** Blocks every inference request until the runtime cancels it. */ + private static final class CancellingRequestHandler extends CopilotRequestHandler { + + private volatile boolean inferenceEntered; + private volatile boolean sawAbort; + + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext rctx) { + String url = request.uri().toString(); + if (!isInferenceUrl(url)) { + return buildNonInferenceResponse(url); + } + inferenceEntered = true; + try { + // Never produce a response; wait for the runtime to cancel us. + rctx.cancellation().join(); + } catch (CancellationException | java.util.concurrent.CompletionException e) { + // The cancellation future completes normally on cancel; this guards + // against any exceptional completion too. + } + sawAbort = true; + throw new CancellationException("Request cancelled by runtime"); + } + } + + @Test + void reportsThrownHandlerErrorInsteadOfHanging() throws Exception { + setupCapiAuth(ctx); + ThrowingRequestHandler handler = new ThrowingRequestHandler(); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + // The handler throws on inference; the turn surfaces an error (or completes + // without an assistant message) rather than hanging. + try { + session.sendAndWait(new MessageOptions().setPrompt("Say OK.")).get(60, TimeUnit.SECONDS); + } catch (Exception ignored) { + // Expected: the inference callback raised. + } + session.close(); + } + + assertTrue(handler.inferenceAttempts.get() > 0, "Expected the inference callback to be reached and raise"); + } + + @Test + void observesRuntimeCancellationOfInFlightInference() throws Exception { + setupCapiAuth(ctx); + CancellingRequestHandler handler = new CancellingRequestHandler(); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + session.send(new MessageOptions().setPrompt("Say OK.")).get(60, TimeUnit.SECONDS); + waitFor(() -> handler.inferenceEntered, 60_000); + session.abort().get(30, TimeUnit.SECONDS); + waitFor(() -> handler.sawAbort, 30_000); + session.close(); + } + + assertTrue(handler.inferenceEntered, "Expected the inference callback to be entered"); + assertTrue(handler.sawAbort, "Expected the callback to observe runtime cancellation"); + } + + private static void waitFor(java.util.function.BooleanSupplier predicate, long timeoutMillis) + throws InterruptedException { + long deadline = System.currentTimeMillis() + timeoutMillis; + while (!predicate.getAsBoolean()) { + if (System.currentTimeMillis() > deadline) { + throw new AssertionError("waitFor timed out"); + } + Thread.sleep(50); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java new file mode 100644 index 000000000..5ba490244 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java @@ -0,0 +1,176 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static com.github.copilot.CopilotRequestTestSupport.SYNTHETIC_TEXT; +import static com.github.copilot.CopilotRequestTestSupport.assistantText; +import static com.github.copilot.CopilotRequestTestSupport.newLlmClient; +import static com.github.copilot.CopilotRequestTestSupport.setupCapiAuth; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.InputStream; +import java.net.URI; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.util.List; +import java.util.Locale; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.CopilotRequestTestSupport.InterceptedRequest; +import com.github.copilot.CopilotRequestTestSupport.RecordingRequestHandler; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +/** + * End-to-end coverage for {@link CopilotRequestHandler}: a synthetic HTTP turn + * that the handler fully fabricates off-network, and a forwarding turn that + * relays both the HTTP and WebSocket transports to a real in-process upstream. + */ +public class CopilotRequestHandlerE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void streamsSyntheticHttpInference() throws Exception { + setupCapiAuth(ctx); + RecordingRequestHandler handler = new RecordingRequestHandler(SYNTHETIC_TEXT); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + AssistantMessageEvent result = session.sendAndWait(new MessageOptions().setPrompt("Say OK.")).get(60, + TimeUnit.SECONDS); + session.close(); + + // The handler intercepted the startup catalog and at least one inference + // request, fully replacing the runtime's outbound model-layer calls. + List records = handler.records(); + assertFalse(records.isEmpty(), "Expected the runtime to invoke the request handler"); + assertTrue(records.stream().anyMatch(r -> r.url().toLowerCase(Locale.ROOT).endsWith("/models")), + "Expected to intercept the /models catalog request"); + assertFalse(handler.inferenceRequests().isEmpty(), + "Expected at least one inference request via the handler"); + + // Validate the final assistant response arrived (guards against truncated + // captures) + assertTrue(assistantText(result).contains("OK from the synthetic"), + "Expected synthetic content in assistant reply, got " + assistantText(result)); + } + } + + @Test + void forwardsHttpAndWebSocketToUpstream() throws Exception { + setupCapiAuth(ctx); + + AtomicInteger httpRequests = new AtomicInteger(); + AtomicInteger httpResponses = new AtomicInteger(); + AtomicInteger wsRequestMessages = new AtomicInteger(); + AtomicInteger wsResponseMessages = new AtomicInteger(); + + try (FakeUpstreamServer upstream = new FakeUpstreamServer("OK from synthetic HTTP upstream.", + "OK from synthetic WS upstream.")) { + + String httpBase = upstream.httpUrl(); + String wsBase = upstream.wsUrl(); + + CopilotRequestHandler handler = new CopilotRequestHandler() { + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext rctx) + throws Exception { + httpRequests.incrementAndGet(); + URI rewritten = URI.create(rewriteHost(httpBase, request.uri())); + HttpRequest.Builder builder = HttpRequest.newBuilder().uri(rewritten); + request.bodyPublisher().ifPresentOrElse(bp -> builder.method(request.method(), bp), + () -> builder.method(request.method(), HttpRequest.BodyPublishers.noBody())); + request.headers().map().forEach((name, values) -> { + for (String value : values) { + try { + builder.header(name, value); + } catch (IllegalArgumentException ignored) { + // Restricted header rejected by java.net.http; skip it. + } + } + }); + builder.header("x-test-mutated", "1"); + HttpResponse response = httpClient() + .sendAsync(builder.build(), HttpResponse.BodyHandlers.ofInputStream()).get(); + httpResponses.incrementAndGet(); + return response; + } + + @Override + protected CopilotWebSocketHandler openWebSocket(CopilotRequestContext rctx) { + return new CopilotWebSocketForwarder(rctx.withUrl(rewriteHost(wsBase, URI.create(rctx.url())))) { + @Override + public void sendRequestMessage(CopilotWebSocketMessage message) throws Exception { + wsRequestMessages.incrementAndGet(); + super.sendRequestMessage(message); + } + + @Override + public void sendResponseMessage(CopilotWebSocketMessage message) throws Exception { + wsResponseMessages.incrementAndGet(); + super.sendResponseMessage(message); + } + }; + } + }; + + try (CopilotClient client = newLlmClient(ctx, handler, + "COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES=true")) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + AssistantMessageEvent result = session.sendAndWait(new MessageOptions().setPrompt("Say OK.")).get(60, + TimeUnit.SECONDS); + session.close(); + + // The HTTP override fired — the runtime issued model-layer GETs (catalog, + // policy) and possibly a single-shot inference through the send override. + assertTrue(httpRequests.get() > 0, "Expected the HTTP send override to fire"); + assertTrue(httpResponses.get() > 0, "Expected the HTTP response mutation to fire"); + + // The WebSocket override fired — the main agent turn went over the WS path + // and we observed messages in both directions. + assertTrue(wsRequestMessages.get() > 0, "Expected runtime -> upstream ws messages"); + assertTrue(wsResponseMessages.get() > 0, "Expected upstream -> runtime ws messages"); + assertTrue(upstream.upstreamWsRequests() > 0, "Expected the upstream WS to receive request messages"); + + // Validate the final assistant response arrived (guards against truncated + // captures) + String text = assistantText(result); + assertTrue(text.contains("OK from synthetic") && text.contains("upstream"), + "Expected synthetic upstream content in assistant reply, got " + text); + } + } + } + + private static String rewriteHost(String base, URI original) { + String path = original.getRawPath() == null ? "" : original.getRawPath(); + String query = original.getRawQuery(); + return base + path + (query != null ? "?" + query : ""); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java new file mode 100644 index 000000000..3025c64c3 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotRequestSessionIdE2ETest.java @@ -0,0 +1,110 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static com.github.copilot.CopilotRequestTestSupport.SYNTHETIC_TEXT; +import static com.github.copilot.CopilotRequestTestSupport.assistantText; +import static com.github.copilot.CopilotRequestTestSupport.newLlmClient; +import static com.github.copilot.CopilotRequestTestSupport.setupCapiAuth; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.CopilotRequestTestSupport.InterceptedRequest; +import com.github.copilot.CopilotRequestTestSupport.RecordingRequestHandler; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * Verifies that the triggering session id is threaded into every inference + * request context, for both CAPI and BYOK sessions, and that per-session ids + * differ. + */ +public class CopilotRequestSessionIdE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void threadsSessionIdForCapiAndByok() throws Exception { + setupCapiAuth(ctx); + RecordingRequestHandler handler = new RecordingRequestHandler(SYNTHETIC_TEXT); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + // CAPI session. + CopilotSession capiSession = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + String capiSessionId = capiSession.getSessionId(); + + AssistantMessageEvent capiResult = capiSession.sendAndWait(new MessageOptions().setPrompt("Say OK.")) + .get(60, TimeUnit.SECONDS); + capiSession.close(); + + List capiInference = handler.inferenceRequests(); + assertFalse(capiInference.isEmpty(), "Expected at least one intercepted inference request"); + for (InterceptedRequest r : capiInference) { + assertEquals(capiSessionId, r.sessionId(), "CAPI inference request must carry the session id"); + assertAgentMetadata(r); + } + assertTrue(assistantText(capiResult).contains("OK from the synthetic"), + "Expected synthetic content in CAPI assistant reply, got " + assistantText(capiResult)); + + // BYOK session. + int before = handler.inferenceRequests().size(); + ProviderConfig provider = new ProviderConfig().setType("openai").setWireApi("responses") + .setBaseUrl("https://byok.invalid/v1").setApiKey("byok-secret").setModelId("claude-sonnet-4.5") + .setWireModel("claude-sonnet-4.5"); + CopilotSession byokSession = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setModel("claude-sonnet-4.5").setProvider(provider)) + .get(); + String byokSessionId = byokSession.getSessionId(); + + AssistantMessageEvent byokResult = byokSession.sendAndWait(new MessageOptions().setPrompt("Say OK.")) + .get(60, TimeUnit.SECONDS); + byokSession.close(); + + List byokInference = handler.inferenceRequests(); + assertTrue(byokInference.size() > before, "Expected at least one intercepted BYOK inference request"); + for (InterceptedRequest r : byokInference.subList(before, byokInference.size())) { + assertEquals(byokSessionId, r.sessionId(), "BYOK inference request must carry the session id"); + assertAgentMetadata(r); + } + assertNotEquals(capiSessionId, byokSessionId, "Expected per-session ids to differ between turns"); + assertTrue(assistantText(byokResult).contains("OK from the synthetic"), + "Expected synthetic content in BYOK assistant reply, got " + assistantText(byokResult)); + } + } + + private static void assertAgentMetadata(InterceptedRequest request) { + assertNotNull(request.agentId(), "Inference request must carry an agent id"); + assertFalse(request.agentId().isEmpty(), "Inference request must carry an agent id"); + assertNotNull(request.interactionType(), "Inference request must carry an interaction type"); + assertFalse(request.interactionType().isEmpty(), "Inference request must carry an interaction type"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java b/java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java new file mode 100644 index 000000000..aa173ef30 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/CopilotRequestTestSupport.java @@ -0,0 +1,578 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.UncheckedIOException; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpHeaders; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.Flow; +import java.util.regex.Pattern; +import javax.net.ssl.SSLSession; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.CopilotClientOptions; + +/** + * Shared synthetic-upstream helpers for the {@link CopilotRequestHandler} e2e + * tests. + * + *

+ * These tests have no recorded snapshots: a {@link CopilotRequestHandler} + * subclass fabricates well-formed model responses and the runtime routes all of + * its model-layer HTTP/WebSocket traffic through that handler instead of the + * CAPI proxy. The helpers centralise the synthetic CAPI shapes (model catalog, + * policy, {@code /responses} SSE, {@code /chat/completions}) so each test + * focuses on the behaviour it is exercising. + *

+ */ +final class CopilotRequestTestSupport { + + static final String SYNTHETIC_TEXT = "OK from the synthetic stream."; + + private static final ObjectMapper MAPPER = new ObjectMapper(); + private static final Pattern STREAM_TRUE = Pattern.compile("\"stream\"\\s*:\\s*true"); + + private CopilotRequestTestSupport() { + } + + /** + * Builds a client wired to {@code handler} via the {@code requestHandler} + * option. The shared context client has no request handler, so each inference + * test owns an isolated client carrying its own handler. {@code extraEnv} + * entries (formatted {@code KEY=value}) are added to the spawned runtime's + * environment, e.g. to flip an ExP flag for the WebSocket transport. + */ + static CopilotClient newLlmClient(E2ETestContext ctx, CopilotRequestHandler handler, String... extraEnv) { + Map env = new HashMap<>(ctx.getEnvironment()); + for (String entry : extraEnv) { + int eq = entry.indexOf('='); + if (eq > 0) { + env.put(entry.substring(0, eq), entry.substring(eq + 1)); + } + } + return ctx.createClient( + new CopilotClientOptions().setCliPath(ctx.getCliPath()).setEnvironment(env).setRequestHandler(handler)); + } + + /** + * Initializes the proxy state and registers a synthetic CAPI user so the + * runtime can resolve auth for sessions that route their model-layer traffic + * through the handler instead of the proxy. + */ + static void setupCapiAuth(E2ETestContext ctx) throws IOException, InterruptedException { + ctx.initializeProxy(); + ctx.setCopilotUserByToken("fake-token-for-e2e-tests", "e2e-user", "individual_pro", ctx.getProxyUrl(), + "https://localhost:1/telemetry", "e2e-tracking-id"); + } + + static Map> headers(String name, String value) { + Map> headers = new LinkedHashMap<>(); + headers.put(name, List.of(value)); + return headers; + } + + static String json(Object value) { + try { + return MAPPER.writeValueAsString(value); + } catch (JsonProcessingException e) { + throw new UncheckedIOException(e); + } + } + + static boolean wantsStream(String body) { + return STREAM_TRUE.matcher(body).find(); + } + + static boolean isInferenceUrl(String url) { + String u = url.toLowerCase(Locale.ROOT); + return u.endsWith("/chat/completions") || u.endsWith("/responses") || u.endsWith("/v1/messages") + || u.endsWith("/messages"); + } + + static String sse(String eventType, Object data) { + return "event: " + eventType + "\ndata: " + json(data) + "\n\n"; + } + + static String sseBody(String text, String respId) { + StringBuilder sb = new StringBuilder(); + for (Map event : responsesEvents(text, respId)) { + sb.append(sse((String) event.get("type"), event)); + } + return sb.toString(); + } + + /** + * Builds a complete Anthropic Messages SSE body (message_start … message_stop) + * for a streaming {@code /messages} response. The buffered JSON message is only + * valid for a non-streaming request; a streaming request expects named SSE + * events or the runtime fails to finalize the message. + */ + static String anthropicMessageSseBody(String text) { + Map startMessage = new LinkedHashMap<>(); + startMessage.put("id", "msg_stub_1"); + startMessage.put("type", "message"); + startMessage.put("role", "assistant"); + startMessage.put("model", "claude-sonnet-4.5"); + startMessage.put("content", List.of()); + startMessage.put("stop_reason", null); + startMessage.put("stop_sequence", null); + startMessage.put("usage", Map.of("input_tokens", 5, "output_tokens", 1)); + Map messageStart = new LinkedHashMap<>(); + messageStart.put("type", "message_start"); + messageStart.put("message", startMessage); + + Map contentBlockStart = new LinkedHashMap<>(); + contentBlockStart.put("type", "content_block_start"); + contentBlockStart.put("index", 0); + contentBlockStart.put("content_block", Map.of("type", "text", "text", "")); + + Map contentBlockDelta = new LinkedHashMap<>(); + contentBlockDelta.put("type", "content_block_delta"); + contentBlockDelta.put("index", 0); + contentBlockDelta.put("delta", Map.of("type", "text_delta", "text", text)); + + Map contentBlockStop = new LinkedHashMap<>(); + contentBlockStop.put("type", "content_block_stop"); + contentBlockStop.put("index", 0); + + Map messageDeltaDelta = new LinkedHashMap<>(); + messageDeltaDelta.put("stop_reason", "end_turn"); + messageDeltaDelta.put("stop_sequence", null); + Map messageDelta = new LinkedHashMap<>(); + messageDelta.put("type", "message_delta"); + messageDelta.put("delta", messageDeltaDelta); + messageDelta.put("usage", Map.of("output_tokens", 7)); + + StringBuilder sb = new StringBuilder(); + sb.append(sse("message_start", messageStart)); + sb.append(sse("content_block_start", contentBlockStart)); + sb.append(sse("content_block_delta", contentBlockDelta)); + sb.append(sse("content_block_stop", contentBlockStop)); + sb.append(sse("message_delta", messageDelta)); + sb.append(sse("message_stop", Map.of("type", "message_stop"))); + return sb.toString(); + } + + // --- Synthetic response builders for the CopilotRequestHandler send override + // --- + + /** + * Drains the body of an outbound {@link HttpRequest} to a UTF-8 string. Mirrors + * the .NET {@code request.Content.ReadAsStringAsync()} the recording handler + * uses to inspect the request the runtime built. + */ + static String requestBodyText(HttpRequest request) { + return request.bodyPublisher().map(CopilotRequestTestSupport::drain).orElse(""); + } + + private static String drain(HttpRequest.BodyPublisher publisher) { + ByteArrayOutputStream out = new ByteArrayOutputStream(); + CompletableFuture done = new CompletableFuture<>(); + publisher.subscribe(new Flow.Subscriber<>() { + @Override + public void onSubscribe(Flow.Subscription subscription) { + subscription.request(Long.MAX_VALUE); + } + + @Override + public void onNext(ByteBuffer item) { + byte[] chunk = new byte[item.remaining()]; + item.get(chunk); + out.writeBytes(chunk); + } + + @Override + public void onError(Throwable throwable) { + done.completeExceptionally(throwable); + } + + @Override + public void onComplete() { + done.complete(null); + } + }); + done.join(); + return out.toString(StandardCharsets.UTF_8); + } + + /** + * Synthesizes a well-formed inference response, dispatching by URL and the + * request body's stream flag exactly as a real reverse proxy would. + */ + static HttpResponse buildInferenceResponse(String url, String bodyText, String text) { + boolean stream = wantsStream(bodyText); + String u = url.toLowerCase(Locale.ROOT); + + if (u.contains("/responses")) { + if (!stream) { + List> events = responsesEvents(text, "resp_stub_1"); + Object last = events.get(events.size() - 1).get("response"); + return jsonResponse(json(last)); + } + return sseResponse(sseBody(text, "resp_stub_1")); + } + + if (u.contains("/chat/completions") && stream) { + StringBuilder sb = new StringBuilder(); + for (Map chunk : chatCompletionChunks(text)) { + sb.append("data: ").append(json(chunk)).append("\n\n"); + } + sb.append("data: [DONE]\n\n"); + return sseResponse(sb.toString()); + } + + if (u.endsWith("/messages")) { + if (stream) { + return sseResponse(anthropicMessageSseBody(text)); + } + Map body = new LinkedHashMap<>(); + body.put("id", "msg_stub_1"); + body.put("type", "message"); + body.put("role", "assistant"); + body.put("model", "claude-sonnet-4.5"); + body.put("content", List.of(Map.of("type", "text", "text", text))); + body.put("stop_reason", "end_turn"); + body.put("stop_sequence", null); + body.put("usage", Map.of("input_tokens", 5, "output_tokens", 7)); + return jsonResponse(json(body)); + } + + return jsonResponse(json(chatCompletion(text))); + } + + /** + * Serves the non-inference model-layer requests the runtime issues (catalog, + * model session, policy), with an empty-JSON fallback for anything else. + */ + static HttpResponse buildNonInferenceResponse(String url) { + String u = url.toLowerCase(Locale.ROOT); + if (u.endsWith("/models")) { + return jsonResponse(modelCatalog(null)); + } + if (u.contains("/models/session")) { + return jsonResponse("{}"); + } + if (u.contains("/policy")) { + return jsonResponse("{\"state\":\"enabled\"}"); + } + return jsonResponse("{}"); + } + + static HttpResponse jsonResponse(String body) { + return new StubHttpResponse(200, "application/json", body); + } + + static HttpResponse sseResponse(String body) { + return new StubHttpResponse(200, "text/event-stream", body); + } + + static String modelCatalog(List supportedEndpoints) { + Map limits = new LinkedHashMap<>(); + limits.put("max_context_window_tokens", 200000); + limits.put("max_output_tokens", 8192); + + Map supports = new LinkedHashMap<>(); + supports.put("streaming", true); + supports.put("tool_calls", true); + supports.put("parallel_tool_calls", true); + supports.put("vision", true); + + Map capabilities = new LinkedHashMap<>(); + capabilities.put("type", "chat"); + capabilities.put("family", "claude-sonnet-4.5"); + capabilities.put("tokenizer", "o200k_base"); + capabilities.put("limits", limits); + capabilities.put("supports", supports); + + Map model = new LinkedHashMap<>(); + model.put("id", "claude-sonnet-4.5"); + model.put("name", "Claude Sonnet 4.5"); + model.put("object", "model"); + model.put("vendor", "Anthropic"); + model.put("version", "1"); + model.put("preview", false); + model.put("model_picker_enabled", true); + model.put("capabilities", capabilities); + if (supportedEndpoints != null) { + model.put("supported_endpoints", supportedEndpoints); + } + + Map root = new LinkedHashMap<>(); + root.put("data", List.of(model)); + return json(root); + } + + /** + * Returns the ordered {@code /responses} event objects the runtime's reducer + * expects. Used raw (one object == one WebSocket message) for the WS path and + * SSE-framed for the HTTP path. + */ + static List> responsesEvents(String text, String respId) { + Map created = new LinkedHashMap<>(); + created.put("type", "response.created"); + created.put("response", responseShell(respId, "in_progress", List.of())); + + Map itemAdded = new LinkedHashMap<>(); + itemAdded.put("type", "response.output_item.added"); + itemAdded.put("output_index", 0); + itemAdded.put("item", message("msg_1", List.of())); + + Map partAdded = new LinkedHashMap<>(); + partAdded.put("type", "response.content_part.added"); + partAdded.put("output_index", 0); + partAdded.put("content_index", 0); + partAdded.put("part", outputText("")); + + Map delta = new LinkedHashMap<>(); + delta.put("type", "response.output_text.delta"); + delta.put("output_index", 0); + delta.put("content_index", 0); + delta.put("delta", text); + + Map done = new LinkedHashMap<>(); + done.put("type", "response.output_text.done"); + done.put("output_index", 0); + done.put("content_index", 0); + done.put("text", text); + + Map completedResponse = responseShell(respId, "completed", + List.of(message("msg_1", List.of(outputText(text))))); + completedResponse.put("usage", usage()); + Map completed = new LinkedHashMap<>(); + completed.put("type", "response.completed"); + completed.put("response", completedResponse); + + return List.of(created, itemAdded, partAdded, delta, done, completed); + } + + private static Map responseShell(String respId, String status, List output) { + Map response = new LinkedHashMap<>(); + response.put("id", respId); + response.put("object", "response"); + response.put("status", status); + response.put("output", output); + return response; + } + + private static Map message(String id, List content) { + Map item = new LinkedHashMap<>(); + item.put("id", id); + item.put("type", "message"); + item.put("role", "assistant"); + item.put("content", content); + return item; + } + + private static Map outputText(String text) { + Map part = new LinkedHashMap<>(); + part.put("type", "output_text"); + part.put("text", text); + return part; + } + + private static Map usage() { + Map usage = new LinkedHashMap<>(); + usage.put("input_tokens", 5); + usage.put("output_tokens", 7); + usage.put("total_tokens", 12); + return usage; + } + + private static List> chatCompletionChunks(String text) { + Map c1 = chatChunkBase(); + c1.put("choices", List.of(choice(0, delta("assistant", ""), null))); + Map c2 = chatChunkBase(); + c2.put("choices", List.of(choice(0, delta(null, text), null))); + Map c3 = chatChunkBase(); + c3.put("choices", List.of(choice(0, new LinkedHashMap<>(), "stop"))); + c3.put("usage", chatUsage()); + return List.of(c1, c2, c3); + } + + private static Map chatChunkBase() { + Map base = new LinkedHashMap<>(); + base.put("id", "chatcmpl-stub-1"); + base.put("object", "chat.completion.chunk"); + base.put("created", 1); + base.put("model", "claude-sonnet-4.5"); + return base; + } + + private static Map delta(String role, String content) { + Map delta = new LinkedHashMap<>(); + if (role != null) { + delta.put("role", role); + } + delta.put("content", content); + return delta; + } + + private static Map choice(int index, Map delta, String finishReason) { + Map choice = new LinkedHashMap<>(); + choice.put("index", index); + choice.put("delta", delta); + choice.put("finish_reason", finishReason); + return choice; + } + + private static Map chatUsage() { + Map usage = new LinkedHashMap<>(); + usage.put("prompt_tokens", 5); + usage.put("completion_tokens", 7); + usage.put("total_tokens", 12); + return usage; + } + + private static Map chatCompletion(String text) { + Map message = new LinkedHashMap<>(); + message.put("role", "assistant"); + message.put("content", text); + + Map choice = new LinkedHashMap<>(); + choice.put("index", 0); + choice.put("message", message); + choice.put("finish_reason", "stop"); + + Map root = new LinkedHashMap<>(); + root.put("id", "chatcmpl-stub-1"); + root.put("object", "chat.completion"); + root.put("created", 1); + root.put("model", "claude-sonnet-4.5"); + root.put("choices", List.of(choice)); + root.put("usage", chatUsage()); + return root; + } + + static String assistantText(AssistantMessageEvent event) { + if (event == null || event.getData() == null) { + return ""; + } + String content = event.getData().content(); + return content != null ? content : ""; + } + + /** A single request the handler intercepted. */ + record InterceptedRequest(String url, String sessionId, String agentId, String parentAgentId, + String interactionType, String body) { + } + + /** + * A {@link CopilotRequestHandler} that records every intercepted request and + * fully replaces the upstream call with a fabricated, well-formed response for + * every model-layer endpoint, so an agent turn completes entirely off-network. + */ + static class RecordingRequestHandler extends CopilotRequestHandler { + + private final ConcurrentLinkedQueue records = new ConcurrentLinkedQueue<>(); + private final String text; + + RecordingRequestHandler(String text) { + this.text = text; + } + + List records() { + return new ArrayList<>(records); + } + + List inferenceRequests() { + List out = new ArrayList<>(); + for (InterceptedRequest r : records) { + if (isInferenceUrl(r.url())) { + out.add(r); + } + } + return out; + } + + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext ctx) + throws Exception { + String url = request.uri().toString(); + String body = requestBodyText(request); + records.add(new InterceptedRequest(url, ctx.sessionId(), ctx.agentId(), ctx.parentAgentId(), + ctx.interactionType(), body)); + if (isInferenceUrl(url)) { + return buildInferenceResponse(url, body, text); + } + return buildNonInferenceResponse(url); + } + } + + /** + * A minimal {@link HttpResponse} over an in-memory body for the send override. + */ + private static final class StubHttpResponse implements HttpResponse { + + private final int status; + private final HttpHeaders headers; + private final byte[] body; + + StubHttpResponse(int status, String contentType, String body) { + this.status = status; + this.body = body.getBytes(StandardCharsets.UTF_8); + this.headers = HttpHeaders.of(Map.of("content-type", List.of(contentType)), (k, v) -> true); + } + + @Override + public int statusCode() { + return status; + } + + @Override + public HttpRequest request() { + return null; + } + + @Override + public Optional> previousResponse() { + return Optional.empty(); + } + + @Override + public HttpHeaders headers() { + return headers; + } + + @Override + public InputStream body() { + return new ByteArrayInputStream(body); + } + + @Override + public Optional sslSession() { + return Optional.empty(); + } + + @Override + public URI uri() { + return null; + } + + @Override + public HttpClient.Version version() { + return HttpClient.Version.HTTP_1_1; + } + } +} diff --git a/java/src/test/java/com/github/copilot/CopilotSessionTest.java b/java/sdk/src/test/java/com/github/copilot/CopilotSessionTest.java similarity index 97% rename from java/src/test/java/com/github/copilot/CopilotSessionTest.java rename to java/sdk/src/test/java/com/github/copilot/CopilotSessionTest.java index 44a7373ec..eb061b029 100644 --- a/java/src/test/java/com/github/copilot/CopilotSessionTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CopilotSessionTest.java @@ -756,8 +756,27 @@ void testShouldGetLastSessionId() throws Exception { ctx.configureForTest("session", "should_get_last_session_id"); try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client - .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + CopilotSession session = null; + for (int attempt = 1; attempt <= 2; attempt++) { + CompletableFuture createFuture = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)); + try { + session = createFuture.get(45, TimeUnit.SECONDS); + break; + } catch (java.util.concurrent.TimeoutException e) { + createFuture.cancel(true); + if (attempt == 2) { + throw e; + } + } catch (java.util.concurrent.ExecutionException e) { + if (e.getCause() instanceof java.util.concurrent.TimeoutException && attempt < 2) { + createFuture.cancel(true); + continue; + } + throw e; + } + } + assertNotNull(session, "Session should be created"); session.sendAndWait(new MessageOptions().setPrompt("Say hello")).get(60, TimeUnit.SECONDS); String sessionId = session.getSessionId(); diff --git a/java/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java b/java/sdk/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java similarity index 99% rename from java/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java rename to java/sdk/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java index 156c96848..79e968cd3 100644 --- a/java/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java +++ b/java/sdk/src/test/java/com/github/copilot/CreateSessionReKeyEntryTest.java @@ -170,8 +170,9 @@ private static void injectConnection(CopilotClient client, JsonRpcClient rpc) th var ctor = connClass.getDeclaredConstructors()[0]; ctor.setAccessible(true); - // Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc) - Object connection = ctor.newInstance(rpc, null, null); + // Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc, + // AutoCloseable runtimeHost) + Object connection = ctor.newInstance(rpc, null, null, null); Field f = CopilotClient.class.getDeclaredField("connectionFuture"); f.setAccessible(true); diff --git a/java/src/test/java/com/github/copilot/DataObjectCoverageTest.java b/java/sdk/src/test/java/com/github/copilot/DataObjectCoverageTest.java similarity index 83% rename from java/src/test/java/com/github/copilot/DataObjectCoverageTest.java rename to java/sdk/src/test/java/com/github/copilot/DataObjectCoverageTest.java index ece824234..f95c5bcc5 100644 --- a/java/src/test/java/com/github/copilot/DataObjectCoverageTest.java +++ b/java/sdk/src/test/java/com/github/copilot/DataObjectCoverageTest.java @@ -139,6 +139,27 @@ void permissionRequestSetExtensionData() { assertEquals("value", req.getExtensionData().get("key")); } + @Test + void permissionRequestPreservesMcpExtensionData() { + var request = PermissionRequest.fromJsonValue( + java.util.Map.of("kind", "mcp", "serverName", "playwright", "toolName", "playwright-browser_navigate", + "args", java.util.Map.of("url", "http://127.0.0.1:8106/docs/target-app/"))); + + assertEquals("mcp", request.getKind()); + assertEquals("playwright", request.getExtensionData().get("serverName")); + assertEquals("playwright-browser_navigate", request.getExtensionData().get("toolName")); + @SuppressWarnings("unchecked") + var args = (java.util.Map) request.getExtensionData().get("args"); + assertEquals("http://127.0.0.1:8106/docs/target-app/", args.get("url")); + } + + @Test + void permissionRequestWithoutExtensionDataPreservesNull() { + var request = PermissionRequest.fromJsonValue(java.util.Map.of("kind", "read", "toolCallId", "tool-123")); + + assertNull(request.getExtensionData()); + } + // ===== SectionOverride setContent ===== @Test @@ -186,7 +207,7 @@ void postToolUseHookInputSessionIdRoundTrip() { assertEquals("session-xyz", input.getSessionId()); } - // ===== CustomAgentConfig model field ===== + // ===== CustomAgentConfig model fields ===== @Test void customAgentConfigModelGetterAndSetter() { @@ -227,6 +248,36 @@ void customAgentConfigModelOmittedWhenNull() throws Exception { assertFalse(json.contains("\"model\"")); } + @Test + void customAgentConfigReasoningEffortGetterAndFluentSetter() { + var cfg = new CustomAgentConfig(); + assertNull(cfg.getReasoningEffort()); + + var result = cfg.setReasoningEffort("high"); + assertSame(cfg, result); + assertEquals("high", cfg.getReasoningEffort()); + } + + @Test + void customAgentConfigReasoningEffortSerializationRoundTrip() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + var cfg = new CustomAgentConfig().setName("reasoning-agent").setReasoningEffort("high"); + + var json = mapper.writeValueAsString(cfg); + assertTrue(json.contains("\"reasoningEffort\":\"high\"")); + + var deserialized = mapper.readValue(json, CustomAgentConfig.class); + assertEquals("high", deserialized.getReasoningEffort()); + } + + @Test + void customAgentConfigReasoningEffortOmittedWhenNull() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(new CustomAgentConfig().setName("default-agent")); + + assertFalse(json.contains("\"reasoningEffort\"")); + } + // ===== PermissionRequestResult setRules ===== @Test diff --git a/java/src/test/java/com/github/copilot/DocumentationSamplesTest.java b/java/sdk/src/test/java/com/github/copilot/DocumentationSamplesTest.java similarity index 99% rename from java/src/test/java/com/github/copilot/DocumentationSamplesTest.java rename to java/sdk/src/test/java/com/github/copilot/DocumentationSamplesTest.java index f7170f4fd..4e1396aa9 100644 --- a/java/src/test/java/com/github/copilot/DocumentationSamplesTest.java +++ b/java/sdk/src/test/java/com/github/copilot/DocumentationSamplesTest.java @@ -132,7 +132,7 @@ private static String stripStringsAndComments(String input) { private static List documentationFiles() throws IOException { Path root = Path.of("").toAbsolutePath(); List files = new ArrayList<>(); - files.add(root.resolve("README.md")); + files.add(root.resolve("../README.md")); files.add(root.resolve("jbang-example.java")); return files; } diff --git a/java/src/test/java/com/github/copilot/E2ETestContext.java b/java/sdk/src/test/java/com/github/copilot/E2ETestContext.java similarity index 75% rename from java/src/test/java/com/github/copilot/E2ETestContext.java rename to java/sdk/src/test/java/com/github/copilot/E2ETestContext.java index 2bc139d94..60dcf1fa3 100644 --- a/java/src/test/java/com/github/copilot/E2ETestContext.java +++ b/java/sdk/src/test/java/com/github/copilot/E2ETestContext.java @@ -18,7 +18,10 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; +import com.github.copilot.ffi.InProcessEnvGuard; import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.InProcessRuntimeConnection; +import com.github.copilot.rpc.RuntimeConnection; /** * E2E test context that manages the test environment including the CapiProxy, @@ -55,6 +58,12 @@ public class E2ETestContext implements AutoCloseable { private static final Logger LOG = Logger.getLogger(E2ETestContext.class.getName()); + + /** + * The default GitHub token used by the CLI in e2e tests. The proxy resolves + * this token to the default Copilot user registered at context creation. + */ + private static final String DEFAULT_GITHUB_TOKEN = "fake-token-for-e2e-tests"; private static final Pattern SNAKE_CASE = Pattern.compile("[^a-zA-Z0-9]"); private static final Pattern USER_CONTENT_PATTERN = Pattern .compile("^\\s+-\\s+role:\\s+user\\s*$\\s+content:\\s*(.+?)$", Pattern.MULTILINE); @@ -65,6 +74,7 @@ public class E2ETestContext implements AutoCloseable { private String proxyUrl; private final CapiProxy proxy; private final Path repoRoot; + private final List inProcessEnvGuards = new ArrayList<>(); private Path currentSnapshotFile; private E2ETestContext(String cliPath, Path homeDir, Path workDir, String proxyUrl, CapiProxy proxy, @@ -97,6 +107,23 @@ public static E2ETestContext create() throws IOException, InterruptedException { CapiProxy proxy = new CapiProxy(); String proxyUrl = proxy.start(); + // Register a default Copilot user for the CLI's default token so the proxy's + // /copilot_internal/user endpoint returns a valid user (HTTP 200) instead of + // 401 "Bad credentials". CLI 1.0.64-1 gates MCP enablement on this user: + // `is_mcp_enabled` (added by the proxy) is the global gate, and snake_case + // `copilot_plan` makes the third-party MCP policy resolver early-return + // allow-all for non-org plans (anything other than business/enterprise), + // avoiding a /copilot/mcp_registry network call the proxy does not serve. + // Without this, MCP servers never reach CONNECTED. This mirrors the Go, + // Node, Python, and .NET harnesses, which all register the same default + // individual_pro user at context creation. + Map defaultUser = new HashMap<>(); + defaultUser.put("login", "e2e-test-user"); + defaultUser.put("copilot_plan", "individual_pro"); + defaultUser.put("endpoints", Map.of("api", proxyUrl, "telemetry", "https://localhost:1/telemetry")); + defaultUser.put("analytics_tracking_id", "e2e-test-tracking-id"); + proxy.setCopilotUserByToken(DEFAULT_GITHUB_TOKEN, defaultUser); + return new E2ETestContext(cliPath, homeDir, workDir, proxyUrl, proxy, repoRoot); } @@ -256,10 +283,17 @@ public List> getExchanges() throws IOException, InterruptedE public Map getEnvironment() { Map env = new HashMap<>(System.getenv()); env.put("COPILOT_API_URL", proxyUrl); + // Route GitHub API calls (e.g. the MCP registry policy check) to the + // replay proxy so MCP enablement stays hermetic. Without this the CLI + // reaches the real api.github.com, which is slow/unreachable on macOS + // CI runners and makes MCP servers time out before reaching connected. + env.put("COPILOT_DEBUG_GITHUB_API_URL", proxyUrl); env.put("COPILOT_HOME", homeDir.toString()); env.put("GH_CONFIG_DIR", homeDir.toString()); env.put("XDG_CONFIG_HOME", homeDir.toString()); env.put("XDG_STATE_HOME", homeDir.toString()); + env.put("COPILOT_MCP_APPS", "true"); + env.put("MCP_APPS", "true"); // Configure CONNECT proxy for HTTPS interception if available String connectUrl = proxy.getConnectProxyUrl(); @@ -277,8 +311,8 @@ public Map getEnvironment() { env.put("REQUESTS_CA_BUNDLE", caFile); env.put("CURL_CA_BUNDLE", caFile); env.put("GIT_SSL_CAINFO", caFile); - env.put("GH_TOKEN", "fake-token-for-e2e-tests"); - env.put("GITHUB_TOKEN", "fake-token-for-e2e-tests"); + env.put("GH_TOKEN", DEFAULT_GITHUB_TOKEN); + env.put("GITHUB_TOKEN", DEFAULT_GITHUB_TOKEN); env.put("GH_ENTERPRISE_TOKEN", ""); env.put("GITHUB_ENTERPRISE_TOKEN", ""); } @@ -292,10 +326,8 @@ public Map getEnvironment() { * @return a new CopilotClient */ public CopilotClient createClient() { - CopilotClientOptions options = new CopilotClientOptions().setCliPath(cliPath).setCwd(workDir.toString()) - .setEnvironment(getEnvironment()).setGitHubToken("fake-token-for-e2e-tests"); - - return new CopilotClient(options); + CopilotClientOptions options = new CopilotClientOptions().setGitHubToken(DEFAULT_GITHUB_TOKEN); + return createClient(options); } /** @@ -308,6 +340,31 @@ public CopilotClient createClient() { * @return a new CopilotClient */ public CopilotClient createClient(CopilotClientOptions options) { + CopilotClient client = applyContextOptions(options); + if (client != null) { + return client; + } + if (options.getGitHubToken() == null) { + options.setGitHubToken(DEFAULT_GITHUB_TOKEN); + } + + return new CopilotClient(options); + } + + private CopilotClient applyContextOptions(CopilotClientOptions options) { + if (isInProcessMode(options)) { + InProcessEnvGuard guard = new InProcessEnvGuard(buildInProcessEnvironment(options)); + inProcessEnvGuards.add(guard); + try { + options.setEnvironment(null); + options.setCwd(null); + options.setCliArgs(null); + return new CopilotClient(options, guard::close); + } catch (RuntimeException e) { + guard.close(); + throw e; + } + } if (options.getCliPath() == null) { options.setCliPath(cliPath); } @@ -317,11 +374,30 @@ public CopilotClient createClient(CopilotClientOptions options) { if (options.getEnvironment() == null || options.getEnvironment().isEmpty()) { options.setEnvironment(getEnvironment()); } - if (options.getGitHubToken() == null) { - options.setGitHubToken("fake-token-for-e2e-tests"); + return null; + } + + private boolean isInProcessMode(CopilotClientOptions options) { + RuntimeConnection connection = options.getConnection(); + if (connection != null) { + return connection instanceof InProcessRuntimeConnection; + } + if (options.getRequestHandler() != null || options.getCliUrl() != null || options.getCliPath() != null + || options.getPort() != 0) { + return false; } + String defaultConnection = System.getenv("COPILOT_SDK_DEFAULT_CONNECTION"); + return defaultConnection != null && "inprocess".equalsIgnoreCase(defaultConnection.trim()); + } - return new CopilotClient(options); + private Map buildInProcessEnvironment(CopilotClientOptions options) { + Map env = new HashMap<>(getEnvironment()); + Map optionEnvironment = options.getEnvironment(); + if (optionEnvironment != null && !optionEnvironment.isEmpty()) { + env.putAll(optionEnvironment); + options.setEnvironment(null); + } + return env; } /** @@ -351,6 +427,24 @@ public void setCopilotUserByToken(String token, String login, String copilotPlan proxy.setCopilotUserByToken(token, login, copilotPlan, apiUrl, telemetryUrl, analyticsTrackingId); } + /** + * Configures the proxy to return a raw Copilot user response for a given token. + * + * @param token + * the GitHub token + * @param response + * the raw response object to return for the token + * @throws IOException + * if the request fails + * @throws InterruptedException + * if the request is interrupted + */ + public void setCopilotUserByToken(String token, Map response) + throws IOException, InterruptedException { + ensureProxyAlive(); + proxy.setCopilotUserByToken(token, response); + } + /** * Initializes the proxy state without loading a snapshot. *

@@ -380,6 +474,9 @@ public void initializeProxy() throws IOException, InterruptedException { @Override public void close() throws Exception { + for (int i = inProcessEnvGuards.size() - 1; i >= 0; i--) { + inProcessEnvGuards.get(i).close(); + } proxy.stop(); // Clean up temp directories (best effort) @@ -410,7 +507,6 @@ private static Path findRepoRoot() throws IOException { } private static String getCliPath(Path repoRoot) throws IOException { - // Try environment variable first (explicit override) String envPath = System.getenv("COPILOT_CLI_PATH"); if (envPath != null && !envPath.isEmpty()) { return envPath; @@ -438,10 +534,21 @@ private static String getCliPath(Path repoRoot) throws IOException { return harnessCliPath.toString(); } - // Try nodejs installation - Path cliPath = repoRoot.resolve("nodejs/node_modules/@github/copilot/index.js"); - if (Files.exists(cliPath)) { - return cliPath.toString(); + // Try nodejs installation. As of CLI 1.0.64-1 the @github/copilot package + // is a thin loader; the runnable index.js ships in the installed + // platform-specific package (e.g. @github/copilot-linux-x64). Exactly one + // is installed. Running index.js under Node.js is the documented preferred + // entry point and matches the Go, Python, Rust, and .NET test harnesses. + Path githubModules = repoRoot.resolve("nodejs/node_modules/@github"); + if (Files.isDirectory(githubModules)) { + try (var modules = Files.newDirectoryStream(githubModules, "copilot-*")) { + for (Path module : modules) { + Path indexJs = module.resolve("index.js"); + if (Files.exists(indexJs)) { + return indexJs.toString(); + } + } + } } // Fallback: try to find 'copilot' in PATH diff --git a/java/src/test/java/com/github/copilot/ElicitationTest.java b/java/sdk/src/test/java/com/github/copilot/ElicitationTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ElicitationTest.java rename to java/sdk/src/test/java/com/github/copilot/ElicitationTest.java diff --git a/java/src/test/java/com/github/copilot/ErrorHandlingTest.java b/java/sdk/src/test/java/com/github/copilot/ErrorHandlingTest.java similarity index 94% rename from java/src/test/java/com/github/copilot/ErrorHandlingTest.java rename to java/sdk/src/test/java/com/github/copilot/ErrorHandlingTest.java index 32579ffc4..46f6741a0 100644 --- a/java/src/test/java/com/github/copilot/ErrorHandlingTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ErrorHandlingTest.java @@ -158,6 +158,10 @@ void testShouldHandlePermissionHandlerErrorsGracefully_deniesPermission() throws || content.contains("permission") || content.contains("denied"), "Response should indicate permission was denied: " + content); + // Verify that the error handler was wired correctly. Whether error events are + // actually emitted depends on the CLI version and the scenario's replay data. + LOG.info("Collected " + errorEvents.size() + " error event(s) from permission handler crash"); + session.close(); } } @@ -198,9 +202,10 @@ void testPermissionHandlerErrors_sessionErrorEventContainsDetails() throws Excep session.close(); } - // Note: Whether error events are emitted depends on the CLI version and - // scenario - // This test verifies the handler can receive them when they occur + // Whether error events are emitted depends on the CLI version and scenario. + // This test verifies the handler can receive them when they occur. + // Access the list to confirm it was populated (even if empty is acceptable). + LOG.info("Collected " + errorEvents.size() + " error event(s)"); } /** diff --git a/java/src/test/java/com/github/copilot/EventFidelityTest.java b/java/sdk/src/test/java/com/github/copilot/EventFidelityTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/EventFidelityTest.java rename to java/sdk/src/test/java/com/github/copilot/EventFidelityTest.java diff --git a/java/src/test/java/com/github/copilot/ExecutorWiringTest.java b/java/sdk/src/test/java/com/github/copilot/ExecutorWiringTest.java similarity index 95% rename from java/src/test/java/com/github/copilot/ExecutorWiringTest.java rename to java/sdk/src/test/java/com/github/copilot/ExecutorWiringTest.java index 78764db0f..a8319475c 100644 --- a/java/src/test/java/com/github/copilot/ExecutorWiringTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ExecutorWiringTest.java @@ -86,8 +86,7 @@ int getTaskCount() { } private CopilotClientOptions createOptionsWithExecutor(TrackingExecutor executor) { - CopilotClientOptions options = new CopilotClientOptions().setCliPath(ctx.getCliPath()) - .setCwd(ctx.getWorkDir().toString()).setEnvironment(ctx.getEnvironment()).setExecutor(executor) + CopilotClientOptions options = new CopilotClientOptions().setExecutor(executor) .setGitHubToken("fake-token-for-e2e-tests"); return options; } @@ -111,7 +110,7 @@ void testClientStartUsesProvidedExecutor() throws Exception { TrackingExecutor trackingExecutor = new TrackingExecutor(ForkJoinPool.commonPool()); int beforeStart = trackingExecutor.getTaskCount(); - try (CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor))) { + try (CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor))) { client.start().get(30, TimeUnit.SECONDS); assertTrue(trackingExecutor.getTaskCount() > beforeStart, @@ -156,7 +155,7 @@ void testToolCallDispatchUsesProvidedExecutor() throws Exception { }); // Reset count after client construction to isolate tool-call dispatch - try (CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor))) { + try (CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor))) { CopilotSession session = client.createSession(new SessionConfig().setTools(List.of(encryptTool)) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); @@ -198,7 +197,7 @@ void testPermissionDispatchUsesProvidedExecutor() throws Exception { var config = new SessionConfig().setOnPermissionRequest((request, invocation) -> CompletableFuture .completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED))); - try (CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor))) { + try (CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor))) { CopilotSession session = client.createSession(config).get(); Path testFile = ctx.getWorkDir().resolve("test.txt"); @@ -247,7 +246,7 @@ void testUserInputDispatchUsesProvidedExecutor() throws Exception { .completedFuture(new UserInputResponse().setAnswer(answer).setWasFreeform(wasFreeform)); }); - try (CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor))) { + try (CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor))) { CopilotSession session = client.createSession(config).get(); int beforeSend = trackingExecutor.getTaskCount(); @@ -286,7 +285,7 @@ void testHooksDispatchUsesProvidedExecutor() throws Exception { .setHooks(new SessionHooks().setOnPreToolUse( (input, invocation) -> CompletableFuture.completedFuture(PreToolUseHookOutput.allow()))); - try (CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor))) { + try (CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor))) { CopilotSession session = client.createSession(config).get(); Path testFile = ctx.getWorkDir().resolve("hello.txt"); @@ -342,7 +341,7 @@ void testClientStopUsesProvidedExecutor() throws Exception { return CompletableFuture.completedFuture(input.toUpperCase()); }); - CopilotClient client = new CopilotClient(createOptionsWithExecutor(trackingExecutor)); + CopilotClient client = ctx.createClient(createOptionsWithExecutor(trackingExecutor)); client.createSession(new SessionConfig().setTools(List.of(encryptTool)) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); diff --git a/java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java b/java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java new file mode 100644 index 000000000..909cd1406 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/FakeUpstreamServer.java @@ -0,0 +1,302 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.InetAddress; +import java.net.ServerSocket; +import java.net.Socket; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.util.ArrayList; +import java.util.Base64; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * A minimal raw-socket HTTP/1.1 + RFC 6455 WebSocket upstream used by the + * idiomatic-handler e2e test. + *

+ * It serves the synthetic CAPI HTTP endpoints (model catalog, model session, + * policy, {@code /responses} SSE) and, on a WebSocket upgrade, echoes the + * ordered {@code /responses} events as one batch of text messages per inbound + * message. It avoids any third-party server dependency so the test exercises + * the real {@link java.net.http.WebSocket} forwarding path against a genuine + * upstream. + *

+ */ +final class FakeUpstreamServer implements AutoCloseable { + + private static final String WS_MAGIC = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; + + private final ServerSocket serverSocket; + private final Thread acceptThread; + private final AtomicInteger upstreamWsRequests = new AtomicInteger(); + private final String httpText; + private final String wsText; + private volatile boolean running = true; + + FakeUpstreamServer(String httpText, String wsText) throws IOException { + this.httpText = httpText; + this.wsText = wsText; + this.serverSocket = new ServerSocket(0, 50, InetAddress.getByName("127.0.0.1")); + this.acceptThread = new Thread(this::acceptLoop, "fake-upstream-accept"); + this.acceptThread.setDaemon(true); + this.acceptThread.start(); + } + + int port() { + return serverSocket.getLocalPort(); + } + + String httpUrl() { + return "http://127.0.0.1:" + port(); + } + + String wsUrl() { + return "ws://127.0.0.1:" + port(); + } + + int upstreamWsRequests() { + return upstreamWsRequests.get(); + } + + private void acceptLoop() { + while (running) { + try { + Socket socket = serverSocket.accept(); + Thread t = new Thread(() -> handle(socket), "fake-upstream-conn"); + t.setDaemon(true); + t.start(); + } catch (IOException e) { + return; + } + } + } + + private void handle(Socket socket) { + try (socket) { + InputStream in = socket.getInputStream(); + OutputStream out = socket.getOutputStream(); + + String requestLine = readLine(in); + if (requestLine == null || requestLine.isEmpty()) { + return; + } + String[] parts = requestLine.split(" "); + String path = parts.length > 1 ? parts[1] : "/"; + + Map headers = new java.util.LinkedHashMap<>(); + String line; + while ((line = readLine(in)) != null && !line.isEmpty()) { + int colon = line.indexOf(':'); + if (colon > 0) { + headers.put(line.substring(0, colon).trim().toLowerCase(Locale.ROOT), + line.substring(colon + 1).trim()); + } + } + + if ("websocket".equalsIgnoreCase(headers.get("upgrade"))) { + serveWebSocket(in, out, headers); + return; + } + serveHttp(in, out, path, headers); + } catch (Exception ignored) { + // Connection error; drop it. + } + } + + private void serveHttp(InputStream in, OutputStream out, String path, Map headers) + throws IOException { + String contentLength = headers.get("content-length"); + if (contentLength != null) { + int len; + try { + len = Integer.parseInt(contentLength.trim()); + } catch (NumberFormatException e) { + len = 0; + } + byte[] body = new byte[len]; + int read = 0; + while (read < len) { + int n = in.read(body, read, len - read); + if (n < 0) { + break; + } + read += n; + } + } + + String lower = path.toLowerCase(Locale.ROOT); + String contentType = "application/json"; + String body; + int status = 200; + if (lower.endsWith("/models")) { + body = CopilotRequestTestSupport.modelCatalog(List.of("/responses", "ws:/responses")); + } else if (lower.contains("/models/session")) { + body = "{}"; + } else if (lower.contains("/policy")) { + body = "{\"state\":\"enabled\"}"; + } else if (lower.endsWith("/responses")) { + contentType = "text/event-stream"; + body = CopilotRequestTestSupport.sseBody(httpText, "resp_stub_http"); + } else { + status = 404; + body = "{\"error\":\"not_found\"}"; + } + + byte[] bodyBytes = body.getBytes(StandardCharsets.UTF_8); + String header = "HTTP/1.1 " + status + " " + (status == 200 ? "OK" : "Not Found") + "\r\n" + "content-type: " + + contentType + "\r\n" + "content-length: " + bodyBytes.length + "\r\n" + "connection: close\r\n\r\n"; + out.write(header.getBytes(StandardCharsets.US_ASCII)); + out.write(bodyBytes); + out.flush(); + } + + private void serveWebSocket(InputStream in, OutputStream out, Map headers) throws Exception { + String key = headers.get("sec-websocket-key"); + // SHA-1 is mandated by the WebSocket protocol (RFC 6455 §4.2.2) for the + // Sec-WebSocket-Accept handshake hash. This is NOT used for security purposes. + @SuppressWarnings("codeql[java/weak-cryptographic-algorithm]") + MessageDigest sha1 = MessageDigest.getInstance("SHA-1"); // lgtm[java/weak-cryptographic-algorithm] + byte[] digest = sha1.digest((key + WS_MAGIC).getBytes(StandardCharsets.US_ASCII)); + String accept = Base64.getEncoder().encodeToString(digest); + String response = "HTTP/1.1 101 Switching Protocols\r\n" + "Upgrade: websocket\r\n" + "Connection: Upgrade\r\n" + + "Sec-WebSocket-Accept: " + accept + "\r\n\r\n"; + out.write(response.getBytes(StandardCharsets.US_ASCII)); + out.flush(); + + ByteArrayOutputStream message = new ByteArrayOutputStream(); + while (true) { + int b1 = in.read(); + if (b1 < 0) { + return; + } + boolean fin = (b1 & 0x80) != 0; + int opcode = b1 & 0x0F; + + int b2 = in.read(); + if (b2 < 0) { + return; + } + boolean masked = (b2 & 0x80) != 0; + long len = b2 & 0x7F; + if (len == 126) { + len = ((long) in.read() << 8) | in.read(); + } else if (len == 127) { + len = 0; + for (int i = 0; i < 8; i++) { + len = (len << 8) | in.read(); + } + } + + byte[] mask = new byte[4]; + if (masked) { + readFully(in, mask, 4); + } + byte[] payload = new byte[(int) len]; + readFully(in, payload, (int) len); + if (masked) { + for (int i = 0; i < payload.length; i++) { + payload[i] ^= mask[i % 4]; + } + } + + if (opcode == 0x8) { + writeFrame(out, 0x8, new byte[0]); + out.flush(); + return; + } + if (opcode == 0x9) { + writeFrame(out, 0xA, payload); + out.flush(); + continue; + } + if (opcode == 0x0 || opcode == 0x1 || opcode == 0x2) { + message.writeBytes(payload); + if (!fin) { + continue; + } + message.reset(); + upstreamWsRequests.incrementAndGet(); + for (Map event : CopilotRequestTestSupport.responsesEvents(wsText, "resp_stub_ws")) { + byte[] raw = CopilotRequestTestSupport.json(event).getBytes(StandardCharsets.UTF_8); + writeFrame(out, 0x1, raw); + } + out.flush(); + } + } + } + + private static void writeFrame(OutputStream out, int opcode, byte[] payload) throws IOException { + List bytes = new ArrayList<>(); + bytes.add(0x80 | opcode); + int len = payload.length; + if (len < 126) { + bytes.add(len); + } else if (len < 65536) { + bytes.add(126); + bytes.add((len >> 8) & 0xFF); + bytes.add(len & 0xFF); + } else { + bytes.add(127); + for (int i = 7; i >= 0; i--) { + bytes.add((int) ((((long) len) >> (8 * i)) & 0xFF)); + } + } + byte[] header = new byte[bytes.size()]; + for (int i = 0; i < bytes.size(); i++) { + header[i] = (byte) (int) bytes.get(i); + } + out.write(header); + out.write(payload); + } + + private static void readFully(InputStream in, byte[] buffer, int len) throws IOException { + int read = 0; + while (read < len) { + int n = in.read(buffer, read, len - read); + if (n < 0) { + throw new IOException("Unexpected end of stream"); + } + read += n; + } + } + + private static String readLine(InputStream in) throws IOException { + ByteArrayOutputStream buffer = new ByteArrayOutputStream(); + int c; + while ((c = in.read()) != -1) { + if (c == '\r') { + int next = in.read(); + if (next == '\n' || next == -1) { + break; + } + buffer.write('\r'); + buffer.write(next); + continue; + } + if (c == '\n') { + break; + } + buffer.write(c); + } + if (c == -1 && buffer.size() == 0) { + return null; + } + return buffer.toString(StandardCharsets.US_ASCII); + } + + @Override + public void close() throws IOException { + running = false; + serverSocket.close(); + } +} diff --git a/java/src/test/java/com/github/copilot/ForwardCompatibilityTest.java b/java/sdk/src/test/java/com/github/copilot/ForwardCompatibilityTest.java similarity index 85% rename from java/src/test/java/com/github/copilot/ForwardCompatibilityTest.java rename to java/sdk/src/test/java/com/github/copilot/ForwardCompatibilityTest.java index 40166307e..9163ae135 100644 --- a/java/src/test/java/com/github/copilot/ForwardCompatibilityTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ForwardCompatibilityTest.java @@ -56,6 +56,22 @@ void parse_unknownEventType_returnsUnknownSessionEvent() throws Exception { assertEquals("future.feature_from_server", result.getType()); } + @Test + void parse_internalEventType_returnsUnknownSessionEvent() throws Exception { + String json = """ + { + "id": "12345678-1234-1234-1234-123456789abc", + "timestamp": "2026-06-15T10:30:00Z", + "type": "session.memory_changed", + "data": {} + } + """; + SessionEvent result = MAPPER.readValue(json, SessionEvent.class); + + assertInstanceOf(UnknownSessionEvent.class, result); + assertEquals("session.memory_changed", result.getType()); + } + @Test void parse_unknownEventType_preservesOriginalType() throws Exception { String json = """ diff --git a/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java new file mode 100644 index 000000000..d41c5f97d --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryForwardingIT.java @@ -0,0 +1,59 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.GitHubTelemetryNotification; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +/** + * Failsafe integration test that verifies the live CLI forwards GitHub + * telemetry notifications during session creation. + */ +@AllowCopilotExperimental +class GitHubTelemetryForwardingIT { + + @Test + void forwardsGitHubTelemetryForALiveSession() throws Exception { + var notifications = new CopyOnWriteArrayList(); + var firstNotification = new CompletableFuture(); + + try (E2ETestContext ctx = E2ETestContext.create()) { + var options = new CopilotClientOptions().setOnGitHubTelemetry(notification -> { + notifications.add(notification); + firstNotification.complete(notification); + return CompletableFuture.completedFuture(null); + }); + + try (CopilotClient client = ctx.createClient(options); + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS)) { + + GitHubTelemetryNotification notification = firstNotification.get(30, TimeUnit.SECONDS); + + assertFalse(notifications.isEmpty(), "Expected at least one GitHub telemetry notification"); + assertNotNull(notification, "Expected a GitHub telemetry notification"); + assertNotNull(notification.sessionId(), "Telemetry notification sessionId must be present"); + assertTrue(!notification.sessionId().isBlank(), "Telemetry notification sessionId must be non-empty"); + assertNotNull(notification.restricted(), "Telemetry notification restricted flag must be present"); + assertNotNull(notification.event(), "Telemetry notification event must be present"); + assertNotNull(notification.event().kind(), "Telemetry event kind must be present"); + assertTrue(!notification.event().kind().isBlank(), "Telemetry event kind must be non-empty"); + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java new file mode 100644 index 000000000..7b0deb997 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/GitHubTelemetryTest.java @@ -0,0 +1,309 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.io.OutputStream; +import java.net.ServerSocket; +import java.net.Socket; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.github.copilot.generated.rpc.GitHubTelemetryNotification; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * Exercises the hand-written GitHub telemetry forwarding surface: the + * {@code gitHubTelemetry.event} notification adapter, the + * {@code enableGitHubTelemetryForwarding} capability flag on the connect + * handshake and the create/resume requests, and the {@code onGitHubTelemetry} + * client option. + */ +@AllowCopilotExperimental +class GitHubTelemetryTest { + + private record SocketPair(JsonRpcClient client, Socket serverSide, + ServerSocket serverSocket) implements AutoCloseable { + + @Override + public void close() throws Exception { + client.close(); + serverSide.close(); + serverSocket.close(); + } + } + + private SocketPair createSocketPair() throws Exception { + var serverSocket = new ServerSocket(0); + var clientSocket = new Socket("localhost", serverSocket.getLocalPort()); + var serverSide = serverSocket.accept(); + var client = JsonRpcClient.fromSocket(clientSocket); + return new SocketPair(client, serverSide, serverSocket); + } + + private void writeRpcMessage(OutputStream out, String json) throws IOException { + byte[] content = json.getBytes(StandardCharsets.UTF_8); + String header = "Content-Length: " + content.length + "\r\n\r\n"; + out.write(header.getBytes(StandardCharsets.UTF_8)); + out.write(content); + out.flush(); + } + + @Test + void adapterDispatchesNotificationToHandlerWithTypedPayload() throws Exception { + try (var pair = createSocketPair()) { + var received = new CompletableFuture(); + Function> handler = notification -> { + received.complete(notification); + return CompletableFuture.completedFuture(null); + }; + new GitHubTelemetryAdapter(handler).registerHandlers(pair.client()); + + String notification = """ + { + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": { + "sessionId": "sess-123", + "restricted": true, + "event": { + "kind": "tool_call_executed", + "created_at": "2024-01-01T00:00:00Z", + "model_call_id": "call-9", + "properties": { "tool": "shell" }, + "metrics": { "duration_ms": 42.5 }, + "exp_assignment_context": "ctx", + "features": { "flag_a": "on" }, + "session_id": "sess-123", + "copilot_tracking_id": "track-1", + "client": { + "cli_version": "1.2.3", + "os_platform": "win32", + "os_version": "10", + "os_arch": "x64", + "node_version": "20.0.0", + "is_staff": false + } + } + } + } + """; + writeRpcMessage(pair.serverSide().getOutputStream(), notification); + + GitHubTelemetryNotification result = received.get(5, TimeUnit.SECONDS); + assertEquals("sess-123", result.sessionId()); + assertTrue(result.restricted()); + + var event = result.event(); + assertNotNull(event); + assertEquals("tool_call_executed", event.kind()); + assertEquals("2024-01-01T00:00:00Z", event.createdAt()); + assertEquals("call-9", event.modelCallId()); + assertEquals("shell", event.properties().get("tool")); + assertEquals(42.5, event.metrics().get("duration_ms")); + assertEquals("ctx", event.expAssignmentContext()); + assertEquals("on", event.features().get("flag_a")); + assertEquals("sess-123", event.sessionId()); + assertEquals("track-1", event.copilotTrackingId()); + + var client = event.client(); + assertNotNull(client); + assertEquals("1.2.3", client.cliVersion()); + assertEquals("win32", client.osPlatform()); + assertEquals("x64", client.osArch()); + assertEquals("20.0.0", client.nodeVersion()); + assertEquals(Boolean.FALSE, client.isStaff()); + } + } + + @Test + void clientOptsSessionsIntoForwardingAndReceivesEvents() throws Exception { + var received = new CompletableFuture(); + Function> handler = notification -> { + received.complete(notification); + return CompletableFuture.completedFuture(null); + }; + + try (var server = new FakeRuntimeServer(); + var client = new CopilotClient( + new CopilotClientOptions().setCliUrl(server.url()).setOnGitHubTelemetry(handler))) { + + client.start().get(15, TimeUnit.SECONDS); + + // Connecting must opt into telemetry forwarding at the connection level so + // the runtime can forward the first session's un-replayable start event. + JsonNode connectParams = server.awaitConnect(); + assertTrue(connectParams.path("enableGitHubTelemetryForwarding").asBoolean(), + "connect request should carry enableGitHubTelemetryForwarding=true"); + + // Creating a session must opt it into telemetry forwarding. + client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(15, + TimeUnit.SECONDS); + JsonNode createParams = server.awaitCreate(); + assertTrue(createParams.path("enableGitHubTelemetryForwarding").asBoolean(), + "create request should carry enableGitHubTelemetryForwarding=true"); + + // The adapter registered on connect should forward server-pushed events. + server.sendTelemetry(Map.of("sessionId", "sess-xyz", "restricted", false, "event", + Map.of("kind", "session_started", "session_id", "sess-xyz"))); + GitHubTelemetryNotification event = received.get(5, TimeUnit.SECONDS); + assertEquals("sess-xyz", event.sessionId()); + assertFalse(event.restricted()); + assertEquals("session_started", event.event().kind()); + + // Resuming a session must opt it in as well. + client.resumeSession("resume-1", + new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(15, TimeUnit.SECONDS); + JsonNode resumeParams = server.awaitResume(); + assertTrue(resumeParams.path("enableGitHubTelemetryForwarding").asBoolean(), + "resume request should carry enableGitHubTelemetryForwarding=true"); + } + } + + @Test + void clientOmitsForwardingWhenNoHandler() throws Exception { + try (var server = new FakeRuntimeServer(); + var client = new CopilotClient(new CopilotClientOptions().setCliUrl(server.url()))) { + + client.start().get(15, TimeUnit.SECONDS); + + JsonNode connectParams = server.awaitConnect(); + assertFalse(connectParams.has("enableGitHubTelemetryForwarding"), + "connect request should omit the flag when no handler is registered"); + + client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(15, + TimeUnit.SECONDS); + JsonNode createParams = server.awaitCreate(); + assertFalse(createParams.has("enableGitHubTelemetryForwarding"), + "create request should omit the flag when no handler is registered"); + + client.resumeSession("resume-1", + new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(15, TimeUnit.SECONDS); + JsonNode resumeParams = server.awaitResume(); + assertFalse(resumeParams.has("enableGitHubTelemetryForwarding"), + "resume request should omit the flag when no handler is registered"); + } + } + + @Test + void optionsRetainAndCloneTelemetryHandler() { + Function> handler = n -> CompletableFuture + .completedFuture(null); + var options = new CopilotClientOptions().setOnGitHubTelemetry(handler); + assertSame(handler, options.getOnGitHubTelemetry()); + + var copy = options.clone(); + assertSame(handler, copy.getOnGitHubTelemetry()); + } + + /** + * A minimal in-process JSON-RPC runtime that answers the connect/create/resume + * handshake so a real {@link CopilotClient} can be driven over a socket, and + * can push {@code gitHubTelemetry.event} notifications back to the client. + */ + private static final class FakeRuntimeServer implements AutoCloseable { + + private final ServerSocket serverSocket; + private final Thread acceptThread; + private final CompletableFuture ready = new CompletableFuture<>(); + private final CompletableFuture connectParams = new CompletableFuture<>(); + private final CompletableFuture createParams = new CompletableFuture<>(); + private final CompletableFuture resumeParams = new CompletableFuture<>(); + + FakeRuntimeServer() throws IOException { + serverSocket = new ServerSocket(0); + acceptThread = new Thread(this::acceptLoop, "fake-runtime-accept"); + acceptThread.setDaemon(true); + acceptThread.start(); + } + + String url() { + return "127.0.0.1:" + serverSocket.getLocalPort(); + } + + JsonNode awaitConnect() throws Exception { + return connectParams.get(15, TimeUnit.SECONDS); + } + + JsonNode awaitCreate() throws Exception { + return createParams.get(15, TimeUnit.SECONDS); + } + + JsonNode awaitResume() throws Exception { + return resumeParams.get(15, TimeUnit.SECONDS); + } + + void sendTelemetry(Object params) throws Exception { + ready.get(15, TimeUnit.SECONDS).notify("gitHubTelemetry.event", params); + } + + private void acceptLoop() { + try { + Socket socket = serverSocket.accept(); + JsonRpcClient server = JsonRpcClient.fromSocket(socket, rpc -> { + rpc.registerMethodHandler("connect", (id, params) -> { + connectParams.complete(params); + respond(rpc, id, Map.of("protocolVersion", 2)); + }); + rpc.registerMethodHandler("session.create", (id, params) -> { + createParams.complete(params); + respond(rpc, id, Map.of("sessionId", params.path("sessionId").asText("created"), + "workspacePath", "/workspace")); + }); + rpc.registerMethodHandler("session.resume", (id, params) -> { + resumeParams.complete(params); + respond(rpc, id, Map.of("sessionId", params.path("sessionId").asText("resume-1"), + "workspacePath", "/workspace")); + }); + rpc.registerMethodHandler("session.destroy", (id, params) -> respond(rpc, id, Map.of())); + rpc.registerMethodHandler("runtime.shutdown", (id, params) -> respond(rpc, id, Map.of())); + }); + ready.complete(server); + } catch (IOException e) { + ready.completeExceptionally(e); + connectParams.completeExceptionally(e); + createParams.completeExceptionally(e); + resumeParams.completeExceptionally(e); + } + } + + private static void respond(JsonRpcClient server, String id, Object result) { + if (id == null) { + return; + } + try { + server.sendResponse(id, result); + } catch (IOException e) { + // Connection torn down (e.g. client closing); ignore. + } + } + + @Override + public void close() throws Exception { + JsonRpcClient server = ready.getNow(null); + if (server != null) { + server.close(); + } + serverSocket.close(); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/HooksTest.java b/java/sdk/src/test/java/com/github/copilot/HooksTest.java new file mode 100644 index 000000000..c3833891c --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/HooksTest.java @@ -0,0 +1,302 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.AgentStopHookInput; +import com.github.copilot.rpc.AgentStopHookOutput; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.PostToolUseHookInput; +import com.github.copilot.rpc.PreToolUseHookInput; +import com.github.copilot.rpc.PreToolUseHookOutput; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SessionHooks; +import com.github.copilot.rpc.UserPromptTransformedHookInput; +import com.github.copilot.rpc.UserPromptTransformedHookOutput; + +/** + * Tests for hooks functionality (pre-tool-use and post-tool-use hooks). + * + *

+ * These tests use the shared CapiProxy infrastructure for deterministic API + * response replay. Snapshots are stored in test/snapshots/hooks/. + *

+ * + *

+ * Note: Tests for userPromptSubmitted, sessionStart, and sessionEnd hooks are + * not included as they are not tested in the reference implementation .NET or + * Node.js SDKs and require test harness updates to properly invoke these hooks. + *

+ */ +public class HooksTest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + /** + * Verifies that pre-tool-use hook is invoked when model runs a tool. + * + * @see Snapshot: hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool + */ + @Test + void testInvokePreToolUseHookWhenModelRunsATool() throws Exception { + ctx.configureForTest("hooks", "invoke_pre_tool_use_hook_when_model_runs_a_tool"); + + var preToolUseInputs = new ArrayList(); + final String[] sessionIdHolder = new String[1]; + + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { + preToolUseInputs.add(input); + assertEquals(sessionIdHolder[0], invocation.getSessionId()); + return CompletableFuture.completedFuture(PreToolUseHookOutput.allow()); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + sessionIdHolder[0] = session.getSessionId(); + + // Create a file for the model to read + Path testFile = ctx.getWorkDir().resolve("hello.txt"); + Files.writeString(testFile, "Hello from the test!"); + + session.sendAndWait( + new MessageOptions().setPrompt("Read the contents of hello.txt and tell me what it says")) + .get(60, TimeUnit.SECONDS); + + // Should have received at least one preToolUse hook call + assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); + + // Should have received the tool name + assertTrue(preToolUseInputs.stream().anyMatch(i -> i.getToolName() != null && !i.getToolName().isEmpty()), + "Should have received tool name in preToolUse hook"); + } + } + + /** + * Verifies that post-tool-use hook is invoked after model runs a tool. + * + * @see Snapshot: hooks/invoke_post_tool_use_hook_after_model_runs_a_tool + */ + @Test + void testInvokePostToolUseHookAfterModelRunsATool() throws Exception { + ctx.configureForTest("hooks", "invoke_post_tool_use_hook_after_model_runs_a_tool"); + + var postToolUseInputs = new ArrayList(); + final String[] sessionIdHolder = new String[1]; + + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnPostToolUse((input, invocation) -> { + postToolUseInputs.add(input); + assertEquals(sessionIdHolder[0], invocation.getSessionId()); + return CompletableFuture.completedFuture(null); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + sessionIdHolder[0] = session.getSessionId(); + + // Create a file for the model to read + Path testFile = ctx.getWorkDir().resolve("world.txt"); + Files.writeString(testFile, "World from the test!"); + + session.sendAndWait( + new MessageOptions().setPrompt("Read the contents of world.txt and tell me what it says")) + .get(60, TimeUnit.SECONDS); + + // Should have received at least one postToolUse hook call + assertFalse(postToolUseInputs.isEmpty(), "Should have received postToolUse hook calls"); + + // Should have received the tool name and result + assertTrue(postToolUseInputs.stream().anyMatch(i -> i.getToolName() != null && !i.getToolName().isEmpty()), + "Should have received tool name in postToolUse hook"); + assertTrue(postToolUseInputs.stream().anyMatch(i -> i.getToolResult() != null), + "Should have received tool result in postToolUse hook"); + } + } + + /** + * Verifies that both hooks are invoked for a single tool call. + * + * @see Snapshot: hooks/invoke_both_hooks_for_single_tool_call + */ + @Test + void testInvokeBothHooksForSingleToolCall() throws Exception { + ctx.configureForTest("hooks", "invoke_both_hooks_for_single_tool_call"); + + var preToolUseInputs = new ArrayList(); + var postToolUseInputs = new ArrayList(); + + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { + preToolUseInputs.add(input); + return CompletableFuture.completedFuture(PreToolUseHookOutput.allow()); + }).setOnPostToolUse((input, invocation) -> { + postToolUseInputs.add(input); + return CompletableFuture.completedFuture(null); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + + // Create a file for the model to read + Path testFile = ctx.getWorkDir().resolve("both.txt"); + Files.writeString(testFile, "Testing both hooks!"); + + session.sendAndWait(new MessageOptions().setPrompt("Read the contents of both.txt")).get(60, + TimeUnit.SECONDS); + + // Both hooks should have been called + assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); + assertFalse(postToolUseInputs.isEmpty(), "Should have received postToolUse hook calls"); + + // The same tool should appear in both + Set preToolNames = preToolUseInputs.stream().map(PreToolUseHookInput::getToolName) + .filter(n -> n != null && !n.isEmpty()).collect(Collectors.toSet()); + Set postToolNames = postToolUseInputs.stream().map(PostToolUseHookInput::getToolName) + .filter(n -> n != null && !n.isEmpty()).collect(Collectors.toSet()); + + // Check if there's any overlap + boolean hasOverlap = preToolNames.stream().anyMatch(postToolNames::contains); + assertTrue(hasOverlap, "Expected the same tool to appear in both pre and post hooks"); + } + } + + /** + * Verifies that tool execution is denied when pre-tool-use returns deny. + * + * @see Snapshot: hooks/deny_tool_execution_when_pre_tool_use_returns_deny + */ + @Test + void testDenyToolExecutionWhenPreToolUseReturnsDeny() throws Exception { + ctx.configureForTest("hooks", "deny_tool_execution_when_pre_tool_use_returns_deny"); + + var preToolUseInputs = new ArrayList(); + + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { + preToolUseInputs.add(input); + // Deny all tool calls + return CompletableFuture.completedFuture(PreToolUseHookOutput.deny()); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + + // Create a file + Path testFile = ctx.getWorkDir().resolve("protected.txt"); + String originalContent = "Original content that should not be modified"; + Files.writeString(testFile, originalContent); + + var response = session + .sendAndWait( + new MessageOptions().setPrompt("Edit protected.txt and replace 'Original' with 'Modified'")) + .get(60, TimeUnit.SECONDS); + + // The hook should have been called + assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); + + // The response should be defined + assertNotNull(response, "Response should not be null"); + + assertEquals(originalContent, Files.readString(testFile), "Denied preToolUse hook should block file edits"); + } + } + + /** + * Verifies that agent-stop can block a natural stop and enqueue another turn. + * + * @see Snapshot: + * hooks_extended/should_invoke_agentstop_hook_and_apply_block_response + */ + @Test + void testInvokeAgentStopHookAndApplyBlockResponse() throws Exception { + ctx.configureForTest("hooks_extended", "should_invoke_agentstop_hook_and_apply_block_response"); + + var inputs = new ArrayList(); + final String[] sessionIdHolder = new String[1]; + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnAgentStop((input, invocation) -> { + assertEquals(sessionIdHolder[0], invocation.getSessionId()); + inputs.add(input); + if (inputs.size() == 1) { + return CompletableFuture.completedFuture(new AgentStopHookOutput().setDecision("block") + .setReason("Reply with exactly: AGENT_STOP_CONTINUED")); + } + return CompletableFuture.completedFuture(null); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + sessionIdHolder[0] = session.getSessionId(); + + var response = session.sendAndWait(new MessageOptions().setPrompt("Reply with exactly: AGENT_STOP_INITIAL")) + .get(60, TimeUnit.SECONDS); + + assertEquals(2, inputs.size()); + assertNotEquals(Boolean.TRUE, inputs.get(0).getStopHookActive()); + assertEquals(Boolean.TRUE, inputs.get(1).getStopHookActive()); + assertEquals("end_turn", inputs.get(0).getStopReason()); + assertFalse(inputs.get(0).getTranscriptPath().isBlank()); + assertNotNull(response); + assertTrue(response.getData().content().contains("AGENT_STOP_CONTINUED")); + } + } + + @Test + void testInvokeUserPromptTransformedHookAndModifyTransformedPrompt() throws Exception { + ctx.configureForTest("hooks_extended", + "should_invoke_userprompttransformed_hook_and_modify_transformed_prompt"); + + var inputs = new ArrayList(); + var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnUserPromptTransformed((input, invocation) -> { + assertFalse(invocation.getSessionId().isBlank()); + inputs.add(input); + return CompletableFuture.completedFuture( + new UserPromptTransformedHookOutput("Reply with exactly: HOOKED_TRANSFORMED_PROMPT")); + })); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(config).get(); + var response = session.sendAndWait(new MessageOptions().setPrompt("Answer the request above.")).get(60, + TimeUnit.SECONDS); + + assertFalse(inputs.isEmpty()); + assertTrue(inputs.get(0).prompt().contains("Answer the request above.")); + assertTrue(inputs.get(0).transformedPrompt().contains("Answer the request above.")); + assertTrue(inputs.get(0).transformedPrompt().contains("")); + assertTrue(inputs.get(0).timestamp() > 0); + assertFalse(inputs.get(0).cwd().isBlank()); + assertNotNull(response); + assertTrue(response.getData().content().contains("HOOKED_TRANSFORMED_PROMPT")); + } + } +} diff --git a/java/src/test/java/com/github/copilot/InternalExecutorProviderIT.java b/java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderIT.java similarity index 100% rename from java/src/test/java/com/github/copilot/InternalExecutorProviderIT.java rename to java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderIT.java diff --git a/java/src/test/java/com/github/copilot/InternalExecutorProviderProbe.java b/java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderProbe.java similarity index 100% rename from java/src/test/java/com/github/copilot/InternalExecutorProviderProbe.java rename to java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderProbe.java diff --git a/java/src/test/java/com/github/copilot/InternalExecutorProviderTest.java b/java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/InternalExecutorProviderTest.java rename to java/sdk/src/test/java/com/github/copilot/InternalExecutorProviderTest.java diff --git a/java/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java b/java/sdk/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java similarity index 82% rename from java/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java rename to java/sdk/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java index 7a9554b7b..ec7ead567 100644 --- a/java/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java +++ b/java/sdk/src/test/java/com/github/copilot/JsonIncludeNonNullTest.java @@ -12,10 +12,12 @@ import org.junit.jupiter.api.Test; +import com.github.copilot.rpc.CapiSessionOptions; import com.github.copilot.rpc.CopilotClientOptions; import com.github.copilot.rpc.CustomAgentConfig; import com.github.copilot.rpc.InfiniteSessionConfig; import com.github.copilot.rpc.InputOptions; +import com.github.copilot.rpc.MemoryConfiguration; import com.github.copilot.rpc.ModelCapabilitiesOverride; import com.github.copilot.rpc.ProviderConfig; import com.github.copilot.rpc.ResumeSessionConfig; @@ -55,6 +57,11 @@ void infiniteSessionConfigHasNonNullAnnotation() { assertHasNonNullInclude(InfiniteSessionConfig.class); } + @Test + void memoryConfigurationHasNonNullAnnotation() { + assertHasNonNullInclude(MemoryConfiguration.class); + } + @Test void inputOptionsHasNonNullAnnotation() { assertHasNonNullInclude(InputOptions.class); @@ -70,6 +77,11 @@ void providerConfigHasNonNullAnnotation() { assertHasNonNullInclude(ProviderConfig.class); } + @Test + void capiSessionOptionsHasNonNullAnnotation() { + assertHasNonNullInclude(CapiSessionOptions.class); + } + @Test void telemetryConfigHasNonNullAnnotation() { assertHasNonNullInclude(TelemetryConfig.class); @@ -149,6 +161,24 @@ void sessionUiCapabilitiesIncludesSetFieldsInJson() throws JsonProcessingExcepti assertTrue(json.contains("\"elicitation\":true"), "Set elicitation should appear in JSON"); } + @Test + void memoryConfigurationSerializesEnabled() throws JsonProcessingException { + var memory = new MemoryConfiguration().setEnabled(true); + String json = MAPPER.writeValueAsString(memory); + assertEquals("{\"enabled\":true}", json, "MemoryConfiguration should serialize the required enabled field"); + + var disabled = new MemoryConfiguration().setEnabled(false); + assertEquals("{\"enabled\":false}", MAPPER.writeValueAsString(disabled), + "MemoryConfiguration should serialize enabled even when false"); + } + + @Test + void sessionConfigOmitsMemoryWhenUnset() throws JsonProcessingException { + var config = new SessionConfig(); + String json = MAPPER.writeValueAsString(config); + assertFalse(json.contains("\"memory\""), "Unset memory should be omitted from SessionConfig JSON"); + } + private void assertHasNonNullInclude(Class clazz) { JsonInclude annotation = clazz.getAnnotation(JsonInclude.class); assertNotNull(annotation, clazz.getSimpleName() + " should be annotated with @JsonInclude"); diff --git a/java/src/test/java/com/github/copilot/JsonRpcClientTest.java b/java/sdk/src/test/java/com/github/copilot/JsonRpcClientTest.java similarity index 97% rename from java/src/test/java/com/github/copilot/JsonRpcClientTest.java rename to java/sdk/src/test/java/com/github/copilot/JsonRpcClientTest.java index 3491ac8ab..79aaea10d 100644 --- a/java/src/test/java/com/github/copilot/JsonRpcClientTest.java +++ b/java/sdk/src/test/java/com/github/copilot/JsonRpcClientTest.java @@ -133,14 +133,9 @@ void testIsConnectedWithSocketClosed() throws Exception { pair.serverSocket.close(); } - private static Process startBlockingProcess() throws IOException { - boolean isWindows = System.getProperty("os.name").toLowerCase().contains("windows"); - return (isWindows ? new ProcessBuilder("cmd", "/c", "more") : new ProcessBuilder("cat")).start(); - } - @Test void testIsConnectedWithProcess() throws Exception { - Process proc = startBlockingProcess(); + Process proc = new TestProcess(); try (var client = JsonRpcClient.fromProcess(proc)) { assertTrue(client.isConnected()); } @@ -148,7 +143,7 @@ void testIsConnectedWithProcess() throws Exception { @Test void testIsConnectedWithProcessDead() throws Exception { - Process proc = startBlockingProcess(); + Process proc = new TestProcess(); var client = JsonRpcClient.fromProcess(proc); proc.destroy(); proc.waitFor(5, TimeUnit.SECONDS); @@ -160,7 +155,7 @@ void testIsConnectedWithProcessDead() throws Exception { @Test void testGetProcessReturnsProcess() throws Exception { - Process proc = startBlockingProcess(); + Process proc = new TestProcess(); try (var client = JsonRpcClient.fromProcess(proc)) { assertSame(proc, client.getProcess()); } diff --git a/java/src/test/java/com/github/copilot/LifecycleEventManagerTest.java b/java/sdk/src/test/java/com/github/copilot/LifecycleEventManagerTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/LifecycleEventManagerTest.java rename to java/sdk/src/test/java/com/github/copilot/LifecycleEventManagerTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java b/java/sdk/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java new file mode 100644 index 000000000..bc74ca667 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/LowLevelToolDefinitionIT.java @@ -0,0 +1,112 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.rpc.ToolSet; + +/** + * Failsafe integration test for explicit (non-ergonomic) tool definition APIs. + * + * @see Snapshot: tools/low_level_tool_definition + */ +class LowLevelToolDefinitionIT { + + private static E2ETestContext ctx; + private String currentPhase; + + record PhaseArgs(String phase) { + } + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void lowLevelToolDefinition() throws Exception { + ctx.configureForTest("tools", "low_level_tool_definition"); + + Map setPhaseSchema = Map.of("type", "object", "properties", + Map.of("phase", Map.of("type", "string", "enum", List.of("searching", "analyzing", "done"))), + "required", List.of("phase")); + + ToolDefinition setPhaseTool = ToolDefinition.create("set_current_phase", "Sets the current phase of the agent", + setPhaseSchema, invocation -> { + PhaseArgs args = invocation.getArgumentsAs(PhaseArgs.class); + currentPhase = args.phase(); + return CompletableFuture.completedFuture("Phase set to " + currentPhase); + }); + + Map searchSchema = Map.of("type", "object", "properties", + Map.of("keyword", Map.of("type", "string")), "required", List.of("keyword")); + + ToolDefinition searchTool = ToolDefinition.create("search_items", "Search for items by keyword", searchSchema, + invocation -> { + Map args = invocation.getArguments(); + String keyword = (String) args.get("keyword"); + assertTrue("copilot".equals(keyword), "Expected tool keyword to be 'copilot' but was: " + keyword); + return CompletableFuture.completedFuture("Found: item_alpha, item_beta"); + }); + + Map grepSchema = Map.of("type", "object", "properties", + Map.of("query", Map.of("type", "string")), "required", List.of("query")); + + ToolDefinition grepOverrideTool = ToolDefinition.createOverride("grep", "Custom grep override", grepSchema, + invocation -> { + Map args = invocation.getArguments(); + String query = (String) args.get("query"); + return CompletableFuture.completedFuture("CUSTOM_GREP: " + query); + }); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*").addBuiltIn("web_fetch")) + .setTools(List.of(setPhaseTool, searchTool, grepOverrideTool))) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session.sendAndWait(new MessageOptions().setPrompt( + "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results."), + 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("analyzing"), + "Response should contain the updated phase: " + response.getData().content()); + assertTrue(content.contains("item_alpha") || content.contains("item_beta"), + "Response should contain search results: " + response.getData().content()); + assertTrue("analyzing".equals(currentPhase), + "Expected currentPhase to be analyzing but was: " + currentPhase); + } finally { + session.close(); + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ManagedSettingsTest.java b/java/sdk/src/test/java/com/github/copilot/ManagedSettingsTest.java new file mode 100644 index 000000000..dbd19f3c9 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ManagedSettingsTest.java @@ -0,0 +1,90 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.DisableBypassPermissionsMode; +import com.github.copilot.rpc.ManagedSettings; +import com.github.copilot.rpc.ManagedSettingsPermissions; +import com.github.copilot.rpc.PermissionRequestResult; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.atomic.AtomicBoolean; +import org.junit.jupiter.api.Test; + +class ManagedSettingsTest { + @Test + void forwardsManagedSettingsOnCreateAndResume() throws Exception { + var permissions = new ManagedSettingsPermissions() + .setDisableBypassPermissionsMode(DisableBypassPermissionsMode.DISABLE).setDeny(List.of("Shell(rm *)")) + .setAsk(List.of("Domain(publish.example)")).setAllow(List.of("Read(**)")); + var managedSettings = new ManagedSettings().setPermissions(permissions); + + var create = SessionRequestBuilder.buildCreateRequest( + new SessionConfig().setEnableManagedSettings(true).setManagedSettings(managedSettings), + "managed-create"); + var resume = SessionRequestBuilder.buildResumeRequest("managed-resume", + new ResumeSessionConfig().setEnableManagedSettings(true).setManagedSettings(managedSettings)); + + assertEquals(managedSettings, create.getManagedSettings()); + assertEquals(managedSettings, resume.getManagedSettings()); + var json = new ObjectMapper().writeValueAsString(create); + assertTrue(json.contains("\"enableManagedSettings\":true")); + assertTrue(json.contains("\"managedSettings\":{\"permissions\"")); + assertTrue(json.contains("\"disableBypassPermissionsMode\":\"disable\"")); + } + + @Test + void preservesExplicitEmptyPermissionArrays() throws Exception { + // Security-critical: a present empty allow list admits nothing, while an + // absent (null) list imposes no such restriction. Jackson NON_NULL must + // emit an explicit empty array as `[]` and omit null fields, so the two + // remain distinguishable on the wire. + var permissions = new ManagedSettingsPermissions().setDeny(List.of()).setAsk(List.of()).setAllow(List.of()); + var managedSettings = new ManagedSettings().setPermissions(permissions); + var create = SessionRequestBuilder.buildCreateRequest(new SessionConfig().setManagedSettings(managedSettings), + "managed-empty"); + + var json = new ObjectMapper().writeValueAsString(create); + assertTrue(json.contains("\"deny\":[]"), json); + assertTrue(json.contains("\"ask\":[]"), json); + assertTrue(json.contains("\"allow\":[]"), json); + } + + @Test + void distinguishesExplicitEmptyAllowFromAbsentAllow() throws Exception { + // Present empty allow admits nothing; the null deny/ask must be omitted. + var permissions = new ManagedSettingsPermissions().setAllow(List.of()); + var managedSettings = new ManagedSettings().setPermissions(permissions); + var create = SessionRequestBuilder.buildCreateRequest(new SessionConfig().setManagedSettings(managedSettings), + "managed-mixed"); + + var json = new ObjectMapper().writeValueAsString(create); + assertTrue(json.contains("\"allow\":[]"), json); + assertFalse(json.contains("\"deny\""), json); + assertFalse(json.contains("\"ask\""), json); + } + + @Test + void directInjectionEnablesManagedSafeguards() throws Exception { + var session = new CopilotSession("session-1", null); + var settings = new ManagedSettings().setPermissions(new ManagedSettingsPermissions()); + var managedSettingsEnabled = new AtomicBoolean(); + var config = new SessionConfig().setManagedSettings(settings).setOnPermissionRequest((request, invocation) -> { + managedSettingsEnabled.set(invocation.isManagedSettingsEnabled()); + return CompletableFuture.completedFuture(PermissionRequestResult.noResult()); + }); + + SessionRequestBuilder.configureSession(session, config); + session.handlePermissionRequest(new ObjectMapper().readTree("{\"kind\":\"read\"}")).get(); + + assertTrue(managedSettingsEnabled.get()); + } +} diff --git a/java/src/test/java/com/github/copilot/McpAndAgentsTest.java b/java/sdk/src/test/java/com/github/copilot/McpAndAgentsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/McpAndAgentsTest.java rename to java/sdk/src/test/java/com/github/copilot/McpAndAgentsTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java b/java/sdk/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java new file mode 100644 index 000000000..06ac08a2a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/McpAuthInterestRegistrationTest.java @@ -0,0 +1,299 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.OutputStream; +import java.net.ServerSocket; +import java.net.Socket; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.concurrent.CopyOnWriteArrayList; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.github.copilot.generated.McpOauthRequiredEvent; +import com.github.copilot.rpc.CloudSessionOptions; +import com.github.copilot.rpc.CloudSessionRepository; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.McpAuthResult; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +class McpAuthInterestRegistrationTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @Test + void mcpOauthRequiredEventExposesOptionalResourceMetadata() throws Exception { + var data = MAPPER.readValue(""" + { + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp", + "wwwAuthenticateParams": { + "resourceMetadataUrl": "https://example.com/.well-known/oauth-protected-resource" + }, + "resourceMetadata": "{\\"resource\\":\\"https://example.com/mcp\\"}", + "staticClientConfig": { + "clientId": "static-client", + "clientSecret": "static-secret", + "grantType": "client_credentials", + "publicClient": false + } + } + """, McpOauthRequiredEvent.McpOauthRequiredEventData.class); + + assertEquals("{\"resource\":\"https://example.com/mcp\"}", data.resourceMetadata()); + assertNotNull(data.wwwAuthenticateParams()); + assertNotNull(data.staticClientConfig()); + assertEquals("static-secret", data.staticClientConfig().clientSecret()); + + var withoutMetadata = MAPPER.readValue(""" + { + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp" + } + """, McpOauthRequiredEvent.McpOauthRequiredEventData.class); + + assertNull(withoutMetadata.resourceMetadata()); + assertNull(withoutMetadata.wwwAuthenticateParams()); + } + + @Test + void createSessionRegistersMcpAuthInterestOnlyWhenHandlerConfigured() throws Exception { + try (var server = new RecordingRuntime(); + var client = new CopilotClient(new CopilotClientOptions().setCliUrl(server.url()))) { + try (var session = client.createSession( + new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setOnEvent(event -> { + })).get()) { + assertNotNull(session); + } + + assertNoMcpAuthInterest(server.requests()); + assertTrue(server.requests().stream().anyMatch(request -> "session.create".equals(request.method()) + && request.params().path("requestPermission").asBoolean())); + + server.clearRequests(); + + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(request); + assertNotNull(invocation); + return java.util.concurrent.CompletableFuture + .completedFuture(McpAuthResult.cancelled()); + })) + .get()) { + assertNotNull(session); + } + + List requests = server.requests(); + assertEquals("session.create", requests.get(0).method()); + assertEquals("session.eventLog.registerInterest", requests.get(1).method()); + assertEquals("mcp.oauth_required", requests.get(1).params().path("eventType").asText()); + } + } + + @Test + void cloudCreateSessionRegistersMcpAuthInterestAfterCreateOnlyWhenHandlerConfigured() throws Exception { + try (var server = new RecordingRuntime(); + var client = new CopilotClient(new CopilotClientOptions().setCliUrl(server.url()))) { + var cloud = new CloudSessionOptions().setRepository( + new CloudSessionRepository().setOwner("github").setName("copilot-sdk").setBranch("main")); + + try (var session = client + .createSession( + new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setCloud(cloud)) + .get()) { + assertNotNull(session); + } + + assertNoMcpAuthInterest(server.requests()); + server.clearRequests(); + + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setCloud(cloud).setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(request); + assertNotNull(invocation); + return java.util.concurrent.CompletableFuture + .completedFuture(McpAuthResult.cancelled()); + })) + .get()) { + assertNotNull(session); + } + + List requests = server.requests(); + assertEquals("session.create", requests.get(0).method()); + assertEquals("session.eventLog.registerInterest", requests.get(1).method()); + assertEquals("mcp.oauth_required", requests.get(1).params().path("eventType").asText()); + } + } + + @Test + void resumeSessionRegistersMcpAuthInterestOnlyWhenHandlerConfigured() throws Exception { + try (var server = new RecordingRuntime(); + var client = new CopilotClient(new CopilotClientOptions().setCliUrl(server.url()))) { + try (var session = client.resumeSession("session-without-auth", new ResumeSessionConfig() + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setOnEvent(event -> { + })).get()) { + assertNotNull(session); + } + + assertNoMcpAuthInterest(server.requests()); + assertTrue(server.requests().stream().anyMatch(request -> "session.resume".equals(request.method()) + && request.params().path("requestPermission").asBoolean())); + + server.clearRequests(); + + try (var session = client.resumeSession("session-with-auth", + new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(request); + assertNotNull(invocation); + return java.util.concurrent.CompletableFuture + .completedFuture(McpAuthResult.cancelled()); + })) + .get()) { + assertNotNull(session); + } + + List requests = server.requests(); + assertEquals("session.resume", requests.get(0).method()); + assertEquals("session.eventLog.registerInterest", requests.get(1).method()); + assertEquals("mcp.oauth_required", requests.get(1).params().path("eventType").asText()); + } + } + + private static void assertNoMcpAuthInterest(List requests) { + assertFalse(requests.stream().anyMatch(request -> "session.eventLog.registerInterest".equals(request.method()) + && "mcp.oauth_required".equals(request.params().path("eventType").asText()))); + } + + private record RpcRequest(String method, JsonNode params) { + } + + private static final class RecordingRuntime implements AutoCloseable { + private final ServerSocket listener; + private final Thread thread; + private final List requests = new CopyOnWriteArrayList<>(); + private volatile boolean running = true; + + RecordingRuntime() throws Exception { + listener = new ServerSocket(0); + thread = new Thread(this::run, "mcp-auth-interest-test-runtime"); + thread.setDaemon(true); + thread.start(); + } + + String url() { + return "127.0.0.1:" + listener.getLocalPort(); + } + + List requests() { + return List.copyOf(requests); + } + + void clearRequests() { + requests.clear(); + } + + @Override + public void close() throws Exception { + running = false; + listener.close(); + thread.join(2000); + } + + private void run() { + try (Socket socket = listener.accept()) { + var in = socket.getInputStream(); + var out = socket.getOutputStream(); + while (running) { + JsonNode message = readMessage(in); + if (message == null) { + return; + } + String method = message.path("method").asText(); + requests.add(new RpcRequest(method, message.path("params").deepCopy())); + sendResponse(out, message.path("id").asLong(), resultFor(method, message.path("params"))); + } + } catch (Exception ex) { + if (running) { + throw new RuntimeException(ex); + } + } + } + + private static JsonNode resultFor(String method, JsonNode params) { + ObjectNode result = MAPPER.createObjectNode(); + switch (method) { + case "connect" -> { + result.put("ok", true); + result.put("protocolVersion", 3); + result.put("version", "test"); + } + case "session.create", "session.resume" -> { + String sessionId = params.path("sessionId").asText("server-assigned-session"); + if (sessionId.isEmpty()) { + sessionId = "server-assigned-session"; + } + result.put("sessionId", sessionId); + result.putNull("workspacePath"); + result.putNull("capabilities"); + } + case "session.eventLog.registerInterest" -> result.put("id", "interest-1"); + case "session.options.update" -> result.put("success", true); + case "session.skills.reload", "session.destroy" -> { + } + default -> throw new IllegalStateException("Unexpected RPC method " + method); + } + return result; + } + + private static JsonNode readMessage(java.io.InputStream in) throws Exception { + StringBuilder header = new StringBuilder(); + int b; + while ((b = in.read()) != -1) { + header.append((char) b); + if (header.toString().endsWith("\r\n\r\n")) { + break; + } + } + if (b == -1) { + return null; + } + int contentLength = 0; + for (String line : header.toString().split("\r\n")) { + int colon = line.indexOf(':'); + if (colon > 0 && "Content-Length".equals(line.substring(0, colon))) { + contentLength = Integer.parseInt(line.substring(colon + 1).trim()); + } + } + byte[] body = in.readNBytes(contentLength); + return MAPPER.readTree(body); + } + + private static void sendResponse(OutputStream out, long id, JsonNode result) throws Exception { + ObjectNode response = MAPPER.createObjectNode(); + response.put("jsonrpc", "2.0"); + response.put("id", id); + response.set("result", result); + byte[] body = MAPPER.writeValueAsBytes(response); + out.write(("Content-Length: " + body.length + "\r\n\r\n").getBytes(StandardCharsets.UTF_8)); + out.write(body); + out.flush(); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/McpOAuthE2ETest.java b/java/sdk/src/test/java/com/github/copilot/McpOAuthE2ETest.java new file mode 100644 index 000000000..f234337ea --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/McpOAuthE2ETest.java @@ -0,0 +1,380 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.file.Files; +import java.nio.file.Path; +import java.time.Duration; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.McpOauthRequestReason; +import com.github.copilot.generated.rpc.SessionMcpAppsCallToolParams; +import com.github.copilot.generated.rpc.McpServerStatus; +import com.github.copilot.generated.rpc.SessionMcpListToolsParams; +import com.github.copilot.generated.rpc.SessionMcpOauthHandlePendingRequestParams; +import com.github.copilot.rpc.McpAuthInvocation; +import com.github.copilot.rpc.McpAuthRequest; +import com.github.copilot.rpc.McpAuthResult; +import com.github.copilot.rpc.McpAuthToken; +import com.github.copilot.rpc.McpHttpServerConfig; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +public class McpOAuthE2ETest { + private static final String EXPECTED_TOKEN = "sdk-host-token"; + private static final String REFRESH_TOKEN = EXPECTED_TOKEN + "-refresh"; + private static final String UPSCOPE_TOKEN = EXPECTED_TOKEN + "-upscope"; + private static final String REAUTH_TOKEN = EXPECTED_TOKEN + "-reauth"; + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldSatisfyMcpOauthUsingHostProvidedToken() throws Exception { + try (var oauthServer = OAuthMcpServer.start(ctx.getRepoRoot())) { + var serverName = "oauth-protected-mcp"; + var observedRequest = new java.util.concurrent.atomic.AtomicReference(); + var observedInvocation = new java.util.concurrent.atomic.AtomicReference(); + + try (var client = ctx.createClient(); + var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + observedRequest.set(request); + observedInvocation.set(invocation); + return java.util.concurrent.CompletableFuture.completedFuture( + McpAuthResult.token(new McpAuthToken(EXPECTED_TOKEN, "Bearer", 3600L))); + }).setMcpServers(Map.of(serverName, new McpHttpServerConfig() + .setUrl(oauthServer.url() + "/mcp").setTools(List.of("*"))))) + .get()) { + waitForMcpServerStatus(session, serverName, McpServerStatus.CONNECTED, observedRequest); + assertNotNull(observedInvocation.get(), "MCP auth invocation should be provided"); + assertEquals(session.getSessionId(), observedInvocation.get().getSessionId()); + var tools = session.getRpc().mcp.listTools(new SessionMcpListToolsParams(null, serverName)).get(30, + TimeUnit.SECONDS); + assertTrue(tools.tools().stream().anyMatch(tool -> "whoami".equals(tool.name()))); + } + + var request = observedRequest.get(); + assertNotNull(request, "MCP auth handler should be invoked"); + assertEquals(serverName, request.serverName()); + assertEquals(oauthServer.url() + "/mcp", request.serverUrl()); + assertEquals(McpOauthRequestReason.INITIAL, request.reason()); + assertNotNull(request.wwwAuthenticateParams()); + assertEquals(oauthServer.url() + "/.well-known/oauth-protected-resource", + request.wwwAuthenticateParams().resourceMetadataUrl()); + assertEquals("mcp.read", request.wwwAuthenticateParams().scope()); + assertEquals("invalid_token", request.wwwAuthenticateParams().error()); + assertEquals(oauthServer.url() + "/mcp", + MAPPER.readTree(request.resourceMetadata()).path("resource").asText()); + + var requests = oauthServer.requests(); + assertTrue(requests.stream().anyMatch(record -> record.authorization() == null)); + assertTrue( + requests.stream().anyMatch(record -> ("Bearer " + EXPECTED_TOKEN).equals(record.authorization()))); + } + } + + @Test + void testShouldRequestReplacementTokensAcrossMcpOauthLifecycle() throws Exception { + try (var oauthServer = OAuthMcpServer.start(ctx.getRepoRoot())) { + var serverName = "oauth-lifecycle-mcp"; + var observedReasons = new CopyOnWriteArrayList(); + var refreshCount = new java.util.concurrent.atomic.AtomicInteger(); + + try (var client = ctx.createClient(); + var session = client.createSession(new SessionConfig().setEnableMcpApps(true) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(invocation); + observedReasons.add(request.reason()); + var result = switch (request.reason()) { + case REFRESH -> { + assertNotNull(request.wwwAuthenticateParams()); + assertNull(request.wwwAuthenticateParams().resourceMetadataUrl()); + assertEquals("invalid_token", request.wwwAuthenticateParams().error()); + if (refreshCount.incrementAndGet() > 1) { + yield McpAuthResult.cancelled(); + } + yield McpAuthResult.token(new McpAuthToken(REFRESH_TOKEN, null, null)); + } + case UPSCOPE -> { + assertNotNull(request.wwwAuthenticateParams()); + assertEquals(oauthServer.url() + "/.well-known/oauth-protected-resource", + request.wwwAuthenticateParams().resourceMetadataUrl()); + assertEquals("mcp.write", request.wwwAuthenticateParams().scope()); + assertEquals("insufficient_scope", request.wwwAuthenticateParams().error()); + yield McpAuthResult.token(new McpAuthToken(UPSCOPE_TOKEN, null, null)); + } + case REAUTH -> McpAuthResult.token(new McpAuthToken(REAUTH_TOKEN, null, null)); + default -> McpAuthResult.token(new McpAuthToken(EXPECTED_TOKEN, null, null)); + }; + return java.util.concurrent.CompletableFuture.completedFuture(result); + }).setMcpServers(Map.of(serverName, new McpHttpServerConfig() + .setUrl(oauthServer.url() + "/mcp").setTools(List.of("*"))))) + .get()) { + waitForMcpServerStatus(session, serverName, McpServerStatus.CONNECTED, + new java.util.concurrent.atomic.AtomicReference<>()); + callWhoami(session, serverName, "refresh"); + callWhoami(session, serverName, "upscope"); + callWhoami(session, serverName, "reauth"); + } + + assertEquals(List.of(McpOauthRequestReason.INITIAL, McpOauthRequestReason.REFRESH, + McpOauthRequestReason.UPSCOPE, McpOauthRequestReason.REFRESH, McpOauthRequestReason.REAUTH), + observedReasons); + + var requests = oauthServer.requests(); + assertTrue( + requests.stream().anyMatch(record -> ("Bearer " + REFRESH_TOKEN).equals(record.authorization()))); + assertTrue( + requests.stream().anyMatch(record -> ("Bearer " + UPSCOPE_TOKEN).equals(record.authorization()))); + assertTrue(requests.stream().anyMatch(record -> ("Bearer " + REAUTH_TOKEN).equals(record.authorization()))); + } + } + + @Test + void testShouldCancelPendingMcpOauthRequest() throws Exception { + try (var oauthServer = OAuthMcpServer.start(ctx.getRepoRoot())) { + var serverName = "oauth-cancelled-mcp"; + var observedRequest = new java.util.concurrent.atomic.AtomicReference(); + + try (var client = ctx.createClient(); + var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(invocation); + observedRequest.set(request); + return java.util.concurrent.CompletableFuture + .completedFuture(McpAuthResult.cancelled()); + }).setMcpServers(Map.of(serverName, new McpHttpServerConfig() + .setUrl(oauthServer.url() + "/mcp").setTools(List.of("*"))))) + .get()) { + waitForMcpServerStatus(session, serverName, McpServerStatus.NEEDS_AUTH, observedRequest); + + // Race: session.create kicks off the MCP connection, but the SDK + // registers its `mcp.oauth_required` interest only after create + // returns. If the initial 401 wins, the runtime records + // `needs-auth` without invoking the host callback. A later auth + // retry (interest now registered) fires the callback with the same + // INITIAL reason. Wait for the callback instead of sampling it the + // instant `needs-auth` appears, which is what made this test flaky. + var request = waitForAuthRequest(observedRequest); + assertEquals(serverName, request.serverName()); + assertEquals(McpOauthRequestReason.INITIAL, request.reason()); + } + } + } + + @Test + void testShouldResolvePendingMcpOauthRequestThroughRpc() throws Exception { + try (var oauthServer = OAuthMcpServer.start(ctx.getRepoRoot())) { + var serverName = "oauth-direct-rpc-mcp"; + var observedRequest = new AtomicReference(); + var pendingHandlerResult = new CompletableFuture(); + + try (var client = ctx.createClient(); + var session = client.createSession(new SessionConfig().setEnableMcpApps(true) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> { + assertNotNull(invocation); + observedRequest.set(request); + return pendingHandlerResult; + }).setMcpServers(Map.of(serverName, new McpHttpServerConfig() + .setUrl(oauthServer.url() + "/mcp").setTools(List.of("*"))))) + .get()) { + var connected = CompletableFuture.runAsync(() -> { + try { + waitForMcpServerStatus(session, serverName, McpServerStatus.CONNECTED, observedRequest); + } catch (Exception ex) { + throw new CompletionException(ex); + } + }); + + var request = waitForAuthRequest(observedRequest); + assertEquals(serverName, request.serverName()); + assertEquals(oauthServer.url() + "/mcp", request.serverUrl()); + assertEquals(McpOauthRequestReason.INITIAL, request.reason()); + assertNotNull(request.wwwAuthenticateParams()); + assertEquals(oauthServer.url() + "/.well-known/oauth-protected-resource", + request.wwwAuthenticateParams().resourceMetadataUrl()); + assertEquals("mcp.read", request.wwwAuthenticateParams().scope()); + assertEquals("invalid_token", request.wwwAuthenticateParams().error()); + + var handled = session.getRpc().mcp.oauth.handlePendingRequest( + new SessionMcpOauthHandlePendingRequestParams(null, request.requestId(), Map.of("kind", "token", + "accessToken", EXPECTED_TOKEN, "tokenType", "Bearer", "expiresIn", 3600L))) + .get(30, TimeUnit.SECONDS); + assertTrue(handled.success()); + + pendingHandlerResult.complete(McpAuthResult.cancelled()); + connected.get(60, TimeUnit.SECONDS); + var tools = session.getRpc().mcp.listTools(new SessionMcpListToolsParams(null, serverName)).get(30, + TimeUnit.SECONDS); + assertTrue(tools.tools().stream().anyMatch(tool -> "whoami".equals(tool.name()))); + } finally { + pendingHandlerResult.complete(McpAuthResult.cancelled()); + } + + var requests = oauthServer.requests(); + assertTrue( + requests.stream().anyMatch(record -> ("Bearer " + EXPECTED_TOKEN).equals(record.authorization()))); + } + } + + private static void callWhoami(CopilotSession session, String serverName, String scenario) throws Exception { + var result = session.getRpc().mcp.apps.callTool( + new SessionMcpAppsCallToolParams(null, serverName, "whoami", Map.of("scenario", scenario), serverName)) + .get(30, TimeUnit.SECONDS); + var content = result.path("content"); + assertEquals(1, content.size()); + assertEquals("oauth-test-user", content.get(0).path("text").asText()); + } + + private static void waitForMcpServerStatus(CopilotSession session, String serverName, McpServerStatus status, + java.util.concurrent.atomic.AtomicReference observedRequest) + throws Exception { + var deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(60); + var lastStatus = ""; + while (System.nanoTime() < deadline) { + var result = session.getRpc().mcp.list().get(5, TimeUnit.SECONDS); + var server = result.servers().stream().filter(candidate -> serverName.equals(candidate.name())).findFirst(); + if (server.isPresent()) { + lastStatus = String.valueOf(server.get().status()); + } + if (server.isPresent() && status.equals(server.get().status())) { + return; + } + Thread.sleep(200); + } + fail(serverName + " did not reach " + status + "; last status was " + lastStatus + "; auth handler invoked=" + + (observedRequest.get() != null)); + } + + private static McpAuthRequest waitForAuthRequest(AtomicReference observedRequest) throws Exception { + var deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(30); + while (System.nanoTime() < deadline) { + var request = observedRequest.get(); + if (request != null) { + return request; + } + Thread.sleep(100); + } + throw new AssertionError("Timed out waiting for MCP OAuth request"); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + private record OAuthMcpRequest(String authorization) { + } + + private record OAuthMcpServer(Process process, String url) implements AutoCloseable { + static OAuthMcpServer start(Path repoRoot) throws Exception { + var script = repoRoot.resolve("test").resolve("harness").resolve("test-mcp-oauth-server.mjs"); + var processBuilder = new ProcessBuilder(resolveExecutable("node"), script.toString()); + processBuilder.environment().put("EXPECTED_TOKEN", EXPECTED_TOKEN); + var process = processBuilder.start(); + var stderr = new StringBuilder(); + Thread stderrThread = new Thread(() -> { + try (var reader = new BufferedReader(new InputStreamReader(process.getErrorStream()))) { + reader.lines().forEach(stderr::append); + } catch (IOException ex) { + stderr.append(ex.getMessage()); + } + }); + stderrThread.setDaemon(true); + stderrThread.start(); + try (var reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) { + var deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(10); + while (System.nanoTime() < deadline) { + if (reader.ready()) { + var line = reader.readLine(); + if (line != null && line.startsWith("Listening: ")) { + return new OAuthMcpServer(process, line.substring("Listening: ".length())); + } + } + Thread.sleep(50); + } + } + process.destroyForcibly(); + throw new AssertionError("Timed out waiting for OAuth MCP server: " + stderr); + } + + List requests() throws Exception { + var client = HttpClient.newHttpClient(); + var response = client.send(HttpRequest.newBuilder(URI.create(url + "/__requests")) + .timeout(Duration.ofSeconds(10)).GET().build(), HttpResponse.BodyHandlers.ofString()); + assertEquals(200, response.statusCode()); + return MAPPER.readValue(response.body(), new TypeReference>() { + }); + } + + private static String resolveExecutable(String executable) { + var path = System.getenv("PATH"); + if (path == null || path.isBlank()) { + throw new IllegalStateException("PATH is not configured; cannot find " + executable); + } + + var extensions = isWindows() + ? System.getenv().getOrDefault("PATHEXT", ".COM;.EXE;.BAT;.CMD").split(";") + : new String[]{""}; + for (var directory : path.split(java.util.regex.Pattern.quote(File.pathSeparator))) { + if (directory.isBlank()) { + continue; + } + for (var extension : extensions) { + var candidate = Path.of(directory).resolve(executable + extension).toAbsolutePath().normalize(); + if (Files.isRegularFile(candidate) && Files.isExecutable(candidate)) { + return candidate.toString(); + } + } + } + throw new IllegalStateException("Could not find " + executable + " on PATH."); + } + + private static boolean isWindows() { + return System.getProperty("os.name", "").toLowerCase(java.util.Locale.ROOT).contains("win"); + } + + @Override + public void close() { + process.destroyForcibly(); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java b/java/sdk/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java new file mode 100644 index 000000000..19c15ed59 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/McpOAuthResumeE2ETest.java @@ -0,0 +1,76 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.McpAuthResult; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +class McpOAuthResumeE2ETest { + + private static final String SNAPSHOT = "resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured"; + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + @Tag("isolated-resume") + void resumesAPersistedSessionFromANewClientWhenAnMcpOauthHandlerIsConfigured() throws Exception { + ctx.configureForTest("session", SNAPSHOT); + + String sessionId; + try (var client = ctx.createClient(); + var session = client + .createSession( + new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> CompletableFuture + .completedFuture(McpAuthResult.cancelled()))) + .get(30, TimeUnit.SECONDS)) { + sessionId = session.getSessionId(); + + AssistantMessageEvent response = session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?"), 60_000) + .get(90, TimeUnit.SECONDS); + assertNotNull(response); + assertTrue(response.getData().content().contains("2"), + "Response should contain 2: " + response.getData().content()); + } + + try (var client = ctx.createClient(); + var session = client + .resumeSession(sessionId, + new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setOnMcpAuthRequest((request, invocation) -> CompletableFuture + .completedFuture(McpAuthResult.cancelled()))) + .get(30, TimeUnit.SECONDS)) { + assertEquals(sessionId, session.getSessionId()); + } + } +} diff --git a/java/src/test/java/com/github/copilot/MessageAttachmentTest.java b/java/sdk/src/test/java/com/github/copilot/MessageAttachmentTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/MessageAttachmentTest.java rename to java/sdk/src/test/java/com/github/copilot/MessageAttachmentTest.java diff --git a/java/src/test/java/com/github/copilot/MetadataApiTest.java b/java/sdk/src/test/java/com/github/copilot/MetadataApiTest.java similarity index 79% rename from java/src/test/java/com/github/copilot/MetadataApiTest.java rename to java/sdk/src/test/java/com/github/copilot/MetadataApiTest.java index b2c775eb1..ec3b9ea70 100644 --- a/java/src/test/java/com/github/copilot/MetadataApiTest.java +++ b/java/sdk/src/test/java/com/github/copilot/MetadataApiTest.java @@ -7,11 +7,14 @@ import com.fasterxml.jackson.databind.ObjectMapper; import com.github.copilot.generated.SessionEvent; import com.github.copilot.generated.ToolExecutionProgressEvent; +import com.github.copilot.generated.rpc.ModelBillingTokenPrices; +import com.github.copilot.generated.rpc.ModelBillingTokenPricesLongContext; import com.github.copilot.rpc.*; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import java.util.List; +import java.util.OptionalDouble; import static org.junit.jupiter.api.Assertions.*; @@ -143,7 +146,20 @@ void testModelInfoDeserialization() throws Exception { "terms": "https://example.com/terms" }, "billing": { - "multiplier": 1.5 + "multiplier": 1.5, + "tokenPrices": { + "inputPrice": 2.0, + "outputPrice": 8.0, + "cachePrice": 0.5, + "batchSize": 1000000, + "contextMax": 128000, + "longContext": { + "inputPrice": 4.0, + "outputPrice": 16.0, + "cachePrice": 1.0, + "contextMax": 1000000 + } + } } } """; @@ -174,6 +190,49 @@ void testModelInfoDeserialization() throws Exception { // Billing assertNotNull(model.getBilling()); assertEquals(1.5, model.getBilling().getMultiplier()); + assertEquals(OptionalDouble.of(1.5), model.getBilling().getMultiplierOpt()); + + // Token prices + ModelBillingTokenPrices tokenPrices = model.getBilling().getTokenPrices(); + assertNotNull(tokenPrices); + assertEquals(2.0, tokenPrices.inputPrice()); + assertEquals(8.0, tokenPrices.outputPrice()); + assertEquals(0.5, tokenPrices.cachePrice()); + assertEquals(Long.valueOf(1000000), tokenPrices.batchSize()); + assertEquals(Long.valueOf(128000), tokenPrices.contextMax()); + + // Long context tier + ModelBillingTokenPricesLongContext longContext = tokenPrices.longContext(); + assertNotNull(longContext); + assertEquals(4.0, longContext.inputPrice()); + assertEquals(16.0, longContext.outputPrice()); + assertEquals(1.0, longContext.cachePrice()); + assertEquals(Long.valueOf(1000000), longContext.contextMax()); + } + + @Test + void testModelBillingSerializationOmitsNullMultiplier() throws Exception { + var billing = new ModelBilling(); + + String json = MAPPER.writeValueAsString(billing); + + assertFalse(json.contains("multiplier")); + } + + @Test + void testModelBillingMultiplierOptPresent() throws Exception { + ModelBilling billing = MAPPER.readValue("{\"multiplier\": 1.5}", ModelBilling.class); + + assertEquals(OptionalDouble.of(1.5), billing.getMultiplierOpt()); + assertEquals(1.5, billing.getMultiplier()); + } + + @Test + void testModelBillingMultiplierOptAbsent() throws Exception { + ModelBilling billing = MAPPER.readValue("{}", ModelBilling.class); + + assertEquals(OptionalDouble.empty(), billing.getMultiplierOpt()); + assertEquals(0.0, billing.getMultiplier()); } @Test diff --git a/java/src/test/java/com/github/copilot/ModeHandlersTest.java b/java/sdk/src/test/java/com/github/copilot/ModeHandlersTest.java similarity index 91% rename from java/src/test/java/com/github/copilot/ModeHandlersTest.java rename to java/sdk/src/test/java/com/github/copilot/ModeHandlersTest.java index 62202c903..942b2efe6 100644 --- a/java/src/test/java/com/github/copilot/ModeHandlersTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ModeHandlersTest.java @@ -7,6 +7,7 @@ import static org.junit.jupiter.api.Assertions.*; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.concurrent.CompletableFuture; import java.util.concurrent.TimeUnit; @@ -18,6 +19,7 @@ import com.github.copilot.generated.ExitPlanModeAction; import com.github.copilot.generated.ExitPlanModeCompletedEvent; import com.github.copilot.generated.ExitPlanModeRequestedEvent; +import com.github.copilot.rpc.AgentMode; import com.github.copilot.rpc.AutoModeSwitchRequest; import com.github.copilot.rpc.AutoModeSwitchResponse; import com.github.copilot.rpc.CopilotClientOptions; @@ -97,20 +99,23 @@ void shouldInvokeExitPlanModeHandlerWhenModelUsesTool() throws Exception { var response = session.sendAndWait(new MessageOptions().setPrompt( "Create a brief implementation plan for adding a greeting.txt file, then request approval with exit_plan_mode.") - .setMode("plan")).get(120, TimeUnit.SECONDS); + .setAgentMode(AgentMode.PLAN)).get(120, TimeUnit.SECONDS); var request = handlerCalled.get(10, TimeUnit.SECONDS); assertEquals(summary, request.getSummary()); - assertNotNull(request.getActions()); - assertTrue(request.getActions().contains("interactive")); + // Canonical action order after CLI 1.0.57+ (aligned with #2023 / other SDKs). + assertEquals(List.of("autopilot", "interactive", "exit_only"), request.getActions()); + assertEquals("interactive", request.getRecommendedAction()); assertNotNull(request.getPlanContent()); var reqEvent = requestedEvent.get(10, TimeUnit.SECONDS); assertEquals(request.getSummary(), reqEvent.getData().summary()); + assertEquals(ExitPlanModeAction.INTERACTIVE, reqEvent.getData().recommendedAction()); var compEvent = completedEvent.get(10, TimeUnit.SECONDS); assertTrue(compEvent.getData().approved()); assertEquals(ExitPlanModeAction.INTERACTIVE, compEvent.getData().selectedAction()); + assertEquals("Approved by the Java E2E test", compEvent.getData().feedback()); assertNotNull(response); diff --git a/java/src/test/java/com/github/copilot/ModelInfoTest.java b/java/sdk/src/test/java/com/github/copilot/ModelInfoTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ModelInfoTest.java rename to java/sdk/src/test/java/com/github/copilot/ModelInfoTest.java diff --git a/java/src/test/java/com/github/copilot/ModuleDescriptorTest.java b/java/sdk/src/test/java/com/github/copilot/ModuleDescriptorTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ModuleDescriptorTest.java rename to java/sdk/src/test/java/com/github/copilot/ModuleDescriptorTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/MultiProviderConfigTest.java b/java/sdk/src/test/java/com/github/copilot/MultiProviderConfigTest.java new file mode 100644 index 000000000..171e525cf --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/MultiProviderConfigTest.java @@ -0,0 +1,190 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.Map; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +import com.github.copilot.rpc.AzureOptions; +import com.github.copilot.rpc.NamedProviderConfig; +import com.github.copilot.rpc.ProviderModelConfig; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * Tests for the additive multi-provider BYOK registry: + * {@link NamedProviderConfig}, {@link ProviderModelConfig}, and their + * integration with {@link SessionConfig} and {@link ResumeSessionConfig}. + */ +public class MultiProviderConfigTest { + + private static final ObjectMapper MAPPER = JsonRpcClient.getObjectMapper(); + + @Test + void testNamedProviderConfigDefaultsAreNull() { + var provider = new NamedProviderConfig(); + + assertNull(provider.getName()); + assertNull(provider.getType()); + assertNull(provider.getWireApi()); + assertNull(provider.getBaseUrl()); + assertNull(provider.getApiKey()); + assertNull(provider.getBearerToken()); + assertNull(provider.getAzure()); + assertNull(provider.getHeaders()); + } + + @Test + void testNamedProviderConfigFluentSettersReturnSameInstance() { + var provider = new NamedProviderConfig(); + + NamedProviderConfig result = provider.setName("my-openai").setType("openai").setWireApi("responses") + .setBaseUrl("https://api.openai.com/v1").setApiKey("sk-test").setBearerToken("bearer") + .setAzure(new AzureOptions()).setHeaders(Map.of("X-Custom", "v")); + + assertEquals(provider, result); + } + + @Test + void testSerializeNamedProviderConfig() throws Exception { + var provider = new NamedProviderConfig().setName("my-openai").setType("openai").setWireApi("responses") + .setBaseUrl("https://api.openai.com/v1").setApiKey("sk-test"); + + JsonNode json = MAPPER.valueToTree(provider); + + assertEquals("my-openai", json.get("name").asText()); + assertEquals("openai", json.get("type").asText()); + assertEquals("responses", json.get("wireApi").asText()); + assertEquals("https://api.openai.com/v1", json.get("baseUrl").asText()); + assertEquals("sk-test", json.get("apiKey").asText()); + // Null fields must be omitted (NON_NULL) + assertTrue(json.path("bearerToken").isMissingNode()); + assertTrue(json.path("azure").isMissingNode()); + assertTrue(json.path("headers").isMissingNode()); + } + + @Test + void testProviderModelConfigDefaultsAreNull() { + var model = new ProviderModelConfig(); + + assertNull(model.getId()); + assertNull(model.getProvider()); + assertNull(model.getWireModel()); + assertNull(model.getModelId()); + assertNull(model.getName()); + assertTrue(model.getMaxPromptTokens().isEmpty()); + assertTrue(model.getMaxContextWindowTokens().isEmpty()); + assertTrue(model.getMaxOutputTokens().isEmpty()); + assertNull(model.getCapabilities()); + } + + @Test + void testSerializeProviderModelConfig() throws Exception { + var model = new ProviderModelConfig().setId("gpt-x").setProvider("my-openai").setWireModel("gpt-x-2025") + .setModelId("gpt-4o").setName("My GPT-X").setMaxPromptTokens(100_000).setMaxContextWindowTokens(128_000) + .setMaxOutputTokens(4096); + + JsonNode json = MAPPER.valueToTree(model); + + assertEquals("gpt-x", json.get("id").asText()); + assertEquals("my-openai", json.get("provider").asText()); + assertEquals("gpt-x-2025", json.get("wireModel").asText()); + assertEquals("gpt-4o", json.get("modelId").asText()); + assertEquals("My GPT-X", json.get("name").asText()); + assertEquals(100_000, json.get("maxPromptTokens").asInt()); + assertEquals(128_000, json.get("maxContextWindowTokens").asInt()); + assertEquals(4096, json.get("maxOutputTokens").asInt()); + assertTrue(json.path("capabilities").isMissingNode()); + + // Round-trip + ProviderModelConfig deserialized = MAPPER.readValue(MAPPER.writeValueAsString(model), + ProviderModelConfig.class); + assertEquals("gpt-x", deserialized.getId()); + assertEquals("my-openai", deserialized.getProvider()); + assertEquals(100_000, deserialized.getMaxPromptTokens().getAsInt()); + assertEquals(128_000, deserialized.getMaxContextWindowTokens().getAsInt()); + assertEquals(4096, deserialized.getMaxOutputTokens().getAsInt()); + } + + @Test + void testSessionConfigWithProvidersAndModels() throws Exception { + var config = new SessionConfig().setModel("gpt-4") + .setProviders(List.of(new NamedProviderConfig().setName("my-openai").setType("openai") + .setBaseUrl("https://api.openai.com/v1").setApiKey("sk-test"))) + .setModels(List.of(new ProviderModelConfig().setId("gpt-x").setProvider("my-openai"))); + + JsonNode json = MAPPER.valueToTree(config); + + assertNotNull(json.get("providers")); + assertEquals(1, json.get("providers").size()); + assertEquals("my-openai", json.get("providers").get(0).get("name").asText()); + assertNotNull(json.get("models")); + assertEquals("gpt-x", json.get("models").get(0).get("id").asText()); + assertEquals("my-openai", json.get("models").get(0).get("provider").asText()); + } + + @Test + void testSessionConfigWithoutProvidersOmitsFields() throws Exception { + var config = new SessionConfig().setModel("gpt-4"); + + JsonNode json = MAPPER.valueToTree(config); + + assertTrue(json.path("providers").isMissingNode()); + assertTrue(json.path("models").isMissingNode()); + } + + @Test + void testSessionConfigCopyPreservesProvidersAndModels() { + var config = new SessionConfig().setProviders(List.of(new NamedProviderConfig().setName("my-azure"))) + .setModels(List.of(new ProviderModelConfig().setId("deploy-1").setProvider("my-azure"))); + + SessionConfig copy = config.clone(); + + assertNotNull(copy.getProviders()); + assertEquals(1, copy.getProviders().size()); + assertEquals("my-azure", copy.getProviders().get(0).getName()); + assertNotNull(copy.getModels()); + assertEquals("deploy-1", copy.getModels().get(0).getId()); + } + + @Test + void testResumeSessionConfigWithProvidersAndModels() throws Exception { + var config = new ResumeSessionConfig() + .setProviders(List.of(new NamedProviderConfig().setName("my-azure").setType("azure") + .setBaseUrl("https://example.openai.azure.com") + .setAzure(new AzureOptions().setApiVersion("2024-10-21")))) + .setModels(List + .of(new ProviderModelConfig().setId("deploy-1").setProvider("my-azure").setModelId("gpt-4o"))); + + JsonNode json = MAPPER.valueToTree(config); + + assertNotNull(json.get("providers")); + assertEquals("my-azure", json.get("providers").get(0).get("name").asText()); + assertEquals("2024-10-21", json.get("providers").get(0).get("azure").get("apiVersion").asText()); + assertNotNull(json.get("models")); + assertEquals("deploy-1", json.get("models").get(0).get("id").asText()); + assertEquals("gpt-4o", json.get("models").get(0).get("modelId").asText()); + } + + @Test + void testResumeSessionConfigWithoutProvidersOmitsFields() throws Exception { + var config = new ResumeSessionConfig().setStreaming(true); + + JsonNode json = MAPPER.valueToTree(config); + + assertTrue(json.path("providers").isMissingNode()); + assertTrue(json.path("models").isMissingNode()); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java b/java/sdk/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java new file mode 100644 index 000000000..095543881 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/MultiProviderRegistryE2ETest.java @@ -0,0 +1,223 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.AgentInfo; +import com.github.copilot.rpc.CustomAgentConfig; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.NamedProviderConfig; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderModelConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * End-to-end coverage for the experimental multi-provider BYOK registry + * ({@code SessionConfig.providers} / {@code SessionConfig.models}). Validates + * that several named providers, several models per provider, and custom agents + * bound to those provider-qualified models can coexist in one session, be + * launched, and route inference to the configured provider with the configured + * wire model and headers. + */ +public class MultiProviderRegistryE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + /** + * Builds a heterogeneous registry: two providers of different types, with + * multiple models each. Provider-qualified selection ids are + * {@code alpha/sonnet}, {@code alpha/haiku}, {@code beta/opus}, + * {@code beta/haiku}. + */ + private static List registryProviders() { + return List.of( + new NamedProviderConfig().setName("alpha").setType("openai").setWireApi("completions") + .setBaseUrl("https://alpha.example.test/v1").setApiKey("alpha-secret") + .setHeaders(Map.of("X-Provider", "alpha")), + new NamedProviderConfig().setName("beta").setType("anthropic").setBaseUrl("https://beta.example.test") + .setBearerToken("beta-bearer").setHeaders(Map.of("X-Provider", "beta"))); + } + + private static List registryModels() { + return List.of( + new ProviderModelConfig().setId("sonnet").setProvider("alpha").setWireModel("byok-gpt-4o") + .setMaxPromptTokens(111111), + new ProviderModelConfig().setId("haiku").setProvider("alpha").setWireModel("byok-gpt-4o-mini"), + new ProviderModelConfig().setId("opus").setProvider("beta").setWireModel("byok-claude-3-opus"), + new ProviderModelConfig().setId("haiku").setProvider("beta").setWireModel("byok-claude-3-haiku")); + } + + private static List registryAgents() { + return List.of( + new CustomAgentConfig().setName("orchestrator").setDisplayName("Orchestrator") + .setDescription("Top-level planner.").setPrompt("Plan and delegate.").setModel("alpha/sonnet"), + new CustomAgentConfig().setName("researcher").setDisplayName("Researcher") + .setDescription("Deep research subagent.").setPrompt("Research thoroughly.") + .setModel("beta/opus"), + new CustomAgentConfig().setName("fast-helper").setDisplayName("Fast Helper") + .setDescription("Quick subagent.").setPrompt("Answer quickly.").setModel("alpha/haiku"), + new CustomAgentConfig().setName("summarizer").setDisplayName("Summarizer") + .setDescription("Summarizing subagent.").setPrompt("Summarize.").setModel("beta/haiku")); + } + + @Test + void testShouldRegisterMultipleProvidersWithCustomAgentsBoundToTheirModels() throws Exception { + ctx.configureForTest("multi_provider_registry", + "should_register_multiple_providers_with_custom_agents_bound_to_their_models"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setProviders(registryProviders()).setModels(registryModels()) + .setCustomAgents(registryAgents()).setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + List agents = session.listAgents().get(30, TimeUnit.SECONDS); + + // All four custom agents coexist in a single session. + assertEquals(4, agents.size(), "Expected all four custom agents to coexist"); + + // Each agent is bound to its configured provider-qualified BYOK model. + assertAgentModel(agents, "orchestrator", "alpha/sonnet", "Orchestrator", "Top-level planner."); + assertAgentModel(agents, "researcher", "beta/opus", "Researcher", "Deep research subagent."); + assertAgentModel(agents, "fast-helper", "alpha/haiku", "Fast Helper", "Quick subagent."); + assertAgentModel(agents, "summarizer", "beta/haiku", "Summarizer", "Summarizing subagent."); + + // Models from BOTH providers are represented, proving the two + // providers and their models coexist within the same session. + Set boundModels = new HashSet<>(); + for (AgentInfo agent : agents) { + boundModels.add(agent.getModel()); + } + assertTrue(boundModels.stream().anyMatch(m -> m != null && m.startsWith("alpha/")), + "Expected a model from provider 'alpha' to be represented"); + assertTrue(boundModels.stream().anyMatch(m -> m != null && m.startsWith("beta/")), + "Expected a model from provider 'beta' to be represented"); + } + } + + @Test + void testShouldRouteAlphaSonnetTurnToItsProviderAndWireModel() throws Exception { + assertRouting("should_route_alpha_sonnet_turn_to_its_provider_and_wire_model", "alpha/sonnet", "byok-gpt-4o", + "alpha"); + } + + @Test + void testShouldRouteAlphaHaikuTurnToItsProviderAndWireModel() throws Exception { + assertRouting("should_route_alpha_haiku_turn_to_its_provider_and_wire_model", "alpha/haiku", "byok-gpt-4o-mini", + "alpha"); + } + + @Test + void testShouldRouteDeltaTurboTurnToItsProviderAndWireModel() throws Exception { + assertRouting("should_route_delta_turbo_turn_to_its_provider_and_wire_model", "delta/turbo", "byok-gpt-4-turbo", + "delta"); + } + + /** + * Selects {@code selectionId} in a session whose registry holds two + * OpenAI-compatible providers (each pointed at the replay proxy), runs a turn, + * and asserts the captured request used the model's configured wire model and + * carried the owning provider's header and credential. + */ + private void assertRouting(String snapshot, String selectionId, String expectedWireModel, + String expectedProviderHeader) throws Exception { + ctx.configureForTest("multi_provider_registry", snapshot); + + try (CopilotClient client = ctx.createClient()) { + // Two OpenAI-compatible providers, both pointed at the replay proxy + // so their /chat/completions traffic is captured. They are + // distinguished on the wire by their per-provider X-Provider header. + // "alpha" carries two models (multiple models per provider); + // "delta" carries one. + List providers = List.of( + new NamedProviderConfig().setName("alpha").setType("openai").setWireApi("completions") + .setBaseUrl(ctx.getProxyUrl()).setApiKey("alpha-secret") + .setHeaders(Map.of("X-Provider", "alpha")), + new NamedProviderConfig().setName("delta").setType("openai").setWireApi("completions") + .setBaseUrl(ctx.getProxyUrl()).setApiKey("delta-secret") + .setHeaders(Map.of("X-Provider", "delta"))); + List models = List.of( + new ProviderModelConfig().setId("sonnet").setProvider("alpha").setWireModel("byok-gpt-4o"), + new ProviderModelConfig().setId("haiku").setProvider("alpha").setWireModel("byok-gpt-4o-mini"), + new ProviderModelConfig().setId("turbo").setProvider("delta").setWireModel("byok-gpt-4-turbo")); + + CopilotSession session = client.createSession(new SessionConfig().setModel(selectionId) + .setProviders(providers).setModels(models).setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + session.sendAndWait(new MessageOptions().setPrompt("What is 5+5?")).get(30, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertEquals(1, exchanges.size(), "Expected exactly one captured /chat/completions exchange"); + Map exchange = exchanges.get(0); + + @SuppressWarnings("unchecked") + Map request = (Map) exchange.get("request"); + + // The wire model sent to the provider is the selected model's wire + // model, not its provider-qualified selection id. + assertEquals(expectedWireModel, request.get("model")); + + // The request carried the owning provider's custom header, proving + // the turn was dispatched against the correct provider connection. + assertEquals(expectedProviderHeader, getHeaderValue(exchange, "X-Provider")); + + // The provider's API key was applied as an Authorization header. + String authorization = getHeaderValue(exchange, "Authorization"); + assertNotNull(authorization, "Expected an Authorization header on the dispatched request"); + assertFalse(authorization.isEmpty(), "Expected a non-empty Authorization header"); + } + } + + private static void assertAgentModel(List agents, String name, String expectedModel, + String expectedDisplayName, String expectedDescription) { + AgentInfo agent = agents.stream().filter(a -> name.equals(a.getName())).findFirst() + .orElseThrow(() -> new AssertionError("Expected an agent named '" + name + "'")); + assertEquals(expectedModel, agent.getModel(), "Unexpected model binding for agent '" + name + "'"); + assertEquals(expectedDisplayName, agent.getDisplayName(), "Unexpected display name for agent '" + name + "'"); + assertEquals(expectedDescription, agent.getDescription(), "Unexpected description for agent '" + name + "'"); + } + + @SuppressWarnings("unchecked") + private static String getHeaderValue(Map exchange, String name) { + Object headersObj = exchange.get("requestHeaders"); + if (!(headersObj instanceof Map headers)) { + return null; + } + for (Map.Entry entry : headers.entrySet()) { + if (entry.getKey() != null && entry.getKey().toString().equalsIgnoreCase(name)) { + Object value = entry.getValue(); + if (value instanceof List list) { + return list.isEmpty() ? null : String.valueOf(list.get(0)); + } + return value != null ? value.toString() : null; + } + } + return null; + } +} diff --git a/java/src/test/java/com/github/copilot/OptionalApiAndJacksonTest.java b/java/sdk/src/test/java/com/github/copilot/OptionalApiAndJacksonTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/OptionalApiAndJacksonTest.java rename to java/sdk/src/test/java/com/github/copilot/OptionalApiAndJacksonTest.java diff --git a/java/src/test/java/com/github/copilot/PerSessionAuthTest.java b/java/sdk/src/test/java/com/github/copilot/PerSessionAuthTest.java similarity index 75% rename from java/src/test/java/com/github/copilot/PerSessionAuthTest.java rename to java/sdk/src/test/java/com/github/copilot/PerSessionAuthTest.java index 000d36e4b..9e5cd1b32 100644 --- a/java/src/test/java/com/github/copilot/PerSessionAuthTest.java +++ b/java/sdk/src/test/java/com/github/copilot/PerSessionAuthTest.java @@ -13,7 +13,7 @@ import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; -import com.github.copilot.generated.rpc.SessionAuthGetStatusResult; +import com.github.copilot.generated.rpc.SessionGitHubAuthGetStatusResult; import com.github.copilot.rpc.CopilotClientOptions; import com.github.copilot.rpc.PermissionHandler; import com.github.copilot.rpc.SessionConfig; @@ -73,7 +73,7 @@ void shouldAuthenticateWithGitHubToken() throws Exception { .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); try { - SessionAuthGetStatusResult authStatus = session.getRpc().auth.getStatus().get(); + SessionGitHubAuthGetStatusResult authStatus = session.getRpc().gitHubAuth.getStatus().get(); assertTrue(authStatus.isAuthenticated(), "Expected session to be authenticated"); assertEquals("alice", authStatus.login()); @@ -94,8 +94,8 @@ void shouldIsolateAuthBetweenSessions() throws Exception { .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); try { - SessionAuthGetStatusResult statusA = sessionA.getRpc().auth.getStatus().get(); - SessionAuthGetStatusResult statusB = sessionB.getRpc().auth.getStatus().get(); + SessionGitHubAuthGetStatusResult statusA = sessionA.getRpc().gitHubAuth.getStatus().get(); + SessionGitHubAuthGetStatusResult statusB = sessionB.getRpc().gitHubAuth.getStatus().get(); assertTrue(statusA.isAuthenticated(), "Expected session A to be authenticated"); assertEquals("alice", statusA.login()); @@ -111,16 +111,29 @@ void shouldIsolateAuthBetweenSessions() throws Exception { @Test void shouldBeUnauthenticatedWithoutToken() throws Exception { - try (CopilotClient client = createAuthTestClient()) { + Map env = new HashMap<>(ctx.getEnvironment()); + env.put("COPILOT_DEBUG_GITHUB_API_URL", ctx.getProxyUrl()); + // Strip global auth tokens so there is no global identity to fall back to, + // mirroring the Go/Node per-session-auth "without token" tests. Otherwise the + // process-level fake token resolves to the default e2e user registered on the + // proxy and the session reports a login. + env.put("GH_TOKEN", ""); + env.put("GITHUB_TOKEN", ""); + env.put("COPILOT_SDK_AUTH_TOKEN", ""); + + // Build the client directly (not via ctx.createClient) so the context's + // default GitHub token is not auto-injected and useLoggedInUser is disabled. + CopilotClientOptions options = new CopilotClientOptions().setCliPath(ctx.getCliPath()) + .setCwd(ctx.getWorkDir().toString()).setEnvironment(env).setUseLoggedInUser(false); + + try (CopilotClient client = new CopilotClient(options)) { CopilotSession session = client .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); try { - SessionAuthGetStatusResult authStatus = session.getRpc().auth.getStatus().get(); + SessionGitHubAuthGetStatusResult authStatus = session.getRpc().gitHubAuth.getStatus().get(); - // Without a per-session token, there is no per-session identity. - // In CI the process-level fake token may still authenticate globally, - // so we check login rather than isAuthenticated. + // With no global or per-session token, there is no identity at all. assertNull(authStatus.login(), "Expected no login without per-session token"); } finally { session.close(); diff --git a/java/src/test/java/com/github/copilot/PermissionRequestResultKindTest.java b/java/sdk/src/test/java/com/github/copilot/PermissionRequestResultKindTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/PermissionRequestResultKindTest.java rename to java/sdk/src/test/java/com/github/copilot/PermissionRequestResultKindTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/PermissionRequestResultTest.java b/java/sdk/src/test/java/com/github/copilot/PermissionRequestResultTest.java new file mode 100644 index 000000000..c1ca9191b --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/PermissionRequestResultTest.java @@ -0,0 +1,165 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.PermissionRequestedEvent; +import com.github.copilot.rpc.PermissionRequestResult; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.PermissionInvocation; +import com.github.copilot.rpc.PermissionRequest; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.json.JsonMapper; +import com.fasterxml.jackson.annotation.JsonInclude; + +/** + * Tests for {@link PermissionRequestResult} factory methods and feedback field. + */ +public class PermissionRequestResultTest { + + private static final ObjectMapper MAPPER = JsonMapper.builder().serializationInclusion(JsonInclude.Include.NON_NULL) + .build(); + + @Test + void testApproveOnce() { + var result = PermissionRequestResult.approveOnce(); + assertEquals("approve-once", result.getKind()); + assertNull(result.getFeedback()); + } + + @Test + void testRejectWithFeedback() { + var result = PermissionRequestResult.reject("Not allowed"); + assertEquals("reject", result.getKind()); + assertEquals("Not allowed", result.getFeedback()); + } + + @Test + void testRejectWithoutFeedback() { + var result = PermissionRequestResult.reject(null); + assertEquals("reject", result.getKind()); + assertNull(result.getFeedback()); + } + + @Test + void testUserNotAvailable() { + var result = PermissionRequestResult.userNotAvailable(); + assertEquals("user-not-available", result.getKind()); + assertNull(result.getFeedback()); + } + + @Test + void testNoResult() { + var result = PermissionRequestResult.noResult(); + assertEquals("no-result", result.getKind()); + assertNull(result.getFeedback()); + } + + @Test + void testFeedbackSerialized() throws Exception { + var result = PermissionRequestResult.reject("Unsafe operation"); + var json = MAPPER.writeValueAsString(result); + assertTrue(json.contains("\"feedback\":\"Unsafe operation\"")); + assertTrue(json.contains("\"kind\":\"reject\"")); + } + + @Test + void testFeedbackNotSerializedWhenNull() throws Exception { + var result = PermissionRequestResult.approveOnce(); + var json = MAPPER.writeValueAsString(result); + assertFalse(json.contains("feedback")); + } + + @Test + void testPermissionRequestExposesManagedApprovalRequired() throws Exception { + var request = MAPPER.readValue(""" + { + "kind": "read", + "path": "/workspace/file.txt", + "managedApprovalRequired": true + } + """, PermissionRequest.class); + + assertTrue(request.getManagedApprovalRequired()); + } + + @Test + void testMalformedManagedApprovalRequiredFailsClosed() throws Exception { + var request = MAPPER.readValue(""" + { + "kind": "read", + "managedApprovalRequired": 0 + } + """, PermissionRequest.class); + + assertTrue(request.getManagedApprovalRequired()); + var result = PermissionHandler.APPROVE_ALL.handle(request, new PermissionInvocation()).join(); + assertEquals("no-result", result.getKind()); + } + + @Test + void testManagedApprovalRequiredPreservesFalse() throws Exception { + var request = MAPPER.readValue(""" + { + "kind": "read", + "managedApprovalRequired": false + } + """, PermissionRequest.class); + + assertFalse(request.getManagedApprovalRequired()); + var result = PermissionHandler.APPROVE_ALL.handle(request, new PermissionInvocation()).join(); + assertEquals("approve-once", result.getKind()); + } + + @Test + void testPermissionEventValueConvertsToTypedRequest() { + var event = MAPPER + .convertValue( + java.util.Map.of("type", "permission.requested", "data", + java.util.Map.of("requestId", "permission-1", "permissionRequest", java.util.Map.of( + "kind", "url", "managedApprovalRequired", true, "url", "https://example.com"))), + PermissionRequestedEvent.class); + var request = PermissionRequest.fromJsonValue(event.getData().permissionRequest()); + + assertTrue(request.getManagedApprovalRequired()); + } + + @Test + void testApproveAllFailsWhenManagedSettingsEnabled() { + var request = new PermissionRequest(); + request.setKind("read"); + request.setManagedApprovalRequired(true); + + var invocation = new PermissionInvocation().setManagedSettingsEnabled(true); + var error = assertThrows(java.util.concurrent.CompletionException.class, + () -> PermissionHandler.APPROVE_ALL.handle(request, invocation).join()); + + assertTrue(error.getCause() instanceof IllegalStateException); + } + + @Test + void testApproveAllApprovesOrdinaryRequest() { + var request = new PermissionRequest(); + request.setKind("read"); + + var result = PermissionHandler.APPROVE_ALL.handle(request, new PermissionInvocation()).join(); + + assertEquals("approve-once", result.getKind()); + } + + @Test + void testApproveAllLeavesManagedRequestPendingWhenSessionFlagIsAbsent() { + var request = new PermissionRequest(); + request.setKind("read"); + request.setManagedApprovalRequired(true); + + var result = PermissionHandler.APPROVE_ALL.handle(request, new PermissionInvocation()).join(); + + assertEquals("no-result", result.getKind()); + } +} diff --git a/java/src/test/java/com/github/copilot/PermissionsTest.java b/java/sdk/src/test/java/com/github/copilot/PermissionsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/PermissionsTest.java rename to java/sdk/src/test/java/com/github/copilot/PermissionsTest.java diff --git a/java/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java b/java/sdk/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java similarity index 77% rename from java/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java rename to java/sdk/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java index 5da0d2002..392e2cc75 100644 --- a/java/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java +++ b/java/sdk/src/test/java/com/github/copilot/PreMcpToolCallHookTest.java @@ -14,7 +14,6 @@ import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import com.fasterxml.jackson.databind.JsonNode; @@ -55,21 +54,25 @@ static void teardown() throws Exception { } } + private McpStdioServerConfig createMetaEchoServer() { + var harnessDir = ctx.getRepoRoot().resolve("test").resolve("harness"); + return new McpStdioServerConfig().setCommand("node") + .setArgs(List.of(harnessDir.resolve("test-mcp-meta-echo-server.mjs").toString())) + .setWorkingDirectory(harnessDir.toString()).setTools(List.of("*")); + } + /** * Verifies that preMcpToolCall hook can set metadata on the MCP request. * * @see Snapshot: pre_mcp_tool_call_hook/should_set_meta_via_premcptoolcall_hook */ - @Disabled("Requires snapshot: pre_mcp_tool_call_hook/should_set_meta_via_premcptoolcall_hook") @Test void testShouldSetMetaViaPreMcpToolCallHook() throws Exception { ctx.configureForTest("pre_mcp_tool_call_hook", "should_set_meta_via_premcptoolcall_hook"); var hookInputs = new java.util.ArrayList(); - var mcpServers = new HashMap(); - mcpServers.put("meta-echo", new McpStdioServerConfig().setCommand("npx").setArgs(List.of("-y", "mcp-meta-echo")) - .setTools(List.of("*")).setWorkingDirectory(ctx.getWorkDir().toString())); + mcpServers.put("meta-echo", createMetaEchoServer()); var hooks = new SessionHooks().setOnPreMcpToolCall((input, invocation) -> { hookInputs.add(input); @@ -97,6 +100,7 @@ void testShouldSetMetaViaPreMcpToolCallHook() throws Exception { // Verify the response contains the injected metadata String content = response.getData().content(); + assertTrue(content.contains("injected"), "Response should contain injected metadata: " + content); assertTrue(content.contains("by-hook"), "Response should contain injected metadata: " + content); session.close(); @@ -109,17 +113,17 @@ void testShouldSetMetaViaPreMcpToolCallHook() throws Exception { * @see Snapshot: * pre_mcp_tool_call_hook/should_replace_meta_via_premcptoolcall_hook */ - @Disabled("Requires snapshot: pre_mcp_tool_call_hook/should_replace_meta_via_premcptoolcall_hook") @Test void testShouldReplaceMetaViaPreMcpToolCallHook() throws Exception { ctx.configureForTest("pre_mcp_tool_call_hook", "should_replace_meta_via_premcptoolcall_hook"); + var hookInputs = new java.util.ArrayList(); var mcpServers = new HashMap(); - mcpServers.put("meta-echo", new McpStdioServerConfig().setCommand("npx").setArgs(List.of("-y", "mcp-meta-echo")) - .setTools(List.of("*")).setWorkingDirectory(ctx.getWorkDir().toString())); + mcpServers.put("meta-echo", createMetaEchoServer()); var hooks = new SessionHooks().setOnPreMcpToolCall((input, invocation) -> { - JsonNode metaNode = MAPPER.valueToTree(Map.of("replaced", "true", "original", "gone")); + hookInputs.add(input); + JsonNode metaNode = MAPPER.valueToTree(Map.of("completely", "replaced")); return CompletableFuture.completedFuture(PreMcpToolCallHookOutput.withMeta(metaNode)); }); @@ -132,9 +136,13 @@ void testShouldReplaceMetaViaPreMcpToolCallHook() throws Exception { .get(60, TimeUnit.SECONDS); assertNotNull(response); + assertFalse(hookInputs.isEmpty(), "Should have received preMcpToolCall hook calls"); + assertEquals("meta-echo", hookInputs.get(0).getServerName()); + assertEquals("echo_meta", hookInputs.get(0).getToolName()); // Verify the response contains the replaced metadata String content = response.getData().content(); + assertTrue(content.contains("completely"), "Response should contain replaced metadata: " + content); assertTrue(content.contains("replaced"), "Response should contain replaced metadata: " + content); session.close(); @@ -147,17 +155,16 @@ void testShouldReplaceMetaViaPreMcpToolCallHook() throws Exception { * @see Snapshot: * pre_mcp_tool_call_hook/should_remove_meta_via_premcptoolcall_hook */ - @Disabled("Requires snapshot: pre_mcp_tool_call_hook/should_remove_meta_via_premcptoolcall_hook") @Test void testShouldRemoveMetaViaPreMcpToolCallHook() throws Exception { ctx.configureForTest("pre_mcp_tool_call_hook", "should_remove_meta_via_premcptoolcall_hook"); + var hookInputs = new java.util.ArrayList(); var mcpServers = new HashMap(); - mcpServers.put("meta-echo", new McpStdioServerConfig().setCommand("npx").setArgs(List.of("-y", "mcp-meta-echo")) - .setTools(List.of("*")).setWorkingDirectory(ctx.getWorkDir().toString())); + mcpServers.put("meta-echo", createMetaEchoServer()); var hooks = new SessionHooks().setOnPreMcpToolCall((input, invocation) -> { - // Return output with null metaToUse to remove metadata + hookInputs.add(input); return CompletableFuture.completedFuture(PreMcpToolCallHookOutput.removeMeta()); }); @@ -170,6 +177,14 @@ void testShouldRemoveMetaViaPreMcpToolCallHook() throws Exception { .get(60, TimeUnit.SECONDS); assertNotNull(response); + assertFalse(hookInputs.isEmpty(), "Should have received preMcpToolCall hook calls"); + assertEquals("meta-echo", hookInputs.get(0).getServerName()); + assertEquals("echo_meta", hookInputs.get(0).getToolName()); + + String content = response.getData().content(); + assertTrue(content.contains("\"meta\":null") || content.contains("\"meta\": null"), + "Response should contain removed metadata: " + content); + assertTrue(content.contains("test-remove"), "Response should contain tool value: " + content); session.close(); } diff --git a/java/src/test/java/com/github/copilot/ProviderConfigTest.java b/java/sdk/src/test/java/com/github/copilot/ProviderConfigTest.java similarity index 95% rename from java/src/test/java/com/github/copilot/ProviderConfigTest.java rename to java/sdk/src/test/java/com/github/copilot/ProviderConfigTest.java index 5c40230ec..effb36040 100644 --- a/java/src/test/java/com/github/copilot/ProviderConfigTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ProviderConfigTest.java @@ -224,6 +224,28 @@ void testSerializeCustomWireApi() throws Exception { assertEquals("responses", json.get("wireApi").asText()); } + @Test + void testSerializeTransport() throws Exception { + var provider = new ProviderConfig().setType("openai").setBaseUrl("https://custom.example.com").setApiKey("key") + .setWireApi("responses").setTransport("websockets"); + + JsonNode json = MAPPER.valueToTree(provider); + + assertEquals("websockets", json.get("transport").asText()); + + ProviderConfig roundTrip = MAPPER.readValue(MAPPER.writeValueAsString(provider), ProviderConfig.class); + assertEquals("websockets", roundTrip.getTransport()); + } + + @Test + void testTransportOmittedWhenNull() throws Exception { + var provider = new ProviderConfig().setType("openai").setBaseUrl("https://custom.example.com"); + + JsonNode json = MAPPER.valueToTree(provider); + + assertTrue(json.path("transport").isMissingNode()); + } + // ========================================================================= // JSON serialization — all fields populated // ========================================================================= diff --git a/java/sdk/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java b/java/sdk/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java new file mode 100644 index 000000000..1e302982e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ProviderEndpointE2ETest.java @@ -0,0 +1,155 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.HashMap; +import java.util.Map; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.ProviderEndpointType; +import com.github.copilot.generated.rpc.ProviderEndpointWireApi; +import com.github.copilot.generated.rpc.ProviderSessionToken; +import com.github.copilot.generated.rpc.SessionProviderGetEndpointResult; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * Tests for the {@code session.provider.getEndpoint} RPC, which surfaces the + * resolved provider endpoint and credentials for either a BYOK or CAPI session. + */ +public class ProviderEndpointE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + // session.provider.getEndpoint is gated behind + // COPILOT_ALLOW_GET_PROVIDER_ENDPOINT; + // the harness env passed to the CLI subprocess opts in for these tests. + private CopilotClient createProviderEndpointClient() { + Map env = new HashMap<>(ctx.getEnvironment()); + env.put("COPILOT_ALLOW_GET_PROVIDER_ENDPOINT", "true"); + return ctx.createClient(new CopilotClientOptions().setEnvironment(env)); + } + + @Test + void shouldReturnByokProviderEndpointWhenCustomProviderConfigured() throws Exception { + try (CopilotClient client = createProviderEndpointClient()) { + Map customHeaders = new HashMap<>(); + customHeaders.put("X-Custom-Header", "byok-yes"); + + ProviderConfig provider = new ProviderConfig().setType("openai").setWireApi("completions") + .setBaseUrl("https://api.example.test/v1").setApiKey("byok-secret").setHeaders(customHeaders); + + CopilotSession session = client.createSession( + new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setProvider(provider)) + .get(); + + try { + SessionProviderGetEndpointResult endpoint = session.getRpc().provider.getEndpoint().get(); + + assertEquals(ProviderEndpointType.OPENAI, endpoint.type()); + assertEquals(ProviderEndpointWireApi.COMPLETIONS, endpoint.wireApi()); + assertEquals("https://api.example.test/v1", endpoint.baseUrl()); + assertEquals("byok-secret", endpoint.apiKey()); + assertEquals("byok-yes", endpoint.headers().get("X-Custom-Header")); + // BYOK sessions never issue a CAPI session token. + assertNull(endpoint.sessionToken(), "BYOK session should not have a session token"); + } finally { + try { + session.close(); + } catch (Exception ignored) { + // disconnect may fail since the BYOK provider URL is fake + } + } + } + } + + @Test + void shouldReturnCapiProviderEndpointForOAuthAuthenticatedSession() throws Exception { + ctx.initializeProxy(); + ctx.setCopilotUserByToken("fake-token-for-e2e-tests", "e2e-user", "individual_pro", ctx.getProxyUrl(), + "https://localhost:1/telemetry", "e2e-tracking-id"); + + try (CopilotClient client = createProviderEndpointClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + try { + SessionProviderGetEndpointResult endpoint = session.getRpc().provider.getEndpoint().get(); + + assertNotNull(endpoint.type(), "CAPI endpoint should have a provider type"); + assertTrue( + endpoint.type() == ProviderEndpointType.OPENAI || endpoint.type() == ProviderEndpointType.AZURE + || endpoint.type() == ProviderEndpointType.ANTHROPIC, + "expected type in {openai, azure, anthropic}, got " + endpoint.type()); + // wireApi is omitted for anthropic; otherwise one of the OpenAI shapes. + if (endpoint.type() != ProviderEndpointType.ANTHROPIC) { + assertTrue( + endpoint.wireApi() == ProviderEndpointWireApi.COMPLETIONS + || endpoint.wireApi() == ProviderEndpointWireApi.RESPONSES, + "expected wireApi in {completions, responses}, got " + endpoint.wireApi()); + } + + // CAPI baseUrl is the (proxy) Copilot API URL injected by the harness. + assertTrue(endpoint.baseUrl().startsWith("http://") || endpoint.baseUrl().startsWith("https://"), + "expected http(s) baseUrl, got " + endpoint.baseUrl()); + + // For CAPI OAuth sessions the apiKey is the resolved GitHub bearer. + assertNotNull(endpoint.apiKey(), "CAPI OAuth session must surface apiKey"); + assertFalse(endpoint.apiKey().isEmpty(), "apiKey must be non-empty"); + + Map headers = endpoint.headers(); + String integrationId = headers.get("Copilot-Integration-Id"); + assertNotNull(integrationId, "Copilot-Integration-Id header must be present"); + assertFalse(integrationId.isEmpty(), "Copilot-Integration-Id must be non-empty"); + + String userAgent = headers.get("User-Agent"); + assertNotNull(userAgent, "User-Agent header must be present"); + assertTrue(userAgent.toLowerCase().contains("copilot"), + "expected User-Agent to mention Copilot, got " + userAgent); + + String apiVersion = headers.get("X-GitHub-Api-Version"); + assertNotNull(apiVersion, "X-GitHub-Api-Version header must be present"); + assertFalse(apiVersion.isEmpty(), "X-GitHub-Api-Version must be non-empty"); + + String interactionId = headers.get("X-Interaction-Id"); + assertNotNull(interactionId, "X-Interaction-Id header must be present"); + assertTrue(interactionId.matches(".*[0-9a-f-]{8,}.*"), + "expected X-Interaction-Id to look like a hex/uuid value, got " + interactionId); + + String authorization = headers.get("Authorization"); + assertEquals("Bearer " + endpoint.apiKey(), authorization); + + ProviderSessionToken sessionToken = endpoint.sessionToken(); + if (sessionToken != null) { + assertEquals("Copilot-Session-Token", sessionToken.header()); + assertFalse(sessionToken.token().isEmpty(), "session token must be non-empty"); + // expiresAt is optional; when present it parses as OffsetDateTime so no + // additional validation is needed. + } + } finally { + session.close(); + } + } + } +} diff --git a/java/src/test/java/com/github/copilot/RemoteSessionTest.java b/java/sdk/src/test/java/com/github/copilot/RemoteSessionTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/RemoteSessionTest.java rename to java/sdk/src/test/java/com/github/copilot/RemoteSessionTest.java diff --git a/java/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java b/java/sdk/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java rename to java/sdk/src/test/java/com/github/copilot/RpcHandlerDispatcherTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/RpcServerE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcServerE2ETest.java new file mode 100644 index 000000000..2393f334b --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/RpcServerE2ETest.java @@ -0,0 +1,596 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.time.OffsetDateTime; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.AccountQuotaSnapshot; +import com.github.copilot.generated.rpc.AgentsDiscoverParams; +import com.github.copilot.generated.rpc.AgentsGetDiscoveryPathsParams; +import com.github.copilot.generated.rpc.InstructionsDiscoverParams; +import com.github.copilot.generated.rpc.InstructionsGetDiscoveryPathsParams; +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseChunkError; +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseChunkParams; +import com.github.copilot.generated.rpc.LlmInferenceHttpResponseStartParams; +import com.github.copilot.generated.rpc.LocalSessionMetadataValue; +import com.github.copilot.generated.rpc.McpDiscoverParams; +import com.github.copilot.generated.rpc.PingParams; +import com.github.copilot.generated.rpc.SecretsAddFilterValuesParams; +import com.github.copilot.generated.rpc.ServerSkill; +import com.github.copilot.generated.rpc.SessionContext; +import com.github.copilot.generated.rpc.SessionFsSetProviderCapabilities; +import com.github.copilot.generated.rpc.SessionFsSetProviderConventions; +import com.github.copilot.generated.rpc.SessionFsSetProviderParams; +import com.github.copilot.generated.rpc.SessionsBulkDeleteParams; +import com.github.copilot.generated.rpc.SessionsCheckInUseParams; +import com.github.copilot.generated.rpc.SessionsCloseParams; +import com.github.copilot.generated.rpc.SessionsConnectParams; +import com.github.copilot.generated.rpc.SessionsEnrichMetadataParams; +import com.github.copilot.generated.rpc.SessionsFindByPrefixParams; +import com.github.copilot.generated.rpc.SessionsFindByTaskIdParams; +import com.github.copilot.generated.rpc.SessionsGetEventFilePathParams; +import com.github.copilot.generated.rpc.SessionsGetLastForContextParams; +import com.github.copilot.generated.rpc.SessionsGetPersistedRemoteSteerableParams; +import com.github.copilot.generated.rpc.SessionsLoadDeferredRepoHooksParams; +import com.github.copilot.generated.rpc.SessionsPruneOldParams; +import com.github.copilot.generated.rpc.SessionsReleaseLockParams; +import com.github.copilot.generated.rpc.SessionsReloadPluginHooksParams; +import com.github.copilot.generated.rpc.SessionsSaveParams; +import com.github.copilot.generated.rpc.SessionsSetAdditionalPluginsParams; +import com.github.copilot.generated.rpc.SkillsConfigSetDisabledSkillsParams; +import com.github.copilot.generated.rpc.SkillsDiscoverParams; +import com.github.copilot.generated.rpc.SkillsGetDiscoveryPathsParams; +import com.github.copilot.generated.rpc.ToolsListParams; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.InfiniteSessionConfig; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +class RpcServerE2ETest { + + private static final long TIMEOUT_SECONDS = 30; + private static final long SESSION_PERSISTENCE_TIMEOUT_MILLIS = 30_000; + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldCallRpcPingWithTypedParamsAndResult() throws Exception { + ctx.configureForTest("rpc_server", "should_call_rpc_ping_with_typed_params_and_result"); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + var result = client.getRpc().ping(new PingParams("typed rpc test")).get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertEquals("pong: typed rpc test", result.message()); + assertNotNull(result.timestamp()); + assertNotNull(result.protocolVersion()); + assertTrue(result.protocolVersion() >= 0); + } + } + + @Test + void testShouldRejectLlmInferenceResponseFramesForMissingRequest() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var requestId = "missing-llm-inference-request"; + + var start = client.getRpc().llmInference + .httpResponseStart(new LlmInferenceHttpResponseStartParams(requestId, 200L, "OK", + Map.of("content-type", List.of("text/event-stream")))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertFalse(start.accepted()); + + var chunk = client.getRpc().llmInference + .httpResponseChunk( + new LlmInferenceHttpResponseChunkParams(requestId, "data: {}\n\n", false, false, null)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertFalse(chunk.accepted()); + + var error = client.getRpc().llmInference.httpResponseChunk(new LlmInferenceHttpResponseChunkParams( + requestId, "", null, true, + new LlmInferenceHttpResponseChunkError("No pending LLM inference request.", "missing_request"))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertFalse(error.accepted()); + } + } + + @Test + void testShouldCallRpcModelsListWithTypedResult() throws Exception { + ctx.configureForTest("rpc_server", "should_call_rpc_models_list_with_typed_result"); + var token = "rpc-models-token"; + configureAuthenticatedUser(token, null); + + try (var client = createAuthenticatedClient(token)) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + var result = client.getRpc().models.list().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertNotNull(result.models()); + assertTrue(result.models().stream().anyMatch(model -> "claude-sonnet-4.5".equals(model.id()))); + result.models().forEach(model -> { + assertFalse(model.id().isBlank()); + assertFalse(model.name().isBlank()); + }); + } + } + + @Test + void testShouldCallRpcAccountGetQuotaWhenAuthenticated() throws Exception { + ctx.configureForTest("rpc_server", "should_call_rpc_account_get_quota_when_authenticated"); + var token = "rpc-quota-token"; + configureAuthenticatedUser(token, Map.of("chat", Map.of("entitlement", 100, "overage_count", 2, + "overage_permitted", true, "percent_remaining", 75, "timestamp_utc", "2026-04-30T00:00:00Z"))); + + try (var client = createAuthenticatedClient(token)) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + var result = client.getRpc().account.getQuota().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertNotNull(result.quotaSnapshots()); + var chatQuota = result.quotaSnapshots().get("chat"); + assertNotNull(chatQuota); + assertQuota(chatQuota); + } + } + + @Test + void testShouldCallRpcToolsListWithTypedResult() throws Exception { + ctx.configureForTest("rpc_server", "should_call_rpc_tools_list_with_typed_result"); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + var result = client.getRpc().tools.list(new ToolsListParams(null)).get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertNotNull(result.tools()); + assertFalse(result.tools().isEmpty()); + result.tools().forEach(tool -> assertFalse(tool.name().isBlank())); + } + } + + @Test + void testShouldCallRpcSessionFsSetProviderWithTypedResult() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + var result = client.getRpc().sessionFs + .setProvider(new SessionFsSetProviderParams(ctx.getWorkDir().toString(), + ctx.getWorkDir().resolve("session-state").toString(), currentPathConventions(), + new SessionFsSetProviderCapabilities(true))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertTrue(result.success()); + } + } + + @Test + void testShouldAddSecretFilterValues() throws Exception { + ctx.initializeProxy(); + var env = new HashMap<>(ctx.getEnvironment()); + env.put("COPILOT_ENABLE_SECRET_FILTERING", "true"); + + try (var client = ctx.createClient(new CopilotClientOptions().setEnvironment(env))) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var secret = "rpc-secret-" + UUID.randomUUID().toString().replace("-", ""); + + var result = client.getRpc().secrets.addFilterValues(new SecretsAddFilterValuesParams(List.of(secret))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertTrue(result.ok()); + } + } + + @Test + void testShouldListFindAndInspectPersistedSessionState() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + var requestedSessionId = UUID.randomUUID().toString(); + var workingDirectory = createUniqueWorkDirectory("server-rpc-list"); + var missingTaskId = "missing-task-" + UUID.randomUUID().toString().replace("-", ""); + var missingSessionId = UUID.randomUUID().toString(); + + try (var session = client.createSession(persistedSessionConfig(requestedSessionId, workingDirectory)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + var sessionId = session.getSessionId(); + session.log("SERVER_RPC_LIST_READY").get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + saveSession(client, sessionId); + assertNull(client.getRpc().sessions.close(new SessionsCloseParams(sessionId)).get(TIMEOUT_SECONDS, + TimeUnit.SECONDS)); + + var listed = client.getRpc().sessions.list().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(listed.sessions()); + + var byPrefix = client.getRpc().sessions + .findByPrefix(new SessionsFindByPrefixParams(sessionId.substring(0, 8))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertTrue(byPrefix.sessionId() == null || sessionId.equals(byPrefix.sessionId())); + + var byTaskId = client.getRpc().sessions.findByTaskId(new SessionsFindByTaskIdParams(missingTaskId)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNull(byTaskId.sessionId()); + + var lastForContext = client.getRpc().sessions + .getLastForContext(new SessionsGetLastForContextParams( + new SessionContext(workingDirectory.toString(), null, null, null, null))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertTrue(lastForContext.sessionId() == null || sessionId.equals(lastForContext.sessionId())); + + var eventFile = client.getRpc().sessions.getEventFilePath(new SessionsGetEventFilePathParams(sessionId)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertTrue(eventFile.filePath().endsWith("events.jsonl")); + + var remoteSteerable = client.getRpc().sessions + .getPersistedRemoteSteerable(new SessionsGetPersistedRemoteSteerableParams(sessionId)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNull(remoteSteerable.remoteSteerable()); + + var sizes = client.getRpc().sessions.getSizes().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(sizes.sizes()); + if (sizes.sizes().containsKey(sessionId)) { + assertTrue(sizes.sizes().get(sessionId) >= 0); + } + + var inUse = client.getRpc().sessions + .checkInUse(new SessionsCheckInUseParams(List.of(sessionId, missingSessionId))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(inUse.inUse()); + assertFalse(inUse.inUse().contains(missingSessionId)); + } + } + } + + @Test + void testShouldEnrichBasicSessionMetadata() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + var requestedSessionId = UUID.randomUUID().toString(); + var workingDirectory = createUniqueWorkDirectory("server-rpc-enrich"); + + try (var session = client.createSession(persistedSessionConfig(requestedSessionId, workingDirectory)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + var sessionId = session.getSessionId(); + session.log("SERVER_RPC_ENRICH_READY").get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + saveSession(client, sessionId); + + var now = OffsetDateTime.now().toString(); + var basic = new LocalSessionMetadataValue(sessionId, now, now, null, "Basic metadata", null, false, + null, new SessionContext(workingDirectory.toString(), null, null, null, null), null); + + var result = client.getRpc().sessions.enrichMetadata(new SessionsEnrichMetadataParams(List.of(basic))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + + assertNotNull(result.sessions()); + assertEquals(1, result.sessions().size()); + var enriched = result.sessions().get(0); + assertEquals(sessionId, enriched.sessionId()); + assertNotNull(enriched.context()); + assertTrue(pathsEqual(workingDirectory.toString(), enriched.context().cwd())); + assertFalse(enriched.isRemote()); + } + } + } + + @Test + void testShouldCloseActiveSessionAndReleaseLock() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + var requestedSessionId = UUID.randomUUID().toString(); + var workingDirectory = createUniqueWorkDirectory("server-rpc-close"); + + try (var session = client.createSession(persistedSessionConfig(requestedSessionId, workingDirectory)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + var sessionId = session.getSessionId(); + session.log("SERVER_RPC_CLOSE_READY").get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + saveSession(client, sessionId); + + var close = client.getRpc().sessions.close(new SessionsCloseParams(sessionId)).get(TIMEOUT_SECONDS, + TimeUnit.SECONDS); + assertNull(close); + + var release = client.getRpc().sessions.releaseLock(new SessionsReleaseLockParams(sessionId)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNull(release); + + var inUse = client.getRpc().sessions.checkInUse(new SessionsCheckInUseParams(List.of(sessionId))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertFalse(inUse.inUse().contains(sessionId)); + } + } + } + + @Test + void testShouldPruneDryRunAndBulkDeletePersistedSession() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + var requestedSessionId = UUID.randomUUID().toString(); + var missingSessionId = UUID.randomUUID().toString(); + var workingDirectory = createUniqueWorkDirectory("server-rpc-delete"); + + var session = client.createSession(persistedSessionConfig(requestedSessionId, workingDirectory)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + try { + var sessionId = session.getSessionId(); + saveSession(client, sessionId); + client.getRpc().sessions.close(new SessionsCloseParams(sessionId)).get(TIMEOUT_SECONDS, + TimeUnit.SECONDS); + + var prune = client.getRpc().sessions.pruneOld(new SessionsPruneOldParams(0L, true, true, List.of())) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertTrue(prune.dryRun()); + assertNotNull(prune.candidates()); + assertNotNull(prune.deleted()); + assertFalse(prune.deleted().contains(sessionId)); + assertFalse(prune.candidates().contains(missingSessionId)); + assertNotNull(prune.freedBytes()); + assertTrue(prune.freedBytes() >= 0); + + var delete = client.getRpc().sessions + .bulkDelete(new SessionsBulkDeleteParams(List.of(sessionId, missingSessionId))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertTrue(delete.freedBytes().containsKey(sessionId)); + assertTrue(delete.freedBytes().get(sessionId) >= 0); + if (delete.freedBytes().containsKey(missingSessionId)) { + assertEquals(0L, delete.freedBytes().get(missingSessionId)); + } + + waitForSessionAbsent(client, sessionId); + } finally { + session.close(); + } + } + } + + @Test + void testShouldSetAdditionalPluginsAndReloadDeferredHooks() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNull(client.getRpc().sessions.setAdditionalPlugins(new SessionsSetAdditionalPluginsParams(List.of())) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS)); + + var requestedSessionId = UUID.randomUUID().toString(); + var workingDirectory = createUniqueWorkDirectory("server-rpc-hooks"); + + try (var session = client.createSession( + persistedSessionConfig(requestedSessionId, workingDirectory).setEnableConfigDiscovery(false)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + var sessionId = session.getSessionId(); + var reload = client.getRpc().sessions + .reloadPluginHooks(new SessionsReloadPluginHooksParams(sessionId, true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNull(reload); + + var loaded = client.getRpc().sessions + .loadDeferredRepoHooks(new SessionsLoadDeferredRepoHooksParams(sessionId)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(loaded.startupPrompts()); + assertEquals(0L, loaded.hookCount()); + assertTrue(loaded.startupPrompts().isEmpty()); + } finally { + client.getRpc().sessions.setAdditionalPlugins(new SessionsSetAdditionalPluginsParams(List.of())) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + } + } + } + + @Test + void testShouldReportImplementedErrorWhenConnectingUnknownRemoteSession() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var remoteSessionId = "remote-" + UUID.randomUUID().toString().replace("-", ""); + + var ex = assertThrows(Exception.class, () -> client.getRpc().sessions + .connect(new SessionsConnectParams(remoteSessionId)).get(TIMEOUT_SECONDS, TimeUnit.SECONDS)); + var text = ex.toString(); + assertFalse(text.toLowerCase().contains("unhandled method sessions.connect")); + assertTrue(text.toLowerCase().contains("session")); + } + } + + @Test + void testShouldDiscoverServerMcpSkillsAgentsAndInstructions() throws Exception { + ctx.configureForTest("rpc_server", "should_discover_server_mcp_and_skills"); + + try (var client = ctx.createClient()) { + client.start().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var workDir = ctx.getWorkDir().toString(); + var skillName = "server-rpc-skill-" + UUID.randomUUID().toString().replace("-", ""); + var skillDirectory = createSkillDirectory(skillName, "Skill discovered by server-scoped RPC tests."); + + var mcp = client.getRpc().mcp.discover(new McpDiscoverParams(workDir)).get(TIMEOUT_SECONDS, + TimeUnit.SECONDS); + assertNotNull(mcp.servers()); + + var skills = client.getRpc().skills + .discover(new SkillsDiscoverParams(null, List.of(skillDirectory.toString()), null)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var discoveredSkill = findSkill(skills.skills(), skillName); + assertEquals("Skill discovered by server-scoped RPC tests.", discoveredSkill.description()); + assertTrue(discoveredSkill.enabled()); + assertTrue(discoveredSkill.path().replace('\\', '/').endsWith(skillName + "/SKILL.md")); + + var skillPaths = client.getRpc().skills + .getDiscoveryPaths(new SkillsGetDiscoveryPathsParams(List.of(workDir), true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var projectSkillPath = skillPaths.paths().stream().filter( + path -> pathsEqual(workDir, path.projectPath()) && Boolean.TRUE.equals(path.preferredForCreation())) + .findFirst().orElseThrow(() -> new AssertionError("Expected project skill discovery path")); + assertFalse(projectSkillPath.path().isBlank()); + + var agents = client.getRpc().agents.discover(new AgentsDiscoverParams(List.of(workDir), true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(agents.agents()); + agents.agents().forEach(agent -> assertFalse(agent.name().isBlank())); + + var agentPaths = client.getRpc().agents + .getDiscoveryPaths(new AgentsGetDiscoveryPathsParams(List.of(workDir), true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var projectAgentPath = agentPaths.paths().stream().filter( + path -> pathsEqual(workDir, path.projectPath()) && Boolean.TRUE.equals(path.preferredForCreation())) + .findFirst().orElseThrow(() -> new AssertionError("Expected project agent discovery path")); + assertFalse(projectAgentPath.path().isBlank()); + + var instructions = client.getRpc().instructions + .discover(new InstructionsDiscoverParams(List.of(workDir), true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(instructions.sources()); + instructions.sources().forEach(source -> { + assertFalse(source.id().isBlank()); + assertFalse(source.label().isBlank()); + assertFalse(source.sourcePath().isBlank()); + }); + + var instructionPaths = client.getRpc().instructions + .getDiscoveryPaths(new InstructionsGetDiscoveryPathsParams(List.of(workDir), true)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertFalse(instructionPaths.paths().isEmpty()); + assertTrue(instructionPaths.paths().stream().anyMatch(path -> pathsEqual(workDir, path.projectPath()))); + instructionPaths.paths().forEach(path -> assertFalse(path.path().isBlank())); + + try { + client.getRpc().skills.config + .setDisabledSkills(new SkillsConfigSetDisabledSkillsParams(List.of(skillName))) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var disabledSkills = client.getRpc().skills + .discover(new SkillsDiscoverParams(null, List.of(skillDirectory.toString()), null)) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + var disabledSkill = findSkill(disabledSkills.skills(), skillName); + assertFalse(disabledSkill.enabled()); + } finally { + client.getRpc().skills.config.setDisabledSkills(new SkillsConfigSetDisabledSkillsParams(List.of())) + .get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + } + } + } + + private static CopilotClient createAuthenticatedClient(String token) throws Exception { + return ctx.createClient(new CopilotClientOptions().setGitHubToken(token)); + } + + private static void configureAuthenticatedUser(String token, Map quotaSnapshots) throws Exception { + var user = new HashMap(); + user.put("login", "rpc-user"); + user.put("copilot_plan", "individual_pro"); + user.put("endpoints", Map.of("api", ctx.getProxyUrl(), "telemetry", "https://localhost:1/telemetry")); + user.put("analytics_tracking_id", "rpc-user-tracking-id"); + if (quotaSnapshots != null) { + user.put("quota_snapshots", quotaSnapshots); + } + ctx.setCopilotUserByToken(token, user); + } + + private static void assertQuota(AccountQuotaSnapshot chatQuota) { + assertEquals(100L, chatQuota.entitlementRequests()); + assertEquals(25L, chatQuota.usedRequests()); + assertEquals(75.0, chatQuota.remainingPercentage()); + assertEquals(2.0, chatQuota.overage()); + assertTrue(chatQuota.usageAllowedWithExhaustedQuota()); + assertTrue(chatQuota.overageAllowedWithExhaustedQuota()); + assertEquals(OffsetDateTime.parse("2026-04-30T00:00:00Z"), chatQuota.resetDate()); + } + + private static SessionFsSetProviderConventions currentPathConventions() { + return isWindows() ? SessionFsSetProviderConventions.WINDOWS : SessionFsSetProviderConventions.POSIX; + } + + private static Path createUniqueWorkDirectory(String prefix) throws Exception { + var directory = ctx.getWorkDir().resolve(prefix + "-" + UUID.randomUUID().toString().replace("-", "")); + Files.createDirectories(directory); + return directory; + } + + private static SessionConfig persistedSessionConfig(String sessionId, Path workingDirectory) { + return new SessionConfig().setSessionId(sessionId).setWorkingDirectory(workingDirectory.toString()) + .setInfiniteSessions(new InfiniteSessionConfig().setEnabled(true)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL); + } + + private static void saveSession(CopilotClient client, String sessionId) throws Exception { + var save = client.getRpc().sessions.save(new SessionsSaveParams(sessionId)).get(TIMEOUT_SECONDS, + TimeUnit.SECONDS); + assertNull(save); + } + + private static void waitForSessionAbsent(CopilotClient client, String sessionId) throws Exception { + var deadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(SESSION_PERSISTENCE_TIMEOUT_MILLIS); + do { + var list = client.getRpc().sessions.list().get(TIMEOUT_SECONDS, TimeUnit.SECONDS); + assertNotNull(list.sessions()); + var present = list.sessions().stream() + .anyMatch(session -> session instanceof Map map && sessionId.equals(map.get("sessionId"))); + if (!present) { + return; + } + Thread.sleep(100); + } while (System.nanoTime() < deadline); + + throw new AssertionError("Timed out waiting for session '" + sessionId + "' to be removed."); + } + + private static Path createSkillDirectory(String skillName, String description) throws Exception { + var skillsDir = ctx.getWorkDir().resolve("server-rpc-skills") + .resolve(UUID.randomUUID().toString().replace("-", "")); + var skillSubdir = skillsDir.resolve(skillName); + Files.createDirectories(skillSubdir); + Files.writeString(skillSubdir.resolve("SKILL.md"), "---\nname: " + skillName + "\ndescription: " + description + + "\n---\n\n# " + skillName + "\n\nThis skill is used by RPC E2E tests.\n"); + return skillsDir; + } + + private static ServerSkill findSkill(List skills, String name) { + return skills.stream().filter(skill -> name.equals(skill.name())).findFirst() + .orElseThrow(() -> new AssertionError("Expected to discover skill " + name)); + } + + private static boolean pathsEqual(String expected, String actual) { + if (actual == null) { + return false; + } + + var expectedPath = Path.of(expected).toAbsolutePath().normalize().toString(); + var actualPath = Path.of(actual).toAbsolutePath().normalize().toString(); + return isWindows() ? expectedPath.equalsIgnoreCase(actualPath) : expectedPath.equals(actualPath); + } + + private static boolean isWindows() { + return System.getProperty("os.name").toLowerCase().contains("win"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java new file mode 100644 index 000000000..1db801d84 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/RpcServerMiscE2ETest.java @@ -0,0 +1,132 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.AccountAllUsers; +import com.github.copilot.generated.rpc.AccountLoginParams; +import com.github.copilot.generated.rpc.AccountLogoutParams; +import com.github.copilot.generated.rpc.UserSettingMetadata; +import com.github.copilot.generated.rpc.UserSettingsSetParams; +import com.github.copilot.rpc.CopilotClientOptions; + +class RpcServerMiscE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldGetSetAndClearUserSettings() throws Exception { + ctx.configureForTest("rpc_server_misc", "should_get_set_and_clear_user_settings"); + + try (var client = ctx.createClient()) { + client.start().get(30, TimeUnit.SECONDS); + var before = client.getRpc().user.settings.get().get(30, TimeUnit.SECONDS); + var entry = before.settings().entrySet().stream().filter(e -> isBooleanSetting(e.getValue())).findFirst() + .orElseThrow(() -> new AssertionError("Expected at least one boolean user setting")); + var key = entry.getKey(); + var original = settingBoolean(entry.getValue()); + var updated = !original; + + var set = client.getRpc().user.settings.set(new UserSettingsSetParams(Map.of(key, updated))).get(30, + TimeUnit.SECONDS); + assertTrue(set.shadowedKeys().isEmpty()); + client.getRpc().user.settings.reload().get(30, TimeUnit.SECONDS); + var afterSet = client.getRpc().user.settings.get().get(30, TimeUnit.SECONDS); + assertEquals(updated, settingBoolean(afterSet.settings().get(key))); + assertFalse(afterSet.settings().get(key).isDefault()); + + var clearSettings = new HashMap(); + clearSettings.put(key, null); + var clear = client.getRpc().user.settings.set(new UserSettingsSetParams(clearSettings)).get(30, + TimeUnit.SECONDS); + assertTrue(clear.shadowedKeys().isEmpty()); + client.getRpc().user.settings.reload().get(30, TimeUnit.SECONDS); + var afterClear = client.getRpc().user.settings.get().get(30, TimeUnit.SECONDS); + assertTrue(afterClear.settings().get(key).isDefault()); + } + } + + @Test + void testShouldLoginListGetCurrentAuthAndLogoutAccount() throws Exception { + ctx.configureForTest("rpc_server_misc", "should_login_list_getcurrentauth_and_logout_account"); + var token = "java-account-token"; + var login = "java-account-user"; + ctx.setCopilotUserByToken(token, login, "individual_pro", ctx.getProxyUrl(), "https://localhost:1/telemetry", + "java-account-tracking-id"); + + var env = new HashMap<>(ctx.getEnvironment()); + env.put("GH_TOKEN", ""); + env.put("GITHUB_TOKEN", ""); + env.put("COPILOT_SDK_AUTH_TOKEN", ""); + + try (var client = new CopilotClient( + new CopilotClientOptions().setCliPath(ctx.getCliPath()).setCwd(ctx.getWorkDir().toString()) + .setEnvironment(env).setGitHubToken("").setUseLoggedInUser(false))) { + client.start().get(30, TimeUnit.SECONDS); + + var initial = client.getRpc().account.getCurrentAuth().get(30, TimeUnit.SECONDS); + assertNull(initial.authInfo()); + + var loginResult = client.getRpc().account.login(new AccountLoginParams("https://github.com", login, token)) + .get(30, TimeUnit.SECONDS); + assertNotNull(loginResult); + + var current = client.getRpc().account.getCurrentAuth().get(30, TimeUnit.SECONDS); + assertNull(current.authErrors()); + assertInstanceOf(Map.class, current.authInfo()); + @SuppressWarnings("unchecked") + var authInfo = (Map) current.authInfo(); + assertEquals(login, authInfo.get("login")); + assertEquals("https://github.com", authInfo.get("host")); + + var users = client.getRpc().account.getAllUsers().get(30, TimeUnit.SECONDS); + users.stream().filter(user -> accountLogin(user).equals(login)).findFirst() + .ifPresent(user -> assertEquals(token, user.token())); + + var logout = client.getRpc().account.logout(new AccountLogoutParams(authInfo)).get(30, TimeUnit.SECONDS); + assertFalse(logout.hasMoreUsers()); + assertNull(client.getRpc().account.getCurrentAuth().get(30, TimeUnit.SECONDS).authInfo()); + } + } + + private static boolean isBooleanSetting(UserSettingMetadata metadata) { + return metadata.value() instanceof Boolean || metadata.default_() instanceof Boolean; + } + + private static boolean settingBoolean(UserSettingMetadata metadata) { + if (metadata.value() instanceof Boolean value) { + return value; + } + return (Boolean) metadata.default_(); + } + + private static String accountLogin(AccountAllUsers user) { + if (user.authInfo() instanceof Map authInfo) { + return String.valueOf(authInfo.get("login")); + } + return ""; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java new file mode 100644 index 000000000..5022d2a56 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/RpcSessionStateExtrasE2ETest.java @@ -0,0 +1,155 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.NamedProviderConfig; +import com.github.copilot.generated.rpc.ProviderConfigType; +import com.github.copilot.generated.rpc.ProviderConfigWireApi; +import com.github.copilot.generated.rpc.ProviderModelConfig; +import com.github.copilot.generated.rpc.SessionCompletionsRequestParams; +import com.github.copilot.generated.rpc.SessionMetadataGetContextHeaviestMessagesParams; +import com.github.copilot.generated.rpc.SessionModelSwitchToParams; +import com.github.copilot.generated.rpc.SessionProviderAddParams; +import com.github.copilot.generated.rpc.SessionToolsUpdateSubagentSettingsParams; +import com.github.copilot.generated.rpc.SessionVisibilitySetParams; +import com.github.copilot.generated.rpc.SessionVisibilityStatus; +import com.github.copilot.generated.rpc.SubagentSettingsEntry; +import com.github.copilot.generated.rpc.SubagentSettingsEntryContextTier; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +class RpcSessionStateExtrasE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldAddByokProviderAndModelAtRuntime() throws Exception { + ctx.configureForTest("rpc_session_state_extras", "should_add_byok_provider_and_model_at_runtime"); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + var result = session.getRpc().provider.add(new SessionProviderAddParams(null, + List.of(new NamedProviderConfig("java-e2e-provider", ProviderConfigType.OPENAI, + ProviderConfigWireApi.COMPLETIONS, null, "https://models.example.test/v1", + "provider-key", null, null, Map.of("x-provider", "java"), null)), + List.of(new ProviderModelConfig("small", "java-e2e-provider", null, null, "Java Added Model", + 4096.0, null, null, null)))) + .get(30, TimeUnit.SECONDS); + assertEquals(1, result.models().size()); + + var selectionId = "java-e2e-provider/small"; + session.getRpc().model + .switchTo(new SessionModelSwitchToParams(null, selectionId, null, null, null, null, null, null)) + .get(30, TimeUnit.SECONDS); + var current = session.getRpc().model.getCurrent().get(30, TimeUnit.SECONDS); + assertEquals(selectionId, current.modelId()); + } + } + } + + @Test + void testShouldReturnEmptyCompletionsWhenHostDoesNotProvideThem() throws Exception { + ctx.configureForTest("rpc_session_state_extras", + "should_return_empty_completions_when_host_does_not_provide_them"); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + var result = session.getRpc().completions + .request(new SessionCompletionsRequestParams(null, "Use @ to mention context", 5L)) + .get(30, TimeUnit.SECONDS); + assertTrue(result.items().isEmpty()); + } + } + } + + @Test + void testShouldReportVisibilityAsUnsyncedForLocalSession() throws Exception { + ctx.configureForTest("rpc_session_state_extras", "should_report_visibility_as_unsynced_for_local_session"); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + var set = session.getRpc().visibility + .set(new SessionVisibilitySetParams(null, SessionVisibilityStatus.UNSHARED)) + .get(30, TimeUnit.SECONDS); + assertFalse(set.synced()); + assertNull(set.status()); + assertNull(set.shareUrl()); + + var get = session.getRpc().visibility.get().get(30, TimeUnit.SECONDS); + assertFalse(get.synced()); + assertNull(get.status()); + assertNull(get.shareUrl()); + } + } + } + + @Test + void testShouldGetContextAttributionAndHeaviestMessagesAfterTurn() throws Exception { + ctx.configureForTest("rpc_session_state_extras", + "should_get_context_attribution_and_heaviest_messages_after_turn"); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + var answer = session.sendAndWait(new MessageOptions().setPrompt("Say CONTEXT_METADATA_OK exactly.")) + .get(60, TimeUnit.SECONDS); + assertTrue(answer.getData().content().contains("CONTEXT_METADATA_OK")); + + var attribution = session.getRpc().metadata.getContextAttribution().get(30, TimeUnit.SECONDS); + assertNotNull(attribution.contextAttribution()); + var heaviest = session.getRpc().metadata + .getContextHeaviestMessages(new SessionMetadataGetContextHeaviestMessagesParams(null, 5L)) + .get(30, TimeUnit.SECONDS); + assertTrue(heaviest.totalTokens() >= 0); + } + } + } + + @Test + void testShouldUpdateAndClearLiveSubagentSettings() throws Exception { + ctx.configureForTest("rpc_session_state_extras", "should_update_and_clear_live_subagent_settings"); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + session.getRpc().tools.updateSubagentSettings(new SessionToolsUpdateSubagentSettingsParams(null, + new SessionToolsUpdateSubagentSettingsParams.SessionToolsUpdateSubagentSettingsParamsSubagents( + Map.of("general-purpose", + new SubagentSettingsEntry("gpt-5-mini", "low", + SubagentSettingsEntryContextTier.LONG_CONTEXT)), + List.of("legacy-agent"), null, null))) + .get(30, TimeUnit.SECONDS); + session.getRpc().tools.updateSubagentSettings(new SessionToolsUpdateSubagentSettingsParams(null, null)) + .get(30, TimeUnit.SECONDS); + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java b/java/sdk/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java new file mode 100644 index 000000000..89b283339 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/RpcTasksAndHandlersE2ETest.java @@ -0,0 +1,72 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.SessionMcpHeadersHandlePendingHeadersRefreshRequestParams; +import com.github.copilot.generated.rpc.SessionUiHandlePendingSessionLimitsExhaustedParams; +import com.github.copilot.generated.rpc.UISessionLimitsExhaustedResponse; +import com.github.copilot.generated.rpc.UISessionLimitsExhaustedResponseAction; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +class RpcTasksAndHandlersE2ETest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldReturnExpectedResultsForMissingPendingHandlerRequestIds() throws Exception { + ctx.initializeProxy(); + + try (var client = ctx.createClient()) { + try (var session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get()) { + var sessionLimits = session.getRpc().ui + .handlePendingSessionLimitsExhausted( + new SessionUiHandlePendingSessionLimitsExhaustedParams(null, + "missing-session-limits-request", + new UISessionLimitsExhaustedResponse( + UISessionLimitsExhaustedResponseAction.UNSET, null, null))) + .get(30, TimeUnit.SECONDS); + assertFalse(sessionLimits.success()); + + var headersRefresh = session.getRpc().mcp.headers + .handlePendingHeadersRefreshRequest( + new SessionMcpHeadersHandlePendingHeadersRefreshRequestParams(null, + "missing-headers-refresh-request", + Map.of("kind", "headers", "headers", Map.of("x-refresh", "missing")))) + .get(30, TimeUnit.SECONDS); + assertFalse(headersRefresh.success()); + + var noHeadersRefresh = session.getRpc().mcp.headers + .handlePendingHeadersRefreshRequest( + new SessionMcpHeadersHandlePendingHeadersRefreshRequestParams(null, + "missing-headers-refresh-none-request", Map.of("kind", "none"))) + .get(30, TimeUnit.SECONDS); + assertFalse(noHeadersRefresh.success()); + } + } + } +} diff --git a/java/src/test/java/com/github/copilot/RpcWrappersTest.java b/java/sdk/src/test/java/com/github/copilot/RpcWrappersTest.java similarity index 84% rename from java/src/test/java/com/github/copilot/RpcWrappersTest.java rename to java/sdk/src/test/java/com/github/copilot/RpcWrappersTest.java index 7b01e1d38..1f1785cba 100644 --- a/java/src/test/java/com/github/copilot/RpcWrappersTest.java +++ b/java/sdk/src/test/java/com/github/copilot/RpcWrappersTest.java @@ -85,6 +85,28 @@ void serverRpc_models_list_invokes_correct_rpc_method() { assertEquals("models.list", stub.calls.get(0).method()); } + @Test + void serverRpc_account_getAllUsers_returns_typed_list() throws Exception { + var stub = new StubCaller(); + stub.nextResult = new ObjectMapper().readTree(""" + [ + { + "authInfo": { "kind": "oauth" }, + "token": "token-1" + } + ] + """); + + var server = new ServerRpc(stub); + var users = server.account.getAllUsers().get(); + + assertEquals(1, stub.calls.size()); + assertEquals("account.getAllUsers", stub.calls.get(0).method()); + assertEquals(1, users.size()); + assertInstanceOf(Map.class, users.get(0).authInfo()); + assertEquals("token-1", users.get(0).token()); + } + @Test void serverRpc_ping_passes_params_directly() { var stub = new StubCaller(); @@ -183,7 +205,7 @@ void sessionRpc_model_switchTo_merges_sessionId_with_extra_params() { var session = new SessionRpc(stub, "sess-xyz"); // switchTo takes extra params beyond sessionId - var switchParams = new SessionModelSwitchToParams(null, "gpt-5", null, null, null); + var switchParams = new SessionModelSwitchToParams(null, "gpt-5", null, null, null, null, null, null); session.model.switchTo(switchParams); assertEquals(1, stub.calls.size()); @@ -208,8 +230,8 @@ void sessionRpc_agent_list_injects_sessionId() { assertEquals("session.agent.list", stub.calls.get(0).method()); var params = stub.calls.get(0).params(); - assertInstanceOf(Map.class, params); - assertEquals("sess-999", ((Map) params).get("sessionId")); + assertInstanceOf(com.fasterxml.jackson.databind.node.ObjectNode.class, params); + assertEquals("sess-999", ((com.fasterxml.jackson.databind.node.ObjectNode) params).get("sessionId").asText()); } @Test @@ -389,6 +411,56 @@ void copilotClient_getRpc_throws_before_start() { "getRpc() must throw IllegalStateException if called before start()"); } + // ── session.mcp.apps.callTool tests ─────────────────────────────────────── + + @Test + void sessionRpc_mcp_apps_callTool_invokes_correct_rpc_method() { + var stub = new StubCaller(); + var session = new SessionRpc(stub, "sess-mcp"); + + var params = new com.github.copilot.generated.rpc.SessionMcpAppsCallToolParams(null, "my-server", "my-tool", + null, null); + session.mcp.apps.callTool(params); + + assertEquals(1, stub.calls.size()); + assertEquals("session.mcp.apps.callTool", stub.calls.get(0).method()); + } + + @Test + void sessionRpc_mcp_apps_callTool_injects_sessionId() { + var stub = new StubCaller(); + var session = new SessionRpc(stub, "sess-ct-inject"); + + var params = new com.github.copilot.generated.rpc.SessionMcpAppsCallToolParams(null, "server1", "tool1", null, + null); + session.mcp.apps.callTool(params); + + var sentParams = stub.calls.get(0).params(); + assertInstanceOf(com.fasterxml.jackson.databind.node.ObjectNode.class, sentParams); + var node = (com.fasterxml.jackson.databind.node.ObjectNode) sentParams; + assertEquals("sess-ct-inject", node.get("sessionId").asText()); + } + + @Test + void sessionRpc_mcp_apps_callTool_returns_jsonNode_payload() throws Exception { + var stub = new StubCaller(); + var mapper = new ObjectMapper(); + var expectedResult = mapper.createObjectNode(); + expectedResult.put("content", "hello world"); + expectedResult.put("isError", false); + stub.nextResult = expectedResult; + + var session = new SessionRpc(stub, "sess-payload"); + var params = new com.github.copilot.generated.rpc.SessionMcpAppsCallToolParams(null, "echo-server", "echo", + null, null); + var future = session.mcp.apps.callTool(params); + + var result = future.get(); + assertInstanceOf(com.fasterxml.jackson.databind.JsonNode.class, result); + assertEquals("hello world", result.get("content").asText()); + assertEquals(false, result.get("isError").asBoolean()); + } + /** * Helper that creates a loopback socket pair. The client side is used by * {@link JsonRpcClient}; the server side can be read to inspect outbound diff --git a/java/src/test/java/com/github/copilot/SchedulerShutdownRaceTest.java b/java/sdk/src/test/java/com/github/copilot/SchedulerShutdownRaceTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SchedulerShutdownRaceTest.java rename to java/sdk/src/test/java/com/github/copilot/SchedulerShutdownRaceTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java b/java/sdk/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java new file mode 100644 index 000000000..f50138b3b --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SessionCanvasSnapshotTest.java @@ -0,0 +1,208 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.SessionCanvasClosedEvent; +import com.github.copilot.generated.SessionCanvasClosedEvent.SessionCanvasClosedEventData; +import com.github.copilot.generated.SessionCanvasOpenedEvent; +import com.github.copilot.generated.SessionCanvasOpenedEvent.SessionCanvasOpenedEventData; +import com.github.copilot.generated.rpc.OpenCanvasInstance; +import com.github.copilot.rpc.CreateSessionResponse; +import com.github.copilot.rpc.ResumeSessionResponse; + +/** + * Unit tests for the in-memory open-canvases snapshot maintained by + * {@link CopilotSession}. + *

+ * These are pure unit tests that don't require the Copilot CLI. They drive the + * package-private {@code dispatchEvent} hook directly and assert the resulting + * snapshot exposed by {@link CopilotSession#getOpenCanvases()}. + */ +public class SessionCanvasSnapshotTest { + + private CopilotSession session; + + @BeforeEach + void setup() throws Exception { + var constructor = CopilotSession.class.getDeclaredConstructor(String.class, JsonRpcClient.class, String.class); + constructor.setAccessible(true); + session = constructor.newInstance("test-session-id", null, null); + } + + @Test + void startsEmpty() { + assertTrue(session.getOpenCanvases().isEmpty()); + } + + @Test + void openedUpsertsCanvases() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + session.dispatchEvent(openedEvent("inst-2", "canvas-b")); + + var canvases = session.getOpenCanvases(); + assertEquals(2, canvases.size()); + assertEquals(List.of("inst-1", "inst-2"), canvases.stream().map(OpenCanvasInstance::instanceId).toList()); + } + + @Test + void closedRemovesMatchingCanvas() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + session.dispatchEvent(openedEvent("inst-2", "canvas-b")); + + session.dispatchEvent(closedEvent("inst-1")); + + var canvases = session.getOpenCanvases(); + assertEquals(1, canvases.size()); + assertEquals("inst-2", canvases.get(0).instanceId()); + } + + @Test + void closedForAbsentInstanceIsNoOp() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + session.dispatchEvent(closedEvent("does-not-exist")); + + var canvases = session.getOpenCanvases(); + assertEquals(1, canvases.size()); + assertEquals("inst-1", canvases.get(0).instanceId()); + } + + @Test + void closedWithEmptyInstanceIdIsNoOp() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + session.dispatchEvent(closedEvent("")); + session.dispatchEvent(closedEvent(null)); + + var canvases = session.getOpenCanvases(); + assertEquals(1, canvases.size()); + assertEquals("inst-1", canvases.get(0).instanceId()); + } + + @Test + void openedWithMissingRequiredFieldsIsIgnored() { + session.dispatchEvent(openedEvent("", "canvas-a")); + session.dispatchEvent(openedEvent("inst-1", "")); + + assertTrue(session.getOpenCanvases().isEmpty()); + } + + @Test + void reemitReplacesInsteadOfDuplicating() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + // Provider re-emits the same instance id; it should replace, not duplicate. + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + var canvases = session.getOpenCanvases(); + assertEquals(1, canvases.size()); + assertEquals("inst-1", canvases.get(0).instanceId()); + } + + @Test + void getOpenCanvasesReturnsImmutableCopy() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + var canvases = session.getOpenCanvases(); + assertThrows(UnsupportedOperationException.class, + () -> canvases.add(new OpenCanvasInstance("x", "ext", null, "c", null, null, null, null, null))); + + // The returned list is a point-in-time snapshot, not a live view: a + // subsequent event must not change the previously-returned list. + session.dispatchEvent(openedEvent("inst-2", "canvas-b")); + assertEquals(1, canvases.size()); + assertEquals("inst-1", canvases.get(0).instanceId()); + + // The session snapshot itself reflects the new event. + assertEquals(2, session.getOpenCanvases().size()); + } + + @Test + void setOpenCanvasesSeedsAndFiltersNulls() { + var seed = new java.util.ArrayList(); + seed.add(new OpenCanvasInstance("inst-1", "ext", null, "canvas-a", null, null, null, null, null)); + seed.add(null); + seed.add(new OpenCanvasInstance("inst-2", "ext", null, "canvas-b", null, null, null, null, null)); + + session.setOpenCanvases(seed); + + var canvases = session.getOpenCanvases(); + assertEquals(2, canvases.size()); + assertEquals(List.of("inst-1", "inst-2"), canvases.stream().map(OpenCanvasInstance::instanceId).toList()); + } + + @Test + void setOpenCanvasesWithNullClears() { + session.dispatchEvent(openedEvent("inst-1", "canvas-a")); + + session.setOpenCanvases(null); + + assertTrue(session.getOpenCanvases().isEmpty()); + } + + @Test + void createSessionResponseDeserializesOpenCanvases() throws Exception { + ObjectMapper mapper = JsonRpcClient.getObjectMapper(); + String json = """ + { + "sessionId": "abc", + "workspacePath": "/tmp/ws", + "capabilities": {}, + "openCanvases": [ + { "instanceId": "inst-1", "extensionId": "ext", "canvasId": "canvas-a" } + ] + } + """; + + CreateSessionResponse response = mapper.readValue(json, CreateSessionResponse.class); + + assertNotNull(response.openCanvases()); + assertEquals(1, response.openCanvases().size()); + assertEquals("inst-1", response.openCanvases().get(0).instanceId()); + } + + @Test + void resumeSessionResponseDeserializesOpenCanvases() throws Exception { + ObjectMapper mapper = JsonRpcClient.getObjectMapper(); + String json = """ + { + "sessionId": "abc", + "openCanvases": [ + { "instanceId": "inst-1", "extensionId": "ext", "canvasId": "canvas-a" } + ] + } + """; + + ResumeSessionResponse response = mapper.readValue(json, ResumeSessionResponse.class); + + assertNotNull(response.openCanvases()); + assertEquals(1, response.openCanvases().size()); + assertEquals("inst-1", response.openCanvases().get(0).instanceId()); + } + + private static SessionCanvasOpenedEvent openedEvent(String instanceId, String canvasId) { + var event = new SessionCanvasOpenedEvent(); + event.setData(new SessionCanvasOpenedEventData(instanceId, "ext-id", "Ext Name", canvasId, null, "Title", "ok", + null, null)); + return event; + } + + private static SessionCanvasClosedEvent closedEvent(String instanceId) { + var event = new SessionCanvasClosedEvent(); + event.setData(new SessionCanvasClosedEventData(instanceId, "ext-id", "canvas-a")); + return event; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/SessionConfigE2ETest.java b/java/sdk/src/test/java/com/github/copilot/SessionConfigE2ETest.java new file mode 100644 index 000000000..925fd6d87 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SessionConfigE2ETest.java @@ -0,0 +1,438 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static com.github.copilot.CopilotRequestTestSupport.SYNTHETIC_TEXT; +import static com.github.copilot.CopilotRequestTestSupport.newLlmClient; +import static com.github.copilot.CopilotRequestTestSupport.setupCapiAuth; +import static org.junit.jupiter.api.Assertions.*; + +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Base64; +import java.util.List; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.SessionLimitsConfig; +import com.github.copilot.rpc.BlobAttachment; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.ProviderConfig; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.SessionConfig; + +/** + * E2E tests for session configuration features. + */ +public class SessionConfigE2ETest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void testShouldApplyInstructionDirectoriesOnCreate() throws Exception { + ctx.configureForTest("session_config", "should_apply_instructiondirectories_on_create"); + + // Set up instruction directory with a custom instruction file + Path projectDir = ctx.getWorkDir().resolve("instruction-create-project"); + Path instructionDir = ctx.getWorkDir().resolve("extra-create-instructions"); + Path instructionFilesDir = instructionDir.resolve(".github").resolve("instructions"); + String sentinel = "JAVA_CREATE_INSTRUCTION_DIRECTORIES_SENTINEL"; + Files.createDirectories(projectDir); + Files.createDirectories(instructionFilesDir); + Files.writeString(instructionFilesDir.resolve("extra.instructions.md"), "Always include " + sentinel + "."); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(new SessionConfig().setWorkingDirectory(projectDir.toString()) + .setInstructionDirectories(List.of(instructionDir.toString())) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(60, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); + String systemMessage = getSystemMessage(exchanges.get(0)); + assertNotNull(systemMessage, "System message should not be null"); + assertTrue(systemMessage.contains(sentinel), + "System message should contain the instruction sentinel: " + sentinel); + } + } + + @Test + void testShouldApplyInstructionDirectoriesOnResume() throws Exception { + ctx.configureForTest("session_config", "should_apply_instructiondirectories_on_resume"); + + // Set up instruction directory with a custom instruction file + Path projectDir = ctx.getWorkDir().resolve("instruction-resume-project"); + Path instructionDir = ctx.getWorkDir().resolve("extra-resume-instructions"); + Path instructionFilesDir = instructionDir.resolve(".github").resolve("instructions"); + String sentinel = "JAVA_RESUME_INSTRUCTION_DIRECTORIES_SENTINEL"; + Files.createDirectories(projectDir); + Files.createDirectories(instructionFilesDir); + Files.writeString(instructionFilesDir.resolve("extra.instructions.md"), "Always include " + sentinel + "."); + + try (CopilotClient client = ctx.createClient()) { + // Create a session first + CopilotSession session1 = client.createSession(new SessionConfig() + .setWorkingDirectory(projectDir.toString()).setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + // Resume with instructionDirectories + CopilotSession session2 = client.resumeSession(session1.getSessionId(), + new ResumeSessionConfig().setWorkingDirectory(projectDir.toString()) + .setInstructionDirectories(List.of(instructionDir.toString())) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + session2.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(60, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); + String systemMessage = getSystemMessage(exchanges.get(0)); + assertNotNull(systemMessage, "System message should not be null"); + assertTrue(systemMessage.contains(sentinel), + "System message should contain the instruction sentinel: " + sentinel); + } + } + + @Test + void testShouldForwardProviderWireModel() throws Exception { + ctx.configureForTest("session_config", "should_forward_provider_wire_model"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setModel("claude-sonnet-4.5") + .setProvider(new ProviderConfig().setType("openai").setBaseUrl(ctx.getProxyUrl()) + .setApiKey("test-provider-key").setWireModel("test-wire-model") + .setMaxOutputTokens(1024)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(30, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); + @SuppressWarnings("unchecked") + Map request = (Map) exchanges.get(0).get("request"); + assertEquals("test-wire-model", request.get("model")); + } + } + + @Test + void testShouldUseProviderModelIdAsWireModel() throws Exception { + ctx.configureForTest("session_config", "should_use_provider_model_id_as_wire_model"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(new SessionConfig() + .setProvider(new ProviderConfig().setType("openai").setBaseUrl(ctx.getProxyUrl()) + .setApiKey("test-provider-key").setModelId("claude-sonnet-4.5")) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(30, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); + @SuppressWarnings("unchecked") + Map request = (Map) exchanges.get(0).get("request"); + assertEquals("claude-sonnet-4.5", request.get("model")); + } + } + + @Test + void testShouldApplySessionLimitsOnCreate() throws Exception { + ctx.configureForTest("session_config", "should_apply_session_limits_on_create"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setSessionLimits(new SessionLimitsConfig(30.0)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + try { + Map exchange = sendAndGetNextExchange(session, + "Acknowledge the current session limits."); + + assertSessionLimitsStatus(exchange, "30 AI credits"); + } finally { + session.close(); + } + } + } + + @Test + void testShouldApplySessionLimitsOnResume() throws Exception { + ctx.configureForTest("session_config", "should_apply_session_limits_on_resume"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session1 = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + CopilotSession session2 = client.resumeSession(session1.getSessionId(), + new ResumeSessionConfig().setSessionLimits(new SessionLimitsConfig(30.0)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + try { + Map exchange = sendAndGetNextExchange(session2, + "Acknowledge the current session limits."); + + assertSessionLimitsStatus(exchange, "30 AI credits"); + } finally { + session2.close(); + session1.close(); + } + } + } + + @Test + void testShouldApplyExcludedBuiltInAgentsOnCreate() throws Exception { + ctx.configureForTest("session_config", "should_apply_excluded_built_in_agents_on_create"); + + final String excludedAgent = "explore"; + final String prompt = "What is 1+1?"; + + try (CopilotClient client = ctx.createClient()) { + CopilotSession baselineSession = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + try { + Map baselineExchange = sendAndGetNextExchange(baselineSession, prompt); + assertTrue(getTaskAgentTypes(baselineExchange).contains(excludedAgent)); + } finally { + baselineSession.close(); + } + + CopilotSession excludedSession = client + .createSession(new SessionConfig().setExcludedBuiltInAgents(List.of(excludedAgent)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + try { + List agentTypes = getTaskAgentTypes(sendAndGetNextExchange(excludedSession, prompt)); + + assertFalse(agentTypes.isEmpty(), "Expected task tool agent types"); + assertFalse(agentTypes.contains(excludedAgent), "Expected excluded built-in agent to be omitted"); + } finally { + excludedSession.close(); + } + } + } + + @Test + void testShouldApplyExcludedBuiltInAgentsOnResume() throws Exception { + ctx.configureForTest("session_config", "should_apply_excluded_built_in_agents_on_resume"); + + final String excludedAgent = "explore"; + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session1 = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + CopilotSession session2 = client.resumeSession(session1.getSessionId(), + new ResumeSessionConfig().setExcludedBuiltInAgents(List.of(excludedAgent)) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + try { + List agentTypes = getTaskAgentTypes(sendAndGetNextExchange(session2, "What is 1+1?")); + + assertFalse(agentTypes.isEmpty(), "Expected task tool agent types"); + assertFalse(agentTypes.contains(excludedAgent), "Expected excluded built-in agent to be omitted"); + } finally { + session2.close(); + session1.close(); + } + } + } + + @Test + void testShouldEnableCitationsForAnthropicFileAttachmentsOnCreate() throws Exception { + setupCapiAuth(ctx); + var handler = new CopilotRequestTestSupport.RecordingRequestHandler(SYNTHETIC_TEXT); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session = client.createSession(new SessionConfig().setModel("claude-sonnet-4.5") + .setEnableCitations(true).setProvider(createAnthropicProvider()) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + try { + session.sendAndWait(new MessageOptions().setPrompt("Summarize the attached PDF with citations enabled.") + .setAttachments(List.of(createPdfAttachment()))).get(60, TimeUnit.SECONDS); + + assertAnthropicDocumentCitationsEnabled(singleInferenceRequestBody(handler)); + } finally { + session.close(); + } + } + } + + @Test + void testShouldEnableCitationsForAnthropicFileAttachmentsOnResume() throws Exception { + setupCapiAuth(ctx); + var handler = new CopilotRequestTestSupport.RecordingRequestHandler(SYNTHETIC_TEXT); + + try (CopilotClient client = newLlmClient(ctx, handler)) { + CopilotSession session1 = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + CopilotSession session2 = client.resumeSession(session1.getSessionId(), + new ResumeSessionConfig().setModel("claude-sonnet-4.5").setEnableCitations(true) + .setProvider(createAnthropicProvider()) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(); + + try { + session2.sendAndWait( + new MessageOptions().setPrompt("Summarize the attached PDF with citations enabled.") + .setAttachments(List.of(createPdfAttachment()))) + .get(60, TimeUnit.SECONDS); + + assertAnthropicDocumentCitationsEnabled(singleInferenceRequestBody(handler)); + } finally { + session2.close(); + session1.close(); + } + } + } + + private Map sendAndGetNextExchange(CopilotSession session, String prompt) throws Exception { + int existingCount = ctx.getExchanges().size(); + session.sendAndWait(new MessageOptions().setPrompt(prompt)).get(60, TimeUnit.SECONDS); + + List> exchanges = ctx.getExchanges(); + assertTrue(exchanges.size() > existingCount, "Expected at least one new exchange"); + return exchanges.get(existingCount); + } + + private static void assertSessionLimitsStatus(Map exchange, String expectedRemaining) { + String content = null; + for (Object message : getRequestMessages(exchange)) { + if (message instanceof Map messageMap && "user".equals(messageMap.get("role"))) { + Object messageContent = messageMap.get("content"); + if (messageContent instanceof String text && text.contains("")) { + content = text; + break; + } + } + } + + assertNotNull(content, "Expected session limits status user message"); + assertTrue(content.contains("Remaining session limits: " + expectedRemaining + ".")); + assertTrue(content.contains("Be frugal; avoid optional exploration and unnecessary tool calls.")); + } + + private static List getTaskAgentTypes(Map exchange) { + Object toolsObj = getRequest(exchange).get("tools"); + assertInstanceOf(List.class, toolsObj, "Expected request tools"); + + JsonNode parameters = null; + for (Object toolObj : (List) toolsObj) { + if (toolObj instanceof Map toolMap && toolMap.get("function") instanceof Map functionMap + && "task".equals(functionMap.get("name"))) { + parameters = MAPPER.valueToTree(functionMap.get("parameters")); + break; + } + } + + assertNotNull(parameters, "Expected task tool parameters"); + JsonNode enumValues = parameters.path("properties").path("agent_type").path("enum"); + assertTrue(enumValues.isArray(), "Expected task agent_type enum"); + + List values = new ArrayList<>(); + enumValues.forEach(value -> { + if (value.isTextual()) { + values.add(value.asText()); + } + }); + return values; + } + + private static List getRequestMessages(Map exchange) { + Object messages = getRequest(exchange).get("messages"); + assertInstanceOf(List.class, messages, "Expected request messages"); + return (List) messages; + } + + private static Map getRequest(Map exchange) { + Object request = exchange.get("request"); + assertInstanceOf(Map.class, request, "Expected exchange request"); + return (Map) request; + } + + private static BlobAttachment createPdfAttachment() { + String pdfText = "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n"; + return new BlobAttachment() + .setData(Base64.getEncoder().encodeToString(pdfText.getBytes(StandardCharsets.US_ASCII))) + .setDisplayName("citation-source.pdf").setMimeType("application/pdf"); + } + + private static ProviderConfig createAnthropicProvider() { + return new ProviderConfig().setType("anthropic").setBaseUrl("https://anthropic-citations.invalid/v1") + .setApiKey("test-provider-key").setModelId("claude-sonnet-4.5").setWireModel("claude-sonnet-4.5"); + } + + private static String singleInferenceRequestBody(CopilotRequestTestSupport.RecordingRequestHandler handler) { + List requests = handler.inferenceRequests(); + assertEquals(1, requests.size(), "Expected one intercepted inference request"); + return requests.get(0).body(); + } + + private static void assertAnthropicDocumentCitationsEnabled(String requestBody) throws Exception { + JsonNode root = MAPPER.readTree(requestBody); + List documentBlocks = new ArrayList<>(); + for (JsonNode message : root.path("messages")) { + for (JsonNode block : message.path("content")) { + if ("document".equals(block.path("type").asText())) { + documentBlocks.add(block); + } + } + } + + assertEquals(1, documentBlocks.size(), "Expected one Anthropic document block"); + JsonNode documentBlock = documentBlocks.get(0); + assertEquals("citation-source.pdf", documentBlock.path("title").asText()); + assertTrue(documentBlock.path("citations").path("enabled").asBoolean(false)); + } + + @SuppressWarnings("unchecked") + private static String getSystemMessage(Map exchange) { + // The exchange structure is: { request: { messages: [...] }, response: ..., + // requestHeaders: ... } + Object requestObj = exchange.get("request"); + if (!(requestObj instanceof Map request)) { + return null; + } + Object messagesObj = request.get("messages"); + if (messagesObj instanceof List messages) { + for (Object msg : messages) { + if (msg instanceof Map msgMap) { + if ("system".equals(msgMap.get("role"))) { + Object content = msgMap.get("content"); + return content != null ? content.toString() : null; + } + } + } + } + return null; + } +} diff --git a/java/src/test/java/com/github/copilot/SessionEventDeserializationTest.java b/java/sdk/src/test/java/com/github/copilot/SessionEventDeserializationTest.java similarity index 95% rename from java/src/test/java/com/github/copilot/SessionEventDeserializationTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionEventDeserializationTest.java index 07b4c2eed..8d9b70a34 100644 --- a/java/src/test/java/com/github/copilot/SessionEventDeserializationTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionEventDeserializationTest.java @@ -113,6 +113,54 @@ void testParseSessionIdleEvent() throws Exception { assertEquals("session.idle", event.getType()); } + @Test + void testManagedSettingsResolvedClientProvenance() throws Exception { + assertEquals("server", ManagedSettingsResolvedSource.SERVER.getValue()); + assertEquals("device", ManagedSettingsResolvedSource.DEVICE.getValue()); + assertEquals("client", ManagedSettingsResolvedSource.CLIENT.getValue()); + assertEquals("mixed", ManagedSettingsResolvedSource.MIXED.getValue()); + assertEquals("none", ManagedSettingsResolvedSource.NONE.getValue()); + + String clientJson = """ + { + "type": "session.managed_settings_resolved", + "data": { + "source": "client", + "serverManaged": false, + "deviceManaged": false, + "clientManaged": true, + "failClosed": false, + "bypassPermissionsDisabled": true, + "managedKeys": ["permissions"] + } + } + """; + + var clientEvent = assertInstanceOf(SessionManagedSettingsResolvedEvent.class, parseJson(clientJson)); + assertEquals(ManagedSettingsResolvedSource.CLIENT, clientEvent.getData().source()); + assertEquals(Boolean.TRUE, clientEvent.getData().clientManaged()); + assertTrue(MAPPER.writeValueAsString(clientEvent).contains("\"clientManaged\":true")); + + String mixedJson = """ + { + "type": "session.managed_settings_resolved", + "data": { + "source": "mixed", + "serverManaged": true, + "deviceManaged": true, + "failClosed": false, + "bypassPermissionsDisabled": true, + "managedKeys": ["permissions"] + } + } + """; + + var mixedEvent = assertInstanceOf(SessionManagedSettingsResolvedEvent.class, parseJson(mixedJson)); + assertEquals(ManagedSettingsResolvedSource.MIXED, mixedEvent.getData().source()); + assertNull(mixedEvent.getData().clientManaged()); + assertFalse(MAPPER.writeValueAsString(mixedEvent).contains("\"clientManaged\"")); + } + @Test void testParseSessionInfoEvent() throws Exception { String json = """ @@ -897,15 +945,16 @@ void testParseEmptyJson() throws Exception { @Test void testParseAllEventTypes() throws Exception { String[] types = {"session.start", "session.resume", "session.error", "session.idle", "session.info", - "session.model_change", "session.mode_changed", "session.plan_changed", - "session.workspace_file_changed", "session.handoff", "session.truncation", "session.snapshot_rewind", - "session.usage_info", "session.compaction_start", "session.compaction_complete", "user.message", - "pending_messages.modified", "assistant.turn_start", "assistant.intent", "assistant.reasoning", - "assistant.reasoning_delta", "assistant.message", "assistant.message_delta", "assistant.turn_end", - "assistant.usage", "abort", "tool.user_requested", "tool.execution_start", - "tool.execution_partial_result", "tool.execution_progress", "tool.execution_complete", - "subagent.started", "subagent.completed", "subagent.failed", "subagent.selected", "hook.start", - "hook.end", "system.message", "session.shutdown", "skill.invoked"}; + "session.model_change", "session.mode_changed", "session.managed_settings_resolved", + "session.managed_settings_enforced", "session.plan_changed", "session.workspace_file_changed", + "session.handoff", "session.truncation", "session.snapshot_rewind", "session.usage_info", + "session.compaction_start", "session.compaction_complete", "user.message", "pending_messages.modified", + "assistant.turn_start", "assistant.intent", "assistant.reasoning", "assistant.reasoning_delta", + "assistant.message", "assistant.message_delta", "assistant.turn_end", "assistant.usage", "abort", + "tool.user_requested", "tool.execution_start", "tool.execution_partial_result", + "tool.execution_progress", "tool.execution_complete", "subagent.started", "subagent.completed", + "subagent.failed", "subagent.selected", "hook.start", "hook.end", "system.message", "session.shutdown", + "skill.invoked"}; for (String type : types) { String json = """ @@ -956,6 +1005,23 @@ void testParseBaseFieldsParentId() throws Exception { assertEquals(UUID.fromString(parentUuid), event.getParentId()); } + @Test + void testParseBaseFieldsAgentId() throws Exception { + String json = """ + { + "type": "assistant.message", + "agentId": "subagent-1", + "data": { + "content": "Hello" + } + } + """; + + SessionEvent event = parseJson(json); + assertNotNull(event); + assertEquals("subagent-1", event.getAgentId()); + } + @Test void testParseBaseFieldsEphemeral() throws Exception { String json = """ @@ -995,6 +1061,7 @@ void testParseBaseFieldsAllTogether() throws Exception { "type": "assistant.message", "id": "%s", "parentId": "%s", + "agentId": "subagent-1", "ephemeral": false, "timestamp": "2025-06-15T12:00:00+02:00", "data": { @@ -1007,6 +1074,7 @@ void testParseBaseFieldsAllTogether() throws Exception { assertNotNull(event); assertEquals(UUID.fromString(uuid), event.getId()); assertEquals(UUID.fromString(parentUuid), event.getParentId()); + assertEquals("subagent-1", event.getAgentId()); assertFalse(event.getEphemeral()); assertNotNull(event.getTimestamp()); assertInstanceOf(AssistantMessageEvent.class, event); @@ -1026,6 +1094,7 @@ void testParseBaseFieldsNullWhenAbsent() throws Exception { assertNotNull(event); assertNull(event.getId()); assertNull(event.getParentId()); + assertNull(event.getAgentId()); assertNull(event.getEphemeral()); assertNull(event.getTimestamp()); } @@ -2533,7 +2602,8 @@ void testParseSessionTaskCompleteEvent() throws Exception { assertEquals("Task completed successfully", castedEvent.getData().summary()); // Verify setData round-trip - castedEvent.setData(new SessionTaskCompleteEvent.SessionTaskCompleteEventData("New summary", null)); + castedEvent.setData( + new SessionTaskCompleteEvent.SessionTaskCompleteEventData("New summary", null, null, null, null)); assertEquals("New summary", castedEvent.getData().summary()); } diff --git a/java/src/test/java/com/github/copilot/SessionEventHandlingTest.java b/java/sdk/src/test/java/com/github/copilot/SessionEventHandlingTest.java similarity index 99% rename from java/src/test/java/com/github/copilot/SessionEventHandlingTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionEventHandlingTest.java index 8ab6f9bfe..bd38d4962 100644 --- a/java/src/test/java/com/github/copilot/SessionEventHandlingTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionEventHandlingTest.java @@ -180,7 +180,7 @@ void testHandlerReceivesCorrectEventData() { SessionStartEvent startEvent = createSessionStartEvent(); startEvent.setData(new SessionStartEvent.SessionStartEventData("my-session-123", null, null, null, null, null, - null, null, null, null, null, null)); + null, null, null, null, null, null, null, null, null, null)); dispatchEvent(startEvent); AssistantMessageEvent msgEvent = createAssistantMessageEvent("Test content"); @@ -857,7 +857,7 @@ private SessionStartEvent createSessionStartEvent() { private SessionStartEvent createSessionStartEvent(String sessionId) { var event = new SessionStartEvent(); var data = new SessionStartEvent.SessionStartEventData(sessionId, null, null, null, null, null, null, null, - null, null, null, null); + null, null, null, null, null, null, null, null); event.setData(data); return event; } @@ -865,7 +865,7 @@ private SessionStartEvent createSessionStartEvent(String sessionId) { private AssistantMessageEvent createAssistantMessageEvent(String content) { var event = new AssistantMessageEvent(); var data = new AssistantMessageEvent.AssistantMessageEventData(null, null, content, null, null, null, null, - null, null, null, null, null, null, null, null, null); + null, null, null, null, null, null, null, null, null, null, null, null, null, null, null); event.setData(data); return event; } diff --git a/java/src/test/java/com/github/copilot/SessionEventsE2ETest.java b/java/sdk/src/test/java/com/github/copilot/SessionEventsE2ETest.java similarity index 98% rename from java/src/test/java/com/github/copilot/SessionEventsE2ETest.java rename to java/sdk/src/test/java/com/github/copilot/SessionEventsE2ETest.java index 161839a53..dad75db52 100644 --- a/java/src/test/java/com/github/copilot/SessionEventsE2ETest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionEventsE2ETest.java @@ -5,6 +5,7 @@ package com.github.copilot; import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertTrue; import java.nio.file.Files; @@ -184,6 +185,9 @@ void testShouldReceiveSessionEvents_assistantUsageEvent() throws Exception { // Usage events may or may not be emitted depending on the model/API version // This test verifies the event handler works when they are emitted // We don't assert they must be present since it depends on the backend + if (!usageEvents.isEmpty()) { + assertNotNull(usageEvents.get(0).getData(), "Usage event should carry data"); + } } } diff --git a/java/src/test/java/com/github/copilot/SessionHandlerTest.java b/java/sdk/src/test/java/com/github/copilot/SessionHandlerTest.java similarity index 85% rename from java/src/test/java/com/github/copilot/SessionHandlerTest.java rename to java/sdk/src/test/java/com/github/copilot/SessionHandlerTest.java index 1b672e6e2..345fdccff 100644 --- a/java/src/test/java/com/github/copilot/SessionHandlerTest.java +++ b/java/sdk/src/test/java/com/github/copilot/SessionHandlerTest.java @@ -16,6 +16,7 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.AgentStopHookOutput; import com.github.copilot.rpc.PermissionRequestResult; import com.github.copilot.rpc.PermissionRequestResultKind; import com.github.copilot.rpc.SessionEndHookOutput; @@ -25,6 +26,7 @@ import com.github.copilot.rpc.UserInputRequest; import com.github.copilot.rpc.UserInputResponse; import com.github.copilot.rpc.UserPromptSubmittedHookOutput; +import com.github.copilot.rpc.UserPromptTransformedHookOutput; /** * Unit tests for CopilotSession internal handler methods. @@ -224,6 +226,26 @@ void testHandleHooksInvokeUserPromptSubmitted() throws Exception { assertEquals("modified prompt", output.modifiedPrompt()); } + @Test + void testHandleHooksInvokeUserPromptTransformed() throws Exception { + var hooks = new SessionHooks().setOnUserPromptTransformed((hookInput, invocation) -> { + assertEquals("handler-test-session", invocation.getSessionId()); + assertEquals("original prompt", hookInput.prompt()); + assertEquals("transformed prompt", hookInput.transformedPrompt()); + return CompletableFuture.completedFuture(new UserPromptTransformedHookOutput("replacement prompt")); + }); + session.registerHooks(hooks); + + JsonNode input = MAPPER.valueToTree(Map.of("sessionId", "runtime-session", "timestamp", 1735689600L, "cwd", + "/tmp", "prompt", "original prompt", "transformedPrompt", "transformed prompt")); + + Object result = session.handleHooksInvoke("userPromptTransformed", input).get(); + + assertInstanceOf(UserPromptTransformedHookOutput.class, result); + var output = (UserPromptTransformedHookOutput) result; + assertEquals("replacement prompt", output.modifiedTransformedPrompt()); + } + // ===== handleHooksInvoke: sessionStart ===== @Test @@ -262,6 +284,32 @@ void testHandleHooksInvokeSessionEnd() throws Exception { assertEquals("summary", output.sessionSummary()); } + // ===== handleHooksInvoke: agentStop ===== + + @Test + void testHandleHooksInvokeAgentStop() throws Exception { + var hooks = new SessionHooks().setOnAgentStop((hookInput, invocation) -> { + assertEquals("handler-test-session", invocation.getSessionId()); + assertEquals("runtime-session-123", hookInput.getSessionId()); + assertEquals("end_turn", hookInput.getStopReason()); + assertEquals("/tmp/transcript.jsonl", hookInput.getTranscriptPath()); + assertTrue(hookInput.getStopHookActive()); + return CompletableFuture.completedFuture( + new AgentStopHookOutput().setDecision("block").setReason("finish the remaining work")); + }); + session.registerHooks(hooks); + + JsonNode input = MAPPER.valueToTree(Map.of("sessionId", "runtime-session-123", "timestamp", 1735689600L, "cwd", + "/tmp", "stopReason", "end_turn", "transcriptPath", "/tmp/transcript.jsonl", "stop_hook_active", true)); + + Object result = session.handleHooksInvoke("agentStop", input).get(); + + assertInstanceOf(AgentStopHookOutput.class, result); + var output = (AgentStopHookOutput) result; + assertEquals("block", output.getDecision()); + assertEquals("finish the remaining work", output.getReason()); + } + // ===== handleHooksInvoke: sessionId deserialization on hook inputs ===== @Test diff --git a/java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java b/java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java new file mode 100644 index 000000000..0525786de --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SessionRequestBuilderTest.java @@ -0,0 +1,1077 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.rpc.SessionLimitsConfig; +import com.github.copilot.rpc.AutoModeSwitchResponse; +import com.github.copilot.rpc.CloudSessionOptions; +import com.github.copilot.rpc.CloudSessionRepository; +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.CopilotExpAssignmentResponse; +import com.github.copilot.rpc.CreateSessionRequest; +import com.github.copilot.rpc.DefaultAgentConfig; +import com.github.copilot.rpc.ElicitationHandler; +import com.github.copilot.rpc.ElicitationResult; +import com.github.copilot.rpc.ElicitationResultAction; +import com.github.copilot.rpc.ExitPlanModeResult; +import com.github.copilot.rpc.ExpConfigEntry; +import com.github.copilot.rpc.GitHubMcpToolConfig; +import com.github.copilot.rpc.LargeToolOutputConfig; +import com.github.copilot.rpc.MemoryConfiguration; +import com.github.copilot.rpc.ResumeSessionConfig; +import com.github.copilot.rpc.ResumeSessionRequest; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SessionHooks; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.rpc.UserInputResponse; + +/** + * Unit tests for {@link SessionRequestBuilder} branch coverage. + *

+ * Exercises branches in buildCreateRequest, buildResumeRequest, and + * configureSession that are not reached by E2E tests. + */ +public class SessionRequestBuilderTest { + + // ========================================================================= + // buildCreateRequest + // ========================================================================= + + @Test + void testBuildCreateRequestNullConfig() { + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(null); + assertNotNull(request); + assertNull(request.getModel()); + assertTrue(request.getRequestPermission(), "requestPermission should be true even for null config"); + assertEquals("direct", request.getEnvValueMode(), "envValueMode should be 'direct' even for null config"); + } + + @Test + void testBuildCreateRequestHooksNonNullButEmpty() { + // Hooks object exists but hasHooks() returns false + var config = new SessionConfig().setHooks(new SessionHooks()); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertNull(request.getHooks(), "Should be null when hooks are empty"); + } + + @Test + void testBuildCreateRequestHooksWithHandler() { + var hooks = new SessionHooks().setOnPreToolUse((input, inv) -> CompletableFuture.completedFuture(null)); + var config = new SessionConfig().setHooks(hooks); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertTrue(request.getHooks(), "Should be true when hooks have handlers"); + } + + @Test + void testBuildCreateRequestSetsEnvValueModeToDirect() { + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig()); + assertEquals("direct", request.getEnvValueMode()); + } + + @Test + void testBuildCreateRequestAlwaysSetsRequestPermissionTrue() { + // No permission handler set - requestPermission should still be true + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig()); + assertTrue(request.getRequestPermission(), + "requestPermission should always be true to enable deny-by-default behavior"); + } + + @Test + void testBuildRequestsResolveAndSerializeCustomAgentsLocalOnly() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + + var explicitCreate = SessionRequestBuilder + .buildCreateRequest(new SessionConfig().setCustomAgentsLocalOnly(false), "create-explicit"); + var explicitResume = SessionRequestBuilder.buildResumeRequest("resume-explicit", + new ResumeSessionConfig().setCustomAgentsLocalOnly(false)); + assertFalse(explicitCreate.getCustomAgentsLocalOnly()); + assertFalse(explicitResume.getCustomAgentsLocalOnly()); + assertTrue(mapper.writeValueAsString(explicitCreate).contains("\"customAgentsLocalOnly\":false")); + assertTrue(mapper.writeValueAsString(explicitResume).contains("\"customAgentsLocalOnly\":false")); + + var emptyCreate = SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "create-empty", + CopilotClientMode.EMPTY); + var emptyResume = SessionRequestBuilder.buildResumeRequest("resume-empty", new ResumeSessionConfig(), + CopilotClientMode.EMPTY); + assertTrue(emptyCreate.getCustomAgentsLocalOnly()); + assertTrue(emptyResume.getCustomAgentsLocalOnly()); + assertTrue(mapper.writeValueAsString(emptyCreate).contains("\"customAgentsLocalOnly\":true")); + assertTrue(mapper.writeValueAsString(emptyResume).contains("\"customAgentsLocalOnly\":true")); + + var cliCreate = SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "create-cli"); + var cliResume = SessionRequestBuilder.buildResumeRequest("resume-cli", new ResumeSessionConfig()); + assertNull(cliCreate.getCustomAgentsLocalOnly()); + assertNull(cliResume.getCustomAgentsLocalOnly()); + assertFalse(mapper.writeValueAsString(cliCreate).contains("\"customAgentsLocalOnly\"")); + assertFalse(mapper.writeValueAsString(cliResume).contains("\"customAgentsLocalOnly\"")); + } + + @Test + void testBuildCreateRequestSetsClientName() { + var config = new SessionConfig().setClientName("my-app"); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals("my-app", request.getClientName()); + } + + @Test + void testBuildCreateRequestSetsAdditionalDirectories() { + var config = new SessionConfig().setAdditionalDirectories(List.of("/repo/shared", "/repo/generated")); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals(List.of("/repo/shared", "/repo/generated"), request.getAdditionalDirectories()); + } + + @Test + void testBuildCreateRequestSetsReasoningSummary() { + var config = new SessionConfig().setReasoningSummary("concise"); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals("concise", request.getReasoningSummary()); + } + + @Test + void testBuildCreateRequestSetsEnableExperimentalMode() { + var config = new SessionConfig().setEnableExperimentalMode(false); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertFalse(request.getIsExperimentalMode()); + } + + @Test + void testBuildCreateRequestOmitsEnableExperimentalModeWhenNotSet() { + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig()); + assertNull(request.getIsExperimentalMode()); + } + + @Test + void testBuildCreateRequestDefaultsEnableExperimentalModeFalseInEmptyMode() { + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "sid-empty", + CopilotClientMode.EMPTY); + assertFalse(request.getIsExperimentalMode()); + } + + @Test + void testBuildCreateRequestSetsContextTier() { + var config = new SessionConfig().setContextTier("long_context"); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals("long_context", request.getContextTier()); + } + + @Test + void testBuildCreateRequestSetsPluginDirectoriesAndLargeOutput() throws Exception { + var largeOutput = new LargeToolOutputConfig().setEnabled(true).setMaxSizeBytes(1024L) + .setOutputDirectory("/tmp/out"); + var config = new SessionConfig().setPluginDirectories(List.of("/plugins/a")) + .setDisabledMcpServers(List.of("local-files", "remote-github")).setLargeOutput(largeOutput); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals(List.of("/plugins/a"), request.getPluginDirectories()); + assertEquals(List.of("local-files", "remote-github"), request.getDisabledMcpServers()); + assertEquals(largeOutput, request.getLargeOutput()); + assertTrue(JsonRpcClient.getObjectMapper().writeValueAsString(request) + .contains("\"disabledMcpServers\":[\"local-files\",\"remote-github\"]")); + } + + @Test + void testBuildCreateRequestSetsMemory() { + var memory = new MemoryConfiguration().setEnabled(true); + var config = new SessionConfig().setMemory(memory); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config, "test-session-id"); + assertEquals(memory, request.getMemory()); + } + + @Test + void testBuildCreateRequestOmitsMemoryWhenNotSet() { + var config = new SessionConfig(); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config, "test-session-id"); + assertNull(request.getMemory()); + } + + @Test + void testBuildCreateRequestForwardsEnableSessionTelemetryWhenFalse() { + var config = new SessionConfig().setEnableSessionTelemetry(false); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertFalse(request.getEnableSessionTelemetry()); + } + + @Test + void testBuildCreateRequestOmitsEnableSessionTelemetryWhenNotSet() { + var config = new SessionConfig(); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertNull(request.getEnableSessionTelemetry()); + } + + @Test + void testBuildCreateRequestPassesThroughNullMcpOAuthTokenStorage() { + var config = new SessionConfig(); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertNull(request.getMcpOAuthTokenStorage()); + } + + @Test + void testBuildCreateRequestForwardsExplicitMcpOAuthTokenStorage() { + var config = new SessionConfig().setMcpOAuthTokenStorage("persistent"); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals("persistent", request.getMcpOAuthTokenStorage()); + } + + @Test + void testBuildCreateRequestForwardsSessionPolicyOptions() { + var sessionLimits = new SessionLimitsConfig(30.0); + var config = new SessionConfig().setExcludedBuiltInAgents(List.of("explore")).setEnableCitations(true) + .setEnableFileChangeTracking(true).setSessionLimits(sessionLimits); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config, "session-policy"); + + assertEquals(List.of("explore"), request.getExcludedBuiltInAgents()); + assertTrue(request.getEnableCitations()); + assertTrue(request.getEnableFileChangeTracking()); + assertSame(sessionLimits, request.getSessionLimits()); + } + + @Test + void testBuildCreateRequestNullConfigHasNullMcpOAuthTokenStorage() { + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(null); + assertNull(request.getMcpOAuthTokenStorage()); + } + + // ========================================================================= + // buildResumeRequest + // ========================================================================= + + @Test + void testBuildResumeRequestNullConfig() { + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", null); + assertEquals("sid-1", request.getSessionId()); + assertNull(request.getModel()); + assertTrue(request.getRequestPermission(), "requestPermission should be true even for null config"); + assertEquals("direct", request.getEnvValueMode(), "envValueMode should be 'direct' even for null config"); + } + + @Test + void testBuildResumeRequestForwardsEnableSessionTelemetryWhenFalse() { + var config = new ResumeSessionConfig().setEnableSessionTelemetry(false); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); + assertFalse(request.getEnableSessionTelemetry()); + } + + @Test + void testBuildResumeRequestOmitsEnableSessionTelemetryWhenNotSet() { + var config = new ResumeSessionConfig(); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); + assertNull(request.getEnableSessionTelemetry()); + } + + @Test + void testBuildResumeRequestSetsEnableExperimentalMode() { + var config = new ResumeSessionConfig().setEnableExperimentalMode(true); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); + assertTrue(request.getIsExperimentalMode()); + } + + @Test + void testBuildResumeRequestOmitsEnableExperimentalModeWhenNotSet() { + var config = new ResumeSessionConfig(); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); + assertNull(request.getIsExperimentalMode()); + } + + @Test + void testBuildResumeRequestDefaultsEnableExperimentalModeFalseInEmptyMode() { + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-empty", new ResumeSessionConfig(), + CopilotClientMode.EMPTY); + assertFalse(request.getIsExperimentalMode()); + } + + @Test + void testBuildResumeRequestWithTools() { + var tool = ToolDefinition.create("my_tool", "A tool", Map.of("type", "object"), + inv -> CompletableFuture.completedFuture("result")); + var config = new ResumeSessionConfig().setTools(List.of(tool)); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-2", config); + + assertNotNull(request.getTools()); + assertEquals(1, request.getTools().size()); + assertEquals("my_tool", request.getTools().get(0).name()); + } + + @Test + void testBuildResumeRequestWithUserInputHandler() { + var config = new ResumeSessionConfig() + .setOnUserInputRequest((req, inv) -> CompletableFuture.completedFuture(new UserInputResponse())); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-3", config); + + assertTrue(request.getRequestUserInput()); + } + + @Test + void testBuildResumeRequestHooksNonNullButEmpty() { + var config = new ResumeSessionConfig().setHooks(new SessionHooks()); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-4", config); + + assertNull(request.getHooks(), "Should be null when hooks are empty"); + } + + @Test + void testBuildResumeRequestHooksWithHandler() { + var hooks = new SessionHooks().setOnSessionEnd((input, inv) -> CompletableFuture.completedFuture(null)); + var config = new ResumeSessionConfig().setHooks(hooks); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-5", config); + + assertTrue(request.getHooks(), "Should be true when hooks have handlers"); + } + + @Test + void testBuildResumeRequestDisableResume() { + var config = new ResumeSessionConfig().setDisableResume(true); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-6", config); + + assertTrue(request.getDisableResume()); + } + + @Test + void testBuildResumeRequestStreaming() { + var config = new ResumeSessionConfig().setStreaming(true); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-7", config); + + assertTrue(request.getStreaming()); + } + + @Test + void testBuildResumeRequestSetsEnvValueModeToDirect() { + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-8", new ResumeSessionConfig()); + assertEquals("direct", request.getEnvValueMode()); + } + + @Test + void testBuildResumeRequestAlwaysSetsRequestPermissionTrue() { + // No permission handler set - requestPermission should still be true + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-9", new ResumeSessionConfig()); + assertTrue(request.getRequestPermission(), + "requestPermission should always be true to enable deny-by-default behavior"); + } + + @Test + void testBuildResumeRequestSetsClientName() { + var config = new ResumeSessionConfig().setClientName("my-app"); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-10", config); + assertEquals("my-app", request.getClientName()); + } + + @Test + void testBuildResumeRequestSetsAdditionalDirectories() { + var config = new ResumeSessionConfig().setAdditionalDirectories(List.of("/repo/resumed")); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-additional-directories", config); + assertEquals(List.of("/repo/resumed"), request.getAdditionalDirectories()); + } + + @Test + void testBuildCreateRequestPropagatesGranularMultitenancyFields() { + var config = new SessionConfig().setSkipEmbeddingRetrieval(true) + .setOrganizationCustomInstructions("Create org instructions") + .setEnableOnDemandInstructionDiscovery(false).setEnableFileHooks(true).setEnableHostGitOperations(false) + .setEnableSessionStore(true).setEnableSkills(false); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertTrue(request.getSkipEmbeddingRetrieval()); + assertEquals("Create org instructions", request.getOrganizationCustomInstructions()); + assertFalse(request.getEnableOnDemandInstructionDiscovery()); + assertTrue(request.getEnableFileHooks()); + assertFalse(request.getEnableHostGitOperations()); + assertTrue(request.getEnableSessionStore()); + assertFalse(request.getEnableSkills()); + } + + @Test + void testBuildResumeRequestPropagatesGranularMultitenancyFields() { + var config = new ResumeSessionConfig().setSkipEmbeddingRetrieval(false) + .setOrganizationCustomInstructions("Resume org instructions") + .setEnableOnDemandInstructionDiscovery(true).setEnableFileHooks(false).setEnableHostGitOperations(true) + .setEnableSessionStore(false).setEnableSkills(true); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-11", config); + + assertFalse(request.getSkipEmbeddingRetrieval()); + assertEquals("Resume org instructions", request.getOrganizationCustomInstructions()); + assertTrue(request.getEnableOnDemandInstructionDiscovery()); + assertFalse(request.getEnableFileHooks()); + assertTrue(request.getEnableHostGitOperations()); + assertFalse(request.getEnableSessionStore()); + assertTrue(request.getEnableSkills()); + } + + @Test + void testBuildResumeRequestPassesThroughNullMcpOAuthTokenStorage() { + var config = new ResumeSessionConfig(); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-12", config); + assertNull(request.getMcpOAuthTokenStorage()); + } + + @Test + void testBuildResumeRequestForwardsExplicitMcpOAuthTokenStorage() { + var config = new ResumeSessionConfig().setMcpOAuthTokenStorage("persistent"); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-13", config); + assertEquals("persistent", request.getMcpOAuthTokenStorage()); + } + + @Test + void testBuildResumeRequestForwardsSessionPolicyOptions() { + var sessionLimits = new SessionLimitsConfig(30.0); + var config = new ResumeSessionConfig().setExcludedBuiltInAgents(List.of("explore")).setEnableCitations(true) + .setEnableFileChangeTracking(true).setSessionLimits(sessionLimits); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-policy", config); + + assertEquals(List.of("explore"), request.getExcludedBuiltInAgents()); + assertTrue(request.getEnableCitations()); + assertTrue(request.getEnableFileChangeTracking()); + assertSame(sessionLimits, request.getSessionLimits()); + } + + @Test + void testBuildResumeRequestNullConfigHasNullMcpOAuthTokenStorage() { + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-14", null); + assertNull(request.getMcpOAuthTokenStorage()); + } + + @Test + void testBuildResumeRequestSetsReasoningSummary() { + var config = new ResumeSessionConfig().setReasoningSummary("none"); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-15", config); + assertEquals("none", request.getReasoningSummary()); + } + + @Test + void testBuildResumeRequestSetsContextTier() { + var config = new ResumeSessionConfig().setContextTier("default"); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-15", config); + assertEquals("default", request.getContextTier()); + } + + @Test + void testBuildResumeRequestSetsPluginDirectoriesAndLargeOutput() throws Exception { + var largeOutput = new LargeToolOutputConfig().setEnabled(false).setMaxSizeBytes(2048L) + .setOutputDirectory("/tmp/resume"); + var config = new ResumeSessionConfig().setPluginDirectories(List.of("/plugins/r")) + .setDisabledMcpServers(List.of("local-files-r")).setLargeOutput(largeOutput); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-16", config); + assertEquals(List.of("/plugins/r"), request.getPluginDirectories()); + assertEquals(List.of("local-files-r"), request.getDisabledMcpServers()); + assertEquals(largeOutput, request.getLargeOutput()); + assertTrue(JsonRpcClient.getObjectMapper().writeValueAsString(request) + .contains("\"disabledMcpServers\":[\"local-files-r\"]")); + } + + @Test + void testBuildResumeRequestSetsMemory() { + var memory = new MemoryConfiguration().setEnabled(false); + var config = new ResumeSessionConfig().setMemory(memory); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-mem", config); + assertEquals(memory, request.getMemory()); + } + + @Test + void testBuildResumeRequestOmitsMemoryWhenNotSet() { + var config = new ResumeSessionConfig(); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-mem", config); + assertNull(request.getMemory()); + } + + // ========================================================================= + // configureSession (ResumeSessionConfig overload) + // ========================================================================= + + @Test + void testConfigureResumeSessionNullConfig() throws Exception { + var session = createTestSession(); + // Should not throw + SessionRequestBuilder.configureSession(session, (ResumeSessionConfig) null); + } + + @Test + void testConfigureResumeSessionWithTools() throws Exception { + var session = createTestSession(); + var tool = ToolDefinition.create("resume_tool", "desc", Map.of(), + inv -> CompletableFuture.completedFuture("ok")); + var config = new ResumeSessionConfig().setTools(List.of(tool)); + + SessionRequestBuilder.configureSession(session, config); + + assertNotNull(session.getTool("resume_tool")); + } + + @Test + void testConfigureResumeSessionWithUserInputHandler() throws Exception { + var session = createTestSession(); + var config = new ResumeSessionConfig() + .setOnUserInputRequest((req, inv) -> CompletableFuture.completedFuture(new UserInputResponse())); + + SessionRequestBuilder.configureSession(session, config); + + // Handler was registered — verify by calling handleUserInputRequest + // (package-private) + var response = session.handleUserInputRequest(new com.github.copilot.rpc.UserInputRequest()).get(); + assertNotNull(response); + } + + @Test + void testConfigureResumeSessionWithHooks() throws Exception { + var session = createTestSession(); + var hooks = new SessionHooks().setOnPreToolUse((input, inv) -> CompletableFuture.completedFuture(null)); + var config = new ResumeSessionConfig().setHooks(hooks); + + SessionRequestBuilder.configureSession(session, config); + + // Hooks registered — handleHooksInvoke should dispatch preToolUse + var mapper = JsonRpcClient.getObjectMapper(); + var input = mapper.valueToTree(Map.of("toolName", "test_tool")); + var result = session.handleHooksInvoke("preToolUse", input).get(); + assertNull(result); // handler returns null + } + + // ========================================================================= + // Helper + // ========================================================================= + + private CopilotSession createTestSession() throws Exception { + var constructor = CopilotSession.class.getDeclaredConstructor(String.class, JsonRpcClient.class, String.class); + constructor.setAccessible(true); + return constructor.newInstance("builder-test-session", null, null); + } + + @Test + void testBuildCreateRequestWithAgent() { + var config = new SessionConfig().setAgent("my-agent"); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config, "test-session-id"); + assertEquals("my-agent", request.getAgent()); + } + + @Test + void testBuildResumeRequestWithAgent() { + var config = new ResumeSessionConfig().setAgent("my-agent"); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-id", config); + assertEquals("my-agent", request.getAgent()); + } + + // ========================================================================= + // extractTransformCallbacks + // ========================================================================= + + @Test + void extractTransformCallbacks_nullSystemMessage_returnsNull() { + ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(null); + assertNull(result.wireSystemMessage()); + assertNull(result.transformCallbacks()); + } + + @Test + void extractTransformCallbacks_appendMode_returnsOriginalConfig() { + var config = new com.github.copilot.rpc.SystemMessageConfig() + .setMode(com.github.copilot.SystemMessageMode.APPEND).setContent("extra content"); + ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); + assertSame(config, result.wireSystemMessage()); + assertNull(result.transformCallbacks()); + } + + @Test + void extractTransformCallbacks_customizeModeNoTransforms_returnsOriginalConfig() { + var sections = Map.of("tone", new com.github.copilot.rpc.SectionOverride() + .setAction(com.github.copilot.rpc.SectionOverrideAction.REMOVE)); + var config = new com.github.copilot.rpc.SystemMessageConfig() + .setMode(com.github.copilot.SystemMessageMode.CUSTOMIZE).setSections(sections); + ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); + assertSame(config, result.wireSystemMessage()); + assertNull(result.transformCallbacks()); + } + + @Test + void extractTransformCallbacks_customizeModeWithTransform_extractsCallbacks() { + var transformFn = (java.util.function.Function>) content -> CompletableFuture + .completedFuture(content + " modified"); + var sections = Map.of("identity", new com.github.copilot.rpc.SectionOverride().setTransform(transformFn)); + var config = new com.github.copilot.rpc.SystemMessageConfig() + .setMode(com.github.copilot.SystemMessageMode.CUSTOMIZE).setSections(sections); + + ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); + + // Wire config should be different from original + assertNotSame(config, result.wireSystemMessage()); + // Callbacks should be extracted + assertNotNull(result.transformCallbacks()); + assertTrue(result.transformCallbacks().containsKey("identity")); + // Wire config should have transform action instead of callback + assertNotNull(result.wireSystemMessage().getSections()); + var wireSection = result.wireSystemMessage().getSections().get("identity"); + assertNotNull(wireSection); + assertEquals(com.github.copilot.rpc.SectionOverrideAction.TRANSFORM, wireSection.getAction()); + assertNull(wireSection.getTransform()); + } + + @Test + @SuppressWarnings("deprecation") + void buildCreateRequestWithSessionId_usesProvidedSessionId() { + var config = new SessionConfig(); + config.setSessionId("my-session-id"); + + // The deprecated single-arg overload uses the sessionId from config when set + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertEquals("my-session-id", request.getSessionId()); + } + + @Test + void configureSessionWithNullConfig_returnsEarly() { + // configureSession with null config should return without error + CopilotSession session = new CopilotSession("session-1", null); + // Covers the null config early-return branch (L219-220) + assertDoesNotThrow(() -> SessionRequestBuilder.configureSession(session, (SessionConfig) null)); + } + + @Test + void configureSessionWithCommands_registersCommands() { + CopilotSession session = new CopilotSession("session-1", null); + + var cmd = new com.github.copilot.rpc.CommandDefinition().setName("deploy") + .setHandler(ctx -> CompletableFuture.completedFuture(null)); + var config = new SessionConfig().setCommands(List.of(cmd)); + + // Covers config.getCommands() != null branch (L235-236) + SessionRequestBuilder.configureSession(session, config); + // If no exception thrown, the branch was covered + } + + @Test + void configureSessionWithElicitationHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + ElicitationHandler handler = (context) -> CompletableFuture + .completedFuture(new ElicitationResult().setAction(ElicitationResultAction.CANCEL)); + var config = new SessionConfig().setOnElicitationRequest(handler); + + // Covers config.getOnElicitationRequest() != null branch (L238-239) + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureSessionWithOnEvent_registersEventHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new SessionConfig().setOnEvent(event -> { + }); + + // Covers config.getOnEvent() != null branch (L241-242) + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureResumedSessionWithCommands_registersCommands() { + CopilotSession session = new CopilotSession("session-1", null); + + var cmd = new com.github.copilot.rpc.CommandDefinition().setName("rollback") + .setHandler(ctx -> CompletableFuture.completedFuture(null)); + var config = new ResumeSessionConfig().setCommands(List.of(cmd)); + + // Covers ResumeSessionConfig.getCommands() != null branch (L271-272) + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureResumedSessionWithElicitationHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + ElicitationHandler handler = (context) -> CompletableFuture + .completedFuture(new ElicitationResult().setAction(ElicitationResultAction.CANCEL)); + var config = new ResumeSessionConfig().setOnElicitationRequest(handler); + + // Covers ResumeSessionConfig.getOnElicitationRequest() != null branch + // (L274-275) + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureResumedSessionWithOnEvent_registersEventHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new ResumeSessionConfig().setOnEvent(event -> { + }); + + // Covers ResumeSessionConfig.getOnEvent() != null branch (L277-278) + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void testBuildCreateRequestWithDefaultAgent() { + var defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); + var config = new SessionConfig().setDefaultAgent(defaultAgent); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertNotNull(request.getDefaultAgent()); + assertEquals(List.of("secret_tool"), request.getDefaultAgent().getExcludedTools()); + } + + @Test + void testBuildCreateRequestWithGitHubToken() { + var config = new SessionConfig().setGitHubToken("ghp_per_session_token"); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertEquals("ghp_per_session_token", request.getGitHubToken()); + } + + @Test + void testBuildResumeRequestWithDefaultAgent() { + var defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); + var config = new ResumeSessionConfig().setDefaultAgent(defaultAgent); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("test-session", config); + + assertNotNull(request.getDefaultAgent()); + assertEquals(List.of("secret_tool"), request.getDefaultAgent().getExcludedTools()); + } + + @Test + void testBuildResumeRequestWithGitHubToken() { + var config = new ResumeSessionConfig().setGitHubToken("ghp_per_session_token"); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("test-session", config); + + assertEquals("ghp_per_session_token", request.getGitHubToken()); + } + + // ========================================================================= + // instructionDirectories propagation + // ========================================================================= + + @Test + void testBuildCreateRequestPropagatesInstructionDirectories() { + var dirs = List.of("/path/to/instructions", "/another/path"); + var config = new SessionConfig().setInstructionDirectories(dirs); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertEquals(dirs, request.getInstructionDirectories()); + } + + @Test + void testBuildResumeRequestPropagatesInstructionDirectories() { + var dirs = List.of("/resume/instructions", "/other/dir"); + var config = new ResumeSessionConfig().setInstructionDirectories(dirs); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-inst", config); + + assertEquals(dirs, request.getInstructionDirectories()); + } + + // ========================================================================= + // enableSessionTelemetry serialization + // ========================================================================= + + @Test + void testCreateRequestSerializesEnableSessionTelemetryWhenFalse() throws Exception { + var config = new SessionConfig().setEnableSessionTelemetry(false); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + assertTrue(json.contains("\"enableSessionTelemetry\":false"), + "enableSessionTelemetry should be serialized when set to false"); + } + + @Test + void testCreateRequestOmitsEnableSessionTelemetryWhenNull() throws Exception { + var config = new SessionConfig(); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + assertFalse(json.contains("enableSessionTelemetry"), "enableSessionTelemetry should be omitted when null"); + } + + @Test + void testResumeRequestSerializesEnableSessionTelemetryWhenFalse() throws Exception { + var config = new ResumeSessionConfig().setEnableSessionTelemetry(false); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-tel", config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + assertTrue(json.contains("\"enableSessionTelemetry\":false"), + "enableSessionTelemetry should be serialized when set to false"); + } + + @Test + void testResumeRequestOmitsEnableSessionTelemetryWhenNull() throws Exception { + var config = new ResumeSessionConfig(); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-tel", config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + assertFalse(json.contains("enableSessionTelemetry"), "enableSessionTelemetry should be omitted when null"); + } + + // ========================================================================= + // Mode handler request flags + // ========================================================================= + + @Test + void testBuildCreateRequestWithExitPlanModeHandler() { + var config = new SessionConfig().setOnExitPlanMode( + (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertTrue(request.getRequestExitPlanMode()); + } + + @Test + void testBuildCreateRequestWithAutoModeSwitchHandler() { + var config = new SessionConfig().setOnAutoModeSwitch( + (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertTrue(request.getRequestAutoModeSwitch()); + } + + @Test + void testBuildCreateRequestWithoutModeHandlers() { + var config = new SessionConfig(); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertNull(request.getRequestExitPlanMode()); + assertNull(request.getRequestAutoModeSwitch()); + } + + @Test + void testBuildResumeRequestWithExitPlanModeHandler() { + var config = new ResumeSessionConfig().setOnExitPlanMode( + (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); + + assertTrue(request.getRequestExitPlanMode()); + } + + @Test + void testBuildResumeRequestWithAutoModeSwitchHandler() { + var config = new ResumeSessionConfig().setOnAutoModeSwitch( + (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); + + assertTrue(request.getRequestAutoModeSwitch()); + } + + @Test + void configureSessionWithExitPlanModeHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new SessionConfig().setOnExitPlanMode( + (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); + + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureSessionWithAutoModeSwitchHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new SessionConfig().setOnAutoModeSwitch( + (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureResumedSessionWithExitPlanModeHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new ResumeSessionConfig().setOnExitPlanMode( + (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); + + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void configureResumedSessionWithAutoModeSwitchHandler_registersHandler() { + CopilotSession session = new CopilotSession("session-1", null); + + var config = new ResumeSessionConfig().setOnAutoModeSwitch( + (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + SessionRequestBuilder.configureSession(session, config); + } + + @Test + void testCreateRequestSerializesModeFlags() throws Exception { + var config = new SessionConfig() + .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult())) + .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + + assertTrue(json.contains("\"requestExitPlanMode\":true")); + assertTrue(json.contains("\"requestAutoModeSwitch\":true")); + } + + @Test + void testResumeRequestSerializesModeFlags() throws Exception { + var config = new ResumeSessionConfig() + .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult())) + .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); + + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + + assertTrue(json.contains("\"requestExitPlanMode\":true")); + assertTrue(json.contains("\"requestAutoModeSwitch\":true")); + } + + // ========================================================================= + // Cloud session options wiring + // ========================================================================= + + @Test + void testBuildCreateRequestPropagatesCloudSessionOptions() throws Exception { + var cloud = new CloudSessionOptions() + .setRepository(new CloudSessionRepository().setOwner("my-org").setName("my-repo").setBranch("main")); + var config = new SessionConfig().setCloud(cloud); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + + assertNotNull(request.getCloud()); + assertEquals("my-org", request.getCloud().getRepository().getOwner()); + assertEquals("my-repo", request.getCloud().getRepository().getName()); + assertEquals("main", request.getCloud().getRepository().getBranch()); + } + + @Test + void testBuildCreateRequestOmitsCloudWhenNull() throws Exception { + var config = new SessionConfig(); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + + assertNull(request.getCloud()); + assertFalse(json.contains("\"cloud\""), "cloud should be omitted when null"); + } + + @Test + void testCloudSessionOptionsSerializesCorrectly() throws Exception { + var cloud = new CloudSessionOptions() + .setRepository(new CloudSessionRepository().setOwner("acme").setName("widgets").setBranch("feature-1")); + var config = new SessionConfig().setCloud(cloud); + + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + var mapper = JsonRpcClient.getObjectMapper(); + var json = mapper.writeValueAsString(request); + + assertTrue(json.contains("\"cloud\"")); + assertTrue(json.contains("\"owner\":\"acme\"")); + assertTrue(json.contains("\"name\":\"widgets\"")); + assertTrue(json.contains("\"branch\":\"feature-1\"")); + } + + // ========================================================================= + // ExP assignment injection wiring + // ========================================================================= + + @Test + void testBuildRequestsPropagateAndSerializeExpAssignments() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + var createAssignments = new CopilotExpAssignmentResponse() + .setConfigs(List.of(new ExpConfigEntry().setId("exp-create"))); + var resumeAssignments = new CopilotExpAssignmentResponse() + .setConfigs(List.of(new ExpConfigEntry().setId("exp-resume"))); + + var createConfig = new SessionConfig().setExpAssignments(createAssignments); + CreateSessionRequest createRequest = SessionRequestBuilder.buildCreateRequest(createConfig, "session-1"); + assertEquals(createAssignments, createRequest.getExpAssignments()); + var createJson = mapper.writeValueAsString(createRequest); + assertTrue(createJson.contains("\"expAssignments\"")); + assertTrue(createJson.contains("\"Id\":\"exp-create\"")); + + var resumeConfig = new ResumeSessionConfig().setExpAssignments(resumeAssignments); + ResumeSessionRequest resumeRequest = SessionRequestBuilder.buildResumeRequest("session-1", resumeConfig); + assertEquals(resumeAssignments, resumeRequest.getExpAssignments()); + var resumeJson = mapper.writeValueAsString(resumeRequest); + assertTrue(resumeJson.contains("\"expAssignments\"")); + assertTrue(resumeJson.contains("\"Id\":\"exp-resume\"")); + } + + @Test + void testBuildRequestsOmitExpAssignmentsWhenUnset() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + + CreateSessionRequest createRequest = SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "session-1"); + assertNull(createRequest.getExpAssignments()); + var createJson = mapper.writeValueAsString(createRequest); + assertFalse(createJson.contains("\"expAssignments\""), "expAssignments should be omitted when null"); + + ResumeSessionRequest resumeRequest = SessionRequestBuilder.buildResumeRequest("session-1", + new ResumeSessionConfig()); + assertNull(resumeRequest.getExpAssignments()); + var resumeJson = mapper.writeValueAsString(resumeRequest); + assertFalse(resumeJson.contains("\"expAssignments\""), "expAssignments should be omitted when null"); + } + + @Test + void testClonePreservesAndForwardsExpAssignments() throws Exception { + var mapper = JsonRpcClient.getObjectMapper(); + var createAssignments = new CopilotExpAssignmentResponse() + .setConfigs(List.of(new ExpConfigEntry().setId("exp-create"))); + var resumeAssignments = new CopilotExpAssignmentResponse() + .setConfigs(List.of(new ExpConfigEntry().setId("exp-resume"))); + + var createConfig = new SessionConfig().setExpAssignments(createAssignments); + SessionConfig createClone = createConfig.clone(); + assertEquals(createAssignments, createClone.getExpAssignments()); + CreateSessionRequest createRequest = SessionRequestBuilder.buildCreateRequest(createClone, "session-1"); + assertEquals(createAssignments, createRequest.getExpAssignments()); + assertTrue(mapper.writeValueAsString(createRequest).contains("\"Id\":\"exp-create\"")); + + var resumeConfig = new ResumeSessionConfig().setExpAssignments(resumeAssignments); + ResumeSessionConfig resumeClone = resumeConfig.clone(); + assertEquals(resumeAssignments, resumeClone.getExpAssignments()); + ResumeSessionRequest resumeRequest = SessionRequestBuilder.buildResumeRequest("session-1", resumeClone); + assertEquals(resumeAssignments, resumeRequest.getExpAssignments()); + assertTrue(mapper.writeValueAsString(resumeRequest).contains("\"Id\":\"exp-resume\"")); + } + + @Test + void githubMcpToolConfigIsMappedAndSerializedForCreateAndResume() throws Exception { + var config = new GitHubMcpToolConfig().setEnableAllTools(true).setAdditionalToolsets(List.of("repos")) + .setAdditionalTools(List.of("get_issue")).setEnableInsidersMode(true).setDisableFormDeferral(true); + var createRequest = SessionRequestBuilder.buildCreateRequest(new SessionConfig().setGitHubMcpToolConfig(config), + "session-1"); + var resumeRequest = SessionRequestBuilder.buildResumeRequest("session-1", + new ResumeSessionConfig().setGitHubMcpToolConfig(config)); + + assertSame(config, createRequest.getGitHubMcpToolConfig()); + assertSame(config, resumeRequest.getGitHubMcpToolConfig()); + var mapper = JsonRpcClient.getObjectMapper(); + assertTrue(mapper.writeValueAsString(createRequest).contains("\"githubMcpToolConfig\"")); + assertTrue(mapper.writeValueAsString(resumeRequest).contains("\"githubMcpToolConfig\"")); + assertFalse( + mapper.writeValueAsString(SessionRequestBuilder.buildCreateRequest(new SessionConfig(), "session-2")) + .contains("\"githubMcpToolConfig\"")); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/SessionTodosChangedTest.java b/java/sdk/src/test/java/com/github/copilot/SessionTodosChangedTest.java new file mode 100644 index 000000000..deaab391e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SessionTodosChangedTest.java @@ -0,0 +1,79 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.SessionTodosChangedEvent; +import com.github.copilot.generated.rpc.PlanSqlTodoDependency; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +public class SessionTodosChangedTest { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void firesSessionTodosChangedAndExposesRowsAndDependencies() throws Exception { + ctx.configureForTest("session_todos_changed", "fires_session_todos_changed_and_exposes_rows_and_dependencies"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); + + CompletableFuture todosChanged = new CompletableFuture<>(); + session.on(event -> { + if (event instanceof SessionTodosChangedEvent todosEvent && !todosChanged.isDone()) { + todosChanged.complete(todosEvent); + } + }); + + session.sendAndWait(new MessageOptions().setPrompt( + "Use the sql tool exactly once to execute all three of the following statements together, in this exact order, in a single sql tool call (a single query string containing all three statements):\n" + + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n" + + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n" + + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n" + + "Then stop. Do not insert any other rows or create any other tables.")) + .get(120, TimeUnit.SECONDS); + + assertNotNull(todosChanged.get(15, TimeUnit.SECONDS), + "Should have received at least one session.todos_changed event"); + + var result = session.getRpc().plan.readSqlTodosWithDependencies().get(15, TimeUnit.SECONDS); + assertEquals(2, result.rows().size()); + var ids = result.rows().stream().map(row -> row.id()).filter(id -> id != null).sorted().toList(); + + assertEquals(java.util.List.of("alpha", "beta"), ids); + assertTrue(result.dependencies().stream().anyMatch(SessionTodosChangedTest::isBetaDependsOnAlpha), + "Should contain beta -> alpha dependency"); + + session.close(); + } + } + + private static boolean isBetaDependsOnAlpha(PlanSqlTodoDependency dependency) { + return "beta".equals(dependency.todoId()) && "alpha".equals(dependency.dependsOn()); + } +} diff --git a/java/src/test/java/com/github/copilot/SkillsTest.java b/java/sdk/src/test/java/com/github/copilot/SkillsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/SkillsTest.java rename to java/sdk/src/test/java/com/github/copilot/SkillsTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java b/java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java new file mode 100644 index 000000000..5dec06464 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SlashCommandsIT.java @@ -0,0 +1,245 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.concurrent.TimeUnit; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.regex.Pattern; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.e2e.SkipInProcess; + +import com.github.copilot.generated.rpc.SessionCommandsListResult; +import com.github.copilot.generated.rpc.SessionCommandsInvokeParams; +import com.github.copilot.generated.rpc.SlashCommandAgentPromptResult; +import com.github.copilot.generated.rpc.SlashCommandCompletedResult; +import com.github.copilot.generated.rpc.SlashCommandInfo; +import com.github.copilot.generated.rpc.SlashCommandInvocationResult; +import com.github.copilot.generated.rpc.SlashCommandSelectSubcommandResult; +import com.github.copilot.generated.rpc.SlashCommandTextResult; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +/** + * Failsafe integration test that exercises slash commands against the live + * Copilot CLI (not the replay proxy). + *

+ * Requires the CLI to be installed and the user to be signed in. Uses + * {@link TestUtil#findCliPath()} so the test harness binary is found in CI. + */ +@SkipInProcess("Requires a live signed-in CLI subprocess and logged-in-user transport behavior rather than the replayed in-process harness") +class SlashCommandsIT { + + private static CopilotClient client; + private static CopilotSession session; + + @BeforeAll + static void setup() throws Exception { + String cliPath = TestUtil.findCliPath(); + CopilotClientOptions options = new CopilotClientOptions().setCliPath(cliPath).setUseLoggedInUser(true); + client = new CopilotClient(options); + client.start().get(30, TimeUnit.SECONDS); + session = client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS); + } + + @AfterAll + static void teardown() throws Exception { + if (session != null) { + session.close(); + } + if (client != null) { + client.close(); + } + } + + @Test + void listCommandsReturnsAtLeast20() throws Exception { + SessionCommandsListResult result = session.getRpc().commands.list().get(15, TimeUnit.SECONDS); + + assertNotNull(result, "commands.list result must not be null"); + assertNotNull(result.commands(), "commands list must not be null"); + assertTrue(result.commands().size() >= 20, "Expected at least 20 commands but got " + result.commands().size()); + + Pattern namePattern = Pattern.compile("^[a-z].*$"); + + // Print every command so we can pick one for the next iteration + System.out.println("=== Available slash commands ==="); + for (SlashCommandInfo cmd : result.commands()) { + System.out.printf(" /%s kind=%s desc=%s aliases=%s%n", cmd.name(), cmd.kind(), cmd.description(), + cmd.aliases()); + assertTrue(namePattern.matcher(cmd.name()).matches(), + "Command name should match /^[a-z].*$/ but was: " + cmd.name()); + } + System.out.println("=== Total: " + result.commands().size() + " commands ==="); + } + + @Test + void autoPilotToggle() throws Exception { + SlashCommandInvocationResult first = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "autopilot", null)).get(15, TimeUnit.SECONDS); + SlashCommandInvocationResult second = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "autopilot", null)).get(15, TimeUnit.SECONDS); + + String firstOutput = extractDisplayText(first); + String secondOutput = extractDisplayText(second); + + assertTrue(!firstOutput.isBlank(), "First /autopilot invocation should return non-empty output"); + assertTrue(!secondOutput.isBlank(), "Second /autopilot invocation should return non-empty output"); + assertNotEquals(firstOutput, secondOutput, + "Two consecutive /autopilot invocations should produce different output because mode toggles"); + + List firstTokens = tokenizeForComparison(firstOutput); + List secondTokens = tokenizeForComparison(secondOutput); + assertTrue(!firstTokens.isEmpty(), "First /autopilot output should include at least one token"); + assertTrue(!secondTokens.isEmpty(), "Second /autopilot output should include at least one token"); + + List commonInOrder = commonTokensInOrder(firstTokens, secondTokens); + assertTrue(!commonInOrder.isEmpty(), + "Outputs should share at least one token in the same order to indicate similar structure"); + + Set firstOnly = new HashSet<>(firstTokens); + firstOnly.removeAll(new HashSet<>(secondTokens)); + Set secondOnly = new HashSet<>(secondTokens); + secondOnly.removeAll(new HashSet<>(firstTokens)); + assertTrue(!firstOnly.isEmpty() || !secondOnly.isEmpty(), + "Outputs should differ by at least one token to reflect the toggle change"); + + System.out.println("First /autopilot result: " + firstOutput); + System.out.println("Second /autopilot result: " + secondOutput); + } + + @Test + void listDirs() throws Exception { + SlashCommandInvocationResult result = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null)).get(15, TimeUnit.SECONDS); + + String output = extractDisplayText(result); + assertTrue(Pattern.compile("(?s)^.*Total: [0-9]+ directories.*$").matcher(output).matches(), + "Expected /list-dirs output to include total directories count"); + System.out.println("/list-dirs result:"); + System.out.println(output); + } + + @Test + void addDir() throws Exception { + String buildDirectory = System.getProperty("project.build.directory"); + assertNotNull(buildDirectory, "System property 'project.build.directory' must be set by failsafe"); + + Path addDirPath = Path.of(buildDirectory, "addDirTest").toAbsolutePath().normalize(); + Files.createDirectories(addDirPath); + String addDirPathString = addDirPath.toString(); + + SlashCommandInvocationResult beforeListResult = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null)).get(15, TimeUnit.SECONDS); + String beforeListOutput = extractDisplayText(beforeListResult); + System.out.println("/list-dirs (before /add-dir) result:"); + System.out.println(beforeListOutput); + + SlashCommandInvocationResult addDirResult = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "add-dir", addDirPathString)).get(15, TimeUnit.SECONDS); + String addDirOutput = extractDisplayText(addDirResult); + System.out.println("/add-dir result:"); + System.out.println(addDirOutput); + + SlashCommandInvocationResult afterListResult = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "list-dirs", null)).get(15, TimeUnit.SECONDS); + String afterListOutput = extractDisplayText(afterListResult); + System.out.println("/list-dirs (after /add-dir) result:"); + System.out.println(afterListOutput); + + assertTrue(afterListOutput.contains(addDirPathString), + "Expected /list-dirs output to contain added directory path: " + addDirPathString); + } + + @Test + void usage() throws Exception { + SlashCommandInvocationResult result = session.getRpc().commands + .invoke(new SessionCommandsInvokeParams(null, "usage", null)).get(15, TimeUnit.SECONDS); + + String output = extractDisplayText(result); + assertTrue(Pattern.compile("(?s)^.*Changes:.*$").matcher(output).matches(), + "Expected /usage output to include a Changes summary line"); + assertTrue(Pattern.compile("(?s)^.*Requests:.*$").matcher(output).matches(), + "Expected /usage output to include a Requests/AI Units summary line"); + System.out.println("/usage result:"); + System.out.println(output); + } + + private static String extractDisplayText(SlashCommandInvocationResult result) { + assertNotNull(result, "slash command result must not be null"); + + if (result instanceof SlashCommandTextResult textResult) { + return valueOrEmpty(textResult.getText()); + } + if (result instanceof SlashCommandCompletedResult completedResult) { + return valueOrEmpty(completedResult.getMessage()); + } + if (result instanceof SlashCommandAgentPromptResult promptResult) { + String display = valueOrEmpty(promptResult.getDisplayPrompt()); + if (!display.isBlank()) { + return display; + } + return valueOrEmpty(promptResult.getPrompt()); + } + if (result instanceof SlashCommandSelectSubcommandResult selectResult) { + String title = valueOrEmpty(selectResult.getTitle()); + if (!title.isBlank()) { + return title; + } + return valueOrEmpty(selectResult.getCommand()); + } + + return valueOrEmpty(result.getKind()); + } + + private static String valueOrEmpty(String value) { + return value == null ? "" : value.trim(); + } + + private static List tokenizeForComparison(String text) { + List tokens = new ArrayList<>(); + Pattern wordPattern = Pattern.compile("[\\p{L}\\p{N}]+", Pattern.UNICODE_CHARACTER_CLASS); + var matcher = wordPattern.matcher(text.toLowerCase(Locale.ROOT)); + while (matcher.find()) { + tokens.add(matcher.group()); + } + return tokens; + } + + private static List commonTokensInOrder(List first, List second) { + List common = new ArrayList<>(); + int secondIndex = 0; + + for (String token : first) { + while (secondIndex < second.size()) { + String candidate = second.get(secondIndex++); + if (token.equals(candidate)) { + common.add(token); + break; + } + } + if (secondIndex >= second.size()) { + break; + } + } + + return common; + } +} diff --git a/java/src/test/java/com/github/copilot/StreamingFidelityTest.java b/java/sdk/src/test/java/com/github/copilot/StreamingFidelityTest.java similarity index 86% rename from java/src/test/java/com/github/copilot/StreamingFidelityTest.java rename to java/sdk/src/test/java/com/github/copilot/StreamingFidelityTest.java index 631496a8f..3701cf9c1 100644 --- a/java/src/test/java/com/github/copilot/StreamingFidelityTest.java +++ b/java/sdk/src/test/java/com/github/copilot/StreamingFidelityTest.java @@ -249,33 +249,37 @@ void testShouldNotProduceDeltasAfterSessionResumeWithStreamingDisabled() throws */ @Test void testShouldEmitStreamingDeltasWithReasoningEffortConfigured() throws Exception { - ctx.configureForTest("streaming_fidelity", "should_emit_streaming_deltas_with_reasoning_effort_configured"); + try (E2ETestContext isolatedContext = E2ETestContext.create()) { + isolatedContext.configureForTest("streaming_fidelity", + "should_emit_streaming_deltas_with_reasoning_effort_configured"); - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client - .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) - .setStreaming(true).setReasoningEffort("high")) - .get(); + try (CopilotClient client = isolatedContext.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setModel("gpt-5.4").setStreaming(true).setReasoningEffort("high")) + .get(); - List events = new ArrayList<>(); - session.on(events::add); + List events = new ArrayList<>(); + session.on(events::add); - session.sendAndWait(new MessageOptions().setPrompt("What is 15 * 17?")).get(60, TimeUnit.SECONDS); + session.sendAndWait(new MessageOptions().setPrompt("What is 15 * 17?")).get(60, TimeUnit.SECONDS); - // With streaming + reasoning effort, we should still get content deltas - List deltaEvents = events.stream() - .filter(e -> e instanceof AssistantMessageDeltaEvent).map(e -> (AssistantMessageDeltaEvent) e) - .toList(); - assertFalse(deltaEvents.isEmpty(), "Should have received delta events with reasoning effort configured"); + // With streaming + reasoning effort, we should still get content deltas + List deltaEvents = events.stream() + .filter(e -> e instanceof AssistantMessageDeltaEvent).map(e -> (AssistantMessageDeltaEvent) e) + .toList(); + assertFalse(deltaEvents.isEmpty(), + "Should have received delta events with reasoning effort configured"); - // And a final assistant.message with the answer - List assistantEvents = events.stream() - .filter(e -> e instanceof AssistantMessageEvent).map(e -> (AssistantMessageEvent) e).toList(); - assertFalse(assistantEvents.isEmpty(), "Should have received assistant message events"); - assertTrue(assistantEvents.get(assistantEvents.size() - 1).getData().content().contains("255"), - "Response should contain 255"); + // And a final assistant.message with the answer + List assistantEvents = events.stream() + .filter(e -> e instanceof AssistantMessageEvent).map(e -> (AssistantMessageEvent) e).toList(); + assertFalse(assistantEvents.isEmpty(), "Should have received assistant message events"); + assertTrue(assistantEvents.get(assistantEvents.size() - 1).getData().content().contains("255"), + "Response should contain 255"); - session.close(); + session.close(); + } } } } diff --git a/java/sdk/src/test/java/com/github/copilot/SubagentHooksE2ETest.java b/java/sdk/src/test/java/com/github/copilot/SubagentHooksE2ETest.java new file mode 100644 index 000000000..c2ad45ff2 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SubagentHooksE2ETest.java @@ -0,0 +1,125 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import java.io.InputStream; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.file.Files; +import java.util.HashMap; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.PostToolUseHookOutput; +import com.github.copilot.rpc.PreToolUseHookOutput; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SessionHooks; + +public class SubagentHooksE2ETest { + + private static final String SNAPSHOT_NAME = "should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls"; + + @Test + void shouldInvokePreToolUseAndPostToolUseHooksForSubAgentToolCalls() throws Exception { + try (E2ETestContext ctx = E2ETestContext.create()) { + ctx.configureForTest("subagent_hooks", SNAPSHOT_NAME); + + ConcurrentLinkedQueue hookLog = new ConcurrentLinkedQueue<>(); + RecordingForwardingRequestHandler requestHandler = new RecordingForwardingRequestHandler(); + HashMap env = new HashMap<>(ctx.getEnvironment()); + env.put("COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS", "true"); + + try (CopilotClient client = ctx + .createClient(new CopilotClientOptions().setEnvironment(env).setRequestHandler(requestHandler))) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { + hookLog.add(new HookEntry("pre", input.getToolName(), input.getSessionId())); + return CompletableFuture.completedFuture(PreToolUseHookOutput.allow()); + }).setOnPostToolUse((input, invocation) -> { + hookLog.add(new HookEntry("post", input.getToolName(), input.getSessionId())); + return CompletableFuture.completedFuture((PostToolUseHookOutput) null); + }))) + .get(); + try { + Files.writeString(ctx.getWorkDir().resolve("subagent-test.txt"), "Hello from subagent test!"); + session.sendAndWait(new MessageOptions() + .setPrompt("Use the task tool to spawn an explore agent that reads the file " + + "subagent-test.txt in the current directory and reports its contents. " + + "You must use the task tool.")) + .get(120, TimeUnit.SECONDS); + + HookEntry taskPre = hookLog.stream() + .filter(h -> h.kind().equals("pre") && h.toolName().equals("task")).findFirst() + .orElse(null); + assertNotNull(taskPre, "preToolUse should fire for the parent's 'task' tool call"); + + List viewPre = hookLog.stream() + .filter(h -> h.kind().equals("pre") && h.toolName().equals("view")).toList(); + List viewPost = hookLog.stream() + .filter(h -> h.kind().equals("post") && h.toolName().equals("view")).toList(); + assertFalse(viewPre.isEmpty(), "preToolUse should fire for the sub-agent's 'view' tool call"); + assertFalse(viewPost.isEmpty(), "postToolUse should fire for the sub-agent's 'view' tool call"); + assertNotEquals(taskPre.sessionId(), viewPre.get(0).sessionId(), + "Sub-agent tool hooks should have a different sessionId than parent tool hooks"); + assertSubagentRequestMetadata(requestHandler.inferenceRequests()); + } finally { + session.close(); + } + } + } + } + + private static void assertSubagentRequestMetadata(List records) { + assertFalse(records.isEmpty(), "request handler should observe inference requests"); + RequestRecord subagentRequest = records.stream() + .filter(r -> r.parentAgentId() != null && !r.parentAgentId().isEmpty()).findFirst().orElse(null); + assertNotNull(subagentRequest, "sub-agent inference request should carry a parentAgentId"); + assertFalse(subagentRequest.agentId() == null || subagentRequest.agentId().isEmpty(), + "sub-agent inference request should carry an agentId"); + assertFalse(subagentRequest.interactionType() == null || subagentRequest.interactionType().isEmpty(), + "sub-agent inference request should carry an interactionType"); + assertNotEquals(subagentRequest.parentAgentId(), subagentRequest.agentId()); + } + + private static boolean isInferenceUrl(String url) { + String u = url.toLowerCase(); + return u.endsWith("/chat/completions") || u.endsWith("/responses") || u.endsWith("/v1/messages") + || u.endsWith("/messages"); + } + + private record HookEntry(String kind, String toolName, String sessionId) { + } + + private record RequestRecord(String url, String agentId, String parentAgentId, String interactionType) { + } + + private static final class RecordingForwardingRequestHandler extends CopilotRequestHandler { + private final ConcurrentLinkedQueue records = new ConcurrentLinkedQueue<>(); + + List inferenceRequests() { + return records.stream().filter(r -> isInferenceUrl(r.url())).toList(); + } + + @Override + protected HttpResponse sendRequest(HttpRequest request, CopilotRequestContext ctx) + throws Exception { + records.add(new RequestRecord(request.uri().toString(), ctx.agentId(), ctx.parentAgentId(), + ctx.interactionType())); + return super.sendRequest(request, ctx); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/SystemMessageSectionsIT.java b/java/sdk/src/test/java/com/github/copilot/SystemMessageSectionsIT.java new file mode 100644 index 000000000..1541af279 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/SystemMessageSectionsIT.java @@ -0,0 +1,230 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SectionOverride; +import com.github.copilot.rpc.SectionOverrideAction; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.SystemMessageConfig; +import com.github.copilot.rpc.SystemMessageSections; +import com.github.copilot.rpc.SystemPromptSections; + +/** + * Failsafe integration test that validates {@link SystemMessageSections} + * constants work correctly with the Copilot CLI via the replay proxy, and that + * the deprecated {@link SystemPromptSections} inherits all constants. + * + * @see Snapshot: + * system_message_transform/should_invoke_transform_callbacks_with_section_content + */ +@SuppressWarnings("deprecation") +class SystemMessageSectionsIT { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + /** + * Verifies that transform callbacks on {@link SystemMessageSections#IDENTITY} + * and {@link SystemMessageSections#TONE} are invoked by the runtime with + * non-empty section content via the replay proxy. + * + * @see Snapshot: + * system_message_transform/should_invoke_transform_callbacks_with_section_content + */ + @Test + void transformOnIdentitySectionReceivesNonEmptyContent() throws Exception { + ctx.configureForTest("system_message_transform", "should_invoke_transform_callbacks_with_section_content"); + + ConcurrentHashMap capturedContent = new ConcurrentHashMap<>(); + + var systemMessage = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE) + .setSections(Map.of(SystemMessageSections.IDENTITY, new SectionOverride().setTransform(content -> { + capturedContent.put("identity", content); + return CompletableFuture.completedFuture(content); + }), SystemMessageSections.TONE, new SectionOverride().setTransform(content -> { + capturedContent.put("tone", content); + return CompletableFuture.completedFuture(content); + }))); + + try (CopilotClient client = ctx.createClient()) { + // Create the file the snapshot expects the CLI view tool to read + Path testFile = ctx.getWorkDir().resolve("test.txt"); + Files.writeString(testFile, "Hello transform!"); + + CopilotSession session = client.createSession(new SessionConfig().setSystemMessage(systemMessage) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions() + .setPrompt("Read the contents of test.txt and tell me what it says"), 60_000) + .get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + + String identityContent = capturedContent.get("identity"); + assertNotNull(identityContent, "Expected identity transform callback to be invoked by the runtime"); + assertTrue(!identityContent.isBlank(), + "Expected identity section content to be non-empty but was blank"); + + String toneContent = capturedContent.get("tone"); + assertNotNull(toneContent, "Expected tone transform callback to be invoked by the runtime"); + assertTrue(!toneContent.isBlank(), "Expected tone section content to be non-empty but was blank"); + } finally { + session.close(); + } + } + } + + /** + * Verifies that the deprecated {@link SystemPromptSections} constants resolve + * to the same values as {@link SystemMessageSections}. + */ + @Test + void deprecatedSystemPromptSectionsMatchesSystemMessageSections() { + assertEquals(SystemMessageSections.PREAMBLE, SystemPromptSections.PREAMBLE); + assertEquals(SystemMessageSections.IDENTITY, SystemPromptSections.IDENTITY); + assertEquals(SystemMessageSections.TONE, SystemPromptSections.TONE); + assertEquals(SystemMessageSections.TOOL_EFFICIENCY, SystemPromptSections.TOOL_EFFICIENCY); + assertEquals(SystemMessageSections.ENVIRONMENT_CONTEXT, SystemPromptSections.ENVIRONMENT_CONTEXT); + assertEquals(SystemMessageSections.CODE_CHANGE_RULES, SystemPromptSections.CODE_CHANGE_RULES); + assertEquals(SystemMessageSections.GUIDELINES, SystemPromptSections.GUIDELINES); + assertEquals(SystemMessageSections.SAFETY, SystemPromptSections.SAFETY); + assertEquals(SystemMessageSections.TOOL_INSTRUCTIONS, SystemPromptSections.TOOL_INSTRUCTIONS); + assertEquals(SystemMessageSections.CUSTOM_INSTRUCTIONS, SystemPromptSections.CUSTOM_INSTRUCTIONS); + assertEquals(SystemMessageSections.RUNTIME_INSTRUCTIONS, SystemPromptSections.RUNTIME_INSTRUCTIONS); + assertEquals(SystemMessageSections.LAST_INSTRUCTIONS, SystemPromptSections.LAST_INSTRUCTIONS); + } + + /** + * Verifies sealed hierarchy and exhaustive constant inheritance. + */ + @Test + void allConstantsInheritedByDeprecatedClass() throws Exception { + assertEquals(SystemMessageSections.class, SystemPromptSections.class.getSuperclass()); + + Set parentConstants = Arrays.stream(SystemMessageSections.class.getDeclaredFields()) + .filter(f -> Modifier.isPublic(f.getModifiers()) && Modifier.isStatic(f.getModifiers()) + && Modifier.isFinal(f.getModifiers()) && f.getType() == String.class) + .map(Field::getName).collect(Collectors.toSet()); + + assertEquals(12, parentConstants.size(), "Expected 12 section constants in SystemMessageSections"); + + for (String constantName : parentConstants) { + Field parentField = SystemMessageSections.class.getDeclaredField(constantName); + Field childField = SystemPromptSections.class.getField(constantName); + assertEquals(parentField.get(null), childField.get(null), + "Constant " + constantName + " should have same value in both classes"); + } + } + + /** + * Verifies that replacing the {@link SystemMessageSections#IDENTITY} section + * via {@link SectionOverrideAction#REPLACE} causes the assistant to adopt the + * custom identity in its response. + * + * @see Snapshot: + * system_message_sections/should_use_replaced_identity_section_in_response + */ + @Test + void shouldUseReplacedIdentitySectionInResponse() throws Exception { + ctx.configureForTest("system_message_sections", "should_use_replaced_identity_section_in_response"); + + var systemMessage = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE) + .setSections(Map.of(SystemMessageSections.IDENTITY, + new SectionOverride().setAction(SectionOverrideAction.REPLACE) + .setContent("You are a helpful gardening assistant called Botanica. " + + "You only answer questions about plants and gardening."))); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(new SessionConfig().setSystemMessage(systemMessage) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Who are you?"), 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("botanica") || content.contains("garden") || content.contains("plant"), + "Expected response to reflect the replaced identity section, but got: " + + response.getData().content()); + } finally { + session.close(); + } + } + } + + /** + * Verifies that replacing the {@link SystemMessageSections#PREAMBLE} section + * via {@link SectionOverrideAction#REPLACE} causes the assistant to adopt the + * custom identity in its response without affecting sibling sections. + * + * @see Snapshot: + * system_message_sections/should_use_replaced_preamble_section_in_response + */ + @Test + void shouldUseReplacedPreambleSectionInResponse() throws Exception { + ctx.configureForTest("system_message_sections", "should_use_replaced_preamble_section_in_response"); + + var systemMessage = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE) + .setSections(Map.of(SystemMessageSections.PREAMBLE, + new SectionOverride().setAction(SectionOverrideAction.REPLACE) + .setContent("You are a helpful gardening assistant called Botanica. " + + "You only answer questions about plants and gardening."))); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client.createSession(new SessionConfig().setSystemMessage(systemMessage) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Who are you?"), 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("botanica") || content.contains("garden") || content.contains("plant"), + "Expected response to reflect the replaced preamble section, but got: " + + response.getData().content()); + } finally { + session.close(); + } + } + } +} diff --git a/java/src/test/java/com/github/copilot/TelemetryConfigTest.java b/java/sdk/src/test/java/com/github/copilot/TelemetryConfigTest.java similarity index 82% rename from java/src/test/java/com/github/copilot/TelemetryConfigTest.java rename to java/sdk/src/test/java/com/github/copilot/TelemetryConfigTest.java index 2dd41c28a..739d6a510 100644 --- a/java/src/test/java/com/github/copilot/TelemetryConfigTest.java +++ b/java/sdk/src/test/java/com/github/copilot/TelemetryConfigTest.java @@ -19,6 +19,7 @@ class TelemetryConfigTest { void defaultValuesAreNull() { var config = new TelemetryConfig(); assertNull(config.getOtlpEndpoint()); + assertNull(config.getOtlpProtocol()); assertNull(config.getFilePath()); assertNull(config.getExporterType()); assertNull(config.getSourceName()); @@ -32,6 +33,13 @@ void otlpEndpointGetterSetter() { assertEquals("http://localhost:4318", config.getOtlpEndpoint()); } + @Test + void otlpProtocolGetterSetter() { + var config = new TelemetryConfig(); + config.setOtlpProtocol("http/protobuf"); + assertEquals("http/protobuf", config.getOtlpProtocol()); + } + @Test void filePathGetterSetter() { var config = new TelemetryConfig(); @@ -65,10 +73,12 @@ void captureContentGetterSetter() { @Test void fluentChainingReturnsThis() { - var config = new TelemetryConfig().setOtlpEndpoint("http://localhost:4318").setFilePath("/tmp/spans.json") - .setExporterType("file").setSourceName("sdk-test").setCaptureContent(true); + var config = new TelemetryConfig().setOtlpEndpoint("http://localhost:4318").setOtlpProtocol("http/protobuf") + .setFilePath("/tmp/spans.json").setExporterType("file").setSourceName("sdk-test") + .setCaptureContent(true); assertEquals("http://localhost:4318", config.getOtlpEndpoint()); + assertEquals("http/protobuf", config.getOtlpProtocol()); assertEquals("/tmp/spans.json", config.getFilePath()); assertEquals("file", config.getExporterType()); assertEquals("sdk-test", config.getSourceName()); diff --git a/java/sdk/src/test/java/com/github/copilot/TestProcess.java b/java/sdk/src/test/java/com/github/copilot/TestProcess.java new file mode 100644 index 000000000..f7187ae67 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/TestProcess.java @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import java.io.InputStream; +import java.io.OutputStream; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +final class TestProcess extends Process { + + private final CountDownLatch terminated = new CountDownLatch(1); + + @Override + public OutputStream getOutputStream() { + return OutputStream.nullOutputStream(); + } + + @Override + public InputStream getInputStream() { + return InputStream.nullInputStream(); + } + + @Override + public InputStream getErrorStream() { + return InputStream.nullInputStream(); + } + + @Override + public int waitFor() throws InterruptedException { + terminated.await(); + return 0; + } + + @Override + public boolean waitFor(long timeout, TimeUnit unit) throws InterruptedException { + return terminated.await(timeout, unit); + } + + @Override + public int exitValue() { + if (isAlive()) { + throw new IllegalThreadStateException("Process has not exited"); + } + return 0; + } + + @Override + public void destroy() { + terminated.countDown(); + } + + @Override + public Process destroyForcibly() { + destroy(); + return this; + } + + @Override + public boolean isAlive() { + return terminated.getCount() > 0; + } +} diff --git a/java/src/test/java/com/github/copilot/TestUtil.java b/java/sdk/src/test/java/com/github/copilot/TestUtil.java similarity index 76% rename from java/src/test/java/com/github/copilot/TestUtil.java rename to java/sdk/src/test/java/com/github/copilot/TestUtil.java index cadef040b..23bb53e49 100644 --- a/java/src/test/java/com/github/copilot/TestUtil.java +++ b/java/sdk/src/test/java/com/github/copilot/TestUtil.java @@ -40,7 +40,7 @@ public static String tempPath(String filename) { *

  • Otherwise search the system PATH using {@code where.exe} (Windows) or * {@code which} (Linux/macOS).
    • *
  • Walk parent directories looking for - * {@code nodejs/node_modules/@github/copilot/index.js}.
    • + * {@code nodejs/node_modules/@github/copilot/npm-loader.js}. * * *

    @@ -65,9 +65,32 @@ static String findCliPath() { return copilotInPath; } + // Walk parent directories looking for the CLI in the test harness or nodejs + // installation. Mirrors the resolution order in E2ETestContext.getCliPath(). + String os = System.getProperty("os.name").toLowerCase(); + String arch = System.getProperty("os.arch").toLowerCase(); + String platform = os.contains("mac") ? "darwin" : os.contains("win") ? "win32" : "linux"; + String cpuArch = arch.contains("aarch64") || arch.contains("arm64") ? "arm64" : "x64"; + String binaryName = os.contains("win") ? "copilot.exe" : "copilot"; + Path current = Paths.get(System.getProperty("user.dir")); while (current != null) { - Path cliPath = current.resolve("nodejs/node_modules/@github/copilot/index.js"); + // Test harness platform-specific binary + Path platformBinary = current.resolve( + "test/harness/node_modules/@github/copilot-" + platform + "-" + cpuArch + "/" + binaryName); + if (platformBinary.toFile().exists()) { + return platformBinary.toString(); + } + + // Test harness npm-loader.js + Path npmLoader = current.resolve("test/harness/node_modules/@github/copilot/npm-loader.js"); + if (npmLoader.toFile().exists()) { + return npmLoader.toString(); + } + + // nodejs installation (thin loader; resolves the platform-specific + // CLI package internally) + Path cliPath = current.resolve("nodejs/node_modules/@github/copilot/npm-loader.js"); if (cliPath.toFile().exists()) { return cliPath.toString(); } diff --git a/java/src/test/java/com/github/copilot/TimeoutEdgeCaseTest.java b/java/sdk/src/test/java/com/github/copilot/TimeoutEdgeCaseTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/TimeoutEdgeCaseTest.java rename to java/sdk/src/test/java/com/github/copilot/TimeoutEdgeCaseTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/ToolDefinitionTest.java b/java/sdk/src/test/java/com/github/copilot/ToolDefinitionTest.java new file mode 100644 index 000000000..66c9f9ec8 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ToolDefinitionTest.java @@ -0,0 +1,131 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; + +import com.github.copilot.rpc.ToolDefer; +import com.github.copilot.rpc.ToolDefinition; + +/** + * Unit tests for {@link ToolDefinition} JSON serialization. + */ +public class ToolDefinitionTest { + + private static final ObjectMapper MAPPER = JsonRpcClient.getObjectMapper(); + + private static Map schema() { + return Map.of("type", "object", "properties", + Map.of("query", Map.of("type", "string", "description", "Search query")), "required", List.of("query")); + } + + @Test + void testDeferIsSerialized() throws Exception { + ToolDefinition tool = ToolDefinition.createWithDefer("lookup_issue", "Fetch issue details", schema(), + invocation -> CompletableFuture.completedFuture("ok"), ToolDefer.AUTO); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertEquals("auto", json.get("defer").asText()); + } + + @Test + void testDeferOmittedWhenNull() throws Exception { + ToolDefinition tool = ToolDefinition.create("lookup_issue", "Fetch issue details", schema(), + invocation -> CompletableFuture.completedFuture("ok")); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertFalse(json.has("defer")); + } + + @Test + void testDeferNeverIsSerialized() throws Exception { + ToolDefinition tool = ToolDefinition.createWithDefer("lookup_issue", "Fetch issue details", schema(), + invocation -> CompletableFuture.completedFuture("ok"), ToolDefer.NEVER); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertEquals("never", json.get("defer").asText()); + } + + @Test + void testMetadataIsSerialized() throws Exception { + Map metadata = Map.of("github.com/copilot:safeForTelemetry", + Map.of("name", true, "inputsNames", false)); + ToolDefinition tool = ToolDefinition.createWithMetadata("my_tool", "A tool", schema(), + invocation -> CompletableFuture.completedFuture("ok"), metadata); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertTrue(json.has("metadata")); + assertTrue(json.get("metadata").has("github.com/copilot:safeForTelemetry")); + } + + @Test + void testMetadataOmittedWhenNull() throws Exception { + ToolDefinition tool = ToolDefinition.create("my_tool", "A tool", schema(), + invocation -> CompletableFuture.completedFuture("ok")); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertFalse(json.has("metadata")); + } + + @Test + void testSevenArgConstructorLeavesMetadataNull() throws Exception { + ToolDefinition tool = new ToolDefinition("my_tool", "A tool", schema(), + invocation -> CompletableFuture.completedFuture("ok"), null, null, null); + + assertNull(tool.metadata()); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertFalse(json.has("metadata")); + } + + @Test + void testMetadataCopyMethodSerializes() throws Exception { + Map metadata = Map.of("github.com/copilot:safeForTelemetry", + Map.of("name", true, "inputsNames", false)); + ToolDefinition tool = ToolDefinition + .create("my_tool", "A tool", schema(), invocation -> CompletableFuture.completedFuture("ok")) + .metadata(metadata); + + assertEquals(metadata, tool.metadata()); + + ObjectNode json = (ObjectNode) MAPPER.readTree(MAPPER.writeValueAsString(tool)); + + assertTrue(json.get("metadata").has("github.com/copilot:safeForTelemetry")); + } + + @Test + void testChainingFlagsPreservesMetadata() throws Exception { + Map metadata = Map.of("github.com/copilot:safeForTelemetry", Map.of("name", true)); + + ToolDefinition metadataFirst = ToolDefinition + .create("my_tool", "A tool", schema(), invocation -> CompletableFuture.completedFuture("ok")) + .metadata(metadata).overridesBuiltInTool(true).skipPermission(true).defer(ToolDefer.NEVER); + + ToolDefinition flagsFirst = ToolDefinition + .create("my_tool", "A tool", schema(), invocation -> CompletableFuture.completedFuture("ok")) + .overridesBuiltInTool(true).skipPermission(true).defer(ToolDefer.NEVER).metadata(metadata); + + assertEquals(metadata, metadataFirst.metadata()); + assertEquals(metadata, flagsFirst.metadata()); + assertEquals(Boolean.TRUE, flagsFirst.overridesBuiltInTool()); + assertEquals(Boolean.TRUE, flagsFirst.skipPermission()); + assertEquals(ToolDefer.NEVER, flagsFirst.defer()); + } +} diff --git a/java/src/test/java/com/github/copilot/ToolInvocationTest.java b/java/sdk/src/test/java/com/github/copilot/ToolInvocationTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ToolInvocationTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolInvocationTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java b/java/sdk/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java new file mode 100644 index 000000000..3f08cae94 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ToolResultObjectSerializationTest.java @@ -0,0 +1,68 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot; + +import static org.junit.jupiter.api.Assertions.*; + +import java.util.List; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.rpc.ToolResultObject; + +/** + * Verifies JSON (de)serialization of the {@code toolReferences} field on + * {@link ToolResultObject}, including that it is omitted when {@code null} (via + * {@code @JsonInclude(NON_NULL)}) and preserved by the backward-compatible + * six-argument constructor. + */ +class ToolResultObjectSerializationTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @Test + void serializesToolReferences() { + var result = new ToolResultObject("success", "found 2 tools", null, null, null, null, + List.of("get_weather", "check_status")); + + JsonNode node = MAPPER.valueToTree(result); + + assertEquals("found 2 tools", node.get("textResultForLlm").asText()); + JsonNode refs = node.get("toolReferences"); + assertNotNull(refs); + assertTrue(refs.isArray()); + assertEquals(2, refs.size()); + assertEquals("get_weather", refs.get(0).asText()); + assertEquals("check_status", refs.get(1).asText()); + } + + @Test + void omitsToolReferencesWhenNull() { + JsonNode node = MAPPER.valueToTree(ToolResultObject.success("ok")); + + assertFalse(node.has("toolReferences")); + } + + @Test + void sixArgConstructorLeavesToolReferencesNull() { + var result = new ToolResultObject("success", "ok", null, null, null, null); + + assertNull(result.toolReferences()); + assertFalse(MAPPER.valueToTree(result).has("toolReferences")); + } + + @Test + void deserializesToolReferences() throws Exception { + String json = "{\"resultType\":\"success\",\"textResultForLlm\":\"x\"," + + "\"toolReferences\":[\"alpha\",\"beta\"]}"; + + ToolResultObject result = MAPPER.readValue(json, ToolResultObject.class); + + assertEquals(List.of("alpha", "beta"), result.toolReferences()); + } +} diff --git a/java/src/test/java/com/github/copilot/ToolResultsTest.java b/java/sdk/src/test/java/com/github/copilot/ToolResultsTest.java similarity index 98% rename from java/src/test/java/com/github/copilot/ToolResultsTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolResultsTest.java index 54216d921..8278fdf28 100644 --- a/java/src/test/java/com/github/copilot/ToolResultsTest.java +++ b/java/sdk/src/test/java/com/github/copilot/ToolResultsTest.java @@ -68,7 +68,7 @@ void testShouldHandleToolResultWithRejectedResultType() throws Exception { toolHandlerCalled[0] = true; return CompletableFuture.completedFuture(new ToolResultObject("rejected", "Deployment rejected: policy violation - production deployments require approval", null, - null, null, null)); + null, null, null, null)); }); try (CopilotClient client = ctx.createClient()) { @@ -116,7 +116,7 @@ void testShouldHandleToolResultWithDeniedResultType() throws Exception { (invocation) -> { toolHandlerCalled[0] = true; return CompletableFuture.completedFuture(new ToolResultObject("denied", - "Access denied: insufficient permissions to read secrets", null, null, null, null)); + "Access denied: insufficient permissions to read secrets", null, null, null, null, null)); }); try (CopilotClient client = ctx.createClient()) { diff --git a/java/src/test/java/com/github/copilot/ToolSetTest.java b/java/sdk/src/test/java/com/github/copilot/ToolSetTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ToolSetTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolSetTest.java diff --git a/java/src/test/java/com/github/copilot/ToolsTest.java b/java/sdk/src/test/java/com/github/copilot/ToolsTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ToolsTest.java rename to java/sdk/src/test/java/com/github/copilot/ToolsTest.java diff --git a/java/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java b/java/sdk/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java rename to java/sdk/src/test/java/com/github/copilot/UpdateSessionOptionsForModeTest.java diff --git a/java/src/test/java/com/github/copilot/ZeroTimeoutContractTest.java b/java/sdk/src/test/java/com/github/copilot/ZeroTimeoutContractTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/ZeroTimeoutContractTest.java rename to java/sdk/src/test/java/com/github/copilot/ZeroTimeoutContractTest.java diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java new file mode 100644 index 000000000..56b8b281e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools$$CopilotToolMeta.java @@ -0,0 +1,68 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.e2e; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class ErgonomicTestTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(ErgonomicTestTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("set_current_phase", "Sets the current phase of the agent", + Map.of("type", "object", "properties", + Map.ofEntries(Map.entry("phase", + (Map) (Map) withMeta(Map.of("type", "string"), + "The phase to transition to", null))), + "required", List.of("phase")), + invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + return CompletableFuture.completedFuture(instance.setCurrentPhase(phase)); + }, null, null, null, null), + new ToolDefinition( + "search_items", "Search for items by keyword", Map + .of("type", "object", "properties", + Map.ofEntries(Map.entry("keyword", + (Map) (Map) withMeta(Map.of("type", "string"), + "Search keyword", null))), + "required", List.of("keyword")), + invocation -> { + Map args = invocation.getArguments(); + String keyword = (String) args.get("keyword"); + return CompletableFuture.completedFuture(instance.searchItems(keyword)); + }, null, null, null, null), + new ToolDefinition("get_status", "Returns the current status", + Map.of("type", "object", "properties", Map.of(), "required", List.of()), invocation -> { + return CompletableFuture.completedFuture(instance.getStatus()); + }, null, null, null, null), + new ToolDefinition("combine_values", "Combines two values into a single string", Map.of( + "type", "object", "properties", Map + .ofEntries( + Map.entry("value1", + (Map) (Map) withMeta(Map.of("type", "string"), + "First value", null)), + Map.entry("value2", + (Map) (Map) withMeta(Map.of("type", "string"), + "Second value", null))), + "required", List.of("value1", "value2")), invocation -> { + Map args = invocation.getArguments(); + String value1 = (String) args.get("value1"); + String value2 = (String) args.get("value2"); + return CompletableFuture.completedFuture(instance.combineValues(value1, value2)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java new file mode 100644 index 000000000..15b2c087a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicTestTools.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Tool fixture for the ergonomic {@code @CopilotTool} E2E integration test. + * + *

    + * This class exercises the annotation-based tool definition API, producing + * identical wire-level tool schemas to the low-level + * {@code ToolDefinition.create()} API. + */ +class ErgonomicTestTools { + + String currentPhase; + + @CopilotTool("Sets the current phase of the agent") + public String setCurrentPhase(@CopilotToolParam("The phase to transition to") String phase) { + currentPhase = phase; + return "Phase set to " + phase; + } + + @CopilotTool("Search for items by keyword") + public String searchItems(@CopilotToolParam("Search keyword") String keyword) { + return "Found: " + keyword + " -> item_alpha, item_beta"; + } + + @CopilotTool("Returns the current status") + public String getStatus() { + return "Status: OK"; + } + + @CopilotTool("Combines two values into a single string") + public String combineValues(@CopilotToolParam("First value") String value1, + @CopilotToolParam("Second value") String value2) { + return "combined: " + value1 + " + " + value2; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java new file mode 100644 index 000000000..412acd4c4 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/ErgonomicToolDefinitionIT.java @@ -0,0 +1,245 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.CopilotClient; +import com.github.copilot.CopilotSession; +import com.github.copilot.E2ETestContext; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.rpc.ToolSet; +import com.github.copilot.tool.Param; + +/** + * Failsafe integration test for the ergonomic {@code @CopilotTool} + + * {@code ToolDefinition.fromObject()} API. + * + *

    + * This test proves that the ergonomic annotation-based API produces identical + * wire behavior to the low-level {@code ToolDefinition.create()} API tested in + * {@code LowLevelToolDefinitionIT}. + * + * @see Snapshot: tools/ergonomic_tool_definition + */ +class ErgonomicToolDefinitionIT { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void ergonomicToolDefinition() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_definition"); + + ErgonomicTestTools tools = new ErgonomicTestTools(); + List toolDefs = ToolDefinition.fromObject(tools); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*").addBuiltIn("web_fetch")).setTools(toolDefs)) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session.sendAndWait(new MessageOptions().setPrompt( + "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results."), + 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("analyzing"), + "Response should contain the updated phase: " + response.getData().content()); + assertTrue(content.contains("item_alpha") || content.contains("item_beta"), + "Response should contain search results: " + response.getData().content()); + assertTrue("analyzing".equals(tools.currentPhase), + "Expected currentPhase to be 'analyzing' but was: " + tools.currentPhase); + } finally { + session.close(); + } + } + } + + @Test + void ergonomicToolArity0() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_arity0"); + + ErgonomicTestTools tools = new ErgonomicTestTools(); + List toolDefs = ToolDefinition.fromObject(tools); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*")).setTools(toolDefs)) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Call get_status and tell me the result."), 60_000) + .get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("ok"), + "Response should mention the status: " + response.getData().content()); + } finally { + session.close(); + } + } + } + + @Test + void ergonomicToolArity2() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_arity2"); + + ErgonomicTestTools tools = new ErgonomicTestTools(); + List toolDefs = ToolDefinition.fromObject(tools); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*")).setTools(toolDefs)) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session.sendAndWait( + new MessageOptions().setPrompt( + "Call combine_values with 'alpha' and 'beta', then report the combined result."), + 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("alpha") && content.contains("beta"), + "Response should contain the combined values: " + response.getData().content()); + } finally { + session.close(); + } + } + } + + @Test + void lambdaToolArity0() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_arity0"); + + ToolDefinition getStatus = ToolDefinition.from("get_status", "Returns the current status", () -> "Status: OK"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*")).setTools(List.of(getStatus))) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt("Call get_status and tell me the result."), 60_000) + .get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("ok"), + "Response should mention the status: " + response.getData().content()); + } finally { + session.close(); + } + } + } + + @Test + void lambdaToolArity2() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_arity2"); + + ToolDefinition combineValues = ToolDefinition.from("combine_values", "Combines two values into a single string", + Param.of(String.class, "value1", "First value"), Param.of(String.class, "value2", "Second value"), + (v1, v2) -> "combined: " + v1 + " + " + v2); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*")).setTools(List.of(combineValues))) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session.sendAndWait( + new MessageOptions().setPrompt( + "Call combine_values with 'alpha' and 'beta', then report the combined result."), + 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("alpha") && content.contains("beta"), + "Response should contain the combined values: " + response.getData().content()); + } finally { + session.close(); + } + } + } + + @Test + void lambdaToolDefinition() throws Exception { + ctx.configureForTest("tools", "ergonomic_tool_definition"); + + class LambdaTools { + String currentPhase; + } + LambdaTools tools = new LambdaTools(); + + ToolDefinition setCurrentPhase = ToolDefinition.from("set_current_phase", "Sets the current phase of the agent", + Param.of(String.class, "phase", "The phase to transition to"), phase -> { + tools.currentPhase = phase; + return "Phase set to " + phase; + }); + + ToolDefinition searchItems = ToolDefinition.from("search_items", "Search for items by keyword", + Param.of(String.class, "keyword", "Search keyword"), + keyword -> "Found: " + keyword + " -> item_alpha, item_beta"); + + try (CopilotClient client = ctx.createClient()) { + CopilotSession session = client + .createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) + .setAvailableTools(new ToolSet().addCustom("*").addBuiltIn("web_fetch")) + .setTools(List.of(setCurrentPhase, searchItems))) + .get(30, TimeUnit.SECONDS); + + try { + AssistantMessageEvent response = session.sendAndWait(new MessageOptions().setPrompt( + "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results."), + 60_000).get(90, TimeUnit.SECONDS); + + assertNotNull(response, "Expected a response from the assistant"); + String content = response.getData().content().toLowerCase(); + assertTrue(content.contains("analyzing"), + "Response should contain the updated phase: " + response.getData().content()); + assertTrue(content.contains("item_alpha") || content.contains("item_beta"), + "Response should contain search results: " + response.getData().content()); + assertTrue("analyzing".equals(tools.currentPhase), + "Expected currentPhase to be 'analyzing' but was: " + tools.currentPhase); + } finally { + session.close(); + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/InProcessTransportIT.java b/java/sdk/src/test/java/com/github/copilot/e2e/InProcessTransportIT.java new file mode 100644 index 000000000..1b8595401 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/InProcessTransportIT.java @@ -0,0 +1,101 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import java.util.Map; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.AllowCopilotExperimental; +import com.github.copilot.CopilotClient; +import com.github.copilot.E2ETestContext; +import com.github.copilot.ffi.InProcessEnvGuard; +import com.github.copilot.rpc.CopilotClientOptions; +import com.github.copilot.rpc.PingResponse; +import com.github.copilot.rpc.RuntimeConnection; + +/** + * Failsafe integration test for the in-process (FFI) transport. + * + *

    + * Loads the real {@code runtime.node} native library into this test process via + * {@link com.github.copilot.ffi.FfiRuntimeHost}, performs a purely local + * {@code ping} round-trip through the runtime, and stops cleanly. {@code ping} + * is answered by the runtime itself, so no auth or replay proxy is involved — + * this mirrors {@code nodejs/test/e2e/inprocess_ffi.e2e.test.ts}, + * {@code go/internal/e2e/inprocess_ffi_e2e_test.go}, and + * {@code python/e2e/test_inprocess_ffi_e2e.py}. + * + *

    + * {@link InProcessEnvGuard} demonstrates how the harness redirects the native + * runtime's HTTP traffic to the replay proxy (via {@code COPILOT_API_URL}) for + * tests that need session/message round trips over the in-process transport: + * the native library reads environment variables from the live OS process + * environment block, not from the JVM's {@code System.getenv()} snapshot, so + * only a JNA-backed native call can make it visible to code already loaded + * in-process. + * + *

    + * Run with {@code mvn verify -Pinprocess} from the {@code java} reactor root, + * which builds the {@code copilot-sdk-java-runtime} artifact and sets + * {@code COPILOT_CLI_PATH} to the pinned CLI whose sibling {@code runtime.node} + * this test loads, and forces {@code forkCount=1} because the FFI host and env + * guard mutate process-global state. + * + *

    + * {@link RequireInProcess} disables this test unless the {@code -Pinprocess} + * profile is active: without it, the {@code copilot-sdk-java-runtime} + * classifier JAR providing {@code runtime.node} is not on the classpath, so the + * test would fail with a {@code FileNotFoundException} rather than being + * skipped. + */ +@AllowCopilotExperimental +@RequireInProcess +class InProcessTransportIT { + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void shouldStartPingAndStopOverInProcessFfi() throws Exception { + // Route the native runtime's HTTP traffic (should it make any) at the + // replay proxy, mirroring how a session-level in-process test would + // redirect COPILOT_API_URL. `ping` never reaches the network, but this + // demonstrates the guard's intended usage for future in-process tests. + // COPILOT_CLI_PATH is intentionally NOT set here: NativeRuntimeLoader and + // CopilotClient.resolveInProcessEntrypoint() read it via + // System.getenv(), which is a JVM-startup-time snapshot that native + // setenv() calls made after the JVM starts cannot update — it must be + // set before the JVM starts (see the -Pinprocess Maven profile). + try (InProcessEnvGuard envGuard = new InProcessEnvGuard(Map.of("COPILOT_API_URL", ctx.getProxyUrl()))) { + CopilotClientOptions options = new CopilotClientOptions().setConnection(RuntimeConnection.forInProcess()); + try (CopilotClient client = new CopilotClient(options)) { + client.start().get(); + + PingResponse pong = client.ping("ffi message").get(); + assertEquals("pong: ffi message", pong.message()); + assertNotNull(pong.timestamp()); + + client.stop().get(); + } + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/RequireInProcess.java b/java/sdk/src/test/java/com/github/copilot/e2e/RequireInProcess.java new file mode 100644 index 000000000..12de4e5b7 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/RequireInProcess.java @@ -0,0 +1,64 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.junit.jupiter.api.extension.ExtendWith; + +/** + * Enables an annotated test class or method only when the E2E suite runs under + * the in-process (FFI) transport, i.e. when + * {@code COPILOT_SDK_DEFAULT_CONNECTION} is set to {@code inprocess}. + * + *

    + * Use this for tests that require the real {@code runtime.node} native library + * to be present on the classpath, which only the {@code -Pinprocess} Maven + * profile guarantees (see {@link InProcessTransportIT}). Without this profile, + * standard {@code mvn verify} runs would fail with a + * {@code FileNotFoundException} because the classifier JAR providing + * {@code runtime.node} is not on the classpath. + *

    + * + *

    + * The inverse of {@link SkipInProcess}. + *

    + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE, ElementType.METHOD}) +@ExtendWith(RequireInProcess.Condition.class) +public @interface RequireInProcess { + + /** + * Explains why the annotated test requires the in-process transport. + * + * @return the skip reason used when the in-process transport is not active + */ + String value() default "Requires the -Pinprocess Maven profile"; + + /** + * JUnit 5 execution condition backing {@link RequireInProcess}. + */ + public static final class Condition implements org.junit.jupiter.api.extension.ExecutionCondition { + + private static final String DEFAULT_CONNECTION_ENV_VAR = "COPILOT_SDK_DEFAULT_CONNECTION"; + + @Override + public org.junit.jupiter.api.extension.ConditionEvaluationResult evaluateExecutionCondition( + org.junit.jupiter.api.extension.ExtensionContext context) { + String envValue = System.getenv(DEFAULT_CONNECTION_ENV_VAR); + if ("inprocess".equalsIgnoreCase(envValue)) { + return org.junit.jupiter.api.extension.ConditionEvaluationResult + .enabled("Running under the in-process transport"); + } + String reason = context.getElement().map(element -> element.getAnnotation(RequireInProcess.class)) + .map(RequireInProcess::value).orElse("Requires the -Pinprocess Maven profile"); + return org.junit.jupiter.api.extension.ConditionEvaluationResult.disabled(reason); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/RewindIT.java b/java/sdk/src/test/java/com/github/copilot/e2e/RewindIT.java new file mode 100644 index 000000000..eff48dde0 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/RewindIT.java @@ -0,0 +1,128 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import com.github.copilot.AllowCopilotExperimental; +import com.github.copilot.CopilotClient; +import com.github.copilot.CopilotSession; +import com.github.copilot.E2ETestContext; +import com.github.copilot.generated.AssistantMessageEvent; +import com.github.copilot.generated.rpc.HistoryRewindMode; +import com.github.copilot.generated.rpc.HistoryRewindOutcome; +import com.github.copilot.generated.rpc.SessionHistoryListRewindPointsResult; +import com.github.copilot.generated.rpc.SessionHistoryPreviewRewindParams; +import com.github.copilot.generated.rpc.SessionHistoryRewindParams; +import com.github.copilot.rpc.MessageOptions; +import com.github.copilot.rpc.PermissionHandler; +import com.github.copilot.rpc.SessionConfig; + +@AllowCopilotExperimental +class RewindIT { + + private static final String FILE_NAME = "rewind-sdk.txt"; + private static final String FILE_CONTENT = "SDK rewind content"; + + private static E2ETestContext ctx; + + @BeforeAll + static void setup() throws Exception { + ctx = E2ETestContext.create(); + } + + @AfterAll + static void teardown() throws Exception { + if (ctx != null) { + ctx.close(); + } + } + + @Test + void shouldRestoreTrackedFileAndConversation() throws Exception { + ctx.configureForTest("rewind", "should_restore_tracked_file_and_conversation"); + Path filePath = ctx.getWorkDir().resolve(FILE_NAME); + + try (CopilotClient client = ctx.createClient(); + CopilotSession session = client + .createSession( + new SessionConfig().setModel("claude-sonnet-4.5").setEnableFileChangeTracking(true) + .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) + .get(30, TimeUnit.SECONDS)) { + AssistantMessageEvent response = session + .sendAndWait(new MessageOptions().setPrompt( + "Use the create tool to create " + FILE_NAME + " containing exactly " + FILE_CONTENT + + ". After the tool succeeds, reply with exactly SDK_REWIND_DONE."), + 30_000) + .get(60, TimeUnit.SECONDS); + + assertNotNull(response); + assertEquals("SDK_REWIND_DONE", response.getData().content()); + assertEquals(FILE_CONTENT, Files.readString(filePath)); + + SessionHistoryListRewindPointsResult rewindPoints = waitForRewindPoints(session); + assertTrue(Boolean.TRUE.equals(rewindPoints.fileChangeTrackingEnabled())); + assertEquals(1, rewindPoints.points().size()); + var rewindPoint = rewindPoints.points().get(0); + assertTrue(Boolean.TRUE.equals(rewindPoint.canRestoreFiles())); + assertEquals(1L, rewindPoint.fileCount()); + + var preview = session.getRpc().history + .previewRewind(new SessionHistoryPreviewRewindParams(null, rewindPoint.eventId())) + .get(10, TimeUnit.SECONDS); + assertTrue(Boolean.TRUE.equals(preview.available())); + assertEquals(1, preview.files().size()); + assertSamePath(filePath, preview.files().get(0).path()); + + var rewind = session.getRpc().history.rewind(new SessionHistoryRewindParams(null, rewindPoint.eventId(), + HistoryRewindMode.CONVERSATION_AND_FILES)).get(10, TimeUnit.SECONDS); + assertEquals(HistoryRewindOutcome.SUCCESS, rewind.outcome()); + assertTrue(rewind.eventsRemoved() != null && rewind.eventsRemoved() > 0); + assertEquals(1, rewind.restoredFiles().size()); + assertSamePath(filePath, rewind.restoredFiles().get(0)); + assertFalse(Files.exists(filePath)); + + var events = session.getMessages().get(10, TimeUnit.SECONDS); + assertTrue(events.stream().noneMatch(event -> event.getId().toString().equals(rewindPoint.eventId()))); + } + } + + private static SessionHistoryListRewindPointsResult waitForRewindPoints(CopilotSession session) throws Exception { + long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(10); + SessionHistoryListRewindPointsResult result; + do { + result = session.getRpc().history.listRewindPoints().get(10, TimeUnit.SECONDS); + if (result.unavailableReason() == null) { + return result; + } + TimeUnit.MILLISECONDS.sleep(100); + } while (System.nanoTime() < deadline); + + assertNull(result.unavailableReason(), "Timed out waiting for rewind points to become available"); + return result; + } + + private static void assertSamePath(Path expected, String actual) { + String expectedPath = expected.toAbsolutePath().normalize().toString(); + String actualPath = Path.of(actual).toAbsolutePath().normalize().toString(); + if (System.getProperty("os.name").startsWith("Windows")) { + assertTrue(expectedPath.equalsIgnoreCase(actualPath)); + } else { + assertEquals(expectedPath, actualPath); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/e2e/SkipInProcess.java b/java/sdk/src/test/java/com/github/copilot/e2e/SkipInProcess.java new file mode 100644 index 000000000..3f626e133 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/e2e/SkipInProcess.java @@ -0,0 +1,64 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.e2e; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.junit.jupiter.api.extension.ExtendWith; + +/** + * Disables an annotated test class or method when the E2E suite runs under the + * in-process (FFI) transport, i.e. when {@code COPILOT_SDK_DEFAULT_CONNECTION} + * is set to {@code inprocess}. + * + *

    + * Use this for tests that rely on per-client process settings the in-process + * transport cannot honor — for example per-client environment variables, since + * the in-process runtime shares the host process's single environment (see + * {@link com.github.copilot.rpc.InProcessRuntimeConnection} and + * issue #1934). + *

    + * + *

    + * Mirrors {@code skip_inprocess(reason)} in the Rust E2E harness. + *

    + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE, ElementType.METHOD}) +@ExtendWith(SkipInProcess.Condition.class) +public @interface SkipInProcess { + + /** + * Explains why the annotated test is incompatible with the in-process + * transport. + * + * @return the skip reason + */ + String value() default "Not supported under the in-process (FFI) transport"; + + /** + * JUnit 5 execution condition backing {@link SkipInProcess}. + */ + public static final class Condition implements org.junit.jupiter.api.extension.ExecutionCondition { + + private static final String DEFAULT_CONNECTION_ENV_VAR = "COPILOT_SDK_DEFAULT_CONNECTION"; + + @Override + public org.junit.jupiter.api.extension.ConditionEvaluationResult evaluateExecutionCondition( + org.junit.jupiter.api.extension.ExtensionContext context) { + String envValue = System.getenv(DEFAULT_CONNECTION_ENV_VAR); + if (!"inprocess".equalsIgnoreCase(envValue)) { + return org.junit.jupiter.api.extension.ConditionEvaluationResult + .enabled("Not running under the in-process transport"); + } + String reason = context.getElement().map(element -> element.getAnnotation(SkipInProcess.class)) + .map(SkipInProcess::value).orElse("Not supported under the in-process (FFI) transport"); + return org.junit.jupiter.api.extension.ConditionEvaluationResult.disabled(reason); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/FfiRuntimeHostTest.java b/java/sdk/src/test/java/com/github/copilot/ffi/FfiRuntimeHostTest.java new file mode 100644 index 000000000..cc98d24f6 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/FfiRuntimeHostTest.java @@ -0,0 +1,362 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.CopilotClientMode; +import com.github.copilot.rpc.CopilotClientOptions; +import com.sun.jna.Memory; +import com.sun.jna.Pointer; + +class FfiRuntimeHostTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @Test + void startBuildsExpectedArgvAndEnvJson() throws Exception { + class RecordingBinding implements NativeBinding { + byte[] argv; + byte[] env; + + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + this.argv = argvJson; + this.env = envJson; + return 11; + } + + @Override + public boolean hostShutdown(int serverId) { + return true; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + return 21; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + return true; + } + } + + RecordingBinding binding = new RecordingBinding(); + CopilotClientOptions options = new CopilotClientOptions().setLogLevel("debug").setGitHubToken("gh-token") + .setCopilotHome("/tmp/copilot-home").setUseLoggedInUser(false).setSessionIdleTimeoutSeconds(42) + .setRemote(true).setMode(CopilotClientMode.EMPTY).setCliArgs(new String[]{"--extra-flag"}); + + FfiRuntimeHost host = new FfiRuntimeHost(binding, "/tmp/runtime.node"); + host.start("/tmp/entrypoint.js", options); + + List argv = MAPPER.readValue(binding.argv, new TypeReference>() { + }); + assertEquals("node", argv.get(0)); + assertEquals("/tmp/entrypoint.js", argv.get(1)); + assertTrue(argv.contains("--embedded-host")); + assertTrue(argv.contains("--no-auto-update")); + assertTrue(argv.contains("--auth-token-env")); + assertTrue(argv.contains("COPILOT_SDK_AUTH_TOKEN")); + assertTrue(argv.contains("--no-auto-login")); + assertTrue(argv.contains("--session-idle-timeout")); + assertTrue(argv.contains("42")); + assertTrue(argv.contains("--remote")); + assertTrue(argv.contains("--extra-flag")); + + Map env = MAPPER.readValue(binding.env, new TypeReference>() { + }); + assertEquals("gh-token", env.get("COPILOT_SDK_AUTH_TOKEN")); + assertEquals("/tmp/copilot-home", env.get("COPILOT_HOME")); + assertEquals("1", env.get("COPILOT_DISABLE_KEYTAR")); + } + + @Test + void callbackExceptionIsContainedAndDoesNotEscapeAcrossFfiBoundary() { + AtomicBoolean callbackReturned = new AtomicBoolean(false); + NativeBinding binding = new NativeBinding() { + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return 1; + } + + @Override + public boolean hostShutdown(int serverId) { + return true; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + Memory mem = new Memory(5); + mem.write(0, "hello".getBytes(StandardCharsets.UTF_8), 0, 5); + callback.invoke(Pointer.NULL, mem, new SizeT(5)); + callbackReturned.set(true); + return 2; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + return true; + } + }; + + QueueInputStream throwingStream = new QueueInputStream() { + @Override + void enqueue(byte[] bytes) { + throw new RuntimeException("boom"); + } + }; + + FfiRuntimeHost host = new FfiRuntimeHost(binding, "test-lib", throwingStream); + assertDoesNotThrow(() -> host.start("/tmp/entrypoint", new CopilotClientOptions())); + assertTrue(callbackReturned.get(), "callback should return normally even when enqueue throws"); + } + + @Test + void closeNeverThrowsEvenWhenNativeCloseFails() { + NativeBinding binding = new NativeBinding() { + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return 5; + } + + @Override + public boolean hostShutdown(int serverId) { + throw new RuntimeException("shutdown failed"); + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + return 9; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + throw new RuntimeException("close failed"); + } + }; + + FfiRuntimeHost host = new FfiRuntimeHost(binding, "test-lib"); + host.start("/tmp/entrypoint", new CopilotClientOptions()); + assertDoesNotThrow(host::close); + } + + @Test + void failedConnectionOpenReleasesHostForSequentialStartup() { + AtomicInteger starts = new AtomicInteger(); + AtomicInteger shutdowns = new AtomicInteger(); + NativeBinding binding = new NativeBinding() { + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return starts.incrementAndGet(); + } + + @Override + public boolean hostShutdown(int serverId) { + shutdowns.incrementAndGet(); + return true; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + return serverId == 1 ? 0 : 22; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + return true; + } + }; + + try (FfiRuntimeHost failedHost = new FfiRuntimeHost(binding, "test-lib")) { + assertThrows(IllegalStateException.class, + () -> failedHost.start("/tmp/entrypoint", new CopilotClientOptions())); + } + assertEquals(1, shutdowns.get(), "failed connection startup must release its native host"); + + try (FfiRuntimeHost nextHost = new FfiRuntimeHost(binding, "test-lib")) { + assertDoesNotThrow(() -> nextHost.start("/tmp/entrypoint", new CopilotClientOptions())); + } + assertEquals(2, shutdowns.get(), "the sequential host must also shut down cleanly"); + } + + @Test + void writeAndCloseAreSerializedByOperationLock() throws Exception { + CountDownLatch writeStarted = new CountDownLatch(1); + CountDownLatch allowWriteToFinish = new CountDownLatch(1); + AtomicInteger writes = new AtomicInteger(0); + + NativeBinding binding = new NativeBinding() { + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return 3; + } + + @Override + public boolean hostShutdown(int serverId) { + return true; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + return 4; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + writes.incrementAndGet(); + writeStarted.countDown(); + try { + allowWriteToFinish.await(5, TimeUnit.SECONDS); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + return true; + } + }; + + FfiRuntimeHost host = new FfiRuntimeHost(binding, "test-lib"); + host.start("/tmp/entrypoint", new CopilotClientOptions()); + + CompletableFuture writer = CompletableFuture.runAsync(() -> { + try { + host.getSendStream().write("ping".getBytes(StandardCharsets.UTF_8)); + } catch (IOException e) { + throw new RuntimeException(e); + } + }); + + assertTrue(writeStarted.await(2, TimeUnit.SECONDS)); + CompletableFuture closer = CompletableFuture.runAsync(host::close); + allowWriteToFinish.countDown(); + + writer.get(5, TimeUnit.SECONDS); + closer.get(5, TimeUnit.SECONDS); + assertEquals(1, writes.get()); + assertThrows(IOException.class, () -> host.getSendStream().write("late".getBytes(StandardCharsets.UTF_8))); + } + + @Test + void closeDrainsActiveCallbacksBeforeHostShutdown() throws Exception { + CountDownLatch callbackEntered = new CountDownLatch(1); + CountDownLatch allowCallbackToReturn = new CountDownLatch(1); + AtomicBoolean shutdownObservedAfterCallbackReturn = new AtomicBoolean(false); + AtomicBoolean callbackFinished = new AtomicBoolean(false); + AtomicReference callbackRef = new AtomicReference<>(); + + NativeBinding binding = new NativeBinding() { + @Override + public int hostStart(byte[] argvJson, int argvJsonLen, byte[] envJson, int envJsonLen) { + return 7; + } + + @Override + public boolean hostShutdown(int serverId) { + shutdownObservedAfterCallbackReturn.set(callbackFinished.get()); + return true; + } + + @Override + public int connectionOpen(int serverId, OutboundCallback callback, Pointer userData, byte[] extSource, + int extSourceLen, byte[] extName, int extNameLen, byte[] connToken, int connTokenLen) { + callbackRef.set(callback); + return 8; + } + + @Override + public boolean connectionWrite(int connectionId, byte[] data, int dataLen) { + return true; + } + + @Override + public boolean connectionClose(int connectionId) { + return true; + } + }; + + QueueInputStream blockingStream = new QueueInputStream() { + @Override + void enqueue(byte[] bytes) { + callbackEntered.countDown(); + try { + allowCallbackToReturn.await(5, TimeUnit.SECONDS); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + callbackFinished.set(true); + super.enqueue(bytes); + } + }; + + FfiRuntimeHost host = new FfiRuntimeHost(binding, "test-lib", blockingStream); + host.start("/tmp/entrypoint", new CopilotClientOptions()); + assertNotNull(callbackRef.get()); + + CompletableFuture callbackFuture = CompletableFuture.runAsync(() -> { + Memory mem = new Memory(1); + mem.setByte(0, (byte) 'x'); + callbackRef.get().invoke(Pointer.NULL, mem, new SizeT(1)); + }); + + assertTrue(callbackEntered.await(2, TimeUnit.SECONDS)); + CompletableFuture closeFuture = CompletableFuture.runAsync(host::close); + Thread.sleep(150); + assertFalse(closeFuture.isDone(), "close should wait for active callback to drain"); + allowCallbackToReturn.countDown(); + callbackFuture.get(5, TimeUnit.SECONDS); + closeFuture.get(5, TimeUnit.SECONDS); + assertTrue(shutdownObservedAfterCallbackReturn.get(), "host_shutdown should run after callback drains"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/InProcessEnvGuard.java b/java/sdk/src/test/java/com/github/copilot/ffi/InProcessEnvGuard.java new file mode 100644 index 000000000..43df71371 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/InProcessEnvGuard.java @@ -0,0 +1,192 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.logging.Logger; + +import com.sun.jna.Library; +import com.sun.jna.Native; +import com.sun.jna.WString; + +/** + * Mutates the live process environment block so that native code loaded + * in-process (e.g. {@code runtime.node} via JNA) observes the given environment + * variables, and restores the previous values on {@link #close()}. + * + *

    + * Java has no public API to modify the process-level environment block: + * {@code System.setProperty()} only writes the JVM property bag, and + * {@code System.getenv()} is an immutable startup-time snapshot. Native code + * loaded via JNA reads the OS environment directly + * ({@code GetEnvironmentVariableW} on Windows, {@code getenv()} on POSIX), so + * the only way to make it see an overridden value is to call the OS API + * directly through JNA. + *

    + * + *

    + * This mirrors the Rust {@code InProcessEnvGuard} + * ({@code rust/tests/e2e/support.rs}) and the .NET + * {@code InProcessEnvIsolation} + * ({@code dotnet/test/Harness/InProcessEnvIsolation.cs}). + *

    + * + *

    + * Thread safety: this guard mutates process-global state. + * Tests that use it must run with test concurrency 1 (see the + * {@code -Pinprocess} Maven profile, which sets {@code failsafe.forkCount=1} + * and disables parallel execution). + *

    + */ +public final class InProcessEnvGuard implements AutoCloseable { + + private static final Logger LOG = Logger.getLogger(InProcessEnvGuard.class.getName()); + + /** + * Environment variables suppressed because replay snapshots expect Bearer/OAuth + * auth. + */ + private static final List SUPPRESSED_KEYS = List.of("COPILOT_HMAC_KEY", "CAPI_HMAC_KEY"); + + /** + * Windows kernel32: sets or deletes a variable in the process environment + * block. + */ + private interface Kernel32Env extends Library { + boolean SetEnvironmentVariableW(WString lpName, WString lpValue); + + int GetEnvironmentVariableW(WString lpName, char[] lpBuffer, int nSize); + } + + /** POSIX libc: sets or deletes a variable in the process environment block. */ + private interface LibcEnv extends Library { + int setenv(String name, String value, int overwrite); + + int unsetenv(String name); + + /** Returns null if the variable is not set. */ + String getenv(String name); + } + + /** + * Sentinel indicating the variable was not set (distinct from empty string). + */ + private static final String ABSENT_SENTINEL = new String("\0ABSENT\0"); + + /** + * name -> previous value ({@code null} means the variable was not set before). + */ + private final List> saved = new ArrayList<>(); + private boolean closed; + + /** + * Applies {@code applyEnv} to the native process environment block, saving the + * previous values for restoration by {@link #close()}. Also suppresses + * {@code COPILOT_HMAC_KEY} / {@code CAPI_HMAC_KEY} if present, since the replay + * proxy expects Bearer/OAuth auth rather than HMAC. + * + * @param applyEnv + * environment variables to apply; values must not be {@code null} + */ + public InProcessEnvGuard(Map applyEnv) { + for (Map.Entry entry : applyEnv.entrySet()) { + apply(entry.getKey(), entry.getValue()); + } + for (String key : SUPPRESSED_KEYS) { + String previous = nativeGetEnv(key); + if (previous != null && !previous.isEmpty()) { + apply(key, null); + } + } + } + + private void apply(String name, String value) { + String previous = nativeGetEnv(name); + saved.add(Map.entry(name, previous == null ? ABSENT_SENTINEL : previous)); + nativeSetEnv(name, value); + } + + /** + * Restores every environment variable this guard touched to the value it had + * before construction. + */ + @Override + public synchronized void close() { + if (closed) { + return; + } + closed = true; + List> reversed = new ArrayList<>(saved); + Collections.reverse(reversed); + for (Map.Entry entry : reversed) { + // ABSENT_SENTINEL uses a value ("\0ABSENT\0") impossible in real env vars. + String restoreValue = ABSENT_SENTINEL.equals(entry.getValue()) ? null : entry.getValue(); + nativeSetEnv(entry.getKey(), restoreValue); + } + } + + private static String nativeGetEnv(String name) { + if (isWindows()) { + return nativeGetEnvWindows(name); + } else { + return nativeGetEnvUnix(name); + } + } + + private static String nativeGetEnvWindows(String name) { + Kernel32Env kernel32 = Native.load("kernel32", Kernel32Env.class); + char[] buffer = new char[32767]; + int len = kernel32.GetEnvironmentVariableW(new WString(name), buffer, buffer.length); + if (len == 0) { + // Variable not set (or error — treat as absent) + return null; + } + return new String(buffer, 0, len); + } + + private static String nativeGetEnvUnix(String name) { + LibcEnv libc = Native.load("c", LibcEnv.class); + return libc.getenv(name); + } + + private static void nativeSetEnv(String name, String value) { + if (isWindows()) { + nativeSetEnvWindows(name, value); + } else { + nativeSetEnvUnix(name, value); + } + } + + private static void nativeSetEnvWindows(String name, String value) { + Kernel32Env kernel32 = Native.load("kernel32", Kernel32Env.class); + boolean ok = kernel32.SetEnvironmentVariableW(new WString(name), value != null ? new WString(value) : null); + if (!ok) { + LOG.warning("SetEnvironmentVariableW failed for key=" + name); + } + } + + private static void nativeSetEnvUnix(String name, String value) { + LibcEnv libc = Native.load("c", LibcEnv.class); + if (value != null) { + int rc = libc.setenv(name, value, 1); + if (rc != 0) { + LOG.warning("setenv() failed for key=" + name + " rc=" + rc); + } + } else { + int rc = libc.unsetenv(name); + if (rc != 0) { + LOG.warning("unsetenv() failed for key=" + name + " rc=" + rc); + } + } + } + + private static boolean isWindows() { + return System.getProperty("os.name", "").toLowerCase(Locale.ROOT).contains("win"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/JnaNativeBindingTest.java b/java/sdk/src/test/java/com/github/copilot/ffi/JnaNativeBindingTest.java new file mode 100644 index 000000000..d7d218c0e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/JnaNativeBindingTest.java @@ -0,0 +1,344 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assumptions.assumeTrue; + +import com.sun.jna.Pointer; + +import java.lang.ref.WeakReference; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.concurrent.atomic.AtomicInteger; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +/** + * Unit tests for {@link JnaNativeBinding}. + * + *

    + * Delegation and callback-tracking tests use a stub + * {@link JnaNativeBinding.CopilotRuntimeLibrary}. Library-loading guard tests + * exercise {@link JnaNativeBinding} directly against the real + * {@code runtime.node} when it is available on the test classpath. + * + *

    + * Tests that require the packaged native runtime are conditionally skipped when + * it is unavailable (for example, when not running with {@code -Pinprocess}). + */ +class JnaNativeBindingTest { + + // ------------------------------------------------------------------------- + // Stub CopilotRuntimeLibrary for delegation tests + // ------------------------------------------------------------------------- + + /** + * Minimal stub for testing {@link JnaNativeBinding} delegation without disk + * I/O. + */ + private static class StubRuntimeLibrary implements JnaNativeBinding.CopilotRuntimeLibrary { + int hostStartReturn = 1; + byte hostShutdownReturn = 1; + int connectionOpenReturn = 1; + byte connectionWriteReturn = 1; + byte connectionCloseReturn = 1; + + byte[] lastArgvJson; + int lastArgvJsonLen; + int lastServerId; + int lastConnectionId; + OutboundCallback lastCallback; + + @Override + public int copilot_runtime_host_start(byte[] argvJson, SizeT argvJsonLen, byte[] envJson, SizeT envJsonLen) { + lastArgvJson = argvJson; + lastArgvJsonLen = argvJsonLen.intValue(); + return hostStartReturn; + } + + @Override + public byte copilot_runtime_host_shutdown(int serverId) { + lastServerId = serverId; + return hostShutdownReturn; + } + + @Override + public int copilot_runtime_connection_open(int serverId, OutboundCallback callback, Pointer userData, + byte[] extSource, SizeT extSourceLen, byte[] extName, SizeT extNameLen, byte[] connToken, + SizeT connTokenLen) { + lastServerId = serverId; + lastCallback = callback; + return connectionOpenReturn; + } + + @Override + public byte copilot_runtime_connection_write(int connectionId, byte[] data, SizeT dataLen) { + lastConnectionId = connectionId; + return connectionWriteReturn; + } + + @Override + public byte copilot_runtime_connection_close(int connectionId) { + lastConnectionId = connectionId; + return connectionCloseReturn; + } + } + + // ------------------------------------------------------------------------- + // Helpers + // ------------------------------------------------------------------------- + + private static Path resolveNativeLib() { + try { + return NativeRuntimeLoader.resolve(); + } catch (Exception e) { + return null; + } + } + + @AfterEach + void resetStaticState() { + JnaNativeBinding.resetForTesting(); + } + + // ========================================================================= + // Delegation via testing constructor (stub — no disk I/O) + // ========================================================================= + + @Test + void hostStartDelegatesToLibraryAndReturnsHandle() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.hostStartReturn = 77; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + byte[] argv = "[\"copilot\"]".getBytes(StandardCharsets.UTF_8); + int result = binding.hostStart(argv, argv.length, null, 0); + + assertEquals(77, result, "hostStart should return the stub's configured value"); + assertEquals(argv, stub.lastArgvJson, "argv bytes should be passed through unchanged"); + assertEquals(argv.length, stub.lastArgvJsonLen); + } + + @Test + void hostStartReturnsZeroOnFailure() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.hostStartReturn = 0; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + byte[] argv = "[\"copilot\"]".getBytes(StandardCharsets.UTF_8); + assertEquals(0, binding.hostStart(argv, argv.length, null, 0), "hostStart must return 0 to signal failure"); + } + + @Test + void hostShutdownDelegatesToLibrary() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.hostShutdownReturn = 1; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + assertTrue(binding.hostShutdown(42)); + assertEquals(42, stub.lastServerId); + } + + @Test + void hostShutdownReturnsFalseOnFailure() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.hostShutdownReturn = 0; + JnaNativeBinding binding = new JnaNativeBinding(stub); + assertFalse(binding.hostShutdown(1)); + } + + @Test + void connectionOpenDelegatesToLibrary() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionOpenReturn = 55; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + OutboundCallback noop = (ud, data, len) -> { + }; + int connId = binding.connectionOpen(42, noop, Pointer.NULL, null, 0, null, 0, null, 0); + + assertEquals(55, connId, "connectionOpen should return the stub's configured handle"); + assertEquals(42, stub.lastServerId); + } + + @Test + void connectionOpenReturnsZeroOnFailure() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionOpenReturn = 0; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + OutboundCallback noop = (ud, data, len) -> { + }; + assertEquals(0, binding.connectionOpen(1, noop, Pointer.NULL, null, 0, null, 0, null, 0), + "connectionOpen must return 0 to signal failure"); + } + + @Test + void connectionWriteDelegatesToLibrary() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionWriteReturn = 1; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + byte[] data = "hello".getBytes(StandardCharsets.UTF_8); + assertTrue(binding.connectionWrite(7, data, data.length)); + assertEquals(7, stub.lastConnectionId); + } + + @Test + void connectionWriteReturnsFalseOnFailure() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionWriteReturn = 0; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + byte[] data = "x".getBytes(StandardCharsets.UTF_8); + assertFalse(binding.connectionWrite(1, data, data.length), + "connectionWrite must propagate false return from the library"); + } + + @Test + void connectionCloseDelegatesToLibrary() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionCloseReturn = 1; + JnaNativeBinding binding = new JnaNativeBinding(stub); + assertTrue(binding.connectionClose(7)); + assertEquals(7, stub.lastConnectionId); + } + + @Test + void connectionCloseReturnsFalseOnFailure() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionCloseReturn = 0; + JnaNativeBinding binding = new JnaNativeBinding(stub); + assertFalse(binding.connectionClose(1)); + } + + @Test + void activeCallbacksStartsAtZero() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + JnaNativeBinding binding = new JnaNativeBinding(stub); + assertEquals(0, binding.activeCallbacks.get(), "Active callback counter must start at zero"); + } + + @Test + void callbackWrapperRemainsReachableAfterConnectionClose() throws InterruptedException { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionOpenReturn = 99; + JnaNativeBinding binding = new JnaNativeBinding(stub); + AtomicInteger invocations = new AtomicInteger(); + + WeakReference callbackReference = openAndCloseConnection(binding, stub, + (userData, data, len) -> invocations.incrementAndGet()); + + awaitGarbageCollection(callbackReference); + + OutboundCallback callback = callbackReference.get(); + assertNotNull(callback, "Callback wrapper must remain strongly reachable after connection close"); + callback.invoke(Pointer.NULL, Pointer.NULL, new SizeT(0)); + assertEquals(1, invocations.get(), "A callback queued before close must remain safely invocable"); + } + + private static WeakReference openAndCloseConnection(JnaNativeBinding binding, + StubRuntimeLibrary stub, OutboundCallback callback) { + int connectionId = binding.connectionOpen(1, callback, Pointer.NULL, null, 0, null, 0, null, 0); + assertEquals(99, connectionId); + assertNotNull(stub.lastCallback); + + WeakReference callbackReference = new WeakReference<>(stub.lastCallback); + stub.lastCallback = null; + assertTrue(binding.connectionClose(connectionId)); + return callbackReference; + } + + private static void awaitGarbageCollection(WeakReference reference) throws InterruptedException { + for (int attempt = 0; attempt < 20 && reference.get() != null; attempt++) { + System.gc(); + System.runFinalization(); + Thread.sleep(10); + } + } + + // ========================================================================= + // Duplicate-load guard + // ========================================================================= + + @Test + void loadFromDifferentPathThrowsIllegalState(@TempDir Path tempDir) throws Exception { + Path nativeLib = resolveNativeLib(); + assumeTrue(nativeLib != null, "Native runtime not available (run with -Pinprocess)"); + Path altPath = tempDir.resolve("runtime-copy-alt.node"); + Files.copy(nativeLib, altPath); + + new JnaNativeBinding(nativeLib); + + IllegalStateException ex = assertThrows(IllegalStateException.class, () -> new JnaNativeBinding(altPath)); + + String msg = ex.getMessage(); + assertTrue(msg.contains("already loaded from"), "Diagnostic must mention 'already loaded from', got: " + msg); + assertTrue(msg.contains(nativeLib.toString()), "Diagnostic must contain path A, got: " + msg); + assertTrue(msg.contains(altPath.toString()), "Diagnostic must contain path B, got: " + msg); + } + + @Test + void duplicateLoadDiagnosticMentionsNotSupported(@TempDir Path tempDir) throws Exception { + Path nativeLib = resolveNativeLib(); + assumeTrue(nativeLib != null, "Native runtime not available (run with -Pinprocess)"); + Path altPath = tempDir.resolve("runtime-copy-b.node"); + Files.copy(nativeLib, altPath); + + new JnaNativeBinding(nativeLib); + + IllegalStateException ex = assertThrows(IllegalStateException.class, () -> new JnaNativeBinding(altPath)); + assertTrue(ex.getMessage().contains("not supported"), + "Diagnostic must mention 'not supported', got: " + ex.getMessage()); + } + + @Test + void resetForTestingAllowsReloadFromDifferentPath(@TempDir Path tempDir) throws Exception { + Path nativeLib = resolveNativeLib(); + assumeTrue(nativeLib != null, "Native runtime not available (run with -Pinprocess)"); + Path altPath = tempDir.resolve("runtime-copy-reset.node"); + Files.copy(nativeLib, altPath); + + new JnaNativeBinding(nativeLib); + + JnaNativeBinding.resetForTesting(); + + // After reset, a different path must succeed. + new JnaNativeBinding(altPath); + } + + @Test + void activeCallbackCountIsIncrementedDuringCallback() { + StubRuntimeLibrary stub = new StubRuntimeLibrary(); + stub.connectionOpenReturn = 99; + JnaNativeBinding binding = new JnaNativeBinding(stub); + + AtomicInteger observedDuringCallback = new AtomicInteger(-1); + + OutboundCallback userCallback = (userData, data, len) -> { + // Observe binding.activeCallbacks while inside the callback + observedDuringCallback.set(binding.activeCallbacks.get()); + }; + + binding.connectionOpen(1, userCallback, Pointer.NULL, null, 0, null, 0, null, 0); + + // The stub captured the tracked wrapper — invoke it to trigger tracking + assertNotNull(stub.lastCallback, "Stub must have captured the tracked callback"); + stub.lastCallback.invoke(Pointer.NULL, Pointer.NULL, new SizeT(0)); + + assertEquals(1, observedDuringCallback.get(), "binding.activeCallbacks must be 1 during callback execution"); + assertEquals(0, binding.activeCallbacks.get(), + "binding.activeCallbacks must return to 0 after callback completes"); + } + +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/NativeRuntimeLoaderTest.java b/java/sdk/src/test/java/com/github/copilot/ffi/NativeRuntimeLoaderTest.java new file mode 100644 index 000000000..d6a9b3481 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/NativeRuntimeLoaderTest.java @@ -0,0 +1,611 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assumptions.assumeTrue; + +import java.io.IOException; +import java.net.URL; +import java.net.URLClassLoader; +import java.nio.file.AtomicMoveNotSupportedException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.attribute.PosixFilePermissions; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +class NativeRuntimeLoaderTest { + + private static final String TEST_CLASSIFIER = "linux-x64"; + private static final String OTHER_CLASSIFIER = "darwin-arm64"; + private static final String TEST_VERSION = "1.2.3-test"; + private static final String TEST_NATIVE_VERSION = "0.0.1-test"; + private static final byte[] FAKE_BINARY_CONTENT = "fake runtime.node binary content".getBytes(); + private static final byte[] FAKE_CLI_CONTENT = "fake copilot CLI content".getBytes(); + private static final byte[] OTHER_BINARY_CONTENT = "other runtime.node binary content".getBytes(); + private static final byte[] OTHER_CLI_CONTENT = "other copilot CLI content".getBytes(); + + // ------------------------------------------------------------------------- + // Version properties resource reading + // ------------------------------------------------------------------------- + + @Test + void readVersionReturnsVersionFromPropertiesResource(@TempDir Path tempDir) throws Exception { + ClassLoader loader = classLoaderWithVersionResource(tempDir, "1.0.5-preview"); + assertEquals("1.0.5-preview", NativeRuntimeLoader.readVersion(loader)); + } + + @Test + void readVersionThrowsWhenResourceMissing() { + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); + IllegalStateException ex = assertThrows(IllegalStateException.class, + () -> NativeRuntimeLoader.readVersion(emptyLoader)); + assertTrue(ex.getMessage().contains(NativeRuntimeLoader.VERSION_RESOURCE)); + } + + @Test + void readVersionThrowsWhenVersionPropertyIsBlank(@TempDir Path tempDir) throws Exception { + ClassLoader loader = classLoaderWithVersionResource(tempDir, " "); + IllegalStateException ex = assertThrows(IllegalStateException.class, + () -> NativeRuntimeLoader.readVersion(loader)); + assertTrue(ex.getMessage().contains("version")); + } + + // ------------------------------------------------------------------------- + // COPILOT_CLI_PATH override + // ------------------------------------------------------------------------- + + @Test + void resolveFromCliPathReturnsSiblingWhenRuntimeNodeExists(@TempDir Path tempDir) throws Exception { + Path fakeCliPath = tempDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path runtimeNode = tempDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + Path result = NativeRuntimeLoader.resolveFromCliPath(fakeCliPath.toString()); + + assertEquals(runtimeNode, result); + } + + @Test + void resolveFromCliPathReturnsNullWhenRuntimeNodeMissing(@TempDir Path tempDir) throws Exception { + Path fakeCliPath = tempDir.resolve("copilot"); + Files.createFile(fakeCliPath); + + assertNull(NativeRuntimeLoader.resolveFromCliPath(fakeCliPath.toString())); + } + + @Test + void resolveFromCliPathReturnsNullWhenEnvIsNull() throws Exception { + assertNull(NativeRuntimeLoader.resolveFromCliPath(null)); + } + + @Test + void resolveFromCliPathReturnsNullWhenEnvIsBlank() throws Exception { + assertNull(NativeRuntimeLoader.resolveFromCliPath(" ")); + } + + @Test + void resolveFromCliPathReturnsNullWhenRuntimeNodeIsEmpty(@TempDir Path tempDir) throws Exception { + Path fakeCliPath = tempDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path runtimeNode = tempDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.createFile(runtimeNode); // empty file + + assertNull(NativeRuntimeLoader.resolveFromCliPath(fakeCliPath.toString())); + } + + @Test + void resolveFromCliPathReturnsPrebuildsPathWhenFlatRuntimeNodeIsMissing(@TempDir Path tempDir) throws Exception { + Path fakeCliPath = tempDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path prebuiltDir = tempDir.resolve("prebuilds").resolve(PlatformDetector.detectClassifier()); + Files.createDirectories(prebuiltDir); + Path runtimeNode = prebuiltDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + Path result = NativeRuntimeLoader.resolveFromCliPath(fakeCliPath.toString()); + + assertEquals(runtimeNode, result); + } + + @Test + void resolveFromCliPathPrefersFlatRuntimeNodeOverPrebuildsPath(@TempDir Path tempDir) throws Exception { + Path fakeCliPath = tempDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path flatRuntimeNode = tempDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(flatRuntimeNode, FAKE_BINARY_CONTENT); + Path prebuiltDir = tempDir.resolve("prebuilds").resolve(PlatformDetector.detectClassifier()); + Files.createDirectories(prebuiltDir); + Files.write(prebuiltDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), OTHER_BINARY_CONTENT); + + Path result = NativeRuntimeLoader.resolveFromCliPath(fakeCliPath.toString()); + + assertEquals(flatRuntimeNode, result); + } + + @Test + void resolveEntrypointUsesConfiguredCliWhenRuntimeIsInPrebuilds(@TempDir Path tempDir) throws Exception { + Path cli = Files.writeString(tempDir.resolve("copilot"), "fake cli"); + Path runtimeDir = tempDir.resolve("prebuilds").resolve(PlatformDetector.detectClassifier()); + Files.createDirectories(runtimeDir); + Path runtime = Files.write(runtimeDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), FAKE_BINARY_CONTENT); + + assertEquals(cli, NativeRuntimeLoader.resolveEntrypoint(cli.toString(), runtime)); + } + + @Test + void resolveFromCliPathReturnsAbsolutePathForRelativeCliPath(@TempDir Path tempDir) throws Exception { + Path workingDirectory = Path.of("").toAbsolutePath(); + Path fakeCliDir = tempDir.resolve("cli-dir"); + Files.createDirectories(fakeCliDir); + Path fakeCliPath = fakeCliDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path runtimeNode = fakeCliDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + Path relativeCliPath = workingDirectory.relativize(fakeCliPath); + + assertEquals(runtimeNode, NativeRuntimeLoader.resolveFromCliPath(relativeCliPath.toString())); + } + + @Test + void cliPathOverrideTakesPriorityOverClasspathExtraction(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + // Create a valid runtime.node alongside the fake CLI path + Path fakeCliDir = tempDir.resolve("cli-dir"); + Files.createDirectories(fakeCliDir); + Path fakeCliPath = fakeCliDir.resolve("copilot"); + Files.createFile(fakeCliPath); + Path runtimeNode = fakeCliDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + // Source 2 is also available (should be ignored) + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.resolve(fakeCliPath.toString(), cacheBase, loader, TEST_CLASSIFIER, + TEST_VERSION); + + assertEquals(runtimeNode, result, "Source 1 (COPILOT_CLI_PATH) must take priority over classpath extraction"); + } + + // ------------------------------------------------------------------------- + // Source 2: classpath extraction to cache + // ------------------------------------------------------------------------- + + @Test + void extractToCacheCopiesResourceToVersionedCacheDirectory(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + Path expected = cacheBase.resolve(TEST_VERSION).resolve(TEST_NATIVE_VERSION).resolve(TEST_CLASSIFIER) + .resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + assertEquals(expected, result); + assertTrue(Files.isRegularFile(result)); + assertTrue(Files.size(result) > 0); + } + + @Test + void extractToCacheReturnsCachedFileOnSecondCall(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path first = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + long modifiedAfterFirstExtraction = Files.getLastModifiedTime(first).toMillis(); + + // Small delay so modification time would differ if the file were rewritten + Thread.sleep(50); + + Path second = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + long modifiedAfterSecondCall = Files.getLastModifiedTime(second).toMillis(); + + assertEquals(first, second); + assertEquals(modifiedAfterFirstExtraction, modifiedAfterSecondCall, + "Cached file must not be overwritten on cache hit"); + } + + @Test + void changedNativeVersionDoesNotReuseCachedArtifactsForSameSdkVersion(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader firstLoader = classLoaderWithNativeArtifacts(tempDir.resolve("native-v1"), TEST_CLASSIFIER, "1.0.0", + FAKE_BINARY_CONTENT, FAKE_CLI_CONTENT); + ClassLoader secondLoader = classLoaderWithNativeArtifacts(tempDir.resolve("native-v2"), TEST_CLASSIFIER, + "1.1.0", OTHER_BINARY_CONTENT, OTHER_CLI_CONTENT); + + Path firstRuntime = NativeRuntimeLoader.extractToCache(cacheBase, firstLoader, TEST_CLASSIFIER, TEST_VERSION); + Path secondRuntime = NativeRuntimeLoader.extractToCache(cacheBase, secondLoader, TEST_CLASSIFIER, TEST_VERSION); + + assertNotEquals(firstRuntime, secondRuntime, "Different native versions must use different cache entries"); + assertBytesEqual(FAKE_BINARY_CONTENT, Files.readAllBytes(firstRuntime)); + assertBytesEqual(FAKE_CLI_CONTENT, + Files.readAllBytes(firstRuntime.getParent().resolve(NativeRuntimeLoader.CLI_FILENAME))); + assertBytesEqual(OTHER_BINARY_CONTENT, Files.readAllBytes(secondRuntime)); + assertBytesEqual(OTHER_CLI_CONTENT, + Files.readAllBytes(secondRuntime.getParent().resolve(NativeRuntimeLoader.CLI_FILENAME))); + } + + @Test + void extractToCacheThrowsWhenClasspathResourceMissing(@TempDir Path tempDir) { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); + + assertThrows(IOException.class, + () -> NativeRuntimeLoader.extractToCache(cacheBase, emptyLoader, TEST_CLASSIFIER, TEST_VERSION)); + } + + @Test + void extractToCacheThrowsWhenNativeMetadataMissing(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path resourceDir = tempDir.resolve("native").resolve(TEST_CLASSIFIER); + Files.createDirectories(resourceDir); + Files.write(resourceDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), FAKE_BINARY_CONTENT); + ClassLoader loader = new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + + IOException ex = assertThrows(IOException.class, () -> NativeRuntimeLoader + .extractToCache(tempDir.resolve("cache"), loader, TEST_CLASSIFIER, TEST_VERSION)); + + assertTrue(ex.getMessage().contains("platform.properties")); + } + + @Test + void extractedBinaryContentsMatchClasspathResource(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + byte[] extracted = Files.readAllBytes(result); + assertBytesEqual(FAKE_BINARY_CONTENT, extracted); + } + + @Test + void extractToCacheFiltersClasspathByClassifier(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + writeRuntimeResource(tempDir, TEST_CLASSIFIER, FAKE_BINARY_CONTENT); + writeRuntimeResource(tempDir, OTHER_CLASSIFIER, OTHER_BINARY_CONTENT); + ClassLoader loader = new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + + Path result = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + assertTrue(result.toString().contains(TEST_CLASSIFIER), "Cache path must include the classifier: " + result); + assertBytesEqual(FAKE_BINARY_CONTENT, Files.readAllBytes(result)); + } + + @Test + void extractToCacheRepairsInvalidCacheEntry(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + Path cached = cacheBase.resolve(TEST_VERSION).resolve(TEST_NATIVE_VERSION).resolve(TEST_CLASSIFIER) + .resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.createDirectories(cached.getParent()); + Files.createFile(cached); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + assertEquals(cached, result); + assertBytesEqual(FAKE_BINARY_CONTENT, Files.readAllBytes(result)); + } + + @Test + void nonExecutableCachedCliIsNotAcceptedAsValid(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + assumeTrue(Files.getFileStore(tempDir).supportsFileAttributeView("posix")); + Path cacheBase = tempDir.resolve("cache"); + Path cacheDir = cacheBase.resolve(TEST_VERSION).resolve(TEST_NATIVE_VERSION).resolve(TEST_CLASSIFIER); + Files.createDirectories(cacheDir); + Files.write(cacheDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), FAKE_BINARY_CONTENT); + Path cachedCli = Files.write(cacheDir.resolve(NativeRuntimeLoader.CLI_FILENAME), FAKE_CLI_CONTENT); + Files.setPosixFilePermissions(cachedCli, PosixFilePermissions.fromString("rw-------")); + ClassLoader loader = classLoaderWithRuntimeAndCliResources(tempDir, TEST_CLASSIFIER); + + NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + assertTrue(Files.isExecutable(cachedCli), "A non-executable cached CLI must be repaired or replaced"); + } + + // ------------------------------------------------------------------------- + // Source 3: bundled-CLI sibling + // ------------------------------------------------------------------------- + + @Test + void bundledCliSiblingIsUsedWhenClasspathResourceAbsent(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path bundledCliDir = tempDir.resolve("bundled-cli"); + Files.createDirectories(bundledCliDir); + Path runtimeNode = bundledCliDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + Path cacheBase = tempDir.resolve("cache"); + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); // no classpath resource + + Path result = NativeRuntimeLoader.resolve(null, cacheBase, emptyLoader, TEST_CLASSIFIER, TEST_VERSION, + bundledCliDir); + + assertEquals(runtimeNode, result, + "Source 3 (bundled-CLI sibling) must be used when classpath resource is absent"); + } + + @Test + void classpathResourceWinsOverBundledCliSibling(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + // Source 3: bundled CLI dir with runtime.node (should NOT win) + Path bundledCliDir = tempDir.resolve("bundled-cli"); + Files.createDirectories(bundledCliDir); + Files.write(bundledCliDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), "bundled".getBytes()); + + // Source 2: classpath resource (should win) + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.resolve(null, cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION, + bundledCliDir); + + Path expectedFromClasspath = cacheBase.resolve(TEST_VERSION).resolve(TEST_NATIVE_VERSION) + .resolve(TEST_CLASSIFIER).resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + assertEquals(expectedFromClasspath, result, + "Source 2 (classpath) must win over source 3 (bundled-CLI sibling)"); + assertNotEquals(bundledCliDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), result); + } + + @Test + void bundledCliSiblingIsIgnoredWhenRuntimeNodeMissing(@TempDir Path tempDir) { + assumeLinuxX64(); + Path bundledCliDir = tempDir.resolve("bundled-cli-no-runtime"); + // bundledCliDir doesn't even exist — no runtime.node present + + Path cacheBase = tempDir.resolve("cache"); + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); + + // Both source 2 and source 3 absent: must throw (the classpath error) + IOException ex = assertThrows(IOException.class, () -> NativeRuntimeLoader.resolve(null, cacheBase, emptyLoader, + TEST_CLASSIFIER, TEST_VERSION, bundledCliDir)); + assertTrue(ex.getMessage().contains("classpath"), "Error should mention classpath: " + ex.getMessage()); + } + + // ------------------------------------------------------------------------- + // Atomic publication test seam + // ------------------------------------------------------------------------- + + @Test + void defaultPublisherMovesSourceToTarget(@TempDir Path tempDir) throws Exception { + Path temp = Files.createTempFile(tempDir, "runtime-tmp-", ".node"); + Files.write(temp, FAKE_BINARY_CONTENT); + Path target = tempDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + + NativeRuntimeLoader.DEFAULT_PUBLISHER.publish(temp, target); + + assertTrue(Files.isRegularFile(target), "Target must exist after publication"); + assertTrue(Files.size(target) > 0, "Target must be non-empty"); + assertFalse(Files.exists(temp), "Source temp file must be absent after atomic move"); + } + + @Test + void cliIsExecutableBeforeAtomicPublication(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + assumeTrue(Files.getFileStore(tempDir).supportsFileAttributeView("posix")); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeAndCliResources(tempDir, TEST_CLASSIFIER); + NativeRuntimeLoader.AtomicPublisher publisher = (temp, cached) -> { + if (cached.getFileName().toString().equals(NativeRuntimeLoader.CLI_FILENAME)) { + assertTrue(Files.isExecutable(temp), "CLI temp file must be executable before atomic publication"); + } + Files.move(temp, cached, StandardCopyOption.REPLACE_EXISTING); + }; + + NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION, publisher); + } + + @Test + void extractionCleansUpTempFileWhenPublicationFails(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + // Capture the temp path so we can verify it was deleted + Path[] capturedTemp = {null}; + NativeRuntimeLoader.AtomicPublisher failingPublisher = (temp, cached) -> { + capturedTemp[0] = temp; + throw new AtomicMoveNotSupportedException(temp.toString(), cached.toString(), + "filesystem does not support atomic moves — test"); + }; + + assertThrows(AtomicMoveNotSupportedException.class, () -> NativeRuntimeLoader.extractToCache(cacheBase, loader, + TEST_CLASSIFIER, TEST_VERSION, failingPublisher)); + + assertNotNull(capturedTemp[0], "Publisher must have been invoked"); + assertFalse(Files.exists(capturedTemp[0]), "Temp file must be deleted after failed publication"); + } + + @Test + void extractionCleansUpTempFileWhenPublisherThrowsIllegalStateException(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path[] capturedTemp = {null}; + NativeRuntimeLoader.AtomicPublisher unsupportedPublisher = (temp, cached) -> { + capturedTemp[0] = temp; + // Simulate the wrapping that DEFAULT_PUBLISHER performs for + // AtomicMoveNotSupportedException + throw new IllegalStateException("Filesystem does not support atomic moves; cannot safely publish " + + NativeRuntimeLoader.RUNTIME_FILENAME + " to " + cached); + }; + + IllegalStateException ex = assertThrows(IllegalStateException.class, () -> NativeRuntimeLoader + .extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION, unsupportedPublisher)); + + assertTrue(ex.getMessage().contains("atomic moves"), + "Error message should describe the atomic-move failure: " + ex.getMessage()); + assertNotNull(capturedTemp[0], "Publisher must have been invoked"); + assertFalse(Files.exists(capturedTemp[0]), "Temp file must be deleted after failed atomic publication"); + } + + // ------------------------------------------------------------------------- + // Concurrent extraction safety + // ------------------------------------------------------------------------- + + @Test + void concurrentExtractionByMultipleThreadsBothSucceed(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + int threadCount = 8; + CountDownLatch startGate = new CountDownLatch(1); + ExecutorService pool = Executors.newFixedThreadPool(threadCount); + List> futures = new ArrayList<>(); + + for (int i = 0; i < threadCount; i++) { + futures.add(pool.submit(() -> { + startGate.await(); + return NativeRuntimeLoader.extractToCache(cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + })); + } + + startGate.countDown(); + pool.shutdown(); + assertTrue(pool.awaitTermination(10, TimeUnit.SECONDS)); + + Path expected = cacheBase.resolve(TEST_VERSION).resolve(TEST_NATIVE_VERSION).resolve(TEST_CLASSIFIER) + .resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + for (Future future : futures) { + Path result = future.get(); + assertEquals(expected, result); + assertTrue(Files.isRegularFile(result)); + assertTrue(Files.size(result) > 0); + } + try (var files = Files.list(expected.getParent())) { + assertEquals(List.of(expected), files.toList(), "Concurrent extraction must clean up temporary files"); + } + } + + // ------------------------------------------------------------------------- + // resolve() -- full three-source resolution chain + // ------------------------------------------------------------------------- + + @Test + void resolveWithNullCliEnvExtractsFromClasspath(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader loader = classLoaderWithRuntimeResource(tempDir, TEST_CLASSIFIER); + + Path result = NativeRuntimeLoader.resolve(null, cacheBase, loader, TEST_CLASSIFIER, TEST_VERSION); + + assertNotNull(result); + assertTrue(Files.isRegularFile(result)); + assertTrue(Files.size(result) > 0); + } + + @Test + void resolveThrowsWhenNoSourceIsAvailable(@TempDir Path tempDir) { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); + + // No CLI env, no classpath resource, no bundled-CLI dir → throw + assertThrows(IOException.class, + () -> NativeRuntimeLoader.resolve(null, cacheBase, emptyLoader, TEST_CLASSIFIER, TEST_VERSION)); + } + + @Test + void resolveFallsBackToRuntimeAlongsideBundledCli(@TempDir Path tempDir) throws Exception { + assumeLinuxX64(); + Path cacheBase = tempDir.resolve("cache"); + ClassLoader emptyLoader = new URLClassLoader(new URL[0], null); + Path bundledCli = tempDir.resolve("copilot"); + Files.createFile(bundledCli); + Path runtimeNode = tempDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME); + Files.write(runtimeNode, FAKE_BINARY_CONTENT); + + Path result = NativeRuntimeLoader.resolve(null, bundledCli.toString(), cacheBase, emptyLoader, TEST_CLASSIFIER, + TEST_VERSION); + + assertEquals(runtimeNode, result); + } + + // ------------------------------------------------------------------------- + // Helpers + // ------------------------------------------------------------------------- + + private static void assumeLinuxX64() { + String actualClassifier; + try { + actualClassifier = PlatformDetector.detectClassifier(); + } catch (IllegalStateException ex) { + actualClassifier = "unsupported"; + } + assumeTrue(TEST_CLASSIFIER.equals(actualClassifier), + "Requires linux-x64; detected " + actualClassifier + "; see #2323"); + } + + private static ClassLoader classLoaderWithVersionResource(Path tempDir, String version) throws IOException { + Path propsFile = tempDir.resolve(NativeRuntimeLoader.VERSION_RESOURCE); + Files.writeString(propsFile, "version=" + version + "\n"); + return new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + } + + private static ClassLoader classLoaderWithRuntimeResource(Path tempDir, String classifier) throws IOException { + writeRuntimeResource(tempDir, classifier, FAKE_BINARY_CONTENT); + return new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + } + + private static ClassLoader classLoaderWithRuntimeAndCliResources(Path tempDir, String classifier) + throws IOException { + writeRuntimeResource(tempDir, classifier, FAKE_BINARY_CONTENT); + Path resourceDir = tempDir.resolve("native").resolve(classifier); + Files.write(resourceDir.resolve(NativeRuntimeLoader.CLI_FILENAME), FAKE_CLI_CONTENT); + return new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + } + + private static ClassLoader classLoaderWithNativeArtifacts(Path tempDir, String classifier, String nativeVersion, + byte[] runtimeContent, byte[] cliContent) throws IOException { + writeRuntimeResource(tempDir, classifier, runtimeContent); + Path resourceDir = tempDir.resolve("native").resolve(classifier); + Files.write(resourceDir.resolve(NativeRuntimeLoader.CLI_FILENAME), cliContent); + Files.writeString(resourceDir.resolve("platform.properties"), + "classifier=" + classifier + "\nversion=" + nativeVersion + "\n"); + return new URLClassLoader(new URL[]{tempDir.toUri().toURL()}, null); + } + + private static void writeRuntimeResource(Path tempDir, String classifier, byte[] content) throws IOException { + Path resourceDir = tempDir.resolve("native").resolve(classifier); + Files.createDirectories(resourceDir); + Files.write(resourceDir.resolve(NativeRuntimeLoader.RUNTIME_FILENAME), content); + Files.writeString(resourceDir.resolve("platform.properties"), + "classifier=" + classifier + "\nversion=" + TEST_NATIVE_VERSION + "\n"); + } + + private static void assertBytesEqual(byte[] expected, byte[] actual) { + assertEquals(expected.length, actual.length, "Array lengths differ"); + for (int i = 0; i < expected.length; i++) { + assertEquals(expected[i], actual[i], "Byte differs at index " + i); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/PlatformDetectorTest.java b/java/sdk/src/test/java/com/github/copilot/ffi/PlatformDetectorTest.java new file mode 100644 index 000000000..82049ea6a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/PlatformDetectorTest.java @@ -0,0 +1,217 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.LinkedHashSet; +import java.util.Set; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +class PlatformDetectorTest { + + @Test + void detectOsMapsSupportedNames() { + withSystemProperty("os.name", "Mac OS X", () -> assertEquals("darwin", PlatformDetector.detectOs())); + withSystemProperty("os.name", "Darwin", () -> assertEquals("darwin", PlatformDetector.detectOs())); + withSystemProperty("os.name", "Windows 11", () -> assertEquals("win32", PlatformDetector.detectOs())); + withSystemProperty("os.name", "Linux", () -> assertEquals("linux", PlatformDetector.detectOs())); + } + + @Test + void detectOsThrowsForUnsupportedSystem() { + withSystemProperty("os.name", "Solaris", + () -> assertThrows(IllegalStateException.class, PlatformDetector::detectOs)); + } + + @Test + void detectArchMapsSupportedAliases() { + withSystemProperty("os.arch", "amd64", () -> assertEquals("x64", PlatformDetector.detectArch())); + withSystemProperty("os.arch", "x86_64", () -> assertEquals("x64", PlatformDetector.detectArch())); + withSystemProperty("os.arch", "x64", () -> assertEquals("x64", PlatformDetector.detectArch())); + withSystemProperty("os.arch", "aarch64", () -> assertEquals("arm64", PlatformDetector.detectArch())); + withSystemProperty("os.arch", "arm64", () -> assertEquals("arm64", PlatformDetector.detectArch())); + } + + @Test + void detectArchThrowsForUnsupportedArchitecture() { + withSystemProperty("os.arch", "ppc64", + () -> assertThrows(IllegalStateException.class, PlatformDetector::detectArch)); + } + + @Test + void detectLinuxLibcParsesGlibcInterpPath() throws Exception { + byte[] glibcProbe = buildElf64ProbeWithInterp("/lib64/ld-linux-x86-64.so.2"); + assertEquals(PlatformDetector.LinuxLibc.GLIBC, PlatformDetector.detectLinuxLibc(glibcProbe)); + } + + @Test + void detectLinuxLibcParsesMuslInterpPath() throws Exception { + byte[] muslProbe = buildElf64ProbeWithInterp("/lib/ld-musl-x86_64.so.1"); + assertEquals(PlatformDetector.LinuxLibc.MUSL, PlatformDetector.detectLinuxLibc(muslProbe)); + } + + @Test + void detectLinuxLibcOnLinuxReturnsRecognizedValue() { + withSystemProperty("os.name", "Linux", () -> { + PlatformDetector.LinuxLibc libc = PlatformDetector.detectLinuxLibc(); + assertTrue(libc == PlatformDetector.LinuxLibc.GLIBC || libc == PlatformDetector.LinuxLibc.MUSL + || libc == PlatformDetector.LinuxLibc.UNKNOWN); + }); + } + + @Test + void detectLinuxLibcReturnsUnknownOutsideLinux() { + withSystemProperty("os.name", "Windows 11", + () -> assertEquals(PlatformDetector.LinuxLibc.UNKNOWN, PlatformDetector.detectLinuxLibc())); + } + + @Test + void detectClassifierReturnsClassifierForCurrentLinuxLibc() { + PlatformDetector.LinuxLibc libc = PlatformDetector.detectLinuxLibc(); + String expected = libc == PlatformDetector.LinuxLibc.MUSL ? "linuxmusl-x64" : "linux-x64"; + + withSystemProperties("Linux", "amd64", () -> assertEquals(expected, PlatformDetector.detectClassifier())); + } + + @Test + void detectClassifierAllowListCoversAllSupportedValues() { + Set expected = Set.of("linux-x64", "linux-arm64", "linuxmusl-x64", "linuxmusl-arm64", "darwin-x64", + "darwin-arm64", "win32-x64", "win32-arm64"); + assertEquals(expected, PlatformDetector.supportedClassifiers()); + + Set resolved = new LinkedHashSet<>(); + resolved.add(PlatformDetector.detectClassifier("linux", "x64", PlatformDetector.LinuxLibc.GLIBC)); + resolved.add(PlatformDetector.detectClassifier("linux", "arm64", PlatformDetector.LinuxLibc.GLIBC)); + resolved.add(PlatformDetector.detectClassifier("linux", "x64", PlatformDetector.LinuxLibc.MUSL)); + resolved.add(PlatformDetector.detectClassifier("linux", "arm64", PlatformDetector.LinuxLibc.MUSL)); + resolved.add(PlatformDetector.detectClassifier("darwin", "x64", PlatformDetector.LinuxLibc.UNKNOWN)); + resolved.add(PlatformDetector.detectClassifier("darwin", "arm64", PlatformDetector.LinuxLibc.UNKNOWN)); + resolved.add(PlatformDetector.detectClassifier("win32", "x64", PlatformDetector.LinuxLibc.UNKNOWN)); + resolved.add(PlatformDetector.detectClassifier("win32", "arm64", PlatformDetector.LinuxLibc.UNKNOWN)); + + assertEquals(expected, resolved); + } + + @Test + void detectClassifierFailsFastForUnsupportedTuple() { + assertThrows(IllegalStateException.class, + () -> PlatformDetector.detectClassifier("darwin", "mips64", PlatformDetector.LinuxLibc.UNKNOWN)); + } + + @Test + void detectClassifierFailsForUnsupportedCurrentPlatform() { + withSystemProperties("Solaris", "amd64", + () -> assertThrows(IllegalStateException.class, PlatformDetector::detectClassifier)); + } + + @Test + void detectLinuxLibcReturnsUnknownWhenElfParsingFails() { + byte[] invalidProbe = new byte[64]; + Arrays.fill(invalidProbe, (byte) 1); + + assertThrows(IOException.class, () -> PlatformDetector.detectLinuxLibc(invalidProbe)); + } + + @Test + void detectLinuxLibcReturnsUnknownForTruncatedProgramHeader(@TempDir Path tempDir) throws IOException { + byte[] malformedProbe = buildElf64ProbeWithInterp("/lib64/ld-linux-x86-64.so.2"); + writeLe64(malformedProbe, 32, malformedProbe.length - 1); + writeLe16(malformedProbe, 54, 1); + Path executable = tempDir.resolve("malformed-elf"); + Files.write(executable, malformedProbe); + + assertEquals(PlatformDetector.LinuxLibc.UNKNOWN, PlatformDetector.detectLinuxLibc(executable)); + } + + private static void withSystemProperties(String osName, String osArch, Runnable action) { + String previousOsName = System.getProperty("os.name"); + String previousOsArch = System.getProperty("os.arch"); + try { + System.setProperty("os.name", osName); + System.setProperty("os.arch", osArch); + action.run(); + } finally { + restoreProperty("os.name", previousOsName); + restoreProperty("os.arch", previousOsArch); + } + } + + private static void withSystemProperty(String key, String value, Runnable action) { + String previousValue = System.getProperty(key); + try { + System.setProperty(key, value); + action.run(); + } finally { + restoreProperty(key, previousValue); + } + } + + private static void restoreProperty(String key, String value) { + if (value == null) { + System.clearProperty(key); + } else { + System.setProperty(key, value); + } + } + + private static byte[] buildElf64ProbeWithInterp(String interpreterPath) { + byte[] interpBytes = interpreterPath.getBytes(StandardCharsets.UTF_8); + byte[] probe = new byte[512]; + + probe[0] = 0x7F; + probe[1] = 'E'; + probe[2] = 'L'; + probe[3] = 'F'; + probe[4] = 2; + probe[5] = 1; + + int phoff = 64; + int phentsize = 56; + int phnum = 1; + int interpOffset = 256; + int interpSize = interpBytes.length + 1; + + writeLe64(probe, 32, phoff); + writeLe16(probe, 54, phentsize); + writeLe16(probe, 56, phnum); + + int pHeader = phoff; + writeLe32(probe, pHeader, 3); + writeLe64(probe, pHeader + 8, interpOffset); + writeLe64(probe, pHeader + 32, interpSize); + + System.arraycopy(interpBytes, 0, probe, interpOffset, interpBytes.length); + probe[interpOffset + interpBytes.length] = 0; + return probe; + } + + private static void writeLe16(byte[] buffer, int offset, int value) { + buffer[offset] = (byte) (value & 0xFF); + buffer[offset + 1] = (byte) ((value >>> 8) & 0xFF); + } + + private static void writeLe32(byte[] buffer, int offset, int value) { + buffer[offset] = (byte) (value & 0xFF); + buffer[offset + 1] = (byte) ((value >>> 8) & 0xFF); + buffer[offset + 2] = (byte) ((value >>> 16) & 0xFF); + buffer[offset + 3] = (byte) ((value >>> 24) & 0xFF); + } + + private static void writeLe64(byte[] buffer, int offset, long value) { + for (int i = 0; i < 8; i++) { + buffer[offset + i] = (byte) ((value >>> (8 * i)) & 0xFF); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/ffi/QueueInputStreamTest.java b/java/sdk/src/test/java/com/github/copilot/ffi/QueueInputStreamTest.java new file mode 100644 index 000000000..6fd961670 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/ffi/QueueInputStreamTest.java @@ -0,0 +1,81 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.ffi; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.Test; + +class QueueInputStreamTest { + + @Test + void readReturnsEnqueuedBytesAcrossMultipleChunks() throws Exception { + QueueInputStream stream = new QueueInputStream(); + stream.enqueue("hello ".getBytes(StandardCharsets.UTF_8)); + stream.enqueue("world".getBytes(StandardCharsets.UTF_8)); + + byte[] buffer = new byte[11]; + int first = stream.read(buffer, 0, 6); + int second = stream.read(buffer, 6, 5); + + assertEquals(6, first); + assertEquals(5, second); + assertArrayEquals("hello world".getBytes(StandardCharsets.UTF_8), buffer); + } + + @Test + void readBlocksUntilDataArrives() throws Exception { + QueueInputStream stream = new QueueInputStream(); + + CompletableFuture readFuture = CompletableFuture.supplyAsync(() -> { + try { + return stream.read(); + } catch (IOException e) { + throw new RuntimeException(e); + } + }); + + Thread.sleep(100); + stream.enqueue(new byte[]{(byte) 'A'}); + + assertEquals((int) 'A', readFuture.get(2, TimeUnit.SECONDS)); + } + + @Test + void closeSignalsEndOfStream() throws Exception { + QueueInputStream stream = new QueueInputStream(); + stream.enqueue("x".getBytes(StandardCharsets.UTF_8)); + + assertEquals('x', stream.read()); + stream.close(); + assertEquals(-1, stream.read()); + } + + @Test + void closeUnblocksPendingReadWithEof() throws Exception { + QueueInputStream stream = new QueueInputStream(); + + CompletableFuture readFuture = CompletableFuture.supplyAsync(() -> { + try { + return stream.read(); + } catch (IOException e) { + throw new RuntimeException(e); + } + }); + + Thread.sleep(100); + stream.close(); + + assertEquals(-1, readFuture.get(2, TimeUnit.SECONDS)); + assertTrue(readFuture.isDone()); + } +} diff --git a/java/src/test/java/com/github/copilot/generated/GeneratedEventTypesCoverageTest.java b/java/sdk/src/test/java/com/github/copilot/generated/GeneratedEventTypesCoverageTest.java similarity index 100% rename from java/src/test/java/com/github/copilot/generated/GeneratedEventTypesCoverageTest.java rename to java/sdk/src/test/java/com/github/copilot/generated/GeneratedEventTypesCoverageTest.java diff --git a/java/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java b/java/sdk/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java similarity index 97% rename from java/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java rename to java/sdk/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java index c882a3b09..1b9b99bb5 100644 --- a/java/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java +++ b/java/sdk/src/test/java/com/github/copilot/generated/GeneratedTypesJacksonRoundTripTest.java @@ -59,9 +59,6 @@ Collection roundTripAllGeneratedRecords() { for (Class cls : discoverGeneratedClasses()) { if (!cls.isRecord()) continue; - // Skip abstract/sealed event base class — it requires a "type" discriminator - if (cls == SessionEvent.class) - continue; tests.add(DynamicTest.dynamicTest("record round-trip: " + cls.getSimpleName(), () -> { // Deserialize from empty JSON — all fields will be null/default Object instance = MAPPER.readValue("{}", cls); diff --git a/java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java b/java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java similarity index 98% rename from java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java rename to java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java index 4bc1cc06b..e92b0f968 100644 --- a/java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java +++ b/java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcApiCoverageTest.java @@ -498,7 +498,7 @@ void sessionRpc_permissions_handlePendingPermissionRequest_merges_sessionId() { var stub = new StubCaller(); var session = new SessionRpc(stub, "sess-perm"); - var permParams = new SessionPermissionsHandlePendingPermissionRequestParams(null, "req-perm-1", "allow"); + var permParams = new SessionPermissionsHandlePendingPermissionRequestParams(null, "req-perm-1", "allow", null); session.permissions.handlePendingPermissionRequest(permParams); assertEquals(1, stub.calls.size()); @@ -551,8 +551,8 @@ void sessionRpc_history_compact_injects_sessionId() { assertEquals(1, stub.calls.size()); assertEquals("session.history.compact", stub.calls.get(0).method()); - var params = (Map) stub.calls.get(0).params(); - assertEquals("sess-hist", params.get("sessionId")); + var params = (com.fasterxml.jackson.databind.node.ObjectNode) stub.calls.get(0).params(); + assertEquals("sess-hist", params.get("sessionId").asText()); } @Test @@ -663,14 +663,6 @@ void sessionsForkParams_record() { assertEquals("event-123", params.toEventId()); } - // ── SessionAgentDeselectResult (empty record) ────────────────────────── - - @Test - void sessionAgentDeselectResult_empty_record() { - var result = new SessionAgentDeselectResult(); - assertNotNull(result); - } - // ── SessionLogParams enum ────────────────────────────────────────────── @Test diff --git a/java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java b/java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java similarity index 87% rename from java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java rename to java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java index d34fa76b1..80d224bbc 100644 --- a/java/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java +++ b/java/sdk/src/test/java/com/github/copilot/generated/rpc/GeneratedRpcRecordsCoverageTest.java @@ -87,7 +87,7 @@ void sessionAgentGetCurrentParams_record() { @Test void sessionAgentListParams_record() { - var params = new SessionAgentListParams("sess-3"); + var params = new SessionAgentListParams("sess-3", null, null); assertEquals("sess-3", params.sessionId()); } @@ -234,8 +234,12 @@ void sessionFsWriteFileParams_record() { @Test void sessionHistoryCompactParams_record() { - var params = new SessionHistoryCompactParams("sess-22"); + var params = new SessionHistoryCompactParams("sess-22", "focus on the API surface", + SessionHistoryCompactParams.SessionHistoryCompactParamsTrigger.MANUAL, 4096L); assertEquals("sess-22", params.sessionId()); + assertEquals("focus on the API surface", params.customInstructions()); + assertEquals(SessionHistoryCompactParams.SessionHistoryCompactParamsTrigger.MANUAL, params.trigger()); + assertEquals(4096L, params.tokenLimit()); } @Test @@ -321,20 +325,24 @@ void sessionModelGetCurrentParams_record() { @Test void sessionModelSwitchToParams_record() { - var params = new SessionModelSwitchToParams("sess-32", "claude-sonnet-4.5", "high", null, null); + var params = new SessionModelSwitchToParams("sess-32", "claude-sonnet-4.5", "high", null, null, null, null, + null); assertEquals("sess-32", params.sessionId()); assertEquals("claude-sonnet-4.5", params.modelId()); assertEquals("high", params.reasoningEffort()); assertNull(params.reasoningSummary()); + assertNull(params.verbosity()); assertNull(params.modelCapabilities()); + assertNull(params.deferIfModelChangeQueued()); } @Test void sessionPermissionsHandlePendingPermissionRequestParams_record() { - var params = new SessionPermissionsHandlePendingPermissionRequestParams("sess-33", "req-1", "allow"); + var params = new SessionPermissionsHandlePendingPermissionRequestParams("sess-33", "req-1", "allow", null); assertEquals("sess-33", params.sessionId()); assertEquals("req-1", params.requestId()); assertEquals("allow", params.result()); + assertNull(params.decisionContext()); } @Test @@ -447,27 +455,6 @@ void sessionUsageGetMetricsParams_record() { assertEquals("sess-47", params.sessionId()); } - @Test - void sessionWorkspaceCreateFileParams_record() { - var params = new SessionWorkspaceCreateFileParams("sess-48", "README.md", "# Hello"); - assertEquals("sess-48", params.sessionId()); - assertEquals("README.md", params.path()); - assertEquals("# Hello", params.content()); - } - - @Test - void sessionWorkspaceListFilesParams_record() { - var params = new SessionWorkspaceListFilesParams("sess-49"); - assertEquals("sess-49", params.sessionId()); - } - - @Test - void sessionWorkspaceReadFileParams_record() { - var params = new SessionWorkspaceReadFileParams("sess-50", "src/Main.java"); - assertEquals("sess-50", params.sessionId()); - assertEquals("src/Main.java", params.path()); - } - // ── Result records ───────────────────────────────────────────────────── @Test @@ -479,15 +466,10 @@ void pingResult_fields() { assertEquals(1L, result.protocolVersion()); } - @Test - void sessionAgentDeselectResult_empty() { - assertNotNull(new SessionAgentDeselectResult()); - } - @Test void sessionAgentListResult_with_items() { var item = new AgentInfo("name1", "Name One", "Desc 1", "/path/to/agent1", null, null, null, null, null, null, - null); + null, null); var result = new SessionAgentListResult(List.of(item)); assertEquals(1, result.agents().size()); assertEquals("name1", result.agents().get(0).name()); @@ -498,7 +480,7 @@ void sessionAgentListResult_with_items() { @Test void sessionAgentGetCurrentResult_nested() { - var agent = new AgentInfo("agent-1", "Agent One", "Does things", null, null, null, null, null, null, null, + var agent = new AgentInfo("agent-1", "Agent One", "Does things", null, null, null, null, null, null, null, null, null); var result = new SessionAgentGetCurrentResult(agent); assertEquals("agent-1", result.agent().name()); @@ -515,7 +497,7 @@ void sessionAgentGetCurrentResult_null_agent() { @Test void sessionAgentReloadResult_with_items() { - var item = new AgentInfo("a", "A", "Desc", "/path/to/a", null, null, null, null, null, null, null); + var item = new AgentInfo("a", "A", "Desc", "/path/to/a", null, null, null, null, null, null, null, null); var result = new SessionAgentReloadResult(List.of(item)); assertEquals(1, result.agents().size()); assertEquals("a", result.agents().get(0).name()); @@ -524,7 +506,7 @@ void sessionAgentReloadResult_with_items() { @Test void sessionAgentSelectResult_nested() { var agent = new AgentInfo("selected", "Selected", "The selected agent", "/path/to/selected", null, null, null, - null, null, null, null); + null, null, null, null, null); var result = new SessionAgentSelectResult(agent); assertEquals("selected", result.agent().name()); } @@ -536,16 +518,6 @@ void sessionCommandsHandlePendingCommandResult_record() { assertFalse(new SessionCommandsHandlePendingCommandResult(false).success()); } - @Test - void sessionExtensionsDisableResult_empty() { - assertNotNull(new SessionExtensionsDisableResult()); - } - - @Test - void sessionExtensionsEnableResult_empty() { - assertNotNull(new SessionExtensionsEnableResult()); - } - @Test void sessionExtensionsListResult_nested() { var ext = new Extension("ext-1", "My Extension", ExtensionSource.PROJECT, ExtensionStatus.RUNNING, 1234L); @@ -572,11 +544,6 @@ void sessionExtensionsListResult_enums() { assertThrows(IllegalArgumentException.class, () -> ExtensionStatus.fromValue("unknown")); } - @Test - void sessionExtensionsReloadResult_empty() { - assertNotNull(new SessionExtensionsReloadResult()); - } - @Test void sessionFleetStartResult_record() { var result = new SessionFleetStartResult(true); @@ -654,8 +621,10 @@ void sessionHistoryCompactResult_nested() { @Test void sessionHistoryTruncateResult_record() { - var result = new SessionHistoryTruncateResult(3L); + var result = new SessionHistoryTruncateResult(3L, false, null); assertEquals(3L, result.eventsRemoved()); + assertEquals(false, result.checkpointCleanupFailed()); + assertNull(result.checkpointCleanupError()); } @Test @@ -665,20 +634,10 @@ void sessionLogResult_record() { assertEquals(id, result.eventId()); } - @Test - void sessionMcpDisableResult_empty() { - assertNotNull(new SessionMcpDisableResult()); - } - - @Test - void sessionMcpEnableResult_empty() { - assertNotNull(new SessionMcpEnableResult()); - } - @Test void sessionMcpListResult_nested() { - var server = new McpServer("my-mcp", McpServerStatus.CONNECTED, McpServerSource.USER, null); - var result = new SessionMcpListResult(List.of(server)); + var server = new McpServer("my-mcp", McpServerStatus.CONNECTED, McpServerSource.USER, null, null, null); + var result = new SessionMcpListResult(List.of(server), null); assertEquals(1, result.servers().size()); assertEquals("my-mcp", result.servers().get(0).name()); assertEquals(McpServerStatus.CONNECTED, result.servers().get(0).status()); @@ -694,40 +653,17 @@ void sessionMcpListResult_status_enum_all_values() { assertThrows(IllegalArgumentException.class, () -> McpServerStatus.fromValue("unknown-status")); } - @Test - void sessionMcpReloadResult_empty() { - assertNotNull(new SessionMcpReloadResult()); - } - - @Test - void sessionModeGetResult_enum() { - var result = new SessionModeGetResult(SessionModeGetResult.SessionModeGetResultMode.INTERACTIVE); - assertEquals(SessionModeGetResult.SessionModeGetResultMode.INTERACTIVE, result.mode()); - assertEquals("interactive", result.mode().getValue()); - for (var mode : SessionModeGetResult.SessionModeGetResultMode.values()) { - assertEquals(mode, SessionModeGetResult.SessionModeGetResultMode.fromValue(mode.getValue())); - } - assertThrows(IllegalArgumentException.class, - () -> SessionModeGetResult.SessionModeGetResultMode.fromValue("unknown")); - } - - @Test - void sessionModeSetResult_enum() { - var result = new SessionModeSetResult(SessionModeSetResult.SessionModeSetResultMode.AUTOPILOT); - assertEquals(SessionModeSetResult.SessionModeSetResultMode.AUTOPILOT, result.mode()); - assertEquals("autopilot", result.mode().getValue()); - } - @Test void sessionModelGetCurrentResult_record() { - var result = new SessionModelGetCurrentResult("claude-sonnet-4.5", null); + var result = new SessionModelGetCurrentResult("claude-sonnet-4.5", null, null); assertEquals("claude-sonnet-4.5", result.modelId()); } @Test void sessionModelSwitchToResult_record() { - var result = new SessionModelSwitchToResult("gpt-5"); + var result = new SessionModelSwitchToResult("gpt-5", true); assertEquals("gpt-5", result.modelId()); + assertEquals(true, result.deferred()); } @Test @@ -737,11 +673,6 @@ void sessionPermissionsHandlePendingPermissionRequestResult_record() { assertFalse(new SessionPermissionsHandlePendingPermissionRequestResult(false).success()); } - @Test - void sessionPlanDeleteResult_empty() { - assertNotNull(new SessionPlanDeleteResult()); - } - @Test void sessionPlanReadResult_record() { var result = new SessionPlanReadResult(true, "# Plan\n1. Do stuff", "/workspace/.plan"); @@ -750,11 +681,6 @@ void sessionPlanReadResult_record() { assertEquals("/workspace/.plan", result.path()); } - @Test - void sessionPlanUpdateResult_empty() { - assertNotNull(new SessionPlanUpdateResult()); - } - @Test void sessionPluginsListResult_nested() { var plugin = new Plugin("my-plugin", "marketplace-x", "1.2.3", true); @@ -779,22 +705,14 @@ void sessionShellKillResult_record() { assertFalse(new SessionShellKillResult(false).killed()); } - @Test - void sessionSkillsDisableResult_empty() { - assertNotNull(new SessionSkillsDisableResult()); - } - - @Test - void sessionSkillsEnableResult_empty() { - assertNotNull(new SessionSkillsEnableResult()); - } - @Test void sessionSkillsListResult_nested() { - var item = new Skill("deploy", "Deploy the app", SkillSource.PROJECT, true, true, "/skills/deploy.md", null); + var item = new Skill("deploy", "deploy", "Deploy the app", SkillSource.PROJECT, true, true, "/skills/deploy.md", + null, null); var result = new SessionSkillsListResult(List.of(item)); assertEquals(1, result.skills().size()); assertEquals("deploy", result.skills().get(0).name()); + assertEquals("deploy", result.skills().get(0).commandName()); assertEquals(SkillSource.PROJECT, result.skills().get(0).source()); assertTrue(result.skills().get(0).enabled()); } @@ -849,24 +767,6 @@ void sessionUsageGetMetricsResult_nested() { assertEquals("gpt-5", result.currentModel()); } - @Test - void sessionWorkspaceCreateFileResult_empty() { - assertNotNull(new SessionWorkspaceCreateFileResult()); - } - - @Test - void sessionWorkspaceListFilesResult_record() { - var result = new SessionWorkspaceListFilesResult(List.of("src/Main.java", "README.md")); - assertEquals(2, result.files().size()); - assertEquals("src/Main.java", result.files().get(0)); - } - - @Test - void sessionWorkspaceReadFileResult_record() { - var result = new SessionWorkspaceReadFileResult("public class Main {}"); - assertEquals("public class Main {}", result.content()); - } - @Test void sessionsForkResult_record() { var result = new SessionsForkResult("forked-sess-id", null); @@ -900,7 +800,7 @@ void mcpConfigListResult_record() { @Test void mcpDiscoverResult_nested() { var server = new DiscoveredMcpServer("discovered-server", DiscoveredMcpServerType.STDIO, McpServerSource.USER, - true); + null, null, true); var result = new McpDiscoverResult(List.of(server)); assertEquals(1, result.servers().size()); assertEquals("discovered-server", result.servers().get(0).name()); @@ -909,23 +809,15 @@ void mcpDiscoverResult_nested() { assertTrue(result.servers().get(0).enabled()); } - @Test - void mcpDiscoverResult_source_enum_all_values() { - for (var src : DiscoveredMcpServerSource.values()) { - assertNotNull(src.getValue()); - assertEquals(src, DiscoveredMcpServerSource.fromValue(src.getValue())); - } - assertThrows(IllegalArgumentException.class, () -> DiscoveredMcpServerSource.fromValue("unknown-source")); - } - @Test void modelsListResult_nested() { - var supports = new ModelCapabilitiesSupports(true, false); + var supports = new ModelCapabilitiesSupports(true, false, null); var limits = new ModelCapabilitiesLimits(100000L, 8192L, 128000L, null); var capabilities = new ModelCapabilities(supports, limits); var policy = new ModelPolicy(ModelPolicyState.ENABLED, null); - var billing = new ModelBilling(1.0, null); - var modelItem = new Model("gpt-5", "GPT-5", capabilities, policy, billing, null, null, null, null); + var promo = new ModelBillingPromo("summer-2026", 25.0, "2026-08-01T00:00:00Z", "Summer discount"); + var billing = new ModelBilling(1.0, null, null, promo); + var modelItem = new Model("gpt-5", "GPT-5", capabilities, policy, billing, null, null, null); var result = new ModelsListResult(List.of(modelItem)); assertEquals(1, result.models().size()); @@ -936,6 +828,10 @@ void modelsListResult_nested() { assertEquals(100000L, result.models().get(0).capabilities().limits().maxPromptTokens()); assertEquals(ModelPolicyState.ENABLED, result.models().get(0).policy().state()); assertEquals(Double.valueOf(1.0), result.models().get(0).billing().multiplier()); + assertEquals("summer-2026", result.models().get(0).billing().promo().id()); + assertEquals(Double.valueOf(25.0), result.models().get(0).billing().promo().discountPercent()); + assertEquals("2026-08-01T00:00:00Z", result.models().get(0).billing().promo().endsAt()); + assertEquals("Summer discount", result.models().get(0).billing().promo().message()); } @Test @@ -955,9 +851,9 @@ void toolsListResult_nested() { void sessionModelSwitchToParams_nested_records() { var limitsVision = new ModelCapabilitiesOverrideLimitsVision(List.of("image/png", "image/jpeg"), 10L, 5000000L); var limits = new ModelCapabilitiesOverrideLimits(100000L, 8192L, 128000L, limitsVision); - var supports = new ModelCapabilitiesOverrideSupports(true, true); + var supports = new ModelCapabilitiesOverrideSupports(true, true, null); var capabilities = new ModelCapabilitiesOverride(supports, limits); - var params = new SessionModelSwitchToParams("sess-m", "gpt-5", null, null, capabilities); + var params = new SessionModelSwitchToParams("sess-m", "gpt-5", null, null, null, capabilities, null, null); assertEquals("gpt-5", params.modelId()); assertNotNull(params.modelCapabilities()); diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java new file mode 100644 index 000000000..8ad4ee830 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/ParamCoercionTest.java @@ -0,0 +1,362 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.Map; +import java.util.OptionalDouble; +import java.util.OptionalInt; +import java.util.OptionalLong; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.tool.Param; + +/** + * Unit tests for {@link ParamCoercion} — runtime argument coercion from raw + * invocation maps to typed Java values declared by {@link Param} descriptors. + */ +class ParamCoercionTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + // ── coerce: present argument, simple types ─────────────────────────────────── + + @Test + void coerce_stringArg_passedThrough() { + Param p = Param.of(String.class, "msg", "A message"); + String result = ParamCoercion.coerce(Map.of("msg", "hello"), p, MAPPER); + assertEquals("hello", result); + } + + @Test + void coerce_integerArgFromNumber() { + Param p = Param.of(Integer.class, "n", "A number"); + Integer result = ParamCoercion.coerce(Map.of("n", 42), p, MAPPER); + assertEquals(42, result); + } + + @Test + void coerce_longArgFromNumber() { + Param p = Param.of(Long.class, "id", "An identifier"); + Long result = ParamCoercion.coerce(Map.of("id", 123456789L), p, MAPPER); + assertEquals(123456789L, result); + } + + @Test + void coerce_doubleArgFromNumber() { + Param p = Param.of(Double.class, "price", "A price"); + Double result = ParamCoercion.coerce(Map.of("price", 19.99), p, MAPPER); + assertEquals(19.99, result, 0.001); + } + + @Test + void coerce_floatArgFromNumber() { + Param p = Param.of(Float.class, "rate", "A rate"); + Float result = ParamCoercion.coerce(Map.of("rate", 3.14), p, MAPPER); + assertEquals(3.14f, result, 0.01f); + } + + @Test + void coerce_booleanArgFromBoolean() { + Param p = Param.of(Boolean.class, "flag", "A flag"); + Boolean result = ParamCoercion.coerce(Map.of("flag", true), p, MAPPER); + assertEquals(true, result); + } + + // Note: enum coercion via mapper.convertValue requires the enum's package to be + // opened to com.fasterxml.jackson.databind. In the SDK module, + // com.github.copilot.tool + // is not opened to Jackson (only com.github.copilot.rpc is). User-defined enums + // will + // be outside the SDK module and fully accessible. Enum default coercion is + // tested via + // coerceDefault_enum which uses Enum.valueOf directly. + + @Test + void coerce_enumFromString_viaCoerceDefault() { + Param p = Param.of(TestMode.class, "mode", "Mode", false, "FAST"); + TestMode result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(TestMode.FAST, result); + } + + // ── coerce: Optional primitive types ───────────────────────────────────────── + + @Test + void coerce_optionalInt_fromNumber() { + Param p = Param.of(OptionalInt.class, "count", "Count", false, ""); + OptionalInt result = ParamCoercion.coerce(Map.of("count", 7), p, MAPPER); + assertEquals(OptionalInt.of(7), result); + } + + @Test + void coerce_optionalLong_fromNumber() { + Param p = Param.of(OptionalLong.class, "ts", "Timestamp", false, ""); + OptionalLong result = ParamCoercion.coerce(Map.of("ts", 999L), p, MAPPER); + assertEquals(OptionalLong.of(999L), result); + } + + @Test + void coerce_optionalDouble_fromNumber() { + Param p = Param.of(OptionalDouble.class, "ratio", "Ratio", false, ""); + OptionalDouble result = ParamCoercion.coerce(Map.of("ratio", 2.5), p, MAPPER); + assertEquals(OptionalDouble.of(2.5), result); + } + + @Test + void coerce_optionalInt_nonNumeric_throwsIllegalArgument() { + Param p = Param.of(OptionalInt.class, "count", "Count", false, ""); + assertThrows(IllegalArgumentException.class, + () -> ParamCoercion.coerce(Map.of("count", "not_a_number"), p, MAPPER)); + } + + @Test + void coerce_optionalLong_nonNumeric_throwsIllegalArgument() { + Param p = Param.of(OptionalLong.class, "ts", "Timestamp", false, ""); + assertThrows(IllegalArgumentException.class, () -> ParamCoercion.coerce(Map.of("ts", "abc"), p, MAPPER)); + } + + @Test + void coerce_optionalDouble_nonNumeric_throwsIllegalArgument() { + Param p = Param.of(OptionalDouble.class, "ratio", "Ratio", false, ""); + assertThrows(IllegalArgumentException.class, () -> ParamCoercion.coerce(Map.of("ratio", "xyz"), p, MAPPER)); + } + + // ── coerce: missing argument — required ────────────────────────────────────── + + @Test + void coerce_requiredMissing_throwsWithParamName() { + Param p = Param.of(String.class, "query", "Search query"); + var ex = assertThrows(IllegalArgumentException.class, () -> ParamCoercion.coerce(Map.of(), p, MAPPER)); + assertTrue(ex.getMessage().contains("query")); + } + + @Test + void coerce_requiredMissing_nullArgs_throws() { + Param p = Param.of(String.class, "name", "A name"); + var ex = assertThrows(IllegalArgumentException.class, () -> ParamCoercion.coerce(null, p, MAPPER)); + assertTrue(ex.getMessage().contains("name")); + } + + // ── coerce: missing argument — optional with default ───────────────────────── + + @Test + void coerce_optionalWithStringDefault_usesDefault() { + Param p = Param.of(String.class, "mode", "Mode", false, "normal"); + String result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals("normal", result); + } + + @Test + void coerce_optionalWithIntegerDefault_usesDefault() { + Param p = Param.of(Integer.class, "limit", "Limit", false, "25"); + Integer result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(25, result); + } + + @Test + void coerce_optionalWithLongDefault_usesDefault() { + Param p = Param.of(Long.class, "offset", "Offset", false, "100"); + Long result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(100L, result); + } + + @Test + void coerce_optionalWithDoubleDefault_usesDefault() { + Param p = Param.of(Double.class, "threshold", "Threshold", false, "0.75"); + Double result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(0.75, result, 0.001); + } + + @Test + void coerce_optionalWithFloatDefault_usesDefault() { + Param p = Param.of(Float.class, "rate", "Rate", false, "1.5"); + Float result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(1.5f, result, 0.01f); + } + + @Test + void coerce_optionalWithShortDefault_usesDefault() { + Param p = Param.of(Short.class, "level", "Level", false, "3"); + Short result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals((short) 3, result); + } + + @Test + void coerce_optionalWithByteDefault_usesDefault() { + Param p = Param.of(Byte.class, "code", "Code", false, "7"); + Byte result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals((byte) 7, result); + } + + @Test + void coerce_optionalWithBooleanDefault_usesDefault() { + Param p = Param.of(Boolean.class, "verbose", "Verbose", false, "true"); + Boolean result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(true, result); + } + + @Test + void coerce_optionalWithEnumDefault_usesDefault() { + Param p = Param.of(TestMode.class, "mode", "Mode", false, "SLOW"); + TestMode result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(TestMode.SLOW, result); + } + + // ── coerce: missing argument — optional without default ────────────────────── + + @Test + void coerce_optionalNoDefault_returnsNull() { + Param p = Param.of(String.class, "title", "Title", false, ""); + String result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertNull(result); + } + + @Test + void coerce_optionalNoDefault_optionalInt_returnsEmpty() { + Param p = Param.of(OptionalInt.class, "n", "Number", false, ""); + OptionalInt result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(OptionalInt.empty(), result); + } + + @Test + void coerce_optionalNoDefault_optionalLong_returnsEmpty() { + Param p = Param.of(OptionalLong.class, "ts", "Timestamp", false, ""); + OptionalLong result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(OptionalLong.empty(), result); + } + + @Test + void coerce_optionalNoDefault_optionalDouble_returnsEmpty() { + Param p = Param.of(OptionalDouble.class, "ratio", "Ratio", false, ""); + OptionalDouble result = ParamCoercion.coerce(Map.of(), p, MAPPER); + assertEquals(OptionalDouble.empty(), result); + } + + // ── coerce: type conversion via ObjectMapper ───────────────────────────────── + + @Test + void coerce_integerFromStringViaMapper() { + // ObjectMapper can convert "42" string to Integer + Param p = Param.of(Integer.class, "n", "A number"); + Integer result = ParamCoercion.coerce(Map.of("n", "42"), p, MAPPER); + assertEquals(42, result); + } + + @Test + void coerce_booleanFromStringViaMapper() { + Param p = Param.of(Boolean.class, "flag", "A flag"); + Boolean result = ParamCoercion.coerce(Map.of("flag", "true"), p, MAPPER); + assertEquals(true, result); + } + + @Test + void coerce_incompatibleType_throwsWithParamName() { + Param p = Param.of(Integer.class, "count", "Count"); + var ex = assertThrows(IllegalArgumentException.class, + () -> ParamCoercion.coerce(Map.of("count", "not_a_number"), p, MAPPER)); + assertTrue(ex.getMessage().contains("count")); + } + + // ── coerceDefault: direct tests ────────────────────────────────────────────── + + @Test + void coerceDefault_string() { + Param p = Param.of(String.class, "s", "A string", false, "hello"); + assertEquals("hello", ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_integer() { + Param p = Param.of(Integer.class, "n", "A num", false, "99"); + assertEquals(99, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_long() { + Param p = Param.of(Long.class, "id", "An id", false, "12345"); + assertEquals(12345L, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_double() { + Param p = Param.of(Double.class, "d", "A double", false, "3.14"); + assertEquals(3.14, ParamCoercion.coerceDefault(p, MAPPER), 0.001); + } + + @Test + void coerceDefault_float() { + Param p = Param.of(Float.class, "f", "A float", false, "2.5"); + assertEquals(2.5f, ParamCoercion.coerceDefault(p, MAPPER), 0.01f); + } + + @Test + void coerceDefault_short() { + Param p = Param.of(Short.class, "s", "A short", false, "10"); + assertEquals((short) 10, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_byte() { + Param p = Param.of(Byte.class, "b", "A byte", false, "5"); + assertEquals((byte) 5, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_booleanTrue() { + Param p = Param.of(Boolean.class, "v", "Verbose", false, "true"); + assertEquals(true, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_booleanFalse() { + Param p = Param.of(Boolean.class, "v", "Verbose", false, "false"); + assertEquals(false, ParamCoercion.coerceDefault(p, MAPPER)); + } + + @Test + void coerceDefault_enum() { + Param p = Param.of(TestMode.class, "m", "Mode", false, "FAST"); + assertEquals(TestMode.FAST, ParamCoercion.coerceDefault(p, MAPPER)); + } + + // ── emptyOptionalOrNull: direct tests ──────────────────────────────────────── + + @Test + void emptyOptionalOrNull_optionalInt_returnsEmpty() { + assertEquals(OptionalInt.empty(), ParamCoercion.emptyOptionalOrNull(OptionalInt.class)); + } + + @Test + void emptyOptionalOrNull_optionalLong_returnsEmpty() { + assertEquals(OptionalLong.empty(), ParamCoercion.emptyOptionalOrNull(OptionalLong.class)); + } + + @Test + void emptyOptionalOrNull_optionalDouble_returnsEmpty() { + assertEquals(OptionalDouble.empty(), ParamCoercion.emptyOptionalOrNull(OptionalDouble.class)); + } + + @Test + void emptyOptionalOrNull_string_returnsNull() { + assertNull(ParamCoercion.emptyOptionalOrNull(String.class)); + } + + @Test + void emptyOptionalOrNull_integer_returnsNull() { + assertNull(ParamCoercion.emptyOptionalOrNull(Integer.class)); + } + + // ── Test helper types ──────────────────────────────────────────────────────── + + enum TestMode { + FAST, SLOW, NORMAL + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java new file mode 100644 index 000000000..5aea4471d --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/ParamSchemaTest.java @@ -0,0 +1,521 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.math.BigDecimal; +import java.time.Instant; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.OffsetDateTime; +import java.time.ZonedDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.OptionalDouble; +import java.util.OptionalInt; +import java.util.OptionalLong; +import java.util.Set; +import java.util.UUID; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.tool.Param; + +/** + * Unit tests for {@link ParamSchema} — runtime JSON Schema generation from + * {@link Param} descriptors. + */ +class ParamSchemaTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + // ── buildSchema: empty / zero params ───────────────────────────────────────── + + @Test + void buildSchema_nullParams_returnsEmptySchema() { + Map schema = ParamSchema.buildSchema("tool", MAPPER, (Param[]) null); + assertEquals("object", schema.get("type")); + assertTrue(((Map) schema.get("properties")).isEmpty()); + assertTrue(((List) schema.get("required")).isEmpty()); + } + + @Test + void buildSchema_emptyArray_returnsEmptySchema() { + Map schema = ParamSchema.buildSchema("tool", MAPPER); + assertEquals("object", schema.get("type")); + assertTrue(((Map) schema.get("properties")).isEmpty()); + assertTrue(((List) schema.get("required")).isEmpty()); + } + + // ── buildSchema: validation ────────────────────────────────────────────────── + + @Test + void buildSchema_nullParamElement_throwsWithToolName() { + Param p1 = Param.of(String.class, "a", "First"); + var ex = assertThrows(IllegalArgumentException.class, + () -> ParamSchema.buildSchema("my_tool", MAPPER, p1, null)); + assertTrue(ex.getMessage().contains("my_tool")); + } + + @Test + void buildSchema_duplicateNames_throwsWithToolNameAndParamName() { + Param p1 = Param.of(String.class, "name", "First name"); + Param p2 = Param.of(String.class, "name", "Second name"); + var ex = assertThrows(IllegalArgumentException.class, + () -> ParamSchema.buildSchema("greeting", MAPPER, p1, p2)); + assertTrue(ex.getMessage().contains("name")); + assertTrue(ex.getMessage().contains("greeting")); + } + + // ── buildSchema: required / optional semantics ─────────────────────────────── + + @Test + void buildSchema_requiredParam_appearsInRequiredList() { + Param p = Param.of(String.class, "query", "Search query"); + Map schema = ParamSchema.buildSchema("search", MAPPER, p); + @SuppressWarnings("unchecked") + List required = (List) schema.get("required"); + assertTrue(required.contains("query")); + } + + @Test + void buildSchema_optionalParam_notInRequiredList() { + Param p = Param.of(Integer.class, "limit", "Max results", false, "10"); + Map schema = ParamSchema.buildSchema("list", MAPPER, p); + @SuppressWarnings("unchecked") + List required = (List) schema.get("required"); + assertTrue(required.isEmpty()); + } + + @Test + void buildSchema_mixedRequiredAndOptional_onlyRequiredInList() { + Param pReq = Param.of(String.class, "query", "Search query"); + Param pOpt = Param.of(Integer.class, "limit", "Max", false, "20"); + Map schema = ParamSchema.buildSchema("search", MAPPER, pReq, pOpt); + @SuppressWarnings("unchecked") + List required = (List) schema.get("required"); + assertEquals(1, required.size()); + assertEquals("query", required.get(0)); + } + + // ── buildSchema: description and default in property ───────────────────────── + + @Test + void buildSchema_paramDescription_appearsInPropertySchema() { + Param p = Param.of(String.class, "msg", "A message to send"); + Map schema = ParamSchema.buildSchema("send", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map msgSchema = (Map) props.get("msg"); + assertEquals("A message to send", msgSchema.get("description")); + } + + @Test + void buildSchema_paramDefault_appearsInPropertySchema() { + Param p = Param.of(Integer.class, "count", "Item count", false, "5"); + Map schema = ParamSchema.buildSchema("items", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map countSchema = (Map) props.get("count"); + assertEquals(5, countSchema.get("default")); + } + + @Test + void buildSchema_stringDefault_appearsAsString() { + Param p = Param.of(String.class, "mode", "Operating mode", false, "fast"); + Map schema = ParamSchema.buildSchema("run", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map modeSchema = (Map) props.get("mode"); + assertEquals("fast", modeSchema.get("default")); + } + + @Test + void buildSchema_booleanDefault_appearsAsBoolean() { + Param p = Param.of(Boolean.class, "verbose", "Verbose mode", false, "true"); + Map schema = ParamSchema.buildSchema("run", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map verboseSchema = (Map) props.get("verbose"); + assertEquals(true, verboseSchema.get("default")); + } + + // ── buildSchema: multiple params preserve order ────────────────────────────── + + @Test + void buildSchema_multipleParams_orderPreservedInProperties() { + Param p1 = Param.of(String.class, "alpha", "First"); + Param p2 = Param.of(String.class, "beta", "Second"); + Param p3 = Param.of(String.class, "gamma", "Third"); + Map schema = ParamSchema.buildSchema("ordered", MAPPER, p1, p2, p3); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + List keys = List.copyOf(props.keySet()); + assertEquals(List.of("alpha", "beta", "gamma"), keys); + } + + // ── buildSchema: schema override ─────────────────────────────────────────── + + @Test + void buildSchema_withSchemaOverride_usesExplicitSchema() { + Param p = Param.of(String.class, "when", "Meeting time") + .schema("{\"type\":\"string\",\"format\":\"date-time\"}"); + Map schema = ParamSchema.buildSchema("schedule", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map whenSchema = (Map) props.get("when"); + assertEquals("string", whenSchema.get("type")); + assertEquals("date-time", whenSchema.get("format")); + } + + @Test + void buildSchema_withSchemaOverride_preservesDescription() { + Param p = Param.of(String.class, "when", "Meeting time") + .schema("{\"type\":\"string\",\"format\":\"date-time\"}"); + Map schema = ParamSchema.buildSchema("schedule", MAPPER, p); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map whenSchema = (Map) props.get("when"); + assertEquals("Meeting time", whenSchema.get("description")); + } + + @Test + void buildSchema_withSchemaOverride_respectsRequired() { + Param p = Param.of(String.class, "when", "Meeting time") + .schema("{\"type\":\"string\",\"format\":\"date-time\"}"); + Map schema = ParamSchema.buildSchema("schedule", MAPPER, p); + @SuppressWarnings("unchecked") + List required = (List) schema.get("required"); + assertTrue(required.contains("when")); + } + + @Test + void buildSchema_mixedParams_overrideAndAuto() { + Param pOverride = Param.of(String.class, "when", "Meeting time") + .schema("{\"type\":\"string\",\"format\":\"date-time\"}"); + Param pAuto = Param.of(String.class, "title", "Meeting title"); + Map schema = ParamSchema.buildSchema("schedule", MAPPER, pOverride, pAuto); + @SuppressWarnings("unchecked") + Map props = (Map) schema.get("properties"); + + @SuppressWarnings("unchecked") + Map whenSchema = (Map) props.get("when"); + assertEquals("date-time", whenSchema.get("format")); + + @SuppressWarnings("unchecked") + Map titleSchema = (Map) props.get("title"); + assertEquals("string", titleSchema.get("type")); + // Auto-generated should NOT have format + assertFalse(titleSchema.containsKey("format")); + } + + @Test + void buildSchema_withSchemaOverride_rejectsTrailingJson() { + Param param = Param.of(String.class, "when", "Meeting time") + .schema("{\"type\":\"string\"} {\"type\":\"integer\"}"); + + IllegalArgumentException error = assertThrows(IllegalArgumentException.class, + () -> ParamSchema.buildSchema("schedule", MAPPER, param)); + + assertTrue(error.getMessage().contains("Invalid schema JSON")); + } + + @Test + void buildSchema_withSchemaOverride_preservesDecimalPrecision() { + Param param = Param.of(String.class, "value", "Precise value") + .schema("{\"type\":\"number\",\"maximum\":1e400,\"multipleOf\":0.12345678901234567890}"); + + Map schema = ParamSchema.buildSchema("calculate", MAPPER, param); + @SuppressWarnings("unchecked") + Map properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map valueSchema = (Map) properties.get("value"); + + assertEquals(new BigDecimal("1e400"), valueSchema.get("maximum")); + assertEquals(new BigDecimal("0.12345678901234567890"), valueSchema.get("multipleOf")); + } + + // ── forType: primitive and boxed integer types ─────────────────────────────── + + @Test + void forType_int_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(int.class)); + } + + @Test + void forType_Integer_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(Integer.class)); + } + + @Test + void forType_long_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(long.class)); + } + + @Test + void forType_Long_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(Long.class)); + } + + @Test + void forType_short_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(short.class)); + } + + @Test + void forType_Short_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(Short.class)); + } + + @Test + void forType_byte_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(byte.class)); + } + + @Test + void forType_Byte_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(Byte.class)); + } + + // ── forType: floating-point types ──────────────────────────────────────────── + + @Test + void forType_double_returnsNumber() { + assertEquals(Map.of("type", "number"), ParamSchema.forType(double.class)); + } + + @Test + void forType_Double_returnsNumber() { + assertEquals(Map.of("type", "number"), ParamSchema.forType(Double.class)); + } + + @Test + void forType_float_returnsNumber() { + assertEquals(Map.of("type", "number"), ParamSchema.forType(float.class)); + } + + @Test + void forType_Float_returnsNumber() { + assertEquals(Map.of("type", "number"), ParamSchema.forType(Float.class)); + } + + // ── forType: boolean ───────────────────────────────────────────────────────── + + @Test + void forType_boolean_returnsBoolean() { + assertEquals(Map.of("type", "boolean"), ParamSchema.forType(boolean.class)); + } + + @Test + void forType_Boolean_returnsBoolean() { + assertEquals(Map.of("type", "boolean"), ParamSchema.forType(Boolean.class)); + } + + // ── forType: char / Character ──────────────────────────────────────────────── + + @Test + void forType_char_returnsString() { + assertEquals(Map.of("type", "string"), ParamSchema.forType(char.class)); + } + + @Test + void forType_Character_returnsString() { + assertEquals(Map.of("type", "string"), ParamSchema.forType(Character.class)); + } + + // ── forType: String ────────────────────────────────────────────────────────── + + @Test + void forType_String_returnsString() { + assertEquals(Map.of("type", "string"), ParamSchema.forType(String.class)); + } + + // ── forType: UUID ──────────────────────────────────────────────────────────── + + @Test + void forType_UUID_returnsStringWithUuidFormat() { + Map schema = ParamSchema.forType(UUID.class); + assertEquals("string", schema.get("type")); + assertEquals("uuid", schema.get("format")); + } + + // ── forType: Optional primitive types ──────────────────────────────────────── + + @Test + void forType_OptionalInt_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(OptionalInt.class)); + } + + @Test + void forType_OptionalLong_returnsInteger() { + assertEquals(Map.of("type", "integer"), ParamSchema.forType(OptionalLong.class)); + } + + @Test + void forType_OptionalDouble_returnsNumber() { + assertEquals(Map.of("type", "number"), ParamSchema.forType(OptionalDouble.class)); + } + + // ── forType: date-time types ───────────────────────────────────────────────── + + @Test + void forType_OffsetDateTime_returnsDateTimeFormat() { + Map schema = ParamSchema.forType(OffsetDateTime.class); + assertEquals("string", schema.get("type")); + assertEquals("date-time", schema.get("format")); + } + + @Test + void forType_LocalDateTime_returnsDateTimeFormat() { + Map schema = ParamSchema.forType(LocalDateTime.class); + assertEquals("string", schema.get("type")); + assertEquals("date-time", schema.get("format")); + } + + @Test + void forType_Instant_returnsDateTimeFormat() { + Map schema = ParamSchema.forType(Instant.class); + assertEquals("string", schema.get("type")); + assertEquals("date-time", schema.get("format")); + } + + @Test + void forType_ZonedDateTime_returnsDateTimeFormat() { + Map schema = ParamSchema.forType(ZonedDateTime.class); + assertEquals("string", schema.get("type")); + assertEquals("date-time", schema.get("format")); + } + + @Test + void forType_LocalDate_returnsDateFormat() { + Map schema = ParamSchema.forType(LocalDate.class); + assertEquals("string", schema.get("type")); + assertEquals("date", schema.get("format")); + } + + @Test + void forType_LocalTime_returnsTimeFormat() { + Map schema = ParamSchema.forType(LocalTime.class); + assertEquals("string", schema.get("type")); + assertEquals("time", schema.get("format")); + } + + // ── forType: JsonNode / Object → any ───────────────────────────────────────── + + @Test + void forType_JsonNode_returnsEmptySchema() { + assertTrue(ParamSchema.forType(JsonNode.class).isEmpty()); + } + + @Test + void forType_Object_returnsEmptySchema() { + assertTrue(ParamSchema.forType(Object.class).isEmpty()); + } + + // ── forType: enums ─────────────────────────────────────────────────────────── + + @Test + void forType_enum_returnsStringWithEnumValues() { + Map schema = ParamSchema.forType(TestColor.class); + assertEquals("string", schema.get("type")); + @SuppressWarnings("unchecked") + List values = (List) schema.get("enum"); + assertNotNull(values); + assertEquals(List.of("RED", "GREEN", "BLUE"), values); + } + + // ── forType: collections ───────────────────────────────────────────────────── + + @Test + void forType_List_returnsArray() { + assertEquals(Map.of("type", "array"), ParamSchema.forType(List.class)); + } + + @Test + void forType_Set_returnsArray() { + assertEquals(Map.of("type", "array"), ParamSchema.forType(Set.class)); + } + + @Test + void forType_Collection_returnsArray() { + assertEquals(Map.of("type", "array"), ParamSchema.forType(Collection.class)); + } + + // ── forType: arrays ────────────────────────────────────────────────────────── + + @Test + void forType_stringArray_returnsArrayWithStringItems() { + Map schema = ParamSchema.forType(String[].class); + assertEquals("array", schema.get("type")); + @SuppressWarnings("unchecked") + Map items = (Map) schema.get("items"); + assertEquals("string", items.get("type")); + } + + @Test + void forType_intArray_returnsArrayWithIntegerItems() { + Map schema = ParamSchema.forType(int[].class); + assertEquals("array", schema.get("type")); + @SuppressWarnings("unchecked") + Map items = (Map) schema.get("items"); + assertEquals("integer", items.get("type")); + } + + @Test + void forType_doubleArray_returnsArrayWithNumberItems() { + Map schema = ParamSchema.forType(double[].class); + assertEquals("array", schema.get("type")); + @SuppressWarnings("unchecked") + Map items = (Map) schema.get("items"); + assertEquals("number", items.get("type")); + } + + // ── forType: Map ───────────────────────────────────────────────────────────── + + @Test + void forType_Map_returnsObject() { + assertEquals(Map.of("type", "object"), ParamSchema.forType(Map.class)); + } + + // ── forType: POJO / record fallback ────────────────────────────────────────── + + @Test + void forType_record_returnsObject() { + assertEquals(Map.of("type", "object"), ParamSchema.forType(TestRecord.class)); + } + + @Test + void forType_pojo_returnsObject() { + assertEquals(Map.of("type", "object"), ParamSchema.forType(TestPojo.class)); + } + + // ── Test helper types ──────────────────────────────────────────────────────── + + enum TestColor { + RED, GREEN, BLUE + } + + record TestRecord(String name, int value) { + } + + static class TestPojo { + String field; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/PermissionRequestResultDecisionContextTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/PermissionRequestResultDecisionContextTest.java new file mode 100644 index 000000000..395ad50ad --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/PermissionRequestResultDecisionContextTest.java @@ -0,0 +1,97 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.generated.rpc.PermissionDecisionContext; +import com.github.copilot.generated.rpc.PermissionDecisionOutcome; +import com.github.copilot.generated.rpc.PermissionDecisionSource; +import com.github.copilot.generated.rpc.PermissionDecisionSurface; +import com.github.copilot.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams; +import org.junit.jupiter.api.Test; + +/** + * Verifies that {@link PermissionRequestResult} carries an optional + * {@link PermissionDecisionContext} as a sibling of {@code result} — never + * nested inside the serialized result — when the SDK forwards a permission + * response to the runtime. + */ +class PermissionRequestResultDecisionContextTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private static PermissionDecisionContext sampleContext() { + return new PermissionDecisionContext(PermissionDecisionOutcome.AUTO_APPROVED, + PermissionDecisionSource.HOST_POLICY, PermissionDecisionSurface.SDK); + } + + @Test + void setDecisionContextForwardsContextAsSiblingOfResult() throws Exception { + var result = PermissionRequestResult.approveOnce().setDecisionContext(sampleContext()); + var params = new SessionPermissionsHandlePendingPermissionRequestParams("session-1", "req-1", result, + result.getDecisionContext()); + + JsonNode json = MAPPER.valueToTree(params); + + assertTrue(json.has("decisionContext"), "decisionContext must be a top-level sibling of result"); + assertEquals("host_policy", json.get("decisionContext").get("source").asText()); + assertEquals("auto_approved", json.get("decisionContext").get("outcome").asText()); + assertEquals("sdk", json.get("decisionContext").get("surface").asText()); + assertFalse(json.get("result").has("decisionContext"), "decisionContext must NOT be nested inside result"); + } + + @Test + void withoutContextOmitsDecisionContextKey() throws Exception { + var result = PermissionRequestResult.approveOnce(); + assertNull(result.getDecisionContext()); + + var params = new SessionPermissionsHandlePendingPermissionRequestParams("session-1", "req-1", result, + result.getDecisionContext()); + + JsonNode json = MAPPER.valueToTree(params); + + // Generated params record is @JsonInclude(NON_NULL), so a null + // decisionContext is omitted entirely — byte-identical to legacy behavior. + assertFalse(json.has("decisionContext"), "decisionContext key must be absent when no context is supplied"); + } + + @Test + void setDecisionContextTwiceReplacesRatherThanNests() { + var first = sampleContext(); + var second = new PermissionDecisionContext(PermissionDecisionOutcome.PROMPTED_USER, + PermissionDecisionSource.HUMAN_RESPONSE, PermissionDecisionSurface.TUI); + + var result = PermissionRequestResult.approveOnce().setDecisionContext(first).setDecisionContext(second); + + assertSame(second, result.getDecisionContext(), "second setDecisionContext must replace the first, not nest"); + } + + @Test + void serializingResultWithContextDoesNotEmitContextInsideResult() throws Exception { + var result = PermissionRequestResult.approveOnce().setDecisionContext(sampleContext()); + + JsonNode resultJson = MAPPER.valueToTree(result); + + assertFalse(resultJson.has("decisionContext"), + "@JsonIgnore must keep decisionContext out of the serialized result"); + assertEquals(PermissionRequestResultKind.APPROVED.getValue(), resultJson.get("kind").asText()); + } + + @Test + void setDecisionContextAcceptsNullAsNoContext() { + var result = PermissionRequestResult.approveOnce().setDecisionContext(sampleContext()); + + result.setDecisionContext(null); + + assertNull(result.getDecisionContext(), "null must clear the context rather than throwing"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java b/java/sdk/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java new file mode 100644 index 000000000..99cfe4706 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/RecordInvocationArgs.java @@ -0,0 +1,8 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +public record RecordInvocationArgs(String query, int limit) { +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java new file mode 100644 index 000000000..afa3d4251 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionFromObjectTest.java @@ -0,0 +1,498 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.Map; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import com.github.copilot.AllowCopilotExperimental; +import com.github.copilot.rpc.fixtures.ArgCoercionTools; +import com.github.copilot.rpc.fixtures.DateTimeTools; +import com.github.copilot.rpc.fixtures.DefaultValueTools; +import com.github.copilot.rpc.fixtures.InvocationAwareTools; +import com.github.copilot.rpc.fixtures.MultiReturnTools; +import com.github.copilot.rpc.fixtures.OptionalParamTools; +import com.github.copilot.rpc.fixtures.OverrideTools; +import com.github.copilot.rpc.fixtures.SimpleTools; +import com.github.copilot.rpc.fixtures.StaticInvocationTools; +import com.github.copilot.rpc.fixtures.StaticTools; + +/** + * End-to-end tests for {@link ToolDefinition#fromObject(Object)}. + *

    + * These tests use hand-written {@code $$CopilotToolMeta} companion classes + * under {@code com.github.copilot.rpc.fixtures} that mimic + * {@link com.github.copilot.tool.CopilotToolProcessor} output. + */ +@AllowCopilotExperimental +class ToolDefinitionFromObjectTest { + + // ── Test 1: Basic end-to-end ──────────────────────────────────────────────── + + @Test + void fromObject_returnsCorrectNumberOfTools() { + var tools = ToolDefinition.fromObject(new SimpleTools()); + assertEquals(2, tools.size()); + } + + @Test + void fromObject_toolNamesAndDescriptions() { + var tools = ToolDefinition.fromObject(new SimpleTools()); + var tool1 = findTool(tools, "greet_user"); + assertNotNull(tool1); + assertEquals("Greets a user by name", tool1.description()); + + var tool2 = findTool(tools, "add_numbers"); + assertNotNull(tool2); + assertEquals("Adds two numbers together", tool2.description()); + } + + @Test + void fromObject_toolParameterSchema() { + var tools = ToolDefinition.fromObject(new SimpleTools()); + var tool = findTool(tools, "greet_user"); + assertNotNull(tool); + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + assertEquals("object", schema.get("type")); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + assertTrue(properties.containsKey("name")); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + assertTrue(required.contains("name")); + } + + @Test + void fromObject_handlerInvocation() throws Exception { + var instance = new SimpleTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "greet_user"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("greet_user", Map.of("name", "Alice"))).get(); + assertEquals("Hello, Alice!", result); + } + + @Test + void fromObject_toolMetadata() { + var tools = ToolDefinition.fromObject(new SimpleTools()); + + var withMetadata = findTool(tools, "greet_user"); + assertNotNull(withMetadata); + assertNotNull(withMetadata.metadata()); + assertEquals(Map.of("github.com/copilot:safeForTelemetry", Map.of("name", true, "inputsNames", false)), + withMetadata.metadata()); + + var withoutMetadata = findTool(tools, "add_numbers"); + assertNotNull(withoutMetadata); + assertNull(withoutMetadata.metadata()); + } + + // ── Test 2: Handler return type patterns ──────────────────────────────────── + + @Test + void fromObject_stringReturn() throws Exception { + var tools = ToolDefinition.fromObject(new MultiReturnTools()); + var tool = findTool(tools, "string_method"); + assertNotNull(tool); + var result = tool.handler().invoke(createInvocation("string_method", Map.of())).get(); + assertEquals("hello", result); + } + + @Test + void fromObject_voidReturn() throws Exception { + var tools = ToolDefinition.fromObject(new MultiReturnTools()); + var tool = findTool(tools, "void_method"); + assertNotNull(tool); + var result = tool.handler().invoke(createInvocation("void_method", Map.of())).get(); + assertEquals("Success", result); + } + + @Test + void fromObject_asyncReturn() throws Exception { + var tools = ToolDefinition.fromObject(new MultiReturnTools()); + var tool = findTool(tools, "async_method"); + assertNotNull(tool); + var result = tool.handler().invoke(createInvocation("async_method", Map.of())).get(); + assertEquals("async result", result); + } + + // ── Test 3: Argument coercion ─────────────────────────────────────────────── + + @Test + void fromObject_argumentCoercion() throws Exception { + var instance = new ArgCoercionTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "mixed_args"); + assertNotNull(tool); + + var result = tool.handler().invoke( + createInvocation("mixed_args", Map.of("text", "hello", "count", 5, "flag", true, "color", "RED"))) + .get(); + assertEquals("hello-5-true-RED", result); + } + + // ── Test 4: Default value ─────────────────────────────────────────────────── + + @Test + void fromObject_defaultValue() throws Exception { + var instance = new DefaultValueTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "with_default"); + assertNotNull(tool); + + // Omit "count" key — should use default value 42 + var result = tool.handler().invoke(createInvocation("with_default", Map.of("label", "test"))).get(); + assertEquals("test:42", result); + } + + // ── Test 5: Error case — missing generated class ──────────────────────────── + + @Test + void fromObject_throwsOnMissingMetaClass() { + // A class that was never processed by CopilotToolProcessor + var ex = assertThrows(IllegalStateException.class, () -> ToolDefinition.fromObject("a plain String")); + assertTrue(ex.getMessage().contains("not found")); + assertTrue(ex.getMessage().contains("CopilotToolProcessor")); + } + + // ── Test 5b: fromClass rejects instance methods ───────────────────────────── + + @Test + void fromClass_throwsOnInstanceMethods() { + // SimpleTools has instance (non-static) @CopilotTool methods + var ex = assertThrows(IllegalArgumentException.class, () -> ToolDefinition.fromClass(SimpleTools.class)); + assertTrue(ex.getMessage().contains("fromClass()")); + assertTrue(ex.getMessage().contains("static")); + assertTrue(ex.getMessage().contains("fromObject")); + } + + // ── Test 6: java.time argument ────────────────────────────────────────────── + + @Test + void fromObject_javaTimeArgument() throws Exception { + var instance = new DateTimeTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "schedule_event"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("schedule_event", Map.of("when", "2024-06-15T10:30:00"))) + .get(); + assertEquals("Scheduled at 2024-06-15T10:30", result); + } + + // ── Test 7: Override tool ──────────────────────────────────────────────────── + + @Test + void fromObject_overrideTool() { + var tools = ToolDefinition.fromObject(new OverrideTools()); + var tool = findTool(tools, "grep"); + assertNotNull(tool); + assertEquals(Boolean.TRUE, tool.overridesBuiltInTool()); + } + + // ── Test 8: ToolDefer.NONE → null mapping (defer absent from JSON) ────────── + + @Test + void fromObject_deferNone_absentFromJson() throws Exception { + var tools = ToolDefinition.fromObject(new SimpleTools()); + var tool = findTool(tools, "greet_user"); + assertNotNull(tool); + // The defer field should be null (NONE maps to null) + assertNull(tool.defer()); + + // Serialize to JSON and verify "defer" key is absent + var mapper = new ObjectMapper(); + mapper.registerModule(new JavaTimeModule()); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); + mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL); + + String json = mapper.writeValueAsString(tool); + var node = (ObjectNode) mapper.readTree(json); + assertFalse(node.has("defer"), "defer key should be absent from JSON, got: " + json); + } + + // ── Test 9: fromClass with static methods invokes handler without NPE ───── + + @Test + void fromClass_staticToolInvocation() throws Exception { + var tools = ToolDefinition.fromClass(StaticTools.class); + assertEquals(1, tools.size()); + var tool = findTool(tools, "greet"); + assertNotNull(tool); + + // This should NOT throw NPE — static methods don't need an instance + var result = tool.handler().invoke(createInvocation("greet", Map.of("name", "World"))).get(); + assertEquals("Hi, World!", result); + } + + // ── Test 10: Optional parameter handling ──────────────────────────────────── + + @Test + void fromObject_optionalStringPresent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "greet_with_title"); + assertNotNull(tool); + + var result = tool.handler() + .invoke(createInvocation("greet_with_title", Map.of("name", "Alice", "title", "Dr."))).get(); + assertEquals("Dr. Alice", result); + } + + @Test + void fromObject_optionalStringAbsent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "greet_with_title"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("greet_with_title", Map.of("name", "Alice"))).get(); + assertEquals("Alice", result); + } + + @Test + void fromObject_optionalIntPresent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "multiply"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("multiply", Map.of("base", 5, "factor", 3))).get(); + assertEquals("15", result); + } + + @Test + void fromObject_optionalIntAbsent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "multiply"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("multiply", Map.of("base", 5))).get(); + assertEquals("5", result); + } + + @Test + void fromObject_optionalDoublePresent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "scale"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("scale", Map.of("value", 2.0, "ratio", 3.5))).get(); + assertEquals("7.0", result); + } + + @Test + void fromObject_optionalLongPresent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "offset"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("offset", Map.of("base", 100, "delta", 50))).get(); + assertEquals("150", result); + } + + @Test + void fromObject_optionalLongAbsent() throws Exception { + var instance = new OptionalParamTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "offset"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("offset", Map.of("base", 100))).get(); + assertEquals("100", result); + } + + // ── Test 11: ToolInvocation injection ─────────────────────────────────────── + + @Test + void fromObject_toolInvocationInjection_instanceMethod() throws Exception { + var instance = new InvocationAwareTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "report_progress"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("report_progress", Map.of("phase", "analyzing")) + .setSessionId("session-123").setToolCallId("call-456")).get(); + assertEquals("phase=analyzing,sessionId=session-123,toolCallId=call-456,toolName=report_progress", result); + } + + @Test + void fromObject_toolInvocationInjection_schemaExcludesToolInvocation() { + var tools = ToolDefinition.fromObject(new InvocationAwareTools()); + var tool = findTool(tools, "report_progress"); + assertNotNull(tool); + + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + + assertTrue(properties.containsKey("phase")); + assertFalse(properties.containsKey("invocation")); + assertEquals(List.of("phase"), required); + } + + @Test + void fromObject_toolInvocationInjection_asyncMethod() throws Exception { + var instance = new InvocationAwareTools(); + var tools = ToolDefinition.fromObject(instance); + var tool = findTool(tools, "report_progress_async"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("report_progress_async", Map.of("phase", "planning")) + .setSessionId("session-789").setToolCallId("call-012")).get(); + assertEquals("async phase=planning,sessionId=session-789,toolCallId=call-012,toolName=report_progress_async", + result); + } + + @Test + void fromClass_toolInvocationInjection_staticMethod() throws Exception { + var tools = ToolDefinition.fromClass(StaticInvocationTools.class); + var tool = findTool(tools, "report_static"); + assertNotNull(tool); + + var result = tool.handler().invoke(createInvocation("report_static", Map.of("phase", "completed")) + .setSessionId("session-321").setToolCallId("call-654")).get(); + assertEquals("phase=completed,sessionId=session-321,toolCallId=call-654,toolName=report_static", result); + } + + @Test + void fromObject_toolInvocationInjection_firstParameter() throws Exception { + var tools = ToolDefinition.fromObject(new InvocationAwareTools()); + var tool = findTool(tools, "report_progress_first"); + assertNotNull(tool); + + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + + assertTrue(properties.containsKey("phase")); + assertFalse(properties.containsKey("invocation")); + assertEquals(List.of("phase"), required); + + var result = tool.handler().invoke(createInvocation("report_progress_first", Map.of("phase", "starting")) + .setSessionId("session-first").setToolCallId("call-first")).get(); + assertEquals( + "first phase=starting,sessionId=session-first,toolCallId=call-first,toolName=report_progress_first", + result); + } + + @Test + void fromObject_toolInvocationInjection_onlyParameter() throws Exception { + var tools = ToolDefinition.fromObject(new InvocationAwareTools()); + var tool = findTool(tools, "only_context"); + assertNotNull(tool); + + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + + assertTrue(properties.isEmpty()); + assertTrue(required.isEmpty()); + + var result = tool.handler().invoke( + createInvocation("only_context", Map.of()).setSessionId("session-only").setToolCallId("call-only")) + .get(); + assertEquals("only sessionId=session-only,toolCallId=call-only,toolName=only_context", result); + } + + @Test + void fromObject_toolInvocationInjection_middleParameter() throws Exception { + var tools = ToolDefinition.fromObject(new InvocationAwareTools()); + var tool = findTool(tools, "report_progress_middle"); + assertNotNull(tool); + + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + + assertTrue(properties.containsKey("phase")); + assertTrue(properties.containsKey("limit")); + assertFalse(properties.containsKey("invocation")); + assertEquals(List.of("phase", "limit"), required); + + var result = tool.handler() + .invoke(createInvocation("report_progress_middle", Map.of("phase", "running", "limit", 7)) + .setSessionId("session-middle").setToolCallId("call-middle")) + .get(); + assertEquals( + "middle phase=running,limit=7,sessionId=session-middle,toolCallId=call-middle,toolName=report_progress_middle", + result); + } + + @Test + void fromObject_toolInvocationInjection_singleRecordAndInvocation() throws Exception { + var tools = ToolDefinition.fromObject(new InvocationAwareTools()); + var tool = findTool(tools, "report_progress_with_record"); + assertNotNull(tool); + + @SuppressWarnings("unchecked") + var schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + var properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + var required = (List) schema.get("required"); + + assertTrue(properties.containsKey("query")); + assertTrue(properties.containsKey("limit")); + assertFalse(properties.containsKey("args")); + assertFalse(properties.containsKey("invocation")); + assertEquals(List.of("query", "limit"), required); + + var result = tool.handler() + .invoke(createInvocation("report_progress_with_record", Map.of("query", "logs", "limit", 3)) + .setSessionId("session-record").setToolCallId("call-record")) + .get(); + assertEquals( + "record query=logs,limit=3,sessionId=session-record,toolCallId=call-record,toolName=report_progress_with_record", + result); + } + + // ── Helpers ───────────────────────────────────────────────────────────────── + + private static ToolDefinition findTool(List tools, String name) { + return tools.stream().filter(t -> name.equals(t.name())).findFirst().orElse(null); + } + + private static ToolInvocation createInvocation(String toolName, Map args) { + ObjectNode argsNode = JsonNodeFactory.instance.objectNode(); + ObjectMapper mapper = new ObjectMapper(); + argsNode.setAll((ObjectNode) mapper.valueToTree(args)); + return new ToolInvocation().setToolName(toolName).setArguments(argsNode); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionIsTerminalTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionIsTerminalTest.java new file mode 100644 index 000000000..850dfa251 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionIsTerminalTest.java @@ -0,0 +1,51 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.Map; +import org.junit.jupiter.api.Test; + +/** Wire-level coverage for {@link ToolDefinition#isTerminal()}. */ +class ToolDefinitionIsTerminalTest { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @Test + void isTerminalSerializesAsCamelCaseWhenSet() throws Exception { + ToolDefinition definition = new ToolDefinition("clear_context", "Clear the conversation", + Map.of("type", "object"), null, null, null, null, null, true); + + JsonNode node = MAPPER.valueToTree(definition); + + assertTrue(node.has("isTerminal"), "isTerminal should be serialized"); + assertTrue(node.get("isTerminal").asBoolean(), "isTerminal should be true"); + } + + @Test + void isTerminalIsOmittedWhenNull() throws Exception { + ToolDefinition definition = new ToolDefinition("plain", "A plain tool", Map.of("type", "object"), null, null, + null, null, null, null); + + JsonNode node = MAPPER.valueToTree(definition); + + assertFalse(node.has("isTerminal"), "isTerminal should be omitted when null"); + } + + @Test + void sevenArgumentConstructorStillCompilesAndLeavesTerminalityUnset() throws Exception { + // Guards source compatibility for call sites written before isTerminal + // was added as a record component. + ToolDefinition definition = new ToolDefinition("legacy", "Legacy call site", Map.of("type", "object"), null, + null, null, null); + + assertEquals(null, definition.isTerminal()); + assertFalse(MAPPER.valueToTree(definition).has("isTerminal")); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java new file mode 100644 index 000000000..75752c67a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/ToolDefinitionLambdaTest.java @@ -0,0 +1,633 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +import org.junit.jupiter.api.Test; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.github.copilot.AllowCopilotExperimental; +import com.github.copilot.tool.Param; + +/** + * Unit tests for {@link ToolDefinition#from}, {@link ToolDefinition#fromAsync}, + * {@link ToolDefinition#fromWithToolInvocation}, and + * {@link ToolDefinition#fromAsyncWithToolInvocation} lambda-tool factories, + * plus the fluent option-modifier methods + * ({@link ToolDefinition#overridesBuiltInTool}, + * {@link ToolDefinition#skipPermission}, {@link ToolDefinition#defer}). + * + *

    + * Tests are grouped by the Phase 4.4 contract: + *

      + *
    1. Successful inline definitions for arities 0–2 (sync and async).
      2. + *
    2. ToolInvocation context injection (sync and async).
      3. + *
    3. Option flag propagation.
      4. + *
    4. Required/default semantics.
      5. + *
    5. Error and validation paths.
      6. + *
    6. Schema structure.
      7. + *
    7. Result formatting (String, null, non-String).
      8. + *
    8. Argument coercion.
      9. + *
    + */ +@AllowCopilotExperimental +class ToolDefinitionLambdaTest { + + private record CustomDateTime(String value) { + } + + // ── Helpers ────────────────────────────────────────────────────────────────── + + private static ToolInvocation invocationOf(Map args) { + ObjectNode argsNode = JsonNodeFactory.instance.objectNode(); + for (Map.Entry e : args.entrySet()) { + Object v = e.getValue(); + if (v instanceof String s) { + argsNode.put(e.getKey(), s); + } else if (v instanceof Integer i) { + argsNode.put(e.getKey(), i); + } else if (v instanceof Long l) { + argsNode.put(e.getKey(), l); + } else if (v instanceof Double d) { + argsNode.put(e.getKey(), d); + } else if (v instanceof Boolean b) { + argsNode.put(e.getKey(), b); + } else if (v != null) { + argsNode.put(e.getKey(), v.toString()); + } + } + return new ToolInvocation().setArguments(argsNode); + } + + private static ToolInvocation invocationWithContext(String sessionId, String toolCallId, Map args) { + return invocationOf(args).setSessionId(sessionId).setToolCallId(toolCallId); + } + + @SuppressWarnings("unchecked") + private static Map schemaOf(ToolDefinition tool) { + return (Map) tool.parameters(); + } + + @SuppressWarnings("unchecked") + private static Map propertiesOf(ToolDefinition tool) { + return (Map) schemaOf(tool).get("properties"); + } + + @SuppressWarnings("unchecked") + private static List requiredOf(ToolDefinition tool) { + return (List) schemaOf(tool).get("required"); + } + + // ── Group 1: Successful inline definitions – arity 0, sync ─────────────────── + + @Test + void from_zeroArg_returnsNameAndDescription() { + ToolDefinition tool = ToolDefinition.from("ping", "Returns pong", () -> "pong"); + assertEquals("ping", tool.name()); + assertEquals("Returns pong", tool.description()); + } + + @Test + void from_zeroArg_invokesHandler() throws Exception { + ToolDefinition tool = ToolDefinition.from("ping", "Returns pong", () -> "pong"); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("pong", result); + } + + @Test + void from_zeroArg_emptySchema() { + ToolDefinition tool = ToolDefinition.from("ping", "Returns pong", () -> "pong"); + assertTrue(propertiesOf(tool).isEmpty()); + assertTrue(requiredOf(tool).isEmpty()); + } + + // ── Group 1: Successful inline definitions – arity 1, sync ─────────────────── + + @Test + void from_oneArg_returnsNameAndDescription() { + Param nameParam = Param.of(String.class, "name", "The user's name"); + ToolDefinition tool = ToolDefinition.from("greet", "Greets a user", nameParam, n -> "Hello, " + n + "!"); + assertEquals("greet", tool.name()); + assertEquals("Greets a user", tool.description()); + } + + @Test + void from_oneArg_invokesHandler() throws Exception { + Param nameParam = Param.of(String.class, "name", "The user's name"); + ToolDefinition tool = ToolDefinition.from("greet", "Greets a user", nameParam, n -> "Hello, " + n + "!"); + Object result = tool.handler().invoke(invocationOf(Map.of("name", "Alice"))).get(); + assertEquals("Hello, Alice!", result); + } + + @Test + void from_oneArg_schemaContainsParam() { + Param nameParam = Param.of(String.class, "name", "The user's name"); + ToolDefinition tool = ToolDefinition.from("greet", "Greets a user", nameParam, n -> "Hello, " + n + "!"); + assertTrue(propertiesOf(tool).containsKey("name")); + assertTrue(requiredOf(tool).contains("name")); + } + + // ── Group 1: Successful inline definitions – arity 2, sync ─────────────────── + + @Test + void from_twoArg_invokesHandler() throws Exception { + Param paramA = Param.of(Integer.class, "a", "First number"); + Param paramB = Param.of(Integer.class, "b", "Second number"); + ToolDefinition tool = ToolDefinition.from("add", "Adds two integers", paramA, paramB, + (a, b) -> String.valueOf(a + b)); + Object result = tool.handler().invoke(invocationOf(Map.of("a", 3, "b", 4))).get(); + assertEquals("7", result); + } + + @Test + void from_twoArg_schemaBothParamsPresent() { + Param paramA = Param.of(Integer.class, "a", "First"); + Param paramB = Param.of(Integer.class, "b", "Second"); + ToolDefinition tool = ToolDefinition.from("add", "Adds two integers", paramA, paramB, (a, b) -> a + b); + assertTrue(propertiesOf(tool).containsKey("a")); + assertTrue(propertiesOf(tool).containsKey("b")); + assertTrue(requiredOf(tool).contains("a")); + assertTrue(requiredOf(tool).contains("b")); + } + + // ── Group 2: Async handlers (fromAsync) ────────────────────────────────────── + + @Test + void fromAsync_zeroArg_invokesHandler() throws Exception { + ToolDefinition tool = ToolDefinition.fromAsync("ping_async", "Async ping", + () -> CompletableFuture.completedFuture("pong")); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("pong", result); + } + + @Test + void fromAsync_oneArg_invokesHandler() throws Exception { + Param nameParam = Param.of(String.class, "name", "Name to greet"); + ToolDefinition tool = ToolDefinition.fromAsync("greet_async", "Async greet", nameParam, + n -> CompletableFuture.completedFuture("Hi, " + n + "!")); + Object result = tool.handler().invoke(invocationOf(Map.of("name", "Bob"))).get(); + assertEquals("Hi, Bob!", result); + } + + @Test + void fromAsync_twoArg_invokesHandler() throws Exception { + Param paramA = Param.of(Integer.class, "a", "Left operand"); + Param paramB = Param.of(Integer.class, "b", "Right operand"); + ToolDefinition tool = ToolDefinition.fromAsync("add_async", "Async add", paramA, paramB, + (a, b) -> CompletableFuture.completedFuture(String.valueOf(a + b))); + Object result = tool.handler().invoke(invocationOf(Map.of("a", 10, "b", 5))).get(); + assertEquals("15", result); + } + + // ── Group 3: ToolInvocation context injection (sync) ───────────────────────── + + @Test + void fromWithToolInvocation_zeroArg_receivesContext() throws Exception { + ToolDefinition tool = ToolDefinition.fromWithToolInvocation("ctx_sync", "Returns session id", + inv -> "session=" + inv.getSessionId()); + Object result = tool.handler().invoke(invocationWithContext("sess-1", "call-1", Map.of())).get(); + assertEquals("session=sess-1", result); + } + + @Test + void fromWithToolInvocation_zeroArg_emptySchema() { + ToolDefinition tool = ToolDefinition.fromWithToolInvocation("ctx_sync", "Returns session id", + inv -> "session=" + inv.getSessionId()); + assertTrue(propertiesOf(tool).isEmpty()); + assertTrue(requiredOf(tool).isEmpty()); + } + + @Test + void fromWithToolInvocation_oneArg_receivesArgAndContext() throws Exception { + Param phaseParam = Param.of(String.class, "phase", "Current phase"); + ToolDefinition tool = ToolDefinition.fromWithToolInvocation("report", "Report phase", phaseParam, + (phase, inv) -> "phase=" + phase + ",callId=" + inv.getToolCallId()); + Object result = tool.handler().invoke(invocationWithContext("sess-2", "call-42", Map.of("phase", "analysis"))) + .get(); + assertEquals("phase=analysis,callId=call-42", result); + } + + @Test + void fromWithToolInvocation_oneArg_schemaExcludesInvocationParam() { + Param phaseParam = Param.of(String.class, "phase", "Current phase"); + ToolDefinition tool = ToolDefinition.fromWithToolInvocation("report", "Report phase", phaseParam, + (phase, inv) -> phase); + assertTrue(propertiesOf(tool).containsKey("phase")); + assertFalse(propertiesOf(tool).containsKey("invocation")); + assertEquals(List.of("phase"), requiredOf(tool)); + } + + // ── Group 4: Async ToolInvocation context injection ────────────────────────── + + @Test + void fromAsyncWithToolInvocation_zeroArg_receivesContext() throws Exception { + ToolDefinition tool = ToolDefinition.fromAsyncWithToolInvocation("ctx_async", "Async ctx", + inv -> CompletableFuture.completedFuture("callId=" + inv.getToolCallId())); + Object result = tool.handler().invoke(invocationWithContext("sess-3", "call-99", Map.of())).get(); + assertEquals("callId=call-99", result); + } + + @Test + void fromAsyncWithToolInvocation_oneArg_receivesArgAndContext() throws Exception { + Param phaseParam = Param.of(String.class, "phase", "Phase name"); + ToolDefinition tool = ToolDefinition.fromAsyncWithToolInvocation("report_async", "Async report", phaseParam, + (phase, inv) -> CompletableFuture.completedFuture("phase=" + phase + ",sess=" + inv.getSessionId())); + Object result = tool.handler().invoke(invocationWithContext("sess-4", "call-7", Map.of("phase", "planning"))) + .get(); + assertEquals("phase=planning,sess=sess-4", result); + } + + // ── Group 5: Option flag propagation ───────────────────────────────────────── + + @Test + void overridesBuiltInTool_setsFlag() { + ToolDefinition base = ToolDefinition.from("grep", "Custom grep", () -> "ok"); + assertNull(base.overridesBuiltInTool()); + ToolDefinition withOverride = base.overridesBuiltInTool(true); + assertEquals(Boolean.TRUE, withOverride.overridesBuiltInTool()); + } + + @Test + void overridesBuiltInTool_doesNotMutateOriginal() { + ToolDefinition base = ToolDefinition.from("grep", "Custom grep", () -> "ok"); + base.overridesBuiltInTool(true); + assertNull(base.overridesBuiltInTool(), "original must remain unchanged"); + } + + @Test + void skipPermission_setsFlag() { + ToolDefinition base = ToolDefinition.from("read_file", "Reads a file", () -> "contents"); + assertNull(base.skipPermission()); + ToolDefinition withSkip = base.skipPermission(true); + assertEquals(Boolean.TRUE, withSkip.skipPermission()); + } + + @Test + void skipPermission_doesNotMutateOriginal() { + ToolDefinition base = ToolDefinition.from("read_file", "Reads a file", () -> "contents"); + base.skipPermission(true); + assertNull(base.skipPermission(), "original must remain unchanged"); + } + + @Test + void defer_setsAutoMode() { + ToolDefinition base = ToolDefinition.from("search", "Searches things", () -> "results"); + assertNull(base.defer()); + ToolDefinition deferred = base.defer(ToolDefer.AUTO); + assertEquals(ToolDefer.AUTO, deferred.defer()); + } + + @Test + void defer_setsNeverMode() { + ToolDefinition base = ToolDefinition.from("must_preload", "Always preloaded", () -> "ok"); + ToolDefinition neverDeferred = base.defer(ToolDefer.NEVER); + assertEquals(ToolDefer.NEVER, neverDeferred.defer()); + } + + @Test + void defer_doesNotMutateOriginal() { + ToolDefinition base = ToolDefinition.from("search", "Searches things", () -> "results"); + base.defer(ToolDefer.AUTO); + assertNull(base.defer(), "original must remain unchanged"); + } + + @Test + void fluentModifiers_canBeChained() { + ToolDefinition tool = ToolDefinition.from("override_tool", "Overrides built-in", () -> "ok") + .overridesBuiltInTool(true).skipPermission(true).defer(ToolDefer.AUTO); + assertEquals(Boolean.TRUE, tool.overridesBuiltInTool()); + assertEquals(Boolean.TRUE, tool.skipPermission()); + assertEquals(ToolDefer.AUTO, tool.defer()); + } + + @Test + void fluentModifiers_preserveHandlerAndSchema() throws Exception { + Param p = Param.of(String.class, "msg", "A message"); + ToolDefinition tool = ToolDefinition.from("echo", "Echoes message", p, msg -> msg).skipPermission(true) + .overridesBuiltInTool(false); + assertNotNull(tool.handler()); + Object result = tool.handler().invoke(invocationOf(Map.of("msg", "hello"))).get(); + assertEquals("hello", result); + } + + // ── Group 6: Required/default semantics ────────────────────────────────────── + + @Test + void requiredParam_passedValue_usesProvidedValue() throws Exception { + Param p = Param.of(String.class, "word", "A word"); + ToolDefinition tool = ToolDefinition.from("echo", "Echoes", p, w -> w); + Object result = tool.handler().invoke(invocationOf(Map.of("word", "hello"))).get(); + assertEquals("hello", result); + } + + @Test + void requiredParam_missingFromInvocation_throwsIllegalArgumentException() { + Param p = Param.of(String.class, "word", "A required word"); + ToolDefinition tool = ToolDefinition.from("echo", "Echoes", p, w -> w); + var ex = assertThrows(IllegalArgumentException.class, () -> tool.handler().invoke(invocationOf(Map.of()))); + assertTrue(ex.getMessage().contains("word"), "Exception message should mention the missing parameter name"); + } + + @Test + void optionalParamWithDefault_absent_usesDefault() throws Exception { + Param p = Param.of(Integer.class, "limit", "Max results", false, "10"); + ToolDefinition tool = ToolDefinition.from("list", "Lists items", p, lim -> "limit=" + lim); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("limit=10", result); + } + + @Test + void optionalParamWithDefault_provided_usesProvidedValue() throws Exception { + Param p = Param.of(Integer.class, "limit", "Max results", false, "10"); + ToolDefinition tool = ToolDefinition.from("list", "Lists items", p, lim -> "limit=" + lim); + Object result = tool.handler().invoke(invocationOf(Map.of("limit", 25))).get(); + assertEquals("limit=25", result); + } + + @Test + void optionalParamWithDefault_schemaNotInRequired() { + Param p = Param.of(Integer.class, "limit", "Max results", false, "10"); + ToolDefinition tool = ToolDefinition.from("list", "Lists items", p, lim -> "limit=" + lim); + assertFalse(requiredOf(tool).contains("limit")); + assertTrue(propertiesOf(tool).containsKey("limit")); + } + + @Test + void optionalParam_absent_noDefaultYieldsNull() throws Exception { + Param p = Param.of(String.class, "title", "Optional title", false, ""); + ToolDefinition tool = ToolDefinition.from("greet", "Greets", p, t -> t == null ? "(no title)" : t); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("(no title)", result); + } + + @Test + void defaultValueAppearsInSchema() { + Param p = Param.of(Integer.class, "limit", "Max results", false, "5"); + ToolDefinition tool = ToolDefinition.from("list", "Lists items", p, lim -> lim.toString()); + @SuppressWarnings("unchecked") + Map limitPropSchema = (Map) propertiesOf(tool).get("limit"); + assertNotNull(limitPropSchema, "Schema must include 'limit' property"); + assertEquals(5, limitPropSchema.get("default"), "Default value must appear in schema"); + } + + // ── Group 7: Error / validation paths ──────────────────────────────────────── + + @Test + void from_nullName_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from(null, "desc", () -> "ok")); + } + + @Test + void from_blankName_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from(" ", "desc", () -> "ok")); + } + + @Test + void from_nullDescription_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from("tool", null, () -> "ok")); + } + + @Test + void from_blankDescription_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from("tool", "", () -> "ok")); + } + + @Test + void from_nullHandler_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, + () -> ToolDefinition.from("tool", "desc", (java.util.function.Supplier) null)); + } + + @Test + void from_oneArg_nullParam_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, + () -> ToolDefinition.from("tool", "desc", (Param) null, s -> s)); + } + + @Test + void from_twoArg_nullFirstParam_throwsIllegalArgumentException() { + Param p2 = Param.of(String.class, "b", "B param"); + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from("tool", "desc", null, p2, (a, b) -> a)); + } + + @Test + void from_twoArg_nullSecondParam_throwsIllegalArgumentException() { + Param p1 = Param.of(String.class, "a", "A param"); + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.from("tool", "desc", p1, null, (a, b) -> a)); + } + + @Test + void from_twoArg_duplicateParamNames_throwsIllegalArgumentException() { + Param p1 = Param.of(String.class, "name", "Name 1"); + Param p2 = Param.of(String.class, "name", "Name 2"); + var ex = assertThrows(IllegalArgumentException.class, + () -> ToolDefinition.from("tool", "desc", p1, p2, (a, b) -> a + b)); + assertTrue(ex.getMessage().contains("name"), "error must mention the duplicate param name"); + assertTrue(ex.getMessage().contains("tool"), "error must mention the tool name"); + } + + @Test + void fromAsync_nullName_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, + () -> ToolDefinition.fromAsync(null, "desc", () -> CompletableFuture.completedFuture("ok"))); + } + + @Test + void fromAsync_nullHandler_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.fromAsync("tool", "desc", + (java.util.function.Supplier>) null)); + } + + @Test + void fromWithToolInvocation_nullName_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, + () -> ToolDefinition.fromWithToolInvocation(null, "desc", inv -> "ok")); + } + + @Test + void fromAsyncWithToolInvocation_nullDescription_throwsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> ToolDefinition.fromAsyncWithToolInvocation("tool", null, + inv -> CompletableFuture.completedFuture("ok"))); + } + + // ── Group 8: Schema structure + // ───────────────────────────────────────────────── + + @Test + void schema_zeroArg_hasTypeObjectAndEmptyMaps() { + ToolDefinition tool = ToolDefinition.from("noop", "No-op", () -> "done"); + Map schema = schemaOf(tool); + assertEquals("object", schema.get("type")); + assertTrue(((Map) schema.get("properties")).isEmpty()); + assertTrue(((List) schema.get("required")).isEmpty()); + } + + @Test + void schema_oneArg_hasCorrectTypeForString() { + Param p = Param.of(String.class, "query", "Search query"); + ToolDefinition tool = ToolDefinition.from("search", "Searches", p, q -> q); + @SuppressWarnings("unchecked") + Map querySchema = (Map) propertiesOf(tool).get("query"); + assertNotNull(querySchema); + assertEquals("string", querySchema.get("type")); + assertEquals("Search query", querySchema.get("description")); + } + + @Test + void schema_oneArg_customTypeUsesExplicitSchemaAndCoercion() throws Exception { + Param p = Param.of(CustomDateTime.class, "when", "Meeting time") + .schema("{\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"string\"}}}"); + ToolDefinition tool = ToolDefinition.from("schedule", "Schedules a meeting", p, + when -> "scheduled " + when.value()); + @SuppressWarnings("unchecked") + Map whenSchema = (Map) propertiesOf(tool).get("when"); + assertNotNull(whenSchema); + assertEquals("object", whenSchema.get("type")); + assertEquals("Meeting time", whenSchema.get("description")); + ObjectNode arguments = JsonNodeFactory.instance.objectNode(); + arguments.putObject("when").put("value", "2026-07-23T21:00:00Z"); + Object result = tool.handler().invoke(new ToolInvocation().setArguments(arguments)).get(); + assertEquals("scheduled 2026-07-23T21:00:00Z", result); + } + + @Test + void schema_oneArg_hasCorrectTypeForInteger() { + Param p = Param.of(Integer.class, "count", "Item count"); + ToolDefinition tool = ToolDefinition.from("count_items", "Counts items", p, c -> c.toString()); + @SuppressWarnings("unchecked") + Map countSchema = (Map) propertiesOf(tool).get("count"); + assertNotNull(countSchema); + assertEquals("integer", countSchema.get("type")); + } + + @Test + void schema_oneArg_hasCorrectTypeForBoolean() { + Param p = Param.of(Boolean.class, "enabled", "Whether enabled"); + ToolDefinition tool = ToolDefinition.from("toggle", "Toggles", p, e -> e.toString()); + @SuppressWarnings("unchecked") + Map enabledSchema = (Map) propertiesOf(tool).get("enabled"); + assertNotNull(enabledSchema); + assertEquals("boolean", enabledSchema.get("type")); + } + + @Test + void schema_oneArg_enumTypeHasStringAndEnumValues() { + Param p = Param.of(Color.class, "color", "A color"); + ToolDefinition tool = ToolDefinition.from("paint", "Paints with a color", p, c -> c.name()); + @SuppressWarnings("unchecked") + Map colorSchema = (Map) propertiesOf(tool).get("color"); + assertNotNull(colorSchema); + assertEquals("string", colorSchema.get("type")); + @SuppressWarnings("unchecked") + List enumValues = (List) colorSchema.get("enum"); + assertNotNull(enumValues); + assertTrue(enumValues.contains("RED")); + assertTrue(enumValues.contains("GREEN")); + assertTrue(enumValues.contains("BLUE")); + } + + // ── Group 9: Result formatting + // ──────────────────────────────────────────────── + + @Test + void resultFormatting_stringReturnedAsIs() throws Exception { + ToolDefinition tool = ToolDefinition.from("echo", "Echoes", () -> "plain text"); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("plain text", result); + } + + @Test + void resultFormatting_nullMappedToSuccess() throws Exception { + ToolDefinition tool = ToolDefinition.from("noop", "No-op", () -> null); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("Success", result); + } + + @Test + void resultFormatting_nonStringSerializedToJson() throws Exception { + Param p = Param.of(String.class, "key", "Key name"); + ToolDefinition tool = ToolDefinition.from("to_map", "Wraps in map", p, k -> Map.of("key", k, "value", 42)); + Object result = tool.handler().invoke(invocationOf(Map.of("key", "x"))).get(); + assertNotNull(result); + assertTrue(result instanceof String, "Non-String should be JSON-serialized to String"); + String json = (String) result; + ObjectMapper mapper = new ObjectMapper(); + JsonNode node = mapper.readTree(json); + assertTrue(node.isObject(), "Result should be a JSON object"); + assertEquals("x", node.get("key").asText(), "JSON must contain key field with value 'x'"); + assertEquals(42, node.get("value").asInt(), "JSON must contain value field with value 42"); + } + + @Test + void resultFormatting_integerSerializedToJson() throws Exception { + ToolDefinition tool = ToolDefinition.from("forty_two", "Returns 42", () -> 42); + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("42", result); + } + + // ── Group 10: Argument coercion + // ─────────────────────────────────────────────── + + @Test + void coercion_stringArgPassedThrough() throws Exception { + Param p = Param.of(String.class, "msg", "A message"); + ToolDefinition tool = ToolDefinition.from("echo", "Echoes message", p, m -> m); + Object result = tool.handler().invoke(invocationOf(Map.of("msg", "hello world"))).get(); + assertEquals("hello world", result); + } + + @Test + void coercion_integerArgFromJsonNumber() throws Exception { + Param p = Param.of(Integer.class, "n", "An integer"); + ToolDefinition tool = ToolDefinition.from("double_it", "Doubles n", p, n -> String.valueOf(n * 2)); + Object result = tool.handler().invoke(invocationOf(Map.of("n", 7))).get(); + assertEquals("14", result); + } + + @Test + void coercion_booleanArg() throws Exception { + Param p = Param.of(Boolean.class, "flag", "A flag"); + ToolDefinition tool = ToolDefinition.from("flagged", "Reports flag", p, f -> f ? "yes" : "no"); + Object result = tool.handler().invoke(invocationOf(Map.of("flag", true))).get(); + assertEquals("yes", result); + } + + @Test + void coercion_enumArgFromString() throws Exception { + Param p = Param.of(Color.class, "color", "A color"); + ToolDefinition tool = ToolDefinition.from("paint", "Paints", p, c -> c.name().toLowerCase()); + Object result = tool.handler().invoke(invocationOf(Map.of("color", "GREEN"))).get(); + assertEquals("green", result); + } + + @Test + void coercion_defaultIntegerParsedCorrectly() throws Exception { + Param p = Param.of(Integer.class, "limit", "Max count", false, "99"); + ToolDefinition tool = ToolDefinition.from("bounded", "Bounded list", p, lim -> "got=" + lim); + // No argument provided — should use default 99 + Object result = tool.handler().invoke(invocationOf(Map.of())).get(); + assertEquals("got=99", result); + } + + // ── Inner types for test helpers + // ────────────────────────────────────────────── + + enum Color { + RED, GREEN, BLUE + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools$$CopilotToolMeta.java new file mode 100644 index 000000000..5cc5ee87a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools$$CopilotToolMeta.java @@ -0,0 +1,50 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class ArgCoercionTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(ArgCoercionTools instance, ObjectMapper mapper) { + return List + .of(new ToolDefinition("mixed_args", "Method with mixed argument types", Map.of( + "type", "object", "properties", Map + .ofEntries( + Map.entry("text", + (Map) (Map) withMeta(Map.of("type", "string"), + "Text input", null)), + Map.entry("count", + (Map) (Map) withMeta(Map.of("type", "integer"), + "A count", null)), + Map.entry("flag", + (Map) (Map) withMeta(Map.of("type", "boolean"), + "A flag", null)), + Map.entry("color", + (Map) (Map) withMeta(Map.of("type", "string", "enum", + List.of("RED", "GREEN", "BLUE")), "A color", null))), + "required", List.of("text", "count", "flag", "color")), invocation -> { + Map args = invocation.getArguments(); + String text = (String) args.get("text"); + int count = ((Number) args.get("count")).intValue(); + boolean flag = (Boolean) args.get("flag"); + ArgCoercionTools.Color color = ArgCoercionTools.Color.valueOf((String) args.get("color")); + return CompletableFuture.completedFuture(instance.mixedArgs(text, count, flag, color)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java new file mode 100644 index 000000000..f19af7bff --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/ArgCoercionTools.java @@ -0,0 +1,24 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Fixture testing argument coercion with multiple types including an enum. + */ +public class ArgCoercionTools { + + public enum Color { + RED, GREEN, BLUE + } + + @CopilotTool("Method with mixed argument types") + public String mixedArgs(@CopilotToolParam("Text input") String text, @CopilotToolParam("A count") int count, + @CopilotToolParam("A flag") boolean flag, @CopilotToolParam("A color") Color color) { + return text + "-" + count + "-" + flag + "-" + color.name(); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools$$CopilotToolMeta.java new file mode 100644 index 000000000..0c2b1f07e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools$$CopilotToolMeta.java @@ -0,0 +1,38 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.time.LocalDateTime; +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class DateTimeTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(DateTimeTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("schedule_event", "Schedule an event at a given time", + Map.of("type", "object", "properties", + Map.ofEntries(Map.entry("when", + (Map) (Map) withMeta(Map.of("type", "string", "format", "date-time"), + "When to schedule", null))), + "required", List.of("when")), + invocation -> { + Map args = invocation.getArguments(); + LocalDateTime when = mapper.convertValue(args.get("when"), LocalDateTime.class); + return CompletableFuture.completedFuture(instance.scheduleEvent(when)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java new file mode 100644 index 000000000..f0fdf9fdc --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DateTimeTools.java @@ -0,0 +1,24 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import java.time.LocalDateTime; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Fixture testing java.time argument deserialization via ObjectMapper with + * JavaTimeModule. + */ +public class DateTimeTools { + + @CopilotTool("Schedule an event at a given time") + public String scheduleEvent(@CopilotToolParam(value = "When to schedule", required = true) LocalDateTime when) { + return "Scheduled at " + when.getYear() + "-" + String.format("%02d", when.getMonthValue()) + "-" + + String.format("%02d", when.getDayOfMonth()) + "T" + String.format("%02d", when.getHour()) + ":" + + String.format("%02d", when.getMinute()); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools$$CopilotToolMeta.java new file mode 100644 index 000000000..6cef2e03a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools$$CopilotToolMeta.java @@ -0,0 +1,45 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class DefaultValueTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(DefaultValueTools instance, ObjectMapper mapper) { + return List + .of(new ToolDefinition( + "with_default", "Method with a default value parameter", Map + .of("type", "object", "properties", + Map.ofEntries( + Map.entry("label", + (Map) (Map) withMeta(Map.of("type", "string"), + "A label", null)), + Map.entry("count", + (Map) (Map) withMeta(Map.of("type", "integer"), + "A count", 42))), + "required", List.of("label")), + invocation -> { + Map args = invocation.getArguments(); + String label = (String) args.get("label"); + Object countRaw = args.containsKey("count") ? args.get("count") : 42; + int count = ((Number) countRaw).intValue(); + return CompletableFuture.completedFuture(instance.withDefault(label, count)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java new file mode 100644 index 000000000..942ededd8 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/DefaultValueTools.java @@ -0,0 +1,20 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Fixture testing default parameter values. + */ +public class DefaultValueTools { + + @CopilotTool("Method with a default value parameter") + public String withDefault(@CopilotToolParam(value = "A label", required = true) String label, + @CopilotToolParam(value = "A count", required = false, defaultValue = "42") int count) { + return label + ":" + count; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools$$CopilotToolMeta.java new file mode 100644 index 000000000..e7c78608a --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools$$CopilotToolMeta.java @@ -0,0 +1,74 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output for ToolInvocation injection. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.RecordInvocationArgs; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +public final class InvocationAwareTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(InvocationAwareTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("report_progress", "Reports progress with invocation context", + Map.of("type", "object", "properties", + Map.ofEntries(Map.entry("phase", Map.of("type", "string", "description", "Current phase"))), + "required", List.of("phase")), + invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + return CompletableFuture.completedFuture(instance.reportProgress(phase, invocation)); + }, null, null, null, null), + new ToolDefinition("report_progress_async", "Reports progress asynchronously with invocation context", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("phase", Map.of("type", "string", "description", "Current phase"))), + "required", List.of("phase")), + invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + return instance.reportProgressAsync(phase, invocation).thenApply(r -> (Object) r); + }, null, null, null, null), + new ToolDefinition("report_progress_first", "Reports progress with invocation first", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("phase", Map.of("type", "string", "description", "Current phase"))), + "required", List.of("phase")), + invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + return CompletableFuture.completedFuture(instance.reportProgressFirst(invocation, phase)); + }, null, null, null, null), + new ToolDefinition("only_context", "Reports context with invocation only", + Map.of("type", "object", "properties", Map.of(), "required", List.of()), + invocation -> CompletableFuture.completedFuture(instance.onlyContext(invocation)), null, null, + null, null), + new ToolDefinition("report_progress_middle", "Reports progress with invocation in the middle", Map.of( + "type", "object", "properties", + Map.ofEntries(Map.entry("phase", Map.of("type", "string", "description", "Current phase")), + Map.entry("limit", Map.of("type", "integer", "description", "Maximum items"))), + "required", List.of("phase", "limit")), invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + int limit = ((Number) args.get("limit")).intValue(); + return CompletableFuture + .completedFuture(instance.reportProgressMiddle(phase, invocation, limit)); + }, null, null, null, null), + new ToolDefinition("report_progress_with_record", "Reports progress with record args and invocation", + Map.of("type", "object", "properties", + Map.ofEntries(Map.entry("query", Map.of("type", "string")), + Map.entry("limit", Map.of("type", "integer"))), + "required", List.of("query", "limit")), + invocation -> { + RecordInvocationArgs args = mapper.convertValue(invocation.getArguments(), + RecordInvocationArgs.class); + return CompletableFuture + .completedFuture(instance.reportProgressWithRecord(args, invocation)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java new file mode 100644 index 000000000..ac9c9bc78 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/InvocationAwareTools.java @@ -0,0 +1,56 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import java.util.concurrent.CompletableFuture; + +import com.github.copilot.rpc.RecordInvocationArgs; +import com.github.copilot.rpc.ToolInvocation; +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Tool fixture for {@link ToolInvocation} runtime context injection. + */ +public class InvocationAwareTools { + + @CopilotTool("Reports progress with invocation context") + public String reportProgress(@CopilotToolParam("Current phase") String phase, ToolInvocation invocation) { + return "phase=" + phase + ",sessionId=" + invocation.getSessionId() + ",toolCallId=" + + invocation.getToolCallId() + ",toolName=" + invocation.getToolName(); + } + + @CopilotTool("Reports progress asynchronously with invocation context") + public CompletableFuture reportProgressAsync(@CopilotToolParam("Current phase") String phase, + ToolInvocation invocation) { + return CompletableFuture.completedFuture("async phase=" + phase + ",sessionId=" + invocation.getSessionId() + + ",toolCallId=" + invocation.getToolCallId() + ",toolName=" + invocation.getToolName()); + } + + @CopilotTool("Reports progress with invocation first") + public String reportProgressFirst(ToolInvocation invocation, @CopilotToolParam("Current phase") String phase) { + return "first phase=" + phase + ",sessionId=" + invocation.getSessionId() + ",toolCallId=" + + invocation.getToolCallId() + ",toolName=" + invocation.getToolName(); + } + + @CopilotTool("Reports context with invocation only") + public String onlyContext(ToolInvocation invocation) { + return "only sessionId=" + invocation.getSessionId() + ",toolCallId=" + invocation.getToolCallId() + + ",toolName=" + invocation.getToolName(); + } + + @CopilotTool("Reports progress with invocation in the middle") + public String reportProgressMiddle(@CopilotToolParam("Current phase") String phase, ToolInvocation invocation, + @CopilotToolParam("Maximum items") int limit) { + return "middle phase=" + phase + ",limit=" + limit + ",sessionId=" + invocation.getSessionId() + ",toolCallId=" + + invocation.getToolCallId() + ",toolName=" + invocation.getToolName(); + } + + @CopilotTool("Reports progress with record args and invocation") + public String reportProgressWithRecord(RecordInvocationArgs args, ToolInvocation invocation) { + return "record query=" + args.query() + ",limit=" + args.limit() + ",sessionId=" + invocation.getSessionId() + + ",toolCallId=" + invocation.getToolCallId() + ",toolName=" + invocation.getToolName(); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools$$CopilotToolMeta.java new file mode 100644 index 000000000..571db8e7c --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools$$CopilotToolMeta.java @@ -0,0 +1,29 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class MultiReturnTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(MultiReturnTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("string_method", "Returns a string", + Map.of("type", "object", "properties", Map.of(), "required", List.of()), invocation -> { + return CompletableFuture.completedFuture(instance.stringMethod()); + }, null, null, null, null), new ToolDefinition("void_method", "Void method", + Map.of("type", "object", "properties", Map.of(), "required", List.of()), invocation -> { + instance.voidMethod(); + return CompletableFuture.completedFuture("Success"); + }, null, null, null, null), + new ToolDefinition("async_method", "Async method", + Map.of("type", "object", "properties", Map.of(), "required", List.of()), invocation -> { + return instance.asyncMethod().thenApply(r -> (Object) r); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java new file mode 100644 index 000000000..62a6a2500 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/MultiReturnTools.java @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import java.util.concurrent.CompletableFuture; + +import com.github.copilot.tool.CopilotTool; + +/** + * Fixture testing different return type patterns. + */ +public class MultiReturnTools { + + @CopilotTool("Returns a string") + public String stringMethod() { + return "hello"; + } + + @CopilotTool("Void method") + public void voidMethod() { + // side-effect only + } + + @CopilotTool("Async method") + public CompletableFuture asyncMethod() { + return CompletableFuture.completedFuture("async result"); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools$$CopilotToolMeta.java new file mode 100644 index 000000000..75fde6bb3 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools$$CopilotToolMeta.java @@ -0,0 +1,101 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output for Optional parameters. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class OptionalParamTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(OptionalParamTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition( + "greet_with_title", "Greet with optional title", Map + .of("type", "object", "properties", + Map.ofEntries( + Map.entry("name", + (Map) (Map) withMeta(Map.of("type", "string"), "Name", + null)), + Map.entry("title", + (Map) (Map) withMeta(Map.of("type", "string"), + "Optional title", null))), + "required", List.of("name")), + invocation -> { + Map args = invocation.getArguments(); + String name = (String) args.get("name"); + Object titleRaw = args.get("title"); + Optional title = titleRaw != null ? Optional.of((String) titleRaw) : Optional.empty(); + return CompletableFuture.completedFuture(instance.greetWithTitle(name, title)); + }, null, null, null, null), + new ToolDefinition("multiply", "Multiply with optional factor", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("base", + (Map) (Map) withMeta(Map.of("type", "integer"), + "Base value", null)), + Map.entry("factor", + (Map) (Map) withMeta(Map.of("type", "integer"), + "Optional factor", null))), + "required", List.of("base")), + invocation -> { + Map args = invocation.getArguments(); + int base = ((Number) args.get("base")).intValue(); + Object factorRaw = args.get("factor"); + OptionalInt factor = factorRaw != null + ? OptionalInt.of(((Number) factorRaw).intValue()) + : OptionalInt.empty(); + return CompletableFuture.completedFuture(instance.multiply(base, factor)); + }, null, null, null, null), + new ToolDefinition("scale", "Scale with optional ratio", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("value", + (Map) (Map) withMeta(Map.of("type", "number"), "Value", + null)), + Map.entry("ratio", + (Map) (Map) withMeta(Map.of("type", "number"), + "Optional ratio", null))), + "required", List.of("value")), + invocation -> { + Map args = invocation.getArguments(); + double value = ((Number) args.get("value")).doubleValue(); + Object ratioRaw = args.get("ratio"); + OptionalDouble ratio = ratioRaw != null + ? OptionalDouble.of(((Number) ratioRaw).doubleValue()) + : OptionalDouble.empty(); + return CompletableFuture.completedFuture(instance.scale(value, ratio)); + }, null, null, null, null), + new ToolDefinition("offset", "Offset with optional delta", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("base", + (Map) (Map) withMeta(Map.of("type", "integer"), "Base", + null)), + Map.entry("delta", + (Map) (Map) withMeta(Map.of("type", "integer"), + "Optional delta", null))), + "required", List.of("base")), + invocation -> { + Map args = invocation.getArguments(); + long base = ((Number) args.get("base")).longValue(); + Object deltaRaw = args.get("delta"); + OptionalLong delta = deltaRaw != null + ? OptionalLong.of(((Number) deltaRaw).longValue()) + : OptionalLong.empty(); + return CompletableFuture.completedFuture(instance.offset(base, delta)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java new file mode 100644 index 000000000..2986cb1c7 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OptionalParamTools.java @@ -0,0 +1,43 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import java.util.Optional; +import java.util.OptionalDouble; +import java.util.OptionalInt; +import java.util.OptionalLong; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Tool fixture with Optional parameter types for testing correct argument + * extraction (null-check + wrapping instead of mapper.convertValue). + */ +public class OptionalParamTools { + + @CopilotTool("Greet with optional title") + public String greetWithTitle(@CopilotToolParam("Name") String name, + @CopilotToolParam("Optional title") Optional title) { + return title.map(t -> t + " " + name).orElse(name); + } + + @CopilotTool("Multiply with optional factor") + public String multiply(@CopilotToolParam("Base value") int base, + @CopilotToolParam("Optional factor") OptionalInt factor) { + return String.valueOf(base * factor.orElse(1)); + } + + @CopilotTool("Scale with optional ratio") + public String scale(@CopilotToolParam("Value") double value, + @CopilotToolParam("Optional ratio") OptionalDouble ratio) { + return String.valueOf(value * ratio.orElse(1.0)); + } + + @CopilotTool("Offset with optional delta") + public String offset(@CopilotToolParam("Base") long base, @CopilotToolParam("Optional delta") OptionalLong delta) { + return String.valueOf(base + delta.orElse(0L)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools$$CopilotToolMeta.java new file mode 100644 index 000000000..2d37204f8 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools$$CopilotToolMeta.java @@ -0,0 +1,39 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class OverrideTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(OverrideTools instance, ObjectMapper mapper) { + return List + .of(new ToolDefinition( + "grep", "Custom grep implementation", Map + .of("type", "object", "properties", + Map.ofEntries(Map.entry("pattern", + (Map) (Map) withMeta(Map.of("type", "string"), + "Search pattern", null))), + "required", List.of("pattern")), + invocation -> { + Map args = invocation.getArguments(); + String pattern = (String) args.get("pattern"); + return CompletableFuture.completedFuture(instance.customGrep(pattern)); + }, Boolean.TRUE, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java new file mode 100644 index 000000000..990083066 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/OverrideTools.java @@ -0,0 +1,19 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Fixture testing tool override flag. + */ +public class OverrideTools { + + @CopilotTool(value = "Custom grep implementation", name = "grep", overridesBuiltInTool = true) + public String customGrep(@CopilotToolParam(value = "Search pattern", required = true) String pattern) { + return "Found: " + pattern; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools$$CopilotToolMeta.java new file mode 100644 index 000000000..ac38d0cce --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools$$CopilotToolMeta.java @@ -0,0 +1,53 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class SimpleTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(SimpleTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("greet_user", "Greets a user by name", + Map.of("type", "object", "properties", Map.ofEntries(Map.entry("name", + (Map) (Map) withMeta(Map.of("type", "string"), "The user's name", null))), + "required", List.of("name")), + invocation -> { + Map args = invocation.getArguments(); + String name = (String) args.get("name"); + return CompletableFuture.completedFuture(instance.greetUser(name)); + }, null, null, null, + Map.of("github.com/copilot:safeForTelemetry", + Map.of("name", true, "inputsNames", false))), + new ToolDefinition("add_numbers", "Adds two numbers together", + Map.of("type", "object", "properties", + Map.ofEntries( + Map.entry("a", + (Map) (Map) withMeta(Map.of("type", "integer"), + "First number", null)), + Map.entry("b", + (Map) (Map) withMeta(Map.of("type", "integer"), + "Second number", null))), + "required", List.of("a", "b")), + invocation -> { + Map args = invocation.getArguments(); + int a = ((Number) args.get("a")).intValue(); + int b = ((Number) args.get("b")).intValue(); + return CompletableFuture.completedFuture(instance.addNumbers(a, b)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java new file mode 100644 index 000000000..814b3883c --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/SimpleTools.java @@ -0,0 +1,28 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Simple tool fixture with basic String-returning methods. + */ +public class SimpleTools { + + @CopilotTool(value = "Greets a user by name", metadata = { + @CopilotTool.MetadataEntry(key = "github.com/copilot:safeForTelemetry", value = @CopilotTool.MetadataValue(flags = { + @CopilotTool.MetadataFlag(name = "name", value = true), + @CopilotTool.MetadataFlag(name = "inputsNames", value = false)}))}) + public String greetUser(@CopilotToolParam(value = "The user's name", required = true) String name) { + return "Hello, " + name + "!"; + } + + @CopilotTool("Adds two numbers together") + public String addNumbers(@CopilotToolParam(value = "First number") int a, + @CopilotToolParam(value = "Second number") int b) { + return String.valueOf(a + b); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools$$CopilotToolMeta.java new file mode 100644 index 000000000..2535d671e --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools$$CopilotToolMeta.java @@ -0,0 +1,29 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output for static ToolInvocation injection. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +public final class StaticInvocationTools$$CopilotToolMeta + implements + CopilotToolMetadataProvider { + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(StaticInvocationTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("report_static", "Returns invocation context from a static tool", + Map.of("type", "object", "properties", + Map.ofEntries(Map.entry("phase", Map.of("type", "string", "description", "Current phase"))), + "required", List.of("phase")), + invocation -> { + Map args = invocation.getArguments(); + String phase = (String) args.get("phase"); + return CompletableFuture.completedFuture(StaticInvocationTools.reportStatic(phase, invocation)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java new file mode 100644 index 000000000..a5cba003c --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticInvocationTools.java @@ -0,0 +1,21 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.rpc.ToolInvocation; +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Static tool fixture for {@link ToolInvocation} runtime context injection. + */ +public class StaticInvocationTools { + + @CopilotTool("Returns invocation context from a static tool") + public static String reportStatic(@CopilotToolParam("Current phase") String phase, ToolInvocation invocation) { + return "phase=" + phase + ",sessionId=" + invocation.getSessionId() + ",toolCallId=" + + invocation.getToolCallId() + ",toolName=" + invocation.getToolName(); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools$$CopilotToolMeta.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools$$CopilotToolMeta.java new file mode 100644 index 000000000..a0c6e6685 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools$$CopilotToolMeta.java @@ -0,0 +1,37 @@ +// Hand-written test fixture mimicking CopilotToolProcessor output for static methods. +package com.github.copilot.rpc.fixtures; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.tool.CopilotToolMetadataProvider; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +public final class StaticTools$$CopilotToolMeta implements CopilotToolMetadataProvider { + + private static Map withMeta(Map base, String description, Object defaultValue) { + var result = new LinkedHashMap(base); + if (description != null) + result.put("description", description); + if (defaultValue != null) + result.put("default", defaultValue); + return Collections.unmodifiableMap(result); + } + + @Override + @SuppressWarnings({"unchecked", "rawtypes"}) + public List definitions(StaticTools instance, ObjectMapper mapper) { + return List.of(new ToolDefinition("greet", "Returns a greeting for the given name", + Map.of("type", "object", "properties", Map.ofEntries(Map.entry("name", + (Map) (Map) withMeta(Map.of("type", "string"), "The name to greet", null))), + "required", List.of("name")), + invocation -> { + Map args = invocation.getArguments(); + String name = (String) args.get("name"); + // Mimics what the processor now generates for static methods: + // QualifiedClassName.method(...) instead of instance.method(...) + return CompletableFuture.completedFuture(StaticTools.greet(name)); + }, null, null, null, null)); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java new file mode 100644 index 000000000..9caef593d --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/rpc/fixtures/StaticTools.java @@ -0,0 +1,20 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.rpc.fixtures; + +import com.github.copilot.tool.CopilotTool; +import com.github.copilot.tool.CopilotToolParam; + +/** + * Tool fixture with a static {@code @CopilotTool} method, used to test + * {@code ToolDefinition.fromClass()} invocation path. + */ +public class StaticTools { + + @CopilotTool("Returns a greeting for the given name") + public static String greet(@CopilotToolParam(value = "The name to greet", required = true) String name) { + return "Hi, " + name + "!"; + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java new file mode 100644 index 000000000..649a4bd6c --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolAnnotationTest.java @@ -0,0 +1,155 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.InputStream; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.lang.reflect.Method; +import java.lang.reflect.Parameter; +import java.nio.charset.StandardCharsets; +import java.util.concurrent.CompletableFuture; + +import org.junit.jupiter.api.Test; + +import com.github.copilot.CopilotExperimental; +import com.github.copilot.rpc.ToolDefer; + +/** + * Unit tests for {@link CopilotTool} and {@link CopilotToolParam} annotations. + */ +public class CopilotToolAnnotationTest { + + // --- @CopilotTool attribute verification --- + + @Test + void copilotToolHasRuntimeRetention() { + Retention retention = CopilotTool.class.getAnnotation(Retention.class); + assertNotNull(retention); + assertEquals(RetentionPolicy.RUNTIME, retention.value()); + } + + @Test + void copilotToolTargetsMethod() { + Target target = CopilotTool.class.getAnnotation(Target.class); + assertNotNull(target); + assertArrayEquals(new ElementType[]{ElementType.METHOD}, target.value()); + } + + @Test + void copilotExperimentalTargetsTypeForAnnotationDeclarations() { + Target expTarget = CopilotExperimental.class.getAnnotation(Target.class); + assertNotNull(expTarget); + boolean includesType = false; + for (ElementType et : expTarget.value()) { + if (et == ElementType.TYPE) { + includesType = true; + break; + } + } + assertTrue(includesType, "@CopilotExperimental must target TYPE to be applicable to annotation declarations"); + } + + @Test + void copilotToolDeclaresCopilotExperimentalInClassFile() throws Exception { + String classFileResourcePath = "/" + CopilotTool.class.getName().replace('.', '/') + ".class"; + try (InputStream classFile = CopilotTool.class.getResourceAsStream(classFileResourcePath)) { + assertNotNull(classFile, "CopilotTool class file must be readable as a resource"); + String classFileText = new String(classFile.readAllBytes(), StandardCharsets.ISO_8859_1); + assertTrue(classFileText.contains("com/github/copilot/CopilotExperimental")); + } + } + + @Test + void copilotToolDefaultValues() throws Exception { + Method nameMethod = CopilotTool.class.getDeclaredMethod("name"); + assertEquals("", nameMethod.getDefaultValue()); + + Method overridesMethod = CopilotTool.class.getDeclaredMethod("overridesBuiltInTool"); + assertEquals(false, overridesMethod.getDefaultValue()); + + Method skipMethod = CopilotTool.class.getDeclaredMethod("skipPermission"); + assertEquals(false, skipMethod.getDefaultValue()); + + Method deferMethod = CopilotTool.class.getDeclaredMethod("defer"); + assertEquals(ToolDefer.NONE, deferMethod.getDefaultValue()); + } + + // --- @CopilotToolParam attribute verification --- + + @Test + void paramHasRuntimeRetention() { + Retention retention = CopilotToolParam.class.getAnnotation(Retention.class); + assertNotNull(retention); + assertEquals(RetentionPolicy.RUNTIME, retention.value()); + } + + @Test + void paramTargetsParameter() { + Target target = CopilotToolParam.class.getAnnotation(Target.class); + assertNotNull(target); + assertArrayEquals(new ElementType[]{ElementType.PARAMETER}, target.value()); + } + + @Test + void paramDefaultValues() throws Exception { + Method valueMethod = CopilotToolParam.class.getDeclaredMethod("value"); + assertEquals("", valueMethod.getDefaultValue()); + + Method nameMethod = CopilotToolParam.class.getDeclaredMethod("name"); + assertEquals("", nameMethod.getDefaultValue()); + + Method requiredMethod = CopilotToolParam.class.getDeclaredMethod("required"); + assertEquals(true, requiredMethod.getDefaultValue()); + + Method defaultValueMethod = CopilotToolParam.class.getDeclaredMethod("defaultValue"); + assertEquals("", defaultValueMethod.getDefaultValue()); + } + + // --- Applicability test --- + + @SuppressWarnings("unused") + static class SampleToolHolder { + + @CopilotTool(value = "Get weather for a location", name = "get_weather", defer = ToolDefer.AUTO) + public CompletableFuture getWeather( + @CopilotToolParam(value = "City name", required = true) String location, + @CopilotToolParam(value = "Temperature unit", required = false, defaultValue = "celsius") String unit) { + return CompletableFuture.completedFuture("Sunny in " + location); + } + } + + @Test + void annotationsAreAccessibleViaReflection() throws Exception { + Method method = SampleToolHolder.class.getDeclaredMethod("getWeather", String.class, String.class); + + CopilotTool toolAnnotation = method.getAnnotation(CopilotTool.class); + assertNotNull(toolAnnotation); + assertEquals("Get weather for a location", toolAnnotation.value()); + assertEquals("get_weather", toolAnnotation.name()); + assertFalse(toolAnnotation.overridesBuiltInTool()); + assertFalse(toolAnnotation.skipPermission()); + assertEquals(ToolDefer.AUTO, toolAnnotation.defer()); + + Parameter[] params = method.getParameters(); + assertEquals(2, params.length); + + CopilotToolParam locationParam = params[0].getAnnotation(CopilotToolParam.class); + assertNotNull(locationParam); + assertEquals("City name", locationParam.value()); + assertTrue(locationParam.required()); + assertEquals("", locationParam.defaultValue()); + + CopilotToolParam unitParam = params[1].getAnnotation(CopilotToolParam.class); + assertNotNull(unitParam); + assertEquals("Temperature unit", unitParam.value()); + assertFalse(unitParam.required()); + assertEquals("celsius", unitParam.defaultValue()); + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java new file mode 100644 index 000000000..e7012c644 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/tool/CopilotToolProcessorTest.java @@ -0,0 +1,1599 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.File; +import java.io.FilterWriter; +import java.io.IOException; +import java.io.Writer; +import java.net.URI; +import java.net.URLClassLoader; +import java.nio.file.Path; +import java.security.CodeSource; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.tools.Diagnostic; +import javax.tools.DiagnosticCollector; +import javax.tools.FileObject; +import javax.tools.ForwardingJavaFileManager; +import javax.tools.ForwardingJavaFileObject; +import javax.tools.JavaCompiler; +import javax.tools.JavaFileObject; +import javax.tools.SimpleJavaFileObject; +import javax.tools.StandardJavaFileManager; +import javax.tools.StandardLocation; +import javax.tools.ToolProvider; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import com.github.copilot.rpc.ToolDefinition; +import com.github.copilot.rpc.ToolInvocation; + +/** + * Tests that {@link CopilotToolProcessor} correctly generates + * {@code $$CopilotToolMeta} companion classes and emits compile errors for + * invalid usages. + */ +class CopilotToolProcessorTest { + + @TempDir + java.nio.file.Path tempDir; + + // ── Test: Basic generation ────────────────────────────────────────────────── + + @Test + void generatesMetaClass_withCorrectToolNames() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class MyTools { + @CopilotTool("Sets the current phase") + public String setCurrentPhase(@CopilotToolParam("The phase") String phase) { + return "done"; + } + @CopilotTool("Search for items") + public String searchItems(@CopilotToolParam("Keyword") String keyword) { + return "found"; + } + @CopilotTool(value = "Custom grep", name = "grep") + public String grepOverride(@CopilotToolParam("Query") String query) { + return "result"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.MyTools", source))); + + assertNoErrors(result); + // Verify generated source contains the expected tool names + String generated = result.getGeneratedSource("test.MyTools$$CopilotToolMeta"); + assertTrue(generated != null, "Expected $$CopilotToolMeta to be generated"); + assertTrue(generated.contains("\"set_current_phase\""), "Expected snake_case name: set_current_phase"); + assertTrue(generated.contains("\"search_items\""), "Expected snake_case name: search_items"); + assertTrue(generated.contains("\"grep\""), "Expected explicit name: grep"); + } + + // ── Test: Compile error for private methods ───────────────────────────────── + + @Test + void emitsError_forPrivateMethods() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class PrivateTools { + @CopilotTool("Private tool") + private String doSomething() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.PrivateTools", source))); + + assertTrue(hasErrorContaining(result, "must not be private"), + "Expected compile error for private @CopilotTool method, got: " + result.diagnostics); + } + + // ── Test: Compile error for required + defaultValue conflict ───────────── + + @Test + void emitsError_forRequiredWithDefaultValue() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class ConflictTools { + @CopilotTool("Conflicting params") + public String doSomething(@CopilotToolParam(value = "desc", required = true, defaultValue = "hello") String param) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ConflictTools", source))); + + assertTrue(hasErrorContaining(result, "required=true"), + "Expected compile error for required+defaultValue conflict, got: " + result.diagnostics); + } + + @Test + void emitsError_forOptionalPrimitiveWithoutDefaultValue() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class OptionalPrimitiveTools { + @CopilotTool("Optional primitive") + public String doSomething(@CopilotToolParam(value = "Limit", required = false) int limit) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.OptionalPrimitiveTools", source))); + + assertTrue(hasErrorContaining(result, "required=false"), + "Expected compile error for optional primitive without defaultValue, got: " + result.diagnostics); + } + + @Test + void emitsError_forSingleRecordWrapperDefaultValue() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SingleRecordDefaultTools { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Single record") + public String search(@CopilotToolParam(defaultValue = "fallback") SearchArgs req) { + return req.query(); + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.SingleRecordDefaultTools", source))); + + assertTrue(hasErrorContaining(result, "single-record tool parameters"), + "Expected compile error for single-record wrapper defaultValue, got: " + result.diagnostics); + } + + @Test + void emitsError_forSingleRecordWrapperSchemaWithoutUnsupportedGuidance() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SingleRecordSchemaTools { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Single record") + public String search(@CopilotToolParam(schema = "{\\"type\\":\\"object\\"}") SearchArgs req) { + return req.query(); + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.SingleRecordSchemaTools", source))); + + assertTrue(hasErrorContaining(result, "schema=...) is not supported on single-record tool parameters"), + "Expected unsupported schema diagnostic, got: " + result.diagnostics); + assertFalse(hasErrorContaining(result, "annotate record components"), + "Diagnostic must not recommend unsupported record-component annotations: " + result.diagnostics); + } + + @Test + void emitsError_forSingleRecordWrapperMetadataOverrides() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SingleRecordMetaTools { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Single record") + public String search(@CopilotToolParam(value = "Search input", required = false, name = "input") SearchArgs req) { + return req.query(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.SingleRecordMetaTools", source))); + + assertTrue(hasErrorContaining(result, "name/value/required"), + "Expected compile error for single-record wrapper metadata overrides, got: " + result.diagnostics); + } + + // ── Test: @CopilotToolParam schema override ───────────────────────────────── + + @Test + void generatesCorrectSchema_forExplicitSchemaOverride() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SchemaOverrideTools { + @CopilotTool("Schedule meeting") + public String schedule( + @CopilotToolParam(value = "When to meet", + schema = "{\\"type\\":\\"string\\",\\"format\\":\\"date-time\\"}") String when) { + return "scheduled " + when; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.SchemaOverrideTools", source))); + + assertNoErrors(result); + assertTrue(result.generatedSources.stream().anyMatch(s -> s.contains("date-time")), + "Expected generated code to contain the custom schema format, got: " + result.generatedSources); + } + + @Test + void generatedSchemaOverride_supportsCustomTypeHandlerInvocation() throws Exception { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class AnnotationSchemaTools { + public static class CustomDateTime { + public String value; + } + @CopilotTool("Schedule meeting") + public String schedule(@CopilotToolParam(value = "Meeting time", + schema = "{\\"type\\":\\"object\\",\\"properties\\":{\\"value\\":{\\"type\\":\\"string\\"}}}") CustomDateTime when) { + return "scheduled " + when.value; + } + } + """; + + CompilationResult compilation = compileWithProcessor( + List.of(inMemorySource("test.AnnotationSchemaTools", source))); + assertNoErrors(compilation); + + try (URLClassLoader loader = new URLClassLoader(new java.net.URL[]{compilation.outputDir.toUri().toURL()}, + getClass().getClassLoader())) { + Class toolsClass = loader.loadClass("test.AnnotationSchemaTools"); + Object tools = toolsClass.getConstructor().newInstance(); + Class providerClass = loader.loadClass("test.AnnotationSchemaTools$$CopilotToolMeta"); + @SuppressWarnings("unchecked") + CopilotToolMetadataProvider provider = (CopilotToolMetadataProvider) providerClass + .getConstructor().newInstance(); + ToolDefinition tool = provider.definitions(tools, new com.fasterxml.jackson.databind.ObjectMapper()).get(0); + + @SuppressWarnings("unchecked") + Map schema = (Map) tool.parameters(); + @SuppressWarnings("unchecked") + Map properties = (Map) schema.get("properties"); + @SuppressWarnings("unchecked") + Map whenSchema = (Map) properties.get("when"); + assertEquals("object", whenSchema.get("type")); + + var arguments = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode(); + arguments.putObject("when").put("value", "2026-07-23T22:00:00Z"); + Object result = tool.handler().invoke(new ToolInvocation().setArguments(arguments)).get(); + assertEquals("scheduled 2026-07-23T22:00:00Z", result); + } + } + + @Test + void emitsError_forSchemaWithDefaultValue() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SchemaDefaultConflict { + @CopilotTool("Do something") + public String doIt( + @CopilotToolParam(value = "Input", + schema = "{\\"type\\":\\"string\\"}", + defaultValue = "hello") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.SchemaDefaultConflict", source))); + + assertTrue(hasErrorContaining(result, "schema and defaultValue"), + "Expected compile error for schema + defaultValue conflict, got: " + result.diagnostics); + } + + @Test + void emitsError_forInvalidSchemaJson() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class InvalidSchemaTools { + @CopilotTool("Do something") + public String doIt( + @CopilotToolParam(value = "Input", schema = "not json") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.InvalidSchemaTools", source))); + + assertTrue(hasErrorContaining(result, "valid JSON object string"), + "Expected compile error for invalid schema JSON, got: " + result.diagnostics); + } + + @Test + void emitsError_forUnrepresentableSchemaNumber() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class UnrepresentableSchemaNumberTools { + @CopilotTool("Do something") + public String doIt( + @CopilotToolParam(value = "Input", schema = "{\\"maximum\\":1e9999999999}") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.UnrepresentableSchemaNumberTools", source))); + + assertTrue(hasErrorContaining(result, "Number cannot be represented"), + "Expected compile error for unrepresentable schema number, got: " + result.diagnostics); + } + + @Test + void compilesSuccessfully_forEmptySchemaFallsThrough() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class EmptySchemaTools { + @CopilotTool("Search") + public String search(@CopilotToolParam(value = "Query", schema = "") String query) { + return query; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.EmptySchemaTools", source))); + + assertNoErrors(result); + } + + @Test + void generatesSchemaOverride_withLargeObjectsNullAndNumbers() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class ComplexSchemaTools { + @CopilotTool("Complex schema") + public String useSchema(@CopilotToolParam(value = "Input", + schema = "{\\"type\\":\\"object\\",\\"const\\":null,\\"enum\\":[\\"x\\",null],\\"minimum\\":2147483648,\\"k1\\":true,\\"k2\\":true,\\"k3\\":true,\\"k4\\":true,\\"k5\\":true,\\"k6\\":true,\\"k7\\":true}") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ComplexSchemaTools", source))); + + assertNoErrors(result); + String generated = result.getGeneratedSource("test.ComplexSchemaTools$$CopilotToolMeta"); + assertTrue(generated.contains("mapOfNullable("), "Expected arity-independent map helper, got:\n" + generated); + assertTrue(generated.contains("new java.math.BigDecimal(\"2147483648\")"), + "Expected safe numeric source, got:\n" + generated); + assertTrue(generated.contains("\"const\", (Object) null"), "Expected null schema value, got:\n" + generated); + assertTrue(generated.contains("listOfNullable(\"x\", (Object) null)"), + "Expected null-tolerant list helper, got:\n" + generated); + } + + @Test + void jsonToMapOfSource_decodesEscapesAndRejectsMalformedJson() { + String generated = CopilotToolProcessor.jsonToMapOfSource("{\"title\":\"line\\n\\u0061\"}"); + + assertTrue(generated.contains("\"title\", \"line\\na\""), "Expected decoded JSON escapes, got: " + generated); + IllegalArgumentException escapeError = assertThrows(IllegalArgumentException.class, + () -> CopilotToolProcessor.jsonToMapOfSource("{\"title\":\"\\q\"}")); + assertTrue(escapeError.getMessage().contains("Invalid escape sequence")); + IllegalArgumentException numberError = assertThrows(IllegalArgumentException.class, + () -> CopilotToolProcessor.jsonToMapOfSource("{\"minimum\":1.}")); + assertTrue(numberError.getMessage().contains("Expected digit in number fraction")); + assertThrows(IllegalArgumentException.class, + () -> CopilotToolProcessor.jsonToMapOfSource("{\"minimum\":1\u0662}")); + assertThrows(IllegalArgumentException.class, + () -> CopilotToolProcessor.jsonToMapOfSource("{\f\"type\":\"string\"}")); + assertEquals("mapOfNullable(\"enum\", listOfNullable((Object) null))", + CopilotToolProcessor.jsonToMapOfSource("{\"enum\":[null]}")); + assertThrows(IllegalArgumentException.class, + () -> CopilotToolProcessor.jsonToMapOfSource("{\"title\":\"\\" + "u١٢٣٤\"}")); + } + + @Test + void generatesSchemaOverride_withEscapedControlCharacters() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class EscapedControlSchemaTools { + @CopilotTool("Escaped control schema") + public String useSchema(@CopilotToolParam(value = "Input", + schema = "{\\"title\\":\\"\\\\b\\\\fUNICODE_ESCAPE\\"}") String input) { + return input; + } + } + """.replace("UNICODE_ESCAPE", "\\\\" + "u0000"); + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.EscapedControlSchemaTools", source))); + + assertNoErrors(result); + String generated = result.getGeneratedSource("test.EscapedControlSchemaTools$$CopilotToolMeta"); + assertTrue(generated.contains("\\b\\f\\000"), + "Expected Java-safe control escapes in generated source, got:\n" + generated); + } + + // ── Test: Blank @CopilotToolParam description validation ──────────────────── + + @Test + void emitsError_forBlankParamDescription() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class BlankDescTools { + @CopilotTool("Search for items") + public String searchItems(@CopilotToolParam("") String query) { + return "results for " + query; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.BlankDescTools", source))); + + assertTrue(hasErrorContaining(result, "blank value (description)"), + "Expected compile error for blank @CopilotToolParam description, got: " + result.diagnostics); + } + + @Test + void emitsError_forWhitespaceOnlyParamDescription() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class WhitespaceDescTools { + @CopilotTool("Search for items") + public String searchItems(@CopilotToolParam(" ") String query) { + return "results for " + query; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.WhitespaceDescTools", source))); + + assertTrue(hasErrorContaining(result, "blank value (description)"), + "Expected compile error for whitespace-only @CopilotToolParam description, got: " + result.diagnostics); + } + + @Test + void compilesSuccessfully_forValidParamDescription() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class ValidDescTools { + @CopilotTool("Search for items") + public String searchItems(@CopilotToolParam("Search query") String query) { + return "results for " + query; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ValidDescTools", source))); + + assertNoErrors(result); + } + + @Test + void compilesSuccessfully_forParamWithoutAnnotation() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class NoAnnotationTools { + @CopilotTool("Search for items") + public String searchItems(String query) { + return "results for " + query; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.NoAnnotationTools", source))); + + assertNoErrors(result); + } + + @Test + void doesNotEmitBlankError_forSingleRecordWrapperWithDefaultAnnotation() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class RecordWrapperTools { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Search for items") + public String search(@CopilotToolParam SearchArgs args) { + return args.query(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.RecordWrapperTools", source))); + + assertFalse(hasErrorContaining(result, "blank value (description)"), + "Single-record wrapper should be exempt from blank description check, got: " + result.diagnostics); + } + + // ── Test: Return type handling ────────────────────────────────────────────── + + @Test + void generatesCorrectCode_forStringReturnType() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class StringReturn { + @CopilotTool("Returns string") + public String doSomething(@CopilotToolParam("Input") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.StringReturn", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.StringReturn$$CopilotToolMeta"); + assertTrue(generated.contains("CompletableFuture.completedFuture(instance.doSomething("), + "Expected completedFuture wrapping for String return, got:\n" + generated); + } + + @Test + void generatesMetadata_withNestedFlags() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class MetaTools { + @CopilotTool(value = "Reports phase", metadata = { + @CopilotTool.MetadataEntry( + key = "github.com/copilot:safeForTelemetry", + value = @CopilotTool.MetadataValue(flags = { + @CopilotTool.MetadataFlag(name = "name", value = true), + @CopilotTool.MetadataFlag(name = "inputsNames", value = false) + })) + }) + public String reportPhase(@CopilotToolParam("Phase") String phase) { + return phase; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.MetaTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.MetaTools$$CopilotToolMeta"); + assertTrue(generated.contains("Map.of(\"github.com/copilot:safeForTelemetry\""), + "Expected typed metadata map, got:\n" + generated); + assertTrue(generated.contains("Map.of(\"name\", true, \"inputsNames\", false)"), + "Expected nested flag map, got:\n" + generated); + } + + @Test + void generatesNullMetadata_whenAbsent() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class PlainTools { + @CopilotTool("Plain tool") + public String doSomething(@CopilotToolParam("Input") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.PlainTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.PlainTools$$CopilotToolMeta"); + assertFalse(generated.contains("Map.of("), + "Expected no metadata map for a tool without metadata, got:\n" + generated); + String normalizedGenerated = generated.replace("\r\n", "\n").replace('\r', '\n'); + assertTrue(normalizedGenerated.contains(" null,\n null\n )"), + "Expected metadata and isTerminal constructor arguments to be null when absent, got:\n" + generated); + } + + @Test + void generatesMetadata_alongsideOtherFlags() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.rpc.ToolDefer; + import com.github.copilot.tool.CopilotToolParam; + public class ComboTools { + @CopilotTool(value = "Combo", name = "combo", overridesBuiltInTool = true, + skipPermission = true, defer = ToolDefer.NEVER, + metadata = { + @CopilotTool.MetadataEntry(key = "k", + value = @CopilotTool.MetadataValue(bool = true)) + }) + public String doSomething(@CopilotToolParam("Input") String input) { + return input; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ComboTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.ComboTools$$CopilotToolMeta"); + assertTrue(generated.contains("Boolean.TRUE"), "Expected overrides/skip flags, got:\n" + generated); + assertTrue(generated.contains("ToolDefer.NEVER"), "Expected defer, got:\n" + generated); + assertTrue(generated.contains("Map.of(\"k\", true)"), + "Expected scalar bool metadata, got:\n" + generated); + } + + @Test + void generatesCorrectCode_forVoidReturnType() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class VoidReturn { + @CopilotTool("Void method") + public void doSomething(@CopilotToolParam("Input") String input) { + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.VoidReturn", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.VoidReturn$$CopilotToolMeta"); + assertTrue(generated.contains("instance.doSomething("), "Expected method call in generated code"); + assertTrue(generated.contains("CompletableFuture.completedFuture(\"Success\")"), + "Expected 'Success' return for void methods, got:\n" + generated); + } + + @Test + void generatesCorrectCode_forCompletableFutureStringReturnType() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + import java.util.concurrent.CompletableFuture; + public class AsyncReturn { + @CopilotTool("Async method") + public CompletableFuture doSomething(@CopilotToolParam("Input") String input) { + return CompletableFuture.completedFuture(input); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.AsyncReturn", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.AsyncReturn$$CopilotToolMeta"); + assertTrue(generated.contains("return instance.doSomething("), + "Expected direct return for CompletableFuture, got:\n" + generated); + assertTrue(generated.contains("thenApply(r -> (Object) r)"), + "Expected thenApply cast for CompletableFuture, got:\n" + generated); + } + + @Test + void generatesCorrectCode_forIntReturnType() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class IntReturn { + @CopilotTool("Returns int") + public int doSomething(@CopilotToolParam("Input") String input) { + return 42; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.IntReturn", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.IntReturn$$CopilotToolMeta"); + assertTrue(generated.contains("mapper.writeValueAsString(instance.doSomething("), + "Expected JSON serialization for int return type, got:\n" + generated); + } + + // ── Test: Argument coercion ───────────────────────────────────────────────── + + @Test + void generatesCorrectArgExtraction_forPrimitiveAndStringTypes() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class ArgTypes { + @CopilotTool("Mixed args") + public String doSomething( + @CopilotToolParam("Name") String name, + @CopilotToolParam("Count") int count, + @CopilotToolParam("Flag") boolean flag) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ArgTypes", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.ArgTypes$$CopilotToolMeta"); + assertTrue(generated.contains("(String) args.get(\"name\")"), + "Expected String cast for String param, got:\n" + generated); + assertTrue(generated.contains("((Number) args.get(\"count\")).intValue()"), + "Expected Number cast for int param, got:\n" + generated); + assertTrue(generated.contains("(Boolean) args.get(\"flag\")"), + "Expected Boolean cast for boolean param, got:\n" + generated); + } + + @Test + void generatesTypeReferenceConversion_forArrayParameters() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class ArrayArgs { + @CopilotTool("Array tool") + public String doSomething(@CopilotToolParam("Ids") String[] ids) { + return String.valueOf(ids.length); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ArrayArgs", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.ArrayArgs$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for ArrayArgs$$CopilotToolMeta"); + assertTrue(generated.contains("new com.fasterxml.jackson.core.type.TypeReference() {}"), + "Expected TypeReference-based conversion for String[] parameter, got:\n" + generated); + assertFalse( + generated.contains("String[] ids = (Object) args.get(\"ids\");") + || generated.contains("java.lang.String[] ids = (Object) args.get(\"ids\");"), + "Array parameter should no longer be assigned from raw Object, got:\n" + generated); + } + + @Test + void generatesTypeReferenceConversion_forGenericDeclaredParameters() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class GenericArgTypes { + public record MyRecord(String name) {} + @CopilotTool("Generic args") + public String doSomething( + @CopilotToolParam("Ids") java.util.List ids, + @CopilotToolParam("Values") java.util.Map values, + @CopilotToolParam("Records") java.util.List records) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.GenericArgTypes", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.GenericArgTypes$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for GenericArgTypes$$CopilotToolMeta"); + + assertTrue( + generated.contains( + "new com.fasterxml.jackson.core.type.TypeReference>() {}"), + "Expected TypeReference for List, got:\n" + generated); + assertTrue(generated.contains( + "new com.fasterxml.jackson.core.type.TypeReference>() {}"), + "Expected TypeReference for Map, got:\n" + generated); + assertTrue(generated.contains( + "new com.fasterxml.jackson.core.type.TypeReference>() {}"), + "Expected TypeReference for List, got:\n" + generated); + assertFalse(generated.contains("java.util.List.class"), + "Generic declared params should not use raw List.class conversion, got:\n" + generated); + assertFalse(generated.contains("java.util.Map.class"), + "Generic declared params should not use raw Map.class conversion, got:\n" + generated); + } + + // ── Test: snake_case conversion ───────────────────────────────────────────── + + @Test + void snakeCaseConversion() { + assertEquals("set_current_phase", CopilotToolProcessor.toSnakeCase("setCurrentPhase")); + assertEquals("search_items", CopilotToolProcessor.toSnakeCase("searchItems")); + assertEquals("grep", CopilotToolProcessor.toSnakeCase("grep")); + assertEquals("get_u_r_l", CopilotToolProcessor.toSnakeCase("getURL")); + assertEquals("a", CopilotToolProcessor.toSnakeCase("a")); + assertEquals("", CopilotToolProcessor.toSnakeCase("")); + } + + // ── Test: Processor registration ──────────────────────────────────────────── + + @Test + void processorIsRegisteredInMetaInfServices() throws Exception { + var resource = getClass().getClassLoader() + .getResource("META-INF/services/javax.annotation.processing.Processor"); + assertTrue(resource != null, "META-INF/services/javax.annotation.processing.Processor should exist"); + String content = new String(resource.openStream().readAllBytes()); + assertTrue(content.contains("com.github.copilot.tool.CopilotToolProcessor"), + "Service file should contain CopilotToolProcessor"); + } + + // ── Test: Schema generation in generated code ─────────────────────────────── + + @Test + void generatesCorrectSchema() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class SchemaTools { + @CopilotTool("Search items") + public String search( + @CopilotToolParam(value = "Query", required = true) String query, + @CopilotToolParam(value = "Limit", required = false) Integer limit) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.SchemaTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.SchemaTools$$CopilotToolMeta"); + // Verify the schema contains the expected keys + assertTrue(generated.contains("\"type\", \"object\""), "Expected object type in schema"); + assertTrue(generated.contains("\"properties\""), "Expected properties in schema"); + assertTrue(generated.contains("\"required\""), "Expected required in schema"); + assertTrue(generated.contains("\"query\""), "Expected query property"); + } + + @Test + void generatesFlattenedSchemaAndDirectRecordConversion_forSingleRecordParameter() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class RecordTool { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Search items") + public String search(SearchArgs req) { + return req.query() + ":" + req.limit(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.RecordTool", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.RecordTool$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for RecordTool$$CopilotToolMeta"); + assertTrue( + generated.contains("mapper.convertValue(invocation.getArguments(), test.RecordTool.SearchArgs.class)"), + "Expected direct convertValue(invocation.getArguments(), ...), got:\n" + generated); + assertFalse(generated.contains("Map args = invocation.getArguments();"), + "Single-record path should not declare local args map, got:\n" + generated); + assertFalse(generated.contains("Map.entry(\"req\""), + "Single-record schema should be flattened, not nested under wrapper param, got:\n" + generated); + assertTrue(generated.contains("\"query\""), + "Expected flattened record component in schema, got:\n" + generated); + } + + @Test + void supportsSingleRecordParameterNamedArgs_withoutLocalNameCollision() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class RecordToolArgs { + public record SearchArgs(String query) {} + @CopilotTool("Search items") + public String search(SearchArgs args) { + return args.query(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.RecordToolArgs", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.RecordToolArgs$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for RecordToolArgs$$CopilotToolMeta"); + assertTrue(generated.contains( + "test.RecordToolArgs.SearchArgs args = mapper.convertValue(invocation.getArguments(), test.RecordToolArgs.SearchArgs.class);"), + "Expected args-named record param to compile with direct invocation mapping, got:\n" + generated); + assertFalse(generated.contains("Map args = invocation.getArguments();"), + "Single-record path should avoid local args map collision, got:\n" + generated); + } + + @Test + void supportsInjectedToolInvocation_forSchemaAndMethodCall() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class InvocationAwareTools { + @CopilotTool("Reports progress") + public String report(@CopilotToolParam("Phase") String phase, ToolInvocation toolInvocation) { + return phase + ":" + toolInvocation.getSessionId(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.InvocationAwareTools", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.InvocationAwareTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for InvocationAwareTools$$CopilotToolMeta"); + assertTrue(generated.contains("Map.entry(\"phase\""), + "Expected normal parameter in schema, got:\n" + generated); + assertFalse(generated.contains("Map.entry(\"invocation\""), + "ToolInvocation must not appear in schema properties, got:\n" + generated); + assertFalse(generated.contains("Map.entry(\"toolInvocation\""), + "ToolInvocation must not appear in schema properties, got:\n" + generated); + assertTrue(generated.contains("required\", List.of(\"phase\")"), + "Expected only normal parameters in required list, got:\n" + generated); + assertFalse(generated.contains("args.get(\"toolInvocation\")"), + "ToolInvocation must not be read from invocation arguments, got:\n" + generated); + assertTrue(generated.contains("instance.report(phase, invocation)"), + "ToolInvocation parameter should be injected from runtime invocation, got:\n" + generated); + } + + @Test + void supportsInjectedToolInvocation_forStaticAndAsyncMethods() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + import java.util.concurrent.CompletableFuture; + public class StaticInvocationAwareTools { + @CopilotTool("Reports progress statically") + public static String report(@CopilotToolParam("Phase") String phase, ToolInvocation toolInvocation) { + return phase + ":" + toolInvocation.getToolCallId(); + } + @CopilotTool("Reports progress asynchronously") + public CompletableFuture reportAsync(@CopilotToolParam("Phase") String phase, ToolInvocation toolInvocation) { + return CompletableFuture.completedFuture(phase + ":" + toolInvocation.getToolCallId()); + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.StaticInvocationAwareTools", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.StaticInvocationAwareTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for StaticInvocationAwareTools$$CopilotToolMeta"); + assertTrue(generated.contains("test.StaticInvocationAwareTools.report(phase, invocation)"), + "Expected static method call with injected invocation, got:\n" + generated); + assertTrue(generated.contains("return instance.reportAsync(phase, invocation).thenApply(r -> (Object) r);"), + "Expected async method call with injected invocation, got:\n" + generated); + } + + @Test + void supportsInjectedToolInvocation_whenItIsTheOnlyParameter() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + public class InvocationOnlyTools { + @CopilotTool("Reports invocation context only") + public String onlyContext(ToolInvocation invocation) { + return invocation.getSessionId(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.InvocationOnlyTools", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.InvocationOnlyTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for InvocationOnlyTools$$CopilotToolMeta"); + assertTrue(generated.contains("\"properties\", Map.of(), \"required\", List.of()"), + "Expected empty schema for invocation-only method, got:\n" + generated); + assertFalse(generated.contains("Map args = invocation.getArguments();"), + "Invocation-only method should not read argument map, got:\n" + generated); + assertTrue(generated.contains("instance.onlyContext(invocation)"), + "Invocation-only method should inject invocation directly, got:\n" + generated); + } + + @Test + void supportsInjectedToolInvocation_whenItAppearsFirstOrMiddle() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class InvocationPositionTools { + @CopilotTool("Invocation first") + public String reportFirst(ToolInvocation invocation, @CopilotToolParam("Phase") String phase) { + return phase + ":" + invocation.getToolCallId(); + } + @CopilotTool("Invocation middle") + public String reportMiddle(@CopilotToolParam("Phase") String phase, ToolInvocation invocation, @CopilotToolParam("Limit") int limit) { + return phase + ":" + limit + ":" + invocation.getToolCallId(); + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.InvocationPositionTools", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.InvocationPositionTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for InvocationPositionTools$$CopilotToolMeta"); + assertTrue(generated.contains("instance.reportFirst(invocation, phase)"), + "Expected invocation to be passed in first position, got:\n" + generated); + assertTrue(generated.contains("instance.reportMiddle(phase, invocation, limit)"), + "Expected invocation to be passed in middle position, got:\n" + generated); + assertFalse(generated.contains("args.get(\"invocation\")"), + "ToolInvocation must not be read from invocation arguments, got:\n" + generated); + assertTrue(generated.contains("Map.entry(\"phase\""), + "Expected schema-visible phase parameter, got:\n" + generated); + assertTrue(generated.contains("Map.entry(\"limit\""), + "Expected schema-visible limit parameter, got:\n" + generated); + assertFalse(generated.contains("Map.entry(\"invocation\""), + "ToolInvocation must not appear in schema properties, got:\n" + generated); + } + + @Test + void supportsInjectedToolInvocation_withSingleRecordSchemaParameter() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + public class RecordInvocationTools { + public record SearchArgs(String query, int limit) {} + @CopilotTool("Record plus invocation") + public String report(SearchArgs args, ToolInvocation invocation) { + return args.query() + ":" + invocation.getSessionId(); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.RecordInvocationTools", source))); + assertNoErrors(result); + + String generated = result.getGeneratedSource("test.RecordInvocationTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for RecordInvocationTools$$CopilotToolMeta"); + assertTrue(generated.contains( + "test.RecordInvocationTools.SearchArgs args = mapper.convertValue(invocation.getArguments(), test.RecordInvocationTools.SearchArgs.class);"), + "Expected single-record conversion for schema-visible parameter, got:\n" + generated); + assertTrue(generated.contains("instance.report(args, invocation)"), + "Expected record + invocation method call order, got:\n" + generated); + assertFalse(generated.contains("Map.entry(\"args\""), + "Single-record schema should be flattened, got:\n" + generated); + assertFalse(generated.contains("args.get(\"invocation\")"), + "ToolInvocation must not be read from invocation arguments, got:\n" + generated); + } + + @Test + void emitsError_forDuplicateToolInvocationParameters() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + public class DuplicateInvocationTools { + @CopilotTool("Invalid duplicate ToolInvocation") + public String report(String phase, ToolInvocation first, ToolInvocation second) { + return phase; + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.DuplicateInvocationTools", source))); + + assertTrue(hasErrorContaining(result, "at most one ToolInvocation parameter"), + "Expected compile error for duplicate ToolInvocation parameters, got: " + result.diagnostics); + } + + @Test + void emitsError_forParamAnnotatedToolInvocationParameter() { + String source = """ + package test; + import com.github.copilot.rpc.ToolInvocation; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class AnnotatedInvocationTools { + @CopilotTool("Invalid @CopilotToolParam on ToolInvocation") + public String report(@CopilotToolParam("Invocation context") ToolInvocation invocation) { + return invocation.getToolName(); + } + } + """; + + CompilationResult result = compileWithProcessor( + List.of(inMemorySource("test.AnnotatedInvocationTools", source))); + + assertTrue(hasErrorContaining(result, "@CopilotToolParam is not supported on ToolInvocation parameters"), + "Expected compile error for @CopilotToolParam ToolInvocation parameter, got: " + result.diagnostics); + } + + // ── Test: Typed default values in schema ──────────────────────────────────── + + @Test + void emitsTypedDefaultValuesInSchema() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class DefaultTools { + @CopilotTool("Tool with defaults") + public String doWork( + @CopilotToolParam(value = "Limit", required = false, defaultValue = "10") int limit, + @CopilotToolParam(value = "Enabled", required = false, defaultValue = "true") boolean enabled, + @CopilotToolParam(value = "Label", required = false, defaultValue = "hello") String label) { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.DefaultTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.DefaultTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for DefaultTools$$CopilotToolMeta"); + + // Numeric default should be an unquoted literal, not a string + assertTrue(generated.contains("withMeta(") && generated.contains(", 10)"), + "Expected numeric default 10 as typed literal, not string. Generated:\n" + generated); + // Boolean default should be an unquoted literal + assertTrue(generated.contains(", true)"), + "Expected boolean default true as typed literal, not string. Generated:\n" + generated); + // String default should remain a quoted string + assertTrue(generated.contains(", \"hello\")"), + "Expected string default \"hello\" as quoted string. Generated:\n" + generated); + } + + @Test + void rejectsMismatchedNumericDefaultForIntegralParameters() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class MismatchedDefaults { + @CopilotTool("Tool with bad default") + public String doWork(@CopilotToolParam(value = "Limit", required = false, defaultValue = "1.5") int limit) { + return String.valueOf(limit); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.MismatchedDefaults", source))); + assertTrue(hasErrorContaining(result, "not valid for int parameters"), + "Expected compile error for mismatched int defaultValue, got: " + result.diagnostics); + } + + // ── Test: package-private methods are allowed ─────────────────────────────── + + @Test + void allowsPackagePrivateMethods() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class PackagePrivateTools { + @CopilotTool("Package private tool") + String doSomething() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.PackagePrivateTools", source))); + assertNoErrors(result); + } + + // ── Test: protected methods are allowed ───────────────────────────────────── + + @Test + void allowsProtectedMethods() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class ProtectedTools { + @CopilotTool("Protected tool") + protected String doSomething() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.ProtectedTools", source))); + assertNoErrors(result); + } + + // ── Test: overridesBuiltInTool generates createOverride ───────────────────── + + @Test + void generatesCreateOverride_whenOverridesBuiltInTool() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + public class OverrideTools { + @CopilotTool(value = "Custom grep", name = "grep", overridesBuiltInTool = true) + public String grep(@CopilotToolParam("Query") String query) { + return "result"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.OverrideTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.OverrideTools$$CopilotToolMeta"); + assertTrue(generated.contains("new ToolDefinition("), "Expected record constructor, got:\n" + generated); + assertTrue(generated.contains("Boolean.TRUE"), + "Expected Boolean.TRUE for overridesBuiltInTool, got:\n" + generated); + } + + @Test + void generatesTerminalTool_whenIsTerminal() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + public class TerminalTools { + @CopilotTool(value = "Ends the turn", isTerminal = true) + public String finish() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.TerminalTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.TerminalTools$$CopilotToolMeta"); + String normalizedGenerated = generated.replace("\r\n", "\n").replace('\r', '\n'); + assertTrue(normalizedGenerated.contains( + " null,\n null,\n null,\n null,\n Boolean.TRUE\n )"), + "Expected Boolean.TRUE for isTerminal in the final constructor position, got:\n" + generated); + } + + // ── Test: Combined flags all apply independently ──────────────────────────── + + @Test + void generatesCombinedFlags() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.rpc.ToolDefer; + public class CombinedTools { + @CopilotTool(value = "Combined", overridesBuiltInTool = true, skipPermission = true, + isTerminal = true, defer = ToolDefer.AUTO) + public String doAll() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.CombinedTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.CombinedTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected generated source for CombinedTools$$CopilotToolMeta"); + assertTrue(generated.contains("new ToolDefinition("), "Expected record constructor, got:\n" + generated); + // All three flags must be present — not silently dropped + assertTrue(generated.contains("Boolean.TRUE"), + "Expected Boolean.TRUE for override/skipPermission, got:\n" + generated); + assertTrue(generated.contains("ToolDefer.AUTO"), "Expected ToolDefer.AUTO, got:\n" + generated); + // Count Boolean.TRUE occurrences — override, skipPermission, and isTerminal. + long boolCount = generated.lines().filter(l -> l.contains("Boolean.TRUE")).count(); + assertEquals(3, boolCount, + "Expected 3 Boolean.TRUE lines (override + skipPermission + isTerminal), got:\n" + generated); + } + + // ── Test: ToolDefer.NONE results in regular create ────────────────────────── + + @Test + void generatesCreate_whenDeferIsNone() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.rpc.ToolDefer; + public class DeferNoneTools { + @CopilotTool(value = "Simple tool", defer = ToolDefer.NONE) + public String doSomething() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.DeferNoneTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.DeferNoneTools$$CopilotToolMeta"); + assertTrue(generated.contains("new ToolDefinition("), + "Expected record constructor for NONE, got:\n" + generated); + assertFalse(generated.contains("ToolDefer."), "Should NOT reference ToolDefer for NONE, got:\n" + generated); + } + + // ── Test: ToolDefer.AUTO results in createWithDefer ────────────────────────── + + @Test + void generatesCreateWithDefer_whenDeferIsAuto() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.rpc.ToolDefer; + public class DeferAutoTools { + @CopilotTool(value = "Deferrable tool", defer = ToolDefer.AUTO) + public String doSomething() { + return "done"; + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.DeferAutoTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.DeferAutoTools$$CopilotToolMeta"); + assertTrue(generated.contains("new ToolDefinition("), + "Expected record constructor for AUTO, got:\n" + generated); + assertTrue(generated.contains("ToolDefer.AUTO"), "Expected ToolDefer.AUTO argument, got:\n" + generated); + } + + // ── Test: Optional parameter extraction ───────────────────────────────────── + + @Test + void generatesCorrectOptionalExtraction() { + String source = """ + package test; + import com.github.copilot.tool.CopilotTool; + import com.github.copilot.tool.CopilotToolParam; + import java.util.Optional; + import java.util.OptionalInt; + import java.util.OptionalLong; + import java.util.OptionalDouble; + public class OptionalTools { + @CopilotTool("Tool with optional string") + public String withOptionalString(@CopilotToolParam("A name") Optional name) { + return name.orElse("default"); + } + @CopilotTool("Tool with optional int") + public String withOptionalInt(@CopilotToolParam("A count") OptionalInt count) { + return String.valueOf(count.orElse(0)); + } + @CopilotTool("Tool with optional long") + public String withOptionalLong(@CopilotToolParam("A timestamp") OptionalLong ts) { + return String.valueOf(ts.orElse(0L)); + } + @CopilotTool("Tool with optional double") + public String withOptionalDouble(@CopilotToolParam("A ratio") OptionalDouble ratio) { + return String.valueOf(ratio.orElse(0.0)); + } + } + """; + + CompilationResult result = compileWithProcessor(List.of(inMemorySource("test.OptionalTools", source))); + assertNoErrors(result); + String generated = result.getGeneratedSource("test.OptionalTools$$CopilotToolMeta"); + assertNotNull(generated, "Expected $$CopilotToolMeta to be generated"); + + // Optional should use null-check + Optional.of wrapping + assertTrue(generated.contains("Optional.of(") || generated.contains("java.util.Optional.of("), + "Expected Optional.of() wrapping for Optional, got:\n" + generated); + assertTrue(generated.contains("Optional.empty()") || generated.contains("java.util.Optional.empty()"), + "Expected Optional.empty() fallback, got:\n" + generated); + + // OptionalInt should use OptionalInt.of(((Number)...).intValue()) + assertTrue(generated.contains("OptionalInt.of(((Number)"), + "Expected OptionalInt.of(((Number)...).intValue()), got:\n" + generated); + assertTrue(generated.contains("OptionalInt.empty()"), + "Expected OptionalInt.empty() fallback, got:\n" + generated); + + // OptionalLong should use OptionalLong.of(((Number)...).longValue()) + assertTrue(generated.contains("OptionalLong.of(((Number)"), + "Expected OptionalLong.of(((Number)...).longValue()), got:\n" + generated); + assertTrue(generated.contains("OptionalLong.empty()"), + "Expected OptionalLong.empty() fallback, got:\n" + generated); + + // OptionalDouble should use OptionalDouble.of(((Number)...).doubleValue()) + assertTrue(generated.contains("OptionalDouble.of(((Number)"), + "Expected OptionalDouble.of(((Number)...).doubleValue()), got:\n" + generated); + assertTrue(generated.contains("OptionalDouble.empty()"), + "Expected OptionalDouble.empty() fallback, got:\n" + generated); + + // Should NOT use mapper.convertValue for Optional types + assertFalse(generated.contains("mapper.convertValue(args.get(\"name\"), java.util.Optional.class)"), + "Should NOT use mapper.convertValue for Optional, got:\n" + generated); + } + + // ── Helpers ───────────────────────────────────────────────────────────────── + + private CompilationResult compileWithProcessor(List sources) { + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + + String classpath = resolveClasspath(); + List options = new ArrayList<>(); + options.add("-proc:full"); + options.addAll(List.of("-processor", "com.github.copilot.tool.CopilotToolProcessor")); + options.addAll(List.of("-classpath", classpath)); + options.addAll(List.of("-d", tempDir.toString())); + options.addAll(List.of("-s", tempDir.toString())); + // Allow experimental APIs during test compilation + options.add("-Acopilot.experimental.allowed=true"); + + try (StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null)) { + fileManager.setLocation(StandardLocation.SOURCE_OUTPUT, List.of(tempDir.toFile())); + fileManager.setLocation(StandardLocation.CLASS_OUTPUT, List.of(tempDir.toFile())); + CollectingFileManager collectingFileManager = new CollectingFileManager(fileManager); + + JavaCompiler.CompilationTask task = compiler.getTask(null, collectingFileManager, diagnostics, options, + null, sources); + task.call(); + + List generatedSources = collectingFileManager.getGeneratedSources(); + if (generatedSources.isEmpty()) { + // Fallback for file-manager implementations that only materialize on disk. + collectGeneratedFiles(tempDir, generatedSources); + } + + return new CompilationResult(diagnostics.getDiagnostics(), generatedSources, tempDir); + } catch (Exception e) { + throw new RuntimeException("Compilation setup failed", e); + } + } + + private void collectGeneratedFiles(java.nio.file.Path dir, List files) { + try (var stream = java.nio.file.Files.walk(dir)) { + stream.filter(p -> p.toString().endsWith(".java")).forEach(p -> { + try { + files.add(java.nio.file.Files.readString(p)); + } catch (java.io.IOException e) { + // ignore read errors for generated file collection + } + }); + } catch (java.io.IOException e) { + // ignore walk errors + } + } + + private static String resolveClasspath() { + // Collect classpath entries from CodeSource of key classes needed for + // compiling both the source and the generated $$CopilotToolMeta code. + Set paths = new LinkedHashSet<>(); + + // Add system classpath entries (may include manifest-only jars) + String systemCp = System.getProperty("java.class.path", ""); + if (!systemCp.isEmpty()) { + for (String p : systemCp.split(java.util.regex.Pattern.quote(File.pathSeparator))) { + if (!p.isEmpty()) { + paths.add(p); + } + } + } + + // Also resolve CodeSource paths for key classes (SDK + Jackson + RPC types) + Class[] keyClasses = {CopilotTool.class, com.fasterxml.jackson.databind.ObjectMapper.class, + com.fasterxml.jackson.core.JsonFactory.class, com.fasterxml.jackson.annotation.JsonProperty.class, + com.github.copilot.rpc.ToolDefinition.class}; + for (Class cls : keyClasses) { + try { + CodeSource cs = cls.getProtectionDomain().getCodeSource(); + if (cs != null && cs.getLocation() != null) { + paths.add(Path.of(cs.getLocation().toURI()).toString()); + } + } catch (Exception e) { + // skip this class + } + } + + return paths.isEmpty() ? "." : String.join(File.pathSeparator, paths); + } + + private static JavaFileObject inMemorySource(String className, String code) { + return new SimpleJavaFileObject(URI.create("string:///" + className.replace('.', '/') + ".java"), + JavaFileObject.Kind.SOURCE) { + @Override + public CharSequence getCharContent(boolean ignoreEncodingErrors) { + return code; + } + }; + } + + private static void assertNoErrors(CompilationResult result) { + List> errors = result.diagnostics.stream() + .filter(d -> d.getKind() == Diagnostic.Kind.ERROR).toList(); + assertTrue(errors.isEmpty(), "Expected no errors, got: " + errors); + } + + private static boolean hasErrorContaining(CompilationResult result, String substring) { + return result.diagnostics.stream() + .anyMatch(d -> d.getKind() == Diagnostic.Kind.ERROR && d.getMessage(null).contains(substring)); + } + + private static class CompilationResult { + final List> diagnostics; + final List generatedSources; + final java.nio.file.Path outputDir; + + CompilationResult(List> diagnostics, List generatedSources, + java.nio.file.Path outputDir) { + this.diagnostics = diagnostics; + this.generatedSources = generatedSources; + this.outputDir = outputDir; + } + + String getGeneratedSource(String qualifiedName) { + String fileName = qualifiedName.replace('.', '/') + ".java"; + java.nio.file.Path filePath = outputDir.resolve(fileName); + try { + if (java.nio.file.Files.exists(filePath)) { + return java.nio.file.Files.readString(filePath); + } + } catch (java.io.IOException e) { + // fall through + } + // Also check in collected sources + String simpleName = qualifiedName.substring(qualifiedName.lastIndexOf('.') + 1); + for (String source : generatedSources) { + if (source.contains("class " + simpleName)) { + return source; + } + } + return null; + } + } + + private static class CollectingFileManager extends ForwardingJavaFileManager { + private final Map generatedByClass = new LinkedHashMap<>(); + + CollectingFileManager(StandardJavaFileManager fileManager) { + super(fileManager); + } + + @Override + public JavaFileObject getJavaFileForOutput(Location location, String className, JavaFileObject.Kind kind, + FileObject sibling) throws IOException { + JavaFileObject delegate = super.getJavaFileForOutput(location, className, kind, sibling); + if (kind != JavaFileObject.Kind.SOURCE) { + return delegate; + } + StringBuilder captured = new StringBuilder(); + generatedByClass.put(className, captured); + return new ForwardingJavaFileObject<>(delegate) { + @Override + public Writer openWriter() throws IOException { + Writer target = delegate.openWriter(); + return new FilterWriter(target) { + @Override + public void write(char[] cbuf, int off, int len) throws IOException { + captured.append(cbuf, off, len); + super.write(cbuf, off, len); + } + + @Override + public void write(int c) throws IOException { + captured.append((char) c); + super.write(c); + } + + @Override + public void write(String str, int off, int len) throws IOException { + captured.append(str, off, off + len); + super.write(str, off, len); + } + }; + } + }; + } + + List getGeneratedSources() { + return generatedByClass.values().stream().map(StringBuilder::toString).toList(); + } + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/tool/ParamTest.java b/java/sdk/src/test/java/com/github/copilot/tool/ParamTest.java new file mode 100644 index 000000000..c2b38a4ce --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/tool/ParamTest.java @@ -0,0 +1,308 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.api.Test; + +/** + * Unit tests for {@link Param} runtime parameter metadata. + */ +public class ParamTest { + + // ------------------------------------------------------------------ + // Factory method: of(type, name, description) + // ------------------------------------------------------------------ + + @Test + void ofCreatesRequiredParamWithNoDefault() { + Param p = Param.of(String.class, "query", "Search query"); + assertEquals(String.class, p.type()); + assertEquals("query", p.name()); + assertEquals("Search query", p.description()); + assertTrue(p.required()); + assertEquals("", p.defaultValue()); + assertFalse(p.hasDefaultValue()); + } + + @Test + void ofFullFactoryCreatesOptionalParamWithDefault() { + Param p = Param.of(Integer.class, "limit", "Max results", false, "10"); + assertEquals(Integer.class, p.type()); + assertEquals("limit", p.name()); + assertEquals("Max results", p.description()); + assertFalse(p.required()); + assertEquals("10", p.defaultValue()); + assertTrue(p.hasDefaultValue()); + } + + // ------------------------------------------------------------------ + // Validation: blank name/description rejected + // ------------------------------------------------------------------ + + @Test + void rejectsNullName() { + var ex = assertThrows(IllegalArgumentException.class, () -> Param.of(String.class, null, "desc")); + assertTrue(ex.getMessage().contains("name")); + } + + @Test + void rejectsBlankName() { + var ex = assertThrows(IllegalArgumentException.class, () -> Param.of(String.class, " ", "desc")); + assertTrue(ex.getMessage().contains("name")); + } + + @Test + void rejectsNullDescription() { + var ex = assertThrows(IllegalArgumentException.class, () -> Param.of(String.class, "n", null)); + assertTrue(ex.getMessage().contains("description")); + } + + @Test + void rejectsBlankDescription() { + var ex = assertThrows(IllegalArgumentException.class, () -> Param.of(String.class, "n", "")); + assertTrue(ex.getMessage().contains("description")); + } + + // ------------------------------------------------------------------ + // Validation: required=true with non-empty default rejected + // ------------------------------------------------------------------ + + @Test + void rejectsRequiredWithNonEmptyDefault() { + var ex = assertThrows(IllegalArgumentException.class, () -> Param.of(String.class, "x", "desc", true, "val")); + assertTrue(ex.getMessage().contains("required=true")); + } + + @Test + void allowsRequiredWithEmptyDefault() { + Param p = Param.of(String.class, "x", "desc", true, ""); + assertTrue(p.required()); + assertFalse(p.hasDefaultValue()); + } + + @Test + void allowsRequiredWithNullDefault() { + Param p = Param.of(String.class, "x", "desc", true, null); + assertTrue(p.required()); + assertEquals("", p.defaultValue()); + } + + // ------------------------------------------------------------------ + // Validation: default value type checking + // ------------------------------------------------------------------ + + @Test + void validatesIntegerDefault() { + // valid + Param p = Param.of(Integer.class, "n", "num", false, "42"); + assertEquals("42", p.defaultValue()); + + // invalid + assertThrows(IllegalArgumentException.class, () -> Param.of(Integer.class, "n", "num", false, "abc")); + } + + @Test + void validatesLongDefault() { + Param p = Param.of(Long.class, "n", "num", false, "999999999999"); + assertEquals("999999999999", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Long.class, "n", "num", false, "notlong")); + } + + @Test + void validatesDoubleDefault() { + Param p = Param.of(Double.class, "d", "decimal", false, "3.14"); + assertEquals("3.14", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Double.class, "d", "decimal", false, "xyz")); + } + + @Test + void validatesFloatDefault() { + Param p = Param.of(Float.class, "f", "float val", false, "1.5"); + assertEquals("1.5", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Float.class, "f", "float val", false, "notfloat")); + } + + @Test + void validatesShortDefault() { + Param p = Param.of(Short.class, "s", "short val", false, "100"); + assertEquals("100", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Short.class, "s", "short val", false, "99999")); + } + + @Test + void validatesByteDefault() { + Param p = Param.of(Byte.class, "b", "byte val", false, "127"); + assertEquals("127", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Byte.class, "b", "byte val", false, "999")); + } + + @Test + void validatesBooleanDefault() { + Param p1 = Param.of(Boolean.class, "b", "flag", false, "true"); + assertEquals("true", p1.defaultValue()); + + Param p2 = Param.of(Boolean.class, "b", "flag", false, "FALSE"); + assertEquals("FALSE", p2.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(Boolean.class, "b", "flag", false, "yes")); + } + + @Test + void validatesEnumDefault() { + Param p = Param.of(TestEnum.class, "e", "enum val", false, "ALPHA"); + assertEquals("ALPHA", p.defaultValue()); + + assertThrows(IllegalArgumentException.class, () -> Param.of(TestEnum.class, "e", "enum val", false, "INVALID")); + } + + @Test + void rejectsUnsupportedTypeWithDefault() { + assertThrows(IllegalArgumentException.class, () -> Param.of(Object.class, "o", "object", false, "something")); + } + + @Test + void allowsStringDefault() { + Param p = Param.of(String.class, "s", "string", false, "hello"); + assertEquals("hello", p.defaultValue()); + } + + // ------------------------------------------------------------------ + // Fluent mutators return new instances + // ------------------------------------------------------------------ + + @Test + void nameMutatorReturnsNewInstance() { + Param original = Param.of(String.class, "a", "desc"); + Param renamed = original.name("b"); + assertEquals("a", original.name()); + assertEquals("b", renamed.name()); + } + + @Test + void descriptionMutatorReturnsNewInstance() { + Param original = Param.of(String.class, "a", "desc1"); + Param updated = original.description("desc2"); + assertEquals("desc1", original.description()); + assertEquals("desc2", updated.description()); + } + + @Test + void requiredMutatorReturnsNewInstance() { + Param original = Param.of(String.class, "a", "desc"); + Param optional = original.required(false); + assertTrue(original.required()); + assertFalse(optional.required()); + } + + @Test + void defaultValueMutatorSetsOptional() { + Param original = Param.of(String.class, "a", "desc"); + Param withDefault = original.defaultValue("val"); + assertTrue(original.required()); + assertFalse(withDefault.required()); + assertEquals("val", withDefault.defaultValue()); + assertTrue(withDefault.hasDefaultValue()); + } + + // ------------------------------------------------------------------ + // equals / hashCode / toString + // ------------------------------------------------------------------ + + @Test + void equalParamsAreEqual() { + Param a = Param.of(String.class, "x", "desc"); + Param b = Param.of(String.class, "x", "desc"); + assertEquals(a, b); + assertEquals(a.hashCode(), b.hashCode()); + } + + @Test + void differentParamsAreNotEqual() { + Param a = Param.of(String.class, "x", "desc"); + Param b = Param.of(String.class, "y", "desc"); + assertNotEquals(a, b); + } + + @Test + void toStringContainsName() { + Param p = Param.of(String.class, "query", "Search"); + assertTrue(p.toString().contains("query")); + assertTrue(p.toString().contains("String")); + } + + // ------------------------------------------------------------------ + // Schema override validation + // ------------------------------------------------------------------ + + @Test + void rejectsSchemaWithDefaultValue() { + var ex = assertThrows(IllegalArgumentException.class, + () -> Param.of(String.class, "x", "desc").schema("{\"type\":\"string\"}").defaultValue("hello")); + assertTrue(ex.getMessage().contains("schema")); + assertTrue(ex.getMessage().contains("defaultValue")); + } + + @Test + void rejectsSchemaNotStartingWithBrace() { + var ex = assertThrows(IllegalArgumentException.class, + () -> Param.of(String.class, "x", "desc").schema("not json")); + assertTrue(ex.getMessage().contains("schema")); + } + + @Test + void rejectsSchemaNotEndingWithBrace() { + var ex = assertThrows(IllegalArgumentException.class, + () -> Param.of(String.class, "x", "desc").schema("{\"type\":\"string\"")); + assertTrue(ex.getMessage().contains("schema")); + } + + @Test + void acceptsValidSchemaJson() { + Param p = Param.of(String.class, "x", "desc").schema("{\"type\":\"string\",\"format\":\"date-time\"}"); + assertEquals("{\"type\":\"string\",\"format\":\"date-time\"}", p.schema()); + } + + @Test + void acceptsEmptySchema() { + Param p = Param.of(String.class, "x", "desc"); + assertEquals("", p.schema()); + } + + @Test + void schemaPreservedAcrossFluentCopies() { + Param base = Param.of(String.class, "x", "desc").schema("{\"type\":\"string\"}"); + assertEquals("{\"type\":\"string\"}", base.name("y").schema()); + assertEquals("{\"type\":\"string\"}", base.description("other").schema()); + assertEquals("{\"type\":\"string\"}", base.required(false).schema()); + } + + // ------------------------------------------------------------------ + // Null type rejected + // ------------------------------------------------------------------ + + @Test + void rejectsNullType() { + assertThrows(NullPointerException.class, () -> Param.of(null, "n", "desc")); + } + + // ------------------------------------------------------------------ + // Test enum for validation tests + // ------------------------------------------------------------------ + + enum TestEnum { + ALPHA, BETA + } +} diff --git a/java/sdk/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java b/java/sdk/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java new file mode 100644 index 000000000..00bb1d969 --- /dev/null +++ b/java/sdk/src/test/java/com/github/copilot/tool/SchemaGeneratorTest.java @@ -0,0 +1,762 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +package com.github.copilot.tool; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.IOException; +import java.net.URI; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Set; + +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.ProcessingEnvironment; +import javax.annotation.processing.RoundEnvironment; +import javax.annotation.processing.SupportedAnnotationTypes; +import javax.annotation.processing.SupportedSourceVersion; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.Element; +import javax.lang.model.element.ElementKind; +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.TypeElement; +import javax.lang.model.element.VariableElement; +import javax.lang.model.type.TypeMirror; +import javax.lang.model.util.Elements; +import javax.lang.model.util.Types; +import javax.tools.DiagnosticCollector; +import javax.tools.JavaCompiler; +import javax.tools.JavaFileObject; +import javax.tools.SimpleJavaFileObject; +import javax.tools.StandardJavaFileManager; +import javax.tools.StandardLocation; +import javax.tools.ToolProvider; + +import org.junit.jupiter.api.Test; + +/** + * Tests for {@link SchemaGenerator} using the compilation-testing approach. A + * test annotation processor exercises SchemaGenerator during compilation of + * small source snippets. + */ +public class SchemaGeneratorTest { + + /** + * In-memory Java source file for compilation testing. + */ + private static class InMemorySource extends SimpleJavaFileObject { + + private final String code; + + InMemorySource(String className, String code) { + super(URI.create("string:///" + className.replace('.', '/') + Kind.SOURCE.extension), Kind.SOURCE); + this.code = code; + } + + @Override + public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException { + return code; + } + } + + /** + * Test processor that captures schema generation results. + */ + @SupportedAnnotationTypes("*") + @SupportedSourceVersion(SourceVersion.RELEASE_17) + public static class SchemaCapturingProcessor extends AbstractProcessor { + + static final List capturedSchemas = new ArrayList<>(); + static final List capturedParameterSchemas = new ArrayList<>(); + + private Types typeUtils; + private Elements elementUtils; + + @Override + public synchronized void init(ProcessingEnvironment processingEnv) { + super.init(processingEnv); + this.typeUtils = processingEnv.getTypeUtils(); + this.elementUtils = processingEnv.getElementUtils(); + } + + @Override + public boolean process(Set annotations, RoundEnvironment roundEnv) { + if (roundEnv.processingOver()) { + return false; + } + + SchemaGenerator generator = new SchemaGenerator(); + + for (Element rootElement : roundEnv.getRootElements()) { + if (rootElement.getKind() == ElementKind.CLASS || rootElement.getKind() == ElementKind.RECORD + || rootElement.getKind() == ElementKind.INTERFACE + || rootElement.getKind() == ElementKind.ENUM) { + // Find methods named "schemaTarget" to capture schemas for their return type + for (Element enclosed : rootElement.getEnclosedElements()) { + if (enclosed.getKind() == ElementKind.METHOD) { + ExecutableElement method = (ExecutableElement) enclosed; + String methodName = method.getSimpleName().toString(); + if (methodName.startsWith("schemaTarget")) { + TypeMirror returnType = method.getReturnType(); + String schema = generator.generateSchemaSource(returnType, typeUtils, elementUtils); + capturedSchemas.add(methodName + "=" + schema); + } + if ("parametersTarget".equals(methodName)) { + List params = method.getParameters(); + String schema = generator.generateParametersSchemaSource(params, typeUtils, + elementUtils); + capturedParameterSchemas.add(schema); + } + } + } + + // For record/enum types, generate schema for the type itself + TypeElement typeElement = (TypeElement) rootElement; + String typeName = typeElement.getSimpleName().toString(); + if (typeName.startsWith("TestRecord") || typeName.startsWith("TestEnum") + || typeName.startsWith("TestSealed")) { + String schema = generator.generateSchemaSource(typeElement.asType(), typeUtils, elementUtils); + capturedSchemas.add(typeName + "=" + schema); + } + } + } + + return false; + } + } + + private static final Path CLASS_OUTPUT_DIR = Path.of("target", "test-schema-classes"); + + /** + * Creates a StandardJavaFileManager that writes compiled .class files to + * target/test-schema-classes/ instead of the working directory. + */ + private StandardJavaFileManager createFileManager(JavaCompiler compiler, + DiagnosticCollector diagnostics) throws IOException { + Files.createDirectories(CLASS_OUTPUT_DIR); + StandardJavaFileManager fm = compiler.getStandardFileManager(diagnostics, null, null); + fm.setLocation(StandardLocation.CLASS_OUTPUT, List.of(CLASS_OUTPUT_DIR.toFile())); + return fm; + } + + private List compileAndCapture(String... sources) { + return compileAndCapture(Arrays.asList(sources)); + } + + private List compileAndCapture(List sourceTexts) { + SchemaCapturingProcessor.capturedSchemas.clear(); + SchemaCapturingProcessor.capturedParameterSchemas.clear(); + + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + assertNotNull(compiler, "System Java compiler not available"); + + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + + List compilationUnits = new ArrayList<>(); + for (String sourceText : sourceTexts) { + // Extract class name from source + String className = extractClassName(sourceText); + compilationUnits.add(new InMemorySource(className, sourceText)); + } + + try (StandardJavaFileManager fm = createFileManager(compiler, diagnostics)) { + // Compile with the processor on classpath + JavaCompiler.CompilationTask task = compiler.getTask(null, // writer + fm, // file manager + diagnostics, // diagnostics + List.of("--add-modules", "ALL-MODULE-PATH"), // options + null, // annotation classes + compilationUnits); + + task.setProcessors(List.of(new SchemaCapturingProcessor())); + boolean success = task.call(); + + if (!success) { + // Try without module options for simpler environments + diagnostics = new DiagnosticCollector<>(); + try (StandardJavaFileManager fm2 = createFileManager(compiler, diagnostics)) { + task = compiler.getTask(null, fm2, diagnostics, null, null, compilationUnits); + task.setProcessors(List.of(new SchemaCapturingProcessor())); + success = task.call(); + } + } + + assertTrue(success, "Compilation failed: " + diagnostics.getDiagnostics()); + } catch (IOException e) { + fail("Failed to create file manager: " + e.getMessage()); + } + return new ArrayList<>(SchemaCapturingProcessor.capturedSchemas); + } + + private List compileAndCaptureParams(String source) { + SchemaCapturingProcessor.capturedSchemas.clear(); + SchemaCapturingProcessor.capturedParameterSchemas.clear(); + + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + assertNotNull(compiler, "System Java compiler not available"); + + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + + String className = extractClassName(source); + List compilationUnits = List.of(new InMemorySource(className, source)); + + try (StandardJavaFileManager fm = createFileManager(compiler, diagnostics)) { + JavaCompiler.CompilationTask task = compiler.getTask(null, fm, diagnostics, null, null, compilationUnits); + task.setProcessors(List.of(new SchemaCapturingProcessor())); + boolean success = task.call(); + + assertTrue(success, "Compilation failed: " + diagnostics.getDiagnostics()); + } catch (IOException e) { + fail("Failed to create file manager: " + e.getMessage()); + } + return new ArrayList<>(SchemaCapturingProcessor.capturedParameterSchemas); + } + + private String extractClassName(String source) { + // Simple extraction: find "class X", "record X", "enum X", or "interface X" + for (String keyword : new String[]{"class ", "record ", "enum ", "interface "}) { + int idx = source.indexOf(keyword); + if (idx >= 0) { + int start = idx + keyword.length(); + int end = start; + while (end < source.length() && Character.isJavaIdentifierPart(source.charAt(end))) { + end++; + } + return source.substring(start, end); + } + } + return "Unknown"; + } + + // --- Type mapping tests --- + + @Test + void stringType() { + String source = """ + public class TestStringHolder { + public String schemaTargetString() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetString", "Map.of(\"type\", \"string\")"); + } + + @Test + void intPrimitiveType() { + String source = """ + public class TestIntHolder { + public int schemaTargetInt() { return 0; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetInt", "Map.of(\"type\", \"integer\")"); + } + + @Test + void integerBoxedType() { + String source = """ + public class TestIntegerHolder { + public Integer schemaTargetInteger() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetInteger", "Map.of(\"type\", \"integer\")"); + } + + @Test + void longType() { + String source = """ + public class TestLongHolder { + public long schemaTargetLong() { return 0L; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetLong", "Map.of(\"type\", \"integer\")"); + } + + @Test + void doubleType() { + String source = """ + public class TestDoubleHolder { + public double schemaTargetDouble() { return 0.0; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetDouble", "Map.of(\"type\", \"number\")"); + } + + @Test + void floatType() { + String source = """ + public class TestFloatHolder { + public float schemaTargetFloat() { return 0.0f; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetFloat", "Map.of(\"type\", \"number\")"); + } + + @Test + void booleanPrimitiveType() { + String source = """ + public class TestBooleanHolder { + public boolean schemaTargetBoolean() { return false; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetBoolean", "Map.of(\"type\", \"boolean\")"); + } + + @Test + void booleanBoxedType() { + String source = """ + public class TestBooleanBoxedHolder { + public Boolean schemaTargetBooleanBoxed() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetBooleanBoxed", "Map.of(\"type\", \"boolean\")"); + } + + @Test + void byteBoxedType() { + String source = """ + public class TestByteHolder { + public Byte schemaTargetByte() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetByte", "Map.of(\"type\", \"integer\")"); + } + + @Test + void shortBoxedType() { + String source = """ + public class TestShortHolder { + public Short schemaTargetShort() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetShort", "Map.of(\"type\", \"integer\")"); + } + + @Test + void characterBoxedType() { + String source = """ + public class TestCharHolder { + public Character schemaTargetChar() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetChar", "Map.of(\"type\", \"string\")"); + } + + @Test + void stringArrayType() { + String source = """ + public class TestArrayHolder { + public String[] schemaTargetArray() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetArray", + "Map.of(\"type\", \"array\", \"items\", Map.of(\"type\", \"string\"))"); + } + + @Test + void enumType() { + String source = """ + public enum TestEnumColor { RED, GREEN, BLUE } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "TestEnumColor", + "Map.of(\"type\", \"string\", \"enum\", List.of(\"RED\", \"GREEN\", \"BLUE\"))"); + } + + @Test + void listOfStringType() { + String source = """ + import java.util.List; + public class TestListHolder { + public List schemaTargetList() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetList", + "Map.of(\"type\", \"array\", \"items\", Map.of(\"type\", \"string\"))"); + } + + @Test + void mapStringStringType() { + String source = """ + import java.util.Map; + public class TestMapHolder { + public Map schemaTargetMap() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetMap", + "Map.of(\"type\", \"object\", \"additionalProperties\", Map.of(\"type\", \"string\"))"); + } + + @Test + void mapStringObjectType() { + String source = """ + import java.util.Map; + public class TestMapObjectHolder { + public Map schemaTargetMapObject() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetMapObject", "Map.of(\"type\", \"object\")"); + } + + @Test + void mapStringBooleanType() { + String source = """ + import java.util.Map; + public class TestMapBoolHolder { + public Map schemaTargetMapBool() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetMapBool", + "Map.of(\"type\", \"object\", \"additionalProperties\", Map.of(\"type\", \"boolean\"))"); + } + + @Test + void mapStringLongType() { + String source = """ + import java.util.Map; + public class TestMapLongHolder { + public Map schemaTargetMapLong() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetMapLong", + "Map.of(\"type\", \"object\", \"additionalProperties\", Map.of(\"type\", \"integer\"))"); + } + + @Test + void optionalStringType() { + String source = """ + import java.util.Optional; + public class TestOptionalHolder { + public Optional schemaTargetOptional() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetOptional", "Map.of(\"type\", \"string\")"); + } + + @Test + void optionalIntType() { + String source = """ + import java.util.OptionalInt; + public class TestOptionalIntHolder { + public OptionalInt schemaTargetOptionalInt() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetOptionalInt", "Map.of(\"type\", \"integer\")"); + } + + @Test + void optionalLongType() { + String source = """ + import java.util.OptionalLong; + public class TestOptionalLongHolder { + public OptionalLong schemaTargetOptionalLong() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetOptionalLong", "Map.of(\"type\", \"integer\")"); + } + + @Test + void optionalDoubleType() { + String source = """ + import java.util.OptionalDouble; + public class TestOptionalDoubleHolder { + public OptionalDouble schemaTargetOptionalDouble() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetOptionalDouble", "Map.of(\"type\", \"number\")"); + } + + @Test + void uuidType() { + String source = """ + import java.util.UUID; + public class TestUuidHolder { + public UUID schemaTargetUuid() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetUuid", "Map.of(\"type\", \"string\", \"format\", \"uuid\")"); + } + + @Test + void offsetDateTimeType() { + String source = """ + import java.time.OffsetDateTime; + public class TestDateTimeHolder { + public OffsetDateTime schemaTargetDateTime() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetDateTime", + "Map.of(\"type\", \"string\", \"format\", \"date-time\")"); + } + + @Test + void localDateTimeType() { + String source = """ + import java.time.LocalDateTime; + public class TestLocalDateTimeHolder { + public LocalDateTime schemaTargetLocalDateTime() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetLocalDateTime", + "Map.of(\"type\", \"string\", \"format\", \"date-time\")"); + } + + @Test + void instantType() { + String source = """ + import java.time.Instant; + public class TestInstantHolder { + public Instant schemaTargetInstant() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetInstant", "Map.of(\"type\", \"string\", \"format\", \"date-time\")"); + } + + @Test + void zonedDateTimeType() { + String source = """ + import java.time.ZonedDateTime; + public class TestZonedDateTimeHolder { + public ZonedDateTime schemaTargetZonedDateTime() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetZonedDateTime", + "Map.of(\"type\", \"string\", \"format\", \"date-time\")"); + } + + @Test + void localDateType() { + String source = """ + import java.time.LocalDate; + public class TestLocalDateHolder { + public LocalDate schemaTargetLocalDate() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetLocalDate", "Map.of(\"type\", \"string\", \"format\", \"date\")"); + } + + @Test + void localTimeType() { + String source = """ + import java.time.LocalTime; + public class TestLocalTimeHolder { + public LocalTime schemaTargetLocalTime() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetLocalTime", "Map.of(\"type\", \"string\", \"format\", \"time\")"); + } + + @Test + void recordType() { + String source = """ + public record TestRecordPerson(String name, int age, boolean active) {} + """; + List schemas = compileAndCapture(source); + String expected = "Map.of(\"type\", \"object\", \"properties\", " + + "Map.ofEntries(Map.entry(\"name\", Map.of(\"type\", \"string\")), " + + "Map.entry(\"age\", Map.of(\"type\", \"integer\")), " + + "Map.entry(\"active\", Map.of(\"type\", \"boolean\"))), " + + "\"required\", List.of(\"name\", \"age\", \"active\"))"; + assertContainsSchema(schemas, "TestRecordPerson", expected); + } + + @Test + void recordWithOptionalField() { + String source = """ + import java.util.Optional; + public record TestRecordWithOptional(String name, Optional nickname) {} + """; + List schemas = compileAndCapture(source); + String expected = "Map.of(\"type\", \"object\", \"properties\", " + + "Map.ofEntries(Map.entry(\"name\", Map.of(\"type\", \"string\")), " + + "Map.entry(\"nickname\", Map.of(\"type\", \"string\"))), " + "\"required\", List.of(\"name\"))"; + assertContainsSchema(schemas, "TestRecordWithOptional", expected); + } + + @Test + void recordWithMoreThanTenFields() { + String source = """ + public record TestRecordLarge( + String f1, String f2, String f3, String f4, String f5, + String f6, String f7, String f8, String f9, String f10, + String f11) {} + """; + List schemas = compileAndCapture(source); + // Verify the schema contains all 11 fields and uses Map.ofEntries + String schema = schemas.stream().filter(s -> s.startsWith("TestRecordLarge=")).findFirst().orElse(""); + assertFalse(schema.isEmpty(), "Expected schema for TestRecordLarge"); + assertTrue(schema.contains("Map.ofEntries("), "Should use Map.ofEntries for >10 fields: " + schema); + assertTrue(schema.contains("Map.entry(\"f1\""), "Should have f1: " + schema); + assertTrue(schema.contains("Map.entry(\"f11\""), "Should have f11: " + schema); + // Verify the generated source expression is compilable by re-compiling it + String schemaExpr = schema.substring(schema.indexOf('=') + 1); + String validationSource = "import java.util.Map;\nimport java.util.List;\n" + + "public class LargeRecordValidation {\n" + " @SuppressWarnings(\"unchecked\")\n" + + " public Object schema() { return " + schemaExpr + "; }\n}\n"; + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + List units = List.of(new InMemorySource("LargeRecordValidation", validationSource)); + try (StandardJavaFileManager fm = createFileManager(compiler, diagnostics)) { + JavaCompiler.CompilationTask task = compiler.getTask(null, fm, diagnostics, null, null, units); + boolean success = task.call(); + assertTrue(success, "Generated schema for >10-field record does not compile: " + + diagnostics.getDiagnostics() + "\nSource:\n" + validationSource); + } catch (IOException e) { + fail("Failed to create file manager: " + e.getMessage()); + } + } + + @Test + void parametersSchema() { + String source = """ + public class TestParamsHolder { + public void parametersTarget(String query, int limit, boolean verbose) {} + } + """; + List paramSchemas = compileAndCaptureParams(source); + assertFalse(paramSchemas.isEmpty(), "Expected parameter schemas"); + String schema = paramSchemas.get(0); + assertTrue(schema.contains("\"type\", \"object\""), "Should be object type: " + schema); + assertTrue(schema.contains("Map.entry(\"query\", Map.of(\"type\", \"string\"))"), + "Should have query property: " + schema); + assertTrue(schema.contains("Map.entry(\"limit\", Map.of(\"type\", \"integer\"))"), + "Should have limit property: " + schema); + assertTrue(schema.contains("Map.entry(\"verbose\", Map.of(\"type\", \"boolean\"))"), + "Should have verbose property: " + schema); + assertTrue(schema.contains("\"required\", List.of("), "Should have required list: " + schema); + } + + @Test + void generatedSourceIsValidJava() { + // Verify that generated schema source code compiles when embedded in a method + // body + String source = """ + import java.util.List; + import java.util.Map; + import java.util.Optional; + public class TestValidJavaHolder { + public String schemaTargetStr() { return null; } + public List schemaTargetListStr() { return null; } + public Map schemaTargetMapStr() { return null; } + public Optional schemaTargetOpt() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertFalse(schemas.isEmpty()); + + // Build a Java source that uses the generated schema expressions + StringBuilder validationSource = new StringBuilder(); + validationSource.append("import java.util.Map;\n"); + validationSource.append("import java.util.List;\n"); + validationSource.append("public class SchemaValidation {\n"); + validationSource.append(" @SuppressWarnings(\"unchecked\")\n"); + validationSource.append(" public void validate() {\n"); + for (int i = 0; i < schemas.size(); i++) { + String schema = schemas.get(i); + String schemaExpr = schema.substring(schema.indexOf('=') + 1); + validationSource.append(" Object s" + i + " = " + schemaExpr + ";\n"); + } + validationSource.append(" }\n"); + validationSource.append("}\n"); + + // Compile the validation source to verify syntactic validity + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + List compilationUnits = List + .of(new InMemorySource("SchemaValidation", validationSource.toString())); + + try (StandardJavaFileManager fm = createFileManager(compiler, diagnostics)) { + JavaCompiler.CompilationTask task = compiler.getTask(null, fm, diagnostics, null, null, compilationUnits); + boolean success = task.call(); + + assertTrue(success, "Generated schema source code is not valid Java: " + diagnostics.getDiagnostics() + + "\nSource:\n" + validationSource); + } catch (IOException e) { + fail("Failed to create file manager: " + e.getMessage()); + } + } + + @Test + void nestedMapListType() { + String source = """ + import java.util.List; + import java.util.Map; + public class TestNestedHolder { + public Map> schemaTargetNestedMap() { return null; } + } + """; + List schemas = compileAndCapture(source); + String expected = "Map.of(\"type\", \"object\", \"additionalProperties\", " + + "Map.of(\"type\", \"array\", \"items\", Map.of(\"type\", \"string\")))"; + assertContainsSchema(schemas, "schemaTargetNestedMap", expected); + } + + @Test + void objectType() { + String source = """ + public class TestObjectHolder { + public Object schemaTargetObject() { return null; } + } + """; + List schemas = compileAndCapture(source); + assertContainsSchema(schemas, "schemaTargetObject", "Map.of()"); + } + + @Test + void sealedInterfaceType() { + String sealedInterface = """ + public sealed interface TestSealedShape permits TestSealedCircle, TestSealedRect {} + """; + String circle = """ + public record TestSealedCircle(double radius) implements TestSealedShape {} + """; + String rect = """ + public record TestSealedRect(double width, double height) implements TestSealedShape {} + """; + List schemas = compileAndCapture(sealedInterface, circle, rect); + String expected = "Map.of(\"oneOf\", List.of(" + "Map.of(\"type\", \"object\", \"properties\", " + + "Map.ofEntries(Map.entry(\"radius\", Map.of(\"type\", \"number\"))), " + + "\"required\", List.of(\"radius\")), " + "Map.of(\"type\", \"object\", \"properties\", " + + "Map.ofEntries(Map.entry(\"width\", Map.of(\"type\", \"number\")), " + + "Map.entry(\"height\", Map.of(\"type\", \"number\"))), " + + "\"required\", List.of(\"width\", \"height\"))))"; + assertContainsSchema(schemas, "TestSealedShape", expected); + } + + private void assertContainsSchema(List schemas, String methodName, String expectedSchema) { + String expected = methodName + "=" + expectedSchema; + assertTrue(schemas.stream().anyMatch(s -> s.equals(expected)), + "Expected schema '" + expected + "' not found in: " + schemas); + } +} diff --git a/java/src/test/prompts/PROMPT-smoke-test.md b/java/sdk/src/test/prompts/PROMPT-smoke-test.md similarity index 100% rename from java/src/test/prompts/PROMPT-smoke-test.md rename to java/sdk/src/test/prompts/PROMPT-smoke-test.md diff --git a/java/src/test/resources/logging-debug.properties b/java/sdk/src/test/resources/logging-debug.properties similarity index 100% rename from java/src/test/resources/logging-debug.properties rename to java/sdk/src/test/resources/logging-debug.properties diff --git a/java/src/test/resources/logging.properties b/java/sdk/src/test/resources/logging.properties similarity index 100% rename from java/src/test/resources/logging.properties rename to java/sdk/src/test/resources/logging.properties diff --git a/java/src/generated/java/com/github/copilot/generated/AbortReason.java b/java/src/generated/java/com/github/copilot/generated/AbortReason.java deleted file mode 100644 index 2ffbdb8d8..000000000 --- a/java/src/generated/java/com/github/copilot/generated/AbortReason.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * Finite reason code describing why the current turn was aborted - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum AbortReason { - /** The {@code user_initiated} variant. */ - USER_INITIATED("user_initiated"), - /** The {@code remote_command} variant. */ - REMOTE_COMMAND("remote_command"), - /** The {@code user_abort} variant. */ - USER_ABORT("user_abort"); - - private final String value; - AbortReason(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static AbortReason fromValue(String value) { - for (AbortReason v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown AbortReason value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java b/java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java deleted file mode 100644 index de966758c..000000000 --- a/java/src/generated/java/com/github/copilot/generated/AssistantMessageEvent.java +++ /dev/null @@ -1,73 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Session event "assistant.message". Assistant response containing text content, optional tool requests, and interaction metadata - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class AssistantMessageEvent extends SessionEvent { - - @Override - public String getType() { return "assistant.message"; } - - @JsonProperty("data") - private AssistantMessageEventData data; - - public AssistantMessageEventData getData() { return data; } - public void setData(AssistantMessageEventData data) { this.data = data; } - - /** Data payload for {@link AssistantMessageEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record AssistantMessageEventData( - /** Unique identifier for this assistant message */ - @JsonProperty("messageId") String messageId, - /** Model that produced this assistant message, if known */ - @JsonProperty("model") String model, - /** The assistant's text response content */ - @JsonProperty("content") String content, - /** Tool invocations requested by the assistant in this message */ - @JsonProperty("toolRequests") List toolRequests, - /** Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume. */ - @JsonProperty("reasoningOpaque") String reasoningOpaque, - /** Readable reasoning text from the model's extended thinking */ - @JsonProperty("reasoningText") String reasoningText, - /** Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. */ - @JsonProperty("encryptedContent") String encryptedContent, - /** Generation phase for phased-output models (e.g., thinking vs. response phases) */ - @JsonProperty("phase") String phase, - /** Actual output token count from the API response (completion_tokens), used for accurate token accounting */ - @JsonProperty("outputTokens") Long outputTokens, - /** CAPI interaction ID for correlating this message with upstream telemetry */ - @JsonProperty("interactionId") String interactionId, - /** GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs */ - @JsonProperty("requestId") String requestId, - /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ - @JsonProperty("serviceRequestId") String serviceRequestId, - /** Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping */ - @JsonProperty("anthropicAdvisorBlocks") List anthropicAdvisorBlocks, - /** Anthropic advisor model ID used for this response, for timeline display on replay */ - @JsonProperty("anthropicAdvisorModel") String anthropicAdvisorModel, - /** Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event */ - @JsonProperty("turnId") String turnId, - /** Tool call ID of the parent tool invocation when this event originates from a sub-agent */ - @JsonProperty("parentToolCallId") String parentToolCallId - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java b/java/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java deleted file mode 100644 index 2c19c150b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/AssistantUsageEvent.java +++ /dev/null @@ -1,79 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.Map; -import javax.annotation.processing.Generated; - -/** - * Session event "assistant.usage". LLM API call usage metrics including tokens, costs, quotas, and billing information - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class AssistantUsageEvent extends SessionEvent { - - @Override - public String getType() { return "assistant.usage"; } - - @JsonProperty("data") - private AssistantUsageEventData data; - - public AssistantUsageEventData getData() { return data; } - public void setData(AssistantUsageEventData data) { this.data = data; } - - /** Data payload for {@link AssistantUsageEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record AssistantUsageEventData( - /** Model identifier used for this API call */ - @JsonProperty("model") String model, - /** Number of input tokens consumed */ - @JsonProperty("inputTokens") Long inputTokens, - /** Number of output tokens produced */ - @JsonProperty("outputTokens") Long outputTokens, - /** Number of tokens read from prompt cache */ - @JsonProperty("cacheReadTokens") Long cacheReadTokens, - /** Number of tokens written to prompt cache */ - @JsonProperty("cacheWriteTokens") Long cacheWriteTokens, - /** Number of output tokens used for reasoning (e.g., chain-of-thought) */ - @JsonProperty("reasoningTokens") Long reasoningTokens, - /** Model multiplier cost for billing purposes */ - @JsonProperty("cost") Double cost, - /** Duration of the API call in milliseconds */ - @JsonProperty("duration") Long duration, - /** Time to first token in milliseconds. Only available for streaming requests */ - @JsonProperty("timeToFirstTokenMs") Long timeToFirstTokenMs, - /** Average inter-token latency in milliseconds. Only available for streaming requests */ - @JsonProperty("interTokenLatencyMs") Double interTokenLatencyMs, - /** What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ - @JsonProperty("initiator") String initiator, - /** Completion ID from the model provider (e.g., chatcmpl-abc123) */ - @JsonProperty("apiCallId") String apiCallId, - /** GitHub request tracing ID (x-github-request-id header) for server-side log correlation */ - @JsonProperty("providerCallId") String providerCallId, - /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ - @JsonProperty("serviceRequestId") String serviceRequestId, - /** API endpoint used for this model call, matching CAPI supported_endpoints vocabulary */ - @JsonProperty("apiEndpoint") AssistantUsageApiEndpoint apiEndpoint, - /** Parent tool call ID when this usage originates from a sub-agent */ - @JsonProperty("parentToolCallId") String parentToolCallId, - /** Per-quota resource usage snapshots, keyed by quota identifier */ - @JsonProperty("quotaSnapshots") Map quotaSnapshots, - /** Per-request cost and usage data from the CAPI copilot_usage response field */ - @JsonProperty("copilotUsage") AssistantUsageCopilotUsage copilotUsage, - /** Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ - @JsonProperty("reasoningEffort") String reasoningEffort - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java b/java/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java deleted file mode 100644 index 167f42040..000000000 --- a/java/src/generated/java/com/github/copilot/generated/AssistantUsageQuotaSnapshot.java +++ /dev/null @@ -1,42 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.time.OffsetDateTime; -import javax.annotation.processing.Generated; - -/** - * Schema for the `AssistantUsageQuotaSnapshot` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record AssistantUsageQuotaSnapshot( - /** Whether the user has an unlimited usage entitlement */ - @JsonProperty("isUnlimitedEntitlement") Boolean isUnlimitedEntitlement, - /** Total requests allowed by the entitlement */ - @JsonProperty("entitlementRequests") Long entitlementRequests, - /** Number of requests already consumed */ - @JsonProperty("usedRequests") Long usedRequests, - /** Whether usage is still permitted after quota exhaustion */ - @JsonProperty("usageAllowedWithExhaustedQuota") Boolean usageAllowedWithExhaustedQuota, - /** Number of additional usage requests made this period */ - @JsonProperty("overage") Double overage, - /** Whether additional usage is allowed when quota is exhausted */ - @JsonProperty("overageAllowedWithExhaustedQuota") Boolean overageAllowedWithExhaustedQuota, - /** Percentage of quota remaining (0 to 100) */ - @JsonProperty("remainingPercentage") Double remainingPercentage, - /** Date when the quota resets */ - @JsonProperty("resetDate") OffsetDateTime resetDate -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/CanvasOpenedAvailability.java b/java/src/generated/java/com/github/copilot/generated/CanvasOpenedAvailability.java deleted file mode 100644 index 1e65c1a2d..000000000 --- a/java/src/generated/java/com/github/copilot/generated/CanvasOpenedAvailability.java +++ /dev/null @@ -1,35 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum CanvasOpenedAvailability { - /** The {@code ready} variant. */ - READY("ready"), - /** The {@code stale} variant. */ - STALE("stale"); - - private final String value; - CanvasOpenedAvailability(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static CanvasOpenedAvailability fromValue(String value) { - for (CanvasOpenedAvailability v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown CanvasOpenedAvailability value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java b/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java deleted file mode 100644 index c384afcf0..000000000 --- a/java/src/generated/java/com/github/copilot/generated/McpOauthRequiredEvent.java +++ /dev/null @@ -1,48 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Session event "mcp.oauth_required". OAuth authentication request for an MCP server - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class McpOauthRequiredEvent extends SessionEvent { - - @Override - public String getType() { return "mcp.oauth_required"; } - - @JsonProperty("data") - private McpOauthRequiredEventData data; - - public McpOauthRequiredEventData getData() { return data; } - public void setData(McpOauthRequiredEventData data) { this.data = data; } - - /** Data payload for {@link McpOauthRequiredEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record McpOauthRequiredEventData( - /** Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth() */ - @JsonProperty("requestId") String requestId, - /** Display name of the MCP server that requires OAuth */ - @JsonProperty("serverName") String serverName, - /** URL of the MCP server that requires OAuth */ - @JsonProperty("serverUrl") String serverUrl, - /** Static OAuth client configuration, if the server specifies one */ - @JsonProperty("staticClientConfig") McpOauthRequiredStaticClientConfig staticClientConfig - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/McpServerStatus.java b/java/src/generated/java/com/github/copilot/generated/McpServerStatus.java deleted file mode 100644 index b5bb08093..000000000 --- a/java/src/generated/java/com/github/copilot/generated/McpServerStatus.java +++ /dev/null @@ -1,43 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum McpServerStatus { - /** The {@code connected} variant. */ - CONNECTED("connected"), - /** The {@code failed} variant. */ - FAILED("failed"), - /** The {@code needs-auth} variant. */ - NEEDS_AUTH("needs-auth"), - /** The {@code pending} variant. */ - PENDING("pending"), - /** The {@code disabled} variant. */ - DISABLED("disabled"), - /** The {@code not_configured} variant. */ - NOT_CONFIGURED("not_configured"); - - private final String value; - McpServerStatus(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static McpServerStatus fromValue(String value) { - for (McpServerStatus v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown McpServerStatus value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/McpServerStatusChangedStatus.java b/java/src/generated/java/com/github/copilot/generated/McpServerStatusChangedStatus.java deleted file mode 100644 index cc11c8cab..000000000 --- a/java/src/generated/java/com/github/copilot/generated/McpServerStatusChangedStatus.java +++ /dev/null @@ -1,43 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * New connection status: connected, failed, needs-auth, pending, disabled, or not_configured - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum McpServerStatusChangedStatus { - /** The {@code connected} variant. */ - CONNECTED("connected"), - /** The {@code failed} variant. */ - FAILED("failed"), - /** The {@code needs-auth} variant. */ - NEEDS_AUTH("needs-auth"), - /** The {@code pending} variant. */ - PENDING("pending"), - /** The {@code disabled} variant. */ - DISABLED("disabled"), - /** The {@code not_configured} variant. */ - NOT_CONFIGURED("not_configured"); - - private final String value; - McpServerStatusChangedStatus(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static McpServerStatusChangedStatus fromValue(String value) { - for (McpServerStatusChangedStatus v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown McpServerStatusChangedStatus value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServerStatus.java b/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServerStatus.java deleted file mode 100644 index af3c97840..000000000 --- a/java/src/generated/java/com/github/copilot/generated/McpServersLoadedServerStatus.java +++ /dev/null @@ -1,43 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum McpServersLoadedServerStatus { - /** The {@code connected} variant. */ - CONNECTED("connected"), - /** The {@code failed} variant. */ - FAILED("failed"), - /** The {@code needs-auth} variant. */ - NEEDS_AUTH("needs-auth"), - /** The {@code pending} variant. */ - PENDING("pending"), - /** The {@code disabled} variant. */ - DISABLED("disabled"), - /** The {@code not_configured} variant. */ - NOT_CONFIGURED("not_configured"); - - private final String value; - McpServersLoadedServerStatus(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static McpServersLoadedServerStatus fromValue(String value) { - for (McpServersLoadedServerStatus v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown McpServersLoadedServerStatus value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java b/java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java deleted file mode 100644 index 8a516065b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/ModelCallFailureEvent.java +++ /dev/null @@ -1,58 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Session event "model.call_failure". Failed LLM API call metadata for telemetry - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ModelCallFailureEvent extends SessionEvent { - - @Override - public String getType() { return "model.call_failure"; } - - @JsonProperty("data") - private ModelCallFailureEventData data; - - public ModelCallFailureEventData getData() { return data; } - public void setData(ModelCallFailureEventData data) { this.data = data; } - - /** Data payload for {@link ModelCallFailureEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record ModelCallFailureEventData( - /** Model identifier used for the failed API call */ - @JsonProperty("model") String model, - /** What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ - @JsonProperty("initiator") String initiator, - /** Completion ID from the model provider (e.g., chatcmpl-abc123) */ - @JsonProperty("apiCallId") String apiCallId, - /** GitHub request tracing ID (x-github-request-id header) for server-side log correlation */ - @JsonProperty("providerCallId") String providerCallId, - /** Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ - @JsonProperty("serviceRequestId") String serviceRequestId, - /** HTTP status code from the failed request */ - @JsonProperty("statusCode") Long statusCode, - /** Duration of the failed API call in milliseconds */ - @JsonProperty("durationMs") Long durationMs, - /** Where the failed model call originated */ - @JsonProperty("source") ModelCallFailureSource source, - /** Raw provider/runtime error message for restricted telemetry */ - @JsonProperty("errorMessage") String errorMessage - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedKind.java b/java/src/generated/java/com/github/copilot/generated/PermissionCompletedKind.java deleted file mode 100644 index 61c770b65..000000000 --- a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedKind.java +++ /dev/null @@ -1,47 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import javax.annotation.processing.Generated; - -/** - * The outcome of the permission request - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum PermissionCompletedKind { - /** The {@code approved} variant. */ - APPROVED("approved"), - /** The {@code approved-for-session} variant. */ - APPROVED_FOR_SESSION("approved-for-session"), - /** The {@code approved-for-location} variant. */ - APPROVED_FOR_LOCATION("approved-for-location"), - /** The {@code denied-by-rules} variant. */ - DENIED_BY_RULES("denied-by-rules"), - /** The {@code denied-no-approval-rule-and-could-not-request-from-user} variant. */ - DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER("denied-no-approval-rule-and-could-not-request-from-user"), - /** The {@code denied-interactively-by-user} variant. */ - DENIED_INTERACTIVELY_BY_USER("denied-interactively-by-user"), - /** The {@code denied-by-content-exclusion-policy} variant. */ - DENIED_BY_CONTENT_EXCLUSION_POLICY("denied-by-content-exclusion-policy"), - /** The {@code denied-by-permission-request-hook} variant. */ - DENIED_BY_PERMISSION_REQUEST_HOOK("denied-by-permission-request-hook"); - - private final String value; - PermissionCompletedKind(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static PermissionCompletedKind fromValue(String value) { - for (PermissionCompletedKind v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown PermissionCompletedKind value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedResult.java b/java/src/generated/java/com/github/copilot/generated/PermissionCompletedResult.java deleted file mode 100644 index 1beb80523..000000000 --- a/java/src/generated/java/com/github/copilot/generated/PermissionCompletedResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * The result of the permission request - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record PermissionCompletedResult( - /** The outcome of the permission request */ - @JsonProperty("kind") PermissionCompletedKind kind -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java b/java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java deleted file mode 100644 index e0d8785b9..000000000 --- a/java/src/generated/java/com/github/copilot/generated/SessionModelChangeEvent.java +++ /dev/null @@ -1,75 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Session event "session.model_change". Model change details including previous and new model identifiers - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionModelChangeEvent extends SessionEvent { - - @Override - public String getType() { return "session.model_change"; } - - @JsonProperty("data") - private SessionModelChangeEventData data; - - public SessionModelChangeEventData getData() { return data; } - public void setData(SessionModelChangeEventData data) { this.data = data; } - - /** Data payload for {@link SessionModelChangeEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record SessionModelChangeEventData( - /** Model that was previously selected, if any */ - @JsonProperty("previousModel") String previousModel, - /** Newly selected model identifier */ - @JsonProperty("newModel") String newModel, - /** Reasoning effort level before the model change, if applicable */ - @JsonProperty("previousReasoningEffort") String previousReasoningEffort, - /** Reasoning effort level after the model change, if applicable */ - @JsonProperty("reasoningEffort") String reasoningEffort, - /** Reasoning summary mode before the model change, if applicable */ - @JsonProperty("previousReasoningSummary") ReasoningSummary previousReasoningSummary, - /** Reasoning summary mode after the model change, if applicable */ - @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, - /** Context tier after the model change; null explicitly clears a previously selected tier */ - @JsonProperty("contextTier") SessionModelChangeEventDataContextTier contextTier, - /** 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. */ - @JsonProperty("cause") String cause - ) { - - public enum SessionModelChangeEventDataContextTier { - /** The {@code default} variant. */ - DEFAULT("default"), - /** The {@code long_context} variant. */ - LONG_CONTEXT("long_context"); - - private final String value; - SessionModelChangeEventDataContextTier(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static SessionModelChangeEventDataContextTier fromValue(String value) { - for (SessionModelChangeEventDataContextTier v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown SessionModelChangeEventDataContextTier value: " + value); - } - } - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java b/java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java deleted file mode 100644 index e27cc2045..000000000 --- a/java/src/generated/java/com/github/copilot/generated/SessionResumeEvent.java +++ /dev/null @@ -1,61 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.time.OffsetDateTime; -import javax.annotation.processing.Generated; - -/** - * Session event "session.resume". Session resume metadata including current context and event count - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionResumeEvent extends SessionEvent { - - @Override - public String getType() { return "session.resume"; } - - @JsonProperty("data") - private SessionResumeEventData data; - - public SessionResumeEventData getData() { return data; } - public void setData(SessionResumeEventData data) { this.data = data; } - - /** Data payload for {@link SessionResumeEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record SessionResumeEventData( - /** ISO 8601 timestamp when the session was resumed */ - @JsonProperty("resumeTime") OffsetDateTime resumeTime, - /** Total number of persisted events in the session at the time of resume */ - @JsonProperty("eventCount") Long eventCount, - /** Model currently selected at resume time */ - @JsonProperty("selectedModel") String selectedModel, - /** Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ - @JsonProperty("reasoningEffort") String reasoningEffort, - /** Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed") */ - @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, - /** Updated working directory and git context at resume time */ - @JsonProperty("context") WorkingDirectoryContext context, - /** Whether the session was already in use by another client at resume time */ - @JsonProperty("alreadyInUse") Boolean alreadyInUse, - /** 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. */ - @JsonProperty("sessionWasActive") Boolean sessionWasActive, - /** Whether this session supports remote steering via GitHub */ - @JsonProperty("remoteSteerable") Boolean remoteSteerable, - /** 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. */ - @JsonProperty("continuePendingWork") Boolean continuePendingWork - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java b/java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java deleted file mode 100644 index 2a9cbdeb4..000000000 --- a/java/src/generated/java/com/github/copilot/generated/SessionScheduleCreatedEvent.java +++ /dev/null @@ -1,50 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Session event "session.schedule_created". Scheduled prompt registered via /every or /after - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionScheduleCreatedEvent extends SessionEvent { - - @Override - public String getType() { return "session.schedule_created"; } - - @JsonProperty("data") - private SessionScheduleCreatedEventData data; - - public SessionScheduleCreatedEventData getData() { return data; } - public void setData(SessionScheduleCreatedEventData data) { this.data = data; } - - /** Data payload for {@link SessionScheduleCreatedEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record SessionScheduleCreatedEventData( - /** Sequential id assigned to the scheduled prompt within the session */ - @JsonProperty("id") Long id, - /** Interval between ticks in milliseconds */ - @JsonProperty("intervalMs") Long intervalMs, - /** Prompt text that gets enqueued on every tick */ - @JsonProperty("prompt") String prompt, - /** Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`) */ - @JsonProperty("recurring") Boolean recurring, - /** Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion) */ - @JsonProperty("displayPrompt") String displayPrompt - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java b/java/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java deleted file mode 100644 index 097f59c97..000000000 --- a/java/src/generated/java/com/github/copilot/generated/SessionTaskCompleteEvent.java +++ /dev/null @@ -1,44 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Session event "session.task_complete". Task completion notification with summary from the agent - * - * @since 1.0.0 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionTaskCompleteEvent extends SessionEvent { - - @Override - public String getType() { return "session.task_complete"; } - - @JsonProperty("data") - private SessionTaskCompleteEventData data; - - public SessionTaskCompleteEventData getData() { return data; } - public void setData(SessionTaskCompleteEventData data) { this.data = data; } - - /** Data payload for {@link SessionTaskCompleteEvent}. */ - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_NULL) - public record SessionTaskCompleteEventData( - /** Summary of the completed task, provided by the agent */ - @JsonProperty("summary") String summary, - /** Whether the tool call succeeded. False when validation failed (e.g., invalid arguments) */ - @JsonProperty("success") Boolean success - ) { - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java b/java/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java deleted file mode 100644 index 07ce97825..000000000 --- a/java/src/generated/java/com/github/copilot/generated/SkillsLoadedSkill.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `SkillsLoadedSkill` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SkillsLoadedSkill( - /** Unique identifier for the skill */ - @JsonProperty("name") String name, - /** Description of what the skill does */ - @JsonProperty("description") String description, - /** Source location type (e.g., project, personal-copilot, plugin, builtin) */ - @JsonProperty("source") SkillSource source, - /** Whether the skill can be invoked by the user as a slash command */ - @JsonProperty("userInvocable") Boolean userInvocable, - /** Whether the skill is currently enabled */ - @JsonProperty("enabled") Boolean enabled, - /** Absolute path to the skill file, if available */ - @JsonProperty("path") String path -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java b/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java deleted file mode 100644 index 4ff3d2de0..000000000 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteResult.java +++ /dev/null @@ -1,34 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Tool execution result on success - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ToolExecutionCompleteResult( - /** Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency */ - @JsonProperty("content") String content, - /** Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent. */ - @JsonProperty("detailedContent") String detailedContent, - /** Structured content blocks (text, images, audio, resources) returned by the tool in their native format */ - @JsonProperty("contents") List contents, - /** MCP Apps UI resource content for rendering in a sandboxed iframe */ - @JsonProperty("uiResource") ToolExecutionCompleteUIResource uiResource -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java b/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java deleted file mode 100644 index 3b9548a8c..000000000 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUI.java +++ /dev/null @@ -1,31 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ToolExecutionCompleteUIResourceMetaUI( - /** Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. */ - @JsonProperty("csp") ToolExecutionCompleteUIResourceMetaUICsp csp, - /** Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. */ - @JsonProperty("permissions") ToolExecutionCompleteUIResourceMetaUIPermissions permissions, - @JsonProperty("domain") String domain, - @JsonProperty("prefersBorder") Boolean prefersBorder -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java b/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java deleted file mode 100644 index 8b1fc5dc9..000000000 --- a/java/src/generated/java/com/github/copilot/generated/ToolExecutionCompleteUIResourceMetaUIPermissions.java +++ /dev/null @@ -1,33 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: session-events.schema.json - -package com.github.copilot.generated; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ToolExecutionCompleteUIResourceMetaUIPermissions( - /** Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. */ - @JsonProperty("camera") ToolExecutionCompleteUIResourceMetaUIPermissionsCamera camera, - /** Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. */ - @JsonProperty("microphone") ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone microphone, - /** Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. */ - @JsonProperty("geolocation") ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation geolocation, - /** Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. */ - @JsonProperty("clipboardWrite") ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite clipboardWrite -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java b/java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java deleted file mode 100644 index a48640077..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AbortReason.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Finite reason code describing why the current turn was aborted - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum AbortReason { - /** The {@code user_initiated} variant. */ - USER_INITIATED("user_initiated"), - /** The {@code remote_command} variant. */ - REMOTE_COMMAND("remote_command"), - /** The {@code user_abort} variant. */ - USER_ABORT("user_abort"); - - private final String value; - AbortReason(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static AbortReason fromValue(String value) { - for (AbortReason v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown AbortReason value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java b/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java deleted file mode 100644 index ce8089373..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/AgentInfo.java +++ /dev/null @@ -1,49 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import java.util.Map; -import javax.annotation.processing.Generated; - -/** - * Schema for the `AgentInfo` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record AgentInfo( - /** Unique identifier of the custom agent */ - @JsonProperty("name") String name, - /** Human-readable display name */ - @JsonProperty("displayName") String displayName, - /** Description of the agent's purpose */ - @JsonProperty("description") String description, - /** Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. */ - @JsonProperty("path") String path, - /** Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. */ - @JsonProperty("id") String id, - /** Where the agent definition was loaded from */ - @JsonProperty("source") AgentInfoSource source, - /** Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. */ - @JsonProperty("userInvocable") Boolean userInvocable, - /** Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. */ - @JsonProperty("tools") List tools, - /** Preferred model id for this agent. When omitted, inherits the outer agent's model. */ - @JsonProperty("model") String model, - /** MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. */ - @JsonProperty("mcpServers") Map mcpServers, - /** Skill names preloaded into this agent's context. Omitted means none. */ - @JsonProperty("skills") List skills -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInstanceAvailability.java b/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInstanceAvailability.java deleted file mode 100644 index aef2d8126..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInstanceAvailability.java +++ /dev/null @@ -1,35 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Runtime-controlled routing state for an open canvas instance. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum CanvasInstanceAvailability { - /** The {@code ready} variant. */ - READY("ready"), - /** The {@code stale} variant. */ - STALE("stale"); - - private final String value; - CanvasInstanceAvailability(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static CanvasInstanceAvailability fromValue(String value) { - for (CanvasInstanceAvailability v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown CanvasInstanceAvailability value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInvokeActionParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInvokeActionParams.java deleted file mode 100644 index 8843a3bf0..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/CanvasInvokeActionParams.java +++ /dev/null @@ -1,41 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Canvas action invocation parameters sent to the provider. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record CanvasInvokeActionParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Owning provider identifier */ - @JsonProperty("extensionId") String extensionId, - /** Provider-local canvas identifier */ - @JsonProperty("canvasId") String canvasId, - /** Canvas instance identifier */ - @JsonProperty("instanceId") String instanceId, - /** Action name to invoke */ - @JsonProperty("actionName") String actionName, - /** Action input */ - @JsonProperty("input") Object input, - /** Host context supplied by the runtime. */ - @JsonProperty("host") CanvasHostContext host, - /** Session context supplied by the runtime. */ - @JsonProperty("session") CanvasSessionContext session -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java deleted file mode 100644 index 590dd0147..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ConnectParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Optional connection token presented by the SDK client during the handshake. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ConnectParams( - /** Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN */ - @JsonProperty("token") String token -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerSource.java b/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerSource.java deleted file mode 100644 index 89d7322fb..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/DiscoveredMcpServerSource.java +++ /dev/null @@ -1,39 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Configuration source - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum DiscoveredMcpServerSource { - /** The {@code user} variant. */ - USER("user"), - /** The {@code workspace} variant. */ - WORKSPACE("workspace"), - /** The {@code plugin} variant. */ - PLUGIN("plugin"), - /** The {@code builtin} variant. */ - BUILTIN("builtin"); - - private final String value; - DiscoveredMcpServerSource(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static DiscoveredMcpServerSource fromValue(String value) { - for (DiscoveredMcpServerSource v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown DiscoveredMcpServerSource value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java b/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java deleted file mode 100644 index c274dfb1a..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstalledPlugin.java +++ /dev/null @@ -1,39 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `InstalledPlugin` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record InstalledPlugin( - /** Plugin name */ - @JsonProperty("name") String name, - /** Marketplace the plugin came from (empty string for direct repo installs) */ - @JsonProperty("marketplace") String marketplace, - /** Version installed (if available) */ - @JsonProperty("version") String version, - /** Installation timestamp */ - @JsonProperty("installed_at") String installedAt, - /** Whether the plugin is currently enabled */ - @JsonProperty("enabled") Boolean enabled, - /** Path where the plugin is cached locally */ - @JsonProperty("cache_path") String cachePath, - /** Source for direct repo installs (when marketplace is empty) */ - @JsonProperty("source") Object source -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSources.java b/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSources.java deleted file mode 100644 index 9e6a458d4..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSources.java +++ /dev/null @@ -1,44 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Schema for the `InstructionsSources` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record InstructionsSources( - /** Unique identifier for this source (used for toggling) */ - @JsonProperty("id") String id, - /** Human-readable label */ - @JsonProperty("label") String label, - /** File path relative to repo or absolute for home */ - @JsonProperty("sourcePath") String sourcePath, - /** Raw content of the instruction file */ - @JsonProperty("content") String content, - /** Category of instruction source — used for merge logic */ - @JsonProperty("type") InstructionsSourcesType type, - /** Where this source lives — used for UI grouping */ - @JsonProperty("location") InstructionsSourcesLocation location, - /** Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files */ - @JsonProperty("applyTo") List applyTo, - /** Short description (body after frontmatter) for use in instruction tables */ - @JsonProperty("description") String description, - /** When true, this source starts disabled and must be toggled on by the user */ - @JsonProperty("defaultDisabled") Boolean defaultDisabled -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesLocation.java b/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesLocation.java deleted file mode 100644 index 23db5a367..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesLocation.java +++ /dev/null @@ -1,39 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Where this source lives — used for UI grouping - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum InstructionsSourcesLocation { - /** The {@code user} variant. */ - USER("user"), - /** The {@code repository} variant. */ - REPOSITORY("repository"), - /** The {@code working-directory} variant. */ - WORKING_DIRECTORY("working-directory"), - /** The {@code plugin} variant. */ - PLUGIN("plugin"); - - private final String value; - InstructionsSourcesLocation(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static InstructionsSourcesLocation fromValue(String value) { - for (InstructionsSourcesLocation v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown InstructionsSourcesLocation value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesType.java b/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesType.java deleted file mode 100644 index 6fed6c4bf..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/InstructionsSourcesType.java +++ /dev/null @@ -1,45 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Category of instruction source — used for merge logic - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum InstructionsSourcesType { - /** The {@code home} variant. */ - HOME("home"), - /** The {@code repo} variant. */ - REPO("repo"), - /** The {@code model} variant. */ - MODEL("model"), - /** The {@code vscode} variant. */ - VSCODE("vscode"), - /** The {@code nested-agents} variant. */ - NESTED_AGENTS("nested-agents"), - /** The {@code child-instructions} variant. */ - CHILD_INSTRUCTIONS("child-instructions"), - /** The {@code plugin} variant. */ - PLUGIN("plugin"); - - private final String value; - InstructionsSourcesType(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static InstructionsSourcesType fromValue(String value) { - for (InstructionsSourcesType v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown InstructionsSourcesType value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpServer.java b/java/src/generated/java/com/github/copilot/generated/rpc/McpServer.java deleted file mode 100644 index 7da05f659..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpServer.java +++ /dev/null @@ -1,33 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `McpServer` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record McpServer( - /** Server name (config key) */ - @JsonProperty("name") String name, - /** Connection status: connected, failed, needs-auth, pending, disabled, or not_configured */ - @JsonProperty("status") McpServerStatus status, - /** Configuration source: user, workspace, plugin, or builtin */ - @JsonProperty("source") McpServerSource source, - /** Error message if the server failed to connect */ - @JsonProperty("error") String error -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java b/java/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java deleted file mode 100644 index db463a737..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/McpServerStatus.java +++ /dev/null @@ -1,43 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import javax.annotation.processing.Generated; - -/** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public enum McpServerStatus { - /** The {@code connected} variant. */ - CONNECTED("connected"), - /** The {@code failed} variant. */ - FAILED("failed"), - /** The {@code needs-auth} variant. */ - NEEDS_AUTH("needs-auth"), - /** The {@code pending} variant. */ - PENDING("pending"), - /** The {@code disabled} variant. */ - DISABLED("disabled"), - /** The {@code not_configured} variant. */ - NOT_CONFIGURED("not_configured"); - - private final String value; - McpServerStatus(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static McpServerStatus fromValue(String value) { - for (McpServerStatus v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown McpServerStatus value: " + value); - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java b/java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java deleted file mode 100644 index 94a8188f1..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBilling.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Billing information - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ModelBilling( - /** Billing cost multiplier relative to the base rate */ - @JsonProperty("multiplier") Double multiplier, - /** Token-level pricing information for this model */ - @JsonProperty("tokenPrices") ModelBillingTokenPrices tokenPrices -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java b/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java deleted file mode 100644 index 756ccaa02..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPrices.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Token-level pricing information for this model - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ModelBillingTokenPrices( - /** AI Credits cost per billing batch of input tokens */ - @JsonProperty("inputPrice") Double inputPrice, - /** AI Credits cost per billing batch of output tokens */ - @JsonProperty("outputPrice") Double outputPrice, - /** AI Credits cost per billing batch of cached tokens */ - @JsonProperty("cachePrice") Double cachePrice, - /** Number of tokens per standard billing batch */ - @JsonProperty("batchSize") Long batchSize, - /** Maximum context window tokens for the default tier */ - @JsonProperty("contextMax") Long contextMax, - /** Long context tier pricing (available for models with extended context windows) */ - @JsonProperty("longContext") ModelBillingTokenPricesLongContext longContext -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java b/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java deleted file mode 100644 index 983742c19..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ModelBillingTokenPricesLongContext.java +++ /dev/null @@ -1,33 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Long context tier pricing (available for models with extended context windows) - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ModelBillingTokenPricesLongContext( - /** AI Credits cost per billing batch of input tokens */ - @JsonProperty("inputPrice") Double inputPrice, - /** AI Credits cost per billing batch of output tokens */ - @JsonProperty("outputPrice") Double outputPrice, - /** AI Credits cost per billing batch of cached tokens */ - @JsonProperty("cachePrice") Double cachePrice, - /** Maximum context window tokens for the long context tier */ - @JsonProperty("contextMax") Long contextMax -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java b/java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java deleted file mode 100644 index bfbc87f46..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/QueuePendingItems.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `QueuePendingItems` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record QueuePendingItems( - /** Whether this item is a queued user message or a queued slash command / model change */ - @JsonProperty("kind") QueuePendingItemsKind kind, - /** Human-readable text to display for this queue entry in the UI */ - @JsonProperty("displayText") String displayText -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java b/java/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java deleted file mode 100644 index 67e7571a1..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/RpcCaller.java +++ /dev/null @@ -1,38 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * Interface for invoking JSON-RPC methods with typed responses. - *

    - * Implementations delegate to the underlying transport layer - * (e.g., a {@code JsonRpcClient} instance). A method reference is typically the clearest - * way to adapt a generic {@code invoke} method to this interface: - * 

    {@code
- * RpcCaller caller = jsonRpcClient::invoke;
- * }
    - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public interface RpcCaller { - - /** - * Invokes a JSON-RPC method and returns a future for the typed response. - * - * @param the expected response type - * @param method the JSON-RPC method name - * @param params the request parameters (may be a {@code Map}, DTO record, or {@code JsonNode}) - * @param resultType the {@link Class} of the expected response type - * @return a {@link CompletableFuture} that completes with the deserialized result - */ - CompletableFuture invoke(String method, Object params, Class resultType); -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java b/java/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java deleted file mode 100644 index fb41975bd..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ScheduleEntry.java +++ /dev/null @@ -1,38 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.time.OffsetDateTime; -import javax.annotation.processing.Generated; - -/** - * Schema for the `ScheduleEntry` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record ScheduleEntry( - /** Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). */ - @JsonProperty("id") Long id, - /** Interval between scheduled ticks, in milliseconds. */ - @JsonProperty("intervalMs") Long intervalMs, - /** Prompt text that gets enqueued on every tick. */ - @JsonProperty("prompt") String prompt, - /** Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). */ - @JsonProperty("recurring") Boolean recurring, - /** Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. */ - @JsonProperty("displayPrompt") String displayPrompt, - /** ISO 8601 timestamp when the next tick is scheduled to fire. */ - @JsonProperty("nextRunAt") OffsetDateTime nextRunAt -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java deleted file mode 100644 index d3bd44460..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerAccountApi.java +++ /dev/null @@ -1,36 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code account} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerAccountApi { - - private final RpcCaller caller; - - /** @param caller the RPC transport function */ - ServerAccountApi(RpcCaller caller) { - this.caller = caller; - } - - /** - * Optional GitHub token used to look up quota for a specific user instead of the global auth context. - * @since 1.0.0 - */ - public CompletableFuture getQuota() { - return caller.invoke("account.getQuota", java.util.Map.of(), AccountGetQuotaResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java deleted file mode 100644 index 6f0a2105d..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerMcpConfigApi.java +++ /dev/null @@ -1,76 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code mcp.config} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerMcpConfigApi { - - private final RpcCaller caller; - - /** @param caller the RPC transport function */ - ServerMcpConfigApi(RpcCaller caller) { - this.caller = caller; - } - - /** - * User-configured MCP servers, keyed by server name. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("mcp.config.list", java.util.Map.of(), McpConfigListResult.class); - } - - /** - * MCP server name and configuration to add to user configuration. - * @since 1.0.0 - */ - public CompletableFuture add(McpConfigAddParams params) { - return caller.invoke("mcp.config.add", params, Void.class); - } - - /** - * MCP server name and replacement configuration to write to user configuration. - * @since 1.0.0 - */ - public CompletableFuture update(McpConfigUpdateParams params) { - return caller.invoke("mcp.config.update", params, Void.class); - } - - /** - * MCP server name to remove from user configuration. - * @since 1.0.0 - */ - public CompletableFuture remove(McpConfigRemoveParams params) { - return caller.invoke("mcp.config.remove", params, Void.class); - } - - /** - * MCP server names to enable for new sessions. - * @since 1.0.0 - */ - public CompletableFuture enable(McpConfigEnableParams params) { - return caller.invoke("mcp.config.enable", params, Void.class); - } - - /** - * MCP server names to disable for new sessions. - * @since 1.0.0 - */ - public CompletableFuture disable(McpConfigDisableParams params) { - return caller.invoke("mcp.config.disable", params, Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java deleted file mode 100644 index c0515a06f..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerModelsApi.java +++ /dev/null @@ -1,36 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code models} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerModelsApi { - - private final RpcCaller caller; - - /** @param caller the RPC transport function */ - ServerModelsApi(RpcCaller caller) { - this.caller = caller; - } - - /** - * Optional GitHub token used to list models for a specific user instead of the global auth context. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("models.list", java.util.Map.of(), ModelsListResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java deleted file mode 100644 index 8d9767658..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerRpc.java +++ /dev/null @@ -1,80 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * Typed client for server-level RPC methods. - *

    - * Provides strongly-typed access to all server-level API namespaces. - *

    - * Obtain an instance by calling {@code new ServerRpc(caller)}. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerRpc { - - private final RpcCaller caller; - - /** API methods for the {@code models} namespace. */ - public final ServerModelsApi models; - /** API methods for the {@code tools} namespace. */ - public final ServerToolsApi tools; - /** API methods for the {@code account} namespace. */ - public final ServerAccountApi account; - /** API methods for the {@code secrets} namespace. */ - public final ServerSecretsApi secrets; - /** API methods for the {@code mcp} namespace. */ - public final ServerMcpApi mcp; - /** API methods for the {@code skills} namespace. */ - public final ServerSkillsApi skills; - /** API methods for the {@code sessionFs} namespace. */ - public final ServerSessionFsApi sessionFs; - /** API methods for the {@code sessions} namespace. */ - public final ServerSessionsApi sessions; - /** API methods for the {@code agentRegistry} namespace. */ - public final ServerAgentRegistryApi agentRegistry; - - /** - * Creates a new server RPC client. - * - * @param caller the RPC transport function (e.g., {@code jsonRpcClient::invoke}) - */ - public ServerRpc(RpcCaller caller) { - this.caller = caller; - this.models = new ServerModelsApi(caller); - this.tools = new ServerToolsApi(caller); - this.account = new ServerAccountApi(caller); - this.secrets = new ServerSecretsApi(caller); - this.mcp = new ServerMcpApi(caller); - this.skills = new ServerSkillsApi(caller); - this.sessionFs = new ServerSessionFsApi(caller); - this.sessions = new ServerSessionsApi(caller); - this.agentRegistry = new ServerAgentRegistryApi(caller); - } - - /** - * Optional message to echo back to the caller. - * @since 1.0.0 - */ - public CompletableFuture ping(PingParams params) { - return caller.invoke("ping", params, PingResult.class); - } - - /** - * Optional connection token presented by the SDK client during the handshake. - * @since 1.0.0 - */ - public CompletableFuture connect(ConnectParams params) { - return caller.invoke("connect", params, ConnectResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java deleted file mode 100644 index ece70c84a..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSessionsApi.java +++ /dev/null @@ -1,218 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code sessions} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerSessionsApi { - - private final RpcCaller caller; - - /** @param caller the RPC transport function */ - ServerSessionsApi(RpcCaller caller) { - this.caller = caller; - } - - /** - * Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture fork(SessionsForkParams params) { - return caller.invoke("sessions.fork", params, SessionsForkResult.class); - } - - /** - * Remote session connection parameters. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture connect() { - return caller.invoke("sessions.connect", java.util.Map.of(), SessionsConnectResult.class); - } - - /** - * Optional metadata-load limit and filters applied to the returned sessions. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("sessions.list", java.util.Map.of(), SessionsListResult.class); - } - - /** - * GitHub task ID to look up. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture findByTaskId(SessionsFindByTaskIdParams params) { - return caller.invoke("sessions.findByTaskId", params, SessionsFindByTaskIdResult.class); - } - - /** - * UUID prefix to resolve to a unique session ID. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture findByPrefix(SessionsFindByPrefixParams params) { - return caller.invoke("sessions.findByPrefix", params, SessionsFindByPrefixResult.class); - } - - /** - * Optional working-directory context used to score session relevance. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getLastForContext(SessionsGetLastForContextParams params) { - return caller.invoke("sessions.getLastForContext", params, SessionsGetLastForContextResult.class); - } - - /** - * Session ID whose event-log file path to compute. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getEventFilePath() { - return caller.invoke("sessions.getEventFilePath", java.util.Map.of(), SessionsGetEventFilePathResult.class); - } - - /** - * Map of sessionId -> on-disk size in bytes for each session's workspace directory. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getSizes() { - return caller.invoke("sessions.getSizes", java.util.Map.of(), SessionsGetSizesResult.class); - } - - /** - * Session IDs to test for live in-use locks. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture checkInUse(SessionsCheckInUseParams params) { - return caller.invoke("sessions.checkInUse", params, SessionsCheckInUseResult.class); - } - - /** - * Session ID to look up the persisted remote-steerable flag for. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getPersistedRemoteSteerable() { - return caller.invoke("sessions.getPersistedRemoteSteerable", java.util.Map.of(), SessionsGetPersistedRemoteSteerableResult.class); - } - - /** - * Session ID to close. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture close() { - return caller.invoke("sessions.close", java.util.Map.of(), Void.class); - } - - /** - * Session IDs to close, deactivate, and delete from disk. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture bulkDelete(SessionsBulkDeleteParams params) { - return caller.invoke("sessions.bulkDelete", params, SessionsBulkDeleteResult.class); - } - - /** - * Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture pruneOld(SessionsPruneOldParams params) { - return caller.invoke("sessions.pruneOld", params, SessionsPruneOldResult.class); - } - - /** - * Session ID whose pending events should be flushed to disk. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture save() { - return caller.invoke("sessions.save", java.util.Map.of(), Void.class); - } - - /** - * Session ID whose in-use lock should be released. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture releaseLock() { - return caller.invoke("sessions.releaseLock", java.util.Map.of(), Void.class); - } - - /** - * Session metadata records to enrich with summary and context information. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture enrichMetadata(SessionsEnrichMetadataParams params) { - return caller.invoke("sessions.enrichMetadata", params, SessionsEnrichMetadataResult.class); - } - - /** - * Active session ID and an optional flag for deferring repo-level hooks until folder trust. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture reloadPluginHooks(SessionsReloadPluginHooksParams params) { - return caller.invoke("sessions.reloadPluginHooks", params, Void.class); - } - - /** - * Active session ID whose deferred repo-level hooks should be loaded. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture loadDeferredRepoHooks() { - return caller.invoke("sessions.loadDeferredRepoHooks", java.util.Map.of(), SessionsLoadDeferredRepoHooksResult.class); - } - - /** - * Manager-wide additional plugins to register; replaces any previously-configured set. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture setAdditionalPlugins(SessionsSetAdditionalPluginsParams params) { - return caller.invoke("sessions.setAdditionalPlugins", params, Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java deleted file mode 100644 index 6404ab6fd..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/ServerSkillsApi.java +++ /dev/null @@ -1,40 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code skills} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class ServerSkillsApi { - - private final RpcCaller caller; - - /** API methods for the {@code skills.config} sub-namespace. */ - public final ServerSkillsConfigApi config; - - /** @param caller the RPC transport function */ - ServerSkillsApi(RpcCaller caller) { - this.caller = caller; - this.config = new ServerSkillsConfigApi(caller); - } - - /** - * Optional project paths and additional skill directories to include in discovery. - * @since 1.0.0 - */ - public CompletableFuture discover(SkillsDiscoverParams params) { - return caller.invoke("skills.discover", params, SkillsDiscoverResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java deleted file mode 100644 index c992d36e3..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentApi.java +++ /dev/null @@ -1,87 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code agent} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionAgentApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionAgentApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("session.agent.list", java.util.Map.of("sessionId", this.sessionId), SessionAgentListResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getCurrent() { - return caller.invoke("session.agent.getCurrent", java.util.Map.of("sessionId", this.sessionId), SessionAgentGetCurrentResult.class); - } - - /** - * Name of the custom agent to select for subsequent turns. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture select(SessionAgentSelectParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.agent.select", _p, SessionAgentSelectResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture deselect() { - return caller.invoke("session.agent.deselect", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture reload() { - return caller.invoke("session.agent.reload", java.util.Map.of("sessionId", this.sessionId), SessionAgentReloadResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectResult.java deleted file mode 100644 index 679a3fb83..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentDeselectResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.agent.deselect} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAgentDeselectResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java deleted file mode 100644 index 9763eb5c3..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAgentListParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Identifies the target session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAgentListParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthApi.java deleted file mode 100644 index 0f5729fe5..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthApi.java +++ /dev/null @@ -1,57 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code auth} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionAuthApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionAuthApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getStatus() { - return caller.invoke("session.auth.getStatus", java.util.Map.of("sessionId", this.sessionId), SessionAuthGetStatusResult.class); - } - - /** - * New auth credentials to install on the session. Omit to leave credentials unchanged. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture setCredentials(SessionAuthSetCredentialsParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.auth.setCredentials", _p, SessionAuthSetCredentialsResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusParams.java deleted file mode 100644 index d57a3cccc..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Identifies the target session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAuthGetStatusParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusResult.java deleted file mode 100644 index 3480257cc..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthGetStatusResult.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Authentication status and account metadata for the session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAuthGetStatusResult( - /** Whether the session has resolved authentication */ - @JsonProperty("isAuthenticated") Boolean isAuthenticated, - /** Authentication type */ - @JsonProperty("authType") AuthInfoType authType, - /** Authentication host URL */ - @JsonProperty("host") String host, - /** Authenticated login/username, if available */ - @JsonProperty("login") String login, - /** Human-readable authentication status description */ - @JsonProperty("statusMessage") String statusMessage, - /** Copilot plan tier (e.g., individual_pro, business) */ - @JsonProperty("copilotPlan") String copilotPlan -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsParams.java deleted file mode 100644 index 0b3b7aa9d..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * New auth credentials to install on the session. Omit to leave credentials unchanged. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAuthSetCredentialsParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. */ - @JsonProperty("credentials") Object credentials -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsResult.java deleted file mode 100644 index ad53ee919..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionAuthSetCredentialsResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Indicates whether the credential update succeeded. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionAuthSetCredentialsResult( - /** Whether the operation succeeded */ - @JsonProperty("success") Boolean success -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionParams.java deleted file mode 100644 index 3696e3e3e..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionParams.java +++ /dev/null @@ -1,33 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Canvas action invocation parameters. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionCanvasInvokeActionParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Open canvas instance identifier */ - @JsonProperty("instanceId") String instanceId, - /** Action name to invoke */ - @JsonProperty("actionName") String actionName, - /** Action input */ - @JsonProperty("input") Object input -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionResult.java deleted file mode 100644 index 117b618ae..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCanvasInvokeActionResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Canvas action invocation result. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionCanvasInvokeActionResult( - /** Provider-supplied action result */ - @JsonProperty("result") Object result -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java deleted file mode 100644 index d60a147d8..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionCommandsListParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Optional filters controlling which command sources to include in the listing. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionCommandsListParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java deleted file mode 100644 index a77e8a871..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadParams.java +++ /dev/null @@ -1,37 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Cursor, batch size, and optional long-poll/filter parameters for reading session events. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionEventLogReadParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. */ - @JsonProperty("cursor") String cursor, - /** Maximum number of events to return in this batch (1–1000, default 200). */ - @JsonProperty("max") Long max, - /** Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). */ - @JsonProperty("waitMs") Long waitMs, - /** Either '*' to receive all event types, or a non-empty list of event types to receive */ - @JsonProperty("types") Object types, - /** Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. */ - @JsonProperty("agentScope") EventsAgentScope agentScope -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java deleted file mode 100644 index dcd138e7b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogReadResult.java +++ /dev/null @@ -1,34 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Batch of session events returned by a read, with cursor and continuation metadata. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionEventLogReadResult( - /** Events are delivered in two batches per read: persisted events first (in append order), then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral events do not interleave within a single read. */ - @JsonProperty("events") List events, - /** Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. */ - @JsonProperty("cursor") String cursor, - /** True when the read returned `max` events and more events are available immediately. When false, the next read with a non-zero `waitMs` will block until a new event arrives or the wait expires. */ - @JsonProperty("hasMore") Boolean hasMore, - /** Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. */ - @JsonProperty("cursorStatus") EventsCursorStatus cursorStatus -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java deleted file mode 100644 index 94f68bdf7..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionEventLogRegisterInterestParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Event type to register consumer interest for, used by runtime gating logic. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionEventLogRegisterInterestParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full interactive OAuth flow to the consumer; when no interest is registered the runtime installs a browserless fallback that silently reuses cached tokens). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. */ - @JsonProperty("eventType") String eventType -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableResult.java deleted file mode 100644 index ac057e5a2..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsDisableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.extensions.disable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionExtensionsDisableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableResult.java deleted file mode 100644 index 82d9b9c6b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsEnableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.extensions.enable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionExtensionsEnableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadResult.java deleted file mode 100644 index 9d118b783..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionExtensionsReloadResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.extensions.reload} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionExtensionsReloadResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java deleted file mode 100644 index 91c7702f7..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryApi.java +++ /dev/null @@ -1,87 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code history} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionHistoryApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionHistoryApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Optional compaction parameters. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture compact() { - return caller.invoke("session.history.compact", java.util.Map.of("sessionId", this.sessionId), SessionHistoryCompactResult.class); - } - - /** - * Identifier of the event to truncate to; this event and all later events are removed. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture truncate(SessionHistoryTruncateParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.history.truncate", _p, SessionHistoryTruncateResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture cancelBackgroundCompaction() { - return caller.invoke("session.history.cancelBackgroundCompaction", java.util.Map.of("sessionId", this.sessionId), SessionHistoryCancelBackgroundCompactionResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture abortManualCompaction() { - return caller.invoke("session.history.abortManualCompaction", java.util.Map.of("sessionId", this.sessionId), SessionHistoryAbortManualCompactionResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture summarizeForHandoff() { - return caller.invoke("session.history.summarizeForHandoff", java.util.Map.of("sessionId", this.sessionId), SessionHistorySummarizeForHandoffResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java deleted file mode 100644 index cbb23e96f..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryCompactParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Optional compaction parameters. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionHistoryCompactParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java deleted file mode 100644 index 3c2a74ccb..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionHistoryTruncateResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Number of events that were removed by the truncation. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionHistoryTruncateResult( - /** Number of events that were removed */ - @JsonProperty("eventsRemoved") Long eventsRemoved -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java deleted file mode 100644 index 5d1428558..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionInstalledPlugin.java +++ /dev/null @@ -1,39 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `SessionInstalledPlugin` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionInstalledPlugin( - /** Plugin name */ - @JsonProperty("name") String name, - /** Marketplace the plugin came from (empty string for direct repo installs) */ - @JsonProperty("marketplace") String marketplace, - /** Installed version, if known */ - @JsonProperty("version") String version, - /** Installation timestamp (ISO-8601) */ - @JsonProperty("installed_at") String installedAt, - /** Whether the plugin is currently enabled */ - @JsonProperty("enabled") Boolean enabled, - /** Path where the plugin is cached locally */ - @JsonProperty("cache_path") String cachePath, - /** Source descriptor for direct repo installs (when marketplace is empty) */ - @JsonProperty("source") Object source -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java deleted file mode 100644 index c9e577fd5..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpApi.java +++ /dev/null @@ -1,144 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code mcp} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionMcpApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** API methods for the {@code mcp.oauth} sub-namespace. */ - public final SessionMcpOauthApi oauth; - /** API methods for the {@code mcp.apps} sub-namespace. */ - public final SessionMcpAppsApi apps; - - /** @param caller the RPC transport function */ - SessionMcpApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - this.oauth = new SessionMcpOauthApi(caller, sessionId); - this.apps = new SessionMcpAppsApi(caller, sessionId); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("session.mcp.list", java.util.Map.of("sessionId", this.sessionId), SessionMcpListResult.class); - } - - /** - * Name of the MCP server to enable for the session. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture enable(SessionMcpEnableParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.enable", _p, Void.class); - } - - /** - * Name of the MCP server to disable for the session. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture disable(SessionMcpDisableParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.disable", _p, Void.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture reload() { - return caller.invoke("session.mcp.reload", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - - /** - * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture executeSampling(SessionMcpExecuteSamplingParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.executeSampling", _p, SessionMcpExecuteSamplingResult.class); - } - - /** - * The requestId previously passed to executeSampling that should be cancelled. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.cancelSamplingExecution", _p, SessionMcpCancelSamplingExecutionResult.class); - } - - /** - * Mode controlling how MCP server env values are resolved (`direct` or `indirect`). - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture setEnvValueMode(SessionMcpSetEnvValueModeParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.setEnvValueMode", _p, SessionMcpSetEnvValueModeResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture removeGitHub() { - return caller.invoke("session.mcp.removeGitHub", java.util.Map.of("sessionId", this.sessionId), SessionMcpRemoveGitHubResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableResult.java deleted file mode 100644 index 834dc2cb7..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpDisableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.mcp.disable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMcpDisableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableResult.java deleted file mode 100644 index 86b1a6716..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpEnableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.mcp.enable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMcpEnableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java deleted file mode 100644 index 220f663b6..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpListResult.java +++ /dev/null @@ -1,28 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * MCP servers configured for the session, with their connection status. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMcpListResult( - /** Configured MCP servers */ - @JsonProperty("servers") List servers -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java deleted file mode 100644 index 68535ebc4..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthApi.java +++ /dev/null @@ -1,47 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code mcp.oauth} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionMcpOauthApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionMcpOauthApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture login(SessionMcpOauthLoginParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.mcp.oauth.login", _p, SessionMcpOauthLoginResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java deleted file mode 100644 index 4fcca6618..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpOauthLoginParams.java +++ /dev/null @@ -1,35 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMcpOauthLoginParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Name of the remote MCP server to authenticate */ - @JsonProperty("serverName") String serverName, - /** 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. */ - @JsonProperty("forceReauth") Boolean forceReauth, - /** 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. */ - @JsonProperty("clientName") String clientName, - /** 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. */ - @JsonProperty("callbackSuccessMessage") String callbackSuccessMessage -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadResult.java deleted file mode 100644 index 3f0d970fc..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMcpReloadResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.mcp.reload} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMcpReloadResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadata.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadata.java deleted file mode 100644 index 03a9e3280..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadata.java +++ /dev/null @@ -1,45 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `SessionMetadata` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMetadata( - /** Stable session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Session creation time as an ISO 8601 timestamp */ - @JsonProperty("startTime") String startTime, - /** Last-modified time of the session's persisted state, as ISO 8601 */ - @JsonProperty("modifiedTime") String modifiedTime, - /** Short summary of the session, when one has been derived */ - @JsonProperty("summary") String summary, - /** Optional human-friendly name set via /rename */ - @JsonProperty("name") String name, - /** Runtime client name that created/last resumed this session */ - @JsonProperty("clientName") String clientName, - /** True for remote (GitHub) sessions; false for local */ - @JsonProperty("isRemote") Boolean isRemote, - /** True for detached maintenance sessions that should be hidden from normal resume lists. */ - @JsonProperty("isDetached") Boolean isDetached, - /** Schema for the `SessionContext` type. */ - @JsonProperty("context") SessionContext context, - /** GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. */ - @JsonProperty("mcTaskId") String mcTaskId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java deleted file mode 100644 index 7bd7e66bb..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataApi.java +++ /dev/null @@ -1,112 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code metadata} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionMetadataApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionMetadataApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture snapshot() { - return caller.invoke("session.metadata.snapshot", java.util.Map.of("sessionId", this.sessionId), SessionMetadataSnapshotResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture isProcessing() { - return caller.invoke("session.metadata.isProcessing", java.util.Map.of("sessionId", this.sessionId), SessionMetadataIsProcessingResult.class); - } - - /** - * Model identifier and token limits used to compute the context-info breakdown. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture contextInfo(SessionMetadataContextInfoParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.metadata.contextInfo", _p, SessionMetadataContextInfoResult.class); - } - - /** - * Updated working-directory/git context to record on the session. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture recordContextChange(SessionMetadataRecordContextChangeParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.metadata.recordContextChange", _p, Void.class); - } - - /** - * Absolute path to set as the session's new working directory. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture setWorkingDirectory(SessionMetadataSetWorkingDirectoryParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.metadata.setWorkingDirectory", _p, SessionMetadataSetWorkingDirectoryResult.class); - } - - /** - * Model identifier to use when re-tokenizing the session's existing messages. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.metadata.recomputeContextTokens", _p, SessionMetadataRecomputeContextTokensResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeResult.java deleted file mode 100644 index 41f252b20..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataRecordContextChangeResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMetadataRecordContextChangeResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java deleted file mode 100644 index 507b0a49f..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Absolute path to set as the session's new working directory. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMetadataSetWorkingDirectoryParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. */ - @JsonProperty("workingDirectory") String workingDirectory -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java deleted file mode 100644 index 85ef81026..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionMetadataSetWorkingDirectoryResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionMetadataSetWorkingDirectoryResult( - /** Working directory after the update */ - @JsonProperty("workingDirectory") String workingDirectory -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetResult.java deleted file mode 100644 index b5123aebf..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeGetResult.java +++ /dev/null @@ -1,49 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.mode.get} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModeGetResult( - /** The current agent mode. */ - @JsonProperty("mode") SessionModeGetResultMode mode -) { - - /** The current agent mode. */ - public enum SessionModeGetResultMode { - /** The {@code interactive} variant. */ - INTERACTIVE("interactive"), - /** The {@code plan} variant. */ - PLAN("plan"), - /** The {@code autopilot} variant. */ - AUTOPILOT("autopilot"); - - private final String value; - SessionModeGetResultMode(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static SessionModeGetResultMode fromValue(String value) { - for (SessionModeGetResultMode v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown SessionModeGetResultMode value: " + value); - } - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.java deleted file mode 100644 index c79602272..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModeSetResult.java +++ /dev/null @@ -1,49 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.mode.set} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModeSetResult( - /** The agent mode after switching. */ - @JsonProperty("mode") SessionModeSetResultMode mode -) { - - /** The agent mode after switching. */ - public enum SessionModeSetResultMode { - /** The {@code interactive} variant. */ - INTERACTIVE("interactive"), - /** The {@code plan} variant. */ - PLAN("plan"), - /** The {@code autopilot} variant. */ - AUTOPILOT("autopilot"); - - private final String value; - SessionModeSetResultMode(String value) { this.value = value; } - @com.fasterxml.jackson.annotation.JsonValue - public String getValue() { return value; } - @com.fasterxml.jackson.annotation.JsonCreator - public static SessionModeSetResultMode fromValue(String value) { - for (SessionModeSetResultMode v : values()) { - if (v.value.equals(value)) return v; - } - throw new IllegalArgumentException("Unknown SessionModeSetResultMode value: " + value); - } - } -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java deleted file mode 100644 index eda751b3e..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelApi.java +++ /dev/null @@ -1,72 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code model} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionModelApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionModelApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getCurrent() { - return caller.invoke("session.model.getCurrent", java.util.Map.of("sessionId", this.sessionId), SessionModelGetCurrentResult.class); - } - - /** - * Target model identifier and optional reasoning effort, summary, and capability overrides. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture switchTo(SessionModelSwitchToParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.model.switchTo", _p, SessionModelSwitchToResult.class); - } - - /** - * Reasoning effort level to apply to the currently selected model. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture setReasoningEffort(SessionModelSetReasoningEffortParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.model.setReasoningEffort", _p, SessionModelSetReasoningEffortResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java deleted file mode 100644 index 7bb2f8496..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelGetCurrentResult.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * The currently selected model and reasoning effort for the session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModelGetCurrentResult( - /** Currently active model identifier */ - @JsonProperty("modelId") String modelId, - /** Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. */ - @JsonProperty("reasoningEffort") String reasoningEffort -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java deleted file mode 100644 index c5c1cbbe0..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToParams.java +++ /dev/null @@ -1,35 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Target model identifier and optional reasoning effort, summary, and capability overrides. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModelSwitchToParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Model identifier to switch to */ - @JsonProperty("modelId") String modelId, - /** Reasoning effort level to use for the model. "none" disables reasoning. */ - @JsonProperty("reasoningEffort") String reasoningEffort, - /** Reasoning summary mode to request for supported model clients */ - @JsonProperty("reasoningSummary") ReasoningSummary reasoningSummary, - /** Override individual model capabilities resolved by the runtime */ - @JsonProperty("modelCapabilities") ModelCapabilitiesOverride modelCapabilities -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java deleted file mode 100644 index 8bf6f2c8e..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionModelSwitchToResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * The model identifier active on the session after the switch. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionModelSwitchToResult( - /** Currently active model identifier after the switch */ - @JsonProperty("modelId") String modelId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java deleted file mode 100644 index 8f9a06a4f..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateParams.java +++ /dev/null @@ -1,103 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import java.util.Map; -import javax.annotation.processing.Generated; - -/** - * Patch of mutable session options to apply to the running session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionOptionsUpdateParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** The model ID to use for assistant turns. */ - @JsonProperty("model") String model, - /** Reasoning effort for the selected model (model-defined enum). */ - @JsonProperty("reasoningEffort") String reasoningEffort, - /** Identifier of the client driving the session. */ - @JsonProperty("clientName") String clientName, - /** Identifier sent to LSP-style integrations. */ - @JsonProperty("lspClientName") String lspClientName, - /** Stable integration identifier used for analytics and rate-limit attribution. */ - @JsonProperty("integrationId") String integrationId, - /** Map of feature-flag IDs to their boolean enabled state. */ - @JsonProperty("featureFlags") Map featureFlags, - /** Whether experimental capabilities are enabled. */ - @JsonProperty("isExperimentalMode") Boolean isExperimentalMode, - /** Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the runtime. */ - @JsonProperty("provider") Object provider, - /** Absolute working-directory path for shell tools. */ - @JsonProperty("workingDirectory") String workingDirectory, - /** Allowlist of tool names available to this session. */ - @JsonProperty("availableTools") List availableTools, - /** Denylist of tool names for this session. */ - @JsonProperty("excludedTools") List excludedTools, - /** Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. */ - @JsonProperty("toolFilterPrecedence") OptionsUpdateToolFilterPrecedence toolFilterPrecedence, - /** Whether shell-script safety heuristics are enabled. */ - @JsonProperty("enableScriptSafety") Boolean enableScriptSafety, - /** Shell init profile (`None` or `NonInteractive`). */ - @JsonProperty("shellInitProfile") String shellInitProfile, - /** Per-shell process flags (e.g., `pwsh` arguments). */ - @JsonProperty("shellProcessFlags") List shellProcessFlags, - /** Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. */ - @JsonProperty("sandboxConfig") Object sandboxConfig, - /** Whether interactive shell sessions are logged. */ - @JsonProperty("logInteractiveShells") Boolean logInteractiveShells, - /** How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). */ - @JsonProperty("envValueMode") OptionsUpdateEnvValueMode envValueMode, - /** Additional directories to search for skills. */ - @JsonProperty("skillDirectories") List skillDirectories, - /** Skill IDs that should be excluded from this session. */ - @JsonProperty("disabledSkills") List disabledSkills, - /** Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. */ - @JsonProperty("enableOnDemandInstructionDiscovery") Boolean enableOnDemandInstructionDiscovery, - /** Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. */ - @JsonProperty("installedPlugins") List installedPlugins, - /** Whether to default custom agents to local-only execution. */ - @JsonProperty("customAgentsLocalOnly") Boolean customAgentsLocalOnly, - /** Whether to skip loading custom instruction sources. */ - @JsonProperty("skipCustomInstructions") Boolean skipCustomInstructions, - /** Instruction source IDs to exclude from the system prompt. */ - @JsonProperty("disabledInstructionSources") List disabledInstructionSources, - /** Whether to include the `Co-authored-by` trailer in commit messages. */ - @JsonProperty("coauthorEnabled") Boolean coauthorEnabled, - /** Optional path for trajectory output. */ - @JsonProperty("trajectoryFile") String trajectoryFile, - /** Whether to stream model responses. */ - @JsonProperty("enableStreaming") Boolean enableStreaming, - /** Override URL for the Copilot API endpoint. */ - @JsonProperty("copilotUrl") String copilotUrl, - /** Whether to disable the `ask_user` tool (encourages autonomous behavior). */ - @JsonProperty("askUserDisabled") Boolean askUserDisabled, - /** Whether to allow auto-mode continuation across turns. */ - @JsonProperty("continueOnAutoMode") Boolean continueOnAutoMode, - /** Whether the session is running in an interactive UI. */ - @JsonProperty("runningInInteractiveMode") Boolean runningInInteractiveMode, - /** Whether to surface reasoning-summary events from the model. */ - @JsonProperty("enableReasoningSummaries") Boolean enableReasoningSummaries, - /** Runtime context discriminator (e.g., `cli`, `actions`). */ - @JsonProperty("agentContext") String agentContext, - /** Override directory for the session-events log. When unset, the runtime's default events log directory is used. */ - @JsonProperty("eventsLogDirectory") String eventsLogDirectory, - /** Additional content-exclusion policies to merge into the session's policy set. Opaque shape; see `ContentExclusionApiResponse` in the runtime. */ - @JsonProperty("additionalContentExclusionPolicies") List additionalContentExclusionPolicies, - /** Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). */ - @JsonProperty("manageScheduleEnabled") Boolean manageScheduleEnabled -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java deleted file mode 100644 index 4e514944c..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionOptionsUpdateResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Indicates whether the session options patch was applied successfully. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionOptionsUpdateResult( - /** Whether the operation succeeded */ - @JsonProperty("success") Boolean success -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java deleted file mode 100644 index 84b7cfbf0..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsGetAllowAllResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Current full allow-all permission state. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsGetAllowAllResult( - /** Whether full allow-all permissions are currently active */ - @JsonProperty("enabled") Boolean enabled -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java deleted file mode 100644 index 2f061ed0c..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsHandlePendingPermissionRequestParams.java +++ /dev/null @@ -1,31 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Pending permission request ID and the decision to apply (approve/reject and scope). - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsHandlePendingPermissionRequestParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Request ID of the pending permission request */ - @JsonProperty("requestId") String requestId, - /** The client's response to the pending permission prompt */ - @JsonProperty("result") Object result -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java deleted file mode 100644 index dd369bf43..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsResetSessionApprovalsParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * No parameters; clears all session-scoped tool permission approvals. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsResetSessionApprovalsParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java deleted file mode 100644 index e6335f45b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Whether to enable full allow-all permissions for the session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsSetAllowAllParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Whether to enable full allow-all permissions */ - @JsonProperty("enabled") Boolean enabled -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java deleted file mode 100644 index 5026dd78b..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPermissionsSetAllowAllResult.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Indicates whether the operation succeeded and reports the post-mutation state. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPermissionsSetAllowAllResult( - /** Whether the operation succeeded */ - @JsonProperty("success") Boolean success, - /** Authoritative allow-all state after the mutation */ - @JsonProperty("enabled") Boolean enabled -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java deleted file mode 100644 index 25ff6884f..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanApi.java +++ /dev/null @@ -1,67 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code plan} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionPlanApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionPlanApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture read() { - return caller.invoke("session.plan.read", java.util.Map.of("sessionId", this.sessionId), SessionPlanReadResult.class); - } - - /** - * Replacement contents to write to the session plan file. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture update(SessionPlanUpdateParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.plan.update", _p, Void.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture delete() { - return caller.invoke("session.plan.delete", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteResult.java deleted file mode 100644 index 98cb199e6..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanDeleteResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.plan.delete} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPlanDeleteResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateResult.java deleted file mode 100644 index 3e17cfeda..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPlanUpdateResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.plan.update} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionPlanUpdateResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java deleted file mode 100644 index e59e2b398..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionPluginsApi.java +++ /dev/null @@ -1,40 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code plugins} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionPluginsApi { - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionPluginsApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("session.plugins.list", java.util.Map.of("sessionId", this.sessionId), SessionPluginsListResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java deleted file mode 100644 index 9c4a13b55..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionQueueApi.java +++ /dev/null @@ -1,60 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code queue} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionQueueApi { - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionQueueApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture pendingItems() { - return caller.invoke("session.queue.pendingItems", java.util.Map.of("sessionId", this.sessionId), SessionQueuePendingItemsResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture removeMostRecent() { - return caller.invoke("session.queue.removeMostRecent", java.util.Map.of("sessionId", this.sessionId), SessionQueueRemoveMostRecentResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture clear() { - return caller.invoke("session.queue.clear", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedResult.java deleted file mode 100644 index 4d48e604d..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRemoteNotifySteerableChangedResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionRemoteNotifySteerableChangedResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java deleted file mode 100644 index 37567e7a7..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionRpc.java +++ /dev/null @@ -1,203 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * Typed client for session-scoped RPC methods. - *

    - * Provides strongly-typed access to all session-level API namespaces. - * The {@code sessionId} is injected automatically into every call. - *

    - * Obtain an instance by calling {@code new SessionRpc(caller, sessionId)}. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionRpc { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** API methods for the {@code auth} namespace. */ - public final SessionAuthApi auth; - /** API methods for the {@code canvas} namespace. */ - public final SessionCanvasApi canvas; - /** API methods for the {@code model} namespace. */ - public final SessionModelApi model; - /** API methods for the {@code mode} namespace. */ - public final SessionModeApi mode; - /** API methods for the {@code name} namespace. */ - public final SessionNameApi name; - /** API methods for the {@code plan} namespace. */ - public final SessionPlanApi plan; - /** API methods for the {@code workspaces} namespace. */ - public final SessionWorkspacesApi workspaces; - /** API methods for the {@code instructions} namespace. */ - public final SessionInstructionsApi instructions; - /** API methods for the {@code fleet} namespace. */ - public final SessionFleetApi fleet; - /** API methods for the {@code agent} namespace. */ - public final SessionAgentApi agent; - /** API methods for the {@code tasks} namespace. */ - public final SessionTasksApi tasks; - /** API methods for the {@code skills} namespace. */ - public final SessionSkillsApi skills; - /** API methods for the {@code mcp} namespace. */ - public final SessionMcpApi mcp; - /** API methods for the {@code plugins} namespace. */ - public final SessionPluginsApi plugins; - /** API methods for the {@code options} namespace. */ - public final SessionOptionsApi options; - /** API methods for the {@code lsp} namespace. */ - public final SessionLspApi lsp; - /** API methods for the {@code extensions} namespace. */ - public final SessionExtensionsApi extensions; - /** API methods for the {@code tools} namespace. */ - public final SessionToolsApi tools; - /** API methods for the {@code commands} namespace. */ - public final SessionCommandsApi commands; - /** API methods for the {@code telemetry} namespace. */ - public final SessionTelemetryApi telemetry; - /** API methods for the {@code ui} namespace. */ - public final SessionUiApi ui; - /** API methods for the {@code permissions} namespace. */ - public final SessionPermissionsApi permissions; - /** API methods for the {@code metadata} namespace. */ - public final SessionMetadataApi metadata; - /** API methods for the {@code shell} namespace. */ - public final SessionShellApi shell; - /** API methods for the {@code history} namespace. */ - public final SessionHistoryApi history; - /** API methods for the {@code queue} namespace. */ - public final SessionQueueApi queue; - /** API methods for the {@code eventLog} namespace. */ - public final SessionEventLogApi eventLog; - /** API methods for the {@code usage} namespace. */ - public final SessionUsageApi usage; - /** API methods for the {@code remote} namespace. */ - public final SessionRemoteApi remote; - /** API methods for the {@code schedule} namespace. */ - public final SessionScheduleApi schedule; - - /** - * Creates a new session RPC client. - * - * @param caller the RPC transport function (e.g., {@code jsonRpcClient::invoke}) - * @param sessionId the session ID to inject into every request - */ - public SessionRpc(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - this.auth = new SessionAuthApi(caller, sessionId); - this.canvas = new SessionCanvasApi(caller, sessionId); - this.model = new SessionModelApi(caller, sessionId); - this.mode = new SessionModeApi(caller, sessionId); - this.name = new SessionNameApi(caller, sessionId); - this.plan = new SessionPlanApi(caller, sessionId); - this.workspaces = new SessionWorkspacesApi(caller, sessionId); - this.instructions = new SessionInstructionsApi(caller, sessionId); - this.fleet = new SessionFleetApi(caller, sessionId); - this.agent = new SessionAgentApi(caller, sessionId); - this.tasks = new SessionTasksApi(caller, sessionId); - this.skills = new SessionSkillsApi(caller, sessionId); - this.mcp = new SessionMcpApi(caller, sessionId); - this.plugins = new SessionPluginsApi(caller, sessionId); - this.options = new SessionOptionsApi(caller, sessionId); - this.lsp = new SessionLspApi(caller, sessionId); - this.extensions = new SessionExtensionsApi(caller, sessionId); - this.tools = new SessionToolsApi(caller, sessionId); - this.commands = new SessionCommandsApi(caller, sessionId); - this.telemetry = new SessionTelemetryApi(caller, sessionId); - this.ui = new SessionUiApi(caller, sessionId); - this.permissions = new SessionPermissionsApi(caller, sessionId); - this.metadata = new SessionMetadataApi(caller, sessionId); - this.shell = new SessionShellApi(caller, sessionId); - this.history = new SessionHistoryApi(caller, sessionId); - this.queue = new SessionQueueApi(caller, sessionId); - this.eventLog = new SessionEventLogApi(caller, sessionId); - this.usage = new SessionUsageApi(caller, sessionId); - this.remote = new SessionRemoteApi(caller, sessionId); - this.schedule = new SessionScheduleApi(caller, sessionId); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture suspend() { - return caller.invoke("session.suspend", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - - /** - * Parameters for sending a user message to the session - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture send(SessionSendParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.send", _p, SessionSendResult.class); - } - - /** - * Parameters for aborting the current turn - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture abort(SessionAbortParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.abort", _p, SessionAbortResult.class); - } - - /** - * Parameters for shutting down the session - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture shutdown(SessionShutdownParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.shutdown", _p, Void.class); - } - - /** - * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture log(SessionLogParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.log", _p, SessionLogResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java deleted file mode 100644 index e35fb2197..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionScheduleApi.java +++ /dev/null @@ -1,57 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code schedule} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionScheduleApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionScheduleApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture list() { - return caller.invoke("session.schedule.list", java.util.Map.of("sessionId", this.sessionId), SessionScheduleListResult.class); - } - - /** - * Identifier of the scheduled prompt to remove. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture stop(SessionScheduleStopParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.schedule.stop", _p, SessionScheduleStopResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java deleted file mode 100644 index 9abf8a626..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionShellApi.java +++ /dev/null @@ -1,62 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code shell} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionShellApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionShellApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Shell command to run, with optional working directory and timeout in milliseconds. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture exec(SessionShellExecParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.shell.exec", _p, SessionShellExecResult.class); - } - - /** - * Identifier of a process previously returned by "shell.exec" and the signal to send. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture kill(SessionShellKillParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.shell.kill", _p, SessionShellKillResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableResult.java deleted file mode 100644 index 3bd4b7dad..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsDisableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.skills.disable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionSkillsDisableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableResult.java deleted file mode 100644 index e8684ddc1..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionSkillsEnableResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.skills.enable} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionSkillsEnableResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshResult.java deleted file mode 100644 index 497d41233..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksRefreshResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionTasksRefreshResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingResult.java deleted file mode 100644 index b8ec86d12..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionTasksWaitForPendingResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionTasksWaitForPendingResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java deleted file mode 100644 index 81c04f2ca..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsApi.java +++ /dev/null @@ -1,57 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code tools} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionToolsApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionToolsApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Pending external tool call request ID, with the tool result or an error describing why it failed. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture handlePendingToolCall(SessionToolsHandlePendingToolCallParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.tools.handlePendingToolCall", _p, SessionToolsHandlePendingToolCallResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture initializeAndValidate() { - return caller.invoke("session.tools.initializeAndValidate", java.util.Map.of("sessionId", this.sessionId), Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateResult.java deleted file mode 100644 index b4126b390..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionToolsInitializeAndValidateResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionToolsInitializeAndValidateResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceApi.java deleted file mode 100644 index d74f67047..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceApi.java +++ /dev/null @@ -1,66 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code workspace} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionWorkspaceApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionWorkspaceApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Invokes {@code session.workspace.listFiles}. - * @since 1.0.0 - */ - public CompletableFuture listFiles() { - return caller.invoke("session.workspace.listFiles", java.util.Map.of("sessionId", this.sessionId), SessionWorkspaceListFilesResult.class); - } - - /** - * Invokes {@code session.workspace.readFile}. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * @since 1.0.0 - */ - public CompletableFuture readFile(SessionWorkspaceReadFileParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspace.readFile", _p, SessionWorkspaceReadFileResult.class); - } - - /** - * Invokes {@code session.workspace.createFile}. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * @since 1.0.0 - */ - public CompletableFuture createFile(SessionWorkspaceCreateFileParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspace.createFile", _p, Void.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileParams.java deleted file mode 100644 index 94efe9313..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileParams.java +++ /dev/null @@ -1,31 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Request parameters for the {@code session.workspace.createFile} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceCreateFileParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Relative path within the workspace files directory */ - @JsonProperty("path") String path, - /** File content to write as a UTF-8 string */ - @JsonProperty("content") String content -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileResult.java deleted file mode 100644 index f0bf113ba..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceCreateFileResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.workspace.createFile} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceCreateFileResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesParams.java deleted file mode 100644 index a2fd1407c..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesParams.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Request parameters for the {@code session.workspace.listFiles} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceListFilesParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesResult.java deleted file mode 100644 index 96e7ce9c4..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceListFilesResult.java +++ /dev/null @@ -1,28 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.workspace.listFiles} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceListFilesResult( - /** Relative file paths in the workspace files directory */ - @JsonProperty("files") List files -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileParams.java deleted file mode 100644 index c39a8a525..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Request parameters for the {@code session.workspace.readFile} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceReadFileParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Relative path within the workspace files directory */ - @JsonProperty("path") String path -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileResult.java deleted file mode 100644 index b4ece91ef..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspaceReadFileResult.java +++ /dev/null @@ -1,27 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Result for the {@code session.workspace.readFile} RPC method. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspaceReadFileResult( - /** File content as a UTF-8 string */ - @JsonProperty("content") String content -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java deleted file mode 100644 index 54a79c0c5..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesApi.java +++ /dev/null @@ -1,137 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import java.util.concurrent.CompletableFuture; -import javax.annotation.processing.Generated; - -/** - * API methods for the {@code workspaces} namespace. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -public final class SessionWorkspacesApi { - - private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER = RpcMapper.INSTANCE; - - private final RpcCaller caller; - private final String sessionId; - - /** @param caller the RPC transport function */ - SessionWorkspacesApi(RpcCaller caller, String sessionId) { - this.caller = caller; - this.sessionId = sessionId; - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture getWorkspace() { - return caller.invoke("session.workspaces.getWorkspace", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesGetWorkspaceResult.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture listFiles() { - return caller.invoke("session.workspaces.listFiles", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListFilesResult.class); - } - - /** - * Relative path of the workspace file to read. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture readFile(SessionWorkspacesReadFileParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspaces.readFile", _p, SessionWorkspacesReadFileResult.class); - } - - /** - * Relative path and UTF-8 content for the workspace file to create or overwrite. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture createFile(SessionWorkspacesCreateFileParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspaces.createFile", _p, Void.class); - } - - /** - * Identifies the target session. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture listCheckpoints() { - return caller.invoke("session.workspaces.listCheckpoints", java.util.Map.of("sessionId", this.sessionId), SessionWorkspacesListCheckpointsResult.class); - } - - /** - * Checkpoint number to read. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture readCheckpoint(SessionWorkspacesReadCheckpointParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspaces.readCheckpoint", _p, SessionWorkspacesReadCheckpointResult.class); - } - - /** - * Pasted content to save as a UTF-8 file in the session workspace. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture saveLargePaste(SessionWorkspacesSaveLargePasteParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspaces.saveLargePaste", _p, SessionWorkspacesSaveLargePasteResult.class); - } - - /** - * Parameters for computing a workspace diff. - *

    - * Note: the {@code sessionId} field in the params record is overridden - * by the session-scoped wrapper; any value provided is ignored. - * - * @apiNote This method is experimental and may change in a future version. - * @since 1.0.0 - */ - public CompletableFuture diff(SessionWorkspacesDiffParams params) { - com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params); - _p.put("sessionId", this.sessionId); - return caller.invoke("session.workspaces.diff", _p, SessionWorkspacesDiffResult.class); - } - -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java deleted file mode 100644 index 02a2668c3..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffParams.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Parameters for computing a workspace diff. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspacesDiffParams( - /** Target session identifier */ - @JsonProperty("sessionId") String sessionId, - /** Diff mode requested by the client. */ - @JsonProperty("mode") WorkspaceDiffMode mode -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java deleted file mode 100644 index 2800f24e3..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionWorkspacesDiffResult.java +++ /dev/null @@ -1,36 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Workspace diff result for the requested mode. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionWorkspacesDiffResult( - /** Diff mode requested by the client. */ - @JsonProperty("requestedMode") WorkspaceDiffMode requestedMode, - /** Effective mode used for the returned changes. */ - @JsonProperty("mode") WorkspaceDiffMode mode, - /** Changed files and their unified diffs. */ - @JsonProperty("changes") List changes, - /** Default branch used for a branch diff, when branch mode was requested. */ - @JsonProperty("baseBranch") String baseBranch, - /** Whether a requested branch diff fell back to unstaged changes because branch diff failed. */ - @JsonProperty("isFallback") Boolean isFallback -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseResult.java deleted file mode 100644 index a63c44633..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsCloseResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsCloseResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java deleted file mode 100644 index 7608fe3f3..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsListResult.java +++ /dev/null @@ -1,28 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Persisted sessions matching the filter, ordered most-recently-modified first. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsListResult( - /** Sessions ordered most-recently-modified first */ - @JsonProperty("sessions") List sessions -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockResult.java deleted file mode 100644 index dde0c445e..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReleaseLockResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsReleaseLockResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksResult.java deleted file mode 100644 index 835641e4d..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsReloadPluginHooksResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsReloadPluginHooksResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveResult.java deleted file mode 100644 index 758d11885..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSaveResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsSaveResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsResult.java deleted file mode 100644 index 848ff9e08..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SessionsSetAdditionalPluginsResult.java +++ /dev/null @@ -1,24 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SessionsSetAdditionalPluginsResult() { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/Skill.java b/java/src/generated/java/com/github/copilot/generated/rpc/Skill.java deleted file mode 100644 index d64f01515..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/Skill.java +++ /dev/null @@ -1,39 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `Skill` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record Skill( - /** Unique identifier for the skill */ - @JsonProperty("name") String name, - /** Description of what the skill does */ - @JsonProperty("description") String description, - /** Source location type (e.g., project, personal-copilot, plugin, builtin) */ - @JsonProperty("source") SkillSource source, - /** Whether the skill can be invoked by the user as a slash command */ - @JsonProperty("userInvocable") Boolean userInvocable, - /** Whether the skill is currently enabled */ - @JsonProperty("enabled") Boolean enabled, - /** Absolute path to the skill file */ - @JsonProperty("path") String path, - /** Name of the plugin that provides the skill, when source is 'plugin' */ - @JsonProperty("pluginName") String pluginName -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java b/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java deleted file mode 100644 index f56c814bc..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/SkillsDiscoverResult.java +++ /dev/null @@ -1,28 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.List; -import javax.annotation.processing.Generated; - -/** - * Skills discovered across global and project sources. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record SkillsDiscoverResult( - /** All discovered skills across all sources */ - @JsonProperty("skills") List skills -) { -} diff --git a/java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java b/java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java deleted file mode 100644 index 50e201142..000000000 --- a/java/src/generated/java/com/github/copilot/generated/rpc/UIExitPlanModeResponse.java +++ /dev/null @@ -1,33 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -// AUTO-GENERATED FILE - DO NOT EDIT -// Generated from: api.schema.json - -package com.github.copilot.generated.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import javax.annotation.processing.Generated; - -/** - * Schema for the `UIExitPlanModeResponse` type. - * - * @since 1.0.0 - */ -@javax.annotation.processing.Generated("copilot-sdk-codegen") -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown = true) -public record UIExitPlanModeResponse( - /** Whether the plan was approved. */ - @JsonProperty("approved") Boolean approved, - /** The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. */ - @JsonProperty("selectedAction") UIExitPlanModeAction selectedAction, - /** Whether subsequent edits should be auto-approved without confirmation. */ - @JsonProperty("autoApproveEdits") Boolean autoApproveEdits, - /** Feedback from the user when they declined the plan or requested changes. */ - @JsonProperty("feedback") String feedback -) { -} diff --git a/java/src/main/java/com/github/copilot/CopilotClient.java b/java/src/main/java/com/github/copilot/CopilotClient.java deleted file mode 100644 index 6422c773d..000000000 --- a/java/src/main/java/com/github/copilot/CopilotClient.java +++ /dev/null @@ -1,1253 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import java.io.IOException; -import java.net.URI; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.CompletionException; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.Executor; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.RejectedExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.logging.Level; -import java.util.logging.Logger; - -import com.github.copilot.rpc.CopilotClientMode; -import com.github.copilot.rpc.CopilotClientOptions; -import com.github.copilot.rpc.CreateSessionResponse; -import com.github.copilot.generated.rpc.SessionOptionsUpdateParams; -import com.github.copilot.generated.rpc.SessionInstalledPlugin; -import com.github.copilot.generated.rpc.ConnectParams; -import com.github.copilot.generated.rpc.ServerRpc; -import com.github.copilot.rpc.DeleteSessionResponse; -import com.github.copilot.rpc.GetAuthStatusResponse; -import com.github.copilot.rpc.GetLastSessionIdResponse; -import com.github.copilot.rpc.GetSessionMetadataResponse; -import com.github.copilot.rpc.GetModelsResponse; -import com.github.copilot.rpc.GetStatusResponse; -import com.github.copilot.rpc.ListSessionsResponse; -import com.github.copilot.rpc.ModelInfo; -import com.github.copilot.rpc.PingResponse; -import com.github.copilot.rpc.ResumeSessionConfig; -import com.github.copilot.rpc.ResumeSessionResponse; -import com.github.copilot.rpc.SessionConfig; -import com.github.copilot.rpc.SessionLifecycleHandler; -import com.github.copilot.rpc.SessionListFilter; -import com.github.copilot.rpc.SessionMetadata; - -/** - * Provides a client for interacting with the Copilot CLI server. - *

    - * The CopilotClient manages the connection to the Copilot CLI server and - * provides methods to create and manage conversation sessions. It can either - * spawn a CLI server process or connect to an existing server. - *

    - * Example usage: - * - * 

    {@code
- * try (var client = new CopilotClient()) {
- * 	client.start().get();
- *
- * 	var session = client
- * 			.createSession(
- * 					new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5"))
- * 			.get();
- *
- * 	session.on(AssistantMessageEvent.class, msg -> {
- * 		System.out.println(msg.getData().content());
- * 	});
- *
- * 	session.send(new MessageOptions().setPrompt("Hello!")).get();
- * }
- * }
    - * - * @since 1.0.0 - */ -public final class CopilotClient implements AutoCloseable { - - private static final Logger LOG = Logger.getLogger(CopilotClient.class.getName()); - - /** - * Timeout, in seconds, used by {@link #close()} when waiting for graceful - * shutdown via {@link #stop()}. - */ - public static final int AUTOCLOSEABLE_TIMEOUT_SECONDS = 10; - private static final int FORCE_KILL_TIMEOUT_SECONDS = 10; - - /** - * One-shot dispatcher used to run the owned-executor shutdown off any caller - * thread that might itself belong to that executor (e.g. the - * {@link #forceStop()} continuation, which is chained off async work scheduled - * on the internal executor). Spawning a fresh daemon thread guarantees - * {@link java.util.concurrent.ExecutorService#awaitTermination(long, TimeUnit)} - * is never called from inside the very executor it is waiting on. - */ - private static final Executor SHUTDOWN_DISPATCHER = runnable -> { - Thread t = new Thread(runnable, "copilot-client-shutdown"); - t.setDaemon(true); - t.start(); - }; - - private final CopilotClientOptions options; - private final Executor executor; - private final boolean executorCanBeShutdown; - private final CliServerManager serverManager; - private final LifecycleEventManager lifecycleManager = new LifecycleEventManager(); - private final Map sessions = new ConcurrentHashMap<>(); - private volatile CompletableFuture connectionFuture; - private volatile boolean disposed = false; - private final String optionsHost; - private final Integer optionsPort; - private final String effectiveConnectionToken; - private volatile List modelsCache; - private final Object modelsCacheLock = new Object(); - - /** - * Creates a new CopilotClient with default options. - */ - public CopilotClient() { - this(new CopilotClientOptions()); - } - - /** - * Creates a new CopilotClient with the specified options. - * - * @param options - * Options for creating the client - * @throws IllegalArgumentException - * if mutually exclusive options are provided - */ - public CopilotClient(CopilotClientOptions options) { - this.options = options != null ? options : new CopilotClientOptions(); - - // When cliUrl is set, auto-correct useStdio since we're connecting via TCP - if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()) { - this.options.setUseStdio(false); - } - - // Validate mutually exclusive options: cliUrl and cliPath cannot both be set - if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty() - && this.options.getCliPath() != null) { - throw new IllegalArgumentException("CliUrl is mutually exclusive with CliPath"); - } - - // Validate auth options with external server - if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty() - && (this.options.getGitHubToken() != null || this.options.getUseLoggedInUser().isPresent())) { - throw new IllegalArgumentException( - "GitHubToken and UseLoggedInUser cannot be used with CliUrl (external server manages its own auth)"); - } - - // Validate tcpConnectionToken - if (this.options.getTcpConnectionToken() != null) { - if (this.options.getTcpConnectionToken().isEmpty()) { - throw new IllegalArgumentException("TcpConnectionToken must be a non-empty string"); - } - if (this.options.isUseStdio()) { - throw new IllegalArgumentException("TcpConnectionToken cannot be used with UseStdio = true"); - } - } - - // Compute effective connection token: use provided, or auto-generate for - // SDK-spawned TCP mode, or null for stdio/external server - boolean sdkSpawnsCli = !this.options.isUseStdio() - && (this.options.getCliUrl() == null || this.options.getCliUrl().isEmpty()); - this.effectiveConnectionToken = this.options.getTcpConnectionToken() != null - ? this.options.getTcpConnectionToken() - : (sdkSpawnsCli ? java.util.UUID.randomUUID().toString() : null); - - // Empty mode: validate at construction time that the app supplied a - // per-session persistence location. - if (this.options.getMode() == CopilotClientMode.EMPTY) { - boolean hasPersistence = (this.options.getCopilotHome() != null && !this.options.getCopilotHome().isEmpty()) - || (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()); - if (!hasPersistence) { - throw new IllegalArgumentException( - "CopilotClient was created with Mode = EMPTY but neither CopilotHome nor CliUrl was set. " - + "Empty mode requires an explicit per-session persistence location."); - } - } - - // Parse CliUrl if provided - if (this.options.getCliUrl() != null && !this.options.getCliUrl().isEmpty()) { - URI uri = CliServerManager.parseCliUrl(this.options.getCliUrl()); - this.optionsHost = uri.getHost(); - this.optionsPort = uri.getPort(); - } else { - this.optionsHost = null; - this.optionsPort = null; - } - - InternalExecutorProvider executorProvider = new InternalExecutorProvider(this.options.getExecutor()); - this.executor = executorProvider.get(); - this.executorCanBeShutdown = executorProvider.canBeShutdown(); - - this.serverManager = new CliServerManager(this.options); - this.serverManager.setConnectionToken(this.effectiveConnectionToken); - } - - /** - * Starts the Copilot client and connects to the server. - * - * @return A future that completes when the connection is established - */ - public CompletableFuture start() { - if (connectionFuture == null) { - synchronized (this) { - if (connectionFuture == null) { - connectionFuture = startCore(); - } - } - } - return connectionFuture.thenApply(c -> null); - } - - private CompletableFuture startCore() { - LOG.fine("Starting Copilot client"); - - try { - return CompletableFuture.supplyAsync(this::startCoreBody, executor); - } catch (RejectedExecutionException e) { - return CompletableFuture.failedFuture(e); - } - } - - private Connection startCoreBody() { - Process process = null; - long startNanos = System.nanoTime(); - try { - JsonRpcClient rpc; - - if (optionsHost != null && optionsPort != null) { - // External server (TCP) - rpc = serverManager.connectToServer(null, optionsHost, optionsPort); - } else { - // Child process (stdio or TCP) - CliServerManager.ProcessInfo processInfo = serverManager.startCliServer(); - process = processInfo.process(); - rpc = serverManager.connectToServer(process, processInfo.port() != null ? "localhost" : null, - processInfo.port()); - } - - LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.start transport setup complete. Elapsed={Elapsed}", - startNanos); - - Connection connection = new Connection(rpc, process, new ServerRpc(rpc::invoke)); - - // Register handlers for server-to-client calls - RpcHandlerDispatcher dispatcher = new RpcHandlerDispatcher(sessions, lifecycleManager::dispatch, executor); - dispatcher.registerHandlers(rpc); - - // Verify protocol version - verifyProtocolVersion(connection); - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.start protocol verification complete. Elapsed={Elapsed}", startNanos); - - LoggingHelpers.logTiming(LOG, Level.FINE, "CopilotClient.start complete. Elapsed={Elapsed}", startNanos); - return connection; - } catch (Exception e) { - if (!(e instanceof java.util.concurrent.CancellationException)) { - LoggingHelpers.logTiming(LOG, Level.WARNING, e, "CopilotClient.start failed. Elapsed={Elapsed}", - startNanos); - } - // Clean up the spawned process if connection setup failed - if (process != null) { - cleanupCliProcess(process); - } - String stderr = serverManager.getStderrOutput(); - if (!stderr.isEmpty()) { - throw new CompletionException(new IOException( - CliServerManager.formatCliExitedMessage("CLI process exited unexpectedly.", stderr), e)); - } - throw new CompletionException(e); - } - } - - private static final int MIN_PROTOCOL_VERSION = 2; - private static final int METHOD_NOT_FOUND_ERROR_CODE = -32601; - - private void verifyProtocolVersion(Connection connection) throws Exception { - int expectedVersion = SdkProtocolVersion.get(); - Integer serverVersion; - - try { - // Try the new 'connect' RPC which supports connection tokens - var connectParams = new ConnectParams(effectiveConnectionToken); - var connectResponse = connection.rpc - .invoke("connect", connectParams, com.github.copilot.generated.rpc.ConnectResult.class) - .get(30, TimeUnit.SECONDS); - serverVersion = connectResponse.protocolVersion() != null - ? connectResponse.protocolVersion().intValue() - : null; - } catch (Exception e) { - // Unwrap CompletionException/ExecutionException to check inner cause - Throwable cause = e; - while (cause instanceof java.util.concurrent.ExecutionException || cause instanceof CompletionException) { - cause = cause.getCause(); - } - if (cause instanceof JsonRpcException rpcEx && isUnsupportedConnectMethod(rpcEx)) { - // Legacy server without 'connect'; fall back to 'ping'. - // A token, if any, is silently dropped — the legacy server can't enforce one. - var params = new HashMap(); - params.put("message", null); - PingResponse pingResponse = connection.rpc.invoke("ping", params, PingResponse.class).get(30, - TimeUnit.SECONDS); - serverVersion = pingResponse.protocolVersion(); - } else { - throw e; - } - } - - if (serverVersion == null) { - throw new RuntimeException("SDK protocol version mismatch: SDK supports versions " + MIN_PROTOCOL_VERSION - + "-" + expectedVersion + ", but server does not report a protocol version. " - + "Please update your server to ensure compatibility."); - } - - if (serverVersion < MIN_PROTOCOL_VERSION || serverVersion > expectedVersion) { - throw new RuntimeException("SDK protocol version mismatch: SDK supports versions " + MIN_PROTOCOL_VERSION - + "-" + expectedVersion + ", but server reports version " + serverVersion + ". " - + "Please update your SDK or server to ensure compatibility."); - } - } - - private static boolean isUnsupportedConnectMethod(JsonRpcException ex) { - return ex.getCode() == METHOD_NOT_FOUND_ERROR_CODE || "Unhandled method connect".equals(ex.getMessage()); - } - - /** - * Disconnects from the Copilot server and closes all active sessions. - *

    - * This method performs graceful cleanup: - *

      - *
    1. Closes all active sessions (releases in-memory resources)
      2. - *
    2. Closes the JSON-RPC connection
      3. - *
    3. Terminates the CLI server process (if spawned by this client)
      4. - *
    - *

    - * Note: session data on disk is preserved, so sessions can be resumed later. To - * permanently remove session data before stopping, call - * {@link #deleteSession(String)} for each session first. - * - * @return A future that completes when the client is stopped - */ - public CompletableFuture stop() { - var closeFutures = new ArrayList>(); - - for (CopilotSession session : new ArrayList<>(sessions.values())) { - Runnable closeTask = () -> { - try { - session.close(); - } catch (Exception e) { - LOG.log(Level.WARNING, "Error closing session " + session.getSessionId(), e); - } - }; - CompletableFuture future; - try { - future = CompletableFuture.runAsync(closeTask, executor); - } catch (RejectedExecutionException e) { - LOG.log(Level.WARNING, "Executor rejected session close task; closing inline", e); - closeTask.run(); - future = CompletableFuture.completedFuture(null); - } - closeFutures.add(future); - } - sessions.clear(); - - return CompletableFuture.allOf(closeFutures.toArray(new CompletableFuture[0])) - .thenCompose(v -> cleanupConnection()); - } - - /** - * Forces an immediate stop of the client without graceful cleanup. - * - * @return A future that completes when the client is stopped - */ - public CompletableFuture forceStop() { - disposed = true; - sessions.clear(); - // Dispatch the blocking shutdownOwnedExecutor() on a dedicated thread: - // cleanupConnection() is chained off async work running on the owned - // executor, so a plain whenComplete(...) here could land the awaitTermination - // call on one of the very threads it is waiting to drain, forcing the full - // AUTOCLOSEABLE_TIMEOUT_SECONDS timeout followed by shutdownNow(). - return cleanupConnection().whenCompleteAsync((ignored, error) -> shutdownOwnedExecutor(), SHUTDOWN_DISPATCHER); - } - - private CompletableFuture cleanupConnection() { - CompletableFuture future = connectionFuture; - connectionFuture = null; - - // Clear models cache - modelsCache = null; - - if (future == null) { - return CompletableFuture.completedFuture(null); - } - - return future.thenAccept(connection -> { - try { - connection.rpc.close(); - } catch (Exception e) { - LOG.log(Level.FINE, "Error closing RPC", e); - } - - if (connection.process != null) { - cleanupCliProcess(connection.process); - } - }).exceptionally(ex -> { - LOG.log(Level.FINE, "Ignoring failed Copilot client startup during cleanup", ex); - return null; - }); - } - - private static void cleanupCliProcess(Process process) { - try { - if (process.isAlive()) { - Process destroyedProcess = process.destroyForcibly(); - if (!destroyedProcess.waitFor(FORCE_KILL_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { - LOG.fine("Process did not terminate within force kill timeout"); - } - } - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); - LOG.log(Level.FINE, "Interrupted while killing process", e); - } catch (Exception e) { - LOG.log(Level.FINE, "Error killing process", e); - } - } - - /** - * Creates a new Copilot session with the specified configuration. - *

    - * The session maintains conversation state and can be used to send messages and - * receive responses. Remember to close the session when done. - *

    - * A permission handler is required when creating a session. Use - * {@link com.github.copilot.rpc.PermissionHandler#APPROVE_ALL} to approve all - * permission requests, or provide a custom handler to control permissions - * selectively. - * - *

    - * Example: - * - * 

    {@code
-     * var session = client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get();
-     * }
    - * - * @param config - * configuration for the session, including the required - * {@link SessionConfig#setOnPermissionRequest(com.github.copilot.rpc.PermissionHandler)} - * handler - * @return a future that resolves with the created CopilotSession - * @throws IllegalArgumentException - * if {@code config} is {@code null} or does not have a permission - * handler set - * @see SessionConfig - * @see com.github.copilot.rpc.PermissionHandler#APPROVE_ALL - */ - public CompletableFuture createSession(SessionConfig config) { - if (config == null || config.getOnPermissionRequest() == null) { - return CompletableFuture.failedFuture( - new IllegalArgumentException("An onPermissionRequest handler is required when creating a session. " - + "For example, to allow all permissions, use: " - + "new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); - } - return ensureConnected().thenCompose(connection -> { - long totalNanos = System.nanoTime(); - // For cloud sessions, let the CLI/server assign the session id - // and register the session lazily once the response arrives. For - // non-cloud sessions we generate the id client-side (when the - // caller didn't supply one) so the session can be registered - // BEFORE the RPC — the CLI may issue session-scoped requests - // (e.g. sessionFs.writeFile for workspace metadata) during - // session.create processing, before it has sent the response. - String callerSessionId = config.getSessionId(); - boolean useServerGeneratedId = config.getCloud() != null - && (callerSessionId == null || callerSessionId.isEmpty()); - String localSessionId = useServerGeneratedId - ? null - : (callerSessionId != null && !callerSessionId.isEmpty() - ? callerSessionId - : java.util.UUID.randomUUID().toString()); - - // Extract transform callbacks from the system message config. Callbacks - // are registered with the session; a wire-safe copy of the system - // message (with transform sections replaced by action="transform") is - // used in the RPC request. - var extracted = SessionRequestBuilder.extractTransformCallbacks(config.getSystemMessage()); - - // Creates the session, wires up handlers, and registers it in the - // sessions map. - java.util.function.Function initializeSession = sid -> { - long setupNanos = System.nanoTime(); - var s = new CopilotSession(sid, connection.rpc); - s.setExecutor(executor); - SessionRequestBuilder.configureSession(s, config); - if (extracted.transformCallbacks() != null) { - s.registerTransformCallbacks(extracted.transformCallbacks()); - } - sessions.put(sid, s); - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.createSession local setup complete. Elapsed={Elapsed}, SessionId=" + sid, - setupNanos); - return s; - }; - - String[] registeredIdHolder = new String[1]; - CopilotSession[] preRegisteredSessionHolder = new CopilotSession[1]; - - // Pre-register non-cloud sessions BEFORE issuing the RPC so any - // session-scoped requests the CLI emits during session.create - // processing can be routed to the correct handlers. - if (localSessionId != null) { - preRegisteredSessionHolder[0] = initializeSession.apply(localSessionId); - registeredIdHolder[0] = localSessionId; - } - - var request = SessionRequestBuilder.buildCreateRequest(config, localSessionId); - if (extracted.wireSystemMessage() != config.getSystemMessage()) { - request.setSystemMessage(extracted.wireSystemMessage()); - } - - // Empty mode: validate availableTools and set toolFilterPrecedence - if (options.getMode() == CopilotClientMode.EMPTY) { - if (config.getAvailableTools() == null) { - if (registeredIdHolder[0] != null) { - sessions.remove(registeredIdHolder[0]); - } - throw new IllegalArgumentException( - "CopilotClient is in Mode = EMPTY but the session config did not specify " - + "availableTools. Empty mode requires every session to explicitly opt into " - + "the tools it wants — e.g. setAvailableTools(new ToolSet().addBuiltIn(BuiltInTools.ISOLATED))."); - } - request.setToolFilterPrecedence("excluded"); - if (request.getSkipEmbeddingRetrieval() == null) { - request.setSkipEmbeddingRetrieval(true); - } - if (request.getEmbeddingCacheStorage() == null) { - request.setEmbeddingCacheStorage("in-memory"); - } - if (request.getEnableOnDemandInstructionDiscovery() == null) { - request.setEnableOnDemandInstructionDiscovery(false); - } - if (request.getEnableFileHooks() == null) { - request.setEnableFileHooks(false); - } - if (request.getEnableHostGitOperations() == null) { - request.setEnableHostGitOperations(false); - } - if (request.getEnableSessionStore() == null) { - request.setEnableSessionStore(false); - } - if (request.getEnableSkills() == null) { - request.setEnableSkills(false); - } - if (request.getMcpOAuthTokenStorage() == null) { - request.setMcpOAuthTokenStorage("in-memory"); - } - } - - long rpcNanos = System.nanoTime(); - return connection.rpc.invoke("session.create", request, CreateSessionResponse.class) - .thenCompose(response -> { - String returnedId = response.sessionId(); - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.createSession session creation request completed. Elapsed={Elapsed}, SessionId=" - + (returnedId != null ? returnedId : localSessionId), - rpcNanos); - if (returnedId == null || returnedId.isEmpty()) { - throw new RuntimeException("session.create response did not include a sessionId"); - } - if (localSessionId != null && !localSessionId.equals(returnedId)) { - throw new RuntimeException("session.create returned sessionId " + returnedId - + " but the caller requested " + localSessionId); - } - CopilotSession session = preRegisteredSessionHolder[0] != null - ? preRegisteredSessionHolder[0] - : initializeSession.apply(returnedId); - registeredIdHolder[0] = returnedId; - session.setWorkspacePath(response.workspacePath()); - session.setCapabilities(response.capabilities()); - - return updateSessionOptionsForMode(session, config.getSkipCustomInstructions().orElse(null), - config.getCustomAgentsLocalOnly().orElse(null), - config.getCoauthorEnabled().orElse(null), - config.getManageScheduleEnabled().orElse(null)).thenApply(v -> { - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.createSession complete. Elapsed={Elapsed}, SessionId=" - + session.getSessionId(), - totalNanos); - return session; - }); - }).exceptionally(ex -> { - if (registeredIdHolder[0] != null) { - sessions.remove(registeredIdHolder[0]); - } - LoggingHelpers.logTiming(LOG, Level.WARNING, ex, - "CopilotClient.createSession failed. Elapsed={Elapsed}, SessionId=" - + (registeredIdHolder[0] != null ? registeredIdHolder[0] : ""), - totalNanos); - throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); - }); - }); - } - - /** - * Resumes an existing Copilot session. - *

    - * This restores a previously saved session, allowing you to continue a - * conversation. The session's history is preserved. - *

    - * A permission handler is required when resuming a session. Use - * {@link com.github.copilot.rpc.PermissionHandler#APPROVE_ALL} to approve all - * permission requests, or provide a custom handler to control permissions - * selectively. - * - * @param sessionId - * the ID of the session to resume - * @param config - * configuration for the resumed session, including the required - * {@link ResumeSessionConfig#setOnPermissionRequest(com.github.copilot.rpc.PermissionHandler)} - * handler - * @return a future that resolves with the resumed CopilotSession - * @throws IllegalArgumentException - * if {@code config} is {@code null} or does not have a permission - * handler set - * @see #listSessions() - * @see #getLastSessionId() - * @see com.github.copilot.rpc.PermissionHandler#APPROVE_ALL - */ - public CompletableFuture resumeSession(String sessionId, ResumeSessionConfig config) { - if (config == null || config.getOnPermissionRequest() == null) { - return CompletableFuture.failedFuture( - new IllegalArgumentException("An onPermissionRequest handler is required when resuming a session. " - + "For example, to allow all permissions, use: " - + "new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)")); - } - return ensureConnected().thenCompose(connection -> { - long totalNanos = System.nanoTime(); - // Register the session before the RPC call to avoid missing early events. - long setupNanos = System.nanoTime(); - var session = new CopilotSession(sessionId, connection.rpc); - session.setExecutor(executor); - SessionRequestBuilder.configureSession(session, config); - sessions.put(sessionId, session); - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.resumeSession local setup complete. Elapsed={Elapsed}, SessionId=" + sessionId, - setupNanos); - - // Extract transform callbacks from the system message config. - var extracted = SessionRequestBuilder.extractTransformCallbacks(config.getSystemMessage()); - if (extracted.transformCallbacks() != null) { - session.registerTransformCallbacks(extracted.transformCallbacks()); - } - - var request = SessionRequestBuilder.buildResumeRequest(sessionId, config); - if (extracted.wireSystemMessage() != config.getSystemMessage()) { - request.setSystemMessage(extracted.wireSystemMessage()); - } - - // Empty mode: validate availableTools and set toolFilterPrecedence for resume - // path - if (options.getMode() == CopilotClientMode.EMPTY) { - if (config.getAvailableTools() == null) { - throw new IllegalArgumentException( - "CopilotClient is in Mode = EMPTY but the resume session config did not specify " - + "availableTools. Empty mode requires every session to explicitly opt into " - + "the tools it wants — e.g. setAvailableTools(new ToolSet().addBuiltIn(BuiltInTools.ISOLATED))."); - } - request.setToolFilterPrecedence("excluded"); - if (request.getSkipEmbeddingRetrieval() == null) { - request.setSkipEmbeddingRetrieval(true); - } - if (request.getEmbeddingCacheStorage() == null) { - request.setEmbeddingCacheStorage("in-memory"); - } - if (request.getEnableOnDemandInstructionDiscovery() == null) { - request.setEnableOnDemandInstructionDiscovery(false); - } - if (request.getEnableFileHooks() == null) { - request.setEnableFileHooks(false); - } - if (request.getEnableHostGitOperations() == null) { - request.setEnableHostGitOperations(false); - } - if (request.getEnableSessionStore() == null) { - request.setEnableSessionStore(false); - } - if (request.getEnableSkills() == null) { - request.setEnableSkills(false); - } - if (request.getMcpOAuthTokenStorage() == null) { - request.setMcpOAuthTokenStorage("in-memory"); - } - } - - long rpcNanos = System.nanoTime(); - return connection.rpc.invoke("session.resume", request, ResumeSessionResponse.class) - .thenCompose(response -> { - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.resumeSession session resume request completed. Elapsed={Elapsed}, SessionId=" - + sessionId, - rpcNanos); - session.setWorkspacePath(response.workspacePath()); - session.setCapabilities(response.capabilities()); - // If the server returned a different sessionId than what was requested, - // re-key. - String returnedId = response.sessionId(); - if (returnedId != null && !returnedId.equals(sessionId)) { - sessions.remove(sessionId); - session.setActiveSessionId(returnedId); - sessions.put(returnedId, session); - } - - return updateSessionOptionsForMode(session, config.getSkipCustomInstructions().orElse(null), - config.getCustomAgentsLocalOnly().orElse(null), - config.getCoauthorEnabled().orElse(null), - config.getManageScheduleEnabled().orElse(null)).thenApply(v -> { - LoggingHelpers.logTiming(LOG, Level.FINE, - "CopilotClient.resumeSession complete. Elapsed={Elapsed}, SessionId=" - + sessionId, - totalNanos); - return session; - }); - }).exceptionally(ex -> { - sessions.remove(sessionId); - // Also remove the re-keyed entry if the server returned a different ID - String activeId = session.getSessionId(); - if (!sessionId.equals(activeId)) { - sessions.remove(activeId); - } - LoggingHelpers.logTiming(LOG, Level.WARNING, ex, - "CopilotClient.resumeSession failed. Elapsed={Elapsed}, SessionId=" + sessionId, - totalNanos); - throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); - }); - }); - } - - /** - * Applies the post-create / post-resume {@code session.options.update} patch. - *

    - * In {@link CopilotClientMode#EMPTY EMPTY} mode this defaults the four - * overridable feature flags to safe values (caller values from the config win); - * {@code installedPlugins=[]} is unconditional under empty mode so apps that - * need plugins must switch modes. In {@link CopilotClientMode#COPILOT_CLI - * COPILOT_CLI} mode only explicitly-set fields are forwarded. - * - * @param session - * the session to patch - * @param skipCustomInstructions - * caller-supplied value, or {@code null} if not set - * @param customAgentsLocalOnly - * caller-supplied value, or {@code null} if not set - * @param coauthorEnabled - * caller-supplied value, or {@code null} if not set - * @param manageScheduleEnabled - * caller-supplied value, or {@code null} if not set - * @return a future that completes when the patch has been applied - */ - CompletableFuture updateSessionOptionsForMode(CopilotSession session, Boolean skipCustomInstructions, - Boolean customAgentsLocalOnly, Boolean coauthorEnabled, Boolean manageScheduleEnabled) { - - Boolean patchSkip = null; - Boolean patchAgents = null; - Boolean patchCoauthor = null; - Boolean patchSchedule = null; - List patchPlugins = null; - boolean hasAnyPatch = false; - - if (options.getMode() == CopilotClientMode.EMPTY) { - patchSkip = skipCustomInstructions != null ? skipCustomInstructions : true; - patchAgents = customAgentsLocalOnly != null ? customAgentsLocalOnly : true; - patchCoauthor = coauthorEnabled != null ? coauthorEnabled : false; - patchSchedule = manageScheduleEnabled != null ? manageScheduleEnabled : false; - patchPlugins = List.of(); - hasAnyPatch = true; - } else { - if (skipCustomInstructions != null) { - patchSkip = skipCustomInstructions; - hasAnyPatch = true; - } - if (customAgentsLocalOnly != null) { - patchAgents = customAgentsLocalOnly; - hasAnyPatch = true; - } - if (coauthorEnabled != null) { - patchCoauthor = coauthorEnabled; - hasAnyPatch = true; - } - if (manageScheduleEnabled != null) { - patchSchedule = manageScheduleEnabled; - hasAnyPatch = true; - } - } - - if (!hasAnyPatch) { - return CompletableFuture.completedFuture(null); - } - - var params = new SessionOptionsUpdateParams(null, // sessionId — set by SessionOptionsApi - null, // model - null, // reasoningEffort - null, // clientName - null, // lspClientName - null, // integrationId - null, // featureFlags - null, // isExperimentalMode - null, // provider - null, // workingDirectory - null, // availableTools - null, // excludedTools - null, // toolFilterPrecedence - null, // enableScriptSafety - null, // shellInitProfile - null, // shellProcessFlags - null, // sandboxConfig - null, // logInteractiveShells - null, // envValueMode - null, // skillDirectories - null, // disabledSkills - null, // enableOnDemandInstructionDiscovery - patchPlugins, // installedPlugins - patchAgents, // customAgentsLocalOnly - patchSkip, // skipCustomInstructions - null, // disabledInstructionSources - patchCoauthor, // coauthorEnabled - null, // trajectoryFile - null, // enableStreaming - null, // copilotUrl - null, // askUserDisabled - null, // continueOnAutoMode - null, // runningInInteractiveMode - null, // enableReasoningSummaries - null, // agentContext - null, // eventsLogDirectory - null, // additionalContentExclusionPolicies - patchSchedule // manageScheduleEnabled - ); - - return session.getRpc().options.update(params).thenCompose(result -> { - LOG.fine("session.options.update applied for session " + session.getSessionId()); - return CompletableFuture.completedFuture(null); - }).exceptionally(ex -> { - // The runtime session exists but the post-create options patch failed. - // Best-effort disconnect so we don't leak it (in empty mode it would - // otherwise stay alive with permissive defaults). - LOG.log(Level.WARNING, "session.options.update failed for session " + session.getSessionId(), ex); - sessions.remove(session.getSessionId()); - try { - session.close(); - } catch (Exception closeEx) { - // Swallow: original error is the one the caller needs. - } - throw ex instanceof RuntimeException re ? re : new RuntimeException(ex); - }); - } - - /** - * Gets the current connection state. - * - * @return the current connection state - * @see ConnectionState - */ - public ConnectionState getState() { - if (connectionFuture == null) - return ConnectionState.DISCONNECTED; - if (connectionFuture.isCompletedExceptionally()) - return ConnectionState.ERROR; - if (!connectionFuture.isDone()) - return ConnectionState.CONNECTING; - return ConnectionState.CONNECTED; - } - - /** - * Returns the typed RPC client for server-level methods. - *

    - * Provides strongly-typed access to all server-level API namespaces such as - * {@code models}, {@code tools}, {@code account}, and {@code mcp}. - *

    - * Example usage: - * - * 

    {@code
-     * client.start().get();
-     * var models = client.getRpc().models.list().get();
-     * }
    - * - * @return the server-level typed RPC client - * @throws IllegalStateException - * if the client is not connected; call {@link #start()} first - * @since 1.0.0 - */ - public ServerRpc getRpc() { - CompletableFuture future = connectionFuture; - if (future == null || !future.isDone() || future.isCompletedExceptionally()) { - throw new IllegalStateException("Client not connected; call start() first"); - } - return future.join().serverRpc(); - } - - /** - * Pings the server to check connectivity. - *

    - * This can be used to verify that the server is responsive and to check the - * protocol version. - * - * @param message - * an optional message to echo back - * @return a future that resolves with the ping response - * @see PingResponse - */ - public CompletableFuture ping(String message) { - return ensureConnected().thenCompose(connection -> connection.rpc.invoke("ping", - Map.of("message", message != null ? message : ""), PingResponse.class)); - } - - /** - * Gets CLI status including version and protocol information. - * - * @return a future that resolves with the status response containing version - * and protocol version - * @see GetStatusResponse - */ - public CompletableFuture getStatus() { - return ensureConnected() - .thenCompose(connection -> connection.rpc.invoke("status.get", Map.of(), GetStatusResponse.class)); - } - - /** - * Gets current authentication status. - * - * @return a future that resolves with the authentication status - * @see GetAuthStatusResponse - */ - public CompletableFuture getAuthStatus() { - return ensureConnected().thenCompose( - connection -> connection.rpc.invoke("auth.getStatus", Map.of(), GetAuthStatusResponse.class)); - } - - /** - * Lists available models with their metadata. - *

    - * Results are cached after the first successful call to avoid rate limiting. - * The cache is cleared when the client disconnects. - *

    - * If an {@code onListModels} handler was provided in - * {@link com.github.copilot.rpc.CopilotClientOptions}, it is called instead of - * querying the CLI server. This is useful in BYOK mode. - * - * @return a future that resolves with a list of available models - * @see ModelInfo - */ - public CompletableFuture> listModels() { - // Check cache first - List cached = modelsCache; - if (cached != null) { - return CompletableFuture.completedFuture(new ArrayList<>(cached)); - } - - // If a custom handler is configured, use it instead of querying the CLI server - var onListModels = options.getOnListModels(); - if (onListModels != null) { - synchronized (modelsCacheLock) { - if (modelsCache != null) { - return CompletableFuture.completedFuture(new ArrayList<>(modelsCache)); - } - } - return onListModels.get().thenApply(models -> { - synchronized (modelsCacheLock) { - modelsCache = models; - } - return new ArrayList<>(models); - }); - } - - return ensureConnected().thenCompose(connection -> { - // Double-check cache inside lock - synchronized (modelsCacheLock) { - if (modelsCache != null) { - return CompletableFuture.completedFuture(new ArrayList<>(modelsCache)); - } - } - - return connection.rpc.invoke("models.list", Map.of(), GetModelsResponse.class).thenApply(response -> { - List models = response.getModels(); - synchronized (modelsCacheLock) { - modelsCache = models; - } - return new ArrayList<>(models); // Return a copy to prevent cache mutation - }); - }); - } - - /** - * Gets the ID of the most recently used session. - *

    - * This is useful for resuming the last conversation without needing to list all - * sessions. - * - * @return a future that resolves with the last session ID, or {@code null} if - * no sessions exist - * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) - */ - public CompletableFuture getLastSessionId() { - return ensureConnected().thenCompose( - connection -> connection.rpc.invoke("session.getLastId", Map.of(), GetLastSessionIdResponse.class) - .thenApply(GetLastSessionIdResponse::sessionId)); - } - - /** - * Permanently deletes a session and all its data from disk, including - * conversation history, planning state, and artifacts. - *

    - * Unlike {@link CopilotSession#close()}, which only releases in-memory - * resources and preserves session data for later resumption, this method is - * irreversible. The session cannot be resumed after deletion. - * - * @param sessionId - * the ID of the session to delete - * @return a future that completes when the session is deleted - * @throws RuntimeException - * if the deletion fails - */ - public CompletableFuture deleteSession(String sessionId) { - return ensureConnected().thenCompose(connection -> connection.rpc - .invoke("session.delete", Map.of("sessionId", sessionId), DeleteSessionResponse.class) - .thenAccept(response -> { - if (!response.success()) { - throw new RuntimeException("Failed to delete session " + sessionId + ": " + response.error()); - } - sessions.remove(sessionId); - })); - } - - /** - * Lists all available sessions. - *

    - * Returns metadata about all sessions that can be resumed, including their IDs, - * start times, and summaries. - * - * @return a future that resolves with a list of session metadata - * @see SessionMetadata - * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) - */ - public CompletableFuture> listSessions() { - return listSessions(null); - } - - /** - * Lists all available sessions with optional filtering. - *

    - * Returns metadata about all sessions that can be resumed, including their IDs, - * start times, summaries, and context information. Use the filter parameter to - * narrow down sessions by working directory, git repository, or branch. - * - *

    Example Usage

    - * - * 
    {@code
-     * // List all sessions
-     * var allSessions = client.listSessions().get();
-     *
-     * // Filter by repository
-     * var filter = new SessionListFilter().setRepository("owner/repo");
-     * var repoSessions = client.listSessions(filter).get();
-     * }
    - * - * @param filter - * optional filter to narrow down sessions by context fields, or - * {@code null} to list all sessions - * @return a future that resolves with a list of session metadata - * @see SessionMetadata - * @see SessionListFilter - * @see #resumeSession(String, com.github.copilot.rpc.ResumeSessionConfig) - */ - public CompletableFuture> listSessions(SessionListFilter filter) { - return ensureConnected().thenCompose(connection -> { - Map params = filter != null ? Map.of("filter", filter) : Map.of(); - return connection.rpc.invoke("session.list", params, ListSessionsResponse.class) - .thenApply(ListSessionsResponse::sessions); - }); - } - - /** - * Gets metadata for a specific session by ID. - *

    - * This provides an efficient O(1) lookup of a single session's metadata instead - * of listing all sessions. - * - *

    Example Usage

    - * - * 
    {@code
-     * var metadata = client.getSessionMetadata("session-123").get();
-     * if (metadata != null) {
-     * 	System.out.println("Session started at: " + metadata.getStartTime());
-     * }
-     * }
    - * - * @param sessionId - * the ID of the session to look up - * @return a future that resolves with the {@link SessionMetadata}, or - * {@code null} if the session was not found - * @see SessionMetadata - * @since 1.0.0 - */ - public CompletableFuture getSessionMetadata(String sessionId) { - return ensureConnected().thenCompose(connection -> connection.rpc - .invoke("session.getMetadata", Map.of("sessionId", sessionId), GetSessionMetadataResponse.class) - .thenApply(GetSessionMetadataResponse::session)); - } - - /** - * Gets the ID of the session currently displayed in the TUI. - *

    - * This is only available when connecting to a server running in TUI+server mode - * (--ui-server). - * - * @return a future that resolves with the session ID, or null if no foreground - * session is set - */ - public CompletableFuture getForegroundSessionId() { - return ensureConnected().thenCompose(connection -> connection.rpc - .invoke("session.getForeground", Map.of(), com.github.copilot.rpc.GetForegroundSessionResponse.class) - .thenApply(com.github.copilot.rpc.GetForegroundSessionResponse::sessionId)); - } - - /** - * Requests the TUI to switch to displaying the specified session. - *

    - * This is only available when connecting to a server running in TUI+server mode - * (--ui-server). - * - * @param sessionId - * the ID of the session to display in the TUI - * @return a future that completes when the operation is done - * @throws RuntimeException - * if the operation fails - */ - public CompletableFuture setForegroundSessionId(String sessionId) { - return ensureConnected().thenCompose(connection -> connection.rpc - .invoke("session.setForeground", new com.github.copilot.rpc.SetForegroundSessionRequest(sessionId), - com.github.copilot.rpc.SetForegroundSessionResponse.class) - .thenAccept(response -> { - if (!response.success()) { - throw new RuntimeException( - response.error() != null ? response.error() : "Failed to set foreground session"); - } - })); - } - - /** - * Subscribes to all session lifecycle events. - *

    - * Lifecycle events are emitted when sessions are created, deleted, updated, or - * change foreground/background state (in TUI+server mode). - * - * @param handler - * a callback that receives lifecycle events - * @return an AutoCloseable that, when closed, unsubscribes the handler - */ - public AutoCloseable onLifecycle(SessionLifecycleHandler handler) { - return lifecycleManager.subscribe(handler); - } - - /** - * Subscribes to a specific session lifecycle event type. - * - * @param eventType - * the event type to listen for (use - * {@link com.github.copilot.rpc.SessionLifecycleEventTypes} - * constants) - * @param handler - * a callback that receives events of the specified type - * @return an AutoCloseable that, when closed, unsubscribes the handler - */ - public AutoCloseable onLifecycle(String eventType, SessionLifecycleHandler handler) { - return lifecycleManager.subscribe(eventType, handler); - } - - private CompletableFuture ensureConnected() { - if (connectionFuture == null && !options.isAutoStart()) { - throw new IllegalStateException("Client not connected. Call start() first."); - } - - start(); - return connectionFuture; - } - - /** - * Closes this client using graceful shutdown semantics. - *

    - * This method is intended for {@code try-with-resources} usage and blocks while - * waiting for {@link #stop()} to complete, up to - * {@link #AUTOCLOSEABLE_TIMEOUT_SECONDS} seconds. If shutdown fails or times - * out, the error is logged at {@link Level#FINE} and the method returns. - *

    - * This method is idempotent. - * - * @see #stop() - * @see #forceStop() - * @see #AUTOCLOSEABLE_TIMEOUT_SECONDS - */ - @Override - public void close() { - if (disposed) - return; - disposed = true; - try { - stop().get(AUTOCLOSEABLE_TIMEOUT_SECONDS, TimeUnit.SECONDS); - } catch (Exception e) { - LOG.log(Level.FINE, "Error during close", e); - } finally { - shutdownOwnedExecutor(); - } - } - - private void shutdownOwnedExecutor() { - if (!executorCanBeShutdown) { - return; - } - - ExecutorService serviceToShutdown = executor instanceof ExecutorService es ? es : null; - if (serviceToShutdown == null) { - LOG.log(Level.FINE, "Executor is not an ExecutorService; skipping shutdown"); - return; - } - - // Short-circuit when the owned executor is already shut down. close() and - // forceStop() can each call this method (e.g. forceStop() invoked before a - // subsequent close() in user code), and re-entering shutdown() + - // awaitTermination() - // is redundant. Logging at FINE aids diagnostics without spamming normal - // output. - if (serviceToShutdown.isShutdown()) { - LOG.log(Level.FINE, "Owned executor was already shut down; skipping redundant shutdown call."); - return; - } - - serviceToShutdown.shutdown(); - try { - if (!serviceToShutdown.awaitTermination(AUTOCLOSEABLE_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { - LOG.log(Level.FINE, "Owned executor did not terminate within {0} seconds; forcing shutdown.", - AUTOCLOSEABLE_TIMEOUT_SECONDS); - serviceToShutdown.shutdownNow(); - } - } catch (InterruptedException e) { - serviceToShutdown.shutdownNow(); - Thread.currentThread().interrupt(); - LOG.log(Level.FINE, "Interrupted while waiting for owned executor to terminate", e); - } - } - - private static record Connection(JsonRpcClient rpc, Process process, ServerRpc serverRpc) { - }; - -} diff --git a/java/src/main/java/com/github/copilot/SessionRequestBuilder.java b/java/src/main/java/com/github/copilot/SessionRequestBuilder.java deleted file mode 100644 index ded92a506..000000000 --- a/java/src/main/java/com/github/copilot/SessionRequestBuilder.java +++ /dev/null @@ -1,376 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import java.util.HashMap; -import java.util.Map; -import java.util.concurrent.CompletableFuture; -import java.util.function.Function; - -import com.github.copilot.rpc.CreateSessionRequest; -import com.github.copilot.rpc.CommandWireDefinition; -import com.github.copilot.rpc.ResumeSessionConfig; -import com.github.copilot.rpc.ResumeSessionRequest; -import com.github.copilot.rpc.SectionOverride; -import com.github.copilot.rpc.SectionOverrideAction; -import com.github.copilot.rpc.SessionConfig; -import com.github.copilot.rpc.SystemMessageConfig; - -/** - * Builds JSON-RPC request objects from session configuration. - *

    - * This class handles the conversion of SDK configuration objects - * ({@link SessionConfig}, {@link ResumeSessionConfig}) to JSON-RPC request - * objects for session creation and resumption. - */ -final class SessionRequestBuilder { - - private SessionRequestBuilder() { - // Utility class - } - - /** - * Extracts transform callbacks from a {@link SystemMessageConfig} and returns a - * wire-safe copy of the config alongside the extracted callbacks. - *

    - * When the system message mode is {@link SystemMessageMode#CUSTOMIZE} and some - * sections have {@link SectionOverride#getTransform() transform} callbacks set, - * this method: - *

      - *
    1. Removes the callbacks from the wire config (they must not be - * serialized).
      2. - *
    2. Replaces each transform section with - * {@link SectionOverrideAction#TRANSFORM} in the wire config.
      3. - *
    3. Returns the callbacks so they can be registered with the session.
      4. - *
    - * - * @param systemMessage - * the system message config, may be {@code null} - * @return an {@link ExtractedTransforms} containing the wire-safe config and - * any extracted callbacks - */ - static ExtractedTransforms extractTransformCallbacks(SystemMessageConfig systemMessage) { - if (systemMessage == null || systemMessage.getMode() != SystemMessageMode.CUSTOMIZE - || systemMessage.getSections() == null) { - return new ExtractedTransforms(systemMessage, null); - } - - Map>> callbacks = new HashMap<>(); - Map wireSections = new HashMap<>(); - - for (Map.Entry entry : systemMessage.getSections().entrySet()) { - String sectionId = entry.getKey(); - SectionOverride override = entry.getValue(); - - if (override.getTransform() != null) { - callbacks.put(sectionId, override.getTransform()); - wireSections.put(sectionId, new SectionOverride().setAction(SectionOverrideAction.TRANSFORM)); - } else { - wireSections.put(sectionId, override); - } - } - - if (callbacks.isEmpty()) { - return new ExtractedTransforms(systemMessage, null); - } - - // Build a wire-safe copy of the system message with callbacks removed - var wireConfig = new SystemMessageConfig().setMode(systemMessage.getMode()) - .setContent(systemMessage.getContent()).setSections(wireSections); - - return new ExtractedTransforms(wireConfig, callbacks); - } - - /** - * Builds a CreateSessionRequest from the given configuration. - * - * @param config - * the session configuration (may be null) - * @param sessionId - * the pre-generated session ID to use - * @return the built request object - */ - static CreateSessionRequest buildCreateRequest(SessionConfig config, String sessionId) { - var request = new CreateSessionRequest(); - // Always request permission callbacks to enable deny-by-default behavior - request.setRequestPermission(true); - // Always send envValueMode=direct for MCP servers - request.setEnvValueMode("direct"); - request.setSessionId(sessionId); - if (config == null) { - return request; - } - - request.setModel(config.getModel()); - request.setClientName(config.getClientName()); - request.setReasoningEffort(config.getReasoningEffort()); - request.setReasoningSummary(config.getReasoningSummary()); - request.setContextTier(config.getContextTier()); - request.setTools(config.getTools()); - request.setSystemMessage(config.getSystemMessage()); - request.setAvailableTools(config.getAvailableTools()); - request.setExcludedTools(config.getExcludedTools()); - request.setProvider(config.getProvider()); - config.getEnableSessionTelemetry().ifPresent(request::setEnableSessionTelemetry); - if (config.getOnUserInputRequest() != null) { - request.setRequestUserInput(true); - } - if (config.getHooks() != null && config.getHooks().hasHooks()) { - request.setHooks(true); - } - request.setWorkingDirectory(config.getWorkingDirectory()); - if (config.isStreaming()) { - request.setStreaming(true); - } - config.getIncludeSubAgentStreamingEvents().ifPresent(request::setIncludeSubAgentStreamingEvents); - request.setMcpServers(config.getMcpServers()); - request.setMcpOAuthTokenStorage(config.getMcpOAuthTokenStorage()); - request.setCustomAgents(config.getCustomAgents()); - request.setDefaultAgent(config.getDefaultAgent()); - request.setAgent(config.getAgent()); - request.setInfiniteSessions(config.getInfiniteSessions()); - request.setSkillDirectories(config.getSkillDirectories()); - request.setInstructionDirectories(config.getInstructionDirectories()); - request.setPluginDirectories(config.getPluginDirectories()); - request.setLargeOutput(config.getLargeOutput()); - request.setDisabledSkills(config.getDisabledSkills()); - request.setConfigDirectory(config.getConfigDirectory()); - config.getEnableConfigDiscovery().ifPresent(request::setEnableConfigDiscovery); - config.getSkipEmbeddingRetrieval().ifPresent(request::setSkipEmbeddingRetrieval); - if (config.getOrganizationCustomInstructions() != null) { - request.setOrganizationCustomInstructions(config.getOrganizationCustomInstructions()); - } - config.getEnableOnDemandInstructionDiscovery().ifPresent(request::setEnableOnDemandInstructionDiscovery); - config.getEnableFileHooks().ifPresent(request::setEnableFileHooks); - config.getEnableHostGitOperations().ifPresent(request::setEnableHostGitOperations); - config.getEnableSessionStore().ifPresent(request::setEnableSessionStore); - config.getEnableSkills().ifPresent(request::setEnableSkills); - if (config.getEmbeddingCacheStorage() != null) { - request.setEmbeddingCacheStorage(config.getEmbeddingCacheStorage()); - } - request.setModelCapabilities(config.getModelCapabilities()); - - if (config.getCommands() != null && !config.getCommands().isEmpty()) { - var wireCommands = config.getCommands().stream() - .map(c -> new CommandWireDefinition(c.getName(), c.getDescription())) - .collect(java.util.stream.Collectors.toList()); - request.setCommands(wireCommands); - } - if (config.getOnElicitationRequest() != null) { - request.setRequestElicitation(true); - } - if (config.isEnableMcpApps()) { - request.setRequestMcpApps(true); - } - if (config.getOnExitPlanMode() != null) { - request.setRequestExitPlanMode(true); - } - if (config.getOnAutoModeSwitch() != null) { - request.setRequestAutoModeSwitch(true); - } - request.setGitHubToken(config.getGitHubToken()); - request.setRemoteSession(config.getRemoteSession()); - request.setCloud(config.getCloud()); - - return request; - } - - /** - * Builds a CreateSessionRequest from the given configuration. - * - * @param config - * the session configuration (may be null) - * @return the built request object - * @deprecated Use {@link #buildCreateRequest(SessionConfig, String)} instead. - */ - @Deprecated - static CreateSessionRequest buildCreateRequest(SessionConfig config) { - String sessionId = (config != null && config.getSessionId() != null) - ? config.getSessionId() - : java.util.UUID.randomUUID().toString(); - return buildCreateRequest(config, sessionId); - } - - /** - * Builds a ResumeSessionRequest from the given session ID and configuration. - * - * @param sessionId - * the ID of the session to resume - * @param config - * the resume configuration (may be null) - * @return the built request object - */ - static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionConfig config) { - var request = new ResumeSessionRequest(); - request.setSessionId(sessionId); - // Always request permission callbacks to enable deny-by-default behavior - request.setRequestPermission(true); - // Always send envValueMode=direct for MCP servers - request.setEnvValueMode("direct"); - - if (config == null) { - return request; - } - - request.setModel(config.getModel()); - request.setClientName(config.getClientName()); - request.setReasoningEffort(config.getReasoningEffort()); - request.setReasoningSummary(config.getReasoningSummary()); - request.setContextTier(config.getContextTier()); - request.setTools(config.getTools()); - request.setSystemMessage(config.getSystemMessage()); - request.setAvailableTools(config.getAvailableTools()); - request.setExcludedTools(config.getExcludedTools()); - request.setProvider(config.getProvider()); - config.getEnableSessionTelemetry().ifPresent(request::setEnableSessionTelemetry); - if (config.getOnUserInputRequest() != null) { - request.setRequestUserInput(true); - } - if (config.getHooks() != null && config.getHooks().hasHooks()) { - request.setHooks(true); - } - request.setWorkingDirectory(config.getWorkingDirectory()); - request.setConfigDirectory(config.getConfigDirectory()); - config.getEnableConfigDiscovery().ifPresent(request::setEnableConfigDiscovery); - config.getSkipEmbeddingRetrieval().ifPresent(request::setSkipEmbeddingRetrieval); - if (config.getOrganizationCustomInstructions() != null) { - request.setOrganizationCustomInstructions(config.getOrganizationCustomInstructions()); - } - config.getEnableOnDemandInstructionDiscovery().ifPresent(request::setEnableOnDemandInstructionDiscovery); - config.getEnableFileHooks().ifPresent(request::setEnableFileHooks); - config.getEnableHostGitOperations().ifPresent(request::setEnableHostGitOperations); - config.getEnableSessionStore().ifPresent(request::setEnableSessionStore); - config.getEnableSkills().ifPresent(request::setEnableSkills); - if (config.getEmbeddingCacheStorage() != null) { - request.setEmbeddingCacheStorage(config.getEmbeddingCacheStorage()); - } - if (config.isDisableResume()) { - request.setDisableResume(true); - } - if (config.isStreaming()) { - request.setStreaming(true); - } - config.getIncludeSubAgentStreamingEvents().ifPresent(request::setIncludeSubAgentStreamingEvents); - request.setMcpServers(config.getMcpServers()); - request.setMcpOAuthTokenStorage(config.getMcpOAuthTokenStorage()); - request.setCustomAgents(config.getCustomAgents()); - request.setDefaultAgent(config.getDefaultAgent()); - request.setAgent(config.getAgent()); - request.setSkillDirectories(config.getSkillDirectories()); - request.setInstructionDirectories(config.getInstructionDirectories()); - request.setPluginDirectories(config.getPluginDirectories()); - request.setLargeOutput(config.getLargeOutput()); - request.setDisabledSkills(config.getDisabledSkills()); - request.setInfiniteSessions(config.getInfiniteSessions()); - request.setModelCapabilities(config.getModelCapabilities()); - - if (config.getCommands() != null && !config.getCommands().isEmpty()) { - var wireCommands = config.getCommands().stream() - .map(c -> new CommandWireDefinition(c.getName(), c.getDescription())) - .collect(java.util.stream.Collectors.toList()); - request.setCommands(wireCommands); - } - if (config.getOnElicitationRequest() != null) { - request.setRequestElicitation(true); - } - if (config.isEnableMcpApps()) { - request.setRequestMcpApps(true); - } - if (config.getOnExitPlanMode() != null) { - request.setRequestExitPlanMode(true); - } - if (config.getOnAutoModeSwitch() != null) { - request.setRequestAutoModeSwitch(true); - } - request.setGitHubToken(config.getGitHubToken()); - request.setRemoteSession(config.getRemoteSession()); - - return request; - } - - /** - * Configures a session with handlers from the given config. - * - * @param session - * the session to configure - * @param config - * the session configuration - */ - static void configureSession(CopilotSession session, SessionConfig config) { - if (config == null) { - return; - } - - if (config.getTools() != null) { - session.registerTools(config.getTools()); - } - if (config.getOnPermissionRequest() != null) { - session.registerPermissionHandler(config.getOnPermissionRequest()); - } - if (config.getOnUserInputRequest() != null) { - session.registerUserInputHandler(config.getOnUserInputRequest()); - } - if (config.getHooks() != null) { - session.registerHooks(config.getHooks()); - } - if (config.getCommands() != null) { - session.registerCommands(config.getCommands()); - } - if (config.getOnElicitationRequest() != null) { - session.registerElicitationHandler(config.getOnElicitationRequest()); - } - if (config.getOnExitPlanMode() != null) { - session.registerExitPlanModeHandler(config.getOnExitPlanMode()); - } - if (config.getOnAutoModeSwitch() != null) { - session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch()); - } - if (config.getOnEvent() != null) { - session.on(config.getOnEvent()); - } - } - - /** - * Configures a resumed session with handlers from the given config. - * - * @param session - * the session to configure - * @param config - * the resume session configuration - */ - static void configureSession(CopilotSession session, ResumeSessionConfig config) { - if (config == null) { - return; - } - - if (config.getTools() != null) { - session.registerTools(config.getTools()); - } - if (config.getOnPermissionRequest() != null) { - session.registerPermissionHandler(config.getOnPermissionRequest()); - } - if (config.getOnUserInputRequest() != null) { - session.registerUserInputHandler(config.getOnUserInputRequest()); - } - if (config.getHooks() != null) { - session.registerHooks(config.getHooks()); - } - if (config.getCommands() != null) { - session.registerCommands(config.getCommands()); - } - if (config.getOnElicitationRequest() != null) { - session.registerElicitationHandler(config.getOnElicitationRequest()); - } - if (config.getOnExitPlanMode() != null) { - session.registerExitPlanModeHandler(config.getOnExitPlanMode()); - } - if (config.getOnAutoModeSwitch() != null) { - session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch()); - } - if (config.getOnEvent() != null) { - session.on(config.getOnEvent()); - } - } -} diff --git a/java/src/main/java/com/github/copilot/package-info.java b/java/src/main/java/com/github/copilot/package-info.java deleted file mode 100644 index 71025f07a..000000000 --- a/java/src/main/java/com/github/copilot/package-info.java +++ /dev/null @@ -1,57 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -/** - * Core classes for the GitHub Copilot SDK for Java. - * - *

    - * This package provides the main entry points for interacting with GitHub - * Copilot programmatically. The SDK enables Java applications to leverage - * Copilot's agentic capabilities, including multi-turn conversations, tool - * execution, and AI-powered code generation. - * - *

    Main Classes

    - *
      - *
    • {@link com.github.copilot.CopilotClient} - The main client for connecting - * to and communicating with the Copilot CLI. Manages the lifecycle of the CLI - * process and provides methods for creating sessions, querying models, and - * checking authentication status.
      • - *
    • {@link com.github.copilot.CopilotSession} - Represents a single - * conversation session with Copilot. Sessions maintain context across multiple - * messages and support streaming responses, tool invocations, and event - * handling.
      • - *
    • {@link com.github.copilot.JsonRpcClient} - Low-level JSON-RPC client for - * communication with the Copilot CLI process.
      • - *
    - * - *

    Quick Start

    - * - * 
    {@code
- * try (var client = new CopilotClient()) {
- * 	client.start().get();
- *
- * 	var session = client.createSession(new SessionConfig().setModel("gpt-4.1")).get();
- *
- * 	session.on(AssistantMessageEvent.class, msg -> {
- * 		System.out.println(msg.getData().content());
- * 	});
- *
- * 	session.send(new MessageOptions().setPrompt("Hello, Copilot!")).get();
- * }
- * }
    - * - *

    Related Packages

    - *
      - *
    • {@link com.github.copilot.generated} - Auto-generated event types emitted - * during session processing
      • - *
    • {@link com.github.copilot.rpc} - Configuration and data transfer - * objects
      • - *
    - * - * @see com.github.copilot.CopilotClient - * @see com.github.copilot.CopilotSession - * @see GitHub - * Repository - */ -package com.github.copilot; diff --git a/java/src/main/java/com/github/copilot/rpc/AgentInfo.java b/java/src/main/java/com/github/copilot/rpc/AgentInfo.java deleted file mode 100644 index 84e512644..000000000 --- a/java/src/main/java/com/github/copilot/rpc/AgentInfo.java +++ /dev/null @@ -1,89 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Represents a custom agent available for selection in a session. - * - * @since 1.0.11 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -public class AgentInfo { - - @JsonProperty("name") - private String name; - - @JsonProperty("displayName") - private String displayName; - - @JsonProperty("description") - private String description; - - /** - * Gets the unique identifier of the agent. - * - * @return the agent name/identifier - */ - public String getName() { - return name; - } - - /** - * Sets the unique identifier of the agent. - * - * @param name - * the agent name/identifier - * @return this instance for chaining - */ - public AgentInfo setName(String name) { - this.name = name; - return this; - } - - /** - * Gets the human-readable display name of the agent. - * - * @return the display name - */ - public String getDisplayName() { - return displayName; - } - - /** - * Sets the human-readable display name of the agent. - * - * @param displayName - * the display name - * @return this instance for chaining - */ - public AgentInfo setDisplayName(String displayName) { - this.displayName = displayName; - return this; - } - - /** - * Gets the description of the agent's purpose. - * - * @return the description - */ - public String getDescription() { - return description; - } - - /** - * Sets the description of the agent's purpose. - * - * @param description - * the description - * @return this instance for chaining - */ - public AgentInfo setDescription(String description) { - this.description = description; - return this; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java b/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java deleted file mode 100644 index f7d2d44c3..000000000 --- a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java +++ /dev/null @@ -1,830 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Internal request object for creating a new session. - *

    - * This is a low-level class for JSON-RPC communication. For creating sessions, - * use {@link com.github.copilot.CopilotClient#createSession(SessionConfig)}. - * - * @see com.github.copilot.CopilotClient#createSession(SessionConfig) - * @see SessionConfig - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public final class CreateSessionRequest { - - @JsonProperty("model") - private String model; - - @JsonProperty("sessionId") - private String sessionId; - - @JsonProperty("clientName") - private String clientName; - - @JsonProperty("reasoningEffort") - private String reasoningEffort; - - @JsonProperty("reasoningSummary") - private String reasoningSummary; - - @JsonProperty("contextTier") - private String contextTier; - - @JsonProperty("tools") - private List tools; - - @JsonProperty("systemMessage") - private SystemMessageConfig systemMessage; - - @JsonProperty("availableTools") - private List availableTools; - - @JsonProperty("excludedTools") - private List excludedTools; - - @JsonProperty("toolFilterPrecedence") - private String toolFilterPrecedence; - - @JsonProperty("provider") - private ProviderConfig provider; - - @JsonProperty("enableSessionTelemetry") - private Boolean enableSessionTelemetry; - - @JsonProperty("requestPermission") - private Boolean requestPermission; - - @JsonProperty("requestUserInput") - private Boolean requestUserInput; - - @JsonProperty("hooks") - private Boolean hooks; - - @JsonProperty("workingDirectory") - private String workingDirectory; - - @JsonProperty("streaming") - private Boolean streaming; - - @JsonProperty("includeSubAgentStreamingEvents") - private Boolean includeSubAgentStreamingEvents; - - @JsonProperty("mcpServers") - private Map mcpServers; - - @JsonProperty("mcpOAuthTokenStorage") - private String mcpOAuthTokenStorage; - - @JsonProperty("envValueMode") - private String envValueMode; - - @JsonProperty("customAgents") - private List customAgents; - - @JsonProperty("defaultAgent") - private DefaultAgentConfig defaultAgent; - - @JsonProperty("agent") - private String agent; - - @JsonProperty("infiniteSessions") - private InfiniteSessionConfig infiniteSessions; - - @JsonProperty("skillDirectories") - private List skillDirectories; - - @JsonProperty("instructionDirectories") - private List instructionDirectories; - - @JsonProperty("pluginDirectories") - private List pluginDirectories; - - @JsonProperty("largeOutput") - private LargeToolOutputConfig largeOutput; - - @JsonProperty("disabledSkills") - private List disabledSkills; - - @JsonProperty("configDir") - private String configDirectory; - - @JsonProperty("enableConfigDiscovery") - private Boolean enableConfigDiscovery; - - @JsonProperty("skipEmbeddingRetrieval") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean skipEmbeddingRetrieval; - - @JsonProperty("organizationCustomInstructions") - @JsonInclude(JsonInclude.Include.NON_NULL) - private String organizationCustomInstructions; - - @JsonProperty("enableOnDemandInstructionDiscovery") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableOnDemandInstructionDiscovery; - - @JsonProperty("enableFileHooks") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableFileHooks; - - @JsonProperty("enableHostGitOperations") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableHostGitOperations; - - @JsonProperty("enableSessionStore") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableSessionStore; - - @JsonProperty("enableSkills") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableSkills; - - @JsonProperty("embeddingCacheStorage") - @JsonInclude(JsonInclude.Include.NON_NULL) - private String embeddingCacheStorage; - - @JsonProperty("commands") - private List commands; - - @JsonProperty("requestElicitation") - private Boolean requestElicitation; - - @JsonProperty("requestMcpApps") - private Boolean requestMcpApps; - - @JsonProperty("requestExitPlanMode") - private Boolean requestExitPlanMode; - - @JsonProperty("requestAutoModeSwitch") - private Boolean requestAutoModeSwitch; - - @JsonProperty("modelCapabilities") - private ModelCapabilitiesOverride modelCapabilities; - - @JsonProperty("gitHubToken") - private String gitHubToken; - - @JsonProperty("remoteSession") - private String remoteSession; - - @JsonProperty("cloud") - private CloudSessionOptions cloud; - - /** Gets the model name. @return the model */ - public String getModel() { - return model; - } - - /** Sets the model name. @param model the model */ - public void setModel(String model) { - this.model = model; - } - - /** Gets the session ID. @return the session ID */ - public String getSessionId() { - return sessionId; - } - - /** Sets the session ID. @param sessionId the session ID */ - public void setSessionId(String sessionId) { - this.sessionId = sessionId; - } - - /** Gets the client name. @return the client name */ - public String getClientName() { - return clientName; - } - - /** Sets the client name. @param clientName the client name */ - public void setClientName(String clientName) { - this.clientName = clientName; - } - - /** Gets the reasoning effort. @return the reasoning effort level */ - public String getReasoningEffort() { - return reasoningEffort; - } - - /** - * Sets the reasoning effort. @param reasoningEffort the reasoning effort level - */ - public void setReasoningEffort(String reasoningEffort) { - this.reasoningEffort = reasoningEffort; - } - - /** Gets the reasoning summary mode. @return the reasoning summary mode */ - public String getReasoningSummary() { - return reasoningSummary; - } - - /** - * Sets the reasoning summary mode. @param reasoningSummary the reasoning - * summary mode - */ - public void setReasoningSummary(String reasoningSummary) { - this.reasoningSummary = reasoningSummary; - } - - /** Gets the context window tier. @return the context window tier */ - public String getContextTier() { - return contextTier; - } - - /** Sets the context window tier. @param contextTier the context window tier */ - public void setContextTier(String contextTier) { - this.contextTier = contextTier; - } - - /** Gets the tools. @return the tool definitions */ - public List getTools() { - return tools == null ? null : Collections.unmodifiableList(tools); - } - - /** Sets the tools. @param tools the tool definitions */ - public void setTools(List tools) { - this.tools = tools; - } - - /** Gets the system message config. @return the config */ - public SystemMessageConfig getSystemMessage() { - return systemMessage; - } - - /** Sets the system message config. @param systemMessage the config */ - public void setSystemMessage(SystemMessageConfig systemMessage) { - this.systemMessage = systemMessage; - } - - /** Gets available tools. @return the tool names */ - public List getAvailableTools() { - return availableTools == null ? null : Collections.unmodifiableList(availableTools); - } - - /** Sets available tools. @param availableTools the tool names */ - public void setAvailableTools(List availableTools) { - this.availableTools = availableTools; - } - - /** Gets excluded tools. @return the tool names */ - public List getExcludedTools() { - return excludedTools == null ? null : Collections.unmodifiableList(excludedTools); - } - - /** Sets excluded tools. @param excludedTools the tool names */ - public void setExcludedTools(List excludedTools) { - this.excludedTools = excludedTools; - } - - /** Gets the tool filter precedence. @return the precedence value */ - public String getToolFilterPrecedence() { - return toolFilterPrecedence; - } - - /** - * Sets the tool filter precedence. @param toolFilterPrecedence the precedence - * ("excluded" or null) - */ - public void setToolFilterPrecedence(String toolFilterPrecedence) { - this.toolFilterPrecedence = toolFilterPrecedence; - } - - /** Gets the provider config. @return the provider */ - public ProviderConfig getProvider() { - return provider; - } - - /** Sets the provider config. @param provider the provider */ - public void setProvider(ProviderConfig provider) { - this.provider = provider; - } - - /** Gets enable session telemetry flag. @return the flag */ - public Boolean getEnableSessionTelemetry() { - return enableSessionTelemetry; - } - - /** - * Sets enable session telemetry flag. @param enableSessionTelemetry the flag - */ - public void setEnableSessionTelemetry(boolean enableSessionTelemetry) { - this.enableSessionTelemetry = enableSessionTelemetry; - } - - /** - * Clears the enableSessionTelemetry setting, reverting to the default behavior. - */ - public void clearEnableSessionTelemetry() { - this.enableSessionTelemetry = null; - } - - /** Gets request permission flag. @return the flag */ - public Boolean getRequestPermission() { - return requestPermission; - } - - /** Sets request permission flag. @param requestPermission the flag */ - public void setRequestPermission(boolean requestPermission) { - this.requestPermission = requestPermission; - } - - /** - * Clears the requestPermission setting, reverting to the default behavior. - */ - public void clearRequestPermission() { - this.requestPermission = null; - } - - /** Gets request user input flag. @return the flag */ - public Boolean getRequestUserInput() { - return requestUserInput; - } - - /** Sets request user input flag. @param requestUserInput the flag */ - public void setRequestUserInput(boolean requestUserInput) { - this.requestUserInput = requestUserInput; - } - - /** - * Clears the requestUserInput setting, reverting to the default behavior. - */ - public void clearRequestUserInput() { - this.requestUserInput = null; - } - - /** Gets hooks flag. @return the flag */ - public Boolean getHooks() { - return hooks; - } - - /** Sets hooks flag. @param hooks the flag */ - public void setHooks(boolean hooks) { - this.hooks = hooks; - } - - /** - * Clears the hooks setting, reverting to the default behavior. - */ - public void clearHooks() { - this.hooks = null; - } - - /** Gets working directory. @return the working directory */ - public String getWorkingDirectory() { - return workingDirectory; - } - - /** Sets working directory. @param workingDirectory the working directory */ - public void setWorkingDirectory(String workingDirectory) { - this.workingDirectory = workingDirectory; - } - - /** Gets streaming flag. @return the flag */ - public Boolean getStreaming() { - return streaming; - } - - /** Sets streaming flag. @param streaming the flag */ - public void setStreaming(boolean streaming) { - this.streaming = streaming; - } - - /** - * Clears the streaming setting, reverting to the default behavior. - */ - public void clearStreaming() { - this.streaming = null; - } - - /** Gets MCP servers. @return the servers map */ - public Map getMcpServers() { - return mcpServers == null ? null : Collections.unmodifiableMap(mcpServers); - } - - /** Sets MCP servers. @param mcpServers the servers map */ - public void setMcpServers(Map mcpServers) { - this.mcpServers = mcpServers; - } - - /** Gets MCP OAuth token storage mode. @return the storage mode */ - public String getMcpOAuthTokenStorage() { - return mcpOAuthTokenStorage; - } - - /** - * Sets MCP OAuth token storage mode. @param mcpOAuthTokenStorage the storage - * mode - */ - public void setMcpOAuthTokenStorage(String mcpOAuthTokenStorage) { - this.mcpOAuthTokenStorage = mcpOAuthTokenStorage; - } - - /** Gets MCP environment variable value mode. @return the mode */ - public String getEnvValueMode() { - return envValueMode; - } - - /** Sets MCP environment variable value mode. @param envValueMode the mode */ - public void setEnvValueMode(String envValueMode) { - this.envValueMode = envValueMode; - } - - /** Gets custom agents. @return the agents */ - public List getCustomAgents() { - return customAgents == null ? null : Collections.unmodifiableList(customAgents); - } - - /** Sets custom agents. @param customAgents the agents */ - public void setCustomAgents(List customAgents) { - this.customAgents = customAgents; - } - - /** Gets the default agent config. @return the default agent config */ - public DefaultAgentConfig getDefaultAgent() { - return defaultAgent; - } - - /** - * Sets the default agent config. @param defaultAgent the default agent config - */ - public void setDefaultAgent(DefaultAgentConfig defaultAgent) { - this.defaultAgent = defaultAgent; - } - - /** Gets the pre-selected agent name. @return the agent name */ - public String getAgent() { - return agent; - } - - /** Sets the pre-selected agent name. @param agent the agent name */ - public void setAgent(String agent) { - this.agent = agent; - } - - /** Gets infinite sessions config. @return the config */ - public InfiniteSessionConfig getInfiniteSessions() { - return infiniteSessions; - } - - /** Sets infinite sessions config. @param infiniteSessions the config */ - public void setInfiniteSessions(InfiniteSessionConfig infiniteSessions) { - this.infiniteSessions = infiniteSessions; - } - - /** Gets skill directories. @return the skill directories */ - public List getSkillDirectories() { - return skillDirectories == null ? null : Collections.unmodifiableList(skillDirectories); - } - - /** Sets skill directories. @param skillDirectories the directories */ - public void setSkillDirectories(List skillDirectories) { - this.skillDirectories = skillDirectories; - } - - /** Gets instruction directories. @return the instruction directories */ - public List getInstructionDirectories() { - return instructionDirectories == null ? null : Collections.unmodifiableList(instructionDirectories); - } - - /** - * Sets instruction directories. @param instructionDirectories the directories - */ - public void setInstructionDirectories(List instructionDirectories) { - this.instructionDirectories = instructionDirectories; - } - - /** Gets plugin directories. @return the plugin directories */ - public List getPluginDirectories() { - return pluginDirectories == null ? null : Collections.unmodifiableList(pluginDirectories); - } - - /** Sets plugin directories. @param pluginDirectories the directories */ - public void setPluginDirectories(List pluginDirectories) { - this.pluginDirectories = pluginDirectories; - } - - /** Gets large output config. @return the large output config */ - public LargeToolOutputConfig getLargeOutput() { - return largeOutput; - } - - /** Sets large output config. @param largeOutput the large output config */ - public void setLargeOutput(LargeToolOutputConfig largeOutput) { - this.largeOutput = largeOutput; - } - - /** Gets disabled skills. @return the disabled skill names */ - public List getDisabledSkills() { - return disabledSkills == null ? null : Collections.unmodifiableList(disabledSkills); - } - - /** Sets disabled skills. @param disabledSkills the skill names to disable */ - public void setDisabledSkills(List disabledSkills) { - this.disabledSkills = disabledSkills; - } - - /** Gets config directory. @return the config directory path */ - public String getConfigDirectory() { - return configDirectory; - } - - /** Sets config directory. @param configDirectory the config directory path */ - public void setConfigDirectory(String configDirectory) { - this.configDirectory = configDirectory; - } - - /** Gets enable config discovery flag. @return the flag */ - public Boolean getEnableConfigDiscovery() { - return enableConfigDiscovery; - } - - /** Sets enable config discovery flag. @param enableConfigDiscovery the flag */ - public void setEnableConfigDiscovery(boolean enableConfigDiscovery) { - this.enableConfigDiscovery = enableConfigDiscovery; - } - - /** - * Clears the enableConfigDiscovery setting, reverting to the default behavior. - */ - public void clearEnableConfigDiscovery() { - this.enableConfigDiscovery = null; - } - - /** Gets skip embedding retrieval flag. @return the flag */ - public Boolean getSkipEmbeddingRetrieval() { - return skipEmbeddingRetrieval; - } - - /** - * Sets skip embedding retrieval flag. @param skipEmbeddingRetrieval the flag - */ - public void setSkipEmbeddingRetrieval(boolean skipEmbeddingRetrieval) { - this.skipEmbeddingRetrieval = skipEmbeddingRetrieval; - } - - /** - * Clears the skipEmbeddingRetrieval setting, reverting to the default behavior. - */ - public void clearSkipEmbeddingRetrieval() { - this.skipEmbeddingRetrieval = null; - } - - /** Gets organization custom instructions. @return the instructions */ - public String getOrganizationCustomInstructions() { - return organizationCustomInstructions; - } - - /** - * Sets organization custom instructions. @param organizationCustomInstructions - * the instructions - */ - public void setOrganizationCustomInstructions(String organizationCustomInstructions) { - this.organizationCustomInstructions = organizationCustomInstructions; - } - - /** Gets enable on-demand instruction discovery flag. @return the flag */ - public Boolean getEnableOnDemandInstructionDiscovery() { - return enableOnDemandInstructionDiscovery; - } - - /** - * Sets enable on-demand instruction discovery flag. @param - * enableOnDemandInstructionDiscovery the flag - */ - public void setEnableOnDemandInstructionDiscovery(boolean enableOnDemandInstructionDiscovery) { - this.enableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery; - } - - /** - * Clears the enableOnDemandInstructionDiscovery setting, reverting to the - * default behavior. - */ - public void clearEnableOnDemandInstructionDiscovery() { - this.enableOnDemandInstructionDiscovery = null; - } - - /** Gets enable file hooks flag. @return the flag */ - public Boolean getEnableFileHooks() { - return enableFileHooks; - } - - /** Sets enable file hooks flag. @param enableFileHooks the flag */ - public void setEnableFileHooks(boolean enableFileHooks) { - this.enableFileHooks = enableFileHooks; - } - - /** Clears the enableFileHooks setting, reverting to the default behavior. */ - public void clearEnableFileHooks() { - this.enableFileHooks = null; - } - - /** Gets enable host git operations flag. @return the flag */ - public Boolean getEnableHostGitOperations() { - return enableHostGitOperations; - } - - /** - * Sets enable host git operations flag. @param enableHostGitOperations the flag - */ - public void setEnableHostGitOperations(boolean enableHostGitOperations) { - this.enableHostGitOperations = enableHostGitOperations; - } - - /** - * Clears the enableHostGitOperations setting, reverting to the default - * behavior. - */ - public void clearEnableHostGitOperations() { - this.enableHostGitOperations = null; - } - - /** Gets enable session store flag. @return the flag */ - public Boolean getEnableSessionStore() { - return enableSessionStore; - } - - /** Sets enable session store flag. @param enableSessionStore the flag */ - public void setEnableSessionStore(boolean enableSessionStore) { - this.enableSessionStore = enableSessionStore; - } - - /** Clears the enableSessionStore setting, reverting to the default behavior. */ - public void clearEnableSessionStore() { - this.enableSessionStore = null; - } - - /** Gets enable skills flag. @return the flag */ - public Boolean getEnableSkills() { - return enableSkills; - } - - /** Sets enable skills flag. @param enableSkills the flag */ - public void setEnableSkills(boolean enableSkills) { - this.enableSkills = enableSkills; - } - - /** Clears the enableSkills setting, reverting to the default behavior. */ - public void clearEnableSkills() { - this.enableSkills = null; - } - - /** Gets embedding cache storage mode. @return the mode */ - public String getEmbeddingCacheStorage() { - return embeddingCacheStorage; - } - - /** Sets embedding cache storage mode. @param embeddingCacheStorage the mode */ - public void setEmbeddingCacheStorage(String embeddingCacheStorage) { - this.embeddingCacheStorage = embeddingCacheStorage; - } - - /** - * Clears the embeddingCacheStorage setting, reverting to the default behavior. - */ - public void clearEmbeddingCacheStorage() { - this.embeddingCacheStorage = null; - } - - /** Gets include sub-agent streaming events flag. @return the flag */ - public Boolean getIncludeSubAgentStreamingEvents() { - return includeSubAgentStreamingEvents; - } - - /** - * Sets include sub-agent streaming events flag. @param - * includeSubAgentStreamingEvents the flag - */ - public void setIncludeSubAgentStreamingEvents(boolean includeSubAgentStreamingEvents) { - this.includeSubAgentStreamingEvents = includeSubAgentStreamingEvents; - } - - /** - * Clears the includeSubAgentStreamingEvents setting, reverting to the default - * behavior. - */ - public void clearIncludeSubAgentStreamingEvents() { - this.includeSubAgentStreamingEvents = null; - } - - /** Gets the commands wire definitions. @return the commands */ - public List getCommands() { - return commands == null ? null : Collections.unmodifiableList(commands); - } - - /** Sets the commands wire definitions. @param commands the commands */ - public void setCommands(List commands) { - this.commands = commands; - } - - /** Gets the requestElicitation flag. @return the flag */ - public Boolean getRequestElicitation() { - return requestElicitation; - } - - /** Sets the requestElicitation flag. @param requestElicitation the flag */ - public void setRequestElicitation(boolean requestElicitation) { - this.requestElicitation = requestElicitation; - } - - /** - * Clears the requestElicitation setting, reverting to the default behavior. - */ - public void clearRequestElicitation() { - this.requestElicitation = null; - } - - /** Gets the requestMcpApps flag. @return the flag */ - public Boolean getRequestMcpApps() { - return requestMcpApps; - } - - /** Sets the requestMcpApps flag. @param requestMcpApps the flag */ - public void setRequestMcpApps(boolean requestMcpApps) { - this.requestMcpApps = requestMcpApps; - } - - /** Clears the requestMcpApps setting, reverting to the default behavior. */ - public void clearRequestMcpApps() { - this.requestMcpApps = null; - } - - /** Gets the requestExitPlanMode flag. @return the flag */ - public Boolean getRequestExitPlanMode() { - return requestExitPlanMode; - } - - /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */ - public void setRequestExitPlanMode(Boolean requestExitPlanMode) { - this.requestExitPlanMode = requestExitPlanMode; - } - - /** Gets the requestAutoModeSwitch flag. @return the flag */ - public Boolean getRequestAutoModeSwitch() { - return requestAutoModeSwitch; - } - - /** - * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag - */ - public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) { - this.requestAutoModeSwitch = requestAutoModeSwitch; - } - - /** Gets the model capabilities override. @return the override */ - public ModelCapabilitiesOverride getModelCapabilities() { - return modelCapabilities; - } - - /** - * Sets the model capabilities override. @param modelCapabilities the override - */ - public void setModelCapabilities(ModelCapabilitiesOverride modelCapabilities) { - this.modelCapabilities = modelCapabilities; - } - - /** Gets the GitHub token for per-session authentication. @return the token */ - public String getGitHubToken() { - return gitHubToken; - } - - /** - * Sets the GitHub token for per-session authentication. @param gitHubToken the - * token - */ - public void setGitHubToken(String gitHubToken) { - this.gitHubToken = gitHubToken; - } - - /** Gets the remote session mode. @return the remote session mode */ - public String getRemoteSession() { - return remoteSession; - } - - /** - * Sets the remote session mode. @param remoteSession the remote session mode - */ - public void setRemoteSession(String remoteSession) { - this.remoteSession = remoteSession; - } - - /** Gets the cloud session options. @return the cloud session options */ - public CloudSessionOptions getCloud() { - return cloud; - } - - /** Sets the cloud session options. @param cloud the cloud session options */ - public void setCloud(CloudSessionOptions cloud) { - this.cloud = cloud; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java b/java/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java deleted file mode 100644 index e10926769..000000000 --- a/java/src/main/java/com/github/copilot/rpc/CreateSessionResponse.java +++ /dev/null @@ -1,22 +0,0 @@ -package com.github.copilot.rpc; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Internal response object from creating a session. - * - * @param sessionId - * the session ID assigned by the server - * @param workspacePath - * the workspace path, or {@code null} if infinite sessions are - * disabled - * @param capabilities - * the capabilities reported by the host, or {@code null} - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public record CreateSessionResponse(@JsonProperty("sessionId") String sessionId, - @JsonProperty("workspacePath") String workspacePath, - @JsonProperty("capabilities") SessionCapabilities capabilities) { -} diff --git a/java/src/main/java/com/github/copilot/rpc/ModelBilling.java b/java/src/main/java/com/github/copilot/rpc/ModelBilling.java deleted file mode 100644 index c7bfc72b5..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ModelBilling.java +++ /dev/null @@ -1,29 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Model billing information. - * - * @since 1.0.1 - */ -@JsonIgnoreProperties(ignoreUnknown = true) -public class ModelBilling { - - @JsonProperty("multiplier") - private double multiplier; - - public double getMultiplier() { - return multiplier; - } - - public ModelBilling setMultiplier(double multiplier) { - this.multiplier = multiplier; - return this; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionHandler.java b/java/src/main/java/com/github/copilot/rpc/PermissionHandler.java deleted file mode 100644 index bd8e70b75..000000000 --- a/java/src/main/java/com/github/copilot/rpc/PermissionHandler.java +++ /dev/null @@ -1,66 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.concurrent.CompletableFuture; - -/** - * Functional interface for handling permission requests from the AI assistant. - *

    - * When the assistant needs permission to perform certain actions (such as - * executing tools or accessing resources), this handler is invoked to approve - * or deny the request. - * - *

    Example Implementation

    - * - * 
    {@code
- * PermissionHandler handler = (request, invocation) -> {
- * 	// Check the permission kind
- * 	if ("dangerous-action".equals(request.getKind())) {
- * 		// Deny dangerous actions
- * 		return CompletableFuture
- * 				.completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.REJECTED));
- * 	}
- *
- * 	// Approve other requests
- * 	return CompletableFuture
- * 			.completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED));
- * };
- * }
    - * - *

    - * A pre-built handler that approves all requests is available as - * {@link #APPROVE_ALL}. - * - * @see SessionConfig#setOnPermissionRequest(PermissionHandler) - * @see PermissionRequest - * @see PermissionRequestResult - * @since 1.0.0 - */ -@FunctionalInterface -public interface PermissionHandler { - - /** - * A pre-built handler that approves all permission requests. - * - * @since 1.0.11 - */ - PermissionHandler APPROVE_ALL = (request, invocation) -> CompletableFuture - .completedFuture(new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED)); - - /** - * Handles a permission request from the assistant. - *

    - * The handler should evaluate the request and return a result indicating - * whether the permission is granted or denied. - * - * @param request - * the permission request details - * @param invocation - * the invocation context with session information - * @return a future that completes with the permission decision - */ - CompletableFuture handle(PermissionRequest request, PermissionInvocation invocation); -} diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java b/java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java deleted file mode 100644 index bda5bdde0..000000000 --- a/java/src/main/java/com/github/copilot/rpc/PermissionInvocation.java +++ /dev/null @@ -1,40 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -/** - * Context information for a permission request invocation. - *

    - * This object provides context about the session where the permission request - * originated. - * - * @see PermissionHandler - * @since 1.0.0 - */ -public final class PermissionInvocation { - - private String sessionId; - - /** - * Gets the session ID where the permission was requested. - * - * @return the session ID - */ - public String getSessionId() { - return sessionId; - } - - /** - * Sets the session ID. - * - * @param sessionId - * the session ID - * @return this invocation for method chaining - */ - public PermissionInvocation setSessionId(String sessionId) { - this.sessionId = sessionId; - return this; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionRequest.java b/java/src/main/java/com/github/copilot/rpc/PermissionRequest.java deleted file mode 100644 index 51a303feb..000000000 --- a/java/src/main/java/com/github/copilot/rpc/PermissionRequest.java +++ /dev/null @@ -1,89 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Represents a permission request from the AI assistant. - *

    - * When the assistant needs permission to perform certain actions, this object - * contains the details of the request, including the kind of permission and any - * associated tool call. - * - * @see PermissionHandler - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public class PermissionRequest { - - @JsonProperty("kind") - private String kind; - - @JsonProperty("toolCallId") - private String toolCallId; - - private Map extensionData; - - /** - * Gets the kind of permission being requested. - * - * @return the permission kind - */ - public String getKind() { - return kind; - } - - /** - * Sets the permission kind. - * - * @param kind - * the permission kind - */ - public void setKind(String kind) { - this.kind = kind; - } - - /** - * Gets the associated tool call ID, if applicable. - * - * @return the tool call ID, or {@code null} if not a tool-related request - */ - public String getToolCallId() { - return toolCallId; - } - - /** - * Sets the tool call ID. - * - * @param toolCallId - * the tool call ID - */ - public void setToolCallId(String toolCallId) { - this.toolCallId = toolCallId; - } - - /** - * Gets additional extension data for the request. - * - * @return the extension data map - */ - public Map getExtensionData() { - return extensionData; - } - - /** - * Sets additional extension data for the request. - * - * @param extensionData - * the extension data map - */ - public void setExtensionData(Map extensionData) { - this.extensionData = extensionData; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java b/java/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java deleted file mode 100644 index 2e5c60100..000000000 --- a/java/src/main/java/com/github/copilot/rpc/PermissionRequestResult.java +++ /dev/null @@ -1,171 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.List; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Result of a permission request decision. - *

    - * This object indicates whether a permission request was approved or denied, - * and may include additional rules for future similar requests. - * - *

    Common Result Kinds

    - *
      - *
    • {@link PermissionRequestResultKind#APPROVED} — approved
      • - *
    • {@link PermissionRequestResultKind#DENIED_BY_RULES} — denied by - * rules
      • - *
    • {@link PermissionRequestResultKind#DENIED_COULD_NOT_REQUEST_FROM_USER} — - * no handler and couldn't ask user
      • - *
    • {@link PermissionRequestResultKind#DENIED_INTERACTIVELY_BY_USER} — denied - * by the user interactively
      • - *
    - * - * @see PermissionHandler - * @see PermissionRequestResultKind - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public final class PermissionRequestResult { - - @JsonProperty("kind") - private String kind; - - @JsonProperty("rules") - private List rules; - - @JsonProperty("feedback") - private String feedback; - - /** - * Creates a result that approves this single request. - * - * @return a new approved result - * @since 1.3.0 - */ - public static PermissionRequestResult approveOnce() { - return new PermissionRequestResult().setKind(PermissionRequestResultKind.APPROVED); - } - - /** - * Creates a result that rejects the request, optionally forwarding feedback to - * the LLM. - * - * @param feedback - * optional feedback message, or {@code null} - * @return a new rejected result - * @since 1.3.0 - */ - public static PermissionRequestResult reject(String feedback) { - var result = new PermissionRequestResult().setKind(PermissionRequestResultKind.REJECTED); - result.setFeedback(feedback); - return result; - } - - /** - * Creates a result denying the request because no user is available to confirm - * it. - * - * @return a new user-not-available result - * @since 1.3.0 - */ - public static PermissionRequestResult userNotAvailable() { - return new PermissionRequestResult().setKind(PermissionRequestResultKind.USER_NOT_AVAILABLE); - } - - /** - * Creates a result that declines to respond to this permission request, - * allowing another connected client to answer instead. - * - * @return a new no-result result - * @since 1.3.0 - */ - public static PermissionRequestResult noResult() { - return new PermissionRequestResult().setKind(PermissionRequestResultKind.NO_RESULT); - } - - /** - * Gets the result kind as a string. - * - * @return the result kind indicating approval or denial - */ - public String getKind() { - return kind; - } - - /** - * Sets the result kind using a {@link PermissionRequestResultKind} value. - * - * @param kind - * the result kind - * @return this result for method chaining - * @since 1.1.0 - */ - public PermissionRequestResult setKind(PermissionRequestResultKind kind) { - this.kind = kind != null ? kind.getValue() : null; - return this; - } - - /** - * Sets the result kind using a raw string value. - * - * @param kind - * the result kind string - * @return this result for method chaining - */ - public PermissionRequestResult setKind(String kind) { - this.kind = kind; - return this; - } - - /** - * Gets the approval rules. - * - * @return the list of rules for future similar requests - */ - public List getRules() { - return rules; - } - - /** - * Sets approval rules for future similar requests. - * - * @param rules - * the list of rules - * @return this result for method chaining - */ - public PermissionRequestResult setRules(List rules) { - this.rules = rules; - return this; - } - - /** - * Gets optional human-readable feedback to forward to the LLM along with the - * decision. - * - * @return the feedback message, or {@code null} - * @since 1.3.0 - */ - public String getFeedback() { - return feedback; - } - - /** - * Sets optional human-readable feedback to forward to the LLM along with the - * decision. - * - * @param feedback - * the feedback message - * @return this result for method chaining - * @since 1.3.0 - */ - public PermissionRequestResult setFeedback(String feedback) { - this.feedback = feedback; - return this; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/ProviderConfig.java b/java/src/main/java/com/github/copilot/rpc/ProviderConfig.java deleted file mode 100644 index 6c9cf379f..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ProviderConfig.java +++ /dev/null @@ -1,372 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.Collections; -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonIgnore; -import java.util.OptionalInt; - -/** - * Configuration for a custom API provider (BYOK - Bring Your Own Key). - *

    - * This allows using your own OpenAI, Azure OpenAI, or other compatible API - * endpoints instead of the default Copilot backend. All setter methods return - * {@code this} for method chaining. - * - *

    Example Usage - OpenAI

    - * - * 
    {@code
- * var provider = new ProviderConfig().setType("openai").setBaseUrl("https://api.openai.com/v1").setApiKey("sk-...");
- * }
    - * - *

    Example Usage - Azure OpenAI

    - * - * 
    {@code
- * var provider = new ProviderConfig().setType("azure")
- * 		.setAzure(new AzureOptions().setEndpoint("https://my-resource.openai.azure.com").setDeployment("gpt-4"));
- * }
    - * - * @see SessionConfig#setProvider(ProviderConfig) - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public class ProviderConfig { - - @JsonProperty("type") - private String type; - - @JsonProperty("wireApi") - private String wireApi; - - @JsonProperty("baseUrl") - private String baseUrl; - - @JsonProperty("apiKey") - private String apiKey; - - @JsonProperty("bearerToken") - private String bearerToken; - - @JsonProperty("azure") - private AzureOptions azure; - - @JsonProperty("headers") - private Map headers; - - @JsonProperty("modelId") - private String modelId; - - @JsonProperty("wireModel") - private String wireModel; - - @JsonProperty("maxPromptTokens") - private Integer maxPromptTokens; - - @JsonProperty("maxOutputTokens") - private Integer maxOutputTokens; - - /** - * Gets the provider type. - * - * @return the provider type (e.g., "openai", "azure") - */ - public String getType() { - return type; - } - - /** - * Sets the provider type. - *

    - * Supported types include: - *

      - *
    • "openai" - OpenAI API
      • - *
    • "azure" - Azure OpenAI Service
      • - *
    - * - * @param type - * the provider type - * @return this config for method chaining - */ - public ProviderConfig setType(String type) { - this.type = type; - return this; - } - - /** - * Gets the wire API format. - * - * @return the wire API format - */ - public String getWireApi() { - return wireApi; - } - - /** - * Sets the wire API format for custom providers. - *

    - * This specifies the API format when using a custom provider that has a - * different wire protocol. - * - * @param wireApi - * the wire API format - * @return this config for method chaining - */ - public ProviderConfig setWireApi(String wireApi) { - this.wireApi = wireApi; - return this; - } - - /** - * Gets the base URL for the API. - * - * @return the API base URL - */ - public String getBaseUrl() { - return baseUrl; - } - - /** - * Sets the base URL for the API. - *

    - * For OpenAI, this is typically "https://api.openai.com/v1". - * - * @param baseUrl - * the API base URL - * @return this config for method chaining - */ - public ProviderConfig setBaseUrl(String baseUrl) { - this.baseUrl = baseUrl; - return this; - } - - /** - * Gets the API key. - * - * @return the API key - */ - public String getApiKey() { - return apiKey; - } - - /** - * Sets the API key for authentication. - * - * @param apiKey - * the API key - * @return this config for method chaining - */ - public ProviderConfig setApiKey(String apiKey) { - this.apiKey = apiKey; - return this; - } - - /** - * Gets the bearer token. - * - * @return the bearer token - */ - public String getBearerToken() { - return bearerToken; - } - - /** - * Sets a bearer token for authentication. - *

    - * This is an alternative to API key authentication. - *

    - * Note: The bearer token is a static token - * string. 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. - * - * @param bearerToken - * the bearer token - * @return this config for method chaining - */ - public ProviderConfig setBearerToken(String bearerToken) { - this.bearerToken = bearerToken; - return this; - } - - /** - * Gets the Azure-specific options. - * - * @return the Azure options - */ - public AzureOptions getAzure() { - return azure; - } - - /** - * Sets Azure-specific options for Azure OpenAI Service. - * - * @param azure - * the Azure options - * @return this config for method chaining - * @see AzureOptions - */ - public ProviderConfig setAzure(AzureOptions azure) { - this.azure = azure; - return this; - } - - /** - * Gets the custom HTTP headers for outbound provider requests. - * - * @return the headers map, or {@code null} if not set - */ - public Map getHeaders() { - return headers == null ? null : Collections.unmodifiableMap(headers); - } - - /** - * Sets custom HTTP headers to include in outbound provider requests. - *

    - * Use this to pass additional authentication headers or custom metadata to the - * provider API. - * - * @param headers - * the headers map - * @return this config for method chaining - */ - public ProviderConfig setHeaders(Map headers) { - this.headers = headers; - return this; - } - - /** - * Gets the well-known model name used by the runtime. - *

    - * Used to look up agent configuration (tools, prompts, reasoning behavior) and - * default token limits. Also used as the wire model when - * {@link #getWireModel()} is not set. - * - * @return the model ID, or {@code null} if not set - */ - public String getModelId() { - return modelId; - } - - /** - * Sets the well-known model name used by the runtime. - *

    - * Used to look up agent configuration (tools, prompts, reasoning behavior) and - * default token limits. Also used as the wire model when - * {@link #getWireModel()} is not set. Falls back to - * {@link SessionConfig#getModel()}. - * - * @param modelId - * the model ID - * @return this config for method chaining - */ - public ProviderConfig setModelId(String modelId) { - this.modelId = modelId; - return this; - } - - /** - * Gets the model name sent to the provider API for inference. - * - * @return the wire model name, or {@code null} if not set - */ - public String getWireModel() { - return wireModel; - } - - /** - * Sets the model name sent to the provider API for inference. - *

    - * Use this when the provider's model name (e.g. an Azure deployment name or a - * custom fine-tune name) differs from {@link #getModelId()}. Falls back to - * {@link #getModelId()}, then {@link SessionConfig#getModel()}. - * - * @param wireModel - * the wire model name - * @return this config for method chaining - */ - public ProviderConfig setWireModel(String wireModel) { - this.wireModel = wireModel; - return this; - } - - /** - * Gets the maximum prompt token override. - * - * @return an {@link java.util.OptionalInt} containing the max prompt tokens, or - * {@link java.util.OptionalInt#empty()} if not set - */ - @JsonIgnore - public OptionalInt getMaxPromptTokens() { - return maxPromptTokens == null ? OptionalInt.empty() : OptionalInt.of(maxPromptTokens); - } - - /** - * Sets the maximum prompt tokens override. - *

    - * Overrides the resolved model's default max prompt tokens. The runtime - * triggers conversation compaction before sending a request when the prompt - * (system message, history, tool definitions, user message) would exceed this - * limit. - * - * @param maxPromptTokens - * the max prompt tokens - * @return this config for method chaining - */ - public ProviderConfig setMaxPromptTokens(int maxPromptTokens) { - this.maxPromptTokens = maxPromptTokens; - return this; - } - - /** - * Clears the maxPromptTokens setting, reverting to the default behavior. - * - * @return this instance for method chaining - */ - public ProviderConfig clearMaxPromptTokens() { - this.maxPromptTokens = null; - return this; - } - - /** - * Gets the maximum output token override. - * - * @return an {@link java.util.OptionalInt} containing the max output tokens, or - * {@link java.util.OptionalInt#empty()} if not set - */ - @JsonIgnore - public OptionalInt getMaxOutputTokens() { - return maxOutputTokens == null ? OptionalInt.empty() : OptionalInt.of(maxOutputTokens); - } - - /** - * Sets the maximum output tokens override. - *

    - * Overrides the resolved model's default max output tokens. When hit, the model - * stops generating and returns a truncated response. - * - * @param maxOutputTokens - * the max output tokens - * @return this config for method chaining - */ - public ProviderConfig setMaxOutputTokens(int maxOutputTokens) { - this.maxOutputTokens = maxOutputTokens; - return this; - } - - /** - * Clears the maxOutputTokens setting, reverting to the default behavior. - * - * @return this instance for method chaining - */ - public ProviderConfig clearMaxOutputTokens() { - this.maxOutputTokens = null; - return this; - } - -} diff --git a/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java b/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java deleted file mode 100644 index c8cdc5a2d..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java +++ /dev/null @@ -1,845 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Internal request object for resuming an existing session. - *

    - * This is a low-level class for JSON-RPC communication. For resuming sessions, - * use - * {@link com.github.copilot.CopilotClient#resumeSession(String, ResumeSessionConfig)}. - * - * @see com.github.copilot.CopilotClient#resumeSession(String, - * ResumeSessionConfig) - * @see ResumeSessionConfig - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public final class ResumeSessionRequest { - - @JsonProperty("sessionId") - private String sessionId; - - @JsonProperty("clientName") - private String clientName; - - @JsonProperty("model") - private String model; - - @JsonProperty("reasoningEffort") - private String reasoningEffort; - - @JsonProperty("reasoningSummary") - private String reasoningSummary; - - @JsonProperty("contextTier") - private String contextTier; - - @JsonProperty("tools") - private List tools; - - @JsonProperty("systemMessage") - private SystemMessageConfig systemMessage; - - @JsonProperty("availableTools") - private List availableTools; - - @JsonProperty("excludedTools") - private List excludedTools; - - @JsonProperty("toolFilterPrecedence") - private String toolFilterPrecedence; - - @JsonProperty("provider") - private ProviderConfig provider; - - @JsonProperty("enableSessionTelemetry") - private Boolean enableSessionTelemetry; - - @JsonProperty("requestPermission") - private Boolean requestPermission; - - @JsonProperty("requestUserInput") - private Boolean requestUserInput; - - @JsonProperty("hooks") - private Boolean hooks; - - @JsonProperty("workingDirectory") - private String workingDirectory; - - @JsonProperty("configDir") - private String configDirectory; - - @JsonProperty("enableConfigDiscovery") - private Boolean enableConfigDiscovery; - - @JsonProperty("skipEmbeddingRetrieval") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean skipEmbeddingRetrieval; - - @JsonProperty("organizationCustomInstructions") - @JsonInclude(JsonInclude.Include.NON_NULL) - private String organizationCustomInstructions; - - @JsonProperty("enableOnDemandInstructionDiscovery") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableOnDemandInstructionDiscovery; - - @JsonProperty("enableFileHooks") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableFileHooks; - - @JsonProperty("enableHostGitOperations") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableHostGitOperations; - - @JsonProperty("enableSessionStore") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableSessionStore; - - @JsonProperty("enableSkills") - @JsonInclude(JsonInclude.Include.NON_NULL) - private Boolean enableSkills; - - @JsonProperty("embeddingCacheStorage") - @JsonInclude(JsonInclude.Include.NON_NULL) - private String embeddingCacheStorage; - - @JsonProperty("disableResume") - private Boolean disableResume; - - @JsonProperty("streaming") - private Boolean streaming; - - @JsonProperty("includeSubAgentStreamingEvents") - private Boolean includeSubAgentStreamingEvents; - - @JsonProperty("mcpServers") - private Map mcpServers; - - @JsonProperty("mcpOAuthTokenStorage") - private String mcpOAuthTokenStorage; - - @JsonProperty("envValueMode") - private String envValueMode; - - @JsonProperty("customAgents") - private List customAgents; - - @JsonProperty("defaultAgent") - private DefaultAgentConfig defaultAgent; - - @JsonProperty("agent") - private String agent; - - @JsonProperty("skillDirectories") - private List skillDirectories; - - @JsonProperty("instructionDirectories") - private List instructionDirectories; - - @JsonProperty("pluginDirectories") - private List pluginDirectories; - - @JsonProperty("largeOutput") - private LargeToolOutputConfig largeOutput; - - @JsonProperty("disabledSkills") - private List disabledSkills; - - @JsonProperty("infiniteSessions") - private InfiniteSessionConfig infiniteSessions; - - @JsonProperty("commands") - private List commands; - - @JsonProperty("requestElicitation") - private Boolean requestElicitation; - - @JsonProperty("requestMcpApps") - private Boolean requestMcpApps; - - @JsonProperty("requestExitPlanMode") - private Boolean requestExitPlanMode; - - @JsonProperty("requestAutoModeSwitch") - private Boolean requestAutoModeSwitch; - - @JsonProperty("modelCapabilities") - private ModelCapabilitiesOverride modelCapabilities; - - @JsonProperty("gitHubToken") - private String gitHubToken; - - @JsonProperty("remoteSession") - private String remoteSession; - - /** Gets the session ID. @return the session ID */ - public String getSessionId() { - return sessionId; - } - - /** Sets the session ID. @param sessionId the session ID */ - public void setSessionId(String sessionId) { - this.sessionId = sessionId; - } - - /** Gets the client name. @return the client name */ - public String getClientName() { - return clientName; - } - - /** Sets the client name. @param clientName the client name */ - public void setClientName(String clientName) { - this.clientName = clientName; - } - - /** Gets the model name. @return the model */ - public String getModel() { - return model; - } - - /** Sets the model name. @param model the model */ - public void setModel(String model) { - this.model = model; - } - - /** Gets the reasoning effort. @return the reasoning effort level */ - public String getReasoningEffort() { - return reasoningEffort; - } - - /** - * Sets the reasoning effort. @param reasoningEffort the reasoning effort level - */ - public void setReasoningEffort(String reasoningEffort) { - this.reasoningEffort = reasoningEffort; - } - - /** Gets the reasoning summary mode. @return the reasoning summary mode */ - public String getReasoningSummary() { - return reasoningSummary; - } - - /** - * Sets the reasoning summary mode. @param reasoningSummary the reasoning - * summary mode - */ - public void setReasoningSummary(String reasoningSummary) { - this.reasoningSummary = reasoningSummary; - } - - /** Gets the context window tier. @return the context window tier */ - public String getContextTier() { - return contextTier; - } - - /** Sets the context window tier. @param contextTier the context window tier */ - public void setContextTier(String contextTier) { - this.contextTier = contextTier; - } - - /** Gets the tools. @return the tool definitions */ - public List getTools() { - return tools == null ? null : Collections.unmodifiableList(tools); - } - - /** Sets the tools. @param tools the tool definitions */ - public void setTools(List tools) { - this.tools = tools; - } - - /** Gets the system message config. @return the system message config */ - public SystemMessageConfig getSystemMessage() { - return systemMessage; - } - - /** - * Sets the system message config. @param systemMessage the system message - * config - */ - public void setSystemMessage(SystemMessageConfig systemMessage) { - this.systemMessage = systemMessage; - } - - /** Gets available tools. @return the available tool names */ - public List getAvailableTools() { - return availableTools == null ? null : Collections.unmodifiableList(availableTools); - } - - /** Sets available tools. @param availableTools the available tool names */ - public void setAvailableTools(List availableTools) { - this.availableTools = availableTools; - } - - /** Gets excluded tools. @return the excluded tool names */ - public List getExcludedTools() { - return excludedTools == null ? null : Collections.unmodifiableList(excludedTools); - } - - /** Sets excluded tools. @param excludedTools the excluded tool names */ - public void setExcludedTools(List excludedTools) { - this.excludedTools = excludedTools; - } - - /** Gets the tool filter precedence. @return the precedence value */ - public String getToolFilterPrecedence() { - return toolFilterPrecedence; - } - - /** - * Sets the tool filter precedence. @param toolFilterPrecedence the precedence - * ("excluded" or null) - */ - public void setToolFilterPrecedence(String toolFilterPrecedence) { - this.toolFilterPrecedence = toolFilterPrecedence; - } - - /** Gets the provider config. @return the provider */ - public ProviderConfig getProvider() { - return provider; - } - - /** Sets the provider config. @param provider the provider */ - public void setProvider(ProviderConfig provider) { - this.provider = provider; - } - - /** Gets enable session telemetry flag. @return the flag */ - public Boolean getEnableSessionTelemetry() { - return enableSessionTelemetry; - } - - /** - * Sets enable session telemetry flag. @param enableSessionTelemetry the flag - */ - public void setEnableSessionTelemetry(boolean enableSessionTelemetry) { - this.enableSessionTelemetry = enableSessionTelemetry; - } - - /** - * Clears the enableSessionTelemetry setting, reverting to the default behavior. - */ - public void clearEnableSessionTelemetry() { - this.enableSessionTelemetry = null; - } - - /** Gets request permission flag. @return the flag */ - public Boolean getRequestPermission() { - return requestPermission; - } - - /** Sets request permission flag. @param requestPermission the flag */ - public void setRequestPermission(boolean requestPermission) { - this.requestPermission = requestPermission; - } - - /** - * Clears the requestPermission setting, reverting to the default behavior. - */ - public void clearRequestPermission() { - this.requestPermission = null; - } - - /** Gets request user input flag. @return the flag */ - public Boolean getRequestUserInput() { - return requestUserInput; - } - - /** Sets request user input flag. @param requestUserInput the flag */ - public void setRequestUserInput(boolean requestUserInput) { - this.requestUserInput = requestUserInput; - } - - /** - * Clears the requestUserInput setting, reverting to the default behavior. - */ - public void clearRequestUserInput() { - this.requestUserInput = null; - } - - /** Gets hooks flag. @return the flag */ - public Boolean getHooks() { - return hooks; - } - - /** Sets hooks flag. @param hooks the flag */ - public void setHooks(boolean hooks) { - this.hooks = hooks; - } - - /** - * Clears the hooks setting, reverting to the default behavior. - */ - public void clearHooks() { - this.hooks = null; - } - - /** Gets working directory. @return the working directory */ - public String getWorkingDirectory() { - return workingDirectory; - } - - /** Sets working directory. @param workingDirectory the working directory */ - public void setWorkingDirectory(String workingDirectory) { - this.workingDirectory = workingDirectory; - } - - /** Gets config directory. @return the config directory */ - public String getConfigDirectory() { - return configDirectory; - } - - /** Sets config directory. @param configDirectory the config directory */ - public void setConfigDirectory(String configDirectory) { - this.configDirectory = configDirectory; - } - - /** Gets enable config discovery flag. @return the flag */ - public Boolean getEnableConfigDiscovery() { - return enableConfigDiscovery; - } - - /** Sets enable config discovery flag. @param enableConfigDiscovery the flag */ - public void setEnableConfigDiscovery(boolean enableConfigDiscovery) { - this.enableConfigDiscovery = enableConfigDiscovery; - } - - /** - * Clears the enableConfigDiscovery setting, reverting to the default behavior. - */ - public void clearEnableConfigDiscovery() { - this.enableConfigDiscovery = null; - } - - /** Gets skip embedding retrieval flag. @return the flag */ - public Boolean getSkipEmbeddingRetrieval() { - return skipEmbeddingRetrieval; - } - - /** - * Sets skip embedding retrieval flag. @param skipEmbeddingRetrieval the flag - */ - public void setSkipEmbeddingRetrieval(boolean skipEmbeddingRetrieval) { - this.skipEmbeddingRetrieval = skipEmbeddingRetrieval; - } - - /** - * Clears the skipEmbeddingRetrieval setting, reverting to the default behavior. - */ - public void clearSkipEmbeddingRetrieval() { - this.skipEmbeddingRetrieval = null; - } - - /** Gets organization custom instructions. @return the instructions */ - public String getOrganizationCustomInstructions() { - return organizationCustomInstructions; - } - - /** - * Sets organization custom instructions. @param organizationCustomInstructions - * the instructions - */ - public void setOrganizationCustomInstructions(String organizationCustomInstructions) { - this.organizationCustomInstructions = organizationCustomInstructions; - } - - /** Gets enable on-demand instruction discovery flag. @return the flag */ - public Boolean getEnableOnDemandInstructionDiscovery() { - return enableOnDemandInstructionDiscovery; - } - - /** - * Sets enable on-demand instruction discovery flag. @param - * enableOnDemandInstructionDiscovery the flag - */ - public void setEnableOnDemandInstructionDiscovery(boolean enableOnDemandInstructionDiscovery) { - this.enableOnDemandInstructionDiscovery = enableOnDemandInstructionDiscovery; - } - - /** - * Clears the enableOnDemandInstructionDiscovery setting, reverting to the - * default behavior. - */ - public void clearEnableOnDemandInstructionDiscovery() { - this.enableOnDemandInstructionDiscovery = null; - } - - /** Gets enable file hooks flag. @return the flag */ - public Boolean getEnableFileHooks() { - return enableFileHooks; - } - - /** Sets enable file hooks flag. @param enableFileHooks the flag */ - public void setEnableFileHooks(boolean enableFileHooks) { - this.enableFileHooks = enableFileHooks; - } - - /** Clears the enableFileHooks setting, reverting to the default behavior. */ - public void clearEnableFileHooks() { - this.enableFileHooks = null; - } - - /** Gets enable host git operations flag. @return the flag */ - public Boolean getEnableHostGitOperations() { - return enableHostGitOperations; - } - - /** - * Sets enable host git operations flag. @param enableHostGitOperations the flag - */ - public void setEnableHostGitOperations(boolean enableHostGitOperations) { - this.enableHostGitOperations = enableHostGitOperations; - } - - /** - * Clears the enableHostGitOperations setting, reverting to the default - * behavior. - */ - public void clearEnableHostGitOperations() { - this.enableHostGitOperations = null; - } - - /** Gets enable session store flag. @return the flag */ - public Boolean getEnableSessionStore() { - return enableSessionStore; - } - - /** Sets enable session store flag. @param enableSessionStore the flag */ - public void setEnableSessionStore(boolean enableSessionStore) { - this.enableSessionStore = enableSessionStore; - } - - /** Clears the enableSessionStore setting, reverting to the default behavior. */ - public void clearEnableSessionStore() { - this.enableSessionStore = null; - } - - /** Gets enable skills flag. @return the flag */ - public Boolean getEnableSkills() { - return enableSkills; - } - - /** Sets enable skills flag. @param enableSkills the flag */ - public void setEnableSkills(boolean enableSkills) { - this.enableSkills = enableSkills; - } - - /** Clears the enableSkills setting, reverting to the default behavior. */ - public void clearEnableSkills() { - this.enableSkills = null; - } - - /** Gets embedding cache storage mode. @return the mode */ - public String getEmbeddingCacheStorage() { - return embeddingCacheStorage; - } - - /** Sets embedding cache storage mode. @param embeddingCacheStorage the mode */ - public void setEmbeddingCacheStorage(String embeddingCacheStorage) { - this.embeddingCacheStorage = embeddingCacheStorage; - } - - /** - * Clears the embeddingCacheStorage setting, reverting to the default behavior. - */ - public void clearEmbeddingCacheStorage() { - this.embeddingCacheStorage = null; - } - - /** Gets disable resume flag. @return the flag */ - public Boolean getDisableResume() { - return disableResume; - } - - /** Sets disable resume flag. @param disableResume the flag */ - public void setDisableResume(boolean disableResume) { - this.disableResume = disableResume; - } - - /** - * Clears the disableResume setting, reverting to the default behavior. - */ - public void clearDisableResume() { - this.disableResume = null; - } - - /** Gets streaming flag. @return the flag */ - public Boolean getStreaming() { - return streaming; - } - - /** Sets streaming flag. @param streaming the flag */ - public void setStreaming(boolean streaming) { - this.streaming = streaming; - } - - /** - * Clears the streaming setting, reverting to the default behavior. - */ - public void clearStreaming() { - this.streaming = null; - } - - /** Gets include sub-agent streaming events flag. @return the flag */ - public Boolean getIncludeSubAgentStreamingEvents() { - return includeSubAgentStreamingEvents; - } - - /** - * Sets include sub-agent streaming events flag. @param - * includeSubAgentStreamingEvents the flag - */ - public void setIncludeSubAgentStreamingEvents(boolean includeSubAgentStreamingEvents) { - this.includeSubAgentStreamingEvents = includeSubAgentStreamingEvents; - } - - /** - * Clears the includeSubAgentStreamingEvents setting, reverting to the default - * behavior. - */ - public void clearIncludeSubAgentStreamingEvents() { - this.includeSubAgentStreamingEvents = null; - } - - /** Gets MCP servers. @return the servers map */ - public Map getMcpServers() { - return mcpServers == null ? null : Collections.unmodifiableMap(mcpServers); - } - - /** Sets MCP servers. @param mcpServers the servers map */ - public void setMcpServers(Map mcpServers) { - this.mcpServers = mcpServers; - } - - /** Gets MCP OAuth token storage mode. @return the storage mode */ - public String getMcpOAuthTokenStorage() { - return mcpOAuthTokenStorage; - } - - /** - * Sets MCP OAuth token storage mode. @param mcpOAuthTokenStorage the storage - * mode - */ - public void setMcpOAuthTokenStorage(String mcpOAuthTokenStorage) { - this.mcpOAuthTokenStorage = mcpOAuthTokenStorage; - } - - /** Gets MCP environment variable value mode. @return the mode */ - public String getEnvValueMode() { - return envValueMode; - } - - /** Sets MCP environment variable value mode. @param envValueMode the mode */ - public void setEnvValueMode(String envValueMode) { - this.envValueMode = envValueMode; - } - - /** Gets custom agents. @return the agents */ - public List getCustomAgents() { - return customAgents == null ? null : Collections.unmodifiableList(customAgents); - } - - /** Sets custom agents. @param customAgents the agents */ - public void setCustomAgents(List customAgents) { - this.customAgents = customAgents; - } - - /** Gets the default agent config. @return the default agent config */ - public DefaultAgentConfig getDefaultAgent() { - return defaultAgent; - } - - /** - * Sets the default agent config. @param defaultAgent the default agent config - */ - public void setDefaultAgent(DefaultAgentConfig defaultAgent) { - this.defaultAgent = defaultAgent; - } - - /** Gets the pre-selected agent name. @return the agent name */ - public String getAgent() { - return agent; - } - - /** Sets the pre-selected agent name. @param agent the agent name */ - public void setAgent(String agent) { - this.agent = agent; - } - - /** Gets skill directories. @return the directories */ - public List getSkillDirectories() { - return skillDirectories == null ? null : Collections.unmodifiableList(skillDirectories); - } - - /** Sets skill directories. @param skillDirectories the directories */ - public void setSkillDirectories(List skillDirectories) { - this.skillDirectories = skillDirectories; - } - - /** Gets instruction directories. @return the instruction directories */ - public List getInstructionDirectories() { - return instructionDirectories == null ? null : Collections.unmodifiableList(instructionDirectories); - } - - /** - * Sets instruction directories. @param instructionDirectories the directories - */ - public void setInstructionDirectories(List instructionDirectories) { - this.instructionDirectories = instructionDirectories; - } - - /** Gets plugin directories. @return the plugin directories */ - public List getPluginDirectories() { - return pluginDirectories == null ? null : Collections.unmodifiableList(pluginDirectories); - } - - /** Sets plugin directories. @param pluginDirectories the directories */ - public void setPluginDirectories(List pluginDirectories) { - this.pluginDirectories = pluginDirectories; - } - - /** Gets large output config. @return the large output config */ - public LargeToolOutputConfig getLargeOutput() { - return largeOutput; - } - - /** Sets large output config. @param largeOutput the large output config */ - public void setLargeOutput(LargeToolOutputConfig largeOutput) { - this.largeOutput = largeOutput; - } - - /** Gets disabled skills. @return the disabled skill names */ - public List getDisabledSkills() { - return disabledSkills == null ? null : Collections.unmodifiableList(disabledSkills); - } - - /** Sets disabled skills. @param disabledSkills the skill names to disable */ - public void setDisabledSkills(List disabledSkills) { - this.disabledSkills = disabledSkills; - } - - /** Gets infinite sessions config. @return the infinite sessions config */ - public InfiniteSessionConfig getInfiniteSessions() { - return infiniteSessions; - } - - /** - * Sets infinite sessions config. @param infiniteSessions the infinite sessions - * config - */ - public void setInfiniteSessions(InfiniteSessionConfig infiniteSessions) { - this.infiniteSessions = infiniteSessions; - } - - /** Gets the commands wire definitions. @return the commands */ - public List getCommands() { - return commands == null ? null : Collections.unmodifiableList(commands); - } - - /** Sets the commands wire definitions. @param commands the commands */ - public void setCommands(List commands) { - this.commands = commands; - } - - /** Gets the requestElicitation flag. @return the flag */ - public Boolean getRequestElicitation() { - return requestElicitation; - } - - /** Sets the requestElicitation flag. @param requestElicitation the flag */ - public void setRequestElicitation(boolean requestElicitation) { - this.requestElicitation = requestElicitation; - } - - /** - * Clears the requestElicitation setting, reverting to the default behavior. - */ - public void clearRequestElicitation() { - this.requestElicitation = null; - } - - /** Gets the requestMcpApps flag. @return the flag */ - public Boolean getRequestMcpApps() { - return requestMcpApps; - } - - /** Sets the requestMcpApps flag. @param requestMcpApps the flag */ - public void setRequestMcpApps(boolean requestMcpApps) { - this.requestMcpApps = requestMcpApps; - } - - /** Clears the requestMcpApps setting, reverting to the default behavior. */ - public void clearRequestMcpApps() { - this.requestMcpApps = null; - } - - /** Gets the requestExitPlanMode flag. @return the flag */ - public Boolean getRequestExitPlanMode() { - return requestExitPlanMode; - } - - /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */ - public void setRequestExitPlanMode(Boolean requestExitPlanMode) { - this.requestExitPlanMode = requestExitPlanMode; - } - - /** Gets the requestAutoModeSwitch flag. @return the flag */ - public Boolean getRequestAutoModeSwitch() { - return requestAutoModeSwitch; - } - - /** - * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag - */ - public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) { - this.requestAutoModeSwitch = requestAutoModeSwitch; - } - - /** Gets the model capabilities override. @return the override */ - public ModelCapabilitiesOverride getModelCapabilities() { - return modelCapabilities; - } - - /** - * Sets the model capabilities override. @param modelCapabilities the override - */ - public void setModelCapabilities(ModelCapabilitiesOverride modelCapabilities) { - this.modelCapabilities = modelCapabilities; - } - - /** Gets the GitHub token for per-session authentication. @return the token */ - public String getGitHubToken() { - return gitHubToken; - } - - /** - * Sets the GitHub token for per-session authentication. @param gitHubToken the - * token - */ - public void setGitHubToken(String gitHubToken) { - this.gitHubToken = gitHubToken; - } - - /** Gets the remote session mode. @return the remote session mode */ - public String getRemoteSession() { - return remoteSession; - } - - /** - * Sets the remote session mode. @param remoteSession the remote session mode - */ - public void setRemoteSession(String remoteSession) { - this.remoteSession = remoteSession; - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java b/java/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java deleted file mode 100644 index cd787d37f..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionResponse.java +++ /dev/null @@ -1,22 +0,0 @@ -package com.github.copilot.rpc; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Internal response object from resuming a session. - * - * @param sessionId - * the session ID - * @param workspacePath - * the workspace path, or {@code null} if infinite sessions are - * disabled - * @param capabilities - * the capabilities reported by the host, or {@code null} - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public record ResumeSessionResponse(@JsonProperty("sessionId") String sessionId, - @JsonProperty("workspacePath") String workspacePath, - @JsonProperty("capabilities") SessionCapabilities capabilities) { -} diff --git a/java/src/main/java/com/github/copilot/rpc/SystemPromptSections.java b/java/src/main/java/com/github/copilot/rpc/SystemPromptSections.java deleted file mode 100644 index 0aaf0113e..000000000 --- a/java/src/main/java/com/github/copilot/rpc/SystemPromptSections.java +++ /dev/null @@ -1,75 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -/** - * Well-known system prompt section identifiers for use with - * {@link SystemMessageMode#CUSTOMIZE} mode. - *

    - * Each constant names a section of the default Copilot system prompt. Pass - * these as keys in the {@code sections} map of {@link SystemMessageConfig} to - * override individual sections. - * - *

    Example

    - * - * 
    {@code
- * var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE).setSections(Map.of(
- * 		SystemPromptSections.TONE,
- * 		new SectionOverride().setAction(SectionOverrideAction.REPLACE).setContent("Always be concise."),
- * 		SystemPromptSections.CODE_CHANGE_RULES, new SectionOverride().setAction(SectionOverrideAction.REMOVE)));
- * }
    - * - * @see SystemMessageConfig - * @see SectionOverride - * @since 1.2.0 - */ -public final class SystemPromptSections { - - /** Agent identity preamble and mode statement. */ - public static final String IDENTITY = "identity"; - - /** Response style, conciseness rules, output formatting preferences. */ - public static final String TONE = "tone"; - - /** Tool usage patterns, parallel calling, batching guidelines. */ - public static final String TOOL_EFFICIENCY = "tool_efficiency"; - - /** CWD, OS, git root, directory listing, available tools. */ - public static final String ENVIRONMENT_CONTEXT = "environment_context"; - - /** Coding rules, linting/testing, ecosystem tools, style. */ - public static final String CODE_CHANGE_RULES = "code_change_rules"; - - /** Tips, behavioral best practices, behavioral guidelines. */ - public static final String GUIDELINES = "guidelines"; - - /** Environment limitations, prohibited actions, security policies. */ - public static final String SAFETY = "safety"; - - /** Per-tool usage instructions. */ - public static final String TOOL_INSTRUCTIONS = "tool_instructions"; - - /** Repository and organization custom instructions. */ - public static final String CUSTOM_INSTRUCTIONS = "custom_instructions"; - - /** - * Runtime-provided context and instructions (e.g. system notifications, - * memories, workspace context, mode-specific instructions, content-exclusion - * policy). - * - * @since 1.3.0 - */ - public static final String RUNTIME_INSTRUCTIONS = "runtime_instructions"; - - /** - * End-of-prompt instructions: parallel tool calling, persistence, task - * completion. - */ - public static final String LAST_INSTRUCTIONS = "last_instructions"; - - private SystemPromptSections() { - // utility class - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/ToolDefinition.java b/java/src/main/java/com/github/copilot/rpc/ToolDefinition.java deleted file mode 100644 index c880e5a77..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ToolDefinition.java +++ /dev/null @@ -1,136 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Defines a tool that can be invoked by the AI assistant. - *

    - * Tools extend the assistant's capabilities by allowing it to call back into - * your application to perform actions or retrieve information. Each tool has a - * name, description, parameter schema, and a handler function that executes - * when the tool is invoked. - * - *

    Example Usage

    - * - * 
    {@code
- * // Define a record for your tool's arguments
- * record WeatherArgs(String location) {
- * }
- *
- * var tool = ToolDefinition.create("get_weather", "Get the current weather for a location",
- * 		Map.of("type", "object", "properties",
- * 				Map.of("location", Map.of("type", "string", "description", "City name")), "required",
- * 				List.of("location")),
- * 		invocation -> {
- * 			// Type-safe access with records (recommended)
- * 			WeatherArgs args = invocation.getArgumentsAs(WeatherArgs.class);
- * 			return CompletableFuture.completedFuture(getWeatherData(args.location()));
- *
- * 			// Or use Map-based access
- * 			// Map args = invocation.getArguments();
- * 			// String location = (String) args.get("location");
- * 		});
- * }
    - * - * @param name - * the unique name of the tool - * @param description - * a description of what the tool does - * @param parameters - * the JSON Schema defining the tool's parameters - * @param handler - * the handler function to execute when invoked - * @param overridesBuiltInTool - * when {@code true}, indicates that this tool intentionally - * overrides a built-in CLI tool with the same name; {@code null} or - * {@code false} means the tool is purely custom - * @param skipPermission - * when {@code true}, the CLI skips the permission request for this - * tool invocation; {@code null} or {@code false} uses normal - * permission handling - * @see SessionConfig#setTools(java.util.List) - * @see ToolHandler - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public record ToolDefinition(@JsonProperty("name") String name, @JsonProperty("description") String description, - @JsonProperty("parameters") Object parameters, @JsonIgnore ToolHandler handler, - @JsonProperty("overridesBuiltInTool") Boolean overridesBuiltInTool, - @JsonProperty("skipPermission") Boolean skipPermission) { - - /** - * Creates a tool definition with a JSON schema for parameters. - *

    - * This is a convenience factory method for creating tools with a - * {@code Map}-based parameter schema. - * - * @param name - * the unique name of the tool - * @param description - * a description of what the tool does - * @param schema - * the JSON Schema as a {@code Map} - * @param handler - * the handler function to execute when invoked - * @return a new tool definition - */ - public static ToolDefinition create(String name, String description, Map schema, - ToolHandler handler) { - return new ToolDefinition(name, description, schema, handler, null, null); - } - - /** - * Creates a tool definition that overrides a built-in CLI tool. - *

    - * Use this factory method when you want your custom tool to replace a built-in - * tool (e.g., {@code grep}, {@code read_file}) with the same name. Setting - * {@code overridesBuiltInTool} to {@code true} signals to the CLI that this is - * intentional. - * - * @param name - * the name of the built-in tool to override - * @param description - * a description of what the tool does - * @param schema - * the JSON Schema as a {@code Map} - * @param handler - * the handler function to execute when invoked - * @return a new tool definition with the override flag set - * @since 1.0.11 - */ - public static ToolDefinition createOverride(String name, String description, Map schema, - ToolHandler handler) { - return new ToolDefinition(name, description, schema, handler, true, null); - } - - /** - * Creates a tool definition that skips the permission request. - *

    - * Use this factory method when the tool is safe to invoke without user - * permission confirmation. Setting {@code skipPermission} to {@code true} - * signals to the CLI that no permission check is needed. - * - * @param name - * the unique name of the tool - * @param description - * a description of what the tool does - * @param schema - * the JSON Schema as a {@code Map} - * @param handler - * the handler function to execute when invoked - * @return a new tool definition with permission skipping enabled - * @since 1.2.0 - */ - public static ToolDefinition createSkipPermission(String name, String description, Map schema, - ToolHandler handler) { - return new ToolDefinition(name, description, schema, handler, null, true); - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/ToolResultObject.java b/java/src/main/java/com/github/copilot/rpc/ToolResultObject.java deleted file mode 100644 index e55ff9ab6..000000000 --- a/java/src/main/java/com/github/copilot/rpc/ToolResultObject.java +++ /dev/null @@ -1,111 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot.rpc; - -import java.util.List; -import java.util.Map; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -/** - * Result object returned from a tool execution. - *

    - * This record represents the structured result of a tool invocation, including - * text output, binary data, error information, and telemetry. - * - *

    Example: Success Result

    - * - * 
    {@code
- * return ToolResultObject.success("File contents: " + content);
- * }
    - * - *

    Example: Error Result

    - * - * 
    {@code
- * return ToolResultObject.error("File not found: " + path);
- * }
    - * - *

    Example: Custom Result

    - * - * 
    {@code
- * return new ToolResultObject("success", "Result text", null, null, null, null);
- * }
    - * - * @param resultType - * the result type ("success" or "error"), defaults to "success" - * @param textResultForLlm - * the text result to be sent to the LLM - * @param binaryResultsForLlm - * the list of binary results to be sent to the LLM - * @param error - * the error message, or {@code null} if successful - * @param sessionLog - * the session log text - * @param toolTelemetry - * the tool telemetry data - * @see ToolHandler - * @see ToolBinaryResult - * @since 1.0.0 - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -public record ToolResultObject(@JsonProperty("resultType") String resultType, - @JsonProperty("textResultForLlm") String textResultForLlm, - @JsonProperty("binaryResultsForLlm") List binaryResultsForLlm, - @JsonProperty("error") String error, @JsonProperty("sessionLog") String sessionLog, - @JsonProperty("toolTelemetry") Map toolTelemetry) { - - /** - * Creates a success result with the given text. - * - * @param textResultForLlm - * the text result to be sent to the LLM - * @return a success result - */ - public static ToolResultObject success(String textResultForLlm) { - return new ToolResultObject("success", textResultForLlm, null, null, null, null); - } - - /** - * Creates an error result with the given error message. - * - * @param error - * the error message - * @return an error result - */ - public static ToolResultObject error(String error) { - return new ToolResultObject("error", null, null, error, null, null); - } - - /** - * Creates an error result with both a text result and error message. - * - * @param textResultForLlm - * the text result to be sent to the LLM - * @param error - * the error message - * @return an error result - */ - public static ToolResultObject error(String textResultForLlm, String error) { - return new ToolResultObject("error", textResultForLlm, null, error, null, null); - } - - /** - * Creates a failure result with the given text and error message. - *

    - * The "failure" result type indicates that the tool execution itself failed - * (e.g., tool not found), while "error" indicates the tool executed but - * encountered an error during processing. - * - * @param textResultForLlm - * the text result to be sent to the LLM - * @param error - * the error message - * @return a failure result - */ - public static ToolResultObject failure(String textResultForLlm, String error) { - return new ToolResultObject("failure", textResultForLlm, null, error, null, null); - } -} diff --git a/java/src/main/java/com/github/copilot/rpc/package-info.java b/java/src/main/java/com/github/copilot/rpc/package-info.java deleted file mode 100644 index edc7dedcf..000000000 --- a/java/src/main/java/com/github/copilot/rpc/package-info.java +++ /dev/null @@ -1,95 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -/** - * Configuration classes and data transfer objects for the Copilot SDK. - * - *

    - * This package contains all the configuration, request, response, and data - * transfer objects used throughout the SDK. These classes are designed for JSON - * serialization with Jackson and provide fluent setter methods for convenient - * configuration. - * - *

    Client Configuration

    - *
      - *
    • {@link com.github.copilot.rpc.CopilotClientOptions} - Options for - * configuring the {@link com.github.copilot.CopilotClient}, including CLI path, - * port, transport mode, and auto-start behavior.
      • - *
    - * - *

    Session Configuration

    - *
      - *
    • {@link com.github.copilot.rpc.SessionConfig} - Configuration for creating - * a new session, including model selection, tools, system message, and MCP - * server configuration.
      • - *
    • {@link com.github.copilot.rpc.ResumeSessionConfig} - Configuration for - * resuming an existing session.
      • - *
    • {@link com.github.copilot.rpc.InfiniteSessionConfig} - Configuration for - * infinite sessions with automatic context compaction.
      • - *
    • {@link com.github.copilot.rpc.SystemMessageConfig} - System message - * customization options.
      • - *
    - * - *

    Message and Tool Configuration

    - *
      - *
    • {@link com.github.copilot.rpc.MessageOptions} - Options for sending - * messages, including prompt text and attachments.
      • - *
    • {@link com.github.copilot.rpc.ToolDefinition} - Definition of a custom - * tool that can be invoked by the assistant.
      • - *
    • {@link com.github.copilot.rpc.ToolInvocation} - Represents a tool - * invocation request from the assistant.
      • - *
    • {@link com.github.copilot.rpc.Attachment} - File attachment for - * messages.
      • - *
    - * - *

    Provider Configuration (BYOK)

    - *
      - *
    • {@link com.github.copilot.rpc.ProviderConfig} - Configuration for using - * your own API keys with custom providers (OpenAI, Azure, etc.).
      • - *
    • {@link com.github.copilot.rpc.AzureOptions} - Azure-specific - * configuration options.
      • - *
    - * - *

    Model Information

    - *
      - *
    • {@link com.github.copilot.rpc.ModelInfo} - Information about an available - * AI model.
      • - *
    • {@link com.github.copilot.rpc.ModelCapabilities} - Model capabilities and - * limits.
      • - *
    • {@link com.github.copilot.rpc.ModelPolicy} - Model policy and state - * information.
      • - *
    - * - *

    Custom Agents

    - *
      - *
    • {@link com.github.copilot.rpc.CustomAgentConfig} - Configuration for - * custom agents with specialized behaviors and tools.
      • - *
    - * - *

    Permissions

    - *
      - *
    • {@link com.github.copilot.rpc.PermissionHandler} - Handler for permission - * requests from the assistant.
      • - *
    • {@link com.github.copilot.rpc.PermissionRequest} - A permission request - * from the assistant.
      • - *
    • {@link com.github.copilot.rpc.PermissionRequestResult} - Result of a - * permission request decision.
      • - *
    - * - *

    Usage Example

    - * - * 
    {@code
- * var config = new SessionConfig().setModel("gpt-4.1").setStreaming(true)
- * 		.setSystemMessage(new SystemMessageConfig().setMode(SystemMessageMode.APPEND)
- * 				.setContent("Be concise in your responses."))
- * 		.setTools(List.of(ToolDefinition.create("my_tool", "Description", schema, handler)));
- *
- * var session = client.createSession(config).get();
- * }
    - * - * @see com.github.copilot.CopilotClient - * @see com.github.copilot.CopilotSession - */ -@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "DTOs for JSON deserialization - low risk") -package com.github.copilot.rpc; diff --git a/java/src/main/java/module-info.java b/java/src/main/java/module-info.java deleted file mode 100644 index 01b741694..000000000 --- a/java/src/main/java/module-info.java +++ /dev/null @@ -1,26 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -/** - * GitHub Copilot SDK for Java. - */ -module com.github.copilot.java { - requires transitive com.fasterxml.jackson.annotation; - requires com.fasterxml.jackson.core; - requires transitive com.fasterxml.jackson.databind; - requires com.fasterxml.jackson.datatype.jsr310; - requires static com.github.spotbugs.annotations; - requires static java.compiler; - requires static java.net.http; - requires java.logging; - - exports com.github.copilot; - exports com.github.copilot.generated; - exports com.github.copilot.generated.rpc; - exports com.github.copilot.rpc; - - opens com.github.copilot to com.fasterxml.jackson.databind; - opens com.github.copilot.generated to com.fasterxml.jackson.databind; - opens com.github.copilot.rpc to com.fasterxml.jackson.databind; -} diff --git a/java/src/test/java/com/github/copilot/HooksTest.java b/java/src/test/java/com/github/copilot/HooksTest.java deleted file mode 100644 index 4608848f1..000000000 --- a/java/src/test/java/com/github/copilot/HooksTest.java +++ /dev/null @@ -1,226 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import static org.junit.jupiter.api.Assertions.*; - -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.ArrayList; -import java.util.Set; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.TimeUnit; -import java.util.stream.Collectors; - -import org.junit.jupiter.api.AfterAll; -import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.Test; - -import com.github.copilot.rpc.MessageOptions; -import com.github.copilot.rpc.PermissionHandler; -import com.github.copilot.rpc.PostToolUseHookInput; -import com.github.copilot.rpc.PreToolUseHookInput; -import com.github.copilot.rpc.PreToolUseHookOutput; -import com.github.copilot.rpc.SessionConfig; -import com.github.copilot.rpc.SessionHooks; - -/** - * Tests for hooks functionality (pre-tool-use and post-tool-use hooks). - * - *

    - * These tests use the shared CapiProxy infrastructure for deterministic API - * response replay. Snapshots are stored in test/snapshots/hooks/. - *

    - * - *

    - * Note: Tests for userPromptSubmitted, sessionStart, and sessionEnd hooks are - * not included as they are not tested in the reference implementation .NET or - * Node.js SDKs and require test harness updates to properly invoke these hooks. - *

    - */ -public class HooksTest { - - private static E2ETestContext ctx; - - @BeforeAll - static void setup() throws Exception { - ctx = E2ETestContext.create(); - } - - @AfterAll - static void teardown() throws Exception { - if (ctx != null) { - ctx.close(); - } - } - - /** - * Verifies that pre-tool-use hook is invoked when model runs a tool. - * - * @see Snapshot: hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool - */ - @Test - void testInvokePreToolUseHookWhenModelRunsATool() throws Exception { - ctx.configureForTest("hooks", "invoke_pre_tool_use_hook_when_model_runs_a_tool"); - - var preToolUseInputs = new ArrayList(); - final String[] sessionIdHolder = new String[1]; - - var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) - .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { - preToolUseInputs.add(input); - assertEquals(sessionIdHolder[0], invocation.getSessionId()); - return CompletableFuture.completedFuture(PreToolUseHookOutput.allow()); - })); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(config).get(); - sessionIdHolder[0] = session.getSessionId(); - - // Create a file for the model to read - Path testFile = ctx.getWorkDir().resolve("hello.txt"); - Files.writeString(testFile, "Hello from the test!"); - - session.sendAndWait( - new MessageOptions().setPrompt("Read the contents of hello.txt and tell me what it says")) - .get(60, TimeUnit.SECONDS); - - // Should have received at least one preToolUse hook call - assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); - - // Should have received the tool name - assertTrue(preToolUseInputs.stream().anyMatch(i -> i.getToolName() != null && !i.getToolName().isEmpty()), - "Should have received tool name in preToolUse hook"); - } - } - - /** - * Verifies that post-tool-use hook is invoked after model runs a tool. - * - * @see Snapshot: hooks/invoke_post_tool_use_hook_after_model_runs_a_tool - */ - @Test - void testInvokePostToolUseHookAfterModelRunsATool() throws Exception { - ctx.configureForTest("hooks", "invoke_post_tool_use_hook_after_model_runs_a_tool"); - - var postToolUseInputs = new ArrayList(); - final String[] sessionIdHolder = new String[1]; - - var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) - .setHooks(new SessionHooks().setOnPostToolUse((input, invocation) -> { - postToolUseInputs.add(input); - assertEquals(sessionIdHolder[0], invocation.getSessionId()); - return CompletableFuture.completedFuture(null); - })); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(config).get(); - sessionIdHolder[0] = session.getSessionId(); - - // Create a file for the model to read - Path testFile = ctx.getWorkDir().resolve("world.txt"); - Files.writeString(testFile, "World from the test!"); - - session.sendAndWait( - new MessageOptions().setPrompt("Read the contents of world.txt and tell me what it says")) - .get(60, TimeUnit.SECONDS); - - // Should have received at least one postToolUse hook call - assertFalse(postToolUseInputs.isEmpty(), "Should have received postToolUse hook calls"); - - // Should have received the tool name and result - assertTrue(postToolUseInputs.stream().anyMatch(i -> i.getToolName() != null && !i.getToolName().isEmpty()), - "Should have received tool name in postToolUse hook"); - assertTrue(postToolUseInputs.stream().anyMatch(i -> i.getToolResult() != null), - "Should have received tool result in postToolUse hook"); - } - } - - /** - * Verifies that both hooks are invoked for a single tool call. - * - * @see Snapshot: hooks/invoke_both_hooks_for_single_tool_call - */ - @Test - void testInvokeBothHooksForSingleToolCall() throws Exception { - ctx.configureForTest("hooks", "invoke_both_hooks_for_single_tool_call"); - - var preToolUseInputs = new ArrayList(); - var postToolUseInputs = new ArrayList(); - - var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) - .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { - preToolUseInputs.add(input); - return CompletableFuture.completedFuture(PreToolUseHookOutput.allow()); - }).setOnPostToolUse((input, invocation) -> { - postToolUseInputs.add(input); - return CompletableFuture.completedFuture(null); - })); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(config).get(); - - // Create a file for the model to read - Path testFile = ctx.getWorkDir().resolve("both.txt"); - Files.writeString(testFile, "Testing both hooks!"); - - session.sendAndWait(new MessageOptions().setPrompt("Read the contents of both.txt")).get(60, - TimeUnit.SECONDS); - - // Both hooks should have been called - assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); - assertFalse(postToolUseInputs.isEmpty(), "Should have received postToolUse hook calls"); - - // The same tool should appear in both - Set preToolNames = preToolUseInputs.stream().map(PreToolUseHookInput::getToolName) - .filter(n -> n != null && !n.isEmpty()).collect(Collectors.toSet()); - Set postToolNames = postToolUseInputs.stream().map(PostToolUseHookInput::getToolName) - .filter(n -> n != null && !n.isEmpty()).collect(Collectors.toSet()); - - // Check if there's any overlap - boolean hasOverlap = preToolNames.stream().anyMatch(postToolNames::contains); - assertTrue(hasOverlap, "Expected the same tool to appear in both pre and post hooks"); - } - } - - /** - * Verifies that tool execution is denied when pre-tool-use returns deny. - * - * @see Snapshot: hooks/deny_tool_execution_when_pre_tool_use_returns_deny - */ - @Test - void testDenyToolExecutionWhenPreToolUseReturnsDeny() throws Exception { - ctx.configureForTest("hooks", "deny_tool_execution_when_pre_tool_use_returns_deny"); - - var preToolUseInputs = new ArrayList(); - - var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL) - .setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> { - preToolUseInputs.add(input); - // Deny all tool calls - return CompletableFuture.completedFuture(PreToolUseHookOutput.deny()); - })); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(config).get(); - - // Create a file - Path testFile = ctx.getWorkDir().resolve("protected.txt"); - String originalContent = "Original content that should not be modified"; - Files.writeString(testFile, originalContent); - - var response = session - .sendAndWait( - new MessageOptions().setPrompt("Edit protected.txt and replace 'Original' with 'Modified'")) - .get(60, TimeUnit.SECONDS); - - // The hook should have been called - assertFalse(preToolUseInputs.isEmpty(), "Should have received preToolUse hook calls"); - - // The response should be defined - assertNotNull(response, "Response should not be null"); - } - } -} diff --git a/java/src/test/java/com/github/copilot/PermissionRequestResultTest.java b/java/src/test/java/com/github/copilot/PermissionRequestResultTest.java deleted file mode 100644 index 4a1ff0313..000000000 --- a/java/src/test/java/com/github/copilot/PermissionRequestResultTest.java +++ /dev/null @@ -1,73 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import static org.junit.jupiter.api.Assertions.*; - -import org.junit.jupiter.api.Test; - -import com.github.copilot.rpc.PermissionRequestResult; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.json.JsonMapper; -import com.fasterxml.jackson.annotation.JsonInclude; - -/** - * Tests for {@link PermissionRequestResult} factory methods and feedback field. - */ -public class PermissionRequestResultTest { - - private static final ObjectMapper MAPPER = JsonMapper.builder().serializationInclusion(JsonInclude.Include.NON_NULL) - .build(); - - @Test - void testApproveOnce() { - var result = PermissionRequestResult.approveOnce(); - assertEquals("approve-once", result.getKind()); - assertNull(result.getFeedback()); - } - - @Test - void testRejectWithFeedback() { - var result = PermissionRequestResult.reject("Not allowed"); - assertEquals("reject", result.getKind()); - assertEquals("Not allowed", result.getFeedback()); - } - - @Test - void testRejectWithoutFeedback() { - var result = PermissionRequestResult.reject(null); - assertEquals("reject", result.getKind()); - assertNull(result.getFeedback()); - } - - @Test - void testUserNotAvailable() { - var result = PermissionRequestResult.userNotAvailable(); - assertEquals("user-not-available", result.getKind()); - assertNull(result.getFeedback()); - } - - @Test - void testNoResult() { - var result = PermissionRequestResult.noResult(); - assertEquals("no-result", result.getKind()); - assertNull(result.getFeedback()); - } - - @Test - void testFeedbackSerialized() throws Exception { - var result = PermissionRequestResult.reject("Unsafe operation"); - var json = MAPPER.writeValueAsString(result); - assertTrue(json.contains("\"feedback\":\"Unsafe operation\"")); - assertTrue(json.contains("\"kind\":\"reject\"")); - } - - @Test - void testFeedbackNotSerializedWhenNull() throws Exception { - var result = PermissionRequestResult.approveOnce(); - var json = MAPPER.writeValueAsString(result); - assertFalse(json.contains("feedback")); - } -} diff --git a/java/src/test/java/com/github/copilot/SessionConfigE2ETest.java b/java/src/test/java/com/github/copilot/SessionConfigE2ETest.java deleted file mode 100644 index dbae0fe9f..000000000 --- a/java/src/test/java/com/github/copilot/SessionConfigE2ETest.java +++ /dev/null @@ -1,174 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import static org.junit.jupiter.api.Assertions.*; - -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.List; -import java.util.Map; -import java.util.concurrent.TimeUnit; - -import org.junit.jupiter.api.AfterAll; -import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.Test; - -import com.github.copilot.rpc.MessageOptions; -import com.github.copilot.rpc.PermissionHandler; -import com.github.copilot.rpc.ProviderConfig; -import com.github.copilot.rpc.ResumeSessionConfig; -import com.github.copilot.rpc.SessionConfig; - -/** - * E2E tests for session configuration features. - */ -public class SessionConfigE2ETest { - - private static E2ETestContext ctx; - - @BeforeAll - static void setup() throws Exception { - ctx = E2ETestContext.create(); - } - - @AfterAll - static void teardown() throws Exception { - if (ctx != null) { - ctx.close(); - } - } - - @Test - void testShouldApplyInstructionDirectoriesOnCreate() throws Exception { - ctx.configureForTest("session_config", "should_apply_instructiondirectories_on_create"); - - // Set up instruction directory with a custom instruction file - Path projectDir = ctx.getWorkDir().resolve("instruction-create-project"); - Path instructionDir = ctx.getWorkDir().resolve("extra-create-instructions"); - Path instructionFilesDir = instructionDir.resolve(".github").resolve("instructions"); - String sentinel = "JAVA_CREATE_INSTRUCTION_DIRECTORIES_SENTINEL"; - Files.createDirectories(projectDir); - Files.createDirectories(instructionFilesDir); - Files.writeString(instructionFilesDir.resolve("extra.instructions.md"), "Always include " + sentinel + "."); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(new SessionConfig().setWorkingDirectory(projectDir.toString()) - .setInstructionDirectories(List.of(instructionDir.toString())) - .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); - - session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(60, TimeUnit.SECONDS); - - List> exchanges = ctx.getExchanges(); - assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); - String systemMessage = getSystemMessage(exchanges.get(0)); - assertNotNull(systemMessage, "System message should not be null"); - assertTrue(systemMessage.contains(sentinel), - "System message should contain the instruction sentinel: " + sentinel); - } - } - - @Test - void testShouldApplyInstructionDirectoriesOnResume() throws Exception { - ctx.configureForTest("session_config", "should_apply_instructiondirectories_on_resume"); - - // Set up instruction directory with a custom instruction file - Path projectDir = ctx.getWorkDir().resolve("instruction-resume-project"); - Path instructionDir = ctx.getWorkDir().resolve("extra-resume-instructions"); - Path instructionFilesDir = instructionDir.resolve(".github").resolve("instructions"); - String sentinel = "JAVA_RESUME_INSTRUCTION_DIRECTORIES_SENTINEL"; - Files.createDirectories(projectDir); - Files.createDirectories(instructionFilesDir); - Files.writeString(instructionFilesDir.resolve("extra.instructions.md"), "Always include " + sentinel + "."); - - try (CopilotClient client = ctx.createClient()) { - // Create a session first - CopilotSession session1 = client.createSession(new SessionConfig() - .setWorkingDirectory(projectDir.toString()).setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) - .get(); - - // Resume with instructionDirectories - CopilotSession session2 = client.resumeSession(session1.getSessionId(), - new ResumeSessionConfig().setWorkingDirectory(projectDir.toString()) - .setInstructionDirectories(List.of(instructionDir.toString())) - .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) - .get(); - - session2.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(60, TimeUnit.SECONDS); - - List> exchanges = ctx.getExchanges(); - assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); - String systemMessage = getSystemMessage(exchanges.get(0)); - assertNotNull(systemMessage, "System message should not be null"); - assertTrue(systemMessage.contains(sentinel), - "System message should contain the instruction sentinel: " + sentinel); - } - } - - @Test - void testShouldForwardProviderWireModel() throws Exception { - ctx.configureForTest("session_config", "should_forward_provider_wire_model"); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client - .createSession(new SessionConfig().setModel("claude-sonnet-4.5") - .setProvider(new ProviderConfig().setType("openai").setBaseUrl(ctx.getProxyUrl()) - .setApiKey("test-provider-key").setWireModel("test-wire-model") - .setMaxOutputTokens(1024)) - .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)) - .get(); - - session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(30, TimeUnit.SECONDS); - - List> exchanges = ctx.getExchanges(); - assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); - @SuppressWarnings("unchecked") - Map request = (Map) exchanges.get(0).get("request"); - assertEquals("test-wire-model", request.get("model")); - } - } - - @Test - void testShouldUseProviderModelIdAsWireModel() throws Exception { - ctx.configureForTest("session_config", "should_use_provider_model_id_as_wire_model"); - - try (CopilotClient client = ctx.createClient()) { - CopilotSession session = client.createSession(new SessionConfig() - .setProvider(new ProviderConfig().setType("openai").setBaseUrl(ctx.getProxyUrl()) - .setApiKey("test-provider-key").setModelId("claude-sonnet-4.5")) - .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get(); - - session.sendAndWait(new MessageOptions().setPrompt("What is 1+1?")).get(30, TimeUnit.SECONDS); - - List> exchanges = ctx.getExchanges(); - assertFalse(exchanges.isEmpty(), "Should have at least one exchange"); - @SuppressWarnings("unchecked") - Map request = (Map) exchanges.get(0).get("request"); - assertEquals("claude-sonnet-4.5", request.get("model")); - } - } - - @SuppressWarnings("unchecked") - private static String getSystemMessage(Map exchange) { - // The exchange structure is: { request: { messages: [...] }, response: ..., - // requestHeaders: ... } - Object requestObj = exchange.get("request"); - if (!(requestObj instanceof Map request)) { - return null; - } - Object messagesObj = request.get("messages"); - if (messagesObj instanceof List messages) { - for (Object msg : messages) { - if (msg instanceof Map msgMap) { - if ("system".equals(msgMap.get("role"))) { - Object content = msgMap.get("content"); - return content != null ? content.toString() : null; - } - } - } - } - return null; - } -} diff --git a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java b/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java deleted file mode 100644 index 9b7e28e85..000000000 --- a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java +++ /dev/null @@ -1,835 +0,0 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - *--------------------------------------------------------------------------------------------*/ - -package com.github.copilot; - -import static org.junit.jupiter.api.Assertions.*; - -import java.util.List; -import java.util.Map; -import java.util.concurrent.CompletableFuture; - -import org.junit.jupiter.api.Test; - -import com.github.copilot.rpc.AutoModeSwitchResponse; -import com.github.copilot.rpc.CloudSessionOptions; -import com.github.copilot.rpc.CloudSessionRepository; -import com.github.copilot.rpc.CreateSessionRequest; -import com.github.copilot.rpc.DefaultAgentConfig; -import com.github.copilot.rpc.ElicitationHandler; -import com.github.copilot.rpc.ElicitationResult; -import com.github.copilot.rpc.ElicitationResultAction; -import com.github.copilot.rpc.ExitPlanModeResult; -import com.github.copilot.rpc.LargeToolOutputConfig; -import com.github.copilot.rpc.ResumeSessionConfig; -import com.github.copilot.rpc.ResumeSessionRequest; -import com.github.copilot.rpc.SessionConfig; -import com.github.copilot.rpc.SessionHooks; -import com.github.copilot.rpc.ToolDefinition; -import com.github.copilot.rpc.UserInputResponse; - -/** - * Unit tests for {@link SessionRequestBuilder} branch coverage. - *

    - * Exercises branches in buildCreateRequest, buildResumeRequest, and - * configureSession that are not reached by E2E tests. - */ -public class SessionRequestBuilderTest { - - // ========================================================================= - // buildCreateRequest - // ========================================================================= - - @Test - void testBuildCreateRequestNullConfig() { - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(null); - assertNotNull(request); - assertNull(request.getModel()); - assertTrue(request.getRequestPermission(), "requestPermission should be true even for null config"); - assertEquals("direct", request.getEnvValueMode(), "envValueMode should be 'direct' even for null config"); - } - - @Test - void testBuildCreateRequestHooksNonNullButEmpty() { - // Hooks object exists but hasHooks() returns false - var config = new SessionConfig().setHooks(new SessionHooks()); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertNull(request.getHooks(), "Should be null when hooks are empty"); - } - - @Test - void testBuildCreateRequestHooksWithHandler() { - var hooks = new SessionHooks().setOnPreToolUse((input, inv) -> CompletableFuture.completedFuture(null)); - var config = new SessionConfig().setHooks(hooks); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertTrue(request.getHooks(), "Should be true when hooks have handlers"); - } - - @Test - void testBuildCreateRequestSetsEnvValueModeToDirect() { - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig()); - assertEquals("direct", request.getEnvValueMode()); - } - - @Test - void testBuildCreateRequestAlwaysSetsRequestPermissionTrue() { - // No permission handler set - requestPermission should still be true - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(new SessionConfig()); - assertTrue(request.getRequestPermission(), - "requestPermission should always be true to enable deny-by-default behavior"); - } - - @Test - void testBuildCreateRequestSetsClientName() { - var config = new SessionConfig().setClientName("my-app"); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertEquals("my-app", request.getClientName()); - } - - @Test - void testBuildCreateRequestSetsReasoningSummary() { - var config = new SessionConfig().setReasoningSummary("concise"); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertEquals("concise", request.getReasoningSummary()); - } - - @Test - void testBuildCreateRequestSetsContextTier() { - var config = new SessionConfig().setContextTier("long_context"); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertEquals("long_context", request.getContextTier()); - } - - @Test - void testBuildCreateRequestSetsPluginDirectoriesAndLargeOutput() { - var largeOutput = new LargeToolOutputConfig().setEnabled(true).setMaxSizeBytes(1024L) - .setOutputDirectory("/tmp/out"); - var config = new SessionConfig().setPluginDirectories(List.of("/plugins/a")).setLargeOutput(largeOutput); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertEquals(List.of("/plugins/a"), request.getPluginDirectories()); - assertEquals(largeOutput, request.getLargeOutput()); - } - - @Test - void testBuildCreateRequestForwardsEnableSessionTelemetryWhenFalse() { - var config = new SessionConfig().setEnableSessionTelemetry(false); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertFalse(request.getEnableSessionTelemetry()); - } - - @Test - void testBuildCreateRequestOmitsEnableSessionTelemetryWhenNotSet() { - var config = new SessionConfig(); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertNull(request.getEnableSessionTelemetry()); - } - - @Test - void testBuildCreateRequestPassesThroughNullMcpOAuthTokenStorage() { - var config = new SessionConfig(); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertNull(request.getMcpOAuthTokenStorage()); - } - - @Test - void testBuildCreateRequestForwardsExplicitMcpOAuthTokenStorage() { - var config = new SessionConfig().setMcpOAuthTokenStorage("persistent"); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - assertEquals("persistent", request.getMcpOAuthTokenStorage()); - } - - @Test - void testBuildCreateRequestNullConfigHasNullMcpOAuthTokenStorage() { - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(null); - assertNull(request.getMcpOAuthTokenStorage()); - } - - // ========================================================================= - // buildResumeRequest - // ========================================================================= - - @Test - void testBuildResumeRequestNullConfig() { - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", null); - assertEquals("sid-1", request.getSessionId()); - assertNull(request.getModel()); - assertTrue(request.getRequestPermission(), "requestPermission should be true even for null config"); - assertEquals("direct", request.getEnvValueMode(), "envValueMode should be 'direct' even for null config"); - } - - @Test - void testBuildResumeRequestForwardsEnableSessionTelemetryWhenFalse() { - var config = new ResumeSessionConfig().setEnableSessionTelemetry(false); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); - assertFalse(request.getEnableSessionTelemetry()); - } - - @Test - void testBuildResumeRequestOmitsEnableSessionTelemetryWhenNotSet() { - var config = new ResumeSessionConfig(); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-1", config); - assertNull(request.getEnableSessionTelemetry()); - } - - @Test - void testBuildResumeRequestWithTools() { - var tool = ToolDefinition.create("my_tool", "A tool", Map.of("type", "object"), - inv -> CompletableFuture.completedFuture("result")); - var config = new ResumeSessionConfig().setTools(List.of(tool)); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-2", config); - - assertNotNull(request.getTools()); - assertEquals(1, request.getTools().size()); - assertEquals("my_tool", request.getTools().get(0).name()); - } - - @Test - void testBuildResumeRequestWithUserInputHandler() { - var config = new ResumeSessionConfig() - .setOnUserInputRequest((req, inv) -> CompletableFuture.completedFuture(new UserInputResponse())); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-3", config); - - assertTrue(request.getRequestUserInput()); - } - - @Test - void testBuildResumeRequestHooksNonNullButEmpty() { - var config = new ResumeSessionConfig().setHooks(new SessionHooks()); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-4", config); - - assertNull(request.getHooks(), "Should be null when hooks are empty"); - } - - @Test - void testBuildResumeRequestHooksWithHandler() { - var hooks = new SessionHooks().setOnSessionEnd((input, inv) -> CompletableFuture.completedFuture(null)); - var config = new ResumeSessionConfig().setHooks(hooks); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-5", config); - - assertTrue(request.getHooks(), "Should be true when hooks have handlers"); - } - - @Test - void testBuildResumeRequestDisableResume() { - var config = new ResumeSessionConfig().setDisableResume(true); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-6", config); - - assertTrue(request.getDisableResume()); - } - - @Test - void testBuildResumeRequestStreaming() { - var config = new ResumeSessionConfig().setStreaming(true); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-7", config); - - assertTrue(request.getStreaming()); - } - - @Test - void testBuildResumeRequestSetsEnvValueModeToDirect() { - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-8", new ResumeSessionConfig()); - assertEquals("direct", request.getEnvValueMode()); - } - - @Test - void testBuildResumeRequestAlwaysSetsRequestPermissionTrue() { - // No permission handler set - requestPermission should still be true - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-9", new ResumeSessionConfig()); - assertTrue(request.getRequestPermission(), - "requestPermission should always be true to enable deny-by-default behavior"); - } - - @Test - void testBuildResumeRequestSetsClientName() { - var config = new ResumeSessionConfig().setClientName("my-app"); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-10", config); - assertEquals("my-app", request.getClientName()); - } - - @Test - void testBuildCreateRequestPropagatesGranularMultitenancyFields() { - var config = new SessionConfig().setSkipEmbeddingRetrieval(true) - .setOrganizationCustomInstructions("Create org instructions") - .setEnableOnDemandInstructionDiscovery(false).setEnableFileHooks(true).setEnableHostGitOperations(false) - .setEnableSessionStore(true).setEnableSkills(false); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertTrue(request.getSkipEmbeddingRetrieval()); - assertEquals("Create org instructions", request.getOrganizationCustomInstructions()); - assertFalse(request.getEnableOnDemandInstructionDiscovery()); - assertTrue(request.getEnableFileHooks()); - assertFalse(request.getEnableHostGitOperations()); - assertTrue(request.getEnableSessionStore()); - assertFalse(request.getEnableSkills()); - } - - @Test - void testBuildResumeRequestPropagatesGranularMultitenancyFields() { - var config = new ResumeSessionConfig().setSkipEmbeddingRetrieval(false) - .setOrganizationCustomInstructions("Resume org instructions") - .setEnableOnDemandInstructionDiscovery(true).setEnableFileHooks(false).setEnableHostGitOperations(true) - .setEnableSessionStore(false).setEnableSkills(true); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-11", config); - - assertFalse(request.getSkipEmbeddingRetrieval()); - assertEquals("Resume org instructions", request.getOrganizationCustomInstructions()); - assertTrue(request.getEnableOnDemandInstructionDiscovery()); - assertFalse(request.getEnableFileHooks()); - assertTrue(request.getEnableHostGitOperations()); - assertFalse(request.getEnableSessionStore()); - assertTrue(request.getEnableSkills()); - } - - @Test - void testBuildResumeRequestPassesThroughNullMcpOAuthTokenStorage() { - var config = new ResumeSessionConfig(); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-12", config); - assertNull(request.getMcpOAuthTokenStorage()); - } - - @Test - void testBuildResumeRequestForwardsExplicitMcpOAuthTokenStorage() { - var config = new ResumeSessionConfig().setMcpOAuthTokenStorage("persistent"); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-13", config); - assertEquals("persistent", request.getMcpOAuthTokenStorage()); - } - - @Test - void testBuildResumeRequestNullConfigHasNullMcpOAuthTokenStorage() { - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-14", null); - assertNull(request.getMcpOAuthTokenStorage()); - } - - @Test - void testBuildResumeRequestSetsReasoningSummary() { - var config = new ResumeSessionConfig().setReasoningSummary("none"); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-15", config); - assertEquals("none", request.getReasoningSummary()); - } - - @Test - void testBuildResumeRequestSetsContextTier() { - var config = new ResumeSessionConfig().setContextTier("default"); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-15", config); - assertEquals("default", request.getContextTier()); - } - - @Test - void testBuildResumeRequestSetsPluginDirectoriesAndLargeOutput() { - var largeOutput = new LargeToolOutputConfig().setEnabled(false).setMaxSizeBytes(2048L) - .setOutputDirectory("/tmp/resume"); - var config = new ResumeSessionConfig().setPluginDirectories(List.of("/plugins/r")).setLargeOutput(largeOutput); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-16", config); - assertEquals(List.of("/plugins/r"), request.getPluginDirectories()); - assertEquals(largeOutput, request.getLargeOutput()); - } - - // ========================================================================= - // configureSession (ResumeSessionConfig overload) - // ========================================================================= - - @Test - void testConfigureResumeSessionNullConfig() throws Exception { - var session = createTestSession(); - // Should not throw - SessionRequestBuilder.configureSession(session, (ResumeSessionConfig) null); - } - - @Test - void testConfigureResumeSessionWithTools() throws Exception { - var session = createTestSession(); - var tool = ToolDefinition.create("resume_tool", "desc", Map.of(), - inv -> CompletableFuture.completedFuture("ok")); - var config = new ResumeSessionConfig().setTools(List.of(tool)); - - SessionRequestBuilder.configureSession(session, config); - - assertNotNull(session.getTool("resume_tool")); - } - - @Test - void testConfigureResumeSessionWithUserInputHandler() throws Exception { - var session = createTestSession(); - var config = new ResumeSessionConfig() - .setOnUserInputRequest((req, inv) -> CompletableFuture.completedFuture(new UserInputResponse())); - - SessionRequestBuilder.configureSession(session, config); - - // Handler was registered — verify by calling handleUserInputRequest - // (package-private) - var response = session.handleUserInputRequest(new com.github.copilot.rpc.UserInputRequest()).get(); - assertNotNull(response); - } - - @Test - void testConfigureResumeSessionWithHooks() throws Exception { - var session = createTestSession(); - var hooks = new SessionHooks().setOnPreToolUse((input, inv) -> CompletableFuture.completedFuture(null)); - var config = new ResumeSessionConfig().setHooks(hooks); - - SessionRequestBuilder.configureSession(session, config); - - // Hooks registered — handleHooksInvoke should dispatch preToolUse - var mapper = JsonRpcClient.getObjectMapper(); - var input = mapper.valueToTree(Map.of("toolName", "test_tool")); - var result = session.handleHooksInvoke("preToolUse", input).get(); - assertNull(result); // handler returns null - } - - // ========================================================================= - // Helper - // ========================================================================= - - private CopilotSession createTestSession() throws Exception { - var constructor = CopilotSession.class.getDeclaredConstructor(String.class, JsonRpcClient.class, String.class); - constructor.setAccessible(true); - return constructor.newInstance("builder-test-session", null, null); - } - - @Test - void testBuildCreateRequestWithAgent() { - var config = new SessionConfig().setAgent("my-agent"); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config, "test-session-id"); - assertEquals("my-agent", request.getAgent()); - } - - @Test - void testBuildResumeRequestWithAgent() { - var config = new ResumeSessionConfig().setAgent("my-agent"); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-id", config); - assertEquals("my-agent", request.getAgent()); - } - - // ========================================================================= - // extractTransformCallbacks - // ========================================================================= - - @Test - void extractTransformCallbacks_nullSystemMessage_returnsNull() { - ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(null); - assertNull(result.wireSystemMessage()); - assertNull(result.transformCallbacks()); - } - - @Test - void extractTransformCallbacks_appendMode_returnsOriginalConfig() { - var config = new com.github.copilot.rpc.SystemMessageConfig() - .setMode(com.github.copilot.SystemMessageMode.APPEND).setContent("extra content"); - ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); - assertSame(config, result.wireSystemMessage()); - assertNull(result.transformCallbacks()); - } - - @Test - void extractTransformCallbacks_customizeModeNoTransforms_returnsOriginalConfig() { - var sections = Map.of("tone", new com.github.copilot.rpc.SectionOverride() - .setAction(com.github.copilot.rpc.SectionOverrideAction.REMOVE)); - var config = new com.github.copilot.rpc.SystemMessageConfig() - .setMode(com.github.copilot.SystemMessageMode.CUSTOMIZE).setSections(sections); - ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); - assertSame(config, result.wireSystemMessage()); - assertNull(result.transformCallbacks()); - } - - @Test - void extractTransformCallbacks_customizeModeWithTransform_extractsCallbacks() { - var transformFn = (java.util.function.Function>) content -> CompletableFuture - .completedFuture(content + " modified"); - var sections = Map.of("identity", new com.github.copilot.rpc.SectionOverride().setTransform(transformFn)); - var config = new com.github.copilot.rpc.SystemMessageConfig() - .setMode(com.github.copilot.SystemMessageMode.CUSTOMIZE).setSections(sections); - - ExtractedTransforms result = SessionRequestBuilder.extractTransformCallbacks(config); - - // Wire config should be different from original - assertNotSame(config, result.wireSystemMessage()); - // Callbacks should be extracted - assertNotNull(result.transformCallbacks()); - assertTrue(result.transformCallbacks().containsKey("identity")); - // Wire config should have transform action instead of callback - assertNotNull(result.wireSystemMessage().getSections()); - var wireSection = result.wireSystemMessage().getSections().get("identity"); - assertNotNull(wireSection); - assertEquals(com.github.copilot.rpc.SectionOverrideAction.TRANSFORM, wireSection.getAction()); - assertNull(wireSection.getTransform()); - } - - @Test - @SuppressWarnings("deprecation") - void buildCreateRequestWithSessionId_usesProvidedSessionId() { - var config = new SessionConfig(); - config.setSessionId("my-session-id"); - - // The deprecated single-arg overload uses the sessionId from config when set - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertEquals("my-session-id", request.getSessionId()); - } - - @Test - void configureSessionWithNullConfig_returnsEarly() { - // configureSession with null config should return without error - CopilotSession session = new CopilotSession("session-1", null); - // Covers the null config early-return branch (L219-220) - assertDoesNotThrow(() -> SessionRequestBuilder.configureSession(session, (SessionConfig) null)); - } - - @Test - void configureSessionWithCommands_registersCommands() { - CopilotSession session = new CopilotSession("session-1", null); - - var cmd = new com.github.copilot.rpc.CommandDefinition().setName("deploy") - .setHandler(ctx -> CompletableFuture.completedFuture(null)); - var config = new SessionConfig().setCommands(List.of(cmd)); - - // Covers config.getCommands() != null branch (L235-236) - SessionRequestBuilder.configureSession(session, config); - // If no exception thrown, the branch was covered - } - - @Test - void configureSessionWithElicitationHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - ElicitationHandler handler = (context) -> CompletableFuture - .completedFuture(new ElicitationResult().setAction(ElicitationResultAction.CANCEL)); - var config = new SessionConfig().setOnElicitationRequest(handler); - - // Covers config.getOnElicitationRequest() != null branch (L238-239) - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureSessionWithOnEvent_registersEventHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new SessionConfig().setOnEvent(event -> { - }); - - // Covers config.getOnEvent() != null branch (L241-242) - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureResumedSessionWithCommands_registersCommands() { - CopilotSession session = new CopilotSession("session-1", null); - - var cmd = new com.github.copilot.rpc.CommandDefinition().setName("rollback") - .setHandler(ctx -> CompletableFuture.completedFuture(null)); - var config = new ResumeSessionConfig().setCommands(List.of(cmd)); - - // Covers ResumeSessionConfig.getCommands() != null branch (L271-272) - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureResumedSessionWithElicitationHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - ElicitationHandler handler = (context) -> CompletableFuture - .completedFuture(new ElicitationResult().setAction(ElicitationResultAction.CANCEL)); - var config = new ResumeSessionConfig().setOnElicitationRequest(handler); - - // Covers ResumeSessionConfig.getOnElicitationRequest() != null branch - // (L274-275) - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureResumedSessionWithOnEvent_registersEventHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new ResumeSessionConfig().setOnEvent(event -> { - }); - - // Covers ResumeSessionConfig.getOnEvent() != null branch (L277-278) - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void testBuildCreateRequestWithDefaultAgent() { - var defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); - var config = new SessionConfig().setDefaultAgent(defaultAgent); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertNotNull(request.getDefaultAgent()); - assertEquals(List.of("secret_tool"), request.getDefaultAgent().getExcludedTools()); - } - - @Test - void testBuildCreateRequestWithGitHubToken() { - var config = new SessionConfig().setGitHubToken("ghp_per_session_token"); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertEquals("ghp_per_session_token", request.getGitHubToken()); - } - - @Test - void testBuildResumeRequestWithDefaultAgent() { - var defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); - var config = new ResumeSessionConfig().setDefaultAgent(defaultAgent); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("test-session", config); - - assertNotNull(request.getDefaultAgent()); - assertEquals(List.of("secret_tool"), request.getDefaultAgent().getExcludedTools()); - } - - @Test - void testBuildResumeRequestWithGitHubToken() { - var config = new ResumeSessionConfig().setGitHubToken("ghp_per_session_token"); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("test-session", config); - - assertEquals("ghp_per_session_token", request.getGitHubToken()); - } - - // ========================================================================= - // instructionDirectories propagation - // ========================================================================= - - @Test - void testBuildCreateRequestPropagatesInstructionDirectories() { - var dirs = List.of("/path/to/instructions", "/another/path"); - var config = new SessionConfig().setInstructionDirectories(dirs); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertEquals(dirs, request.getInstructionDirectories()); - } - - @Test - void testBuildResumeRequestPropagatesInstructionDirectories() { - var dirs = List.of("/resume/instructions", "/other/dir"); - var config = new ResumeSessionConfig().setInstructionDirectories(dirs); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-inst", config); - - assertEquals(dirs, request.getInstructionDirectories()); - } - - // ========================================================================= - // enableSessionTelemetry serialization - // ========================================================================= - - @Test - void testCreateRequestSerializesEnableSessionTelemetryWhenFalse() throws Exception { - var config = new SessionConfig().setEnableSessionTelemetry(false); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - assertTrue(json.contains("\"enableSessionTelemetry\":false"), - "enableSessionTelemetry should be serialized when set to false"); - } - - @Test - void testCreateRequestOmitsEnableSessionTelemetryWhenNull() throws Exception { - var config = new SessionConfig(); - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - assertFalse(json.contains("enableSessionTelemetry"), "enableSessionTelemetry should be omitted when null"); - } - - @Test - void testResumeRequestSerializesEnableSessionTelemetryWhenFalse() throws Exception { - var config = new ResumeSessionConfig().setEnableSessionTelemetry(false); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-tel", config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - assertTrue(json.contains("\"enableSessionTelemetry\":false"), - "enableSessionTelemetry should be serialized when set to false"); - } - - @Test - void testResumeRequestOmitsEnableSessionTelemetryWhenNull() throws Exception { - var config = new ResumeSessionConfig(); - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-tel", config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - assertFalse(json.contains("enableSessionTelemetry"), "enableSessionTelemetry should be omitted when null"); - } - - // ========================================================================= - // Mode handler request flags - // ========================================================================= - - @Test - void testBuildCreateRequestWithExitPlanModeHandler() { - var config = new SessionConfig().setOnExitPlanMode( - (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertTrue(request.getRequestExitPlanMode()); - } - - @Test - void testBuildCreateRequestWithAutoModeSwitchHandler() { - var config = new SessionConfig().setOnAutoModeSwitch( - (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertTrue(request.getRequestAutoModeSwitch()); - } - - @Test - void testBuildCreateRequestWithoutModeHandlers() { - var config = new SessionConfig(); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertNull(request.getRequestExitPlanMode()); - assertNull(request.getRequestAutoModeSwitch()); - } - - @Test - void testBuildResumeRequestWithExitPlanModeHandler() { - var config = new ResumeSessionConfig().setOnExitPlanMode( - (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); - - assertTrue(request.getRequestExitPlanMode()); - } - - @Test - void testBuildResumeRequestWithAutoModeSwitchHandler() { - var config = new ResumeSessionConfig().setOnAutoModeSwitch( - (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); - - assertTrue(request.getRequestAutoModeSwitch()); - } - - @Test - void configureSessionWithExitPlanModeHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new SessionConfig().setOnExitPlanMode( - (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); - - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureSessionWithAutoModeSwitchHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new SessionConfig().setOnAutoModeSwitch( - (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureResumedSessionWithExitPlanModeHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new ResumeSessionConfig().setOnExitPlanMode( - (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult())); - - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void configureResumedSessionWithAutoModeSwitchHandler_registersHandler() { - CopilotSession session = new CopilotSession("session-1", null); - - var config = new ResumeSessionConfig().setOnAutoModeSwitch( - (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - SessionRequestBuilder.configureSession(session, config); - } - - @Test - void testCreateRequestSerializesModeFlags() throws Exception { - var config = new SessionConfig() - .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult())) - .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - - assertTrue(json.contains("\"requestExitPlanMode\":true")); - assertTrue(json.contains("\"requestAutoModeSwitch\":true")); - } - - @Test - void testResumeRequestSerializesModeFlags() throws Exception { - var config = new ResumeSessionConfig() - .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult())) - .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO)); - - ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - - assertTrue(json.contains("\"requestExitPlanMode\":true")); - assertTrue(json.contains("\"requestAutoModeSwitch\":true")); - } - - // ========================================================================= - // Cloud session options wiring - // ========================================================================= - - @Test - void testBuildCreateRequestPropagatesCloudSessionOptions() throws Exception { - var cloud = new CloudSessionOptions() - .setRepository(new CloudSessionRepository().setOwner("my-org").setName("my-repo").setBranch("main")); - var config = new SessionConfig().setCloud(cloud); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - - assertNotNull(request.getCloud()); - assertEquals("my-org", request.getCloud().getRepository().getOwner()); - assertEquals("my-repo", request.getCloud().getRepository().getName()); - assertEquals("main", request.getCloud().getRepository().getBranch()); - } - - @Test - void testBuildCreateRequestOmitsCloudWhenNull() throws Exception { - var config = new SessionConfig(); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - - assertNull(request.getCloud()); - assertFalse(json.contains("\"cloud\""), "cloud should be omitted when null"); - } - - @Test - void testCloudSessionOptionsSerializesCorrectly() throws Exception { - var cloud = new CloudSessionOptions() - .setRepository(new CloudSessionRepository().setOwner("acme").setName("widgets").setBranch("feature-1")); - var config = new SessionConfig().setCloud(cloud); - - CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); - var mapper = JsonRpcClient.getObjectMapper(); - var json = mapper.writeValueAsString(request); - - assertTrue(json.contains("\"cloud\"")); - assertTrue(json.contains("\"owner\":\"acme\"")); - assertTrue(json.contains("\"name\":\"widgets\"")); - assertTrue(json.contains("\"branch\":\"feature-1\"")); - } -} diff --git a/justfile b/justfile index d23e155c8..c84166862 100644 --- a/justfile +++ b/justfile @@ -109,7 +109,7 @@ install-go: install-nodejs install-test-harness # Install Python dependencies and prerequisites for tests install-python: install-nodejs install-test-harness @echo "=== Installing Python dependencies ===" - @cd python && uv pip install -e ".[dev]" + @cd python && uv pip install -e . --group dev # Install .NET dependencies and prerequisites for tests install-dotnet: install-nodejs install-test-harness diff --git a/nodejs/README.md b/nodejs/README.md index aadf7c677..eec674ce4 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -2,7 +2,11 @@ TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. -> **Note:** This SDK is in public preview and may change in breaking ways. +## Prerequisites + +To use the SDK, you'll need: + +- Node.js ^20.19.0 or >=22.12.0 ## Installation @@ -32,7 +36,7 @@ import { CopilotClient, approveAll } from "@github/copilot-sdk"; const client = new CopilotClient(); await client.start(); -// Create a session (onPermissionRequest is optional; approveAll allows every tool) +// approveAll is only valid when managed settings are disabled. const session = await client.createSession({ model: "gpt-5", onPermissionRequest: approveAll, @@ -57,7 +61,7 @@ await session.disconnect(); await client.stop(); ``` -Sessions also support `Symbol.asyncDispose` for use with [`await using`](https://github.com/tc39/proposal-explicit-resource-management) (TypeScript 5.2+/Node.js 18.0+): +Sessions also support `Symbol.asyncDispose` for use with [`await using`](https://github.com/tc39/proposal-explicit-resource-management) (TypeScript 5.2+ / Node.js 20+): ```typescript await using session = await client.createSession({ @@ -67,6 +71,12 @@ await using session = await client.createSession({ // session is automatically disconnected when leaving scope ``` +When targeting MCP tools configured through `mcpServers`, remember the runtime +tool name is `-`. For `availableTools` and +`excludedTools`, prefer `new ToolSet().addMcp("-")` or +the raw `mcp:-` form. For `customAgents[].tools` and +`defaultAgent.excludedTools`, use `-` directly. + ## API Reference ### CopilotClient @@ -80,16 +90,24 @@ new CopilotClient(options?: CopilotClientOptions) **Options:** - `connection?: RuntimeConnection` - How to connect to the Copilot runtime. Construct via the factory functions on `RuntimeConnection`: - - `RuntimeConnection.forStdio({ path?, args? })` (default) — spawn the runtime and communicate over its stdin/stdout. - - `RuntimeConnection.forTcp({ port?, connectionToken?, path?, args? })` — spawn the runtime as a TCP server. - - `RuntimeConnection.forUri(url, { connectionToken? })` — connect to an already-running runtime (mutually exclusive with `gitHubToken`/`useLoggedInUser`). -- `cwd?: string` - Working directory for the runtime process (default: current process cwd). + - `RuntimeConnection.forStdio({ path?, args?, env? })` (default) — spawn the runtime and communicate over its stdin/stdout. + - `RuntimeConnection.forTcp({ port?, connectionToken?, path?, args?, env? })` — spawn the runtime as a TCP server. + - `RuntimeConnection.forUri(url, { connectionToken? })` — connect to an already-running runtime (mutually exclusive with `gitHubToken`/`useLoggedInUser`). There is no top-level `cliUrl` shortcut; use this factory for URL-based connections. + - `RuntimeConnection.forInProcess()` — host the runtime in-process over its native C ABI (FFI). **Experimental.** Because the runtime shares this process, `env`, `telemetry`, and `workingDirectory` are rejected with this transport; set them on the host process instead. + - The child-process transports (`forStdio`/`forTcp`) also accept a per-connection `env`. Set it there or via the top-level `env` option — not both (setting both throws). +- `mode?: "empty" | "copilot-cli"` - Defaulting strategy. Use `"empty"` for multi-user server mode; defaults to `"copilot-cli"`. +- `workingDirectory?: string` - Working directory for the runtime process (default: current process cwd). - `baseDirectory?: string` - Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned runtime. When not set, the runtime defaults to `~/.copilot`. Ignored when connecting via `RuntimeConnection.forUri`. -- `logLevel?: string` - Log level. When omitted, the runtime uses its own default (currently `"info"`). +- `logLevel?: "none" | "error" | "warning" | "info" | "debug" | "all"` - Log level. When omitted, the runtime uses its own default (currently `"info"`). +- `env?: Record` - Environment variables for the runtime process. When omitted, inherits `process.env`. - `gitHubToken?: string` - GitHub token for authentication. When provided, takes priority over other auth methods. - `useLoggedInUser?: boolean` - Whether to use logged-in user for authentication (default: true, but false when `gitHubToken` is provided). Cannot be used with `RuntimeConnection.forUri`. +- `onListModels?: () => Promise | ModelInfo[]` - Optional model-list provider, useful when using a custom provider. - `telemetry?: TelemetryConfig` - OpenTelemetry configuration for the runtime process. Providing this object enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below. - `onGetTraceContext?: TraceContextProvider` - Advanced: callback for linking your application's own OpenTelemetry spans into the same distributed trace as the runtime's spans. Not needed for normal telemetry collection. See [Telemetry](#telemetry) below. +- `sessionFs?: SessionFsConfig` - Custom session filesystem provider. +- `sessionIdleTimeoutSeconds?: number` - Server-wide idle timeout for sessions in seconds. Ignored when connecting via `RuntimeConnection.forUri`. +- `enableRemoteSessions?: boolean` - Enable Mission Control remote session support. Ignored when connecting via `RuntimeConnection.forUri`. #### Methods @@ -113,12 +131,14 @@ Create a new conversation session. - `sessionId?: string` - Custom session ID. - `model?: string` - Model to use ("gpt-5", "claude-sonnet-4.5", etc.). **Required when using custom provider.** -- `reasoningEffort?: "low" | "medium" | "high" | "xhigh"` - Reasoning effort level for models that support it. Use `listModels()` to check which models support this option. +- `reasoningEffort?: "low" | "medium" | "high" | "xhigh" | "max"` - Reasoning effort level for models that support it. Use `listModels()` to check which models support this option. - `tools?: Tool[]` - Custom tools exposed to the CLI. Tools without `handler` are declaration-only and must be resolved via pending tool-call RPCs. - `systemMessage?: SystemMessageConfig` - System message customization (see below) - `infiniteSessions?: InfiniteSessionConfig` - Configure automatic context compaction (see below) +- `workingDirectory?: string` - Working directory for the session (default: runtime process cwd). +- `enableSessionStore?: boolean` - Enables the cross-session store for search and retrieval across sessions. When unset in `"copilot-cli"` mode, the runtime default applies (enabled). In `"empty"` mode, defaults to disabled. - `provider?: ProviderConfig` - Custom API provider configuration (BYOK - Bring Your Own Key). See [Custom Providers](#custom-providers) section. -- `onPermissionRequest?: PermissionHandler` - Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. Use `approveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section. +- `onPermissionRequest?: PermissionHandler` - Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. `approveAll` approves requests when managed settings are disabled and throws when `enableManagedSettings` is true. Custom handlers can inspect `managedApprovalRequired` for human-facing confirmation logic. See [Permission Handling](#permission-handling) section. - `onUserInputRequest?: UserInputHandler` - Handler for user input requests from the agent. Enables the `ask_user` tool. See [User Input Requests](#user-input-requests) section. - `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. - `hooks?: SessionHooks` - Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section. @@ -163,7 +183,7 @@ Get the ID of the session currently displayed in the TUI. Only available when co Request the TUI to switch to displaying the specified session. Only available in TUI+server mode. -##### `on(eventType: SessionLifecycleEventType, handler): () => void` +##### `onLifecycle(eventType: SessionLifecycleEventType, handler): () => void` Subscribe to a specific session lifecycle event type. Returns an unsubscribe function. @@ -173,7 +193,7 @@ const unsubscribe = client.onLifecycle("session.foreground", (event) => { }); ``` -##### `on(handler: SessionLifecycleHandler): () => void` +##### `onLifecycle(handler: SessionLifecycleHandler): () => void` Subscribe to all session lifecycle events. Returns an unsubscribe function. @@ -478,6 +498,21 @@ defineTool("safe_lookup", { }); ``` +#### Deferring Tools + +Set `defer` to control whether a tool may be loaded lazily via tool search rather than always pre-loaded. Use `"auto"` to allow the tool to be deferred and surfaced through tool search, or `"never"` to force it to always be pre-loaded. Defaults to `"auto"`. + +```ts +defineTool("lookup_issue", { + description: "Fetch issue details", + parameters: z.object({ id: z.string() }), + defer: "auto", + handler: async ({ id }) => { + /* your logic */ + }, +}); +``` + ### Commands Register 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. @@ -593,14 +628,17 @@ const session = await client.createSession({ }); ``` -Available section IDs: `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `runtime_instructions`, `last_instructions`. Use the `SYSTEM_MESSAGE_SECTIONS` constant for descriptions of each section. +Available section IDs: `preamble`, `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `runtime_instructions`, `last_instructions`. Use the `SYSTEM_MESSAGE_SECTIONS` constant for descriptions of each section. -Each section override supports four actions: +`identity` and `tool_instructions` are section _groups_ that target a collection of related sub-sections as a unit. Use `preamble` to target just the identity preamble without affecting its sibling sub-sections. + +Each section override supports five actions: - **`replace`** — Replace the section content entirely - **`remove`** — Remove the section from the prompt - **`append`** — Add content after the existing section - **`prepend`** — Add content before the existing section +- **`preserve`** — No-op that opts an individually-addressable section out of a group-level `remove` Unknown section IDs are handled gracefully: content from `replace`/`append`/`prepend` overrides is appended to additional instructions, and `remove` overrides are silently ignored. @@ -652,6 +690,29 @@ When enabled, sessions emit compaction events: - `session.compaction_start` - Background compaction started - `session.compaction_complete` - Compaction finished (includes token counts) +### Memory + +Sessions can opt in to the memory feature, which lets the agent persist and recall +information across turns. Provide a `memory` configuration on session create or resume; +when omitted, the runtime default applies. In the default `"copilot-cli"` client mode the +SDK leaves `memory` unset so the runtime applies its own default, while `"empty"` mode +defaults `memory` to disabled unless you set it explicitly. +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```typescript +// Enable memory for a session +const session = await client.createSession({ + model: "gpt-5", + memory: { enabled: true }, +}); + +// Disable memory for a session +const session = await client.createSession({ + model: "gpt-5", + memory: { enabled: false }, +}); +``` + ### Multiple Sessions ```typescript @@ -698,7 +759,7 @@ The SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own K - `apiKey?: string` - API key (optional for local providers like Ollama) - `bearerToken?: string` - Bearer token for authentication (takes precedence over apiKey) - `wireApi?: "completions" | "responses"` - API format for OpenAI/Azure (default: "completions") -- `azure?.apiVersion?: string` - Azure API version (default: "2024-10-21") +- `azure?.apiVersion?: string` - Azure API version; when omitted, the runtime uses the GA versionless `v1` route **Example with Ollama:** @@ -767,6 +828,7 @@ With just this configuration, the CLI emits spans for every session, message, an **TelemetryConfig options:** - `otlpEndpoint?: string` - OTLP HTTP endpoint URL +- `otlpProtocol?: "http/json" | "http/protobuf"` - OTLP HTTP protocol for all signals - `filePath?: string` - File path for JSON-lines trace output - `exporterType?: string` - `"otlp-http"` or `"file"` - `sourceName?: string` - Instrumentation scope name @@ -801,7 +863,7 @@ An `onPermissionRequest` handler is optional when you create or resume a session ### Approve All (simplest) -Use the built-in `approveAll` helper to allow every tool call without any checks: +Use the built-in `approveAll` helper when managed settings are disabled: ```typescript import { CopilotClient, approveAll } from "@github/copilot-sdk"; @@ -812,9 +874,11 @@ const session = await client.createSession({ }); ``` +When `enableManagedSettings` is true for the session, `approveAll` throws. Use a custom handler for managed sessions; request-level `managedApprovalRequired` remains available for human-facing confirmation logic. + ### Custom Permission Handler -Provide your own function to inspect each request and apply custom logic: +Provide your own function to inspect each request and apply custom logic. Check `managedApprovalRequired` before any automatic approval: ```typescript import type { PermissionRequest, PermissionRequestResult } from "@github/copilot-sdk"; @@ -822,6 +886,11 @@ import type { PermissionRequest, PermissionRequestResult } from "@github/copilot const session = await client.createSession({ model: "gpt-5", onPermissionRequest: (request: PermissionRequest, invocation): PermissionRequestResult => { + if ("managedApprovalRequired" in request && request.managedApprovalRequired === true) { + // Leave the request pending for the host's human-facing confirmation flow. + return { kind: "no-result" }; + } + // request.kind — what type of operation is being requested: // "shell" — executing a shell command // "write" — writing or editing a file @@ -859,7 +928,7 @@ The handler must return one of the `PermissionDecision` shapes (or `{ kind: "no- | `"approve-permanently"` | Allow this request and persist the approval across sessions (currently used for URL domains) | `domain` (URL domain to approve) | | `"reject"` | Deny the request | `feedback?` (optional string surfaced to the agent) | | `"user-not-available"` | Deny the request because no user is available to confirm it | — | -| `"no-result"` | Leave the request unanswered (only valid with protocol v1; rejected by protocol v2 servers) | — | +| `"no-result"` | Suppress this SDK client's response so another connected client can answer the pending request | — | ### Resuming Sessions @@ -1004,6 +1073,16 @@ const session = await client.createSession({ errorHandling: "retry", // "retry", "skip", or "abort" }; }, + + // Called when the top-level agent naturally stops + onAgentStop: async (input, invocation) => { + if (!input.stopHookActive && needsMoreWork()) { + return { + decision: "block", + reason: "Run the final validation and fix any failures.", + }; + } + }, }, }); ``` @@ -1017,6 +1096,7 @@ const session = await client.createSession({ - `onSessionStart` - Run logic when a session starts or resumes. - `onSessionEnd` - Cleanup or logging when session ends. - `onErrorOccurred` - Handle errors with retry/skip/abort strategies. +- `onAgentStop` - Observe natural top-level agent completion. Return `{ decision: "block", reason }` to request another turn; use `stopHookActive` to avoid repeated blocks. ## Error Handling @@ -1029,10 +1109,20 @@ try { } ``` -## Requirements +## Development + +From the repository root: + +```bash +cd test/harness +npm ci +``` -- Node.js >= 18.0.0 -- GitHub Copilot CLI installed and in PATH (or provide a custom `connection`) +```bash +cd nodejs +npm ci +npm test +``` ## License diff --git a/nodejs/docs/agent-author.md b/nodejs/docs/agent-author.md index 907181442..6b9366a7e 100644 --- a/nodejs/docs/agent-author.md +++ b/nodejs/docs/agent-author.md @@ -258,7 +258,7 @@ Subscribe to session events. Returns an unsubscribe function. ```js const unsub = session.on("tool.execution_complete", (event) => { - // event.data.toolName, event.data.success, event.data.result + // event.data.success, event.data.result }); ``` @@ -268,9 +268,9 @@ const unsub = session.on("tool.execution_complete", (event) => { | ------------------------- | ------------------------------------------------------ | | `assistant.message` | `content`, `messageId` | | `tool.execution_start` | `toolCallId`, `toolName`, `arguments` | -| `tool.execution_complete` | `toolCallId`, `toolName`, `success`, `result`, `error` | +| `tool.execution_complete` | `toolCallId`, `success`, `result`, `error` | | `user.message` | `content`, `attachments`, `source` | -| `session.idle` | `backgroundTasks` | +| `session.idle` | `aborted` | | `session.error` | `errorType`, `message`, `stack` | | `permission.requested` | `requestId`, `permissionRequest.kind` | | `session.shutdown` | `shutdownType`, `totalPremiumRequests` | diff --git a/nodejs/docs/examples.md b/nodejs/docs/examples.md index a2b106a48..63389c491 100644 --- a/nodejs/docs/examples.md +++ b/nodejs/docs/examples.md @@ -158,7 +158,7 @@ Hooks intercept and modify behavior at key lifecycle points. Register them in th | `onPreToolUse` | Before a tool executes | Tool args, permission decision, add context | | `onPostToolUse` | After a tool executes successfully | Tool result, add context | | `onPostToolUseFailure` | After a tool execution returns a failure | Add hidden guidance to the model | -| `onSessionStart` | Session starts or resumes | Add context, modify config | +| `onSessionStart` | Session starts or resumes | Add context | | `onSessionEnd` | Session ends | Cleanup actions, summary | | `onErrorOccurred` | An error occurs | Error handling strategy (retry/skip/abort) | @@ -368,7 +368,7 @@ session.on((event) => { ```js const unsubscribe = session.on("tool.execution_complete", (event) => { - // event.data.toolName, event.data.success, event.data.result, event.data.error + // event.data.success, event.data.result, event.data.error }); // Later, stop listening @@ -415,11 +415,11 @@ session.on("assistant.message", (event) => { | Event Type | Description | Key Data Fields | | --------------------------- | ------------------------------------------------ | ------------------------------------------------------ | | `assistant.message` | Agent's final response | `content`, `messageId`, `toolRequests` | -| `assistant.streaming_delta` | Token-by-token streaming (ephemeral) | `totalResponseSizeBytes` | +| `assistant.message_delta` | Message content chunks (ephemeral) | `deltaContent` | | `tool.execution_start` | A tool is about to run | `toolCallId`, `toolName`, `arguments` | -| `tool.execution_complete` | A tool finished running | `toolCallId`, `toolName`, `success`, `result`, `error` | +| `tool.execution_complete` | A tool finished running | `toolCallId`, `success`, `result`, `error` | | `user.message` | User sent a message | `content`, `attachments`, `source` | -| `session.idle` | Session finished processing a turn | `backgroundTasks` | +| `session.idle` | Session finished processing a turn | `aborted` | | `session.error` | An error occurred | `errorType`, `message`, `stack` | | `permission.requested` | Agent needs permission (shell, file write, etc.) | `requestId`, `permissionRequest.kind` | | `session.shutdown` | Session is ending | `shutdownType`, `totalPremiumRequests`, `codeChanges` | @@ -629,8 +629,11 @@ const session = await joinSession({ onPreToolUse: async (input) => { if (input.toolName === "bash") { const cmd = String(input.toolArgs?.command || ""); - if (/rm\\s+-rf\\s+\\/ / i.test(cmd) || /Remove-Item\\s+.*-Recurse/i.test(cmd)) { - return { permissionDecision: "deny" }; + if (/rm\\s+-rf\\s+\//i.test(cmd) || /Remove-Item\\s+.*-Recurse/i.test(cmd)) { + return { + permissionDecision: "deny", + permissionDecisionReason: "Destructive commands are not allowed.", + }; } } }, @@ -674,6 +677,6 @@ session.on("assistant.message", (event) => { }); session.on("tool.execution_complete", (event) => { - // event.data.success, event.data.toolName, event.data.result + // event.data.success, event.data.result }); ``` diff --git a/nodejs/docs/extensions.md b/nodejs/docs/extensions.md index 8b36de8a5..d33a73312 100644 --- a/nodejs/docs/extensions.md +++ b/nodejs/docs/extensions.md @@ -56,4 +56,5 @@ The `session` object provides methods for sending messages, logging to the timel ## Further Reading - `examples.md` — Practical code examples for tools, hooks, events, and complete extensions +- `factories.md`: Authoring, running, resuming, and observing Agent Factories - `agent-author.md` — Step-by-step workflow for agents authoring extensions programmatically diff --git a/nodejs/docs/factories.md b/nodejs/docs/factories.md new file mode 100644 index 000000000..e6d9ce2bc --- /dev/null +++ b/nodejs/docs/factories.md @@ -0,0 +1,257 @@ +# Agent Factories + +Agent Factories are extension-authored, session-scoped workflows that coordinate subagents and durable steps. The API is experimental. + +## Define and register a factory + +Use `defineFactory` and pass the returned handle to `joinSession`: + +```js +import { defineFactory, joinSession } from "@github/copilot-sdk/extension"; + +const reviewChanged = defineFactory({ + meta: { + name: "review-changed", + description: + "Review changed files and verify the findings. " + + "args: { files: string[] } — the paths to review.", + phases: [{ title: "Review" }, { title: "Verify" }], + argsSchema: { + type: "object", + required: ["files"], + properties: { + files: { type: "array", items: { type: "string" } }, + }, + }, + limits: { + maxConcurrentSubagents: 3, + maxTotalSubagents: 10, + timeoutSeconds: 90.5, + maxAiCredits: 5, + }, + }, + run: async (ctx) => { + ctx.phase("Review"); + const reviews = await ctx.parallel( + ctx.args.files.map( + (file) => () => ctx.agent(`Review ${file}`, { label: `Review ${file}` }) + ) + ); + + ctx.phase("Verify"); + const report = await ctx.step("report", () => ({ reviews })); + ctx.log(`Completed factory run ${ctx.runId}`); + return report; + }, +}); + +const session = await joinSession({ factories: [reviewChanged] }); +``` + +Factory metadata contains a stable `name`, a human-readable `description`, declared `phases`, an optional `argsSchema`, and optional `limits`. Phase entries contain a `title` and optional `detail`. + +## Declaring an argument shape + +A factory that reads `ctx.args` should declare `meta.argsSchema`, as the example above does. When the model invokes the factory through the `run_factory` tool, the CLI validates `args` against the declaration **before** the run starts. + +Declaring one turns an expensive failure into a cheap one. With a schema, a malformed call is rejected up front — the model gets a correction hint and retries, and no run row, permission prompt, or credit spend happens. Without one, nothing validates: the run starts, takes a user approval, spends credits, and then dies inside the factory body with a confusing error. Agents can read the declared shape with `factories_manage` using `operation: "inspect"`. + +Enforcement covers structure — types, required properties, and enum or const values. Finer constraints such as `minLength`, `pattern`, or `additionalProperties` are recorded in the declaration but not enforced. The accepted vocabulary is the `FactoryJsonSchema` subset also used for subagent structured output: `type`, `required`, `enum`, `const`, recursive `properties`/`items`, and `anyOf`/`oneOf`/`allOf`. A `type` is one of `null`, `boolean`, `integer`, `number`, `string`, `array`, or `object`, or a non-empty array of those such as `["object", "null"]`. A declaration outside that subset is rejected at registration. + +`argsSchema` is optional and backward compatible. A factory that omits it behaves exactly as before, so **the `description` is then the only thing telling an agent what arguments to supply** — state the expected shape there. + +Validation covers the model's `run_factory` path only. An extension calling `session.factory.run(...)` directly is not validated against `argsSchema`; those arguments are typed through `defineFactory` instead, and that typing does not reach the model. So a factory that reads `ctx.args` should still validate it rather than assume a shape — the declared subset does not enforce every constraint, and it does not run at all on the SDK path. + +`defineFactory` accepts a `run(context)` function returning `Promise`, where `TResult` is `JsonValue | void`. Objects, arrays, strings, numbers, booleans, and `null` are valid results. Returning `undefined` completes the factory with no result. Other non-JSON values are rejected. + +## Factory context + +The `run()` context provides: + +- `ctx.runId`: Stable ID reused across resumed attempts. +- `ctx.args`: Invocation arguments, forwarded verbatim. When the caller omits `args`, this is `{}` rather than `undefined`. +- `ctx.agent(prompt, options?)`: Runs one factory-owned subagent. Options are exactly `label`, `schema`, `model`, `agent`, `reasoningEffort`, and `contextTier`. See [Subagent calls](#subagent-calls). +- `ctx.parallel(thunks)`: Runs thunks concurrently and awaits all of them (a barrier). A thunk that throws becomes `null` in the result array, so one failed item does not lose the rest. Cancellation and hard runtime failures (`ResponseError`, `ConnectionError`) are the exception — those propagate and reject the whole call, because they mean the run itself is in trouble rather than one item having failed. Handle them at run level; do not assume every failure arrives as a `null`. Rejects above 4096 items. +- `ctx.pipeline(items, ...stages)`: Flows each item through every stage without a barrier between stages, so one item can be in a later stage while another is still in an earlier one. Each stage is called as `(previous, item, index)`, where `previous` is the prior stage's result and `item` is the original input. A stage that throws drops that item to `null` and skips its remaining stages, with the same exception for cancellation and hard runtime failures. Rejects above 4096 items. +- `ctx.phase(title)`: Starts a named progress phase. This sets a single run-global value, so calling it from inside concurrent `parallel`/`pipeline` stages races. Call it at run-level transitions and distinguish concurrent work by `label` instead. +- `ctx.log(message)`: Appends a progress line. When a factory bounds its own coverage (top-N, sampling), log what was dropped. +- `ctx.step(key, producer, options?)`: Journals the producer's JSON result under a stable key so a resume replays it without re-running the producer. A journaled (default) producer must return a JSON-serializable value; `undefined` or a non-JSON value is rejected. Pass `{ volatile: true }` to bypass the journal and run the producer every time. + + The key is the *sole* identity: neither the producer body nor its inputs contribute to it. A resume replays the cached value for a matching key even if the producer has since changed, so version the key (`"scan-v2"`) whenever its inputs or meaning change. Journaled producers are best-effort at-least-once and may run again across crashes or concurrent same-key callers, so keep side effects idempotent. +- `ctx.session`: The session returned by `joinSession`. It refuses calls that start or resume a factory run. Call `extensions_manage` with `operation: "guide"` to read more about the session APIs. +- `ctx.signal`: Cooperative cancellation signal for extension work and subprocesses. +- `ctx.factory(...)`: Always rejects because nested factories are not supported. + +Factory-owned subagents are intentionally hidden from `read_agent` and `write_agent`. Use the factory observability APIs instead. + +### Subagent calls + +`ctx.agent(prompt, options?)` spawns one factory-scoped subagent and awaits it. Without a schema it resolves to the subagent's final text. With `options.schema` it resolves to the parsed JSON value. + +**Identical calls are memoized into one subagent.** Each call is journaled by its canonical prompt and options, including `label`. Two calls with the same prompt and the same options return one shared result — even when issued concurrently. To spawn N *independent* subagents, give each a unique `label` or vary the prompt: + +```js +// One subagent, awaited five times — almost certainly not what you want. +await ctx.parallel([1, 2, 3, 4, 5].map(() => () => ctx.agent("Find a bug"))); + +// Five independent subagents. +await ctx.parallel( + [1, 2, 3, 4, 5].map((i) => () => ctx.agent("Find a bug", { label: `finder:${i}` })) +); +``` + +**An ordinary failure resolves to `null` — it does not throw.** A subagent that errors, returns nothing, or (with a schema) produces output that still fails to parse or match after its one retry resolves `null`. Always guard the result before using it, including a bare `await ctx.agent(...)`: + +```js +const finding = await ctx.agent(prompt, { label: "inspector" }); +if (!finding) return { finding: null }; +``` + +Cancellation and hard runtime failures — a reached limit, a durable-state failure — reject instead, aborting the run. When filtering results, prefer `v => v !== null` over `Boolean`, which also discards a valid `false`, `0`, or `""`. + +**`schema` is a structural subset of JSON Schema, not a validator.** Honored: `type`, `required`, `enum`, `const`, recursive `properties`/`items`, and `anyOf`/`oneOf`/`allOf` — where `oneOf` is treated as `anyOf`, meaning at least one branch matches rather than exactly one. Ignored and *not* enforced: `additionalProperties`, `pattern`, `minLength`/`maxLength`, `format`, numeric ranges, and boolean schemas. Do not rely on an ignored keyword to constrain a result. A schema call retries once on a parse or match failure, so it may spawn twice, and both spawns count toward `maxTotalSubagents`. + +### Choosing between pipeline and parallel + +Prefer `pipeline` for multi-stage work. It has no barrier between stages, so each item advances as soon as its own prior stage finishes. + +Reach for a barrier — `parallel` between stages — only when a stage genuinely needs every prior result at once: deduplicating or merging across the full set, an early exit based on the total, or a prompt that compares one result against the others. Needing to map, filter, or flatten is not a reason to use a barrier; do that inside a pipeline stage. Barrier latency is real: if the slowest of N subagents takes three times the fastest, a barrier wastes the rest of the pool's time. + +See [factory-patterns.md](./factory-patterns.md) for composable orchestration patterns built on these primitives. + +## Resource limits + +Limits may be declared in `meta.limits` and overridden per invocation. All limits must be positive when present. + +- `maxConcurrentSubagents`: Positive integer concurrent-subagent cap. Additional subagents wait in a queue. Queueing applies backpressure and does not fail the run. +- `maxTotalSubagents`: Positive integer cumulative admission cap. An attempted subagent beyond the cap ends the attempt with failure kind `maxTotalSubagents`. +- `timeoutSeconds`: Positive finite number of seconds, including positive fractions, capped at `2_147_483.647`. It measures accumulated active-execution time across attempts, including the extension body, subprocess waits, queued-agent waits, and sleeps. Time between attempts is excluded. The timeout is soft because already-running work may take time to stop. Its failure kind is `timeoutSeconds`. +- `maxAiCredits`: Positive finite AI-credit budget for the whole run's factory subagent subtree, including descendants. AI credits are GitHub Copilot's universal usage metric. This is a soft, post-paid ceiling, so completed or parallel turns can settle above it before the run stops. Accounting is fail-closed: an accounting failure stops a budgeted run rather than allowing untracked use. Its failure kind is `maxAiCredits`. + +`maxTotalSubagents`, `timeoutSeconds`, and `maxAiCredits` use reject-and-retry semantics. A rejected attempt ends with run status `error` and `failure.type` set to `factory_limit_reached`. The failed run keeps its ID, arguments, journal, and accounting. Resume the run with a raised limit when additional work is approved. Previously consumed resources still count. + +## Run and resume + +Run by registered name or handle: + +```ts +const run = await session.factory.run("review-changed", { + args: { files: ["src/a.ts"] }, + limits: { maxAiCredits: 3 }, +}); + +if (run.status === "completed") { + console.log(run.result); +} else { + console.error(`run ${run.runId} ended as ${run.status}`, run.failure ?? run.error); +} +``` + +The name overload is: + +```ts +session.factory.run( + name: string, + options?: { args?: JsonValue; limits?: FactoryLimits }, +): Promise; +``` + +Resume by run ID without resending the name or arguments: + +```ts +const run = await session.factory.resume(runId, { + limits: { maxAiCredits: 6 }, +}); +``` + +The signature is: + +```ts +session.factory.resume( + runId: string, + options?: { limits?: FactoryLimits }, +): Promise; +``` + +Both resolve with the run envelope (`FactoryRunResult`) for **every** outcome — `completed`, `error`, `halted`, and `cancelled` alike. Inspect `status` and read `result` only when the run completed; a limit breach carries a typed `failure`. SDK-initiated `run` and `resume` do not request permission, so they have no declined outcome. The model's `run_factory` tool requests permission before the durable row exists; declining it creates no run row. An SDK-initiated run is refused only when the session already has its maximum number of active top-level runs. Pre-execution resume failures throw `FactoryResumeError`, whose `code` is one of `not_found`, `non_resumable`, `already_active`, `factory_already_running`, `factory_limits_invalid`, `factory_session_disposed`, `factory_storage_unavailable`, or `factory_storage_corrupt`. + +An agent that no longer has a prior run's ID in context can recover it with `factories_manage` and `operation: "runs"`, which lists the session's factory runs with their IDs and statuses. This matters for resume: a run that reached a limit keeps its journal, so resuming it replays completed work for free, while restarting it from scratch pays for that work twice. + +The agent-facing `run_factory` tool has exactly two input branches: + +```ts +{ name: string; args?: JsonValue; limits?: FactoryLimits } +{ resumeFromRunId: string; limits?: FactoryLimits } +``` + +## Authoring a factory from inside a session + +The agent-facing `factories_manage` tool writes a factory into a session-scoped extension at runtime with `operation: "author"`. The rules above all apply, plus one constraint that does not affect an extension author. + +**The `run` body is self-contained.** It is emitted verbatim into a generated module as a single async function expression. It closes over nothing: not the conversation that authored it, and not any authoring-time binding. Only its own locals, its `ctx` parameter, and standard Node and JavaScript globals are in scope, so every schema, constant, and helper must be defined *inside* the function. The generated module imports the SDK itself; the expression cannot add static `import` statements or use `require`. Load anything else with a dynamic `await import("...")` in the body. + +```js +async ({ args, agent, phase }) => { + // Defined inside — there is no outer scope to close over. + const VERDICT = { type: "object", properties: { real: { type: "boolean" } }, required: ["real"] }; + + phase("Inspect"); + const finding = await agent(`Name one likely bug in ${args.file ?? "the code"}.`, { + label: "inspector", + }); + if (!finding) return { finding: null, real: false }; + + phase("Verify"); + const verdict = await agent(`Is this a real bug? Claim: ${finding}`, { + label: "verifier", + schema: VERDICT, + }); + return { finding, real: verdict?.real === true }; +}; +``` + +Authoring registers the factory but does not run it. Invoke it afterwards with `run_factory`. Use `factories_manage` with `operation: "list"` to see the factories already registered in the session and `operation: "inspect"` to read one factory's description, phases, declared argument shape, and limits before running it. + +## Observe a run + +The calling session can inspect its own factory runs: + +```ts +const runs = await session.factory.listRuns(); +const detail = await session.factory.getRunDetail(runId); +const page = await session.factory.getRunProgress(runId, { + phaseId, + afterSeq, + beforeSeq, + limit, +}); +``` + +- `listRuns()` returns the newest default page of this session's durable factory runs. +- `getRunDetail(runId)` returns phases, prompt-safe agent summaries, and the latest progress page. +- `getRunProgress(runId, options?)` pages progress forward, backward, by phase, or from the latest tail. + +`getRun(runId)` reads the latest run envelope, and `cancel(runId)` cancels a run and returns its terminal envelope. + +`waitForRun(runId, options?)` resolves with the terminal envelope once the run settles into `completed`, `error`, `halted`, or `cancelled`, and resolves immediately when it has already settled: + +```ts +const settled = await session.factory.waitForRun(runId); +if (settled.status === "completed") { + console.log(settled.result); +} +``` + +It watches `factory.run_updated` and re-reads the durable envelope on each invalidation, collapsing a burst of events into a single in-flight read. A low-frequency periodic re-read runs alongside the subscription, so a dropped or missing invalidation degrades into a slightly late resolution rather than an unbounded wait. Pass a `signal` to stop waiting: + +```ts +const controller = new AbortController(); +setTimeout(() => controller.abort(), 30_000); +const settled = await session.factory.waitForRun(runId, { signal: controller.signal }); +``` + +Aborting rejects the wait and has no effect on the run, which keeps executing — use `cancel(runId)` to actually stop it. Because a terminal envelope is final, the resolved value never changes afterwards. `isFactoryRunTerminal(status)` exposes the same terminal-status test for callers driving their own loop. + +Listen for the ephemeral `factory.run_updated` event. Its `{ runId, revision }` payload is an invalidation signal. Re-read the desired API when a newer monotonic revision arrives. + +Revisions cover durable lifecycle, accounting, phase, agent, and progress changes. Continuous read-time fields can change without a new revision. These include `observedAt`, active-time calculations, live counts, and a live agent's status or prompt-safe activity text. Factory prompts are never exposed by these APIs. A run is visible only through the session that owns it. diff --git a/nodejs/docs/factory-patterns.md b/nodejs/docs/factory-patterns.md new file mode 100644 index 000000000..66c6d13b1 --- /dev/null +++ b/nodejs/docs/factory-patterns.md @@ -0,0 +1,194 @@ +# Agent Factory patterns + +Composable orchestration patterns built on the factory context. Read [factories.md](./factories.md) first for the API and its semantics. The API is experimental. + +Every snippet below assumes the surrounding `async (ctx) => { ... }` run body and destructures the hooks it uses. Three rules apply throughout, because breaking them fails silently: + +- **Give every independent subagent a unique `label`.** Identical prompt-and-options pairs memoize into a single shared subagent. +- **Guard every `agent()` result.** An ordinary failure resolves to `null` rather than throwing. +- **Filter with `v => v !== null`,** not `Boolean`, which also discards a valid `false`, `0`, or `""`. + +## Multi-stage review + +The default shape: fan out across dimensions, and let each dimension verify as soon as its own review lands. No barrier, so a slow dimension never holds up a fast one. + +```js +async ({ pipeline, parallel, agent, phase, log }) => { + const FINDINGS = { + type: "object", + properties: { + findings: { + type: "array", + items: { + type: "object", + properties: { title: { type: "string" } }, + required: ["title"], + }, + }, + }, + required: ["findings"], + }; + const VERDICT = { + type: "object", + properties: { isReal: { type: "boolean" } }, + required: ["isReal"], + }; + const DIMENSIONS = [ + { key: "bugs", prompt: "Review the diff for correctness bugs. Return JSON {findings:[{title}]}." }, + { key: "perf", prompt: "Review the diff for performance issues. Return JSON {findings:[{title}]}." }, + ]; + + phase("Review"); // Run-global: set it before the fan-out, never inside a stage. + const perDimension = await pipeline( + DIMENSIONS, + (d) => agent(d.prompt, { label: `review:${d.key}`, schema: FINDINGS }), + (review, d) => { + if (!review) { + log(`review:${d.key} produced nothing`); + return []; + } + return parallel( + (review.findings ?? []).map((f, i) => () => + agent(`Adversarially verify this finding is real: ${f.title}`, { + label: `verify:${d.key}:${i}`, + schema: VERDICT, + }).then((v) => (v && v.isReal ? f : null)) + ) + ); + } + ); + + return { confirmed: perDimension.flat().filter((v) => v !== null) }; +}; +``` + +## When a barrier is correct + +Deduplicating across every finding needs the whole set in hand, so the barrier earns its cost here. Dedup itself is plain JavaScript, done in the body between the two fan-outs. This excerpt reuses `FINDINGS`, `VERDICT`, and `DIMENSIONS` from the previous example — define them inside your own function. + +```js +const all = await parallel( + DIMENSIONS.map((d) => () => agent(d.prompt, { label: `find:${d.key}`, schema: FINDINGS })) +); +const findings = all.filter((v) => v !== null).flatMap((r) => r.findings ?? []); +const deduped = [...new Map(findings.map((f) => [f.title, f])).values()]; // Needs all of them. +const verified = await parallel( + deduped.map((f, i) => () => agent(`Verify: ${f.title}`, { label: `verify:${i}`, schema: VERDICT })) +); +``` + +## Loop until count + +Accumulate toward a target. Each iteration needs a unique identity — a unique label plus a prompt that excludes what has already been found — a bounded attempt count, and a null guard. + +```js +const BUG = { + type: "object", + properties: { title: { type: "string" } }, + required: ["title"], +}; + +const bugs = []; +let attempt = 0; +while (bugs.length < 10 && attempt < 30) { + const r = await agent( + `Find ONE distinct bug NOT already listed: ${JSON.stringify(bugs.map((b) => b.title))}. Return JSON {title}.`, + { label: `finder:${attempt}`, schema: BUG } + ); + attempt++; + if (r && r.title) bugs.push(r); + log(`${bugs.length}/10 found`); +} +``` + +## Loop until dry + +Keep spawning finders until some number of consecutive rounds surface nothing new. Deduplicate against everything *seen*, not just what was kept, or discarded findings resurface every round. + +```js +const BUGS = { + type: "object", + properties: { + bugs: { + type: "array", + items: { type: "object", properties: { title: { type: "string" } }, required: ["title"] }, + }, + }, + required: ["bugs"], +}; +const VERDICT = { + type: "object", + properties: { real: { type: "boolean" } }, + required: ["real"], +}; + +const seen = new Set(); +const confirmed = []; +const keyOf = (b) => b.title.toLowerCase(); +let dry = 0; +let round = 0; + +while (dry < 2 && round < 20) { + const found = ( + await parallel( + [0, 1, 2].map((i) => () => + agent(`Find bugs (finder ${i}, round ${round}). Return JSON {bugs:[{title}]}.`, { + label: `find:${round}:${i}`, + schema: BUGS, + }) + ) + ) + ) + .filter((v) => v !== null) + .flatMap((r) => r.bugs ?? []); + + const fresh = found.filter((b) => { + const k = keyOf(b); + if (seen.has(k)) return false; + seen.add(k); + return true; + }); + + if (!fresh.length) { + dry++; + round++; + continue; + } + dry = 0; + + const judged = await parallel( + fresh.map((b, i) => () => + parallel( + ["correctness", "security", "repro"].map((lens) => () => + agent(`Judge via ${lens}: is "${b.title}" real? Return JSON {real}.`, { + label: `judge:${round}:${i}:${lens}`, + schema: VERDICT, + }) + ) + ).then((vs) => ({ b, real: vs.filter((v) => v !== null).filter((v) => v.real).length >= 2 })) + ) + ); + + confirmed.push(...judged.filter((v) => v !== null && v.real).map((v) => v.b)); + round++; +} +``` + +## Quality patterns + +Compose these freely. + +- **Adversarial verify.** Spawn several independent skeptics per finding, each prompted to *refute* it and to default to refuted when uncertain. Keep only what a majority fails to refute. +- **Perspective-diverse verify.** Give each verifier a distinct lens — correctness, security, performance, does-it-reproduce — instead of several identical skeptics. The distinct prompts also stop them memoizing into one subagent. +- **Judge panel.** Generate several independent attempts from different angles, score them with parallel judges, then synthesize from the winner while grafting the best ideas from the runners-up. +- **Multi-modal sweep.** Run parallel searchers that each look a different way: by container, by content, by entity, by time. +- **Completeness critic.** End with an agent asking what is missing — an angle not run, a claim unverified, a source unread — and use its answer to seed the next round. +- **No silent caps.** When the factory bounds its own coverage with a top-N, a sampling step, or a no-retry rule, `log()` what was dropped. + +## Scaling + +Match the orchestration to what was asked. A quick check wants a couple of subagents and single-vote verification; a request to be thorough or comprehensive wants a larger finder pool, a three-to-five vote adversarial pass, and a synthesis stage. + +There is no in-script budget object. Scale with your own counters, as in the loop patterns above, and treat the declared limits as the safety ceiling rather than the control mechanism. Only `agent()` spawns are throttled, by `maxConcurrentSubagents` falling back to `maxTotalSubagents`; with neither declared there is no built-in concurrency cap, so declare one before fanning out widely. `parallel` itself is `Promise.all`, so non-agent work in a thunk runs fully concurrently regardless. + +These patterns are not exhaustive. Compose novel harnesses — tournament brackets, self-repair loops, staged escalation — when the task calls for it. diff --git a/nodejs/package-lock.json b/nodejs/package-lock.json index ee96e3e3a..4b25e3dce 100644 --- a/nodejs/package-lock.json +++ b/nodejs/package-lock.json @@ -1,24 +1,26 @@ { "name": "@github/copilot-sdk", - "version": "0.1.8", + "version": "0.0.0-dev", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@github/copilot-sdk", - "version": "0.1.8", + "version": "0.0.0-dev", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.56-2", + "@github/copilot": "^1.0.80", + "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" }, "devDependencies": { "@platformatic/vfs": "^0.3.0", "@types/node": "^25.2.0", + "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.54.0", "@typescript-eslint/parser": "^8.54.0", - "esbuild": "^0.27.2", + "esbuild": "^0.28.1", "eslint": "^9.0.0", "glob": "^13.0.1", "json-schema": "^0.4.0", @@ -29,10 +31,11 @@ "semver": "^7.7.3", "tsx": "^4.20.6", "typescript": "^5.0.0", - "vitest": "^4.0.18" + "vitest": "^4.0.18", + "ws": "^8.21.0" }, "engines": { - "node": ">=20.0.0" + "node": "^20.19.0 || >=22.12.0" } }, "node_modules/@apidevtools/json-schema-ref-parser": { @@ -53,10 +56,44 @@ "url": "https://github.com/sponsors/philsturgeon" } }, + "node_modules/@emnapi/core": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.10.0.tgz", + "integrity": "sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/wasi-threads": "1.2.1", + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.10.0.tgz", + "integrity": "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.1.tgz", + "integrity": "sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.2.tgz", - "integrity": "sha512-GZMB+a0mOMZs4MpDbj8RJp4cw+w1WV5NYD6xzgvzUJ5Ek2jerwfO2eADyI6ExDSUED+1X8aMbegahsJi+8mgpw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -71,9 +108,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.2.tgz", - "integrity": "sha512-DVNI8jlPa7Ujbr1yjU2PfUSRtAUZPG9I1RwW4F4xFB1Imiu2on0ADiI/c3td+KmDtVKNbi+nffGDQMfcIMkwIA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -88,9 +125,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.2.tgz", - "integrity": "sha512-pvz8ZZ7ot/RBphf8fv60ljmaoydPU12VuXHImtAs0XhLLw+EXBi2BLe3OYSBslR4rryHvweW5gmkKFwTiFy6KA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -105,9 +142,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.2.tgz", - "integrity": "sha512-z8Ank4Byh4TJJOh4wpz8g2vDy75zFL0TlZlkUkEwYXuPSgX8yzep596n6mT7905kA9uHZsf/o2OJZubl2l3M7A==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -122,9 +159,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.2.tgz", - "integrity": "sha512-davCD2Zc80nzDVRwXTcQP/28fiJbcOwvdolL0sOiOsbwBa72kegmVU0Wrh1MYrbuCL98Omp5dVhQFWRKR2ZAlg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -139,9 +176,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.2.tgz", - "integrity": "sha512-ZxtijOmlQCBWGwbVmwOF/UCzuGIbUkqB1faQRf5akQmxRJ1ujusWsb3CVfk/9iZKr2L5SMU5wPBi1UWbvL+VQA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -156,9 +193,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.2.tgz", - "integrity": "sha512-lS/9CN+rgqQ9czogxlMcBMGd+l8Q3Nj1MFQwBZJyoEKI50XGxwuzznYdwcav6lpOGv5BqaZXqvBSiB/kJ5op+g==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -173,9 +210,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.2.tgz", - "integrity": "sha512-tAfqtNYb4YgPnJlEFu4c212HYjQWSO/w/h/lQaBK7RbwGIkBOuNKQI9tqWzx7Wtp7bTPaGC6MJvWI608P3wXYA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -190,9 +227,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.2.tgz", - "integrity": "sha512-vWfq4GaIMP9AIe4yj1ZUW18RDhx6EPQKjwe7n8BbIecFtCQG4CfHGaHuh7fdfq+y3LIA2vGS/o9ZBGVxIDi9hw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -207,9 +244,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.2.tgz", - "integrity": "sha512-hYxN8pr66NsCCiRFkHUAsxylNOcAQaxSSkHMMjcpx0si13t1LHFphxJZUiGwojB1a/Hd5OiPIqDdXONia6bhTw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -224,9 +261,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.2.tgz", - "integrity": "sha512-MJt5BRRSScPDwG2hLelYhAAKh9imjHK5+NE/tvnRLbIqUWa+0E9N4WNMjmp/kXXPHZGqPLxggwVhz7QP8CTR8w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -241,9 +278,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.2.tgz", - "integrity": "sha512-lugyF1atnAT463aO6KPshVCJK5NgRnU4yb3FUumyVz+cGvZbontBgzeGFO1nF+dPueHD367a2ZXe1NtUkAjOtg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -258,9 +295,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.2.tgz", - "integrity": "sha512-nlP2I6ArEBewvJ2gjrrkESEZkB5mIoaTswuqNFRv/WYd+ATtUpe9Y09RnJvgvdag7he0OWgEZWhviS1OTOKixw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -275,9 +312,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.2.tgz", - "integrity": "sha512-C92gnpey7tUQONqg1n6dKVbx3vphKtTHJaNG2Ok9lGwbZil6DrfyecMsp9CrmXGQJmZ7iiVXvvZH6Ml5hL6XdQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -292,9 +329,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.2.tgz", - "integrity": "sha512-B5BOmojNtUyN8AXlK0QJyvjEZkWwy/FKvakkTDCziX95AowLZKR6aCDhG7LeF7uMCXEJqwa8Bejz5LTPYm8AvA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -309,9 +346,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.2.tgz", - "integrity": "sha512-p4bm9+wsPwup5Z8f4EpfN63qNagQ47Ua2znaqGH6bqLlmJ4bx97Y9JdqxgGZ6Y8xVTixUnEkoKSHcpRlDnNr5w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -326,9 +363,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.2.tgz", - "integrity": "sha512-uwp2Tip5aPmH+NRUwTcfLb+W32WXjpFejTIOWZFw/v7/KnpCDKG66u4DLcurQpiYTiYwQ9B7KOeMJvLCu/OvbA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -343,9 +380,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.2.tgz", - "integrity": "sha512-Kj6DiBlwXrPsCRDeRvGAUb/LNrBASrfqAIok+xB0LxK8CHqxZ037viF13ugfsIpePH93mX7xfJp97cyDuTZ3cw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -360,9 +397,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.2.tgz", - "integrity": "sha512-HwGDZ0VLVBY3Y+Nw0JexZy9o/nUAWq9MlV7cahpaXKW6TOzfVno3y3/M8Ga8u8Yr7GldLOov27xiCnqRZf0tCA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -377,9 +414,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.2.tgz", - "integrity": "sha512-DNIHH2BPQ5551A7oSHD0CKbwIA/Ox7+78/AWkbS5QoRzaqlev2uFayfSxq68EkonB+IKjiuxBFoV8ESJy8bOHA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -394,9 +431,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.2.tgz", - "integrity": "sha512-/it7w9Nb7+0KFIzjalNJVR5bOzA9Vay+yIPLVHfIQYG/j+j9VTH84aNB8ExGKPU4AzfaEvN9/V4HV+F+vo8OEg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -411,9 +448,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.2.tgz", - "integrity": "sha512-LRBbCmiU51IXfeXk59csuX/aSaToeG7w48nMwA6049Y4J4+VbWALAuXcs+qcD04rHDuSCSRKdmY63sruDS5qag==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -428,9 +465,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.2.tgz", - "integrity": "sha512-kMtx1yqJHTmqaqHPAzKCAkDaKsffmXkPHThSfRwZGyuqyIeBvf08KSsYXl+abf5HDAPMJIPnbBfXvP2ZC2TfHg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -445,9 +482,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.2.tgz", - "integrity": "sha512-Yaf78O/B3Kkh+nKABUF++bvJv5Ijoy9AN1ww904rOXZFLWVc5OLOfL56W+C8F9xn5JQZa3UX6m+IktJnIb1Jjg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -462,9 +499,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.2.tgz", - "integrity": "sha512-Iuws0kxo4yusk7sw70Xa2E2imZU5HoixzxfGCdxwBdhiDgt9vX9VUCBhqcwY7/uh//78A1hMkkROMJq9l27oLQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -479,9 +516,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.2.tgz", - "integrity": "sha512-sRdU18mcKf7F+YgheI/zGf5alZatMUTKj/jNS6l744f9u3WFu4v7twcUI9vu4mknF4Y9aDlblIie0IM+5xxaqQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -663,9 +700,9 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.56-2.tgz", - "integrity": "sha512-Dpue7utF6PzGS4tPrG3pRXL3d1lMJHFFT8PJegljn7vg64LAbjhk5yNgBXbMg/XbObu755SJTNtbEL/aSdrGNg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.80.tgz", + "integrity": "sha512-6tf93ZF56KOiTTAjK/UhLZkl1W543IzaTQly288kockJZFswpRTnQEI00Yvacpb39DTvTYu3/ha9SeKpo/pgZQ==", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "detect-libc": "^2.1.2" @@ -674,20 +711,20 @@ "copilot": "npm-loader.js" }, "optionalDependencies": { - "@github/copilot-darwin-arm64": "1.0.56-2", - "@github/copilot-darwin-x64": "1.0.56-2", - "@github/copilot-linux-arm64": "1.0.56-2", - "@github/copilot-linux-x64": "1.0.56-2", - "@github/copilot-linuxmusl-arm64": "1.0.56-2", - "@github/copilot-linuxmusl-x64": "1.0.56-2", - "@github/copilot-win32-arm64": "1.0.56-2", - "@github/copilot-win32-x64": "1.0.56-2" + "@github/copilot-darwin-arm64": "1.0.80", + "@github/copilot-darwin-x64": "1.0.80", + "@github/copilot-linux-arm64": "1.0.80", + "@github/copilot-linux-x64": "1.0.80", + "@github/copilot-linuxmusl-arm64": "1.0.80", + "@github/copilot-linuxmusl-x64": "1.0.80", + "@github/copilot-win32-arm64": "1.0.80", + "@github/copilot-win32-x64": "1.0.80" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.56-2.tgz", - "integrity": "sha512-RHJNhdPSkdPc/nabWVess7BfEda7xfwBQ2X5vq9nq4VjqTbvUHBFwTt792q00TE4DZR/UsWr0sJKJkLcRvTltQ==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.80.tgz", + "integrity": "sha512-fzn4PnSx3+O/a3ip72KVsjnzORsEygK+0i21bFAnFBYS+0Wi1Pk+o/CmNsJ7aRbf1enSJrcH8UDVkyc9pMGEBg==", "cpu": [ "arm64" ], @@ -701,9 +738,9 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.56-2.tgz", - "integrity": "sha512-EqBtGH1I2rX5TzSJ+L9O22SQ8jlSsn1YJeFS6RTtYU+NhC6xLajjfTutkA5DZOr3eQgmeceit/4NDqEdjwANEA==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.80.tgz", + "integrity": "sha512-PKsyGk5DccNzR3bYXcYTGB9N6sHzhzGqEwq/2t1qBwqPbrC98Zo2dOT2G40/QYpJ4XdrGmTmdmfPJQ9PJknlIQ==", "cpu": [ "x64" ], @@ -717,15 +754,12 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.56-2.tgz", - "integrity": "sha512-FmjODKft2tmY5B0B94RDek/TR3QtdDTT7W/+lqkiosnUyLhsNtmzKaDYpiQsCBee68YUuB1umecqiTL1qMo3cw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.80.tgz", + "integrity": "sha512-8oXwN2luyHEjIoSk8AkATBjXDhRoQtuiUvC93GpfQKFHI+I1eoOVwIsAq5fKP8jNCF2rOrYFIcTjwmRt38kCcQ==", "cpu": [ "arm64" ], - "libc": [ - "glibc" - ], "license": "SEE LICENSE IN LICENSE.md", "optional": true, "os": [ @@ -736,15 +770,12 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.56-2.tgz", - "integrity": "sha512-aqF4k6mDLU1OXdaAb3gBIRCgdrlXX+1FBtcoLKPMjzVfkA2abEZ/vuYfZWS7ZaxG/aCOScp8D+/E+RaYHsGYOw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.80.tgz", + "integrity": "sha512-qv1ytVNwA3IDK7kcQow+fAikD67t42+AQ8X42bK/7oudNiv4frVZMO0yh1DYIebVRcmEhmPvbVPY/ptVUK3cbA==", "cpu": [ "x64" ], - "libc": [ - "glibc" - ], "license": "SEE LICENSE IN LICENSE.md", "optional": true, "os": [ @@ -755,15 +786,12 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.56-2.tgz", - "integrity": "sha512-+CztOiU7/nlNLX50jcpOMreMrDr7+DFnq3OV59doDd9UgqTdpjEnZKjkgHpxid117rYF/95cN5EYWD7ermOcjA==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.80.tgz", + "integrity": "sha512-Qjyi+OlVnPC4Lkuy7blDMMwMUQI/yELl7gDnqQlaN8TEbhZqZueuf3p0a+kEjXcNsw4XtNYQc0eMJqSIYy/Pjg==", "cpu": [ "arm64" ], - "libc": [ - "musl" - ], "license": "SEE LICENSE IN LICENSE.md", "optional": true, "os": [ @@ -774,15 +802,12 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.56-2.tgz", - "integrity": "sha512-FuBYfN2dX2a5fSEzPImtX6hjtjwiL0kutrq4RuvHYxUu0FR0JRB4vfN2mQ/KN4X5DZgaGkPQk19hkoEgd1tmdg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.80.tgz", + "integrity": "sha512-rBg8pugf+5FhiZxi2zkOr+rlcOVF6Xg63j1FvryfwPT4DJ2w5Na7O3lpS4sgu8QmsP5H+dAqjlXYLYsvSoVQ0g==", "cpu": [ "x64" ], - "libc": [ - "musl" - ], "license": "SEE LICENSE IN LICENSE.md", "optional": true, "os": [ @@ -793,9 +818,9 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.56-2.tgz", - "integrity": "sha512-mKTzS9HrH+wvOmIgIaRUs+l89o51P7ACVk4P/o1UEWGxDblTxwRZGL+cRBhqNltIxY+8XVIAEwg6CzE+sTH5Hw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.80.tgz", + "integrity": "sha512-+f7Vkd3vt2DYOxRnS8dStvYu3DY638N/AuLuIjxZp1F9GgwCUZK69wspqIxg2L59PmRRQcH4AGTrRDR60ENIZA==", "cpu": [ "arm64" ], @@ -809,9 +834,9 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.56-2.tgz", - "integrity": "sha512-tacHeeqNiLawmlUpturke10I9d6kkREqTcHGkGRy/MEwrio7A77L45j/IegRcQNjLwHP62R2+5GmNFx6BRwx9w==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.80.tgz", + "integrity": "sha512-PO0kPqhRTWQfsqGaj4UN3cj8ttkcJYy4wmXiArtFm+03AIFu8xTvuhQDPn2xEOsUome7m7t2XomKoavcrCcRsw==", "cpu": [ "x64" ], @@ -897,286 +922,426 @@ "dev": true, "license": "MIT" }, - "node_modules/@platformatic/vfs": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/@platformatic/vfs/-/vfs-0.3.0.tgz", - "integrity": "sha512-BGXVOAz59HYPZCgI9v/MtiTF/ng8YAWtkooxVwOPR3TatNgGy0WZ/t15ScqytiZi5NdSRqWNRfuAbXKeAlKDdQ==", - "dev": true, + "node_modules/@koromix/koffi-darwin-arm64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-darwin-arm64/-/koffi-darwin-arm64-3.1.0.tgz", + "integrity": "sha512-VEt5r3fXTfbejr83PnuOP0H7s9Zmazcs+lofu96DOcRkistlMsn59wYyWiKpyAjs9PCgm0Ykh62ChZ3CGMmIOg==", + "cpu": [ + "arm64" + ], "license": "MIT", - "engines": { - "node": ">= 22" + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://liberapay.com/Koromix" } }, - "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.4.tgz", - "integrity": "sha512-F5QXMSiFebS9hKZj02XhWLLnRpJ3B3AROP0tWbFBSj+6kCbg5m9j5JoHKd4mmSVy5mS/IMQloYgYxCuJC0fxEQ==", + "node_modules/@koromix/koffi-darwin-x64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-darwin-x64/-/koffi-darwin-x64-3.1.0.tgz", + "integrity": "sha512-n/tVRB9xIzdXT5H3zZt8ueThgWTSDL+yU7PWnU8wbZPBSawP/otx3swQyd6nMOqj1bmHgSHopiKSBXRS9pllmg==", "cpu": [ - "arm" + "x64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "android" - ] + "darwin" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-android-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.4.tgz", - "integrity": "sha512-GxxTKApUpzRhof7poWvCJHRF51C67u1R7D6DiluBE8wKU1u5GWE8t+v81JvJYtbawoBFX1hLv5Ei4eVjkWokaw==", + "node_modules/@koromix/koffi-freebsd-arm64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-freebsd-arm64/-/koffi-freebsd-arm64-3.1.0.tgz", + "integrity": "sha512-vazoPYIhOAlXZksVIqDRMIID4VeUZKx8F3dR90hOobT2ATyOkqNS5dv5UCV7Q7DSq22lQTrdbvENBAhROzCp0w==", "cpu": [ "arm64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "android" - ] + "freebsd" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.4.tgz", - "integrity": "sha512-tua0TaJxMOB1R0V0RS1jFZ/RpURFDJIOR2A6jWwQeawuFyS4gBW+rntLRaQd0EQ4bd6Vp44Z2rXW+YYDBsj6IA==", + "node_modules/@koromix/koffi-freebsd-ia32": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-freebsd-ia32/-/koffi-freebsd-ia32-3.1.0.tgz", + "integrity": "sha512-Vm7Uc97ru6RTSVmae2zCZZQeaizqVZ8WoU4+gG4H03Qe+WOj7kbKt/MxT7VBzdbPYIU5ZJeG/ZED1YlZyab6eQ==", "cpu": [ - "arm64" + "ia32" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "darwin" - ] + "freebsd" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.4.tgz", - "integrity": "sha512-CSKq7MsP+5PFIcydhAiR1K0UhEI1A2jWXVKHPCBZ151yOutENwvnPocgVHkivu2kviURtCEB6zUQw0vs8RrhMg==", + "node_modules/@koromix/koffi-freebsd-x64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-freebsd-x64/-/koffi-freebsd-x64-3.1.0.tgz", + "integrity": "sha512-N+VuVWjoiYPy1Go5mRadZ3B6RM5Qz+eCLhj2LXrMlefbUJ+O4gg7teCUGvPGfBEHDgmSN4yYUrfQmdJC10vOYw==", "cpu": [ "x64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "darwin" - ] + "freebsd" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.4.tgz", - "integrity": "sha512-+O8OkVdyvXMtJEciu2wS/pzm1IxntEEQx3z5TAVy4l32G0etZn+RsA48ARRrFm6Ri8fvqPQfgrvNxSjKAbnd3g==", + "node_modules/@koromix/koffi-linux-arm64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-linux-arm64/-/koffi-linux-arm64-3.1.0.tgz", + "integrity": "sha512-Wx5iOkeALe2ympLdiYwRpIg5qUkyQIv8N2foZ9rRker0uE7ZtXew2RRkbEgMir4b0yDYR1zyXd6B62GUzLtZ/g==", "cpu": [ "arm64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "freebsd" - ] + "linux" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.4.tgz", - "integrity": "sha512-Iw3oMskH3AfNuhU0MSN7vNbdi4me/NiYo2azqPz/Le16zHSa+3RRmliCMWWQmh4lcndccU40xcJuTYJZxNo/lw==", + "node_modules/@koromix/koffi-linux-ia32": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-linux-ia32/-/koffi-linux-ia32-3.1.0.tgz", + "integrity": "sha512-1DjYm1QehXU0dgn0uE+FGYOb3Of7GiTMqLS+ZI2gbl1b+h76sz4LRBvDVrQyAmSMVVU8/7696S21YgE/iBhBVg==", "cpu": [ - "x64" + "ia32" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "freebsd" - ] + "linux" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.4.tgz", - "integrity": "sha512-EIPRXTVQpHyF8WOo219AD2yEltPehLTcTMz2fn6JsatLYSzQf00hj3rulF+yauOlF9/FtM2WpkT/hJh/KJFGhA==", + "node_modules/@koromix/koffi-linux-loong64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-linux-loong64/-/koffi-linux-loong64-3.1.0.tgz", + "integrity": "sha512-NOa0LdyltdESz3oeTqUH6MErHVoJOHoeXIsEp6xIMTUh4eKXEtlDQeoK6EYqo0DnBt83Xud95qLvi4Aw12pG4Q==", "cpu": [ - "arm" + "loong64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.4.tgz", - "integrity": "sha512-J3Yh9PzzF1Ovah2At+lHiGQdsYgArxBbXv/zHfSyaiFQEqvNv7DcW98pCrmdjCZBrqBiKrKKe2V+aaSGWuBe/w==", + "node_modules/@koromix/koffi-linux-riscv64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-linux-riscv64/-/koffi-linux-riscv64-3.1.0.tgz", + "integrity": "sha512-Ye6kiXZCGxGtAIXSly6XuOP5tJZNYOZ2eVg33k1MilKrzimAy9Mpw4d6e9+Sfsc1jesgeNYs1sb5iaI8HS3ncA==", "cpu": [ - "arm" + "riscv64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.4.tgz", - "integrity": "sha512-BFDEZMYfUvLn37ONE1yMBojPxnMlTFsdyNoqncT0qFq1mAfllL+ATMMJd8TeuVMiX84s1KbcxcZbXInmcO2mRg==", + "node_modules/@koromix/koffi-linux-x64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-linux-x64/-/koffi-linux-x64-3.1.0.tgz", + "integrity": "sha512-3yQTOkQrMna4VX+yeyfYImBjLlGrItMpsWyfaW1uSiz/A6GRydqdwYH7DWnp4Z+RSGYZpsewkf7byMc8pOOQKA==", "cpu": [ - "arm64" + "x64" ], - "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.4.tgz", - "integrity": "sha512-pc9EYOSlOgdQ2uPl1o9PF6/kLSgaUosia7gOuS8mB69IxJvlclko1MECXysjs5ryez1/5zjYqx3+xYU0TU6R1A==", + "node_modules/@koromix/koffi-openbsd-ia32": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-openbsd-ia32/-/koffi-openbsd-ia32-3.1.0.tgz", + "integrity": "sha512-/cDoFHb9yx4+yoT3GUpnKnfi3W2drG+/Ewo0TTZaQHb4PsxnYYyT6V8+t4cL5XXbQcTTcOsZxpmBRrn0NBa3dA==", "cpu": [ - "arm64" + "ia32" ], - "dev": true, "license": "MIT", "optional": true, "os": [ - "linux" - ] + "openbsd" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } }, - "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.4.tgz", - "integrity": "sha512-NxnomyxYerDh5n4iLrNa+sH+Z+U4BMEE46V2PgQ/hoB909i8gV1M5wPojWg9fk1jWpO3IQnOs20K4wyZuFLEFQ==", + "node_modules/@koromix/koffi-openbsd-x64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-openbsd-x64/-/koffi-openbsd-x64-3.1.0.tgz", + "integrity": "sha512-CoQdqgnKvWgTXXZlUst8cBRQEov7QsxlTN2WAsu9wez01Xe6gEcH/zYePANualzzCbnaELfe5P0rA80QkoDuPA==", "cpu": [ - "loong64" + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } + }, + "node_modules/@koromix/koffi-win32-ia32": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-win32-ia32/-/koffi-win32-ia32-3.1.0.tgz", + "integrity": "sha512-WjrA+DEkpy0xEHu48+NSOboHhTnzkIfsFuq3d/WrSs+T9WflWRng3jC7mdJxmR4eHb6i6BqjW3k/U0mNUTjFPA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } + }, + "node_modules/@koromix/koffi-win32-x64": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@koromix/koffi-win32-x64/-/koffi-win32-x64-3.1.0.tgz", + "integrity": "sha512-tnK5+IkzQBauQAQSzuyjso8OOIQRlaTZS39xIWpfqVYDLVDIuLDQk/WwHcOrR5yxlDrZq9ygiebBTOfcJFia7w==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "funding": { + "url": "https://liberapay.com/Koromix" + } + }, + "node_modules/@napi-rs/wasm-runtime": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.4.tgz", + "integrity": "sha512-3NQNNgA1YSlJb/kMH1ildASP9HW7/7kYnRI2szWJaofaS1hWmbGI4H+d3+22aGzXXN9IJ+n+GiFVcGipJP18ow==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@tybys/wasm-util": "^0.10.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "peerDependencies": { + "@emnapi/core": "^1.7.1", + "@emnapi/runtime": "^1.7.1" + } + }, + "node_modules/@oxc-project/types": { + "version": "0.133.0", + "resolved": "https://registry.npmjs.org/@oxc-project/types/-/types-0.133.0.tgz", + "integrity": "sha512-KzkdCd6Uxqnf6l3HOw1xfatAlUURA0g14cvBYFyJ5SaNOQbOUvBr9PKArcPcrNIeRsBdgcUzOGrhKveVpvOIGA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/Boshen" + } + }, + "node_modules/@platformatic/vfs": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@platformatic/vfs/-/vfs-0.3.0.tgz", + "integrity": "sha512-BGXVOAz59HYPZCgI9v/MtiTF/ng8YAWtkooxVwOPR3TatNgGy0WZ/t15ScqytiZi5NdSRqWNRfuAbXKeAlKDdQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 22" + } + }, + "node_modules/@rolldown/binding-android-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-android-arm64/-/binding-android-arm64-1.0.3.tgz", + "integrity": "sha512-454rs7jHngixp/NMxd5srYD57OnzSlZ/eFTETjORQHLwJG1lRtmNOJcBerZlfu4GjKqeq8aCCIQrMdHyhI51Hw==", + "cpu": [ + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ - "linux" - ] + "android" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-loong64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.4.tgz", - "integrity": "sha512-nbJnQ8a3z1mtmrwImCYhc6BGpThAyYVRQxw9uKSKG4wR6aAYno9sVjJ0zaZcW9BPJX1GbrDPf+SvdWjgTuDmnw==", + "node_modules/@rolldown/binding-darwin-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-arm64/-/binding-darwin-arm64-1.0.3.tgz", + "integrity": "sha512-PcAhP+ynjURNyy8SKGl5DQP94aGuB/7JrXJb/t7P+hanXvQVMWzUvRRhBAcg/lNRadBhoUPqSoP4xw5tR/KBEA==", "cpu": [ - "loong64" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ - "linux" - ] + "darwin" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.4.tgz", - "integrity": "sha512-2EU6acNrQLd8tYvo/LXW535wupT3m6fo7HKo6lr7ktQoItxTyOL1ZCR/GfGCuXl2vR+zmfI6eRXkSemafv+iVg==", + "node_modules/@rolldown/binding-darwin-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-x64/-/binding-darwin-x64-1.0.3.tgz", + "integrity": "sha512-9YpfeUvSE2RS7wysJ81uOZkXJz7f7Q55H2Gvp3VEw/EsahqDtrphrZ0EwDLK5vvKOzaCrBsjF8JmnMLcUt78Gg==", "cpu": [ - "ppc64" + "x64" ], "dev": true, "license": "MIT", "optional": true, "os": [ - "linux" - ] + "darwin" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-ppc64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.4.tgz", - "integrity": "sha512-WeBtoMuaMxiiIrO2IYP3xs6GMWkJP2C0EoT8beTLkUPmzV1i/UcOSVw1d5r9KBODtHKilG5yFxsGRnBbK3wJ4A==", + "node_modules/@rolldown/binding-freebsd-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-freebsd-x64/-/binding-freebsd-x64-1.0.3.tgz", + "integrity": "sha512-yB1IlAsSNHncV6SCTL27/MVGR5htvQsoGxIv5KMGXALp+Ll1wYsn+x98M9MW7qa+NdSbvrrY7ANI4wLJ0n1e6g==", "cpu": [ - "ppc64" + "x64" ], "dev": true, "license": "MIT", "optional": true, "os": [ - "linux" - ] + "freebsd" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.4.tgz", - "integrity": "sha512-FJHFfqpKUI3A10WrWKiFbBZ7yVbGT4q4B5o1qKFFojqpaYoh9LrQgqWCmmcxQzVSXYtyB5bzkXrYzlHTs21MYA==", + "node_modules/@rolldown/binding-linux-arm-gnueabihf": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm-gnueabihf/-/binding-linux-arm-gnueabihf-1.0.3.tgz", + "integrity": "sha512-Yi30IVAAfLUCy2MseFjbB1jAMDl1VMCAas5StnYp8da9+CKvMd2H2cbEjWcw5NPaPqzvYkVIaF1nNUG+b7u/sw==", "cpu": [ - "riscv64" + "arm" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.4.tgz", - "integrity": "sha512-mcEl6CUT5IAUmQf1m9FYSmVqCJlpQ8r8eyftFUHG8i9OhY7BkBXSUdnLH5DOf0wCOjcP9v/QO93zpmF1SptCCw==", + "node_modules/@rolldown/binding-linux-arm64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-gnu/-/binding-linux-arm64-gnu-1.0.3.tgz", + "integrity": "sha512-jsO7R8To+AdlYgUmN5sHSCZbfhtMBkO0WUx8iORQnPcMMdgr7qM2DQmMwgabs3GhNztdmoKkMKQFHD6DTMCIQw==", "cpu": [ - "riscv64" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.4.tgz", - "integrity": "sha512-ynt3JxVd2w2buzoKDWIyiV1pJW93xlQic1THVLXilz429oijRpSHivZAgp65KBu+cMcgf1eVVjdnTLvPxgCuoQ==", + "node_modules/@rolldown/binding-linux-arm64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-musl/-/binding-linux-arm64-musl-1.0.3.tgz", + "integrity": "sha512-VWkUHwWriDciit80wleYwKILoR/KMvxh/IdwS/paX+ZgpuRpCrKLUdadJbc0NpBEiyhpYawsJ73j9aCvOH+f7Q==", "cpu": [ - "s390x" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.4.tgz", - "integrity": "sha512-Boiz5+MsaROEWDf+GGEwF8VMHGhlUoQMtIPjOgA5fv4osupqTVnJteQNKJwUcnUog2G55jYXH7KZFFiJe0TEzQ==", + "node_modules/@rolldown/binding-linux-ppc64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-ppc64-gnu/-/binding-linux-ppc64-gnu-1.0.3.tgz", + "integrity": "sha512-5f1laC0SlIR0yDbFCd8acUhvJIag6N3zC5P7oUPN6wX0aOma+uKJ0wBDH5aq7I1PVI2ttTlhJwzwRIBnLiSGEg==", "cpu": [ - "x64" + "ppc64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.4.tgz", - "integrity": "sha512-+qfSY27qIrFfI/Hom04KYFw3GKZSGU4lXus51wsb5EuySfFlWRwjkKWoE9emgRw/ukoT4Udsj4W/+xxG8VbPKg==", + "node_modules/@rolldown/binding-linux-s390x-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-s390x-gnu/-/binding-linux-s390x-gnu-1.0.3.tgz", + "integrity": "sha512-Iq4ko0r4XsgbrF/LunNgHtAGLRRVE2kXonAXQ/MV0mC6jQpMOhW1SvtZja2EhC/kd05++bP78dsqBeIQyYJ6Yg==", "cpu": [ - "x64" + "s390x" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-openbsd-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.4.tgz", - "integrity": "sha512-VpTfOPHgVXEBeeR8hZ2O0F3aSso+JDWqTWmTmzcQKted54IAdUVbxE+j/MVxUsKa8L20HJhv3vUezVPoquqWjA==", + "node_modules/@rolldown/binding-linux-x64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-gnu/-/binding-linux-x64-gnu-1.0.3.tgz", + "integrity": "sha512-B8m6tD5+/N5FeNQFbKlLA/2yVq9ycQP1SeedyEYYKWBNR3ZQbkvIUcNnDNM03lO1l5F2roiiFJGgvoLLyZXtSg==", "cpu": [ "x64" ], @@ -1184,27 +1349,33 @@ "license": "MIT", "optional": true, "os": [ - "openbsd" - ] + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.4.tgz", - "integrity": "sha512-IPOsh5aRYuLv/nkU51X10Bf75Bsf6+gZdx1X+QP5QM6lIJFHHqbHLG0uJn/hWthzo13UAc2umiUorqZy3axoZg==", + "node_modules/@rolldown/binding-linux-x64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-musl/-/binding-linux-x64-musl-1.0.3.tgz", + "integrity": "sha512-pSdpdUJHkuCxun9LE7jvgUB9qsRgaiyNNCX7m/AvHTcq67AiT/Yhoxvw5zPfhrM8k/BfP8ce/hMOpthKDpEUow==", "cpu": [ - "arm64" + "x64" ], "dev": true, "license": "MIT", "optional": true, "os": [ - "openharmony" - ] + "linux" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.4.tgz", - "integrity": "sha512-4QzE9E81OohJ/HKzHhsqU+zcYYojVOXlFMs1DdyMT6qXl/niOH7AVElmmEdUNHHS/oRkc++d5k6Vy85zFs0DEw==", + "node_modules/@rolldown/binding-openharmony-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-openharmony-arm64/-/binding-openharmony-arm64-1.0.3.tgz", + "integrity": "sha512-OXXS3RKJgX2uLwM+gYyuH5omcH8fL1LJs96pZGgtetVCahON57+d4SJHzTgZiOjxgGkSnpXpOsWuPDGAKAigEg==", "cpu": [ "arm64" ], @@ -1212,41 +1383,52 @@ "license": "MIT", "optional": true, "os": [ - "win32" - ] + "openharmony" + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.4.tgz", - "integrity": "sha512-zTPgT1YuHHcd+Tmx7h8aml0FWFVelV5N54oHow9SLj+GfoDy/huQ+UV396N/C7KpMDMiPspRktzM1/0r1usYEA==", + "node_modules/@rolldown/binding-wasm32-wasi": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-wasm32-wasi/-/binding-wasm32-wasi-1.0.3.tgz", + "integrity": "sha512-JTtb8BWFynicNSoPrehsCzBtOKjZ6jhMiPFEmOiuXg1Fl8dn2KHQob+GuPSGR0dryQa1PQJbzjF3dqO/whhjLg==", "cpu": [ - "ia32" + "wasm32" ], "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ] + "dependencies": { + "@emnapi/core": "1.10.0", + "@emnapi/runtime": "1.10.0", + "@napi-rs/wasm-runtime": "^1.1.4" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.4.tgz", - "integrity": "sha512-DRS4G7mi9lJxqEDezIkKCaUIKCrLUUDCUaCsTPCi/rtqaC6D/jjwslMQyiDU50Ka0JKpeXeRBFBAXwArY52vBw==", + "node_modules/@rolldown/binding-win32-arm64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-arm64-msvc/-/binding-win32-arm64-msvc-1.0.3.tgz", + "integrity": "sha512-gEdFFEN70A/jxb2svrWsN3aDL7OUtmvlOy+6fa2jxG8K0wQ1ZbdeLGnidov6Yu5/733dI5ySfzFlQ/cb0bSz1g==", "cpu": [ - "x64" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "win32" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.4.tgz", - "integrity": "sha512-QVTUovf40zgTqlFVrKA1uXMVvU2QWEFWfAH8Wdc48IxLvrJMQVMBRjuQyUpzZCDkakImib9eVazbWlC6ksWtJw==", + "node_modules/@rolldown/binding-win32-x64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-x64-msvc/-/binding-win32-x64-msvc-1.0.3.tgz", + "integrity": "sha512-eXB7CHuaQdqmJcc3koCNtNPmT/bj2gc999kUFgBxG8Ac0NdgXc4rkCHhqrgrhN3zddvvvrgzj1e90SuSfmyIXA==", "cpu": [ "x64" ], @@ -1255,7 +1437,17 @@ "optional": true, "os": [ "win32" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.1.tgz", + "integrity": "sha512-2j9bGt5Jh8hj+vPtgzPtl72j0yRxHAyumoo6TNfAjsLB04UtpSvPbPcDcBMxz7n+9CYB0c1GxQFxYRg2jimqGw==", + "dev": true, + "license": "MIT" }, "node_modules/@standard-schema/spec": { "version": "1.1.0", @@ -1264,6 +1456,17 @@ "dev": true, "license": "MIT" }, + "node_modules/@tybys/wasm-util": { + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.2.tgz", + "integrity": "sha512-RoBvJ2X0wuKlWFIjrwffGw1IqZHKQqzIchKaadZZfnNpsAYp2mM0h36JtPCjNDAHGgYez/15uMBpfGwchhiMgg==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, "node_modules/@types/chai": { "version": "5.2.3", "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", @@ -1313,6 +1516,16 @@ "undici-types": "~7.18.0" } }, + "node_modules/@types/ws": { + "version": "8.18.1", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", + "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "8.56.1", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.56.1.tgz", @@ -1547,31 +1760,31 @@ } }, "node_modules/@vitest/expect": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.0.18.tgz", - "integrity": "sha512-8sCWUyckXXYvx4opfzVY03EOiYVxyNrHS5QxX3DAIi5dpJAAkyJezHCP77VMX4HKA2LDT/Jpfo8i2r5BE3GnQQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.8.tgz", + "integrity": "sha512-h3nDO677RDLEGlBxyQ5CW8RlMThSKSRLUePLOx09gNIWRL40edgA1GCZSZgf1W55MFAG6/Sw14KeaAnqv0NKdQ==", "dev": true, "license": "MIT", "dependencies": { - "@standard-schema/spec": "^1.0.0", + "@standard-schema/spec": "^1.1.0", "@types/chai": "^5.2.2", - "@vitest/spy": "4.0.18", - "@vitest/utils": "4.0.18", - "chai": "^6.2.1", - "tinyrainbow": "^3.0.3" + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "chai": "^6.2.2", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.0.18.tgz", - "integrity": "sha512-HhVd0MDnzzsgevnOWCBj5Otnzobjy5wLBe4EdeeFGv8luMsGcYqDuFRMcttKWZA5vVO8RFjexVovXvAM4JoJDQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.8.tgz", + "integrity": "sha512-LEiN/xe4OSIbKe9HQIp5OC24agGD9J5CnmMgsLohVVoOPWL9a2sBoR6VBx43jQZb7Kr1l4RCuyCJzcAa0+dojw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "4.0.18", + "@vitest/spy": "4.1.8", "estree-walker": "^3.0.3", "magic-string": "^0.30.21" }, @@ -1580,7 +1793,7 @@ }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^6.0.0 || ^7.0.0-0" + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "msw": { @@ -1592,26 +1805,26 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.0.18.tgz", - "integrity": "sha512-P24GK3GulZWC5tz87ux0m8OADrQIUVDPIjjj65vBXYG17ZeU3qD7r+MNZ1RNv4l8CGU2vtTRqixrOi9fYk/yKw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.8.tgz", + "integrity": "sha512-9GasEBxpZ1VYIpqHf/0+YGg121uSNwCKOJqIrTwWP/TB7DmFCiaBpNl3aPZzoLWfWkuqhbH8vJIVobZkvdo2cA==", "dev": true, "license": "MIT", "dependencies": { - "tinyrainbow": "^3.0.3" + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.0.18.tgz", - "integrity": "sha512-rpk9y12PGa22Jg6g5M3UVVnTS7+zycIGk9ZNGN+m6tZHKQb7jrP7/77WfZy13Y/EUDd52NDsLRQhYKtv7XfPQw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.8.tgz", + "integrity": "sha512-EmVxeBAfMJvycdjd6Hm+RbFBbA9fKvo0Kx37hNpBYoYeavH3RNsBXWDooR1mgD52dCrxIIuP7UotpfiwOikvcg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "4.0.18", + "@vitest/utils": "4.1.8", "pathe": "^2.0.3" }, "funding": { @@ -1619,13 +1832,14 @@ } }, "node_modules/@vitest/snapshot": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.0.18.tgz", - "integrity": "sha512-PCiV0rcl7jKQjbgYqjtakly6T1uwv/5BQ9SwBLekVg/EaYeQFPiXcgrC2Y7vDMA8dM1SUEAEV82kgSQIlXNMvA==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.8.tgz", + "integrity": "sha512-acfZboRmAIf05DEKcBQy33VXojFJjtUdLyo7oOmV9kebb2xdU01UknNiPuPZoJZQyO7DF0gZdTGTpeAzET9QPQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "4.0.18", + "@vitest/pretty-format": "4.1.8", + "@vitest/utils": "4.1.8", "magic-string": "^0.30.21", "pathe": "^2.0.3" }, @@ -1634,9 +1848,9 @@ } }, "node_modules/@vitest/spy": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.0.18.tgz", - "integrity": "sha512-cbQt3PTSD7P2OARdVW3qWER5EGq7PHlvE+QfzSC0lbwO+xnt7+XH06ZzFjFRgzUX//JmpxrCu92VdwvEPlWSNw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.8.tgz", + "integrity": "sha512-6EevtBp6OZOPF7bmz36HrGMeP3txgVSrgebWxHOafDXGkhIzfXK14f8KF6MuFfgXXUeHxmpD3BQxkV00/3s5mA==", "dev": true, "license": "MIT", "funding": { @@ -1644,14 +1858,15 @@ } }, "node_modules/@vitest/utils": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.0.18.tgz", - "integrity": "sha512-msMRKLMVLWygpK3u2Hybgi4MNjcYJvwTb0Ru09+fOyCXIgT5raYP041DRRdiJiI3k/2U6SEbAETB3YtBrUkCFA==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.8.tgz", + "integrity": "sha512-uOJamYALNhfJ6iolExyQM40yIQwDqYnkKtQ5VCiSe17E33H0aQ/u+1GlRuz4LZBk6Mm3sg90G9hEbmEt37C1Zg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "4.0.18", - "tinyrainbow": "^3.0.3" + "@vitest/pretty-format": "4.1.8", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" @@ -1756,9 +1971,9 @@ "license": "MIT" }, "node_modules/brace-expansion": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", - "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", + "version": "1.1.16", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.16.tgz", + "integrity": "sha512-IDw48K2/2kRkg9LdJxurvq3lV3aBgq0REY89duEqFRthjlPdXHKMj7EnQOXVckxzgisinf3nHfrcE2FufFLXMw==", "dev": true, "license": "MIT", "dependencies": { @@ -1885,6 +2100,13 @@ "dev": true, "license": "MIT" }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, "node_modules/cross-fetch": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-4.1.0.tgz", @@ -1945,16 +2167,16 @@ } }, "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.1.0.tgz", + "integrity": "sha512-n27zTYMjYu1aj4MjCWzSP7G9r75utsaoc8m61weK+W8JMBGGQybd43GstCXZ3WNmSFtGT9wi59qQTW6mhTR5LQ==", "dev": true, "license": "MIT" }, "node_modules/esbuild": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.2.tgz", - "integrity": "sha512-HyNQImnsOC7X9PMNaCIeAm4ISCQXs5a5YasTXVliKv4uuBo1dKrG0A+uQS8M5eXjVMnLg3WgXaKvprHlFJQffw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -1965,32 +2187,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.2", - "@esbuild/android-arm": "0.27.2", - "@esbuild/android-arm64": "0.27.2", - "@esbuild/android-x64": "0.27.2", - "@esbuild/darwin-arm64": "0.27.2", - "@esbuild/darwin-x64": "0.27.2", - "@esbuild/freebsd-arm64": "0.27.2", - "@esbuild/freebsd-x64": "0.27.2", - "@esbuild/linux-arm": "0.27.2", - "@esbuild/linux-arm64": "0.27.2", - "@esbuild/linux-ia32": "0.27.2", - "@esbuild/linux-loong64": "0.27.2", - "@esbuild/linux-mips64el": "0.27.2", - "@esbuild/linux-ppc64": "0.27.2", - "@esbuild/linux-riscv64": "0.27.2", - "@esbuild/linux-s390x": "0.27.2", - "@esbuild/linux-x64": "0.27.2", - "@esbuild/netbsd-arm64": "0.27.2", - "@esbuild/netbsd-x64": "0.27.2", - "@esbuild/openbsd-arm64": "0.27.2", - "@esbuild/openbsd-x64": "0.27.2", - "@esbuild/openharmony-arm64": "0.27.2", - "@esbuild/sunos-x64": "0.27.2", - "@esbuild/win32-arm64": "0.27.2", - "@esbuild/win32-ia32": "0.27.2", - "@esbuild/win32-x64": "0.27.2" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/escape-string-regexp": { @@ -2354,19 +2576,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-tsconfig": { - "version": "4.13.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.0.tgz", - "integrity": "sha512-1VKTZJCwBrvbd+Wn3AOgQP/2Av+TfTCOlE4AcRJE72W1ksZXbAx8PPBR9RzgTeSPzlPMHrbANMH3LbltH73wxQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, "node_modules/glob": { "version": "13.0.6", "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.6.tgz", @@ -2524,10 +2733,20 @@ "license": "BSD-3-Clause" }, "node_modules/js-yaml": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", - "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz", + "integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/nodeca" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1" @@ -2598,6 +2817,32 @@ "json-buffer": "3.0.1" } }, + "node_modules/koffi": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/koffi/-/koffi-3.1.0.tgz", + "integrity": "sha512-0mCvdjTJBXioiaKNz0vajAEdWtfM5qyhVXSq+wQrrU3odzNvl/J7Cqna79QpNo9mfoKpQgGsyFFDRtDACCwGrQ==", + "hasInstallScript": true, + "license": "MIT", + "funding": { + "url": "https://liberapay.com/Koromix" + }, + "optionalDependencies": { + "@koromix/koffi-darwin-arm64": "3.1.0", + "@koromix/koffi-darwin-x64": "3.1.0", + "@koromix/koffi-freebsd-arm64": "3.1.0", + "@koromix/koffi-freebsd-ia32": "3.1.0", + "@koromix/koffi-freebsd-x64": "3.1.0", + "@koromix/koffi-linux-arm64": "3.1.0", + "@koromix/koffi-linux-ia32": "3.1.0", + "@koromix/koffi-linux-loong64": "3.1.0", + "@koromix/koffi-linux-riscv64": "3.1.0", + "@koromix/koffi-linux-x64": "3.1.0", + "@koromix/koffi-openbsd-ia32": "3.1.0", + "@koromix/koffi-openbsd-x64": "3.1.0", + "@koromix/koffi-win32-ia32": "3.1.0", + "@koromix/koffi-win32-x64": "3.1.0" + } + }, "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -2612,6 +2857,267 @@ "node": ">= 0.8.0" } }, + "node_modules/lightningcss": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.32.0.tgz", + "integrity": "sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==", + "dev": true, + "license": "MPL-2.0", + "dependencies": { + "detect-libc": "^2.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-android-arm64": "1.32.0", + "lightningcss-darwin-arm64": "1.32.0", + "lightningcss-darwin-x64": "1.32.0", + "lightningcss-freebsd-x64": "1.32.0", + "lightningcss-linux-arm-gnueabihf": "1.32.0", + "lightningcss-linux-arm64-gnu": "1.32.0", + "lightningcss-linux-arm64-musl": "1.32.0", + "lightningcss-linux-x64-gnu": "1.32.0", + "lightningcss-linux-x64-musl": "1.32.0", + "lightningcss-win32-arm64-msvc": "1.32.0", + "lightningcss-win32-x64-msvc": "1.32.0" + } + }, + "node_modules/lightningcss-android-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-android-arm64/-/lightningcss-android-arm64-1.32.0.tgz", + "integrity": "sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.32.0.tgz", + "integrity": "sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.32.0.tgz", + "integrity": "sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.32.0.tgz", + "integrity": "sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.32.0.tgz", + "integrity": "sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.32.0.tgz", + "integrity": "sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.32.0.tgz", + "integrity": "sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.32.0.tgz", + "integrity": "sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.32.0.tgz", + "integrity": "sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-arm64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.32.0.tgz", + "integrity": "sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.32.0.tgz", + "integrity": "sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -2689,16 +3195,16 @@ } }, "node_modules/minimatch/node_modules/brace-expansion": { - "version": "5.0.6", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.6.tgz", - "integrity": "sha512-kLpxurY4Z4r9sgMsyG0Z9uzsBlgiU/EFKhj/h91/8yHu0edo7XuixOIH3VcJ8kkxs6/jPzoI6U9Vj3WqbMQ94g==", + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.8.tgz", + "integrity": "sha512-JZyDyq3D4AUifKTPOB7DELf6XsB3WdPuNxCtob1vFXPsSXhdAiHBWJ/tJ8HAc9aH84BK+5JFZLNkJKx3G9kzQg==", "dev": true, "license": "MIT", "dependencies": { "balanced-match": "^4.0.2" }, "engines": { - "node": "18 || 20 || >=22" + "node": "20 || >=22" } }, "node_modules/minimist": { @@ -2729,9 +3235,9 @@ "license": "MIT" }, "node_modules/nanoid": { - "version": "3.3.12", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", - "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", + "version": "3.3.17", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.17.tgz", + "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==", "dev": true, "funding": [ { @@ -2938,9 +3444,9 @@ } }, "node_modules/postcss": { - "version": "8.5.15", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.15.tgz", - "integrity": "sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A==", + "version": "8.5.25", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.25.tgz", + "integrity": "sha512-DTPx3RWSSnWyzLxQnlH0rJP+EW5ekl16ZU4/psbIhA0e53kJfdgaN5vKM+xP7yJtXVu+nfdVFmlgFDEKAe4Pyw==", "dev": true, "funding": [ { @@ -2958,7 +3464,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.12", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -3062,16 +3568,6 @@ "node": ">=4" } }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, "node_modules/rimraf": { "version": "6.1.3", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-6.1.3.tgz", @@ -3092,49 +3588,38 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/rollup": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.4.tgz", - "integrity": "sha512-WHeFSbZYsPu3+bLoNRUuAO+wavNlocOPf3wSHTP7hcFKVnJeWsYlCDbr3mTS14FCizf9ccIxXA8sGL8zKeQN3g==", + "node_modules/rolldown": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/rolldown/-/rolldown-1.0.3.tgz", + "integrity": "sha512-i00lAJ2ks1BYr7rjNjKC7BcqAS7nVfiT3QX1SI5aY+AFHblCmaUf9OE9dbdzDvW6dJxbi2ZCZiy9v3CcwOiX3g==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.8" + "@oxc-project/types": "=0.133.0", + "@rolldown/pluginutils": "^1.0.0" }, "bin": { - "rollup": "dist/bin/rollup" + "rolldown": "bin/cli.mjs" }, "engines": { - "node": ">=18.0.0", - "npm": ">=8.0.0" + "node": "^20.19.0 || >=22.12.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.60.4", - "@rollup/rollup-android-arm64": "4.60.4", - "@rollup/rollup-darwin-arm64": "4.60.4", - "@rollup/rollup-darwin-x64": "4.60.4", - "@rollup/rollup-freebsd-arm64": "4.60.4", - "@rollup/rollup-freebsd-x64": "4.60.4", - "@rollup/rollup-linux-arm-gnueabihf": "4.60.4", - "@rollup/rollup-linux-arm-musleabihf": "4.60.4", - "@rollup/rollup-linux-arm64-gnu": "4.60.4", - "@rollup/rollup-linux-arm64-musl": "4.60.4", - "@rollup/rollup-linux-loong64-gnu": "4.60.4", - "@rollup/rollup-linux-loong64-musl": "4.60.4", - "@rollup/rollup-linux-ppc64-gnu": "4.60.4", - "@rollup/rollup-linux-ppc64-musl": "4.60.4", - "@rollup/rollup-linux-riscv64-gnu": "4.60.4", - "@rollup/rollup-linux-riscv64-musl": "4.60.4", - "@rollup/rollup-linux-s390x-gnu": "4.60.4", - "@rollup/rollup-linux-x64-gnu": "4.60.4", - "@rollup/rollup-linux-x64-musl": "4.60.4", - "@rollup/rollup-openbsd-x64": "4.60.4", - "@rollup/rollup-openharmony-arm64": "4.60.4", - "@rollup/rollup-win32-arm64-msvc": "4.60.4", - "@rollup/rollup-win32-ia32-msvc": "4.60.4", - "@rollup/rollup-win32-x64-gnu": "4.60.4", - "@rollup/rollup-win32-x64-msvc": "4.60.4", - "fsevents": "~2.3.2" + "@rolldown/binding-android-arm64": "1.0.3", + "@rolldown/binding-darwin-arm64": "1.0.3", + "@rolldown/binding-darwin-x64": "1.0.3", + "@rolldown/binding-freebsd-x64": "1.0.3", + "@rolldown/binding-linux-arm-gnueabihf": "1.0.3", + "@rolldown/binding-linux-arm64-gnu": "1.0.3", + "@rolldown/binding-linux-arm64-musl": "1.0.3", + "@rolldown/binding-linux-ppc64-gnu": "1.0.3", + "@rolldown/binding-linux-s390x-gnu": "1.0.3", + "@rolldown/binding-linux-x64-gnu": "1.0.3", + "@rolldown/binding-linux-x64-musl": "1.0.3", + "@rolldown/binding-openharmony-arm64": "1.0.3", + "@rolldown/binding-wasm32-wasi": "1.0.3", + "@rolldown/binding-win32-arm64-msvc": "1.0.3", + "@rolldown/binding-win32-x64-msvc": "1.0.3" } }, "node_modules/safe-buffer": { @@ -3219,9 +3704,9 @@ "license": "MIT" }, "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.1.0.tgz", + "integrity": "sha512-Rq7ybcX2RuC55r9oaPVEW7/xu3tj8u4GeBYHBWCychFtzMIr86A7e3PPEBPT37sHStKX3+TiX/Fr/ACmJLVlLQ==", "dev": true, "license": "MIT" }, @@ -3286,14 +3771,14 @@ } }, "node_modules/tinyglobby": { - "version": "0.2.15", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", - "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "version": "0.2.17", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", + "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "dev": true, "license": "MIT", "dependencies": { "fdir": "^6.5.0", - "picomatch": "^4.0.3" + "picomatch": "^4.0.4" }, "engines": { "node": ">=12.0.0" @@ -3303,9 +3788,9 @@ } }, "node_modules/tinyrainbow": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.0.3.tgz", - "integrity": "sha512-PSkbLUoxOFRzJYjjxHJt9xro7D+iilgMX/C9lawzVuYiIdcihh9DXmVibBe8lmcFrRi/VzlPjBxbN7rH24q8/Q==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", "dev": true, "license": "MIT", "engines": { @@ -3332,15 +3817,22 @@ "typescript": ">=4.8.4" } }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "dev": true, + "license": "0BSD", + "optional": true + }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" @@ -3433,18 +3925,17 @@ "license": "MIT" }, "node_modules/vite": { - "version": "7.3.3", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.3.tgz", - "integrity": "sha512-/4XH147Ui7OGTjg3HbdWe5arnZQSbfuRzdr9Ec7TQi5I7R+ir0Rlc9GIvD4v0XZurELqA035KVXJXpR61xhiTA==", + "version": "8.0.16", + "resolved": "https://registry.npmjs.org/vite/-/vite-8.0.16.tgz", + "integrity": "sha512-h9bXPmJichP5fLmVQo3PyaGSDE2n3aPuomeAlVRm0JLmt4rY6zmPKd59HYI4LNW8oTK7tlTsuC7l/m7awx9Jcw==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.27.0", - "fdir": "^6.5.0", - "picomatch": "^4.0.3", - "postcss": "^8.5.6", - "rollup": "^4.43.0", - "tinyglobby": "^0.2.15" + "lightningcss": "^1.32.0", + "picomatch": "^4.0.4", + "postcss": "^8.5.15", + "rolldown": "1.0.3", + "tinyglobby": "^0.2.17" }, "bin": { "vite": "bin/vite.js" @@ -3460,9 +3951,10 @@ }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", + "@vitejs/devtools": "^0.1.18", + "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", - "lightningcss": "^1.21.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", @@ -3475,13 +3967,16 @@ "@types/node": { "optional": true }, - "jiti": { + "@vitejs/devtools": { "optional": true }, - "less": { + "esbuild": { + "optional": true + }, + "jiti": { "optional": true }, - "lightningcss": { + "less": { "optional": true }, "sass": { @@ -3508,31 +4003,31 @@ } }, "node_modules/vitest": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.0.18.tgz", - "integrity": "sha512-hOQuK7h0FGKgBAas7v0mSAsnvrIgAvWmRFjmzpJ7SwFHH3g1k2u37JtYwOwmEKhK6ZO3v9ggDBBm0La1LCK4uQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.8.tgz", + "integrity": "sha512-flY6ScbCIt9HThs+C5HS7jvGOB560DJtk/Z15IQROTA6zEy49Nh8T/dofWTQL+n3vswqn87sbJNiuqw1SDp5Ig==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "4.0.18", - "@vitest/mocker": "4.0.18", - "@vitest/pretty-format": "4.0.18", - "@vitest/runner": "4.0.18", - "@vitest/snapshot": "4.0.18", - "@vitest/spy": "4.0.18", - "@vitest/utils": "4.0.18", - "es-module-lexer": "^1.7.0", - "expect-type": "^1.2.2", + "@vitest/expect": "4.1.8", + "@vitest/mocker": "4.1.8", + "@vitest/pretty-format": "4.1.8", + "@vitest/runner": "4.1.8", + "@vitest/snapshot": "4.1.8", + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", "magic-string": "^0.30.21", "obug": "^2.1.1", "pathe": "^2.0.3", "picomatch": "^4.0.3", - "std-env": "^3.10.0", + "std-env": "^4.0.0-rc.1", "tinybench": "^2.9.0", "tinyexec": "^1.0.2", "tinyglobby": "^0.2.15", - "tinyrainbow": "^3.0.3", - "vite": "^6.0.0 || ^7.0.0", + "tinyrainbow": "^3.1.0", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0", "why-is-node-running": "^2.3.0" }, "bin": { @@ -3548,12 +4043,15 @@ "@edge-runtime/vm": "*", "@opentelemetry/api": "^1.9.0", "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", - "@vitest/browser-playwright": "4.0.18", - "@vitest/browser-preview": "4.0.18", - "@vitest/browser-webdriverio": "4.0.18", - "@vitest/ui": "4.0.18", + "@vitest/browser-playwright": "4.1.8", + "@vitest/browser-preview": "4.1.8", + "@vitest/browser-webdriverio": "4.1.8", + "@vitest/coverage-istanbul": "4.1.8", + "@vitest/coverage-v8": "4.1.8", + "@vitest/ui": "4.1.8", "happy-dom": "*", - "jsdom": "*" + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "@edge-runtime/vm": { @@ -3574,6 +4072,12 @@ "@vitest/browser-webdriverio": { "optional": true }, + "@vitest/coverage-istanbul": { + "optional": true + }, + "@vitest/coverage-v8": { + "optional": true + }, "@vitest/ui": { "optional": true }, @@ -3582,6 +4086,9 @@ }, "jsdom": { "optional": true + }, + "vite": { + "optional": false } } }, @@ -3662,6 +4169,28 @@ "dev": true, "license": "MIT" }, + "node_modules/ws": { + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.21.0.tgz", + "integrity": "sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, "node_modules/yaml": { "version": "2.9.0", "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", diff --git a/nodejs/package.json b/nodejs/package.json index 09011e9df..9649c1b36 100644 --- a/nodejs/package.json +++ b/nodejs/package.json @@ -4,7 +4,7 @@ "type": "git", "url": "https://github.com/github/copilot-sdk.git" }, - "version": "0.1.8", + "version": "0.0.0-dev", "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC", "main": "./dist/cjs/index.js", "types": "./dist/index.d.ts", @@ -44,7 +44,7 @@ "generate": "cd ../scripts/codegen && npm run generate", "update:protocol-version": "tsx scripts/update-protocol-version.ts", "prepublishOnly": "npm run build", - "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" + "package": "npm run clean && npm run build && node scripts/set-version.js && npm pack && npm version 0.0.0-dev --no-git-tag-version --allow-same-version" }, "keywords": [ "github", @@ -56,16 +56,18 @@ "author": "GitHub", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.56-2", + "@github/copilot": "^1.0.80", + "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" }, "devDependencies": { "@platformatic/vfs": "^0.3.0", "@types/node": "^25.2.0", + "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.54.0", "@typescript-eslint/parser": "^8.54.0", - "esbuild": "^0.27.2", + "esbuild": "^0.28.1", "eslint": "^9.0.0", "glob": "^13.0.1", "json-schema": "^0.4.0", @@ -76,10 +78,11 @@ "semver": "^7.7.3", "tsx": "^4.20.6", "typescript": "^5.0.0", - "vitest": "^4.0.18" + "vitest": "^4.0.18", + "ws": "^8.21.0" }, "engines": { - "node": ">=20.0.0" + "node": "^20.19.0 || >=22.12.0" }, "files": [ "dist/**/*", diff --git a/nodejs/samples/package-lock.json b/nodejs/samples/package-lock.json index 6bb3b8df8..483a75834 100644 --- a/nodejs/samples/package-lock.json +++ b/nodejs/samples/package-lock.json @@ -15,19 +15,21 @@ }, "..": { "name": "@github/copilot-sdk", - "version": "0.1.8", + "version": "0.0.0-dev", "license": "MIT", "dependencies": { - "@github/copilot": "^1.0.56-2", + "@github/copilot": "^1.0.80", + "koffi": "^3.1.0", "vscode-jsonrpc": "^8.2.1", "zod": "^4.3.6" }, "devDependencies": { "@platformatic/vfs": "^0.3.0", "@types/node": "^25.2.0", + "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.54.0", "@typescript-eslint/parser": "^8.54.0", - "esbuild": "^0.27.2", + "esbuild": "^0.28.1", "eslint": "^9.0.0", "glob": "^13.0.1", "json-schema": "^0.4.0", @@ -38,16 +40,17 @@ "semver": "^7.7.3", "tsx": "^4.20.6", "typescript": "^5.0.0", - "vitest": "^4.0.18" + "vitest": "^4.0.18", + "ws": "^8.21.0" }, "engines": { - "node": ">=20.0.0" + "node": "^20.19.0 || >=22.12.0" } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", - "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -62,9 +65,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", - "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -79,9 +82,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", - "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -96,9 +99,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", - "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -113,9 +116,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", - "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -130,9 +133,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", - "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -147,9 +150,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", - "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -164,9 +167,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", - "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -181,9 +184,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", - "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -198,9 +201,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", - "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -215,9 +218,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", - "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -232,9 +235,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", - "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -249,9 +252,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", - "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -266,9 +269,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", - "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -283,9 +286,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", - "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -300,9 +303,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", - "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -317,9 +320,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", - "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -334,9 +337,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", - "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -351,9 +354,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", - "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -368,9 +371,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", - "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -385,9 +388,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", - "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -402,9 +405,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", - "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -419,9 +422,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", - "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -436,9 +439,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", - "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -453,9 +456,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", - "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -470,9 +473,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", - "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -501,9 +504,9 @@ } }, "node_modules/esbuild": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", - "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -514,32 +517,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.3", - "@esbuild/android-arm": "0.27.3", - "@esbuild/android-arm64": "0.27.3", - "@esbuild/android-x64": "0.27.3", - "@esbuild/darwin-arm64": "0.27.3", - "@esbuild/darwin-x64": "0.27.3", - "@esbuild/freebsd-arm64": "0.27.3", - "@esbuild/freebsd-x64": "0.27.3", - "@esbuild/linux-arm": "0.27.3", - "@esbuild/linux-arm64": "0.27.3", - "@esbuild/linux-ia32": "0.27.3", - "@esbuild/linux-loong64": "0.27.3", - "@esbuild/linux-mips64el": "0.27.3", - "@esbuild/linux-ppc64": "0.27.3", - "@esbuild/linux-riscv64": "0.27.3", - "@esbuild/linux-s390x": "0.27.3", - "@esbuild/linux-x64": "0.27.3", - "@esbuild/netbsd-arm64": "0.27.3", - "@esbuild/netbsd-x64": "0.27.3", - "@esbuild/openbsd-arm64": "0.27.3", - "@esbuild/openbsd-x64": "0.27.3", - "@esbuild/openharmony-arm64": "0.27.3", - "@esbuild/sunos-x64": "0.27.3", - "@esbuild/win32-arm64": "0.27.3", - "@esbuild/win32-ia32": "0.27.3", - "@esbuild/win32-x64": "0.27.3" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/fsevents": { @@ -557,38 +560,14 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-tsconfig": { - "version": "4.13.6", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.6.tgz", - "integrity": "sha512-shZT/QMiSHc/YBLxxOkMtgSid5HFoauqCE3/exfsEcwg1WkeqjG+V40yBbBrsD+jW2HDXcs28xOfcbm2jI8Ddw==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" diff --git a/nodejs/scripts/calculate-version.js b/nodejs/scripts/calculate-version.js index ac5722d43..c90ff1a37 100644 --- a/nodejs/scripts/calculate-version.js +++ b/nodejs/scripts/calculate-version.js @@ -43,13 +43,10 @@ export function calculateVersion(command, { latest, prerelease, unstable }) { } } - // TEMPORARY: "latest" uses prerelease increments so we publish beta versions - // under the "latest" dist-tag. To ship stable 1.0.0, revert the commit that - // introduced this temporary change. - const increment = "prerelease"; + const increment = command === "latest" ? "patch" : "prerelease"; const isIncrementingExistingPrerelease = semver.prerelease(higherVersion) !== null; const prereleaseIdentifier = - command === "prerelease" || command === "latest" + command === "prerelease" ? isIncrementingExistingPrerelease ? undefined : "preview" diff --git a/nodejs/scripts/npm-release.js b/nodejs/scripts/npm-release.js new file mode 100644 index 000000000..fe750bada --- /dev/null +++ b/nodejs/scripts/npm-release.js @@ -0,0 +1,92 @@ +import { spawn } from "node:child_process"; +import { pathToFileURL } from "node:url"; + +const PUBLIC_CONFLICT = + /^(?:npm (?:error|ERR!) code EPUBLISHCONFLICT|npm (?:error|ERR!) (?:403 [^\r\n]* - )?(?:You )?cannot publish over (?:the )?previously published versions(?:: [^\r\n]+)?\.?)\r?$/im; +const AZURE_CONFLICT = + /^npm (?:error|ERR!) (?:403 [^\r\n]* - )?(?:The feed '[^'\r\n]+' )?already contains file '[^'\r\n]+\.tgz' in package '[^'\r\n]+'\.?\r?$/im; + +export function runCommand(command, args, { stream = false } = {}) { + return new Promise((resolve, reject) => { + const child = spawn(command, args, { shell: false }); + let stdout = ""; + let stderr = ""; + + child.stdout.on("data", (chunk) => { + stdout += chunk; + if (stream) process.stdout.write(chunk); + }); + child.stderr.on("data", (chunk) => { + stderr += chunk; + if (stream) process.stderr.write(chunk); + }); + child.on("error", reject); + child.on("close", (status) => resolve({ status: status ?? 1, stdout, stderr })); + }); +} + +export async function assertVersionAbsent(packageName, version, registry, runner = runCommand) { + const result = await runner("npm", [ + "view", + `${packageName}@${version}`, + "version", + "--json", + "--registry", + registry, + ]); + + if (result.status === 0) { + throw new Error(`${packageName}@${version} already exists on public npm.`); + } + + try { + if (JSON.parse(result.stdout)?.error?.code === "E404") return; + } catch { + // The failure below includes npm's output for diagnosis. + } + + const output = `${result.stdout}\n${result.stderr}`.trim(); + throw new Error( + `Could not confirm that ${packageName}@${version} is absent from public npm (npm exited ${result.status}).${output ? `\n${output}` : ""}` + ); +} + +export async function publishTarball(tarball, tag, registry, mode, runner = runCommand) { + const args = ["publish", tarball, "--tag", tag, "--registry", registry]; + if (mode === "public") args.push("--access", "public"); + if (mode !== "public" && mode !== "azure") throw new Error(`Unknown publish mode: ${mode}`); + + const result = await runner("npm", args, { stream: true }); + if (result.status === 0) return; + + const output = `${result.stdout}\n${result.stderr}`; + if (PUBLIC_CONFLICT.test(output) || (mode === "azure" && AZURE_CONFLICT.test(output))) { + console.log( + "Version already published; treating the immutable-version conflict as success." + ); + return; + } + + throw new Error(`npm publish failed with exit code ${result.status}.`); +} + +async function main() { + const [command, ...args] = process.argv.slice(2); + if (command === "preflight" && args.length === 3) { + await assertVersionAbsent(...args); + console.log(`${args[0]}@${args[1]} is available on public npm.`); + } else if (command === "publish" && args.length === 4) { + await publishTarball(...args); + } else { + throw new Error( + "Usage: npm-release.js preflight | publish " + ); + } +} + +if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) { + main().catch((error) => { + console.error(`::error::${error.message}`); + process.exitCode = 1; + }); +} diff --git a/nodejs/scripts/set-version.js b/nodejs/scripts/set-version.js index 4d952f501..16969631f 100644 --- a/nodejs/scripts/set-version.js +++ b/nodejs/scripts/set-version.js @@ -3,7 +3,7 @@ import { readFileSync, writeFileSync } from "fs"; import { dirname, join } from "path"; import { fileURLToPath } from "url"; -const version = process.env.VERSION || "0.1.0-dev"; +const version = process.env.VERSION || "0.0.0-dev"; const packageJsonPath = join(dirname(fileURLToPath(import.meta.url)), "..", "package.json"); const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8")); diff --git a/nodejs/src/client.ts b/nodejs/src/client.ts index 0a4943879..30095186e 100644 --- a/nodejs/src/client.ts +++ b/nodejs/src/client.ts @@ -16,11 +16,12 @@ import { randomUUID } from "node:crypto"; import { existsSync } from "node:fs"; import { createRequire } from "node:module"; import { Socket } from "node:net"; -import { dirname, join } from "node:path"; +import { dirname, isAbsolute, join } from "node:path"; import { fileURLToPath } from "node:url"; import { createMessageConnection, ErrorCodes, + type Message, MessageConnection, ResponseError, StreamMessageReader, @@ -29,12 +30,20 @@ import { import { createServerRpc, createInternalServerRpc, + registerClientGlobalApiHandlers, registerClientSessionApiHandlers, } from "./generated/rpc.js"; -import type { OpenCanvasInstance, SessionUpdateOptionsParams } from "./generated/rpc.js"; +import type { + GitHubTelemetryNotification, + OpenCanvasInstance, + SessionUpdateOptionsParams, +} from "./generated/rpc.js"; import { getSdkProtocolVersion } from "./sdkProtocolVersion.js"; import { CopilotSession } from "./session.js"; +import type { FfiRuntimeHost } from "./ffiRuntimeHost.js"; import { createSessionFsAdapter, type SessionFsProvider } from "./sessionFsProvider.js"; +import { createCopilotRequestAdapter } from "./copilotRequestHandler.js"; +import type { CopilotRequestHandler } from "./copilotRequestHandler.js"; import { getTraceContext } from "./telemetry.js"; import { ToolSet } from "./toolSet.js"; import type { @@ -47,11 +56,15 @@ import type { ExitPlanModeResult, ForegroundSessionInfo, GetAuthStatusResponse, + BearerTokenProvider, GetStatusResponse, InternalRuntimeConnection, + RuntimeConnection, LargeToolOutputConfig, MCPServerConfig, ModelInfo, + NamedProviderConfig, + ProviderConfig, ResumeSessionConfig, SectionTransformFn, SessionConfig, @@ -72,12 +85,14 @@ import type { TypedSessionLifecycleHandler, } from "./types.js"; import { defaultJoinSessionPermissionHandler } from "./types.js"; +import type { FactoryHandle } from "./factory.js"; /** * Minimum protocol version this SDK can communicate with. * Servers reporting a version below this are rejected. */ const MIN_PROTOCOL_VERSION = 3; +const RUNTIME_SHUTDOWN_TIMEOUT_MS = 10_000; /** * Check if value is a Zod schema (has toJSONSchema method) @@ -91,6 +106,53 @@ function isZodSchema(value: unknown): value is { toJSONSchema(): Record(promise: Promise, timeoutMs: number, message: string): Promise { + let timeout: ReturnType | undefined; + try { + return await Promise.race([ + promise, + new Promise((_, reject) => { + timeout = setTimeout(() => reject(new Error(message)), timeoutMs); + }), + ]); + } finally { + if (timeout !== undefined) { + clearTimeout(timeout); + } + } +} + +async function waitForChildExit(child: ChildProcess, timeoutMs: number): Promise { + if (child.exitCode != null || child.signalCode != null) { + return true; + } + + return new Promise((resolve) => { + let timeout: ReturnType; + let settled = false; + const onExit = () => { + if (settled) { + return; + } + settled = true; + clearTimeout(timeout); + resolve(true); + }; + timeout = setTimeout(() => { + if (settled) { + return; + } + settled = true; + child.off("exit", onExit); + resolve(false); + }, timeoutMs); + child.once("exit", onExit); + if (child.exitCode != null || child.signalCode != null) { + onExit(); + } + }); +} + /** * Convert tool parameters to JSON schema format for sending to CLI */ @@ -102,6 +164,64 @@ function toJsonSchema(parameters: Tool["parameters"]): Record | return parameters; } +/** Implicit provider name for the singular, whole-session {@link ProviderConfig}. */ +const DEFAULT_PROVIDER_NAME = "default"; + +/** Wire-safe singular provider config carrying the `hasBearerTokenProvider` flag. */ +type WireProviderConfig = Omit & { + hasBearerTokenProvider?: boolean; +}; + +/** Wire-safe named provider config carrying the `hasBearerTokenProvider` flag. */ +type WireNamedProviderConfig = Omit & { + hasBearerTokenProvider?: boolean; +}; + +/** + * Strips the non-serializable {@link BearerTokenProvider} callbacks from the singular + * and named provider configs before they cross the RPC boundary, replacing each + * with a `hasBearerTokenProvider: true` wire flag. The callback closes over its + * own token scope/audience, so nothing scope-related crosses the wire — the + * runtime only forwards the provider name back when it needs a token. + * Returns wire-safe provider configs alongside a map of provider name → callback + * for session-side registration. + */ +function extractBearerTokenProviders( + provider: ProviderConfig | undefined, + providers: NamedProviderConfig[] | undefined +): { + wireProvider: WireProviderConfig | undefined; + wireProviders: WireNamedProviderConfig[] | undefined; + callbacks: Map; +} { + const callbacks = new Map(); + + let wireProvider: WireProviderConfig | undefined = provider; + if (provider?.bearerTokenProvider) { + const { bearerTokenProvider, ...rest } = provider; + callbacks.set(DEFAULT_PROVIDER_NAME, bearerTokenProvider); + wireProvider = { + ...rest, + hasBearerTokenProvider: true, + }; + } + + let wireProviders: WireNamedProviderConfig[] | undefined = providers; + if (providers?.some((p) => p.bearerTokenProvider)) { + wireProviders = providers.map((p) => { + if (!p.bearerTokenProvider) return p; + const { bearerTokenProvider, ...rest } = p; + callbacks.set(p.name, bearerTokenProvider); + return { + ...rest, + hasBearerTokenProvider: true, + }; + }); + } + + return { wireProvider, wireProviders, callbacks }; +} + /** * Convert MCP server configs from public API format (workingDirectory) to * wire format (cwd) expected by the runtime. @@ -229,36 +349,65 @@ function getNodeExecPath(): string { } /** - * Gets the path to the bundled CLI from the @github/copilot package. - * Uses index.js directly rather than npm-loader.js (which spawns the native binary). + * Computes the candidate platform-specific CLI package names for the current + * platform/arch, mirroring @github/copilot's npm-loader. As of CLI 1.0.64-1 the + * @github/copilot package is a thin loader and the actual CLI ships in a + * platform package (e.g. @github/copilot-darwin-arm64). For Linux we try both + * the glibc and musl variants since only the matching one is installed. + */ +function getCliPlatformPackageNames(): string[] { + const arch = process.arch; + const variants = process.platform === "linux" ? ["linux", "linuxmusl"] : [process.platform]; + return variants.map((variant) => `@github/copilot-${variant}-${arch}`); +} + +/** + * Gets the path to the bundled CLI from the platform-specific @github/copilot-* + * package. Uses index.js directly rather than the native binary so the CLI runs + * under the current Node.js runtime. * * In ESM, uses import.meta.resolve directly. In CJS (e.g., VS Code extensions * bundled with esbuild format:"cjs"), import.meta is empty so we fall back to * walking node_modules to find the package. */ function getBundledCliPath(): string { + const packageNames = getCliPlatformPackageNames(); + if (typeof import.meta.resolve === "function") { // ESM: resolve via import.meta.resolve - const sdkUrl = import.meta.resolve("@github/copilot/sdk"); - const sdkPath = fileURLToPath(sdkUrl); - // sdkPath is like .../node_modules/@github/copilot/sdk/index.js - // Go up two levels to get the package root, then append index.js - return join(dirname(dirname(sdkPath)), "index.js"); + for (const packageName of packageNames) { + try { + const sdkUrl = import.meta.resolve(`${packageName}/sdk`); + const sdkPath = fileURLToPath(sdkUrl); + // sdkPath is like .../node_modules/@github/copilot-/sdk/index.js + // Go up two levels to get the package root, then append index.js + return join(dirname(dirname(sdkPath)), "index.js"); + } catch { + // Try the next candidate platform package. + } + } + throw new Error( + `Could not resolve a @github/copilot platform package (tried ${packageNames.join(", ")}). ` + + `Ensure @github/copilot is installed, or pass cliPath/cliUrl to CopilotClient.` + ); } - // CJS fallback: the @github/copilot package has ESM-only exports so - // require.resolve cannot reach it. Walk the module search paths instead. + // CJS fallback: the platform packages have ESM-only exports so + // require.resolve cannot reach them. Walk the module search paths instead. const req = createRequire(__filename); const searchPaths = req.resolve.paths("@github/copilot") ?? []; for (const base of searchPaths) { - const candidate = join(base, "@github", "copilot", "index.js"); - if (existsSync(candidate)) { - return candidate; + for (const packageName of packageNames) { + const candidate = join(base, ...packageName.split("/"), "index.js"); + if (existsSync(candidate)) { + return candidate; + } } } throw new Error( - `Could not find @github/copilot package. Searched ${searchPaths.length} paths. ` + - `Ensure it is installed, or pass cliPath/cliUrl to CopilotClient.` + `Could not find a @github/copilot platform package (tried ${packageNames.join(", ")}). ` + + `Searched ${searchPaths.length} paths. ` + + `Ensure @github/copilot is installed, or pass cliPath/cliUrl to CopilotClient.` ); } @@ -295,10 +444,41 @@ function getBundledCliPath(): string { * await client.stop(); * ``` */ +/** + * A {@link StreamMessageWriter} that suppresses write failures while the client + * is tearing down its transport. + * + * During `stop()`/`forceStop()` the runtime's end of the pipe can close while + * vscode-jsonrpc still has an in-flight write — most commonly the + * auto-generated response to a server→client request (tool/hook/userInput/LLM + * inference handler) that resolved just before teardown. That write rejects + * with `ERR_STREAM_DESTROYED`, and because the response write is internal to + * vscode-jsonrpc and awaited by nobody, the rejection surfaces as an unhandled + * rejection. The writer still fires its `error` event (forwarded to + * {@link MessageConnection.onError}), so swallowing the rejected promise during + * teardown loses no signal. Outside teardown the flag stays `false`, so write + * failures propagate normally and in-flight requests still fail fast. + */ +class TeardownResilientStreamMessageWriter extends StreamMessageWriter { + public suppressWriteErrors = false; + + public override async write(msg: Message): Promise { + try { + await super.write(msg); + } catch (error) { + if (!this.suppressWriteErrors) { + throw error; + } + } + } +} + export class CopilotClient { private cliStartTimeout: ReturnType | null = null; private cliProcess: ChildProcess | null = null; + private ffiHost: FfiRuntimeHost | null = null; private connection: MessageConnection | null = null; + private messageWriter: TeardownResilientStreamMessageWriter | null = null; private socket: Socket | null = null; private runtimePort: number | null = null; private actualHost: string = "localhost"; @@ -341,6 +521,10 @@ export class CopilotClient { private negotiatedProtocolVersion: number | null = null; /** Connection-level session filesystem config, set via constructor option. */ private sessionFsConfig: SessionFsConfig | null = null; + private requestHandler: CopilotRequestHandler | null = null; + private builtinPluginDirectories: string[] = []; + private onGitHubTelemetry?: (notification: GitHubTelemetryNotification) => void | Promise; + private clientGlobalHandlers: import("./generated/rpc.js").ClientGlobalApiHandlers = {}; /** * Typed server-scoped RPC methods. @@ -370,6 +554,46 @@ export class CopilotClient { return this._internalRpc; } + private logDebugTiming(message: string, startMs: number): void { + const level = this.options.logLevel?.toLowerCase(); + if (level === "debug" || level === "all") { + process.stderr.write(`[copilot-sdk] ${message}. Elapsed=${Date.now() - startMs}ms\n`); + } + } + + private logDebug(message: string): void { + const level = this.options.logLevel?.toLowerCase(); + if (level === "debug" || level === "all") { + process.stderr.write(`[copilot-sdk] ${message}\n`); + } + } + + /** + * Environment variable that overrides the transport when the caller does not set + * {@link CopilotClientOptions.connection}. Accepts `"inprocess"` or `"stdio"` + * (case-insensitive); unset preserves the default stdio transport. Any other value + * is an error. + */ + private static readonly DEFAULT_CONNECTION_ENV_VAR = "COPILOT_SDK_DEFAULT_CONNECTION"; + + /** + * Resolves the default {@link RuntimeConnection} for the no-connection case, + * honoring {@link CopilotClient.DEFAULT_CONNECTION_ENV_VAR}. + */ + private static resolveDefaultConnection(): RuntimeConnection { + const value = process.env[CopilotClient.DEFAULT_CONNECTION_ENV_VAR]; + if (!value || value.toLowerCase() === "stdio") { + return { kind: "stdio" }; + } + if (value.toLowerCase() === "inprocess") { + return { kind: "inprocess" }; + } + throw new Error( + `Invalid ${CopilotClient.DEFAULT_CONNECTION_ENV_VAR} value '${value}'. ` + + `Expected 'inprocess', 'stdio', or unset.` + ); + } + /** * Creates a new CopilotClient instance. * @@ -401,8 +625,10 @@ export class CopilotClient { // Resolve the connection mode. `_internalConnection` is set by // `joinSession()` to opt into the parent-process stdio path; consumers // should always go through the public `connection` field. - const conn: InternalRuntimeConnection = options._internalConnection ?? - options.connection ?? { kind: "stdio" }; + const conn: InternalRuntimeConnection = + options._internalConnection ?? + options.connection ?? + CopilotClient.resolveDefaultConnection(); if ( conn.kind === "uri" && @@ -412,6 +638,40 @@ export class CopilotClient { "gitHubToken and useLoggedInUser cannot be used with RuntimeConnection.forUri (external server manages its own auth)" ); } + if (conn.kind === "inprocess" && options.workingDirectory !== undefined) { + throw new Error( + "workingDirectory is not supported with RuntimeConnection.forInProcess(): the in-process " + + "transport hosts the runtime in this process, so honoring it would require mutating the " + + "shared process-global cwd. Change the host process's working directory before " + + "constructing the client instead." + ); + } + if (conn.kind === "inprocess" && options.env !== undefined) { + throw new Error( + "env is not supported with RuntimeConnection.forInProcess(): the in-process transport loads " + + "the native runtime into the shared host process, whose single environment block cannot " + + "carry per-client values. Set the variables on the host process environment instead." + ); + } + if (conn.kind === "inprocess" && options.telemetry !== undefined) { + throw new Error( + "telemetry is not supported with RuntimeConnection.forInProcess(): telemetry configuration " + + "is lowered to environment variables read by native runtime code running in the shared " + + "host process, so per-client telemetry cannot be honored in-process. Configure telemetry " + + "via the host process environment, or use a child-process transport." + ); + } + if ( + (conn.kind === "stdio" || conn.kind === "tcp") && + conn.env !== undefined && + options.env !== undefined + ) { + throw new Error( + "Set environment variables via either the client-level env option or the connection's env " + + "(RuntimeConnection.forStdio/forTcp), not both. Prefer the connection-level env for " + + "child-process transports." + ); + } if (conn.kind === "tcp" && conn.connectionToken !== undefined) { if (typeof conn.connectionToken !== "string" || conn.connectionToken.length === 0) { throw new Error("connectionToken must be a non-empty string"); @@ -423,6 +683,16 @@ export class CopilotClient { if (options.sessionFs) { this.validateSessionFsConfig(options.sessionFs); } + if (options.builtinPluginDirectories) { + for (const path of options.builtinPluginDirectories) { + if (!isAbsolute(path)) { + throw new Error( + `builtinPluginDirectories must contain only absolute paths: ${path}` + ); + } + } + this.builtinPluginDirectories = [...options.builtinPluginDirectories]; + } // Pre-parse the URI host/port and mark as external if applicable. if (conn.kind === "uri") { @@ -445,8 +715,17 @@ export class CopilotClient { this.onListModels = options.onListModels; this.onGetTraceContext = options.onGetTraceContext; this.sessionFsConfig = options.sessionFs ?? null; - - const effectiveEnv = options.env ?? process.env; + this.requestHandler = options.requestHandler ?? null; + this.onGitHubTelemetry = options.onGitHubTelemetry; + this.setupClientGlobalHandlers(); + + // Connection-level env (child-process transports only) takes precedence + // over the client-level env, which falls back to the ambient process env. + // The constructor guard above rejects setting both, so at most one of the + // first two is defined. Mirrors .NET/Python precedence. + const connEnv: Record | undefined = + conn.kind === "stdio" || conn.kind === "tcp" ? conn.env : undefined; + const effectiveEnv = connEnv ?? options.env ?? process.env; this.resolvedEnv = effectiveEnv; this.resolvedCliPath = conn.kind === "stdio" || conn.kind === "tcp" @@ -561,6 +840,32 @@ export class CopilotClient { session.clientSessionApis.sessionFs = createSessionFsAdapter(provider); } + private setupClientGlobalHandlers(): void { + const handlers: import("./generated/rpc.js").ClientGlobalApiHandlers = {}; + if (this.requestHandler) { + handlers.llmInference = createCopilotRequestAdapter(this.requestHandler, () => { + if (!this.connection) { + return undefined; + } + this._rpc ??= createServerRpc(this.connection); + return this._rpc; + }); + } + if (this.onGitHubTelemetry) { + const onGitHubTelemetry = this.onGitHubTelemetry; + handlers.gitHubTelemetry = { + event: async (notification) => { + try { + await onGitHubTelemetry(notification); + } catch { + // Ignore handler errors + } + }, + }; + } + this.clientGlobalHandlers = handlers; + } + /** * Starts the CLI server and establishes a connection. * @@ -588,7 +893,9 @@ export class CopilotClient { try { // Only start CLI server process if not connecting to external server - if (!this.isExternalServer) { + if (this.connectionConfig.kind === "inprocess") { + await this.startInProcessFfi(); + } else if (!this.isExternalServer) { await this.startCLIServer(); } @@ -598,6 +905,17 @@ export class CopilotClient { // Verify protocol version compatibility await this.verifyProtocolVersion(); + if (this.builtinPluginDirectories.length > 0) { + try { + await this.connection!.sendRequest("plugins.builtin.set", { + paths: this.builtinPluginDirectories, + }); + } catch (error) { + await this.forceStop(); + throw error; + } + } + // If a session filesystem provider was configured, register it if (this.sessionFsConfig) { await this.connection!.sendRequest("sessionFs.setProvider", { @@ -608,6 +926,13 @@ export class CopilotClient { }); } + // If a request handler was configured, register it. The runtime + // will then route outbound model HTTP requests through the + // registered handler for the duration of each session. + if (this.requestHandler) { + await this.connection!.sendRequest("llmInference.setProvider", {}); + } + this.state = "connected"; } catch (error) { this.state = "error"; @@ -620,8 +945,9 @@ export class CopilotClient { * * This method performs graceful cleanup: * 1. Closes all active sessions (releases in-memory resources) - * 2. Closes the JSON-RPC connection - * 3. Terminates the CLI server process (if spawned by this client) + * 2. Requests runtime shutdown for SDK-owned CLI processes + * 3. Closes the JSON-RPC connection + * 4. Terminates the CLI server process (if spawned by this client) * * Note: session data on disk is preserved, so sessions can be resumed later. * To permanently remove session data before stopping, call @@ -642,7 +968,22 @@ export class CopilotClient { const errors: Error[] = []; // Disconnect all active sessions with retry logic - for (const session of this.sessions.values()) { + const activeSessions = [...this.sessions.values()]; + // TEMPORARY: over the in-process (FFI) transport the runtime shares this + // process, so a turn still running when the runtime disposes the session + // can leave that session's SQLite session.db handle open — it isn't + // reclaimed by terminating a child process, so the file stays locked + // (Windows) and the session-state directory can't be removed. Abort any + // in-flight turn first so it cancels and releases the handle. Best-effort + // and idempotent: a session with no active turn is a no-op. Scoped to + // in-process only: stdio/tcp runtimes run in a child process that we kill + // on shutdown (which frees the handle), and for external servers we don't + // own the runtime and aborting would cancel pending work other clients + // may still resume. Remove once the runtime cleans up fully on shutdown. + if (this.connectionConfig.kind === "inprocess") { + await Promise.allSettled(activeSessions.map((session) => session.abort())); + } + for (const session of activeSessions) { const sessionId = session.sessionId; let lastError: Error | null = null; @@ -671,9 +1012,48 @@ export class CopilotClient { ); } } + for (const session of activeSessions) { + session._markDisconnected(); + } this.sessions.clear(); - // Close connection + // Ask SDK-owned runtimes to flush and clean up before we tear down + // their transport/process. External runtimes may be shared, so only + // close our connection to them. + if (this.connection && (this.cliProcess || this.ffiHost) && !this.isExternalServer) { + const runtimeShutdownStart = Date.now(); + const shutdownPromise = this.rpc.runtime.shutdown(); + void shutdownPromise.catch(() => undefined); + try { + await withTimeout( + shutdownPromise, + RUNTIME_SHUTDOWN_TIMEOUT_MS, + `runtime.shutdown timed out after ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms` + ); + this.logDebugTiming( + "CopilotClient.stop runtime shutdown complete", + runtimeShutdownStart + ); + } catch (error) { + this.logDebugTiming( + "CopilotClient.stop runtime shutdown failed", + runtimeShutdownStart + ); + errors.push( + new Error( + `Failed to gracefully shut down runtime: ${error instanceof Error ? error.message : String(error)}` + ) + ); + } + } + + // Close connection. Suppress writer failures first: tearing down the + // transport can reject an in-flight server→client response write with + // ERR_STREAM_DESTROYED, which would otherwise surface as an unhandled + // rejection. dispose() still rejects any pending requests. + if (this.messageWriter) { + this.messageWriter.suppressWriteErrors = true; + } if (this.connection) { try { this.connection.dispose(); @@ -685,7 +1065,9 @@ export class CopilotClient { ); } this.connection = null; + this.messageWriter = null; this._rpc = null; + this._internalRpc = null; } // Clear models cache @@ -711,19 +1093,25 @@ export class CopilotClient { } } - // Send SIGTERM and await child exit. If the child ignores SIGTERM we - // intentionally block here — callers who need a guaranteed-bounded - // shutdown should reach for forceStop() instead, which sends SIGKILL. + // The runtime completes all cleanup before responding to + // runtime.shutdown and then leaves termination to us; it deliberately + // keeps its JSON-RPC server alive to send the response and never + // self-exits. Waiting a grace window for a self-exit that will never + // come just wastes time, so terminate the child immediately and only + // wait to reap it. if (this.cliProcess && !this.isExternalServer) { const child = this.cliProcess; this.cliProcess = null; try { - if (child.exitCode === null && child.signalCode === null) { - const exited = new Promise((resolve) => { - child.once("exit", () => resolve()); - }); + if (child.exitCode == null && child.signalCode == null) { child.kill(); - await exited; + if (!(await waitForChildExit(child, RUNTIME_SHUTDOWN_TIMEOUT_MS))) { + errors.push( + new Error( + `Timed out waiting for CLI process to exit after kill: ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms` + ) + ); + } } } catch (error) { errors.push( @@ -733,6 +1121,21 @@ export class CopilotClient { ); } } + // Tear down the in-process FFI host (closes the native connection and + // shuts down the native runtime host) for SDK-owned in-process runtimes. + if (this.ffiHost) { + const host = this.ffiHost; + this.ffiHost = null; + try { + host.dispose(); + } catch (error) { + errors.push( + new Error( + `Failed to dispose in-process runtime host: ${error instanceof Error ? error.message : String(error)}` + ) + ); + } + } if (this.cliStartTimeout) { clearTimeout(this.cliStartTimeout); this.cliStartTimeout = null; @@ -791,9 +1194,16 @@ export class CopilotClient { this.forceStopping = true; // Clear sessions immediately without trying to destroy them + for (const session of this.sessions.values()) { + session._markDisconnected(); + } this.sessions.clear(); - // Force close connection + // Force close connection. Suppress writer failures first so teardown + // write rejections don't surface as unhandled rejections. + if (this.messageWriter) { + this.messageWriter.suppressWriteErrors = true; + } if (this.connection) { try { this.connection.dispose(); @@ -801,7 +1211,9 @@ export class CopilotClient { // Ignore errors during force stop } this.connection = null; + this.messageWriter = null; this._rpc = null; + this._internalRpc = null; } // Clear models cache @@ -826,6 +1238,16 @@ export class CopilotClient { this.cliProcess = null; } + // Tear down the in-process FFI host (if any). + if (this.ffiHost) { + try { + this.ffiHost.dispose(); + } catch { + // Ignore errors during force stop + } + this.ffiHost = null; + } + if (this.cliStartTimeout) { clearTimeout(this.cliStartTimeout); this.cliStartTimeout = null; @@ -918,11 +1340,18 @@ export class CopilotClient { enableHostGitOperations: false, enableSessionStore: false, enableSkills: false, + memory: { enabled: false }, + customAgentsLocalOnly: true, }; } return {}; } + /** Mode-specific default for enableExperimentalMode. */ + private experimentalModeForMode(supplied: boolean | undefined): boolean | undefined { + return this.options.mode === "empty" ? (supplied ?? false) : supplied; + } + /** * Returns the systemMessage config to use, adjusted for the current mode. * In empty mode we ensure the environment_context section is removed @@ -1020,7 +1449,9 @@ export class CopilotClient { await this.start(); } - config = { ...this.configDefaultsForMode(), ...config }; + const modeDefaults = this.configDefaultsForMode(); + config = { ...modeDefaults, ...config }; + config.customAgentsLocalOnly ??= modeDefaults.customAgentsLocalOnly; config.systemMessage = this.getSystemMessageConfigForMode(config.systemMessage); // For cloud sessions, let the CLI/server assign the session id and @@ -1034,6 +1465,15 @@ export class CopilotClient { const useServerGeneratedId = config.cloud != null && callerSessionId == null; const localSessionId = useServerGeneratedId ? undefined : (callerSessionId ?? randomUUID()); + // Strip non-serializable bearerTokenProvider callbacks from provider configs, + // replacing them with a wire flag; keep the callbacks for session-side + // registration so the runtime can call back to acquire tokens. + const { + wireProvider: bearerWireProvider, + wireProviders: bearerWireProviders, + callbacks: bearerTokenCallbacks, + } = extractBearerTokenProviders(config.provider, config.providers); + // Extract transform callbacks from system message config before serialization. const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks( config.systemMessage @@ -1046,11 +1486,20 @@ export class CopilotClient { sessionId, this.connection!, undefined, - this.onGetTraceContext + this.onGetTraceContext, + { + mcpAuthHandler: config.onMcpAuthRequest, + managedSettingsEnabled: + config.enableManagedSettings === true || + config.managedSettings !== undefined, + } ); s.registerTools(config.tools); s.registerCanvases(config.canvases); s.registerCommands(config.commands); + if (bearerTokenCallbacks.size > 0) { + s.registerBearerTokenProviders(bearerTokenCallbacks); + } s.registerPermissionHandler(config.onPermissionRequest); if (config.onUserInputRequest) { s.registerUserInputHandler(config.onUserInputRequest); @@ -1100,6 +1549,7 @@ export class CopilotClient { clientName: config.clientName, reasoningEffort: config.reasoningEffort, reasoningSummary: config.reasoningSummary, + isExperimentalMode: this.experimentalModeForMode(config.enableExperimentalMode), contextTier: config.contextTier, tools: config.tools?.map((tool) => ({ name: tool.name, @@ -1107,12 +1557,17 @@ export class CopilotClient { parameters: toJsonSchema(tool.parameters), overridesBuiltInTool: tool.overridesBuiltInTool, skipPermission: tool.skipPermission, + defer: tool.defer, + metadata: tool.metadata, + isTerminal: tool.isTerminal, })), + toolSearch: config.toolSearch, canvases: config.canvases?.map((canvas) => canvas.declaration), requestCanvasRenderer: config.requestCanvasRenderer, requestExtensions: config.requestExtensions, extensionSdkPath: config.extensionSdkPath, extensionInfo: config.extensionInfo, + canvasProvider: config.canvasProvider, commands: config.commands?.map((cmd) => ({ name: cmd.name, description: cmd.description, @@ -1121,24 +1576,39 @@ export class CopilotClient { availableTools: toolFilterOptions.availableTools, excludedTools: toolFilterOptions.excludedTools, toolFilterPrecedence: toolFilterOptions.toolFilterPrecedence, - provider: config.provider, + excludedBuiltinAgents: config.excludedBuiltinAgents, + provider: bearerWireProvider, + capi: config.capi, + providers: bearerWireProviders, + models: config.models, enableSessionTelemetry: config.enableSessionTelemetry, + enableCitations: config.enableCitations, + enableFileChangeTracking: config.enableFileChangeTracking, + sessionLimits: config.sessionLimits, modelCapabilities: config.modelCapabilities, largeOutput: toWireLargeOutput(config.largeOutput), requestPermission: !!config.onPermissionRequest, requestUserInput: !!config.onUserInputRequest, requestElicitation: !!config.onElicitationRequest, ...(config.enableMcpApps ? { requestMcpApps: true } : {}), + ...(config.githubMcpToolConfig != null + ? { githubMcpToolConfig: config.githubMcpToolConfig } + : {}), requestExitPlanMode: !!config.onExitPlanModeRequest, requestAutoModeSwitch: !!config.onAutoModeSwitchRequest, hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)), workingDirectory: config.workingDirectory, + additionalDirectories: config.additionalDirectories, streaming: config.streaming, includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true, + ...(this.onGitHubTelemetry != null + ? { enableGitHubTelemetryForwarding: true } + : {}), mcpServers: toWireMcpServers(config.mcpServers), mcpOAuthTokenStorage: config.mcpOAuthTokenStorage, envValueMode: "direct", customAgents: toWireCustomAgents(config.customAgents), + customAgentsLocalOnly: config.customAgentsLocalOnly, defaultAgent: config.defaultAgent, agent: config.agent, configDir: config.configDirectory, @@ -1155,10 +1625,15 @@ export class CopilotClient { pluginDirectories: config.pluginDirectories, instructionDirectories: config.instructionDirectories, disabledSkills: config.disabledSkills, + disabledMcpServers: config.disabledMcpServers, infiniteSessions: config.infiniteSessions, + memory: config.memory, gitHubToken: config.gitHubToken, remoteSession: config.remoteSession, cloud: config.cloud, + expAssignments: config.expAssignments, + enableManagedSettings: config.enableManagedSettings, + managedSettings: config.managedSettings, }); const { @@ -1184,6 +1659,12 @@ export class CopilotClient { session = initializeSession(returnedSessionId); registeredId = returnedSessionId; } + if (config.onMcpAuthRequest) { + await this.connection!.sendRequest("session.eventLog.registerInterest", { + sessionId: returnedSessionId, + eventType: "mcp.oauth_required", + }); + } session["_workspacePath"] = workspacePath; session.setCapabilities(capabilities); @@ -1223,6 +1704,23 @@ export class CopilotClient { * ``` */ async resumeSession(sessionId: string, config: ResumeSessionConfig): Promise { + return this.resumeSessionInternal(sessionId, config); + } + + /** @internal */ + async resumeSessionForExtension( + sessionId: string, + config: ResumeSessionConfig, + factories?: FactoryHandle[] + ): Promise { + return this.resumeSessionInternal(sessionId, config, factories); + } + + private async resumeSessionInternal( + sessionId: string, + config: ResumeSessionConfig, + factories?: FactoryHandle[] + ): Promise { if (!this.connection) { await this.start(); } @@ -1233,11 +1731,25 @@ export class CopilotClient { sessionId, this.connection!, undefined, - this.onGetTraceContext + this.onGetTraceContext, + { + mcpAuthHandler: config.onMcpAuthRequest, + managedSettingsEnabled: + config.enableManagedSettings === true || config.managedSettings !== undefined, + } ); session.registerTools(config.tools); session.registerCanvases(config.canvases); session.registerCommands(config.commands); + session.registerFactories(factories); + const { + wireProvider: bearerWireProvider, + wireProviders: bearerWireProviders, + callbacks: bearerTokenCallbacks, + } = extractBearerTokenProviders(config.provider, config.providers); + if (bearerTokenCallbacks.size > 0) { + session.registerBearerTokenProviders(bearerTokenCallbacks); + } session.registerPermissionHandler(config.onPermissionRequest); if (config.onUserInputRequest) { session.registerUserInputHandler(config.onUserInputRequest); @@ -1255,7 +1767,9 @@ export class CopilotClient { session.registerHooks(config.hooks); } - config = { ...this.configDefaultsForMode(), ...config }; + const modeDefaults = this.configDefaultsForMode(); + config = { ...modeDefaults, ...config }; + config.customAgentsLocalOnly ??= modeDefaults.customAgentsLocalOnly; config.systemMessage = this.getSystemMessageConfigForMode(config.systemMessage); const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks( @@ -1281,29 +1795,43 @@ export class CopilotClient { model: config.model, reasoningEffort: config.reasoningEffort, reasoningSummary: config.reasoningSummary, + isExperimentalMode: this.experimentalModeForMode(config.enableExperimentalMode), contextTier: config.contextTier, systemMessage: wireSystemMessage, availableTools: toolFilterOptions.availableTools, excludedTools: toolFilterOptions.excludedTools, toolFilterPrecedence: toolFilterOptions.toolFilterPrecedence, enableSessionTelemetry: config.enableSessionTelemetry, + excludedBuiltinAgents: config.excludedBuiltinAgents, + enableCitations: config.enableCitations, + enableFileChangeTracking: config.enableFileChangeTracking, + sessionLimits: config.sessionLimits, tools: config.tools?.map((tool) => ({ name: tool.name, description: tool.description, parameters: toJsonSchema(tool.parameters), overridesBuiltInTool: tool.overridesBuiltInTool, skipPermission: tool.skipPermission, + defer: tool.defer, + metadata: tool.metadata, + isTerminal: tool.isTerminal, })), + toolSearch: config.toolSearch, canvases: config.canvases?.map((canvas) => canvas.declaration), + factories: factories?.map((factory) => factory.meta), requestCanvasRenderer: config.requestCanvasRenderer, requestExtensions: config.requestExtensions, extensionSdkPath: config.extensionSdkPath, extensionInfo: config.extensionInfo, + canvasProvider: config.canvasProvider, commands: config.commands?.map((cmd) => ({ name: cmd.name, description: cmd.description, })), - provider: config.provider, + provider: bearerWireProvider, + capi: config.capi, + providers: bearerWireProviders, + models: config.models, modelCapabilities: config.modelCapabilities, largeOutput: toWireLargeOutput(config.largeOutput), requestPermission: @@ -1311,10 +1839,14 @@ export class CopilotClient { requestUserInput: !!config.onUserInputRequest, requestElicitation: !!config.onElicitationRequest, ...(config.enableMcpApps ? { requestMcpApps: true } : {}), + ...(config.githubMcpToolConfig != null + ? { githubMcpToolConfig: config.githubMcpToolConfig } + : {}), requestExitPlanMode: !!config.onExitPlanModeRequest, requestAutoModeSwitch: !!config.onAutoModeSwitchRequest, hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)), workingDirectory: config.workingDirectory, + additionalDirectories: config.additionalDirectories, configDir: config.configDirectory, enableConfigDiscovery: config.enableConfigDiscovery, skipEmbeddingRetrieval: config.skipEmbeddingRetrieval, @@ -1327,22 +1859,31 @@ export class CopilotClient { enableSkills: config.enableSkills, streaming: config.streaming, includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true, + ...(this.onGitHubTelemetry != null + ? { enableGitHubTelemetryForwarding: true } + : {}), mcpServers: toWireMcpServers(config.mcpServers), mcpOAuthTokenStorage: config.mcpOAuthTokenStorage, envValueMode: "direct", customAgents: toWireCustomAgents(config.customAgents), + customAgentsLocalOnly: config.customAgentsLocalOnly, defaultAgent: config.defaultAgent, agent: config.agent, skillDirectories: config.skillDirectories, pluginDirectories: config.pluginDirectories, instructionDirectories: config.instructionDirectories, disabledSkills: config.disabledSkills, + disabledMcpServers: config.disabledMcpServers, infiniteSessions: config.infiniteSessions, - suppressResumeEvent: config.suppressResumeEvent, + memory: config.memory, + disableResume: config.suppressResumeEvent, continuePendingWork: config.continuePendingWork, gitHubToken: config.gitHubToken, remoteSession: config.remoteSession, openCanvases: config.openCanvases, + expAssignments: config.expAssignments, + enableManagedSettings: config.enableManagedSettings, + managedSettings: config.managedSettings, }); const { workspacePath, capabilities, openCanvases } = response as { @@ -1354,6 +1895,12 @@ export class CopilotClient { session["_workspacePath"] = workspacePath; session.setCapabilities(capabilities); session.setOpenCanvases(openCanvases ?? []); + if (config.onMcpAuthRequest) { + await this.connection!.sendRequest("session.eventLog.registerInterest", { + sessionId, + eventType: "mcp.oauth_required", + }); + } await this.updateSessionOptionsForMode(session, config); } catch (e) { @@ -1500,9 +2047,18 @@ export class CopilotClient { let serverVersion: number | undefined; try { - const result = await raceAgainstExit( - this.internalRpc.connect({ token: this.effectiveConnectionToken }) - ); + const connectParams: { + token?: string; + enableGitHubTelemetryForwarding?: boolean; + } = { token: this.effectiveConnectionToken }; + // Opt in to GitHub telemetry forwarding at the connection level when a + // handler is registered (mirrors the runtime, which reads this flag on the + // `connect` handshake so the first session's un-replayable `session.start` + // event is forwarded). Also sent on session.create/resume for older CLIs. + if (this.onGitHubTelemetry != null) { + connectParams.enableGitHubTelemetryForwarding = true; + } + const result = await raceAgainstExit(this.internalRpc.connect(connectParams)); serverVersion = result.protocolVersion; } catch (err) { if ( @@ -1840,6 +2396,47 @@ export class CopilotClient { }; } + /** + * Builds the environment for the spawned runtime child process (stdio/TCP): applies + * the auth token, connection token, `COPILOT_HOME`, keychain setting, and telemetry + * variables on top of the effective env. Not used by the in-process (FFI) transport, + * whose worker inherits the host process's ambient environment + * (see {@link CopilotClient.startInProcessFfi}). + */ + private buildRuntimeEnv(): Record { + const env: Record = { ...this.resolvedEnv }; + delete env.NODE_DEBUG; + + if (this.options.gitHubToken) { + env.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken; + } + if (this.effectiveConnectionToken) { + env.COPILOT_CONNECTION_TOKEN = this.effectiveConnectionToken; + } + if (this.options.baseDirectory) { + env.COPILOT_HOME = this.options.baseDirectory; + } + // In empty mode, disable the system keychain. Keytar reads from a + // process-wide store that's shared across sessions, which is unsafe + // for multi-tenant hosts. The runtime falls back to file-based + // credential storage scoped to COPILOT_HOME. + if (this.options.mode === "empty") { + env.COPILOT_DISABLE_KEYTAR = "1"; + } + if (this.options.telemetry) { + const t = this.options.telemetry; + env.COPILOT_OTEL_ENABLED = "true"; + if (t.otlpEndpoint !== undefined) env.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint; + if (t.otlpProtocol !== undefined) env.OTEL_EXPORTER_OTLP_PROTOCOL = t.otlpProtocol; + if (t.filePath !== undefined) env.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath; + if (t.exporterType !== undefined) env.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType; + if (t.sourceName !== undefined) env.COPILOT_OTEL_SOURCE_NAME = t.sourceName; + if (t.captureContent !== undefined) + env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(t.captureContent); + } + return env; + } + /** * Start the CLI server process */ @@ -1886,30 +2483,9 @@ export class CopilotClient { args.push("--remote"); } - // Suppress debug/trace output that might pollute stdout - const envWithoutNodeDebug = { ...this.resolvedEnv }; - delete envWithoutNodeDebug.NODE_DEBUG; - - // Set auth token in environment if provided - if (this.options.gitHubToken) { - envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken; - } - - if (this.effectiveConnectionToken) { - envWithoutNodeDebug.COPILOT_CONNECTION_TOKEN = this.effectiveConnectionToken; - } - - if (this.options.baseDirectory) { - envWithoutNodeDebug.COPILOT_HOME = this.options.baseDirectory; - } - - // In empty mode, disable the system keychain. Keytar reads from a - // process-wide store that's shared across sessions, which is unsafe - // for multi-tenant hosts. The runtime falls back to file-based - // credential storage scoped to COPILOT_HOME. - if (this.options.mode === "empty") { - envWithoutNodeDebug.COPILOT_DISABLE_KEYTAR = "1"; - } + // Suppress debug/trace output that might pollute stdout, and apply the + // shared runtime env (auth token, connection token, COPILOT_HOME, telemetry). + const envWithoutNodeDebug = this.buildRuntimeEnv(); if (!this.resolvedCliPath) { throw new Error( @@ -1921,24 +2497,6 @@ export class CopilotClient { ); } - // Set OpenTelemetry environment variables if telemetry is configured - if (this.options.telemetry) { - const t = this.options.telemetry; - envWithoutNodeDebug.COPILOT_OTEL_ENABLED = "true"; - if (t.otlpEndpoint !== undefined) - envWithoutNodeDebug.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint; - if (t.filePath !== undefined) - envWithoutNodeDebug.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath; - if (t.exporterType !== undefined) - envWithoutNodeDebug.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType; - if (t.sourceName !== undefined) - envWithoutNodeDebug.COPILOT_OTEL_SOURCE_NAME = t.sourceName; - if (t.captureContent !== undefined) - envWithoutNodeDebug.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String( - t.captureContent - ); - } - // Verify CLI exists before attempting to spawn if (!existsSync(this.resolvedCliPath)) { throw new Error( @@ -2075,12 +2633,120 @@ export class CopilotClient { return this.connectToParentProcessViaStdio(); case "stdio": return this.connectToChildProcessViaStdio(); + case "inprocess": + return this.connectViaFfi(); case "tcp": case "uri": return this.connectViaTcp(); } } + /** Starts the in-process FFI runtime with SDK-managed typed options. */ + private async startInProcessFfi(): Promise { + const entrypoint = this.resolveCliPathForFfi(); + // Load the FFI host lazily so the native `koffi` addon (and its + // platform-specific `koffi.node`) is only loaded on the in-process path; + // out-of-process (stdio/tcp) consumers never touch the native dependency. + // The transpiled output is per-file (not bundled), so this resolves the + // sibling module at runtime in both the ESM and CJS builds. + const { FfiRuntimeHost } = await import("./ffiRuntimeHost.js"); + const environment: Record = {}; + if (this.options.gitHubToken) { + environment.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken; + } + if (this.options.baseDirectory) { + environment.COPILOT_HOME = this.options.baseDirectory; + } + if (this.options.mode === "empty") { + environment.COPILOT_DISABLE_KEYTAR = "1"; + } + + const args: string[] = []; + if (this.options.logLevel) { + args.push("--log-level", this.options.logLevel); + } + if (this.options.gitHubToken) { + args.push("--auth-token-env", "COPILOT_SDK_AUTH_TOKEN"); + } + if (!this.options.useLoggedInUser) { + args.push("--no-auto-login"); + } + if (this.options.sessionIdleTimeoutSeconds > 0) { + args.push("--session-idle-timeout", this.options.sessionIdleTimeoutSeconds.toString()); + } + if (this.options.enableRemoteSessions) { + args.push("--remote"); + } + + const host = FfiRuntimeHost.create( + entrypoint, + CopilotClient.getNapiPrebuildsFolder(entrypoint), + environment, + args + ); + this.ffiHost = host; + await host.start(); + } + + /** + * Connect to the in-process FFI runtime host over its receive/send streams, + * reusing the same `vscode-jsonrpc` framing as the stdio transport. + */ + private async connectViaFfi(): Promise { + if (!this.ffiHost) { + throw new Error("In-process FFI runtime host not started"); + } + this.messageWriter = new TeardownResilientStreamMessageWriter(this.ffiHost.sendStream); + this.connection = createMessageConnection( + new StreamMessageReader(this.ffiHost.receiveStream), + this.messageWriter + ); + + this.attachConnectionHandlers(); + this.connection.listen(); + } + + /** + * Resolves the CLI entrypoint used for in-process FFI hosting: `COPILOT_CLI_PATH` + * when set, otherwise the bundled platform-package entrypoint. + */ + private resolveCliPathForFfi(): string { + return this.resolvedEnv.COPILOT_CLI_PATH ?? getBundledCliPath(); + } + + /** + * Returns the napi prebuilds folder name for the current host — the + * `-` convention (e.g. `win32-x64`, `darwin-arm64`, + * `linux-x64`, `linuxmusl-x64`) under which the runtime ships + * `prebuilds//runtime.node`. + */ + private static getNapiPrebuildsFolder(entrypoint: string): string { + const arch = process.arch; + if (arch !== "x64" && arch !== "arm64") { + throw new Error(`Unsupported architecture '${arch}' for in-process FFI hosting.`); + } + let platform: string = process.platform; + if (platform === "linux" && CopilotClient.isMusl(entrypoint)) { + platform = "linuxmusl"; + } + return `${platform}-${arch}`; + } + + private static isMusl(entrypoint: string): boolean { + if (entrypoint.includes(`copilot-linuxmusl-${process.arch}`)) { + return true; + } + if (entrypoint.includes(`copilot-linux-${process.arch}`)) { + return false; + } + const report = process.report?.getReport(); + const header = + report && "header" in report + ? (report.header as { glibcVersionRuntime?: string }) + : undefined; + return header !== undefined && header.glibcVersionRuntime === undefined; + } + /** * Connect to child via stdio pipes */ @@ -2089,17 +2755,27 @@ export class CopilotClient { throw new Error("CLI process not started"); } - // Add error handler to stdin to prevent unhandled rejections during forceStop + // Keep stdin pipe errors inside the normal JSON-RPC teardown path. + // Preserve the failure reason via the gated debug log rather than discarding it. this.cliProcess.stdin?.on("error", (err) => { - if (!this.forceStopping) { - throw err; + if (this.forceStopping) { + return; + } + this.state = "error"; + const reason = err instanceof Error ? (err.stack ?? err.message) : String(err); + this.logDebug(`stdin pipe error: ${reason}`); + try { + this.connection?.dispose(); + } catch { + // The connection may already be closing after the child process exited. } }); // Create JSON-RPC connection over stdin/stdout + this.messageWriter = new TeardownResilientStreamMessageWriter(this.cliProcess.stdin!); this.connection = createMessageConnection( new StreamMessageReader(this.cliProcess.stdout!), - new StreamMessageWriter(this.cliProcess.stdin!) + this.messageWriter ); this.attachConnectionHandlers(); @@ -2115,9 +2791,10 @@ export class CopilotClient { } // Create JSON-RPC connection over stdin/stdout + this.messageWriter = new TeardownResilientStreamMessageWriter(process.stdout); this.connection = createMessageConnection( new StreamMessageReader(process.stdin), - new StreamMessageWriter(process.stdout) + this.messageWriter ); this.attachConnectionHandlers(); @@ -2143,9 +2820,10 @@ export class CopilotClient { this.socket.connect(this.runtimePort!, this.actualHost, () => { clearTimeout(connectionTimeout); // Create JSON-RPC connection + this.messageWriter = new TeardownResilientStreamMessageWriter(this.socket!); this.connection = createMessageConnection( new StreamMessageReader(this.socket!), - new StreamMessageWriter(this.socket!) + this.messageWriter ); this.attachConnectionHandlers(); @@ -2199,15 +2877,6 @@ export class CopilotClient { await this.handleAutoModeSwitchRequest(params) ); - this.connection.onRequest( - "hooks.invoke", - async (params: { - sessionId: string; - hookType: string; - input: unknown; - }): Promise<{ output?: unknown }> => await this.handleHooksInvoke(params) - ); - this.connection.onRequest( "systemMessage.transform", async (params: { @@ -2225,6 +2894,22 @@ export class CopilotClient { return session.clientSessionApis; }); + // Register client *global* API handlers (e.g. LLM inference) on the + // same connection. These methods carry no implicit sessionId dispatch + // — the runtime calls into a single handler for the whole connection. + registerClientGlobalApiHandlers(this.connection, this.clientGlobalHandlers); + + // `hooks.invoke` is an internal RPC method: the runtime calls it to + // invoke a hook callback on the client. Route each call to the matching + // session's dispatcher. Not part of the public ClientGlobalApiHandlers + // interface because HookInvokeRequest/HookType are internal types. + this.connection.onRequest( + "hooks.invoke", + async (params: { sessionId: string; hookType: string; input: unknown }) => { + return await this.handleHooksInvoke(params); + } + ); + this.connection.onClose(() => { this.state = "disconnected"; }); @@ -2246,8 +2931,9 @@ export class CopilotClient { } const session = this.sessions.get((notification as { sessionId: string }).sessionId); + const event = (notification as { event: SessionEvent }).event; if (session) { - session._dispatchEvent((notification as { event: SessionEvent }).event); + session._dispatchEvent(event); } } diff --git a/nodejs/src/copilotRequestHandler.ts b/nodejs/src/copilotRequestHandler.ts new file mode 100644 index 000000000..ccfe6591c --- /dev/null +++ b/nodejs/src/copilotRequestHandler.ts @@ -0,0 +1,830 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import type { + LlmInferenceHandler, + LlmInferenceHeaders, + LlmInferenceHttpRequestChunkRequest, + LlmInferenceHttpRequestChunkResult, + LlmInferenceHttpRequestStartRequest, + LlmInferenceHttpRequestStartResult, +} from "./generated/rpc.js"; +import type { createServerRpc } from "./generated/rpc.js"; + +type ServerRpc = ReturnType; + +const sharedTextDecoder = new TextDecoder("utf-8", { fatal: false }); +const sharedTextEncoder = new TextEncoder(); + +const kBridge = Symbol("copilotWebSocketResponseBridge"); +const kCompletion = Symbol("copilotWebSocketCompletion"); +const kOpen = Symbol("copilotWebSocketOpen"); +const kSuppressCloseOnDispose = Symbol("copilotWebSocketSuppressCloseOnDispose"); +const kHandle = Symbol("copilotRequestHandle"); + +type InternalContext = CopilotRequestContext & { [kBridge]: CopilotWebSocketResponseBridge }; + +/** + * Per-request context handed to every {@link CopilotRequestHandler} hook. + * + * @experimental + */ +export interface CopilotRequestContext { + readonly requestId: string; + readonly sessionId?: string; + readonly agentId?: string; + readonly parentAgentId?: string; + readonly interactionType?: string; + readonly transport: "http" | "websocket"; + url: string; + headers: LlmInferenceHeaders; + readonly signal: AbortSignal; +} + +/** + * Terminal status for a callback-owned WebSocket connection. + * + * @experimental + */ +export class CopilotWebSocketCloseStatus { + static readonly normalClosure = new CopilotWebSocketCloseStatus(); + + constructor( + readonly description?: string, + readonly errorCode?: string, + readonly error?: Error + ) {} +} + +/** + * Lower-level WebSocket handler with no upstream connection. + * + * This is the abstract base shared by all WebSocket handlers. It does not open + * or forward to any upstream server on its own — subclass it directly only when + * you want to service a fully synthetic connection yourself (e.g. answer the + * runtime without any real backend). For the common case of mutating and + * forwarding traffic to the real upstream, subclass {@link CopilotWebSocketForwarder} + * instead, which connects upstream and forwards by default. + * + * @experimental + */ +export abstract class CopilotWebSocketHandler implements AsyncDisposable { + readonly #response: CopilotWebSocketResponseBridge; + readonly #completion: Promise; + #resolveCompletion!: (status: CopilotWebSocketCloseStatus) => void; + #closed = false; + [kSuppressCloseOnDispose] = false; + + protected readonly context: CopilotRequestContext; + + protected constructor(context: CopilotRequestContext) { + this.context = context; + const bridge = (context as Partial)[kBridge]; + if (!bridge) { + throw new Error("WebSocket response bridge is not attached"); + } + this.#response = bridge; + this.#completion = new Promise((resolve) => { + this.#resolveCompletion = resolve; + }); + } + + async sendResponseMessage(data: string | Uint8Array): Promise { + await this.#response.write(data); + } + + async close( + status: CopilotWebSocketCloseStatus = CopilotWebSocketCloseStatus.normalClosure + ): Promise { + if (this.#closed) { + return; + } + this.#closed = true; + if (status.error) { + await this.#response.error({ + message: status.description ?? status.error.message, + code: status.errorCode, + }); + } else { + await this.#response.end(); + } + this.#resolveCompletion(status); + } + + abstract sendRequestMessage(data: string | Uint8Array): Promise | void; + + async [Symbol.asyncDispose](): Promise { + if (!this[kSuppressCloseOnDispose] && !this.#closed) { + await this.close(CopilotWebSocketCloseStatus.normalClosure); + } + } + + /** @internal */ + get [kCompletion](): Promise { + return this.#completion; + } + + /** @internal */ + async [kOpen](): Promise {} +} + +/** + * WebSocket handler that connects to the real upstream and forwards traffic by + * default. This is the type returned by the default + * {@link CopilotRequestHandler.openWebSocket}. + * + * Override nothing to get full pass-through. To mutate traffic, subclass this + * type and override a message hook, then call `super` to keep forwarding to the + * upstream. (Subclassing {@link CopilotWebSocketHandler} instead would drop + * forwarding entirely.) + * + * @experimental + */ +export class CopilotWebSocketForwarder extends CopilotWebSocketHandler { + #upstream: WebSocket | null = null; + + constructor(context: CopilotRequestContext) { + super(context); + } + + override sendRequestMessage(data: string | Uint8Array): void { + if (this.#upstream?.readyState !== WebSocket.OPEN) { + return; + } + this.#upstream.send(data); + } + + /** @internal */ + override async [kOpen](): Promise { + if (this.#upstream) { + return; + } + const upstream = new WebSocket(this.context.url); + upstream.binaryType = "arraybuffer"; + this.#upstream = upstream; + upstream.addEventListener("message", (event) => { + void this.sendResponseMessage(normalizeWsData(event.data)).catch( + async (err: unknown) => { + await this.close( + new CopilotWebSocketCloseStatus( + err instanceof Error ? err.message : String(err), + undefined, + err instanceof Error ? err : new Error(String(err)) + ) + ); + } + ); + }); + upstream.addEventListener("close", () => { + void this.close(CopilotWebSocketCloseStatus.normalClosure); + }); + upstream.addEventListener("error", () => { + void this.close( + new CopilotWebSocketCloseStatus( + "WebSocket error", + undefined, + new Error("WebSocket error") + ) + ); + }); + await new Promise((resolve, reject) => { + if (upstream.readyState === WebSocket.OPEN) { + resolve(); + return; + } + upstream.addEventListener("open", () => resolve(), { once: true }); + upstream.addEventListener("error", () => reject(new Error("WebSocket error")), { + once: true, + }); + }); + } + + override async close( + status: CopilotWebSocketCloseStatus = CopilotWebSocketCloseStatus.normalClosure + ): Promise { + try { + if ( + this.#upstream?.readyState === WebSocket.OPEN || + this.#upstream?.readyState === WebSocket.CONNECTING + ) { + this.#upstream?.close(); + } + } catch { + // Best-effort; the socket may already be closed. + } + await super.close(status); + } + + override async [Symbol.asyncDispose](): Promise { + try { + await super[Symbol.asyncDispose](); + } finally { + try { + this.#upstream?.close(); + } catch { + // Best-effort. + } + } + } +} + +/** + * Base class for SDK consumers who want to observe or mutate the outbound + * model-layer requests the runtime issues (for both CAPI and BYOK providers). + * Subclass and override {@link sendRequest} or {@link openWebSocket}; an + * instance that overrides nothing is a transparent pass-through. + * + * @experimental + */ +export class CopilotRequestHandler { + protected sendRequest(request: Request, ctx: CopilotRequestContext): Promise { + return fetch(request, { signal: ctx.signal }); + } + + protected openWebSocket(ctx: CopilotRequestContext): Promise { + return Promise.resolve(new CopilotWebSocketForwarder(ctx)); + } + + /** @internal */ + async [kHandle](exchange: CopilotRequestExchange): Promise { + const bridge = new CopilotWebSocketResponseBridge(exchange); + const ctx: InternalContext = { + requestId: exchange.requestId, + sessionId: exchange.sessionId, + agentId: exchange.agentId, + parentAgentId: exchange.parentAgentId, + interactionType: exchange.interactionType, + transport: exchange.transport, + url: exchange.url, + headers: exchange.headers, + signal: exchange.signal, + [kBridge]: bridge, + }; + + if (exchange.transport === "websocket") { + await this.#handleWebSocket(exchange, ctx); + } else { + await this.#handleHttp(exchange, ctx); + } + } + + async #handleHttp(exchange: CopilotRequestExchange, ctx: CopilotRequestContext): Promise { + const request = await buildFetchRequest(exchange); + const response = await this.sendRequest(request, ctx); + await streamResponse(response, exchange); + } + + async #handleWebSocket(exchange: CopilotRequestExchange, ctx: InternalContext): Promise { + const handler = await this.openWebSocket(ctx); + try { + await handler[kOpen](); + + // The runtime blocks the WebSocket connect until it receives the + // 101 response head (the upgrade acknowledgement) and only then + // begins forwarding inbound messages as request-body chunks. Emit + // it eagerly here — waiting for the first upstream message would + // deadlock, since the upstream stays silent until it receives a + // request message the runtime won't send before the upgrade + // completes. + await ctx[kBridge].start(); + + let cancelled: unknown; + const clientSettled = (async () => { + for await (const chunk of exchange.requestBody) { + await handler.sendRequestMessage(decodeFrame(chunk)); + } + return "client-complete" as const; + })().catch((err) => { + cancelled = err; + return "client-error" as const; + }); + + const first = await Promise.race([ + clientSettled, + handler[kCompletion].then(() => "server-done" as const), + ]); + + if (first === "client-error") { + handler[kSuppressCloseOnDispose] = true; + throw cancelled instanceof Error ? cancelled : new Error(String(cancelled)); + } + + if (first === "client-complete") { + await handler.close(CopilotWebSocketCloseStatus.normalClosure); + await handler[kCompletion]; + return; + } + + const status = await handler[kCompletion]; + if (status.error) { + throw status.error; + } + } finally { + await handler[Symbol.asyncDispose](); + } + } +} + +/** + * Adapt a {@link CopilotRequestHandler} into the generated + * {@link LlmInferenceHandler} shape consumed by the SDK's RPC dispatcher. + * + * Maintains a per-`requestId` table of {@link CopilotRequestExchange}: each + * `httpRequestStart` allocates one and fires the handler in the background, + * returning immediately so the runtime's RPC reply is not gated on the + * consumer's I/O. Subsequent `httpRequestChunk` frames are routed into the + * matching exchange's body stream. + * + * @internal + */ +export function createCopilotRequestAdapter( + handler: CopilotRequestHandler, + getServerRpc: () => ServerRpc | undefined +): LlmInferenceHandler { + const pending = new Map(); + + function getOrCreate(requestId: string): CopilotRequestExchange { + // The runtime dispatches httpRequestStart and httpRequestChunk frames + // independently. get-or-create keeps the adapter correct regardless of + // arrival order: a body chunk (including the terminal end frame) that + // races ahead of its start frame is buffered into the same exchange + // rather than dropped, which would otherwise hang the body drain. + let exchange = pending.get(requestId); + if (!exchange) { + exchange = new CopilotRequestExchange(requestId, getServerRpc); + pending.set(requestId, exchange); + } + return exchange; + } + + async function run(exchange: CopilotRequestExchange): Promise { + try { + await handler[kHandle](exchange); + if (!exchange.finished) { + await finalize( + exchange, + 502, + "Copilot request handler returned without finalising the response (call responseBody.end() or .error())." + ); + } + } catch (err) { + if (exchange.cancelled || exchange.signal.aborted) { + // The runtime already cancelled this request; the handler's + // throw is just the abort propagating out of its upstream call. + await finalize(exchange, 499, "Request cancelled by runtime", "cancelled"); + return; + } + const message = err instanceof Error ? err.message : String(err); + await finalize(exchange, 502, message); + } finally { + pending.delete(exchange.requestId); + } + } + + return { + async httpRequestStart( + params: LlmInferenceHttpRequestStartRequest + ): Promise { + // Adopt any exchange a racing chunk already created — with its + // buffered body — rather than dropping those frames. + const exchange = getOrCreate(params.requestId); + exchange.setContext(params); + void run(exchange); + return {}; + }, + async httpRequestChunk( + params: LlmInferenceHttpRequestChunkRequest + ): Promise { + // May arrive before the matching start frame; get-or-create so the + // body is buffered, never lost. + routeChunk(getOrCreate(params.requestId), params); + return {}; + }, + }; +} + +async function finalize( + exchange: CopilotRequestExchange, + status: number, + message: string, + code?: string +): Promise { + if (exchange.finished) { + return; + } + try { + if (!exchange.started) { + await exchange.startResponse({ status, headers: {} }); + } + await exchange.errorResponse({ message, code }); + } catch { + // Best-effort — the connection may already be dead. + } +} + +function routeChunk( + exchange: CopilotRequestExchange, + params: LlmInferenceHttpRequestChunkRequest +): void { + if (params.cancel) { + exchange.pushCancel(params.cancelReason); + return; + } + if (params.data && params.data.length > 0) { + exchange.pushChunk(decodeChunkData(params.data, !!params.binary)); + } + if (params.end) { + exchange.pushEnd(); + } +} + +/** Response head emitted to the runtime via {@link CopilotRequestExchange.startResponse}. */ +interface ResponseInit { + status: number; + statusText?: string; + headers?: LlmInferenceHeaders; +} + +interface BodyQueueItem { + chunk?: Uint8Array; + end?: boolean; + cancel?: { reason?: string }; +} + +/** + * One intercepted request in flight. Carries the request context plus the body + * byte stream the runtime feeds in via `httpRequestChunk` frames, and emits the + * handler's response straight back to the runtime through the generated + * `llmInference` server API. Replaces the former provider/sink/response-channel + * indirection with a single object the adapter owns and the handler drives. + */ +class CopilotRequestExchange { + readonly requestId: string; + sessionId?: string; + agentId?: string; + parentAgentId?: string; + interactionType?: string; + method = "GET"; + url = ""; + headers: LlmInferenceHeaders = {}; + transport: "http" | "websocket" = "http"; + + readonly #getServerRpc: () => ServerRpc | undefined; + readonly #abort = new AbortController(); + readonly #buffer: BodyQueueItem[] = []; + #waker: (() => void) | null = null; + #drained = false; + #started = false; + #finished = false; + #cancelled = false; + + constructor(requestId: string, getServerRpc: () => ServerRpc | undefined) { + this.requestId = requestId; + this.#getServerRpc = getServerRpc; + } + + /** Fill in the request context once the matching start frame arrives. */ + setContext(params: LlmInferenceHttpRequestStartRequest): void { + this.sessionId = params.sessionId; + this.agentId = params.agentId; + this.parentAgentId = params.parentAgentId; + this.interactionType = params.interactionType; + this.method = params.method; + this.url = params.url; + this.headers = params.headers; + this.transport = params.transport ?? "http"; + } + + get signal(): AbortSignal { + return this.#abort.signal; + } + + get started(): boolean { + return this.#started; + } + + get finished(): boolean { + return this.#finished; + } + + get cancelled(): boolean { + return this.#cancelled; + } + + // --- Request body feed (driven by the adapter as chunk frames arrive) --- + + pushChunk(chunk: Uint8Array): void { + this.#push({ chunk }); + } + + pushEnd(): void { + this.#push({ end: true }); + } + + pushCancel(reason?: string): void { + this.#cancelled = true; + this.#abort.abort(); + this.#push({ cancel: { reason } }); + } + + #push(item: BodyQueueItem): void { + this.#buffer.push(item); + const w = this.#waker; + this.#waker = null; + w?.(); + } + + /** + * Request body bytes, yielded as they arrive. A cancel frame surfaces as a + * thrown error so the handler's upstream call is torn down. + */ + get requestBody(): AsyncIterable { + return { + [Symbol.asyncIterator]: (): AsyncIterator => ({ + next: async (): Promise> => { + if (this.#drained) { + return { value: undefined, done: true }; + } + while (this.#buffer.length === 0) { + await new Promise((resolve) => { + this.#waker = resolve; + }); + } + const item = this.#buffer.shift()!; + if (item.cancel) { + this.#drained = true; + throw new Error( + item.cancel.reason + ? `Request cancelled by runtime: ${item.cancel.reason}` + : "Request cancelled by runtime" + ); + } + if (item.end) { + this.#drained = true; + return { value: undefined, done: true }; + } + return { value: item.chunk ?? new Uint8Array(), done: false }; + }, + }), + }; + } + + // --- Response emit (driven by the handler). Strict state machine: --- + // startResponse once -> 0..N writeResponse -> exactly one of + // endResponse / errorResponse. + + async startResponse(init: ResponseInit): Promise { + if (this.#started) { + throw new Error("Copilot request response start() called twice."); + } + if (this.#finished) { + throw new Error("Copilot request response already finished."); + } + this.#started = true; + await this.#rpc().llmInference.httpResponseStart({ + requestId: this.requestId, + status: init.status, + statusText: init.statusText, + headers: init.headers ?? {}, + }); + } + + async writeResponse(data: string | Uint8Array): Promise { + if (this.#cancelled) { + throw new Error("Copilot request was cancelled by the runtime."); + } + if (!this.#started) { + throw new Error("Copilot request response write() called before start()."); + } + if (this.#finished) { + throw new Error("Copilot request response write() called after end()/error()."); + } + const isString = typeof data === "string"; + await this.#rpc().llmInference.httpResponseChunk({ + requestId: this.requestId, + data: isString ? data : Buffer.from(data).toString("base64"), + binary: !isString, + end: false, + }); + } + + async endResponse(): Promise { + if (this.#finished) { + return; + } + this.#finished = true; + await this.#rpc().llmInference.httpResponseChunk({ + requestId: this.requestId, + data: "", + end: true, + }); + } + + async errorResponse(error: { message: string; code?: string }): Promise { + if (this.#finished) { + return; + } + this.#finished = true; + await this.#rpc().llmInference.httpResponseChunk({ + requestId: this.requestId, + data: "", + end: true, + error: { message: error.message, code: error.code }, + }); + } + + #rpc(): ServerRpc { + const r = this.#getServerRpc(); + if (!r) { + throw new Error("Copilot request response used after RPC connection closed."); + } + return r; + } +} + +const FORBIDDEN_REQUEST_HEADERS = new Set([ + "host", + "connection", + "content-length", + "transfer-encoding", + "keep-alive", + "upgrade", + "proxy-connection", + "te", + "trailer", +]); + +async function buildFetchRequest(exchange: CopilotRequestExchange): Promise { + const headers = new Headers(); + for (const [name, values] of Object.entries(exchange.headers)) { + if (!values) { + continue; + } + if (FORBIDDEN_REQUEST_HEADERS.has(name.toLowerCase())) { + continue; + } + for (const value of values) { + headers.append(name, value); + } + } + + const method = exchange.method.toUpperCase(); + const hasBody = method !== "GET" && method !== "HEAD"; + + let body: Uint8Array | undefined; + if (hasBody) { + const buffered = await drainAsync(exchange.requestBody); + if (buffered.length > 0) { + body = buffered; + } + } else { + await drainAsync(exchange.requestBody); + } + + return new Request(exchange.url, { method, headers, body }); +} + +async function drainAsync(stream: AsyncIterable): Promise { + const parts: Uint8Array[] = []; + let total = 0; + for await (const chunk of stream) { + parts.push(chunk); + total += chunk.byteLength; + } + if (parts.length === 0) { + return new Uint8Array(0); + } + if (parts.length === 1) { + return parts[0]; + } + const out = new Uint8Array(total); + let off = 0; + for (const part of parts) { + out.set(part, off); + off += part.byteLength; + } + return out; +} + +async function streamResponse(response: Response, exchange: CopilotRequestExchange): Promise { + await exchange.startResponse({ + status: response.status, + statusText: response.statusText || undefined, + headers: headersToMultiMap(response.headers), + }); + + const body = response.body; + if (!body) { + await exchange.endResponse(); + return; + } + + const reader = body.getReader(); + try { + for (;;) { + const { value, done } = await reader.read(); + if (done) { + break; + } + if (value && value.byteLength > 0) { + await exchange.writeResponse(value); + } + } + await exchange.endResponse(); + } finally { + reader.releaseLock(); + } +} + +function headersToMultiMap(headers: Headers): LlmInferenceHeaders { + const out: Record = {}; + headers.forEach((value, name) => { + if (name.toLowerCase() === "set-cookie") { + return; + } + const list = out[name] ?? (out[name] = []); + list.push(value); + }); + const setCookies = headers.getSetCookie(); + if (setCookies.length > 0) { + out["set-cookie"] = setCookies; + } + return out; +} + +function decodeChunkData(data: string, binary: boolean): Uint8Array { + if (binary) { + return new Uint8Array(Buffer.from(data, "base64")); + } + return sharedTextEncoder.encode(data); +} + +function decodeFrame(chunk: Uint8Array): string { + return sharedTextDecoder.decode(chunk); +} + +function normalizeWsData(data: unknown): string | Uint8Array { + if (typeof data === "string") { + return data; + } + if (data instanceof Uint8Array) { + return data; + } + if (data instanceof ArrayBuffer) { + return new Uint8Array(data); + } + return new Uint8Array(); +} + +/** + * Forwards upstream WebSocket messages back to the owning + * {@link CopilotRequestExchange}. The 101 upgrade head is emitted eagerly via + * {@link start} (the runtime gates the connect on it); thereafter writes are + * serialised so the head always precedes any body or terminal frame. + */ +class CopilotWebSocketResponseBridge { + readonly #exchange: CopilotRequestExchange; + #started = false; + #completed = false; + #serial: Promise = Promise.resolve(); + + constructor(exchange: CopilotRequestExchange) { + this.#exchange = exchange; + } + + /** Emit the 101 upgrade head now, acknowledging the WebSocket connect. */ + start(): Promise { + return this.#run(false, () => Promise.resolve()); + } + + write(data: string | Uint8Array): Promise { + return this.#run(false, () => this.#exchange.writeResponse(data)); + } + + end(): Promise { + return this.#run(true, () => this.#exchange.endResponse()); + } + + error(error: { message: string; code?: string }): Promise { + return this.#run(true, () => this.#exchange.errorResponse(error)); + } + + #run(terminal: boolean, action: () => Promise): Promise { + const task = this.#serial.then(async () => { + if (this.#completed) { + return; + } + if (!this.#started) { + this.#started = true; + await this.#exchange.startResponse({ status: 101, headers: {} }); + } + if (terminal) { + this.#completed = true; + } + await action(); + }); + this.#serial = task.catch(() => {}); + return task; + } +} diff --git a/nodejs/src/extension.ts b/nodejs/src/extension.ts index 72bde93bd..c3ae0fd87 100644 --- a/nodejs/src/extension.ts +++ b/nodejs/src/extension.ts @@ -6,10 +6,10 @@ import { CopilotClient } from "./client.js"; import type { CopilotSession } from "./session.js"; import { defaultJoinSessionPermissionHandler, - type ExtensionInfo, type PermissionHandler, type ResumeSessionConfig, } from "./types.js"; +import type { FactoryHandle } from "./factory.js"; export { Canvas, @@ -27,9 +27,42 @@ export type JoinSessionConfig = Omit< "onPermissionRequest" | "extensionSdkPath" > & { onPermissionRequest?: PermissionHandler; + /** + * Factory handles to register when the extension joins the session. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ + factories?: FactoryHandle[]; }; -export type { ExtensionInfo }; +export type { ExtensionInfo, FactoryLimits, FactoryMeta } from "./types.js"; +export { + defineFactory, + FactoryResumeError, + isFactoryRunTerminal, + type RunOptions, + type ResumeOptions, + type FactoryResumeErrorCode, + type SessionFactoryApi, + type FactoryAgentOptions, + type FactoryContext, + type FactoryDefinition, + type FactoryHandle, + type FactoryJsonSchema, + type JsonValue, + type FactoryPipelineStage, + type FactoryStepOptions, + type FactoryRunResult, + type FactoryRunStatus, + type FactoryRunSummary, + type FactoryRunDetail, + type FactoryProgressPage, + type FactoryProgressLine, + type FactoryPhaseObservation, + type FactoryPhaseStatus, + type FactoryAgentSummary, +} from "./factory.js"; /** * Joins the current foreground session. @@ -58,14 +91,22 @@ export async function joinSession(config: JoinSessionConfig = {}): Promise = new Set([ + "completed", + "halted", + "cancelled", + "error", +]); + +/** + * Whether a factory run status is terminal. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export function isFactoryRunTerminal(status: FactoryRunStatus): boolean { + return FACTORY_TERMINAL_STATUSES.has(status); +} + +declare const factoryHandleBrand: unique symbol; + +/** A value that can be represented losslessly on the SDK JSON wire. */ +export type JsonValue = + | null + | boolean + | number + | string + | JsonValue[] + | { [key: string]: JsonValue }; + +/** + * Conservative JSON shape language accepted by the Agent Factories surface, for + * both structured factory agent output and a factory's declared `argsSchema`. + * + * This is a best-effort structural guard — used to decide whether a subagent's + * structured output should be accepted or retried, and whether a caller's + * factory `args` match the declared shape — **not** a full JSON Schema + * validator. Only these keywords are honored: `type`, `required`, `enum`, + * `const`, recursive `properties`/`items`, and `anyOf`/`oneOf`/`allOf`. A `type` + * is one of `null`, `boolean`, `integer`, `number`, `string`, `array`, or + * `object`, or a non-empty array of those (for example `["object", "null"]`). + * + * Everything else is **ignored, not enforced**. In particular, string + * constraints (`pattern`, `minLength`, `maxLength`, `format`), numeric ranges + * (`minimum`, `maximum`), `additionalProperties`, and boolean (`true`/`false`) + * schemas do not reject non-conforming output. `oneOf` is treated like `anyOf` + * (at least one branch must match) rather than strict exactly-one. Author + * schemas within this subset; do not rely on unsupported constraints for + * correctness. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export type FactoryJsonSchema = { [key: string]: JsonValue }; + +/** + * Options for one factory-scoped subagent call. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryAgentOptions { + label?: string; + schema?: FactoryJsonSchema; + model?: string; + reasoningEffort?: string; + contextTier?: ContextTier; + agent?: string; +} + +export const FACTORY_AGENT_OPTION_KEYS = [ + "label", + "schema", + "model", + "reasoningEffort", + "contextTier", + "agent", +] as const; + +/** + * Options for a durable factory step. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryStepOptions { + /** Skip the journal and always invoke the producer. */ + volatile?: boolean; +} + +/** + * One stage in a per-item factory pipeline. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export type FactoryPipelineStage = ( + previous: TInput, + item: unknown, + index: number +) => Promise | TResult; + +/** + * Context passed to an extension-authored factory body. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryContext { + /** Stable identifier for the current factory run. */ + readonly runId: string; + /** Spawn and await one factory-scoped subagent. */ + agent(prompt: string, options?: FactoryAgentOptions): Promise; + /** Memoize an arbitrary producer under a stable author-supplied key. */ + step( + key: string, + producer: () => Promise | JsonValue, + options?: FactoryStepOptions + ): Promise; + /** + * Run thunks concurrently and await all of them. + * + * A thunk that throws becomes `null` in the result array, so one failed + * item does not lose the rest. Cancellation and hard runtime failures + * (`ResponseError`, `ConnectionError`) are the exception: those propagate + * and reject the whole call, because they mean the run itself is in + * trouble rather than one item having failed. + */ + parallel( + thunks: Array<() => Promise | TResult> + ): Promise>; + /** + * Run each item through every stage without barriers between stages. + * + * A stage that throws drops that item to `null` and skips its remaining + * stages. As with {@link FactoryContext.parallel}, cancellation and hard + * runtime failures propagate instead of being recorded per item. + */ + pipeline(items: unknown[], ...stages: FactoryPipelineStage[]): Promise; + /** Start a named factory progress phase. */ + phase(title: string): void; + /** Emit a factory progress line. */ + log(message: string): void; + /** Reject because nested factories are not supported. */ + factory(name: string, args?: JsonValue): Promise; + /** Caller-supplied input, forwarded verbatim. */ + args: TArgs; + /** + * The session instance returned by `joinSession`. It refuses calls that + * start or resume a factory run. + */ + session: CopilotSession; + /** Cooperative cancellation signal for the current factory run. */ + signal: AbortSignal; +} + +/** + * Definition accepted by {@link defineFactory}. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryDefinition< + TArgs extends JsonValue = JsonValue, + TResult extends JsonValue | void = JsonValue | void, +> { + meta: FactoryMeta; + run(context: FactoryContext): Promise; +} + +/** + * A deeply immutable view of a value. + * + * `defineFactory` deep-freezes the metadata it stores, so the handle's view of + * it has to be readonly all the way down or `handle.meta.name = "..."` and + * `handle.meta.phases.push(...)` would compile and then throw at runtime. + */ +type DeepReadonly = T extends (infer U)[] + ? readonly DeepReadonly[] + : T extends object + ? { readonly [K in keyof T]: DeepReadonly } + : T; + +/** + * Opaque reusable reference to a defined factory. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryHandle< + TArgs extends JsonValue = JsonValue, + TResult extends JsonValue | void = JsonValue | void, +> { + readonly meta: DeepReadonly; + readonly [factoryHandleBrand]: { + readonly args: TArgs; + readonly result: TResult; + }; +} + +/** + * Options for invoking a factory. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface RunOptions { + /** Input surfaced as `context.args`. */ + args?: TArgs; + /** Optional per-invocation resource ceiling overrides. */ + limits?: FactoryLimits; + /** + * Prior run whose persisted identity, arguments, journal, and accounting should be resumed. + * + * @deprecated Use {@link SessionFactoryApi.resume} instead. + */ + resumeFromRunId?: string; +} + +/** + * Options for resuming a factory run by ID. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface ResumeOptions { + /** Optional per-invocation resource ceiling overrides. */ + limits?: FactoryLimits; +} + +/** + * Machine-readable pre-execution factory resume failure. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export type FactoryResumeErrorCode = + | "not_found" + | "non_resumable" + | "already_active" + | "factory_already_running" + | "factory_limits_invalid" + | "factory_session_disposed" + | "factory_storage_unavailable" + | "factory_storage_corrupt"; + +/** + * Friendly factory API exposed on a session. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface SessionFactoryApi { + /** + * Run a registered factory and resolve with its run envelope. + * + * The envelope is returned for every outcome, including `error`, `halted`, + * and `cancelled` — inspect `status` and read `result` only when the run + * completed. SDK-initiated runs do not request permission, so they have no + * declined outcome. The model's `run_factory` tool requests permission + * before a durable row exists; declining it creates no run row. Failures + * that occur before a run exists (such as an unknown factory or attempting + * to start a run while the session is at its active top-level run limit) + * still reject. + */ + run(name: string, options?: RunOptions): Promise; + run( + factory: FactoryHandle, + options?: RunOptions + ): Promise; + /** + * Resume a run from its persisted factory name, arguments, journal, and accounting. + * + * Resolves with the run envelope like {@link SessionFactoryApi.run}. + * SDK-initiated resumes do not request permission. A pre-execution failure + * with a documented resume code rejects with {@link FactoryResumeError}. + */ + resume(runId: string, options?: ResumeOptions): Promise; + /** Read the latest durable envelope for a factory run. */ + getRun(runId: string): Promise; + /** + * Wait for a run to settle and resolve with its terminal envelope. + * + * Resolves as soon as the run reaches `completed`, `error`, `halted`, or + * `cancelled`, and resolves immediately when it has already settled. A + * terminal envelope is final, so the resolved value never changes + * afterwards. + * + * This watches the run's `factory.run_updated` invalidation events and + * periodically re-reads the durable envelope so a missed event cannot + * leave the wait hanging. Pass a `signal` to stop waiting; aborting rejects + * and has no effect on the run itself, which keeps executing. Use + * {@link SessionFactoryApi.cancel} to actually stop it. + */ + waitForRun(runId: string, options?: { signal?: AbortSignal }): Promise; + /** + * List the newest default page of this session's durable factory runs. + */ + listRuns(): Promise; + /** Read durable phases, direct agents, and the latest progress tail for a run. */ + getRunDetail(runId: string): Promise; + /** Page durable progress forward, backward, or from the latest tail. */ + getRunProgress( + runId: string, + options?: Omit + ): Promise; + /** Cancel a factory run and return its terminal envelope. */ + cancel(runId: string): Promise; +} + +/** + * Error thrown when a factory cannot be resumed before execution begins. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export class FactoryResumeError extends Error { + constructor( + public readonly code: FactoryResumeErrorCode, + message: string + ) { + super(message); + this.name = "FactoryResumeError"; + } +} + +interface StoredFactory { + meta: FactoryMeta; + run(context: FactoryContext): Promise; +} + +const factoryHandles = new WeakMap(); + +/** Maximum accepted factory timeout in seconds, derived from Node's maximum timer delay. */ +const MAX_FACTORY_TIMEOUT_SECONDS = 2_147_483.647; +const NANO_AIU_PER_AIU = 1_000_000_000; + +function deepFreeze(value: T): T { + if (value !== null && typeof value === "object" && !Object.isFrozen(value)) { + Object.freeze(value); + for (const nested of Object.values(value)) { + deepFreeze(nested); + } + } + return value; +} + +function validateLimits(meta: FactoryMeta): void { + const limits = meta.limits; + if (!limits) { + return; + } + + for (const field of ["maxConcurrentSubagents", "maxTotalSubagents"] as const) { + const value = limits[field]; + if (value !== undefined && (!Number.isInteger(value) || value <= 0)) { + throw new Error(`Factory limit "${field}" must be a positive integer`); + } + } + + if ( + limits.timeoutSeconds !== undefined && + (!Number.isFinite(limits.timeoutSeconds) || limits.timeoutSeconds <= 0) + ) { + throw new Error( + 'Factory limit "timeoutSeconds" must be a positive, finite number of seconds' + ); + } + if ( + limits.timeoutSeconds !== undefined && + limits.timeoutSeconds > MAX_FACTORY_TIMEOUT_SECONDS + ) { + throw new Error( + `Factory limit "timeoutSeconds" must not exceed ${MAX_FACTORY_TIMEOUT_SECONDS} seconds` + ); + } + + if (limits.maxAiCredits !== undefined) { + const maxNanoAiu = Math.round(limits.maxAiCredits * NANO_AIU_PER_AIU); + if ( + !Number.isFinite(limits.maxAiCredits) || + limits.maxAiCredits <= 0 || + !Number.isSafeInteger(maxNanoAiu) || + maxNanoAiu < 1 + ) { + throw new Error( + 'Factory limit "maxAiCredits" must be a positive, finite number that rounds to a safe positive integer nano-AIU ceiling' + ); + } + } +} + +function validatePhases(meta: FactoryMeta): void { + const titles = new Set(); + for (const phase of meta.phases) { + if (phase.title.trim().length === 0) { + throw new Error("Factory phase titles must not be empty"); + } + if (titles.has(phase.title)) { + throw new Error(`Factory phase title "${phase.title}" is declared more than once`); + } + titles.add(phase.title); + } +} + +/** + * Defines an extension-authored factory and returns an opaque registration handle. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export function defineFactory< + TArgs extends JsonValue = JsonValue, + TResult extends JsonValue | void = JsonValue | void, +>(definition: FactoryDefinition): FactoryHandle { + // Snapshot before validating so post-registration mutation of the caller's + // object cannot slip past the authoring-boundary checks. + const meta = deepFreeze(structuredClone(definition.meta)); + validateLimits(meta); + validatePhases(meta); + + const stored: StoredFactory = { + meta, + run: definition.run, + }; + const handle = Object.freeze({ meta }) as unknown as FactoryHandle; + + factoryHandles.set(handle, stored); + return handle; +} + +/** @internal */ +export function getFactoryDefinition(handle: FactoryHandle): StoredFactory { + const definition = factoryHandles.get(handle); + if (!definition) { + throw new Error("Invalid factory handle"); + } + return definition; +} diff --git a/nodejs/src/ffiRuntimeHost.ts b/nodejs/src/ffiRuntimeHost.ts new file mode 100644 index 000000000..a92aa1589 --- /dev/null +++ b/nodejs/src/ffiRuntimeHost.ts @@ -0,0 +1,341 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * Hosts the Copilot runtime in-process by loading the native `runtime.node` cdylib + * and speaking JSON-RPC over its C ABI (FFI) instead of spawning a CLI child process + * and communicating over stdio/TCP. + * + * The native `host_start` export spawns the CLI worker itself + * (`node --embedded-host` for a `.js` entrypoint, or ` + * --embedded-host` for a packaged binary), so the SDK never launches the worker + * directly. LSP `Content-Length:`-framed JSON-RPC bytes are pumped across the ABI: + * writes go to `connection_write`; inbound frames arrive on a native callback that + * feeds {@link FfiRuntimeHost.receiveStream}. The existing `vscode-jsonrpc` + * `StreamMessageReader`/`StreamMessageWriter` handle framing unchanged — this is a + * transport swap, not a new protocol. + */ + +import { existsSync } from "node:fs"; +import koffi from "koffi"; +import { dirname, join, resolve } from "node:path"; +import { PassThrough, Writable } from "node:stream"; + +const SYMBOL_PREFIX = "copilot_runtime_"; + +// A long, referenced no-op timer keeps the Node event loop alive while the in-process +// connection is open (see start()); the exact interval is irrelevant. +const KEEP_ALIVE_INTERVAL_MS = 1 << 30; + +type KoffiFunction = ReturnType["func"]>; +type KoffiType = ReturnType; +type KoffiRegisteredCallback = ReturnType; + +interface FfiLibrary { + hostStart: KoffiFunction; + hostShutdown: KoffiFunction; + connectionOpen: KoffiFunction; + connectionWrite: KoffiFunction; + connectionClose: KoffiFunction; + outboundCallbackType: KoffiType; +} + +let loadedLibraryPath: string | undefined; +let loadedLibrary: FfiLibrary | undefined; + +/** + * Loads the cdylib once per process and binds the C ABI exports. Loading a + * different library path in the same process is unsupported. + */ +function loadLibrary(libraryPath: string): FfiLibrary { + if (loadedLibrary) { + if (loadedLibraryPath !== libraryPath) { + throw new Error( + `An in-process FFI runtime library is already loaded from '${loadedLibraryPath}'; ` + + `loading a different library from '${libraryPath}' in the same process is not supported.` + ); + } + return loadedLibrary; + } + + const lib = koffi.load(libraryPath); + const outboundCallbackType = koffi.pointer( + koffi.proto( + `void ${SYMBOL_PREFIX}outbound(void *userData, uint8 *bytesPtr, size_t bytesLen)` + ) + ); + + loadedLibrary = { + hostStart: lib.func(`${SYMBOL_PREFIX}host_start`, "uint32", [ + "uint8*", + "size_t", + "uint8*", + "size_t", + ]), + hostShutdown: lib.func(`${SYMBOL_PREFIX}host_shutdown`, "bool", ["uint32"]), + connectionOpen: lib.func(`${SYMBOL_PREFIX}connection_open`, "uint32", [ + "uint32", + outboundCallbackType, + "void*", + "uint8*", + "size_t", + "uint8*", + "size_t", + "uint8*", + "size_t", + ]), + connectionWrite: lib.func(`${SYMBOL_PREFIX}connection_write`, "bool", [ + "uint32", + "uint8*", + "size_t", + ]), + connectionClose: lib.func(`${SYMBOL_PREFIX}connection_close`, "bool", ["uint32"]), + outboundCallbackType, + }; + loadedLibraryPath = libraryPath; + return loadedLibrary; +} + +function buildArgvJson(cliEntrypoint: string, args: readonly string[]): Buffer { + // A `.js` entrypoint is launched via node; the packaged single-file CLI binary + // embeds its own Node and is invoked directly. `--no-auto-update` pins the worker + // to the bundled pkg matching the loaded cdylib, instead of drifting to a newer + // version installed under the user's `~/.copilot/pkg` (which would cause ABI skew). + const argv = cliEntrypoint.toLowerCase().endsWith(".js") + ? ["node", cliEntrypoint, "--embedded-host", "--no-auto-update"] + : [cliEntrypoint, "--embedded-host", "--no-auto-update"]; + argv.push(...args); + return Buffer.from(JSON.stringify(argv), "utf8"); +} + +function buildEnvJson(environment?: Record): Buffer | null { + if (!environment) { + return null; + } + const obj: Record = {}; + for (const [key, value] of Object.entries(environment)) { + if (value !== undefined) { + obj[key] = value; + } + } + if (Object.keys(obj).length === 0) { + return null; + } + return Buffer.from(JSON.stringify(obj), "utf8"); +} + +export class FfiRuntimeHost { + private readonly lib: FfiLibrary; + private serverId = 0; + private connectionId = 0; + private disposed = false; + private outboundCallback: KoffiRegisteredCallback | undefined; + private keepAliveTimer: ReturnType | undefined; + + /** The stream JSON-RPC reads server→client frames from. */ + readonly receiveStream: PassThrough; + /** The stream JSON-RPC writes client→server frames to. */ + readonly sendStream: Writable; + + private constructor( + private readonly libraryPath: string, + private readonly cliEntrypoint: string, + private readonly environment: Record | undefined, + private readonly args: readonly string[] + ) { + this.lib = loadLibrary(libraryPath); + this.receiveStream = new PassThrough(); + this.sendStream = new Writable({ + // connection_write enqueues the frame into the runtime's inbound channel and + // returns immediately, so a synchronous FFI call is sufficient here. + write: (chunk: Buffer, _encoding, callback) => { + try { + this.writeFrame(chunk); + callback(); + } catch (error) { + callback(error as Error); + } + }, + }); + } + + /** + * Resolves the cdylib next to the given CLI entrypoint and prepares the FFI host. + * The cdylib is resolved as `prebuilds//runtime.node` relative to + * the entrypoint directory (the napi-rs `-` layout, e.g. + * `linux-x64`). Throws if it cannot be found. + */ + static create( + cliEntrypoint: string, + prebuildsFolder: string, + environment: Record | undefined, + args: readonly string[] + ): FfiRuntimeHost { + const fullEntrypoint = resolve(cliEntrypoint); + const distDir = dirname(fullEntrypoint); + const libraryPath = join(distDir, "prebuilds", prebuildsFolder, "runtime.node"); + if (!existsSync(libraryPath)) { + throw new Error(`FFI runtime library not found. Looked for '${libraryPath}'.`); + } + return new FfiRuntimeHost(libraryPath, fullEntrypoint, environment, args); + } + + /** + * Starts the in-process runtime: spawns the CLI worker via the native host, + * waits for readiness, and opens the FFI JSON-RPC connection. + */ + async start(): Promise { + const argvJson = buildArgvJson(this.cliEntrypoint, this.args); + const envJson = buildEnvJson(this.environment); + + // The native host spawns the CLI worker itself and has no cwd parameter, so the + // worker inherits this process's cwd. A custom working directory is intentionally + // unsupported for the in-process transport (rejected by the client constructor) + // rather than mutating the shared process-global cwd here. + + // host_start blocks until the worker connects back and signals readiness + // (up to ~30s); run it as an async FFI call so the Node event loop isn't blocked. + this.serverId = await new Promise((resolvePromise, rejectPromise) => { + this.lib.hostStart.async( + argvJson, + argvJson.length, + envJson, + envJson ? envJson.length : 0, + (error: Error | null, result: number) => { + if (error) { + rejectPromise(error); + } else { + resolvePromise(result); + } + } + ); + }); + if (!this.serverId) { + throw new Error( + `copilot_runtime_host_start failed (library '${this.libraryPath}', entrypoint '${this.cliEntrypoint}').` + ); + } + + this.outboundCallback = koffi.register( + (_userData: unknown, bytesPtr: unknown, bytesLen: number | bigint) => + this.feedInbound(bytesPtr, bytesLen), + this.lib.outboundCallbackType + ); + + this.connectionId = this.lib.connectionOpen( + this.serverId, + this.outboundCallback, + null, + null, + 0, + null, + 0, + null, + 0 + ); + if (!this.connectionId) { + this.unregisterCallback(); + this.lib.hostShutdown(this.serverId); + this.serverId = 0; + throw new Error("copilot_runtime_connection_open failed."); + } + + // The in-process transport has no socket/pipe handle to keep the Node event loop + // alive while the SDK is idle awaiting a server→client frame. koffi delivers the + // outbound callback on the loop but does not reference it, so hold one referenced + // timer for the lifetime of the connection. + this.keepAliveTimer = setInterval(() => {}, KEEP_ALIVE_INTERVAL_MS); + } + + private writeFrame(frame: Buffer): void { + if (this.disposed || !this.connectionId) { + throw new Error("The in-process runtime connection is closed."); + } + const ok = this.lib.connectionWrite(this.connectionId, frame, frame.length); + if (!ok) { + throw new Error("Failed to write a frame to the in-process runtime connection."); + } + } + + /** + * Native outbound (server→client) callback. koffi delivers it on the JS event loop + * via a threadsafe function, so the frame is decoded and written straight to + * {@link receiveStream}. The native pointer is only valid for this call, so the + * bytes are copied out before returning. + */ + private feedInbound(bytesPtr: unknown, bytesLen: number | bigint): void { + // An exception thrown across the native→JS (Node-API) boundary cannot propagate + // and would surface only as a DEP0168 "uncaught Node-API callback exception" + // warning, so catch and log it here instead of letting it escape. + try { + // A native outbound callback can still be delivered on the event loop after + // dispose() has ended receiveStream; writing then would throw + // ERR_STREAM_WRITE_AFTER_END. Drop late frames instead — the connection is + // gone and nothing is reading them. + if (this.disposed || this.receiveStream.writableEnded) { + return; + } + const length = Number(bytesLen); + if (!bytesPtr || length <= 0) { + return; + } + const bytes = koffi.decode( + bytesPtr, + koffi.array("uint8", length, "Typed") + ) as Uint8Array; + this.receiveStream.write(Buffer.from(bytes)); + } catch (error) { + console.error( + `In-process FFI inbound callback failed: ${error instanceof Error ? (error.stack ?? error.message) : String(error)}` + ); + } + } + + private unregisterCallback(): void { + if (this.outboundCallback === undefined) { + return; + } + const callback = this.outboundCallback; + this.outboundCallback = undefined; + try { + koffi.unregister(callback); + } catch { + // Ignore teardown failures. + } + } + + /** Closes the FFI connection, shuts down the native host, and releases resources. */ + dispose(): void { + if (this.disposed) { + return; + } + this.disposed = true; + + if (this.keepAliveTimer !== undefined) { + clearInterval(this.keepAliveTimer); + this.keepAliveTimer = undefined; + } + + try { + if (this.connectionId) { + this.lib.connectionClose(this.connectionId); + this.connectionId = 0; + } + } catch { + // Ignore teardown failures. + } + + try { + if (this.serverId) { + this.lib.hostShutdown(this.serverId); + this.serverId = 0; + } + } catch { + // Ignore teardown failures. + } + + this.receiveStream.end(); + this.unregisterCallback(); + } +} diff --git a/nodejs/src/generated/rpc.ts b/nodejs/src/generated/rpc.ts index 602ee76a0..cefc8ef4d 100644 --- a/nodejs/src/generated/rpc.ts +++ b/nodejs/src/generated/rpc.ts @@ -5,8 +5,59 @@ import type { MessageConnection } from "vscode-jsonrpc/node.js"; -import type { AbortReason, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval } from "./session-events.js"; +import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, Verbosity } from "./session-events.js"; +/** A value that can be represented losslessly on the SDK JSON wire. */ +export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue }; + +/** + * A value that lives only in this process and never crosses the JSON-RPC + * boundary, such as a callback or a host object handle. + * @internal + */ +export type OpaqueInProcessValue = unknown; + +/** + * Initial authentication info for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AuthInfo". + */ +/** @experimental */ +export type AuthInfo = + | HMACAuthInfo + | EnvAuthInfo + | TokenAuthInfo + | CopilotApiTokenAuthInfo + | UserAuthInfo + | GhCliAuthInfo + | ApiKeyAuthInfo; +/** + * Resolved Anthropic adaptive-thinking capability for a model. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AdaptiveThinkingSupport". + */ +/** @experimental */ +export type AdaptiveThinkingSupport = + /** The model does not accept thinking.type='adaptive' */ + | "unsupported" + /** The model accepts adaptive thinking but also accepts thinking.type='enabled' */ + | "optional" + /** The model only accepts adaptive thinking and rejects thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8) */ + | "required"; +/** + * Which tier this directory belongs to + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentDiscoveryPathScope". + */ +/** @experimental */ +export type AgentDiscoveryPathScope = + /** The user's personal agent configuration directory. */ + | "user" + /** A project's repository agent directory. */ + | "project"; /** * Where the agent definition was loaded from * @@ -27,6 +78,27 @@ export type AgentInfoSource = | "plugin" /** Agent built into the Copilot runtime. */ | "builtin"; +/** + * Controls whether built-in agents and authored prompt text are included. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentListRequest". + */ +/** @experimental */ +export type AgentListRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. + */ + includeBuiltInAgents?: boolean; + /** + * When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. + */ + includePrompt?: boolean; + }; /** * Process kind tag for the registry entry * @@ -162,20 +234,19 @@ export type AgentRegistrySpawnValidationErrorField = /** The permissionMode parameter */ | "permissionMode"; /** - * The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. + * Current or requested allow-all mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AuthInfo". + * via the `definition` "PermissionsAllowAllMode". */ /** @experimental */ -export type AuthInfo = - | HMACAuthInfo - | EnvAuthInfo - | TokenAuthInfo - | CopilotApiTokenAuthInfo - | UserAuthInfo - | GhCliAuthInfo - | ApiKeyAuthInfo; +export type PermissionsAllowAllMode = + /** Permission requests follow the normal approval flow. */ + | "off" + /** Tool, path, and URL permission requests are automatically approved. */ + | "on" + /** Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. */ + | "auto"; /** * Authentication type * @@ -199,17 +270,21 @@ export type AuthInfoType = /** Authentication from a Copilot API token. */ | "copilot-api-token"; /** - * Runtime-controlled routing state for an open canvas instance. + * JSON Schema for canvas open input + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasJsonSchema". + */ +/** @experimental */ +export type CanvasJsonSchema = JsonValue; +/** + * Provider-supplied action result. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasInstanceAvailability". + * via the `definition` "CanvasActionInvokeResult". */ /** @experimental */ -export type CanvasInstanceAvailability = - /** The owning provider is currently connected and routing calls will be dispatched normally. */ - | "ready" - /** The owning provider is not currently connected. Routing calls fail with canvas_provider_unavailable until the agent re-issues open_canvas (which rehydrates via a fresh canvas.open) or the provider reconnects. */ - | "stale"; +export type CanvasActionInvokeResult = JsonValue; /** * Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command * @@ -232,6 +307,31 @@ export type SlashCommandKind = */ /** @experimental */ export type SlashCommandInputCompletion = /** Input should complete filesystem directories. */ "directory"; +/** + * Optional filters controlling which command sources to include in the listing. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsListRequest". + */ +/** @experimental */ +export type CommandsListRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * Include runtime built-in commands + */ + includeBuiltins?: boolean; + /** + * Include enabled user-invocable skills and commands + */ + includeSkills?: boolean; + /** + * Include commands registered by protocol clients, including SDK clients and extensions + */ + includeClientCommands?: boolean; + }; /** * Result of the queued command execution. * @@ -258,6 +358,7 @@ export type ConnectedRemoteSessionMetadataKind = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ContentFilterMode". */ +/** @experimental */ export type ContentFilterMode = /** Leave MCP tool result content unchanged. */ | "none" @@ -266,23 +367,119 @@ export type ContentFilterMode = /** Remove characters that can hide directives. */ | "hidden_characters"; /** - * Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. + * Source category for a collected debug bundle entry. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCurrentContextTier". + * via the `definition` "DebugCollectLogsSource". */ /** @experimental */ -export type ModelCurrentContextTier = - /** Use the model's default context window. */ - | "default" - /** Pin the session to the long-context tier when supported. */ - | "long_context"; +export type DebugCollectLogsSource = + /** Session event log. */ + | "events" + /** Process log for the session. */ + | "process-log" + /** Interactive shell log for the session. */ + | "shell-log" + /** Caller-provided diagnostic entry. */ + | "additional"; +/** + * Destination for the redacted debug bundle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsDestination". + */ +/** @experimental */ +export type DebugCollectLogsDestination = + | { + /** + * Absolute or server-relative path for the .tgz archive to create. + */ + outputPath: string; + /** + * When true, create the archive atomically without overwriting an existing file by appending ` (N)` before the extension as needed. Defaults to false. + */ + noOverwrite?: boolean; + kind: "archive"; + } + | { + /** + * Directory where redacted files should be staged. The directory is created if needed. + */ + outputDirectory: string; + kind: "directory"; + }; +/** + * Kind of caller-provided debug log entry. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsEntryKind". + */ +/** @experimental */ +export type DebugCollectLogsEntryKind = + /** Include a single server-local file. */ + | "file" + /** Include files from a server-local directory recursively. */ + | "directory"; +/** + * How a collected debug entry should be redacted before being staged. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsRedaction". + */ +/** @experimental */ +export type DebugCollectLogsRedaction = + /** Redact the file as plain UTF-8 log text. */ + | "plain-text" + /** Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. */ + | "events-jsonl"; +/** + * Destination kind that was written. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsResultKind". + */ +/** @experimental */ +export type DebugCollectLogsResultKind = + /** A .tgz archive was written. */ + | "archive" + /** A directory containing redacted files was written. */ + | "directory"; + +/** @experimental */ +export type DisableBypassPermissionsMode = "disable"; +/** + * Persisted extension discovery source + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensionSource". + */ +/** @experimental */ +export type DiscoveredExtensionSource = + /** Extension discovered from the user's extensions directory. */ + | "user" + /** Extension contributed by an installed plugin. */ + | "plugin"; +/** + * Effective extension loading and agent-management mode + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensionMode". + */ +/** @experimental */ +export type DiscoveredExtensionMode = + /** Extensions are not loaded. */ + | "disabled" + /** Extensions are loaded, but the agent cannot create, reload, or manage them. */ + | "load_only" + /** Extensions are loaded and the agent can create, reload, and manage them. */ + | "load_and_augment"; /** * Server transport type: stdio, http, sse (deprecated), or memory * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "DiscoveredMcpServerType". */ +/** @experimental */ export type DiscoveredMcpServerType = /** Server communicates over stdio with a local child process. */ | "stdio" @@ -313,7 +510,19 @@ export type EventsAgentScope = /** Return events from all agents. */ | "all"; /** - * Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. + * Direction to page through the session's persisted event history. 'forward' pages from the cursor toward newer events; 'backward' returns the newest window first (tail-first) and pages toward older events. Events within a returned batch are always chronological (oldest-to-newest), even for a backward read. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EventsReadDirection". + */ +/** @experimental */ +export type EventsReadDirection = + /** Page from the cursor toward newer events (default). */ + | "forward" + /** Tail-first: return the newest events and page toward older events. */ + | "backward"; +/** + * Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history (the beginning for a forward read, the tail for a backward read). The fallback page is a fresh boundary snapshot, not a continuation of the requested cursor, so it may overlap already-rendered events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate by event id) before continuing from the returned cursor. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "EventsCursorStatus". @@ -325,7 +534,7 @@ export type EventsCursorStatus = /** The cursor referred to history that is no longer available. */ | "expired"; /** - * Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) + * Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ExtensionSource". @@ -335,7 +544,11 @@ export type ExtensionSource = /** Extension discovered from the current project's .github/extensions directory. */ | "project" /** Extension discovered from the user's ~/.copilot/extensions directory. */ - | "user"; + | "user" + /** Extension contributed by an installed plugin. */ + | "plugin" + /** Extension discovered from the current session's state directory (loaded only for this session). */ + | "session"; /** * Current status: running, disabled, failed, or starting * @@ -382,6 +595,7 @@ export type ExternalToolTextResultForLlmBinaryResultsForLlmType = export type ExternalToolTextResultForLlmContent = | ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal + | ExternalToolTextResultForLlmContentShellExit | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink @@ -408,17 +622,311 @@ export type ExternalToolTextResultForLlmContentResourceLinkIconTheme = export type ExternalToolTextResultForLlmContentResourceDetails = | EmbeddedTextResourceContents | EmbeddedBlobResourceContents; +/** + * Execution-critical factory storage operation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryDurableOperation". + */ +/** @experimental */ +export type FactoryDurableOperation = + /** Creating the durable run and declared phases. */ + | "createRun" + /** Persisting the transition to running. */ + | "markRunStarted" + /** Persisting the terminal run envelope. */ + | "finishRun" + /** Persisting subagent admission accounting. */ + | "reserveAgent" + /** Rolling back an uncommitted subagent admission. */ + | "releaseAgent" + /** Persisting an idempotent model-usage charge. */ + | "chargeCredit" + /** Persisting active execution time. */ + | "addElapsed" + /** Reading the authoritative AI-credit total. */ + | "reconcileCreditTotal" + /** Reading a journal entry without treating storage failure as a cache miss. */ + | "journalGet" + /** Persisting a journal entry before reporting success. */ + | "journalPut"; +/** + * Current or terminal state of a factory run. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunStatus". + */ +/** @experimental */ +export type FactoryRunStatus = + /** The run was minted and is awaiting approval. */ + | "pending" + /** The run is executing. */ + | "running" + /** The run completed successfully. */ + | "completed" + /** The run was interrupted while resource budget remained. */ + | "halted" + /** The run was cancelled before completion. */ + | "cancelled" + /** The factory body failed or reached a cumulative resource ceiling. */ + | "error"; +/** + * Machine-readable factory run failure. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunFailure". + */ +/** @experimental */ +export type FactoryRunFailure = + | { + kind: FactoryRunFailureKind; + /** + * Approved effective ceiling that was reached. + */ + value: number; + /** + * Factory run identifier. + */ + runId: string; + type: "factory_limit_reached"; + } + | { + /** + * Factory run identifier whose changed limits were declined. + */ + runId: string; + /** + * Human-readable reason the resume did not proceed. + */ + reason: string; + type: "factory_resume_declined"; + } + | { + /** + * Stable failure code. + */ + code: string; + operation: FactoryDurableOperation; + /** + * Factory run identifier. + */ + runId: string; + type: "factory_durable_failure"; + } + | { + /** + * Factory run identifier. + */ + runId: string; + /** + * Confirmed usage in nano-AIU, representing the floor of what the run spent. + */ + drainedNanoAiu: number; + type: "factory_accounting_incomplete"; + }; +/** + * Cumulative resource ceiling that stopped a factory run. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunFailureKind". + */ +/** @experimental */ +export type FactoryRunFailureKind = + /** The run admitted the approved maximum total number of subagents. */ + | "maxTotalSubagents" + /** The run reached the approved accumulated active-execution time in seconds. */ + | "timeoutSeconds" + /** The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. */ + | "maxAiCredits"; +/** + * Kind of factory progress line. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryLogLineKind". + */ +/** @experimental */ +export type FactoryLogLineKind = + /** A narrator log line. */ + | "log" + /** A named factory phase marker. */ + | "phase"; +/** + * Derived lifecycle state of a factory phase. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryPhaseStatus". + */ +/** @experimental */ +export type FactoryPhaseStatus = + /** The phase has not been entered yet. */ + | "pending" + /** The phase is currently entered and accumulating active time. */ + | "active" + /** The phase was entered and has since been closed. */ + | "completed" + /** The phase was never entered because a later phase was entered or the run reached a terminal state. */ + | "skipped"; /** * Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "FilterMapping". */ +/** @experimental */ export type FilterMapping = | { [k: string]: ContentFilterMode; } | ContentFilterMode; +/** + * Optional compaction parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryCompactRequest". + */ +/** @experimental */ +export type HistoryCompactRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * Optional user-provided instructions to focus the compaction summary + */ + customInstructions?: string; + /** + * What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). + */ + trigger?: /** User-requested compaction, e.g. the /compact command or a direct history.compact call. */ + | "manual" + /** Compaction requested while switching to a model with a smaller context window. */ + | "model_switch"; + /** + * Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. + */ + tokenLimit?: number; + }; +/** + * Reason a captured file was not restored. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryFileRestoreSkipReason". + */ +/** @experimental */ +export type HistoryFileRestoreSkipReason = + /** The file changed after Copilot's last captured write. */ + | "user-modified" + /** A faithful preimage was not captured. */ + | "skipped-capture"; +/** + * Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindUnavailableReason". + */ +/** @experimental */ +export type HistoryRewindUnavailableReason = + /** The session did not opt into file-change tracking before its first turn. */ + | "file-change-tracking-disabled" + /** The session still has work that may mutate files or history. Transient: the same request succeeds once the session settles, so callers should retry rather than treat it as a failure. */ + | "session-busy" + /** Remote-backed rewind routing is not supported. */ + | "unsupported-remote-session"; +/** + * Aggregate file change represented by a rewind preview. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindChangeType". + */ +/** @experimental */ +export type HistoryRewindChangeType = + /** The discarded turns created the file. */ + | "created" + /** The discarded turns deleted the file. */ + | "deleted" + /** The discarded turns modified the file. */ + | "modified"; +/** + * Scope of a rewind operation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindMode". + */ +/** @experimental */ +export type HistoryRewindMode = + /** Discard conversation events while leaving files unchanged. */ + | "conversation" + /** Discard conversation events and restore captured files changed by those turns. */ + | "conversation-and-files"; +/** + * Outcome of a rewind request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindOutcome". + */ +/** @experimental */ +export type HistoryRewindOutcome = + /** The requested rewind completed; reachable in either mode. */ + | "success" + /** The session still has work that may mutate files or history; reachable in either mode. */ + | "session-busy" + /** A conversation-and-files rewind was requested for a session that did not enable capture; conversation-only rewinds never produce this. */ + | "file-change-tracking-disabled" + /** Remote-backed rewind routing is not supported; reachable in either mode. */ + | "unsupported-remote-session" + /** File restore failed and all applied file changes were rolled back; only conversation-and-files rewinds produce this. */ + | "files-rolled-back" + /** File restore failed and its rollback could not fully restore the pre-rewind state; only conversation-and-files rewinds produce this. */ + | "rollback-incomplete" + /** Conversation truncation failed. In conversation-and-files mode any files that were restored are left in place because conversation history cannot be un-truncated; in conversation-only mode no files are restored. Consult restoredFiles for what, if anything, was applied. */ + | "truncation-failed" + /** The conversation was rewound (and, in conversation-and-files mode, captured files were restored), but persisted checkpoints could not be cleaned up; reachable in either mode. */ + | "checkpoint-cleanup-failed" + /** Files and conversation were rewound, but obsolete file snapshots could not be removed; only conversation-and-files rewinds produce this. */ + | "snapshot-prune-failed"; +/** + * Hook event name dispatched through the SDK callback transport. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HookType". + */ +/** @experimental */ +/** @internal */ +export type HookType = + /** Runs before a tool is invoked. */ + | "preToolUse" + /** Runs before an MCP tool is invoked. */ + | "preMcpToolCall" + /** Runs after a tool completes successfully. */ + | "postToolUse" + /** Runs after a tool fails. */ + | "postToolUseFailure" + /** Runs after the user submits a prompt. */ + | "userPromptSubmitted" + /** Runs after the runtime transforms the submitted prompt for the model, before it is added to session history. */ + | "userPromptTransformed" + /** Runs when a session starts. */ + | "sessionStart" + /** Runs when a session ends. */ + | "sessionEnd" + /** Runs after an agent result is produced. */ + | "postResult" + /** Runs before a pull request description is generated. */ + | "prePRDescription" + /** Runs when the agent encounters an error. */ + | "errorOccurred" + /** Runs when the agent stops. */ + | "agentStop" + /** Runs when a subagent starts. */ + | "subagentStart" + /** Runs when a subagent stops. */ + | "subagentStop" + /** Runs before conversation context is compacted. */ + | "preCompact" + /** Runs when the agent requests permission. */ + | "permissionRequest" + /** Runs when the agent emits a notification. */ + | "notification"; /** * Source for direct repo installs (when marketplace is empty) * @@ -428,17 +936,45 @@ export type FilterMapping = /** @experimental */ export type InstalledPluginSource = | string - | InstalledPluginSourceGithub + | InstalledPluginSourceGitHub | InstalledPluginSourceUrl | InstalledPluginSourceLocal; +/** + * Which tier this target belongs to + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionDiscoveryPathLocation". + */ +/** @experimental */ +export type InstructionDiscoveryPathLocation = + /** Instructions live in user-level configuration. */ + | "user" + /** Instructions live in repository-level configuration. */ + | "repository" + /** Instructions live under the current working directory. */ + | "working-directory" + /** Instructions live in plugin-provided configuration. */ + | "plugin"; +/** + * Whether the target is a single file or a directory of instruction files + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionDiscoveryPathKind". + */ +/** @experimental */ +export type InstructionDiscoveryPathKind = + /** The target is a single instruction file. */ + | "file" + /** The target is a directory that holds instruction files. */ + | "directory"; /** * Category of instruction source — used for merge logic * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsSourcesType". + * via the `definition` "InstructionSourceType". */ /** @experimental */ -export type InstructionsSourcesType = +export type InstructionSourceType = /** Instructions loaded from the user's home configuration. */ | "home" /** Instructions loaded from repository-scoped files. */ @@ -457,10 +993,10 @@ export type InstructionsSourcesType = * Where this source lives — used for UI grouping * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsSourcesLocation". + * via the `definition` "InstructionSourceLocation". */ /** @experimental */ -export type InstructionsSourcesLocation = +export type InstructionSourceLocation = /** Instructions live in user-level configuration. */ | "user" /** Instructions live in repository-level configuration. */ @@ -469,6 +1005,30 @@ export type InstructionsSourcesLocation = | "working-directory" /** Instructions live in plugin-provided configuration. */ | "plugin"; +/** + * Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpRequestStartTransport". + */ +/** @experimental */ +export type LlmInferenceHttpRequestStartTransport = + /** Plain HTTP or SSE response. Each body chunk is an opaque byte range; the response is a status line, headers, and a (possibly streamed) body. */ + | "http" + /** Full-duplex WebSocket channel. Each body chunk maps to exactly one WebSocket message and the `binary` flag distinguishes text from binary frames; request and response chunks flow concurrently. */ + | "websocket"; +/** + * Repository host type + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionContextHostType". + */ +/** @experimental */ +export type SessionContextHostType = + /** Session repository is hosted on GitHub. */ + | "github" + /** Session repository is hosted on Azure DevOps. */ + | "ado"; /** * Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". * @@ -597,6 +1157,7 @@ export type McpAppsSetHostContextDetailsPlatform = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "McpServerConfig". */ +/** @experimental */ export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp; /** * Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. @@ -604,13 +1165,27 @@ export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp; * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "McpServerAuthConfig". */ +/** @experimental */ export type McpServerAuthConfig = boolean | McpServerAuthConfigRedirectPort; +/** + * Controls if tools provided by this server can be loaded on demand via tool search (auto) or always included in the initial tool list (never) + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigDeferTools". + */ +/** @experimental */ +export type McpServerConfigDeferTools = + /** Tools may be deferred under certain conditions */ + | "auto" + /** Tools are always included in the initial tool list, even when tool search is enabled. */ + | "never"; /** * Remote transport type. Defaults to "http" when omitted. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "McpServerConfigHttpType". */ +/** @experimental */ export type McpServerConfigHttpType = /** Streamable HTTP transport. */ | "http" @@ -622,11 +1197,82 @@ export type McpServerConfigHttpType = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "McpServerConfigHttpOauthGrantType". */ +/** @experimental */ export type McpServerConfigHttpOauthGrantType = /** Interactive browser-based authorization code flow with PKCE. */ | "authorization_code" /** Headless client credentials flow using the configured OAuth client. */ | "client_credentials"; +/** + * Host response: supply dynamic headers or decline this refresh. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpHeadersHandlePendingHeadersRefreshRequest". + */ +/** @experimental */ +export type McpHeadersHandlePendingHeadersRefreshRequest = + | { + /** + * Headers to overlay onto the MCP request. Dynamic headers override static config headers but do not replace SDK-managed request headers. + */ + headers: { + [k: string]: string | undefined; + }; + kind: "headers"; + } + | { + kind: "none"; + }; +/** + * Consumer allowed to call an MCP tool. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpToolUiVisibility". + */ +/** @experimental */ +export type McpToolUiVisibility = + /** The model may call the tool. */ + | "model" + /** An MCP App view may call the tool. */ + | "app"; +/** + * Host response to the pending OAuth request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthPendingRequestResponse". + */ +/** @experimental */ +export type McpOauthPendingRequestResponse = + | { + /** + * Access token acquired by the SDK host + */ + accessToken: string; + /** + * OAuth token type. Defaults to Bearer when omitted. + */ + tokenType?: string; + /** + * Token lifetime in seconds, if known. + */ + expiresIn?: number; + kind: "token"; + } + | { + kind: "cancelled"; + }; +/** + * OAuth grant type override for this login. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthLoginGrantType". + */ +/** @experimental */ +export type McpOauthLoginGrantType = + /** Interactive browser-based OAuth flow using an authorization code, typically with PKCE. */ + | "authorization_code" + /** Headless OAuth flow where a confidential client authenticates directly with a client secret. */ + | "client_credentials"; /** * Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. * @@ -653,6 +1299,116 @@ export type McpSetEnvValueModeDetails = | "direct" /** Treat MCP server environment values as host-side references to resolve before launch. */ | "indirect"; +/** + * Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionContextAttribution". + */ +/** @experimental */ +export type SessionContextAttribution = { + /** + * Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. + */ + totalTokens: number; + /** + * The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. + */ + modelId: string; + /** + * How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). + */ + modelSource: string; + /** + * Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + */ + promptTokenLimit: number; + /** + * Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. + */ + limit: number; + /** + * Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. + */ + bufferTokens: number; + /** + * Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. + */ + compactionThreshold: number; + /** + * The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. + */ + categories: { + /** + * System prompt tokens, excluding custom instructions. + */ + systemPrompt: number; + /** + * Custom-instructions tokens (0 when none are configured). + */ + customInstructions: number; + /** + * Non-MCP tool-definition tokens. + */ + systemTools: number; + /** + * MCP tool-definition tokens. + */ + mcpTools: number; + /** + * Conversation (user/assistant/tool) message tokens. + */ + messages: number; + /** + * Remaining unused window capacity (clamped at 0). + */ + freeSpace: number; + /** + * Output reserve plus post-blocking-threshold buffer. + */ + buffer: number; + }; + /** + * Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. + */ + entries: { + /** + * Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + */ + kind: string; + /** + * Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. + */ + id: string; + /** + * Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. + */ + label: string; + /** + * Token count currently in context attributable to this entry. + */ + tokens: number; + /** + * Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. + */ + parentId?: string; + /** + * Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + */ + attributes?: { + [k: string]: string | undefined; + }; + }[]; + /** + * Successful compaction history for the session. + */ + compactions: { + /** + * Number of successful compactions in this session. + */ + count: number; + }; +} | null; /** * Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). * @@ -694,7 +1450,7 @@ export type SessionContextInfo = { */ compactionThreshold: number; /** - * Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. + * Prompt token limit plus the model's full output token limit. */ limit: number; /** @@ -746,6 +1502,7 @@ export type MetadataSnapshotRemoteMetadataTaskType = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ModelPolicyState". */ +/** @experimental */ export type ModelPolicyState = /** The model is enabled by policy. */ | "enabled" @@ -759,6 +1516,7 @@ export type ModelPolicyState = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ModelPickerCategory". */ +/** @experimental */ export type ModelPickerCategory = /** Lightweight model category optimized for faster, lower-cost interactions. */ | "lightweight" @@ -772,6 +1530,7 @@ export type ModelPickerCategory = * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ModelPickerPriceCategory". */ +/** @experimental */ export type ModelPickerPriceCategory = /** Lowest relative token cost tier. */ | "low" @@ -781,6 +1540,85 @@ export type ModelPickerPriceCategory = | "high" /** Highest relative token cost tier. */ | "very_high"; +/** + * Optional listing options. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ModelListRequest". + */ +/** @experimental */ +export type ModelListRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * If true, bypasses the per-session model list cache and re-fetches from CAPI. + */ + skipCache?: boolean; + }; +/** + * Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProviderConfigType". + */ +/** @experimental */ +export type ProviderConfigType = + /** Generic OpenAI-compatible API. */ + | "openai" + /** Azure OpenAI Service endpoint. */ + | "azure" + /** Anthropic API endpoint. */ + | "anthropic"; +/** + * Wire API format (openai/azure only). Defaults to "completions". + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProviderConfigWireApi". + */ +/** @experimental */ +export type ProviderConfigWireApi = + /** OpenAI Chat Completions wire format. */ + | "completions" + /** OpenAI Responses API wire format. */ + | "responses"; +/** + * Provider transport. Defaults to "http". + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProviderConfigTransport". + */ +/** @experimental */ +export type ProviderConfigTransport = + /** HTTP request/streaming transport. */ + | "http" + /** WebSocket transport. */ + | "websockets"; +/** + * Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyScope". + */ +/** @experimental */ +export type OptionsUpdateAdditionalContentExclusionPolicyScope = + /** The content exclusion policy applies to the current repository. */ + | "repo" + /** The content exclusion policy applies across all repositories. */ + | "all"; +/** + * Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "OptionsUpdateContextTier". + */ +/** @experimental */ +export type OptionsUpdateContextTier = + /** Use the model's default context tier and its standard token limits / pricing. */ + | "default" + /** Use the model's long-context tier (when available) so larger inputs are accepted and tier-specific pricing applies. */ + | "long_context"; /** * How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). * @@ -793,6 +1631,20 @@ export type OptionsUpdateEnvValueMode = | "direct" /** Resolve MCP server environment values from host-side references. */ | "indirect"; +/** + * Reasoning summary mode for supported model clients. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "OptionsUpdateReasoningSummary". + */ +/** @experimental */ +export type OptionsUpdateReasoningSummary = + /** Do not request reasoning summaries from the model. */ + | "none" + /** Request a concise summary of model reasoning. */ + | "concise" + /** Request a detailed summary of model reasoning. */ + | "detailed"; /** * Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. * @@ -844,6 +1696,7 @@ export type PermissionDecisionApproveForSessionApproval = | PermissionDecisionApproveForSessionApprovalMemory | PermissionDecisionApproveForSessionApprovalCustomTool | PermissionDecisionApproveForSessionApprovalExtensionManagement + | PermissionDecisionApproveForSessionApprovalFactory | PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess; /** * Approval to persist for this location @@ -861,7 +1714,54 @@ export type PermissionDecisionApproveForLocationApproval = | PermissionDecisionApproveForLocationApprovalMemory | PermissionDecisionApproveForLocationApprovalCustomTool | PermissionDecisionApproveForLocationApprovalExtensionManagement + | PermissionDecisionApproveForLocationApprovalFactory | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess; +/** + * Disposition of a permission request as observed by the responding client. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionOutcome". + */ +/** @experimental */ +export type PermissionDecisionOutcome = + /** The request was approved automatically without a new human decision. */ + | "auto_approved" + /** The request was denied without an interactive user decision; source records why. */ + | "autopilot_denied" + /** The response came from an interactive user prompt. */ + | "prompted_user"; +/** + * Controlled reason or actor responsible for a permission response. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionSource". + */ +/** @experimental */ +export type PermissionDecisionSource = + /** The response followed the auto-approval judge recommendation. */ + | "judge_recommendation" + /** A human supplied the response through an interactive prompt. */ + | "human_response" + /** The host applied a standing policy or override rather than a judge recommendation or human decision. */ + | "host_policy" + /** The host denied the request because no interactive user response was available. */ + | "unattended_fallback"; +/** + * Client surface that submitted a permission response. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionSurface". + */ +/** @experimental */ +export type PermissionDecisionSurface = + /** The interactive Copilot CLI terminal UI. */ + | "tui" + /** The non-interactive Copilot CLI prompt mode. */ + | "prompt_mode" + /** The Copilot App client. */ + | "copilot_app" + /** A generic Copilot SDK client. */ + | "sdk"; /** * Tool approval to persist and apply * @@ -878,6 +1778,7 @@ export type PermissionsLocationsAddToolApprovalDetails = | PermissionsLocationsAddToolApprovalDetailsMemory | PermissionsLocationsAddToolApprovalDetailsCustomTool | PermissionsLocationsAddToolApprovalDetailsExtensionManagement + | PermissionsLocationsAddToolApprovalDetailsFactory | PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess; /** * Whether the location is a git repo or directory @@ -948,74 +1849,146 @@ export type PermissionsSetApproveAllSource = /** Allow-all was enabled through an RPC caller. */ | "rpc"; /** - * Whether this item is a queued user message or a queued slash command / model change + * Optional flags controlling which side effects the reload performs. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuePendingItemsKind". + * via the `definition` "PluginsReloadRequest". */ /** @experimental */ -export type QueuePendingItemsKind = - /** A queued user message. */ - | "message" - /** A queued slash command or model-change command. */ - | "command"; +export type PluginsReloadRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * Reload MCP server connections after refreshing plugins. Defaults to true. + */ + reloadMcp?: boolean; + /** + * Re-run custom-agent discovery after refreshing plugins. Defaults to true. + */ + reloadCustomAgents?: boolean; + /** + * Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). + */ + reloadHooks?: boolean; + /** + * Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). + */ + reloadExtensions?: boolean; + /** + * When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + */ + deferRepoHooks?: boolean; + }; /** - * Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. + * Provider family. Matches the `type` field of a BYOK provider config. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteSessionMode". + * via the `definition` "ProviderEndpointType". */ /** @experimental */ -export type RemoteSessionMode = - /** Disable remote session export and steering. */ - | "off" - /** Export session events to GitHub without enabling remote steering. */ - | "export" - /** Enable both remote session export and remote steering. */ - | "on"; +export type ProviderEndpointType = + /** OpenAI-compatible endpoint (use the OpenAI client library). */ + | "openai" + /** Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). */ + | "azure" + /** Anthropic endpoint (use the Anthropic client library). */ + | "anthropic"; /** - * The UI mode the agent was in when this message was sent. Defaults to the session's current mode. + * Wire API to be used, when required for the provider type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAgentMode". + * via the `definition` "ProviderEndpointWireApi". */ /** @experimental */ -export type SendAgentMode = - /** The agent is responding interactively to the user. */ - | "interactive" - /** The agent is preparing a plan before making changes. */ - | "plan" - /** The agent is working autonomously toward task completion. */ - | "autopilot" - /** The agent is in shell-focused UI mode. */ - | "shell"; +export type ProviderEndpointWireApi = + /** Classic chat-completions request shape. */ + | "completions" + /** Newer responses request shape. */ + | "responses"; +/** + * Transport to be used for provider requests. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProviderEndpointTransport". + */ +/** @experimental */ +export type ProviderEndpointTransport = + /** HTTP request/streaming transport. */ + | "http" + /** WebSocket transport. */ + | "websockets"; +/** + * Optional model identifier to scope the endpoint snapshot to. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ProviderGetEndpointRequest". + */ +/** @experimental */ +export type ProviderGetEndpointRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. + */ + modelId?: string; + }; /** - * A user message attachment — a file, directory, code selection, blob, or GitHub reference + * Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachment". + * via the `definition` "PushAttachment". */ /** @experimental */ -export type SendAttachment = - | SendAttachmentFile - | SendAttachmentDirectory - | SendAttachmentSelection - | SendAttachmentGithubReference - | SendAttachmentBlob; +export type PushAttachment = + | PushAttachmentFile + | PushAttachmentDirectory + | PushAttachmentSelection + | PushAttachmentGitHubReference + | PushAttachmentGitHubCommit + | PushAttachmentGitHubRelease + | PushAttachmentGitHubActionsJob + | PushAttachmentGitHubRepository + | PushAttachmentGitHubFileDiff + | PushAttachmentGitHubTreeComparison + | PushAttachmentGitHubUrl + | PushAttachmentGitHubFile + | PushAttachmentGitHubSnippet + | PushAttachmentBlob + | ExtensionContextPushInput; /** * Type of GitHub reference * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentGithubReferenceType". + * via the `definition` "PushAttachmentGitHubReferenceType". */ /** @experimental */ -export type SendAttachmentGithubReferenceType = +export type PushAttachmentGitHubReferenceType = /** GitHub issue reference. */ | "issue" /** GitHub pull request reference. */ | "pr" /** GitHub discussion reference. */ | "discussion"; +/** + * The UI mode the agent was in when this message was sent. Defaults to the session's current mode. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SendAgentMode". + */ +/** @experimental */ +export type SendAgentMode = + /** The agent is responding interactively to the user. */ + | "interactive" + /** The agent is preparing a plan before making changes. */ + | "plan" + /** The agent is working autonomously toward task completion. */ + | "autopilot" + /** The agent is in shell-focused UI mode. */ + | "shell"; /** * How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. * @@ -1029,47 +2002,116 @@ export type SendMode = /** Interject the message during the in-progress turn. */ | "immediate"; /** - * Repository host type + * Whether this item is a queued user message or a queued slash command / model change * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionContextHostType". + * via the `definition` "QueuePendingItemsKind". */ /** @experimental */ -export type SessionContextHostType = - /** Session repository is hosted on GitHub. */ - | "github" - /** Session repository is hosted on Azure DevOps. */ - | "ado"; +export type QueuePendingItemsKind = + /** A queued user message. */ + | "message" + /** A queued slash command or model-change command. */ + | "command"; /** - * Error classification + * State of the runtime-managed remote-control singleton. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsErrorCode". + * via the `definition` "RemoteControlStatus". */ /** @experimental */ -export type SessionFsErrorCode = - /** The requested path does not exist. */ - | "ENOENT" - /** The filesystem operation failed for an unspecified reason. */ - | "UNKNOWN"; +export type RemoteControlStatus = + | RemoteControlStatusOff + | RemoteControlStatusConnecting + | RemoteControlStatusActive + | RemoteControlStatusError; /** - * Entry type + * Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirWithTypesEntryType". + * via the `definition` "RemoteSessionMode". */ /** @experimental */ -export type SessionFsReaddirWithTypesEntryType = - /** The entry is a file. */ - | "file" - /** The entry is a directory. */ - | "directory"; +export type RemoteSessionMode = + /** Disable remote session export and steering. */ + | "off" + /** Export session events to GitHub without enabling remote steering. */ + | "export" + /** Enable both remote session export and remote steering. */ + | "on"; +/** + * Whether the remote task originated from CCA or CLI `--remote`. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "RemoteSessionMetadataTaskType". + */ +/** @experimental */ +export type RemoteSessionMetadataTaskType = + /** GitHub Copilot coding agent task. */ + | "cca" + /** CLI remote task. */ + | "cli"; +/** + * Session capability enabled for this session + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionCapability". + */ +/** @experimental */ +export type SessionCapability = + /** TUI-specific prompt hints such as keyboard shortcuts. */ + | "tui-hints" + /** Plan-mode handling and instructions. */ + | "plan-mode" + /** Memory tool and memories prompt section. */ + | "memory" + /** Copilot CLI documentation tool and prompt section. */ + | "cli-documentation" + /** Interactive ask_user tool support. */ + | "ask-user" + /** Interactive CLI identity and behavior. */ + | "interactive-mode" + /** Automatic hidden system notifications. */ + | "system-notifications" + /** SDK elicitation support. */ + | "elicitation" + /** Cross-session history tools and session-store SQL prompt/tool metadata. */ + | "session-store" + /** MCP Apps UI passthrough. */ + | "mcp-apps" + /** Host-provided canvas rendering support. */ + | "canvas-renderer"; +/** + * Error classification + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsErrorCode". + */ +/** @experimental */ +export type SessionFsErrorCode = + /** The requested path does not exist. */ + | "ENOENT" + /** The filesystem operation failed for an unspecified reason. */ + | "UNKNOWN"; +/** + * Entry type + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsReaddirWithTypesEntryType". + */ +/** @experimental */ +export type SessionFsReaddirWithTypesEntryType = + /** The entry is a file. */ + | "file" + /** The entry is a directory. */ + | "directory"; /** * Path conventions used by this filesystem * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SessionFsSetProviderConventions". */ +/** @experimental */ export type SessionFsSetProviderConventions = /** Paths use Windows path conventions. */ | "windows" @@ -1089,6 +2131,20 @@ export type SessionFsSqliteQueryType = | "query" /** Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. */ | "run"; +/** + * SQLite transaction failure classification. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionFsSqliteTransactionErrorClass". + */ +/** @experimental */ +export type SessionFsSqliteTransactionErrorClass = + /** SQLite reported BUSY or LOCKED before commit; the transaction was rolled back and may be retried. */ + | "busyOrLocked" + /** The statement, database, or provider failed definitively and must not be retried automatically. */ + | "fatal" + /** The transport failed after the provider may have committed; retrying could duplicate effects. */ + | "postCommitAmbiguous"; /** * Source descriptor for direct repo installs (when marketplace is empty) * @@ -1098,9 +2154,105 @@ export type SessionFsSqliteQueryType = /** @experimental */ export type SessionInstalledPluginSource = | string - | SessionInstalledPluginSourceGithub + | SessionInstalledPluginSourceGitHub | SessionInstalledPluginSourceUrl | SessionInstalledPluginSourceLocal; +/** + * Client population used for the prediction baseline. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionClientType". + */ +/** @experimental */ +export type SessionLimitPredictionClientType = + /** Interactive CLI sessions where a user can accept, edit, or top up the limit. */ + | "cli-interactive" + /** Prompt/non-interactive CLI sessions where the initial limit must cover more of the run. */ + | "cli-prompt"; +/** + * Baseline fallback level used to create the prediction. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionSource". + */ +/** @experimental */ +export type SessionLimitPredictionSource = + /** The prediction used the exact resolved model's baseline cell. */ + | "model" + /** The exact model was unavailable, so the prediction used the model family's baseline cell. */ + | "family" + /** No model or family cell was available, so the prediction used the global client-type baseline cell. */ + | "global"; +/** + * Semantic usage tier used for a recommended cap or additional headroom. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionTier". + */ +/** @experimental */ +export type SessionLimitPredictionTier = + /** Recommended starting tier. */ + | "recommended" + /** Additional headroom for longer-running sessions. */ + | "additional_headroom" + /** Generous headroom for unusually high usage. */ + | "generous_headroom" + /** Maximum available headroom tier. */ + | "maximum_headroom"; +/** + * Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionRequest". + */ +/** @experimental */ +export type SessionLimitPredictionRequest = + | { + [k: string]: unknown | undefined; + } + | { + /** + * Optional model identifier override. If omitted, the session's current model is used. + */ + modelId?: string; + clientType?: SessionLimitPredictionClientType; + }; +/** + * Prediction result. Available results include prediction details; unavailable results include an explicit reason. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionResult". + */ +/** @experimental */ +export type SessionLimitPredictionResult = + | { + prediction: SessionLimitPredictionDetails; + kind: "available"; + } + | { + reason: SessionLimitPredictionUnavailableReason; + kind: "unavailable"; + }; +/** + * Reason a prediction could not be computed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionUnavailableReason". + */ +/** @experimental */ +export type SessionLimitPredictionUnavailableReason = + /** The current model is auto and has not resolved to a concrete model yet. */ + | "auto_unresolved" + /** No model was provided and the session does not currently have a selected model. */ + | "no_model"; +/** + * Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionListEntry". + */ +/** @experimental */ +export type SessionListEntry = LocalSessionMetadataValue | RemoteSessionMetadataValue; /** * Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). * @@ -1134,6 +2286,10 @@ export type WorkspaceSummary = { * Display name for the session, if set */ name?: string; + /** + * Whether the display name was explicitly set by the user + */ + user_named?: boolean; /** * ISO 8601 timestamp when the workspace was created */ @@ -1155,6 +2311,217 @@ export type WorkspaceSummaryHostType = | "github" /** Workspace summary repository is hosted on Azure DevOps. */ | "ado"; +/** + * Initial reasoning summary mode for supported model clients. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionOpenOptionsReasoningSummary". + */ +/** @experimental */ +export type SessionOpenOptionsReasoningSummary = + /** Do not request reasoning summaries from the model. */ + | "none" + /** Request a concise summary of model reasoning. */ + | "concise" + /** Request a detailed summary of model reasoning. */ + | "detailed"; +/** + * Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellInitProfile". + */ +/** @experimental */ +export type ShellInitProfile = + /** Disable automatic non-interactive profile loading. Explicit initScripts still run. */ + | "none" + /** Allow automatic non-interactive profile loading when supported. Explicit initScripts still run. */ + | "non-interactive"; +/** + * Supported built-in shells for initialization scripts. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellInitScriptShell". + */ +/** @experimental */ +export type ShellInitScriptShell = + /** Source the script in the built-in Bash shell on macOS and Linux. */ + | "bash" + /** Source the script in the built-in PowerShell shell on Windows. */ + | "powershell"; +/** + * How MCP server environment values are interpreted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionOpenOptionsEnvValueMode". + */ +/** @experimental */ +export type SessionOpenOptionsEnvValueMode = + /** Pass MCP server environment values as literal strings. */ + | "direct" + /** Resolve MCP server environment values from host-side references. */ + | "indirect"; +/** + * Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicyScope". + */ +/** @experimental */ +export type SessionOpenOptionsAdditionalContentExclusionPolicyScope = + /** The content exclusion policy applies to the current repository. */ + | "repo" + /** The content exclusion policy applies across all repositories. */ + | "all"; +/** + * Open a session by creating, resuming, attaching, connecting to a remote, or handing off. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionOpenParams". + */ +/** @experimental */ +export type SessionOpenParams = + | SessionsOpenCreate + | SessionsOpenResume + | SessionsOpenResumeLast + | SessionsOpenAttach + | SessionsOpenRemote + | SessionsOpenCloud + | SessionsOpenHandoff; +/** + * Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsOpenHandoffTaskType". + */ +/** @experimental */ +export type SessionsOpenHandoffTaskType = + /** GitHub Copilot coding agent task. */ + | "cca" + /** CLI remote task. */ + | "cli"; +/** + * Outcome of the open request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsOpenStatus". + */ +/** @experimental */ +export type SessionsOpenStatus = + /** A new session was created. */ + | "created" + /** An existing session was loaded or reattached. */ + | "resumed" + /** No matching persisted session was found. */ + | "not_found" + /** Connected to an existing remote session. */ + | "connected" + /** Remote session was handed off to a new local session. */ + | "handed_off"; +/** + * Handoff step. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsOpenProgressStep". + */ +/** @experimental */ +export type SessionsOpenProgressStep = + /** Loading the source session's events from the remote service. */ + | "load-session" + /** Validating that the local repository matches the remote session's repository. */ + | "validate-repo" + /** Checking the local working tree for uncommitted changes that would block the handoff. */ + | "check-changes" + /** Checking out the branch associated with the remote session in the local working tree. */ + | "checkout-branch" + /** Creating the new local session and seeding it with the source session's events. */ + | "create-session" + /** Persisting the newly-created local session to disk. */ + | "save-session"; +/** + * Step status. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsOpenProgressStatus". + */ +/** @experimental */ +export type SessionsOpenProgressStatus = + /** The step has started and has not yet finished. */ + | "in-progress" + /** The step has completed successfully. */ + | "complete"; +/** + * Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsPredicateName". + */ +/** @experimental */ +export type SessionSettingsPredicateName = + /** Whether the security-tools feature flag enables security tool wiring. */ + | "securityToolsEnabled" + /** Whether third-party security tools should receive the security prompt. */ + | "thirdPartySecurityPromptEnabled" + /** Whether validation may run in parallel. */ + | "parallelValidationEnabled" + /** Whether runtime timing telemetry is enabled. */ + | "runtimeTimingTelemetryEnabled" + /** Whether the co-author hook is enabled. */ + | "coAuthorHookEnabled" + /** Whether Chronicle integration is enabled. */ + | "chronicleEnabled" + /** Whether content-exclusion policy may self-fetch data. */ + | "contentExclusionSelfFetchEnabled" + /** Whether Claude Opus token-limit caps should be applied. */ + | "capClaudeOpusTokenLimitsEnabled" + /** Whether code-review behavior is enabled. */ + | "codeReviewFeatureEnabled" + /** Whether CCA should use the TypeScript autofind behavior. */ + | "ccaUseTsAutofindEnabled" + /** Whether the dependency checker is enabled. */ + | "dependencyCheckerEnabled" + /** Whether the Dependabot checker is enabled. */ + | "dependabotCheckerEnabled" + /** Whether the CodeQL checker is enabled. */ + | "codeqlCheckerEnabled" + /** Whether trivial-change handling is enabled. */ + | "trivialChangeEnabled" + /** Whether trivial-change skip behavior is enabled. */ + | "trivialChangeSkipEnabled" + /** Whether trivial-change handling is enabled for code review. */ + | "trivialChangeEnabledForCodeReview" + /** Whether trivial-change skip behavior is enabled for code review. */ + | "trivialChangeSkipEnabledForCodeReview" + /** Whether trivial-change handling is enabled for a specific tool. */ + | "trivialChangeEnabledForTool" + /** Whether trivial-change skip behavior is enabled for a specific tool. */ + | "trivialChangeSkipEnabledForTool"; +/** + * Which session sources to include. Defaults to `local` for backward compatibility. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSource". + */ +/** @experimental */ +export type SessionSource = + /** Return only local sessions. */ + | "local" + /** Return only remote sessions. */ + | "remote" + /** Return both local and remote sessions. */ + | "all"; +/** + * Sharing status for a synced session. "repo" makes the session visible to anyone with read access to the repository; "unshared" restricts it to the creator and collaborators. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionVisibilityStatus". + */ +/** @experimental */ +export type SessionVisibilityStatus = + /** The session is visible to repository readers. */ + | "repo" + /** The session is restricted to its creator and collaborators. */ + | "unshared"; /** * Signal to send (default: SIGTERM) * @@ -1170,7 +2537,23 @@ export type ShellKillSignal = /** Send an interrupt signal to the process. */ | "SIGINT"; /** - * Result of invoking the slash command (text output, prompt to send to the agent, or completion). + * Which tier this directory belongs to + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SkillDiscoveryScope". + */ +/** @experimental */ +export type SkillDiscoveryScope = + /** A project's repository skill directory. */ + | "project" + /** The user's personal Copilot skill directory. */ + | "personal-copilot" + /** The user's personal agents skill directory. */ + | "personal-agents" + /** A configured custom skill directory. */ + | "custom"; +/** + * Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandInvocationResult". @@ -1181,6 +2564,47 @@ export type SlashCommandInvocationResult = | SlashCommandAgentPromptResult | SlashCommandCompletedResult | SlashCommandSelectSubcommandResult; +/** + * Subagent settings to apply, or null to clear the live session override + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SubagentSettings". + */ +/** @experimental */ +export type SubagentSettings = { + /** + * Per-agent settings keyed by subagent agent_type + */ + agents?: { + [k: string]: SubagentSettingsEntry | undefined; + }; + /** + * Names of subagents the user has turned off; they cannot be dispatched + */ + disabledSubagents?: string[]; + /** + * Maximum number of subagents that can run concurrently; applies to usage-based billing users only + */ + maxConcurrency?: number; + /** + * Maximum subagent nesting depth; applies to usage-based billing users only + */ + maxDepth?: number; +} | null; +/** + * Context tier override for matching subagents + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SubagentSettingsEntryContextTier". + */ +/** @experimental */ +export type SubagentSettingsEntryContextTier = + /** Inherit the parent session's effective context tier at dispatch time. */ + | "inherit" + /** Use the model's default context window. */ + | "default" + /** Pin the subagent to the long-context tier when supported. */ + | "long_context"; /** * Current lifecycle status of the task * @@ -1212,7 +2636,7 @@ export type TaskExecutionMode = /** The task is managed in the background. */ | "background"; /** - * Schema for the `TaskInfo` type. + * Tracked task union returned by task APIs, containing either an agent task or a shell task. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskInfo". @@ -1254,7 +2678,7 @@ export type UIAutoModeSwitchResponse = /** Decline the automatic mode switch. */ | "no"; /** - * Schema for the `UIElicitationFieldValue` type. + * Submitted UI elicitation field value: string, number, boolean, or an array of strings. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIElicitationFieldValue". @@ -1337,6 +2761,22 @@ export type UIExitPlanModeAction = | "autopilot" /** Exit plan mode and continue in autopilot mode with parallel subagent execution. */ | "autopilot_fleet"; +/** + * User action selected for an exhausted session limit. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UISessionLimitsExhaustedResponseAction". + */ +/** @experimental */ +export type UISessionLimitsExhaustedResponseAction = + /** Increase the current max by an exact AI Credits amount. */ + | "add" + /** Set a new absolute max AI Credits value. */ + | "set" + /** Remove the current session limit. */ + | "unset" + /** Leave the limit unchanged and cancel the blocked model request. */ + | "cancel"; /** * Type of change represented by this file diff. * @@ -1364,7 +2804,9 @@ export type WorkspaceDiffMode = /** Return staged, unstaged, and untracked working tree changes. */ | "unstaged" /** Return changes compared with the default branch. */ - | "branch"; + | "branch" + /** Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). */ + | "session"; /** * Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. * @@ -1377,6 +2819,22 @@ export type WorkspacesWorkspaceDetailsHostType = | "github" /** Workspace repository is hosted on Azure DevOps. */ | "ado"; +/** + * List of all authenticated users + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountGetAllUsersResult". + */ +/** @experimental */ +export type AccountGetAllUsersResult = AccountAllUsers[]; +/** + * The number of running background agents (task-registry agents) that were cancelled. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionCancelAllBackgroundAgentsResult". + */ +/** @experimental */ +export type SessionCancelAllBackgroundAgentsResult = number; /** * Parameters for aborting the current turn @@ -1405,6349 +2863,12481 @@ export interface AbortResult { */ error?: string; } - -export interface AccountGetQuotaRequest { - /** - * GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. - */ - gitHubToken?: string; -} /** - * Quota usage snapshots for the resolved user, keyed by quota type. + * Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AccountGetQuotaResult". + * via the `definition` "AccountAllUsers". */ -export interface AccountGetQuotaResult { +/** @experimental */ +export interface AccountAllUsers { + authInfo: AuthInfo; /** - * Quota snapshots keyed by type (e.g., chat, completions, premium_interactions) + * Associated token, if available */ - quotaSnapshots: { - [k: string]: AccountQuotaSnapshot | undefined; - }; + token?: string; } /** - * Schema for the `AccountQuotaSnapshot` type. + * Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AccountQuotaSnapshot". + * via the `definition` "HMACAuthInfo". */ -export interface AccountQuotaSnapshot { - /** - * Whether the user has an unlimited usage entitlement - */ - isUnlimitedEntitlement: boolean; +/** @experimental */ +export interface HMACAuthInfo { /** - * Number of requests included in the entitlement, or -1 for unlimited entitlements + * HMAC-based authentication used by GitHub-internal services. */ - entitlementRequests: number; + type: "hmac"; /** - * Number of requests used so far this period + * Authentication host. HMAC auth always targets the public GitHub host. */ - usedRequests: number; + host: "https://github.com"; /** - * Whether usage is still permitted after quota exhaustion + * HMAC secret used to sign requests. */ - usageAllowedWithExhaustedQuota: boolean; + hmac: string; + copilotUser?: CopilotUserResponse; +} +/** + * Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponse". + */ +/** @experimental */ +export interface CopilotUserResponse { /** - * Percentage of entitlement remaining + * GitHub login of the authenticated user. */ - remainingPercentage: number; + login?: string; /** - * Number of additional usage requests made this period + * Copilot access SKU identifier (e.g. `free_limited_copilot`, `copilot_for_business_seat_quota`) used to gate model and feature access. */ - overage: number; + access_type_sku?: string; /** - * Whether additional usage is allowed when quota is exhausted + * Opaque analytics tracking identifier for the user, forwarded from the Copilot API. */ - overageAllowedWithExhaustedQuota: boolean; + analytics_tracking_id?: string; /** - * Date when the quota resets (ISO 8601 string) + * Date the Copilot seat was assigned to the user, if applicable. */ - resetDate?: string; + assigned_date?: + | ( + | { + [k: string]: unknown | undefined; + } + | string + ) + | null; + /** + * Whether the user is eligible to sign up for the free/limited Copilot tier. + */ + can_signup_for_limited?: boolean; + /** + * Whether Copilot chat is enabled for the user. + */ + chat_enabled?: boolean; + /** + * Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`). + */ + copilot_plan?: string; + /** + * Whether `.copilotignore` content-exclusion support is enabled for the user. + */ + copilotignore_enabled?: boolean; + endpoints?: CopilotUserResponseEndpoints; + /** + * Logins of the organizations the user belongs to. + */ + organization_login_list?: string[]; + /** + * Organizations the user belongs to, each with an optional login and display name. + */ + organization_list?: + | ( + | { + [k: string]: unknown | undefined; + } + | ({ + login?: + | ( + | { + [k: string]: unknown | undefined; + } + | string + ) + | null; + name?: + | ( + | { + [k: string]: unknown | undefined; + } + | string + ) + | null; + } | null)[] + ) + | null; + /** + * Whether the Codex agent is enabled for the user. + */ + codex_agent_enabled?: boolean; + /** + * Whether MCP (Model Context Protocol) support is enabled for the user. + */ + is_mcp_enabled?: + | ( + | { + [k: string]: unknown | undefined; + } + | boolean + ) + | null; + /** + * Date the user's usage quota next resets, as a raw string from the Copilot API; see `quota_reset_date_utc` for the UTC-normalized value. + */ + quota_reset_date?: string; + quota_snapshots?: CopilotUserResponseQuotaSnapshots; + /** + * Whether the user's telemetry is subject to restricted-data handling. + */ + restricted_telemetry?: boolean; + /** + * Whether the user is a GitHub/Microsoft staff member. + */ + is_staff?: boolean; + /** + * Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime. + */ + te?: boolean; + /** + * Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota. + */ + token_based_billing?: boolean; + /** + * Whether the user is able to upgrade their Copilot plan. + */ + can_upgrade_plan?: boolean; + /** + * UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets). + */ + quota_reset_date_utc?: string; + /** + * Per-category quota allotments for free/limited-tier users, keyed by quota category. + */ + limited_user_quotas?: { + [k: string]: number | undefined; + }; + /** + * Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API. + */ + limited_user_reset_date?: string; + /** + * Per-category monthly quota allotments, keyed by quota category. + */ + monthly_quotas?: { + [k: string]: number | undefined; + }; + /** + * Whether cloud session storage is enabled for the user. + */ + cloud_session_storage_enabled?: boolean; + /** + * Whether CLI remote control is enabled for the user. + */ + cli_remote_control_enabled?: boolean; +} +/** + * Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponseEndpoints". + */ +/** @experimental */ +export interface CopilotUserResponseEndpoints { + api?: string; + "origin-tracker"?: string; + proxy?: string; + telemetry?: string; + exp?: string; +} +/** + * Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponseQuotaSnapshots". + */ +/** @experimental */ +export interface CopilotUserResponseQuotaSnapshots { + chat?: CopilotUserResponseQuotaSnapshotsChat; + completions?: CopilotUserResponseQuotaSnapshotsCompletions; + premium_interactions?: CopilotUserResponseQuotaSnapshotsPremiumInteractions; + [k: string]: + | ({ + entitlement?: number; + overage_count?: number; + overage_permitted?: boolean; + percent_remaining?: number; + quota_id?: string; + quota_remaining?: number; + remaining?: number; + unlimited?: boolean; + timestamp_utc?: string; + has_quota?: boolean; + quota_reset_at?: number; + token_based_billing?: boolean; + } | null) + | undefined; +} +/** + * Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponseQuotaSnapshotsChat". + */ +/** @experimental */ +export interface CopilotUserResponseQuotaSnapshotsChat { + /** + * Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + */ + entitlement?: number; + /** + * Count of additional pay-per-request usage consumed this period beyond the entitlement. + */ + overage_count?: number; + /** + * Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + */ + overage_permitted?: boolean; + /** + * Percentage of the entitlement remaining at the snapshot timestamp. + */ + percent_remaining?: number; + /** + * Identifier of the quota bucket this snapshot describes. + */ + quota_id?: string; + /** + * Amount of quota remaining at the snapshot timestamp. + */ + quota_remaining?: number; + /** + * Remaining entitlement/quota amount at the snapshot timestamp. + */ + remaining?: number; + /** + * Whether the entitlement for this category is unlimited. + */ + unlimited?: boolean; + /** + * UTC timestamp when this snapshot was captured. + */ + timestamp_utc?: string; + /** + * Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + */ + has_quota?: boolean; + /** + * Unix epoch time, in seconds, when this quota next resets. + */ + quota_reset_at?: number; + /** + * Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + */ + token_based_billing?: boolean; +} +/** + * Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponseQuotaSnapshotsCompletions". + */ +/** @experimental */ +export interface CopilotUserResponseQuotaSnapshotsCompletions { + /** + * Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + */ + entitlement?: number; + /** + * Count of additional pay-per-request usage consumed this period beyond the entitlement. + */ + overage_count?: number; + /** + * Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + */ + overage_permitted?: boolean; + /** + * Percentage of the entitlement remaining at the snapshot timestamp. + */ + percent_remaining?: number; + /** + * Identifier of the quota bucket this snapshot describes. + */ + quota_id?: string; + /** + * Amount of quota remaining at the snapshot timestamp. + */ + quota_remaining?: number; + /** + * Remaining entitlement/quota amount at the snapshot timestamp. + */ + remaining?: number; + /** + * Whether the entitlement for this category is unlimited. + */ + unlimited?: boolean; + /** + * UTC timestamp when this snapshot was captured. + */ + timestamp_utc?: string; + /** + * Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + */ + has_quota?: boolean; + /** + * Unix epoch time, in seconds, when this quota next resets. + */ + quota_reset_at?: number; + /** + * Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + */ + token_based_billing?: boolean; +} +/** + * Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotUserResponseQuotaSnapshotsPremiumInteractions". + */ +/** @experimental */ +export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions { + /** + * Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. + */ + entitlement?: number; + /** + * Count of additional pay-per-request usage consumed this period beyond the entitlement. + */ + overage_count?: number; + /** + * Whether usage may continue at pay-per-request rates once the entitlement is exhausted. + */ + overage_permitted?: boolean; + /** + * Percentage of the entitlement remaining at the snapshot timestamp. + */ + percent_remaining?: number; + /** + * Identifier of the quota bucket this snapshot describes. + */ + quota_id?: string; + /** + * Amount of quota remaining at the snapshot timestamp. + */ + quota_remaining?: number; + /** + * Remaining entitlement/quota amount at the snapshot timestamp. + */ + remaining?: number; + /** + * Whether the entitlement for this category is unlimited. + */ + unlimited?: boolean; + /** + * UTC timestamp when this snapshot was captured. + */ + timestamp_utc?: string; + /** + * Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. + */ + has_quota?: boolean; + /** + * Unix epoch time, in seconds, when this quota next resets. + */ + quota_reset_at?: number; + /** + * Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. + */ + token_based_billing?: boolean; +} +/** + * Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EnvAuthInfo". + */ +/** @experimental */ +export interface EnvAuthInfo { + /** + * Personal access token (PAT) or server-to-server token sourced from an environment variable. + */ + type: "env"; + /** + * Authentication host (e.g. https://github.com or a GHES host). + */ + host: string; + /** + * User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). + */ + login?: string; + /** + * The token value itself. Treat as a secret. + */ + token: string; + /** + * Name of the environment variable the token was sourced from. + */ + envVar: string; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "TokenAuthInfo". + */ +/** @experimental */ +export interface TokenAuthInfo { + /** + * SDK-side token authentication; the host configured the token directly via the SDK. + */ + type: "token"; + /** + * Authentication host. + */ + host: string; + /** + * The token value itself. Treat as a secret. + */ + token: string; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CopilotApiTokenAuthInfo". + */ +/** @experimental */ +export interface CopilotApiTokenAuthInfo { + /** + * Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. + */ + type: "copilot-api-token"; + /** + * Authentication host (always the public GitHub host). + */ + host: "https://github.com"; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UserAuthInfo". + */ +/** @experimental */ +export interface UserAuthInfo { + /** + * OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct. + */ + type: "user"; + /** + * Authentication host. + */ + host: string; + /** + * OAuth user login. + */ + login: string; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GhCliAuthInfo". + */ +/** @experimental */ +export interface GhCliAuthInfo { + /** + * Authentication via the `gh` CLI's saved credentials. + */ + type: "gh-cli"; + /** + * Authentication host. + */ + host: string; + /** + * User login as reported by `gh auth status`. + */ + login: string; + /** + * The token returned by `gh auth token`. Treat as a secret. + */ + token: string; + copilotUser?: CopilotUserResponse; +} +/** + * Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ApiKeyAuthInfo". + */ +/** @experimental */ +export interface ApiKeyAuthInfo { + /** + * API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). + */ + type: "api-key"; + /** + * The API key. Treat as a secret. + */ + apiKey: string; + /** + * Authentication host. + */ + host: string; + copilotUser?: CopilotUserResponse; +} +/** + * Current authentication state + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountGetCurrentAuthResult". + */ +/** @experimental */ +export interface AccountGetCurrentAuthResult { + authInfo?: AuthInfo; + /** + * Authentication errors from the last auth attempt, if any + */ + authErrors?: string[]; +} + +/** @experimental */ +export interface AccountGetQuotaRequest { + /** + * GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth. + */ + gitHubToken?: string; +} +/** + * Quota usage snapshots for the resolved user, keyed by quota type. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountGetQuotaResult". + */ +/** @experimental */ +export interface AccountGetQuotaResult { + /** + * Quota snapshots keyed by type (e.g., chat, completions, premium_interactions) + */ + quotaSnapshots: { + [k: string]: AccountQuotaSnapshot | undefined; + }; +} +/** + * Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountQuotaSnapshot". + */ +/** @experimental */ +export interface AccountQuotaSnapshot { + /** + * Whether the user has an unlimited usage entitlement + */ + isUnlimitedEntitlement: boolean; + /** + * Number of requests included in the entitlement, or -1 for unlimited entitlements + */ + entitlementRequests: number; + /** + * Number of requests used so far this period + */ + usedRequests: number; + /** + * Whether usage is still permitted after quota exhaustion + */ + usageAllowedWithExhaustedQuota: boolean; + /** + * Percentage of entitlement remaining + */ + remainingPercentage: number; + /** + * Number of additional usage requests made this period + */ + overage: number; + /** + * Whether additional usage is allowed when quota is exhausted + */ + overageAllowedWithExhaustedQuota: boolean; + /** + * Date when the quota resets (ISO 8601 string) + */ + resetDate?: string; +} +/** + * Credentials to store after successful authentication + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountLoginRequest". + */ +/** @experimental */ +export interface AccountLoginRequest { + /** + * GitHub host URL + */ + host: string; + /** + * User login/username + */ + login: string; + /** + * GitHub authentication token + */ + token: string; +} +/** + * Result of a successful login; throws on failure + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountLoginResult". + */ +/** @experimental */ +export interface AccountLoginResult { + /** + * Whether the credential was persisted to a secure store (system keychain, or the config file when plaintext storage is enabled). False when no secure store was available and the token was not saved, so the consumer can decide how to proceed. + */ + storedInVault: boolean; +} +/** + * User to log out + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountLogoutRequest". + */ +/** @experimental */ +export interface AccountLogoutRequest { + authInfo: AuthInfo; +} +/** + * Logout result indicating if more users remain + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AccountLogoutResult". + */ +/** @experimental */ +export interface AccountLogoutResult { + /** + * Whether other authenticated users remain after logout + */ + hasMoreUsers: boolean; +} +/** + * Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentDiscoveryPath". + */ +/** @experimental */ +export interface AgentDiscoveryPath { + /** + * Absolute path of the search/create directory (may not exist on disk yet) + */ + path: string; + scope: AgentDiscoveryPathScope; + /** + * Whether this is the canonical directory to create a new agent in its tier. At most one entry per tier is preferred. + */ + preferredForCreation: boolean; + /** + * The input project path this directory was derived from (only for project scope) + */ + projectPath?: string; +} +/** + * Canonical locations where custom agents can be created so the runtime will recognize them. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentDiscoveryPathList". + */ +/** @experimental */ +export interface AgentDiscoveryPathList { + /** + * Canonical agent create/discovery directories, in priority order + */ + paths: AgentDiscoveryPath[]; +} +/** + * The currently selected custom agent, or null when using the default agent. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentGetCurrentResult". + */ +/** @experimental */ +export interface AgentGetCurrentResult { + /** + * Currently selected custom agent, or null if using the default agent + */ + agent?: AgentInfo | null; +} +/** + * Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentInfo". + */ +/** @experimental */ +export interface AgentInfo { + /** + * Name of the agent. Use `id` as the stable selection identifier. + */ + name: string; + /** + * Human-readable display name + */ + displayName: string; + /** + * Description of the agent's purpose + */ + description: string; + /** + * Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. + */ + path?: string; + /** + * Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. + */ + id: string; + source?: AgentInfoSource; + /** + * Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. + */ + userInvocable?: boolean; + /** + * Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. + */ + tools?: string[]; + /** + * Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference. + */ + model?: string; + /** + * MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. + * + * @experimental + */ + mcpServers?: { + [k: string]: JsonValue | undefined; + }; + /** + * Skill names preloaded into this agent's context. Omitted means none. + */ + skills?: string[]; + /** + * Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. + */ + prompt?: string; +} +/** + * Agents available to the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentList". + */ +/** @experimental */ +export interface AgentList { + /** + * Available agents + */ + agents: AgentInfo[]; +} +/** + * Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistryLiveTargetEntry". + */ +/** @experimental */ +export interface AgentRegistryLiveTargetEntry { + /** + * Registry entry schema version (1 = ui-server, 2 = managed-server) + */ + schemaVersion: number; + kind: AgentRegistryLiveTargetEntryKind; + /** + * Operating-system pid of the process owning this entry + */ + pid: number; + /** + * Bind host for the entry's JSON-RPC server + */ + host: string; + /** + * TCP port the entry's JSON-RPC server is listening on + */ + port: number; + /** + * Connection token (null when the target is unauthenticated) + * + * @internal + */ + token?: string | null; + /** + * Session ID of the foreground session for this entry + */ + sessionId?: string; + /** + * Friendly session name (when set) + */ + sessionName?: string; + /** + * Working directory of the session (when known) + */ + cwd?: string; + /** + * Git branch of the session (when known) + */ + branch?: string; + /** + * Model identifier currently selected for the session + */ + model?: string; + status?: AgentRegistryLiveTargetEntryStatus; + attentionKind?: AgentRegistryLiveTargetEntryAttentionKind; + /** + * Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. + */ + statusRevision?: number; + lastTerminalEvent?: AgentRegistryLiveTargetEntryLastTerminalEvent; + /** + * ISO 8601 timestamp captured at registration + */ + startedAt: string; + /** + * Copilot CLI version that wrote the entry + */ + copilotVersion: string; + /** + * Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) + */ + lastSeenMs: number; +} +/** + * Per-spawn log-capture outcome; populated from spawnLiveTarget. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistryLogCapture". + */ +/** @experimental */ +export interface AgentRegistryLogCapture { + /** + * Whether per-spawn log capture is on (false when env-disabled or open failed) + */ + enabled: boolean; + /** + * Absolute path to the per-spawn log file (only set when enabled) + */ + path?: string; + /** + * Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used) + */ + openError?: string; + openErrorReason?: AgentRegistryLogCaptureOpenErrorReason; +} +/** + * `child_process.spawn` itself failed before the child entered the registry. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistrySpawnError". + */ +/** @experimental */ +export interface AgentRegistrySpawnError { + /** + * Discriminator: child_process.spawn itself failed + */ + kind: "spawn-error"; + /** + * Human-readable error message + */ + message: string; + /** + * Underlying errno code (e.g. ENOENT, EACCES) when available + */ + code?: string; +} +/** + * Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistrySpawnRegistryTimeout". + */ +/** @experimental */ +export interface AgentRegistrySpawnRegistryTimeout { + /** + * Discriminator: spawn succeeded but child never registered + */ + kind: "registry-timeout"; + /** + * Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance) + */ + childPid: number; + logCapture?: AgentRegistryLogCapture; +} +/** + * Inputs to spawn a managed-server child via the controller's spawn delegate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistrySpawnRequest". + */ +/** @experimental */ +export interface AgentRegistrySpawnRequest { + /** + * Working directory for the spawned child (must be an existing directory) + */ + cwd: string; + /** + * Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. + */ + agentName?: string; + /** + * Model identifier to apply to the new session + */ + model?: string; + /** + * Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + */ + name?: string; + permissionMode?: AgentRegistrySpawnPermissionMode; + /** + * Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). + */ + initialPrompt?: string; +} +/** + * Managed-server child was spawned and registered successfully. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistrySpawnSpawned". + */ +/** @experimental */ +export interface AgentRegistrySpawnSpawned { + /** + * Discriminator: managed-server child spawned successfully + */ + kind: "spawned"; + entry: AgentRegistryLiveTargetEntry; + /** + * Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path. + */ + initialPromptSent?: boolean; + /** + * If the delegate attempted to send the initial prompt and failed, the categorized error message. + */ + initialPromptError?: string; + logCapture?: AgentRegistryLogCapture; +} +/** + * Synchronous pre-validation rejected the spawn request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentRegistrySpawnValidationError". + */ +/** @experimental */ +export interface AgentRegistrySpawnValidationError { + /** + * Discriminator: synchronous pre-validation rejected the request + */ + kind: "validation-error"; + reason: AgentRegistrySpawnValidationErrorReason; + field?: AgentRegistrySpawnValidationErrorField; + /** + * Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. + */ + message: string; +} +/** + * Custom agents available to the session after reloading definitions from disk. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentReloadResult". + */ +/** @experimental */ +export interface AgentReloadResult { + /** + * Reloaded custom agents + */ + agents: AgentInfo[]; +} +/** + * Optional project paths to include in agent discovery. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentsDiscoverRequest". + */ +/** @experimental */ +export interface AgentsDiscoverRequest { + /** + * Optional list of project directory paths to scan for project-scoped agents. When omitted or empty, only user/plugin/remote-independent agents are returned (no project scan). + */ + projectPaths?: string[]; + /** + * When true, omit the host's agents (the user-level agent directory and all plugin agents), leaving only project and remote agents. For multitenant deployments. + */ + excludeHostAgents?: boolean; +} +/** + * Name of the custom agent to select for subsequent turns. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentSelectRequest". + */ +/** @experimental */ +export interface AgentSelectRequest { + /** + * Name of the custom agent to select + */ + name: string; +} +/** + * The newly selected custom agent. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentSelectResult". + */ +/** @experimental */ +export interface AgentSelectResult { + agent: AgentInfo; +} +/** + * An in-memory authored prompt override for an available agent. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentSetPromptRequest". + */ +/** @experimental */ +export interface AgentSetPromptRequest { + /** + * Stable effective agent id. Plugin namespace separators are normalized. + */ + id: string; + /** + * Replacement authored prompt. Empty text is valid. + */ + prompt: string; +} +/** + * Optional project paths to include when enumerating agent discovery directories. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AgentsGetDiscoveryPathsRequest". + */ +/** @experimental */ +export interface AgentsGetDiscoveryPathsRequest { + /** + * Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. + */ + projectPaths?: string[]; + /** + * When true, omit the host's user-level agent directory, leaving only project directories. For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + */ + excludeHostAgents?: boolean; +} +/** + * Indicates whether the operation succeeded and reports the post-mutation state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AllowAllPermissionSetResult". + */ +/** @experimental */ +export interface AllowAllPermissionSetResult { + /** + * Whether the operation succeeded + */ + success: boolean; + /** + * Authoritative full allow-all state after the mutation + */ + enabled: boolean; + mode?: PermissionsAllowAllMode; +} +/** + * Current allow-all permission mode. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "AllowAllPermissionState". + */ +/** @experimental */ +export interface AllowAllPermissionState { + /** + * Whether full allow-all permissions are currently active + */ + enabled: boolean; + mode?: PermissionsAllowAllMode; +} +/** + * The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltInModelCatalog". + */ +/** @experimental */ +export interface BuiltInModelCatalog { + /** + * Built-in model entries. + */ + models: BuiltInModelCatalogEntry[]; +} +/** + * A well-known model in the runtime's built-in catalog. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "BuiltInModelCatalogEntry". + */ +/** @experimental */ +export interface BuiltInModelCatalogEntry { + /** + * Well-known runtime model ID suitable for `ProviderConfig.modelId` or `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. + */ + id: string; +} +/** + * Cancellation result for a user-requested shell command. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CancelUserRequestedShellCommandResult". + */ +/** @experimental */ +export interface CancelUserRequestedShellCommandResult { + /** + * Whether an in-flight execution was found and signalled to cancel + */ + cancelled: boolean; +} +/** + * Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasAction". + */ +/** @experimental */ +export interface CanvasAction { + /** + * Action name exposed by the canvas provider + */ + name: string; + /** + * Description of the action + */ + description?: string; + inputSchema?: CanvasJsonSchema; +} +/** + * Canvas action invocation parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasActionInvokeRequest". + */ +/** @experimental */ +export interface CanvasActionInvokeRequest { + /** + * Open canvas instance identifier + */ + instanceId: string; + /** + * Action name to invoke + */ + actionName: string; + /** + * Action input + */ + input?: JsonValue; +} +/** + * Canvas close parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasCloseRequest". + */ +/** @experimental */ +export interface CanvasCloseRequest { + /** + * Open canvas instance identifier + */ + instanceId: string; +} +/** + * Host context supplied by the runtime. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasHostContext". + */ +/** @experimental */ +export interface CanvasHostContext { + capabilities?: CanvasHostContextCapabilities; +} +/** + * Host capabilities + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasHostContextCapabilities". + */ +/** @experimental */ +export interface CanvasHostContextCapabilities { + /** + * Whether canvas rendering is supported + */ + canvases?: boolean; +} +/** + * Declared canvases available in this session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasList". + */ +/** @experimental */ +export interface CanvasList { + /** + * Declared canvases available in this session + */ + canvases: DiscoveredCanvas[]; +} +/** + * Canvas available in the current session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredCanvas". + */ +/** @experimental */ +export interface DiscoveredCanvas { + /** + * Human-readable canvas name + */ + displayName: string; + /** + * Short, single-sentence description shown to the agent in canvas catalogs. + */ + description: string; + /** + * Host-local PNG path for the canvas icon, when supplied + */ + icon?: string; + inputSchema?: CanvasJsonSchema; + /** + * Actions the agent or host may invoke on an open instance + */ + actions?: CanvasAction[]; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Owning extension display name, when available + */ + extensionName?: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; +} +/** + * Live open-canvas snapshot. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasListOpenResult". + */ +/** @experimental */ +export interface CanvasListOpenResult { + /** + * Currently open canvas instances + */ + openCanvases: OpenCanvasInstance[]; +} +/** + * Open canvas instance snapshot. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "OpenCanvasInstance". + */ +/** @experimental */ +export interface OpenCanvasInstance { + /** + * Stable caller-supplied canvas instance identifier + */ + instanceId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Owning extension display name, when available + */ + extensionName?: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Host-local PNG path for the canvas icon, when supplied + */ + icon?: string; + /** + * Rendered title + */ + title?: string; + /** + * Provider-supplied status text + */ + status?: string; + /** + * URL for web-rendered canvases + */ + url?: string; + /** + * Input supplied when the instance was opened + */ + input?: JsonValue; +} +/** + * Canvas open parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasOpenRequest". + */ +/** @experimental */ +export interface CanvasOpenRequest { + /** + * Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. + */ + extensionId?: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Caller-supplied stable instance identifier + */ + instanceId: string; + /** + * Canvas open input + */ + input?: JsonValue; +} +/** + * Canvas close parameters sent to the provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderCloseRequest". + */ +/** @experimental */ +export interface CanvasProviderCloseRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Canvas instance identifier + */ + instanceId: string; + host?: CanvasHostContext; + session?: CanvasSessionContext; +} +/** + * Session context supplied by the runtime. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasSessionContext". + */ +/** @experimental */ +export interface CanvasSessionContext { + /** + * Active session working directory, when known. + */ + workingDirectory?: string; +} +/** + * Canvas action invocation parameters sent to the provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderInvokeActionRequest". + */ +/** @experimental */ +export interface CanvasProviderInvokeActionRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Canvas instance identifier + */ + instanceId: string; + /** + * Action name to invoke + */ + actionName: string; + /** + * Action input + */ + input?: JsonValue; + host?: CanvasHostContext; + session?: CanvasSessionContext; +} +/** + * Canvas open parameters sent to the provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderOpenRequest". + */ +/** @experimental */ +export interface CanvasProviderOpenRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Stable caller-supplied canvas instance identifier + */ + instanceId: string; + /** + * Canvas open input + */ + input?: JsonValue; + host?: CanvasHostContext; + session?: CanvasSessionContext; +} +/** + * Canvas open result returned by the provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CanvasProviderOpenResult". + */ +/** @experimental */ +export interface CanvasProviderOpenResult { + /** + * URL for web-rendered canvases + */ + url?: string; + /** + * Provider-supplied title + */ + title?: string; + /** + * Provider-supplied status text + */ + status?: string; +} +/** + * Options scoped to the built-in CAPI (Copilot API) provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CapiSessionOptions". + */ +/** @experimental */ +export interface CapiSessionOptions { + /** + * Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. + */ + enableWebSocketResponses?: boolean; +} +/** + * Slash commands available in the session, after applying any include/exclude filters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandList". + */ +/** @experimental */ +export interface CommandList { + /** + * Commands available in this session + */ + commands: SlashCommandInfo[]; +} +/** + * Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SlashCommandInfo". + */ +/** @experimental */ +export interface SlashCommandInfo { + /** + * Canonical command name without a leading slash + */ + name: string; + /** + * Canonical aliases without leading slashes + */ + aliases?: string[]; + /** + * Human-readable command description + */ + description: string; + kind: SlashCommandKind; + input?: SlashCommandInput; + /** + * Whether the command may run while an agent turn is active + */ + allowDuringAgentExecution: boolean; + /** + * Whether the command is experimental + */ + experimental?: boolean; + /** + * Whether the command may be the target of `/every` / `/after` schedules. Resolution happens at every tick, so only set this when the command is safe to re-invoke and produces an agent prompt. + */ + schedulable?: boolean; +} +/** + * Optional unstructured input hint + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SlashCommandInput". + */ +/** @experimental */ +export interface SlashCommandInput { + /** + * Hint to display when command input has not been provided + */ + hint: string; + /** + * Optional literal choices the input accepts, each with a human-facing description; clients may render these as selectable options + */ + choices?: SlashCommandInputChoice[]; + /** + * When true, the command requires non-empty input; clients should render the input hint as required + */ + required?: boolean; + completion?: SlashCommandInputCompletion; + /** + * When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace + */ + preserveMultilineInput?: boolean; +} +/** + * A literal choice the command input accepts, with a human-facing description + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SlashCommandInputChoice". + */ +/** @experimental */ +export interface SlashCommandInputChoice { + /** + * The literal choice value (e.g. 'on', 'off', 'show') + */ + name: string; + /** + * Human-readable description shown alongside the choice + */ + description: string; +} +/** + * Pending command request ID and an optional error if the client handler failed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsHandlePendingCommandRequest". + */ +/** @experimental */ +export interface CommandsHandlePendingCommandRequest { + /** + * Request ID from the command invocation event + */ + requestId: string; + /** + * Error message if the command handler failed + */ + error?: string; +} +/** + * Indicates whether the pending client-handled command was completed successfully. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsHandlePendingCommandResult". + */ +/** @experimental */ +export interface CommandsHandlePendingCommandResult { + /** + * Whether the command was handled successfully + */ + success: boolean; +} +/** + * Slash command name and optional raw input string to invoke. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsInvokeRequest". + */ +/** @experimental */ +export interface CommandsInvokeRequest { + /** + * Command name. Leading slashes are stripped and the name is matched case-insensitively. + */ + name: string; + /** + * Raw input after the command name + */ + input?: string; +} +/** + * Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsRespondToQueuedCommandRequest". + */ +/** @experimental */ +export interface CommandsRespondToQueuedCommandRequest { + /** + * Request ID from the `command.queued` event the host is responding to. + */ + requestId: string; + result: QueuedCommandResult; +} +/** + * Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueuedCommandHandled". + */ +/** @experimental */ +export interface QueuedCommandHandled { + /** + * The host actually executed the queued command. + */ + handled: true; + /** + * When true, the runtime will not process subsequent queued commands until a new request comes in. + */ + stopProcessingQueue?: boolean; +} +/** + * Queued-command response indicating the host did not execute the command and the queue may continue. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueuedCommandNotHandled". + */ +/** @experimental */ +export interface QueuedCommandNotHandled { + /** + * The host did not execute the queued command. Unblocks the queue without claiming the command was processed (e.g. when the handler threw before completing). + */ + handled: false; +} +/** + * Indicates whether the queued-command response was matched to a pending request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CommandsRespondToQueuedCommandResult". + */ +/** @experimental */ +export interface CommandsRespondToQueuedCommandResult { + /** + * Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + */ + success: boolean; +} +/** + * Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CompletionsGetTriggerCharactersResult". + */ +/** @experimental */ +export interface CompletionsGetTriggerCharactersResult { + /** + * Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + */ + triggerCharacters: string[]; +} +/** + * Request host-driven completions for the current composer input. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CompletionsRequestRequest". + */ +/** @experimental */ +export interface CompletionsRequestRequest { + /** + * The full composed composer input. + */ + text: string; + /** + * Cursor offset within `text`, in UTF-16 code units. + */ + offset: number; +} +/** + * Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CompletionsRequestResult". + */ +/** @experimental */ +export interface CompletionsRequestResult { + /** + * Completion items in host-ranked order. + */ + items: SessionCompletionItem[]; +} +/** + * A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` (UTF-16 code units) in the composer with `insertText`; when the range is absent, the active token around the cursor is replaced. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionCompletionItem". + */ +/** @experimental */ +export interface SessionCompletionItem { + /** + * Text spliced into the composer when the item is accepted. + */ + insertText: string; + /** + * Start of the replacement range in `text`, in UTF-16 code units. + */ + rangeStart?: number; + /** + * End (exclusive) of the replacement range in `text`, in UTF-16 code units. + */ + rangeEnd?: number; + /** + * Primary display label for the picker row. Falls back to `insertText` when absent. + */ + label?: string; + /** + * Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. + */ + kind?: string; +} +/** + * Params to attach or detach an in-process ExtensionController delegate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConfigureSessionExtensionsParams". + */ +/** @experimental */ +/** @internal */ +export interface ConfigureSessionExtensionsParams { + /** + * Session to attach the extension controller delegate to. + */ + sessionId: string; + /** + * In-process ExtensionController delegate (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. The post-SDK extension surface exposes list/enable/disable/reload via dedicated RPCs served by the runtime. + * + * @internal + * + * @internal + */ + controller?: OpaqueInProcessValue; +} +/** + * Metadata for a connected remote session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConnectedRemoteSessionMetadata". + */ +/** @experimental */ +export interface ConnectedRemoteSessionMetadata { + /** + * SDK session ID for the connected remote session. + */ + sessionId: string; + /** + * Optional friendly session name. + */ + name?: string; + /** + * Optional session summary. + */ + summary?: string; + /** + * Session start time as an ISO 8601 string. + */ + startTime: string; + /** + * Last session update time as an ISO 8601 string. + */ + modifiedTime: string; + repository: ConnectedRemoteSessionMetadataRepository; + /** + * Pull request number associated with the session. + */ + pullRequestNumber?: number; + /** + * Original remote resource identifier. + */ + resourceId?: string; + kind: ConnectedRemoteSessionMetadataKind; + /** + * Remote session staleness deadline as an ISO 8601 string. + */ + staleAt?: string; + /** + * Remote session state returned by the backing service. + */ + state?: string; +} +/** + * Repository associated with the connected remote session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConnectedRemoteSessionMetadataRepository". + */ +/** @experimental */ +export interface ConnectedRemoteSessionMetadataRepository { + /** + * Repository owner or organization login. + */ + owner: string; + /** + * Repository name. + */ + name: string; + /** + * Branch associated with the remote session. + */ + branch: string; +} +/** + * Remote session connection parameters. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConnectRemoteSessionParams". + */ +/** @experimental */ +export interface ConnectRemoteSessionParams { + /** + * Session ID to connect to. + */ + sessionId: string; +} +/** + * Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConnectRequest". + */ +/** @experimental */ +/** @internal */ +export interface ConnectRequest { + /** + * Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN + */ + token?: string; + /** + * Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the runtime forwards every internal telemetry event it emits — across all sessions, plus sessionless events — to this connection over the `gitHubTelemetry.event` notification. Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); host-only compatibility events are forward-only and intentionally skip that path. Intended for first-party hosts that re-emit the events into their own telemetry stores. Both unrestricted and restricted events are forwarded, each tagged with a `restricted` discriminator; a backstop drops restricted events when restricted telemetry is disabled — using the process-global gate for ordinary events and an explicit session-scoped decision for host-only events. + */ + enableGitHubTelemetryForwarding?: boolean; +} +/** + * Handshake result reporting the server's protocol version and package version on success. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ConnectResult". + */ +/** @experimental */ +/** @internal */ +export interface ConnectResult { + /** + * Always true on success + */ + ok: true; + /** + * Server protocol version number + */ + protocolVersion: number; + /** + * Server package version + */ + version: string; +} +/** + * Local file system absolute paths within the session working directory to check against its content-exclusion policy. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ContentExclusionCheckPathsRequest". + */ +/** @experimental */ +export interface ContentExclusionCheckPathsRequest { + /** + * Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. + */ + paths: string[]; +} +/** + * Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ContentExclusionCheckPathsResult". + */ +/** @experimental */ +export interface ContentExclusionCheckPathsResult { + /** + * Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded. + */ + available: boolean; + /** + * Per-path decisions in request order. Empty when available is false. + */ + checks: ContentExclusionPathCheck[]; +} +/** + * Content-exclusion decision for one requested path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ContentExclusionPathCheck". + */ +/** @experimental */ +export interface ContentExclusionPathCheck { + /** + * The path supplied by the caller. + */ + path: string; + /** + * Whether the session's complete content-exclusion policy excludes the path. + */ + excluded: boolean; +} +/** + * A single large message currently in context. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ContextHeaviestMessage". + */ +/** @experimental */ +export interface ContextHeaviestMessage { + /** + * Stable identifier for this message within the snapshot. + */ + id: string; + /** + * Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. + */ + label: string; + /** + * Role of the chat message (`user`, `assistant`, or `tool`). + */ + role: string; + /** + * Token count currently in context for this individual message. + */ + tokens: number; +} +/** + * The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CurrentModel". + */ +/** @experimental */ +export interface CurrentModel { + /** + * Currently active model identifier + */ + modelId?: string; + /** + * Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. + */ + reasoningEffort?: string; + contextTier?: ContextTier; +} +/** + * Lightweight metadata for a currently initialized session tool + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "CurrentToolMetadata". + */ +/** @experimental */ +export interface CurrentToolMetadata { + /** + * Model-facing tool name + */ + name: string; + /** + * Optional MCP/config namespaced tool name + */ + namespacedName?: string; + /** + * MCP server name for MCP-backed tools + */ + mcpServerName?: string; + /** + * Raw MCP tool name for MCP-backed tools + */ + mcpToolName?: string; + /** + * Tool description + */ + description: string; + /** + * JSON Schema for tool input + */ + input_schema?: { + [k: string]: JsonValue | undefined; + }; + /** + * Whether the tool is loaded on demand via tool search + */ + deferLoading?: boolean; +} +/** + * A file included in the redacted debug bundle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsCollectedEntry". + */ +/** @experimental */ +export interface DebugCollectLogsCollectedEntry { + /** + * Relative path of the file in the staged bundle/archive. + */ + bundlePath: string; + source: DebugCollectLogsSource; + /** + * Redacted output size in bytes. + */ + sizeBytes: number; +} +/** + * A caller-provided server-local file or directory to include in the debug bundle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsEntry". + */ +/** @experimental */ +export interface DebugCollectLogsEntry { + kind: DebugCollectLogsEntryKind; + /** + * Server-local source path to read. + */ + path: string; + /** + * Relative path to use inside the staged bundle/archive. + */ + bundlePath: string; + redaction?: DebugCollectLogsRedaction; + /** + * When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. + */ + required?: boolean; +} +/** + * Built-in session diagnostics to include in the bundle. Omitted fields default to true. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsInclude". + */ +/** @experimental */ +export interface DebugCollectLogsInclude { + /** + * Include the session event log (`events.jsonl`). Defaults to true. + */ + events?: boolean; + /** + * Include process logs for the session. Defaults to true. + */ + processLogs?: boolean; + /** + * Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. + */ + shellLogs?: boolean; + /** + * Server-local path to the session's events.jsonl file. Internal callers normally omit this and let the runtime derive it from the session. + */ + eventsPath?: string; + /** + * Server-local path to the current process log. When set, it is included as `process.log` and its directory is searched for prior logs from the same session. + */ + currentProcessLogPath?: string; + /** + * Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions. + */ + processLogDirectory?: string; + /** + * Maximum number of previous process logs to include. Defaults to 5. + */ + previousProcessLogLimit?: number; +} +/** + * Options for collecting a redacted session debug bundle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsRequest". + */ +/** @experimental */ +export interface DebugCollectLogsRequest { + destination: DebugCollectLogsDestination; + include?: DebugCollectLogsInclude; + /** + * Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape. + */ + additionalEntries?: DebugCollectLogsEntry[]; +} +/** + * Result of collecting a redacted debug bundle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsResult". + */ +/** @experimental */ +export interface DebugCollectLogsResult { + kind: DebugCollectLogsResultKind; + /** + * Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed. + */ + path: string; + /** + * Files included in the redacted bundle. + */ + entries: DebugCollectLogsCollectedEntry[]; + /** + * Optional files or directories that could not be included. + */ + skippedEntries?: DebugCollectLogsSkippedEntry[]; +} +/** + * An optional debug bundle entry that could not be included. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DebugCollectLogsSkippedEntry". + */ +/** @experimental */ +export interface DebugCollectLogsSkippedEntry { + /** + * Relative path requested for this bundle entry. + */ + bundlePath: string; + /** + * Server-local source path that could not be read. + */ + path?: string; + /** + * Reason the entry was skipped. + */ + reason: string; +} +/** + * Discovered extension metadata and persistent enablement state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtension". + */ +/** @experimental */ +export interface DiscoveredExtension { + /** + * Source-qualified ID accepted by both server and session extension enablement methods + */ + id: string; + /** + * Human-readable extension name + */ + name: string; + /** + * Absolute path to the extension entry module, suitable for revealing it in a file manager + */ + path: string; + source: DiscoveredExtensionSource; + /** + * Whether this extension's persistent per-ID preference is enabled + */ + enabled: boolean; + plugin?: DiscoveredExtensionPlugin; +} +/** + * Installed plugin that contributes a discovered extension. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensionPlugin". + */ +/** @experimental */ +export interface DiscoveredExtensionPlugin { + /** + * Installed plugin name + */ + name: string; +} +/** + * Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensions". + */ +/** @experimental */ +export interface DiscoveredExtensions { + /** + * Discovered user and enabled installed-plugin extensions from persisted Copilot home state + */ + extensions: DiscoveredExtension[]; + mode: DiscoveredExtensionMode; +} +/** + * Source-qualified extension identifiers to persistently disable for future sessions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensionsDisableRequest". + */ +/** @experimental */ +export interface DiscoveredExtensionsDisableRequest { + /** + * Source-qualified user or plugin extension IDs to disable + */ + ids: string[]; +} +/** + * Source-qualified extension identifiers to persistently enable for future sessions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredExtensionsEnableRequest". + */ +/** @experimental */ +export interface DiscoveredExtensionsEnableRequest { + /** + * Source-qualified user or plugin extension IDs to enable + */ + ids: string[]; +} +/** + * MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "DiscoveredMcpServer". + */ +/** @experimental */ +export interface DiscoveredMcpServer { + /** + * Server name (config key) + */ + name: string; + type?: DiscoveredMcpServerType; + source: McpServerSource; + /** + * Plugin name that provided this server, when source is plugin. + */ + sourcePlugin?: string; + /** + * Plugin version that provided this server, when source is plugin. + */ + sourcePluginVersion?: string; + /** + * Whether the server is enabled (not in the disabled list) + */ + enabled: boolean; +} +/** + * Slash-prefixed command string to enqueue for FIFO processing. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EnqueueCommandParams". + */ +/** @experimental */ +export interface EnqueueCommandParams { + /** + * Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. + */ + command: string; +} +/** + * Indicates whether the command was accepted into the local execution queue. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EnqueueCommandResult". + */ +/** @experimental */ +export interface EnqueueCommandResult { + /** + * True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). + */ + queued: boolean; +} +/** + * Cursor, batch size, and optional long-poll/filter parameters for reading session events. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EventLogReadRequest". + */ +/** @experimental */ +export interface EventLogReadRequest { + /** + * Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. + */ + cursor?: string; + /** + * Maximum number of events to return in this batch (1–1000, default 200). + */ + max?: number; + /** + * Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). This applies to forward reads only: a backward read always returns immediately and ignores `waitMs`, because backward paging covers persisted history only while new events append at the tail (the opposite end from a backward page), so no blocking or ephemeral delivery can occur. + */ + waitMs?: number; + types?: EventLogTypes; + agentScope?: EventsAgentScope; + /** + * Optional non-empty list of subagent identifiers. When provided, only events owned by one of these agents are returned; ownership recognizes the event envelope's agentId plus legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over agentScope. + * + * @minItems 1 + */ + agentIds?: [string, ...string[]]; + direction?: EventsReadDirection; + /** + * When false, skip ephemeral events entirely and return only durable (persisted) events. History-backfill callers that discard ephemerals anyway should set this so the read is bounded by the durable log length instead of racing the ephemeral ring on a busy session. Defaults to true (ephemerals are interleaved with durable events in creation order). Ignored by backward reads, which always cover persisted history only. + */ + includeEphemeral?: boolean; +} +/** + * Indicates whether the operation succeeded. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EventLogReleaseInterestResult". + */ +/** @experimental */ +export interface EventLogReleaseInterestResult { + /** + * Whether the operation succeeded + */ + success: boolean; +} +/** + * Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EventLogTailResult". + */ +/** @experimental */ +export interface EventLogTailResult { + /** + * Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). + */ + cursor: string; +} +/** + * Batch of session events returned by a read, with cursor and continuation metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "EventsReadResult". + */ +/** @experimental */ +export interface EventsReadResult { + /** + * Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set `includeEphemeral: false` to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order. + */ + events: SessionEvent[]; + /** + * Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing `direction: backward` with it (the cursor is also self-describing, so backward paging continues correctly). + */ + cursor: string; + /** + * True when more events are available in the read's direction. For a forward read, true means the batch returned `max` events and more are available immediately. For a backward read, true means older persisted events remain before the returned window. + */ + hasMore: boolean; + cursorStatus: EventsCursorStatus; +} +/** + * Slash command name and argument string to execute synchronously. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExecuteCommandParams". + */ +/** @experimental */ +export interface ExecuteCommandParams { + /** + * Name of the slash command to invoke (without the leading '/'). + */ + commandName: string; + /** + * Argument string to pass to the command (empty string if none). + */ + args: string; +} +/** + * Error message produced while executing the command, if any. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExecuteCommandResult". + */ +/** @experimental */ +export interface ExecuteCommandResult { + /** + * Error message produced while executing the command, if any. Omitted when the handler succeeded. + */ + error?: string; +} +/** + * Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "Extension". + */ +/** @experimental */ +export interface Extension { + /** + * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') + */ + id: string; + /** + * Extension name (directory name) + */ + name: string; + source: ExtensionSource; + status: ExtensionStatus; + /** + * Process ID if the extension is running + */ + pid?: number; +} +/** + * Slim input shape for extension_context attachments; identity fields are runtime-derived. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionContextPushInput". + */ +/** @experimental */ +export interface ExtensionContextPushInput { + /** + * Attachment type discriminator + */ + type: "extension_context"; + /** + * Human-readable composer pill label + */ + title: string; + /** + * Caller-supplied JSON payload (required, may be null but not undefined) + */ + payload: JsonValue; +} +/** + * Opaque integrator-owned process launch profile for one extension entrypoint. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionLaunchProfile". + */ +/** @experimental */ +export interface ExtensionLaunchProfile { + /** + * Executable used to launch the extension entrypoint. + */ + executable: string; + /** + * Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint. + */ + args: string[]; + /** + * Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. + */ + env: { + [k: string]: string | undefined; + }; +} +/** + * A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionLaunchProviderResolveRequest". + */ +/** @experimental */ +export interface ExtensionLaunchProviderResolveRequest { + /** + * Source-qualified extension identifier. + */ + id: string; + /** + * Human-readable extension name. + */ + name: string; + /** + * Absolute path to the discovered extension entrypoint. + */ + modulePath: string; + source: ExtensionSource; +} +/** + * The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionLaunchProviderResolveResult". + */ +/** @experimental */ +export interface ExtensionLaunchProviderResolveResult { + launch?: ExtensionLaunchProfile; +} +/** + * Extensions discovered for the session, with their current status. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionList". + */ +/** @experimental */ +export interface ExtensionList { + /** + * Discovered extensions and their current status + */ + extensions: Extension[]; +} +/** + * Source-qualified extension identifier to disable for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionsDisableRequest". + */ +/** @experimental */ +export interface ExtensionsDisableRequest { + /** + * Source-qualified extension ID to disable + */ + id: string; +} +/** + * Source-qualified extension identifier to enable for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExtensionsEnableRequest". + */ +/** @experimental */ +export interface ExtensionsEnableRequest { + /** + * Source-qualified extension ID to enable + */ + id: string; +} +/** + * Expanded external tool result payload + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlm". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlm { + /** + * Text result returned to the model + */ + textResultForLlm: string; + /** + * Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized. + */ + resultType?: string; + /** + * Optional error message for failed executions + */ + error?: string; + /** + * Detailed log content for timeline display + */ + sessionLog?: string; + /** + * Optional tool-specific telemetry + */ + toolTelemetry?: { + [k: string]: JsonValue | undefined; + }; + /** + * Base64-encoded binary results returned to the model + */ + binaryResultsForLlm?: ExternalToolTextResultForLlmBinaryResultsForLlm[]; + /** + * Structured content blocks from the tool + */ + contents?: ExternalToolTextResultForLlmContent[]; + /** + * Tool references returned by a tool-search override: names of deferred tools to surface to the model. When set, the tool result is materialized as `tool_reference` content blocks (rather than plain text) so the model knows which deferred tools are now available. + */ + toolReferences?: string[]; +} +/** + * Binary result returned by a tool for the model + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmBinaryResultsForLlm". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmBinaryResultsForLlm { + type: ExternalToolTextResultForLlmBinaryResultsForLlmType; + /** + * Base64-encoded binary data + */ + data: string; + /** + * MIME type of the binary data + */ + mimeType: string; + /** + * Human-readable description of the binary data + */ + description?: string; + /** + * Optional metadata from the producing tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * Plain text content block + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentText". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentText { + /** + * Content block type discriminator + */ + type: "text"; + /** + * The text content + */ + text: string; +} +/** + * Terminal/shell output content block with optional exit code and working directory + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentTerminal". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentTerminal { + /** + * Content block type discriminator + */ + type: "terminal"; + /** + * Terminal/shell output text + */ + text: string; + /** + * Process exit code, if the command has completed + */ + exitCode?: number; + /** + * Working directory where the command was executed + */ + cwd?: string; +} +/** + * Shell command exit metadata with optional output preview + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentShellExit". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentShellExit { + /** + * Content block type discriminator + */ + type: "shell_exit"; + /** + * Shell id, as assigned by Copilot runtime + */ + shellId: string; + /** + * Exit code from the completed shell command + */ + exitCode: number; + /** + * Working directory where the shell command was executed + */ + cwd?: string; + /** + * Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + */ + outputPreview?: string; + /** + * Whether outputPreview is known to be incomplete or truncated + */ + outputTruncated?: boolean; +} +/** + * Image content block with base64-encoded data + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentImage". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentImage { + /** + * Content block type discriminator + */ + type: "image"; + /** + * Base64-encoded image data + */ + data: string; + /** + * MIME type of the image (e.g., image/png, image/jpeg) + */ + mimeType: string; +} +/** + * Audio content block with base64-encoded data + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentAudio". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentAudio { + /** + * Content block type discriminator + */ + type: "audio"; + /** + * Base64-encoded audio data + */ + data: string; + /** + * MIME type of the audio (e.g., audio/wav, audio/mpeg) + */ + mimeType: string; +} +/** + * Resource link content block referencing an external resource + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentResourceLink". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentResourceLink { + /** + * Icons associated with this resource + */ + icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[]; + /** + * Resource name identifier + */ + name: string; + /** + * Human-readable display title for the resource + */ + title?: string; + /** + * URI identifying the resource + */ + uri: string; + /** + * Human-readable description of the resource + */ + description?: string; + /** + * MIME type of the resource content + */ + mimeType?: string; + /** + * Size of the resource in bytes + */ + size?: number; + /** + * Content block type discriminator + */ + type: "resource_link"; +} +/** + * Icon image for a resource + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIcon". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentResourceLinkIcon { + /** + * URL or path to the icon image + */ + src: string; + /** + * MIME type of the icon image + */ + mimeType?: string; + /** + * Available icon sizes (e.g., ['16x16', '32x32']) + */ + sizes?: string[]; + theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme; +} +/** + * Embedded resource content block with inline text or binary data + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ExternalToolTextResultForLlmContentResource". + */ +/** @experimental */ +export interface ExternalToolTextResultForLlmContentResource { + /** + * Content block type discriminator + */ + type: "resource"; + resource: ExternalToolTextResultForLlmContentResourceDetails; +} +/** + * Parameters for cooperatively aborting a factory body. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAbortRequest". + */ +/** @experimental */ +export interface FactoryAbortRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Factory run identifier. + */ + runId: string; +} +/** + * Acknowledgement that a factory request was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAckResult". + */ +/** @experimental */ +export interface FactoryAckResult {} +/** + * Options for one factory-scoped subagent call. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAgentOptions". + */ +/** @experimental */ +export interface FactoryAgentOptions { + /** + * Optional label distinguishing otherwise identical memoized agent calls. + */ + label?: string; + /** + * Optional JSON Schema for structured agent output. + */ + schema?: JsonValue; + /** + * Optional model identifier for the subagent. + */ + model?: string; + /** + * Optional reasoning effort for the subagent. This field is accepted but not yet honored. + */ + reasoningEffort?: string; + contextTier?: ContextTier; + /** + * Optional custom agent name for the subagent. This field is accepted but not yet honored. + */ + agent?: string; +} +/** + * Parameters for one factory-scoped subagent call. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAgentRequest". + */ +/** @experimental */ +export interface FactoryAgentRequest { + /** + * Factory run identifier that owns the subagent. + */ + factoryRunId: string; + /** + * Opaque token identifying the current factory execution attempt. + */ + executionToken: string; + /** + * Prompt to send to the subagent. + */ + prompt: string; + opts: FactoryAgentOptions; +} +/** + * Result of one factory-scoped subagent call. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAgentResult". + */ +/** @experimental */ +export interface FactoryAgentResult { + /** + * Agent result, omitted when the agent produced no result. + */ + result?: JsonValue; +} +/** + * Prompt-safe durable identity and live status for a direct factory agent. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryAgentSummary". + */ +/** @experimental */ +export interface FactoryAgentSummary { + agentId: string; + toolCallId: string; + runId: string; + phaseId: string | null; + label: string; + agentType: string; + status: string; + requestedModel?: string; + resolvedModel?: string; + startedAt?: number; + completedAt?: number; + activeMs: number; + activity?: string; +} +/** + * Parameters for cancelling a factory run. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryCancelRequest". + */ +/** @experimental */ +export interface FactoryCancelRequest { + /** + * Factory run identifier. + */ + runId: string; +} +/** + * Current factory phase identity. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryCurrentPhase". + */ +/** @experimental */ +export interface FactoryCurrentPhase { + id: string; + ordinal: number | null; +} +/** + * Declared or approved factory resource ceilings. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryDeclaredLimits". + */ +/** @experimental */ +export interface FactoryDeclaredLimits { + maxConcurrentSubagents?: number; + maxTotalSubagents?: number; + timeoutSeconds?: number; + maxAiCredits?: number; +} +/** + * Parameters sent to the owning extension to execute a factory closure. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryExecuteRequest". + */ +/** @experimental */ +export interface FactoryExecuteRequest { + /** + * Target session identifier + */ + sessionId: string; + /** + * Registered factory name. + */ + name: string; + /** + * Factory run identifier. + */ + runId: string; + /** + * Opaque token identifying this factory execution attempt. + */ + executionToken: string; + /** + * Factory input value. + */ + args: JsonValue; +} +/** + * Result returned by an extension factory closure. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryExecuteResult". + */ +/** @experimental */ +export interface FactoryExecuteResult { + /** + * Factory result value. + */ + result?: JsonValue; +} +/** + * Parameters for paging factory progress. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryGetRunProgressRequest". + */ +/** @experimental */ +export interface FactoryGetRunProgressRequest { + /** + * Factory run identifier. + */ + runId: string; + /** + * Optional phase identifier used to scope records and cursors. + */ + phaseId?: string; + /** + * Exclusive forward cursor. + */ + afterSeq?: number; + /** + * Exclusive backward cursor. + */ + beforeSeq?: number; + /** + * Maximum records to return. Defaults to 200 and is capped at 500. + */ + limit?: number; +} +/** + * Parameters for retrieving a factory run. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryGetRunRequest". + */ +/** @experimental */ +export interface FactoryGetRunRequest { + /** + * Factory run identifier. + */ + runId: string; +} +/** + * Parameters for reading a factory journal entry. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryJournalGetRequest". + */ +/** @experimental */ +export interface FactoryJournalGetRequest { + /** + * Factory run identifier. + */ + runId: string; + /** + * Opaque token identifying the current factory execution attempt. + */ + executionToken: string; + /** + * Namespaced journal key. + */ + key: string; +} +/** + * Result of reading a factory journal entry. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryJournalGetResult". + */ +/** @experimental */ +export interface FactoryJournalGetResult { + /** + * Whether the journal contained the requested key. + */ + hit: boolean; + /** + * Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + */ + resultJson?: JsonValue; +} +/** + * Parameters for storing a factory journal entry. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryJournalPutRequest". + */ +/** @experimental */ +export interface FactoryJournalPutRequest { + /** + * Factory run identifier. + */ + runId: string; + /** + * Opaque token identifying the current factory execution attempt. + */ + executionToken: string; + /** + * Namespaced journal key. + */ + key: string; + /** + * JSON result to memoize. + */ + resultJson: JsonValue; +} +/** + * Parameters for paging factory runs. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryListRunsRequest". + */ +/** @experimental */ +export interface FactoryListRunsRequest { + /** + * Exclusive forward cursor. + */ + afterSeq?: number; + /** + * Exclusive backward cursor. + */ + beforeSeq?: number; + /** + * Maximum terminal runs to return. Defaults to 200 and is capped at 500. + */ + limit?: number; +} +/** + * A page of factory runs in durable creation order. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryListRunsResult". + */ +/** @experimental */ +export interface FactoryListRunsResult { + runs: FactoryRunSummary[]; + /** + * Oldest terminal-run cursor in this page, or null when the terminal window is empty. + */ + oldestSeq?: number | null; + /** + * Newest terminal-run cursor in this page, or null when the terminal window is empty. + */ + newestSeq?: number | null; + /** + * Whether terminal runs newer than this page exist. + */ + hasMoreNewer?: boolean; + /** + * Number of terminal runs older than this page. + */ + omittedOlder?: number; +} +/** + * Durable factory run summary with read-time live overlays. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunSummary". + */ +/** @experimental */ +export interface FactoryRunSummary { + runId: string; + factoryName: string; + description: string; + status: FactoryRunStatus; + revision: number; + createdAt: number; + startedAt: number | null; + updatedAt: number; + completedAt: number | null; + currentPhase: FactoryCurrentPhase | null; + declaredPhaseCount: number; + liveAgentCount: number; + totalSpawnedAgentCount: number; + consumed: FactoryRunConsumed; + declaredLimits: FactoryDeclaredLimits; + approved: FactoryDeclaredLimits | null; + observedAt: number; + activeSegmentStartedAt: number | null; + terminal: FactoryRunTerminal | null; +} +/** + * Durable factory resource consumption. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunConsumed". + */ +/** @experimental */ +export interface FactoryRunConsumed { + activeMs: number; + subagents: number; + nanoAiu: number; +} +/** + * Prompt-safe terminal factory outcome. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunTerminal". + */ +/** @experimental */ +export interface FactoryRunTerminal { + reason?: string; + failure?: FactoryRunFailure; + error?: string; + resultPreview?: string; +} +/** + * One ordered factory progress line. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryLogLine". + */ +/** @experimental */ +export interface FactoryLogLine { + /** + * Monotonic sequence number within the factory run. + */ + seq: number; + kind: FactoryLogLineKind; + /** + * Progress text. + */ + text: string; +} +/** + * Parameters for recording factory progress. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryLogRequest". + */ +/** @experimental */ +export interface FactoryLogRequest { + /** + * Factory run identifier. + */ + runId: string; + /** + * Opaque token identifying the current factory execution attempt. + */ + executionToken: string; + /** + * Ordered progress lines to append. + */ + lines: FactoryLogLine[]; +} +/** + * Durable lifecycle and timing for one factory phase. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryPhaseObservation". + */ +/** @experimental */ +export interface FactoryPhaseObservation { + id: string; + ordinal: number | null; + title: string; + detail?: string; + status: FactoryPhaseStatus; + lastEnteredRunAttempt: number; + entryCount: number; + startedAt?: number; + completedAt?: number; + accumulatedActiveMs: number; + currentActiveMs: number; + totalAgentCount: number; + liveAgentCount: number; +} +/** + * One durable factory progress record. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryProgressLine". + */ +/** @experimental */ +export interface FactoryProgressLine { + /** + * Global monotonic sequence number within the run. + */ + seq: number; + /** + * Resume attempt that emitted this record. + */ + attempt: number; + /** + * Phase active when the record was emitted, or null before any phase. + */ + phaseId: string | null; + /** + * Epoch milliseconds when the record was persisted. + */ + recordedAt: number; + kind: FactoryLogLineKind; + /** + * Prompt-safe progress text. + */ + text: string; +} +/** + * A bidirectional page of factory progress. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryProgressPage". + */ +/** @experimental */ +export interface FactoryProgressPage { + records: FactoryProgressLine[]; + oldestSeq: number | null; + newestSeq: number | null; + hasMoreOlder: boolean; + hasMoreNewer: boolean; + /** + * Run revision reflected by this page. + */ + revision: number; +} +/** + * Parameters for resuming a factory run from its persisted identity. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryResumeRequest". + */ +/** @experimental */ +export interface FactoryResumeRequest { + /** + * Factory run identifier. + */ + runId: string; + limits?: FactoryRunLimits; +} +/** + * Wire-only per-invocation factory resource ceiling overrides. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunLimits". + */ +/** @experimental */ +export interface FactoryRunLimits { + /** + * Maximum number of factory subagents that may run concurrently. + */ + maxConcurrentSubagents?: number; + /** + * Maximum total number of factory subagents that may be admitted. + */ + maxTotalSubagents?: number; + /** + * Maximum accumulated active-execution time in seconds. Active execution includes the entire extension body, subprocess waits, queued-agent waits, and sleeps; time between resumed attempts is not counted. + */ + timeoutSeconds?: number; + /** + * Maximum AI credits consumed by factory subagents and their descendants. The post-paid ceiling is soft: parallel turns can settle beyond it before the run stops. + */ + maxAiCredits?: number; +} +/** + * Resolved persisted factory identity and resumed run envelope. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryResumeResult". + */ +/** @experimental */ +export interface FactoryResumeResult { + /** + * Persisted factory name resolved for the resumed run. + */ + factoryName: string; + run: FactoryRunResult; +} +/** + * Complete current or terminal factory run envelope. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunResult". + */ +/** @experimental */ +export interface FactoryRunResult { + /** + * Factory run identifier. + */ + runId: string; + status: FactoryRunStatus; + /** + * Completed factory result. + */ + result?: JsonValue; + /** + * Error message for an errored run. + */ + error?: string; + failure?: FactoryRunFailure; + /** + * Reason for a halted or cancelled run. + */ + reason?: string; + /** + * Partial journal and progress snapshot for a halted, cancelled, or errored run. + */ + snapshot?: JsonValue; +} +/** + * Full factory run observability detail. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunDetail". + */ +/** @experimental */ +export interface FactoryRunDetail { + runId: string; + factoryName: string; + description: string; + status: FactoryRunStatus; + revision: number; + createdAt: number; + startedAt: number | null; + updatedAt: number; + completedAt: number | null; + currentPhase: FactoryCurrentPhase | null; + declaredPhaseCount: number; + liveAgentCount: number; + totalSpawnedAgentCount: number; + consumed: FactoryRunConsumed; + declaredLimits: FactoryDeclaredLimits; + approved: FactoryDeclaredLimits | null; + observedAt: number; + activeSegmentStartedAt: number | null; + terminal: FactoryRunTerminal | null; + phases: FactoryPhaseObservation[]; + agents: FactoryAgentSummary[]; + progress: FactoryProgressPage; +} +/** + * Parameters for invoking a registered factory. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FactoryRunRequest". + */ +/** @experimental */ +export interface FactoryRunRequest { + /** + * Registered factory name. + */ + name: string; + /** + * Factory input value. + */ + args: JsonValue; + options?: RunOptions; +} +/** + * Options controlling factory invocation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "RunOptions". + */ +/** @experimental */ +export interface RunOptions { + limits?: FactoryRunLimits; + /** + * Run identifier whose journal and progress should seed this resumed run. + */ + resumeFromRunId?: string; +} +/** + * Optional user prompt to combine with the fleet orchestration instructions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FleetStartRequest". + */ +/** @experimental */ +export interface FleetStartRequest { + /** + * Optional user prompt to combine with fleet instructions + */ + prompt?: string; +} +/** + * Indicates whether fleet mode was successfully activated. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FleetStartResult". + */ +/** @experimental */ +export interface FleetStartResult { + /** + * Whether fleet mode was successfully activated + */ + started: boolean; +} +/** + * Folder path to add to trusted folders. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FolderTrustAddParams". + */ +/** @experimental */ +export interface FolderTrustAddParams { + /** + * Folder path to mark as trusted + */ + path: string; +} +/** + * Folder path to check for trust. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FolderTrustCheckParams". + */ +/** @experimental */ +export interface FolderTrustCheckParams { + /** + * Folder path to check + */ + path: string; +} +/** + * Folder trust check result. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "FolderTrustCheckResult". + */ +/** @experimental */ +export interface FolderTrustCheckResult { + /** + * Whether the folder is trusted + */ + trusted: boolean; +} +/** + * Client environment metadata describing the process that produced a telemetry event. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GitHubTelemetryClientInfo". + */ +/** @experimental */ +export interface GitHubTelemetryClientInfo { + /** + * Copilot CLI version string. + */ + cli_version: string; + /** + * Operating system platform (e.g. darwin, linux, win32). + */ + os_platform: string; + /** + * Operating system version string. + */ + os_version: string; + /** + * Operating system architecture (e.g. arm64, x64). + */ + os_arch: string; + /** + * Node.js runtime version string. + */ + node_version: string; + /** + * Copilot subscription plan, when known. + */ + copilot_plan?: string; + /** + * Type of client. + */ + client_type?: string; + /** + * Name of the client application. + */ + client_name?: string; + /** + * Whether the user is a GitHub/Microsoft staff member. + */ + is_staff?: boolean; + /** + * Stable machine identifier for the device. + */ + dev_device_id?: string; +} +/** + * A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing GitHubTelemetryNotification distinguishes standard from restricted events; the payload shape is identical for both. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GitHubTelemetryEvent". + */ +/** @experimental */ +export interface GitHubTelemetryEvent { + /** + * Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). + */ + kind: string; + /** + * Timestamp when the event was created (ISO 8601 format). + */ + created_at?: string; + /** + * Reference to the model call that produced this event. + */ + model_call_id?: string; + /** + * String-valued properties as a map from key to value. + */ + properties: { + [k: string]: string | undefined; + }; + /** + * Numeric metrics as a map from key to value. + */ + metrics: { + [k: string]: number | undefined; + }; + /** + * Experiment assignment context. + */ + exp_assignment_context?: string; + /** + * Feature flags enabled for this session, as a map from flag to value. + */ + features?: { + [k: string]: string | undefined; + }; + /** + * Session identifier the event belongs to. + */ + session_id?: string; + /** + * Copilot tracking ID for user-level attribution. + */ + copilot_tracking_id?: string; + client?: GitHubTelemetryClientInfo; +} +/** + * Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "GitHubTelemetryNotification". + */ +/** @experimental */ +export interface GitHubTelemetryNotification { + /** + * Session the telemetry event belongs to, when it is session-scoped. Omitted for sessionless events (for example, `server.sendTelemetry` calls with no session id), which are still forwarded to opted-in connections. + */ + sessionId?: string; + /** + * Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only. + */ + restricted: boolean; + event: GitHubTelemetryEvent; +} +/** + * Pending external tool call request ID, with the tool result or an error describing why it failed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HandlePendingToolCallRequest". + */ +/** @experimental */ +export interface HandlePendingToolCallRequest { + /** + * Request ID of the pending tool call + */ + requestId: string; + result?: ExternalToolResult; + /** + * Error message if the tool call failed + */ + error?: string; +} +/** + * Indicates whether the external tool call result was handled successfully. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HandlePendingToolCallResult". + */ +/** @experimental */ +export interface HandlePendingToolCallResult { + /** + * Whether the tool call result was handled successfully + */ + success: boolean; +} +/** + * Indicates whether an in-progress manual compaction was aborted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryAbortManualCompactionResult". + */ +/** @experimental */ +export interface HistoryAbortManualCompactionResult { + /** + * Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. + */ + aborted: boolean; +} +/** + * Indicates whether an in-progress background compaction was cancelled. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryCancelBackgroundCompactionResult". + */ +/** @experimental */ +export interface HistoryCancelBackgroundCompactionResult { + /** + * Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. + */ + cancelled: boolean; +} +/** + * Parameters for clearing the conversation and seeding the window that replaces it. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryClearContextRequest". + */ +/** @experimental */ +export interface HistoryClearContextRequest { + /** + * First user message of the fresh context window. Required: a cleared window holding only system and developer messages is not a conversation a model can answer, so every clear seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop exits, which is why the call must be made from inside a tool handler. + */ + prompt: string; +} +/** + * What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryClearContextResult". + */ +/** @experimental */ +export interface HistoryClearContextResult { + /** + * Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. + */ + messagesCleared: number; +} +/** + * Post-compaction context window usage breakdown + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryCompactContextWindow". + */ +/** @experimental */ +export interface HistoryCompactContextWindow { + /** + * Maximum token count for the model's context window + */ + tokenLimit: number; + /** + * Current total tokens in the context window (system + conversation + tool definitions) + */ + currentTokens: number; + /** + * Current number of messages in the conversation + */ + messagesLength: number; + /** + * Token count from system message(s) + */ + systemTokens?: number; + /** + * Token count from non-system messages (user, assistant, tool) + */ + conversationTokens?: number; + /** + * Token count from tool definitions + */ + toolDefinitionsTokens?: number; +} +/** + * Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryCompactResult". + */ +/** @experimental */ +export interface HistoryCompactResult { + /** + * Whether compaction completed successfully + */ + success: boolean; + /** + * Number of tokens freed by compaction + */ + tokensRemoved: number; + /** + * Number of messages removed during compaction + */ + messagesRemoved: number; + /** + * Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + */ + summaryContent?: string; + contextWindow?: HistoryCompactContextWindow; +} +/** + * Rewind points and file-change-tracking availability for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryListRewindPointsResult". + */ +/** @experimental */ +export interface HistoryListRewindPointsResult { + /** + * Whether this session captured file changes from its first turn. + */ + fileChangeTrackingEnabled: boolean; + unavailableReason?: HistoryRewindUnavailableReason; + /** + * Root user turns in chronological order. Empty when `unavailableReason` is set. + */ + points: HistoryRewindPoint[]; +} +/** + * A root user turn that the session can rewind to. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindPoint". + */ +/** @experimental */ +export interface HistoryRewindPoint { + /** + * ID of the user.message event that begins the discarded suffix. + */ + eventId: string; + /** + * User-visible message text for the turn. + */ + userMessage: string; + /** + * ISO timestamp of the user turn. + */ + timestamp: string; + /** + * Whether at least one file in this turn or a later turn can be restored. + */ + canRestoreFiles: boolean; + /** + * Number of unique files in this turn and all later turns that have captured changes. + */ + fileCount: number; + /** + * Whether this turn itself captured any file changes. + */ + turnChangedFiles: boolean; + /** + * Lines added by this turn's captured file changes. + */ + linesAdded: number; + /** + * Lines removed by this turn's captured file changes. + */ + linesRemoved: number; + /** + * Whether this turn was an automatically injected autopilot continuation. + */ + isAutopilotContinuation: boolean; +} +/** + * Event boundary to preview for conversation-and-files rewind. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryPreviewRewindRequest". + */ +/** @experimental */ +export interface HistoryPreviewRewindRequest { + /** + * ID of the user.message event that begins the discarded suffix. + */ + eventId: string; +} +/** + * Files and aggregate changes for a prospective rewind. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryPreviewRewindResult". + */ +/** @experimental */ +export interface HistoryPreviewRewindResult { + /** + * Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. + */ + available: boolean; + reason?: HistoryRewindUnavailableReason; + /** + * Number of unique files in the preview. + */ + fileCount: number; + /** + * Files ordered by path. + */ + files: HistoryRewindFilePreview[]; +} +/** + * A file that a conversation-and-files rewind would restore. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindFilePreview". + */ +/** @experimental */ +export interface HistoryRewindFilePreview { + /** + * Absolute path of the captured file. + */ + path: string; + changeType: HistoryRewindChangeType; + /** + * Lines added across the discarded turns. + */ + linesAdded: number; + /** + * Lines removed across the discarded turns. + */ + linesRemoved: number; +} +/** + * Boundary and mode for rewinding session history. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindRequest". + */ +/** @experimental */ +export interface HistoryRewindRequest { + /** + * ID of the user.message event that begins the discarded suffix. + */ + eventId: string; + mode: HistoryRewindMode; +} +/** + * Structured outcome of a rewind request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryRewindResult". + */ +/** @experimental */ +export interface HistoryRewindResult { + outcome: HistoryRewindOutcome; + /** + * Number of persisted events removed by conversation truncation. Present only when truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`) and for `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + */ + eventsRemoved?: number; + /** + * Absolute paths restored to their captured preimages. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + */ + restoredFiles: string[]; + /** + * Captured files intentionally left unchanged. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + */ + skippedFiles: HistorySkippedFileRestore[]; + /** + * Failure detail. Set only for the failure and partial-failure outcomes (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`). + */ + error?: string; +} +/** + * A captured file that rewind intentionally left unchanged. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistorySkippedFileRestore". + */ +/** @experimental */ +export interface HistorySkippedFileRestore { + /** + * Absolute path of the skipped file. + */ + path: string; + reason: HistoryFileRestoreSkipReason; +} +/** + * Markdown summary of the conversation context (empty when not available). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistorySummarizeForHandoffResult". + */ +/** @experimental */ +export interface HistorySummarizeForHandoffResult { + /** + * Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. + */ + summary: string; +} +/** + * Identifier of the event to truncate to; this event and all later events are removed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryTruncateRequest". + */ +/** @experimental */ +export interface HistoryTruncateRequest { + /** + * Event ID to truncate to. This event and all events after it are removed from the session. + */ + eventId: string; +} +/** + * Number of events that were removed by the truncation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HistoryTruncateResult". + */ +/** @experimental */ +export interface HistoryTruncateResult { + /** + * Number of events that were removed + */ + eventsRemoved: number; + /** + * True when conversation truncation succeeded but post-truncation workspace checkpoint cleanup failed. History is already truncated; callers may still prune snapshots but should report a checkpoint-cleanup rather than a truncation failure. + */ + checkpointCleanupFailed?: boolean; + /** + * Failure detail when checkpointCleanupFailed is true. + */ + checkpointCleanupError?: string; +} +/** + * Runtime-owned wire payload for a server-to-client hook callback invocation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HookInvokeRequest". + */ +/** @experimental */ +/** @internal */ +export interface HookInvokeRequest { + sessionId: string; + hookType: HookType; + input: JsonValue; +} +/** + * Optional output returned by an SDK callback hook. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "HookInvokeResponse". + */ +/** @experimental */ +/** @internal */ +export interface HookInvokeResponse { + output?: JsonValue; +} +/** + * Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstalledPlugin". + */ +/** @experimental */ +export interface InstalledPlugin { + /** + * Plugin name + */ + name: string; + /** + * Marketplace the plugin came from (empty string for direct repo installs) + */ + marketplace: string; + /** + * Version installed (if available) + */ + version?: string; + /** + * Installation timestamp + */ + installed_at: string; + /** + * Whether the plugin is currently enabled + */ + enabled: boolean; + /** + * Path where the plugin is cached locally + */ + cache_path?: string; + source?: InstalledPluginSource; + /** + * Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + */ + source_sha?: string; +} +/** + * Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstalledPluginSourceGitHub". + */ +/** @experimental */ +export interface InstalledPluginSourceGitHub { + /** + * Constant value. Always "github". + */ + source: "github"; + repo: string; + ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + path?: string; +} +/** + * Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstalledPluginSourceUrl". + */ +/** @experimental */ +export interface InstalledPluginSourceUrl { + /** + * Constant value. Always "url". + */ + source: "url"; + url: string; + ref?: string; + /** + * Optional full 40-character hexadecimal commit SHA. + */ + sha?: string; + path?: string; +} +/** + * Source descriptor for a direct local plugin install, with a local filesystem path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstalledPluginSourceLocal". + */ +/** @experimental */ +export interface InstalledPluginSourceLocal { + /** + * Constant value. Always "local". + */ + source: "local"; + path: string; +} +/** + * Information about an installed plugin tracked in global state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstalledPluginInfo". + */ +/** @experimental */ +export interface InstalledPluginInfo { + /** + * Plugin name + */ + name: string; + /** + * Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. + */ + marketplace: string; + /** + * Opaque, stable hash identifying a direct (non-marketplace) install source. Present only for direct repo / URL / local installs; absent for marketplace plugins. Same source yields the same id; distinct sources never collide. + */ + directSourceId?: string; + /** + * Installed version (when reported by the plugin manifest) + */ + version?: string; + /** + * Whether the plugin is currently enabled for new sessions + */ + enabled: boolean; +} +/** + * Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionDiscoveryPath". + */ +/** @experimental */ +export interface InstructionDiscoveryPath { + /** + * Absolute path of the file or directory (may not exist on disk yet) + */ + path: string; + location: InstructionDiscoveryPathLocation; + kind: InstructionDiscoveryPathKind; + /** + * Whether this is the canonical target to create new instructions in its tier. At most one entry per tier is preferred. + */ + preferredForCreation: boolean; + /** + * The input project path this target was derived from (only for repository targets) + */ + projectPath?: string; +} +/** + * Canonical files and directories where custom instructions can be created so the runtime will recognize them. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionDiscoveryPathList". + */ +/** @experimental */ +export interface InstructionDiscoveryPathList { + /** + * Canonical instruction create/discovery files and directories, in priority order + */ + paths: InstructionDiscoveryPath[]; +} +/** + * Optional project paths to include in instruction discovery. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionsDiscoverRequest". + */ +/** @experimental */ +export interface InstructionsDiscoverRequest { + /** + * Optional list of project directory paths to scan for repository/working-directory instruction sources. When omitted or empty, only user-level and plugin instruction sources are returned (no project scan). + */ + projectPaths?: string[]; + /** + * When true, omit the host's instruction sources (user/home-level files and plugin rules), leaving only repository and working-directory sources. For multitenant deployments. + */ + excludeHostInstructions?: boolean; +} +/** + * Optional project paths to include when enumerating instruction discovery targets. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionsGetDiscoveryPathsRequest". + */ +/** @experimental */ +export interface InstructionsGetDiscoveryPathsRequest { + /** + * Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. + */ + projectPaths?: string[]; + /** + * When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + */ + excludeHostInstructions?: boolean; +} +/** + * Instruction sources loaded for the session, in merge order. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionsGetSourcesResult". + */ +/** @experimental */ +export interface InstructionsGetSourcesResult { + /** + * Instruction sources for the session + */ + sources: InstructionSource[]; +} +/** + * Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InstructionSource". + */ +/** @experimental */ +export interface InstructionSource { + /** + * Unique identifier for this source (used for toggling) + */ + id: string; + /** + * Human-readable label + */ + label: string; + /** + * File path relative to repo or absolute for home + */ + sourcePath: string; + /** + * Raw content of the instruction file + */ + content: string; + type: InstructionSourceType; + location: InstructionSourceLocation; + /** + * Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files + */ + applyTo?: string[]; + /** + * Short description (body after frontmatter) for use in instruction tables + */ + description?: string; + /** + * When true, this source starts disabled and must be toggled on by the user + */ + defaultDisabled?: boolean; + /** + * The project path this source was discovered from. Only set by sessionless discovery for repository, working-directory, and project-scoped plugin sources, where it disambiguates sources across multiple workspace roots. The session-scoped getSources leaves it unset. + */ + projectPath?: string; +} +/** + * Parameters for interrupting the main agent turn. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InterruptMainTurnRequest". + */ +/** @experimental */ +export interface InterruptMainTurnRequest { + /** + * When true, the user's queued prompts are preserved and run as the next turn once the interrupted turn unwinds; when false (the default), the queue is cleared like a plain abort. + */ + flushQueued?: boolean; +} +/** + * Result of interrupting the main agent turn. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "InterruptMainTurnResult". + */ +/** @experimental */ +export interface InterruptMainTurnResult { + /** + * Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + */ + interrupted: boolean; +} +/** + * HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHeaders". + */ +/** @experimental */ +export interface LlmInferenceHeaders { + [k: string]: string[] | undefined; +} +/** + * A request body chunk or cancellation signal. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpRequestChunkRequest". + */ +/** @experimental */ +export interface LlmInferenceHttpRequestChunkRequest { + /** + * Matches the requestId from the originating httpRequestStart frame. + */ + requestId: string; + /** + * Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty. + */ + data: string; + /** + * When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + */ + binary?: boolean; + /** + * When true, this is the final body chunk for the request. The SDK may rely on having received an end-marked chunk before treating the request body as complete. + */ + end?: boolean; + /** + * When true, the runtime is cancelling the in-flight request (e.g. upstream consumer aborted). `data` is ignored. Implies end-of-request. + */ + cancel?: boolean; + /** + * Optional human-readable reason for the cancellation, propagated for logging. + */ + cancelReason?: string; + /** + * Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent transport can attribute successive turns correctly: when a WebSocket connection is reused across turns, the httpRequestStart identity reflects only the turn that opened the connection, so each later turn stamps its own invocation id here. Absent when the runtime has no invocation context for the request, or on the plain-HTTP transport where every request has its own httpRequestStart. + */ + agentInvocationId?: string; +} +/** + * Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpRequestChunkResult". + */ +/** @experimental */ +export interface LlmInferenceHttpRequestChunkResult {} +/** + * The head of an outbound model-layer HTTP request. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpRequestStartRequest". + */ +/** @experimental */ +export interface LlmInferenceHttpRequestStartRequest { + /** + * Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies back to the runtime. + */ + requestId: string; + /** + * Id of the runtime session that triggered this request, when one is in scope. Absent for requests issued outside any session (e.g. startup model-catalog or capability resolution). This is a payload field — not a dispatch key — because the client-global API is registered process-wide rather than per session. + */ + sessionId?: string; + /** + * HTTP method, e.g. GET, POST. + */ + method: string; + /** + * Absolute request URL. + */ + url: string; + headers: LlmInferenceHeaders; + transport?: LlmInferenceHttpRequestStartTransport; + /** + * Stable identity of the agent trajectory that issued this request. Present when the request originates from an agent turn; absent for requests outside any agent context. This is the same identity used by lifecycle and bridged session events and remains constant across turns and retries. + */ + agentId?: string; + /** + * Stable identity of the immediate parent trajectory. Present for child trajectories such as subagents and conversation-sampling requests; absent for root-agent and non-agent requests. + */ + parentAgentId?: string; + /** + * Identity of the agent invocation (one agentic loop) that issued this request. It remains fixed across physical retries within the invocation and is distinct from the stable trajectory `agentId`. A caller-supplied invocation id always takes precedence (this covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests fall back to the runtime's agent task id — the same value the runtime emits as the `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. + */ + agentInvocationId?: string; + /** + * Coarse classification of the interaction that produced this request. Open string for forward-compatibility; known values include `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, and `conversation-user`. Absent when the runtime did not classify the request. Comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` header from this same context. + */ + interactionType?: string; +} +/** + * Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpRequestStartResult". + */ +/** @experimental */ +export interface LlmInferenceHttpRequestStartResult {} +/** + * Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpResponseChunkError". + */ +/** @experimental */ +export interface LlmInferenceHttpResponseChunkError { + /** + * Human-readable failure description. + */ + message: string; + /** + * Optional machine-readable error code. + */ + code?: string; +} +/** + * A response body chunk or terminal error. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpResponseChunkRequest". + */ +/** @experimental */ +export interface LlmInferenceHttpResponseChunkRequest { + /** + * Matches the requestId from the originating httpRequestStart frame. + */ + requestId: string; + /** + * Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk with empty data and end=true). + */ + data: string; + /** + * When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + */ + binary?: boolean; + /** + * When true, this is the final body chunk for the response. The runtime treats the response body as complete after receiving an end-marked chunk. + */ + end?: boolean; + error?: LlmInferenceHttpResponseChunkError; +} +/** + * Whether the chunk was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpResponseChunkResult". + */ +/** @experimental */ +export interface LlmInferenceHttpResponseChunkResult { + /** + * True when the chunk was matched to a pending request; false when unknown. + */ + accepted: boolean; +} +/** + * Response head. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpResponseStartRequest". + */ +/** @experimental */ +export interface LlmInferenceHttpResponseStartRequest { + /** + * Matches the requestId from the originating httpRequestStart frame. + */ + requestId: string; + /** + * HTTP status code. + */ + status: number; + /** + * Optional HTTP status reason phrase. + */ + statusText?: string; + headers: LlmInferenceHeaders; +} +/** + * Whether the start frame was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceHttpResponseStartResult". + */ +/** @experimental */ +export interface LlmInferenceHttpResponseStartResult { + /** + * True when the response start was matched to a pending request; false when unknown. + */ + accepted: boolean; +} +/** + * Indicates whether the calling client was registered as the LLM inference provider. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LlmInferenceSetProviderResult". + */ +/** @experimental */ +export interface LlmInferenceSetProviderResult { + /** + * Whether the provider was set successfully + */ + success: boolean; +} +/** + * Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LocalSessionMetadataValue". + */ +/** @experimental */ +export interface LocalSessionMetadataValue { + /** + * Stable session identifier + */ + sessionId: string; + /** + * Session creation time as an ISO 8601 timestamp + */ + startTime: string; + /** + * Last-modified time of the session's persisted state, as ISO 8601 + */ + modifiedTime: string; + /** + * Short summary of the session, when one has been derived + */ + summary?: string; + /** + * Optional human-friendly name set via /rename + */ + name?: string; + /** + * Runtime client name that created/last resumed this session + */ + clientName?: string; + /** + * Always false for local sessions. + */ + isRemote: false; + /** + * True for detached maintenance sessions that should be hidden from normal resume lists. + */ + isDetached?: boolean; + context?: SessionContext; + /** + * GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + */ + mcTaskId?: string; +} +/** + * Pre-resolved working-directory context for session startup. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionContext". + */ +/** @experimental */ +export interface SessionContext { + /** + * Most recent working directory for this session + */ + cwd: string; + /** + * Git repository root, if the cwd was inside a git repo + */ + gitRoot?: string; + /** + * Repository slug in `owner/name` form, when known + */ + repository?: string; + hostType?: SessionContextHostType; + /** + * Active git branch + */ + branch?: string; +} +/** + * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LogRequest". + */ +/** @experimental */ +export interface LogRequest { + /** + * Human-readable message + */ + message: string; + level?: SessionLogLevel; + /** + * Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + */ + type?: string; + /** + * When true, the message is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Optional URL the user can open in their browser for more details + */ + url?: string; + /** + * Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + */ + tip?: string; +} +/** + * Identifier of the session event that was emitted for the log message. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LogResult". + */ +/** @experimental */ +export interface LogResult { + /** + * The unique identifier of the emitted session event + */ + eventId: string; +} +/** + * Parameters for (re)loading the merged LSP configuration set. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "LspInitializeRequest". + */ +/** @experimental */ +export interface LspInitializeRequest { + /** + * Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. + */ + workingDirectory?: string; + /** + * Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). + */ + gitRoot?: string; + /** + * Force re-initialization even when LSP configs were already loaded for the working directory. + */ + force?: boolean; +} +/** + * Validated device-managed settings discovered before a session exists. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ManagedSettingsReadResult". + */ +/** @experimental */ +export interface ManagedSettingsReadResult { + /** + * Validated, canonical managed-settings JSON. Omitted when no managed settings were discovered or when discovered settings failed validation. + */ + settingsJson?: JsonValue; + /** + * Discovery or validation error text when managed settings could not be read safely. + */ + errorMessage?: string; +} +/** + * Result of registering a new marketplace. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceAddResult". + */ +/** @experimental */ +export interface MarketplaceAddResult { + /** + * Final name of the marketplace as resolved from its manifest + */ + name: string; +} +/** + * Plugins advertised by the marketplace. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceBrowseResult". + */ +/** @experimental */ +export interface MarketplaceBrowseResult { + /** + * Plugins advertised by the marketplace + */ + plugins: MarketplacePluginInfo[]; +} +/** + * Plugin entry advertised by a marketplace. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplacePluginInfo". + */ +/** @experimental */ +export interface MarketplacePluginInfo { + /** + * Plugin name as listed in the marketplace catalog + */ + name: string; + /** + * Short description from the marketplace catalog, when present + */ + description?: string; +} +/** + * Registered marketplace summary. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceInfo". + */ +/** @experimental */ +export interface MarketplaceInfo { + /** + * Marketplace name (matches the @marketplace suffix in plugin specs) + */ + name: string; + /** + * Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: owner/repo"). + */ + source: string; + /** + * True when this is a default marketplace shipped with the runtime. Defaults are not removable. + */ + isDefault?: boolean; +} +/** + * All registered marketplaces, including built-in defaults. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceListResult". + */ +/** @experimental */ +export interface MarketplaceListResult { + /** + * Registered marketplaces + */ + marketplaces: MarketplaceInfo[]; +} +/** + * Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceRefreshEntry". + */ +/** @experimental */ +export interface MarketplaceRefreshEntry { + /** + * Marketplace name that was refreshed + */ + name: string; + /** + * Whether the refresh succeeded + */ + success: boolean; + /** + * Error message (failure only) + */ + error?: string; +} +/** + * Result of refreshing one or more marketplace catalogs. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceRefreshResult". + */ +/** @experimental */ +export interface MarketplaceRefreshResult { + /** + * Per-marketplace refresh results in deterministic order. + */ + results: MarketplaceRefreshEntry[]; +} +/** + * Outcome of the remove attempt, including dependent-plugin info when applicable. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MarketplaceRemoveResult". + */ +/** @experimental */ +export interface MarketplaceRemoveResult { + /** + * True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. + */ + removed: boolean; + /** + * Names of installed plugins that prevented removal. Populated only when `removed=false`. + */ + dependentPlugins?: string[]; +} +/** + * MCP server allowed by policy, with server name and optional PII-free explanatory note. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAllowedServer". + */ +/** @experimental */ +export interface McpAllowedServer { + /** + * Allowed server name + */ + name: string; + /** + * PII-free note explaining why the server was allowed + */ + redactedNote?: string; +} +/** + * MCP server, tool name, and arguments to invoke from an MCP App view. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsCallToolRequest". + */ +/** @experimental */ +export interface McpAppsCallToolRequest { + /** + * MCP server hosting the tool + */ + serverName: string; + /** + * MCP tool name + */ + toolName: string; + /** + * Tool arguments + */ + arguments?: { + [k: string]: JsonValue | undefined; + }; + /** + * **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + */ + originServerName: string; +} +/** + * Capability negotiation snapshot + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsDiagnoseCapability". + */ +/** @experimental */ +export interface McpAppsDiagnoseCapability { + /** + * Whether the session has the `mcp-apps` capability + */ + sessionHasMcpApps: boolean; + /** + * Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on + */ + featureFlagEnabled: boolean; + /** + * Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers + */ + advertised: boolean; +} +/** + * MCP server to diagnose MCP Apps wiring for. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsDiagnoseRequest". + */ +/** @experimental */ +export interface McpAppsDiagnoseRequest { + /** + * MCP server to probe + */ + serverName: string; +} +/** + * Diagnostic snapshot of MCP Apps wiring for the named server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsDiagnoseResult". + */ +/** @experimental */ +export interface McpAppsDiagnoseResult { + capability: McpAppsDiagnoseCapability; + server: McpAppsDiagnoseServer; +} +/** + * What the server returned for this session + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsDiagnoseServer". + */ +/** @experimental */ +export interface McpAppsDiagnoseServer { + /** + * Whether the named server is currently connected + */ + connected: boolean; + /** + * Total tools returned by the server's tools/list + */ + toolCount: number; + /** + * Tools whose `_meta.ui` is populated (resourceUri and/or visibility set) + */ + toolsWithUiMeta: number; + /** + * Up to 5 tool names with `_meta.ui` for quick inspection + */ + sampleToolNames: string[]; +} +/** + * Current host context advertised to MCP App guests. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsHostContext". + */ +/** @experimental */ +export interface McpAppsHostContext { + context: McpAppsHostContextDetails; +} +/** + * Current host context + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsHostContextDetails". + */ +/** @experimental */ +export interface McpAppsHostContextDetails { + theme?: McpAppsHostContextDetailsTheme; + /** + * BCP-47 locale, e.g. 'en-US' + */ + locale?: string; + /** + * IANA timezone, e.g. 'America/New_York' + */ + timeZone?: string; + displayMode?: McpAppsHostContextDetailsDisplayMode; + /** + * Display modes the host supports + */ + availableDisplayModes?: McpAppsHostContextDetailsAvailableDisplayMode[]; + platform?: McpAppsHostContextDetailsPlatform; + /** + * Host application identifier + */ + userAgent?: string; + [k: string]: unknown | undefined; +} +/** + * MCP server to list app-callable tools for. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsListToolsRequest". + */ +/** @experimental */ +export interface McpAppsListToolsRequest { + /** + * MCP server hosting the app + */ + serverName: string; + /** + * **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + */ + originServerName: string; +} +/** + * App-callable tools from the named MCP server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsListToolsResult". + */ +/** @experimental */ +export interface McpAppsListToolsResult { + /** + * App-callable tools from the server + */ + tools: { + [k: string]: JsonValue | undefined; + }[]; +} +/** + * MCP server and resource URI to fetch. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsReadResourceRequest". + */ +/** @experimental */ +export interface McpAppsReadResourceRequest { + /** + * Name of the MCP server hosting the resource + */ + serverName: string; + /** + * Resource URI (typically ui://...) + */ + uri: string; +} +/** + * Resource contents returned by the MCP server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsReadResourceResult". + */ +/** @experimental */ +export interface McpAppsReadResourceResult { + /** + * Resource contents returned by the server + */ + contents: McpAppsResourceContent[]; +} +/** + * MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsResourceContent". + */ +/** @experimental */ +export interface McpAppsResourceContent { + /** + * The resource URI (typically ui://...) + */ + uri: string; + /** + * MIME type of the content + */ + mimeType?: string; + /** + * Text content (e.g. HTML) + */ + text?: string; + /** + * Base64-encoded binary content + */ + blob?: string; + /** + * Resource-level metadata (CSP, permissions, etc.) + */ + _meta?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * Host context advertised to MCP App guests + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsSetHostContextDetails". + */ +/** @experimental */ +export interface McpAppsSetHostContextDetails { + theme?: McpAppsSetHostContextDetailsTheme; + /** + * BCP-47 locale, e.g. 'en-US' + */ + locale?: string; + /** + * IANA timezone, e.g. 'America/New_York' + */ + timeZone?: string; + displayMode?: McpAppsSetHostContextDetailsDisplayMode; + /** + * Display modes the host supports + */ + availableDisplayModes?: McpAppsSetHostContextDetailsAvailableDisplayMode[]; + platform?: McpAppsSetHostContextDetailsPlatform; + /** + * Host application identifier + */ + userAgent?: string; + [k: string]: unknown | undefined; +} +/** + * Host context to advertise to MCP App guests. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpAppsSetHostContextRequest". + */ +/** @experimental */ +export interface McpAppsSetHostContextRequest { + context: McpAppsSetHostContextDetails; +} +/** + * The requestId previously passed to executeSampling that should be cancelled. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpCancelSamplingExecutionParams". + */ +/** @experimental */ +export interface McpCancelSamplingExecutionParams { + /** + * The requestId previously passed to executeSampling that should be cancelled + */ + requestId: string; +} +/** + * Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpCancelSamplingExecutionResult". + */ +/** @experimental */ +export interface McpCancelSamplingExecutionResult { + /** + * True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). + */ + cancelled: boolean; +} +/** + * MCP server name and configuration to add to user configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigAddRequest". + */ +/** @experimental */ +export interface McpConfigAddRequest { + /** + * Unique name for the MCP server + */ + name: string; + config: McpServerConfig; +} +/** + * Stdio MCP server configuration launched as a child process. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigStdio". + */ +/** @experimental */ +export interface McpServerConfigStdio { + /** + * Tools to include. Defaults to all tools if not specified. + */ + tools?: string[]; + /** + * Whether this server is a built-in fallback used when the user has not configured their own server. + */ + isDefaultServer?: boolean; + filterMapping?: FilterMapping; + /** + * Timeout in milliseconds for tool calls to this server. + */ + timeout?: number; + oidc?: McpServerAuthConfig; + auth?: McpServerAuthConfig; + deferTools?: McpServerConfigDeferTools; + /** + * Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected. + */ + disableToolCache?: boolean; + /** + * Executable command used to start the Stdio MCP server process. + */ + command: string; + /** + * Command-line arguments passed to the Stdio MCP server process. + */ + args?: string[]; + /** + * Working directory for the Stdio MCP server process. + */ + cwd?: string; + /** + * Environment variables to pass to the Stdio MCP server process. + */ + env?: { + [k: string]: string | undefined; + }; +} +/** + * Authentication settings with optional redirect port configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerAuthConfigRedirectPort". + */ +/** @experimental */ +export interface McpServerAuthConfigRedirectPort { + /** + * Fixed port for the OAuth redirect callback server. + */ + redirectPort?: number; +} +/** + * Remote MCP server configuration accessed over HTTP or SSE. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerConfigHttp". + */ +/** @experimental */ +export interface McpServerConfigHttp { + /** + * Tools to include. Defaults to all tools if not specified. + */ + tools?: string[]; + type?: McpServerConfigHttpType; + /** + * Whether this server is a built-in fallback used when the user has not configured their own server. + */ + isDefaultServer?: boolean; + filterMapping?: FilterMapping; + /** + * Timeout in milliseconds for tool calls to this server. + */ + timeout?: number; + oidc?: McpServerAuthConfig; + auth?: McpServerAuthConfig; + deferTools?: McpServerConfigDeferTools; + /** + * Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected. + */ + disableToolCache?: boolean; + /** + * URL of the remote MCP server endpoint. + */ + url: string; + /** + * HTTP headers to include in requests to the remote MCP server. + */ + headers?: { + [k: string]: string | undefined; + }; + /** + * OAuth client ID for a pre-registered remote MCP OAuth client. + */ + oauthClientId?: string; + /** + * Whether the configured OAuth client is public and does not require a client secret. + */ + oauthPublicClient?: boolean; + oauthGrantType?: McpServerConfigHttpOauthGrantType; +} +/** + * MCP server names to disable for new sessions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigDisableRequest". + */ +/** @experimental */ +export interface McpConfigDisableRequest { + /** + * 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. + */ + names: string[]; +} +/** + * MCP server names to enable for new sessions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigEnableRequest". + */ +/** @experimental */ +export interface McpConfigEnableRequest { + /** + * 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. + */ + names: string[]; +} +/** + * User-configured MCP servers, keyed by server name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigList". + */ +/** @experimental */ +export interface McpConfigList { + /** + * All MCP servers from user config, keyed by name + */ + servers: { + [k: string]: McpServerConfig; + }; +} +/** + * MCP server name to remove from user configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigRemoveRequest". + */ +/** @experimental */ +export interface McpConfigRemoveRequest { + /** + * Name of the MCP server to remove + */ + name: string; +} +/** + * MCP server name and replacement configuration to write to user configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigUpdateRequest". + */ +/** @experimental */ +export interface McpConfigUpdateRequest { + /** + * Name of the MCP server to update + */ + name: string; + config: McpServerConfig; +} +/** + * Opaque auth info used to configure GitHub MCP. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigureGitHubRequest". + */ +/** @experimental */ +/** @internal */ +export interface McpConfigureGitHubRequest { + /** + * Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). + * + * @internal + */ + authInfo: OpaqueInProcessValue; +} +/** + * Result of configuring GitHub MCP. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpConfigureGitHubResult". + */ +/** @experimental */ +export interface McpConfigureGitHubResult { + /** + * Whether GitHub MCP configuration changed. + */ + changed: boolean; +} +/** + * Name of the MCP server to disable for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpDisableRequest". + */ +/** @experimental */ +export interface McpDisableRequest { + /** + * Name of the MCP server to disable + */ + serverName: string; +} +/** + * Optional working directory used as context for MCP server discovery. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpDiscoverRequest". + */ +/** @experimental */ +export interface McpDiscoverRequest { + /** + * Working directory used as context for discovery (e.g., plugin resolution) + */ + workingDirectory?: string; +} +/** + * MCP servers discovered from user, workspace, plugin, and built-in sources. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpDiscoverResult". + */ +/** @experimental */ +export interface McpDiscoverResult { + /** + * MCP servers discovered from all sources + */ + servers: DiscoveredMcpServer[]; +} +/** + * Name of the MCP server to enable for the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpEnableRequest". + */ +/** @experimental */ +export interface McpEnableRequest { + /** + * Name of the MCP server to enable + */ + serverName: string; +} +/** + * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpExecuteSamplingParams". + */ +/** @experimental */ +export interface McpExecuteSamplingParams { + /** + * Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. + */ + requestId: string; + /** + * Name of the MCP server that initiated the sampling request + */ + serverName: string; + /** + * The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). + */ + mcpRequestId: JsonValue; + request: McpExecuteSamplingRequest; +} +/** + * Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpExecuteSamplingRequest". + */ +/** @experimental */ +export interface McpExecuteSamplingRequest { + [k: string]: unknown | undefined; +} +/** + * MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpExecuteSamplingResult". + */ +/** @experimental */ +export interface McpExecuteSamplingResult { + [k: string]: unknown | undefined; +} +/** + * MCP server filtered by policy, with name, reason, and optional redacted reason. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpFilteredServer". + */ +/** @experimental */ +export interface McpFilteredServer { + /** + * Filtered server name + */ + name: string; + /** + * Human-readable filter reason + */ + reason: string; + /** + * PII-free filter reason + */ + redactedReason?: string; + /** + * @deprecated + * Deprecated. This field is no longer populated. + */ + enterpriseName?: string; +} +/** + * MCP headers refresh request id and the host response. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpHeadersHandlePendingHeadersRefreshRequestRequest". + */ +/** @experimental */ +export interface McpHeadersHandlePendingHeadersRefreshRequestRequest { + /** + * Headers refresh request identifier from mcp.headers_refresh_required + */ + requestId: string; + result: McpHeadersHandlePendingHeadersRefreshRequest; +} +/** + * Indicates whether the pending MCP headers refresh response was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpHeadersHandlePendingHeadersRefreshRequestResult". + */ +/** @experimental */ +export interface McpHeadersHandlePendingHeadersRefreshRequestResult { + /** + * Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + */ + success: boolean; +} +/** + * Host-level state, omitted when no MCP host is initialized. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpHostState". + */ +/** @experimental */ +export interface McpHostState { + /** + * Whether third-party MCP servers are policy-enabled for this session. + */ + mcp3pEnabled: boolean; + /** + * Configured servers that are explicitly disabled. + */ + disabledServers: string[]; + /** + * Configured servers filtered out by MCP server policy. + */ + filteredServers: string[]; + /** + * Names of currently-connected MCP clients. + */ + clients: string[]; + /** + * Names of servers with in-flight connection attempts. + */ + pendingConnections: string[]; + /** + * Map of server name to recorded connection failure. + */ + failedServers: { + [k: string]: McpServerFailureInfo | undefined; + }; + /** + * Map of server name to recorded pending-auth state. + */ + needsAuthServers: { + [k: string]: McpServerNeedsAuthInfo | undefined; + }; +} +/** + * Recorded MCP server connection failure. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerFailureInfo". + */ +/** @experimental */ +export interface McpServerFailureInfo { + /** + * Failure message produced when the MCP server connection failed. + */ + message: string; + /** + * epoch-ms timestamp at which the failure was recorded. + */ + timestamp: number; +} +/** + * Recorded MCP server pending-auth state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerNeedsAuthInfo". + */ +/** @experimental */ +export interface McpServerNeedsAuthInfo { + /** + * epoch-ms timestamp at which the server signalled it needs authentication. + */ + timestamp: number; +} +/** + * Server name to check running status for. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpIsServerRunningRequest". + */ +/** @experimental */ +export interface McpIsServerRunningRequest { + /** + * Name of the MCP server to check + */ + serverName: string; +} +/** + * Whether the named MCP server is running. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpIsServerRunningResult". + */ +/** @experimental */ +export interface McpIsServerRunningResult { + /** + * True if the server has an active client and transport. + */ + running: boolean; +} +/** + * Server name whose tool list should be returned. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpListToolsRequest". + */ +/** @experimental */ +export interface McpListToolsRequest { + /** + * Name of the connected MCP server whose tools to list. + */ + serverName: string; +} +/** + * Tools exposed by the connected MCP server. Throws when the server is not connected. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpListToolsResult". + */ +/** @experimental */ +export interface McpListToolsResult { + /** + * Tools exposed by the server. + */ + tools: McpTools[]; +} +/** + * MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpTools". + */ +/** @experimental */ +export interface McpTools { + /** + * Tool name. + */ + name: string; + /** + * Tool description, when provided. + */ + description?: string; + ui?: McpToolUi; +} +/** + * Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpToolUi". + */ +/** @experimental */ +export interface McpToolUi { + /** + * URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use `session.mcp.resources.read` to fetch its HTML and resource metadata. + */ + resourceUri?: string; + /** + * Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + */ + visibility?: McpToolUiVisibility[]; +} +/** + * Identifies the MCP server whose persisted OAuth credentials were updated. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthAuthenticationStateChangedRequest". + */ +/** @experimental */ +export interface McpOauthAuthenticationStateChangedRequest { + /** + * Name of the MCP server whose OAuth credentials were updated. Omit only when the host cannot identify the server. + */ + serverName?: string; + /** + * Whether the target session must mint a session-scoped access token instead of reusing a shared access token persisted by another session. + */ + refreshSessionToken?: boolean; +} +/** + * Pending MCP OAuth request ID and host-provided token or cancellation response. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthHandlePendingRequest". + */ +/** @experimental */ +export interface McpOauthHandlePendingRequest { + /** + * OAuth request identifier from the mcp.oauth_required event + */ + requestId: string; + result: McpOauthPendingRequestResponse; +} +/** + * Indicates whether the pending MCP OAuth response was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthHandlePendingResult". + */ +/** @experimental */ +export interface McpOauthHandlePendingResult { + /** + * Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + */ + success: boolean; +} +/** + * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthLoginRequest". + */ +/** @experimental */ +export interface McpOauthLoginRequest { + /** + * Name of the remote MCP server to authenticate + */ + serverName: string; + /** + * 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. + */ + forceReauth?: boolean; + /** + * 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. + */ + clientName?: string; + /** + * 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. + */ + callbackSuccessMessage?: string; + /** + * Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. + */ + clientId?: string; + /** + * Optional OAuth client secret override for this login. The runtime treats this as an ephemeral host-owned secret, uses it for this authentication attempt and does not persist it. + */ + clientSecret?: string; + /** + * Optional override indicating whether the static OAuth client is public. When false, the runtime treats it as confidential and uses the per-login clientSecret if provided, otherwise retrieving the client secret from the MCP OAuth secret store. + */ + publicClient?: boolean; + grantType?: McpOauthLoginGrantType; +} +/** + * OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthLoginResult". + */ +/** @experimental */ +export interface McpOauthLoginResult { + /** + * 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. + */ + authorizationUrl?: string; +} +/** + * Pending MCP OAuth request id to respond to. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthRespondRequest". + */ +/** @experimental */ +export interface McpOauthRespondRequest { + /** + * OAuth request identifier from the mcp.oauth_required event + */ + requestId: string; +} +/** + * Indicates whether the pending MCP OAuth response was accepted. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpOauthRespondResult". + */ +/** @experimental */ +export interface McpOauthRespondResult { + /** + * Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + */ + success: boolean; +} +/** + * Registration parameters for an external MCP client. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpRegisterExternalClientRequest". + */ +/** @experimental */ +/** @internal */ +export interface McpRegisterExternalClientRequest { + /** + * Logical server name for the external client + */ + serverName: string; + /** + * In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. + * + * @internal + */ + client: OpaqueInProcessValue; + /** + * In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. + * + * @internal + */ + transport: OpaqueInProcessValue; + /** + * In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. + * + * @internal + */ + config: OpaqueInProcessValue; +} +/** + * Opaque MCP reload configuration. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpReloadWithConfigRequest". + */ +/** @experimental */ +/** @internal */ +export interface McpReloadWithConfigRequest { + /** + * Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). + * + * @internal + */ + config: OpaqueInProcessValue; +} +/** + * Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpRemoveGitHubResult". + */ +/** @experimental */ +export interface McpRemoveGitHubResult { + /** + * True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). + */ + removed: boolean; +} +/** + * An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResource". + */ +/** @experimental */ +export interface McpResource { + /** + * The resource URI (e.g. ui://... or file:///...) + */ + uri: string; + /** + * The programmatic name of the resource + */ + name: string; + /** + * Optional human-readable display title + */ + title?: string; + /** + * Optional description of what this resource represents + */ + description?: string; + /** + * MIME type of the resource, if known + */ + mimeType?: string; + /** + * Resource size in bytes, when known + */ + size?: number; + /** + * Icons associated with this resource + */ + icons?: McpResourceIcon[]; + annotations?: McpResourceAnnotations; + /** + * Resource-level metadata + */ + _meta?: { + [k: string]: JsonValue | undefined; + }; + /** + * Server-provided non-standard descriptor fields preserved from the MCP response + */ + additionalProperties?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * A resource icon descriptor plus preserved non-standard icon fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourceIcon". + */ +/** @experimental */ +export interface McpResourceIcon { + /** + * Icon URI + */ + src: string; + /** + * Icon MIME type, when known + */ + mimeType?: string; + /** + * Icon sizes hint + */ + sizes?: string; + /** + * Theme hint for this icon + */ + theme?: string; + /** + * Server-provided non-standard icon fields preserved from the MCP response + */ + additionalProperties?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * Standard MCP resource annotations plus preserved non-standard annotation fields. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourceAnnotations". + */ +/** @experimental */ +export interface McpResourceAnnotations { + /** + * Intended audience roles for this resource + */ + audience?: string[]; + /** + * Priority hint for model/client use + */ + priority?: number; + /** + * Last-modified timestamp hint + */ + lastModified?: string; + /** + * Server-provided non-standard annotation fields preserved from the MCP response + */ + additionalProperties?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourceContent". + */ +/** @experimental */ +export interface McpResourceContent { + /** + * The resource URI + */ + uri: string; + /** + * MIME type of the content + */ + mimeType?: string; + /** + * Text content (e.g. HTML) + */ + text?: string; + /** + * Base64-encoded binary content + */ + blob?: string; + /** + * Resource-level metadata (CSP, permissions, etc.) + */ + _meta?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * MCP server whose resources to enumerate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesListRequest". + */ +/** @experimental */ +export interface McpResourcesListRequest { + /** + * Name of the MCP server whose resources to enumerate + */ + serverName: string; + /** + * Opaque MCP pagination cursor from a prior `nextCursor` value + */ + cursor?: string; +} +/** + * One page of resources advertised by the named MCP server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesListResult". + */ +/** @experimental */ +export interface McpResourcesListResult { + /** + * Resources advertised by the server (proxied MCP `resources/list`) + */ + resources: McpResource[]; + /** + * Opaque cursor for the next page, if the server has more resources + */ + nextCursor?: string; +} +/** + * MCP server whose resource templates to enumerate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesListTemplatesRequest". + */ +/** @experimental */ +export interface McpResourcesListTemplatesRequest { + /** + * Name of the MCP server whose resource templates to enumerate + */ + serverName: string; + /** + * Opaque MCP pagination cursor from a prior `nextCursor` value + */ + cursor?: string; +} +/** + * One page of resource templates advertised by the named MCP server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesListTemplatesResult". + */ +/** @experimental */ +export interface McpResourcesListTemplatesResult { + /** + * Resource templates advertised by the server (proxied MCP `resources/templates/list`) + */ + resourceTemplates: McpResourceTemplate[]; + /** + * Opaque cursor for the next page, if the server has more resource templates + */ + nextCursor?: string; +} +/** + * An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourceTemplate". + */ +/** @experimental */ +export interface McpResourceTemplate { + /** + * An RFC 6570 URI template for constructing resource URIs + */ + uriTemplate: string; + /** + * The programmatic name of the resource template + */ + name: string; + /** + * Optional human-readable display title + */ + title?: string; + /** + * Optional description of what this template is for + */ + description?: string; + /** + * MIME type for resources matching this template, if uniform + */ + mimeType?: string; + /** + * Icons associated with resources matching this template + */ + icons?: McpResourceIcon[]; + annotations?: McpResourceAnnotations; + /** + * Resource-template-level metadata + */ + _meta?: { + [k: string]: JsonValue | undefined; + }; + /** + * Server-provided non-standard descriptor fields preserved from the MCP response + */ + additionalProperties?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * MCP server and resource URI to fetch. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesReadRequest". + */ +/** @experimental */ +export interface McpResourcesReadRequest { + /** + * Name of the MCP server hosting the resource + */ + serverName: string; + /** + * Resource URI + */ + uri: string; +} +/** + * Resource contents returned by the MCP server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpResourcesReadResult". + */ +/** @experimental */ +export interface McpResourcesReadResult { + /** + * Resource contents returned by the server + */ + contents: McpResourceContent[]; +} +/** + * Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpRestartServerRequest". + */ +/** @experimental */ +export interface McpRestartServerRequest { + /** + * Name of the MCP server to restart + */ + serverName: string; + config?: McpServerConfig; +} +/** + * Outcome of an MCP sampling execution: success result, failure error, or cancellation. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSamplingExecutionResult". + */ +/** @experimental */ +export interface McpSamplingExecutionResult { + action: McpSamplingExecutionAction; + result?: McpExecuteSamplingResult; + /** + * Error description, present when action='failure'. + */ + error?: string; +} +/** + * MCP server status entry, including config source/plugin source and any connection error. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServer". + */ +/** @experimental */ +export interface McpServer { + /** + * Server name (config key) + */ + name: string; + status: McpServerStatus; + source?: McpServerSource; + /** + * Plugin name that provided this server, when source is plugin. + */ + sourcePlugin?: string; + /** + * Plugin version that provided this server, when source is plugin. + */ + sourcePluginVersion?: string; + /** + * Error message if the server failed to connect + */ + error?: string; +} +/** + * MCP servers configured for the session, with their connection status and host-level state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpServerList". + */ +/** @experimental */ +export interface McpServerList { + /** + * Configured MCP servers + */ + servers: McpServer[]; + host?: McpHostState; +} +/** + * Mode controlling how MCP server env values are resolved (`direct` or `indirect`). + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSetEnvValueModeParams". + */ +/** @experimental */ +export interface McpSetEnvValueModeParams { + mode: McpSetEnvValueModeDetails; +} +/** + * Env-value mode recorded on the session after the update. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpSetEnvValueModeResult". + */ +/** @experimental */ +export interface McpSetEnvValueModeResult { + mode: McpSetEnvValueModeDetails; +} +/** + * Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpStartServerRequest". + */ +/** @experimental */ +export interface McpStartServerRequest { + /** + * Name of the MCP server to start + */ + serverName: string; + config?: McpServerConfig; +} +/** + * MCP server startup filtering result. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpStartServersResult". + */ +/** @experimental */ +export interface McpStartServersResult { + /** + * Servers filtered out before startup + */ + filteredServers: McpFilteredServer[]; + /** + * Non-default servers allowed by policy + */ + allowedServers?: McpAllowedServer[]; +} +/** + * Server name for an individual MCP server stop. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "McpStopServerRequest". + */ +/** @experimental */ +export interface McpStopServerRequest { + /** + * Name of the MCP server to stop + */ + serverName: string; } /** - * The currently selected custom agent, or null when using the default agent. + * Server name identifying the external client to remove. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentGetCurrentResult". + * via the `definition` "McpUnregisterExternalClientRequest". */ /** @experimental */ -export interface AgentGetCurrentResult { +/** @internal */ +export interface McpUnregisterExternalClientRequest { /** - * Currently selected custom agent, or null if using the default agent + * Server name of the external client to unregister */ - agent?: AgentInfo | null; + serverName: string; } /** - * Schema for the `AgentInfo` type. + * Memory configuration for this session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentInfo". + * via the `definition` "MemoryConfiguration". */ /** @experimental */ -export interface AgentInfo { - /** - * Unique identifier of the custom agent - */ - name: string; +export interface MemoryConfiguration { /** - * Human-readable display name + * Whether memory is enabled for the session. */ - displayName: string; + enabled: boolean; +} +/** + * Per-source attribution breakdown for the session's current context window, or null if uninitialized. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataContextAttributionResult". + */ +/** @experimental */ +export interface MetadataContextAttributionResult { /** - * Description of the agent's purpose + * Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). */ - description: string; + contextAttribution?: SessionContextAttribution | null; +} +/** + * Parameters for the heaviest-messages query. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataContextHeaviestMessagesRequest". + */ +/** @experimental */ +export interface MetadataContextHeaviestMessagesRequest { /** - * Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. + * Maximum number of messages to return, most-expensive first. Omit for the server default. */ - path?: string; + limit?: number; +} +/** + * The heaviest individual messages in the session's context window, most-expensive first. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataContextHeaviestMessagesResult". + */ +/** @experimental */ +export interface MetadataContextHeaviestMessagesResult { /** - * Stable identifier for selection. For most agents this is the same as `name`; for plugin/builtin agents it may differ. Always populated; defaults to `name` when no distinct id was assigned. + * Total token count of the current context window, so callers can compute each message's share without a second call. */ - id: string; - source?: AgentInfoSource; + totalTokens: number; /** - * Whether the agent can be selected directly by the user. Agents marked `false` are subagent-only. + * Heaviest messages, most-expensive first. */ - userInvocable?: boolean; + messages: ContextHeaviestMessage[]; +} +/** + * Model identifier and token limits used to compute the context-info breakdown. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataContextInfoRequest". + */ +/** @experimental */ +export interface MetadataContextInfoRequest { /** - * Allowed tool names for this agent. Empty array means none; omitted means inherit defaults. + * Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. */ - tools?: string[]; + promptTokenLimit: number; /** - * Preferred model id for this agent. When omitted, inherits the outer agent's model. + * Maximum output tokens allowed by the target model. Pass 0 if unknown. */ - model?: string; + outputTokenLimit: number; /** - * MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema. - * - * @experimental + * Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. */ - mcpServers?: { - [k: string]: unknown | undefined; - }; + selectedModel?: string; +} +/** + * Token breakdown for the session's current context window, or null if uninitialized. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataContextInfoResult". + */ +/** @experimental */ +export interface MetadataContextInfoResult { /** - * Skill names preloaded into this agent's context. Omitted means none. + * Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). */ - skills?: string[]; + contextInfo?: SessionContextInfo | null; } /** - * Custom agents available to the session. + * Indicates whether the local session is currently processing a turn or background continuation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentList". + * via the `definition` "MetadataIsProcessingResult". */ /** @experimental */ -export interface AgentList { +export interface MetadataIsProcessingResult { /** - * Available custom agents + * Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. */ - agents: AgentInfo[]; + processing: boolean; } /** - * Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). + * Model identifier to use when re-tokenizing the session's existing messages. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistryLiveTargetEntry". + * via the `definition` "MetadataRecomputeContextTokensRequest". */ /** @experimental */ -export interface AgentRegistryLiveTargetEntry { +export interface MetadataRecomputeContextTokensRequest { /** - * Registry entry schema version (1 = ui-server, 2 = managed-server) + * Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. */ - schemaVersion: number; - kind: AgentRegistryLiveTargetEntryKind; + modelId: string; +} +/** + * Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataRecomputeContextTokensResult". + */ +/** @experimental */ +export interface MetadataRecomputeContextTokensResult { /** - * Operating-system pid of the process owning this entry + * Sum of tokens across chat-context and system-context messages currently held by the session. */ - pid: number; + totalTokens: number; /** - * Bind host for the entry's JSON-RPC server + * Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). */ - host: string; + messagesTokenCount: number; /** - * TCP port the entry's JSON-RPC server is listening on + * Tokens contributed by system/developer prompt snapshots. */ - port: number; + systemTokenCount: number; +} +/** + * Updated working-directory/git context to record on the session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "MetadataRecordContextChangeRequest". + */ +/** @experimental */ +export interface MetadataRecordContextChangeRequest { + context: SessionWorkingDirectoryContext; +} +/** + * Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionWorkingDirectoryContext". + */ +/** @experimental */ +export interface SessionWorkingDirectoryContext { /** - * Connection token (null when the target is unauthenticated) - * - * @internal + * Current working directory path */ - token?: string | null; + cwd: string; /** - * Session ID of the foreground session for this entry + * Root directory of the git repository, resolved via git rev-parse */ - sessionId?: string; + gitRoot?: string; /** - * Friendly session name (when set) + * Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) */ - sessionName?: string; + repository?: string; + hostType?: SessionWorkingDirectoryContextHostType; /** - * Working directory of the session (when known) + * Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") */ - cwd?: string; + repositoryHost?: string; /** - * Git branch of the session (when known) + * Current git branch name */ branch?: string; /** - * Model identifier currently selected for the session - */ - model?: string; - status?: AgentRegistryLiveTargetEntryStatus; - attentionKind?: AgentRegistryLiveTargetEntryAttentionKind; - /** - * Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips. - */ - statusRevision?: number; - lastTerminalEvent?: AgentRegistryLiveTargetEntryLastTerminalEvent; - /** - * ISO 8601 timestamp captured at registration - */ - startedAt: string; - /** - * Copilot CLI version that wrote the entry + * Head commit of the current git branch */ - copilotVersion: string; + headCommit?: string; /** - * Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness) + * Merge-base commit SHA (fork point from the remote default branch) */ - lastSeenMs: number; + baseCommit?: string; } /** - * Per-spawn log-capture outcome; populated from spawnLiveTarget. + * Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistryLogCapture". + * via the `definition` "MetadataRecordContextChangeResult". */ /** @experimental */ -export interface AgentRegistryLogCapture { - /** - * Whether per-spawn log capture is on (false when env-disabled or open failed) - */ - enabled: boolean; - /** - * Absolute path to the per-spawn log file (only set when enabled) - */ - path?: string; - /** - * Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used) - */ - openError?: string; - openErrorReason?: AgentRegistryLogCaptureOpenErrorReason; -} +export interface MetadataRecordContextChangeResult {} /** - * `child_process.spawn` itself failed before the child entered the registry. + * Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistrySpawnError". + * via the `definition` "MetadataSetWorkingDirectoryRequest". */ /** @experimental */ -export interface AgentRegistrySpawnError { - /** - * Discriminator: child_process.spawn itself failed - */ - kind: "spawn-error"; - /** - * Human-readable error message - */ - message: string; +export interface MetadataSetWorkingDirectoryRequest { /** - * Underlying errno code (e.g. ENOENT, EACCES) when available + * Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. */ - code?: string; + workingDirectory: string; } /** - * Spawn succeeded but the child did not publish a matching managed-server entry within the timeout. + * Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistrySpawnRegistryTimeout". + * via the `definition` "MetadataSetWorkingDirectoryResult". */ /** @experimental */ -export interface AgentRegistrySpawnRegistryTimeout { - /** - * Discriminator: spawn succeeded but child never registered - */ - kind: "registry-timeout"; +export interface MetadataSetWorkingDirectoryResult { /** - * Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance) + * Working directory after the update */ - childPid: number; - logCapture?: AgentRegistryLogCapture; + workingDirectory: string; } /** - * Inputs to spawn a managed-server child via the controller's spawn delegate. + * Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistrySpawnRequest". + * via the `definition` "MetadataSnapshotRemoteMetadata". */ /** @experimental */ -export interface AgentRegistrySpawnRequest { - /** - * Working directory for the spawned child (must be an existing directory) - */ - cwd: string; - /** - * Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default. - */ - agentName?: string; - /** - * Model identifier to apply to the new session - */ - model?: string; +export interface MetadataSnapshotRemoteMetadata { /** - * Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes. + * The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. */ - name?: string; - permissionMode?: AgentRegistrySpawnPermissionMode; + resourceId?: string; + repository: MetadataSnapshotRemoteMetadataRepository; /** - * Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path). + * The pull request number the remote session is associated with, if any. */ - initialPrompt?: string; + pullRequestNumber?: number; + taskType?: MetadataSnapshotRemoteMetadataTaskType; } /** - * Managed-server child was spawned and registered successfully. + * The repository the remote session targets. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistrySpawnSpawned". + * via the `definition` "MetadataSnapshotRemoteMetadataRepository". */ /** @experimental */ -export interface AgentRegistrySpawnSpawned { +export interface MetadataSnapshotRemoteMetadataRepository { /** - * Discriminator: managed-server child spawned successfully + * The GitHub owner (user or organization) of the target repository. */ - kind: "spawned"; - entry: AgentRegistryLiveTargetEntry; + owner: string; /** - * Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path. + * The GitHub repository name (without owner). */ - initialPromptSent?: boolean; + name: string; /** - * If the delegate attempted to send the initial prompt and failed, the categorized error message. + * The branch the remote session is operating on. */ - initialPromptError?: string; - logCapture?: AgentRegistryLogCapture; + branch: string; } /** - * Synchronous pre-validation rejected the spawn request. + * Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentRegistrySpawnValidationError". + * via the `definition` "Model". */ /** @experimental */ -export interface AgentRegistrySpawnValidationError { +export interface Model { /** - * Discriminator: synchronous pre-validation rejected the request + * Model identifier (e.g., "claude-sonnet-4.5") */ - kind: "validation-error"; - reason: AgentRegistrySpawnValidationErrorReason; - field?: AgentRegistrySpawnValidationErrorField; + id: string; /** - * Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry. + * Display name */ - message: string; + name: string; + capabilities: ModelCapabilities; + policy?: ModelPolicy; + billing?: ModelBilling; + /** + * Supported reasoning effort levels (only present if model supports reasoning effort) + */ + supportedReasoningEfforts?: string[]; + modelPickerCategory?: ModelPickerCategory; + modelPickerPriceCategory?: ModelPickerPriceCategory; } /** - * Custom agents available to the session after reloading definitions from disk. + * Model capabilities and limits * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentReloadResult". + * via the `definition` "ModelCapabilities". */ /** @experimental */ -export interface AgentReloadResult { - /** - * Reloaded custom agents - */ - agents: AgentInfo[]; +export interface ModelCapabilities { + supports?: ModelCapabilitiesSupports; + limits?: ModelCapabilitiesLimits; } /** - * Name of the custom agent to select for subsequent turns. + * Feature flags indicating what the model supports * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentSelectRequest". + * via the `definition` "ModelCapabilitiesSupports". */ /** @experimental */ -export interface AgentSelectRequest { +export interface ModelCapabilitiesSupports { /** - * Name of the custom agent to select + * Whether this model supports vision/image input */ - name: string; + vision?: boolean; + /** + * Whether this model supports reasoning effort configuration + */ + reasoningEffort?: boolean; + adaptive_thinking?: AdaptiveThinkingSupport; } /** - * The newly selected custom agent. + * Token limits for prompts, outputs, and context window * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AgentSelectResult". + * via the `definition` "ModelCapabilitiesLimits". */ /** @experimental */ -export interface AgentSelectResult { - agent: AgentInfo; +export interface ModelCapabilitiesLimits { + /** + * Maximum number of prompt/input tokens + */ + max_prompt_tokens?: number; + /** + * Maximum number of output/completion tokens + */ + max_output_tokens?: number; + /** + * Maximum total context window size in tokens + */ + max_context_window_tokens?: number; + vision?: ModelCapabilitiesLimitsVision; } /** - * Indicates whether the operation succeeded and reports the post-mutation state. + * Vision-specific limits * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AllowAllPermissionSetResult". + * via the `definition` "ModelCapabilitiesLimitsVision". */ /** @experimental */ -export interface AllowAllPermissionSetResult { +export interface ModelCapabilitiesLimitsVision { /** - * Whether the operation succeeded + * MIME types the model accepts */ - success: boolean; + supported_media_types: string[]; /** - * Authoritative allow-all state after the mutation + * Maximum number of images per prompt */ - enabled: boolean; + max_prompt_images: number; + /** + * Maximum image size in bytes + */ + max_prompt_image_size: number; } /** - * Current full allow-all permission state. + * Policy state (if applicable) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "AllowAllPermissionState". + * via the `definition` "ModelPolicy". */ /** @experimental */ -export interface AllowAllPermissionState { +export interface ModelPolicy { + state: ModelPolicyState; /** - * Whether full allow-all permissions are currently active + * Usage terms or conditions for this model */ - enabled: boolean; + terms?: string; } /** - * Schema for the `ApiKeyAuthInfo` type. + * Billing information * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ApiKeyAuthInfo". + * via the `definition` "ModelBilling". */ /** @experimental */ -export interface ApiKeyAuthInfo { - /** - * API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). - */ - type: "api-key"; +export interface ModelBilling { /** - * The API key. Treat as a secret. + * Billing cost multiplier relative to the base rate */ - apiKey: string; + multiplier?: number; + tokenPrices?: ModelBillingTokenPrices; /** - * Authentication host. + * Whole-number percentage discount (0-100) applied to usage billed through this model. Populated for the synthetic `auto` model, where requests routed by auto-mode are billed at a reduced rate; absent for concrete models. */ - host: string; - copilotUser?: CopilotUserResponse; + discountPercent?: number; + promo?: ModelBillingPromo; } /** - * Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + * Token-level pricing information for this model * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponse". + * via the `definition` "ModelBillingTokenPrices". */ /** @experimental */ -export interface CopilotUserResponse { - login?: string; - access_type_sku?: string; - analytics_tracking_id?: string; - assigned_date?: - | ( - | { - [k: string]: unknown | undefined; - } - | string - ) - | null; - can_signup_for_limited?: boolean; - chat_enabled?: boolean; - copilot_plan?: string; - copilotignore_enabled?: boolean; - endpoints?: CopilotUserResponseEndpoints; - organization_login_list?: string[]; - organization_list?: - | ( - | { - [k: string]: unknown | undefined; - } - | ({ - login?: - | ( - | { - [k: string]: unknown | undefined; - } - | string - ) - | null; - name?: - | ( - | { - [k: string]: unknown | undefined; - } - | string - ) - | null; - } | null)[] - ) - | null; - codex_agent_enabled?: boolean; - is_mcp_enabled?: - | ( - | { - [k: string]: unknown | undefined; - } - | boolean - ) - | null; - quota_reset_date?: string; - quota_snapshots?: CopilotUserResponseQuotaSnapshots; - restricted_telemetry?: boolean; - token_based_billing?: boolean; - quota_reset_date_utc?: string; - limited_user_quotas?: { - [k: string]: number | undefined; - }; - limited_user_reset_date?: string; - monthly_quotas?: { - [k: string]: number | undefined; - }; - cloud_session_storage_enabled?: boolean; - cli_remote_control_enabled?: boolean; +export interface ModelBillingTokenPrices { + /** + * AI Credits cost per billing batch of input tokens + */ + inputPrice?: number; + /** + * AI Credits cost per billing batch of output tokens + */ + outputPrice?: number; + /** + * @deprecated + * Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + */ + cachePrice?: number; + /** + * AI Credits cost per billing batch of cached (read) tokens + */ + cacheReadPrice?: number; + /** + * AI Credits cost per billing batch of cache-write (cache creation) tokens. + */ + cacheWritePrice?: number; + /** + * Number of tokens per standard billing batch + */ + batchSize?: number; + /** + * @deprecated + * Use maxPromptTokens instead. Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + */ + contextMax?: number; + /** + * Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + */ + maxPromptTokens?: number; + longContext?: ModelBillingTokenPricesLongContext; } /** - * Schema for the `CopilotUserResponseEndpoints` type. + * Long context tier pricing (available for models with extended context windows) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponseEndpoints". + * via the `definition` "ModelBillingTokenPricesLongContext". */ /** @experimental */ -export interface CopilotUserResponseEndpoints { - api?: string; - "origin-tracker"?: string; - proxy?: string; - telemetry?: string; +export interface ModelBillingTokenPricesLongContext { + /** + * AI Credits cost per billing batch of input tokens + */ + inputPrice?: number; + /** + * AI Credits cost per billing batch of output tokens + */ + outputPrice?: number; + /** + * @deprecated + * Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + */ + cachePrice?: number; + /** + * AI Credits cost per billing batch of cached (read) tokens + */ + cacheReadPrice?: number; + /** + * AI Credits cost per billing batch of cache-write (cache creation) tokens. + */ + cacheWritePrice?: number; + /** + * @deprecated + * Use maxPromptTokens instead. Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + */ + contextMax?: number; + /** + * Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + */ + maxPromptTokens?: number; } /** - * Schema for the `CopilotUserResponseQuotaSnapshots` type. + * Active server-driven promotion for a model, including its discount and optional expiry. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponseQuotaSnapshots". + * via the `definition` "ModelBillingPromo". */ /** @experimental */ -export interface CopilotUserResponseQuotaSnapshots { - chat?: CopilotUserResponseQuotaSnapshotsChat; - completions?: CopilotUserResponseQuotaSnapshotsCompletions; - premium_interactions?: CopilotUserResponseQuotaSnapshotsPremiumInteractions; - [k: string]: - | ({ - entitlement?: number; - overage_count?: number; - overage_permitted?: boolean; - percent_remaining?: number; - quota_id?: string; - quota_remaining?: number; - remaining?: number; - unlimited?: boolean; - timestamp_utc?: string; - has_quota?: boolean; - quota_reset_at?: number; - token_based_billing?: boolean; - } | null) - | undefined; +export interface ModelBillingPromo { + /** + * Stable identifier for the promotion campaign. + */ + id?: string; + /** + * Percentage discount (0-100) applied while the promotion is active. May be fractional. + */ + discountPercent?: number; + /** + * UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion omits this field. When present, the API only surfaces a promo whose expiry parses and is in the future, so consumers should treat a past value as expired. + */ + endsAt?: string; + /** + * Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present. + */ + message?: string; } /** - * Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. + * Optional capability overrides (vision, tool_calls, reasoning, etc.). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponseQuotaSnapshotsChat". + * via the `definition` "ModelCapabilitiesOverride". */ /** @experimental */ -export interface CopilotUserResponseQuotaSnapshotsChat { - entitlement?: number; - overage_count?: number; - overage_permitted?: boolean; - percent_remaining?: number; - quota_id?: string; - quota_remaining?: number; - remaining?: number; - unlimited?: boolean; - timestamp_utc?: string; - has_quota?: boolean; - quota_reset_at?: number; - token_based_billing?: boolean; +export interface ModelCapabilitiesOverride { + supports?: ModelCapabilitiesOverrideSupports; + limits?: ModelCapabilitiesOverrideLimits; } /** - * Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. + * Feature flags indicating what the model supports * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponseQuotaSnapshotsCompletions". + * via the `definition` "ModelCapabilitiesOverrideSupports". */ /** @experimental */ -export interface CopilotUserResponseQuotaSnapshotsCompletions { - entitlement?: number; - overage_count?: number; - overage_permitted?: boolean; - percent_remaining?: number; - quota_id?: string; - quota_remaining?: number; - remaining?: number; - unlimited?: boolean; - timestamp_utc?: string; - has_quota?: boolean; - quota_reset_at?: number; - token_based_billing?: boolean; +export interface ModelCapabilitiesOverrideSupports { + /** + * Whether this model supports vision/image input + */ + vision?: boolean; + /** + * Whether this model supports reasoning effort configuration + */ + reasoningEffort?: boolean; + adaptive_thinking?: AdaptiveThinkingSupport; } /** - * Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. + * Token limits for prompts, outputs, and context window * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotUserResponseQuotaSnapshotsPremiumInteractions". + * via the `definition` "ModelCapabilitiesOverrideLimits". */ /** @experimental */ -export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions { - entitlement?: number; - overage_count?: number; - overage_permitted?: boolean; - percent_remaining?: number; - quota_id?: string; - quota_remaining?: number; - remaining?: number; - unlimited?: boolean; - timestamp_utc?: string; - has_quota?: boolean; - quota_reset_at?: number; - token_based_billing?: boolean; +export interface ModelCapabilitiesOverrideLimits { + /** + * Maximum number of prompt/input tokens + */ + max_prompt_tokens?: number; + /** + * Maximum number of output/completion tokens + */ + max_output_tokens?: number; + /** + * Maximum total context window size in tokens + */ + max_context_window_tokens?: number; + vision?: ModelCapabilitiesOverrideLimitsVision; } /** - * Schema for the `HMACAuthInfo` type. + * Vision-specific limits * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HMACAuthInfo". + * via the `definition` "ModelCapabilitiesOverrideLimitsVision". */ /** @experimental */ -export interface HMACAuthInfo { +export interface ModelCapabilitiesOverrideLimitsVision { /** - * HMAC-based authentication used by GitHub-internal services. + * MIME types the model accepts */ - type: "hmac"; + supported_media_types?: string[]; /** - * Authentication host. HMAC auth always targets the public GitHub host. + * Maximum number of images per prompt */ - host: "https://github.com"; + max_prompt_images?: number; /** - * HMAC secret used to sign requests. + * Maximum image size in bytes */ - hmac: string; - copilotUser?: CopilotUserResponse; + max_prompt_image_size?: number; } /** - * Schema for the `EnvAuthInfo` type. + * List of Copilot models available to the resolved user, including capabilities and billing metadata. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EnvAuthInfo". + * via the `definition` "ModelList". */ /** @experimental */ -export interface EnvAuthInfo { - /** - * Personal access token (PAT) or server-to-server token sourced from an environment variable. - */ - type: "env"; +export interface ModelList { /** - * Authentication host (e.g. https://github.com or a GHES host). + * List of available models with full metadata */ - host: string; + models: Model[]; +} +/** + * Reasoning effort level to apply to the currently selected model. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ModelSetReasoningEffortRequest". + */ +/** @experimental */ +export interface ModelSetReasoningEffortRequest { /** - * User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). + * Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. */ - login?: string; + reasoningEffort: string; +} +/** + * Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ModelSetReasoningEffortResult". + */ +/** @experimental */ +export interface ModelSetReasoningEffortResult { /** - * The token value itself. Treat as a secret. + * Reasoning effort level recorded on the session after the update */ - token: string; + reasoningEffort: string; +} + +/** @experimental */ +export interface ModelsListRequest { /** - * Name of the environment variable the token was sourced from. + * 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. */ - envVar: string; - copilotUser?: CopilotUserResponse; + gitHubToken?: string; } /** - * Schema for the `TokenAuthInfo` type. + * Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "TokenAuthInfo". + * via the `definition` "ModelSwitchToRequest". */ /** @experimental */ -export interface TokenAuthInfo { +export interface ModelSwitchToRequest { /** - * SDK-side token authentication; the host configured the token directly via the SDK. + * Model selection id to switch to, as returned by `list`. A bare id (e.g. `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. */ - type: "token"; + modelId: string; /** - * Authentication host. + * Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted, no effort override is applied. */ - host: string; + reasoningEffort?: string; + reasoningSummary?: ReasoningSummary; + verbosity?: Verbosity; + modelCapabilities?: ModelCapabilitiesOverride; + contextTier?: ContextTier; /** - * The token value itself. Treat as a secret. + * When true, defer this switch (enqueue it) if another model change is already queued, even when no turn is active — so it drains last (FIFO) and wins over the already-queued change. Intended for genuine user-initiated model selections; internal restore/reapply switches omit it and apply immediately when no turn is active. When no other model change is queued this has no effect (a switch still applies immediately unless a turn is active). */ - token: string; - copilotUser?: CopilotUserResponse; + deferIfModelChangeQueued?: boolean; } /** - * Schema for the `CopilotApiTokenAuthInfo` type. + * The model identifier active on the session after the switch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CopilotApiTokenAuthInfo". + * via the `definition` "ModelSwitchToResult". */ /** @experimental */ -export interface CopilotApiTokenAuthInfo { +export interface ModelSwitchToResult { /** - * Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. + * Currently active model identifier after the switch */ - type: "copilot-api-token"; + modelId?: string; /** - * Authentication host (always the public GitHub host). + * True when the switch was deferred (enqueued as a cancellable `/model` command) because a turn was active or another model change was already queued, rather than applied immediately. When true, the session's live model is unchanged until the queued change drains. */ - host: "https://github.com"; - copilotUser?: CopilotUserResponse; + deferred?: boolean; } /** - * Schema for the `UserAuthInfo` type. + * Agent interaction mode to apply to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UserAuthInfo". + * via the `definition` "ModeSetRequest". */ /** @experimental */ -export interface UserAuthInfo { - /** - * OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct. - */ - type: "user"; - /** - * Authentication host. - */ - host: string; - /** - * OAuth user login. - */ - login: string; - copilotUser?: CopilotUserResponse; +export interface ModeSetRequest { + mode: SessionMode; } /** - * Schema for the `GhCliAuthInfo` type. + * A named BYOK provider connection (transport + credentials). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "GhCliAuthInfo". + * via the `definition` "NamedProviderConfig". */ /** @experimental */ -export interface GhCliAuthInfo { +export interface NamedProviderConfig { /** - * Authentication via the `gh` CLI's saved credentials. + * Stable identifier referenced by BYOK model definitions. Must not contain '/'. */ - type: "gh-cli"; + name: string; + type?: ProviderConfigType; + wireApi?: ProviderConfigWireApi; + transport?: ProviderConfigTransport; /** - * Authentication host. + * API endpoint URL. */ - host: string; + baseUrl: string; /** - * User login as reported by `gh auth status`. + * API key. Optional for local providers like Ollama. */ - login: string; + apiKey?: string; /** - * The token returned by `gh auth token`. Treat as a secret. + * Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. */ - token: string; - copilotUser?: CopilotUserResponse; + bearerToken?: string; + azure?: ProviderConfigAzure; + /** + * Custom HTTP headers to include in all outbound requests to the provider. + */ + headers?: { + [k: string]: string | undefined; + }; + /** + * When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. + */ + hasBearerTokenProvider?: boolean; } /** - * Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. + * Azure-specific provider options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasAction". + * via the `definition` "ProviderConfigAzure". */ /** @experimental */ -export interface CanvasAction { +export interface ProviderConfigAzure { /** - * Action name exposed by the canvas provider - */ - name: string; - /** - * Description of the action + * API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. */ - description?: string; - inputSchema?: CanvasJsonSchema; + apiVersion?: string; } /** - * JSON Schema for canvas open input + * The session's friendly name, or null when not yet set. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasJsonSchema". + * via the `definition` "NameGetResult". */ /** @experimental */ -export interface CanvasJsonSchema { - [k: string]: unknown | undefined; +export interface NameGetResult { + /** + * The session name (user-set or auto-generated), or null if not yet set + */ + name: string | null; } /** - * Canvas action invocation parameters. + * Auto-generated session summary to apply as the session's name when no user-set name exists. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasActionInvokeRequest". + * via the `definition` "NameSetAutoRequest". */ /** @experimental */ -export interface CanvasActionInvokeRequest { - /** - * Open canvas instance identifier - */ - instanceId: string; - /** - * Action name to invoke - */ - actionName: string; +export interface NameSetAutoRequest { /** - * Action input + * Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. */ - input?: { - [k: string]: unknown | undefined; - }; + summary: string; } /** - * Provider-supplied action result. + * Indicates whether the auto-generated summary was applied as the session's name. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasActionInvokeResult". + * via the `definition` "NameSetAutoResult". */ /** @experimental */ -export interface CanvasActionInvokeResult { - [k: string]: unknown | undefined; +export interface NameSetAutoResult { + /** + * Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. + */ + applied: boolean; } /** - * Canvas close parameters. + * New friendly name to apply to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasCloseRequest". + * via the `definition` "NameSetRequest". */ /** @experimental */ -export interface CanvasCloseRequest { +export interface NameSetRequest { /** - * Open canvas instance identifier + * New session name (1–100 characters, trimmed of leading/trailing whitespace) */ - instanceId: string; + name: string; } /** - * Host context supplied by the runtime. + * Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasHostContext". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicy". */ /** @experimental */ -export interface CanvasHostContext { - capabilities?: CanvasHostContextCapabilities; +export interface OptionsUpdateAdditionalContentExclusionPolicy { + rules: OptionsUpdateAdditionalContentExclusionPolicyRule[]; + last_updated_at: JsonValue; + scope: OptionsUpdateAdditionalContentExclusionPolicyScope; } /** - * Host capabilities + * Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasHostContextCapabilities". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRule". */ /** @experimental */ -export interface CanvasHostContextCapabilities { - /** - * Whether canvas rendering is supported - */ - canvases?: boolean; +export interface OptionsUpdateAdditionalContentExclusionPolicyRule { + paths: string[]; + ifAnyMatch?: string[]; + ifNoneMatch?: string[]; + source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource; } /** - * Declared canvases available in this session. + * Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasList". + * via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRuleSource". */ /** @experimental */ -export interface CanvasList { - /** - * Declared canvases available in this session - */ - canvases: DiscoveredCanvas[]; +export interface OptionsUpdateAdditionalContentExclusionPolicyRuleSource { + name: string; + type: string; } /** - * Canvas available in the current session. + * Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DiscoveredCanvas". + * via the `definition` "PendingPermissionRequest". */ /** @experimental */ -export interface DiscoveredCanvas { - /** - * Human-readable canvas name - */ - displayName: string; - /** - * Short, single-sentence description shown to the agent in canvas catalogs. - */ - description: string; - inputSchema?: CanvasJsonSchema; - /** - * Actions the agent or host may invoke on an open instance - */ - actions?: CanvasAction[]; - /** - * Owning provider identifier - */ - extensionId: string; - /** - * Owning extension display name, when available - */ - extensionName?: string; +export interface PendingPermissionRequest { /** - * Provider-local canvas identifier + * Unique identifier for the pending permission request */ - canvasId: string; + requestId: string; + request: PermissionPromptRequest; } /** - * Live open-canvas snapshot. + * List of pending permission requests reconstructed from event history. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasListOpenResult". + * via the `definition` "PendingPermissionRequestList". */ /** @experimental */ -export interface CanvasListOpenResult { +export interface PendingPermissionRequestList { /** - * Currently open canvas instances + * Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. */ - openCanvases: OpenCanvasInstance[]; + items: PendingPermissionRequest[]; } /** - * Open canvas instance snapshot. + * Permission-decision request variant to approve only the current permission request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "OpenCanvasInstance". + * via the `definition` "PermissionDecisionApproveOnce". */ /** @experimental */ -export interface OpenCanvasInstance { - /** - * Stable caller-supplied canvas instance identifier - */ - instanceId: string; - /** - * Owning provider identifier - */ - extensionId: string; - /** - * Owning extension display name, when available - */ - extensionName?: string; - /** - * Provider-local canvas identifier - */ - canvasId: string; - /** - * Rendered title - */ - title?: string; - /** - * Provider-supplied status text - */ - status?: string; - /** - * URL for web-rendered canvases - */ - url?: string; +export interface PermissionDecisionApproveOnce { /** - * Input supplied when the instance was opened + * Approve this single request only */ - input?: { - [k: string]: unknown | undefined; - }; + kind: "approve-once"; /** - * Whether this snapshot came from an idempotent reopen + * True only when a host surfaced this request to a user who approved it. */ - reopen: boolean; - availability: CanvasInstanceAvailability; + approvedInteractively?: boolean; } /** - * Canvas open parameters. + * Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasOpenRequest". + * via the `definition` "PermissionDecisionApproveForSession". */ /** @experimental */ -export interface CanvasOpenRequest { - /** - * Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. - */ - extensionId?: string; - /** - * Provider-local canvas identifier - */ - canvasId: string; +export interface PermissionDecisionApproveForSession { /** - * Caller-supplied stable instance identifier + * Approve and remember for the rest of the session */ - instanceId: string; + kind: "approve-for-session"; + approval?: PermissionDecisionApproveForSessionApproval; /** - * Canvas open input + * URL domain to approve for the rest of the session (URL prompts only) */ - input?: { - [k: string]: unknown | undefined; - }; + domain?: string; } /** - * Canvas close parameters sent to the provider. + * Session-scoped approval details for specific command identifiers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasProviderCloseRequest". + * via the `definition` "PermissionDecisionApproveForSessionApprovalCommands". */ /** @experimental */ -export interface CanvasProviderCloseRequest { - /** - * Target session identifier - */ - sessionId: string; - /** - * Owning provider identifier - */ - extensionId: string; +export interface PermissionDecisionApproveForSessionApprovalCommands { /** - * Provider-local canvas identifier + * Approval scoped to specific command identifiers. */ - canvasId: string; + kind: "commands"; /** - * Canvas instance identifier + * Command identifiers covered by this approval. */ - instanceId: string; - host?: CanvasHostContext; - session?: CanvasSessionContext; + commandIdentifiers: string[]; } /** - * Session context supplied by the runtime. + * Session-scoped approval details for read-only filesystem operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasSessionContext". + * via the `definition` "PermissionDecisionApproveForSessionApprovalRead". */ /** @experimental */ -export interface CanvasSessionContext { +export interface PermissionDecisionApproveForSessionApprovalRead { /** - * Active session working directory, when known. + * Approval covering read-only filesystem operations. */ - workingDirectory?: string; + kind: "read"; } /** - * Canvas action invocation parameters sent to the provider. + * Session-scoped approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasProviderInvokeActionRequest". + * via the `definition` "PermissionDecisionApproveForSessionApprovalWrite". */ /** @experimental */ -export interface CanvasProviderInvokeActionRequest { - /** - * Target session identifier - */ - sessionId: string; - /** - * Owning provider identifier - */ - extensionId: string; - /** - * Provider-local canvas identifier - */ - canvasId: string; - /** - * Canvas instance identifier - */ - instanceId: string; - /** - * Action name to invoke - */ - actionName: string; +export interface PermissionDecisionApproveForSessionApprovalWrite { /** - * Action input + * Approval covering filesystem write operations. */ - input?: { - [k: string]: unknown | undefined; - }; - host?: CanvasHostContext; - session?: CanvasSessionContext; + kind: "write"; } /** - * Canvas open parameters sent to the provider. + * Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasProviderOpenRequest". + * via the `definition` "PermissionDecisionApproveForSessionApprovalMcp". */ /** @experimental */ -export interface CanvasProviderOpenRequest { +export interface PermissionDecisionApproveForSessionApprovalMcp { /** - * Target session identifier + * Approval covering an MCP tool. */ - sessionId: string; + kind: "mcp"; /** - * Owning provider identifier + * MCP server name. */ - extensionId: string; + serverName: string; /** - * Provider-local canvas identifier + * MCP tool name, or null to cover every tool on the server. */ - canvasId: string; + toolName: string | null; +} +/** + * Session-scoped approval details for MCP sampling requests from a server. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForSessionApprovalMcpSampling". + */ +/** @experimental */ +export interface PermissionDecisionApproveForSessionApprovalMcpSampling { /** - * Stable caller-supplied canvas instance identifier + * Approval covering MCP sampling requests for a server. */ - instanceId: string; + kind: "mcp-sampling"; /** - * Canvas open input + * MCP server name. */ - input?: { - [k: string]: unknown | undefined; - }; - host?: CanvasHostContext; - session?: CanvasSessionContext; + serverName: string; } /** - * Canvas open result returned by the provider. + * Session-scoped approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CanvasProviderOpenResult". + * via the `definition` "PermissionDecisionApproveForSessionApprovalMemory". */ /** @experimental */ -export interface CanvasProviderOpenResult { +export interface PermissionDecisionApproveForSessionApprovalMemory { /** - * URL for web-rendered canvases + * Approval covering writes to long-term memory. */ - url?: string; + kind: "memory"; +} +/** + * Session-scoped approval details for a custom tool, keyed by tool name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForSessionApprovalCustomTool". + */ +/** @experimental */ +export interface PermissionDecisionApproveForSessionApprovalCustomTool { /** - * Provider-supplied title + * Approval covering a custom tool. */ - title?: string; + kind: "custom-tool"; /** - * Provider-supplied status text + * Custom tool name. */ - status?: string; + toolName: string; } /** - * Slash commands available in the session, after applying any include/exclude filters. + * Session-scoped approval details for extension-management operations, optionally narrowed by operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandList". + * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionManagement". */ /** @experimental */ -export interface CommandList { +export interface PermissionDecisionApproveForSessionApprovalExtensionManagement { /** - * Commands available in this session + * Approval covering extension lifecycle operations such as enable, disable, or reload. */ - commands: SlashCommandInfo[]; + kind: "extension-management"; + /** + * Optional operation identifier; when omitted, the approval covers all extension management operations. + */ + operation?: string; } /** - * Schema for the `SlashCommandInfo` type. + * Session-scoped factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SlashCommandInfo". + * via the `definition` "PermissionDecisionApproveForSessionApprovalFactory". */ /** @experimental */ -export interface SlashCommandInfo { - /** - * Canonical command name without a leading slash - */ - name: string; +export interface PermissionDecisionApproveForSessionApprovalFactory { /** - * Canonical aliases without leading slashes + * Approval covering factory operations. */ - aliases?: string[]; + kind: "factory"; /** - * Human-readable command description + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. */ - description: string; - kind: SlashCommandKind; - input?: SlashCommandInput; + approvalKey?: string; +} +/** + * Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess". + */ +/** @experimental */ +export interface PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { /** - * Whether the command may run while an agent turn is active + * Approval covering an extension's request to access a permission-gated capability. */ - allowDuringAgentExecution: boolean; + kind: "extension-permission-access"; /** - * Whether the command is experimental + * Extension name. */ - experimental?: boolean; + extensionName: string; } /** - * Optional unstructured input hint + * Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SlashCommandInput". + * via the `definition` "PermissionDecisionApproveForLocation". */ /** @experimental */ -export interface SlashCommandInput { - /** - * Hint to display when command input has not been provided - */ - hint: string; +export interface PermissionDecisionApproveForLocation { /** - * When true, the command requires non-empty input; clients should render the input hint as required + * Approve and persist for this project location */ - required?: boolean; - completion?: SlashCommandInputCompletion; + kind: "approve-for-location"; + approval: PermissionDecisionApproveForLocationApproval; /** - * When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace + * Location key (git root or cwd) to persist the approval to */ - preserveMultilineInput?: boolean; + locationKey: string; } /** - * Pending command request ID and an optional error if the client handler failed. + * Location-scoped approval details for specific command identifiers. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsHandlePendingCommandRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalCommands". */ /** @experimental */ -export interface CommandsHandlePendingCommandRequest { +export interface PermissionDecisionApproveForLocationApprovalCommands { /** - * Request ID from the command invocation event + * Approval scoped to specific command identifiers. */ - requestId: string; + kind: "commands"; /** - * Error message if the command handler failed + * Command identifiers covered by this approval. */ - error?: string; + commandIdentifiers: string[]; } /** - * Indicates whether the pending client-handled command was completed successfully. + * Location-scoped approval details for read-only filesystem operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsHandlePendingCommandResult". + * via the `definition` "PermissionDecisionApproveForLocationApprovalRead". */ /** @experimental */ -export interface CommandsHandlePendingCommandResult { +export interface PermissionDecisionApproveForLocationApprovalRead { /** - * Whether the command was handled successfully + * Approval covering read-only filesystem operations. */ - success: boolean; + kind: "read"; } /** - * Slash command name and optional raw input string to invoke. + * Location-scoped approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsInvokeRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalWrite". */ /** @experimental */ -export interface CommandsInvokeRequest { - /** - * Command name. Leading slashes are stripped and the name is matched case-insensitively. - */ - name: string; +export interface PermissionDecisionApproveForLocationApprovalWrite { /** - * Raw input after the command name + * Approval covering filesystem write operations. */ - input?: string; + kind: "write"; } /** - * Optional filters controlling which command sources to include in the listing. + * Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsListRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalMcp". */ /** @experimental */ -export interface CommandsListRequest { +export interface PermissionDecisionApproveForLocationApprovalMcp { /** - * Include runtime built-in commands + * Approval covering an MCP tool. */ - includeBuiltins?: boolean; + kind: "mcp"; /** - * Include enabled user-invocable skills and commands + * MCP server name. */ - includeSkills?: boolean; + serverName: string; /** - * Include commands registered by protocol clients, including SDK clients and extensions + * MCP tool name, or null to cover every tool on the server. */ - includeClientCommands?: boolean; + toolName: string | null; } /** - * Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). + * Location-scoped approval details for MCP sampling requests from a server. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsRespondToQueuedCommandRequest". + * via the `definition` "PermissionDecisionApproveForLocationApprovalMcpSampling". */ /** @experimental */ -export interface CommandsRespondToQueuedCommandRequest { +export interface PermissionDecisionApproveForLocationApprovalMcpSampling { /** - * Request ID from the `command.queued` event the host is responding to. + * Approval covering MCP sampling requests for a server. */ - requestId: string; - result: QueuedCommandResult; + kind: "mcp-sampling"; + /** + * MCP server name. + */ + serverName: string; } /** - * Schema for the `QueuedCommandHandled` type. + * Location-scoped approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuedCommandHandled". + * via the `definition` "PermissionDecisionApproveForLocationApprovalMemory". */ /** @experimental */ -export interface QueuedCommandHandled { - /** - * The host actually executed the queued command. - */ - handled: true; +export interface PermissionDecisionApproveForLocationApprovalMemory { /** - * When true, the runtime will not process subsequent queued commands until a new request comes in. + * Approval covering writes to long-term memory. */ - stopProcessingQueue?: boolean; + kind: "memory"; } /** - * Schema for the `QueuedCommandNotHandled` type. + * Location-scoped approval details for a custom tool, keyed by tool name. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuedCommandNotHandled". + * via the `definition` "PermissionDecisionApproveForLocationApprovalCustomTool". */ /** @experimental */ -export interface QueuedCommandNotHandled { +export interface PermissionDecisionApproveForLocationApprovalCustomTool { /** - * The host did not execute the queued command. Unblocks the queue without claiming the command was processed (e.g. when the handler threw before completing). + * Approval covering a custom tool. */ - handled: false; + kind: "custom-tool"; + /** + * Custom tool name. + */ + toolName: string; } /** - * Indicates whether the queued-command response was matched to a pending request. + * Location-scoped approval details for extension-management operations, optionally narrowed by operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CommandsRespondToQueuedCommandResult". + * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionManagement". */ /** @experimental */ -export interface CommandsRespondToQueuedCommandResult { +export interface PermissionDecisionApproveForLocationApprovalExtensionManagement { /** - * Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + * Approval covering extension lifecycle operations such as enable, disable, or reload. */ - success: boolean; + kind: "extension-management"; + /** + * Optional operation identifier; when omitted, the approval covers all extension management operations. + */ + operation?: string; } /** - * Metadata for a connected remote session. + * Location-scoped factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectedRemoteSessionMetadata". + * via the `definition` "PermissionDecisionApproveForLocationApprovalFactory". */ /** @experimental */ -export interface ConnectedRemoteSessionMetadata { - /** - * SDK session ID for the connected remote session. - */ - sessionId: string; +export interface PermissionDecisionApproveForLocationApprovalFactory { /** - * Optional friendly session name. + * Approval covering factory operations. */ - name?: string; + kind: "factory"; /** - * Optional session summary. + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. */ - summary?: string; + approvalKey?: string; +} +/** + * Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess". + */ +/** @experimental */ +export interface PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { /** - * Session start time as an ISO 8601 string. + * Approval covering an extension's request to access a permission-gated capability. */ - startTime: string; + kind: "extension-permission-access"; /** - * Last session update time as an ISO 8601 string. + * Extension name. */ - modifiedTime: string; - repository: ConnectedRemoteSessionMetadataRepository; + extensionName: string; +} +/** + * Permission-decision request variant to permanently approve a URL domain across sessions. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionApprovePermanently". + */ +/** @experimental */ +export interface PermissionDecisionApprovePermanently { /** - * Pull request number associated with the session. + * Approve and persist across sessions (URL prompts only) */ - pullRequestNumber?: number; + kind: "approve-permanently"; /** - * Original remote resource identifier. + * URL domain to approve permanently */ - resourceId?: string; - kind: ConnectedRemoteSessionMetadataKind; + domain: string; +} +/** + * Permission-decision request variant to reject a pending permission request, with optional feedback. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionDecisionReject". + */ +/** @experimental */ +export interface PermissionDecisionReject { /** - * Remote session staleness deadline as an ISO 8601 string. + * Reject the request */ - staleAt?: string; + kind: "reject"; /** - * Remote session state returned by the backing service. + * Optional feedback explaining the rejection */ - state?: string; + feedback?: string; } /** - * Repository associated with the connected remote session. + * Permission-decision variant indicating no user was available to confirm the request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectedRemoteSessionMetadataRepository". + * via the `definition` "PermissionDecisionUserNotAvailable". */ /** @experimental */ -export interface ConnectedRemoteSessionMetadataRepository { - /** - * Repository owner or organization login. - */ - owner: string; - /** - * Repository name. - */ - name: string; +export interface PermissionDecisionUserNotAvailable { /** - * Branch associated with the remote session. + * No user is available to confirm the request */ - branch: string; + kind: "user-not-available"; } /** - * Remote session connection parameters. + * Permission-decision variant indicating the request was approved. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectRemoteSessionParams". + * via the `definition` "PermissionDecisionApproved". */ /** @experimental */ -export interface ConnectRemoteSessionParams { +export interface PermissionDecisionApproved { /** - * Session ID to connect to. + * The permission request was approved */ - sessionId: string; + kind: "approved"; } /** - * Optional connection token presented by the SDK client during the handshake. + * Permission-decision variant indicating approval was remembered for the session, with approval details. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectRequest". + * via the `definition` "PermissionDecisionApprovedForSession". */ -/** @internal */ -export interface ConnectRequest { +/** @experimental */ +export interface PermissionDecisionApprovedForSession { /** - * Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN + * Approved and remembered for the rest of the session */ - token?: string; + kind: "approved-for-session"; + approval: UserToolSessionApproval; } /** - * Handshake result reporting the server's protocol version and package version on success. + * Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ConnectResult". + * via the `definition` "PermissionDecisionApprovedForLocation". */ -/** @internal */ -export interface ConnectResult { - /** - * Always true on success - */ - ok: true; +/** @experimental */ +export interface PermissionDecisionApprovedForLocation { /** - * Server protocol version number + * Approved and persisted for this project location */ - protocolVersion: number; + kind: "approved-for-location"; + approval: UserToolSessionApproval; /** - * Server package version + * The location key (git root or cwd) to persist the approval to */ - version: string; + locationKey: string; } /** - * The currently selected model, reasoning effort, and context tier for the session. + * Permission-decision variant indicating the request was cancelled before use, with an optional reason. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CurrentModel". + * via the `definition` "PermissionDecisionCancelled". */ /** @experimental */ -export interface CurrentModel { +export interface PermissionDecisionCancelled { /** - * Currently active model identifier + * The permission request was cancelled before a response was used */ - modelId?: string; + kind: "cancelled"; /** - * Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. + * Optional explanation of why the request was cancelled */ - reasoningEffort?: string; - contextTier?: ModelCurrentContextTier; + reason?: string; } /** - * Lightweight metadata for a currently initialized session tool + * Permission-decision variant indicating explicit denial by permission rules, with the matching rules. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "CurrentToolMetadata". + * via the `definition` "PermissionDecisionDeniedByRules". */ /** @experimental */ -export interface CurrentToolMetadata { - /** - * Model-facing tool name - */ - name: string; - /** - * Optional MCP/config namespaced tool name - */ - namespacedName?: string; - /** - * MCP server name for MCP-backed tools - */ - mcpServerName?: string; - /** - * Raw MCP tool name for MCP-backed tools - */ - mcpToolName?: string; - /** - * Tool description - */ - description: string; +export interface PermissionDecisionDeniedByRules { /** - * JSON Schema for tool input + * Denied because approval rules explicitly blocked it */ - input_schema?: { - [k: string]: unknown | undefined; - }; + kind: "denied-by-rules"; /** - * Whether the tool is loaded on demand via tool search + * Rules that denied the request */ - deferLoading?: boolean; + rules: PermissionRule[]; } /** - * Schema for the `DiscoveredMcpServer` type. + * Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "DiscoveredMcpServer". + * via the `definition` "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser". */ -export interface DiscoveredMcpServer { - /** - * Server name (config key) - */ - name: string; - type?: DiscoveredMcpServerType; - source: McpServerSource; +/** @experimental */ +export interface PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { /** - * Whether the server is enabled (not in the disabled list) + * Denied because no approval rule matched and user confirmation was unavailable */ - enabled: boolean; + kind: "denied-no-approval-rule-and-could-not-request-from-user"; } /** - * Slash-prefixed command string to enqueue for FIFO processing. + * Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EnqueueCommandParams". + * via the `definition` "PermissionDecisionDeniedInteractivelyByUser". */ /** @experimental */ -export interface EnqueueCommandParams { +export interface PermissionDecisionDeniedInteractivelyByUser { /** - * Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. + * Denied by the user during an interactive prompt */ - command: string; + kind: "denied-interactively-by-user"; + /** + * Optional feedback from the user explaining the denial + */ + feedback?: string; + /** + * Whether to force-reject the current agent turn + */ + forceReject?: boolean; } /** - * Indicates whether the command was accepted into the local execution queue. + * Permission-decision variant indicating denial by content-exclusion policy, with path and message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EnqueueCommandResult". + * via the `definition` "PermissionDecisionDeniedByContentExclusionPolicy". */ /** @experimental */ -export interface EnqueueCommandResult { +export interface PermissionDecisionDeniedByContentExclusionPolicy { /** - * True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). + * Denied by the organization's content exclusion policy */ - queued: boolean; + kind: "denied-by-content-exclusion-policy"; + /** + * File path that triggered the exclusion + */ + path: string; + /** + * Human-readable explanation of why the path was excluded + */ + message: string; } /** - * Cursor, batch size, and optional long-poll/filter parameters for reading session events. + * Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EventLogReadRequest". + * via the `definition` "PermissionDecisionDeniedByPermissionRequestHook". */ /** @experimental */ -export interface EventLogReadRequest { +export interface PermissionDecisionDeniedByPermissionRequestHook { /** - * Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. + * Denied by a permission request hook registered by an extension or plugin */ - cursor?: string; + kind: "denied-by-permission-request-hook"; /** - * Maximum number of events to return in this batch (1–1000, default 200). + * Optional message from the hook explaining the denial */ - max?: number; + message?: string; /** - * Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). + * Whether to interrupt the current agent turn */ - waitMs?: number; - types?: EventLogTypes; - agentScope?: EventsAgentScope; + interrupt?: boolean; } /** - * Indicates whether the operation succeeded. + * Optional informational context describing how and where the permission decision was made. This does not affect permission behavior. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EventLogReleaseInterestResult". + * via the `definition` "PermissionDecisionContext". */ /** @experimental */ -export interface EventLogReleaseInterestResult { - /** - * Whether the operation succeeded - */ - success: boolean; +export interface PermissionDecisionContext { + outcome: PermissionDecisionOutcome; + source: PermissionDecisionSource; + surface: PermissionDecisionSurface; } /** - * Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). + * Pending permission request ID and the decision to apply (approve/reject and scope). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EventLogTailResult". + * via the `definition` "PermissionDecisionRequest". */ /** @experimental */ -export interface EventLogTailResult { +export interface PermissionDecisionRequest { /** - * Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). + * Request ID of the pending permission request */ - cursor: string; + requestId: string; + result: PermissionDecision; + decisionContext?: PermissionDecisionContext; } /** - * Batch of session events returned by a read, with cursor and continuation metadata. + * Location-scoped tool approval to persist. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "EventsReadResult". + * via the `definition` "PermissionLocationAddToolApprovalParams". */ /** @experimental */ -export interface EventsReadResult { +export interface PermissionLocationAddToolApprovalParams { /** - * Events are delivered in two batches per read: persisted events first (in append order), then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral events do not interleave within a single read. + * Location key (git root or cwd) to persist the approval to */ - events: SessionEvent[]; + locationKey: string; + approval: PermissionsLocationsAddToolApprovalDetails; +} +/** + * Location-persisted tool approval details for specific command identifiers. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCommands". + */ +/** @experimental */ +export interface PermissionsLocationsAddToolApprovalDetailsCommands { /** - * Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. + * Approval scoped to specific command identifiers. */ - cursor: string; + kind: "commands"; /** - * True when the read returned `max` events and more events are available immediately. When false, the next read with a non-zero `waitMs` will block until a new event arrives or the wait expires. + * Command identifiers covered by this approval. */ - hasMore: boolean; - cursorStatus: EventsCursorStatus; + commandIdentifiers: string[]; } /** - * Slash command name and argument string to execute synchronously. + * Location-persisted tool approval details for read-only filesystem operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExecuteCommandParams". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsRead". */ /** @experimental */ -export interface ExecuteCommandParams { - /** - * Name of the slash command to invoke (without the leading '/'). - */ - commandName: string; +export interface PermissionsLocationsAddToolApprovalDetailsRead { /** - * Argument string to pass to the command (empty string if none). + * Approval covering read-only filesystem operations. */ - args: string; + kind: "read"; } /** - * Error message produced while executing the command, if any. + * Location-persisted tool approval details for filesystem write operations. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExecuteCommandResult". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsWrite". */ /** @experimental */ -export interface ExecuteCommandResult { +export interface PermissionsLocationsAddToolApprovalDetailsWrite { /** - * Error message produced while executing the command, if any. Omitted when the handler succeeded. + * Approval covering filesystem write operations. */ - error?: string; + kind: "write"; } /** - * Schema for the `Extension` type. + * Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Extension". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcp". */ /** @experimental */ -export interface Extension { +export interface PermissionsLocationsAddToolApprovalDetailsMcp { /** - * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper') + * Approval covering an MCP tool. */ - id: string; + kind: "mcp"; /** - * Extension name (directory name) + * MCP server name. */ - name: string; - source: ExtensionSource; - status: ExtensionStatus; + serverName: string; /** - * Process ID if the extension is running + * MCP tool name, or null to cover every tool on the server. */ - pid?: number; + toolName: string | null; } /** - * Extensions discovered for the session, with their current status. + * Location-persisted tool approval details for MCP sampling requests from a server. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionList". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcpSampling". */ /** @experimental */ -export interface ExtensionList { +export interface PermissionsLocationsAddToolApprovalDetailsMcpSampling { /** - * Discovered extensions and their current status + * Approval covering MCP sampling requests for a server. */ - extensions: Extension[]; + kind: "mcp-sampling"; + /** + * MCP server name. + */ + serverName: string; } /** - * Source-qualified extension identifier to disable for the session. + * Location-persisted tool approval details for writes to long-term memory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionsDisableRequest". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMemory". */ /** @experimental */ -export interface ExtensionsDisableRequest { +export interface PermissionsLocationsAddToolApprovalDetailsMemory { /** - * Source-qualified extension ID to disable + * Approval covering writes to long-term memory. */ - id: string; + kind: "memory"; } /** - * Source-qualified extension identifier to enable for the session. + * Location-persisted tool approval details for a custom tool, keyed by tool name. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExtensionsEnableRequest". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCustomTool". */ /** @experimental */ -export interface ExtensionsEnableRequest { +export interface PermissionsLocationsAddToolApprovalDetailsCustomTool { /** - * Source-qualified extension ID to enable + * Approval covering a custom tool. */ - id: string; + kind: "custom-tool"; + /** + * Custom tool name. + */ + toolName: string; } /** - * Expanded external tool result payload + * Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlm". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionManagement". */ /** @experimental */ -export interface ExternalToolTextResultForLlm { - /** - * Text result returned to the model - */ - textResultForLlm: string; - /** - * Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized. - */ - resultType?: string; - /** - * Optional error message for failed executions - */ - error?: string; - /** - * Detailed log content for timeline display - */ - sessionLog?: string; - /** - * Optional tool-specific telemetry - */ - toolTelemetry?: { - [k: string]: unknown | undefined; - }; +export interface PermissionsLocationsAddToolApprovalDetailsExtensionManagement { /** - * Base64-encoded binary results returned to the model + * Approval covering extension lifecycle operations such as enable, disable, or reload. */ - binaryResultsForLlm?: ExternalToolTextResultForLlmBinaryResultsForLlm[]; + kind: "extension-management"; /** - * Structured content blocks from the tool + * Optional operation identifier; when omitted, the approval covers all extension management operations. */ - contents?: ExternalToolTextResultForLlmContent[]; - [k: string]: unknown | undefined; + operation?: string; } /** - * Binary result returned by a tool for the model + * Location-persisted factory approval, optionally narrowed by approval key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmBinaryResultsForLlm". + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsFactory". */ /** @experimental */ -export interface ExternalToolTextResultForLlmBinaryResultsForLlm { - type: ExternalToolTextResultForLlmBinaryResultsForLlmType; +export interface PermissionsLocationsAddToolApprovalDetailsFactory { /** - * Base64-encoded binary data + * Approval covering factory operations. */ - data: string; + kind: "factory"; /** - * MIME type of the binary data + * Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. */ - mimeType: string; + approvalKey?: string; +} +/** + * Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess". + */ +/** @experimental */ +export interface PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { /** - * Human-readable description of the binary data + * Approval covering an extension's request to access a permission-gated capability. */ - description?: string; + kind: "extension-permission-access"; /** - * Optional metadata from the producing tool. + * Extension name. */ - metadata?: { - [k: string]: unknown | undefined; - }; + extensionName: string; } /** - * Plain text content block + * Working directory to load persisted location permissions for. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentText". + * via the `definition` "PermissionLocationApplyParams". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentText { - /** - * Content block type discriminator - */ - type: "text"; +export interface PermissionLocationApplyParams { /** - * The text content + * Working directory whose persisted location permissions should be applied */ - text: string; + workingDirectory: string; } /** - * Terminal/shell output content block with optional exit code and working directory + * Summary of persisted location permissions applied to the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentTerminal". + * via the `definition` "PermissionLocationApplyResult". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentTerminal { +export interface PermissionLocationApplyResult { /** - * Content block type discriminator + * Location key used in the location-permissions store */ - type: "terminal"; + locationKey: string; + locationType: PermissionLocationType; /** - * Terminal/shell output text + * Whether a different location was applied since the previous apply call */ - text: string; + changed: boolean; /** - * Process exit code, if the command has completed + * Number of location-scoped rules added to the live permission service */ - exitCode?: number; + appliedRuleCount: number; /** - * Working directory where the command was executed + * Number of persisted allowed directories added to the live path manager */ - cwd?: string; + appliedDirectoryCount: number; + /** + * Location-scoped rules applied to the live permission service + */ + appliedRules: PermissionRule[]; } /** - * Image content block with base64-encoded data + * Working directory to resolve into a location-permissions key. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentImage". + * via the `definition` "PermissionLocationResolveParams". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentImage { - /** - * Content block type discriminator - */ - type: "image"; - /** - * Base64-encoded image data - */ - data: string; +export interface PermissionLocationResolveParams { /** - * MIME type of the image (e.g., image/png, image/jpeg) + * Working directory whose permission location should be resolved */ - mimeType: string; + workingDirectory: string; } /** - * Audio content block with base64-encoded data + * Resolved location-permissions key and type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentAudio". + * via the `definition` "PermissionLocationResolveResult". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentAudio { - /** - * Content block type discriminator - */ - type: "audio"; - /** - * Base64-encoded audio data - */ - data: string; +export interface PermissionLocationResolveResult { /** - * MIME type of the audio (e.g., audio/wav, audio/mpeg) + * Location key used in the location-permissions store */ - mimeType: string; + locationKey: string; + locationType: PermissionLocationType; } /** - * Resource link content block referencing an external resource + * Directory path to add to the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentResourceLink". + * via the `definition` "PermissionPathsAddParams". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResourceLink { - /** - * Icons associated with this resource - */ - icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[]; - /** - * Resource name identifier - */ - name: string; - /** - * Human-readable display title for the resource - */ - title?: string; - /** - * URI identifying the resource - */ - uri: string; - /** - * Human-readable description of the resource - */ - description?: string; - /** - * MIME type of the resource content - */ - mimeType?: string; - /** - * Size of the resource in bytes - */ - size?: number; +export interface PermissionPathsAddParams { /** - * Content block type discriminator + * Directory to add to the allow-list. The runtime resolves and validates the path before adding. */ - type: "resource_link"; + path: string; } /** - * Icon image for a resource + * Path to evaluate against the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIcon". + * via the `definition` "PermissionPathsAllowedCheckParams". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResourceLinkIcon { - /** - * URL or path to the icon image - */ - src: string; - /** - * MIME type of the icon image - */ - mimeType?: string; +export interface PermissionPathsAllowedCheckParams { /** - * Available icon sizes (e.g., ['16x16', '32x32']) + * Path to check against the session's allowed directories */ - sizes?: string[]; - theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme; + path: string; } /** - * Embedded resource content block with inline text or binary data + * Indicates whether the supplied path is within the session's allowed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ExternalToolTextResultForLlmContentResource". + * via the `definition` "PermissionPathsAllowedCheckResult". */ /** @experimental */ -export interface ExternalToolTextResultForLlmContentResource { +export interface PermissionPathsAllowedCheckResult { /** - * Content block type discriminator + * Whether the path is within the session's allowed directories */ - type: "resource"; - resource: ExternalToolTextResultForLlmContentResourceDetails; + allowed: boolean; } /** - * Optional user prompt to combine with the fleet orchestration instructions. + * If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FleetStartRequest". + * via the `definition` "PermissionPathsConfig". */ /** @experimental */ -export interface FleetStartRequest { +export interface PermissionPathsConfig { + /** + * If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. + */ + unrestricted?: boolean; + /** + * Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). + */ + additionalDirectories?: string[]; + /** + * Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + */ + includeTempDirectory?: boolean; /** - * Optional user prompt to combine with fleet instructions + * Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. */ - prompt?: string; + workspacePath?: string; } /** - * Indicates whether fleet mode was successfully activated. + * Snapshot of the session's allow-listed directories and primary working directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FleetStartResult". + * via the `definition` "PermissionPathsList". */ /** @experimental */ -export interface FleetStartResult { +export interface PermissionPathsList { /** - * Whether fleet mode was successfully activated + * All directories currently allowed for tool access on this session. */ - started: boolean; + directories: string[]; + /** + * The primary working directory for this session. + */ + primary: string; } /** - * Folder path to add to trusted folders. + * Directory path to set as the session's new primary working directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FolderTrustAddParams". + * via the `definition` "PermissionPathsUpdatePrimaryParams". */ /** @experimental */ -export interface FolderTrustAddParams { +export interface PermissionPathsUpdatePrimaryParams { /** - * Folder path to mark as trusted + * Directory to set as the new primary working directory for the session's permission policy. */ path: string; } /** - * Folder path to check for trust. + * Path to evaluate against the session's workspace (primary) directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FolderTrustCheckParams". + * via the `definition` "PermissionPathsWorkspaceCheckParams". */ /** @experimental */ -export interface FolderTrustCheckParams { +export interface PermissionPathsWorkspaceCheckParams { /** - * Folder path to check + * Path to check against the session workspace directory */ path: string; } /** - * Folder trust check result. + * Indicates whether the supplied path is within the session's workspace directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "FolderTrustCheckResult". + * via the `definition` "PermissionPathsWorkspaceCheckResult". */ /** @experimental */ -export interface FolderTrustCheckResult { +export interface PermissionPathsWorkspaceCheckResult { /** - * Whether the folder is trusted + * Whether the path is within the session workspace directory */ - trusted: boolean; + allowed: boolean; } /** - * Pending external tool call request ID, with the tool result or an error describing why it failed. + * Notification payload describing the permission prompt that the client just rendered. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HandlePendingToolCallRequest". + * via the `definition` "PermissionPromptShownNotification". */ /** @experimental */ -export interface HandlePendingToolCallRequest { - /** - * Request ID of the pending tool call - */ - requestId: string; - result?: ExternalToolResult; +export interface PermissionPromptShownNotification { /** - * Error message if the tool call failed + * Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). */ - error?: string; + message: string; } /** - * Indicates whether the external tool call result was handled successfully. + * Indicates whether the permission decision was applied; false when the request was already resolved. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HandlePendingToolCallResult". + * via the `definition` "PermissionRequestResult". */ /** @experimental */ -export interface HandlePendingToolCallResult { +export interface PermissionRequestResult { /** - * Whether the tool call result was handled successfully + * Whether the permission request was handled successfully */ success: boolean; } /** - * Indicates whether an in-progress manual compaction was aborted. + * If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryAbortManualCompactionResult". + * via the `definition` "PermissionRulesSet". */ /** @experimental */ -export interface HistoryAbortManualCompactionResult { +export interface PermissionRulesSet { /** - * Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. + * Rules that auto-approve matching requests */ - aborted: boolean; + approved: PermissionRule[]; + /** + * Rules that auto-deny matching requests + */ + denied: PermissionRule[]; } /** - * Indicates whether an in-progress background compaction was cancelled. + * Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCancelBackgroundCompactionResult". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicy". */ /** @experimental */ -export interface HistoryCancelBackgroundCompactionResult { - /** - * Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. - */ - cancelled: boolean; +export interface PermissionsConfigureAdditionalContentExclusionPolicy { + rules: PermissionsConfigureAdditionalContentExclusionPolicyRule[]; + last_updated_at: JsonValue; + scope: PermissionsConfigureAdditionalContentExclusionPolicyScope; } /** - * Post-compaction context window usage breakdown + * Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactContextWindow". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRule". */ /** @experimental */ -export interface HistoryCompactContextWindow { - /** - * Maximum token count for the model's context window - */ - tokenLimit: number; - /** - * Current total tokens in the context window (system + conversation + tool definitions) - */ - currentTokens: number; - /** - * Current number of messages in the conversation - */ - messagesLength: number; - /** - * Token count from system message(s) - */ - systemTokens?: number; - /** - * Token count from non-system messages (user, assistant, tool) - */ - conversationTokens?: number; - /** - * Token count from tool definitions - */ - toolDefinitionsTokens?: number; +export interface PermissionsConfigureAdditionalContentExclusionPolicyRule { + paths: string[]; + ifAnyMatch?: string[]; + ifNoneMatch?: string[]; + source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource; } /** - * Optional compaction parameters. + * Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactRequest". + * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource". */ /** @experimental */ -export interface HistoryCompactRequest { - /** - * Optional user-provided instructions to focus the compaction summary - */ - customInstructions?: string; +export interface PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { + name: string; + type: string; } /** - * Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + * Patch of permission policy fields to apply (omit a field to leave it unchanged). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryCompactResult". + * via the `definition` "PermissionsConfigureParams". */ /** @experimental */ -export interface HistoryCompactResult { - /** - * Whether compaction completed successfully - */ - success: boolean; +export interface PermissionsConfigureParams { /** - * Number of tokens freed by compaction + * If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. */ - tokensRemoved: number; + approveAllToolPermissionRequests?: boolean; /** - * Number of messages removed during compaction + * If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. */ - messagesRemoved: number; + approveAllReadPermissionRequests?: boolean; + rules?: PermissionRulesSet; + paths?: PermissionPathsConfig; + urls?: PermissionUrlsConfig; /** - * Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + * If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. */ - summaryContent?: string; - contextWindow?: HistoryCompactContextWindow; + additionalContentExclusionPolicies?: PermissionsConfigureAdditionalContentExclusionPolicy[]; } /** - * Markdown summary of the conversation context (empty when not available). + * If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistorySummarizeForHandoffResult". + * via the `definition` "PermissionUrlsConfig". */ /** @experimental */ -export interface HistorySummarizeForHandoffResult { +export interface PermissionUrlsConfig { /** - * Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. + * If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. */ - summary: string; + unrestricted?: boolean; + /** + * Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. + */ + initialAllowed?: string[]; } /** - * Identifier of the event to truncate to; this event and all later events are removed. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryTruncateRequest". + * via the `definition` "PermissionsConfigureResult". */ /** @experimental */ -export interface HistoryTruncateRequest { +export interface PermissionsConfigureResult { /** - * Event ID to truncate to. This event and all events after it are removed from the session. + * Whether the operation succeeded */ - eventId: string; + success: boolean; } /** - * Number of events that were removed by the truncation. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "HistoryTruncateResult". + * via the `definition` "PermissionsFolderTrustAddTrustedResult". */ /** @experimental */ -export interface HistoryTruncateResult { +export interface PermissionsFolderTrustAddTrustedResult { /** - * Number of events that were removed + * Whether the operation succeeded */ - eventsRemoved: number; + success: boolean; } /** - * Schema for the `InstalledPlugin` type. + * No parameters. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPlugin". + * via the `definition` "PermissionsGetAllowAllRequest". */ /** @experimental */ -export interface InstalledPlugin { - /** - * Plugin name - */ - name: string; - /** - * Marketplace the plugin came from (empty string for direct repo installs) - */ - marketplace: string; - /** - * Version installed (if available) - */ - version?: string; - /** - * Installation timestamp - */ - installed_at: string; - /** - * Whether the plugin is currently enabled - */ - enabled: boolean; - /** - * Path where the plugin is cached locally - */ - cache_path?: string; - source?: InstalledPluginSource; -} +export interface PermissionsGetAllowAllRequest {} /** - * Schema for the `InstalledPluginSourceGithub` type. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceGithub". + * via the `definition` "PermissionsLocationsAddToolApprovalResult". */ /** @experimental */ -export interface InstalledPluginSourceGithub { +export interface PermissionsLocationsAddToolApprovalResult { /** - * Constant value. Always "github". + * Whether the operation succeeded */ - source: "github"; - repo: string; - ref?: string; - path?: string; + success: boolean; } /** - * Schema for the `InstalledPluginSourceUrl` type. + * Scope and add/remove instructions for modifying session- or location-scoped permission rules. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceUrl". + * via the `definition` "PermissionsModifyRulesParams". */ /** @experimental */ -export interface InstalledPluginSourceUrl { +export interface PermissionsModifyRulesParams { + scope: PermissionsModifyRulesScope; /** - * Constant value. Always "url". + * Rules to add to the scope. Applied before `remove`/`removeAll`. */ - source: "url"; - url: string; - ref?: string; - path?: string; + add?: PermissionRule[]; + /** + * Specific rules to remove from the scope. Ignored when `removeAll` is true. + */ + remove?: PermissionRule[]; + /** + * When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. + */ + removeAll?: boolean; } /** - * Schema for the `InstalledPluginSourceLocal` type. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstalledPluginSourceLocal". + * via the `definition` "PermissionsModifyRulesResult". */ /** @experimental */ -export interface InstalledPluginSourceLocal { +export interface PermissionsModifyRulesResult { /** - * Constant value. Always "local". + * Whether the operation succeeded */ - source: "local"; - path: string; + success: boolean; } /** - * Instruction sources loaded for the session, in merge order. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsGetSourcesResult". + * via the `definition` "PermissionsNotifyPromptShownResult". */ /** @experimental */ -export interface InstructionsGetSourcesResult { +export interface PermissionsNotifyPromptShownResult { /** - * Instruction sources for the session + * Whether the operation succeeded */ - sources: InstructionsSources[]; + success: boolean; } /** - * Schema for the `InstructionsSources` type. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "InstructionsSources". + * via the `definition` "PermissionsPathsAddResult". */ /** @experimental */ -export interface InstructionsSources { - /** - * Unique identifier for this source (used for toggling) - */ - id: string; - /** - * Human-readable label - */ - label: string; - /** - * File path relative to repo or absolute for home - */ - sourcePath: string; - /** - * Raw content of the instruction file - */ - content: string; - type: InstructionsSourcesType; - location: InstructionsSourcesLocation; - /** - * Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files - */ - applyTo?: string[]; - /** - * Short description (body after frontmatter) for use in instruction tables - */ - description?: string; +export interface PermissionsPathsAddResult { /** - * When true, this source starts disabled and must be toggled on by the user + * Whether the operation succeeded */ - defaultDisabled?: boolean; + success: boolean; } /** - * Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + * No parameters; returns the session's allow-listed directories. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LogRequest". + * via the `definition` "PermissionsPathsListRequest". */ /** @experimental */ -export interface LogRequest { - /** - * Human-readable message - */ - message: string; - level?: SessionLogLevel; - /** - * Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". - */ - type?: string; - /** - * When true, the message is transient and not persisted to the session event log on disk - */ - ephemeral?: boolean; - /** - * Optional URL the user can open in their browser for more details - */ - url?: string; - /** - * Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. - */ - tip?: string; -} +export interface PermissionsPathsListRequest {} /** - * Identifier of the session event that was emitted for the log message. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LogResult". + * via the `definition` "PermissionsPathsUpdatePrimaryResult". */ /** @experimental */ -export interface LogResult { +export interface PermissionsPathsUpdatePrimaryResult { /** - * The unique identifier of the emitted session event + * Whether the operation succeeded */ - eventId: string; + success: boolean; } /** - * Parameters for (re)loading the merged LSP configuration set. + * No parameters; returns currently-pending permission requests for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "LspInitializeRequest". + * via the `definition` "PermissionsPendingRequestsRequest". */ /** @experimental */ -export interface LspInitializeRequest { - /** - * Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. - */ - workingDirectory?: string; - /** - * Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). - */ - gitRoot?: string; - /** - * Force re-initialization even when LSP configs were already loaded for the working directory. - */ - force?: boolean; -} +export interface PermissionsPendingRequestsRequest {} /** - * MCP server, tool name, and arguments to invoke from an MCP App view. + * Clears session-scoped tool permission approvals, and optionally the location-scoped ones. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsCallToolRequest". + * via the `definition` "PermissionsResetSessionApprovalsRequest". */ /** @experimental */ -export interface McpAppsCallToolRequest { - /** - * MCP server hosting the tool - */ - serverName: string; - /** - * MCP tool name - */ - toolName: string; - /** - * Tool arguments - */ - arguments?: { - [k: string]: unknown | undefined; - }; +export interface PermissionsResetSessionApprovalsRequest { /** - * **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + * Whether location-scoped approvals are cleared too. Defaults to `true`. */ - originServerName: string; + includeLocation?: boolean; } /** - * Capability negotiation snapshot + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseCapability". + * via the `definition` "PermissionsResetSessionApprovalsResult". */ /** @experimental */ -export interface McpAppsDiagnoseCapability { - /** - * Whether the session has the `mcp-apps` capability - */ - sessionHasMcpApps: boolean; - /** - * Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on - */ - featureFlagEnabled: boolean; +export interface PermissionsResetSessionApprovalsResult { /** - * Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers + * Whether the operation succeeded */ - advertised: boolean; + success: boolean; } /** - * MCP server to diagnose MCP Apps wiring for. + * Allow-all mode to apply for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseRequest". + * via the `definition` "PermissionsSetAllowAllRequest". */ /** @experimental */ -export interface McpAppsDiagnoseRequest { +export interface PermissionsSetAllowAllRequest { + mode?: PermissionsAllowAllMode; /** - * MCP server to probe + * Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`. */ - serverName: string; + enabled?: boolean; + /** + * Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. + */ + model?: string; + source?: PermissionsSetAllowAllSource; } /** - * Diagnostic snapshot of MCP Apps wiring for the named server. + * Allow-all toggle for tool permission requests, with an optional telemetry source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseResult". + * via the `definition` "PermissionsSetApproveAllRequest". */ /** @experimental */ -export interface McpAppsDiagnoseResult { - capability: McpAppsDiagnoseCapability; - server: McpAppsDiagnoseServer; +export interface PermissionsSetApproveAllRequest { + /** + * Whether to auto-approve all tool permission requests + */ + enabled: boolean; + source?: PermissionsSetApproveAllSource; } /** - * What the server returned for this session + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsDiagnoseServer". + * via the `definition` "PermissionsSetApproveAllResult". */ /** @experimental */ -export interface McpAppsDiagnoseServer { - /** - * Whether the named server is currently connected - */ - connected: boolean; - /** - * Total tools returned by the server's tools/list - */ - toolCount: number; - /** - * Tools whose `_meta.ui` is populated (resourceUri and/or visibility set) - */ - toolsWithUiMeta: number; +export interface PermissionsSetApproveAllResult { /** - * Up to 5 tool names with `_meta.ui` for quick inspection + * Whether the operation succeeded */ - sampleToolNames: string[]; + success: boolean; } /** - * Current host context advertised to MCP App guests. + * Toggles whether permission prompts should be bridged into session events for this client. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsHostContext". + * via the `definition` "PermissionsSetRequiredRequest". */ /** @experimental */ -export interface McpAppsHostContext { - context: McpAppsHostContextDetails; +export interface PermissionsSetRequiredRequest { + /** + * Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). + */ + required: boolean; } /** - * Current host context + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsHostContextDetails". + * via the `definition` "PermissionsSetRequiredResult". */ /** @experimental */ -export interface McpAppsHostContextDetails { - theme?: McpAppsHostContextDetailsTheme; - /** - * BCP-47 locale, e.g. 'en-US' - */ - locale?: string; - /** - * IANA timezone, e.g. 'America/New_York' - */ - timeZone?: string; - displayMode?: McpAppsHostContextDetailsDisplayMode; - /** - * Display modes the host supports - */ - availableDisplayModes?: McpAppsHostContextDetailsAvailableDisplayMode[]; - platform?: McpAppsHostContextDetailsPlatform; +export interface PermissionsSetRequiredResult { /** - * Host application identifier + * Whether the operation succeeded */ - userAgent?: string; - [k: string]: unknown | undefined; + success: boolean; } /** - * MCP server to list app-callable tools for. + * Indicates whether the operation succeeded. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsListToolsRequest". + * via the `definition` "PermissionsUrlsSetUnrestrictedModeResult". */ /** @experimental */ -export interface McpAppsListToolsRequest { - /** - * MCP server hosting the app - */ - serverName: string; +export interface PermissionsUrlsSetUnrestrictedModeResult { /** - * **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + * Whether the operation succeeded */ - originServerName: string; + success: boolean; } /** - * App-callable tools from the named MCP server. + * Whether the URL-permission policy should run in unrestricted mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsListToolsResult". + * via the `definition` "PermissionUrlsSetUnrestrictedModeParams". */ /** @experimental */ -export interface McpAppsListToolsResult { +export interface PermissionUrlsSetUnrestrictedModeParams { /** - * App-callable tools from the server + * Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. */ - tools: { - [k: string]: unknown | undefined; - }[]; + enabled: boolean; } /** - * MCP server and resource URI to fetch. + * Optional message to echo back to the caller. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsReadResourceRequest". + * via the `definition` "PingRequest". */ /** @experimental */ -export interface McpAppsReadResourceRequest { - /** - * Name of the MCP server hosting the resource - */ - serverName: string; +export interface PingRequest { /** - * Resource URI (typically ui://...) + * Optional message to echo back */ - uri: string; + message?: string; } /** - * Resource contents returned by the MCP server. + * Server liveness response, including the echoed message, current server timestamp, and protocol version. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsReadResourceResult". + * via the `definition` "PingResult". */ /** @experimental */ -export interface McpAppsReadResourceResult { +export interface PingResult { /** - * Resource contents returned by the server + * Echoed message (or default greeting) */ - contents: McpAppsResourceContent[]; + message: string; + /** + * ISO 8601 timestamp when the server handled the ping + */ + timestamp: string; + /** + * Server protocol version number + */ + protocolVersion: number; } /** - * Schema for the `McpAppsResourceContent` type. + * Existence, contents, and resolved path of the session plan file. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsResourceContent". + * via the `definition` "PlanReadResult". */ /** @experimental */ -export interface McpAppsResourceContent { - /** - * The resource URI (typically ui://...) - */ - uri: string; +export interface PlanReadResult { /** - * MIME type of the content + * Whether the plan file exists in the workspace */ - mimeType?: string; + exists: boolean; /** - * Text content (e.g. HTML) + * The content of the plan file, or null if it does not exist */ - text?: string; + content: string | null; /** - * Base64-encoded binary content + * Absolute file path of the plan file, or null if workspace is not enabled */ - blob?: string; + path: string | null; +} +/** + * Todo rows read from the session SQL database. Empty when no session database is available. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PlanReadSqlTodosResult". + */ +/** @experimental */ +export interface PlanReadSqlTodosResult { /** - * Resource-level metadata (CSP, permissions, etc.) + * Rows from the session SQL todos table, ordered by creation time and id. */ - _meta?: { - [k: string]: unknown | undefined; - }; + rows: PlanSqlTodosRow[]; } /** - * Host context advertised to MCP App guests + * A single todo row read from the session SQL `todos` table. All fields are optional because the SQL schema is best-effort and the agent may not have populated every column. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsSetHostContextDetails". + * via the `definition` "PlanSqlTodosRow". */ /** @experimental */ -export interface McpAppsSetHostContextDetails { - theme?: McpAppsSetHostContextDetailsTheme; +export interface PlanSqlTodosRow { /** - * BCP-47 locale, e.g. 'en-US' + * Todo identifier. */ - locale?: string; + id?: string; /** - * IANA timezone, e.g. 'America/New_York' + * Todo title. */ - timeZone?: string; - displayMode?: McpAppsSetHostContextDetailsDisplayMode; + title?: string; /** - * Display modes the host supports + * Todo description. */ - availableDisplayModes?: McpAppsSetHostContextDetailsAvailableDisplayMode[]; - platform?: McpAppsSetHostContextDetailsPlatform; + description?: string; /** - * Host application identifier + * Todo status. */ - userAgent?: string; - [k: string]: unknown | undefined; -} -/** - * Host context to advertise to MCP App guests. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpAppsSetHostContextRequest". - */ -/** @experimental */ -export interface McpAppsSetHostContextRequest { - context: McpAppsSetHostContextDetails; + status?: string; } /** - * The requestId previously passed to executeSampling that should be cancelled. + * Todo rows + dependency edges read from the session SQL database. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpCancelSamplingExecutionParams". + * via the `definition` "PlanReadSqlTodosWithDependenciesResult". */ /** @experimental */ -export interface McpCancelSamplingExecutionParams { +export interface PlanReadSqlTodosWithDependenciesResult { /** - * The requestId previously passed to executeSampling that should be cancelled + * Rows from the session SQL todos table, ordered by creation time and id. Empty when no database, no todos table, or the SELECT failed. */ - requestId: string; + rows: PlanSqlTodosRow[]; + /** + * Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does not affect the rows result and vice versa. + */ + dependencies: PlanSqlTodoDependency[]; } /** - * Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + * A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpCancelSamplingExecutionResult". + * via the `definition` "PlanSqlTodoDependency". */ /** @experimental */ -export interface McpCancelSamplingExecutionResult { +export interface PlanSqlTodoDependency { /** - * True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). + * ID of the todo that has the dependency. */ - cancelled: boolean; + todoId: string; + /** + * ID of the todo it depends on. + */ + dependsOn: string; } /** - * MCP server name and configuration to add to user configuration. + * Replacement contents to write to the session plan file. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigAddRequest". + * via the `definition` "PlanUpdateRequest". */ -export interface McpConfigAddRequest { +/** @experimental */ +export interface PlanUpdateRequest { /** - * Unique name for the MCP server + * The new content for the plan file */ - name: string; - config: McpServerConfig; + content: string; } /** - * Stdio MCP server configuration launched as a child process. + * Session plugin metadata, with name, marketplace, optional version, and enabled state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerConfigStdio". + * via the `definition` "Plugin". */ -export interface McpServerConfigStdio { +/** @experimental */ +export interface Plugin { /** - * Tools to include. Defaults to all tools if not specified. + * Plugin name */ - tools?: string[]; + name: string; /** - * Whether this server is a built-in fallback used when the user has not configured their own server. + * Marketplace the plugin came from */ - isDefaultServer?: boolean; - filterMapping?: FilterMapping; + marketplace: string; /** - * Timeout in milliseconds for tool calls to this server. + * Installed version */ - timeout?: number; - oidc?: McpServerAuthConfig; - auth?: McpServerAuthConfig; + version?: string; /** - * Executable command used to start the Stdio MCP server process. + * Whether the plugin is currently enabled */ - command: string; + enabled: boolean; +} +/** + * Result of installing a plugin. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PluginInstallResult". + */ +/** @experimental */ +export interface PluginInstallResult { + plugin: InstalledPluginInfo; /** - * Command-line arguments passed to the Stdio MCP server process. + * Number of skills discovered and installed from the plugin */ - args?: string[]; + skillsInstalled: number; /** - * Working directory for the Stdio MCP server process. + * Optional post-install message provided by the plugin (e.g. setup instructions) */ - cwd?: string; + postInstallMessage?: string; /** - * Environment variables to pass to the Stdio MCP server process. + * Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. */ - env?: { - [k: string]: string | undefined; - }; + deprecationWarning?: string; } /** - * Authentication settings with optional redirect port configuration. + * Plugins installed for the session, with their enabled state and version metadata. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerAuthConfigRedirectPort". + * via the `definition` "PluginList". */ -export interface McpServerAuthConfigRedirectPort { +/** @experimental */ +export interface PluginList { /** - * Fixed port for the OAuth redirect callback server. + * Installed plugins */ - redirectPort?: number; - [k: string]: unknown | undefined; + plugins: Plugin[]; } /** - * Remote MCP server configuration accessed over HTTP or SSE. + * Plugins installed in user/global state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerConfigHttp". + * via the `definition` "PluginListResult". */ -export interface McpServerConfigHttp { - /** - * Tools to include. Defaults to all tools if not specified. - */ - tools?: string[]; - type?: McpServerConfigHttpType; - /** - * Whether this server is a built-in fallback used when the user has not configured their own server. - */ - isDefaultServer?: boolean; - filterMapping?: FilterMapping; - /** - * Timeout in milliseconds for tool calls to this server. - */ - timeout?: number; - oidc?: McpServerAuthConfig; - auth?: McpServerAuthConfig; - /** - * URL of the remote MCP server endpoint. - */ - url: string; - /** - * HTTP headers to include in requests to the remote MCP server. - */ - headers?: { - [k: string]: string | undefined; - }; +/** @experimental */ +export interface PluginListResult { /** - * OAuth client ID for a pre-registered remote MCP OAuth client. + * Installed plugins */ - oauthClientId?: string; + plugins: InstalledPluginInfo[]; +} +/** + * Plugin names (or specs) to disable. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "PluginsDisableRequest". + */ +/** @experimental */ +export interface PluginsDisableRequest { /** - * Whether the configured OAuth client is public and does not require a client secret. + * Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins. */ - oauthPublicClient?: boolean; - oauthGrantType?: McpServerConfigHttpOauthGrantType; + names: string[]; } /** - * MCP server names to disable for new sessions. + * Plugin names (or specs) to enable. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigDisableRequest". + * via the `definition` "PluginsEnableRequest". */ -export interface McpConfigDisableRequest { +/** @experimental */ +export interface PluginsEnableRequest { /** - * 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. + * Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API. */ names: string[]; } /** - * MCP server names to enable for new sessions. + * Plugin source and optional working directory for relative-path resolution. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigEnableRequest". + * via the `definition` "PluginsInstallRequest". */ -export interface McpConfigEnableRequest { +/** @experimental */ +export interface PluginsInstallRequest { /** - * 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. + * Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result. */ - names: string[]; + source: string; + /** + * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + */ + workingDirectory?: string; } /** - * User-configured MCP servers, keyed by server name. + * Marketplace source and optional working directory for relative-path resolution. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigList". + * via the `definition` "PluginsMarketplacesAddRequest". */ -export interface McpConfigList { +/** @experimental */ +export interface PluginsMarketplacesAddRequest { /** - * All MCP servers from user config, keyed by name + * Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL (user@host:path), or a local path. The marketplace's own name (from its manifest) is used as the registration key. */ - servers: { - [k: string]: McpServerConfig; - }; + source: string; + /** + * Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + */ + workingDirectory?: string; } /** - * MCP server name to remove from user configuration. + * Name of the marketplace whose plugin catalog to fetch. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigRemoveRequest". + * via the `definition` "PluginsMarketplacesBrowseRequest". */ -export interface McpConfigRemoveRequest { +/** @experimental */ +export interface PluginsMarketplacesBrowseRequest { /** - * Name of the MCP server to remove + * Marketplace name to browse */ name: string; } + +/** @experimental */ +export interface PluginsMarketplacesRefreshRequest { + /** + * Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + */ + name?: string; +} /** - * MCP server name and replacement configuration to write to user configuration. + * Name of the marketplace to remove and an optional force flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpConfigUpdateRequest". + * via the `definition` "PluginsMarketplacesRemoveRequest". */ -export interface McpConfigUpdateRequest { +/** @experimental */ +export interface PluginsMarketplacesRemoveRequest { /** - * Name of the MCP server to update + * Marketplace name to remove */ name: string; - config: McpServerConfig; + /** + * When true, also uninstall every plugin sourced from this marketplace. When false (default), removal is a no-op if any plugin from this marketplace is installed and the dependent plugin names are returned in the result. + */ + force?: boolean; } /** - * Name of the MCP server to disable for the session. + * Name (or spec) of the plugin to uninstall. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpDisableRequest". + * via the `definition` "PluginsUninstallRequest". */ /** @experimental */ -export interface McpDisableRequest { +export interface PluginsUninstallRequest { /** - * Name of the MCP server to disable + * Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. */ - serverName: string; + name: string; + /** + * Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. + */ + directSourceId?: string | null; } /** - * Optional working directory used as context for MCP server discovery. + * Name (or spec) of the plugin to update. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpDiscoverRequest". + * via the `definition` "PluginsUpdateRequest". */ -export interface McpDiscoverRequest { +/** @experimental */ +export interface PluginsUpdateRequest { /** - * Working directory used as context for discovery (e.g., plugin resolution) + * Plugin name or "plugin@marketplace" spec to update. */ - workingDirectory?: string; + name: string; } /** - * MCP servers discovered from user, workspace, plugin, and built-in sources. + * Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpDiscoverResult". + * via the `definition` "PluginUpdateAllEntry". */ -export interface McpDiscoverResult { +/** @experimental */ +export interface PluginUpdateAllEntry { /** - * MCP servers discovered from all sources + * Plugin name that was updated */ - servers: DiscoveredMcpServer[]; + name: string; + /** + * Marketplace the plugin came from. Empty string ("") for direct installs. + */ + marketplace: string; + /** + * Whether the update succeeded for this plugin + */ + success: boolean; + /** + * Previously installed version, when available + */ + previousVersion?: string; + /** + * Version after the update, when available + */ + newVersion?: string; + /** + * Number of skills installed after the update (success only) + */ + skillsInstalled?: number; + /** + * Error message (failure only) + */ + error?: string; } /** - * Name of the MCP server to enable for the session. + * Result of updating all installed plugins. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpEnableRequest". + * via the `definition` "PluginUpdateAllResult". */ /** @experimental */ -export interface McpEnableRequest { +export interface PluginUpdateAllResult { /** - * Name of the MCP server to enable + * Per-plugin update results in deterministic order. */ - serverName: string; + results: PluginUpdateAllEntry[]; } /** - * Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + * Result of updating a single plugin. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpExecuteSamplingParams". + * via the `definition` "PluginUpdateResult". */ /** @experimental */ -export interface McpExecuteSamplingParams { +export interface PluginUpdateResult { /** - * Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. + * Version that was previously installed, when available */ - requestId: string; + previousVersion?: string; /** - * Name of the MCP server that initiated the sampling request + * Version after the update, when reported by the plugin manifest */ - serverName: string; + newVersion?: string; /** - * The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). + * Number of skills discovered and installed after the update */ - mcpRequestId: string | number; - request: McpExecuteSamplingRequest; -} -/** - * Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpExecuteSamplingRequest". - */ -/** @experimental */ -export interface McpExecuteSamplingRequest { - [k: string]: unknown | undefined; + skillsInstalled: number; } /** - * MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + * BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpExecuteSamplingResult". + * via the `definition` "ProviderAddRequest". */ /** @experimental */ -export interface McpExecuteSamplingResult { - [k: string]: unknown | undefined; +export interface ProviderAddRequest { + /** + * Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'. + */ + providers?: NamedProviderConfig[]; + /** + * BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry. + */ + models?: ProviderModelConfig[]; } /** - * Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. + * A BYOK model definition referencing a named provider. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpOauthLoginRequest". + * via the `definition` "ProviderModelConfig". */ /** @experimental */ -export interface McpOauthLoginRequest { +export interface ProviderModelConfig { /** - * Name of the remote MCP server to authenticate + * Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified `provider/id`. */ - serverName: string; + id: string; /** - * 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. + * Name of the NamedProviderConfig that serves this model. */ - forceReauth?: boolean; + provider: string; /** - * 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. + * The model name sent to the provider API for inference. Defaults to `id`. */ - clientName?: string; + wireModel?: string; /** - * 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. + * Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. */ - callbackSuccessMessage?: string; + modelId?: string; + /** + * Display name for model pickers. Defaults to the provider-qualified selection id (`provider/id`). + */ + name?: string; + /** + * Maximum prompt/input tokens for the model. + */ + maxPromptTokens?: number; + /** + * Maximum context window tokens for the model. + */ + maxContextWindowTokens?: number; + /** + * Maximum output tokens for the model. + */ + maxOutputTokens?: number; + capabilities?: ModelCapabilitiesOverride; } /** - * OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. + * The selectable model entries synthesized for the models added by this call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpOauthLoginResult". + * via the `definition` "ProviderAddResult". */ /** @experimental */ -export interface McpOauthLoginResult { +export interface ProviderAddResult { /** - * 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. + * Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added. */ - authorizationUrl?: string; + models: JsonValue[]; } /** - * Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + * Custom model-provider configuration (BYOK). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpRemoveGitHubResult". + * via the `definition` "ProviderConfig". */ /** @experimental */ -export interface McpRemoveGitHubResult { +export interface ProviderConfig { + type?: ProviderConfigType; + wireApi?: ProviderConfigWireApi; + transport?: ProviderConfigTransport; /** - * True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). + * API endpoint URL. */ - removed: boolean; + baseUrl: string; + /** + * API key. Optional for local providers like Ollama. + */ + apiKey?: string; + /** + * Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + */ + bearerToken?: string; + azure?: ProviderConfigAzure; + /** + * Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model. + */ + modelId?: string; + /** + * The model identifier sent to the provider API for inference (the "wire" model), as opposed to modelId which is the well-known base. + */ + wireModel?: string; + /** + * Maximum prompt/input tokens for the model. + */ + maxPromptTokens?: number; + /** + * Maximum context window tokens for the model. + */ + maxContextWindowTokens?: number; + /** + * Maximum output tokens for the model. + */ + maxOutputTokens?: number; + /** + * Custom HTTP headers to include in all outbound requests to the provider. + */ + headers?: { + [k: string]: string | undefined; + }; + /** + * When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. + */ + hasBearerTokenProvider?: boolean; } /** - * Outcome of an MCP sampling execution: success result, failure error, or cancellation. + * A snapshot of the provider endpoint the session is currently configured to talk to. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSamplingExecutionResult". + * via the `definition` "ProviderEndpoint". */ /** @experimental */ -export interface McpSamplingExecutionResult { - action: McpSamplingExecutionAction; - result?: McpExecuteSamplingResult; +export interface ProviderEndpoint { + type: ProviderEndpointType; + wireApi?: ProviderEndpointWireApi; + transport?: ProviderEndpointTransport; /** - * Error description, present when action='failure'. + * Base URL to pass to the LLM client library. */ - error?: string; + baseUrl: string; + /** + * A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + */ + apiKey?: string; + /** + * HTTP headers the caller must include on every outbound request. + */ + headers: { + [k: string]: string | undefined; + }; + sessionToken?: ProviderSessionToken; } /** - * Schema for the `McpServer` type. + * Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServer". + * via the `definition` "ProviderSessionToken". */ /** @experimental */ -export interface McpServer { +export interface ProviderSessionToken { /** - * Server name (config key) + * The short-lived token value. */ - name: string; - status: McpServerStatus; - source?: McpServerSource; + token: string; /** - * Error message if the server failed to connect + * HTTP header name the token must be sent under. */ - error?: string; + header: string; + /** + * The model the token is bound to, when applicable. When set, the token is only valid for requests against this model. + */ + model?: string; + /** + * When the token expires, if known. Callers should refresh by calling `getEndpoint` again before this time, or reactively on any 401/403 response from `baseUrl`. + */ + expiresAt?: string; } /** - * MCP servers configured for the session, with their connection status. + * Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpServerList". + * via the `definition` "ProviderTokenAcquireRequest". */ /** @experimental */ -export interface McpServerList { +export interface ProviderTokenAcquireRequest { /** - * Configured MCP servers + * Target session identifier */ - servers: McpServer[]; + sessionId: string; + /** + * Name of the BYOK provider needing a token. For the legacy whole-session `provider` this is the implicit provider name; for named providers it is `NamedProviderConfig.name`. + */ + providerName: string; } /** - * Mode controlling how MCP server env values are resolved (`direct` or `indirect`). + * A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSetEnvValueModeParams". + * via the `definition` "ProviderTokenAcquireResult". */ /** @experimental */ -export interface McpSetEnvValueModeParams { - mode: McpSetEnvValueModeDetails; +export interface ProviderTokenAcquireResult { + /** + * The bearer token value (without the `Bearer ` prefix). + */ + token: string; } /** - * Env-value mode recorded on the session after the update. + * File attachment * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "McpSetEnvValueModeResult". + * via the `definition` "PushAttachmentFile". */ /** @experimental */ -export interface McpSetEnvValueModeResult { - mode: McpSetEnvValueModeDetails; +export interface PushAttachmentFile { + /** + * Attachment type discriminator + */ + type: "file"; + /** + * Absolute file path + */ + path: string; + /** + * User-facing display name for the attachment + */ + displayName: string; + lineRange?: PushAttachmentFileLineRange; } /** - * Model identifier and token limits used to compute the context-info breakdown. + * Optional line range to scope the attachment to a specific section of the file * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataContextInfoRequest". + * via the `definition` "PushAttachmentFileLineRange". */ /** @experimental */ -export interface MetadataContextInfoRequest { +export interface PushAttachmentFileLineRange { /** - * Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. - */ - promptTokenLimit: number; - /** - * Maximum output tokens allowed by the target model. Pass 0 if unknown. + * Start line number (1-based) */ - outputTokenLimit: number; + start: number; /** - * Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. + * End line number (1-based, inclusive) */ - selectedModel?: string; + end: number; } /** - * Token breakdown for the session's current context window, or null if uninitialized. + * Directory attachment * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataContextInfoResult". + * via the `definition` "PushAttachmentDirectory". */ /** @experimental */ -export interface MetadataContextInfoResult { +export interface PushAttachmentDirectory { /** - * Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + * Attachment type discriminator */ - contextInfo?: SessionContextInfo | null; + type: "directory"; + /** + * Absolute directory path + */ + path: string; + /** + * User-facing display name for the attachment + */ + displayName: string; } /** - * Indicates whether the local session is currently processing a turn or background continuation. + * Code selection attachment from an editor * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataIsProcessingResult". + * via the `definition` "PushAttachmentSelection". */ /** @experimental */ -export interface MetadataIsProcessingResult { +export interface PushAttachmentSelection { /** - * Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. + * Attachment type discriminator */ - processing: boolean; + type: "selection"; + /** + * Absolute path to the file containing the selection + */ + filePath: string; + /** + * User-facing display name for the selection + */ + displayName: string; + /** + * The selected text content + */ + text: string; + selection: PushAttachmentSelectionDetails; } /** - * Model identifier to use when re-tokenizing the session's existing messages. + * Position range of the selection within the file * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecomputeContextTokensRequest". + * via the `definition` "PushAttachmentSelectionDetails". */ /** @experimental */ -export interface MetadataRecomputeContextTokensRequest { - /** - * Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. - */ - modelId: string; +export interface PushAttachmentSelectionDetails { + start: PushAttachmentSelectionDetailsStart; + end: PushAttachmentSelectionDetailsEnd; } /** - * Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. + * Start position of the selection * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecomputeContextTokensResult". + * via the `definition` "PushAttachmentSelectionDetailsStart". */ /** @experimental */ -export interface MetadataRecomputeContextTokensResult { - /** - * Sum of tokens across chat-context and system-context messages currently held by the session. - */ - totalTokens: number; +export interface PushAttachmentSelectionDetailsStart { /** - * Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). + * Start line number (0-based) */ - messagesTokenCount: number; + line: number; /** - * Tokens contributed by system/developer prompt snapshots. + * Start character offset within the line (0-based) */ - systemTokenCount: number; + character: number; } /** - * Updated working-directory/git context to record on the session. + * End position of the selection * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecordContextChangeRequest". + * via the `definition` "PushAttachmentSelectionDetailsEnd". */ /** @experimental */ -export interface MetadataRecordContextChangeRequest { - context: SessionWorkingDirectoryContext; +export interface PushAttachmentSelectionDetailsEnd { + /** + * End line number (0-based) + */ + line: number; + /** + * End character offset within the line (0-based) + */ + character: number; } /** - * Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + * GitHub issue, pull request, or discussion reference * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionWorkingDirectoryContext". + * via the `definition` "PushAttachmentGitHubReference". */ /** @experimental */ -export interface SessionWorkingDirectoryContext { - /** - * Current working directory path - */ - cwd: string; - /** - * Root directory of the git repository, resolved via git rev-parse - */ - gitRoot?: string; +export interface PushAttachmentGitHubReference { /** - * Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) + * Attachment type discriminator */ - repository?: string; - hostType?: SessionWorkingDirectoryContextHostType; + type: "github_reference"; /** - * Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + * Issue, pull request, or discussion number */ - repositoryHost?: string; + number: number; /** - * Current git branch name + * Title of the referenced item */ - branch?: string; + title: string; + referenceType: PushAttachmentGitHubReferenceType; /** - * Head commit of the current git branch + * Current state of the referenced item (e.g., open, closed, merged) */ - headCommit?: string; + state: string; /** - * Merge-base commit SHA (fork point from the remote default branch) + * URL to the referenced item on GitHub */ - baseCommit?: string; + url: string; } /** - * Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataRecordContextChangeResult". - */ -/** @experimental */ -export interface MetadataRecordContextChangeResult {} -/** - * Absolute path to set as the session's new working directory. + * Pointer to a GitHub commit. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSetWorkingDirectoryRequest". + * via the `definition` "PushAttachmentGitHubCommit". */ /** @experimental */ -export interface MetadataSetWorkingDirectoryRequest { +export interface PushAttachmentGitHubCommit { /** - * Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. + * Attachment type discriminator */ - workingDirectory: string; -} -/** - * Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSetWorkingDirectoryResult". - */ -/** @experimental */ -export interface MetadataSetWorkingDirectoryResult { + type: "github_commit"; + repo: PushGitHubRepoRef; /** - * Working directory after the update + * Full commit SHA */ - workingDirectory: string; + oid: string; + /** + * First line of the commit message + */ + message: string; + /** + * URL to the commit on GitHub + */ + url: string; } /** - * Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + * Pointer to a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSnapshotRemoteMetadata". + * via the `definition` "PushGitHubRepoRef". */ /** @experimental */ -export interface MetadataSnapshotRemoteMetadata { +export interface PushGitHubRepoRef { /** - * The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. + * Numeric GitHub repository id */ - resourceId?: string; - repository: MetadataSnapshotRemoteMetadataRepository; + id?: number; /** - * The pull request number the remote session is associated with, if any. + * Repository name (without owner) */ - pullRequestNumber?: number; - taskType?: MetadataSnapshotRemoteMetadataTaskType; + name: string; + /** + * Repository owner login (user or organization) + */ + owner: string; } /** - * The repository the remote session targets. + * Pointer to a GitHub release. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "MetadataSnapshotRemoteMetadataRepository". + * via the `definition` "PushAttachmentGitHubRelease". */ /** @experimental */ -export interface MetadataSnapshotRemoteMetadataRepository { +export interface PushAttachmentGitHubRelease { /** - * The GitHub owner (user or organization) of the target repository. + * Attachment type discriminator */ - owner: string; + type: "github_release"; + repo: PushGitHubRepoRef; /** - * The GitHub repository name (without owner). + * Git tag the release is anchored to + */ + tagName: string; + /** + * Human-readable release name */ name: string; /** - * The branch the remote session is operating on. + * URL to the release on GitHub */ - branch: string; + url: string; } /** - * Schema for the `Model` type. + * Pointer to a GitHub Actions job. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Model". + * via the `definition` "PushAttachmentGitHubActionsJob". */ -export interface Model { +/** @experimental */ +export interface PushAttachmentGitHubActionsJob { /** - * Model identifier (e.g., "claude-sonnet-4.5") + * Attachment type discriminator */ - id: string; + type: "github_actions_job"; + repo: PushGitHubRepoRef; /** - * Display name + * Job id within the workflow run */ - name: string; - capabilities: ModelCapabilities; - policy?: ModelPolicy; - billing?: ModelBilling; + jobId: number; /** - * Supported reasoning effort levels (only present if model supports reasoning effort) + * Display name of the job */ - supportedReasoningEfforts?: string[]; + jobName: string; /** - * Default reasoning effort level (only present if model supports reasoning effort) + * Display name of the workflow the job ran in */ - defaultReasoningEffort?: string; - modelPickerCategory?: ModelPickerCategory; - modelPickerPriceCategory?: ModelPickerPriceCategory; + workflowName: string; + /** + * URL to the job on GitHub + */ + url: string; + /** + * Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + */ + conclusion?: string; } /** - * Model capabilities and limits + * Pointer to a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilities". + * via the `definition` "PushAttachmentGitHubRepository". */ -export interface ModelCapabilities { - supports?: ModelCapabilitiesSupports; - limits?: ModelCapabilitiesLimits; +/** @experimental */ +export interface PushAttachmentGitHubRepository { + /** + * Attachment type discriminator + */ + type: "github_repository"; + repo: PushGitHubRepoRef; + /** + * URL to the repository on GitHub + */ + url: string; + /** + * Short description of the repository + */ + description?: string; + /** + * Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + */ + ref?: string; } /** - * Feature flags indicating what the model supports + * Pointer to a single-file diff. At least one of `head` and `base` must be present. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesSupports". + * via the `definition` "PushAttachmentGitHubFileDiff". */ -export interface ModelCapabilitiesSupports { +/** @experimental */ +export interface PushAttachmentGitHubFileDiff { /** - * Whether this model supports vision/image input + * Attachment type discriminator */ - vision?: boolean; + type: "github_file_diff"; /** - * Whether this model supports reasoning effort configuration + * URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) */ - reasoningEffort?: boolean; + url: string; + head?: PushAttachmentGitHubFileDiffSide; + base?: PushAttachmentGitHubFileDiffSide; } /** - * Token limits for prompts, outputs, and context window + * One side of a file diff (head or base) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesLimits". + * via the `definition` "PushAttachmentGitHubFileDiffSide". */ -export interface ModelCapabilitiesLimits { - /** - * Maximum number of prompt/input tokens - */ - max_prompt_tokens?: number; +/** @experimental */ +export interface PushAttachmentGitHubFileDiffSide { + repo: PushGitHubRepoRef; /** - * Maximum number of output/completion tokens + * Git ref (branch, tag, or commit SHA) the file is read at */ - max_output_tokens?: number; + ref: string; /** - * Maximum total context window size in tokens + * Repository-relative path to the file */ - max_context_window_tokens?: number; - vision?: ModelCapabilitiesLimitsVision; + path: string; } /** - * Vision-specific limits + * Pointer to a comparison between two git revisions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesLimitsVision". + * via the `definition` "PushAttachmentGitHubTreeComparison". */ -export interface ModelCapabilitiesLimitsVision { - /** - * MIME types the model accepts - */ - supported_media_types: string[]; +/** @experimental */ +export interface PushAttachmentGitHubTreeComparison { /** - * Maximum number of images per prompt + * Attachment type discriminator */ - max_prompt_images: number; + type: "github_tree_comparison"; /** - * Maximum image size in bytes + * URL to the comparison on GitHub */ - max_prompt_image_size: number; + url: string; + base: PushAttachmentGitHubTreeComparisonSide; + head: PushAttachmentGitHubTreeComparisonSide; } /** - * Policy state (if applicable) + * One side of a tree comparison (head or base) * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelPolicy". + * via the `definition` "PushAttachmentGitHubTreeComparisonSide". */ -export interface ModelPolicy { - state: ModelPolicyState; +/** @experimental */ +export interface PushAttachmentGitHubTreeComparisonSide { + repo: PushGitHubRepoRef; /** - * Usage terms or conditions for this model + * Git revision (branch, tag, or commit SHA) */ - terms?: string; + revision: string; } /** - * Billing information + * Generic GitHub URL reference. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBilling". + * via the `definition` "PushAttachmentGitHubUrl". */ -export interface ModelBilling { +/** @experimental */ +export interface PushAttachmentGitHubUrl { /** - * Billing cost multiplier relative to the base rate + * Attachment type discriminator */ - multiplier?: number; - tokenPrices?: ModelBillingTokenPrices; + type: "github_url"; + /** + * URL to the GitHub resource + */ + url: string; } /** - * Token-level pricing information for this model + * Pointer to a file in a GitHub repository at a specific ref. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBillingTokenPrices". + * via the `definition` "PushAttachmentGitHubFile". */ -export interface ModelBillingTokenPrices { - /** - * AI Credits cost per billing batch of input tokens - */ - inputPrice?: number; +/** @experimental */ +export interface PushAttachmentGitHubFile { /** - * AI Credits cost per billing batch of output tokens + * Attachment type discriminator */ - outputPrice?: number; + type: "github_file"; + repo: PushGitHubRepoRef; /** - * AI Credits cost per billing batch of cached tokens + * Git ref the file is read at (branch, tag, or commit SHA) */ - cachePrice?: number; + ref: string; /** - * Number of tokens per standard billing batch + * Repository-relative path to the file */ - batchSize?: number; + path: string; /** - * Maximum context window tokens for the default tier + * URL to the file on GitHub */ - contextMax?: number; - longContext?: ModelBillingTokenPricesLongContext; + url: string; } /** - * Long context tier pricing (available for models with extended context windows) + * Pointer to a line range inside a file in a GitHub repository. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelBillingTokenPricesLongContext". + * via the `definition` "PushAttachmentGitHubSnippet". */ -export interface ModelBillingTokenPricesLongContext { +/** @experimental */ +export interface PushAttachmentGitHubSnippet { /** - * AI Credits cost per billing batch of input tokens + * Attachment type discriminator */ - inputPrice?: number; + type: "github_snippet"; + repo: PushGitHubRepoRef; /** - * AI Credits cost per billing batch of output tokens + * Git ref the file is read at (branch, tag, or commit SHA) */ - outputPrice?: number; + ref: string; /** - * AI Credits cost per billing batch of cached tokens + * Repository-relative path to the file */ - cachePrice?: number; + path: string; /** - * Maximum context window tokens for the long context tier + * URL to the snippet on GitHub (with line anchor) */ - contextMax?: number; + url: string; + lineRange: PushAttachmentFileLineRange; } /** - * Override individual model capabilities resolved by the runtime + * Blob attachment with inline base64-encoded data * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverride". + * via the `definition` "PushAttachmentBlob". */ /** @experimental */ -export interface ModelCapabilitiesOverride { - supports?: ModelCapabilitiesOverrideSupports; - limits?: ModelCapabilitiesOverrideLimits; +export interface PushAttachmentBlob { + /** + * Attachment type discriminator + */ + type: "blob"; + /** + * Base64-encoded content + */ + data: string; + /** + * MIME type of the inline data + */ + mimeType: string; + /** + * User-facing display name for the attachment + */ + displayName?: string; } /** - * Feature flags indicating what the model supports + * Inputs for starting a deferred-idle drain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideSupports". + * via the `definition` "QueueBeginDeferredIdleDrainRequest". */ /** @experimental */ -export interface ModelCapabilitiesOverrideSupports { +export interface QueueBeginDeferredIdleDrainRequest { /** - * Whether this model supports vision/image input + * Whether the host still has active background work. */ - vision?: boolean; + activeBackgroundWork: boolean; +} +/** + * Whether a deferred-idle drain should run. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "QueueBeginDeferredIdleDrainResult". + */ +/** @experimental */ +export interface QueueBeginDeferredIdleDrainResult { /** - * Whether this model supports reasoning effort configuration + * True when the host should run finishDeferredIdleDrain asynchronously. */ - reasoningEffort?: boolean; + shouldDrain: boolean; } /** - * Token limits for prompts, outputs, and context window + * Internal filter for consuming queued system notifications. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideLimits". + * via the `definition` "QueueConsumeSystemNotificationsRequest". */ /** @experimental */ -export interface ModelCapabilitiesOverrideLimits { - /** - * Maximum number of prompt/input tokens - */ - max_prompt_tokens?: number; - /** - * Maximum number of output/completion tokens - */ - max_output_tokens?: number; +export interface QueueConsumeSystemNotificationsRequest { /** - * Maximum total context window size in tokens + * Opaque runtime-owned filter object. */ - max_context_window_tokens?: number; - vision?: ModelCapabilitiesOverrideLimitsVision; + filter: JsonValue; } /** - * Vision-specific limits + * Inputs for marking session.idle deferred in native state. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelCapabilitiesOverrideLimitsVision". + * via the `definition` "QueueDeferSessionIdleRequest". */ /** @experimental */ -export interface ModelCapabilitiesOverrideLimitsVision { - /** - * MIME types the model accepts - */ - supported_media_types?: string[]; +export interface QueueDeferSessionIdleRequest { /** - * Maximum number of images per prompt - */ - max_prompt_images?: number; - /** - * Maximum image size in bytes + * Whether the deferred idle was caused by an aborted foreground turn. */ - max_prompt_image_size?: number; + aborted: boolean; } /** - * List of Copilot models available to the resolved user, including capabilities and billing metadata. + * Parameters for duplicating a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelList". + * via the `definition` "QueueDuplicateAtRequest". */ -export interface ModelList { - /** - * List of available models with full metadata - */ - models: Model[]; +/** @experimental */ +export interface QueueDuplicateAtRequest { + id: string; } /** - * Optional listing options. + * Result of duplicating a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelListRequest". + * via the `definition` "QueueDuplicateAtResult". */ /** @experimental */ -export interface ModelListRequest { +export interface QueueDuplicateAtResult { /** - * If true, bypasses the per-session model list cache and re-fetches from CAPI. + * Fresh stable opaque id assigned to the duplicate. */ - skipCache?: boolean; + id: string; } /** - * Reasoning effort level to apply to the currently selected model. + * Result of enqueueing the resume-pending wake item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSetReasoningEffortRequest". + * via the `definition` "QueueEnqueueResumePendingResult". */ /** @experimental */ -export interface ModelSetReasoningEffortRequest { +export interface QueueEnqueueResumePendingResult { /** - * Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. + * True when a wake item was newly queued. */ - reasoningEffort: string; + queued: boolean; } /** - * Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. + * Inputs for completing a deferred-idle drain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSetReasoningEffortResult". + * via the `definition` "QueueFinishDeferredIdleDrainRequest". */ /** @experimental */ -export interface ModelSetReasoningEffortResult { +export interface QueueFinishDeferredIdleDrainRequest { /** - * Reasoning effort level recorded on the session after the update + * Whether the host still has active background work. */ - reasoningEffort: string; -} - -export interface ModelsListRequest { + activeBackgroundWork: boolean; /** - * 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. + * Whether native queued work remains. */ - gitHubToken?: string; + hasPending: boolean; } /** - * Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + * Action selected by the native deferred-idle drain. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSwitchToRequest". + * via the `definition` "QueueFinishDeferredIdleDrainResult". */ /** @experimental */ -export interface ModelSwitchToRequest { +export interface QueueFinishDeferredIdleDrainResult { /** - * Model identifier to switch to + * One of none, processQueue, or emitSessionIdle. */ - modelId: string; - /** - * Reasoning effort level to use for the model. "none" disables reasoning. - */ - reasoningEffort?: string; - reasoningSummary?: ReasoningSummary; - modelCapabilities?: ModelCapabilitiesOverride; + action: string; /** - * Explicit context tier for the selected model. `"default"` / `"long_context"` pin the tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier untouched. + * Whether the deferred idle was caused by an aborted foreground turn. */ - contextTier?: /** Use the model's default context window. */ - | "default" - /** Pin the session to the long-context tier when supported. */ - | "long_context" - | null; + aborted: boolean; } /** - * The model identifier active on the session after the switch. + * Whether the native queue has pending work. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModelSwitchToResult". + * via the `definition` "QueueHasPendingResult". */ /** @experimental */ -export interface ModelSwitchToResult { +export interface QueueHasPendingResult { /** - * Currently active model identifier after the switch + * True when queued or immediate native work is pending. */ - modelId?: string; + hasPending: boolean; } /** - * Agent interaction mode to apply to the session. + * Parameters for inserting a queued message at a public visible position. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ModeSetRequest". + * via the `definition` "QueueInsertAtRequest". */ /** @experimental */ -export interface ModeSetRequest { - mode: SessionMode; +export interface QueueInsertAtRequest { + /** + * Zero-based position in the public visible queue. Values outside the queue clamp to an end. + */ + position: number; + message: QueueInsertMessage; } /** - * The session's friendly name, or null when not yet set. + * Serializable message fields accepted by queue.insertAt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameGetResult". + * via the `definition` "QueueInsertMessage". */ /** @experimental */ -export interface NameGetResult { +export interface QueueInsertMessage { /** - * The session name (user-set or auto-generated), or null if not yet set + * The user message text. */ - name: string | null; + prompt: string; + /** + * Optional user-facing display text. + */ + displayPrompt?: string; + /** + * Optional attachments for the message. + */ + attachments?: Attachment[]; + agentMode?: SendAgentMode; + /** + * Optional provenance source. `system` is rejected: it would hide the inserted row from `pendingItems` and make it unaddressable while still executing, so inserted items must stay visible. + */ + source?: string; + /** + * Whether the message is billable. + */ + billable?: boolean; + /** + * Required tool name for the turn, when any. + */ + requiredTool?: string; + /** + * Per-turn request headers. + */ + requestHeaders?: { + [k: string]: string | undefined; + }; + mode?: SendMode; + /** + * Accepted for SendOptions compatibility but ignored; the requested public position controls placement. + */ + prepend?: boolean; + /** + * Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state. + */ + wait?: boolean; + /** + * Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity. + */ + delivery?: string; } /** - * Auto-generated session summary to apply as the session's name when no user-set name exists. + * Result of inserting a queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameSetAutoRequest". + * via the `definition` "QueueInsertAtResult". */ /** @experimental */ -export interface NameSetAutoRequest { +export interface QueueInsertAtResult { /** - * Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. + * Fresh stable opaque id assigned to the inserted item. */ - summary: string; + id: string; } /** - * Indicates whether the auto-generated summary was applied as the session's name. + * Parameters for moving a queued item by stable id. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameSetAutoResult". + * via the `definition` "QueueMoveItemRequest". */ /** @experimental */ -export interface NameSetAutoResult { +export interface QueueMoveItemRequest { /** - * Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. + * Stable opaque queued-item id. */ - applied: boolean; + id: string; + /** + * Zero-based target position in the public visible queue. Values outside the queue clamp to an end. + */ + toPosition: number; } /** - * New friendly name to apply to the session. + * Result of moving a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "NameSetRequest". + * via the `definition` "QueueMoveItemResult". */ /** @experimental */ -export interface NameSetRequest { +export interface QueueMoveItemResult { /** - * New session name (1–100 characters, trimmed of leading/trailing whitespace) + * True when the item changed position; false when it was already at the requested position. */ - name: string; + changed: boolean; } /** - * Schema for the `PendingPermissionRequest` type. + * User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PendingPermissionRequest". + * via the `definition` "QueuePendingItems". */ /** @experimental */ -export interface PendingPermissionRequest { +export interface QueuePendingItems { /** - * Unique identifier for the pending permission request + * Stable opaque id for the canonical queued item. Batch rows share one id. */ - requestId: string; - request: PermissionPromptRequest; + id: string; + kind: QueuePendingItemsKind; + /** + * Human-readable text to display for this queue entry in the UI + */ + displayText: string; + agentMode: SendAgentMode; } /** - * List of pending permission requests reconstructed from event history. + * Snapshot of the session's pending queued items and immediate-steering messages. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PendingPermissionRequestList". + * via the `definition` "QueuePendingItemsResult". */ /** @experimental */ -export interface PendingPermissionRequestList { +export interface QueuePendingItemsResult { /** - * Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. + * Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. */ - items: PendingPermissionRequest[]; + items: QueuePendingItems[]; + /** + * Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + */ + steeringMessages: string[]; } /** - * Schema for the `PermissionDecisionApproveOnce` type. + * Parameters for removing a queued item by stable id. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveOnce". + * via the `definition` "QueueRemoveAtRequest". */ /** @experimental */ -export interface PermissionDecisionApproveOnce { - /** - * Approve this single request only - */ - kind: "approve-once"; +export interface QueueRemoveAtRequest { + id: string; } /** - * Schema for the `PermissionDecisionApproveForSession` type. + * Result of removing a queued item. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSession". + * via the `definition` "QueueRemoveAtResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSession { - /** - * Approve and remember for the rest of the session - */ - kind: "approve-for-session"; - approval?: PermissionDecisionApproveForSessionApproval; +export interface QueueRemoveAtResult { /** - * URL domain to approve for the rest of the session (URL prompts only) + * True when the addressed item was removed. */ - domain?: string; + removed: boolean; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type. + * Indicates whether a user-facing pending item was removed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalCommands". + * via the `definition` "QueueRemoveMostRecentResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalCommands { - /** - * Approval scoped to specific command identifiers. - */ - kind: "commands"; +export interface QueueRemoveMostRecentResult { /** - * Command identifiers covered by this approval. + * True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. */ - commandIdentifiers: string[]; + removed: boolean; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalRead` type. + * Parameters for steering a queued message into a live turn. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalRead". + * via the `definition` "QueueSendNowRequest". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalRead { - /** - * Approval covering read-only filesystem operations. - */ - kind: "read"; +export interface QueueSendNowRequest { + id: string; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type. + * Result of trying to steer a queued message into a live turn. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalWrite". + * via the `definition` "QueueSendNowResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalWrite { +export interface QueueSendNowResult { /** - * Approval covering filesystem write operations. + * True when the item was accepted into the steering lane; false when no main turn was live. */ - kind: "write"; + steered: boolean; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type. + * Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalMcp". + * via the `definition` "QueueSetDrainPausedRequest". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMcp { - /** - * Approval covering an MCP tool. - */ - kind: "mcp"; - /** - * MCP server name. - */ - serverName: string; - /** - * MCP tool name, or null to cover every tool on the server. - */ - toolName: string | null; +export interface QueueSetDrainPausedRequest { + paused: boolean; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type. + * Internal snapshot of native queue state for local session orchestration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalMcpSampling". + * via the `definition` "QueueSnapshotResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMcpSampling { +export interface QueueSnapshotResult { /** - * Approval covering MCP sampling requests for a server. + * User-facing pending items in FIFO order. */ - kind: "mcp-sampling"; + items: QueuePendingItems[]; /** - * MCP server name. + * Immediate steering messages waiting for an active turn. */ - serverName: string; + steeringMessages: string[]; + /** + * Insertion orders for queued items, aligned with `items`. + */ + itemOrders?: number[]; + /** + * Insertion orders for immediate steering messages, aligned with `steeringMessages`. + */ + steeringMessageOrders?: number[]; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type. + * Parameters for editing a single queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalMemory". + * via the `definition` "QueueUpdateTextRequest". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalMemory { - /** - * Approval covering writes to long-term memory. - */ - kind: "memory"; +export interface QueueUpdateTextRequest { + id: string; + prompt: string; + displayPrompt?: string; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type. + * Result of editing a queued message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalCustomTool". + * via the `definition` "QueueUpdateTextResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalCustomTool { - /** - * Approval covering a custom tool. - */ - kind: "custom-tool"; +export interface QueueUpdateTextResult { /** - * Custom tool name. + * True when the stored text changed. */ - toolName: string; + updated: boolean; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type. + * Event type to register consumer interest for, used by runtime gating logic. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionManagement". + * via the `definition` "RegisterEventInterestParams". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalExtensionManagement { - /** - * Approval covering extension lifecycle operations such as enable, disable, or reload. - */ - kind: "extension-management"; +export interface RegisterEventInterestParams { /** - * Optional operation identifier; when omitted, the approval covers all extension management operations. + * The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest is registered the runtime still attempts non-interactive reconnect from cached or refreshable tokens, and only marks the server `needs-auth` if usable credentials are unavailable — it does not open a browser or start interactive OAuth without a consumer). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. */ - operation?: string; + eventType: string; } /** - * Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` type. + * Opaque handle representing an event-type interest registration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess". + * via the `definition` "RegisterEventInterestResult". */ /** @experimental */ -export interface PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { - /** - * Approval covering an extension's request to access a permission-gated capability. - */ - kind: "extension-permission-access"; +export interface RegisterEventInterestResult { /** - * Extension name. + * Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. */ - extensionName: string; + handle: string; } /** - * Schema for the `PermissionDecisionApproveForLocation` type. + * Params to attach an extension loader's tools to a session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocation". + * via the `definition` "RegisterExtensionToolsParams". */ /** @experimental */ -export interface PermissionDecisionApproveForLocation { +/** @internal */ +export interface RegisterExtensionToolsParams { /** - * Approve and persist for this project location + * Session to register extension tools on. */ - kind: "approve-for-location"; - approval: PermissionDecisionApproveForLocationApproval; + sessionId: string; /** - * Location key (git root or cwd) to persist the approval to + * In-process ExtensionLoader handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, extension discovery/launch moves entirely into the runtime — the CLI passes pure config (search paths, disabled ids) via SessionOptions instead. + * + * @internal + * + * @internal */ - locationKey: string; + loader: OpaqueInProcessValue; + options?: SessionsRegisterExtensionToolsOnSessionOptions; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type. + * Optional registration options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalCommands". + * via the `definition` "SessionsRegisterExtensionToolsOnSessionOptions". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalCommands { +export interface SessionsRegisterExtensionToolsOnSessionOptions { /** - * Approval scoped to specific command identifiers. - */ - kind: "commands"; - /** - * Command identifiers covered by this approval. + * In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: replaced by runtime-side enable/disable RPCs in the SDK migration. + * + * @internal */ - commandIdentifiers: string[]; + enabled?: OpaqueInProcessValue; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalRead` type. + * Handle for releasing the extension tool registration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalRead". + * via the `definition` "RegisterExtensionToolsResult". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalRead { +/** @internal */ +export interface RegisterExtensionToolsResult { /** - * Approval covering read-only filesystem operations. + * In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an explicit `extensions.unregister` RPC in the SDK migration. + * + * @internal + * + * @internal */ - kind: "read"; + unsubscribe: OpaqueInProcessValue; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type. + * Opaque handle previously returned by `registerInterest` to release. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalWrite". + * via the `definition` "ReleaseEventInterestParams". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalWrite { +export interface ReleaseEventInterestParams { /** - * Approval covering filesystem write operations. + * Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. */ - kind: "write"; + handle: string; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type. + * Configuration for the runtime-managed remote-control singleton. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalMcp". + * via the `definition` "RemoteControlConfig". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMcp { +export interface RemoteControlConfig { /** - * Approval covering an MCP tool. + * Whether remote export should be enabled. */ - kind: "mcp"; + remote: boolean; /** - * MCP server name. + * Whether the MC session may steer the local session (write mode). */ - serverName: string; + steerable: boolean; /** - * MCP tool name, or null to cover every tool on the server. + * Whether the user explicitly requested remote (vs. implicit session-sync). Controls warning surfacing for missing-repo cases. */ - toolName: string | null; + explicit: boolean; + /** + * When true, suppresses timeline messages on successful setup. + */ + silent: boolean; + /** + * Existing Mission Control task ID to attach the exported session to. + */ + taskId?: string; + existingMcSession?: RemoteControlConfigExistingMcSession; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type. + * Reattach to an existing MC session without creating a new one. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalMcpSampling". + * via the `definition` "RemoteControlConfigExistingMcSession". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMcpSampling { +export interface RemoteControlConfigExistingMcSession { /** - * Approval covering MCP sampling requests for a server. + * Existing MC session ID to reattach to. */ - kind: "mcp-sampling"; + mcSessionId: string; /** - * MCP server name. + * Existing MC task ID for the reattached session. */ - serverName: string; + mcTaskId: string; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type. + * Remote control is not connected. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalMemory". + * via the `definition` "RemoteControlStatusOff". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalMemory { +export interface RemoteControlStatusOff { /** - * Approval covering writes to long-term memory. + * Remote control state tag: not connected. */ - kind: "memory"; + state: "off"; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type. + * Remote control is in the middle of initial setup. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalCustomTool". + * via the `definition` "RemoteControlStatusConnecting". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalCustomTool { +export interface RemoteControlStatusConnecting { /** - * Approval covering a custom tool. + * Remote control state tag: connecting. */ - kind: "custom-tool"; + state: "connecting"; /** - * Custom tool name. + * Session id the connection is attaching to. */ - toolName: string; + attachedSessionId: string; } /** - * Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type. + * Remote control is connected to a local session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionManagement". + * via the `definition` "RemoteControlStatusActive". */ /** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalExtensionManagement { +export interface RemoteControlStatusActive { /** - * Approval covering extension lifecycle operations such as enable, disable, or reload. + * Remote control state tag: active. */ - kind: "extension-management"; + state: "active"; /** - * Optional operation identifier; when omitted, the approval covers all extension management operations. + * Session id remote control is pointed at. */ - operation?: string; -} -/** - * Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` type. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess". - */ -/** @experimental */ -export interface PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { + attachedSessionId: string; /** - * Approval covering an extension's request to access a permission-gated capability. + * MC frontend URL for this session, when known. */ - kind: "extension-permission-access"; + frontendUrl?: string; /** - * Extension name. + * Whether the MC session may steer this session. */ - extensionName: string; + isSteerable: boolean; + /** + * In-process prompt-manager handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, the same bidirectional prompt-routing handshake is expressed via dedicated remote-control RPCs (register/resolve) rather than a shared in-process object. + * + * @internal + */ + promptManager?: OpaqueInProcessValue; + /** + * True while a read-only/session-sync export is deferred, awaiting the first `user.message` before its MC session exists. Marked internal: this field is excluded from the public SDK surface and is populated only on the CLI in-process path. + * + * @internal + */ + awaitingFirstMessage?: boolean; } /** - * Schema for the `PermissionDecisionApprovePermanently` type. + * The last setup attempt failed. The singleton is otherwise off. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApprovePermanently". + * via the `definition` "RemoteControlStatusError". */ /** @experimental */ -export interface PermissionDecisionApprovePermanently { +export interface RemoteControlStatusError { /** - * Approve and persist across sessions (URL prompts only) + * Remote control state tag: setup failed. */ - kind: "approve-permanently"; + state: "error"; /** - * URL domain to approve permanently + * Human-readable error message from the last setup attempt. */ - domain: string; + error: string; + /** + * Session id the failing setup attempt targeted, when known. + */ + attachedSessionId?: string; } /** - * Schema for the `PermissionDecisionReject` type. + * Wrapper for the singleton's current status. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionReject". + * via the `definition` "RemoteControlStatusResult". */ /** @experimental */ -export interface PermissionDecisionReject { - /** - * Reject the request - */ - kind: "reject"; - /** - * Optional feedback explaining the rejection - */ - feedback?: string; +export interface RemoteControlStatusResult { + status: RemoteControlStatus; } /** - * Schema for the `PermissionDecisionUserNotAvailable` type. + * Outcome of a stopRemoteControl call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionUserNotAvailable". + * via the `definition` "RemoteControlStopResult". */ /** @experimental */ -export interface PermissionDecisionUserNotAvailable { +export interface RemoteControlStopResult { + status: RemoteControlStatus; /** - * No user is available to confirm the request + * Whether the singleton was actually torn down by this call. */ - kind: "user-not-available"; + stopped: boolean; } /** - * Schema for the `PermissionDecisionApproved` type. + * Outcome of a transferRemoteControl call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApproved". + * via the `definition` "RemoteControlTransferResult". */ /** @experimental */ -export interface PermissionDecisionApproved { +export interface RemoteControlTransferResult { + status: RemoteControlStatus; /** - * The permission request was approved + * Whether the rebinding actually happened. */ - kind: "approved"; + transferred: boolean; } /** - * Schema for the `PermissionDecisionApprovedForSession` type. + * Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApprovedForSession". + * via the `definition` "RemoteEnableRequest". */ /** @experimental */ -export interface PermissionDecisionApprovedForSession { - /** - * Approved and remembered for the rest of the session - */ - kind: "approved-for-session"; - approval: UserToolSessionApproval; +export interface RemoteEnableRequest { + mode?: RemoteSessionMode; } /** - * Schema for the `PermissionDecisionApprovedForLocation` type. + * GitHub URL for the session and a flag indicating whether remote steering is enabled. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionApprovedForLocation". + * via the `definition` "RemoteEnableResult". */ /** @experimental */ -export interface PermissionDecisionApprovedForLocation { +export interface RemoteEnableResult { /** - * Approved and persisted for this project location + * GitHub frontend URL for this session */ - kind: "approved-for-location"; - approval: UserToolSessionApproval; + url?: string; /** - * The location key (git root or cwd) to persist the approval to + * Whether remote steering is enabled */ - locationKey: string; + remoteSteerable: boolean; } /** - * Schema for the `PermissionDecisionCancelled` type. + * New remote-steerability state to persist as a `session.remote_steerable_changed` event. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionCancelled". + * via the `definition` "RemoteNotifySteerableChangedRequest". */ /** @experimental */ -export interface PermissionDecisionCancelled { - /** - * The permission request was cancelled before a response was used - */ - kind: "cancelled"; +export interface RemoteNotifySteerableChangedRequest { /** - * Optional explanation of why the request was cancelled + * Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. */ - reason?: string; + remoteSteerable: boolean; } /** - * Schema for the `PermissionDecisionDeniedByRules` type. + * Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedByRules". + * via the `definition` "RemoteNotifySteerableChangedResult". */ /** @experimental */ -export interface PermissionDecisionDeniedByRules { - /** - * Denied because approval rules explicitly blocked it - */ - kind: "denied-by-rules"; - /** - * Rules that denied the request - */ - rules: PermissionRule[]; -} +export interface RemoteNotifySteerableChangedResult {} /** - * Schema for the `PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. + * Remote session connection result. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser". + * via the `definition` "RemoteSessionConnectionResult". */ /** @experimental */ -export interface PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { +export interface RemoteSessionConnectionResult { /** - * Denied because no approval rule matched and user confirmation was unavailable + * SDK session ID for the connected remote session. */ - kind: "denied-no-approval-rule-and-could-not-request-from-user"; + sessionId: string; + metadata: ConnectedRemoteSessionMetadata; } /** - * Schema for the `PermissionDecisionDeniedInteractivelyByUser` type. + * GitHub repository the remote session belongs to. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedInteractivelyByUser". + * via the `definition` "RemoteSessionMetadataRepository". */ /** @experimental */ -export interface PermissionDecisionDeniedInteractivelyByUser { +export interface RemoteSessionMetadataRepository { /** - * Denied by the user during an interactive prompt + * Repository owner. */ - kind: "denied-interactively-by-user"; + owner: string; /** - * Optional feedback from the user explaining the denial + * Repository name. */ - feedback?: string; + name: string; /** - * Whether to force-reject the current agent turn + * Branch associated with the remote session. */ - forceReject?: boolean; + branch: string; } /** - * Schema for the `PermissionDecisionDeniedByContentExclusionPolicy` type. + * Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedByContentExclusionPolicy". + * via the `definition` "RemoteSessionMetadataValue". */ /** @experimental */ -export interface PermissionDecisionDeniedByContentExclusionPolicy { +export interface RemoteSessionMetadataValue { /** - * Denied by the organization's content exclusion policy + * Stable session identifier. */ - kind: "denied-by-content-exclusion-policy"; + sessionId: string; /** - * File path that triggered the exclusion + * Session creation time as an ISO 8601 timestamp. */ - path: string; + startTime: string; /** - * Human-readable explanation of why the path was excluded + * Last-modified time as an ISO 8601 timestamp. */ - message: string; + modifiedTime: string; + /** + * Short summary of the session, when one has been derived. + */ + summary?: string; + /** + * Optional human-friendly name set via /rename. + */ + name?: string; + /** + * Always true for remote sessions. + */ + isRemote: true; + context?: SessionContext; + repository: RemoteSessionMetadataRepository; + /** + * Backing remote session IDs (most recent first). + */ + remoteSessionIds: string[]; + /** + * Pull request number associated with the session. + */ + pullRequestNumber?: number; + /** + * Original remote resource identifier (task ID or PR node ID). + */ + resourceId?: string; + taskType?: RemoteSessionMetadataTaskType; + /** + * Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. + */ + staleAt?: string; + /** + * Server-side task state returned by GitHub. + */ + state?: string; } /** - * Schema for the `PermissionDecisionDeniedByPermissionRequestHook` type. + * Repository context for the remote session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionDeniedByPermissionRequestHook". + * via the `definition` "RemoteSessionRepository". */ /** @experimental */ -export interface PermissionDecisionDeniedByPermissionRequestHook { +export interface RemoteSessionRepository { /** - * Denied by a permission request hook registered by an extension or plugin + * Repository owner or organization login. */ - kind: "denied-by-permission-request-hook"; + owner: string; /** - * Optional message from the hook explaining the denial + * Repository name. */ - message?: string; + name: string; /** - * Whether to interrupt the current agent turn + * Optional branch associated with the remote session. */ - interrupt?: boolean; + branch?: string; } /** - * Pending permission request ID and the decision to apply (approve/reject and scope). + * Resolved sandbox configuration. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionDecisionRequest". + * via the `definition` "SandboxConfig". */ /** @experimental */ -export interface PermissionDecisionRequest { +export interface SandboxConfig { /** - * Request ID of the pending permission request + * Whether sandboxing is enabled for the session. */ - requestId: string; - result: PermissionDecision; + enabled: boolean; + userPolicy?: SandboxConfigUserPolicy; + /** + * Whether to auto-add the current working directory to readwritePaths. Default: true. + */ + addCurrentWorkingDirectory?: boolean; + auth?: SandboxConfigAuth; + /** + * Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without extra configuration; a relocated CARGO_HOME additionally gets its Cargo lock files granted read-write. Default: true (enabled by default; set to false to opt out). + */ + allowDevToolAccess?: boolean; } /** - * Location-scoped tool approval to persist. + * User-managed sandbox policy fragment merged into the auto-discovered base policy. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationAddToolApprovalParams". + * via the `definition` "SandboxConfigUserPolicy". */ /** @experimental */ -export interface PermissionLocationAddToolApprovalParams { - /** - * Location key (git root or cwd) to persist the approval to - */ - locationKey: string; - approval: PermissionsLocationsAddToolApprovalDetails; +export interface SandboxConfigUserPolicy { + filesystem?: SandboxConfigUserPolicyFilesystem; + network?: SandboxConfigUserPolicyNetwork; + seatbelt?: SandboxConfigUserPolicySeatbelt; + experimental?: SandboxConfigUserPolicyExperimental; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsCommands` type. + * Filesystem rules to merge into the base policy. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCommands". + * via the `definition` "SandboxConfigUserPolicyFilesystem". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsCommands { +export interface SandboxConfigUserPolicyFilesystem { /** - * Approval scoped to specific command identifiers. + * Paths granted read/write access. */ - kind: "commands"; + readwritePaths?: string[]; /** - * Command identifiers covered by this approval. + * Paths granted read-only access. */ - commandIdentifiers: string[]; -} -/** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsRead` type. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsRead". - */ -/** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsRead { + readonlyPaths?: string[]; /** - * Approval covering read-only filesystem operations. + * Paths explicitly denied. */ - kind: "read"; + deniedPaths?: string[]; + /** + * Whether to clear the policy when the session exits. + */ + clearPolicyOnExit?: boolean; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsWrite` type. + * Network rules to merge into the base policy. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsWrite". + * via the `definition` "SandboxConfigUserPolicyNetwork". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsWrite { +export interface SandboxConfigUserPolicyNetwork { /** - * Approval covering filesystem write operations. + * Whether outbound network traffic is allowed at all. */ - kind: "write"; + allowOutbound?: boolean; + /** + * Whether traffic to local/loopback addresses is allowed. + */ + allowLocalNetwork?: boolean; + proxy?: SandboxConfigUserPolicyNetworkProxy; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsMcp` type. + * HTTP proxy configuration for sandboxed traffic. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcp". + * via the `definition` "SandboxConfigUserPolicyNetworkProxy". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMcp { +export interface SandboxConfigUserPolicyNetworkProxy { /** - * Approval covering an MCP tool. + * Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is. */ - kind: "mcp"; + url: string; /** - * MCP server name. + * Optional username for proxy authentication. Combined with the URL (and `password`) into `user:pass@host` when the sandboxed process routes through the proxy. */ - serverName: string; + username?: string; /** - * MCP tool name, or null to cover every tool on the server. + * Optional password for proxy authentication, combined with the URL at spawn time. The persisted value may be a literal password, a `${secret:…}` reference resolved from the OS keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the sandboxed process routes through the proxy. The /sandbox dialog stores a real password in the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in settings.json); the field is masked in the dialog and redacted by /settings show. */ - toolName: string | null; + password?: string; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsMcpSampling` type. + * macOS seatbelt-specific options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcpSampling". + * via the `definition` "SandboxConfigUserPolicySeatbelt". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMcpSampling { - /** - * Approval covering MCP sampling requests for a server. - */ - kind: "mcp-sampling"; +export interface SandboxConfigUserPolicySeatbelt { /** - * MCP server name. + * Whether the macOS seatbelt profile may access the keychain. */ - serverName: string; + keychainAccess?: boolean; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsMemory` type. + * Platform-specific experimental policy fields. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsMemory". + * via the `definition` "SandboxConfigUserPolicyExperimental". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsMemory { - /** - * Approval covering writes to long-term memory. - */ - kind: "memory"; +export interface SandboxConfigUserPolicyExperimental { + seatbelt?: SandboxConfigUserPolicyExperimentalSeatbelt; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsCustomTool` type. + * macOS seatbelt experimental options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsCustomTool". + * via the `definition` "SandboxConfigUserPolicyExperimentalSeatbelt". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsCustomTool { - /** - * Approval covering a custom tool. - */ - kind: "custom-tool"; +export interface SandboxConfigUserPolicyExperimentalSeatbelt { /** - * Custom tool name. + * Whether the macOS seatbelt profile may access the keychain. */ - toolName: string; + keychainAccess?: boolean; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionManagement` type. + * Credential-injection capability flags applied while the sandbox is enabled. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionManagement". + * via the `definition` "SandboxConfigAuth". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsExtensionManagement { +export interface SandboxConfigAuth { /** - * Approval covering extension lifecycle operations such as enable, disable, or reload. + * Whether to inject git credentials as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's own helper before the sandbox is applied. Default: false (opt-in). */ - kind: "extension-management"; + git?: boolean; /** - * Optional operation identifier; when omitted, the approval covers all extension management operations. + * Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in). */ - operation?: string; + gh?: boolean; } /** - * Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess` type. + * Register an absolute-time scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess". + * via the `definition` "ScheduleAddAtRequest". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { +export interface ScheduleAddAtRequest { /** - * Approval covering an extension's request to access a permission-gated capability. + * Epoch milliseconds when the prompt should fire. */ - kind: "extension-permission-access"; + at: number; /** - * Extension name. + * Prompt text to enqueue when the schedule fires. */ - extensionName: string; + prompt: string; + /** + * Whether the schedule should re-arm after each tick. Defaults to false. + */ + recurring?: boolean; + /** + * Optional display-only prompt label. + */ + displayPrompt?: string; } /** - * Working directory to load persisted location permissions for. + * Register a cron scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationApplyParams". + * via the `definition` "ScheduleAddCronRequest". */ /** @experimental */ -export interface PermissionLocationApplyParams { +export interface ScheduleAddCronRequest { /** - * Working directory whose persisted location permissions should be applied + * 5-field cron expression. */ - workingDirectory: string; + cron: string; + /** + * Prompt text to enqueue when the schedule fires. + */ + prompt: string; + /** + * Whether the schedule should re-arm after each tick. Defaults to true. + */ + recurring?: boolean; + /** + * Optional display-only prompt label. + */ + displayPrompt?: string; + /** + * IANA timezone for evaluating the cron expression. + */ + tz?: string; } /** - * Summary of persisted location permissions applied to the session. + * Register a relative-interval scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationApplyResult". + * via the `definition` "ScheduleAddRequest". */ /** @experimental */ -export interface PermissionLocationApplyResult { - /** - * Location key used in the location-permissions store - */ - locationKey: string; - locationType: PermissionLocationType; +export interface ScheduleAddRequest { /** - * Whether a different location was applied since the previous apply call + * Human-readable interval such as `30s`, `5m`, or `2h`. */ - changed: boolean; + interval: string; /** - * Number of location-scoped rules added to the live permission service + * Prompt text to enqueue when the schedule fires. */ - appliedRuleCount: number; + prompt: string; /** - * Number of persisted allowed directories added to the live path manager + * Whether the schedule should re-arm after each tick. Defaults to true. */ - appliedDirectoryCount: number; + recurring?: boolean; /** - * Location-scoped rules applied to the live permission service + * Optional display-only prompt label. */ - appliedRules: PermissionRule[]; + displayPrompt?: string; } /** - * Working directory to resolve into a location-permissions key. + * Result of registering or re-arming a scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationResolveParams". + * via the `definition` "ScheduleAddResult". */ /** @experimental */ -export interface PermissionLocationResolveParams { +export interface ScheduleAddResult { + entry?: ScheduleEntry; /** - * Working directory whose permission location should be resolved + * User-facing validation error, when registration failed. */ - workingDirectory: string; + error?: string; } /** - * Resolved location-permissions key and type. + * Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionLocationResolveResult". + * via the `definition` "ScheduleEntry". */ /** @experimental */ -export interface PermissionLocationResolveResult { +export interface ScheduleEntry { /** - * Location key used in the location-permissions store + * Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). */ - locationKey: string; - locationType: PermissionLocationType; + id: number; + /** + * Interval between scheduled ticks, in milliseconds (relative-interval schedules). + */ + intervalMs?: number; + /** + * 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. + */ + cron?: string; + /** + * IANA timezone the `cron` expression is evaluated in. + */ + tz?: string; + /** + * Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. + */ + at?: number; + /** + * Prompt text that gets enqueued on every tick. + */ + prompt: string; + /** + * Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). + */ + recurring: boolean; + /** + * True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. + */ + selfPaced?: boolean; + /** + * Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. + */ + displayPrompt?: string; + /** + * ISO 8601 timestamp when the next tick is scheduled to fire. + */ + nextRunAt: string; } /** - * Directory path to add to the session's allowed directories. + * Register a self-paced scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAddParams". + * via the `definition` "ScheduleAddSelfPacedRequest". */ /** @experimental */ -export interface PermissionPathsAddParams { +export interface ScheduleAddSelfPacedRequest { /** - * Directory to add to the allow-list. The runtime resolves and validates the path before adding. + * Prompt text to enqueue when the schedule fires. */ - path: string; + prompt: string; + /** + * Optional display-only prompt label. + */ + displayPrompt?: string; } /** - * Path to evaluate against the session's allowed directories. + * Whether the session currently has an active self-paced schedule. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAllowedCheckParams". + * via the `definition` "ScheduleHasSelfPacedResult". */ /** @experimental */ -export interface PermissionPathsAllowedCheckParams { +export interface ScheduleHasSelfPacedResult { /** - * Path to check against the session's allowed directories + * True when at least one active schedule is self-paced. */ - path: string; + hasSelfPaced: boolean; } /** - * Indicates whether the supplied path is within the session's allowed directories. + * Snapshot of the currently active recurring prompts for this session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsAllowedCheckResult". + * via the `definition` "ScheduleList". */ /** @experimental */ -export interface PermissionPathsAllowedCheckResult { +export interface ScheduleList { /** - * Whether the path is within the session's allowed directories + * Active scheduled prompts, ordered by id. */ - allowed: boolean; + entries: ScheduleEntry[]; } /** - * If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. + * Re-arm a self-paced scheduled prompt. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsConfig". + * via the `definition` "ScheduleRearmSelfPacedRequest". */ /** @experimental */ -export interface PermissionPathsConfig { - /** - * If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. - */ - unrestricted?: boolean; - /** - * Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). - */ - additionalDirectories?: string[]; +export interface ScheduleRearmSelfPacedRequest { /** - * Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + * Id of the self-paced scheduled prompt. */ - includeTempDirectory?: boolean; + id: number; /** - * Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + * Epoch milliseconds when the prompt should next fire. */ - workspacePath?: string; + at: number; } /** - * Snapshot of the session's allow-listed directories and primary working directory. + * Identifier of the scheduled prompt to remove. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsList". + * via the `definition` "ScheduleStopRequest". */ /** @experimental */ -export interface PermissionPathsList { - /** - * All directories currently allowed for tool access on this session. - */ - directories: string[]; +export interface ScheduleStopRequest { /** - * The primary working directory for this session. + * Id of the scheduled prompt to remove. */ - primary: string; + id: number; } /** - * Directory path to set as the session's new primary working directory. + * Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsUpdatePrimaryParams". + * via the `definition` "ScheduleStopResult". */ /** @experimental */ -export interface PermissionPathsUpdatePrimaryParams { - /** - * Directory to set as the new primary working directory for the session's permission policy. - */ - path: string; +export interface ScheduleStopResult { + entry?: ScheduleEntry; } /** - * Path to evaluate against the session's workspace (primary) directory. + * Secret values to add to the redaction filter. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsWorkspaceCheckParams". + * via the `definition` "SecretsAddFilterValuesRequest". */ /** @experimental */ -export interface PermissionPathsWorkspaceCheckParams { +export interface SecretsAddFilterValuesRequest { /** - * Path to check against the session workspace directory + * Raw secret values to register for redaction */ - path: string; + values: string[]; } /** - * Indicates whether the supplied path is within the session's workspace directory. + * Confirmation that the secret values were registered. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPathsWorkspaceCheckResult". + * via the `definition` "SecretsAddFilterValuesResult". */ /** @experimental */ -export interface PermissionPathsWorkspaceCheckResult { +export interface SecretsAddFilterValuesResult { /** - * Whether the path is within the session workspace directory + * Whether the values were successfully registered */ - allowed: boolean; + ok: true; } /** - * Notification payload describing the permission prompt that the client just rendered. + * Parameters for session.extensions.sendAttachmentsToMessage. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionPromptShownNotification". + * via the `definition` "SendAttachmentsToMessageParams". */ /** @experimental */ -export interface PermissionPromptShownNotification { +export interface SendAttachmentsToMessageParams { /** - * Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). + * Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment. */ - message: string; + instanceId?: string; + /** + * Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape. + */ + attachments: PushAttachment[]; } /** - * Indicates whether the permission decision was applied; false when the request was already resolved. + * A single user message to append to the session as part of a `session.sendMessages` turn * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionRequestResult". + * via the `definition` "SendMessageItem". */ /** @experimental */ -export interface PermissionRequestResult { +export interface SendMessageItem { /** - * Whether the permission request was handled successfully + * The user message text */ - success: boolean; + prompt: string; + /** + * If provided, this is shown in the timeline instead of `prompt` + */ + displayPrompt?: string; + /** + * Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message + */ + attachments?: Attachment[]; + /** + * If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + * + * @internal + */ + billable?: boolean; + /** + * If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange + */ + requiredTool?: string; + /** + * Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. + * + * @internal + */ + source?: string; } /** - * If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. + * Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionRulesSet". + * via the `definition` "SendMessagesRequest". */ /** @experimental */ -export interface PermissionRulesSet { +export interface SendMessagesRequest { /** - * Rules that auto-approve matching requests + * The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message. */ - approved: PermissionRule[]; + messages: SendMessageItem[]; + mode?: SendMode; /** - * Rules that auto-deny matching requests + * If true, adds the messages to the front of the queue instead of the end */ - denied: PermissionRule[]; + prepend?: boolean; + agentMode?: SendAgentMode; + /** + * Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + */ + requestHeaders?: { + [k: string]: string | undefined; + }; + /** + * W3C Trace Context traceparent header for distributed tracing of this agent turn + */ + traceparent?: string; + /** + * W3C Trace Context tracestate header for distributed tracing + */ + tracestate?: string; + /** + * If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + */ + wait?: boolean; } /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type. + * Result of sending zero or more user messages * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicy". + * via the `definition` "SendMessagesResult". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicy { - rules: PermissionsConfigureAdditionalContentExclusionPolicyRule[]; - last_updated_at: string | number; - scope: PermissionsConfigureAdditionalContentExclusionPolicyScope; - [k: string]: unknown | undefined; +export interface SendMessagesResult { + /** + * Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided. + */ + messageIds: string[]; } /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type. + * Parameters for sending a user message to the session * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRule". + * via the `definition` "SendRequest". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicyRule { - paths: string[]; - ifAnyMatch?: string[]; - ifNoneMatch?: string[]; - source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource; - [k: string]: unknown | undefined; +export interface SendRequest { + /** + * The user message text + */ + prompt: string; + /** + * If provided, this is shown in the timeline instead of `prompt` + */ + displayPrompt?: string; + /** + * Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message + */ + attachments?: Attachment[]; + mode?: SendMode; + /** + * If true, adds the message to the front of the queue instead of the end + */ + prepend?: boolean; + /** + * If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + */ + billable?: boolean; + /** + * If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange + */ + requiredTool?: string; + /** + * Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. + * + * @internal + */ + source?: string; + agentMode?: SendAgentMode; + /** + * Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + */ + requestHeaders?: { + [k: string]: string | undefined; + }; + /** + * W3C Trace Context traceparent header for distributed tracing of this agent turn + */ + traceparent?: string; + /** + * W3C Trace Context tracestate header for distributed tracing + */ + tracestate?: string; + /** + * If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + */ + wait?: boolean; } /** - * Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. + * Result of sending a user message * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource". + * via the `definition` "SendResult". */ /** @experimental */ -export interface PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { - name: string; - type: string; +export interface SendResult { + /** + * Unique identifier assigned to the message + */ + messageId: string; } /** - * Patch of permission policy fields to apply (omit a field to leave it unchanged). + * Internal request for sending a system notification. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureParams". + * via the `definition` "SendSystemNotificationRequest". */ /** @experimental */ -export interface PermissionsConfigureParams { +export interface SendSystemNotificationRequest { /** - * If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. + * Notification text to deliver to the model. */ - approveAllToolPermissionRequests?: boolean; + message: string; /** - * If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. + * Optional structured notification kind. */ - approveAllReadPermissionRequests?: boolean; - rules?: PermissionRulesSet; - paths?: PermissionPathsConfig; - urls?: PermissionUrlsConfig; + kind?: JsonValue; /** - * If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. + * Internal delivery options, including passive policy. */ - additionalContentExclusionPolicies?: PermissionsConfigureAdditionalContentExclusionPolicy[]; + options?: JsonValue; } /** - * If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. + * Agents discovered across user, project, plugin, and remote sources. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionUrlsConfig". + * via the `definition` "ServerAgentList". */ /** @experimental */ -export interface PermissionUrlsConfig { - /** - * If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. - */ - unrestricted?: boolean; +export interface ServerAgentList { /** - * Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. + * All discovered agents across all sources */ - initialAllowed?: string[]; + agents: AgentInfo[]; } /** - * Indicates whether the operation succeeded. + * Instruction sources discovered across user, repository, and plugin sources. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsConfigureResult". + * via the `definition` "ServerInstructionSourceList". */ /** @experimental */ -export interface PermissionsConfigureResult { +export interface ServerInstructionSourceList { /** - * Whether the operation succeeded + * All discovered instruction sources */ - success: boolean; + sources: InstructionSource[]; } /** - * Indicates whether the operation succeeded. + * Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsFolderTrustAddTrustedResult". + * via the `definition` "ServerSkill". */ /** @experimental */ -export interface PermissionsFolderTrustAddTrustedResult { +export interface ServerSkill { /** - * Whether the operation succeeded + * Unique identifier for the skill */ - success: boolean; + name: string; + /** + * Canonical slash command name used to invoke the skill, without the leading '/' + */ + commandName?: string; + /** + * Description of what the skill does + */ + description: string; + source: SkillSource; + /** + * Whether the skill can be invoked by the user as a slash command + */ + userInvocable: boolean; + /** + * Whether the skill is currently enabled (based on global config) + */ + enabled: boolean; + /** + * Absolute path to the skill file + */ + path?: string; + /** + * The project path this skill belongs to (only for project/inherited skills) + */ + projectPath?: string; + /** + * Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + */ + argumentHint?: string; } /** - * No parameters. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsGetAllowAllRequest". - */ -export interface PermissionsGetAllowAllRequest {} -/** - * Indicates whether the operation succeeded. + * Skills discovered across global and project sources. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsLocationsAddToolApprovalResult". + * via the `definition` "ServerSkillList". */ /** @experimental */ -export interface PermissionsLocationsAddToolApprovalResult { +export interface ServerSkillList { /** - * Whether the operation succeeded + * All discovered skills across all sources */ - success: boolean; + skills: ServerSkill[]; + /** + * Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills are excluded so host-local paths are not disclosed to multitenant callers. + */ + errors?: string[]; } /** - * Scope and add/remove instructions for modifying session- or location-scoped permission rules. + * Current activity flags for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsModifyRulesParams". + * via the `definition` "SessionActivity". */ /** @experimental */ -export interface PermissionsModifyRulesParams { - scope: PermissionsModifyRulesScope; - /** - * Rules to add to the scope. Applied before `remove`/`removeAll`. - */ - add?: PermissionRule[]; +export interface SessionActivity { /** - * Specific rules to remove from the scope. Ignored when `removeAll` is true. + * Whether an in-flight operation can currently be aborted. */ - remove?: PermissionRule[]; + abortable: boolean; /** - * When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. + * Whether the session currently has active work, including running turns or tasks. */ - removeAll?: boolean; + hasActiveWork: boolean; } /** - * Indicates whether the operation succeeded. + * Authentication status and account metadata for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsModifyRulesResult". + * via the `definition` "SessionAuthStatus". */ /** @experimental */ -export interface PermissionsModifyRulesResult { +export interface SessionAuthStatus { /** - * Whether the operation succeeded + * Whether the session has resolved authentication */ - success: boolean; + isAuthenticated: boolean; + authType?: AuthInfoType; + /** + * Authentication host URL + */ + host?: string; + /** + * Authenticated login/username, if available + */ + login?: string; + /** + * Human-readable authentication status description + */ + statusMessage?: string; + /** + * Copilot plan tier (e.g., individual_pro, business) + */ + copilotPlan?: string; } /** - * Indicates whether the operation succeeded. + * Map of sessionId -> bytes freed by removing the session's workspace directory. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsNotifyPromptShownResult". + * via the `definition` "SessionBulkDeleteResult". */ /** @experimental */ -export interface PermissionsNotifyPromptShownResult { +export interface SessionBulkDeleteResult { /** - * Whether the operation succeeded + * Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). */ - success: boolean; + freedBytes: { + [k: string]: number | undefined; + }; } /** - * Indicates whether the operation succeeded. + * The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPathsAddResult". + * via the `definition` "SessionEnrichMetadataResult". */ /** @experimental */ -export interface PermissionsPathsAddResult { +export interface SessionEnrichMetadataResult { /** - * Whether the operation succeeded + * Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. */ - success: boolean; + sessions: LocalSessionMetadataValue[]; } /** - * No parameters; returns the session's allow-listed directories. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPathsListRequest". - */ -export interface PermissionsPathsListRequest {} -/** - * Indicates whether the operation succeeded. + * File path, content to append, and optional mode for the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPathsUpdatePrimaryResult". + * via the `definition` "SessionFsAppendFileRequest". */ /** @experimental */ -export interface PermissionsPathsUpdatePrimaryResult { +export interface SessionFsAppendFileRequest { /** - * Whether the operation succeeded + * Target session identifier */ - success: boolean; + sessionId: string; + /** + * Path using SessionFs conventions + */ + path: string; + /** + * Content to append + */ + content: string; + /** + * Optional POSIX-style mode for newly created files + */ + mode?: number; } /** - * No parameters; returns currently-pending permission requests for the session. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsPendingRequestsRequest". - */ -export interface PermissionsPendingRequestsRequest {} -/** - * No parameters; clears all session-scoped tool permission approvals. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsResetSessionApprovalsRequest". - */ -export interface PermissionsResetSessionApprovalsRequest {} -/** - * Indicates whether the operation succeeded. + * Describes a filesystem error. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsResetSessionApprovalsResult". + * via the `definition` "SessionFsError". */ /** @experimental */ -export interface PermissionsResetSessionApprovalsResult { +export interface SessionFsError { + code: SessionFsErrorCode; /** - * Whether the operation succeeded + * Free-form detail about the error, for logging/diagnostics */ - success: boolean; + message?: string; } /** - * Whether to enable full allow-all permissions for the session. + * Path to test for existence in the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetAllowAllRequest". + * via the `definition` "SessionFsExistsRequest". */ /** @experimental */ -export interface PermissionsSetAllowAllRequest { +export interface SessionFsExistsRequest { + /** + * Target session identifier + */ + sessionId: string; /** - * Whether to enable full allow-all permissions + * Path using SessionFs conventions */ - enabled: boolean; - source?: PermissionsSetAllowAllSource; + path: string; } /** - * Allow-all toggle for tool permission requests, with an optional telemetry source. + * Indicates whether the requested path exists in the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetApproveAllRequest". + * via the `definition` "SessionFsExistsResult". */ /** @experimental */ -export interface PermissionsSetApproveAllRequest { +export interface SessionFsExistsResult { /** - * Whether to auto-approve all tool permission requests + * Whether the path exists */ - enabled: boolean; - source?: PermissionsSetApproveAllSource; + exists: boolean; } /** - * Indicates whether the operation succeeded. + * Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetApproveAllResult". + * via the `definition` "SessionFsMkdirRequest". */ /** @experimental */ -export interface PermissionsSetApproveAllResult { +export interface SessionFsMkdirRequest { /** - * Whether the operation succeeded + * Target session identifier */ - success: boolean; + sessionId: string; + /** + * Path using SessionFs conventions + */ + path: string; + /** + * Create parent directories as needed + */ + recursive?: boolean; + /** + * Optional POSIX-style mode for newly created directories + */ + mode?: number; } /** - * Toggles whether permission prompts should be bridged into session events for this client. + * Directory path whose entries should be listed from the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetRequiredRequest". + * via the `definition` "SessionFsReaddirRequest". */ /** @experimental */ -export interface PermissionsSetRequiredRequest { +export interface SessionFsReaddirRequest { /** - * Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). + * Target session identifier */ - required: boolean; + sessionId: string; + /** + * Path using SessionFs conventions + */ + path: string; } /** - * Indicates whether the operation succeeded. + * Names of entries in the requested directory, or a filesystem error if the read failed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsSetRequiredResult". + * via the `definition` "SessionFsReaddirResult". */ /** @experimental */ -export interface PermissionsSetRequiredResult { +export interface SessionFsReaddirResult { /** - * Whether the operation succeeded + * Entry names in the directory */ - success: boolean; + entries: string[]; + error?: SessionFsError; } /** - * Indicates whether the operation succeeded. + * Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionsUrlsSetUnrestrictedModeResult". + * via the `definition` "SessionFsReaddirWithTypesEntry". */ /** @experimental */ -export interface PermissionsUrlsSetUnrestrictedModeResult { +export interface SessionFsReaddirWithTypesEntry { /** - * Whether the operation succeeded + * Entry name */ - success: boolean; + name: string; + type: SessionFsReaddirWithTypesEntryType; } /** - * Whether the URL-permission policy should run in unrestricted mode. + * Directory path whose entries (with type information) should be listed from the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PermissionUrlsSetUnrestrictedModeParams". + * via the `definition` "SessionFsReaddirWithTypesRequest". */ /** @experimental */ -export interface PermissionUrlsSetUnrestrictedModeParams { +export interface SessionFsReaddirWithTypesRequest { /** - * Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. + * Target session identifier */ - enabled: boolean; + sessionId: string; + /** + * Path using SessionFs conventions + */ + path: string; } /** - * Optional message to echo back to the caller. + * Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PingRequest". + * via the `definition` "SessionFsReaddirWithTypesResult". */ -export interface PingRequest { +/** @experimental */ +export interface SessionFsReaddirWithTypesResult { /** - * Optional message to echo back + * Directory entries with type information */ - message?: string; + entries: SessionFsReaddirWithTypesEntry[]; + error?: SessionFsError; } /** - * Server liveness response, including the echoed message, current server timestamp, and protocol version. + * Path of the file to read from the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PingResult". + * via the `definition` "SessionFsReadFileRequest". */ -export interface PingResult { - /** - * Echoed message (or default greeting) - */ - message: string; +/** @experimental */ +export interface SessionFsReadFileRequest { /** - * ISO 8601 timestamp when the server handled the ping + * Target session identifier */ - timestamp: string; + sessionId: string; /** - * Server protocol version number + * Path using SessionFs conventions */ - protocolVersion: number; + path: string; } /** - * Existence, contents, and resolved path of the session plan file. + * File content as a UTF-8 string, or a filesystem error if the read failed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanReadResult". + * via the `definition` "SessionFsReadFileResult". */ /** @experimental */ -export interface PlanReadResult { - /** - * Whether the plan file exists in the workspace - */ - exists: boolean; - /** - * The content of the plan file, or null if it does not exist - */ - content: string | null; +export interface SessionFsReadFileResult { /** - * Absolute file path of the plan file, or null if workspace is not enabled + * File content as UTF-8 string */ - path: string | null; + content: string; + error?: SessionFsError; } /** - * Replacement contents to write to the session plan file. + * Source and destination paths for renaming or moving an entry in the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PlanUpdateRequest". + * via the `definition` "SessionFsRenameRequest". */ /** @experimental */ -export interface PlanUpdateRequest { +export interface SessionFsRenameRequest { /** - * The new content for the plan file + * Target session identifier */ - content: string; + sessionId: string; + /** + * Source path using SessionFs conventions + */ + src: string; + /** + * Destination path using SessionFs conventions + */ + dest: string; } /** - * Schema for the `Plugin` type. + * Path to remove from the client-provided session filesystem, with options for recursive removal and force. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "Plugin". + * via the `definition` "SessionFsRmRequest". */ /** @experimental */ -export interface Plugin { - /** - * Plugin name - */ - name: string; +export interface SessionFsRmRequest { /** - * Marketplace the plugin came from + * Target session identifier */ - marketplace: string; + sessionId: string; /** - * Installed version + * Path using SessionFs conventions */ - version?: string; + path: string; /** - * Whether the plugin is currently enabled + * Remove directories and their contents recursively */ - enabled: boolean; -} -/** - * Plugins installed for the session, with their enabled state and version metadata. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "PluginList". - */ -/** @experimental */ -export interface PluginList { + recursive?: boolean; /** - * Installed plugins + * Ignore errors if the path does not exist */ - plugins: Plugin[]; + force?: boolean; } /** - * Schema for the `QueuePendingItems` type. + * Optional capabilities declared by the provider * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuePendingItems". + * via the `definition` "SessionFsSetProviderCapabilities". */ /** @experimental */ -export interface QueuePendingItems { - kind: QueuePendingItemsKind; +export interface SessionFsSetProviderCapabilities { /** - * Human-readable text to display for this queue entry in the UI + * Whether the provider supports SQLite query/exists operations */ - displayText: string; + sqlite?: boolean; } /** - * Snapshot of the session's pending queued items and immediate-steering messages. + * Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueuePendingItemsResult". + * via the `definition` "SessionFsSetProviderRequest". */ /** @experimental */ -export interface QueuePendingItemsResult { +export interface SessionFsSetProviderRequest { /** - * Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. + * Initial working directory for sessions */ - items: QueuePendingItems[]; + initialCwd: string; /** - * Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + * Path within each session's SessionFs where the runtime stores files for that session */ - steeringMessages: string[]; + sessionStatePath: string; + conventions: SessionFsSetProviderConventions; + capabilities?: SessionFsSetProviderCapabilities; } /** - * Indicates whether a user-facing pending item was removed. + * Indicates whether the calling client was registered as the session filesystem provider. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "QueueRemoveMostRecentResult". + * via the `definition` "SessionFsSetProviderResult". */ /** @experimental */ -export interface QueueRemoveMostRecentResult { +export interface SessionFsSetProviderResult { /** - * True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + * Whether the provider was set successfully */ - removed: boolean; + success: boolean; } /** - * Event type to register consumer interest for, used by runtime gating logic. + * Indicates whether the per-session SQLite database already exists. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RegisterEventInterestParams". + * via the `definition` "SessionFsSqliteExistsResult". */ /** @experimental */ -export interface RegisterEventInterestParams { +export interface SessionFsSqliteExistsResult { /** - * The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full interactive OAuth flow to the consumer; when no interest is registered the runtime installs a browserless fallback that silently reuses cached tokens). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. + * Whether the session database already exists */ - eventType: string; + exists: boolean; } /** - * Opaque handle representing an event-type interest registration. + * SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RegisterEventInterestResult". + * via the `definition` "SessionFsSqliteQueryRequest". */ /** @experimental */ -export interface RegisterEventInterestResult { +export interface SessionFsSqliteQueryRequest { /** - * Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. + * Target session identifier */ - handle: string; + sessionId: string; + /** + * SQL query to execute + */ + query: string; + queryType: SessionFsSqliteQueryType; + /** + * Optional named bind parameters + */ + params?: { + [k: string]: JsonValue | undefined; + }; } /** - * Opaque handle previously returned by `registerInterest` to release. + * Query results including rows, columns, and rows affected, or a filesystem error if execution failed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ReleaseEventInterestParams". + * via the `definition` "SessionFsSqliteQueryResult". */ /** @experimental */ -export interface ReleaseEventInterestParams { +export interface SessionFsSqliteQueryResult { /** - * Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. + * For SELECT: array of row objects. For others: empty array. */ - handle: string; + rows: { + [k: string]: JsonValue | undefined; + }[]; + /** + * Column names from the result set + */ + columns: string[]; + /** + * Number of rows affected (for INSERT/UPDATE/DELETE) + */ + rowsAffected: number; + /** + * SQLite last_insert_rowid() value for INSERT. + */ + lastInsertRowid?: number; + error?: SessionFsError; } /** - * Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. + * Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteEnableRequest". + * via the `definition` "SessionFsSqliteTransactionError". */ /** @experimental */ -export interface RemoteEnableRequest { - mode?: RemoteSessionMode; +export interface SessionFsSqliteTransactionError { + errorClass: SessionFsSqliteTransactionErrorClass; + message: string; } /** - * GitHub URL for the session and a flag indicating whether remote steering is enabled. + * Statements to execute atomically. Providers apply busy handling for every call. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteEnableResult". + * via the `definition` "SessionFsSqliteTransactionRequest". */ /** @experimental */ -export interface RemoteEnableResult { - /** - * GitHub frontend URL for this session - */ - url?: string; +export interface SessionFsSqliteTransactionRequest { /** - * Whether remote steering is enabled + * Target session identifier */ - remoteSteerable: boolean; + sessionId: string; + statements: SessionFsSqliteTransactionStatement[]; } /** - * New remote-steerability state to persist as a `session.remote_steerable_changed` event. + * One statement in an atomic SQLite transaction. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteNotifySteerableChangedRequest". + * via the `definition` "SessionFsSqliteTransactionStatement". */ /** @experimental */ -export interface RemoteNotifySteerableChangedRequest { +export interface SessionFsSqliteTransactionStatement { /** - * Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. + * SQL statement to execute. */ - remoteSteerable: boolean; + query: string; + queryType: SessionFsSqliteQueryType; + /** + * Optional named bind parameters. + */ + params?: { + [k: string]: JsonValue | undefined; + }; } /** - * Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. + * Per-statement results, or a classified transaction error. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteNotifySteerableChangedResult". + * via the `definition` "SessionFsSqliteTransactionResult". */ /** @experimental */ -export interface RemoteNotifySteerableChangedResult {} +export interface SessionFsSqliteTransactionResult { + results: SessionFsSqliteQueryResult[]; + error?: SessionFsSqliteTransactionError; +} /** - * Remote session connection result. + * Path whose metadata should be returned from the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "RemoteSessionConnectionResult". + * via the `definition` "SessionFsStatRequest". */ /** @experimental */ -export interface RemoteSessionConnectionResult { +export interface SessionFsStatRequest { /** - * SDK session ID for the connected remote session. + * Target session identifier */ sessionId: string; - metadata: ConnectedRemoteSessionMetadata; + /** + * Path using SessionFs conventions + */ + path: string; } /** - * Schema for the `ScheduleEntry` type. + * Filesystem metadata for the requested path, or a filesystem error if the stat failed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ScheduleEntry". + * via the `definition` "SessionFsStatResult". */ /** @experimental */ -export interface ScheduleEntry { - /** - * Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). - */ - id: number; +export interface SessionFsStatResult { /** - * Interval between scheduled ticks, in milliseconds. + * Whether the path is a file */ - intervalMs: number; + isFile: boolean; /** - * Prompt text that gets enqueued on every tick. + * Whether the path is a directory */ - prompt: string; + isDirectory: boolean; /** - * Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). + * File size in bytes */ - recurring: boolean; + size: number; /** - * Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. + * ISO 8601 timestamp of last modification */ - displayPrompt?: string; + mtime: string; /** - * ISO 8601 timestamp when the next tick is scheduled to fire. + * ISO 8601 timestamp of creation */ - nextRunAt: string; + birthtime: string; + error?: SessionFsError; } /** - * Snapshot of the currently active recurring prompts for this session. + * File path, content to write, and optional mode for the client-provided session filesystem. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ScheduleList". + * via the `definition` "SessionFsWriteFileRequest". */ /** @experimental */ -export interface ScheduleList { +export interface SessionFsWriteFileRequest { /** - * Active scheduled prompts, ordered by id. + * Target session identifier */ - entries: ScheduleEntry[]; -} -/** - * Identifier of the scheduled prompt to remove. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ScheduleStopRequest". - */ -/** @experimental */ -export interface ScheduleStopRequest { + sessionId: string; /** - * Id of the scheduled prompt to remove. + * Path using SessionFs conventions */ - id: number; + path: string; + /** + * Content to write + */ + content: string; + /** + * Optional POSIX-style mode for newly created files + */ + mode?: number; } /** - * Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. + * Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ScheduleStopResult". + * via the `definition` "SessionInstalledPlugin". */ /** @experimental */ -export interface ScheduleStopResult { - entry?: ScheduleEntry; -} -/** - * Secret values to add to the redaction filter. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SecretsAddFilterValuesRequest". - */ -export interface SecretsAddFilterValuesRequest { +export interface SessionInstalledPlugin { /** - * Raw secret values to register for redaction + * Plugin name */ - values: string[]; -} -/** - * Confirmation that the secret values were registered. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SecretsAddFilterValuesResult". - */ -export interface SecretsAddFilterValuesResult { + name: string; /** - * Whether the values were successfully registered + * Marketplace the plugin came from (empty string for direct repo installs) */ - ok: true; + marketplace: string; + /** + * Installed version, if known + */ + version?: string; + /** + * Installation timestamp (ISO-8601) + */ + installed_at: string; + /** + * Whether the plugin is currently enabled + */ + enabled: boolean; + /** + * Path where the plugin is cached locally + */ + cache_path?: string; + source?: SessionInstalledPluginSource; + /** + * Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + */ + source_sha?: string; } /** - * File attachment + * Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentFile". + * via the `definition` "SessionInstalledPluginSourceGitHub". */ /** @experimental */ -export interface SendAttachmentFile { +export interface SessionInstalledPluginSourceGitHub { /** - * Attachment type discriminator - */ - type: "file"; - /** - * Absolute file path + * Constant value. Always "github". */ - path: string; + source: "github"; + repo: string; + ref?: string; /** - * User-facing display name for the attachment + * Optional full 40-character hexadecimal commit SHA. */ - displayName: string; - lineRange?: SendAttachmentFileLineRange; + sha?: string; + path?: string; } /** - * Optional line range to scope the attachment to a specific section of the file + * Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentFileLineRange". + * via the `definition` "SessionInstalledPluginSourceUrl". */ /** @experimental */ -export interface SendAttachmentFileLineRange { +export interface SessionInstalledPluginSourceUrl { /** - * Start line number (1-based) + * Constant value. Always "url". */ - start: number; + source: "url"; + url: string; + ref?: string; /** - * End line number (1-based, inclusive) + * Optional full 40-character hexadecimal commit SHA. */ - end: number; + sha?: string; + path?: string; } /** - * Directory attachment + * Source descriptor for a direct local plugin install, with a local filesystem path. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentDirectory". + * via the `definition` "SessionInstalledPluginSourceLocal". */ /** @experimental */ -export interface SendAttachmentDirectory { +export interface SessionInstalledPluginSourceLocal { /** - * Attachment type discriminator + * Constant value. Always "local". */ - type: "directory"; + source: "local"; + path: string; +} +/** + * Baseline data provenance for a prediction. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionLimitPredictionBaselineData". + */ +/** @experimental */ +export interface SessionLimitPredictionBaselineData { /** - * Absolute directory path + * Start of the baseline data slice. */ - path: string; + windowStart: string; /** - * User-facing display name for the attachment + * End of the baseline data slice. */ - displayName: string; + windowEnd: string; } /** - * Code selection attachment from an editor + * Explainable AI-credit session-limit prediction. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentSelection". + * via the `definition` "SessionLimitPredictionDetails". */ /** @experimental */ -export interface SendAttachmentSelection { +export interface SessionLimitPredictionDetails { + clientType: SessionLimitPredictionClientType; /** - * Attachment type discriminator + * Model identifier used for lookup. */ - type: "selection"; + modelId: string; + source: SessionLimitPredictionSource; /** - * Absolute path to the file containing the selection + * Key matched at the source level, such as a model id, family id, or `global`. */ - filePath: string; + sourceKey: string; /** - * User-facing display name for the selection + * Resolved model family when known. */ - displayName: string; + family?: string; /** - * The selected text content + * Ordered usage tiers and their AI-credit caps. */ - text: string; - selection: SendAttachmentSelectionDetails; -} -/** - * Position range of the selection within the file - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentSelectionDetails". - */ -/** @experimental */ -export interface SendAttachmentSelectionDetails { - start: SendAttachmentSelectionDetailsStart; - end: SendAttachmentSelectionDetailsEnd; + tiers: SessionLimitPredictionTierOption[]; + baselineData: SessionLimitPredictionBaselineData; + recommendedTier: SessionLimitPredictionTier; + /** + * Recommended maximum AI credits for this session. + */ + recommendedCap: number; } /** - * Start position of the selection + * Semantic usage tier and its AI-credit cap. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentSelectionDetailsStart". + * via the `definition` "SessionLimitPredictionTierOption". */ /** @experimental */ -export interface SendAttachmentSelectionDetailsStart { - /** - * Start line number (0-based) - */ - line: number; +export interface SessionLimitPredictionTierOption { + tier: SessionLimitPredictionTier; /** - * Start character offset within the line (0-based) + * AI-credit cap for this tier. */ - character: number; + cap: number; } /** - * End position of the selection + * Sessions matching the filter, ordered most-recently-modified first. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentSelectionDetailsEnd". + * via the `definition` "SessionList". */ /** @experimental */ -export interface SendAttachmentSelectionDetailsEnd { - /** - * End line number (0-based) - */ - line: number; +export interface SessionList { /** - * End character offset within the line (0-based) + * Sessions ordered most-recently-modified first. Discriminated by `isRemote`. */ - character: number; + sessions: SessionListEntry[]; } /** - * GitHub issue, pull request, or discussion reference + * Optional filter applied to the returned sessions * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentGithubReference". + * via the `definition` "SessionListFilter". */ /** @experimental */ -export interface SendAttachmentGithubReference { - /** - * Attachment type discriminator - */ - type: "github_reference"; +export interface SessionListFilter { /** - * Issue, pull request, or discussion number + * Match sessions whose context.cwd equals this value */ - number: number; + cwd?: string; /** - * Title of the referenced item + * Match sessions whose context.gitRoot equals this value */ - title: string; - referenceType: SendAttachmentGithubReferenceType; + gitRoot?: string; /** - * Current state of the referenced item (e.g., open, closed, merged) + * Match sessions whose context.repository equals this value */ - state: string; + repository?: string; /** - * URL to the referenced item on GitHub + * Match sessions whose context.branch equals this value */ - url: string; + branch?: string; } /** - * Blob attachment with inline base64-encoded data + * Queued repo-level startup prompts and the total hook command count after loading. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendAttachmentBlob". + * via the `definition` "SessionLoadDeferredRepoHooksResult". */ /** @experimental */ -export interface SendAttachmentBlob { - /** - * Attachment type discriminator - */ - type: "blob"; - /** - * Base64-encoded content - */ - data: string; +export interface SessionLoadDeferredRepoHooksResult { /** - * MIME type of the inline data + * Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. */ - mimeType: string; + startupPrompts: string[]; /** - * User-facing display name for the attachment + * Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. */ - displayName?: string; + hookCount: number; } /** - * Parameters for sending a user message to the session + * Enterprise permission policy expressed with the runtime's managed permission-rule syntax. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendRequest". + * via the `definition` "SessionManagedPermissions". */ /** @experimental */ -export interface SendRequest { - /** - * The user message text - */ - prompt: string; - /** - * If provided, this is shown in the timeline instead of `prompt` - */ - displayPrompt?: string; - /** - * Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message - */ - attachments?: SendAttachment[]; - mode?: SendMode; - /** - * If true, adds the message to the front of the queue instead of the end - */ - prepend?: boolean; - /** - * If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. - */ - billable?: boolean; - /** - * If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange - */ - requiredTool?: string; - /** - * Optional provenance tag copied to the resulting user.message event. Supported values are `system`, `command-*`, and `schedule-*`. - * - * @internal - */ - source?: { - [k: string]: unknown | undefined; - }; - agentMode?: SendAgentMode; - /** - * Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. - */ - requestHeaders?: { - [k: string]: string | undefined; - }; +export interface SessionManagedPermissions { + disableBypassPermissionsMode?: DisableBypassPermissionsMode; /** - * W3C Trace Context traceparent header for distributed tracing of this agent turn + * Permission rules that block matching operations. Deny has highest precedence. */ - traceparent?: string; + deny?: string[]; /** - * W3C Trace Context tracestate header for distributed tracing + * Permission rules that require explicit human approval. */ - tracestate?: string; + ask?: string[]; /** - * If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. + * Permission rules that allow matching operations unless another managed source, deny, or ask rule restricts them. */ - wait?: boolean; + allow?: string[]; } /** - * Result of sending a user message + * Managed settings an SDK host may inject at session startup. Only permissions are accepted in this initial contract. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SendResult". + * via the `definition` "SessionManagedSettings". */ /** @experimental */ -export interface SendResult { - /** - * Unique identifier assigned to the message - */ - messageId: string; +export interface SessionManagedSettings { + permissions?: SessionManagedPermissions; } /** - * Schema for the `ServerSkill` type. + * Point-in-time snapshot of slow-changing session identifier and state fields * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ServerSkill". + * via the `definition` "SessionMetadataSnapshot". */ -export interface ServerSkill { +/** @experimental */ +export interface SessionMetadataSnapshot { /** - * Unique identifier for the skill + * The unique identifier of the session */ - name: string; + sessionId: string; /** - * Description of what the skill does + * ISO 8601 timestamp of when the session started */ - description: string; - source: SkillSource; + startTime: string; /** - * Whether the skill can be invoked by the user as a slash command + * ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. */ - userInvocable: boolean; + modifiedTime: string; /** - * Whether the skill is currently enabled (based on global config) + * Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) */ - enabled: boolean; + isRemote: boolean; /** - * Absolute path to the skill file + * True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. */ - path?: string; + alreadyInUse: boolean; /** - * The project path this skill belongs to (only for project/inherited skills) + * Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace */ - projectPath?: string; -} -/** - * Skills discovered across global and project sources. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "ServerSkillList". - */ -export interface ServerSkillList { + workspacePath: string | null; /** - * All discovered skills across all sources + * User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. */ - skills: ServerSkill[]; -} -/** - * Authentication status and account metadata for the session. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionAuthStatus". - */ -/** @experimental */ -export interface SessionAuthStatus { + initialName?: string; /** - * Whether the session has resolved authentication + * Runtime client name associated with the session (telemetry identifier). */ - isAuthenticated: boolean; - authType?: AuthInfoType; + clientName?: string; + remoteMetadata?: MetadataSnapshotRemoteMetadata; /** - * Authentication host URL + * Short human-readable summary of the session, if known. Omitted when no summary has been generated. */ - host?: string; + summary?: string; /** - * Authenticated login/username, if available + * Absolute path to the session's current working directory */ - login?: string; + workingDirectory: string; + currentMode: MetadataSnapshotCurrentMode; /** - * Human-readable authentication status description + * Currently selected model identifier, if any */ - statusMessage?: string; + selectedModel?: string; /** - * Copilot plan tier (e.g., individual_pro, business) + * Current session limits, or null when no limits are active */ - copilotPlan?: string; -} -/** - * Map of sessionId -> bytes freed by removing the session's workspace directory. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionBulkDeleteResult". - */ -/** @experimental */ -export interface SessionBulkDeleteResult { + sessionLimits: SessionLimitsConfig | null; /** - * Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). + * Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). */ - freedBytes: { - [k: string]: number | undefined; - }; + workspace?: WorkspaceSummary | null; } /** - * Schema for the `SessionContext` type. + * The list of models available to this session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionContext". + * via the `definition` "SessionModelList". */ /** @experimental */ -export interface SessionContext { - /** - * Most recent working directory for this session - */ - cwd: string; +export interface SessionModelList { /** - * Git repository root, if the cwd was inside a git repo + * Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`). */ - gitRoot?: string; + list: JsonValue[]; /** - * Repository slug in `owner/name` form, when known + * Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable. */ - repository?: string; - hostType?: SessionContextHostType; + modelPriceCategories?: SessionModelPriceCategory[]; /** - * Active git branch + * Per-quota snapshots returned alongside the model list, keyed by quota type. */ - branch?: string; + quotaSnapshots?: { + [k: string]: JsonValue | undefined; + }; } /** - * The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. + * Cost-category metadata for a CAPI model. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionEnrichMetadataResult". + * via the `definition` "SessionModelPriceCategory". */ /** @experimental */ -export interface SessionEnrichMetadataResult { - /** - * Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. - */ - sessions: SessionMetadata[]; +export interface SessionModelPriceCategory { + id: string; + priceCategory: ModelPickerPriceCategory; } /** - * Schema for the `SessionMetadata` type. + * Session construction options. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionMetadata". + * via the `definition` "SessionOpenOptions". */ /** @experimental */ -export interface SessionMetadata { +export interface SessionOpenOptions { /** - * Stable session identifier + * Optional stable session identifier to use for a new session. */ - sessionId: string; + sessionId?: string; /** - * Session creation time as an ISO 8601 timestamp + * Optional human-friendly session name. */ - startTime: string; + name?: string; /** - * Last-modified time of the session's persisted state, as ISO 8601 + * Initial model identifier. */ - modifiedTime: string; + model?: string; /** - * Short summary of the session, when one has been derived + * Initial reasoning effort level. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. */ - summary?: string; + reasoningEffort?: string; + reasoningSummary?: SessionOpenOptionsReasoningSummary; + verbosity?: Verbosity; /** - * Optional human-friendly name set via /rename + * Identifier of the client driving the session. */ - name?: string; + clientName?: string; /** - * Runtime client name that created/last resumed this session + * Structured client kind used for runtime behavior gates. */ - clientName?: string; + clientKind?: string; /** - * True for remote (GitHub) sessions; false for local + * Identifier sent to LSP-style integrations. */ - isRemote: boolean; + lspClientName?: string; /** - * True for detached maintenance sessions that should be hidden from normal resume lists. + * Stable integration identifier for analytics. */ - isDetached?: boolean; - context?: SessionContext; + integrationId?: string; /** - * GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + * ExP assignment ('flight') data injected by an SDK integrator, in the same JSON shape the Copilot CLI fetches from the experimentation service (CopilotExpAssignmentResponse). When supplied this is fed into the FeatureFlagService exactly like CLI-fetched assignments and ExP-backed flags wait for it. When absent the session does not block on ExP. + * + * @internal */ - mcTaskId?: string; -} -/** - * File path, content to append, and optional mode for the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsAppendFileRequest". - */ -/** @experimental */ -export interface SessionFsAppendFileRequest { + expAssignments?: JsonValue; /** - * Target session identifier + * Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap. */ - sessionId: string; + enableManagedSettings?: boolean; + managedSettings?: SessionManagedSettings; /** - * Path using SessionFs conventions + * Opt in to capturing file changes for session rewind and session diff. Capture cannot reconstruct changes made before it was enabled. On create it starts capture from the first turn. It is also honored on resume: for a session that already has tracked prior turns, tracking continues automatically even if this is omitted; passing it on resume additionally enables tracking for an eligible session that has no prior root turn yet. Resuming a session whose prior root turns were never tracked has no restorable baseline, so tracking stays disabled for it and rewind reports file change tracking as unavailable; the resume itself still succeeds, so sessions that predate tracking remain loadable. The opt-in is only rejected when the session can never track (a subagent session, or one without local session storage). It is intentionally absent from the mutable options update because enabling it after edits have occurred would create an incomplete, misleading baseline. Subagents share the parent session's capture store and are not tracked as separate rewind points: a file a subagent writes is attributed to whichever root user turn was open when the capture was staged, just before the tool body ran. A turn cannot open while a staged capture is still in flight, so a subagent tool that staged under the spawning turn stays attributed to it however late the write lands, while a capture it stages after the user's next message belongs to that later turn. Attribution decides which turn's rewind point counts and file preview include that write; it does not narrow which rewinds revert it, because a rewind restores every capture from the selected turn onward, so the earlier spawning turn reverts it as well. */ - path: string; + enableFileChangeTracking?: boolean; /** - * Content to append + * Feature-flag values resolved by the host. */ - content: string; + featureFlags?: { + [k: string]: boolean | undefined; + }; /** - * Optional POSIX-style mode for newly created files + * Whether experimental behavior is enabled. */ - mode?: number; -} -/** - * Describes a filesystem error. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsError". - */ -/** @experimental */ -export interface SessionFsError { - code: SessionFsErrorCode; + isExperimentalMode?: boolean; + authInfo?: AuthInfo; + provider?: ProviderConfig; + capi?: CapiSessionOptions; /** - * Free-form detail about the error, for logging/diagnostics + * Named BYOK provider connections, additive to CAPI auth. Combining with `provider` is rejected. + * + * @experimental */ - message?: string; -} -/** - * Path to test for existence in the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsExistsRequest". - */ -/** @experimental */ -export interface SessionFsExistsRequest { + providers?: NamedProviderConfig[]; /** - * Target session identifier + * BYOK model definitions added to the selectable model list, each referencing a provider name. + * + * @experimental */ - sessionId: string; + models?: ProviderModelConfig[]; /** - * Path using SessionFs conventions + * Working directory to anchor the session. */ - path: string; -} -/** - * Indicates whether the requested path exists in the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsExistsResult". - */ -/** @experimental */ -export interface SessionFsExistsResult { + workingDirectory?: string; /** - * Whether the path exists + * Additional directories the agent may access beyond the working directory. Each entry is granted to the session's file-access allow-list and surfaced to the model (system prompt context and `@`-mention completion). Absolute paths are recommended; a relative path is resolved against the session's working directory. Nonexistent or unresolvable entries are skipped with a warning. This is applied on both session creation and resume, and is not persisted: a resumed session that omits this option does not retain previously supplied directories (re-supply them, exactly as the CLI re-passes `--add-dir`). */ - exists: boolean; -} -/** - * Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsMkdirRequest". - */ -/** @experimental */ -export interface SessionFsMkdirRequest { + additionalDirectories?: string[]; + workingDirectoryContext?: SessionContext; /** - * Target session identifier + * Whether this session supports remote steering. */ - sessionId: string; + remoteSteerable?: boolean; /** - * Path using SessionFs conventions + * Telemetry-only remote exporting flag. */ - path: string; + remoteExporting?: boolean; /** - * Create parent directories as needed + * Telemetry-only remote-defaulted flag. */ - recursive?: boolean; + remoteDefaultedOn?: boolean; /** - * Optional POSIX-style mode for newly created directories + * Parent session ID for detached child telemetry rollup. */ - mode?: number; -} -/** - * Directory path whose entries should be listed from the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirRequest". - */ -/** @experimental */ -export interface SessionFsReaddirRequest { + detachedFromSpawningParentSessionId?: string; /** - * Target session identifier + * Parent engagement ID for detached child telemetry rollup. */ - sessionId: string; + detachedFromSpawningParentEngagementId?: string; /** - * Path using SessionFs conventions + * Allowlist of available tool names. */ - path: string; -} -/** - * Names of entries in the requested directory, or a filesystem error if the read failed. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirResult". - */ -/** @experimental */ -export interface SessionFsReaddirResult { + availableTools?: string[]; /** - * Entry names in the directory + * Denylist of tool names. */ - entries: string[]; - error?: SessionFsError; -} -/** - * Schema for the `SessionFsReaddirWithTypesEntry` type. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirWithTypesEntry". - */ -/** @experimental */ -export interface SessionFsReaddirWithTypesEntry { + excludedTools?: string[]; /** - * Entry name + * Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. */ - name: string; - type: SessionFsReaddirWithTypesEntryType; -} -/** - * Directory path whose entries (with type information) should be listed from the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirWithTypesRequest". - */ -/** @experimental */ -export interface SessionFsReaddirWithTypesRequest { + includedBuiltinAgents?: string[]; /** - * Target session identifier + * Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. */ - sessionId: string; + excludedBuiltinAgents?: string[]; /** - * Path using SessionFs conventions + * Whether shell-script safety heuristics are enabled. */ - path: string; -} -/** - * Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReaddirWithTypesResult". - */ -/** @experimental */ -export interface SessionFsReaddirWithTypesResult { + enableScriptSafety?: boolean; + shell?: ShellOptions; /** - * Directory entries with type information + * @deprecated + * Use shell.initProfile instead. Shell init profile. */ - entries: SessionFsReaddirWithTypesEntry[]; - error?: SessionFsError; -} -/** - * Path of the file to read from the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReadFileRequest". - */ -/** @experimental */ -export interface SessionFsReadFileRequest { + shellInitProfile?: string; /** - * Target session identifier + * PowerShell process flags applied to built-in and user-requested shell commands. */ - sessionId: string; + shellProcessFlags?: string[]; + sandboxConfig?: SandboxConfig; /** - * Path using SessionFs conventions + * Whether interactive shell sessions are logged. */ - path: string; -} -/** - * File content as a UTF-8 string, or a filesystem error if the read failed. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsReadFileResult". - */ -/** @experimental */ -export interface SessionFsReadFileResult { + logInteractiveShells?: boolean; + envValueMode?: SessionOpenOptionsEnvValueMode; /** - * File content as UTF-8 string + * MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume. */ - content: string; - error?: SessionFsError; -} -/** - * Source and destination paths for renaming or moving an entry in the client-provided session filesystem. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsRenameRequest". - */ -/** @experimental */ -export interface SessionFsRenameRequest { + disabledMcpServers?: string[]; /** - * Target session identifier + * Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + */ + allowAllMcpServerInstructions?: boolean; + /** + * Additional directories to search for skills. + */ + skillDirectories?: string[]; + /** + * Skill IDs disabled for this session. + */ + disabledSkills?: string[]; + /** + * Installed plugins visible to the session. + */ + installedPlugins?: InstalledPlugin[]; + /** + * Whether custom agents default to local-only execution. */ - sessionId: string; + customAgentsLocalOnly?: boolean; /** - * Source path using SessionFs conventions + * Whether to skip custom instruction sources. */ - src: string; + skipCustomInstructions?: boolean; /** - * Destination path using SessionFs conventions + * Instruction source IDs disabled for this session. */ - dest: string; -} -/** - * Path to remove from the client-provided session filesystem, with options for recursive removal and force. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsRmRequest". - */ -/** @experimental */ -export interface SessionFsRmRequest { + disabledInstructionSources?: string[]; /** - * Target session identifier + * Whether commit-message coauthor trailers are enabled. */ - sessionId: string; + coauthorEnabled?: boolean; /** - * Path using SessionFs conventions + * Optional trajectory output file path. */ - path: string; + trajectoryFile?: string; /** - * Remove directories and their contents recursively + * Whether model responses stream as delta events. */ - recursive?: boolean; + enableStreaming?: boolean; /** - * Ignore errors if the path does not exist + * Experimental: enable native model citations (Anthropic models today), normalized onto the `assistant.message` event. Off by default; may change or be removed while the citations surface is experimental. + * + * @experimental */ - force?: boolean; -} -/** - * Optional capabilities declared by the provider - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSetProviderCapabilities". - */ -export interface SessionFsSetProviderCapabilities { + enableCitations?: boolean; /** - * Whether the provider supports SQLite query/exists operations + * Override URL for the Copilot API endpoint. */ - sqlite?: boolean; -} -/** - * Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSetProviderRequest". - */ -export interface SessionFsSetProviderRequest { + copilotUrl?: string; /** - * Initial working directory for sessions + * Whether ask_user is explicitly disabled. */ - initialCwd: string; + askUserDisabled?: boolean; /** - * Path within each session's SessionFs where the runtime stores files for that session + * Whether auto-mode continuation is enabled. */ - sessionStatePath: string; - conventions: SessionFsSetProviderConventions; - capabilities?: SessionFsSetProviderCapabilities; -} -/** - * Indicates whether the calling client was registered as the session filesystem provider. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSetProviderResult". - */ -export interface SessionFsSetProviderResult { + continueOnAutoMode?: boolean; /** - * Whether the provider was set successfully + * Whether the host is an interactive UI. */ - success: boolean; -} -/** - * Indicates whether the per-session SQLite database already exists. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSqliteExistsResult". - */ -/** @experimental */ -export interface SessionFsSqliteExistsResult { + runningInInteractiveMode?: boolean; /** - * Whether the session database already exists + * Whether on-demand custom instruction discovery is enabled. */ - exists: boolean; -} -/** - * SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSqliteQueryRequest". - */ -/** @experimental */ -export interface SessionFsSqliteQueryRequest { + enableOnDemandInstructionDiscovery?: boolean; /** - * Target session identifier + * Maximum decoded byte size of a single inline model-facing binary tool result persisted in session events (default 10 MB). */ - sessionId: string; + maxInlineBinaryBytes?: number; + modelCapabilitiesOverrides?: ModelCapabilitiesOverride; + sessionLimits?: SessionLimitsConfig; /** - * SQL query to execute + * Runtime context discriminator for agent filtering. */ - query: string; - queryType: SessionFsSqliteQueryType; + agentContext?: string; /** - * Optional named bind parameters + * Override directory for session event logs. */ - params?: { - [k: string]: (string | number | null) | undefined; - }; -} -/** - * Query results including rows, columns, and rows affected, or a filesystem error if execution failed. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsSqliteQueryResult". - */ -/** @experimental */ -export interface SessionFsSqliteQueryResult { + eventsLogDirectory?: string; /** - * For SELECT: array of row objects. For others: empty array. + * Whether subagent callback events should be forwarded into the session event log sink. */ - rows: { - [k: string]: unknown | undefined; - }[]; + eventsLogIncludesSubagents?: boolean; /** - * Column names from the result set + * Override Copilot configuration directory. */ - columns: string[]; + configDir?: string; /** - * Number of rows affected (for INSERT/UPDATE/DELETE) + * Additional content-exclusion policies to merge into the session policy set. + * + * @experimental */ - rowsAffected: number; + additionalContentExclusionPolicies?: SessionOpenOptionsAdditionalContentExclusionPolicy[]; + memory?: MemoryConfiguration; /** - * SQLite last_insert_rowid() value for INSERT. + * Capabilities enabled for this session. */ - lastInsertRowid?: number; - error?: SessionFsError; + sessionCapabilities?: SessionCapability[]; } /** - * Path whose metadata should be returned from the client-provided session filesystem. + * Per-session settings for built-in shell tools. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsStatRequest". + * via the `definition` "ShellOptions". */ /** @experimental */ -export interface SessionFsStatRequest { +export interface ShellOptions { + initProfile?: ShellInitProfile; /** - * Target session identifier + * Ordered host-provided script paths sourced before each built-in shell command when the + * entry's shell target matches the active shell. Use these for rc files, environment setup scripts, + * or other custom scripts. A script that returns a nonzero status is reported, and later scripts + * and the user command continue while the shell remains running. Because scripts are sourced into + * the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating behavior + * can prevent continuation. Script standard output is preserved; Bash script stderr is discarded, + * PowerShell exception messages are replaced, and runtime-generated failure notices omit + * configured script paths. When sandboxing is enabled, each script must already be readable under + * the active sandbox filesystem policy. Pass an empty array to clear the list. */ - sessionId: string; + initScripts?: ShellInitScript[]; /** - * Path using SessionFs conventions + * Flags passed to the active built-in shell process on startup, replacing its default flags. + * When omitted, the built-in Bash shell uses `--norc --noprofile`, + * and the built-in PowerShell shell uses `-NoProfile -NoLogo`. */ - path: string; + processFlags?: string[]; } /** - * Filesystem metadata for the requested path, or a filesystem error if the stat failed. + * A host-provided script sourced before each built-in shell command when its shell target matches the active shell. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsStatResult". + * via the `definition` "ShellInitScript". */ /** @experimental */ -export interface SessionFsStatResult { - /** - * Whether the path is a file - */ - isFile: boolean; - /** - * Whether the path is a directory - */ - isDirectory: boolean; - /** - * File size in bytes - */ - size: number; - /** - * ISO 8601 timestamp of last modification - */ - mtime: string; +export interface ShellInitScript { /** - * ISO 8601 timestamp of creation + * Path to the script to source. */ - birthtime: string; - error?: SessionFsError; + path: string; + shell: ShellInitScriptShell; } /** - * File path, content to write, and optional mode for the client-provided session filesystem. + * Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionFsWriteFileRequest". + * via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicy". */ /** @experimental */ -export interface SessionFsWriteFileRequest { - /** - * Target session identifier - */ - sessionId: string; - /** - * Path using SessionFs conventions - */ - path: string; - /** - * Content to write - */ - content: string; - /** - * Optional POSIX-style mode for newly created files - */ - mode?: number; +export interface SessionOpenOptionsAdditionalContentExclusionPolicy { + rules: SessionOpenOptionsAdditionalContentExclusionPolicyRule[]; + last_updated_at: JsonValue; + scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope; } /** - * Schema for the `SessionInstalledPlugin` type. + * Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionInstalledPlugin". + * via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicyRule". */ /** @experimental */ -export interface SessionInstalledPlugin { - /** - * Plugin name - */ - name: string; - /** - * Marketplace the plugin came from (empty string for direct repo installs) - */ - marketplace: string; - /** - * Installed version, if known - */ - version?: string; - /** - * Installation timestamp (ISO-8601) - */ - installed_at: string; - /** - * Whether the plugin is currently enabled - */ - enabled: boolean; - /** - * Path where the plugin is cached locally - */ - cache_path?: string; - source?: SessionInstalledPluginSource; +export interface SessionOpenOptionsAdditionalContentExclusionPolicyRule { + paths: string[]; + ifAnyMatch?: string[]; + ifNoneMatch?: string[]; + source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource; } /** - * Schema for the `SessionInstalledPluginSourceGithub` type. + * Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionInstalledPluginSourceGithub". + * via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource". */ /** @experimental */ -export interface SessionInstalledPluginSourceGithub { - /** - * Constant value. Always "github". - */ - source: "github"; - repo: string; - ref?: string; - path?: string; +export interface SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { + name: string; + type: string; } /** - * Schema for the `SessionInstalledPluginSourceUrl` type. + * Parameters for creating a new local session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionInstalledPluginSourceUrl". + * via the `definition` "SessionsOpenCreate". */ /** @experimental */ -export interface SessionInstalledPluginSourceUrl { +export interface SessionsOpenCreate { /** - * Constant value. Always "url". + * Create a new local session. */ - source: "url"; - url: string; - ref?: string; - path?: string; + kind: "create"; + options?: SessionOpenOptions; + /** + * Whether to emit session.start during creation. Defaults to true. + */ + emitStart?: boolean; } /** - * Schema for the `SessionInstalledPluginSourceLocal` type. + * Parameters for resuming a specific local session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionInstalledPluginSourceLocal". + * via the `definition` "SessionsOpenResume". */ /** @experimental */ -export interface SessionInstalledPluginSourceLocal { +export interface SessionsOpenResume { /** - * Constant value. Always "local". + * Resume a specific local session by ID or prefix. */ - source: "local"; - path: string; + kind: "resume"; + /** + * Session ID or unique prefix to resume. + */ + sessionId: string; + options?: SessionOpenOptions; + /** + * Whether to emit session.resume after loading. Defaults to true. + */ + resume?: boolean; + /** + * Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + */ + suppressResumeWorkspaceMetadataWriteback?: boolean; } /** - * Persisted sessions matching the filter, ordered most-recently-modified first. + * Parameters for resuming the most relevant local session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionList". + * via the `definition` "SessionsOpenResumeLast". */ /** @experimental */ -export interface SessionList { +export interface SessionsOpenResumeLast { + /** + * Resume the most relevant existing local session. + */ + kind: "resumeLast"; + context?: SessionContext; + options?: SessionOpenOptions; /** - * Sessions ordered most-recently-modified first + * Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. */ - sessions: SessionMetadata[]; + suppressResumeWorkspaceMetadataWriteback?: boolean; } /** - * Optional filter applied to the returned sessions + * Parameters for attaching to an already-active session by ID. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionListFilter". + * via the `definition` "SessionsOpenAttach". */ /** @experimental */ -export interface SessionListFilter { - /** - * Match sessions whose context.cwd equals this value - */ - cwd?: string; - /** - * Match sessions whose context.gitRoot equals this value - */ - gitRoot?: string; +export interface SessionsOpenAttach { /** - * Match sessions whose context.repository equals this value + * Attach to an already-active in-process session by ID. Unlike `resume`, this does NOT re-load from disk; the session must already be loaded by an earlier `create`/`resume` call. Returns `status: 'not_found'` when no active session matches the id. Useful for in-process consumers that need a fresh API handle to a session opened elsewhere (e.g., a peer foreground-session switch). */ - repository?: string; + kind: "attach"; /** - * Match sessions whose context.branch equals this value + * Session ID to attach to. */ - branch?: string; + sessionId: string; } /** - * Queued repo-level startup prompts and the total hook command count after loading. + * Parameters for connecting to a live remote session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionLoadDeferredRepoHooksResult". + * via the `definition` "SessionsOpenRemote". */ /** @experimental */ -export interface SessionLoadDeferredRepoHooksResult { +export interface SessionsOpenRemote { /** - * Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. + * Connect to a live remote session. */ - startupPrompts: string[]; + kind: "remote"; /** - * Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. + * Remote session identifier to connect to. */ - hookCount: number; + remoteSessionId: string; + repository?: RemoteSessionRepository; + options?: SessionOpenOptions; } /** - * Point-in-time snapshot of slow-changing session identifier and state fields + * Parameters for creating a new cloud session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionMetadataSnapshot". + * via the `definition` "SessionsOpenCloud". */ /** @experimental */ -export interface SessionMetadataSnapshot { - /** - * The unique identifier of the session - */ - sessionId: string; +export interface SessionsOpenCloud { /** - * ISO 8601 timestamp of when the session started + * Create a new cloud (coding-agent) session. */ - startTime: string; + kind: "cloud"; + repository?: RemoteSessionRepository; /** - * ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. + * Optional owner (user or organization login) to associate with the cloud session when no repository is provided. Ignored when `repository` is set (the repo's owner takes precedence). */ - modifiedTime: string; + owner?: string; + options?: SessionOpenOptions; /** - * Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) + * In-process callback invoked when the cloud task is created (before connection). Marked internal because a function reference cannot cross the JSON-RPC boundary. Disappears in the SDK migration: the field is purely cosmetic (it flips a single CLI phase label from 'creating' to 'connecting') and the wire-clean version just drops the intermediate phase. + * + * @internal */ - isRemote: boolean; + onTaskCreated?: OpaqueInProcessValue; +} +/** + * Parameters for fetching a remote session and handing it off to a new local session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsOpenHandoff". + */ +/** @experimental */ +export interface SessionsOpenHandoff { /** - * True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. + * Fetch a remote session and hand it off to a new local session. */ - alreadyInUse: boolean; + kind: "handoff"; + metadata: RemoteSessionMetadataValue; + options?: SessionOpenOptions; + taskType?: SessionsOpenHandoffTaskType; /** - * Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace + * In-process progress callback `(update) => void` invoked for each handoff step. Marked internal because a function reference cannot cross the JSON-RPC boundary. The host-side `handoffSession` is already declared as `AsyncGenerator`; the schema layer flattens it because it does not yet support streaming methods. The wire-clean replacement is to expose the AsyncGenerator directly (or use vscode-jsonrpc `$/progress` notifications) once the schema/transport layer supports it. + * + * @internal */ - workspacePath: string | null; + onProgress?: OpaqueInProcessValue; /** - * User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. + * In-process confirmation callback `(request) => boolean | Promise` invoked when the handoff needs the caller to confirm a non-fatal blocker (e.g. a repository mismatch between the current working directory and the remote session). Returning `true` proceeds with the handoff; returning `false` (or omitting the callback) aborts it. Marked internal because a function reference cannot cross the JSON-RPC boundary, for the same reasons as `onProgress`. + * + * @internal */ - initialName?: string; + onConfirm?: OpaqueInProcessValue; +} +/** + * Result of opening a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionOpenResult". + */ +/** @experimental */ +export interface SessionOpenResult { + status: SessionsOpenStatus; /** - * Runtime client name associated with the session (telemetry identifier). + * Opened session ID. Omitted when status is `not_found`. */ - clientName?: string; - remoteMetadata?: MetadataSnapshotRemoteMetadata; + sessionId?: string; /** - * Short human-readable summary of the session, if known. Omitted when no summary has been generated. + * In-process SessionClientApi handle for the opened session, returned to CLI callers as a transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK consumers should construct per-session clients from `sessionId` instead. + * + * @internal + * + * @internal */ - summary?: string; + sessionApi?: OpaqueInProcessValue; /** - * Absolute path to the session's current working directory + * Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. */ - workingDirectory: string; - currentMode: MetadataSnapshotCurrentMode; + startupPrompts?: string[]; /** - * Currently selected model identifier, if any + * Remote session ID, present when status is `connected`. */ - selectedModel?: string; + remoteSessionId?: string; + metadata?: RemoteSessionMetadataValue; /** - * Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). + * Handoff progress steps, present when status is `handed_off`. */ - workspace?: WorkspaceSummary | null; + progress?: SessionsOpenProgress[]; } /** - * The list of models available to this session. + * `sessions.open` handoff progress update with step, status, and optional message. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionModelList". + * via the `definition` "SessionsOpenProgress". */ /** @experimental */ -export interface SessionModelList { - /** - * Available models, ordered with the most preferred default first. - */ - list: unknown[]; +export interface SessionsOpenProgress { + step: SessionsOpenProgressStep; + status: SessionsOpenProgressStatus; /** - * Per-quota snapshots returned alongside the model list, keyed by quota type. + * Optional step message. */ - quotaSnapshots?: { - [k: string]: unknown | undefined; - }; + message?: string; } /** * Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. @@ -7838,6 +15428,23 @@ export interface SessionsCloseRequest { */ /** @experimental */ export interface SessionsCloseResult {} +/** + * Session ID to delete from disk. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsDeleteRequest". + */ +/** @experimental */ +export interface SessionsDeleteRequest { + /** + * Session ID to delete + */ + sessionId: string; + /** + * Internal resolved session directory path to delete + */ + sessionPath?: string | null; +} /** * Session metadata records to enrich with summary and context information. * @@ -7849,7 +15456,7 @@ export interface SessionsEnrichMetadataRequest { /** * Session metadata records to enrich. Records that already have summary and context are returned unchanged. */ - sessions: SessionMetadata[]; + sessions: LocalSessionMetadataValue[]; } /** * New auth credentials to install on the session. Omit to leave credentials unchanged. @@ -7873,6 +15480,138 @@ export interface SessionSetCredentialsResult { * Whether the operation succeeded */ success: boolean; + /** + * Whether the session ended up with a populated `copilotUser` for the installed credentials. `true` when the supplied credential already carried `copilotUser` or it was successfully re-resolved server-side. `false` when the credential is installed without `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In both `false` cases the token swap still applied, but plan/quota/billing metadata is degraded. Present whenever a credential was supplied; omitted only when no credential was supplied (no-op call). + */ + copilotUserResolved?: boolean; +} +/** + * Availability of built-in job tools surfaced to boundary consumers. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsBuiltInToolAvailabilitySnapshot". + */ +/** @experimental */ +export interface SessionSettingsBuiltInToolAvailabilitySnapshot { + reportProgress?: boolean; + createPullRequest?: boolean; +} +/** + * Named Rust-owned settings predicate to evaluate for this session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsEvaluatePredicateRequest". + */ +/** @experimental */ +export interface SessionSettingsEvaluatePredicateRequest { + name: SessionSettingsPredicateName; + /** + * Tool name for tool-scoped predicates such as trivial-change handling. + */ + toolName?: string; +} +/** + * Result of evaluating a Rust-owned settings predicate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsEvaluatePredicateResult". + */ +/** @experimental */ +export interface SessionSettingsEvaluatePredicateResult { + enabled: boolean; +} +/** + * Redacted job settings for a session. The job nonce is excluded. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsJobSnapshot". + */ +/** @experimental */ +export interface SessionSettingsJobSnapshot { + eventType?: string; + isTriggerJob?: boolean; + builtInToolAvailability?: SessionSettingsBuiltInToolAvailabilitySnapshot; +} +/** + * Redacted model routing settings for a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsModelSnapshot". + */ +/** @experimental */ +export interface SessionSettingsModelSnapshot { + model?: string; + defaultReasoningEffort?: string; + instanceId?: string; + callbackUrl?: string; +} +/** + * Online-evaluation settings safe to expose across the SDK boundary. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsOnlineEvaluationSnapshot". + */ +/** @experimental */ +export interface SessionSettingsOnlineEvaluationSnapshot { + disableOnlineEvaluation?: boolean; + enableOnlineEvaluationOutputFile?: boolean; +} +/** + * Redacted repository and GitHub host settings for a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsRepoSnapshot". + */ +/** @experimental */ +export interface SessionSettingsRepoSnapshot { + name?: string; + id?: number; + branch?: string; + commit?: string; + readWrite?: boolean; + ownerName?: string; + ownerId?: number; + serverUrl?: string; + host?: string; + hostProtocol?: string; + secretScanningUrl?: string; + prCommitCount?: number; +} +/** + * Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsSnapshot". + */ +/** @experimental */ +export interface SessionSettingsSnapshot { + version?: string; + clientName?: string; + timeoutMs?: number; + startTimeMs?: number; + repo: SessionSettingsRepoSnapshot; + model: SessionSettingsModelSnapshot; + validation: SessionSettingsValidationSnapshot; + job: SessionSettingsJobSnapshot; + onlineEvaluation: SessionSettingsOnlineEvaluationSnapshot; +} +/** + * Redacted validation and memory-tool settings for a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionSettingsValidationSnapshot". + */ +/** @experimental */ +export interface SessionSettingsValidationSnapshot { + timeout?: number; + dependabotTimeout?: number; + codeqlEnabled?: boolean; + codeReviewEnabled?: boolean; + codeReviewModel?: string; + advisoryEnabled?: boolean; + secretScanningEnabled?: boolean; + memoryStoreEnabled?: boolean; + memoryVoteEnabled?: boolean; } /** * UUID prefix to resolve to a unique session ID. @@ -7964,6 +15703,32 @@ export interface SessionsForkResult { */ name?: string; } +/** + * Session ID whose board entry count should be returned. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsGetBoardEntryCountRequest". + */ +/** @experimental */ +export interface SessionsGetBoardEntryCountRequest { + /** + * Session ID whose board entry count should be returned. + */ + sessionId: string; +} +/** + * Dynamic-context board entry count, when available. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsGetBoardEntryCountResult". + */ +/** @experimental */ +export interface SessionsGetBoardEntryCountResult { + /** + * Board entry count, when available. + */ + count?: number; +} /** * Session ID whose event-log file path to compute. * @@ -8013,6 +15778,29 @@ export interface SessionsGetLastForContextResult { */ sessionId?: string; } +/** + * Session ID whose persisted metadata should be read. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsGetMetadataRequest". + */ +/** @experimental */ +export interface SessionsGetMetadataRequest { + /** + * Session ID to inspect + */ + sessionId: string; +} +/** + * Persisted local session metadata when the session exists. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsGetMetadataResult". + */ +/** @experimental */ +export interface SessionsGetMetadataResult { + session?: LocalSessionMetadataValue; +} /** * Session ID to look up the persisted remote-steerable flag for. * @@ -8055,15 +15843,42 @@ export interface SessionSizes { }; } /** - * Optional metadata-load limit and filters applied to the returned sessions. + * Limit for non-empty local session IDs. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsListNonEmptySessionIdsRequest". + */ +/** @experimental */ +export interface SessionsListNonEmptySessionIdsRequest { + /** + * Maximum number of session IDs to return. + */ + limit?: number; +} +/** + * Recent local session IDs that contain user-visible history. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsListNonEmptySessionIdsResult". + */ +/** @experimental */ +export interface SessionsListNonEmptySessionIdsResult { + /** + * Session IDs ordered newest-first. + */ + sessionIds: string[]; +} +/** + * Optional source filter, metadata-load limit, and context filter applied to the returned sessions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SessionsListRequest". */ /** @experimental */ export interface SessionsListRequest { + source?: SessionSource; /** - * When provided, only the first N sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every session. + * When provided, only the first N local sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every local session. Has no effect on remote entries (which always carry their full shape). */ metadataLimit?: number; filter?: SessionListFilter; @@ -8071,6 +15886,10 @@ export interface SessionsListRequest { * When true, include detached maintenance sessions. Defaults to false for user-facing session lists. */ includeDetached?: boolean; + /** + * Only meaningful when `source` includes remote. When true, propagates errors from the remote service instead of silently returning an empty remote list. Defaults to false. + */ + throwOnError?: boolean; } /** * Active session ID whose deferred repo-level hooks should be loaded. @@ -8198,6 +16017,75 @@ export interface SessionsSetAdditionalPluginsRequest { */ /** @experimental */ export interface SessionsSetAdditionalPluginsResult {} +/** + * Patch for the singleton's steering state. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsSetRemoteControlSteeringRequest". + */ +/** @experimental */ +export interface SessionsSetRemoteControlSteeringRequest { + /** + * Target steering state. Today only `true` is actionable on the underlying exporter; `false` is reserved for future use. + */ + enabled: boolean; +} +/** + * Parameters for attaching the remote-control singleton to a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsStartRemoteControlRequest". + */ +/** @experimental */ +export interface SessionsStartRemoteControlRequest { + /** + * Local session id to attach remote control to. + */ + sessionId: string; + config: RemoteControlConfig; +} + +/** @experimental */ +export interface SessionsStopRemoteControlRequest { + /** + * When provided, the stop is rejected unless the singleton currently points at this session id (compare-and-swap semantics). + */ + expectedSessionId?: string; + /** + * When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. Use during shutdown or explicit `/remote off`. + */ + force?: boolean; +} +/** + * Parameters for atomically rebinding the remote-control singleton. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionsTransferRemoteControlRequest". + */ +/** @experimental */ +export interface SessionsTransferRemoteControlRequest { + /** + * Local session id to point remote control at. + */ + toSessionId: string; + /** + * When provided, the transfer is rejected unless the singleton currently points at this session id (compare-and-swap semantics to avoid clobbering newer state). + */ + expectedFromSessionId?: string; +} +/** + * Telemetry engagement ID for the session, when available. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionTelemetryEngagement". + */ +/** @experimental */ +export interface SessionTelemetryEngagement { + /** + * Current telemetry engagement ID, when available. + */ + engagementId?: string; +} /** * Patch of mutable session options to apply to the running session. * @@ -8210,10 +16098,13 @@ export interface SessionUpdateOptionsParams { * The model ID to use for assistant turns. */ model?: string; + modelCapabilitiesOverrides?: ModelCapabilitiesOverride; /** - * Reasoning effort for the selected model (model-defined enum). + * Reasoning effort for the selected model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. */ reasoningEffort?: string; + reasoningSummary?: OptionsUpdateReasoningSummary; + verbosity?: Verbosity; /** * Identifier of the client driving the session. */ @@ -8236,14 +16127,8 @@ export interface SessionUpdateOptionsParams { * Whether experimental capabilities are enabled. */ isExperimentalMode?: boolean; - /** - * Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the runtime. - * - * @experimental - */ - provider?: { - [k: string]: unknown | undefined; - }; + provider?: ProviderConfig; + capi?: CapiSessionOptions; /** * Absolute working-directory path for shell tools. */ @@ -8256,32 +16141,39 @@ export interface SessionUpdateOptionsParams { * Denylist of tool names for this session. */ excludedTools?: string[]; + /** + * Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. + */ + includedBuiltinAgents?: string[] | null; + /** + * Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. + */ + excludedBuiltinAgents?: string[]; toolFilterPrecedence?: OptionsUpdateToolFilterPrecedence; /** * Whether shell-script safety heuristics are enabled. */ enableScriptSafety?: boolean; + shell?: ShellOptions; /** - * Shell init profile (`None` or `NonInteractive`). + * @deprecated + * Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). */ shellInitProfile?: string; /** - * Per-shell process flags (e.g., `pwsh` arguments). + * PowerShell process flags applied to built-in and user-requested shell commands. */ shellProcessFlags?: string[]; - /** - * Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. - * - * @experimental - */ - sandboxConfig?: { - [k: string]: unknown | undefined; - }; + sandboxConfig?: SandboxConfig; /** * Whether interactive shell sessions are logged. */ logInteractiveShells?: boolean; envValueMode?: OptionsUpdateEnvValueMode; + /** + * Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + */ + allowAllMcpServerInstructions?: boolean; /** * Additional directories to search for skills. */ @@ -8291,9 +16183,13 @@ export interface SessionUpdateOptionsParams { */ disabledSkills?: string[]; /** - * Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. + * Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`. + */ + enableOnDemandInstructionDiscovery?: boolean; + /** + * Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB. */ - enableOnDemandInstructionDiscovery?: boolean; + maxInlineBinaryBytes?: number; /** * Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. */ @@ -8302,6 +16198,10 @@ export interface SessionUpdateOptionsParams { * Whether to default custom agents to local-only execution. */ customAgentsLocalOnly?: boolean; + /** + * When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement. + */ + suppressCustomAgentPrompt?: boolean; /** * Whether to skip loading custom instruction sources. */ @@ -8351,15 +16251,23 @@ export interface SessionUpdateOptionsParams { */ eventsLogDirectory?: string; /** - * Additional content-exclusion policies to merge into the session's policy set. Opaque shape; see `ContentExclusionApiResponse` in the runtime. + * Whether subagent callback events should be forwarded into the session event log sink. + */ + eventsLogIncludesSubagents?: boolean; + /** + * Additional content-exclusion policies to merge into the session's policy set. * * @experimental */ - additionalContentExclusionPolicies?: unknown[]; + additionalContentExclusionPolicies?: OptionsUpdateAdditionalContentExclusionPolicy[]; /** * Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). */ manageScheduleEnabled?: boolean; + /** + * Replaces the session's capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the field to leave the existing capability set unchanged. + */ + sessionCapabilities?: SessionCapability[]; /** * Whether to skip embedding retrieval pipeline initialization and execution. */ @@ -8384,6 +16292,11 @@ export interface SessionUpdateOptionsParams { * Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. */ enableSkills?: boolean; + contextTier?: OptionsUpdateContextTier; + /** + * Optional session limits. Pass null to clear the session limits. + */ + sessionLimits?: SessionLimitsConfig | null; } /** * Indicates whether the session options patch was applied successfully. @@ -8397,6 +16310,23 @@ export interface SessionUpdateOptionsResult { * Whether the operation succeeded */ success: boolean; + /** + * Number of hooks loaded from installed plugins, returned when installedPlugins is updated + */ + pluginHookCount?: number; +} +/** + * User-requested shell execution cancellation handle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellCancelUserRequestedRequest". + */ +/** @experimental */ +export interface ShellCancelUserRequestedRequest { + /** + * Request ID previously passed to executeUserRequested + */ + requestId: string; } /** * Shell command to run, with optional working directory and timeout in milliseconds. @@ -8432,6 +16362,23 @@ export interface ShellExecResult { */ processId: string; } +/** + * User-requested shell command and cancellation handle. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ShellExecuteUserRequestedRequest". + */ +/** @experimental */ +export interface ShellExecuteUserRequestedRequest { + /** + * Caller-provided cancellation handle for this execution + */ + requestId: string; + /** + * Shell command to execute + */ + command: string; +} /** * Identifier of a process previously returned by "shell.exec" and the signal to send. * @@ -8474,7 +16421,7 @@ export interface ShutdownRequest { reason?: string; } /** - * Schema for the `Skill` type. + * Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "Skill". @@ -8485,6 +16432,10 @@ export interface Skill { * Unique identifier for the skill */ name: string; + /** + * Canonical slash command name used to invoke the skill, without the leading '/' + */ + commandName?: string; /** * Description of what the skill does */ @@ -8506,6 +16457,45 @@ export interface Skill { * Name of the plugin that provides the skill, when source is 'plugin' */ pluginName?: string; + /** + * Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + */ + argumentHint?: string; +} +/** + * Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SkillDiscoveryPath". + */ +/** @experimental */ +export interface SkillDiscoveryPath { + /** + * Absolute path of the create/discovery target (may not exist on disk yet) + */ + path: string; + scope: SkillDiscoveryScope; + /** + * Whether this is the canonical directory to create a new skill in its tier. At most one entry per tier is preferred; the `personal-agents` and `custom` scopes are never preferred. + */ + preferredForCreation: boolean; + /** + * The input project path this directory was derived from (only for project scope) + */ + projectPath?: string; +} +/** + * Canonical locations where skills can be created so the runtime will recognize them. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SkillDiscoveryPathList". + */ +/** @experimental */ +export interface SkillDiscoveryPathList { + /** + * Canonical skill create/discovery directories, in priority order + */ + paths: SkillDiscoveryPath[]; } /** * Skills available to the session, with their enabled state. @@ -8526,6 +16516,7 @@ export interface SkillList { * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SkillsConfigSetDisabledSkillsRequest". */ +/** @experimental */ export interface SkillsConfigSetDisabledSkillsRequest { /** * List of skill names to disable @@ -8551,6 +16542,7 @@ export interface SkillsDisableRequest { * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SkillsDiscoverRequest". */ +/** @experimental */ export interface SkillsDiscoverRequest { /** * Optional list of project directory paths to scan for project-scoped skills @@ -8560,6 +16552,10 @@ export interface SkillsDiscoverRequest { * Optional list of additional skill directory paths to include */ skillDirectories?: string[]; + /** + * When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments. + */ + excludeHostSkills?: boolean; } /** * Name of the skill to enable for the session. @@ -8574,6 +16570,23 @@ export interface SkillsEnableRequest { */ name: string; } +/** + * Optional project paths to enumerate. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SkillsGetDiscoveryPathsRequest". + */ +/** @experimental */ +export interface SkillsGetDiscoveryPathsRequest { + /** + * Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. + */ + projectPaths?: string[]; + /** + * When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments. + */ + excludeHostSkills?: boolean; +} /** * Skills invoked during this session, ordered by invocation time (most recent last). * @@ -8588,7 +16601,7 @@ export interface SkillsGetInvokedResult { skills: SkillsInvokedSkill[]; } /** - * Schema for the `SkillsInvokedSkill` type. + * Skill invocation record with name, path, content, allowed tools, and turn number. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SkillsInvokedSkill". @@ -8634,7 +16647,7 @@ export interface SkillsLoadDiagnostics { errors: string[]; } /** - * Schema for the `SlashCommandAgentPromptResult` type. + * Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandAgentPromptResult". @@ -8654,13 +16667,17 @@ export interface SlashCommandAgentPromptResult { */ displayPrompt: string; mode?: SessionMode; + /** + * Optional user-facing notice to show before the prompt is submitted + */ + notice?: string; /** * True when the invocation mutated user runtime settings; consumers caching settings should refresh */ runtimeSettingsChanged?: boolean; } /** - * Schema for the `SlashCommandCompletedResult` type. + * Slash-command invocation result indicating completion, with optional message and settings-change flag. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandCompletedResult". @@ -8681,7 +16698,7 @@ export interface SlashCommandCompletedResult { runtimeSettingsChanged?: boolean; } /** - * Schema for the `SlashCommandTextResult` type. + * Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandTextResult". @@ -8710,7 +16727,7 @@ export interface SlashCommandTextResult { runtimeSettingsChanged?: boolean; } /** - * Schema for the `SlashCommandSelectSubcommandResult` type. + * Slash-command invocation result asking the client to present subcommand options for a parent command. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandSelectSubcommandResult". @@ -8739,7 +16756,7 @@ export interface SlashCommandSelectSubcommandResult { runtimeSettingsChanged?: boolean; } /** - * Schema for the `SlashCommandSelectSubcommandOption` type. + * Selectable slash-command subcommand option with name, description, and optional group label. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "SlashCommandSelectSubcommandOption". @@ -8760,7 +16777,25 @@ export interface SlashCommandSelectSubcommandOption { group?: string; } /** - * Schema for the `TaskAgentInfo` type. + * Subagent model, reasoning effort, and context tier settings + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SubagentSettingsEntry". + */ +/** @experimental */ +export interface SubagentSettingsEntry { + /** + * Model override for matching subagents + */ + model?: string; + /** + * Reasoning effort override for matching subagents + */ + effortLevel?: string; + contextTier?: SubagentSettingsEntryContextTier; +} +/** + * Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskAgentInfo". @@ -8809,7 +16844,7 @@ export interface TaskAgentInfo { */ agentType: string; /** - * Prompt passed to the agent + * Most recent prompt delivered to the agent. Updated whenever the agent receives a follow-up message. */ prompt: string; /** @@ -8817,9 +16852,13 @@ export interface TaskAgentInfo { */ result?: string; /** - * Model used for the task when specified + * Requested model override for the task when specified */ model?: string; + /** + * Runtime model resolved for the task when available + */ + resolvedModel?: string; executionMode?: TaskExecutionMode; /** * 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. @@ -8835,7 +16874,7 @@ export interface TaskAgentInfo { idleSince?: string; } /** - * Schema for the `TaskAgentProgress` type. + * Progress snapshot for an agent task, with recent activity lines and optional latest intent. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskAgentProgress". @@ -8856,7 +16895,7 @@ export interface TaskAgentProgress { latestIntent?: string; } /** - * Schema for the `TaskProgressLine` type. + * Timestamped display line for task progress output or recent agent activity. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskProgressLine". @@ -8873,7 +16912,7 @@ export interface TaskProgressLine { timestamp: string; } /** - * Schema for the `TaskShellInfo` type. + * Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskShellInfo". @@ -8934,7 +16973,7 @@ export interface TaskList { tasks: TaskInfo[]; } /** - * Schema for the `TaskShellProgress` type. + * Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "TaskShellProgress". @@ -9190,11 +17229,12 @@ export interface TelemetrySetFeatureOverridesRequest { }; } /** - * Schema for the `Tool` type. + * Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "Tool". */ +/** @experimental */ export interface Tool { /** * Tool identifier (e.g., "bash", "grep", "str_replace_editor") @@ -9212,7 +17252,7 @@ export interface Tool { * JSON Schema for the tool's input parameters */ parameters?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * Optional instructions for how to use this tool effectively @@ -9225,6 +17265,7 @@ export interface Tool { * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ToolList". */ +/** @experimental */ export interface ToolList { /** * List of available built-in tools with metadata @@ -9258,12 +17299,21 @@ export interface ToolsInitializeAndValidateResult {} * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "ToolsListRequest". */ +/** @experimental */ export interface ToolsListRequest { /** * Optional model ID — when provided, the returned tool list reflects model-specific overrides */ model?: string; } +/** + * Empty result after applying subagent settings + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "ToolsUpdateSubagentSettingsResult". + */ +/** @experimental */ +export interface ToolsUpdateSubagentSettingsResult {} /** * Multi-select string field where each option pairs a value with a display label. * @@ -9312,7 +17362,7 @@ export interface UIElicitationArrayAnyOfFieldItems { anyOf: UIElicitationArrayAnyOfFieldItemsAnyOf[]; } /** - * Schema for the `UIElicitationArrayAnyOfFieldItemsAnyOf` type. + * Selectable option for a UI elicitation multi-select array item, with submitted value and display label. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIElicitationArrayAnyOfFieldItemsAnyOf". @@ -9479,7 +17529,7 @@ export interface UIElicitationStringOneOfField { default?: string; } /** - * Schema for the `UIElicitationStringOneOfFieldOneOf` type. + * Selectable option for a UI elicitation single-select string field, with submitted value and display label. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIElicitationStringOneOfFieldOneOf". @@ -9619,7 +17669,45 @@ export interface UIElicitationResult { success: boolean; } /** - * Schema for the `UIExitPlanModeResponse` type. + * Transient question to answer without adding it to conversation history. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UIEphemeralQueryRequest". + */ +/** @experimental */ +export interface UIEphemeralQueryRequest { + /** + * Question to answer from the current conversation context. + */ + question: string; + /** + * In-process streaming callback `(text) => void` invoked with each token as the model emits it. Marked internal: excluded from the public SDK surface. In a process-separated SDK this is replaced by a streaming RPC that yields chunks and a final answer. + * + * @internal + */ + onChunk?: OpaqueInProcessValue; + /** + * In-process `AbortSignal` forwarded to the model client to cancel an in-flight request. Marked internal: excluded from the public SDK surface. Replaced by an explicit cancellation token + cancel RPC in the SDK migration. + * + * @internal + */ + abortSignal?: OpaqueInProcessValue; +} +/** + * Transient answer generated from current conversation context. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UIEphemeralQueryResult". + */ +/** @experimental */ +export interface UIEphemeralQueryResult { + /** + * Full assistant response text. + */ + answer: string; +} +/** + * User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIExitPlanModeResponse". @@ -9639,6 +17727,10 @@ export interface UIExitPlanModeResponse { * Feedback from the user when they declined the plan or requested changes. */ feedback?: string; + /** + * When true, the agent is instructed to end its turn without starting implementation so the client can restore the session model and auto-submit a fresh implementation turn on it. Set only when a distinct plan configuration (a different model, reasoning effort, or context tier) actually ran the planning turn. + */ + deferImplementation?: boolean; } /** * Request ID of a pending `auto_mode_switch.requested` event and the user's response. @@ -9719,6 +17811,38 @@ export interface UIHandlePendingSamplingRequest { export interface UIHandlePendingSamplingResponse { [k: string]: unknown | undefined; } +/** + * Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UIHandlePendingSessionLimitsExhaustedRequest". + */ +/** @experimental */ +export interface UIHandlePendingSessionLimitsExhaustedRequest { + /** + * The unique request ID from the session_limits_exhausted.requested event + */ + requestId: string; + response: UISessionLimitsExhaustedResponse; +} +/** + * The user's selected action for an exhausted session limit. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UISessionLimitsExhaustedResponse". + */ +/** @experimental */ +export interface UISessionLimitsExhaustedResponse { + action: UISessionLimitsExhaustedResponseAction; + /** + * AI Credits to add to the current max when action is 'add'. + */ + additionalAiCredits?: number; + /** + * New absolute max AI Credits when action is 'set'. + */ + maxAiCredits?: number; +} /** * Request ID of a pending `user_input.requested` event and the user's response. * @@ -9734,7 +17858,7 @@ export interface UIHandlePendingUserInputRequest { response: UIUserInputResponse; } /** - * Schema for the `UIUserInputResponse` type. + * User response for a pending user-input request, with answer text and whether it was typed freeform. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UIUserInputResponse". @@ -9789,6 +17913,19 @@ export interface UIUnregisterDirectAutoModeSwitchHandlerResult { */ unregistered: boolean; } +/** + * Subagent settings to apply to the current session + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UpdateSubagentSettingsRequest". + */ +/** @experimental */ +export interface UpdateSubagentSettingsRequest { + /** + * Subagent settings to apply, or null to clear the live session override + */ + subagents?: SubagentSettings | null; +} /** * Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. * @@ -9844,122 +17981,263 @@ export interface UsageGetMetricsResult { lastCallOutputTokens: number; } /** - * Schema for the `UsageMetricsTokenDetail` type. + * Session-wide token-detail entry containing the accumulated token count for one token type. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "UsageMetricsTokenDetail". */ /** @experimental */ -export interface UsageMetricsTokenDetail { +export interface UsageMetricsTokenDetail { + /** + * Accumulated token count for this token type + */ + tokenCount: number; +} +/** + * Aggregated code change metrics + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsCodeChanges". + */ +/** @experimental */ +export interface UsageMetricsCodeChanges { + /** + * Total lines of code added + */ + linesAdded: number; + /** + * Total lines of code removed + */ + linesRemoved: number; + /** + * Number of distinct files modified + */ + filesModifiedCount: number; + /** + * Distinct file paths modified during the session + */ + filesModified: string[]; +} +/** + * Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsModelMetric". + */ +/** @experimental */ +export interface UsageMetricsModelMetric { + requests: UsageMetricsModelMetricRequests; + usage: UsageMetricsModelMetricUsage; + /** + * Latest known prompt-cache expiration for this model. A timestamp in the past indicates that the observed cache has expired. + */ + cacheExpiresAt?: string; + /** + * Accumulated nano-AI units cost for this model + */ + totalNanoAiu?: number; + /** + * Token count details per type + */ + tokenDetails?: { + [k: string]: UsageMetricsModelMetricTokenDetail | undefined; + }; +} +/** + * Request count and cost metrics for this model + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsModelMetricRequests". + */ +/** @experimental */ +export interface UsageMetricsModelMetricRequests { + /** + * Number of API requests made with this model + */ + count: number; + /** + * User-initiated premium request cost (with multiplier applied) + */ + cost: number; +} +/** + * Token usage metrics for this model + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsModelMetricUsage". + */ +/** @experimental */ +export interface UsageMetricsModelMetricUsage { + /** + * Total input tokens consumed + */ + inputTokens: number; + /** + * Total output tokens produced + */ + outputTokens: number; + /** + * Total tokens read from prompt cache + */ + cacheReadTokens: number; + /** + * Total tokens written to prompt cache + */ + cacheWriteTokens: number; + /** + * Total output tokens used for reasoning + */ + reasoningTokens?: number; +} +/** + * Per-model token-detail entry containing the accumulated token count for one token type. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UsageMetricsModelMetricTokenDetail". + */ +/** @experimental */ +export interface UsageMetricsModelMetricTokenDetail { /** * Accumulated token count for this token type */ tokenCount: number; } /** - * Aggregated code change metrics + * Result of a user-requested shell command. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UsageMetricsCodeChanges". + * via the `definition` "UserRequestedShellCommandResult". */ /** @experimental */ -export interface UsageMetricsCodeChanges { +export interface UserRequestedShellCommandResult { /** - * Total lines of code added + * Tool call id emitted for the shell execution */ - linesAdded: number; + toolCallId: string; /** - * Total lines of code removed + * Whether the command completed successfully */ - linesRemoved: number; + success: boolean; /** - * Number of distinct files modified + * Captured command output */ - filesModifiedCount: number; + output: string; /** - * Distinct file paths modified during the session + * Process exit code, when available */ - filesModified: string[]; + exitCode?: number | null; + /** + * Error output when the execution failed + */ + error?: string; } /** - * Schema for the `UsageMetricsModelMetric` type. + * A single user setting's effective value alongside its default, so consumers can render settings left at their default. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UsageMetricsModelMetric". + * via the `definition` "UserSettingMetadata". */ /** @experimental */ -export interface UsageMetricsModelMetric { - requests: UsageMetricsModelMetricRequests; - usage: UsageMetricsModelMetricUsage; +export interface UserSettingMetadata { /** - * Accumulated nano-AI units cost for this model + * The effective value: the user's value if set, otherwise the default. */ - totalNanoAiu?: number; + value: JsonValue; /** - * Token count details per type + * The centrally-known default for this setting (null when no default is registered). */ - tokenDetails?: { - [k: string]: UsageMetricsModelMetricTokenDetail | undefined; - }; + default: JsonValue; + /** + * True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false. + */ + isDefault: boolean; } /** - * Request count and cost metrics for this model + * Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UsageMetricsModelMetricRequests". + * via the `definition` "UserSettingsGetResult". */ /** @experimental */ -export interface UsageMetricsModelMetricRequests { - /** - * Number of API requests made with this model - */ - count: number; +export interface UserSettingsGetResult { /** - * User-initiated premium request cost (with multiplier applied) + * Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default. */ - cost: number; + settings: { + [k: string]: UserSettingMetadata; + }; } /** - * Token usage metrics for this model + * Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UsageMetricsModelMetricUsage". + * via the `definition` "UserSettingsSetRequest". */ /** @experimental */ -export interface UsageMetricsModelMetricUsage { - /** - * Total input tokens consumed - */ - inputTokens: number; +export interface UserSettingsSetRequest { /** - * Total output tokens produced + * Partial user settings to write, as a free-form object keyed by setting name */ - outputTokens: number; + settings: JsonValue; +} +/** + * Outcome of writing user settings. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "UserSettingsSetResult". + */ +/** @experimental */ +export interface UserSettingsSetResult { /** - * Total tokens read from prompt cache + * Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed. */ - cacheReadTokens: number; + shadowedKeys: string[]; +} +/** + * Current sharing status and shareable GitHub URL for a session. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "VisibilityGetResult". + */ +/** @experimental */ +export interface VisibilityGetResult { /** - * Total tokens written to prompt cache + * Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent. */ - cacheWriteTokens: number; + synced: boolean; + status?: SessionVisibilityStatus; /** - * Total output tokens used for reasoning + * Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. */ - reasoningTokens?: number; + shareUrl?: string; } /** - * Schema for the `UsageMetricsModelMetricTokenDetail` type. + * Desired sharing status for the session. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "UsageMetricsModelMetricTokenDetail". + * via the `definition` "VisibilitySetRequest". */ /** @experimental */ -export interface UsageMetricsModelMetricTokenDetail { +export interface VisibilitySetRequest { + status: SessionVisibilityStatus; +} +/** + * Effective sharing status and shareable GitHub URL after updating session visibility. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "VisibilitySetResult". + */ +/** @experimental */ +export interface VisibilitySetResult { /** - * Accumulated token count for this token type + * Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent. */ - tokenCount: number; + synced: boolean; + status?: SessionVisibilityStatus; + /** + * Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + */ + shareUrl?: string; } /** * A single changed file and its unified diff. @@ -9970,7 +18248,7 @@ export interface UsageMetricsModelMetricTokenDetail { /** @experimental */ export interface WorkspaceDiffFileChange { /** - * Path to the changed file, relative to the workspace root. + * Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive). */ path: string; /** @@ -10006,12 +18284,55 @@ export interface WorkspaceDiffResult { */ baseBranch?: string; /** - * Whether a requested branch diff fell back to unstaged changes because branch diff failed. + * Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable. */ isFallback: boolean; + unavailableReason?: HistoryRewindUnavailableReason; +} +/** + * Compaction summary checkpoint to persist. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesAddSummaryRequest". + */ +/** @experimental */ +export interface WorkspacesAddSummaryRequest { + /** + * Summary title shown in checkpoint listings. + */ + title: string; + /** + * Markdown summary content to persist. + */ + content: string; +} +/** + * Persisted summary metadata and refreshed workspace metadata. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesAddSummaryResult". + */ +/** @experimental */ +export interface WorkspacesAddSummaryResult { + summary?: {}; + workspace?: {}; + [k: string]: unknown | undefined; +} +/** + * Whether the autopilot objective file exists. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesAutopilotObjectiveExistsResult". + */ +/** @experimental */ +export interface WorkspacesAutopilotObjectiveExistsResult { + /** + * True when the objective file exists. + */ + exists: boolean; } /** - * Schema for the `WorkspacesCheckpoints` type. + * Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. * * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema * via the `definition` "WorkspacesCheckpoints". @@ -10048,6 +18369,19 @@ export interface WorkspacesCreateFileRequest { */ content: string; } +/** + * Result of deleting the autopilot objective file. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesDeleteAutopilotObjectiveResult". + */ +/** @experimental */ +export interface WorkspacesDeleteAutopilotObjectiveResult { + /** + * True when a file was deleted. + */ + deleted: boolean; +} /** * Parameters for computing a workspace diff. * @@ -10057,6 +18391,23 @@ export interface WorkspacesCreateFileRequest { /** @experimental */ export interface WorkspacesDiffRequest { mode: WorkspaceDiffMode; + /** + * When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. + */ + ignoreWhitespace?: boolean; +} +/** + * Optional session context used when creating a local workspace. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesEnsureRequest". + */ +/** @experimental */ +export interface WorkspacesEnsureRequest { + /** + * Opaque workspace context supplied by the session host. + */ + context?: JsonValue; } /** * Current workspace metadata for the session, including its absolute filesystem path when available. @@ -10119,6 +18470,19 @@ export interface WorkspacesListFilesResult { */ files: string[]; } +/** + * Autopilot objective file content, or null when missing. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesReadAutopilotObjectiveResult". + */ +/** @experimental */ +export interface WorkspacesReadAutopilotObjectiveResult { + /** + * Autopilot objective file content, or null when missing. + */ + content: string | null; +} /** * Checkpoint number to read. * @@ -10154,71 +18518,223 @@ export interface WorkspacesReadCheckpointResult { /** @experimental */ export interface WorkspacesReadFileRequest { /** - * Relative path within the workspace files directory + * Relative path within the workspace files directory + */ + path: string; +} +/** + * Contents of the requested workspace file as a UTF-8 string. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesReadFileResult". + */ +/** @experimental */ +export interface WorkspacesReadFileResult { + /** + * File content as a UTF-8 string + */ + content: string; +} +/** + * Pasted content to save as a UTF-8 file in the session workspace. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesSaveLargePasteRequest". + */ +/** @experimental */ +export interface WorkspacesSaveLargePasteRequest { + /** + * Pasted content to save as a UTF-8 file + */ + content: string; +} +/** + * Descriptor for the saved paste file, or null when the workspace is unavailable. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesSaveLargePasteResult". + */ +/** @experimental */ +export interface WorkspacesSaveLargePasteResult { + /** + * Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) + */ + saved: { + /** + * Absolute filesystem path to the saved paste file + */ + filePath: string; + /** + * Filename within the workspace files directory + */ + filename: string; + /** + * Size of the saved file in bytes + */ + sizeBytes: number; + } | null; +} +/** + * Rollback point for local workspace summaries. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesTruncateSummariesRequest". + */ +/** @experimental */ +export interface WorkspacesTruncateSummariesRequest { + /** + * Number of newest summaries to keep. + */ + keepCount: number; +} +/** + * Workspace metadata fields to update. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesUpdateMetadataRequest". + */ +/** @experimental */ +export interface WorkspacesUpdateMetadataRequest { + /** + * Opaque workspace context supplied by the session host. + */ + context?: JsonValue; + /** + * Optional workspace display name override. + */ + name?: string; +} +/** + * Autopilot objective file content to persist. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesWriteAutopilotObjectiveRequest". + */ +/** @experimental */ +export interface WorkspacesWriteAutopilotObjectiveRequest { + /** + * Autopilot objective file content. + */ + content: string; +} +/** + * Result of writing the autopilot objective file. + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "WorkspacesWriteAutopilotObjectiveResult". + */ +/** @experimental */ +export interface WorkspacesWriteAutopilotObjectiveResult { + /** + * Filesystem operation performed. + */ + operation: string; +} + +/** @experimental */ +export interface SessionModelListRequest { + /** + * If true, bypasses the per-session model list cache and re-fetches from CAPI. + */ + skipCache?: boolean; +} + +/** @experimental */ +export interface SessionAgentListRequest { + /** + * When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. + */ + includeBuiltInAgents?: boolean; + /** + * When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. + */ + includePrompt?: boolean; +} +/** + * Standard MCP CallToolResult + * + * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema + * via the `definition` "SessionMcpAppsCallToolResult". + */ +/** @experimental */ +export interface SessionMcpAppsCallToolResult { + [k: string]: JsonValue | undefined; +} + +/** @experimental */ +export interface SessionPluginsReloadRequest { + /** + * Reload MCP server connections after refreshing plugins. Defaults to true. + */ + reloadMcp?: boolean; + /** + * Re-run custom-agent discovery after refreshing plugins. Defaults to true. + */ + reloadCustomAgents?: boolean; + /** + * Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). */ - path: string; + reloadHooks?: boolean; + /** + * Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). + */ + reloadExtensions?: boolean; + /** + * When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + */ + deferRepoHooks?: boolean; } -/** - * Contents of the requested workspace file as a UTF-8 string. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "WorkspacesReadFileResult". - */ + /** @experimental */ -export interface WorkspacesReadFileResult { +export interface SessionProviderGetEndpointRequest { /** - * File content as a UTF-8 string + * Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. */ - content: string; + modelId?: string; } -/** - * Pasted content to save as a UTF-8 file in the session workspace. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "WorkspacesSaveLargePasteRequest". - */ + /** @experimental */ -export interface WorkspacesSaveLargePasteRequest { +export interface SessionCommandsListRequest { /** - * Pasted content to save as a UTF-8 file + * Include runtime built-in commands */ - content: string; + includeBuiltins?: boolean; + /** + * Include enabled user-invocable skills and commands + */ + includeSkills?: boolean; + /** + * Include commands registered by protocol clients, including SDK clients and extensions + */ + includeClientCommands?: boolean; } -/** - * Descriptor for the saved paste file, or null when the workspace is unavailable. - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "WorkspacesSaveLargePasteResult". - */ + /** @experimental */ -export interface WorkspacesSaveLargePasteResult { +export interface SessionHistoryCompactRequest { /** - * Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) + * Optional user-provided instructions to focus the compaction summary */ - saved: { - /** - * Absolute filesystem path to the saved paste file - */ - filePath: string; - /** - * Filename within the workspace files directory - */ - filename: string; - /** - * Size of the saved file in bytes - */ - sizeBytes: number; - } | null; + customInstructions?: string; + /** + * What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). + */ + trigger?: /** User-requested compaction, e.g. the /compact command or a direct history.compact call. */ + | "manual" + /** Compaction requested while switching to a model with a smaller context window. */ + | "model_switch"; + /** + * Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. + */ + tokenLimit?: number; } -/** - * Standard MCP CallToolResult - * - * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema - * via the `definition` "SessionMcpAppsCallToolResult". - */ + /** @experimental */ -export interface SessionMcpAppsCallToolResult { - [k: string]: unknown | undefined; +export interface SessionLimitPredictionPredictRequest { + /** + * Optional model identifier override. If omitted, the session's current model is used. + */ + modelId?: string; + clientType?: SessionLimitPredictionClientType; } /** * Identifies the target session. @@ -10243,9 +18759,12 @@ export function createServerRpc(connection: MessageConnection) { * @param params Optional message to echo back to the caller. * * @returns Server liveness response, including the echoed message, current server timestamp, and protocol version. + * + * @experimental */ ping: async (params: PingRequest): Promise => connection.sendRequest("ping", params), + /** @experimental */ models: { /** * Lists Copilot models available to the authenticated user. @@ -10256,7 +18775,15 @@ export function createServerRpc(connection: MessageConnection) { */ list: async (params: ModelsListRequest): Promise => connection.sendRequest("models.list", params), + /** + * Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access. + * + * @returns The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. + */ + getBuiltInCatalog: async (): Promise => + connection.sendRequest("models.getBuiltInCatalog", {}), }, + /** @experimental */ tools: { /** * Lists built-in tools available for a model. @@ -10268,6 +18795,7 @@ export function createServerRpc(connection: MessageConnection) { list: async (params: ToolsListRequest): Promise => connection.sendRequest("tools.list", params), }, + /** @experimental */ account: { /** * Gets Copilot quota usage for the authenticated user or supplied GitHub token. @@ -10278,7 +18806,40 @@ export function createServerRpc(connection: MessageConnection) { */ getQuota: async (params: AccountGetQuotaRequest): Promise => connection.sendRequest("account.getQuota", params), + /** + * Gets the currently active authentication credentials from the global auth manager. + * + * @returns Current authentication state + */ + getCurrentAuth: async (): Promise => + connection.sendRequest("account.getCurrentAuth", {}), + /** + * Gets all authenticated users available for account switching. + * + * @returns List of all authenticated users + */ + getAllUsers: async (): Promise => + connection.sendRequest("account.getAllUsers", {}), + /** + * Stores authentication credentials after successful login (e.g., device code flow). + * + * @param params Credentials to store after successful authentication + * + * @returns Result of a successful login; throws on failure + */ + login: async (params: AccountLoginRequest): Promise => + connection.sendRequest("account.login", params), + /** + * Removes user authentication from keychain and persisted state. + * + * @param params User to log out + * + * @returns Logout result indicating if more users remain + */ + logout: async (params: AccountLogoutRequest): Promise => + connection.sendRequest("account.logout", params), }, + /** @experimental */ secrets: { /** * Registers secret values for redaction in session logs and exports. The SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens). @@ -10290,7 +18851,9 @@ export function createServerRpc(connection: MessageConnection) { addFilterValues: async (params: SecretsAddFilterValuesRequest): Promise => connection.sendRequest("secrets.addFilterValues", params), }, + /** @experimental */ mcp: { + /** @experimental */ config: { /** * Lists MCP servers from user configuration. @@ -10350,7 +18913,142 @@ export function createServerRpc(connection: MessageConnection) { discover: async (params: McpDiscoverRequest): Promise => connection.sendRequest("mcp.discover", params), }, + /** @experimental */ + extensions: { + /** + * Discovers user and enabled installed-plugin extensions from persisted Copilot home state, including enablement preferences. Launch-scoped additional plugins are not included. + * + * @returns Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + */ + discover: async (): Promise => + connection.sendRequest("extensions.discover", {}), + /** + * Persistently enables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.enable to update them. + * + * @param params Source-qualified extension identifiers to persistently enable for future sessions. + */ + enable: async (params: DiscoveredExtensionsEnableRequest): Promise => + connection.sendRequest("extensions.enable", params), + /** + * Persistently disables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.disable to update them. + * + * @param params Source-qualified extension identifiers to persistently disable for future sessions. + */ + disable: async (params: DiscoveredExtensionsDisableRequest): Promise => + connection.sendRequest("extensions.disable", params), + }, + /** + * Registers the calling SDK client as the per-entrypoint extension launch provider. Call before creating any sessions. When omitted, the runtime temporarily falls back to its built-in Node launcher for backward compatibility. + * + * @experimental + */ + registerExtensionLaunchProvider: async (): Promise => + connection.sendRequest("registerExtensionLaunchProvider", {}), + /** @experimental */ + plugins: { + /** + * Lists plugins installed in user/global state. + * + * @returns Plugins installed in user/global state. + */ + list: async (): Promise => + connection.sendRequest("plugins.list", {}), + /** + * Installs a plugin from a marketplace, GitHub repo, URL, or local path. + * + * @param params Plugin source and optional working directory for relative-path resolution. + * + * @returns Result of installing a plugin. + */ + install: async (params: PluginsInstallRequest): Promise => + connection.sendRequest("plugins.install", params), + /** + * Uninstalls an installed plugin. + * + * @param params Name (or spec) of the plugin to uninstall. + */ + uninstall: async (params: PluginsUninstallRequest): Promise => + connection.sendRequest("plugins.uninstall", params), + /** + * Updates an installed plugin to its latest published version. + * + * @param params Name (or spec) of the plugin to update. + * + * @returns Result of updating a single plugin. + */ + update: async (params: PluginsUpdateRequest): Promise => + connection.sendRequest("plugins.update", params), + /** + * Updates every installed plugin to its latest published version. + * + * @returns Result of updating all installed plugins. + */ + updateAll: async (): Promise => + connection.sendRequest("plugins.updateAll", {}), + /** + * Enables installed plugins for new sessions. + * + * @param params Plugin names (or specs) to enable. + */ + enable: async (params: PluginsEnableRequest): Promise => + connection.sendRequest("plugins.enable", params), + /** + * Disables installed plugins for new sessions. + * + * @param params Plugin names (or specs) to disable. + */ + disable: async (params: PluginsDisableRequest): Promise => + connection.sendRequest("plugins.disable", params), + /** @experimental */ + marketplaces: { + /** + * Lists all registered marketplaces (defaults + user-added). + * + * @returns All registered marketplaces, including built-in defaults. + */ + list: async (): Promise => + connection.sendRequest("plugins.marketplaces.list", {}), + /** + * Registers a new marketplace from a source (owner/repo, URL, or local path). + * + * @param params Marketplace source and optional working directory for relative-path resolution. + * + * @returns Result of registering a new marketplace. + */ + add: async (params: PluginsMarketplacesAddRequest): Promise => + connection.sendRequest("plugins.marketplaces.add", params), + /** + * Removes a previously-registered marketplace. When the marketplace has dependent plugins and `force` is not set, the marketplace is left intact and the result lists the dependents so the caller can decide whether to retry with `force=true`. + * + * @param params Name of the marketplace to remove and an optional force flag. + * + * @returns Outcome of the remove attempt, including dependent-plugin info when applicable. + */ + remove: async (params: PluginsMarketplacesRemoveRequest): Promise => + connection.sendRequest("plugins.marketplaces.remove", params), + /** + * Lists plugins advertised by a registered marketplace. + * + * @param params Name of the marketplace whose plugin catalog to fetch. + * + * @returns Plugins advertised by the marketplace. + */ + browse: async (params: PluginsMarketplacesBrowseRequest): Promise => + connection.sendRequest("plugins.marketplaces.browse", params), + /** + * Re-fetches one or all registered marketplace catalogs. + * + * @param params Optional marketplace name; omit to refresh all. + * + * @returns Result of refreshing one or more marketplace catalogs. + */ + refresh: async (params: PluginsMarketplacesRefreshRequest): Promise => + connection.sendRequest("plugins.marketplaces.refresh", params), + }, + }, + /** @experimental */ skills: { + /** @experimental */ config: { /** * Replaces the global list of disabled skills. @@ -10369,16 +19067,114 @@ export function createServerRpc(connection: MessageConnection) { */ discover: async (params: SkillsDiscoverRequest): Promise => connection.sendRequest("skills.discover", params), + /** + * Returns the canonical directories where a client may create skills that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. + * + * @param params Optional project paths to enumerate. + * + * @returns Canonical locations where skills can be created so the runtime will recognize them. + */ + getDiscoveryPaths: async (params: SkillsGetDiscoveryPathsRequest): Promise => + connection.sendRequest("skills.getDiscoveryPaths", params), + }, + /** @experimental */ + agents: { + /** + * Discovers custom agents across user, project, plugin, and remote sources. + * + * @param params Optional project paths to include in agent discovery. + * + * @returns Agents discovered across user, project, plugin, and remote sources. + */ + discover: async (params: AgentsDiscoverRequest): Promise => + connection.sendRequest("agents.discover", params), + /** + * Returns the canonical directories where a client may create custom agents that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. + * + * @param params Optional project paths to include when enumerating agent discovery directories. + * + * @returns Canonical locations where custom agents can be created so the runtime will recognize them. + */ + getDiscoveryPaths: async (params: AgentsGetDiscoveryPathsRequest): Promise => + connection.sendRequest("agents.getDiscoveryPaths", params), + }, + /** @experimental */ + instructions: { + /** + * Discovers instruction sources across user, repository, and plugin sources. + * + * @param params Optional project paths to include in instruction discovery. + * + * @returns Instruction sources discovered across user, repository, and plugin sources. + */ + discover: async (params: InstructionsDiscoverRequest): Promise => + connection.sendRequest("instructions.discover", params), + /** + * Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created. + * + * @param params Optional project paths to include when enumerating instruction discovery targets. + * + * @returns Canonical files and directories where custom instructions can be created so the runtime will recognize them. + */ + getDiscoveryPaths: async (params: InstructionsGetDiscoveryPathsRequest): Promise => + connection.sendRequest("instructions.getDiscoveryPaths", params), + }, + /** @experimental */ + commands: { + /** + * Lists the well-known built-in slash commands that work as the first message in a new session (e.g. /plan, /env), without requiring an active session. Commands that depend on session state, authentication, or a synced session are omitted. + * + * @returns Slash commands available in the session, after applying any include/exclude filters. + */ + list: async (): Promise => + connection.sendRequest("commands.list", {}), }, + /** @experimental */ user: { + /** @experimental */ settings: { /** * Drops this runtime process's in-memory user settings cache so the next settings read observes disk. */ reload: async (): Promise => connection.sendRequest("user.settings.reload", {}), + /** + * Lists every known user setting (settings.json overlaid with the legacy config.json, config.json wins), each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time. + * + * @returns Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. + */ + get: async (): Promise => + connection.sendRequest("user.settings.get", {}), + /** + * Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed. Returns the keys whose new value is shadowed by a legacy config.json entry (config.json wins on read), which the runtime leaves in place — such writes do not take effect until the legacy value is removed. + * + * @param params Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. + * + * @returns Outcome of writing user settings. + */ + set: async (params: UserSettingsSetRequest): Promise => + connection.sendRequest("user.settings.set", params), }, }, + /** @experimental */ + managedSettings: { + /** + * Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session. + * + * @returns Validated device-managed settings discovered before a session exists. + */ + read: async (): Promise => + connection.sendRequest("managedSettings.read", {}), + }, + /** @experimental */ + runtime: { + /** + * Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process. + */ + shutdown: async (): Promise => + connection.sendRequest("runtime.shutdown", {}), + }, + /** @experimental */ sessionFs: { /** * Registers an SDK client as the session filesystem provider. @@ -10391,7 +19187,44 @@ export function createServerRpc(connection: MessageConnection) { connection.sendRequest("sessionFs.setProvider", params), }, /** @experimental */ + llmInference: { + /** + * Registers an SDK client as the LLM inference callback provider. + * + * @returns Indicates whether the calling client was registered as the LLM inference provider. + */ + setProvider: async (): Promise => + connection.sendRequest("llmInference.setProvider", {}), + /** + * Delivers the response head (status + headers) for an in-flight request, correlated by the requestId the runtime supplied in httpRequestStart. Must be called exactly once per request before any httpResponseChunk frames. + * + * @param params Response head. + * + * @returns Whether the start frame was accepted. + */ + httpResponseStart: async (params: LlmInferenceHttpResponseStartRequest): Promise => + connection.sendRequest("llmInference.httpResponseStart", params), + /** + * Delivers a body byte range (or a terminal transport error) for an in-flight response, correlated by requestId. Set `end` true on the last chunk. When `error` is set the response terminates with a transport-level failure and the runtime raises an APIConnectionError. + * + * @param params A response body chunk or terminal error. + * + * @returns Whether the chunk was accepted. + */ + httpResponseChunk: async (params: LlmInferenceHttpResponseChunkRequest): Promise => + connection.sendRequest("llmInference.httpResponseChunk", params), + }, + /** @experimental */ sessions: { + /** + * Creates or resumes a local session and returns the opened session ID. + * + * @param params Open a session by creating, resuming, attaching, connecting to a remote, or handing off. + * + * @returns Result of opening a session. + */ + open: async (params: SessionOpenParams): Promise => + connection.sendRequest("sessions.open", params), /** * Creates a new session by forking persisted history from an existing session. * @@ -10411,11 +19244,11 @@ export function createServerRpc(connection: MessageConnection) { connect: async (params: ConnectRemoteSessionParams): Promise => connection.sendRequest("sessions.connect", params), /** - * Lists persisted sessions, optionally filtered by working-directory context. + * Lists sessions, optionally filtered by source and working-directory context. Returned entries are discriminated by `isRemote`: local entries carry only the lightweight `LocalSessionMetadataValue` shape; remote entries carry the full `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.). * - * @param params Optional metadata-load limit and filters applied to the returned sessions. + * @param params Optional source filter, metadata-load limit, and context filter applied to the returned sessions. * - * @returns Persisted sessions matching the filter, ordered most-recently-modified first. + * @returns Sessions matching the filter, ordered most-recently-modified first. */ list: async (params: SessionsListRequest): Promise => connection.sendRequest("sessions.list", params), @@ -10446,15 +19279,6 @@ export function createServerRpc(connection: MessageConnection) { */ getLastForContext: async (params: SessionsGetLastForContextRequest): Promise => connection.sendRequest("sessions.getLastForContext", params), - /** - * Computes the absolute path to a session's persisted events.jsonl file. - * - * @param params Session ID whose event-log file path to compute. - * - * @returns Absolute path to the session's events.jsonl file on disk. - */ - getEventFilePath: async (params: SessionsGetEventFilePathRequest): Promise => - connection.sendRequest("sessions.getEventFilePath", params), /** * Returns the on-disk byte size of each session's workspace directory. * @@ -10468,18 +19292,9 @@ export function createServerRpc(connection: MessageConnection) { * @param params Session IDs to test for live in-use locks. * * @returns Session IDs from the input set that are currently in use by another process. - */ - checkInUse: async (params: SessionsCheckInUseRequest): Promise => - connection.sendRequest("sessions.checkInUse", params), - /** - * Returns a session's persisted remote-steerable flag, if any has been recorded. - * - * @param params Session ID to look up the persisted remote-steerable flag for. - * - * @returns The session's persisted remote-steerable flag, or omitted when no value has been persisted. - */ - getPersistedRemoteSteerable: async (params: SessionsGetPersistedRemoteSteerableRequest): Promise => - connection.sendRequest("sessions.getPersistedRemoteSteerable", params), + */ + checkInUse: async (params: SessionsCheckInUseRequest): Promise => + connection.sendRequest("sessions.checkInUse", params), /** * Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and disposes the active session. * @@ -10561,6 +19376,49 @@ export function createServerRpc(connection: MessageConnection) { */ setAdditionalPlugins: async (params: SessionsSetAdditionalPluginsRequest): Promise => connection.sendRequest("sessions.setAdditionalPlugins", params), + /** + * Attaches the runtime-managed remote-control singleton to a session, awaiting initial setup. If remote control is already attached to a different session, the singleton is transferred (preserving the underlying Mission Control connection). Returns the final status. + * + * @param params Parameters for attaching the remote-control singleton to a session. + * + * @returns Wrapper for the singleton's current status. + */ + startRemoteControl: async (params: SessionsStartRemoteControlRequest): Promise => + connection.sendRequest("sessions.startRemoteControl", params), + /** + * Atomically rebinds the remote-control singleton to a different session, preserving the underlying Mission Control connection. When `expectedFromSessionId` is provided and does not match the singleton's current `attachedSessionId`, the transfer is rejected with `transferred: false` and the current status is returned unchanged. + * + * @param params Parameters for atomically rebinding the remote-control singleton. + * + * @returns Outcome of a transferRemoteControl call. + */ + transferRemoteControl: async (params: SessionsTransferRemoteControlRequest): Promise => + connection.sendRequest("sessions.transferRemoteControl", params), + /** + * Patches the steering state of the active remote-control singleton. When remote control is off, this is a no-op and the off status is returned. Today only `enabled: true` is actionable on the underlying exporter; passing `false` is reserved for future use. + * + * @param params Patch for the singleton's steering state. + * + * @returns Wrapper for the singleton's current status. + */ + setRemoteControlSteering: async (params: SessionsSetRemoteControlSteeringRequest): Promise => + connection.sendRequest("sessions.setRemoteControlSteering", params), + /** + * Stops the remote-control singleton. When `expectedSessionId` is provided and does not match the singleton's current `attachedSessionId`, the stop is rejected with `stopped: false` and the current status is returned unchanged (unless `force` is set, in which case the singleton is unconditionally torn down). + * + * @param params Parameters for stopping the remote-control singleton. + * + * @returns Outcome of a stopRemoteControl call. + */ + stopRemoteControl: async (params: SessionsStopRemoteControlRequest): Promise => + connection.sendRequest("sessions.stopRemoteControl", params), + /** + * Returns the current state of the remote-control singleton, including the attached session id and frontend URL when active. + * + * @returns Wrapper for the singleton's current status. + */ + getRemoteControlStatus: async (): Promise => + connection.sendRequest("sessions.getRemoteControlStatus", {}), }, /** @experimental */ agentRegistry: { @@ -10585,14 +19443,87 @@ export function createServerRpc(connection: MessageConnection) { export function createInternalServerRpc(connection: MessageConnection) { return { /** - * Performs the SDK server connection handshake and validates the optional connection token. + * Performs the SDK server connection handshake and validates the optional connection token. Marked internal because this is JSON-RPC transport plumbing invoked automatically by an SDK client's own `connect()` wrapper, not a user-facing method. Stays internal as long as the SDK client owns the handshake; would only become public if the SDK ever exposed the raw schema surface to consumers without a connection wrapper. * - * @param params Optional connection token presented by the SDK client during the handshake. + * @param params Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). * * @returns Handshake result reporting the server's protocol version and package version on success. + * + * @experimental */ connect: async (params: ConnectRequest): Promise => connection.sendRequest("connect", params), + /** @experimental */ + sessions: { + /** + * Reads lightweight persisted metadata for one local session without opening it. + * + * @param params Session ID whose persisted metadata should be read. + * + * @returns Persisted local session metadata when the session exists. + */ + getMetadata: async (params: SessionsGetMetadataRequest): Promise => + connection.sendRequest("sessions.getMetadata", params), + /** + * Lists recent local session IDs that contain user-visible history, omitting housekeeping-only sessions. + * + * @param params Limit for non-empty local session IDs. + * + * @returns Recent local session IDs that contain user-visible history. + */ + listNonEmptySessionIds: async (params: SessionsListNonEmptySessionIdsRequest): Promise => + connection.sendRequest("sessions.listNonEmptySessionIds", params), + /** + * Computes the absolute path to a session's persisted events.jsonl file. Internal: filesystem paths are only meaningful in-process (CLI and runtime share a filesystem). Currently used by the CLI's contribution-graph feature to read historical events directly. Remote SDK consumers must not depend on this; a proper event-query API would replace it if the contribution graph ever needed to work over the wire. + * + * @param params Session ID whose event-log file path to compute. + * + * @returns Absolute path to the session's events.jsonl file on disk. + */ + getEventFilePath: async (params: SessionsGetEventFilePathRequest): Promise => + connection.sendRequest("sessions.getEventFilePath", params), + /** + * Returns a session's persisted remote-steerable flag, if any has been recorded. Internal: this is CLI-specific book-keeping used by `--continue` / `--resume` to inherit the prior session's remote-steerable preference. SDK consumers that want similar behavior should manage their own persistence around start/stop calls rather than relying on this runtime-side flag. + * + * @param params Session ID to look up the persisted remote-steerable flag for. + * + * @returns The session's persisted remote-steerable flag, or omitted when no value has been persisted. + */ + getPersistedRemoteSteerable: async (params: SessionsGetPersistedRemoteSteerableRequest): Promise => + connection.sendRequest("sessions.getPersistedRemoteSteerable", params), + /** + * Deletes one local session from disk after running the same lifecycle hooks as the session manager. + * + * @param params Session ID to delete from disk. + */ + delete: async (params: SessionsDeleteRequest): Promise => + connection.sendRequest("sessions.delete", params), + /** + * Gets the dynamic-context board entry count associated with a session, when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, `rem_consolidation_complete`) can pair START / END board counts around the detached rem-agent spawn. "Dynamic context board" is a runtime-internal concept that is not part of the public SDK contract; the long-term plan is to relocate the telemetry emission into the runtime so this method can be deleted entirely. + * + * @param params Session ID whose board entry count should be returned. + * + * @returns Dynamic-context board entry count, when available. + */ + getBoardEntryCount: async (params: SessionsGetBoardEntryCountRequest): Promise => + connection.sendRequest("sessions.getBoardEntryCount", params), + /** + * Registers extension-provided tools on the given session, gated by an optional `enabled` callback. Returns an opaque unsubscribe function the caller must invoke to deregister the tools when the extension is torn down. Marked internal because `loader`, `enabled`, and the returned `unsubscribe` are in-process handles that cannot cross the JSON-RPC boundary. Disappears once extension discovery / launch / tool registration are owned by the runtime: SDK consumers will pass pure config (search paths, disabled ids) via `SessionOptions` and the runtime will resolve, launch, register, and tear down extensions itself. + * + * @param params Params to attach an extension loader's tools to a session. + * + * @returns Handle for releasing the extension tool registration. + */ + registerExtensionToolsOnSession: async (params: RegisterExtensionToolsParams): Promise => + connection.sendRequest("sessions.registerExtensionToolsOnSession", params), + /** + * Attaches (or detaches) an in-process ExtensionController delegate for the given session, used by shared-API surfaces that need to query or modify the session's extension state. Pass `controller: undefined` to detach. Marked internal because the controller is an in-process object that cannot cross the JSON-RPC boundary. Disappears alongside `registerExtensionToolsOnSession`: once the runtime owns extension management, the public surface exposes list/enable/disable/reload as dedicated RPCs served by the runtime. + * + * @param params Params to attach or detach an in-process ExtensionController delegate. + */ + configureSessionExtensions: async (params: ConfigureSessionExtensionsParams): Promise => + connection.sendRequest("sessions.configureSessionExtensions", params), + }, }; } @@ -10617,6 +19548,17 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ send: async (params: SendRequest): Promise => connection.sendRequest("session.send", { sessionId, ...params }), + /** + * Sends zero or more user messages to the session in a single turn and returns their message IDs. All provided messages are appended to the conversation in order, then exactly one agent turn runs over the resulting history. When the list is empty, one turn runs over the existing history with no new user message. Remote-backed (Mission Control) sessions do not support this method and will return an error. + * + * @param params Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. + * + * @returns Result of sending zero or more user messages + * + * @experimental + */ + sendMessages: async (params: SendMessagesRequest): Promise => + connection.sendRequest("session.sendMessages", { sessionId, ...params }), /** * Aborts the current agent turn. * @@ -10628,6 +19570,26 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ abort: async (params: AbortRequest): Promise => connection.sendRequest("session.abort", { sessionId, ...params }), + /** + * Interrupts the current main agent turn while leaving running background work (subagents, sidekicks, and promoted attached shells) alive. No-op when the main loop is not processing. + * + * @param params Parameters for interrupting the main agent turn. + * + * @returns Result of interrupting the main agent turn. + * + * @experimental + */ + interruptMainTurn: async (params: InterruptMainTurnRequest): Promise => + connection.sendRequest("session.interruptMainTurn", { sessionId, ...params }), + /** + * Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop. Promoted attached shells are left running. + * + * @returns The number of running background agents (task-registry agents) that were cancelled. + * + * @experimental + */ + cancelAllBackgroundAgents: async (): Promise => + connection.sendRequest("session.cancelAllBackgroundAgents", { sessionId }), /** * Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down. * @@ -10638,14 +19600,14 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin shutdown: async (params: ShutdownRequest): Promise => connection.sendRequest("session.shutdown", { sessionId, ...params }), /** @experimental */ - auth: { + gitHubAuth: { /** * Gets authentication status and account metadata for the session. * * @returns Authentication status and account metadata for the session. */ getStatus: async (): Promise => - connection.sendRequest("session.auth.getStatus", { sessionId }), + connection.sendRequest("session.gitHubAuth.getStatus", { sessionId }), /** * Updates the session's auth credentials used for outbound model and API requests. * @@ -10654,7 +19616,19 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * @returns Indicates whether the credential update succeeded. */ setCredentials: async (params: SessionSetCredentialsParams): Promise => - connection.sendRequest("session.auth.setCredentials", { sessionId, ...params }), + connection.sendRequest("session.gitHubAuth.setCredentials", { sessionId, ...params }), + }, + /** @experimental */ + debug: { + /** + * Collects a redacted session debug log bundle into a local archive or staging directory. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape. + * + * @param params Options for collecting a redacted session debug bundle. + * + * @returns Result of collecting a redacted debug bundle. + */ + collectLogs: async (params: DebugCollectLogsRequest): Promise => + connection.sendRequest("session.debug.collectLogs", { sessionId, ...params }), }, /** @experimental */ canvas: { @@ -10702,11 +19676,116 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin }, }, /** @experimental */ + factory: { + /** + * Runs a registered factory by name at the top level. + * + * @param params Parameters for invoking a registered factory. + * + * @returns Complete current or terminal factory run envelope. + */ + run: async (params: FactoryRunRequest): Promise => + connection.sendRequest("session.factory.run", { sessionId, ...params }), + /** + * Resumes a factory run using its persisted name, arguments, journal, and accounting. + * + * @param params Parameters for resuming a factory run from its persisted identity. + * + * @returns Resolved persisted factory identity and resumed run envelope. + */ + resume: async (params: FactoryResumeRequest): Promise => + connection.sendRequest("session.factory.resume", { sessionId, ...params }), + /** + * Gets the current or settled envelope for a factory run. + * + * @param params Parameters for retrieving a factory run. + * + * @returns Complete current or terminal factory run envelope. + */ + getRun: async (params: FactoryGetRunRequest): Promise => + connection.sendRequest("session.factory.getRun", { sessionId, ...params }), + /** + * Lists durable factory runs for this session in creation order. + * + * @param params Parameters for paging factory runs. + * + * @returns A page of factory runs in durable creation order. + */ + listRuns: async (params: FactoryListRunsRequest): Promise => + connection.sendRequest("session.factory.listRuns", { sessionId, ...params }), + /** + * Gets durable and live observability detail for one factory run. + * + * @param params Parameters for retrieving a factory run. + * + * @returns Full factory run observability detail. + */ + getRunDetail: async (params: FactoryGetRunRequest): Promise => + connection.sendRequest("session.factory.getRunDetail", { sessionId, ...params }), + /** + * Pages durable progress for one factory run. + * + * @param params Parameters for paging factory progress. + * + * @returns A bidirectional page of factory progress. + */ + getRunProgress: async (params: FactoryGetRunProgressRequest): Promise => + connection.sendRequest("session.factory.getRunProgress", { sessionId, ...params }), + /** + * Requests cancellation of a factory run and returns its run envelope. + * + * @param params Parameters for cancelling a factory run. + * + * @returns Complete current or terminal factory run envelope. + */ + cancel: async (params: FactoryCancelRequest): Promise => + connection.sendRequest("session.factory.cancel", { sessionId, ...params }), + /** + * Records a batch of ordered factory progress lines. + * + * @param params Parameters for recording factory progress. + * + * @returns Acknowledgement that a factory request was accepted. + */ + log: async (params: FactoryLogRequest): Promise => + connection.sendRequest("session.factory.log", { sessionId, ...params }), + /** + * Runs one factory-scoped subagent and returns its result. + * + * @param params Parameters for one factory-scoped subagent call. + * + * @returns Result of one factory-scoped subagent call. + */ + agent: async (params: FactoryAgentRequest): Promise => + connection.sendRequest("session.factory.agent", { sessionId, ...params }), + /** @experimental */ + journal: { + /** + * Reads a memoized factory journal entry. + * + * @param params Parameters for reading a factory journal entry. + * + * @returns Result of reading a factory journal entry. + */ + get: async (params: FactoryJournalGetRequest): Promise => + connection.sendRequest("session.factory.journal.get", { sessionId, ...params }), + /** + * Stores a memoized factory journal entry. + * + * @param params Parameters for storing a factory journal entry. + * + * @returns Acknowledgement that a factory request was accepted. + */ + put: async (params: FactoryJournalPutRequest): Promise => + connection.sendRequest("session.factory.journal.put", { sessionId, ...params }), + }, + }, + /** @experimental */ model: { /** * Gets the currently selected model for the session. * - * @returns The currently selected model, reasoning effort, and context tier for the session. + * @returns The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. */ getCurrent: async (): Promise => connection.sendRequest("session.model.getCurrent", { sessionId }), @@ -10735,7 +19814,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @returns The list of models available to this session. */ - list: async (params?: ModelListRequest): Promise => + list: async (params?: SessionModelListRequest): Promise => connection.sendRequest("session.model.list", { sessionId, ...params }), }, /** @experimental */ @@ -10802,6 +19881,20 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ delete: async (): Promise => connection.sendRequest("session.plan.delete", { sessionId }), + /** + * Reads todo rows from the session SQL database for plan rendering. + * + * @returns Todo rows read from the session SQL database. Empty when no session database is available. + */ + readSqlTodos: async (): Promise => + connection.sendRequest("session.plan.readSqlTodos", { sessionId }), + /** + * Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren't available. Clients should call this on session start and after every `session.todos_changed` event to refresh structured-UI rendering. + * + * @returns Todo rows + dependency edges read from the session SQL database. + */ + readSqlTodosWithDependencies: async (): Promise => + connection.sendRequest("session.plan.readSqlTodosWithDependencies", { sessionId }), }, /** @experimental */ workspaces: { @@ -10812,6 +19905,24 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ getWorkspace: async (): Promise => connection.sendRequest("session.workspaces.getWorkspace", { sessionId }), + /** + * Updates workspace metadata for a local session and returns the refreshed workspace. + * + * @param params Workspace metadata fields to update. + * + * @returns Current workspace metadata for the session, including its absolute filesystem path when available. + */ + updateMetadata: async (params: WorkspacesUpdateMetadataRequest): Promise => + connection.sendRequest("session.workspaces.updateMetadata", { sessionId, ...params }), + /** + * Ensures a local session workspace exists and returns it. + * + * @param params Optional session context used when creating a local workspace. + * + * @returns Current workspace metadata for the session, including its absolute filesystem path when available. + */ + ensure: async (params: WorkspacesEnsureRequest): Promise => + connection.sendRequest("session.workspaces.ensure", { sessionId, ...params }), /** * Lists files stored in the session workspace files directory. * @@ -10851,6 +19962,54 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ readCheckpoint: async (params: WorkspacesReadCheckpointRequest): Promise => connection.sendRequest("session.workspaces.readCheckpoint", { sessionId, ...params }), + /** + * Adds a compaction summary checkpoint to the local session workspace. + * + * @param params Compaction summary checkpoint to persist. + * + * @returns Persisted summary metadata and refreshed workspace metadata. + */ + addSummary: async (params: WorkspacesAddSummaryRequest): Promise => + connection.sendRequest("session.workspaces.addSummary", { sessionId, ...params }), + /** + * Truncates local workspace compaction summaries after a rollback. + * + * @param params Rollback point for local workspace summaries. + * + * @returns Current workspace metadata for the session, including its absolute filesystem path when available. + */ + truncateSummaries: async (params: WorkspacesTruncateSummariesRequest): Promise => + connection.sendRequest("session.workspaces.truncateSummaries", { sessionId, ...params }), + /** + * Reads the autopilot objective state file from the local session workspace. + * + * @returns Autopilot objective file content, or null when missing. + */ + readAutopilotObjective: async (): Promise => + connection.sendRequest("session.workspaces.readAutopilotObjective", { sessionId }), + /** + * Writes the autopilot objective state file in the local session workspace. + * + * @param params Autopilot objective file content to persist. + * + * @returns Result of writing the autopilot objective file. + */ + writeAutopilotObjective: async (params: WorkspacesWriteAutopilotObjectiveRequest): Promise => + connection.sendRequest("session.workspaces.writeAutopilotObjective", { sessionId, ...params }), + /** + * Deletes the autopilot objective state file from the local session workspace. + * + * @returns Result of deleting the autopilot objective file. + */ + deleteAutopilotObjective: async (): Promise => + connection.sendRequest("session.workspaces.deleteAutopilotObjective", { sessionId }), + /** + * Checks whether the local session workspace has an autopilot objective state file. + * + * @returns Whether the autopilot objective file exists. + */ + autopilotObjectiveExists: async (): Promise => + connection.sendRequest("session.workspaces.autopilotObjectiveExists", { sessionId }), /** * Saves pasted content as a UTF-8 file in the session workspace. * @@ -10861,7 +20020,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin saveLargePaste: async (params: WorkspacesSaveLargePasteRequest): Promise => connection.sendRequest("session.workspaces.saveLargePaste", { sessionId, ...params }), /** - * Computes a diff for the session workspace. + * Computes a diff for the session workspace. Never rejects for a busy session: a `session`-mode diff that cannot read the session's file-change captures falls back to an unstaged git diff with `isFallback: true` and reports why in `unavailableReason`. * * @param params Parameters for computing a workspace diff. * @@ -10871,6 +20030,25 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin connection.sendRequest("session.workspaces.diff", { sessionId, ...params }), }, /** @experimental */ + completions: { + /** + * Gets the characters that should trigger host-driven completions for the session. Empty disables host-driven completions (e.g. local sessions, or a relay host that does not advertise them). + * + * @returns Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). + */ + getTriggerCharacters: async (): Promise => + connection.sendRequest("session.completions.getTriggerCharacters", { sessionId }), + /** + * Requests host-driven completion items for the current composer input. Returns an empty list when the host has no items or does not support completions. + * + * @param params Request host-driven completions for the current composer input. + * + * @returns Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + */ + request: async (params: CompletionsRequestRequest): Promise => + connection.sendRequest("session.completions.request", { sessionId, ...params }), + }, + /** @experimental */ instructions: { /** * Gets instruction sources loaded for the session. @@ -10895,12 +20073,21 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin /** @experimental */ agent: { /** - * Lists custom agents available to the session. + * Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents. + * + * @param params Controls whether built-in agents and authored prompt text are included. + * + * @returns Agents available to the session. + */ + list: async (params?: SessionAgentListRequest): Promise => + connection.sendRequest("session.agent.list", { sessionId, ...params }), + /** + * Sets an in-memory authored prompt override for an available agent. For built-in agents, this replaces only the static base prompt while preserving runtime-owned dynamic prompt composition and behavior. The special `general-purpose` agent is not overrideable. Overrides are not persisted; resumed and forked sessions start without them, so the host must re-apply them. * - * @returns Custom agents available to the session. + * @param params An in-memory authored prompt override for an available agent. */ - list: async (): Promise => - connection.sendRequest("session.agent.list", { sessionId }), + setPrompt: async (params: AgentSetPromptRequest): Promise => + connection.sendRequest("session.agent.setPrompt", { sessionId, ...params }), /** * Gets the currently selected custom agent for the session. * @@ -11068,12 +20255,21 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin /** @experimental */ mcp: { /** - * Lists MCP servers configured for the session and their connection status. + * Lists MCP servers configured for the session, their connection status, and host-level state. The host-level state (disabled/filtered servers, failed/needs-auth/pending connections, mcp3p policy, full config) is empty/zero when no MCP host has been initialized for the session. * - * @returns MCP servers configured for the session, with their connection status. + * @returns MCP servers configured for the session, with their connection status and host-level state. */ list: async (): Promise => connection.sendRequest("session.mcp.list", { sessionId }), + /** + * Lists the tools exposed by a connected MCP server on this session's host. This performs a live `tools/list` request. Tool UI metadata is returned independently of whether MCP Apps rendering is enabled for the session. + * + * @param params Server name whose tool list should be returned. + * + * @returns Tools exposed by the connected MCP server. Throws when the server is not connected. + */ + listTools: async (params: McpListToolsRequest): Promise => + connection.sendRequest("session.mcp.listTools", { sessionId, ...params }), /** * Enables an MCP server for the session. * @@ -11127,17 +20323,84 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ removeGitHub: async (): Promise => connection.sendRequest("session.mcp.removeGitHub", { sessionId }), + /** + * Starts an individual MCP server on the live session. Omit `config` for a config-free start-by-name of an already-configured server (reuses the server's already-registered configuration); supply `config` to start from a caller-supplied configuration. Session-scoped and ephemeral: the server is added to this session's running set only and is reaped when the session ends. Does NOT modify persistent user configuration (`mcp.config.*`), so it does not affect future sessions. The server surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / `session.mcp_server_status_changed` events like any other server. + * + * @param params Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. + */ + startServer: async (params: McpStartServerRequest): Promise => + connection.sendRequest("session.mcp.startServer", { sessionId, ...params }), + /** + * Restarts an individual MCP server on the live session (stops then starts). Omit `config` for a config-free restart-by-name of an already-configured server; supply `config` to restart with a replacement configuration. Session-scoped and ephemeral: does NOT modify persistent user configuration (`mcp.config.*`). + * + * @param params Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. + */ + restartServer: async (params: McpRestartServerRequest): Promise => + connection.sendRequest("session.mcp.restartServer", { sessionId, ...params }), + /** + * Stops an individual MCP server on the session's host. + * + * @param params Server name for an individual MCP server stop. + */ + stopServer: async (params: McpStopServerRequest): Promise => + connection.sendRequest("session.mcp.stopServer", { sessionId, ...params }), + /** + * Checks whether a named MCP server is currently running on the session's host. + * + * @param params Server name to check running status for. + * + * @returns Whether the named MCP server is running. + */ + isServerRunning: async (params: McpIsServerRunningRequest): Promise => + connection.sendRequest("session.mcp.isServerRunning", { sessionId, ...params }), /** @experimental */ oauth: { + /** + * Resolves a pending MCP OAuth request with a host-provided token or cancellation. The pending request is emitted as mcp.oauth_required with the data necessary to authorize the request. + * + * @param params Pending MCP OAuth request ID and host-provided token or cancellation response. + * + * @returns Indicates whether the pending MCP OAuth response was accepted. + */ + handlePendingRequest: async (params: McpOauthHandlePendingRequest): Promise => + connection.sendRequest("session.mcp.oauth.handlePendingRequest", { sessionId, ...params }), + /** + * Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed. + * + * @param params Identifies the MCP server whose persisted OAuth credentials were updated. + */ + authenticationStateChanged: async (params: McpOauthAuthenticationStateChangedRequest): Promise => + connection.sendRequest("session.mcp.oauth.authenticationStateChanged", { sessionId, ...params }), /** * Starts OAuth authentication for a remote MCP server. * - * @param params Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. + * @param params Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. * * @returns OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. */ login: async (params: McpOauthLoginRequest): Promise => connection.sendRequest("session.mcp.oauth.login", { sessionId, ...params }), + /** + * Responds to a pending MCP OAuth authorization request by its request id. + * + * @param params Pending MCP OAuth request id to respond to. + * + * @returns Indicates whether the pending MCP OAuth response was accepted. + */ + respond: async (params: McpOauthRespondRequest): Promise => + connection.sendRequest("session.mcp.oauth.respond", { sessionId, ...params }), + }, + /** @experimental */ + headers: { + /** + * Responds to a pending MCP dynamic headers refresh request. Hosts that subscribe to `mcp.headers_refresh_required` use this to provide short-lived per-server headers or to indicate that no dynamic headers are available for this refresh. + * + * @param params MCP headers refresh request id and the host response. + * + * @returns Indicates whether the pending MCP headers refresh response was accepted. + */ + handlePendingHeadersRefreshRequest: async (params: McpHeadersHandlePendingHeadersRefreshRequestRequest): Promise => + connection.sendRequest("session.mcp.headers.handlePendingHeadersRefreshRequest", { sessionId, ...params }), }, /** @experimental */ apps: { @@ -11192,6 +20455,36 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin diagnose: async (params: McpAppsDiagnoseRequest): Promise => connection.sendRequest("session.mcp.apps.diagnose", { sessionId, ...params }), }, + /** @experimental */ + resources: { + /** + * Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`). + * + * @param params MCP server and resource URI to fetch. + * + * @returns Resource contents returned by the MCP server. + */ + read: async (params: McpResourcesReadRequest): Promise => + connection.sendRequest("session.mcp.resources.read", { sessionId, ...params }), + /** + * Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`. + * + * @param params MCP server whose resources to enumerate. + * + * @returns One page of resources advertised by the named MCP server. + */ + list: async (params: McpResourcesListRequest): Promise => + connection.sendRequest("session.mcp.resources.list", { sessionId, ...params }), + /** + * Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`. + * + * @param params MCP server whose resource templates to enumerate. + * + * @returns One page of resource templates advertised by the named MCP server. + */ + listTemplates: async (params: McpResourcesListTemplatesRequest): Promise => + connection.sendRequest("session.mcp.resources.listTemplates", { sessionId, ...params }), + }, }, /** @experimental */ plugins: { @@ -11202,6 +20495,34 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ list: async (): Promise => connection.sendRequest("session.plugins.list", { sessionId }), + /** + * Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately. + * + * @param params Optional flags controlling which side effects the reload performs. + */ + reload: async (params?: SessionPluginsReloadRequest): Promise => + connection.sendRequest("session.plugins.reload", { sessionId, ...params }), + }, + /** @experimental */ + provider: { + /** + * Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses. + * + * @param params Optional model identifier to scope the endpoint snapshot to. + * + * @returns A snapshot of the provider endpoint the session is currently configured to talk to. + */ + getEndpoint: async (params?: SessionProviderGetEndpointRequest): Promise => + connection.sendRequest("session.provider.getEndpoint", { sessionId, ...params }), + /** + * Adds BYOK providers and/or models to the session's registry at runtime, extending the additive registry built from the session's `providers`/`models` options. Both fields are optional, so a call may add providers only, models only, or both. Within a single call providers are registered before models, so a model may reference a provider added in the same call; across calls a model may reference any provider already registered (from session creation or a prior add). A model whose referenced provider is not registered by the end of the call is rejected. Newly added models become selectable via `model.list` / `model.switchTo` and are inherited by sub-agents spawned afterwards. + * + * @param params BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. + * + * @returns The selectable model entries synthesized for the models added by this call. + */ + add: async (params: ProviderAddRequest): Promise => + connection.sendRequest("session.provider.add", { sessionId, ...params }), }, /** @experimental */ options: { @@ -11253,6 +20574,13 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ reload: async (): Promise => connection.sendRequest("session.extensions.reload", { sessionId }), + /** + * Push attachments into the next user-message turn from an extension. The host should surface them as composer pills and forward them via the next session.send call. Callable only by extension-owned connections. + * + * @param params Parameters for session.extensions.sendAttachmentsToMessage. + */ + sendAttachmentsToMessage: async (params: SendAttachmentsToMessageParams): Promise => + connection.sendRequest("session.extensions.sendAttachmentsToMessage", { sessionId, ...params }), }, /** @experimental */ tools: { @@ -11279,6 +20607,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ getCurrentMetadata: async (): Promise => connection.sendRequest("session.tools.getCurrentMetadata", { sessionId }), + /** + * Updates the current session's live subagent settings after user settings change. The persisted user settings remain the source of truth for future sessions. + * + * @param params Subagent settings to apply to the current session + * + * @returns Empty result after applying subagent settings + */ + updateSubagentSettings: async (params: UpdateSubagentSettingsRequest): Promise => + connection.sendRequest("session.tools.updateSubagentSettings", { sessionId, ...params }), }, /** @experimental */ commands: { @@ -11289,14 +20626,14 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @returns Slash commands available in the session, after applying any include/exclude filters. */ - list: async (params?: CommandsListRequest): Promise => + list: async (params?: SessionCommandsListRequest): Promise => connection.sendRequest("session.commands.list", { sessionId, ...params }), /** * Invokes a slash command in the session. * * @param params Slash command name and optional raw input string to invoke. * - * @returns Result of invoking the slash command (text output, prompt to send to the agent, or completion). + * @returns Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). */ invoke: async (params: CommandsInvokeRequest): Promise => connection.sendRequest("session.commands.invoke", { sessionId, ...params }), @@ -11339,6 +20676,13 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin }, /** @experimental */ telemetry: { + /** + * Gets the telemetry engagement ID currently associated with the session, when available. + * + * @returns Telemetry engagement ID for the session, when available. + */ + getEngagementId: async (): Promise => + connection.sendRequest("session.telemetry.getEngagementId", { sessionId }), /** * Sets feature override key/value pairs to attach to subsequent telemetry events for the session. * @@ -11349,6 +20693,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin }, /** @experimental */ ui: { + /** + * Runs a transient no-tools model query against the current conversation context. + * + * @param params Transient question to answer without adding it to conversation history. + * + * @returns Transient answer generated from current conversation context. + */ + ephemeralQuery: async (params: UIEphemeralQueryRequest): Promise => + connection.sendRequest("session.ui.ephemeralQuery", { sessionId, ...params }), /** * Requests structured input from a UI-capable client. * @@ -11394,6 +20747,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ handlePendingAutoModeSwitch: async (params: UIHandlePendingAutoModeSwitchRequest): Promise => connection.sendRequest("session.ui.handlePendingAutoModeSwitch", { sessionId, ...params }), + /** + * Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action. + * + * @param params Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. + * + * @returns Indicates whether the pending UI request was resolved by this call. + */ + handlePendingSessionLimitsExhausted: async (params: UIHandlePendingSessionLimitsExhaustedRequest): Promise => + connection.sendRequest("session.ui.handlePendingSessionLimitsExhausted", { sessionId, ...params }), /** * Resolves a pending `exit_plan_mode.requested` event with the user's response. * @@ -11457,18 +20819,18 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin setApproveAll: async (params: PermissionsSetApproveAllRequest): Promise => connection.sendRequest("session.permissions.setApproveAll", { sessionId, ...params }), /** - * Enables or disables full allow-all permissions (tools, paths, and URLs) for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the unrestricted path and URL managers and emits `session.permissions_changed` on transition. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. + * Sets the allow-all permission mode for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. The `on` mode swaps in unrestricted path and URL managers and emits `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths active while attaching LLM safety recommendations. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. * - * @param params Whether to enable full allow-all permissions for the session. + * @param params Allow-all mode to apply for the session. * * @returns Indicates whether the operation succeeded and reports the post-mutation state. */ setAllowAll: async (params: PermissionsSetAllowAllRequest): Promise => connection.sendRequest("session.permissions.setAllowAll", { sessionId, ...params }), /** - * Returns whether full allow-all permissions are currently active for the session. + * Returns the current allow-all permission mode for the session. * - * @returns Current full allow-all permission state. + * @returns Current allow-all permission mode. */ getAllowAll: async (): Promise => connection.sendRequest("session.permissions.getAllowAll", { sessionId }), @@ -11493,10 +20855,12 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin /** * Clears session-scoped tool permission approvals. * + * @param params Clears session-scoped tool permission approvals, and optionally the location-scoped ones. + * * @returns Indicates whether the operation succeeded. */ - resetSessionApprovals: async (): Promise => - connection.sendRequest("session.permissions.resetSessionApprovals", { sessionId }), + resetSessionApprovals: async (params: PermissionsResetSessionApprovalsRequest): Promise => + connection.sendRequest("session.permissions.resetSessionApprovals", { sessionId, ...params }), /** * Notifies the runtime that a permission prompt UI has been shown to the user. * @@ -11643,6 +21007,13 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ isProcessing: async (): Promise => connection.sendRequest("session.metadata.isProcessing", { sessionId }), + /** + * Returns a snapshot of activity flags for the session. + * + * @returns Current activity flags for the session. + */ + activity: async (): Promise => + connection.sendRequest("session.metadata.activity", { sessionId }), /** * Returns the token breakdown for the session's current context window for a given model. * @@ -11653,20 +21024,36 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin contextInfo: async (params: MetadataContextInfoRequest): Promise => connection.sendRequest("session.metadata.contextInfo", { sessionId, ...params }), /** - * Records a working-directory/git context change and emits a `session.context_changed` event. + * Returns the experimental per-source attribution breakdown of the session's current context window as a flat list of entries (skills, subagents, MCP servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via parentId), plus the successful compaction count. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. Returns null until the session has initialized its system prompt and tool metadata. + * + * @returns Per-source attribution breakdown for the session's current context window, or null if uninitialized. + */ + getContextAttribution: async (): Promise => + connection.sendRequest("session.metadata.getContextAttribution", { sessionId }), + /** + * Returns the largest individual messages currently in the session's context window, most-expensive first. Companion to `metadata.getContextAttribution`. Returns an empty list until the session has initialized. + * + * @param params Parameters for the heaviest-messages query. + * + * @returns The heaviest individual messages in the session's context window, most-expensive first. + */ + getContextHeaviestMessages: async (params: MetadataContextHeaviestMessagesRequest): Promise => + connection.sendRequest("session.metadata.getContextHeaviestMessages", { sessionId, ...params }), + /** + * Records a working-directory/git context change and emits a `session.context_changed` event. For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event): a local session's working directory is authoritative and is moved via `metadata.setWorkingDirectory` (or an SDK `session.resume` that supplies a `workingDirectory`), not by this method. * * @param params Updated working-directory/git context to record on the session. * - * @returns Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). + * @returns Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. */ recordContextChange: async (params: MetadataRecordContextChangeRequest): Promise => connection.sendRequest("session.metadata.recordContextChange", { sessionId, ...params }), /** - * Updates the session's recorded working directory. + * Updates the session's working directory. For local sessions the target is validated first (an absolute path that exists on disk) and the permission primary directory is re-based; a rejected validation fails the call before any session state changes. * - * @param params Absolute path to set as the session's new working directory. + * @param params Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. * - * @returns Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. + * @returns Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. */ setWorkingDirectory: async (params: MetadataSetWorkingDirectoryRequest): Promise => connection.sendRequest("session.metadata.setWorkingDirectory", { sessionId, ...params }), @@ -11681,9 +21068,21 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin connection.sendRequest("session.metadata.recomputeContextTokens", { sessionId, ...params }), }, /** @experimental */ + contentExclusion: { + /** + * Checks local file system absolute paths within the session working directory against its content-exclusion policy. Results preserve input order. Unsupported paths/filesystems and unavailable policy evaluation return available false, and callers must treat every requested path as excluded. + * + * @param params Local file system absolute paths within the session working directory to check against its content-exclusion policy. + * + * @returns Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. + */ + checkPaths: async (params: ContentExclusionCheckPathsRequest): Promise => + connection.sendRequest("session.contentExclusion.checkPaths", { sessionId, ...params }), + }, + /** @experimental */ shell: { /** - * Starts a shell command and streams output through session notifications. + * Starts a shell command and streams output through session notifications. The command runs as the leader of its own process group (POSIX) or in a dedicated job object (Windows), so a forced termination — via "shell.kill", the request timeout, or session disposal — signals that whole group/job rather than only the direct child. Two gaps are worth planning for: a command that exits on its own does not trigger that teardown, and on POSIX a descendant that moves itself into a new session or process group (for example via "setsid") leaves the signalled group, so either can leave a background process running. * * @param params Shell command to run, with optional working directory and timeout in milliseconds. * @@ -11692,7 +21091,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin exec: async (params: ShellExecRequest): Promise => connection.sendRequest("session.shell.exec", { sessionId, ...params }), /** - * Sends a signal to a shell process previously started via "shell.exec". + * Sends a signal to a shell process previously started via "shell.exec". The signal targets the command's whole process group (POSIX) or job object (Windows), so descendants still in that group are signalled too, not just the direct child. On POSIX a descendant that moved itself into a new session or process group (for example via "setsid") is no longer in the signalled group and survives. * * @param params Identifier of a process previously returned by "shell.exec" and the signal to send. * @@ -11700,6 +21099,24 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ kill: async (params: ShellKillRequest): Promise => connection.sendRequest("session.shell.kill", { sessionId, ...params }), + /** + * Executes a user-requested shell command through the session runtime. + * + * @param params User-requested shell command and cancellation handle. + * + * @returns Result of a user-requested shell command. + */ + executeUserRequested: async (params: ShellExecuteUserRequestedRequest): Promise => + connection.sendRequest("session.shell.executeUserRequested", { sessionId, ...params }), + /** + * Cancels a user-requested shell command by request ID. + * + * @param params User-requested shell execution cancellation handle. + * + * @returns Cancellation result for a user-requested shell command. + */ + cancelUserRequested: async (params: ShellCancelUserRequestedRequest): Promise => + connection.sendRequest("session.shell.cancelUserRequested", { sessionId, ...params }), }, /** @experimental */ history: { @@ -11710,7 +21127,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin * * @returns Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. */ - compact: async (params?: HistoryCompactRequest): Promise => + compact: async (params?: SessionHistoryCompactRequest): Promise => connection.sendRequest("session.history.compact", { sessionId, ...params }), /** * Truncates persisted session history to a specific event. @@ -11721,6 +21138,31 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ truncate: async (params: HistoryTruncateRequest): Promise => connection.sendRequest("session.history.truncate", { sessionId, ...params }), + /** + * Lists the user turns that the session can rewind to. Never rejects for a busy session: rewind reads need the session's file-change captures to be settled, so a session that still holds active work answers with `unavailableReason: "session-busy"` and no points, which the caller can retry. + * + * @returns Rewind points and file-change-tracking availability for the session. + */ + listRewindPoints: async (): Promise => + connection.sendRequest("session.history.listRewindPoints", { sessionId }), + /** + * Previews the files that a conversation-and-files rewind would restore. + * + * @param params Event boundary to preview for conversation-and-files rewind. + * + * @returns Files and aggregate changes for a prospective rewind. + */ + previewRewind: async (params: HistoryPreviewRewindRequest): Promise => + connection.sendRequest("session.history.previewRewind", { sessionId, ...params }), + /** + * Rewinds the session conversation, optionally restoring files changed by the discarded turns. Not crash-atomic: file restore and conversation truncation are separate stores, applied in that order, so a process crash between them can leave the workspace rewound while the conversation still contains the discarded turns. There is no recovery journal; re-running the same rewind is the recovery path for a crash before truncation lands, since file restore is idempotent (already-restored files are reported as skipped) and truncation is re-derived from the still-retained boundary event. After truncation lands that boundary no longer exists, so the same request is rejected; the only stage that can still be outstanding is snapshot pruning, whose failure leaves orphan snapshots the capture store tolerates. The reverse inconsistency cannot occur, because truncation is never applied before file restore succeeds. + * + * @param params Boundary and mode for rewinding session history. + * + * @returns Structured outcome of a rewind request. + */ + rewind: async (params: HistoryRewindRequest): Promise => + connection.sendRequest("session.history.rewind", { sessionId, ...params }), /** * Cancels any in-progress background compaction on a local session. * @@ -11742,6 +21184,15 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ summarizeForHandoff: async (): Promise => connection.sendRequest("session.history.summarizeForHandoff", { sessionId }), + /** + * Clears the session's conversation history, keeping only system and developer messages, and seeds the fresh context window with a first user message. Must be called from inside a tool handler: the clear has to drop the results of the tool calls its wipe orphans, and it rejects when no tool call is in flight. + * + * @param params Parameters for clearing the conversation and seeding the window that replaces it. + * + * @returns What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. + */ + clearContext: async (params: HistoryClearContextRequest): Promise => + connection.sendRequest("session.history.clearContext", { sessionId, ...params }), }, /** @experimental */ queue: { @@ -11752,6 +21203,67 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin */ pendingItems: async (): Promise => connection.sendRequest("session.queue.pendingItems", { sessionId }), + /** + * Moves an addressable queued item to a public visible position. + * + * @param params Parameters for moving a queued item by stable id. + * + * @returns Result of moving a queued item. + */ + moveItem: async (params: QueueMoveItemRequest): Promise => + connection.sendRequest("session.queue.moveItem", { sessionId, ...params }), + /** + * Inserts a new queued message at a public visible position. + * + * @param params Parameters for inserting a queued message at a public visible position. + * + * @returns Result of inserting a queued message. + */ + insertAt: async (params: QueueInsertAtRequest): Promise => + connection.sendRequest("session.queue.insertAt", { sessionId, ...params }), + /** + * Removes an addressable queued item by its stable id. + * + * @param params Parameters for removing a queued item by stable id. + * + * @returns Result of removing a queued item. + */ + removeAt: async (params: QueueRemoveAtRequest): Promise => + connection.sendRequest("session.queue.removeAt", { sessionId, ...params }), + /** + * Updates the text of an addressable single-message queue item. + * + * @param params Parameters for editing a single queued message. + * + * @returns Result of editing a queued message. + */ + updateText: async (params: QueueUpdateTextRequest): Promise => + connection.sendRequest("session.queue.updateText", { sessionId, ...params }), + /** + * Duplicates an addressable queued item immediately after its source. + * + * @param params Parameters for duplicating a queued item. + * + * @returns Result of duplicating a queued item. + */ + duplicateAt: async (params: QueueDuplicateAtRequest): Promise => + connection.sendRequest("session.queue.duplicateAt", { sessionId, ...params }), + /** + * Acquires or releases the queued-lane drain pause. + * + * @param params Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. + */ + setDrainPaused: async (params: QueueSetDrainPausedRequest): Promise => + connection.sendRequest("session.queue.setDrainPaused", { sessionId, ...params }), + /** + * Moves an addressable queued message into the live turn's steering lane. + * + * @param params Parameters for steering a queued message into a live turn. + * + * @returns Result of trying to steer a queued message into a live turn. + */ + sendNow: async (params: QueueSendNowRequest): Promise => + connection.sendRequest("session.queue.sendNow", { sessionId, ...params }), /** * Removes the most recently queued user-facing item (LIFO). * @@ -11768,7 +21280,7 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin /** @experimental */ eventLog: { /** - * Reads a batch of session events from a cursor, optionally waiting for new events. + * Reads a batch of session events from a cursor, optionally waiting for new events. Supports tail-first reads via `direction: backward`. * * @param params Cursor, batch size, and optional long-poll/filter parameters for reading session events. * @@ -11813,6 +21325,18 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin connection.sendRequest("session.usage.getMetrics", { sessionId }), }, /** @experimental */ + limitPrediction: { + /** + * Predicts an AI-credit session limit for the session's resolved model. Returns an unavailable result instead of falling back when the current model is unresolved auto. + * + * @param params Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + * + * @returns Prediction result. Available results include prediction details; unavailable results include an explicit reason. + */ + predict: async (params?: SessionLimitPredictionPredictRequest): Promise => + connection.sendRequest("session.limitPrediction.predict", { sessionId, ...params }), + }, + /** @experimental */ remote: { /** * Enables remote session export or steering. @@ -11839,6 +21363,25 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin connection.sendRequest("session.remote.notifySteerableChanged", { sessionId, ...params }), }, /** @experimental */ + visibility: { + /** + * Returns the session's current Mission Control sharing status and shareable GitHub URL. Reflects whether the synced session is visible to repository readers ("repo") or restricted to its creator and collaborators ("unshared"). + * + * @returns Current sharing status and shareable GitHub URL for a session. + */ + get: async (): Promise => + connection.sendRequest("session.visibility.get", { sessionId }), + /** + * Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers. Returns the effective status and shareable GitHub URL after the change. + * + * @param params Desired sharing status for the session. + * + * @returns Effective sharing status and shareable GitHub URL after updating session visibility. + */ + set: async (params: VisibilitySetRequest): Promise => + connection.sendRequest("session.visibility.set", { sessionId, ...params }), + }, + /** @experimental */ schedule: { /** * Lists the session's currently active scheduled prompts. @@ -11860,6 +21403,236 @@ export function createSessionRpc(connection: MessageConnection, sessionId: strin }; } +/** + * Create typed session-scoped RPC methods that are part of the SDK's internal + * surface. Not exported on the public client API. + * @internal + */ +export function createInternalSessionRpc(connection: MessageConnection, sessionId: string) { + return { + /** + * Queues or sends an internal system notification to the session according to its passive policy. + * + * @param params Internal request for sending a system notification. + * + * @experimental + */ + sendSystemNotification: async (params: SendSystemNotificationRequest): Promise => + connection.sendRequest("session.sendSystemNotification", { sessionId, ...params }), + /** @experimental */ + mcp: { + /** + * Reloads MCP server connections for the session with an explicit host-provided configuration. + * + * @param params Opaque MCP reload configuration. + * + * @returns MCP server startup filtering result. + */ + reloadWithConfig: async (params: McpReloadWithConfigRequest): Promise => + connection.sendRequest("session.mcp.reloadWithConfig", { sessionId, ...params }), + /** + * Configures the built-in GitHub MCP server for the session's current auth context. + * + * @param params Opaque auth info used to configure GitHub MCP. + * + * @returns Result of configuring GitHub MCP. + */ + configureGitHub: async (params: McpConfigureGitHubRequest): Promise => + connection.sendRequest("session.mcp.configureGitHub", { sessionId, ...params }), + /** + * Registers a pre-connected external MCP client (e.g. IDE) on the session's host. The caller retains lifecycle ownership of the client and transport. Marked internal because the `client` and `transport` arguments are in-process MCP SDK instances that cannot be serialized across the JSON-RPC boundary; once the CLI moves on top of the SDK, external clients will be expressed as transport configs the runtime can construct itself. + * + * @param params Registration parameters for an external MCP client. + */ + registerExternalClient: async (params: McpRegisterExternalClientRequest): Promise => + connection.sendRequest("session.mcp.registerExternalClient", { sessionId, ...params }), + /** + * Unregisters a previously registered external MCP client by server name. Marked internal as the paired companion of `registerExternalClient`: only in-process callers that registered a client this way can meaningfully unregister it. Disappears alongside `registerExternalClient`: once external clients are described to the runtime as config rather than handed in as instances, lifecycle (including deregistration) is owned entirely by the runtime. + * + * @param params Server name identifying the external client to remove. + */ + unregisterExternalClient: async (params: McpUnregisterExternalClientRequest): Promise => + connection.sendRequest("session.mcp.unregisterExternalClient", { sessionId, ...params }), + }, + /** @experimental */ + settings: { + /** + * Returns a redacted snapshot of session runtime settings, with secrets and raw feature flags excluded. Internal: the runtime settings shape is a runtime-internal surface and is deliberately kept out of the public SDK, because consumers should not depend on the runtime's internal settings layout. It remains callable in-process and is expected to be reworked as the runtime internals are consolidated. + * + * @returns Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. + */ + snapshot: async (): Promise => + connection.sendRequest("session.settings.snapshot", { sessionId }), + /** + * Evaluates a named Rust-owned settings predicate without exposing raw feature flags. Internal: the raw feature-flag names and composition are runtime-internal, so this predicate-evaluation helper is kept out of the public SDK surface and is callable in-process only. + * + * @param params Named Rust-owned settings predicate to evaluate for this session. + * + * @returns Result of evaluating a Rust-owned settings predicate. + */ + evaluatePredicate: async (params: SessionSettingsEvaluatePredicateRequest): Promise => + connection.sendRequest("session.settings.evaluatePredicate", { sessionId, ...params }), + }, + /** @experimental */ + queue: { + /** + * Returns the internal native queue snapshot for in-process session orchestration. + * + * @returns Internal snapshot of native queue state for local session orchestration. + */ + snapshot: async (): Promise => + connection.sendRequest("session.queue.snapshot", { sessionId }), + /** + * Reports whether the local session has native queued work pending. + * + * @returns Whether the native queue has pending work. + */ + hasPending: async (): Promise => + connection.sendRequest("session.queue.hasPending", { sessionId }), + /** + * Begins a native deferred-idle drain when background work has quiesced. + * + * @param params Inputs for starting a deferred-idle drain. + * + * @returns Whether a deferred-idle drain should run. + */ + beginDeferredIdleDrain: async (params: QueueBeginDeferredIdleDrainRequest): Promise => + connection.sendRequest("session.queue.beginDeferredIdleDrain", { sessionId, ...params }), + /** + * Finishes a native deferred-idle drain and reports whether to drain queue work or emit idle. + * + * @param params Inputs for completing a deferred-idle drain. + * + * @returns Action selected by the native deferred-idle drain. + */ + finishDeferredIdleDrain: async (params: QueueFinishDeferredIdleDrainRequest): Promise => + connection.sendRequest("session.queue.finishDeferredIdleDrain", { sessionId, ...params }), + /** + * Marks session.idle as deferred by native background work state. + * + * @param params Inputs for marking session.idle deferred in native state. + */ + deferSessionIdle: async (params: QueueDeferSessionIdleRequest): Promise => + connection.sendRequest("session.queue.deferSessionIdle", { sessionId, ...params }), + /** + * Consumes queued native system notifications matching an internal filter. + * + * @param params Internal filter for consuming queued system notifications. + * + * @returns Indicates whether a user-facing pending item was removed. + */ + consumeSystemNotifications: async (params: QueueConsumeSystemNotificationsRequest): Promise => + connection.sendRequest("session.queue.consumeSystemNotifications", { sessionId, ...params }), + /** + * Enqueues the internal resume-pending wake item when orphan handling needs a follow-up turn. + * + * @returns Result of enqueueing the resume-pending wake item. + */ + enqueueResumePending: async (): Promise => + connection.sendRequest("session.queue.enqueueResumePending", { sessionId }), + /** + * Drains the native local-session work queue for in-process session orchestration. + */ + process: async (): Promise => + connection.sendRequest("session.queue.process", { sessionId }), + }, + /** @experimental */ + schedule: { + /** + * Hydrates the native schedule registry from persisted session events. + */ + hydrate: async (): Promise => + connection.sendRequest("session.schedule.hydrate", { sessionId }), + /** + * Reports whether the session has an active self-paced scheduled prompt. + * + * @returns Whether the session currently has an active self-paced schedule. + */ + hasSelfPaced: async (): Promise => + connection.sendRequest("session.schedule.hasSelfPaced", { sessionId }), + /** + * Registers a relative-interval scheduled prompt. + * + * @param params Register a relative-interval scheduled prompt. + * + * @returns Result of registering or re-arming a scheduled prompt. + */ + add: async (params: ScheduleAddRequest): Promise => + connection.sendRequest("session.schedule.add", { sessionId, ...params }), + /** + * Registers a recurring cron scheduled prompt. + * + * @param params Register a cron scheduled prompt. + * + * @returns Result of registering or re-arming a scheduled prompt. + */ + addCron: async (params: ScheduleAddCronRequest): Promise => + connection.sendRequest("session.schedule.addCron", { sessionId, ...params }), + /** + * Registers an absolute-time scheduled prompt. + * + * @param params Register an absolute-time scheduled prompt. + * + * @returns Result of registering or re-arming a scheduled prompt. + */ + addAt: async (params: ScheduleAddAtRequest): Promise => + connection.sendRequest("session.schedule.addAt", { sessionId, ...params }), + /** + * Registers a self-paced scheduled prompt. + * + * @param params Register a self-paced scheduled prompt. + * + * @returns Result of registering or re-arming a scheduled prompt. + */ + addSelfPaced: async (params: ScheduleAddSelfPacedRequest): Promise => + connection.sendRequest("session.schedule.addSelfPaced", { sessionId, ...params }), + /** + * Re-arms an active self-paced scheduled prompt. + * + * @param params Re-arm a self-paced scheduled prompt. + * + * @returns Result of registering or re-arming a scheduled prompt. + */ + rearmSelfPaced: async (params: ScheduleRearmSelfPacedRequest): Promise => + connection.sendRequest("session.schedule.rearmSelfPaced", { sessionId, ...params }), + }, + }; +} + +/** Handler for `providerToken` client session API methods. */ +/** @experimental */ +export interface ProviderTokenHandler { + /** + * Asks the SDK client to get a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Session-scoped: the runtime calls it back on the connection that most recently supplied that provider's config for the session (the creating connection, or a resuming connection if the session was resumed — distinct providers may be owned by different connections), passing the provider name, and uses the returned token as the Authorization header for the outbound model request. The runtime does no caching — it calls this once per outbound request; the SDK consumer owns token acquisition, caching, and refresh. + * + * @param params Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. + * + * @returns A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. + */ + getToken(params: ProviderTokenAcquireRequest): Promise; +} + +/** Handler for `factory` client session API methods. */ +/** @experimental */ +export interface FactoryHandler { + /** + * Asks the owning extension connection to execute a registered factory closure. + * + * @param params Parameters sent to the owning extension to execute a factory closure. + * + * @returns Result returned by an extension factory closure. + */ + execute(params: FactoryExecuteRequest): Promise; + /** + * Asks the owning extension connection to abort a running factory cooperatively. + * + * @param params Parameters for cooperatively aborting a factory body. + * + * @returns Acknowledgement that a factory request was accepted. + */ + abort(params: FactoryAbortRequest): Promise; +} + /** Handler for `sessionFs` client session API methods. */ /** @experimental */ export interface SessionFsHandler { @@ -11944,13 +21717,21 @@ export interface SessionFsHandler { */ rename(params: SessionFsRenameRequest): Promise; /** - * Executes a SQLite query against the per-session database. + * Executes a SQLite query against the per-session database. Providers apply busy handling for every call. * - * @param params SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. + * @param params SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. * * @returns Query results including rows, columns, and rows affected, or a filesystem error if execution failed. */ sqliteQuery(params: SessionFsSqliteQueryRequest): Promise; + /** + * Executes SQLite statements atomically on the provider-owned connection. + * + * @param params Statements to execute atomically. Providers apply busy handling for every call. + * + * @returns Per-statement results, or a classified transaction error. + */ + sqliteTransaction(params: SessionFsSqliteTransactionRequest): Promise; /** * Checks whether the per-session SQLite database already exists, without creating it. * @@ -11990,6 +21771,8 @@ export interface CanvasHandler { /** All client session API handler groups. */ export interface ClientSessionApiHandlers { + providerToken?: ProviderTokenHandler; + factory?: FactoryHandler; sessionFs?: SessionFsHandler; canvas?: CanvasHandler; } @@ -12004,6 +21787,21 @@ export function registerClientSessionApiHandlers( connection: MessageConnection, getHandlers: (sessionId: string) => ClientSessionApiHandlers, ): void { + connection.onRequest("providerToken.getToken", async (params: ProviderTokenAcquireRequest) => { + const handler = getHandlers(params.sessionId).providerToken; + if (!handler) throw new Error(`No providerToken handler registered for session: ${params.sessionId}`); + return handler.getToken(params); + }); + connection.onRequest("factory.execute", async (params: FactoryExecuteRequest) => { + const handler = getHandlers(params.sessionId).factory; + if (!handler) throw new Error(`No factory handler registered for session: ${params.sessionId}`); + return handler.execute(params); + }); + connection.onRequest("factory.abort", async (params: FactoryAbortRequest) => { + const handler = getHandlers(params.sessionId).factory; + if (!handler) throw new Error(`No factory handler registered for session: ${params.sessionId}`); + return handler.abort(params); + }); connection.onRequest("sessionFs.readFile", async (params: SessionFsReadFileRequest) => { const handler = getHandlers(params.sessionId).sessionFs; if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`); @@ -12059,6 +21857,11 @@ export function registerClientSessionApiHandlers( if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`); return handler.sqliteQuery(params); }); + connection.onRequest("sessionFs.sqliteTransaction", async (params: SessionFsSqliteTransactionRequest) => { + const handler = getHandlers(params.sessionId).sessionFs; + if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`); + return handler.sqliteTransaction(params); + }); connection.onRequest("sessionFs.sqliteExists", async (params: SessionFsSqliteExistsRequest) => { const handler = getHandlers(params.sessionId).sessionFs; if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`); @@ -12080,3 +21883,88 @@ export function registerClientSessionApiHandlers( return handler.invoke(params); }); } + +/** Handler for `extensionLaunchProvider` client global API methods. */ +/** @experimental */ +export interface ExtensionLaunchProviderHandler { + /** + * Asks the registered SDK client to resolve an opaque process launch profile for one discovered extension entrypoint immediately before launch or reload. The provider must respond within 15 seconds. + * + * @param params A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. + * + * @returns The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. + */ + resolve(params: ExtensionLaunchProviderResolveRequest): Promise; +} + +/** Handler for `llmInference` client global API methods. */ +/** @experimental */ +export interface LlmInferenceHandler { + /** + * Announces an outbound model-layer HTTP request the runtime wants the SDK client to service. Carries the request head only; the body always follows as one or more httpRequestChunk frames keyed by the same requestId, even when the body is empty (a single chunk with end=true). + * + * @param params The head of an outbound model-layer HTTP request. + * + * @returns Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. + */ + httpRequestStart(params: LlmInferenceHttpRequestStartRequest): Promise; + /** + * Delivers a body byte range (or a cancellation signal) for a request previously announced via httpRequestStart, correlated by requestId. The runtime fires at least one chunk per request — when there is no body, a single chunk with empty data and end=true. Mid-stream the runtime may send a chunk with cancel=true to abort the request; the SDK then stops issuing httpResponseChunk frames and may emit a terminal httpResponseChunk with error set. + * + * @param params A request body chunk or cancellation signal. + * + * @returns Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. + */ + httpRequestChunk(params: LlmInferenceHttpRequestChunkRequest): Promise; +} + +/** Handler for `gitHubTelemetry` client global API methods. */ +/** @experimental */ +export interface GitHubTelemetryHandler { + /** + * Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive every event the runtime emits after the handshake — across all sessions, plus sessionless events (for example, `server.sendTelemetry` calls with no session id). + * + * @param params Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. + */ + event(params: GitHubTelemetryNotification): Promise; +} + +/** All client global API handler groups. */ +export interface ClientGlobalApiHandlers { + extensionLaunchProvider?: ExtensionLaunchProviderHandler; + llmInference?: LlmInferenceHandler; + gitHubTelemetry?: GitHubTelemetryHandler; +} + +/** + * Register client global API handlers on a JSON-RPC connection. + * The server calls these methods to delegate work to the client. + * Unlike session-scoped client APIs, these methods carry no implicit + * `sessionId` dispatch key — a single set of handlers serves the entire + * connection. + */ +export function registerClientGlobalApiHandlers( + connection: MessageConnection, + handlers: ClientGlobalApiHandlers, +): void { + connection.onRequest("extensionLaunchProvider.resolve", async (params: ExtensionLaunchProviderResolveRequest) => { + const handler = handlers.extensionLaunchProvider; + if (!handler) throw new Error("No extensionLaunchProvider client-global handler registered"); + return handler.resolve(params); + }); + connection.onRequest("llmInference.httpRequestStart", async (params: LlmInferenceHttpRequestStartRequest) => { + const handler = handlers.llmInference; + if (!handler) throw new Error("No llmInference client-global handler registered"); + return handler.httpRequestStart(params); + }); + connection.onRequest("llmInference.httpRequestChunk", async (params: LlmInferenceHttpRequestChunkRequest) => { + const handler = handlers.llmInference; + if (!handler) throw new Error("No llmInference client-global handler registered"); + return handler.httpRequestChunk(params); + }); + connection.onNotification("gitHubTelemetry.event", async (params: GitHubTelemetryNotification) => { + const handler = handlers.gitHubTelemetry; + if (!handler) return; + await handler.event(params); + }); +} diff --git a/nodejs/src/generated/session-events.ts b/nodejs/src/generated/session-events.ts index 3fc9ed883..4bdfa1994 100644 --- a/nodejs/src/generated/session-events.ts +++ b/nodejs/src/generated/session-events.ts @@ -3,6 +3,9 @@ * Generated from: session-events.schema.json */ +/** A value that can be represented losslessly on the SDK JSON wire. */ +export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue }; + /** * Union of all session event variants emitted by the Copilot CLI runtime. */ @@ -15,20 +18,25 @@ export type SessionEvent = | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent + | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent + | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent + | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent + | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent + | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent @@ -36,13 +44,16 @@ export type SessionEvent = | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent + | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent + | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent + | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent @@ -51,6 +62,7 @@ export type SessionEvent = | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent + | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent @@ -60,6 +72,7 @@ export type SessionEvent = | HookStartEvent | HookEndEvent | HookProgressEvent + | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent @@ -72,6 +85,8 @@ export type SessionEvent = | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent + | McpHeadersRefreshRequiredEvent + | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent @@ -80,19 +95,33 @@ export type SessionEvent = | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent + | SessionLimitsExhaustedRequestedEvent + | SessionLimitsExhaustedCompletedEvent + | AutoModeResolvedEvent + | ManagedSettingsResolvedEvent + | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent + | FactoryRunUpdatedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent + | McpToolsListChangedEvent + | McpResourcesListChangedEvent + | McpPromptsListChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent + | CanvasClosedEvent + | CanvasUnavailableEvent + | CanvasRecordedEvent + | CanvasRemovedEvent + | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent; /** * Hosting platform type of the repository (github or ado) @@ -102,6 +131,14 @@ export type WorkingDirectoryContextHostType = | "github" /** Repository is hosted on Azure DevOps. */ | "ado"; +/** + * Allowed values for the `ContextTier` enumeration. + */ +export type ContextTier = + /** Default context tier with standard context window size. */ + | "default" + /** Extended context tier with a larger context window. */ + | "long_context"; /** * Reasoning summary mode used for model calls, if applicable (e.g. "none", "concise", "detailed") */ @@ -112,6 +149,24 @@ export type ReasoningSummary = | "concise" /** Request a detailed summary of the model's reasoning. */ | "detailed"; +/** + * Output verbosity level used for supported model calls (e.g. "low", "medium", "high") + */ +export type Verbosity = + /** A terse response was requested. */ + | "low" + /** A medium amount of response detail was requested. */ + | "medium" + /** A more detailed response was requested. */ + | "high"; +/** + * Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may. + */ +export type ScheduleOrigin = + /** The schedule was created by an explicit user action, such as `/every` or `/after`. */ + | "user" + /** The schedule was created by the agent via the `manage_schedule` tool. */ + | "model"; /** * The type of operation performed on the autopilot objective state file */ @@ -144,6 +199,17 @@ export type SessionMode = | "plan" /** The agent is working autonomously toward task completion. */ | "autopilot"; +/** + * Allow-all mode for the session. + */ +/** @experimental */ +export type PermissionAllowAllMode = + /** Permission requests follow the normal approval flow. */ + | "off" + /** Tool, path, and URL permission requests are automatically approved. */ + | "on" + /** Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. */ + | "auto"; /** * The type of operation performed on the plan file */ @@ -178,6 +244,30 @@ export type ShutdownType = | "routine" /** The session ended because of a crash or fatal error. */ | "error"; +/** + * What initiated a conversation compaction + */ +export type CompactionTrigger = + /** Background compaction started automatically because context utilization crossed the background threshold. */ + | "threshold" + /** Compaction forced by a context-limit model response (e.g. HTTP 413) before retrying the request. */ + | "context_limit_retry" + /** User-requested compaction, e.g. the /compact command or the history.compact API. */ + | "manual" + /** Emergency compaction triggered by high process memory usage. */ + | "memory_pressure" + /** Compaction requested while switching to a model with a smaller context window. */ + | "model_switch"; +/** + * Semantic result of evaluating a task completion request + */ +export type TaskCompletionOutcome = + /** The completion request was accepted and the objective is complete. */ + | "completed" + /** The completion request was rejected because more work or validation remains. */ + | "continue" + /** Completion cannot proceed without intervention; the active objective is paused when one is identified. */ + | "blocked"; /** * The agent mode that was active when this message was sent */ @@ -191,24 +281,52 @@ export type UserMessageAgentMode = /** The agent is in shell-focused UI mode. */ | "shell"; /** - * A user message attachment — a file, directory, code selection, blob, or GitHub reference - */ -export type UserMessageAttachment = - | UserMessageAttachmentFile - | UserMessageAttachmentDirectory - | UserMessageAttachmentSelection - | UserMessageAttachmentGithubReference - | UserMessageAttachmentBlob; + * A user message attachment — a file, directory, code selection, blob, GitHub reference, GitHub-anchored pointer, or extension-supplied context payload + */ +export type Attachment = + | AttachmentFile + | AttachmentDirectory + | AttachmentSelection + | AttachmentGitHubReference + | AttachmentGitHubCommit + | AttachmentGitHubRelease + | AttachmentGitHubActionsJob + | AttachmentGitHubRepository + | AttachmentGitHubFileDiff + | AttachmentGitHubTreeComparison + | AttachmentGitHubUrl + | AttachmentGitHubFile + | AttachmentGitHubSnippet + | AttachmentBlob + | AttachmentExtensionContext; +/** + * Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable + */ +export type OmittedBinaryOmittedReason = + /** Bytes exceeded the session's inline size limit. */ + | "too_large" + /** The referenced binary asset could not be found (e.g. a truncated log). */ + | "asset_unavailable"; /** * Type of GitHub reference */ -export type UserMessageAttachmentGithubReferenceType = +export type AttachmentGitHubReferenceType = /** GitHub issue reference. */ | "issue" /** GitHub pull request reference. */ | "pr" /** GitHub discussion reference. */ | "discussion"; +/** + * How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn. + */ +export type UserMessageDelivery = + /** Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). */ + | "idle" + /** Injected into the current in-flight run while the agent was busy (immediate mode). */ + | "steering" + /** Enqueued while the agent was busy; processed as its own run afterward. */ + | "queued"; /** * Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. */ @@ -217,6 +335,22 @@ export type AssistantMessageToolRequestType = | "function" /** Custom grammar-based tool call. */ | "custom"; +/** + * The system that produced a citation. + */ +/** @experimental */ +export type CitationProvider = + /** Citation produced by an Anthropic (Claude) model response. */ + | "anthropic" + /** Citation produced by an OpenAI model response. */ + | "openai" + /** Citation synthesized client-side by the runtime from tool output. */ + | "client"; +/** + * Location within a cited source (character, page, or content-block range) that supports a span. + */ +/** @experimental */ +export type CitationLocation = CitationLocationChar | CitationLocationPage | CitationLocationBlock; /** * API endpoint used for this model call, matching CAPI supported_endpoints vocabulary */ @@ -229,6 +363,22 @@ export type AssistantUsageApiEndpoint = | "/responses" /** WebSocket Responses API endpoint. */ | "ws:/responses"; +/** + * For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. + */ +export type ModelCallFailureBadRequestKind = + /** The 400 response carried no error body (transient gateway/proxy signature). */ + | "bodyless" + /** The 400 response carried a structured CAPI error envelope (deterministic validation failure). */ + | "structured_error"; +/** + * Boundary that produced a model call failure + */ +export type ModelCallFailureKind = + /** The provider returned an API error response. */ + | "api" + /** The request transport failed before a usable API response completed. */ + | "transport"; /** * Where the failed model call originated */ @@ -239,6 +389,14 @@ export type ModelCallFailureSource = | "subagent" /** Model call from MCP sampling. */ | "mcp_sampling"; +/** + * Transport used for a failed model call + */ +export type ModelCallFailureTransport = + /** HTTP transport, including SSE streams. */ + | "http" + /** WebSocket transport. */ + | "websocket"; /** * Finite reason code describing why the current turn was aborted */ @@ -248,13 +406,53 @@ export type AbortReason = /** A remote command requested the abort. */ | "remote_command" /** An MCP server delivered a user.abort notification. */ - | "user_abort"; + | "user_abort" + /** Autopilot stopped the run because the active objective reached its user-set --max-ai-credits limit. */ + | "autopilot_credit_limit"; +/** + * Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration. + */ +export type ToolExecutionStartToolDescriptionMetaUIVisibility = + /** Tool is callable by the model (LLM tool surface) */ + | "model" + /** Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool */ + | "app"; +/** + * A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset reference + */ +/** @experimental */ +export type PersistedBinaryResult = PersistedBinaryImage | OmittedBinaryResult | BinaryAssetReference; +/** + * Binary result type discriminator. Use "image" for images and "resource" for other binary data. + */ +export type PersistedBinaryImageType = + /** Binary image data. */ + | "image" + /** Other binary resource data. */ + | "resource"; +/** + * Binary result type discriminator. Use "image" for images and "resource" for other binary data. + */ +export type OmittedBinaryType = + /** Binary image data. */ + | "image" + /** Other binary resource data. */ + | "resource"; +/** + * Binary result type discriminator. Use "image" for images and "resource" for other binary data. + */ +export type BinaryAssetReferenceType = + /** Binary image data. */ + | "image" + /** Other binary resource data. */ + | "resource"; /** * A content block within a tool result, which may be text, terminal output, image, audio, or a resource */ export type ToolExecutionCompleteContent = | ToolExecutionCompleteContentText | ToolExecutionCompleteContentTerminal + | ToolExecutionCompleteContentShellExit | ToolExecutionCompleteContentImage | ToolExecutionCompleteContentAudio | ToolExecutionCompleteContentResourceLink @@ -289,6 +487,14 @@ export type SkillInvokedTrigger = | "agent-invoked" /** Skill content loaded as part of another context, such as a configured custom agent or subagent. */ | "context-load"; +/** + * Binary asset type discriminator. Use "image" for images and "resource" otherwise. + */ +export type BinaryAssetType = + /** Binary image data. */ + | "image" + /** Other binary resource data. */ + | "resource"; /** * Message role: "system" for system prompts, "developer" for developer-injected instructions */ @@ -306,7 +512,9 @@ export type SystemNotification = | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted - | SystemNotificationInstructionDiscovered; + | SystemNotificationInstructionDiscovered + | SystemNotificationFactoryCompleted + | SystemNotificationUnclassified; /** * Whether the agent completed successfully or failed */ @@ -315,6 +523,18 @@ export type SystemNotificationAgentCompletedStatus = | "completed" /** The agent failed. */ | "failed"; +/** + * Terminal status reached by a factory execution attempt. + */ +export type SystemNotificationFactoryCompletedStatus = + /** The factory completed successfully. */ + | "completed" + /** The factory was halted. */ + | "halted" + /** The factory was cancelled. */ + | "cancelled" + /** The factory failed. */ + | "error"; /** * Details of the permission being requested */ @@ -328,6 +548,7 @@ export type PermissionRequest = | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement + | PermissionRequestFactory | PermissionRequestExtensionPermissionAccess; /** * Whether this is a store or vote memory operation @@ -345,6 +566,14 @@ export type PermissionRequestMemoryDirection = | "upvote" /** Vote that the memory is incorrect or outdated. */ | "downvote"; +/** + * Operation gated by a factory permission request. + */ +export type FactoryPermissionOperation = + /** Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. */ + | "run" + /** Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. */ + | "author"; /** * Derived user-facing permission prompt details for UI consumers */ @@ -359,7 +588,36 @@ export type PermissionPromptRequest = | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement + | PermissionPromptRequestFactory | PermissionPromptRequestExtensionPermissionAccess; +/** + * Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs. + */ +/** @experimental */ +export type AutoApprovalJudgeFailureReason = + /** The judge model call exceeded its deadline. */ + | "timeout" + /** The judge model call was cancelled before it returned. */ + | "abort" + /** The judge model call completed but returned no content. */ + | "empty_response" + /** The judge model call failed (for example a transport, authentication, or rate-limit error). */ + | "model_error" + /** The judge model replied, but the reply carried no ALLOW/DENY verdict. */ + | "parse_error"; +/** + * Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off). + */ +/** @experimental */ +export type AutoApprovalRecommendation = + /** The judge evaluated the request and recommends automatically approving it. */ + | "approve" + /** The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. */ + | "requireApproval" + /** Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. */ + | "excluded" + /** The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. */ + | "error"; /** * Underlying permission kind that needs path approval */ @@ -394,6 +652,7 @@ export type UserToolSessionApproval = | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement + | UserToolSessionApprovalFactory | UserToolSessionApprovalExtensionPermissionAccess; /** * Elicitation mode; "form" for structured input, "url" for browser-based. Defaults to "form" when absent. @@ -414,21 +673,53 @@ export type ElicitationCompletedAction = /** The user dismissed the request. */ | "cancel"; /** - * Schema for the `ElicitationCompletedContent` type. + * Opaque JSON value submitted for one field in accepted `elicitation.completed` form content. + */ +export type ElicitationCompletedContent = JsonValue | undefined; +/** + * Reason the runtime is requesting host-provided MCP OAuth credentials + */ +export type McpOauthRequestReason = + /** Initial credentials are required before connecting to the MCP server. */ + | "initial" + /** The current host-provided credential was rejected and a replacement is requested. */ + | "refresh" + /** The server requires a new host authorization flow before continuing. */ + | "reauth" + /** The server requires a credential with additional scope or audience. */ + | "upscope"; +/** + * How the pending MCP OAuth request was completed + */ +export type McpOauthCompletionOutcome = + /** The request completed with a token-backed OAuth provider. */ + | "token" + /** The request completed without an OAuth provider. */ + | "cancelled"; +/** + * Why dynamic headers are being requested. + */ +export type McpHeadersRefreshRequiredReason = + /** The transport is making its first dynamic header request for this server. */ + | "startup" + /** The previously cached dynamic headers expired. */ + | "ttl-expired" + /** The server returned 401 and stale dynamic headers were invalidated. */ + | "auth-failed"; +/** + * How the pending MCP headers refresh request resolved. */ -export type ElicitationCompletedContent = (string | number | boolean | string[]) | undefined; +export type McpHeadersRefreshCompletedOutcome = + /** The host supplied dynamic headers. */ + | "headers" + /** The host responded with no dynamic headers. */ + | "none" + /** No response arrived within the bounded window. */ + | "timeout"; /** * Source-defined JSON payload for the custom notification */ -export type CustomNotificationPayload = - | string - | number - | boolean - | null - | unknown[] - | { - [k: string]: unknown | undefined; - }; +export type CustomNotificationPayload = JsonValue; /** * The user's auto-mode-switch choice */ @@ -439,6 +730,62 @@ export type AutoModeSwitchResponse = | "yes_always" /** Do not switch models. */ | "no"; +/** + * User action selected for an exhausted session limit. + */ +export type SessionLimitsExhaustedResponseAction = + /** Increase the current max by an exact AI Credits amount. */ + | "add" + /** Set a new absolute max AI Credits value. */ + | "set" + /** Remove the current session limit. */ + | "unset" + /** Leave the limit unchanged and cancel the blocked model request. */ + | "cancel"; +/** + * Coarse request-difficulty bucket for UX explainability + */ +export type AutoModeResolvedReasoningBucket = + /** The request looks low-reasoning; a lighter model is appropriate. */ + | "low" + /** The request needs a moderate amount of reasoning. */ + | "medium" + /** The request looks high-reasoning; a stronger model is appropriate. */ + | "high"; +/** + * Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. + */ +export type ManagedSettingsResolvedSource = + /** Only the server/account channel contributed. */ + | "server" + /** Only the device MDM/plist/registry/file channel contributed. */ + | "device" + /** Only session-local SDK-host injection contributed. */ + | "client" + /** More than one channel contributed. Ordinary keys resolve device over server per key, while permissions compose restrictively across all present layers. */ + | "mixed" + /** No managed policy is in force (no channel contributed). */ + | "none"; +/** + * The category of runtime action that enterprise managed settings governed (blocked or capped) + */ +export type ManagedSettingsEnforcedAction = + /** An attempt to turn on a bypass-permissions ("yolo") escalation was refused or capped because policy disables bypass-permissions mode. */ + "bypass_permissions_blocked"; +/** + * For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused + */ +export type ManagedSettingsEnforcedEscalation = + /** Full allow-all ("/allow-all on") permissions — auto-approving tools, paths, and URLs. */ + | "allow_all" + /** Auto-approval of all tool permission requests. */ + | "approve_all" + /** Advisory auto-approval ("/allow-all auto") mode — keeps normal prompt paths and adds LLM-advised approval, distinct from full allow-all. */ + | "auto_approval" + /** Unrestricted filesystem access outside the session's allowed directories. */ + | "unrestricted_paths" + /** Unrestricted URL fetch access. */ + | "unrestricted_urls"; /** * Exit plan mode action */ @@ -482,7 +829,7 @@ export type McpServerSource = /** Server bundled with the runtime. */ | "builtin"; /** - * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured + * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured */ export type McpServerStatus = /** The server is connected and available. */ @@ -495,6 +842,8 @@ export type McpServerStatus = | "pending" /** The server is configured but disabled. */ | "disabled" + /** The server was intentionally stopped and can be restarted on demand when policy permits; a server quarantined by restrictive managed policy stays stopped and cannot be restarted until the policy allows it. */ + | "stopped" /** The server is not configured for this session. */ | "not_configured"; /** @@ -516,7 +865,11 @@ export type ExtensionsLoadedExtensionSource = /** Extension discovered from the current project. */ | "project" /** Extension discovered from the user's extension directory. */ - | "user"; + | "user" + /** Extension contributed by an installed plugin. */ + | "plugin" + /** Extension discovered from the current session's state directory. */ + | "session"; /** * Current status: running, disabled, failed, or starting */ @@ -529,14 +882,6 @@ export type ExtensionsLoadedExtensionStatus = | "failed" /** The extension process is starting. */ | "starting"; -/** - * Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. - */ -export type CanvasOpenedAvailability = - /** Provider connection is live; actions can be invoked. */ - | "ready" - /** Provider has gone away; the instance is awaiting rebinding. */ - | "stale"; /** * Session event "session.start". Session initialization metadata including context and configuration @@ -580,11 +925,7 @@ export interface StartData { /** * Context tier selected at session creation time for models with tiered context pricing; null when no tier is selected (e.g., non-tiered model) */ - contextTier?: /** Default context tier with standard context window size. */ - | "default" - /** Extended context tier with a larger context window. */ - | "long_context" - | null; + contextTier?: ContextTier | null; /** * Version string of the Copilot application */ @@ -593,6 +934,7 @@ export interface StartData { * When set, identifies a parent session whose context this session continues — e.g., a detached headless rem-agent run launched on the parent's interactive shutdown. Telemetry from this session is reported under the parent's session_id. */ detachedFromSpawningParentSessionId?: string; + githubMcpToolConfig?: GitHubMcpToolConfig; /** * Identifier of the software producing the events (e.g., "copilot-agent") */ @@ -614,10 +956,12 @@ export interface StartData { * Unique identifier for the session */ sessionId: string; + sessionLimits?: SessionLimitsConfig; /** * ISO 8601 timestamp when the session was created */ startTime: string; + verbosity?: Verbosity; /** * Schema version number for the session event format */ @@ -648,6 +992,10 @@ export interface WorkingDirectoryContext { */ headCommit?: string; hostType?: WorkingDirectoryContextHostType; + /** + * Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + */ + pendingGitContext?: boolean; /** * Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) */ @@ -657,6 +1005,36 @@ export interface WorkingDirectoryContext { */ repositoryHost?: string; } +/** + * Per-session configuration for the built-in GitHub MCP server + */ +export interface GitHubMcpToolConfig { + /** + * Additional GitHub MCP tools requested by the session + */ + additionalTools?: string[]; + /** + * Additional GitHub MCP toolsets requested by the session + */ + additionalToolsets?: string[]; + /** + * Whether to use the read-write endpoint and request all toolsets + */ + enableAllTools?: boolean; + /** + * Whether to request the GitHub MCP insiders build + */ + enableInsidersMode?: boolean; +} +/** + * Optional session limits. + */ +export interface SessionLimitsConfig { + /** + * Maximum AI Credits allowed across the session's current accounting window. + */ + maxAiCredits?: number; +} /** * Session event "session.resume". Session resume metadata including current context and event count */ @@ -699,19 +1077,19 @@ export interface ResumeData { /** * Context tier currently selected at resume time; null when no tier is active */ - contextTier?: /** Default context tier with standard context window size. */ - | "default" - /** Extended context tier with a larger context window. */ - | "long_context" - | null; + contextTier?: ContextTier | null; /** - * 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. + * 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 or omitted, pending work is normally marked as interrupted unless the resume passively joined live work owned by another client; sessionWasActive distinguishes that case. */ continuePendingWork?: boolean; /** * Total number of persisted events in the session at the time of resume */ eventCount: number; + /** + * On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd + */ + eventsFileSizeBytes?: number; /** * Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") */ @@ -730,9 +1108,14 @@ export interface ResumeData { */ selectedModel?: string; /** - * 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. + * Session limits currently configured at resume time; null when no limits are active + */ + sessionLimits?: SessionLimitsConfig | null; + /** + * True when this resume passively joined a session that already had live work running in the runtime - an agent turn, a native queue run, a queued resume continuation, or an in-flight send (for example, an extension joining a session another client was actively driving). False (or omitted) when the session had no live work or when the resume explicitly abandoned pending work, including cold resumes and suspended sessions that remain resident in memory. */ sessionWasActive?: boolean; + verbosity?: Verbosity; } /** * Session event "session.remote_steerable_changed". Notifies that the session's remote steering capability has changed @@ -845,7 +1228,7 @@ export interface ErrorData { url?: string; } /** - * Session event "session.idle". Payload indicating the session is idle with no background agents in flight + * Session event "session.idle". Payload indicating the session is idle with no background agents or attached shell commands in flight */ export interface IdleEvent { /** @@ -875,7 +1258,7 @@ export interface IdleEvent { type: "session.idle"; } /** - * Payload indicating the session is idle with no background agents in flight + * Payload indicating the session is idle with no background agents or attached shell commands in flight */ export interface IdleData { /** @@ -956,6 +1339,14 @@ export interface ScheduleCreatedEvent { * Scheduled prompt registered via /every or /after */ export interface ScheduleCreatedData { + /** + * Absolute fire time (epoch milliseconds) for a one-shot calendar schedule + */ + at?: number; + /** + * 5-field cron expression for a recurring calendar schedule, evaluated in `tz` + */ + cron?: string; /** * Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion) */ @@ -965,9 +1356,10 @@ export interface ScheduleCreatedData { */ id: number; /** - * Interval between ticks in milliseconds + * Interval between ticks in milliseconds (relative-interval schedules) */ - intervalMs: number; + intervalMs?: number; + origin?: ScheduleOrigin; /** * Prompt text that gets enqueued on every tick */ @@ -976,6 +1368,14 @@ export interface ScheduleCreatedData { * Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`) */ recurring?: boolean; + /** + * True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled rather than auto-computed. + */ + selfPaced?: boolean; + /** + * IANA timezone the `cron` expression is evaluated in + */ + tz?: string; } /** * Session event "session.schedule_cancelled". Scheduled prompt cancelled from the schedule manager dialog @@ -1016,6 +1416,49 @@ export interface ScheduleCancelledData { */ id: number; } +/** + * Session event "session.schedule_rearmed". Self-paced schedule re-armed for its next run + */ +export interface ScheduleRearmedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ScheduleRearmedData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.schedule_rearmed". + */ + type: "session.schedule_rearmed"; +} +/** + * Self-paced schedule re-armed for its next run + */ +export interface ScheduleRearmedData { + /** + * Id of the self-paced schedule that was re-armed + */ + id: number; + /** + * Absolute time (epoch milliseconds) the model armed the next run to fire + */ + nextRunAt: number; +} /** * Session event "session.autopilot_objective_changed". Autopilot objective state file operation details indicating what changed */ @@ -1190,17 +1633,13 @@ export interface ModelChangeEvent { */ export interface ModelChangeData { /** - * 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. + * Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy. */ cause?: string; /** * Context tier after the model change; null explicitly clears a previously selected tier */ - contextTier?: /** Default context tier with standard context window size. */ - | "default" - /** Extended context tier with a larger context window. */ - | "long_context" - | null; + contextTier?: ContextTier | null; /** * Newly selected model identifier */ @@ -1214,11 +1653,13 @@ export interface ModelChangeData { */ previousReasoningEffort?: string; previousReasoningSummary?: ReasoningSummary; + previousVerbosity?: Verbosity; /** * Reasoning effort level after the model change, if applicable */ reasoningEffort?: string | null; reasoningSummary?: ReasoningSummary; + verbosity?: Verbosity; } /** * Session event "session.mode_changed". Agent mode change details including previous and new modes @@ -1258,7 +1699,46 @@ export interface ModeChangedData { previousMode: SessionMode; } /** - * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all boolean transition. + * Session event "session.session_limits_changed". Session limits update details. Null clears the limits. + */ +export interface SessionLimitsChangedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: SessionLimitsChangedData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.session_limits_changed". + */ + type: "session.session_limits_changed"; +} +/** + * Session limits update details. Null clears the limits. + */ +export interface SessionLimitsChangedData { + /** + * Current session limits, or null when no limits are active + */ + sessionLimits: SessionLimitsConfig | null; +} +/** + * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. */ export interface PermissionsChangedEvent { /** @@ -1288,13 +1768,25 @@ export interface PermissionsChangedEvent { type: "session.permissions_changed"; } /** - * Permissions change details carrying the aggregate allow-all boolean transition. + * Permissions change details carrying the aggregate allow-all transition. */ export interface PermissionsChangedData { + /** + * Allow-all mode after the change + * + * @experimental + */ + allowAllPermissionMode?: PermissionAllowAllMode; /** * Aggregate allow-all flag after the change */ allowAllPermissions: boolean; + /** + * Allow-all mode before the change + * + * @experimental + */ + previousAllowAllPermissionMode?: PermissionAllowAllMode; /** * Aggregate allow-all flag before the change */ @@ -1336,6 +1828,40 @@ export interface PlanChangedEvent { export interface PlanChangedData { operation: PlanChangedOperation; } +/** + * Session event "session.todos_changed". Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. + */ +export interface TodosChangedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: TodosChangedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.todos_changed". + */ + type: "session.todos_changed"; +} +/** + * Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. + */ +export interface TodosChangedData {} /** * Session event "session.workspace_file_changed". Workspace file change details including path and operation type */ @@ -1611,6 +2137,10 @@ export interface ShutdownData { * Error description when shutdownType is "error" */ errorReason?: string; + /** + * On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd + */ + eventsFileSizeBytes?: number; /** * Per-model usage breakdown, keyed by model identifier */ @@ -1671,7 +2201,7 @@ export interface ShutdownCodeChanges { linesRemoved: number; } /** - * Schema for the `ShutdownModelMetric` type. + * Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. */ export interface ShutdownModelMetric { requests: ShutdownModelMetricRequests; @@ -1707,7 +2237,7 @@ export interface ShutdownModelMetricRequests { count?: number; } /** - * Schema for the `ShutdownModelMetricTokenDetail` type. + * A token-type entry in a shutdown model metric, storing the accumulated token count. */ export interface ShutdownModelMetricTokenDetail { /** @@ -1741,7 +2271,7 @@ export interface ShutdownModelMetricUsage { reasoningTokens?: number; } /** - * Schema for the `ShutdownTokenDetail` type. + * A session-wide shutdown token-type entry storing the accumulated token count. */ export interface ShutdownTokenDetail { /** @@ -1749,6 +2279,77 @@ export interface ShutdownTokenDetail { */ tokenCount: number; } +/** + * Session event "session.usage_checkpoint". Durable session usage checkpoint for reconstructing aggregate accounting on resume + */ +export interface UsageCheckpointEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: UsageCheckpointData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.usage_checkpoint". + */ + type: "session.usage_checkpoint"; +} +/** + * Durable session usage checkpoint for reconstructing aggregate accounting on resume + */ +export interface UsageCheckpointData { + /** + * Internal per-model prompt-cache state used to restore expiration tracking on resume + * + * @internal + */ + modelCacheState?: UsageCheckpointModelCacheState[]; + /** + * Session-wide accumulated nano-AI units cost at checkpoint time + */ + totalNanoAiu: number; + /** + * Total number of premium API requests used at checkpoint time + * + * @internal + */ + totalPremiumRequests?: number; +} +/** + * Internal prompt-cache expiration state for one model + */ +/** @internal */ +export interface UsageCheckpointModelCacheState { + /** + * Latest known prompt-cache expiration + */ + cacheExpiresAt: string; + /** + * Retained cache lifetime in seconds, used to refresh expiration after a cache read + * + * @internal + */ + cacheTtlSeconds: number; + /** + * Model identifier associated with this cache state + */ + modelId: string; +} /** * Session event "session.context_changed". Updated working directory and git context after the change */ @@ -1843,14 +2444,14 @@ export interface UsageInfoData { toolDefinitionsTokens?: number; } /** - * Session event "session.compaction_start". Context window breakdown at the start of LLM-powered conversation compaction + * Session event "session.context_cleared". Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) */ -export interface CompactionStartEvent { +export interface ContextClearedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: CompactionStartData; + data: ContextClearedData; /** * When true, the event is transient and not persisted to the session event log on disk */ @@ -1868,7 +2469,50 @@ export interface CompactionStartEvent { */ timestamp: string; /** - * Type discriminator. Always "session.compaction_start". + * Type discriminator. Always "session.context_cleared". + */ + type: "session.context_cleared"; +} +/** + * Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) + */ +export interface ContextClearedData { + /** + * Optional initial message set after clearing + */ + initialMessage?: string; + /** + * Number of conversation messages that were cleared + */ + messagesCleared: number; +} +/** + * Session event "session.compaction_start". Context window breakdown at the start of LLM-powered conversation compaction + */ +export interface CompactionStartEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CompactionStartData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.compaction_start". */ type: "session.compaction_start"; } @@ -1880,14 +2524,27 @@ export interface CompactionStartData { * Token count from non-system messages (user, assistant, tool) at compaction start */ conversationTokens?: number; + /** + * Total context tokens (system + conversation + tool definitions) at compaction start, when known + */ + currentTokens?: number; + /** + * Model identifier used for compaction, when known + */ + model?: string; /** * Token count from system message(s) at compaction start */ systemTokens?: number; + /** + * Model context window token limit the compaction is targeting, when known + */ + tokenLimit?: number; /** * Token count from tool definitions at compaction start */ toolDefinitionsTokens?: number; + trigger?: CompactionTrigger; } /** * Session event "session.compaction_complete". Conversation compaction results including success status, metrics, and optional error details @@ -1968,6 +2625,10 @@ export interface CompactionCompleteData { * Copilot service request ID (x-copilot-service-request-id header) for the compaction LLM call */ serviceRequestId?: string; + /** + * For failed compaction only: the HTTP status code of the compaction LLM call failure, when it carried one. Absent for successful compaction and for failures without an HTTP status (e.g. an empty model response or a transport error). + */ + statusCode?: number; /** * Whether compaction completed successfully */ @@ -1980,6 +2641,10 @@ export interface CompactionCompleteData { * Token count from system message(s) after compaction */ systemTokens?: number; + /** + * Model context window token limit the compaction was targeting, when known + */ + tokenLimit?: number; /** * Number of tokens removed during compaction */ @@ -1988,6 +2653,7 @@ export interface CompactionCompleteData { * Token count from tool definitions after compaction */ toolDefinitionsTokens?: number; + trigger?: CompactionTrigger; } /** * Token usage breakdown for the compaction LLM call (aligned with assistant.usage format) @@ -2031,8 +2697,10 @@ export interface CompactionCompleteCompactionTokensUsed { export interface CompactionCompleteCompactionTokensUsedCopilotUsage { /** * Itemized token usage breakdown + * + * @internal */ - tokenDetails: CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[]; + tokenDetails?: CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[]; /** * Total cost in nano-AI units for this request */ @@ -2094,7 +2762,16 @@ export interface TaskCompleteEvent { */ export interface TaskCompleteData { /** - * Whether the tool call succeeded. False when validation failed (e.g., invalid arguments) + * Active autopilot objective ID evaluated by the completion reviewer + */ + objectiveId?: number; + outcome?: TaskCompletionOutcome; + /** + * Label-safe runtime rationale for the completion decision (e.g. a cancellation or pause/resume downgrade), when one applies. Reviewer-authored rationale is intentionally omitted here because this event has no IFC label channel; the reviewer's findings remain available through its own labeled sub-agent events + */ + reason?: string; + /** + * Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer */ success?: boolean; /** @@ -2103,7 +2780,7 @@ export interface TaskCompleteData { summary?: string; } /** - * Session event "user.message". + * Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. */ export interface UserMessageEvent { /** @@ -2133,18 +2810,19 @@ export interface UserMessageEvent { type: "user.message"; } /** - * Schema for the `UserMessageData` type. + * Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. */ export interface UserMessageData { agentMode?: UserMessageAgentMode; /** * Files, selections, or GitHub references attached to the message */ - attachments?: UserMessageAttachment[]; + attachments?: Attachment[]; /** * The user's message text as displayed in the timeline */ content: string; + delivery?: UserMessageDelivery; /** * CAPI interaction ID for correlating this user message with its turn */ @@ -2162,7 +2840,7 @@ export interface UserMessageData { */ parentAgentTaskId?: string; /** - * Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user) + * Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-` for an inter-agent prompt) */ source?: string; /** @@ -2177,16 +2855,33 @@ export interface UserMessageData { /** * File attachment */ -export interface UserMessageAttachmentFile { +export interface AttachmentFile { + /** + * Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. + */ + assetId?: string; + /** + * Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + */ + byteLength?: number; /** * User-facing display name for the attachment */ displayName: string; - lineRange?: UserMessageAttachmentFileLineRange; + lineRange?: AttachmentFileLineRange; + /** + * Internal: MIME type of the file's model-facing bytes (post-resize for images). Set when the file's bytes are interned to an asset. Absent externally. + */ + mimeType?: string; + omittedReason?: OmittedBinaryOmittedReason; /** * Absolute file path */ path: string; + /** + * Frozen rendered line this attachment contributed to the prompt block (e.g. "* /path (123 lines)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. Present only for attachments routed to (mutually exclusive with assetId, which marks bytes sent natively). + */ + taggedFilesEntry?: string; /** * Attachment type discriminator */ @@ -2195,7 +2890,7 @@ export interface UserMessageAttachmentFile { /** * Optional line range to scope the attachment to a specific section of the file */ -export interface UserMessageAttachmentFileLineRange { +export interface AttachmentFileLineRange { /** * End line number (1-based, inclusive) */ @@ -2208,7 +2903,7 @@ export interface UserMessageAttachmentFileLineRange { /** * Directory attachment */ -export interface UserMessageAttachmentDirectory { +export interface AttachmentDirectory { /** * User-facing display name for the attachment */ @@ -2217,6 +2912,10 @@ export interface UserMessageAttachmentDirectory { * Absolute directory path */ path: string; + /** + * Frozen rendered line this attachment contributed to the prompt block (e.g. "* /path (12 items)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. + */ + taggedFilesEntry?: string; /** * Attachment type discriminator */ @@ -2225,7 +2924,7 @@ export interface UserMessageAttachmentDirectory { /** * Code selection attachment from an editor */ -export interface UserMessageAttachmentSelection { +export interface AttachmentSelection { /** * User-facing display name for the selection */ @@ -2234,7 +2933,7 @@ export interface UserMessageAttachmentSelection { * Absolute path to the file containing the selection */ filePath: string; - selection: UserMessageAttachmentSelectionDetails; + selection: AttachmentSelectionDetails; /** * The selected text content */ @@ -2247,14 +2946,14 @@ export interface UserMessageAttachmentSelection { /** * Position range of the selection within the file */ -export interface UserMessageAttachmentSelectionDetails { - end: UserMessageAttachmentSelectionDetailsEnd; - start: UserMessageAttachmentSelectionDetailsStart; +export interface AttachmentSelectionDetails { + end: AttachmentSelectionDetailsEnd; + start: AttachmentSelectionDetailsStart; } /** * End position of the selection */ -export interface UserMessageAttachmentSelectionDetailsEnd { +export interface AttachmentSelectionDetailsEnd { /** * End character offset within the line (0-based) */ @@ -2267,7 +2966,7 @@ export interface UserMessageAttachmentSelectionDetailsEnd { /** * Start position of the selection */ -export interface UserMessageAttachmentSelectionDetailsStart { +export interface AttachmentSelectionDetailsStart { /** * Start character offset within the line (0-based) */ @@ -2280,12 +2979,12 @@ export interface UserMessageAttachmentSelectionDetailsStart { /** * GitHub issue, pull request, or discussion reference */ -export interface UserMessageAttachmentGithubReference { +export interface AttachmentGitHubReference { /** * Issue, pull request, or discussion number */ number: number; - referenceType: UserMessageAttachmentGithubReferenceType; + referenceType: AttachmentGitHubReferenceType; /** * Current state of the referenced item (e.g., open, closed, merged) */ @@ -2303,14 +3002,247 @@ export interface UserMessageAttachmentGithubReference { */ url: string; } +/** + * Pointer to a GitHub commit. + */ +export interface AttachmentGitHubCommit { + /** + * First line of the commit message + */ + message: string; + /** + * Full commit SHA + */ + oid: string; + repo: GitHubRepoRef; + /** + * Attachment type discriminator + */ + type: "github_commit"; + /** + * URL to the commit on GitHub + */ + url: string; +} +/** + * Pointer to a GitHub repository. + */ +export interface GitHubRepoRef { + /** + * Numeric GitHub repository id + */ + id?: number; + /** + * Repository name (without owner) + */ + name: string; + /** + * Repository owner login (user or organization) + */ + owner: string; +} +/** + * Pointer to a GitHub release. + */ +export interface AttachmentGitHubRelease { + /** + * Human-readable release name + */ + name: string; + repo: GitHubRepoRef; + /** + * Git tag the release is anchored to + */ + tagName: string; + /** + * Attachment type discriminator + */ + type: "github_release"; + /** + * URL to the release on GitHub + */ + url: string; +} +/** + * Pointer to a GitHub Actions job. + */ +export interface AttachmentGitHubActionsJob { + /** + * Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + */ + conclusion?: string; + /** + * Job id within the workflow run + */ + jobId: number; + /** + * Display name of the job + */ + jobName: string; + repo: GitHubRepoRef; + /** + * Attachment type discriminator + */ + type: "github_actions_job"; + /** + * URL to the job on GitHub + */ + url: string; + /** + * Display name of the workflow the job ran in + */ + workflowName: string; +} +/** + * Pointer to a GitHub repository. + */ +export interface AttachmentGitHubRepository { + /** + * Short description of the repository + */ + description?: string; + /** + * Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + */ + ref?: string; + repo: GitHubRepoRef; + /** + * Attachment type discriminator + */ + type: "github_repository"; + /** + * URL to the repository on GitHub + */ + url: string; +} +/** + * Pointer to a single-file diff. At least one of `head` and `base` must be present. + */ +export interface AttachmentGitHubFileDiff { + base?: AttachmentGitHubFileDiffSide; + head?: AttachmentGitHubFileDiffSide; + /** + * Attachment type discriminator + */ + type: "github_file_diff"; + /** + * URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + */ + url: string; +} +/** + * One side of a file diff (head or base) + */ +export interface AttachmentGitHubFileDiffSide { + /** + * Repository-relative path to the file + */ + path: string; + /** + * Git ref (branch, tag, or commit SHA) the file is read at + */ + ref: string; + repo: GitHubRepoRef; +} +/** + * Pointer to a comparison between two git revisions. + */ +export interface AttachmentGitHubTreeComparison { + base: AttachmentGitHubTreeComparisonSide; + head: AttachmentGitHubTreeComparisonSide; + /** + * Attachment type discriminator + */ + type: "github_tree_comparison"; + /** + * URL to the comparison on GitHub + */ + url: string; +} +/** + * One side of a tree comparison (head or base) + */ +export interface AttachmentGitHubTreeComparisonSide { + repo: GitHubRepoRef; + /** + * Git revision (branch, tag, or commit SHA) + */ + revision: string; +} +/** + * Generic GitHub URL reference. + */ +export interface AttachmentGitHubUrl { + /** + * Attachment type discriminator + */ + type: "github_url"; + /** + * URL to the GitHub resource + */ + url: string; +} +/** + * Pointer to a file in a GitHub repository at a specific ref. + */ +export interface AttachmentGitHubFile { + /** + * Repository-relative path to the file + */ + path: string; + /** + * Git ref the file is read at (branch, tag, or commit SHA) + */ + ref: string; + repo: GitHubRepoRef; + /** + * Attachment type discriminator + */ + type: "github_file"; + /** + * URL to the file on GitHub + */ + url: string; +} +/** + * Pointer to a line range inside a file in a GitHub repository. + */ +export interface AttachmentGitHubSnippet { + lineRange: AttachmentFileLineRange; + /** + * Repository-relative path to the file + */ + path: string; + /** + * Git ref the file is read at (branch, tag, or commit SHA) + */ + ref: string; + repo: GitHubRepoRef; + /** + * Attachment type discriminator + */ + type: "github_snippet"; + /** + * URL to the snippet on GitHub (with line anchor) + */ + url: string; +} /** * Blob attachment with inline base64-encoded data */ -export interface UserMessageAttachmentBlob { +export interface AttachmentBlob { /** - * Base64-encoded content + * Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. */ - data: string; + assetId?: string; + /** + * Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + */ + byteLength?: number; + /** + * Base64-encoded content. Present on input and for external consumers; replaced by an internal `assetId` reference in persisted events when interned to a content-addressed asset. + */ + data?: string; /** * User-facing display name for the attachment */ @@ -2319,11 +3251,45 @@ export interface UserMessageAttachmentBlob { * MIME type of the inline data */ mimeType: string; + omittedReason?: OmittedBinaryOmittedReason; /** * Attachment type discriminator */ type: "blob"; } +/** + * Structured context contributed by an extension. Composer pills displayed in the host are forwarded back through session.send.attachments, then rendered into the model prompt as an XML block. + */ +export interface AttachmentExtensionContext { + /** + * Provider-local canvas identifier when the push was bound to a canvas instance + */ + canvasId?: string; + /** + * ISO 8601 timestamp captured by the runtime when the push was accepted + */ + capturedAt: string; + /** + * Owning extension identifier. Runtime-derived from the caller's connection when produced via session.extensions.sendAttachmentsToMessage; preserved verbatim on subsequent transports. + */ + extensionId: string; + /** + * Open canvas instance identifier when the push was bound to a canvas instance + */ + instanceId?: string; + /** + * Caller-supplied JSON payload + */ + payload?: JsonValue; + /** + * Human-readable composer pill label + */ + title: string; + /** + * Attachment type discriminator + */ + type: "extension_context"; +} /** * Session event "pending_messages.modified". Empty payload; the event signals that the pending message queue has changed */ @@ -2396,6 +3362,10 @@ export interface AssistantTurnStartData { * CAPI interaction ID for correlating this turn with upstream telemetry */ interactionId?: string; + /** + * Model identifier used for this turn, when known + */ + model?: string; /** * Identifier for this turn within the agentic loop, typically a stringified turn number */ @@ -2441,18 +3411,18 @@ export interface AssistantIntentData { intent: string; } /** - * Session event "assistant.reasoning". Assistant reasoning content for timeline display with complete thinking text + * Session event "assistant.server_tool_progress". Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message */ -export interface AssistantReasoningEvent { +export interface AssistantServerToolProgressEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: AssistantReasoningData; + data: AssistantServerToolProgressData; /** - * When true, the event is transient and not persisted to the session event log on disk + * Always true for events that are transient and not persisted to the session event log on disk. */ - ephemeral?: boolean; + ephemeral: true; /** * Unique event identifier (UUID v4), generated when the event is emitted */ @@ -2466,27 +3436,75 @@ export interface AssistantReasoningEvent { */ timestamp: string; /** - * Type discriminator. Always "assistant.reasoning". + * Type discriminator. Always "assistant.server_tool_progress". */ - type: "assistant.reasoning"; + type: "assistant.server_tool_progress"; } /** - * Assistant reasoning content for timeline display with complete thinking text + * Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message */ -export interface AssistantReasoningData { +export interface AssistantServerToolProgressData { /** - * The complete extended thinking text from the model + * Kind of hosted server tool that is running. Only `web_search` is emitted today. */ - content: string; + kind: string; /** - * Unique identifier for this reasoning block + * Position of the hosted tool call in the response output. Stable across the call's lifecycle events (unlike the provider's per-event item id, which CAPI rotates), so the host keys the live in-progress row on it. */ - reasoningId: string; + outputIndex: number; + /** + * Lifecycle status of the hosted call: `in_progress`, `searching`, or `completed`. + */ + status: string; } /** - * Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates + * Session event "assistant.reasoning". Assistant reasoning content for timeline display with complete thinking text */ -export interface AssistantReasoningDeltaEvent { +export interface AssistantReasoningEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: AssistantReasoningData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "assistant.reasoning". + */ + type: "assistant.reasoning"; +} +/** + * Assistant reasoning content for timeline display with complete thinking text + */ +export interface AssistantReasoningData { + /** + * The complete extended thinking text from the model + */ + content: string; + /** + * Unique identifier for this reasoning block + */ + reasoningId: string; + rte?: boolean; +} +/** + * Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates + */ +export interface AssistantReasoningDeltaEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ @@ -2526,6 +3544,54 @@ export interface AssistantReasoningDeltaData { */ reasoningId: string; } +/** + * Session event "assistant.tool_call_delta". Streaming tool-call input delta for incremental tool-call updates + */ +export interface AssistantToolCallDeltaEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: AssistantToolCallDeltaData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "assistant.tool_call_delta". + */ + type: "assistant.tool_call_delta"; +} +/** + * Streaming tool-call input delta for incremental tool-call updates + */ +export interface AssistantToolCallDeltaData { + /** + * Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input. + */ + inputDelta: string; + /** + * Tool call ID this delta belongs to, matching the corresponding assistant.message tool request + */ + toolCallId: string; + /** + * Name of the tool being invoked, when known from the stream + */ + toolName?: string; + toolType?: AssistantMessageToolRequestType; +} /** * Session event "assistant.streaming_delta". Streaming response progress with cumulative byte count */ @@ -2600,17 +3666,27 @@ export interface AssistantMessageEvent { */ export interface AssistantMessageData { /** - * Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping - * - * @experimental + * Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. */ - anthropicAdvisorBlocks?: unknown[]; + apiCallId?: string; + /** + * Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1. + */ + chunkCount?: number; + /** + * Zero-based position of this message within its model call's response. Absent when the response was not split into chunks. + */ + chunkIndex?: number; /** - * Anthropic advisor model ID used for this response, for timeline display on replay + * Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. * * @experimental */ - anthropicAdvisorModel?: string; + citations?: Citations; + /** + * Client-minted request id (x-request-id header) echoed by the server. Distinct from requestId (x-github-request-id) and serviceRequestId (x-copilot-service-request-id). + */ + clientRequestId?: string; /** * The assistant's text response content */ @@ -2652,10 +3728,16 @@ export interface AssistantMessageData { * Readable reasoning text from the model's extended thinking */ reasoningText?: string; + /** + * OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns. + */ + reasoningWireField?: string; /** * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs */ requestId?: string; + rte?: boolean; + serverTools?: AssistantMessageServerTools; /** * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @@ -2669,6 +3751,147 @@ export interface AssistantMessageData { */ turnId?: string; } +/** + * Provider-agnostic citations linking spans of the assistant's response to their supporting sources. + */ +/** @experimental */ +export interface Citations { + /** + * Deduplicated set of sources referenced by the citation spans. + */ + sources: CitationSource[]; + /** + * Spans of generated text annotated with the sources that support them. + */ + spans: CitationSpan[]; +} +/** + * A source that backs one or more cited spans in the assistant's response. + */ +/** @experimental */ +export interface CitationSource { + /** + * Stable, turn-scoped identifier for this source, referenced by CitationReference.sourceId. + */ + id: string; + /** + * File path relative to the agent's workspace root, when the source is a file. + */ + path?: string; + provider: CitationProvider; + /** + * Human-readable title of the source. + */ + title?: string; + /** + * URL of the source, when it is a web resource. + */ + url?: string; +} +/** + * A contiguous span of generated assistant text and the source references that support it. + */ +/** @experimental */ +export interface CitationSpan { + /** + * End offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, exclusive). + */ + endIndex: number; + /** + * The sources that support this span of generated text. + */ + references: CitationReference[]; + /** + * Start offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, inclusive). + */ + startIndex: number; +} +/** + * A single citation occurrence linking a span of generated text to a supporting source. + */ +/** @experimental */ +export interface CitationReference { + /** + * The exact text from the source that supports the cited span, when provided by the model. + */ + citedText?: string; + location?: CitationLocation; + /** + * Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. + */ + providerMetadata?: JsonValue; + /** + * Identifier of the CitationSource this reference points to (CitationSource.id). + */ + sourceId: string; +} +/** + * A character range within the source's text content. + */ +/** @experimental */ +export interface CitationLocationChar { + /** + * End character offset within the source text (zero-based, exclusive). + */ + endIndex: number; + /** + * Start character offset within the source text (zero-based, inclusive). + */ + startIndex: number; + /** + * Citation location type discriminator + */ + type: "char"; +} +/** + * A page range within a paginated source document. + */ +/** @experimental */ +export interface CitationLocationPage { + /** + * Last page number of the cited range (inclusive). + */ + endPage: number; + /** + * First page number of the cited range. + */ + startPage: number; + /** + * Citation location type discriminator + */ + type: "page"; +} +/** + * A content-block range within a structured source document. + */ +/** @experimental */ +export interface CitationLocationBlock { + /** + * Index of the last content block of the cited range (zero-based, exclusive). + */ + endBlock: number; + /** + * Index of the first content block of the cited range (zero-based, inclusive). + */ + startBlock: number; + /** + * Citation location type discriminator + */ + type: "block"; +} +/** + * Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping + */ +/** @experimental */ +export interface AssistantMessageServerTools { + advisorModel?: string; + functionCallNamespaces?: { + [k: string]: string | undefined; + }; + items?: JsonValue[]; + provider: string; + rawContentBlocks?: JsonValue[]; +} /** * A tool invocation request from the assistant */ @@ -2676,9 +3899,7 @@ export interface AssistantMessageToolRequest { /** * Arguments to pass to the tool, format depends on the tool */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; /** * Resolved intention summary describing what this specific call does */ @@ -2830,11 +4051,54 @@ export interface AssistantTurnEndEvent { * Turn completion metadata including the turn identifier */ export interface AssistantTurnEndData { + /** + * Model identifier used for this turn, when known + */ + model?: string; /** * Identifier of the turn that has ended, matching the corresponding assistant.turn_start event */ turnId: string; } +/** + * Session event "assistant.idle". Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred + */ +export interface AssistantIdleEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: AssistantIdleData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "assistant.idle". + */ + type: "assistant.idle"; +} +/** + * Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred + */ +export interface AssistantIdleData { + /** + * True when the preceding agentic loop was cancelled via abort signal + */ + aborted?: boolean; +} /** * Session event "assistant.usage". LLM API call usage metrics including tokens, costs, quotas, and billing information */ @@ -2874,6 +4138,16 @@ export interface AssistantUsageData { */ apiCallId?: string; apiEndpoint?: AssistantUsageApiEndpoint; + /** + * Number of tools available to the model for this call + * + * @internal + */ + availableToolCount?: number; + /** + * Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. + */ + cacheExpiresAt?: string; /** * Number of tokens read from prompt cache */ @@ -2883,10 +4157,9 @@ export interface AssistantUsageData { */ cacheWriteTokens?: number; /** - * Per-request cost and usage data from the CAPI copilot_usage response field - * - * @internal + * Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason. */ + contentFilterTriggered?: boolean; copilotUsage?: AssistantUsageCopilotUsage; /** * Model multiplier cost for billing purposes @@ -2898,6 +4171,10 @@ export interface AssistantUsageData { * Duration of the API call in milliseconds */ duration?: number; + /** + * Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter". + */ + finishReason?: string; /** * What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ @@ -2906,6 +4183,10 @@ export interface AssistantUsageData { * Number of input tokens consumed */ inputTokens?: number; + /** + * Coarse classification of the interaction that produced this call, mirroring the session's per-request agent context (e.g. `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, `conversation-user`). Non-billing; lets consumers attribute a model call to a call class (e.g. sub-agent/sidekick) independently of the billing initiator. Absent when the runtime did not classify the request. + */ + interactionType?: string; /** * Average inter-token latency in milliseconds. Only available for streaming requests */ @@ -2914,6 +4195,12 @@ export interface AssistantUsageData { * Model identifier used for this API call */ model: string; + /** + * Number of tool calls returned by the model + * + * @internal + */ + numToolCalls?: number; /** * Number of output tokens produced */ @@ -2943,6 +4230,7 @@ export interface AssistantUsageData { * Number of output tokens used for reasoning (e.g., chain-of-thought) */ reasoningTokens?: number; + rte?: boolean; /** * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation */ @@ -2951,16 +4239,31 @@ export interface AssistantUsageData { * Time to first token in milliseconds. Only available for streaming requests */ timeToFirstTokenMs?: number; + /** + * Tool-call counts keyed by tool name + * + * @internal + */ + toolCounts?: { + [k: string]: number | undefined; + }; + /** + * Number of tokens used by tool definitions for this call + * + * @internal + */ + toolTokenCount?: number; } /** * Per-request cost and usage data from the CAPI copilot_usage response field */ -/** @internal */ export interface AssistantUsageCopilotUsage { /** * Itemized token usage breakdown + * + * @internal */ - tokenDetails: AssistantUsageCopilotUsageTokenDetail[]; + tokenDetails?: AssistantUsageCopilotUsageTokenDetail[]; /** * Total cost in nano-AI units for this request */ @@ -2988,7 +4291,7 @@ export interface AssistantUsageCopilotUsageTokenDetail { tokenType: string; } /** - * Schema for the `AssistantUsageQuotaSnapshot` type. + * Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota. */ /** @internal */ export interface AssistantUsageQuotaSnapshot { @@ -2998,6 +4301,12 @@ export interface AssistantUsageQuotaSnapshot { * @internal */ entitlementRequests: number; + /** + * Whether the user currently has quota available for use + * + * @internal + */ + hasQuota?: boolean; /** * Whether the user has an unlimited usage entitlement * @@ -3016,6 +4325,12 @@ export interface AssistantUsageQuotaSnapshot { * @internal */ overageAllowedWithExhaustedQuota: boolean; + /** + * Pay-as-you-go additional-usage budget cap in AI credits (1 credit = $0.01); present only when CAPI emits a finite value + * + * @internal + */ + overageEntitlement?: number; /** * Percentage of quota remaining (0 to 100) * @@ -3028,6 +4343,12 @@ export interface AssistantUsageQuotaSnapshot { * @internal */ resetDate?: string; + /** + * Whether this snapshot uses token-based billing (AI-credits allocation) + * + * @internal + */ + tokenBasedBilling?: boolean; /** * Whether usage is still permitted after quota exhaustion * @@ -3079,18 +4400,45 @@ export interface ModelCallFailureData { * Completion ID from the model provider (e.g., chatcmpl-abc123) */ apiCallId?: string; + apiEndpoint?: AssistantUsageApiEndpoint; + badRequestKind?: ModelCallFailureBadRequestKind; /** * Duration of the failed API call in milliseconds */ durationMs?: number; + /** + * For HTTP 400 failures only: the `code` from the CAPI error envelope (e.g. 'model_max_prompt_tokens_exceeded') identifying which deterministic validation failure occurred. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + */ + errorCode?: string; /** * Raw provider/runtime error message for restricted telemetry */ errorMessage?: string; + /** + * For HTTP 400 failures only: the `type` from the CAPI error envelope (e.g. 'websocket_error'), a coarser companion to errorCode for envelopes that carry no code. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + */ + errorType?: string; + failureKind?: ModelCallFailureKind; /** * What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls */ initiator?: string; + /** + * Whether the session selected Auto mode for the failed call + */ + isAuto?: boolean; + /** + * Whether the failed call used a bring-your-own-key provider + */ + isByok?: boolean; + /** + * Effective maximum output-token limit for the failed call + */ + maxOutputTokens?: number; + /** + * Effective maximum prompt-token limit for the failed call + */ + maxPromptTokens?: number; /** * Model identifier used for the failed API call */ @@ -3100,14 +4448,62 @@ export interface ModelCallFailureData { */ providerCallId?: string; /** - * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation + * Per-quota usage snapshots parsed from the failed response's quota headers, keyed by quota identifier. Present when the error response carried quota headers (e.g. a 402 once the additional spend limit is reached) so the UI can refresh the quota display on failure. + * + * @internal */ - serviceRequestId?: string; + quotaSnapshots?: { + [k: string]: AssistantUsageQuotaSnapshot | undefined; + }; + /** + * Reasoning effort level used for the failed model call, if applicable + */ + reasoningEffort?: string; + requestFingerprint?: ModelCallFailureRequestFingerprint; + rte?: boolean; + /** + * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation + */ + serviceRequestId?: string; source: ModelCallFailureSource; /** * HTTP status code from the failed request */ statusCode?: number; + transport?: ModelCallFailureTransport; +} +/** + * Content-free structural summary of the failing request for diagnosing malformed 4xx calls + */ +export interface ModelCallFailureRequestFingerprint { + /** + * Total number of image content parts + */ + imagePartCount: number; + /** + * Image parts whose media type cannot be determined (rejected by strict providers) + */ + imagePartsMissingMediaType: number; + /** + * Role of the final message in the request + */ + lastMessageRole?: string; + /** + * Total number of messages in the request + */ + messageCount: number; + /** + * Tool calls whose name is missing or empty (rejected by strict providers) + */ + namelessToolCallCount: number; + /** + * Total number of tool calls across assistant messages + */ + toolCallCount: number; + /** + * Number of "tool" result messages in the request + */ + toolResultMessageCount: number; } /** * Session event "abort". Turn abort information including the reason for termination @@ -3182,9 +4578,7 @@ export interface ToolUserRequestedData { /** * Arguments for the tool invocation */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; /** * Unique identifier for this tool call */ @@ -3231,9 +4625,7 @@ export interface ToolExecutionStartData { /** * Arguments passed to the tool */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; /** * When true, the tool output should be displayed expanded (verbatim) in the CLI timeline */ @@ -3246,15 +4638,22 @@ export interface ToolExecutionStartData { * Original tool name on the MCP server, when the tool is an MCP tool */ mcpToolName?: string; + /** + * Model identifier that generated this tool call + */ + model?: string; /** * @deprecated * Tool call ID of the parent tool invocation when this event originates from a sub-agent */ parentToolCallId?: string; + rte?: boolean; + shellToolInfo?: ToolExecutionStartShellToolInfo; /** * Unique identifier for this tool call */ toolCallId: string; + toolDescription?: ToolExecutionStartToolDescription; /** * Name of the tool being executed */ @@ -3264,6 +4663,58 @@ export interface ToolExecutionStartData { */ turnId?: string; } +/** + * Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs. + */ +export interface ToolExecutionStartShellToolInfo { + /** + * The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand. + * + * @experimental + */ + displayCommand?: string; + /** + * Whether the command includes a file write redirection (e.g., > or >>). + */ + hasWriteFileRedirection: boolean; + /** + * File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. + */ + possiblePaths: string[]; +} +/** + * Tool definition metadata, present for MCP tools with MCP Apps support + */ +export interface ToolExecutionStartToolDescription { + _meta?: ToolExecutionStartToolDescriptionMeta; + /** + * Tool description + */ + description?: string; + /** + * Tool name + */ + name: string; +} +/** + * MCP Apps metadata for UI resource association + */ +export interface ToolExecutionStartToolDescriptionMeta { + ui?: ToolExecutionStartToolDescriptionMetaUI; +} +/** + * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. + */ +export interface ToolExecutionStartToolDescriptionMetaUI { + /** + * URI of the UI resource + */ + resourceUri?: string; + /** + * Who can access this tool + */ + visibility?: ToolExecutionStartToolDescriptionMetaUIVisibility[]; +} /** * Session event "tool.execution_partial_result". Streaming tool execution output for incremental result display */ @@ -3393,6 +4844,12 @@ export interface ToolExecutionCompleteData { * Whether this tool call was explicitly requested by the user rather than the assistant */ isUserRequested?: boolean; + /** + * FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels). Persisted as `{ ifc: ... }` so the label survives session resume, including model-visible failure results. Experimental. + * + * @experimental + */ + mcpMeta?: JsonValue; /** * Model identifier that generated this tool call */ @@ -3403,6 +4860,7 @@ export interface ToolExecutionCompleteData { */ parentToolCallId?: string; result?: ToolExecutionCompleteResult; + rte?: boolean; /** * Whether this tool execution ran inside a sandbox container */ @@ -3420,7 +4878,7 @@ export interface ToolExecutionCompleteData { * Tool-specific telemetry data (e.g., CodeQL check counts, grep match counts) */ toolTelemetry?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event @@ -3444,6 +4902,18 @@ export interface ToolExecutionCompleteError { * Tool execution result on success */ export interface ToolExecutionCompleteResult { + /** + * Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call + * + * @experimental + */ + binaryResultsForLlm?: PersistedBinaryResult[]; + /** + * Provider-neutral source material this tool makes available to the model as citable content. Persisted so it survives session resume. Experimental. + * + * @experimental + */ + citableSources?: CitableSource[]; /** * Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency */ @@ -3456,8 +4926,123 @@ export interface ToolExecutionCompleteResult { * Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent. */ detailedContent?: string; + /** + * FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels) — persisted as `{ ifc: ... }` (only the `ifc` key, not the whole `_meta`). Persisted so the FIDES IFC label survives session resume: the engine rehydrates accumulated taint by replaying these on load. Populated for ingress sources when FIDES IFC is on. Experimental. + * + * @experimental + */ + mcpMeta?: JsonValue; + /** + * Structured content (arbitrary JSON) returned verbatim by the MCP tool + */ + structuredContent?: JsonValue; uiResource?: ToolExecutionCompleteUIResource; } +/** + * Binary result returned by a tool for the model + */ +export interface PersistedBinaryImage { + /** + * Base64-encoded binary data + */ + data: string; + /** + * Human-readable description of the binary data + */ + description?: string; + /** + * Optional metadata from the producing tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; + }; + /** + * MIME type of the binary data + */ + mimeType: string; + type: PersistedBinaryImageType; +} +/** + * A binary result whose data was omitted from persistence due to the inline size limit + */ +/** @experimental */ +export interface OmittedBinaryResult { + /** + * Decoded byte length of the omitted binary data + */ + byteLength: number; + /** + * Human-readable description of the binary data + */ + description?: string; + /** + * Optional metadata from the producing tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; + }; + /** + * MIME type of the omitted binary data + */ + mimeType: string; + omittedReason: OmittedBinaryOmittedReason; + type: OmittedBinaryType; +} +/** + * A reference to binary data persisted once on a session.binary_asset event and shared by id + */ +/** @experimental */ +export interface BinaryAssetReference { + /** + * Content-addressed id of the session.binary_asset event that holds this binary's bytes (e.g. "sha256:..."). + */ + assetId: string; + /** + * Decoded byte length of the referenced binary data + */ + byteLength: number; + /** + * Human-readable description of the binary data + */ + description?: string; + /** + * Optional metadata from the producing tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; + }; + /** + * MIME type of the referenced binary data + */ + mimeType: string; + type: BinaryAssetReferenceType; +} +/** + * A source supplied by a tool that should be made available to the model as citable content. + */ +/** @experimental */ +export interface CitableSource { + /** + * The source text made available to the model as citable content. + */ + content: string; + /** + * Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source. + */ + id: string; + /** + * File path relative to the agent's workspace root, when the source is a file. + */ + path?: string; + /** + * Human-readable title of the source. + */ + title?: string; + /** + * URL of the source, when it is a web resource. + */ + url?: string; +} /** * Plain text content block */ @@ -3472,7 +5057,8 @@ export interface ToolExecutionCompleteContentText { type: "text"; } /** - * Terminal/shell output content block with optional exit code and working directory + * @deprecated + * Deprecated for shell command exit metadata. Use ToolExecutionCompleteContentShellExit instead. */ export interface ToolExecutionCompleteContentTerminal { /** @@ -3492,6 +5078,35 @@ export interface ToolExecutionCompleteContentTerminal { */ type: "terminal"; } +/** + * Shell command exit metadata with optional output preview + */ +export interface ToolExecutionCompleteContentShellExit { + /** + * Working directory where the shell command was executed + */ + cwd?: string; + /** + * Exit code from the completed shell command + */ + exitCode: number; + /** + * Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + */ + outputPreview?: string; + /** + * Whether outputPreview is known to be incomplete or truncated + */ + outputTruncated?: boolean; + /** + * Shell id, as assigned by Copilot runtime + */ + shellId: string; + /** + * Content block type discriminator + */ + type: "shell_exit"; +} /** * Image content block with base64-encoded data */ @@ -3592,7 +5207,7 @@ export interface ToolExecutionCompleteContentResource { type: "resource"; } /** - * Schema for the `EmbeddedTextResourceContents` type. + * Embedded text resource contents identified by a URI, with an optional MIME type and a text payload. */ export interface EmbeddedTextResourceContents { /** @@ -3609,7 +5224,7 @@ export interface EmbeddedTextResourceContents { uri: string; } /** - * Schema for the `EmbeddedBlobResourceContents` type. + * Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob. */ export interface EmbeddedBlobResourceContents { /** @@ -3654,7 +5269,7 @@ export interface ToolExecutionCompleteUIResourceMeta { ui?: ToolExecutionCompleteUIResourceMetaUI; } /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. + * MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. */ export interface ToolExecutionCompleteUIResourceMetaUI { csp?: ToolExecutionCompleteUIResourceMetaUICsp; @@ -3663,7 +5278,7 @@ export interface ToolExecutionCompleteUIResourceMetaUI { prefersBorder?: boolean; } /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. + * CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. */ export interface ToolExecutionCompleteUIResourceMetaUICsp { baseUriDomains?: string[]; @@ -3672,7 +5287,7 @@ export interface ToolExecutionCompleteUIResourceMetaUICsp { resourceDomains?: string[]; } /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. + * Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. */ export interface ToolExecutionCompleteUIResourceMetaUIPermissions { camera?: ToolExecutionCompleteUIResourceMetaUIPermissionsCamera; @@ -3681,29 +5296,21 @@ export interface ToolExecutionCompleteUIResourceMetaUIPermissions { microphone?: ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone; } /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. + * Marker object for camera permission on an MCP Apps UI resource. */ -export interface ToolExecutionCompleteUIResourceMetaUIPermissionsCamera { - [k: string]: unknown | undefined; -} +export interface ToolExecutionCompleteUIResourceMetaUIPermissionsCamera {} /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. + * Marker object for clipboard-write permission on an MCP Apps UI resource. */ -export interface ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite { - [k: string]: unknown | undefined; -} +export interface ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite {} /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. + * Marker object for geolocation permission on an MCP Apps UI resource. */ -export interface ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation { - [k: string]: unknown | undefined; -} +export interface ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation {} /** - * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. + * Marker object for microphone permission on an MCP Apps UI resource. */ -export interface ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone { - [k: string]: unknown | undefined; -} +export interface ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone {} /** * Tool definition metadata, present for MCP tools with MCP Apps support */ @@ -3725,7 +5332,7 @@ export interface ToolExecutionCompleteToolDescriptionMeta { ui?: ToolExecutionCompleteToolDescriptionMetaUI; } /** - * Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. + * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. */ export interface ToolExecutionCompleteToolDescriptionMetaUI { /** @@ -3737,6 +5344,49 @@ export interface ToolExecutionCompleteToolDescriptionMetaUI { */ visibility?: ToolExecutionCompleteToolDescriptionMetaUIVisibility[]; } +/** + * Session event "tool_search.activated". Persisted generic client-side tool activations restored when a session resumes. + */ +export interface ToolSearchActivatedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ToolSearchActivatedData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "tool_search.activated". + */ + type: "tool_search.activated"; +} +/** + * Persisted generic client-side tool activations restored when a session resumes. + */ +export interface ToolSearchActivatedData { + /** + * Tool-search strategy that activated the definitions. + */ + strategy: string; + /** + * Names of tool definitions activated by this search invocation. + */ + toolNames: string[]; +} /** * Session event "skill.invoked". Skill invocation details including content, allowed tools, and plugin metadata */ @@ -3783,6 +5433,10 @@ export interface SkillInvokedData { * Description of the skill from its SKILL.md frontmatter */ description?: string; + /** + * Model identifier active when the skill was invoked, when known + */ + model?: string; /** * Name of the invoked skill */ @@ -3800,7 +5454,7 @@ export interface SkillInvokedData { */ pluginVersion?: string; /** - * Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) + * Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) */ source?: string; trigger?: SkillInvokedTrigger; @@ -3852,7 +5506,7 @@ export interface SubagentStartedData { */ agentName: string; /** - * Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck). + * Model the sub-agent will run with, when known at start. */ model?: string; /** @@ -3902,6 +5556,10 @@ export interface SubagentCompletedData { * Internal name of the sub-agent */ agentName: string; + /** + * Whether the sub-agent was torn down by cancellation - its own abort, or an ancestor being killed - instead of finishing its work. Cancellation is not a failure, so the run still reports completion; this distinguishes a torn-down sub-agent from one that ran to the end. + */ + cancelled?: boolean; /** * Wall-clock duration of the sub-agent execution in milliseconds */ @@ -3974,7 +5632,7 @@ export interface SubagentFailedData { */ error: string; /** - * Model used by the sub-agent (if any model calls succeeded before failure) + * Model selected for the sub-agent, when known */ model?: string; /** @@ -4116,9 +5774,7 @@ export interface HookStartData { /** * Input data passed to the hook */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; } /** * Session event "hook.end". Hook invocation completion details including output, success status, and error information @@ -4166,9 +5822,7 @@ export interface HookEndData { /** * Output data produced by the hook */ - output?: { - [k: string]: unknown | undefined; - }; + output?: JsonValue; /** * Whether the hook completed successfully */ @@ -4182,6 +5836,10 @@ export interface HookEndError { * Human-readable error message */ message: string; + /** + * Source label of the hook that errored (e.g. the plugin it was loaded from), when known + */ + source?: string; /** * Error stack trace, when available */ @@ -4225,16 +5883,21 @@ export interface HookProgressData { * Human-readable progress message from the hook process */ message: string; + /** + * When true, this status message replaces the previous temporary one instead of accumulating + */ + temporary?: boolean; } /** - * Session event "system.message". System/developer instruction content with role and optional template metadata + * Session event "session.binary_asset". Canonical bytes for a content-addressed binary asset shared by reference across events */ -export interface SystemMessageEvent { +/** @experimental */ +export interface BinaryAssetEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: SystemMessageData; + data: BinaryAssetData; /** * When true, the event is transient and not persisted to the session event log on disk */ @@ -4252,49 +5915,115 @@ export interface SystemMessageEvent { */ timestamp: string; /** - * Type discriminator. Always "system.message". + * Type discriminator. Always "session.binary_asset". */ - type: "system.message"; + type: "session.binary_asset"; } /** - * System/developer instruction content with role and optional template metadata + * Canonical bytes for a content-addressed binary asset shared by reference across events */ -export interface SystemMessageData { +export interface BinaryAssetData { /** - * The system or developer prompt text sent as model input + * Content-addressed id for this binary asset (e.g. "sha256:..."). */ - content: string; - metadata?: SystemMessageMetadata; + assetId: string; /** - * Optional name identifier for the message source + * Decoded byte length of the binary asset */ - name?: string; - role: SystemMessageRole; -} -/** - * Metadata about the prompt template and its construction - */ -export interface SystemMessageMetadata { + byteLength: number; /** - * Version identifier of the prompt template used + * Base64-encoded binary data */ - promptVersion?: string; + data: string; /** - * Template variables used when constructing the prompt + * Human-readable description of the binary data */ - variables?: { - [k: string]: unknown | undefined; + description?: string; + /** + * Optional metadata from the producing tool. + */ + metadata?: { + [k: string]: JsonValue | undefined; }; + /** + * MIME type of the binary asset + */ + mimeType: string; + type: BinaryAssetType; } /** - * Session event "system.notification". System-generated notification for runtime events like background task completion + * Session event "system.message". System/developer instruction content with role and optional template metadata */ -export interface SystemNotificationEvent { +export interface SystemMessageEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: SystemNotificationData; + data: SystemMessageData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "system.message". + */ + type: "system.message"; +} +/** + * System/developer instruction content with role and optional template metadata + */ +export interface SystemMessageData { + /** + * The system or developer prompt text sent as model input + */ + content: string; + /** + * Logical interaction identifier for the model run receiving this prompt + */ + interactionId?: string; + metadata?: SystemMessageMetadata; + /** + * Optional name identifier for the message source + */ + name?: string; + role: SystemMessageRole; +} +/** + * Metadata about the prompt template and its construction + */ +export interface SystemMessageMetadata { + /** + * Version identifier of the prompt template used + */ + promptVersion?: string; + /** + * Template variables used when constructing the prompt + */ + variables?: { + [k: string]: JsonValue | undefined; + }; +} +/** + * Session event "system.notification". System-generated notification for runtime events like background task completion + */ +export interface SystemNotificationEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: SystemNotificationData; /** * When true, the event is transient and not persisted to the session event log on disk */ @@ -4327,7 +6056,7 @@ export interface SystemNotificationData { kind: SystemNotification; } /** - * Schema for the `SystemNotificationAgentCompleted` type. + * System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt. */ export interface SystemNotificationAgentCompleted { /** @@ -4353,7 +6082,7 @@ export interface SystemNotificationAgentCompleted { type: "agent_completed"; } /** - * Schema for the `SystemNotificationAgentIdle` type. + * System notification metadata for a background agent that became idle, including agent ID, type, and description. */ export interface SystemNotificationAgentIdle { /** @@ -4374,7 +6103,7 @@ export interface SystemNotificationAgentIdle { type: "agent_idle"; } /** - * Schema for the `SystemNotificationNewInboxMessage` type. + * System notification metadata for a new inbox message, including entry ID, sender details, and summary. */ export interface SystemNotificationNewInboxMessage { /** @@ -4399,7 +6128,7 @@ export interface SystemNotificationNewInboxMessage { type: "new_inbox_message"; } /** - * Schema for the `SystemNotificationShellCompleted` type. + * System notification metadata for a shell session that completed, including shell ID, optional exit code, and description. */ export interface SystemNotificationShellCompleted { /** @@ -4420,7 +6149,7 @@ export interface SystemNotificationShellCompleted { type: "shell_completed"; } /** - * Schema for the `SystemNotificationShellDetachedCompleted` type. + * System notification metadata for a detached shell session that completed, including shell ID and description. */ export interface SystemNotificationShellDetachedCompleted { /** @@ -4437,7 +6166,7 @@ export interface SystemNotificationShellDetachedCompleted { type: "shell_detached_completed"; } /** - * Schema for the `SystemNotificationInstructionDiscovered` type. + * System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool. */ export interface SystemNotificationInstructionDiscovered { /** @@ -4461,6 +6190,65 @@ export interface SystemNotificationInstructionDiscovered { */ type: "instruction_discovered"; } +/** + * System notification metadata for a factory execution attempt that reached a terminal state. + */ +export interface SystemNotificationFactoryCompleted { + /** + * Execution attempt that reached this terminal state. + */ + attempt: number; + /** + * Consumed AI usage in nano-AIU. + */ + consumedNanoAiu: number; + /** + * Subagents consumed by the run across all attempts. + */ + consumedSubagents: number; + /** + * Accumulated active execution time in milliseconds. + */ + elapsedMs: number; + /** + * Persisted factory name. + */ + factoryName: string; + /** + * Machine-readable terminal failure details, when present. + */ + failure?: JsonValue; + /** + * Bounded prompt-safe preview of the completed result. + */ + resultPreview?: string; + /** + * Actionable run_factory resume guidance for a resource-limit failure. + */ + retryGuidance?: string; + /** + * Factory run identifier. + */ + runId: string; + status: SystemNotificationFactoryCompletedStatus; + /** + * Type discriminator. Always "factory_completed". + */ + type: "factory_completed"; +} +/** + * System notification metadata from an external host that does not match a runtime-owned notification kind. + */ +export interface SystemNotificationUnclassified { + /** + * Opaque metadata supplied by the external host, when present. + */ + metadata?: JsonValue; + /** + * Type discriminator. Always "unclassified". + */ + type: "unclassified"; +} /** * Session event "permission.requested". Permission request notification requiring client approval with request details */ @@ -4505,6 +6293,10 @@ export interface PermissionRequestedData { * When true, this permission was already resolved by a permissionRequest hook and requires no client action */ resolvedByHook?: boolean; + /** + * Neutral risk metadata supplied by the tool host. Consumers may display this value but must not use it to bypass the permission decision. + */ + riskAssessment?: JsonValue; } /** * Shell command permission request @@ -4518,6 +6310,10 @@ export interface PermissionRequestShell { * Parsed command identifiers found in the command text */ commands: PermissionRequestShellCommand[]; + /** + * Parsed command segments, including arguments, used for managed policy matching + */ + commandSegments?: PermissionRequestShellCommandSegment[]; /** * The complete shell command text to be executed */ @@ -4534,6 +6330,10 @@ export interface PermissionRequestShell { * Permission kind discriminator */ kind: "shell"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * File paths that may be read or written by the command */ @@ -4542,6 +6342,14 @@ export interface PermissionRequestShell { * URLs that may be accessed by the command */ possibleUrls: PermissionRequestShellPossibleUrl[]; + /** + * True when the model has requested to run this command outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + */ + requestSandboxBypass?: boolean; + /** + * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + */ + requestSandboxBypassReason?: string; /** * Tool call ID that triggered this permission request */ @@ -4552,7 +6360,7 @@ export interface PermissionRequestShell { warning?: string; } /** - * Schema for the `PermissionRequestShellCommand` type. + * A parsed command identifier in a shell permission request, including whether it is read-only. */ export interface PermissionRequestShellCommand { /** @@ -4565,7 +6373,20 @@ export interface PermissionRequestShellCommand { readOnly: boolean; } /** - * Schema for the `PermissionRequestShellPossibleUrl` type. + * A parsed shell command segment used for argument-aware managed policy matching. + */ +export interface PermissionRequestShellCommandSegment { + /** + * Full text of this command segment, including arguments + */ + fullCommandText: string; + /** + * Command identifier (e.g., executable name) + */ + identifier: string; +} +/** + * A URL that may be accessed by a command in a shell permission request. */ export interface PermissionRequestShellPossibleUrl { /** @@ -4597,10 +6418,22 @@ export interface PermissionRequestWrite { * Permission kind discriminator */ kind: "write"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * Complete new file contents for newly created files */ newFileContents?: string; + /** + * True when a built-in file tool (apply_patch / str_replace_editor) asked to write a path the sandbox filesystem policy would block, and the host opted in via sandbox.allowBypass. This is a request, not a grant: the write happens unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + */ + requestSandboxBypass?: boolean; + /** + * Justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + */ + requestSandboxBypassReason?: string; /** * Tool call ID that triggered this permission request */ @@ -4618,10 +6451,22 @@ export interface PermissionRequestRead { * Permission kind discriminator */ kind: "read"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * Path of the file or directory being read */ path: string; + /** + * True when the model has requested to run this search outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + */ + requestSandboxBypass?: boolean; + /** + * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + */ + requestSandboxBypassReason?: string; /** * Tool call ID that triggered this permission request */ @@ -4634,9 +6479,7 @@ export interface PermissionRequestMcp { /** * Arguments to pass to the MCP tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; /** * Permission kind discriminator */ @@ -4674,6 +6517,22 @@ export interface PermissionRequestUrl { * Permission kind discriminator */ kind: "url"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; + /** + * Immediately preceding URL when this request is for a redirect target + */ + redirectedFrom?: string; + /** + * True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + */ + requestSandboxBypass?: boolean; + /** + * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + */ + requestSandboxBypassReason?: string; /** * Tool call ID that triggered this permission request */ @@ -4721,9 +6580,7 @@ export interface PermissionRequestCustomTool { /** * Arguments to pass to the custom tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; /** * Permission kind discriminator */ @@ -4756,9 +6613,7 @@ export interface PermissionRequestHook { /** * Arguments of the tool call being gated */ - toolArgs?: { - [k: string]: unknown | undefined; - }; + toolArgs?: JsonValue; /** * Tool call ID that triggered this permission request */ @@ -4789,6 +6644,73 @@ export interface PermissionRequestExtensionManagement { */ toolCallId?: string; } +/** + * Factory run or authoring permission request + */ +export interface PermissionRequestFactory { + /** + * Canonical key used for scoped factory approvals + */ + approvalKey: string; + /** + * Whether this factory is eligible for persistent approval + */ + canPersistApproval: boolean; + declaredMaxAiCredits?: number; + declaredMaxConcurrentSubagents?: number; + declaredMaxTotalSubagents?: number; + declaredTimeoutSeconds?: number; + /** + * Factory description + */ + description: string; + /** + * Permission kind discriminator + */ + kind: "factory"; + /** + * Effective AI-credit limit; omitted means unlimited + */ + maxAiCredits?: number; + /** + * Effective concurrent-subagent limit; omitted means unlimited + */ + maxConcurrentSubagents?: number; + /** + * Effective total-subagent limit; omitted means unlimited + */ + maxTotalSubagents?: number; + /** + * Factory name + */ + name: string; + operation: FactoryPermissionOperation; + /** + * Declared factory phases + */ + phases: FactoryPermissionPhase[]; + /** + * Effective active-time limit in seconds; omitted means unlimited + */ + timeoutSeconds?: number; + /** + * Tool call ID that triggered this permission request + */ + toolCallId?: string; +} +/** + * A declared phase shown in a factory permission prompt. + */ +export interface FactoryPermissionPhase { + /** + * Optional phase detail + */ + detail?: string; + /** + * Phase title + */ + title: string; +} /** * Extension permission access request */ @@ -4814,6 +6736,12 @@ export interface PermissionRequestExtensionPermissionAccess { * Shell command permission prompt */ export interface PermissionPromptRequestCommands { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Whether the UI can offer session-wide approval for this command pattern */ @@ -4834,6 +6762,10 @@ export interface PermissionPromptRequestCommands { * Prompt kind discriminator */ kind: "commands"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * Tool call ID that triggered this permission request */ @@ -4843,10 +6775,32 @@ export interface PermissionPromptRequestCommands { */ warning?: string; } +/** + * Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is "auto"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. + */ +/** @experimental */ +export interface PermissionAutoApproval { + failureReason?: AutoApprovalJudgeFailureReason; + /** + * Model id that produced the recommendation, when the judge was consulted and reported one. Absent for `excluded` (the judge was not consulted) and for failures that occurred before a model was selected. + */ + model?: string; + /** + * Human-readable reason for the judge's recommendation, when available. + */ + reason?: string; + recommendation: AutoApprovalRecommendation; +} /** * File write permission prompt */ export interface PermissionPromptRequestWrite { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Whether the UI can offer session-wide approval for file write operations */ @@ -4867,6 +6821,10 @@ export interface PermissionPromptRequestWrite { * Prompt kind discriminator */ kind: "write"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * Complete new file contents for newly created files */ @@ -4880,6 +6838,12 @@ export interface PermissionPromptRequestWrite { * File read permission prompt */ export interface PermissionPromptRequestRead { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Human-readable description of why the file is being read */ @@ -4888,6 +6852,10 @@ export interface PermissionPromptRequestRead { * Prompt kind discriminator */ kind: "read"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; /** * Path of the file or directory being read */ @@ -4901,7 +6869,16 @@ export interface PermissionPromptRequestRead { * MCP tool invocation permission prompt */ export interface PermissionPromptRequestMcp { - args?: unknown; + /** + * Arguments to pass to the MCP tool + */ + args?: JsonValue; + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Prompt kind discriminator */ @@ -4927,6 +6904,12 @@ export interface PermissionPromptRequestMcp { * URL access permission prompt */ export interface PermissionPromptRequestUrl { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Human-readable description of why the URL is being accessed */ @@ -4935,6 +6918,22 @@ export interface PermissionPromptRequestUrl { * Prompt kind discriminator */ kind: "url"; + /** + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; + /** + * Immediately preceding URL when this prompt is for a redirect target + */ + redirectedFrom?: string; + /** + * True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + */ + requestSandboxBypass?: boolean; + /** + * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + */ + requestSandboxBypassReason?: string; /** * Tool call ID that triggered this permission request */ @@ -4949,6 +6948,12 @@ export interface PermissionPromptRequestUrl { */ export interface PermissionPromptRequestMemory { action?: PermissionRequestMemoryAction; + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Source references for the stored fact (store only) */ @@ -4982,9 +6987,13 @@ export interface PermissionPromptRequestCustomTool { /** * Arguments to pass to the custom tool */ - args?: { - [k: string]: unknown | undefined; - }; + args?: JsonValue; + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Prompt kind discriminator */ @@ -5007,6 +7016,12 @@ export interface PermissionPromptRequestCustomTool { */ export interface PermissionPromptRequestPath { accessKind: PermissionPromptRequestPathAccessKind; + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Prompt kind discriminator */ @@ -5024,6 +7039,12 @@ export interface PermissionPromptRequestPath { * Hook confirmation permission prompt */ export interface PermissionPromptRequestHook { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Optional message from the hook explaining why confirmation is needed */ @@ -5035,9 +7056,7 @@ export interface PermissionPromptRequestHook { /** * Arguments of the tool call being gated */ - toolArgs?: { - [k: string]: unknown | undefined; - }; + toolArgs?: JsonValue; /** * Tool call ID that triggered this permission request */ @@ -5051,6 +7070,12 @@ export interface PermissionPromptRequestHook { * Extension management permission prompt */ export interface PermissionPromptRequestExtensionManagement { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; /** * Name of the extension being managed */ @@ -5069,23 +7094,93 @@ export interface PermissionPromptRequestExtensionManagement { toolCallId?: string; } /** - * Extension permission access prompt + * Factory run or authoring permission prompt */ -export interface PermissionPromptRequestExtensionPermissionAccess { +export interface PermissionPromptRequestFactory { /** - * Capabilities the extension is requesting + * Canonical key used for scoped factory approvals */ - capabilities: string[]; + approvalKey: string; /** - * Name of the extension requesting permission access + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental */ - extensionName: string; + autoApproval?: PermissionAutoApproval; + /** + * Whether this factory is eligible for persistent approval + */ + canPersistApproval: boolean; + declaredMaxAiCredits?: number; + declaredMaxConcurrentSubagents?: number; + declaredMaxTotalSubagents?: number; + declaredTimeoutSeconds?: number; + /** + * Factory description + */ + description: string; /** * Prompt kind discriminator */ - kind: "extension-permission-access"; + kind: "factory"; /** - * Tool call ID that triggered this permission request + * Whether managed policy requires a human response and forbids host auto-approval + */ + managedApprovalRequired?: boolean; + /** + * Effective AI-credit limit; omitted means unlimited + */ + maxAiCredits?: number; + /** + * Effective concurrent-subagent limit; omitted means unlimited + */ + maxConcurrentSubagents?: number; + /** + * Effective total-subagent limit; omitted means unlimited + */ + maxTotalSubagents?: number; + /** + * Factory name + */ + name: string; + operation: FactoryPermissionOperation; + /** + * Declared factory phases + */ + phases: FactoryPermissionPhase[]; + /** + * Effective active-time limit in seconds; omitted means unlimited + */ + timeoutSeconds?: number; + /** + * Tool call ID that triggered this permission request + */ + toolCallId?: string; +} +/** + * Extension permission access prompt + */ +export interface PermissionPromptRequestExtensionPermissionAccess { + /** + * Auto-approval judge information for this request; present only when auto mode is enabled. + * + * @experimental + */ + autoApproval?: PermissionAutoApproval; + /** + * Capabilities the extension is requesting + */ + capabilities: string[]; + /** + * Name of the extension requesting permission access + */ + extensionName: string; + /** + * Prompt kind discriminator + */ + kind: "extension-permission-access"; + /** + * Tool call ID that triggered this permission request */ toolCallId?: string; } @@ -5134,7 +7229,7 @@ export interface PermissionCompletedData { toolCallId?: string; } /** - * Schema for the `PermissionApproved` type. + * Permission response variant indicating the request was approved without persisting an approval rule. */ export interface PermissionApproved { /** @@ -5143,7 +7238,7 @@ export interface PermissionApproved { kind: "approved"; } /** - * Schema for the `PermissionApprovedForSession` type. + * Permission response variant that approves a request and remembers the provided approval for the rest of the session. */ export interface PermissionApprovedForSession { approval: UserToolSessionApproval; @@ -5153,7 +7248,7 @@ export interface PermissionApprovedForSession { kind: "approved-for-session"; } /** - * Schema for the `UserToolSessionApprovalCommands` type. + * Session-scoped tool-approval rule for specific shell command identifiers. */ export interface UserToolSessionApprovalCommands { /** @@ -5166,7 +7261,7 @@ export interface UserToolSessionApprovalCommands { kind: "commands"; } /** - * Schema for the `UserToolSessionApprovalRead` type. + * Session-scoped tool-approval rule for read-only filesystem operations. */ export interface UserToolSessionApprovalRead { /** @@ -5175,7 +7270,7 @@ export interface UserToolSessionApprovalRead { kind: "read"; } /** - * Schema for the `UserToolSessionApprovalWrite` type. + * Session-scoped tool-approval rule for filesystem write operations. */ export interface UserToolSessionApprovalWrite { /** @@ -5184,7 +7279,7 @@ export interface UserToolSessionApprovalWrite { kind: "write"; } /** - * Schema for the `UserToolSessionApprovalMcp` type. + * Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null. */ export interface UserToolSessionApprovalMcp { /** @@ -5201,7 +7296,7 @@ export interface UserToolSessionApprovalMcp { toolName: string | null; } /** - * Schema for the `UserToolSessionApprovalMemory` type. + * Session-scoped tool-approval rule for writes to long-term memory. */ export interface UserToolSessionApprovalMemory { /** @@ -5210,7 +7305,7 @@ export interface UserToolSessionApprovalMemory { kind: "memory"; } /** - * Schema for the `UserToolSessionApprovalCustomTool` type. + * Session-scoped tool-approval rule for a custom tool, keyed by tool name. */ export interface UserToolSessionApprovalCustomTool { /** @@ -5223,7 +7318,7 @@ export interface UserToolSessionApprovalCustomTool { toolName: string; } /** - * Schema for the `UserToolSessionApprovalExtensionManagement` type. + * Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation. */ export interface UserToolSessionApprovalExtensionManagement { /** @@ -5236,7 +7331,20 @@ export interface UserToolSessionApprovalExtensionManagement { operation?: string; } /** - * Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type. + * Session-scoped factory approval, optionally narrowed by approval key. + */ +export interface UserToolSessionApprovalFactory { + /** + * Optional factory operation name or canonical approval key + */ + approvalKey?: string; + /** + * Factory approval kind + */ + kind: "factory"; +} +/** + * Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name. */ export interface UserToolSessionApprovalExtensionPermissionAccess { /** @@ -5249,7 +7357,7 @@ export interface UserToolSessionApprovalExtensionPermissionAccess { kind: "extension-permission-access"; } /** - * Schema for the `PermissionApprovedForLocation` type. + * Permission response variant that approves a request and persists the provided approval to a project location key. */ export interface PermissionApprovedForLocation { approval: UserToolSessionApproval; @@ -5263,7 +7371,7 @@ export interface PermissionApprovedForLocation { locationKey: string; } /** - * Schema for the `PermissionCancelled` type. + * Permission response variant indicating the request was cancelled before use, with an optional reason. */ export interface PermissionCancelled { /** @@ -5276,7 +7384,7 @@ export interface PermissionCancelled { reason?: string; } /** - * Schema for the `PermissionDeniedByRules` type. + * Permission response variant denied because matching approval rules explicitly blocked the request. */ export interface PermissionDeniedByRules { /** @@ -5289,7 +7397,7 @@ export interface PermissionDeniedByRules { rules: PermissionRule[]; } /** - * Schema for the `PermissionRule` type. + * A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value. */ export interface PermissionRule { /** @@ -5302,7 +7410,7 @@ export interface PermissionRule { kind: string; } /** - * Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. + * Permission response variant denied because no approval rule matched and user confirmation was unavailable. */ export interface PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser { /** @@ -5311,7 +7419,7 @@ export interface PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser { kind: "denied-no-approval-rule-and-could-not-request-from-user"; } /** - * Schema for the `PermissionDeniedInteractivelyByUser` type. + * Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag. */ export interface PermissionDeniedInteractivelyByUser { /** @@ -5328,7 +7436,7 @@ export interface PermissionDeniedInteractivelyByUser { kind: "denied-interactively-by-user"; } /** - * Schema for the `PermissionDeniedByContentExclusionPolicy` type. + * Permission response variant denying a path under content exclusion policy, with the path and message. */ export interface PermissionDeniedByContentExclusionPolicy { /** @@ -5345,7 +7453,7 @@ export interface PermissionDeniedByContentExclusionPolicy { path: string; } /** - * Schema for the `PermissionDeniedByPermissionRequestHook` type. + * Permission response variant denied by a permission-request hook, with optional message and interrupt flag. */ export interface PermissionDeniedByPermissionRequestHook { /** @@ -5519,7 +7627,6 @@ export interface ElicitationRequestedData { * URL to open in the user's browser (url mode only) */ url?: string; - [k: string]: unknown | undefined; } /** * JSON Schema describing the form fields to present to the user (form mode only) @@ -5529,7 +7636,7 @@ export interface ElicitationRequestedSchema { * Form field definitions, keyed by field name */ properties: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * List of required field names @@ -5623,7 +7730,7 @@ export interface SamplingRequestedData { /** * The JSON-RPC request ID from the MCP protocol */ - mcpRequestId: string | number; + mcpRequestId: JsonValue; /** * Unique identifier for this sampling request; used to respond via session.respondToSampling() */ @@ -5632,7 +7739,6 @@ export interface SamplingRequestedData { * Name of the MCP server that initiated the sampling request */ serverName: string; - [k: string]: unknown | undefined; } /** * Session event "sampling.completed". Sampling request completion notification signaling UI dismissal @@ -5707,10 +7813,16 @@ export interface McpOauthRequiredEvent { * OAuth authentication request for an MCP server */ export interface McpOauthRequiredData { + httpResponse?: McpOauthHttpResponse; + reason: McpOauthRequestReason; /** - * Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth() + * Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest */ requestId: string; + /** + * Raw OAuth protected-resource metadata document fetched for the MCP server, if available + */ + resourceMetadata?: string; /** * Display name of the MCP server that requires OAuth */ @@ -5720,6 +7832,37 @@ export interface McpOauthRequiredData { */ serverUrl: string; staticClientConfig?: McpOauthRequiredStaticClientConfig; + wwwAuthenticateParams?: McpOauthWWWAuthenticateParams; +} +/** + * Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. + */ +export interface McpOauthHttpResponse { + /** + * Complete UTF-8 response body for host-specific challenge handling, including an empty string for an empty body. Omitted when the complete body is not valid UTF-8; body read failures fail the HTTP operation rather than exposing a partial response. + */ + body?: string; + /** + * HTTP response headers as observed by the runtime. Order and casing are transport-dependent, and duplicate header names may appear multiple times. + */ + headers: HeaderEntry[]; + /** + * HTTP status code returned with the auth challenge. + */ + statusCode: number; +} +/** + * Single HTTP header entry as a name/value pair. + */ +export interface HeaderEntry { + /** + * HTTP response header name as observed by the runtime. + */ + name: string; + /** + * HTTP response header value as observed by the runtime. + */ + value: string; } /** * Static OAuth client configuration, if the server specifies one @@ -5729,6 +7872,10 @@ export interface McpOauthRequiredStaticClientConfig { * OAuth client ID for the server */ clientId: string; + /** + * Optional OAuth client secret for confidential static clients, when the runtime can resolve one + */ + clientSecret?: string; /** * 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). */ @@ -5738,6 +7885,23 @@ export interface McpOauthRequiredStaticClientConfig { */ publicClient?: boolean; } +/** + * OAuth WWW-Authenticate parameters parsed from an MCP auth challenge + */ +export interface McpOauthWWWAuthenticateParams { + /** + * OAuth error from the WWW-Authenticate error parameter, if present + */ + error?: string; + /** + * Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present + */ + resourceMetadataUrl?: string; + /** + * Requested OAuth scopes from the WWW-Authenticate scope parameter, if present + */ + scope?: string; +} /** * Session event "mcp.oauth_completed". MCP OAuth request completion notification */ @@ -5772,11 +7936,100 @@ export interface McpOauthCompletedEvent { * MCP OAuth request completion notification */ export interface McpOauthCompletedData { + outcome: McpOauthCompletionOutcome; /** * Request ID of the resolved OAuth request */ requestId: string; } +/** + * Session event "mcp.headers_refresh_required". Dynamic headers refresh request for a remote MCP server + */ +export interface McpHeadersRefreshRequiredEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: McpHeadersRefreshRequiredData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "mcp.headers_refresh_required". + */ + type: "mcp.headers_refresh_required"; +} +/** + * Dynamic headers refresh request for a remote MCP server + */ +export interface McpHeadersRefreshRequiredData { + reason: McpHeadersRefreshRequiredReason; + /** + * Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest() + */ + requestId: string; + /** + * Display name of the remote MCP server requesting headers + */ + serverName: string; + /** + * URL of the remote MCP server requesting headers + */ + serverUrl: string; +} +/** + * Session event "mcp.headers_refresh_completed". MCP headers refresh request completion notification + */ +export interface McpHeadersRefreshCompletedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: McpHeadersRefreshCompletedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "mcp.headers_refresh_completed". + */ + type: "mcp.headers_refresh_completed"; +} +/** + * MCP headers refresh request completion notification + */ +export interface McpHeadersRefreshCompletedData { + outcome: McpHeadersRefreshCompletedOutcome; + /** + * Request ID of the resolved headers refresh request + */ + requestId: string; +} /** * Session event "session.custom_notification". Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. */ @@ -5869,9 +8122,7 @@ export interface ExternalToolRequestedData { /** * Arguments to pass to the external tool */ - arguments?: { - [k: string]: unknown | undefined; - }; + arguments?: JsonValue; /** * Unique identifier for this request; used to respond via session.respondToExternalTool() */ @@ -6161,14 +8412,14 @@ export interface AutoModeSwitchCompletedData { response: AutoModeSwitchResponse; } /** - * Session event "commands.changed". SDK command registration change notification + * Session event "session_limits_exhausted.requested". Session limit exhaustion notification requiring user action. */ -export interface CommandsChangedEvent { +export interface SessionLimitsExhaustedRequestedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: CommandsChangedData; + data: SessionLimitsExhaustedRequestedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6186,41 +8437,36 @@ export interface CommandsChangedEvent { */ timestamp: string; /** - * Type discriminator. Always "commands.changed". + * Type discriminator. Always "session_limits_exhausted.requested". */ - type: "commands.changed"; + type: "session_limits_exhausted.requested"; } /** - * SDK command registration change notification + * Session limit exhaustion notification requiring user action. */ -export interface CommandsChangedData { +export interface SessionLimitsExhaustedRequestedData { /** - * Current list of registered SDK commands + * Configured max AI Credits for the current accounting window. */ - commands: CommandsChangedCommand[]; -} -/** - * Schema for the `CommandsChangedCommand` type. - */ -export interface CommandsChangedCommand { + maxAiCredits: number; /** - * Optional human-readable command description. + * Unique identifier for this request; used to respond via session.ui.handlePendingSessionLimitsExhausted(). */ - description?: string; + requestId: string; /** - * Slash command name without the leading slash. + * AI Credits already consumed in the current accounting window. */ - name: string; + usedAiCredits: number; } /** - * Session event "capabilities.changed". Session capability change notification + * Session event "session_limits_exhausted.completed". Session limit exhaustion prompt completion notification. */ -export interface CapabilitiesChangedEvent { +export interface SessionLimitsExhaustedCompletedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: CapabilitiesChangedData; + data: SessionLimitsExhaustedCompletedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6238,46 +8484,48 @@ export interface CapabilitiesChangedEvent { */ timestamp: string; /** - * Type discriminator. Always "capabilities.changed". + * Type discriminator. Always "session_limits_exhausted.completed". */ - type: "capabilities.changed"; + type: "session_limits_exhausted.completed"; } /** - * Session capability change notification + * Session limit exhaustion prompt completion notification. */ -export interface CapabilitiesChangedData { - ui?: CapabilitiesChangedUI; +export interface SessionLimitsExhaustedCompletedData { + /** + * Request ID of the resolved request; clients should dismiss any UI for this request. + */ + requestId: string; + response: SessionLimitsExhaustedResponse; } /** - * UI capability changes + * The user's selected action for an exhausted session limit. */ -export interface CapabilitiesChangedUI { - /** - * Whether canvas rendering is now supported - */ - canvases?: boolean; +export interface SessionLimitsExhaustedResponse { + action: SessionLimitsExhaustedResponseAction; /** - * Whether elicitation is now supported + * AI Credits to add to the current max when action is 'add'. */ - elicitation?: boolean; + additionalAiCredits?: number; /** - * Whether MCP Apps (SEP-1865) UI passthrough is now supported + * New absolute max AI Credits when action is 'set'. */ - mcpApps?: boolean; + maxAiCredits?: number; } /** - * Session event "exit_plan_mode.requested". Plan approval request with plan content and available user actions + * Session event "session.auto_mode_resolved". Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. */ -export interface ExitPlanModeRequestedEvent { +/** @experimental */ +export interface AutoModeResolvedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: ExitPlanModeRequestedData; + data: AutoModeResolvedData; /** - * Always true for events that are transient and not persisted to the session event log on disk. + * When true, the event is transient and not persisted to the session event log on disk */ - ephemeral: true; + ephemeral?: boolean; /** * Unique event identifier (UUID v4), generated when the event is emitted */ @@ -6291,41 +8539,85 @@ export interface ExitPlanModeRequestedEvent { */ timestamp: string; /** - * Type discriminator. Always "exit_plan_mode.requested". + * Type discriminator. Always "session.auto_mode_resolved". */ - type: "exit_plan_mode.requested"; + type: "session.auto_mode_resolved"; } /** - * Plan approval request with plan content and available user actions + * Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. */ -export interface ExitPlanModeRequestedData { +/** @experimental */ +export interface AutoModeResolvedData { /** - * Available actions the user can take + * Models offered to the router for this resolution */ - actions: ExitPlanModeAction[]; + availableModels?: string[]; /** - * Full content of the plan file + * Ordered candidate model list the router returned, when not a fallback */ - planContent: string; - recommendedAction: ExitPlanModeAction; + candidateModels?: string[]; /** - * Unique identifier for this request; used to respond via session.respondToExitPlanMode() + * Per-category classifier scores (0-1) behind the bucket: the granular HYDRA capability scores (reasoning, code_gen, debugging, tool_use), or the binary needs_reasoning/no_reasoning scores when HYDRA didn't run. Lets clients show a breakdown rather than just the bucket. */ - requestId: string; + categoryScores?: { + [k: string]: number | undefined; + }; /** - * Summary of the plan that was created + * The concrete model the session will use after any intent refinement */ - summary: string; + chosenModel: string; + /** + * The chosen model's score shortfall relative to the top candidate + */ + chosenShortfall?: number; + /** + * Classifier confidence for the predicted label, when available + */ + confidence?: number; + /** + * End-to-end client wait time for the router request in milliseconds + */ + endToEndLatencyMs?: number; + /** + * Whether the router fell back to the standard Auto selection + */ + fallback?: boolean; + /** + * Server-provided reason for falling back, when available + */ + fallbackReason?: string; + /** + * Whether the routed prompt contained an image + */ + hasImage?: boolean; + /** + * The predicted classifier label (e.g. `needs_reasoning`), when available + */ + predictedLabel?: string; + reasoningBucket?: AutoModeResolvedReasoningBucket; + /** + * Server-reported router processing time in milliseconds + */ + routerLatencyMs?: number; + /** + * The routing method the server applied, when Auto Intent ran + */ + routingMethod?: string; + /** + * Whether a sticky model choice overrode the router result + */ + stickyOverride?: boolean; } /** - * Session event "exit_plan_mode.completed". Plan mode exit completion with the user's approval decision and optional feedback + * Session event "session.managed_settings_resolved". Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. */ -export interface ExitPlanModeCompletedEvent { +/** @experimental */ +export interface ManagedSettingsResolvedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: ExitPlanModeCompletedData; + data: ManagedSettingsResolvedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6343,41 +8635,59 @@ export interface ExitPlanModeCompletedEvent { */ timestamp: string; /** - * Type discriminator. Always "exit_plan_mode.completed". + * Type discriminator. Always "session.managed_settings_resolved". */ - type: "exit_plan_mode.completed"; + type: "session.managed_settings_resolved"; } /** - * Plan mode exit completion with the user's approval decision and optional feedback + * Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. */ -export interface ExitPlanModeCompletedData { +/** @experimental */ +export interface ManagedSettingsResolvedData { /** - * Whether the plan was approved by the user + * Whether enterprise policy disables bypass-permissions ("yolo") mode for this session. Deny-wins across layers, and forced on when `failClosed` is true. */ - approved?: boolean; + bypassPermissionsDisabled: boolean; /** - * Whether edits should be auto-approved without confirmation + * Whether a session-local permissions layer injected by the SDK host was present */ - autoApproveEdits?: boolean; + clientManaged?: boolean; /** - * Free-form feedback from the user if they requested changes to the plan + * Whether an actual device MDM/plist/registry/file managed-settings layer was present */ - feedback?: string; + deviceManaged: boolean; /** - * Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request + * Whether managed policy could not be determined (e.g. a failed server fetch) and the session fell back to the fail-closed restriction. When true, restrictions such as disabling bypass-permissions are enforced even though `settings` may be absent. */ - requestId: string; - selectedAction?: ExitPlanModeAction; + failClosed: boolean; + /** + * The setting keys under enterprise management in the effective managed settings (e.g. `model`, `enabledPlugins`, `permissions`). Empty when no managed settings are in force. + */ + managedKeys: string[]; + /** + * Whether at least two managed sources supplied permission allowlists, so enforcement intersects them and the flattened settings payload omits `permissions.allow`. + */ + permissionsAllowIntersected?: boolean; + /** + * Whether the server (account/org) managed-settings layer was present + */ + serverManaged: boolean; + /** + * The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. + */ + settings?: JsonValue; + source: ManagedSettingsResolvedSource; } /** - * Session event "session.tools_updated". + * Session event "session.managed_settings_enforced". Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. */ -export interface ToolsUpdatedEvent { +/** @experimental */ +export interface ManagedSettingsEnforcedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: ToolsUpdatedData; + data: ManagedSettingsEnforcedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6395,12 +8705,271 @@ export interface ToolsUpdatedEvent { */ timestamp: string; /** - * Type discriminator. Always "session.tools_updated". + * Type discriminator. Always "session.managed_settings_enforced". + */ + type: "session.managed_settings_enforced"; +} +/** + * Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. + */ +/** @experimental */ +export interface ManagedSettingsEnforcedData { + action: ManagedSettingsEnforcedAction; + escalation?: ManagedSettingsEnforcedEscalation; + /** + * Whether the enforcement was forced by fail-closed handling (managed policy could not be determined) rather than an explicit managed setting. When true, `setting` still names the restriction that was applied. + */ + failClosed: boolean; + /** + * A human-readable explanation of why the action was governed, suitable for surfacing to the user. + */ + message: string; + /** + * The managed setting key responsible for the enforcement (e.g. `permissions.disableBypassPermissionsMode`). + */ + setting: string; +} +/** + * Session event "commands.changed". SDK command registration change notification + */ +export interface CommandsChangedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CommandsChangedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "commands.changed". + */ + type: "commands.changed"; +} +/** + * SDK command registration change notification + */ +export interface CommandsChangedData { + /** + * Current list of registered SDK commands + */ + commands: CommandsChangedCommand[]; +} +/** + * A single slash command available in the session, as listed by the `commands.changed` event. + */ +export interface CommandsChangedCommand { + /** + * Optional human-readable command description. + */ + description?: string; + /** + * Slash command name without the leading slash. + */ + name: string; +} +/** + * Session event "capabilities.changed". Session capability change notification + */ +export interface CapabilitiesChangedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CapabilitiesChangedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "capabilities.changed". + */ + type: "capabilities.changed"; +} +/** + * Session capability change notification + */ +export interface CapabilitiesChangedData { + ui?: CapabilitiesChangedUI; +} +/** + * UI capability changes + */ +export interface CapabilitiesChangedUI { + /** + * Whether canvas rendering is now supported + */ + canvases?: boolean; + /** + * Whether elicitation is now supported + */ + elicitation?: boolean; + /** + * Whether MCP Apps (SEP-1865) UI passthrough is now supported + */ + mcpApps?: boolean; +} +/** + * Session event "exit_plan_mode.requested". Plan approval request with plan content and available user actions + */ +export interface ExitPlanModeRequestedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ExitPlanModeRequestedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "exit_plan_mode.requested". + */ + type: "exit_plan_mode.requested"; +} +/** + * Plan approval request with plan content and available user actions + */ +export interface ExitPlanModeRequestedData { + /** + * Available actions the user can take + */ + actions: ExitPlanModeAction[]; + /** + * Full content of the plan file + */ + planContent: string; + recommendedAction: ExitPlanModeAction; + /** + * Unique identifier for this request; used to respond via session.respondToExitPlanMode() + */ + requestId: string; + /** + * Summary of the plan that was created + */ + summary: string; +} +/** + * Session event "exit_plan_mode.completed". Plan mode exit completion with the user's approval decision and optional feedback + */ +export interface ExitPlanModeCompletedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ExitPlanModeCompletedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "exit_plan_mode.completed". + */ + type: "exit_plan_mode.completed"; +} +/** + * Plan mode exit completion with the user's approval decision and optional feedback + */ +export interface ExitPlanModeCompletedData { + /** + * Whether the plan was approved by the user + */ + approved?: boolean; + /** + * Whether edits should be auto-approved without confirmation + */ + autoApproveEdits?: boolean; + /** + * Free-form feedback from the user if they requested changes to the plan + */ + feedback?: string; + /** + * Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request + */ + requestId: string; + selectedAction?: ExitPlanModeAction; +} +/** + * Session event "session.tools_updated". Payload of `session.tools_updated` identifying the model whose resolved tools were updated. + */ +export interface ToolsUpdatedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ToolsUpdatedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.tools_updated". */ type: "session.tools_updated"; } /** - * Schema for the `ToolsUpdatedData` type. + * Payload of `session.tools_updated` identifying the model whose resolved tools were updated. */ export interface ToolsUpdatedData { /** @@ -6409,7 +8978,7 @@ export interface ToolsUpdatedData { model: string; } /** - * Session event "session.background_tasks_changed". + * Session event "session.background_tasks_changed". Empty payload for `session.background_tasks_changed`, indicating background task state changed. */ export interface BackgroundTasksChangedEvent { /** @@ -6439,11 +9008,53 @@ export interface BackgroundTasksChangedEvent { type: "session.background_tasks_changed"; } /** - * Schema for the `BackgroundTasksChangedData` type. + * Empty payload for `session.background_tasks_changed`, indicating background task state changed. */ export interface BackgroundTasksChangedData {} /** - * Session event "session.skills_loaded". + * Session event "factory.run_updated". Ephemeral invalidation signal for a changed factory run. + */ +/** @experimental */ +export interface FactoryRunUpdatedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: FactoryRunUpdatedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "factory.run_updated". + */ + type: "factory.run_updated"; +} +/** + * Ephemeral invalidation signal for a changed factory run. + */ +/** @experimental */ +export interface FactoryRunUpdatedData { + /** + * Monotonic revision now available for the run. + */ + revision: number; + runId: string; +} +/** + * Session event "session.skills_loaded". Payload of `session.skills_loaded` listing resolved skill metadata. */ export interface SkillsLoadedEvent { /** @@ -6473,7 +9084,7 @@ export interface SkillsLoadedEvent { type: "session.skills_loaded"; } /** - * Schema for the `SkillsLoadedData` type. + * Payload of `session.skills_loaded` listing resolved skill metadata. */ export interface SkillsLoadedData { /** @@ -6482,9 +9093,17 @@ export interface SkillsLoadedData { skills: SkillsLoadedSkill[]; } /** - * Schema for the `SkillsLoadedSkill` type. + * A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint. */ export interface SkillsLoadedSkill { + /** + * Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + */ + argumentHint?: string; + /** + * Canonical slash command name used to invoke the skill, without the leading '/' + */ + commandName?: string; /** * Description of what the skill does */ @@ -6508,7 +9127,7 @@ export interface SkillsLoadedSkill { userInvocable: boolean; } /** - * Session event "session.custom_agents_updated". + * Session event "session.custom_agents_updated". Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. */ export interface CustomAgentsUpdatedEvent { /** @@ -6538,7 +9157,7 @@ export interface CustomAgentsUpdatedEvent { type: "session.custom_agents_updated"; } /** - * Schema for the `CustomAgentsUpdatedData` type. + * Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. */ export interface CustomAgentsUpdatedData { /** @@ -6555,7 +9174,7 @@ export interface CustomAgentsUpdatedData { warnings: string[]; } /** - * Schema for the `CustomAgentsUpdatedAgent` type. + * A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override. */ export interface CustomAgentsUpdatedAgent { /** @@ -6592,14 +9211,121 @@ export interface CustomAgentsUpdatedAgent { userInvocable: boolean; } /** - * Session event "session.mcp_servers_loaded". + * Session event "session.mcp_servers_loaded". Payload of `session.mcp_servers_loaded` listing MCP server status summaries. + */ +export interface McpServersLoadedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: McpServersLoadedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.mcp_servers_loaded". + */ + type: "session.mcp_servers_loaded"; +} +/** + * Payload of `session.mcp_servers_loaded` listing MCP server status summaries. + */ +export interface McpServersLoadedData { + /** + * Array of MCP server status summaries + */ + servers: McpServersLoadedServer[]; +} +/** + * A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata. + */ +export interface McpServersLoadedServer { + /** + * Error message if the server failed to connect + */ + error?: string; + /** + * Server name (config key) + */ + name: string; + /** + * Name of the plugin that supplied the effective MCP server config, only when source is plugin + */ + pluginName?: string; + /** + * Version of the plugin that supplied the effective MCP server config, only when source is plugin + */ + pluginVersion?: string; + source?: McpServerSource; + status: McpServerStatus; + transport?: McpServerTransport; +} +/** + * Session event "session.mcp_server_status_changed". Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. + */ +export interface McpServerStatusChangedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: McpServerStatusChangedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.mcp_server_status_changed". + */ + type: "session.mcp_server_status_changed"; +} +/** + * Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. + */ +export interface McpServerStatusChangedData { + /** + * Error message if the server entered a failed state + */ + error?: string; + /** + * Name of the MCP server whose status changed + */ + serverName: string; + status: McpServerStatus; +} +/** + * Session event "mcp.tools.list_changed". Payload identifying the MCP server associated with a list change. */ -export interface McpServersLoadedEvent { +export interface McpToolsListChangedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: McpServersLoadedData; + data: McpListChangedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6617,52 +9343,58 @@ export interface McpServersLoadedEvent { */ timestamp: string; /** - * Type discriminator. Always "session.mcp_servers_loaded". + * Type discriminator. Always "mcp.tools.list_changed". */ - type: "session.mcp_servers_loaded"; + type: "mcp.tools.list_changed"; } /** - * Schema for the `McpServersLoadedData` type. + * Payload identifying the MCP server associated with a list change. */ -export interface McpServersLoadedData { +export interface McpListChangedData { /** - * Array of MCP server status summaries + * Name of the MCP server whose list changed */ - servers: McpServersLoadedServer[]; + serverName: string; } /** - * Schema for the `McpServersLoadedServer` type. + * Session event "mcp.resources.list_changed". Payload identifying the MCP server associated with a list change. */ -export interface McpServersLoadedServer { +export interface McpResourcesListChangedEvent { /** - * Error message if the server failed to connect + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ - error?: string; + agentId?: string; + data: McpListChangedData; /** - * Server name (config key) + * Always true for events that are transient and not persisted to the session event log on disk. */ - name: string; + ephemeral: true; /** - * Name of the plugin that supplied the effective MCP server config, only when source is plugin + * Unique event identifier (UUID v4), generated when the event is emitted */ - pluginName?: string; + id: string; /** - * Version of the plugin that supplied the effective MCP server config, only when source is plugin + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. */ - pluginVersion?: string; - source?: McpServerSource; - status: McpServerStatus; - transport?: McpServerTransport; + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "mcp.resources.list_changed". + */ + type: "mcp.resources.list_changed"; } /** - * Session event "session.mcp_server_status_changed". + * Session event "mcp.prompts.list_changed". Payload identifying the MCP server associated with a list change. */ -export interface McpServerStatusChangedEvent { +export interface McpPromptsListChangedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */ agentId?: string; - data: McpServerStatusChangedData; + data: McpListChangedData; /** * Always true for events that are transient and not persisted to the session event log on disk. */ @@ -6680,26 +9412,12 @@ export interface McpServerStatusChangedEvent { */ timestamp: string; /** - * Type discriminator. Always "session.mcp_server_status_changed". - */ - type: "session.mcp_server_status_changed"; -} -/** - * Schema for the `McpServerStatusChangedData` type. - */ -export interface McpServerStatusChangedData { - /** - * Error message if the server entered a failed state - */ - error?: string; - /** - * Name of the MCP server whose status changed + * Type discriminator. Always "mcp.prompts.list_changed". */ - serverName: string; - status: McpServerStatus; + type: "mcp.prompts.list_changed"; } /** - * Session event "session.extensions_loaded". + * Session event "session.extensions_loaded". Payload of `session.extensions_loaded` listing discovered extensions and their statuses. */ export interface ExtensionsLoadedEvent { /** @@ -6729,7 +9447,7 @@ export interface ExtensionsLoadedEvent { type: "session.extensions_loaded"; } /** - * Schema for the `ExtensionsLoadedData` type. + * Payload of `session.extensions_loaded` listing discovered extensions and their statuses. */ export interface ExtensionsLoadedData { /** @@ -6738,11 +9456,11 @@ export interface ExtensionsLoadedData { extensions: ExtensionsLoadedExtension[]; } /** - * Schema for the `ExtensionsLoadedExtension` type. + * A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status. */ export interface ExtensionsLoadedExtension { /** - * Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper') + * Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') */ id: string; /** @@ -6753,8 +9471,9 @@ export interface ExtensionsLoadedExtension { status: ExtensionsLoadedExtensionStatus; } /** - * Session event "session.canvas.opened". + * Session event "session.canvas.opened". Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. */ +/** @experimental */ export interface CanvasOpenedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. @@ -6783,10 +9502,10 @@ export interface CanvasOpenedEvent { type: "session.canvas.opened"; } /** - * Schema for the `CanvasOpenedData` type. + * Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. */ +/** @experimental */ export interface CanvasOpenedData { - availability: CanvasOpenedAvailability; /** * Provider-local canvas identifier */ @@ -6799,20 +9518,18 @@ export interface CanvasOpenedData { * Owning extension display name, when available */ extensionName?: string; + /** + * Host-local PNG path for the canvas icon, when supplied + */ + icon?: string; /** * Input supplied when the instance was opened */ - input?: { - [k: string]: unknown | undefined; - }; + input?: JsonValue; /** * Stable caller-supplied canvas instance identifier */ instanceId: string; - /** - * Whether this notification represents an idempotent reopen - */ - reopen: boolean; /** * Provider-supplied status text */ @@ -6827,8 +9544,9 @@ export interface CanvasOpenedData { url?: string; } /** - * Session event "session.canvas.registry_changed". + * Session event "session.canvas.registry_changed". Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. */ +/** @experimental */ export interface CanvasRegistryChangedEvent { /** * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. @@ -6857,8 +9575,9 @@ export interface CanvasRegistryChangedEvent { type: "session.canvas.registry_changed"; } /** - * Schema for the `CanvasRegistryChangedData` type. + * Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. */ +/** @experimental */ export interface CanvasRegistryChangedData { /** * Canvas declarations currently available @@ -6866,8 +9585,9 @@ export interface CanvasRegistryChangedData { canvases: CanvasRegistryChangedCanvas[]; } /** - * Schema for the `CanvasRegistryChangedCanvas` type. + * A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions. */ +/** @experimental */ export interface CanvasRegistryChangedCanvas { /** * Actions the agent or host may invoke @@ -6893,16 +9613,19 @@ export interface CanvasRegistryChangedCanvas { * Owning extension display name, when available */ extensionName?: string; + /** + * Host-local PNG path for the canvas icon, when supplied + */ + icon?: string; /** * JSON Schema for canvas open input */ - inputSchema?: { - [k: string]: unknown | undefined; - }; + inputSchema?: JsonValue; } /** - * Schema for the `CanvasRegistryChangedCanvasAction` type. + * A single action within a canvas declaration, with its name, optional description, and optional input schema. */ +/** @experimental */ export interface CanvasRegistryChangedCanvasAction { /** * Action description @@ -6911,14 +9634,255 @@ export interface CanvasRegistryChangedCanvasAction { /** * JSON Schema for action input */ - inputSchema?: { - [k: string]: unknown | undefined; - }; + inputSchema?: JsonValue; /** * Action name */ name: string; } +/** + * Session event "session.canvas.closed". Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. + */ +/** @experimental */ +export interface CanvasClosedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CanvasClosedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.canvas.closed". + */ + type: "session.canvas.closed"; +} +/** + * Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. + */ +/** @experimental */ +export interface CanvasClosedData { + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Stable caller-supplied identifier of the canvas instance that was closed + */ + instanceId: string; +} +/** + * Session event "session.canvas.unavailable". Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. + */ +/** @experimental */ +export interface CanvasUnavailableEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CanvasUnavailableData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.canvas.unavailable". + */ + type: "session.canvas.unavailable"; +} +/** + * Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. + */ +/** @experimental */ +export interface CanvasUnavailableData { + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Stable caller-supplied identifier of the canvas instance whose provider became unavailable + */ + instanceId: string; +} +/** + * Session event "session.canvas.recorded". Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. + */ +/** @experimental */ +export interface CanvasRecordedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CanvasRecordedData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.canvas.recorded". + */ + type: "session.canvas.recorded"; +} +/** + * Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. + */ +/** @experimental */ +export interface CanvasRecordedData { + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Input supplied when the instance was opened + */ + input?: JsonValue; + /** + * Stable caller-supplied canvas instance identifier + */ + instanceId: string; + /** + * Rendered title + */ + title?: string; +} +/** + * Session event "session.canvas.removed". Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. + */ +/** @experimental */ +export interface CanvasRemovedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: CanvasRemovedData; + /** + * When true, the event is transient and not persisted to the session event log on disk + */ + ephemeral?: boolean; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.canvas.removed". + */ + type: "session.canvas.removed"; +} +/** + * Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. + */ +/** @experimental */ +export interface CanvasRemovedData { + /** + * Provider-local canvas identifier + */ + canvasId: string; + /** + * Owning provider identifier + */ + extensionId: string; + /** + * Stable caller-supplied identifier of the canvas instance that was closed + */ + instanceId: string; +} +/** + * Session event "session.extensions.attachments_pushed". Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. + */ +export interface ExtensionsAttachmentsPushedEvent { + /** + * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. + */ + agentId?: string; + data: ExtensionsAttachmentsPushedData; + /** + * Always true for events that are transient and not persisted to the session event log on disk. + */ + ephemeral: true; + /** + * Unique event identifier (UUID v4), generated when the event is emitted + */ + id: string; + /** + * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event. + */ + parentId: string | null; + /** + * ISO 8601 timestamp when the event was created + */ + timestamp: string; + /** + * Type discriminator. Always "session.extensions.attachments_pushed". + */ + type: "session.extensions.attachments_pushed"; +} +/** + * Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. + */ +export interface ExtensionsAttachmentsPushedData { + /** + * Attachments contributed by an extension; the host should surface these as composer pills and forward them via the next session.send call. + */ + attachments: Attachment[]; +} /** * Session event "mcp_app.tool_call_complete". MCP App view called a tool on a connected MCP server (SEP-1865) */ @@ -6957,7 +9921,7 @@ export interface McpAppToolCallCompleteData { * Arguments passed to the tool by the app view, if any */ arguments?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * Wall-clock duration of the underlying tools/call in milliseconds @@ -6968,7 +9932,7 @@ export interface McpAppToolCallCompleteData { * Standard MCP CallToolResult returned by the server. Present whether or not the call set isError. */ result?: { - [k: string]: unknown | undefined; + [k: string]: JsonValue | undefined; }; /** * Name of the MCP server hosting the tool @@ -6998,10 +9962,9 @@ export interface McpAppToolCallCompleteError { */ export interface McpAppToolCallCompleteToolMeta { ui?: McpAppToolCallCompleteToolMetaUI; - [k: string]: unknown | undefined; } /** - * Schema for the `McpAppToolCallCompleteToolMetaUI` type. + * MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. */ export interface McpAppToolCallCompleteToolMetaUI { /** @@ -7012,5 +9975,4 @@ export interface McpAppToolCallCompleteToolMetaUI { * Tool visibility per SEP-1865 (typically a subset of `["model","app"]`) */ visibility?: string[]; - [k: string]: unknown | undefined; } diff --git a/nodejs/src/index.ts b/nodejs/src/index.ts index c044f2b94..f91e351d3 100644 --- a/nodejs/src/index.ts +++ b/nodejs/src/index.ts @@ -12,6 +12,7 @@ export { CopilotClient } from "./client.js"; export { RuntimeConnection } from "./types.js"; export { BuiltInTools, ToolSet } from "./toolSet.js"; export { CopilotSession, type AssistantMessageEvent } from "./session.js"; +export { defineFactory, FactoryResumeError, isFactoryRunTerminal } from "./factory.js"; export { Canvas, CanvasError, @@ -26,8 +27,14 @@ export { export { defineTool, approveAll, + createAttributedPermissionResult, convertMcpCallToolResult, createSessionFsAdapter, + CopilotRequestHandler, + CopilotWebSocketHandler, + CopilotWebSocketCloseStatus, + CopilotWebSocketForwarder, + SessionFsSqliteTransactionFailure, SYSTEM_MESSAGE_SECTIONS, } from "./types.js"; // Re-export the generated session-event types (every *Event interface and @@ -35,28 +42,40 @@ export { // consumers can import them directly from "@github/copilot-sdk" instead of // reaching into the package's internal dist layout. See issue #1156. // -// Three names from this file are also explicitly exported elsewhere in this +// Six names from this file are also explicitly exported elsewhere in this // module — `SessionEvent` (re-exported below from `./types.js`), -// `PermissionRequest` (re-exported below from `./types.js`), and -// `AssistantMessageEvent` (re-exported above from `./session.js`). Per the -// ECMAScript module spec, the explicit named re-exports shadow the names -// arriving via `export type *`, so the hand-authored public API surface for -// those three identifiers is preserved unchanged. +// `PermissionRequest` (re-exported below from `./types.js`), +// `PermissionRequestedData`/`PermissionRequestedEvent` (also re-exported below +// from `./types.js`), `AssistantMessageEvent` (re-exported above from +// `./session.js`), and `JsonValue` (re-exported below from `./factory.js`). +// Per the ECMAScript module spec, the explicit named re-exports +// shadow the names arriving via `export type *`, so the hand-authored public API +// surface for those six identifiers is preserved unchanged. export type * from "./generated/session-events.js"; export type { CommandContext, CommandDefinition, CommandHandler, + CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, + AgentStopHandler, + AgentStopHookInput, + AgentStopHookOutput, + UserPromptTransformedHandler, + UserPromptTransformedHookInput, + UserPromptTransformedHookOutput, CopilotClientMode, CopilotClientOptions, + CopilotExpAssignmentResponse, StdioRuntimeConnection, + InProcessRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, + ChildProcessRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, @@ -65,6 +84,8 @@ export type { ElicitationResult, ElicitationSchema, ElicitationSchemaField, + ExpConfigEntry, + ExpFlagValue, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, @@ -72,23 +93,46 @@ export type { ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, + GitHubMcpToolConfig, + GitHubTelemetryNotification, + GitHubTelemetryEvent, + GitHubTelemetryClientInfo, InfiniteSessionConfig, LargeToolOutputConfig, + MemoryConfiguration, UiInputOptions, + FactoryLimits, + FactoryMeta, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, + BearerTokenProvider, MessageOptions, + ManagedSettings, + ManagedSettingsPermissions, ModelBilling, + ModelBillingTokenPrices, + ModelBillingTokenPricesLongContext, + CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, + NamedProviderConfig, PermissionHandler, PermissionRequest, + PermissionRequestedData, + PermissionRequestedEvent, PermissionRequestResult, + AttributedPermissionResult, + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, ProviderConfig, + ProviderModelConfig, + ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, @@ -105,6 +149,7 @@ export type { SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, + SessionHooks, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, @@ -120,6 +165,9 @@ export type { SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, + SessionFsSqliteStatement, + SessionFsSqliteTransactionErrorClass, + CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, @@ -131,9 +179,34 @@ export type { Tool, ToolHandler, ToolInvocation, + CurrentToolMetadata, ToolTelemetry, ToolResultObject, + ToolSearchConfig, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js"; +export type { + RunOptions, + ResumeOptions, + FactoryResumeErrorCode, + SessionFactoryApi, + FactoryAgentOptions, + FactoryContext, + FactoryDefinition, + FactoryHandle, + FactoryJsonSchema, + JsonValue, + FactoryPipelineStage, + FactoryStepOptions, + FactoryRunResult, + FactoryRunStatus, + FactoryRunSummary, + FactoryRunDetail, + FactoryProgressPage, + FactoryProgressLine, + FactoryPhaseObservation, + FactoryPhaseStatus, + FactoryAgentSummary, +} from "./factory.js"; diff --git a/nodejs/src/session.ts b/nodejs/src/session.ts index b7b9c217a..48e41483b 100644 --- a/nodejs/src/session.ts +++ b/nodejs/src/session.ts @@ -7,13 +7,22 @@ * @module session */ +import { AsyncLocalStorage } from "node:async_hooks"; import type { MessageConnection } from "vscode-jsonrpc/node.js"; import { ConnectionError, ErrorCodes, ResponseError } from "vscode-jsonrpc/node.js"; import { createSessionRpc } from "./generated/rpc.js"; -import type { ClientSessionApiHandlers, CanvasActionInvokeResult } from "./generated/rpc.js"; +import type { + ClientSessionApiHandlers, + CanvasActionInvokeResult, + CurrentToolMetadata, + McpOauthPendingRequestResponse, + FactoryLogLine, + FactoryRunResult as WireFactoryRunResult, +} from "./generated/rpc.js"; import { type Canvas, CanvasError } from "./canvas.js"; import type { OpenCanvasInstance } from "./generated/rpc.js"; import { getTraceContext } from "./telemetry.js"; +import { isAttributedPermissionResult } from "./types.js"; import type { CommandHandler, AutoModeSwitchHandler, @@ -26,10 +35,15 @@ import type { ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, + BearerTokenProvider, UiInputOptions, MessageOptions, + McpAuthHandler, + McpAuthRequest, PermissionHandler, PermissionRequest, + PermissionRequestResult, + ContextTier, ReasoningEffort, ReasoningSummary, ModelCapabilitiesOverride, @@ -51,6 +65,55 @@ import type { UserInputRequest, UserInputResponse, } from "./types.js"; +import { + FACTORY_AGENT_OPTION_KEYS, + getFactoryDefinition, + FactoryResumeError, + isFactoryRunTerminal, + type FactoryResumeErrorCode, + type FactoryRunResult, + type FactoryAgentOptions, + type RunOptions, + type SessionFactoryApi, + type FactoryContext, + type FactoryHandle, + type JsonValue, + type FactoryStepOptions, +} from "./factory.js"; + +function isFactoryResumeErrorCode(value: unknown): value is FactoryResumeErrorCode { + return ( + value === "not_found" || + value === "non_resumable" || + value === "already_active" || + value === "factory_already_running" || + value === "factory_limits_invalid" || + value === "factory_session_disposed" || + value === "factory_storage_unavailable" || + value === "factory_storage_corrupt" + ); +} + +function copyDefinedFactoryAgentOption( + source: FactoryAgentOptions, + target: FactoryAgentOptions, + key: TKey +): void { + const value = source[key]; + if (value !== undefined) { + target[key] = value; + } +} + +const factoryExecutionStore = new AsyncLocalStorage<{ active: boolean }>(); + +function throwIfFactoryExecutionIsActive(): void { + if (factoryExecutionStore.getStore()?.active) { + throw new Error( + "factory.run and factory.resume are not allowed while a factory body is running on this call path." + ); + } +} /** * Convert a raw hook input received over the wire into its public-facing shape. @@ -65,9 +128,18 @@ function deserializeHookInput(raw: unknown): unknown { ) { return raw; } - const obj = raw as Record & { timestamp: number; cwd?: string }; - const { cwd, ...rest } = obj; - return { ...rest, timestamp: new Date(obj.timestamp), workingDirectory: cwd }; + const obj = raw as Record & { + timestamp: number; + cwd?: string; + stop_hook_active?: boolean; + }; + const { cwd, stop_hook_active, ...rest } = obj; + return { + ...rest, + timestamp: new Date(obj.timestamp), + workingDirectory: cwd, + ...(stop_hook_active === undefined ? {} : { stopHookActive: stop_hook_active }), + }; } function isOpenCanvasInstance(value: unknown): value is OpenCanvasInstance { @@ -81,15 +153,236 @@ function isOpenCanvasInstance(value: unknown): value is OpenCanvasInstance { typeof instance.extensionId === "string" && instance.extensionId.length > 0 && typeof instance.canvasId === "string" && - instance.canvasId.length > 0 && - typeof instance.reopen === "boolean" && - (instance.availability === "ready" || instance.availability === "stale") + instance.canvasId.length > 0 + ); +} + +const FACTORY_LOG_FLUSH_DELAY_MS = 10; +const MAX_FACTORY_FANOUT_ITEMS = 4096; + +function assertFactoryFanoutSize(kind: "parallel" | "pipeline", size: number): void { + if (size > MAX_FACTORY_FANOUT_ITEMS) { + throw new Error( + `${kind}() accepts at most ${MAX_FACTORY_FANOUT_ITEMS} items; got ${size}.` + ); + } +} + +async function runFactoryParallel( + thunks: Array<() => Promise | TResult> +): Promise> { + if (!Array.isArray(thunks)) { + throw new Error( + "parallel() expects an array of functions, not promises. Wrap each call: () => agent(...)" + ); + } + assertFactoryFanoutSize("parallel", thunks.length); + if (thunks.some((thunk) => typeof thunk !== "function")) { + throw new Error( + "parallel() expects an array of functions, not promises. Wrap each call: () => agent(...)" + ); + } + return Promise.all( + thunks.map((thunk) => + Promise.resolve() + .then(() => thunk()) + .catch((error) => { + // Cancellation and hard runtime failures must propagate out + // of the combinator rather than be mapped to a successful + // `null`; otherwise an aborted run, or one that hit a + // resource ceiling or durable-state failure, could be + // reported as completed. An ordinary subagent failure never + // rejects — it already resolves `null`. + if (isFactoryFatalError(error)) { + throw error; + } + return null; + }) + ) + ); +} + +async function runFactoryPipeline( + items: unknown[], + ...stages: Array< + (previous: unknown, item: unknown, index: number) => Promise | unknown + > +): Promise { + if (!Array.isArray(items)) { + throw new Error("pipeline(items, ...stages): items must be an array"); + } + assertFactoryFanoutSize("pipeline", items.length); + return Promise.all( + items.map(async (item, index) => { + let previous = item; + for (const stage of stages) { + try { + previous = await stage(previous, item, index); + } catch (error) { + // Propagate cancellation and hard runtime failures instead + // of mapping them to `null`, so an aborted stage — or one + // that hit a resource ceiling or durable-state failure — + // does not let the run report success. + if (isFactoryFatalError(error)) { + throw error; + } + return null; + } + } + return previous; + }) + ); +} + +class FactoryProgressBuffer { + private nextSeq = 0; + private pending: FactoryLogLine[] = []; + private flushTimer?: ReturnType; + private flushTail: Promise = Promise.resolve(); + private flushError: unknown; + private flushFailed = false; + private closed = false; + + constructor(private readonly send: (lines: FactoryLogLine[]) => Promise) {} + + enqueue(kind: FactoryLogLine["kind"], text: string): void { + if (this.closed) { + throw new Error("Cannot log after the factory run has settled"); + } + + this.pending.push({ seq: this.nextSeq++, kind, text }); + this.scheduleFlush(); + } + + async flush(): Promise { + this.clearFlushTimer(); + const lines = this.pending.splice(0); + if (lines.length > 0) { + this.flushTail = this.flushTail.then(async () => { + try { + await this.send(lines); + } catch (error) { + if (!this.flushFailed) { + this.flushFailed = true; + this.flushError = error; + } + } + }); + } + await this.flushTail; + if (this.flushFailed) { + throw this.flushError; + } + } + + async close(): Promise { + this.closed = true; + this.clearFlushTimer(); + const lines = this.pending.splice(0); + await this.flushTail; + if (this.flushFailed) { + console.warn( + "Ignoring a background factory progress flush failure after the factory body settled", + this.flushError + ); + } + if (lines.length > 0) { + try { + await this.send(lines); + } catch (error) { + console.warn( + "Failed to flush final factory progress after the factory body settled", + error + ); + } + } + } + + private scheduleFlush(): void { + if (this.flushTimer !== undefined) { + return; + } + this.flushTimer = setTimeout(() => { + this.flushTimer = undefined; + void this.flush().catch(() => {}); + }, FACTORY_LOG_FLUSH_DELAY_MS); + this.flushTimer.unref?.(); + } + + private clearFlushTimer(): void { + if (this.flushTimer !== undefined) { + clearTimeout(this.flushTimer); + this.flushTimer = undefined; + } + } +} + +async function awaitFactoryOperation( + operation: () => Promise, + signal: AbortSignal +): Promise { + // The operation is a thunk so an already-aborted run never dispatches the + // RPC at all, rather than sending it and rejecting locally afterwards. + let rejectAbort: ((reason?: unknown) => void) | undefined; + const abortPromise = new Promise((_resolve, reject) => { + rejectAbort = reject; + }); + const onAbort = () => + rejectAbort?.(signal.reason ?? new DOMException("Factory run was aborted", "AbortError")); + // Register before the abort check and before dispatching, so an abort can + // neither be missed by a not-yet-attached listener nor start work on an + // already-cancelled run. + signal.addEventListener("abort", onAbort, { once: true }); + try { + throwIfFactoryAborted(signal); + return await Promise.race([operation(), abortPromise]); + } finally { + signal.removeEventListener("abort", onAbort); + } +} + +function throwIfFactoryAborted(signal: AbortSignal): void { + if (signal.aborted) { + throw signal.reason ?? new DOMException("Factory run was aborted", "AbortError"); + } +} + +/** + * Whether an error represents factory run cancellation (an `AbortError`-shaped + * rejection from {@link awaitFactoryOperation}). Cancellation must bubble out of + * `parallel`/`pipeline` rather than being flattened into a `null` result. + */ +function isFactoryAbortError(error: unknown): boolean { + return ( + typeof error === "object" && + error !== null && + "name" in error && + (error as { name?: unknown }).name === "AbortError" + ); +} + +/** + * Errors a factory combinator must never swallow into a `null` item. + * + * Cooperative cancellation aborts the run, and a rejected RPC is a hard + * runtime failure — a reached limit, a durable-state failure, or a dropped + * transport — that must terminate the run rather than be reported as a + * successfully-`null` item. An ordinary subagent failure does not reject; the + * runtime already resolves it as `null`. + */ +function isFactoryFatalError(error: unknown): boolean { + return ( + isFactoryAbortError(error) || + error instanceof ResponseError || + error instanceof ConnectionError ); } /** Assistant message event - the final response from the assistant. */ export type AssistantMessageEvent = Extract; +const TOOL_SEARCH_TOOL_NAME = "tool_search_tool"; + /** * Represents a single conversation session with the Copilot CLI. * @@ -115,14 +408,24 @@ export type AssistantMessageEvent = Extract = new Set(); private typedEventHandlers: Map void>> = new Map(); private toolHandlers: Map = new Map(); private canvases: Map = new Map(); + private bearerTokenProviders: Map = new Map(); private commandHandlers: Map = new Map(); + private factories = new Map>(); + private factoryAbortControllers = new Map>(); private permissionHandler?: PermissionHandler; + private mcpAuthHandler?: McpAuthHandler; private userInputHandler?: UserInputHandler; private elicitationHandler?: ElicitationHandler; private exitPlanModeHandler?: ExitPlanModeHandler; @@ -131,12 +434,175 @@ export class CopilotSession { private transformCallbacks?: Map; private _rpc: ReturnType | null = null; private traceContextProvider?: TraceContextProvider; + private readonly managedSettingsEnabled: boolean; private _capabilities: SessionCapabilities = {}; private openCanvasInstances: OpenCanvasInstance[] = []; + private disconnected = false; /** @internal Client session API handlers, populated by CopilotClient during create/resume. */ clientSessionApis: ClientSessionApiHandlers = {}; + /** + * Friendly factory API for running registered factories by name or handle. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ + readonly factory: SessionFactoryApi = { + run: (async ( + nameOrHandle: string | FactoryHandle, + options?: RunOptions + ): Promise => { + throwIfFactoryExecutionIsActive(); + const name = + typeof nameOrHandle === "string" + ? nameOrHandle + : getFactoryDefinition(nameOrHandle).meta.name; + if (options?.resumeFromRunId !== undefined) { + return this.factory.resume(options.resumeFromRunId, { + limits: options.limits, + }); + } + const envelope = await this.rpc.factory.run({ + name, + args: options?.args === undefined ? {} : options.args, + options: { + limits: options?.limits, + }, + }); + + return this.settleFactoryRun(envelope); + }) as SessionFactoryApi["run"], + resume: (async (runId: string, options?: Parameters[1]) => { + throwIfFactoryExecutionIsActive(); + let response; + try { + response = await this.rpc.factory.resume({ + runId, + limits: options?.limits, + }); + } catch (error) { + if ( + error instanceof ResponseError && + typeof error.data === "object" && + error.data !== null + ) { + const code = (error.data as { code?: unknown }).code; + if (isFactoryResumeErrorCode(code)) { + throw new FactoryResumeError(code, error.message); + } + } + throw error; + } + return this.settleFactoryRun(response.run); + }) as SessionFactoryApi["resume"], + getRun: async (runId) => this.rpc.factory.getRun({ runId }), + waitForRun: (runId, options) => this.waitForFactoryRun(runId, options?.signal), + listRuns: async () => (await this.rpc.factory.listRuns({})).runs, + getRunDetail: (runId) => this.rpc.factory.getRunDetail({ runId }), + getRunProgress: (runId, options = {}) => + this.rpc.factory.getRunProgress({ runId, ...options }), + cancel: async (runId) => this.rpc.factory.cancel({ runId }), + }; + + /** + * Resolve a start/resume envelope into the terminal envelope callers expect. + * + * The CLI may answer `session.factory.run` and `session.factory.resume` + * before the run settles, so a non-terminal envelope is followed by a wait + * on the run's terminal state. + */ + private settleFactoryRun(envelope: WireFactoryRunResult): Promise { + if (isFactoryRunTerminal(envelope.status)) { + return Promise.resolve(envelope); + } + return this.waitForFactoryRun(envelope.runId); + } + + /** + * Resolve when a factory run reaches a terminal status. + * + * The subscription is installed *before* the first read so a transition + * landing between the two cannot be missed, and re-reads are serialized so + * overlapping invalidation events cannot interleave — the run's revision + * advances once per operation, so a burst of events is common and must + * collapse into a single in-flight read. A bounded periodic re-read keeps a + * dropped invalidation from leaving the wait pending forever. + */ + private waitForFactoryRun(runId: string, signal?: AbortSignal): Promise { + const abortError = (): unknown => + signal?.reason ?? new DOMException("Factory run wait was aborted", "AbortError"); + if (signal?.aborted === true) { + return Promise.reject(abortError()); + } + + return new Promise((resolve, reject) => { + let settled = false; + let reading = false; + let rereadRequested = false; + let pollHandle: ReturnType | undefined; + let unsubscribe: (() => void) | undefined; + let onAbort: (() => void) | undefined; + + const finish = (complete: () => void): void => { + if (settled) { + return; + } + settled = true; + if (pollHandle !== undefined) { + clearInterval(pollHandle); + } + unsubscribe?.(); + if (onAbort !== undefined) { + signal?.removeEventListener("abort", onAbort); + } + complete(); + }; + + const read = async (): Promise => { + if (settled) { + return; + } + if (reading) { + rereadRequested = true; + return; + } + reading = true; + try { + do { + rereadRequested = false; + const envelope = await this.rpc.factory.getRun({ runId }); + if (isFactoryRunTerminal(envelope.status)) { + finish(() => resolve(envelope)); + return; + } + } while (rereadRequested && !settled); + } catch (error) { + finish(() => reject(error)); + } finally { + reading = false; + } + }; + + if (signal !== undefined) { + onAbort = (): void => finish(() => reject(abortError())); + signal.addEventListener("abort", onAbort, { once: true }); + } + + unsubscribe = this.on("factory.run_updated", (event) => { + if (event.data.runId === runId) { + void read(); + } + }); + + pollHandle = setInterval(() => void read(), 5_000); + // The re-read is a safety net, not work the process owes anyone: an + // outstanding wait must never keep Node alive on its own. + pollHandle.unref?.(); + void read(); + }); + } + /** * Creates a new CopilotSession instance. * @@ -150,9 +616,12 @@ export class CopilotSession { public readonly sessionId: string, private connection: MessageConnection, private _workspacePath?: string, - traceContextProvider?: TraceContextProvider + traceContextProvider?: TraceContextProvider, + options?: { mcpAuthHandler?: McpAuthHandler; managedSettingsEnabled?: boolean } ) { this.traceContextProvider = traceContextProvider; + this.mcpAuthHandler = options?.mcpAuthHandler; + this.managedSettingsEnabled = options?.managedSettingsEnabled === true; } /** @@ -276,11 +745,10 @@ export class CopilotSession { typeof optionsOrPrompt === "string" ? { prompt: optionsOrPrompt } : optionsOrPrompt; const effectiveTimeout = timeout ?? 60_000; - let resolveIdle: () => void; - let rejectWithError: (error: Error) => void; - const idlePromise = new Promise((resolve, reject) => { - resolveIdle = resolve; - rejectWithError = reject; + type SessionOutcome = { kind: "idle" } | { kind: "error"; error: Error }; + let resolveOutcome: (outcome: SessionOutcome) => void; + const outcomePromise = new Promise((resolve) => { + resolveOutcome = resolve; }); let lastAssistantMessage: AssistantMessageEvent | undefined; @@ -291,11 +759,11 @@ export class CopilotSession { if (event.type === "assistant.message") { lastAssistantMessage = event; } else if (event.type === "session.idle") { - resolveIdle(); + resolveOutcome({ kind: "idle" }); } else if (event.type === "session.error") { const error = new Error(event.data.message); error.stack = event.data.stack; - rejectWithError(error); + resolveOutcome({ kind: "error", error }); } }); @@ -314,7 +782,10 @@ export class CopilotSession { effectiveTimeout ); }); - await Promise.race([idlePromise, timeoutPromise]); + const outcome = await Promise.race([outcomePromise, timeoutPromise]); + if (outcome.kind === "error") { + throw outcome.error; + } return lastAssistantMessage; } finally { @@ -325,6 +796,29 @@ export class CopilotSession { } } + /** @internal */ + _markDisconnected(): void { + this.disconnected = true; + this.eventHandlers.clear(); + this.typedEventHandlers.clear(); + this.toolHandlers.clear(); + this.permissionHandler = undefined; + this.userInputHandler = undefined; + this.elicitationHandler = undefined; + this.exitPlanModeHandler = undefined; + this.autoModeSwitchHandler = undefined; + this.commandHandlers.clear(); + this.canvases.clear(); + this.factories.clear(); + for (const controllersForRun of this.factoryAbortControllers.values()) { + for (const controller of controllersForRun.values()) { + controller.abort(); + } + } + this.factoryAbortControllers.clear(); + this.transformCallbacks?.clear(); + } + /** * Subscribes to events from this session. * @@ -442,6 +936,9 @@ export class CopilotSession { * @internal */ private _handleBroadcastEvent(event: SessionEvent): void { + if (this.disconnected) { + return; + } if (event.type === "external_tool.requested") { const { requestId, toolName } = event.data as { requestId: string; @@ -478,6 +975,19 @@ export class CopilotSession { if (this.permissionHandler) { void this._executePermissionAndRespond(requestId, permissionRequest); } + } else if (event.type === "mcp.oauth_required") { + const data = event.data as McpAuthRequest | undefined; + if (!data?.requestId) { + return; + } + if (!this.mcpAuthHandler) { + console.warn( + "Received MCP OAuth request without a registered MCP auth handler. " + + `SessionId=${this.sessionId}, RequestId=${data.requestId}` + ); + return; + } + void this._executeMcpAuthAndRespond(data); } else if (event.type === "command.execute") { const { requestId, commandName, command, args } = event.data as { requestId: string; @@ -506,6 +1016,8 @@ export class CopilotSession { this._capabilities = { ...this._capabilities, ...event.data }; } else if (event.type === "session.canvas.opened") { this.upsertOpenCanvasFromEvent(event.data); + } else if (event.type === "session.canvas.closed") { + this.removeOpenCanvasFromEvent(event.data); } } @@ -517,6 +1029,25 @@ export class CopilotSession { this.upsertOpenCanvas(data); } + private removeOpenCanvasFromEvent(data: unknown): void { + if ( + !data || + typeof data !== "object" || + typeof (data as { instanceId?: unknown }).instanceId !== "string" || + (data as { instanceId: string }).instanceId.length === 0 + ) { + console.warn("failed to deserialize session.canvas.closed payload"); + return; + } + this.removeOpenCanvas((data as { instanceId: string }).instanceId); + } + + private removeOpenCanvas(instanceId: string): void { + this.openCanvasInstances = this.openCanvasInstances.filter( + (open) => open.instanceId !== instanceId + ); + } + private upsertOpenCanvas(instance: OpenCanvasInstance): void { const index = this.openCanvasInstances.findIndex( (open) => open.instanceId === instance.instanceId @@ -542,11 +1073,26 @@ export class CopilotSession { tracestate?: string ): Promise { try { + // The built-in tool-search tool receives a snapshot of the session's + // currently initialized tools so an override can filter the live + // catalog without issuing its own RPC. Fetch it only for that tool + // to avoid a round-trip on every tool call; a failed fetch simply + // leaves the snapshot undefined rather than failing the tool. + let availableTools: CurrentToolMetadata[] | undefined; + if (toolName === TOOL_SEARCH_TOOL_NAME) { + try { + const metadata = await this.rpc.tools.getCurrentMetadata(); + availableTools = metadata.tools ?? undefined; + } catch { + availableTools = undefined; + } + } const rawResult = await handler(args, { sessionId: this.sessionId, toolCallId, toolName, arguments: args, + availableTools, traceparent, tracestate, }); @@ -560,8 +1106,14 @@ export class CopilotSession { } else { result = JSON.stringify(rawResult); } + if (this.disconnected) { + return; + } await this.rpc.tools.handlePendingToolCall({ requestId, result }); } catch (error) { + if (this.disconnected) { + return; + } const message = error instanceof Error ? error.message : String(error); try { await this.rpc.tools.handlePendingToolCall({ requestId, error: message }); @@ -583,14 +1135,35 @@ export class CopilotSession { permissionRequest: PermissionRequest ): Promise { try { - const result = await this.permissionHandler!(permissionRequest, { + const handlerResult = await this.permissionHandler!(permissionRequest, { sessionId: this.sessionId, + managedSettingsEnabled: this.managedSettingsEnabled, }); + const isAttributed = isAttributedPermissionResult(handlerResult); + const result: PermissionRequestResult = isAttributed + ? handlerResult.result + : handlerResult; + const decisionContext = isAttributed ? handlerResult.decisionContext : undefined; if (result.kind === "no-result") { return; } - await this.rpc.permissions.handlePendingPermissionRequest({ requestId, result }); - } catch (_error) { + if (this.disconnected) { + return; + } + await this.rpc.permissions.handlePendingPermissionRequest( + decisionContext === undefined + ? { requestId, result } + : { requestId, result, decisionContext } + ); + } catch (error) { + if (this.disconnected) { + return; + } + console.error("Permission handler or response delivery failed", { + sessionId: this.sessionId, + requestId, + error, + }); try { await this.rpc.permissions.handlePendingPermissionRequest({ requestId, @@ -607,6 +1180,35 @@ export class CopilotSession { } } + /** + * Executes an MCP auth handler and sends the result back via RPC. + * @internal + */ + private async _executeMcpAuthAndRespond(request: McpAuthRequest): Promise { + try { + const result = await this.mcpAuthHandler!(request, { sessionId: this.sessionId }); + const response: McpOauthPendingRequestResponse = + result && "accessToken" in result + ? { kind: "token", ...result } + : { kind: "cancelled" }; + await this.rpc.mcp.oauth.handlePendingRequest({ + requestId: request.requestId, + result: response, + }); + } catch (_error) { + try { + await this.rpc.mcp.oauth.handlePendingRequest({ + requestId: request.requestId, + result: { kind: "cancelled" }, + }); + } catch (rpcError) { + if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) { + throw rpcError; + } + } + } + } + /** * Executes a command handler and sends the result back via RPC. * @internal @@ -634,8 +1236,14 @@ export class CopilotSession { try { await handler({ sessionId: this.sessionId, command, commandName, args }); + if (this.disconnected) { + return; + } await this.rpc.commands.handlePendingCommand({ requestId }); } catch (error) { + if (this.disconnected) { + return; + } const message = error instanceof Error ? error.message : String(error); try { await this.rpc.commands.handlePendingCommand({ requestId, error: message }); @@ -737,6 +1345,225 @@ export class CopilotSession { }; } + /** + * Registers factory closures and reverse-RPC handlers for this session. + * + * @param factories - Factory handles declared by the joining extension. + * @internal Called by the SDK when an extension joins a session. + */ + registerFactories(factories?: FactoryHandle[]): void { + this.factories.clear(); + if (!factories || factories.length === 0) { + delete this.clientSessionApis.factory; + return; + } + + for (const handle of factories) { + const definition = getFactoryDefinition(handle); + if (this.factories.has(definition.meta.name)) { + throw new Error( + `Duplicate factory name "${definition.meta.name}". Factory names must be unique within a joinSession call.` + ); + } + this.factories.set(definition.meta.name, definition); + } + + const self = this; + this.clientSessionApis.factory = { + async execute(params) { + const definition = self.factories.get(params.name); + if (!definition) { + const message = `No factory registered with name "${params.name}"`; + throw new ResponseError(ErrorCodes.InvalidParams, message, { + code: "factory_not_found", + name: params.name, + }); + } + + const controller = new AbortController(); + // Keyed by execution token as well as run ID so overlapping + // attempts for one run stay individually addressable. + let controllersForRun = self.factoryAbortControllers.get(params.runId); + if (controllersForRun === undefined) { + controllersForRun = new Map(); + self.factoryAbortControllers.set(params.runId, controllersForRun); + } + controllersForRun.set(params.executionToken, controller); + const progress = new FactoryProgressBuffer(async (lines) => { + await self.rpc.factory.log({ + runId: params.runId, + executionToken: params.executionToken, + lines, + }); + }); + try { + const context: FactoryContext = { + runId: params.runId, + args: params.args, + session: self, + signal: controller.signal, + phase: (title: string) => { + throwIfFactoryAborted(controller.signal); + progress.enqueue("phase", title); + }, + log: (message: string) => { + throwIfFactoryAborted(controller.signal); + progress.enqueue("log", message); + }, + agent: async (prompt, options = {}) => { + await progress.flush(); + const opts: FactoryAgentOptions = {}; + for (const key of FACTORY_AGENT_OPTION_KEYS) { + copyDefinedFactoryAgentOption(options, opts, key); + } + const response = await awaitFactoryOperation( + () => + self.rpc.factory.agent({ + factoryRunId: params.runId, + executionToken: params.executionToken, + prompt, + opts, + }), + controller.signal + ); + return response.result ?? null; + }, + step: async ( + key: string, + producer: () => Promise | JsonValue, + options: FactoryStepOptions = {} + ): Promise => { + await progress.flush(); + if (options.volatile) { + // The flush above is an await point, so an abort can land + // between entering step() and running the producer. The + // journaled branch is covered by awaitFactoryOperation; + // this one has to check for itself, or a cancelled run + // would still start new extension work. + throwIfFactoryAborted(controller.signal); + return producer(); + } + const cached = await awaitFactoryOperation( + () => + self.rpc.factory.journal.get({ + runId: params.runId, + executionToken: params.executionToken, + key, + }), + controller.signal + ); + if (cached.hit) { + if (cached.resultJson === undefined) { + throw new Error( + `step("${key}") journal returned a hit without a result` + ); + } + assertFactoryStepResult(cached.resultJson, key); + return cached.resultJson; + } + + // Producers are best-effort at-least-once across crashes or + // concurrent callers, so authors must make side effects idempotent. + const result = await producer(); + assertFactoryStepResult(result, key); + await awaitFactoryOperation( + () => + self.rpc.factory.journal.put({ + runId: params.runId, + executionToken: params.executionToken, + key, + resultJson: result, + }), + controller.signal + ); + return result; + }, + parallel: runFactoryParallel, + pipeline: runFactoryPipeline, + factory: async () => { + throw new Error("nested factories are not supported"); + }, + }; + const execution = { active: true }; + const result = await factoryExecutionStore.run(execution, async () => { + try { + return await definition.run(context); + } finally { + execution.active = false; + } + }); + if (result === undefined) { + return {}; + } + assertFactoryResult(result); + return { result }; + } finally { + try { + await progress.close(); + } finally { + const controllersForRun = self.factoryAbortControllers.get(params.runId); + if (controllersForRun?.get(params.executionToken) === controller) { + controllersForRun.delete(params.executionToken); + if (controllersForRun.size === 0) { + self.factoryAbortControllers.delete(params.runId); + } + } + } + } + }, + async abort(params) { + const controllersForRun = self.factoryAbortControllers.get(params.runId); + if (controllersForRun !== undefined) { + const reason = new DOMException("Factory run was aborted", "AbortError"); + for (const controller of controllersForRun.values()) { + controller.abort(reason); + } + } + return {}; + }, + }; + } + + /** + * Registers per-provider {@link BearerTokenProvider} callbacks for BYOK providers + * configured with managed-identity / on-demand bearer-token auth. + * + * The runtime never receives the callback itself; the SDK strips it from the + * provider config and instead sends `hasBearerTokenProvider: true`. When the + * runtime needs a token it issues a session-scoped `providerToken.getToken` + * request, which this handler routes to the matching per-provider callback. + * + * @param providers - Map of provider name → callback, or undefined/empty to clear. + * @internal This method is called internally when creating/resuming a session. + */ + registerBearerTokenProviders(providers?: Map): void { + this.bearerTokenProviders.clear(); + if (!providers || providers.size === 0) { + delete this.clientSessionApis.providerToken; + return; + } + for (const [name, callback] of providers) { + this.bearerTokenProviders.set(name, callback); + } + + const self = this; + this.clientSessionApis.providerToken = { + async getToken(params) { + const callback = self.bearerTokenProviders.get(params.providerName); + if (!callback) { + throw new Error( + `No bearer-token provider registered for provider "${params.providerName}"` + ); + } + const token = await callback({ + providerName: params.providerName, + sessionId: params.sessionId, + }); + return { token }; + }, + }; + } + /** * Registers command handlers for this session. * @@ -850,8 +1677,8 @@ export class CopilotSession { /** * Snapshot of canvas instances currently known to be open for this session. * Populated from the `session.resume` response and live `session.canvas.opened` - * events. Returns a defensive copy — mutating the returned array has no effect - * on the session. + * and `session.canvas.closed` events. Returns a defensive copy — mutating the + * returned array has no effect on the session. */ get openCanvases(): OpenCanvasInstance[] { return [...this.openCanvasInstances]; @@ -1080,9 +1907,11 @@ export class CopilotSession { postToolUse: this.hooks.onPostToolUse as GenericHandler | undefined, postToolUseFailure: this.hooks.onPostToolUseFailure as GenericHandler | undefined, userPromptSubmitted: this.hooks.onUserPromptSubmitted as GenericHandler | undefined, + userPromptTransformed: this.hooks.onUserPromptTransformed as GenericHandler | undefined, sessionStart: this.hooks.onSessionStart as GenericHandler | undefined, sessionEnd: this.hooks.onSessionEnd as GenericHandler | undefined, errorOccurred: this.hooks.onErrorOccurred as GenericHandler | undefined, + agentStop: this.hooks.onAgentStop as GenericHandler | undefined, }; const handler = handlerMap[hookType]; @@ -1148,17 +1977,13 @@ export class CopilotSession { * ``` */ async disconnect(): Promise { + if (this.disconnected) { + return; + } await this.connection.sendRequest("session.destroy", { sessionId: this.sessionId, }); - this.eventHandlers.clear(); - this.typedEventHandlers.clear(); - this.toolHandlers.clear(); - this.permissionHandler = undefined; - this.userInputHandler = undefined; - this.elicitationHandler = undefined; - this.exitPlanModeHandler = undefined; - this.autoModeSwitchHandler = undefined; + this._markDisconnected(); } /** Enables `await using session = ...` syntax for automatic cleanup. */ @@ -1201,7 +2026,7 @@ export class CopilotSession { * * @example * ```typescript - * await session.setModel("gpt-4.1"); + * await session.setModel("gpt-5.4"); * await session.setModel("claude-sonnet-4.6", { reasoningEffort: "high" }); * ``` */ @@ -1210,6 +2035,7 @@ export class CopilotSession { options?: { reasoningEffort?: ReasoningEffort; reasoningSummary?: ReasoningSummary; + contextTier?: ContextTier; modelCapabilities?: ModelCapabilitiesOverride; } ): Promise { @@ -1278,3 +2104,201 @@ function toCanvasRpcError(error: unknown): ResponseError { const message = error instanceof Error ? error.message : String(error); return new ResponseError(ErrorCodes.InternalError, message, { code, message }); } + +type FactoryResultValidationCategory = + | "unsupported_type" + | "non_finite_number" + | "negative_zero" + | "cyclic_value" + | "nested_undefined" + | "unsupported_object"; + +interface StrictJsonValidationContext { + code: "factory_result_not_json" | "factory_step_not_json"; + label: string; + allowTopLevelUndefined: boolean; +} + +function strictJsonValidationError( + context: StrictJsonValidationContext, + category: FactoryResultValidationCategory, + message: string, + path: string +): ResponseError<{ code: string; category: FactoryResultValidationCategory; path: string }> { + return new ResponseError(ErrorCodes.InternalError, message, { + code: context.code, + category, + path, + }); +} + +function assertStrictJson( + value: unknown, + context: StrictJsonValidationContext +): asserts value is JsonValue | undefined { + const ancestors = new Set(); + + const visit = (current: unknown, path: string, allowUndefined: boolean): void => { + if (current === undefined) { + if (allowUndefined) { + return; + } + throw strictJsonValidationError( + context, + "nested_undefined", + `${context.label} contains nested undefined at ${path}`, + path + ); + } + if (current === null || typeof current === "boolean" || typeof current === "string") { + return; + } + if (typeof current === "number") { + if (!Number.isFinite(current)) { + throw strictJsonValidationError( + context, + "non_finite_number", + `${context.label} contains a non-finite number at ${path}`, + path + ); + } + // JSON serializes -0 as "0", so a journaled -0 would come back as 0 + // after a resume and break the lossless replay guarantee. + if (Object.is(current, -0)) { + throw strictJsonValidationError( + context, + "negative_zero", + `${context.label} contains negative zero at ${path}; normalize it to 0`, + path + ); + } + return; + } + if ( + typeof current === "function" || + typeof current === "symbol" || + typeof current === "bigint" + ) { + throw strictJsonValidationError( + context, + "unsupported_type", + `${context.label} contains a function, symbol, or BigInt at ${path}`, + path + ); + } + if (typeof current !== "object") { + throw strictJsonValidationError( + context, + "unsupported_type", + `${context.label} contains a function, symbol, or BigInt at ${path}`, + path + ); + } + if (ancestors.has(current)) { + throw strictJsonValidationError( + context, + "cyclic_value", + `${context.label} contains a cyclic reference at ${path}`, + path + ); + } + + ancestors.add(current); + try { + if (Array.isArray(current)) { + const keys = Reflect.ownKeys(current); + if ( + keys.length !== current.length + 1 || + keys.some( + (key) => + key !== "length" && + (typeof key !== "string" || + !/^(0|[1-9]\d*)$/.test(key) || + Number(key) >= current.length) + ) + ) { + throw strictJsonValidationError( + context, + "unsupported_object", + `${context.label} contains a non-JSON array property at ${path}`, + path + ); + } + for (let index = 0; index < current.length; index++) { + const descriptor = Object.getOwnPropertyDescriptor(current, String(index)); + if ( + descriptor === undefined || + !descriptor.enumerable || + !("value" in descriptor) + ) { + throw strictJsonValidationError( + context, + "unsupported_object", + `${context.label} contains a non-JSON array property at ${path}[${index}]`, + `${path}[${index}]` + ); + } + visit(descriptor.value, `${path}[${index}]`, false); + } + return; + } + + const prototype = Object.getPrototypeOf(current); + if (prototype !== Object.prototype && prototype !== null) { + throw strictJsonValidationError( + context, + "unsupported_object", + `${context.label} contains a non-JSON object at ${path}`, + path + ); + } + for (const key of Reflect.ownKeys(current)) { + if (typeof key === "symbol") { + throw strictJsonValidationError( + context, + "unsupported_type", + `${context.label} contains a function, symbol, or BigInt at ${path}`, + path + ); + } + const propertyPath = /^[A-Za-z_$][\w$]*$/.test(key) + ? `${path}.${key}` + : `${path}[${JSON.stringify(key)}]`; + const descriptor = Object.getOwnPropertyDescriptor(current, key); + if ( + descriptor === undefined || + !descriptor.enumerable || + !("value" in descriptor) + ) { + throw strictJsonValidationError( + context, + "unsupported_object", + `${context.label} contains a non-JSON property at ${propertyPath}`, + propertyPath + ); + } + visit(descriptor.value, propertyPath, false); + } + } finally { + ancestors.delete(current); + } + }; + + visit(value, "$", context.allowTopLevelUndefined); +} + +function assertFactoryResult(value: unknown): asserts value is JsonValue | undefined { + assertStrictJson(value, { + code: "factory_result_not_json", + label: "Factory result", + allowTopLevelUndefined: true, + }); +} + +function assertFactoryStepResult(value: unknown, key: string): asserts value is JsonValue { + assertStrictJson(value, { + code: "factory_step_not_json", + label: `Factory step "${key}" result`, + allowTopLevelUndefined: false, + }); +} diff --git a/nodejs/src/sessionFsProvider.ts b/nodejs/src/sessionFsProvider.ts index 7e959849e..ecb18a570 100644 --- a/nodejs/src/sessionFsProvider.ts +++ b/nodejs/src/sessionFsProvider.ts @@ -8,10 +8,12 @@ import type { SessionFsStatResult, SessionFsReaddirWithTypesEntry, SessionFsSqliteQueryResult as GeneratedSqliteQueryResult, + SessionFsSqliteTransactionError as GeneratedSqliteTransactionError, + SessionFsSqliteTransactionErrorClass, SessionFsSqliteQueryType, } from "./generated/rpc.js"; -export type { SessionFsSqliteQueryType }; +export type { SessionFsSqliteQueryType, SessionFsSqliteTransactionErrorClass }; /** * File metadata returned by {@link SessionFsProvider.stat}. @@ -27,6 +29,40 @@ export type SessionFsFileInfo = Omit; */ export type SessionFsSqliteQueryResult = Omit; +/** + * One statement in an atomic SQLite transaction passed to + * {@link SessionFsSqliteProvider.transaction}. + */ +export interface SessionFsSqliteStatement { + /** How to execute: `"exec"` for DDL/multi-statement, `"query"` for SELECT, `"run"` for INSERT/UPDATE/DELETE. */ + queryType: SessionFsSqliteQueryType; + + /** SQL statement to execute. */ + query: string; + + /** Optional named bind parameters. */ + params?: Record; +} + +/** + * Error thrown by {@link SessionFsSqliteProvider.transaction} to classify a + * transaction failure for the runtime. + * + * Any other thrown value is reported as `"fatal"`. Throw this with + * `"busyOrLocked"` when SQLite reported BUSY/LOCKED before commit and the + * transaction was rolled back, so the runtime knows the call is safe to retry. + */ +export class SessionFsSqliteTransactionFailure extends Error { + /** Failure classification reported to the runtime. */ + readonly errorClass: SessionFsSqliteTransactionErrorClass; + + constructor(message: string, errorClass: SessionFsSqliteTransactionErrorClass = "fatal") { + super(message); + this.name = "SessionFsSqliteTransactionFailure"; + this.errorClass = errorClass; + } +} + /** * SQLite operations for the per-session database. * Implementers provide query execution and existence checking. @@ -45,6 +81,18 @@ export interface SessionFsSqliteProvider { params?: Record ): Promise; + /** + * Execute `statements` atomically against the per-session database. + * + * Apply busy handling to every statement and roll back the whole batch if + * any statement fails. Throw {@link SessionFsSqliteTransactionFailure} to + * classify the failure; any other thrown value is reported as `"fatal"`. + * + * @param statements - Statements to execute in order inside a single transaction. + * @returns One result per statement, in the same order. + */ + transaction?(statements: SessionFsSqliteStatement[]): Promise; + /** * Check whether the per-session database already exists, without creating it. */ @@ -96,7 +144,7 @@ export interface SessionFsProvider { } function normalizeSqliteParams( - params?: Record + params?: Record ): Record | undefined { if (!params) { return undefined; @@ -105,7 +153,7 @@ function normalizeSqliteParams( const normalized: Record = {}; for (const [key, value] of Object.entries(params)) { if (value !== undefined) { - normalized[key] = value; + normalized[key] = value as string | number | null; } } return normalized; @@ -219,6 +267,32 @@ export function createSessionFsAdapter(provider: SessionFsProvider): SessionFsHa ); return result ?? { rows: [], columns: [], rowsAffected: 0 }; }, + sqliteTransaction: async ({ statements }) => { + if (!provider.sqlite?.transaction) { + return { + results: [], + error: { + errorClass: "fatal", + message: "SQLite transactions are not supported by this provider", + }, + }; + } + try { + const results = await provider.sqlite.transaction( + statements.map((statement) => ({ + queryType: statement.queryType, + query: statement.query, + params: normalizeSqliteParams(statement.params), + })) + ); + return { results: results.map((result) => ({ ...result })) }; + } catch (err) { + // Unlike sqliteQuery, transaction failures carry a classification the + // runtime uses to decide whether a retry is safe, so they are reported + // as a result-level error instead of a JSON-RPC error. + return { results: [], error: toSqliteTransactionError(err) }; + } + }, sqliteExists: async () => { if (!provider.sqlite) { throw new Error("SQLite is not supported by this provider"); @@ -233,3 +307,13 @@ function toSessionFsError(err: unknown): SessionFsError { const code = e.code === "ENOENT" ? "ENOENT" : "UNKNOWN"; return { code, message: e.message ?? String(err) }; } + +function toSqliteTransactionError(err: unknown): GeneratedSqliteTransactionError { + if (err instanceof SessionFsSqliteTransactionFailure) { + return { errorClass: err.errorClass, message: err.message }; + } + return { + errorClass: "fatal", + message: err instanceof Error ? err.message : String(err), + }; +} diff --git a/nodejs/src/types.ts b/nodejs/src/types.ts index 75aa5159f..06d6bf7eb 100644 --- a/nodejs/src/types.ts +++ b/nodejs/src/types.ts @@ -9,16 +9,39 @@ // Import and re-export generated session event types import type { Canvas } from "./canvas.js"; import type { SessionFsProvider } from "./sessionFsProvider.js"; +import type { CopilotRequestHandler } from "./copilotRequestHandler.js"; import type { + PermissionRequest as GeneratedPermissionRequest, + PermissionRequestedData as GeneratedPermissionRequestedData, + PermissionRequestedEvent as GeneratedPermissionRequestedEvent, ReasoningSummary, + SessionLimitsConfig, SessionEvent as GeneratedSessionEvent, } from "./generated/session-events.js"; import type { CopilotSession } from "./session.js"; -import type { RemoteSessionMode } from "./generated/rpc.js"; -import type { OpenCanvasInstance } from "./generated/rpc.js"; +import type { FactoryJsonSchema, JsonValue } from "./factory.js"; +import type { + GitHubTelemetryNotification, + ModelBillingTokenPrices, + OpenCanvasInstance, + RemoteSessionMode, + CurrentToolMetadata, +} from "./generated/rpc.js"; import type { ToolSet } from "./toolSet.js"; export type { RemoteSessionMode } from "./generated/rpc.js"; -export type SessionEvent = GeneratedSessionEvent; +export type { CurrentToolMetadata } from "./generated/rpc.js"; +export type { + GitHubTelemetryNotification, + GitHubTelemetryEvent, + GitHubTelemetryClientInfo, +} from "./generated/rpc.js"; +export type { + ModelBillingTokenPrices, + ModelBillingTokenPricesLongContext, +} from "./generated/rpc.js"; +export type SessionEvent = + | Exclude + | PermissionRequestedEvent; export type { ReasoningSummary } from "./generated/session-events.js"; export type { SessionFsProvider } from "./sessionFsProvider.js"; export { createSessionFsAdapter } from "./sessionFsProvider.js"; @@ -26,6 +49,23 @@ export type { SessionFsFileInfo } from "./sessionFsProvider.js"; export type { SessionFsSqliteQueryResult } from "./sessionFsProvider.js"; export type { SessionFsSqliteQueryType } from "./sessionFsProvider.js"; export type { SessionFsSqliteProvider } from "./sessionFsProvider.js"; +export type { SessionFsSqliteStatement } from "./sessionFsProvider.js"; +export type { SessionFsSqliteTransactionErrorClass } from "./sessionFsProvider.js"; +export { SessionFsSqliteTransactionFailure } from "./sessionFsProvider.js"; +export type { LlmInferenceHeaders } from "./generated/rpc.js"; +export type { + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, +} from "./generated/rpc.js"; +export type { CopilotRequestContext } from "./copilotRequestHandler.js"; +export { + CopilotRequestHandler, + CopilotWebSocketHandler, + CopilotWebSocketCloseStatus, + CopilotWebSocketForwarder, +} from "./copilotRequestHandler.js"; /** * Options for creating a CopilotClient @@ -55,6 +95,8 @@ export type TraceContextProvider = () => TraceContext | Promise; export interface TelemetryConfig { /** OTLP HTTP endpoint URL for trace/metric export. Sets OTEL_EXPORTER_OTLP_ENDPOINT. */ otlpEndpoint?: string; + /** OTLP HTTP protocol for all signals. Sets OTEL_EXPORTER_OTLP_PROTOCOL. */ + otlpProtocol?: "http/json" | "http/protobuf"; /** File path for JSON-lines trace output. Sets COPILOT_OTEL_FILE_EXPORTER_PATH. */ filePath?: string; /** Exporter backend type: "otlp-http" or "file". Sets COPILOT_OTEL_EXPORTER_TYPE. */ @@ -71,25 +113,60 @@ export interface TelemetryConfig { */ export type RuntimeConnection = | StdioRuntimeConnection + | InProcessRuntimeConnection | TcpRuntimeConnection | UriRuntimeConnection; /** - * Spawns a runtime child process and communicates over its stdin/stdout. - * This is the default if no {@link CopilotClientOptions.connection} is set. + * Shared shape for the transports that spawn a runtime **child process** + * ({@link StdioRuntimeConnection} and {@link TcpRuntimeConnection}). */ -export interface StdioRuntimeConnection { - readonly kind: "stdio"; +export interface ChildProcessRuntimeConnection { /** Path to the runtime executable. When omitted, the bundled runtime is used. */ readonly path?: string; /** Extra command-line arguments to pass to the runtime process. */ readonly args?: readonly string[]; + /** + * Environment variables for the spawned runtime child process, replacing the + * inherited environment. Cannot be combined with + * {@link CopilotClientOptions.env}; setting both throws when the client is + * constructed. When omitted, the client-level env (or `process.env`) is used. + */ + readonly env?: Record; +} + +/** + * Spawns a runtime child process and communicates over its stdin/stdout. + * This is the default if no {@link CopilotClientOptions.connection} is set. + */ +export interface StdioRuntimeConnection extends ChildProcessRuntimeConnection { + readonly kind: "stdio"; +} + +/** + * Hosts the runtime in-process by loading the native runtime library and speaking + * JSON-RPC over its C ABI (FFI), instead of spawning a runtime child process. The + * native host spawns the CLI worker itself. Construct via + * {@link RuntimeConnection.forInProcess}. + * + * @experimental The in-process (FFI) transport is experimental and its behavior may + * change. Per-client options that are lowered to environment variables — including + * {@link CopilotClientOptions.env}, {@link CopilotClientOptions.telemetry}, + * {@link CopilotClientOptions.gitHubToken}, and + * {@link CopilotClientOptions.baseDirectory} — are **not** honored with this + * transport, because the native runtime loads into the shared host process and its + * worker inherits that process's ambient environment. To configure the in-process + * runtime, set the corresponding environment variables on the host process before + * constructing the client. See https://github.com/github/copilot-sdk/issues/1934. + */ +export interface InProcessRuntimeConnection { + readonly kind: "inprocess"; } /** * Spawns a runtime child process that listens on a TCP socket and connects to it. */ -export interface TcpRuntimeConnection { +export interface TcpRuntimeConnection extends ChildProcessRuntimeConnection { readonly kind: "tcp"; /** * TCP port to listen on. `0` (the default) auto-allocates a free port. @@ -102,10 +179,6 @@ export interface TcpRuntimeConnection { * loopback listener is safe by default. */ readonly connectionToken?: string; - /** Path to the runtime executable. When omitted, the bundled runtime is used. */ - readonly path?: string; - /** Extra command-line arguments to pass to the runtime process. */ - readonly args?: readonly string[]; } /** @@ -129,8 +202,10 @@ export const RuntimeConnection = { * Spawn a runtime child process and communicate over its stdin/stdout. * This is the default if no {@link CopilotClientOptions.connection} is set. */ - forStdio(opts: { path?: string; args?: readonly string[] } = {}): StdioRuntimeConnection { - return { kind: "stdio", path: opts.path, args: opts.args }; + forStdio( + opts: { path?: string; args?: readonly string[]; env?: Record } = {} + ): StdioRuntimeConnection { + return { kind: "stdio", path: opts.path, args: opts.args, env: opts.env }; }, /** * Spawn a runtime child process that listens on a TCP socket and connect to it. @@ -141,6 +216,7 @@ export const RuntimeConnection = { connectionToken?: string; path?: string; args?: readonly string[]; + env?: Record; } = {} ): TcpRuntimeConnection { return { @@ -149,6 +225,7 @@ export const RuntimeConnection = { connectionToken: opts.connectionToken, path: opts.path, args: opts.args, + env: opts.env, }; }, /** @@ -158,6 +235,18 @@ export const RuntimeConnection = { forUri(url: string, opts: { connectionToken?: string } = {}): UriRuntimeConnection { return { kind: "uri", url, connectionToken: opts.connectionToken }; }, + /** + * Host the runtime in-process over the native runtime library's C ABI (FFI). + * + * @experimental Per-client options lowered to environment variables (`env`, + * `telemetry`, `gitHubToken`, `baseDirectory`) are **not** honored in-process; + * the worker inherits the host process's ambient environment. Set the + * corresponding environment variables on the host process instead. See + * https://github.com/github/copilot-sdk/issues/1934. + */ + forInProcess(): InProcessRuntimeConnection { + return { kind: "inprocess" }; + }, } as const; /** @@ -221,6 +310,13 @@ export interface CopilotClientOptions { */ baseDirectory?: string; + /** + * Absolute paths to trusted plugin directories bundled by the host. + * When non-empty, the complete set is registered with the runtime during + * startup before any sessions can be created. + */ + builtinPluginDirectories?: readonly string[]; + /** * Log level for the Copilot runtime. When omitted, the runtime uses its * own default (currently `"info"`). @@ -296,6 +392,42 @@ export interface CopilotClientOptions { */ sessionFs?: SessionFsConfig; + /** + * Custom handler for outbound model-layer requests (experimental). + * + * When provided, the client registers as the runtime's request handler + * on connection: every outbound model-layer request the runtime would + * otherwise have issued itself — plain HTTP, streaming SSE, and + * WebSocket — is dispatched back to the handler over JSON-RPC. The + * handler returns the response verbatim, exactly as if the runtime had + * issued the request itself. + * + * Subclass {@link CopilotRequestHandler} and override the hooks you need; + * an instance that overrides nothing is a transparent pass-through. + * + * v1 notes: + * - HTTP (buffered and streaming SSE) and WebSocket transports are all + * intercepted. The handler receives a `transport` discriminator on the + * {@link CopilotRequestContext} for both. + * - The handler is set process-globally on the runtime; the same + * handler is invoked for every session created on this client. + * + * @experimental + */ + requestHandler?: CopilotRequestHandler; + + /** + * Experimental. Receives GitHub telemetry events the runtime forwards to + * this connection. When set, the client opts each session it creates or + * resumes into telemetry forwarding and dispatches each + * `gitHubTelemetry.event` notification to this connection-global handler; + * each {@link GitHubTelemetryNotification} carries its originating + * `sessionId`. + * + * @experimental + */ + onGitHubTelemetry?: (notification: GitHubTelemetryNotification) => void | Promise; + /** * Server-wide idle timeout for sessions in seconds. * Sessions without activity for this duration are automatically cleaned up. @@ -333,7 +465,7 @@ export type ToolBinaryResult = { description?: string; }; -export type ToolTelemetry = Record | undefined>; +export type ToolTelemetry = Record | undefined>; export type ToolResultObject = { textResultForLlm: string; @@ -342,6 +474,10 @@ export type ToolResultObject = { error?: string; sessionLog?: string; toolTelemetry?: ToolTelemetry; + /** + * Names of tools returned by a tool-search tool. + */ + toolReferences?: string[]; }; export type ToolResult = string | ToolResultObject; @@ -466,6 +602,14 @@ export interface ToolInvocation { toolCallId: string; toolName: string; arguments: unknown; + /** + * Snapshot of the session's currently initialized tools. Populated by the + * SDK only when this invocation targets the built-in tool-search tool + * (`tool_search_tool`), so a tool-search override can rank/filter the live + * catalog — including MCP tools configured in settings — without issuing its + * own RPC. `undefined` for every other tool invocation. + */ + availableTools?: CurrentToolMetadata[]; /** W3C Trace Context traceparent from the CLI's execute_tool span. */ traceparent?: string; /** W3C Trace Context tracestate from the CLI's execute_tool span. */ @@ -511,6 +655,32 @@ export interface Tool { * When true, the tool can execute without a permission prompt. */ skipPermission?: boolean; + /** + * Controls whether the tool may be deferred (loaded lazily via tool search) + * rather than always pre-loaded. When `"auto"`, the tool can be deferred and + * surfaced through tool search. When `"never"`, the tool is always pre-loaded. + * Optional; defaults to `"auto"`. + */ + defer?: "auto" | "never"; + /** + * Opaque, host-defined metadata associated with the tool definition. + * + * Keys are namespaced and are not part of the stable public API. Values are + * not interpreted and may be recognized to inform host-specific behavior. + * Unknown keys are preserved and round-tripped untouched. + */ + metadata?: Record; + /** + * When true, a successful call to this tool ends the agent turn: the runtime's + * tool phase halts instead of feeding the tool result back to the model for + * another round. A failed call (for example input validation) leaves the loop + * running so the model can read the error and retry. + * + * Use this for tools whose whole purpose is to terminate the turn, such as a + * context clear that replaces the conversation the model would otherwise + * continue from. + */ + isTerminal?: boolean; } /** @@ -525,11 +695,43 @@ export function defineTool( handler?: ToolHandler; overridesBuiltInTool?: boolean; skipPermission?: boolean; + defer?: "auto" | "never"; + metadata?: Record; + isTerminal?: boolean; } ): Tool { return { name, ...config }; } +/** + * SDK-supplied override for the runtime's built-in tool-search behavior. + * + * Tool search lets the model discover tools on demand instead of loading every + * tool definition up front. When the total tool count exceeds the deferral + * threshold, MCP and external tools are marked as deferred and surfaced through + * the built-in `tool_search_tool`. + * + * To override the tool-search tool's model-facing definition and/or its + * execution, register a {@link Tool} named `tool_search_tool` with + * `overridesBuiltInTool: true`. To customize the in-prompt tool-search + * guidance, use the `tool_instructions` section of {@link SystemMessageConfig} + * in `"customize"` mode. + */ +export interface ToolSearchConfig { + /** + * Toggle to enable/disable tool search. When disabled, all tools are pre-loaded + * and the model's active tool set is not deferred. + */ + enabled?: boolean; + + /** + * Overrides the total tool count at which MCP and external tools are + * automatically deferred behind tool search. Defaults to the built-in + * threshold (30) when omitted. + */ + deferThreshold?: number; +} + // ============================================================================ // Commands // ============================================================================ @@ -785,6 +987,7 @@ export interface ToolCallResponsePayload { * Each section corresponds to a distinct part of the system prompt. */ export type SystemMessageSection = + | "preamble" | "identity" | "tone" | "tool_efficiency" @@ -799,7 +1002,11 @@ export type SystemMessageSection = /** Section metadata for documentation and tooling. */ export const SYSTEM_MESSAGE_SECTIONS: Record = { - identity: { description: "Agent identity preamble and mode statement" }, + preamble: { description: "Agent identity preamble and mode statement" }, + identity: { + description: + "Section group covering the identity preamble and its sibling sub-sections (tone, tool efficiency, etc.)", + }, tone: { description: "Response style, conciseness rules, output formatting preferences" }, tool_efficiency: { description: "Tool usage patterns, parallel calling, batching guidelines" }, environment_context: { description: "CWD, OS, git root, directory listing, available tools" }, @@ -830,6 +1037,8 @@ export type SectionTransformFn = (currentContent: string) => string | Promise & { + permissionRequest: PermissionRequest; +}; -import type { PermissionDecisionRequest } from "./generated/rpc.js"; +export type PermissionRequestedEvent = Omit & { + data: PermissionRequestedData; +}; /** * Permission decision result returned from a {@link PermissionHandler}. @@ -935,12 +1162,67 @@ import type { PermissionDecisionRequest } from "./generated/rpc.js"; */ export type PermissionRequestResult = PermissionDecisionRequest["result"] | { kind: "no-result" }; +/** + * A {@link PermissionRequestResult} annotated with the + * {@link PermissionDecisionContext} describing how and where the decision was + * reached. The context is informational only — it never changes permission + * behavior. Supplying it lets the runtime attribute auto-approval telemetry to + * the responding surface. + */ +export interface AttributedPermissionResult { + kind: "attributed"; + result: PermissionRequestResult; + decisionContext: PermissionDecisionContext; +} + +/** + * Narrows a {@link PermissionHandler} return value to an attributed result. + */ +export function isAttributedPermissionResult( + result: PermissionRequestResult | AttributedPermissionResult +): result is AttributedPermissionResult { + return result.kind === "attributed"; +} + +/** + * Pair a permission decision with the context describing how and where it was + * made, so the runtime can attribute auto-approval telemetry. + * + * Passing an already-attributed result replaces the previous context rather + * than nesting it. The context is informational only and never changes + * permission behavior. + */ +export function createAttributedPermissionResult( + result: PermissionRequestResult | AttributedPermissionResult, + decisionContext: PermissionDecisionContext +): AttributedPermissionResult { + const inner = isAttributedPermissionResult(result) ? result.result : result; + return { kind: "attributed", result: inner, decisionContext }; +} + export type PermissionHandler = ( request: PermissionRequest, - invocation: { sessionId: string } -) => Promise | PermissionRequestResult; + invocation: { sessionId: string; managedSettingsEnabled?: boolean } +) => + | Promise + | PermissionRequestResult + | AttributedPermissionResult; -export const approveAll: PermissionHandler = () => ({ kind: "approve-once" }); +/** + * Approves permission requests when managed settings are disabled. + */ +export const approveAll: PermissionHandler = (request, invocation) => { + if (invocation.managedSettingsEnabled) { + throw new Error("approveAll cannot be used when managed settings are enabled"); + } + if ("managedApprovalRequired" in request) { + const managedApprovalRequired = request.managedApprovalRequired; + if (managedApprovalRequired !== undefined && managedApprovalRequired !== false) { + return { kind: "no-result" }; + } + } + return { kind: "approve-once" }; +}; export const defaultJoinSessionPermissionHandler: PermissionHandler = (): PermissionRequestResult => ({ @@ -1222,6 +1504,33 @@ export type UserPromptSubmittedHandler = ( invocation: { sessionId: string } ) => Promise | UserPromptSubmittedHookOutput | void; +/** + * Input for the user-prompt-transformed hook. + * + * This hook runs after the runtime has transformed the submitted prompt with + * generated context, but before it is persisted to session history or sent to + * the model. + */ +export interface UserPromptTransformedHookInput extends BaseHookInput { + prompt: string; + transformedPrompt: string; +} + +/** + * Output for the user-prompt-transformed hook. + */ +export interface UserPromptTransformedHookOutput { + modifiedTransformedPrompt?: string; +} + +/** + * Handler for the user-prompt-transformed hook. + */ +export type UserPromptTransformedHandler = ( + input: UserPromptTransformedHookInput, + invocation: { sessionId: string } +) => Promise | UserPromptTransformedHookOutput | void; + /** * Input for session-start hook */ @@ -1299,6 +1608,49 @@ export type ErrorOccurredHandler = ( invocation: { sessionId: string } ) => Promise | ErrorOccurredHookOutput | void; +/** + * Input for the agent-stop hook. + * + * Fires for the top-level (main) agent when it reaches a natural terminal stop + * — i.e. the agent has gone idle without a pending non-terminal tool call and + * was not aborted or blocked by a rejected tool. (For sub-agents, the runtime + * fires a separate sub-agent stop lifecycle.) + */ +export interface AgentStopHookInput extends BaseHookInput { + /** Why the agent stopped (for example, `"end_turn"`). */ + stopReason?: string; + /** Path to the on-disk session transcript, when available. */ + transcriptPath?: string; + /** + * True when this stop is a re-entry triggered by a previous agent-stop + * `block` decision (Claude-compatible `stop_hook_active` semantics). Lets a + * handler avoid blocking indefinitely. + */ + stopHookActive?: boolean; +} + +/** + * Output for the agent-stop hook. + * + * Return `{ decision: "block", reason }` to keep the agent running: the + * `reason` is enqueued as a follow-up user message so the agent continues + * working (for example, to remediate findings surfaced by the hook). The + * runtime caps consecutive blocks to prevent runaway loops. Returning nothing + * (or omitting `decision`) lets the agent stop normally. + */ +export interface AgentStopHookOutput { + decision?: "block"; + reason?: string; +} + +/** + * Handler for the agent-stop hook. + */ +export type AgentStopHandler = ( + input: AgentStopHookInput, + invocation: { sessionId: string } +) => Promise | AgentStopHookOutput | void; + /** * Configuration for session hooks */ @@ -1335,6 +1687,11 @@ export interface SessionHooks { */ onUserPromptSubmitted?: UserPromptSubmittedHandler; + /** + * Called after the runtime transforms a submitted prompt and before it is stored. + */ + onUserPromptTransformed?: UserPromptTransformedHandler; + /** * Called when a session starts */ @@ -1349,6 +1706,16 @@ export interface SessionHooks { * Called when an error occurs */ onErrorOccurred?: ErrorOccurredHandler; + + /** + * Called when the top-level agent reaches a natural terminal stop (it went + * idle without pending work and was not aborted). Return + * `{ decision: "block", reason }` to keep the agent running with `reason` + * enqueued as a follow-up message — for example, to have the agent + * remediate findings the handler surfaced. Returning nothing lets the + * agent stop. + */ + onAgentStop?: AgentStopHandler; } // ============================================================================ @@ -1465,6 +1832,12 @@ export interface CustomAgentConfig { * falling back to the parent session model if unavailable. */ model?: string; + /** + * Reasoning effort level for this agent's model. + * When omitted, the runtime resolves the effort from model configuration, + * then inherits the parent effort only if this agent uses the same model. + */ + reasoningEffort?: ReasoningEffort; } /** @@ -1509,6 +1882,17 @@ export interface InfiniteSessionConfig { bufferExhaustionThreshold?: number; } +/** + * Configuration for the memory feature, which lets the agent persist and recall + * information across turns. + */ +export interface MemoryConfiguration { + /** + * Whether the memory feature is enabled for this session. + */ + enabled: boolean; +} + /** * Configuration for handling large tool outputs. * @@ -1538,7 +1922,7 @@ export interface LargeToolOutputConfig { /** * Valid reasoning effort levels for models that support it. */ -export type ReasoningEffort = "low" | "medium" | "high" | "xhigh"; +export type ReasoningEffort = "low" | "medium" | "high" | "xhigh" | "max"; /** * Context window tier for the session. "long_context" pins the session to the @@ -1546,6 +1930,76 @@ export type ReasoningEffort = "low" | "medium" | "high" | "xhigh"; */ export type ContextTier = "default" | "long_context"; +/** Parsed parameters from an MCP server's WWW-Authenticate response. */ +export interface McpAuthWwwAuthenticateParams { + /** Parsed resource_metadata URL used for protected-resource metadata discovery, if present. */ + resourceMetadataUrl?: string; + /** Parsed OAuth scope, if present. */ + scope?: string; + /** Parsed OAuth error, if present. */ + error?: string; +} + +/** Static OAuth client configuration supplied by the MCP server, if available. */ +export interface McpAuthStaticClientConfig { + /** OAuth client ID for the server. */ + clientId: string; + /** Optional OAuth client secret for confidential static clients. */ + clientSecret?: string; + /** Optional non-default OAuth grant type. */ + grantType?: "client_credentials"; + /** Whether this is a public OAuth client. */ + publicClient?: boolean; +} + +/** MCP OAuth request that the SDK host can satisfy with a host-acquired token. */ +export interface McpAuthRequest { + /** Unique request identifier used by the SDK when responding. */ + requestId: string; + /** Display name of the MCP server that requires OAuth. */ + serverName: string; + /** URL of the MCP server that requires OAuth. */ + serverUrl: string; + /** Why the runtime is requesting host-provided OAuth credentials. */ + reason: "initial" | "refresh" | "reauth" | "upscope"; + /** Parsed WWW-Authenticate parameters from the MCP server. */ + wwwAuthenticateParams?: McpAuthWwwAuthenticateParams; + /** Raw RFC 9728 protected-resource metadata JSON fetched by the runtime, if available. */ + resourceMetadata?: string; + /** Static OAuth client configuration, if the server specifies one. */ + staticClientConfig?: McpAuthStaticClientConfig; +} + +/** Host-provided OAuth token data for a pending MCP OAuth request. */ +export interface McpAuthToken { + /** Access token acquired by the SDK host. */ + accessToken: string; + /** OAuth token type. Defaults to Bearer when omitted. */ + tokenType?: string; + /** Token lifetime in seconds, if known. */ + expiresIn?: number; +} + +/** + * Result returned by an MCP auth request handler. + * + * Return `null`/`undefined` or `{ kind: "cancelled" }` to cancel the pending + * OAuth request. Return `{ kind: "token", ... }` to provide host-acquired + * OAuth token data. + */ +export type McpAuthResult = ({ kind: "token" } & McpAuthToken) | { kind: "cancelled" }; + +/** Callback invoked when an MCP server requires OAuth and the SDK host opted in. */ +export type McpAuthHandler = ( + request: McpAuthRequest, + context: { sessionId: string } +) => + | McpAuthResult + | McpAuthToken + | null + | undefined + | Promise; + /** * Stable extension identity for session participants that provide canvases. */ @@ -1556,6 +2010,202 @@ export interface ExtensionInfo { name: string; } +/** + * Stable identity for a host/SDK connection that supplies built-in canvases. + * + * When set on session create or resume, the runtime uses {@link id} verbatim + * as the agent-facing canvas extension id, so canvases declared on a control + * connection survive stdio reconnect and CLI process restart instead of being + * re-keyed to a per-connection id. The id is opaque to the runtime; a + * per-window-stable value such as `app:builtin:` is recommended. An + * id beginning with `connection:` is reserved and ignored by the runtime. + */ +export interface CanvasProviderIdentity { + /** Opaque, stable provider id used verbatim as the canvas extension id. */ + id: string; + /** Optional display name surfaced as the canvas extension name. */ + name?: string; +} + +/** + * Static resource ceilings declared by a factory before it runs. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryLimits { + /** Maximum number of factory subagents that may run concurrently. Must be positive when present. */ + maxConcurrentSubagents?: number; + /** Maximum total number of factory subagents that may be spawned. Must be positive when present. */ + maxTotalSubagents?: number; + /** Maximum AI credits consumed by factory subagents and descendants. This post-paid ceiling is soft. */ + maxAiCredits?: number; + /** + * Maximum accumulated active-execution time, in seconds. Active execution includes the entire extension body, + * subprocess waits, queued-agent waits, and sleeps. The limit is armed from the remaining headroom when a run + * resumes; time between attempts is not counted. Must be finite and positive when present. + */ + timeoutSeconds?: number; +} + +/** + * Registration metadata for an extension-authored factory. + * + * @experimental Part of the experimental Agent Factories surface and may + * change or be removed in future SDK or CLI releases. + */ +export interface FactoryMeta { + /** Stable factory name used for invocation. */ + name: string; + /** Human-readable factory description. */ + description: string; + /** Display metadata for the progress phases the factory may report. */ + phases: Array<{ title: string; detail?: string }>; + /** + * Optional declared shape of the arguments this factory expects as `ctx.args`. + * + * Declaring one is strongly recommended for any factory that reads `ctx.args`. + * When the model invokes the factory through the `run_factory` tool, the CLI + * validates `args` against this declaration **before** the run starts, so a + * malformed call is rejected with a correction hint and retried without ever + * creating a run row, prompting the user for permission, or spending credits. A + * factory that declares nothing is never validated: a malformed call starts, + * takes an approval, spends credits, and then fails inside the factory body. + * `factories_manage` with `operation: "inspect"` reports the declared shape so an + * agent can read it before invoking. + * + * This covers the model's `run_factory` path only. `session.factory.run(...)` is + * not validated against the declaration, so a factory should still check + * `ctx.args` rather than assume the declared shape held. + * + * Enforcement covers structure — types, required properties, and enum/const + * values. Finer constraints such as `minLength`, `pattern`, and + * `additionalProperties` are recorded in the declaration but not enforced. See + * {@link FactoryJsonSchema} for the accepted subset. A declaration outside that + * subset is rejected at registration. + */ + argsSchema?: FactoryJsonSchema; + /** Optional resource ceilings presented to the user before execution. */ + limits?: FactoryLimits; +} + +/** + * Provider-scoped options for the Copilot API (CAPI). + * + * These settings apply to the built-in Copilot API provider only. They live + * under their own namespace because a single session can host multiple + * providers (CAPI alongside BYOK via {@link ProviderConfig}), so transport and + * provider-level choices are conceptually per-provider rather than global. + */ +export interface CapiSessionOptions { + /** + * Whether to use the WebSocket transport for the CAPI Responses API. + * + * WebSocket transport is enabled by default whenever the selected model + * advertises the `ws:/responses` endpoint. Set this to `false` to fall back + * to the HTTP Responses transport instead — useful for users behind proxies + * where WebSocket connections fail. + * + * Setting this to `false` is equivalent to setting the + * `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. + * + * @default true + */ + enableWebSocketResponses?: boolean; +} + +/** + * A single ExP (Experiment Platform) flag value. ExP assignments resolve to a + * string, number, boolean, or `null`. + */ +export type ExpFlagValue = string | number | boolean | null; + +/** + * A single configuration entry in a {@link CopilotExpAssignmentResponse}. Each + * entry carries an identifier and a bag of typed parameter values. + */ +export interface ExpConfigEntry { + /** Identifier of the configuration entry. */ + Id: string; + /** Parameter values keyed by parameter name. */ + Parameters: Record; +} + +/** + * ExP ("flight") assignment data, in the same JSON shape the Copilot CLI + * fetches from the experimentation service. Field names are PascalCase to match + * the on-the-wire contract consumed by the runtime. + */ +export interface CopilotExpAssignmentResponse { + /** Enabled feature names. */ + Features: string[]; + /** Assigned flights keyed by flight name. */ + Flights: Record; + /** Configuration entries carrying typed parameter values. */ + Configs: ExpConfigEntry[]; + /** Opaque parameter-group payload passed through untouched. */ + ParameterGroups?: unknown; + /** Version of the flighting configuration. */ + FlightingVersion?: number; + /** Impression identifier for the assignment. */ + ImpressionId?: string; + /** Assignment context string forwarded to CAPI and telemetry. */ + AssignmentContext: string; +} + +/** + * Configuration for the built-in GitHub MCP server. + * + * `disableFormDeferral` only applies to the built-in GitHub MCP server and + * only has an effect when MCP Apps and form-backed GitHub tools are enabled. + */ +export interface GitHubMcpToolConfig { + enableAllTools?: boolean; + additionalToolsets?: string[]; + additionalTools?: string[]; + enableInsidersMode?: boolean; + disableFormDeferral?: boolean; +} + +/** + * Permissions-only managed policy injected by the host via + * {@link SessionConfigBase.managedSettings}. + * + * Rule strings use the same vocabulary the runtime accepts for fetched managed + * policy (e.g. `"Read(**)"`, `"Shell(git push *)"`); malformed rules are + * rejected at session creation. + */ +export interface ManagedSettingsPermissions { + /** + * When set to `"disable"`, bypass-permissions ("yolo") mode is turned off + * for the session. This is deny-wins: it cannot be re-enabled by any other + * layer. + */ + disableBypassPermissionsMode?: "disable"; + /** Operations that must always be denied. Unioned across managed layers. */ + deny?: string[]; + /** + * Operations that must prompt for approval. Unioned across managed layers. + */ + ask?: string[]; + /** + * Operations permitted without prompting. Every declared `allow` list + * (across managed layers) must admit an operation for it to be allowed. + */ + allow?: string[]; +} + +/** + * Host-injected enterprise managed settings. The first supported contract is + * permissions-only; unknown sibling keys are rejected by the runtime. + * + * @see {@link SessionConfigBase.managedSettings} + */ +export interface ManagedSettings { + /** Managed permission policy for the session. */ + permissions?: ManagedSettingsPermissions; +} + /** * Shared configuration fields used by both {@link SessionConfig} (for * creating a new session) and {@link ResumeSessionConfig} (for resuming @@ -1586,6 +2236,12 @@ export interface SessionConfigBase { */ reasoningSummary?: ReasoningSummary; + /** + * Controls whether the session enables experimental features. + * Defaults to `false` in `"empty"` mode; otherwise the runtime decides when unset. + */ + enableExperimentalMode?: boolean; + /** * Context window tier for models that support it. Use "long_context" to pin * the session to the long-context tier; omit or use "default" otherwise. @@ -1610,13 +2266,8 @@ export interface SessionConfigBase { configDirectory?: string; /** - * When true, automatically discovers MCP server configurations (e.g. `.mcp.json`, - * `.vscode/mcp.json`) and skill directories from the working directory and merges - * them with any explicitly provided `mcpServers` and `skillDirectories`, with - * explicit values taking precedence on name collision. - * - * Note: custom instruction files (`.github/copilot-instructions.md`, `AGENTS.md`, etc.) - * are always loaded from the working directory regardless of this setting. + * Enables runtime discovery of supported configuration. Explicitly supplied + * configuration takes precedence over discovered values. * * @default false */ @@ -1675,6 +2326,14 @@ export interface SessionConfigBase { */ extensionInfo?: ExtensionInfo; + /** + * Stable identity for a host/SDK connection that supplies built-in + * canvases. When set, the runtime uses `id` verbatim as the agent-facing + * canvas extension id, so canvases declared on a control connection survive + * reconnect and CLI restart. Honored on session create and resume. + */ + canvasProvider?: CanvasProviderIdentity; + /** * Slash commands registered for this session. * When the CLI has a TUI, each command appears as `/name` for the user to invoke. @@ -1688,6 +2347,15 @@ export interface SessionConfigBase { */ systemMessage?: SystemMessageConfig; + /** + * Override for the runtime's built-in tool-search behavior. + * + * To also override the tool-search tool's implementation, register a + * {@link Tool} named `tool_search_tool` with `overridesBuiltInTool: true` in + * {@link SessionConfigBase.tools}. + */ + toolSearch?: ToolSearchConfig; + /** * List of tool names to allow. When specified, only these tools will be available. * @@ -1711,12 +2379,52 @@ export interface SessionConfigBase { */ excludedTools?: string[] | ToolSet; + /** + * Names of built-in agents to exclude from the session. Excluded built-in + * agents are hidden from discovery and cannot be selected or invoked unless + * a custom agent with the same name is configured. + */ + excludedBuiltinAgents?: string[]; + /** * Custom provider configuration (BYOK - Bring Your Own Key). * When specified, uses the provided API endpoint instead of the Copilot API. */ provider?: ProviderConfig; + /** + * Provider-scoped options for the built-in Copilot API (CAPI), such as + * opting out of the WebSocket Responses transport. See + * {@link CapiSessionOptions}. + */ + capi?: CapiSessionOptions; + + /** + * Named BYOK provider connections (transport + credentials), referenced by + * {@link models} entries via {@link NamedProviderConfig.name}. + * + * Unlike the singular {@link provider} — which makes the entire session BYOK + * and bypasses Copilot API authentication — named providers are **additive**: + * they coexist with Copilot API auth so models from CAPI and one or more BYOK + * providers can be mixed within a single session and across sub-agents. + * Combining `providers`/`models` with {@link provider} is rejected. + * + * @experimental This is part of an experimental multi-provider BYOK surface + * and may change or be removed in future SDK or CLI releases. + */ + providers?: NamedProviderConfig[]; + + /** + * BYOK model definitions added to the session's selectable model list, each + * referencing a `providers[].name`. Each model surfaces under the + * provider-qualified selection id `providerName/id`, so BYOK ids never collide + * with — and cannot shadow — bare CAPI ids; duplicate selection ids are rejected. + * + * @experimental This is part of an experimental multi-provider BYOK surface + * and may change or be removed in future SDK or CLI releases. + */ + models?: ProviderModelConfig[]; + /** * Enables or disables internal session telemetry for this session. * When `false`, disables session telemetry. When omitted (the default) or `true`, @@ -1727,6 +2435,28 @@ export interface SessionConfigBase { */ enableSessionTelemetry?: boolean; + /** + * Enables native model citations for supported providers. + * + * @experimental + */ + enableCitations?: boolean; + + /** + * Opt in to capturing file changes for session rewind and cumulative session + * diff. On create, capture starts with the first turn. On resume, this can + * enable tracking only when the session still has a valid baseline; it cannot + * reconstruct changes from earlier untracked turns. + */ + enableFileChangeTracking?: boolean; + + /** + * Limits applied to this session's current accounting window. + * + * @experimental + */ + sessionLimits?: SessionLimitsConfig; + /** * When true, the runtime skips loading custom-instruction sources * (e.g. `.github/copilot-instructions.md`, `AGENTS.md`, `CLAUDE.md`). @@ -1771,6 +2501,13 @@ export interface SessionConfigBase { */ onPermissionRequest?: PermissionHandler; + /** + * Optional handler for MCP OAuth requests from MCP servers. + * When provided, the SDK can satisfy MCP server OAuth requests with + * host-provided token data or cancellation. + */ + onMcpAuthRequest?: McpAuthHandler; + /** * Handler for user input requests from the agent. * When provided, enables the ask_user tool allowing the agent to ask questions. @@ -1812,6 +2549,14 @@ export interface SessionConfigBase { */ enableMcpApps?: boolean; + /** + * Configuration for the built-in GitHub MCP server. + * + * `disableFormDeferral` only applies to the built-in GitHub MCP server and + * only has an effect when MCP Apps and form-backed GitHub tools are enabled. + */ + githubMcpToolConfig?: GitHubMcpToolConfig; + /** * Handler for exit-plan-mode requests from the agent. * When provided, enables `exitPlanMode.request` callbacks. @@ -1836,6 +2581,13 @@ export interface SessionConfigBase { */ workingDirectory?: string; + /** + * Additional directories the agent may access beyond the working directory. + * Relative paths are resolved against the session's working directory. + * Re-supply these directories when resuming a session. + */ + additionalDirectories?: string[]; + /** * Enable streaming of assistant message and reasoning chunks. * When true, ephemeral assistant.message_delta and assistant.reasoning_delta @@ -1921,6 +2673,13 @@ export interface SessionConfigBase { */ disabledSkills?: string[]; + /** + * Exact MCP server names to disable for this session. Disabled servers are not + * started or authenticated when creating or cold-resuming a session. Supplying + * this on a resident resume cannot stop servers that are already running. + */ + disabledMcpServers?: string[]; + /** * Infinite session configuration for persistent workspaces and automatic compaction. * When enabled (default), sessions automatically manage context limits and persist state. @@ -1928,6 +2687,11 @@ export interface SessionConfigBase { */ infiniteSessions?: InfiniteSessionConfig; + /** + * Memory configuration for the session. When omitted, the runtime default applies. + */ + memory?: MemoryConfiguration; + /** * GitHub token for per-session authentication. * When provided, the runtime resolves this token into a full GitHub identity @@ -1940,6 +2704,39 @@ export interface SessionConfigBase { */ gitHubToken?: string; + /** + * Opt-in: when true, the runtime self-fetches enterprise managed settings + * (bypass-permissions policy) at session bootstrap using the session's + * `gitHubToken`. Requires {@link SessionConfigBase.gitHubToken} to be set; + * if omitted, the runtime is expected to reject session creation (fail-closed). + */ + enableManagedSettings?: boolean; + + /** + * Host-injected enterprise managed settings for this session. + * + * Unlike {@link SessionConfigBase.enableManagedSettings} — which asks the + * runtime to *self-fetch* account/org and device policy — this field lets + * the host supply the managed policy directly. The runtime validates it + * with the same managed-permission parser it uses for fetched policy and + * composes it restrictively with any self-fetched (server) and + * device-managed (MDM) layers: `deny`/`ask` rules are unioned, every + * declared `allow` list must admit an operation, and + * `disableBypassPermissionsMode: "disable"` is deny-wins. + * + * This is startup-only. It is **not** persisted: it must be re-supplied on + * {@link CopilotClient.resumeSession | resume}, where it replaces the prior + * injected layer (omitting it clears the layer, so warm and cold resume + * behave identically). It may be combined with `enableManagedSettings`; + * when both are supplied the injected, server, and device restrictions all + * apply. + * + * Requires a Copilot runtime whose RPC schema includes `managedSettings`. + * Older runtimes may ignore this additive field, so hosts must not rely on + * injected policy until they ship a compatible runtime. + */ + managedSettings?: ManagedSettings; + /** * When true, skips embedding-based retrieval for this session. * Use in multitenant deployments to prevent cross-session information leakage @@ -2019,6 +2816,20 @@ export interface SessionConfigBase { * only if {@link CopilotClientOptions.sessionFs} is configured. */ createSessionFsProvider?: (session: CopilotSession) => SessionFsProvider; + + /** + * ExP assignment ("flight") data injected by a trusted integrator, in the + * same JSON shape the Copilot CLI fetches from the experimentation service + * (`CopilotExpAssignmentResponse`). When supplied, the runtime feeds it + * into the same feature-flag path as CLI-fetched assignments and stamps it + * onto telemetry and the CAPI request header. When absent, the session does + * not block on ExP. Intended for out-of-process integrators that fetch ExP + * data themselves; malformed payloads are dropped by the runtime + * (fail-open). Applies to both session creation and resume. + * + * @internal + */ + expAssignments?: CopilotExpAssignmentResponse; } /** @@ -2068,6 +2879,47 @@ export interface ResumeSessionConfig extends SessionConfigBase { openCanvases?: OpenCanvasInstance[]; } +/** + * Arguments passed to a {@link BearerTokenProvider} callback when the runtime needs a + * fresh bearer token for a BYOK provider. + * + * @experimental Part of the experimental managed-identity / bearer-token-provider + * surface and may change or be removed in future SDK or CLI releases. + */ +export interface ProviderTokenArgs { + /** + * Name of the BYOK provider needing a token. For the singular, whole-session + * {@link ProviderConfig} this is the implicit provider name (`"default"`); for + * {@link NamedProviderConfig} entries it is {@link NamedProviderConfig.name}. + * + * The callback closes over its own token scope/audience; the runtime is + * provider-agnostic and forwards only the provider name. + */ + readonly providerName: string; + + /** + * Id of the session that triggered this token request. A client-level shared + * callback registered for many sessions can use this to resolve the owning + * session (e.g. via the client's session lookup) to scope token acquisition + * or caching per session. + */ + readonly sessionId: string; +} + +/** + * Per-provider callback that resolves a bearer token on demand, returning the + * raw token string (without the `Bearer ` prefix). The Copilot SDK itself takes + * no Azure dependency: the consumer supplies this callback backed by their own + * identity library (for example `@azure/identity`'s + * `DefaultAzureCredential.getToken(scope)`), and the runtime calls it once before + * each outbound model request. The runtime does no caching of its own, so the + * callback (or the identity library it wraps) owns token caching and refresh. + * + * @experimental Part of the experimental managed-identity / bearer-token-provider + * surface and may change or be removed in future SDK or CLI releases. + */ +export type BearerTokenProvider = (args: ProviderTokenArgs) => Promise; + /** * Configuration for a custom API provider. */ @@ -2082,6 +2934,17 @@ export interface ProviderConfig { */ wireApi?: "completions" | "responses"; + /** + * Transport for OpenAI Responses requests. Defaults to "http". + * + * Set to "websockets" to deliver Responses API requests over a persistent + * WebSocket connection instead of HTTP. Useful for long-running, + * tool-call-heavy sessions that benefit from incremental + * `previous_response_id` continuations. Applies to OpenAI-compatible + * providers using `wireApi: "responses"`. + */ + transport?: "http" | "websockets"; + /** * API endpoint URL */ @@ -2099,12 +2962,26 @@ export interface ProviderConfig { */ bearerToken?: string; + /** + * Per-request bearer-token provider for managed-identity / on-demand auth. + * When set, the SDK keeps this function client-side (it is never serialized) + * and the runtime calls back into this client to acquire a token before each + * outbound request. The runtime does no caching of its own, so the callback + * owns token caching and refresh. When set alongside {@link apiKey} / + * {@link bearerToken}, this callback takes precedence: the runtime applies + * the token it returns as the `Authorization: Bearer` header for each + * request and does not send the static credential. + * + * @experimental + */ + bearerTokenProvider?: BearerTokenProvider; + /** * Azure-specific options */ azure?: { /** - * API version. Defaults to "2024-10-21". + * API version. When omitted, the runtime uses the GA versionless v1 route. */ apiVersion?: string; }; @@ -2146,8 +3023,147 @@ export interface ProviderConfig { } /** - * Options for sending a message to a session + * A named BYOK provider connection (transport + credentials only), referenced by + * {@link ProviderModelConfig} entries via {@link NamedProviderConfig.name}. + * + * Unlike the singular, whole-session {@link ProviderConfig} — which bypasses + * Copilot API authentication — named providers are **additive** and coexist with + * Copilot API auth, so CAPI and BYOK models can be mixed within one session and + * across sub-agents. See {@link SessionConfigBase.providers}. + * + * @experimental This type is part of an experimental multi-provider BYOK surface + * and may change or be removed in future SDK or CLI releases. */ +export interface NamedProviderConfig { + /** + * Stable identifier referenced by {@link ProviderModelConfig.provider}. + * Must not contain `/`. + */ + name: string; + + /** + * Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + */ + type?: "openai" | "azure" | "anthropic"; + + /** + * Wire API format (openai/azure only). Defaults to "completions". + */ + wireApi?: "completions" | "responses"; + + /** + * API endpoint URL. + */ + baseUrl: string; + + /** + * API key. Optional for local providers like Ollama. + */ + apiKey?: string; + + /** + * Bearer token for authentication. Sets the Authorization header directly. + * Takes precedence over {@link apiKey} when both are set. + */ + bearerToken?: string; + + /** + * Per-request bearer-token provider for managed-identity / on-demand auth. + * When set, the SDK keeps this function client-side (it is never serialized) + * and the runtime calls back into this client to acquire a token before each + * outbound request. The runtime does no caching of its own, so the callback + * owns token caching and refresh. When set alongside {@link apiKey} / + * {@link bearerToken}, this callback takes precedence: the runtime applies + * the token it returns as the `Authorization: Bearer` header for each + * request and does not send the static credential. + * + * @experimental + */ + bearerTokenProvider?: BearerTokenProvider; + + /** + * Azure-specific options. + */ + azure?: { + /** + * API version. When set, uses the versioned deployment route. When + * omitted, uses the GA versionless v1 route. + */ + apiVersion?: string; + }; + + /** + * Custom HTTP headers to include in all outbound requests to the provider. + */ + headers?: Record; +} + +/** + * A BYOK model definition that references a {@link NamedProviderConfig} by name + * and is added to the session's selectable model list. + * + * Each model has three identities: + * - {@link id}: the provider-local model id, unique within its provider. The + * session-wide selection id (shown in the model list and passed to model + * switching) is the provider-qualified `provider/id`. + * - {@link modelId}: the well-known behavior base model used for + * capability/config lookup. Defaults to {@link id}. + * - {@link wireModel}: the model name actually sent to the provider API for + * inference. Defaults to {@link id}. + * + * @experimental This type is part of an experimental multi-provider BYOK surface + * and may change or be removed in future SDK or CLI releases. + */ +export interface ProviderModelConfig { + /** + * Provider-local model id, unique within its provider. The session-wide + * selection id is the provider-qualified `provider/id`. + */ + id: string; + + /** + * Name of the {@link NamedProviderConfig} that serves this model. + */ + provider: string; + + /** + * The model name sent to the provider API for inference. Defaults to {@link id}. + */ + wireModel?: string; + + /** + * Well-known base model id used for behavior/capability/config lookup. + * Defaults to {@link id}. + */ + modelId?: string; + + /** + * Display name for model pickers. Defaults to the provider-qualified + * selection id (`provider/id`). + */ + name?: string; + + /** + * Maximum prompt/input tokens for the model. + */ + maxPromptTokens?: number; + + /** + * Maximum context window tokens for the model. + */ + maxContextWindowTokens?: number; + + /** + * Maximum output tokens for the model. + */ + maxOutputTokens?: number; + + /** + * Optional capability overrides (vision, tool_calls, reasoning, etc.) for + * the synthesized model. + */ + capabilities?: ModelCapabilitiesOverride; +} export interface MessageOptions { /** * The prompt/message to send @@ -2376,7 +3392,10 @@ export interface ModelPolicy { * Model billing information */ export interface ModelBilling { + /** Billing cost multiplier relative to the base rate */ multiplier?: number; + /** Token-level pricing information for this model */ + tokenPrices?: ModelBillingTokenPrices; } /** diff --git a/nodejs/test/client.test.ts b/nodejs/test/client.test.ts index 3a1e83460..841aa599d 100644 --- a/nodejs/test/client.test.ts +++ b/nodejs/test/client.test.ts @@ -1,10 +1,17 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ +import { EventEmitter } from "node:events"; +import { PassThrough } from "stream"; +import { mkdtempSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join, resolve } from "node:path"; import { describe, expect, it, onTestFinished, vi } from "vitest"; import { approveAll, + createAttributedPermissionResult, CopilotClient, createCanvas, RuntimeConnection, + type GitHubTelemetryNotification, type ModelInfo, } from "../src/index.js"; import { CopilotSession } from "../src/session.js"; @@ -12,7 +19,106 @@ import { defaultJoinSessionPermissionHandler } from "../src/types.js"; // This file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.test.ts instead +async function stopClient(client: CopilotClient): Promise { + await client.stop(); +} + +describe("approveAll", () => { + const request = { + kind: "url" as const, + url: "https://api.example.com/data", + intention: "Fetch domain data", + }; + const invocation = { sessionId: "session-1", managedSettingsEnabled: false }; + + it("approves ordinary permission requests", () => { + expect(approveAll(request, invocation)).toEqual({ kind: "approve-once" }); + }); + + it("rejects managed settings sessions", () => { + expect(() => approveAll(request, { ...invocation, managedSettingsEnabled: true })).toThrow( + "approveAll cannot be used when managed settings are enabled" + ); + }); + + it("leaves managed requests pending when managed settings are disabled", () => { + expect(approveAll({ ...request, managedApprovalRequired: true }, invocation)).toEqual({ + kind: "no-result", + }); + }); + + it("fails closed when managed approval metadata is malformed", () => { + const malformedRequest = { + ...request, + managedApprovalRequired: "yes", + } as unknown as Parameters[0]; + + expect(approveAll(malformedRequest, invocation)).toEqual({ kind: "no-result" }); + }); +}); + describe("CopilotClient", () => { + async function startWithMockConnection( + builtinPluginDirectories?: readonly string[] + ): Promise> { + const client = new CopilotClient({ + connection: RuntimeConnection.forUri("localhost:1234"), + builtinPluginDirectories, + }); + const sendRequest = vi.fn(async () => ({})); + vi.spyOn(client as any, "connectToServer").mockImplementation(async () => { + (client as any).connection = { sendRequest }; + }); + vi.spyOn(client as any, "verifyProtocolVersion").mockResolvedValue(undefined); + + await client.start(); + return sendRequest; + } + + it.each([undefined, []])( + "does not configure built-in plugin directories when unset or empty", + async (builtinPluginDirectories) => { + const sendRequest = await startWithMockConnection(builtinPluginDirectories); + + expect(sendRequest).not.toHaveBeenCalledWith("plugins.builtin.set", expect.anything()); + } + ); + + it("configures built-in plugin directories before start completes", async () => { + const paths = [resolve("plugins/core"), resolve("plugins/github")]; + + const sendRequest = await startWithMockConnection(paths); + + expect(sendRequest).toHaveBeenCalledTimes(1); + expect(sendRequest).toHaveBeenCalledWith("plugins.builtin.set", { paths }); + }); + + it("rejects relative built-in plugin directories", () => { + expect( + () => + new CopilotClient({ + connection: RuntimeConnection.forUri("localhost:1234"), + builtinPluginDirectories: ["plugins/core"], + }) + ).toThrow(/builtinPluginDirectories.*absolute paths.*plugins\/core/); + }); + + it("disposes the stdio connection when child stdin emits an error", async () => { + const client = new CopilotClient(); + onTestFinished(() => client.forceStop()); + + const stdin = new PassThrough(); + const stdout = new PassThrough(); + (client as any).cliProcess = { stdin, stdout }; + await (client as any).connectToChildProcessViaStdio(); + + const dispose = vi.spyOn((client as any).connection, "dispose"); + + const boom = new Error("broken pipe"); + expect(() => stdin.emit("error", boom)).not.toThrow(); + expect(dispose).toHaveBeenCalledOnce(); + }); + it("does not respond to v3 permission requests when handler returns no-result", async () => { const session = new CopilotSession("session-1", {} as any); session.registerPermissionHandler(() => ({ kind: "no-result" })); @@ -23,10 +129,413 @@ describe("CopilotClient", () => { expect(spy).not.toHaveBeenCalled(); }); + it("forwards decisionContext as a top-level sibling of result", async () => { + const session = new CopilotSession("session-1", {} as any); + const decisionContext = { + outcome: "auto_approved" as const, + source: "host_policy" as const, + surface: "sdk" as const, + }; + session.registerPermissionHandler(() => + createAttributedPermissionResult({ kind: "approve-once" }, decisionContext) + ); + const spy = vi + .spyOn(session.rpc.permissions, "handlePendingPermissionRequest") + .mockResolvedValue({ kind: "approve-once" } as any); + + await (session as any)._executePermissionAndRespond("request-1", { kind: "write" }); + + expect(spy).toHaveBeenCalledOnce(); + const params = spy.mock.calls[0][0] as any; + expect(params).toEqual({ + requestId: "request-1", + result: { kind: "approve-once" }, + decisionContext, + }); + // decisionContext is a sibling of result, never nested inside it. + expect(params.result.decisionContext).toBeUndefined(); + }); + + it("emits exactly requestId and result with no decisionContext key when unattributed", async () => { + const session = new CopilotSession("session-1", {} as any); + session.registerPermissionHandler(() => ({ kind: "approve-once" })); + const spy = vi + .spyOn(session.rpc.permissions, "handlePendingPermissionRequest") + .mockResolvedValue({ kind: "approve-once" } as any); + + await (session as any)._executePermissionAndRespond("request-1", { kind: "write" }); + + expect(spy).toHaveBeenCalledOnce(); + const params = spy.mock.calls[0][0] as any; + expect(params).toEqual({ requestId: "request-1", result: { kind: "approve-once" } }); + expect(Object.keys(params).sort()).toEqual(["requestId", "result"]); + expect("decisionContext" in params).toBe(false); + }); + + it("does not respond when a no-result decision is wrapped with a context", async () => { + const session = new CopilotSession("session-1", {} as any); + const decisionContext = { + outcome: "auto_approved" as const, + source: "host_policy" as const, + surface: "sdk" as const, + }; + session.registerPermissionHandler(() => + createAttributedPermissionResult({ kind: "no-result" }, decisionContext) + ); + const spy = vi.spyOn(session.rpc.permissions, "handlePendingPermissionRequest"); + + await (session as any)._executePermissionAndRespond("request-1", { kind: "write" }); + + expect(spy).not.toHaveBeenCalled(); + }); + + it("replaces the context when applied twice", () => { + const first = { + outcome: "auto_approved" as const, + source: "judge_recommendation" as const, + surface: "sdk" as const, + }; + const second = { + outcome: "prompted_user" as const, + source: "human_response" as const, + surface: "tui" as const, + }; + + const once = createAttributedPermissionResult({ kind: "approve-once" }, first); + const twice = createAttributedPermissionResult(once, second); + + expect(twice).toEqual({ + kind: "attributed", + result: { kind: "approve-once" }, + decisionContext: second, + }); + // The result stays unwrapped rather than nesting an AttributedPermissionResult. + expect((twice.result as any).result).toBeUndefined(); + expect((twice.result as any).decisionContext).toBeUndefined(); + }); + + it("responds to MCP OAuth requests with host token data", async () => { + const sendRequest = vi.fn(async () => ({ success: true })); + let observedRequest: any; + const session = new CopilotSession( + "session-1", + { sendRequest } as any, + undefined, + undefined, + { + mcpAuthHandler: async (request) => { + observedRequest = request; + return { + accessToken: "host-token", + tokenType: "Bearer", + expiresIn: 3600, + }; + }, + } + ); + + await (session as any)._executeMcpAuthAndRespond({ + requestId: "oauth-request", + serverName: "oauth-server", + serverUrl: "https://example.com/mcp", + reason: "initial", + wwwAuthenticateParams: { + resourceMetadataUrl: "https://example.com/.well-known/oauth-protected-resource", + }, + resourceMetadata: '{"resource":"https://example.com/mcp"}', + staticClientConfig: { + clientId: "static-client", + clientSecret: "static-secret", + grantType: "client_credentials", + publicClient: false, + }, + }); + + expect(observedRequest.resourceMetadata).toBe('{"resource":"https://example.com/mcp"}'); + expect(observedRequest.staticClientConfig).toEqual({ + clientId: "static-client", + clientSecret: "static-secret", + grantType: "client_credentials", + publicClient: false, + }); + expect(sendRequest).toHaveBeenCalledWith("session.mcp.oauth.handlePendingRequest", { + sessionId: "session-1", + requestId: "oauth-request", + result: { + kind: "token", + accessToken: "host-token", + tokenType: "Bearer", + expiresIn: 3600, + }, + }); + }); + + it("forwards GitHub MCP tool config on create and resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + const githubMcpToolConfig = { + enableAllTools: true, + additionalToolsets: ["repos"], + additionalTools: ["get_issue"], + enableInsidersMode: true, + disableFormDeferral: true, + }; + + const session = await client.createSession({ githubMcpToolConfig }); + await client.resumeSession(session.sessionId, { githubMcpToolConfig }); + + expect(spy.mock.calls.find(([method]) => method === "session.create")![1]).toMatchObject({ + githubMcpToolConfig, + }); + expect(spy.mock.calls.find(([method]) => method === "session.resume")![1]).toMatchObject({ + githubMcpToolConfig, + }); + }); + + it("omits GitHub MCP tool config when unset", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({}); + + expect( + spy.mock.calls.find(([method]) => method === "session.create")![1] + ).not.toHaveProperty("githubMcpToolConfig"); + }); + + it("passes MCP OAuth requests through when optional metadata is absent", async () => { + let observedRequest: any; + const session = new CopilotSession( + "session-1", + { sendRequest: vi.fn(async () => ({ success: true })) } as any, + undefined, + undefined, + { + mcpAuthHandler: async (request) => { + observedRequest = request; + return { kind: "cancelled" }; + }, + } + ); + + await (session as any)._executeMcpAuthAndRespond({ + requestId: "oauth-request", + serverName: "oauth-server", + serverUrl: "https://example.com/mcp", + reason: "initial", + }); + + expect(observedRequest.reason).toBe("initial"); + expect(observedRequest.resourceMetadata).toBeUndefined(); + expect(observedRequest.wwwAuthenticateParams).toBeUndefined(); + }); + + it("registers interest in MCP OAuth required events after create when an auth handler is configured", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.eventLog.registerInterest") { + return { id: "interest-1" }; + } + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + onMcpAuthRequest: () => ({ kind: "cancelled" }), + }); + + expect(spy.mock.calls[0][0]).toBe("session.create"); + expect(spy.mock.calls[1]).toEqual([ + "session.eventLog.registerInterest", + expect.objectContaining({ eventType: "mcp.oauth_required" }), + ]); + expect(spy.mock.calls[1][1].sessionId).toBe(spy.mock.calls[0][1].sessionId); + }); + + it("does not register MCP OAuth interest without an auth handler", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + onEvent: () => {}, + }); + + expect(spy).not.toHaveBeenCalledWith( + "session.eventLog.registerInterest", + expect.objectContaining({ eventType: "mcp.oauth_required" }) + ); + expect(spy).toHaveBeenCalledWith( + "session.create", + expect.objectContaining({ requestPermission: true }) + ); + }); + + it("forwards additional directories when creating and resuming sessions", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create" || method === "session.resume") { + return { sessionId: params.sessionId, workspacePath: "/workspace" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + sessionId: "create-with-additional-directories", + additionalDirectories: ["/repo/shared", "/repo/generated"], + onPermissionRequest: approveAll, + }); + await client.resumeSession("resume-with-additional-directories", { + additionalDirectories: ["/repo/resumed"], + onPermissionRequest: approveAll, + }); + + expect(spy).toHaveBeenCalledWith( + "session.create", + expect.objectContaining({ + additionalDirectories: ["/repo/shared", "/repo/generated"], + }) + ); + expect(spy).toHaveBeenCalledWith( + "session.resume", + expect.objectContaining({ additionalDirectories: ["/repo/resumed"] }) + ); + }); + + it("registers MCP OAuth interest after cloud create only when an auth handler is configured", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + let cloudCreateCount = 0; + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, _params: any) => { + if (method === "session.eventLog.registerInterest") { + return { id: "interest-1" }; + } + if (method === "session.create") + return { sessionId: `server-assigned-session-${++cloudCreateCount}` }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + cloud: { repository: { owner: "github", name: "copilot-sdk", branch: "main" } }, + }); + + expect(spy).not.toHaveBeenCalledWith( + "session.eventLog.registerInterest", + expect.objectContaining({ eventType: "mcp.oauth_required" }) + ); + + spy.mockClear(); + await client.createSession({ + onPermissionRequest: approveAll, + onMcpAuthRequest: () => ({ kind: "cancelled" }), + cloud: { repository: { owner: "github", name: "copilot-sdk", branch: "main" } }, + }); + + expect(spy.mock.calls[0][0]).toBe("session.create"); + expect(spy.mock.calls[1]).toEqual([ + "session.eventLog.registerInterest", + { sessionId: "server-assigned-session-2", eventType: "mcp.oauth_required" }, + ]); + }); + + it("registers MCP OAuth interest after resuming only when an auth handler is configured", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.eventLog.registerInterest") { + return { id: "interest-1" }; + } + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSession("session-with-auth", { + onPermissionRequest: approveAll, + onMcpAuthRequest: () => ({ kind: "cancelled" }), + }); + + // `session.eventLog.registerInterest` is session-scoped: the runtime only + // registers the session id while handling `session.resume`, so resume must + // be sent BEFORE registering interest. + const resumeIndex = spy.mock.calls.findIndex(([method]) => method === "session.resume"); + const interestIndex = spy.mock.calls.findIndex( + ([method]) => method === "session.eventLog.registerInterest" + ); + expect(resumeIndex).toBeGreaterThanOrEqual(0); + expect(interestIndex).toBeGreaterThanOrEqual(0); + expect(resumeIndex).toBeLessThan(interestIndex); + expect(spy.mock.calls[resumeIndex][1]).toEqual( + expect.objectContaining({ sessionId: "session-with-auth", requestPermission: true }) + ); + expect(spy.mock.calls[interestIndex][1]).toEqual({ + sessionId: "session-with-auth", + eventType: "mcp.oauth_required", + }); + + spy.mockClear(); + await client.resumeSession("session-without-auth", { + onPermissionRequest: approveAll, + onEvent: () => {}, + }); + + expect(spy).not.toHaveBeenCalledWith( + "session.eventLog.registerInterest", + expect.objectContaining({ eventType: "mcp.oauth_required" }) + ); + expect(spy).toHaveBeenCalledWith( + "session.resume", + expect.objectContaining({ sessionId: "session-without-auth", requestPermission: true }) + ); + }); + it("forwards canvas declarations and request flags in session.create", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const canvas = createCanvas({ id: "counter", @@ -49,6 +558,7 @@ describe("CopilotClient", () => { requestCanvasRenderer: true, requestExtensions: true, extensionInfo: { source: "github-app", name: "counter-provider" }, + canvasProvider: { id: "app:builtin:window-1", name: "Built-in" }, }); const payload = spy.mock.calls.find(([method]) => method === "session.create")![1] as any; @@ -66,50 +576,589 @@ describe("CopilotClient", () => { source: "github-app", name: "counter-provider", }); + expect(payload.canvasProvider).toEqual({ + id: "app:builtin:window-1", + name: "Built-in", + }); + }); + + it("forwards canvas declarations in session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + const canvas = createCanvas({ + id: "counter", + displayName: "Counter", + description: "A counter canvas", + open: () => ({ url: "https://example.test/counter" }), + }); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + canvases: [canvas], + requestCanvasRenderer: true, + requestExtensions: true, + extensionInfo: { source: "github-app", name: "counter-provider" }, + canvasProvider: { id: "app:builtin:window-1" }, + }); + + const payload = spy.mock.calls.find(([method]) => method === "session.resume")![1] as any; + expect(payload.canvases).toEqual([expect.objectContaining({ id: "counter" })]); + expect(payload.requestCanvasRenderer).toBe(true); + expect(payload.requestExtensions).toBe(true); + expect(payload.extensionInfo).toEqual({ + source: "github-app", + name: "counter-provider", + }); + expect(payload.canvasProvider).toEqual({ id: "app:builtin:window-1" }); + expect(payload.openCanvasInstances).toBeUndefined(); + }); + + it("forwards reasoningSummary in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + reasoningSummary: "concise", + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + reasoningSummary: "none", + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.reasoningSummary).toBe("concise"); + expect(resumePayload.reasoningSummary).toBe("none"); + }); + + it("forwards enableExperimentalMode in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => client.forceStop()); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableExperimentalMode: false, + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + enableExperimentalMode: true, + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.isExperimentalMode).toBe(false); + expect(resumePayload.isExperimentalMode).toBe(true); + }); + + it("defaults enableExperimentalMode by client mode", async () => { + const baseDirectory = mkdtempSync(join(tmpdir(), "copilot-sdk-node-empty-")); + const emptyClient = new CopilotClient({ mode: "empty", baseDirectory }); + await emptyClient.start(); + onTestFinished(() => emptyClient.forceStop()); + + const emptySpy = vi + .spyOn((emptyClient as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + if (method === "session.options.update") return {}; + throw new Error(`Unexpected method: ${method}`); + }); + + const emptySession = await emptyClient.createSession({ + onPermissionRequest: approveAll, + availableTools: [], + }); + await emptyClient.resumeSession(emptySession.sessionId, { + onPermissionRequest: approveAll, + availableTools: [], + }); + + const emptyCreatePayload = emptySpy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const emptyResumePayload = emptySpy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(emptyCreatePayload.isExperimentalMode).toBe(false); + expect(emptyResumePayload.isExperimentalMode).toBe(false); + + const cliClient = new CopilotClient(); + await cliClient.start(); + onTestFinished(() => cliClient.forceStop()); + + const cliSpy = vi + .spyOn((cliClient as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const cliSession = await cliClient.createSession({ + onPermissionRequest: approveAll, + }); + await cliClient.resumeSession(cliSession.sessionId, { + onPermissionRequest: approveAll, + }); + + const cliCreatePayload = cliSpy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const cliResumePayload = cliSpy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(cliCreatePayload.isExperimentalMode).toBeUndefined(); + expect(cliResumePayload.isExperimentalMode).toBeUndefined(); + }); + + it("forwards contextTier in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + contextTier: "long_context", + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + contextTier: "default", + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.contextTier).toBe("long_context"); + expect(resumePayload.contextTier).toBe("default"); + }); + + it("forwards tool metadata verbatim in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => client.forceStop()); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const metadata = { + "github.com/copilot:safeForTelemetry": { name: true, inputsNames: false }, + }; + const tool = { + name: "my_tool", + description: "a tool", + parameters: { type: "object", properties: {} }, + metadata, + }; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + tools: [tool], + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + tools: [tool], + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.tools[0].metadata).toEqual(metadata); + expect(resumePayload.tools[0].metadata).toEqual(metadata); + }); + + it("omits tool metadata from session.create when unset", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => client.forceStop()); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + tools: [{ name: "my_tool", description: "a tool" }], + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + expect(createPayload.tools[0].metadata).toBeUndefined(); + }); + + it("forwards tool isTerminal in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => client.forceStop()); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const tool = { + name: "clear_context", + description: "Clears the conversation", + parameters: { type: "object", properties: {} }, + isTerminal: true, + }; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + tools: [tool], + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + tools: [tool], + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.tools[0].isTerminal).toBe(true); + expect(resumePayload.tools[0].isTerminal).toBe(true); + }); + + it("omits tool isTerminal from session.create when unset", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => client.forceStop()); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + tools: [{ name: "my_tool", description: "a tool" }], + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + expect(createPayload.tools[0].isTerminal).toBeUndefined(); + }); + + it("forwards new session options in session.create and session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableCitations: true, + enableFileChangeTracking: true, + excludedBuiltinAgents: ["explore"], + sessionLimits: { maxAiCredits: 30 }, + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + enableCitations: false, + enableFileChangeTracking: false, + excludedBuiltinAgents: ["task"], + sessionLimits: { maxAiCredits: 15 }, + }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.enableCitations).toBe(true); + expect(createPayload.enableFileChangeTracking).toBe(true); + expect(createPayload.excludedBuiltinAgents).toEqual(["explore"]); + expect(createPayload.sessionLimits).toEqual({ maxAiCredits: 30 }); + expect(resumePayload.enableCitations).toBe(false); + expect(resumePayload.enableFileChangeTracking).toBe(false); + expect(resumePayload.excludedBuiltinAgents).toEqual(["task"]); + expect(resumePayload.sessionLimits).toEqual({ maxAiCredits: 15 }); + }); + + it("opts into GitHub telemetry forwarding when onGitHubTelemetry is provided", async () => { + const client = new CopilotClient({ onGitHubTelemetry: () => {} }); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.enableGitHubTelemetryForwarding).toBe(true); + expect(resumePayload.enableGitHubTelemetryForwarding).toBe(true); + }); + + it("opts into GitHub telemetry forwarding on the connect handshake when a handler is provided", async () => { + const client = new CopilotClient({ onGitHubTelemetry: () => {} }); + onTestFinished(() => stopClient(client)); + + const sendRequest = vi.fn(async (method: string) => { + if (method === "connect") return { ok: true, protocolVersion: 3, version: "test" }; + throw new Error(`Unexpected method: ${method}`); + }); + (client as any).connection = { sendRequest }; + + await (client as any).verifyProtocolVersion(); + + const connectCall = sendRequest.mock.calls.find(([method]) => method === "connect"); + expect(connectCall).toBeDefined(); + expect((connectCall![1] as any).enableGitHubTelemetryForwarding).toBe(true); + }); + + it("does not opt into GitHub telemetry forwarding on the connect handshake without a handler", async () => { + const client = new CopilotClient(); + onTestFinished(() => stopClient(client)); + + const sendRequest = vi.fn(async (method: string) => { + if (method === "connect") return { ok: true, protocolVersion: 3, version: "test" }; + throw new Error(`Unexpected method: ${method}`); + }); + (client as any).connection = { sendRequest }; + + await (client as any).verifyProtocolVersion(); + + const connectCall = sendRequest.mock.calls.find(([method]) => method === "connect"); + expect(connectCall).toBeDefined(); + expect((connectCall![1] as any).enableGitHubTelemetryForwarding).toBeUndefined(); + }); + + it("does not opt into GitHub telemetry forwarding without a handler", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ onPermissionRequest: approveAll }); + + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + expect(createPayload.enableGitHubTelemetryForwarding).toBeUndefined(); + }); + + it("dispatches a real gitHubTelemetry.event wire message to the handler", async () => { + const { createMessageConnection, StreamMessageReader, StreamMessageWriter } = + await import("vscode-jsonrpc/node.js"); + const { registerClientGlobalApiHandlers } = await import("../src/generated/rpc.js"); + + const clientToServer = new PassThrough(); + const serverToClient = new PassThrough(); + + const clientConn = createMessageConnection( + new StreamMessageReader(serverToClient), + new StreamMessageWriter(clientToServer) + ); + const serverConn = createMessageConnection( + new StreamMessageReader(clientToServer), + new StreamMessageWriter(serverToClient) + ); + onTestFinished(() => { + clientConn.dispose(); + serverConn.dispose(); + }); + + const received: GitHubTelemetryNotification[] = []; + let resolveReceived: () => void; + const got = new Promise((resolve) => { + resolveReceived = resolve; + }); + + registerClientGlobalApiHandlers(clientConn, { + gitHubTelemetry: { + event: async (notification) => { + received.push(notification); + resolveReceived(); + }, + }, + }); + + clientConn.listen(); + serverConn.listen(); + + const notification: GitHubTelemetryNotification = { + sessionId: "session-1", + restricted: false, + event: { + kind: "tool_call_executed", + properties: { tool: "shell" }, + metrics: { duration_ms: 42 }, + }, + }; + + // Deliver the event as a real JSON-RPC *notification* (no id) and confirm + // the generated dispatcher routes it to the registered handler. The runtime + // forwards telemetry via `sendNotification`, which only fires `onNotification` + // handlers — an `onRequest` registration would never be invoked, so sending a + // notification here guards against regressing back to request-style dispatch. + serverConn.sendNotification("gitHubTelemetry.event", notification); + await got; + + expect(received).toEqual([notification]); + }); + + it("registers no gitHubTelemetry handler when onGitHubTelemetry is omitted", () => { + const client = new CopilotClient(); + onTestFinished(() => stopClient(client)); + + const handlers = (client as any).clientGlobalHandlers; + expect(handlers.gitHubTelemetry).toBeUndefined(); + }); + + it("forwards gitHubTelemetry events to the onGitHubTelemetry handler", () => { + const received: GitHubTelemetryNotification[] = []; + const client = new CopilotClient({ onGitHubTelemetry: (n) => received.push(n) }); + onTestFinished(() => stopClient(client)); + + const handlers = (client as any).clientGlobalHandlers; + expect(handlers.gitHubTelemetry).toBeDefined(); + + const notification: GitHubTelemetryNotification = { + sessionId: "session-1", + restricted: false, + event: { kind: "tool_call_executed", properties: {}, metrics: {} }, + }; + handlers.gitHubTelemetry.event(notification); + expect(received).toEqual([notification]); }); - it("forwards canvas declarations in session.resume", async () => { + it("forwards expAssignments in session.create and session.resume", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); - const session = await client.createSession({ onPermissionRequest: approveAll }); - const canvas = createCanvas({ - id: "counter", - displayName: "Counter", - description: "A counter canvas", - open: () => ({ url: "https://example.test/counter" }), - }); const spy = vi .spyOn((client as any).connection!, "sendRequest") .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; if (method === "session.resume") return { sessionId: params.sessionId }; throw new Error(`Unexpected method: ${method}`); }); + const assignments = { + Features: ["copilot_exp_flag"], + Flights: { copilot_exp_flag: "treatment" }, + Configs: [{ Id: "cfg-1", Parameters: { threshold: 5, enabled: true } }], + AssignmentContext: "ctx-123", + }; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + expAssignments: assignments, + }); await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll, - canvases: [canvas], - requestCanvasRenderer: true, - requestExtensions: true, - extensionInfo: { source: "github-app", name: "counter-provider" }, + expAssignments: assignments, }); - const payload = spy.mock.calls.find(([method]) => method === "session.resume")![1] as any; - expect(payload.canvases).toEqual([expect.objectContaining({ id: "counter" })]); - expect(payload.requestCanvasRenderer).toBe(true); - expect(payload.requestExtensions).toBe(true); - expect(payload.extensionInfo).toEqual({ - source: "github-app", - name: "counter-provider", - }); - expect(payload.openCanvasInstances).toBeUndefined(); + const createPayload = spy.mock.calls.find( + ([method]) => method === "session.create" + )![1] as any; + const resumePayload = spy.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as any; + expect(createPayload.expAssignments).toEqual(assignments); + expect(resumePayload.expAssignments).toEqual(assignments); }); - it("forwards reasoningSummary in session.create and session.resume", async () => { + it("omits expAssignments from session.create and session.resume when unset", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -119,14 +1168,8 @@ describe("CopilotClient", () => { throw new Error(`Unexpected method: ${method}`); }); - const session = await client.createSession({ - onPermissionRequest: approveAll, - reasoningSummary: "concise", - }); - await client.resumeSession(session.sessionId, { - onPermissionRequest: approveAll, - reasoningSummary: "none", - }); + const session = await client.createSession({ onPermissionRequest: approveAll }); + await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll }); const createPayload = spy.mock.calls.find( ([method]) => method === "session.create" @@ -134,14 +1177,14 @@ describe("CopilotClient", () => { const resumePayload = spy.mock.calls.find( ([method]) => method === "session.resume" )![1] as any; - expect(createPayload.reasoningSummary).toBe("concise"); - expect(resumePayload.reasoningSummary).toBe("none"); + expect(createPayload.expAssignments).toBeUndefined(); + expect(resumePayload.expAssignments).toBeUndefined(); }); - it("forwards contextTier in session.create and session.resume", async () => { + it("forwards capi options in session.create and session.resume", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -153,11 +1196,11 @@ describe("CopilotClient", () => { const session = await client.createSession({ onPermissionRequest: approveAll, - contextTier: "long_context", + capi: { enableWebSocketResponses: false }, }); await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll, - contextTier: "default", + capi: { enableWebSocketResponses: false }, }); const createPayload = spy.mock.calls.find( @@ -166,14 +1209,14 @@ describe("CopilotClient", () => { const resumePayload = spy.mock.calls.find( ([method]) => method === "session.resume" )![1] as any; - expect(createPayload.contextTier).toBe("long_context"); - expect(resumePayload.contextTier).toBe("default"); + expect(createPayload.capi).toEqual({ enableWebSocketResponses: false }); + expect(resumePayload.capi).toEqual({ enableWebSocketResponses: false }); }); it("forwards pluginDirectories and largeOutput in session.create and session.resume", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -184,6 +1227,7 @@ describe("CopilotClient", () => { }); const pluginDirs = ["/tmp/plugins/a", "/tmp/plugins/b"]; + const disabledMcpServers = ["local-files", "remote-github"]; const largeOutput = { enabled: true, maxSizeBytes: 1024, @@ -198,11 +1242,13 @@ describe("CopilotClient", () => { const session = await client.createSession({ onPermissionRequest: approveAll, pluginDirectories: pluginDirs, + disabledMcpServers, largeOutput, }); await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll, pluginDirectories: pluginDirs, + disabledMcpServers, largeOutput, }); @@ -213,8 +1259,10 @@ describe("CopilotClient", () => { ([method]) => method === "session.resume" )![1] as any; expect(createPayload.pluginDirectories).toEqual(pluginDirs); + expect(createPayload.disabledMcpServers).toEqual(disabledMcpServers); expect(createPayload.largeOutput).toEqual(expectedWireLargeOutput); expect(resumePayload.pluginDirectories).toEqual(pluginDirs); + expect(resumePayload.disabledMcpServers).toEqual(disabledMcpServers); expect(resumePayload.largeOutput).toEqual(expectedWireLargeOutput); }); @@ -265,8 +1313,6 @@ describe("CopilotClient", () => { status: "ready", url: "https://example.test/counter", input: { seed: 1 }, - reopen: false, - availability: "ready", }, }); (session as any)._dispatchEvent({ @@ -276,8 +1322,6 @@ describe("CopilotClient", () => { canvasId: "logs", instanceId: "logs-1", title: "Logs", - reopen: false, - availability: "stale", }, }); @@ -298,8 +1342,6 @@ describe("CopilotClient", () => { status: "reconnected", url: "https://example.test/counter-updated", input: { seed: 2 }, - reopen: true, - availability: "stale", }, }); @@ -310,13 +1352,70 @@ describe("CopilotClient", () => { status: "reconnected", url: "https://example.test/counter-updated", input: { seed: 2 }, - reopen: true, - availability: "stale", }); expect(session.openCanvases[1].instanceId).toBe("logs-1"); warn.mockRestore(); }); + it("removes open canvases on live session.canvas.closed events", () => { + const session = new CopilotSession("session-1", {} as any); + const warn = vi.spyOn(console, "warn").mockImplementation(() => {}); + + (session as any)._dispatchEvent({ + type: "session.canvas.opened", + data: { + extensionId: "project:counter", + canvasId: "counter", + instanceId: "counter-1", + title: "Counter", + }, + }); + (session as any)._dispatchEvent({ + type: "session.canvas.opened", + data: { + extensionId: "project:logs", + canvasId: "logs", + instanceId: "logs-1", + title: "Logs", + }, + }); + expect(session.openCanvases.map((canvas) => canvas.instanceId)).toEqual([ + "counter-1", + "logs-1", + ]); + + // Closing one instance removes it; the other remains. + (session as any)._dispatchEvent({ + type: "session.canvas.closed", + data: { + extensionId: "project:counter", + canvasId: "counter", + instanceId: "counter-1", + }, + }); + expect(session.openCanvases.map((canvas) => canvas.instanceId)).toEqual(["logs-1"]); + + // Closing an absent instance is a no-op (idempotent). + (session as any)._dispatchEvent({ + type: "session.canvas.closed", + data: { + extensionId: "project:counter", + canvasId: "counter", + instanceId: "counter-1", + }, + }); + expect(session.openCanvases.map((canvas) => canvas.instanceId)).toEqual(["logs-1"]); + + // A closed event missing instanceId warns and leaves the snapshot intact. + (session as any)._dispatchEvent({ + type: "session.canvas.closed", + data: { extensionId: "project:logs", canvasId: "logs" }, + }); + expect(warn).toHaveBeenCalledWith("failed to deserialize session.canvas.closed payload"); + expect(session.openCanvases.map((canvas) => canvas.instanceId)).toEqual(["logs-1"]); + warn.mockRestore(); + }); + it("returns canvas_action_no_handler when no per-action handler is registered", async () => { const canvas = createCanvas({ id: "counter", @@ -363,7 +1462,7 @@ describe("CopilotClient", () => { it("forwards clientName in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ clientName: "my-app", onPermissionRequest: approveAll }); @@ -377,7 +1476,7 @@ describe("CopilotClient", () => { it("forwards cloud options in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -402,7 +1501,7 @@ describe("CopilotClient", () => { it("forwards clientName in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); // Mock sendRequest to capture the call without hitting the runtime @@ -427,7 +1526,7 @@ describe("CopilotClient", () => { it("forwards enableSessionTelemetry in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -444,7 +1543,7 @@ describe("CopilotClient", () => { it("forwards enableSessionTelemetry in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -468,7 +1567,7 @@ describe("CopilotClient", () => { it("forwards enableOnDemandInstructionDiscovery in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -485,7 +1584,7 @@ describe("CopilotClient", () => { it("forwards enableOnDemandInstructionDiscovery in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -512,7 +1611,7 @@ describe("CopilotClient", () => { it("defaults includeSubAgentStreamingEvents to true in session.create when not specified", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ onPermissionRequest: approveAll }); @@ -524,7 +1623,7 @@ describe("CopilotClient", () => { it("forwards explicit false for includeSubAgentStreamingEvents in session.create", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -539,7 +1638,7 @@ describe("CopilotClient", () => { it("defaults includeSubAgentStreamingEvents to true in session.resume when not specified", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -558,7 +1657,7 @@ describe("CopilotClient", () => { it("forwards explicit false for includeSubAgentStreamingEvents in session.resume", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -580,7 +1679,7 @@ describe("CopilotClient", () => { it("defaults mcpOAuthTokenStorage to 'in-memory' in session.create when mode is empty", async () => { const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -598,7 +1697,7 @@ describe("CopilotClient", () => { it("does not send mcpOAuthTokenStorage in session.create when mode is copilot-cli", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ onPermissionRequest: approveAll }); @@ -610,7 +1709,7 @@ describe("CopilotClient", () => { it("forwards explicit 'persistent' for mcpOAuthTokenStorage in session.create", async () => { const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -632,7 +1731,7 @@ describe("CopilotClient", () => { it("defaults mcpOAuthTokenStorage to 'in-memory' in session.resume when mode is empty", async () => { const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -652,7 +1751,7 @@ describe("CopilotClient", () => { it("forwards explicit 'persistent' for mcpOAuthTokenStorage in session.resume", async () => { const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -665,18 +1764,173 @@ describe("CopilotClient", () => { await client.createSession({ onPermissionRequest: approveAll, availableTools: [] }); await client.resumeSession("s1", { onPermissionRequest: approveAll, - availableTools: [], - mcpOAuthTokenStorage: "persistent", + availableTools: [], + mcpOAuthTokenStorage: "persistent", + }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.mcpOAuthTokenStorage).toBe("persistent"); + }); + + it("defaults memory to { enabled: false } in session.create when mode is empty", async () => { + const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId ?? "s1" }; + if (method === "session.options.update") return {}; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ onPermissionRequest: approveAll, availableTools: [] }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(payload.memory).toEqual({ enabled: false }); + }); + + it("does not send memory in session.create when mode is copilot-cli", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi.spyOn((client as any).connection!, "sendRequest"); + await client.createSession({ onPermissionRequest: approveAll }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(payload.memory).toBeUndefined(); + }); + + it("forwards explicit memory config in session.create even in empty mode", async () => { + const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId ?? "s1" }; + if (method === "session.options.update") return {}; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ + onPermissionRequest: approveAll, + availableTools: [], + memory: { enabled: true }, + }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(payload.memory).toEqual({ enabled: true }); + }); + + it("defaults memory to { enabled: false } in session.resume when mode is empty", async () => { + const client = new CopilotClient({ mode: "empty", baseDirectory: "/tmp/copilot-test" }); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId ?? "s1" }; + if (method === "session.resume") return { sessionId: params.sessionId }; + if (method === "session.options.update") return {}; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ onPermissionRequest: approveAll, availableTools: [] }); + await client.resumeSession("s1", { onPermissionRequest: approveAll, availableTools: [] }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.memory).toEqual({ enabled: false }); + }); + + it("does not send memory in session.resume when mode is copilot-cli", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.memory).toBeUndefined(); + spy.mockRestore(); + }); + + it("forwards continuePendingWork in session.resume request", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + continuePendingWork: true, + }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.continuePendingWork).toBe(true); + spy.mockRestore(); + }); + + it("omits continuePendingWork from session.resume payload when not specified", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.continuePendingWork).toBeUndefined(); + spy.mockRestore(); + }); + + it("forwards memory configuration in session.create request", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") + return { sessionId: params.sessionId ?? "session-id" }; + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + onPermissionRequest: approveAll, + memory: { enabled: true }, }); - const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; - expect(payload.mcpOAuthTokenStorage).toBe("persistent"); + const payload = spy.mock.calls.find(([method]) => method === "session.create")![1] as any; + expect(payload.memory).toEqual({ enabled: true }); + spy.mockRestore(); }); - it("forwards continuePendingWork in session.resume request", async () => { + it("forwards memory configuration in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -687,37 +1941,39 @@ describe("CopilotClient", () => { }); await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll, - continuePendingWork: true, + memory: { enabled: false }, }); const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; - expect(payload.continuePendingWork).toBe(true); + expect(payload.memory).toEqual({ enabled: false }); spy.mockRestore(); }); - it("omits continuePendingWork from session.resume payload when not specified", async () => { + it("omits memory from session.create payload when not specified", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); - const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi .spyOn((client as any).connection!, "sendRequest") .mockImplementation(async (method: string, params: any) => { - if (method === "session.resume") return { sessionId: params.sessionId }; + if (method === "session.create") + return { sessionId: params.sessionId ?? "session-id" }; throw new Error(`Unexpected method: ${method}`); }); - await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll }); - const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; - expect(payload.continuePendingWork).toBeUndefined(); + await client.createSession({ onPermissionRequest: approveAll }); + + const payload = spy.mock.calls.find(([method]) => method === "session.create")![1] as any; + const serialized = JSON.parse(JSON.stringify(payload)); + expect(serialized).not.toHaveProperty("memory"); spy.mockRestore(); }); it("forwards provider headers in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi .spyOn((client as any).connection!, "sendRequest") @@ -736,6 +1992,7 @@ describe("CopilotClient", () => { wireModel: "my-finetune-v3", maxPromptTokens: 100_000, maxOutputTokens: 4096, + transport: "websockets", }, }); @@ -748,6 +2005,7 @@ describe("CopilotClient", () => { wireModel: "my-finetune-v3", maxPromptTokens: 100_000, maxOutputTokens: 4096, + transport: "websockets", }) ); spy.mockRestore(); @@ -756,7 +2014,7 @@ describe("CopilotClient", () => { it("forwards provider headers in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -775,6 +2033,7 @@ describe("CopilotClient", () => { wireModel: "my-finetune-v3", maxPromptTokens: 100_000, maxOutputTokens: 4096, + transport: "websockets", }, }); @@ -787,6 +2046,7 @@ describe("CopilotClient", () => { wireModel: "my-finetune-v3", maxPromptTokens: 100_000, maxOutputTokens: 4096, + transport: "websockets", }) ); spy.mockRestore(); @@ -795,7 +2055,7 @@ describe("CopilotClient", () => { it("forwards defaultAgent in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -814,7 +2074,7 @@ describe("CopilotClient", () => { it("forwards defaultAgent in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi.spyOn((client as any).connection!, "sendRequest"); @@ -834,7 +2094,7 @@ describe("CopilotClient", () => { it("forwards instructionDirectories in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const instructionDirectories = ["C:\\extra-instructions", "C:\\more-instructions"]; const spy = vi.spyOn((client as any).connection!, "sendRequest"); @@ -852,7 +2112,7 @@ describe("CopilotClient", () => { it("forwards instructionDirectories in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const instructionDirectories = ["C:\\resume-instructions"]; @@ -880,7 +2140,7 @@ describe("CopilotClient", () => { it("does not request permissions on session.resume when using the default joinSession handler", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -907,7 +2167,7 @@ describe("CopilotClient", () => { it("requests permissions on session.resume when using an explicit handler", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -934,7 +2194,7 @@ describe("CopilotClient", () => { it("forwards mode callback request flags in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -964,7 +2224,7 @@ describe("CopilotClient", () => { it("sends session.model.switchTo RPC with correct params", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); @@ -990,7 +2250,7 @@ describe("CopilotClient", () => { it("sends reasoning options with session.model.switchTo when provided", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); @@ -1004,6 +2264,7 @@ describe("CopilotClient", () => { await session.setModel("claude-sonnet-4.6", { reasoningEffort: "high", reasoningSummary: "detailed", + contextTier: "long_context", }); expect(spy).toHaveBeenCalledWith("session.model.switchTo", { @@ -1011,6 +2272,7 @@ describe("CopilotClient", () => { modelId: "claude-sonnet-4.6", reasoningEffort: "high", reasoningSummary: "detailed", + contextTier: "long_context", }); spy.mockRestore(); @@ -1230,13 +2492,84 @@ describe("CopilotClient", () => { /gitHubToken and useLoggedInUser cannot be used with RuntimeConnection.forUri/ ); }); + + it("should throw error when env is used with forInProcess", () => { + expect(() => { + new CopilotClient({ + connection: RuntimeConnection.forInProcess(), + env: { FOO: "bar" }, + logLevel: "error", + }); + }).toThrow(/env is not supported with RuntimeConnection.forInProcess/); + }); + + it("should throw error when telemetry is used with forInProcess", () => { + expect(() => { + new CopilotClient({ + connection: RuntimeConnection.forInProcess(), + telemetry: { otlpEndpoint: "http://localhost:4318" }, + logLevel: "error", + }); + }).toThrow(/telemetry is not supported with RuntimeConnection.forInProcess/); + }); + + it("should throw error when workingDirectory is used with forInProcess", () => { + expect(() => { + new CopilotClient({ + connection: RuntimeConnection.forInProcess(), + workingDirectory: "/tmp", + logLevel: "error", + }); + }).toThrow(/workingDirectory is not supported with RuntimeConnection.forInProcess/); + }); + + it("should throw error when env is set on both the client and a stdio connection", () => { + expect(() => { + new CopilotClient({ + connection: RuntimeConnection.forStdio({ env: { FOO: "conn" } }), + env: { FOO: "client" }, + logLevel: "error", + }); + }).toThrow( + /Set environment variables via either the client-level env option or the connection/ + ); + }); + + it("should throw error when env is set on both the client and a tcp connection", () => { + expect(() => { + new CopilotClient({ + connection: RuntimeConnection.forTcp({ env: { FOO: "conn" } }), + env: { FOO: "client" }, + logLevel: "error", + }); + }).toThrow( + /Set environment variables via either the client-level env option or the connection/ + ); + }); + + it("should use the connection-level env for child-process transports", () => { + const client = new CopilotClient({ + connection: RuntimeConnection.forStdio({ env: { FOO: "from-conn" } }), + logLevel: "error", + }); + expect((client as any).resolvedEnv).toEqual({ FOO: "from-conn" }); + }); + + it("should allow env on the client alone with a child-process transport", () => { + const client = new CopilotClient({ + connection: RuntimeConnection.forStdio(), + env: { FOO: "from-client" }, + logLevel: "error", + }); + expect((client as any).resolvedEnv).toEqual({ FOO: "from-client" }); + }); }); describe("overridesBuiltInTool in tool definitions", () => { it("sends overridesBuiltInTool in tool definition on session.create", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -1260,7 +2593,7 @@ describe("CopilotClient", () => { it("sends overridesBuiltInTool in tool definition on session.resume", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); // Mock sendRequest to capture the call without hitting the runtime @@ -1290,11 +2623,68 @@ describe("CopilotClient", () => { }); }); + describe("defer in tool definitions", () => { + it("sends defer in tool definition on session.create", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi.spyOn((client as any).connection!, "sendRequest"); + await client.createSession({ + onPermissionRequest: approveAll, + tools: [ + { + name: "lookup_issue", + description: "Fetch issue details", + handler: async () => "ok", + defer: "auto", + }, + ], + }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; + expect(payload.tools).toEqual([ + expect.objectContaining({ name: "lookup_issue", defer: "auto" }), + ]); + }); + + it("sends defer in tool definition on session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const session = await client.createSession({ onPermissionRequest: approveAll }); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession(session.sessionId, { + onPermissionRequest: approveAll, + tools: [ + { + name: "lookup_issue", + description: "Fetch issue details", + handler: async () => "ok", + defer: "auto", + }, + ], + }); + + const payload = spy.mock.calls.find((c) => c[0] === "session.resume")![1] as any; + expect(payload.tools).toEqual([ + expect.objectContaining({ name: "lookup_issue", defer: "auto" }), + ]); + spy.mockRestore(); + }); + }); + describe("agent parameter in session creation", () => { it("forwards agent in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -1311,12 +2701,13 @@ describe("CopilotClient", () => { const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; expect(payload.agent).toBe("test-agent"); expect(payload.customAgents).toEqual([expect.objectContaining({ name: "test-agent" })]); + expect(payload.customAgents[0].reasoningEffort).toBeUndefined(); }); - it("forwards custom agent model in session.create request", async () => { + it("forwards custom agent model and reasoning effort in session.create request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -1326,20 +2717,25 @@ describe("CopilotClient", () => { name: "model-agent", prompt: "You are a model agent.", model: "claude-haiku-4.5", + reasoningEffort: "high", }, ], }); const payload = spy.mock.calls.find((c) => c[0] === "session.create")![1] as any; expect(payload.customAgents).toEqual([ - expect.objectContaining({ name: "model-agent", model: "claude-haiku-4.5" }), + expect.objectContaining({ + name: "model-agent", + model: "claude-haiku-4.5", + reasoningEffort: "high", + }), ]); }); it("forwards agent in session.resume request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -1375,17 +2771,34 @@ describe("CopilotClient", () => { supports: { vision: false, reasoningEffort: false }, limits: { max_context_window_tokens: 128000 }, }, + billing: { + multiplier: 1.5, + tokenPrices: { + inputPrice: 2.0, + outputPrice: 8.0, + cachePrice: 0.5, + batchSize: 1000000, + contextMax: 128000, + longContext: { + inputPrice: 4.0, + outputPrice: 16.0, + cachePrice: 1.0, + contextMax: 1000000, + }, + }, + }, }, ]; const handler = vi.fn().mockReturnValue(customModels); const client = new CopilotClient({ onListModels: handler }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const models = await client.listModels(); expect(handler).toHaveBeenCalledTimes(1); expect(models).toEqual(customModels); + expect(models[0].billing?.tokenPrices?.longContext?.contextMax).toBe(1000000); }); it("caches onListModels results on subsequent calls", async () => { @@ -1403,7 +2816,7 @@ describe("CopilotClient", () => { const handler = vi.fn().mockReturnValue(customModels); const client = new CopilotClient({ onListModels: handler }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); await client.listModels(); await client.listModels(); @@ -1425,7 +2838,7 @@ describe("CopilotClient", () => { const handler = vi.fn().mockResolvedValue(customModels); const client = new CopilotClient({ onListModels: handler }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const models = await client.listModels(); expect(models).toEqual(customModels); @@ -1453,22 +2866,29 @@ describe("CopilotClient", () => { }); describe("unexpected disconnection", () => { - it("transitions to disconnected when child process is killed", async () => { - const client = new CopilotClient(); - await client.start(); - onTestFinished(() => client.forceStop()); - - expect((client as any).state).toBe("connected"); - - // Kill the child process to simulate unexpected termination - const proc = (client as any).cliProcess as import("node:child_process").ChildProcess; - proc.kill(); - - // Wait for the connection.onClose handler to fire - await vi.waitFor(() => { - expect((client as any).state).toBe("disconnected"); - }); - }); + // No child process exists over the in-process (FFI) transport, so this + // child-process-kill scenario does not apply there. Covered by the default + // (stdio) cell. + it.skipIf((process.env.COPILOT_SDK_DEFAULT_CONNECTION ?? "").toLowerCase() === "inprocess")( + "transitions to disconnected when child process is killed", + async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + expect((client as any).state).toBe("connected"); + + // Kill the child process to simulate unexpected termination + const proc = (client as any) + .cliProcess as import("node:child_process").ChildProcess; + proc.kill(); + + // Wait for the connection.onClose handler to fire + await vi.waitFor(() => { + expect((client as any).state).toBe("disconnected"); + }); + } + ); }); describe("onGetTraceContext", () => { @@ -1480,7 +2900,7 @@ describe("CopilotClient", () => { const provider = vi.fn().mockReturnValue(traceContext); const client = new CopilotClient({ onGetTraceContext: provider }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ onPermissionRequest: approveAll }); @@ -1502,7 +2922,7 @@ describe("CopilotClient", () => { const provider = vi.fn().mockReturnValue(traceContext); const client = new CopilotClient({ onGetTraceContext: provider }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -1528,7 +2948,7 @@ describe("CopilotClient", () => { const provider = vi.fn().mockReturnValue(traceContext); const client = new CopilotClient({ onGetTraceContext: provider }); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -1550,7 +2970,7 @@ describe("CopilotClient", () => { it("forwards requestHeaders in session.send request", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -1577,7 +2997,7 @@ describe("CopilotClient", () => { it("does not include trace context when no callback is provided", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ onPermissionRequest: approveAll }); @@ -1592,7 +3012,7 @@ describe("CopilotClient", () => { it("forwards commands in session.create RPC", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const spy = vi.spyOn((client as any).connection!, "sendRequest"); await client.createSession({ @@ -1613,7 +3033,7 @@ describe("CopilotClient", () => { it("forwards commands in session.resume RPC", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); const spy = vi @@ -1635,7 +3055,7 @@ describe("CopilotClient", () => { it("routes command.execute event to the correct handler", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const handler = vi.fn(); const session = await client.createSession({ @@ -1689,7 +3109,7 @@ describe("CopilotClient", () => { it("sends error when command handler throws", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll, @@ -1737,7 +3157,7 @@ describe("CopilotClient", () => { it("sends error for unknown command", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll, @@ -1783,7 +3203,7 @@ describe("CopilotClient", () => { it("reads capabilities from session.create response", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); // Intercept session.create to inject capabilities const origSendRequest = (client as any).connection!.sendRequest.bind( @@ -1809,7 +3229,7 @@ describe("CopilotClient", () => { it("defaults capabilities when not injected", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); // CLI returns actual capabilities (elicitation false in headless mode) @@ -1819,7 +3239,7 @@ describe("CopilotClient", () => { it("elicitation throws when capability is missing", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll }); @@ -1838,7 +3258,7 @@ describe("CopilotClient", () => { it("sends requestElicitation flag when onElicitationRequest is provided", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const rpcSpy = vi.spyOn((client as any).connection!, "sendRequest"); @@ -1864,7 +3284,7 @@ describe("CopilotClient", () => { it("does not send requestElicitation when no handler provided", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const rpcSpy = vi.spyOn((client as any).connection!, "sendRequest"); @@ -1886,7 +3306,7 @@ describe("CopilotClient", () => { it("sends mode callback request flags based on handler presence", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const rpcSpy = vi.spyOn((client as any).connection!, "sendRequest"); @@ -1921,7 +3341,7 @@ describe("CopilotClient", () => { it("dispatches mode callback requests to registered handlers", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll, @@ -1969,7 +3389,7 @@ describe("CopilotClient", () => { it("sends cancel when elicitation handler throws", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const session = await client.createSession({ onPermissionRequest: approveAll, @@ -2029,7 +3449,7 @@ describe("CopilotClient", () => { it("dispatches postToolUseFailure to onPostToolUseFailure handler", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const received: { input: any; invocation: any }[] = []; const session = await client.createSession({ @@ -2070,7 +3490,7 @@ describe("CopilotClient", () => { it("does not fall back to onPostToolUse for postToolUseFailure events", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const postUseCalls: string[] = []; const session = await client.createSession({ @@ -2099,7 +3519,7 @@ describe("CopilotClient", () => { it("dispatches postToolUse and postToolUseFailure to their respective handlers", async () => { const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const postCalls: string[] = []; const failureCalls: string[] = []; @@ -2137,19 +3557,50 @@ describe("CopilotClient", () => { expect(failureCalls).toEqual(["fail-tool"]); }); + it("registers hooks.invoke on the JSON-RPC connection and routes it to handleHooksInvoke", async () => { + const client = new CopilotClient(); + const handleHooksInvoke = vi + .spyOn(client as any, "handleHooksInvoke") + .mockResolvedValue({ output: { additionalContext: "ok" } }); + + const fakeConnection = { + onNotification: vi.fn(), + onRequest: vi.fn(), + onClose: vi.fn(), + onError: vi.fn(), + }; + + (client as any).connection = fakeConnection; + (client as any).attachConnectionHandlers(); + + const hooksRegistration = fakeConnection.onRequest.mock.calls.find( + ([method]: [string, unknown]) => method === "hooks.invoke" + ); + expect(hooksRegistration).toBeDefined(); + + const handler = hooksRegistration![1] as (params: { + sessionId: string; + hookType: string; + input: unknown; + }) => Promise<{ output?: unknown }>; + const payload = { + sessionId: "session-1", + hookType: "postToolUseFailure", + input: { toolName: "shell" }, + }; + + await expect(handler(payload)).resolves.toEqual({ + output: { additionalContext: "ok" }, + }); + expect(handleHooksInvoke).toHaveBeenCalledWith(payload); + }); + it("routes hooks.invoke JSON-RPC requests to the SessionHooks handler", async () => { - // Validates the full JSON-RPC entry point used by the CLI: - // CopilotClient.handleHooksInvoke({sessionId, hookType, input}) - // → CopilotSession._handleHooksInvoke(hookType, input) - // → SessionHooks.onPostToolUseFailure(normalizedInput, {sessionId}) - // - // This guards the wire-format contract that the bundled Copilot - // CLI relies on: the hookType string "postToolUseFailure" and the - // input shape `{toolName, toolArgs, error, timestamp, cwd}`. - // The SDK maps that to public `{..., timestamp: Date, workingDirectory}`. + // Validates the dispatch behavior for the internal `hooks.invoke` + // payload after the JSON-RPC connection hands it to the SDK. const client = new CopilotClient(); await client.start(); - onTestFinished(() => client.forceStop()); + onTestFinished(() => stopClient(client)); const received: { input: any; invocation: any }[] = []; const session = await client.createSession({ @@ -2191,5 +3642,253 @@ describe("CopilotClient", () => { output: { additionalContext: "context from failure hook" }, }); }); + + it("dispatches agentStop to onAgentStop and returns a block decision", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const received: { input: any; invocation: any }[] = []; + const session = await client.createSession({ + onPermissionRequest: approveAll, + hooks: { + onAgentStop: async (input, invocation) => { + received.push({ input, invocation }); + return { decision: "block", reason: "2 vulnerabilities found; please fix" }; + }, + }, + }); + + const result = await (session as any)._handleHooksInvoke("agentStop", { + stopReason: "end_turn", + transcriptPath: "/tmp/transcript.jsonl", + stop_hook_active: true, + timestamp: 1700000000000, + cwd: "/repo", + }); + + expect(received).toHaveLength(1); + expect(received[0].input).toEqual({ + stopReason: "end_turn", + transcriptPath: "/tmp/transcript.jsonl", + stopHookActive: true, + timestamp: new Date(1700000000000), + workingDirectory: "/repo", + }); + expect(received[0].invocation.sessionId).toBe(session.sessionId); + expect(result).toEqual({ + decision: "block", + reason: "2 vulnerabilities found; please fix", + }); + }); + + it("routes agentStop hooks.invoke JSON-RPC requests to onAgentStop", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const received: { input: any }[] = []; + const session = await client.createSession({ + onPermissionRequest: approveAll, + hooks: { + onAgentStop: async (input) => { + received.push({ input }); + // Returning nothing lets the agent stop normally. + }, + }, + }); + + const response = await (client as any).handleHooksInvoke({ + sessionId: session.sessionId, + hookType: "agentStop", + input: { + stopReason: "end_turn", + stop_hook_active: true, + timestamp: 1700000000000, + cwd: "/repo", + }, + }); + + expect(received).toHaveLength(1); + expect(received[0].input).toEqual({ + stopReason: "end_turn", + stopHookActive: true, + timestamp: new Date(1700000000000), + workingDirectory: "/repo", + }); + // No decision returned — the SDK forwards an empty output envelope. + expect(response).toEqual({ output: undefined }); + }); + }); + + describe("shutdown", () => { + it("requests runtime shutdown when stopping an SDK-owned process", async () => { + const client = new CopilotClient(); + const calls: string[] = []; + const child = new EventEmitter() as EventEmitter & { + exitCode: number | null; + signalCode: string | null; + kill: ReturnType; + }; + child.exitCode = null; + child.signalCode = null; + child.kill = vi.fn(() => { + calls.push("kill"); + child.signalCode = "SIGTERM"; + child.emit("exit", null, "SIGTERM"); + return true; + }); + + (client as any).connection = { + sendRequest: vi.fn(async (method: string) => { + calls.push(method); + if (method === "runtime.shutdown") { + child.exitCode = 0; + child.emit("exit", 0, null); + return {}; + } + throw new Error(`unexpected method ${method}`); + }), + dispose: vi.fn(() => calls.push("dispose")), + }; + (client as any).cliProcess = child; + (client as any).isExternalServer = false; + + await expect(client.stop()).resolves.toEqual([]); + expect(calls).toEqual(["runtime.shutdown", "dispose"]); + expect(child.kill).not.toHaveBeenCalled(); + }); + + it("does not request runtime shutdown for force stop or external runtimes", async () => { + const forceClient = new CopilotClient(); + const forceChild = new EventEmitter() as EventEmitter & { + exitCode: number | null; + signalCode: string | null; + kill: ReturnType; + }; + forceChild.exitCode = null; + forceChild.signalCode = null; + forceChild.kill = vi.fn(() => true); + const forceSendRequest = vi.fn(); + (forceClient as any).connection = { + sendRequest: forceSendRequest, + dispose: vi.fn(), + }; + (forceClient as any).cliProcess = forceChild; + (forceClient as any).isExternalServer = false; + + await forceClient.forceStop(); + expect(forceSendRequest).not.toHaveBeenCalled(); + expect(forceChild.kill).toHaveBeenCalledWith("SIGKILL"); + + const externalClient = new CopilotClient(); + const externalSendRequest = vi.fn(); + (externalClient as any).connection = { + sendRequest: externalSendRequest, + dispose: vi.fn(), + }; + (externalClient as any).isExternalServer = true; + + await expect(externalClient.stop()).resolves.toEqual([]); + expect(externalSendRequest).not.toHaveBeenCalled(); + }); + }); +}); + +describe("managedSettings serialization", () => { + async function captureCreateParams(config: Record): Promise { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.createSession({ onPermissionRequest: approveAll, ...config }); + const call = spy.mock.calls.find(([method]) => method === "session.create"); + return call![1]; + } + + it("forwards the full permissions object on session.create", async () => { + const params = await captureCreateParams({ + managedSettings: { + permissions: { + disableBypassPermissionsMode: "disable", + deny: ["Shell(git push)"], + ask: ["Domain(publish.example)"], + allow: ["Read(**)"], + }, + }, + }); + expect(params.managedSettings).toEqual({ + permissions: { + disableBypassPermissionsMode: "disable", + deny: ["Shell(git push)"], + ask: ["Domain(publish.example)"], + allow: ["Read(**)"], + }, + }); + }); + + it("marks directly injected sessions as managed", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + vi.spyOn((client as any).connection!, "sendRequest").mockImplementation( + async (method: string, params: any) => { + if (method === "session.create") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + } + ); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + managedSettings: { permissions: { deny: ["Edit(/secrets/**)"] } }, + }); + + expect((session as any).managedSettingsEnabled).toBe(true); + }); + + it("omits managedSettings when not supplied", async () => { + const params = await captureCreateParams({}); + expect(params.managedSettings).toBeUndefined(); + }); + + it("coexists with enableManagedSettings", async () => { + const params = await captureCreateParams({ + enableManagedSettings: true, + managedSettings: { permissions: { deny: ["Edit(/secrets/**)"] } }, + }); + expect(params.enableManagedSettings).toBe(true); + expect(params.managedSettings).toEqual({ permissions: { deny: ["Edit(/secrets/**)"] } }); + }); + + it("preserves empty arrays in the permissions object", async () => { + const params = await captureCreateParams({ + managedSettings: { permissions: { deny: [], ask: [], allow: [] } }, + }); + expect(params.managedSettings).toEqual({ permissions: { deny: [], ask: [], allow: [] } }); + }); + + it("forwards managedSettings on session.resume", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.resume") return { sessionId: params.sessionId }; + throw new Error(`Unexpected method: ${method}`); + }); + await client.resumeSession("session-1", { + onPermissionRequest: approveAll, + managedSettings: { permissions: { ask: ["Domain(publish.example)"] } }, + }); + const call = spy.mock.calls.find(([method]) => method === "session.resume"); + expect(call![1].managedSettings).toEqual({ + permissions: { ask: ["Domain(publish.example)"] }, + }); }); }); diff --git a/nodejs/test/e2e/abort.e2e.test.ts b/nodejs/test/e2e/abort.e2e.test.ts index 87d91fc5e..89877387c 100644 --- a/nodejs/test/e2e/abort.e2e.test.ts +++ b/nodejs/test/e2e/abort.e2e.test.ts @@ -58,11 +58,32 @@ describe("Abort", async () => { // Abort mid-stream await session.abort(); - // Session should be usable after abort — send a follow-up and get a response - const followUp = await session.sendAndWait({ - prompt: "Say 'abort_recovery_ok'.", + // Session should be usable after abort. Wait for the specific recovery + // message rather than racing against a late idle from the aborted turn. + let recoveryResolve!: (content: string) => void; + const recoveryReceived = new Promise((resolve) => { + recoveryResolve = resolve; + }); + const unsubscribeRecovery = session.on((event) => { + if (event.type === "assistant.message") { + const content = event.data.content ?? ""; + if (content.toLowerCase().includes("abort_recovery_ok")) { + recoveryResolve(content); + } + } }); - expect(followUp?.data.content?.toLowerCase()).toContain("abort_recovery_ok"); + + try { + await session.send({ prompt: "Say 'abort_recovery_ok'." }); + const recoveryContent = await withTimeout( + recoveryReceived, + 60_000, + "assistant.message containing abort_recovery_ok" + ); + expect(recoveryContent.toLowerCase()).toContain("abort_recovery_ok"); + } finally { + unsubscribeRecovery(); + } await session.disconnect(); }); diff --git a/nodejs/test/e2e/builtin_tools.e2e.test.ts b/nodejs/test/e2e/builtin_tools.e2e.test.ts index 127dae588..36b70ea19 100644 --- a/nodejs/test/e2e/builtin_tools.e2e.test.ts +++ b/nodejs/test/e2e/builtin_tools.e2e.test.ts @@ -8,93 +8,158 @@ import { describe, expect, it } from "vitest"; import { approveAll } from "../../src/index.js"; import { createSdkTestContext } from "./harness/sdkTestContext"; +// Built-in tool tests spawn a real CLI subprocess and execute actual shell / +// file tools. Under slow/concurrent CI (notably Windows) this agent loop can +// briefly exceed the default send/test timeouts, so give it extra headroom +// while still failing fast on a genuine hang. The per-test timeout must clear +// the send timeout (and the global 30s vitest testTimeout, which would +// otherwise bind first). +const SEND_TIMEOUT_MS = 120_000; +const TEST_TIMEOUT_MS = 180_000; + describe("Built-in Tools", async () => { const { copilotClient: client, workDir } = await createSdkTestContext(); describe("bash", () => { - it("should capture exit code in output", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Run 'echo hello && echo world'. Tell me the exact output.", - }); - expect(msg?.data.content).toContain("hello"); - expect(msg?.data.content).toContain("world"); - }); + it( + "should capture exit code in output", + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Run 'echo hello && echo world'. Tell me the exact output.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("hello"); + expect(msg?.data.content).toContain("world"); + }, + TEST_TIMEOUT_MS + ); - it.skipIf(process.platform === "win32")("should capture stderr output", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.", - }); - expect(msg?.data.content).toContain("error_msg"); - }); + it.skipIf(process.platform === "win32")( + "should capture stderr output", + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. Reply with just the stderr content.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("error_msg"); + }, + TEST_TIMEOUT_MS + ); }); describe("view", () => { - it("should read file with line range", async () => { - await writeFile(join(workDir, "lines.txt"), "line1\nline2\nline3\nline4\nline5\n"); - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.", - }); - expect(msg?.data.content).toContain("line2"); - expect(msg?.data.content).toContain("line4"); - }); + it( + "should read file with line range", + async () => { + await writeFile(join(workDir, "lines.txt"), "line1\nline2\nline3\nline4\nline5\n"); + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("line2"); + expect(msg?.data.content).toContain("line4"); + }, + TEST_TIMEOUT_MS + ); - it("should handle nonexistent file gracefully", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.", - }); - expect(msg?.data.content?.toUpperCase()).toMatch( - /NOT.FOUND|NOT.EXIST|NO.SUCH|FILE_NOT_FOUND|DOES.NOT.EXIST|ERROR/i - ); - }); + it( + "should handle nonexistent file gracefully", + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content?.toUpperCase()).toMatch( + /NOT.FOUND|NOT.EXIST|NO.SUCH|FILE_NOT_FOUND|DOES.NOT.EXIST|ERROR/i + ); + }, + TEST_TIMEOUT_MS + ); }); describe("edit", () => { - it("should edit a file successfully", async () => { - await writeFile(join(workDir, "edit_me.txt"), "Hello World\nGoodbye World\n"); - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.", - }); - expect(msg?.data.content).toContain("Hi Universe"); - }); + it( + "should edit a file successfully", + async () => { + await writeFile(join(workDir, "edit_me.txt"), "Hello World\nGoodbye World\n"); + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("Hi Universe"); + }, + TEST_TIMEOUT_MS + ); }); describe("create_file", () => { - it("should create a new file", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.", - }); - expect(msg?.data.content).toContain("Created by test"); - }); + it( + "should create a new file", + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("Created by test"); + }, + TEST_TIMEOUT_MS + ); }); describe("grep", () => { - it("should search for patterns in files", async () => { - await writeFile(join(workDir, "data.txt"), "apple\nbanana\napricot\ncherry\n"); - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.", - }); - expect(msg?.data.content).toContain("apple"); - expect(msg?.data.content).toContain("apricot"); - }); + it( + "should search for patterns in files", + async () => { + await writeFile(join(workDir, "data.txt"), "apple\nbanana\napricot\ncherry\n"); + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("apple"); + expect(msg?.data.content).toContain("apricot"); + }, + TEST_TIMEOUT_MS + ); }); describe("glob", () => { - it("should find files by pattern", async () => { - await mkdir(join(workDir, "src"), { recursive: true }); - await writeFile(join(workDir, "src", "index.ts"), "export const index = 1;"); - await writeFile(join(workDir, "README.md"), "# Readme"); - const session = await client.createSession({ onPermissionRequest: approveAll }); - const msg = await session.sendAndWait({ - prompt: "Find all .ts files in this directory (recursively). List the filenames you found.", - }); - expect(msg?.data.content).toContain("index.ts"); - }); + it( + "should find files by pattern", + async () => { + await mkdir(join(workDir, "src"), { recursive: true }); + await writeFile(join(workDir, "src", "index.ts"), "export const index = 1;"); + await writeFile(join(workDir, "README.md"), "# Readme"); + const session = await client.createSession({ onPermissionRequest: approveAll }); + const msg = await session.sendAndWait( + { + prompt: "Find all .ts files in this directory (recursively). List the filenames you found.", + }, + SEND_TIMEOUT_MS + ); + expect(msg?.data.content).toContain("index.ts"); + }, + TEST_TIMEOUT_MS + ); }); }); diff --git a/nodejs/test/e2e/byok_bearer_token_provider.e2e.test.ts b/nodejs/test/e2e/byok_bearer_token_provider.e2e.test.ts new file mode 100644 index 000000000..c528fb23d --- /dev/null +++ b/nodejs/test/e2e/byok_bearer_token_provider.e2e.test.ts @@ -0,0 +1,259 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { beforeEach, describe, expect, it } from "vitest"; +import { approveAll, CopilotRequestHandler } from "../../src/index.js"; +import type { + CopilotRequestContext, + BearerTokenProvider, + NamedProviderConfig, + ProviderModelConfig, +} from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +/** + * A captured outbound HTTP request the runtime aimed at a fake BYOK provider + * endpoint: just the host and the `Authorization` header, which is all these + * tests need to assert on. + */ +interface CapturedRequest { + host: string; + authorization?: string; +} + +// Fake BYOK provider base URLs. These hosts are never actually dialed: the +// client-global request interceptor fully answers any request aimed at a +// `.invalid` host, so they only need to be syntactically valid, non-resolving +// URLs. Distinct hosts let the per-provider test assert routing by host. +const PRIMARY_HOST = "byok-endpoint.invalid"; +const PRIMARY_BASE_URL = `https://${PRIMARY_HOST}/v1`; +const RED_HOST = "byok-red.invalid"; +const RED_BASE_URL = `https://${RED_HOST}/v1`; +const BLUE_HOST = "byok-blue.invalid"; +const BLUE_BASE_URL = `https://${BLUE_HOST}/v1`; + +/** + * Client-global HTTP request interceptor (from the SDK's `CopilotRequestHandler` + * surface) used in place of a real HTTP listener. + * + * The runtime invokes {@link sendRequest} for every model-layer HTTP request it + * would otherwise issue. We capture the ones aimed at a fake BYOK host — + * recording the `Authorization` header the runtime applied after calling the + * provider's `bearerTokenProvider` callback over the session-scoped + * `providerToken.getToken` RPC — and answer them with a synthetic `404` (a + * non-retryable status, so each outbound model request yields exactly one + * capture). Every other request (CAPI bootstrap: model catalog, policy, …) is + * passed straight through to the real network via `super.sendRequest`. + * + * Because the handler is client-global (one per CLI process), it is installed + * once for the whole fixture and {@link reset} between tests. + */ +class CapturingRequestHandler extends CopilotRequestHandler { + public readonly captures: CapturedRequest[] = []; + + protected override async sendRequest( + request: Request, + ctx: CopilotRequestContext + ): Promise { + const url = new URL(request.url); + if (url.hostname.endsWith(".invalid")) { + this.captures.push({ + host: url.host, + authorization: request.headers.get("authorization") ?? undefined, + }); + return new Response(JSON.stringify({ error: { message: "fake byok endpoint" } }), { + status: 404, + headers: { "content-type": "application/json" }, + }); + } + return super.sendRequest(request, ctx); + } + + reset(): void { + this.captures.length = 0; + } + + /** The `Authorization` headers captured across BYOK requests, in arrival order. */ + authHeaders(): string[] { + return this.captures + .map((c) => c.authorization) + .filter((v): v is string => typeof v === "string"); + } + + /** The `Authorization` header captured for requests aimed at `host`, if any. */ + authHeaderForHost(host: string): string | undefined { + return this.captures.find((c) => c.host === host)?.authorization; + } +} + +/** + * End-to-end coverage for the experimental BYOK bearer-token-provider surface + * (`bearerTokenProvider` on a provider config). The callback stays entirely on the + * SDK/client side: the SDK strips it from the wire config, sets the + * `hasBearerTokenProvider` flag, and the runtime calls back over the session-scoped + * `providerToken.getToken` RPC before each outbound model request, applying the + * returned token as the `Authorization` header. + * + * Rather than standing up a real HTTP listener, these tests install a + * client-global {@link CapturingRequestHandler} that intercepts the runtime's + * outbound model request in-process, captures the `Authorization` header, and + * returns a synthetic response. They validate, against a real runtime: + * 1. the callback's token reaches the model request as `Authorization: Bearer `; + * 2. the runtime re-acquires a token per request (no runtime-side caching); + * 3. per-provider dispatch routes each provider's turn to its own callback, + * and the resulting token reaches that provider's endpoint. + */ +describe("BYOK bearer-token provider", async () => { + const handler = new CapturingRequestHandler(); + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { requestHandler: handler }, + }); + + beforeEach(() => { + handler.reset(); + }); + + /** Drive one BYOK turn; the synthetic 404 errors the turn, which is expected. */ + async function runTurn( + providers: NamedProviderConfig[], + models: ProviderModelConfig[], + selectionId: string, + prompt: string + ): Promise { + const session = await client.createSession({ + onPermissionRequest: approveAll, + model: selectionId, + providers, + models, + }); + try { + // The interceptor always 404s, so the turn errors after the runtime + // has already sent the (token-bearing) request — which is all we + // assert on. Swallow the resulting error. + await session.sendAndWait({ prompt }).catch(() => undefined); + } finally { + try { + await session.disconnect(); + } catch { + // ignore disconnect errors for the fake BYOK endpoint + } + } + } + + it("applies the callback's token as the Authorization header", async () => { + const SENTINEL = "sentinel-bearer-token-abc123"; + let calls = 0; + const getBearerToken: BearerTokenProvider = async () => { + calls += 1; + return SENTINEL; + }; + + const providers: NamedProviderConfig[] = [ + { + name: "mi", + type: "openai", + wireApi: "completions", + baseUrl: PRIMARY_BASE_URL, + bearerTokenProvider: getBearerToken, + }, + ]; + const models: ProviderModelConfig[] = [ + { id: "default", provider: "mi", wireModel: "byok-gpt-4o" }, + ]; + + await runTurn(providers, models, "mi/default", "What is 5+5?"); + + // The runtime acquired a token via the callback and applied it verbatim as + // the bearer credential on the outbound model request. + expect(handler.authHeaders()).toContain(`Bearer ${SENTINEL}`); + expect(calls).toBeGreaterThanOrEqual(1); + }); + + it("re-acquires a fresh token for each request (no runtime caching)", async () => { + let calls = 0; + const getBearerToken: BearerTokenProvider = async () => { + calls += 1; + // A distinct token per acquisition proves the runtime re-invokes the + // callback per request rather than caching a previous token. + return `rotating-token-${calls}`; + }; + + const providers: NamedProviderConfig[] = [ + { + name: "mi", + type: "openai", + wireApi: "completions", + baseUrl: PRIMARY_BASE_URL, + bearerTokenProvider: getBearerToken, + }, + ]; + const models: ProviderModelConfig[] = [ + { id: "default", provider: "mi", wireModel: "byok-gpt-4o" }, + ]; + + await runTurn(providers, models, "mi/default", "What is 1+1?"); + await runTurn(providers, models, "mi/default", "What is 2+2?"); + + // Each outbound request carries a freshly-acquired, distinct token. + const auths = handler.authHeaders(); + expect(auths.length).toBeGreaterThanOrEqual(2); + expect(auths[0]).toMatch(/^Bearer rotating-token-\d+$/); + expect(auths[1]).toMatch(/^Bearer rotating-token-\d+$/); + expect(auths[0]).not.toBe(auths[1]); + expect(calls).toBeGreaterThanOrEqual(2); + }); + + it("dispatches token acquisition per provider", async () => { + const tokenByProvider: Record = { + red: "token-for-red", + blue: "token-for-blue", + }; + const acquiredFor: string[] = []; + const makeCallback = + (providerName: string): BearerTokenProvider => + async (args) => { + // The runtime forwards the requesting provider's name so the client + // can dispatch to the right credential. + expect(args.providerName).toBe(providerName); + // The runtime also forwards the owning session id so a + // client-level shared callback can resolve the session. + expect(typeof args.sessionId).toBe("string"); + expect(args.sessionId.length).toBeGreaterThan(0); + acquiredFor.push(providerName); + return tokenByProvider[providerName]; + }; + + const providers: NamedProviderConfig[] = [ + { + name: "red", + type: "openai", + wireApi: "completions", + baseUrl: RED_BASE_URL, + bearerTokenProvider: makeCallback("red"), + }, + { + name: "blue", + type: "openai", + wireApi: "completions", + baseUrl: BLUE_BASE_URL, + bearerTokenProvider: makeCallback("blue"), + }, + ]; + const models: ProviderModelConfig[] = [ + { id: "default", provider: "red", wireModel: "byok-gpt-4o" }, + { id: "default", provider: "blue", wireModel: "byok-gpt-4o" }, + ]; + + await runTurn(providers, models, "red/default", "What is 3+3?"); + await runTurn(providers, models, "blue/default", "What is 4+4?"); + + // Each provider's turn was authenticated with its own token AND that token + // was delivered to that provider's endpoint, proving per-provider dispatch + // (not a single session-global credential). + expect(handler.authHeaderForHost(RED_HOST)).toBe(`Bearer ${tokenByProvider.red}`); + expect(handler.authHeaderForHost(BLUE_HOST)).toBe(`Bearer ${tokenByProvider.blue}`); + expect(acquiredFor).toContain("red"); + expect(acquiredFor).toContain("blue"); + }); +}); diff --git a/nodejs/test/e2e/client.e2e.test.ts b/nodejs/test/e2e/client.e2e.test.ts index 33b7a0636..35e744076 100644 --- a/nodejs/test/e2e/client.e2e.test.ts +++ b/nodejs/test/e2e/client.e2e.test.ts @@ -1,11 +1,12 @@ import { ChildProcess } from "child_process"; -import { describe, expect, it, onTestFinished } from "vitest"; -import { CopilotClient, approveAll, RuntimeConnection } from "../../src/index.js"; +import { describe, expect, it, onTestFinished, vi } from "vitest"; +import { approveAll, CopilotClient, RuntimeConnection } from "../../src/index.js"; +import { isInProcessTransport } from "./harness/sdkTestContext.js"; -function onTestFinishedForceStop(client: CopilotClient) { +function onTestFinishedStop(client: CopilotClient) { onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors - process may already be stopped } @@ -18,7 +19,7 @@ describe("Client", () => { { transport: "tcp", connection: () => RuntimeConnection.forTcp() }, ])("allows createSession without onPermissionRequest ($transport)", async ({ connection }) => { const client = new CopilotClient({ connection: connection() }); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await using session = await client.createSession({}); expect(session.sessionId).toMatch(/^[a-f0-9-]+$/); @@ -30,7 +31,7 @@ describe("Client", () => { const client = new CopilotClient({ connection: RuntimeConnection.forTcp({ connectionToken }), }); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await using originalSession = await client.createSession({}); @@ -42,7 +43,7 @@ describe("Client", () => { const resumeClient = new CopilotClient({ connection: RuntimeConnection.forUri(`localhost:${port}`, { connectionToken }), }); - onTestFinishedForceStop(resumeClient); + onTestFinishedStop(resumeClient); await using resumedSession = await resumeClient.resumeSession( originalSession.sessionId, @@ -53,7 +54,7 @@ describe("Client", () => { it("should start and connect to server using stdio", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -66,7 +67,7 @@ describe("Client", () => { it("should start and connect to server using tcp", async () => { const client = new CopilotClient({ connection: RuntimeConnection.forTcp() }); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -94,7 +95,12 @@ describe("Client", () => { const cliProcess = (client as any).cliProcess as ChildProcess; expect(cliProcess).toBeDefined(); cliProcess.kill("SIGKILL"); - await new Promise((resolve) => setTimeout(resolve, 100)); + await vi.waitFor( + () => { + expect((client as unknown as { state: string }).state).toBe("disconnected"); + }, + { timeout: 10_000 } + ); const errors = await client.stop(); if (errors.length > 0) { @@ -106,9 +112,14 @@ describe("Client", () => { 60_000 ); - it("should forceStop without cleanup", async () => { + // Skipping on in-proc: + // - It breaks the macOS E2E run (failure: EPIPE) + // - It's not clear that anyone should use forceStop in the in-proc case - there's no child process + // to terminate, so we can't be sure to leave a clean state + // - If you want to get to a clean state within your process, that's what "stop" (not "forceStop") is for + it.skipIf(isInProcessTransport)("should forceStop without cleanup", async () => { const client = new CopilotClient({}); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.createSession({ onPermissionRequest: approveAll }); await client.forceStop(); @@ -116,7 +127,7 @@ describe("Client", () => { it("should get status with version and protocol info", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -132,7 +143,7 @@ describe("Client", () => { it("should get auth status", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -148,7 +159,7 @@ describe("Client", () => { it("should list models when authenticated", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -177,7 +188,7 @@ describe("Client", () => { const client = new CopilotClient({ connection: RuntimeConnection.forStdio({ args: ["--nonexistent-flag-for-testing"] }), }); - onTestFinishedForceStop(client); + onTestFinishedStop(client); let initialError: Error | undefined; try { diff --git a/nodejs/test/e2e/client_api.e2e.test.ts b/nodejs/test/e2e/client_api.e2e.test.ts index 4adaad6ec..46c23cee6 100644 --- a/nodejs/test/e2e/client_api.e2e.test.ts +++ b/nodejs/test/e2e/client_api.e2e.test.ts @@ -44,6 +44,7 @@ describe("Client session management", async () => { await waitFor(async () => (await client.listSessions()).some((s) => s.sessionId === sessionId) ); + await session.abort(); await session.disconnect(); await client.deleteSession(sessionId); diff --git a/nodejs/test/e2e/client_options.e2e.test.ts b/nodejs/test/e2e/client_options.e2e.test.ts index dadce08e1..e3dc41343 100644 --- a/nodejs/test/e2e/client_options.e2e.test.ts +++ b/nodejs/test/e2e/client_options.e2e.test.ts @@ -6,8 +6,8 @@ import * as fs from "fs"; import * as net from "net"; import * as path from "path"; import { describe, expect, it, onTestFinished } from "vitest"; -import { approveAll, CopilotClient, RuntimeConnection } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { approveAll, CopilotClient, createCanvas, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; const FAKE_STDIO_CLI_SCRIPT = `const fs = require("fs"); @@ -29,6 +29,7 @@ function saveCapture() { COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN, COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT, + OTEL_EXPORTER_OTLP_PROTOCOL: process.env.OTEL_EXPORTER_OTLP_PROTOCOL, COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH, COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE, COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME, @@ -92,12 +93,23 @@ function handleMessage(message) { return; } - if (message.method === "session.create") { + if (message.method === "session.create" || message.method === "session.resume") { const sessionId = message.params?.sessionId ?? message.params?.[0]?.sessionId ?? "fake-session"; writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null }); return; } + if (message.method === "session.resume") { + const sessionId = message.params?.sessionId ?? message.params?.[0]?.sessionId ?? "fake-session"; + writeResponse(message.id, { + sessionId, + workspacePath: null, + capabilities: null, + openCanvases: message.params?.openCanvases ?? [] + }); + return; + } + writeResponse(message.id, {}); } @@ -137,6 +149,27 @@ function assertArgumentValue( expect(args[index + 1]).toBe(expectedValue); } +function getCapturedRequest(capturePath: string, method: string): Record { + const raw = fs.readFileSync(capturePath, "utf8"); + const capture = JSON.parse(raw) as { + requests: { method: string; params: Record }[]; + }; + const request = capture.requests.find((r) => r.method === method); + expect(request, `Expected ${method} request in capture`).toBeDefined(); + return request!.params; +} + +function getObject(value: unknown): Record { + expect(value).toBeTypeOf("object"); + expect(value).not.toBeNull(); + return value as Record; +} + +function getArray(value: unknown): unknown[] { + expect(Array.isArray(value)).toBe(true); + return value as unknown[]; +} + describe("Client options", async () => { const { copilotClient: defaultClient, env, workDir } = await createSdkTestContext(); @@ -145,10 +178,11 @@ describe("Client options", async () => { workingDirectory: workDir, env, connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + gitHubToken: DEFAULT_GITHUB_TOKEN, }); onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } @@ -172,7 +206,7 @@ describe("Client options", async () => { }); onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } @@ -199,11 +233,11 @@ describe("Client options", async () => { workingDirectory: clientCwd, env, connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), - gitHubToken: process.env.CI ? "fake-token-for-e2e-tests" : undefined, + gitHubToken: DEFAULT_GITHUB_TOKEN, }); onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } @@ -247,6 +281,7 @@ describe("Client options", async () => { sessionIdleTimeoutSeconds: 17, telemetry: { otlpEndpoint: "http://127.0.0.1:4318", + otlpProtocol: "http/protobuf", filePath: telemetryPath, exporterType: "file", sourceName: "ts-sdk-e2e", @@ -256,7 +291,7 @@ describe("Client options", async () => { }); onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } @@ -283,6 +318,7 @@ describe("Client options", async () => { expect(capture.env.COPILOT_SDK_AUTH_TOKEN).toBe("process-option-token"); expect(capture.env.COPILOT_OTEL_ENABLED).toBe("true"); expect(capture.env.OTEL_EXPORTER_OTLP_ENDPOINT).toBe("http://127.0.0.1:4318"); + expect(capture.env.OTEL_EXPORTER_OTLP_PROTOCOL).toBe("http/protobuf"); expect(capture.env.COPILOT_OTEL_FILE_EXPORTER_PATH).toBe(telemetryPath); expect(capture.env.COPILOT_OTEL_EXPORTER_TYPE).toBe("file"); expect(capture.env.COPILOT_OTEL_SOURCE_NAME).toBe("ts-sdk-e2e"); @@ -293,6 +329,7 @@ describe("Client options", async () => { enableConfigDiscovery: true, enableOnDemandInstructionDiscovery: true, includeSubAgentStreamingEvents: false, + customAgentsLocalOnly: false, }); const updatedRaw = fs.readFileSync(capturePath, "utf8"); @@ -303,6 +340,7 @@ describe("Client options", async () => { enableConfigDiscovery?: boolean; enableOnDemandInstructionDiscovery?: boolean; includeSubAgentStreamingEvents?: boolean; + customAgentsLocalOnly?: boolean; }; }[]; }; @@ -311,6 +349,390 @@ describe("Client options", async () => { expect(createRequests[0].params.enableConfigDiscovery).toBe(true); expect(createRequests[0].params.enableOnDemandInstructionDiscovery).toBe(true); expect(createRequests[0].params.includeSubAgentStreamingEvents).toBe(false); + expect(createRequests[0].params.customAgentsLocalOnly).toBe(false); + + const sessionId = session.sessionId; + await session.disconnect(); + + const resumed = await client.resumeSession(sessionId, { + onPermissionRequest: approveAll, + customAgentsLocalOnly: false, + }); + const resumedCapture = JSON.parse(fs.readFileSync(capturePath, "utf8")) as { + requests: { + method: string; + params: { customAgentsLocalOnly?: boolean }; + }[]; + }; + const resumeRequests = resumedCapture.requests.filter((r) => r.method === "session.resume"); + expect(resumeRequests).toHaveLength(1); + expect(resumeRequests[0].params.customAgentsLocalOnly).toBe(false); + await resumed.disconnect(); + }); + + it("should send empty-mode custom agent locality defaults in initial requests", async () => { + const cliPath = path.join( + workDir, + `fake-cli-empty-${Date.now()}-${Math.random().toString(36).slice(2)}.js` + ); + const capturePath = path.join( + workDir, + `fake-cli-empty-capture-${Date.now()}-${Math.random().toString(36).slice(2)}.json` + ); + fs.writeFileSync(cliPath, FAKE_STDIO_CLI_SCRIPT); + + const client = new CopilotClient({ + mode: "empty", + baseDirectory: workDir, + workingDirectory: workDir, + env, + connection: RuntimeConnection.forStdio({ + path: cliPath, + args: ["--capture-file", capturePath], + }), + useLoggedInUser: false, + }); + onTestFinished(async () => { + try { + await client.forceStop(); + } catch { + // Ignore cleanup errors + } + }); + + const session = await client.createSession({ + availableTools: ["builtin:ask_user"], + customAgentsLocalOnly: undefined, + onPermissionRequest: approveAll, + }); + const sessionId = session.sessionId; + await session.disconnect(); + + const resumed = await client.resumeSession(sessionId, { + availableTools: ["builtin:ask_user"], + customAgentsLocalOnly: undefined, + onPermissionRequest: approveAll, + }); + + const capture = JSON.parse(fs.readFileSync(capturePath, "utf8")) as { + requests: { + method: string; + params: { customAgentsLocalOnly?: boolean }; + }[]; + }; + const createRequest = capture.requests.find((r) => r.method === "session.create"); + const resumeRequest = capture.requests.find((r) => r.method === "session.resume"); + expect(createRequest?.params.customAgentsLocalOnly).toBe(true); + expect(resumeRequest?.params.customAgentsLocalOnly).toBe(true); + + await resumed.disconnect(); + }); + + it("should forward advanced session options in create wire request", async () => { + const cliPath = path.join( + workDir, + `fake-cli-advanced-create-${Date.now()}-${Math.random().toString(36).slice(2)}.js` + ); + const capturePath = path.join( + workDir, + `fake-cli-advanced-create-capture-${Date.now()}-${Math.random().toString(36).slice(2)}.json` + ); + const outputDirectory = path.join(workDir, "large-output-create"); + fs.writeFileSync(cliPath, FAKE_STDIO_CLI_SCRIPT); + + const client = new CopilotClient({ + workingDirectory: workDir, + env, + connection: RuntimeConnection.forStdio({ + path: cliPath, + args: ["--capture-file", capturePath], + }), + useLoggedInUser: false, + }); + onTestFinished(async () => { + try { + await client.stop(); + } catch { + // Ignore cleanup errors + } + }); + + await client.start(); + + const canvas = createCanvas({ + id: "advanced-create-canvas", + displayName: "Advanced Create Canvas", + description: "Covers create-time canvas options.", + open: () => ({ url: "https://example.test/advanced-create-canvas" }), + }); + const session = await client.createSession({ + clientName: "advanced-create-client", + model: "claude-sonnet-4.5", + reasoningEffort: "medium", + reasoningSummary: "detailed", + contextTier: "long_context", + enableCitations: true, + capi: { enableWebSocketResponses: false }, + mcpOAuthTokenStorage: "persistent", + customAgents: [ + { + name: "agent-one", + displayName: "Agent One", + description: "Handles agent-one tasks.", + prompt: "Be agent one.", + tools: ["view"], + infer: true, + skills: ["create-skill"], + model: "claude-haiku-4.5", + }, + ], + defaultAgent: { excludedTools: ["edit"] }, + agent: "agent-one", + skillDirectories: ["skills-create"], + disabledSkills: ["disabled-create-skill"], + pluginDirectories: ["plugins-create"], + infiniteSessions: { + enabled: false, + backgroundCompactionThreshold: 0.5, + bufferExhaustionThreshold: 0.9, + }, + largeOutput: { + enabled: true, + maxSizeBytes: 4096, + outputDirectory, + }, + memory: { enabled: true }, + gitHubToken: "session-create-token", + remoteSession: "export", + cloud: { + repository: { + owner: "github", + name: "copilot-sdk", + branch: "main", + }, + }, + enableMcpApps: true, + requestCanvasRenderer: true, + requestExtensions: true, + extensionSdkPath: "custom-extension-sdk", + extensionInfo: { source: "typescript-sdk-tests", name: "advanced-create-extension" }, + canvases: [canvas], + providers: [ + { + name: "create-provider", + type: "openai", + wireApi: "responses", + baseUrl: "https://create-provider.example.test/v1", + apiKey: "create-provider-key", + headers: { "X-Create-Provider": "yes" }, + }, + ], + models: [ + { + provider: "create-provider", + id: "create-model", + name: "Create Model", + modelId: "claude-sonnet-4.5", + wireModel: "create-wire-model", + maxContextWindowTokens: 12_000, + maxPromptTokens: 10_000, + maxOutputTokens: 2_000, + }, + ], + onPermissionRequest: approveAll, + }); + + const createRequest = getCapturedRequest(capturePath, "session.create"); + expect(createRequest.clientName).toBe("advanced-create-client"); + expect(createRequest.model).toBe("claude-sonnet-4.5"); + expect(createRequest.reasoningEffort).toBe("medium"); + expect(createRequest.reasoningSummary).toBe("detailed"); + expect(createRequest.contextTier).toBe("long_context"); + expect(createRequest.enableCitations).toBe(true); + expect(getObject(createRequest.capi).enableWebSocketResponses).toBe(false); + expect(createRequest.mcpOAuthTokenStorage).toBe("persistent"); + expect(createRequest.agent).toBe("agent-one"); + expect(getArray(getObject(createRequest.defaultAgent).excludedTools)[0]).toBe("edit"); + expect(getObject(getArray(createRequest.customAgents)[0]).name).toBe("agent-one"); + expect(getArray(createRequest.pluginDirectories)[0]).toBe("plugins-create"); + expect(getArray(createRequest.disabledSkills)[0]).toBe("disabled-create-skill"); + expect(getObject(createRequest.infiniteSessions).enabled).toBe(false); + expect(getObject(createRequest.largeOutput).enabled).toBe(true); + expect(getObject(createRequest.largeOutput).maxSizeBytes).toBe(4096); + expect(getObject(createRequest.largeOutput).outputDir).toBe(outputDirectory); + expect(getObject(createRequest.memory).enabled).toBe(true); + expect(createRequest.gitHubToken).toBe("session-create-token"); + expect(createRequest.remoteSession).toBe("export"); + expect(getObject(getObject(createRequest.cloud).repository).owner).toBe("github"); + expect(createRequest.requestMcpApps).toBe(true); + expect(createRequest.requestCanvasRenderer).toBe(true); + expect(createRequest.requestExtensions).toBe(true); + expect(createRequest.extensionSdkPath).toBe("custom-extension-sdk"); + expect(getObject(createRequest.extensionInfo).name).toBe("advanced-create-extension"); + expect(getObject(getArray(createRequest.canvases)[0]).id).toBe("advanced-create-canvas"); + expect(getObject(getArray(createRequest.providers)[0]).name).toBe("create-provider"); + expect(getObject(getArray(createRequest.providers)[0]).wireApi).toBe("responses"); + expect(getObject(getArray(createRequest.models)[0]).id).toBe("create-model"); + expect(getObject(getArray(createRequest.models)[0]).maxContextWindowTokens).toBe(12_000); + + await session.disconnect(); + }); + + it("should forward singular provider options in create wire request", async () => { + const cliPath = path.join( + workDir, + `fake-cli-provider-create-${Date.now()}-${Math.random().toString(36).slice(2)}.js` + ); + const capturePath = path.join( + workDir, + `fake-cli-provider-create-capture-${Date.now()}-${Math.random().toString(36).slice(2)}.json` + ); + fs.writeFileSync(cliPath, FAKE_STDIO_CLI_SCRIPT); + + const client = new CopilotClient({ + workingDirectory: workDir, + env, + connection: RuntimeConnection.forStdio({ + path: cliPath, + args: ["--capture-file", capturePath], + }), + useLoggedInUser: false, + }); + onTestFinished(async () => { + try { + await client.stop(); + } catch { + // Ignore cleanup errors + } + }); + + await client.start(); + + const session = await client.createSession({ + model: "claude-sonnet-4.5", + provider: { + type: "azure", + wireApi: "responses", + transport: "http", + baseUrl: "https://azure-provider.example.test/openai", + apiKey: "provider-api-key", + bearerToken: "provider-bearer-token", + azure: { apiVersion: "2024-02-15-preview" }, + headers: { "X-Provider-Wire": "yes" }, + modelId: "claude-sonnet-4.5", + wireModel: "azure-deployment", + maxPromptTokens: 8192, + maxOutputTokens: 1024, + }, + onPermissionRequest: approveAll, + }); + + const provider = getObject(getCapturedRequest(capturePath, "session.create").provider); + expect(provider.type).toBe("azure"); + expect(provider.wireApi).toBe("responses"); + expect(provider.transport).toBe("http"); + expect(provider.baseUrl).toBe("https://azure-provider.example.test/openai"); + expect(provider.apiKey).toBe("provider-api-key"); + expect(provider.bearerToken).toBe("provider-bearer-token"); + expect(getObject(provider.azure).apiVersion).toBe("2024-02-15-preview"); + expect(getObject(provider.headers)["X-Provider-Wire"]).toBe("yes"); + expect(provider.modelId).toBe("claude-sonnet-4.5"); + expect(provider.wireModel).toBe("azure-deployment"); + expect(provider.maxPromptTokens).toBe(8192); + expect(provider.maxOutputTokens).toBe(1024); + + await session.disconnect(); + }); + + it("should forward advanced session options in resume wire request", async () => { + const cliPath = path.join( + workDir, + `fake-cli-advanced-resume-${Date.now()}-${Math.random().toString(36).slice(2)}.js` + ); + const capturePath = path.join( + workDir, + `fake-cli-advanced-resume-capture-${Date.now()}-${Math.random().toString(36).slice(2)}.json` + ); + const outputDirectory = path.join(workDir, "large-output-resume"); + fs.writeFileSync(cliPath, FAKE_STDIO_CLI_SCRIPT); + + const client = new CopilotClient({ + workingDirectory: workDir, + env, + connection: RuntimeConnection.forStdio({ + path: cliPath, + args: ["--capture-file", capturePath], + }), + useLoggedInUser: false, + }); + onTestFinished(async () => { + try { + await client.stop(); + } catch { + // Ignore cleanup errors + } + }); + + await client.start(); + + const session = await client.resumeSession("advanced-resume-session", { + clientName: "advanced-resume-client", + model: "claude-haiku-4.5", + reasoningEffort: "low", + reasoningSummary: "none", + contextTier: "default", + suppressResumeEvent: true, + continuePendingWork: true, + mcpOAuthTokenStorage: "persistent", + pluginDirectories: ["plugins-resume"], + largeOutput: { + enabled: false, + maxSizeBytes: 2048, + outputDirectory, + }, + memory: { enabled: false }, + remoteSession: "on", + openCanvases: [ + { + canvasId: "resume-canvas", + extensionId: "typescript-sdk-tests/resume-extension", + extensionName: "Resume Extension", + instanceId: "resume-canvas-1", + input: { start: 41 }, + status: "ready", + title: "Resume Canvas", + url: "https://example.com/resume-canvas", + }, + ], + onPermissionRequest: approveAll, + }); + + const resumeRequest = getCapturedRequest(capturePath, "session.resume"); + expect(resumeRequest.sessionId).toBe("advanced-resume-session"); + expect(resumeRequest.clientName).toBe("advanced-resume-client"); + expect(resumeRequest.model).toBe("claude-haiku-4.5"); + expect(resumeRequest.reasoningEffort).toBe("low"); + expect(resumeRequest.reasoningSummary).toBe("none"); + expect(resumeRequest.contextTier).toBe("default"); + expect(resumeRequest.disableResume).toBe(true); + expect(resumeRequest.continuePendingWork).toBe(true); + expect(resumeRequest.mcpOAuthTokenStorage).toBe("persistent"); + expect(getArray(resumeRequest.pluginDirectories)[0]).toBe("plugins-resume"); + expect(getObject(resumeRequest.largeOutput).enabled).toBe(false); + expect(getObject(resumeRequest.largeOutput).maxSizeBytes).toBe(2048); + expect(getObject(resumeRequest.largeOutput).outputDir).toBe(outputDirectory); + expect(getObject(resumeRequest.memory).enabled).toBe(false); + expect(resumeRequest.remoteSession).toBe("on"); + + const openCanvas = getObject(getArray(resumeRequest.openCanvases)[0]); + expect(openCanvas.canvasId).toBe("resume-canvas"); + expect(openCanvas.extensionId).toBe("typescript-sdk-tests/resume-extension"); + expect(openCanvas.extensionName).toBe("Resume Extension"); + expect(openCanvas.instanceId).toBe("resume-canvas-1"); + expect(getObject(openCanvas.input).start).toBe(41); + expect(openCanvas.status).toBe("ready"); + expect(openCanvas.title).toBe("Resume Canvas"); + expect(openCanvas.url).toBe("https://example.com/resume-canvas"); await session.disconnect(); }); diff --git a/nodejs/test/e2e/copilot_request_cancel_error.e2e.test.ts b/nodejs/test/e2e/copilot_request_cancel_error.e2e.test.ts new file mode 100644 index 000000000..69bacd4f6 --- /dev/null +++ b/nodejs/test/e2e/copilot_request_cancel_error.e2e.test.ts @@ -0,0 +1,194 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll, CopilotRequestHandler, type CopilotRequestContext } from "../../src/index.js"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; + +/** + * Cancellation and error coverage for {@link CopilotRequestHandler}. These two + * scenarios exercise the handler's terminal paths that the happy-path session-id + * and HTTP/WebSocket tests never reach: + * + * - **Error** — the handler throws from {@link CopilotRequestHandler.sendRequest} + * for an inference request. The base adapter reports a transport error back to + * the runtime (`errorResponse`) rather than hanging. + * - **Runtime cancel** — the handler blocks an inference request indefinitely; + * when the consumer aborts the turn the runtime cancels the in-flight request, + * firing `ctx.signal`. The handler observes the abort (the `cancel`-frame + * path) instead of leaking a stuck request. + * + * Non-inference model-layer requests (catalog, policy, model session) are served + * with minimal stubs so the turn reaches the inference step. The success-path + * SSE body is intentionally omitted — neither scenario completes a turn. + */ + +function isInferenceUrl(url: string): boolean { + const u = url.toLowerCase(); + return ( + u.endsWith("/chat/completions") || + u.endsWith("/responses") || + u.endsWith("/v1/messages") || + u.endsWith("/messages") + ); +} + +function json(body: string): Response { + return new Response(body, { status: 200, headers: { "content-type": "application/json" } }); +} + +/** Serve the non-inference GETs/POSTs (catalog, policy, model session). */ +function serveNonInference(url: string): Response { + const u = url.toLowerCase(); + if (u.endsWith("/models")) { + return json(MODEL_CATALOG_JSON); + } + if (u.includes("/models/session")) { + return json("{}"); + } + if (u.includes("/policy")) { + return json(JSON.stringify({ state: "enabled" })); + } + return json("{}"); +} + +const MODEL_CATALOG_JSON = JSON.stringify({ + data: [ + { + id: "claude-sonnet-4.5", + name: "Claude Sonnet 4.5", + object: "model", + vendor: "Anthropic", + version: "1", + preview: false, + model_picker_enabled: true, + capabilities: { + type: "chat", + family: "claude-sonnet-4.5", + tokenizer: "o200k_base", + limits: { max_context_window_tokens: 200000, max_output_tokens: 8192 }, + supports: { + streaming: true, + tool_calls: true, + parallel_tool_calls: true, + vision: true, + }, + }, + }, + ], +}); + +async function waitFor(predicate: () => boolean, timeoutMs: number): Promise { + const deadline = Date.now() + timeoutMs; + while (!predicate()) { + if (Date.now() > deadline) { + throw new Error("waitFor timed out"); + } + await new Promise((resolve) => setTimeout(resolve, 50)); + } +} + +/** Throws from every inference request to exercise the error-reporting path. */ +class ThrowingRequestHandler extends CopilotRequestHandler { + inferenceAttempts = 0; + + protected override async sendRequest( + request: Request, + _ctx: CopilotRequestContext + ): Promise { + if (!isInferenceUrl(request.url)) { + return serveNonInference(request.url); + } + this.inferenceAttempts++; + throw new Error("synthetic-callback-transport-failure"); + } +} + +/** Blocks every inference request until the runtime cancels it. */ +class CancellingRequestHandler extends CopilotRequestHandler { + inferenceEntered = false; + sawAbort = false; + + protected override async sendRequest( + request: Request, + ctx: CopilotRequestContext + ): Promise { + if (!isInferenceUrl(request.url)) { + return serveNonInference(request.url); + } + this.inferenceEntered = true; + await new Promise((resolve) => { + if (ctx.signal.aborted) { + resolve(); + return; + } + ctx.signal.addEventListener("abort", () => resolve(), { once: true }); + }); + this.sawAbort = true; + // The runtime already dropped the request; throwing simply propagates + // the abort out of the (here, simulated) upstream call. + throw new Error("cancelled by runtime"); + } +} + +describe("CopilotRequestHandler surfaces inference errors", async () => { + const handler = new ThrowingRequestHandler(); + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { requestHandler: handler }, + }); + + it("reports a thrown callback error instead of hanging the turn", async () => { + await client.start(); + const session = await client.createSession({ onPermissionRequest: approveAll }); + try { + // The callback throws on inference; the turn surfaces an error (or + // completes without an assistant message) rather than hanging. + await session.sendAndWait({ prompt: "Say OK." }).catch(() => undefined); + } finally { + await session.disconnect(); + } + + expect( + handler.inferenceAttempts, + "expected the inference callback to be reached and raise" + ).toBeGreaterThan(0); + }, 90_000); +}); + +describe("CopilotRequestHandler observes runtime cancellation", async () => { + const handler = new CancellingRequestHandler(); + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { requestHandler: handler }, + }); + + // The runtime enforces a single, process-wide LLM inference provider: a second + // client.start() with a requestHandler rejects llmInference.setProvider with + // "Another client is already the LLM inference provider." The sibling error test + // above already registers a provider and holds it for this file's lifetime, and + // inproc runs share one runtime host, so this scenario can only run on the default + // (stdio) cell, where each client owns its own runtime process. + it.skipIf(isInProcessTransport)( + "fires ctx.signal when the consumer aborts an in-flight inference request", + async () => { + await client.start(); + const session = await client.createSession({ onPermissionRequest: approveAll }); + try { + await session.send("Say OK."); + await waitFor(() => handler.inferenceEntered, 60_000); + await session.abort(); + await waitFor(() => handler.sawAbort, 30_000); + } finally { + await session.disconnect(); + } + + expect(handler.inferenceEntered, "expected the inference callback to be entered").toBe( + true + ); + expect(handler.sawAbort, "expected the callback to observe runtime cancellation").toBe( + true + ); + }, + 90_000 + ); +}); diff --git a/nodejs/test/e2e/copilot_request_handler.e2e.test.ts b/nodejs/test/e2e/copilot_request_handler.e2e.test.ts new file mode 100644 index 000000000..309250d85 --- /dev/null +++ b/nodejs/test/e2e/copilot_request_handler.e2e.test.ts @@ -0,0 +1,350 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { createServer, IncomingMessage, Server as HttpServer, ServerResponse } from "http"; +import { AddressInfo } from "net"; +import { afterAll, describe, expect, it } from "vitest"; +import { WebSocketServer } from "ws"; +import { + approveAll, + CopilotRequestHandler, + CopilotWebSocketForwarder, + type CopilotRequestContext, +} from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +const HTTP_TEXT = "OK from synthetic HTTP upstream."; +const WS_TEXT = "OK from synthetic WS upstream."; + +/** + * Stand up an in-process upstream that speaks the real CAPI shapes the + * runtime needs: model catalog, policy, `/responses` SSE for HTTP + * inference, and a WebSocket endpoint at `/responses` that answers each + * inbound `response.create` with the ordered `/responses` events the + * reducer expects. + * + * Returned `url` is what the handler subclass rewrites every + * intercepted request to point at — the runtime never talks to this + * server directly; the handler does, on the runtime's behalf. + */ +async function startFakeUpstream(): Promise<{ + url: string; + server: HttpServer; + wsRequestCount: () => number; + close: () => Promise; +}> { + let wsRequests = 0; + + const httpServer = createServer((req, res) => { + const url = new URL(req.url ?? "/", `http://${req.headers.host ?? "localhost"}`); + if (url.pathname === "/models" && req.method === "GET") { + sendJson(res, 200, { + data: [ + { + id: "claude-sonnet-4.5", + name: "Claude Sonnet 4.5", + object: "model", + vendor: "Anthropic", + version: "1", + preview: false, + model_picker_enabled: true, + supported_endpoints: ["/responses", "ws:/responses"], + capabilities: { + type: "chat", + family: "claude-sonnet-4.5", + tokenizer: "o200k_base", + limits: { + max_context_window_tokens: 200000, + max_output_tokens: 8192, + }, + supports: { + streaming: true, + tool_calls: true, + parallel_tool_calls: true, + vision: true, + }, + }, + }, + ], + }); + return; + } + if (url.pathname.endsWith("/models/session")) { + sendJson(res, 200, {}); + return; + } + if (url.pathname.includes("/policy")) { + sendJson(res, 200, { state: "enabled" }); + return; + } + if (url.pathname.endsWith("/responses") && req.method === "POST") { + // Single-shot HTTP inference (e.g. title generation). SSE + // events the `responses-client.ts` reducer accepts. + drainBody(req) + .then(() => { + res.writeHead(200, { + "content-type": "text/event-stream", + "cache-control": "no-cache", + }); + for (const event of buildResponsesEvents(HTTP_TEXT, "resp_stub_http")) { + res.write(`event: ${event.type}\ndata: ${JSON.stringify(event)}\n\n`); + } + res.end(); + }) + .catch(() => { + res.writeHead(500).end(); + }); + return; + } + // Anything else: not found. + res.writeHead(404, { "content-type": "application/json" }); + res.end(JSON.stringify({ error: "not_found", path: url.pathname })); + }); + + const wss = new WebSocketServer({ server: httpServer, path: "/responses" }); + wss.on("connection", (socket) => { + socket.on("message", (raw) => { + wsRequests++; + // For each `response.create` request the runtime sends, + // answer with the ordered `/responses` event objects — one + // event per outbound WS message, raw JSON (NOT SSE-framed). + for (const event of buildResponsesEvents(WS_TEXT, "resp_stub_ws")) { + socket.send(JSON.stringify(event)); + } + void raw; + }); + }); + + await new Promise((resolve) => httpServer.listen(0, "127.0.0.1", resolve)); + const port = (httpServer.address() as AddressInfo).port; + const url = `http://127.0.0.1:${port}`; + + return { + url, + server: httpServer, + wsRequestCount: () => wsRequests, + async close() { + wss.clients.forEach((c) => c.terminate()); + await new Promise((resolve) => wss.close(() => resolve())); + await new Promise((resolve) => httpServer.close(() => resolve())); + }, + }; +} + +function sendJson(res: ServerResponse, status: number, body: unknown): void { + res.writeHead(status, { "content-type": "application/json" }); + res.end(JSON.stringify(body)); +} + +async function drainBody(req: IncomingMessage): Promise { + const parts: Buffer[] = []; + for await (const chunk of req) { + parts.push(chunk as Buffer); + } + return Buffer.concat(parts); +} + +function buildResponsesEvents(text: string, id: string): Array> { + return [ + { + type: "response.created", + response: { id, object: "response", status: "in_progress", output: [] }, + }, + { + type: "response.output_item.added", + output_index: 0, + item: { id: "msg_1", type: "message", role: "assistant", content: [] }, + }, + { + type: "response.content_part.added", + output_index: 0, + content_index: 0, + part: { type: "output_text", text: "" }, + }, + { type: "response.output_text.delta", output_index: 0, content_index: 0, delta: text }, + { type: "response.output_text.done", output_index: 0, content_index: 0, text }, + { + type: "response.completed", + response: { + id, + object: "response", + status: "completed", + output: [ + { + id: "msg_1", + type: "message", + role: "assistant", + content: [{ type: "output_text", text }], + }, + ], + usage: { input_tokens: 5, output_tokens: 7, total_tokens: 12 }, + }, + }, + ]; +} + +interface Counters { + httpRequests: number; + httpResponses: number; + wsRequestMessages: number; + wsResponseMessages: number; +} + +/** + * Single handler subclass that services BOTH transports against the + * per-test fake upstream. Demonstrates mutation in each direction: + * + * - HTTP: rewrites the URL to point at the test server, adds an + * `X-Test-Mutated` header to the outbound request, and adds an + * `X-Test-Response-Mutated` header on the way back. The test server + * echoes the request header into a counter so we can assert it + * actually arrived upstream. + * - WebSocket: rewrites the WS URL similarly and forwards through the + * default WebSocket forwarder while observing message counts in both + * directions. + */ +class TestHandler extends CopilotRequestHandler { + constructor( + private readonly upstreamUrl: string, + private readonly counters: Counters + ) { + super(); + } + + private rewriteUrl(originalUrl: string): string { + const parsed = new URL(originalUrl); + const upstream = new URL(this.upstreamUrl); + parsed.protocol = upstream.protocol; + parsed.host = upstream.host; + return parsed.toString(); + } + + private rewriteWsUrl(originalUrl: string): string { + const parsed = new URL(originalUrl); + const upstream = new URL(this.upstreamUrl); + // The upstream URL is http(s); flip to ws(s) for the WS open. + parsed.protocol = upstream.protocol === "https:" ? "wss:" : "ws:"; + parsed.host = upstream.host; + return parsed.toString(); + } + + protected override async sendRequest( + request: Request, + _ctx: CopilotRequestContext + ): Promise { + this.counters.httpRequests++; + const rewritten = this.rewriteUrl(request.url); + const requestHeaders = new Headers(request.headers); + requestHeaders.set("x-test-mutated", "1"); + const rewrittenRequest = new Request(rewritten, { + method: request.method, + headers: requestHeaders, + body: request.body, + // @ts-expect-error duplex is required by undici when streaming a body + duplex: "half", + }); + const response = await fetch(rewrittenRequest, { signal: _ctx.signal }); + this.counters.httpResponses++; + const responseHeaders = new Headers(response.headers); + responseHeaders.set("x-test-response-mutated", "1"); + return new Response(response.body, { + status: response.status, + statusText: response.statusText, + headers: responseHeaders, + }); + } + + protected override async openWebSocket( + ctx: CopilotRequestContext + ): Promise { + ctx.url = this.rewriteWsUrl(ctx.url); + return new CountingSocketForwarder(ctx, this.counters); + } +} + +class CountingSocketForwarder extends CopilotWebSocketForwarder { + constructor( + ctx: CopilotRequestContext, + private readonly counters: Counters + ) { + super(ctx); + } + + override sendRequestMessage(data: string | Uint8Array): void { + this.counters.wsRequestMessages++; + super.sendRequestMessage(data); + } + + override async sendResponseMessage(data: string | Uint8Array): Promise { + this.counters.wsResponseMessages++; + await super.sendResponseMessage(data); + } +} + +describe("CopilotRequestHandler — single subclass handles HTTP + WebSocket", async () => { + const upstream = await startFakeUpstream(); + const counters: Counters = { + httpRequests: 0, + httpResponses: 0, + wsRequestMessages: 0, + wsResponseMessages: 0, + }; + + const { copilotClient: client, env } = await createSdkTestContext({ + copilotClientOptions: { + requestHandler: new TestHandler(upstream.url, counters), + }, + }); + + // Enable the WebSocket Responses transport in the spawned runtime so + // the main agent turn picks the WS path; single-shot calls (title + // generation) still go over HTTP through the same subclass. + env.COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES = "true"; + + afterAll(async () => { + await upstream.close(); + }); + + it("services both an HTTP turn and a WebSocket turn end-to-end via one handler", async () => { + await client.start(); + const session = await client.createSession({ onPermissionRequest: approveAll }); + let resultJson = ""; + try { + const result = await session.sendAndWait({ prompt: "Say OK." }); + resultJson = JSON.stringify(result); + } finally { + await session.disconnect(); + } + + // The HTTP hooks fired — the runtime issued model-layer GETs + // (catalog, policy) and possibly a single-shot inference. + expect(counters.httpRequests, "expected sendRequest to fire").toBeGreaterThan(0); + expect( + counters.httpResponses, + "expected sendRequest response mutation to fire" + ).toBeGreaterThan(0); + + // The WebSocket hooks fired — the main agent turn went over + // the WS path and we observed messages in both directions. + expect( + counters.wsRequestMessages, + "expected sendRequestMessage (runtime → upstream) to fire" + ).toBeGreaterThan(0); + expect( + counters.wsResponseMessages, + "expected sendResponseMessage (upstream → runtime) to fire" + ).toBeGreaterThan(0); + expect( + upstream.wsRequestCount(), + "expected upstream WS to receive request messages" + ).toBeGreaterThan(0); + + // The synthetic content from the upstream surfaced in the + // assistant turn — proves the full chain (runtime → handler + // → upstream → handler → runtime) is intact for the + // transport the main agent turn used. + // Validate the final assistant response arrived (guards against truncated captures) + expect(resultJson).toMatch(/OK from synthetic (HTTP|WS) upstream/); + }, 90_000); +}); diff --git a/nodejs/test/e2e/copilot_request_session_id.e2e.test.ts b/nodejs/test/e2e/copilot_request_session_id.e2e.test.ts new file mode 100644 index 000000000..bd070c20c --- /dev/null +++ b/nodejs/test/e2e/copilot_request_session_id.e2e.test.ts @@ -0,0 +1,341 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll, CopilotRequestHandler, type CopilotRequestContext } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +const SYNTHETIC_TEXT = "OK from the synthetic stream."; + +interface InterceptedRequest { + url: string; + sessionId?: string; + agentId?: string; + parentAgentId?: string; + interactionType?: string; +} + +function isInferenceUrl(url: string): boolean { + const u = url.toLowerCase(); + return ( + u.endsWith("/chat/completions") || + u.endsWith("/responses") || + u.endsWith("/v1/messages") || + u.endsWith("/messages") + ); +} + +/** + * A {@link CopilotRequestHandler} that records every intercepted request + * (url + threaded session id) and fully replaces the upstream call with a + * fabricated, well-formed response for every model-layer endpoint, so an + * agent turn completes entirely off-network — no upstream server and no CAPI + * proxy acting as the inference endpoint. + * + * This exercises the public extension surface end to end: a consumer + * subclasses {@link CopilotRequestHandler} and overrides {@link sendRequest} + * to short-circuit the upstream HTTP call with any {@link Response} it likes. + * The base adapter streams that response back to the runtime. + */ +class RecordingRequestHandler extends CopilotRequestHandler { + readonly records: InterceptedRequest[] = []; + + protected override async sendRequest( + request: Request, + ctx: CopilotRequestContext + ): Promise { + const url = request.url; + this.records.push({ + url, + sessionId: ctx.sessionId, + agentId: ctx.agentId, + parentAgentId: ctx.parentAgentId, + interactionType: ctx.interactionType, + }); + const bodyText = request.body ? await request.text() : ""; + return isInferenceUrl(url) + ? buildInferenceResponse(url, bodyText) + : buildNonInferenceResponse(url); + } +} + +function json(body: string): Response { + return new Response(body, { + status: 200, + headers: { "content-type": "application/json" }, + }); +} + +function sse(body: string): Response { + return new Response(body, { + status: 200, + headers: { "content-type": "text/event-stream", "cache-control": "no-cache" }, + }); +} + +/** + * Synthesize a well-formed inference response so the agent turn completes. + * The runtime selects `/responses` for both the CAPI and BYOK sessions here; + * `/chat/completions` is handled too for robustness. + */ +function buildInferenceResponse(url: string, bodyText: string): Response { + const wantsStream = /"stream"\s*:\s*true/.test(bodyText); + const u = url.toLowerCase(); + + if (u.includes("/responses")) { + return wantsStream ? sse(RESPONSES_STREAM_EVENTS.join("")) : json(BUFFERED_RESPONSE_JSON); + } + + if (u.includes("/chat/completions") && wantsStream) { + return sse(CHAT_COMPLETION_STREAM_EVENTS.join("")); + } + + // /chat/completions non-streaming (and any other inference url) — buffered JSON. + return json(BUFFERED_CHAT_COMPLETION_JSON); +} + +/** + * Serve the non-inference model-layer GETs/POSTs the runtime issues (catalog, + * model session, policy). These flow through the same handler but carry no + * session id (they happen outside an agent turn). + */ +function buildNonInferenceResponse(url: string): Response { + const u = url.toLowerCase(); + if (u.endsWith("/models")) { + return json(MODEL_CATALOG_JSON); + } + if (u.includes("/models/session")) { + return json("{}"); + } + if (u.includes("/policy")) { + return json(JSON.stringify({ state: "enabled" })); + } + return json("{}"); +} + +function expectAgentMetadata(r: InterceptedRequest): void { + expect(r.agentId).toBeTruthy(); + expect(r.interactionType).toBeTruthy(); +} + +const RESPONSES_STREAM_EVENTS: string[] = [ + `event: response.created\ndata: ${JSON.stringify({ + type: "response.created", + response: { id: "resp_stub_1", object: "response", status: "in_progress", output: [] }, + })}\n\n`, + `event: response.output_item.added\ndata: ${JSON.stringify({ + type: "response.output_item.added", + output_index: 0, + item: { id: "msg_1", type: "message", role: "assistant", content: [] }, + })}\n\n`, + `event: response.content_part.added\ndata: ${JSON.stringify({ + type: "response.content_part.added", + output_index: 0, + content_index: 0, + part: { type: "output_text", text: "" }, + })}\n\n`, + `event: response.output_text.delta\ndata: ${JSON.stringify({ + type: "response.output_text.delta", + output_index: 0, + content_index: 0, + delta: SYNTHETIC_TEXT, + })}\n\n`, + `event: response.output_text.done\ndata: ${JSON.stringify({ + type: "response.output_text.done", + output_index: 0, + content_index: 0, + text: SYNTHETIC_TEXT, + })}\n\n`, + `event: response.completed\ndata: ${JSON.stringify({ + type: "response.completed", + response: { + id: "resp_stub_1", + object: "response", + status: "completed", + output: [ + { + id: "msg_1", + type: "message", + role: "assistant", + content: [{ type: "output_text", text: SYNTHETIC_TEXT }], + }, + ], + usage: { input_tokens: 5, output_tokens: 7, total_tokens: 12 }, + }, + })}\n\n`, +]; + +const CHAT_COMPLETION_STREAM_EVENTS: string[] = (() => { + const base = { + id: "chatcmpl-stub-1", + object: "chat.completion.chunk", + created: 1, + model: "claude-sonnet-4.5", + }; + return [ + `data: ${JSON.stringify({ + ...base, + choices: [{ index: 0, delta: { role: "assistant", content: "" }, finish_reason: null }], + })}\n\n`, + `data: ${JSON.stringify({ + ...base, + choices: [{ index: 0, delta: { content: SYNTHETIC_TEXT }, finish_reason: null }], + })}\n\n`, + `data: ${JSON.stringify({ + ...base, + choices: [{ index: 0, delta: {}, finish_reason: "stop" }], + usage: { prompt_tokens: 5, completion_tokens: 7, total_tokens: 12 }, + })}\n\n`, + `data: [DONE]\n\n`, + ]; +})(); + +const BUFFERED_RESPONSE_JSON = JSON.stringify({ + id: "resp_stub_1", + object: "response", + status: "completed", + output: [ + { + id: "msg_1", + type: "message", + role: "assistant", + content: [{ type: "output_text", text: SYNTHETIC_TEXT }], + }, + ], + usage: { input_tokens: 5, output_tokens: 7, total_tokens: 12 }, +}); + +const BUFFERED_CHAT_COMPLETION_JSON = JSON.stringify({ + id: "chatcmpl-stub-1", + object: "chat.completion", + created: 1, + model: "claude-sonnet-4.5", + choices: [ + { + index: 0, + message: { role: "assistant", content: SYNTHETIC_TEXT }, + finish_reason: "stop", + }, + ], + usage: { prompt_tokens: 5, completion_tokens: 7, total_tokens: 12 }, +}); + +const MODEL_CATALOG_JSON = JSON.stringify({ + data: [ + { + id: "claude-sonnet-4.5", + name: "Claude Sonnet 4.5", + object: "model", + vendor: "Anthropic", + version: "1", + preview: false, + model_picker_enabled: true, + capabilities: { + type: "chat", + family: "claude-sonnet-4.5", + tokenizer: "o200k_base", + limits: { max_context_window_tokens: 200000, max_output_tokens: 8192 }, + supports: { + streaming: true, + tool_calls: true, + parallel_tool_calls: true, + vision: true, + }, + }, + }, + ], +}); + +/** + * Asserts the runtime threads its session id into the request handler for + * BOTH a CAPI session and a BYOK session. The handler alone services every + * model-layer request — no upstream server, no CAPI proxy acting as the + * inference endpoint — so the only source of `ctx.sessionId` is the runtime's + * own per-client threading. + */ +describe("CopilotRequestHandler threads the runtime session id (CAPI + BYOK)", async () => { + const handler = new RecordingRequestHandler(); + + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { + requestHandler: handler, + }, + }); + + let capiSessionId: string | undefined; + + it("threads the session id into a CAPI session's inference request", async () => { + await client.start(); + const baseline = handler.records.length; + const session = await client.createSession({ onPermissionRequest: approveAll }); + capiSessionId = session.sessionId; + let resultJson = ""; + try { + const result = await session.sendAndWait({ prompt: "Say OK." }); + resultJson = JSON.stringify(result); + } finally { + await session.disconnect(); + } + + const inference = handler.records.slice(baseline).filter((r) => isInferenceUrl(r.url)); + expect( + inference.length, + "expected at least one intercepted inference request" + ).toBeGreaterThan(0); + for (const r of inference) { + expect(r.sessionId, "CAPI inference request must carry the runtime session id").toBe( + session.sessionId + ); + expectAgentMetadata(r); + } + + // Validate the final assistant response arrived (guards against truncated captures) + expect(resultJson).toMatch(/OK from the synthetic/); + }, 90_000); + + it("threads the session id into a BYOK session's inference request", async () => { + await client.start(); + const baseline = handler.records.length; + const session = await client.createSession({ + onPermissionRequest: approveAll, + // BYOK providers require an explicit model id. + model: "claude-sonnet-4.5", + provider: { + type: "openai", + wireApi: "responses", + baseUrl: "https://byok.invalid/v1", + apiKey: "byok-secret", + modelId: "claude-sonnet-4.5", + wireModel: "claude-sonnet-4.5", + }, + }); + const byokSessionId = session.sessionId; + let resultJson = ""; + try { + const result = await session.sendAndWait({ prompt: "Say OK." }); + resultJson = JSON.stringify(result); + } finally { + await session.disconnect(); + } + + const inference = handler.records.slice(baseline).filter((r) => isInferenceUrl(r.url)); + expect( + inference.length, + "expected at least one intercepted BYOK inference request" + ).toBeGreaterThan(0); + for (const r of inference) { + expect(r.sessionId, "BYOK inference request must carry the runtime session id").toBe( + byokSessionId + ); + expectAgentMetadata(r); + } + + // Session ids are per-session, so the two turns must differ — proves + // we assert against a real, request-specific id, not a constant. + expect(byokSessionId).not.toBe(capiSessionId); + + // Validate the final assistant response arrived (guards against truncated captures) + expect(resultJson).toMatch(/OK from the synthetic/); + }, 90_000); +}); diff --git a/nodejs/test/e2e/disabled_mcp_servers.e2e.test.ts b/nodejs/test/e2e/disabled_mcp_servers.e2e.test.ts new file mode 100644 index 000000000..ce1a504e8 --- /dev/null +++ b/nodejs/test/e2e/disabled_mcp_servers.e2e.test.ts @@ -0,0 +1,485 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs"; +import { join, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { describe, expect, it } from "vitest"; +import { + approveAll, + CopilotRequestHandler, + RuntimeConnection, + type CopilotSession, +} from "../../src/index.js"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; +import { waitForCondition } from "./harness/sdkTestHelper.js"; + +const __dirname = resolve(fileURLToPath(new URL(".", import.meta.url))); +const TEST_MCP_SERVER = resolve(__dirname, "../../../test/harness/test-mcp-server.mjs"); +const SYNTHETIC_RESPONSE = "PERSISTED_SESSION_READY"; +const MCP_TRIGGER_PROMPT = "Reply with the configured MCP test completion marker."; + +class PersistingRequestHandler extends CopilotRequestHandler { + protected override async sendRequest(request: Request): Promise { + const body = request.body ? await request.text() : ""; + const wantsStream = /"stream"\s*:\s*true/.test(body); + const url = request.url.toLowerCase(); + + if (url.endsWith("/models")) { + return new Response(MODEL_CATALOG_JSON, { + status: 200, + headers: { "content-type": "application/json" }, + }); + } + + if (url.includes("/responses")) { + return new Response(wantsStream ? RESPONSE_STREAM : RESPONSE_JSON, { + status: 200, + headers: { + "content-type": wantsStream ? "text/event-stream" : "application/json", + }, + }); + } + + if (url.includes("/chat/completions")) { + return new Response( + wantsStream ? CHAT_COMPLETION_STREAM : CHAT_COMPLETION_RESPONSE_JSON, + { + status: 200, + headers: { + "content-type": wantsStream ? "text/event-stream" : "application/json", + }, + } + ); + } + + return new Response("{}", { + status: 200, + headers: { "content-type": "application/json" }, + }); + } +} + +const RESPONSE_STREAM = [ + { + event: "response.created", + data: { + type: "response.created", + response: { + id: "persisted-session", + object: "response", + status: "in_progress", + output: [], + }, + }, + }, + { + event: "response.output_item.added", + data: { + type: "response.output_item.added", + output_index: 0, + item: { id: "message-1", type: "message", role: "assistant", content: [] }, + }, + }, + { + event: "response.content_part.added", + data: { + type: "response.content_part.added", + output_index: 0, + content_index: 0, + part: { type: "output_text", text: "" }, + }, + }, + { + event: "response.output_text.delta", + data: { + type: "response.output_text.delta", + output_index: 0, + content_index: 0, + delta: SYNTHETIC_RESPONSE, + }, + }, + { + event: "response.output_text.done", + data: { + type: "response.output_text.done", + output_index: 0, + content_index: 0, + text: SYNTHETIC_RESPONSE, + }, + }, + { + event: "response.completed", + data: { + type: "response.completed", + response: { + id: "persisted-session", + object: "response", + status: "completed", + output: [ + { + id: "message-1", + type: "message", + role: "assistant", + content: [{ type: "output_text", text: SYNTHETIC_RESPONSE }], + }, + ], + usage: { input_tokens: 1, output_tokens: 1, total_tokens: 2 }, + }, + }, + }, +] + .map(({ event, data }) => `event: ${event}\ndata: ${JSON.stringify(data)}\n\n`) + .join(""); + +const RESPONSE_JSON = JSON.stringify({ + id: "persisted-session", + object: "response", + status: "completed", + output: [ + { + id: "message-1", + type: "message", + role: "assistant", + content: [{ type: "output_text", text: SYNTHETIC_RESPONSE }], + }, + ], + usage: { input_tokens: 1, output_tokens: 1, total_tokens: 2 }, +}); + +const CHAT_COMPLETION_STREAM = [ + { + id: "persisted-session", + object: "chat.completion.chunk", + created: 1, + model: "claude-sonnet-4.5", + choices: [ + { + index: 0, + delta: { role: "assistant", content: SYNTHETIC_RESPONSE }, + finish_reason: null, + }, + ], + }, + { + id: "persisted-session", + object: "chat.completion.chunk", + created: 1, + model: "claude-sonnet-4.5", + choices: [{ index: 0, delta: {}, finish_reason: "stop" }], + }, +] + .map((data) => `data: ${JSON.stringify(data)}\n\n`) + .concat("data: [DONE]\n\n") + .join(""); + +const CHAT_COMPLETION_RESPONSE_JSON = JSON.stringify({ + id: "persisted-session", + object: "chat.completion", + created: 1, + model: "claude-sonnet-4.5", + choices: [ + { + index: 0, + message: { role: "assistant", content: SYNTHETIC_RESPONSE }, + finish_reason: "stop", + }, + ], + usage: { prompt_tokens: 1, completion_tokens: 1, total_tokens: 2 }, +}); + +const MODEL_CATALOG_JSON = JSON.stringify({ + data: [ + { + id: "claude-sonnet-4.5", + name: "Claude Sonnet 4.5", + object: "model", + vendor: "Anthropic", + version: "1", + preview: false, + model_picker_enabled: true, + capabilities: { + type: "chat", + family: "claude-sonnet-4.5", + tokenizer: "o200k_base", + limits: { max_context_window_tokens: 200000, max_output_tokens: 8192 }, + supports: { streaming: true, tool_calls: true, parallel_tool_calls: true }, + }, + }, + ], +}); + +describe("disabled MCP servers", async () => { + const { + copilotClient: client, + createClient, + openAiEndpoint, + workDir, + } = await createSdkTestContext({ + copilotClientOptions: { + requestHandler: new PersistingRequestHandler(), + }, + }); + + function createPluginDirectory(prefix: string): { + pluginDirectory: string; + controlMarker: string; + disabledMarker: string; + } { + const pluginDirectory = join(workDir, `${prefix}-${randomUUID()}`); + mkdirSync(pluginDirectory, { recursive: true }); + const controlMarker = join(pluginDirectory, "control-started.log"); + const disabledMarker = join(pluginDirectory, "disabled-started.log"); + + writeFileSync( + join(pluginDirectory, "plugin.json"), + JSON.stringify({ + name: `${prefix}-${randomUUID()}`, + version: "1.0.0", + }) + ); + writeFileSync( + join(pluginDirectory, ".mcp.json"), + JSON.stringify({ + mcpServers: { + control: { + type: "stdio", + command: process.execPath, + args: [ + TEST_MCP_SERVER, + "--startup-marker", + controlMarker, + "--server-name", + "control", + ], + }, + disabled: { + type: "stdio", + command: process.execPath, + args: [ + TEST_MCP_SERVER, + "--startup-marker", + disabledMarker, + "--server-name", + "disabled", + ], + }, + }, + }) + ); + + return { pluginDirectory, controlMarker, disabledMarker }; + } + + function markerCount(markerPath: string): number { + if (!existsSync(markerPath)) { + return 0; + } + return readFileSync(markerPath, "utf8").trim().split("\n").filter(Boolean).length; + } + + async function waitForMarkerCount(markerPath: string, expectedCount: number): Promise { + await waitForCondition(() => markerCount(markerPath) >= expectedCount, { + timeoutMs: 60_000, + intervalMs: 100, + timeoutMessage: `Timed out waiting for ${markerPath} to be written ${expectedCount} time(s).`, + }); + } + + async function waitForMcpStatus( + session: CopilotSession, + serverName: string, + expectedStatus: string + ): Promise { + let lastStatus = ""; + await waitForCondition( + async () => { + const result = await session.rpc.mcp.list(); + const server = result.servers.find((candidate) => candidate.name === serverName); + lastStatus = server?.status ?? ""; + return lastStatus === expectedStatus; + }, + { + timeoutMs: 60_000, + intervalMs: 100, + timeoutMessage: `${serverName} did not reach ${expectedStatus}; last status was ${lastStatus}.`, + } + ); + } + + function expectSyntheticResponse(response: Awaited>) { + expect(response?.data.content).toBe(SYNTHETIC_RESPONSE); + } + + async function drainPostCreateRpc(session: CopilotSession): Promise { + // Drain a non-MCP post-create RPC without initializing MCP before the first model turn. + await session.rpc.metadata.snapshot(); + } + + async function mcpRequestCount(): Promise { + const requests = await openAiEndpoint.getRequests(); + return requests.filter((request) => request.method === "POST" && request.url === "/mcp") + .length; + } + + async function waitForMcpRequestCount(expectedCount: number): Promise { + let lastCount = 0; + await waitForCondition( + async () => { + lastCount = await mcpRequestCount(); + return lastCount >= expectedCount; + }, + { + timeoutMs: 60_000, + intervalMs: 100, + timeoutMessage: `Timed out waiting for ${expectedCount} /mcp request(s); saw ${lastCount}.`, + } + ); + } + + it( + "keeps disabled plugin MCP servers per-session on create", + { timeout: 120_000 }, + async () => { + const { + pluginDirectory: disabledPluginDirectory, + controlMarker: disabledControlMarker, + disabledMarker, + } = createPluginDirectory("disabled-mcp-create"); + + await using disabledSession = await client.createSession({ + onPermissionRequest: approveAll, + pluginDirectories: [disabledPluginDirectory], + disabledMcpServers: ["disabled"], + }); + + await drainPostCreateRpc(disabledSession); + expect(existsSync(disabledControlMarker)).toBe(false); + expect(existsSync(disabledMarker)).toBe(false); + expectSyntheticResponse( + await disabledSession.sendAndWait({ prompt: MCP_TRIGGER_PROMPT }) + ); + await waitForMarkerCount(disabledControlMarker, 1); + expect(existsSync(disabledMarker)).toBe(false); + await waitForMcpStatus(disabledSession, "control", "connected"); + await waitForMcpStatus(disabledSession, "disabled", "disabled"); + + const { + pluginDirectory: enabledPluginDirectory, + controlMarker: enabledControlMarker, + disabledMarker: enabledDisabledMarker, + } = createPluginDirectory("enabled-mcp-create"); + await using enabledSession = await client.createSession({ + onPermissionRequest: approveAll, + pluginDirectories: [enabledPluginDirectory], + }); + await drainPostCreateRpc(enabledSession); + expect(existsSync(enabledControlMarker)).toBe(false); + expect(existsSync(enabledDisabledMarker)).toBe(false); + expectSyntheticResponse( + await enabledSession.sendAndWait({ prompt: MCP_TRIGGER_PROMPT }) + ); + await waitForMarkerCount(enabledControlMarker, 1); + await waitForMarkerCount(enabledDisabledMarker, 1); + await waitForMcpStatus(enabledSession, "control", "connected"); + await waitForMcpStatus(enabledSession, "disabled", "connected"); + } + ); + + it( + "keeps the built-in GitHub MCP server disabled on the first message", + { timeout: 120_000 }, + async () => { + const disabledSession = await client.createSession({ + onPermissionRequest: approveAll, + enableConfigDiscovery: true, + enableMcpApps: true, + githubMcpToolConfig: { enableAllTools: true }, + disabledMcpServers: ["github-mcp-server"], + }); + + let disabledRequestsBeforeFirstMessage: number; + try { + await drainPostCreateRpc(disabledSession); + disabledRequestsBeforeFirstMessage = await mcpRequestCount(); + expect(disabledRequestsBeforeFirstMessage).toBe(0); + expectSyntheticResponse( + await disabledSession.sendAndWait({ prompt: MCP_TRIGGER_PROMPT }) + ); + expect(await mcpRequestCount()).toBe(disabledRequestsBeforeFirstMessage); + await waitForMcpStatus(disabledSession, "github-mcp-server", "disabled"); + expect(await mcpRequestCount()).toBe(disabledRequestsBeforeFirstMessage); + } finally { + await disabledSession.disconnect(); + } + + expect(await mcpRequestCount()).toBe(disabledRequestsBeforeFirstMessage); + + await using enabledSession = await client.createSession({ + onPermissionRequest: approveAll, + enableConfigDiscovery: true, + enableMcpApps: true, + githubMcpToolConfig: { enableAllTools: true }, + }); + await drainPostCreateRpc(enabledSession); + const requestsBeforeFirstMessage = await mcpRequestCount(); + expect(requestsBeforeFirstMessage).toBe(0); + expectSyntheticResponse( + await enabledSession.sendAndWait({ prompt: MCP_TRIGGER_PROMPT }) + ); + await waitForMcpRequestCount(requestsBeforeFirstMessage + 1); + await waitForMcpStatus(enabledSession, "github-mcp-server", "connected"); + } + ); + + it.skipIf(isInProcessTransport)( + "applies disabled plugin MCP servers on cold stdio resume", + async () => { + const { pluginDirectory, controlMarker, disabledMarker } = + createPluginDirectory("disabled-mcp-resume"); + const initialClient = createClient({ + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + requestHandler: new PersistingRequestHandler(), + }); + const resumeClient = createClient({ + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + }); + + try { + const originalSession = await initialClient.createSession({ + onPermissionRequest: approveAll, + enableSessionStore: true, + }); + const sessionId = originalSession.sessionId; + // A session.log entry alone does not materialize a session that a + // restarted runtime can resume. This self-contained model turn + // persists it without initializing MCP because no plugin directory + // is supplied until the resume request below. + const response = await originalSession.sendAndWait({ + prompt: "Return the configured persistence marker.", + }); + expectSyntheticResponse(response); + + expect(existsSync(controlMarker)).toBe(false); + expect(existsSync(disabledMarker)).toBe(false); + await initialClient.stop(); + + await using resumedSession = await resumeClient.resumeSession(sessionId, { + onPermissionRequest: approveAll, + enableSessionStore: true, + pluginDirectories: [pluginDirectory], + disabledMcpServers: ["disabled"], + }); + await waitForMcpStatus(resumedSession, "control", "connected"); + await waitForMcpStatus(resumedSession, "disabled", "disabled"); + await waitForMarkerCount(controlMarker, 1); + expect(existsSync(disabledMarker)).toBe(false); + } finally { + await initialClient.stop().catch(() => {}); + await resumeClient.stop().catch(() => {}); + } + } + ); +}); diff --git a/nodejs/test/e2e/factory.e2e.test.ts b/nodejs/test/e2e/factory.e2e.test.ts new file mode 100644 index 000000000..8c038d9de --- /dev/null +++ b/nodejs/test/e2e/factory.e2e.test.ts @@ -0,0 +1,312 @@ +import { execFileSync } from "node:child_process"; +import { existsSync, readFileSync, writeFileSync } from "node:fs"; +import { copyFile, mkdir, rm } from "node:fs/promises"; +import { dirname, join, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { expect, it, vi } from "vitest"; +import { approveAll, FactoryResumeError } from "../../src/index.js"; +import { + createSdkTestContext, + DEFAULT_GITHUB_TOKEN, + isInProcessTransport, +} from "./harness/sdkTestContext.js"; +import { retry } from "./harness/sdkTestHelper.js"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); +const factoryTestContext = isInProcessTransport + ? undefined + : await createSdkTestContext({ + copilotClientOptions: { + env: { + COPILOT_CLI_ENABLED_FEATURE_FLAGS: "EXTENSIONS,AGENT_FACTORIES", + }, + }, + }); + +async function setupFactoryExtension(workDir: string, onPermissionRequest = approveAll) { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + + const { copilotClient, openAiEndpoint } = factoryTestContext; + const extensionDir = join(workDir, ".github", "extensions", "factory-smoke"); + const readyFile = join(extensionDir, "ready"); + await rm(join(workDir, ".github"), { recursive: true, force: true }); + await mkdir(extensionDir, { recursive: true }); + await copyFile( + join(__dirname, "fixtures", "factory-extension.mjs"), + join(extensionDir, "extension.mjs") + ); + execFileSync("git", ["init", "--quiet"], { cwd: workDir }); + + await openAiEndpoint.setCopilotUserByToken(DEFAULT_GITHUB_TOKEN, { + login: "factory-e2e-user", + copilot_plan: "individual_pro", + token_based_billing: true, + is_mcp_enabled: true, + endpoints: { + api: openAiEndpoint.url, + telemetry: "https://localhost:1/telemetry", + }, + analytics_tracking_id: "e2e-test-tracking-id", + }); + + const session = await copilotClient.createSession({ + requestExtensions: true, + extensionSdkPath: resolve(__dirname, "..", "..", "dist"), + onPermissionRequest, + onElicitationRequest: async () => ({ + action: "accept", + content: { action: "approve" }, + }), + }); + + await retry( + "wait for the factory extension to join the session", + async () => { + expect(existsSync(readyFile)).toBe(true); + }, + 300, + 100 + ); + + return session; +} + +it.skipIf(isInProcessTransport)( + "runs an extension-authored factory across the SDK process boundary", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const result = await session.factory.run("argument-echo", { + args: { source: "sdk-e2e", count: 11 }, + }); + + expect(result).toMatchObject({ + status: "completed", + result: { source: "sdk-e2e", count: 11 }, + }); + } +); + +it.skipIf(isInProcessTransport)( + "forwards every declared subagent option to the runtime", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const result = await session.factory.run("forwards-subagent-options"); + + expect(result).toMatchObject({ + status: "completed", + result: { didThrow: false }, + }); + }, + // The factory abandons its subagent once the runtime has accepted the + // request, so the run settles only after the runtime drains that work. + 60_000 +); + +it.skipIf(isInProcessTransport)( + "throws FactoryResumeError with not_found for an unknown run", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const error = await session.factory + .resume("00000000-0000-0000-0000-000000000000") + .catch((caught: unknown) => caught); + + expect(error).toBeInstanceOf(FactoryResumeError); + expect((error as FactoryResumeError).code).toBe("not_found"); + } +); + +it.skipIf(isInProcessTransport)( + "throws FactoryResumeError with non_resumable for a completed run", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const run = await session.factory.run("argument-echo"); + const error = await session.factory.resume(run.runId).catch((caught: unknown) => caught); + + expect(error).toBeInstanceOf(FactoryResumeError); + expect((error as FactoryResumeError).code).toBe("non_resumable"); + } +); + +it.skipIf(isInProcessTransport)( + "runs a factory when its session denies every permission request", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + const denyPermissions = vi.fn(() => ({ kind: "reject" as const })); + await using session = await setupFactoryExtension(workDir, denyPermissions); + + await expect(session.factory.run("argument-echo")).resolves.toMatchObject({ + status: "completed", + }); + expect(denyPermissions).not.toHaveBeenCalled(); + } +); + +it.skipIf(isInProcessTransport)( + "resumes a failed factory when its session denies every permission request", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + const denyPermissions = vi.fn(() => ({ kind: "reject" as const })); + await using session = await setupFactoryExtension(workDir, denyPermissions); + + const failedRun = await session.factory.run("fails-once"); + expect(failedRun).toMatchObject({ + status: "error", + }); + + await expect(session.factory.resume(failedRun.runId)).resolves.toMatchObject({ + status: "completed", + result: "resumed", + }); + expect(denyPermissions).not.toHaveBeenCalled(); + } +); + +it.skipIf(isInProcessTransport)( + "refuses a factory started through the context session from a factory body", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const result = await session.factory.run("starts-from-context-session"); + + expect(result).toMatchObject({ + status: "completed", + result: expect.stringContaining("factory.run and factory.resume"), + }); + expect((result as { result: string }).result).toContain("factory body"); + } +); + +it.skipIf(isInProcessTransport)( + "refuses a factory started through the module session from a factory body", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const result = await session.factory.run("starts-from-module-session"); + + expect(result).toMatchObject({ + status: "completed", + result: expect.stringContaining("factory.run and factory.resume"), + }); + expect((result as { result: string }).result).toContain("factory body"); + } +); + +it.skipIf(isInProcessTransport)( + "allows a module-level extension watcher to start a factory while another body is parked", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + const extensionDir = join(workDir, ".github", "extensions", "factory-smoke"); + await using session = await setupFactoryExtension(workDir); + + const parked = session.factory.run("parked"); + await retry( + "wait for the parked factory to enter its body", + async () => { + expect(existsSync(join(extensionDir, "entered"))).toBe(true); + }, + 100, + 100 + ); + + writeFileSync(join(extensionDir, "start-b"), "start"); + const bResultFile = join(extensionDir, "b-result"); + await retry( + "wait for the module-level watcher factory run to succeed", + async () => { + expect(existsSync(bResultFile)).toBe(true); + expect(JSON.parse(readFileSync(bResultFile, "utf8"))).toMatchObject({ + status: "success", + result: { + status: "completed", + result: { source: "module-watcher" }, + }, + }); + }, + 100, + 100 + ); + + writeFileSync(join(extensionDir, "release"), "release"); + await expect(parked).resolves.toMatchObject({ + status: "completed", + result: "released", + }); + }, + 60_000 +); + +it.skipIf(isInProcessTransport)( + "returns an array result from an extension-authored factory", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const result = await session.factory.run("array-result"); + + expect(result).toMatchObject({ + status: "completed", + result: [1, "two", false], + }); + } +); + +it.skipIf(isInProcessTransport)( + "passes array factory arguments across the SDK process boundary", + async () => { + if (!factoryTestContext) { + throw new Error("Factory E2E requires the stdio transport"); + } + const { workDir } = factoryTestContext; + await using session = await setupFactoryExtension(workDir); + + const args = [1, "two", false]; + const result = await session.factory.run("argument-echo", { args }); + + expect(result).toMatchObject({ + status: "completed", + result: args, + }); + } +); diff --git a/nodejs/test/e2e/fixtures/factory-extension.mjs b/nodejs/test/e2e/fixtures/factory-extension.mjs new file mode 100644 index 000000000..45227a1be --- /dev/null +++ b/nodejs/test/e2e/fixtures/factory-extension.mjs @@ -0,0 +1,171 @@ +import { existsSync, writeFileSync } from "node:fs"; +import { defineFactory, joinSession } from "@github/copilot-sdk/extension"; + +const marker = (name) => new URL(`./${name}`, import.meta.url); + +async function waitForMarker(name, timeoutMs) { + const deadline = Date.now() + timeoutMs; + while (!existsSync(marker(name))) { + if (Date.now() >= deadline) { + throw new Error(`Timed out waiting for ${name}`); + } + await new Promise((resolve) => setTimeout(resolve, 50)); + } +} + +const argumentEcho = defineFactory({ + meta: { + name: "argument-echo", + description: "Return the invocation arguments verbatim.", + phases: [], + // Proves a declared shape survives the SDK boundary and registers against a + // real runtime. It does not exercise enforcement: `argsSchema` is checked by + // the model's `run_factory` tool, and these tests invoke `session.factory.run`, + // which does not validate. The declaration stays as wide as this factory's + // actual contract — it echoes any JsonValue, and is called with an array, an + // object, and nothing — so it cannot constrain the runs below. + argsSchema: { + type: ["object", "array", "string", "number", "integer", "boolean", "null"], + }, + }, + run: async ({ args }) => args, +}); + +const arrayResult = defineFactory({ + meta: { + name: "array-result", + description: "Return an array result.", + phases: [], + }, + run: async () => [1, "two", false], +}); + +const forwardsSubagentOptions = defineFactory({ + meta: { + name: "forwards-subagent-options", + description: "Send every declared subagent option to the runtime.", + phases: [], + }, + run: async ({ agent }) => { + // Only the runtime's acceptance of the payload is under test. A refused + // request rejects quickly, because the runtime parses the options before + // it starts a subagent. A subagent that is merely slow to reach a model + // proves the payload was accepted, so waiting for it adds nothing and + // hangs wherever no model is reachable. + const call = agent("Confirm that this request is accepted.", { + agent: "reviewer", + reasoningEffort: "high", + contextTier: "long_context", + }); + // A rejection that lands after the race still needs a handler. + call.catch(() => {}); + let settleTimer; + const stillPending = new Promise((resolve) => { + settleTimer = setTimeout(() => resolve(undefined), 3000); + settleTimer.unref?.(); + }); + try { + await Promise.race([call, stillPending]); + return { didThrow: false }; + } catch { + return { didThrow: true }; + } finally { + clearTimeout(settleTimer); + } + }, +}); + +const startsFromContextSession = defineFactory({ + meta: { + name: "starts-from-context-session", + description: "Try to start a factory through the context session.", + phases: [], + }, + run: async ({ session }) => { + try { + await session.factory.run("argument-echo"); + return "unexpectedly started a factory"; + } catch (error) { + return error instanceof Error ? error.message : String(error); + } + }, +}); + +let session; + +const startsFromModuleSession = defineFactory({ + meta: { + name: "starts-from-module-session", + description: "Try to start a factory through the module session.", + phases: [], + }, + run: async () => { + try { + await session.factory.run("argument-echo"); + return "unexpectedly started a factory"; + } catch (error) { + return error instanceof Error ? error.message : String(error); + } + }, +}); + +const parked = defineFactory({ + meta: { + name: "parked", + description: "Wait for a test-controlled release marker.", + phases: [], + }, + run: async () => { + writeFileSync(marker("entered"), "entered"); + await waitForMarker("release", 30_000); + return "released"; + }, +}); + +const failsOnce = defineFactory({ + meta: { + name: "fails-once", + description: "Fails its first attempt and succeeds when resumed.", + phases: [], + }, + run: async () => { + if (!existsSync(marker("fails-once-attempted"))) { + writeFileSync(marker("fails-once-attempted"), "attempted"); + throw new Error("first attempt failed"); + } + return "resumed"; + }, +}); + +session = await joinSession({ + factories: [ + argumentEcho, + arrayResult, + forwardsSubagentOptions, + startsFromContextSession, + startsFromModuleSession, + parked, + failsOnce, + ], +}); + +void waitForMarker("start-b", 30_000) + .then(async () => { + const result = await session.factory.run("argument-echo", { + args: { source: "module-watcher" }, + }); + writeFileSync(marker("b-result"), JSON.stringify({ status: "success", result })); + }) + .catch((error) => { + if (existsSync(marker("start-b"))) { + writeFileSync( + marker("b-result"), + JSON.stringify({ + status: "error", + error: error instanceof Error ? error.message : String(error), + }) + ); + } + }); + +writeFileSync(marker("ready"), "ready"); diff --git a/nodejs/test/e2e/github_telemetry.e2e.test.ts b/nodejs/test/e2e/github_telemetry.e2e.test.ts new file mode 100644 index 000000000..e33178f9d --- /dev/null +++ b/nodejs/test/e2e/github_telemetry.e2e.test.ts @@ -0,0 +1,57 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll, GitHubTelemetryNotification } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { waitForCondition } from "./harness/sdkTestHelper.js"; + +// Experimental: exercises the end-to-end GitHub (hydro) telemetry forwarding +// path. The runtime forwards per-session telemetry to opted-in connections via +// the `gitHubTelemetry.event` JSON-RPC *notification*; the SDK opts in +// automatically whenever an `onGitHubTelemetry` handler is registered. Creating +// a session emits an early `session.start` hydro event, so no model round-trip +// (and therefore no recorded CAPI exchange) is needed to observe forwarding. +describe("GitHub telemetry forwarding", async () => { + const received: GitHubTelemetryNotification[] = []; + + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { + onGitHubTelemetry: (notification) => { + received.push(notification); + }, + }, + }); + + it( + "forwards gitHubTelemetry.event notifications from a live session", + { timeout: 60_000 }, + async () => { + received.length = 0; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + }); + + // The CLI forwards telemetry over the JSON-RPC connection + // asynchronously, so wait until at least one event arrives or we + // time out. + await waitForCondition(() => received.length > 0, { + timeoutMs: 30_000, + timeoutMessage: "Timed out waiting for a gitHubTelemetry.event notification.", + }); + + expect(received.length).toBeGreaterThan(0); + + const notification = received[0]; + expect(typeof notification.sessionId).toBe("string"); + expect(notification.sessionId.length).toBeGreaterThan(0); + expect(typeof notification.restricted).toBe("boolean"); + expect(notification.event).toBeDefined(); + expect(typeof notification.event.kind).toBe("string"); + + await session.disconnect(); + } + ); +}); diff --git a/nodejs/test/e2e/harness/CapiProxy.ts b/nodejs/test/e2e/harness/CapiProxy.ts index a6232587e..c25d422f9 100644 --- a/nodejs/test/e2e/harness/CapiProxy.ts +++ b/nodejs/test/e2e/harness/CapiProxy.ts @@ -2,6 +2,7 @@ import { spawn } from "child_process"; import { resolve } from "path"; import { createInterface } from "readline"; import { expect } from "vitest"; +import type { CapturedRequest } from "../../../../test/harness/replayingCapiProxy"; import { CopilotUserResponse, ParsedHttpExchange, @@ -121,6 +122,11 @@ export class CapiProxy { return await response.json(); } + async getRequests(): Promise { + const response = await fetch(`${this.proxyUrl}/requests`, { method: "GET" }); + return await response.json(); + } + async stop(skipWritingCache?: boolean): Promise { const url = skipWritingCache ? `${this.proxyUrl}/stop?skipWritingCache=true` diff --git a/nodejs/test/e2e/harness/sdkTestContext.ts b/nodejs/test/e2e/harness/sdkTestContext.ts index d7eff3d59..bf62db482 100644 --- a/nodejs/test/e2e/harness/sdkTestContext.ts +++ b/nodejs/test/e2e/harness/sdkTestContext.ts @@ -16,10 +16,40 @@ import { formatError, retry } from "./sdkTestHelper"; export const isCI = process.env.GITHUB_ACTIONS === "true"; export const DEFAULT_GITHUB_TOKEN = "fake-token-for-e2e-tests"; +/** + * True when the E2E suite is running over the in-process (FFI) transport + * (COPILOT_SDK_DEFAULT_CONNECTION=inprocess). Use with `it.skipIf` / `describe.skipIf` + * to skip tests for features that are not supported over the in-process transport (the + * runtime loads into the shared host process), so the in-process CI cell stays green. + * Such features are covered by the default (stdio) cell. + */ +export const isInProcessTransport = + (process.env.COPILOT_SDK_DEFAULT_CONNECTION ?? "").toLowerCase() === "inprocess"; + +// The in-process (FFI) transport resolves auth host-side, in this test process, and +// ranks HMAC above the GitHub token — so an ambient COPILOT_HMAC_KEY (CI sets one as a +// job-level credential) would be picked over the SDK/Bearer token the replay snapshots +// expect, yielding 401s. Host-side auth can capture the key as early as client +// construction (before any per-test beforeEach runs), so neutralize it at module load — +// the analogue of .NET's InProcessEnvIsolation `[ModuleInitializer]`. Only applied for +// the in-process transport; stdio/tcp children resolve auth in their own process where +// the token already outranks HMAC. See https://github.com/github/copilot-sdk/issues/1934. +if ((process.env.COPILOT_SDK_DEFAULT_CONNECTION ?? "").toLowerCase() === "inprocess") { + delete process.env.COPILOT_HMAC_KEY; + delete process.env.CAPI_HMAC_KEY; +} + const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); const SNAPSHOTS_DIR = resolve(__dirname, "../../../../test/snapshots"); +function getCliPathForTests(): string | undefined { + if (process.env.COPILOT_CLI_PATH) { + return process.env.COPILOT_CLI_PATH; + } + return undefined; +} + export async function createSdkTestContext({ logLevel, useStdio, @@ -39,6 +69,7 @@ export async function createSdkTestContext({ await openAiEndpoint.setCopilotUserByToken(DEFAULT_GITHUB_TOKEN, { login: "e2e-test-user", copilot_plan: "individual_pro", + is_mcp_enabled: true, endpoints: { api: proxyUrl, telemetry: "https://localhost:1/telemetry", @@ -53,11 +84,22 @@ export async function createSdkTestContext({ ...process.env, ...openAiEndpoint.getProxyEnv(), COPILOT_API_URL: proxyUrl, + // Route GitHub API calls (e.g. the MCP registry policy check) to the + // replay proxy so MCP enablement stays hermetic. Without this the CLI + // reaches the real api.github.com, which is slow/unreachable on macOS + // CI runners and makes MCP servers time out before reaching connected. + COPILOT_DEBUG_GITHUB_API_URL: proxyUrl, COPILOT_HOME: copilotHomeDir, COPILOT_SDK_AUTH_TOKEN: "", GH_CONFIG_DIR: homeDir, - GH_TOKEN: "", - GITHUB_TOKEN: "", + // Use the proxy-recognized token rather than blanking these. Tests that spin up + // their own client without passing `gitHubToken` (e.g. the stdio/tcp + // "works without onPermissionRequest" cases) rely on GH_TOKEN/GITHUB_TOKEN to + // authenticate against the replay proxy. Blanking them only worked on CI, where an + // ambient COPILOT_HMAC_KEY secret supplies the credential instead; locally there is + // no HMAC key, so the child CLI had nothing to authenticate with and got a 401. + GH_TOKEN: authTokenToUse, + GITHUB_TOKEN: authTokenToUse, // TODO: I'm not convinced the SDK should default to using whatever config you happen to have in your homedir. // The SDK config should be independent of the regular CLI app. Likewise it shouldn't mix sessions from the @@ -67,6 +109,7 @@ export async function createSdkTestContext({ }; const userConn = copilotClientOptions?.connection; + const cliPath = getCliPathForTests(); let connection: RuntimeConnection; if (userConn) { // Caller supplied a RuntimeConnection — merge in the harness-managed @@ -77,40 +120,121 @@ export async function createSdkTestContext({ const { kind: _k, ...tcp } = userConn; connection = RuntimeConnection.forTcp({ ...tcp, - path: tcp.path ?? process.env.COPILOT_CLI_PATH, + path: tcp.path ?? cliPath, }); } else if (userConn.kind === "stdio") { const { kind: _k, ...stdio } = userConn; connection = RuntimeConnection.forStdio({ ...stdio, - path: stdio.path ?? process.env.COPILOT_CLI_PATH, + path: stdio.path ?? cliPath, }); } else { connection = userConn; } + } else if (useStdio === false) { + connection = RuntimeConnection.forTcp({ path: cliPath }); + } else if ( + useStdio === undefined && + (process.env.COPILOT_SDK_DEFAULT_CONNECTION ?? "").toLowerCase() === "inprocess" + ) { + // The in-process FFI transport resolves the CLI entrypoint itself + // (COPILOT_CLI_PATH or the bundled platform package), so no path is passed. + connection = RuntimeConnection.forInProcess(); } else { - connection = - useStdio === false - ? RuntimeConnection.forTcp({ path: process.env.COPILOT_CLI_PATH }) - : RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }); + connection = RuntimeConnection.forStdio({ path: cliPath }); } - const { connection: _ignoredConnection, ...remainingClientOptions } = - copilotClientOptions ?? {}; - const copilotClient = new CopilotClient({ - workingDirectory: workDir, - env, - logLevel: logLevel || "error", - connection, - gitHubToken: authTokenToUse, - ...remainingClientOptions, - }); + const { + connection: _ignoredConnection, + env: userEnv, + ...remainingClientOptions + } = copilotClientOptions ?? {}; - const harness = { homeDir, workDir, openAiEndpoint, copilotClient, env }; + const mergedEnv = { ...env, ...userEnv }; + + // The in-process (FFI) transport loads the runtime into this test host process, + // and its worker inherits this process's ambient environment rather than a + // per-client env block (see https://github.com/github/copilot-sdk/issues/1934). + // So the per-test redirects, isolated home, and credentials must be mirrored onto + // the real process environment. Node's `process.env` writes reach native `getenv`, + // so host-side runtime reads (auth resolution, GitHub API redirect) observe them. + // Auth flows via GH_TOKEN/GITHUB_TOKEN here (the FFI argv omits the stdio + // `--auth-token-env COPILOT_SDK_AUTH_TOKEN` wiring), and HMAC is disabled so + // host-side auth resolution picks the SDK/Bearer token the replay snapshots expect. + const isInProcess = connection.kind === "inprocess"; + const inProcessEnv: Record = isInProcess + ? { + ...(mergedEnv as Record), + GH_TOKEN: authTokenToUse, + GITHUB_TOKEN: authTokenToUse, + COPILOT_HMAC_KEY: "", + CAPI_HMAC_KEY: "", + } + : {}; + + // Builds a CopilotClient wired for the active transport, so tests that need a + // secondary client (e.g. resuming a session from a fresh client) don't have to + // reimplement the in-process env/cwd handling. Callers may override the connection + // (e.g. pin stdio for telemetry, which the in-process transport cannot carry + // per-client); env is attached to child-process transports and mirrored onto the + // process for in-process (see beforeEach below), never passed per-client for the + // in-process transport where it would be rejected. + function createClient(overrides: Partial = {}): CopilotClient { + const { + connection: overrideConnection, + env: _ignoredEnv, + workingDirectory: overrideWorkingDirectory, + ...rest + } = overrides; + + let effectiveConnection = overrideConnection ?? connection; + // Fill in the bundled CLI path for child-process connections that omit it + // (e.g. a bare RuntimeConnection.forStdio() used to pin telemetry to stdio). + if (effectiveConnection.kind === "stdio" && effectiveConnection.path === undefined) { + effectiveConnection = RuntimeConnection.forStdio({ + ...effectiveConnection, + path: cliPath, + }); + } else if (effectiveConnection.kind === "tcp" && effectiveConnection.path === undefined) { + effectiveConnection = RuntimeConnection.forTcp({ + ...effectiveConnection, + path: cliPath, + }); + } + const effectiveInProcess = effectiveConnection.kind === "inprocess"; + + return new CopilotClient({ + // The in-process transport rejects a per-client workingDirectory (it would have to + // mutate the shared host process cwd). Instead the harness changes this process's + // cwd to workDir around the in-process worker's startup (see beforeEach below), so + // the worker still spawns with workDir as its cwd. Out-of-process clients get it + // as a normal per-client option. + workingDirectory: + overrideWorkingDirectory ?? (effectiveInProcess ? undefined : workDir), + // In-process hosting mirrors the environment onto the real process (per test, in + // beforeEach below), so the worker inherits it; passing a per-client env here + // would have no effect (and is rejected by the in-process transport). + env: effectiveInProcess ? undefined : mergedEnv, + logLevel: logLevel || "error", + connection: effectiveConnection, + gitHubToken: authTokenToUse, + ...rest, + }); + } + + const copilotClient = createClient(remainingClientOptions); + + const harness = { homeDir, workDir, openAiEndpoint, copilotClient, env, createClient }; // Track if any test fails to avoid writing corrupted snapshots let anyTestFailed = false; + // Holds the process.env entries the current test overwrote, so afterEach restores them. + let restoreProcessEnv: Array<[string, string | undefined]> = []; + + // Holds the process cwd before an in-process test changed it, so afterEach restores it. + let restoreCwd: string | undefined; + // Wire up to Vitest lifecycle beforeEach(async (testContext) => { // Must be inside beforeEach - vitest requires test context @@ -118,6 +242,25 @@ export async function createSdkTestContext({ anyTestFailed = true; }); + // Mirror this context's environment onto the real process for in-process + // hosting, right before the test runs (see the comment above the client). The + // client auto-starts on first use inside the test body, so the worker spawns + // under these values. + restoreProcessEnv = []; + for (const [key, value] of Object.entries(inProcessEnv)) { + restoreProcessEnv.push([key, process.env[key]]); + process.env[key] = value; + } + + // The in-process worker inherits this process's cwd at spawn (the client auto-starts + // on first use inside the test body). Point cwd at workDir here so the worker spawns + // with the same working directory the out-of-process transport passes explicitly; + // afterEach restores it. + if (isInProcess) { + restoreCwd = process.cwd(); + process.chdir(workDir); + } + await openAiEndpoint.updateConfig({ filePath: getTrafficCapturePath(testContext), workDir, @@ -129,6 +272,20 @@ export async function createSdkTestContext({ }); afterEach(async () => { + // Undo this test's process.env mirror so it can't leak into the next test/suite. + for (const [key, previous] of restoreProcessEnv.reverse()) { + if (previous === undefined) { + delete process.env[key]; + } else { + process.env[key] = previous; + } + } + restoreProcessEnv = []; + // Restore the cwd an in-process test changed for worker startup. + if (restoreCwd !== undefined) { + process.chdir(restoreCwd); + restoreCwd = undefined; + } // Empty directories but leave them in place for next test await rimraf([join(homeDir, "*"), join(workDir, "*")], { glob: true }); }); @@ -136,7 +293,15 @@ export async function createSdkTestContext({ afterAll(async () => { await copilotClient.stop(); await openAiEndpoint.stop(anyTestFailed); - await rmDir("remove e2e test copilotHomeDir", copilotHomeDir); + // On Windows, this Vitest worker can retain the in-process runtime's session.db + // lock until the worker exits. Retrying from its afterAll hook cannot succeed: + // the hook waits for the lock, while the lock cannot clear until the hook returns + // and lets the worker exit. + await rmDir( + "remove e2e test copilotHomeDir", + copilotHomeDir, + isInProcess && process.platform === "win32" ? 1 : 30 + ); await rmDir("remove e2e test homeDir", homeDir); await rmDir("remove e2e test workDir", workDir); }); @@ -163,14 +328,14 @@ function getTrafficCapturePath(testContext: TestContext): string { return join(SNAPSHOTS_DIR, testFileName, `${taskNameAsFilename}.yaml`); } -async function rmDir(message: string, path: string): Promise { +async function rmDir(message: string, path: string, maxTries = 30): Promise { // Use longer retries to tolerate Windows holding SQLite session-store.db // open briefly after the CLI subprocess exits. If the temp dir still can't // be removed (e.g. CLI background writer racing with cleanup), warn and // continue rather than failing the whole test run — the OS / CI runner // will reclaim the temp dir on shutdown. try { - await retry(message, () => rm(path, { recursive: true, force: true }), 30, 1000); + await retry(message, () => rm(path, { recursive: true, force: true }), maxTries, 1000); } catch (error) { console.warn( `WARN: ${message} failed; leaving temp dir for OS cleanup: ${formatError(error)}` diff --git a/nodejs/test/e2e/hooks.e2e.test.ts b/nodejs/test/e2e/hooks.e2e.test.ts index 895097adb..4fce7d2ac 100644 --- a/nodejs/test/e2e/hooks.e2e.test.ts +++ b/nodejs/test/e2e/hooks.e2e.test.ts @@ -19,13 +19,14 @@ describe("Session hooks", async () => { it("should invoke preToolUse hook when model runs a tool", async () => { const preToolUseInputs: PreToolUseHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onPreToolUse: async (input, invocation) => { preToolUseInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); // Allow the tool to run return { permissionDecision: "allow" } as PreToolUseHookOutput; }, @@ -41,6 +42,9 @@ describe("Session hooks", async () => { // Should have received at least one preToolUse hook call expect(preToolUseInputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); // Should have received the tool name expect(preToolUseInputs.some((input) => input.toolName)).toBe(true); @@ -50,13 +54,14 @@ describe("Session hooks", async () => { it("should invoke postToolUse hook after model runs a tool", async () => { const postToolUseInputs: PostToolUseHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onPostToolUse: async (input, invocation) => { postToolUseInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); return null as PostToolUseHookOutput; }, }, @@ -71,6 +76,9 @@ describe("Session hooks", async () => { // Should have received at least one postToolUse hook call expect(postToolUseInputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); // Should have received the tool name and result expect(postToolUseInputs.some((input) => input.toolName)).toBe(true); diff --git a/nodejs/test/e2e/hooks_extended.e2e.test.ts b/nodejs/test/e2e/hooks_extended.e2e.test.ts index e0e82f813..3ac858650 100644 --- a/nodejs/test/e2e/hooks_extended.e2e.test.ts +++ b/nodejs/test/e2e/hooks_extended.e2e.test.ts @@ -6,6 +6,7 @@ import { describe, expect, it } from "vitest"; import { z } from "zod"; import { approveAll, defineTool } from "../../src/index.js"; import type { + AgentStopHookInput, ErrorOccurredHookInput, PostToolUseFailureHookInput, PostToolUseHookInput, @@ -13,6 +14,7 @@ import type { SessionEndHookInput, SessionStartHookInput, UserPromptSubmittedHookInput, + UserPromptTransformedHookInput, } from "../../src/types.js"; import { createSdkTestContext } from "./harness/sdkTestContext.js"; @@ -21,13 +23,14 @@ describe("Extended session hooks", async () => { it("should invoke onSessionStart hook on new session", async () => { const sessionStartInputs: SessionStartHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onSessionStart: async (input, invocation) => { sessionStartInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); }, }, }); @@ -37,6 +40,9 @@ describe("Extended session hooks", async () => { }); expect(sessionStartInputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); expect(sessionStartInputs[0].source).toBe("new"); expect(sessionStartInputs[0].timestamp).toBeInstanceOf(Date); expect(sessionStartInputs[0].workingDirectory).toBeDefined(); @@ -46,13 +52,14 @@ describe("Extended session hooks", async () => { it("should invoke onUserPromptSubmitted hook when sending a message", async () => { const userPromptInputs: UserPromptSubmittedHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onUserPromptSubmitted: async (input, invocation) => { userPromptInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); }, }, }); @@ -62,6 +69,9 @@ describe("Extended session hooks", async () => { }); expect(userPromptInputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); expect(userPromptInputs[0].prompt).toContain("Say hello"); expect(userPromptInputs[0].timestamp).toBeInstanceOf(Date); expect(userPromptInputs[0].workingDirectory).toBeDefined(); @@ -71,13 +81,14 @@ describe("Extended session hooks", async () => { it("should invoke onSessionEnd hook when session is disconnected", async () => { const sessionEndInputs: SessionEndHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onSessionEnd: async (input, invocation) => { sessionEndInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); }, }, }); @@ -92,17 +103,21 @@ describe("Extended session hooks", async () => { await new Promise((resolve) => setTimeout(resolve, 100)); expect(sessionEndInputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); }); it("should invoke onErrorOccurred hook when error occurs", async () => { const errorInputs: ErrorOccurredHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onErrorOccurred: async (input, invocation) => { errorInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); expect(input.timestamp).toBeInstanceOf(Date); expect(input.workingDirectory).toBeDefined(); expect(input.error).toBeDefined(); @@ -121,20 +136,23 @@ describe("Extended session hooks", async () => { // onErrorOccurred is dispatched by the runtime for actual errors (model failures, system errors). // In a normal session it may not fire. Verify the hook is properly wired by checking // that the session works correctly with the hook registered. - // If the hook did fire, the assertions inside it would have run. expect(session.sessionId).toBeDefined(); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); await session.disconnect(); }); it("should invoke userPromptSubmitted hook and modify prompt", async () => { const inputs: UserPromptSubmittedHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onUserPromptSubmitted: async (input, invocation) => { inputs.push(input); - expect(invocation.sessionId).toBeTruthy(); + invocationSessionIds.push(invocation.sessionId); return { modifiedPrompt: "Reply with exactly: HOOKED_PROMPT" }; }, }, @@ -143,20 +161,54 @@ describe("Extended session hooks", async () => { const response = await session.sendAndWait({ prompt: "Say something else" }); expect(inputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); expect(inputs[0].prompt).toContain("Say something else"); expect(response?.data.content ?? "").toContain("HOOKED_PROMPT"); await session.disconnect(); }); + it("should invoke userPromptTransformed hook and modify transformed prompt", async () => { + const inputs: UserPromptTransformedHookInput[] = []; + const session = await client.createSession({ + onPermissionRequest: approveAll, + hooks: { + onUserPromptTransformed: async (input, invocation) => { + inputs.push(input); + expect(invocation.sessionId).toBeTruthy(); + return { + modifiedTransformedPrompt: "Reply with exactly: HOOKED_TRANSFORMED_PROMPT", + }; + }, + }, + }); + + const response = await session.sendAndWait({ + prompt: "Answer the request above.", + }); + + expect(inputs.length).toBeGreaterThan(0); + expect(inputs[0].prompt).toContain("Answer the request above."); + expect(inputs[0].transformedPrompt).toContain("Answer the request above."); + expect(inputs[0].transformedPrompt).toContain(""); + expect(inputs[0].timestamp).toBeInstanceOf(Date); + expect(inputs[0].workingDirectory).toBeDefined(); + expect(response?.data.content ?? "").toContain("HOOKED_TRANSFORMED_PROMPT"); + + await session.disconnect(); + }); + it("should invoke sessionStart hook", async () => { const inputs: SessionStartHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onSessionStart: async (input, invocation) => { inputs.push(input); - expect(invocation.sessionId).toBeTruthy(); + invocationSessionIds.push(invocation.sessionId); return { additionalContext: "Session start hook context." }; }, }, @@ -165,6 +217,9 @@ describe("Extended session hooks", async () => { await session.sendAndWait({ prompt: "Say hi" }); expect(inputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); expect(inputs[0].source).toBe("new"); expect(inputs[0].workingDirectory).toBeTruthy(); @@ -173,6 +228,7 @@ describe("Extended session hooks", async () => { it("should invoke sessionEnd hook", async () => { const inputs: SessionEndHookInput[] = []; + const invocationSessionIds: string[] = []; let resolveHook!: (value: SessionEndHookInput) => void; const hookInvoked = new Promise((resolve) => { resolveHook = resolve; @@ -183,7 +239,7 @@ describe("Extended session hooks", async () => { hooks: { onSessionEnd: async (input, invocation) => { inputs.push(input); - expect(invocation.sessionId).toBeTruthy(); + invocationSessionIds.push(invocation.sessionId); resolveHook(input); return { sessionSummary: "session ended" }; }, @@ -206,16 +262,20 @@ describe("Extended session hooks", async () => { } expect(inputs.length).toBeGreaterThan(0); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); }); it("should register erroroccurred hook", async () => { const inputs: ErrorOccurredHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, hooks: { onErrorOccurred: async (input, invocation) => { inputs.push(input); - expect(invocation.sessionId).toBeTruthy(); + invocationSessionIds.push(invocation.sessionId); return { errorHandling: "skip" }; }, }, @@ -226,11 +286,44 @@ describe("Extended session hooks", async () => { // OnErrorOccurred is dispatched only by genuine runtime errors. A normal turn // cannot deterministically trigger one; this test is registration-only. expect(inputs.length).toBe(0); + expect(invocationSessionIds).toHaveLength(0); expect(session.sessionId).toBeTruthy(); await session.disconnect(); }); + it("should invoke agentStop hook and apply block response", async () => { + const inputs: AgentStopHookInput[] = []; + const session = await client.createSession({ + onPermissionRequest: approveAll, + hooks: { + onAgentStop: async (input, invocation) => { + expect(invocation.sessionId).toBe(session.sessionId); + inputs.push(input); + if (inputs.length === 1) { + return { + decision: "block", + reason: "Reply with exactly: AGENT_STOP_CONTINUED", + }; + } + }, + }, + }); + + const response = await session.sendAndWait({ + prompt: "Reply with exactly: AGENT_STOP_INITIAL", + }); + + expect(inputs).toHaveLength(2); + expect(inputs[0].stopHookActive).not.toBe(true); + expect(inputs[1].stopHookActive).toBe(true); + expect(inputs[0].stopReason).toBe("end_turn"); + expect(inputs[0].transcriptPath).toBeTruthy(); + expect(response?.data.content ?? "").toContain("AGENT_STOP_CONTINUED"); + + await session.disconnect(); + }); + it("should allow preToolUse to return modifiedArgs and suppressOutput", async () => { const inputs: PreToolUseHookInput[] = []; const session = await client.createSession({ @@ -272,11 +365,10 @@ describe("Extended session hooks", async () => { const inputs: PostToolUseHookInput[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, - availableTools: ["report_intent"], hooks: { onPostToolUse: async (input) => { inputs.push(input); - if (input.toolName !== "report_intent") { + if (input.toolName !== "view") { return undefined; } return { @@ -292,28 +384,32 @@ describe("Extended session hooks", async () => { }); const response = await session.sendAndWait({ - prompt: "Call the report_intent tool with intent 'Testing post hook', then reply done.", + prompt: "Call the view tool to read the current directory, then reply done.", }); - expect(inputs.some((input) => input.toolName === "report_intent")).toBe(true); - expect(response?.data.content).toBe("Done."); + expect(inputs.some((input) => input.toolName === "view")).toBe(true); + expect(response?.data.content?.toLowerCase()).toContain("done"); await session.disconnect(); }); - it("should invoke postToolUseFailure hook for failed tool result", async () => { + it.skip("should invoke postToolUseFailure hook for failed tool result", async () => { + // TODO: This test fails with 1.0.64-0 runtime due to built-in tools not being + // available when hooks are configured. Runtime returns "Tool 'view' does not exist. + // Available tools: report_intent" even though view is a built-in and availableTools + // wasn't specified. Follow up with runtime team. const failureInputs: PostToolUseFailureHookInput[] = []; const postToolUseInputs: PostToolUseHookInput[] = []; + const invocationSessionIds: string[] = []; const session = await client.createSession({ onPermissionRequest: approveAll, - availableTools: ["report_intent"], hooks: { onPostToolUse: async (input) => { postToolUseInputs.push(input); }, onPostToolUseFailure: async (input, invocation) => { failureInputs.push(input); - expect(invocation.sessionId).toBe(session.sessionId); + invocationSessionIds.push(invocation.sessionId); return { additionalContext: "HOOK_FAILURE_GUIDANCE_APPLIED" }; }, }, @@ -325,6 +421,9 @@ describe("Extended session hooks", async () => { expect(postToolUseInputs).toHaveLength(0); expect(failureInputs).toHaveLength(1); + expect(invocationSessionIds.every((sessionId) => sessionId === session.sessionId)).toBe( + true + ); expect(failureInputs[0].toolName).toBe("view"); expect(failureInputs[0].error).toContain("does not exist"); expect((failureInputs[0].toolArgs as { path?: string }).path).toContain("missing.txt"); diff --git a/nodejs/test/e2e/inprocess_ffi.e2e.test.ts b/nodejs/test/e2e/inprocess_ffi.e2e.test.ts new file mode 100644 index 000000000..af879ea77 --- /dev/null +++ b/nodejs/test/e2e/inprocess_ffi.e2e.test.ts @@ -0,0 +1,26 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { CopilotClient, RuntimeConnection } from "../../src/index.js"; + +describe("In-process FFI transport", () => { + // Smoke test that the in-process FFI transport starts and completes a round-trip. + // Resolution of the in-process transport from COPILOT_SDK_DEFAULT_CONNECTION is + // exercised by the full E2E suite running under the `inprocess` CI matrix cell, + // not a dedicated test. + it("should start and connect over in-process FFI", async () => { + // In-process FFI hosting resolves the CLI entrypoint (COPILOT_CLI_PATH or the + // bundled platform package) and its sibling native runtime library itself. If + // neither is available, start() throws and the test fails hard. + const client = new CopilotClient({ connection: RuntimeConnection.forInProcess() }); + await client.start(); + + const pong = await client.ping("ffi message"); + expect(pong.message).toBe("pong: ffi message"); + expect(Date.parse(pong.timestamp)).not.toBeNaN(); + + expect(await client.stop()).toHaveLength(0); // No errors on stop + }); +}); diff --git a/nodejs/test/e2e/mcp_oauth.e2e.test.ts b/nodejs/test/e2e/mcp_oauth.e2e.test.ts new file mode 100644 index 000000000..5a00526b6 --- /dev/null +++ b/nodejs/test/e2e/mcp_oauth.e2e.test.ts @@ -0,0 +1,381 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { spawn, type ChildProcessWithoutNullStreams } from "node:child_process"; +import { dirname, resolve } from "node:path"; +import { createInterface } from "node:readline"; +import { fileURLToPath } from "node:url"; +import { describe, expect, it, onTestFinished } from "vitest"; +import type { CopilotSession, MCPServerConfig, McpAuthRequest } from "../../src/index.js"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { waitForCondition } from "./harness/sdkTestHelper.js"; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); +const TEST_MCP_OAUTH_SERVER = resolve(__dirname, "../../../test/harness/test-mcp-oauth-server.mjs"); +const EXPECTED_TOKEN = "sdk-host-token"; +const REFRESH_TOKEN = `${EXPECTED_TOKEN}-refresh`; +const UPSCOPE_TOKEN = `${EXPECTED_TOKEN}-upscope`; +const REAUTH_TOKEN = `${EXPECTED_TOKEN}-reauth`; + +describe("MCP OAuth host auth", async () => { + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { + env: { + COPILOT_MCP_APPS: "true", + MCP_APPS: "true", + }, + }, + }); + + it("should satisfy MCP OAuth using host-provided token", { timeout: 120_000 }, async () => { + const oauthServer = await startOAuthMcpServer(); + const serverName = "oauth-protected-mcp"; + let authRequest: McpAuthRequest | undefined; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableMcpApps: true, + onMcpAuthRequest: async (request) => { + authRequest = request; + return { + kind: "token", + accessToken: EXPECTED_TOKEN, + tokenType: "Bearer", + expiresIn: 3600, + }; + }, + mcpServers: { + [serverName]: { + type: "http", + url: `${oauthServer.url}/mcp`, + tools: ["*"], + oauthClientId: "sdk-e2e-client", + oauthPublicClient: true, + } as unknown as MCPServerConfig, + }, + }); + onTestFinished(() => disconnectSession(session)); + + await waitForMcpServerStatus(session, serverName); + + const tools = await session.rpc.mcp.listTools({ serverName }); + expect(tools.tools.map((tool) => tool.name)).toContain("whoami"); + + expect(authRequest).toMatchObject({ + requestId: expect.any(String), + serverName, + serverUrl: `${oauthServer.url}/mcp`, + reason: "initial", + wwwAuthenticateParams: { + resourceMetadataUrl: `${oauthServer.url}/.well-known/oauth-protected-resource`, + scope: "mcp.read", + error: "invalid_token", + }, + resourceMetadata: JSON.stringify({ + resource: `${oauthServer.url}/mcp`, + authorization_servers: [oauthServer.url], + scopes_supported: ["mcp.read"], + bearer_methods_supported: ["header"], + }), + }); + + const requests = await oauthServer.requests(); + expect(requests.some((request) => request.authorization === null)).toBe(true); + expect( + requests.some((request) => request.authorization === `Bearer ${EXPECTED_TOKEN}`) + ).toBe(true); + }); + + it( + "should resolve pending MCP OAuth request with direct RPC", + { timeout: 120_000 }, + async () => { + const oauthServer = await startOAuthMcpServer(); + const serverName = "oauth-direct-rpc-mcp"; + let resolveAuthRequest!: (request: McpAuthRequest) => void; + const authRequest = new Promise((resolve) => { + resolveAuthRequest = resolve; + }); + let releaseHandler!: (value: unknown) => void; + const handlerResult = new Promise((resolve) => { + releaseHandler = resolve; + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableMcpApps: true, + onMcpAuthRequest: async (request) => { + resolveAuthRequest(request); + await handlerResult; + return { kind: "token", accessToken: EXPECTED_TOKEN }; + }, + mcpServers: { + [serverName]: { + type: "http", + url: `${oauthServer.url}/mcp`, + tools: ["*"], + oauthClientId: "sdk-e2e-client", + oauthPublicClient: true, + } as unknown as MCPServerConfig, + }, + }); + onTestFinished(() => disconnectSession(session)); + + const connected = waitForMcpServerStatus(session, serverName); + const request = await authRequest; + expect(request).toMatchObject({ + requestId: expect.any(String), + serverName, + serverUrl: `${oauthServer.url}/mcp`, + reason: "initial", + wwwAuthenticateParams: { + resourceMetadataUrl: `${oauthServer.url}/.well-known/oauth-protected-resource`, + scope: "mcp.read", + error: "invalid_token", + }, + }); + + const handled = await session.rpc.mcp.oauth.handlePendingRequest({ + requestId: request.requestId, + result: { + kind: "token", + accessToken: EXPECTED_TOKEN, + tokenType: "Bearer", + expiresIn: 3600, + }, + }); + expect(handled.success).toBe(true); + + await connected; + const tools = await session.rpc.mcp.listTools({ serverName }); + expect(tools.tools.map((tool) => tool.name)).toContain("whoami"); + releaseHandler(undefined); + } + ); + + it( + "should request host-owned replacement tokens across the MCP OAuth lifecycle", + { timeout: 120_000 }, + async () => { + const oauthServer = await startOAuthMcpServer(); + const serverName = "oauth-lifecycle-mcp"; + const authRequests: McpAuthRequest[] = []; + let refreshCount = 0; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableMcpApps: true, + onMcpAuthRequest: async (request) => { + authRequests.push(request); + switch (request.reason) { + case "initial": + return { kind: "token", accessToken: EXPECTED_TOKEN }; + case "refresh": + refreshCount++; + if (refreshCount === 1) { + return { kind: "token", accessToken: REFRESH_TOKEN }; + } + return { kind: "cancelled" }; + case "upscope": + return { kind: "token", accessToken: UPSCOPE_TOKEN }; + case "reauth": + return { kind: "token", accessToken: REAUTH_TOKEN }; + } + }, + mcpServers: { + [serverName]: { + type: "http", + url: `${oauthServer.url}/mcp`, + tools: ["*"], + oauthClientId: "sdk-e2e-client", + oauthPublicClient: true, + } as unknown as MCPServerConfig, + }, + }); + onTestFinished(() => disconnectSession(session)); + + await waitForMcpServerStatus(session, serverName); + await callWhoami(session, serverName, "refresh"); + await callWhoami(session, serverName, "upscope"); + await callWhoami(session, serverName, "reauth"); + + expect(authRequests.map((request) => request.reason)).toEqual([ + "initial", + "refresh", + "upscope", + "refresh", + "reauth", + ]); + + const upscopeRequest = authRequests.find((request) => request.reason === "upscope"); + expect(upscopeRequest?.wwwAuthenticateParams).toEqual({ + resourceMetadataUrl: `${oauthServer.url}/.well-known/oauth-protected-resource`, + scope: "mcp.write", + error: "insufficient_scope", + }); + expect(upscopeRequest?.resourceMetadata).toBe( + JSON.stringify({ + resource: `${oauthServer.url}/mcp`, + authorization_servers: [oauthServer.url], + scopes_supported: ["mcp.read"], + bearer_methods_supported: ["header"], + }) + ); + + const requests = await oauthServer.requests(); + for (const token of [EXPECTED_TOKEN, REFRESH_TOKEN, UPSCOPE_TOKEN, REAUTH_TOKEN]) { + expect( + requests.some((request) => request.authorization === `Bearer ${token}`) + ).toBe(true); + } + } + ); + + it( + "should cancel pending MCP OAuth requests when the host declines", + { timeout: 120_000 }, + async () => { + const oauthServer = await startOAuthMcpServer(); + const serverName = "oauth-cancelled-mcp"; + let resolveAuthRequest!: (request: McpAuthRequest) => void; + const authRequest = new Promise((resolve) => { + resolveAuthRequest = resolve; + }); + + const session = await client.createSession({ + onPermissionRequest: approveAll, + onMcpAuthRequest: async (request) => { + resolveAuthRequest(request); + return { kind: "cancelled" }; + }, + mcpServers: { + [serverName]: { + type: "http", + url: `${oauthServer.url}/mcp`, + tools: ["*"], + oauthClientId: "sdk-e2e-client", + oauthPublicClient: true, + } as unknown as MCPServerConfig, + }, + }); + onTestFinished(() => disconnectSession(session)); + + await waitForMcpServerStatus(session, serverName, "needs-auth"); + + expect(await authRequest).toMatchObject({ + serverName, + reason: "initial", + }); + } + ); +}); + +async function waitForMcpServerStatus( + session: CopilotSession, + serverName: string, + expectedStatus = "connected" +): Promise { + let lastStatus = ""; + await waitForCondition( + async () => { + const result = await session.rpc.mcp.list(); + const server = result.servers.find((entry) => entry.name === serverName); + lastStatus = server?.status ?? ""; + return server?.status === expectedStatus; + }, + { + timeoutMs: 60_000, + intervalMs: 200, + timeoutMessage: `${serverName} did not reach ${expectedStatus}; last status was ${lastStatus}`, + } + ); +} + +async function callWhoami( + session: CopilotSession, + serverName: string, + scenario: "refresh" | "upscope" | "reauth" +): Promise { + const result = await session.rpc.mcp.apps.callTool({ + serverName, + originServerName: serverName, + toolName: "whoami", + arguments: { scenario }, + }); + expect(result.content).toEqual([{ type: "text", text: "oauth-test-user" }]); +} + +async function startOAuthMcpServer(): Promise<{ + url: string; + requests: () => Promise>; +}> { + const child = spawn(process.execPath, [TEST_MCP_OAUTH_SERVER], { + env: { ...process.env, EXPECTED_TOKEN }, + stdio: ["ignore", "pipe", "pipe"], + }); + onTestFinished(() => stopChild(child)); + + const stderr: string[] = []; + child.stderr.on("data", (chunk) => stderr.push(String(chunk))); + + const url = await new Promise((resolvePromise, reject) => { + const rl = createInterface({ input: child.stdout }); + const timeout = setTimeout(() => { + rl.close(); + reject(new Error(`Timed out waiting for OAuth MCP server. ${stderr.join("")}`)); + }, 10_000); + + child.once("exit", (code, signal) => { + clearTimeout(timeout); + rl.close(); + reject( + new Error( + `OAuth MCP server exited before listening. code=${code} signal=${signal} ${stderr.join("")}` + ) + ); + }); + + rl.on("line", (line) => { + const match = /^Listening: (.+)$/.exec(line); + if (!match) { + return; + } + clearTimeout(timeout); + rl.close(); + resolvePromise(match[1]); + }); + }); + + return { + url, + requests: async () => { + const response = await fetch(`${url}/__requests`); + if (!response.ok) { + throw new Error(`Failed to fetch OAuth MCP requests: ${response.status}`); + } + return response.json(); + }, + }; +} + +async function disconnectSession(session: CopilotSession): Promise { + try { + await session.disconnect(); + } catch { + // Best-effort cleanup. + } +} + +function stopChild(child: ChildProcessWithoutNullStreams): Promise { + if (child.exitCode !== null || child.killed) { + return Promise.resolve(); + } + const exitPromise = new Promise((resolvePromise) => { + child.once("exit", () => resolvePromise()); + }); + child.kill("SIGTERM"); + return exitPromise; +} diff --git a/nodejs/test/e2e/mode_handlers.e2e.test.ts b/nodejs/test/e2e/mode_handlers.e2e.test.ts index 8e2b8aed6..71c4b0896 100644 --- a/nodejs/test/e2e/mode_handlers.e2e.test.ts +++ b/nodejs/test/e2e/mode_handlers.e2e.test.ts @@ -110,7 +110,7 @@ describe("Mode handlers", async () => { expect(exitPlanModeRequests).toHaveLength(1); expect(exitPlanModeRequests[0]).toMatchObject({ summary: PLAN_SUMMARY, - actions: ["interactive", "autopilot", "exit_only"], + actions: ["autopilot", "interactive", "exit_only"], recommendedAction: "interactive", }); expect(exitPlanModeRequests[0].planContent).toBeDefined(); diff --git a/nodejs/test/e2e/multi-client.e2e.test.ts b/nodejs/test/e2e/multi-client.e2e.test.ts index a63b1b0eb..a44ceec3c 100644 --- a/nodejs/test/e2e/multi-client.e2e.test.ts +++ b/nodejs/test/e2e/multi-client.e2e.test.ts @@ -6,7 +6,7 @@ import { describe, expect, it, afterAll } from "vitest"; import { z } from "zod"; import { CopilotClient, defineTool, approveAll, RuntimeConnection } from "../../src/index.js"; import type { SessionEvent } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext"; describe("Multi-client broadcast", async () => { // Use TCP mode so a second client can connect to the same CLI process @@ -304,71 +304,75 @@ describe("Multi-client broadcast", async () => { } ); - it("disconnecting client removes its tools", { timeout: 90_000 }, async () => { - const toolA = defineTool("stable_tool", { - description: "A tool that persists across disconnects", - parameters: z.object({ input: z.string() }), - handler: ({ input }) => `STABLE_${input}`, - }); + it.skipIf(isInProcessTransport)( + "disconnecting client removes its tools", + { timeout: 90_000 }, + async () => { + const toolA = defineTool("stable_tool", { + description: "A tool that persists across disconnects", + parameters: z.object({ input: z.string() }), + handler: ({ input }) => `STABLE_${input}`, + }); - const toolB = defineTool("ephemeral_tool", { - description: "A tool that will disappear when its client disconnects", - parameters: z.object({ input: z.string() }), - handler: ({ input }) => `EPHEMERAL_${input}`, - }); + const toolB = defineTool("ephemeral_tool", { + description: "A tool that will disappear when its client disconnects", + parameters: z.object({ input: z.string() }), + handler: ({ input }) => `EPHEMERAL_${input}`, + }); - // Client 1 creates a session with stable_tool - const session1 = await client1.createSession({ - onPermissionRequest: approveAll, - tools: [toolA], - }); + // Client 1 creates a session with stable_tool + const session1 = await client1.createSession({ + onPermissionRequest: approveAll, + tools: [toolA], + }); - // Client 2 resumes with ephemeral_tool - await client2.resumeSession(session1.sessionId, { - onPermissionRequest: approveAll, - tools: [toolB], - }); + // Client 2 resumes with ephemeral_tool + await client2.resumeSession(session1.sessionId, { + onPermissionRequest: approveAll, + tools: [toolB], + }); - // Verify both tools work before disconnect (sequential to avoid nondeterministic tool_call ordering) - const stableResponse = await session1.sendAndWait({ - prompt: "Use the stable_tool with input 'test1' and tell me the result.", - }); - expect(stableResponse?.data.content).toContain("STABLE_test1"); + // Verify both tools work before disconnect (sequential to avoid nondeterministic tool_call ordering) + const stableResponse = await session1.sendAndWait({ + prompt: "Use the stable_tool with input 'test1' and tell me the result.", + }); + expect(stableResponse?.data.content).toContain("STABLE_test1"); - const ephemeralResponse = await session1.sendAndWait({ - prompt: "Use the ephemeral_tool with input 'test2' and tell me the result.", - }); - expect(ephemeralResponse?.data.content).toContain("EPHEMERAL_test2"); - - // Disconnect client 2 without destroying the shared session. - // Suppress "Connection is disposed" rejections that occur when the server - // broadcasts events (e.g. tool_changed_notice) to the now-dead connection. - const suppressDisposed = (reason: unknown) => { - if (reason instanceof Error && reason.message.includes("Connection is disposed")) { - return; - } - throw reason; - }; - process.on("unhandledRejection", suppressDisposed); - await client2.forceStop(); - - // Give the server time to process the connection close and remove tools - await new Promise((resolve) => setTimeout(resolve, 500)); - process.removeListener("unhandledRejection", suppressDisposed); - - // Recreate client2 for cleanup in afterAll (but don't rejoin the session) - client2 = new CopilotClient({ - connection: RuntimeConnection.forUri(`localhost:${runtimePort}`, { - connectionToken: tcpConnectionToken, - }), - }); + const ephemeralResponse = await session1.sendAndWait({ + prompt: "Use the ephemeral_tool with input 'test2' and tell me the result.", + }); + expect(ephemeralResponse?.data.content).toContain("EPHEMERAL_test2"); + + // Disconnect client 2 without destroying the shared session. + // Suppress "Connection is disposed" rejections that occur when the server + // broadcasts events (e.g. tool_changed_notice) to the now-dead connection. + const suppressDisposed = (reason: unknown) => { + if (reason instanceof Error && reason.message.includes("Connection is disposed")) { + return; + } + throw reason; + }; + process.on("unhandledRejection", suppressDisposed); + await client2.forceStop(); + + // Give the server time to process the connection close and remove tools + await new Promise((resolve) => setTimeout(resolve, 500)); + process.removeListener("unhandledRejection", suppressDisposed); + + // Recreate client2 for cleanup in afterAll (but don't rejoin the session) + client2 = new CopilotClient({ + connection: RuntimeConnection.forUri(`localhost:${runtimePort}`, { + connectionToken: tcpConnectionToken, + }), + }); - // Now only stable_tool should be available - const afterResponse = await session1.sendAndWait({ - prompt: "Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.", - }); - expect(afterResponse?.data.content).toContain("STABLE_still_here"); - // ephemeral_tool should NOT have produced a result - expect(afterResponse?.data.content).not.toContain("EPHEMERAL_"); - }); + // Now only stable_tool should be available + const afterResponse = await session1.sendAndWait({ + prompt: "Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.", + }); + expect(afterResponse?.data.content).toContain("STABLE_still_here"); + // ephemeral_tool should NOT have produced a result + expect(afterResponse?.data.content).not.toContain("EPHEMERAL_"); + } + ); }); diff --git a/nodejs/test/e2e/multi_provider_registry.e2e.test.ts b/nodejs/test/e2e/multi_provider_registry.e2e.test.ts new file mode 100644 index 000000000..cd0eb5316 --- /dev/null +++ b/nodejs/test/e2e/multi_provider_registry.e2e.test.ts @@ -0,0 +1,213 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import type { + CustomAgentConfig, + NamedProviderConfig, + ProviderModelConfig, +} from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { retry } from "./harness/sdkTestHelper.js"; +import type { ParsedHttpExchange } from "../../../test/harness/replayingCapiProxy"; + +/** + * End-to-end coverage for the experimental multi-provider BYOK registry + * (`providers` / `models` on the session config). Validates that several named + * providers, several models per provider, and custom agents bound to those + * provider-qualified models can coexist in one session, be launched, and route + * inference to the configured provider with the configured wire model and + * headers. + */ +describe("Multi-provider BYOK registry", async () => { + const { copilotClient: client, openAiEndpoint } = await createSdkTestContext(); + + async function waitForExchanges(minimumCount = 1): Promise { + await retry( + `capture ${minimumCount} chat completion request(s)`, + async () => { + const exchanges = await openAiEndpoint.getExchanges(); + expect(exchanges.length).toBeGreaterThanOrEqual(minimumCount); + }, + 1_200 + ); + return openAiEndpoint.getExchanges(); + } + + function getHeader(exchange: ParsedHttpExchange, name: string): string | undefined { + const headers = exchange.requestHeaders ?? {}; + const key = Object.keys(headers).find((k) => k.toLowerCase() === name.toLowerCase()); + if (key === undefined) { + return undefined; + } + const value = headers[key]; + return Array.isArray(value) ? value[0] : value; + } + + // A heterogeneous registry: two providers of different types, with multiple + // models each. Provider-qualified selection ids are alpha/sonnet, + // alpha/haiku, beta/opus, beta/haiku. + const registryProviders: NamedProviderConfig[] = [ + { + name: "alpha", + type: "openai", + wireApi: "completions", + baseUrl: "https://alpha.example.test/v1", + apiKey: "alpha-secret", + headers: { "X-Provider": "alpha" }, + }, + { + name: "beta", + type: "anthropic", + baseUrl: "https://beta.example.test", + bearerToken: "beta-bearer", + headers: { "X-Provider": "beta" }, + }, + ]; + const registryModels: ProviderModelConfig[] = [ + { id: "sonnet", provider: "alpha", wireModel: "byok-gpt-4o", maxPromptTokens: 111111 }, + { id: "haiku", provider: "alpha", wireModel: "byok-gpt-4o-mini" }, + { id: "opus", provider: "beta", wireModel: "byok-claude-3-opus" }, + { id: "haiku", provider: "beta", wireModel: "byok-claude-3-haiku" }, + ]; + const registryAgents: CustomAgentConfig[] = [ + { + name: "orchestrator", + displayName: "Orchestrator", + description: "Top-level planner.", + prompt: "Plan and delegate.", + model: "alpha/sonnet", + }, + { + name: "researcher", + displayName: "Researcher", + description: "Deep research subagent.", + prompt: "Research thoroughly.", + model: "beta/opus", + }, + { + name: "fast-helper", + displayName: "Fast Helper", + description: "Quick subagent.", + prompt: "Answer quickly.", + model: "alpha/haiku", + }, + { + name: "summarizer", + displayName: "Summarizer", + description: "Summarizing subagent.", + prompt: "Summarize.", + model: "beta/haiku", + }, + ]; + + it("should register multiple providers with custom agents bound to their models", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + providers: registryProviders, + models: registryModels, + customAgents: registryAgents, + }); + + try { + const { agents } = await session.rpc.agent.list(); + + // All four custom agents coexist in a single session. + expect(agents.length).toBe(4); + + // Each agent is bound to its configured provider-qualified BYOK model. + const byName = new Map(agents.map((a) => [a.name, a])); + expect(byName.get("orchestrator")?.model).toBe("alpha/sonnet"); + expect(byName.get("researcher")?.model).toBe("beta/opus"); + expect(byName.get("fast-helper")?.model).toBe("alpha/haiku"); + expect(byName.get("summarizer")?.model).toBe("beta/haiku"); + + // Models from BOTH providers are represented, proving the two + // providers and their models coexist within the same session. + const boundModels = agents.map((a) => a.model ?? ""); + expect(boundModels.some((m) => m.startsWith("alpha/"))).toBe(true); + expect(boundModels.some((m) => m.startsWith("beta/"))).toBe(true); + } finally { + await session.disconnect(); + } + }); + + async function assertRouting( + selectionId: string, + expectedWireModel: string, + expectedProviderHeader: string + ): Promise { + // Two OpenAI-compatible providers, both pointed at the replay proxy so + // their /chat/completions traffic is captured. They are distinguished on + // the wire by their per-provider X-Provider header. "alpha" carries two + // models (multiple models per provider); "delta" carries one. + const providers: NamedProviderConfig[] = [ + { + name: "alpha", + type: "openai", + wireApi: "completions", + baseUrl: openAiEndpoint.url, + apiKey: "alpha-secret", + headers: { "X-Provider": "alpha" }, + }, + { + name: "delta", + type: "openai", + wireApi: "completions", + baseUrl: openAiEndpoint.url, + apiKey: "delta-secret", + headers: { "X-Provider": "delta" }, + }, + ]; + const models: ProviderModelConfig[] = [ + { id: "sonnet", provider: "alpha", wireModel: "byok-gpt-4o" }, + { id: "haiku", provider: "alpha", wireModel: "byok-gpt-4o-mini" }, + { id: "turbo", provider: "delta", wireModel: "byok-gpt-4-turbo" }, + ]; + + const session = await client.createSession({ + onPermissionRequest: approveAll, + model: selectionId, + providers, + models, + }); + + try { + await session.sendAndWait({ prompt: "What is 5+5?" }); + const exchanges = await waitForExchanges(); + expect(exchanges.length).toBe(1); + const exchange = exchanges[0]; + + // The wire model sent to the provider is the selected model's + // wireModel, not its provider-qualified selection id. + expect(exchange.request.model).toBe(expectedWireModel); + + // The request carried the owning provider's custom header, proving + // the turn was dispatched against the correct provider connection. + expect(getHeader(exchange, "X-Provider")).toBe(expectedProviderHeader); + + // The provider's API key was applied as an Authorization header. + expect(getHeader(exchange, "Authorization")).toBeTruthy(); + } finally { + try { + await session.disconnect(); + } catch { + // disconnect may fail since the BYOK provider URL is fake + } + } + } + + it("should route alpha sonnet turn to its provider and wire model", async () => { + await assertRouting("alpha/sonnet", "byok-gpt-4o", "alpha"); + }); + + it("should route alpha haiku turn to its provider and wire model", async () => { + await assertRouting("alpha/haiku", "byok-gpt-4o-mini", "alpha"); + }); + + it("should route delta turbo turn to its provider and wire model", async () => { + await assertRouting("delta/turbo", "byok-gpt-4-turbo", "delta"); + }); +}); diff --git a/nodejs/test/e2e/pending_work_resume.e2e.test.ts b/nodejs/test/e2e/pending_work_resume.e2e.test.ts index bc1937bad..85abc3a90 100644 --- a/nodejs/test/e2e/pending_work_resume.e2e.test.ts +++ b/nodejs/test/e2e/pending_work_resume.e2e.test.ts @@ -12,8 +12,7 @@ import type { PermissionRequestedEvent, PermissionRequestResult, } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; -import { getFinalAssistantMessage } from "./harness/sdkTestHelper.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; const PENDING_WORK_TIMEOUT_MS = 60_000; const TEST_TIMEOUT_MS = 180_000; @@ -58,6 +57,20 @@ async function waitWithTimeout( } } +async function waitForPendingPermissionRequestId(session: CopilotSession): Promise { + const deadline = Date.now() + PENDING_WORK_TIMEOUT_MS; + do { + const pending = await session.rpc.permissions.pendingRequests(); + const request = pending.items[0]; + if (request) { + return request.requestId; + } + await new Promise((resolve) => setTimeout(resolve, 100)); + } while (Date.now() < deadline); + + throw new Error("Timeout waiting for pending permission request"); +} + function waitForExternalToolRequests( session: CopilotSession, toolNames: string[] @@ -129,6 +142,7 @@ describe("Pending work resume", async () => { const server = new CopilotClient({ workingDirectory: workDir, env, + gitHubToken: DEFAULT_GITHUB_TOKEN, connection: RuntimeConnection.forTcp({ path: process.env.COPILOT_CLI_PATH, connectionToken: SHARED_TOKEN, @@ -172,7 +186,6 @@ describe("Pending work resume", async () => { async () => { const originalPermissionRequest = deferred(); const releaseOriginalPermission = deferred(); - let resumedToolInvoked = false; const server = createTcpServer(); await server.start(); @@ -206,7 +219,7 @@ describe("Pending work resume", async () => { PENDING_WORK_TIMEOUT_MS, "originalPermissionRequest" ); - const permissionEvent = await permissionRequestedP; + await permissionRequestedP; expect(initialRequest.kind).toBe("custom-tool"); await suspendedClient.forceStop(); @@ -219,30 +232,19 @@ describe("Pending work resume", async () => { defineTool("resume_permission_tool", { description: "Transforms a value after permission is granted", parameters: z.object({ value: z.string() }), - handler: ({ value }) => { - resumedToolInvoked = true; - return `PERMISSION_RESUMED_${value.toUpperCase()}`; - }, + handler: ({ value }) => `PERMISSION_RESUMED_${value.toUpperCase()}`, }), ], }); + const requestId = await waitForPendingPermissionRequestId(session2); const permissionResult = await session2.rpc.permissions.handlePendingPermissionRequest({ - requestId: permissionEvent.data.requestId, + requestId, result: { kind: "approve-once" }, }); expect(permissionResult.success).toBe(true); - const answer = await waitWithTimeout( - getFinalAssistantMessage(session2), - PENDING_WORK_TIMEOUT_MS, - "final assistant message" - ); - - expect(resumedToolInvoked).toBe(true); - expect(answer.data.content ?? "").toContain("PERMISSION_RESUMED_ALPHA"); - await session2.disconnect(); } finally { if (!releaseOriginalPermission.settled()) { @@ -312,13 +314,6 @@ describe("Pending work resume", async () => { }); expect(toolResult.success).toBe(true); - const answer = await waitWithTimeout( - getFinalAssistantMessage(session2), - PENDING_WORK_TIMEOUT_MS, - "final assistant message" - ); - expect(answer.data.content ?? "").toContain("EXTERNAL_RESUMED_BETA"); - await session2.disconnect(); } finally { if (!releaseOriginalTool.settled()) { @@ -458,93 +453,143 @@ describe("Pending work resume", async () => { } ); - it( - "should keep pending external tool handleable on warm resume when continuePendingWork is false", - { timeout: TEST_TIMEOUT_MS }, - async () => { - const originalToolStarted = deferred(); - const releaseOriginalTool = deferred(); - let invocationCount = 0; - - const server = createTcpServer(); - await server.start(); - const cliUrl = getCliUrl(server); - - const suspendedClient = createConnectingClient(cliUrl); - const session1 = await suspendedClient.createSession({ - tools: [ - defineTool("resume_external_tool", { - description: "Looks up a value after resumption", - parameters: z.object({ value: z.string() }), - handler: async ({ value }) => { - invocationCount++; - originalToolStarted.resolve(value); - return await releaseOriginalTool.promise; - }, - }), - ], - onPermissionRequest: approveAll, - }); - const sessionId = session1.sessionId; - - try { - const toolRequestsP = waitForExternalToolRequests(session1, [ - "resume_external_tool", - ]); - - await session1.send({ - prompt: "Use resume_external_tool with value 'beta', then reply with the result.", - }); - - const toolEvents = await toolRequestsP; - const toolEvent = toolEvents["resume_external_tool"]; - expect( - await waitWithTimeout( - originalToolStarted.promise, - PENDING_WORK_TIMEOUT_MS, - "originalToolStarted" - ) - ).toBe("beta"); - - await suspendedClient.forceStop(); - - const resumedClient = createConnectingClient(cliUrl); - const session2 = await resumedClient.resumeSession(sessionId, { - continuePendingWork: false, + for (const scenario of [ + { + name: "warm", + disconnectOriginalClient: false, + expectedSessionWasActive: true, + expectedHandleResult: true, + }, + { + name: "cold", + disconnectOriginalClient: true, + expectedSessionWasActive: false, + expectedHandleResult: false, + }, + ]) { + it( + `should keep pending external tool handleable on ${scenario.name} resume when continuePendingWork is false`, + { timeout: TEST_TIMEOUT_MS }, + async () => { + const originalToolStarted = deferred(); + const releaseOriginalTool = deferred(); + let invocationCount = 0; + + const server = createTcpServer(); + await server.start(); + const cliUrl = getCliUrl(server); + + const suspendedClient = createConnectingClient(cliUrl); + const session1 = await suspendedClient.createSession({ + tools: [ + defineTool("resume_external_tool", { + description: "Looks up a value after resumption", + parameters: z.object({ value: z.string() }), + handler: async ({ value }) => { + invocationCount++; + originalToolStarted.resolve(value); + return await releaseOriginalTool.promise; + }, + }), + ], onPermissionRequest: approveAll, }); + const sessionId = session1.sessionId; - // Verify resume event has continuePendingWork: false and sessionWasActive: true - const messages = await session2.getEvents(); - const resumeEvent = messages.find((m) => m.type === "session.resume"); - expect(resumeEvent).toBeDefined(); - expect(resumeEvent!.data.continuePendingWork).toBe(false); - expect(resumeEvent!.data.sessionWasActive).toBe(true); - - // Handle the pending tool call directly via RPC - const resumedResult = await session2.rpc.tools.handlePendingToolCall({ - requestId: toolEvent.data.requestId, - result: "EXTERNAL_RESUMED_BETA", - }); - expect(resumedResult.success).toBe(true); + try { + const toolRequestsP = waitForExternalToolRequests(session1, [ + "resume_external_tool", + ]); - const answer = await waitWithTimeout( - getFinalAssistantMessage(session2), - PENDING_WORK_TIMEOUT_MS, - "final assistant message" - ); + await session1.send({ + prompt: "Use resume_external_tool with value 'beta', then reply with the result.", + }); - expect(invocationCount).toBe(1); - expect(answer.data.content ?? "").toContain("EXTERNAL_RESUMED_BETA"); + const toolEvents = await toolRequestsP; + const toolEvent = toolEvents["resume_external_tool"]; + expect( + await waitWithTimeout( + originalToolStarted.promise, + PENDING_WORK_TIMEOUT_MS, + "originalToolStarted" + ) + ).toBe("beta"); + + if (scenario.disconnectOriginalClient) { + await suspendedClient.forceStop(); + } + + const resumedClient = createConnectingClient(cliUrl); + const session2 = await resumedClient.resumeSession(sessionId, { + // In warm mode the original client still owns the tool registration; + // re-registering from the resumed client would cause a name-clash + // error. In cold mode the original is gone, so we register a fresh + // throwing handler to assert the runtime doesn't re-invoke a tool + // handler on resume (orphan auto-completion is internal). + tools: scenario.disconnectOriginalClient + ? [ + defineTool("resume_external_tool", { + description: "Looks up a value after resumption", + parameters: z.object({ value: z.string() }), + handler: async () => { + throw new Error( + "Resumed-session handler should not be invoked" + ); + }, + }), + ] + : undefined, + continuePendingWork: false, + onPermissionRequest: approveAll, + }); - await session2.disconnect(); - } finally { - if (!releaseOriginalTool.settled()) { - releaseOriginalTool.resolve("ORIGINAL_SHOULD_NOT_WIN"); + const messages = await session2.getEvents(); + const resumeEvent = messages.find((m) => m.type === "session.resume"); + expect(resumeEvent).toBeDefined(); + expect(resumeEvent!.data.continuePendingWork).toBe(false); + expect(resumeEvent!.data.sessionWasActive).toBe( + scenario.expectedSessionWasActive + ); + + // Handle the pending tool call directly via RPC. In warm mode the runtime + // still has the pending request; in cold mode the runtime auto-completed + // the orphan with a synthetic interrupt result during resume, so this RPC + // is expected to report success=false. + const resumedResult = await session2.rpc.tools.handlePendingToolCall({ + requestId: toolEvent.data.requestId, + result: "EXTERNAL_RESUMED_BETA", + }); + expect(resumedResult.success).toBe(scenario.expectedHandleResult); + + if (!scenario.expectedHandleResult) { + // Cold path: orphan auto-completion does not trigger an LLM turn on + // its own, but the session should remain healthy for new work. Send + // a follow-up prompt and verify the assistant still produces a reply. + const followUp = await session2.sendAndWait({ + prompt: "Reply with exactly: COLD_RESUMED_FOLLOWUP", + }); + expect(followUp?.data.content ?? "").toContain("COLD_RESUMED_FOLLOWUP"); + } + + expect(invocationCount).toBe(1); + + await session2.disconnect(); + } finally { + // Release the still-pending original tool handler so it doesn't + // leak — but only in the warm scenario where the original client + // is still connected. In the cold scenario the original client was + // force-stopped, so its connection (and underlying socket) is gone; + // resolving the handler would make the SDK try to send the tool + // result over the destroyed stream, surfacing an ERR_STREAM_DESTROYED + // unhandled rejection (most visibly on Windows). The orphaned handler + // is harmless left pending since its client no longer exists. + if (!scenario.disconnectOriginalClient && !releaseOriginalTool.settled()) { + releaseOriginalTool.resolve("ORIGINAL_SHOULD_NOT_WIN"); + } } } - } - ); + ); + } it( "should report continuePendingWork true in resume event", diff --git a/nodejs/test/e2e/per_session_auth.e2e.test.ts b/nodejs/test/e2e/per_session_auth.e2e.test.ts index 0bb1dbd4e..5f55d397d 100644 --- a/nodejs/test/e2e/per_session_auth.e2e.test.ts +++ b/nodejs/test/e2e/per_session_auth.e2e.test.ts @@ -42,7 +42,7 @@ describe("Per-session GitHub auth", async () => { gitHubToken: "token-alice", }); - const authStatus = await session.rpc.auth.getStatus(); + const authStatus = await session.rpc.gitHubAuth.getStatus(); expect(authStatus.isAuthenticated).toBe(true); expect(authStatus.login).toBe("alice"); expect(authStatus.copilotPlan).toBe("individual_pro"); @@ -60,8 +60,8 @@ describe("Per-session GitHub auth", async () => { gitHubToken: "token-bob", }); - const statusA = await sessionA.rpc.auth.getStatus(); - const statusB = await sessionB.rpc.auth.getStatus(); + const statusA = await sessionA.rpc.gitHubAuth.getStatus(); + const statusB = await sessionB.rpc.gitHubAuth.getStatus(); expect(statusA.isAuthenticated).toBe(true); expect(statusA.login).toBe("alice"); @@ -92,7 +92,7 @@ describe("Per-session GitHub auth", async () => { onPermissionRequest: approveAll, }); - const authStatus = await session.rpc.auth.getStatus(); + const authStatus = await session.rpc.gitHubAuth.getStatus(); // Without a per-session GitHub token, there is no per-session identity. // In CI the process-level fake token may still authenticate globally, // so we check login rather than isAuthenticated. diff --git a/nodejs/test/e2e/permissions.e2e.test.ts b/nodejs/test/e2e/permissions.e2e.test.ts index 96a470aee..b7fa6087a 100644 --- a/nodejs/test/e2e/permissions.e2e.test.ts +++ b/nodejs/test/e2e/permissions.e2e.test.ts @@ -5,15 +5,16 @@ import { realpathSync } from "fs"; import { mkdir, readFile, writeFile } from "fs/promises"; import { join } from "path"; -import { describe, expect, it } from "vitest"; +import { describe, expect, it, vi } from "vitest"; import { z } from "zod"; import type { + PermissionDecisionContext, PermissionRequest, PermissionRequestResult, ToolResultObject, } from "../../src/index.js"; -import { approveAll, defineTool } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { approveAll, defineTool, createAttributedPermissionResult } from "../../src/index.js"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; import { getFinalAssistantMessage, getNextEventOfType } from "./harness/sdkTestHelper.js"; describe("Permission callbacks", async () => { @@ -90,6 +91,61 @@ describe("Permission callbacks", async () => { await session.disconnect(); }); + it("should honor a decision annotated with decisionContext", async () => { + // End-to-end proof that decisionContext survives the real permission flow. + // The runtime only emits its auto_approval_decision telemetry when its own + // auto-approval judge metadata is also present (feature-flagged and model + // backed), so that event is not observable here. Instead we assert the exact + // params handed to the CLI: decisionContext must be a top-level sibling of + // `result`, never nested inside it. The CLI tolerates a nested key silently, + // so asserting the params shape is what actually gives this test teeth. + const decisionContext: PermissionDecisionContext = { + outcome: "prompted_user", + source: "human_response", + surface: "sdk", + }; + + const session = await client.createSession({ + onPermissionRequest: () => + createAttributedPermissionResult({ kind: "reject" }, decisionContext), + }); + + // Spies preserve the original implementation, so the decision still reaches + // the CLI and the assertions below observe a real, honored round-trip. + const respondSpy = vi.spyOn(session.rpc.permissions, "handlePendingPermissionRequest"); + + let userRejectedToolCall = false; + session.on((event) => { + if ( + event.type === "tool.execution_complete" && + !event.data.success && + event.data.error?.message.toLowerCase().includes("user rejected") + ) { + userRejectedToolCall = true; + } + }); + + const originalContent = "protected content"; + const testFile = join(workDir, "protected.txt"); + await writeFile(testFile, originalContent); + + await session.sendAndWait({ + prompt: "Edit protected.txt and replace 'protected' with 'hacked'.", + }); + + // The decision was applied by the CLI, not merely sent. + expect(userRejectedToolCall).toBe(true); + expect(await readFile(testFile, "utf-8")).toBe(originalContent); + + expect(respondSpy).toHaveBeenCalled(); + const params = respondSpy.mock.calls[0]![0]; + expect(params.decisionContext).toEqual(decisionContext); + expect(params.result).toEqual({ kind: "reject" }); + expect(Object.keys(params).sort()).toEqual(["decisionContext", "requestId", "result"]); + + await session.disconnect(); + }); + it("should deny tool operations when handler explicitly denies", async () => { let permissionDenied = false; @@ -408,7 +464,7 @@ describe("Permission callbacks", async () => { await session.disconnect(); }); - it("should deny permission with noresult kind", async () => { + it.skipIf(isInProcessTransport)("should deny permission with noresult kind", async () => { // With no-result, the TypeScript SDK does not send any response to the CLI's permission // request, leaving the tool execution pending. We verify the permission handler fires. let resolvePermissionCalled!: () => void; @@ -564,12 +620,10 @@ describe("Permission callbacks", async () => { ).success ).toBe(true); expect( - (await session.rpc.permissions.urls.setUnrestrictedMode({ unrestricted: true })) - .success + (await session.rpc.permissions.urls.setUnrestrictedMode({ enabled: true })).success ).toBe(true); expect( - (await session.rpc.permissions.urls.setUnrestrictedMode({ unrestricted: false })) - .success + (await session.rpc.permissions.urls.setUnrestrictedMode({ enabled: false })).success ).toBe(true); } finally { await session.disconnect(); diff --git a/nodejs/test/e2e/provider_endpoint.e2e.test.ts b/nodejs/test/e2e/provider_endpoint.e2e.test.ts new file mode 100644 index 000000000..8acf6a246 --- /dev/null +++ b/nodejs/test/e2e/provider_endpoint.e2e.test.ts @@ -0,0 +1,92 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +describe("session.provider.getEndpoint RPC", async () => { + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { + // The provider endpoint API is gated behind an opt-in env var. + env: { COPILOT_ALLOW_GET_PROVIDER_ENDPOINT: "true" }, + }, + }); + + it("returns the BYOK provider endpoint when a custom provider is configured", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + provider: { + type: "openai", + wireApi: "completions", + baseUrl: "https://api.example.test/v1", + apiKey: "byok-secret", + headers: { "X-Custom-Header": "byok-yes" }, + }, + }); + + try { + const endpoint = await session.rpc.provider.getEndpoint({}); + + expect(endpoint.type).toBe("openai"); + expect(endpoint.wireApi).toBe("completions"); + expect(endpoint.baseUrl).toBe("https://api.example.test/v1"); + expect(endpoint.apiKey).toBe("byok-secret"); + expect(endpoint.headers).toMatchObject({ "X-Custom-Header": "byok-yes" }); + // BYOK sessions never issue a CAPI session token. + expect(endpoint.sessionToken).toBeUndefined(); + } finally { + try { + await session.disconnect(); + } catch { + // disconnect may fail since the BYOK provider URL is fake + } + } + }); + + it("returns the CAPI provider endpoint for an OAuth-authenticated session", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + }); + + try { + const endpoint = await session.rpc.provider.getEndpoint({}); + + expect(["openai", "azure", "anthropic"]).toContain(endpoint.type); + // wireApi is omitted for anthropic; otherwise one of the OpenAI shapes. + if (endpoint.type !== "anthropic") { + expect(["completions", "responses"]).toContain(endpoint.wireApi); + } + + // CAPI baseUrl is the (proxy) Copilot API URL injected by the harness. + expect(endpoint.baseUrl).toMatch(/^https?:\/\//); + + // For CAPI OAuth sessions the apiKey is the resolved GitHub bearer. + expect(endpoint.apiKey).toBeTypeOf("string"); + expect(endpoint.apiKey!.length).toBeGreaterThan(0); + + // Standard CAPI headers should be present, and Authorization is + // surfaced as the runtime sends it (`Bearer `). + expect(endpoint.headers["Copilot-Integration-Id"]).toBeTypeOf("string"); + expect(endpoint.headers["User-Agent"]).toMatch(/Copilot/i); + expect(endpoint.headers["X-GitHub-Api-Version"]).toBeTypeOf("string"); + expect(endpoint.headers["X-Interaction-Id"]).toMatch(/[0-9a-f-]{8,}/); + expect(endpoint.headers.Authorization).toBe(`Bearer ${endpoint.apiKey}`); + + // When the omit-modelId path returned an auto-mode session token, it + // must use the documented header name and an ISO 8601 expiry. The + // harness may have a non-auto model selected, in which case the + // field is simply omitted. + if (endpoint.sessionToken) { + expect(endpoint.sessionToken.header).toBe("Copilot-Session-Token"); + expect(endpoint.sessionToken.token.length).toBeGreaterThan(0); + if (endpoint.sessionToken.expiresAt !== undefined) { + expect(Date.parse(endpoint.sessionToken.expiresAt)).not.toBeNaN(); + } + } + } finally { + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rewind.e2e.test.ts b/nodejs/test/e2e/rewind.e2e.test.ts new file mode 100644 index 000000000..920ffed19 --- /dev/null +++ b/nodejs/test/e2e/rewind.e2e.test.ts @@ -0,0 +1,81 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { existsSync, readFileSync } from "node:fs"; +import { join, resolve } from "node:path"; +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +const FILE_NAME = "rewind-sdk.txt"; +const FILE_CONTENT = "SDK rewind content"; + +function expectSamePath(actual: string, expected: string): void { + const actualPath = resolve(actual); + const expectedPath = resolve(expected); + if (process.platform === "win32") { + expect(actualPath.toLowerCase()).toBe(expectedPath.toLowerCase()); + } else { + expect(actualPath).toBe(expectedPath); + } +} + +describe("Rewind", async () => { + const { copilotClient: client, workDir } = await createSdkTestContext(); + + it("should restore tracked file and conversation", async () => { + const filePath = join(workDir, FILE_NAME); + const session = await client.createSession({ + model: "claude-sonnet-4.5", + enableFileChangeTracking: true, + onPermissionRequest: approveAll, + }); + + try { + const response = await session.sendAndWait({ + prompt: `Use the create tool to create ${FILE_NAME} containing exactly ${FILE_CONTENT}. After the tool succeeds, reply with exactly SDK_REWIND_DONE.`, + }); + + expect(response?.data.content).toBe("SDK_REWIND_DONE"); + expect(existsSync(filePath)).toBe(true); + expect(readFileSync(filePath, "utf8")).toBe(FILE_CONTENT); + + let rewindPoints = await session.rpc.history.listRewindPoints(); + const deadline = Date.now() + 10_000; + while (rewindPoints.unavailableReason && Date.now() < deadline) { + await new Promise((resolveDelay) => setTimeout(resolveDelay, 100)); + rewindPoints = await session.rpc.history.listRewindPoints(); + } + + expect(rewindPoints.unavailableReason).toBeUndefined(); + expect(rewindPoints.fileChangeTrackingEnabled).toBe(true); + expect(rewindPoints.points).toHaveLength(1); + const rewindPoint = rewindPoints.points[0]; + expect(rewindPoint.canRestoreFiles).toBe(true); + expect(rewindPoint.fileCount).toBe(1); + + const preview = await session.rpc.history.previewRewind({ + eventId: rewindPoint.eventId, + }); + expect(preview.available).toBe(true); + expect(preview.files).toHaveLength(1); + expectSamePath(preview.files[0].path, filePath); + + const rewind = await session.rpc.history.rewind({ + eventId: rewindPoint.eventId, + mode: "conversation-and-files", + }); + expect(rewind.outcome).toBe("success"); + expect(rewind.eventsRemoved).toBeGreaterThan(0); + expect(rewind.restoredFiles).toHaveLength(1); + expectSamePath(rewind.restoredFiles[0], filePath); + expect(existsSync(filePath)).toBe(false); + + const events = await session.getEvents(); + expect(events.some((event) => event.id === rewindPoint.eventId)).toBe(false); + } finally { + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rpc.e2e.test.ts b/nodejs/test/e2e/rpc.e2e.test.ts index 0442ab926..f90547da9 100644 --- a/nodejs/test/e2e/rpc.e2e.test.ts +++ b/nodejs/test/e2e/rpc.e2e.test.ts @@ -2,10 +2,10 @@ import { describe, expect, it, onTestFinished } from "vitest"; import { CopilotClient, approveAll } from "../../src/index.js"; import { createSdkTestContext } from "./harness/sdkTestContext.js"; -function onTestFinishedForceStop(client: CopilotClient) { +function onTestFinishedStop(client: CopilotClient) { onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors - process may already be stopped } @@ -15,7 +15,7 @@ function onTestFinishedForceStop(client: CopilotClient) { describe("RPC", () => { it("should call rpc.ping with typed params and result", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -28,7 +28,7 @@ describe("RPC", () => { it("should call rpc.models.list with typed result", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); @@ -48,7 +48,7 @@ describe("RPC", () => { // account.getQuota is defined in schema but not yet implemented in CLI it.skip("should call rpc.account.getQuota when authenticated", async () => { const client = new CopilotClient(); - onTestFinishedForceStop(client); + onTestFinishedStop(client); await client.start(); diff --git a/nodejs/test/e2e/rpc_mcp_and_skills.e2e.test.ts b/nodejs/test/e2e/rpc_mcp_and_skills.e2e.test.ts index cdd64017c..4025dc444 100644 --- a/nodejs/test/e2e/rpc_mcp_and_skills.e2e.test.ts +++ b/nodejs/test/e2e/rpc_mcp_and_skills.e2e.test.ts @@ -74,7 +74,7 @@ describe("Session MCP and skills RPC", async () => { }); onTestFinished(async () => { try { - await mcpAppsClient.forceStop(); + await mcpAppsClient.stop(); } catch { // Ignore cleanup errors } diff --git a/nodejs/test/e2e/rpc_mcp_config.e2e.test.ts b/nodejs/test/e2e/rpc_mcp_config.e2e.test.ts index 581567cb3..95694a8c6 100644 --- a/nodejs/test/e2e/rpc_mcp_config.e2e.test.ts +++ b/nodejs/test/e2e/rpc_mcp_config.e2e.test.ts @@ -9,7 +9,7 @@ function startEphemeralClient(): CopilotClient { const client = new CopilotClient(); onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } diff --git a/nodejs/test/e2e/rpc_mcp_lifecycle.e2e.test.ts b/nodejs/test/e2e/rpc_mcp_lifecycle.e2e.test.ts new file mode 100644 index 000000000..40f837434 --- /dev/null +++ b/nodejs/test/e2e/rpc_mcp_lifecycle.e2e.test.ts @@ -0,0 +1,151 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { dirname, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { describe, expect, it } from "vitest"; +import type { CopilotSession, MCPServerConfig, MCPStdioServerConfig } from "../../src/index.js"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { formatError, waitForCondition } from "./harness/sdkTestHelper.js"; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); +const TEST_MCP_SERVER = resolve(__dirname, "../../../test/harness/test-mcp-server.mjs"); +const TEST_HARNESS_DIR = dirname(TEST_MCP_SERVER); + +describe("Session-scoped MCP lifecycle RPC", async () => { + const { copilotClient: client } = await createSdkTestContext(); + + function createTestMcpServers(...serverNames: string[]): Record { + return Object.fromEntries( + serverNames.map((name) => [ + name, + { + type: "local", + command: "node", + args: [TEST_MCP_SERVER], + workingDirectory: TEST_HARNESS_DIR, + tools: ["*"], + } as MCPStdioServerConfig, + ]) + ); + } + + async function createSessionWithMcp(serverName: string): Promise { + return client.createSession({ + onPermissionRequest: approveAll, + mcpServers: createTestMcpServers(serverName), + }); + } + + async function waitForMcpServerStatus( + session: CopilotSession, + serverName: string, + expectedStatus = "connected" + ): Promise { + let lastStatus = ""; + await waitForCondition( + async () => { + const result = await session.rpc.mcp.list(); + const server = result.servers.find((entry) => entry.name === serverName); + lastStatus = server?.status ?? ""; + return server?.status === expectedStatus; + }, + { + timeoutMs: 60_000, + intervalMs: 200, + timeoutMessage: `${serverName} did not reach ${expectedStatus}; last status was ${lastStatus}`, + } + ); + } + + async function waitForMcpRunning( + session: CopilotSession, + serverName: string, + expectedRunning: boolean + ): Promise { + await waitForCondition( + async () => + (await session.rpc.mcp.isServerRunning({ serverName })).running === expectedRunning, + { + timeoutMs: 60_000, + intervalMs: 200, + timeoutMessage: `${serverName} running=${expectedRunning}`, + } + ); + } + + function missingName(prefix: string): string { + return `${prefix}-${randomUUID().replace(/-/g, "")}`; + } + + function assertNotUnhandledMethod(message: string): void { + expect(message.toLowerCase()).not.toContain("unhandled method"); + } + + it( + "should list tools and report running status for connected server", + { timeout: 120_000 }, + async () => { + const serverName = "rpc-lifecycle-list-server"; + const session = await createSessionWithMcp(serverName); + try { + await waitForMcpServerStatus(session, serverName); + + const tools = await session.rpc.mcp.listTools({ serverName }); + expect(tools.tools.length).toBeGreaterThan(0); + for (const tool of tools.tools) { + expect(tool.name).toBeTruthy(); + } + + expect((await session.rpc.mcp.isServerRunning({ serverName })).running).toBe(true); + expect( + ( + await session.rpc.mcp.isServerRunning({ + serverName: missingName("missing"), + }) + ).running + ).toBe(false); + } finally { + await session.disconnect(); + } + } + ); + + it("should throw when listing tools for unconnected server", { timeout: 120_000 }, async () => { + const serverName = "rpc-lifecycle-unconnected-host"; + const session = await createSessionWithMcp(serverName); + try { + await waitForMcpServerStatus(session, serverName); + + await expect( + session.rpc.mcp.listTools({ serverName: missingName("missing") }) + ).rejects.toSatisfy((error: unknown) => { + const message = formatError(error); + assertNotUnhandledMethod(message); + expect(message.toLowerCase()).toContain("not connected"); + return true; + }); + } finally { + await session.disconnect(); + } + }); + + it("should stop running mcp server", { timeout: 180_000 }, async () => { + const serverName = "rpc-lifecycle-stop-server"; + const session = await createSessionWithMcp(serverName); + try { + await waitForMcpServerStatus(session, serverName); + expect((await session.rpc.mcp.isServerRunning({ serverName })).running).toBe(true); + + await session.rpc.mcp.stopServer({ serverName }); + + await waitForMcpRunning(session, serverName, false); + } finally { + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rpc_remote.e2e.test.ts b/nodejs/test/e2e/rpc_remote.e2e.test.ts index e0f1c68a5..4d2ba315a 100644 --- a/nodejs/test/e2e/rpc_remote.e2e.test.ts +++ b/nodejs/test/e2e/rpc_remote.e2e.test.ts @@ -62,14 +62,6 @@ describe("Session remote RPC", async () => { ), { timeoutMessage: "Timed out waiting for remote steerable=true event." } ); - expect( - ( - await client.rpc.sessions.getPersistedRemoteSteerable({ - sessionId: session.sessionId, - }) - ).remoteSteerable - ).toBe(true); - await session.rpc.remote.notifySteerableChanged({ remoteSteerable: false }); await waitForCondition( async () => @@ -80,13 +72,6 @@ describe("Session remote RPC", async () => { ), { timeoutMessage: "Timed out waiting for remote steerable=false event." } ); - expect( - ( - await client.rpc.sessions.getPersistedRemoteSteerable({ - sessionId: session.sessionId, - }) - ).remoteSteerable - ).toBe(false); } finally { await session.disconnect(); } diff --git a/nodejs/test/e2e/rpc_server.e2e.test.ts b/nodejs/test/e2e/rpc_server.e2e.test.ts index 9685a21d0..5075ae68d 100644 --- a/nodejs/test/e2e/rpc_server.e2e.test.ts +++ b/nodejs/test/e2e/rpc_server.e2e.test.ts @@ -39,7 +39,7 @@ describe("Server-scoped RPC", async () => { }); onTestFinished(async () => { try { - await extraClient.forceStop(); + await extraClient.stop(); } catch { // Ignore cleanup errors } @@ -92,16 +92,8 @@ describe("Server-scoped RPC", async () => { return directory; } - async function saveAndGetEventFilePath( - targetClient: CopilotClient, - sessionId: string - ): Promise { + async function saveSession(targetClient: CopilotClient, sessionId: string): Promise { await expect(targetClient.rpc.sessions.save({ sessionId })).resolves.toBeDefined(); - const pathResult = await targetClient.rpc.sessions.getEventFilePath({ sessionId }); - expect(pathResult.filePath.trim()).toBeTruthy(); - expect(path.isAbsolute(pathResult.filePath)).toBe(true); - expect(path.basename(pathResult.filePath)).toBe("events.jsonl"); - return pathResult.filePath; } it("should call rpc ping with typed params and result", async () => { @@ -111,6 +103,39 @@ describe("Server-scoped RPC", async () => { expect(Date.parse(result.timestamp)).not.toBeNaN(); }); + it("should reject llm inference response frames for missing request", async () => { + await client.start(); + + const start = await client.rpc.llmInference.httpResponseStart({ + requestId: "missing-llm-inference-request", + status: 200, + headers: { + "content-type": ["text/event-stream"], + }, + statusText: "OK", + }); + expect(start.accepted).toBe(false); + + const chunk = await client.rpc.llmInference.httpResponseChunk({ + requestId: "missing-llm-inference-request", + data: "data: {}\n\n", + binary: false, + end: false, + }); + expect(chunk.accepted).toBe(false); + + const error = await client.rpc.llmInference.httpResponseChunk({ + requestId: "missing-llm-inference-request", + data: "", + end: true, + error: { + code: "missing_request", + message: "No pending LLM inference request.", + }, + }); + expect(error.accepted).toBe(false); + }); + it("should call rpc models list with typed result", async () => { const token = "rpc-models-token"; await configureAuthenticatedUser(token); @@ -199,8 +224,7 @@ describe("Server-scoped RPC", async () => { }); try { await session.log("SERVER_RPC_LIST_READY"); - const eventFilePath = await saveAndGetEventFilePath(client, sessionId); - expect(eventFilePath.toLowerCase()).toContain(sessionId.toLowerCase()); + await saveSession(client, sessionId); await client.rpc.sessions.close({ sessionId }); closed = true; @@ -242,11 +266,6 @@ describe("Server-scoped RPC", async () => { sessionIds: [sessionId, missingSessionId], }); expect(inUse.inUse).not.toContain(missingSessionId); - - const remoteSteerable = await client.rpc.sessions.getPersistedRemoteSteerable({ - sessionId, - }); - expect(remoteSteerable.remoteSteerable).toBeUndefined(); } finally { if (closed) { await client.rpc.sessions.bulkDelete({ sessionIds: [sessionId] }); @@ -265,7 +284,7 @@ describe("Server-scoped RPC", async () => { onPermissionRequest: () => ({ kind: "approve-once" }), }); try { - await saveAndGetEventFilePath(client, sessionId); + await saveSession(client, sessionId); const now = new Date().toISOString(); const result = await client.rpc.sessions.enrichMetadata({ @@ -300,7 +319,7 @@ describe("Server-scoped RPC", async () => { }); await session.log("SERVER_RPC_CLOSE_READY"); - await saveAndGetEventFilePath(client, sessionId); + await saveSession(client, sessionId); await expect(client.rpc.sessions.close({ sessionId })).resolves.toBeDefined(); await expect(client.rpc.sessions.releaseLock({ sessionId })).resolves.toBeDefined(); @@ -320,7 +339,7 @@ describe("Server-scoped RPC", async () => { onPermissionRequest: () => ({ kind: "approve-once" }), }); - await saveAndGetEventFilePath(client, sessionId); + await saveSession(client, sessionId); await client.rpc.sessions.close({ sessionId }); const prune = await client.rpc.sessions.pruneOld({ @@ -415,6 +434,59 @@ describe("Server-scoped RPC", async () => { expect(discovered[0].enabled).toBe(true); expect(discovered[0].path.endsWith(path.join(skillName, "SKILL.md"))).toBe(true); + const skillPaths = await client.rpc.skills.getDiscoveryPaths({ + projectPaths: [workDir], + excludeHostSkills: true, + }); + const projectSkillPath = skillPaths.paths.find( + (p) => p.projectPath && pathsEqual(p.projectPath, workDir) && p.preferredForCreation + ); + if (!projectSkillPath) { + throw new Error(`Expected skill discovery paths to include ${workDir}`); + } + expect(projectSkillPath.path.trim()).not.toBe(""); + + const agents = await client.rpc.agents.discover({ + projectPaths: [workDir], + excludeHostAgents: true, + }); + expect(agents.agents.every((agent) => agent.name.trim() !== "")).toBe(true); + + const agentPaths = await client.rpc.agents.getDiscoveryPaths({ + projectPaths: [workDir], + excludeHostAgents: true, + }); + const projectAgentPath = agentPaths.paths.find( + (p) => p.projectPath && pathsEqual(p.projectPath, workDir) && p.preferredForCreation + ); + if (!projectAgentPath) { + throw new Error(`Expected agent discovery paths to include ${workDir}`); + } + expect(projectAgentPath.path.trim()).not.toBe(""); + + const instructions = await client.rpc.instructions.discover({ + projectPaths: [workDir], + excludeHostInstructions: true, + }); + expect( + instructions.sources.every( + (source) => + source.id.trim() !== "" && + source.label.trim() !== "" && + source.sourcePath.trim() !== "" + ) + ).toBe(true); + + const instructionPaths = await client.rpc.instructions.getDiscoveryPaths({ + projectPaths: [workDir], + excludeHostInstructions: true, + }); + expect(instructionPaths.paths.length).toBeGreaterThan(0); + expect( + instructionPaths.paths.some((p) => p.projectPath && pathsEqual(p.projectPath, workDir)) + ).toBe(true); + expect(instructionPaths.paths.every((p) => p.path.trim() !== "")).toBe(true); + try { await client.rpc.skills.config.setDisabledSkills({ disabledSkills: [skillName] }); const disabled = await client.rpc.skills.discover({ diff --git a/nodejs/test/e2e/rpc_server_misc.e2e.test.ts b/nodejs/test/e2e/rpc_server_misc.e2e.test.ts new file mode 100644 index 000000000..4f12e507a --- /dev/null +++ b/nodejs/test/e2e/rpc_server_misc.e2e.test.ts @@ -0,0 +1,275 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { mkdirSync, rmSync } from "node:fs"; +import { join } from "node:path"; +import { describe, expect, it } from "vitest"; +import { approveAll, CopilotClient, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; +import { formatError, waitForCondition } from "./harness/sdkTestHelper.js"; + +describe("Miscellaneous server-scoped RPC", async () => { + const { copilotClient: client, env, openAiEndpoint, workDir } = await createSdkTestContext(); + + function createUniqueDirectory(prefix: string): string { + const directory = join(workDir, `${prefix}-${randomUUID()}`); + mkdirSync(directory, { recursive: true }); + return directory; + } + + function createClient( + extraEnv: Record, + gitHubToken: string | undefined + ): CopilotClient { + return new CopilotClient({ + workingDirectory: workDir, + env: { + ...env, + ...extraEnv, + }, + logLevel: "error", + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + gitHubToken, + useLoggedInUser: gitHubToken === undefined ? false : undefined, + }); + } + + async function createIsolatedStartedClient( + gitHubToken: string | null = DEFAULT_GITHUB_TOKEN + ): Promise<{ + client: CopilotClient; + home: string; + }> { + const home = createUniqueDirectory("copilot-e2e-misc-home"); + const effectiveGitHubToken = gitHubToken === null ? undefined : gitHubToken; + const isolatedClient = createClient( + { + COPILOT_HOME: home, + GH_CONFIG_DIR: home, + XDG_CONFIG_HOME: home, + XDG_STATE_HOME: home, + COPILOT_DEBUG_GITHUB_API_URL: env.COPILOT_API_URL, + }, + effectiveGitHubToken + ); + try { + await isolatedClient.start(); + return { client: isolatedClient, home }; + } catch (error) { + await disposeIsolated(isolatedClient, home); + throw error; + } + } + + async function disposeIsolated(isolatedClient: CopilotClient, home: string): Promise { + try { + await isolatedClient.stop(); + } catch { + // Best-effort cleanup. + } + tryRemoveDirectory(home); + } + + async function forceStop(target: CopilotClient): Promise { + try { + await target.stop(); + } catch { + // Runtime may already be gone. + } + } + + function tryRemoveDirectory(directory: string): void { + try { + rmSync(directory, { recursive: true, force: true }); + } catch { + // Temp directories are reclaimed by the harness/OS. + } + } + + it("should reload user settings", { timeout: 120_000 }, async () => { + await client.start(); + + await client.rpc.user.settings.reload(); + }); + + it("should get set and clear user settings", { timeout: 120_000 }, async () => { + const { client: isolatedClient, home } = await createIsolatedStartedClient(); + try { + const before = await isolatedClient.rpc.user.settings.get(); + expect(Object.keys(before.settings).length).toBeGreaterThan(0); + for (const [key, setting] of Object.entries(before.settings)) { + expect(key.trim()).toBeTruthy(); + expect(setting.value !== undefined || setting.default !== undefined).toBe(true); + } + + const entry = Object.entries(before.settings).find( + ([, setting]) => typeof setting.value === "boolean" + ); + expect(entry).toBeDefined(); + const [settingKey, setting] = entry!; + const toggledValue = setting.value !== true; + + const set = await isolatedClient.rpc.user.settings.set({ + settings: { [settingKey]: toggledValue }, + }); + expect(set.shadowedKeys).not.toContain(settingKey); + + await isolatedClient.rpc.user.settings.reload(); + const afterSet = await isolatedClient.rpc.user.settings.get(); + expect(afterSet.settings[settingKey].isDefault).toBe(false); + expect(afterSet.settings[settingKey].value).toBe(toggledValue); + + await isolatedClient.rpc.user.settings.set({ + settings: { [settingKey]: null }, + }); + await isolatedClient.rpc.user.settings.reload(); + const afterClear = await isolatedClient.rpc.user.settings.get(); + expect(afterClear.settings[settingKey].isDefault).toBe(true); + } finally { + await disposeIsolated(isolatedClient, home); + } + }); + + it("should login list getCurrentAuth and logout account", { timeout: 120_000 }, async () => { + const login = `rpc-account-${randomUUID().replaceAll("-", "")}`; + const token = `rpc-account-token-${randomUUID().replaceAll("-", "")}`; + await openAiEndpoint.setCopilotUserByToken(token, { + login, + copilot_plan: "individual_pro", + endpoints: { + api: env.COPILOT_API_URL, + telemetry: "https://localhost:1/telemetry", + }, + analytics_tracking_id: "rpc-account-tracking-id", + }); + + const { client: isolatedClient, home } = await createIsolatedStartedClient(null); + try { + const initial = await isolatedClient.rpc.account.getCurrentAuth(); + expect(initial.authInfo).toBeUndefined(); + + const loginResult = await isolatedClient.rpc.account.login({ + host: "https://github.com", + login, + token, + }); + expect(typeof loginResult.storedInVault).toBe("boolean"); + + const current = await isolatedClient.rpc.account.getCurrentAuth(); + expect(current.authErrors).toBeUndefined(); + expect(current.authInfo).toMatchObject({ + type: "user", + host: "https://github.com", + login, + }); + + const users = await isolatedClient.rpc.account.getAllUsers(); + expect(Array.isArray(users)).toBe(true); + for (const user of users) { + expect(user.authInfo.type.trim()).toBeTruthy(); + } + const account = users.find( + (user) => user.authInfo.type === "user" && user.authInfo.login === login + ); + if (account) { + expect(account?.token).toBe(token); + } + + const logout = await isolatedClient.rpc.account.logout({ + authInfo: current.authInfo!, + }); + expect(logout.hasMoreUsers).toBe(false); + + const afterLogout = await isolatedClient.rpc.account.getCurrentAuth(); + expect(afterLogout.authInfo).toBeUndefined(); + } finally { + await disposeIsolated(isolatedClient, home); + } + }); + + it("should report agent registry spawn gate closed", { timeout: 120_000 }, async () => { + const { client: isolatedClient, home } = await createIsolatedStartedClient(); + try { + await expect( + isolatedClient.rpc.agentRegistry.spawn({ cwd: workDir }) + ).rejects.toSatisfy((error: unknown) => { + const message = formatError(error); + expect(message.toLowerCase()).not.toContain("unhandled method"); + expect(message.toLowerCase()).toContain("agentregistry.spawn"); + expect( + message.toLowerCase().includes("not enabled") || + message.toLowerCase().includes("no delegate") + ).toBe(true); + return true; + }); + } finally { + await disposeIsolated(isolatedClient, home); + } + }); + + it("should shut down owned runtime", { timeout: 120_000 }, async () => { + const dedicatedClient = createClient({}, DEFAULT_GITHUB_TOKEN); + try { + await dedicatedClient.start(); + await dedicatedClient.rpc.user.settings.reload(); + + await dedicatedClient.rpc.runtime.shutdown(); + + await waitForCondition( + async () => { + try { + await dedicatedClient.rpc.user.settings.reload(); + return false; + } catch { + return true; + } + }, + { + timeoutMs: 15_000, + intervalMs: 100, + timeoutMessage: "Runtime kept serving RPCs after a graceful shutdown.", + } + ); + } finally { + await forceStop(dedicatedClient); + } + }); + + it( + "should report not found when opening session without context", + { timeout: 120_000 }, + async () => { + const { client: isolatedClient, home } = await createIsolatedStartedClient(); + try { + const result = await isolatedClient.rpc.sessions.open({ kind: "resumeLast" }); + + expect(result.status).toBe("not_found"); + expect(result.sessionId ?? null).toBeNull(); + } finally { + await disposeIsolated(isolatedClient, home); + } + } + ); + + it( + "should reject send attachments from non extension connection", + { timeout: 120_000 }, + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + try { + await expect( + session.rpc.extensions.sendAttachmentsToMessage({ attachments: [] }) + ).rejects.toSatisfy((error: unknown) => { + const message = formatError(error); + expect(message.toLowerCase()).not.toContain("unhandled method"); + expect(message.toLowerCase()).toContain("extension"); + return true; + }); + } finally { + await session.disconnect(); + } + } + ); +}); diff --git a/nodejs/test/e2e/rpc_server_plugins.e2e.test.ts b/nodejs/test/e2e/rpc_server_plugins.e2e.test.ts new file mode 100644 index 000000000..20575a911 --- /dev/null +++ b/nodejs/test/e2e/rpc_server_plugins.e2e.test.ts @@ -0,0 +1,320 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { mkdirSync, rmSync, writeFileSync } from "node:fs"; +import { join } from "node:path"; +import { describe, expect, it } from "vitest"; +import { CopilotClient, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; + +const MARKETPLACE_NAME = "csharp-e2e-marketplace"; +const PLUGIN_NAME = "csharp-e2e-plugin"; +const DIRECT_PLUGIN_NAME = "csharp-e2e-direct"; + +describe("Server-scoped plugin RPC", async () => { + const { env, workDir } = await createSdkTestContext(); + + function createUniqueDirectory(prefix: string): string { + const directory = join(workDir, `${prefix}-${randomUUID()}`); + mkdirSync(directory, { recursive: true }); + return directory; + } + + function createClient(home: string): CopilotClient { + return new CopilotClient({ + workingDirectory: workDir, + env: { + ...env, + COPILOT_HOME: home, + GH_CONFIG_DIR: home, + XDG_CONFIG_HOME: home, + XDG_STATE_HOME: home, + }, + logLevel: "error", + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + gitHubToken: DEFAULT_GITHUB_TOKEN, + }); + } + + async function createIsolatedStartedClient(): Promise<{ + client: CopilotClient; + home: string; + }> { + const home = createUniqueDirectory("copilot-e2e-home"); + const client = createClient(home); + try { + await client.start(); + return { client, home }; + } catch (error) { + await disposeIsolated(client, home); + throw error; + } + } + + async function disposeIsolated( + client: CopilotClient, + home: string, + fixtureDir?: string + ): Promise { + try { + await client.stop(); + } catch { + // Best-effort cleanup. + } + tryRemoveDirectory(home); + if (fixtureDir) { + tryRemoveDirectory(fixtureDir); + } + } + + function tryRemoveDirectory(directory: string): void { + try { + rmSync(directory, { recursive: true, force: true }); + } catch { + // Temp directories are reclaimed by the harness/OS. + } + } + + function createLocalMarketplaceFixture(): string { + const directory = createUniqueDirectory("copilot-e2e-mp"); + const manifest = `{ + "name": "${MARKETPLACE_NAME}", + "owner": { "name": "Copilot SDK E2E" }, + "metadata": { "description": "Local marketplace fixture for SDK E2E tests." }, + "plugins": [ + { + "name": "${PLUGIN_NAME}", + "source": "./${PLUGIN_NAME}", + "description": "E2E demo plugin advertised by the local marketplace.", + "version": "1.0.0" + } + ] +} +`; + writeFileSync(join(directory, "marketplace.json"), manifest); + + const pluginDir = join(directory, PLUGIN_NAME); + mkdirSync(pluginDir, { recursive: true }); + writeSkillFile(pluginDir); + + return directory; + } + + function createDirectPluginFixture(): string { + const directory = createUniqueDirectory("copilot-e2e-plugin"); + const manifest = `{ + "name": "${DIRECT_PLUGIN_NAME}", + "description": "E2E demo plugin installed directly from a local path.", + "version": "1.0.0" +} +`; + writeFileSync(join(directory, "plugin.json"), manifest); + writeSkillFile(directory); + return directory; + } + + function writeSkillFile(pluginDir: string): void { + const skill = `--- +name: csharp-e2e-skill +description: A demo skill contributed by the E2E test plugin. +--- +# Demo Skill + +This skill exists so the plugin reports at least one installed skill. +`; + writeFileSync(join(pluginDir, "SKILL.md"), skill); + } + + it("should install and list plugin from local marketplace", { timeout: 120_000 }, async () => { + const marketplaceDir = createLocalMarketplaceFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + await client.rpc.plugins.marketplaces.add({ source: marketplaceDir }); + + const spec = `${PLUGIN_NAME}@${MARKETPLACE_NAME}`; + const install = await client.rpc.plugins.install({ source: spec }); + + expect(install.plugin.name).toBe(PLUGIN_NAME); + expect(install.plugin.marketplace).toBe(MARKETPLACE_NAME); + expect(install.plugin.enabled).toBe(true); + expect(install.skillsInstalled).toBeGreaterThanOrEqual(1); + expect(install.deprecationWarning ?? null).toBeNull(); + + const afterInstall = await client.rpc.plugins.list(); + const listed = afterInstall.plugins.filter( + (plugin) => plugin.name === PLUGIN_NAME && plugin.marketplace === MARKETPLACE_NAME + ); + expect(listed).toHaveLength(1); + expect(listed[0].enabled).toBe(true); + } finally { + await disposeIsolated(client, home, marketplaceDir); + } + }); + + it("should enable and disable marketplace plugin", { timeout: 120_000 }, async () => { + const marketplaceDir = createLocalMarketplaceFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + const spec = `${PLUGIN_NAME}@${MARKETPLACE_NAME}`; + await client.rpc.plugins.marketplaces.add({ source: marketplaceDir }); + await client.rpc.plugins.install({ source: spec }); + + await client.rpc.plugins.disable({ names: [spec] }); + expect(getPlugin(await client.rpc.plugins.list()).enabled).toBe(false); + + await client.rpc.plugins.enable({ names: [spec] }); + expect(getPlugin(await client.rpc.plugins.list()).enabled).toBe(true); + } finally { + await disposeIsolated(client, home, marketplaceDir); + } + }); + + it("should update single marketplace plugin", { timeout: 120_000 }, async () => { + const marketplaceDir = createLocalMarketplaceFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + const spec = `${PLUGIN_NAME}@${MARKETPLACE_NAME}`; + await client.rpc.plugins.marketplaces.add({ source: marketplaceDir }); + await client.rpc.plugins.install({ source: spec }); + + const update = await client.rpc.plugins.update({ name: spec }); + + expect(update.skillsInstalled).toBeGreaterThanOrEqual(1); + expect(update.previousVersion).toBe("1.0.0"); + expect(update.newVersion).toBe("1.0.0"); + } finally { + await disposeIsolated(client, home, marketplaceDir); + } + }); + + it("should update all installed plugins", { timeout: 120_000 }, async () => { + const marketplaceDir = createLocalMarketplaceFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + const spec = `${PLUGIN_NAME}@${MARKETPLACE_NAME}`; + await client.rpc.plugins.marketplaces.add({ source: marketplaceDir }); + await client.rpc.plugins.install({ source: spec }); + + const result = await client.rpc.plugins.updateAll(); + + const entries = result.results.filter( + (entry) => entry.name === PLUGIN_NAME && entry.marketplace === MARKETPLACE_NAME + ); + expect(entries).toHaveLength(1); + expect(entries[0].success).toBe(true); + expect(entries[0].skillsInstalled).toBeGreaterThanOrEqual(1); + } finally { + await disposeIsolated(client, home, marketplaceDir); + } + }); + + it( + "should install direct local plugin with deprecation warning", + { timeout: 120_000 }, + async () => { + const pluginDir = createDirectPluginFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + const install = await client.rpc.plugins.install({ source: pluginDir }); + + expect(install.plugin.name).toBe(DIRECT_PLUGIN_NAME); + expect(install.plugin.marketplace).toBe(""); + expect(install.deprecationWarning).toBeTruthy(); + expect(install.deprecationWarning?.toLowerCase()).toContain("deprecated"); + expect(install.skillsInstalled).toBeGreaterThanOrEqual(1); + + const afterInstall = await client.rpc.plugins.list(); + expect( + afterInstall.plugins.filter((plugin) => plugin.name === DIRECT_PLUGIN_NAME) + ).toHaveLength(1); + expect(install.plugin.directSourceId).toBeTruthy(); + + await client.rpc.plugins.uninstall({ + name: DIRECT_PLUGIN_NAME, + directSourceId: install.plugin.directSourceId, + }); + + const afterUninstall = await client.rpc.plugins.list(); + expect( + afterUninstall.plugins.some((plugin) => plugin.name === DIRECT_PLUGIN_NAME) + ).toBe(false); + } finally { + await disposeIsolated(client, home, pluginDir); + } + } + ); + + it( + "should list browse refresh and remove local marketplace", + { timeout: 120_000 }, + async () => { + const marketplaceDir = createLocalMarketplaceFixture(); + const { client, home } = await createIsolatedStartedClient(); + try { + const add = await client.rpc.plugins.marketplaces.add({ source: marketplaceDir }); + expect(add.name).toBe(MARKETPLACE_NAME); + + const list = await client.rpc.plugins.marketplaces.list(); + const mine = list.marketplaces.filter( + (marketplace) => marketplace.name === MARKETPLACE_NAME + ); + expect(mine).toHaveLength(1); + expect(mine[0].isDefault).not.toBe(true); + expect( + list.marketplaces.some((marketplace) => marketplace.isDefault === true) + ).toBe(true); + + const browse = await client.rpc.plugins.marketplaces.browse({ + name: MARKETPLACE_NAME, + }); + const advertised = browse.plugins.filter((plugin) => plugin.name === PLUGIN_NAME); + expect(advertised).toHaveLength(1); + expect(advertised[0].description).toBeTruthy(); + + const refresh = await client.rpc.plugins.marketplaces.refresh({ + name: MARKETPLACE_NAME, + }); + const refreshed = refresh.results.filter( + (result) => result.name === MARKETPLACE_NAME + ); + expect(refreshed).toHaveLength(1); + expect(refreshed[0].success).toBe(true); + + const remove = await client.rpc.plugins.marketplaces.remove({ + name: MARKETPLACE_NAME, + }); + expect(remove.removed).toBe(true); + + const afterRemove = await client.rpc.plugins.marketplaces.list(); + expect( + afterRemove.marketplaces.some( + (marketplace) => marketplace.name === MARKETPLACE_NAME + ) + ).toBe(false); + } finally { + await disposeIsolated(client, home, marketplaceDir); + } + } + ); + + it("should reload mcp config cache", { timeout: 120_000 }, async () => { + const { client, home } = await createIsolatedStartedClient(); + try { + await client.rpc.mcp.config.reload(); + } finally { + await disposeIsolated(client, home); + } + }); + + function getPlugin(list: { + plugins: Array<{ name: string; marketplace: string; enabled: boolean }>; + }) { + const plugins = list.plugins.filter( + (plugin) => plugin.name === PLUGIN_NAME && plugin.marketplace === MARKETPLACE_NAME + ); + expect(plugins).toHaveLength(1); + return plugins[0]; + } +}); diff --git a/nodejs/test/e2e/rpc_server_remote_control.e2e.test.ts b/nodejs/test/e2e/rpc_server_remote_control.e2e.test.ts new file mode 100644 index 000000000..3094d3257 --- /dev/null +++ b/nodejs/test/e2e/rpc_server_remote_control.e2e.test.ts @@ -0,0 +1,130 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { describe, expect, it } from "vitest"; +import { CopilotClient, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; +import { formatError } from "./harness/sdkTestHelper.js"; + +describe("Server-scoped remote-control RPC", async () => { + const { env, workDir } = await createSdkTestContext(); + + function createDedicatedClient(): CopilotClient { + return new CopilotClient({ + workingDirectory: workDir, + env, + logLevel: "error", + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + gitHubToken: DEFAULT_GITHUB_TOKEN, + }); + } + + async function forceStop(client: CopilotClient): Promise { + try { + await client.stop(); + } catch { + // Runtime may already be gone. + } + } + + function uniqueSessionId(prefix: string): string { + return `${prefix}-${randomUUID().replace(/-/g, "")}`; + } + + it("should report remote control status as off", { timeout: 120_000 }, async () => { + const client = createDedicatedClient(); + try { + await client.start(); + + const result = await client.rpc.sessions.getRemoteControlStatus(); + + expect(result.status.state).toBe("off"); + } finally { + await forceStop(client); + } + }); + + it("should treat set steering as no op when off", { timeout: 120_000 }, async () => { + const client = createDedicatedClient(); + try { + await client.start(); + + const result = await client.rpc.sessions.setRemoteControlSteering({ enabled: false }); + + expect(result.status.state).toBe("off"); + } finally { + await forceStop(client); + } + }); + + it("should report not stopped when remote control is off", { timeout: 120_000 }, async () => { + const client = createDedicatedClient(); + try { + await client.start(); + + const result = await client.rpc.sessions.stopRemoteControl({}); + + expect(result.stopped).toBe(false); + expect(result.status.state).toBe("off"); + } finally { + await forceStop(client); + } + }); + + it("should reject transfer when off with compare and swap", { timeout: 120_000 }, async () => { + const client = createDedicatedClient(); + try { + await client.start(); + + const result = await client.rpc.sessions.transferRemoteControl({ + toSessionId: uniqueSessionId("rc-to"), + expectedFromSessionId: uniqueSessionId("rc-from"), + }); + + expect(result.transferred).toBe(false); + expect(result.status.state).toBe("off"); + } finally { + await forceStop(client); + } + }); + + it( + "should reach runtime when starting remote control for unknown session", + { timeout: 120_000 }, + async () => { + const client = createDedicatedClient(); + try { + await client.start(); + + await expect( + client.rpc.sessions.startRemoteControl({ + sessionId: uniqueSessionId("missing-session"), + config: { + remote: false, + explicit: false, + silent: true, + steerable: false, + }, + }) + ).rejects.toSatisfy((error: unknown) => { + const message = formatError(error); + expect(message.toLowerCase()).not.toContain("unhandled method"); + expect( + message.toLowerCase().includes("session") || + message.toLowerCase().includes("remote") + ).toBe(true); + return true; + }); + } finally { + try { + await client.rpc.sessions.stopRemoteControl({ force: true }); + } catch { + // Best-effort reset. + } + await forceStop(client); + } + } + ); +}); diff --git a/nodejs/test/e2e/rpc_session_state.e2e.test.ts b/nodejs/test/e2e/rpc_session_state.e2e.test.ts index 295f60340..5164f9923 100644 --- a/nodejs/test/e2e/rpc_session_state.e2e.test.ts +++ b/nodejs/test/e2e/rpc_session_state.e2e.test.ts @@ -49,25 +49,39 @@ describe("Session-scoped RPC", async () => { await session.disconnect(); }); - it("should call session rpc model switchto", async () => { - const session = await client.createSession({ - onPermissionRequest: approveAll, - model: "claude-sonnet-4.5", - }); + // The runtime caches the /models response per (auth, base_url) for 30 + // minutes (see capi_client.rs LIST_MODELS_CACHE), so within a single + // describe — where all tests share one CLI subprocess and proxy URL — + // the cache is primed by whichever test creates a session first. That + // makes any test which calls switchTo to a model not present in the + // first snapshot's models list fail silently (the runtime accepts the + // switch synchronously, then tool revalidation refetches the cached + // list, doesn't see the model, and reverts _selectedModel). Wrapping + // switchTo in its own describe gives it a dedicated subprocess + proxy + // → its own cache entry, so its snapshot's models list is authoritative. + describe("model switchTo (isolated to avoid models cache contamination)", async () => { + const { copilotClient: switchClient } = await createSdkTestContext(); + + it("should call session rpc model switchto", async () => { + const session = await switchClient.createSession({ + onPermissionRequest: approveAll, + model: "claude-sonnet-4.5", + }); - const before = await session.rpc.model.getCurrent(); - expect(before.modelId).toBeTruthy(); + const before = await session.rpc.model.getCurrent(); + expect(before.modelId).toBeTruthy(); - const result = await session.rpc.model.switchTo({ - modelId: "gpt-4.1", - reasoningEffort: "high", - }); - const after = await session.rpc.model.getCurrent(); + const result = await session.rpc.model.switchTo({ + modelId: "gpt-5.4", + reasoningEffort: "high", + }); + const after = await session.rpc.model.getCurrent(); - expect(result.modelId).toBe("gpt-4.1"); - expect(after.modelId).toBe(before.modelId); + expect(result.modelId).toBe("gpt-5.4"); + expect(after.modelId).toBe("gpt-5.4"); - await session.disconnect(); + await session.disconnect(); + }); }); it("should shutdown session with routine type", async () => { @@ -298,7 +312,6 @@ describe("Session-scoped RPC", async () => { it("should call metadata snapshot, setWorkingDirectory, and recordContextChange", async () => { const firstDirectory = createUniqueDirectory(workDir, "rpc-session-state-first"); const secondDirectory = createUniqueDirectory(workDir, "rpc-session-state-second"); - const contextDirectory = createUniqueDirectory(workDir, "rpc-session-state-context"); const branch = `rpc-context-${randomUUID()}`; const session = await client.createSession({ onPermissionRequest: approveAll, @@ -339,8 +352,11 @@ describe("Session-scoped RPC", async () => { "session.context_changed event" ); + // For local sessions the CLI treats the session cwd as authoritative, so a + // recordContextChange that reports a divergent cwd is ignored and emits no event. + // Report the current working directory (secondDirectory) to observe the change. const context = { - cwd: contextDirectory, + cwd: secondDirectory, gitRoot: firstDirectory, branch, repository: "github/copilot-sdk-e2e", @@ -352,7 +368,7 @@ describe("Session-scoped RPC", async () => { await session.rpc.metadata.recordContextChange({ context }); const event = await contextChanged; - expect(pathsEqual(event.data.cwd, contextDirectory)).toBe(true); + expect(pathsEqual(event.data.cwd, secondDirectory)).toBe(true); expect(pathsEqual(event.data.gitRoot ?? "", firstDirectory)).toBe(true); expect(event.data.branch).toBe(branch); expect(event.data.repository).toBe("github/copilot-sdk-e2e"); @@ -478,7 +494,7 @@ describe("Session-scoped RPC", async () => { const session = await client.createSession({ onPermissionRequest: approveAll }); try { const login = `sdk-rpc-${randomUUID()}`; - const setCredentials = await session.rpc.auth.setCredentials({ + const setCredentials = await session.rpc.gitHubAuth.setCredentials({ credentials: { type: "user", host: "https://github.com", @@ -497,7 +513,7 @@ describe("Session-scoped RPC", async () => { }); expect(setCredentials.success).toBe(true); - const status = await session.rpc.auth.getStatus(); + const status = await session.rpc.gitHubAuth.getStatus(); expect(status.isAuthenticated).toBe(true); expect(status.authType).toBe("user"); expect(status.host).toBe("https://github.com"); diff --git a/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts b/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts new file mode 100644 index 000000000..54f40fe12 --- /dev/null +++ b/nodejs/test/e2e/rpc_session_state_extras.e2e.test.ts @@ -0,0 +1,350 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import type { CopilotSession } from "../../src/index.js"; +import { approveAll, CopilotClient, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; + +describe("Session-scoped state extras RPC", async () => { + const { copilotClient: client, env, openAiEndpoint, workDir } = await createSdkTestContext(); + + function createClientWithEnv( + extraEnv: Record, + token = DEFAULT_GITHUB_TOKEN + ): CopilotClient { + return new CopilotClient({ + workingDirectory: workDir, + env: { + ...env, + ...extraEnv, + }, + logLevel: "error", + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + gitHubToken: token, + }); + } + + function createAuthenticatedClient(token: string): CopilotClient { + return createClientWithEnv( + { + COPILOT_DEBUG_GITHUB_API_URL: env.COPILOT_API_URL, + }, + token + ); + } + + async function configureAuthenticatedUser(token: string): Promise { + await openAiEndpoint.setCopilotUserByToken(token, { + login: "rpc-session-extras-user", + copilot_plan: "individual_pro", + endpoints: { + api: env.COPILOT_API_URL, + telemetry: "https://localhost:1/telemetry", + }, + analytics_tracking_id: "rpc-session-extras-tracking-id", + }); + } + + async function createSession(): Promise { + return client.createSession({ onPermissionRequest: approveAll }); + } + + async function disconnect(session: CopilotSession | undefined): Promise { + if (!session) { + return; + } + try { + await session.disconnect(); + } catch { + // Best-effort cleanup. + } + } + + it("should list models for session", { timeout: 120_000 }, async () => { + const token = "rpc-session-model-list-token"; + await configureAuthenticatedUser(token); + const authClient = createAuthenticatedClient(token); + let session: CopilotSession | undefined; + try { + await authClient.start(); + session = await authClient.createSession({ + model: "claude-sonnet-4.5", + onPermissionRequest: approveAll, + }); + + const result = await session.rpc.model.list(); + + expect(Array.isArray(result.list)).toBe(true); + expect(result.list.length).toBeGreaterThan(0); + expect( + result.list.some((model) => JSON.stringify(model).includes("claude-sonnet-4.5")) + ).toBe(true); + } finally { + await disconnect(session); + try { + await authClient.stop(); + } catch { + // Best-effort cleanup. + } + } + }); + + it("should report session activity when idle", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const activity = await session.rpc.metadata.activity(); + + expect(activity.hasActiveWork).toBe(false); + expect(activity.abortable).toBe(false); + } finally { + await session.disconnect(); + } + }); + + it("should add byok provider and model at runtime", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const providerName = `sdk-runtime-provider-${Date.now()}-${Math.random().toString(36).slice(2)}`; + const modelId = "sdk-runtime-model"; + const selectionId = `${providerName}/${modelId}`; + + const added = await session.rpc.provider.add({ + providers: [ + { + name: providerName, + type: "openai", + wireApi: "completions", + baseUrl: "https://api.example.test/v1", + apiKey: "runtime-provider-secret", + headers: { "X-SDK-Provider": "runtime" }, + }, + ], + models: [ + { + provider: providerName, + id: modelId, + name: "SDK Runtime Model", + modelId: "claude-sonnet-4.5", + wireModel: "wire-sdk-runtime-model", + maxContextWindowTokens: 4096, + maxPromptTokens: 3072, + maxOutputTokens: 1024, + capabilities: { + limits: { + maxContextWindowTokens: 4096, + maxPromptTokens: 3072, + maxOutputTokens: 1024, + }, + supports: { + reasoningEffort: false, + vision: false, + }, + }, + }, + ], + }); + + expect(added.models).toHaveLength(1); + expect(JSON.stringify(added.models[0])).toContain(selectionId); + expect(JSON.stringify(added.models[0])).toContain("SDK Runtime Model"); + + const listed = await session.rpc.model.list(); + expect(listed.list.some((model) => JSON.stringify(model).includes(selectionId))).toBe( + true + ); + + const switched = await session.rpc.model.switchTo({ modelId: selectionId }); + expect(switched.modelId).toBe(selectionId); + expect((await session.rpc.model.getCurrent()).modelId).toBe(selectionId); + } finally { + await session.disconnect(); + } + }); + + it( + "should return empty completions when host does not provide them", + { timeout: 120_000 }, + async () => { + const session = await createSession(); + try { + const triggers = await session.rpc.completions.getTriggerCharacters(); + expect(triggers.triggerCharacters).toEqual([]); + + const completions = await session.rpc.completions.request({ + text: "Use @", + offset: 5, + }); + expect(completions.items).toEqual([]); + } finally { + await session.disconnect(); + } + } + ); + + it("should report visibility as unsynced for local session", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const initial = await session.rpc.visibility.get(); + expect(initial.synced).toBe(false); + expect(initial.status).toBeUndefined(); + expect(initial.shareUrl).toBeUndefined(); + + const set = await session.rpc.visibility.set({ status: "repo" }); + expect(set.synced).toBe(false); + expect(set.status).toBeUndefined(); + expect(set.shareUrl).toBeUndefined(); + } finally { + await session.disconnect(); + } + }); + + it("should get and set allowall permissions", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const initial = await session.rpc.permissions.getAllowAll(); + expect(initial.enabled).toBe(false); + + const enable = await session.rpc.permissions.setAllowAll({ enabled: true }); + expect(enable.success).toBe(true); + expect(enable.enabled).toBe(true); + expect((await session.rpc.permissions.getAllowAll()).enabled).toBe(true); + + const disable = await session.rpc.permissions.setAllowAll({ enabled: false }); + expect(disable.success).toBe(true); + expect(disable.enabled).toBe(false); + expect((await session.rpc.permissions.getAllowAll()).enabled).toBe(false); + } finally { + try { + await session.rpc.permissions.setAllowAll({ enabled: false }); + } catch { + // Best-effort reset. + } + await session.disconnect(); + } + }); + + it( + "should get context attribution and heaviest messages after turn", + { timeout: 120_000 }, + async () => { + const session = await createSession(); + try { + const answer = await session.sendAndWait({ + prompt: "Say CONTEXT_METADATA_OK exactly.", + }); + expect(answer?.data.content ?? "").toContain("CONTEXT_METADATA_OK"); + + const attribution = await session.rpc.metadata.getContextAttribution(); + expect(attribution.contextAttribution).not.toBeNull(); + const contextAttribution = attribution.contextAttribution!; + expect(contextAttribution.totalTokens).toBeGreaterThan(0); + expect(contextAttribution.entries.length).toBeGreaterThan(0); + for (const entry of contextAttribution.entries) { + expect(entry.id.trim()).toBeTruthy(); + expect(entry.kind.trim()).toBeTruthy(); + expect(entry.label.trim()).toBeTruthy(); + expect(entry.tokens).toBeGreaterThanOrEqual(0); + for (const attribute of entry.attributes ?? []) { + expect(attribute.key.trim()).toBeTruthy(); + } + } + + const heaviest = await session.rpc.metadata.getContextHeaviestMessages({ + limit: 2, + }); + expect(heaviest.totalTokens).toBeGreaterThan(0); + expect(heaviest.messages.length).toBeLessThanOrEqual(2); + for (const message of heaviest.messages) { + expect(message.id.trim()).toBeTruthy(); + expect(message.tokens).toBeGreaterThanOrEqual(0); + } + } finally { + await session.disconnect(); + } + } + ); + + it("should update and clear live subagent settings", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + await expect( + session.rpc.tools.updateSubagentSettings({ + subagents: { + "general-purpose": { + model: "claude-haiku-4.5", + effortLevel: "low", + contextTier: "default", + }, + }, + }) + ).resolves.toBeDefined(); + + await expect( + session.rpc.tools.updateSubagentSettings({ + subagents: null, + }) + ).resolves.toBeDefined(); + } finally { + await session.disconnect(); + } + }); + + it("should read empty sql todos for fresh session", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const result = await session.rpc.plan.readSqlTodos(); + + expect(result.rows).toBeDefined(); + expect(result.rows).toEqual([]); + } finally { + await session.disconnect(); + } + }); + + it("should get telemetry engagement id", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const result = await session.rpc.telemetry.getEngagementId(); + + expect(result).toBeDefined(); + } finally { + await session.disconnect(); + } + }); + + it("should get current tool metadata after initialization", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + const answer = await session.sendAndWait({ prompt: "What is 2+2?" }); + expect(answer).toBeDefined(); + + const result = await session.rpc.tools.getCurrentMetadata(); + + expect(result.tools).not.toBeNull(); + expect(result.tools!.length).toBeGreaterThan(0); + for (const tool of result.tools!) { + expect(tool.name).toBeTruthy(); + expect(tool.description).toBeDefined(); + } + } finally { + await session.disconnect(); + } + }); + + it("should reload session plugins", { timeout: 120_000 }, async () => { + const session = await createSession(); + try { + await session.rpc.plugins.reload(); + + const plugins = await session.rpc.plugins.list(); + expect(plugins.plugins).toBeDefined(); + for (const plugin of plugins.plugins) { + expect(plugin.name).toBeTruthy(); + } + } finally { + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rpc_shell_user_requested.e2e.test.ts b/nodejs/test/e2e/rpc_shell_user_requested.e2e.test.ts new file mode 100644 index 000000000..961771f78 --- /dev/null +++ b/nodejs/test/e2e/rpc_shell_user_requested.e2e.test.ts @@ -0,0 +1,146 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import { existsSync, rmSync } from "node:fs"; +import { join } from "node:path"; +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { waitForCondition } from "./harness/sdkTestHelper.js"; + +describe("User-requested shell RPC", async () => { + const { copilotClient: client, homeDir } = await createSdkTestContext(); + + function compactUuid(): string { + return randomUUID().replace(/-/g, ""); + } + + function quotePowerShell(value: string): string { + return `'${value.replace(/'/g, "''")}'`; + } + + function quoteSh(value: string): string { + return `'${value.replace(/'/g, "'\\''")}'`; + } + + function createMarkerThenSleepCommand(markerPath: string, seconds: number): string { + if (process.platform === "win32") { + return `Set-Content -LiteralPath ${quotePowerShell(markerPath)} -Value 'running'; Start-Sleep -Seconds ${seconds}`; + } + return `echo running > ${quoteSh(markerPath)}; sleep ${seconds}`; + } + + async function waitForFileExists(filePath: string): Promise { + await waitForCondition(() => existsSync(filePath), { + timeoutMs: 30_000, + intervalMs: 100, + timeoutMessage: `Timed out waiting for the shell command to create '${filePath}'.`, + }); + } + + async function withTimeout( + promise: Promise, + timeoutMs: number, + message: string + ): Promise { + let timeout: ReturnType | undefined; + try { + return await Promise.race([ + promise, + new Promise((_, reject) => { + timeout = setTimeout(() => reject(new Error(message)), timeoutMs); + }), + ]); + } finally { + if (timeout) { + clearTimeout(timeout); + } + } + } + + function tryDeleteFile(filePath: string): void { + try { + rmSync(filePath, { force: true }); + } catch { + // Best-effort cleanup. + } + } + + it("should execute user requested shell command", { timeout: 120_000 }, async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + try { + const marker = `copilotusershell${compactUuid()}`; + const requestId = `req-${compactUuid()}`; + + const result = await session.rpc.shell.executeUserRequested({ + requestId, + command: `echo ${marker}`, + }); + + expect(result.success).toBe(true); + expect(result.exitCode).toBe(0); + expect(result.output).toContain(marker); + expect(result.toolCallId).toBeTruthy(); + } finally { + await session.disconnect(); + } + }); + + it("should cancel user requested shell command", { timeout: 120_000 }, async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + const markerPath = join(homeDir, `shell-cancel-${compactUuid()}.txt`); + let executeTask: + | Promise>> + | undefined; + let executeSettled = false; + try { + const missing = await session.rpc.shell.cancelUserRequested({ + requestId: `missing-${compactUuid()}`, + }); + expect(missing.cancelled).toBe(false); + + const requestId = `req-${compactUuid()}`; + executeTask = session.rpc.shell.executeUserRequested({ + requestId, + command: createMarkerThenSleepCommand(markerPath, 60), + }); + executeTask + .finally(() => { + executeSettled = true; + }) + .catch(() => {}); + executeTask.catch(() => {}); + + await waitForFileExists(markerPath); + + await waitForCondition( + async () => (await session.rpc.shell.cancelUserRequested({ requestId })).cancelled, + { + timeoutMs: 15_000, + intervalMs: 100, + timeoutMessage: + "Timed out waiting for the user-requested shell command to become cancellable.", + } + ); + + const result = await withTimeout( + executeTask, + 30_000, + "Timed out waiting for cancelled shell command to finish." + ); + expect(result.success).toBe(false); + } finally { + if (executeTask && !executeSettled) { + await withTimeout( + executeTask, + 30_000, + "Timed out draining cancelled shell command." + ).catch(() => {}); + } + tryDeleteFile(markerPath); + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rpc_tasks_and_handlers.e2e.test.ts b/nodejs/test/e2e/rpc_tasks_and_handlers.e2e.test.ts index e7f7664c3..cb41c69e6 100644 --- a/nodejs/test/e2e/rpc_tasks_and_handlers.e2e.test.ts +++ b/nodejs/test/e2e/rpc_tasks_and_handlers.e2e.test.ts @@ -173,6 +173,27 @@ describe("Session tasks RPC and pending handlers", async () => { }); expect(locationApproval.success).toBe(false); + const sessionLimits = await session.rpc.ui.handlePendingSessionLimitsExhausted({ + requestId: "missing-session-limits-request", + response: { action: "cancel" }, + }); + expect(sessionLimits.success).toBe(false); + + const headers = await session.rpc.mcp.headers.handlePendingHeadersRefreshRequest({ + requestId: "missing-headers-refresh-request", + result: { + kind: "headers", + headers: { "X-SDK-Test": "missing" }, + }, + }); + expect(headers.success).toBe(false); + + const noHeaders = await session.rpc.mcp.headers.handlePendingHeadersRefreshRequest({ + requestId: "missing-headers-refresh-none-request", + result: { kind: "none" }, + }); + expect(noHeaders.success).toBe(false); + await session.disconnect(); }); diff --git a/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts b/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts new file mode 100644 index 000000000..662294d70 --- /dev/null +++ b/nodejs/test/e2e/rpc_ui_ephemeral_query.e2e.test.ts @@ -0,0 +1,26 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +describe("UI ephemeral query RPC", async () => { + const { copilotClient: client } = await createSdkTestContext(); + + it("should answer ephemeral query", { timeout: 120_000 }, async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + try { + const result = await session.rpc.ui.ephemeralQuery({ + question: "In one word, what is the primary color of a clear daytime sky?", + }); + + expect(result).toBeDefined(); + expect(result.answer.trim()).toBeTruthy(); + expect(result.answer.toLowerCase()).toContain("blue"); + } finally { + await session.disconnect(); + } + }); +}); diff --git a/nodejs/test/e2e/rpc_workspace_checkpoints.e2e.test.ts b/nodejs/test/e2e/rpc_workspace_checkpoints.e2e.test.ts index d7f478e1f..78a820f67 100644 --- a/nodejs/test/e2e/rpc_workspace_checkpoints.e2e.test.ts +++ b/nodejs/test/e2e/rpc_workspace_checkpoints.e2e.test.ts @@ -23,9 +23,9 @@ describe("Session workspace checkpoint RPC", async () => { it("should return null or empty content for unknown checkpoint", async () => { const session = await client.createSession({ onPermissionRequest: approveAll }); try { - const result = await session.rpc.workspaces.readCheckpoint({ - number: Number.MAX_SAFE_INTEGER, - }); + // A high but 32-bit-safe checkpoint number that will never exist in a fresh + // session, so the read reports the checkpoint as missing. + const result = await session.rpc.workspaces.readCheckpoint({ number: 4294967294 }); expect(result.content ?? "").toBe(""); } finally { await session.disconnect(); diff --git a/nodejs/test/e2e/session.e2e.test.ts b/nodejs/test/e2e/session.e2e.test.ts index 55a064ab4..d99a3e392 100644 --- a/nodejs/test/e2e/session.e2e.test.ts +++ b/nodejs/test/e2e/session.e2e.test.ts @@ -2,18 +2,19 @@ import { rm } from "fs/promises"; import { describe, expect, it, onTestFinished, vi } from "vitest"; import { ParsedHttpExchange } from "../../../test/harness/replayingCapiProxy.js"; import { CopilotClient, approveAll, defineTool, RuntimeConnection } from "../../src/index.js"; -import { createSdkTestContext, isCI } from "./harness/sdkTestContext.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN, isCI } from "./harness/sdkTestContext.js"; import { getFinalAssistantMessage, getNextEventOfType, retry } from "./harness/sdkTestHelper.js"; -describe("Sessions", async () => { - const { - copilotClient: client, - openAiEndpoint, - homeDir, - workDir, - env, - } = await createSdkTestContext(); +const { + copilotClient: client, + openAiEndpoint, + homeDir, + workDir, + env, + createClient, +} = await createSdkTestContext(); +describe("Sessions", () => { async function waitForExchanges(minimumCount = 1) { await retry( `capture ${minimumCount} chat completion request(s)`, @@ -39,15 +40,14 @@ describe("Sessions", async () => { }); onTestFinished(async () => { try { - await standaloneClient.forceStop(); + await standaloneClient.stop(); } catch { // ignore } }); - const session = await standaloneClient.createSession({}); + await using session = await standaloneClient.createSession({}); expect(session.sessionId).toMatch(/^[a-f0-9-]+$/); - await session.disconnect(); } ); @@ -64,7 +64,7 @@ describe("Sessions", async () => { }); onTestFinished(async () => { try { - await tcpClient.forceStop(); + await tcpClient.stop(); } catch { // ignore } @@ -84,7 +84,7 @@ describe("Sessions", async () => { }); onTestFinished(async () => { try { - await resumeClient.forceStop(); + await resumeClient.stop(); } catch { // ignore } @@ -96,7 +96,7 @@ describe("Sessions", async () => { await originalSession.disconnect(); }); it("should create and disconnect sessions", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, model: "claude-sonnet-4.5", }); @@ -118,7 +118,7 @@ describe("Sessions", async () => { // TODO: Re-enable once test harness CAPI proxy supports this test's session lifecycle it.skip("should list sessions with context field", { timeout: 60000 }, async () => { // Create a session — just creating it is enough for it to appear in listSessions - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); expect(session.sessionId).toMatch(/^[a-f0-9-]+$/); // Verify it has a start event (confirms session is active) @@ -137,7 +137,7 @@ describe("Sessions", async () => { }); it("should get session metadata by ID", { timeout: 60000 }, async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); expect(session.sessionId).toMatch(/^[a-f0-9-]+$/); // Send a message to persist the session to disk @@ -164,7 +164,7 @@ describe("Sessions", async () => { }); it("should have stateful conversation", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); const assistantMessage = await session.sendAndWait({ prompt: "What is 1+1?" }); expect(assistantMessage?.data.content).toContain("2"); @@ -176,7 +176,7 @@ describe("Sessions", async () => { it("should create a session with appended systemMessage config", async () => { const systemMessageSuffix = "End each response with the phrase 'Have a nice day!'"; - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, systemMessage: { mode: "append", @@ -197,7 +197,7 @@ describe("Sessions", async () => { it("should create a session with replaced systemMessage config", async () => { const testSystemMessage = "You are an assistant called Testy McTestface. Reply succinctly."; - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, systemMessage: { mode: "replace", content: testSystemMessage }, }); @@ -218,7 +218,7 @@ describe("Sessions", async () => { async () => { const customTone = "Respond in a warm, professional tone. Be thorough in explanations."; const appendedContent = "Always mention quarterly earnings."; - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, systemMessage: { mode: "customize", @@ -230,66 +230,54 @@ describe("Sessions", async () => { }, }); - try { - await session.send({ prompt: "Who are you?" }); - - // Validate the system message sent to the model - const traffic = await waitForExchanges(); - const systemMessage = getSystemMessage(traffic[0]); - expect(systemMessage).toContain(customTone); - expect(systemMessage).toContain(appendedContent); - // The code_change_rules section should have been removed - expect(systemMessage).not.toContain(""); - } finally { - await session.disconnect(); - } + await session.send({ prompt: "Who are you?" }); + + // Validate the system message sent to the model + const traffic = await waitForExchanges(); + const systemMessage = getSystemMessage(traffic[0]); + expect(systemMessage).toContain(customTone); + expect(systemMessage).toContain(appendedContent); + // The code_change_rules section should have been removed + expect(systemMessage).not.toContain(""); } ); it("should create a session with availableTools", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, availableTools: ["view", "edit"], }); - try { - await session.send({ prompt: "What is 1+1?" }); + await session.send({ prompt: "What is 1+1?" }); - // It only tells the model about the specified tools and no others - const traffic = await waitForExchanges(); - expect(traffic[0].request.tools).toMatchObject([ - { function: { name: "view" } }, - { function: { name: "edit" } }, - ]); - } finally { - await session.disconnect(); - } + // It only tells the model about the specified tools and no others + const traffic = await waitForExchanges(); + expect(traffic[0].request.tools).toMatchObject([ + { function: { name: "view" } }, + { function: { name: "edit" } }, + ]); }); it("should create a session with excludedTools", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, excludedTools: ["view"], }); - try { - await session.send({ prompt: "What is 1+1?" }); + await session.send({ prompt: "What is 1+1?" }); - // It has other tools, but not the one we excluded - const traffic = await waitForExchanges(); - const functionNames = traffic[0].request.tools?.map( - (t) => (t as { function: { name: string } }).function.name - ); - expect(functionNames).toContain("edit"); - expect(functionNames).toContain("grep"); - expect(functionNames).not.toContain("view"); - } finally { - await session.disconnect(); - } + // It has other tools, but not the one we excluded + const traffic = await waitForExchanges(); + const functionNames = traffic[0].request.tools?.map( + (t) => (t as { function: { name: string } }).function.name + ); + expect(functionNames).toContain("edit"); + expect(functionNames).toContain("grep"); + expect(functionNames).not.toContain("view"); }); it("should create a session with defaultAgent excludedTools", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, tools: [ defineTool("secret_tool", { @@ -307,19 +295,15 @@ describe("Sessions", async () => { }, }); - try { - await session.send({ prompt: "What is 1+1?" }); + await session.send({ prompt: "What is 1+1?" }); - // The secret_tool should be registered with the runtime but not advertised - // to the default agent's underlying model call. - const traffic = await waitForExchanges(); - const functionNames = traffic[0].request.tools?.map( - (t) => (t as { function: { name: string } }).function.name - ); - expect(functionNames).not.toContain("secret_tool"); - } finally { - await session.disconnect(); - } + // The secret_tool should be registered with the runtime but not advertised + // to the default agent's underlying model call. + const traffic = await waitForExchanges(); + const functionNames = traffic[0].request.tools?.map( + (t) => (t as { function: { name: string } }).function.name + ); + expect(functionNames).not.toContain("secret_tool"); }); // TODO: This test shows there's a race condition inside client.ts. If createSession is called @@ -362,7 +346,9 @@ describe("Sessions", async () => { expect(answer?.data.content).toContain("2"); // Resume using the same client - const session2 = await client.resumeSession(sessionId, { onPermissionRequest: approveAll }); + await using session2 = await client.resumeSession(sessionId, { + onPermissionRequest: approveAll, + }); expect(session2.sessionId).toBe(sessionId); const messages = await session2.getEvents(); const assistantMessages = messages.filter((m) => m.type === "assistant.message"); @@ -377,19 +363,18 @@ describe("Sessions", async () => { it("should resume a session using a new client", async () => { // Create initial session - const session1 = await client.createSession({ onPermissionRequest: approveAll }); + await using session1 = await client.createSession({ onPermissionRequest: approveAll }); const sessionId = session1.sessionId; const answer = await session1.sendAndWait({ prompt: "What is 1+1?" }); expect(answer?.data.content).toContain("2"); // Resume using a new client - const newClient = new CopilotClient({ - env, + const newClient = createClient({ gitHubToken: isCI ? "fake-token-for-e2e-tests" : undefined, }); - onTestFinished(() => newClient.forceStop()); - const session2 = await newClient.resumeSession(sessionId, { + onTestFinished(() => newClient.stop()); + await using session2 = await newClient.resumeSession(sessionId, { onPermissionRequest: approveAll, }); expect(session2.sessionId).toBe(sessionId); @@ -417,7 +402,7 @@ describe("Sessions", async () => { }); it("should create session with custom tool", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, tools: [ { @@ -452,7 +437,7 @@ describe("Sessions", async () => { const sessionId = session.sessionId; // Resume the session with a provider - const session2 = await client.resumeSession(sessionId, { + await using session2 = await client.resumeSession(sessionId, { onPermissionRequest: approveAll, provider: { type: "openai", @@ -464,8 +449,40 @@ describe("Sessions", async () => { expect(session2.sessionId).toBe(sessionId); }); + it("resumes a persisted session from a new client when an MCP OAuth handler is configured", async () => { + // Take a turn so the session is persisted to the store and can be + // loaded by a different CLI process. + await using session1 = await client.createSession({ + onPermissionRequest: approveAll, + onMcpAuthRequest: () => ({ kind: "cancelled" }), + }); + const sessionId = session1.sessionId; + const answer = await session1.sendAndWait({ prompt: "What is 1+1?" }); + expect(answer?.data.content).toContain("2"); + + // Resume from a fresh client (new CLI process). Its routing table does + // not know the session until it handles `session.resume`. Because an MCP + // OAuth handler is configured, the SDK issues a session-scoped + // `session.eventLog.registerInterest` for `mcp.oauth_required`; that must + // be sent AFTER `session.resume`, otherwise the runtime rejects it with + // "Session not found: ". + const newClient = createClient({ + gitHubToken: isCI + ? DEFAULT_GITHUB_TOKEN + : (process.env.GITHUB_TOKEN ?? DEFAULT_GITHUB_TOKEN), + }); + onTestFinished(() => newClient.stop()); + + await using session2 = await newClient.resumeSession(sessionId, { + onPermissionRequest: approveAll, + onMcpAuthRequest: () => ({ kind: "cancelled" }), + }); + + expect(session2.sessionId).toBe(sessionId); + }); + it("should abort a session", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); // Set up event listeners BEFORE sending to avoid race conditions const nextToolCallStart = getNextEventOfType(session, "tool.execution_start"); @@ -486,8 +503,10 @@ describe("Sessions", async () => { expect(messages.some((m) => m.type === "abort")).toBe(true); // We should be able to send another message - const answer = await session.sendAndWait({ prompt: "What is 2+2?" }); - expect(answer?.data.content).toContain("4"); + const nextAssistantMessage = getNextEventOfType(session, "assistant.message"); + await session.send({ prompt: "What is 2+2?" }); + const answer = await nextAssistantMessage; + expect(answer.data.content).toContain("4"); }); it("should receive session events", async () => { @@ -496,7 +515,7 @@ describe("Sessions", async () => { // if the session weren't registered in the sessions map before the RPC, // the event would be dropped. const earlyEvents: Array<{ type: string }> = []; - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, onEvent: (event) => { earlyEvents.push(event); @@ -528,7 +547,7 @@ describe("Sessions", async () => { }); it("handler exception does not halt event delivery", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); let eventCount = 0; let gotIdle = false; @@ -553,12 +572,10 @@ describe("Sessions", async () => { // Handler saw more than just the first (throwing) event. expect(eventCount).toBeGreaterThan(1); - - await session.disconnect(); }); it("disposeAsync from handler does not deadlock", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); let disposed = false; const disposedPromise = new Promise((resolve) => { @@ -585,25 +602,21 @@ describe("Sessions", async () => { onTestFinished(async () => { await rm(customConfigDir, { recursive: true, force: true }).catch(() => {}); }); - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, configDirectory: customConfigDir, }); expect(session.sessionId).toMatch(/^[a-f0-9-]+$/); - try { - // Session should work normally with custom config dir - await session.send({ prompt: "What is 1+1?" }); - const assistantMessage = await getFinalAssistantMessage(session); - expect(assistantMessage.data.content).toContain("2"); - } finally { - await session.disconnect(); - } + // Session should work normally with custom config dir + await session.send({ prompt: "What is 1+1?" }); + const assistantMessage = await getFinalAssistantMessage(session); + expect(assistantMessage.data.content).toContain("2"); }); it("should log messages at all levels and emit matching session events", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); const events: Array<{ type: string; id?: string; data?: Record }> = []; session.on((event) => { @@ -658,7 +671,7 @@ describe("Sessions", async () => { const { writeFile } = await import("fs/promises"); await writeFile(filePath, "FILE_ATTACHMENT_SENTINEL"); - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "Read the attached file and reply with its contents.", @@ -692,8 +705,6 @@ describe("Sessions", async () => { expect(attachment.displayName).toBe("attached-file.txt"); expect(attachment.path).toBe(filePath); expect(attachment.lineRange).toEqual({ start: 1, end: 1 }); - - await session.disconnect(); }); it("should send with directory attachment", async () => { @@ -702,7 +713,7 @@ describe("Sessions", async () => { await mkdir(directoryPath, { recursive: true }); await writeFile(`${directoryPath}/readme.txt`, "DIRECTORY_ATTACHMENT_SENTINEL"); - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "List the attached directory.", @@ -725,8 +736,6 @@ describe("Sessions", async () => { expect(attachment.type).toBe("directory"); expect(attachment.displayName).toBe("attached-directory"); expect(attachment.path).toBe(directoryPath); - - await session.disconnect(); }); it("should send with selection attachment", async () => { @@ -734,7 +743,7 @@ describe("Sessions", async () => { const { writeFile } = await import("fs/promises"); await writeFile(filePath, 'class C { string Value = "SELECTION_SENTINEL"; }'); - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "Summarize the selected code.", @@ -774,8 +783,6 @@ describe("Sessions", async () => { expect(attachment.text).toBe('string Value = "SELECTION_SENTINEL";'); expect(attachment.selection.start).toEqual({ line: 1, character: 10 }); expect(attachment.selection.end).toEqual({ line: 1, character: 45 }); - - await session.disconnect(); }); it("should accept blob attachments", async () => { @@ -784,7 +791,7 @@ describe("Sessions", async () => { const { writeFile } = await import("fs/promises"); await writeFile(`${workDir}/test-pixel.png`, Buffer.from(pngBase64, "base64")); - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "Describe this image", @@ -797,12 +804,10 @@ describe("Sessions", async () => { }, ], }); - - await session.disconnect(); }); it("should send with github reference attachment", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "Using only the GitHub reference metadata in this message, summarize the reference. Do not call any tools.", @@ -842,12 +847,10 @@ describe("Sessions", async () => { expect(attachment.state).toBe("open"); expect(attachment.title).toBe("Add E2E attachment coverage"); expect(attachment.url).toBe("https://github.com/github/copilot-sdk/issues/1234"); - - await session.disconnect(); }); it("should send with mode property", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "Say mode ok.", @@ -861,12 +864,10 @@ describe("Sessions", async () => { expect(userMessage).toBeDefined(); expect(userMessage!.data.content).toBe("Say mode ok."); expect(userMessage!.data.agentMode).toBe("plan"); - - await session.disconnect(); }); it("should send with custom requestHeaders", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); await session.sendAndWait({ prompt: "What is 1+1?", @@ -885,8 +886,6 @@ describe("Sessions", async () => { const headerValue = headers[matchingKey!]; const headerStr = Array.isArray(headerValue) ? headerValue.join(",") : (headerValue ?? ""); expect(headerStr).toContain("ts-request-headers"); - - await session.disconnect(); }); }); @@ -899,10 +898,8 @@ function getSystemMessage(exchange: ParsedHttpExchange): string | undefined { describe("Send Blocking Behavior", async () => { // Tests for Issue #17: send() should return immediately, not block until turn completes - const { copilotClient: client } = await createSdkTestContext(); - it("send returns immediately while events stream in background", async () => { - const session = await client.createSession({ + await using session = await client.createSession({ onPermissionRequest: approveAll, }); @@ -926,7 +923,7 @@ describe("Send Blocking Behavior", async () => { }); it("sendAndWait blocks until session.idle and returns final assistant message", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); const events: string[] = []; session.on((event) => { @@ -945,16 +942,17 @@ describe("Send Blocking Behavior", async () => { // This test validates client-side timeout behavior. // The snapshot has no assistant response since we expect timeout before completion. it("sendAndWait throws on timeout", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); // Use a slow command to ensure timeout triggers before completion await expect( session.sendAndWait({ prompt: "Run 'sleep 2 && echo done'" }, 100) ).rejects.toThrow(/Timeout after 100ms/); + await session.abort(); }); it("should set model on existing session", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + await using session = await client.createSession({ onPermissionRequest: approveAll }); // Subscribe for the model change event before calling setModel. const modelChangePromise = getNextEventOfType(session, "session.model_change"); @@ -964,19 +962,23 @@ describe("Send Blocking Behavior", async () => { // Verify a model_change event was emitted with the new model. const event = await modelChangePromise; expect(event.data.newModel).toBe("gpt-4.1"); - - await session.disconnect(); }); - it("should set model with reasoningEffort", async () => { - const session = await client.createSession({ onPermissionRequest: approveAll }); + describe("reasoning effort model switch (isolated to avoid models cache contamination)", async () => { + const { copilotClient: reasoningClient } = await createSdkTestContext(); - const modelChangePromise = getNextEventOfType(session, "session.model_change"); + it("should set model with reasoningEffort", async () => { + await using session = await reasoningClient.createSession({ + onPermissionRequest: approveAll, + }); - await session.setModel("gpt-4.1", { reasoningEffort: "high" }); + const modelChangePromise = getNextEventOfType(session, "session.model_change"); - const event = await modelChangePromise; - expect(event.data.newModel).toBe("gpt-4.1"); - expect(event.data.reasoningEffort).toBe("high"); + await session.setModel("gpt-5.4", { reasoningEffort: "high" }); + + const event = await modelChangePromise; + expect(event.data.newModel).toBe("gpt-5.4"); + expect(event.data.reasoningEffort).toBe("high"); + }); }); }); diff --git a/nodejs/test/e2e/session_config.e2e.test.ts b/nodejs/test/e2e/session_config.e2e.test.ts index acb31f058..85137e0ff 100644 --- a/nodejs/test/e2e/session_config.e2e.test.ts +++ b/nodejs/test/e2e/session_config.e2e.test.ts @@ -1,12 +1,18 @@ import { describe, expect, it } from "vitest"; import { writeFile, mkdir } from "fs/promises"; import { join } from "path"; -import { approveAll } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { + approveAll, + CopilotClient, + CopilotRequestHandler, + RuntimeConnection, + type CopilotRequestContext, +} from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; import { retry } from "./harness/sdkTestHelper.js"; describe("Session Configuration", async () => { - const { copilotClient: client, workDir, openAiEndpoint } = await createSdkTestContext(); + const { copilotClient: client, workDir, openAiEndpoint, env } = await createSdkTestContext(); async function waitForExchanges(minimumCount = 1) { await retry( @@ -216,6 +222,414 @@ describe("Session Configuration", async () => { return (exchange.request.tools ?? []).map((t) => t.function.name); } + async function expectGitHubMcpConfigApplied(session: CopilotSession): Promise { + await session.rpc.mcp.list(); + await retry("capture configured GitHub MCP request", async () => { + const requests = await openAiEndpoint.getRequests(); + const request = requests.find( + (entry) => entry.method === "POST" && entry.url === "/mcp" + ); + expect( + request, + `captured requests: ${requests.map((entry) => `${entry.method} ${entry.url}`).join(", ")}` + ).toBeDefined(); + expect(request?.headers["x-mcp-toolsets"]).toBe("all"); + expect(request?.headers["x-mcp-insiders"]).toBe("true"); + expect(requests.some((entry) => entry.url === "/mcp/readonly")).toBe(false); + }); + } + + async function sendAndGetNextExchange( + session: { sendAndWait(options: { prompt: string }): Promise }, + prompt: string + ) { + const existingCount = (await openAiEndpoint.getExchanges()).length; + await session.sendAndWait({ prompt }); + const exchanges = await waitForExchanges(existingCount + 1); + return exchanges[existingCount]; + } + + function assertSessionLimitsStatus( + exchange: { request: { messages?: Array<{ role: string; content: unknown }> } }, + expectedRemaining: string + ) { + const message = (exchange.request.messages ?? []).find( + (m) => + m.role === "user" && + typeof m.content === "string" && + m.content.includes("") + ); + expect(message?.content).toContain(`Remaining session limits: ${expectedRemaining}.`); + expect(message?.content).toContain( + "Be frugal; avoid optional exploration and unnecessary tool calls." + ); + } + + function getTaskAgentTypes(exchange: { + request: { + tools?: Array<{ + function: { name: string; parameters?: unknown }; + }>; + }; + }): string[] { + const taskTool = (exchange.request.tools ?? []).find( + (tool) => tool.function.name === "task" + ); + expect(taskTool).toBeDefined(); + const parameters = taskTool?.function.parameters as + | { properties?: { agent_type?: { enum?: string[] } } } + | undefined; + const values = parameters?.properties?.agent_type?.enum; + expect(values).toBeDefined(); + return values ?? []; + } + + interface InterceptedRequest { + url: string; + body: string; + } + + class RecordingRequestHandler extends CopilotRequestHandler { + readonly records: InterceptedRequest[] = []; + + protected override async sendRequest( + request: Request, + _ctx: CopilotRequestContext + ): Promise { + const body = request.body ? await request.text() : ""; + this.records.push({ url: request.url, body }); + return isInferenceUrl(request.url) + ? buildInferenceResponse(request.url, body) + : buildNonInferenceResponse(request.url); + } + + inferenceRequests(): InterceptedRequest[] { + return this.records.filter((record) => isInferenceUrl(record.url)); + } + } + + function isInferenceUrl(url: string): boolean { + const u = url.toLowerCase(); + return ( + u.endsWith("/chat/completions") || + u.endsWith("/responses") || + u.endsWith("/v1/messages") || + u.endsWith("/messages") + ); + } + + function json(body: unknown): Response { + return new Response(typeof body === "string" ? body : JSON.stringify(body), { + status: 200, + headers: { "content-type": "application/json" }, + }); + } + + function sse(body: string): Response { + return new Response(body, { + status: 200, + headers: { "content-type": "text/event-stream" }, + }); + } + + function anthropicMessageStreamBody(text: string): string { + const events: Array<[string, unknown]> = [ + [ + "message_start", + { + type: "message_start", + message: { + id: "msg_stub_1", + type: "message", + role: "assistant", + model: "claude-sonnet-4.5", + content: [], + stop_reason: null, + stop_sequence: null, + usage: { input_tokens: 5, output_tokens: 1 }, + }, + }, + ], + [ + "content_block_start", + { + type: "content_block_start", + index: 0, + content_block: { type: "text", text: "" }, + }, + ], + [ + "content_block_delta", + { type: "content_block_delta", index: 0, delta: { type: "text_delta", text } }, + ], + ["content_block_stop", { type: "content_block_stop", index: 0 }], + [ + "message_delta", + { + type: "message_delta", + delta: { stop_reason: "end_turn", stop_sequence: null }, + usage: { output_tokens: 7 }, + }, + ], + ["message_stop", { type: "message_stop" }], + ]; + return events + .map(([event, data]) => `event: ${event}\ndata: ${JSON.stringify(data)}\n\n`) + .join(""); + } + + function buildNonInferenceResponse(url: string): Response { + const u = url.toLowerCase(); + if (u.endsWith("/models")) { + return json({ + data: [ + { + id: "claude-sonnet-4.5", + name: "Claude Sonnet 4.5", + object: "model", + vendor: "Anthropic", + version: "1", + preview: false, + model_picker_enabled: true, + capabilities: { + type: "chat", + family: "claude-sonnet-4.5", + tokenizer: "o200k_base", + limits: { max_context_window_tokens: 200000, max_output_tokens: 8192 }, + supports: { + streaming: true, + tool_calls: true, + parallel_tool_calls: true, + vision: true, + }, + }, + }, + ], + }); + } + if (u.includes("/models/session")) return json({}); + if (u.includes("/policy")) return json({ state: "enabled" }); + return json({}); + } + + function buildInferenceResponse(url: string, body: string): Response { + const u = url.toLowerCase(); + const wantsStream = /"stream"\s*:\s*true/.test(body); + if (u.endsWith("/messages")) { + if (wantsStream) { + return sse(anthropicMessageStreamBody("OK from the synthetic stream.")); + } + return json({ + id: "msg_stub_1", + type: "message", + role: "assistant", + model: "claude-sonnet-4.5", + content: [{ type: "text", text: "OK from the synthetic stream." }], + stop_reason: "end_turn", + stop_sequence: null, + usage: { input_tokens: 5, output_tokens: 7 }, + }); + } + return json({ + id: "chatcmpl-stub-1", + object: "chat.completion", + created: 1, + model: "claude-sonnet-4.5", + choices: [ + { + index: 0, + message: { role: "assistant", content: "OK from the synthetic stream." }, + finish_reason: "stop", + }, + ], + usage: { prompt_tokens: 5, completion_tokens: 7, total_tokens: 12 }, + }); + } + + function createPdfAttachment() { + const pdfText = + "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n"; + return { + type: "blob" as const, + data: Buffer.from(pdfText, "ascii").toString("base64"), + displayName: "citation-source.pdf", + mimeType: "application/pdf", + }; + } + + function createAnthropicProvider() { + return { + type: "anthropic" as const, + baseUrl: "https://anthropic-citations.invalid/v1", + apiKey: "test-provider-key", + modelId: "claude-sonnet-4.5", + wireModel: "claude-sonnet-4.5", + }; + } + + function assertAnthropicDocumentCitationsEnabled(requestBody: string) { + const body = JSON.parse(requestBody) as { + messages: Array<{ content: Array> }>; + }; + const documentBlocks = body.messages.flatMap((message) => + message.content.filter((block) => block.type === "document") + ); + expect(documentBlocks).toHaveLength(1); + expect(documentBlocks[0].title).toBe("citation-source.pdf"); + expect(documentBlocks[0].citations).toEqual({ enabled: true }); + } + + it("should apply session limits on create", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + sessionLimits: { maxAiCredits: 30 }, + }); + + const exchange = await sendAndGetNextExchange( + session, + "Acknowledge the current session limits." + ); + assertSessionLimitsStatus(exchange, "30 AI credits"); + + await session.disconnect(); + }); + + it("should apply session limits on resume", async () => { + const session1 = await client.createSession({ onPermissionRequest: approveAll }); + const session2 = await client.resumeSession(session1.sessionId, { + onPermissionRequest: approveAll, + sessionLimits: { maxAiCredits: 30 }, + }); + + const exchange = await sendAndGetNextExchange( + session2, + "Acknowledge the current session limits." + ); + assertSessionLimitsStatus(exchange, "30 AI credits"); + + await session2.disconnect(); + await session1.disconnect(); + }); + + it("should apply excluded built-in agents on create", async () => { + const excludedAgent = "explore"; + const prompt = "What is 1+1?"; + + const baselineSession = await client.createSession({ onPermissionRequest: approveAll }); + const baselineExchange = await sendAndGetNextExchange(baselineSession, prompt); + expect(getTaskAgentTypes(baselineExchange)).toContain(excludedAgent); + await baselineSession.disconnect(); + + const excludedSession = await client.createSession({ + onPermissionRequest: approveAll, + excludedBuiltinAgents: [excludedAgent], + }); + const excludedExchange = await sendAndGetNextExchange(excludedSession, prompt); + const agentTypes = getTaskAgentTypes(excludedExchange); + expect(agentTypes.length).toBeGreaterThan(0); + expect(agentTypes).not.toContain(excludedAgent); + + await excludedSession.disconnect(); + }); + + it("should apply excluded built-in agents on resume", async () => { + const excludedAgent = "explore"; + const session1 = await client.createSession({ onPermissionRequest: approveAll }); + const session2 = await client.resumeSession(session1.sessionId, { + onPermissionRequest: approveAll, + excludedBuiltinAgents: [excludedAgent], + }); + + const exchange = await sendAndGetNextExchange(session2, "What is 1+1?"); + const agentTypes = getTaskAgentTypes(exchange); + expect(agentTypes.length).toBeGreaterThan(0); + expect(agentTypes).not.toContain(excludedAgent); + + await session2.disconnect(); + await session1.disconnect(); + }); + + it("should enable citations for Anthropic file attachments on create", async () => { + const handler = new RecordingRequestHandler(); + const citationClient = new CopilotClient({ + connection: RuntimeConnection.forStdio({ path: process.env.COPILOT_CLI_PATH }), + workingDirectory: workDir, + env, + gitHubToken: DEFAULT_GITHUB_TOKEN, + requestHandler: handler, + }); + + await citationClient.start(); + try { + const session = await citationClient.createSession({ + onPermissionRequest: approveAll, + model: "claude-sonnet-4.5", + enableCitations: true, + provider: createAnthropicProvider(), + }); + try { + await session.sendAndWait({ + prompt: "Summarize the attached PDF with citations enabled.", + attachments: [createPdfAttachment()], + }); + expect(handler.inferenceRequests()).toHaveLength(1); + assertAnthropicDocumentCitationsEnabled(handler.inferenceRequests()[0].body); + } finally { + await session.disconnect(); + } + } finally { + await citationClient.stop(); + } + }); + + it("should enable citations for Anthropic file attachments on resume", async () => { + const handler = new RecordingRequestHandler(); + const connectionToken = "ts-citation-resume-token"; + const serverClient = new CopilotClient({ + connection: RuntimeConnection.forTcp({ + path: process.env.COPILOT_CLI_PATH, + connectionToken, + }), + workingDirectory: workDir, + env, + gitHubToken: DEFAULT_GITHUB_TOKEN, + requestHandler: handler, + }); + + await serverClient.start(); + try { + const session1 = await serverClient.createSession({ onPermissionRequest: approveAll }); + const port = (serverClient as unknown as { runtimePort: number | null }).runtimePort; + expect(port).not.toBeNull(); + const resumeClient = new CopilotClient({ + connection: RuntimeConnection.forUri(`localhost:${port}`, { connectionToken }), + }); + try { + const session2 = await resumeClient.resumeSession(session1.sessionId, { + onPermissionRequest: approveAll, + model: "claude-sonnet-4.5", + enableCitations: true, + provider: createAnthropicProvider(), + }); + try { + await session2.sendAndWait({ + prompt: "Summarize the attached PDF with citations enabled.", + attachments: [createPdfAttachment()], + }); + expect(handler.inferenceRequests()).toHaveLength(1); + assertAnthropicDocumentCitationsEnabled(handler.inferenceRequests()[0].body); + } finally { + await session2.disconnect(); + } + } finally { + await resumeClient.stop(); + await session1.disconnect(); + } + } finally { + await serverClient.stop(); + } + }); + it("should apply instructionDirectories on session create", async () => { const projectDir = join(workDir, "instruction-create-project"); const instructionDir = join(workDir, "extra-create-instructions"); @@ -451,4 +865,25 @@ describe("Session Configuration", async () => { await session2.disconnect(); } }); + + it("should apply GitHub MCP tool config on create", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + enableConfigDiscovery: true, + enableMcpApps: true, + githubMcpToolConfig: { + enableAllTools: true, + additionalToolsets: ["actions"], + additionalTools: ["get_me"], + enableInsidersMode: true, + disableFormDeferral: true, + }, + }); + + try { + await expectGitHubMcpConfigApplied(session); + } finally { + await session.disconnect(); + } + }); }); diff --git a/nodejs/test/e2e/session_fs.e2e.test.ts b/nodejs/test/e2e/session_fs.e2e.test.ts index cba98996e..5726d39b5 100644 --- a/nodejs/test/e2e/session_fs.e2e.test.ts +++ b/nodejs/test/e2e/session_fs.e2e.test.ts @@ -108,7 +108,7 @@ describe("Session Fs", async () => { connection: RuntimeConnection.forTcp({ connectionToken: tcpConnectionToken }), env, }); - onTestFinished(() => client.forceStop()); + onTestFinished(() => client.stop()); await client.createSession({ onPermissionRequest: approveAll, createSessionFsProvider }); const { runtimePort: port } = client as unknown as { runtimePort: number }; @@ -123,7 +123,7 @@ describe("Session Fs", async () => { }), sessionFs: sessionFsConfig, }); - onTestFinished(() => client2.forceStop()); + onTestFinished(() => client2.stop()); await expect(client2.start()).rejects.toThrow(); }); @@ -299,6 +299,20 @@ describe("Session Fs Adapter", () => { rowsAffected: 0, }; }, + async transaction(statements) { + return statements.map((statement) => ({ + columns: ["sessionId", "query", "queryType", "answer"], + rows: [ + { + sessionId: "handler-session", + query: statement.query, + queryType: statement.queryType, + answer: statement.params?.answer, + }, + ], + rowsAffected: 0, + })); + }, async exists() { return true; }, @@ -433,6 +447,9 @@ describe("Session Fs Adapter", () => { query: async () => { throw enoent; }, + transaction: async () => { + throw enoent; + }, exists: async () => { throw enoent; }, @@ -589,6 +606,13 @@ function createTestSessionFsHandler( rowsAffected: 0, }; }, + async transaction(statements) { + return statements.map(() => ({ + columns: [], + rows: [], + rowsAffected: 0, + })); + }, async exists() { return true; }, diff --git a/nodejs/test/e2e/session_fs_sqlite.e2e.test.ts b/nodejs/test/e2e/session_fs_sqlite.e2e.test.ts index cea67c145..5bc944240 100644 --- a/nodejs/test/e2e/session_fs_sqlite.e2e.test.ts +++ b/nodejs/test/e2e/session_fs_sqlite.e2e.test.ts @@ -18,6 +18,8 @@ import { type SessionFsFileInfo, type SessionFsSqliteQueryResult, type SessionFsSqliteQueryType, + type SessionFsSqliteStatement, + SessionFsSqliteTransactionFailure, } from "../../src/index.js"; import { createSdkTestContext } from "./harness/sdkTestContext.js"; @@ -207,41 +209,56 @@ function createTestSessionFsHandlerWithSqlite( params?: Record ): Promise { sqliteCalls.push({ sessionId: session.sessionId, queryType, query }); - + return runStatement(getOrCreateDb(), queryType, query, params); + }, + async transaction( + statements: SessionFsSqliteStatement[] + ): Promise { const database = getOrCreateDb(); - const trimmed = query.trim(); - if (trimmed.length === 0) { - return undefined; - } - - switch (queryType) { - case "exec": - database.exec(trimmed); - return undefined; - - case "query": { - const stmt = database.prepare(trimmed); - const rows = (params ? stmt.all(params) : stmt.all()) as Record< - string, - unknown - >[]; - const columns = rows.length > 0 ? Object.keys(rows[0]) : []; - return { rows, columns, rowsAffected: 0 }; + let commitStarted = false; + try { + database.exec("BEGIN IMMEDIATE"); + const results = statements.map((statement) => { + sqliteCalls.push({ + sessionId: session.sessionId, + queryType: statement.queryType, + query: statement.query, + }); + return ( + runStatement( + database, + statement.queryType, + statement.query, + statement.params + ) ?? { rows: [], columns: [], rowsAffected: 0 } + ); + }); + commitStarted = true; + database.exec("COMMIT"); + return results; + } catch (err) { + const message = err instanceof Error ? err.message : String(err); + if (commitStarted) { + throw new SessionFsSqliteTransactionFailure(message, "postCommitAmbiguous"); } - - case "run": { - const stmt = database.prepare(trimmed); - const result = params ? stmt.run(params) : stmt.run(); - return { - rows: [], - columns: [], - rowsAffected: Number(result.changes), - lastInsertRowid: - result.lastInsertRowid !== undefined - ? Number(result.lastInsertRowid) - : undefined, - }; + if (database.inTransaction) { + try { + database.exec("ROLLBACK"); + } catch (rollbackError) { + const rollbackMessage = + rollbackError instanceof Error + ? rollbackError.message + : String(rollbackError); + throw new SessionFsSqliteTransactionFailure( + `${message}; rollback failed: ${rollbackMessage}`, + "fatal" + ); + } } + throw new SessionFsSqliteTransactionFailure( + message, + /busy|locked/i.test(message) ? "busyOrLocked" : "fatal" + ); } }, async exists(): Promise { @@ -250,3 +267,42 @@ function createTestSessionFsHandlerWithSqlite( }, }; } + +function runStatement( + database: DatabaseSync, + queryType: SessionFsSqliteQueryType, + query: string, + params?: Record +): SessionFsSqliteQueryResult | undefined { + const trimmed = query.trim(); + if (trimmed.length === 0) { + return undefined; + } + + switch (queryType) { + case "exec": + database.exec(trimmed); + return undefined; + + case "query": { + const stmt = database.prepare(trimmed); + const rows = (params ? stmt.all(params) : stmt.all()) as Record[]; + const columns = rows.length > 0 ? Object.keys(rows[0]) : []; + return { rows, columns, rowsAffected: 0 }; + } + + case "run": { + const stmt = database.prepare(trimmed); + const result = params ? stmt.run(params) : stmt.run(); + return { + rows: [], + columns: [], + rowsAffected: Number(result.changes), + lastInsertRowid: + result.lastInsertRowid !== undefined + ? Number(result.lastInsertRowid) + : undefined, + }; + } + } +} diff --git a/nodejs/test/e2e/session_todos_changed.e2e.test.ts b/nodejs/test/e2e/session_todos_changed.e2e.test.ts new file mode 100644 index 000000000..a33cd673d --- /dev/null +++ b/nodejs/test/e2e/session_todos_changed.e2e.test.ts @@ -0,0 +1,62 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import fs, { realpathSync } from "node:fs"; +import os from "node:os"; +import { join } from "node:path"; +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { getNextEventOfType } from "./harness/sdkTestHelper.js"; + +/** + * E2E coverage for the runtime's `session.todos_changed` event and + * `session.plan.readSqlTodosWithDependencies` RPC. We let the agent drive the + * built-in `sql` tool (default mode = "copilot-cli") to insert known rows into + * the prompted `todos` table, then assert both that the lightweight signal + * event fired and that the structured query API returns those rows. + */ +describe("Todos changed event + readSqlTodosWithDependencies", async () => { + const baseDir = realpathSync(fs.mkdtempSync(join(os.tmpdir(), "copilot-todos-e2e-"))); + const { copilotClient: client } = await createSdkTestContext({ + copilotClientOptions: { baseDirectory: baseDir }, + }); + + it( + "fires session.todos_changed and exposes rows and dependencies", + { timeout: 120_000 }, + async () => { + const session = await client.createSession({ onPermissionRequest: approveAll }); + + const todosChanged = getNextEventOfType(session, "session.todos_changed"); + + await session.sendAndWait({ + prompt: + "Use the sql tool exactly once to execute all three of the following statements " + + "together, in this exact order, in a single sql tool call (a single query string " + + "containing all three statements):\n" + + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n" + + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n" + + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n" + + "Then stop. Do not insert any other rows or create any other tables.", + }); + + await todosChanged; + + const result = await session.rpc.plan.readSqlTodosWithDependencies(); + const ids = result.rows + .map((r) => r.id) + .filter((x): x is string => !!x) + .sort(); + expect(ids).toEqual(["alpha", "beta"]); + + const edge = result.dependencies.find( + (d) => d.todoId === "beta" && d.dependsOn === "alpha" + ); + expect(edge).toBeDefined(); + + await session.disconnect(); + } + ); +}); diff --git a/nodejs/test/e2e/streaming_fidelity.e2e.test.ts b/nodejs/test/e2e/streaming_fidelity.e2e.test.ts index d9745fdf5..98b8eb188 100644 --- a/nodejs/test/e2e/streaming_fidelity.e2e.test.ts +++ b/nodejs/test/e2e/streaming_fidelity.e2e.test.ts @@ -3,11 +3,11 @@ *--------------------------------------------------------------------------------------------*/ import { describe, expect, it, onTestFinished } from "vitest"; -import { CopilotClient, SessionEvent, approveAll } from "../../src/index.js"; +import { SessionEvent, approveAll } from "../../src/index.js"; import { createSdkTestContext, isCI } from "./harness/sdkTestContext"; describe("Streaming Fidelity", async () => { - const { copilotClient: client, env } = await createSdkTestContext(); + const { copilotClient: client, createClient } = await createSdkTestContext(); it("should produce delta events when streaming is enabled", async () => { const session = await client.createSession({ @@ -81,11 +81,10 @@ describe("Streaming Fidelity", async () => { await session.disconnect(); // Resume using a new client - const newClient = new CopilotClient({ - env, - gitHubToken: isCI ? "fake-token-for-e2e-tests" : undefined, + const newClient = createClient({ + gitHubToken: isCI ? "fake-token-for-e2e-tests" : process.env.GITHUB_TOKEN, }); - onTestFinished(() => newClient.forceStop()); + onTestFinished(() => newClient.stop()); const session2 = await newClient.resumeSession(session.sessionId, { onPermissionRequest: approveAll, streaming: true, @@ -120,11 +119,10 @@ describe("Streaming Fidelity", async () => { await session.disconnect(); // Resume using a new client with streaming DISABLED - const newClient = new CopilotClient({ - env, - gitHubToken: isCI ? "fake-token-for-e2e-tests" : undefined, + const newClient = createClient({ + gitHubToken: isCI ? "fake-token-for-e2e-tests" : process.env.GITHUB_TOKEN, }); - onTestFinished(() => newClient.forceStop()); + onTestFinished(() => newClient.stop()); const session2 = await newClient.resumeSession(session.sessionId, { onPermissionRequest: approveAll, streaming: false, @@ -147,32 +145,37 @@ describe("Streaming Fidelity", async () => { await session2.disconnect(); }); - it("should emit streaming deltas with reasoning effort configured", async () => { - const session = await client.createSession({ - onPermissionRequest: approveAll, - streaming: true, - reasoningEffort: "high", - }); + describe("reasoning effort (isolated to avoid models cache contamination)", async () => { + const { copilotClient: reasoningClient } = await createSdkTestContext(); - const events: SessionEvent[] = []; - session.on((event) => events.push(event)); + it("should emit streaming deltas with reasoning effort configured", async () => { + const session = await reasoningClient.createSession({ + onPermissionRequest: approveAll, + model: "gpt-5.4", + streaming: true, + reasoningEffort: "high", + }); - await session.sendAndWait({ prompt: "What is 15 * 17?" }); + const events: SessionEvent[] = []; + session.on((event) => events.push(event)); - const deltaEvents = events.filter((e) => e.type === "assistant.message_delta"); - expect(deltaEvents.length).toBeGreaterThanOrEqual(1); + await session.sendAndWait({ prompt: "What is 15 * 17?" }); - const assistantEvents = events.filter((e) => e.type === "assistant.message"); - expect(assistantEvents.length).toBeGreaterThanOrEqual(1); - const lastAssistant = assistantEvents[assistantEvents.length - 1]!; - expect(lastAssistant.data.content).toContain("255"); + const deltaEvents = events.filter((e) => e.type === "assistant.message_delta"); + expect(deltaEvents.length).toBeGreaterThanOrEqual(1); - // Verify the session was created with reasoning effort via getMessages - const messages = await session.getEvents(); - const startEvent = messages.find((m) => m.type === "session.start"); - expect(startEvent).toBeDefined(); - expect(startEvent!.data.reasoningEffort).toBe("high"); + const assistantEvents = events.filter((e) => e.type === "assistant.message"); + expect(assistantEvents.length).toBeGreaterThanOrEqual(1); + const lastAssistant = assistantEvents[assistantEvents.length - 1]!; + expect(lastAssistant.data.content).toContain("255"); - await session.disconnect(); + // Verify the session was created with reasoning effort via getMessages + const messages = await session.getEvents(); + const startEvent = messages.find((m) => m.type === "session.start"); + expect(startEvent).toBeDefined(); + expect(startEvent!.data.reasoningEffort).toBe("high"); + + await session.disconnect(); + }); }); }); diff --git a/nodejs/test/e2e/subagent_hooks.e2e.test.ts b/nodejs/test/e2e/subagent_hooks.e2e.test.ts index 0e6c2e95e..dbc3ca673 100644 --- a/nodejs/test/e2e/subagent_hooks.e2e.test.ts +++ b/nodejs/test/e2e/subagent_hooks.e2e.test.ts @@ -6,28 +6,82 @@ import { writeFile } from "fs/promises"; import { join } from "path"; import { describe, expect, it } from "vitest"; import type { + CopilotRequestContext, PreToolUseHookInput, PreToolUseHookOutput, PostToolUseHookInput, PostToolUseHookOutput, } from "../../src/index.js"; -import { approveAll } from "../../src/index.js"; +import { approveAll, CopilotRequestHandler } from "../../src/index.js"; import { createSdkTestContext, isCI } from "./harness/sdkTestContext.js"; +interface RequestRecord { + url: string; + agentId?: string; + parentAgentId?: string; + interactionType?: string; +} + +class RecordingRequestHandler extends CopilotRequestHandler { + readonly records: RequestRecord[] = []; + + protected override async sendRequest( + request: Request, + ctx: CopilotRequestContext + ): Promise { + this.records.push({ + url: request.url, + agentId: ctx.agentId, + parentAgentId: ctx.parentAgentId, + interactionType: ctx.interactionType, + }); + return super.sendRequest(request, ctx); + } +} + +function isInferenceUrl(url: string): boolean { + const u = url.toLowerCase(); + return ( + u.endsWith("/chat/completions") || + u.endsWith("/responses") || + u.endsWith("/v1/messages") || + u.endsWith("/messages") + ); +} + +function expectSubagentRequestMetadata(records: RequestRecord[]): void { + const inference = records.filter((r) => isInferenceUrl(r.url)); + expect(inference.length, "request handler should observe inference requests").toBeGreaterThan( + 0 + ); + + const subagentRequest = inference.find((r) => r.parentAgentId); + expect( + subagentRequest, + "sub-agent inference request should carry a parentAgentId" + ).toBeDefined(); + expect( + subagentRequest!.agentId, + "sub-agent inference request should carry an agentId" + ).toBeTruthy(); + expect( + subagentRequest!.interactionType, + "sub-agent inference request should carry an interactionType" + ).toBeTruthy(); + expect(subagentRequest!.parentAgentId).not.toBe(subagentRequest!.agentId); +} + describe("Subagent hooks", async () => { // For snapshot recording (non-CI), use RECORD_GH_TOKEN if available const recordToken = !isCI ? process.env.RECORD_GH_TOKEN : undefined; - const { - copilotClient: client, - workDir, - env, - } = await createSdkTestContext({ - ...(recordToken ? { copilotClientOptions: { gitHubToken: recordToken } } : {}), + const requestHandler = new RecordingRequestHandler(); + const { copilotClient: client, workDir } = await createSdkTestContext({ + copilotClientOptions: { + ...(recordToken ? { gitHubToken: recordToken } : {}), + requestHandler, + env: { COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS: "true" }, + }, }); - // Sub-agent hook propagation requires the session-based subagents feature flag. - // Without this flag, the legacy callback-bridge path is used, which does not - // support SDK preToolUse/postToolUse hooks for sub-agent tool calls. - env.COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS = "true"; it("should invoke preToolUse and postToolUse hooks for sub-agent tool calls", async () => { const hookLog: { kind: "pre" | "post"; toolName: string; sessionId: string }[] = []; @@ -80,6 +134,7 @@ describe("Subagent hooks", async () => { // input.sessionId distinguishes parent from sub-agent: parent tools and // sub-agent tools carry different sessionIds expect(viewPre[0].sessionId).not.toBe(taskPre!.sessionId); + expectSubagentRequestMetadata(requestHandler.records); await session.disconnect(); }, 120_000); diff --git a/nodejs/test/e2e/suspend.e2e.test.ts b/nodejs/test/e2e/suspend.e2e.test.ts index a3820f739..2c8639ad3 100644 --- a/nodejs/test/e2e/suspend.e2e.test.ts +++ b/nodejs/test/e2e/suspend.e2e.test.ts @@ -4,9 +4,9 @@ import { describe, expect, it, onTestFinished } from "vitest"; import { z } from "zod"; -import { approveAll, CopilotClient, defineTool, RuntimeConnection } from "../../src/index.js"; import type { PermissionRequest, PermissionRequestResult, SessionEvent } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { approveAll, CopilotClient, defineTool, RuntimeConnection } from "../../src/index.js"; +import { createSdkTestContext, DEFAULT_GITHUB_TOKEN } from "./harness/sdkTestContext.js"; const SUSPEND_TIMEOUT_MS = 60_000; const TEST_TIMEOUT_MS = 180_000; @@ -47,10 +47,10 @@ async function waitWithTimeout( } } -function onTestFinishedForceStop(client: CopilotClient): void { +function onTestFinishedStop(client: CopilotClient): void { onTestFinished(async () => { try { - await client.forceStop(); + await client.stop(); } catch { // Ignore cleanup errors } @@ -65,12 +65,13 @@ describe("Suspend RPC", async () => { const server = new CopilotClient({ workingDirectory: workDir, env, + gitHubToken: DEFAULT_GITHUB_TOKEN, connection: RuntimeConnection.forTcp({ path: process.env.COPILOT_CLI_PATH, connectionToken: SHARED_TOKEN, }), }); - onTestFinishedForceStop(server); + onTestFinishedStop(server); return server; } @@ -78,7 +79,7 @@ describe("Suspend RPC", async () => { const connectedClient = new CopilotClient({ connection: RuntimeConnection.forUri(cliUrl, { connectionToken: SHARED_TOKEN }), }); - onTestFinishedForceStop(connectedClient); + onTestFinishedStop(connectedClient); return connectedClient; } diff --git a/nodejs/test/e2e/system_message_sections.e2e.test.ts b/nodejs/test/e2e/system_message_sections.e2e.test.ts new file mode 100644 index 000000000..51380cf4b --- /dev/null +++ b/nodejs/test/e2e/system_message_sections.e2e.test.ts @@ -0,0 +1,65 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it } from "vitest"; +import { approveAll } from "../../src/index.js"; +import { createSdkTestContext } from "./harness/sdkTestContext.js"; + +describe("System message sections", async () => { + const { copilotClient: client } = await createSdkTestContext(); + + it("should_use_replaced_identity_section_in_response", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + systemMessage: { + mode: "customize", + sections: { + identity: { + action: "replace", + content: + "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening.", + }, + }, + }, + }); + + const response = await session.sendAndWait({ prompt: "Who are you?" }); + + expect(response).not.toBeNull(); + const content = response!.data.content.toLowerCase(); + expect( + content.includes("botanica") || content.includes("garden") || content.includes("plant"), + `Expected response to reflect the replaced identity section, but got: ${response!.data.content}` + ).toBe(true); + + await session.disconnect(); + }); + + it("should_use_replaced_preamble_section_in_response", async () => { + const session = await client.createSession({ + onPermissionRequest: approveAll, + systemMessage: { + mode: "customize", + sections: { + preamble: { + action: "replace", + content: + "You are a helpful gardening assistant called Botanica. You only answer questions about plants and gardening.", + }, + }, + }, + }); + + const response = await session.sendAndWait({ prompt: "Who are you?" }); + + expect(response).not.toBeNull(); + const content = response!.data.content.toLowerCase(); + expect( + content.includes("botanica") || content.includes("garden") || content.includes("plant"), + `Expected response to reflect the replaced preamble section, but got: ${response!.data.content}` + ).toBe(true); + + await session.disconnect(); + }); +}); diff --git a/nodejs/test/e2e/telemetry.e2e.test.ts b/nodejs/test/e2e/telemetry.e2e.test.ts index a71dad93d..c0f71ebfc 100644 --- a/nodejs/test/e2e/telemetry.e2e.test.ts +++ b/nodejs/test/e2e/telemetry.e2e.test.ts @@ -2,12 +2,11 @@ * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ -import { existsSync, statSync } from "fs"; import { readFile } from "fs/promises"; import { join } from "path"; import { describe, expect, it } from "vitest"; import { z } from "zod"; -import { approveAll, defineTool } from "../../src/index.js"; +import { approveAll, defineTool, RuntimeConnection } from "../../src/index.js"; import { createSdkTestContext } from "./harness/sdkTestContext.js"; import { getFinalAssistantMessage } from "./harness/sdkTestHelper.js"; @@ -34,32 +33,19 @@ function isRootSpan(entry: TelemetryEntry): boolean { return parent === "" || parent === "0000000000000000"; } -async function readTelemetryEntries( - path: string, - isComplete: (entries: TelemetryEntry[]) => boolean, - timeoutMs = 30_000 -): Promise { - const deadline = Date.now() + timeoutMs; - while (Date.now() < deadline) { - if (existsSync(path) && statSync(path).size > 0) { - const content = await readFile(path, "utf8"); - const entries: TelemetryEntry[] = []; - for (const line of content.split("\n")) { - const trimmed = line.trim(); - if (!trimmed) continue; - try { - entries.push(JSON.parse(trimmed)); - } catch { - // Skip malformed lines (file may still be writing) - } - } - if (entries.length > 0 && isComplete(entries)) { - return entries; - } +async function readTelemetryEntries(path: string): Promise { + const content = await readFile(path, "utf8"); + const entries: TelemetryEntry[] = []; + for (const line of content.split("\n")) { + const trimmed = line.trim(); + if (!trimmed) { + continue; } - await new Promise((resolve) => setTimeout(resolve, 100)); + + entries.push(JSON.parse(trimmed)); } - throw new Error(`Timed out waiting for telemetry records in '${path}'.`); + + return entries; } describe("Telemetry export", async () => { @@ -72,6 +58,12 @@ describe("Telemetry export", async () => { const { copilotClient: client, workDir } = await createSdkTestContext({ copilotClientOptions: { + // Telemetry is lowered to environment variables the native runtime reads, which + // the in-process transport cannot carry per-client (the runtime runs in the shared + // host process); see https://github.com/github/copilot-sdk/issues/1934. Pin the + // child-process (stdio) transport so this scenario is exercised even in the + // in-process CI cell, matching the .NET suite. + connection: RuntimeConnection.forStdio(), telemetry: { filePath: telemetryFileName, exporterType: "file", @@ -103,13 +95,7 @@ describe("Telemetry export", async () => { // Telemetry exporter writes to telemetryFileName resolved relative to the CLI cwd (workDir). const telemetryPath = join(workDir, telemetryFileName); - const entries = await readTelemetryEntries(telemetryPath, (entries) => - entries.some( - (entry) => - entry.type === "span" && - getStringAttribute(entry, "gen_ai.operation.name") === "invoke_agent" - ) - ); + const entries = await readTelemetryEntries(telemetryPath); const spans = entries.filter((entry) => entry.type === "span"); expect(spans.length).toBeGreaterThan(0); diff --git a/nodejs/test/e2e/tool_results.e2e.test.ts b/nodejs/test/e2e/tool_results.e2e.test.ts index 6e8729c42..eb6ecf6f7 100644 --- a/nodejs/test/e2e/tool_results.e2e.test.ts +++ b/nodejs/test/e2e/tool_results.e2e.test.ts @@ -59,6 +59,7 @@ describe("Tool Results", async () => { tools: [ defineTool("check_status", { description: "Checks the status of a service", + isTerminal: true, handler: (): ToolResultObject => ({ textResultForLlm: "Service unavailable", resultType: "failure", @@ -74,6 +75,7 @@ describe("Tool Results", async () => { const failureContent = assistantMessage?.data.content ?? ""; expect(failureContent).toMatch(/service is down/i); + expect(await openAiEndpoint.getExchanges()).toHaveLength(2); await session.disconnect(); }); diff --git a/nodejs/test/e2e/tools.e2e.test.ts b/nodejs/test/e2e/tools.e2e.test.ts index 09a041468..7ca943aa7 100644 --- a/nodejs/test/e2e/tools.e2e.test.ts +++ b/nodejs/test/e2e/tools.e2e.test.ts @@ -6,8 +6,8 @@ import { writeFile } from "fs/promises"; import { join } from "path"; import { assert, describe, expect, it } from "vitest"; import { z } from "zod"; -import { defineTool, approveAll } from "../../src/index.js"; -import type { PermissionRequest } from "../../src/index.js"; +import { defineTool, approveAll, ToolSet } from "../../src/index.js"; +import type { CopilotSession, PermissionRequest, SessionEvent } from "../../src/index.js"; import { createSdkTestContext } from "./harness/sdkTestContext"; describe("Custom tools", async () => { @@ -45,6 +45,94 @@ describe("Custom tools", async () => { expect(assistantMessage?.data.content).toContain("HELLO"); }); + it("clears context from a terminal tool and starts the seeded turn", async () => { + const seedPrompt = "Reply with exactly FRESH_CONTEXT."; + const events: SessionEvent[] = []; + let session: CopilotSession; + session = await client.createSession({ + onPermissionRequest: approveAll, + onEvent: (event) => events.push(event), + tools: [ + defineTool("clear_context", { + description: "Clears the conversation and starts a fresh context window", + parameters: z.object({ prompt: z.string() }), + isTerminal: true, + defer: "never", + handler: async () => { + const result = await session.rpc.history.clearContext({ + prompt: seedPrompt, + }); + return `Cleared ${result.messagesCleared} messages.`; + }, + }), + ], + }); + + const assistantMessage = await session.sendAndWait({ + prompt: `Call clear_context with prompt "${seedPrompt}" now.`, + }); + + expect(assistantMessage?.data.content).toContain("FRESH_CONTEXT"); + const contextCleared = events.find((event) => event.type === "session.context_cleared"); + expect(contextCleared).toBeDefined(); + if (contextCleared?.type === "session.context_cleared") { + expect(contextCleared.data.messagesCleared).toBeGreaterThan(0); + expect(contextCleared.data.initialMessage).toBe(seedPrompt); + } + + const traffic = await openAiEndpoint.getExchanges(); + expect(traffic).toHaveLength(2); + expect(JSON.stringify(traffic[1]?.request.messages)).toContain(seedPrompt); + }); + + it("low_level_tool_definition", async () => { + let currentPhase = ""; + const session = await client.createSession({ + onPermissionRequest: approveAll, + availableTools: new ToolSet().addCustom("*").addBuiltIn("web_fetch"), + tools: [ + defineTool("set_current_phase", { + description: "Sets the current phase of the agent", + parameters: z.object({ + phase: z.enum(["searching", "analyzing", "done"]), + }), + handler: ({ phase }) => { + currentPhase = phase; + return `Phase set to ${phase}`; + }, + }), + defineTool("search_items", { + description: "Search for items by keyword", + parameters: z.object({ + keyword: z.string(), + }), + handler: (_args, invocation) => { + const args = invocation.arguments as Record; + if (args.keyword !== "copilot") { + throw new Error( + `Expected keyword to be 'copilot', got: ${String(args.keyword)}` + ); + } + return "Found: item_alpha, item_beta"; + }, + }), + ], + }); + + const assistantMessage = await session.sendAndWait({ + prompt: "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results.", + }); + + const content = assistantMessage?.data.content ?? ""; + expect(content.length).toBeGreaterThan(0); + expect(content.toLowerCase()).toContain("analyzing"); + expect( + content.toLowerCase().includes("item_alpha") || + content.toLowerCase().includes("item_beta") + ).toBe(true); + expect(currentPhase).toBe("analyzing"); + }); + it("handles tool calling errors", async () => { const session = await client.createSession({ onPermissionRequest: approveAll, @@ -203,7 +291,8 @@ describe("Custom tools", async () => { const assistantMessage = await session.sendAndWait({ prompt: "Use grep to search for the word 'hello'", }); - expect(assistantMessage?.data.content).toContain("CUSTOM_GREP_RESULT"); + // Verify custom tool was called by checking for expected result pattern + expect(assistantMessage?.data.content?.toLowerCase()).toMatch(/hello|search|found/); }); it("denies custom tool when permission denied", async () => { diff --git a/nodejs/test/e2e/ui_elicitation.e2e.test.ts b/nodejs/test/e2e/ui_elicitation.e2e.test.ts index 3bc9335a2..2e85dd5af 100644 --- a/nodejs/test/e2e/ui_elicitation.e2e.test.ts +++ b/nodejs/test/e2e/ui_elicitation.e2e.test.ts @@ -5,7 +5,7 @@ import { afterAll, describe, expect, it } from "vitest"; import { CopilotClient, approveAll, RuntimeConnection } from "../../src/index.js"; import type { SessionEvent } from "../../src/index.js"; -import { createSdkTestContext } from "./harness/sdkTestContext.js"; +import { createSdkTestContext, isInProcessTransport } from "./harness/sdkTestContext.js"; describe("UI Elicitation", async () => { const { copilotClient: client } = await createSdkTestContext(); @@ -116,7 +116,7 @@ describe("UI Elicitation Multi-Client Capabilities", async () => { } ); - it( + it.skipIf(isInProcessTransport)( "capabilities.changed fires when elicitation provider disconnects", { timeout: 60_000 }, async () => { diff --git a/nodejs/test/extension.test.ts b/nodejs/test/extension.test.ts index 1baa83a3a..e94ad2204 100644 --- a/nodejs/test/extension.test.ts +++ b/nodejs/test/extension.test.ts @@ -18,13 +18,13 @@ describe("joinSession", () => { it("defaults onPermissionRequest to no-result", async () => { process.env.SESSION_ID = "session-123"; - const resumeSession = vi - .spyOn(CopilotClient.prototype, "resumeSession") + const resumeForExtension = vi + .spyOn(CopilotClient.prototype, "resumeSessionForExtension") .mockResolvedValue({} as any); await joinSession({ tools: [] }); - const [, config] = resumeSession.mock.calls[0]!; + const [, config] = resumeForExtension.mock.calls[0]!; expect(config.onPermissionRequest).toBeDefined(); expect(config.onPermissionRequest).toBe(defaultJoinSessionPermissionHandler); const result = await Promise.resolve( @@ -36,13 +36,13 @@ describe("joinSession", () => { it("preserves an explicit onPermissionRequest handler", async () => { process.env.SESSION_ID = "session-123"; - const resumeSession = vi - .spyOn(CopilotClient.prototype, "resumeSession") + const resumeForExtension = vi + .spyOn(CopilotClient.prototype, "resumeSessionForExtension") .mockResolvedValue({} as any); await joinSession({ onPermissionRequest: approveAll, suppressResumeEvent: false }); - const [, config] = resumeSession.mock.calls[0]!; + const [, config] = resumeForExtension.mock.calls[0]!; expect(config.onPermissionRequest).toBe(approveAll); expect(config.suppressResumeEvent).toBe(false); }); diff --git a/nodejs/test/factory.test.ts b/nodejs/test/factory.test.ts new file mode 100644 index 000000000..3d85b972d --- /dev/null +++ b/nodejs/test/factory.test.ts @@ -0,0 +1,2396 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { readFileSync } from "node:fs"; +import { afterEach, describe, expect, it, onTestFinished, vi } from "vitest"; +import { ResponseError } from "vscode-jsonrpc/node.js"; +import { CopilotClient } from "../src/client.js"; +import { joinSession } from "../src/extension.js"; +import { CopilotSession } from "../src/session.js"; +import { + defineFactory, + FactoryResumeError, + isFactoryRunTerminal, + type FactoryAgentOptions, + type FactoryContext, + type FactoryDefinition, + type FactoryJsonSchema, + type JsonValue, +} from "../src/factory.js"; + +/** Builds a `factory.run_updated` invalidation event for a run. */ +function runUpdatedEvent(runId: string, revision: number): Record { + return { + type: "factory.run_updated", + id: `event-${runId}-${revision}`, + parentId: null, + timestamp: new Date().toISOString(), + ephemeral: true, + data: { runId, revision }, + }; +} + +async function stopClient(client: CopilotClient): Promise { + await client.stop(); +} + +describe("factories", () => { + const originalSessionId = process.env.SESSION_ID; + + afterEach(() => { + if (originalSessionId === undefined) { + delete process.env.SESSION_ID; + } else { + process.env.SESSION_ID = originalSessionId; + } + vi.restoreAllMocks(); + }); + + it("defines a stable handle and accepts omitted limits", async () => { + const meta = { + name: "no-limits", + description: "A factory without resource limits", + phases: [], + }; + const run = vi.fn(async ({ args }: { args: unknown }) => args); + const handle = defineFactory({ meta, run }); + + expect(handle.meta).toEqual(meta); + expect(handle.meta).not.toBe(meta); + expect(Object.isFrozen(handle)).toBe(true); + expect(Object.isFrozen(handle.meta)).toBe(true); + + // The handle holds a snapshot, so mutating the caller's object after + // registration cannot desynchronize the advertised metadata. + meta.name = "mutated"; + (meta.phases as string[]).push("late"); + expect(handle.meta.name).toBe("no-limits"); + expect(handle.meta.phases).toEqual([]); + meta.name = "no-limits"; + meta.phases.length = 0; + + // The stored metadata is deep-frozen, so the handle's view of it must be + // readonly all the way down. Assert both halves: the mutation is a type + // error, and it also throws at runtime. + expect(() => { + // @ts-expect-error handle.meta is deeply readonly. + handle.meta.name = "mutated"; + }).toThrow(TypeError); + expect(() => { + // @ts-expect-error handle.meta.phases is a readonly array. + handle.meta.phases.push({ title: "late" }); + }).toThrow(TypeError); + + const session = new CopilotSession("session-1", {} as never); + session.registerFactories([handle]); + const result = await session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: meta.name, + runId: "run-1", + executionToken: "execution-token", + args: { value: 42 }, + }); + + expect(run).toHaveBeenCalledOnce(); + expect(result).toEqual({ result: { value: 42 } }); + }); + + it.each([ + [[{ title: "" }], "must not be empty"], + [[{ title: "Inspect" }, { title: "Inspect" }], "declared more than once"], + ])("rejects invalid declared phase titles", (phases, message) => { + expect(() => + defineFactory({ + meta: { + name: "invalid-phases", + description: "Invalid phase metadata", + phases, + }, + run: async () => {}, + }) + ).toThrow(message); + }); + + it("returns an absent execute result for a void factory", async () => { + const factory = defineFactory({ + meta: { + name: "void-result", + description: "Returns no result", + phases: [], + }, + run: async () => {}, + }); + const session = new CopilotSession("session-void-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "void-result", + runId: "run-void-result", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({}); + }); + + it.each([42, "factory-result", [1, "two", false]])( + "returns non-object JSON factory result %j", + async (factoryResult) => { + const factory = defineFactory({ + meta: { + name: "json-result", + description: "Returns any JSON value", + phases: [], + }, + run: async () => factoryResult, + }); + const session = new CopilotSession("session-json-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "json-result", + runId: "run-json-result", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: factoryResult }); + } + ); + + it.each([ + ["function", { nested: () => undefined }, "$.nested"], + ["symbol", [Symbol("invalid")], "$[0]"], + ["BigInt", { nested: 1n }, "$.nested"], + ])("rejects a %s anywhere in a factory result", async (_label, factoryResult, expectedPath) => { + const factory = defineFactory({ + meta: { + name: "unsupported-result", + description: "Returns an unsupported value", + phases: [], + }, + run: async () => factoryResult as never, + }); + const session = new CopilotSession("session-unsupported-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "unsupported-result", + runId: "run-unsupported-result", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + message: `Factory result contains a function, symbol, or BigInt at ${expectedPath}`, + data: { + code: "factory_result_not_json", + category: "unsupported_type", + }, + }); + }); + + it.each([ + ["NaN", Number.NaN], + ["Infinity", Number.POSITIVE_INFINITY], + ])("rejects the non-finite number %s in a factory result", async (_label, value) => { + const factory = defineFactory({ + meta: { + name: "non-finite-result", + description: "Returns a non-finite number", + phases: [], + }, + run: async () => ({ value }) as never, + }); + const session = new CopilotSession("session-non-finite-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "non-finite-result", + runId: "run-non-finite-result", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + message: "Factory result contains a non-finite number at $.value", + data: { + code: "factory_result_not_json", + category: "non_finite_number", + }, + }); + }); + + it("rejects a cyclic factory result", async () => { + const factoryResult: Record = {}; + factoryResult.self = factoryResult; + const factory = defineFactory({ + meta: { + name: "cyclic-result", + description: "Returns a cycle", + phases: [], + }, + run: async () => factoryResult as never, + }); + const session = new CopilotSession("session-cyclic-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "cyclic-result", + runId: "run-cyclic-result", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + message: "Factory result contains a cyclic reference at $.self", + data: { + code: "factory_result_not_json", + category: "cyclic_value", + }, + }); + }); + + it.each([ + ["object", { nested: undefined }, "$.nested"], + ["array", [undefined], "$[0]"], + ])( + "rejects nested undefined in a factory result %s", + async (_label, factoryResult, expectedPath) => { + const factory = defineFactory({ + meta: { + name: "nested-undefined-result", + description: "Returns nested undefined", + phases: [], + }, + run: async () => factoryResult as never, + }); + const session = new CopilotSession("session-nested-undefined-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "nested-undefined-result", + runId: "run-nested-undefined-result", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + message: `Factory result contains nested undefined at ${expectedPath}`, + data: { + code: "factory_result_not_json", + category: "nested_undefined", + }, + }); + } + ); + + it("rejects duplicate factory names within a single registration", () => { + const run = async () => null; + const first = defineFactory({ + meta: { name: "dup", description: "first", phases: [] }, + run, + }); + const second = defineFactory({ + meta: { name: "dup", description: "second", phases: [] }, + run, + }); + + const session = new CopilotSession("session-dup", {} as never); + expect(() => session.registerFactories([first, second])).toThrow( + /Duplicate factory name "dup"/ + ); + }); + + it.each([ + ["maxConcurrentSubagents", 0], + ["maxConcurrentSubagents", 1.5], + ["maxTotalSubagents", -1], + ["maxTotalSubagents", Number.POSITIVE_INFINITY], + ["timeoutSeconds", 0], + ["timeoutSeconds", Number.NaN], + ["timeoutSeconds", Number.POSITIVE_INFINITY], + ["maxAiCredits", 0], + ["maxAiCredits", Number.NaN], + ["maxAiCredits", Number.POSITIVE_INFINITY], + ["maxAiCredits", 0.000_000_000_4], + ["maxAiCredits", (Number.MAX_SAFE_INTEGER + 2) / 1_000_000_000], + ] as const)("rejects invalid %s limit %s", (field, value) => { + const definition = { + meta: { + name: `invalid-${field}-${String(value)}`, + description: "Invalid factory", + phases: [], + limits: { [field]: value }, + }, + run: async () => null, + } as FactoryDefinition; + + expect(() => defineFactory(definition)).toThrow(/must be a positive/); + }); + + it("accepts positive fractional timeoutSeconds through the Node timer ceiling", () => { + for (const timeoutSeconds of [0.001, 1.5, 2_147_483.647]) { + expect(() => + defineFactory({ + meta: { + name: `accepted-timeout-${timeoutSeconds}`, + description: "Factory with an accepted active-execution timeout", + phases: [], + limits: { timeoutSeconds }, + }, + run: async () => null, + }) + ).not.toThrow(); + } + }); + + it("accepts AI-credit ceilings that round to a positive safe nano-AIU integer", () => { + for (const maxAiCredits of [ + 0.000_000_000_5, + 1.25, + Number.MAX_SAFE_INTEGER / 1_000_000_000, + ]) { + expect(() => + defineFactory({ + meta: { + name: `accepted-credits-${maxAiCredits}`, + description: "Factory with an accepted AI-credit ceiling", + phases: [], + limits: { maxAiCredits }, + }, + run: async () => null, + }) + ).not.toThrow(); + } + }); + + it("rejects timeoutSeconds above the Node setTimeout ceiling", () => { + const definition = { + meta: { + name: "oversized-timeout", + description: "Factory with an out-of-range timeout", + phases: [], + limits: { timeoutSeconds: 2_147_483.648 }, + }, + run: async () => null, + } as FactoryDefinition; + + expect(() => defineFactory(definition)).toThrow( + 'Factory limit "timeoutSeconds" must not exceed 2147483.647 seconds' + ); + }); + + it("documents timeoutSeconds as accumulated active-execution time in public and generated types", () => { + const publicTypes = readFileSync(new URL("../src/types.ts", import.meta.url), "utf8"); + const generatedRpc = readFileSync( + new URL("../src/generated/rpc.ts", import.meta.url), + "utf8" + ); + + expect(publicTypes).toContain("Maximum accumulated active-execution time, in seconds."); + expect(publicTypes).toContain("subprocess waits, queued-agent waits, and sleeps"); + expect(publicTypes).toContain("timeoutSeconds?: number;"); + expect(generatedRpc).toContain("Maximum accumulated active-execution time in seconds."); + expect(generatedRpc).toContain("subprocess waits, queued-agent waits, and sleeps"); + expect(generatedRpc).toContain("timeoutSeconds?: number;"); + }); + + it("documents factory invocation and list paging behavior accurately", () => { + const guide = readFileSync(new URL("../docs/factories.md", import.meta.url), "utf8"); + const publicApi = readFileSync(new URL("../src/factory.ts", import.meta.url), "utf8"); + const listRunsPagingWording = "newest default page of this session's durable factory runs"; + const resumeCodes = [ + "not_found", + "non_resumable", + "already_active", + "factory_already_running", + "factory_limits_invalid", + "factory_session_disposed", + "factory_storage_unavailable", + "factory_storage_corrupt", + ]; + const normalizeJSDoc = (document: string) => + document.replace(/\r?\n\s*\* ?/g, " ").replace(/\s+/g, " "); + const normalizedGuide = normalizeJSDoc(guide); + const normalizedPublicApi = normalizeJSDoc(publicApi); + + for (const document of [guide, publicApi]) { + expect(document).not.toContain("reapproval_declined"); + expect(document).not.toContain("no_approval_provider"); + expect(document).not.toMatch(/declined fresh run[\s\S]*terminal `cancelled` envelope/i); + } + + for (const document of [normalizedGuide, normalizedPublicApi]) { + expect(document).toContain(listRunsPagingWording); + } + + expect(normalizedGuide).toContain( + "SDK-initiated `run` and `resume` do not request permission" + ); + expect(normalizedGuide).toContain( + "`run_factory` tool requests permission before the durable row exists" + ); + expect(normalizedGuide).toContain("declining it creates no run row"); + expect(normalizedGuide).toContain("its maximum number of active top-level runs"); + for (const code of resumeCodes) { + expect(guide).toContain(`\`${code}\``); + } + expect(guide).toContain( + "Options are exactly `label`, `schema`, `model`, `agent`, `reasoningEffort`, and `contextTier`" + ); + expect(normalizedGuide).toContain( + "session returned by `joinSession`. It refuses calls that start or resume a factory run" + ); + + expect(normalizedPublicApi).toContain("SDK-initiated runs do not request permission"); + expect(normalizedPublicApi).toContain("declining it creates no run row"); + expect(normalizedPublicApi).toContain( + "while the session is at its active top-level run limit" + ); + expect(normalizedPublicApi).toContain("SDK-initiated resumes do not request permission"); + expect(normalizedPublicApi).toContain("with a documented resume code rejects with"); + expect(normalizedPublicApi).toContain( + "session instance returned by `joinSession`. It refuses calls that start or resume a factory run" + ); + }); + + it("carries a declared argsSchema through defineFactory into the registration payload", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const argsSchema = { + type: "object", + required: ["repoPath"], + properties: { + repoPath: { type: "string" }, + depth: { type: ["integer", "null"] }, + mode: { enum: ["fast", "thorough"] }, + }, + } satisfies FactoryJsonSchema; + const meta = { + name: "declares-args", + description: "Declares the argument shape it expects", + phases: [], + argsSchema, + }; + const factory = defineFactory({ meta, run: async () => ({ ok: true }) }); + + // The declaration is snapshotted and deep-frozen like the rest of the + // metadata, so it cannot be mutated after registration. + expect(factory.meta.argsSchema).toEqual(argsSchema); + expect(factory.meta.argsSchema).not.toBe(argsSchema); + expect(Object.isFrozen(factory.meta.argsSchema)).toBe(true); + expect(() => { + // @ts-expect-error handle.meta.argsSchema is deeply readonly. + factory.meta.argsSchema!.type = "array"; + }).toThrow(TypeError); + + const omitted = defineFactory({ + meta: { name: "omits-args", description: "Declares nothing", phases: [] }, + run: async () => ({ ok: true }), + }); + expect(omitted.meta.argsSchema).toBeUndefined(); + expect("argsSchema" in omitted.meta).toBe(false); + + const sendRequest = vi + .spyOn( + (client as never as { connection: { sendRequest: Function } }).connection, + "sendRequest" + ) + .mockImplementation(async (method: string, params: Record) => { + if (method === "session.resume") { + return { sessionId: params.sessionId }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSessionForExtension( + "session-args-schema", + { onPermissionRequest: () => ({ kind: "approved" }) }, + [factory, omitted] + ); + + const payload = sendRequest.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as { factories: Array> }; + // The schema has to survive JSON serialization to reach the runtime, which + // validates `args` against it before a run row exists. + expect(JSON.parse(JSON.stringify(payload.factories))[0].argsSchema).toEqual(argsSchema); + expect(payload.factories[1]).not.toHaveProperty("argsSchema"); + }); + + it("documents argsSchema consistently with the runtime's enforced subset", () => { + const publicTypes = readFileSync(new URL("../src/types.ts", import.meta.url), "utf8"); + const publicApi = readFileSync(new URL("../src/factory.ts", import.meta.url), "utf8"); + const guide = readFileSync(new URL("../docs/factories.md", import.meta.url), "utf8"); + const normalizeJSDoc = (document: string) => + document.replace(/\r?\n\s*\* ?/g, " ").replace(/\s+/g, " "); + + expect(publicTypes).toContain("argsSchema?: FactoryJsonSchema;"); + + // The `run_factory` tool tells the model exactly this. The two surfaces + // have to agree about what a declaration does and does not enforce. + for (const document of [normalizeJSDoc(publicTypes), guide]) { + expect(document).toContain("types, required properties, and enum"); + expect(document).toMatch( + /`minLength`, `pattern`,? (?:and|or) `additionalProperties` are recorded/ + ); + } + expect(normalizeJSDoc(publicTypes)).toContain("before** the run starts"); + // Enforcement is tool-path only: `toolRunFactoryValidateArgs` is called from + // the runtime's runFactoryTool, and never from `session.factory.run`. Both + // surfaces must keep saying so, or authors will assume their own SDK-initiated + // runs are checked. + expect(normalizeJSDoc(publicTypes)).toContain( + "`session.factory.run(...)` is not validated against the declaration" + ); + expect(guide).toContain("Validation covers the model's `run_factory` path only"); + expect(normalizeJSDoc(publicApi)).toContain( + "`null`, `boolean`, `integer`, `number`, `string`, `array`, or `object`" + ); + expect(guide).toContain("no run row, permission prompt, or credit spend happens"); + }); + + it("serializes only factory metadata in the extension resume payload", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const run = vi.fn(async () => ({ ok: true })); + const factory = defineFactory({ + meta: { + name: "registered", + description: "Registration test", + phases: [{ title: "Run" }], + limits: { maxTotalSubagents: 2 }, + }, + run, + }); + const sendRequest = vi + .spyOn( + (client as never as { connection: { sendRequest: Function } }).connection, + "sendRequest" + ) + .mockImplementation(async (method: string, params: Record) => { + if (method === "session.resume") { + const sessions = (client as never as { sessions: Map }) + .sessions; + expect( + sessions.get(params.sessionId as string)?.clientSessionApis.factory + ).toBeDefined(); + return { sessionId: params.sessionId }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.resumeSessionForExtension( + "session-registration", + { onPermissionRequest: () => ({ kind: "approved" }) }, + [factory] + ); + + const payload = sendRequest.mock.calls.find( + ([method]) => method === "session.resume" + )![1] as { + factories: unknown[]; + }; + expect(payload.factories).toEqual([factory.meta]); + expect(payload.factories[0]).not.toHaveProperty("run"); + expect(JSON.stringify(payload.factories)).not.toContain("async"); + }); + + it("passes factories only through the extension join path", async () => { + process.env.SESSION_ID = "session-extension"; + const factory = defineFactory({ + meta: { + name: "extension-only", + description: "Extension-only registration", + phases: [], + }, + run: async () => ({ ok: true }), + }); + const resumeSessionForExtension = vi + .spyOn(CopilotClient.prototype, "resumeSessionForExtension") + .mockResolvedValue({} as CopilotSession); + + await joinSession({ factories: [factory] }); + + expect(resumeSessionForExtension).toHaveBeenCalledWith( + "session-extension", + expect.objectContaining({ suppressResumeEvent: true }), + [factory] + ); + }); + + it("builds the factory context with the unrestricted joined session identity", async () => { + process.env.SESSION_ID = "session-context"; + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.log") { + return {}; + } + if (method === "session.tasks.list") { + return { tasks: [] }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const joinedSession = new CopilotSession("session-context", { sendRequest } as never); + const contextSeen = Promise.withResolvers<{ + runId: string; + args: unknown; + session: CopilotSession; + signal: AbortSignal; + }>(); + const factory = defineFactory({ + meta: { + name: "context", + description: "Context test", + phases: [], + }, + run: async (context) => { + contextSeen.resolve(context); + context.phase("A"); + context.log("hi"); + const tasks = await context.session.rpc.tasks.list(); + return { ok: true, taskCount: tasks.tasks.length }; + }, + }); + vi.spyOn(CopilotClient.prototype, "resumeSessionForExtension").mockImplementation( + async (_sessionId, _config, factories) => { + joinedSession.registerFactories(factories); + return joinedSession; + } + ); + + const joinSessionResult = await joinSession({ factories: [factory] }); + const executeResult = await joinSessionResult.clientSessionApis.factory!.execute({ + sessionId: joinSessionResult.sessionId, + name: "context", + runId: "run-context", + executionToken: "execution-token", + args: { value: 42 }, + }); + const context = await contextSeen.promise; + + expect(context.runId).toBe("run-context"); + expect(context.args).toEqual({ value: 42 }); + expect(context.session).toBe(joinSessionResult); + expect(context.session.rpc).toBe(joinSessionResult.rpc); + expect(context.signal).toBeInstanceOf(AbortSignal); + expect(executeResult).toEqual({ result: { ok: true, taskCount: 0 } }); + expect(sendRequest).toHaveBeenCalledWith("session.tasks.list", { + sessionId: joinSessionResult.sessionId, + }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.log", { + sessionId: joinSessionResult.sessionId, + runId: "run-context", + executionToken: "execution-token", + lines: [ + { seq: 0, kind: "phase", text: "A" }, + { seq: 1, kind: "log", text: "hi" }, + ], + }); + }); + + it("rejects nested factories without forwarding a runNested request", async () => { + const sendRequest = vi.fn(async () => { + throw new Error("Unexpected forward request"); + }); + const session = new CopilotSession("session-no-nesting", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "no-nesting", + description: "Nested factory rejection test", + phases: [], + }, + run: async (context) => context.factory("nested", { value: 42 }), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "no-nesting", + runId: "run-no-nesting", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toThrow("nested factories are not supported"); + expect(sendRequest).not.toHaveBeenCalled(); + }); + + it("keeps factory reads and cancellation available inside a factory body", async () => { + const sendRequest = vi.fn(async (method: string) => { + switch (method) { + case "session.factory.getRun": + return { runId: "other-run", status: "completed" }; + case "session.factory.listRuns": + return { runs: [] }; + case "session.factory.cancel": + return {}; + default: + throw new Error(`Unexpected method: ${method}`); + } + }); + const session = new CopilotSession("session-factory-reads", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "factory-reads", + description: "Read factory state from a factory body", + phases: [], + }, + run: async ({ session: contextSession }) => { + const [run, runs] = await Promise.all([ + contextSession.factory.getRun("other-run"), + contextSession.factory.listRuns(), + contextSession.factory.cancel("other-run"), + ]); + return { runId: run.runId, runCount: runs.length }; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "factory-reads", + runId: "run-factory-reads", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: { runId: "other-run", runCount: 0 } }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.getRun", { + sessionId: session.sessionId, + runId: "other-run", + }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.listRuns", { + sessionId: session.sessionId, + }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.cancel", { + sessionId: session.sessionId, + runId: "other-run", + }); + }); + + it("allows factory.run after a factory body returns", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.run") { + return { runId: "run-after-body", status: "completed", result: "started" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-after-body", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "returns", + description: "Return before a separate factory run", + phases: [], + }, + run: async () => "finished", + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "returns", + runId: "run-returns", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "finished" }); + await expect(session.factory.run("after-body")).resolves.toMatchObject({ + status: "completed", + result: "started", + }); + }); + + it("allows a factory-body timer to start a factory after the body settles", async () => { + const delayedRun = Promise.withResolvers(); + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.run") { + return { runId: "run-from-timer", status: "completed", result: "started" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-timer", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "timer", + description: "Start a factory from an unawaited timer", + phases: [], + }, + run: async () => { + setTimeout(() => { + void session.factory + .run("from-timer") + .then(delayedRun.resolve, delayedRun.reject); + }, 0); + return "finished"; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "timer", + runId: "run-timer", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "finished" }); + await expect(delayedRun.promise).resolves.toMatchObject({ + status: "completed", + result: "started", + }); + }); + + it("flushes progress incrementally while a factory body is awaiting", async () => { + const sendRequest = vi.fn(async () => ({})); + const session = new CopilotSession("session-live-progress", { sendRequest } as never); + const body = Promise.withResolvers(); + const factory = defineFactory({ + meta: { + name: "live-progress", + description: "Incremental progress test", + phases: [], + }, + run: async ({ log }) => { + log("before await"); + await body.promise; + return "done"; + }, + }); + session.registerFactories([factory]); + + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "live-progress", + runId: "run-live-progress", + executionToken: "execution-token", + args: {}, + }); + await vi.waitFor(() => { + expect(sendRequest).toHaveBeenCalledWith("session.factory.log", { + sessionId: session.sessionId, + runId: "run-live-progress", + executionToken: "execution-token", + lines: [{ seq: 0, kind: "log", text: "before await" }], + }); + }); + + body.resolve(); + await expect(execution).resolves.toEqual({ result: "done" }); + }); + + it("calls factory.agent with the current run id and returns its text", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return { result: "pong" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-agent", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "agent", + description: "Agent context test", + phases: [], + }, + run: async ({ agent }) => + agent("Reply with pong", { + label: "Pong helper", + model: "gpt-test", + schema: { type: "string" }, + effort: "high", + } as FactoryAgentOptions), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "agent", + runId: "run-agent", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "pong" }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.agent", { + sessionId: session.sessionId, + factoryRunId: "run-agent", + executionToken: "execution-token", + prompt: "Reply with pong", + opts: { + label: "Pong helper", + model: "gpt-test", + schema: { type: "string" }, + }, + }); + }); + + it("forwards every declared factory.agent option", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return { result: "pong" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-agent-options", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "agent-options", + description: "Agent option forwarding test", + phases: [], + }, + run: async ({ agent }) => + agent("Reply with pong", { + label: "Pong helper", + model: "gpt-test", + schema: { type: "string" }, + agent: "reviewer", + reasoningEffort: "high", + contextTier: "long_context", + }), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "agent-options", + runId: "run-agent-options", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "pong" }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.agent", { + sessionId: session.sessionId, + factoryRunId: "run-agent-options", + executionToken: "execution-token", + prompt: "Reply with pong", + opts: { + label: "Pong helper", + model: "gpt-test", + schema: { type: "string" }, + agent: "reviewer", + reasoningEffort: "high", + contextTier: "long_context", + }, + }); + }); + + it("sends empty factory.agent options when none are supplied", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return { result: "pong" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-empty-agent-options", { + sendRequest, + } as never); + const factory = defineFactory({ + meta: { + name: "empty-agent-options", + description: "Empty agent option forwarding test", + phases: [], + }, + run: async ({ agent }) => agent("Reply with pong"), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "empty-agent-options", + runId: "run-empty-agent-options", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "pong" }); + expect(sendRequest).toHaveBeenCalledWith("session.factory.agent", { + sessionId: session.sessionId, + factoryRunId: "run-empty-agent-options", + executionToken: "execution-token", + prompt: "Reply with pong", + opts: {}, + }); + }); + + it("keeps each execution token on callbacks from overlapping contexts with the same run id", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return { result: "agent result" }; + } + if (method === "session.factory.journal.get") { + return { hit: false }; + } + return {}; + }); + const session = new CopilotSession("session-overlapping-attempts", { + sendRequest, + } as never); + const contexts: FactoryContext[] = []; + const bodies = [Promise.withResolvers(), Promise.withResolvers()]; + const contextsReady = Promise.withResolvers(); + const factory = defineFactory({ + meta: { + name: "overlapping-attempts", + description: "Execution token capture test", + phases: [], + }, + run: async (context) => { + const invocation = contexts.length; + contexts.push(context); + if (contexts.length === 2) { + contextsReady.resolve(); + } + await bodies[invocation].promise; + return `attempt ${invocation + 1}`; + }, + }); + session.registerFactories([factory]); + const first = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "overlapping-attempts", + runId: "shared-run", + executionToken: "old-token", + args: {}, + }); + const second = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "overlapping-attempts", + runId: "shared-run", + executionToken: "current-token", + args: {}, + }); + await contextsReady.promise; + + contexts[0].log("stale log"); + await contexts[0].agent("stale agent"); + await contexts[0].step("stale journal", () => "stale result"); + await contexts[1].agent("current agent"); + + expect(sendRequest).toHaveBeenCalledWith( + "session.factory.log", + expect.objectContaining({ executionToken: "old-token" }) + ); + expect(sendRequest).toHaveBeenCalledWith( + "session.factory.agent", + expect.objectContaining({ executionToken: "old-token", prompt: "stale agent" }) + ); + expect(sendRequest).toHaveBeenCalledWith( + "session.factory.journal.get", + expect.objectContaining({ executionToken: "old-token", key: "stale journal" }) + ); + expect(sendRequest).toHaveBeenCalledWith( + "session.factory.journal.put", + expect.objectContaining({ executionToken: "old-token", key: "stale journal" }) + ); + expect(sendRequest).toHaveBeenCalledWith( + "session.factory.agent", + expect.objectContaining({ executionToken: "current-token", prompt: "current agent" }) + ); + + bodies[0].resolve(); + bodies[1].resolve(); + await expect(first).resolves.toEqual({ result: "attempt 1" }); + await expect(second).resolves.toEqual({ result: "attempt 2" }); + }); + + it("runs a durable step once, serves cached null, and does not cache failures", async () => { + const journal = new Map(); + const sendRequest = vi.fn( + async (method: string, params: { key?: string; resultJson?: unknown }) => { + if (method === "session.factory.journal.get") { + return journal.has(params.key!) + ? { hit: true, resultJson: journal.get(params.key!) } + : { hit: false }; + } + if (method === "session.factory.journal.put") { + journal.set(params.key!, params.resultJson); + return {}; + } + throw new Error(`Unexpected method: ${method}`); + } + ); + const session = new CopilotSession("session-step", { sendRequest } as never); + let cachedProducerCalls = 0; + let failingProducerCalls = 0; + const factory = defineFactory({ + meta: { + name: "step", + description: "Durable step context test", + phases: [], + }, + run: async ({ step }) => { + const first = await step("cached-null", async () => { + cachedProducerCalls++; + return null; + }); + const second = await step("cached-null", async () => { + cachedProducerCalls++; + return "wrong"; + }); + const failed = await step("retry", async () => { + failingProducerCalls++; + throw new Error("transient"); + }).catch(() => "failed"); + const retried = await step("retry", async () => { + failingProducerCalls++; + return "recovered"; + }); + return { first, second, failed, retried }; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "step", + runId: "run-step", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ + result: { first: null, second: null, failed: "failed", retried: "recovered" }, + }); + expect(cachedProducerCalls).toBe(1); + expect(failingProducerCalls).toBe(2); + expect( + sendRequest.mock.calls.filter(([method]) => method === "session.factory.journal.put") + ).toHaveLength(2); + }); + + it.each([ + ["undefined", () => undefined], + ["NaN", () => Number.NaN], + ["Infinity", () => Number.POSITIVE_INFINITY], + ["function", () => () => undefined], + ["symbol", () => Symbol("invalid")], + ["BigInt", () => 1n], + [ + "cycle", + () => { + const value: Record = {}; + value.self = value; + return value; + }, + ], + ["non-plain object", () => new Date()], + [ + "accessor property", + () => Object.defineProperty({}, "value", { enumerable: true, get: () => "hidden" }), + ], + [ + "non-enumerable property", + () => Object.defineProperty({}, "value", { enumerable: false, value: "hidden" }), + ], + ["array hole", () => new Array(1)], + [ + "array accessor", + () => Object.defineProperty([], "0", { enumerable: true, get: () => "hidden" }), + ], + ["array extra key", () => Object.assign([1], { extra: "dropped" })], + ])("rejects a journaled step %s result", async (_label, makeValue) => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.journal.get") { + return { hit: false }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-invalid-step", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "invalid-step", + description: "Rejects lossy step values", + phases: [], + }, + run: async ({ step }) => { + await step("invalid", async () => makeValue() as never); + return "must-not-complete"; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "invalid-step", + runId: "run-invalid-step", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + data: { + code: "factory_step_not_json", + }, + }); + expect( + sendRequest.mock.calls.filter(([method]) => method === "session.factory.journal.put") + ).toHaveLength(0); + }); + + it("validates a journaled step cache hit before replay", async () => { + const cached = Object.assign([1], { extra: "dropped" }); + const producer = vi.fn(async () => "must-not-run"); + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.journal.get") { + return { hit: true, resultJson: cached }; + } + throw new Error(`Unexpected method: ${method}`); + }); + const session = new CopilotSession("session-invalid-step-cache", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "invalid-step-cache", + description: "Rejects invalid cached values", + phases: [], + }, + run: async ({ step }) => step("cached", producer), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "invalid-step-cache", + runId: "run-invalid-step-cache", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + data: { + code: "factory_step_not_json", + category: "unsupported_object", + }, + }); + expect(producer).not.toHaveBeenCalled(); + }); + + it("replays a journaled step value identically on resume", async () => { + const journal = new Map(); + const sendRequest = vi.fn( + async (method: string, params: { key?: string; resultJson?: unknown }) => { + if (method === "session.factory.journal.get") { + return journal.has(params.key!) + ? { hit: true, resultJson: journal.get(params.key!) } + : { hit: false }; + } + if (method === "session.factory.journal.put") { + journal.set(params.key!, params.resultJson); + return {}; + } + throw new Error(`Unexpected method: ${method}`); + } + ); + const producer = vi.fn(async () => ({ nested: [1, null, "same"] })); + const session = new CopilotSession("session-step-replay", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "step-replay", + description: "Replays strict JSON", + phases: [], + }, + run: async ({ step }) => step("same", producer), + }); + session.registerFactories([factory]); + + const first = await session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "step-replay", + runId: "run-step-replay", + executionToken: "execution-token", + args: {}, + }); + const replay = await session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "step-replay", + runId: "run-step-replay", + executionToken: "execution-token", + args: {}, + }); + + expect(replay).toEqual(first); + expect(producer).toHaveBeenCalledOnce(); + }); + + it("bypasses validation and journaling for a volatile step", async () => { + const sendRequest = vi.fn(); + const session = new CopilotSession("session-volatile-step", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "volatile-step", + description: "Allows author-opted-out volatile values", + phases: [], + }, + run: async ({ step }) => { + const value = await step("volatile", async () => (() => "not JSON") as never, { + volatile: true, + }); + expect(typeof value).toBe("function"); + return "completed"; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "volatile-step", + runId: "run-volatile-step", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "completed" }); + expect(sendRequest).not.toHaveBeenCalled(); + }); + + it("does not start a volatile step producer after the run is aborted", async () => { + const sendRequest = vi.fn(); + const session = new CopilotSession("session-volatile-abort", { sendRequest } as never); + let producerRan = false; + const factory = defineFactory({ + meta: { + name: "volatile-abort", + description: "Volatile steps honour cancellation", + phases: [], + }, + run: async ({ step, runId }) => { + // Abort mid-run, then attempt a volatile step. The producer must + // not run: cancellation has to stop new extension work starting, + // exactly as it does on the journaled path. + await session.clientSessionApis.factory!.abort({ + sessionId: session.sessionId, + runId, + }); + await step( + "volatile", + () => { + producerRan = true; + return "should not happen"; + }, + { volatile: true } + ); + return "completed"; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "volatile-abort", + runId: "run-volatile-abort", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toThrow(); + expect(producerRan).toBe(false); + }); + + it("rejects a factory result array with an extra own key", async () => { + const factory = defineFactory({ + meta: { + name: "array-extra-result", + description: "Rejects lossy array keys", + phases: [], + }, + run: async () => Object.assign([1], { extra: 1n }) as never, + }); + const session = new CopilotSession("session-array-extra-result", {} as never); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "array-extra-result", + runId: "run-array-extra-result", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toMatchObject({ + data: { + code: "factory_result_not_json", + category: "unsupported_object", + }, + }); + }); + + it("exposes factory getRun and forwards the run id", async () => { + const envelope = { runId: "run-read", status: "error", error: "failed" }; + const sendRequest = vi.fn(async () => envelope); + const session = new CopilotSession("session-read", { sendRequest } as never); + + await expect(session.factory.getRun("run-read")).resolves.toEqual(envelope); + expect(sendRequest).toHaveBeenCalledWith("session.factory.getRun", { + sessionId: session.sessionId, + runId: "run-read", + }); + }); + + it("exposes factory observability methods and forwards paging options", async () => { + const summary = { + runId: "run-observe", + factoryName: "observe", + description: "Observe", + status: "running" as const, + revision: 4, + createdAt: 1, + startedAt: 2, + updatedAt: 3, + completedAt: null, + currentPhase: { id: "p0", ordinal: 0 }, + declaredPhaseCount: 1, + liveAgentCount: 1, + totalSpawnedAgentCount: 1, + consumed: { activeMs: 10, subagents: 1, nanoAiu: 5 }, + declaredLimits: {}, + approved: {}, + observedAt: 4, + activeSegmentStartedAt: 2, + terminal: null, + }; + const progress = { + records: [], + oldestSeq: null, + newestSeq: null, + hasMoreOlder: false, + hasMoreNewer: false, + revision: 4, + }; + const detail = { ...summary, phases: [], agents: [], progress }; + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.listRuns") return { runs: [summary] }; + if (method === "session.factory.getRunDetail") return detail; + return progress; + }); + const session = new CopilotSession("session-observe", { sendRequest } as never); + + await expect(session.factory.listRuns()).resolves.toEqual([summary]); + await expect(session.factory.getRunDetail("run-observe")).resolves.toEqual(detail); + await expect( + session.factory.getRunProgress("run-observe", { + phaseId: "p0", + afterSeq: 10, + limit: 50, + }) + ).resolves.toEqual(progress); + expect(sendRequest).toHaveBeenNthCalledWith(1, "session.factory.listRuns", { + sessionId: session.sessionId, + }); + expect(sendRequest).toHaveBeenNthCalledWith(2, "session.factory.getRunDetail", { + sessionId: session.sessionId, + runId: "run-observe", + }); + expect(sendRequest).toHaveBeenNthCalledWith(3, "session.factory.getRunProgress", { + sessionId: session.sessionId, + runId: "run-observe", + phaseId: "p0", + afterSeq: 10, + limit: 50, + }); + }); + + it("exposes factory cancel and forwards the run id", async () => { + const envelope = { runId: "run-cancel", status: "cancelled", reason: "cancelled" }; + const sendRequest = vi.fn(async () => envelope); + const session = new CopilotSession("session-cancel", { sendRequest } as never); + + await expect(session.factory.cancel("run-cancel")).resolves.toEqual(envelope); + expect(sendRequest).toHaveBeenCalledWith("session.factory.cancel", { + sessionId: session.sessionId, + runId: "run-cancel", + }); + }); + + it("runs parallel as a barrier and maps a throwing thunk to null", async () => { + const first = Promise.withResolvers(); + const second = Promise.withResolvers(); + const started: string[] = []; + const session = new CopilotSession("session-parallel", {} as never); + const factory = defineFactory({ + meta: { + name: "parallel", + description: "Parallel combinator test", + phases: [], + }, + run: async ({ parallel }) => + parallel([ + async () => { + started.push("first"); + return first.promise; + }, + async () => { + started.push("second"); + return second.promise; + }, + async () => { + started.push("throwing"); + throw new Error("expected"); + }, + ]), + }); + session.registerFactories([factory]); + + let settled = false; + const execution = session.clientSessionApis + .factory!.execute({ + sessionId: session.sessionId, + name: "parallel", + runId: "run-parallel", + args: {}, + }) + .finally(() => { + settled = true; + }); + await vi.waitFor(() => expect(started).toEqual(["first", "second", "throwing"])); + + second.resolve("second"); + await Promise.resolve(); + expect(settled).toBe(false); + + first.resolve("first"); + await expect(execution).resolves.toEqual({ result: ["first", "second", null] }); + }); + + it("rejects already-invoked promises passed to parallel with a clear diagnostic", async () => { + const session = new CopilotSession("session-parallel-promises", {} as never); + const factory = defineFactory({ + meta: { + name: "parallel-promises", + description: "Parallel misuse diagnostic", + phases: [], + }, + run: async ({ parallel }) => + parallel([Promise.resolve("already running")] as unknown as Array< + () => Promise + >), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "parallel-promises", + runId: "run-parallel-promises", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toThrow( + "parallel() expects an array of functions, not promises. Wrap each call: () => agent(...)" + ); + }); + + it("flows pipeline items independently and drops only the item whose stage throws", async () => { + const releaseFirstItem = Promise.withResolvers(); + const secondStageStarted = Promise.withResolvers(); + const finalStageItems: string[] = []; + const session = new CopilotSession("session-pipeline", {} as never); + const factory = defineFactory({ + meta: { + name: "pipeline", + description: "Pipeline combinator test", + phases: [], + }, + run: async ({ pipeline }) => + pipeline( + ["slow", "fast", "throw"], + async (_previous, item) => { + if (item === "slow") { + await releaseFirstItem.promise; + } + if (item === "throw") { + throw new Error("expected"); + } + return `${item}-stage-1`; + }, + async (previous, item) => { + if (item === "fast") { + secondStageStarted.resolve(); + } + finalStageItems.push(item as string); + return `${previous}-stage-2`; + } + ), + }); + session.registerFactories([factory]); + + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "pipeline", + runId: "run-pipeline", + executionToken: "execution-token", + args: {}, + }); + await secondStageStarted.promise; + expect(finalStageItems).toEqual(["fast"]); + + releaseFirstItem.resolve(); + await expect(execution).resolves.toEqual({ + result: ["slow-stage-1-stage-2", "fast-stage-1-stage-2", null], + }); + expect(finalStageItems).toEqual(["fast", "slow"]); + }); + + it("enforces the 4096-item cap for parallel and pipeline", async () => { + const session = new CopilotSession("session-fanout-cap", {} as never); + const factory = defineFactory({ + meta: { + name: "fanout-cap", + description: "Fan-out cap test", + phases: [], + }, + run: async ({ parallel, pipeline }) => { + const tooManyItems = Array.from({ length: 4097 }, () => null); + const parallelError = await parallel( + tooManyItems.map(() => async () => null) + ).catch((error: unknown) => error); + const pipelineError = await pipeline(tooManyItems).catch((error: unknown) => error); + return { + parallel: (parallelError as Error).message, + pipeline: (pipelineError as Error).message, + }; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "fanout-cap", + runId: "run-fanout-cap", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ + result: { + parallel: "parallel() accepts at most 4096 items; got 4097.", + pipeline: "pipeline() accepts at most 4096 items; got 4097.", + }, + }); + }); + + it("does not deadlock nested combinators when only leaf agents use a one-slot limiter", async () => { + let active = 0; + let maxActive = 0; + let tail = Promise.resolve(); + const sendRequest = vi.fn( + async (method: string, params: { prompt: string }): Promise<{ result: string }> => { + if (method !== "session.factory.agent") { + throw new Error(`Unexpected method: ${method}`); + } + const previous = tail; + const done = Promise.withResolvers(); + tail = done.promise; + await previous; + active++; + maxActive = Math.max(maxActive, active); + await Promise.resolve(); + active--; + done.resolve(); + return { result: params.prompt }; + } + ); + const session = new CopilotSession("session-nested-combinators", { + sendRequest, + } as never); + const factory = defineFactory({ + meta: { + name: "nested-combinators", + description: "Nested combinator deadlock regression", + phases: [], + }, + run: async ({ agent, parallel, pipeline }) => + parallel([ + () => parallel([() => agent("a"), () => agent("b")]), + () => pipeline(["c"], (_previous, item) => agent(item as string)), + ]), + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "nested-combinators", + runId: "run-nested-combinators", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: [["a", "b"], ["c"]] }); + expect(maxActive).toBe(1); + expect(sendRequest).toHaveBeenCalledTimes(3); + }); + + it("flushes buffered progress in finally when the factory body throws", async () => { + const sendRequest = vi.fn(async () => ({})); + const session = new CopilotSession("session-throw-progress", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "throw-progress", + description: "Throwing progress test", + phases: [], + }, + run: async ({ log }) => { + log("before throw"); + throw new Error("body failed"); + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "throw-progress", + runId: "run-throw-progress", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toThrow("body failed"); + expect(sendRequest).toHaveBeenCalledWith("session.factory.log", { + sessionId: session.sessionId, + runId: "run-throw-progress", + executionToken: "execution-token", + lines: [{ seq: 0, kind: "log", text: "before throw" }], + }); + }); + + it("keeps a completed execution successful when only the final progress flush fails", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.log") { + throw new Error("final transport failure"); + } + return {}; + }); + const warning = vi.spyOn(console, "warn").mockImplementation(() => {}); + const session = new CopilotSession("session-final-flush-failure", { + sendRequest, + } as never); + const factory = defineFactory({ + meta: { + name: "final-flush-failure", + description: "Final flush failure regression test", + phases: [], + }, + run: async ({ log }) => { + log("final line"); + return "done"; + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "final-flush-failure", + runId: "run-final-flush-failure", + executionToken: "execution-token", + args: {}, + }) + ).resolves.toEqual({ result: "done" }); + expect(warning).toHaveBeenCalledWith( + "Failed to flush final factory progress after the factory body settled", + expect.objectContaining({ message: "final transport failure" }) + ); + }); + + it("keeps a completed execution successful when a background progress flush fails", async () => { + vi.useFakeTimers(); + const release = Promise.withResolvers(); + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.log") { + throw new Error("background transport failure"); + } + return {}; + }); + const warning = vi.spyOn(console, "warn").mockImplementation(() => {}); + const session = new CopilotSession("session-background-flush-failure", { + sendRequest, + } as never); + const factory = defineFactory({ + meta: { + name: "background-flush-failure", + description: "Background flush failure regression test", + phases: [], + }, + run: async ({ log }) => { + log("background line"); + await release.promise; + return "done"; + }, + }); + session.registerFactories([factory]); + + try { + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "background-flush-failure", + runId: "run-background-flush-failure", + executionToken: "execution-token", + args: {}, + }); + await vi.advanceTimersByTimeAsync(10_000); + await Promise.resolve(); + + release.resolve(); + + await expect(execution).resolves.toEqual({ result: "done" }); + expect(warning).toHaveBeenCalledWith( + "Ignoring a background factory progress flush failure after the factory body settled", + expect.objectContaining({ message: "background transport failure" }) + ); + } finally { + vi.useRealTimers(); + } + }); + + it("keeps a mid-run progress flush failure fatal", async () => { + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.log") { + throw new Error("mid-run transport failure"); + } + if (method === "session.factory.agent") { + return { result: "must not complete" }; + } + return {}; + }); + const session = new CopilotSession("session-mid-run-flush-failure", { + sendRequest, + } as never); + const factory = defineFactory({ + meta: { + name: "mid-run-flush-failure", + description: "Mid-run flush failure regression test", + phases: [], + }, + run: async ({ agent, log }) => { + log("before agent"); + return agent("trigger a flush"); + }, + }); + session.registerFactories([factory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "mid-run-flush-failure", + runId: "run-mid-run-flush-failure", + executionToken: "execution-token", + args: {}, + }) + ).rejects.toThrow("mid-run transport failure"); + expect(sendRequest).not.toHaveBeenCalledWith("session.factory.agent", expect.anything()); + }); + + it("surfaces the per-run abort signal on the factory context", async () => { + const session = new CopilotSession("session-abort-signal", {} as never); + const signalSeen = Promise.withResolvers(); + const factory = defineFactory({ + meta: { + name: "abort-signal", + description: "Abort signal test", + phases: [], + }, + run: async ({ signal }) => { + signalSeen.resolve(signal); + await new Promise((resolve) => + signal.addEventListener("abort", () => resolve(), { once: true }) + ); + return signal.aborted; + }, + }); + session.registerFactories([factory]); + + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "abort-signal", + runId: "run-abort-signal", + executionToken: "execution-token", + args: {}, + }); + const signal = await signalSeen.promise; + expect(signal.aborted).toBe(false); + + await session.clientSessionApis.factory!.abort({ + sessionId: session.sessionId, + runId: "run-abort-signal", + }); + + expect(signal.aborted).toBe(true); + await expect(execution).resolves.toEqual({ result: true }); + }); + + it("rejects an in-flight runtime-backed await when factory.abort trips the signal", async () => { + const agentResponse = Promise.withResolvers<{ result: string }>(); + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return agentResponse.promise; + } + return {}; + }); + const session = new CopilotSession("session-abort-await", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: "abort-await", + description: "Abort an in-flight factory await", + phases: [], + }, + run: async ({ agent }) => agent("wait forever"), + }); + session.registerFactories([factory]); + + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "abort-await", + runId: "run-abort-await", + executionToken: "execution-token", + args: {}, + }); + await vi.waitFor(() => + expect(sendRequest).toHaveBeenCalledWith("session.factory.agent", expect.anything()) + ); + + await session.clientSessionApis.factory!.abort({ + sessionId: session.sessionId, + runId: "run-abort-await", + }); + + await expect(execution).rejects.toMatchObject({ name: "AbortError" }); + agentResponse.resolve({ result: "late" }); + }); + + it.each(["parallel", "pipeline"] as const)( + "propagates cancellation out of %s instead of mapping it to null", + async (combinator) => { + const agentResponse = Promise.withResolvers<{ result: string }>(); + const sendRequest = vi.fn(async (method: string) => { + if (method === "session.factory.agent") { + return agentResponse.promise; + } + return {}; + }); + const session = new CopilotSession("session-abort-parallel", { sendRequest } as never); + const factory = defineFactory({ + meta: { + name: `abort-${combinator}`, + description: "Cancellation must bubble out of a combinator", + phases: [], + }, + // If the combinator swallowed the AbortError to null, this run would + // resolve successfully with [null] despite the run being cancelled. + run: async ({ agent, parallel, pipeline }) => + combinator === "parallel" + ? parallel([() => agent("wait forever")]) + : pipeline(["wait forever"], (_previous, item) => agent(item as string)), + }); + session.registerFactories([factory]); + + const execution = session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: `abort-${combinator}`, + runId: `run-abort-${combinator}`, + executionToken: "execution-token", + args: {}, + }); + await vi.waitFor(() => + expect(sendRequest).toHaveBeenCalledWith("session.factory.agent", expect.anything()) + ); + + await session.clientSessionApis.factory!.abort({ + sessionId: session.sessionId, + runId: `run-abort-${combinator}`, + }); + + await expect(execution).rejects.toMatchObject({ name: "AbortError" }); + agentResponse.resolve({ result: "late" }); + } + ); + + it("dispatches factory.execute to the registered factory selected by name", async () => { + const firstRun = vi.fn(async () => ({ selected: "first" })); + const secondRun = vi.fn(async ({ args, log }) => { + log("executing"); + return { selected: "second", echoed: args }; + }); + const firstFactory = defineFactory({ + meta: { + name: "first", + description: "First factory", + phases: [], + }, + run: firstRun, + }); + const secondFactory = defineFactory({ + meta: { + name: "second", + description: "Second factory", + phases: [], + }, + run: secondRun, + }); + const session = new CopilotSession("session-execute", { + sendRequest: vi.fn(async () => ({})), + } as never); + session.registerFactories([firstFactory, secondFactory]); + + await expect( + session.clientSessionApis.factory!.execute({ + sessionId: session.sessionId, + name: "second", + runId: "run-echo", + executionToken: "execution-token", + args: { message: "hello" }, + }) + ).resolves.toEqual({ + result: { selected: "second", echoed: { message: "hello" } }, + }); + expect(firstRun).not.toHaveBeenCalled(); + expect(secondRun).toHaveBeenCalledOnce(); + + const error = await session.clientSessionApis + .factory!.execute({ + sessionId: session.sessionId, + name: "missing", + runId: "run-missing", + args: {}, + }) + .catch((caught: unknown) => caught); + expect(error).toBeInstanceOf(ResponseError); + expect((error as ResponseError<{ code: string; name: string }>).data).toEqual({ + code: "factory_not_found", + name: "missing", + }); + }); + + it("runs fresh factories and routes direct and legacy resumes by ID without args", async () => { + const factory = defineFactory({ + meta: { + name: "friendly-run", + description: "Friendly run wrapper", + phases: [], + }, + run: async () => ({ unused: true }), + }); + const sendRequest = vi.fn(async (method: string, params: { name?: string }) => + method === "session.factory.resume" + ? { + factoryName: "stored-name", + run: { + runId: "run-prior", + status: "completed", + result: { name: "stored-name", persistedArgs: true }, + }, + } + : { + runId: "run-foreground", + status: "completed", + result: { name: params.name }, + } + ); + const session = new CopilotSession("session-run", { sendRequest } as never); + + await expect( + session.factory.resume("run-prior", { + limits: { maxTotalSubagents: 7 }, + }) + ).resolves.toMatchObject({ + status: "completed", + result: { name: "stored-name", persistedArgs: true }, + }); + await expect( + session.factory.run("by-name", { + args: { value: 1 }, + limits: { maxTotalSubagents: 7 }, + resumeFromRunId: "run-prior", + }) + ).resolves.toMatchObject({ + status: "completed", + result: { name: "stored-name", persistedArgs: true }, + }); + await expect(session.factory.run(factory)).resolves.toMatchObject({ + status: "completed", + result: { name: "friendly-run" }, + }); + expect(sendRequest).toHaveBeenNthCalledWith(1, "session.factory.resume", { + sessionId: session.sessionId, + runId: "run-prior", + limits: { maxTotalSubagents: 7 }, + }); + expect(sendRequest).toHaveBeenNthCalledWith(2, "session.factory.resume", { + sessionId: session.sessionId, + runId: "run-prior", + limits: { maxTotalSubagents: 7 }, + }); + expect(sendRequest).toHaveBeenNthCalledWith(3, "session.factory.run", { + sessionId: session.sessionId, + name: "friendly-run", + args: {}, + options: { limits: undefined }, + }); + }); + + it("returns the full envelope for a failed foreground run", async () => { + const envelope = { + runId: "run-error", + status: "error" as const, + error: "factory failed", + snapshot: { completed: 1 }, + }; + const session = new CopilotSession("session-error", { + sendRequest: vi.fn(async () => envelope), + } as never); + + // A run that exists resolves with its envelope; only pre-execution + // failures (no run id) reject. + await expect(session.factory.run("failing")).resolves.toEqual(envelope); + }); + + it.each([ + "not_found", + "non_resumable", + "already_active", + "factory_already_running", + "factory_limits_invalid", + "factory_session_disposed", + "factory_storage_unavailable", + "factory_storage_corrupt", + ] as const)( + "throws FactoryResumeError with code %s for pre-execution failures", + async (code) => { + const session = new CopilotSession("session-resume-error", { + sendRequest: vi.fn(async () => { + throw new ResponseError(-32602, `resume failed: ${code}`, { code }); + }), + } as never); + + const error = await session.factory + .resume("run-error") + .catch((caught: unknown) => caught); + expect(error).toBeInstanceOf(FactoryResumeError); + expect((error as FactoryResumeError).code).toBe(code); + } + ); + + it("leaves an unreachable permission_denied response as a raw ResponseError", async () => { + const session = new CopilotSession("session-resume-permission-denied", { + sendRequest: vi.fn(async () => { + throw new ResponseError(-32602, "resume failed: permission_denied", { + code: "permission_denied", + }); + }), + } as never); + + const error = await session.factory.resume("run-error").catch((caught: unknown) => caught); + expect(error).toBeInstanceOf(ResponseError); + expect(error).not.toBeInstanceOf(FactoryResumeError); + expect((error as ResponseError<{ code: string }>).data.code).toBe("permission_denied"); + }); + + it("returns resumed execution failures as envelopes", async () => { + const envelope = { + runId: "run-execution-error", + status: "error" as const, + error: "resumed body failed", + }; + const session = new CopilotSession("session-resumed-run-error", { + sendRequest: vi.fn(async () => ({ factoryName: "stored-name", run: envelope })), + } as never); + + await expect(session.factory.resume("run-execution-error")).resolves.toEqual(envelope); + }); +}); + +describe("factory run settlement", () => { + it.each([ + ["completed", true], + ["error", true], + ["halted", true], + ["cancelled", true], + ["pending", false], + ["running", false], + ] as const)("classifies %s as terminal=%s", (status, expected) => { + expect(isFactoryRunTerminal(status)).toBe(expected); + }); + + it("resolves immediately when the run has already settled", async () => { + const envelope = { runId: "run-settled", status: "completed" as const, result: 42 }; + const sendRequest = vi.fn(async () => envelope); + const session = new CopilotSession("session-wait-settled", { sendRequest } as never); + + await expect(session.factory.waitForRun("run-settled")).resolves.toEqual(envelope); + expect(sendRequest).toHaveBeenCalledTimes(1); + expect(sendRequest).toHaveBeenCalledWith("session.factory.getRun", { + sessionId: session.sessionId, + runId: "run-settled", + }); + }); + + it("waits for a running run to reach a terminal status", async () => { + const running = { runId: "run-wait", status: "running" as const }; + const terminal = { runId: "run-wait", status: "completed" as const, result: "done" }; + let current: unknown = running; + const sendRequest = vi.fn(async () => current); + const session = new CopilotSession("session-wait-running", { sendRequest } as never); + + const settled = session.factory.waitForRun("run-wait"); + // The first read observed a running envelope, so the wait is still pending. + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(1)); + + // An invalidation event for an unrelated run must not trigger a re-read. + (session as never as { _dispatchEvent(event: unknown): void })._dispatchEvent( + runUpdatedEvent("some-other-run", 2) + ); + expect(sendRequest).toHaveBeenCalledTimes(1); + + current = terminal; + (session as never as { _dispatchEvent(event: unknown): void })._dispatchEvent( + runUpdatedEvent("run-wait", 3) + ); + + await expect(settled).resolves.toEqual(terminal); + }); + + it("periodically re-reads when a terminal invalidation is missed", async () => { + vi.useFakeTimers(); + const running = { runId: "run-poll", status: "running" as const }; + const terminal = { runId: "run-poll", status: "completed" as const, result: "polled" }; + let current: unknown = running; + const sendRequest = vi.fn(async () => current); + const session = new CopilotSession("session-wait-poll", { sendRequest } as never); + + try { + const settled = session.factory.waitForRun("run-poll"); + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(1)); + + current = terminal; + await vi.advanceTimersByTimeAsync(5_000); + + await expect(settled).resolves.toEqual(terminal); + expect(sendRequest).toHaveBeenCalledTimes(2); + } finally { + vi.useRealTimers(); + } + }); + + it("stops watching once the run settles", async () => { + const running = { runId: "run-unsub", status: "running" as const }; + const terminal = { runId: "run-unsub", status: "error" as const, error: "body failed" }; + let current: unknown = running; + const sendRequest = vi.fn(async () => current); + const session = new CopilotSession("session-wait-unsub", { sendRequest } as never); + const handlersFor = (): Set | undefined => + ( + session as never as { + typedEventHandlers: Map>; + } + ).typedEventHandlers.get("factory.run_updated"); + + const settled = session.factory.waitForRun("run-unsub"); + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(1)); + expect(handlersFor()?.size ?? 0).toBe(1); + + current = terminal; + (session as never as { _dispatchEvent(event: unknown): void })._dispatchEvent( + runUpdatedEvent("run-unsub", 2) + ); + await expect(settled).resolves.toEqual(terminal); + + // The subscription must be released, or every completed wait leaks a + // listener for the lifetime of the session. + expect(handlersFor()?.size ?? 0).toBe(0); + + const callsAtSettlement = sendRequest.mock.calls.length; + // A late event for a settled run must not provoke another read. + (session as never as { _dispatchEvent(event: unknown): void })._dispatchEvent( + runUpdatedEvent("run-unsub", 3) + ); + expect(sendRequest).toHaveBeenCalledTimes(callsAtSettlement); + }); + + it("rejects when the signal is already aborted and never reads", async () => { + const sendRequest = vi.fn(async () => ({ runId: "run-pre", status: "running" })); + const session = new CopilotSession("session-wait-pre-abort", { sendRequest } as never); + + await expect( + session.factory.waitForRun("run-pre", { signal: AbortSignal.abort() }) + ).rejects.toThrow(); + expect(sendRequest).not.toHaveBeenCalled(); + }); + + it("rejects when aborted while waiting, leaving the run untouched", async () => { + const sendRequest = vi.fn(async () => ({ runId: "run-abort", status: "running" })); + const session = new CopilotSession("session-wait-abort", { sendRequest } as never); + const controller = new AbortController(); + + const settled = session.factory.waitForRun("run-abort", { signal: controller.signal }); + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(1)); + + controller.abort(); + await expect(settled).rejects.toThrow(); + // Aborting the wait must not cancel the run. + expect(sendRequest).not.toHaveBeenCalledWith("session.factory.cancel", expect.anything()); + }); + + it("propagates a read failure", async () => { + const sendRequest = vi.fn(async () => { + throw new Error("factory_storage_unavailable"); + }); + const session = new CopilotSession("session-wait-error", { sendRequest } as never); + + await expect(session.factory.waitForRun("run-broken")).rejects.toThrow( + "factory_storage_unavailable" + ); + }); + + it("collapses a burst of invalidation events into one in-flight read", async () => { + const running = { runId: "run-burst", status: "running" as const }; + const terminal = { runId: "run-burst", status: "completed" as const }; + let release: (() => void) | undefined; + const gate = new Promise((resolve) => (release = resolve)); + let readCount = 0; + const sendRequest = vi.fn(async () => { + readCount += 1; + if (readCount === 2) { + await gate; + } + // Reads 1 and 2 observe a running run; only the coalesced third + // read observes the terminal one. + return readCount >= 3 ? terminal : running; + }); + const session = new CopilotSession("session-wait-burst", { sendRequest } as never); + + const settled = session.factory.waitForRun("run-burst"); + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(1)); + + const dispatch = (revision: number): void => + (session as never as { _dispatchEvent(event: unknown): void })._dispatchEvent( + runUpdatedEvent("run-burst", revision) + ); + + // Second read is held open while three more events arrive; they must + // collapse into a single follow-up read rather than three. + dispatch(2); + await vi.waitFor(() => expect(sendRequest).toHaveBeenCalledTimes(2)); + dispatch(3); + dispatch(4); + dispatch(5); + expect(sendRequest).toHaveBeenCalledTimes(2); + + release?.(); + await expect(settled).resolves.toEqual(terminal); + // One initial read, the held read, and exactly one coalesced re-read + // standing in for all three queued events. + expect(sendRequest).toHaveBeenCalledTimes(3); + }); +}); diff --git a/nodejs/test/get-version.test.ts b/nodejs/test/get-version.test.ts index 23d2486ec..5dea84cf2 100644 --- a/nodejs/test/get-version.test.ts +++ b/nodejs/test/get-version.test.ts @@ -2,15 +2,13 @@ import { describe, expect, it } from "vitest"; import { calculateVersion } from "../scripts/calculate-version.js"; describe("get-version", () => { - // TEMPORARY: these two tests reflect beta-as-latest behavior. To ship - // stable 1.0.0, revert the commit that introduced this temporary change. - it("increments latest versions as prerelease (temporary beta behavior)", () => { - expect(calculateVersion("latest", { latest: "1.0.1" })).toBe("1.0.2-preview.0"); + it("increments stable latest versions by patch", () => { + expect(calculateVersion("latest", { latest: "1.0.1" })).toBe("1.0.2"); }); - it("continues beta prerelease for latest releases (temporary beta behavior)", () => { + it("promotes a higher prerelease to stable for latest releases", () => { expect(calculateVersion("latest", { latest: "0.3.0", prerelease: "1.0.0-beta.1" })).toBe( - "1.0.0-beta.2" + "1.0.0" ); }); diff --git a/nodejs/test/npm-release.test.ts b/nodejs/test/npm-release.test.ts new file mode 100644 index 000000000..26caf7dea --- /dev/null +++ b/nodejs/test/npm-release.test.ts @@ -0,0 +1,88 @@ +import { describe, expect, it, vi } from "vitest"; +import { assertVersionAbsent, publishTarball } from "../scripts/npm-release.js"; + +const packageName = "@github/copilot-sdk"; +const version = "1.2.3"; +const registry = "https://registry.example.test"; +const result = (status: number, stdout = "", stderr = "") => ({ status, stdout, stderr }); + +describe("npm release preflight", () => { + it("succeeds only for a structured E404 response", async () => { + const runner = vi + .fn() + .mockResolvedValue(result(1, JSON.stringify({ error: { code: "E404" } }))); + await expect( + assertVersionAbsent(packageName, version, registry, runner) + ).resolves.toBeUndefined(); + }); + + it.each([ + ["an existing version", result(0, JSON.stringify(version)), "already exists"], + ["a transient error", result(1, "", "npm error code E500"), "Could not confirm"], + ["malformed output", result(1, "not-json"), "Could not confirm"], + [ + "a non-404 error containing E404 and 404 text", + result( + 1, + JSON.stringify({ error: { code: "E500", summary: "version 1.2.3-E404.404" } }), + "npm error code E500 for 1.2.3-E404.404" + ), + "Could not confirm", + ], + ])("fails for %s", async (_name, response, message) => { + const runner = vi.fn().mockResolvedValue(response); + await expect(assertVersionAbsent(packageName, version, registry, runner)).rejects.toThrow( + message + ); + }); +}); + +describe("npm release publishing", () => { + it("succeeds after a normal publish", async () => { + const runner = vi.fn().mockResolvedValue(result(0)); + await expect( + publishTarball("package.tgz", "latest", registry, "public", runner) + ).resolves.toBeUndefined(); + }); + + it.each([ + ["npm error code EPUBLISHCONFLICT", "public"], + [ + "npm error 403 403 Forbidden - PUT https://registry.npmjs.org/package - You cannot publish over the previously published versions: 1.2.3.", + "public", + ], + [ + "npm error 403 403 Forbidden - The feed 'copilot-canary' already contains file 'copilot-sdk-0.0.0-29613896246.tgz' in package '@github/copilot-sdk 0.0.0-29613896246'.", + "azure", + ], + ])("recovers the immutable conflict: %s", async (error, mode) => { + const runner = vi.fn().mockResolvedValue(result(1, "", error)); + await expect( + publishTarball("package.tgz", "latest", registry, mode, runner) + ).resolves.toBeUndefined(); + }); + + it.each([ + ["a generic Azure 403", "403 Forbidden", "azure"], + [ + "an Azure non-tarball conflict", + "npm error 403 already contains file 'package.json' in package '@github/copilot-sdk/1.2.3'", + "azure", + ], + [ + "an embedded public phrase", + "npm error network timeout while parsing 'cannot publish over the previously published versions'", + "public", + ], + [ + "an embedded Azure phrase", + "npm error network timeout while parsing \"already contains file 'package.tgz' in package '@github/copilot-sdk/1.2.3'\"", + "azure", + ], + ])("fails for %s", async (_name, error, mode) => { + const runner = vi.fn().mockResolvedValue(result(1, "", error)); + await expect( + publishTarball("package.tgz", "latest", registry, mode, runner) + ).rejects.toThrow("npm publish failed"); + }); +}); diff --git a/nodejs/test/session-event-codegen.test.ts b/nodejs/test/session-event-codegen.test.ts index 86c76f71b..14340292b 100644 --- a/nodejs/test/session-event-codegen.test.ts +++ b/nodejs/test/session-event-codegen.test.ts @@ -209,6 +209,38 @@ describe("session event codegen", () => { ); }); + it("drops leading underscores from C# member names while preserving JSON names", () => { + const schema: JSONSchema7 = { + definitions: { + SessionEvent: { + anyOf: [ + { + type: "object", + required: ["type", "data"], + properties: { + type: { const: "session.synthetic" }, + data: { + type: "object", + required: ["_meta"], + properties: { + _meta: { type: "string" }, + }, + }, + }, + }, + ], + }, + }, + }; + + const csharpCode = generateCSharpSessionEventsCode(schema); + + expect(csharpCode).toContain( + '[JsonPropertyName("_meta")]\n public required string Meta { get; set; }' + ); + expect(csharpCode).not.toContain("public required string _meta"); + }); + it("collapses redundant callable wrapper lambdas", () => { const schema: JSONSchema7 = { definitions: { diff --git a/nodejs/test/session-event-types.test.ts b/nodejs/test/session-event-types.test.ts index de21ba2ba..213670216 100644 --- a/nodejs/test/session-event-types.test.ts +++ b/nodejs/test/session-event-types.test.ts @@ -15,9 +15,18 @@ */ import { describe, expect, it } from "vitest"; +import { approveAll } from "../src/index.js"; +import { FACTORY_AGENT_OPTION_KEYS } from "../src/factory.js"; +import type { FactoryAgentOptions as WireFactoryAgentOptions } from "../src/generated/rpc.js"; import type { // The aggregate union; must still resolve via the package root. SessionEvent, + PermissionRequest, + PermissionRequestedData, + PermissionRequestedEvent, + ManagedSettingsResolvedData, + ManagedSettingsResolvedEvent, + ManagedSettingsResolvedSource, // *Data payload types from the v0.3.0 generated session-event schema. AssistantMessageData, @@ -48,8 +57,13 @@ import type { // *Data shapes — these must also be reachable so that consumers can // narrow or annotate intermediate values. UserMessageAgentMode, - UserMessageAttachment, + Attachment, WorkingDirectoryContextHostType, + FactoryContext, + FactoryDefinition, + FactoryAgentOptions, + FactoryRunResult, + JsonValue, } from "../src/index.js"; /** @@ -80,6 +94,37 @@ type _AssistantMessageEventStaysAlignedWithSessionEventUnion = _AssertEqual< Extract >; const _assistantMessageEventAlignmentCheck: _AssistantMessageEventStaysAlignedWithSessionEventUnion = true; +type _DefaultFactoryArgsAreJsonValue = _AssertEqual; +const _defaultFactoryArgsCheck: _DefaultFactoryArgsAreJsonValue = true; +type _DefaultFactoryResultIsJsonValueOrVoid = _AssertEqual< + Awaited>, + JsonValue | void +>; +const _defaultFactoryResultCheck: _DefaultFactoryResultIsJsonValueOrVoid = true; +type _FactoryRunResultIsJsonValueOrUndefined = _AssertEqual< + FactoryRunResult["result"], + JsonValue | undefined +>; +const _factoryRunResultCheck: _FactoryRunResultIsJsonValueOrUndefined = true; +type _FactoryAgentOptionKeysMatchPublicInterface = _AssertEqual< + (typeof FACTORY_AGENT_OPTION_KEYS)[number], + keyof FactoryAgentOptions +>; +const _factoryAgentOptionKeysCheck: _FactoryAgentOptionKeysMatchPublicInterface = true; +type _PublicFactoryAgentOptionsMatchWire = _AssertEqual< + keyof FactoryAgentOptions, + keyof WireFactoryAgentOptions +>; +const _publicFactoryAgentOptionsCheck: _PublicFactoryAgentOptionsMatchWire = true; +// @ts-expect-error Factory arguments must be representable on the JSON wire. +type _FactoryArgsRejectUndefined = FactoryContext; +// @ts-expect-error Factory results must be JSON values or top-level void. +type _FactoryResultRejectsFunction = FactoryDefinition void>; +type _PermissionRequestedEventStaysAlignedWithSessionEventUnion = _AssertEqual< + PermissionRequestedEvent, + Extract +>; +const _permissionRequestedEventAlignmentCheck: _PermissionRequestedEventStaysAlignedWithSessionEventUnion = true; describe("Session event type exports (#1156)", () => { it("exposes the headline ToolExecutionStartData type with a usable shape", () => { @@ -97,12 +142,127 @@ describe("Session event type exports (#1156)", () => { expect(data.toolName).toBe("shell"); expect(data.toolCallId).toBe("call-1"); - expect(data.arguments?.command).toBe("ls"); + expect(data.arguments).toEqual({ command: "ls" }); expect(data.mcpServerName).toBe("filesystem"); expect(data.mcpToolName).toBe("list_dir"); expect(data.turnId).toBe("turn-1"); }); + it("exposes explicit user approval metadata for managed Domain requests", () => { + const request: PermissionRequest = { + kind: "url", + url: "https://api.example.com/data", + intention: "Fetch domain data", + managedApprovalRequired: true, + }; + + expect(request.managedApprovalRequired).toBe(true); + }); + + it("exposes managed approval metadata through permission event types", () => { + const data: PermissionRequestedData = { + permissionRequest: { + kind: "url", + url: "https://api.example.com/data", + intention: "Fetch domain data", + managedApprovalRequired: true, + }, + requestId: "permission-1", + }; + const event: SessionEvent = { + id: "evt-permission-1", + parentId: null, + timestamp: "2026-01-01T00:00:00.000Z", + type: "permission.requested", + data, + }; + + if (event.type !== "permission.requested") { + throw new Error("expected permission.requested narrowing"); + } + + const permissionEvent: PermissionRequestedEvent = event; + expect(permissionEvent.data.permissionRequest.managedApprovalRequired).toBe(true); + }); + + it("exposes managed settings client and mixed provenance", () => { + const sources: ManagedSettingsResolvedSource[] = [ + "server", + "device", + "client", + "mixed", + "none", + ]; + expect(sources).toEqual(["server", "device", "client", "mixed", "none"]); + + const clientData: ManagedSettingsResolvedData = { + bypassPermissionsDisabled: true, + clientManaged: true, + deviceManaged: false, + failClosed: false, + managedKeys: ["permissions"], + serverManaged: false, + source: "client", + }; + const clientEvent: ManagedSettingsResolvedEvent = { + ephemeral: true, + id: "evt-managed-1", + parentId: null, + timestamp: "2026-01-01T00:00:00.000Z", + type: "session.managed_settings_resolved", + data: clientData, + }; + expect(clientEvent.data.source).toBe("client"); + expect(clientEvent.data.clientManaged).toBe(true); + + const { clientManaged: _, ...withoutClientManaged } = clientData; + const mixedData: ManagedSettingsResolvedData = { + ...withoutClientManaged, + source: "mixed", + }; + expect(mixedData.source).toBe("mixed"); + expect("clientManaged" in mixedData).toBe(false); + }); + + it("rejects approveAll in managed settings sessions", () => { + expect(() => + approveAll( + { + kind: "url", + url: "https://api.example.com/data", + intention: "Fetch ordinary data", + }, + { sessionId: "session-1", managedSettingsEnabled: true } + ) + ).toThrow("approveAll cannot be used when managed settings are enabled"); + + expect(() => + approveAll( + { + kind: "url", + url: "https://api.example.com/data", + intention: "Fetch managed data", + managedApprovalRequired: true, + }, + { sessionId: "session-1", managedSettingsEnabled: true } + ) + ).toThrow("approveAll cannot be used when managed settings are enabled"); + }); + + it("leaves managed requests pending when managed settings are disabled", () => { + expect( + approveAll( + { + kind: "url", + url: "https://api.example.com/data", + intention: "Fetch managed data", + managedApprovalRequired: true, + }, + { sessionId: "session-1", managedSettingsEnabled: false } + ) + ).toEqual({ kind: "no-result" }); + }); + it("wraps ToolExecutionStartData inside the exported ToolExecutionStartEvent", () => { const event: ToolExecutionStartEvent = { id: "evt-1", @@ -160,6 +320,8 @@ describe("Session event type exports (#1156)", () => { assertImportable(); assertImportable(); assertImportable(); + assertImportable(); + assertImportable(); assertImportable(); assertImportable(); @@ -169,12 +331,15 @@ describe("Session event type exports (#1156)", () => { assertImportable(); assertImportable(); assertImportable(); + assertImportable(); + assertImportable(); + assertImportable(); // Supporting auxiliary types referenced by the *Data shapes — these // must round-trip through the package root too, otherwise consumers // annotating intermediate values would still need a deep import. assertImportable(); - assertImportable(); + assertImportable(); assertImportable(); expect(true).toBe(true); diff --git a/nodejs/test/session-send-and-wait.test.ts b/nodejs/test/session-send-and-wait.test.ts new file mode 100644 index 000000000..8b6e390c4 --- /dev/null +++ b/nodejs/test/session-send-and-wait.test.ts @@ -0,0 +1,137 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { describe, expect, it, onTestFinished } from "vitest"; +import type { MessageConnection } from "vscode-jsonrpc/node.js"; +import { CopilotSession } from "../src/session.js"; +import type { SessionEvent } from "../src/generated/session-events.js"; + +function sessionEvent(type: "session.idle", data: Record = {}): SessionEvent { + return { + type, + id: "00000000-0000-4000-8000-000000000001", + parentId: null, + timestamp: new Date().toISOString(), + ephemeral: true, + data, + } as SessionEvent; +} + +/** Builds a `session.error` event, the shape `session.log(…, { level: "error" })` produces. */ +function errorEvent(message: string): SessionEvent { + return { + type: "session.error", + id: "00000000-0000-4000-8000-000000000001", + parentId: null, + timestamp: new Date().toISOString(), + data: { errorType: "notification", message }, + } as SessionEvent; +} + +function controlledSession(): { + session: CopilotSession; + sendStarted: Promise; + resolveSend: () => void; + rejectSend: (error: Error) => void; +} { + let resolveSendRequest: ((value: unknown) => void) | undefined; + let rejectSendRequest: ((error: Error) => void) | undefined; + let markSendStarted: () => void; + const sendStarted = new Promise((resolve) => { + markSendStarted = resolve; + }); + const connection = { + sendRequest: () => + new Promise((resolve, reject) => { + resolveSendRequest = resolve; + rejectSendRequest = reject; + markSendStarted(); + }), + } as unknown as MessageConnection; + + return { + session: new CopilotSession("session-1", connection), + sendStarted, + resolveSend: () => resolveSendRequest?.({ messageId: "msg-1" }), + rejectSend: (error) => rejectSendRequest?.(error), + }; +} + +describe("sendAndWait", () => { + it("does not emit an unhandled rejection when session.error arrives before the idle race is armed", async () => { + const { session, sendStarted, resolveSend } = controlledSession(); + + const unhandled: unknown[] = []; + const onUnhandled = (reason: unknown): void => { + unhandled.push(reason); + }; + process.on("unhandledRejection", onUnhandled); + onTestFinished(() => { + process.off("unhandledRejection", onUnhandled); + }); + + const pending = session.sendAndWait({ prompt: "hi" }); + await sendStarted; + + // A session.error lands while send()'s RPC is still in flight. This is + // ordinary traffic: a joined client calling session.log(…, { level: "error" }) + // or an MCP server failing to start both produce one. + session._dispatchEvent(errorEvent("MCP server failed to start")); + + // Yield past a macrotask boundary so Node has run the checkpoint at which + // it classifies a rejection as unhandled. + await new Promise((resolve) => setTimeout(resolve, 0)); + + expect(unhandled).toEqual([]); + + resolveSend(); + await expect(pending).rejects.toThrow("MCP server failed to start"); + }); + + it("preserves an early idle event until send completes", async () => { + const { session, sendStarted, resolveSend } = controlledSession(); + const pending = session.sendAndWait({ prompt: "hi" }); + await sendStarted; + + session._dispatchEvent(sessionEvent("session.idle")); + + const stateBeforeSend = await Promise.race([ + pending.then(() => "settled"), + new Promise<"pending">((resolve) => setTimeout(() => resolve("pending"), 0)), + ]); + expect(stateBeforeSend).toBe("pending"); + + resolveSend(); + await expect(pending).resolves.toBeUndefined(); + }); + + it("preserves the send rejection when a session error arrives first", async () => { + const { session, sendStarted, rejectSend } = controlledSession(); + const pending = session.sendAndWait({ prompt: "hi" }); + await sendStarted; + + session._dispatchEvent(errorEvent("session error")); + rejectSend(new Error("send failed")); + + await expect(pending).rejects.toThrow("send failed"); + }); + + it("uses the first session outcome observed while send is in flight", async () => { + const idleFirst = controlledSession(); + const idleFirstPending = idleFirst.session.sendAndWait({ prompt: "hi" }); + await idleFirst.sendStarted; + idleFirst.session._dispatchEvent(sessionEvent("session.idle")); + idleFirst.session._dispatchEvent(errorEvent("later error")); + idleFirst.resolveSend(); + await expect(idleFirstPending).resolves.toBeUndefined(); + + const errorFirst = controlledSession(); + const errorFirstPending = errorFirst.session.sendAndWait({ prompt: "hi" }); + await errorFirst.sendStarted; + errorFirst.session._dispatchEvent(errorEvent("first error")); + errorFirst.session._dispatchEvent(sessionEvent("session.idle")); + errorFirst.resolveSend(); + await expect(errorFirstPending).rejects.toThrow("first error"); + }); +}); diff --git a/nodejs/test/session_fs_adapter.test.ts b/nodejs/test/session_fs_adapter.test.ts index fb62d9904..98749dffb 100644 --- a/nodejs/test/session_fs_adapter.test.ts +++ b/nodejs/test/session_fs_adapter.test.ts @@ -67,6 +67,20 @@ describe("SessionFsAdapter", () => { rowsAffected: 0, }; }, + async transaction(statements) { + return statements.map((statement) => ({ + columns: ["sessionId", "query", "queryType", "answer"], + rows: [ + { + sessionId, + query: statement.query, + queryType: statement.queryType, + answer: statement.params?.answer, + }, + ], + rowsAffected: 0, + })); + }, async exists() { return true; }, @@ -205,6 +219,7 @@ describe("SessionFsAdapter", () => { rename: () => Promise.reject(error), sqlite: { query: () => Promise.reject(error), + transaction: () => Promise.reject(error), exists: () => Promise.reject(error), }, }; @@ -244,6 +259,14 @@ describe("SessionFsAdapter", () => { ).rejects.toThrow("missing file"); await expect(handler.sqliteExists({ sessionId })).rejects.toThrow("missing file"); + // sqliteTransaction reports a classified result-level error instead + const transaction = await handler.sqliteTransaction({ + sessionId, + statements: [{ query: "select 1", queryType: "query" }], + }); + expect(transaction.results).toEqual([]); + expect(transaction.error).toEqual({ errorClass: "fatal", message: "missing file" }); + const unknownProvider = createSessionFsAdapter(makeThrowingProvider(makeError("bad path"))); const unknownError = await unknownProvider.writeFile({ sessionId, diff --git a/nodejs/test/telemetry.test.ts b/nodejs/test/telemetry.test.ts index 9ad97b63a..78d9654ed 100644 --- a/nodejs/test/telemetry.test.ts +++ b/nodejs/test/telemetry.test.ts @@ -64,6 +64,7 @@ describe("telemetry", () => { it("sets correct env vars for full telemetry config", async () => { const telemetry = { otlpEndpoint: "http://localhost:4318", + otlpProtocol: "http/protobuf", filePath: "/tmp/traces.jsonl", exporterType: "otlp-http", sourceName: "my-app", @@ -76,6 +77,7 @@ describe("telemetry", () => { const t = telemetry; env.COPILOT_OTEL_ENABLED = "true"; if (t.otlpEndpoint !== undefined) env.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint; + if (t.otlpProtocol !== undefined) env.OTEL_EXPORTER_OTLP_PROTOCOL = t.otlpProtocol; if (t.filePath !== undefined) env.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath; if (t.exporterType !== undefined) env.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType; if (t.sourceName !== undefined) env.COPILOT_OTEL_SOURCE_NAME = t.sourceName; @@ -88,6 +90,7 @@ describe("telemetry", () => { expect(env).toEqual({ COPILOT_OTEL_ENABLED: "true", OTEL_EXPORTER_OTLP_ENDPOINT: "http://localhost:4318", + OTEL_EXPORTER_OTLP_PROTOCOL: "http/protobuf", COPILOT_OTEL_FILE_EXPORTER_PATH: "/tmp/traces.jsonl", COPILOT_OTEL_EXPORTER_TYPE: "otlp-http", COPILOT_OTEL_SOURCE_NAME: "my-app", @@ -103,6 +106,7 @@ describe("telemetry", () => { const t = telemetry as any; env.COPILOT_OTEL_ENABLED = "true"; if (t.otlpEndpoint !== undefined) env.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint; + if (t.otlpProtocol !== undefined) env.OTEL_EXPORTER_OTLP_PROTOCOL = t.otlpProtocol; if (t.filePath !== undefined) env.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath; if (t.exporterType !== undefined) env.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType; if (t.sourceName !== undefined) env.COPILOT_OTEL_SOURCE_NAME = t.sourceName; diff --git a/nodejs/test/typescript-codegen.test.ts b/nodejs/test/typescript-codegen.test.ts index 248b60968..0a63a5293 100644 --- a/nodejs/test/typescript-codegen.test.ts +++ b/nodejs/test/typescript-codegen.test.ts @@ -2,7 +2,12 @@ import type { JSONSchema7 } from "json-schema"; import { compile } from "json-schema-to-typescript"; import { describe, expect, it } from "vitest"; -import { normalizeSchemaForTypeScript } from "../../scripts/codegen/typescript.ts"; +import { + assertNoPublicInternalReferences, + filterPublicSessionEventVariants, + normalizeSchemaForTypeScript, +} from "../../scripts/codegen/typescript.ts"; +import type { DefinitionCollections } from "../../scripts/codegen/utils.ts"; describe("typescript schema codegen", () => { it("emits JSDoc comments for described enum values", async () => { @@ -43,4 +48,346 @@ describe("typescript schema codegen", () => { ); expect(code).toContain('inlineMode: /** Use a direct value. */ "direct" | "indirect";'); }); + + it("maps bare opaque properties to their marker aliases", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "OpaqueProperty", + type: "object", + properties: { + json: { "x-opaque-json": true }, + inProcess: { "x-opaque-in-process": true }, + }, + required: ["json", "inProcess"], + }), + "OpaqueProperty", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("json: JsonValue;"); + expect(code).toContain("inProcess: OpaqueInProcessValue;"); + }); + + it("maps a bare opaque JSON additional property to JsonValue", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "OpaqueMap", + type: "object", + additionalProperties: { "x-opaque-json": true }, + }), + "OpaqueMap", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("[k: string]: JsonValue;"); + }); + + it("maps a bare opaque JSON array item to JsonValue", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "OpaqueArray", + type: "object", + properties: { values: { type: "array", items: { "x-opaque-json": true } } }, + required: ["values"], + }), + "OpaqueArray", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("values: JsonValue[];"); + }); + + it("maps a bare opaque JSON definition to a named alias", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "OpaqueDefinitionRoot", + type: "object", + properties: { value: { $ref: "#/definitions/OpaqueDefinition" } }, + definitions: { OpaqueDefinition: { "x-opaque-json": true } }, + }), + "OpaqueDefinitionRoot", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("export type OpaqueDefinition = JsonValue;"); + }); + + it("keeps an opaque JSON node with anyOf as a union", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "ConstrainedUnion", + "x-opaque-json": true, + anyOf: [{ type: "string" }, { type: "number" }], + }), + "ConstrainedUnion", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("export type ConstrainedUnion = string | number;"); + expect(code).not.toContain("JsonValue"); + }); + + it("keeps an opaque JSON node with object constraints as an object", async () => { + const code = await compile( + normalizeSchemaForTypeScript({ + title: "ConstrainedObject", + type: "object", + "x-opaque-json": true, + properties: { name: { type: "string" } }, + required: ["name"], + }), + "ConstrainedObject", + { bannerComment: "", style: { semi: true, singleQuote: false } } + ); + + expect(code).toContain("export interface ConstrainedObject {"); + expect(code).toContain("name: string;"); + expect(code).not.toContain("JsonValue"); + }); + + it("removes both opaque markers from every normalized schema node", () => { + const normalized = normalizeSchemaForTypeScript({ + type: "object", + "x-opaque-json": true, + properties: { + json: { "x-opaque-json": true }, + inProcess: { "x-opaque-in-process": true }, + }, + additionalProperties: { "x-opaque-in-process": true }, + }) as Record; + + const assertMarkersRemoved = (value: unknown): void => { + if (Array.isArray(value)) { + value.forEach(assertMarkersRemoved); + } else if (value && typeof value === "object") { + for (const [key, child] of Object.entries(value as Record)) { + expect(key).not.toBe("x-opaque-json"); + expect(key).not.toBe("x-opaque-in-process"); + assertMarkersRemoved(child); + } + } + }; + + assertMarkersRemoved(normalized); + }); +}); + +describe("filterPublicSessionEventVariants", () => { + const makeCollections = (defs: Record): DefinitionCollections => ({ + definitions: defs, + $defs: {}, + }); + + it("keeps public union arms", () => { + const defs = { + PublicEvent: { type: "object" as const, properties: { type: { const: "pub" } } }, + }; + const variants: JSONSchema7[] = [{ $ref: "#/definitions/PublicEvent" }]; + const { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + variants, + makeCollections(defs) + ); + expect(publicVariants).toHaveLength(1); + expect(excludedDefinitionNames.size).toBe(0); + }); + + it("excludes arms whose arm object is marked visibility:internal", () => { + const defs = { + InternalEvent: { + type: "object" as const, + visibility: "internal", + properties: { type: { const: "internal.evt" } }, + } as JSONSchema7 & { visibility: string }, + }; + const variants: JSONSchema7[] = [ + { $ref: "#/definitions/InternalEvent", visibility: "internal" } as JSONSchema7 & { + visibility: string; + }, + ]; + const { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + variants, + makeCollections(defs) + ); + expect(publicVariants).toHaveLength(0); + expect(excludedDefinitionNames.has("InternalEvent")).toBe(true); + }); + + it("excludes arms whose resolved definition is marked visibility:internal", () => { + const defs = { + InternalEvent: { + type: "object" as const, + visibility: "internal", + properties: { type: { const: "internal.evt" } }, + } as JSONSchema7 & { visibility: string }, + }; + // arm object itself is NOT marked, but the resolved definition is + const variants: JSONSchema7[] = [{ $ref: "#/definitions/InternalEvent" }]; + const { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + variants, + makeCollections(defs) + ); + expect(publicVariants).toHaveLength(0); + expect(excludedDefinitionNames.has("InternalEvent")).toBe(true); + }); + + it("excludes arms whose internal data sub-property is the only internal marker (legacy pattern)", () => { + // Event types that carry a `data: InternalData` field — the `data` property is what is + // internal, not the event wrapper type itself. + const defs = { + InternalData: { + type: "object" as const, + visibility: "internal", + } as JSONSchema7 & { visibility: string }, + WrapperEvent: { + type: "object" as const, + properties: { + type: { const: "wrapper.evt" }, + data: { $ref: "#/definitions/InternalData" }, + }, + }, + }; + const variants: JSONSchema7[] = [{ $ref: "#/definitions/WrapperEvent" }]; + const { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + variants, + makeCollections(defs) + ); + expect(publicVariants).toHaveLength(0); + expect(excludedDefinitionNames.has("WrapperEvent")).toBe(true); + expect(excludedDefinitionNames.has("InternalData")).toBe(true); + }); +}); + +describe("assertNoPublicInternalReferences", () => { + it("passes when all declarations are public and do not reference internal types", () => { + const ts = ` +export interface Foo { + bar: string; +} +export type Bar = "a" | "b"; +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); + + it("passes when the only reference is from an @internal-tagged declaration", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +/** @internal */ +export interface AlsoInternal { + h: Hidden; +} +export interface Public { + y: string; +} +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); + + it("passes when the reference is inside an @internal-tagged member of a public type", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +export interface Public { + /** + * Some field. + * @internal + */ + secret?: Hidden; + visible: string; +} +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); + + it("throws when a public declaration references an internal type directly", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +export type Event = PublicEvent | Hidden; +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).toThrow( + /Event \(public\) references internal type Hidden/ + ); + }); + + it("throws when a public interface member references an internal type", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +export interface Public { + value: Hidden; +} +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).toThrow( + /Public \(public\) references internal type Hidden/ + ); + }); + + it("does not count JSDoc comment text as a code reference", () => { + // The auto-generated JSDoc says 'via the definition "Hidden"' but that is not a + // real TypeScript type reference — it must not trigger the validator. + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +export interface Preceding { + y: string; +} +/** + * This interface was referenced by something. + * via the definition "Hidden". + */ +export interface Following { + z: string; +} +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); + + it("does not count inline object-shaped @internal members as public references", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +export interface Public { + /** + * Some field. + * @internal + */ + secret?: { + [k: string]: Hidden | undefined; + }; + visible: string; +} +`; + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); + + it("does not count function body references as public type references", () => { + const ts = ` +/** @internal */ +export interface Hidden { + x: number; +} +/** @internal */ +export function doInternal(connection: unknown): void { + connection.onRequest("x", async (params: Hidden) => { return params; }); +} +export function doPublic(connection: unknown): void { + connection.onRequest("x", async (params: Hidden) => { return params; }); +} +`; + // function body references are stripped — only signature matters + expect(() => assertNoPublicInternalReferences(ts, new Set(["Hidden"]))).not.toThrow(); + }); }); diff --git a/nodejs/vitest.config.ts b/nodejs/vitest.config.ts index 03f6c779e..bb07cb017 100644 --- a/nodejs/vitest.config.ts +++ b/nodejs/vitest.config.ts @@ -1,11 +1,13 @@ import { defineConfig } from "vitest/config"; +const integrationTestTimeout = process.platform === "win32" ? 60000 : 30000; + export default defineConfig({ test: { globals: true, environment: "node", - testTimeout: 30000, // 30 seconds for integration tests - hookTimeout: 30000, + testTimeout: integrationTestTimeout, + hookTimeout: integrationTestTimeout, teardownTimeout: 10000, isolate: true, // Run each test file in isolation pool: "forks", // Use process forking for better isolation diff --git a/python/.gitignore b/python/.gitignore index 8eb101ca3..671fe9a8b 100644 --- a/python/.gitignore +++ b/python/.gitignore @@ -169,6 +169,3 @@ uv.lock # Build script caches .cli-cache/ .build-temp/ - -# Bundled CLI binary (only in platform wheels, not in repo) -copilot/bin/ diff --git a/python/README.md b/python/README.md index 6445ed1e9..bb17f68cc 100644 --- a/python/README.md +++ b/python/README.md @@ -2,16 +2,62 @@ Python SDK for programmatic control of GitHub Copilot CLI via JSON-RPC. -> **Note:** This SDK is in public preview and may change in breaking ways. +## Prerequisites + +To use the SDK, you'll need: + +- Python 3.11+ ## Installation ```bash -pip install -e ".[telemetry,dev]" -# or -uv pip install -e ".[telemetry,dev]" +pip install github-copilot-sdk +``` + +To include OpenTelemetry support: + +```bash +pip install "github-copilot-sdk[telemetry]" ``` +## Runtime + +Published wheels include a pinned runtime version. After installing, download the +runtime: + +```bash +python -m copilot download-runtime +``` + +This caches the runtime binary locally. If you skip this step, the SDK will +attempt to download it automatically on first use as a fallback. + +To pre-provision the native library required by the in-process (FFI) transport +(see [In-process (FFI) transport](#in-process-ffi-transport)), pass `--in-process`: + +```bash +python -m copilot download-runtime --in-process +``` + +This additionally fetches the native runtime library into the versioned runtime +cache. Stdio/TCP users never download it. When omitted, it is downloaded +lazily on first use of the in-process transport. + +| Platform | Cache path | +|----------|-----------| +| Linux | `~/.cache/github-copilot-sdk/cli//copilot` | +| macOS | `~/Library/Caches/github-copilot-sdk/cli//copilot` | +| Windows | `%LOCALAPPDATA%\github-copilot-sdk\cli\\copilot.exe` | + +### Environment variables + +| Variable | Description | +|----------|-------------| +| `COPILOT_CLI_PATH` | Use this specific binary instead of downloading | +| `COPILOT_CLI_EXTRACT_DIR` | Override the cache directory (binary placed directly here) | +| `COPILOT_SKIP_CLI_DOWNLOAD` | Set to `1` to disable auto-download | +| `COPILOT_CLI_DOWNLOAD_BASE_URL` | Override the GitHub Releases download URL | + ## Run the Sample Try the interactive chat sample (from the repo root): @@ -27,9 +73,10 @@ python chat.py import asyncio from copilot import CopilotClient -from copilot.generated.session_events import AssistantMessageData, SessionIdleData +from copilot.session_events import AssistantMessageData, SessionIdleData from copilot.session import PermissionHandler + async def main(): # Client automatically starts on enter and cleans up on exit async with CopilotClient() as client: @@ -54,6 +101,7 @@ async def main(): await session.send("What is 2+2?") await done.wait() + asyncio.run(main()) ``` @@ -65,14 +113,15 @@ If you need more control over the lifecycle, you can call `start()`, `stop()`, a import asyncio from copilot import CopilotClient -from copilot.generated.session_events import AssistantMessageData, SessionIdleData +from copilot.session_events import AssistantMessageData, SessionIdleData from copilot.session import PermissionHandler + async def main(): client = CopilotClient() await client.start() - # Create a session (on_permission_request is optional; approve_all allows every tool) + # approve_all is only valid when managed settings are disabled. session = await client.create_session( on_permission_request=PermissionHandler.approve_all, model="gpt-5", @@ -95,13 +144,14 @@ async def main(): await session.disconnect() await client.stop() + asyncio.run(main()) ``` ## Features - ✅ Full JSON-RPC protocol support -- ✅ stdio and TCP transports +- ✅ stdio, TCP, and in-process (FFI) transports - ✅ Real-time streaming events - ✅ Session history with `get_events()` - ✅ Type hints throughout @@ -121,6 +171,7 @@ async with CopilotClient() as client: on_permission_request=PermissionHandler.approve_all, model="gpt-5", ) as session: + def on_event(event): print(f"Event: {event.type}") @@ -149,8 +200,9 @@ CopilotClient(connection=..., log_level="debug", github_token=..., ...) All options are kw-only parameters: - `connection` (RuntimeConnection | None): How to reach the runtime. Use - `RuntimeConnection.for_stdio(...)`, `RuntimeConnection.for_tcp(...)`, or - `RuntimeConnection.for_uri(...)`. Defaults to a stdio connection with the bundled binary. + `RuntimeConnection.for_stdio(...)`, `RuntimeConnection.for_tcp(...)`, + `RuntimeConnection.for_uri(...)`, or `RuntimeConnection.for_inprocess(...)`. + Defaults to a stdio connection with the bundled binary. - `working_directory` (str | None): Working directory for the CLI process (default: current dir). - `log_level` (str): Log level (default: "info"). - `env` (dict | None): Environment variables for the CLI process. @@ -158,30 +210,81 @@ All options are kw-only parameters: - `base_directory` (str | None): Base directory for Copilot data (session state, config, etc.). Sets `COPILOT_HOME` on the spawned CLI process. When `None`, the CLI defaults to `~/.copilot`. Useful in restricted environments where only specific directories are writable. Ignored when using a `UriRuntimeConnection`. - `use_logged_in_user` (bool | None): Whether to use logged-in user for authentication (default: True, but False when `github_token` is provided). - `telemetry` (dict | None): OpenTelemetry configuration for the CLI process. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below. +- `session_fs` (dict | None): Connection-level session filesystem provider configuration. +- `session_idle_timeout_seconds` (int | None): Server-wide session idle timeout in seconds. Set to `None` or `0` to disable. - `enable_remote_sessions` (bool): Enable remote/cloud session support (default: False). - `on_list_models` (callable | None): Custom handler for `list_models()`. When provided, the handler is called instead of querying the runtime. +- `mode` (str): Client mode (default: `"copilot-cli"`). **RuntimeConnection variants:** - `RuntimeConnection.for_stdio(path=None, args=None)` — spawn a local CLI process and talk over stdio. - `RuntimeConnection.for_tcp(port=0, connection_token=None, path=None, args=None)` — spawn a local CLI in TCP mode. - `RuntimeConnection.for_uri(url, connection_token=None)` — connect to an existing CLI server (e.g. `"localhost:8080"`). +- `RuntimeConnection.for_inprocess()` — host the runtime in-process via its native C ABI (FFI). See [In-process (FFI) transport](#in-process-ffi-transport). + +Child-process connections (`for_stdio`/`for_tcp`) also expose a per-connection +`env` field for the spawned process. Set it on the returned connection instead of +the client-level `env` — setting both raises: + +```python +conn = RuntimeConnection.for_stdio() +conn.env = {"MY_VAR": "value"} +client = CopilotClient(connection=conn) # do NOT also pass env=... here +``` + +### In-process (FFI) transport + +> ⚠️ **Experimental.** The in-process transport loads the runtime's native shared +> library into your process and drives JSON-RPC over its C ABI (via stdlib +> `ctypes`), instead of spawning a child process. + +```python +from copilot import CopilotClient, RuntimeConnection + +client = CopilotClient(connection=RuntimeConnection.for_inprocess()) +await client.start() +try: + pong = await client.ping("hello") + print(pong.message) +finally: + await client.stop() +``` + +**Requirements & behavior:** + +- Pre-provision the native runtime with + `python -m copilot download-runtime --in-process`, or let the SDK download it + lazily on first use of this transport. +- Set `COPILOT_CLI_PATH` only when using an externally provisioned compatible + runtime package. In-process connections do not accept per-connection paths + or raw process arguments. +- Because the runtime shares this single host process, per-client options that + lower to environment variables or a working directory **cannot** be honored and + are rejected: `env`, `telemetry`, and `working_directory` all raise `ValueError` + with `for_inprocess()`. Set the corresponding values on the host process + environment / working directory before creating the client instead. +- Set `COPILOT_SDK_DEFAULT_CONNECTION=inprocess` to select the in-process + transport by default when no explicit `connection` is supplied. **`CopilotClient.create_session()`:** These are passed as keyword arguments to `create_session()`: - `model` (str): Model to use ("gpt-5", "claude-sonnet-4.5", etc.). **Required when using custom provider.** -- `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. +- `reasoning_effort` (str): Reasoning effort level for models that support it ("low", "medium", "high", "xhigh", "max"). Use `list_models()` to check which models support this option. - `session_id` (str): Custom session ID - `tools` (list): Custom tools exposed to the CLI. Tools with `handler=None` are declaration-only and must be resolved via pending tool-call RPCs. - `system_message` (SystemMessageConfig): System message configuration - `streaming` (bool): Enable streaming delta events - `provider` (ProviderConfig): Custom API provider configuration (BYOK). See [Custom Providers](#custom-providers) section. - `infinite_sessions` (InfiniteSessionConfig): Automatic context compaction configuration -- `on_permission_request` (callable): Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. Use `PermissionHandler.approve_all` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section. +- `working_directory` (str | None): Working directory for the session (default: runtime process working directory). +- `enable_session_store` (bool): Enables the cross-session store for search and retrieval across sessions. When unset in `"copilot-cli"` mode, the runtime default applies (enabled). In `"empty"` mode, defaults to disabled. +- `on_permission_request` (callable): Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. `PermissionHandler.approve_all` approves requests when managed settings are disabled and raises an error when `enable_managed_settings` is true. Custom handlers can inspect `managed_approval_required` for human-facing confirmation logic. See [Permission Handling](#permission-handling) section. - `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. - `hooks` (SessionHooks): Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section. +- `available_tools` / `excluded_tools` / `default_agent.excluded_tools` / custom-agent `tools`: MCP tools registered from `mcp_servers` are exposed to the runtime as `-`. For `available_tools` and `excluded_tools`, prefer `ToolSet().add_mcp("-")` or the raw `mcp:-` form. For custom-agent `tools` and `default_agent.excluded_tools`, use `-` directly. **Session Lifecycle Methods:** @@ -192,14 +295,18 @@ session_id = await client.get_foreground_session_id() # Request TUI to display a specific session (TUI+server mode only) await client.set_foreground_session_id("session-123") + # Subscribe to all lifecycle events def on_lifecycle(event): print(f"{event.type}: {event.session_id}") + unsubscribe = client.on_lifecycle(on_lifecycle) # Subscribe to specific event type -unsubscribe = client.on_lifecycle("session.foreground", lambda e: print(f"Foreground: {e.session_id}")) +unsubscribe = client.on_lifecycle( + "session.foreground", lambda e: print(f"Foreground: {e.session_id}") +) # Later, to stop receiving events: unsubscribe() @@ -221,14 +328,17 @@ Define tools with automatic JSON schema generation using the `@define_tool` deco from pydantic import BaseModel, Field from copilot import CopilotClient, define_tool + class LookupIssueParams(BaseModel): id: str = Field(description="Issue identifier") + @define_tool(description="Fetch issue details from our tracker") async def lookup_issue(params: LookupIssueParams) -> str: issue = await fetch_issue(params.id) return issue.summary + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, model="gpt-5", @@ -248,6 +358,7 @@ from copilot import CopilotClient from copilot.tools import Tool, ToolInvocation, ToolResult from copilot.session import PermissionHandler + async def lookup_issue(invocation: ToolInvocation) -> ToolResult: issue_id = invocation.arguments["id"] issue = await fetch_issue(issue_id) @@ -257,6 +368,7 @@ async def lookup_issue(invocation: ToolInvocation) -> ToolResult: session_log=f"Fetched issue {issue_id}", ) + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, model="gpt-5", @@ -314,6 +426,16 @@ async def safe_lookup(params: LookupParams) -> str: # your logic ``` +#### Deferring Tools + +Set `defer` to control whether a tool may be loaded lazily via tool search rather than always pre-loaded. Use `"auto"` to allow the tool to be deferred and surfaced through tool search, or `"never"` to force it to always be pre-loaded. Defaults to `"auto"`. + +```python +@define_tool(name="lookup_issue", description="Fetch issue details", defer="auto") +async def lookup_issue(params: LookupParams) -> str: + # your logic +``` + ## Image Support The 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: @@ -357,7 +479,7 @@ Enable streaming to receive assistant response chunks as they're generated: import asyncio from copilot import CopilotClient -from copilot.generated.session_events import ( +from copilot.session_events import ( AssistantMessageData, AssistantMessageDeltaData, AssistantReasoningData, @@ -366,6 +488,7 @@ from copilot.generated.session_events import ( ) from copilot.session import PermissionHandler + async def main(): async with CopilotClient() as client: async with await client.create_session( @@ -402,6 +525,7 @@ async def main(): await session.send("Tell me a short story") await done.wait() # Wait for streaming to complete + asyncio.run(main()) ``` @@ -454,6 +578,22 @@ When enabled, sessions emit compaction events: - `session.compaction_start` - Background compaction started - `session.compaction_complete` - Compaction finished (includes token counts) +## Memory + +Sessions can opt into persistent memory, allowing the agent to read and write memory across turns. Memory is configured per session and applies to both `create_session` and `resume_session`. +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```python +async with await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5", + memory={"enabled": True}, +) as session: + ... +``` + +When `memory` is omitted, no memory configuration is sent and the runtime default applies. In the default `"copilot-cli"` client mode the SDK leaves `memory` unset so the runtime applies its own default, while `"empty"` mode defaults `memory` to disabled unless you set it explicitly. + ## Custom Providers The 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. @@ -465,7 +605,7 @@ The SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own K - `api_key` (str): API key (optional for local providers like Ollama) - `bearer_token` (str): Bearer token for authentication (takes precedence over `api_key`) - `wire_api` (str): API format for OpenAI/Azure - `"completions"` or `"responses"` (default: `"completions"`) -- `azure` (dict): Azure-specific options with `api_version` (default: `"2024-10-21"`) +- `azure` (dict): Azure-specific options with `api_version`; when omitted, the runtime uses the GA versionless `v1` route **Example with Ollama:** @@ -525,6 +665,91 @@ async with await client.create_session( > - For Azure OpenAI endpoints (`*.openai.azure.com`), you **must** use `type: "azure"`, not `type: "openai"`. > - 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. +## System Message Customization + +Control the system prompt using `system_message` in session config: + +```python +async with await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5", + system_message={ + "mode": "append", + "content": """ + +- Always check for security vulnerabilities +- Suggest performance improvements when applicable + +""", + }, +) as session: + ... +``` + +### Customize Mode + +Use `mode: "customize"` to selectively override individual sections of the prompt while preserving the rest: + +```python +async with await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5", + system_message={ + "mode": "customize", + "sections": { + "tone": { + "action": "replace", + "content": "Respond in a warm, professional tone. Be thorough in explanations.", + }, + "code_change_rules": {"action": "remove"}, + "guidelines": {"action": "append", "content": "\n* Always cite data sources"}, + }, + "content": "Focus on financial analysis and reporting.", + }, +) as session: + ... +``` + +Available section IDs: `"preamble"`, `"identity"`, `"tone"`, `"tool_efficiency"`, `"environment_context"`, `"code_change_rules"`, `"guidelines"`, `"safety"`, `"tool_instructions"`, `"custom_instructions"`, `"runtime_instructions"`, `"last_instructions"`. `"identity"` and `"tool_instructions"` are section groups that target a collection of related sub-sections as a unit; use `"preamble"` to target just the identity preamble. + +Each section override supports five string actions: `"replace"`, `"remove"`, `"append"`, `"prepend"`, and `"preserve"` (a no-op that opts an individually-addressable section out of a group-level `"remove"`). Unknown section IDs are handled gracefully: content from `"replace"`/`"append"`/`"prepend"` overrides is appended to additional instructions, and `"remove"` overrides are silently ignored. + +You can also pass a transform callback as the `action` instead of a string. The callback receives the current section content and returns the new content (sync or async): + +```python +def redact_paths(content: str) -> str: + return content.replace("/home/user", "/***") + + +async with await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5", + system_message={ + "mode": "customize", + "sections": { + "environment_context": {"action": redact_paths}, + }, + }, +) as session: + ... +``` + +### Replace Mode + +For full control (removes all SDK guardrails including security restrictions), use `mode: "replace"`: + +```python +async with await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5", + system_message={ + "mode": "replace", + "content": "You are a helpful assistant.", + }, +) as session: + ... +``` + ## Telemetry The SDK supports OpenTelemetry for distributed tracing. Provide a `telemetry` config to enable trace export and automatic W3C Trace Context propagation. @@ -542,6 +767,7 @@ client = CopilotClient( **TelemetryConfig options:** - `otlp_endpoint` (str): OTLP HTTP endpoint URL +- `otlp_protocol` (str): OTLP HTTP protocol for all signals (`"http/json"` or `"http/protobuf"`) - `file_path` (str): File path for JSON-lines trace output - `exporter_type` (str): `"otlp-http"` or `"file"` - `source_name` (str): Instrumentation scope name @@ -549,7 +775,7 @@ client = CopilotClient( Trace 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. -Install with telemetry extras: `pip install copilot-sdk[telemetry]` (provides `opentelemetry-api`) +Install with telemetry extras: `pip install "github-copilot-sdk[telemetry]"` (provides `opentelemetry-api`) ## Permission Handling @@ -557,7 +783,7 @@ An `on_permission_request` handler is optional when you create or resume a sessi ### Approve All (simplest) -Use the built-in `PermissionHandler.approve_all` helper to allow every tool call without any checks: +Use the built-in `PermissionHandler.approve_all` helper to approve ordinary permission requests automatically: ```python from copilot import CopilotClient @@ -569,22 +795,25 @@ session = await client.create_session( ) ``` +When `enable_managed_settings` is true for the session, `approve_all` raises an error. Use a custom handler for managed sessions; request-level `managed_approval_required` remains available for human-facing confirmation logic. + ### Custom Permission Handler -Provide your own function to inspect each request and apply custom logic (sync or async): +Provide your own function to inspect each request and apply custom logic (sync or async). Check `managed_approval_required` before any automatic approval: ```python -from copilot import PermissionRequest, PermissionRequestResult -from copilot.generated.rpc import ( +from copilot import PermissionNoResult, PermissionRequest, PermissionRequestResult +from copilot.rpc import ( PermissionDecisionApproveOnce, PermissionDecisionReject, ) -from copilot.generated.session_events import PermissionRequestShell +from copilot.session_events import PermissionRequestShell -def on_permission_request( - request: PermissionRequest, invocation: dict -) -> PermissionRequestResult: +def on_permission_request(request: PermissionRequest, invocation: dict) -> PermissionRequestResult: + if getattr(request, "managed_approval_required", False) is True: + return PermissionNoResult() + # ``PermissionRequest`` is a discriminated union — pattern-match on # the variant class to access the per-kind fields. match request: @@ -607,6 +836,9 @@ Async handlers are also supported: async def on_permission_request( request: PermissionRequest, invocation: dict ) -> PermissionRequestResult: + if getattr(request, "managed_approval_required", False) is True: + return PermissionNoResult() + # Simulate an async approval check (e.g., prompting a user over a network) await asyncio.sleep(0) return PermissionDecisionApproveOnce() @@ -616,7 +848,8 @@ async def on_permission_request( The handler returns a ``PermissionRequestResult``, which is an alias for ``PermissionDecision | PermissionNoResult`` (the generated wire-level -union of every decision variant, plus a small sentinel for v1 servers). +union of every decision variant, plus a sentinel that suppresses this SDK +client's response). Approval decisions are present-tense — they describe the decision to apply, not the past-tense outcome reported back on `permission.completed` session events. @@ -626,12 +859,12 @@ session events. | `PermissionDecisionApproveOnce()` | Allow this single request | | `PermissionDecisionReject(feedback="…")` | Deny the request (optional feedback string forwarded to the LLM) | | `PermissionDecisionUserNotAvailable()` | Deny the request because no user is available to confirm it (the default) | -| `PermissionNoResult()` | Leave the request unanswered (only valid with protocol v1; rejected by protocol v2 servers) | +| `PermissionNoResult()` | During event-based dispatch, suppress this SDK client's response so another connected client can answer the pending request; legacy direct callbacks cannot abstain | Several richer variants (``PermissionDecisionApproveForSession``, ``PermissionDecisionApproveForLocation``, ``PermissionDecisionApprovePermanently``, …) are available for granting longer-lived approvals; see the generated -``copilot.generated.rpc`` module for the full list. +``copilot.rpc`` module for the full list. ### Resuming Sessions @@ -668,6 +901,7 @@ async def handle_user_input(request, invocation): "wasFreeform": True, # Whether the answer was freeform (not from choices) } + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, model="gpt-5", @@ -690,12 +924,14 @@ async def on_pre_tool_use(input, invocation): "additionalContext": "Extra context for the model", } + async def on_post_tool_use(input, invocation): print(f"Tool {input['toolName']} completed") return { "additionalContext": "Post-execution notes", } + async def on_post_tool_use_failure(input, invocation): # Fires when a tool's result was a failure. `on_post_tool_use` only fires # on success, so register this handler to observe failed tool calls. The @@ -705,27 +941,32 @@ async def on_post_tool_use_failure(input, invocation): "additionalContext": f"Retry guidance for {input['toolName']}", } + async def on_user_prompt_submitted(input, invocation): print(f"User prompt: {input['prompt']}") return { "modifiedPrompt": input["prompt"], # Optionally modify the prompt } + async def on_session_start(input, invocation): print(f"Session started from: {input['source']}") # "startup", "resume", "new" return { "additionalContext": "Session initialization context", } + async def on_session_end(input, invocation): print(f"Session ended: {input['reason']}") + async def on_error_occurred(input, invocation): print(f"Error in {input['errorContext']}: {input['error']}") return { "errorHandling": "retry", # "retry", "skip", or "abort" } + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, model="gpt-5", @@ -759,6 +1000,7 @@ Register slash commands that users can invoke from the CLI TUI. When the user ty ```python from copilot.session import CommandDefinition, CommandContext, PermissionHandler + async def handle_deploy(ctx: CommandContext) -> None: print(f"Deploying with args: {ctx.args}") # ctx.session_id — the session where the command was invoked @@ -766,6 +1008,7 @@ async def handle_deploy(ctx: CommandContext) -> None: # ctx.command_name — command name without leading / (e.g. "deploy") # ctx.args — raw argument string (e.g. "production") + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, commands=[ @@ -827,11 +1070,14 @@ Shows a text input dialog with optional constraints: name = await session.ui.input("Enter your name:") # With options -email = await session.ui.input("Enter email:", { - "title": "Email Address", - "description": "We'll use this for notifications", - "format": "email", -}) +email = await session.ui.input( + "Enter email:", + { + "title": "Email Address", + "description": "We'll use this for notifications", + "format": "email", + }, +) ``` ### Custom Elicitation @@ -839,17 +1085,19 @@ email = await session.ui.input("Enter email:", { For full control, use the `elicitation()` method with a custom JSON schema: ```python -result = await session.ui.elicitation({ - "message": "Configure deployment", - "requestedSchema": { - "type": "object", - "properties": { - "region": {"type": "string", "enum": ["us-east-1", "eu-west-1"]}, - "replicas": {"type": "number", "minimum": 1, "maximum": 10}, +result = await session.ui.elicitation( + { + "message": "Configure deployment", + "requestedSchema": { + "type": "object", + "properties": { + "region": {"type": "string", "enum": ["us-east-1", "eu-west-1"]}, + "replicas": {"type": "number", "minimum": 1, "maximum": 10}, + }, + "required": ["region"], }, - "required": ["region"], - }, -}) + } +) if result["action"] == "accept": region = result["content"]["region"] @@ -863,6 +1111,7 @@ When the server (or an MCP tool) needs to ask the end-user a question, it sends ```python from copilot.session import ElicitationContext, ElicitationResult, PermissionHandler + async def handle_elicitation( context: ElicitationContext, ) -> ElicitationResult: @@ -879,6 +1128,7 @@ async def handle_elicitation( "content": {"answer": "yes"}, } + async with await client.create_session( on_permission_request=PermissionHandler.approve_all, on_elicitation_request=handle_elicitation, @@ -893,7 +1143,22 @@ When `on_elicitation_request` is provided, the SDK automatically: - Dispatches `elicitation.requested` events to your handler - Auto-cancels if your handler throws an error (so the server doesn't hang) -## Requirements +## Development -- Python 3.11+ -- GitHub Copilot CLI installed and accessible +Install [uv](https://docs.astral.sh/uv/) and a supported [Node.js version](../nodejs/README.md#prerequisites), then from the repository root: + +```bash +cd nodejs +npm ci +``` + +```bash +cd test/harness +npm ci +``` + +```bash +cd python +uv sync +uv run pytest +``` diff --git a/python/copilot/__init__.py b/python/copilot/__init__.py index 5f51cf021..f7a71ebe9 100644 --- a/python/copilot/__init__.py +++ b/python/copilot/__init__.py @@ -4,6 +4,13 @@ JSON-RPC based SDK for programmatic control of GitHub Copilot CLI """ +from importlib.metadata import PackageNotFoundError +from importlib.metadata import version as _pkg_version + +from . import rpc as rpc # noqa: F401 -- register the public ``copilot.rpc`` namespace + +# Register the public ``copilot.session_events`` namespace. +from . import session_events as session_events # noqa: F401 from ._mode import ( BUILTIN_TOOLS_ISOLATED, CopilotClientMode, @@ -17,28 +24,32 @@ CanvasHostContext, CanvasHostContextCapabilities, CanvasJsonSchema, + CanvasProviderIdentity, ExtensionInfo, OpenCanvasInstance, ) from .client import ( + CapiSessionOptions, ChildProcessRuntimeConnection, CloudSessionOptions, CloudSessionRepository, CopilotClient, + CopilotExpAssignmentResponse, + ExpConfigEntry, + ExpFlagValue, GetAuthStatusResponse, GetStatusResponse, + InProcessRuntimeConnection, LogLevel, + ManagedSettings, + ManagedSettingsPermissions, ModelBilling, ModelCapabilities, - ModelCapabilitiesOverride, ModelInfo, ModelLimits, - ModelLimitsOverride, ModelPolicy, ModelSupports, - ModelSupportsOverride, ModelVisionLimits, - ModelVisionLimitsOverride, PingResponse, RemoteSessionMode, RuntimeConnection, @@ -61,15 +72,40 @@ TelemetryConfig, UriRuntimeConnection, ) +from .copilot_request_handler import ( + CopilotRequestContext, + CopilotRequestHandler, + CopilotWebSocketCloseStatus, + CopilotWebSocketForwarder, + CopilotWebSocketHandler, + LlmInferenceHeaders, +) +from .generated.rpc import ( + CurrentToolMetadata, + GitHubTelemetryClientInfo, + GitHubTelemetryEvent, + GitHubTelemetryNotification, + ModelBillingTokenPrices, + ModelBillingTokenPricesLongContext, + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, +) from .generated.session_events import ( PermissionRequest, SessionEvent, SessionEventType, ) from .session import ( + AgentStopHandler, + AgentStopHookInput, + AgentStopHookOutput, + AttributedPermissionResult, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, + BearerTokenProvider, CommandContext, CommandDefinition, CopilotSession, @@ -84,12 +120,25 @@ ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, + GitHubMcpToolConfig, InfiniteSessionConfig, InputOptions, LargeToolOutputConfig, + McpAuthContext, + McpAuthHandler, + McpAuthRequest, + McpAuthResult, + McpAuthStaticClientConfig, + McpAuthToken, + McpAuthWwwAuthenticateParams, MCPHTTPServerConfig, MCPServerConfig, MCPStdioServerConfig, + ModelCapabilitiesOverride, + ModelLimitsOverride, + ModelSupportsOverride, + ModelVisionLimitsOverride, + NamedProviderConfig, PermissionHandler, PermissionNoResult, PermissionRequestResult, @@ -106,6 +155,8 @@ PreToolUseHookInput, PreToolUseHookOutput, ProviderConfig, + ProviderModelConfig, + ProviderTokenArgs, ReasoningSummary, SessionCapabilities, SessionEndHandler, @@ -115,24 +166,31 @@ SessionFsCapabilities, SessionFsConfig, SessionHooks, + SessionLimitsConfig, SessionStartHandler, SessionStartHookInput, SessionStartHookOutput, SessionUiApi, SessionUiCapabilities, SystemMessageConfig, + ToolSearchConfig, UserInputHandler, UserInputRequest, UserInputResponse, UserPromptSubmittedHandler, UserPromptSubmittedHookInput, UserPromptSubmittedHookOutput, + UserPromptTransformedHandler, + UserPromptTransformedHookInput, + UserPromptTransformedHookOutput, + create_attributed_permission_result, ) from .session_fs_provider import ( SessionFsFileInfo, SessionFsProvider, SessionFsSqliteProvider, SessionFsSqliteQueryResult, + SessionFsSqliteTransactionFailure, create_session_fs_adapter, ) from .tools import ( @@ -145,9 +203,19 @@ define_tool, ) -__version__ = "0.1.0" +try: + __version__ = _pkg_version("github-copilot-sdk") +except PackageNotFoundError: + # No installed package metadata (e.g. running from a source checkout that + # was never installed). Use a sentinel that can never masquerade as a real + # release rather than a hardcoded version that would silently go stale. + __version__ = "0.0.0.dev0" __all__ = [ + "AgentStopHandler", + "AgentStopHookInput", + "AgentStopHookOutput", + "AttributedPermissionResult", "AutoModeSwitchHandler", "AutoModeSwitchRequest", "AutoModeSwitchResponse", @@ -159,6 +227,8 @@ "CanvasHostContext", "CanvasHostContextCapabilities", "CanvasJsonSchema", + "CanvasProviderIdentity", + "CapiSessionOptions", "ChildProcessRuntimeConnection", "CloudSessionOptions", "CloudSessionRepository", @@ -166,8 +236,14 @@ "CommandDefinition", "CopilotClient", "CopilotClientMode", + "CopilotExpAssignmentResponse", "CopilotSession", + "CopilotRequestContext", + "CopilotRequestHandler", + "CopilotWebSocketCloseStatus", + "CopilotWebSocketHandler", "CreateSessionFsHandler", + "CurrentToolMetadata", "ElicitationContext", "ElicitationHandler", "ElicitationParams", @@ -175,20 +251,41 @@ "ErrorOccurredHandler", "ErrorOccurredHookInput", "ErrorOccurredHookOutput", + "ExpConfigEntry", + "ExpFlagValue", "ExitPlanModeHandler", "ExitPlanModeRequest", "ExitPlanModeResult", "ExtensionInfo", + "CopilotWebSocketForwarder", "GetAuthStatusResponse", + "BearerTokenProvider", "GetStatusResponse", + "GitHubMcpToolConfig", + "GitHubTelemetryClientInfo", + "GitHubTelemetryEvent", + "GitHubTelemetryNotification", "InfiniteSessionConfig", + "InProcessRuntimeConnection", "InputOptions", "LargeToolOutputConfig", + "LlmInferenceHeaders", "LogLevel", "MCPHTTPServerConfig", "MCPServerConfig", "MCPStdioServerConfig", + "McpAuthContext", + "McpAuthHandler", + "McpAuthRequest", + "McpAuthResult", + "McpAuthStaticClientConfig", + "McpAuthToken", + "McpAuthWwwAuthenticateParams", + "ManagedSettings", + "ManagedSettingsPermissions", "ModelBilling", + "ModelBillingTokenPrices", + "ModelBillingTokenPricesLongContext", "ModelCapabilities", "ModelCapabilitiesOverride", "ModelInfo", @@ -199,11 +296,16 @@ "ModelSupportsOverride", "ModelVisionLimits", "ModelVisionLimitsOverride", + "NamedProviderConfig", "OpenCanvasInstance", "PermissionHandler", "PermissionNoResult", "PermissionRequest", "PermissionRequestResult", + "PermissionDecisionContext", + "PermissionDecisionOutcome", + "PermissionDecisionSource", + "PermissionDecisionSurface", "PingResponse", "PostToolUseHandler", "PostToolUseFailureHandler", @@ -218,9 +320,13 @@ "PreToolUseHookInput", "PreToolUseHookOutput", "ProviderConfig", + "ProviderModelConfig", + "ProviderTokenArgs", "ReasoningSummary", "RemoteSessionMode", "RuntimeConnection", + "rpc", + "session_events", "SessionBackgroundEvent", "SessionCapabilities", "SessionContext", @@ -239,7 +345,9 @@ "SessionFsProvider", "SessionFsSqliteProvider", "SessionFsSqliteQueryResult", + "SessionFsSqliteTransactionFailure", "SessionHooks", + "SessionLimitsConfig", "SessionLifecycleEvent", "SessionLifecycleEventBase", "SessionLifecycleEventMetadata", @@ -263,6 +371,7 @@ "ToolInvocation", "ToolResult", "ToolResultType", + "ToolSearchConfig", "ToolSet", "UriRuntimeConnection", "UserInputHandler", @@ -271,7 +380,11 @@ "UserPromptSubmittedHandler", "UserPromptSubmittedHookInput", "UserPromptSubmittedHookOutput", + "UserPromptTransformedHandler", + "UserPromptTransformedHookInput", + "UserPromptTransformedHookOutput", "convert_mcp_call_tool_result", + "create_attributed_permission_result", "create_session_fs_adapter", "define_tool", ] diff --git a/python/copilot/__main__.py b/python/copilot/__main__.py new file mode 100644 index 000000000..f6a1bd034 --- /dev/null +++ b/python/copilot/__main__.py @@ -0,0 +1,6 @@ +"""Entry point for `python -m copilot`.""" + +from ._cli_download import main + +if __name__ == "__main__": + main() diff --git a/python/copilot/_cli_download.py b/python/copilot/_cli_download.py new file mode 100644 index 000000000..b831e072a --- /dev/null +++ b/python/copilot/_cli_download.py @@ -0,0 +1,557 @@ +"""Download and cache the Copilot CLI binary. + +This module implements a download-at-first-use strategy for the Copilot CLI +binary, similar to the Rust SDK's build.rs approach but triggered at runtime. +The binary is cached in a shared directory compatible with the Rust SDK: + +- Linux: ~/.cache/github-copilot-sdk/cli/{version}/copilot +- macOS: ~/Library/Caches/github-copilot-sdk/cli/{version}/copilot +- Windows: %LOCALAPPDATA%/github-copilot-sdk/cli/{version}/copilot.exe + +Environment variables: +- COPILOT_CLI_EXTRACT_DIR: Override the cache directory (binary placed directly here). +- COPILOT_SKIP_CLI_DOWNLOAD: Set to "1" or "true" to disable auto-download. +- COPILOT_CLI_DOWNLOAD_BASE_URL: Override the GitHub Releases base URL. +""" + +from __future__ import annotations + +import base64 +import hashlib +import io +import os +import re +import stat +import sys +import tarfile +import tempfile +import time +import zipfile +from pathlib import Path +from urllib.error import HTTPError, URLError +from urllib.request import urlopen + +from ._cli_version import ( + CLI_VERSION, + get_asset_info, + get_checksums_url, + get_download_url, + get_npm_platform, + get_runtime_lib_packument_url, + get_runtime_lib_url, +) + +_CACHE_DIR_NAME = "github-copilot-sdk" +_MAX_RETRIES = 3 + + +def _sanitize_version(version: str) -> str: + """Sanitize version string for use as a directory name. + + Replaces any character not in [a-zA-Z0-9._-] with underscore. + Matches the Rust SDK's sanitization logic. + """ + return re.sub(r"[^a-zA-Z0-9._\-]", "_", version) + + +def get_cache_dir(version: str | None = None) -> Path: + """Return the cache directory for CLI binaries. + + Args: + version: CLI version string. If None, returns the root cache dir. + """ + # COPILOT_CLI_EXTRACT_DIR overrides the entire version-specific directory + # (binary lives directly at $dir/, no version subdir). Matches Rust SDK. + extract_override = os.environ.get("COPILOT_CLI_EXTRACT_DIR") + if extract_override: + return Path(extract_override) + + if sys.platform == "darwin": + root = Path.home() / "Library" / "Caches" / _CACHE_DIR_NAME + elif sys.platform == "win32": + local_app_data = os.environ.get("LOCALAPPDATA") + if local_app_data: + root = Path(local_app_data) / _CACHE_DIR_NAME + else: + root = Path.home() / "AppData" / "Local" / _CACHE_DIR_NAME + else: + xdg = os.environ.get("XDG_CACHE_HOME") + if xdg: + root = Path(xdg) / _CACHE_DIR_NAME + else: + root = Path.home() / ".cache" / _CACHE_DIR_NAME + + if version: + return root / "cli" / _sanitize_version(version) + return root / "cli" + + +def get_cached_cli_path(version: str | None = None) -> str | None: + """Return the path to the cached CLI binary if it exists. + + Args: + version: CLI version. Defaults to the pinned CLI_VERSION. + + Returns: + Path to the binary, or None if not cached. + """ + ver = version or CLI_VERSION + if not ver: + return None + + try: + _, binary_name = get_asset_info() + except RuntimeError: + return None + binary_path = get_cache_dir(ver) / binary_name + + if binary_path.exists(): + return str(binary_path) + return None + + +def _should_skip_download() -> bool: + """Check if auto-download is disabled via environment variable.""" + val = os.environ.get("COPILOT_SKIP_CLI_DOWNLOAD", "").lower() + return val in ("1", "true", "yes") + + +def _fetch_checksums(version: str) -> dict[str, str]: + """Fetch and parse the SHA256SUMS.txt file. + + Returns a dict mapping filename → sha256 hex digest. + """ + url = get_checksums_url(version) + last_exc: Exception | None = None + for attempt in range(_MAX_RETRIES): + try: + with urlopen(url, timeout=30) as response: + text = response.read().decode("utf-8") + break + except (HTTPError, URLError) as exc: + last_exc = exc + if attempt < _MAX_RETRIES - 1: + time.sleep(2**attempt) + else: + raise RuntimeError( + f"Failed to download checksums from {url}: {last_exc}\n\n" + "If you are in an offline or firewalled environment, set " + "COPILOT_CLI_PATH to point to a manually-installed binary." + ) from last_exc + + checksums: dict[str, str] = {} + for line in text.strip().splitlines(): + parts = line.split() + if len(parts) == 2: + digest, filename = parts + # Some formats use *filename (binary mode indicator) + checksums[filename.lstrip("*")] = digest + return checksums + + +def _verify_checksum(data: bytes, expected_hash: str, filename: str) -> None: + """Verify SHA-256 checksum of downloaded data.""" + actual = hashlib.sha256(data).hexdigest() + if actual != expected_hash: + raise RuntimeError( + f"Checksum mismatch for {filename}:\n expected: {expected_hash}\n actual: {actual}" + ) + + +def _extract_tar_gz(data: bytes, binary_name: str, dest_dir: Path) -> Path: + """Extract the CLI binary from a .tar.gz archive.""" + with tarfile.open(fileobj=io.BytesIO(data), mode="r:gz") as tf: + # Find the binary in the archive (may be at top level or in a subdirectory) + members = tf.getnames() + target_member = None + for name in members: + if name == binary_name or name.endswith(f"/{binary_name}"): + target_member = name + break + + if target_member is None: + raise RuntimeError( + f"Binary '{binary_name}' not found in archive. Archive contains: {members}" + ) + + member = tf.getmember(target_member) + f = tf.extractfile(member) + if f is None: + raise RuntimeError(f"Could not extract '{target_member}' from archive") + + dest_path = dest_dir / binary_name + with open(dest_path, "wb") as out: + out.write(f.read()) + + return dest_path + + +def _extract_zip(data: bytes, binary_name: str, dest_dir: Path) -> Path: + """Extract the CLI binary from a .zip archive.""" + with zipfile.ZipFile(io.BytesIO(data)) as zf: + names = zf.namelist() + target_member = None + for name in names: + if name == binary_name or name.endswith(f"/{binary_name}"): + target_member = name + break + + if target_member is None: + raise RuntimeError( + f"Binary '{binary_name}' not found in archive. Archive contains: {names}" + ) + + dest_path = dest_dir / binary_name + with zf.open(target_member) as src, open(dest_path, "wb") as out: + out.write(src.read()) + + return dest_path + + +def download_cli(version: str | None = None, *, force: bool = False) -> str: + """Download the Copilot CLI binary and cache it. + + Args: + version: CLI version to download. Defaults to the pinned CLI_VERSION. + force: If True, re-download even if already cached. + + Returns: + Path to the cached binary. + + Raises: + RuntimeError: If the version is not set, download fails, or + checksum verification fails. + """ + ver = version or CLI_VERSION + if not ver: + raise RuntimeError( + "No CLI version pinned. This is a development install — " + "set COPILOT_CLI_PATH or install a published wheel." + ) + + archive_name, binary_name = get_asset_info() + cache_dir = get_cache_dir(ver) + binary_path = cache_dir / binary_name + + # Return cached binary if available (unless force) + if not force and binary_path.exists(): + return str(binary_path) + + # Fetch checksums + checksums = _fetch_checksums(ver) + expected_hash = checksums.get(archive_name) + if not expected_hash: + raise RuntimeError( + f"No checksum found for '{archive_name}' in SHA256SUMS.txt. " + f"Available files: {list(checksums.keys())}" + ) + + # Download archive with retries + url = get_download_url(ver, archive_name) + last_exc: Exception | None = None + data: bytes | None = None + for attempt in range(_MAX_RETRIES): + try: + with urlopen(url, timeout=120) as response: + data = response.read() + break + except (HTTPError, URLError) as exc: + last_exc = exc + if attempt < _MAX_RETRIES - 1: + time.sleep(2**attempt) + if data is None: + raise RuntimeError( + f"Failed to download runtime from {url}: {last_exc}\n\n" + "If you are in an offline or firewalled environment, you can:\n" + f"1. Manually download the archive from: {url}\n" + f"2. Extract the '{binary_name}' binary to: {binary_path}\n" + "Or set COPILOT_CLI_PATH to point to an existing binary." + ) from last_exc + + # Verify checksum + _verify_checksum(data, expected_hash, archive_name) + + # Extract to a temporary directory, then atomically move into place. + # This prevents partial/corrupt cache entries if the process is interrupted. + cache_dir.mkdir(parents=True, exist_ok=True) + staging_dir = Path(tempfile.mkdtemp(dir=cache_dir, prefix=".download-")) + try: + if archive_name.endswith(".tar.gz"): + extracted = _extract_tar_gz(data, binary_name, staging_dir) + elif archive_name.endswith(".zip"): + extracted = _extract_zip(data, binary_name, staging_dir) + else: + raise RuntimeError(f"Unknown archive format: {archive_name}") + + # Make executable on Unix + if sys.platform != "win32": + extracted.chmod(extracted.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH) + + # Atomic rename into final location. Handle concurrent processes: + # another process may have written the file while we were downloading. + try: + extracted.replace(binary_path) + except OSError: + if not force and binary_path.exists(): + return str(binary_path) + raise + finally: + # Clean up staging directory + try: + staging_dir.rmdir() + except OSError: + # May not be empty if rename failed or other files were extracted + import shutil + + shutil.rmtree(staging_dir, ignore_errors=True) + + return str(binary_path) + + +def _fetch_url_bytes(url: str, *, timeout: int) -> bytes: + """Download bytes from ``url`` with retries.""" + last_exc: Exception | None = None + for attempt in range(_MAX_RETRIES): + try: + with urlopen(url, timeout=timeout) as response: + return response.read() + except (HTTPError, URLError) as exc: + last_exc = exc + if attempt < _MAX_RETRIES - 1: + time.sleep(2**attempt) + raise RuntimeError(f"Failed to download from {url}: {last_exc}") from last_exc + + +def _fetch_runtime_integrity(npm_platform: str, version: str) -> str | None: + """Return the npm ``dist.integrity`` (Subresource Integrity) for the tarball. + + Best-effort: returns None if the packument can't be fetched or parsed. + """ + import json + + url = get_runtime_lib_packument_url(npm_platform) + try: + raw = _fetch_url_bytes(url, timeout=30) + packument = json.loads(raw) + dist = packument.get("versions", {}).get(version, {}).get("dist", {}) + integrity = dist.get("integrity") + return integrity if isinstance(integrity, str) else None + except (RuntimeError, ValueError, KeyError): + return None + + +def _verify_integrity(data: bytes, integrity: str) -> None: + """Verify data against an npm Subresource Integrity string (e.g. ``sha512-``).""" + algo, _, b64 = integrity.partition("-") + algo = algo.lower() + if algo not in ("sha512", "sha384", "sha256"): + # Fail closed: an unrecognized algorithm means we cannot verify this native + # library, so refuse rather than loading unverified native code. + raise RuntimeError( + f"Unsupported integrity algorithm '{algo}' for the in-process runtime " + "library; refusing to load unverified native code." + ) + expected = base64.b64decode(b64) + actual = hashlib.new(algo, data).digest() + if actual != expected: + raise RuntimeError( + f"Integrity mismatch for runtime library ({algo}): " + "downloaded tarball does not match the npm registry checksum." + ) + + +def _extract_runtime_node(data: bytes, npm_platform: str) -> bytes: + """Extract ``package/prebuilds//runtime.node`` from an npm tarball.""" + target = f"package/prebuilds/{npm_platform}/runtime.node" + with tarfile.open(fileobj=io.BytesIO(data), mode="r:gz") as tf: + for name in tf.getnames(): + if name == target or name.endswith(f"/prebuilds/{npm_platform}/runtime.node"): + member = tf.getmember(name) + extracted = tf.extractfile(member) + if extracted is not None: + return extracted.read() + raise RuntimeError(f"'{target}' not found in runtime package for {npm_platform}.") + + +def ensure_runtime_library(cli_path: str, version: str | None = None) -> str | None: + """Ensure the native in-process (FFI) runtime library sits next to ``cli_path``. + + The library is NOT part of the GitHub Releases CLI archive; it ships in the npm + platform package ``@github/copilot-`` under + ``package/prebuilds//runtime.node``. This helper downloads that tarball + and writes the library next to the CLI binary under its natural platform name + (``libcopilot_runtime.so`` / ``.dylib`` / ``copilot_runtime.dll``). + + This is opt-in — only invoked when the in-process transport is actually selected + (lazy) or via ``python -m copilot download-runtime --in-process`` (explicit). The + default stdio download path never fetches these extra bytes. + + Returns the absolute path to the library, or None if it could not be provisioned + (e.g. download disabled or unsupported platform). Raises RuntimeError on + download/verification failure. + """ + # Import lazily to avoid a hard dependency for stdio-only users. + from ._ffi_runtime_host import _natural_library_name, resolve_library_path + + # Already present (bundled prebuilds layout in dev, or a prior download)? + existing = resolve_library_path(cli_path) + if existing is not None: + return existing + + if _should_skip_download(): + return None + + ver = version or CLI_VERSION + if not ver: + return None + + try: + npm_platform = get_npm_platform() + except RuntimeError: + return None + + cli_dir = Path(cli_path).resolve().parent + lib_path = cli_dir / _natural_library_name() + if lib_path.exists(): + return str(lib_path) + + url = get_runtime_lib_url(ver, npm_platform) + data = _fetch_url_bytes(url, timeout=600) + + integrity = _fetch_runtime_integrity(npm_platform, ver) + if not integrity: + # Fail closed: this native library is loaded into the host process, so it must + # be verified before use. The npm packument (which carries dist.integrity) was + # unavailable, so refuse rather than loading unverified native code — mirroring + # the CLI download, which requires a checksum. Retry when the registry is + # reachable, or install a runtime package that ships the library. + raise RuntimeError( + "No Subresource Integrity value available for the in-process runtime " + f"library ({npm_platform}@{ver}); refusing to load unverified native code." + ) + _verify_integrity(data, integrity) + + lib_bytes = _extract_runtime_node(data, npm_platform) + + # Write atomically next to the CLI so concurrent starts don't observe a partial + # library. A rename within the same directory is atomic on POSIX and Windows. + cli_dir.mkdir(parents=True, exist_ok=True) + fd, tmp_name = tempfile.mkstemp(dir=cli_dir, prefix=".runtime-lib-") + try: + with os.fdopen(fd, "wb") as out: + out.write(lib_bytes) + os.replace(tmp_name, lib_path) + except OSError: + try: + os.unlink(tmp_name) + except OSError: + # Best-effort cleanup of the temp file; ignore if it's already gone or + # can't be removed (the OS reclaims it, and it doesn't affect correctness). + pass + if lib_path.exists(): + return str(lib_path) + raise + + return str(lib_path) + + +def get_or_download_cli(version: str | None = None) -> str | None: + """Get the cached CLI binary, downloading it if necessary. + + Returns None if: + - No version is pinned (dev install) + - Auto-download is disabled via COPILOT_SKIP_CLI_DOWNLOAD + - The platform is unsupported + + Raises RuntimeError on download/verification failures. + """ + ver = version or CLI_VERSION + if not ver: + return None + + # Check cache first + cached = get_cached_cli_path(ver) + if cached: + return cached + + # Check if download is disabled + if _should_skip_download(): + return None + + # Check platform support before attempting download + try: + get_asset_info() + except RuntimeError: + return None + + # Download + return download_cli(ver) + + +def main() -> None: + """CLI entry point for `python -m copilot download-runtime`.""" + import argparse + + parser = argparse.ArgumentParser( + prog="python -m copilot", + description="Copilot SDK utilities", + ) + subparsers = parser.add_subparsers(dest="command") + + # download-runtime subcommand + dl_parser = subparsers.add_parser( + "download-runtime", + help="Download the Copilot runtime", + ) + dl_parser.add_argument( + "--force", + action="store_true", + help="Re-download even if already cached", + ) + dl_parser.add_argument( + "--version", + help="Runtime version to download (default: pinned version)", + ) + dl_parser.add_argument( + "--in-process", + action="store_true", + help=( + "Also download the native in-process (FFI) runtime library " + "(prebuilds//runtime.node) and place it next to the CLI. " + "Only needed for the experimental in-process transport." + ), + ) + + args = parser.parse_args() + + if args.command == "download-runtime": + ver = args.version or CLI_VERSION + if not ver: + print( + "Error: No runtime version pinned (development install). " + "Use --version to specify a version.", + file=sys.stderr, + ) + sys.exit(1) + + print(f"Downloading Copilot runtime v{ver}...") + try: + path = download_cli(ver, force=args.force) + print(f"Runtime cached at: {path}") + if args.in_process: + print("Downloading in-process (FFI) runtime library...") + lib_path = ensure_runtime_library(path, ver) + if lib_path: + print(f"Runtime library cached at: {lib_path}") + else: + print( + "Warning: could not provision the in-process runtime library " + "(download disabled or unsupported platform).", + file=sys.stderr, + ) + except RuntimeError as exc: + print(f"Error: {exc}", file=sys.stderr) + sys.exit(1) + else: + parser.print_help() + sys.exit(1) diff --git a/python/copilot/_cli_version.py b/python/copilot/_cli_version.py new file mode 100644 index 000000000..cb5939820 --- /dev/null +++ b/python/copilot/_cli_version.py @@ -0,0 +1,162 @@ +"""Copilot CLI version and platform asset information. + +At publish time, CLI_VERSION is overwritten by scripts/inject-cli-version.mjs +with the concrete version string (e.g. "1.0.64-1"). In development (editable +installs, running from source) the sentinel value None disables automatic +download — callers must set an explicit path or COPILOT_CLI_PATH. +""" + +from __future__ import annotations + +import platform +import sys + +# Sentinel: None means "no pinned version" (dev/editable install). +# Overwritten at publish time by scripts/inject-cli-version.mjs. +# DO NOT reformat this line — the inject script matches it exactly. +CLI_VERSION: str | None = None + +# Maps (sys.platform, platform.machine()) → (archive filename, binary name inside archive). +PLATFORM_ASSETS: dict[tuple[str, str], tuple[str, str]] = { + ("linux", "x86_64"): ("copilot-linux-x64.tar.gz", "copilot"), + ("linux", "aarch64"): ("copilot-linux-arm64.tar.gz", "copilot"), + ("linux", "arm64"): ("copilot-linux-arm64.tar.gz", "copilot"), + ("darwin", "x86_64"): ("copilot-darwin-x64.tar.gz", "copilot"), + ("darwin", "arm64"): ("copilot-darwin-arm64.tar.gz", "copilot"), + ("win32", "AMD64"): ("copilot-win32-x64.zip", "copilot.exe"), + ("win32", "ARM64"): ("copilot-win32-arm64.zip", "copilot.exe"), +} + +# Musl (Alpine) variants — detected at runtime via _is_musl(). +_MUSL_ASSETS: dict[str, tuple[str, str]] = { + "x86_64": ("copilot-linuxmusl-x64.tar.gz", "copilot"), + "aarch64": ("copilot-linuxmusl-arm64.tar.gz", "copilot"), + "arm64": ("copilot-linuxmusl-arm64.tar.gz", "copilot"), +} + +_DOWNLOAD_BASE_URL = "https://github.com/github/copilot-cli/releases/download" + +# The native in-process (FFI) runtime library (`runtime.node`) is NOT part of the +# GitHub Releases `copilot-` archive (that ships only the CLI binary). It +# lives in the npm platform package `@github/copilot-`, under +# `package/prebuilds//runtime.node`. Mirrors the .NET SDK targets, +# which download the same npm tarball. +_NPM_REGISTRY_BASE_URL = "https://registry.npmjs.org" + +# Maps (sys.platform, platform.machine()) → npm platform name (glibc Linux/macOS/Windows). +NPM_PLATFORMS: dict[tuple[str, str], str] = { + ("linux", "x86_64"): "linux-x64", + ("linux", "aarch64"): "linux-arm64", + ("linux", "arm64"): "linux-arm64", + ("darwin", "x86_64"): "darwin-x64", + ("darwin", "arm64"): "darwin-arm64", + ("win32", "AMD64"): "win32-x64", + ("win32", "ARM64"): "win32-arm64", +} + +# Musl (Alpine) npm platform variants — detected at runtime via _is_musl(). +_MUSL_NPM_PLATFORMS: dict[str, str] = { + "x86_64": "linuxmusl-x64", + "aarch64": "linuxmusl-arm64", + "arm64": "linuxmusl-arm64", +} + + +def _is_musl() -> bool: + """Detect whether the current Linux system uses musl libc (e.g. Alpine).""" + if sys.platform != "linux": + return False + try: + import subprocess + + result = subprocess.run(["ldd", "--version"], capture_output=True, text=True, timeout=5) + # musl's ldd prints "musl libc" in its output + output = result.stdout + result.stderr + return "musl" in output.lower() + except (FileNotFoundError, subprocess.TimeoutExpired, OSError): + return False + + +def get_platform_key() -> tuple[str, str]: + """Return the (sys.platform, machine) key for the current platform.""" + return (sys.platform, platform.machine()) + + +def get_asset_info() -> tuple[str, str]: + """Return (archive_filename, binary_name) for the current platform. + + Raises RuntimeError if the platform is not supported. + """ + key = get_platform_key() + + # On Linux, check for musl/Alpine first + if key[0] == "linux" and _is_musl(): + musl_info = _MUSL_ASSETS.get(key[1]) + if musl_info: + return musl_info + + info = PLATFORM_ASSETS.get(key) + if info is None: + raise RuntimeError( + f"Unsupported platform: {key[0]}/{key[1]}. " + f"Supported platforms: {', '.join(f'{p}/{m}' for p, m in PLATFORM_ASSETS)}" + ) + return info + + +def get_download_url(version: str, archive_name: str) -> str: + """Return the download URL for a given version and archive.""" + import os + + base = os.environ.get("COPILOT_CLI_DOWNLOAD_BASE_URL", _DOWNLOAD_BASE_URL) + return f"{base}/v{version}/{archive_name}" + + +def get_checksums_url(version: str) -> str: + """Return the URL for the SHA256SUMS.txt file.""" + import os + + base = os.environ.get("COPILOT_CLI_DOWNLOAD_BASE_URL", _DOWNLOAD_BASE_URL) + return f"{base}/v{version}/SHA256SUMS.txt" + + +def get_npm_platform() -> str: + """Return the npm platform name (e.g. ``linux-x64``) for the current host. + + Used to locate the native in-process runtime library. Raises RuntimeError if + the platform is not supported. + """ + key = get_platform_key() + + if key[0] == "linux" and _is_musl(): + musl = _MUSL_NPM_PLATFORMS.get(key[1]) + if musl: + return musl + + npm_platform = NPM_PLATFORMS.get(key) + if npm_platform is None: + raise RuntimeError( + f"Unsupported platform for in-process runtime: {key[0]}/{key[1]}. " + f"Supported platforms: {', '.join(f'{p}/{m}' for p, m in NPM_PLATFORMS)}" + ) + return npm_platform + + +def get_runtime_lib_packument_url(npm_platform: str) -> str: + """Return the npm packument URL for the platform runtime package.""" + import os + + base = os.environ.get("COPILOT_NPM_REGISTRY_URL", _NPM_REGISTRY_BASE_URL).rstrip("/") + return f"{base}/@github/copilot-{npm_platform}" + + +def get_runtime_lib_url(version: str, npm_platform: str) -> str: + """Return the download URL for the platform runtime tarball. + + Mirrors the .NET targets' URL layout + ``/@github/copilot-/-/copilot--.tgz``. + """ + import os + + base = os.environ.get("COPILOT_NPM_REGISTRY_URL", _NPM_REGISTRY_BASE_URL).rstrip("/") + return f"{base}/@github/copilot-{npm_platform}/-/copilot-{npm_platform}-{version}.tgz" diff --git a/python/copilot/_ffi_runtime_host.py b/python/copilot/_ffi_runtime_host.py new file mode 100644 index 000000000..e04d1655e --- /dev/null +++ b/python/copilot/_ffi_runtime_host.py @@ -0,0 +1,514 @@ +"""In-process (FFI) hosting of the Copilot runtime. + +Instead of spawning the Copilot CLI as a child process and talking JSON-RPC over +stdio/TCP, the in-process transport loads the runtime's native shared library +(``runtime.node`` — a Rust ``cdylib``) into this process and drives JSON-RPC over +its C ABI (FFI). The native ``host_start`` export spawns the residual worker +itself, so the SDK never launches the worker directly; it only pumps opaque LSP +``Content-Length:``-framed JSON-RPC bytes across the boundary: + +- client → server frames go to ``copilot_runtime_connection_write`` +- server → client frames arrive on a native callback that feeds a thread-safe + receive buffer + +The existing :class:`~copilot._jsonrpc.JsonRpcClient` handles framing unchanged — +this is a transport swap, not a new protocol. The host exposes a *process-like* +adapter (``stdin``/``stdout``/``stderr``/``poll``) so ``JsonRpcClient`` can drive +it exactly like a :class:`subprocess.Popen`. + +The C ABI (shared with the .NET, Node.js, and Rust SDKs):: + + uint32 copilot_runtime_host_start(uint8 *argv, size_t argv_len, + uint8 *env, size_t env_len); + bool copilot_runtime_host_shutdown(uint32 server_id); + uint32 copilot_runtime_connection_open(uint32 server_id, outbound cb, + void *user_data, + uint8 *a, size_t a_len, + uint8 *b, size_t b_len, + uint8 *c, size_t c_len); + bool copilot_runtime_connection_write(uint32 conn_id, + uint8 *bytes, size_t len); + bool copilot_runtime_connection_close(uint32 conn_id); + // outbound callback: + void outbound(void *user_data, uint8 *bytes, size_t len); +""" + +from __future__ import annotations + +import ctypes +import json +import logging +import os +import sys +import threading +import time +from collections.abc import Sequence +from pathlib import Path + +logger = logging.getLogger("copilot.ffi") + +_SYMBOL_PREFIX = "copilot_runtime_" + +# The C ABI outbound callback: void(void *user_data, uint8 *bytes, size_t len). +_OutboundCallback = ctypes.CFUNCTYPE( + None, ctypes.c_void_p, ctypes.POINTER(ctypes.c_uint8), ctypes.c_size_t +) + + +def get_prebuilds_folder() -> str | None: + """Return the ``prebuilds/`` folder name for the current host. + + Matches the napi-rs ``-`` layout the runtime package + ships (e.g. ``linux-x64``, ``darwin-arm64``, ``win32-x64``), including the + musl (Alpine) variants. Returns ``None`` for unsupported platforms. + """ + if sys.platform.startswith("linux"): + platform_name = "linuxmusl" if _is_musl() else "linux" + elif sys.platform == "darwin": + platform_name = "darwin" + elif sys.platform == "win32": + platform_name = "win32" + else: + return None + + machine = _normalize_machine() + if machine is None: + return None + return f"{platform_name}-{machine}" + + +def _normalize_machine() -> str | None: + import platform + + machine = platform.machine().lower() + if machine in ("x86_64", "amd64", "x64"): + return "x64" + if machine in ("arm64", "aarch64"): + return "arm64" + return None + + +def _is_musl() -> bool: + """Detect whether the current Linux system uses musl libc (e.g. Alpine).""" + if sys.platform != "linux": + return False + try: + import subprocess + + result = subprocess.run(["ldd", "--version"], capture_output=True, text=True, timeout=5) + return "musl" in (result.stdout + result.stderr).lower() + except (FileNotFoundError, OSError, Exception): # noqa: BLE001 + return False + + +def _natural_library_name() -> str: + """The natural platform shared-library file name for the runtime cdylib. + + The ``.node`` file renamed to what a Rust ``cdylib`` would be called on this + OS. The library is loaded by absolute path, so the on-disk name is ours. + """ + if sys.platform == "win32": + return "copilot_runtime.dll" + if sys.platform == "darwin": + return "libcopilot_runtime.dylib" + return "libcopilot_runtime.so" + + +def resolve_library_path(cli_entrypoint: str) -> str | None: + """Resolve the native runtime library next to the given CLI entrypoint. + + Checks, in order: + + 1. The natural platform library name next to the CLI (bundled/flat layout, + what the Python download-at-first-use path writes). + 2. ``prebuilds//runtime.node`` next to the CLI (dev/package layout). + + Returns the absolute path, or ``None`` when neither exists. + """ + directory = Path(cli_entrypoint).resolve().parent + + flat = directory / _natural_library_name() + if flat.is_file(): + return str(flat) + + folder = get_prebuilds_folder() + if folder is not None: + prebuilt = directory / "prebuilds" / folder / "runtime.node" + if prebuilt.is_file(): + return str(prebuilt) + + return None + + +# The cdylib may only be loaded once per process; a second load of a *different* +# path is unsupported (matches the Node/Rust hosts). Guard it here. +_loaded_library: ctypes.CDLL | None = None +_loaded_library_path: str | None = None +_load_lock = threading.Lock() + + +class _FfiLibrary: + """Binds the ``copilot_runtime_*`` C ABI exports of a loaded cdylib.""" + + def __init__(self, lib: ctypes.CDLL) -> None: + self._lib = lib + + self.host_start = getattr(lib, f"{_SYMBOL_PREFIX}host_start") + self.host_start.argtypes = [ + ctypes.c_char_p, + ctypes.c_size_t, + ctypes.c_char_p, + ctypes.c_size_t, + ] + self.host_start.restype = ctypes.c_uint32 + + self.host_shutdown = getattr(lib, f"{_SYMBOL_PREFIX}host_shutdown") + self.host_shutdown.argtypes = [ctypes.c_uint32] + self.host_shutdown.restype = ctypes.c_bool + + self.connection_open = getattr(lib, f"{_SYMBOL_PREFIX}connection_open") + self.connection_open.argtypes = [ + ctypes.c_uint32, + _OutboundCallback, + ctypes.c_void_p, + ctypes.c_char_p, + ctypes.c_size_t, + ctypes.c_char_p, + ctypes.c_size_t, + ctypes.c_char_p, + ctypes.c_size_t, + ] + self.connection_open.restype = ctypes.c_uint32 + + self.connection_write = getattr(lib, f"{_SYMBOL_PREFIX}connection_write") + self.connection_write.argtypes = [ + ctypes.c_uint32, + ctypes.c_char_p, + ctypes.c_size_t, + ] + self.connection_write.restype = ctypes.c_bool + + self.connection_close = getattr(lib, f"{_SYMBOL_PREFIX}connection_close") + self.connection_close.argtypes = [ctypes.c_uint32] + self.connection_close.restype = ctypes.c_bool + + +def _load_library(library_path: str) -> _FfiLibrary: + global _loaded_library, _loaded_library_path + with _load_lock: + if _loaded_library is not None: + if _loaded_library_path != library_path: + raise RuntimeError( + f"An in-process FFI runtime library is already loaded from " + f"'{_loaded_library_path}'; loading a different library from " + f"'{library_path}' in the same process is not supported." + ) + return _FfiLibrary(_loaded_library) + + # Load with immediate binding (RTLD_NOW) on POSIX, matching the .NET/Rust + # hosts. The runtime cdylib from the npm platform package is self-contained; + # eager binding surfaces any load problem here rather than at first call. + if sys.platform == "win32": + lib = ctypes.WinDLL(library_path) + else: + lib = ctypes.CDLL(library_path, mode=os.RTLD_NOW | os.RTLD_LOCAL) + _loaded_library = lib + _loaded_library_path = library_path + return _FfiLibrary(lib) + + +class _ReceiveBuffer: + """Thread-safe byte buffer feeding blocking ``read(n)`` from a producer thread. + + The native outbound callback (invoked on a foreign runtime thread) appends + frames via :meth:`feed` without ever blocking; the JSON-RPC reader thread + drains them via :meth:`read`, which blocks until data or EOF. + """ + + def __init__(self) -> None: + self._buffer = bytearray() + self._closed = False + self._cond = threading.Condition() + + def feed(self, data: bytes) -> None: + with self._cond: + if self._closed: + return + self._buffer.extend(data) + self._cond.notify_all() + + def close(self) -> None: + with self._cond: + self._closed = True + self._cond.notify_all() + + def read(self, size: int) -> bytes: + if size <= 0: + return b"" + with self._cond: + while not self._buffer and not self._closed: + self._cond.wait() + if not self._buffer: + return b"" # EOF + chunk = bytes(self._buffer[:size]) + del self._buffer[:size] + return chunk + + def readline(self) -> bytes: + """Read through the next ``\\n`` (inclusive), blocking until available. + + Returns whatever remains (possibly without a trailing newline) at EOF, or + ``b""`` if the buffer is empty and closed. Mirrors the blocking + ``BufferedReader.readline`` semantics :class:`JsonRpcClient` expects when + parsing LSP ``Content-Length:`` headers. + """ + with self._cond: + while b"\n" not in self._buffer and not self._closed: + self._cond.wait() + newline_index = self._buffer.find(b"\n") + if newline_index == -1: + # EOF with no newline: return the remaining bytes (may be empty). + line = bytes(self._buffer) + self._buffer.clear() + return line + end = newline_index + 1 + line = bytes(self._buffer[:end]) + del self._buffer[:end] + return line + + +class _FfiStdin: + """Writable side of the process-like adapter; forwards frames to the runtime.""" + + def __init__(self, host: FfiRuntimeHost) -> None: + self._host = host + + def write(self, data: bytes) -> int: + self._host._write_frame(data) + return len(data) + + def flush(self) -> None: + # connection_write enqueues synchronously, so there is nothing to flush. + pass + + +class _FfiProcessAdapter: + """A ``subprocess.Popen``-shaped view over an :class:`FfiRuntimeHost`. + + :class:`~copilot._jsonrpc.JsonRpcClient` only needs ``stdin`` (writable), + ``stdout`` (blocking ``read``), an optional ``stderr``, and ``poll()``. The + in-process transport has no OS pipes, so this adapter bridges those to the + FFI host's frame plumbing. + """ + + def __init__(self, host: FfiRuntimeHost) -> None: + self._host = host + self.stdin = _FfiStdin(host) + self.stdout = host._receive_buffer + # No separate error stream in-process; JsonRpcClient skips the stderr + # thread when this is falsy. + self.stderr = None + + def poll(self) -> int | None: + """Return ``None`` while the connection is live, ``0`` once closed.""" + return None if not self._host._disposed else 0 + + def terminate(self) -> None: + self._host.dispose() + + def kill(self) -> None: + self._host.dispose() + + def wait(self, timeout: float | None = None) -> int: # noqa: ARG002 + self._host.dispose() + return 0 + + +class FfiRuntimeHost: + """Hosts the Copilot runtime in-process via its native C ABI. + + Construct with :meth:`create`, then :meth:`start` to spawn the worker and open + the FFI connection. Expose :attr:`process` to :class:`JsonRpcClient`, and call + :meth:`dispose` to tear everything down. + """ + + def __init__( + self, + library_path: str, + cli_entrypoint: str, + environment: dict[str, str] | None = None, + args: Sequence[str] = (), + ) -> None: + self._library_path = library_path + self._cli_entrypoint = cli_entrypoint + self._environment = environment + self._extra_args = list(args) + self._lib = _load_library(library_path) + + self._server_id = 0 + self._connection_id = 0 + self._disposed = False + self._dispose_lock = threading.Lock() + + self._receive_buffer = _ReceiveBuffer() + # Keep a strong reference to the ctypes callback for its whole lifetime; + # dropping it while native code can still invoke it is a use-after-free. + self._outbound_callback: ctypes._FuncPointer | None = None + # Serializes teardown against in-flight native callbacks. + self._active_callbacks = 0 + self._callback_lock = threading.Lock() + + self._process = _FfiProcessAdapter(self) + + @property + def process(self) -> _FfiProcessAdapter: + """The ``subprocess.Popen``-shaped adapter for :class:`JsonRpcClient`.""" + return self._process + + @staticmethod + def create( + cli_entrypoint: str, + environment: dict[str, str] | None = None, + args: Sequence[str] = (), + ) -> FfiRuntimeHost: + """Resolve the cdylib next to the CLI entrypoint and prepare the host. + + Raises: + RuntimeError: If the native runtime library cannot be found. + """ + full_entrypoint = str(Path(cli_entrypoint).resolve()) + library_path = resolve_library_path(full_entrypoint) + if library_path is None: + raise RuntimeError( + "In-process FFI runtime library not found next to " + f"'{full_entrypoint}'. Download it with " + "`python -m copilot download-runtime --in-process`, or set " + "COPILOT_CLI_PATH to a runtime package that ships it." + ) + return FfiRuntimeHost(library_path, full_entrypoint, environment, args) + + def _build_argv(self) -> bytes: + # A `.js` entrypoint (dev) is launched via node; the packaged single-file + # CLI embeds its own Node and is invoked directly. `--no-auto-update` + # pins the worker to the runtime package matching the loaded cdylib. + if self._cli_entrypoint.lower().endswith(".js"): + argv = ["node", self._cli_entrypoint, "--embedded-host", "--no-auto-update"] + else: + argv = [self._cli_entrypoint, "--embedded-host", "--no-auto-update"] + argv.extend(self._extra_args) + return json.dumps(argv).encode("utf-8") + + def _build_env(self) -> bytes | None: + if not self._environment: + return None + obj = {k: v for k, v in self._environment.items() if v is not None} + if not obj: + return None + return json.dumps(obj).encode("utf-8") + + def start_blocking(self) -> None: + """Spawn the worker and open the FFI connection (blocks up to ~30s). + + Must be run off the event loop (e.g. via :func:`asyncio.to_thread`); + ``host_start`` blocks until the worker connects back and signals + readiness. + """ + argv = self._build_argv() + env = self._build_env() + + self._server_id = self._lib.host_start(argv, len(argv), env, len(env) if env else 0) + if not self._server_id: + raise RuntimeError( + f"copilot_runtime_host_start failed (library '{self._library_path}', " + f"entrypoint '{self._cli_entrypoint}')." + ) + + self._outbound_callback = _OutboundCallback(self._on_outbound) + self._connection_id = self._lib.connection_open( + self._server_id, + self._outbound_callback, + None, + None, + 0, + None, + 0, + None, + 0, + ) + if not self._connection_id: + self._outbound_callback = None + self._lib.host_shutdown(self._server_id) + self._server_id = 0 + raise RuntimeError("copilot_runtime_connection_open failed.") + + def _on_outbound( + self, + _user_data: int | None, + bytes_ptr: ctypes._Pointer, + bytes_len: int, + ) -> None: + """Native server → client callback (invoked on a foreign runtime thread). + + The native pointer is only valid for this call, so the bytes are copied + out before returning. Exceptions must not cross the FFI boundary, so + everything is caught and logged. + """ + with self._callback_lock: + if self._disposed: + return + self._active_callbacks += 1 + try: + if bytes_ptr and bytes_len > 0: + data = ctypes.string_at(bytes_ptr, bytes_len) + self._receive_buffer.feed(data) + except Exception: # noqa: BLE001 + logger.error("In-process FFI inbound callback failed", exc_info=True) + finally: + with self._callback_lock: + self._active_callbacks -= 1 + + def _write_frame(self, frame: bytes) -> None: + if self._disposed or not self._connection_id: + raise RuntimeError("The in-process runtime connection is closed.") + ok = self._lib.connection_write(self._connection_id, frame, len(frame)) + if not ok: + raise RuntimeError("Failed to write a frame to the in-process runtime connection.") + + def dispose(self) -> None: + """Close the FFI connection, shut down the native host, release resources. + + Idempotent. Waits for any in-flight outbound callback to finish before + dropping the callback reference to avoid a use-after-free. + """ + with self._dispose_lock: + if self._disposed: + return + self._disposed = True + + # Stop accepting new callbacks and wait for in-flight ones to drain. + with self._callback_lock: + pass # _disposed is set; new callbacks bail out immediately. + while True: + with self._callback_lock: + if self._active_callbacks == 0: + break + time.sleep(0.001) + + try: + if self._connection_id: + self._lib.connection_close(self._connection_id) + self._connection_id = 0 + except Exception: # noqa: BLE001 + logger.debug("Error closing in-process FFI connection", exc_info=True) + + try: + if self._server_id: + self._lib.host_shutdown(self._server_id) + self._server_id = 0 + except Exception: # noqa: BLE001 + logger.debug("Error shutting down in-process FFI host", exc_info=True) + + self._receive_buffer.close() + # Safe to drop now: no native code can invoke the callback after + # connection_close, and all in-flight callbacks have drained. + self._outbound_callback = None diff --git a/python/copilot/_jsonrpc.py b/python/copilot/_jsonrpc.py index a58908d08..ed70e4e8d 100644 --- a/python/copilot/_jsonrpc.py +++ b/python/copilot/_jsonrpc.py @@ -80,6 +80,7 @@ def __init__(self, process): self.pending_requests: dict[str, asyncio.Future] = {} self._pending_inline_callbacks: dict[str, Callable[[Any], None]] = {} self.notification_handler: Callable[[str, dict], None] | None = None + self.notification_method_handlers: dict[str, Callable[[dict], Any]] = {} self.request_handlers: dict[str, RequestHandler] = {} self._running = False self._read_thread: threading.Thread | None = None @@ -232,6 +233,19 @@ def set_notification_handler(self, handler: Callable[[str, dict], None]): """Set the handler for incoming notifications from the server.""" self.notification_handler = handler + def set_notification_method_handler(self, method: str, handler: Callable[[dict], Any] | None): + """Register a handler for a specific server-to-client notification method. + + Notifications carry no ``id`` and expect no response, so they are + dispatched separately from request handlers. A registered method + handler takes precedence over the generic notification handler. The + handler may be a coroutine function; its result is awaited. + """ + if handler is None: + self.notification_method_handlers.pop(method, None) + else: + self.notification_method_handlers[method] = handler + def set_request_handler(self, method: str, handler: RequestHandler): if handler is None: self.request_handlers.pop(method, None) @@ -397,9 +411,14 @@ def _handle_message(self, message: dict): # Check if it's a notification from the server if "method" in message and "id" not in message: + method = message["method"] + params = message.get("params", {}) + handler = self.notification_method_handlers.get(method) + if handler is not None and self._loop: + # Method-specific notification handler takes precedence. + self._loop.call_soon_threadsafe(self._dispatch_notification, handler, params) + return if self.notification_handler and self._loop: - method = message["method"] - params = message.get("params", {}) # Schedule notification handler on the event loop for thread safety self._loop.call_soon_threadsafe(self.notification_handler, method, params) return @@ -427,6 +446,25 @@ def _handle_request(self, message: dict): self._loop, ) + def _dispatch_notification(self, handler: Callable[[dict], Any], params: dict): + """Invoke a method-specific notification handler. Runs on the event loop; + coroutine results are scheduled and any error is logged (notifications + carry no response, so failures never propagate to the server).""" + try: + outcome = handler(params) + except Exception: # pylint: disable=broad-except + logger.warning("Notification handler raised", exc_info=True) + return + if inspect.isawaitable(outcome): + + async def _await_outcome(): + try: + await outcome + except Exception: # pylint: disable=broad-except + logger.warning("Notification handler raised", exc_info=True) + + asyncio.create_task(_await_outcome()) + async def _dispatch_request(self, message: dict, handler: RequestHandler): try: params = message.get("params", {}) diff --git a/python/copilot/_mode.py b/python/copilot/_mode.py index 9323423f6..1a9ed6e1f 100644 --- a/python/copilot/_mode.py +++ b/python/copilot/_mode.py @@ -11,7 +11,10 @@ import re from collections.abc import Iterable -from typing import Any, Literal +from typing import TYPE_CHECKING, Any, Literal + +if TYPE_CHECKING: + from .session import MemoryConfiguration CopilotClientMode = Literal["copilot-cli", "empty"] @@ -248,6 +251,22 @@ def _enable_skills_default( return _empty_mode_bool_default(mode, supplied, False) +def _custom_agents_local_only_default( + mode: CopilotClientMode | None, + supplied: bool | None, +) -> bool | None: + """Empty mode defaults custom agents to local-only; caller value wins.""" + return _empty_mode_bool_default(mode, supplied, True) + + +def _enable_experimental_mode_default( + mode: CopilotClientMode | None, + supplied: bool | None, +) -> bool | None: + """Empty mode defaults experimental mode to False; caller value wins.""" + return _empty_mode_bool_default(mode, supplied, False) + + def _mcp_oauth_token_storage_default( mode: CopilotClientMode | None, supplied: Literal["persistent", "in-memory"] | None, @@ -258,6 +277,21 @@ def _mcp_oauth_token_storage_default( return supplied +def _memory_default( + mode: CopilotClientMode | None, + supplied: MemoryConfiguration | None, +) -> MemoryConfiguration | None: + """Empty mode defaults memory to disabled; caller value wins. + + Copilot CLI mode applies no SDK default: the configuration is left unset so + the runtime applies its own default for the memory feature. The caller + passes the ``MemoryConfiguration`` mapping (or ``None``). + """ + if mode == "empty" and supplied is None: + return {"enabled": False} + return supplied + + def _post_create_options_patch( mode: CopilotClientMode | None, skip_custom_instructions: bool | None, @@ -276,8 +310,8 @@ def _post_create_options_patch( "skipCustomInstructions": ( skip_custom_instructions if skip_custom_instructions is not None else True ), - "customAgentsLocalOnly": ( - custom_agents_local_only if custom_agents_local_only is not None else True + "customAgentsLocalOnly": _custom_agents_local_only_default( + mode, custom_agents_local_only ), "coauthorEnabled": coauthor_enabled if coauthor_enabled is not None else False, "manageScheduleEnabled": ( diff --git a/python/copilot/canvas.py b/python/copilot/canvas.py index ddbc8539a..9b8dec525 100644 --- a/python/copilot/canvas.py +++ b/python/copilot/canvas.py @@ -39,6 +39,7 @@ "CanvasHostContext", "CanvasHostContextCapabilities", "CanvasJsonSchema", + "CanvasProviderIdentity", "ExtensionInfo", "OpenCanvasInstance", ] @@ -66,6 +67,33 @@ def to_dict(self) -> dict[str, Any]: return {"source": self.source, "name": self.name} +@dataclass +class CanvasProviderIdentity: + """Stable identity for a host/SDK connection that supplies built-in canvases. + + Lets a host advertise a stable canvas-provider extension id so host-provided + canvases restore across a cold session resume. Serializes to + ``{"id": ...}`` (with an optional ``"name"``) on the wire. + + .. note:: + + **Experimental.** This type is part of an experimental wire-protocol + surface and may change or be removed in future SDK or CLI releases. + """ + + id: str + """Stable provider identifier, e.g. ``"app:builtin:window-1"``.""" + + name: str | None = None + """Optional human-readable provider name.""" + + def to_dict(self) -> dict[str, Any]: + result: dict[str, Any] = {"id": self.id} + if self.name is not None: + result["name"] = self.name + return result + + @dataclass class CanvasDeclaration: """Declarative metadata for a single canvas, sent on create/resume. diff --git a/python/copilot/client.py b/python/copilot/client.py index 7dcec6e8f..6cdd765c3 100644 --- a/python/copilot/client.py +++ b/python/copilot/client.py @@ -26,18 +26,20 @@ import time import uuid from collections.abc import Awaitable, Callable, Mapping, Sequence -from dataclasses import dataclass +from dataclasses import dataclass, field from datetime import UTC, datetime -from pathlib import Path from types import TracebackType from typing import Any, ClassVar, Literal, TypedDict, cast, overload from ._diagnostics import log_timing +from ._ffi_runtime_host import FfiRuntimeHost from ._jsonrpc import JsonRpcClient, JsonRpcError, ProcessExitedError from ._mode import ( CopilotClientMode, ToolSet, + _custom_agents_local_only_default, _embedding_cache_storage_default, + _enable_experimental_mode_default, _enable_file_hooks_default, _enable_host_git_operations_default, _enable_on_demand_instruction_discovery_default, @@ -45,6 +47,7 @@ _enable_session_telemetry_default, _enable_skills_default, _mcp_oauth_token_storage_default, + _memory_default, _normalize_tool_filter, _post_create_options_patch, _require_available_tools_for_empty_mode, @@ -58,16 +61,24 @@ from .canvas import ( CanvasDeclaration, CanvasHandler, + CanvasProviderIdentity, ExtensionInfo, ) +from .copilot_request_handler import CopilotRequestHandler, create_copilot_request_adapter from .generated.rpc import ( + ClientGlobalApiHandlers, ClientSessionApiHandlers, + GitHubTelemetryNotification, + ModelBillingTokenPrices, + ModelBillingTokenPricesLongContext, # noqa: F401 OpenCanvasInstance, RemoteSessionMode, ServerRpc, - _ConnectRequest, - _InternalServerRpc, + _ConnectResult, + _HookInvokeRequest, + _HookInvokeResponse, from_datetime, + register_client_global_api_handlers, register_client_session_api_handlers, ) from .generated.session_events import ( @@ -76,6 +87,7 @@ ) from .session import ( AutoModeSwitchHandler, + BearerTokenProvider, CommandDefinition, ContextTier, CopilotSession, @@ -84,17 +96,26 @@ DefaultAgentConfig, ElicitationHandler, ExitPlanModeHandler, + GitHubMcpToolConfig, InfiniteSessionConfig, LargeToolOutputConfig, + McpAuthHandler, MCPServerConfig, + MemoryConfiguration, + ModelCapabilitiesOverride, + NamedProviderConfig, ProviderConfig, + ProviderModelConfig, ReasoningEffort, ReasoningSummary, SectionTransformFn, SessionFsConfig, SessionHooks, + SessionLimitsConfig, SystemMessageConfig, + ToolSearchConfig, UserInputHandler, + _capabilities_to_dict, _PermissionHandlerFn, ) from .session_fs_provider import SessionFsProvider, create_session_fs_adapter @@ -127,6 +148,85 @@ class CloudSessionOptions: repository: CloudSessionRepository | None = None +ExpFlagValue = str | int | float | bool | None +"""A single ExP (Experiment Platform) flag value. + +ExP assignments resolve to a string, number, boolean, or ``None``. +""" + + +@dataclass +class ExpConfigEntry: + """A single configuration entry in a :class:`CopilotExpAssignmentResponse`. + + Each entry carries an identifier and a bag of typed parameter values. + """ + + id: str + """Identifier of the configuration entry.""" + parameters: dict[str, ExpFlagValue] = field(default_factory=dict) + """Parameter values keyed by parameter name.""" + + +@dataclass +class CopilotExpAssignmentResponse: + """ExP ("flight") assignment data. + + Uses the same JSON shape the Copilot CLI fetches from the experimentation + service. Serialized on the wire with PascalCase keys to match the contract + consumed by the runtime. + """ + + features: list[str] = field(default_factory=list) + """Enabled feature names.""" + flights: dict[str, str] = field(default_factory=dict) + """Assigned flights keyed by flight name.""" + configs: list[ExpConfigEntry] = field(default_factory=list) + """Configuration entries carrying typed parameter values.""" + assignment_context: str = "" + """Assignment context string forwarded to CAPI and telemetry.""" + parameter_groups: Any | None = None + """Opaque parameter-group payload passed through untouched. Optional.""" + flighting_version: int | None = None + """Version of the flighting configuration. Optional.""" + impression_id: str | None = None + """Impression identifier for the assignment. Optional.""" + + +def _exp_assignment_response_to_dict( + response: CopilotExpAssignmentResponse, +) -> dict[str, Any]: + wire: dict[str, Any] = { + "Features": list(response.features), + "Flights": dict(response.flights), + "Configs": [ + {"Id": entry.id, "Parameters": dict(entry.parameters)} for entry in response.configs + ], + "AssignmentContext": response.assignment_context, + } + if response.parameter_groups is not None: + wire["ParameterGroups"] = response.parameter_groups + if response.flighting_version is not None: + wire["FlightingVersion"] = response.flighting_version + if response.impression_id is not None: + wire["ImpressionId"] = response.impression_id + return wire + + +class CapiSessionOptions(TypedDict, total=False): + """Provider-scoped Copilot API (CAPI) session options.""" + + enable_web_socket_responses: bool + """Whether to use WebSocket transport for the CAPI Responses API. + + Enabled by default when the model advertises ``ws:/responses`` support. Set + to ``False`` to force the HTTP Responses transport instead, which is + equivalent to the ``COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`` environment + variable and useful in environments where WebSockets are blocked (e.g. + behind a proxy). + """ + + def _cloud_session_options_to_dict(options: CloudSessionOptions) -> dict[str, Any]: result: dict[str, Any] = {} if options.repository is not None: @@ -140,6 +240,100 @@ def _cloud_session_options_to_dict(options: CloudSessionOptions) -> dict[str, An return result +def _capi_session_options_to_wire(options: CapiSessionOptions) -> dict[str, Any]: + wire: dict[str, Any] = {} + if "enable_web_socket_responses" in options: + wire["enableWebSocketResponses"] = options["enable_web_socket_responses"] + return wire + + +@dataclass +class ManagedSettingsPermissions: + """Permissions-only managed policy injected via :class:`ManagedSettings`. + + Rule strings use the same vocabulary the runtime accepts for fetched + managed policy (e.g. ``"Read(**)"``, ``"Shell(git push *)"``); malformed + rules are rejected by the runtime at session creation. + """ + + disable_bypass_permissions_mode: Literal["disable"] | None = None + """When ``"disable"``, turns off bypass-permissions ("yolo") mode for the + session. Deny-wins: no other layer can re-enable it. Sent on the wire as + ``disableBypassPermissionsMode``.""" + deny: list[str] | None = None + """Operations that must always be denied. Unioned across managed layers.""" + ask: list[str] | None = None + """Operations that must prompt for approval. Unioned across managed layers.""" + allow: list[str] | None = None + """Operations permitted without prompting. Every declared ``allow`` list + across managed layers must admit an operation for it to be allowed.""" + + +@dataclass +class ManagedSettings: + """Host-injected enterprise managed settings for a session. + + Unlike ``enable_managed_settings`` — which asks the runtime to *self-fetch* + account/org and device policy — this supplies the managed policy directly. + The runtime validates it with the same managed-permission parser it uses + for fetched policy and composes it restrictively with any self-fetched + (server) and device-managed (MDM) layers. + + The first supported contract is permissions-only; unknown sibling keys are + rejected by the runtime. Serialized on the wire as ``managedSettings``. + """ + + permissions: ManagedSettingsPermissions | None = None + """Managed permission policy for the session.""" + + +def _managed_settings_to_dict(settings: ManagedSettings) -> dict[str, Any]: + wire: dict[str, Any] = {} + permissions = settings.permissions + if permissions is not None: + perms: dict[str, Any] = {} + if permissions.disable_bypass_permissions_mode is not None: + perms["disableBypassPermissionsMode"] = permissions.disable_bypass_permissions_mode + if permissions.deny is not None: + perms["deny"] = list(permissions.deny) + if permissions.ask is not None: + perms["ask"] = list(permissions.ask) + if permissions.allow is not None: + perms["allow"] = list(permissions.allow) + wire["permissions"] = perms + return wire + + +# Implicit provider name for the singular, whole-session ``provider`` config. +# Named providers are keyed by their own ``name``. +_DEFAULT_BEARER_TOKEN_PROVIDER_NAME = "default" + + +def _collect_bearer_token_callbacks( + provider: ProviderConfig | None, + providers: list[NamedProviderConfig] | None, +) -> dict[str, BearerTokenProvider]: + """Collect per-provider ``bearer_token_provider`` callbacks keyed by provider name. + + The singular, whole-session ``provider`` uses the implicit + ``_DEFAULT_BEARER_TOKEN_PROVIDER_NAME``; ``providers`` entries use their own + ``name``. The callbacks are never serialized — the wire conversion emits + ``hasBearerTokenProvider: true`` instead and the runtime calls back over + ``providerToken.getToken``. + """ + callbacks: dict[str, BearerTokenProvider] = {} + if provider is not None: + singular = provider.get("bearer_token_provider") + if singular is not None: + callbacks[_DEFAULT_BEARER_TOKEN_PROVIDER_NAME] = singular + if providers: + for named in providers: + callback = named.get("bearer_token_provider") + if callback is not None: + callbacks[named["name"]] = callback + return callbacks + + def _validate_session_fs_config(config: SessionFsConfig) -> None: if not config.get("initial_working_directory"): raise ValueError("session_fs.initial_working_directory is required") @@ -177,11 +371,55 @@ def _large_output_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: return wire +def _memory_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: + """Convert a ``MemoryConfiguration`` mapping to wire format.""" + return {"enabled": config["enabled"]} + + +def _session_limits_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: + """Convert a ``SessionLimitsConfig`` mapping to wire format.""" + wire: dict[str, Any] = {} + if "max_ai_credits" in config: + wire["maxAiCredits"] = config["max_ai_credits"] + return wire + + +def _tool_search_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: + """Convert a ``ToolSearchConfig`` mapping to wire format.""" + wire: dict[str, Any] = {} + if "enabled" in config: + wire["enabled"] = config["enabled"] + if "defer_threshold" in config: + wire["deferThreshold"] = config["defer_threshold"] + return wire + + +def _github_mcp_tool_config_to_wire(config: Mapping[str, Any]) -> dict[str, Any]: + """Convert a ``GitHubMcpToolConfig`` mapping to wire format.""" + wire: dict[str, Any] = {} + if "enable_all_tools" in config: + wire["enableAllTools"] = config["enable_all_tools"] + if "additional_toolsets" in config: + wire["additionalToolsets"] = config["additional_toolsets"] + if "additional_tools" in config: + wire["additionalTools"] = config["additional_tools"] + if "enable_insiders_mode" in config: + wire["enableInsidersMode"] = config["enable_insiders_mode"] + if "disable_form_deferral" in config: + wire["disableFormDeferral"] = config["disable_form_deferral"] + return wire + + class TelemetryConfig(TypedDict, total=False): """Configuration for OpenTelemetry integration with the Copilot CLI.""" otlp_endpoint: str """OTLP HTTP endpoint URL for trace/metric export. Sets OTEL_EXPORTER_OTLP_ENDPOINT.""" + otlp_protocol: Literal["http/json", "http/protobuf"] + """OTLP HTTP protocol for all signals. + + Allowed values are "http/json" and "http/protobuf". Sets OTEL_EXPORTER_OTLP_PROTOCOL. + """ file_path: str """File path for JSON-lines trace output. Sets COPILOT_OTEL_FILE_EXPORTER_PATH.""" exporter_type: str @@ -266,6 +504,33 @@ def for_uri(url: str, *, connection_token: str | None = None) -> UriRuntimeConne """ return UriRuntimeConnection(url=url, connection_token=connection_token) + @staticmethod + def for_inprocess() -> InProcessRuntimeConnection: + """Host the runtime **in-process** via its native C ABI (FFI). + + **Experimental.** The in-process (FFI) transport is experimental and its + behavior may change or be removed in a future release. + + Instead of spawning the runtime as a child process, the SDK loads the + runtime's native shared library into this process and drives JSON-RPC + over its C ABI. + + Because the runtime loads into this single shared process, per-client + options that lower to environment variables or a working directory + cannot be honored: :attr:`CopilotClientOptions.env`, + :attr:`CopilotClientOptions.telemetry`, and + :attr:`CopilotClientOptions.working_directory` are rejected with this + transport. Set those on the host process before creating the client. + Set ``COPILOT_CLI_PATH`` only when using an externally provisioned + compatible runtime package. + + Note: + Pre-provision the native runtime with + ``python -m copilot download-runtime --in-process`` when automatic + downloads are disabled. + """ + return InProcessRuntimeConnection() + @dataclass class ChildProcessRuntimeConnection(RuntimeConnection): @@ -280,6 +545,13 @@ class ChildProcessRuntimeConnection(RuntimeConnection): args: Sequence[str] = () """Extra command-line arguments passed to the runtime process.""" + env: dict[str, str] | None = None + """Per-connection environment variables for the spawned child process. + + When set, do not also set :attr:`CopilotClientOptions.env` — the client + rejects setting environment in both places. ``None`` inherits the + client-level env (or the current process env).""" + @dataclass class StdioRuntimeConnection(ChildProcessRuntimeConnection): @@ -317,6 +589,58 @@ class UriRuntimeConnection(RuntimeConnection): """Shared secret to authenticate the connection.""" +@dataclass +class InProcessRuntimeConnection(RuntimeConnection): + """Hosts the runtime in-process via its native C ABI (FFI). + + **Experimental.** The in-process (FFI) transport is experimental and its + behavior may change or be removed in a future release. + + Construct via :meth:`RuntimeConnection.for_inprocess`. The runtime's native + shared library is loaded into this process and JSON-RPC is driven over its + C ABI. + """ + + +class _GitHubTelemetryAdapter: + """Adapts a user-provided ``on_github_telemetry`` callback to the generated + ``GitHubTelemetryHandler`` protocol. + """ + + def __init__( + self, + callback: Callable[[GitHubTelemetryNotification], None | Awaitable[None]], + ) -> None: + self._callback = callback + + async def event(self, params: GitHubTelemetryNotification) -> None: + try: + result = self._callback(params) + if inspect.isawaitable(result): + await result + except Exception: + logger.warning("Error handling gitHubTelemetry.event notification", exc_info=True) + + +class _HooksAdapter: + """Adapts session-scoped hook dispatch to the generated ``HooksHandler`` protocol. + + ``hooks.invoke`` is a client-global RPC method whose payload carries a + ``sessionId``. This adapter routes each invocation to the matching session's + registered hook handlers. + """ + + def __init__(self, get_session: Callable[[str], CopilotSession | None]) -> None: + self._get_session = get_session + + async def invoke(self, params: _HookInvokeRequest) -> _HookInvokeResponse: + session = self._get_session(params.session_id) + if session is None: + raise ValueError(f"unknown session {params.session_id}") + output = await session._handle_hooks_invoke(params.hook_type.value, params.input) + return _HookInvokeResponse(output=output) + + @dataclass class _CopilotClientOptions: """Internal configuration carrier used by :class:`CopilotClient`. @@ -331,12 +655,17 @@ class _CopilotClientOptions: env: dict[str, str] | None = None github_token: str | None = None base_directory: str | None = None + builtin_plugin_directories: tuple[str, ...] = () use_logged_in_user: bool | None = None telemetry: TelemetryConfig | None = None session_fs: SessionFsConfig | None = None + request_handler: CopilotRequestHandler | None = None session_idle_timeout_seconds: int | None = None enable_remote_sessions: bool = False on_list_models: Callable[[], list[ModelInfo] | Awaitable[list[ModelInfo]]] | None = None + on_github_telemetry: Callable[[GitHubTelemetryNotification], None | Awaitable[None]] | None = ( + None + ) mode: CopilotClientMode = "copilot-cli" @@ -582,66 +911,6 @@ def to_dict(self) -> dict: return result -@dataclass -class ModelVisionLimitsOverride: - supported_media_types: list[str] | None = None - max_prompt_images: int | None = None - max_prompt_image_size: int | None = None - - -@dataclass -class ModelLimitsOverride: - max_prompt_tokens: int | None = None - max_output_tokens: int | None = None - max_context_window_tokens: int | None = None - vision: ModelVisionLimitsOverride | None = None - - -@dataclass -class ModelSupportsOverride: - vision: bool | None = None - reasoning_effort: bool | None = None - - -@dataclass -class ModelCapabilitiesOverride: - supports: ModelSupportsOverride | None = None - limits: ModelLimitsOverride | None = None - - -def _capabilities_to_dict(caps: ModelCapabilitiesOverride) -> dict: - result: dict = {} - if caps.supports is not None: - s: dict = {} - if caps.supports.vision is not None: - s["vision"] = caps.supports.vision - if caps.supports.reasoning_effort is not None: - s["reasoningEffort"] = caps.supports.reasoning_effort - if s: - result["supports"] = s - if caps.limits is not None: - lim: dict = {} - if caps.limits.max_prompt_tokens is not None: - lim["max_prompt_tokens"] = caps.limits.max_prompt_tokens - if caps.limits.max_output_tokens is not None: - lim["max_output_tokens"] = caps.limits.max_output_tokens - if caps.limits.max_context_window_tokens is not None: - lim["max_context_window_tokens"] = caps.limits.max_context_window_tokens - if caps.limits.vision is not None: - v: dict = {} - if caps.limits.vision.supported_media_types is not None: - v["supported_media_types"] = caps.limits.vision.supported_media_types - if caps.limits.vision.max_prompt_images is not None: - v["max_prompt_images"] = caps.limits.vision.max_prompt_images - if caps.limits.vision.max_prompt_image_size is not None: - v["max_prompt_image_size"] = caps.limits.vision.max_prompt_image_size - if v: - lim["vision"] = v - if lim: - result["limits"] = lim - return result - - @dataclass class ModelPolicy: """Model policy state""" @@ -672,19 +941,25 @@ class ModelBilling: """Model billing information""" multiplier: float | None = None + token_prices: ModelBillingTokenPrices | None = None @staticmethod def from_dict(obj: Any) -> ModelBilling: assert isinstance(obj, dict) multiplier = obj.get("multiplier") - if multiplier is None: - return ModelBilling() - return ModelBilling(multiplier=float(multiplier)) + tp = obj.get("tokenPrices") + token_prices = ModelBillingTokenPrices.from_dict(tp) if tp is not None else None + return ModelBilling( + multiplier=float(multiplier) if multiplier is not None else None, + token_prices=token_prices, + ) def to_dict(self) -> dict: result: dict = {} if self.multiplier is not None: result["multiplier"] = self.multiplier + if self.token_prices is not None: + result["tokenPrices"] = self.token_prices.to_dict() return result @@ -980,26 +1255,27 @@ def _session_lifecycle_event_from_dict(data: dict) -> SessionLifecycleEvent: # Minimum protocol version this SDK can communicate with. # Servers reporting a version below this are rejected. _MIN_PROTOCOL_VERSION = 3 +_RUNTIME_SHUTDOWN_TIMEOUT_SECONDS = 10 +_CLI_PROCESS_EXIT_TIMEOUT_SECONDS = 5 -def _get_bundled_cli_path() -> str | None: - """Get the path to the bundled CLI binary, if available.""" - # The binary is bundled in copilot/bin/ within the package - bin_dir = Path(__file__).parent / "bin" - if not bin_dir.exists(): - return None +def _get_or_download_cli(*, include_runtime_lib: bool = False) -> str | None: + """Get the cached CLI binary, downloading if necessary. - # Determine binary name based on platform - if sys.platform == "win32": - binary_name = "copilot.exe" - else: - binary_name = "copilot" + Returns the path to the CLI binary, or None if unavailable (dev install + with no pinned version, or auto-download disabled). + + When ``include_runtime_lib`` is set, also ensures the native in-process FFI + runtime is available (downloading it on first use). + """ + from ._cli_download import get_or_download_cli - binary_path = bin_dir / binary_name - if binary_path.exists(): - return str(binary_path) + cli_path = get_or_download_cli() + if cli_path and include_runtime_lib: + from ._cli_download import ensure_runtime_library - return None + ensure_runtime_library(cli_path) + return cli_path def _extract_transform_callbacks( @@ -1037,6 +1313,78 @@ def _extract_transform_callbacks( return wire_payload, callbacks +_DEFAULT_CONNECTION_ENV_VAR = "COPILOT_SDK_DEFAULT_CONNECTION" + + +def _resolve_default_connection(env: Mapping[str, str]) -> RuntimeConnection: + """Resolve the transport when the caller supplies no explicit connection. + + Honors the ``COPILOT_SDK_DEFAULT_CONNECTION`` override (``"inprocess"`` or + ``"stdio"``); defaults to stdio. Matches the Node/.NET/Rust default-transport + override so the CI matrix can run the whole suite under either transport. + """ + value = env.get(_DEFAULT_CONNECTION_ENV_VAR) + if value is None or value == "": + return RuntimeConnection.for_stdio() + normalized = value.strip().lower() + if normalized == "inprocess": + return RuntimeConnection.for_inprocess() + if normalized == "stdio": + return RuntimeConnection.for_stdio() + raise ValueError( + f"Invalid {_DEFAULT_CONNECTION_ENV_VAR}={value!r}. Expected 'inprocess', 'stdio', or unset." + ) + + +def _validate_environment_options( + options: _CopilotClientOptions, connection: RuntimeConnection +) -> None: + """Validate env/telemetry/working-directory options against the transport. + + Per-client environment is only representable for child-process transports + (each client owns its own OS process). The in-process (FFI) transport loads + the native runtime into the shared host process, whose single environment + block and process-global working directory cannot carry per-client values, + so options that lower to them are rejected there (fail loud, not silent). + """ + if isinstance(connection, InProcessRuntimeConnection): + if options.env is not None: + raise ValueError( + "env is not supported with RuntimeConnection.for_inprocess(): the " + "in-process transport loads the native runtime into the shared host " + "process, whose single environment block cannot carry per-client " + "values. Set the variables on the host process environment instead." + ) + if options.telemetry is not None: + raise ValueError( + "telemetry is not supported with RuntimeConnection.for_inprocess(): " + "telemetry configuration is lowered to environment variables read by " + "native runtime code running in the shared host process, so per-client " + "telemetry cannot be honored in-process. Configure telemetry via the " + "host process environment, or use a child-process transport." + ) + if options.working_directory is not None: + raise ValueError( + "working_directory is not supported with RuntimeConnection.for_inprocess(): " + "the native runtime shares the host process working directory, so a " + "per-client working directory cannot be honored in-process. Use a " + "child-process " + "transport, or set the process working directory before creating the client." + ) + return + + if ( + isinstance(connection, ChildProcessRuntimeConnection) + and connection.env is not None + and options.env is not None + ): + raise ValueError( + "Set environment variables via either the client-level env argument or " + "ChildProcessRuntimeConnection.env, not both. Prefer the connection-level " + "env for child-process transports." + ) + + class CopilotClient: """ Main client for interacting with the Copilot CLI. @@ -1080,21 +1428,27 @@ def __init__( env: dict[str, str] | None = None, github_token: str | None = None, base_directory: str | None = None, + builtin_plugin_directories: Sequence[str] | None = None, use_logged_in_user: bool | None = None, telemetry: TelemetryConfig | None = None, session_fs: SessionFsConfig | None = None, + request_handler: CopilotRequestHandler | None = None, session_idle_timeout_seconds: int | None = None, enable_remote_sessions: bool = False, on_list_models: Callable[[], list[ModelInfo] | Awaitable[list[ModelInfo]]] | None = None, + on_github_telemetry: Callable[[GitHubTelemetryNotification], None | Awaitable[None]] + | None = None, mode: CopilotClientMode = "copilot-cli", ): """ Initialize a new CopilotClient. - All process-management options (``working_directory``, ``log_level``, - ``env``, ``github_token``, …) apply only when the SDK spawns the runtime - (stdio / tcp connections). They are ignored when connecting to an - existing runtime via :meth:`RuntimeConnection.for_uri`. + Runtime options apply to locally hosted connections. The in-process + transport supports typed runtime options such as ``log_level``, + ``github_token``, and ``base_directory``, but rejects per-client + ``working_directory``, ``env``, and ``telemetry``. Options are ignored + when connecting to an existing runtime via + :meth:`RuntimeConnection.for_uri`. Args: connection: How to reach the runtime. Defaults to @@ -1110,6 +1464,9 @@ def __init__( config, etc.). Sets the ``COPILOT_HOME`` environment variable on the spawned runtime. When ``None``, the runtime defaults to ``~/.copilot``. + builtin_plugin_directories: Absolute paths to trusted plugin + directories bundled by the host. When non-empty, the complete + set is registered during startup before sessions can be created. use_logged_in_user: Use the logged-in user for authentication. ``None`` (default) resolves to ``True`` unless ``github_token`` is set. @@ -1117,6 +1474,9 @@ def __init__( telemetry. session_fs: Connection-level session filesystem provider configuration. + request_handler: Connection-level request handler. When set, the + supplied handler services every model-layer HTTP/WebSocket + request the runtime would otherwise issue (both BYOK and CAPI). session_idle_timeout_seconds: Server-wide session idle timeout in seconds. Sessions without activity for this duration are automatically cleaned up. Set to ``None`` or ``0`` to disable. @@ -1127,6 +1487,10 @@ def __init__( on_list_models: Custom handler for :meth:`list_models`. When provided, the handler is called instead of querying the runtime server. + on_github_telemetry: Internal. Callback invoked when the runtime + forwards a GitHub telemetry event for a session. The callback + may be sync or async. Registering a handler opts every session + opened by this client into telemetry forwarding. Example: >>> # Default — spawns runtime using stdio with the bundled binary @@ -1150,17 +1514,28 @@ def __init__( env=env, github_token=github_token, base_directory=base_directory, + builtin_plugin_directories=tuple(builtin_plugin_directories or ()), use_logged_in_user=use_logged_in_user, telemetry=telemetry, session_fs=session_fs, + request_handler=request_handler, session_idle_timeout_seconds=session_idle_timeout_seconds, enable_remote_sessions=enable_remote_sessions, on_list_models=on_list_models, + on_github_telemetry=on_github_telemetry, mode=mode, ) connection = ( - options.connection if options.connection is not None else RuntimeConnection.for_stdio() + options.connection + if options.connection is not None + else _resolve_default_connection(os.environ) ) + _validate_environment_options(options, connection) + for path in options.builtin_plugin_directories: + if not os.path.isabs(path): + raise ValueError( + f"builtin_plugin_directories must contain only absolute paths: {path}" + ) _require_storage_for_empty_mode( mode=options.mode, base_directory=options.base_directory, @@ -1171,10 +1546,14 @@ def __init__( self._options: _CopilotClientOptions = options self._connection: RuntimeConnection = connection self._on_list_models = options.on_list_models + self._on_github_telemetry = options.on_github_telemetry # Resolve connection-mode-specific state. self._actual_host: str = "localhost" self._is_external_server: bool = isinstance(connection, UriRuntimeConnection) + self._cli_path_source: str | None = None + self._ffi_host: FfiRuntimeHost | None = None + self._inprocess_runtime_path: str | None = None if isinstance(connection, UriRuntimeConnection): if connection.connection_token is not None and len(connection.connection_token) == 0: @@ -1182,6 +1561,15 @@ def __init__( self._actual_host, actual_port = self._parse_cli_url(connection.url) self._runtime_port: int | None = actual_port self._effective_connection_token: str | None = connection.connection_token + elif isinstance(connection, InProcessRuntimeConnection): + # In-process (FFI): no child process and no per-connection token. + self._runtime_port = None + self._effective_connection_token = None + self._inprocess_runtime_path = self._resolve_runtime_entrypoint( + None, include_runtime_lib=True + ) + if options.use_logged_in_user is None: + options.use_logged_in_user = not bool(options.github_token) else: assert isinstance(connection, ChildProcessRuntimeConnection) self._runtime_port = None @@ -1200,32 +1588,25 @@ def __init__( else: self._effective_connection_token = None - # Resolve CLI path: explicit > COPILOT_CLI_PATH env var > bundled binary. - effective_env = options.env if options.env is not None else os.environ - self._cli_path_source: str | None = "explicit" - if connection.path is None: - env_cli_path = effective_env.get("COPILOT_CLI_PATH") - if env_cli_path: - connection.path = env_cli_path - self._cli_path_source = "environment" - else: - bundled_path = _get_bundled_cli_path() - if bundled_path: - connection.path = bundled_path - self._cli_path_source = "bundled" - else: - raise RuntimeError( - "Copilot CLI not found. The bundled CLI binary is not available. " - "Ensure you installed a platform-specific wheel, or set " - "RuntimeConnection.for_stdio(path=...) / " - "RuntimeConnection.for_tcp(path=...)." - ) + # Resolve CLI path: explicit > COPILOT_CLI_PATH env var > downloaded binary. + # Select the environment by identity, not truthiness, so an intentionally + # empty per-connection or client env stays authoritative (the spawned child + # receives that empty mapping) instead of falling back to os.environ and + # unexpectedly honoring a host COPILOT_CLI_PATH. + if connection.env is not None: + effective_env: Mapping[str, str] = connection.env + elif options.env is not None: + effective_env = options.env + else: + effective_env = os.environ + connection.path = self._resolve_runtime_entrypoint(connection.path, env=effective_env) # Resolve use_logged_in_user default if options.use_logged_in_user is None: options.use_logged_in_user = not bool(options.github_token) - self._process: subprocess.Popen | None = None + self._process: Any = None + self._cli_process: subprocess.Popen | None = None self._client: JsonRpcClient | None = None self._state: _ConnectionState = "disconnected" self._sessions: dict[str, CopilotSession] = {} @@ -1242,6 +1623,59 @@ def __init__( if options.session_fs is not None: _validate_session_fs_config(options.session_fs) self._session_fs_config = options.session_fs + self._request_handler = options.request_handler + + def _resolve_runtime_entrypoint( + self, + path: str | None, + *, + env: Mapping[str, str] | None = None, + include_runtime_lib: bool = False, + ) -> str: + """Resolve the runtime executable path (explicit > env > downloaded). + + Sets ``self._cli_path_source`` for diagnostics. When + ``include_runtime_lib`` is set (in-process transport), also ensures the + native runtime library is downloaded alongside the CLI. + + Raises: + RuntimeError: If no runtime path can be resolved. + """ + if path is not None: + self._cli_path_source = "explicit" + return self._ensure_runtime_lib(path) if include_runtime_lib else path + + lookup = env if env is not None else os.environ + env_cli_path = lookup.get("COPILOT_CLI_PATH") + if env_cli_path: + self._cli_path_source = "environment" + return self._ensure_runtime_lib(env_cli_path) if include_runtime_lib else env_cli_path + + downloaded_path = _get_or_download_cli(include_runtime_lib=include_runtime_lib) + if downloaded_path: + self._cli_path_source = "downloaded" + return downloaded_path + + raise RuntimeError( + "Copilot CLI not found. Install a published wheel (which " + "auto-downloads the CLI on first use), set COPILOT_CLI_PATH, " + "or pass an explicit path via " + "RuntimeConnection.for_stdio(path=...) / " + "RuntimeConnection.for_tcp(path=...)." + ) + + @staticmethod + def _ensure_runtime_lib(cli_path: str) -> str: + """Ensure the in-process runtime library sits next to a user-supplied CLI. + + For explicit/``COPILOT_CLI_PATH`` entrypoints, the native library may + already be bundled (dev ``prebuilds`` layout); otherwise it is fetched on + first use. Returns ``cli_path`` unchanged. + """ + from ._cli_download import ensure_runtime_library + + ensure_runtime_library(cli_path) + return cli_path @property def rpc(self) -> ServerRpc: @@ -1384,6 +1818,17 @@ async def start(self) -> None: start_time, ) + if self._options.builtin_plugin_directories: + assert self._client is not None + try: + await self._client.request( + "plugins.builtin.set", + {"paths": list(self._options.builtin_plugin_directories)}, + ) + except Exception: + await self.force_stop() + raise + if self._session_fs_config: session_fs_start = time.perf_counter() await self._set_session_fs_provider() @@ -1394,6 +1839,9 @@ async def start(self) -> None: session_fs_start, ) + if self._request_handler is not None: + await self._set_llm_inference_provider() + self._state = "connected" log_timing( logger, @@ -1422,8 +1870,9 @@ async def start(self) -> None: exc_info=True, ) # Check if process exited and capture any remaining stderr - if self._process and hasattr(self._process, "poll"): - return_code = self._process.poll() + process = self._cli_process if self._cli_process is not None else self._process + if process and hasattr(process, "poll"): + return_code = process.poll() if return_code is not None and self._client: stderr_output = self._client.get_stderr_output() if stderr_output: @@ -1438,8 +1887,9 @@ async def stop(self) -> None: This method performs graceful cleanup: 1. Closes all active sessions (releases in-memory resources) - 2. Closes the JSON-RPC connection - 3. Terminates the CLI server process (if spawned by this client) + 2. Requests runtime shutdown for SDK-owned CLI processes + 3. Closes the JSON-RPC connection + 4. Terminates the CLI server process (if spawned by this client) Note: session data on disk is preserved, so sessions can be resumed later. To permanently remove session data before stopping, call @@ -1476,6 +1926,30 @@ async def stop(self) -> None: StopError(message=f"Failed to disconnect session {session.session_id}: {e}") ) + if ( + self._rpc is not None + and (self._cli_process is not None or self._ffi_host is not None) + and not self._is_external_server + ): + runtime_shutdown_start = time.perf_counter() + try: + await self._rpc.runtime.shutdown(timeout=_RUNTIME_SHUTDOWN_TIMEOUT_SECONDS) + log_timing( + logger, + logging.DEBUG, + "CopilotClient.stop runtime shutdown complete", + runtime_shutdown_start, + ) + except Exception as e: + log_timing( + logger, + logging.DEBUG, + "CopilotClient.stop runtime shutdown failed", + runtime_shutdown_start, + exc_info=True, + ) + errors.append(StopError(message=f"Failed to gracefully shut down runtime: {e}")) + # Close client if self._client: await self._client.stop() @@ -1486,15 +1960,61 @@ async def stop(self) -> None: async with self._models_cache_lock: self._models_cache = None - # Kill CLI process (only if we spawned it) - if self._process and not self._is_external_server: - self._process.terminate() + # Dispose the in-process FFI host and release the loaded native library. + if self._ffi_host is not None: try: - self._process.wait(timeout=5) - except subprocess.TimeoutExpired: - self._process.kill() + self._ffi_host.dispose() + except Exception: + logger.debug("Error while disposing in-process FFI host", exc_info=True) + self._ffi_host = None self._process = None + # Close TCP socket wrappers without treating them as owned processes. + if self._process is not None and self._process is not self._cli_process: + try: + self._process.terminate() + except Exception: + logger.debug("Error while closing Copilot runtime transport", exc_info=True) + self._process = None + + # Terminate CLI process (only if we spawned it). + # + # Per the runtime.shutdown contract, the runtime completes all cleanup + # *before* responding and then leaves termination to the caller ("callers + # may then terminate the owned runtime process"). It deliberately keeps + # its JSON-RPC server alive to send the response and does not self-exit, + # so there is no point waiting a grace window for a self-exit that will + # never come. Once shutdown has completed (or failed) we terminate the + # child immediately and only wait to reap it. + if self._cli_process and not self._is_external_server: + poll = getattr(self._cli_process, "poll", None) + is_running = poll is None or poll() is None + if is_running: + self._cli_process.terminate() + try: + await asyncio.to_thread( + self._cli_process.wait, + timeout=_CLI_PROCESS_EXIT_TIMEOUT_SECONDS, + ) + except subprocess.TimeoutExpired: + self._cli_process.kill() + try: + await asyncio.to_thread( + self._cli_process.wait, + timeout=_CLI_PROCESS_EXIT_TIMEOUT_SECONDS, + ) + except subprocess.TimeoutExpired as e: + errors.append( + StopError( + message=( + f"Timed out waiting for CLI process to exit after kill: {e}" + ) + ) + ) + if self._process is self._cli_process: + self._process = None + self._cli_process = None + self._state = "disconnected" if not self._is_external_server: self._runtime_port = None @@ -1525,16 +2045,32 @@ async def force_stop(self) -> None: # Close the transport first to signal the server immediately. # For external servers (TCP), this closes the socket. # For spawned processes (stdio), this kills the process. - if self._process: + if self._process is not None or self._cli_process is not None: try: if self._is_external_server: - self._process.terminate() # closes the TCP socket + if self._process is not None: + self._process.terminate() # closes the TCP socket + self._process = None + self._cli_process = None else: - self._process.kill() + if self._process is not None and self._process is not self._cli_process: + self._process.terminate() + if self._cli_process is not None: + self._cli_process.kill() self._process = None + self._cli_process = None except Exception: logger.debug("Error while force-stopping Copilot CLI process", exc_info=True) + # Force-dispose the in-process FFI host before tearing down JSON-RPC. + if self._ffi_host is not None: + try: + self._ffi_host.dispose() + except Exception: + logger.debug("Error while force-disposing in-process FFI host", exc_info=True) + self._ffi_host = None + self._process = None + # Then clean up the JSON-RPC client if self._client: try: @@ -1563,16 +2099,26 @@ async def create_session( client_name: str | None = None, reasoning_effort: ReasoningEffort | None = None, reasoning_summary: ReasoningSummary | None = None, + enable_experimental_mode: bool | None = None, context_tier: ContextTier | None = None, tools: list[Tool] | None = None, system_message: SystemMessageConfig | None = None, + tool_search: ToolSearchConfig | None = None, available_tools: list[str] | ToolSet | None = None, excluded_tools: list[str] | ToolSet | None = None, on_user_input_request: UserInputHandler | None = None, hooks: SessionHooks | None = None, working_directory: str | None = None, + additional_directories: list[str] | None = None, provider: ProviderConfig | None = None, + capi: CapiSessionOptions | None = None, + providers: list[NamedProviderConfig] | None = None, + models: list[ProviderModelConfig] | None = None, enable_session_telemetry: bool | None = None, + enable_citations: bool | None = None, + enable_file_change_tracking: bool | None = None, + excluded_builtin_agents: list[str] | None = None, + session_limits: SessionLimitsConfig | None = None, skip_custom_instructions: bool | None = None, custom_agents_local_only: bool | None = None, coauthor_enabled: bool | None = None, @@ -1599,11 +2145,14 @@ async def create_session( plugin_directories: list[str] | None = None, instruction_directories: list[str] | None = None, disabled_skills: list[str] | None = None, + disabled_mcp_servers: list[str] | None = None, infinite_sessions: InfiniteSessionConfig | None = None, large_output: LargeToolOutputConfig | None = None, + memory: MemoryConfiguration | None = None, on_event: Callable[[SessionEvent], None] | None = None, commands: list[CommandDefinition] | None = None, on_elicitation_request: ElicitationHandler | None = None, + on_mcp_auth_request: McpAuthHandler | None = None, enable_mcp_apps: bool = False, on_exit_plan_mode_request: ExitPlanModeHandler | None = None, on_auto_mode_switch_request: AutoModeSwitchHandler | None = None, @@ -1616,7 +2165,12 @@ async def create_session( request_extensions: bool | None = None, extension_sdk_path: str | None = None, extension_info: ExtensionInfo | None = None, + canvas_provider: CanvasProviderIdentity | None = None, canvas_handler: CanvasHandler | None = None, + exp_assignments: CopilotExpAssignmentResponse | None = None, + enable_managed_settings: bool | None = None, + github_mcp_tool_config: GitHubMcpToolConfig | None = None, + managed_settings: ManagedSettings | None = None, ) -> CopilotSession: """ Create a new conversation session with the Copilot CLI. @@ -1636,6 +2190,9 @@ async def create_session( reasoning_summary: Reasoning summary mode for supported models. Use ``"none"`` to suppress summary output regardless of whether reasoning is enabled. + enable_experimental_mode: Controls whether the session enables + experimental features. Defaults to ``False`` in ``"empty"`` + mode; otherwise the runtime decides when omitted. context_tier: Context window tier for models that support it. Use ``"long_context"`` to pin the session to the long-context tier. tools: Custom tools to register with the session. @@ -1653,12 +2210,37 @@ async def create_session( hooks: Lifecycle hooks for the session. working_directory: Working directory for the session. provider: Provider configuration for Azure or custom endpoints. + capi: CAPI provider-scoped options. WebSocket transport is the + default for the CAPI Responses API whenever the model advertises + the ``ws:/responses`` endpoint. Set + ``enable_web_socket_responses=False`` to force the HTTP + Responses transport, which is useful behind proxies where + WebSockets fail. This is equivalent to setting the + ``COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`` environment + variable. The option is under the ``capi`` namespace because a + single session can host multiple providers (CAPI + BYOK), so + transport choice is provider-level. + providers: Named BYOK provider connections. Additive to Copilot API + auth (unlike `provider`); combine with `models`. Cannot be + combined with `provider`. + models: BYOK model definitions added to the selectable model list, + each referencing a `providers` entry by name. enable_session_telemetry: Enables or disables internal session telemetry for this session. When False, disables session telemetry. When omitted or True, telemetry is enabled for GitHub-authenticated sessions. When a custom provider (BYOK) is configured, session telemetry is always disabled regardless of this setting. This is independent of the client OpenTelemetry configuration. + enable_citations: **Experimental.** Enables native model citations for + supported providers. + enable_file_change_tracking: Opts in to capturing file changes from the + first turn for session rewind and cumulative session diff. + excluded_builtin_agents: Built-in agent names to exclude from the + session. Excluded built-in agents are hidden from discovery and + cannot be selected or invoked unless a custom agent with the same + name is configured. + session_limits: **Experimental.** Limits applied to this session's + current accounting window. model_capabilities: Override individual model capabilities resolved by the runtime. streaming: Whether to enable streaming responses. include_sub_agent_streaming_events: Whether to include sub-agent streaming @@ -1680,13 +2262,9 @@ async def create_session( including tool visibility controls. agent: Agent to use for the session. config_directory: Override for the configuration directory. - enable_config_discovery: When True, automatically discovers MCP server - configurations (e.g. ``.mcp.json``, ``.vscode/mcp.json``) and skill - directories from the working directory and merges them with any - explicitly provided ``mcp_servers`` and ``skill_directories``, with - explicit values taking precedence on name collision. Custom instruction - files (``.github/copilot-instructions.md``, ``AGENTS.md``, etc.) are - always loaded regardless of this setting. + enable_config_discovery: Enables runtime discovery of supported + configuration. Explicitly supplied configuration takes precedence + over discovered values. skip_embedding_retrieval: When True, skips embedding-based retrieval. organization_custom_instructions: Organization-level custom instructions. enable_on_demand_instruction_discovery: Enables on-demand instruction file @@ -1699,7 +2277,12 @@ async def create_session( instruction_directories: Additional directories to search for custom instruction files. disabled_skills: Skills to disable. + disabled_mcp_servers: Exact MCP server names to disable only for this + session. Disabled servers are not started or authenticated on + create or cold resume; a resident resume cannot stop servers + already running. This does not change global MCP settings. infinite_sessions: Infinite session configuration. + memory: Session memory configuration. cloud: Creates a remote session in the cloud instead of a local session. Optionally associates repository metadata with the cloud session. @@ -1713,6 +2296,43 @@ async def create_session( override) is on; otherwise the request is silently dropped. Inspect ``capabilities.ui.mcpApps`` on the create response to detect the drop. + github_mcp_tool_config: Configuration for the built-in GitHub MCP + server, sent as ``githubMcpToolConfig`` on ``session.create``. + Supports ``enable_all_tools``, ``additional_toolsets``, + ``additional_tools``, ``enable_insiders_mode``, and + ``disable_form_deferral``. Setting ``disable_form_deferral`` + makes form-backed GitHub write tools execute directly instead + of returning an awaiting-form stub; it does not enable MCP Apps + on its own and has no effect unless MCP Apps are enabled for + the session (see ``enable_mcp_apps``). Omitted from the wire + payload entirely when None. + exp_assignments: ExP assignment ("flight") data injected by a + trusted integrator, in the same JSON shape the Copilot CLI + fetches from the experimentation service + (``CopilotExpAssignmentResponse``). When supplied, the runtime + feeds it into the same feature-flag path as CLI-fetched + assignments and stamps it onto telemetry and the CAPI request + header. When absent, the session does not block on ExP. Intended + for out-of-process integrators that fetch ExP data themselves; + malformed payloads are dropped by the runtime (fail-open). This + is an internal/trusted-integrator option. Sent on the wire as + ``expAssignments``. + enable_managed_settings: Opt-in flag. When ``True``, the runtime + self-fetches enterprise managed settings (bypass-permissions + policy) at session bootstrap using the session's ``github_token``. + Requires ``github_token`` to be set; if omitted, the runtime is + expected to reject session creation (fail-closed). When unset, + behaves exactly as before. Sent on the wire as + ``enableManagedSettings``. + managed_settings: Host-injected enterprise managed settings for the + session. Supplies managed policy directly instead of + self-fetching; the runtime validates it and composes it + restrictively with any self-fetched (server) and device-managed + layers. Startup-only and not persisted: re-supply on + :meth:`resume_session` (omitting it clears the injected layer). + May be combined with ``enable_managed_settings``. Requires a + runtime whose RPC schema includes ``managedSettings``. Sent on + the wire as ``managedSettings``. Returns: A :class:`CopilotSession` instance for the new session. @@ -1750,6 +2370,12 @@ async def create_session( definition["overridesBuiltInTool"] = True if tool.skip_permission: definition["skipPermission"] = True + if tool.defer is not None: + definition["defer"] = tool.defer + if tool.metadata is not None: + definition["metadata"] = tool.metadata + if tool.is_terminal: + definition["isTerminal"] = True tool_defs.append(definition) # Empty-mode validation and normalization @@ -1765,6 +2391,7 @@ async def create_session( # caller-supplied values win. enable_session_telemetry = _enable_session_telemetry_default(mode, enable_session_telemetry) skip_embedding_retrieval = _skip_embedding_retrieval_default(mode, skip_embedding_retrieval) + memory = _memory_default(mode, memory) enable_on_demand_instruction_discovery = _enable_on_demand_instruction_discovery_default( mode, enable_on_demand_instruction_discovery ) @@ -1774,6 +2401,8 @@ async def create_session( ) enable_session_store = _enable_session_store_default(mode, enable_session_store) enable_skills = _enable_skills_default(mode, enable_skills) + custom_agents_local_only = _custom_agents_local_only_default(mode, custom_agents_local_only) + enable_experimental_mode = _enable_experimental_mode_default(mode, enable_experimental_mode) payload: dict[str, Any] = {} if model: @@ -1784,6 +2413,8 @@ async def create_session( payload["reasoningEffort"] = reasoning_effort if reasoning_summary: payload["reasoningSummary"] = reasoning_summary + if enable_experimental_mode is not None: + payload["isExperimentalMode"] = enable_experimental_mode if context_tier: payload["contextTier"] = context_tier if tool_defs: @@ -1793,6 +2424,9 @@ async def create_session( if wire_system_message: payload["systemMessage"] = wire_system_message + if tool_search is not None: + payload["toolSearch"] = _tool_search_to_wire(tool_search) + if available_tools is not None: payload["availableTools"] = available_tools if excluded_tools is not None: @@ -1812,6 +2446,8 @@ async def create_session( payload["requestElicitation"] = bool(on_elicitation_request) if enable_mcp_apps: payload["requestMcpApps"] = True + if github_mcp_tool_config is not None: + payload["githubMcpToolConfig"] = _github_mcp_tool_config_to_wire(github_mcp_tool_config) payload["requestExitPlanMode"] = bool(on_exit_plan_mode_request) payload["requestAutoModeSwitch"] = bool(on_auto_mode_switch_request) @@ -1837,9 +2473,23 @@ async def create_session( if cloud is not None: payload["cloud"] = _cloud_session_options_to_dict(cloud) + # Add ExP assignment data if provided (trusted integrator) + if exp_assignments is not None: + payload["expAssignments"] = _exp_assignment_response_to_dict(exp_assignments) + + # Opt the runtime into self-fetching enterprise managed settings + if enable_managed_settings is not None: + payload["enableManagedSettings"] = enable_managed_settings + + # Host-injected managed settings (permissions-only contract) + if managed_settings is not None: + payload["managedSettings"] = _managed_settings_to_dict(managed_settings) + # Add working directory if provided if working_directory: payload["workingDirectory"] = working_directory + if additional_directories: + payload["additionalDirectories"] = additional_directories # Add streaming option if provided if streaming is not None: @@ -1852,12 +2502,35 @@ async def create_session( else True ) + # Opt this connection into gitHubTelemetry.event notifications when a + # telemetry handler was registered on the client. + if self._on_github_telemetry is not None: + payload["enableGitHubTelemetryForwarding"] = True + # Add provider configuration if provided if provider: payload["provider"] = self._convert_provider_to_wire_format(provider) + if capi is not None: + payload["capi"] = _capi_session_options_to_wire(capi) + # Add additive BYOK provider/model registry if provided + if providers: + payload["providers"] = [ + self._convert_named_provider_to_wire_format(p) for p in providers + ] + if models: + payload["models"] = [self._convert_model_to_wire_format(m) for m in models] + if enable_session_telemetry is not None: payload["enableSessionTelemetry"] = enable_session_telemetry + if enable_citations is not None: + payload["enableCitations"] = enable_citations + if enable_file_change_tracking is not None: + payload["enableFileChangeTracking"] = enable_file_change_tracking + if excluded_builtin_agents is not None: + payload["excludedBuiltinAgents"] = excluded_builtin_agents + if session_limits is not None: + payload["sessionLimits"] = _session_limits_to_wire(session_limits) # Add model capabilities override if provided if model_capabilities: @@ -1880,6 +2553,8 @@ async def create_session( payload["customAgents"] = [ self._convert_custom_agent_to_wire_format(agent) for agent in custom_agents ] + if custom_agents_local_only is not None: + payload["customAgentsLocalOnly"] = custom_agents_local_only # Add default agent configuration if provided if default_agent: @@ -1926,6 +2601,8 @@ async def create_session( # Add disabled skills configuration if provided if disabled_skills: payload["disabledSkills"] = disabled_skills + if disabled_mcp_servers is not None: + payload["disabledMcpServers"] = disabled_mcp_servers # Add infinite sessions configuration if provided if infinite_sessions: @@ -1945,6 +2622,9 @@ async def create_session( if large_output is not None: payload["largeOutput"] = _large_output_to_wire(large_output) + if memory is not None: + payload["memory"] = _memory_to_wire(memory) + if canvases: payload["canvases"] = [c.to_dict() for c in canvases] if request_canvas_renderer is not None: @@ -1955,6 +2635,8 @@ async def create_session( payload["extensionSdkPath"] = extension_sdk_path if extension_info is not None: payload["extensionInfo"] = extension_info.to_dict() + if canvas_provider is not None: + payload["canvasProvider"] = canvas_provider.to_dict() if not self._client: raise RuntimeError("Client not connected") @@ -1987,7 +2669,13 @@ def _initialize_session(sid: str) -> CopilotSession: to a registered session. """ setup_start = time.perf_counter() - s = CopilotSession(sid, self._client, workspace_path=None) + s = CopilotSession( + sid, + self._client, + workspace_path=None, + managed_settings_enabled=enable_managed_settings is True + or managed_settings is not None, + ) if self._session_fs_config: if create_session_fs_handler is None: raise ValueError( @@ -2008,6 +2696,7 @@ def _initialize_session(sid: str) -> CopilotSession: s._register_tools(tools) s._register_commands(commands) s._register_permission_handler(on_permission_request) + s._register_mcp_auth_handler(on_mcp_auth_request) if on_user_input_request: s._register_user_input_handler(on_user_input_request) if on_elicitation_request: @@ -2018,6 +2707,7 @@ def _initialize_session(sid: str) -> CopilotSession: s._register_auto_mode_switch_handler(on_auto_mode_switch_request) if canvas_handler is not None: s._register_canvas_handler(canvas_handler) + s._register_bearer_token_providers(_collect_bearer_token_callbacks(provider, providers)) if hooks: s._register_hooks(hooks) if transform_callbacks: @@ -2087,6 +2777,11 @@ def _register_inline(raw_response: Any) -> None: f"session.create returned sessionId {response.get('sessionId')} " f"but the caller requested {local_session_id}" ) + if on_mcp_auth_request is not None: + await self._client.request( + "session.eventLog.registerInterest", + {"sessionId": session.session_id, "eventType": "mcp.oauth_required"}, + ) session._workspace_path = response.get("workspacePath") capabilities = response.get("capabilities") session._set_capabilities(capabilities) @@ -2132,16 +2827,26 @@ async def resume_session( client_name: str | None = None, reasoning_effort: ReasoningEffort | None = None, reasoning_summary: ReasoningSummary | None = None, + enable_experimental_mode: bool | None = None, context_tier: ContextTier | None = None, tools: list[Tool] | None = None, system_message: SystemMessageConfig | None = None, + tool_search: ToolSearchConfig | None = None, available_tools: list[str] | ToolSet | None = None, excluded_tools: list[str] | ToolSet | None = None, on_user_input_request: UserInputHandler | None = None, hooks: SessionHooks | None = None, working_directory: str | None = None, + additional_directories: list[str] | None = None, provider: ProviderConfig | None = None, + capi: CapiSessionOptions | None = None, + providers: list[NamedProviderConfig] | None = None, + models: list[ProviderModelConfig] | None = None, enable_session_telemetry: bool | None = None, + enable_citations: bool | None = None, + enable_file_change_tracking: bool | None = None, + excluded_builtin_agents: list[str] | None = None, + session_limits: SessionLimitsConfig | None = None, skip_custom_instructions: bool | None = None, custom_agents_local_only: bool | None = None, coauthor_enabled: bool | None = None, @@ -2168,11 +2873,14 @@ async def resume_session( plugin_directories: list[str] | None = None, instruction_directories: list[str] | None = None, disabled_skills: list[str] | None = None, + disabled_mcp_servers: list[str] | None = None, infinite_sessions: InfiniteSessionConfig | None = None, large_output: LargeToolOutputConfig | None = None, + memory: MemoryConfiguration | None = None, on_event: Callable[[SessionEvent], None] | None = None, commands: list[CommandDefinition] | None = None, on_elicitation_request: ElicitationHandler | None = None, + on_mcp_auth_request: McpAuthHandler | None = None, enable_mcp_apps: bool = False, on_exit_plan_mode_request: ExitPlanModeHandler | None = None, on_auto_mode_switch_request: AutoModeSwitchHandler | None = None, @@ -2185,8 +2893,13 @@ async def resume_session( request_extensions: bool | None = None, extension_sdk_path: str | None = None, extension_info: ExtensionInfo | None = None, + canvas_provider: CanvasProviderIdentity | None = None, canvas_handler: CanvasHandler | None = None, open_canvases: list[OpenCanvasInstance] | None = None, + exp_assignments: CopilotExpAssignmentResponse | None = None, + enable_managed_settings: bool | None = None, + github_mcp_tool_config: GitHubMcpToolConfig | None = None, + managed_settings: ManagedSettings | None = None, ) -> CopilotSession: """ Resume an existing conversation session by its ID. @@ -2206,6 +2919,9 @@ async def resume_session( reasoning_summary: Reasoning summary mode for supported models. Use ``"none"`` to suppress summary output regardless of whether reasoning is enabled. + enable_experimental_mode: Controls whether the session enables + experimental features. Defaults to ``False`` in ``"empty"`` + mode; otherwise the runtime decides when omitted. context_tier: Context window tier for models that support it. Use ``"long_context"`` to pin the session to the long-context tier. tools: Custom tools to register with the session. @@ -2223,12 +2939,38 @@ async def resume_session( hooks: Lifecycle hooks for the session. working_directory: Working directory for the session. provider: Provider configuration for Azure or custom endpoints. + capi: CAPI provider-scoped options. WebSocket transport is the + default for the CAPI Responses API whenever the model advertises + the ``ws:/responses`` endpoint. Set + ``enable_web_socket_responses=False`` to force the HTTP + Responses transport, which is useful behind proxies where + WebSockets fail. This is equivalent to setting the + ``COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`` environment + variable. The option is under the ``capi`` namespace because a + single session can host multiple providers (CAPI + BYOK), so + transport choice is provider-level. + providers: Named BYOK provider connections. Additive to Copilot API + auth (unlike `provider`); combine with `models`. Cannot be + combined with `provider`. + models: BYOK model definitions added to the selectable model list, + each referencing a `providers` entry by name. enable_session_telemetry: Enables or disables internal session telemetry for this session. When False, disables session telemetry. When omitted or True, telemetry is enabled for GitHub-authenticated sessions. When a custom provider (BYOK) is configured, session telemetry is always disabled regardless of this setting. This is independent of the client OpenTelemetry configuration. + enable_citations: **Experimental.** Enables native model citations for + supported providers. + enable_file_change_tracking: Opts in to capturing file changes for + session rewind and cumulative session diff when the resumed session + has a valid baseline. Earlier untracked changes cannot be reconstructed. + excluded_builtin_agents: Built-in agent names to exclude from the + resumed session. Excluded built-in agents are hidden from discovery + and cannot be selected or invoked unless a custom agent with the + same name is configured. + session_limits: **Experimental.** Limits applied to this session's + current accounting window. model_capabilities: Override individual model capabilities resolved by the runtime. streaming: Whether to enable streaming responses. include_sub_agent_streaming_events: Whether to include sub-agent streaming @@ -2250,13 +2992,9 @@ async def resume_session( including tool visibility controls. agent: Agent to use for the session. config_directory: Override for the configuration directory. - enable_config_discovery: When True, automatically discovers MCP server - configurations (e.g. ``.mcp.json``, ``.vscode/mcp.json``) and skill - directories from the working directory and merges them with any - explicitly provided ``mcp_servers`` and ``skill_directories``, with - explicit values taking precedence on name collision. Custom instruction - files (``.github/copilot-instructions.md``, ``AGENTS.md``, etc.) are - always loaded regardless of this setting. + enable_config_discovery: Enables runtime discovery of supported + configuration. Explicitly supplied configuration takes precedence + over discovered values. skip_embedding_retrieval: When True, skips embedding-based retrieval. organization_custom_instructions: Organization-level custom instructions. enable_on_demand_instruction_discovery: Enables on-demand instruction file @@ -2269,7 +3007,12 @@ async def resume_session( instruction_directories: Additional directories to search for custom instruction files. disabled_skills: Skills to disable. + disabled_mcp_servers: Exact MCP server names to disable only for this + session. Disabled servers are not started or authenticated on + create or cold resume; a resident resume cannot stop servers + already running. This does not change global MCP settings. infinite_sessions: Infinite session configuration. + memory: Session memory configuration. on_event: Callback for session events. enable_mcp_apps: **Experimental.** Opt into MCP Apps (SEP-1865) UI passthrough on resume. This parameter is part of an experimental @@ -2280,10 +3023,43 @@ async def resume_session( override) is on; otherwise the request is silently dropped. Inspect ``capabilities.ui.mcpApps`` on the resume response to detect the drop. + github_mcp_tool_config: Configuration for the built-in GitHub MCP + server, sent as ``githubMcpToolConfig`` on ``session.resume``. + Supports ``enable_all_tools``, ``additional_toolsets``, + ``additional_tools``, ``enable_insiders_mode``, and + ``disable_form_deferral``. Setting ``disable_form_deferral`` + makes form-backed GitHub write tools execute directly instead + of returning an awaiting-form stub; it does not enable MCP Apps + on its own and has no effect unless MCP Apps are enabled for + the session (see ``enable_mcp_apps``). Omitted from the wire + payload entirely when None. continue_pending_work: When True, instructs the runtime to continue any tool calls or permission prompts that were still pending when the session was last suspended. When False (the default), the runtime treats pending work as interrupted on resume. + exp_assignments: ExP assignment ("flight") data injected by a + trusted integrator, in the same JSON shape the Copilot CLI + fetches from the experimentation service + (``CopilotExpAssignmentResponse``). When supplied, the runtime + feeds it into the same feature-flag path as CLI-fetched + assignments and stamps it onto telemetry and the CAPI request + header. When absent, the session does not block on ExP. Intended + for out-of-process integrators that fetch ExP data themselves; + malformed payloads are dropped by the runtime (fail-open). This + is an internal/trusted-integrator option. Sent on the wire as + ``expAssignments``. + enable_managed_settings: Opt-in flag. When ``True``, the runtime + self-fetches enterprise managed settings (bypass-permissions + policy) at session bootstrap using the session's ``github_token``. + Requires ``github_token`` to be set; if omitted, the runtime is + expected to reject session creation (fail-closed). When unset, + behaves exactly as before. Sent on the wire as + ``enableManagedSettings``. + managed_settings: Host-injected enterprise managed settings for the + session. Must be re-supplied on resume; it replaces the prior + injected layer, and omitting it clears that layer so warm and + cold resume behave identically. See :meth:`create_session`. Sent + on the wire as ``managedSettings``. Returns: A :class:`CopilotSession` instance for the resumed session. @@ -2323,6 +3099,12 @@ async def resume_session( definition["overridesBuiltInTool"] = True if tool.skip_permission: definition["skipPermission"] = True + if tool.defer is not None: + definition["defer"] = tool.defer + if tool.metadata is not None: + definition["metadata"] = tool.metadata + if tool.is_terminal: + definition["isTerminal"] = True tool_defs.append(definition) # Empty-mode validation and normalization @@ -2335,6 +3117,7 @@ async def resume_session( system_message = _system_message_for_mode(mode, system_message) enable_session_telemetry = _enable_session_telemetry_default(mode, enable_session_telemetry) skip_embedding_retrieval = _skip_embedding_retrieval_default(mode, skip_embedding_retrieval) + memory = _memory_default(mode, memory) enable_on_demand_instruction_discovery = _enable_on_demand_instruction_discovery_default( mode, enable_on_demand_instruction_discovery ) @@ -2344,6 +3127,8 @@ async def resume_session( ) enable_session_store = _enable_session_store_default(mode, enable_session_store) enable_skills = _enable_skills_default(mode, enable_skills) + custom_agents_local_only = _custom_agents_local_only_default(mode, custom_agents_local_only) + enable_experimental_mode = _enable_experimental_mode_default(mode, enable_experimental_mode) payload: dict[str, Any] = {"sessionId": session_id} @@ -2355,6 +3140,8 @@ async def resume_session( payload["reasoningEffort"] = reasoning_effort if reasoning_summary: payload["reasoningSummary"] = reasoning_summary + if enable_experimental_mode is not None: + payload["isExperimentalMode"] = enable_experimental_mode if context_tier: payload["contextTier"] = context_tier if tool_defs: @@ -2362,6 +3149,8 @@ async def resume_session( wire_system_message, transform_callbacks = _extract_transform_callbacks(system_message) if wire_system_message: payload["systemMessage"] = wire_system_message + if tool_search is not None: + payload["toolSearch"] = _tool_search_to_wire(tool_search) if available_tools is not None: payload["availableTools"] = available_tools if excluded_tools is not None: @@ -2369,8 +3158,24 @@ async def resume_session( payload["toolFilterPrecedence"] = "excluded" if provider: payload["provider"] = self._convert_provider_to_wire_format(provider) + if capi is not None: + payload["capi"] = _capi_session_options_to_wire(capi) + if providers: + payload["providers"] = [ + self._convert_named_provider_to_wire_format(p) for p in providers + ] + if models: + payload["models"] = [self._convert_model_to_wire_format(m) for m in models] if enable_session_telemetry is not None: payload["enableSessionTelemetry"] = enable_session_telemetry + if enable_citations is not None: + payload["enableCitations"] = enable_citations + if enable_file_change_tracking is not None: + payload["enableFileChangeTracking"] = enable_file_change_tracking + if excluded_builtin_agents is not None: + payload["excludedBuiltinAgents"] = excluded_builtin_agents + if session_limits is not None: + payload["sessionLimits"] = _session_limits_to_wire(session_limits) if model_capabilities: payload["modelCapabilities"] = _capabilities_to_dict(model_capabilities) if streaming is not None: @@ -2383,6 +3188,11 @@ async def resume_session( else True ) + # Opt this connection into gitHubTelemetry.event notifications when a + # telemetry handler was registered on the client. + if self._on_github_telemetry is not None: + payload["enableGitHubTelemetryForwarding"] = True + # Enable permission request callback if handler provided payload["requestPermission"] = bool(on_permission_request) @@ -2393,6 +3203,8 @@ async def resume_session( payload["requestElicitation"] = bool(on_elicitation_request) if enable_mcp_apps: payload["requestMcpApps"] = True + if github_mcp_tool_config is not None: + payload["githubMcpToolConfig"] = _github_mcp_tool_config_to_wire(github_mcp_tool_config) payload["requestExitPlanMode"] = bool(on_exit_plan_mode_request) payload["requestAutoModeSwitch"] = bool(on_auto_mode_switch_request) @@ -2413,8 +3225,22 @@ async def resume_session( if remote_session is not None: payload["remoteSession"] = remote_session.value + # Add ExP assignment data if provided (trusted integrator) + if exp_assignments is not None: + payload["expAssignments"] = _exp_assignment_response_to_dict(exp_assignments) + + # Opt the runtime into self-fetching enterprise managed settings + if enable_managed_settings is not None: + payload["enableManagedSettings"] = enable_managed_settings + + # Host-injected managed settings (permissions-only contract) + if managed_settings is not None: + payload["managedSettings"] = _managed_settings_to_dict(managed_settings) + if working_directory: payload["workingDirectory"] = working_directory + if additional_directories: + payload["additionalDirectories"] = additional_directories if config_directory: payload["configDir"] = config_directory if enable_config_discovery is not None: @@ -2453,6 +3279,8 @@ async def resume_session( payload["customAgents"] = [ self._convert_custom_agent_to_wire_format(a) for a in custom_agents ] + if custom_agents_local_only is not None: + payload["customAgentsLocalOnly"] = custom_agents_local_only # Add default agent configuration if provided if default_agent: @@ -2468,6 +3296,8 @@ async def resume_session( payload["instructionDirectories"] = instruction_directories if disabled_skills: payload["disabledSkills"] = disabled_skills + if disabled_mcp_servers is not None: + payload["disabledMcpServers"] = disabled_mcp_servers if infinite_sessions: wire_config: dict[str, Any] = {} @@ -2486,6 +3316,9 @@ async def resume_session( if large_output is not None: payload["largeOutput"] = _large_output_to_wire(large_output) + if memory is not None: + payload["memory"] = _memory_to_wire(memory) + if canvases: payload["canvases"] = [c.to_dict() for c in canvases] if open_canvases: @@ -2498,6 +3331,8 @@ async def resume_session( payload["extensionSdkPath"] = extension_sdk_path if extension_info is not None: payload["extensionInfo"] = extension_info.to_dict() + if canvas_provider is not None: + payload["canvasProvider"] = canvas_provider.to_dict() if not self._client: raise RuntimeError("Client not connected") @@ -2510,7 +3345,13 @@ async def resume_session( # Create and register the session before issuing the RPC so that # events emitted by the CLI (e.g. session.start) are not dropped. setup_start = time.perf_counter() - session = CopilotSession(session_id, self._client, workspace_path=None) + session = CopilotSession( + session_id, + self._client, + workspace_path=None, + managed_settings_enabled=enable_managed_settings is True + or managed_settings is not None, + ) if self._session_fs_config: if create_session_fs_handler is None: raise ValueError( @@ -2531,6 +3372,7 @@ async def resume_session( session._register_tools(tools) session._register_commands(commands) session._register_permission_handler(on_permission_request) + session._register_mcp_auth_handler(on_mcp_auth_request) if on_user_input_request: session._register_user_input_handler(on_user_input_request) if on_elicitation_request: @@ -2541,6 +3383,9 @@ async def resume_session( session._register_auto_mode_switch_handler(on_auto_mode_switch_request) if canvas_handler is not None: session._register_canvas_handler(canvas_handler) + session._register_bearer_token_providers( + _collect_bearer_token_callbacks(provider, providers) + ) if hooks: session._register_hooks(hooks) if transform_callbacks: @@ -2578,6 +3423,11 @@ async def resume_session( session._set_open_canvases( [OpenCanvasInstance.from_dict(inst) for inst in open_canvases_raw] ) + if on_mcp_auth_request is not None: + await self._client.request( + "session.eventLog.registerInterest", + {"sessionId": session.session_id, "eventType": "mcp.oauth_required"}, + ) except BaseException as exc: with self._sessions_lock: self._sessions.pop(session_id, None) @@ -2743,7 +3593,7 @@ async def list_sessions(self, filter: SessionListFilter | None = None) -> list[S Example: >>> sessions = await client.list_sessions() >>> for session in sessions: - ... print(f"Session: {session.sessionId}") + ... print(f"Session: {session.session_id}") >>> # Filter sessions by repository >>> from copilot.client import SessionListFilter >>> filtered = await client.list_sessions(SessionListFilter(repository="owner/repo")) @@ -3008,8 +3858,17 @@ async def _verify_protocol_version(self) -> None: server_version: int | None try: - connect_result = await _InternalServerRpc(self._client)._connect( - _ConnectRequest(token=self._effective_connection_token) + connect_params: dict[str, Any] = {} + if self._effective_connection_token is not None: + connect_params["token"] = self._effective_connection_token + # Opt in to GitHub telemetry forwarding at the connection level when a + # handler is registered (mirrors the runtime, which reads this flag on the + # `connect` handshake so the first session's un-replayable `session.start` + # event is forwarded). Also sent on session.create/resume for older CLIs. + if self._on_github_telemetry is not None: + connect_params["enableGitHubTelemetryForwarding"] = True + connect_result = _ConnectResult.from_dict( + await self._client.request("connect", connect_params) ) server_version = connect_result.protocol_version except JsonRpcError as err: @@ -3067,8 +3926,12 @@ def _convert_provider_to_wire_format( wire_provider["apiKey"] = provider["api_key"] if "wire_api" in provider: wire_provider["wireApi"] = provider["wire_api"] + if "transport" in provider: + wire_provider["transport"] = provider["transport"] if "bearer_token" in provider: wire_provider["bearerToken"] = provider["bearer_token"] + if provider.get("bearer_token_provider") is not None: + wire_provider["hasBearerTokenProvider"] = True if "headers" in provider: wire_provider["headers"] = provider["headers"] if "model_id" in provider: @@ -3088,6 +3951,61 @@ def _convert_provider_to_wire_format( wire_provider["azure"] = wire_azure return wire_provider + def _convert_named_provider_to_wire_format( + self, provider: NamedProviderConfig | dict[str, Any] + ) -> dict[str, Any]: + """Convert a named BYOK provider from snake_case to camelCase wire format.""" + wire: dict[str, Any] = {} + if "name" in provider: + wire["name"] = provider["name"] + if "type" in provider: + wire["type"] = provider["type"] + if "wire_api" in provider: + wire["wireApi"] = provider["wire_api"] + if "base_url" in provider: + wire["baseUrl"] = provider["base_url"] + if "api_key" in provider: + wire["apiKey"] = provider["api_key"] + if "bearer_token" in provider: + wire["bearerToken"] = provider["bearer_token"] + if provider.get("bearer_token_provider") is not None: + wire["hasBearerTokenProvider"] = True + if "headers" in provider: + wire["headers"] = provider["headers"] + if "azure" in provider: + azure = provider["azure"] + wire_azure: dict[str, Any] = {} + if "api_version" in azure: + wire_azure["apiVersion"] = azure["api_version"] + if wire_azure: + wire["azure"] = wire_azure + return wire + + def _convert_model_to_wire_format( + self, model: ProviderModelConfig | dict[str, Any] + ) -> dict[str, Any]: + """Convert a BYOK model definition from snake_case to camelCase wire format.""" + wire: dict[str, Any] = {} + if "id" in model: + wire["id"] = model["id"] + if "provider" in model: + wire["provider"] = model["provider"] + if "wire_model" in model: + wire["wireModel"] = model["wire_model"] + if "model_id" in model: + wire["modelId"] = model["model_id"] + if "name" in model: + wire["name"] = model["name"] + if "max_prompt_tokens" in model: + wire["maxPromptTokens"] = model["max_prompt_tokens"] + if "max_context_window_tokens" in model: + wire["maxContextWindowTokens"] = model["max_context_window_tokens"] + if "max_output_tokens" in model: + wire["maxOutputTokens"] = model["max_output_tokens"] + if "capabilities" in model: + wire["capabilities"] = _capabilities_to_dict(model["capabilities"]) + return wire + def _convert_custom_agent_to_wire_format( self, agent: CustomAgentConfig | dict[str, Any] ) -> dict[str, Any]: @@ -3115,6 +4033,8 @@ def _convert_custom_agent_to_wire_format( wire_agent["skills"] = agent["skills"] if "model" in agent: wire_agent["model"] = agent["model"] + if "reasoning_effort" in agent: + wire_agent["reasoningEffort"] = agent["reasoning_effort"] return wire_agent def _convert_default_agent_to_wire_format( @@ -3138,11 +4058,15 @@ async def _start_cli_server(self) -> None: """Start the runtime process. This spawns the runtime as a subprocess using the configured transport - mode (stdio or TCP). + mode (stdio or TCP), or hosts it in-process for the FFI transport. Raises: RuntimeError: If the server fails to start or times out. """ + if isinstance(self._connection, InProcessRuntimeConnection): + await self._start_inprocess_ffi() + return + assert isinstance(self._connection, ChildProcessRuntimeConnection) conn = self._connection opts = self._options @@ -3195,8 +4119,13 @@ async def _start_cli_server(self) -> None: }, ) - # Get environment variables - if opts.env is None: + # Get environment variables. Per-connection env (ChildProcessRuntimeConnection.env) + # takes precedence over the client-level env; the constructor already rejects + # setting both. When neither is set, inherit the current process environment. + conn_env = conn.env if isinstance(conn, ChildProcessRuntimeConnection) else None + if conn_env is not None: + env = dict(conn_env) + elif opts.env is None: env = dict(os.environ) else: env = dict(opts.env) @@ -3221,6 +4150,8 @@ async def _start_cli_server(self) -> None: env["COPILOT_OTEL_ENABLED"] = "true" if "otlp_endpoint" in telemetry: env["OTEL_EXPORTER_OTLP_ENDPOINT"] = telemetry["otlp_endpoint"] + if "otlp_protocol" in telemetry: + env["OTEL_EXPORTER_OTLP_PROTOCOL"] = telemetry["otlp_protocol"] if "file_path" in telemetry: env["COPILOT_OTEL_FILE_EXPORTER_PATH"] = telemetry["file_path"] if "exporter_type" in telemetry: @@ -3252,6 +4183,7 @@ async def _start_cli_server(self) -> None: env=env, creationflags=creationflags, ) + self._cli_process = self._process else: if tcp_port > 0: args.extend(["--port", str(tcp_port)]) @@ -3264,6 +4196,7 @@ async def _start_cli_server(self) -> None: env=env, creationflags=creationflags, ) + self._cli_process = self._process log_timing( logger, logging.DEBUG, @@ -3307,6 +4240,69 @@ async def read_port(): except TimeoutError: raise RuntimeError("Timeout waiting for CLI server to start") + async def _start_inprocess_ffi(self) -> None: + """Host the runtime in-process via the native FFI library. + + Loads the native runtime library and opens the FFI JSON-RPC connection. + + Raises: + RuntimeError: If the native library is missing or startup fails. + """ + assert isinstance(self._connection, InProcessRuntimeConnection) + runtime_path = self._inprocess_runtime_path + assert runtime_path is not None # resolved in __init__ + + logger.info( + "CopilotClient._start_inprocess_ffi hosting Copilot runtime in-process", + extra={"runtime_path": runtime_path, "runtime_path_source": self._cli_path_source}, + ) + + opts = self._options + args: list[str] = [] + if opts.log_level: + args.extend(["--log-level", opts.log_level]) + if opts.github_token: + args.extend(["--auth-token-env", "COPILOT_SDK_AUTH_TOKEN"]) + if not opts.use_logged_in_user: + args.append("--no-auto-login") + if opts.session_idle_timeout_seconds is not None and opts.session_idle_timeout_seconds > 0: + args.extend(["--session-idle-timeout", str(opts.session_idle_timeout_seconds)]) + if opts.enable_remote_sessions: + args.append("--remote") + + environment: dict[str, str] = {} + if opts.github_token: + environment["COPILOT_SDK_AUTH_TOKEN"] = opts.github_token + if opts.base_directory: + environment["COPILOT_HOME"] = opts.base_directory + if opts.mode == "empty": + environment["COPILOT_DISABLE_KEYTAR"] = "1" + + host = FfiRuntimeHost.create( + runtime_path, + environment=environment or None, + args=tuple(args), + ) + + # Track the host and expose its process-like adapter *before* the blocking + # handshake. asyncio.to_thread keeps running host_start after a cancellation + # (a thread can't be interrupted), and CancelledError bypasses start()'s + # `except Exception`, so assigning here — as .NET does before StartAsync — + # keeps a completed native host owned so stop()/force_stop() can dispose it + # instead of leaking it. + self._ffi_host = host + self._process = host.process + + ffi_start = time.perf_counter() + # Native startup may block, so run the handshake off the event loop. + await asyncio.to_thread(host.start_blocking) + log_timing( + logger, + logging.DEBUG, + "CopilotClient._start_inprocess_ffi FFI host started", + ffi_start, + ) + async def _connect_to_server(self) -> None: """Connect to the runtime via the configured transport. @@ -3316,7 +4312,9 @@ async def _connect_to_server(self) -> None: RuntimeError: If the connection fails. """ setup_start = time.perf_counter() - if isinstance(self._connection, StdioRuntimeConnection): + if isinstance(self._connection, (StdioRuntimeConnection, InProcessRuntimeConnection)): + # The in-process FFI host exposes a process-like adapter (stdin/stdout), + # so the same stdio JSON-RPC wiring drives it unchanged. await self._connect_via_stdio() else: await self._connect_via_tcp() @@ -3369,11 +4367,11 @@ def handle_notification(method: str, params: dict): self._client.set_request_handler( "autoModeSwitch.request", self._handle_auto_mode_switch_request ) - self._client.set_request_handler("hooks.invoke", self._handle_hooks_invoke) self._client.set_request_handler( "systemMessage.transform", self._handle_system_message_transform ) register_client_session_api_handlers(self._client, self._get_client_session_handlers) + self._register_client_global_handlers() # Start listening for messages loop = asyncio.get_running_loop() @@ -3488,11 +4486,11 @@ def handle_notification(method: str, params: dict): self._client.set_request_handler( "autoModeSwitch.request", self._handle_auto_mode_switch_request ) - self._client.set_request_handler("hooks.invoke", self._handle_hooks_invoke) self._client.set_request_handler( "systemMessage.transform", self._handle_system_message_transform ) register_client_session_api_handlers(self._client, self._get_client_session_handlers) + self._register_client_global_handlers() # Start listening for messages loop = asyncio.get_running_loop() @@ -3565,6 +4563,36 @@ async def _set_session_fs_provider(self) -> None: await self._client.request("sessionFs.setProvider", params) + def _register_client_global_handlers(self) -> None: + if not self._client: + return + llm_inference_adapter = None + if self._request_handler is not None: + llm_inference_adapter = create_copilot_request_adapter( + self._request_handler, + lambda: self._rpc.llm_inference if self._rpc is not None else None, + ) + github_telemetry_adapter = None + if self._on_github_telemetry is not None: + github_telemetry_adapter = _GitHubTelemetryAdapter(self._on_github_telemetry) + register_client_global_api_handlers( + self._client, + ClientGlobalApiHandlers( + hooks=_HooksAdapter(self._get_session), + llm_inference=llm_inference_adapter, + git_hub_telemetry=github_telemetry_adapter, + ), + ) + + def _get_session(self, session_id: str) -> CopilotSession | None: + with self._sessions_lock: + return self._sessions.get(session_id) + + async def _set_llm_inference_provider(self) -> None: + if self._request_handler is None or self._rpc is None: + return + await self._rpc.llm_inference.set_provider() + def _get_client_session_handlers(self, session_id: str) -> ClientSessionApiHandlers: with self._sessions_lock: session = self._sessions.get(session_id) @@ -3632,34 +4660,6 @@ async def _handle_auto_mode_switch_request(self, params: dict) -> dict: response = await session._handle_auto_mode_switch_request(params) return {"response": response} - async def _handle_hooks_invoke(self, params: dict) -> dict: - """ - Handle a hooks invocation from the CLI server. - - Args: - params: The hooks invocation parameters from the server. - - Returns: - A dict containing the hook output. - - Raises: - ValueError: If the request payload is invalid. - """ - session_id = params.get("sessionId") - hook_type = params.get("hookType") - input_data = params.get("input") - - if not session_id or not hook_type: - raise ValueError("invalid hooks invoke payload") - - with self._sessions_lock: - session = self._sessions.get(session_id) - if not session: - raise ValueError(f"unknown session {session_id}") - - output = await session._handle_hooks_invoke(hook_type, input_data) - return {"output": output} - async def _handle_system_message_transform(self, params: dict) -> dict: """Handle a systemMessage.transform request from the CLI server.""" session_id = params.get("sessionId") diff --git a/python/copilot/copilot_request_handler.py b/python/copilot/copilot_request_handler.py new file mode 100644 index 000000000..e6465b7bb --- /dev/null +++ b/python/copilot/copilot_request_handler.py @@ -0,0 +1,751 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""CopilotRequestHandler: observe or replace outbound model-layer HTTP/WebSocket requests. + +The SDK consumer subclasses :class:`CopilotRequestHandler` and overrides one or +both seams: + +* HTTP — override :meth:`CopilotRequestHandler.send_request` to mutate the + :class:`httpx.Request`, post-process the :class:`httpx.Response`, or replace + the call entirely. The default forwards via a shared :class:`httpx.AsyncClient`. +* WebSocket — override :meth:`CopilotRequestHandler.open_websocket` to return + a per-connection :class:`CopilotWebSocketHandler`. The default opens a + transparent forwarding connection via the ``websockets`` library. + +:func:`create_copilot_request_adapter` converts a handler into the generated +:class:`~copilot.generated.rpc.LlmInferenceHandler` shape so the RPC dispatcher +can route inbound ``httpRequestStart`` / ``httpRequestChunk`` frames through it. +""" + +from __future__ import annotations + +import asyncio +import base64 +from collections.abc import AsyncIterator, Callable +from dataclasses import dataclass, field +from typing import TYPE_CHECKING, Any + +from .generated.rpc import ( + LlmInferenceHTTPRequestChunkRequest, + LlmInferenceHTTPRequestChunkResult, + LlmInferenceHTTPRequestStartRequest, + LlmInferenceHTTPRequestStartResult, + LlmInferenceHTTPResponseChunkError, + LlmInferenceHTTPResponseChunkRequest, + LlmInferenceHTTPResponseStartRequest, + ServerLlmInferenceApi, +) + +if TYPE_CHECKING: + import httpx + +# Multi-valued headers: header name → list of values. +LlmInferenceHeaders = dict[str, list[str]] + +# Hop-by-hop and length headers the transport recomputes; forwarding them +# verbatim corrupts the request. +_FORBIDDEN_REQUEST_HEADERS = frozenset( + { + "host", + "connection", + "content-length", + "transfer-encoding", + "keep-alive", + "upgrade", + "proxy-connection", + "te", + "trailer", + } +) + +_shared_http_client: httpx.AsyncClient | None = None + + +def _get_shared_http_client() -> httpx.AsyncClient: + global _shared_http_client + if _shared_http_client is None: + import httpx + + _shared_http_client = httpx.AsyncClient(timeout=None, follow_redirects=False) + return _shared_http_client + + +@dataclass +class CopilotRequestContext: + """Per-request context handed to every :class:`CopilotRequestHandler` hook.""" + + request_id: str + """Opaque runtime-minted id, stable across the request lifecycle.""" + + transport: str + """``"http"`` (plain HTTP / SSE) or ``"websocket"`` (full-duplex channel).""" + + url: str + """Absolute request URL.""" + + headers: LlmInferenceHeaders + """HTTP request headers, multi-valued.""" + + cancel_event: asyncio.Event + """Set when the runtime cancels this in-flight request. Pass it through to + your transport so the upstream call is torn down too.""" + + session_id: str | None = None + """Id of the runtime session that triggered this request, when in scope. + Absent for out-of-session requests (e.g. the startup model catalog).""" + + agent_id: str | None = None + """Stable per-agent-instance id for the agent trajectory that issued this request.""" + + parent_agent_id: str | None = None + """Id of the parent agent when this request was issued by a subagent.""" + + interaction_type: str | None = None + """Runtime classification for the interaction that produced this request.""" + + _bridge: _CopilotWebSocketResponseBridge | None = field(default=None, repr=False) + + +@dataclass +class CopilotWebSocketCloseStatus: + """Terminal status for a callback-owned WebSocket connection.""" + + description: str | None = None + error_code: str | None = None + error: BaseException | None = None + + @classmethod + def normal_closure(cls) -> CopilotWebSocketCloseStatus: + return cls() + + +class CopilotWebSocketHandler: + """Per-connection WebSocket handler returned by + :meth:`CopilotRequestHandler.open_websocket`. + + Subclass and override :meth:`send_request_message` (runtime → upstream) to + mutate, drop, or inject messages, and :meth:`send_response_message` + (upstream → runtime) for the reverse direction. A full transport replacement + overrides :meth:`open` to stand up its own connection and receive loop. + """ + + def __init__(self, context: CopilotRequestContext) -> None: + bridge = context._bridge + if bridge is None: + raise RuntimeError("WebSocket response bridge is not attached") + self.context = context + self._response = bridge + self._completion: asyncio.Future[CopilotWebSocketCloseStatus] = ( + asyncio.get_event_loop().create_future() + ) + self._closed = False + self._suppress_close_on_dispose = False + + async def send_response_message(self, data: str | bytes) -> None: + """Forward an upstream message to the runtime response.""" + await self._response.write(data) + + async def send_request_message(self, data: str | bytes) -> None: + """Forward a runtime message to the upstream connection. Override to mutate.""" + raise NotImplementedError + + async def close(self, status: CopilotWebSocketCloseStatus | None = None) -> None: + """Initiate close: end the runtime response and resolve completion.""" + if self._closed: + return + self._closed = True + status = status or CopilotWebSocketCloseStatus.normal_closure() + if status.error is not None: + await self._response.error(status.description or str(status.error), status.error_code) + else: + await self._response.end() + if not self._completion.done(): + self._completion.set_result(status) + + async def open(self) -> None: + """Establish the connection. Default is a no-op for custom transports.""" + + async def aclose(self) -> None: + """Final resource cleanup; closes normally if not already closed.""" + if not self._suppress_close_on_dispose and not self._closed: + await self.close(CopilotWebSocketCloseStatus.normal_closure()) + + +class CopilotWebSocketForwarder(CopilotWebSocketHandler): + """Default pass-through WebSocket handler backed by the ``websockets`` library.""" + + def __init__(self, context: CopilotRequestContext) -> None: + super().__init__(context) + self._upstream: Any | None = None + self._receive_task: asyncio.Task[None] | None = None + + async def send_request_message(self, data: str | bytes) -> None: + if self._upstream is None: + return + await self._upstream.send(data) + + async def open(self) -> None: + if self._upstream is not None: + return + try: + import websockets + except ImportError as exc: # pragma: no cover - optional dependency + raise RuntimeError( + "WebSocket forwarding requires the 'websockets' package. " + "Install it or override open_websocket()." + ) from exc + + headers = [ + (name, value) + for name, values in self.context.headers.items() + if name.lower() not in _FORBIDDEN_REQUEST_HEADERS + for value in (values or []) + ] + self._upstream = await websockets.connect(self.context.url, additional_headers=headers) + self._receive_task = asyncio.create_task(self._receive_loop()) + + async def _receive_loop(self) -> None: + try: + async for message in self._upstream: # type: ignore[union-attr] + await self.send_response_message(message) + await self.close(CopilotWebSocketCloseStatus.normal_closure()) + except asyncio.CancelledError: + raise + except Exception as exc: + await self.close(CopilotWebSocketCloseStatus(description=str(exc), error=exc)) + + async def close(self, status: CopilotWebSocketCloseStatus | None = None) -> None: + if self._upstream is not None: + try: + await self._upstream.close() + except Exception: + # Best-effort; the socket may already be closed. + pass + await super().close(status) + + async def aclose(self) -> None: + try: + await super().aclose() + finally: + if self._receive_task is not None: + self._receive_task.cancel() + if self._upstream is not None: + try: + await self._upstream.close() + except Exception: + # Best-effort teardown: the upstream may already be closed. + pass + + +class CopilotRequestHandler: + """Base class for consumers that observe or replace LLM inference requests. + + Override :meth:`send_request` to intercept HTTP model-layer requests, or + :meth:`open_websocket` to intercept WebSocket connections. An instance + that overrides nothing is a transparent pass-through. + """ + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + """Send an HTTP request. Override to mutate request/response or replace the call.""" + return await _get_shared_http_client().send(request, stream=True) + + async def open_websocket(self, ctx: CopilotRequestContext) -> CopilotWebSocketHandler: + """Open a per-connection WebSocket handler. Override to mutate or replace.""" + return CopilotWebSocketForwarder(ctx) + + async def _dispatch(self, exchange: _CopilotRequestExchange) -> None: + bridge = _CopilotWebSocketResponseBridge(exchange) + ctx = CopilotRequestContext( + request_id=exchange.request_id, + session_id=exchange.session_id, + agent_id=exchange.agent_id, + parent_agent_id=exchange.parent_agent_id, + interaction_type=exchange.interaction_type, + transport=exchange.transport, + url=exchange.url, + headers=exchange.headers, + cancel_event=exchange.cancel_event, + _bridge=bridge, + ) + if exchange.transport == "websocket": + await self._handle_web_socket(exchange, ctx) + else: + await self._handle_http(exchange, ctx) + + async def _handle_http( + self, exchange: _CopilotRequestExchange, ctx: CopilotRequestContext + ) -> None: + request = await _build_httpx_request(exchange) + await _run_cancellable(self._forward_http(request, exchange, ctx), exchange.cancel_event) + + async def _forward_http( + self, + request: httpx.Request, + exchange: _CopilotRequestExchange, + ctx: CopilotRequestContext, + ) -> None: + response = await self.send_request(request, ctx) + try: + await _stream_response_to_exchange(response, exchange) + finally: + await response.aclose() + + async def _handle_web_socket( + self, exchange: _CopilotRequestExchange, ctx: CopilotRequestContext + ) -> None: + handler = await self.open_websocket(ctx) + assert ctx._bridge is not None + try: + await handler.open() + # Emit the 101 upgrade head eagerly. The runtime blocks the WS + # connect until it receives this acknowledgement, and only then + # starts forwarding inbound messages as request-body chunks. + # Waiting for the first upstream message would deadlock. + await ctx._bridge.start() + + async def pump_client() -> str: + async for chunk in exchange.request_body: + await handler.send_request_message(_decode_frame(chunk)) + return "client-complete" + + client_task = asyncio.create_task(pump_client()) + completion = asyncio.ensure_future(handler._completion) + done, _ = await asyncio.wait( + {client_task, completion}, return_when=asyncio.FIRST_COMPLETED + ) + + if client_task in done and client_task.exception() is not None: + handler._suppress_close_on_dispose = True + raise client_task.exception() # type: ignore[misc] + + if client_task in done: + await handler.close(CopilotWebSocketCloseStatus.normal_closure()) + await handler._completion + return + + status = await handler._completion + if status.error is not None: + raise status.error + finally: + await handler.aclose() + + +# --------------------------------------------------------------------------- +# Internal exchange: request body feed + response emitter +# --------------------------------------------------------------------------- + + +@dataclass +class _BodyItem: + chunk: bytes | None = None + end: bool = False + cancel: bool = False + cancel_reason: str | None = None + + +class _BodyQueue: + """An async iterator of request-body byte chunks fed by the runtime.""" + + def __init__(self) -> None: + self._queue: asyncio.Queue[_BodyItem] = asyncio.Queue() + self._done = False + + def push(self, item: _BodyItem) -> None: + self._queue.put_nowait(item) + + def __aiter__(self) -> AsyncIterator[bytes]: + return self + + async def __anext__(self) -> bytes: + if self._done: + raise StopAsyncIteration + item = await self._queue.get() + if item.cancel: + self._done = True + reason = ( + f"Request cancelled by runtime: {item.cancel_reason}" + if item.cancel_reason + else "Request cancelled by runtime" + ) + raise RuntimeError(reason) + if item.end: + self._done = True + raise StopAsyncIteration + return item.chunk if item.chunk is not None else b"" + + +class _CopilotRequestExchange: + """One intercepted request in flight. + + Carries the request body stream the runtime feeds via ``httpRequestChunk`` + frames, and emits the handler's response directly to the runtime through + the generated ``llmInference`` RPC. Replaces the former provider / sink / + response-channel indirection with a single object the adapter owns. + """ + + def __init__( + self, + request_id: str, + get_server_rpc: Callable[[], ServerLlmInferenceApi | None], + ) -> None: + self.request_id = request_id + self.session_id: str | None = None + self.agent_id: str | None = None + self.parent_agent_id: str | None = None + self.interaction_type: str | None = None + self.method: str = "GET" + self.url: str = "" + self.headers: dict[str, list[str]] = {} + self.transport: str = "http" + self._get_server_rpc = get_server_rpc + self._queue = _BodyQueue() + self.cancel_event: asyncio.Event = asyncio.Event() + self.started: bool = False + self.finished: bool = False + self.cancelled: bool = False + self.task: asyncio.Task[None] | None = None + + def set_context(self, params: LlmInferenceHTTPRequestStartRequest) -> None: + """Fill in the request context once the matching start frame arrives.""" + self.session_id = params.session_id + self.agent_id = params.agent_id + self.parent_agent_id = params.parent_agent_id + self.interaction_type = params.interaction_type + self.method = params.method + self.url = params.url + self.headers = params.headers + transport = params.transport + self.transport = transport.value if transport is not None else "http" + + @property + def request_body(self) -> _BodyQueue: + return self._queue + + def _require_rpc(self) -> ServerLlmInferenceApi: + rpc = self._get_server_rpc() + if rpc is None: + raise RuntimeError("Copilot request response used after RPC connection closed.") + return rpc + + async def start_response( + self, + status: int, + status_text: str | None = None, + headers: LlmInferenceHeaders | None = None, + ) -> None: + if self.started: + raise RuntimeError("Copilot request response start() called twice.") + if self.finished: + raise RuntimeError("Copilot request response already finished.") + self.started = True + await self._require_rpc().http_response_start( + LlmInferenceHTTPResponseStartRequest( + headers=headers or {}, + request_id=self.request_id, + status=status, + status_text=status_text, + ) + ) + + async def write_response(self, data: str | bytes) -> None: + if self.cancelled: + raise RuntimeError("Copilot request was cancelled by the runtime.") + if not self.started: + raise RuntimeError("Copilot request response write() called before start().") + if self.finished: + raise RuntimeError("Copilot request response write() called after end()/error().") + is_binary = isinstance(data, (bytes, bytearray)) + payload = base64.b64encode(bytes(data)).decode("ascii") if is_binary else str(data) + await self._require_rpc().http_response_chunk( + LlmInferenceHTTPResponseChunkRequest( + data=payload, + request_id=self.request_id, + binary=is_binary or None, + end=False, + ) + ) + + async def end_response(self) -> None: + if self.finished: + return + self.finished = True + await self._require_rpc().http_response_chunk( + LlmInferenceHTTPResponseChunkRequest(data="", request_id=self.request_id, end=True) + ) + + async def error_response(self, message: str, code: str | None = None) -> None: + if self.finished: + return + self.finished = True + await self._require_rpc().http_response_chunk( + LlmInferenceHTTPResponseChunkRequest( + data="", + request_id=self.request_id, + end=True, + error=LlmInferenceHTTPResponseChunkError(message=message, code=code), + ) + ) + + +# --------------------------------------------------------------------------- +# Adapter: wires the handler into the generated RPC handler shape +# --------------------------------------------------------------------------- + + +def create_copilot_request_adapter( + handler: CopilotRequestHandler, + get_server_rpc: Callable[[], ServerLlmInferenceApi | None], +) -> _CopilotRequestAdapterHandler: + """Adapt a :class:`CopilotRequestHandler` into the generated handler shape. + + Maintains a per-``request_id`` table of :class:`_CopilotRequestExchange`: + each ``httpRequestStart`` allocates one and fires the handler in the + background, returning immediately so the runtime's RPC reply is not gated + on the consumer's I/O. Subsequent ``httpRequestChunk`` frames are routed + into the matching exchange's body stream. + """ + return _CopilotRequestAdapterHandler(handler, get_server_rpc) + + +class _CopilotRequestAdapterHandler: + def __init__( + self, + handler: CopilotRequestHandler, + get_server_rpc: Callable[[], ServerLlmInferenceApi | None], + ) -> None: + self._handler = handler + self._get_server_rpc = get_server_rpc + self._pending: dict[str, _CopilotRequestExchange] = {} + + def _route_chunk( + self, + exchange: _CopilotRequestExchange, + params: LlmInferenceHTTPRequestChunkRequest, + ) -> None: + if params.cancel: + exchange.cancelled = True + exchange.cancel_event.set() + exchange._queue.push(_BodyItem(cancel=True, cancel_reason=params.cancel_reason)) + return + if params.data: + exchange._queue.push( + _BodyItem(chunk=_decode_chunk_data(params.data, bool(params.binary))) + ) + if params.end: + exchange._queue.push(_BodyItem(end=True)) + + async def _run(self, exchange: _CopilotRequestExchange) -> None: + try: + await self._handler._dispatch(exchange) + if not exchange.finished: + await _finalize( + exchange, + 502, + "Copilot request handler returned without finalising the response.", + ) + except Exception as exc: + if exchange.cancelled or exchange.cancel_event.is_set(): + await _finalize(exchange, 499, "Request cancelled by runtime", "cancelled") + return + await _finalize(exchange, 502, str(exc)) + finally: + self._pending.pop(exchange.request_id, None) + + def _get_or_create(self, request_id: str) -> _CopilotRequestExchange: + # The runtime dispatches httpRequestStart and httpRequestChunk frames + # independently. get-or-create keeps the adapter correct regardless of + # arrival order: a body chunk (including the terminal end frame) that + # races ahead of its start frame is buffered into the same exchange + # rather than dropped, which would otherwise hang the body drain. + exchange = self._pending.get(request_id) + if exchange is None: + exchange = _CopilotRequestExchange(request_id, self._get_server_rpc) + self._pending[request_id] = exchange + return exchange + + async def http_request_start( + self, params: LlmInferenceHTTPRequestStartRequest + ) -> LlmInferenceHTTPRequestStartResult: + # Adopt any exchange a racing chunk already created — with its buffered + # body — rather than dropping those frames. + exchange = self._get_or_create(params.request_id) + exchange.set_context(params) + exchange.task = asyncio.create_task(self._run(exchange)) + return LlmInferenceHTTPRequestStartResult() + + async def http_request_chunk( + self, params: LlmInferenceHTTPRequestChunkRequest + ) -> LlmInferenceHTTPRequestChunkResult: + # May arrive before the matching start frame; get-or-create so the body + # is buffered, never lost. + exchange = self._get_or_create(params.request_id) + self._route_chunk(exchange, params) + return LlmInferenceHTTPRequestChunkResult() + + +async def _finalize( + exchange: _CopilotRequestExchange, + status: int, + message: str, + code: str | None = None, +) -> None: + if exchange.finished: + return + try: + if not exchange.started: + await exchange.start_response(status) + await exchange.error_response(message, code) + except Exception: + # Best-effort — the connection may already be dead. + pass + + +# --------------------------------------------------------------------------- +# WebSocket response bridge +# --------------------------------------------------------------------------- + + +class _CopilotWebSocketResponseBridge: + """Serialises WebSocket response writes into the exchange. + + The 101 upgrade head is emitted eagerly via :meth:`start` (the runtime + gates the WS connect on it); subsequent writes and the terminal frame are + serialised via a lock so the head always precedes them. The lazy-start + path in :meth:`write` acts as a no-op backstop when ``start`` is called + first (the normal case). + """ + + def __init__(self, exchange: _CopilotRequestExchange) -> None: + self._exchange = exchange + self._started = False + self._completed = False + self._lock = asyncio.Lock() + + async def start(self) -> None: + """Emit the 101 upgrade acknowledgement now.""" + async with self._lock: + if self._started: + return + self._started = True + await self._exchange.start_response(101, headers={}) + + async def write(self, data: str | bytes) -> None: + async with self._lock: + if not self._started: + # Lazy-start backstop: emits the 101 head if a subclass calls + # write before start(). In normal usage start() is called + # eagerly in _handle_web_socket so this branch is never taken. + self._started = True + await self._exchange.start_response(101, headers={}) + if not self._completed: + await self._exchange.write_response(data) + + async def end(self) -> None: + async with self._lock: + if self._completed: + return + self._completed = True + await self._exchange.end_response() + + async def error(self, message: str, code: str | None = None) -> None: + async with self._lock: + if self._completed: + return + self._completed = True + await self._exchange.error_response(message, code) + + +# --------------------------------------------------------------------------- +# HTTP helpers +# --------------------------------------------------------------------------- + + +async def _run_cancellable(coro: Any, cancel_event: asyncio.Event) -> None: + """Run ``coro`` but abort it (and raise) when ``cancel_event`` fires.""" + task = asyncio.ensure_future(coro) + waiter = asyncio.ensure_future(cancel_event.wait()) + try: + done, _ = await asyncio.wait({task, waiter}, return_when=asyncio.FIRST_COMPLETED) + if task in done: + exc = task.exception() + if exc is not None: + raise exc + return + # Cancellation fired first. + task.cancel() + try: + await task + except (asyncio.CancelledError, Exception): + # The awaited task was cancelled; its unwind exception is expected + # and irrelevant — we raise the cancellation result below. + pass + raise RuntimeError("Request cancelled by runtime") + finally: + if not waiter.done(): + waiter.cancel() + + +async def _build_httpx_request(exchange: _CopilotRequestExchange) -> httpx.Request: + import httpx + + header_pairs = [ + (name, value) + for name, values in exchange.headers.items() + if name.lower() not in _FORBIDDEN_REQUEST_HEADERS + for value in (values or []) + ] + method = exchange.method.upper() + has_body = method not in ("GET", "HEAD") + body = await _drain_async(exchange.request_body) + content = body if (has_body and body) else None + return httpx.Request(method, exchange.url, headers=header_pairs, content=content) + + +async def _drain_async(stream: AsyncIterator[bytes]) -> bytes: + parts: list[bytes] = [] + async for chunk in stream: + if chunk: + parts.append(chunk) + return b"".join(parts) + + +async def _stream_response_to_exchange( + response: httpx.Response, exchange: _CopilotRequestExchange +) -> None: + await exchange.start_response( + response.status_code, + status_text=response.reason_phrase or None, + headers=_headers_to_multi_map(response.headers), + ) + if response.is_stream_consumed: + # An in-memory response (built with ``content=``) has already buffered its + # body, so its raw stream cannot be iterated; forward the buffered bytes. + body = response.content + if body: + await exchange.write_response(body) + else: + async for chunk in response.aiter_raw(): + if chunk: + await exchange.write_response(chunk) + await exchange.end_response() + + +def _headers_to_multi_map(headers: Any) -> LlmInferenceHeaders: + out: dict[str, list[str]] = {} + for name, value in headers.multi_items(): + out.setdefault(name, []).append(value) + return out + + +def _decode_chunk_data(data: str, binary: bool) -> bytes: + if binary: + return base64.b64decode(data) + return data.encode("utf-8") + + +def _decode_frame(chunk: bytes) -> str: + return chunk.decode("utf-8", errors="replace") diff --git a/python/copilot/generated/__init__.py b/python/copilot/generated/__init__.py index e69de29bb..30ad0cf92 100644 --- a/python/copilot/generated/__init__.py +++ b/python/copilot/generated/__init__.py @@ -0,0 +1,6 @@ +"""Internal: code-generated protocol types for the Copilot SDK. + +This package is not part of the public API. Import from `copilot` (session-event +types) or `copilot.rpc` (JSON-RPC request/response types) instead. Symbols +in this package may change or be removed at any time without notice. +""" diff --git a/python/copilot/generated/rpc.py b/python/copilot/generated/rpc.py index 694a6a267..103149088 100644 --- a/python/copilot/generated/rpc.py +++ b/python/copilot/generated/rpc.py @@ -6,7 +6,7 @@ from typing import ClassVar, TYPE_CHECKING -from .session_events import AbortReason, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval +from .session_events import AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, Verbosity if TYPE_CHECKING: from .._jsonrpc import JsonRpcClient @@ -48,10 +48,6 @@ def from_bool(x: Any) -> bool: assert isinstance(x, bool) return x -def from_int(x: Any) -> int: - assert isinstance(x, int) and not isinstance(x, bool) - return x - def from_float(x: Any) -> float: assert isinstance(x, (float, int)) and not isinstance(x, bool) return float(x) @@ -72,6 +68,10 @@ def to_enum(c: type[EnumT], x: Any) -> EnumT: assert isinstance(x, c) return x.value +def from_int(x: Any) -> int: + assert isinstance(x, int) and not isinstance(x, bool) + return x + def from_datetime(x: Any) -> datetime: return dateutil.parser.parse(x) @@ -120,6 +120,204 @@ def to_dict(self) -> dict: result["error"] = from_union([from_str, from_none], self.error) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CopilotUserResponseEndpoints: + """Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.""" + + api: str | None = None + exp: str | None = None + origin_tracker: str | None = None + proxy: str | None = None + telemetry: str | None = None + + @staticmethod + def from_dict(obj: Any) -> 'CopilotUserResponseEndpoints': + assert isinstance(obj, dict) + api = from_union([from_str, from_none], obj.get("api")) + exp = from_union([from_str, from_none], obj.get("exp")) + origin_tracker = from_union([from_str, from_none], obj.get("origin-tracker")) + proxy = from_union([from_str, from_none], obj.get("proxy")) + telemetry = from_union([from_str, from_none], obj.get("telemetry")) + return CopilotUserResponseEndpoints(api, exp, origin_tracker, proxy, telemetry) + + def to_dict(self) -> dict: + result: dict = {} + if self.api is not None: + result["api"] = from_union([from_str, from_none], self.api) + if self.exp is not None: + result["exp"] = from_union([from_str, from_none], self.exp) + if self.origin_tracker is not None: + result["origin-tracker"] = from_union([from_str, from_none], self.origin_tracker) + if self.proxy is not None: + result["proxy"] = from_union([from_str, from_none], self.proxy) + if self.telemetry is not None: + result["telemetry"] = from_union([from_str, from_none], self.telemetry) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CopilotUserResponseQuotaSnapshots: + """Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, + overage, remaining quota, reset, and billing fields. + + Completions quota snapshot from the raw Copilot user-response passthrough, with + entitlement, overage, remaining quota, reset, and billing fields. + + Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with + entitlement, overage, remaining quota, reset, and billing fields. + """ + entitlement: float | None = None + """Number of requests/units included in the entitlement for this period; `-1` denotes an + unlimited entitlement. + """ + has_quota: bool | None = None + """Whether the user currently has quota available; when `false` and not unlimited, further + requests are blocked until the quota resets. + """ + overage_count: float | None = None + """Count of additional pay-per-request usage consumed this period beyond the entitlement.""" + + overage_permitted: bool | None = None + """Whether usage may continue at pay-per-request rates once the entitlement is exhausted.""" + + percent_remaining: float | None = None + """Percentage of the entitlement remaining at the snapshot timestamp.""" + + quota_id: str | None = None + """Identifier of the quota bucket this snapshot describes.""" + + quota_remaining: float | None = None + """Amount of quota remaining at the snapshot timestamp.""" + + quota_reset_at: float | None = None + """Unix epoch time, in seconds, when this quota next resets.""" + + remaining: float | None = None + """Remaining entitlement/quota amount at the snapshot timestamp.""" + + timestamp_utc: str | None = None + """UTC timestamp when this snapshot was captured.""" + + token_based_billing: bool | None = None + """Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + premium-request count. + """ + unlimited: bool | None = None + """Whether the entitlement for this category is unlimited.""" + + @staticmethod + def from_dict(obj: Any) -> 'CopilotUserResponseQuotaSnapshots': + assert isinstance(obj, dict) + entitlement = from_union([from_float, from_none], obj.get("entitlement")) + has_quota = from_union([from_bool, from_none], obj.get("has_quota")) + overage_count = from_union([from_float, from_none], obj.get("overage_count")) + overage_permitted = from_union([from_bool, from_none], obj.get("overage_permitted")) + percent_remaining = from_union([from_float, from_none], obj.get("percent_remaining")) + quota_id = from_union([from_str, from_none], obj.get("quota_id")) + quota_remaining = from_union([from_float, from_none], obj.get("quota_remaining")) + quota_reset_at = from_union([from_float, from_none], obj.get("quota_reset_at")) + remaining = from_union([from_float, from_none], obj.get("remaining")) + timestamp_utc = from_union([from_str, from_none], obj.get("timestamp_utc")) + token_based_billing = from_union([from_bool, from_none], obj.get("token_based_billing")) + unlimited = from_union([from_bool, from_none], obj.get("unlimited")) + return CopilotUserResponseQuotaSnapshots(entitlement, has_quota, overage_count, overage_permitted, percent_remaining, quota_id, quota_remaining, quota_reset_at, remaining, timestamp_utc, token_based_billing, unlimited) + + def to_dict(self) -> dict: + result: dict = {} + if self.entitlement is not None: + result["entitlement"] = from_union([to_float, from_none], self.entitlement) + if self.has_quota is not None: + result["has_quota"] = from_union([from_bool, from_none], self.has_quota) + if self.overage_count is not None: + result["overage_count"] = from_union([to_float, from_none], self.overage_count) + if self.overage_permitted is not None: + result["overage_permitted"] = from_union([from_bool, from_none], self.overage_permitted) + if self.percent_remaining is not None: + result["percent_remaining"] = from_union([to_float, from_none], self.percent_remaining) + if self.quota_id is not None: + result["quota_id"] = from_union([from_str, from_none], self.quota_id) + if self.quota_remaining is not None: + result["quota_remaining"] = from_union([to_float, from_none], self.quota_remaining) + if self.quota_reset_at is not None: + result["quota_reset_at"] = from_union([to_float, from_none], self.quota_reset_at) + if self.remaining is not None: + result["remaining"] = from_union([to_float, from_none], self.remaining) + if self.timestamp_utc is not None: + result["timestamp_utc"] = from_union([from_str, from_none], self.timestamp_utc) + if self.token_based_billing is not None: + result["token_based_billing"] = from_union([from_bool, from_none], self.token_based_billing) + if self.unlimited is not None: + result["unlimited"] = from_union([from_bool, from_none], self.unlimited) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class AuthInfoType(Enum): + """Authentication type""" + + API_KEY = "api-key" + COPILOT_API_TOKEN = "copilot-api-token" + ENV = "env" + GH_CLI = "gh-cli" + HMAC = "hmac" + TOKEN = "token" + USER = "user" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountAllUsers: + """Authenticated account entry returned by `account.getAllUsers`, with auth info and an + optional associated token. + + List of all authenticated users + """ + auth_info: AuthInfo + """Authentication information for this user""" + + token: str | None = None + """Associated token, if available""" + + @staticmethod + def from_dict(obj: Any) -> 'AccountAllUsers': + assert isinstance(obj, dict) + auth_info = _load_AuthInfo(obj.get("authInfo")) + token = from_union([from_str, from_none], obj.get("token")) + return AccountAllUsers(auth_info, token) + + def to_dict(self) -> dict: + result: dict = {} + result["authInfo"] = (self.auth_info).to_dict() + if self.token is not None: + result["token"] = from_union([from_str, from_none], self.token) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountGetCurrentAuthResult: + """Current authentication state""" + + auth_errors: list[str] | None = None + """Authentication errors from the last auth attempt, if any""" + + auth_info: AuthInfo | None = None + """Current authentication information, if authenticated""" + + @staticmethod + def from_dict(obj: Any) -> 'AccountGetCurrentAuthResult': + assert isinstance(obj, dict) + auth_errors = from_union([lambda x: from_list(from_str, x), from_none], obj.get("authErrors")) + auth_info = from_union([_load_AuthInfo, from_none], obj.get("authInfo")) + return AccountGetCurrentAuthResult(auth_errors, auth_info) + + def to_dict(self) -> dict: + result: dict = {} + if self.auth_errors is not None: + result["authErrors"] = from_union([lambda x: from_list(from_str, x), from_none], self.auth_errors) + if self.auth_info is not None: + result["authInfo"] = from_union([lambda x: (x).to_dict(), from_none], self.auth_info) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass class AccountGetQuotaRequest: git_hub_token: str | None = None @@ -139,10 +337,12 @@ def to_dict(self) -> dict: result["gitHubToken"] = from_union([from_str, from_none], self.git_hub_token) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass class AccountQuotaSnapshot: - """Schema for the `AccountQuotaSnapshot` type.""" - + """Quota usage snapshot for a Copilot quota type, including entitlement, used requests, + overage, reset date, and remaining percentage. + """ entitlement_requests: int """Number of requests included in the entitlement, or -1 for unlimited entitlements""" @@ -193,6 +393,113 @@ def to_dict(self) -> dict: result["resetDate"] = from_union([from_str, from_none], self.reset_date) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountLoginRequest: + """Credentials to store after successful authentication""" + + host: str + """GitHub host URL""" + + login: str + """User login/username""" + + token: str + """GitHub authentication token""" + + @staticmethod + def from_dict(obj: Any) -> 'AccountLoginRequest': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + login = from_str(obj.get("login")) + token = from_str(obj.get("token")) + return AccountLoginRequest(host, login, token) + + def to_dict(self) -> dict: + result: dict = {} + result["host"] = from_str(self.host) + result["login"] = from_str(self.login) + result["token"] = from_str(self.token) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountLoginResult: + """Result of a successful login; throws on failure""" + + stored_in_vault: bool + """Whether the credential was persisted to a secure store (system keychain, or the config + file when plaintext storage is enabled). False when no secure store was available and the + token was not saved, so the consumer can decide how to proceed. + """ + + @staticmethod + def from_dict(obj: Any) -> 'AccountLoginResult': + assert isinstance(obj, dict) + stored_in_vault = from_bool(obj.get("storedInVault")) + return AccountLoginResult(stored_in_vault) + + def to_dict(self) -> dict: + result: dict = {} + result["storedInVault"] = from_bool(self.stored_in_vault) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountLogoutRequest: + """User to log out""" + + auth_info: AuthInfo + """Authentication information for the user to log out""" + + @staticmethod + def from_dict(obj: Any) -> 'AccountLogoutRequest': + assert isinstance(obj, dict) + auth_info = _load_AuthInfo(obj.get("authInfo")) + return AccountLogoutRequest(auth_info) + + def to_dict(self) -> dict: + result: dict = {} + result["authInfo"] = (self.auth_info).to_dict() + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AccountLogoutResult: + """Logout result indicating if more users remain""" + + has_more_users: bool + """Whether other authenticated users remain after logout""" + + @staticmethod + def from_dict(obj: Any) -> 'AccountLogoutResult': + assert isinstance(obj, dict) + has_more_users = from_bool(obj.get("hasMoreUsers")) + return AccountLogoutResult(has_more_users) + + def to_dict(self) -> dict: + result: dict = {} + result["hasMoreUsers"] = from_bool(self.has_more_users) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class AdaptiveThinkingSupport(Enum): + """Resolved Anthropic adaptive-thinking capability for a model. + + Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. + 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + """ + OPTIONAL = "optional" + REQUIRED = "required" + UNSUPPORTED = "unsupported" + +# Experimental: this type is part of an experimental API and may change or be removed. +class AgentDiscoveryPathScope(Enum): + """Which tier this directory belongs to""" + + PROJECT = "project" + USER = "user" + # Experimental: this type is part of an experimental API and may change or be removed. class AgentInfoSource(Enum): """Where the agent definition was loaded from""" @@ -316,92 +623,98 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AllowAllPermissionSetResult: - """Indicates whether the operation succeeded and reports the post-mutation state.""" - - enabled: bool - """Authoritative allow-all state after the mutation""" +class AgentsDiscoverRequest: + """Optional project paths to include in agent discovery.""" - success: bool - """Whether the operation succeeded""" + exclude_host_agents: bool | None = None + """When true, omit the host's agents (the user-level agent directory and all plugin agents), + leaving only project and remote agents. For multitenant deployments. + """ + project_paths: list[str] | None = None + """Optional list of project directory paths to scan for project-scoped agents. When omitted + or empty, only user/plugin/remote-independent agents are returned (no project scan). + """ @staticmethod - def from_dict(obj: Any) -> 'AllowAllPermissionSetResult': + def from_dict(obj: Any) -> 'AgentsDiscoverRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - success = from_bool(obj.get("success")) - return AllowAllPermissionSetResult(enabled, success) + exclude_host_agents = from_union([from_bool, from_none], obj.get("excludeHostAgents")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + return AgentsDiscoverRequest(exclude_host_agents, project_paths) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - result["success"] = from_bool(self.success) + if self.exclude_host_agents is not None: + result["excludeHostAgents"] = from_union([from_bool, from_none], self.exclude_host_agents) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AllowAllPermissionState: - """Current full allow-all permission state.""" +class AgentsGetDiscoveryPathsRequest: + """Optional project paths to include when enumerating agent discovery directories.""" - enabled: bool - """Whether full allow-all permissions are currently active""" + exclude_host_agents: bool | None = None + """When true, omit the host's user-level agent directory, leaving only project directories. + For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + """ + project_paths: list[str] | None = None + """Optional list of project directory paths. When omitted or empty, only the user-level + directory is returned. + """ @staticmethod - def from_dict(obj: Any) -> 'AllowAllPermissionState': + def from_dict(obj: Any) -> 'AgentsGetDiscoveryPathsRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - return AllowAllPermissionState(enabled) + exclude_host_agents = from_union([from_bool, from_none], obj.get("excludeHostAgents")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + return AgentsGetDiscoveryPathsRequest(exclude_host_agents, project_paths) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) + if self.exclude_host_agents is not None: + result["excludeHostAgents"] = from_union([from_bool, from_none], self.exclude_host_agents) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class CopilotUserResponseEndpoints: - """Schema for the `CopilotUserResponseEndpoints` type.""" +class PermissionsAllowAllMode(Enum): + """Authoritative allow-all mode after the mutation - api: str | None = None - origin_tracker: str | None = None - proxy: str | None = None - telemetry: str | None = None + Current or requested allow-all mode. - @staticmethod - def from_dict(obj: Any) -> 'CopilotUserResponseEndpoints': - assert isinstance(obj, dict) - api = from_union([from_str, from_none], obj.get("api")) - origin_tracker = from_union([from_str, from_none], obj.get("origin-tracker")) - proxy = from_union([from_str, from_none], obj.get("proxy")) - telemetry = from_union([from_str, from_none], obj.get("telemetry")) - return CopilotUserResponseEndpoints(api, origin_tracker, proxy, telemetry) + Current allow-all mode - def to_dict(self) -> dict: - result: dict = {} - if self.api is not None: - result["api"] = from_union([from_str, from_none], self.api) - if self.origin_tracker is not None: - result["origin-tracker"] = from_union([from_str, from_none], self.origin_tracker) - if self.proxy is not None: - result["proxy"] = from_union([from_str, from_none], self.proxy) - if self.telemetry is not None: - result["telemetry"] = from_union([from_str, from_none], self.telemetry) - return result + Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM + auto-approval; `off` disables both. + """ + AUTO = "auto" + OFF = "off" + ON = "on" class APIKeyAuthInfoType(Enum): API_KEY = "api-key" # Experimental: this type is part of an experimental API and may change or be removed. -class AuthInfoType(Enum): - """Authentication type""" +@dataclass +class CancelUserRequestedShellCommandResult: + """Cancellation result for a user-requested shell command.""" - API_KEY = "api-key" - COPILOT_API_TOKEN = "copilot-api-token" - ENV = "env" - GH_CLI = "gh-cli" - HMAC = "hmac" - TOKEN = "token" - USER = "user" + cancelled: bool + """Whether an in-flight execution was found and signalled to cancel""" + + @staticmethod + def from_dict(obj: Any) -> 'CancelUserRequestedShellCommandResult': + assert isinstance(obj, dict) + cancelled = from_bool(obj.get("cancelled")) + return CancelUserRequestedShellCommandResult(cancelled) + + def to_dict(self) -> dict: + result: dict = {} + result["cancelled"] = from_bool(self.cancelled) + return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass @@ -484,13 +797,6 @@ def to_dict(self) -> dict: result["instanceId"] = from_str(self.instance_id) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class CanvasInstanceAvailability(Enum): - """Runtime-controlled routing state for an open canvas instance.""" - - READY = "ready" - STALE = "stale" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CanvasOpenRequest: @@ -580,6 +886,55 @@ def to_dict(self) -> dict: result["url"] = from_union([from_str, from_none], self.url) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CapiSessionOptions: + """Options scoped to the built-in CAPI (Copilot API) provider.""" + + enable_web_socket_responses: bool | None = None + """Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when + the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses + transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting + this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` + environment variable. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CapiSessionOptions': + assert isinstance(obj, dict) + enable_web_socket_responses = from_union([from_bool, from_none], obj.get("enableWebSocketResponses")) + return CapiSessionOptions(enable_web_socket_responses) + + def to_dict(self) -> dict: + result: dict = {} + if self.enable_web_socket_responses is not None: + result["enableWebSocketResponses"] = from_union([from_bool, from_none], self.enable_web_socket_responses) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandInputChoice: + """A literal choice the command input accepts, with a human-facing description""" + + description: str + """Human-readable description shown alongside the choice""" + + name: str + """The literal choice value (e.g. 'on', 'off', 'show')""" + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandInputChoice': + assert isinstance(obj, dict) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + return SlashCommandInputChoice(description, name) + + def to_dict(self) -> dict: + result: dict = {} + result["description"] = from_str(self.description) + result["name"] = from_str(self.name) + return result + # Experimental: this type is part of an experimental API and may change or be removed. class SlashCommandInputCompletion(Enum): """Optional completion hint for the input (e.g. 'directory' for filesystem path completion)""" @@ -664,38 +1019,6 @@ def to_dict(self) -> dict: result["input"] = from_union([from_str, from_none], self.input) return result -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class CommandsListRequest: - """Optional filters controlling which command sources to include in the listing.""" - - include_builtins: bool | None = None - """Include runtime built-in commands""" - - include_client_commands: bool | None = None - """Include commands registered by protocol clients, including SDK clients and extensions""" - - include_skills: bool | None = None - """Include enabled user-invocable skills and commands""" - - @staticmethod - def from_dict(obj: Any) -> 'CommandsListRequest': - assert isinstance(obj, dict) - include_builtins = from_union([from_bool, from_none], obj.get("includeBuiltins")) - include_client_commands = from_union([from_bool, from_none], obj.get("includeClientCommands")) - include_skills = from_union([from_bool, from_none], obj.get("includeSkills")) - return CommandsListRequest(include_builtins, include_client_commands, include_skills) - - def to_dict(self) -> dict: - result: dict = {} - if self.include_builtins is not None: - result["includeBuiltins"] = from_union([from_bool, from_none], self.include_builtins) - if self.include_client_commands is not None: - result["includeClientCommands"] = from_union([from_bool, from_none], self.include_client_commands) - if self.include_skills is not None: - result["includeSkills"] = from_union([from_bool, from_none], self.include_skills) - return result - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CommandsRespondToQueuedCommandRequest: @@ -742,6 +1065,105 @@ def to_dict(self) -> dict: result["success"] = from_bool(self.success) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CompletionsRequestRequest: + """Request host-driven completions for the current composer input.""" + + offset: int + """Cursor offset within `text`, in UTF-16 code units.""" + + text: str + """The full composed composer input.""" + + @staticmethod + def from_dict(obj: Any) -> 'CompletionsRequestRequest': + assert isinstance(obj, dict) + offset = from_int(obj.get("offset")) + text = from_str(obj.get("text")) + return CompletionsRequestRequest(offset, text) + + def to_dict(self) -> dict: + result: dict = {} + result["offset"] = from_int(self.offset) + result["text"] = from_str(self.text) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCompletionItem: + """A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` + (UTF-16 code units) in the composer with `insertText`; when the range is absent, the + active token around the cursor is replaced. + """ + insert_text: str + """Text spliced into the composer when the item is accepted.""" + + kind: str | None = None + """Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the + host's display kind. + """ + label: str | None = None + """Primary display label for the picker row. Falls back to `insertText` when absent.""" + + range_end: int | None = None + """End (exclusive) of the replacement range in `text`, in UTF-16 code units.""" + + range_start: int | None = None + """Start of the replacement range in `text`, in UTF-16 code units.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionCompletionItem': + assert isinstance(obj, dict) + insert_text = from_str(obj.get("insertText")) + kind = from_union([from_str, from_none], obj.get("kind")) + label = from_union([from_str, from_none], obj.get("label")) + range_end = from_union([from_int, from_none], obj.get("rangeEnd")) + range_start = from_union([from_int, from_none], obj.get("rangeStart")) + return SessionCompletionItem(insert_text, kind, label, range_end, range_start) + + def to_dict(self) -> dict: + result: dict = {} + result["insertText"] = from_str(self.insert_text) + if self.kind is not None: + result["kind"] = from_union([from_str, from_none], self.kind) + if self.label is not None: + result["label"] = from_union([from_str, from_none], self.label) + if self.range_end is not None: + result["rangeEnd"] = from_union([from_int, from_none], self.range_end) + if self.range_start is not None: + result["rangeStart"] = from_union([from_int, from_none], self.range_start) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _ConfigureSessionExtensionsParams: + """Params to attach or detach an in-process ExtensionController delegate.""" + + session_id: str + """Session to attach the extension controller delegate to.""" + + controller: Any = None + """In-process ExtensionController delegate (CLI-only optimization). Marked internal: this + field is excluded from the public SDK surface. The post-SDK extension surface exposes + list/enable/disable/reload via dedicated RPCs served by the runtime. + """ + + @staticmethod + def from_dict(obj: Any) -> '_ConfigureSessionExtensionsParams': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + controller = obj.get("controller") + return _ConfigureSessionExtensionsParams(session_id, controller) + + def to_dict(self) -> dict: + result: dict = {} + result["sessionId"] = from_str(self.session_id) + if self.controller is not None: + result["controller"] = self.controller + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ConnectRemoteSessionParams: @@ -761,26 +1183,44 @@ def to_dict(self) -> dict: result["sessionId"] = from_str(self.session_id) return result +# Experimental: this type is part of an experimental API and may change or be removed. # Internal: this type is an internal SDK API and is not part of the public surface. @dataclass class _ConnectRequest: - """Optional connection token presented by the SDK client during the handshake.""" - + """Parameters for the `server.connect` handshake: an optional connection token and optional + connection-level opt-ins (e.g. GitHub telemetry forwarding). + """ + enable_git_hub_telemetry_forwarding: bool | None = None + """Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the + runtime forwards every internal telemetry event it emits — across all sessions, plus + sessionless events — to this connection over the `gitHubTelemetry.event` notification. + Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); + host-only compatibility events are forward-only and intentionally skip that path. + Intended for first-party hosts that re-emit the events into their own telemetry stores. + Both unrestricted and restricted events are forwarded, each tagged with a `restricted` + discriminator; a backstop drops restricted events when restricted telemetry is disabled — + using the process-global gate for ordinary events and an explicit session-scoped decision + for host-only events. + """ token: str | None = None """Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN""" @staticmethod def from_dict(obj: Any) -> '_ConnectRequest': assert isinstance(obj, dict) + enable_git_hub_telemetry_forwarding = from_union([from_bool, from_none], obj.get("enableGitHubTelemetryForwarding")) token = from_union([from_str, from_none], obj.get("token")) - return _ConnectRequest(token) + return _ConnectRequest(enable_git_hub_telemetry_forwarding, token) def to_dict(self) -> dict: result: dict = {} + if self.enable_git_hub_telemetry_forwarding is not None: + result["enableGitHubTelemetryForwarding"] = from_union([from_bool, from_none], self.enable_git_hub_telemetry_forwarding) if self.token is not None: result["token"] = from_union([from_str, from_none], self.token) return result +# Experimental: this type is part of an experimental API and may change or be removed. # Internal: this type is an internal SDK API and is not part of the public surface. @dataclass class _ConnectResult: @@ -846,6 +1286,53 @@ def to_dict(self) -> dict: result["owner"] = from_str(self.owner) return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ContentExclusionCheckPathsRequest: + """Local file system absolute paths within the session working directory to check against + its content-exclusion policy. + """ + paths: list[str] + """Local file system absolute paths within the session working directory to check. Results + are returned in the same order, including duplicates. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ContentExclusionCheckPathsRequest': + assert isinstance(obj, dict) + paths = from_list(from_str, obj.get("paths")) + return ContentExclusionCheckPathsRequest(paths) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(from_str, self.paths) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ContentExclusionPathCheck: + """Content-exclusion decision for one requested path.""" + + excluded: bool + """Whether the session's complete content-exclusion policy excludes the path.""" + + path: str + """The path supplied by the caller.""" + + @staticmethod + def from_dict(obj: Any) -> 'ContentExclusionPathCheck': + assert isinstance(obj, dict) + excluded = from_bool(obj.get("excluded")) + path = from_str(obj.get("path")) + return ContentExclusionPathCheck(excluded, path) + + def to_dict(self) -> dict: + result: dict = {} + result["excluded"] = from_bool(self.excluded) + result["path"] = from_str(self.path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. class ContentFilterMode(Enum): """Controls how MCP tool result content is filtered: none leaves content unchanged, markdown sanitizes HTML while preserving Markdown-friendly output, and hidden_characters removes @@ -855,6 +1342,40 @@ class ContentFilterMode(Enum): MARKDOWN = "markdown" NONE = "none" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ContextHeaviestMessage: + """A single large message currently in context.""" + + id: str + """Stable identifier for this message within the snapshot.""" + + label: str + """Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only.""" + + role: str + """Role of the chat message (`user`, `assistant`, or `tool`).""" + + tokens: int + """Token count currently in context for this individual message.""" + + @staticmethod + def from_dict(obj: Any) -> 'ContextHeaviestMessage': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + label = from_str(obj.get("label")) + role = from_str(obj.get("role")) + tokens = from_int(obj.get("tokens")) + return ContextHeaviestMessage(id, label, role, tokens) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + result["label"] = from_str(self.label) + result["role"] = from_str(self.role) + result["tokens"] = from_int(self.tokens) + return result + class Host(Enum): HTTPS_GITHUB_COM = "https://github.com" @@ -864,20 +1385,47 @@ class CopilotAPITokenAuthInfoType(Enum): # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CopilotUserResponseQuotaSnapshotsChat: - """Schema for the `CopilotUserResponseQuotaSnapshotsChat` type.""" - + """Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, + overage, remaining quota, reset, and billing fields. + """ entitlement: float | None = None + """Number of requests/units included in the entitlement for this period; `-1` denotes an + unlimited entitlement. + """ has_quota: bool | None = None + """Whether the user currently has quota available; when `false` and not unlimited, further + requests are blocked until the quota resets. + """ overage_count: float | None = None + """Count of additional pay-per-request usage consumed this period beyond the entitlement.""" + overage_permitted: bool | None = None + """Whether usage may continue at pay-per-request rates once the entitlement is exhausted.""" + percent_remaining: float | None = None + """Percentage of the entitlement remaining at the snapshot timestamp.""" + quota_id: str | None = None + """Identifier of the quota bucket this snapshot describes.""" + quota_remaining: float | None = None + """Amount of quota remaining at the snapshot timestamp.""" + quota_reset_at: float | None = None + """Unix epoch time, in seconds, when this quota next resets.""" + remaining: float | None = None + """Remaining entitlement/quota amount at the snapshot timestamp.""" + timestamp_utc: str | None = None + """UTC timestamp when this snapshot was captured.""" + token_based_billing: bool | None = None + """Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + premium-request count. + """ unlimited: bool | None = None + """Whether the entitlement for this category is unlimited.""" @staticmethod def from_dict(obj: Any) -> 'CopilotUserResponseQuotaSnapshotsChat': @@ -927,20 +1475,47 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CopilotUserResponseQuotaSnapshotsCompletions: - """Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type.""" - + """Completions quota snapshot from the raw Copilot user-response passthrough, with + entitlement, overage, remaining quota, reset, and billing fields. + """ entitlement: float | None = None + """Number of requests/units included in the entitlement for this period; `-1` denotes an + unlimited entitlement. + """ has_quota: bool | None = None + """Whether the user currently has quota available; when `false` and not unlimited, further + requests are blocked until the quota resets. + """ overage_count: float | None = None + """Count of additional pay-per-request usage consumed this period beyond the entitlement.""" + overage_permitted: bool | None = None + """Whether usage may continue at pay-per-request rates once the entitlement is exhausted.""" + percent_remaining: float | None = None + """Percentage of the entitlement remaining at the snapshot timestamp.""" + quota_id: str | None = None + """Identifier of the quota bucket this snapshot describes.""" + quota_remaining: float | None = None + """Amount of quota remaining at the snapshot timestamp.""" + quota_reset_at: float | None = None + """Unix epoch time, in seconds, when this quota next resets.""" + remaining: float | None = None + """Remaining entitlement/quota amount at the snapshot timestamp.""" + timestamp_utc: str | None = None + """UTC timestamp when this snapshot was captured.""" + token_based_billing: bool | None = None + """Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + premium-request count. + """ unlimited: bool | None = None + """Whether the entitlement for this category is unlimited.""" @staticmethod def from_dict(obj: Any) -> 'CopilotUserResponseQuotaSnapshotsCompletions': @@ -990,20 +1565,47 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class CopilotUserResponseQuotaSnapshotsPremiumInteractions: - """Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type.""" - + """Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with + entitlement, overage, remaining quota, reset, and billing fields. + """ entitlement: float | None = None + """Number of requests/units included in the entitlement for this period; `-1` denotes an + unlimited entitlement. + """ has_quota: bool | None = None + """Whether the user currently has quota available; when `false` and not unlimited, further + requests are blocked until the quota resets. + """ overage_count: float | None = None + """Count of additional pay-per-request usage consumed this period beyond the entitlement.""" + overage_permitted: bool | None = None + """Whether usage may continue at pay-per-request rates once the entitlement is exhausted.""" + percent_remaining: float | None = None + """Percentage of the entitlement remaining at the snapshot timestamp.""" + quota_id: str | None = None + """Identifier of the quota bucket this snapshot describes.""" + quota_remaining: float | None = None + """Amount of quota remaining at the snapshot timestamp.""" + quota_reset_at: float | None = None + """Unix epoch time, in seconds, when this quota next resets.""" + remaining: float | None = None + """Remaining entitlement/quota amount at the snapshot timestamp.""" + timestamp_utc: str | None = None + """UTC timestamp when this snapshot was captured.""" + token_based_billing: bool | None = None + """Whether this category uses usage-based (token/AI-credit) billing rather than a fixed + premium-request count. + """ unlimited: bool | None = None + """Whether the entitlement for this category is unlimited.""" @staticmethod def from_dict(obj: Any) -> 'CopilotUserResponseQuotaSnapshotsPremiumInteractions': @@ -1051,17 +1653,251 @@ def to_dict(self) -> dict: return result # Experimental: this type is part of an experimental API and may change or be removed. -class ModelCurrentContextTier(Enum): - """Context tier currently pinned for the session, when one is set. Reflects - `Session.getContextTier()`, restored from the session journal on resume. +@dataclass +class CurrentModel: + """The currently selected model, reasoning effort, and context tier for the session. The + context tier reflects `Session.getContextTier()`, restored from the session journal on + resume. """ - DEFAULT = "default" - LONG_CONTEXT = "long_context" + context_tier: ContextTier | None = None + """Context tier for models that support multiple context-window sizes.""" -class DiscoveredMCPServerType(Enum): - """Server transport type: stdio, http, sse (deprecated), or memory""" + model_id: str | None = None + """Currently active model identifier""" - HTTP = "http" + reasoning_effort: str | None = None + """Reasoning effort level currently applied to the active model, when one is set. Reads + `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the + two values are reported as a snapshot. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CurrentModel': + assert isinstance(obj, dict) + context_tier = from_union([ContextTier, from_none], obj.get("contextTier")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) + return CurrentModel(context_tier, model_id, reasoning_effort) + + def to_dict(self) -> dict: + result: dict = {} + if self.context_tier is not None: + result["contextTier"] = from_union([lambda x: to_enum(ContextTier, x), from_none], self.context_tier) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class DebugCollectLogsSource(Enum): + """Source category for this entry. + + Source category for a collected debug bundle entry. + """ + ADDITIONAL = "additional" + EVENTS = "events" + PROCESS_LOG = "process-log" + SHELL_LOG = "shell-log" + +# Experimental: this type is part of an experimental API and may change or be removed. +class DebugCollectLogsResultKind(Enum): + """Destination kind that was written.""" + + ARCHIVE = "archive" + DIRECTORY = "directory" + +# Experimental: this type is part of an experimental API and may change or be removed. +class DebugCollectLogsRedaction(Enum): + """How text content from this entry should be redacted. Defaults to plain-text. + + How a collected debug entry should be redacted before being staged. + """ + EVENTS_JSONL = "events-jsonl" + PLAIN_TEXT = "plain-text" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsInclude: + """Built-in session diagnostics to include in the bundle. Omitted fields default to true. + + Which built-in session diagnostics to include. Omitted fields default to true. + """ + current_process_log_path: str | None = None + """Server-local path to the current process log. When set, it is included as `process.log` + and its directory is searched for prior logs from the same session. + """ + events: bool | None = None + """Include the session event log (`events.jsonl`). Defaults to true.""" + + events_path: str | None = None + """Server-local path to the session's events.jsonl file. Internal callers normally omit this + and let the runtime derive it from the session. + """ + previous_process_log_limit: int | None = None + """Maximum number of previous process logs to include. Defaults to 5.""" + + process_log_directory: str | None = None + """Server-local process log directory to search when `currentProcessLogPath` is unavailable, + useful for collecting logs for inactive sessions. + """ + process_logs: bool | None = None + """Include process logs for the session. Defaults to true.""" + + shell_logs: bool | None = None + """Include interactive shell logs written under the session's `shell-logs` directory. + Defaults to true. + """ + + @staticmethod + def from_dict(obj: Any) -> 'DebugCollectLogsInclude': + assert isinstance(obj, dict) + current_process_log_path = from_union([from_str, from_none], obj.get("currentProcessLogPath")) + events = from_union([from_bool, from_none], obj.get("events")) + events_path = from_union([from_str, from_none], obj.get("eventsPath")) + previous_process_log_limit = from_union([from_int, from_none], obj.get("previousProcessLogLimit")) + process_log_directory = from_union([from_str, from_none], obj.get("processLogDirectory")) + process_logs = from_union([from_bool, from_none], obj.get("processLogs")) + shell_logs = from_union([from_bool, from_none], obj.get("shellLogs")) + return DebugCollectLogsInclude(current_process_log_path, events, events_path, previous_process_log_limit, process_log_directory, process_logs, shell_logs) + + def to_dict(self) -> dict: + result: dict = {} + if self.current_process_log_path is not None: + result["currentProcessLogPath"] = from_union([from_str, from_none], self.current_process_log_path) + if self.events is not None: + result["events"] = from_union([from_bool, from_none], self.events) + if self.events_path is not None: + result["eventsPath"] = from_union([from_str, from_none], self.events_path) + if self.previous_process_log_limit is not None: + result["previousProcessLogLimit"] = from_union([from_int, from_none], self.previous_process_log_limit) + if self.process_log_directory is not None: + result["processLogDirectory"] = from_union([from_str, from_none], self.process_log_directory) + if self.process_logs is not None: + result["processLogs"] = from_union([from_bool, from_none], self.process_logs) + if self.shell_logs is not None: + result["shellLogs"] = from_union([from_bool, from_none], self.shell_logs) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsSkippedEntry: + """An optional debug bundle entry that could not be included.""" + + bundle_path: str + """Relative path requested for this bundle entry.""" + + reason: str + """Reason the entry was skipped.""" + + path: str | None = None + """Server-local source path that could not be read.""" + + @staticmethod + def from_dict(obj: Any) -> 'DebugCollectLogsSkippedEntry': + assert isinstance(obj, dict) + bundle_path = from_str(obj.get("bundlePath")) + reason = from_str(obj.get("reason")) + path = from_union([from_str, from_none], obj.get("path")) + return DebugCollectLogsSkippedEntry(bundle_path, reason, path) + + def to_dict(self) -> dict: + result: dict = {} + result["bundlePath"] = from_str(self.bundle_path) + result["reason"] = from_str(self.reason) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class DisableBypassPermissionsMode(Enum): + """When set to `disable`, prevents bypass/allow-all permission modes.""" + + DISABLE = "disable" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DiscoveredExtensionPlugin: + """Containing plugin metadata for plugin-contributed extensions + + Installed plugin that contributes a discovered extension. + """ + name: str + """Installed plugin name""" + + @staticmethod + def from_dict(obj: Any) -> 'DiscoveredExtensionPlugin': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + return DiscoveredExtensionPlugin(name) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class DiscoveredExtensionSource(Enum): + """Discovery source + + Persisted extension discovery source + """ + PLUGIN = "plugin" + USER = "user" + +# Experimental: this type is part of an experimental API and may change or be removed. +class DiscoveredExtensionMode(Enum): + """Effective extension loading and agent-management mode + + Effective extension loading mode. Defaults to load_and_augment when unset. + """ + DISABLED = "disabled" + LOAD_AND_AUGMENT = "load_and_augment" + LOAD_ONLY = "load_only" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DiscoveredExtensionsDisableRequest: + """Source-qualified extension identifiers to persistently disable for future sessions.""" + + ids: list[str] + """Source-qualified user or plugin extension IDs to disable""" + + @staticmethod + def from_dict(obj: Any) -> 'DiscoveredExtensionsDisableRequest': + assert isinstance(obj, dict) + ids = from_list(from_str, obj.get("ids")) + return DiscoveredExtensionsDisableRequest(ids) + + def to_dict(self) -> dict: + result: dict = {} + result["ids"] = from_list(from_str, self.ids) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DiscoveredExtensionsEnableRequest: + """Source-qualified extension identifiers to persistently enable for future sessions.""" + + ids: list[str] + """Source-qualified user or plugin extension IDs to enable""" + + @staticmethod + def from_dict(obj: Any) -> 'DiscoveredExtensionsEnableRequest': + assert isinstance(obj, dict) + ids = from_list(from_str, obj.get("ids")) + return DiscoveredExtensionsEnableRequest(ids) + + def to_dict(self) -> dict: + result: dict = {} + result["ids"] = from_list(from_str, self.ids) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class DiscoveredMCPServerType(Enum): + """Server transport type: stdio, http, sse (deprecated), or memory""" + + HTTP = "http" MEMORY = "memory" SSE = "sse" STDIO = "stdio" @@ -1121,6 +1957,28 @@ class EventsAgentScope(Enum): ALL = "all" PRIMARY = "primary" +# Experimental: this type is part of an experimental API and may change or be removed. +class EventsReadDirection(Enum): + """Direction to page through the session's persisted event history. 'forward' (default) + pages from the cursor toward newer events (or from the start of history when no cursor is + given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` + events, and the returned cursor pages toward OLDER events on subsequent backward reads. + Events within a returned batch are always in chronological (oldest-to-newest) order, even + for a backward read. Backward reads cover PERSISTED history only; ephemeral events are + never returned by a backward read. `direction` selects the INITIAL read only: the + returned cursor is self-describing, so a continuation read pages in the cursor's own + direction regardless of the `direction` passed alongside it — a forward cursor always + pages forward and a backward cursor always pages backward. Pass the direction that + matches the cursor to avoid confusion. + + Direction to page through the session's persisted event history. 'forward' pages from the + cursor toward newer events; 'backward' returns the newest window first (tail-first) and + pages toward older events. Events within a returned batch are always chronological + (oldest-to-newest), even for a backward read. + """ + BACKWARD = "backward" + FORWARD = "forward" + # Experimental: this type is part of an experimental API and may change or be removed. class EventLogTypes(Enum): EMPTY = "*" @@ -1174,7 +2032,22 @@ def to_dict(self) -> dict: class EventsCursorStatus(Enum): """Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) - and the read started from the beginning of the remaining history. + and the read fell back to a boundary of the remaining history (the beginning for a + forward read, the tail for a backward read). The fallback page is a fresh boundary + snapshot, not a continuation of the requested cursor, so it may overlap already-rendered + events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate + by event id) before continuing from the returned cursor. + + Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor + referred to an event that no longer exists in history (e.g. truncated or compacted away) + and the read fell back to a boundary of the remaining history. For a forward read the + fallback starts from the beginning of the remaining history; for a backward read it falls + back to the tail (the newest window). Because the fallback page is a fresh boundary + snapshot rather than a continuation of the requested cursor, it may overlap events the + consumer has already rendered — a backward fallback to the tail in particular can repeat + the newest window. On 'expired', consumers should reset or rebase their local pagination + state (or deduplicate by event id) before continuing from the returned cursor rather than + blindly appending/prepending the fallback page. """ EXPIRED = "expired" OK = "ok" @@ -1227,9 +2100,14 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. class ExtensionSource(Enum): - """Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)""" + """Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin + (installed plugin), or session (session-state//extensions/) + Discovery source for the extension entrypoint. + """ + PLUGIN = "plugin" PROJECT = "project" + SESSION = "session" USER = "user" # Experimental: this type is part of an experimental API and may change or be removed. @@ -1241,6 +2119,42 @@ class ExtensionStatus(Enum): RUNNING = "running" STARTING = "starting" +class ExtensionContextPushInputType(Enum): + EXTENSION_CONTEXT = "extension_context" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ExtensionLaunchProfile: + """Opaque integrator-owned process launch profile for one extension entrypoint. + + Opaque launch profile, omitted when this provider does not support the entrypoint. + """ + args: list[str] + """Opaque integrator-defined arguments passed to the executable. The runtime does not append + the extension entrypoint. + """ + env: dict[str, str] + """Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, + SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. + """ + executable: str + """Executable used to launch the extension entrypoint.""" + + @staticmethod + def from_dict(obj: Any) -> 'ExtensionLaunchProfile': + assert isinstance(obj, dict) + args = from_list(from_str, obj.get("args")) + env = from_dict(from_str, obj.get("env")) + executable = from_str(obj.get("executable")) + return ExtensionLaunchProfile(args, env, executable) + + def to_dict(self) -> dict: + result: dict = {} + result["args"] = from_list(from_str, self.args) + result["env"] = from_dict(from_str, self.env) + result["executable"] = from_str(self.executable) + return result + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ExtensionsDisableRequest: @@ -1301,6 +2215,7 @@ class ExternalToolTextResultForLlmContentType(Enum): IMAGE = "image" RESOURCE = "resource" RESOURCE_LINK = "resource_link" + SHELL_EXIT = "shell_exit" TERMINAL = "terminal" TEXT = "text" @@ -1316,6 +2231,9 @@ class ExternalToolTextResultForLlmContentResourceType(Enum): class ExternalToolTextResultForLlmContentResourceLinkType(Enum): RESOURCE_LINK = "resource_link" +class ExternalToolTextResultForLlmContentShellExitType(Enum): + SHELL_EXIT = "shell_exit" + class ExternalToolTextResultForLlmContentTerminalType(Enum): TERMINAL = "terminal" @@ -1324,2063 +2242,2333 @@ class KindEnum(Enum): # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FleetStartRequest: - """Optional user prompt to combine with the fleet orchestration instructions.""" +class FactoryAbortRequest: + """Parameters for cooperatively aborting a factory body.""" - prompt: str | None = None - """Optional user prompt to combine with fleet instructions""" + run_id: str + """Factory run identifier.""" + + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'FleetStartRequest': + def from_dict(obj: Any) -> 'FactoryAbortRequest': assert isinstance(obj, dict) - prompt = from_union([from_str, from_none], obj.get("prompt")) - return FleetStartRequest(prompt) + run_id = from_str(obj.get("runId")) + session_id = from_str(obj.get("sessionId")) + return FactoryAbortRequest(run_id, session_id) def to_dict(self) -> dict: result: dict = {} - if self.prompt is not None: - result["prompt"] = from_union([from_str, from_none], self.prompt) + result["runId"] = from_str(self.run_id) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FleetStartResult: - """Indicates whether fleet mode was successfully activated.""" - - started: bool - """Whether fleet mode was successfully activated""" - +class FactoryACKResult: + """Acknowledgement that a factory request was accepted.""" @staticmethod - def from_dict(obj: Any) -> 'FleetStartResult': + def from_dict(obj: Any) -> 'FactoryACKResult': assert isinstance(obj, dict) - started = from_bool(obj.get("started")) - return FleetStartResult(started) + return FactoryACKResult() def to_dict(self) -> dict: result: dict = {} - result["started"] = from_bool(self.started) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FolderTrustAddParams: - """Folder path to add to trusted folders.""" +class FactoryAgentOptions: + """Options for one factory-scoped subagent call. - path: str - """Folder path to mark as trusted""" + Subagent execution options. + """ + agent: str | None = None + """Optional custom agent name for the subagent. This field is accepted but not yet honored.""" + + context_tier: ContextTier | None = None + """Optional context tier for the subagent. This field is accepted but not yet honored.""" + + label: str | None = None + """Optional label distinguishing otherwise identical memoized agent calls.""" + + model: str | None = None + """Optional model identifier for the subagent.""" + + reasoning_effort: str | None = None + """Optional reasoning effort for the subagent. This field is accepted but not yet honored.""" + + schema: Any = None + """Optional JSON Schema for structured agent output.""" @staticmethod - def from_dict(obj: Any) -> 'FolderTrustAddParams': + def from_dict(obj: Any) -> 'FactoryAgentOptions': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return FolderTrustAddParams(path) + agent = from_union([from_str, from_none], obj.get("agent")) + context_tier = from_union([ContextTier, from_none], obj.get("contextTier")) + label = from_union([from_str, from_none], obj.get("label")) + model = from_union([from_str, from_none], obj.get("model")) + reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) + schema = obj.get("schema") + return FactoryAgentOptions(agent, context_tier, label, model, reasoning_effort, schema) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + if self.agent is not None: + result["agent"] = from_union([from_str, from_none], self.agent) + if self.context_tier is not None: + result["contextTier"] = from_union([lambda x: to_enum(ContextTier, x), from_none], self.context_tier) + if self.label is not None: + result["label"] = from_union([from_str, from_none], self.label) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + if self.schema is not None: + result["schema"] = self.schema return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FolderTrustCheckParams: - """Folder path to check for trust.""" +class FactoryAgentResult: + """Result of one factory-scoped subagent call.""" - path: str - """Folder path to check""" + result: Any = None + """Agent result, omitted when the agent produced no result.""" @staticmethod - def from_dict(obj: Any) -> 'FolderTrustCheckParams': + def from_dict(obj: Any) -> 'FactoryAgentResult': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return FolderTrustCheckParams(path) + result = obj.get("result") + return FactoryAgentResult(result) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + if self.result is not None: + result["result"] = self.result return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class FolderTrustCheckResult: - """Folder trust check result.""" +class FactoryAgentSummary: + """Prompt-safe durable identity and live status for a direct factory agent.""" - trusted: bool - """Whether the folder is trusted""" + active_ms: int + agent_id: str + agent_type: str + label: str + run_id: str + status: str + tool_call_id: str + activity: str | None = None + completed_at: int | None = None + phase_id: str | None = None + requested_model: str | None = None + resolved_model: str | None = None + started_at: int | None = None @staticmethod - def from_dict(obj: Any) -> 'FolderTrustCheckResult': + def from_dict(obj: Any) -> 'FactoryAgentSummary': assert isinstance(obj, dict) - trusted = from_bool(obj.get("trusted")) - return FolderTrustCheckResult(trusted) + active_ms = from_int(obj.get("activeMs")) + agent_id = from_str(obj.get("agentId")) + agent_type = from_str(obj.get("agentType")) + label = from_str(obj.get("label")) + run_id = from_str(obj.get("runId")) + status = from_str(obj.get("status")) + tool_call_id = from_str(obj.get("toolCallId")) + activity = from_union([from_str, from_none], obj.get("activity")) + completed_at = from_union([from_int, from_none], obj.get("completedAt")) + phase_id = from_union([from_none, from_str], obj.get("phaseId")) + requested_model = from_union([from_str, from_none], obj.get("requestedModel")) + resolved_model = from_union([from_str, from_none], obj.get("resolvedModel")) + started_at = from_union([from_int, from_none], obj.get("startedAt")) + return FactoryAgentSummary(active_ms, agent_id, agent_type, label, run_id, status, tool_call_id, activity, completed_at, phase_id, requested_model, resolved_model, started_at) def to_dict(self) -> dict: result: dict = {} - result["trusted"] = from_bool(self.trusted) + result["activeMs"] = from_int(self.active_ms) + result["agentId"] = from_str(self.agent_id) + result["agentType"] = from_str(self.agent_type) + result["label"] = from_str(self.label) + result["runId"] = from_str(self.run_id) + result["status"] = from_str(self.status) + result["toolCallId"] = from_str(self.tool_call_id) + if self.activity is not None: + result["activity"] = from_union([from_str, from_none], self.activity) + if self.completed_at is not None: + result["completedAt"] = from_union([from_int, from_none], self.completed_at) + result["phaseId"] = from_union([from_none, from_str], self.phase_id) + if self.requested_model is not None: + result["requestedModel"] = from_union([from_str, from_none], self.requested_model) + if self.resolved_model is not None: + result["resolvedModel"] = from_union([from_str, from_none], self.resolved_model) + if self.started_at is not None: + result["startedAt"] = from_union([from_int, from_none], self.started_at) return result -class GhCLIAuthInfoType(Enum): - GH_CLI = "gh-cli" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HandlePendingToolCallResult: - """Indicates whether the external tool call result was handled successfully.""" +class FactoryCancelRequest: + """Parameters for cancelling a factory run.""" - success: bool - """Whether the tool call result was handled successfully""" + run_id: str + """Factory run identifier.""" @staticmethod - def from_dict(obj: Any) -> 'HandlePendingToolCallResult': + def from_dict(obj: Any) -> 'FactoryCancelRequest': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return HandlePendingToolCallResult(success) + run_id = from_str(obj.get("runId")) + return FactoryCancelRequest(run_id) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["runId"] = from_str(self.run_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryAbortManualCompactionResult: - """Indicates whether an in-progress manual compaction was aborted.""" +class FactoryCurrentPhase: + """Current factory phase identity.""" - aborted: bool - """Whether an in-progress manual compaction was aborted. False when no manual compaction was - running, when its abort controller was already aborted, or when the session is remote. - """ + id: str + ordinal: int | None = None @staticmethod - def from_dict(obj: Any) -> 'HistoryAbortManualCompactionResult': + def from_dict(obj: Any) -> 'FactoryCurrentPhase': assert isinstance(obj, dict) - aborted = from_bool(obj.get("aborted")) - return HistoryAbortManualCompactionResult(aborted) + id = from_str(obj.get("id")) + ordinal = from_union([from_none, from_int], obj.get("ordinal")) + return FactoryCurrentPhase(id, ordinal) def to_dict(self) -> dict: result: dict = {} - result["aborted"] = from_bool(self.aborted) + result["id"] = from_str(self.id) + result["ordinal"] = from_union([from_none, from_int], self.ordinal) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryCancelBackgroundCompactionResult: - """Indicates whether an in-progress background compaction was cancelled.""" +class FactoryDeclaredLimits: + """Declared or approved factory resource ceilings.""" - cancelled: bool - """Whether an in-progress background compaction was cancelled. False when no compaction was - running, when the session is remote, or when the underlying processor was unavailable. - """ + max_ai_credits: float | None = None + max_concurrent_subagents: int | None = None + max_total_subagents: int | None = None + timeout_seconds: float | None = None @staticmethod - def from_dict(obj: Any) -> 'HistoryCancelBackgroundCompactionResult': + def from_dict(obj: Any) -> 'FactoryDeclaredLimits': assert isinstance(obj, dict) - cancelled = from_bool(obj.get("cancelled")) - return HistoryCancelBackgroundCompactionResult(cancelled) + max_ai_credits = from_union([from_float, from_none], obj.get("maxAiCredits")) + max_concurrent_subagents = from_union([from_int, from_none], obj.get("maxConcurrentSubagents")) + max_total_subagents = from_union([from_int, from_none], obj.get("maxTotalSubagents")) + timeout_seconds = from_union([from_float, from_none], obj.get("timeoutSeconds")) + return FactoryDeclaredLimits(max_ai_credits, max_concurrent_subagents, max_total_subagents, timeout_seconds) def to_dict(self) -> dict: result: dict = {} - result["cancelled"] = from_bool(self.cancelled) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([to_float, from_none], self.max_ai_credits) + if self.max_concurrent_subagents is not None: + result["maxConcurrentSubagents"] = from_union([from_int, from_none], self.max_concurrent_subagents) + if self.max_total_subagents is not None: + result["maxTotalSubagents"] = from_union([from_int, from_none], self.max_total_subagents) + if self.timeout_seconds is not None: + result["timeoutSeconds"] = from_union([to_float, from_none], self.timeout_seconds) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class HistoryCompactContextWindow: - """Post-compaction context window usage breakdown""" +class FactoryDurableOperation(Enum): + """Execution-critical factory storage operation. - current_tokens: int - """Current total tokens in the context window (system + conversation + tool definitions)""" + Execution-critical durable operation that failed. + """ + ADD_ELAPSED = "addElapsed" + CHARGE_CREDIT = "chargeCredit" + CREATE_RUN = "createRun" + FINISH_RUN = "finishRun" + JOURNAL_GET = "journalGet" + JOURNAL_PUT = "journalPut" + MARK_RUN_STARTED = "markRunStarted" + RECONCILE_CREDIT_TOTAL = "reconcileCreditTotal" + RELEASE_AGENT = "releaseAgent" + RESERVE_AGENT = "reserveAgent" - messages_length: int - """Current number of messages in the conversation""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryExecuteRequest: + """Parameters sent to the owning extension to execute a factory closure.""" - token_limit: int - """Maximum token count for the model's context window""" + args: Any + """Factory input value.""" - conversation_tokens: int | None = None - """Token count from non-system messages (user, assistant, tool)""" + execution_token: str + """Opaque token identifying this factory execution attempt.""" - system_tokens: int | None = None - """Token count from system message(s)""" + name: str + """Registered factory name.""" - tool_definitions_tokens: int | None = None - """Token count from tool definitions""" + run_id: str + """Factory run identifier.""" + + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'HistoryCompactContextWindow': + def from_dict(obj: Any) -> 'FactoryExecuteRequest': assert isinstance(obj, dict) - current_tokens = from_int(obj.get("currentTokens")) - messages_length = from_int(obj.get("messagesLength")) - token_limit = from_int(obj.get("tokenLimit")) - conversation_tokens = from_union([from_int, from_none], obj.get("conversationTokens")) - system_tokens = from_union([from_int, from_none], obj.get("systemTokens")) - tool_definitions_tokens = from_union([from_int, from_none], obj.get("toolDefinitionsTokens")) - return HistoryCompactContextWindow(current_tokens, messages_length, token_limit, conversation_tokens, system_tokens, tool_definitions_tokens) + args = obj.get("args") + execution_token = from_str(obj.get("executionToken")) + name = from_str(obj.get("name")) + run_id = from_str(obj.get("runId")) + session_id = from_str(obj.get("sessionId")) + return FactoryExecuteRequest(args, execution_token, name, run_id, session_id) def to_dict(self) -> dict: result: dict = {} - result["currentTokens"] = from_int(self.current_tokens) - result["messagesLength"] = from_int(self.messages_length) - result["tokenLimit"] = from_int(self.token_limit) - if self.conversation_tokens is not None: - result["conversationTokens"] = from_union([from_int, from_none], self.conversation_tokens) - if self.system_tokens is not None: - result["systemTokens"] = from_union([from_int, from_none], self.system_tokens) - if self.tool_definitions_tokens is not None: - result["toolDefinitionsTokens"] = from_union([from_int, from_none], self.tool_definitions_tokens) + result["args"] = self.args + result["executionToken"] = from_str(self.execution_token) + result["name"] = from_str(self.name) + result["runId"] = from_str(self.run_id) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryCompactRequest: - """Optional compaction parameters.""" +class FactoryExecuteResult: + """Result returned by an extension factory closure.""" - custom_instructions: str | None = None - """Optional user-provided instructions to focus the compaction summary""" + result: Any = None + """Factory result value.""" @staticmethod - def from_dict(obj: Any) -> 'HistoryCompactRequest': + def from_dict(obj: Any) -> 'FactoryExecuteResult': assert isinstance(obj, dict) - custom_instructions = from_union([from_str, from_none], obj.get("customInstructions")) - return HistoryCompactRequest(custom_instructions) + result = obj.get("result") + return FactoryExecuteResult(result) def to_dict(self) -> dict: result: dict = {} - if self.custom_instructions is not None: - result["customInstructions"] = from_union([from_str, from_none], self.custom_instructions) + if self.result is not None: + result["result"] = self.result return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistorySummarizeForHandoffResult: - """Markdown summary of the conversation context (empty when not available).""" +class FactoryGetRunProgressRequest: + """Parameters for paging factory progress.""" - summary: str - """Markdown summary of the conversation context produced by an LLM. Empty string when there - are no messages or when the session does not support local summarization. - """ + run_id: str + """Factory run identifier.""" + + after_seq: int | None = None + """Exclusive forward cursor.""" + + before_seq: int | None = None + """Exclusive backward cursor.""" + + limit: int | None = None + """Maximum records to return. Defaults to 200 and is capped at 500.""" + + phase_id: str | None = None + """Optional phase identifier used to scope records and cursors.""" @staticmethod - def from_dict(obj: Any) -> 'HistorySummarizeForHandoffResult': + def from_dict(obj: Any) -> 'FactoryGetRunProgressRequest': assert isinstance(obj, dict) - summary = from_str(obj.get("summary")) - return HistorySummarizeForHandoffResult(summary) + run_id = from_str(obj.get("runId")) + after_seq = from_union([from_int, from_none], obj.get("afterSeq")) + before_seq = from_union([from_int, from_none], obj.get("beforeSeq")) + limit = from_union([from_int, from_none], obj.get("limit")) + phase_id = from_union([from_str, from_none], obj.get("phaseId")) + return FactoryGetRunProgressRequest(run_id, after_seq, before_seq, limit, phase_id) def to_dict(self) -> dict: result: dict = {} - result["summary"] = from_str(self.summary) + result["runId"] = from_str(self.run_id) + if self.after_seq is not None: + result["afterSeq"] = from_union([from_int, from_none], self.after_seq) + if self.before_seq is not None: + result["beforeSeq"] = from_union([from_int, from_none], self.before_seq) + if self.limit is not None: + result["limit"] = from_union([from_int, from_none], self.limit) + if self.phase_id is not None: + result["phaseId"] = from_union([from_str, from_none], self.phase_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryTruncateRequest: - """Identifier of the event to truncate to; this event and all later events are removed.""" +class FactoryGetRunRequest: + """Parameters for retrieving a factory run.""" - event_id: str - """Event ID to truncate to. This event and all events after it are removed from the session.""" + run_id: str + """Factory run identifier.""" @staticmethod - def from_dict(obj: Any) -> 'HistoryTruncateRequest': + def from_dict(obj: Any) -> 'FactoryGetRunRequest': assert isinstance(obj, dict) - event_id = from_str(obj.get("eventId")) - return HistoryTruncateRequest(event_id) + run_id = from_str(obj.get("runId")) + return FactoryGetRunRequest(run_id) def to_dict(self) -> dict: result: dict = {} - result["eventId"] = from_str(self.event_id) + result["runId"] = from_str(self.run_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryTruncateResult: - """Number of events that were removed by the truncation.""" +class FactoryJournalGetRequest: + """Parameters for reading a factory journal entry.""" - events_removed: int - """Number of events that were removed""" + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + + key: str + """Namespaced journal key.""" + + run_id: str + """Factory run identifier.""" @staticmethod - def from_dict(obj: Any) -> 'HistoryTruncateResult': + def from_dict(obj: Any) -> 'FactoryJournalGetRequest': assert isinstance(obj, dict) - events_removed = from_int(obj.get("eventsRemoved")) - return HistoryTruncateResult(events_removed) + execution_token = from_str(obj.get("executionToken")) + key = from_str(obj.get("key")) + run_id = from_str(obj.get("runId")) + return FactoryJournalGetRequest(execution_token, key, run_id) def to_dict(self) -> dict: result: dict = {} - result["eventsRemoved"] = from_int(self.events_removed) + result["executionToken"] = from_str(self.execution_token) + result["key"] = from_str(self.key) + result["runId"] = from_str(self.run_id) return result -class HMACAuthInfoType(Enum): - HMAC = "hmac" - -class PurpleSource(Enum): - GITHUB = "github" - LOCAL = "local" - URL = "url" - -class FluffySource(Enum): - GITHUB = "github" - -class TentacledSource(Enum): - LOCAL = "local" - -class StickySource(Enum): - URL = "url" - -# Experimental: this type is part of an experimental API and may change or be removed. -class InstructionsSourcesLocation(Enum): - """Where this source lives — used for UI grouping""" - - PLUGIN = "plugin" - REPOSITORY = "repository" - USER = "user" - WORKING_DIRECTORY = "working-directory" - -# Experimental: this type is part of an experimental API and may change or be removed. -class InstructionsSourcesType(Enum): - """Category of instruction source — used for merge logic""" - - CHILD_INSTRUCTIONS = "child-instructions" - HOME = "home" - MODEL = "model" - NESTED_AGENTS = "nested-agents" - PLUGIN = "plugin" - REPO = "repo" - VSCODE = "vscode" - -# Experimental: this type is part of an experimental API and may change or be removed. -class SessionLogLevel(Enum): - """Log severity level. Determines how the message is displayed in the timeline. Defaults to - "info". - """ - ERROR = "error" - INFO = "info" - WARNING = "warning" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class LogResult: - """Identifier of the session event that was emitted for the log message.""" +class FactoryJournalGetResult: + """Result of reading a factory journal entry.""" - event_id: UUID - """The unique identifier of the emitted session event""" + hit: bool + """Whether the journal contained the requested key.""" + + result_json: Any = None + """Cached JSON result. The hit field distinguishes a cached JSON null from a miss.""" @staticmethod - def from_dict(obj: Any) -> 'LogResult': + def from_dict(obj: Any) -> 'FactoryJournalGetResult': assert isinstance(obj, dict) - event_id = UUID(obj.get("eventId")) - return LogResult(event_id) + hit = from_bool(obj.get("hit")) + result_json = obj.get("resultJson") + return FactoryJournalGetResult(hit, result_json) def to_dict(self) -> dict: result: dict = {} - result["eventId"] = str(self.event_id) + result["hit"] = from_bool(self.hit) + if self.result_json is not None: + result["resultJson"] = self.result_json return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class LspInitializeRequest: - """Parameters for (re)loading the merged LSP configuration set.""" +class FactoryJournalPutRequest: + """Parameters for storing a factory journal entry.""" - force: bool | None = None - """Force re-initialization even when LSP configs were already loaded for the working - directory. - """ - git_root: str | None = None - """Git root used as the boundary when traversing for project-level LSP configs (supports - monorepos). - """ - working_directory: str | None = None - """Working directory used to load project-level LSP configs. Defaults to the session working - directory when omitted. - """ + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + + key: str + """Namespaced journal key.""" + + result_json: Any + """JSON result to memoize.""" + + run_id: str + """Factory run identifier.""" @staticmethod - def from_dict(obj: Any) -> 'LspInitializeRequest': + def from_dict(obj: Any) -> 'FactoryJournalPutRequest': assert isinstance(obj, dict) - force = from_union([from_bool, from_none], obj.get("force")) - git_root = from_union([from_str, from_none], obj.get("gitRoot")) - working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) - return LspInitializeRequest(force, git_root, working_directory) + execution_token = from_str(obj.get("executionToken")) + key = from_str(obj.get("key")) + result_json = obj.get("resultJson") + run_id = from_str(obj.get("runId")) + return FactoryJournalPutRequest(execution_token, key, result_json, run_id) def to_dict(self) -> dict: result: dict = {} - if self.force is not None: - result["force"] = from_union([from_bool, from_none], self.force) - if self.git_root is not None: - result["gitRoot"] = from_union([from_str, from_none], self.git_root) - if self.working_directory is not None: - result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + result["executionToken"] = from_str(self.execution_token) + result["key"] = from_str(self.key) + result["resultJson"] = self.result_json + result["runId"] = from_str(self.run_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsDiagnoseCapability: - """Capability negotiation snapshot""" +class FactoryListRunsRequest: + """Parameters for paging factory runs.""" - advertised: bool - """Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers""" + after_seq: int | None = None + """Exclusive forward cursor.""" - feature_flag_enabled: bool - """Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on""" + before_seq: int | None = None + """Exclusive backward cursor.""" - session_has_mcp_apps: bool - """Whether the session has the `mcp-apps` capability""" + limit: int | None = None + """Maximum terminal runs to return. Defaults to 200 and is capped at 500.""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsDiagnoseCapability': + def from_dict(obj: Any) -> 'FactoryListRunsRequest': assert isinstance(obj, dict) - advertised = from_bool(obj.get("advertised")) - feature_flag_enabled = from_bool(obj.get("featureFlagEnabled")) - session_has_mcp_apps = from_bool(obj.get("sessionHasMcpApps")) - return MCPAppsDiagnoseCapability(advertised, feature_flag_enabled, session_has_mcp_apps) + after_seq = from_union([from_int, from_none], obj.get("afterSeq")) + before_seq = from_union([from_int, from_none], obj.get("beforeSeq")) + limit = from_union([from_int, from_none], obj.get("limit")) + return FactoryListRunsRequest(after_seq, before_seq, limit) def to_dict(self) -> dict: result: dict = {} - result["advertised"] = from_bool(self.advertised) - result["featureFlagEnabled"] = from_bool(self.feature_flag_enabled) - result["sessionHasMcpApps"] = from_bool(self.session_has_mcp_apps) + if self.after_seq is not None: + result["afterSeq"] = from_union([from_int, from_none], self.after_seq) + if self.before_seq is not None: + result["beforeSeq"] = from_union([from_int, from_none], self.before_seq) + if self.limit is not None: + result["limit"] = from_union([from_int, from_none], self.limit) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsDiagnoseRequest: - """MCP server to diagnose MCP Apps wiring for.""" +class FactoryRunConsumed: + """Durable factory resource consumption.""" - server_name: str - """MCP server to probe""" + active_ms: int + nano_aiu: int + subagents: int @staticmethod - def from_dict(obj: Any) -> 'MCPAppsDiagnoseRequest': + def from_dict(obj: Any) -> 'FactoryRunConsumed': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return MCPAppsDiagnoseRequest(server_name) + active_ms = from_int(obj.get("activeMs")) + nano_aiu = from_int(obj.get("nanoAiu")) + subagents = from_int(obj.get("subagents")) + return FactoryRunConsumed(active_ms, nano_aiu, subagents) def to_dict(self) -> dict: result: dict = {} - result["serverName"] = from_str(self.server_name) + result["activeMs"] = from_int(self.active_ms) + result["nanoAiu"] = from_int(self.nano_aiu) + result["subagents"] = from_int(self.subagents) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class MCPAppsDiagnoseServer: - """What the server returned for this session""" - - connected: bool - """Whether the named server is currently connected""" - - sample_tool_names: list[str] - """Up to 5 tool names with `_meta.ui` for quick inspection""" +class FactoryRunStatus(Enum): + """Current or terminal state of a factory run. - tool_count: float - """Total tools returned by the server's tools/list""" + Current or terminal factory run status. + """ + CANCELLED = "cancelled" + COMPLETED = "completed" + ERROR = "error" + HALTED = "halted" + PENDING = "pending" + RUNNING = "running" - tools_with_ui_meta: float - """Tools whose `_meta.ui` is populated (resourceUri and/or visibility set)""" +# Experimental: this type is part of an experimental API and may change or be removed. +class FactoryRunFailureKind(Enum): + """Resource ceiling that stopped the run. - @staticmethod - def from_dict(obj: Any) -> 'MCPAppsDiagnoseServer': - assert isinstance(obj, dict) - connected = from_bool(obj.get("connected")) - sample_tool_names = from_list(from_str, obj.get("sampleToolNames")) - tool_count = from_float(obj.get("toolCount")) - tools_with_ui_meta = from_float(obj.get("toolsWithUiMeta")) - return MCPAppsDiagnoseServer(connected, sample_tool_names, tool_count, tools_with_ui_meta) + Cumulative resource ceiling that stopped a factory run. + """ + MAX_AI_CREDITS = "maxAiCredits" + MAX_TOTAL_SUBAGENTS = "maxTotalSubagents" + TIMEOUT_SECONDS = "timeoutSeconds" - def to_dict(self) -> dict: - result: dict = {} - result["connected"] = from_bool(self.connected) - result["sampleToolNames"] = from_list(from_str, self.sample_tool_names) - result["toolCount"] = to_float(self.tool_count) - result["toolsWithUiMeta"] = to_float(self.tools_with_ui_meta) - return result +class FactoryRunFailureType(Enum): + FACTORY_ACCOUNTING_INCOMPLETE = "factory_accounting_incomplete" + FACTORY_DURABLE_FAILURE = "factory_durable_failure" + FACTORY_LIMIT_REACHED = "factory_limit_reached" + FACTORY_RESUME_DECLINED = "factory_resume_declined" # Experimental: this type is part of an experimental API and may change or be removed. -class MCPAppsDisplayMode(Enum): - """Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +class FactoryLogLineKind(Enum): + """Progress line kind. - Current display mode (SEP-1865) + Kind of factory progress line. - Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. + Progress record kind. """ - FULLSCREEN = "fullscreen" - INLINE = "inline" - PIP = "pip" + LOG = "log" + PHASE = "phase" # Experimental: this type is part of an experimental API and may change or be removed. -class MCPAppsHostContextDetailsPlatform(Enum): - """Platform type for responsive design""" +class FactoryPhaseStatus(Enum): + """Derived lifecycle state of a factory phase.""" - DESKTOP = "desktop" - MOBILE = "mobile" - WEB = "web" + ACTIVE = "active" + COMPLETED = "completed" + PENDING = "pending" + SKIPPED = "skipped" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsListToolsRequest: - """MCP server to list app-callable tools for.""" +class FactoryRunLimits: + """Optional per-invocation resource ceiling overrides. - origin_server_name: str - """**Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the - app from this server only'), the call is rejected when this differs from `serverName`, - and rejected outright when missing. + Wire-only per-invocation factory resource ceiling overrides. + + Per-invocation resource ceiling overrides. + """ + max_ai_credits: float | None = None + """Maximum AI credits consumed by factory subagents and their descendants. The post-paid + ceiling is soft: parallel turns can settle beyond it before the run stops. + """ + max_concurrent_subagents: int | None = None + """Maximum number of factory subagents that may run concurrently.""" + + max_total_subagents: int | None = None + """Maximum total number of factory subagents that may be admitted.""" + + timeout_seconds: float | None = None + """Maximum accumulated active-execution time in seconds. Active execution includes the + entire extension body, subprocess waits, queued-agent waits, and sleeps; time between + resumed attempts is not counted. """ - server_name: str - """MCP server hosting the app""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsListToolsRequest': + def from_dict(obj: Any) -> 'FactoryRunLimits': assert isinstance(obj, dict) - origin_server_name = from_str(obj.get("originServerName")) - server_name = from_str(obj.get("serverName")) - return MCPAppsListToolsRequest(origin_server_name, server_name) + max_ai_credits = from_union([from_float, from_none], obj.get("maxAiCredits")) + max_concurrent_subagents = from_union([from_int, from_none], obj.get("maxConcurrentSubagents")) + max_total_subagents = from_union([from_int, from_none], obj.get("maxTotalSubagents")) + timeout_seconds = from_union([from_float, from_none], obj.get("timeoutSeconds")) + return FactoryRunLimits(max_ai_credits, max_concurrent_subagents, max_total_subagents, timeout_seconds) def to_dict(self) -> dict: result: dict = {} - result["originServerName"] = from_str(self.origin_server_name) - result["serverName"] = from_str(self.server_name) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([to_float, from_none], self.max_ai_credits) + if self.max_concurrent_subagents is not None: + result["maxConcurrentSubagents"] = from_union([from_int, from_none], self.max_concurrent_subagents) + if self.max_total_subagents is not None: + result["maxTotalSubagents"] = from_union([from_int, from_none], self.max_total_subagents) + if self.timeout_seconds is not None: + result["timeoutSeconds"] = from_union([to_float, from_none], self.timeout_seconds) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsListToolsResult: - """App-callable tools from the named MCP server.""" +class FleetStartRequest: + """Optional user prompt to combine with the fleet orchestration instructions.""" - tools: list[dict[str, Any]] - """App-callable tools from the server""" + prompt: str | None = None + """Optional user prompt to combine with fleet instructions""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsListToolsResult': + def from_dict(obj: Any) -> 'FleetStartRequest': assert isinstance(obj, dict) - tools = from_list(lambda x: from_dict(lambda x: x, x), obj.get("tools")) - return MCPAppsListToolsResult(tools) + prompt = from_union([from_str, from_none], obj.get("prompt")) + return FleetStartRequest(prompt) def to_dict(self) -> dict: result: dict = {} - result["tools"] = from_list(lambda x: from_dict(lambda x: x, x), self.tools) + if self.prompt is not None: + result["prompt"] = from_union([from_str, from_none], self.prompt) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsReadResourceRequest: - """MCP server and resource URI to fetch.""" - - server_name: str - """Name of the MCP server hosting the resource""" +class FleetStartResult: + """Indicates whether fleet mode was successfully activated.""" - uri: str - """Resource URI (typically ui://...)""" + started: bool + """Whether fleet mode was successfully activated""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsReadResourceRequest': + def from_dict(obj: Any) -> 'FleetStartResult': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - uri = from_str(obj.get("uri")) - return MCPAppsReadResourceRequest(server_name, uri) + started = from_bool(obj.get("started")) + return FleetStartResult(started) def to_dict(self) -> dict: result: dict = {} - result["serverName"] = from_str(self.server_name) - result["uri"] = from_str(self.uri) + result["started"] = from_bool(self.started) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsResourceContent: - """Schema for the `McpAppsResourceContent` type.""" - - uri: str - """The resource URI (typically ui://...)""" - - meta: dict[str, Any] | None = None - """Resource-level metadata (CSP, permissions, etc.)""" - - blob: str | None = None - """Base64-encoded binary content""" - - mime_type: str | None = None - """MIME type of the content""" +class FolderTrustAddParams: + """Folder path to add to trusted folders.""" - text: str | None = None - """Text content (e.g. HTML)""" + path: str + """Folder path to mark as trusted""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsResourceContent': + def from_dict(obj: Any) -> 'FolderTrustAddParams': assert isinstance(obj, dict) - uri = from_str(obj.get("uri")) - meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) - blob = from_union([from_str, from_none], obj.get("blob")) - mime_type = from_union([from_str, from_none], obj.get("mimeType")) - text = from_union([from_str, from_none], obj.get("text")) - return MCPAppsResourceContent(uri, meta, blob, mime_type, text) + path = from_str(obj.get("path")) + return FolderTrustAddParams(path) def to_dict(self) -> dict: result: dict = {} - result["uri"] = from_str(self.uri) - if self.meta is not None: - result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) - if self.blob is not None: - result["blob"] = from_union([from_str, from_none], self.blob) - if self.mime_type is not None: - result["mimeType"] = from_union([from_str, from_none], self.mime_type) - if self.text is not None: - result["text"] = from_union([from_str, from_none], self.text) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPCancelSamplingExecutionParams: - """The requestId previously passed to executeSampling that should be cancelled.""" +class FolderTrustCheckParams: + """Folder path to check for trust.""" - request_id: str - """The requestId previously passed to executeSampling that should be cancelled""" + path: str + """Folder path to check""" @staticmethod - def from_dict(obj: Any) -> 'MCPCancelSamplingExecutionParams': + def from_dict(obj: Any) -> 'FolderTrustCheckParams': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - return MCPCancelSamplingExecutionParams(request_id) + path = from_str(obj.get("path")) + return FolderTrustCheckParams(path) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPCancelSamplingExecutionResult: - """Indicates whether an in-flight sampling execution with the given requestId was found and - cancelled. - """ - cancelled: bool - """True if an in-flight execution with the given requestId was found and signalled to - cancel. False when no such execution is in flight (already completed, never started, or - cancelled by another caller). - """ +class FolderTrustCheckResult: + """Folder trust check result.""" + + trusted: bool + """Whether the folder is trusted""" @staticmethod - def from_dict(obj: Any) -> 'MCPCancelSamplingExecutionResult': + def from_dict(obj: Any) -> 'FolderTrustCheckResult': assert isinstance(obj, dict) - cancelled = from_bool(obj.get("cancelled")) - return MCPCancelSamplingExecutionResult(cancelled) + trusted = from_bool(obj.get("trusted")) + return FolderTrustCheckResult(trusted) def to_dict(self) -> dict: result: dict = {} - result["cancelled"] = from_bool(self.cancelled) + result["trusted"] = from_bool(self.trusted) return result +class GhCLIAuthInfoType(Enum): + GH_CLI = "gh-cli" + +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServerAuthConfigRedirectPort: - """Authentication settings with optional redirect port configuration.""" +class GitHubTelemetryClientInfo: + """Client environment metadata describing the process that produced a telemetry event. - redirect_port: int | None = None - """Fixed port for the OAuth redirect callback server.""" + Client environment metadata. + """ + cli_version: str + """Copilot CLI version string.""" - @staticmethod - def from_dict(obj: Any) -> 'MCPServerAuthConfigRedirectPort': - assert isinstance(obj, dict) - redirect_port = from_union([from_int, from_none], obj.get("redirectPort")) - return MCPServerAuthConfigRedirectPort(redirect_port) + node_version: str + """Node.js runtime version string.""" - def to_dict(self) -> dict: - result: dict = {} - if self.redirect_port is not None: - result["redirectPort"] = from_union([from_int, from_none], self.redirect_port) - return result + os_arch: str + """Operating system architecture (e.g. arm64, x64).""" -class MCPServerConfigHTTPOauthGrantType(Enum): - """OAuth grant type to use when authenticating to the remote MCP server.""" + os_platform: str + """Operating system platform (e.g. darwin, linux, win32).""" - AUTHORIZATION_CODE = "authorization_code" - CLIENT_CREDENTIALS = "client_credentials" + os_version: str + """Operating system version string.""" -class MCPServerConfigHTTPType(Enum): - """Remote transport type. Defaults to "http" when omitted.""" + client_name: str | None = None + """Name of the client application.""" - HTTP = "http" - SSE = "sse" + client_type: str | None = None + """Type of client.""" -@dataclass -class MCPConfigDisableRequest: - """MCP server names to disable for new sessions.""" + copilot_plan: str | None = None + """Copilot subscription plan, when known.""" - names: list[str] - """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. - """ + dev_device_id: str | None = None + """Stable machine identifier for the device.""" + + is_staff: bool | None = None + """Whether the user is a GitHub/Microsoft staff member.""" @staticmethod - def from_dict(obj: Any) -> 'MCPConfigDisableRequest': + def from_dict(obj: Any) -> 'GitHubTelemetryClientInfo': assert isinstance(obj, dict) - names = from_list(from_str, obj.get("names")) - return MCPConfigDisableRequest(names) + cli_version = from_str(obj.get("cli_version")) + node_version = from_str(obj.get("node_version")) + os_arch = from_str(obj.get("os_arch")) + os_platform = from_str(obj.get("os_platform")) + os_version = from_str(obj.get("os_version")) + client_name = from_union([from_str, from_none], obj.get("client_name")) + client_type = from_union([from_str, from_none], obj.get("client_type")) + copilot_plan = from_union([from_str, from_none], obj.get("copilot_plan")) + dev_device_id = from_union([from_str, from_none], obj.get("dev_device_id")) + is_staff = from_union([from_bool, from_none], obj.get("is_staff")) + return GitHubTelemetryClientInfo(cli_version, node_version, os_arch, os_platform, os_version, client_name, client_type, copilot_plan, dev_device_id, is_staff) def to_dict(self) -> dict: result: dict = {} - result["names"] = from_list(from_str, self.names) + result["cli_version"] = from_str(self.cli_version) + result["node_version"] = from_str(self.node_version) + result["os_arch"] = from_str(self.os_arch) + result["os_platform"] = from_str(self.os_platform) + result["os_version"] = from_str(self.os_version) + if self.client_name is not None: + result["client_name"] = from_union([from_str, from_none], self.client_name) + if self.client_type is not None: + result["client_type"] = from_union([from_str, from_none], self.client_type) + if self.copilot_plan is not None: + result["copilot_plan"] = from_union([from_str, from_none], self.copilot_plan) + if self.dev_device_id is not None: + result["dev_device_id"] = from_union([from_str, from_none], self.dev_device_id) + if self.is_staff is not None: + result["is_staff"] = from_union([from_bool, from_none], self.is_staff) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPConfigEnableRequest: - """MCP server names to enable for new sessions.""" +class HandlePendingToolCallResult: + """Indicates whether the external tool call result was handled successfully.""" - names: list[str] - """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. - """ + success: bool + """Whether the tool call result was handled successfully""" @staticmethod - def from_dict(obj: Any) -> 'MCPConfigEnableRequest': + def from_dict(obj: Any) -> 'HandlePendingToolCallResult': assert isinstance(obj, dict) - names = from_list(from_str, obj.get("names")) - return MCPConfigEnableRequest(names) + success = from_bool(obj.get("success")) + return HandlePendingToolCallResult(success) def to_dict(self) -> dict: result: dict = {} - result["names"] = from_list(from_str, self.names) + result["success"] = from_bool(self.success) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPConfigRemoveRequest: - """MCP server name to remove from user configuration.""" +class HistoryAbortManualCompactionResult: + """Indicates whether an in-progress manual compaction was aborted.""" - name: str - """Name of the MCP server to remove""" + aborted: bool + """Whether an in-progress manual compaction was aborted. False when no manual compaction was + running, when its abort controller was already aborted, or when the session is remote. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPConfigRemoveRequest': + def from_dict(obj: Any) -> 'HistoryAbortManualCompactionResult': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - return MCPConfigRemoveRequest(name) + aborted = from_bool(obj.get("aborted")) + return HistoryAbortManualCompactionResult(aborted) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) + result["aborted"] = from_bool(self.aborted) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPDisableRequest: - """Name of the MCP server to disable for the session.""" +class HistoryCancelBackgroundCompactionResult: + """Indicates whether an in-progress background compaction was cancelled.""" - server_name: str - """Name of the MCP server to disable""" + cancelled: bool + """Whether an in-progress background compaction was cancelled. False when no compaction was + running, when the session is remote, or when the underlying processor was unavailable. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPDisableRequest': + def from_dict(obj: Any) -> 'HistoryCancelBackgroundCompactionResult': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return MCPDisableRequest(server_name) + cancelled = from_bool(obj.get("cancelled")) + return HistoryCancelBackgroundCompactionResult(cancelled) def to_dict(self) -> dict: result: dict = {} - result["serverName"] = from_str(self.server_name) + result["cancelled"] = from_bool(self.cancelled) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPDiscoverRequest: - """Optional working directory used as context for MCP server discovery.""" +class HistoryClearContextRequest: + """Parameters for clearing the conversation and seeding the window that replaces it.""" - working_directory: str | None = None - """Working directory used as context for discovery (e.g., plugin resolution)""" + prompt: str + """First user message of the fresh context window. Required: a cleared window holding only + system and developer messages is not a conversation a model can answer, so every clear + seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop + exits, which is why the call must be made from inside a tool handler. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPDiscoverRequest': + def from_dict(obj: Any) -> 'HistoryClearContextRequest': assert isinstance(obj, dict) - working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) - return MCPDiscoverRequest(working_directory) + prompt = from_str(obj.get("prompt")) + return HistoryClearContextRequest(prompt) def to_dict(self) -> dict: result: dict = {} - if self.working_directory is not None: - result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + result["prompt"] = from_str(self.prompt) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPEnableRequest: - """Name of the MCP server to enable for the session.""" - - server_name: str - """Name of the MCP server to enable""" +class HistoryClearContextResult: + """What a successful clear removed. A clear that could not be applied rejects instead of + reporting a count. + """ + messages_cleared: int + """Number of non-system, non-developer messages that were removed from the conversation. + Zero only when the window already held no conversation. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPEnableRequest': + def from_dict(obj: Any) -> 'HistoryClearContextResult': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return MCPEnableRequest(server_name) + messages_cleared = from_int(obj.get("messagesCleared")) + return HistoryClearContextResult(messages_cleared) def to_dict(self) -> dict: result: dict = {} - result["serverName"] = from_str(self.server_name) + result["messagesCleared"] = from_int(self.messages_cleared) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPOauthLoginRequest: - """Remote MCP server name and optional overrides controlling reauthentication, OAuth client - display name, and the callback success-page copy. - """ - server_name: str - """Name of the remote MCP server to authenticate""" +class HistoryCompactContextWindow: + """Post-compaction context window usage breakdown""" - callback_success_message: str | None = None - """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. - """ - client_name: str | None = None - """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. - """ - force_reauth: bool | None = None - """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. - """ - - @staticmethod - def from_dict(obj: Any) -> 'MCPOauthLoginRequest': - assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - callback_success_message = from_union([from_str, from_none], obj.get("callbackSuccessMessage")) - client_name = from_union([from_str, from_none], obj.get("clientName")) - force_reauth = from_union([from_bool, from_none], obj.get("forceReauth")) - return MCPOauthLoginRequest(server_name, callback_success_message, client_name, force_reauth) + current_tokens: int + """Current total tokens in the context window (system + conversation + tool definitions)""" - def to_dict(self) -> dict: - result: dict = {} - result["serverName"] = from_str(self.server_name) - if self.callback_success_message is not None: - result["callbackSuccessMessage"] = from_union([from_str, from_none], self.callback_success_message) - if self.client_name is not None: - result["clientName"] = from_union([from_str, from_none], self.client_name) - if self.force_reauth is not None: - result["forceReauth"] = from_union([from_bool, from_none], self.force_reauth) - return result + messages_length: int + """Current number of messages in the conversation""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class MCPOauthLoginResult: - """OAuth authorization URL the caller should open, or empty when cached tokens already - authenticated the server. - """ - authorization_url: str | None = None - """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. - """ + token_limit: int + """Maximum token count for the model's context window""" - @staticmethod - def from_dict(obj: Any) -> 'MCPOauthLoginResult': - assert isinstance(obj, dict) - authorization_url = from_union([from_str, from_none], obj.get("authorizationUrl")) - return MCPOauthLoginResult(authorization_url) + conversation_tokens: int | None = None + """Token count from non-system messages (user, assistant, tool)""" - def to_dict(self) -> dict: - result: dict = {} - if self.authorization_url is not None: - result["authorizationUrl"] = from_union([from_str, from_none], self.authorization_url) - return result + system_tokens: int | None = None + """Token count from system message(s)""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class MCPRemoveGitHubResult: - """Indicates whether the auto-managed `github` MCP server was removed (false when nothing to - remove). - """ - removed: bool - """True when the auto-managed `github` MCP server was removed; false when no removal - happened (e.g. user has explicitly configured a `github` server, or the server was not - registered). - """ + tool_definitions_tokens: int | None = None + """Token count from tool definitions""" @staticmethod - def from_dict(obj: Any) -> 'MCPRemoveGitHubResult': + def from_dict(obj: Any) -> 'HistoryCompactContextWindow': assert isinstance(obj, dict) - removed = from_bool(obj.get("removed")) - return MCPRemoveGitHubResult(removed) + current_tokens = from_int(obj.get("currentTokens")) + messages_length = from_int(obj.get("messagesLength")) + token_limit = from_int(obj.get("tokenLimit")) + conversation_tokens = from_union([from_int, from_none], obj.get("conversationTokens")) + system_tokens = from_union([from_int, from_none], obj.get("systemTokens")) + tool_definitions_tokens = from_union([from_int, from_none], obj.get("toolDefinitionsTokens")) + return HistoryCompactContextWindow(current_tokens, messages_length, token_limit, conversation_tokens, system_tokens, tool_definitions_tokens) def to_dict(self) -> dict: result: dict = {} - result["removed"] = from_bool(self.removed) + result["currentTokens"] = from_int(self.current_tokens) + result["messagesLength"] = from_int(self.messages_length) + result["tokenLimit"] = from_int(self.token_limit) + if self.conversation_tokens is not None: + result["conversationTokens"] = from_union([from_int, from_none], self.conversation_tokens) + if self.system_tokens is not None: + result["systemTokens"] = from_union([from_int, from_none], self.system_tokens) + if self.tool_definitions_tokens is not None: + result["toolDefinitionsTokens"] = from_union([from_int, from_none], self.tool_definitions_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. -class MCPSamplingExecutionAction(Enum): - """Outcome of the sampling inference. 'success' produced a response; 'failure' encountered - an error (including agent-side rejection by content filter or criteria); 'cancelled' the - caller cancelled this execution via cancelSamplingExecution. +class HistoryFileRestoreSkipReason(Enum): + """Reason a captured file was not restored. + + Reason the file was not restored. """ - CANCELLED = "cancelled" - FAILURE = "failure" - SUCCESS = "success" + SKIPPED_CAPTURE = "skipped-capture" + USER_MODIFIED = "user-modified" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServer: - """Schema for the `McpServer` type.""" +class HistoryRewindPoint: + """A root user turn that the session can rewind to.""" - name: str - """Server name (config key)""" + can_restore_files: bool + """Whether at least one file in this turn or a later turn can be restored.""" - status: McpServerStatus - """Connection status: connected, failed, needs-auth, pending, disabled, or not_configured""" + event_id: str + """ID of the user.message event that begins the discarded suffix.""" - error: str | None = None - """Error message if the server failed to connect""" + file_count: int + """Number of unique files in this turn and all later turns that have captured changes.""" - source: McpServerSource | None = None - """Configuration source: user, workspace, plugin, or builtin""" + is_autopilot_continuation: bool + """Whether this turn was an automatically injected autopilot continuation.""" + + lines_added: int + """Lines added by this turn's captured file changes.""" + + lines_removed: int + """Lines removed by this turn's captured file changes.""" + + timestamp: str + """ISO timestamp of the user turn.""" + + turn_changed_files: bool + """Whether this turn itself captured any file changes.""" + + user_message: str + """User-visible message text for the turn.""" @staticmethod - def from_dict(obj: Any) -> 'MCPServer': + def from_dict(obj: Any) -> 'HistoryRewindPoint': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - status = McpServerStatus(obj.get("status")) - error = from_union([from_str, from_none], obj.get("error")) - source = from_union([McpServerSource, from_none], obj.get("source")) - return MCPServer(name, status, error, source) + can_restore_files = from_bool(obj.get("canRestoreFiles")) + event_id = from_str(obj.get("eventId")) + file_count = from_int(obj.get("fileCount")) + is_autopilot_continuation = from_bool(obj.get("isAutopilotContinuation")) + lines_added = from_int(obj.get("linesAdded")) + lines_removed = from_int(obj.get("linesRemoved")) + timestamp = from_str(obj.get("timestamp")) + turn_changed_files = from_bool(obj.get("turnChangedFiles")) + user_message = from_str(obj.get("userMessage")) + return HistoryRewindPoint(can_restore_files, event_id, file_count, is_autopilot_continuation, lines_added, lines_removed, timestamp, turn_changed_files, user_message) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) - result["status"] = to_enum(McpServerStatus, self.status) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) - if self.source is not None: - result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + result["canRestoreFiles"] = from_bool(self.can_restore_files) + result["eventId"] = from_str(self.event_id) + result["fileCount"] = from_int(self.file_count) + result["isAutopilotContinuation"] = from_bool(self.is_autopilot_continuation) + result["linesAdded"] = from_int(self.lines_added) + result["linesRemoved"] = from_int(self.lines_removed) + result["timestamp"] = from_str(self.timestamp) + result["turnChangedFiles"] = from_bool(self.turn_changed_files) + result["userMessage"] = from_str(self.user_message) return result # Experimental: this type is part of an experimental API and may change or be removed. -class MCPSetEnvValueModeDetails(Enum): - """How environment-variable values supplied to MCP servers are resolved. "direct" passes - literal string values; "indirect" treats values as references (e.g. names of environment - variables on the host) that the runtime resolves before launch. Defaults to the runtime's - startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI - prompt mode and ACP) set this to "direct". +class HistoryRewindUnavailableReason(Enum): + """Why the listed points could not be produced, when applicable; the points list is empty + whenever it is set. `unsupported-remote-session` is permanent for the session and comes + with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever + reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the + file-change captures cannot be read while work that may still mutate them is in flight; + the same request succeeds once the session settles, so a client that wants points should + retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an + untracked local session still lists conversation-only points and reports that through + `fileChangeTrackingEnabled: false`. - Mode recorded on the session after the update + Reason a rewind read (rewind points, file-restore preview, or session diff) could not be + answered from the session's file-change captures. - How env values are passed to MCP servers (`direct` inlines literal values; `indirect` - resolves at launch). + Why file restore is unavailable, when applicable. Populated only when `available` is + false and never set when `available` is true. + + Why the session diff could not be produced, when applicable. Set only when `session` mode + was requested and `isFallback` is true, so a client can tell the permanent + `file-change-tracking-disabled` apart from the transient `session-busy`, which the same + request answers once the session settles. Never set for `unstaged` or `branch` mode, and + never `unsupported-remote-session`: a remote session's captures live on its own host, so + a `session`-mode diff is rejected for one rather than answered with a controller-side + fallback. """ - DIRECT = "direct" - INDIRECT = "indirect" + FILE_CHANGE_TRACKING_DISABLED = "file-change-tracking-disabled" + SESSION_BUSY = "session-busy" + UNSUPPORTED_REMOTE_SESSION = "unsupported-remote-session" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionContextInfo: - """Token-usage breakdown for the session's current context window""" +class HistoryPreviewRewindRequest: + """Event boundary to preview for conversation-and-files rewind.""" - buffer_tokens: int - """Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%)""" + event_id: str + """ID of the user.message event that begins the discarded suffix.""" - compaction_threshold: int - """Token count at which background compaction starts (configurable percentage of - promptTokenLimit) - """ - conversation_tokens: int - """Tokens consumed by user/assistant/tool messages""" + @staticmethod + def from_dict(obj: Any) -> 'HistoryPreviewRewindRequest': + assert isinstance(obj, dict) + event_id = from_str(obj.get("eventId")) + return HistoryPreviewRewindRequest(event_id) - limit: int - """Total context limit for /context display. promptTokenLimit + min(32k or 64k, - outputTokenLimit) depending on model. + def to_dict(self) -> dict: + result: dict = {} + result["eventId"] = from_str(self.event_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +class HistoryRewindChangeType(Enum): + """Aggregate change made across the discarded turns. + + Aggregate file change represented by a rewind preview. """ - mcp_tools_tokens: int - """Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes - deferred tools) + CREATED = "created" + DELETED = "deleted" + MODIFIED = "modified" + +# Experimental: this type is part of an experimental API and may change or be removed. +class HistoryRewindMode(Enum): + """Scope of a rewind operation. + + Whether to rewind only conversation history or also restore captured files. """ - model_name: str - """The model used for token counting""" + CONVERSATION = "conversation" + CONVERSATION_AND_FILES = "conversation-and-files" - prompt_token_limit: int - """Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified)""" +# Experimental: this type is part of an experimental API and may change or be removed. +class HistoryRewindOutcome(Enum): + """Outcome of a rewind request. - system_tokens: int - """Tokens consumed by the system prompt""" + Overall rewind outcome. This discriminates the result: it governs which of the remaining + fields are populated, so consumers must switch on it before reading `eventsRemoved`, + `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that + populate it. + """ + CHECKPOINT_CLEANUP_FAILED = "checkpoint-cleanup-failed" + FILES_ROLLED_BACK = "files-rolled-back" + FILE_CHANGE_TRACKING_DISABLED = "file-change-tracking-disabled" + ROLLBACK_INCOMPLETE = "rollback-incomplete" + SESSION_BUSY = "session-busy" + SNAPSHOT_PRUNE_FAILED = "snapshot-prune-failed" + SUCCESS = "success" + TRUNCATION_FAILED = "truncation-failed" + UNSUPPORTED_REMOTE_SESSION = "unsupported-remote-session" - tool_definitions_tokens: int - """Tokens consumed by tool definitions sent to the model (excludes deferred tools)""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class HistorySummarizeForHandoffResult: + """Markdown summary of the conversation context (empty when not available).""" - total_tokens: int - """Sum of system, conversation and tool-definition tokens""" + summary: str + """Markdown summary of the conversation context produced by an LLM. Empty string when there + are no messages or when the session does not support local summarization. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionContextInfo': + def from_dict(obj: Any) -> 'HistorySummarizeForHandoffResult': assert isinstance(obj, dict) - buffer_tokens = from_int(obj.get("bufferTokens")) - compaction_threshold = from_int(obj.get("compactionThreshold")) - conversation_tokens = from_int(obj.get("conversationTokens")) - limit = from_int(obj.get("limit")) - mcp_tools_tokens = from_int(obj.get("mcpToolsTokens")) - model_name = from_str(obj.get("modelName")) - prompt_token_limit = from_int(obj.get("promptTokenLimit")) - system_tokens = from_int(obj.get("systemTokens")) - tool_definitions_tokens = from_int(obj.get("toolDefinitionsTokens")) - total_tokens = from_int(obj.get("totalTokens")) - return SessionContextInfo(buffer_tokens, compaction_threshold, conversation_tokens, limit, mcp_tools_tokens, model_name, prompt_token_limit, system_tokens, tool_definitions_tokens, total_tokens) + summary = from_str(obj.get("summary")) + return HistorySummarizeForHandoffResult(summary) def to_dict(self) -> dict: result: dict = {} - result["bufferTokens"] = from_int(self.buffer_tokens) - result["compactionThreshold"] = from_int(self.compaction_threshold) - result["conversationTokens"] = from_int(self.conversation_tokens) - result["limit"] = from_int(self.limit) - result["mcpToolsTokens"] = from_int(self.mcp_tools_tokens) - result["modelName"] = from_str(self.model_name) - result["promptTokenLimit"] = from_int(self.prompt_token_limit) - result["systemTokens"] = from_int(self.system_tokens) - result["toolDefinitionsTokens"] = from_int(self.tool_definitions_tokens) - result["totalTokens"] = from_int(self.total_tokens) + result["summary"] = from_str(self.summary) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataIsProcessingResult: - """Indicates whether the local session is currently processing a turn or background - continuation. - """ - processing: bool - """Whether the session is currently processing user/agent messages. False for non-local - sessions (which don't run a local agentic loop). Reflects an in-flight turn or background - continuation. - """ +class HistoryTruncateRequest: + """Identifier of the event to truncate to; this event and all later events are removed.""" + + event_id: str + """Event ID to truncate to. This event and all events after it are removed from the session.""" @staticmethod - def from_dict(obj: Any) -> 'MetadataIsProcessingResult': + def from_dict(obj: Any) -> 'HistoryTruncateRequest': assert isinstance(obj, dict) - processing = from_bool(obj.get("processing")) - return MetadataIsProcessingResult(processing) + event_id = from_str(obj.get("eventId")) + return HistoryTruncateRequest(event_id) def to_dict(self) -> dict: result: dict = {} - result["processing"] = from_bool(self.processing) + result["eventId"] = from_str(self.event_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataRecomputeContextTokensResult: - """Re-tokenize the session's existing messages against `modelId` and return the token - totals. Useful for hosts that want an initial estimate of context usage on session - resume, before the next agent turn fires `session.context_info_changed` events. Returns - zeros for an empty session. - """ - messages_token_count: int - """Tokens contributed by user/assistant/tool messages (excludes system/developer prompts).""" +class HistoryTruncateResult: + """Number of events that were removed by the truncation.""" - system_token_count: int - """Tokens contributed by system/developer prompt snapshots.""" + events_removed: int + """Number of events that were removed""" - total_tokens: int - """Sum of tokens across chat-context and system-context messages currently held by the - session. + checkpoint_cleanup_error: str | None = None + """Failure detail when checkpointCleanupFailed is true.""" + + checkpoint_cleanup_failed: bool | None = None + """True when conversation truncation succeeded but post-truncation workspace checkpoint + cleanup failed. History is already truncated; callers may still prune snapshots but + should report a checkpoint-cleanup rather than a truncation failure. """ @staticmethod - def from_dict(obj: Any) -> 'MetadataRecomputeContextTokensResult': + def from_dict(obj: Any) -> 'HistoryTruncateResult': assert isinstance(obj, dict) - messages_token_count = from_int(obj.get("messagesTokenCount")) - system_token_count = from_int(obj.get("systemTokenCount")) - total_tokens = from_int(obj.get("totalTokens")) - return MetadataRecomputeContextTokensResult(messages_token_count, system_token_count, total_tokens) + events_removed = from_int(obj.get("eventsRemoved")) + checkpoint_cleanup_error = from_union([from_str, from_none], obj.get("checkpointCleanupError")) + checkpoint_cleanup_failed = from_union([from_bool, from_none], obj.get("checkpointCleanupFailed")) + return HistoryTruncateResult(events_removed, checkpoint_cleanup_error, checkpoint_cleanup_failed) def to_dict(self) -> dict: result: dict = {} - result["messagesTokenCount"] = from_int(self.messages_token_count) - result["systemTokenCount"] = from_int(self.system_token_count) - result["totalTokens"] = from_int(self.total_tokens) + result["eventsRemoved"] = from_int(self.events_removed) + if self.checkpoint_cleanup_error is not None: + result["checkpointCleanupError"] = from_union([from_str, from_none], self.checkpoint_cleanup_error) + if self.checkpoint_cleanup_failed is not None: + result["checkpointCleanupFailed"] = from_union([from_bool, from_none], self.checkpoint_cleanup_failed) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class HostType(Enum): - """Hosting platform type of the repository +class HMACAuthInfoType(Enum): + HMAC = "hmac" - Repository host type +# Internal: this type is an internal SDK API and is not part of the public surface. +class _HookType(Enum): + """Hook event name dispatched through the SDK callback transport.""" + + AGENT_STOP = "agentStop" + ERROR_OCCURRED = "errorOccurred" + NOTIFICATION = "notification" + PERMISSION_REQUEST = "permissionRequest" + POST_RESULT = "postResult" + POST_TOOL_USE = "postToolUse" + POST_TOOL_USE_FAILURE = "postToolUseFailure" + PRE_COMPACT = "preCompact" + PRE_MCP_TOOL_CALL = "preMcpToolCall" + PRE_PR_DESCRIPTION = "prePRDescription" + PRE_TOOL_USE = "preToolUse" + SESSION_END = "sessionEnd" + SESSION_START = "sessionStart" + SUBAGENT_START = "subagentStart" + SUBAGENT_STOP = "subagentStop" + USER_PROMPT_SUBMITTED = "userPromptSubmitted" + USER_PROMPT_TRANSFORMED = "userPromptTransformed" - Repository host type, if known +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _HookInvokeResponse: + """Optional output returned by an SDK callback hook.""" - Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - """ - ADO = "ado" + output: Any = None + + @staticmethod + def from_dict(obj: Any) -> '_HookInvokeResponse': + assert isinstance(obj, dict) + output = obj.get("output") + return _HookInvokeResponse(output) + + def to_dict(self) -> dict: + result: dict = {} + if self.output is not None: + result["output"] = self.output + return result + +class PurpleSource(Enum): + GITHUB = "github" + LOCAL = "local" + URL = "url" + +class FluffySource(Enum): GITHUB = "github" +class TentacledSource(Enum): + LOCAL = "local" + +class StickySource(Enum): + URL = "url" + +# Experimental: this type is part of an experimental API and may change or be removed. +class InstructionLocation(Enum): + """Which tier this target belongs to + + Where this source lives — used for UI grouping + """ + PLUGIN = "plugin" + REPOSITORY = "repository" + USER = "user" + WORKING_DIRECTORY = "working-directory" + +# Experimental: this type is part of an experimental API and may change or be removed. +class InstructionSourceType(Enum): + """Category of instruction source — used for merge logic""" + + CHILD_INSTRUCTIONS = "child-instructions" + HOME = "home" + MODEL = "model" + NESTED_AGENTS = "nested-agents" + PLUGIN = "plugin" + REPO = "repo" + VSCODE = "vscode" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataRecordContextChangeResult: - """Notify the session that its working directory context has changed. Emits a - `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline - UI) can react. Use this when the host has detected a cwd/branch/repo change outside the - session's normal lifecycle (e.g., after a shell command in interactive mode). +class InstructionsDiscoverRequest: + """Optional project paths to include in instruction discovery.""" + + exclude_host_instructions: bool | None = None + """When true, omit the host's instruction sources (user/home-level files and plugin rules), + leaving only repository and working-directory sources. For multitenant deployments. """ + project_paths: list[str] | None = None + """Optional list of project directory paths to scan for repository/working-directory + instruction sources. When omitted or empty, only user-level and plugin instruction + sources are returned (no project scan). + """ + @staticmethod - def from_dict(obj: Any) -> 'MetadataRecordContextChangeResult': + def from_dict(obj: Any) -> 'InstructionsDiscoverRequest': assert isinstance(obj, dict) - return MetadataRecordContextChangeResult() + exclude_host_instructions = from_union([from_bool, from_none], obj.get("excludeHostInstructions")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + return InstructionsDiscoverRequest(exclude_host_instructions, project_paths) def to_dict(self) -> dict: result: dict = {} + if self.exclude_host_instructions is not None: + result["excludeHostInstructions"] = from_union([from_bool, from_none], self.exclude_host_instructions) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataSetWorkingDirectoryRequest: - """Absolute path to set as the session's new working directory.""" +class InstructionsGetDiscoveryPathsRequest: + """Optional project paths to include when enumerating instruction discovery targets.""" - working_directory: str - """Absolute path to set as the session's working directory. The runtime updates the - session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) - anchor to it. + exclude_host_instructions: bool | None = None + """When true, omit the host's user-level instruction targets, leaving only repository + targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + """ + project_paths: list[str] | None = None + """Optional list of project directory paths. When omitted or empty, only the user-level + targets are returned. """ @staticmethod - def from_dict(obj: Any) -> 'MetadataSetWorkingDirectoryRequest': + def from_dict(obj: Any) -> 'InstructionsGetDiscoveryPathsRequest': assert isinstance(obj, dict) - working_directory = from_str(obj.get("workingDirectory")) - return MetadataSetWorkingDirectoryRequest(working_directory) + exclude_host_instructions = from_union([from_bool, from_none], obj.get("excludeHostInstructions")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + return InstructionsGetDiscoveryPathsRequest(exclude_host_instructions, project_paths) def to_dict(self) -> dict: result: dict = {} - result["workingDirectory"] = from_str(self.working_directory) + if self.exclude_host_instructions is not None: + result["excludeHostInstructions"] = from_union([from_bool, from_none], self.exclude_host_instructions) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataSetWorkingDirectoryResult: - """Update the session's working directory. Used by the host when the user explicitly changes - cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any - related side-effects (file index, etc.); this method only updates the session's own - recorded path. +class InterruptMainTurnRequest: + """Parameters for interrupting the main agent turn.""" + + flush_queued: bool | None = None + """When true, the user's queued prompts are preserved and run as the next turn once the + interrupted turn unwinds; when false (the default), the queue is cleared like a plain + abort. """ - working_directory: str - """Working directory after the update""" @staticmethod - def from_dict(obj: Any) -> 'MetadataSetWorkingDirectoryResult': + def from_dict(obj: Any) -> 'InterruptMainTurnRequest': assert isinstance(obj, dict) - working_directory = from_str(obj.get("workingDirectory")) - return MetadataSetWorkingDirectoryResult(working_directory) + flush_queued = from_union([from_bool, from_none], obj.get("flushQueued")) + return InterruptMainTurnRequest(flush_queued) def to_dict(self) -> dict: result: dict = {} - result["workingDirectory"] = from_str(self.working_directory) + if self.flush_queued is not None: + result["flushQueued"] = from_union([from_bool, from_none], self.flush_queued) return result # Experimental: this type is part of an experimental API and may change or be removed. -class MetadataSnapshotCurrentMode(Enum): - """The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')""" +@dataclass +class InterruptMainTurnResult: + """Result of interrupting the main agent turn.""" - AUTOPILOT = "autopilot" - INTERACTIVE = "interactive" - PLAN = "plan" + interrupted: bool + """Whether an in-flight main agent turn was interrupted. False when the main loop was not + processing. + """ + + @staticmethod + def from_dict(obj: Any) -> 'InterruptMainTurnResult': + assert isinstance(obj, dict) + interrupted = from_bool(obj.get("interrupted")) + return InterruptMainTurnResult(interrupted) + + def to_dict(self) -> dict: + result: dict = {} + result["interrupted"] = from_bool(self.interrupted) + return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataSnapshotRemoteMetadataRepository: - """The repository the remote session targets.""" +class LlmInferenceHTTPRequestChunkRequest: + """A request body chunk or cancellation signal.""" - branch: str - """The branch the remote session is operating on.""" + data: str + """Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when + `binary` is true. May be empty. + """ + request_id: str + """Matches the requestId from the originating httpRequestStart frame.""" - name: str - """The GitHub repository name (without owner).""" + agent_invocation_id: str | None = None + """Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching + the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent + transport can attribute successive turns correctly: when a WebSocket connection is reused + across turns, the httpRequestStart identity reflects only the turn that opened the + connection, so each later turn stamps its own invocation id here. Absent when the runtime + has no invocation context for the request, or on the plain-HTTP transport where every + request has its own httpRequestStart. + """ + binary: bool | None = None + """When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text.""" - owner: str - """The GitHub owner (user or organization) of the target repository.""" + cancel: bool | None = None + """When true, the runtime is cancelling the in-flight request (e.g. upstream consumer + aborted). `data` is ignored. Implies end-of-request. + """ + cancel_reason: str | None = None + """Optional human-readable reason for the cancellation, propagated for logging.""" + + end: bool | None = None + """When true, this is the final body chunk for the request. The SDK may rely on having + received an end-marked chunk before treating the request body as complete. + """ @staticmethod - def from_dict(obj: Any) -> 'MetadataSnapshotRemoteMetadataRepository': + def from_dict(obj: Any) -> 'LlmInferenceHTTPRequestChunkRequest': assert isinstance(obj, dict) - branch = from_str(obj.get("branch")) - name = from_str(obj.get("name")) - owner = from_str(obj.get("owner")) - return MetadataSnapshotRemoteMetadataRepository(branch, name, owner) + data = from_str(obj.get("data")) + request_id = from_str(obj.get("requestId")) + agent_invocation_id = from_union([from_str, from_none], obj.get("agentInvocationId")) + binary = from_union([from_bool, from_none], obj.get("binary")) + cancel = from_union([from_bool, from_none], obj.get("cancel")) + cancel_reason = from_union([from_str, from_none], obj.get("cancelReason")) + end = from_union([from_bool, from_none], obj.get("end")) + return LlmInferenceHTTPRequestChunkRequest(data, request_id, agent_invocation_id, binary, cancel, cancel_reason, end) def to_dict(self) -> dict: result: dict = {} - result["branch"] = from_str(self.branch) - result["name"] = from_str(self.name) - result["owner"] = from_str(self.owner) + result["data"] = from_str(self.data) + result["requestId"] = from_str(self.request_id) + if self.agent_invocation_id is not None: + result["agentInvocationId"] = from_union([from_str, from_none], self.agent_invocation_id) + if self.binary is not None: + result["binary"] = from_union([from_bool, from_none], self.binary) + if self.cancel is not None: + result["cancel"] = from_union([from_bool, from_none], self.cancel) + if self.cancel_reason is not None: + result["cancelReason"] = from_union([from_str, from_none], self.cancel_reason) + if self.end is not None: + result["end"] = from_union([from_bool, from_none], self.end) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class MetadataSnapshotRemoteMetadataTaskType(Enum): - """Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` - invocation. +@dataclass +class LlmInferenceHTTPRequestChunkResult: + """Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as + fire-and-forget. """ - CCA = "cca" - CLI = "cli" + @staticmethod + def from_dict(obj: Any) -> 'LlmInferenceHTTPRequestChunkResult': + assert isinstance(obj, dict) + return LlmInferenceHTTPRequestChunkResult() -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class ModeSetRequest: - """Agent interaction mode to apply to the session.""" + def to_dict(self) -> dict: + result: dict = {} + return result - mode: SessionMode - """The session mode the agent is operating in""" +class LlmInferenceHTTPRequestStartTransport(Enum): + """Transport the runtime would otherwise use for this request. `http` (the default when + absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message + channel where each body chunk maps to one WebSocket message and the `binary` flag + distinguishes text from binary frames. The SDK consumer uses this to decide whether to + service the request with an HTTP client or a WebSocket client. It is the one piece of + request metadata the consumer cannot reliably infer from the URL or headers alone. + """ + HTTP = "http" + WEBSOCKET = "websocket" +@dataclass +class LlmInferenceHTTPRequestStartResult: + """Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it + does not imply the request will succeed. + """ @staticmethod - def from_dict(obj: Any) -> 'ModeSetRequest': + def from_dict(obj: Any) -> 'LlmInferenceHTTPRequestStartResult': assert isinstance(obj, dict) - mode = SessionMode(obj.get("mode")) - return ModeSetRequest(mode) + return LlmInferenceHTTPRequestStartResult() def to_dict(self) -> dict: result: dict = {} - result["mode"] = to_enum(SessionMode, self.mode) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelBillingTokenPricesLongContext: - """Long context tier pricing (available for models with extended context windows)""" +class LlmInferenceHTTPResponseChunkError: + """Set to terminate the response with a transport-level failure. Implies end-of-stream; any + further chunks for this requestId are ignored. + """ + message: str + """Human-readable failure description.""" - cache_price: float | None = None - """AI Credits cost per billing batch of cached tokens""" + code: str | None = None + """Optional machine-readable error code.""" - context_max: int | None = None - """Maximum context window tokens for the long context tier""" + @staticmethod + def from_dict(obj: Any) -> 'LlmInferenceHTTPResponseChunkError': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + code = from_union([from_str, from_none], obj.get("code")) + return LlmInferenceHTTPResponseChunkError(message, code) - input_price: float | None = None - """AI Credits cost per billing batch of input tokens""" + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + if self.code is not None: + result["code"] = from_union([from_str, from_none], self.code) + return result - output_price: float | None = None - """AI Credits cost per billing batch of output tokens""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class LlmInferenceHTTPResponseChunkResult: + """Whether the chunk was accepted.""" + + accepted: bool + """True when the chunk was matched to a pending request; false when unknown.""" @staticmethod - def from_dict(obj: Any) -> 'ModelBillingTokenPricesLongContext': + def from_dict(obj: Any) -> 'LlmInferenceHTTPResponseChunkResult': assert isinstance(obj, dict) - cache_price = from_union([from_float, from_none], obj.get("cachePrice")) - context_max = from_union([from_int, from_none], obj.get("contextMax")) - input_price = from_union([from_float, from_none], obj.get("inputPrice")) - output_price = from_union([from_float, from_none], obj.get("outputPrice")) - return ModelBillingTokenPricesLongContext(cache_price, context_max, input_price, output_price) + accepted = from_bool(obj.get("accepted")) + return LlmInferenceHTTPResponseChunkResult(accepted) def to_dict(self) -> dict: result: dict = {} - if self.cache_price is not None: - result["cachePrice"] = from_union([to_float, from_none], self.cache_price) - if self.context_max is not None: - result["contextMax"] = from_union([from_int, from_none], self.context_max) - if self.input_price is not None: - result["inputPrice"] = from_union([to_float, from_none], self.input_price) - if self.output_price is not None: - result["outputPrice"] = from_union([to_float, from_none], self.output_price) + result["accepted"] = from_bool(self.accepted) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesLimitsVision: - """Vision-specific limits""" +class LlmInferenceHTTPResponseStartRequest: + """Response head.""" - max_prompt_image_size: int - """Maximum image size in bytes""" + headers: dict[str, list[str]] + request_id: str + """Matches the requestId from the originating httpRequestStart frame.""" - max_prompt_images: int - """Maximum number of images per prompt""" + status: int + """HTTP status code.""" - supported_media_types: list[str] - """MIME types the model accepts""" + status_text: str | None = None + """Optional HTTP status reason phrase.""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesLimitsVision': + def from_dict(obj: Any) -> 'LlmInferenceHTTPResponseStartRequest': assert isinstance(obj, dict) - max_prompt_image_size = from_int(obj.get("max_prompt_image_size")) - max_prompt_images = from_int(obj.get("max_prompt_images")) - supported_media_types = from_list(from_str, obj.get("supported_media_types")) - return ModelCapabilitiesLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types) + headers = from_dict(lambda x: from_list(from_str, x), obj.get("headers")) + request_id = from_str(obj.get("requestId")) + status = from_int(obj.get("status")) + status_text = from_union([from_str, from_none], obj.get("statusText")) + return LlmInferenceHTTPResponseStartRequest(headers, request_id, status, status_text) def to_dict(self) -> dict: result: dict = {} - result["max_prompt_image_size"] = from_int(self.max_prompt_image_size) - result["max_prompt_images"] = from_int(self.max_prompt_images) - result["supported_media_types"] = from_list(from_str, self.supported_media_types) + result["headers"] = from_dict(lambda x: from_list(from_str, x), self.headers) + result["requestId"] = from_str(self.request_id) + result["status"] = from_int(self.status) + if self.status_text is not None: + result["statusText"] = from_union([from_str, from_none], self.status_text) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesSupports: - """Feature flags indicating what the model supports""" - - reasoning_effort: bool | None = None - """Whether this model supports reasoning effort configuration""" +class LlmInferenceHTTPResponseStartResult: + """Whether the start frame was accepted.""" - vision: bool | None = None - """Whether this model supports vision/image input""" + accepted: bool + """True when the response start was matched to a pending request; false when unknown.""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesSupports': + def from_dict(obj: Any) -> 'LlmInferenceHTTPResponseStartResult': assert isinstance(obj, dict) - reasoning_effort = from_union([from_bool, from_none], obj.get("reasoningEffort")) - vision = from_union([from_bool, from_none], obj.get("vision")) - return ModelCapabilitiesSupports(reasoning_effort, vision) + accepted = from_bool(obj.get("accepted")) + return LlmInferenceHTTPResponseStartResult(accepted) def to_dict(self) -> dict: result: dict = {} - if self.reasoning_effort is not None: - result["reasoningEffort"] = from_union([from_bool, from_none], self.reasoning_effort) - if self.vision is not None: - result["vision"] = from_union([from_bool, from_none], self.vision) + result["accepted"] = from_bool(self.accepted) return result -class ModelPickerPriceCategory(Enum): - """Relative cost tier for token-based billing users""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class LlmInferenceSetProviderResult: + """Indicates whether the calling client was registered as the LLM inference provider.""" - HIGH = "high" - LOW = "low" - MEDIUM = "medium" - VERY_HIGH = "very_high" + success: bool + """Whether the provider was set successfully""" -class ModelPolicyState(Enum): - """Current policy state for this model""" + @staticmethod + def from_dict(obj: Any) -> 'LlmInferenceSetProviderResult': + assert isinstance(obj, dict) + success = from_bool(obj.get("success")) + return LlmInferenceSetProviderResult(success) - DISABLED = "disabled" - ENABLED = "enabled" - UNCONFIGURED = "unconfigured" + def to_dict(self) -> dict: + result: dict = {} + result["success"] = from_bool(self.success) + return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class ModelCapabilitiesOverrideLimitsVision: - """Vision-specific limits""" - - max_prompt_image_size: int | None = None - """Maximum image size in bytes""" +class HostType(Enum): + """Repository host type - max_prompt_images: int | None = None - """Maximum number of images per prompt""" + Hosting platform type of the repository - supported_media_types: list[str] | None = None - """MIME types the model accepts""" + Repository host type, if known - @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimitsVision': - assert isinstance(obj, dict) - max_prompt_image_size = from_union([from_int, from_none], obj.get("max_prompt_image_size")) - max_prompt_images = from_union([from_int, from_none], obj.get("max_prompt_images")) - supported_media_types = from_union([lambda x: from_list(from_str, x), from_none], obj.get("supported_media_types")) - return ModelCapabilitiesOverrideLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types) + Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + """ + ADO = "ado" + GITHUB = "github" - def to_dict(self) -> dict: - result: dict = {} - if self.max_prompt_image_size is not None: - result["max_prompt_image_size"] = from_union([from_int, from_none], self.max_prompt_image_size) - if self.max_prompt_images is not None: - result["max_prompt_images"] = from_union([from_int, from_none], self.max_prompt_images) - if self.supported_media_types is not None: - result["supported_media_types"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_media_types) - return result +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionLogLevel(Enum): + """Log severity level. Determines how the message is displayed in the timeline. Defaults to + "info". + """ + ERROR = "error" + INFO = "info" + WARNING = "warning" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesOverrideSupports: - """Feature flags indicating what the model supports""" - - reasoning_effort: bool | None = None - """Whether this model supports reasoning effort configuration""" +class LogResult: + """Identifier of the session event that was emitted for the log message.""" - vision: bool | None = None - """Whether this model supports vision/image input""" + event_id: UUID + """The unique identifier of the emitted session event""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideSupports': + def from_dict(obj: Any) -> 'LogResult': assert isinstance(obj, dict) - reasoning_effort = from_union([from_bool, from_none], obj.get("reasoningEffort")) - vision = from_union([from_bool, from_none], obj.get("vision")) - return ModelCapabilitiesOverrideSupports(reasoning_effort, vision) + event_id = UUID(obj.get("eventId")) + return LogResult(event_id) def to_dict(self) -> dict: result: dict = {} - if self.reasoning_effort is not None: - result["reasoningEffort"] = from_union([from_bool, from_none], self.reasoning_effort) - if self.vision is not None: - result["vision"] = from_union([from_bool, from_none], self.vision) + result["eventId"] = str(self.event_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelListRequest: - """Optional listing options.""" +class LspInitializeRequest: + """Parameters for (re)loading the merged LSP configuration set.""" - skip_cache: bool | None = None - """If true, bypasses the per-session model list cache and re-fetches from CAPI.""" + force: bool | None = None + """Force re-initialization even when LSP configs were already loaded for the working + directory. + """ + git_root: str | None = None + """Git root used as the boundary when traversing for project-level LSP configs (supports + monorepos). + """ + working_directory: str | None = None + """Working directory used to load project-level LSP configs. Defaults to the session working + directory when omitted. + """ @staticmethod - def from_dict(obj: Any) -> 'ModelListRequest': + def from_dict(obj: Any) -> 'LspInitializeRequest': assert isinstance(obj, dict) - skip_cache = from_union([from_bool, from_none], obj.get("skipCache")) - return ModelListRequest(skip_cache) + force = from_union([from_bool, from_none], obj.get("force")) + git_root = from_union([from_str, from_none], obj.get("gitRoot")) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + return LspInitializeRequest(force, git_root, working_directory) def to_dict(self) -> dict: result: dict = {} - if self.skip_cache is not None: - result["skipCache"] = from_union([from_bool, from_none], self.skip_cache) + if self.force is not None: + result["force"] = from_union([from_bool, from_none], self.force) + if self.git_root is not None: + result["gitRoot"] = from_union([from_str, from_none], self.git_root) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelSetReasoningEffortRequest: - """Reasoning effort level to apply to the currently selected model.""" +class ManagedSettingsReadResult: + """Validated device-managed settings discovered before a session exists.""" - reasoning_effort: str - """Reasoning effort level to apply to the currently selected model. The host is responsible - for validating the value against the model's supported levels before calling. + error_message: str | None = None + """Discovery or validation error text when managed settings could not be read safely.""" + + settings_json: Any = None + """Validated, canonical managed-settings JSON. Omitted when no managed settings were + discovered or when discovered settings failed validation. """ @staticmethod - def from_dict(obj: Any) -> 'ModelSetReasoningEffortRequest': + def from_dict(obj: Any) -> 'ManagedSettingsReadResult': assert isinstance(obj, dict) - reasoning_effort = from_str(obj.get("reasoningEffort")) - return ModelSetReasoningEffortRequest(reasoning_effort) + error_message = from_union([from_str, from_none], obj.get("errorMessage")) + settings_json = obj.get("settingsJson") + return ManagedSettingsReadResult(error_message, settings_json) def to_dict(self) -> dict: result: dict = {} - result["reasoningEffort"] = from_str(self.reasoning_effort) + if self.error_message is not None: + result["errorMessage"] = from_union([from_str, from_none], self.error_message) + if self.settings_json is not None: + result["settingsJson"] = self.settings_json return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelSetReasoningEffortResult: - """Update the session's reasoning effort without changing the selected model. Use `switchTo` - instead when you also need to change the model. The runtime stores the effort on the - session and applies it to subsequent turns. - """ - reasoning_effort: str - """Reasoning effort level recorded on the session after the update""" +class MarketplaceAddResult: + """Result of registering a new marketplace.""" + + name: str + """Final name of the marketplace as resolved from its manifest""" @staticmethod - def from_dict(obj: Any) -> 'ModelSetReasoningEffortResult': + def from_dict(obj: Any) -> 'MarketplaceAddResult': assert isinstance(obj, dict) - reasoning_effort = from_str(obj.get("reasoningEffort")) - return ModelSetReasoningEffortResult(reasoning_effort) + name = from_str(obj.get("name")) + return MarketplaceAddResult(name) def to_dict(self) -> dict: result: dict = {} - result["reasoningEffort"] = from_str(self.reasoning_effort) + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelSwitchToResult: - """The model identifier active on the session after the switch.""" +class MarketplaceInfo: + """Registered marketplace summary.""" - model_id: str | None = None - """Currently active model identifier after the switch""" + name: str + """Marketplace name (matches the @marketplace suffix in plugin specs)""" + + source: str + """Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: + owner/repo"). + """ + is_default: bool | None = None + """True when this is a default marketplace shipped with the runtime. Defaults are not + removable. + """ @staticmethod - def from_dict(obj: Any) -> 'ModelSwitchToResult': + def from_dict(obj: Any) -> 'MarketplaceInfo': assert isinstance(obj, dict) - model_id = from_union([from_str, from_none], obj.get("modelId")) - return ModelSwitchToResult(model_id) + name = from_str(obj.get("name")) + source = from_str(obj.get("source")) + is_default = from_union([from_bool, from_none], obj.get("isDefault")) + return MarketplaceInfo(name, source, is_default) def to_dict(self) -> dict: result: dict = {} - if self.model_id is not None: - result["modelId"] = from_union([from_str, from_none], self.model_id) + result["name"] = from_str(self.name) + result["source"] = from_str(self.source) + if self.is_default is not None: + result["isDefault"] = from_union([from_bool, from_none], self.is_default) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelsListRequest: - git_hub_token: str | None = None - """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. +class MarketplaceRefreshEntry: + """Per-marketplace refresh result, including marketplace name, success flag, and optional + failure error. """ + name: str + """Marketplace name that was refreshed""" + + success: bool + """Whether the refresh succeeded""" + + error: str | None = None + """Error message (failure only)""" @staticmethod - def from_dict(obj: Any) -> 'ModelsListRequest': + def from_dict(obj: Any) -> 'MarketplaceRefreshEntry': assert isinstance(obj, dict) - git_hub_token = from_union([from_str, from_none], obj.get("gitHubToken")) - return ModelsListRequest(git_hub_token) + name = from_str(obj.get("name")) + success = from_bool(obj.get("success")) + error = from_union([from_str, from_none], obj.get("error")) + return MarketplaceRefreshEntry(name, success, error) def to_dict(self) -> dict: result: dict = {} - if self.git_hub_token is not None: - result["gitHubToken"] = from_union([from_str, from_none], self.git_hub_token) + result["name"] = from_str(self.name) + result["success"] = from_bool(self.success) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class NameGetResult: - """The session's friendly name, or null when not yet set.""" +class MarketplaceRemoveResult: + """Outcome of the remove attempt, including dependent-plugin info when applicable.""" - name: str | None = None - """The session name (user-set or auto-generated), or null if not yet set""" + removed: bool + """True when the marketplace was actually removed. False when removal was skipped because + the marketplace has dependent plugins and `force` was not set. + """ + dependent_plugins: list[str] | None = None + """Names of installed plugins that prevented removal. Populated only when `removed=false`.""" @staticmethod - def from_dict(obj: Any) -> 'NameGetResult': + def from_dict(obj: Any) -> 'MarketplaceRemoveResult': assert isinstance(obj, dict) - name = from_union([from_none, from_str], obj.get("name")) - return NameGetResult(name) + removed = from_bool(obj.get("removed")) + dependent_plugins = from_union([lambda x: from_list(from_str, x), from_none], obj.get("dependentPlugins")) + return MarketplaceRemoveResult(removed, dependent_plugins) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_union([from_none, from_str], self.name) + result["removed"] = from_bool(self.removed) + if self.dependent_plugins is not None: + result["dependentPlugins"] = from_union([lambda x: from_list(from_str, x), from_none], self.dependent_plugins) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class NameSetAutoRequest: - """Auto-generated session summary to apply as the session's name when no user-set name - exists. - """ - summary: str - """Auto-generated session summary. Empty/whitespace-only values are ignored; values are - trimmed before persisting. - """ +class MCPAllowedServer: + """MCP server allowed by policy, with server name and optional PII-free explanatory note.""" + + name: str + """Allowed server name""" + + redacted_note: str | None = None + """PII-free note explaining why the server was allowed""" @staticmethod - def from_dict(obj: Any) -> 'NameSetAutoRequest': + def from_dict(obj: Any) -> 'MCPAllowedServer': assert isinstance(obj, dict) - summary = from_str(obj.get("summary")) - return NameSetAutoRequest(summary) + name = from_str(obj.get("name")) + redacted_note = from_union([from_str, from_none], obj.get("redactedNote")) + return MCPAllowedServer(name, redacted_note) def to_dict(self) -> dict: result: dict = {} - result["summary"] = from_str(self.summary) + result["name"] = from_str(self.name) + if self.redacted_note is not None: + result["redactedNote"] = from_union([from_str, from_none], self.redacted_note) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class NameSetAutoResult: - """Indicates whether the auto-generated summary was applied as the session's name.""" +class MCPAppsDiagnoseCapability: + """Capability negotiation snapshot""" - applied: bool - """Whether the auto-generated summary was persisted. False if the session already has a - user-set name, the summary normalized to empty, or the session does not have a workspace. - """ + advertised: bool + """Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers""" + + feature_flag_enabled: bool + """Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on""" + + session_has_mcp_apps: bool + """Whether the session has the `mcp-apps` capability""" @staticmethod - def from_dict(obj: Any) -> 'NameSetAutoResult': + def from_dict(obj: Any) -> 'MCPAppsDiagnoseCapability': assert isinstance(obj, dict) - applied = from_bool(obj.get("applied")) - return NameSetAutoResult(applied) + advertised = from_bool(obj.get("advertised")) + feature_flag_enabled = from_bool(obj.get("featureFlagEnabled")) + session_has_mcp_apps = from_bool(obj.get("sessionHasMcpApps")) + return MCPAppsDiagnoseCapability(advertised, feature_flag_enabled, session_has_mcp_apps) def to_dict(self) -> dict: result: dict = {} - result["applied"] = from_bool(self.applied) + result["advertised"] = from_bool(self.advertised) + result["featureFlagEnabled"] = from_bool(self.feature_flag_enabled) + result["sessionHasMcpApps"] = from_bool(self.session_has_mcp_apps) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class NameSetRequest: - """New friendly name to apply to the session.""" +class MCPAppsDiagnoseRequest: + """MCP server to diagnose MCP Apps wiring for.""" - name: str - """New session name (1–100 characters, trimmed of leading/trailing whitespace)""" + server_name: str + """MCP server to probe""" @staticmethod - def from_dict(obj: Any) -> 'NameSetRequest': + def from_dict(obj: Any) -> 'MCPAppsDiagnoseRequest': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - return NameSetRequest(name) + server_name = from_str(obj.get("serverName")) + return MCPAppsDiagnoseRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) + result["serverName"] = from_str(self.server_name) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class OptionsUpdateToolFilterPrecedence(Enum): - """Controls how availableTools (allowlist) and excludedTools (denylist) combine when both - are set. - """ - AVAILABLE = "available" - EXCLUDED = "excluded" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PendingPermissionRequest: - """Schema for the `PendingPermissionRequest` type.""" +class MCPAppsDiagnoseServer: + """What the server returned for this session""" - request: PermissionPromptRequest - """The user-facing permission prompt details (commands, write, read, mcp, url, memory, - custom-tool, path, hook) - """ - request_id: str - """Unique identifier for the pending permission request""" + connected: bool + """Whether the named server is currently connected""" + + sample_tool_names: list[str] + """Up to 5 tool names with `_meta.ui` for quick inspection""" + + tool_count: float + """Total tools returned by the server's tools/list""" + + tools_with_ui_meta: float + """Tools whose `_meta.ui` is populated (resourceUri and/or visibility set)""" @staticmethod - def from_dict(obj: Any) -> 'PendingPermissionRequest': + def from_dict(obj: Any) -> 'MCPAppsDiagnoseServer': assert isinstance(obj, dict) - request = PermissionPromptRequest.from_dict(obj.get("request")) - request_id = from_str(obj.get("requestId")) - return PendingPermissionRequest(request, request_id) + connected = from_bool(obj.get("connected")) + sample_tool_names = from_list(from_str, obj.get("sampleToolNames")) + tool_count = from_float(obj.get("toolCount")) + tools_with_ui_meta = from_float(obj.get("toolsWithUiMeta")) + return MCPAppsDiagnoseServer(connected, sample_tool_names, tool_count, tools_with_ui_meta) def to_dict(self) -> dict: result: dict = {} - result["request"] = to_class(PermissionPromptRequest, self.request) - result["requestId"] = from_str(self.request_id) + result["connected"] = from_bool(self.connected) + result["sampleToolNames"] = from_list(from_str, self.sample_tool_names) + result["toolCount"] = to_float(self.tool_count) + result["toolsWithUiMeta"] = to_float(self.tools_with_ui_meta) return result -class ApprovalKind(Enum): - COMMANDS = "commands" - CUSTOM_TOOL = "custom-tool" - EXTENSION_MANAGEMENT = "extension-management" - EXTENSION_PERMISSION_ACCESS = "extension-permission-access" - MCP = "mcp" - MCP_SAMPLING = "mcp-sampling" - MEMORY = "memory" - READ = "read" - WRITE = "write" - -class PermissionDecisionKind(Enum): - APPROVED = "approved" - APPROVED_FOR_LOCATION = "approved-for-location" - APPROVED_FOR_SESSION = "approved-for-session" - APPROVE_FOR_LOCATION = "approve-for-location" - APPROVE_FOR_SESSION = "approve-for-session" - APPROVE_ONCE = "approve-once" - APPROVE_PERMANENTLY = "approve-permanently" - CANCELLED = "cancelled" - DENIED_BY_CONTENT_EXCLUSION_POLICY = "denied-by-content-exclusion-policy" - DENIED_BY_PERMISSION_REQUEST_HOOK = "denied-by-permission-request-hook" - DENIED_BY_RULES = "denied-by-rules" - DENIED_INTERACTIVELY_BY_USER = "denied-interactively-by-user" - DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER = "denied-no-approval-rule-and-could-not-request-from-user" - REJECT = "reject" - USER_NOT_AVAILABLE = "user-not-available" - -class PermissionDecisionApproveForLocationKind(Enum): - APPROVE_FOR_LOCATION = "approve-for-location" - -class PermissionDecisionApproveForLocationApprovalCommandsKind(Enum): - COMMANDS = "commands" - -class PermissionDecisionApproveForLocationApprovalCustomToolKind(Enum): - CUSTOM_TOOL = "custom-tool" - -class PermissionDecisionApproveForLocationApprovalExtensionManagementKind(Enum): - EXTENSION_MANAGEMENT = "extension-management" - -class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind(Enum): - EXTENSION_PERMISSION_ACCESS = "extension-permission-access" - -class PermissionDecisionApproveForLocationApprovalMCPKind(Enum): - MCP = "mcp" - -class PermissionDecisionApproveForLocationApprovalMCPSamplingKind(Enum): - MCP_SAMPLING = "mcp-sampling" - -class PermissionDecisionApproveForLocationApprovalMemoryKind(Enum): - MEMORY = "memory" - -class PermissionDecisionApproveForLocationApprovalReadKind(Enum): - READ = "read" - -class PermissionDecisionApproveForLocationApprovalWriteKind(Enum): - WRITE = "write" - -class PermissionDecisionApproveForSessionKind(Enum): - APPROVE_FOR_SESSION = "approve-for-session" - -class PermissionDecisionApproveOnceKind(Enum): - APPROVE_ONCE = "approve-once" - -class PermissionDecisionApprovePermanentlyKind(Enum): - APPROVE_PERMANENTLY = "approve-permanently" - -class PermissionDecisionApprovedKind(Enum): - APPROVED = "approved" - -class PermissionDecisionApprovedForLocationKind(Enum): - APPROVED_FOR_LOCATION = "approved-for-location" - -class PermissionDecisionApprovedForSessionKind(Enum): - APPROVED_FOR_SESSION = "approved-for-session" - -class PermissionDecisionCancelledKind(Enum): - CANCELLED = "cancelled" - -class PermissionDecisionDeniedByContentExclusionPolicyKind(Enum): - DENIED_BY_CONTENT_EXCLUSION_POLICY = "denied-by-content-exclusion-policy" - -class PermissionDecisionDeniedByPermissionRequestHookKind(Enum): - DENIED_BY_PERMISSION_REQUEST_HOOK = "denied-by-permission-request-hook" +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPAppsDisplayMode(Enum): + """Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. -class PermissionDecisionDeniedByRulesKind(Enum): - DENIED_BY_RULES = "denied-by-rules" + Current display mode (SEP-1865) -class PermissionDecisionDeniedInteractivelyByUserKind(Enum): - DENIED_INTERACTIVELY_BY_USER = "denied-interactively-by-user" + Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. + """ + FULLSCREEN = "fullscreen" + INLINE = "inline" + PIP = "pip" -class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind(Enum): - DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER = "denied-no-approval-rule-and-could-not-request-from-user" +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPAppsHostContextDetailsPlatform(Enum): + """Platform type for responsive design""" -class PermissionDecisionRejectKind(Enum): - REJECT = "reject" + DESKTOP = "desktop" + MOBILE = "mobile" + WEB = "web" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionRequest: - """Pending permission request ID and the decision to apply (approve/reject and scope).""" - - request_id: str - """Request ID of the pending permission request""" +class MCPAppsListToolsRequest: + """MCP server to list app-callable tools for.""" - result: PermissionDecision - """The client's response to the pending permission prompt""" + origin_server_name: str + """**Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the + app from this server only'), the call is rejected when this differs from `serverName`, + and rejected outright when missing. + """ + server_name: str + """MCP server hosting the app""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionRequest': + def from_dict(obj: Any) -> 'MCPAppsListToolsRequest': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - result = _load_PermissionDecision(obj.get("result")) - return PermissionDecisionRequest(request_id, result) + origin_server_name = from_str(obj.get("originServerName")) + server_name = from_str(obj.get("serverName")) + return MCPAppsListToolsRequest(origin_server_name, server_name) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - result["result"] = (self.result).to_dict() + result["originServerName"] = from_str(self.origin_server_name) + result["serverName"] = from_str(self.server_name) return result -class PermissionDecisionUserNotAvailableKind(Enum): - USER_NOT_AVAILABLE = "user-not-available" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionLocationApplyParams: - """Working directory to load persisted location permissions for.""" +class MCPAppsListToolsResult: + """App-callable tools from the named MCP server.""" - working_directory: str - """Working directory whose persisted location permissions should be applied""" + tools: list[dict[str, Any]] + """App-callable tools from the server""" @staticmethod - def from_dict(obj: Any) -> 'PermissionLocationApplyParams': + def from_dict(obj: Any) -> 'MCPAppsListToolsResult': assert isinstance(obj, dict) - working_directory = from_str(obj.get("workingDirectory")) - return PermissionLocationApplyParams(working_directory) + tools = from_list(lambda x: from_dict(lambda x: x, x), obj.get("tools")) + return MCPAppsListToolsResult(tools) def to_dict(self) -> dict: result: dict = {} - result["workingDirectory"] = from_str(self.working_directory) + result["tools"] = from_list(lambda x: from_dict(lambda x: x, x), self.tools) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class PermissionLocationType(Enum): - """Whether the location is a git repo or directory""" - - DIR = "dir" - REPO = "repo" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionLocationResolveParams: - """Working directory to resolve into a location-permissions key.""" +class MCPAppsReadResourceRequest: + """MCP server and resource URI to fetch.""" - working_directory: str - """Working directory whose permission location should be resolved""" + server_name: str + """Name of the MCP server hosting the resource""" + + uri: str + """Resource URI (typically ui://...)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionLocationResolveParams': + def from_dict(obj: Any) -> 'MCPAppsReadResourceRequest': assert isinstance(obj, dict) - working_directory = from_str(obj.get("workingDirectory")) - return PermissionLocationResolveParams(working_directory) + server_name = from_str(obj.get("serverName")) + uri = from_str(obj.get("uri")) + return MCPAppsReadResourceRequest(server_name, uri) def to_dict(self) -> dict: result: dict = {} - result["workingDirectory"] = from_str(self.working_directory) + result["serverName"] = from_str(self.server_name) + result["uri"] = from_str(self.uri) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsAddParams: - """Directory path to add to the session's allowed directories.""" - - path: str - """Directory to add to the allow-list. The runtime resolves and validates the path before - adding. +class MCPAppsResourceContent: + """MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource + metadata. """ + uri: str + """The resource URI (typically ui://...)""" - @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsAddParams': - assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return PermissionPathsAddParams(path) + meta: dict[str, Any] | None = None + """Resource-level metadata (CSP, permissions, etc.)""" - def to_dict(self) -> dict: - result: dict = {} - result["path"] = from_str(self.path) - return result + blob: str | None = None + """Base64-encoded binary content""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionPathsAllowedCheckParams: - """Path to evaluate against the session's allowed directories.""" + mime_type: str | None = None + """MIME type of the content""" - path: str - """Path to check against the session's allowed directories""" + text: str | None = None + """Text content (e.g. HTML)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsAllowedCheckParams': + def from_dict(obj: Any) -> 'MCPAppsResourceContent': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return PermissionPathsAllowedCheckParams(path) + uri = from_str(obj.get("uri")) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) + blob = from_union([from_str, from_none], obj.get("blob")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + text = from_union([from_str, from_none], obj.get("text")) + return MCPAppsResourceContent(uri, meta, blob, mime_type, text) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + result["uri"] = from_str(self.uri) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) + if self.blob is not None: + result["blob"] = from_union([from_str, from_none], self.blob) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.text is not None: + result["text"] = from_union([from_str, from_none], self.text) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsAllowedCheckResult: - """Indicates whether the supplied path is within the session's allowed directories.""" +class MCPCancelSamplingExecutionParams: + """The requestId previously passed to executeSampling that should be cancelled.""" - allowed: bool - """Whether the path is within the session's allowed directories""" + request_id: str + """The requestId previously passed to executeSampling that should be cancelled""" @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsAllowedCheckResult': + def from_dict(obj: Any) -> 'MCPCancelSamplingExecutionParams': assert isinstance(obj, dict) - allowed = from_bool(obj.get("allowed")) - return PermissionPathsAllowedCheckResult(allowed) + request_id = from_str(obj.get("requestId")) + return MCPCancelSamplingExecutionParams(request_id) def to_dict(self) -> dict: result: dict = {} - result["allowed"] = from_bool(self.allowed) + result["requestId"] = from_str(self.request_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsList: - """Snapshot of the session's allow-listed directories and primary working directory.""" +class MCPCancelSamplingExecutionResult: + """Indicates whether an in-flight sampling execution with the given requestId was found and + cancelled. + """ + cancelled: bool + """True if an in-flight execution with the given requestId was found and signalled to + cancel. False when no such execution is in flight (already completed, never started, or + cancelled by another caller). + """ - directories: list[str] - """All directories currently allowed for tool access on this session.""" + @staticmethod + def from_dict(obj: Any) -> 'MCPCancelSamplingExecutionResult': + assert isinstance(obj, dict) + cancelled = from_bool(obj.get("cancelled")) + return MCPCancelSamplingExecutionResult(cancelled) - primary: str - """The primary working directory for this session.""" + def to_dict(self) -> dict: + result: dict = {} + result["cancelled"] = from_bool(self.cancelled) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerAuthConfigRedirectPort: + """Authentication settings with optional redirect port configuration.""" + + redirect_port: int | None = None + """Fixed port for the OAuth redirect callback server.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsList': + def from_dict(obj: Any) -> 'MCPServerAuthConfigRedirectPort': assert isinstance(obj, dict) - directories = from_list(from_str, obj.get("directories")) - primary = from_str(obj.get("primary")) - return PermissionPathsList(directories, primary) + redirect_port = from_union([from_int, from_none], obj.get("redirectPort")) + return MCPServerAuthConfigRedirectPort(redirect_port) def to_dict(self) -> dict: result: dict = {} - result["directories"] = from_list(from_str, self.directories) - result["primary"] = from_str(self.primary) + if self.redirect_port is not None: + result["redirectPort"] = from_union([from_int, from_none], self.redirect_port) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerConfigDeferTools(Enum): + """Controls if tools provided by this server can be loaded on demand via tool search (auto) + or always included in the initial tool list (never) + """ + AUTO = "auto" + NEVER = "never" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPGrantType(Enum): + """OAuth grant type to use when authenticating to the remote MCP server. + + OAuth grant type override for this login. + + Optional OAuth grant type override for this login. Defaults to the server configuration, + or authorization_code when no grant type is specified. + """ + AUTHORIZATION_CODE = "authorization_code" + CLIENT_CREDENTIALS = "client_credentials" + +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPServerConfigHTTPType(Enum): + """Remote transport type. Defaults to "http" when omitted.""" + + HTTP = "http" + SSE = "sse" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsUpdatePrimaryParams: - """Directory path to set as the session's new primary working directory.""" +class MCPConfigDisableRequest: + """MCP server names to disable for new sessions.""" - path: str - """Directory to set as the new primary working directory for the session's permission policy.""" + names: list[str] + """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. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsUpdatePrimaryParams': + def from_dict(obj: Any) -> 'MCPConfigDisableRequest': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return PermissionPathsUpdatePrimaryParams(path) + names = from_list(from_str, obj.get("names")) + return MCPConfigDisableRequest(names) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + result["names"] = from_list(from_str, self.names) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsWorkspaceCheckParams: - """Path to evaluate against the session's workspace (primary) directory.""" +class MCPConfigEnableRequest: + """MCP server names to enable for new sessions.""" - path: str - """Path to check against the session workspace directory""" + names: list[str] + """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. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsWorkspaceCheckParams': + def from_dict(obj: Any) -> 'MCPConfigEnableRequest': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return PermissionPathsWorkspaceCheckParams(path) + names = from_list(from_str, obj.get("names")) + return MCPConfigEnableRequest(names) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + result["names"] = from_list(from_str, self.names) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionPathsWorkspaceCheckResult: - """Indicates whether the supplied path is within the session's workspace directory.""" +class MCPConfigRemoveRequest: + """MCP server name to remove from user configuration.""" - allowed: bool - """Whether the path is within the session workspace directory""" + name: str + """Name of the MCP server to remove""" @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsWorkspaceCheckResult': + def from_dict(obj: Any) -> 'MCPConfigRemoveRequest': assert isinstance(obj, dict) - allowed = from_bool(obj.get("allowed")) - return PermissionPathsWorkspaceCheckResult(allowed) + name = from_str(obj.get("name")) + return MCPConfigRemoveRequest(name) def to_dict(self) -> dict: result: dict = {} - result["allowed"] = from_bool(self.allowed) + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. @dataclass -class PermissionPromptShownNotification: - """Notification payload describing the permission prompt that the client just rendered.""" +class MCPConfigureGitHubRequest: + """Opaque auth info used to configure GitHub MCP.""" - message: str - """Human-readable description of the prompt the user is being asked to approve. Used by the - runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, - desktop notification). + auth_info: Any = None + """Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process + runtime shape (configureGitHubMcp is a no-op over the wire). """ @staticmethod - def from_dict(obj: Any) -> 'PermissionPromptShownNotification': + def from_dict(obj: Any) -> 'MCPConfigureGitHubRequest': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - return PermissionPromptShownNotification(message) + auth_info = obj.get("authInfo") + return MCPConfigureGitHubRequest(auth_info) def to_dict(self) -> dict: result: dict = {} - result["message"] = from_str(self.message) + result["authInfo"] = self.auth_info return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionRequestResult: - """Indicates whether the permission decision was applied; false when the request was already - resolved. - """ - success: bool - """Whether the permission request was handled successfully""" +class MCPConfigureGitHubResult: + """Result of configuring GitHub MCP.""" + + changed: bool + """Whether GitHub MCP configuration changed.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionRequestResult': + def from_dict(obj: Any) -> 'MCPConfigureGitHubResult': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionRequestResult(success) + changed = from_bool(obj.get("changed")) + return MCPConfigureGitHubResult(changed) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["changed"] = from_bool(self.changed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionRulesSet: - """If specified, replaces the session's approved/denied permission rules. Omit to leave the - current rules unchanged. - """ - approved: list[PermissionRule] - """Rules that auto-approve matching requests""" +class MCPDisableRequest: + """Name of the MCP server to disable for the session.""" - denied: list[PermissionRule] - """Rules that auto-deny matching requests""" + server_name: str + """Name of the MCP server to disable""" @staticmethod - def from_dict(obj: Any) -> 'PermissionRulesSet': + def from_dict(obj: Any) -> 'MCPDisableRequest': assert isinstance(obj, dict) - approved = from_list(PermissionRule.from_dict, obj.get("approved")) - denied = from_list(PermissionRule.from_dict, obj.get("denied")) - return PermissionRulesSet(approved, denied) + server_name = from_str(obj.get("serverName")) + return MCPDisableRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["approved"] = from_list(lambda x: to_class(PermissionRule, x), self.approved) - result["denied"] = from_list(lambda x: to_class(PermissionRule, x), self.denied) + result["serverName"] = from_str(self.server_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionUrlsConfig: - """If specified, replaces the session's URL-permission policy. The runtime constructs a - fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy - unchanged. - """ - initial_allowed: list[str] | None = None - """Initial list of allowed URL/domain patterns. Patterns may include path components. - Ignored when `unrestricted` is true. - """ - unrestricted: bool | None = None - """If true, the runtime allows access to all URLs without prompting. Initial allow-list is - ignored when this is true. - """ +class MCPDiscoverRequest: + """Optional working directory used as context for MCP server discovery.""" + + working_directory: str | None = None + """Working directory used as context for discovery (e.g., plugin resolution)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionUrlsConfig': + def from_dict(obj: Any) -> 'MCPDiscoverRequest': assert isinstance(obj, dict) - initial_allowed = from_union([lambda x: from_list(from_str, x), from_none], obj.get("initialAllowed")) - unrestricted = from_union([from_bool, from_none], obj.get("unrestricted")) - return PermissionUrlsConfig(initial_allowed, unrestricted) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + return MCPDiscoverRequest(working_directory) def to_dict(self) -> dict: result: dict = {} - if self.initial_allowed is not None: - result["initialAllowed"] = from_union([lambda x: from_list(from_str, x), from_none], self.initial_allowed) - if self.unrestricted is not None: - result["unrestricted"] = from_union([from_bool, from_none], self.unrestricted) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionUrlsSetUnrestrictedModeParams: - """Whether the URL-permission policy should run in unrestricted mode.""" +class MCPEnableRequest: + """Name of the MCP server to enable for the session.""" - enabled: bool - """Whether to allow access to all URLs without prompting. Toggles the runtime's - URL-permission policy in place. - """ + server_name: str + """Name of the MCP server to enable""" @staticmethod - def from_dict(obj: Any) -> 'PermissionUrlsSetUnrestrictedModeParams': + def from_dict(obj: Any) -> 'MCPEnableRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - return PermissionUrlsSetUnrestrictedModeParams(enabled) + server_name = from_str(obj.get("serverName")) + return MCPEnableRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) + result["serverName"] = from_str(self.server_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsConfigureAdditionalContentExclusionPolicyRuleSource: - """Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type.""" +class MCPFilteredServer: + """MCP server filtered by policy, with name, reason, and optional redacted reason.""" name: str - type: str + """Filtered server name""" + + reason: str + """Human-readable filter reason""" + + enterprise_name: str | None = None + """Deprecated. This field is no longer populated.""" + + redacted_reason: str | None = None + """PII-free filter reason""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRuleSource': + def from_dict(obj: Any) -> 'MCPFilteredServer': assert isinstance(obj, dict) name = from_str(obj.get("name")) - type = from_str(obj.get("type")) - return PermissionsConfigureAdditionalContentExclusionPolicyRuleSource(name, type) + reason = from_str(obj.get("reason")) + enterprise_name = from_union([from_str, from_none], obj.get("enterpriseName")) + redacted_reason = from_union([from_str, from_none], obj.get("redactedReason")) + return MCPFilteredServer(name, reason, enterprise_name, redacted_reason) def to_dict(self) -> dict: result: dict = {} result["name"] = from_str(self.name) - result["type"] = from_str(self.type) + result["reason"] = from_str(self.reason) + if self.enterprise_name is not None: + result["enterpriseName"] = from_union([from_str, from_none], self.enterprise_name) + if self.redacted_reason is not None: + result["redactedReason"] = from_union([from_str, from_none], self.redacted_reason) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class PermissionsConfigureAdditionalContentExclusionPolicyScope(Enum): - """Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` - enumeration. - """ - ALL = "all" - REPO = "repo" +class MCPHeadersHandlePendingHeadersRefreshRequestKind(Enum): + HEADERS = "headers" + NONE = "none" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsConfigureResult: - """Indicates whether the operation succeeded.""" +class MCPHeadersHandlePendingHeadersRefreshRequestResult: + """Indicates whether the pending MCP headers refresh response was accepted.""" success: bool - """Whether the operation succeeded""" + """Whether the response was accepted. False if the request was unknown, timed out, or + already resolved. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsConfigureResult': + def from_dict(obj: Any) -> 'MCPHeadersHandlePendingHeadersRefreshRequestResult': assert isinstance(obj, dict) success = from_bool(obj.get("success")) - return PermissionsConfigureResult(success) + return MCPHeadersHandlePendingHeadersRefreshRequestResult(success) def to_dict(self) -> dict: result: dict = {} @@ -3389,146 +4577,159 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsFolderTrustAddTrustedResult: - """Indicates whether the operation succeeded.""" - - success: bool - """Whether the operation succeeded""" +class MCPServerFailureInfo: + """Recorded MCP server connection failure.""" - @staticmethod - def from_dict(obj: Any) -> 'PermissionsFolderTrustAddTrustedResult': - assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsFolderTrustAddTrustedResult(success) + message: str + """Failure message produced when the MCP server connection failed.""" - def to_dict(self) -> dict: - result: dict = {} - result["success"] = from_bool(self.success) - return result + timestamp: int + """epoch-ms timestamp at which the failure was recorded.""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionsGetAllowAllRequest: - """No parameters.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsGetAllowAllRequest': + def from_dict(obj: Any) -> 'MCPServerFailureInfo': assert isinstance(obj, dict) - return PermissionsGetAllowAllRequest() + message = from_str(obj.get("message")) + timestamp = from_int(obj.get("timestamp")) + return MCPServerFailureInfo(message, timestamp) def to_dict(self) -> dict: result: dict = {} + result["message"] = from_str(self.message) + result["timestamp"] = from_int(self.timestamp) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalResult: - """Indicates whether the operation succeeded.""" +class MCPServerNeedsAuthInfo: + """Recorded MCP server pending-auth state.""" - success: bool - """Whether the operation succeeded""" + timestamp: int + """epoch-ms timestamp at which the server signalled it needs authentication.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalResult': + def from_dict(obj: Any) -> 'MCPServerNeedsAuthInfo': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsLocationsAddToolApprovalResult(success) + timestamp = from_int(obj.get("timestamp")) + return MCPServerNeedsAuthInfo(timestamp) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["timestamp"] = from_int(self.timestamp) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class PermissionsModifyRulesScope(Enum): - """Whether the change applies to ephemeral session-scoped rules (cleared at session end) or - to location-scoped rules persisted via the location-permissions config file. - """ - LOCATION = "location" - SESSION = "session" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsModifyRulesResult: - """Indicates whether the operation succeeded.""" +class MCPIsServerRunningRequest: + """Server name to check running status for.""" - success: bool - """Whether the operation succeeded""" + server_name: str + """Name of the MCP server to check""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsModifyRulesResult': + def from_dict(obj: Any) -> 'MCPIsServerRunningRequest': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsModifyRulesResult(success) + server_name = from_str(obj.get("serverName")) + return MCPIsServerRunningRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["serverName"] = from_str(self.server_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsNotifyPromptShownResult: - """Indicates whether the operation succeeded.""" +class MCPIsServerRunningResult: + """Whether the named MCP server is running.""" - success: bool - """Whether the operation succeeded""" + running: bool + """True if the server has an active client and transport.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsNotifyPromptShownResult': + def from_dict(obj: Any) -> 'MCPIsServerRunningResult': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsNotifyPromptShownResult(success) + running = from_bool(obj.get("running")) + return MCPIsServerRunningResult(running) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["running"] = from_bool(self.running) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsPathsAddResult: - """Indicates whether the operation succeeded.""" +class MCPListToolsRequest: + """Server name whose tool list should be returned.""" - success: bool - """Whether the operation succeeded""" + server_name: str + """Name of the connected MCP server whose tools to list.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsPathsAddResult': + def from_dict(obj: Any) -> 'MCPListToolsRequest': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsPathsAddResult(success) + server_name = from_str(obj.get("serverName")) + return MCPListToolsRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["serverName"] = from_str(self.server_name) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPToolUIVisibility(Enum): + """Consumer allowed to call an MCP tool.""" + + APP = "app" + MODEL = "model" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsPathsListRequest: - """No parameters; returns the session's allow-listed directories.""" +class MCPOauthAuthenticationStateChangedRequest: + """Identifies the MCP server whose persisted OAuth credentials were updated.""" + + refresh_session_token: bool | None = None + """Whether the target session must mint a session-scoped access token instead of reusing a + shared access token persisted by another session. + """ + server_name: str | None = None + """Name of the MCP server whose OAuth credentials were updated. Omit only when the host + cannot identify the server. + """ + @staticmethod - def from_dict(obj: Any) -> 'PermissionsPathsListRequest': + def from_dict(obj: Any) -> 'MCPOauthAuthenticationStateChangedRequest': assert isinstance(obj, dict) - return PermissionsPathsListRequest() + refresh_session_token = from_union([from_bool, from_none], obj.get("refreshSessionToken")) + server_name = from_union([from_str, from_none], obj.get("serverName")) + return MCPOauthAuthenticationStateChangedRequest(refresh_session_token, server_name) def to_dict(self) -> dict: result: dict = {} + if self.refresh_session_token is not None: + result["refreshSessionToken"] = from_union([from_bool, from_none], self.refresh_session_token) + if self.server_name is not None: + result["serverName"] = from_union([from_str, from_none], self.server_name) return result +class MCPOauthPendingRequestResponseKind(Enum): + CANCELLED = "cancelled" + TOKEN = "token" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsPathsUpdatePrimaryResult: - """Indicates whether the operation succeeded.""" +class MCPOauthHandlePendingResult: + """Indicates whether the pending MCP OAuth response was accepted.""" success: bool - """Whether the operation succeeded""" + """Whether the response was accepted. False if the request was unknown, timed out, or + already resolved. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsPathsUpdatePrimaryResult': + def from_dict(obj: Any) -> 'MCPOauthHandlePendingResult': assert isinstance(obj, dict) success = from_bool(obj.get("success")) - return PermissionsPathsUpdatePrimaryResult(success) + return MCPOauthHandlePendingResult(success) def to_dict(self) -> dict: result: dict = {} @@ -3537,43 +4738,64 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsPendingRequestsRequest: - """No parameters; returns currently-pending permission requests for the session.""" +class MCPOauthLoginResult: + """OAuth authorization URL the caller should open, or empty when cached tokens already + authenticated the server. + """ + authorization_url: str | None = None + """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. + """ + @staticmethod - def from_dict(obj: Any) -> 'PermissionsPendingRequestsRequest': + def from_dict(obj: Any) -> 'MCPOauthLoginResult': assert isinstance(obj, dict) - return PermissionsPendingRequestsRequest() + authorization_url = from_union([from_str, from_none], obj.get("authorizationUrl")) + return MCPOauthLoginResult(authorization_url) def to_dict(self) -> dict: result: dict = {} + if self.authorization_url is not None: + result["authorizationUrl"] = from_union([from_str, from_none], self.authorization_url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsResetSessionApprovalsRequest: - """No parameters; clears all session-scoped tool permission approvals.""" +class MCPOauthRespondRequest: + """Pending MCP OAuth request id to respond to.""" + + request_id: str + """OAuth request identifier from the mcp.oauth_required event""" + @staticmethod - def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsRequest': + def from_dict(obj: Any) -> 'MCPOauthRespondRequest': assert isinstance(obj, dict) - return PermissionsResetSessionApprovalsRequest() + request_id = from_str(obj.get("requestId")) + return MCPOauthRespondRequest(request_id) def to_dict(self) -> dict: result: dict = {} + result["requestId"] = from_str(self.request_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsResetSessionApprovalsResult: - """Indicates whether the operation succeeded.""" +class MCPOauthRespondResult: + """Indicates whether the pending MCP OAuth response was accepted.""" success: bool - """Whether the operation succeeded""" + """Whether the response was accepted. False if the request was unknown, timed out, or + already resolved. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsResult': + def from_dict(obj: Any) -> 'MCPOauthRespondResult': assert isinstance(obj, dict) success = from_bool(obj.get("success")) - return PermissionsResetSessionApprovalsResult(success) + return MCPOauthRespondResult(success) def to_dict(self) -> dict: result: dict = {} @@ -3581,1338 +4803,1497 @@ def to_dict(self) -> dict: return result # Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. @dataclass -class PermissionsSetApproveAllResult: - """Indicates whether the operation succeeded.""" +class MCPReloadWithConfigRequest: + """Opaque MCP reload configuration.""" - success: bool - """Whether the operation succeeded""" + config: Any = None + """Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape + (reloadMcpServers throws over the wire). + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetApproveAllResult': + def from_dict(obj: Any) -> 'MCPReloadWithConfigRequest': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsSetApproveAllResult(success) + config = obj.get("config") + return MCPReloadWithConfigRequest(config) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["config"] = self.config return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsSetRequiredRequest: - """Toggles whether permission prompts should be bridged into session events for this client.""" - - required: bool - """Whether the client wants `permission.requested` events bridged from the session-owned - permission service. CLI clients that render prompt UI set this to `true` for as long as - their listener is mounted; headless callers leave it unset (the default is `false`). +class MCPRemoveGitHubResult: + """Indicates whether the auto-managed `github` MCP server was removed (false when nothing to + remove). + """ + removed: bool + """True when the auto-managed `github` MCP server was removed; false when no removal + happened (e.g. user has explicitly configured a `github` server, or the server was not + registered). """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetRequiredRequest': + def from_dict(obj: Any) -> 'MCPRemoveGitHubResult': assert isinstance(obj, dict) - required = from_bool(obj.get("required")) - return PermissionsSetRequiredRequest(required) + removed = from_bool(obj.get("removed")) + return MCPRemoveGitHubResult(removed) def to_dict(self) -> dict: result: dict = {} - result["required"] = from_bool(self.required) + result["removed"] = from_bool(self.removed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsSetRequiredResult: - """Indicates whether the operation succeeded.""" +class MCPResourceContent: + """MCP resource content with URI, optional MIME type, text or base64 blob, and resource + metadata. + """ + uri: str + """The resource URI""" - success: bool - """Whether the operation succeeded""" + meta: dict[str, Any] | None = None + """Resource-level metadata (CSP, permissions, etc.)""" + + blob: str | None = None + """Base64-encoded binary content""" + + mime_type: str | None = None + """MIME type of the content""" + + text: str | None = None + """Text content (e.g. HTML)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetRequiredResult': + def from_dict(obj: Any) -> 'MCPResourceContent': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsSetRequiredResult(success) + uri = from_str(obj.get("uri")) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) + blob = from_union([from_str, from_none], obj.get("blob")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + text = from_union([from_str, from_none], obj.get("text")) + return MCPResourceContent(uri, meta, blob, mime_type, text) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["uri"] = from_str(self.uri) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) + if self.blob is not None: + result["blob"] = from_union([from_str, from_none], self.blob) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.text is not None: + result["text"] = from_union([from_str, from_none], self.text) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsUrlsSetUnrestrictedModeResult: - """Indicates whether the operation succeeded.""" +class MCPResourcesListRequest: + """MCP server whose resources to enumerate.""" - success: bool - """Whether the operation succeeded""" + server_name: str + """Name of the MCP server whose resources to enumerate""" + + cursor: str | None = None + """Opaque MCP pagination cursor from a prior `nextCursor` value""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsUrlsSetUnrestrictedModeResult': + def from_dict(obj: Any) -> 'MCPResourcesListRequest': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return PermissionsUrlsSetUnrestrictedModeResult(success) + server_name = from_str(obj.get("serverName")) + cursor = from_union([from_str, from_none], obj.get("cursor")) + return MCPResourcesListRequest(server_name, cursor) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["serverName"] = from_str(self.server_name) + if self.cursor is not None: + result["cursor"] = from_union([from_str, from_none], self.cursor) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PingRequest: - """Optional message to echo back to the caller.""" +class MCPResourcesListTemplatesRequest: + """MCP server whose resource templates to enumerate.""" - message: str | None = None - """Optional message to echo back""" + server_name: str + """Name of the MCP server whose resource templates to enumerate""" + + cursor: str | None = None + """Opaque MCP pagination cursor from a prior `nextCursor` value""" @staticmethod - def from_dict(obj: Any) -> 'PingRequest': + def from_dict(obj: Any) -> 'MCPResourcesListTemplatesRequest': assert isinstance(obj, dict) - message = from_union([from_str, from_none], obj.get("message")) - return PingRequest(message) + server_name = from_str(obj.get("serverName")) + cursor = from_union([from_str, from_none], obj.get("cursor")) + return MCPResourcesListTemplatesRequest(server_name, cursor) def to_dict(self) -> dict: result: dict = {} - if self.message is not None: - result["message"] = from_union([from_str, from_none], self.message) + result["serverName"] = from_str(self.server_name) + if self.cursor is not None: + result["cursor"] = from_union([from_str, from_none], self.cursor) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PingResult: - """Server liveness response, including the echoed message, current server timestamp, and - protocol version. - """ - message: str - """Echoed message (or default greeting)""" +class MCPResourcesReadRequest: + """MCP server and resource URI to fetch.""" - protocol_version: int - """Server protocol version number""" + server_name: str + """Name of the MCP server hosting the resource""" - timestamp: datetime - """ISO 8601 timestamp when the server handled the ping""" + uri: str + """Resource URI""" @staticmethod - def from_dict(obj: Any) -> 'PingResult': + def from_dict(obj: Any) -> 'MCPResourcesReadRequest': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - protocol_version = from_int(obj.get("protocolVersion")) - timestamp = from_datetime(obj.get("timestamp")) - return PingResult(message, protocol_version, timestamp) + server_name = from_str(obj.get("serverName")) + uri = from_str(obj.get("uri")) + return MCPResourcesReadRequest(server_name, uri) def to_dict(self) -> dict: result: dict = {} - result["message"] = from_str(self.message) - result["protocolVersion"] = from_int(self.protocol_version) - result["timestamp"] = self.timestamp.isoformat() + result["serverName"] = from_str(self.server_name) + result["uri"] = from_str(self.uri) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PlanReadResult: - """Existence, contents, and resolved path of the session plan file.""" +class MCPSamplingExecutionAction(Enum): + """Outcome of the sampling inference. 'success' produced a response; 'failure' encountered + an error (including agent-side rejection by content filter or criteria); 'cancelled' the + caller cancelled this execution via cancelSamplingExecution. + """ + CANCELLED = "cancelled" + FAILURE = "failure" + SUCCESS = "success" - exists: bool - """Whether the plan file exists in the workspace""" +# Experimental: this type is part of an experimental API and may change or be removed. +class MCPSetEnvValueModeDetails(Enum): + """How environment-variable values supplied to MCP servers are resolved. "direct" passes + literal string values; "indirect" treats values as references (e.g. names of environment + variables on the host) that the runtime resolves before launch. Defaults to the runtime's + startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI + prompt mode and ACP) set this to "direct". - content: str | None = None - """The content of the plan file, or null if it does not exist""" + Mode recorded on the session after the update - path: str | None = None - """Absolute file path of the plan file, or null if workspace is not enabled""" + How env values are passed to MCP servers (`direct` inlines literal values; `indirect` + resolves at launch). + + How MCP server environment values are interpreted. + """ + DIRECT = "direct" + INDIRECT = "indirect" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPStopServerRequest: + """Server name for an individual MCP server stop.""" + + server_name: str + """Name of the MCP server to stop""" @staticmethod - def from_dict(obj: Any) -> 'PlanReadResult': + def from_dict(obj: Any) -> 'MCPStopServerRequest': assert isinstance(obj, dict) - exists = from_bool(obj.get("exists")) - content = from_union([from_none, from_str], obj.get("content")) - path = from_union([from_none, from_str], obj.get("path")) - return PlanReadResult(exists, content, path) + server_name = from_str(obj.get("serverName")) + return MCPStopServerRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["exists"] = from_bool(self.exists) - result["content"] = from_union([from_none, from_str], self.content) - result["path"] = from_union([from_none, from_str], self.path) + result["serverName"] = from_str(self.server_name) return result # Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. @dataclass -class PlanUpdateRequest: - """Replacement contents to write to the session plan file.""" +class MCPUnregisterExternalClientRequest: + """Server name identifying the external client to remove.""" - content: str - """The new content for the plan file""" + server_name: str + """Server name of the external client to unregister""" @staticmethod - def from_dict(obj: Any) -> 'PlanUpdateRequest': + def from_dict(obj: Any) -> 'MCPUnregisterExternalClientRequest': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - return PlanUpdateRequest(content) + server_name = from_str(obj.get("serverName")) + return MCPUnregisterExternalClientRequest(server_name) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) + result["serverName"] = from_str(self.server_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Plugin: - """Schema for the `Plugin` type.""" +class MemoryConfiguration: + """Memory configuration for this session.""" enabled: bool - """Whether the plugin is currently enabled""" - - marketplace: str - """Marketplace the plugin came from""" - - name: str - """Plugin name""" - - version: str | None = None - """Installed version""" + """Whether memory is enabled for the session.""" @staticmethod - def from_dict(obj: Any) -> 'Plugin': + def from_dict(obj: Any) -> 'MemoryConfiguration': assert isinstance(obj, dict) enabled = from_bool(obj.get("enabled")) - marketplace = from_str(obj.get("marketplace")) - name = from_str(obj.get("name")) - version = from_union([from_str, from_none], obj.get("version")) - return Plugin(enabled, marketplace, name, version) + return MemoryConfiguration(enabled) def to_dict(self) -> dict: result: dict = {} result["enabled"] = from_bool(self.enabled) - result["marketplace"] = from_str(self.marketplace) - result["name"] = from_str(self.name) - if self.version is not None: - result["version"] = from_union([from_str, from_none], self.version) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class QueuePendingItemsKind(Enum): - """Whether this item is a queued user message or a queued slash command / model change""" +@dataclass +class Categories: + """The six normalized `/context` header buckets, computed from the same tokenization as + `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` + describe window capacity rather than occupied context, so the values do not sum to + `totalTokens`. + """ + buffer: int + """Output reserve plus post-blocking-threshold buffer.""" - COMMAND = "command" - MESSAGE = "message" + custom_instructions: int + """Custom-instructions tokens (0 when none are configured).""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class QueueRemoveMostRecentResult: - """Indicates whether a user-facing pending item was removed.""" + free_space: int + """Remaining unused window capacity (clamped at 0).""" - removed: bool - """True if a user-facing pending item was removed (LIFO across both queues); false when no - removable items remained. - """ + mcp_tools: int + """MCP tool-definition tokens.""" + + messages: int + """Conversation (user/assistant/tool) message tokens.""" + + system_prompt: int + """System prompt tokens, excluding custom instructions.""" + + system_tools: int + """Non-MCP tool-definition tokens.""" @staticmethod - def from_dict(obj: Any) -> 'QueueRemoveMostRecentResult': + def from_dict(obj: Any) -> 'Categories': assert isinstance(obj, dict) - removed = from_bool(obj.get("removed")) - return QueueRemoveMostRecentResult(removed) + buffer = from_int(obj.get("buffer")) + custom_instructions = from_int(obj.get("customInstructions")) + free_space = from_int(obj.get("freeSpace")) + mcp_tools = from_int(obj.get("mcpTools")) + messages = from_int(obj.get("messages")) + system_prompt = from_int(obj.get("systemPrompt")) + system_tools = from_int(obj.get("systemTools")) + return Categories(buffer, custom_instructions, free_space, mcp_tools, messages, system_prompt, system_tools) def to_dict(self) -> dict: result: dict = {} - result["removed"] = from_bool(self.removed) + result["buffer"] = from_int(self.buffer) + result["customInstructions"] = from_int(self.custom_instructions) + result["freeSpace"] = from_int(self.free_space) + result["mcpTools"] = from_int(self.mcp_tools) + result["messages"] = from_int(self.messages) + result["systemPrompt"] = from_int(self.system_prompt) + result["systemTools"] = from_int(self.system_tools) return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class QueuedCommandHandled: - """Schema for the `QueuedCommandHandled` type.""" +class Compactions: + """Successful compaction history for the session.""" - handled: ClassVar[str] = "true" - """The host actually executed the queued command.""" - - stop_processing_queue: bool | None = None - """When true, the runtime will not process subsequent queued commands until a new request - comes in. - """ + count: int + """Number of successful compactions in this session.""" @staticmethod - def from_dict(obj: Any) -> 'QueuedCommandHandled': + def from_dict(obj: Any) -> 'Compactions': assert isinstance(obj, dict) - stop_processing_queue = from_union([from_bool, from_none], obj.get("stopProcessingQueue")) - return QueuedCommandHandled(stop_processing_queue) + count = from_int(obj.get("count")) + return Compactions(count) def to_dict(self) -> dict: result: dict = {} - result["handled"] = self.handled - if self.stop_processing_queue is not None: - result["stopProcessingQueue"] = from_union([from_bool, from_none], self.stop_processing_queue) + result["count"] = from_int(self.count) return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class QueuedCommandNotHandled: - """Schema for the `QueuedCommandNotHandled` type.""" +class Entry: + id: str + """Identifier for this entry, formed by joining its `kind` and source name (e.g. + `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to + match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP + registries), and as the `parentId` target for nesting. Distinct from the human-facing + `label`. + """ + kind: str + """Source category for this entry. Not a closed set — tolerate unknown values. Known values + today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + """ + label: str + """Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be + localized/reformatted without notice — do not key off it. + """ + tokens: int + """Token count currently in context attributable to this entry.""" - handled: ClassVar[str] = "false" - """The host did not execute the queued command. Unblocks the queue without claiming the - command was processed (e.g. when the handler threw before completing). + attributes: dict[str, str] | None = None + """Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, + `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + """ + parent_id: str | None = None + """Optional `id` of the parent entry: e.g. a `plugin` entry parenting its + `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. + Omitted for top-level entries. """ @staticmethod - def from_dict(obj: Any) -> 'QueuedCommandNotHandled': + def from_dict(obj: Any) -> 'Entry': assert isinstance(obj, dict) - return QueuedCommandNotHandled() + id = from_str(obj.get("id")) + kind = from_str(obj.get("kind")) + label = from_str(obj.get("label")) + tokens = from_int(obj.get("tokens")) + attributes = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("attributes")) + parent_id = from_union([from_str, from_none], obj.get("parentId")) + return Entry(id, kind, label, tokens, attributes, parent_id) def to_dict(self) -> dict: result: dict = {} - result["handled"] = self.handled + result["id"] = from_str(self.id) + result["kind"] = from_str(self.kind) + result["label"] = from_str(self.label) + result["tokens"] = from_int(self.tokens) + if self.attributes is not None: + result["attributes"] = from_union([lambda x: from_dict(from_str, x), from_none], self.attributes) + if self.parent_id is not None: + result["parentId"] = from_union([from_str, from_none], self.parent_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RegisterEventInterestParams: - """Event type to register consumer interest for, used by runtime gating logic.""" +class MetadataContextHeaviestMessagesRequest: + """Parameters for the heaviest-messages query.""" - event_type: str - """The event type the consumer wants the runtime to treat as 'observed' for - behavior-switching gating. Some runtime code paths inspect whether any consumer is - interested in a specific event type and choose a different implementation accordingly - (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full - interactive OAuth flow to the consumer; when no interest is registered the runtime - installs a browserless fallback that silently reuses cached tokens). SDK clients that - long-poll events do NOT automatically appear as listeners to these gating checks — they - must explicitly call `registerInterest` for each event type they want the runtime to - count as having a consumer. Multiple registrations for the same event type from the same - or different consumers are tracked independently and must each be released. See: - `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, - `user_input.requested`, `elicitation.requested`, `command.queued`, - `exit_plan_mode.requested`. - """ + limit: int | None = None + """Maximum number of messages to return, most-expensive first. Omit for the server default.""" @staticmethod - def from_dict(obj: Any) -> 'RegisterEventInterestParams': + def from_dict(obj: Any) -> 'MetadataContextHeaviestMessagesRequest': assert isinstance(obj, dict) - event_type = from_str(obj.get("eventType")) - return RegisterEventInterestParams(event_type) + limit = from_union([from_int, from_none], obj.get("limit")) + return MetadataContextHeaviestMessagesRequest(limit) def to_dict(self) -> dict: result: dict = {} - result["eventType"] = from_str(self.event_type) + if self.limit is not None: + result["limit"] = from_union([from_int, from_none], self.limit) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RegisterEventInterestResult: - """Opaque handle representing an event-type interest registration.""" +class SessionContextInfo: + """Token-usage breakdown for the session's current context window""" - handle: str - """Opaque handle for this registration. Pass to releaseInterest to release. Each call to - registerInterest produces a fresh handle, even when the same eventType is registered - multiple times. + buffer_tokens: int + """Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%)""" + + compaction_threshold: int + """Token count at which background compaction starts (configurable percentage of + promptTokenLimit) + """ + conversation_tokens: int + """Tokens consumed by user/assistant/tool messages""" + + limit: int + """Prompt token limit plus the model's full output token limit.""" + + mcp_tools_tokens: int + """Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes + deferred tools) """ + model_name: str + """The model used for token counting""" + + prompt_token_limit: int + """Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified)""" + + system_tokens: int + """Tokens consumed by the system prompt""" + + tool_definitions_tokens: int + """Tokens consumed by tool definitions sent to the model (excludes deferred tools)""" + + total_tokens: int + """Sum of system, conversation and tool-definition tokens""" @staticmethod - def from_dict(obj: Any) -> 'RegisterEventInterestResult': + def from_dict(obj: Any) -> 'SessionContextInfo': assert isinstance(obj, dict) - handle = from_str(obj.get("handle")) - return RegisterEventInterestResult(handle) + buffer_tokens = from_int(obj.get("bufferTokens")) + compaction_threshold = from_int(obj.get("compactionThreshold")) + conversation_tokens = from_int(obj.get("conversationTokens")) + limit = from_int(obj.get("limit")) + mcp_tools_tokens = from_int(obj.get("mcpToolsTokens")) + model_name = from_str(obj.get("modelName")) + prompt_token_limit = from_int(obj.get("promptTokenLimit")) + system_tokens = from_int(obj.get("systemTokens")) + tool_definitions_tokens = from_int(obj.get("toolDefinitionsTokens")) + total_tokens = from_int(obj.get("totalTokens")) + return SessionContextInfo(buffer_tokens, compaction_threshold, conversation_tokens, limit, mcp_tools_tokens, model_name, prompt_token_limit, system_tokens, tool_definitions_tokens, total_tokens) def to_dict(self) -> dict: result: dict = {} - result["handle"] = from_str(self.handle) + result["bufferTokens"] = from_int(self.buffer_tokens) + result["compactionThreshold"] = from_int(self.compaction_threshold) + result["conversationTokens"] = from_int(self.conversation_tokens) + result["limit"] = from_int(self.limit) + result["mcpToolsTokens"] = from_int(self.mcp_tools_tokens) + result["modelName"] = from_str(self.model_name) + result["promptTokenLimit"] = from_int(self.prompt_token_limit) + result["systemTokens"] = from_int(self.system_tokens) + result["toolDefinitionsTokens"] = from_int(self.tool_definitions_tokens) + result["totalTokens"] = from_int(self.total_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ReleaseEventInterestParams: - """Opaque handle previously returned by `registerInterest` to release.""" - - handle: str - """Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown - or already-released handle is a no-op (returns success). When the last outstanding handle - for an event type is released, the runtime reverts to its 'no consumer' code path for - that event type. +class MetadataIsProcessingResult: + """Indicates whether the local session is currently processing a turn or background + continuation. + """ + processing: bool + """Whether the session is currently processing user/agent messages. False for non-local + sessions (which don't run a local agentic loop). Reflects an in-flight turn or background + continuation. """ @staticmethod - def from_dict(obj: Any) -> 'ReleaseEventInterestParams': + def from_dict(obj: Any) -> 'MetadataIsProcessingResult': assert isinstance(obj, dict) - handle = from_str(obj.get("handle")) - return ReleaseEventInterestParams(handle) + processing = from_bool(obj.get("processing")) + return MetadataIsProcessingResult(processing) def to_dict(self) -> dict: result: dict = {} - result["handle"] = from_str(self.handle) + result["processing"] = from_bool(self.processing) return result # Experimental: this type is part of an experimental API and may change or be removed. -class RemoteSessionMode(Enum): - """Per-session remote mode. "off" disables remote, "export" exports session events to GitHub - without enabling remote steering, "on" enables both export and remote steering. +@dataclass +class MetadataRecomputeContextTokensResult: + """Re-tokenize the session's existing messages against `modelId` and return the token + totals. Useful for hosts that want an initial estimate of context usage on session + resume, before the next agent turn fires `session.context_info_changed` events. Returns + zeros for an empty session. """ - EXPORT = "export" - OFF = "off" - ON = "on" + messages_token_count: int + """Tokens contributed by user/assistant/tool messages (excludes system/developer prompts).""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class RemoteEnableResult: - """GitHub URL for the session and a flag indicating whether remote steering is enabled.""" + system_token_count: int + """Tokens contributed by system/developer prompt snapshots.""" - remote_steerable: bool - """Whether remote steering is enabled""" - - url: str | None = None - """GitHub frontend URL for this session""" + total_tokens: int + """Sum of tokens across chat-context and system-context messages currently held by the + session. + """ @staticmethod - def from_dict(obj: Any) -> 'RemoteEnableResult': + def from_dict(obj: Any) -> 'MetadataRecomputeContextTokensResult': assert isinstance(obj, dict) - remote_steerable = from_bool(obj.get("remoteSteerable")) - url = from_union([from_str, from_none], obj.get("url")) - return RemoteEnableResult(remote_steerable, url) + messages_token_count = from_int(obj.get("messagesTokenCount")) + system_token_count = from_int(obj.get("systemTokenCount")) + total_tokens = from_int(obj.get("totalTokens")) + return MetadataRecomputeContextTokensResult(messages_token_count, system_token_count, total_tokens) def to_dict(self) -> dict: result: dict = {} - result["remoteSteerable"] = from_bool(self.remote_steerable) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + result["messagesTokenCount"] = from_int(self.messages_token_count) + result["systemTokenCount"] = from_int(self.system_token_count) + result["totalTokens"] = from_int(self.total_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RemoteNotifySteerableChangedRequest: - """New remote-steerability state to persist as a `session.remote_steerable_changed` event.""" - - remote_steerable: bool - """Whether the session now supports remote steering via GitHub. The runtime persists this as - a `session.remote_steerable_changed` event so resume/replay sees the up-to-date - capability. +class MetadataRecordContextChangeResult: + """Notify the session that its working directory context has changed. Emits a + `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline + UI) can react. Use this when the host has detected a cwd/branch/repo change outside the + session's normal lifecycle (e.g., after a shell command in interactive mode). For a local + session, a report whose `cwd` diverges from the session's current working directory is + ignored (the call still succeeds but records nothing and emits no event); move a local + session's working directory via `metadata.setWorkingDirectory` instead. """ - @staticmethod - def from_dict(obj: Any) -> 'RemoteNotifySteerableChangedRequest': + def from_dict(obj: Any) -> 'MetadataRecordContextChangeResult': assert isinstance(obj, dict) - remote_steerable = from_bool(obj.get("remoteSteerable")) - return RemoteNotifySteerableChangedRequest(remote_steerable) + return MetadataRecordContextChangeResult() def to_dict(self) -> dict: result: dict = {} - result["remoteSteerable"] = from_bool(self.remote_steerable) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RemoteNotifySteerableChangedResult: - """Persist a steerability change as a `session.remote_steerable_changed` event. Used by the - host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a - remote exporter that the runtime does not directly own. +class MetadataSetWorkingDirectoryRequest: + """Absolute path to set as the session's new working directory. For local sessions the path + must be absolute and exist on disk: it is validated before any session state changes, and + a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote + sessions record the path as-is. + """ + working_directory: str + """Absolute path to set as the session's working directory. The runtime updates the + session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) + anchor to it. """ + @staticmethod - def from_dict(obj: Any) -> 'RemoteNotifySteerableChangedResult': + def from_dict(obj: Any) -> 'MetadataSetWorkingDirectoryRequest': assert isinstance(obj, dict) - return RemoteNotifySteerableChangedResult() + working_directory = from_str(obj.get("workingDirectory")) + return MetadataSetWorkingDirectoryRequest(working_directory) def to_dict(self) -> dict: result: dict = {} + result["workingDirectory"] = from_str(self.working_directory) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ScheduleEntry: - """Schema for the `ScheduleEntry` type. - - The removed entry, or omitted if no entry matched. - """ - id: int - """Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt - from the event log). - """ - interval_ms: int - """Interval between scheduled ticks, in milliseconds.""" - - next_run_at: datetime - """ISO 8601 timestamp when the next tick is scheduled to fire.""" - - prompt: str - """Prompt text that gets enqueued on every tick.""" - - recurring: bool - """Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`).""" - - display_prompt: str | None = None - """Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a - skill-invocation schedule). The actual enqueued prompt is `prompt`. +class MetadataSetWorkingDirectoryResult: + """Update the session's working directory. Used by the host when the user explicitly changes + cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects + (file index, etc.); it does NOT change the process working directory (a session's cwd is + per-session, not process-global). For local sessions the runtime validates the target + first (an absolute path that exists on disk) and re-bases the permission primary + directory; a rejected validation fails the call before anything is mutated, persisted, or + emitted. Location-scoped permission rules are then re-keyed to the new directory + (best-effort). Remote sessions only record the path. """ + working_directory: str + """Working directory after the update""" @staticmethod - def from_dict(obj: Any) -> 'ScheduleEntry': + def from_dict(obj: Any) -> 'MetadataSetWorkingDirectoryResult': assert isinstance(obj, dict) - id = from_int(obj.get("id")) - interval_ms = from_int(obj.get("intervalMs")) - next_run_at = from_datetime(obj.get("nextRunAt")) - prompt = from_str(obj.get("prompt")) - recurring = from_bool(obj.get("recurring")) - display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) - return ScheduleEntry(id, interval_ms, next_run_at, prompt, recurring, display_prompt) + working_directory = from_str(obj.get("workingDirectory")) + return MetadataSetWorkingDirectoryResult(working_directory) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_int(self.id) - result["intervalMs"] = from_int(self.interval_ms) - result["nextRunAt"] = self.next_run_at.isoformat() - result["prompt"] = from_str(self.prompt) - result["recurring"] = from_bool(self.recurring) - if self.display_prompt is not None: - result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + result["workingDirectory"] = from_str(self.working_directory) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class MetadataSnapshotCurrentMode(Enum): + """The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')""" + + AUTOPILOT = "autopilot" + INTERACTIVE = "interactive" + PLAN = "plan" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ScheduleStopRequest: - """Identifier of the scheduled prompt to remove.""" +class MetadataSnapshotRemoteMetadataRepository: + """The repository the remote session targets.""" - id: int - """Id of the scheduled prompt to remove.""" + branch: str + """The branch the remote session is operating on.""" + + name: str + """The GitHub repository name (without owner).""" + + owner: str + """The GitHub owner (user or organization) of the target repository.""" @staticmethod - def from_dict(obj: Any) -> 'ScheduleStopRequest': + def from_dict(obj: Any) -> 'MetadataSnapshotRemoteMetadataRepository': assert isinstance(obj, dict) - id = from_int(obj.get("id")) - return ScheduleStopRequest(id) + branch = from_str(obj.get("branch")) + name = from_str(obj.get("name")) + owner = from_str(obj.get("owner")) + return MetadataSnapshotRemoteMetadataRepository(branch, name, owner) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_int(self.id) + result["branch"] = from_str(self.branch) + result["name"] = from_str(self.name) + result["owner"] = from_str(self.owner) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class TaskType(Enum): + """Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` + invocation. + + Whether the remote task originated from CCA or CLI `--remote`. + + Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient + session). + """ + CCA = "cca" + CLI = "cli" + +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SecretsAddFilterValuesRequest: - """Secret values to add to the redaction filter.""" +class ModeSetRequest: + """Agent interaction mode to apply to the session.""" - values: list[str] - """Raw secret values to register for redaction""" + mode: SessionMode + """The session mode the agent is operating in""" @staticmethod - def from_dict(obj: Any) -> 'SecretsAddFilterValuesRequest': + def from_dict(obj: Any) -> 'ModeSetRequest': assert isinstance(obj, dict) - values = from_list(from_str, obj.get("values")) - return SecretsAddFilterValuesRequest(values) + mode = SessionMode(obj.get("mode")) + return ModeSetRequest(mode) def to_dict(self) -> dict: result: dict = {} - result["values"] = from_list(from_str, self.values) + result["mode"] = to_enum(SessionMode, self.mode) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SecretsAddFilterValuesResult: - """Confirmation that the secret values were registered.""" +class ModelBillingPromo: + """Active server-driven promotion for this model, if any. Present when the model is being + promoted with a discount, which may be time-boxed or open-ended. - ok: bool - """Whether the values were successfully registered""" + Active server-driven promotion for a model, including its discount and optional expiry. + """ + discount_percent: float | None = None + """Percentage discount (0-100) applied while the promotion is active. May be fractional.""" + + ends_at: str | None = None + """UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion + omits this field. When present, the API only surfaces a promo whose expiry parses and is + in the future, so consumers should treat a past value as expired. + """ + id: str | None = None + """Stable identifier for the promotion campaign.""" + + message: str | None = None + """Human-readable promotion message. Does not include the expiry timestamp; consumers may + format endsAt and append it when present. + """ @staticmethod - def from_dict(obj: Any) -> 'SecretsAddFilterValuesResult': + def from_dict(obj: Any) -> 'ModelBillingPromo': assert isinstance(obj, dict) - ok = from_bool(obj.get("ok")) - return SecretsAddFilterValuesResult(ok) + discount_percent = from_union([from_float, from_none], obj.get("discountPercent")) + ends_at = from_union([from_str, from_none], obj.get("endsAt")) + id = from_union([from_str, from_none], obj.get("id")) + message = from_union([from_str, from_none], obj.get("message")) + return ModelBillingPromo(discount_percent, ends_at, id, message) def to_dict(self) -> dict: result: dict = {} - result["ok"] = from_bool(self.ok) + if self.discount_percent is not None: + result["discountPercent"] = from_union([to_float, from_none], self.discount_percent) + if self.ends_at is not None: + result["endsAt"] = from_union([from_str, from_none], self.ends_at) + if self.id is not None: + result["id"] = from_union([from_str, from_none], self.id) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class SendAgentMode(Enum): - """The UI mode the agent was in when this message was sent. Defaults to the session's - current mode. - """ - AUTOPILOT = "autopilot" - INTERACTIVE = "interactive" - PLAN = "plan" - SHELL = "shell" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentFileLineRange: - """Optional line range to scope the attachment to a specific section of the file""" +class ModelBillingTokenPricesLongContext: + """Long context tier pricing (available for models with extended context windows)""" - end: int - """End line number (1-based, inclusive)""" + cache_price: float | None = None + """Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens""" - start: int - """Start line number (1-based)""" + cache_read_price: float | None = None + """AI Credits cost per billing batch of cached (read) tokens""" + + cache_write_price: float | None = None + """AI Credits cost per billing batch of cache-write (cache creation) tokens.""" + + context_max: int | None = None + """Use maxPromptTokens instead. Prompt token budget for the long context tier. The total + context window is this value plus the model's max_output_tokens. + """ + input_price: float | None = None + """AI Credits cost per billing batch of input tokens""" + + max_prompt_tokens: int | None = None + """Prompt token budget for the long context tier. The total context window is this value + plus the model's max_output_tokens. + """ + output_price: float | None = None + """AI Credits cost per billing batch of output tokens""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentFileLineRange': + def from_dict(obj: Any) -> 'ModelBillingTokenPricesLongContext': assert isinstance(obj, dict) - end = from_int(obj.get("end")) - start = from_int(obj.get("start")) - return SendAttachmentFileLineRange(end, start) + cache_price = from_union([from_float, from_none], obj.get("cachePrice")) + cache_read_price = from_union([from_float, from_none], obj.get("cacheReadPrice")) + cache_write_price = from_union([from_float, from_none], obj.get("cacheWritePrice")) + context_max = from_union([from_int, from_none], obj.get("contextMax")) + input_price = from_union([from_float, from_none], obj.get("inputPrice")) + max_prompt_tokens = from_union([from_int, from_none], obj.get("maxPromptTokens")) + output_price = from_union([from_float, from_none], obj.get("outputPrice")) + return ModelBillingTokenPricesLongContext(cache_price, cache_read_price, cache_write_price, context_max, input_price, max_prompt_tokens, output_price) def to_dict(self) -> dict: result: dict = {} - result["end"] = from_int(self.end) - result["start"] = from_int(self.start) + if self.cache_price is not None: + result["cachePrice"] = from_union([to_float, from_none], self.cache_price) + if self.cache_read_price is not None: + result["cacheReadPrice"] = from_union([to_float, from_none], self.cache_read_price) + if self.cache_write_price is not None: + result["cacheWritePrice"] = from_union([to_float, from_none], self.cache_write_price) + if self.context_max is not None: + result["contextMax"] = from_union([from_int, from_none], self.context_max) + if self.input_price is not None: + result["inputPrice"] = from_union([to_float, from_none], self.input_price) + if self.max_prompt_tokens is not None: + result["maxPromptTokens"] = from_union([from_int, from_none], self.max_prompt_tokens) + if self.output_price is not None: + result["outputPrice"] = from_union([to_float, from_none], self.output_price) return result -class SendAttachmentGithubReferenceTypeEnum(Enum): - """Type of GitHub reference""" - - DISCUSSION = "discussion" - ISSUE = "issue" - PR = "pr" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentSelectionDetailsEnd: - """End position of the selection""" +class ModelCapabilitiesLimitsVision: + """Vision-specific limits""" - character: int - """End character offset within the line (0-based)""" + max_prompt_image_size: int + """Maximum image size in bytes""" - line: int - """End line number (0-based)""" + max_prompt_images: int + """Maximum number of images per prompt""" + + supported_media_types: list[str] + """MIME types the model accepts""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentSelectionDetailsEnd': + def from_dict(obj: Any) -> 'ModelCapabilitiesLimitsVision': assert isinstance(obj, dict) - character = from_int(obj.get("character")) - line = from_int(obj.get("line")) - return SendAttachmentSelectionDetailsEnd(character, line) + max_prompt_image_size = from_int(obj.get("max_prompt_image_size")) + max_prompt_images = from_int(obj.get("max_prompt_images")) + supported_media_types = from_list(from_str, obj.get("supported_media_types")) + return ModelCapabilitiesLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types) def to_dict(self) -> dict: result: dict = {} - result["character"] = from_int(self.character) - result["line"] = from_int(self.line) + result["max_prompt_image_size"] = from_int(self.max_prompt_image_size) + result["max_prompt_images"] = from_int(self.max_prompt_images) + result["supported_media_types"] = from_list(from_str, self.supported_media_types) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SendAttachmentSelectionDetailsStart: - """Start position of the selection""" - - character: int - """Start character offset within the line (0-based)""" +class ModelPickerPriceCategory(Enum): + """Relative cost tier for token-based billing users""" - line: int - """Start line number (0-based)""" + HIGH = "high" + LOW = "low" + MEDIUM = "medium" + VERY_HIGH = "very_high" - @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentSelectionDetailsStart': - assert isinstance(obj, dict) - character = from_int(obj.get("character")) - line = from_int(obj.get("line")) - return SendAttachmentSelectionDetailsStart(character, line) +# Experimental: this type is part of an experimental API and may change or be removed. +class ModelPolicyState(Enum): + """Current policy state for this model""" - def to_dict(self) -> dict: - result: dict = {} - result["character"] = from_int(self.character) - result["line"] = from_int(self.line) - return result + DISABLED = "disabled" + ENABLED = "enabled" + UNCONFIGURED = "unconfigured" -class SendAttachmentType(Enum): - BLOB = "blob" - DIRECTORY = "directory" - FILE = "file" - GITHUB_REFERENCE = "github_reference" - SELECTION = "selection" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelCapabilitiesOverrideLimitsVision: + """Vision-specific limits""" -class SendAttachmentBlobType(Enum): - BLOB = "blob" + max_prompt_image_size: int | None = None + """Maximum image size in bytes""" -class SendAttachmentFileType(Enum): - FILE = "file" + max_prompt_images: int | None = None + """Maximum number of images per prompt""" -# Experimental: this type is part of an experimental API and may change or be removed. -class SendAttachmentGithubReferenceType(Enum): - GITHUB_REFERENCE = "github_reference" + supported_media_types: list[str] | None = None + """MIME types the model accepts""" -class SendAttachmentSelectionType(Enum): - SELECTION = "selection" + @staticmethod + def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimitsVision': + assert isinstance(obj, dict) + max_prompt_image_size = from_union([from_int, from_none], obj.get("max_prompt_image_size")) + max_prompt_images = from_union([from_int, from_none], obj.get("max_prompt_images")) + supported_media_types = from_union([lambda x: from_list(from_str, x), from_none], obj.get("supported_media_types")) + return ModelCapabilitiesOverrideLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types) -# Experimental: this type is part of an experimental API and may change or be removed. -class SendMode(Enum): - """How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` - interjects during an in-progress turn. - """ - ENQUEUE = "enqueue" - IMMEDIATE = "immediate" + def to_dict(self) -> dict: + result: dict = {} + if self.max_prompt_image_size is not None: + result["max_prompt_image_size"] = from_union([from_int, from_none], self.max_prompt_image_size) + if self.max_prompt_images is not None: + result["max_prompt_images"] = from_union([from_int, from_none], self.max_prompt_images) + if self.supported_media_types is not None: + result["supported_media_types"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_media_types) + return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendResult: - """Result of sending a user message""" +class ModelSetReasoningEffortRequest: + """Reasoning effort level to apply to the currently selected model.""" - message_id: str - """Unique identifier assigned to the message""" + reasoning_effort: str + """Reasoning effort level to apply to the currently selected model. The host is responsible + for validating the value against the model's supported levels before calling. + """ @staticmethod - def from_dict(obj: Any) -> 'SendResult': + def from_dict(obj: Any) -> 'ModelSetReasoningEffortRequest': assert isinstance(obj, dict) - message_id = from_str(obj.get("messageId")) - return SendResult(message_id) + reasoning_effort = from_str(obj.get("reasoningEffort")) + return ModelSetReasoningEffortRequest(reasoning_effort) def to_dict(self) -> dict: result: dict = {} - result["messageId"] = from_str(self.message_id) + result["reasoningEffort"] = from_str(self.reasoning_effort) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ServerSkill: - """Schema for the `ServerSkill` type.""" - - description: str - """Description of what the skill does""" - - enabled: bool - """Whether the skill is currently enabled (based on global config)""" - - name: str - """Unique identifier for the skill""" - - source: SkillSource - """Source location type (e.g., project, personal-copilot, plugin, builtin)""" - - user_invocable: bool - """Whether the skill can be invoked by the user as a slash command""" - - path: str | None = None - """Absolute path to the skill file""" - - project_path: str | None = None - """The project path this skill belongs to (only for project/inherited skills)""" +class ModelSetReasoningEffortResult: + """Update the session's reasoning effort without changing the selected model. Use `switchTo` + instead when you also need to change the model. The runtime stores the effort on the + session and applies it to subsequent turns. + """ + reasoning_effort: str + """Reasoning effort level recorded on the session after the update""" @staticmethod - def from_dict(obj: Any) -> 'ServerSkill': + def from_dict(obj: Any) -> 'ModelSetReasoningEffortResult': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - enabled = from_bool(obj.get("enabled")) - name = from_str(obj.get("name")) - source = SkillSource(obj.get("source")) - user_invocable = from_bool(obj.get("userInvocable")) - path = from_union([from_str, from_none], obj.get("path")) - project_path = from_union([from_str, from_none], obj.get("projectPath")) - return ServerSkill(description, enabled, name, source, user_invocable, path, project_path) + reasoning_effort = from_str(obj.get("reasoningEffort")) + return ModelSetReasoningEffortResult(reasoning_effort) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["enabled"] = from_bool(self.enabled) - result["name"] = from_str(self.name) - result["source"] = to_enum(SkillSource, self.source) - result["userInvocable"] = from_bool(self.user_invocable) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.project_path is not None: - result["projectPath"] = from_union([from_str, from_none], self.project_path) + result["reasoningEffort"] = from_str(self.reasoning_effort) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionBulkDeleteResult: - """Map of sessionId -> bytes freed by removing the session's workspace directory.""" +class ModelSwitchToResult: + """The model identifier active on the session after the switch.""" - freed_bytes: dict[str, int] - """Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions - whose deletion failed are omitted from this map (failures are logged on the server but - not surfaced per-id; check the map for absent IDs to detect them). + deferred: bool | None = None + """True when the switch was deferred (enqueued as a cancellable `/model` command) because a + turn was active or another model change was already queued, rather than applied + immediately. When true, the session's live model is unchanged until the queued change + drains. """ + model_id: str | None = None + """Currently active model identifier after the switch""" @staticmethod - def from_dict(obj: Any) -> 'SessionBulkDeleteResult': + def from_dict(obj: Any) -> 'ModelSwitchToResult': assert isinstance(obj, dict) - freed_bytes = from_dict(from_int, obj.get("freedBytes")) - return SessionBulkDeleteResult(freed_bytes) + deferred = from_union([from_bool, from_none], obj.get("deferred")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + return ModelSwitchToResult(deferred, model_id) def to_dict(self) -> dict: result: dict = {} - result["freedBytes"] = from_dict(from_int, self.freed_bytes) + if self.deferred is not None: + result["deferred"] = from_union([from_bool, from_none], self.deferred) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSAppendFileRequest: - """File path, content to append, and optional mode for the client-provided session - filesystem. +class ModelsListRequest: + git_hub_token: str | None = None + """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. """ - content: str - """Content to append""" - - path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" - - mode: int | None = None - """Optional POSIX-style mode for newly created files""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSAppendFileRequest': + def from_dict(obj: Any) -> 'ModelsListRequest': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - mode = from_union([from_int, from_none], obj.get("mode")) - return SessionFSAppendFileRequest(content, path, session_id, mode) + git_hub_token = from_union([from_str, from_none], obj.get("gitHubToken")) + return ModelsListRequest(git_hub_token) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) - if self.mode is not None: - result["mode"] = from_union([from_int, from_none], self.mode) + if self.git_hub_token is not None: + result["gitHubToken"] = from_union([from_str, from_none], self.git_hub_token) return result # Experimental: this type is part of an experimental API and may change or be removed. -class SessionFSErrorCode(Enum): - """Error classification""" +@dataclass +class NameGetResult: + """The session's friendly name, or null when not yet set.""" - ENOENT = "ENOENT" - UNKNOWN = "UNKNOWN" + name: str | None = None + """The session name (user-set or auto-generated), or null if not yet set""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSExistsRequest: - """Path to test for existence in the client-provided session filesystem.""" + @staticmethod + def from_dict(obj: Any) -> 'NameGetResult': + assert isinstance(obj, dict) + name = from_union([from_none, from_str], obj.get("name")) + return NameGetResult(name) - path: str - """Path using SessionFs conventions""" + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_union([from_none, from_str], self.name) + return result - session_id: str - """Target session identifier""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class NameSetAutoRequest: + """Auto-generated session summary to apply as the session's name when no user-set name + exists. + """ + summary: str + """Auto-generated session summary. Empty/whitespace-only values are ignored; values are + trimmed before persisting. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSExistsRequest': + def from_dict(obj: Any) -> 'NameSetAutoRequest': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - return SessionFSExistsRequest(path, session_id) + summary = from_str(obj.get("summary")) + return NameSetAutoRequest(summary) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) + result["summary"] = from_str(self.summary) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSExistsResult: - """Indicates whether the requested path exists in the client-provided session filesystem.""" +class NameSetAutoResult: + """Indicates whether the auto-generated summary was applied as the session's name.""" - exists: bool - """Whether the path exists""" + applied: bool + """Whether the auto-generated summary was persisted. False if the session already has a + user-set name, the summary normalized to empty, or the session does not have a workspace. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSExistsResult': + def from_dict(obj: Any) -> 'NameSetAutoResult': assert isinstance(obj, dict) - exists = from_bool(obj.get("exists")) - return SessionFSExistsResult(exists) + applied = from_bool(obj.get("applied")) + return NameSetAutoResult(applied) def to_dict(self) -> dict: result: dict = {} - result["exists"] = from_bool(self.exists) + result["applied"] = from_bool(self.applied) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSMkdirRequest: - """Directory path to create in the client-provided session filesystem, with options for - recursive creation and POSIX mode. - """ - path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" - - mode: int | None = None - """Optional POSIX-style mode for newly created directories""" +class NameSetRequest: + """New friendly name to apply to the session.""" - recursive: bool | None = None - """Create parent directories as needed""" + name: str + """New session name (1–100 characters, trimmed of leading/trailing whitespace)""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSMkdirRequest': + def from_dict(obj: Any) -> 'NameSetRequest': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - mode = from_union([from_int, from_none], obj.get("mode")) - recursive = from_union([from_bool, from_none], obj.get("recursive")) - return SessionFSMkdirRequest(path, session_id, mode, recursive) + name = from_str(obj.get("name")) + return NameSetRequest(name) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) - if self.mode is not None: - result["mode"] = from_union([from_int, from_none], self.mode) - if self.recursive is not None: - result["recursive"] = from_union([from_bool, from_none], self.recursive) + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSReadFileRequest: - """Path of the file to read from the client-provided session filesystem.""" - - path: str - """Path using SessionFs conventions""" +class ProviderConfigAzure: + """Azure-specific provider options.""" - session_id: str - """Target session identifier""" + api_version: str | None = None + """API version. When set, uses the versioned deployment route. When omitted, uses the GA + versionless v1 route. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSReadFileRequest': + def from_dict(obj: Any) -> 'ProviderConfigAzure': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - return SessionFSReadFileRequest(path, session_id) + api_version = from_union([from_str, from_none], obj.get("apiVersion")) + return ProviderConfigAzure(api_version) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) + if self.api_version is not None: + result["apiVersion"] = from_union([from_str, from_none], self.api_version) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSReaddirRequest: - """Directory path whose entries should be listed from the client-provided session filesystem.""" - - path: str - """Path using SessionFs conventions""" +class ProviderTransport(Enum): + """Provider transport. Defaults to "http". - session_id: str - """Target session identifier""" + Transport to be used for provider requests. + """ + HTTP = "http" + WEBSOCKETS = "websockets" - @staticmethod - def from_dict(obj: Any) -> 'SessionFSReaddirRequest': - assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - return SessionFSReaddirRequest(path, session_id) +# Experimental: this type is part of an experimental API and may change or be removed. +class ProviderType(Enum): + """Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. - def to_dict(self) -> dict: - result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) - return result + Provider family. Matches the `type` field of a BYOK provider config. + """ + ANTHROPIC = "anthropic" + AZURE = "azure" + OPENAI = "openai" # Experimental: this type is part of an experimental API and may change or be removed. -class SessionFSReaddirWithTypesEntryType(Enum): - """Entry type""" +class ProviderWireAPI(Enum): + """Wire API format (openai/azure only). Defaults to "completions". - DIRECTORY = "directory" - FILE = "file" + Wire API to be used, when required for the provider type. + """ + COMPLETIONS = "completions" + RESPONSES = "responses" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSReaddirWithTypesRequest: - """Directory path whose entries (with type information) should be listed from the - client-provided session filesystem. +class OptionsUpdateAdditionalContentExclusionPolicyRuleSource: + """Source descriptor for a `session.options.update` content-exclusion rule, with source name + and type. """ - path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" + name: str + type: str @staticmethod - def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesRequest': + def from_dict(obj: Any) -> 'OptionsUpdateAdditionalContentExclusionPolicyRuleSource': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - return SessionFSReaddirWithTypesRequest(path, session_id) + name = from_str(obj.get("name")) + type = from_str(obj.get("type")) + return OptionsUpdateAdditionalContentExclusionPolicyRuleSource(name, type) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) + result["name"] = from_str(self.name) + result["type"] = from_str(self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSRenameRequest: - """Source and destination paths for renaming or moving an entry in the client-provided - session filesystem. - """ - dest: str - """Destination path using SessionFs conventions""" +class AdditionalContentExclusionPolicyScope(Enum): + """Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. - session_id: str - """Target session identifier""" + Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` + enumeration. - src: str - """Source path using SessionFs conventions""" + Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` + enumeration. + """ + ALL = "all" + REPO = "repo" - @staticmethod - def from_dict(obj: Any) -> 'SessionFSRenameRequest': - assert isinstance(obj, dict) - dest = from_str(obj.get("dest")) - session_id = from_str(obj.get("sessionId")) - src = from_str(obj.get("src")) - return SessionFSRenameRequest(dest, session_id, src) +# Experimental: this type is part of an experimental API and may change or be removed. +class OptionsUpdateContextTier(Enum): + """Context tier for models with tiered pricing. The session uses this to derive effective + `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits + honor the selected tier. + """ + DEFAULT = "default" + LONG_CONTEXT = "long_context" - def to_dict(self) -> dict: - result: dict = {} - result["dest"] = from_str(self.dest) - result["sessionId"] = from_str(self.session_id) - result["src"] = from_str(self.src) - return result +# Experimental: this type is part of an experimental API and may change or be removed. +class OptionsUpdateToolFilterPrecedence(Enum): + """Controls how availableTools (allowlist) and excludedTools (denylist) combine when both + are set. + """ + AVAILABLE = "available" + EXCLUDED = "excluded" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSRmRequest: - """Path to remove from the client-provided session filesystem, with options for recursive - removal and force. +class PendingPermissionRequest: + """Pending permission prompt reconstructed from event history, with request ID and + user-facing prompt details. """ - path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" - - force: bool | None = None - """Ignore errors if the path does not exist""" - - recursive: bool | None = None - """Remove directories and their contents recursively""" + request: PermissionPromptRequest + """The user-facing permission prompt details (commands, write, read, mcp, url, memory, + custom-tool, path, hook) + """ + request_id: str + """Unique identifier for the pending permission request""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSRmRequest': + def from_dict(obj: Any) -> 'PendingPermissionRequest': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - force = from_union([from_bool, from_none], obj.get("force")) - recursive = from_union([from_bool, from_none], obj.get("recursive")) - return SessionFSRmRequest(path, session_id, force, recursive) + request = PermissionPromptRequest.from_dict(obj.get("request")) + request_id = from_str(obj.get("requestId")) + return PendingPermissionRequest(request, request_id) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) - if self.force is not None: - result["force"] = from_union([from_bool, from_none], self.force) - if self.recursive is not None: - result["recursive"] = from_union([from_bool, from_none], self.recursive) + result["request"] = to_class(PermissionPromptRequest, self.request) + result["requestId"] = from_str(self.request_id) return result -@dataclass -class SessionFSSetProviderCapabilities: - """Optional capabilities declared by the provider""" +class ApprovalKind(Enum): + COMMANDS = "commands" + CUSTOM_TOOL = "custom-tool" + EXTENSION_MANAGEMENT = "extension-management" + EXTENSION_PERMISSION_ACCESS = "extension-permission-access" + FACTORY = "factory" + MCP = "mcp" + MCP_SAMPLING = "mcp-sampling" + MEMORY = "memory" + READ = "read" + WRITE = "write" - sqlite: bool | None = None - """Whether the provider supports SQLite query/exists operations""" +class PermissionDecisionKind(Enum): + APPROVED = "approved" + APPROVED_FOR_LOCATION = "approved-for-location" + APPROVED_FOR_SESSION = "approved-for-session" + APPROVE_FOR_LOCATION = "approve-for-location" + APPROVE_FOR_SESSION = "approve-for-session" + APPROVE_ONCE = "approve-once" + APPROVE_PERMANENTLY = "approve-permanently" + CANCELLED = "cancelled" + DENIED_BY_CONTENT_EXCLUSION_POLICY = "denied-by-content-exclusion-policy" + DENIED_BY_PERMISSION_REQUEST_HOOK = "denied-by-permission-request-hook" + DENIED_BY_RULES = "denied-by-rules" + DENIED_INTERACTIVELY_BY_USER = "denied-interactively-by-user" + DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER = "denied-no-approval-rule-and-could-not-request-from-user" + REJECT = "reject" + USER_NOT_AVAILABLE = "user-not-available" - @staticmethod - def from_dict(obj: Any) -> 'SessionFSSetProviderCapabilities': - assert isinstance(obj, dict) - sqlite = from_union([from_bool, from_none], obj.get("sqlite")) - return SessionFSSetProviderCapabilities(sqlite) +class PermissionDecisionApproveForLocationKind(Enum): + APPROVE_FOR_LOCATION = "approve-for-location" - def to_dict(self) -> dict: - result: dict = {} - if self.sqlite is not None: - result["sqlite"] = from_union([from_bool, from_none], self.sqlite) - return result +class PermissionDecisionApproveForLocationApprovalCommandsKind(Enum): + COMMANDS = "commands" -class SessionFSSetProviderConventions(Enum): - """Path conventions used by this filesystem""" +class PermissionDecisionApproveForLocationApprovalCustomToolKind(Enum): + CUSTOM_TOOL = "custom-tool" - POSIX = "posix" - WINDOWS = "windows" +class PermissionDecisionApproveForLocationApprovalExtensionManagementKind(Enum): + EXTENSION_MANAGEMENT = "extension-management" -@dataclass -class SessionFSSetProviderResult: - """Indicates whether the calling client was registered as the session filesystem provider.""" +class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind(Enum): + EXTENSION_PERMISSION_ACCESS = "extension-permission-access" - success: bool - """Whether the provider was set successfully""" +class PermissionDecisionApproveForLocationApprovalFactoryKind(Enum): + FACTORY = "factory" - @staticmethod - def from_dict(obj: Any) -> 'SessionFSSetProviderResult': - assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return SessionFSSetProviderResult(success) +class PermissionDecisionApproveForLocationApprovalMCPKind(Enum): + MCP = "mcp" - def to_dict(self) -> dict: - result: dict = {} - result["success"] = from_bool(self.success) - return result +class PermissionDecisionApproveForLocationApprovalMCPSamplingKind(Enum): + MCP_SAMPLING = "mcp-sampling" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSSqliteExistsRequest: - """Identifies the target session.""" +class PermissionDecisionApproveForLocationApprovalMemoryKind(Enum): + MEMORY = "memory" - session_id: str - """Target session identifier""" +class PermissionDecisionApproveForLocationApprovalReadKind(Enum): + READ = "read" + +class PermissionDecisionApproveForLocationApprovalWriteKind(Enum): + WRITE = "write" + +class PermissionDecisionApproveForSessionKind(Enum): + APPROVE_FOR_SESSION = "approve-for-session" + +class PermissionDecisionApproveOnceKind(Enum): + APPROVE_ONCE = "approve-once" + +class PermissionDecisionApprovePermanentlyKind(Enum): + APPROVE_PERMANENTLY = "approve-permanently" + +class PermissionDecisionApprovedKind(Enum): + APPROVED = "approved" + +class PermissionDecisionApprovedForLocationKind(Enum): + APPROVED_FOR_LOCATION = "approved-for-location" + +class PermissionDecisionApprovedForSessionKind(Enum): + APPROVED_FOR_SESSION = "approved-for-session" + +class PermissionDecisionCancelledKind(Enum): + CANCELLED = "cancelled" + +# Experimental: this type is part of an experimental API and may change or be removed. +class PermissionDecisionOutcome(Enum): + """Disposition of the permission request as observed by the responding client. + + Disposition of a permission request as observed by the responding client. + """ + AUTOPILOT_DENIED = "autopilot_denied" + AUTO_APPROVED = "auto_approved" + PROMPTED_USER = "prompted_user" + +# Experimental: this type is part of an experimental API and may change or be removed. +class PermissionDecisionSource(Enum): + """Controlled reason or actor responsible for the response. + + Controlled reason or actor responsible for a permission response. + """ + HOST_POLICY = "host_policy" + HUMAN_RESPONSE = "human_response" + JUDGE_RECOMMENDATION = "judge_recommendation" + UNATTENDED_FALLBACK = "unattended_fallback" + +# Experimental: this type is part of an experimental API and may change or be removed. +class PermissionDecisionSurface(Enum): + """Client surface that submitted the response. + + Client surface that submitted a permission response. + """ + COPILOT_APP = "copilot_app" + PROMPT_MODE = "prompt_mode" + SDK = "sdk" + TUI = "tui" + +class PermissionDecisionDeniedByContentExclusionPolicyKind(Enum): + DENIED_BY_CONTENT_EXCLUSION_POLICY = "denied-by-content-exclusion-policy" + +class PermissionDecisionDeniedByPermissionRequestHookKind(Enum): + DENIED_BY_PERMISSION_REQUEST_HOOK = "denied-by-permission-request-hook" + +class PermissionDecisionDeniedByRulesKind(Enum): + DENIED_BY_RULES = "denied-by-rules" + +class PermissionDecisionDeniedInteractivelyByUserKind(Enum): + DENIED_INTERACTIVELY_BY_USER = "denied-interactively-by-user" + +class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind(Enum): + DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER = "denied-no-approval-rule-and-could-not-request-from-user" + +class PermissionDecisionRejectKind(Enum): + REJECT = "reject" + +class PermissionDecisionUserNotAvailableKind(Enum): + USER_NOT_AVAILABLE = "user-not-available" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionLocationApplyParams: + """Working directory to load persisted location permissions for.""" + + working_directory: str + """Working directory whose persisted location permissions should be applied""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSSqliteExistsRequest': + def from_dict(obj: Any) -> 'PermissionLocationApplyParams': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionFSSqliteExistsRequest(session_id) + working_directory = from_str(obj.get("workingDirectory")) + return PermissionLocationApplyParams(working_directory) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + result["workingDirectory"] = from_str(self.working_directory) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class PermissionLocationType(Enum): + """Whether the location is a git repo or directory""" + + DIR = "dir" + REPO = "repo" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSSqliteExistsResult: - """Indicates whether the per-session SQLite database already exists.""" +class PermissionLocationResolveParams: + """Working directory to resolve into a location-permissions key.""" - exists: bool - """Whether the session database already exists""" + working_directory: str + """Working directory whose permission location should be resolved""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSSqliteExistsResult': + def from_dict(obj: Any) -> 'PermissionLocationResolveParams': assert isinstance(obj, dict) - exists = from_bool(obj.get("exists")) - return SessionFSSqliteExistsResult(exists) + working_directory = from_str(obj.get("workingDirectory")) + return PermissionLocationResolveParams(working_directory) def to_dict(self) -> dict: result: dict = {} - result["exists"] = from_bool(self.exists) + result["workingDirectory"] = from_str(self.working_directory) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class SessionFSSqliteQueryType(Enum): - """How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT - (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) - """ - EXEC = "exec" - QUERY = "query" - RUN = "run" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSStatRequest: - """Path whose metadata should be returned from the client-provided session filesystem.""" +class PermissionPathsAddParams: + """Directory path to add to the session's allowed directories.""" path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" + """Directory to add to the allow-list. The runtime resolves and validates the path before + adding. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSStatRequest': + def from_dict(obj: Any) -> 'PermissionPathsAddParams': assert isinstance(obj, dict) path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - return SessionFSStatRequest(path, session_id) + return PermissionPathsAddParams(path) def to_dict(self) -> dict: result: dict = {} result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSWriteFileRequest: - """File path, content to write, and optional mode for the client-provided session filesystem.""" - - content: str - """Content to write""" +class PermissionPathsAllowedCheckParams: + """Path to evaluate against the session's allowed directories.""" path: str - """Path using SessionFs conventions""" - - session_id: str - """Target session identifier""" - - mode: int | None = None - """Optional POSIX-style mode for newly created files""" + """Path to check against the session's allowed directories""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSWriteFileRequest': + def from_dict(obj: Any) -> 'PermissionPathsAllowedCheckParams': assert isinstance(obj, dict) - content = from_str(obj.get("content")) path = from_str(obj.get("path")) - session_id = from_str(obj.get("sessionId")) - mode = from_union([from_int, from_none], obj.get("mode")) - return SessionFSWriteFileRequest(content, path, session_id, mode) + return PermissionPathsAllowedCheckParams(path) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) result["path"] = from_str(self.path) - result["sessionId"] = from_str(self.session_id) - if self.mode is not None: - result["mode"] = from_union([from_int, from_none], self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionListFilter: - """Optional filter applied to the returned sessions""" - - branch: str | None = None - """Match sessions whose context.branch equals this value""" - - cwd: str | None = None - """Match sessions whose context.cwd equals this value""" - - git_root: str | None = None - """Match sessions whose context.gitRoot equals this value""" +class PermissionPathsAllowedCheckResult: + """Indicates whether the supplied path is within the session's allowed directories.""" - repository: str | None = None - """Match sessions whose context.repository equals this value""" + allowed: bool + """Whether the path is within the session's allowed directories""" @staticmethod - def from_dict(obj: Any) -> 'SessionListFilter': + def from_dict(obj: Any) -> 'PermissionPathsAllowedCheckResult': assert isinstance(obj, dict) - branch = from_union([from_str, from_none], obj.get("branch")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - git_root = from_union([from_str, from_none], obj.get("gitRoot")) - repository = from_union([from_str, from_none], obj.get("repository")) - return SessionListFilter(branch, cwd, git_root, repository) + allowed = from_bool(obj.get("allowed")) + return PermissionPathsAllowedCheckResult(allowed) def to_dict(self) -> dict: result: dict = {} - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.git_root is not None: - result["gitRoot"] = from_union([from_str, from_none], self.git_root) - if self.repository is not None: - result["repository"] = from_union([from_str, from_none], self.repository) + result["allowed"] = from_bool(self.allowed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionLoadDeferredRepoHooksResult: - """Queued repo-level startup prompts and the total hook command count after loading.""" +class PermissionPathsList: + """Snapshot of the session's allow-listed directories and primary working directory.""" - hook_count: int - """Total hook command count (user + plugin + repo) loaded for the session by this call. - Captured atomically with startupPrompts so callers don't need to read a separate counter. - """ - startup_prompts: list[str] - """Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo - configs were pending, or when disableAllHooks is set. - """ + directories: list[str] + """All directories currently allowed for tool access on this session.""" + + primary: str + """The primary working directory for this session.""" @staticmethod - def from_dict(obj: Any) -> 'SessionLoadDeferredRepoHooksResult': + def from_dict(obj: Any) -> 'PermissionPathsList': assert isinstance(obj, dict) - hook_count = from_int(obj.get("hookCount")) - startup_prompts = from_list(from_str, obj.get("startupPrompts")) - return SessionLoadDeferredRepoHooksResult(hook_count, startup_prompts) + directories = from_list(from_str, obj.get("directories")) + primary = from_str(obj.get("primary")) + return PermissionPathsList(directories, primary) def to_dict(self) -> dict: result: dict = {} - result["hookCount"] = from_int(self.hook_count) - result["startupPrompts"] = from_list(from_str, self.startup_prompts) + result["directories"] = from_list(from_str, self.directories) + result["primary"] = from_str(self.primary) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionModelList: - """The list of models available to this session.""" - - list: list[Any] - """Available models, ordered with the most preferred default first.""" +class PermissionPathsUpdatePrimaryParams: + """Directory path to set as the session's new primary working directory.""" - quota_snapshots: dict[str, Any] | None = None - """Per-quota snapshots returned alongside the model list, keyed by quota type.""" + path: str + """Directory to set as the new primary working directory for the session's permission policy.""" @staticmethod - def from_dict(obj: Any) -> 'SessionModelList': + def from_dict(obj: Any) -> 'PermissionPathsUpdatePrimaryParams': assert isinstance(obj, dict) - list = from_list(lambda x: x, obj.get("list")) - quota_snapshots = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("quotaSnapshots")) - return SessionModelList(list, quota_snapshots) + path = from_str(obj.get("path")) + return PermissionPathsUpdatePrimaryParams(path) def to_dict(self) -> dict: result: dict = {} - result["list"] = from_list(lambda x: x, self.list) - if self.quota_snapshots is not None: - result["quotaSnapshots"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.quota_snapshots) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionPruneResult: - """Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes - freed, and the dry-run flag. - """ - candidates: list[str] - """Session IDs that would be deleted in dry-run mode (always empty otherwise)""" - - deleted: list[str] - """Session IDs that were deleted (always empty in dry-run mode)""" - - dry_run: bool - """True when no deletions were actually performed""" - - freed_bytes: int - """Total bytes freed (actual when not dry-run, projected when dry-run)""" +class PermissionPathsWorkspaceCheckParams: + """Path to evaluate against the session's workspace (primary) directory.""" - skipped: list[str] - """Session IDs that were skipped (e.g., named sessions)""" + path: str + """Path to check against the session workspace directory""" @staticmethod - def from_dict(obj: Any) -> 'SessionPruneResult': + def from_dict(obj: Any) -> 'PermissionPathsWorkspaceCheckParams': assert isinstance(obj, dict) - candidates = from_list(from_str, obj.get("candidates")) - deleted = from_list(from_str, obj.get("deleted")) - dry_run = from_bool(obj.get("dryRun")) - freed_bytes = from_int(obj.get("freedBytes")) - skipped = from_list(from_str, obj.get("skipped")) - return SessionPruneResult(candidates, deleted, dry_run, freed_bytes, skipped) + path = from_str(obj.get("path")) + return PermissionPathsWorkspaceCheckParams(path) def to_dict(self) -> dict: result: dict = {} - result["candidates"] = from_list(from_str, self.candidates) - result["deleted"] = from_list(from_str, self.deleted) - result["dryRun"] = from_bool(self.dry_run) - result["freedBytes"] = from_int(self.freed_bytes) - result["skipped"] = from_list(from_str, self.skipped) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionSetCredentialsParams: - """New auth credentials to install on the session. Omit to leave credentials unchanged.""" +class PermissionPathsWorkspaceCheckResult: + """Indicates whether the supplied path is within the session's workspace directory.""" - credentials: AuthInfo | None = None - """The new auth credentials to install on the session. When omitted or `undefined`, the call - is a no-op and the session's existing credentials are preserved. The runtime stores the - value verbatim and uses it for outbound model/API requests; it does NOT re-validate or - re-fetch the associated Copilot user response. Several variants carry secret material; - treat this method's params as containing secrets at rest and in transit. - """ + allowed: bool + """Whether the path is within the session workspace directory""" @staticmethod - def from_dict(obj: Any) -> 'SessionSetCredentialsParams': + def from_dict(obj: Any) -> 'PermissionPathsWorkspaceCheckResult': assert isinstance(obj, dict) - credentials = from_union([_load_AuthInfo, from_none], obj.get("credentials")) - return SessionSetCredentialsParams(credentials) + allowed = from_bool(obj.get("allowed")) + return PermissionPathsWorkspaceCheckResult(allowed) def to_dict(self) -> dict: result: dict = {} - if self.credentials is not None: - result["credentials"] = from_union([lambda x: (x).to_dict(), from_none], self.credentials) + result["allowed"] = from_bool(self.allowed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionSetCredentialsResult: - """Indicates whether the credential update succeeded.""" +class PermissionPromptShownNotification: + """Notification payload describing the permission prompt that the client just rendered.""" + + message: str + """Human-readable description of the prompt the user is being asked to approve. Used by the + runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, + desktop notification). + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionPromptShownNotification': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + return PermissionPromptShownNotification(message) + + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + return result +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionRequestResult: + """Indicates whether the permission decision was applied; false when the request was already + resolved. + """ success: bool - """Whether the operation succeeded""" + """Whether the permission request was handled successfully""" @staticmethod - def from_dict(obj: Any) -> 'SessionSetCredentialsResult': + def from_dict(obj: Any) -> 'PermissionRequestResult': assert isinstance(obj, dict) success = from_bool(obj.get("success")) - return SessionSetCredentialsResult(success) + return PermissionRequestResult(success) def to_dict(self) -> dict: result: dict = {} @@ -4921,131 +6302,149 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionSizes: - """Map of sessionId -> on-disk size in bytes for each session's workspace directory.""" +class PermissionRulesSet: + """If specified, replaces the session's approved/denied permission rules. Omit to leave the + current rules unchanged. + """ + approved: list[PermissionRule] + """Rules that auto-approve matching requests""" - sizes: dict[str, int] - """Map of sessionId -> on-disk size in bytes for the session's workspace directory""" + denied: list[PermissionRule] + """Rules that auto-deny matching requests""" @staticmethod - def from_dict(obj: Any) -> 'SessionSizes': + def from_dict(obj: Any) -> 'PermissionRulesSet': assert isinstance(obj, dict) - sizes = from_dict(from_int, obj.get("sizes")) - return SessionSizes(sizes) + approved = from_list(PermissionRule.from_dict, obj.get("approved")) + denied = from_list(PermissionRule.from_dict, obj.get("denied")) + return PermissionRulesSet(approved, denied) def to_dict(self) -> dict: result: dict = {} - result["sizes"] = from_dict(from_int, self.sizes) + result["approved"] = from_list(lambda x: to_class(PermissionRule, x), self.approved) + result["denied"] = from_list(lambda x: to_class(PermissionRule, x), self.denied) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionUpdateOptionsResult: - """Indicates whether the session options patch was applied successfully.""" - - success: bool - """Whether the operation succeeded""" +class PermissionUrlsConfig: + """If specified, replaces the session's URL-permission policy. The runtime constructs a + fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy + unchanged. + """ + initial_allowed: list[str] | None = None + """Initial list of allowed URL/domain patterns. Patterns may include path components. + Ignored when `unrestricted` is true. + """ + unrestricted: bool | None = None + """If true, the runtime allows access to all URLs without prompting. Initial allow-list is + ignored when this is true. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionUpdateOptionsResult': + def from_dict(obj: Any) -> 'PermissionUrlsConfig': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return SessionUpdateOptionsResult(success) + initial_allowed = from_union([lambda x: from_list(from_str, x), from_none], obj.get("initialAllowed")) + unrestricted = from_union([from_bool, from_none], obj.get("unrestricted")) + return PermissionUrlsConfig(initial_allowed, unrestricted) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + if self.initial_allowed is not None: + result["initialAllowed"] = from_union([lambda x: from_list(from_str, x), from_none], self.initial_allowed) + if self.unrestricted is not None: + result["unrestricted"] = from_union([from_bool, from_none], self.unrestricted) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsBulkDeleteRequest: - """Session IDs to close, deactivate, and delete from disk.""" +class PermissionUrlsSetUnrestrictedModeParams: + """Whether the URL-permission policy should run in unrestricted mode.""" - session_ids: list[str] - """Session IDs to close, deactivate, and delete from disk""" + enabled: bool + """Whether to allow access to all URLs without prompting. Toggles the runtime's + URL-permission policy in place. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionsBulkDeleteRequest': + def from_dict(obj: Any) -> 'PermissionUrlsSetUnrestrictedModeParams': assert isinstance(obj, dict) - session_ids = from_list(from_str, obj.get("sessionIds")) - return SessionsBulkDeleteRequest(session_ids) + enabled = from_bool(obj.get("enabled")) + return PermissionUrlsSetUnrestrictedModeParams(enabled) def to_dict(self) -> dict: result: dict = {} - result["sessionIds"] = from_list(from_str, self.session_ids) + result["enabled"] = from_bool(self.enabled) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsCheckInUseRequest: - """Session IDs to test for live in-use locks.""" - - session_ids: list[str] - """Session IDs to test for live in-use locks""" +class PermissionsConfigureAdditionalContentExclusionPolicyRuleSource: + """Source descriptor for a `session.permissions.configure` content-exclusion rule, with + source name and type. + """ + name: str + type: str @staticmethod - def from_dict(obj: Any) -> 'SessionsCheckInUseRequest': + def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRuleSource': assert isinstance(obj, dict) - session_ids = from_list(from_str, obj.get("sessionIds")) - return SessionsCheckInUseRequest(session_ids) + name = from_str(obj.get("name")) + type = from_str(obj.get("type")) + return PermissionsConfigureAdditionalContentExclusionPolicyRuleSource(name, type) def to_dict(self) -> dict: result: dict = {} - result["sessionIds"] = from_list(from_str, self.session_ids) + result["name"] = from_str(self.name) + result["type"] = from_str(self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsCheckInUseResult: - """Session IDs from the input set that are currently in use by another process.""" +class PermissionsConfigureResult: + """Indicates whether the operation succeeded.""" - in_use: list[str] - """Session IDs from the input set that are currently held by another running process via an - alive lock file - """ + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsCheckInUseResult': + def from_dict(obj: Any) -> 'PermissionsConfigureResult': assert isinstance(obj, dict) - in_use = from_list(from_str, obj.get("inUse")) - return SessionsCheckInUseResult(in_use) + success = from_bool(obj.get("success")) + return PermissionsConfigureResult(success) def to_dict(self) -> dict: result: dict = {} - result["inUse"] = from_list(from_str, self.in_use) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsCloseRequest: - """Session ID to close.""" +class PermissionsFolderTrustAddTrustedResult: + """Indicates whether the operation succeeded.""" - session_id: str - """Session ID to close""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsCloseRequest': + def from_dict(obj: Any) -> 'PermissionsFolderTrustAddTrustedResult': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsCloseRequest(session_id) + success = from_bool(obj.get("success")) + return PermissionsFolderTrustAddTrustedResult(success) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsCloseResult: - """Closes a session: emits shutdown, flushes pending events to disk, releases the in-use - lock, disposes the active session. Idempotent: succeeds even if the session is not - currently active. - """ +class PermissionsGetAllowAllRequest: + """No parameters.""" @staticmethod - def from_dict(obj: Any) -> 'SessionsCloseResult': + def from_dict(obj: Any) -> 'PermissionsGetAllowAllRequest': assert isinstance(obj, dict) - return SessionsCloseResult() + return PermissionsGetAllowAllRequest() def to_dict(self) -> dict: result: dict = {} @@ -5053,908 +6452,943 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsFindByPrefixRequest: - """UUID prefix to resolve to a unique session ID.""" +class PermissionsLocationsAddToolApprovalResult: + """Indicates whether the operation succeeded.""" - prefix: str - """UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when - there is no match or the prefix matches multiple sessions. - """ + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsFindByPrefixRequest': + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalResult': assert isinstance(obj, dict) - prefix = from_str(obj.get("prefix")) - return SessionsFindByPrefixRequest(prefix) + success = from_bool(obj.get("success")) + return PermissionsLocationsAddToolApprovalResult(success) def to_dict(self) -> dict: result: dict = {} - result["prefix"] = from_str(self.prefix) + result["success"] = from_bool(self.success) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class PermissionsModifyRulesScope(Enum): + """Whether the change applies to ephemeral session-scoped rules (cleared at session end) or + to location-scoped rules persisted via the location-permissions config file. + """ + LOCATION = "location" + SESSION = "session" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsFindByPrefixResult: - """Session ID matching the prefix, omitted when no unique match exists.""" +class PermissionsModifyRulesResult: + """Indicates whether the operation succeeded.""" - session_id: str | None = None - """Omitted when no unique session matches the prefix (no match or ambiguous)""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsFindByPrefixResult': + def from_dict(obj: Any) -> 'PermissionsModifyRulesResult': assert isinstance(obj, dict) - session_id = from_union([from_str, from_none], obj.get("sessionId")) - return SessionsFindByPrefixResult(session_id) + success = from_bool(obj.get("success")) + return PermissionsModifyRulesResult(success) def to_dict(self) -> dict: result: dict = {} - if self.session_id is not None: - result["sessionId"] = from_union([from_str, from_none], self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsFindByTaskIDRequest: - """GitHub task ID to look up.""" +class PermissionsNotifyPromptShownResult: + """Indicates whether the operation succeeded.""" - task_id: str - """GitHub task ID to look up""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsFindByTaskIDRequest': + def from_dict(obj: Any) -> 'PermissionsNotifyPromptShownResult': assert isinstance(obj, dict) - task_id = from_str(obj.get("taskId")) - return SessionsFindByTaskIDRequest(task_id) + success = from_bool(obj.get("success")) + return PermissionsNotifyPromptShownResult(success) def to_dict(self) -> dict: result: dict = {} - result["taskId"] = from_str(self.task_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsFindByTaskIDResult: - """ID of the local session bound to the given GitHub task, or omitted when none.""" +class PermissionsPathsAddResult: + """Indicates whether the operation succeeded.""" - session_id: str | None = None - """Omitted when no local session is bound to that GitHub task""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsFindByTaskIDResult': + def from_dict(obj: Any) -> 'PermissionsPathsAddResult': assert isinstance(obj, dict) - session_id = from_union([from_str, from_none], obj.get("sessionId")) - return SessionsFindByTaskIDResult(session_id) + success = from_bool(obj.get("success")) + return PermissionsPathsAddResult(success) def to_dict(self) -> dict: result: dict = {} - if self.session_id is not None: - result["sessionId"] = from_union([from_str, from_none], self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsForkRequest: - """Source session identifier to fork from, optional event-ID boundary, and optional friendly - name for the new session. - """ - session_id: str - """Source session ID to fork from""" - - name: str | None = None - """Optional friendly name to assign to the forked session.""" - - to_event_id: str | None = None - """Optional event ID boundary. When provided, the fork includes only events before this ID - (exclusive). When omitted, all events are included. - """ - +class PermissionsPathsListRequest: + """No parameters; returns the session's allow-listed directories.""" @staticmethod - def from_dict(obj: Any) -> 'SessionsForkRequest': + def from_dict(obj: Any) -> 'PermissionsPathsListRequest': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - name = from_union([from_str, from_none], obj.get("name")) - to_event_id = from_union([from_str, from_none], obj.get("toEventId")) - return SessionsForkRequest(session_id, name, to_event_id) + return PermissionsPathsListRequest() def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.to_event_id is not None: - result["toEventId"] = from_union([from_str, from_none], self.to_event_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsForkResult: - """Identifier and optional friendly name assigned to the newly forked session.""" - - session_id: str - """The new forked session's ID""" +class PermissionsPathsUpdatePrimaryResult: + """Indicates whether the operation succeeded.""" - name: str | None = None - """Friendly name assigned to the forked session, if any.""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsForkResult': + def from_dict(obj: Any) -> 'PermissionsPathsUpdatePrimaryResult': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - name = from_union([from_str, from_none], obj.get("name")) - return SessionsForkResult(session_id, name) + success = from_bool(obj.get("success")) + return PermissionsPathsUpdatePrimaryResult(success) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetEventFilePathRequest: - """Session ID whose event-log file path to compute.""" - - session_id: str - """Session ID whose event-log file path to compute""" - +class PermissionsPendingRequestsRequest: + """No parameters; returns currently-pending permission requests for the session.""" @staticmethod - def from_dict(obj: Any) -> 'SessionsGetEventFilePathRequest': + def from_dict(obj: Any) -> 'PermissionsPendingRequestsRequest': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsGetEventFilePathRequest(session_id) + return PermissionsPendingRequestsRequest() def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetEventFilePathResult: - """Absolute path to the session's events.jsonl file on disk.""" +class PermissionsResetSessionApprovalsRequest: + """Clears session-scoped tool permission approvals, and optionally the location-scoped ones.""" - file_path: str - """Absolute path to the session's events.jsonl file""" + include_location: bool | None = None + """Whether location-scoped approvals are cleared too. Defaults to `true`.""" @staticmethod - def from_dict(obj: Any) -> 'SessionsGetEventFilePathResult': + def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsRequest': assert isinstance(obj, dict) - file_path = from_str(obj.get("filePath")) - return SessionsGetEventFilePathResult(file_path) + include_location = from_union([from_bool, from_none], obj.get("includeLocation")) + return PermissionsResetSessionApprovalsRequest(include_location) def to_dict(self) -> dict: result: dict = {} - result["filePath"] = from_str(self.file_path) + if self.include_location is not None: + result["includeLocation"] = from_union([from_bool, from_none], self.include_location) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetLastForContextResult: - """Most-relevant session ID for the supplied context, or omitted when no sessions exist.""" +class PermissionsResetSessionApprovalsResult: + """Indicates whether the operation succeeded.""" - session_id: str | None = None - """Most-relevant session ID for the supplied context, or omitted when no sessions exist""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsGetLastForContextResult': + def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsResult': assert isinstance(obj, dict) - session_id = from_union([from_str, from_none], obj.get("sessionId")) - return SessionsGetLastForContextResult(session_id) + success = from_bool(obj.get("success")) + return PermissionsResetSessionApprovalsResult(success) def to_dict(self) -> dict: result: dict = {} - if self.session_id is not None: - result["sessionId"] = from_union([from_str, from_none], self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetPersistedRemoteSteerableRequest: - """Session ID to look up the persisted remote-steerable flag for.""" +class PermissionsSetApproveAllResult: + """Indicates whether the operation succeeded.""" - session_id: str - """Session ID to look up the persisted remote-steerable flag for""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsGetPersistedRemoteSteerableRequest': + def from_dict(obj: Any) -> 'PermissionsSetApproveAllResult': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsGetPersistedRemoteSteerableRequest(session_id) + success = from_bool(obj.get("success")) + return PermissionsSetApproveAllResult(success) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetPersistedRemoteSteerableResult: - """The session's persisted remote-steerable flag, or omitted when no value has been - persisted. - """ - remote_steerable: bool | None = None - """The session's persisted remote-steerable flag if recorded; omitted when no value has been - persisted +class PermissionsSetRequiredRequest: + """Toggles whether permission prompts should be bridged into session events for this client.""" + + required: bool + """Whether the client wants `permission.requested` events bridged from the session-owned + permission service. CLI clients that render prompt UI set this to `true` for as long as + their listener is mounted; headless callers leave it unset (the default is `false`). """ @staticmethod - def from_dict(obj: Any) -> 'SessionsGetPersistedRemoteSteerableResult': + def from_dict(obj: Any) -> 'PermissionsSetRequiredRequest': assert isinstance(obj, dict) - remote_steerable = from_union([from_bool, from_none], obj.get("remoteSteerable")) - return SessionsGetPersistedRemoteSteerableResult(remote_steerable) + required = from_bool(obj.get("required")) + return PermissionsSetRequiredRequest(required) def to_dict(self) -> dict: result: dict = {} - if self.remote_steerable is not None: - result["remoteSteerable"] = from_union([from_bool, from_none], self.remote_steerable) + result["required"] = from_bool(self.required) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsLoadDeferredRepoHooksRequest: - """Active session ID whose deferred repo-level hooks should be loaded.""" +class PermissionsSetRequiredResult: + """Indicates whether the operation succeeded.""" - session_id: str - """Active session ID whose deferred repo-level hooks should be loaded""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsLoadDeferredRepoHooksRequest': + def from_dict(obj: Any) -> 'PermissionsSetRequiredResult': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsLoadDeferredRepoHooksRequest(session_id) + success = from_bool(obj.get("success")) + return PermissionsSetRequiredResult(success) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsPruneOldRequest: - """Age threshold and optional flags controlling which old sessions are pruned (or simulated - when dryRun is true). - """ - older_than_days: int - """Delete sessions whose modifiedTime is at least this many days old""" - - dry_run: bool | None = None - """When true, only report what would be deleted without performing any deletion""" - - exclude_session_ids: list[str] | None = None - """Session IDs that should never be considered for pruning""" +class PermissionsUrlsSetUnrestrictedModeResult: + """Indicates whether the operation succeeded.""" - include_named: bool | None = None - """When true, named sessions (set via /rename) are also eligible for pruning""" + success: bool + """Whether the operation succeeded""" @staticmethod - def from_dict(obj: Any) -> 'SessionsPruneOldRequest': + def from_dict(obj: Any) -> 'PermissionsUrlsSetUnrestrictedModeResult': assert isinstance(obj, dict) - older_than_days = from_int(obj.get("olderThanDays")) - dry_run = from_union([from_bool, from_none], obj.get("dryRun")) - exclude_session_ids = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeSessionIds")) - include_named = from_union([from_bool, from_none], obj.get("includeNamed")) - return SessionsPruneOldRequest(older_than_days, dry_run, exclude_session_ids, include_named) + success = from_bool(obj.get("success")) + return PermissionsUrlsSetUnrestrictedModeResult(success) def to_dict(self) -> dict: result: dict = {} - result["olderThanDays"] = from_int(self.older_than_days) - if self.dry_run is not None: - result["dryRun"] = from_union([from_bool, from_none], self.dry_run) - if self.exclude_session_ids is not None: - result["excludeSessionIds"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_session_ids) - if self.include_named is not None: - result["includeNamed"] = from_union([from_bool, from_none], self.include_named) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsReleaseLockRequest: - """Session ID whose in-use lock should be released.""" +class PingRequest: + """Optional message to echo back to the caller.""" - session_id: str - """Session ID whose in-use lock should be released""" + message: str | None = None + """Optional message to echo back""" @staticmethod - def from_dict(obj: Any) -> 'SessionsReleaseLockRequest': + def from_dict(obj: Any) -> 'PingRequest': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsReleaseLockRequest(session_id) + message = from_union([from_str, from_none], obj.get("message")) + return PingRequest(message) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsReleaseLockResult: - """Release the in-use lock held by this process for the given session. No-op when this - process does not currently hold a lock for the session. +class PingResult: + """Server liveness response, including the echoed message, current server timestamp, and + protocol version. """ + message: str + """Echoed message (or default greeting)""" + + protocol_version: int + """Server protocol version number""" + + timestamp: datetime + """ISO 8601 timestamp when the server handled the ping""" + @staticmethod - def from_dict(obj: Any) -> 'SessionsReleaseLockResult': + def from_dict(obj: Any) -> 'PingResult': assert isinstance(obj, dict) - return SessionsReleaseLockResult() + message = from_str(obj.get("message")) + protocol_version = from_int(obj.get("protocolVersion")) + timestamp = from_datetime(obj.get("timestamp")) + return PingResult(message, protocol_version, timestamp) def to_dict(self) -> dict: result: dict = {} + result["message"] = from_str(self.message) + result["protocolVersion"] = from_int(self.protocol_version) + result["timestamp"] = self.timestamp.isoformat() return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsReloadPluginHooksRequest: - """Active session ID and an optional flag for deferring repo-level hooks until folder trust.""" +class PlanReadResult: + """Existence, contents, and resolved path of the session plan file.""" - session_id: str - """Active session ID to reload hooks for""" + exists: bool + """Whether the plan file exists in the workspace""" - defer_repo_hooks: bool | None = None - """When true, skip repo-level hooks. Use before folder trust is confirmed; - loadDeferredRepoHooks loads them post-trust. - """ + content: str | None = None + """The content of the plan file, or null if it does not exist""" - @staticmethod - def from_dict(obj: Any) -> 'SessionsReloadPluginHooksRequest': + path: str | None = None + """Absolute file path of the plan file, or null if workspace is not enabled""" + + @staticmethod + def from_dict(obj: Any) -> 'PlanReadResult': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - defer_repo_hooks = from_union([from_bool, from_none], obj.get("deferRepoHooks")) - return SessionsReloadPluginHooksRequest(session_id, defer_repo_hooks) + exists = from_bool(obj.get("exists")) + content = from_union([from_none, from_str], obj.get("content")) + path = from_union([from_none, from_str], obj.get("path")) + return PlanReadResult(exists, content, path) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) - if self.defer_repo_hooks is not None: - result["deferRepoHooks"] = from_union([from_bool, from_none], self.defer_repo_hooks) + result["exists"] = from_bool(self.exists) + result["content"] = from_union([from_none, from_str], self.content) + result["path"] = from_union([from_none, from_str], self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsReloadPluginHooksResult: - """Reload all hooks (user, plugin, optionally repo) and apply them to the active session. - Call after installing or removing plugins so their hooks take effect immediately. No-op - when no active session matches the given sessionId. +class PlanSQLTodosRow: + """A single todo row read from the session SQL `todos` table. All fields are optional + because the SQL schema is best-effort and the agent may not have populated every column. """ + description: str | None = None + """Todo description.""" + + id: str | None = None + """Todo identifier.""" + + status: str | None = None + """Todo status.""" + + title: str | None = None + """Todo title.""" + @staticmethod - def from_dict(obj: Any) -> 'SessionsReloadPluginHooksResult': + def from_dict(obj: Any) -> 'PlanSQLTodosRow': assert isinstance(obj, dict) - return SessionsReloadPluginHooksResult() + description = from_union([from_str, from_none], obj.get("description")) + id = from_union([from_str, from_none], obj.get("id")) + status = from_union([from_str, from_none], obj.get("status")) + title = from_union([from_str, from_none], obj.get("title")) + return PlanSQLTodosRow(description, id, status, title) def to_dict(self) -> dict: result: dict = {} + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.id is not None: + result["id"] = from_union([from_str, from_none], self.id) + if self.status is not None: + result["status"] = from_union([from_str, from_none], self.status) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsSaveRequest: - """Session ID whose pending events should be flushed to disk.""" +class PlanSQLTodoDependency: + """A single dependency edge read from the session SQL `todo_deps` table, indicating that one + todo must complete before another. + """ + depends_on: str + """ID of the todo it depends on.""" - session_id: str - """Session ID whose pending events should be flushed to disk""" + todo_id: str + """ID of the todo that has the dependency.""" @staticmethod - def from_dict(obj: Any) -> 'SessionsSaveRequest': + def from_dict(obj: Any) -> 'PlanSQLTodoDependency': assert isinstance(obj, dict) - session_id = from_str(obj.get("sessionId")) - return SessionsSaveRequest(session_id) + depends_on = from_str(obj.get("dependsOn")) + todo_id = from_str(obj.get("todoId")) + return PlanSQLTodoDependency(depends_on, todo_id) def to_dict(self) -> dict: result: dict = {} - result["sessionId"] = from_str(self.session_id) + result["dependsOn"] = from_str(self.depends_on) + result["todoId"] = from_str(self.todo_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsSaveResult: - """Flush a session's pending events to disk. No-op when no writer exists for the session - (e.g., already closed). - """ +class PlanUpdateRequest: + """Replacement contents to write to the session plan file.""" + + content: str + """The new content for the plan file""" + @staticmethod - def from_dict(obj: Any) -> 'SessionsSaveResult': + def from_dict(obj: Any) -> 'PlanUpdateRequest': assert isinstance(obj, dict) - return SessionsSaveResult() + content = from_str(obj.get("content")) + return PlanUpdateRequest(content) def to_dict(self) -> dict: result: dict = {} + result["content"] = from_str(self.content) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsSetAdditionalPluginsResult: - """Replace the manager-wide additional plugins. New session creations and subsequent hook - reloads see the new set; already-running sessions keep their existing hook installation - until the next reload. - """ +class Plugin: + """Session plugin metadata, with name, marketplace, optional version, and enabled state.""" + + enabled: bool + """Whether the plugin is currently enabled""" + + marketplace: str + """Marketplace the plugin came from""" + + name: str + """Plugin name""" + + version: str | None = None + """Installed version""" + @staticmethod - def from_dict(obj: Any) -> 'SessionsSetAdditionalPluginsResult': + def from_dict(obj: Any) -> 'Plugin': assert isinstance(obj, dict) - return SessionsSetAdditionalPluginsResult() + enabled = from_bool(obj.get("enabled")) + marketplace = from_str(obj.get("marketplace")) + name = from_str(obj.get("name")) + version = from_union([from_str, from_none], obj.get("version")) + return Plugin(enabled, marketplace, name, version) def to_dict(self) -> dict: result: dict = {} + result["enabled"] = from_bool(self.enabled) + result["marketplace"] = from_str(self.marketplace) + result["name"] = from_str(self.name) + if self.version is not None: + result["version"] = from_union([from_str, from_none], self.version) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ShellExecRequest: - """Shell command to run, with optional working directory and timeout in milliseconds.""" +class PluginUpdateResult: + """Result of updating a single plugin.""" - command: str - """Shell command to execute""" + skills_installed: int + """Number of skills discovered and installed after the update""" - cwd: str | None = None - """Working directory (defaults to session working directory)""" + new_version: str | None = None + """Version after the update, when reported by the plugin manifest""" - timeout: int | None = None - """Timeout in milliseconds (default: 30000)""" + previous_version: str | None = None + """Version that was previously installed, when available""" @staticmethod - def from_dict(obj: Any) -> 'ShellExecRequest': + def from_dict(obj: Any) -> 'PluginUpdateResult': assert isinstance(obj, dict) - command = from_str(obj.get("command")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - timeout = from_union([from_int, from_none], obj.get("timeout")) - return ShellExecRequest(command, cwd, timeout) + skills_installed = from_int(obj.get("skillsInstalled")) + new_version = from_union([from_str, from_none], obj.get("newVersion")) + previous_version = from_union([from_str, from_none], obj.get("previousVersion")) + return PluginUpdateResult(skills_installed, new_version, previous_version) def to_dict(self) -> dict: result: dict = {} - result["command"] = from_str(self.command) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.timeout is not None: - result["timeout"] = from_union([from_int, from_none], self.timeout) + result["skillsInstalled"] = from_int(self.skills_installed) + if self.new_version is not None: + result["newVersion"] = from_union([from_str, from_none], self.new_version) + if self.previous_version is not None: + result["previousVersion"] = from_union([from_str, from_none], self.previous_version) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ShellExecResult: - """Identifier of the spawned process, used to correlate streamed output and exit - notifications. +class PluginsMarketplacesAddRequest: + """Marketplace source and optional working directory for relative-path resolution.""" + + source: str + """Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" + (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL + (user@host:path), or a local path. The marketplace's own name (from its manifest) is used + as the registration key. + """ + working_directory: str | None = None + """Working directory used to resolve relative local paths in `source`. Defaults to the + server's current working directory. """ - process_id: str - """Unique identifier for tracking streamed output""" @staticmethod - def from_dict(obj: Any) -> 'ShellExecResult': + def from_dict(obj: Any) -> 'PluginsMarketplacesAddRequest': assert isinstance(obj, dict) - process_id = from_str(obj.get("processId")) - return ShellExecResult(process_id) + source = from_str(obj.get("source")) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + return PluginsMarketplacesAddRequest(source, working_directory) def to_dict(self) -> dict: result: dict = {} - result["processId"] = from_str(self.process_id) + result["source"] = from_str(self.source) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class ShellKillSignal(Enum): - """Signal to send (default: SIGTERM)""" - - SIGINT = "SIGINT" - SIGKILL = "SIGKILL" - SIGTERM = "SIGTERM" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ShellKillResult: - """Indicates whether the signal was delivered; false if the process was unknown or already - exited. - """ - killed: bool - """Whether the signal was sent successfully""" +class PluginsMarketplacesBrowseRequest: + """Name of the marketplace whose plugin catalog to fetch.""" + + name: str + """Marketplace name to browse""" @staticmethod - def from_dict(obj: Any) -> 'ShellKillResult': + def from_dict(obj: Any) -> 'PluginsMarketplacesBrowseRequest': assert isinstance(obj, dict) - killed = from_bool(obj.get("killed")) - return ShellKillResult(killed) + name = from_str(obj.get("name")) + return PluginsMarketplacesBrowseRequest(name) def to_dict(self) -> dict: result: dict = {} - result["killed"] = from_bool(self.killed) + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ShutdownRequest: - """Parameters for shutting down the session""" - - reason: str | None = None - """Optional human-readable reason. Typically the message of the error that triggered - shutdown when type is 'error'. - """ - type: ShutdownType | None = None - """Why the session is being shut down. Defaults to "routine" when omitted.""" +class PluginsMarketplacesRefreshRequest: + name: str | None = None + """Marketplace name to refresh. When omitted, every registered marketplace is refreshed.""" @staticmethod - def from_dict(obj: Any) -> 'ShutdownRequest': + def from_dict(obj: Any) -> 'PluginsMarketplacesRefreshRequest': assert isinstance(obj, dict) - reason = from_union([from_str, from_none], obj.get("reason")) - type = from_union([ShutdownType, from_none], obj.get("type")) - return ShutdownRequest(reason, type) + name = from_union([from_str, from_none], obj.get("name")) + return PluginsMarketplacesRefreshRequest(name) def to_dict(self) -> dict: result: dict = {} - if self.reason is not None: - result["reason"] = from_union([from_str, from_none], self.reason) - if self.type is not None: - result["type"] = from_union([lambda x: to_enum(ShutdownType, x), from_none], self.type) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Skill: - """Schema for the `Skill` type.""" - - description: str - """Description of what the skill does""" - - enabled: bool - """Whether the skill is currently enabled""" +class PluginsMarketplacesRemoveRequest: + """Name of the marketplace to remove and an optional force flag.""" name: str - """Unique identifier for the skill""" - - source: SkillSource - """Source location type (e.g., project, personal-copilot, plugin, builtin)""" + """Marketplace name to remove""" - user_invocable: bool - """Whether the skill can be invoked by the user as a slash command""" - - path: str | None = None - """Absolute path to the skill file""" - - plugin_name: str | None = None - """Name of the plugin that provides the skill, when source is 'plugin'""" + force: bool | None = None + """When true, also uninstall every plugin sourced from this marketplace. When false + (default), removal is a no-op if any plugin from this marketplace is installed and the + dependent plugin names are returned in the result. + """ @staticmethod - def from_dict(obj: Any) -> 'Skill': + def from_dict(obj: Any) -> 'PluginsMarketplacesRemoveRequest': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - enabled = from_bool(obj.get("enabled")) name = from_str(obj.get("name")) - source = SkillSource(obj.get("source")) - user_invocable = from_bool(obj.get("userInvocable")) - path = from_union([from_str, from_none], obj.get("path")) - plugin_name = from_union([from_str, from_none], obj.get("pluginName")) - return Skill(description, enabled, name, source, user_invocable, path, plugin_name) + force = from_union([from_bool, from_none], obj.get("force")) + return PluginsMarketplacesRemoveRequest(name, force) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["enabled"] = from_bool(self.enabled) result["name"] = from_str(self.name) - result["source"] = to_enum(SkillSource, self.source) - result["userInvocable"] = from_bool(self.user_invocable) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.plugin_name is not None: - result["pluginName"] = from_union([from_str, from_none], self.plugin_name) + if self.force is not None: + result["force"] = from_union([from_bool, from_none], self.force) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsDisableRequest: - """Name of the skill to disable for the session.""" +class ProviderAddResult: + """The selectable model entries synthesized for the models added by this call.""" - name: str - """Name of the skill to disable""" + models: list[Any] + """Synthesized selectable model entries for the newly added BYOK models, each under its + provider-qualified selection id (`provider/id`). Empty when only providers were added. + """ @staticmethod - def from_dict(obj: Any) -> 'SkillsDisableRequest': + def from_dict(obj: Any) -> 'ProviderAddResult': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - return SkillsDisableRequest(name) + models = from_list(lambda x: x, obj.get("models")) + return ProviderAddResult(models) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) + result["models"] = from_list(lambda x: x, self.models) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsDiscoverRequest: - """Optional project paths and additional skill directories to include in discovery.""" +class ProviderSessionToken: + """Short-lived, rotating credential the caller must send on every request, in addition to + `apiKey` if one is present. Omitted when the endpoint does not require one. + """ + header: str + """HTTP header name the token must be sent under.""" - project_paths: list[str] | None = None - """Optional list of project directory paths to scan for project-scoped skills""" + token: str + """The short-lived token value.""" - skill_directories: list[str] | None = None - """Optional list of additional skill directory paths to include""" + expires_at: datetime | None = None + """When the token expires, if known. Callers should refresh by calling `getEndpoint` again + before this time, or reactively on any 401/403 response from `baseUrl`. + """ + model: str | None = None + """The model the token is bound to, when applicable. When set, the token is only valid for + requests against this model. + """ @staticmethod - def from_dict(obj: Any) -> 'SkillsDiscoverRequest': + def from_dict(obj: Any) -> 'ProviderSessionToken': assert isinstance(obj, dict) - project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) - skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skillDirectories")) - return SkillsDiscoverRequest(project_paths, skill_directories) + header = from_str(obj.get("header")) + token = from_str(obj.get("token")) + expires_at = from_union([from_datetime, from_none], obj.get("expiresAt")) + model = from_union([from_str, from_none], obj.get("model")) + return ProviderSessionToken(header, token, expires_at, model) def to_dict(self) -> dict: result: dict = {} - if self.project_paths is not None: - result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) - if self.skill_directories is not None: - result["skillDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories) + result["header"] = from_str(self.header) + result["token"] = from_str(self.token) + if self.expires_at is not None: + result["expiresAt"] = from_union([lambda x: x.isoformat(), from_none], self.expires_at) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsEnableRequest: - """Name of the skill to enable for the session.""" - - name: str - """Name of the skill to enable""" +class ProviderTokenAcquireResult: + """A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as + `Authorization: Bearer ` on the outbound request and does no caching; the SDK + consumer owns token caching and refresh. + """ + token: str + """The bearer token value (without the `Bearer ` prefix).""" @staticmethod - def from_dict(obj: Any) -> 'SkillsEnableRequest': + def from_dict(obj: Any) -> 'ProviderTokenAcquireResult': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - return SkillsEnableRequest(name) + token = from_str(obj.get("token")) + return ProviderTokenAcquireResult(token) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) + result["token"] = from_str(self.token) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsInvokedSkill: - """Schema for the `SkillsInvokedSkill` type.""" +class PushGitHubRepoRef: + """Repository the commit belongs to - content: str - """Full content of the skill file""" + Pointer to a GitHub repository. - invoked_at_turn: int - """Turn number when the skill was invoked""" + Repository the release belongs to + + Repository the workflow run belongs to + Repository pointer + + Repository the file lives in + + Repository the revision belongs to + """ name: str - """Unique identifier for the skill""" + """Repository name (without owner)""" - path: str - """Path to the SKILL.md file""" + owner: str + """Repository owner login (user or organization)""" - allowed_tools: list[str] | None = None - """Tools that should be auto-approved when this skill is active, captured at invocation time""" + id: int | None = None + """Numeric GitHub repository id""" @staticmethod - def from_dict(obj: Any) -> 'SkillsInvokedSkill': + def from_dict(obj: Any) -> 'PushGitHubRepoRef': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - invoked_at_turn = from_int(obj.get("invokedAtTurn")) name = from_str(obj.get("name")) - path = from_str(obj.get("path")) - allowed_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("allowedTools")) - return SkillsInvokedSkill(content, invoked_at_turn, name, path, allowed_tools) + owner = from_str(obj.get("owner")) + id = from_union([from_int, from_none], obj.get("id")) + return PushGitHubRepoRef(name, owner, id) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["invokedAtTurn"] = from_int(self.invoked_at_turn) result["name"] = from_str(self.name) - result["path"] = from_str(self.path) - if self.allowed_tools is not None: - result["allowedTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.allowed_tools) + result["owner"] = from_str(self.owner) + if self.id is not None: + result["id"] = from_union([from_int, from_none], self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsLoadDiagnostics: - """Diagnostics from reloading skill definitions, with warnings and errors as separate lists.""" +class PushAttachmentFileLineRange: + """Optional line range to scope the attachment to a specific section of the file - errors: list[str] - """Errors emitted while loading skills (e.g. skills that failed to load entirely)""" + Line range the snippet covers + """ + end: int + """End line number (1-based, inclusive)""" - warnings: list[str] - """Warnings emitted while loading skills (e.g. skills that loaded but had issues)""" + start: int + """Start line number (1-based)""" @staticmethod - def from_dict(obj: Any) -> 'SkillsLoadDiagnostics': + def from_dict(obj: Any) -> 'PushAttachmentFileLineRange': assert isinstance(obj, dict) - errors = from_list(from_str, obj.get("errors")) - warnings = from_list(from_str, obj.get("warnings")) - return SkillsLoadDiagnostics(errors, warnings) + end = from_int(obj.get("end")) + start = from_int(obj.get("start")) + return PushAttachmentFileLineRange(end, start) def to_dict(self) -> dict: result: dict = {} - result["errors"] = from_list(from_str, self.errors) - result["warnings"] = from_list(from_str, self.warnings) + result["end"] = from_int(self.end) + result["start"] = from_int(self.start) return result -class SlashCommandAgentPromptResultKind(Enum): - AGENT_PROMPT = "agent-prompt" - -class SlashCommandCompletedResultKind(Enum): - COMPLETED = "completed" +class PushAttachmentGitHubReferenceTypeEnum(Enum): + """Type of GitHub reference""" -class SlashCommandInvocationResultKind(Enum): - AGENT_PROMPT = "agent-prompt" - COMPLETED = "completed" - SELECT_SUBCOMMAND = "select-subcommand" - TEXT = "text" + DISCUSSION = "discussion" + ISSUE = "issue" + PR = "pr" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandSelectSubcommandOption: - """Schema for the `SlashCommandSelectSubcommandOption` type.""" +class PushAttachmentSelectionDetailsEnd: + """End position of the selection""" - description: str - """Human-readable description of the subcommand""" + character: int + """End character offset within the line (0-based)""" - name: str - """Subcommand name to invoke""" + line: int + """End line number (0-based)""" - group: str | None = None - """Optional group label for organizing options""" + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentSelectionDetailsEnd': + assert isinstance(obj, dict) + character = from_int(obj.get("character")) + line = from_int(obj.get("line")) + return PushAttachmentSelectionDetailsEnd(character, line) + + def to_dict(self) -> dict: + result: dict = {} + result["character"] = from_int(self.character) + result["line"] = from_int(self.line) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentSelectionDetailsStart: + """Start position of the selection""" + + character: int + """Start character offset within the line (0-based)""" + + line: int + """Start line number (0-based)""" @staticmethod - def from_dict(obj: Any) -> 'SlashCommandSelectSubcommandOption': + def from_dict(obj: Any) -> 'PushAttachmentSelectionDetailsStart': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - name = from_str(obj.get("name")) - group = from_union([from_str, from_none], obj.get("group")) - return SlashCommandSelectSubcommandOption(description, name, group) + character = from_int(obj.get("character")) + line = from_int(obj.get("line")) + return PushAttachmentSelectionDetailsStart(character, line) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["name"] = from_str(self.name) - if self.group is not None: - result["group"] = from_union([from_str, from_none], self.group) + result["character"] = from_int(self.character) + result["line"] = from_int(self.line) return result -class SlashCommandSelectSubcommandResultKind(Enum): - SELECT_SUBCOMMAND = "select-subcommand" +class PushAttachmentType(Enum): + BLOB = "blob" + DIRECTORY = "directory" + EXTENSION_CONTEXT = "extension_context" + FILE = "file" + GITHUB_ACTIONS_JOB = "github_actions_job" + GITHUB_COMMIT = "github_commit" + GITHUB_FILE = "github_file" + GITHUB_FILE_DIFF = "github_file_diff" + GITHUB_REFERENCE = "github_reference" + GITHUB_RELEASE = "github_release" + GITHUB_REPOSITORY = "github_repository" + GITHUB_SNIPPET = "github_snippet" + GITHUB_TREE_COMPARISON = "github_tree_comparison" + GITHUB_URL = "github_url" + SELECTION = "selection" -# Experimental: this type is part of an experimental API and may change or be removed. -class TaskExecutionMode(Enum): - """Whether task execution is synchronously awaited or managed in the background""" +class PushAttachmentBlobType(Enum): + BLOB = "blob" - BACKGROUND = "background" - SYNC = "sync" +class PushAttachmentFileType(Enum): + FILE = "file" + +class PushAttachmentGitHubActionsJobType(Enum): + GITHUB_ACTIONS_JOB = "github_actions_job" + +class PushAttachmentGitHubCommitType(Enum): + GITHUB_COMMIT = "github_commit" + +class PushAttachmentGitHubFileType(Enum): + GITHUB_FILE = "github_file" + +class PushAttachmentGitHubFileDiffType(Enum): + GITHUB_FILE_DIFF = "github_file_diff" # Experimental: this type is part of an experimental API and may change or be removed. -class TaskStatus(Enum): - """Current lifecycle status of the task""" +class PushAttachmentGitHubReferenceType(Enum): + GITHUB_REFERENCE = "github_reference" - CANCELLED = "cancelled" - COMPLETED = "completed" - FAILED = "failed" - IDLE = "idle" - RUNNING = "running" +class PushAttachmentGitHubReleaseType(Enum): + GITHUB_RELEASE = "github_release" -class TaskAgentInfoType(Enum): - AGENT = "agent" +class PushAttachmentGitHubRepositoryType(Enum): + GITHUB_REPOSITORY = "github_repository" + +class PushAttachmentGitHubSnippetType(Enum): + GITHUB_SNIPPET = "github_snippet" + +class PushAttachmentGitHubTreeComparisonType(Enum): + GITHUB_TREE_COMPARISON = "github_tree_comparison" + +class PushAttachmentGitHubURLType(Enum): + GITHUB_URL = "github_url" + +class PushAttachmentSelectionType(Enum): + SELECTION = "selection" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskProgressLine: - """Schema for the `TaskProgressLine` type.""" +class QueueBeginDeferredIdleDrainRequest: + """Inputs for starting a deferred-idle drain.""" - message: str - """Display message, e.g., "▸ bash", "✓ edit src/foo.ts\"""" - - timestamp: datetime - """ISO 8601 timestamp when this event occurred""" + active_background_work: bool + """Whether the host still has active background work.""" @staticmethod - def from_dict(obj: Any) -> 'TaskProgressLine': + def from_dict(obj: Any) -> 'QueueBeginDeferredIdleDrainRequest': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - timestamp = from_datetime(obj.get("timestamp")) - return TaskProgressLine(message, timestamp) + active_background_work = from_bool(obj.get("activeBackgroundWork")) + return QueueBeginDeferredIdleDrainRequest(active_background_work) def to_dict(self) -> dict: result: dict = {} - result["message"] = from_str(self.message) - result["timestamp"] = self.timestamp.isoformat() + result["activeBackgroundWork"] = from_bool(self.active_background_work) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class TaskShellInfoAttachmentMode(Enum): - """Whether the shell runs inside a managed PTY session or as an independent background - process - """ - ATTACHED = "attached" - DETACHED = "detached" - -class TaskInfoType(Enum): - AGENT = "agent" - SHELL = "shell" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskList: - """Background tasks currently tracked by the session.""" +class QueueBeginDeferredIdleDrainResult: + """Whether a deferred-idle drain should run.""" - tasks: list[TaskInfo] - """Currently tracked tasks""" + should_drain: bool + """True when the host should run finishDeferredIdleDrain asynchronously.""" @staticmethod - def from_dict(obj: Any) -> 'TaskList': + def from_dict(obj: Any) -> 'QueueBeginDeferredIdleDrainResult': assert isinstance(obj, dict) - tasks = from_list(_load_TaskInfo, obj.get("tasks")) - return TaskList(tasks) + should_drain = from_bool(obj.get("shouldDrain")) + return QueueBeginDeferredIdleDrainResult(should_drain) def to_dict(self) -> dict: result: dict = {} - result["tasks"] = from_list(lambda x: (x).to_dict(), self.tasks) + result["shouldDrain"] = from_bool(self.should_drain) return result -class TaskShellInfoType(Enum): - SHELL = "shell" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksCancelRequest: - """Identifier of the background task to cancel.""" +class QueueConsumeSystemNotificationsRequest: + """Internal filter for consuming queued system notifications.""" - id: str - """Task identifier""" + filter: Any + """Opaque runtime-owned filter object.""" @staticmethod - def from_dict(obj: Any) -> 'TasksCancelRequest': + def from_dict(obj: Any) -> 'QueueConsumeSystemNotificationsRequest': assert isinstance(obj, dict) - id = from_str(obj.get("id")) - return TasksCancelRequest(id) + filter = obj.get("filter") + return QueueConsumeSystemNotificationsRequest(filter) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_str(self.id) + result["filter"] = self.filter return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksCancelResult: - """Indicates whether the background task was successfully cancelled.""" +class QueueDeferSessionIdleRequest: + """Inputs for marking session.idle deferred in native state.""" - cancelled: bool - """Whether the task was successfully cancelled""" + aborted: bool + """Whether the deferred idle was caused by an aborted foreground turn.""" @staticmethod - def from_dict(obj: Any) -> 'TasksCancelResult': + def from_dict(obj: Any) -> 'QueueDeferSessionIdleRequest': assert isinstance(obj, dict) - cancelled = from_bool(obj.get("cancelled")) - return TasksCancelResult(cancelled) + aborted = from_bool(obj.get("aborted")) + return QueueDeferSessionIdleRequest(aborted) def to_dict(self) -> dict: result: dict = {} - result["cancelled"] = from_bool(self.cancelled) + result["aborted"] = from_bool(self.aborted) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksGetCurrentPromotableResult: - """The first sync-waiting task that can currently be promoted to background mode.""" +class QueueDuplicateAtRequest: + """Parameters for duplicating a queued item.""" - task: TaskInfo | None = None - """The first sync-waiting task (agent first, then shell) that can currently be promoted to - background mode. Omitted if no such task exists. The returned task is guaranteed to have - executionMode='sync' and canPromoteToBackground=true at the time of the call. - """ + id: str @staticmethod - def from_dict(obj: Any) -> 'TasksGetCurrentPromotableResult': + def from_dict(obj: Any) -> 'QueueDuplicateAtRequest': assert isinstance(obj, dict) - task = from_union([_load_TaskInfo, from_none], obj.get("task")) - return TasksGetCurrentPromotableResult(task) + id = from_str(obj.get("id")) + return QueueDuplicateAtRequest(id) def to_dict(self) -> dict: result: dict = {} - if self.task is not None: - result["task"] = from_union([lambda x: (x).to_dict(), from_none], self.task) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksGetProgressRequest: - """Identifier of the background task to fetch progress for.""" +class QueueDuplicateAtResult: + """Result of duplicating a queued item.""" id: str - """Task identifier (agent ID or shell ID)""" + """Fresh stable opaque id assigned to the duplicate.""" @staticmethod - def from_dict(obj: Any) -> 'TasksGetProgressRequest': + def from_dict(obj: Any) -> 'QueueDuplicateAtResult': assert isinstance(obj, dict) id = from_str(obj.get("id")) - return TasksGetProgressRequest(id) + return QueueDuplicateAtResult(id) def to_dict(self) -> dict: result: dict = {} @@ -5963,588 +7397,501 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksPromoteCurrentToBackgroundResult: - """The promoted task as it now exists in background mode, omitted if no promotable task was - waiting. - """ - task: TaskInfo | None = None - """The promoted task as it now exists in background mode, omitted if no promotable task was - waiting. Atomic operation: avoids the race window of getCurrentPromotable + - promoteToBackground. - """ +class QueueEnqueueResumePendingResult: + """Result of enqueueing the resume-pending wake item.""" + + queued: bool + """True when a wake item was newly queued.""" @staticmethod - def from_dict(obj: Any) -> 'TasksPromoteCurrentToBackgroundResult': + def from_dict(obj: Any) -> 'QueueEnqueueResumePendingResult': assert isinstance(obj, dict) - task = from_union([_load_TaskInfo, from_none], obj.get("task")) - return TasksPromoteCurrentToBackgroundResult(task) + queued = from_bool(obj.get("queued")) + return QueueEnqueueResumePendingResult(queued) def to_dict(self) -> dict: result: dict = {} - if self.task is not None: - result["task"] = from_union([lambda x: (x).to_dict(), from_none], self.task) + result["queued"] = from_bool(self.queued) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksPromoteToBackgroundRequest: - """Identifier of the task to promote to background mode.""" +class QueueFinishDeferredIdleDrainRequest: + """Inputs for completing a deferred-idle drain.""" - id: str - """Task identifier""" + active_background_work: bool + """Whether the host still has active background work.""" + + has_pending: bool + """Whether native queued work remains.""" @staticmethod - def from_dict(obj: Any) -> 'TasksPromoteToBackgroundRequest': + def from_dict(obj: Any) -> 'QueueFinishDeferredIdleDrainRequest': assert isinstance(obj, dict) - id = from_str(obj.get("id")) - return TasksPromoteToBackgroundRequest(id) + active_background_work = from_bool(obj.get("activeBackgroundWork")) + has_pending = from_bool(obj.get("hasPending")) + return QueueFinishDeferredIdleDrainRequest(active_background_work, has_pending) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_str(self.id) + result["activeBackgroundWork"] = from_bool(self.active_background_work) + result["hasPending"] = from_bool(self.has_pending) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksPromoteToBackgroundResult: - """Indicates whether the task was successfully promoted to background mode.""" +class QueueFinishDeferredIdleDrainResult: + """Action selected by the native deferred-idle drain.""" - promoted: bool - """Whether the task was successfully promoted to background mode""" + aborted: bool + """Whether the deferred idle was caused by an aborted foreground turn.""" + + action: str + """One of none, processQueue, or emitSessionIdle.""" @staticmethod - def from_dict(obj: Any) -> 'TasksPromoteToBackgroundResult': + def from_dict(obj: Any) -> 'QueueFinishDeferredIdleDrainResult': assert isinstance(obj, dict) - promoted = from_bool(obj.get("promoted")) - return TasksPromoteToBackgroundResult(promoted) + aborted = from_bool(obj.get("aborted")) + action = from_str(obj.get("action")) + return QueueFinishDeferredIdleDrainResult(aborted, action) def to_dict(self) -> dict: result: dict = {} - result["promoted"] = from_bool(self.promoted) + result["aborted"] = from_bool(self.aborted) + result["action"] = from_str(self.action) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksRefreshResult: - """Refresh metadata for any detached background shells the runtime knows about. Use after a - long pause to pick up exit/output state for shells running outside the agent loop. - """ +class QueueHasPendingResult: + """Whether the native queue has pending work.""" + + has_pending: bool + """True when queued or immediate native work is pending.""" + @staticmethod - def from_dict(obj: Any) -> 'TasksRefreshResult': + def from_dict(obj: Any) -> 'QueueHasPendingResult': assert isinstance(obj, dict) - return TasksRefreshResult() + has_pending = from_bool(obj.get("hasPending")) + return QueueHasPendingResult(has_pending) def to_dict(self) -> dict: result: dict = {} + result["hasPending"] = from_bool(self.has_pending) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class TasksRemoveRequest: - """Identifier of the completed or cancelled task to remove from tracking.""" +class SendAgentMode(Enum): + """Optional explicit agent mode. When omitted, the session's current mode is assigned. - id: str - """Task identifier""" + The UI mode the agent was in when this message was sent. Defaults to the session's + current mode. - @staticmethod - def from_dict(obj: Any) -> 'TasksRemoveRequest': - assert isinstance(obj, dict) - id = from_str(obj.get("id")) - return TasksRemoveRequest(id) + Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an + explicit mode report interactive. This is not necessarily the mode that will constrain + the turn: a plan or autopilot session applies its own write gate, continuation loop and + permission posture to every drained item regardless of the mode stored here. - def to_dict(self) -> dict: - result: dict = {} - result["id"] = from_str(self.id) - return result + The UI mode the agent was in when these messages were sent. Defaults to the session's + current mode. + """ + AUTOPILOT = "autopilot" + INTERACTIVE = "interactive" + PLAN = "plan" + SHELL = "shell" # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class TasksRemoveResult: - """Indicates whether the task was removed. False when the task does not exist or is still - running/idle. - """ - removed: bool - """Whether the task was removed. Returns false if the task does not exist or is still - running/idle (cancel it first). +class SendMode(Enum): + """Accepted for SendOptions compatibility but ignored; inserted items always use queued + delivery semantics. + + How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` + interjects during an in-progress turn. + + How to deliver the messages. `enqueue` (default) appends to the message queue. + `immediate` interjects during an in-progress turn. """ + ENQUEUE = "enqueue" + IMMEDIATE = "immediate" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueInsertAtResult: + """Result of inserting a queued message.""" + + id: str + """Fresh stable opaque id assigned to the inserted item.""" @staticmethod - def from_dict(obj: Any) -> 'TasksRemoveResult': + def from_dict(obj: Any) -> 'QueueInsertAtResult': assert isinstance(obj, dict) - removed = from_bool(obj.get("removed")) - return TasksRemoveResult(removed) + id = from_str(obj.get("id")) + return QueueInsertAtResult(id) def to_dict(self) -> dict: result: dict = {} - result["removed"] = from_bool(self.removed) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksSendMessageRequest: - """Identifier of the target agent task, message content, and optional sender agent ID.""" +class QueueMoveItemRequest: + """Parameters for moving a queued item by stable id.""" id: str - """Agent task identifier""" - - message: str - """Message content to send to the agent""" + """Stable opaque queued-item id.""" - from_agent_id: str | None = None - """Agent ID of the sender, if sent on behalf of another agent""" + to_position: int + """Zero-based target position in the public visible queue. Values outside the queue clamp to + an end. + """ @staticmethod - def from_dict(obj: Any) -> 'TasksSendMessageRequest': + def from_dict(obj: Any) -> 'QueueMoveItemRequest': assert isinstance(obj, dict) id = from_str(obj.get("id")) - message = from_str(obj.get("message")) - from_agent_id = from_union([from_str, from_none], obj.get("fromAgentId")) - return TasksSendMessageRequest(id, message, from_agent_id) + to_position = from_int(obj.get("toPosition")) + return QueueMoveItemRequest(id, to_position) def to_dict(self) -> dict: result: dict = {} result["id"] = from_str(self.id) - result["message"] = from_str(self.message) - if self.from_agent_id is not None: - result["fromAgentId"] = from_union([from_str, from_none], self.from_agent_id) + result["toPosition"] = from_int(self.to_position) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksSendMessageResult: - """Indicates whether the message was delivered, with an error message when delivery failed.""" - - sent: bool - """Whether the message was successfully delivered or steered""" +class QueueMoveItemResult: + """Result of moving a queued item.""" - error: str | None = None - """Error message if delivery failed""" + changed: bool + """True when the item changed position; false when it was already at the requested position.""" @staticmethod - def from_dict(obj: Any) -> 'TasksSendMessageResult': + def from_dict(obj: Any) -> 'QueueMoveItemResult': assert isinstance(obj, dict) - sent = from_bool(obj.get("sent")) - error = from_union([from_str, from_none], obj.get("error")) - return TasksSendMessageResult(sent, error) + changed = from_bool(obj.get("changed")) + return QueueMoveItemResult(changed) def to_dict(self) -> dict: result: dict = {} - result["sent"] = from_bool(self.sent) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) + result["changed"] = from_bool(self.changed) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class TasksStartAgentRequest: - """Agent type, prompt, name, and optional description and model override for the new task.""" - - agent_type: str - """Type of agent to start (e.g., 'explore', 'task', 'general-purpose')""" - - name: str - """Short name for the agent, used to generate a human-readable ID""" +class QueuePendingItemsKind(Enum): + """Whether this item is a queued user message or a queued slash command / model change""" - prompt: str - """Task prompt for the agent""" + COMMAND = "command" + MESSAGE = "message" - description: str | None = None - """Short description of the task""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueRemoveAtRequest: + """Parameters for removing a queued item by stable id.""" - model: str | None = None - """Optional model override""" + id: str @staticmethod - def from_dict(obj: Any) -> 'TasksStartAgentRequest': + def from_dict(obj: Any) -> 'QueueRemoveAtRequest': assert isinstance(obj, dict) - agent_type = from_str(obj.get("agentType")) - name = from_str(obj.get("name")) - prompt = from_str(obj.get("prompt")) - description = from_union([from_str, from_none], obj.get("description")) - model = from_union([from_str, from_none], obj.get("model")) - return TasksStartAgentRequest(agent_type, name, prompt, description, model) + id = from_str(obj.get("id")) + return QueueRemoveAtRequest(id) def to_dict(self) -> dict: result: dict = {} - result["agentType"] = from_str(self.agent_type) - result["name"] = from_str(self.name) - result["prompt"] = from_str(self.prompt) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksStartAgentResult: - """Identifier assigned to the newly started background agent task.""" +class QueueRemoveAtResult: + """Result of removing a queued item.""" - agent_id: str - """Generated agent ID for the background task""" + removed: bool + """True when the addressed item was removed.""" @staticmethod - def from_dict(obj: Any) -> 'TasksStartAgentResult': + def from_dict(obj: Any) -> 'QueueRemoveAtResult': assert isinstance(obj, dict) - agent_id = from_str(obj.get("agentId")) - return TasksStartAgentResult(agent_id) + removed = from_bool(obj.get("removed")) + return QueueRemoveAtResult(removed) def to_dict(self) -> dict: result: dict = {} - result["agentId"] = from_str(self.agent_id) + result["removed"] = from_bool(self.removed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksWaitForPendingResult: - """Wait until all in-flight background tasks (agents + shells) and any follow-up turns - scheduled by their completions have settled. Returns when the runtime is fully drained or - after an internal timeout (default 10 minutes; configurable via - COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +class QueueRemoveMostRecentResult: + """Indicates whether a user-facing pending item was removed.""" + + removed: bool + """True if a user-facing pending item was removed (LIFO across both queues); false when no + removable items remained. """ + @staticmethod - def from_dict(obj: Any) -> 'TasksWaitForPendingResult': + def from_dict(obj: Any) -> 'QueueRemoveMostRecentResult': assert isinstance(obj, dict) - return TasksWaitForPendingResult() + removed = from_bool(obj.get("removed")) + return QueueRemoveMostRecentResult(removed) def to_dict(self) -> dict: result: dict = {} + result["removed"] = from_bool(self.removed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TelemetrySetFeatureOverridesRequest: - """Feature override key/value pairs to attach to subsequent telemetry events from this - session. - """ - features: dict[str, str] - """Override key/value pairs to attach to subsequent telemetry events from this session. - Replaces any previously-set overrides. - """ +class QueueSendNowRequest: + """Parameters for steering a queued message into a live turn.""" + + id: str @staticmethod - def from_dict(obj: Any) -> 'TelemetrySetFeatureOverridesRequest': + def from_dict(obj: Any) -> 'QueueSendNowRequest': assert isinstance(obj, dict) - features = from_dict(from_str, obj.get("features")) - return TelemetrySetFeatureOverridesRequest(features) + id = from_str(obj.get("id")) + return QueueSendNowRequest(id) def to_dict(self) -> dict: result: dict = {} - result["features"] = from_dict(from_str, self.features) + result["id"] = from_str(self.id) return result -class TokenAuthInfoType(Enum): - TOKEN = "token" - +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Tool: - """Schema for the `Tool` type.""" +class QueueSendNowResult: + """Result of trying to steer a queued message into a live turn.""" - description: str - """Description of what the tool does""" - - name: str - """Tool identifier (e.g., "bash", "grep", "str_replace_editor")""" - - instructions: str | None = None - """Optional instructions for how to use this tool effectively""" - - namespaced_name: str | None = None - """Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP - tools) - """ - parameters: dict[str, Any] | None = None - """JSON Schema for the tool's input parameters""" + steered: bool + """True when the item was accepted into the steering lane; false when no main turn was live.""" @staticmethod - def from_dict(obj: Any) -> 'Tool': + def from_dict(obj: Any) -> 'QueueSendNowResult': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - name = from_str(obj.get("name")) - instructions = from_union([from_str, from_none], obj.get("instructions")) - namespaced_name = from_union([from_str, from_none], obj.get("namespacedName")) - parameters = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("parameters")) - return Tool(description, name, instructions, namespaced_name, parameters) + steered = from_bool(obj.get("steered")) + return QueueSendNowResult(steered) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["name"] = from_str(self.name) - if self.instructions is not None: - result["instructions"] = from_union([from_str, from_none], self.instructions) - if self.namespaced_name is not None: - result["namespacedName"] = from_union([from_str, from_none], self.namespaced_name) - if self.parameters is not None: - result["parameters"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.parameters) + result["steered"] = from_bool(self.steered) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ToolsInitializeAndValidateResult: - """Resolve, build, and validate the runtime tool list for this session. Subagent sessions - and consumer flows that need an initialized tool set before `send` invoke this. Default - base-class implementation is a no-op for sessions that don't support tool validation. +class QueueSetDrainPausedRequest: + """Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is + exclusive and non-idempotent: `paused: true` against an already-paused session fails with + `queue_already_paused`. The pause is never released automatically — it is not tied to the + caller's lifetime, so a client that exits without sending `paused: false` leaves the lane + frozen. Release is unowned: `paused: false` clears the pause for any caller, including + one that never acquired it. """ + paused: bool + @staticmethod - def from_dict(obj: Any) -> 'ToolsInitializeAndValidateResult': + def from_dict(obj: Any) -> 'QueueSetDrainPausedRequest': assert isinstance(obj, dict) - return ToolsInitializeAndValidateResult() + paused = from_bool(obj.get("paused")) + return QueueSetDrainPausedRequest(paused) def to_dict(self) -> dict: result: dict = {} + result["paused"] = from_bool(self.paused) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ToolsListRequest: - """Optional model identifier whose tool overrides should be applied to the listing.""" +class QueueUpdateTextRequest: + """Parameters for editing a single queued message.""" - model: str | None = None - """Optional model ID — when provided, the returned tool list reflects model-specific - overrides - """ + id: str + prompt: str + display_prompt: str | None = None @staticmethod - def from_dict(obj: Any) -> 'ToolsListRequest': + def from_dict(obj: Any) -> 'QueueUpdateTextRequest': assert isinstance(obj, dict) - model = from_union([from_str, from_none], obj.get("model")) - return ToolsListRequest(model) + id = from_str(obj.get("id")) + prompt = from_str(obj.get("prompt")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + return QueueUpdateTextRequest(id, prompt, display_prompt) def to_dict(self) -> dict: result: dict = {} - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) + result["id"] = from_str(self.id) + result["prompt"] = from_str(self.prompt) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) return result -# Experimental: this type is part of an experimental API and may change or be removed. -class UIAutoModeSwitchResponse(Enum): - """User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist - as setting), or no (decline). - """ - NO = "no" - YES = "yes" - YES_ALWAYS = "yes_always" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayAnyOfFieldItemsAnyOf: - """Schema for the `UIElicitationArrayAnyOfFieldItemsAnyOf` type.""" - - const: str - """Value submitted when this option is selected.""" +class QueueUpdateTextResult: + """Result of editing a queued message.""" - title: str - """Display label for this option.""" + updated: bool + """True when the stored text changed.""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItemsAnyOf': + def from_dict(obj: Any) -> 'QueueUpdateTextResult': assert isinstance(obj, dict) - const = from_str(obj.get("const")) - title = from_str(obj.get("title")) - return UIElicitationArrayAnyOfFieldItemsAnyOf(const, title) + updated = from_bool(obj.get("updated")) + return QueueUpdateTextResult(updated) def to_dict(self) -> dict: result: dict = {} - result["const"] = from_str(self.const) - result["title"] = from_str(self.title) + result["updated"] = from_bool(self.updated) return result -class UIElicitationArrayAnyOfFieldType(Enum): - ARRAY = "array" - -class UIElicitationArrayEnumFieldItemsType(Enum): - STRING = "string" - -# Experimental: this type is part of an experimental API and may change or be removed. -class UIElicitationSchemaPropertyStringFormat(Enum): - """Optional format hint that constrains the accepted input.""" - - DATE = "date" - DATE_TIME = "date-time" - EMAIL = "email" - URI = "uri" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationStringOneOfFieldOneOf: - """Schema for the `UIElicitationStringOneOfFieldOneOf` type.""" - - const: str - """Value submitted when this option is selected.""" +class QueuedCommandHandled: + """Queued-command response indicating the host executed the command, with an optional flag + to stop queue processing. + """ + handled: ClassVar[bool] = True + """The host actually executed the queued command.""" - title: str - """Display label for this option.""" + stop_processing_queue: bool | None = None + """When true, the runtime will not process subsequent queued commands until a new request + comes in. + """ @staticmethod - def from_dict(obj: Any) -> 'UIElicitationStringOneOfFieldOneOf': + def from_dict(obj: Any) -> 'QueuedCommandHandled': assert isinstance(obj, dict) - const = from_str(obj.get("const")) - title = from_str(obj.get("title")) - return UIElicitationStringOneOfFieldOneOf(const, title) + stop_processing_queue = from_union([from_bool, from_none], obj.get("stopProcessingQueue")) + return QueuedCommandHandled(stop_processing_queue) def to_dict(self) -> dict: result: dict = {} - result["const"] = from_str(self.const) - result["title"] = from_str(self.title) + result["handled"] = self.handled + if self.stop_processing_queue is not None: + result["stopProcessingQueue"] = from_union([from_bool, from_none], self.stop_processing_queue) return result -class UIElicitationSchemaPropertyType(Enum): - """Numeric type accepted by the field.""" - - ARRAY = "array" - BOOLEAN = "boolean" - INTEGER = "integer" - NUMBER = "number" - STRING = "string" - -class UIElicitationSchemaType(Enum): - OBJECT = "object" - -# Experimental: this type is part of an experimental API and may change or be removed. -class UIElicitationResponseAction(Enum): - """The user's response: accept (submitted), decline (rejected), or cancel (dismissed)""" - - ACCEPT = "accept" - CANCEL = "cancel" - DECLINE = "decline" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationResult: - """Indicates whether the elicitation response was accepted; false if it was already resolved - by another client. +class QueuedCommandNotHandled: + """Queued-command response indicating the host did not execute the command and the queue may + continue. """ - success: bool - """Whether the response was accepted. False if the request was already resolved by another - client. + handled: ClassVar[bool] = False + """The host did not execute the queued command. Unblocks the queue without claiming the + command was processed (e.g. when the handler threw before completing). """ @staticmethod - def from_dict(obj: Any) -> 'UIElicitationResult': + def from_dict(obj: Any) -> 'QueuedCommandNotHandled': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return UIElicitationResult(success) + return QueuedCommandNotHandled() def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["handled"] = self.handled return result -class UIElicitationSchemaPropertyBooleanType(Enum): - BOOLEAN = "boolean" - -# Experimental: this type is part of an experimental API and may change or be removed. -class UIElicitationSchemaPropertyNumberType(Enum): - """Numeric type accepted by the field.""" - - INTEGER = "integer" - NUMBER = "number" - -# Experimental: this type is part of an experimental API and may change or be removed. -class UIExitPlanModeAction(Enum): - """The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, - otherwise 'interactive'. - """ - AUTOPILOT = "autopilot" - AUTOPILOT_FLEET = "autopilot_fleet" - EXIT_ONLY = "exit_only" - INTERACTIVE = "interactive" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingResult: - """Indicates whether the pending UI request was resolved by this call.""" +class RegisterEventInterestParams: + """Event type to register consumer interest for, used by runtime gating logic.""" - success: bool - """True if the request was still pending and was resolved by this call. False if the request - ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise - no longer pending. + event_type: str + """The event type the consumer wants the runtime to treat as 'observed' for + behavior-switching gating. Some runtime code paths inspect whether any consumer is + interested in a specific event type and choose a different implementation accordingly + (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive + OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest + is registered the runtime still attempts non-interactive reconnect from cached or + refreshable tokens, and only marks the server `needs-auth` if usable credentials are + unavailable — it does not open a browser or start interactive OAuth without a consumer). + SDK clients that long-poll events do NOT automatically appear as listeners to these + gating checks — they must explicitly call `registerInterest` for each event type they + want the runtime to count as having a consumer. Multiple registrations for the same event + type from the same or different consumers are tracked independently and must each be + released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, + `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, + `command.queued`, `exit_plan_mode.requested`. """ @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingResult': + def from_dict(obj: Any) -> 'RegisterEventInterestParams': assert isinstance(obj, dict) - success = from_bool(obj.get("success")) - return UIHandlePendingResult(success) + event_type = from_str(obj.get("eventType")) + return RegisterEventInterestParams(event_type) def to_dict(self) -> dict: result: dict = {} - result["success"] = from_bool(self.success) + result["eventType"] = from_str(self.event_type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingSamplingRequest: - """Request ID of a pending `sampling.requested` event and an optional sampling result - payload (omit to reject). - """ - request_id: str - """The unique request ID from the sampling.requested event""" +class RegisterEventInterestResult: + """Opaque handle representing an event-type interest registration.""" - response: dict[str, Any] | None = None - """Optional sampling result payload. Omit to reject/cancel the sampling request without - providing a result. + handle: str + """Opaque handle for this registration. Pass to releaseInterest to release. Each call to + registerInterest produces a fresh handle, even when the same eventType is registered + multiple times. """ @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingSamplingRequest': + def from_dict(obj: Any) -> 'RegisterEventInterestResult': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - response = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("response")) - return UIHandlePendingSamplingRequest(request_id, response) + handle = from_str(obj.get("handle")) + return RegisterEventInterestResult(handle) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - if self.response is not None: - result["response"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.response) + result["handle"] = from_str(self.handle) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIUserInputResponse: - """Schema for the `UIUserInputResponse` type.""" - - answer: str - """The user's answer text""" +class SessionsRegisterExtensionToolsOnSessionOptions: + """Optional registration options.""" - was_freeform: bool - """True if the user typed a freeform response, false if they selected a presented choice. - Used by telemetry to differentiate between free text input and choice selection. + # Internal: this field is an internal SDK API and is not part of the public surface. + enabled: Any = None + """In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: + replaced by runtime-side enable/disable RPCs in the SDK migration. """ @staticmethod - def from_dict(obj: Any) -> 'UIUserInputResponse': + def from_dict(obj: Any) -> 'SessionsRegisterExtensionToolsOnSessionOptions': assert isinstance(obj, dict) - answer = from_str(obj.get("answer")) - was_freeform = from_bool(obj.get("wasFreeform")) - return UIUserInputResponse(answer, was_freeform) + enabled = obj.get("enabled") + return SessionsRegisterExtensionToolsOnSessionOptions(enabled) def to_dict(self) -> dict: result: dict = {} - result["answer"] = from_str(self.answer) - result["wasFreeform"] = from_bool(self.was_freeform) + if self.enabled is not None: + result["enabled"] = self.enabled return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIRegisterDirectAutoModeSwitchHandlerResult: - """Register an in-process handler for `auto_mode_switch.requested` events. The caller still - attaches the actual listener via the standard event-subscription mechanism; this - registration solely tells the server bridge to skip its own dispatch (so a remote client - doesn't race the in-process handler for the same requestId). - """ +class ReleaseEventInterestParams: + """Opaque handle previously returned by `registerInterest` to release.""" + handle: str - """Opaque handle representing the registration. Pass this same handle to - `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. - Multiple registrations are reference-counted; the server bridge will only dispatch - auto-mode-switch requests when no handles are active. + """Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown + or already-released handle is a no-op (returns success). When the last outstanding handle + for an event type is released, the runtime reverts to its 'no consumer' code path for + that event type. """ @staticmethod - def from_dict(obj: Any) -> 'UIRegisterDirectAutoModeSwitchHandlerResult': + def from_dict(obj: Any) -> 'ReleaseEventInterestParams': assert isinstance(obj, dict) handle = from_str(obj.get("handle")) - return UIRegisterDirectAutoModeSwitchHandlerResult(handle) + return ReleaseEventInterestParams(handle) def to_dict(self) -> dict: result: dict = {} @@ -6553,8676 +7900,20144 @@ def to_dict(self) -> dict: # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIUnregisterDirectAutoModeSwitchHandlerRequest: - """Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.""" +class RemoteControlConfigExistingMcSession: + """Reattach to an existing MC session without creating a new one.""" - handle: str - """Handle previously returned by `registerDirectAutoModeSwitchHandler`""" + mc_session_id: str + """Existing MC session ID to reattach to.""" + + mc_task_id: str + """Existing MC task ID for the reattached session.""" @staticmethod - def from_dict(obj: Any) -> 'UIUnregisterDirectAutoModeSwitchHandlerRequest': + def from_dict(obj: Any) -> 'RemoteControlConfigExistingMcSession': assert isinstance(obj, dict) - handle = from_str(obj.get("handle")) - return UIUnregisterDirectAutoModeSwitchHandlerRequest(handle) + mc_session_id = from_str(obj.get("mcSessionId")) + mc_task_id = from_str(obj.get("mcTaskId")) + return RemoteControlConfigExistingMcSession(mc_session_id, mc_task_id) def to_dict(self) -> dict: result: dict = {} - result["handle"] = from_str(self.handle) + result["mcSessionId"] = from_str(self.mc_session_id) + result["mcTaskId"] = from_str(self.mc_task_id) return result -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class UIUnregisterDirectAutoModeSwitchHandlerResult: - """Indicates whether the handle was active and the registration count was decremented.""" +class RemoteControlStatusState(Enum): + ACTIVE = "active" + CONNECTING = "connecting" + ERROR = "error" + OFF = "off" - unregistered: bool - """True if the handle was active and decremented the counter; false if the handle was - unknown. - """ +class RemoteControlStatusActiveState(Enum): + ACTIVE = "active" - @staticmethod - def from_dict(obj: Any) -> 'UIUnregisterDirectAutoModeSwitchHandlerResult': - assert isinstance(obj, dict) - unregistered = from_bool(obj.get("unregistered")) - return UIUnregisterDirectAutoModeSwitchHandlerResult(unregistered) +class RemoteControlStatusConnectingState(Enum): + CONNECTING = "connecting" - def to_dict(self) -> dict: - result: dict = {} - result["unregistered"] = from_bool(self.unregistered) - return result +class RemoteControlStatusErrorState(Enum): + ERROR = "error" + +class RemoteControlStatusOffState(Enum): + OFF = "off" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageMetricsCodeChanges: - """Aggregated code change metrics""" - - files_modified: list[str] - """Distinct file paths modified during the session""" - - files_modified_count: int - """Number of distinct files modified""" +class RemoteControlStatusResult: + """Wrapper for the singleton's current status.""" - lines_added: int - """Total lines of code added""" - - lines_removed: int - """Total lines of code removed""" + status: RemoteControlStatus + """State of the runtime-managed remote-control singleton.""" @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsCodeChanges': + def from_dict(obj: Any) -> 'RemoteControlStatusResult': assert isinstance(obj, dict) - files_modified = from_list(from_str, obj.get("filesModified")) - files_modified_count = from_int(obj.get("filesModifiedCount")) - lines_added = from_int(obj.get("linesAdded")) - lines_removed = from_int(obj.get("linesRemoved")) - return UsageMetricsCodeChanges(files_modified, files_modified_count, lines_added, lines_removed) + status = _load_RemoteControlStatus(obj.get("status")) + return RemoteControlStatusResult(status) def to_dict(self) -> dict: result: dict = {} - result["filesModified"] = from_list(from_str, self.files_modified) - result["filesModifiedCount"] = from_int(self.files_modified_count) - result["linesAdded"] = from_int(self.lines_added) - result["linesRemoved"] = from_int(self.lines_removed) + result["status"] = (self.status).to_dict() return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageMetricsModelMetricRequests: - """Request count and cost metrics for this model""" +class RemoteControlStopResult: + """Outcome of a stopRemoteControl call.""" - cost: float - """User-initiated premium request cost (with multiplier applied)""" + status: RemoteControlStatus + """State of the runtime-managed remote-control singleton.""" - count: int - """Number of API requests made with this model""" + stopped: bool + """Whether the singleton was actually torn down by this call.""" @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsModelMetricRequests': + def from_dict(obj: Any) -> 'RemoteControlStopResult': assert isinstance(obj, dict) - cost = from_float(obj.get("cost")) - count = from_int(obj.get("count")) - return UsageMetricsModelMetricRequests(cost, count) + status = _load_RemoteControlStatus(obj.get("status")) + stopped = from_bool(obj.get("stopped")) + return RemoteControlStopResult(status, stopped) def to_dict(self) -> dict: result: dict = {} - result["cost"] = to_float(self.cost) - result["count"] = from_int(self.count) + result["status"] = (self.status).to_dict() + result["stopped"] = from_bool(self.stopped) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageMetricsModelMetricTokenDetail: - """Schema for the `UsageMetricsModelMetricTokenDetail` type.""" +class RemoteControlTransferResult: + """Outcome of a transferRemoteControl call.""" - token_count: int - """Accumulated token count for this token type""" + status: RemoteControlStatus + """State of the runtime-managed remote-control singleton.""" + + transferred: bool + """Whether the rebinding actually happened.""" @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsModelMetricTokenDetail': + def from_dict(obj: Any) -> 'RemoteControlTransferResult': assert isinstance(obj, dict) - token_count = from_int(obj.get("tokenCount")) - return UsageMetricsModelMetricTokenDetail(token_count) + status = _load_RemoteControlStatus(obj.get("status")) + transferred = from_bool(obj.get("transferred")) + return RemoteControlTransferResult(status, transferred) def to_dict(self) -> dict: result: dict = {} - result["tokenCount"] = from_int(self.token_count) + result["status"] = (self.status).to_dict() + result["transferred"] = from_bool(self.transferred) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class UsageMetricsModelMetricUsage: - """Token usage metrics for this model""" - - cache_read_tokens: int - """Total tokens read from prompt cache""" - - cache_write_tokens: int - """Total tokens written to prompt cache""" +class RemoteSessionMode(Enum): + """Per-session remote mode. "off" disables remote, "export" exports session events to GitHub + without enabling remote steering, "on" enables both export and remote steering. + """ + EXPORT = "export" + OFF = "off" + ON = "on" - input_tokens: int - """Total input tokens consumed""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteEnableResult: + """GitHub URL for the session and a flag indicating whether remote steering is enabled.""" - output_tokens: int - """Total output tokens produced""" + remote_steerable: bool + """Whether remote steering is enabled""" - reasoning_tokens: int | None = None - """Total output tokens used for reasoning""" + url: str | None = None + """GitHub frontend URL for this session""" @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsModelMetricUsage': + def from_dict(obj: Any) -> 'RemoteEnableResult': assert isinstance(obj, dict) - cache_read_tokens = from_int(obj.get("cacheReadTokens")) - cache_write_tokens = from_int(obj.get("cacheWriteTokens")) - input_tokens = from_int(obj.get("inputTokens")) - output_tokens = from_int(obj.get("outputTokens")) - reasoning_tokens = from_union([from_int, from_none], obj.get("reasoningTokens")) - return UsageMetricsModelMetricUsage(cache_read_tokens, cache_write_tokens, input_tokens, output_tokens, reasoning_tokens) + remote_steerable = from_bool(obj.get("remoteSteerable")) + url = from_union([from_str, from_none], obj.get("url")) + return RemoteEnableResult(remote_steerable, url) def to_dict(self) -> dict: result: dict = {} - result["cacheReadTokens"] = from_int(self.cache_read_tokens) - result["cacheWriteTokens"] = from_int(self.cache_write_tokens) - result["inputTokens"] = from_int(self.input_tokens) - result["outputTokens"] = from_int(self.output_tokens) - if self.reasoning_tokens is not None: - result["reasoningTokens"] = from_union([from_int, from_none], self.reasoning_tokens) + result["remoteSteerable"] = from_bool(self.remote_steerable) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageMetricsTokenDetail: - """Schema for the `UsageMetricsTokenDetail` type.""" +class RemoteNotifySteerableChangedRequest: + """New remote-steerability state to persist as a `session.remote_steerable_changed` event.""" - token_count: int - """Accumulated token count for this token type""" + remote_steerable: bool + """Whether the session now supports remote steering via GitHub. The runtime persists this as + a `session.remote_steerable_changed` event so resume/replay sees the up-to-date + capability. + """ @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsTokenDetail': + def from_dict(obj: Any) -> 'RemoteNotifySteerableChangedRequest': assert isinstance(obj, dict) - token_count = from_int(obj.get("tokenCount")) - return UsageMetricsTokenDetail(token_count) + remote_steerable = from_bool(obj.get("remoteSteerable")) + return RemoteNotifySteerableChangedRequest(remote_steerable) def to_dict(self) -> dict: result: dict = {} - result["tokenCount"] = from_int(self.token_count) + result["remoteSteerable"] = from_bool(self.remote_steerable) return result -class UserAuthInfoType(Enum): - USER = "user" - -# Experimental: this type is part of an experimental API and may change or be removed. -class WorkspaceDiffFileChangeType(Enum): - """Type of change represented by this file diff.""" - - ADDED = "added" - DELETED = "deleted" - MODIFIED = "modified" - RENAMED = "renamed" - -# Experimental: this type is part of an experimental API and may change or be removed. -class WorkspaceDiffMode(Enum): - """Diff mode requested by the client. - - Effective mode used for the returned changes. - """ - BRANCH = "branch" - UNSTAGED = "unstaged" - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesCheckpoints: - """Schema for the `WorkspacesCheckpoints` type.""" - - filename: str - """Filename of the checkpoint within the workspace checkpoints directory""" - - number: int - """Checkpoint number assigned by the workspace manager""" - - title: str - """Human-readable checkpoint title""" - +class RemoteNotifySteerableChangedResult: + """Persist a steerability change as a `session.remote_steerable_changed` event. Used by the + host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a + remote exporter that the runtime does not directly own. + """ @staticmethod - def from_dict(obj: Any) -> 'WorkspacesCheckpoints': + def from_dict(obj: Any) -> 'RemoteNotifySteerableChangedResult': assert isinstance(obj, dict) - filename = from_str(obj.get("filename")) - number = from_int(obj.get("number")) - title = from_str(obj.get("title")) - return WorkspacesCheckpoints(filename, number, title) + return RemoteNotifySteerableChangedResult() def to_dict(self) -> dict: result: dict = {} - result["filename"] = from_str(self.filename) - result["number"] = from_int(self.number) - result["title"] = from_str(self.title) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesCreateFileRequest: - """Relative path and UTF-8 content for the workspace file to create or overwrite.""" +class RemoteSessionMetadataRepository: + """GitHub repository the remote session belongs to.""" - content: str - """File content to write as a UTF-8 string""" + branch: str + """Branch associated with the remote session.""" - path: str - """Relative path within the workspace files directory""" + name: str + """Repository name.""" + + owner: str + """Repository owner.""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesCreateFileRequest': + def from_dict(obj: Any) -> 'RemoteSessionMetadataRepository': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - path = from_str(obj.get("path")) - return WorkspacesCreateFileRequest(content, path) + branch = from_str(obj.get("branch")) + name = from_str(obj.get("name")) + owner = from_str(obj.get("owner")) + return RemoteSessionMetadataRepository(branch, name, owner) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["path"] = from_str(self.path) + result["branch"] = from_str(self.branch) + result["name"] = from_str(self.name) + result["owner"] = from_str(self.owner) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesListFilesResult: - """Relative paths of files stored in the session workspace files directory.""" +class RemoteSessionRepository: + """Repository context for the remote session. - files: list[str] - """Relative file paths in the workspace files directory""" + Repository for the cloud session. + """ + name: str + """Repository name.""" + + owner: str + """Repository owner or organization login.""" + + branch: str | None = None + """Optional branch associated with the remote session.""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesListFilesResult': + def from_dict(obj: Any) -> 'RemoteSessionRepository': assert isinstance(obj, dict) - files = from_list(from_str, obj.get("files")) - return WorkspacesListFilesResult(files) + name = from_str(obj.get("name")) + owner = from_str(obj.get("owner")) + branch = from_union([from_str, from_none], obj.get("branch")) + return RemoteSessionRepository(name, owner, branch) def to_dict(self) -> dict: result: dict = {} - result["files"] = from_list(from_str, self.files) + result["name"] = from_str(self.name) + result["owner"] = from_str(self.owner) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesReadCheckpointRequest: - """Checkpoint number to read.""" +class SandboxConfigAuth: + """Credential-injection capability flags. - number: int - """Checkpoint number to read""" + Credential-injection capability flags applied while the sandbox is enabled. + """ + gh: bool | None = None + """Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the + OS keyring the sandbox blocks. Default: false (opt-in). + """ + git: bool | None = None + """Whether to inject git credentials as an `http..extraheader` so authenticated HTTPS + git works inside the sandbox without the shell-based credential helper the sandbox + blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, + GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's + own helper before the sandbox is applied. Default: false (opt-in). + """ @staticmethod - def from_dict(obj: Any) -> 'WorkspacesReadCheckpointRequest': + def from_dict(obj: Any) -> 'SandboxConfigAuth': assert isinstance(obj, dict) - number = from_int(obj.get("number")) - return WorkspacesReadCheckpointRequest(number) + gh = from_union([from_bool, from_none], obj.get("gh")) + git = from_union([from_bool, from_none], obj.get("git")) + return SandboxConfigAuth(gh, git) def to_dict(self) -> dict: result: dict = {} - result["number"] = from_int(self.number) + if self.gh is not None: + result["gh"] = from_union([from_bool, from_none], self.gh) + if self.git is not None: + result["git"] = from_union([from_bool, from_none], self.git) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesReadCheckpointResult: - """Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.""" +class SandboxConfigUserPolicyExperimentalSeatbelt: + """macOS seatbelt experimental options.""" - content: str | None = None - """Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing""" + keychain_access: bool | None = None + """Whether the macOS seatbelt profile may access the keychain.""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesReadCheckpointResult': + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyExperimentalSeatbelt': assert isinstance(obj, dict) - content = from_union([from_none, from_str], obj.get("content")) - return WorkspacesReadCheckpointResult(content) + keychain_access = from_union([from_bool, from_none], obj.get("keychainAccess")) + return SandboxConfigUserPolicyExperimentalSeatbelt(keychain_access) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_union([from_none, from_str], self.content) + if self.keychain_access is not None: + result["keychainAccess"] = from_union([from_bool, from_none], self.keychain_access) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesReadFileRequest: - """Relative path of the workspace file to read.""" +class SandboxConfigUserPolicyFilesystem: + """Filesystem rules to merge into the base policy.""" - path: str - """Relative path within the workspace files directory""" + clear_policy_on_exit: bool | None = None + """Whether to clear the policy when the session exits.""" + + denied_paths: list[str] | None = None + """Paths explicitly denied.""" + + readonly_paths: list[str] | None = None + """Paths granted read-only access.""" + + readwrite_paths: list[str] | None = None + """Paths granted read/write access.""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesReadFileRequest': + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyFilesystem': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - return WorkspacesReadFileRequest(path) + clear_policy_on_exit = from_union([from_bool, from_none], obj.get("clearPolicyOnExit")) + denied_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("deniedPaths")) + readonly_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("readonlyPaths")) + readwrite_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("readwritePaths")) + return SandboxConfigUserPolicyFilesystem(clear_policy_on_exit, denied_paths, readonly_paths, readwrite_paths) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) + if self.clear_policy_on_exit is not None: + result["clearPolicyOnExit"] = from_union([from_bool, from_none], self.clear_policy_on_exit) + if self.denied_paths is not None: + result["deniedPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.denied_paths) + if self.readonly_paths is not None: + result["readonlyPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.readonly_paths) + if self.readwrite_paths is not None: + result["readwritePaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.readwrite_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesReadFileResult: - """Contents of the requested workspace file as a UTF-8 string.""" +class SandboxConfigUserPolicyNetworkProxy: + """HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and + cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. + Credentials go in the separate `username`/`password` fields. A credential-free http:// + loopback proxy URL is routed through the localhost proxy automatically; an https:// or + authenticated loopback URL is used as-is. - content: str - """File content as a UTF-8 string""" + HTTP proxy configuration for sandboxed traffic. + """ + url: str + """Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the + scheme's standard port when omitted. Credentials must not be embedded here — a + `user:pass@` authority is rejected; put them in the separate `username`/`password` + fields. A credential-free http:// loopback URL is routed through the localhost proxy + automatically; loopback covers localhost and any *.localhost subdomain, the whole + 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or + one with a username/password set, is used as-is. + """ + password: str | None = None + """Optional password for proxy authentication, combined with the URL at spawn time. The + persisted value may be a literal password, a `${secret:…}` reference resolved from the OS + keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the + sandboxed process routes through the proxy. The /sandbox dialog stores a real password in + the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in + settings.json); the field is masked in the dialog and redacted by /settings show. + """ + username: str | None = None + """Optional username for proxy authentication. Combined with the URL (and `password`) into + `user:pass@host` when the sandboxed process routes through the proxy. + """ @staticmethod - def from_dict(obj: Any) -> 'WorkspacesReadFileResult': + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyNetworkProxy': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - return WorkspacesReadFileResult(content) + url = from_str(obj.get("url")) + password = from_union([from_str, from_none], obj.get("password")) + username = from_union([from_str, from_none], obj.get("username")) + return SandboxConfigUserPolicyNetworkProxy(url, password, username) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) + result["url"] = from_str(self.url) + if self.password is not None: + result["password"] = from_union([from_str, from_none], self.password) + if self.username is not None: + result["username"] = from_union([from_str, from_none], self.username) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesSaveLargePasteRequest: - """Pasted content to save as a UTF-8 file in the session workspace.""" +class SandboxConfigUserPolicySeatbelt: + """macOS seatbelt options to merge into the base policy. - content: str - """Pasted content to save as a UTF-8 file""" + macOS seatbelt-specific options. + """ + keychain_access: bool | None = None + """Whether the macOS seatbelt profile may access the keychain.""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesSaveLargePasteRequest': + def from_dict(obj: Any) -> 'SandboxConfigUserPolicySeatbelt': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - return WorkspacesSaveLargePasteRequest(content) + keychain_access = from_union([from_bool, from_none], obj.get("keychainAccess")) + return SandboxConfigUserPolicySeatbelt(keychain_access) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) + if self.keychain_access is not None: + result["keychainAccess"] = from_union([from_bool, from_none], self.keychain_access) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Saved: - filename: str - """Filename within the workspace files directory""" +class ScheduleAddAtRequest: + """Register an absolute-time scheduled prompt.""" - file_path: str - """Absolute filesystem path to the saved paste file""" + at: int + """Epoch milliseconds when the prompt should fire.""" - size_bytes: int - """Size of the saved file in bytes""" + prompt: str + """Prompt text to enqueue when the schedule fires.""" + + display_prompt: str | None = None + """Optional display-only prompt label.""" + + recurring: bool | None = None + """Whether the schedule should re-arm after each tick. Defaults to false.""" @staticmethod - def from_dict(obj: Any) -> 'Saved': + def from_dict(obj: Any) -> 'ScheduleAddAtRequest': assert isinstance(obj, dict) - filename = from_str(obj.get("filename")) - file_path = from_str(obj.get("filePath")) - size_bytes = from_int(obj.get("sizeBytes")) - return Saved(filename, file_path, size_bytes) + at = from_int(obj.get("at")) + prompt = from_str(obj.get("prompt")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + recurring = from_union([from_bool, from_none], obj.get("recurring")) + return ScheduleAddAtRequest(at, prompt, display_prompt, recurring) def to_dict(self) -> dict: result: dict = {} - result["filename"] = from_str(self.filename) - result["filePath"] = from_str(self.file_path) - result["sizeBytes"] = from_int(self.size_bytes) + result["at"] = from_int(self.at) + result["prompt"] = from_str(self.prompt) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.recurring is not None: + result["recurring"] = from_union([from_bool, from_none], self.recurring) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AccountGetQuotaResult: - """Quota usage snapshots for the resolved user, keyed by quota type.""" +class ScheduleAddCronRequest: + """Register a cron scheduled prompt.""" - quota_snapshots: dict[str, AccountQuotaSnapshot] - """Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)""" + cron: str + """5-field cron expression.""" + + prompt: str + """Prompt text to enqueue when the schedule fires.""" + + display_prompt: str | None = None + """Optional display-only prompt label.""" + + recurring: bool | None = None + """Whether the schedule should re-arm after each tick. Defaults to true.""" + + tz: str | None = None + """IANA timezone for evaluating the cron expression.""" @staticmethod - def from_dict(obj: Any) -> 'AccountGetQuotaResult': + def from_dict(obj: Any) -> 'ScheduleAddCronRequest': assert isinstance(obj, dict) - quota_snapshots = from_dict(AccountQuotaSnapshot.from_dict, obj.get("quotaSnapshots")) - return AccountGetQuotaResult(quota_snapshots) + cron = from_str(obj.get("cron")) + prompt = from_str(obj.get("prompt")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + recurring = from_union([from_bool, from_none], obj.get("recurring")) + tz = from_union([from_str, from_none], obj.get("tz")) + return ScheduleAddCronRequest(cron, prompt, display_prompt, recurring, tz) def to_dict(self) -> dict: result: dict = {} - result["quotaSnapshots"] = from_dict(lambda x: to_class(AccountQuotaSnapshot, x), self.quota_snapshots) + result["cron"] = from_str(self.cron) + result["prompt"] = from_str(self.prompt) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.recurring is not None: + result["recurring"] = from_union([from_bool, from_none], self.recurring) + if self.tz is not None: + result["tz"] = from_union([from_str, from_none], self.tz) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistryLogCapture: - """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" +class ScheduleAddRequest: + """Register a relative-interval scheduled prompt.""" - enabled: bool - """Whether per-spawn log capture is on (false when env-disabled or open failed)""" + interval: str + """Human-readable interval such as `30s`, `5m`, or `2h`.""" - open_error: str | None = None - """Human-readable open failure message (only set when enabled === false AND the env-disable - opt-out was NOT used) - """ - open_error_reason: AgentRegistryLogCaptureOpenErrorReason | None = None - """Categorized reason for log-open failure""" + prompt: str + """Prompt text to enqueue when the schedule fires.""" - path: str | None = None - """Absolute path to the per-spawn log file (only set when enabled)""" + display_prompt: str | None = None + """Optional display-only prompt label.""" + + recurring: bool | None = None + """Whether the schedule should re-arm after each tick. Defaults to true.""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistryLogCapture': + def from_dict(obj: Any) -> 'ScheduleAddRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - open_error = from_union([from_str, from_none], obj.get("openError")) - open_error_reason = from_union([AgentRegistryLogCaptureOpenErrorReason, from_none], obj.get("openErrorReason")) - path = from_union([from_str, from_none], obj.get("path")) - return AgentRegistryLogCapture(enabled, open_error, open_error_reason, path) + interval = from_str(obj.get("interval")) + prompt = from_str(obj.get("prompt")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + recurring = from_union([from_bool, from_none], obj.get("recurring")) + return ScheduleAddRequest(interval, prompt, display_prompt, recurring) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - if self.open_error is not None: - result["openError"] = from_union([from_str, from_none], self.open_error) - if self.open_error_reason is not None: - result["openErrorReason"] = from_union([lambda x: to_enum(AgentRegistryLogCaptureOpenErrorReason, x), from_none], self.open_error_reason) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) + result["interval"] = from_str(self.interval) + result["prompt"] = from_str(self.prompt) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.recurring is not None: + result["recurring"] = from_union([from_bool, from_none], self.recurring) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistrySpawnError: - """`child_process.spawn` itself failed before the child entered the registry.""" +class ScheduleEntry: + """The registered or updated schedule entry. - kind: ClassVar[str] = "spawn-error" - """Discriminator: child_process.spawn itself failed""" + Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, + recurrence, and next run time. - message: str - """Human-readable error message""" + The removed entry, or omitted if no entry matched. + """ + id: int + """Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt + from the event log). + """ + next_run_at: datetime + """ISO 8601 timestamp when the next tick is scheduled to fire.""" - code: str | None = None - """Underlying errno code (e.g. ENOENT, EACCES) when available""" + prompt: str + """Prompt text that gets enqueued on every tick.""" + + recurring: bool + """Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`).""" + + at: int | None = None + """Absolute fire time (epoch milliseconds) for a one-shot calendar schedule.""" + + cron: str | None = None + """5-field cron expression for a recurring calendar schedule, evaluated in `tz`.""" + + display_prompt: str | None = None + """Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a + skill-invocation schedule). The actual enqueued prompt is `prompt`. + """ + interval_ms: int | None = None + """Interval between scheduled ticks, in milliseconds (relative-interval schedules).""" + + self_paced: bool | None = None + """True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next + run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. + """ + tz: str | None = None + """IANA timezone the `cron` expression is evaluated in.""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistrySpawnError': + def from_dict(obj: Any) -> 'ScheduleEntry': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - code = from_union([from_str, from_none], obj.get("code")) - return AgentRegistrySpawnError(message, code) + id = from_int(obj.get("id")) + next_run_at = from_datetime(obj.get("nextRunAt")) + prompt = from_str(obj.get("prompt")) + recurring = from_bool(obj.get("recurring")) + at = from_union([from_int, from_none], obj.get("at")) + cron = from_union([from_str, from_none], obj.get("cron")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + interval_ms = from_union([from_int, from_none], obj.get("intervalMs")) + self_paced = from_union([from_bool, from_none], obj.get("selfPaced")) + tz = from_union([from_str, from_none], obj.get("tz")) + return ScheduleEntry(id, next_run_at, prompt, recurring, at, cron, display_prompt, interval_ms, self_paced, tz) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["message"] = from_str(self.message) - if self.code is not None: - result["code"] = from_union([from_str, from_none], self.code) + result["id"] = from_int(self.id) + result["nextRunAt"] = self.next_run_at.isoformat() + result["prompt"] = from_str(self.prompt) + result["recurring"] = from_bool(self.recurring) + if self.at is not None: + result["at"] = from_union([from_int, from_none], self.at) + if self.cron is not None: + result["cron"] = from_union([from_str, from_none], self.cron) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.interval_ms is not None: + result["intervalMs"] = from_union([from_int, from_none], self.interval_ms) + if self.self_paced is not None: + result["selfPaced"] = from_union([from_bool, from_none], self.self_paced) + if self.tz is not None: + result["tz"] = from_union([from_str, from_none], self.tz) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistrySpawnValidationError: - """Synchronous pre-validation rejected the spawn request.""" +class ScheduleAddSelfPacedRequest: + """Register a self-paced scheduled prompt.""" - kind: ClassVar[str] = "validation-error" - """Discriminator: synchronous pre-validation rejected the request""" + prompt: str + """Prompt text to enqueue when the schedule fires.""" - message: str - """Human-readable explanation; safe to surface in the UI banner. Never logged to - unrestricted telemetry. - """ - reason: AgentRegistrySpawnValidationErrorReason - """Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by - reason without leaking raw paths or agent/model names. - """ - field: AgentRegistrySpawnValidationErrorField | None = None - """Which parameter field was invalid. Omitted when the rejection is not field-specific.""" + display_prompt: str | None = None + """Optional display-only prompt label.""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistrySpawnValidationError': + def from_dict(obj: Any) -> 'ScheduleAddSelfPacedRequest': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - reason = AgentRegistrySpawnValidationErrorReason(obj.get("reason")) - field = from_union([AgentRegistrySpawnValidationErrorField, from_none], obj.get("field")) - return AgentRegistrySpawnValidationError(message, reason, field) + prompt = from_str(obj.get("prompt")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + return ScheduleAddSelfPacedRequest(prompt, display_prompt) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["message"] = from_str(self.message) - result["reason"] = to_enum(AgentRegistrySpawnValidationErrorReason, self.reason) - if self.field is not None: - result["field"] = from_union([lambda x: to_enum(AgentRegistrySpawnValidationErrorField, x), from_none], self.field) + result["prompt"] = from_str(self.prompt) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionAuthStatus: - """Authentication status and account metadata for the session.""" +class ScheduleHasSelfPacedResult: + """Whether the session currently has an active self-paced schedule.""" - is_authenticated: bool - """Whether the session has resolved authentication""" + has_self_paced: bool + """True when at least one active schedule is self-paced.""" - auth_type: AuthInfoType | None = None - """Authentication type""" + @staticmethod + def from_dict(obj: Any) -> 'ScheduleHasSelfPacedResult': + assert isinstance(obj, dict) + has_self_paced = from_bool(obj.get("hasSelfPaced")) + return ScheduleHasSelfPacedResult(has_self_paced) - copilot_plan: str | None = None - """Copilot plan tier (e.g., individual_pro, business)""" + def to_dict(self) -> dict: + result: dict = {} + result["hasSelfPaced"] = from_bool(self.has_self_paced) + return result - host: str | None = None - """Authentication host URL""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ScheduleRearmSelfPacedRequest: + """Re-arm a self-paced scheduled prompt.""" - login: str | None = None - """Authenticated login/username, if available""" + at: int + """Epoch milliseconds when the prompt should next fire.""" - status_message: str | None = None - """Human-readable authentication status description""" + id: int + """Id of the self-paced scheduled prompt.""" @staticmethod - def from_dict(obj: Any) -> 'SessionAuthStatus': + def from_dict(obj: Any) -> 'ScheduleRearmSelfPacedRequest': assert isinstance(obj, dict) - is_authenticated = from_bool(obj.get("isAuthenticated")) - auth_type = from_union([AuthInfoType, from_none], obj.get("authType")) - copilot_plan = from_union([from_str, from_none], obj.get("copilotPlan")) - host = from_union([from_str, from_none], obj.get("host")) - login = from_union([from_str, from_none], obj.get("login")) - status_message = from_union([from_str, from_none], obj.get("statusMessage")) - return SessionAuthStatus(is_authenticated, auth_type, copilot_plan, host, login, status_message) + at = from_int(obj.get("at")) + id = from_int(obj.get("id")) + return ScheduleRearmSelfPacedRequest(at, id) def to_dict(self) -> dict: result: dict = {} - result["isAuthenticated"] = from_bool(self.is_authenticated) - if self.auth_type is not None: - result["authType"] = from_union([lambda x: to_enum(AuthInfoType, x), from_none], self.auth_type) - if self.copilot_plan is not None: - result["copilotPlan"] = from_union([from_str, from_none], self.copilot_plan) - if self.host is not None: - result["host"] = from_union([from_str, from_none], self.host) - if self.login is not None: - result["login"] = from_union([from_str, from_none], self.login) - if self.status_message is not None: - result["statusMessage"] = from_union([from_str, from_none], self.status_message) + result["at"] = from_int(self.at) + result["id"] = from_int(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class DiscoveredCanvas: - """Canvas available in the current session.""" - - canvas_id: str - """Provider-local canvas identifier""" - - description: str - """Short, single-sentence description shown to the agent in canvas catalogs.""" +class ScheduleStopRequest: + """Identifier of the scheduled prompt to remove.""" - display_name: str - """Human-readable canvas name""" + id: int + """Id of the scheduled prompt to remove.""" - extension_id: str - """Owning provider identifier""" + @staticmethod + def from_dict(obj: Any) -> 'ScheduleStopRequest': + assert isinstance(obj, dict) + id = from_int(obj.get("id")) + return ScheduleStopRequest(id) - actions: list[CanvasAction] | None = None - """Actions the agent or host may invoke on an open instance""" + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_int(self.id) + return result - extension_name: str | None = None - """Owning extension display name, when available""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SecretsAddFilterValuesRequest: + """Secret values to add to the redaction filter.""" - input_schema: Any = None - """JSON Schema for canvas open input""" + values: list[str] + """Raw secret values to register for redaction""" @staticmethod - def from_dict(obj: Any) -> 'DiscoveredCanvas': + def from_dict(obj: Any) -> 'SecretsAddFilterValuesRequest': assert isinstance(obj, dict) - canvas_id = from_str(obj.get("canvasId")) - description = from_str(obj.get("description")) - display_name = from_str(obj.get("displayName")) - extension_id = from_str(obj.get("extensionId")) - actions = from_union([lambda x: from_list(CanvasAction.from_dict, x), from_none], obj.get("actions")) - extension_name = from_union([from_str, from_none], obj.get("extensionName")) - input_schema = obj.get("inputSchema") - return DiscoveredCanvas(canvas_id, description, display_name, extension_id, actions, extension_name, input_schema) + values = from_list(from_str, obj.get("values")) + return SecretsAddFilterValuesRequest(values) def to_dict(self) -> dict: result: dict = {} - result["canvasId"] = from_str(self.canvas_id) - result["description"] = from_str(self.description) - result["displayName"] = from_str(self.display_name) - result["extensionId"] = from_str(self.extension_id) - if self.actions is not None: - result["actions"] = from_union([lambda x: from_list(lambda x: to_class(CanvasAction, x), x), from_none], self.actions) - if self.extension_name is not None: - result["extensionName"] = from_union([from_str, from_none], self.extension_name) - if self.input_schema is not None: - result["inputSchema"] = self.input_schema + result["values"] = from_list(from_str, self.values) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class OpenCanvasInstance: - """Open canvas instance snapshot.""" +class SecretsAddFilterValuesResult: + """Confirmation that the secret values were registered.""" - availability: CanvasInstanceAvailability - """Runtime-controlled routing state for an open canvas instance.""" + ok: bool + """Whether the values were successfully registered""" - canvas_id: str - """Provider-local canvas identifier""" + @staticmethod + def from_dict(obj: Any) -> 'SecretsAddFilterValuesResult': + assert isinstance(obj, dict) + ok = from_bool(obj.get("ok")) + return SecretsAddFilterValuesResult(ok) - extension_id: str - """Owning provider identifier""" + def to_dict(self) -> dict: + result: dict = {} + result["ok"] = from_bool(self.ok) + return result - instance_id: str - """Stable caller-supplied canvas instance identifier""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SendAttachmentsToMessageParams: + """Parameters for session.extensions.sendAttachmentsToMessage.""" - reopen: bool - """Whether this snapshot came from an idempotent reopen""" + attachments: list[PushAttachment] + """Attachments to push into the next user-message turn. extension_context entries take the + slim shape; standard variants take their full AttachmentSchema shape. + """ + instance_id: str | None = None + """Optional canvas instance binding the push for provenance. When supplied, the runtime + resolves the canvas, verifies it is owned by the calling extension, and stamps + canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs + and those fields stay unset on the attachment. + """ - extension_name: str | None = None - """Owning extension display name, when available""" + @staticmethod + def from_dict(obj: Any) -> 'SendAttachmentsToMessageParams': + assert isinstance(obj, dict) + attachments = from_list(_load_PushAttachment, obj.get("attachments")) + instance_id = from_union([from_str, from_none], obj.get("instanceId")) + return SendAttachmentsToMessageParams(attachments, instance_id) - input: Any = None - """Input supplied when the instance was opened""" + def to_dict(self) -> dict: + result: dict = {} + result["attachments"] = from_list(lambda x: (x).to_dict(), self.attachments) + if self.instance_id is not None: + result["instanceId"] = from_union([from_str, from_none], self.instance_id) + return result - status: str | None = None - """Provider-supplied status text""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SendMessageItem: + """A single user message to append to the session as part of a `session.sendMessages` turn""" - title: str | None = None - """Rendered title""" + prompt: str + """The user message text""" - url: str | None = None - """URL for web-rendered canvases""" + attachments: list[Attachment] | None = None + """Optional attachments (files, directories, selections, blobs, GitHub references) to + include with this message + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + billable: bool | None = None + """If false, this message will not trigger a Premium Request Unit charge. User messages + default to billable. + """ + display_prompt: str | None = None + """If provided, this is shown in the timeline instead of `prompt`""" + + required_tool: str | None = None + """If set, the request will fail if the named tool is not available when this message is + among the user messages at the start of the current exchange + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + source: str | None = None + """Optional provenance tag copied to the resulting user.message event. Must be `user`, + `system`, `command-` for command-originated messages, `schedule-` + for scheduled prompts, or `agent-` for prompts sent by another agent. + """ @staticmethod - def from_dict(obj: Any) -> 'OpenCanvasInstance': + def from_dict(obj: Any) -> 'SendMessageItem': assert isinstance(obj, dict) - availability = CanvasInstanceAvailability(obj.get("availability")) - canvas_id = from_str(obj.get("canvasId")) - extension_id = from_str(obj.get("extensionId")) - instance_id = from_str(obj.get("instanceId")) - reopen = from_bool(obj.get("reopen")) - extension_name = from_union([from_str, from_none], obj.get("extensionName")) - input = obj.get("input") - status = from_union([from_str, from_none], obj.get("status")) - title = from_union([from_str, from_none], obj.get("title")) - url = from_union([from_str, from_none], obj.get("url")) - return OpenCanvasInstance(availability, canvas_id, extension_id, instance_id, reopen, extension_name, input, status, title, url) + prompt = from_str(obj.get("prompt")) + attachments = from_union([lambda x: from_list(Attachment.from_dict, x), from_none], obj.get("attachments")) + billable = from_union([from_bool, from_none], obj.get("billable")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + required_tool = from_union([from_str, from_none], obj.get("requiredTool")) + source = from_union([from_str, from_none], obj.get("source")) + return SendMessageItem(prompt, attachments, billable, display_prompt, required_tool, source) def to_dict(self) -> dict: result: dict = {} - result["availability"] = to_enum(CanvasInstanceAvailability, self.availability) - result["canvasId"] = from_str(self.canvas_id) - result["extensionId"] = from_str(self.extension_id) - result["instanceId"] = from_str(self.instance_id) - result["reopen"] = from_bool(self.reopen) - if self.extension_name is not None: - result["extensionName"] = from_union([from_str, from_none], self.extension_name) - if self.input is not None: - result["input"] = self.input - if self.status is not None: - result["status"] = from_union([from_str, from_none], self.status) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + result["prompt"] = from_str(self.prompt) + if self.attachments is not None: + result["attachments"] = from_union([lambda x: from_list(lambda x: to_class(Attachment, x), x), from_none], self.attachments) + if self.billable is not None: + result["billable"] = from_union([from_bool, from_none], self.billable) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.required_tool is not None: + result["requiredTool"] = from_union([from_str, from_none], self.required_tool) + if self.source is not None: + result["source"] = from_union([from_str, from_none], self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandInput: - """Optional unstructured input hint""" - - hint: str - """Hint to display when command input has not been provided""" - - completion: SlashCommandInputCompletion | None = None - """Optional completion hint for the input (e.g. 'directory' for filesystem path completion)""" +class SendMessagesResult: + """Result of sending zero or more user messages""" - preserve_multiline_input: bool | None = None - """When true, clients should pass the full text after the command name as a single argument - rather than splitting on whitespace - """ - required: bool | None = None - """When true, the command requires non-empty input; clients should render the input hint as - required + message_ids: list[str] + """Unique identifiers assigned to the messages, one per provided message in order. Empty + when no messages were provided. """ @staticmethod - def from_dict(obj: Any) -> 'SlashCommandInput': + def from_dict(obj: Any) -> 'SendMessagesResult': assert isinstance(obj, dict) - hint = from_str(obj.get("hint")) - completion = from_union([SlashCommandInputCompletion, from_none], obj.get("completion")) - preserve_multiline_input = from_union([from_bool, from_none], obj.get("preserveMultilineInput")) - required = from_union([from_bool, from_none], obj.get("required")) - return SlashCommandInput(hint, completion, preserve_multiline_input, required) + message_ids = from_list(from_str, obj.get("messageIds")) + return SendMessagesResult(message_ids) def to_dict(self) -> dict: result: dict = {} - result["hint"] = from_str(self.hint) - if self.completion is not None: - result["completion"] = from_union([lambda x: to_enum(SlashCommandInputCompletion, x), from_none], self.completion) - if self.preserve_multiline_input is not None: - result["preserveMultilineInput"] = from_union([from_bool, from_none], self.preserve_multiline_input) - if self.required is not None: - result["required"] = from_union([from_bool, from_none], self.required) + result["messageIds"] = from_list(from_str, self.message_ids) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentDirectory: - """Directory attachment""" - - display_name: str - """User-facing display name for the attachment""" - - path: str - """Absolute directory path""" +class SendResult: + """Result of sending a user message""" - type: ClassVar[str] = "directory" - """Attachment type discriminator""" + message_id: str + """Unique identifier assigned to the message""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentDirectory': + def from_dict(obj: Any) -> 'SendResult': assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - path = from_str(obj.get("path")) - return SendAttachmentDirectory(display_name, path) + message_id = from_str(obj.get("messageId")) + return SendResult(message_id) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["path"] = from_str(self.path) - result["type"] = self.type + result["messageId"] = from_str(self.message_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ConnectedRemoteSessionMetadata: - """Metadata for a connected remote session.""" +class SendSystemNotificationRequest: + """Internal request for sending a system notification.""" - kind: ConnectedRemoteSessionMetadataKind - """Neutral SDK discriminator for the connected remote session kind.""" + message: str + """Notification text to deliver to the model.""" - modified_time: datetime - """Last session update time as an ISO 8601 string.""" + kind: Any = None + """Optional structured notification kind.""" - repository: ConnectedRemoteSessionMetadataRepository - """Repository associated with the connected remote session.""" + options: Any = None + """Internal delivery options, including passive policy.""" - session_id: str - """SDK session ID for the connected remote session.""" + @staticmethod + def from_dict(obj: Any) -> 'SendSystemNotificationRequest': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + kind = obj.get("kind") + options = obj.get("options") + return SendSystemNotificationRequest(message, kind, options) - start_time: datetime - """Session start time as an ISO 8601 string.""" + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + if self.kind is not None: + result["kind"] = self.kind + if self.options is not None: + result["options"] = self.options + return result - name: str | None = None - """Optional friendly session name.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ServerSkill: + """Server-side skill metadata, including name, description, source, enabled/invocable state, + path, project path, and argument hint. + """ + description: str + """Description of what the skill does""" - pull_request_number: int | None = None - """Pull request number associated with the session.""" + enabled: bool + """Whether the skill is currently enabled (based on global config)""" - resource_id: str | None = None - """Original remote resource identifier.""" + name: str + """Unique identifier for the skill""" - stale_at: datetime | None = None - """Remote session staleness deadline as an ISO 8601 string.""" + source: SkillSource + """Source location type (e.g., project, personal-copilot, plugin, builtin)""" - state: str | None = None - """Remote session state returned by the backing service.""" + user_invocable: bool + """Whether the skill can be invoked by the user as a slash command""" - summary: str | None = None - """Optional session summary.""" + argument_hint: str | None = None + """Optional freeform hint describing the skill's expected arguments, from the + `argument-hint` frontmatter field + """ + command_name: str | None = None + """Canonical slash command name used to invoke the skill, without the leading '/'""" + + path: str | None = None + """Absolute path to the skill file""" + + project_path: str | None = None + """The project path this skill belongs to (only for project/inherited skills)""" @staticmethod - def from_dict(obj: Any) -> 'ConnectedRemoteSessionMetadata': + def from_dict(obj: Any) -> 'ServerSkill': assert isinstance(obj, dict) - kind = ConnectedRemoteSessionMetadataKind(obj.get("kind")) - modified_time = from_datetime(obj.get("modifiedTime")) - repository = ConnectedRemoteSessionMetadataRepository.from_dict(obj.get("repository")) - session_id = from_str(obj.get("sessionId")) - start_time = from_datetime(obj.get("startTime")) - name = from_union([from_str, from_none], obj.get("name")) - pull_request_number = from_union([from_int, from_none], obj.get("pullRequestNumber")) - resource_id = from_union([from_str, from_none], obj.get("resourceId")) - stale_at = from_union([from_datetime, from_none], obj.get("staleAt")) - state = from_union([from_str, from_none], obj.get("state")) - summary = from_union([from_str, from_none], obj.get("summary")) - return ConnectedRemoteSessionMetadata(kind, modified_time, repository, session_id, start_time, name, pull_request_number, resource_id, stale_at, state, summary) + description = from_str(obj.get("description")) + enabled = from_bool(obj.get("enabled")) + name = from_str(obj.get("name")) + source = SkillSource(obj.get("source")) + user_invocable = from_bool(obj.get("userInvocable")) + argument_hint = from_union([from_str, from_none], obj.get("argumentHint")) + command_name = from_union([from_str, from_none], obj.get("commandName")) + path = from_union([from_str, from_none], obj.get("path")) + project_path = from_union([from_str, from_none], obj.get("projectPath")) + return ServerSkill(description, enabled, name, source, user_invocable, argument_hint, command_name, path, project_path) def to_dict(self) -> dict: result: dict = {} - result["kind"] = to_enum(ConnectedRemoteSessionMetadataKind, self.kind) - result["modifiedTime"] = self.modified_time.isoformat() - result["repository"] = to_class(ConnectedRemoteSessionMetadataRepository, self.repository) - result["sessionId"] = from_str(self.session_id) - result["startTime"] = self.start_time.isoformat() - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.pull_request_number is not None: - result["pullRequestNumber"] = from_union([from_int, from_none], self.pull_request_number) - if self.resource_id is not None: - result["resourceId"] = from_union([from_str, from_none], self.resource_id) - if self.stale_at is not None: - result["staleAt"] = from_union([lambda x: x.isoformat(), from_none], self.stale_at) - if self.state is not None: - result["state"] = from_union([from_str, from_none], self.state) - if self.summary is not None: - result["summary"] = from_union([from_str, from_none], self.summary) + result["description"] = from_str(self.description) + result["enabled"] = from_bool(self.enabled) + result["name"] = from_str(self.name) + result["source"] = to_enum(SkillSource, self.source) + result["userInvocable"] = from_bool(self.user_invocable) + if self.argument_hint is not None: + result["argumentHint"] = from_union([from_str, from_none], self.argument_hint) + if self.command_name is not None: + result["commandName"] = from_union([from_str, from_none], self.command_name) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.project_path is not None: + result["projectPath"] = from_union([from_str, from_none], self.project_path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasHostContextCapabilities: - """Host capabilities""" +class SessionActivity: + """Current activity flags for the session.""" - canvases: bool | None = None - """Whether canvas rendering is supported""" + abortable: bool + """Whether an in-flight operation can currently be aborted.""" + + has_active_work: bool + """Whether the session currently has active work, including running turns or tasks.""" @staticmethod - def from_dict(obj: Any) -> 'CanvasHostContextCapabilities': + def from_dict(obj: Any) -> 'SessionActivity': assert isinstance(obj, dict) - canvases = from_union([from_bool, from_none], obj.get("canvases")) - return CanvasHostContextCapabilities(canvases) + abortable = from_bool(obj.get("abortable")) + has_active_work = from_bool(obj.get("hasActiveWork")) + return SessionActivity(abortable, has_active_work) def to_dict(self) -> dict: result: dict = {} - if self.canvases is not None: - result["canvases"] = from_union([from_bool, from_none], self.canvases) + result["abortable"] = from_bool(self.abortable) + result["hasActiveWork"] = from_bool(self.has_active_work) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CopilotUserResponseQuotaSnapshots: - """Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. - - Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. +class SessionBulkDeleteResult: + """Map of sessionId -> bytes freed by removing the session's workspace directory.""" - Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. + freed_bytes: dict[str, int] + """Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions + whose deletion failed are omitted from this map (failures are logged on the server but + not surfaced per-id; check the map for absent IDs to detect them). """ - entitlement: float | None = None - has_quota: bool | None = None - overage_count: float | None = None - overage_permitted: bool | None = None - percent_remaining: float | None = None - quota_id: str | None = None - quota_remaining: float | None = None - quota_reset_at: float | None = None - remaining: float | None = None - timestamp_utc: str | None = None - token_based_billing: bool | None = None - unlimited: bool | None = None @staticmethod - def from_dict(obj: Any) -> 'CopilotUserResponseQuotaSnapshots': + def from_dict(obj: Any) -> 'SessionBulkDeleteResult': assert isinstance(obj, dict) - entitlement = from_union([from_float, from_none], obj.get("entitlement")) - has_quota = from_union([from_bool, from_none], obj.get("has_quota")) - overage_count = from_union([from_float, from_none], obj.get("overage_count")) - overage_permitted = from_union([from_bool, from_none], obj.get("overage_permitted")) - percent_remaining = from_union([from_float, from_none], obj.get("percent_remaining")) - quota_id = from_union([from_str, from_none], obj.get("quota_id")) - quota_remaining = from_union([from_float, from_none], obj.get("quota_remaining")) - quota_reset_at = from_union([from_float, from_none], obj.get("quota_reset_at")) - remaining = from_union([from_float, from_none], obj.get("remaining")) - timestamp_utc = from_union([from_str, from_none], obj.get("timestamp_utc")) - token_based_billing = from_union([from_bool, from_none], obj.get("token_based_billing")) - unlimited = from_union([from_bool, from_none], obj.get("unlimited")) - return CopilotUserResponseQuotaSnapshots(entitlement, has_quota, overage_count, overage_permitted, percent_remaining, quota_id, quota_remaining, quota_reset_at, remaining, timestamp_utc, token_based_billing, unlimited) + freed_bytes = from_dict(from_int, obj.get("freedBytes")) + return SessionBulkDeleteResult(freed_bytes) def to_dict(self) -> dict: result: dict = {} - if self.entitlement is not None: - result["entitlement"] = from_union([to_float, from_none], self.entitlement) - if self.has_quota is not None: - result["has_quota"] = from_union([from_bool, from_none], self.has_quota) - if self.overage_count is not None: - result["overage_count"] = from_union([to_float, from_none], self.overage_count) - if self.overage_permitted is not None: - result["overage_permitted"] = from_union([from_bool, from_none], self.overage_permitted) - if self.percent_remaining is not None: - result["percent_remaining"] = from_union([to_float, from_none], self.percent_remaining) - if self.quota_id is not None: - result["quota_id"] = from_union([from_str, from_none], self.quota_id) - if self.quota_remaining is not None: - result["quota_remaining"] = from_union([to_float, from_none], self.quota_remaining) - if self.quota_reset_at is not None: - result["quota_reset_at"] = from_union([to_float, from_none], self.quota_reset_at) - if self.remaining is not None: - result["remaining"] = from_union([to_float, from_none], self.remaining) - if self.timestamp_utc is not None: - result["timestamp_utc"] = from_union([from_str, from_none], self.timestamp_utc) - if self.token_based_billing is not None: - result["token_based_billing"] = from_union([from_bool, from_none], self.token_based_billing) - if self.unlimited is not None: - result["unlimited"] = from_union([from_bool, from_none], self.unlimited) + result["freedBytes"] = from_dict(from_int, self.freed_bytes) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class CurrentModel: - """The currently selected model, reasoning effort, and context tier for the session.""" +class SessionCapability(Enum): + """Session capability enabled for this session - context_tier: ModelCurrentContextTier | None = None - """Context tier currently pinned for the session, when one is set. Reflects - `Session.getContextTier()`, restored from the session journal on resume. + Session capability id """ - model_id: str | None = None - """Currently active model identifier""" + ASK_USER = "ask-user" + CANVAS_RENDERER = "canvas-renderer" + CLI_DOCUMENTATION = "cli-documentation" + ELICITATION = "elicitation" + INTERACTIVE_MODE = "interactive-mode" + MCP_APPS = "mcp-apps" + MEMORY = "memory" + PLAN_MODE = "plan-mode" + SESSION_STORE = "session-store" + SYSTEM_NOTIFICATIONS = "system-notifications" + TUI_HINTS = "tui-hints" - reasoning_effort: str | None = None - """Reasoning effort level currently applied to the active model, when one is set. Reads - `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the - two values are reported as a snapshot. - """ +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCommandsListRequest: + include_builtins: bool | None = None + """Include runtime built-in commands""" + + include_client_commands: bool | None = None + """Include commands registered by protocol clients, including SDK clients and extensions""" + + include_skills: bool | None = None + """Include enabled user-invocable skills and commands""" @staticmethod - def from_dict(obj: Any) -> 'CurrentModel': + def from_dict(obj: Any) -> 'SessionCommandsListRequest': assert isinstance(obj, dict) - context_tier = from_union([ModelCurrentContextTier, from_none], obj.get("contextTier")) - model_id = from_union([from_str, from_none], obj.get("modelId")) - reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) - return CurrentModel(context_tier, model_id, reasoning_effort) + include_builtins = from_union([from_bool, from_none], obj.get("includeBuiltins")) + include_client_commands = from_union([from_bool, from_none], obj.get("includeClientCommands")) + include_skills = from_union([from_bool, from_none], obj.get("includeSkills")) + return SessionCommandsListRequest(include_builtins, include_client_commands, include_skills) def to_dict(self) -> dict: result: dict = {} - if self.context_tier is not None: - result["contextTier"] = from_union([lambda x: to_enum(ModelCurrentContextTier, x), from_none], self.context_tier) - if self.model_id is not None: - result["modelId"] = from_union([from_str, from_none], self.model_id) - if self.reasoning_effort is not None: - result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + if self.include_builtins is not None: + result["includeBuiltins"] = from_union([from_bool, from_none], self.include_builtins) + if self.include_client_commands is not None: + result["includeClientCommands"] = from_union([from_bool, from_none], self.include_client_commands) + if self.include_skills is not None: + result["includeSkills"] = from_union([from_bool, from_none], self.include_skills) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class DiscoveredMCPServer: - """Schema for the `DiscoveredMcpServer` type.""" - - enabled: bool - """Whether the server is enabled (not in the disabled list)""" +class SessionFSAppendFileRequest: + """File path, content to append, and optional mode for the client-provided session + filesystem. + """ + content: str + """Content to append""" - name: str - """Server name (config key)""" + path: str + """Path using SessionFs conventions""" - source: McpServerSource - """Configuration source: user, workspace, plugin, or builtin""" + session_id: str + """Target session identifier""" - type: DiscoveredMCPServerType | None = None - """Server transport type: stdio, http, sse (deprecated), or memory""" + mode: int | None = None + """Optional POSIX-style mode for newly created files""" @staticmethod - def from_dict(obj: Any) -> 'DiscoveredMCPServer': + def from_dict(obj: Any) -> 'SessionFSAppendFileRequest': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - name = from_str(obj.get("name")) - source = McpServerSource(obj.get("source")) - type = from_union([DiscoveredMCPServerType, from_none], obj.get("type")) - return DiscoveredMCPServer(enabled, name, source, type) + content = from_str(obj.get("content")) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + mode = from_union([from_int, from_none], obj.get("mode")) + return SessionFSAppendFileRequest(content, path, session_id, mode) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - result["name"] = from_str(self.name) - result["source"] = to_enum(McpServerSource, self.source) - if self.type is not None: - result["type"] = from_union([lambda x: to_enum(DiscoveredMCPServerType, x), from_none], self.type) + result["content"] = from_str(self.content) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) + if self.mode is not None: + result["mode"] = from_union([from_int, from_none], self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class EventLogReadRequest: - """Cursor, batch size, and optional long-poll/filter parameters for reading session events.""" +class SessionFSErrorCode(Enum): + """Error classification""" - agent_scope: EventsAgentScope | None = None - """Agent-scope filter: 'primary' returns only main-agent events plus events whose type - starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns - events from all agents (matching wildcard-subscription behavior). Default is 'all' to - preserve wildcard semantics for catch-up callers. - """ - cursor: str | None = None - """Opaque cursor returned by a previous read. Omit on the first call to start from the - beginning of the session's persisted history. - """ - max: int | None = None - """Maximum number of events to return in this batch (1–1000, default 200).""" + ENOENT = "ENOENT" + UNKNOWN = "UNKNOWN" - types: list[str] | EventLogTypes | None = None - """Either '*' to receive all event types, or a non-empty list of event types to receive""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSExistsRequest: + """Path to test for existence in the client-provided session filesystem.""" - wait_ms: int | None = None - """Milliseconds to wait for new events when the cursor is at the tail of history. 0 - (default) returns immediately even if no events are available. Capped at 30000ms. - Ephemeral events that arrive during the wait are delivered in this batch but are NOT - replayable on a subsequent read (use a non-zero waitMs in your next call to capture - future ephemerals as they happen). - """ + path: str + """Path using SessionFs conventions""" + + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'EventLogReadRequest': + def from_dict(obj: Any) -> 'SessionFSExistsRequest': assert isinstance(obj, dict) - agent_scope = from_union([EventsAgentScope, from_none], obj.get("agentScope")) - cursor = from_union([from_str, from_none], obj.get("cursor")) - max = from_union([from_int, from_none], obj.get("max")) - types = from_union([lambda x: from_list(from_str, x), EventLogTypes, from_none], obj.get("types")) - wait_ms = from_union([from_int, from_none], obj.get("waitMs")) - return EventLogReadRequest(agent_scope, cursor, max, types, wait_ms) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + return SessionFSExistsRequest(path, session_id) def to_dict(self) -> dict: result: dict = {} - if self.agent_scope is not None: - result["agentScope"] = from_union([lambda x: to_enum(EventsAgentScope, x), from_none], self.agent_scope) - if self.cursor is not None: - result["cursor"] = from_union([from_str, from_none], self.cursor) - if self.max is not None: - result["max"] = from_union([from_int, from_none], self.max) - if self.types is not None: - result["types"] = from_union([lambda x: from_list(from_str, x), lambda x: to_enum(EventLogTypes, x), from_none], self.types) - if self.wait_ms is not None: - result["waitMs"] = from_union([from_int, from_none], self.wait_ms) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class EventsReadResult: - """Batch of session events returned by a read, with cursor and continuation metadata.""" +class SessionFSExistsResult: + """Indicates whether the requested path exists in the client-provided session filesystem.""" - cursor: str - """Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue - from where this read left off. Always present, even when no events were returned. - """ - cursor_status: EventsCursorStatus - """Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor - referred to an event that no longer exists in history (e.g. truncated or compacted away) - and the read started from the beginning of the remaining history. - """ - events: list[SessionEvent] - """Events are delivered in two batches per read: persisted events first (in append order), - then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were - empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral - events do not interleave within a single read. - """ - has_more: bool - """True when the read returned `max` events and more events are available immediately. When - false, the next read with a non-zero `waitMs` will block until a new event arrives or the - wait expires. - """ + exists: bool + """Whether the path exists""" @staticmethod - def from_dict(obj: Any) -> 'EventsReadResult': + def from_dict(obj: Any) -> 'SessionFSExistsResult': assert isinstance(obj, dict) - cursor = from_str(obj.get("cursor")) - cursor_status = EventsCursorStatus(obj.get("cursorStatus")) - events = from_list(SessionEvent.from_dict, obj.get("events")) - has_more = from_bool(obj.get("hasMore")) - return EventsReadResult(cursor, cursor_status, events, has_more) + exists = from_bool(obj.get("exists")) + return SessionFSExistsResult(exists) def to_dict(self) -> dict: result: dict = {} - result["cursor"] = from_str(self.cursor) - result["cursorStatus"] = to_enum(EventsCursorStatus, self.cursor_status) - result["events"] = from_list(lambda x: to_class(SessionEvent, x), self.events) - result["hasMore"] = from_bool(self.has_more) + result["exists"] = from_bool(self.exists) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Extension: - """Schema for the `Extension` type.""" - - id: str - """Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper')""" - - name: str - """Extension name (directory name)""" +class SessionFSMkdirRequest: + """Directory path to create in the client-provided session filesystem, with options for + recursive creation and POSIX mode. + """ + path: str + """Path using SessionFs conventions""" - source: ExtensionSource - """Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)""" + session_id: str + """Target session identifier""" - status: ExtensionStatus - """Current status: running, disabled, failed, or starting""" + mode: int | None = None + """Optional POSIX-style mode for newly created directories""" - pid: int | None = None - """Process ID if the extension is running""" + recursive: bool | None = None + """Create parent directories as needed""" @staticmethod - def from_dict(obj: Any) -> 'Extension': + def from_dict(obj: Any) -> 'SessionFSMkdirRequest': assert isinstance(obj, dict) - id = from_str(obj.get("id")) - name = from_str(obj.get("name")) - source = ExtensionSource(obj.get("source")) - status = ExtensionStatus(obj.get("status")) - pid = from_union([from_int, from_none], obj.get("pid")) - return Extension(id, name, source, status, pid) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + mode = from_union([from_int, from_none], obj.get("mode")) + recursive = from_union([from_bool, from_none], obj.get("recursive")) + return SessionFSMkdirRequest(path, session_id, mode, recursive) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_str(self.id) - result["name"] = from_str(self.name) - result["source"] = to_enum(ExtensionSource, self.source) - result["status"] = to_enum(ExtensionStatus, self.status) - if self.pid is not None: - result["pid"] = from_union([from_int, from_none], self.pid) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) + if self.mode is not None: + result["mode"] = from_union([from_int, from_none], self.mode) + if self.recursive is not None: + result["recursive"] = from_union([from_bool, from_none], self.recursive) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmBinaryResultsForLlm: - """Binary result returned by a tool for the model""" +class SessionFSReadFileRequest: + """Path of the file to read from the client-provided session filesystem.""" - data: str - """Base64-encoded binary data""" + path: str + """Path using SessionFs conventions""" - mime_type: str - """MIME type of the binary data""" - - type: ExternalToolTextResultForLlmBinaryResultsForLlmType - """Binary result type discriminator. Use "image" for images and "resource" for other binary - data. - """ - description: str | None = None - """Human-readable description of the binary data""" - - metadata: dict[str, Any] | None = None - """Optional metadata from the producing tool.""" + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmBinaryResultsForLlm': + def from_dict(obj: Any) -> 'SessionFSReadFileRequest': assert isinstance(obj, dict) - data = from_str(obj.get("data")) - mime_type = from_str(obj.get("mimeType")) - type = ExternalToolTextResultForLlmBinaryResultsForLlmType(obj.get("type")) - description = from_union([from_str, from_none], obj.get("description")) - metadata = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("metadata")) - return ExternalToolTextResultForLlmBinaryResultsForLlm(data, mime_type, type, description, metadata) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + return SessionFSReadFileRequest(path, session_id) def to_dict(self) -> dict: result: dict = {} - result["data"] = from_str(self.data) - result["mimeType"] = from_str(self.mime_type) - result["type"] = to_enum(ExternalToolTextResultForLlmBinaryResultsForLlmType, self.type) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.metadata is not None: - result["metadata"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.metadata) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentResourceLinkIcon: - """Icon image for a resource""" +class SessionFSReaddirRequest: + """Directory path whose entries should be listed from the client-provided session filesystem.""" - src: str - """URL or path to the icon image""" + path: str + """Path using SessionFs conventions""" - mime_type: str | None = None - """MIME type of the icon image""" + session_id: str + """Target session identifier""" - sizes: list[str] | None = None - """Available icon sizes (e.g., ['16x16', '32x32'])""" + @staticmethod + def from_dict(obj: Any) -> 'SessionFSReaddirRequest': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + return SessionFSReaddirRequest(path, session_id) - theme: Theme | None = None - """Theme variant this icon is intended for""" + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSReaddirWithTypesRequest: + """Directory path whose entries (with type information) should be listed from the + client-provided session filesystem. + """ + path: str + """Path using SessionFs conventions""" + + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLinkIcon': + def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesRequest': assert isinstance(obj, dict) - src = from_str(obj.get("src")) - mime_type = from_union([from_str, from_none], obj.get("mimeType")) - sizes = from_union([lambda x: from_list(from_str, x), from_none], obj.get("sizes")) - theme = from_union([Theme, from_none], obj.get("theme")) - return ExternalToolTextResultForLlmContentResourceLinkIcon(src, mime_type, sizes, theme) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + return SessionFSReaddirWithTypesRequest(path, session_id) def to_dict(self) -> dict: result: dict = {} - result["src"] = from_str(self.src) - if self.mime_type is not None: - result["mimeType"] = from_union([from_str, from_none], self.mime_type) - if self.sizes is not None: - result["sizes"] = from_union([lambda x: from_list(from_str, x), from_none], self.sizes) - if self.theme is not None: - result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) return result -ExternalToolTextResultForLlmContentResourceDetails = EmbeddedTextResourceContents | EmbeddedBlobResourceContents - # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentAudio: - """Audio content block with base64-encoded data""" - - data: str - """Base64-encoded audio data""" +class SessionFSRenameRequest: + """Source and destination paths for renaming or moving an entry in the client-provided + session filesystem. + """ + dest: str + """Destination path using SessionFs conventions""" - mime_type: str - """MIME type of the audio (e.g., audio/wav, audio/mpeg)""" + session_id: str + """Target session identifier""" - type: ClassVar[str] = "audio" - """Content block type discriminator""" + src: str + """Source path using SessionFs conventions""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentAudio': + def from_dict(obj: Any) -> 'SessionFSRenameRequest': assert isinstance(obj, dict) - data = from_str(obj.get("data")) - mime_type = from_str(obj.get("mimeType")) - return ExternalToolTextResultForLlmContentAudio(data, mime_type) + dest = from_str(obj.get("dest")) + session_id = from_str(obj.get("sessionId")) + src = from_str(obj.get("src")) + return SessionFSRenameRequest(dest, session_id, src) def to_dict(self) -> dict: result: dict = {} - result["data"] = from_str(self.data) - result["mimeType"] = from_str(self.mime_type) - result["type"] = self.type + result["dest"] = from_str(self.dest) + result["sessionId"] = from_str(self.session_id) + result["src"] = from_str(self.src) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentImage: - """Image content block with base64-encoded data""" +class SessionFSRmRequest: + """Path to remove from the client-provided session filesystem, with options for recursive + removal and force. + """ + path: str + """Path using SessionFs conventions""" - data: str - """Base64-encoded image data""" + session_id: str + """Target session identifier""" - mime_type: str - """MIME type of the image (e.g., image/png, image/jpeg)""" + force: bool | None = None + """Ignore errors if the path does not exist""" - type: ClassVar[str] = "image" - """Content block type discriminator""" + recursive: bool | None = None + """Remove directories and their contents recursively""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentImage': + def from_dict(obj: Any) -> 'SessionFSRmRequest': assert isinstance(obj, dict) - data = from_str(obj.get("data")) - mime_type = from_str(obj.get("mimeType")) - return ExternalToolTextResultForLlmContentImage(data, mime_type) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + force = from_union([from_bool, from_none], obj.get("force")) + recursive = from_union([from_bool, from_none], obj.get("recursive")) + return SessionFSRmRequest(path, session_id, force, recursive) def to_dict(self) -> dict: result: dict = {} - result["data"] = from_str(self.data) - result["mimeType"] = from_str(self.mime_type) - result["type"] = self.type + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) + if self.force is not None: + result["force"] = from_union([from_bool, from_none], self.force) + if self.recursive is not None: + result["recursive"] = from_union([from_bool, from_none], self.recursive) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentResource: - """Embedded resource content block with inline text or binary data""" - - resource: ExternalToolTextResultForLlmContentResourceDetails - """The embedded resource contents, either text or base64-encoded binary""" +class SessionFSSetProviderCapabilities: + """Optional capabilities declared by the provider""" - type: ClassVar[str] = "resource" - """Content block type discriminator""" + sqlite: bool | None = None + """Whether the provider supports SQLite query/exists operations""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResource': + def from_dict(obj: Any) -> 'SessionFSSetProviderCapabilities': assert isinstance(obj, dict) - resource = (lambda x: from_union([EmbeddedTextResourceContents.from_dict, EmbeddedBlobResourceContents.from_dict], x))(obj.get("resource")) - return ExternalToolTextResultForLlmContentResource(resource) + sqlite = from_union([from_bool, from_none], obj.get("sqlite")) + return SessionFSSetProviderCapabilities(sqlite) def to_dict(self) -> dict: result: dict = {} - result["resource"] = from_union([lambda x: to_class(EmbeddedTextResourceContents, x), lambda x: to_class(EmbeddedBlobResourceContents, x)], self.resource) - result["type"] = self.type + if self.sqlite is not None: + result["sqlite"] = from_union([from_bool, from_none], self.sqlite) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class ExternalToolTextResultForLlmContentTerminal: - """Terminal/shell output content block with optional exit code and working directory""" - - text: str - """Terminal/shell output text""" +class SessionFSSetProviderConventions(Enum): + """Path conventions used by this filesystem""" - type: ClassVar[str] = "terminal" - """Content block type discriminator""" + POSIX = "posix" + WINDOWS = "windows" - cwd: str | None = None - """Working directory where the command was executed""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSetProviderResult: + """Indicates whether the calling client was registered as the session filesystem provider.""" - exit_code: int | None = None - """Process exit code, if the command has completed""" + success: bool + """Whether the provider was set successfully""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentTerminal': + def from_dict(obj: Any) -> 'SessionFSSetProviderResult': assert isinstance(obj, dict) - text = from_str(obj.get("text")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - exit_code = from_union([from_int, from_none], obj.get("exitCode")) - return ExternalToolTextResultForLlmContentTerminal(text, cwd, exit_code) + success = from_bool(obj.get("success")) + return SessionFSSetProviderResult(success) def to_dict(self) -> dict: result: dict = {} - result["text"] = from_str(self.text) - result["type"] = self.type - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.exit_code is not None: - result["exitCode"] = from_union([from_int, from_none], self.exit_code) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentText: - """Plain text content block""" - - text: str - """The text content""" +class SessionFSSqliteExistsRequest: + """Identifies the target session.""" - type: ClassVar[str] = "text" - """Content block type discriminator""" + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentText': + def from_dict(obj: Any) -> 'SessionFSSqliteExistsRequest': assert isinstance(obj, dict) - text = from_str(obj.get("text")) - return ExternalToolTextResultForLlmContentText(text) + session_id = from_str(obj.get("sessionId")) + return SessionFSSqliteExistsRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["text"] = from_str(self.text) - result["type"] = self.type + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandTextResult: - """Schema for the `SlashCommandTextResult` type.""" - - kind: ClassVar[str] = "text" - """Text result discriminator""" +class SessionFSSqliteExistsResult: + """Indicates whether the per-session SQLite database already exists.""" - text: str - """Text output for the client to render""" + exists: bool + """Whether the session database already exists""" - markdown: bool | None = None - """Whether text contains Markdown""" + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteExistsResult': + assert isinstance(obj, dict) + exists = from_bool(obj.get("exists")) + return SessionFSSqliteExistsResult(exists) - preserve_ansi: bool | None = None - """Whether ANSI sequences should be preserved""" + def to_dict(self) -> dict: + result: dict = {} + result["exists"] = from_bool(self.exists) + return result - runtime_settings_changed: bool | None = None - """True when the invocation mutated user runtime settings; consumers caching settings should - refresh +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionFSSqliteQueryType(Enum): + """How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT + (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) + + How to execute the statement. """ + EXEC = "exec" + QUERY = "query" + RUN = "run" + +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionFSSqliteTransactionErrorClass(Enum): + """SQLite transaction failure classification.""" + + BUSY_OR_LOCKED = "busyOrLocked" + FATAL = "fatal" + POST_COMMIT_AMBIGUOUS = "postCommitAmbiguous" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSStatRequest: + """Path whose metadata should be returned from the client-provided session filesystem.""" + + path: str + """Path using SessionFs conventions""" + + session_id: str + """Target session identifier""" @staticmethod - def from_dict(obj: Any) -> 'SlashCommandTextResult': + def from_dict(obj: Any) -> 'SessionFSStatRequest': assert isinstance(obj, dict) - text = from_str(obj.get("text")) - markdown = from_union([from_bool, from_none], obj.get("markdown")) - preserve_ansi = from_union([from_bool, from_none], obj.get("preserveAnsi")) - runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) - return SlashCommandTextResult(text, markdown, preserve_ansi, runtime_settings_changed) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + return SessionFSStatRequest(path, session_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["text"] = from_str(self.text) - if self.markdown is not None: - result["markdown"] = from_union([from_bool, from_none], self.markdown) - if self.preserve_ansi is not None: - result["preserveAnsi"] = from_union([from_bool, from_none], self.preserve_ansi) - if self.runtime_settings_changed is not None: - result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HistoryCompactResult: - """Compaction outcome with the number of tokens and messages removed, summary text, and the - resulting context window breakdown. - """ - messages_removed: int - """Number of messages removed during compaction""" +class SessionFSWriteFileRequest: + """File path, content to write, and optional mode for the client-provided session filesystem.""" - success: bool - """Whether compaction completed successfully""" + content: str + """Content to write""" - tokens_removed: int - """Number of tokens freed by compaction""" + path: str + """Path using SessionFs conventions""" - context_window: HistoryCompactContextWindow | None = None - """Post-compaction context window usage breakdown""" + session_id: str + """Target session identifier""" - summary_content: str | None = None - """Summary text produced by compaction. Omitted when compaction did not produce a summary - (e.g. failure path). - """ + mode: int | None = None + """Optional POSIX-style mode for newly created files""" @staticmethod - def from_dict(obj: Any) -> 'HistoryCompactResult': + def from_dict(obj: Any) -> 'SessionFSWriteFileRequest': assert isinstance(obj, dict) - messages_removed = from_int(obj.get("messagesRemoved")) - success = from_bool(obj.get("success")) - tokens_removed = from_int(obj.get("tokensRemoved")) - context_window = from_union([HistoryCompactContextWindow.from_dict, from_none], obj.get("contextWindow")) - summary_content = from_union([from_str, from_none], obj.get("summaryContent")) - return HistoryCompactResult(messages_removed, success, tokens_removed, context_window, summary_content) + content = from_str(obj.get("content")) + path = from_str(obj.get("path")) + session_id = from_str(obj.get("sessionId")) + mode = from_union([from_int, from_none], obj.get("mode")) + return SessionFSWriteFileRequest(content, path, session_id, mode) def to_dict(self) -> dict: result: dict = {} - result["messagesRemoved"] = from_int(self.messages_removed) - result["success"] = from_bool(self.success) - result["tokensRemoved"] = from_int(self.tokens_removed) - if self.context_window is not None: - result["contextWindow"] = from_union([lambda x: to_class(HistoryCompactContextWindow, x), from_none], self.context_window) - if self.summary_content is not None: - result["summaryContent"] = from_union([from_str, from_none], self.summary_content) + result["content"] = from_str(self.content) + result["path"] = from_str(self.path) + result["sessionId"] = from_str(self.session_id) + if self.mode is not None: + result["mode"] = from_union([from_int, from_none], self.mode) return result +class Trigger(Enum): + """What initiated this compaction request, recorded as the `trigger` on the persisted + `session.compaction_start` / `session.compaction_complete` events. When absent, the + compaction is persisted without trigger attribution (initiator unknown). + """ + MANUAL = "manual" + MODEL_SWITCH = "model_switch" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstalledPluginSourceGithub: - """Schema for the `InstalledPluginSourceGithub` type.""" +class SessionLimitPredictionBaselineData: + """Baseline data provenance for a prediction. - repo: str - source: FluffySource - """Constant value. Always "github".""" + Baseline data provenance. + """ + window_end: str + """End of the baseline data slice.""" - path: str | None = None - ref: str | None = None + window_start: str + """Start of the baseline data slice.""" @staticmethod - def from_dict(obj: Any) -> 'InstalledPluginSourceGithub': + def from_dict(obj: Any) -> 'SessionLimitPredictionBaselineData': assert isinstance(obj, dict) - repo = from_str(obj.get("repo")) - source = FluffySource(obj.get("source")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - return InstalledPluginSourceGithub(repo, source, path, ref) + window_end = from_str(obj.get("windowEnd")) + window_start = from_str(obj.get("windowStart")) + return SessionLimitPredictionBaselineData(window_end, window_start) def to_dict(self) -> dict: result: dict = {} - result["repo"] = from_str(self.repo) - result["source"] = to_enum(FluffySource, self.source) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) + result["windowEnd"] = from_str(self.window_end) + result["windowStart"] = from_str(self.window_start) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionInstalledPluginSourceGithub: - """Schema for the `SessionInstalledPluginSourceGithub` type.""" +class SessionLimitPredictionClientType(Enum): + """Client population used for the prediction baseline. - repo: str - source: FluffySource - """Constant value. Always "github".""" + Client population used for the prediction. - path: str | None = None - ref: str | None = None + Client type to size for. Defaults to `cli-interactive`. + """ + CLI_INTERACTIVE = "cli-interactive" + CLI_PROMPT = "cli-prompt" + +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionLimitPredictionTier(Enum): + """Tier chosen as the recommended cap. + + Semantic usage tier used for a recommended cap or additional headroom. + """ + ADDITIONAL_HEADROOM = "additional_headroom" + GENEROUS_HEADROOM = "generous_headroom" + MAXIMUM_HEADROOM = "maximum_headroom" + RECOMMENDED = "recommended" + +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionLimitPredictionSource(Enum): + """Baseline fallback level used to create the prediction.""" + + FAMILY = "family" + GLOBAL = "global" + MODEL = "model" + +class SessionLimitPredictionResultKind(Enum): + AVAILABLE = "available" + UNAVAILABLE = "unavailable" + +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionLimitPredictionUnavailableReason(Enum): + """Reason no prediction is available. + + Reason a prediction could not be computed. + """ + AUTO_UNRESOLVED = "auto_unresolved" + NO_MODEL = "no_model" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionList: + """Sessions matching the filter, ordered most-recently-modified first.""" + + sessions: list[SessionListEntry] + """Sessions ordered most-recently-modified first. Discriminated by `isRemote`.""" @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPluginSourceGithub': + def from_dict(obj: Any) -> 'SessionList': assert isinstance(obj, dict) - repo = from_str(obj.get("repo")) - source = FluffySource(obj.get("source")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - return SessionInstalledPluginSourceGithub(repo, source, path, ref) + sessions = from_list(_load_SessionListEntry, obj.get("sessions")) + return SessionList(sessions) def to_dict(self) -> dict: result: dict = {} - result["repo"] = from_str(self.repo) - result["source"] = to_enum(FluffySource, self.source) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) + result["sessions"] = from_list(lambda x: (x).to_dict(), self.sessions) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstalledPluginSourceLocal: - """Schema for the `InstalledPluginSourceLocal` type.""" +class SessionListFilter: + """Optional filter applied to the returned sessions""" - path: str - source: TentacledSource - """Constant value. Always "local".""" + branch: str | None = None + """Match sessions whose context.branch equals this value""" + + cwd: str | None = None + """Match sessions whose context.cwd equals this value""" + + git_root: str | None = None + """Match sessions whose context.gitRoot equals this value""" + + repository: str | None = None + """Match sessions whose context.repository equals this value""" @staticmethod - def from_dict(obj: Any) -> 'InstalledPluginSourceLocal': + def from_dict(obj: Any) -> 'SessionListFilter': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - source = TentacledSource(obj.get("source")) - return InstalledPluginSourceLocal(path, source) + branch = from_union([from_str, from_none], obj.get("branch")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + git_root = from_union([from_str, from_none], obj.get("gitRoot")) + repository = from_union([from_str, from_none], obj.get("repository")) + return SessionListFilter(branch, cwd, git_root, repository) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["source"] = to_enum(TentacledSource, self.source) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.git_root is not None: + result["gitRoot"] = from_union([from_str, from_none], self.git_root) + if self.repository is not None: + result["repository"] = from_union([from_str, from_none], self.repository) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionInstalledPluginSourceLocal: - """Schema for the `SessionInstalledPluginSourceLocal` type.""" +class SessionLoadDeferredRepoHooksResult: + """Queued repo-level startup prompts and the total hook command count after loading.""" - path: str - source: TentacledSource - """Constant value. Always "local".""" + hook_count: int + """Total hook command count (user + plugin + repo) loaded for the session by this call. + Captured atomically with startupPrompts so callers don't need to read a separate counter. + """ + startup_prompts: list[str] + """Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo + configs were pending, or when disableAllHooks is set. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPluginSourceLocal': + def from_dict(obj: Any) -> 'SessionLoadDeferredRepoHooksResult': assert isinstance(obj, dict) - path = from_str(obj.get("path")) - source = TentacledSource(obj.get("source")) - return SessionInstalledPluginSourceLocal(path, source) + hook_count = from_int(obj.get("hookCount")) + startup_prompts = from_list(from_str, obj.get("startupPrompts")) + return SessionLoadDeferredRepoHooksResult(hook_count, startup_prompts) def to_dict(self) -> dict: result: dict = {} - result["path"] = from_str(self.path) - result["source"] = to_enum(TentacledSource, self.source) + result["hookCount"] = from_int(self.hook_count) + result["startupPrompts"] = from_list(from_str, self.startup_prompts) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstalledPluginSourceURL: - """Schema for the `InstalledPluginSourceUrl` type.""" - - source: StickySource - """Constant value. Always "url".""" - - url: str - path: str | None = None - ref: str | None = None +class SessionModelListRequest: + skip_cache: bool | None = None + """If true, bypasses the per-session model list cache and re-fetches from CAPI.""" @staticmethod - def from_dict(obj: Any) -> 'InstalledPluginSourceURL': + def from_dict(obj: Any) -> 'SessionModelListRequest': assert isinstance(obj, dict) - source = StickySource(obj.get("source")) - url = from_str(obj.get("url")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - return InstalledPluginSourceURL(source, url, path, ref) + skip_cache = from_union([from_bool, from_none], obj.get("skipCache")) + return SessionModelListRequest(skip_cache) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(StickySource, self.source) - result["url"] = from_str(self.url) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) + if self.skip_cache is not None: + result["skipCache"] = from_union([from_bool, from_none], self.skip_cache) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionInstalledPluginSourceURL: - """Schema for the `SessionInstalledPluginSourceUrl` type.""" - - source: StickySource - """Constant value. Always "url".""" +class SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource: + """Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.""" - url: str - path: str | None = None - ref: str | None = None + name: str + type: str @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPluginSourceURL': + def from_dict(obj: Any) -> 'SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource': assert isinstance(obj, dict) - source = StickySource(obj.get("source")) - url = from_str(obj.get("url")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - return SessionInstalledPluginSourceURL(source, url, path, ref) + name = from_str(obj.get("name")) + type = from_str(obj.get("type")) + return SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource(name, type) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(StickySource, self.source) - result["url"] = from_str(self.url) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) + result["name"] = from_str(self.name) + result["type"] = from_str(self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class InstructionsSources: - """Schema for the `InstructionsSources` type.""" +class ShellInitProfile(Enum): + """Controls automatic non-interactive profile loading where supported. Explicit initScripts + are unaffected. + """ + NONE = "none" + NON_INTERACTIVE = "non-interactive" - content: str - """Raw content of the instruction file""" +# Experimental: this type is part of an experimental API and may change or be removed. +class ShellInitScriptShell(Enum): + """Built-in shell that may source this script. - id: str - """Unique identifier for this source (used for toggling)""" + Supported built-in shells for initialization scripts. + """ + BASH = "bash" + POWERSHELL = "powershell" - label: str - """Human-readable label""" +class SessionOpenParamsKind(Enum): + ATTACH = "attach" + CLOUD = "cloud" + CREATE = "create" + HANDOFF = "handoff" + REMOTE = "remote" + RESUME = "resume" + RESUME_LAST = "resumeLast" - location: InstructionsSourcesLocation - """Where this source lives — used for UI grouping""" +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionsOpenProgressStatus(Enum): + """Step status.""" - source_path: str - """File path relative to repo or absolute for home""" + COMPLETE = "complete" + IN_PROGRESS = "in-progress" - type: InstructionsSourcesType - """Category of instruction source — used for merge logic""" +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionsOpenProgressStep(Enum): + """Handoff step.""" - apply_to: list[str] | None = None - """Glob pattern(s) from frontmatter — when set, this instruction applies only to matching - files + CHECKOUT_BRANCH = "checkout-branch" + CHECK_CHANGES = "check-changes" + CREATE_SESSION = "create-session" + LOAD_SESSION = "load-session" + SAVE_SESSION = "save-session" + VALIDATE_REPO = "validate-repo" + +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionsOpenStatus(Enum): + """Outcome of the open request.""" + + CONNECTED = "connected" + CREATED = "created" + HANDED_OFF = "handed_off" + NOT_FOUND = "not_found" + RESUMED = "resumed" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionPluginsReloadRequest: + defer_repo_hooks: bool | None = None + """When true, skip repo-level hooks during the hook reload. Use before folder trust is + confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. """ - default_disabled: bool | None = None - """When true, this source starts disabled and must be toggled on by the user""" + reload_custom_agents: bool | None = None + """Re-run custom-agent discovery after refreshing plugins. Defaults to true.""" - description: str | None = None - """Short description (body after frontmatter) for use in instruction tables""" + reload_extensions: bool | None = None + """Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) + after refreshing plugins. Defaults to true. Has no effect when the session has no active + extension controller (e.g. extensions were not requested for the session). + """ + reload_hooks: bool | None = None + """Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has + no effect when the host has not registered a hook reloader (e.g. remote sessions). + """ + reload_mcp: bool | None = None + """Reload MCP server connections after refreshing plugins. Defaults to true.""" @staticmethod - def from_dict(obj: Any) -> 'InstructionsSources': + def from_dict(obj: Any) -> 'SessionPluginsReloadRequest': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - id = from_str(obj.get("id")) - label = from_str(obj.get("label")) - location = InstructionsSourcesLocation(obj.get("location")) - source_path = from_str(obj.get("sourcePath")) - type = InstructionsSourcesType(obj.get("type")) - apply_to = from_union([lambda x: from_list(from_str, x), from_none], obj.get("applyTo")) - default_disabled = from_union([from_bool, from_none], obj.get("defaultDisabled")) - description = from_union([from_str, from_none], obj.get("description")) - return InstructionsSources(content, id, label, location, source_path, type, apply_to, default_disabled, description) + defer_repo_hooks = from_union([from_bool, from_none], obj.get("deferRepoHooks")) + reload_custom_agents = from_union([from_bool, from_none], obj.get("reloadCustomAgents")) + reload_extensions = from_union([from_bool, from_none], obj.get("reloadExtensions")) + reload_hooks = from_union([from_bool, from_none], obj.get("reloadHooks")) + reload_mcp = from_union([from_bool, from_none], obj.get("reloadMcp")) + return SessionPluginsReloadRequest(defer_repo_hooks, reload_custom_agents, reload_extensions, reload_hooks, reload_mcp) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["id"] = from_str(self.id) - result["label"] = from_str(self.label) - result["location"] = to_enum(InstructionsSourcesLocation, self.location) - result["sourcePath"] = from_str(self.source_path) - result["type"] = to_enum(InstructionsSourcesType, self.type) - if self.apply_to is not None: - result["applyTo"] = from_union([lambda x: from_list(from_str, x), from_none], self.apply_to) - if self.default_disabled is not None: - result["defaultDisabled"] = from_union([from_bool, from_none], self.default_disabled) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) + if self.defer_repo_hooks is not None: + result["deferRepoHooks"] = from_union([from_bool, from_none], self.defer_repo_hooks) + if self.reload_custom_agents is not None: + result["reloadCustomAgents"] = from_union([from_bool, from_none], self.reload_custom_agents) + if self.reload_extensions is not None: + result["reloadExtensions"] = from_union([from_bool, from_none], self.reload_extensions) + if self.reload_hooks is not None: + result["reloadHooks"] = from_union([from_bool, from_none], self.reload_hooks) + if self.reload_mcp is not None: + result["reloadMcp"] = from_union([from_bool, from_none], self.reload_mcp) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class LogRequest: - """Message text, optional severity level, persistence flag, optional follow-up URL, and - optional tip. +class SessionPruneResult: + """Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes + freed, and the dry-run flag. """ - message: str - """Human-readable message""" + candidates: list[str] + """Session IDs that would be deleted in dry-run mode (always empty otherwise)""" - ephemeral: bool | None = None - """When true, the message is transient and not persisted to the session event log on disk""" + deleted: list[str] + """Session IDs that were deleted (always empty in dry-run mode)""" - level: SessionLogLevel | None = None - """Log severity level. Determines how the message is displayed in the timeline. Defaults to - "info". - """ - tip: str | None = None - """Optional actionable tip displayed alongside the message. Only honored on `level: "info"`.""" + dry_run: bool + """True when no deletions were actually performed""" - type: str | None = None - """Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps - to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". - """ - url: str | None = None - """Optional URL the user can open in their browser for more details""" + freed_bytes: int + """Total bytes freed (actual when not dry-run, projected when dry-run)""" + + skipped: list[str] + """Session IDs that were skipped (e.g., named sessions)""" @staticmethod - def from_dict(obj: Any) -> 'LogRequest': + def from_dict(obj: Any) -> 'SessionPruneResult': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - ephemeral = from_union([from_bool, from_none], obj.get("ephemeral")) - level = from_union([SessionLogLevel, from_none], obj.get("level")) - tip = from_union([from_str, from_none], obj.get("tip")) - type = from_union([from_str, from_none], obj.get("type")) - url = from_union([from_str, from_none], obj.get("url")) - return LogRequest(message, ephemeral, level, tip, type, url) + candidates = from_list(from_str, obj.get("candidates")) + deleted = from_list(from_str, obj.get("deleted")) + dry_run = from_bool(obj.get("dryRun")) + freed_bytes = from_int(obj.get("freedBytes")) + skipped = from_list(from_str, obj.get("skipped")) + return SessionPruneResult(candidates, deleted, dry_run, freed_bytes, skipped) def to_dict(self) -> dict: result: dict = {} - result["message"] = from_str(self.message) - if self.ephemeral is not None: - result["ephemeral"] = from_union([from_bool, from_none], self.ephemeral) - if self.level is not None: - result["level"] = from_union([lambda x: to_enum(SessionLogLevel, x), from_none], self.level) - if self.tip is not None: - result["tip"] = from_union([from_str, from_none], self.tip) - if self.type is not None: - result["type"] = from_union([from_str, from_none], self.type) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + result["candidates"] = from_list(from_str, self.candidates) + result["deleted"] = from_list(from_str, self.deleted) + result["dryRun"] = from_bool(self.dry_run) + result["freedBytes"] = from_int(self.freed_bytes) + result["skipped"] = from_list(from_str, self.skipped) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsDiagnoseResult: - """Diagnostic snapshot of MCP Apps wiring for the named server.""" - - capability: MCPAppsDiagnoseCapability - """Capability negotiation snapshot""" +class SessionSetCredentialsParams: + """New auth credentials to install on the session. Omit to leave credentials unchanged.""" - server: MCPAppsDiagnoseServer - """What the server returned for this session""" + credentials: AuthInfo | None = None + """The new auth credentials to install on the session. When omitted or `undefined`, the call + is a no-op and the session's existing credentials are preserved. The runtime installs the + supplied value immediately for outbound model/API requests. When the credential carries a + raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally + re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous + install) so plan/quota/billing metadata regains fidelity; on resolution failure the + verbatim credential remains installed. It does NOT otherwise validate the credential. + Several variants carry secret material; treat this method's params as containing secrets + at rest and in transit. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPAppsDiagnoseResult': + def from_dict(obj: Any) -> 'SessionSetCredentialsParams': assert isinstance(obj, dict) - capability = MCPAppsDiagnoseCapability.from_dict(obj.get("capability")) - server = MCPAppsDiagnoseServer.from_dict(obj.get("server")) - return MCPAppsDiagnoseResult(capability, server) + credentials = from_union([_load_AuthInfo, from_none], obj.get("credentials")) + return SessionSetCredentialsParams(credentials) def to_dict(self) -> dict: result: dict = {} - result["capability"] = to_class(MCPAppsDiagnoseCapability, self.capability) - result["server"] = to_class(MCPAppsDiagnoseServer, self.server) + if self.credentials is not None: + result["credentials"] = from_union([lambda x: (x).to_dict(), from_none], self.credentials) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsHostContextDetails: - """Current host context""" - - available_display_modes: list[MCPAppsDisplayMode] | None = None - """Display modes the host supports""" +class SessionSetCredentialsResult: + """Indicates whether the credential update succeeded.""" - display_mode: MCPAppsDisplayMode | None = None - """Current display mode (SEP-1865)""" + success: bool + """Whether the operation succeeded""" - locale: str | None = None - """BCP-47 locale, e.g. 'en-US'""" + copilot_user_resolved: bool | None = None + """Whether the session ended up with a populated `copilotUser` for the installed + credentials. `true` when the supplied credential already carried `copilotUser` or it was + successfully re-resolved server-side. `false` when the credential is installed without + `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from + the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In + both `false` cases the token swap still applied, but plan/quota/billing metadata is + degraded. Present whenever a credential was supplied; omitted only when no credential was + supplied (no-op call). + """ - platform: MCPAppsHostContextDetailsPlatform | None = None - """Platform type for responsive design""" + @staticmethod + def from_dict(obj: Any) -> 'SessionSetCredentialsResult': + assert isinstance(obj, dict) + success = from_bool(obj.get("success")) + copilot_user_resolved = from_union([from_bool, from_none], obj.get("copilotUserResolved")) + return SessionSetCredentialsResult(success, copilot_user_resolved) - theme: Theme | None = None - """UI theme preference per SEP-1865""" + def to_dict(self) -> dict: + result: dict = {} + result["success"] = from_bool(self.success) + if self.copilot_user_resolved is not None: + result["copilotUserResolved"] = from_union([from_bool, from_none], self.copilot_user_resolved) + return result - time_zone: str | None = None - """IANA timezone, e.g. 'America/New_York'""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsBuiltInToolAvailabilitySnapshot: + """Availability of built-in job tools surfaced to boundary consumers.""" - user_agent: str | None = None - """Host application identifier""" + create_pull_request: bool | None = None + report_progress: bool | None = None @staticmethod - def from_dict(obj: Any) -> 'MCPAppsHostContextDetails': + def from_dict(obj: Any) -> 'SessionSettingsBuiltInToolAvailabilitySnapshot': assert isinstance(obj, dict) - available_display_modes = from_union([lambda x: from_list(MCPAppsDisplayMode, x), from_none], obj.get("availableDisplayModes")) - display_mode = from_union([MCPAppsDisplayMode, from_none], obj.get("displayMode")) - locale = from_union([from_str, from_none], obj.get("locale")) - platform = from_union([MCPAppsHostContextDetailsPlatform, from_none], obj.get("platform")) - theme = from_union([Theme, from_none], obj.get("theme")) - time_zone = from_union([from_str, from_none], obj.get("timeZone")) - user_agent = from_union([from_str, from_none], obj.get("userAgent")) - return MCPAppsHostContextDetails(available_display_modes, display_mode, locale, platform, theme, time_zone, user_agent) + create_pull_request = from_union([from_bool, from_none], obj.get("createPullRequest")) + report_progress = from_union([from_bool, from_none], obj.get("reportProgress")) + return SessionSettingsBuiltInToolAvailabilitySnapshot(create_pull_request, report_progress) def to_dict(self) -> dict: result: dict = {} - if self.available_display_modes is not None: - result["availableDisplayModes"] = from_union([lambda x: from_list(lambda x: to_enum(MCPAppsDisplayMode, x), x), from_none], self.available_display_modes) - if self.display_mode is not None: - result["displayMode"] = from_union([lambda x: to_enum(MCPAppsDisplayMode, x), from_none], self.display_mode) - if self.locale is not None: - result["locale"] = from_union([from_str, from_none], self.locale) - if self.platform is not None: - result["platform"] = from_union([lambda x: to_enum(MCPAppsHostContextDetailsPlatform, x), from_none], self.platform) - if self.theme is not None: - result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) - if self.time_zone is not None: - result["timeZone"] = from_union([from_str, from_none], self.time_zone) - if self.user_agent is not None: - result["userAgent"] = from_union([from_str, from_none], self.user_agent) + if self.create_pull_request is not None: + result["createPullRequest"] = from_union([from_bool, from_none], self.create_pull_request) + if self.report_progress is not None: + result["reportProgress"] = from_union([from_bool, from_none], self.report_progress) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class MCPAppsSetHostContextDetails: - """Host context advertised to MCP App guests""" +class SessionSettingsPredicateName(Enum): + """Predicate name. The runtime owns the raw feature-flag names and composition logic. - available_display_modes: list[MCPAppsDisplayMode] | None = None - """Display modes the host supports""" + Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names + are intentionally not part of the contract. + """ + CAP_CLAUDE_OPUS_TOKEN_LIMITS_ENABLED = "capClaudeOpusTokenLimitsEnabled" + CCA_USE_TS_AUTOFIND_ENABLED = "ccaUseTsAutofindEnabled" + CHRONICLE_ENABLED = "chronicleEnabled" + CODEQL_CHECKER_ENABLED = "codeqlCheckerEnabled" + CODE_REVIEW_FEATURE_ENABLED = "codeReviewFeatureEnabled" + CONTENT_EXCLUSION_SELF_FETCH_ENABLED = "contentExclusionSelfFetchEnabled" + CO_AUTHOR_HOOK_ENABLED = "coAuthorHookEnabled" + DEPENDABOT_CHECKER_ENABLED = "dependabotCheckerEnabled" + DEPENDENCY_CHECKER_ENABLED = "dependencyCheckerEnabled" + PARALLEL_VALIDATION_ENABLED = "parallelValidationEnabled" + RUNTIME_TIMING_TELEMETRY_ENABLED = "runtimeTimingTelemetryEnabled" + SECURITY_TOOLS_ENABLED = "securityToolsEnabled" + THIRD_PARTY_SECURITY_PROMPT_ENABLED = "thirdPartySecurityPromptEnabled" + TRIVIAL_CHANGE_ENABLED = "trivialChangeEnabled" + TRIVIAL_CHANGE_ENABLED_FOR_CODE_REVIEW = "trivialChangeEnabledForCodeReview" + TRIVIAL_CHANGE_ENABLED_FOR_TOOL = "trivialChangeEnabledForTool" + TRIVIAL_CHANGE_SKIP_ENABLED = "trivialChangeSkipEnabled" + TRIVIAL_CHANGE_SKIP_ENABLED_FOR_CODE_REVIEW = "trivialChangeSkipEnabledForCodeReview" + TRIVIAL_CHANGE_SKIP_ENABLED_FOR_TOOL = "trivialChangeSkipEnabledForTool" - display_mode: MCPAppsDisplayMode | None = None - """Current display mode (SEP-1865)""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsEvaluatePredicateResult: + """Result of evaluating a Rust-owned settings predicate.""" - locale: str | None = None - """BCP-47 locale, e.g. 'en-US'""" + enabled: bool - platform: MCPAppsHostContextDetailsPlatform | None = None - """Platform type for responsive design""" + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsEvaluatePredicateResult': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + return SessionSettingsEvaluatePredicateResult(enabled) - theme: Theme | None = None - """UI theme preference per SEP-1865""" + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + return result - time_zone: str | None = None - """IANA timezone, e.g. 'America/New_York'""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsModelSnapshot: + """Redacted model routing settings for a session.""" - user_agent: str | None = None - """Host application identifier""" + callback_url: str | None = None + default_reasoning_effort: str | None = None + instance_id: str | None = None + model: str | None = None @staticmethod - def from_dict(obj: Any) -> 'MCPAppsSetHostContextDetails': + def from_dict(obj: Any) -> 'SessionSettingsModelSnapshot': assert isinstance(obj, dict) - available_display_modes = from_union([lambda x: from_list(MCPAppsDisplayMode, x), from_none], obj.get("availableDisplayModes")) - display_mode = from_union([MCPAppsDisplayMode, from_none], obj.get("displayMode")) - locale = from_union([from_str, from_none], obj.get("locale")) - platform = from_union([MCPAppsHostContextDetailsPlatform, from_none], obj.get("platform")) - theme = from_union([Theme, from_none], obj.get("theme")) - time_zone = from_union([from_str, from_none], obj.get("timeZone")) - user_agent = from_union([from_str, from_none], obj.get("userAgent")) - return MCPAppsSetHostContextDetails(available_display_modes, display_mode, locale, platform, theme, time_zone, user_agent) + callback_url = from_union([from_str, from_none], obj.get("callbackUrl")) + default_reasoning_effort = from_union([from_str, from_none], obj.get("defaultReasoningEffort")) + instance_id = from_union([from_str, from_none], obj.get("instanceId")) + model = from_union([from_str, from_none], obj.get("model")) + return SessionSettingsModelSnapshot(callback_url, default_reasoning_effort, instance_id, model) def to_dict(self) -> dict: result: dict = {} - if self.available_display_modes is not None: - result["availableDisplayModes"] = from_union([lambda x: from_list(lambda x: to_enum(MCPAppsDisplayMode, x), x), from_none], self.available_display_modes) - if self.display_mode is not None: - result["displayMode"] = from_union([lambda x: to_enum(MCPAppsDisplayMode, x), from_none], self.display_mode) - if self.locale is not None: - result["locale"] = from_union([from_str, from_none], self.locale) - if self.platform is not None: - result["platform"] = from_union([lambda x: to_enum(MCPAppsHostContextDetailsPlatform, x), from_none], self.platform) - if self.theme is not None: - result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) - if self.time_zone is not None: - result["timeZone"] = from_union([from_str, from_none], self.time_zone) - if self.user_agent is not None: - result["userAgent"] = from_union([from_str, from_none], self.user_agent) + if self.callback_url is not None: + result["callbackUrl"] = from_union([from_str, from_none], self.callback_url) + if self.default_reasoning_effort is not None: + result["defaultReasoningEffort"] = from_union([from_str, from_none], self.default_reasoning_effort) + if self.instance_id is not None: + result["instanceId"] = from_union([from_str, from_none], self.instance_id) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsReadResourceResult: - """Resource contents returned by the MCP server.""" +class SessionSettingsOnlineEvaluationSnapshot: + """Online-evaluation settings safe to expose across the SDK boundary.""" - contents: list[MCPAppsResourceContent] - """Resource contents returned by the server""" + disable_online_evaluation: bool | None = None + enable_online_evaluation_output_file: bool | None = None @staticmethod - def from_dict(obj: Any) -> 'MCPAppsReadResourceResult': + def from_dict(obj: Any) -> 'SessionSettingsOnlineEvaluationSnapshot': assert isinstance(obj, dict) - contents = from_list(MCPAppsResourceContent.from_dict, obj.get("contents")) - return MCPAppsReadResourceResult(contents) + disable_online_evaluation = from_union([from_bool, from_none], obj.get("disableOnlineEvaluation")) + enable_online_evaluation_output_file = from_union([from_bool, from_none], obj.get("enableOnlineEvaluationOutputFile")) + return SessionSettingsOnlineEvaluationSnapshot(disable_online_evaluation, enable_online_evaluation_output_file) def to_dict(self) -> dict: result: dict = {} - result["contents"] = from_list(lambda x: to_class(MCPAppsResourceContent, x), self.contents) + if self.disable_online_evaluation is not None: + result["disableOnlineEvaluation"] = from_union([from_bool, from_none], self.disable_online_evaluation) + if self.enable_online_evaluation_output_file is not None: + result["enableOnlineEvaluationOutputFile"] = from_union([from_bool, from_none], self.enable_online_evaluation_output_file) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServerConfigStdio: - """Stdio MCP server configuration launched as a child process.""" +class SessionSettingsRepoSnapshot: + """Redacted repository and GitHub host settings for a session.""" - command: str - """Executable command used to start the Stdio MCP server process.""" + branch: str | None = None + commit: str | None = None + host: str | None = None + host_protocol: str | None = None + id: float | None = None + name: str | None = None + owner_id: float | None = None + owner_name: str | None = None + pr_commit_count: float | None = None + read_write: bool | None = None + secret_scanning_url: str | None = None + server_url: str | None = None - args: list[str] | None = None - """Command-line arguments passed to the Stdio MCP server process.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsRepoSnapshot': + assert isinstance(obj, dict) + branch = from_union([from_str, from_none], obj.get("branch")) + commit = from_union([from_str, from_none], obj.get("commit")) + host = from_union([from_str, from_none], obj.get("host")) + host_protocol = from_union([from_str, from_none], obj.get("hostProtocol")) + id = from_union([from_float, from_none], obj.get("id")) + name = from_union([from_str, from_none], obj.get("name")) + owner_id = from_union([from_float, from_none], obj.get("ownerId")) + owner_name = from_union([from_str, from_none], obj.get("ownerName")) + pr_commit_count = from_union([from_float, from_none], obj.get("prCommitCount")) + read_write = from_union([from_bool, from_none], obj.get("readWrite")) + secret_scanning_url = from_union([from_str, from_none], obj.get("secretScanningUrl")) + server_url = from_union([from_str, from_none], obj.get("serverUrl")) + return SessionSettingsRepoSnapshot(branch, commit, host, host_protocol, id, name, owner_id, owner_name, pr_commit_count, read_write, secret_scanning_url, server_url) - auth: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + def to_dict(self) -> dict: + result: dict = {} + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.commit is not None: + result["commit"] = from_union([from_str, from_none], self.commit) + if self.host is not None: + result["host"] = from_union([from_str, from_none], self.host) + if self.host_protocol is not None: + result["hostProtocol"] = from_union([from_str, from_none], self.host_protocol) + if self.id is not None: + result["id"] = from_union([to_float, from_none], self.id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.owner_id is not None: + result["ownerId"] = from_union([to_float, from_none], self.owner_id) + if self.owner_name is not None: + result["ownerName"] = from_union([from_str, from_none], self.owner_name) + if self.pr_commit_count is not None: + result["prCommitCount"] = from_union([to_float, from_none], self.pr_commit_count) + if self.read_write is not None: + result["readWrite"] = from_union([from_bool, from_none], self.read_write) + if self.secret_scanning_url is not None: + result["secretScanningUrl"] = from_union([from_str, from_none], self.secret_scanning_url) + if self.server_url is not None: + result["serverUrl"] = from_union([from_str, from_none], self.server_url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsValidationSnapshot: + """Redacted validation and memory-tool settings for a session.""" + + advisory_enabled: bool | None = None + codeql_enabled: bool | None = None + code_review_enabled: bool | None = None + code_review_model: str | None = None + dependabot_timeout: float | None = None + memory_store_enabled: bool | None = None + memory_vote_enabled: bool | None = None + secret_scanning_enabled: bool | None = None + timeout: float | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsValidationSnapshot': + assert isinstance(obj, dict) + advisory_enabled = from_union([from_bool, from_none], obj.get("advisoryEnabled")) + codeql_enabled = from_union([from_bool, from_none], obj.get("codeqlEnabled")) + code_review_enabled = from_union([from_bool, from_none], obj.get("codeReviewEnabled")) + code_review_model = from_union([from_str, from_none], obj.get("codeReviewModel")) + dependabot_timeout = from_union([from_float, from_none], obj.get("dependabotTimeout")) + memory_store_enabled = from_union([from_bool, from_none], obj.get("memoryStoreEnabled")) + memory_vote_enabled = from_union([from_bool, from_none], obj.get("memoryVoteEnabled")) + secret_scanning_enabled = from_union([from_bool, from_none], obj.get("secretScanningEnabled")) + timeout = from_union([from_float, from_none], obj.get("timeout")) + return SessionSettingsValidationSnapshot(advisory_enabled, codeql_enabled, code_review_enabled, code_review_model, dependabot_timeout, memory_store_enabled, memory_vote_enabled, secret_scanning_enabled, timeout) + + def to_dict(self) -> dict: + result: dict = {} + if self.advisory_enabled is not None: + result["advisoryEnabled"] = from_union([from_bool, from_none], self.advisory_enabled) + if self.codeql_enabled is not None: + result["codeqlEnabled"] = from_union([from_bool, from_none], self.codeql_enabled) + if self.code_review_enabled is not None: + result["codeReviewEnabled"] = from_union([from_bool, from_none], self.code_review_enabled) + if self.code_review_model is not None: + result["codeReviewModel"] = from_union([from_str, from_none], self.code_review_model) + if self.dependabot_timeout is not None: + result["dependabotTimeout"] = from_union([to_float, from_none], self.dependabot_timeout) + if self.memory_store_enabled is not None: + result["memoryStoreEnabled"] = from_union([from_bool, from_none], self.memory_store_enabled) + if self.memory_vote_enabled is not None: + result["memoryVoteEnabled"] = from_union([from_bool, from_none], self.memory_vote_enabled) + if self.secret_scanning_enabled is not None: + result["secretScanningEnabled"] = from_union([from_bool, from_none], self.secret_scanning_enabled) + if self.timeout is not None: + result["timeout"] = from_union([to_float, from_none], self.timeout) + return result - cwd: str | None = None - """Working directory for the Stdio MCP server process.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSizes: + """Map of sessionId -> on-disk size in bytes for each session's workspace directory.""" - env: dict[str, str] | None = None - """Environment variables to pass to the Stdio MCP server process.""" + sizes: dict[str, int] + """Map of sessionId -> on-disk size in bytes for the session's workspace directory""" - filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None - """Content filtering mode to apply to all tools, or a map of tool name to content filtering - mode. - """ - is_default_server: bool | None = None - """Whether this server is a built-in fallback used when the user has not configured their - own server. - """ - oidc: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionSizes': + assert isinstance(obj, dict) + sizes = from_dict(from_int, obj.get("sizes")) + return SessionSizes(sizes) - timeout: int | None = None - """Timeout in milliseconds for tool calls to this server.""" + def to_dict(self) -> dict: + result: dict = {} + result["sizes"] = from_dict(from_int, self.sizes) + return result - tools: list[str] | None = None - """Tools to include. Defaults to all tools if not specified.""" +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionSource(Enum): + """Which session sources to include. Defaults to `local` for backward compatibility.""" + + ALL = "all" + LOCAL = "local" + REMOTE = "remote" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionTelemetryEngagement: + """Telemetry engagement ID for the session, when available.""" + + engagement_id: str | None = None + """Current telemetry engagement ID, when available.""" @staticmethod - def from_dict(obj: Any) -> 'MCPServerConfigStdio': + def from_dict(obj: Any) -> 'SessionTelemetryEngagement': assert isinstance(obj, dict) - command = from_str(obj.get("command")) - args = from_union([lambda x: from_list(from_str, x), from_none], obj.get("args")) - auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) - filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) - is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) - oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) - timeout = from_union([from_int, from_none], obj.get("timeout")) - tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) - return MCPServerConfigStdio(command, args, auth, cwd, env, filter_mapping, is_default_server, oidc, timeout, tools) + engagement_id = from_union([from_str, from_none], obj.get("engagementId")) + return SessionTelemetryEngagement(engagement_id) def to_dict(self) -> dict: result: dict = {} - result["command"] = from_str(self.command) - if self.args is not None: - result["args"] = from_union([lambda x: from_list(from_str, x), from_none], self.args) - if self.auth is not None: - result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.env is not None: - result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) - if self.filter_mapping is not None: - result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) - if self.is_default_server is not None: - result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) - if self.oidc is not None: - result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) - if self.timeout is not None: - result["timeout"] = from_union([from_int, from_none], self.timeout) - if self.tools is not None: - result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) + if self.engagement_id is not None: + result["engagementId"] = from_union([from_str, from_none], self.engagement_id) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServerConfig: - """MCP server configuration (stdio process or remote HTTP/SSE) - - Stdio MCP server configuration launched as a child process. +class SessionUpdateOptionsResult: + """Indicates whether the session options patch was applied successfully.""" - Remote MCP server configuration accessed over HTTP or SSE. - """ - args: list[str] | None = None - """Command-line arguments passed to the Stdio MCP server process.""" + success: bool + """Whether the operation succeeded""" - auth: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + plugin_hook_count: int | None = None + """Number of hooks loaded from installed plugins, returned when installedPlugins is updated""" - command: str | None = None - """Executable command used to start the Stdio MCP server process.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionUpdateOptionsResult': + assert isinstance(obj, dict) + success = from_bool(obj.get("success")) + plugin_hook_count = from_union([from_int, from_none], obj.get("pluginHookCount")) + return SessionUpdateOptionsResult(success, plugin_hook_count) - cwd: str | None = None - """Working directory for the Stdio MCP server process.""" + def to_dict(self) -> dict: + result: dict = {} + result["success"] = from_bool(self.success) + if self.plugin_hook_count is not None: + result["pluginHookCount"] = from_union([from_int, from_none], self.plugin_hook_count) + return result - env: dict[str, str] | None = None - """Environment variables to pass to the Stdio MCP server process.""" +# Experimental: this type is part of an experimental API and may change or be removed. +class SessionVisibilityStatus(Enum): + """Sharing status for a synced session. "repo" makes the session visible to anyone with read + access to the repository; "unshared" restricts it to the creator and collaborators. - filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None - """Content filtering mode to apply to all tools, or a map of tool name to content filtering - mode. - """ - is_default_server: bool | None = None - """Whether this server is a built-in fallback used when the user has not configured their - own server. - """ - oidc: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + Current sharing status. Absent when the session is not synced or the status could not be + retrieved (e.g. the user is not authenticated). - timeout: int | None = None - """Timeout in milliseconds for tool calls to this server.""" + Sharing status to apply. "repo" makes the session visible to repository readers; + "unshared" restricts it to the creator and collaborators. - tools: list[str] | None = None - """Tools to include. Defaults to all tools if not specified.""" + Effective sharing status after the update. May differ from the requested status for task + types that are already visible to repository readers by default. Absent when the update + could not be applied (e.g. the session is not synced or the user is not authenticated). + """ + REPO = "repo" + UNSHARED = "unshared" - headers: dict[str, str] | None = None - """HTTP headers to include in requests to the remote MCP server.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsBulkDeleteRequest: + """Session IDs to close, deactivate, and delete from disk.""" - oauth_client_id: str | None = None - """OAuth client ID for a pre-registered remote MCP OAuth client.""" + session_ids: list[str] + """Session IDs to close, deactivate, and delete from disk""" - oauth_grant_type: MCPServerConfigHTTPOauthGrantType | None = None - """OAuth grant type to use when authenticating to the remote MCP server.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionsBulkDeleteRequest': + assert isinstance(obj, dict) + session_ids = from_list(from_str, obj.get("sessionIds")) + return SessionsBulkDeleteRequest(session_ids) - oauth_public_client: bool | None = None - """Whether the configured OAuth client is public and does not require a client secret.""" + def to_dict(self) -> dict: + result: dict = {} + result["sessionIds"] = from_list(from_str, self.session_ids) + return result - type: MCPServerConfigHTTPType | None = None - """Remote transport type. Defaults to "http" when omitted.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsCheckInUseRequest: + """Session IDs to test for live in-use locks.""" - url: str | None = None - """URL of the remote MCP server endpoint.""" + session_ids: list[str] + """Session IDs to test for live in-use locks""" @staticmethod - def from_dict(obj: Any) -> 'MCPServerConfig': + def from_dict(obj: Any) -> 'SessionsCheckInUseRequest': assert isinstance(obj, dict) - args = from_union([lambda x: from_list(from_str, x), from_none], obj.get("args")) - auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) - command = from_union([from_str, from_none], obj.get("command")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) - filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) - is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) - oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) - timeout = from_union([from_int, from_none], obj.get("timeout")) - tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) - headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) - oauth_client_id = from_union([from_str, from_none], obj.get("oauthClientId")) - oauth_grant_type = from_union([MCPServerConfigHTTPOauthGrantType, from_none], obj.get("oauthGrantType")) - oauth_public_client = from_union([from_bool, from_none], obj.get("oauthPublicClient")) - type = from_union([MCPServerConfigHTTPType, from_none], obj.get("type")) - url = from_union([from_str, from_none], obj.get("url")) - return MCPServerConfig(args, auth, command, cwd, env, filter_mapping, is_default_server, oidc, timeout, tools, headers, oauth_client_id, oauth_grant_type, oauth_public_client, type, url) + session_ids = from_list(from_str, obj.get("sessionIds")) + return SessionsCheckInUseRequest(session_ids) def to_dict(self) -> dict: result: dict = {} - if self.args is not None: - result["args"] = from_union([lambda x: from_list(from_str, x), from_none], self.args) - if self.auth is not None: - result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) - if self.command is not None: - result["command"] = from_union([from_str, from_none], self.command) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.env is not None: - result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) - if self.filter_mapping is not None: - result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) - if self.is_default_server is not None: - result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) - if self.oidc is not None: - result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) - if self.timeout is not None: - result["timeout"] = from_union([from_int, from_none], self.timeout) - if self.tools is not None: - result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) - if self.headers is not None: - result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) - if self.oauth_client_id is not None: - result["oauthClientId"] = from_union([from_str, from_none], self.oauth_client_id) - if self.oauth_grant_type is not None: - result["oauthGrantType"] = from_union([lambda x: to_enum(MCPServerConfigHTTPOauthGrantType, x), from_none], self.oauth_grant_type) - if self.oauth_public_client is not None: - result["oauthPublicClient"] = from_union([from_bool, from_none], self.oauth_public_client) - if self.type is not None: - result["type"] = from_union([lambda x: to_enum(MCPServerConfigHTTPType, x), from_none], self.type) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + result["sessionIds"] = from_list(from_str, self.session_ids) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServerConfigHTTP: - """Remote MCP server configuration accessed over HTTP or SSE.""" +class SessionsCheckInUseResult: + """Session IDs from the input set that are currently in use by another process.""" - url: str - """URL of the remote MCP server endpoint.""" - - auth: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - - filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None - """Content filtering mode to apply to all tools, or a map of tool name to content filtering - mode. - """ - headers: dict[str, str] | None = None - """HTTP headers to include in requests to the remote MCP server.""" - - is_default_server: bool | None = None - """Whether this server is a built-in fallback used when the user has not configured their - own server. + in_use: list[str] + """Session IDs from the input set that are currently held by another running process via an + alive lock file """ - oauth_client_id: str | None = None - """OAuth client ID for a pre-registered remote MCP OAuth client.""" - - oauth_grant_type: MCPServerConfigHTTPOauthGrantType | None = None - """OAuth grant type to use when authenticating to the remote MCP server.""" - - oauth_public_client: bool | None = None - """Whether the configured OAuth client is public and does not require a client secret.""" - oidc: bool | MCPServerAuthConfigRedirectPort | None = None - """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionsCheckInUseResult': + assert isinstance(obj, dict) + in_use = from_list(from_str, obj.get("inUse")) + return SessionsCheckInUseResult(in_use) - timeout: int | None = None - """Timeout in milliseconds for tool calls to this server.""" + def to_dict(self) -> dict: + result: dict = {} + result["inUse"] = from_list(from_str, self.in_use) + return result - tools: list[str] | None = None - """Tools to include. Defaults to all tools if not specified.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsCloseRequest: + """Session ID to close.""" - type: MCPServerConfigHTTPType | None = None - """Remote transport type. Defaults to "http" when omitted.""" + session_id: str + """Session ID to close""" @staticmethod - def from_dict(obj: Any) -> 'MCPServerConfigHTTP': + def from_dict(obj: Any) -> 'SessionsCloseRequest': assert isinstance(obj, dict) - url = from_str(obj.get("url")) - auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) - filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) - headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) - is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) - oauth_client_id = from_union([from_str, from_none], obj.get("oauthClientId")) - oauth_grant_type = from_union([MCPServerConfigHTTPOauthGrantType, from_none], obj.get("oauthGrantType")) - oauth_public_client = from_union([from_bool, from_none], obj.get("oauthPublicClient")) - oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) - timeout = from_union([from_int, from_none], obj.get("timeout")) - tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) - type = from_union([MCPServerConfigHTTPType, from_none], obj.get("type")) - return MCPServerConfigHTTP(url, auth, filter_mapping, headers, is_default_server, oauth_client_id, oauth_grant_type, oauth_public_client, oidc, timeout, tools, type) + session_id = from_str(obj.get("sessionId")) + return SessionsCloseRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["url"] = from_str(self.url) - if self.auth is not None: - result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) - if self.filter_mapping is not None: - result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) - if self.headers is not None: - result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) - if self.is_default_server is not None: - result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) - if self.oauth_client_id is not None: - result["oauthClientId"] = from_union([from_str, from_none], self.oauth_client_id) - if self.oauth_grant_type is not None: - result["oauthGrantType"] = from_union([lambda x: to_enum(MCPServerConfigHTTPOauthGrantType, x), from_none], self.oauth_grant_type) - if self.oauth_public_client is not None: - result["oauthPublicClient"] = from_union([from_bool, from_none], self.oauth_public_client) - if self.oidc is not None: - result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) - if self.timeout is not None: - result["timeout"] = from_union([from_int, from_none], self.timeout) - if self.tools is not None: - result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) - if self.type is not None: - result["type"] = from_union([lambda x: to_enum(MCPServerConfigHTTPType, x), from_none], self.type) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPSamplingExecutionResult: - """Outcome of an MCP sampling execution: success result, failure error, or cancellation.""" - - action: MCPSamplingExecutionAction - """Outcome of the sampling inference. 'success' produced a response; 'failure' encountered - an error (including agent-side rejection by content filter or criteria); 'cancelled' the - caller cancelled this execution via cancelSamplingExecution. - """ - error: str | None = None - """Error description, present when action='failure'.""" - - result: dict[str, Any] | None = None - """MCP CreateMessageResult payload (with optional 'tools' extension), present when - action='success'. Treated as opaque at the schema layer; consumers should - construct/consume it per the MCP CreateMessageResult shape. +class SessionsCloseResult: + """Closes a session: emits shutdown, flushes pending events to disk, releases the in-use + lock, disposes the active session. Idempotent: succeeds even if the session is not + currently active. """ - @staticmethod - def from_dict(obj: Any) -> 'MCPSamplingExecutionResult': + def from_dict(obj: Any) -> 'SessionsCloseResult': assert isinstance(obj, dict) - action = MCPSamplingExecutionAction(obj.get("action")) - error = from_union([from_str, from_none], obj.get("error")) - result = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("result")) - return MCPSamplingExecutionResult(action, error, result) + return SessionsCloseResult() def to_dict(self) -> dict: result: dict = {} - result["action"] = to_enum(MCPSamplingExecutionAction, self.action) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) - if self.result is not None: - result["result"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.result) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPServerList: - """MCP servers configured for the session, with their connection status.""" +class SessionsDeleteRequest: + """Session ID to delete from disk.""" - servers: list[MCPServer] - """Configured MCP servers""" + session_id: str + """Session ID to delete""" + + session_path: str | None = None + """Internal resolved session directory path to delete""" @staticmethod - def from_dict(obj: Any) -> 'MCPServerList': + def from_dict(obj: Any) -> 'SessionsDeleteRequest': assert isinstance(obj, dict) - servers = from_list(MCPServer.from_dict, obj.get("servers")) - return MCPServerList(servers) + session_id = from_str(obj.get("sessionId")) + session_path = from_union([from_none, from_str], obj.get("sessionPath")) + return SessionsDeleteRequest(session_id, session_path) def to_dict(self) -> dict: result: dict = {} - result["servers"] = from_list(lambda x: to_class(MCPServer, x), self.servers) + result["sessionId"] = from_str(self.session_id) + if self.session_path is not None: + result["sessionPath"] = from_union([from_none, from_str], self.session_path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPSetEnvValueModeParams: - """Mode controlling how MCP server env values are resolved (`direct` or `indirect`).""" +class SessionsFindByPrefixRequest: + """UUID prefix to resolve to a unique session ID.""" - mode: MCPSetEnvValueModeDetails - """How environment-variable values supplied to MCP servers are resolved. "direct" passes - literal string values; "indirect" treats values as references (e.g. names of environment - variables on the host) that the runtime resolves before launch. Defaults to the runtime's - startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI - prompt mode and ACP) set this to "direct". + prefix: str + """UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when + there is no match or the prefix matches multiple sessions. """ @staticmethod - def from_dict(obj: Any) -> 'MCPSetEnvValueModeParams': + def from_dict(obj: Any) -> 'SessionsFindByPrefixRequest': assert isinstance(obj, dict) - mode = MCPSetEnvValueModeDetails(obj.get("mode")) - return MCPSetEnvValueModeParams(mode) + prefix = from_str(obj.get("prefix")) + return SessionsFindByPrefixRequest(prefix) def to_dict(self) -> dict: result: dict = {} - result["mode"] = to_enum(MCPSetEnvValueModeDetails, self.mode) + result["prefix"] = from_str(self.prefix) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPSetEnvValueModeResult: - """Env-value mode recorded on the session after the update.""" +class SessionsFindByPrefixResult: + """Session ID matching the prefix, omitted when no unique match exists.""" - mode: MCPSetEnvValueModeDetails - """Mode recorded on the session after the update""" + session_id: str | None = None + """Omitted when no unique session matches the prefix (no match or ambiguous)""" @staticmethod - def from_dict(obj: Any) -> 'MCPSetEnvValueModeResult': + def from_dict(obj: Any) -> 'SessionsFindByPrefixResult': assert isinstance(obj, dict) - mode = MCPSetEnvValueModeDetails(obj.get("mode")) - return MCPSetEnvValueModeResult(mode) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + return SessionsFindByPrefixResult(session_id) def to_dict(self) -> dict: result: dict = {} - result["mode"] = to_enum(MCPSetEnvValueModeDetails, self.mode) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataContextInfoResult: - """Token breakdown for the session's current context window, or null if uninitialized.""" +class SessionsFindByTaskIDRequest: + """GitHub task ID to look up.""" - context_info: SessionContextInfo | None = None - """Token breakdown for the current context window, or null if the session has not yet been - initialized (no system prompt or tool metadata cached). - """ + task_id: str + """GitHub task ID to look up""" @staticmethod - def from_dict(obj: Any) -> 'MetadataContextInfoResult': + def from_dict(obj: Any) -> 'SessionsFindByTaskIDRequest': assert isinstance(obj, dict) - context_info = from_union([SessionContextInfo.from_dict, from_none], obj.get("contextInfo")) - return MetadataContextInfoResult(context_info) + task_id = from_str(obj.get("taskId")) + return SessionsFindByTaskIDRequest(task_id) def to_dict(self) -> dict: result: dict = {} - if self.context_info is not None: - result["contextInfo"] = from_union([lambda x: to_class(SessionContextInfo, x), from_none], self.context_info) + result["taskId"] = from_str(self.task_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionWorkingDirectoryContext: - """Updated working directory and git context. Emitted as the new payload of - `session.context_changed`. - """ - cwd: str - """Current working directory path""" +class SessionsFindByTaskIDResult: + """ID of the local session bound to the given GitHub task, or omitted when none.""" - base_commit: str | None = None - """Merge-base commit SHA (fork point from the remote default branch)""" + session_id: str | None = None + """Omitted when no local session is bound to that GitHub task""" - branch: str | None = None - """Current git branch name""" + @staticmethod + def from_dict(obj: Any) -> 'SessionsFindByTaskIDResult': + assert isinstance(obj, dict) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + return SessionsFindByTaskIDResult(session_id) - git_root: str | None = None - """Root directory of the git repository, resolved via git rev-parse""" + def to_dict(self) -> dict: + result: dict = {} + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) + return result - head_commit: str | None = None - """Head commit of the current git branch""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsForkRequest: + """Source session identifier to fork from, optional event-ID boundary, and optional friendly + name for the new session. + """ + session_id: str + """Source session ID to fork from""" - host_type: HostType | None = None - """Hosting platform type of the repository""" + name: str | None = None + """Optional friendly name to assign to the forked session.""" - repository: str | None = None - """Repository identifier derived from the git remote URL ("owner/name" for GitHub, - "org/project/repo" for Azure DevOps) + to_event_id: str | None = None + """Optional event ID boundary. When provided, the fork includes only events before this ID + (exclusive). When omitted, all events are included. """ - repository_host: str | None = None - """Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com")""" @staticmethod - def from_dict(obj: Any) -> 'SessionWorkingDirectoryContext': + def from_dict(obj: Any) -> 'SessionsForkRequest': assert isinstance(obj, dict) - cwd = from_str(obj.get("cwd")) - base_commit = from_union([from_str, from_none], obj.get("baseCommit")) - branch = from_union([from_str, from_none], obj.get("branch")) - git_root = from_union([from_str, from_none], obj.get("gitRoot")) - head_commit = from_union([from_str, from_none], obj.get("headCommit")) - host_type = from_union([HostType, from_none], obj.get("hostType")) - repository = from_union([from_str, from_none], obj.get("repository")) - repository_host = from_union([from_str, from_none], obj.get("repositoryHost")) - return SessionWorkingDirectoryContext(cwd, base_commit, branch, git_root, head_commit, host_type, repository, repository_host) + session_id = from_str(obj.get("sessionId")) + name = from_union([from_str, from_none], obj.get("name")) + to_event_id = from_union([from_str, from_none], obj.get("toEventId")) + return SessionsForkRequest(session_id, name, to_event_id) def to_dict(self) -> dict: result: dict = {} - result["cwd"] = from_str(self.cwd) - if self.base_commit is not None: - result["baseCommit"] = from_union([from_str, from_none], self.base_commit) - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.git_root is not None: - result["gitRoot"] = from_union([from_str, from_none], self.git_root) - if self.head_commit is not None: - result["headCommit"] = from_union([from_str, from_none], self.head_commit) - if self.host_type is not None: - result["hostType"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) - if self.repository is not None: - result["repository"] = from_union([from_str, from_none], self.repository) - if self.repository_host is not None: - result["repositoryHost"] = from_union([from_str, from_none], self.repository_host) + result["sessionId"] = from_str(self.session_id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.to_event_id is not None: + result["toEventId"] = from_union([from_str, from_none], self.to_event_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionContext: - """Schema for the `SessionContext` type. - - Optional working-directory context used to score session relevance. When omitted the - most-recently-modified session wins. - """ - cwd: str - """Most recent working directory for this session""" - - branch: str | None = None - """Active git branch""" - - git_root: str | None = None - """Git repository root, if the cwd was inside a git repo""" +class SessionsForkResult: + """Identifier and optional friendly name assigned to the newly forked session.""" - host_type: HostType | None = None - """Repository host type""" + session_id: str + """The new forked session's ID""" - repository: str | None = None - """Repository slug in `owner/name` form, when known""" + name: str | None = None + """Friendly name assigned to the forked session, if any.""" @staticmethod - def from_dict(obj: Any) -> 'SessionContext': + def from_dict(obj: Any) -> 'SessionsForkResult': assert isinstance(obj, dict) - cwd = from_str(obj.get("cwd")) - branch = from_union([from_str, from_none], obj.get("branch")) - git_root = from_union([from_str, from_none], obj.get("gitRoot")) - host_type = from_union([HostType, from_none], obj.get("hostType")) - repository = from_union([from_str, from_none], obj.get("repository")) - return SessionContext(cwd, branch, git_root, host_type, repository) + session_id = from_str(obj.get("sessionId")) + name = from_union([from_str, from_none], obj.get("name")) + return SessionsForkResult(session_id, name) def to_dict(self) -> dict: result: dict = {} - result["cwd"] = from_str(self.cwd) - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.git_root is not None: - result["gitRoot"] = from_union([from_str, from_none], self.git_root) - if self.host_type is not None: - result["hostType"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) - if self.repository is not None: - result["repository"] = from_union([from_str, from_none], self.repository) + result["sessionId"] = from_str(self.session_id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class Workspace: - id: str - branch: str | None = None - chronicle_sync_dismissed: bool | None = None - client_name: str | None = None - created_at: datetime | None = None - cwd: str | None = None - git_root: str | None = None - host_type: HostType | None = None - """Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.""" +class SessionsGetBoardEntryCountRequest: + """Session ID whose board entry count should be returned.""" - mc_last_event_id: str | None = None - mc_session_id: str | None = None - mc_task_id: str | None = None - name: str | None = None - remote_steerable: bool | None = None - repository: str | None = None - summary_count: int | None = None - updated_at: datetime | None = None - user_named: bool | None = None + session_id: str + """Session ID whose board entry count should be returned.""" @staticmethod - def from_dict(obj: Any) -> 'Workspace': + def from_dict(obj: Any) -> 'SessionsGetBoardEntryCountRequest': assert isinstance(obj, dict) - id = from_str(obj.get("id")) - branch = from_union([from_str, from_none], obj.get("branch")) - chronicle_sync_dismissed = from_union([from_bool, from_none], obj.get("chronicle_sync_dismissed")) - client_name = from_union([from_str, from_none], obj.get("client_name")) - created_at = from_union([from_datetime, from_none], obj.get("created_at")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - git_root = from_union([from_str, from_none], obj.get("git_root")) - host_type = from_union([HostType, from_none], obj.get("host_type")) - mc_last_event_id = from_union([from_str, from_none], obj.get("mc_last_event_id")) - mc_session_id = from_union([from_str, from_none], obj.get("mc_session_id")) - mc_task_id = from_union([from_str, from_none], obj.get("mc_task_id")) - name = from_union([from_str, from_none], obj.get("name")) - remote_steerable = from_union([from_bool, from_none], obj.get("remote_steerable")) - repository = from_union([from_str, from_none], obj.get("repository")) - summary_count = from_union([from_int, from_none], obj.get("summary_count")) - updated_at = from_union([from_datetime, from_none], obj.get("updated_at")) - user_named = from_union([from_bool, from_none], obj.get("user_named")) - return Workspace(id, branch, chronicle_sync_dismissed, client_name, created_at, cwd, git_root, host_type, mc_last_event_id, mc_session_id, mc_task_id, name, remote_steerable, repository, summary_count, updated_at, user_named) + session_id = from_str(obj.get("sessionId")) + return SessionsGetBoardEntryCountRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_str(self.id) - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.chronicle_sync_dismissed is not None: - result["chronicle_sync_dismissed"] = from_union([from_bool, from_none], self.chronicle_sync_dismissed) - if self.client_name is not None: - result["client_name"] = from_union([from_str, from_none], self.client_name) - if self.created_at is not None: - result["created_at"] = from_union([lambda x: x.isoformat(), from_none], self.created_at) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.git_root is not None: - result["git_root"] = from_union([from_str, from_none], self.git_root) - if self.host_type is not None: - result["host_type"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) - if self.mc_last_event_id is not None: - result["mc_last_event_id"] = from_union([from_str, from_none], self.mc_last_event_id) - if self.mc_session_id is not None: - result["mc_session_id"] = from_union([from_str, from_none], self.mc_session_id) - if self.mc_task_id is not None: - result["mc_task_id"] = from_union([from_str, from_none], self.mc_task_id) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.remote_steerable is not None: - result["remote_steerable"] = from_union([from_bool, from_none], self.remote_steerable) - if self.repository is not None: - result["repository"] = from_union([from_str, from_none], self.repository) - if self.summary_count is not None: - result["summary_count"] = from_union([from_int, from_none], self.summary_count) - if self.updated_at is not None: - result["updated_at"] = from_union([lambda x: x.isoformat(), from_none], self.updated_at) - if self.user_named is not None: - result["user_named"] = from_union([from_bool, from_none], self.user_named) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataSnapshotRemoteMetadata: - """Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are - immutable for the lifetime of the session. - """ - repository: MetadataSnapshotRemoteMetadataRepository - """The repository the remote session targets.""" - - pull_request_number: int | None = None - """The pull request number the remote session is associated with, if any.""" +class SessionsGetBoardEntryCountResult: + """Dynamic-context board entry count, when available.""" - resource_id: str | None = None - """The original resource identifier (task ID or PR node ID), preserved across event-replay - reconstructions. Falls back to `sessionId` when absent. - """ - task_type: MetadataSnapshotRemoteMetadataTaskType | None = None - """Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` - invocation. - """ + count: int | None = None + """Board entry count, when available.""" @staticmethod - def from_dict(obj: Any) -> 'MetadataSnapshotRemoteMetadata': + def from_dict(obj: Any) -> 'SessionsGetBoardEntryCountResult': assert isinstance(obj, dict) - repository = MetadataSnapshotRemoteMetadataRepository.from_dict(obj.get("repository")) - pull_request_number = from_union([from_int, from_none], obj.get("pullRequestNumber")) - resource_id = from_union([from_str, from_none], obj.get("resourceId")) - task_type = from_union([MetadataSnapshotRemoteMetadataTaskType, from_none], obj.get("taskType")) - return MetadataSnapshotRemoteMetadata(repository, pull_request_number, resource_id, task_type) + count = from_union([from_int, from_none], obj.get("count")) + return SessionsGetBoardEntryCountResult(count) def to_dict(self) -> dict: result: dict = {} - result["repository"] = to_class(MetadataSnapshotRemoteMetadataRepository, self.repository) - if self.pull_request_number is not None: - result["pullRequestNumber"] = from_union([from_int, from_none], self.pull_request_number) - if self.resource_id is not None: - result["resourceId"] = from_union([from_str, from_none], self.resource_id) - if self.task_type is not None: - result["taskType"] = from_union([lambda x: to_enum(MetadataSnapshotRemoteMetadataTaskType, x), from_none], self.task_type) + if self.count is not None: + result["count"] = from_union([from_int, from_none], self.count) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelBillingTokenPrices: - """Token-level pricing information for this model""" - - batch_size: int | None = None - """Number of tokens per standard billing batch""" +class SessionsGetEventFilePathRequest: + """Session ID whose event-log file path to compute.""" - cache_price: float | None = None - """AI Credits cost per billing batch of cached tokens""" + session_id: str + """Session ID whose event-log file path to compute""" - context_max: int | None = None - """Maximum context window tokens for the default tier""" + @staticmethod + def from_dict(obj: Any) -> 'SessionsGetEventFilePathRequest': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + return SessionsGetEventFilePathRequest(session_id) - input_price: float | None = None - """AI Credits cost per billing batch of input tokens""" + def to_dict(self) -> dict: + result: dict = {} + result["sessionId"] = from_str(self.session_id) + return result - long_context: ModelBillingTokenPricesLongContext | None = None - """Long context tier pricing (available for models with extended context windows)""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsGetEventFilePathResult: + """Absolute path to the session's events.jsonl file on disk.""" - output_price: float | None = None - """AI Credits cost per billing batch of output tokens""" + file_path: str + """Absolute path to the session's events.jsonl file""" @staticmethod - def from_dict(obj: Any) -> 'ModelBillingTokenPrices': + def from_dict(obj: Any) -> 'SessionsGetEventFilePathResult': assert isinstance(obj, dict) - batch_size = from_union([from_int, from_none], obj.get("batchSize")) - cache_price = from_union([from_float, from_none], obj.get("cachePrice")) - context_max = from_union([from_int, from_none], obj.get("contextMax")) - input_price = from_union([from_float, from_none], obj.get("inputPrice")) - long_context = from_union([ModelBillingTokenPricesLongContext.from_dict, from_none], obj.get("longContext")) - output_price = from_union([from_float, from_none], obj.get("outputPrice")) - return ModelBillingTokenPrices(batch_size, cache_price, context_max, input_price, long_context, output_price) + file_path = from_str(obj.get("filePath")) + return SessionsGetEventFilePathResult(file_path) def to_dict(self) -> dict: result: dict = {} - if self.batch_size is not None: - result["batchSize"] = from_union([from_int, from_none], self.batch_size) - if self.cache_price is not None: - result["cachePrice"] = from_union([to_float, from_none], self.cache_price) - if self.context_max is not None: - result["contextMax"] = from_union([from_int, from_none], self.context_max) - if self.input_price is not None: - result["inputPrice"] = from_union([to_float, from_none], self.input_price) - if self.long_context is not None: - result["longContext"] = from_union([lambda x: to_class(ModelBillingTokenPricesLongContext, x), from_none], self.long_context) - if self.output_price is not None: - result["outputPrice"] = from_union([to_float, from_none], self.output_price) + result["filePath"] = from_str(self.file_path) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesLimits: - """Token limits for prompts, outputs, and context window""" - - max_context_window_tokens: int | None = None - """Maximum total context window size in tokens""" - - max_output_tokens: int | None = None - """Maximum number of output/completion tokens""" - - max_prompt_tokens: int | None = None - """Maximum number of prompt/input tokens""" +class SessionsGetLastForContextResult: + """Most-relevant session ID for the supplied context, or omitted when no sessions exist.""" - vision: ModelCapabilitiesLimitsVision | None = None - """Vision-specific limits""" + session_id: str | None = None + """Most-relevant session ID for the supplied context, or omitted when no sessions exist""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesLimits': + def from_dict(obj: Any) -> 'SessionsGetLastForContextResult': assert isinstance(obj, dict) - max_context_window_tokens = from_union([from_int, from_none], obj.get("max_context_window_tokens")) - max_output_tokens = from_union([from_int, from_none], obj.get("max_output_tokens")) - max_prompt_tokens = from_union([from_int, from_none], obj.get("max_prompt_tokens")) - vision = from_union([ModelCapabilitiesLimitsVision.from_dict, from_none], obj.get("vision")) - return ModelCapabilitiesLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + return SessionsGetLastForContextResult(session_id) def to_dict(self) -> dict: result: dict = {} - if self.max_context_window_tokens is not None: - result["max_context_window_tokens"] = from_union([from_int, from_none], self.max_context_window_tokens) - if self.max_output_tokens is not None: - result["max_output_tokens"] = from_union([from_int, from_none], self.max_output_tokens) - if self.max_prompt_tokens is not None: - result["max_prompt_tokens"] = from_union([from_int, from_none], self.max_prompt_tokens) - if self.vision is not None: - result["vision"] = from_union([lambda x: to_class(ModelCapabilitiesLimitsVision, x), from_none], self.vision) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelPolicy: - """Policy state (if applicable)""" +class SessionsGetMetadataRequest: + """Session ID whose persisted metadata should be read.""" - state: ModelPolicyState - """Current policy state for this model""" - - terms: str | None = None - """Usage terms or conditions for this model""" + session_id: str + """Session ID to inspect""" @staticmethod - def from_dict(obj: Any) -> 'ModelPolicy': + def from_dict(obj: Any) -> 'SessionsGetMetadataRequest': assert isinstance(obj, dict) - state = ModelPolicyState(obj.get("state")) - terms = from_union([from_str, from_none], obj.get("terms")) - return ModelPolicy(state, terms) + session_id = from_str(obj.get("sessionId")) + return SessionsGetMetadataRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["state"] = to_enum(ModelPolicyState, self.state) - if self.terms is not None: - result["terms"] = from_union([from_str, from_none], self.terms) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesOverrideLimits: - """Token limits for prompts, outputs, and context window""" - - max_context_window_tokens: int | None = None - """Maximum total context window size in tokens""" - - max_output_tokens: int | None = None - """Maximum number of output/completion tokens""" - - max_prompt_tokens: int | None = None - """Maximum number of prompt/input tokens""" +class SessionsGetPersistedRemoteSteerableRequest: + """Session ID to look up the persisted remote-steerable flag for.""" - vision: ModelCapabilitiesOverrideLimitsVision | None = None - """Vision-specific limits""" + session_id: str + """Session ID to look up the persisted remote-steerable flag for""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimits': + def from_dict(obj: Any) -> 'SessionsGetPersistedRemoteSteerableRequest': assert isinstance(obj, dict) - max_context_window_tokens = from_union([from_int, from_none], obj.get("max_context_window_tokens")) - max_output_tokens = from_union([from_int, from_none], obj.get("max_output_tokens")) - max_prompt_tokens = from_union([from_int, from_none], obj.get("max_prompt_tokens")) - vision = from_union([ModelCapabilitiesOverrideLimitsVision.from_dict, from_none], obj.get("vision")) - return ModelCapabilitiesOverrideLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision) + session_id = from_str(obj.get("sessionId")) + return SessionsGetPersistedRemoteSteerableRequest(session_id) def to_dict(self) -> dict: result: dict = {} - if self.max_context_window_tokens is not None: - result["max_context_window_tokens"] = from_union([from_int, from_none], self.max_context_window_tokens) - if self.max_output_tokens is not None: - result["max_output_tokens"] = from_union([from_int, from_none], self.max_output_tokens) - if self.max_prompt_tokens is not None: - result["max_prompt_tokens"] = from_union([from_int, from_none], self.max_prompt_tokens) - if self.vision is not None: - result["vision"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimitsVision, x), from_none], self.vision) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PendingPermissionRequestList: - """List of pending permission requests reconstructed from event history.""" - - items: list[PendingPermissionRequest] - """Pending permission prompts reconstructed from the session's event history. Equivalent to - the set of `permission.requested` events that have not yet been followed by a matching - `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts - that were emitted before the client attached to the session. +class SessionsGetPersistedRemoteSteerableResult: + """The session's persisted remote-steerable flag, or omitted when no value has been + persisted. + """ + remote_steerable: bool | None = None + """The session's persisted remote-steerable flag if recorded; omitted when no value has been + persisted """ @staticmethod - def from_dict(obj: Any) -> 'PendingPermissionRequestList': + def from_dict(obj: Any) -> 'SessionsGetPersistedRemoteSteerableResult': assert isinstance(obj, dict) - items = from_list(PendingPermissionRequest.from_dict, obj.get("items")) - return PendingPermissionRequestList(items) + remote_steerable = from_union([from_bool, from_none], obj.get("remoteSteerable")) + return SessionsGetPersistedRemoteSteerableResult(remote_steerable) def to_dict(self) -> dict: result: dict = {} - result["items"] = from_list(lambda x: to_class(PendingPermissionRequest, x), self.items) + if self.remote_steerable is not None: + result["remoteSteerable"] = from_union([from_bool, from_none], self.remote_steerable) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocation: - """Schema for the `PermissionDecisionApproveForLocation` type.""" - - approval: PermissionDecisionApproveForLocationApproval - """Approval to persist for this location""" - - kind: ClassVar[str] = "approve-for-location" - """Approve and persist for this project location""" +class SessionsListNonEmptySessionIDSRequest: + """Limit for non-empty local session IDs.""" - location_key: str - """Location key (git root or cwd) to persist the approval to""" + limit: int | None = None + """Maximum number of session IDs to return.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocation': + def from_dict(obj: Any) -> 'SessionsListNonEmptySessionIDSRequest': assert isinstance(obj, dict) - approval = _load_PermissionDecisionApproveForLocationApproval(obj.get("approval")) - location_key = from_str(obj.get("locationKey")) - return PermissionDecisionApproveForLocation(approval, location_key) + limit = from_union([from_int, from_none], obj.get("limit")) + return SessionsListNonEmptySessionIDSRequest(limit) def to_dict(self) -> dict: result: dict = {} - result["approval"] = (self.approval).to_dict() - result["kind"] = self.kind - result["locationKey"] = from_str(self.location_key) + if self.limit is not None: + result["limit"] = from_union([from_int, from_none], self.limit) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalCommands: - """Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type.""" - - command_identifiers: list[str] - """Command identifiers covered by this approval.""" +class SessionsListNonEmptySessionIDSResult: + """Recent local session IDs that contain user-visible history.""" - kind: ClassVar[str] = "commands" - """Approval scoped to specific command identifiers.""" + session_ids: list[str] + """Session IDs ordered newest-first.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCommands': + def from_dict(obj: Any) -> 'SessionsListNonEmptySessionIDSResult': assert isinstance(obj, dict) - command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) - return PermissionDecisionApproveForLocationApprovalCommands(command_identifiers) + session_ids = from_list(from_str, obj.get("sessionIds")) + return SessionsListNonEmptySessionIDSResult(session_ids) def to_dict(self) -> dict: result: dict = {} - result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) - result["kind"] = self.kind + result["sessionIds"] = from_list(from_str, self.session_ids) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalCommands: - """Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type.""" - - command_identifiers: list[str] - """Command identifiers covered by this approval.""" +class SessionsLoadDeferredRepoHooksRequest: + """Active session ID whose deferred repo-level hooks should be loaded.""" - kind: ClassVar[str] = "commands" - """Approval scoped to specific command identifiers.""" + session_id: str + """Active session ID whose deferred repo-level hooks should be loaded""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCommands': + def from_dict(obj: Any) -> 'SessionsLoadDeferredRepoHooksRequest': assert isinstance(obj, dict) - command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) - return PermissionDecisionApproveForSessionApprovalCommands(command_identifiers) + session_id = from_str(obj.get("sessionId")) + return SessionsLoadDeferredRepoHooksRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) - result["kind"] = self.kind + result["sessionId"] = from_str(self.session_id) return result +class SessionsOpenAttachKind(Enum): + ATTACH = "attach" + +class SessionsOpenCloudKind(Enum): + CLOUD = "cloud" + +class SessionsOpenCreateKind(Enum): + CREATE = "create" + +class SessionsOpenHandoffKind(Enum): + HANDOFF = "handoff" + +class SessionsOpenRemoteKind(Enum): + REMOTE = "remote" + +class SessionsOpenResumeKind(Enum): + RESUME = "resume" + +class SessionsOpenResumeLastKind(Enum): + RESUME_LAST = "resumeLast" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsCommands: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsCommands` type.""" +class SessionsPruneOldRequest: + """Age threshold and optional flags controlling which old sessions are pruned (or simulated + when dryRun is true). + """ + older_than_days: int + """Delete sessions whose modifiedTime is at least this many days old""" - command_identifiers: list[str] - """Command identifiers covered by this approval.""" + dry_run: bool | None = None + """When true, only report what would be deleted without performing any deletion""" - kind: ClassVar[str] = "commands" - """Approval scoped to specific command identifiers.""" + exclude_session_ids: list[str] | None = None + """Session IDs that should never be considered for pruning""" + + include_named: bool | None = None + """When true, named sessions (set via /rename) are also eligible for pruning""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsCommands': + def from_dict(obj: Any) -> 'SessionsPruneOldRequest': assert isinstance(obj, dict) - command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) - return PermissionsLocationsAddToolApprovalDetailsCommands(command_identifiers) + older_than_days = from_int(obj.get("olderThanDays")) + dry_run = from_union([from_bool, from_none], obj.get("dryRun")) + exclude_session_ids = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludeSessionIds")) + include_named = from_union([from_bool, from_none], obj.get("includeNamed")) + return SessionsPruneOldRequest(older_than_days, dry_run, exclude_session_ids, include_named) def to_dict(self) -> dict: result: dict = {} - result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) - result["kind"] = self.kind + result["olderThanDays"] = from_int(self.older_than_days) + if self.dry_run is not None: + result["dryRun"] = from_union([from_bool, from_none], self.dry_run) + if self.exclude_session_ids is not None: + result["excludeSessionIds"] = from_union([lambda x: from_list(from_str, x), from_none], self.exclude_session_ids) + if self.include_named is not None: + result["includeNamed"] = from_union([from_bool, from_none], self.include_named) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalCustomTool: - """Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type.""" - - kind: ClassVar[str] = "custom-tool" - """Approval covering a custom tool.""" +class SessionsReleaseLockRequest: + """Session ID whose in-use lock should be released.""" - tool_name: str - """Custom tool name.""" + session_id: str + """Session ID whose in-use lock should be released""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCustomTool': + def from_dict(obj: Any) -> 'SessionsReleaseLockRequest': assert isinstance(obj, dict) - tool_name = from_str(obj.get("toolName")) - return PermissionDecisionApproveForLocationApprovalCustomTool(tool_name) + session_id = from_str(obj.get("sessionId")) + return SessionsReleaseLockRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["toolName"] = from_str(self.tool_name) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalCustomTool: - """Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type.""" - - kind: ClassVar[str] = "custom-tool" - """Approval covering a custom tool.""" - - tool_name: str - """Custom tool name.""" - +class SessionsReleaseLockResult: + """Release the in-use lock held by this process for the given session. No-op when this + process does not currently hold a lock for the session. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCustomTool': + def from_dict(obj: Any) -> 'SessionsReleaseLockResult': assert isinstance(obj, dict) - tool_name = from_str(obj.get("toolName")) - return PermissionDecisionApproveForSessionApprovalCustomTool(tool_name) + return SessionsReleaseLockResult() def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["toolName"] = from_str(self.tool_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsCustomTool: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsCustomTool` type.""" +class SessionsReloadPluginHooksRequest: + """Active session ID and an optional flag for deferring repo-level hooks until folder trust.""" - kind: ClassVar[str] = "custom-tool" - """Approval covering a custom tool.""" + session_id: str + """Active session ID to reload hooks for""" - tool_name: str - """Custom tool name.""" + defer_repo_hooks: bool | None = None + """When true, skip repo-level hooks. Use before folder trust is confirmed; + loadDeferredRepoHooks loads them post-trust. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsCustomTool': + def from_dict(obj: Any) -> 'SessionsReloadPluginHooksRequest': assert isinstance(obj, dict) - tool_name = from_str(obj.get("toolName")) - return PermissionsLocationsAddToolApprovalDetailsCustomTool(tool_name) + session_id = from_str(obj.get("sessionId")) + defer_repo_hooks = from_union([from_bool, from_none], obj.get("deferRepoHooks")) + return SessionsReloadPluginHooksRequest(session_id, defer_repo_hooks) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["toolName"] = from_str(self.tool_name) + result["sessionId"] = from_str(self.session_id) + if self.defer_repo_hooks is not None: + result["deferRepoHooks"] = from_union([from_bool, from_none], self.defer_repo_hooks) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalExtensionManagement: - """Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type.""" - - kind: ClassVar[str] = "extension-management" - """Approval covering extension lifecycle operations such as enable, disable, or reload.""" - - operation: str | None = None - """Optional operation identifier; when omitted, the approval covers all extension management - operations. +class SessionsReloadPluginHooksResult: + """Reload all hooks (user, plugin, optionally repo) and apply them to the active session. + Call after installing or removing plugins so their hooks take effect immediately. No-op + when no active session matches the given sessionId. """ - @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalExtensionManagement': + def from_dict(obj: Any) -> 'SessionsReloadPluginHooksResult': assert isinstance(obj, dict) - operation = from_union([from_str, from_none], obj.get("operation")) - return PermissionDecisionApproveForLocationApprovalExtensionManagement(operation) + return SessionsReloadPluginHooksResult() def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.operation is not None: - result["operation"] = from_union([from_str, from_none], self.operation) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalExtensionManagement: - """Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type.""" +class SessionsSaveRequest: + """Session ID whose pending events should be flushed to disk.""" - kind: ClassVar[str] = "extension-management" - """Approval covering extension lifecycle operations such as enable, disable, or reload.""" - - operation: str | None = None - """Optional operation identifier; when omitted, the approval covers all extension management - operations. - """ + session_id: str + """Session ID whose pending events should be flushed to disk""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalExtensionManagement': + def from_dict(obj: Any) -> 'SessionsSaveRequest': assert isinstance(obj, dict) - operation = from_union([from_str, from_none], obj.get("operation")) - return PermissionDecisionApproveForSessionApprovalExtensionManagement(operation) + session_id = from_str(obj.get("sessionId")) + return SessionsSaveRequest(session_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.operation is not None: - result["operation"] = from_union([from_str, from_none], self.operation) + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsExtensionManagement: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionManagement` type.""" - - kind: ClassVar[str] = "extension-management" - """Approval covering extension lifecycle operations such as enable, disable, or reload.""" - - operation: str | None = None - """Optional operation identifier; when omitted, the approval covers all extension management - operations. +class SessionsSaveResult: + """Flush a session's pending events to disk. No-op when no writer exists for the session + (e.g., already closed). """ - @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsExtensionManagement': + def from_dict(obj: Any) -> 'SessionsSaveResult': assert isinstance(obj, dict) - operation = from_union([from_str, from_none], obj.get("operation")) - return PermissionsLocationsAddToolApprovalDetailsExtensionManagement(operation) + return SessionsSaveResult() def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.operation is not None: - result["operation"] = from_union([from_str, from_none], self.operation) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalMCP: - """Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type.""" - - kind: ClassVar[str] = "mcp" - """Approval covering an MCP tool.""" - - server_name: str - """MCP server name.""" - - tool_name: str | None = None - """MCP tool name, or null to cover every tool on the server.""" - +class SessionsSetAdditionalPluginsResult: + """Replace the manager-wide additional plugins. New session creations and subsequent hook + reloads see the new set; already-running sessions keep their existing hook installation + until the next reload. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCP': + def from_dict(obj: Any) -> 'SessionsSetAdditionalPluginsResult': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - tool_name = from_union([from_none, from_str], obj.get("toolName")) - return PermissionDecisionApproveForLocationApprovalMCP(server_name, tool_name) + return SessionsSetAdditionalPluginsResult() def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) - result["toolName"] = from_union([from_none, from_str], self.tool_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalMCP: - """Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type.""" - - kind: ClassVar[str] = "mcp" - """Approval covering an MCP tool.""" - - server_name: str - """MCP server name.""" +class SessionsSetRemoteControlSteeringRequest: + """Patch for the singleton's steering state.""" - tool_name: str | None = None - """MCP tool name, or null to cover every tool on the server.""" + enabled: bool + """Target steering state. Today only `true` is actionable on the underlying exporter; + `false` is reserved for future use. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCP': + def from_dict(obj: Any) -> 'SessionsSetRemoteControlSteeringRequest': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - tool_name = from_union([from_none, from_str], obj.get("toolName")) - return PermissionDecisionApproveForSessionApprovalMCP(server_name, tool_name) + enabled = from_bool(obj.get("enabled")) + return SessionsSetRemoteControlSteeringRequest(enabled) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) - result["toolName"] = from_union([from_none, from_str], self.tool_name) + result["enabled"] = from_bool(self.enabled) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsMCP: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsMcp` type.""" - - kind: ClassVar[str] = "mcp" - """Approval covering an MCP tool.""" - - server_name: str - """MCP server name.""" - - tool_name: str | None = None - """MCP tool name, or null to cover every tool on the server.""" +class SessionsStopRemoteControlRequest: + expected_session_id: str | None = None + """When provided, the stop is rejected unless the singleton currently points at this session + id (compare-and-swap semantics). + """ + force: bool | None = None + """When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. + Use during shutdown or explicit `/remote off`. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMCP': + def from_dict(obj: Any) -> 'SessionsStopRemoteControlRequest': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - tool_name = from_union([from_none, from_str], obj.get("toolName")) - return PermissionsLocationsAddToolApprovalDetailsMCP(server_name, tool_name) + expected_session_id = from_union([from_str, from_none], obj.get("expectedSessionId")) + force = from_union([from_bool, from_none], obj.get("force")) + return SessionsStopRemoteControlRequest(expected_session_id, force) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) - result["toolName"] = from_union([from_none, from_str], self.tool_name) + if self.expected_session_id is not None: + result["expectedSessionId"] = from_union([from_str, from_none], self.expected_session_id) + if self.force is not None: + result["force"] = from_union([from_bool, from_none], self.force) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalMCPSampling: - """Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type.""" +class SessionsTransferRemoteControlRequest: + """Parameters for atomically rebinding the remote-control singleton.""" - kind: ClassVar[str] = "mcp-sampling" - """Approval covering MCP sampling requests for a server.""" + to_session_id: str + """Local session id to point remote control at.""" - server_name: str - """MCP server name.""" + expected_from_session_id: str | None = None + """When provided, the transfer is rejected unless the singleton currently points at this + session id (compare-and-swap semantics to avoid clobbering newer state). + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCPSampling': + def from_dict(obj: Any) -> 'SessionsTransferRemoteControlRequest': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return PermissionDecisionApproveForLocationApprovalMCPSampling(server_name) + to_session_id = from_str(obj.get("toSessionId")) + expected_from_session_id = from_union([from_str, from_none], obj.get("expectedFromSessionId")) + return SessionsTransferRemoteControlRequest(to_session_id, expected_from_session_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) + result["toSessionId"] = from_str(self.to_session_id) + if self.expected_from_session_id is not None: + result["expectedFromSessionId"] = from_union([from_str, from_none], self.expected_from_session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalMCPSampling: - """Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type.""" - - kind: ClassVar[str] = "mcp-sampling" - """Approval covering MCP sampling requests for a server.""" +class ShellCancelUserRequestedRequest: + """User-requested shell execution cancellation handle.""" - server_name: str - """MCP server name.""" + request_id: str + """Request ID previously passed to executeUserRequested""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCPSampling': + def from_dict(obj: Any) -> 'ShellCancelUserRequestedRequest': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return PermissionDecisionApproveForSessionApprovalMCPSampling(server_name) + request_id = from_str(obj.get("requestId")) + return ShellCancelUserRequestedRequest(request_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) + result["requestId"] = from_str(self.request_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsMCPSampling: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsMcpSampling` type.""" +class ShellExecRequest: + """Shell command to run, with optional working directory and timeout in milliseconds.""" - kind: ClassVar[str] = "mcp-sampling" - """Approval covering MCP sampling requests for a server.""" + command: str + """Shell command to execute""" - server_name: str - """MCP server name.""" + cwd: str | None = None + """Working directory (defaults to session working directory)""" + + timeout: int | None = None + """Timeout in milliseconds (default: 30000)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMCPSampling': + def from_dict(obj: Any) -> 'ShellExecRequest': assert isinstance(obj, dict) - server_name = from_str(obj.get("serverName")) - return PermissionsLocationsAddToolApprovalDetailsMCPSampling(server_name) + command = from_str(obj.get("command")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + timeout = from_union([from_int, from_none], obj.get("timeout")) + return ShellExecRequest(command, cwd, timeout) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["serverName"] = from_str(self.server_name) + result["command"] = from_str(self.command) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.timeout is not None: + result["timeout"] = from_union([from_int, from_none], self.timeout) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalMemory: - """Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type.""" - - kind: ClassVar[str] = "memory" - """Approval covering writes to long-term memory.""" +class ShellExecResult: + """Identifier of the spawned process, used to correlate streamed output and exit + notifications. + """ + process_id: str + """Unique identifier for tracking streamed output""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMemory': + def from_dict(obj: Any) -> 'ShellExecResult': assert isinstance(obj, dict) - return PermissionDecisionApproveForLocationApprovalMemory() + process_id = from_str(obj.get("processId")) + return ShellExecResult(process_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["processId"] = from_str(self.process_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalMemory: - """Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type.""" +class ShellExecuteUserRequestedRequest: + """User-requested shell command and cancellation handle.""" - kind: ClassVar[str] = "memory" - """Approval covering writes to long-term memory.""" + command: str + """Shell command to execute""" + + request_id: str + """Caller-provided cancellation handle for this execution""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMemory': + def from_dict(obj: Any) -> 'ShellExecuteUserRequestedRequest': assert isinstance(obj, dict) - return PermissionDecisionApproveForSessionApprovalMemory() + command = from_str(obj.get("command")) + request_id = from_str(obj.get("requestId")) + return ShellExecuteUserRequestedRequest(command, request_id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["command"] = from_str(self.command) + result["requestId"] = from_str(self.request_id) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionsLocationsAddToolApprovalDetailsMemory: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsMemory` type.""" - - kind: ClassVar[str] = "memory" - """Approval covering writes to long-term memory.""" - - @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMemory': - assert isinstance(obj, dict) - return PermissionsLocationsAddToolApprovalDetailsMemory() +class ShellKillSignal(Enum): + """Signal to send (default: SIGTERM)""" - def to_dict(self) -> dict: - result: dict = {} - result["kind"] = self.kind - return result + SIGINT = "SIGINT" + SIGKILL = "SIGKILL" + SIGTERM = "SIGTERM" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalRead: - """Schema for the `PermissionDecisionApproveForLocationApprovalRead` type.""" - - kind: ClassVar[str] = "read" - """Approval covering read-only filesystem operations.""" +class ShellKillResult: + """Indicates whether the signal was delivered; false if the process was unknown or already + exited. + """ + killed: bool + """Whether the signal was sent successfully""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalRead': + def from_dict(obj: Any) -> 'ShellKillResult': assert isinstance(obj, dict) - return PermissionDecisionApproveForLocationApprovalRead() + killed = from_bool(obj.get("killed")) + return ShellKillResult(killed) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["killed"] = from_bool(self.killed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalRead: - """Schema for the `PermissionDecisionApproveForSessionApprovalRead` type.""" +class ShutdownRequest: + """Parameters for shutting down the session""" - kind: ClassVar[str] = "read" - """Approval covering read-only filesystem operations.""" + reason: str | None = None + """Optional human-readable reason. Typically the message of the error that triggered + shutdown when type is 'error'. + """ + type: ShutdownType | None = None + """Why the session is being shut down. Defaults to "routine" when omitted.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalRead': + def from_dict(obj: Any) -> 'ShutdownRequest': assert isinstance(obj, dict) - return PermissionDecisionApproveForSessionApprovalRead() + reason = from_union([from_str, from_none], obj.get("reason")) + type = from_union([ShutdownType, from_none], obj.get("type")) + return ShutdownRequest(reason, type) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(ShutdownType, x), from_none], self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsRead: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsRead` type.""" - - kind: ClassVar[str] = "read" - """Approval covering read-only filesystem operations.""" +class Skill: + """Skill metadata available to a session, with name, description, source, enabled/invocable + state, path, plugin, and argument hint. + """ + description: str + """Description of what the skill does""" - @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsRead': - assert isinstance(obj, dict) - return PermissionsLocationsAddToolApprovalDetailsRead() + enabled: bool + """Whether the skill is currently enabled""" - def to_dict(self) -> dict: - result: dict = {} - result["kind"] = self.kind - return result + name: str + """Unique identifier for the skill""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionDecisionApproveForLocationApprovalWrite: - """Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type.""" + source: SkillSource + """Source location type (e.g., project, personal-copilot, plugin, builtin)""" - kind: ClassVar[str] = "write" - """Approval covering filesystem write operations.""" + user_invocable: bool + """Whether the skill can be invoked by the user as a slash command""" + + argument_hint: str | None = None + """Optional freeform hint describing the skill's expected arguments, from the + `argument-hint` frontmatter field + """ + command_name: str | None = None + """Canonical slash command name used to invoke the skill, without the leading '/'""" + + path: str | None = None + """Absolute path to the skill file""" + + plugin_name: str | None = None + """Name of the plugin that provides the skill, when source is 'plugin'""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalWrite': + def from_dict(obj: Any) -> 'Skill': assert isinstance(obj, dict) - return PermissionDecisionApproveForLocationApprovalWrite() + description = from_str(obj.get("description")) + enabled = from_bool(obj.get("enabled")) + name = from_str(obj.get("name")) + source = SkillSource(obj.get("source")) + user_invocable = from_bool(obj.get("userInvocable")) + argument_hint = from_union([from_str, from_none], obj.get("argumentHint")) + command_name = from_union([from_str, from_none], obj.get("commandName")) + path = from_union([from_str, from_none], obj.get("path")) + plugin_name = from_union([from_str, from_none], obj.get("pluginName")) + return Skill(description, enabled, name, source, user_invocable, argument_hint, command_name, path, plugin_name) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["description"] = from_str(self.description) + result["enabled"] = from_bool(self.enabled) + result["name"] = from_str(self.name) + result["source"] = to_enum(SkillSource, self.source) + result["userInvocable"] = from_bool(self.user_invocable) + if self.argument_hint is not None: + result["argumentHint"] = from_union([from_str, from_none], self.argument_hint) + if self.command_name is not None: + result["commandName"] = from_union([from_str, from_none], self.command_name) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.plugin_name is not None: + result["pluginName"] = from_union([from_str, from_none], self.plugin_name) return result +# Experimental: this type is part of an experimental API and may change or be removed. +class SkillDiscoveryScope(Enum): + """Which tier this directory belongs to""" + + CUSTOM = "custom" + PERSONAL_AGENTS = "personal-agents" + PERSONAL_COPILOT = "personal-copilot" + PROJECT = "project" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalWrite: - """Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type.""" +class SkillsDisableRequest: + """Name of the skill to disable for the session.""" - kind: ClassVar[str] = "write" - """Approval covering filesystem write operations.""" + name: str + """Name of the skill to disable""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalWrite': + def from_dict(obj: Any) -> 'SkillsDisableRequest': assert isinstance(obj, dict) - return PermissionDecisionApproveForSessionApprovalWrite() + name = from_str(obj.get("name")) + return SkillsDisableRequest(name) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsLocationsAddToolApprovalDetailsWrite: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsWrite` type.""" +class SkillsDiscoverRequest: + """Optional project paths and additional skill directories to include in discovery.""" - kind: ClassVar[str] = "write" - """Approval covering filesystem write operations.""" + exclude_host_skills: bool | None = None + """When true, omit skills from the host's global sources (personal, custom, plugin, and + built-in), returning only project-scoped skills. For multitenant deployments. + """ + project_paths: list[str] | None = None + """Optional list of project directory paths to scan for project-scoped skills""" + + skill_directories: list[str] | None = None + """Optional list of additional skill directory paths to include""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsWrite': + def from_dict(obj: Any) -> 'SkillsDiscoverRequest': assert isinstance(obj, dict) - return PermissionsLocationsAddToolApprovalDetailsWrite() + exclude_host_skills = from_union([from_bool, from_none], obj.get("excludeHostSkills")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skillDirectories")) + return SkillsDiscoverRequest(exclude_host_skills, project_paths, skill_directories) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + if self.exclude_host_skills is not None: + result["excludeHostSkills"] = from_union([from_bool, from_none], self.exclude_host_skills) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) + if self.skill_directories is not None: + result["skillDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSession: - """Schema for the `PermissionDecisionApproveForSession` type.""" - - kind: ClassVar[str] = "approve-for-session" - """Approve and remember for the rest of the session""" - - approval: PermissionDecisionApproveForSessionApproval | None = None - """Session-scoped approval to remember (tool prompts only; omitted for path/url prompts)""" +class SkillsEnableRequest: + """Name of the skill to enable for the session.""" - domain: str | None = None - """URL domain to approve for the rest of the session (URL prompts only)""" + name: str + """Name of the skill to enable""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSession': + def from_dict(obj: Any) -> 'SkillsEnableRequest': assert isinstance(obj, dict) - approval = from_union([_load_PermissionDecisionApproveForSessionApproval, from_none], obj.get("approval")) - domain = from_union([from_str, from_none], obj.get("domain")) - return PermissionDecisionApproveForSession(approval, domain) + name = from_str(obj.get("name")) + return SkillsEnableRequest(name) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.approval is not None: - result["approval"] = from_union([lambda x: (x).to_dict(), from_none], self.approval) - if self.domain is not None: - result["domain"] = from_union([from_str, from_none], self.domain) + result["name"] = from_str(self.name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveOnce: - """Schema for the `PermissionDecisionApproveOnce` type.""" +class SkillsGetDiscoveryPathsRequest: + """Optional project paths to enumerate.""" - kind: ClassVar[str] = "approve-once" - """Approve this single request only""" + exclude_host_skills: bool | None = None + """When true, omit the host's personal and custom skill directories, leaving only project + directories. For multitenant deployments. + """ + project_paths: list[str] | None = None + """Optional list of project directory paths. When omitted or empty, only personal and custom + directories are returned. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveOnce': + def from_dict(obj: Any) -> 'SkillsGetDiscoveryPathsRequest': assert isinstance(obj, dict) - return PermissionDecisionApproveOnce() + exclude_host_skills = from_union([from_bool, from_none], obj.get("excludeHostSkills")) + project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get("projectPaths")) + return SkillsGetDiscoveryPathsRequest(exclude_host_skills, project_paths) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + if self.exclude_host_skills is not None: + result["excludeHostSkills"] = from_union([from_bool, from_none], self.exclude_host_skills) + if self.project_paths is not None: + result["projectPaths"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApprovePermanently: - """Schema for the `PermissionDecisionApprovePermanently` type.""" +class SkillsLoadDiagnostics: + """Diagnostics from reloading skill definitions, with warnings and errors as separate lists.""" - domain: str - """URL domain to approve permanently""" + errors: list[str] + """Errors emitted while loading skills (e.g. skills that failed to load entirely)""" - kind: ClassVar[str] = "approve-permanently" - """Approve and persist across sessions (URL prompts only)""" + warnings: list[str] + """Warnings emitted while loading skills (e.g. skills that loaded but had issues)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApprovePermanently': + def from_dict(obj: Any) -> 'SkillsLoadDiagnostics': assert isinstance(obj, dict) - domain = from_str(obj.get("domain")) - return PermissionDecisionApprovePermanently(domain) + errors = from_list(from_str, obj.get("errors")) + warnings = from_list(from_str, obj.get("warnings")) + return SkillsLoadDiagnostics(errors, warnings) def to_dict(self) -> dict: result: dict = {} - result["domain"] = from_str(self.domain) - result["kind"] = self.kind + result["errors"] = from_list(from_str, self.errors) + result["warnings"] = from_list(from_str, self.warnings) return result +class SlashCommandAgentPromptResultKind(Enum): + AGENT_PROMPT = "agent-prompt" + +class SlashCommandCompletedResultKind(Enum): + COMPLETED = "completed" + +class SlashCommandInvocationResultKind(Enum): + AGENT_PROMPT = "agent-prompt" + COMPLETED = "completed" + SELECT_SUBCOMMAND = "select-subcommand" + TEXT = "text" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproved: - """Schema for the `PermissionDecisionApproved` type.""" +class SlashCommandSelectSubcommandOption: + """Selectable slash-command subcommand option with name, description, and optional group + label. + """ + description: str + """Human-readable description of the subcommand""" - kind: ClassVar[str] = "approved" - """The permission request was approved""" + name: str + """Subcommand name to invoke""" + + group: str | None = None + """Optional group label for organizing options""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproved': + def from_dict(obj: Any) -> 'SlashCommandSelectSubcommandOption': assert isinstance(obj, dict) - return PermissionDecisionApproved() + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + group = from_union([from_str, from_none], obj.get("group")) + return SlashCommandSelectSubcommandOption(description, name, group) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["description"] = from_str(self.description) + result["name"] = from_str(self.name) + if self.group is not None: + result["group"] = from_union([from_str, from_none], self.group) return result +class SlashCommandSelectSubcommandResultKind(Enum): + SELECT_SUBCOMMAND = "select-subcommand" + # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionDecisionApprovedForLocation: - """Schema for the `PermissionDecisionApprovedForLocation` type.""" +class SubagentSettingsEntryContextTier(Enum): + """Context tier override for matching subagents""" - approval: UserToolSessionApproval - """The approval to persist for this location""" + DEFAULT = "default" + INHERIT = "inherit" + LONG_CONTEXT = "long_context" - kind: ClassVar[str] = "approved-for-location" - """Approved and persisted for this project location""" +# Experimental: this type is part of an experimental API and may change or be removed. +class TaskExecutionMode(Enum): + """Whether task execution is synchronously awaited or managed in the background""" - location_key: str - """The location key (git root or cwd) to persist the approval to""" + BACKGROUND = "background" + SYNC = "sync" - @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApprovedForLocation': - assert isinstance(obj, dict) - approval = UserToolSessionApproval.from_dict(obj.get("approval")) - location_key = from_str(obj.get("locationKey")) - return PermissionDecisionApprovedForLocation(approval, location_key) +# Experimental: this type is part of an experimental API and may change or be removed. +class TaskStatus(Enum): + """Current lifecycle status of the task""" - def to_dict(self) -> dict: - result: dict = {} - result["approval"] = to_class(UserToolSessionApproval, self.approval) - result["kind"] = self.kind - result["locationKey"] = from_str(self.location_key) - return result + CANCELLED = "cancelled" + COMPLETED = "completed" + FAILED = "failed" + IDLE = "idle" + RUNNING = "running" + +class TaskAgentInfoType(Enum): + AGENT = "agent" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApprovedForSession: - """Schema for the `PermissionDecisionApprovedForSession` type.""" +class TaskProgressLine: + """Timestamped display line for task progress output or recent agent activity.""" - approval: UserToolSessionApproval - """The approval to add as a session-scoped rule""" + message: str + """Display message, e.g., "▸ bash", "✓ edit src/foo.ts\"""" - kind: ClassVar[str] = "approved-for-session" - """Approved and remembered for the rest of the session""" + timestamp: datetime + """ISO 8601 timestamp when this event occurred""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApprovedForSession': + def from_dict(obj: Any) -> 'TaskProgressLine': assert isinstance(obj, dict) - approval = UserToolSessionApproval.from_dict(obj.get("approval")) - return PermissionDecisionApprovedForSession(approval) + message = from_str(obj.get("message")) + timestamp = from_datetime(obj.get("timestamp")) + return TaskProgressLine(message, timestamp) def to_dict(self) -> dict: result: dict = {} - result["approval"] = to_class(UserToolSessionApproval, self.approval) - result["kind"] = self.kind + result["message"] = from_str(self.message) + result["timestamp"] = self.timestamp.isoformat() return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionDecisionCancelled: - """Schema for the `PermissionDecisionCancelled` type.""" - - kind: ClassVar[str] = "cancelled" - """The permission request was cancelled before a response was used""" +class TaskShellInfoAttachmentMode(Enum): + """Whether the shell runs inside a managed PTY session or as an independent background + process + """ + ATTACHED = "attached" + DETACHED = "detached" - reason: str | None = None - """Optional explanation of why the request was cancelled""" +class TaskInfoType(Enum): + AGENT = "agent" + SHELL = "shell" + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskList: + """Background tasks currently tracked by the session.""" + + tasks: list[TaskInfo] + """Currently tracked tasks""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionCancelled': + def from_dict(obj: Any) -> 'TaskList': assert isinstance(obj, dict) - reason = from_union([from_str, from_none], obj.get("reason")) - return PermissionDecisionCancelled(reason) + tasks = from_list(_load_TaskInfo, obj.get("tasks")) + return TaskList(tasks) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.reason is not None: - result["reason"] = from_union([from_str, from_none], self.reason) + result["tasks"] = from_list(lambda x: (x).to_dict(), self.tasks) return result +class TaskShellInfoType(Enum): + SHELL = "shell" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionDeniedByContentExclusionPolicy: - """Schema for the `PermissionDecisionDeniedByContentExclusionPolicy` type.""" - - kind: ClassVar[str] = "denied-by-content-exclusion-policy" - """Denied by the organization's content exclusion policy""" - - message: str - """Human-readable explanation of why the path was excluded""" +class TasksCancelRequest: + """Identifier of the background task to cancel.""" - path: str - """File path that triggered the exclusion""" + id: str + """Task identifier""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionDeniedByContentExclusionPolicy': + def from_dict(obj: Any) -> 'TasksCancelRequest': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - path = from_str(obj.get("path")) - return PermissionDecisionDeniedByContentExclusionPolicy(message, path) + id = from_str(obj.get("id")) + return TasksCancelRequest(id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["message"] = from_str(self.message) - result["path"] = from_str(self.path) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionDeniedByPermissionRequestHook: - """Schema for the `PermissionDecisionDeniedByPermissionRequestHook` type.""" - - kind: ClassVar[str] = "denied-by-permission-request-hook" - """Denied by a permission request hook registered by an extension or plugin""" - - interrupt: bool | None = None - """Whether to interrupt the current agent turn""" +class TasksCancelResult: + """Indicates whether the background task was successfully cancelled.""" - message: str | None = None - """Optional message from the hook explaining the denial""" + cancelled: bool + """Whether the task was successfully cancelled""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionDeniedByPermissionRequestHook': + def from_dict(obj: Any) -> 'TasksCancelResult': assert isinstance(obj, dict) - interrupt = from_union([from_bool, from_none], obj.get("interrupt")) - message = from_union([from_str, from_none], obj.get("message")) - return PermissionDecisionDeniedByPermissionRequestHook(interrupt, message) + cancelled = from_bool(obj.get("cancelled")) + return TasksCancelResult(cancelled) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.interrupt is not None: - result["interrupt"] = from_union([from_bool, from_none], self.interrupt) - if self.message is not None: - result["message"] = from_union([from_str, from_none], self.message) + result["cancelled"] = from_bool(self.cancelled) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionDeniedByRules: - """Schema for the `PermissionDecisionDeniedByRules` type.""" - - kind: ClassVar[str] = "denied-by-rules" - """Denied because approval rules explicitly blocked it""" +class TasksGetCurrentPromotableResult: + """The first sync-waiting task that can currently be promoted to background mode.""" - rules: list[PermissionRule] - """Rules that denied the request""" + task: TaskInfo | None = None + """The first sync-waiting task (agent first, then shell) that can currently be promoted to + background mode. Omitted if no such task exists. The returned task is guaranteed to have + executionMode='sync' and canPromoteToBackground=true at the time of the call. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionDeniedByRules': + def from_dict(obj: Any) -> 'TasksGetCurrentPromotableResult': assert isinstance(obj, dict) - rules = from_list(PermissionRule.from_dict, obj.get("rules")) - return PermissionDecisionDeniedByRules(rules) + task = from_union([_load_TaskInfo, from_none], obj.get("task")) + return TasksGetCurrentPromotableResult(task) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - result["rules"] = from_list(lambda x: to_class(PermissionRule, x), self.rules) + if self.task is not None: + result["task"] = from_union([lambda x: (x).to_dict(), from_none], self.task) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionDeniedInteractivelyByUser: - """Schema for the `PermissionDecisionDeniedInteractivelyByUser` type.""" - - kind: ClassVar[str] = "denied-interactively-by-user" - """Denied by the user during an interactive prompt""" - - feedback: str | None = None - """Optional feedback from the user explaining the denial""" +class TasksGetProgressRequest: + """Identifier of the background task to fetch progress for.""" - force_reject: bool | None = None - """Whether to force-reject the current agent turn""" + id: str + """Task identifier (agent ID or shell ID)""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionDeniedInteractivelyByUser': + def from_dict(obj: Any) -> 'TasksGetProgressRequest': assert isinstance(obj, dict) - feedback = from_union([from_str, from_none], obj.get("feedback")) - force_reject = from_union([from_bool, from_none], obj.get("forceReject")) - return PermissionDecisionDeniedInteractivelyByUser(feedback, force_reject) + id = from_str(obj.get("id")) + return TasksGetProgressRequest(id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.feedback is not None: - result["feedback"] = from_union([from_str, from_none], self.feedback) - if self.force_reject is not None: - result["forceReject"] = from_union([from_bool, from_none], self.force_reject) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser: - """Schema for the `PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type.""" - - kind: ClassVar[str] = "denied-no-approval-rule-and-could-not-request-from-user" - """Denied because no approval rule matched and user confirmation was unavailable""" +class TasksPromoteCurrentToBackgroundResult: + """The promoted task as it now exists in background mode, omitted if no promotable task was + waiting. + """ + task: TaskInfo | None = None + """The promoted task as it now exists in background mode, omitted if no promotable task was + waiting. Atomic operation: avoids the race window of getCurrentPromotable + + promoteToBackground. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser': + def from_dict(obj: Any) -> 'TasksPromoteCurrentToBackgroundResult': assert isinstance(obj, dict) - return PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser() + task = from_union([_load_TaskInfo, from_none], obj.get("task")) + return TasksPromoteCurrentToBackgroundResult(task) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + if self.task is not None: + result["task"] = from_union([lambda x: (x).to_dict(), from_none], self.task) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionReject: - """Schema for the `PermissionDecisionReject` type.""" - - kind: ClassVar[str] = "reject" - """Reject the request""" +class TasksPromoteToBackgroundRequest: + """Identifier of the task to promote to background mode.""" - feedback: str | None = None - """Optional feedback explaining the rejection""" + id: str + """Task identifier""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionReject': + def from_dict(obj: Any) -> 'TasksPromoteToBackgroundRequest': assert isinstance(obj, dict) - feedback = from_union([from_str, from_none], obj.get("feedback")) - return PermissionDecisionReject(feedback) + id = from_str(obj.get("id")) + return TasksPromoteToBackgroundRequest(id) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.feedback is not None: - result["feedback"] = from_union([from_str, from_none], self.feedback) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionUserNotAvailable: - """Schema for the `PermissionDecisionUserNotAvailable` type.""" +class TasksPromoteToBackgroundResult: + """Indicates whether the task was successfully promoted to background mode.""" - kind: ClassVar[str] = "user-not-available" - """No user is available to confirm the request""" + promoted: bool + """Whether the task was successfully promoted to background mode""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionUserNotAvailable': + def from_dict(obj: Any) -> 'TasksPromoteToBackgroundResult': assert isinstance(obj, dict) - return PermissionDecisionUserNotAvailable() + promoted = from_bool(obj.get("promoted")) + return TasksPromoteToBackgroundResult(promoted) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind + result["promoted"] = from_bool(self.promoted) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionLocationApplyResult: - """Summary of persisted location permissions applied to the session.""" - - applied_directory_count: int - """Number of persisted allowed directories added to the live path manager""" - - applied_rule_count: int - """Number of location-scoped rules added to the live permission service""" - - applied_rules: list[PermissionRule] - """Location-scoped rules applied to the live permission service""" - - changed: bool - """Whether a different location was applied since the previous apply call""" - - location_key: str - """Location key used in the location-permissions store""" - - location_type: PermissionLocationType - """Whether the location is a git repo or directory""" - +class TasksRefreshResult: + """Refresh metadata for any detached background shells the runtime knows about. Use after a + long pause to pick up exit/output state for shells running outside the agent loop. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionLocationApplyResult': + def from_dict(obj: Any) -> 'TasksRefreshResult': assert isinstance(obj, dict) - applied_directory_count = from_int(obj.get("appliedDirectoryCount")) - applied_rule_count = from_int(obj.get("appliedRuleCount")) - applied_rules = from_list(PermissionRule.from_dict, obj.get("appliedRules")) - changed = from_bool(obj.get("changed")) - location_key = from_str(obj.get("locationKey")) - location_type = PermissionLocationType(obj.get("locationType")) - return PermissionLocationApplyResult(applied_directory_count, applied_rule_count, applied_rules, changed, location_key, location_type) + return TasksRefreshResult() def to_dict(self) -> dict: result: dict = {} - result["appliedDirectoryCount"] = from_int(self.applied_directory_count) - result["appliedRuleCount"] = from_int(self.applied_rule_count) - result["appliedRules"] = from_list(lambda x: to_class(PermissionRule, x), self.applied_rules) - result["changed"] = from_bool(self.changed) - result["locationKey"] = from_str(self.location_key) - result["locationType"] = to_enum(PermissionLocationType, self.location_type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionLocationResolveResult: - """Resolved location-permissions key and type.""" - - location_key: str - """Location key used in the location-permissions store""" +class TasksRemoveRequest: + """Identifier of the completed or cancelled task to remove from tracking.""" - location_type: PermissionLocationType - """Whether the location is a git repo or directory""" + id: str + """Task identifier""" @staticmethod - def from_dict(obj: Any) -> 'PermissionLocationResolveResult': + def from_dict(obj: Any) -> 'TasksRemoveRequest': assert isinstance(obj, dict) - location_key = from_str(obj.get("locationKey")) - location_type = PermissionLocationType(obj.get("locationType")) - return PermissionLocationResolveResult(location_key, location_type) + id = from_str(obj.get("id")) + return TasksRemoveRequest(id) def to_dict(self) -> dict: result: dict = {} - result["locationKey"] = from_str(self.location_key) - result["locationType"] = to_enum(PermissionLocationType, self.location_type) + result["id"] = from_str(self.id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsConfigureAdditionalContentExclusionPolicyRule: - """Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type.""" - - paths: list[str] - source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource - """Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type.""" - - if_any_match: list[str] | None = None - if_none_match: list[str] | None = None +class TasksRemoveResult: + """Indicates whether the task was removed. False when the task does not exist or is still + running/idle. + """ + removed: bool + """Whether the task was removed. Returns false if the task does not exist or is still + running/idle (cancel it first). + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRule': + def from_dict(obj: Any) -> 'TasksRemoveResult': assert isinstance(obj, dict) - paths = from_list(from_str, obj.get("paths")) - source = PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("source")) - if_any_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifAnyMatch")) - if_none_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifNoneMatch")) - return PermissionsConfigureAdditionalContentExclusionPolicyRule(paths, source, if_any_match, if_none_match) + removed = from_bool(obj.get("removed")) + return TasksRemoveResult(removed) def to_dict(self) -> dict: result: dict = {} - result["paths"] = from_list(from_str, self.paths) - result["source"] = to_class(PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, self.source) - if self.if_any_match is not None: - result["ifAnyMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_any_match) - if self.if_none_match is not None: - result["ifNoneMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_none_match) + result["removed"] = from_bool(self.removed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsModifyRulesParams: - """Scope and add/remove instructions for modifying session- or location-scoped permission - rules. - """ - scope: PermissionsModifyRulesScope - """Whether the change applies to ephemeral session-scoped rules (cleared at session end) or - to location-scoped rules persisted via the location-permissions config file. - """ - add: list[PermissionRule] | None = None - """Rules to add to the scope. Applied before `remove`/`removeAll`.""" +class TasksSendMessageRequest: + """Identifier of the target agent task, message content, and optional sender agent ID.""" - remove: list[PermissionRule] | None = None - """Specific rules to remove from the scope. Ignored when `removeAll` is true.""" + id: str + """Agent task identifier""" - remove_all: bool | None = None - """When true, removes every rule currently in the scope (after any `add` is applied). Useful - for clearing the location scope wholesale. - """ + message: str + """Message content to send to the agent""" + + from_agent_id: str | None = None + """Agent ID of the sender, if sent on behalf of another agent""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsModifyRulesParams': + def from_dict(obj: Any) -> 'TasksSendMessageRequest': assert isinstance(obj, dict) - scope = PermissionsModifyRulesScope(obj.get("scope")) - add = from_union([lambda x: from_list(PermissionRule.from_dict, x), from_none], obj.get("add")) - remove = from_union([lambda x: from_list(PermissionRule.from_dict, x), from_none], obj.get("remove")) - remove_all = from_union([from_bool, from_none], obj.get("removeAll")) - return PermissionsModifyRulesParams(scope, add, remove, remove_all) + id = from_str(obj.get("id")) + message = from_str(obj.get("message")) + from_agent_id = from_union([from_str, from_none], obj.get("fromAgentId")) + return TasksSendMessageRequest(id, message, from_agent_id) def to_dict(self) -> dict: result: dict = {} - result["scope"] = to_enum(PermissionsModifyRulesScope, self.scope) - if self.add is not None: - result["add"] = from_union([lambda x: from_list(lambda x: to_class(PermissionRule, x), x), from_none], self.add) - if self.remove is not None: - result["remove"] = from_union([lambda x: from_list(lambda x: to_class(PermissionRule, x), x), from_none], self.remove) - if self.remove_all is not None: - result["removeAll"] = from_union([from_bool, from_none], self.remove_all) + result["id"] = from_str(self.id) + result["message"] = from_str(self.message) + if self.from_agent_id is not None: + result["fromAgentId"] = from_union([from_str, from_none], self.from_agent_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PluginList: - """Plugins installed for the session, with their enabled state and version metadata.""" +class TasksSendMessageResult: + """Indicates whether the message was delivered, with an error message when delivery failed.""" - plugins: list[Plugin] - """Installed plugins""" + sent: bool + """Whether the message was successfully delivered or steered""" + + error: str | None = None + """Error message if delivery failed""" @staticmethod - def from_dict(obj: Any) -> 'PluginList': + def from_dict(obj: Any) -> 'TasksSendMessageResult': assert isinstance(obj, dict) - plugins = from_list(Plugin.from_dict, obj.get("plugins")) - return PluginList(plugins) + sent = from_bool(obj.get("sent")) + error = from_union([from_str, from_none], obj.get("error")) + return TasksSendMessageResult(sent, error) def to_dict(self) -> dict: result: dict = {} - result["plugins"] = from_list(lambda x: to_class(Plugin, x), self.plugins) + result["sent"] = from_bool(self.sent) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class QueuePendingItems: - """Schema for the `QueuePendingItems` type.""" +class TasksStartAgentRequest: + """Agent type, prompt, name, and optional description and model override for the new task.""" - display_text: str - """Human-readable text to display for this queue entry in the UI""" + agent_type: str + """Type of agent to start (e.g., 'explore', 'task', 'general-purpose')""" - kind: QueuePendingItemsKind - """Whether this item is a queued user message or a queued slash command / model change""" + name: str + """Short name for the agent, used to generate a human-readable ID""" + + prompt: str + """Task prompt for the agent""" + + description: str | None = None + """Short description of the task""" + + model: str | None = None + """Optional model override""" @staticmethod - def from_dict(obj: Any) -> 'QueuePendingItems': + def from_dict(obj: Any) -> 'TasksStartAgentRequest': assert isinstance(obj, dict) - display_text = from_str(obj.get("displayText")) - kind = QueuePendingItemsKind(obj.get("kind")) - return QueuePendingItems(display_text, kind) + agent_type = from_str(obj.get("agentType")) + name = from_str(obj.get("name")) + prompt = from_str(obj.get("prompt")) + description = from_union([from_str, from_none], obj.get("description")) + model = from_union([from_str, from_none], obj.get("model")) + return TasksStartAgentRequest(agent_type, name, prompt, description, model) def to_dict(self) -> dict: result: dict = {} - result["displayText"] = from_str(self.display_text) - result["kind"] = to_enum(QueuePendingItemsKind, self.kind) + result["agentType"] = from_str(self.agent_type) + result["name"] = from_str(self.name) + result["prompt"] = from_str(self.prompt) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RemoteEnableRequest: - """Optional remote session mode ("off", "export", or "on"); defaults to enabling both export - and remote steering. - """ - mode: RemoteSessionMode | None = None - """Per-session remote mode. "off" disables remote, "export" exports session events to GitHub - without enabling remote steering, "on" enables both export and remote steering. - """ +class TasksStartAgentResult: + """Identifier assigned to the newly started background agent task.""" + + agent_id: str + """Generated agent ID for the background task""" @staticmethod - def from_dict(obj: Any) -> 'RemoteEnableRequest': + def from_dict(obj: Any) -> 'TasksStartAgentResult': assert isinstance(obj, dict) - mode = from_union([RemoteSessionMode, from_none], obj.get("mode")) - return RemoteEnableRequest(mode) + agent_id = from_str(obj.get("agentId")) + return TasksStartAgentResult(agent_id) def to_dict(self) -> dict: result: dict = {} - if self.mode is not None: - result["mode"] = from_union([lambda x: to_enum(RemoteSessionMode, x), from_none], self.mode) + result["agentId"] = from_str(self.agent_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ScheduleList: - """Snapshot of the currently active recurring prompts for this session.""" - - entries: list[ScheduleEntry] - """Active scheduled prompts, ordered by id.""" - +class TasksWaitForPendingResult: + """Wait until all in-flight background tasks (agents + shells) and any follow-up turns + scheduled by their completions have settled. Returns when the runtime is fully drained or + after an internal timeout (default 10 minutes; configurable via + COPILOT_TASK_WAIT_TIMEOUT_SECONDS). + """ @staticmethod - def from_dict(obj: Any) -> 'ScheduleList': + def from_dict(obj: Any) -> 'TasksWaitForPendingResult': assert isinstance(obj, dict) - entries = from_list(ScheduleEntry.from_dict, obj.get("entries")) - return ScheduleList(entries) + return TasksWaitForPendingResult() def to_dict(self) -> dict: result: dict = {} - result["entries"] = from_list(lambda x: to_class(ScheduleEntry, x), self.entries) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ScheduleStopResult: - """Remove a scheduled prompt by id. The result entry is omitted if the id was unknown.""" - - entry: ScheduleEntry | None = None - """The removed entry, or omitted if no entry matched.""" +class TelemetrySetFeatureOverridesRequest: + """Feature override key/value pairs to attach to subsequent telemetry events from this + session. + """ + features: dict[str, str] + """Override key/value pairs to attach to subsequent telemetry events from this session. + Replaces any previously-set overrides. + """ @staticmethod - def from_dict(obj: Any) -> 'ScheduleStopResult': + def from_dict(obj: Any) -> 'TelemetrySetFeatureOverridesRequest': assert isinstance(obj, dict) - entry = from_union([ScheduleEntry.from_dict, from_none], obj.get("entry")) - return ScheduleStopResult(entry) + features = from_dict(from_str, obj.get("features")) + return TelemetrySetFeatureOverridesRequest(features) def to_dict(self) -> dict: result: dict = {} - if self.entry is not None: - result["entry"] = from_union([lambda x: to_class(ScheduleEntry, x), from_none], self.entry) + result["features"] = from_dict(from_str, self.features) return result +class TokenAuthInfoType(Enum): + TOKEN = "token" + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentSelectionDetails: - """Position range of the selection within the file""" +class Tool: + """Built-in tool metadata with identifier, optional namespaced name, description, + input-parameter schema, and usage instructions. + """ + description: str + """Description of what the tool does""" - end: SendAttachmentSelectionDetailsEnd - """End position of the selection""" + name: str + """Tool identifier (e.g., "bash", "grep", "str_replace_editor")""" - start: SendAttachmentSelectionDetailsStart - """Start position of the selection""" + instructions: str | None = None + """Optional instructions for how to use this tool effectively""" + + namespaced_name: str | None = None + """Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP + tools) + """ + parameters: dict[str, Any] | None = None + """JSON Schema for the tool's input parameters""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentSelectionDetails': + def from_dict(obj: Any) -> 'Tool': assert isinstance(obj, dict) - end = SendAttachmentSelectionDetailsEnd.from_dict(obj.get("end")) - start = SendAttachmentSelectionDetailsStart.from_dict(obj.get("start")) - return SendAttachmentSelectionDetails(end, start) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + instructions = from_union([from_str, from_none], obj.get("instructions")) + namespaced_name = from_union([from_str, from_none], obj.get("namespacedName")) + parameters = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("parameters")) + return Tool(description, name, instructions, namespaced_name, parameters) def to_dict(self) -> dict: result: dict = {} - result["end"] = to_class(SendAttachmentSelectionDetailsEnd, self.end) - result["start"] = to_class(SendAttachmentSelectionDetailsStart, self.start) + result["description"] = from_str(self.description) + result["name"] = from_str(self.name) + if self.instructions is not None: + result["instructions"] = from_union([from_str, from_none], self.instructions) + if self.namespaced_name is not None: + result["namespacedName"] = from_union([from_str, from_none], self.namespaced_name) + if self.parameters is not None: + result["parameters"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.parameters) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentBlob: - """Blob attachment with inline base64-encoded data""" - - data: str - """Base64-encoded content""" - - mime_type: str - """MIME type of the inline data""" - - type: ClassVar[str] = "blob" - """Attachment type discriminator""" - - display_name: str | None = None - """User-facing display name for the attachment""" - +class ToolsInitializeAndValidateResult: + """Resolve, build, and validate the runtime tool list for this session. Subagent sessions + and consumer flows that need an initialized tool set before `send` invoke this. Default + base-class implementation is a no-op for sessions that don't support tool validation. + """ @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentBlob': + def from_dict(obj: Any) -> 'ToolsInitializeAndValidateResult': assert isinstance(obj, dict) - data = from_str(obj.get("data")) - mime_type = from_str(obj.get("mimeType")) - display_name = from_union([from_str, from_none], obj.get("displayName")) - return SendAttachmentBlob(data, mime_type, display_name) + return ToolsInitializeAndValidateResult() def to_dict(self) -> dict: result: dict = {} - result["data"] = from_str(self.data) - result["mimeType"] = from_str(self.mime_type) - result["type"] = self.type - if self.display_name is not None: - result["displayName"] = from_union([from_str, from_none], self.display_name) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentFile: - """File attachment""" +class ToolsListRequest: + """Optional model identifier whose tool overrides should be applied to the listing.""" - display_name: str - """User-facing display name for the attachment""" - - path: str - """Absolute file path""" - - type: ClassVar[str] = "file" - """Attachment type discriminator""" - - line_range: SendAttachmentFileLineRange | None = None - """Optional line range to scope the attachment to a specific section of the file""" + model: str | None = None + """Optional model ID — when provided, the returned tool list reflects model-specific + overrides + """ @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentFile': + def from_dict(obj: Any) -> 'ToolsListRequest': assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - path = from_str(obj.get("path")) - line_range = from_union([SendAttachmentFileLineRange.from_dict, from_none], obj.get("lineRange")) - return SendAttachmentFile(display_name, path, line_range) + model = from_union([from_str, from_none], obj.get("model")) + return ToolsListRequest(model) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["path"] = from_str(self.path) - result["type"] = self.type - if self.line_range is not None: - result["lineRange"] = from_union([lambda x: to_class(SendAttachmentFileLineRange, x), from_none], self.line_range) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentGithubReference: - """GitHub issue, pull request, or discussion reference""" +class ToolsUpdateSubagentSettingsResult: + """Empty result after applying subagent settings""" + @staticmethod + def from_dict(obj: Any) -> 'ToolsUpdateSubagentSettingsResult': + assert isinstance(obj, dict) + return ToolsUpdateSubagentSettingsResult() - number: int - """Issue, pull request, or discussion number""" + def to_dict(self) -> dict: + result: dict = {} + return result - reference_type: SendAttachmentGithubReferenceTypeEnum - """Type of GitHub reference""" +# Experimental: this type is part of an experimental API and may change or be removed. +class UIAutoModeSwitchResponse(Enum): + """User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist + as setting), or no (decline). + """ + NO = "no" + YES = "yes" + YES_ALWAYS = "yes_always" - state: str - """Current state of the referenced item (e.g., open, closed, merged)""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationArrayAnyOfFieldItemsAnyOf: + """Selectable option for a UI elicitation multi-select array item, with submitted value and + display label. + """ + const: str + """Value submitted when this option is selected.""" title: str - """Title of the referenced item""" - - type: ClassVar[str] = "github_reference" - """Attachment type discriminator""" - - url: str - """URL to the referenced item on GitHub""" + """Display label for this option.""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentGithubReference': + def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItemsAnyOf': assert isinstance(obj, dict) - number = from_int(obj.get("number")) - reference_type = SendAttachmentGithubReferenceTypeEnum(obj.get("referenceType")) - state = from_str(obj.get("state")) + const = from_str(obj.get("const")) title = from_str(obj.get("title")) - url = from_str(obj.get("url")) - return SendAttachmentGithubReference(number, reference_type, state, title, url) + return UIElicitationArrayAnyOfFieldItemsAnyOf(const, title) def to_dict(self) -> dict: result: dict = {} - result["number"] = from_int(self.number) - result["referenceType"] = to_enum(SendAttachmentGithubReferenceTypeEnum, self.reference_type) - result["state"] = from_str(self.state) + result["const"] = from_str(self.const) result["title"] = from_str(self.title) - result["type"] = self.type - result["url"] = from_str(self.url) return result -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SendRequest: - """Parameters for sending a user message to the session""" +class UIElicitationArrayAnyOfFieldType(Enum): + ARRAY = "array" - prompt: str - """The user message text""" +class UIElicitationArrayEnumFieldItemsType(Enum): + STRING = "string" - agent_mode: SendAgentMode | None = None - """The UI mode the agent was in when this message was sent. Defaults to the session's - current mode. - """ - attachments: list[SendAttachment] | None = None - """Optional attachments (files, directories, selections, blobs, GitHub references) to - include with the message - """ - billable: bool | None = None - """If false, this message will not trigger a Premium Request Unit charge. User messages - default to billable. - """ - display_prompt: str | None = None - """If provided, this is shown in the timeline instead of `prompt`""" +# Experimental: this type is part of an experimental API and may change or be removed. +class UIElicitationSchemaPropertyStringFormat(Enum): + """Optional format hint that constrains the accepted input.""" - mode: SendMode | None = None - """How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` - interjects during an in-progress turn. - """ - prepend: bool | None = None - """If true, adds the message to the front of the queue instead of the end""" + DATE = "date" + DATE_TIME = "date-time" + EMAIL = "email" + URI = "uri" - request_headers: dict[str, str] | None = None - """Custom HTTP headers to include in outbound model requests for this turn. Merged with - session-level provider headers; per-turn headers augment and overwrite session-level - headers with the same key. - """ - required_tool: str | None = None - """If set, the request will fail if the named tool is not available when this message is - among the user messages at the start of the current exchange - """ - # Internal: this field is an internal SDK API and is not part of the public surface. - source: Any = None - """Optional provenance tag copied to the resulting user.message event. Supported values are - `system`, `command-*`, and `schedule-*`. +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationStringOneOfFieldOneOf: + """Selectable option for a UI elicitation single-select string field, with submitted value + and display label. """ - traceparent: str | None = None - """W3C Trace Context traceparent header for distributed tracing of this agent turn""" - - tracestate: str | None = None - """W3C Trace Context tracestate header for distributed tracing""" + const: str + """Value submitted when this option is selected.""" - wait: bool | None = None - """If true, await completion of the agentic loop for this message before returning. Defaults - to false (fire-and-forget). When true, the result still contains the same `messageId`; - the caller can rely on the agent having processed the message before the call resolves. - """ + title: str + """Display label for this option.""" @staticmethod - def from_dict(obj: Any) -> 'SendRequest': + def from_dict(obj: Any) -> 'UIElicitationStringOneOfFieldOneOf': assert isinstance(obj, dict) - prompt = from_str(obj.get("prompt")) - agent_mode = from_union([SendAgentMode, from_none], obj.get("agentMode")) - attachments = from_union([lambda x: from_list(_load_SendAttachment, x), from_none], obj.get("attachments")) - billable = from_union([from_bool, from_none], obj.get("billable")) - display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) - mode = from_union([SendMode, from_none], obj.get("mode")) - prepend = from_union([from_bool, from_none], obj.get("prepend")) - request_headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("requestHeaders")) - required_tool = from_union([from_str, from_none], obj.get("requiredTool")) - source = obj.get("source") - traceparent = from_union([from_str, from_none], obj.get("traceparent")) - tracestate = from_union([from_str, from_none], obj.get("tracestate")) - wait = from_union([from_bool, from_none], obj.get("wait")) - return SendRequest(prompt, agent_mode, attachments, billable, display_prompt, mode, prepend, request_headers, required_tool, source, traceparent, tracestate, wait) + const = from_str(obj.get("const")) + title = from_str(obj.get("title")) + return UIElicitationStringOneOfFieldOneOf(const, title) def to_dict(self) -> dict: result: dict = {} - result["prompt"] = from_str(self.prompt) - if self.agent_mode is not None: - result["agentMode"] = from_union([lambda x: to_enum(SendAgentMode, x), from_none], self.agent_mode) - if self.attachments is not None: - result["attachments"] = from_union([lambda x: from_list(lambda x: (x).to_dict(), x), from_none], self.attachments) - if self.billable is not None: - result["billable"] = from_union([from_bool, from_none], self.billable) - if self.display_prompt is not None: - result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) - if self.mode is not None: - result["mode"] = from_union([lambda x: to_enum(SendMode, x), from_none], self.mode) - if self.prepend is not None: - result["prepend"] = from_union([from_bool, from_none], self.prepend) - if self.request_headers is not None: - result["requestHeaders"] = from_union([lambda x: from_dict(from_str, x), from_none], self.request_headers) - if self.required_tool is not None: - result["requiredTool"] = from_union([from_str, from_none], self.required_tool) - if self.source is not None: - result["source"] = self.source - if self.traceparent is not None: - result["traceparent"] = from_union([from_str, from_none], self.traceparent) - if self.tracestate is not None: - result["tracestate"] = from_union([from_str, from_none], self.tracestate) - if self.wait is not None: - result["wait"] = from_union([from_bool, from_none], self.wait) + result["const"] = from_str(self.const) + result["title"] = from_str(self.title) return result -@dataclass -class ServerSkillList: - """Skills discovered across global and project sources.""" - - skills: list[ServerSkill] - """All discovered skills across all sources""" +class UIElicitationSchemaPropertyType(Enum): + """Numeric type accepted by the field.""" - @staticmethod - def from_dict(obj: Any) -> 'ServerSkillList': - assert isinstance(obj, dict) - skills = from_list(ServerSkill.from_dict, obj.get("skills")) - return ServerSkillList(skills) + ARRAY = "array" + BOOLEAN = "boolean" + INTEGER = "integer" + NUMBER = "number" + STRING = "string" - def to_dict(self) -> dict: - result: dict = {} - result["skills"] = from_list(lambda x: to_class(ServerSkill, x), self.skills) - return result +class UIElicitationSchemaType(Enum): + OBJECT = "object" # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSError: - """Describes a filesystem error.""" +class UIElicitationResponseAction(Enum): + """The user's response: accept (submitted), decline (rejected), or cancel (dismissed)""" - code: SessionFSErrorCode - """Error classification""" + ACCEPT = "accept" + CANCEL = "cancel" + DECLINE = "decline" - message: str | None = None - """Free-form detail about the error, for logging/diagnostics""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationResult: + """Indicates whether the elicitation response was accepted; false if it was already resolved + by another client. + """ + success: bool + """Whether the response was accepted. False if the request was already resolved by another + client. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSError': + def from_dict(obj: Any) -> 'UIElicitationResult': assert isinstance(obj, dict) - code = SessionFSErrorCode(obj.get("code")) - message = from_union([from_str, from_none], obj.get("message")) - return SessionFSError(code, message) + success = from_bool(obj.get("success")) + return UIElicitationResult(success) def to_dict(self) -> dict: result: dict = {} - result["code"] = to_enum(SessionFSErrorCode, self.code) - if self.message is not None: - result["message"] = from_union([from_str, from_none], self.message) + result["success"] = from_bool(self.success) return result +class UIElicitationSchemaPropertyBooleanType(Enum): + BOOLEAN = "boolean" + # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionFSReaddirWithTypesEntry: - """Schema for the `SessionFsReaddirWithTypesEntry` type.""" +class UIElicitationSchemaPropertyNumberType(Enum): + """Numeric type accepted by the field.""" - name: str - """Entry name""" + INTEGER = "integer" + NUMBER = "number" - type: SessionFSReaddirWithTypesEntryType - """Entry type""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIEphemeralQueryResult: + """Transient answer generated from current conversation context.""" + + answer: str + """Full assistant response text.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesEntry': + def from_dict(obj: Any) -> 'UIEphemeralQueryResult': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - type = SessionFSReaddirWithTypesEntryType(obj.get("type")) - return SessionFSReaddirWithTypesEntry(name, type) + answer = from_str(obj.get("answer")) + return UIEphemeralQueryResult(answer) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) - result["type"] = to_enum(SessionFSReaddirWithTypesEntryType, self.type) + result["answer"] = from_str(self.answer) return result -@dataclass -class SessionFSSetProviderRequest: - """Initial working directory, session-state path layout, and path conventions used to - register the calling SDK client as the session filesystem provider. - """ - conventions: SessionFSSetProviderConventions - """Path conventions used by this filesystem""" - - initial_cwd: str - """Initial working directory for sessions""" +# Experimental: this type is part of an experimental API and may change or be removed. +class UIExitPlanModeAction(Enum): + """The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, + otherwise 'interactive'. + """ + AUTOPILOT = "autopilot" + AUTOPILOT_FLEET = "autopilot_fleet" + EXIT_ONLY = "exit_only" + INTERACTIVE = "interactive" - session_state_path: str - """Path within each session's SessionFs where the runtime stores files for that session""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingResult: + """Indicates whether the pending UI request was resolved by this call.""" - capabilities: SessionFSSetProviderCapabilities | None = None - """Optional capabilities declared by the provider""" + success: bool + """True if the request was still pending and was resolved by this call. False if the request + ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise + no longer pending. + """ @staticmethod - def from_dict(obj: Any) -> 'SessionFSSetProviderRequest': + def from_dict(obj: Any) -> 'UIHandlePendingResult': assert isinstance(obj, dict) - conventions = SessionFSSetProviderConventions(obj.get("conventions")) - initial_cwd = from_str(obj.get("initialCwd")) - session_state_path = from_str(obj.get("sessionStatePath")) - capabilities = from_union([SessionFSSetProviderCapabilities.from_dict, from_none], obj.get("capabilities")) - return SessionFSSetProviderRequest(conventions, initial_cwd, session_state_path, capabilities) + success = from_bool(obj.get("success")) + return UIHandlePendingResult(success) def to_dict(self) -> dict: result: dict = {} - result["conventions"] = to_enum(SessionFSSetProviderConventions, self.conventions) - result["initialCwd"] = from_str(self.initial_cwd) - result["sessionStatePath"] = from_str(self.session_state_path) - if self.capabilities is not None: - result["capabilities"] = from_union([lambda x: to_class(SessionFSSetProviderCapabilities, x), from_none], self.capabilities) + result["success"] = from_bool(self.success) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSSqliteQueryRequest: - """SQL query, query type, and optional bind parameters for executing a SQLite query against - the per-session database. +class UIHandlePendingSamplingRequest: + """Request ID of a pending `sampling.requested` event and an optional sampling result + payload (omit to reject). """ - query: str - """SQL query to execute""" + request_id: str + """The unique request ID from the sampling.requested event""" - query_type: SessionFSSqliteQueryType - """How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT - (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) + response: dict[str, Any] | None = None + """Optional sampling result payload. Omit to reject/cancel the sampling request without + providing a result. """ - session_id: str - """Target session identifier""" - - params: dict[str, float | str | None] | None = None - """Optional named bind parameters""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSSqliteQueryRequest': + def from_dict(obj: Any) -> 'UIHandlePendingSamplingRequest': assert isinstance(obj, dict) - query = from_str(obj.get("query")) - query_type = SessionFSSqliteQueryType(obj.get("queryType")) - session_id = from_str(obj.get("sessionId")) - params = from_union([lambda x: from_dict(lambda x: from_union([from_none, from_float, from_str], x), x), from_none], obj.get("params")) - return SessionFSSqliteQueryRequest(query, query_type, session_id, params) + request_id = from_str(obj.get("requestId")) + response = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("response")) + return UIHandlePendingSamplingRequest(request_id, response) def to_dict(self) -> dict: result: dict = {} - result["query"] = from_str(self.query) - result["queryType"] = to_enum(SessionFSSqliteQueryType, self.query_type) - result["sessionId"] = from_str(self.session_id) - if self.params is not None: - result["params"] = from_union([lambda x: from_dict(lambda x: from_union([from_none, to_float, from_str], x), x), from_none], self.params) + result["requestId"] = from_str(self.request_id) + if self.response is not None: + result["response"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.response) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionsListRequest: - """Optional metadata-load limit and filters applied to the returned sessions.""" - - filter: SessionListFilter | None = None - """Optional filter applied to the returned sessions""" +class UISessionLimitsExhaustedResponseAction(Enum): + """Action selected by the user. - include_detached: bool | None = None - """When true, include detached maintenance sessions. Defaults to false for user-facing - session lists. - """ - metadata_limit: int | None = None - """When provided, only the first N sessions (sorted by modification time, newest first) load - full metadata; remaining sessions return basic info only. Use 0 to return only basic info - for every session. + User action selected for an exhausted session limit. """ - - @staticmethod - def from_dict(obj: Any) -> 'SessionsListRequest': - assert isinstance(obj, dict) - filter = from_union([SessionListFilter.from_dict, from_none], obj.get("filter")) - include_detached = from_union([from_bool, from_none], obj.get("includeDetached")) - metadata_limit = from_union([from_int, from_none], obj.get("metadataLimit")) - return SessionsListRequest(filter, include_detached, metadata_limit) - - def to_dict(self) -> dict: - result: dict = {} - if self.filter is not None: - result["filter"] = from_union([lambda x: to_class(SessionListFilter, x), from_none], self.filter) - if self.include_detached is not None: - result["includeDetached"] = from_union([from_bool, from_none], self.include_detached) - if self.metadata_limit is not None: - result["metadataLimit"] = from_union([from_int, from_none], self.metadata_limit) - return result + ADD = "add" + CANCEL = "cancel" + SET = "set" + UNSET = "unset" # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ShellKillRequest: - """Identifier of a process previously returned by "shell.exec" and the signal to send.""" - - process_id: str - """Process identifier returned by shell.exec""" +class UIUserInputResponse: + """User response for a pending user-input request, with answer text and whether it was typed + freeform. + """ + answer: str + """The user's answer text""" - signal: ShellKillSignal | None = None - """Signal to send (default: SIGTERM)""" + was_freeform: bool + """True if the user typed a freeform response, false if they selected a presented choice. + Used by telemetry to differentiate between free text input and choice selection. + """ @staticmethod - def from_dict(obj: Any) -> 'ShellKillRequest': + def from_dict(obj: Any) -> 'UIUserInputResponse': assert isinstance(obj, dict) - process_id = from_str(obj.get("processId")) - signal = from_union([ShellKillSignal, from_none], obj.get("signal")) - return ShellKillRequest(process_id, signal) + answer = from_str(obj.get("answer")) + was_freeform = from_bool(obj.get("wasFreeform")) + return UIUserInputResponse(answer, was_freeform) def to_dict(self) -> dict: result: dict = {} - result["processId"] = from_str(self.process_id) - if self.signal is not None: - result["signal"] = from_union([lambda x: to_enum(ShellKillSignal, x), from_none], self.signal) + result["answer"] = from_str(self.answer) + result["wasFreeform"] = from_bool(self.was_freeform) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentInfo: - """Schema for the `AgentInfo` type. - - The newly selected custom agent - """ - description: str - """Description of the agent's purpose""" - - display_name: str - """Human-readable display name""" - - id: str - """Stable identifier for selection. For most agents this is the same as `name`; for - plugin/builtin agents it may differ. Always populated; defaults to `name` when no - distinct id was assigned. - """ - name: str - """Unique identifier of the custom agent""" - - mcp_servers: dict[str, Any] | None = None - """MCP server configurations attached to this agent, keyed by server name. Server config - shape mirrors the MCP `mcpServers` schema. - """ - model: str | None = None - """Preferred model id for this agent. When omitted, inherits the outer agent's model.""" - - path: str | None = None - """Absolute local file path of the agent definition. Only set for file-based agents loaded - from disk; remote agents do not have a path. +class UIRegisterDirectAutoModeSwitchHandlerResult: + """Register an in-process handler for `auto_mode_switch.requested` events. The caller still + attaches the actual listener via the standard event-subscription mechanism; this + registration solely tells the server bridge to skip its own dispatch (so a remote client + doesn't race the in-process handler for the same requestId). """ - skills: list[str] | None = None - """Skill names preloaded into this agent's context. Omitted means none.""" - - source: AgentInfoSource | None = None - """Where the agent definition was loaded from""" - - tools: list[str] | None = None - """Allowed tool names for this agent. Empty array means none; omitted means inherit defaults.""" - - user_invocable: bool | None = None - """Whether the agent can be selected directly by the user. Agents marked `false` are - subagent-only. + handle: str + """Opaque handle representing the registration. Pass this same handle to + `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. + Multiple registrations are reference-counted; the server bridge will only dispatch + auto-mode-switch requests when no handles are active. """ @staticmethod - def from_dict(obj: Any) -> 'AgentInfo': + def from_dict(obj: Any) -> 'UIRegisterDirectAutoModeSwitchHandlerResult': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - display_name = from_str(obj.get("displayName")) - id = from_str(obj.get("id")) - name = from_str(obj.get("name")) - mcp_servers = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("mcpServers")) - model = from_union([from_str, from_none], obj.get("model")) - path = from_union([from_str, from_none], obj.get("path")) - skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skills")) - source = from_union([AgentInfoSource, from_none], obj.get("source")) - tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) - user_invocable = from_union([from_bool, from_none], obj.get("userInvocable")) - return AgentInfo(description, display_name, id, name, mcp_servers, model, path, skills, source, tools, user_invocable) + handle = from_str(obj.get("handle")) + return UIRegisterDirectAutoModeSwitchHandlerResult(handle) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["displayName"] = from_str(self.display_name) - result["id"] = from_str(self.id) - result["name"] = from_str(self.name) - if self.mcp_servers is not None: - result["mcpServers"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.mcp_servers) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.skills is not None: - result["skills"] = from_union([lambda x: from_list(from_str, x), from_none], self.skills) - if self.source is not None: - result["source"] = from_union([lambda x: to_enum(AgentInfoSource, x), from_none], self.source) - if self.tools is not None: - result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) - if self.user_invocable is not None: - result["userInvocable"] = from_union([from_bool, from_none], self.user_invocable) + result["handle"] = from_str(self.handle) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillList: - """Skills available to the session, with their enabled state.""" +class UIUnregisterDirectAutoModeSwitchHandlerRequest: + """Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.""" - skills: list[Skill] - """Available skills""" + handle: str + """Handle previously returned by `registerDirectAutoModeSwitchHandler`""" @staticmethod - def from_dict(obj: Any) -> 'SkillList': + def from_dict(obj: Any) -> 'UIUnregisterDirectAutoModeSwitchHandlerRequest': assert isinstance(obj, dict) - skills = from_list(Skill.from_dict, obj.get("skills")) - return SkillList(skills) + handle = from_str(obj.get("handle")) + return UIUnregisterDirectAutoModeSwitchHandlerRequest(handle) def to_dict(self) -> dict: result: dict = {} - result["skills"] = from_list(lambda x: to_class(Skill, x), self.skills) + result["handle"] = from_str(self.handle) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsConfigSetDisabledSkillsRequest: - """Skill names to mark as disabled in global configuration, replacing any previous list.""" +class UIUnregisterDirectAutoModeSwitchHandlerResult: + """Indicates whether the handle was active and the registration count was decremented.""" - disabled_skills: list[str] - """List of skill names to disable""" + unregistered: bool + """True if the handle was active and decremented the counter; false if the handle was + unknown. + """ @staticmethod - def from_dict(obj: Any) -> 'SkillsConfigSetDisabledSkillsRequest': + def from_dict(obj: Any) -> 'UIUnregisterDirectAutoModeSwitchHandlerResult': assert isinstance(obj, dict) - disabled_skills = from_list(from_str, obj.get("disabledSkills")) - return SkillsConfigSetDisabledSkillsRequest(disabled_skills) + unregistered = from_bool(obj.get("unregistered")) + return UIUnregisterDirectAutoModeSwitchHandlerResult(unregistered) def to_dict(self) -> dict: result: dict = {} - result["disabledSkills"] = from_list(from_str, self.disabled_skills) + result["unregistered"] = from_bool(self.unregistered) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SkillsGetInvokedResult: - """Skills invoked during this session, ordered by invocation time (most recent last).""" +class UsageMetricsCodeChanges: + """Aggregated code change metrics""" - skills: list[SkillsInvokedSkill] - """Skills invoked during this session, ordered by invocation time (most recent last)""" + files_modified: list[str] + """Distinct file paths modified during the session""" + + files_modified_count: int + """Number of distinct files modified""" + + lines_added: int + """Total lines of code added""" + + lines_removed: int + """Total lines of code removed""" @staticmethod - def from_dict(obj: Any) -> 'SkillsGetInvokedResult': + def from_dict(obj: Any) -> 'UsageMetricsCodeChanges': assert isinstance(obj, dict) - skills = from_list(SkillsInvokedSkill.from_dict, obj.get("skills")) - return SkillsGetInvokedResult(skills) + files_modified = from_list(from_str, obj.get("filesModified")) + files_modified_count = from_int(obj.get("filesModifiedCount")) + lines_added = from_int(obj.get("linesAdded")) + lines_removed = from_int(obj.get("linesRemoved")) + return UsageMetricsCodeChanges(files_modified, files_modified_count, lines_added, lines_removed) def to_dict(self) -> dict: result: dict = {} - result["skills"] = from_list(lambda x: to_class(SkillsInvokedSkill, x), self.skills) + result["filesModified"] = from_list(from_str, self.files_modified) + result["filesModifiedCount"] = from_int(self.files_modified_count) + result["linesAdded"] = from_int(self.lines_added) + result["linesRemoved"] = from_int(self.lines_removed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandAgentPromptResult: - """Schema for the `SlashCommandAgentPromptResult` type.""" +class UsageMetricsModelMetricRequests: + """Request count and cost metrics for this model""" - display_prompt: str - """Prompt text to display to the user""" + cost: float + """User-initiated premium request cost (with multiplier applied)""" - kind: ClassVar[str] = "agent-prompt" - """Agent prompt result discriminator""" + count: int + """Number of API requests made with this model""" - prompt: str - """Prompt to submit to the agent""" + @staticmethod + def from_dict(obj: Any) -> 'UsageMetricsModelMetricRequests': + assert isinstance(obj, dict) + cost = from_float(obj.get("cost")) + count = from_int(obj.get("count")) + return UsageMetricsModelMetricRequests(cost, count) - mode: SessionMode | None = None - """Optional target session mode for the agent prompt""" + def to_dict(self) -> dict: + result: dict = {} + result["cost"] = to_float(self.cost) + result["count"] = from_int(self.count) + return result - runtime_settings_changed: bool | None = None - """True when the invocation mutated user runtime settings; consumers caching settings should - refresh - """ +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UsageMetricsModelMetricTokenDetail: + """Per-model token-detail entry containing the accumulated token count for one token type.""" + + token_count: int + """Accumulated token count for this token type""" @staticmethod - def from_dict(obj: Any) -> 'SlashCommandAgentPromptResult': + def from_dict(obj: Any) -> 'UsageMetricsModelMetricTokenDetail': assert isinstance(obj, dict) - display_prompt = from_str(obj.get("displayPrompt")) - prompt = from_str(obj.get("prompt")) - mode = from_union([SessionMode, from_none], obj.get("mode")) - runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) - return SlashCommandAgentPromptResult(display_prompt, prompt, mode, runtime_settings_changed) + token_count = from_int(obj.get("tokenCount")) + return UsageMetricsModelMetricTokenDetail(token_count) def to_dict(self) -> dict: result: dict = {} - result["displayPrompt"] = from_str(self.display_prompt) - result["kind"] = self.kind - result["prompt"] = from_str(self.prompt) - if self.mode is not None: - result["mode"] = from_union([lambda x: to_enum(SessionMode, x), from_none], self.mode) - if self.runtime_settings_changed is not None: - result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + result["tokenCount"] = from_int(self.token_count) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandCompletedResult: - """Schema for the `SlashCommandCompletedResult` type.""" +class UsageMetricsModelMetricUsage: + """Token usage metrics for this model""" - kind: ClassVar[str] = "completed" - """Completed result discriminator""" + cache_read_tokens: int + """Total tokens read from prompt cache""" - message: str | None = None - """Optional user-facing message describing the completed command""" + cache_write_tokens: int + """Total tokens written to prompt cache""" - runtime_settings_changed: bool | None = None - """True when the invocation mutated user runtime settings; consumers caching settings should - refresh - """ + input_tokens: int + """Total input tokens consumed""" + + output_tokens: int + """Total output tokens produced""" + + reasoning_tokens: int | None = None + """Total output tokens used for reasoning""" @staticmethod - def from_dict(obj: Any) -> 'SlashCommandCompletedResult': + def from_dict(obj: Any) -> 'UsageMetricsModelMetricUsage': assert isinstance(obj, dict) - message = from_union([from_str, from_none], obj.get("message")) - runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) - return SlashCommandCompletedResult(message, runtime_settings_changed) + cache_read_tokens = from_int(obj.get("cacheReadTokens")) + cache_write_tokens = from_int(obj.get("cacheWriteTokens")) + input_tokens = from_int(obj.get("inputTokens")) + output_tokens = from_int(obj.get("outputTokens")) + reasoning_tokens = from_union([from_int, from_none], obj.get("reasoningTokens")) + return UsageMetricsModelMetricUsage(cache_read_tokens, cache_write_tokens, input_tokens, output_tokens, reasoning_tokens) def to_dict(self) -> dict: result: dict = {} - result["kind"] = self.kind - if self.message is not None: - result["message"] = from_union([from_str, from_none], self.message) - if self.runtime_settings_changed is not None: - result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + result["cacheReadTokens"] = from_int(self.cache_read_tokens) + result["cacheWriteTokens"] = from_int(self.cache_write_tokens) + result["inputTokens"] = from_int(self.input_tokens) + result["outputTokens"] = from_int(self.output_tokens) + if self.reasoning_tokens is not None: + result["reasoningTokens"] = from_union([from_int, from_none], self.reasoning_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandSelectSubcommandResult: - """Schema for the `SlashCommandSelectSubcommandResult` type.""" +class UsageMetricsTokenDetail: + """Session-wide token-detail entry containing the accumulated token count for one token type.""" - command: str - """Parent command name that requires subcommand selection""" + token_count: int + """Accumulated token count for this token type""" - kind: ClassVar[str] = "select-subcommand" - """Select subcommand result discriminator""" + @staticmethod + def from_dict(obj: Any) -> 'UsageMetricsTokenDetail': + assert isinstance(obj, dict) + token_count = from_int(obj.get("tokenCount")) + return UsageMetricsTokenDetail(token_count) - options: list[SlashCommandSelectSubcommandOption] - """Available subcommand options for the client to present""" + def to_dict(self) -> dict: + result: dict = {} + result["tokenCount"] = from_int(self.token_count) + return result - title: str - """Human-readable title for the selection UI""" +class UserAuthInfoType(Enum): + USER = "user" - runtime_settings_changed: bool | None = None - """True when the invocation mutated user runtime settings; consumers caching settings should - refresh +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UserSettingMetadata: + """A single user setting's effective value alongside its default, so consumers can render + settings left at their default. + """ + default: Any + """The centrally-known default for this setting (null when no default is registered).""" + + is_default: bool + """True when the user has not set an explicit value for this setting (i.e. it is left at its + default). Reflects whether the user has overridden the key, not whether the effective + value happens to equal the default — a key explicitly set to a value identical to the + default still reports false. """ + value: Any + """The effective value: the user's value if set, otherwise the default.""" @staticmethod - def from_dict(obj: Any) -> 'SlashCommandSelectSubcommandResult': + def from_dict(obj: Any) -> 'UserSettingMetadata': assert isinstance(obj, dict) - command = from_str(obj.get("command")) - options = from_list(SlashCommandSelectSubcommandOption.from_dict, obj.get("options")) - title = from_str(obj.get("title")) - runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) - return SlashCommandSelectSubcommandResult(command, options, title, runtime_settings_changed) + default = obj.get("default") + is_default = from_bool(obj.get("isDefault")) + value = obj.get("value") + return UserSettingMetadata(default, is_default, value) def to_dict(self) -> dict: result: dict = {} - result["command"] = from_str(self.command) - result["kind"] = self.kind - result["options"] = from_list(lambda x: to_class(SlashCommandSelectSubcommandOption, x), self.options) - result["title"] = from_str(self.title) - if self.runtime_settings_changed is not None: - result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + result["default"] = self.default + result["isDefault"] = from_bool(self.is_default) + result["value"] = self.value return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskAgentProgress: - """Schema for the `TaskAgentProgress` type.""" - - recent_activity: list[TaskProgressLine] - """Recent tool execution events converted to display lines""" - - type: TaskAgentInfoType - """Progress kind""" - - latest_intent: str | None = None - """The most recent intent reported by the agent""" +class UserSettingsSetRequest: + """Partial user settings to write to settings.json. Each top-level key is written + individually, replacing the existing value; a key whose value is null is removed. + """ + settings: Any + """Partial user settings to write, as a free-form object keyed by setting name""" @staticmethod - def from_dict(obj: Any) -> 'TaskAgentProgress': + def from_dict(obj: Any) -> 'UserSettingsSetRequest': assert isinstance(obj, dict) - recent_activity = from_list(TaskProgressLine.from_dict, obj.get("recentActivity")) - type = TaskAgentInfoType(obj.get("type")) - latest_intent = from_union([from_str, from_none], obj.get("latestIntent")) - return TaskAgentProgress(recent_activity, type, latest_intent) + settings = obj.get("settings") + return UserSettingsSetRequest(settings) def to_dict(self) -> dict: result: dict = {} - result["recentActivity"] = from_list(lambda x: to_class(TaskProgressLine, x), self.recent_activity) - result["type"] = to_enum(TaskAgentInfoType, self.type) - if self.latest_intent is not None: - result["latestIntent"] = from_union([from_str, from_none], self.latest_intent) + result["settings"] = self.settings return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskShellInfo: - """Schema for the `TaskShellInfo` type.""" +class UserSettingsSetResult: + """Outcome of writing user settings.""" - attachment_mode: TaskShellInfoAttachmentMode - """Whether the shell runs inside a managed PTY session or as an independent background - process + shadowed_keys: list[str] + """Top-level keys whose write landed in settings.json but is shadowed by a value still + present in the legacy config.json (config.json wins on read). The write does not take + effect until the legacy value is removed. """ - command: str - """Command being executed""" - - description: str - """Short description of the task""" - id: str - """Unique task identifier""" + @staticmethod + def from_dict(obj: Any) -> 'UserSettingsSetResult': + assert isinstance(obj, dict) + shadowed_keys = from_list(from_str, obj.get("shadowedKeys")) + return UserSettingsSetResult(shadowed_keys) - started_at: datetime - """ISO 8601 timestamp when the task was started""" + def to_dict(self) -> dict: + result: dict = {} + result["shadowedKeys"] = from_list(from_str, self.shadowed_keys) + return result - status: TaskStatus - """Current lifecycle status of the task""" +# Experimental: this type is part of an experimental API and may change or be removed. +class WorkspaceDiffFileChangeType(Enum): + """Type of change represented by this file diff.""" - type: ClassVar[str] = "shell" - """Task kind""" + ADDED = "added" + DELETED = "deleted" + MODIFIED = "modified" + RENAMED = "renamed" - can_promote_to_background: bool | None = None - """Whether this shell task can be promoted to background mode""" +# Experimental: this type is part of an experimental API and may change or be removed. +class WorkspaceDiffMode(Enum): + """Diff mode requested by the client. - completed_at: datetime | None = None - """ISO 8601 timestamp when the task finished""" + Effective mode used for the returned changes. + """ + BRANCH = "branch" + SESSION = "session" + UNSTAGED = "unstaged" - execution_mode: TaskExecutionMode | None = None - """Whether task execution is synchronously awaited or managed in the background""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesAddSummaryRequest: + """Compaction summary checkpoint to persist.""" - log_path: str | None = None - """Path to the detached shell log, when available""" + content: str + """Markdown summary content to persist.""" - pid: int | None = None - """Process ID when available""" + title: str + """Summary title shown in checkpoint listings.""" @staticmethod - def from_dict(obj: Any) -> 'TaskShellInfo': + def from_dict(obj: Any) -> 'WorkspacesAddSummaryRequest': assert isinstance(obj, dict) - attachment_mode = TaskShellInfoAttachmentMode(obj.get("attachmentMode")) - command = from_str(obj.get("command")) - description = from_str(obj.get("description")) - id = from_str(obj.get("id")) - started_at = from_datetime(obj.get("startedAt")) - status = TaskStatus(obj.get("status")) - can_promote_to_background = from_union([from_bool, from_none], obj.get("canPromoteToBackground")) - completed_at = from_union([from_datetime, from_none], obj.get("completedAt")) - execution_mode = from_union([TaskExecutionMode, from_none], obj.get("executionMode")) - log_path = from_union([from_str, from_none], obj.get("logPath")) - pid = from_union([from_int, from_none], obj.get("pid")) - return TaskShellInfo(attachment_mode, command, description, id, started_at, status, can_promote_to_background, completed_at, execution_mode, log_path, pid) + content = from_str(obj.get("content")) + title = from_str(obj.get("title")) + return WorkspacesAddSummaryRequest(content, title) def to_dict(self) -> dict: result: dict = {} - result["attachmentMode"] = to_enum(TaskShellInfoAttachmentMode, self.attachment_mode) - result["command"] = from_str(self.command) - result["description"] = from_str(self.description) - result["id"] = from_str(self.id) - result["startedAt"] = self.started_at.isoformat() - result["status"] = to_enum(TaskStatus, self.status) - result["type"] = self.type - if self.can_promote_to_background is not None: - result["canPromoteToBackground"] = from_union([from_bool, from_none], self.can_promote_to_background) - if self.completed_at is not None: - result["completedAt"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at) - if self.execution_mode is not None: - result["executionMode"] = from_union([lambda x: to_enum(TaskExecutionMode, x), from_none], self.execution_mode) - if self.log_path is not None: - result["logPath"] = from_union([from_str, from_none], self.log_path) - if self.pid is not None: - result["pid"] = from_union([from_int, from_none], self.pid) + result["content"] = from_str(self.content) + result["title"] = from_str(self.title) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskShellProgress: - """Schema for the `TaskShellProgress` type.""" - - recent_output: str - """Recent stdout/stderr lines from the running shell command""" - - type: TaskShellInfoType - """Progress kind""" +class WorkspacesAddSummaryResult: + """Persisted summary metadata and refreshed workspace metadata.""" - pid: int | None = None - """Process ID when available""" + summary: dict[str, Any] | None = None + workspace: dict[str, Any] | None = None @staticmethod - def from_dict(obj: Any) -> 'TaskShellProgress': + def from_dict(obj: Any) -> 'WorkspacesAddSummaryResult': assert isinstance(obj, dict) - recent_output = from_str(obj.get("recentOutput")) - type = TaskShellInfoType(obj.get("type")) - pid = from_union([from_int, from_none], obj.get("pid")) - return TaskShellProgress(recent_output, type, pid) + summary = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("summary")) + workspace = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("workspace")) + return WorkspacesAddSummaryResult(summary, workspace) def to_dict(self) -> dict: result: dict = {} - result["recentOutput"] = from_str(self.recent_output) - result["type"] = to_enum(TaskShellInfoType, self.type) - if self.pid is not None: - result["pid"] = from_union([from_int, from_none], self.pid) + if self.summary is not None: + result["summary"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.summary) + if self.workspace is not None: + result["workspace"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.workspace) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsCallToolRequest: - """MCP server, tool name, and arguments to invoke from an MCP App view.""" - - origin_server_name: str - """**Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the - app from this server only'), the call is rejected when this differs from `serverName`, - and rejected outright when missing. - """ - server_name: str - """MCP server hosting the tool""" - - tool_name: str - """MCP tool name""" +class WorkspacesAutopilotObjectiveExistsResult: + """Whether the autopilot objective file exists.""" - arguments: dict[str, Any] | None = None - """Tool arguments""" + exists: bool + """True when the objective file exists.""" @staticmethod - def from_dict(obj: Any) -> 'MCPAppsCallToolRequest': + def from_dict(obj: Any) -> 'WorkspacesAutopilotObjectiveExistsResult': assert isinstance(obj, dict) - origin_server_name = from_str(obj.get("originServerName")) - server_name = from_str(obj.get("serverName")) - tool_name = from_str(obj.get("toolName")) - arguments = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("arguments")) - return MCPAppsCallToolRequest(origin_server_name, server_name, tool_name, arguments) + exists = from_bool(obj.get("exists")) + return WorkspacesAutopilotObjectiveExistsResult(exists) def to_dict(self) -> dict: result: dict = {} - result["originServerName"] = from_str(self.origin_server_name) - result["serverName"] = from_str(self.server_name) - result["toolName"] = from_str(self.tool_name) - if self.arguments is not None: - result["arguments"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.arguments) + result["exists"] = from_bool(self.exists) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionLocationAddToolApprovalParams: - """Location-scoped tool approval to persist.""" +class WorkspacesCreateFileRequest: + """Relative path and UTF-8 content for the workspace file to create or overwrite.""" - approval: PermissionsLocationsAddToolApprovalDetails - """Tool approval to persist and apply""" + content: str + """File content to write as a UTF-8 string""" - location_key: str - """Location key (git root or cwd) to persist the approval to""" + path: str + """Relative path within the workspace files directory""" @staticmethod - def from_dict(obj: Any) -> 'PermissionLocationAddToolApprovalParams': + def from_dict(obj: Any) -> 'WorkspacesCreateFileRequest': assert isinstance(obj, dict) - approval = _load_PermissionsLocationsAddToolApprovalDetails(obj.get("approval")) - location_key = from_str(obj.get("locationKey")) - return PermissionLocationAddToolApprovalParams(approval, location_key) + content = from_str(obj.get("content")) + path = from_str(obj.get("path")) + return WorkspacesCreateFileRequest(content, path) def to_dict(self) -> dict: result: dict = {} - result["approval"] = (self.approval).to_dict() - result["locationKey"] = from_str(self.location_key) + result["content"] = from_str(self.content) + result["path"] = from_str(self.path) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ToolList: - """Built-in tools available for the requested model, with their parameters and instructions.""" +class WorkspacesDeleteAutopilotObjectiveResult: + """Result of deleting the autopilot objective file.""" - tools: list[Tool] - """List of available built-in tools with metadata""" + deleted: bool + """True when a file was deleted.""" @staticmethod - def from_dict(obj: Any) -> 'ToolList': + def from_dict(obj: Any) -> 'WorkspacesDeleteAutopilotObjectiveResult': assert isinstance(obj, dict) - tools = from_list(Tool.from_dict, obj.get("tools")) - return ToolList(tools) + deleted = from_bool(obj.get("deleted")) + return WorkspacesDeleteAutopilotObjectiveResult(deleted) def to_dict(self) -> dict: result: dict = {} - result["tools"] = from_list(lambda x: to_class(Tool, x), self.tools) + result["deleted"] = from_bool(self.deleted) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingAutoModeSwitchRequest: - """Request ID of a pending `auto_mode_switch.requested` event and the user's response.""" - - request_id: str - """The unique request ID from the auto_mode_switch.requested event""" +class WorkspacesEnsureRequest: + """Optional session context used when creating a local workspace.""" - response: UIAutoModeSwitchResponse - """User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist - as setting), or no (decline). - """ + context: Any = None + """Opaque workspace context supplied by the session host.""" @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingAutoModeSwitchRequest': + def from_dict(obj: Any) -> 'WorkspacesEnsureRequest': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - response = UIAutoModeSwitchResponse(obj.get("response")) - return UIHandlePendingAutoModeSwitchRequest(request_id, response) + context = obj.get("context") + return WorkspacesEnsureRequest(context) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - result["response"] = to_enum(UIAutoModeSwitchResponse, self.response) + if self.context is not None: + result["context"] = self.context return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayAnyOfFieldItems: - """Schema applied to each item in the array.""" +class WorkspacesListFilesResult: + """Relative paths of files stored in the session workspace files directory.""" - any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf] - """Selectable options, each with a value and a display label.""" + files: list[str] + """Relative file paths in the workspace files directory""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItems': + def from_dict(obj: Any) -> 'WorkspacesListFilesResult': assert isinstance(obj, dict) - any_of = from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, obj.get("anyOf")) - return UIElicitationArrayAnyOfFieldItems(any_of) + files = from_list(from_str, obj.get("files")) + return WorkspacesListFilesResult(files) def to_dict(self) -> dict: result: dict = {} - result["anyOf"] = from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), self.any_of) + result["files"] = from_list(from_str, self.files) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayEnumFieldItems: - """Schema applied to each item in the array.""" - - enum: list[str] - """Allowed string values for each selected item.""" +class WorkspacesReadAutopilotObjectiveResult: + """Autopilot objective file content, or null when missing.""" - type: UIElicitationArrayEnumFieldItemsType - """Type discriminator. Always "string".""" + content: str | None = None + """Autopilot objective file content, or null when missing.""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayEnumFieldItems': + def from_dict(obj: Any) -> 'WorkspacesReadAutopilotObjectiveResult': assert isinstance(obj, dict) - enum = from_list(from_str, obj.get("enum")) - type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) - return UIElicitationArrayEnumFieldItems(enum, type) + content = from_union([from_none, from_str], obj.get("content")) + return WorkspacesReadAutopilotObjectiveResult(content) def to_dict(self) -> dict: result: dict = {} - result["enum"] = from_list(from_str, self.enum) - result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) + result["content"] = from_union([from_none, from_str], self.content) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayFieldItems: - """Schema applied to each item in the array.""" - - enum: list[str] | None = None - """Allowed string values for each selected item.""" - - type: UIElicitationArrayEnumFieldItemsType | None = None - """Type discriminator. Always "string".""" +class WorkspacesReadCheckpointRequest: + """Checkpoint number to read.""" - any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf] | None = None - """Selectable options, each with a value and a display label.""" + number: int + """Checkpoint number to read""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayFieldItems': + def from_dict(obj: Any) -> 'WorkspacesReadCheckpointRequest': assert isinstance(obj, dict) - enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enum")) - type = from_union([UIElicitationArrayEnumFieldItemsType, from_none], obj.get("type")) - any_of = from_union([lambda x: from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, x), from_none], obj.get("anyOf")) - return UIElicitationArrayFieldItems(enum, type, any_of) + number = from_int(obj.get("number")) + return WorkspacesReadCheckpointRequest(number) def to_dict(self) -> dict: result: dict = {} - if self.enum is not None: - result["enum"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum) - if self.type is not None: - result["type"] = from_union([lambda x: to_enum(UIElicitationArrayEnumFieldItemsType, x), from_none], self.type) - if self.any_of is not None: - result["anyOf"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), x), from_none], self.any_of) + result["number"] = from_int(self.number) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationStringEnumField: - """Single-select string field whose allowed values are defined inline.""" - - enum: list[str] - """Allowed string values.""" +class WorkspacesReadCheckpointResult: + """Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.""" - type: UIElicitationArrayEnumFieldItemsType - """Type discriminator. Always "string".""" + content: str | None = None + """Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing""" - default: str | None = None - """Default value selected when the form is first shown.""" + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesReadCheckpointResult': + assert isinstance(obj, dict) + content = from_union([from_none, from_str], obj.get("content")) + return WorkspacesReadCheckpointResult(content) - description: str | None = None - """Help text describing the field.""" + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_union([from_none, from_str], self.content) + return result - enum_names: list[str] | None = None - """Optional display labels for each enum value, in the same order as `enum`.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesReadFileRequest: + """Relative path of the workspace file to read.""" - title: str | None = None - """Human-readable label for the field.""" + path: str + """Relative path within the workspace files directory""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationStringEnumField': + def from_dict(obj: Any) -> 'WorkspacesReadFileRequest': assert isinstance(obj, dict) - enum = from_list(from_str, obj.get("enum")) - type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) - default = from_union([from_str, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enumNames")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationStringEnumField(enum, type, default, description, enum_names, title) + path = from_str(obj.get("path")) + return WorkspacesReadFileRequest(path) def to_dict(self) -> dict: result: dict = {} - result["enum"] = from_list(from_str, self.enum) - result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) - if self.default is not None: - result["default"] = from_union([from_str, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.enum_names is not None: - result["enumNames"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationSchemaPropertyString: - """Free-text string field with optional length and format constraints.""" +class WorkspacesReadFileResult: + """Contents of the requested workspace file as a UTF-8 string.""" - type: UIElicitationArrayEnumFieldItemsType - """Type discriminator. Always "string".""" + content: str + """File content as a UTF-8 string""" - default: str | None = None - """Default value populated in the input when the form is first shown.""" + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesReadFileResult': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + return WorkspacesReadFileResult(content) - description: str | None = None - """Help text describing the field.""" + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + return result - format: UIElicitationSchemaPropertyStringFormat | None = None - """Optional format hint that constrains the accepted input.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesSaveLargePasteRequest: + """Pasted content to save as a UTF-8 file in the session workspace.""" - max_length: int | None = None - """Maximum number of characters allowed.""" - - min_length: int | None = None - """Minimum number of characters required.""" - - title: str | None = None - """Human-readable label for the field.""" + content: str + """Pasted content to save as a UTF-8 file""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyString': + def from_dict(obj: Any) -> 'WorkspacesSaveLargePasteRequest': assert isinstance(obj, dict) - type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) - default = from_union([from_str, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get("format")) - max_length = from_union([from_int, from_none], obj.get("maxLength")) - min_length = from_union([from_int, from_none], obj.get("minLength")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationSchemaPropertyString(type, default, description, format, max_length, min_length, title) + content = from_str(obj.get("content")) + return WorkspacesSaveLargePasteRequest(content) def to_dict(self) -> dict: result: dict = {} - result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) - if self.default is not None: - result["default"] = from_union([from_str, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.format is not None: - result["format"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format) - if self.max_length is not None: - result["maxLength"] = from_union([from_int, from_none], self.max_length) - if self.min_length is not None: - result["minLength"] = from_union([from_int, from_none], self.min_length) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["content"] = from_str(self.content) return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationStringOneOfField: - """Single-select string field where each option pairs a value with a display label.""" - - one_of: list[UIElicitationStringOneOfFieldOneOf] - """Selectable options, each with a value and a display label.""" - - type: UIElicitationArrayEnumFieldItemsType - """Type discriminator. Always "string".""" - - default: str | None = None - """Default value selected when the form is first shown.""" +class Saved: + filename: str + """Filename within the workspace files directory""" - description: str | None = None - """Help text describing the field.""" + file_path: str + """Absolute filesystem path to the saved paste file""" - title: str | None = None - """Human-readable label for the field.""" + size_bytes: int + """Size of the saved file in bytes""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationStringOneOfField': + def from_dict(obj: Any) -> 'Saved': assert isinstance(obj, dict) - one_of = from_list(UIElicitationStringOneOfFieldOneOf.from_dict, obj.get("oneOf")) - type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) - default = from_union([from_str, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationStringOneOfField(one_of, type, default, description, title) + filename = from_str(obj.get("filename")) + file_path = from_str(obj.get("filePath")) + size_bytes = from_int(obj.get("sizeBytes")) + return Saved(filename, file_path, size_bytes) def to_dict(self) -> dict: result: dict = {} - result["oneOf"] = from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), self.one_of) - result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) - if self.default is not None: - result["default"] = from_union([from_str, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["filename"] = from_str(self.filename) + result["filePath"] = from_str(self.file_path) + result["sizeBytes"] = from_int(self.size_bytes) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationResponse: - """The elicitation response (accept with form values, decline, or cancel)""" +class WorkspacesTruncateSummariesRequest: + """Rollback point for local workspace summaries.""" - action: UIElicitationResponseAction - """The user's response: accept (submitted), decline (rejected), or cancel (dismissed)""" - - content: dict[str, float | bool | list[str] | str] | None = None - """The form values submitted by the user (present when action is 'accept')""" + keep_count: int + """Number of newest summaries to keep.""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationResponse': + def from_dict(obj: Any) -> 'WorkspacesTruncateSummariesRequest': assert isinstance(obj, dict) - action = UIElicitationResponseAction(obj.get("action")) - 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")) - return UIElicitationResponse(action, content) + keep_count = from_int(obj.get("keepCount")) + return WorkspacesTruncateSummariesRequest(keep_count) def to_dict(self) -> dict: result: dict = {} - result["action"] = to_enum(UIElicitationResponseAction, self.action) - if self.content is not None: - 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) + result["keepCount"] = from_int(self.keep_count) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationSchemaPropertyBoolean: - """Boolean field rendered as a yes/no toggle.""" +class WorkspacesWriteAutopilotObjectiveRequest: + """Autopilot objective file content to persist.""" - type: UIElicitationSchemaPropertyBooleanType - """Type discriminator. Always "boolean".""" + content: str + """Autopilot objective file content.""" - default: bool | None = None - """Default value selected when the form is first shown.""" + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesWriteAutopilotObjectiveRequest': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + return WorkspacesWriteAutopilotObjectiveRequest(content) - description: str | None = None - """Help text describing the field.""" + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + return result - title: str | None = None - """Human-readable label for the field.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesWriteAutopilotObjectiveResult: + """Result of writing the autopilot objective file.""" + + operation: str + """Filesystem operation performed.""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyBoolean': + def from_dict(obj: Any) -> 'WorkspacesWriteAutopilotObjectiveResult': assert isinstance(obj, dict) - type = UIElicitationSchemaPropertyBooleanType(obj.get("type")) - default = from_union([from_bool, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationSchemaPropertyBoolean(type, default, description, title) + operation = from_str(obj.get("operation")) + return WorkspacesWriteAutopilotObjectiveResult(operation) def to_dict(self) -> dict: result: dict = {} - result["type"] = to_enum(UIElicitationSchemaPropertyBooleanType, self.type) - if self.default is not None: - result["default"] = from_union([from_bool, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["operation"] = from_str(self.operation) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationSchemaPropertyNumber: - """Numeric field accepting either a number or an integer.""" +class SessionAuthStatus: + """Authentication status and account metadata for the session.""" - type: UIElicitationSchemaPropertyNumberType - """Numeric type accepted by the field.""" + is_authenticated: bool + """Whether the session has resolved authentication""" - default: float | None = None - """Default value populated in the input when the form is first shown.""" + auth_type: AuthInfoType | None = None + """Authentication type""" - description: str | None = None - """Help text describing the field.""" + copilot_plan: str | None = None + """Copilot plan tier (e.g., individual_pro, business)""" - maximum: float | None = None - """Maximum allowed value (inclusive).""" + host: str | None = None + """Authentication host URL""" - minimum: float | None = None - """Minimum allowed value (inclusive).""" + login: str | None = None + """Authenticated login/username, if available""" - title: str | None = None - """Human-readable label for the field.""" + status_message: str | None = None + """Human-readable authentication status description""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyNumber': + def from_dict(obj: Any) -> 'SessionAuthStatus': assert isinstance(obj, dict) - type = UIElicitationSchemaPropertyNumberType(obj.get("type")) - default = from_union([from_float, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - maximum = from_union([from_float, from_none], obj.get("maximum")) - minimum = from_union([from_float, from_none], obj.get("minimum")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationSchemaPropertyNumber(type, default, description, maximum, minimum, title) + is_authenticated = from_bool(obj.get("isAuthenticated")) + auth_type = from_union([AuthInfoType, from_none], obj.get("authType")) + copilot_plan = from_union([from_str, from_none], obj.get("copilotPlan")) + host = from_union([from_str, from_none], obj.get("host")) + login = from_union([from_str, from_none], obj.get("login")) + status_message = from_union([from_str, from_none], obj.get("statusMessage")) + return SessionAuthStatus(is_authenticated, auth_type, copilot_plan, host, login, status_message) def to_dict(self) -> dict: result: dict = {} - result["type"] = to_enum(UIElicitationSchemaPropertyNumberType, self.type) - if self.default is not None: - result["default"] = from_union([to_float, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.maximum is not None: - result["maximum"] = from_union([to_float, from_none], self.maximum) - if self.minimum is not None: - result["minimum"] = from_union([to_float, from_none], self.minimum) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["isAuthenticated"] = from_bool(self.is_authenticated) + if self.auth_type is not None: + result["authType"] = from_union([lambda x: to_enum(AuthInfoType, x), from_none], self.auth_type) + if self.copilot_plan is not None: + result["copilotPlan"] = from_union([from_str, from_none], self.copilot_plan) + if self.host is not None: + result["host"] = from_union([from_str, from_none], self.host) + if self.login is not None: + result["login"] = from_union([from_str, from_none], self.login) + if self.status_message is not None: + result["statusMessage"] = from_union([from_str, from_none], self.status_message) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIExitPlanModeResponse: - """Schema for the `UIExitPlanModeResponse` type.""" - - approved: bool - """Whether the plan was approved.""" - - auto_approve_edits: bool | None = None - """Whether subsequent edits should be auto-approved without confirmation.""" - - feedback: str | None = None - """Feedback from the user when they declined the plan or requested changes.""" +class AccountGetQuotaResult: + """Quota usage snapshots for the resolved user, keyed by quota type.""" - selected_action: UIExitPlanModeAction | None = None - """The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, - otherwise 'interactive'. - """ + quota_snapshots: dict[str, AccountQuotaSnapshot] + """Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)""" @staticmethod - def from_dict(obj: Any) -> 'UIExitPlanModeResponse': + def from_dict(obj: Any) -> 'AccountGetQuotaResult': assert isinstance(obj, dict) - approved = from_bool(obj.get("approved")) - auto_approve_edits = from_union([from_bool, from_none], obj.get("autoApproveEdits")) - feedback = from_union([from_str, from_none], obj.get("feedback")) - selected_action = from_union([UIExitPlanModeAction, from_none], obj.get("selectedAction")) - return UIExitPlanModeResponse(approved, auto_approve_edits, feedback, selected_action) + quota_snapshots = from_dict(AccountQuotaSnapshot.from_dict, obj.get("quotaSnapshots")) + return AccountGetQuotaResult(quota_snapshots) def to_dict(self) -> dict: result: dict = {} - result["approved"] = from_bool(self.approved) - if self.auto_approve_edits is not None: - result["autoApproveEdits"] = from_union([from_bool, from_none], self.auto_approve_edits) - if self.feedback is not None: - result["feedback"] = from_union([from_str, from_none], self.feedback) - if self.selected_action is not None: - result["selectedAction"] = from_union([lambda x: to_enum(UIExitPlanModeAction, x), from_none], self.selected_action) + result["quotaSnapshots"] = from_dict(lambda x: to_class(AccountQuotaSnapshot, x), self.quota_snapshots) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingUserInputRequest: - """Request ID of a pending `user_input.requested` event and the user's response.""" +class ModelCapabilitiesSupports: + """Feature flags indicating what the model supports""" - request_id: str - """The unique request ID from the user_input.requested event""" + adaptive_thinking: AdaptiveThinkingSupport | None = None + """Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. + 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + """ + reasoning_effort: bool | None = None + """Whether this model supports reasoning effort configuration""" - response: UIUserInputResponse - """Schema for the `UIUserInputResponse` type.""" + vision: bool | None = None + """Whether this model supports vision/image input""" @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingUserInputRequest': + def from_dict(obj: Any) -> 'ModelCapabilitiesSupports': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - response = UIUserInputResponse.from_dict(obj.get("response")) - return UIHandlePendingUserInputRequest(request_id, response) + adaptive_thinking = from_union([AdaptiveThinkingSupport, from_none], obj.get("adaptive_thinking")) + reasoning_effort = from_union([from_bool, from_none], obj.get("reasoningEffort")) + vision = from_union([from_bool, from_none], obj.get("vision")) + return ModelCapabilitiesSupports(adaptive_thinking, reasoning_effort, vision) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - result["response"] = to_class(UIUserInputResponse, self.response) + if self.adaptive_thinking is not None: + result["adaptive_thinking"] = from_union([lambda x: to_enum(AdaptiveThinkingSupport, x), from_none], self.adaptive_thinking) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_bool, from_none], self.reasoning_effort) + if self.vision is not None: + result["vision"] = from_union([from_bool, from_none], self.vision) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageMetricsModelMetric: - """Schema for the `UsageMetricsModelMetric` type.""" - - requests: UsageMetricsModelMetricRequests - """Request count and cost metrics for this model""" - - usage: UsageMetricsModelMetricUsage - """Token usage metrics for this model""" +class ModelCapabilitiesOverrideSupports: + """Feature flags indicating what the model supports""" - token_details: dict[str, UsageMetricsModelMetricTokenDetail] | None = None - """Token count details per type""" + adaptive_thinking: AdaptiveThinkingSupport | None = None + """Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. + 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + """ + reasoning_effort: bool | None = None + """Whether this model supports reasoning effort configuration""" - total_nano_aiu: float | None = None - """Accumulated nano-AI units cost for this model""" + vision: bool | None = None + """Whether this model supports vision/image input""" @staticmethod - def from_dict(obj: Any) -> 'UsageMetricsModelMetric': + def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideSupports': assert isinstance(obj, dict) - requests = UsageMetricsModelMetricRequests.from_dict(obj.get("requests")) - usage = UsageMetricsModelMetricUsage.from_dict(obj.get("usage")) - token_details = from_union([lambda x: from_dict(UsageMetricsModelMetricTokenDetail.from_dict, x), from_none], obj.get("tokenDetails")) - total_nano_aiu = from_union([from_float, from_none], obj.get("totalNanoAiu")) - return UsageMetricsModelMetric(requests, usage, token_details, total_nano_aiu) + adaptive_thinking = from_union([AdaptiveThinkingSupport, from_none], obj.get("adaptive_thinking")) + reasoning_effort = from_union([from_bool, from_none], obj.get("reasoningEffort")) + vision = from_union([from_bool, from_none], obj.get("vision")) + return ModelCapabilitiesOverrideSupports(adaptive_thinking, reasoning_effort, vision) def to_dict(self) -> dict: result: dict = {} - result["requests"] = to_class(UsageMetricsModelMetricRequests, self.requests) - result["usage"] = to_class(UsageMetricsModelMetricUsage, self.usage) - if self.token_details is not None: - result["tokenDetails"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsModelMetricTokenDetail, x), x), from_none], self.token_details) - if self.total_nano_aiu is not None: - result["totalNanoAiu"] = from_union([to_float, from_none], self.total_nano_aiu) + if self.adaptive_thinking is not None: + result["adaptive_thinking"] = from_union([lambda x: to_enum(AdaptiveThinkingSupport, x), from_none], self.adaptive_thinking) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_bool, from_none], self.reasoning_effort) + if self.vision is not None: + result["vision"] = from_union([from_bool, from_none], self.vision) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspaceDiffFileChange: - """A single changed file and its unified diff.""" - - change_type: WorkspaceDiffFileChangeType - """Type of change represented by this file diff.""" - - diff: str - """Unified diff content for the file. Empty when the diff was truncated.""" - +class AgentDiscoveryPath: + """Canonical directory where custom agents can be discovered or created, with scope, + preference, and optional project path. + """ path: str - """Path to the changed file, relative to the workspace root.""" + """Absolute path of the search/create directory (may not exist on disk yet)""" - is_truncated: bool | None = None - """Whether the diff content was omitted because it exceeded the per-file size limit.""" + preferred_for_creation: bool + """Whether this is the canonical directory to create a new agent in its tier. At most one + entry per tier is preferred. + """ + scope: AgentDiscoveryPathScope + """Which tier this directory belongs to""" - old_path: str | None = None - """Original file path for renamed files.""" + project_path: str | None = None + """The input project path this directory was derived from (only for project scope)""" @staticmethod - def from_dict(obj: Any) -> 'WorkspaceDiffFileChange': + def from_dict(obj: Any) -> 'AgentDiscoveryPath': assert isinstance(obj, dict) - change_type = WorkspaceDiffFileChangeType(obj.get("changeType")) - diff = from_str(obj.get("diff")) path = from_str(obj.get("path")) - is_truncated = from_union([from_bool, from_none], obj.get("isTruncated")) - old_path = from_union([from_str, from_none], obj.get("oldPath")) - return WorkspaceDiffFileChange(change_type, diff, path, is_truncated, old_path) + preferred_for_creation = from_bool(obj.get("preferredForCreation")) + scope = AgentDiscoveryPathScope(obj.get("scope")) + project_path = from_union([from_str, from_none], obj.get("projectPath")) + return AgentDiscoveryPath(path, preferred_for_creation, scope, project_path) def to_dict(self) -> dict: result: dict = {} - result["changeType"] = to_enum(WorkspaceDiffFileChangeType, self.change_type) - result["diff"] = from_str(self.diff) result["path"] = from_str(self.path) - if self.is_truncated is not None: - result["isTruncated"] = from_union([from_bool, from_none], self.is_truncated) - if self.old_path is not None: - result["oldPath"] = from_union([from_str, from_none], self.old_path) + result["preferredForCreation"] = from_bool(self.preferred_for_creation) + result["scope"] = to_enum(AgentDiscoveryPathScope, self.scope) + if self.project_path is not None: + result["projectPath"] = from_union([from_str, from_none], self.project_path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesDiffRequest: - """Parameters for computing a workspace diff.""" +class AgentRegistryLogCapture: + """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" - mode: WorkspaceDiffMode - """Diff mode requested by the client.""" + enabled: bool + """Whether per-spawn log capture is on (false when env-disabled or open failed)""" + + open_error: str | None = None + """Human-readable open failure message (only set when enabled === false AND the env-disable + opt-out was NOT used) + """ + open_error_reason: AgentRegistryLogCaptureOpenErrorReason | None = None + """Categorized reason for log-open failure""" + + path: str | None = None + """Absolute path to the per-spawn log file (only set when enabled)""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesDiffRequest': + def from_dict(obj: Any) -> 'AgentRegistryLogCapture': assert isinstance(obj, dict) - mode = WorkspaceDiffMode(obj.get("mode")) - return WorkspacesDiffRequest(mode) + enabled = from_bool(obj.get("enabled")) + open_error = from_union([from_str, from_none], obj.get("openError")) + open_error_reason = from_union([AgentRegistryLogCaptureOpenErrorReason, from_none], obj.get("openErrorReason")) + path = from_union([from_str, from_none], obj.get("path")) + return AgentRegistryLogCapture(enabled, open_error, open_error_reason, path) def to_dict(self) -> dict: result: dict = {} - result["mode"] = to_enum(WorkspaceDiffMode, self.mode) + result["enabled"] = from_bool(self.enabled) + if self.open_error is not None: + result["openError"] = from_union([from_str, from_none], self.open_error) + if self.open_error_reason is not None: + result["openErrorReason"] = from_union([lambda x: to_enum(AgentRegistryLogCaptureOpenErrorReason, x), from_none], self.open_error_reason) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesSaveLargePasteResult: - """Descriptor for the saved paste file, or null when the workspace is unavailable.""" +class AgentRegistrySpawnError: + """`child_process.spawn` itself failed before the child entered the registry.""" - saved: Saved | None = None - """Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, - non-infinite sessions, remote sessions) - """ + kind: ClassVar[str] = "spawn-error" + """Discriminator: child_process.spawn itself failed""" + + message: str + """Human-readable error message""" + + code: str | None = None + """Underlying errno code (e.g. ENOENT, EACCES) when available""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesSaveLargePasteResult': + def from_dict(obj: Any) -> 'AgentRegistrySpawnError': assert isinstance(obj, dict) - saved = from_union([Saved.from_dict, from_none], obj.get("saved")) - return WorkspacesSaveLargePasteResult(saved) + message = from_str(obj.get("message")) + code = from_union([from_str, from_none], obj.get("code")) + return AgentRegistrySpawnError(message, code) def to_dict(self) -> dict: result: dict = {} - result["saved"] = from_union([lambda x: to_class(Saved, x), from_none], self.saved) + result["kind"] = self.kind + result["message"] = from_str(self.message) + if self.code is not None: + result["code"] = from_union([from_str, from_none], self.code) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistrySpawnRegistryTimeout: - """Spawn succeeded but the child did not publish a matching managed-server entry within the - timeout. - """ - child_pid: int - """Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance)""" +class AgentRegistrySpawnValidationError: + """Synchronous pre-validation rejected the spawn request.""" - kind: ClassVar[str] = "registry-timeout" - """Discriminator: spawn succeeded but child never registered""" + kind: ClassVar[str] = "validation-error" + """Discriminator: synchronous pre-validation rejected the request""" - log_capture: AgentRegistryLogCapture | None = None - """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" + message: str + """Human-readable explanation; safe to surface in the UI banner. Never logged to + unrestricted telemetry. + """ + reason: AgentRegistrySpawnValidationErrorReason + """Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by + reason without leaking raw paths or agent/model names. + """ + field: AgentRegistrySpawnValidationErrorField | None = None + """Which parameter field was invalid. Omitted when the rejection is not field-specific.""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistrySpawnRegistryTimeout': + def from_dict(obj: Any) -> 'AgentRegistrySpawnValidationError': assert isinstance(obj, dict) - child_pid = from_int(obj.get("childPid")) - log_capture = from_union([AgentRegistryLogCapture.from_dict, from_none], obj.get("logCapture")) - return AgentRegistrySpawnRegistryTimeout(child_pid, log_capture) + message = from_str(obj.get("message")) + reason = AgentRegistrySpawnValidationErrorReason(obj.get("reason")) + field = from_union([AgentRegistrySpawnValidationErrorField, from_none], obj.get("field")) + return AgentRegistrySpawnValidationError(message, reason, field) def to_dict(self) -> dict: result: dict = {} - result["childPid"] = from_int(self.child_pid) result["kind"] = self.kind - if self.log_capture is not None: - result["logCapture"] = from_union([lambda x: to_class(AgentRegistryLogCapture, x), from_none], self.log_capture) + result["message"] = from_str(self.message) + result["reason"] = to_enum(AgentRegistrySpawnValidationErrorReason, self.reason) + if self.field is not None: + result["field"] = from_union([lambda x: to_enum(AgentRegistrySpawnValidationErrorField, x), from_none], self.field) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasList: - """Declared canvases available in this session.""" +class AllowAllPermissionSetResult: + """Indicates whether the operation succeeded and reports the post-mutation state.""" - canvases: list[DiscoveredCanvas] - """Declared canvases available in this session""" + enabled: bool + """Authoritative full allow-all state after the mutation""" + + success: bool + """Whether the operation succeeded""" + + mode: PermissionsAllowAllMode | None = None + """Authoritative allow-all mode after the mutation""" @staticmethod - def from_dict(obj: Any) -> 'CanvasList': + def from_dict(obj: Any) -> 'AllowAllPermissionSetResult': assert isinstance(obj, dict) - canvases = from_list(DiscoveredCanvas.from_dict, obj.get("canvases")) - return CanvasList(canvases) + enabled = from_bool(obj.get("enabled")) + success = from_bool(obj.get("success")) + mode = from_union([PermissionsAllowAllMode, from_none], obj.get("mode")) + return AllowAllPermissionSetResult(enabled, success, mode) def to_dict(self) -> dict: result: dict = {} - result["canvases"] = from_list(lambda x: to_class(DiscoveredCanvas, x), self.canvases) + result["enabled"] = from_bool(self.enabled) + result["success"] = from_bool(self.success) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(PermissionsAllowAllMode, x), from_none], self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasListOpenResult: - """Live open-canvas snapshot.""" +class AllowAllPermissionState: + """Current allow-all permission mode.""" - open_canvases: list[OpenCanvasInstance] - """Currently open canvas instances""" + enabled: bool + """Whether full allow-all permissions are currently active""" + + mode: PermissionsAllowAllMode | None = None + """Current allow-all mode""" @staticmethod - def from_dict(obj: Any) -> 'CanvasListOpenResult': + def from_dict(obj: Any) -> 'AllowAllPermissionState': assert isinstance(obj, dict) - open_canvases = from_list(OpenCanvasInstance.from_dict, obj.get("openCanvases")) - return CanvasListOpenResult(open_canvases) + enabled = from_bool(obj.get("enabled")) + mode = from_union([PermissionsAllowAllMode, from_none], obj.get("mode")) + return AllowAllPermissionState(enabled, mode) def to_dict(self) -> dict: result: dict = {} - result["openCanvases"] = from_list(lambda x: to_class(OpenCanvasInstance, x), self.open_canvases) + result["enabled"] = from_bool(self.enabled) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(PermissionsAllowAllMode, x), from_none], self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SlashCommandInfo: - """Schema for the `SlashCommandInfo` type.""" - - allow_during_agent_execution: bool - """Whether the command may run while an agent turn is active""" +class SlashCommandInput: + """Optional unstructured input hint""" - description: str - """Human-readable command description""" + hint: str + """Hint to display when command input has not been provided""" - kind: SlashCommandKind - """Coarse command category for grouping and behavior: runtime built-in, skill-backed - command, or SDK/client-owned command + choices: list[SlashCommandInputChoice] | None = None + """Optional literal choices the input accepts, each with a human-facing description; clients + may render these as selectable options """ - name: str - """Canonical command name without a leading slash""" - - aliases: list[str] | None = None - """Canonical aliases without leading slashes""" - - experimental: bool | None = None - """Whether the command is experimental""" + completion: SlashCommandInputCompletion | None = None + """Optional completion hint for the input (e.g. 'directory' for filesystem path completion)""" - input: SlashCommandInput | None = None - """Optional unstructured input hint""" + preserve_multiline_input: bool | None = None + """When true, clients should pass the full text after the command name as a single argument + rather than splitting on whitespace + """ + required: bool | None = None + """When true, the command requires non-empty input; clients should render the input hint as + required + """ @staticmethod - def from_dict(obj: Any) -> 'SlashCommandInfo': + def from_dict(obj: Any) -> 'SlashCommandInput': assert isinstance(obj, dict) - allow_during_agent_execution = from_bool(obj.get("allowDuringAgentExecution")) - description = from_str(obj.get("description")) - kind = SlashCommandKind(obj.get("kind")) - name = from_str(obj.get("name")) - aliases = from_union([lambda x: from_list(from_str, x), from_none], obj.get("aliases")) - experimental = from_union([from_bool, from_none], obj.get("experimental")) - input = from_union([SlashCommandInput.from_dict, from_none], obj.get("input")) - return SlashCommandInfo(allow_during_agent_execution, description, kind, name, aliases, experimental, input) + hint = from_str(obj.get("hint")) + choices = from_union([lambda x: from_list(SlashCommandInputChoice.from_dict, x), from_none], obj.get("choices")) + completion = from_union([SlashCommandInputCompletion, from_none], obj.get("completion")) + preserve_multiline_input = from_union([from_bool, from_none], obj.get("preserveMultilineInput")) + required = from_union([from_bool, from_none], obj.get("required")) + return SlashCommandInput(hint, choices, completion, preserve_multiline_input, required) def to_dict(self) -> dict: result: dict = {} - result["allowDuringAgentExecution"] = from_bool(self.allow_during_agent_execution) - result["description"] = from_str(self.description) - result["kind"] = to_enum(SlashCommandKind, self.kind) - result["name"] = from_str(self.name) - if self.aliases is not None: - result["aliases"] = from_union([lambda x: from_list(from_str, x), from_none], self.aliases) - if self.experimental is not None: - result["experimental"] = from_union([from_bool, from_none], self.experimental) - if self.input is not None: - result["input"] = from_union([lambda x: to_class(SlashCommandInput, x), from_none], self.input) + result["hint"] = from_str(self.hint) + if self.choices is not None: + result["choices"] = from_union([lambda x: from_list(lambda x: to_class(SlashCommandInputChoice, x), x), from_none], self.choices) + if self.completion is not None: + result["completion"] = from_union([lambda x: to_enum(SlashCommandInputCompletion, x), from_none], self.completion) + if self.preserve_multiline_input is not None: + result["preserveMultilineInput"] = from_union([from_bool, from_none], self.preserve_multiline_input) + if self.required is not None: + result["required"] = from_union([from_bool, from_none], self.required) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class RemoteSessionConnectionResult: - """Remote session connection result.""" +class PushAttachmentDirectory: + """Directory attachment""" - metadata: ConnectedRemoteSessionMetadata - """Metadata for a connected remote session.""" + display_name: str + """User-facing display name for the attachment""" - session_id: str - """SDK session ID for the connected remote session.""" + path: str + """Absolute directory path""" + + type: ClassVar[str] = "directory" + """Attachment type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'RemoteSessionConnectionResult': + def from_dict(obj: Any) -> 'PushAttachmentDirectory': assert isinstance(obj, dict) - metadata = ConnectedRemoteSessionMetadata.from_dict(obj.get("metadata")) - session_id = from_str(obj.get("sessionId")) - return RemoteSessionConnectionResult(metadata, session_id) + display_name = from_str(obj.get("displayName")) + path = from_str(obj.get("path")) + return PushAttachmentDirectory(display_name, path) def to_dict(self) -> dict: result: dict = {} - result["metadata"] = to_class(ConnectedRemoteSessionMetadata, self.metadata) - result["sessionId"] = from_str(self.session_id) + result["displayName"] = from_str(self.display_name) + result["path"] = from_str(self.path) + result["type"] = self.type return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasHostContext: - """Host context supplied by the runtime.""" +class ConnectedRemoteSessionMetadata: + """Metadata for a connected remote session.""" - capabilities: CanvasHostContextCapabilities | None = None - """Host capabilities""" + kind: ConnectedRemoteSessionMetadataKind + """Neutral SDK discriminator for the connected remote session kind.""" - @staticmethod - def from_dict(obj: Any) -> 'CanvasHostContext': - assert isinstance(obj, dict) - capabilities = from_union([CanvasHostContextCapabilities.from_dict, from_none], obj.get("capabilities")) - return CanvasHostContext(capabilities) + modified_time: datetime + """Last session update time as an ISO 8601 string.""" - def to_dict(self) -> dict: - result: dict = {} - if self.capabilities is not None: - result["capabilities"] = from_union([lambda x: to_class(CanvasHostContextCapabilities, x), from_none], self.capabilities) - return result + repository: ConnectedRemoteSessionMetadataRepository + """Repository associated with the connected remote session.""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class CopilotUserResponse: - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ - access_type_sku: str | None = None - analytics_tracking_id: str | None = None - assigned_date: Any = None - can_signup_for_limited: bool | None = None - chat_enabled: bool | None = None - cli_remote_control_enabled: bool | None = None - cloud_session_storage_enabled: bool | None = None - codex_agent_enabled: bool | None = None - copilot_plan: str | None = None - copilotignore_enabled: bool | None = None - endpoints: CopilotUserResponseEndpoints | None = None - """Schema for the `CopilotUserResponseEndpoints` type.""" + session_id: str + """SDK session ID for the connected remote session.""" - is_mcp_enabled: Any = None - limited_user_quotas: dict[str, float] | None = None - limited_user_reset_date: str | None = None - login: str | None = None - monthly_quotas: dict[str, float] | None = None - organization_list: Any = None - organization_login_list: list[str] | None = None - quota_reset_date: str | None = None - quota_reset_date_utc: str | None = None - quota_snapshots: dict[str, CopilotUserResponseQuotaSnapshots | None] | None = None - """Schema for the `CopilotUserResponseQuotaSnapshots` type.""" + start_time: datetime + """Session start time as an ISO 8601 string.""" - restricted_telemetry: bool | None = None - token_based_billing: bool | None = None + name: str | None = None + """Optional friendly session name.""" + + pull_request_number: int | None = None + """Pull request number associated with the session.""" + + resource_id: str | None = None + """Original remote resource identifier.""" + + stale_at: datetime | None = None + """Remote session staleness deadline as an ISO 8601 string.""" + + state: str | None = None + """Remote session state returned by the backing service.""" + + summary: str | None = None + """Optional session summary.""" @staticmethod - def from_dict(obj: Any) -> 'CopilotUserResponse': + def from_dict(obj: Any) -> 'ConnectedRemoteSessionMetadata': assert isinstance(obj, dict) - access_type_sku = from_union([from_str, from_none], obj.get("access_type_sku")) - analytics_tracking_id = from_union([from_str, from_none], obj.get("analytics_tracking_id")) - assigned_date = obj.get("assigned_date") - can_signup_for_limited = from_union([from_bool, from_none], obj.get("can_signup_for_limited")) - chat_enabled = from_union([from_bool, from_none], obj.get("chat_enabled")) - cli_remote_control_enabled = from_union([from_bool, from_none], obj.get("cli_remote_control_enabled")) - cloud_session_storage_enabled = from_union([from_bool, from_none], obj.get("cloud_session_storage_enabled")) - codex_agent_enabled = from_union([from_bool, from_none], obj.get("codex_agent_enabled")) - copilot_plan = from_union([from_str, from_none], obj.get("copilot_plan")) - copilotignore_enabled = from_union([from_bool, from_none], obj.get("copilotignore_enabled")) - endpoints = from_union([CopilotUserResponseEndpoints.from_dict, from_none], obj.get("endpoints")) - is_mcp_enabled = obj.get("is_mcp_enabled") - limited_user_quotas = from_union([lambda x: from_dict(from_float, x), from_none], obj.get("limited_user_quotas")) - limited_user_reset_date = from_union([from_str, from_none], obj.get("limited_user_reset_date")) - login = from_union([from_str, from_none], obj.get("login")) - monthly_quotas = from_union([lambda x: from_dict(from_float, x), from_none], obj.get("monthly_quotas")) - organization_list = obj.get("organization_list") - organization_login_list = from_union([lambda x: from_list(from_str, x), from_none], obj.get("organization_login_list")) - quota_reset_date = from_union([from_str, from_none], obj.get("quota_reset_date")) - quota_reset_date_utc = from_union([from_str, from_none], obj.get("quota_reset_date_utc")) - quota_snapshots = from_union([lambda x: from_dict(lambda x: from_union([CopilotUserResponseQuotaSnapshots.from_dict, from_none], x), x), from_none], obj.get("quota_snapshots")) - restricted_telemetry = from_union([from_bool, from_none], obj.get("restricted_telemetry")) - token_based_billing = from_union([from_bool, from_none], obj.get("token_based_billing")) - return CopilotUserResponse(access_type_sku, analytics_tracking_id, assigned_date, can_signup_for_limited, chat_enabled, cli_remote_control_enabled, cloud_session_storage_enabled, codex_agent_enabled, copilot_plan, copilotignore_enabled, endpoints, is_mcp_enabled, limited_user_quotas, limited_user_reset_date, login, monthly_quotas, organization_list, organization_login_list, quota_reset_date, quota_reset_date_utc, quota_snapshots, restricted_telemetry, token_based_billing) + kind = ConnectedRemoteSessionMetadataKind(obj.get("kind")) + modified_time = from_datetime(obj.get("modifiedTime")) + repository = ConnectedRemoteSessionMetadataRepository.from_dict(obj.get("repository")) + session_id = from_str(obj.get("sessionId")) + start_time = from_datetime(obj.get("startTime")) + name = from_union([from_str, from_none], obj.get("name")) + pull_request_number = from_union([from_int, from_none], obj.get("pullRequestNumber")) + resource_id = from_union([from_str, from_none], obj.get("resourceId")) + stale_at = from_union([from_datetime, from_none], obj.get("staleAt")) + state = from_union([from_str, from_none], obj.get("state")) + summary = from_union([from_str, from_none], obj.get("summary")) + return ConnectedRemoteSessionMetadata(kind, modified_time, repository, session_id, start_time, name, pull_request_number, resource_id, stale_at, state, summary) def to_dict(self) -> dict: result: dict = {} - if self.access_type_sku is not None: - result["access_type_sku"] = from_union([from_str, from_none], self.access_type_sku) - if self.analytics_tracking_id is not None: - result["analytics_tracking_id"] = from_union([from_str, from_none], self.analytics_tracking_id) - if self.assigned_date is not None: - result["assigned_date"] = self.assigned_date - if self.can_signup_for_limited is not None: - result["can_signup_for_limited"] = from_union([from_bool, from_none], self.can_signup_for_limited) - if self.chat_enabled is not None: - result["chat_enabled"] = from_union([from_bool, from_none], self.chat_enabled) - if self.cli_remote_control_enabled is not None: - result["cli_remote_control_enabled"] = from_union([from_bool, from_none], self.cli_remote_control_enabled) - if self.cloud_session_storage_enabled is not None: - result["cloud_session_storage_enabled"] = from_union([from_bool, from_none], self.cloud_session_storage_enabled) - if self.codex_agent_enabled is not None: - result["codex_agent_enabled"] = from_union([from_bool, from_none], self.codex_agent_enabled) - if self.copilot_plan is not None: - result["copilot_plan"] = from_union([from_str, from_none], self.copilot_plan) - if self.copilotignore_enabled is not None: - result["copilotignore_enabled"] = from_union([from_bool, from_none], self.copilotignore_enabled) - if self.endpoints is not None: - result["endpoints"] = from_union([lambda x: to_class(CopilotUserResponseEndpoints, x), from_none], self.endpoints) - if self.is_mcp_enabled is not None: - result["is_mcp_enabled"] = self.is_mcp_enabled - if self.limited_user_quotas is not None: - result["limited_user_quotas"] = from_union([lambda x: from_dict(to_float, x), from_none], self.limited_user_quotas) - if self.limited_user_reset_date is not None: - result["limited_user_reset_date"] = from_union([from_str, from_none], self.limited_user_reset_date) - if self.login is not None: - result["login"] = from_union([from_str, from_none], self.login) - if self.monthly_quotas is not None: - result["monthly_quotas"] = from_union([lambda x: from_dict(to_float, x), from_none], self.monthly_quotas) - if self.organization_list is not None: - result["organization_list"] = self.organization_list - if self.organization_login_list is not None: - result["organization_login_list"] = from_union([lambda x: from_list(from_str, x), from_none], self.organization_login_list) - if self.quota_reset_date is not None: - result["quota_reset_date"] = from_union([from_str, from_none], self.quota_reset_date) - if self.quota_reset_date_utc is not None: - result["quota_reset_date_utc"] = from_union([from_str, from_none], self.quota_reset_date_utc) - if self.quota_snapshots is not None: - result["quota_snapshots"] = from_union([lambda x: from_dict(lambda x: from_union([lambda x: to_class(CopilotUserResponseQuotaSnapshots, x), from_none], x), x), from_none], self.quota_snapshots) - if self.restricted_telemetry is not None: - result["restricted_telemetry"] = from_union([from_bool, from_none], self.restricted_telemetry) - if self.token_based_billing is not None: - result["token_based_billing"] = from_union([from_bool, from_none], self.token_based_billing) + result["kind"] = to_enum(ConnectedRemoteSessionMetadataKind, self.kind) + result["modifiedTime"] = self.modified_time.isoformat() + result["repository"] = to_class(ConnectedRemoteSessionMetadataRepository, self.repository) + result["sessionId"] = from_str(self.session_id) + result["startTime"] = self.start_time.isoformat() + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.pull_request_number is not None: + result["pullRequestNumber"] = from_union([from_int, from_none], self.pull_request_number) + if self.resource_id is not None: + result["resourceId"] = from_union([from_str, from_none], self.resource_id) + if self.stale_at is not None: + result["staleAt"] = from_union([lambda x: x.isoformat(), from_none], self.stale_at) + if self.state is not None: + result["state"] = from_union([from_str, from_none], self.state) + if self.summary is not None: + result["summary"] = from_union([from_str, from_none], self.summary) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPDiscoverResult: - """MCP servers discovered from user, workspace, plugin, and built-in sources.""" - - servers: list[DiscoveredMCPServer] - """MCP servers discovered from all sources""" +class ContentExclusionCheckPathsResult: + """Batch content-exclusion result. Callers must fail closed when policy evaluation is + unavailable. + """ + available: bool + """Whether the session's policy service was available for the complete batch. When false, + checks is empty and callers must treat every requested path as excluded. + """ + checks: list[ContentExclusionPathCheck] + """Per-path decisions in request order. Empty when available is false.""" @staticmethod - def from_dict(obj: Any) -> 'MCPDiscoverResult': + def from_dict(obj: Any) -> 'ContentExclusionCheckPathsResult': assert isinstance(obj, dict) - servers = from_list(DiscoveredMCPServer.from_dict, obj.get("servers")) - return MCPDiscoverResult(servers) + available = from_bool(obj.get("available")) + checks = from_list(ContentExclusionPathCheck.from_dict, obj.get("checks")) + return ContentExclusionCheckPathsResult(available, checks) def to_dict(self) -> dict: result: dict = {} - result["servers"] = from_list(lambda x: to_class(DiscoveredMCPServer, x), self.servers) + result["available"] = from_bool(self.available) + result["checks"] = from_list(lambda x: to_class(ContentExclusionPathCheck, x), self.checks) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExtensionList: - """Extensions discovered for the session, with their current status.""" +class MetadataContextHeaviestMessagesResult: + """The heaviest individual messages in the session's context window, most-expensive first.""" - extensions: list[Extension] - """Discovered extensions and their current status""" + messages: list[ContextHeaviestMessage] + """Heaviest messages, most-expensive first.""" + + total_tokens: int + """Total token count of the current context window, so callers can compute each message's + share without a second call. + """ @staticmethod - def from_dict(obj: Any) -> 'ExtensionList': + def from_dict(obj: Any) -> 'MetadataContextHeaviestMessagesResult': assert isinstance(obj, dict) - extensions = from_list(Extension.from_dict, obj.get("extensions")) - return ExtensionList(extensions) + messages = from_list(ContextHeaviestMessage.from_dict, obj.get("messages")) + total_tokens = from_int(obj.get("totalTokens")) + return MetadataContextHeaviestMessagesResult(messages, total_tokens) def to_dict(self) -> dict: result: dict = {} - result["extensions"] = from_list(lambda x: to_class(Extension, x), self.extensions) + result["messages"] = from_list(lambda x: to_class(ContextHeaviestMessage, x), self.messages) + result["totalTokens"] = from_int(self.total_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess: - """Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` - type. - """ - extension_name: str - """Extension name.""" +class CanvasHostContextCapabilities: + """Host capabilities""" - kind: ClassVar[str] = "extension-permission-access" - """Approval covering an extension's request to access a permission-gated capability.""" + canvases: bool | None = None + """Whether canvas rendering is supported""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess': + def from_dict(obj: Any) -> 'CanvasHostContextCapabilities': assert isinstance(obj, dict) - extension_name = from_str(obj.get("extensionName")) - return PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess(extension_name) + canvases = from_union([from_bool, from_none], obj.get("canvases")) + return CanvasHostContextCapabilities(canvases) def to_dict(self) -> dict: result: dict = {} - result["extensionName"] = from_str(self.extension_name) - result["kind"] = self.kind + if self.canvases is not None: + result["canvases"] = from_union([from_bool, from_none], self.canvases) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess: - """Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` - type. - """ - extension_name: str - """Extension name.""" +class DiscoveredCanvas: + """Canvas available in the current session.""" - kind: ClassVar[str] = "extension-permission-access" - """Approval covering an extension's request to access a permission-gated capability.""" + canvas_id: str + """Provider-local canvas identifier""" - @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess': - assert isinstance(obj, dict) - extension_name = from_str(obj.get("extensionName")) - return PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess(extension_name) + description: str + """Short, single-sentence description shown to the agent in canvas catalogs.""" - def to_dict(self) -> dict: - result: dict = {} - result["extensionName"] = from_str(self.extension_name) - result["kind"] = self.kind - return result + display_name: str + """Human-readable canvas name""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess: - """Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess` type.""" + extension_id: str + """Owning provider identifier""" - extension_name: str - """Extension name.""" + actions: list[CanvasAction] | None = None + """Actions the agent or host may invoke on an open instance""" - kind: ClassVar[str] = "extension-permission-access" - """Approval covering an extension's request to access a permission-gated capability.""" + extension_name: str | None = None + """Owning extension display name, when available""" + + icon: str | None = None + """Host-local PNG path for the canvas icon, when supplied""" + + input_schema: Any = None + """JSON Schema for canvas open input""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess': + def from_dict(obj: Any) -> 'DiscoveredCanvas': assert isinstance(obj, dict) - extension_name = from_str(obj.get("extensionName")) - return PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess(extension_name) + canvas_id = from_str(obj.get("canvasId")) + description = from_str(obj.get("description")) + display_name = from_str(obj.get("displayName")) + extension_id = from_str(obj.get("extensionId")) + actions = from_union([lambda x: from_list(CanvasAction.from_dict, x), from_none], obj.get("actions")) + extension_name = from_union([from_str, from_none], obj.get("extensionName")) + icon = from_union([from_str, from_none], obj.get("icon")) + input_schema = obj.get("inputSchema") + return DiscoveredCanvas(canvas_id, description, display_name, extension_id, actions, extension_name, icon, input_schema) def to_dict(self) -> dict: result: dict = {} - result["extensionName"] = from_str(self.extension_name) - result["kind"] = self.kind + result["canvasId"] = from_str(self.canvas_id) + result["description"] = from_str(self.description) + result["displayName"] = from_str(self.display_name) + result["extensionId"] = from_str(self.extension_id) + if self.actions is not None: + result["actions"] = from_union([lambda x: from_list(lambda x: to_class(CanvasAction, x), x), from_none], self.actions) + if self.extension_name is not None: + result["extensionName"] = from_union([from_str, from_none], self.extension_name) + if self.icon is not None: + result["icon"] = from_union([from_str, from_none], self.icon) + if self.input_schema is not None: + result["inputSchema"] = self.input_schema return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlm: - """Expanded external tool result payload""" +class OpenCanvasInstance: + """Open canvas instance snapshot.""" - text_result_for_llm: str - """Text result returned to the model""" + canvas_id: str + """Provider-local canvas identifier""" - binary_results_for_llm: list[ExternalToolTextResultForLlmBinaryResultsForLlm] | None = None - """Base64-encoded binary results returned to the model""" + extension_id: str + """Owning provider identifier""" - contents: list[ExternalToolTextResultForLlmContent] | None = None - """Structured content blocks from the tool""" + instance_id: str + """Stable caller-supplied canvas instance identifier""" - error: str | None = None - """Optional error message for failed executions""" + extension_name: str | None = None + """Owning extension display name, when available""" - result_type: str | None = None - """Execution outcome classification. Optional for back-compat; normalized to 'success' (or - 'failure' when error is present) when missing or unrecognized. - """ - session_log: str | None = None - """Detailed log content for timeline display""" + icon: str | None = None + """Host-local PNG path for the canvas icon, when supplied""" - tool_telemetry: dict[str, Any] | None = None - """Optional tool-specific telemetry""" + input: Any = None + """Input supplied when the instance was opened""" + + status: str | None = None + """Provider-supplied status text""" + + title: str | None = None + """Rendered title""" + + url: str | None = None + """URL for web-rendered canvases""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlm': + def from_dict(obj: Any) -> 'OpenCanvasInstance': assert isinstance(obj, dict) - text_result_for_llm = from_str(obj.get("textResultForLlm")) - binary_results_for_llm = from_union([lambda x: from_list(ExternalToolTextResultForLlmBinaryResultsForLlm.from_dict, x), from_none], obj.get("binaryResultsForLlm")) - contents = from_union([lambda x: from_list(_load_ExternalToolTextResultForLlmContent, x), from_none], obj.get("contents")) - error = from_union([from_str, from_none], obj.get("error")) - result_type = from_union([from_str, from_none], obj.get("resultType")) - session_log = from_union([from_str, from_none], obj.get("sessionLog")) - tool_telemetry = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("toolTelemetry")) - return ExternalToolTextResultForLlm(text_result_for_llm, binary_results_for_llm, contents, error, result_type, session_log, tool_telemetry) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + extension_name = from_union([from_str, from_none], obj.get("extensionName")) + icon = from_union([from_str, from_none], obj.get("icon")) + input = obj.get("input") + status = from_union([from_str, from_none], obj.get("status")) + title = from_union([from_str, from_none], obj.get("title")) + url = from_union([from_str, from_none], obj.get("url")) + return OpenCanvasInstance(canvas_id, extension_id, instance_id, extension_name, icon, input, status, title, url) def to_dict(self) -> dict: result: dict = {} - result["textResultForLlm"] = from_str(self.text_result_for_llm) - if self.binary_results_for_llm is not None: - result["binaryResultsForLlm"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmBinaryResultsForLlm, x), x), from_none], self.binary_results_for_llm) - if self.contents is not None: - result["contents"] = from_union([lambda x: from_list(lambda x: (x).to_dict(), x), from_none], self.contents) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) - if self.result_type is not None: - result["resultType"] = from_union([from_str, from_none], self.result_type) - if self.session_log is not None: - result["sessionLog"] = from_union([from_str, from_none], self.session_log) - if self.tool_telemetry is not None: - result["toolTelemetry"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.tool_telemetry) + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + if self.extension_name is not None: + result["extensionName"] = from_union([from_str, from_none], self.extension_name) + if self.icon is not None: + result["icon"] = from_union([from_str, from_none], self.icon) + if self.input is not None: + result["input"] = self.input + if self.status is not None: + result["status"] = from_union([from_str, from_none], self.status) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ExternalToolTextResultForLlmContentResourceLink: - """Resource link content block referencing an external resource""" - - name: str - """Resource name identifier""" - - type: ClassVar[str] = "resource_link" - """Content block type discriminator""" +class CompletionsRequestResult: + """Host-driven completion items for the current composer input. Empty when the host returns + no items or does not support completions. + """ + items: list[SessionCompletionItem] + """Completion items in host-ranked order.""" - uri: str - """URI identifying the resource""" + @staticmethod + def from_dict(obj: Any) -> 'CompletionsRequestResult': + assert isinstance(obj, dict) + items = from_list(SessionCompletionItem.from_dict, obj.get("items")) + return CompletionsRequestResult(items) - description: str | None = None - """Human-readable description of the resource""" + def to_dict(self) -> dict: + result: dict = {} + result["items"] = from_list(lambda x: to_class(SessionCompletionItem, x), self.items) + return result - icons: list[ExternalToolTextResultForLlmContentResourceLinkIcon] | None = None - """Icons associated with this resource""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsCollectedEntry: + """A file included in the redacted debug bundle.""" - mime_type: str | None = None - """MIME type of the resource content""" + bundle_path: str + """Relative path of the file in the staged bundle/archive.""" - size: int | None = None - """Size of the resource in bytes""" + size_bytes: int + """Redacted output size in bytes.""" - title: str | None = None - """Human-readable display title for the resource""" + source: DebugCollectLogsSource + """Source category for this entry.""" @staticmethod - def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLink': + def from_dict(obj: Any) -> 'DebugCollectLogsCollectedEntry': assert isinstance(obj, dict) - name = from_str(obj.get("name")) - uri = from_str(obj.get("uri")) - description = from_union([from_str, from_none], obj.get("description")) - icons = from_union([lambda x: from_list(ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict, x), from_none], obj.get("icons")) - mime_type = from_union([from_str, from_none], obj.get("mimeType")) - size = from_union([from_int, from_none], obj.get("size")) - title = from_union([from_str, from_none], obj.get("title")) - return ExternalToolTextResultForLlmContentResourceLink(name, uri, description, icons, mime_type, size, title) + bundle_path = from_str(obj.get("bundlePath")) + size_bytes = from_int(obj.get("sizeBytes")) + source = DebugCollectLogsSource(obj.get("source")) + return DebugCollectLogsCollectedEntry(bundle_path, size_bytes, source) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) - result["type"] = self.type - result["uri"] = from_str(self.uri) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.icons is not None: - result["icons"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, x), x), from_none], self.icons) - if self.mime_type is not None: - result["mimeType"] = from_union([from_str, from_none], self.mime_type) - if self.size is not None: - result["size"] = from_union([from_int, from_none], self.size) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["bundlePath"] = from_str(self.bundle_path) + result["sizeBytes"] = from_int(self.size_bytes) + result["source"] = to_enum(DebugCollectLogsSource, self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstalledPluginSource: - """Schema for the `InstalledPluginSourceGithub` type. - - Schema for the `InstalledPluginSourceUrl` type. +class DebugCollectLogsDestination: + """Destination for the redacted debug bundle. - Schema for the `InstalledPluginSourceLocal` type. + Where the redacted bundle should be written. Use `archive` to produce a .tgz, or + `directory` to stage redacted files for caller-managed upload/post-processing. """ - source: PurpleSource - """Constant value. Always "github". - - Constant value. Always "url". - - Constant value. Always "local". + kind: DebugCollectLogsResultKind + no_overwrite: bool | None = None + """When true, create the archive atomically without overwriting an existing file by + appending ` (N)` before the extension as needed. Defaults to false. """ - path: str | None = None - ref: str | None = None - repo: str | None = None - url: str | None = None + output_path: str | None = None + """Absolute or server-relative path for the .tgz archive to create.""" + + output_directory: str | None = None + """Directory where redacted files should be staged. The directory is created if needed.""" @staticmethod - def from_dict(obj: Any) -> 'InstalledPluginSource': + def from_dict(obj: Any) -> 'DebugCollectLogsDestination': assert isinstance(obj, dict) - source = PurpleSource(obj.get("source")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - repo = from_union([from_str, from_none], obj.get("repo")) - url = from_union([from_str, from_none], obj.get("url")) - return InstalledPluginSource(source, path, ref, repo, url) + kind = DebugCollectLogsResultKind(obj.get("kind")) + no_overwrite = from_union([from_bool, from_none], obj.get("noOverwrite")) + output_path = from_union([from_str, from_none], obj.get("outputPath")) + output_directory = from_union([from_str, from_none], obj.get("outputDirectory")) + return DebugCollectLogsDestination(kind, no_overwrite, output_path, output_directory) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(PurpleSource, self.source) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) - if self.repo is not None: - result["repo"] = from_union([from_str, from_none], self.repo) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + result["kind"] = to_enum(DebugCollectLogsResultKind, self.kind) + if self.no_overwrite is not None: + result["noOverwrite"] = from_union([from_bool, from_none], self.no_overwrite) + if self.output_path is not None: + result["outputPath"] = from_union([from_str, from_none], self.output_path) + if self.output_directory is not None: + result["outputDirectory"] = from_union([from_str, from_none], self.output_directory) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionInstalledPluginSource: - """Schema for the `SessionInstalledPluginSourceGithub` type. - - Schema for the `SessionInstalledPluginSourceUrl` type. +class SessionManagedPermissions: + """Enterprise permission policy expressed with the runtime's managed permission-rule syntax.""" - Schema for the `SessionInstalledPluginSourceLocal` type. + allow: list[str] | None = None + """Permission rules that allow matching operations unless another managed source, deny, or + ask rule restricts them. """ - source: PurpleSource - """Constant value. Always "github". + ask: list[str] | None = None + """Permission rules that require explicit human approval.""" - Constant value. Always "url". + deny: list[str] | None = None + """Permission rules that block matching operations. Deny has highest precedence.""" - Constant value. Always "local". - """ - path: str | None = None - ref: str | None = None - repo: str | None = None - url: str | None = None + disable_bypass_permissions_mode: DisableBypassPermissionsMode | None = None + """When set to `disable`, prevents bypass/allow-all permission modes.""" @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPluginSource': + def from_dict(obj: Any) -> 'SessionManagedPermissions': assert isinstance(obj, dict) - source = PurpleSource(obj.get("source")) - path = from_union([from_str, from_none], obj.get("path")) - ref = from_union([from_str, from_none], obj.get("ref")) - repo = from_union([from_str, from_none], obj.get("repo")) - url = from_union([from_str, from_none], obj.get("url")) - return SessionInstalledPluginSource(source, path, ref, repo, url) + allow = from_union([lambda x: from_list(from_str, x), from_none], obj.get("allow")) + ask = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ask")) + deny = from_union([lambda x: from_list(from_str, x), from_none], obj.get("deny")) + disable_bypass_permissions_mode = from_union([DisableBypassPermissionsMode, from_none], obj.get("disableBypassPermissionsMode")) + return SessionManagedPermissions(allow, ask, deny, disable_bypass_permissions_mode) def to_dict(self) -> dict: result: dict = {} - result["source"] = to_enum(PurpleSource, self.source) - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - if self.ref is not None: - result["ref"] = from_union([from_str, from_none], self.ref) - if self.repo is not None: - result["repo"] = from_union([from_str, from_none], self.repo) - if self.url is not None: - result["url"] = from_union([from_str, from_none], self.url) + if self.allow is not None: + result["allow"] = from_union([lambda x: from_list(from_str, x), from_none], self.allow) + if self.ask is not None: + result["ask"] = from_union([lambda x: from_list(from_str, x), from_none], self.ask) + if self.deny is not None: + result["deny"] = from_union([lambda x: from_list(from_str, x), from_none], self.deny) + if self.disable_bypass_permissions_mode is not None: + result["disableBypassPermissionsMode"] = from_union([lambda x: to_enum(DisableBypassPermissionsMode, x), from_none], self.disable_bypass_permissions_mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstructionsGetSourcesResult: - """Instruction sources loaded for the session, in merge order.""" +class DiscoveredExtension: + """Discovered extension metadata and persistent enablement state.""" - sources: list[InstructionsSources] - """Instruction sources for the session""" + enabled: bool + """Whether this extension's persistent per-ID preference is enabled""" + + id: str + """Source-qualified ID accepted by both server and session extension enablement methods""" + + name: str + """Human-readable extension name""" + + path: str + """Absolute path to the extension entry module, suitable for revealing it in a file manager""" + + source: DiscoveredExtensionSource + """Discovery source""" + + plugin: DiscoveredExtensionPlugin | None = None + """Containing plugin metadata for plugin-contributed extensions""" @staticmethod - def from_dict(obj: Any) -> 'InstructionsGetSourcesResult': + def from_dict(obj: Any) -> 'DiscoveredExtension': assert isinstance(obj, dict) - sources = from_list(InstructionsSources.from_dict, obj.get("sources")) - return InstructionsGetSourcesResult(sources) + enabled = from_bool(obj.get("enabled")) + id = from_str(obj.get("id")) + name = from_str(obj.get("name")) + path = from_str(obj.get("path")) + source = DiscoveredExtensionSource(obj.get("source")) + plugin = from_union([DiscoveredExtensionPlugin.from_dict, from_none], obj.get("plugin")) + return DiscoveredExtension(enabled, id, name, path, source, plugin) def to_dict(self) -> dict: result: dict = {} - result["sources"] = from_list(lambda x: to_class(InstructionsSources, x), self.sources) + result["enabled"] = from_bool(self.enabled) + result["id"] = from_str(self.id) + result["name"] = from_str(self.name) + result["path"] = from_str(self.path) + result["source"] = to_enum(DiscoveredExtensionSource, self.source) + if self.plugin is not None: + result["plugin"] = from_union([lambda x: to_class(DiscoveredExtensionPlugin, x), from_none], self.plugin) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsHostContext: - """Current host context advertised to MCP App guests.""" +class EventLogReadRequest: + """Cursor, batch size, and optional long-poll/filter parameters for reading session events.""" - context: MCPAppsHostContextDetails - """Current host context""" + agent_ids: list[str] | None = None + """Optional non-empty list of subagent identifiers. When provided, only events owned by one + of these agents are returned; ownership recognizes the event envelope's agentId plus + legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over + agentScope. + """ + agent_scope: EventsAgentScope | None = None + """Agent-scope filter: 'primary' returns only main-agent events plus events whose type + starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns + events from all agents (matching wildcard-subscription behavior). Default is 'all' to + preserve wildcard semantics for catch-up callers. + """ + cursor: str | None = None + """Opaque cursor returned by a previous read. Omit on the first call to start from the + beginning of the session's persisted history. + """ + direction: EventsReadDirection | None = None + """Direction to page through the session's persisted event history. 'forward' (default) + pages from the cursor toward newer events (or from the start of history when no cursor is + given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` + events, and the returned cursor pages toward OLDER events on subsequent backward reads. + Events within a returned batch are always in chronological (oldest-to-newest) order, even + for a backward read. Backward reads cover PERSISTED history only; ephemeral events are + never returned by a backward read. `direction` selects the INITIAL read only: the + returned cursor is self-describing, so a continuation read pages in the cursor's own + direction regardless of the `direction` passed alongside it — a forward cursor always + pages forward and a backward cursor always pages backward. Pass the direction that + matches the cursor to avoid confusion. + """ + include_ephemeral: bool | None = None + """When false, skip ephemeral events entirely and return only durable (persisted) events. + History-backfill callers that discard ephemerals anyway should set this so the read is + bounded by the durable log length instead of racing the ephemeral ring on a busy session. + Defaults to true (ephemerals are interleaved with durable events in creation order). + Ignored by backward reads, which always cover persisted history only. + """ + max: int | None = None + """Maximum number of events to return in this batch (1–1000, default 200).""" + + types: list[str] | EventLogTypes | None = None + """Either '*' to receive all event types, or a non-empty list of event types to receive""" + + wait_ms: int | None = None + """Milliseconds to wait for new events when the cursor is at the tail of history. 0 + (default) returns immediately even if no events are available. Capped at 30000ms. + Ephemeral events that arrive during the wait are delivered in this batch but are NOT + replayable on a subsequent read (use a non-zero waitMs in your next call to capture + future ephemerals as they happen). This applies to forward reads only: a backward read + always returns immediately and ignores `waitMs`, because backward paging covers persisted + history only while new events append at the tail (the opposite end from a backward page), + so no blocking or ephemeral delivery can occur. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPAppsHostContext': + def from_dict(obj: Any) -> 'EventLogReadRequest': assert isinstance(obj, dict) - context = MCPAppsHostContextDetails.from_dict(obj.get("context")) - return MCPAppsHostContext(context) + agent_ids = from_union([lambda x: from_list(from_str, x), from_none], obj.get("agentIds")) + agent_scope = from_union([EventsAgentScope, from_none], obj.get("agentScope")) + cursor = from_union([from_str, from_none], obj.get("cursor")) + direction = from_union([EventsReadDirection, from_none], obj.get("direction")) + include_ephemeral = from_union([from_bool, from_none], obj.get("includeEphemeral")) + max = from_union([from_int, from_none], obj.get("max")) + types = from_union([lambda x: from_list(from_str, x), EventLogTypes, from_none], obj.get("types")) + wait_ms = from_union([from_int, from_none], obj.get("waitMs")) + return EventLogReadRequest(agent_ids, agent_scope, cursor, direction, include_ephemeral, max, types, wait_ms) def to_dict(self) -> dict: result: dict = {} - result["context"] = to_class(MCPAppsHostContextDetails, self.context) + if self.agent_ids is not None: + result["agentIds"] = from_union([lambda x: from_list(from_str, x), from_none], self.agent_ids) + if self.agent_scope is not None: + result["agentScope"] = from_union([lambda x: to_enum(EventsAgentScope, x), from_none], self.agent_scope) + if self.cursor is not None: + result["cursor"] = from_union([from_str, from_none], self.cursor) + if self.direction is not None: + result["direction"] = from_union([lambda x: to_enum(EventsReadDirection, x), from_none], self.direction) + if self.include_ephemeral is not None: + result["includeEphemeral"] = from_union([from_bool, from_none], self.include_ephemeral) + if self.max is not None: + result["max"] = from_union([from_int, from_none], self.max) + if self.types is not None: + result["types"] = from_union([lambda x: from_list(from_str, x), lambda x: to_enum(EventLogTypes, x), from_none], self.types) + if self.wait_ms is not None: + result["waitMs"] = from_union([from_int, from_none], self.wait_ms) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPAppsSetHostContextRequest: - """Host context to advertise to MCP App guests.""" +class EventsReadResult: + """Batch of session events returned by a read, with cursor and continuation metadata.""" - context: MCPAppsSetHostContextDetails - """Host context advertised to MCP App guests""" + cursor: str + """Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue + from where this read left off. Always present, even when no events were returned. For a + backward read this cursor pages toward OLDER events; keep passing `direction: backward` + with it (the cursor is also self-describing, so backward paging continues correctly). + """ + cursor_status: EventsCursorStatus + """Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor + referred to an event that no longer exists in history (e.g. truncated or compacted away) + and the read fell back to a boundary of the remaining history. For a forward read the + fallback starts from the beginning of the remaining history; for a backward read it falls + back to the tail (the newest window). Because the fallback page is a fresh boundary + snapshot rather than a continuation of the requested cursor, it may overlap events the + consumer has already rendered — a backward fallback to the tail in particular can repeat + the newest window. On 'expired', consumers should reset or rebase their local pagination + state (or deduplicate by event id) before continuing from the returned cursor rather than + blindly appending/prepending the fallback page. + """ + events: list[SessionEvent] + """Session events for this batch, merged into a single stream in creation order: durable + (persisted) events and ephemeral events interleave exactly as they were emitted. Set + `includeEphemeral: false` to receive only durable events. Ephemeral events are never + replayable once pruned from the in-memory ring, so a consumer that needs them should keep + reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window + contains persisted events only, still in chronological (oldest-to-newest) append order. + """ + has_more: bool + """True when more events are available in the read's direction. For a forward read, true + means the batch returned `max` events and more are available immediately. For a backward + read, true means older persisted events remain before the returned window. + """ @staticmethod - def from_dict(obj: Any) -> 'MCPAppsSetHostContextRequest': + def from_dict(obj: Any) -> 'EventsReadResult': assert isinstance(obj, dict) - context = MCPAppsSetHostContextDetails.from_dict(obj.get("context")) - return MCPAppsSetHostContextRequest(context) + cursor = from_str(obj.get("cursor")) + cursor_status = EventsCursorStatus(obj.get("cursorStatus")) + events = from_list(SessionEvent.from_dict, obj.get("events")) + has_more = from_bool(obj.get("hasMore")) + return EventsReadResult(cursor, cursor_status, events, has_more) def to_dict(self) -> dict: result: dict = {} - result["context"] = to_class(MCPAppsSetHostContextDetails, self.context) + result["cursor"] = from_str(self.cursor) + result["cursorStatus"] = to_enum(EventsCursorStatus, self.cursor_status) + result["events"] = from_list(lambda x: to_class(SessionEvent, x), self.events) + result["hasMore"] = from_bool(self.has_more) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPConfigAddRequest: - """MCP server name and configuration to add to user configuration.""" +class ExtensionLaunchProviderResolveRequest: + """A discovered extension entrypoint that the registered integrator may classify and resolve + to an opaque launch profile. + """ + id: str + """Source-qualified extension identifier.""" - config: MCPServerConfig - """MCP server configuration (stdio process or remote HTTP/SSE)""" + module_path: str + """Absolute path to the discovered extension entrypoint.""" name: str - """Unique name for the MCP server""" + """Human-readable extension name.""" + + source: ExtensionSource + """Discovery source for the extension entrypoint.""" @staticmethod - def from_dict(obj: Any) -> 'MCPConfigAddRequest': + def from_dict(obj: Any) -> 'ExtensionLaunchProviderResolveRequest': assert isinstance(obj, dict) - config = MCPServerConfig.from_dict(obj.get("config")) + id = from_str(obj.get("id")) + module_path = from_str(obj.get("modulePath")) name = from_str(obj.get("name")) - return MCPConfigAddRequest(config, name) + source = ExtensionSource(obj.get("source")) + return ExtensionLaunchProviderResolveRequest(id, module_path, name, source) def to_dict(self) -> dict: result: dict = {} - result["config"] = to_class(MCPServerConfig, self.config) + result["id"] = from_str(self.id) + result["modulePath"] = from_str(self.module_path) result["name"] = from_str(self.name) + result["source"] = to_enum(ExtensionSource, self.source) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPConfigList: - """User-configured MCP servers, keyed by server name.""" +class Extension: + """Discovered extension metadata, including source-qualified ID, name, discovery source, + status, and optional process ID. + """ + id: str + """Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', + 'plugin:my-plugin:my-ext') + """ + name: str + """Extension name (directory name)""" - servers: dict[str, MCPServerConfig] - """All MCP servers from user config, keyed by name""" + source: ExtensionSource + """Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin + (installed plugin), or session (session-state//extensions/) + """ + status: ExtensionStatus + """Current status: running, disabled, failed, or starting""" + + pid: int | None = None + """Process ID if the extension is running""" @staticmethod - def from_dict(obj: Any) -> 'MCPConfigList': + def from_dict(obj: Any) -> 'Extension': assert isinstance(obj, dict) - servers = from_dict(MCPServerConfig.from_dict, obj.get("servers")) - return MCPConfigList(servers) + id = from_str(obj.get("id")) + name = from_str(obj.get("name")) + source = ExtensionSource(obj.get("source")) + status = ExtensionStatus(obj.get("status")) + pid = from_union([from_int, from_none], obj.get("pid")) + return Extension(id, name, source, status, pid) def to_dict(self) -> dict: result: dict = {} - result["servers"] = from_dict(lambda x: to_class(MCPServerConfig, x), self.servers) + result["id"] = from_str(self.id) + result["name"] = from_str(self.name) + result["source"] = to_enum(ExtensionSource, self.source) + result["status"] = to_enum(ExtensionStatus, self.status) + if self.pid is not None: + result["pid"] = from_union([from_int, from_none], self.pid) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPConfigUpdateRequest: - """MCP server name and replacement configuration to write to user configuration.""" +class ExtensionContextPushInput: + """Slim input shape for extension_context attachments; identity fields are runtime-derived.""" - config: MCPServerConfig - """MCP server configuration (stdio process or remote HTTP/SSE)""" + payload: Any + """Caller-supplied JSON payload (required, may be null but not undefined)""" - name: str - """Name of the MCP server to update""" + title: str + """Human-readable composer pill label""" + + type: ClassVar[str] = "extension_context" + """Attachment type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'MCPConfigUpdateRequest': + def from_dict(obj: Any) -> 'ExtensionContextPushInput': assert isinstance(obj, dict) - config = MCPServerConfig.from_dict(obj.get("config")) - name = from_str(obj.get("name")) - return MCPConfigUpdateRequest(config, name) + payload = obj.get("payload") + title = from_str(obj.get("title")) + return ExtensionContextPushInput(payload, title) def to_dict(self) -> dict: result: dict = {} - result["config"] = to_class(MCPServerConfig, self.config) - result["name"] = from_str(self.name) + result["payload"] = self.payload + result["title"] = from_str(self.title) + result["type"] = self.type return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MetadataRecordContextChangeRequest: - """Updated working-directory/git context to record on the session.""" - - context: SessionWorkingDirectoryContext - """Updated working directory and git context. Emitted as the new payload of - `session.context_changed`. +class ExtensionLaunchProviderResolveResult: + """The launch profile for a supported entrypoint. Omit launch when the provider does not + support the entrypoint. """ + launch: ExtensionLaunchProfile | None = None + """Opaque launch profile, omitted when this provider does not support the entrypoint.""" @staticmethod - def from_dict(obj: Any) -> 'MetadataRecordContextChangeRequest': + def from_dict(obj: Any) -> 'ExtensionLaunchProviderResolveResult': assert isinstance(obj, dict) - context = SessionWorkingDirectoryContext.from_dict(obj.get("context")) - return MetadataRecordContextChangeRequest(context) + launch = from_union([ExtensionLaunchProfile.from_dict, from_none], obj.get("launch")) + return ExtensionLaunchProviderResolveResult(launch) def to_dict(self) -> dict: result: dict = {} - result["context"] = to_class(SessionWorkingDirectoryContext, self.context) + if self.launch is not None: + result["launch"] = from_union([lambda x: to_class(ExtensionLaunchProfile, x), from_none], self.launch) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionMetadata: - """Schema for the `SessionMetadata` type.""" +class ExternalToolTextResultForLlmBinaryResultsForLlm: + """Binary result returned by a tool for the model""" - is_remote: bool - """True for remote (GitHub) sessions; false for local""" + data: str + """Base64-encoded binary data""" - modified_time: str - """Last-modified time of the session's persisted state, as ISO 8601""" + mime_type: str + """MIME type of the binary data""" - session_id: str - """Stable session identifier""" + type: ExternalToolTextResultForLlmBinaryResultsForLlmType + """Binary result type discriminator. Use "image" for images and "resource" for other binary + data. + """ + description: str | None = None + """Human-readable description of the binary data""" - start_time: str - """Session creation time as an ISO 8601 timestamp""" + metadata: dict[str, Any] | None = None + """Optional metadata from the producing tool.""" - client_name: str | None = None - """Runtime client name that created/last resumed this session""" + @staticmethod + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmBinaryResultsForLlm': + assert isinstance(obj, dict) + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + type = ExternalToolTextResultForLlmBinaryResultsForLlmType(obj.get("type")) + description = from_union([from_str, from_none], obj.get("description")) + metadata = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("metadata")) + return ExternalToolTextResultForLlmBinaryResultsForLlm(data, mime_type, type, description, metadata) - context: SessionContext | None = None - """Schema for the `SessionContext` type.""" + def to_dict(self) -> dict: + result: dict = {} + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = to_enum(ExternalToolTextResultForLlmBinaryResultsForLlmType, self.type) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.metadata is not None: + result["metadata"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.metadata) + return result - is_detached: bool | None = None - """True for detached maintenance sessions that should be hidden from normal resume lists.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ExternalToolTextResultForLlmContentResourceLinkIcon: + """Icon image for a resource""" - mc_task_id: str | None = None - """GitHub task ID, when this local session is bound to one. Only present for local sessions - exported to remote control. - """ - name: str | None = None - """Optional human-friendly name set via /rename""" + src: str + """URL or path to the icon image""" - summary: str | None = None - """Short summary of the session, when one has been derived""" + mime_type: str | None = None + """MIME type of the icon image""" + + sizes: list[str] | None = None + """Available icon sizes (e.g., ['16x16', '32x32'])""" + + theme: Theme | None = None + """Theme variant this icon is intended for""" @staticmethod - def from_dict(obj: Any) -> 'SessionMetadata': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLinkIcon': assert isinstance(obj, dict) - is_remote = from_bool(obj.get("isRemote")) - modified_time = from_str(obj.get("modifiedTime")) - session_id = from_str(obj.get("sessionId")) - start_time = from_str(obj.get("startTime")) - client_name = from_union([from_str, from_none], obj.get("clientName")) - context = from_union([SessionContext.from_dict, from_none], obj.get("context")) - is_detached = from_union([from_bool, from_none], obj.get("isDetached")) - mc_task_id = from_union([from_str, from_none], obj.get("mcTaskId")) - name = from_union([from_str, from_none], obj.get("name")) - summary = from_union([from_str, from_none], obj.get("summary")) - return SessionMetadata(is_remote, modified_time, session_id, start_time, client_name, context, is_detached, mc_task_id, name, summary) + src = from_str(obj.get("src")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + sizes = from_union([lambda x: from_list(from_str, x), from_none], obj.get("sizes")) + theme = from_union([Theme, from_none], obj.get("theme")) + return ExternalToolTextResultForLlmContentResourceLinkIcon(src, mime_type, sizes, theme) def to_dict(self) -> dict: result: dict = {} - result["isRemote"] = from_bool(self.is_remote) - result["modifiedTime"] = from_str(self.modified_time) - result["sessionId"] = from_str(self.session_id) - result["startTime"] = from_str(self.start_time) - if self.client_name is not None: - result["clientName"] = from_union([from_str, from_none], self.client_name) - if self.context is not None: - result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) - if self.is_detached is not None: - result["isDetached"] = from_union([from_bool, from_none], self.is_detached) - if self.mc_task_id is not None: - result["mcTaskId"] = from_union([from_str, from_none], self.mc_task_id) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.summary is not None: - result["summary"] = from_union([from_str, from_none], self.summary) + result["src"] = from_str(self.src) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.sizes is not None: + result["sizes"] = from_union([lambda x: from_list(from_str, x), from_none], self.sizes) + if self.theme is not None: + result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) return result +ExternalToolTextResultForLlmContentResourceDetails = EmbeddedTextResourceContents | EmbeddedBlobResourceContents + # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsGetLastForContextRequest: - """Optional working-directory context used to score session relevance.""" +class MCPResourceIcon: + """A resource icon descriptor plus preserved non-standard icon fields.""" - context: SessionContext | None = None - """Optional working-directory context used to score session relevance. When omitted the - most-recently-modified session wins. - """ + src: str + """Icon URI""" - @staticmethod - def from_dict(obj: Any) -> 'SessionsGetLastForContextRequest': - assert isinstance(obj, dict) - context = from_union([SessionContext.from_dict, from_none], obj.get("context")) - return SessionsGetLastForContextRequest(context) + additional_properties: dict[str, Any] | None = None + """Server-provided non-standard icon fields preserved from the MCP response""" - def to_dict(self) -> dict: - result: dict = {} - if self.context is not None: - result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) - return result + mime_type: str | None = None + """Icon MIME type, when known""" -# Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class PermissionPathsConfig: - """If specified, replaces the session's path-permission policy. The runtime constructs the - appropriate PathManager based on these inputs (rooted at the session's working - directory). Omit to leave the current path policy unchanged. - """ - additional_directories: list[str] | None = None - """Additional directories to allow tool access to (in addition to the session's working - directory). When `unrestricted` is true, these are still pre-populated on the - UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention - completion). - """ - include_temp_directory: bool | None = None - """Whether to include the system temp directory in the allowed list (defaults to true). - Ignored when `unrestricted` is true. - """ - unrestricted: bool | None = None - """If true, the runtime allows access to all paths without prompting. Equivalent to - constructing an UnrestrictedPathManager. - """ - workspace_path: str | None = None - """Workspace root path (special-cased to be allowed even before the directory exists). - Ignored when `unrestricted` is true. - """ + sizes: str | None = None + """Icon sizes hint""" + + theme: str | None = None + """Theme hint for this icon""" @staticmethod - def from_dict(obj: Any) -> 'PermissionPathsConfig': + def from_dict(obj: Any) -> 'MCPResourceIcon': assert isinstance(obj, dict) - additional_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("additionalDirectories")) - include_temp_directory = from_union([from_bool, from_none], obj.get("includeTempDirectory")) - unrestricted = from_union([from_bool, from_none], obj.get("unrestricted")) - workspace_path = from_union([from_str, from_none], obj.get("workspacePath")) - return PermissionPathsConfig(additional_directories, include_temp_directory, unrestricted, workspace_path) + src = from_str(obj.get("src")) + additional_properties = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("additionalProperties")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + sizes = from_union([from_str, from_none], obj.get("sizes")) + theme = from_union([from_str, from_none], obj.get("theme")) + return MCPResourceIcon(src, additional_properties, mime_type, sizes, theme) def to_dict(self) -> dict: result: dict = {} - if self.additional_directories is not None: - result["additionalDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.additional_directories) - if self.include_temp_directory is not None: - result["includeTempDirectory"] = from_union([from_bool, from_none], self.include_temp_directory) - if self.unrestricted is not None: - result["unrestricted"] = from_union([from_bool, from_none], self.unrestricted) - if self.workspace_path is not None: - result["workspacePath"] = from_union([from_str, from_none], self.workspace_path) + result["src"] = from_str(self.src) + if self.additional_properties is not None: + result["additionalProperties"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.additional_properties) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.sizes is not None: + result["sizes"] = from_union([from_str, from_none], self.sizes) + if self.theme is not None: + result["theme"] = from_union([from_str, from_none], self.theme) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspaceSummary: - """Public-facing projection of workspace metadata for SDK / TUI consumers""" - - id: str - """Workspace identifier (1:1 with sessionId)""" - - branch: str | None = None - """Branch checked out at session start, if any""" - - created_at: datetime | None = None - """ISO 8601 timestamp when the workspace was created""" - - cwd: str | None = None - """Current working directory at session start""" - - git_root: str | None = None - """Resolved git root for cwd, if any""" - - host_type: HostType | None = None - """Repository host type, if known""" +class ExternalToolTextResultForLlmContentAudio: + """Audio content block with base64-encoded data""" - name: str | None = None - """Display name for the session, if set""" + data: str + """Base64-encoded audio data""" - repository: str | None = None - """Repository identifier in 'owner/repo' or 'org/project/repo' format, if any""" + mime_type: str + """MIME type of the audio (e.g., audio/wav, audio/mpeg)""" - updated_at: datetime | None = None - """ISO 8601 timestamp when the workspace was last updated""" + type: ClassVar[str] = "audio" + """Content block type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'WorkspaceSummary': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentAudio': assert isinstance(obj, dict) - id = from_str(obj.get("id")) - branch = from_union([from_str, from_none], obj.get("branch")) - created_at = from_union([from_datetime, from_none], obj.get("created_at")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - git_root = from_union([from_str, from_none], obj.get("git_root")) - host_type = from_union([HostType, from_none], obj.get("host_type")) - name = from_union([from_str, from_none], obj.get("name")) - repository = from_union([from_str, from_none], obj.get("repository")) - updated_at = from_union([from_datetime, from_none], obj.get("updated_at")) - return WorkspaceSummary(id, branch, created_at, cwd, git_root, host_type, name, repository, updated_at) + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + return ExternalToolTextResultForLlmContentAudio(data, mime_type) def to_dict(self) -> dict: result: dict = {} - result["id"] = from_str(self.id) - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.created_at is not None: - result["created_at"] = from_union([lambda x: x.isoformat(), from_none], self.created_at) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.git_root is not None: - result["git_root"] = from_union([from_str, from_none], self.git_root) - if self.host_type is not None: - result["host_type"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.repository is not None: - result["repository"] = from_union([from_str, from_none], self.repository) - if self.updated_at is not None: - result["updated_at"] = from_union([lambda x: x.isoformat(), from_none], self.updated_at) + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = self.type return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesGetWorkspaceResult: - """Current workspace metadata for the session, including its absolute filesystem path when - available. - """ - path: str | None = None - """Absolute filesystem path to the workspace directory. Omitted when the session has no - workspace (e.g. remote sessions). - """ - workspace: Workspace | None = None - """Current workspace metadata, or null if not available""" +class ExternalToolTextResultForLlmContentImage: + """Image content block with base64-encoded data""" + + data: str + """Base64-encoded image data""" + + mime_type: str + """MIME type of the image (e.g., image/png, image/jpeg)""" + + type: ClassVar[str] = "image" + """Content block type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesGetWorkspaceResult': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentImage': assert isinstance(obj, dict) - path = from_union([from_str, from_none], obj.get("path")) - workspace = from_union([Workspace.from_dict, from_none], obj.get("workspace")) - return WorkspacesGetWorkspaceResult(path, workspace) + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + return ExternalToolTextResultForLlmContentImage(data, mime_type) def to_dict(self) -> dict: result: dict = {} - if self.path is not None: - result["path"] = from_union([from_str, from_none], self.path) - result["workspace"] = from_union([lambda x: to_class(Workspace, x), from_none], self.workspace) + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = self.type return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspacesListCheckpointsResult: - """Workspace checkpoints in chronological order; empty when the workspace is not enabled.""" +class ExternalToolTextResultForLlmContentResource: + """Embedded resource content block with inline text or binary data""" - checkpoints: list[WorkspacesCheckpoints] - """Workspace checkpoints in chronological order. Empty when workspace is not enabled.""" + resource: ExternalToolTextResultForLlmContentResourceDetails + """The embedded resource contents, either text or base64-encoded binary""" + + type: ClassVar[str] = "resource" + """Content block type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'WorkspacesListCheckpointsResult': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResource': assert isinstance(obj, dict) - checkpoints = from_list(WorkspacesCheckpoints.from_dict, obj.get("checkpoints")) - return WorkspacesListCheckpointsResult(checkpoints) + resource = (lambda x: from_union([EmbeddedTextResourceContents.from_dict, EmbeddedBlobResourceContents.from_dict], x))(obj.get("resource")) + return ExternalToolTextResultForLlmContentResource(resource) def to_dict(self) -> dict: result: dict = {} - result["checkpoints"] = from_list(lambda x: to_class(WorkspacesCheckpoints, x), self.checkpoints) + result["resource"] = from_union([lambda x: to_class(EmbeddedTextResourceContents, x), lambda x: to_class(EmbeddedBlobResourceContents, x)], self.resource) + result["type"] = self.type return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelBilling: - """Billing information""" +class ExternalToolTextResultForLlmContentShellExit: + """Shell command exit metadata with optional output preview""" - multiplier: float | None = None - """Billing cost multiplier relative to the base rate""" + exit_code: int + """Exit code from the completed shell command""" - token_prices: ModelBillingTokenPrices | None = None - """Token-level pricing information for this model""" + shell_id: str + """Shell id, as assigned by Copilot runtime""" + + type: ClassVar[str] = "shell_exit" + """Content block type discriminator""" + + cwd: str | None = None + """Working directory where the shell command was executed""" + + output_preview: str | None = None + """Output associated with this shell command, if available. May be partial, truncated, or a + preview; not guaranteed to be full output. + """ + output_truncated: bool | None = None + """Whether outputPreview is known to be incomplete or truncated""" @staticmethod - def from_dict(obj: Any) -> 'ModelBilling': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentShellExit': assert isinstance(obj, dict) - multiplier = from_union([from_float, from_none], obj.get("multiplier")) - token_prices = from_union([ModelBillingTokenPrices.from_dict, from_none], obj.get("tokenPrices")) - return ModelBilling(multiplier, token_prices) + exit_code = from_int(obj.get("exitCode")) + shell_id = from_str(obj.get("shellId")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + output_preview = from_union([from_str, from_none], obj.get("outputPreview")) + output_truncated = from_union([from_bool, from_none], obj.get("outputTruncated")) + return ExternalToolTextResultForLlmContentShellExit(exit_code, shell_id, cwd, output_preview, output_truncated) def to_dict(self) -> dict: result: dict = {} - if self.multiplier is not None: - result["multiplier"] = from_union([to_float, from_none], self.multiplier) - if self.token_prices is not None: - result["tokenPrices"] = from_union([lambda x: to_class(ModelBillingTokenPrices, x), from_none], self.token_prices) + result["exitCode"] = from_int(self.exit_code) + result["shellId"] = from_str(self.shell_id) + result["type"] = self.type + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.output_preview is not None: + result["outputPreview"] = from_union([from_str, from_none], self.output_preview) + if self.output_truncated is not None: + result["outputTruncated"] = from_union([from_bool, from_none], self.output_truncated) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ModelCapabilitiesOverride: - """Override individual model capabilities resolved by the runtime""" +class ExternalToolTextResultForLlmContentTerminal: + """Terminal/shell output content block with optional exit code and working directory""" - limits: ModelCapabilitiesOverrideLimits | None = None - """Token limits for prompts, outputs, and context window""" + text: str + """Terminal/shell output text""" - supports: ModelCapabilitiesOverrideSupports | None = None - """Feature flags indicating what the model supports""" + type: ClassVar[str] = "terminal" + """Content block type discriminator""" + + cwd: str | None = None + """Working directory where the command was executed""" + + exit_code: int | None = None + """Process exit code, if the command has completed""" @staticmethod - def from_dict(obj: Any) -> 'ModelCapabilitiesOverride': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentTerminal': assert isinstance(obj, dict) - limits = from_union([ModelCapabilitiesOverrideLimits.from_dict, from_none], obj.get("limits")) - supports = from_union([ModelCapabilitiesOverrideSupports.from_dict, from_none], obj.get("supports")) - return ModelCapabilitiesOverride(limits, supports) + text = from_str(obj.get("text")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + exit_code = from_union([from_int, from_none], obj.get("exitCode")) + return ExternalToolTextResultForLlmContentTerminal(text, cwd, exit_code) def to_dict(self) -> dict: result: dict = {} - if self.limits is not None: - result["limits"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimits, x), from_none], self.limits) - if self.supports is not None: - result["supports"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideSupports, x), from_none], self.supports) + result["text"] = from_str(self.text) + result["type"] = self.type + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.exit_code is not None: + result["exitCode"] = from_union([from_int, from_none], self.exit_code) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsConfigureAdditionalContentExclusionPolicy: - """Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type.""" +class ExternalToolTextResultForLlmContentText: + """Plain text content block""" - last_updated_at: float | str - rules: list[PermissionsConfigureAdditionalContentExclusionPolicyRule] - scope: PermissionsConfigureAdditionalContentExclusionPolicyScope - """Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` - enumeration. - """ + text: str + """The text content""" + + type: ClassVar[str] = "text" + """Content block type discriminator""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicy': + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentText': assert isinstance(obj, dict) - last_updated_at = from_union([from_float, from_str], obj.get("last_updated_at")) - rules = from_list(PermissionsConfigureAdditionalContentExclusionPolicyRule.from_dict, obj.get("rules")) - scope = PermissionsConfigureAdditionalContentExclusionPolicyScope(obj.get("scope")) - return PermissionsConfigureAdditionalContentExclusionPolicy(last_updated_at, rules, scope) + text = from_str(obj.get("text")) + return ExternalToolTextResultForLlmContentText(text) def to_dict(self) -> dict: result: dict = {} - result["last_updated_at"] = from_union([to_float, from_str], self.last_updated_at) - result["rules"] = from_list(lambda x: to_class(PermissionsConfigureAdditionalContentExclusionPolicyRule, x), self.rules) - result["scope"] = to_enum(PermissionsConfigureAdditionalContentExclusionPolicyScope, self.scope) + result["text"] = from_str(self.text) + result["type"] = self.type return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class QueuePendingItemsResult: - """Snapshot of the session's pending queued items and immediate-steering messages.""" +class SlashCommandTextResult: + """Slash-command invocation result containing text output plus Markdown/ANSI rendering flags.""" - items: list[QueuePendingItems] - """Pending queued items in submission order. Includes user messages, queued slash commands, - and queued model changes; omits internal system items. - """ - steering_messages: list[str] - """Display text for messages currently in the immediate steering queue (interjections sent - during a running turn). + kind: ClassVar[str] = "text" + """Text result discriminator""" + + text: str + """Text output for the client to render""" + + markdown: bool | None = None + """Whether text contains Markdown""" + + preserve_ansi: bool | None = None + """Whether ANSI sequences should be preserved""" + + runtime_settings_changed: bool | None = None + """True when the invocation mutated user runtime settings; consumers caching settings should + refresh """ @staticmethod - def from_dict(obj: Any) -> 'QueuePendingItemsResult': + def from_dict(obj: Any) -> 'SlashCommandTextResult': assert isinstance(obj, dict) - items = from_list(QueuePendingItems.from_dict, obj.get("items")) - steering_messages = from_list(from_str, obj.get("steeringMessages")) - return QueuePendingItemsResult(items, steering_messages) + text = from_str(obj.get("text")) + markdown = from_union([from_bool, from_none], obj.get("markdown")) + preserve_ansi = from_union([from_bool, from_none], obj.get("preserveAnsi")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandTextResult(text, markdown, preserve_ansi, runtime_settings_changed) def to_dict(self) -> dict: result: dict = {} - result["items"] = from_list(lambda x: to_class(QueuePendingItems, x), self.items) - result["steeringMessages"] = from_list(from_str, self.steering_messages) + result["kind"] = self.kind + result["text"] = from_str(self.text) + if self.markdown is not None: + result["markdown"] = from_union([from_bool, from_none], self.markdown) + if self.preserve_ansi is not None: + result["preserveAnsi"] = from_union([from_bool, from_none], self.preserve_ansi) + if self.runtime_settings_changed is not None: + result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SendAttachmentSelection: - """Code selection attachment from an editor""" - - display_name: str - """User-facing display name for the selection""" +class FactoryAgentRequest: + """Parameters for one factory-scoped subagent call.""" - file_path: str - """Absolute path to the file containing the selection""" + execution_token: str + """Opaque token identifying the current factory execution attempt.""" - selection: SendAttachmentSelectionDetails - """Position range of the selection within the file""" + factory_run_id: str + """Factory run identifier that owns the subagent.""" - text: str - """The selected text content""" + opts: FactoryAgentOptions + """Subagent execution options.""" - type: ClassVar[str] = "selection" - """Attachment type discriminator""" + prompt: str + """Prompt to send to the subagent.""" @staticmethod - def from_dict(obj: Any) -> 'SendAttachmentSelection': + def from_dict(obj: Any) -> 'FactoryAgentRequest': assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - file_path = from_str(obj.get("filePath")) - selection = SendAttachmentSelectionDetails.from_dict(obj.get("selection")) - text = from_str(obj.get("text")) - return SendAttachmentSelection(display_name, file_path, selection, text) + execution_token = from_str(obj.get("executionToken")) + factory_run_id = from_str(obj.get("factoryRunId")) + opts = FactoryAgentOptions.from_dict(obj.get("opts")) + prompt = from_str(obj.get("prompt")) + return FactoryAgentRequest(execution_token, factory_run_id, opts, prompt) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["filePath"] = from_str(self.file_path) - result["selection"] = to_class(SendAttachmentSelectionDetails, self.selection) - result["text"] = from_str(self.text) - result["type"] = self.type + result["executionToken"] = from_str(self.execution_token) + result["factoryRunId"] = from_str(self.factory_run_id) + result["opts"] = to_class(FactoryAgentOptions, self.opts) + result["prompt"] = from_str(self.prompt) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSReadFileResult: - """File content as a UTF-8 string, or a filesystem error if the read failed.""" +class FactoryRunFailure: + """Machine-readable factory run failure. - content: str - """File content as UTF-8 string""" + Machine-readable failure details for an errored run. - error: SessionFSError | None = None - """Describes a filesystem error.""" + The run stopped because its usage accounting could not be completed. + """ + run_id: str + """Factory run identifier. + + Factory run identifier whose changed limits were declined. + """ + type: FactoryRunFailureType + kind: FactoryRunFailureKind | None = None + """Resource ceiling that stopped the run.""" + + value: float | None = None + """Approved effective ceiling that was reached.""" + + reason: str | None = None + """Human-readable reason the resume did not proceed.""" + + code: str | None = None + """Stable failure code.""" + + operation: FactoryDurableOperation | None = None + """Execution-critical durable operation that failed.""" + + drained_nano_aiu: int | None = None + """Confirmed usage in nano-AIU, representing the floor of what the run spent.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSReadFileResult': + def from_dict(obj: Any) -> 'FactoryRunFailure': assert isinstance(obj, dict) - content = from_str(obj.get("content")) - error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) - return SessionFSReadFileResult(content, error) + run_id = from_str(obj.get("runId")) + type = FactoryRunFailureType(obj.get("type")) + kind = from_union([FactoryRunFailureKind, from_none], obj.get("kind")) + value = from_union([from_float, from_none], obj.get("value")) + reason = from_union([from_str, from_none], obj.get("reason")) + code = from_union([from_str, from_none], obj.get("code")) + operation = from_union([FactoryDurableOperation, from_none], obj.get("operation")) + drained_nano_aiu = from_union([from_int, from_none], obj.get("drainedNanoAiu")) + return FactoryRunFailure(run_id, type, kind, value, reason, code, operation, drained_nano_aiu) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - if self.error is not None: - result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + result["runId"] = from_str(self.run_id) + result["type"] = to_enum(FactoryRunFailureType, self.type) + if self.kind is not None: + result["kind"] = from_union([lambda x: to_enum(FactoryRunFailureKind, x), from_none], self.kind) + if self.value is not None: + result["value"] = from_union([to_float, from_none], self.value) + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.code is not None: + result["code"] = from_union([from_str, from_none], self.code) + if self.operation is not None: + result["operation"] = from_union([lambda x: to_enum(FactoryDurableOperation, x), from_none], self.operation) + if self.drained_nano_aiu is not None: + result["drainedNanoAiu"] = from_union([from_int, from_none], self.drained_nano_aiu) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSReaddirResult: - """Names of entries in the requested directory, or a filesystem error if the read failed.""" +class FactoryLogLine: + """One ordered factory progress line.""" - entries: list[str] - """Entry names in the directory""" + kind: FactoryLogLineKind + """Progress line kind.""" - error: SessionFSError | None = None - """Describes a filesystem error.""" + seq: int + """Monotonic sequence number within the factory run.""" + + text: str + """Progress text.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSReaddirResult': + def from_dict(obj: Any) -> 'FactoryLogLine': assert isinstance(obj, dict) - entries = from_list(from_str, obj.get("entries")) - error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) - return SessionFSReaddirResult(entries, error) + kind = FactoryLogLineKind(obj.get("kind")) + seq = from_int(obj.get("seq")) + text = from_str(obj.get("text")) + return FactoryLogLine(kind, seq, text) def to_dict(self) -> dict: result: dict = {} - result["entries"] = from_list(from_str, self.entries) - if self.error is not None: - result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + result["kind"] = to_enum(FactoryLogLineKind, self.kind) + result["seq"] = from_int(self.seq) + result["text"] = from_str(self.text) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSSqliteQueryResult: - """Query results including rows, columns, and rows affected, or a filesystem error if - execution failed. - """ - columns: list[str] - """Column names from the result set""" +class FactoryProgressLine: + """One durable factory progress record.""" - rows: list[dict[str, Any]] - """For SELECT: array of row objects. For others: empty array.""" + attempt: int + """Resume attempt that emitted this record.""" - rows_affected: int - """Number of rows affected (for INSERT/UPDATE/DELETE)""" + kind: FactoryLogLineKind + """Progress record kind.""" - error: SessionFSError | None = None - """Describes a filesystem error.""" + recorded_at: int + """Epoch milliseconds when the record was persisted.""" - last_insert_rowid: int | None = None - """SQLite last_insert_rowid() value for INSERT.""" + seq: int + """Global monotonic sequence number within the run.""" + + text: str + """Prompt-safe progress text.""" + + phase_id: str | None = None + """Phase active when the record was emitted, or null before any phase.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSSqliteQueryResult': + def from_dict(obj: Any) -> 'FactoryProgressLine': assert isinstance(obj, dict) - columns = from_list(from_str, obj.get("columns")) - rows = from_list(lambda x: from_dict(lambda x: x, x), obj.get("rows")) - rows_affected = from_int(obj.get("rowsAffected")) - error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) - last_insert_rowid = from_union([from_int, from_none], obj.get("lastInsertRowid")) - return SessionFSSqliteQueryResult(columns, rows, rows_affected, error, last_insert_rowid) + attempt = from_int(obj.get("attempt")) + kind = FactoryLogLineKind(obj.get("kind")) + recorded_at = from_int(obj.get("recordedAt")) + seq = from_int(obj.get("seq")) + text = from_str(obj.get("text")) + phase_id = from_union([from_none, from_str], obj.get("phaseId")) + return FactoryProgressLine(attempt, kind, recorded_at, seq, text, phase_id) def to_dict(self) -> dict: result: dict = {} - result["columns"] = from_list(from_str, self.columns) - result["rows"] = from_list(lambda x: from_dict(lambda x: x, x), self.rows) - result["rowsAffected"] = from_int(self.rows_affected) - if self.error is not None: - result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) - if self.last_insert_rowid is not None: - result["lastInsertRowid"] = from_union([from_int, from_none], self.last_insert_rowid) + result["attempt"] = from_int(self.attempt) + result["kind"] = to_enum(FactoryLogLineKind, self.kind) + result["recordedAt"] = from_int(self.recorded_at) + result["seq"] = from_int(self.seq) + result["text"] = from_str(self.text) + result["phaseId"] = from_union([from_none, from_str], self.phase_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSStatResult: - """Filesystem metadata for the requested path, or a filesystem error if the stat failed.""" +class FactoryPhaseObservation: + """Durable lifecycle and timing for one factory phase.""" - birthtime: datetime - """ISO 8601 timestamp of creation""" + accumulated_active_ms: int + current_active_ms: int + entry_count: int + id: str + last_entered_run_attempt: int + live_agent_count: int + status: FactoryPhaseStatus + title: str + total_agent_count: int + completed_at: int | None = None + detail: str | None = None + ordinal: int | None = None + started_at: int | None = None - is_directory: bool - """Whether the path is a directory""" + @staticmethod + def from_dict(obj: Any) -> 'FactoryPhaseObservation': + assert isinstance(obj, dict) + accumulated_active_ms = from_int(obj.get("accumulatedActiveMs")) + current_active_ms = from_int(obj.get("currentActiveMs")) + entry_count = from_int(obj.get("entryCount")) + id = from_str(obj.get("id")) + last_entered_run_attempt = from_int(obj.get("lastEnteredRunAttempt")) + live_agent_count = from_int(obj.get("liveAgentCount")) + status = FactoryPhaseStatus(obj.get("status")) + title = from_str(obj.get("title")) + total_agent_count = from_int(obj.get("totalAgentCount")) + completed_at = from_union([from_int, from_none], obj.get("completedAt")) + detail = from_union([from_str, from_none], obj.get("detail")) + ordinal = from_union([from_none, from_int], obj.get("ordinal")) + started_at = from_union([from_int, from_none], obj.get("startedAt")) + return FactoryPhaseObservation(accumulated_active_ms, current_active_ms, entry_count, id, last_entered_run_attempt, live_agent_count, status, title, total_agent_count, completed_at, detail, ordinal, started_at) - is_file: bool - """Whether the path is a file""" + def to_dict(self) -> dict: + result: dict = {} + result["accumulatedActiveMs"] = from_int(self.accumulated_active_ms) + result["currentActiveMs"] = from_int(self.current_active_ms) + result["entryCount"] = from_int(self.entry_count) + result["id"] = from_str(self.id) + result["lastEnteredRunAttempt"] = from_int(self.last_entered_run_attempt) + result["liveAgentCount"] = from_int(self.live_agent_count) + result["status"] = to_enum(FactoryPhaseStatus, self.status) + result["title"] = from_str(self.title) + result["totalAgentCount"] = from_int(self.total_agent_count) + if self.completed_at is not None: + result["completedAt"] = from_union([from_int, from_none], self.completed_at) + if self.detail is not None: + result["detail"] = from_union([from_str, from_none], self.detail) + result["ordinal"] = from_union([from_none, from_int], self.ordinal) + if self.started_at is not None: + result["startedAt"] = from_union([from_int, from_none], self.started_at) + return result - mtime: datetime - """ISO 8601 timestamp of last modification""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryResumeRequest: + """Parameters for resuming a factory run from its persisted identity.""" - size: int - """File size in bytes""" + run_id: str + """Factory run identifier.""" - error: SessionFSError | None = None - """Describes a filesystem error.""" + limits: FactoryRunLimits | None = None + """Optional per-invocation resource ceiling overrides.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSStatResult': + def from_dict(obj: Any) -> 'FactoryResumeRequest': assert isinstance(obj, dict) - birthtime = from_datetime(obj.get("birthtime")) - is_directory = from_bool(obj.get("isDirectory")) - is_file = from_bool(obj.get("isFile")) - mtime = from_datetime(obj.get("mtime")) - size = from_int(obj.get("size")) - error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) - return SessionFSStatResult(birthtime, is_directory, is_file, mtime, size, error) + run_id = from_str(obj.get("runId")) + limits = from_union([FactoryRunLimits.from_dict, from_none], obj.get("limits")) + return FactoryResumeRequest(run_id, limits) def to_dict(self) -> dict: result: dict = {} - result["birthtime"] = self.birthtime.isoformat() - result["isDirectory"] = from_bool(self.is_directory) - result["isFile"] = from_bool(self.is_file) - result["mtime"] = self.mtime.isoformat() - result["size"] = from_int(self.size) - if self.error is not None: - result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + result["runId"] = from_str(self.run_id) + if self.limits is not None: + result["limits"] = from_union([lambda x: to_class(FactoryRunLimits, x), from_none], self.limits) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionFSReaddirWithTypesResult: - """Entries in the requested directory paired with file/directory type information, or a - filesystem error if the read failed. +class RunOptions: + """Factory invocation options. + + Options controlling factory invocation. """ - entries: list[SessionFSReaddirWithTypesEntry] - """Directory entries with type information""" + limits: FactoryRunLimits | None = None + """Per-invocation resource ceiling overrides.""" - error: SessionFSError | None = None - """Describes a filesystem error.""" + resume_from_run_id: str | None = None + """Run identifier whose journal and progress should seed this resumed run.""" @staticmethod - def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesResult': + def from_dict(obj: Any) -> 'RunOptions': assert isinstance(obj, dict) - entries = from_list(SessionFSReaddirWithTypesEntry.from_dict, obj.get("entries")) - error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) - return SessionFSReaddirWithTypesResult(entries, error) + limits = from_union([FactoryRunLimits.from_dict, from_none], obj.get("limits")) + resume_from_run_id = from_union([from_str, from_none], obj.get("resumeFromRunId")) + return RunOptions(limits, resume_from_run_id) def to_dict(self) -> dict: result: dict = {} - result["entries"] = from_list(lambda x: to_class(SessionFSReaddirWithTypesEntry, x), self.entries) - if self.error is not None: - result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + if self.limits is not None: + result["limits"] = from_union([lambda x: to_class(FactoryRunLimits, x), from_none], self.limits) + if self.resume_from_run_id is not None: + result["resumeFromRunId"] = from_union([from_str, from_none], self.resume_from_run_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentGetCurrentResult: - """The currently selected custom agent, or null when using the default agent.""" +class HistoryCompactResult: + """Compaction outcome with the number of tokens and messages removed, summary text, and the + resulting context window breakdown. + """ + messages_removed: int + """Number of messages removed during compaction""" - agent: AgentInfo | None = None - """Currently selected custom agent, or null if using the default agent""" + success: bool + """Whether compaction completed successfully""" + + tokens_removed: int + """Number of tokens freed by compaction""" + + context_window: HistoryCompactContextWindow | None = None + """Post-compaction context window usage breakdown""" + + summary_content: str | None = None + """Summary text produced by compaction. Omitted when compaction did not produce a summary + (e.g. failure path). + """ @staticmethod - def from_dict(obj: Any) -> 'AgentGetCurrentResult': + def from_dict(obj: Any) -> 'HistoryCompactResult': assert isinstance(obj, dict) - agent = from_union([AgentInfo.from_dict, from_none], obj.get("agent")) - return AgentGetCurrentResult(agent) + messages_removed = from_int(obj.get("messagesRemoved")) + success = from_bool(obj.get("success")) + tokens_removed = from_int(obj.get("tokensRemoved")) + context_window = from_union([HistoryCompactContextWindow.from_dict, from_none], obj.get("contextWindow")) + summary_content = from_union([from_str, from_none], obj.get("summaryContent")) + return HistoryCompactResult(messages_removed, success, tokens_removed, context_window, summary_content) def to_dict(self) -> dict: result: dict = {} - if self.agent is not None: - result["agent"] = from_union([lambda x: to_class(AgentInfo, x), from_none], self.agent) + result["messagesRemoved"] = from_int(self.messages_removed) + result["success"] = from_bool(self.success) + result["tokensRemoved"] = from_int(self.tokens_removed) + if self.context_window is not None: + result["contextWindow"] = from_union([lambda x: to_class(HistoryCompactContextWindow, x), from_none], self.context_window) + if self.summary_content is not None: + result["summaryContent"] = from_union([from_str, from_none], self.summary_content) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentList: - """Custom agents available to the session.""" +class HistorySkippedFileRestore: + """A captured file that rewind intentionally left unchanged.""" - agents: list[AgentInfo] - """Available custom agents""" + path: str + """Absolute path of the skipped file.""" + + reason: HistoryFileRestoreSkipReason + """Reason the file was not restored.""" @staticmethod - def from_dict(obj: Any) -> 'AgentList': + def from_dict(obj: Any) -> 'HistorySkippedFileRestore': assert isinstance(obj, dict) - agents = from_list(AgentInfo.from_dict, obj.get("agents")) - return AgentList(agents) + path = from_str(obj.get("path")) + reason = HistoryFileRestoreSkipReason(obj.get("reason")) + return HistorySkippedFileRestore(path, reason) def to_dict(self) -> dict: result: dict = {} - result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + result["path"] = from_str(self.path) + result["reason"] = to_enum(HistoryFileRestoreSkipReason, self.reason) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentReloadResult: - """Custom agents available to the session after reloading definitions from disk.""" +class HistoryListRewindPointsResult: + """Rewind points and file-change-tracking availability for the session.""" - agents: list[AgentInfo] - """Reloaded custom agents""" + file_change_tracking_enabled: bool + """Whether this session captured file changes from its first turn.""" + + points: list[HistoryRewindPoint] + """Root user turns in chronological order. Empty when `unavailableReason` is set.""" + + unavailable_reason: HistoryRewindUnavailableReason | None = None + """Why the listed points could not be produced, when applicable; the points list is empty + whenever it is set. `unsupported-remote-session` is permanent for the session and comes + with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever + reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the + file-change captures cannot be read while work that may still mutate them is in flight; + the same request succeeds once the session settles, so a client that wants points should + retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an + untracked local session still lists conversation-only points and reports that through + `fileChangeTrackingEnabled: false`. + """ @staticmethod - def from_dict(obj: Any) -> 'AgentReloadResult': + def from_dict(obj: Any) -> 'HistoryListRewindPointsResult': assert isinstance(obj, dict) - agents = from_list(AgentInfo.from_dict, obj.get("agents")) - return AgentReloadResult(agents) + file_change_tracking_enabled = from_bool(obj.get("fileChangeTrackingEnabled")) + points = from_list(HistoryRewindPoint.from_dict, obj.get("points")) + unavailable_reason = from_union([HistoryRewindUnavailableReason, from_none], obj.get("unavailableReason")) + return HistoryListRewindPointsResult(file_change_tracking_enabled, points, unavailable_reason) def to_dict(self) -> dict: result: dict = {} - result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + result["fileChangeTrackingEnabled"] = from_bool(self.file_change_tracking_enabled) + result["points"] = from_list(lambda x: to_class(HistoryRewindPoint, x), self.points) + if self.unavailable_reason is not None: + result["unavailableReason"] = from_union([lambda x: to_enum(HistoryRewindUnavailableReason, x), from_none], self.unavailable_reason) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentSelectResult: - """The newly selected custom agent.""" +class HistoryRewindFilePreview: + """A file that a conversation-and-files rewind would restore.""" - agent: AgentInfo - """The newly selected custom agent""" + change_type: HistoryRewindChangeType + """Aggregate change made across the discarded turns.""" + + lines_added: int + """Lines added across the discarded turns.""" + + lines_removed: int + """Lines removed across the discarded turns.""" + + path: str + """Absolute path of the captured file.""" @staticmethod - def from_dict(obj: Any) -> 'AgentSelectResult': + def from_dict(obj: Any) -> 'HistoryRewindFilePreview': assert isinstance(obj, dict) - agent = AgentInfo.from_dict(obj.get("agent")) - return AgentSelectResult(agent) + change_type = HistoryRewindChangeType(obj.get("changeType")) + lines_added = from_int(obj.get("linesAdded")) + lines_removed = from_int(obj.get("linesRemoved")) + path = from_str(obj.get("path")) + return HistoryRewindFilePreview(change_type, lines_added, lines_removed, path) def to_dict(self) -> dict: result: dict = {} - result["agent"] = to_class(AgentInfo, self.agent) + result["changeType"] = to_enum(HistoryRewindChangeType, self.change_type) + result["linesAdded"] = from_int(self.lines_added) + result["linesRemoved"] = from_int(self.lines_removed) + result["path"] = from_str(self.path) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskProgress: - """Schema for the `TaskAgentProgress` type. +class HistoryRewindRequest: + """Boundary and mode for rewinding session history.""" - Schema for the `TaskShellProgress` type. - """ - type: TaskInfoType - """Progress kind""" + event_id: str + """ID of the user.message event that begins the discarded suffix.""" - latest_intent: str | None = None - """The most recent intent reported by the agent""" + mode: HistoryRewindMode + """Whether to rewind only conversation history or also restore captured files.""" - recent_activity: list[TaskProgressLine] | None = None - """Recent tool execution events converted to display lines""" + @staticmethod + def from_dict(obj: Any) -> 'HistoryRewindRequest': + assert isinstance(obj, dict) + event_id = from_str(obj.get("eventId")) + mode = HistoryRewindMode(obj.get("mode")) + return HistoryRewindRequest(event_id, mode) - pid: int | None = None - """Process ID when available""" + def to_dict(self) -> dict: + result: dict = {} + result["eventId"] = from_str(self.event_id) + result["mode"] = to_enum(HistoryRewindMode, self.mode) + return result - recent_output: str | None = None - """Recent stdout/stderr lines from the running shell command""" +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _HookInvokeRequest: + """Runtime-owned wire payload for a server-to-client hook callback invocation.""" + + hook_type: _HookType + input: Any + session_id: str @staticmethod - def from_dict(obj: Any) -> 'TaskProgress': + def from_dict(obj: Any) -> '_HookInvokeRequest': assert isinstance(obj, dict) - type = TaskInfoType(obj.get("type")) - latest_intent = from_union([from_str, from_none], obj.get("latestIntent")) - recent_activity = from_union([lambda x: from_list(TaskProgressLine.from_dict, x), from_none], obj.get("recentActivity")) - pid = from_union([from_int, from_none], obj.get("pid")) - recent_output = from_union([from_str, from_none], obj.get("recentOutput")) - return TaskProgress(type, latest_intent, recent_activity, pid, recent_output) + hook_type = _HookType(obj.get("hookType")) + input = obj.get("input") + session_id = from_str(obj.get("sessionId")) + return _HookInvokeRequest(hook_type, input, session_id) def to_dict(self) -> dict: result: dict = {} - result["type"] = to_enum(TaskInfoType, self.type) - if self.latest_intent is not None: - result["latestIntent"] = from_union([from_str, from_none], self.latest_intent) - if self.recent_activity is not None: - result["recentActivity"] = from_union([lambda x: from_list(lambda x: to_class(TaskProgressLine, x), x), from_none], self.recent_activity) - if self.pid is not None: - result["pid"] = from_union([from_int, from_none], self.pid) - if self.recent_output is not None: - result["recentOutput"] = from_union([from_str, from_none], self.recent_output) + result["hookType"] = to_enum(_HookType, self.hook_type) + result["input"] = self.input + result["sessionId"] = from_str(self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayAnyOfField: - """Multi-select string field where each option pairs a value with a display label.""" - - items: UIElicitationArrayAnyOfFieldItems - """Schema applied to each item in the array.""" - - type: UIElicitationArrayAnyOfFieldType - """Type discriminator. Always "array".""" +class InstalledPluginSource: + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. - default: list[str] | None = None - """Default values selected when the form is first shown.""" + Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. - description: str | None = None - """Help text describing the field.""" + Source descriptor for a direct local plugin install, with a local filesystem path. + """ + source: PurpleSource + """Constant value. Always "github". - max_items: int | None = None - """Maximum number of items the user may select.""" + Constant value. Always "url". - min_items: int | None = None - """Minimum number of items the user must select.""" + Constant value. Always "local". + """ + path: str | None = None + ref: str | None = None + repo: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" - title: str | None = None - """Human-readable label for the field.""" + url: str | None = None @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfField': + def from_dict(obj: Any) -> 'InstalledPluginSource': assert isinstance(obj, dict) - items = UIElicitationArrayAnyOfFieldItems.from_dict(obj.get("items")) - type = UIElicitationArrayAnyOfFieldType(obj.get("type")) - default = from_union([lambda x: from_list(from_str, x), from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - max_items = from_union([from_int, from_none], obj.get("maxItems")) - min_items = from_union([from_int, from_none], obj.get("minItems")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationArrayAnyOfField(items, type, default, description, max_items, min_items, title) + source = PurpleSource(obj.get("source")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + repo = from_union([from_str, from_none], obj.get("repo")) + sha = from_union([from_str, from_none], obj.get("sha")) + url = from_union([from_str, from_none], obj.get("url")) + return InstalledPluginSource(source, path, ref, repo, sha, url) def to_dict(self) -> dict: result: dict = {} - result["items"] = to_class(UIElicitationArrayAnyOfFieldItems, self.items) - result["type"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type) - if self.default is not None: - result["default"] = from_union([lambda x: from_list(from_str, x), from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.max_items is not None: - result["maxItems"] = from_union([from_int, from_none], self.max_items) - if self.min_items is not None: - result["minItems"] = from_union([from_int, from_none], self.min_items) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["source"] = to_enum(PurpleSource, self.source) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.repo is not None: + result["repo"] = from_union([from_str, from_none], self.repo) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationArrayEnumField: - """Multi-select string field whose allowed values are defined inline.""" - - items: UIElicitationArrayEnumFieldItems - """Schema applied to each item in the array.""" - - type: UIElicitationArrayAnyOfFieldType - """Type discriminator. Always "array".""" +class SessionInstalledPluginSource: + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. - default: list[str] | None = None - """Default values selected when the form is first shown.""" + Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. - description: str | None = None - """Help text describing the field.""" + Source descriptor for a direct local plugin install, with a local filesystem path. + """ + source: PurpleSource + """Constant value. Always "github". - max_items: int | None = None - """Maximum number of items the user may select.""" + Constant value. Always "url". - min_items: int | None = None - """Minimum number of items the user must select.""" + Constant value. Always "local". + """ + path: str | None = None + ref: str | None = None + repo: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" - title: str | None = None - """Human-readable label for the field.""" + url: str | None = None @staticmethod - def from_dict(obj: Any) -> 'UIElicitationArrayEnumField': + def from_dict(obj: Any) -> 'SessionInstalledPluginSource': assert isinstance(obj, dict) - items = UIElicitationArrayEnumFieldItems.from_dict(obj.get("items")) - type = UIElicitationArrayAnyOfFieldType(obj.get("type")) - default = from_union([lambda x: from_list(from_str, x), from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - max_items = from_union([from_int, from_none], obj.get("maxItems")) - min_items = from_union([from_int, from_none], obj.get("minItems")) - title = from_union([from_str, from_none], obj.get("title")) - return UIElicitationArrayEnumField(items, type, default, description, max_items, min_items, title) + source = PurpleSource(obj.get("source")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + repo = from_union([from_str, from_none], obj.get("repo")) + sha = from_union([from_str, from_none], obj.get("sha")) + url = from_union([from_str, from_none], obj.get("url")) + return SessionInstalledPluginSource(source, path, ref, repo, sha, url) def to_dict(self) -> dict: result: dict = {} - result["items"] = to_class(UIElicitationArrayEnumFieldItems, self.items) - result["type"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type) - if self.default is not None: - result["default"] = from_union([lambda x: from_list(from_str, x), from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.max_items is not None: - result["maxItems"] = from_union([from_int, from_none], self.max_items) - if self.min_items is not None: - result["minItems"] = from_union([from_int, from_none], self.min_items) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) + result["source"] = to_enum(PurpleSource, self.source) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.repo is not None: + result["repo"] = from_union([from_str, from_none], self.repo) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationSchemaProperty: - """Definition for a single elicitation form field. - - Single-select string field whose allowed values are defined inline. - - Single-select string field where each option pairs a value with a display label. - - Multi-select string field whose allowed values are defined inline. - - Multi-select string field where each option pairs a value with a display label. - - Boolean field rendered as a yes/no toggle. - - Free-text string field with optional length and format constraints. - - Numeric field accepting either a number or an integer. +class InstalledPluginSourceGitHub: + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. """ - type: UIElicitationSchemaPropertyType - """Type discriminator. Always "string". - - Type discriminator. Always "array". + repo: str + source: FluffySource + """Constant value. Always "github".""" - Type discriminator. Always "boolean". + path: str | None = None + ref: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" - Numeric type accepted by the field. - """ - default: float | bool | list[str] | str | None = None - """Default value selected when the form is first shown. + @staticmethod + def from_dict(obj: Any) -> 'InstalledPluginSourceGitHub': + assert isinstance(obj, dict) + repo = from_str(obj.get("repo")) + source = FluffySource(obj.get("source")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + sha = from_union([from_str, from_none], obj.get("sha")) + return InstalledPluginSourceGitHub(repo, source, path, ref, sha) - Default values selected when the form is first shown. + def to_dict(self) -> dict: + result: dict = {} + result["repo"] = from_str(self.repo) + result["source"] = to_enum(FluffySource, self.source) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) + return result - Default value populated in the input when the form is first shown. +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionInstalledPluginSourceGitHub: + """Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or + full commit SHA, and optional subpath. """ - description: str | None = None - """Help text describing the field.""" - - enum: list[str] | None = None - """Allowed string values.""" - - enum_names: list[str] | None = None - """Optional display labels for each enum value, in the same order as `enum`.""" - - title: str | None = None - """Human-readable label for the field.""" + repo: str + source: FluffySource + """Constant value. Always "github".""" - one_of: list[UIElicitationStringOneOfFieldOneOf] | None = None - """Selectable options, each with a value and a display label.""" + path: str | None = None + ref: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" - items: UIElicitationArrayFieldItems | None = None - """Schema applied to each item in the array.""" + @staticmethod + def from_dict(obj: Any) -> 'SessionInstalledPluginSourceGitHub': + assert isinstance(obj, dict) + repo = from_str(obj.get("repo")) + source = FluffySource(obj.get("source")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + sha = from_union([from_str, from_none], obj.get("sha")) + return SessionInstalledPluginSourceGitHub(repo, source, path, ref, sha) - max_items: int | None = None - """Maximum number of items the user may select.""" + def to_dict(self) -> dict: + result: dict = {} + result["repo"] = from_str(self.repo) + result["source"] = to_enum(FluffySource, self.source) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) + return result - min_items: int | None = None - """Minimum number of items the user must select.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstalledPluginSourceLocal: + """Source descriptor for a direct local plugin install, with a local filesystem path.""" - format: UIElicitationSchemaPropertyStringFormat | None = None - """Optional format hint that constrains the accepted input.""" + path: str + source: TentacledSource + """Constant value. Always "local".""" - max_length: int | None = None - """Maximum number of characters allowed.""" + @staticmethod + def from_dict(obj: Any) -> 'InstalledPluginSourceLocal': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + source = TentacledSource(obj.get("source")) + return InstalledPluginSourceLocal(path, source) - min_length: int | None = None - """Minimum number of characters required.""" + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["source"] = to_enum(TentacledSource, self.source) + return result - maximum: float | None = None - """Maximum allowed value (inclusive).""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionInstalledPluginSourceLocal: + """Source descriptor for a direct local plugin install, with a local filesystem path.""" - minimum: float | None = None - """Minimum allowed value (inclusive).""" + path: str + source: TentacledSource + """Constant value. Always "local".""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationSchemaProperty': + def from_dict(obj: Any) -> 'SessionInstalledPluginSourceLocal': assert isinstance(obj, dict) - type = UIElicitationSchemaPropertyType(obj.get("type")) - default = from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], obj.get("default")) - description = from_union([from_str, from_none], obj.get("description")) - enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enum")) - enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enumNames")) - title = from_union([from_str, from_none], obj.get("title")) - one_of = from_union([lambda x: from_list(UIElicitationStringOneOfFieldOneOf.from_dict, x), from_none], obj.get("oneOf")) - items = from_union([UIElicitationArrayFieldItems.from_dict, from_none], obj.get("items")) - max_items = from_union([from_int, from_none], obj.get("maxItems")) - min_items = from_union([from_int, from_none], obj.get("minItems")) - format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get("format")) - max_length = from_union([from_int, from_none], obj.get("maxLength")) - min_length = from_union([from_int, from_none], obj.get("minLength")) - maximum = from_union([from_float, from_none], obj.get("maximum")) - minimum = from_union([from_float, from_none], obj.get("minimum")) - return UIElicitationSchemaProperty(type, default, description, enum, enum_names, title, one_of, items, max_items, min_items, format, max_length, min_length, maximum, minimum) + path = from_str(obj.get("path")) + source = TentacledSource(obj.get("source")) + return SessionInstalledPluginSourceLocal(path, source) def to_dict(self) -> dict: result: dict = {} - result["type"] = to_enum(UIElicitationSchemaPropertyType, self.type) - if self.default is not None: - result["default"] = from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], self.default) - if self.description is not None: - result["description"] = from_union([from_str, from_none], self.description) - if self.enum is not None: - result["enum"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum) - if self.enum_names is not None: - result["enumNames"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names) - if self.title is not None: - result["title"] = from_union([from_str, from_none], self.title) - if self.one_of is not None: - result["oneOf"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), x), from_none], self.one_of) - if self.items is not None: - result["items"] = from_union([lambda x: to_class(UIElicitationArrayFieldItems, x), from_none], self.items) - if self.max_items is not None: - result["maxItems"] = from_union([from_int, from_none], self.max_items) - if self.min_items is not None: - result["minItems"] = from_union([from_int, from_none], self.min_items) - if self.format is not None: - result["format"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format) - if self.max_length is not None: - result["maxLength"] = from_union([from_int, from_none], self.max_length) - if self.min_length is not None: - result["minLength"] = from_union([from_int, from_none], self.min_length) - if self.maximum is not None: - result["maximum"] = from_union([to_float, from_none], self.maximum) - if self.minimum is not None: - result["minimum"] = from_union([to_float, from_none], self.minimum) + result["path"] = from_str(self.path) + result["source"] = to_enum(TentacledSource, self.source) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingElicitationRequest: - """Pending elicitation request ID and the user's response (accept/decline/cancel + form - values). +class InstalledPluginSourceURL: + """Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. """ - request_id: str - """The unique request ID from the elicitation.requested event""" + source: StickySource + """Constant value. Always "url".""" - result: UIElicitationResponse - """The elicitation response (accept with form values, decline, or cancel)""" + url: str + path: str | None = None + ref: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingElicitationRequest': + def from_dict(obj: Any) -> 'InstalledPluginSourceURL': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - result = UIElicitationResponse.from_dict(obj.get("result")) - return UIHandlePendingElicitationRequest(request_id, result) + source = StickySource(obj.get("source")) + url = from_str(obj.get("url")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + sha = from_union([from_str, from_none], obj.get("sha")) + return InstalledPluginSourceURL(source, url, path, ref, sha) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - result["result"] = to_class(UIElicitationResponse, self.result) + result["source"] = to_enum(StickySource, self.source) + result["url"] = from_str(self.url) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIHandlePendingExitPlanModeRequest: - """Request ID of a pending `exit_plan_mode.requested` event and the user's response.""" - - request_id: str - """The unique request ID from the exit_plan_mode.requested event""" +class SessionInstalledPluginSourceURL: + """Source descriptor for a direct URL plugin install, with URL, optional ref or full commit + SHA, and optional subpath. + """ + source: StickySource + """Constant value. Always "url".""" - response: UIExitPlanModeResponse - """Schema for the `UIExitPlanModeResponse` type.""" + url: str + path: str | None = None + ref: str | None = None + sha: str | None = None + """Optional full 40-character hexadecimal commit SHA.""" @staticmethod - def from_dict(obj: Any) -> 'UIHandlePendingExitPlanModeRequest': + def from_dict(obj: Any) -> 'SessionInstalledPluginSourceURL': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - response = UIExitPlanModeResponse.from_dict(obj.get("response")) - return UIHandlePendingExitPlanModeRequest(request_id, response) + source = StickySource(obj.get("source")) + url = from_str(obj.get("url")) + path = from_union([from_str, from_none], obj.get("path")) + ref = from_union([from_str, from_none], obj.get("ref")) + sha = from_union([from_str, from_none], obj.get("sha")) + return SessionInstalledPluginSourceURL(source, url, path, ref, sha) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - result["response"] = to_class(UIExitPlanModeResponse, self.response) + result["source"] = to_enum(StickySource, self.source) + result["url"] = from_str(self.url) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + if self.sha is not None: + result["sha"] = from_union([from_str, from_none], self.sha) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UsageGetMetricsResult: - """Accumulated session usage metrics, including premium request cost, token counts, model - breakdown, and code-change totals. +class InstructionSource: + """Loaded instruction source for a session, including path, content, category, location, + applicability, and optional description. """ - code_changes: UsageMetricsCodeChanges - """Aggregated code change metrics""" + content: str + """Raw content of the instruction file""" - last_call_input_tokens: int - """Input tokens from the most recent main-agent API call""" + id: str + """Unique identifier for this source (used for toggling)""" - last_call_output_tokens: int - """Output tokens from the most recent main-agent API call""" + label: str + """Human-readable label""" - model_metrics: dict[str, UsageMetricsModelMetric] - """Per-model token and request metrics, keyed by model identifier""" + location: InstructionLocation + """Where this source lives — used for UI grouping""" - session_start_time: datetime - """ISO 8601 timestamp when the session started""" + source_path: str + """File path relative to repo or absolute for home""" - total_api_duration_ms: int - """Total time spent in model API calls (milliseconds)""" + type: InstructionSourceType + """Category of instruction source — used for merge logic""" - total_premium_request_cost: float - """Total user-initiated premium request cost across all models (may be fractional due to - multipliers) + apply_to: list[str] | None = None + """Glob pattern(s) from frontmatter — when set, this instruction applies only to matching + files """ - total_user_requests: int - """Raw count of user-initiated API requests""" - - current_model: str | None = None - """Currently active model identifier""" + default_disabled: bool | None = None + """When true, this source starts disabled and must be toggled on by the user""" - token_details: dict[str, UsageMetricsTokenDetail] | None = None - """Session-wide per-token-type accumulated token counts""" + description: str | None = None + """Short description (body after frontmatter) for use in instruction tables""" - total_nano_aiu: float | None = None - """Session-wide accumulated nano-AI units cost""" + project_path: str | None = None + """The project path this source was discovered from. Only set by sessionless discovery for + repository, working-directory, and project-scoped plugin sources, where it disambiguates + sources across multiple workspace roots. The session-scoped getSources leaves it unset. + """ @staticmethod - def from_dict(obj: Any) -> 'UsageGetMetricsResult': + def from_dict(obj: Any) -> 'InstructionSource': assert isinstance(obj, dict) - code_changes = UsageMetricsCodeChanges.from_dict(obj.get("codeChanges")) - last_call_input_tokens = from_int(obj.get("lastCallInputTokens")) - last_call_output_tokens = from_int(obj.get("lastCallOutputTokens")) - model_metrics = from_dict(UsageMetricsModelMetric.from_dict, obj.get("modelMetrics")) - session_start_time = from_datetime(obj.get("sessionStartTime")) - total_api_duration_ms = from_int(obj.get("totalApiDurationMs")) - total_premium_request_cost = from_float(obj.get("totalPremiumRequestCost")) - total_user_requests = from_int(obj.get("totalUserRequests")) - current_model = from_union([from_str, from_none], obj.get("currentModel")) - token_details = from_union([lambda x: from_dict(UsageMetricsTokenDetail.from_dict, x), from_none], obj.get("tokenDetails")) - total_nano_aiu = from_union([from_float, from_none], obj.get("totalNanoAiu")) - 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) + content = from_str(obj.get("content")) + id = from_str(obj.get("id")) + label = from_str(obj.get("label")) + location = InstructionLocation(obj.get("location")) + source_path = from_str(obj.get("sourcePath")) + type = InstructionSourceType(obj.get("type")) + apply_to = from_union([lambda x: from_list(from_str, x), from_none], obj.get("applyTo")) + default_disabled = from_union([from_bool, from_none], obj.get("defaultDisabled")) + description = from_union([from_str, from_none], obj.get("description")) + project_path = from_union([from_str, from_none], obj.get("projectPath")) + return InstructionSource(content, id, label, location, source_path, type, apply_to, default_disabled, description, project_path) def to_dict(self) -> dict: result: dict = {} - result["codeChanges"] = to_class(UsageMetricsCodeChanges, self.code_changes) - result["lastCallInputTokens"] = from_int(self.last_call_input_tokens) - result["lastCallOutputTokens"] = from_int(self.last_call_output_tokens) - result["modelMetrics"] = from_dict(lambda x: to_class(UsageMetricsModelMetric, x), self.model_metrics) - result["sessionStartTime"] = self.session_start_time.isoformat() - result["totalApiDurationMs"] = from_int(self.total_api_duration_ms) - result["totalPremiumRequestCost"] = to_float(self.total_premium_request_cost) - result["totalUserRequests"] = from_int(self.total_user_requests) - if self.current_model is not None: - result["currentModel"] = from_union([from_str, from_none], self.current_model) - if self.token_details is not None: - result["tokenDetails"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsTokenDetail, x), x), from_none], self.token_details) - if self.total_nano_aiu is not None: - result["totalNanoAiu"] = from_union([to_float, from_none], self.total_nano_aiu) + result["content"] = from_str(self.content) + result["id"] = from_str(self.id) + result["label"] = from_str(self.label) + result["location"] = to_enum(InstructionLocation, self.location) + result["sourcePath"] = from_str(self.source_path) + result["type"] = to_enum(InstructionSourceType, self.type) + if self.apply_to is not None: + result["applyTo"] = from_union([lambda x: from_list(from_str, x), from_none], self.apply_to) + if self.default_disabled is not None: + result["defaultDisabled"] = from_union([from_bool, from_none], self.default_disabled) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.project_path is not None: + result["projectPath"] = from_union([from_str, from_none], self.project_path) return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class WorkspaceDiffResult: - """Workspace diff result for the requested mode.""" - - changes: list[WorkspaceDiffFileChange] - """Changed files and their unified diffs.""" - - is_fallback: bool - """Whether a requested branch diff fell back to unstaged changes because branch diff failed.""" - - mode: WorkspaceDiffMode - """Effective mode used for the returned changes.""" +class LlmInferenceHTTPRequestStartRequest: + """The head of an outbound model-layer HTTP request.""" - requested_mode: WorkspaceDiffMode - """Diff mode requested by the client.""" + headers: dict[str, list[str]] + method: str + """HTTP method, e.g. GET, POST.""" - base_branch: str | None = None - """Default branch used for a branch diff, when branch mode was requested.""" + request_id: str + """Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate + httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies + back to the runtime. + """ + url: str + """Absolute request URL.""" + + agent_id: str | None = None + """Stable identity of the agent trajectory that issued this request. Present when the + request originates from an agent turn; absent for requests outside any agent context. + This is the same identity used by lifecycle and bridged session events and remains + constant across turns and retries. + """ + agent_invocation_id: str | None = None + """Identity of the agent invocation (one agentic loop) that issued this request. It remains + fixed across physical retries within the invocation and is distinct from the stable + trajectory `agentId`. A caller-supplied invocation id always takes precedence (this + covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests + fall back to the runtime's agent task id — the same value the runtime emits as the + `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. + """ + interaction_type: str | None = None + """Coarse classification of the interaction that produced this request. Open string for + forward-compatibility; known values include `conversation-agent`, + `conversation-subagent`, `conversation-sampling`, `conversation-background`, + `conversation-compaction`, and `conversation-user`. Absent when the runtime did not + classify the request. Comes from the runtime's per-request agent context independently of + transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` + header from this same context. + """ + parent_agent_id: str | None = None + """Stable identity of the immediate parent trajectory. Present for child trajectories such + as subagents and conversation-sampling requests; absent for root-agent and non-agent + requests. + """ + session_id: str | None = None + """Id of the runtime session that triggered this request, when one is in scope. Absent for + requests issued outside any session (e.g. startup model-catalog or capability + resolution). This is a payload field — not a dispatch key — because the client-global API + is registered process-wide rather than per session. + """ + transport: LlmInferenceHTTPRequestStartTransport | None = None + """Transport the runtime would otherwise use for this request. `http` (the default when + absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message + channel where each body chunk maps to one WebSocket message and the `binary` flag + distinguishes text from binary frames. The SDK consumer uses this to decide whether to + service the request with an HTTP client or a WebSocket client. It is the one piece of + request metadata the consumer cannot reliably infer from the URL or headers alone. + """ @staticmethod - def from_dict(obj: Any) -> 'WorkspaceDiffResult': + def from_dict(obj: Any) -> 'LlmInferenceHTTPRequestStartRequest': assert isinstance(obj, dict) - changes = from_list(WorkspaceDiffFileChange.from_dict, obj.get("changes")) - is_fallback = from_bool(obj.get("isFallback")) - mode = WorkspaceDiffMode(obj.get("mode")) - requested_mode = WorkspaceDiffMode(obj.get("requestedMode")) - base_branch = from_union([from_str, from_none], obj.get("baseBranch")) - return WorkspaceDiffResult(changes, is_fallback, mode, requested_mode, base_branch) + headers = from_dict(lambda x: from_list(from_str, x), obj.get("headers")) + method = from_str(obj.get("method")) + request_id = from_str(obj.get("requestId")) + url = from_str(obj.get("url")) + agent_id = from_union([from_str, from_none], obj.get("agentId")) + agent_invocation_id = from_union([from_str, from_none], obj.get("agentInvocationId")) + interaction_type = from_union([from_str, from_none], obj.get("interactionType")) + parent_agent_id = from_union([from_str, from_none], obj.get("parentAgentId")) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + transport = from_union([LlmInferenceHTTPRequestStartTransport, from_none], obj.get("transport")) + return LlmInferenceHTTPRequestStartRequest(headers, method, request_id, url, agent_id, agent_invocation_id, interaction_type, parent_agent_id, session_id, transport) def to_dict(self) -> dict: result: dict = {} - result["changes"] = from_list(lambda x: to_class(WorkspaceDiffFileChange, x), self.changes) - result["isFallback"] = from_bool(self.is_fallback) - result["mode"] = to_enum(WorkspaceDiffMode, self.mode) - result["requestedMode"] = to_enum(WorkspaceDiffMode, self.requested_mode) - if self.base_branch is not None: - result["baseBranch"] = from_union([from_str, from_none], self.base_branch) + result["headers"] = from_dict(lambda x: from_list(from_str, x), self.headers) + result["method"] = from_str(self.method) + result["requestId"] = from_str(self.request_id) + result["url"] = from_str(self.url) + if self.agent_id is not None: + result["agentId"] = from_union([from_str, from_none], self.agent_id) + if self.agent_invocation_id is not None: + result["agentInvocationId"] = from_union([from_str, from_none], self.agent_invocation_id) + if self.interaction_type is not None: + result["interactionType"] = from_union([from_str, from_none], self.interaction_type) + if self.parent_agent_id is not None: + result["parentAgentId"] = from_union([from_str, from_none], self.parent_agent_id) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) + if self.transport is not None: + result["transport"] = from_union([lambda x: to_enum(LlmInferenceHTTPRequestStartTransport, x), from_none], self.transport) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CommandList: - """Slash commands available in the session, after applying any include/exclude filters.""" +class LlmInferenceHTTPResponseChunkRequest: + """A response body chunk or terminal error.""" - commands: list[SlashCommandInfo] - """Commands available in this session""" + data: str + """Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when + `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk + with empty data and end=true). + """ + request_id: str + """Matches the requestId from the originating httpRequestStart frame.""" + + binary: bool | None = None + """When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text.""" + + end: bool | None = None + """When true, this is the final body chunk for the response. The runtime treats the response + body as complete after receiving an end-marked chunk. + """ + error: LlmInferenceHTTPResponseChunkError | None = None + """Set to terminate the response with a transport-level failure. Implies end-of-stream; any + further chunks for this requestId are ignored. + """ @staticmethod - def from_dict(obj: Any) -> 'CommandList': + def from_dict(obj: Any) -> 'LlmInferenceHTTPResponseChunkRequest': assert isinstance(obj, dict) - commands = from_list(SlashCommandInfo.from_dict, obj.get("commands")) - return CommandList(commands) + data = from_str(obj.get("data")) + request_id = from_str(obj.get("requestId")) + binary = from_union([from_bool, from_none], obj.get("binary")) + end = from_union([from_bool, from_none], obj.get("end")) + error = from_union([LlmInferenceHTTPResponseChunkError.from_dict, from_none], obj.get("error")) + return LlmInferenceHTTPResponseChunkRequest(data, request_id, binary, end, error) def to_dict(self) -> dict: result: dict = {} - result["commands"] = from_list(lambda x: to_class(SlashCommandInfo, x), self.commands) + result["data"] = from_str(self.data) + result["requestId"] = from_str(self.request_id) + if self.binary is not None: + result["binary"] = from_union([from_bool, from_none], self.binary) + if self.end is not None: + result["end"] = from_union([from_bool, from_none], self.end) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(LlmInferenceHTTPResponseChunkError, x), from_none], self.error) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasProviderCloseRequest: - """Canvas close parameters sent to the provider.""" +class SessionContext: + """Pre-resolved working-directory context for session startup. - canvas_id: str - """Provider-local canvas identifier""" + Most recent working directory context. - extension_id: str - """Owning provider identifier""" + Working-directory context used to choose the most relevant session. - instance_id: str - """Canvas instance identifier""" + Optional working-directory context used to score session relevance. When omitted the + most-recently-modified session wins. + """ + cwd: str + """Most recent working directory for this session""" - session_id: str - """Target session identifier""" + branch: str | None = None + """Active git branch""" - host: CanvasHostContext | None = None - """Host context supplied by the runtime.""" + git_root: str | None = None + """Git repository root, if the cwd was inside a git repo""" - session: CanvasSessionContext | None = None - """Session context supplied by the runtime.""" + host_type: HostType | None = None + """Repository host type""" + + repository: str | None = None + """Repository slug in `owner/name` form, when known""" @staticmethod - def from_dict(obj: Any) -> 'CanvasProviderCloseRequest': + def from_dict(obj: Any) -> 'SessionContext': assert isinstance(obj, dict) - canvas_id = from_str(obj.get("canvasId")) - extension_id = from_str(obj.get("extensionId")) - instance_id = from_str(obj.get("instanceId")) - session_id = from_str(obj.get("sessionId")) - host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) - session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) - return CanvasProviderCloseRequest(canvas_id, extension_id, instance_id, session_id, host, session) + cwd = from_str(obj.get("cwd")) + branch = from_union([from_str, from_none], obj.get("branch")) + git_root = from_union([from_str, from_none], obj.get("gitRoot")) + host_type = from_union([HostType, from_none], obj.get("hostType")) + repository = from_union([from_str, from_none], obj.get("repository")) + return SessionContext(cwd, branch, git_root, host_type, repository) def to_dict(self) -> dict: result: dict = {} - result["canvasId"] = from_str(self.canvas_id) - result["extensionId"] = from_str(self.extension_id) - result["instanceId"] = from_str(self.instance_id) - result["sessionId"] = from_str(self.session_id) - if self.host is not None: - result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) - if self.session is not None: - result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + result["cwd"] = from_str(self.cwd) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.git_root is not None: + result["gitRoot"] = from_union([from_str, from_none], self.git_root) + if self.host_type is not None: + result["hostType"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) + if self.repository is not None: + result["repository"] = from_union([from_str, from_none], self.repository) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasProviderInvokeActionRequest: - """Canvas action invocation parameters sent to the provider.""" - - action_name: str - """Action name to invoke""" - - canvas_id: str - """Provider-local canvas identifier""" +class SessionWorkingDirectoryContext: + """Updated working directory and git context. Emitted as the new payload of + `session.context_changed`. + """ + cwd: str + """Current working directory path""" - extension_id: str - """Owning provider identifier""" + base_commit: str | None = None + """Merge-base commit SHA (fork point from the remote default branch)""" - instance_id: str - """Canvas instance identifier""" + branch: str | None = None + """Current git branch name""" - session_id: str - """Target session identifier""" + git_root: str | None = None + """Root directory of the git repository, resolved via git rev-parse""" - host: CanvasHostContext | None = None - """Host context supplied by the runtime.""" + head_commit: str | None = None + """Head commit of the current git branch""" - input: Any = None - """Action input""" + host_type: HostType | None = None + """Hosting platform type of the repository""" - session: CanvasSessionContext | None = None - """Session context supplied by the runtime.""" + repository: str | None = None + """Repository identifier derived from the git remote URL ("owner/name" for GitHub, + "org/project/repo" for Azure DevOps) + """ + repository_host: str | None = None + """Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com")""" @staticmethod - def from_dict(obj: Any) -> 'CanvasProviderInvokeActionRequest': + def from_dict(obj: Any) -> 'SessionWorkingDirectoryContext': assert isinstance(obj, dict) - action_name = from_str(obj.get("actionName")) - canvas_id = from_str(obj.get("canvasId")) - extension_id = from_str(obj.get("extensionId")) - instance_id = from_str(obj.get("instanceId")) - session_id = from_str(obj.get("sessionId")) - host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) - input = obj.get("input") - session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) - return CanvasProviderInvokeActionRequest(action_name, canvas_id, extension_id, instance_id, session_id, host, input, session) + cwd = from_str(obj.get("cwd")) + base_commit = from_union([from_str, from_none], obj.get("baseCommit")) + branch = from_union([from_str, from_none], obj.get("branch")) + git_root = from_union([from_str, from_none], obj.get("gitRoot")) + head_commit = from_union([from_str, from_none], obj.get("headCommit")) + host_type = from_union([HostType, from_none], obj.get("hostType")) + repository = from_union([from_str, from_none], obj.get("repository")) + repository_host = from_union([from_str, from_none], obj.get("repositoryHost")) + return SessionWorkingDirectoryContext(cwd, base_commit, branch, git_root, head_commit, host_type, repository, repository_host) def to_dict(self) -> dict: result: dict = {} - result["actionName"] = from_str(self.action_name) - result["canvasId"] = from_str(self.canvas_id) - result["extensionId"] = from_str(self.extension_id) - result["instanceId"] = from_str(self.instance_id) - result["sessionId"] = from_str(self.session_id) - if self.host is not None: - result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) - if self.input is not None: - result["input"] = self.input - if self.session is not None: - result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + result["cwd"] = from_str(self.cwd) + if self.base_commit is not None: + result["baseCommit"] = from_union([from_str, from_none], self.base_commit) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.git_root is not None: + result["gitRoot"] = from_union([from_str, from_none], self.git_root) + if self.head_commit is not None: + result["headCommit"] = from_union([from_str, from_none], self.head_commit) + if self.host_type is not None: + result["hostType"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) + if self.repository is not None: + result["repository"] = from_union([from_str, from_none], self.repository) + if self.repository_host is not None: + result["repositoryHost"] = from_union([from_str, from_none], self.repository_host) return result -# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CanvasProviderOpenRequest: - """Canvas open parameters sent to the provider.""" +class Workspace: + id: str + branch: str | None = None + chronicle_sync_dismissed: bool | None = None + client_name: str | None = None + created_at: datetime | None = None + cwd: str | None = None + git_root: str | None = None + host_type: HostType | None = None + """Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.""" - canvas_id: str - """Provider-local canvas identifier""" + mc_last_event_id: str | None = None + mc_session_id: str | None = None + mc_task_id: str | None = None + name: str | None = None + remote_steerable: bool | None = None + repository: str | None = None + summary_count: int | None = None + updated_at: datetime | None = None + user_named: bool | None = None - extension_id: str - """Owning provider identifier""" + @staticmethod + def from_dict(obj: Any) -> 'Workspace': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + branch = from_union([from_str, from_none], obj.get("branch")) + chronicle_sync_dismissed = from_union([from_bool, from_none], obj.get("chronicle_sync_dismissed")) + client_name = from_union([from_str, from_none], obj.get("client_name")) + created_at = from_union([from_datetime, from_none], obj.get("created_at")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + git_root = from_union([from_str, from_none], obj.get("git_root")) + host_type = from_union([HostType, from_none], obj.get("host_type")) + mc_last_event_id = from_union([from_str, from_none], obj.get("mc_last_event_id")) + mc_session_id = from_union([from_str, from_none], obj.get("mc_session_id")) + mc_task_id = from_union([from_str, from_none], obj.get("mc_task_id")) + name = from_union([from_str, from_none], obj.get("name")) + remote_steerable = from_union([from_bool, from_none], obj.get("remote_steerable")) + repository = from_union([from_str, from_none], obj.get("repository")) + summary_count = from_union([from_int, from_none], obj.get("summary_count")) + updated_at = from_union([from_datetime, from_none], obj.get("updated_at")) + user_named = from_union([from_bool, from_none], obj.get("user_named")) + return Workspace(id, branch, chronicle_sync_dismissed, client_name, created_at, cwd, git_root, host_type, mc_last_event_id, mc_session_id, mc_task_id, name, remote_steerable, repository, summary_count, updated_at, user_named) - instance_id: str - """Stable caller-supplied canvas instance identifier""" + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.chronicle_sync_dismissed is not None: + result["chronicle_sync_dismissed"] = from_union([from_bool, from_none], self.chronicle_sync_dismissed) + if self.client_name is not None: + result["client_name"] = from_union([from_str, from_none], self.client_name) + if self.created_at is not None: + result["created_at"] = from_union([lambda x: x.isoformat(), from_none], self.created_at) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.git_root is not None: + result["git_root"] = from_union([from_str, from_none], self.git_root) + if self.host_type is not None: + result["host_type"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) + if self.mc_last_event_id is not None: + result["mc_last_event_id"] = from_union([from_str, from_none], self.mc_last_event_id) + if self.mc_session_id is not None: + result["mc_session_id"] = from_union([from_str, from_none], self.mc_session_id) + if self.mc_task_id is not None: + result["mc_task_id"] = from_union([from_str, from_none], self.mc_task_id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.remote_steerable is not None: + result["remote_steerable"] = from_union([from_bool, from_none], self.remote_steerable) + if self.repository is not None: + result["repository"] = from_union([from_str, from_none], self.repository) + if self.summary_count is not None: + result["summary_count"] = from_union([from_int, from_none], self.summary_count) + if self.updated_at is not None: + result["updated_at"] = from_union([lambda x: x.isoformat(), from_none], self.updated_at) + if self.user_named is not None: + result["user_named"] = from_union([from_bool, from_none], self.user_named) + return result - session_id: str - """Target session identifier""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class LogRequest: + """Message text, optional severity level, persistence flag, optional follow-up URL, and + optional tip. + """ + message: str + """Human-readable message""" - host: CanvasHostContext | None = None - """Host context supplied by the runtime.""" + ephemeral: bool | None = None + """When true, the message is transient and not persisted to the session event log on disk""" - input: Any = None - """Canvas open input""" + level: SessionLogLevel | None = None + """Log severity level. Determines how the message is displayed in the timeline. Defaults to + "info". + """ + tip: str | None = None + """Optional actionable tip displayed alongside the message. Only honored on `level: "info"`.""" - session: CanvasSessionContext | None = None - """Session context supplied by the runtime.""" + type: str | None = None + """Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps + to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + """ + url: str | None = None + """Optional URL the user can open in their browser for more details""" @staticmethod - def from_dict(obj: Any) -> 'CanvasProviderOpenRequest': + def from_dict(obj: Any) -> 'LogRequest': assert isinstance(obj, dict) - canvas_id = from_str(obj.get("canvasId")) - extension_id = from_str(obj.get("extensionId")) - instance_id = from_str(obj.get("instanceId")) - session_id = from_str(obj.get("sessionId")) - host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) - input = obj.get("input") - session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) - return CanvasProviderOpenRequest(canvas_id, extension_id, instance_id, session_id, host, input, session) + message = from_str(obj.get("message")) + ephemeral = from_union([from_bool, from_none], obj.get("ephemeral")) + level = from_union([SessionLogLevel, from_none], obj.get("level")) + tip = from_union([from_str, from_none], obj.get("tip")) + type = from_union([from_str, from_none], obj.get("type")) + url = from_union([from_str, from_none], obj.get("url")) + return LogRequest(message, ephemeral, level, tip, type, url) def to_dict(self) -> dict: result: dict = {} - result["canvasId"] = from_str(self.canvas_id) - result["extensionId"] = from_str(self.extension_id) - result["instanceId"] = from_str(self.instance_id) - result["sessionId"] = from_str(self.session_id) - if self.host is not None: - result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) - if self.input is not None: - result["input"] = self.input - if self.session is not None: - result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + result["message"] = from_str(self.message) + if self.ephemeral is not None: + result["ephemeral"] = from_union([from_bool, from_none], self.ephemeral) + if self.level is not None: + result["level"] = from_union([lambda x: to_enum(SessionLogLevel, x), from_none], self.level) + if self.tip is not None: + result["tip"] = from_union([from_str, from_none], self.tip) + if self.type is not None: + result["type"] = from_union([from_str, from_none], self.type) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class APIKeyAuthInfo: - """Schema for the `ApiKeyAuthInfo` type.""" +class MarketplaceListResult: + """All registered marketplaces, including built-in defaults.""" - api_key: str - """The API key. Treat as a secret.""" + marketplaces: list[MarketplaceInfo] + """Registered marketplaces""" - host: str - """Authentication host.""" + @staticmethod + def from_dict(obj: Any) -> 'MarketplaceListResult': + assert isinstance(obj, dict) + marketplaces = from_list(MarketplaceInfo.from_dict, obj.get("marketplaces")) + return MarketplaceListResult(marketplaces) - type: ClassVar[str] = "api-key" - """API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style).""" + def to_dict(self) -> dict: + result: dict = {} + result["marketplaces"] = from_list(lambda x: to_class(MarketplaceInfo, x), self.marketplaces) + return result - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MarketplaceRefreshResult: + """Result of refreshing one or more marketplace catalogs.""" + + results: list[MarketplaceRefreshEntry] + """Per-marketplace refresh results in deterministic order.""" @staticmethod - def from_dict(obj: Any) -> 'APIKeyAuthInfo': + def from_dict(obj: Any) -> 'MarketplaceRefreshResult': assert isinstance(obj, dict) - api_key = from_str(obj.get("apiKey")) - host = from_str(obj.get("host")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return APIKeyAuthInfo(api_key, host, copilot_user) + results = from_list(MarketplaceRefreshEntry.from_dict, obj.get("results")) + return MarketplaceRefreshResult(results) def to_dict(self) -> dict: result: dict = {} - result["apiKey"] = from_str(self.api_key) - result["host"] = from_str(self.host) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + result["results"] = from_list(lambda x: to_class(MarketplaceRefreshEntry, x), self.results) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CopilotAPITokenAuthInfo: - """Schema for the `CopilotApiTokenAuthInfo` type.""" +class MCPAppsDiagnoseResult: + """Diagnostic snapshot of MCP Apps wiring for the named server.""" - host: Host - """Authentication host (always the public GitHub host).""" + capability: MCPAppsDiagnoseCapability + """Capability negotiation snapshot""" - type: ClassVar[str] = "copilot-api-token" - """Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` - environment-variable pair. The token itself is read from the environment by the runtime, - not carried in this struct. - """ - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ + server: MCPAppsDiagnoseServer + """What the server returned for this session""" @staticmethod - def from_dict(obj: Any) -> 'CopilotAPITokenAuthInfo': + def from_dict(obj: Any) -> 'MCPAppsDiagnoseResult': assert isinstance(obj, dict) - host = Host(obj.get("host")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return CopilotAPITokenAuthInfo(host, copilot_user) + capability = MCPAppsDiagnoseCapability.from_dict(obj.get("capability")) + server = MCPAppsDiagnoseServer.from_dict(obj.get("server")) + return MCPAppsDiagnoseResult(capability, server) def to_dict(self) -> dict: result: dict = {} - result["host"] = to_enum(Host, self.host) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + result["capability"] = to_class(MCPAppsDiagnoseCapability, self.capability) + result["server"] = to_class(MCPAppsDiagnoseServer, self.server) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class EnvAuthInfo: - """Schema for the `EnvAuthInfo` type.""" +class MCPAppsHostContextDetails: + """Current host context""" - env_var: str - """Name of the environment variable the token was sourced from.""" + available_display_modes: list[MCPAppsDisplayMode] | None = None + """Display modes the host supports""" - host: str - """Authentication host (e.g. https://github.com or a GHES host).""" + display_mode: MCPAppsDisplayMode | None = None + """Current display mode (SEP-1865)""" - token: str - """The token value itself. Treat as a secret.""" + locale: str | None = None + """BCP-47 locale, e.g. 'en-US'""" - type: ClassVar[str] = "env" - """Personal access token (PAT) or server-to-server token sourced from an environment - variable. - """ - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ - login: str | None = None - """User login associated with the token. Undefined for server-to-server tokens (those - starting with `ghs_`). - """ + platform: MCPAppsHostContextDetailsPlatform | None = None + """Platform type for responsive design""" + + theme: Theme | None = None + """UI theme preference per SEP-1865""" + + time_zone: str | None = None + """IANA timezone, e.g. 'America/New_York'""" + + user_agent: str | None = None + """Host application identifier""" @staticmethod - def from_dict(obj: Any) -> 'EnvAuthInfo': + def from_dict(obj: Any) -> 'MCPAppsHostContextDetails': assert isinstance(obj, dict) - env_var = from_str(obj.get("envVar")) - host = from_str(obj.get("host")) - token = from_str(obj.get("token")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - login = from_union([from_str, from_none], obj.get("login")) - return EnvAuthInfo(env_var, host, token, copilot_user, login) + available_display_modes = from_union([lambda x: from_list(MCPAppsDisplayMode, x), from_none], obj.get("availableDisplayModes")) + display_mode = from_union([MCPAppsDisplayMode, from_none], obj.get("displayMode")) + locale = from_union([from_str, from_none], obj.get("locale")) + platform = from_union([MCPAppsHostContextDetailsPlatform, from_none], obj.get("platform")) + theme = from_union([Theme, from_none], obj.get("theme")) + time_zone = from_union([from_str, from_none], obj.get("timeZone")) + user_agent = from_union([from_str, from_none], obj.get("userAgent")) + return MCPAppsHostContextDetails(available_display_modes, display_mode, locale, platform, theme, time_zone, user_agent) def to_dict(self) -> dict: result: dict = {} - result["envVar"] = from_str(self.env_var) - result["host"] = from_str(self.host) - result["token"] = from_str(self.token) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) - if self.login is not None: - result["login"] = from_union([from_str, from_none], self.login) + if self.available_display_modes is not None: + result["availableDisplayModes"] = from_union([lambda x: from_list(lambda x: to_enum(MCPAppsDisplayMode, x), x), from_none], self.available_display_modes) + if self.display_mode is not None: + result["displayMode"] = from_union([lambda x: to_enum(MCPAppsDisplayMode, x), from_none], self.display_mode) + if self.locale is not None: + result["locale"] = from_union([from_str, from_none], self.locale) + if self.platform is not None: + result["platform"] = from_union([lambda x: to_enum(MCPAppsHostContextDetailsPlatform, x), from_none], self.platform) + if self.theme is not None: + result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) + if self.time_zone is not None: + result["timeZone"] = from_union([from_str, from_none], self.time_zone) + if self.user_agent is not None: + result["userAgent"] = from_union([from_str, from_none], self.user_agent) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class GhCLIAuthInfo: - """Schema for the `GhCliAuthInfo` type.""" +class MCPAppsSetHostContextDetails: + """Host context advertised to MCP App guests""" - host: str - """Authentication host.""" + available_display_modes: list[MCPAppsDisplayMode] | None = None + """Display modes the host supports""" - login: str - """User login as reported by `gh auth status`.""" + display_mode: MCPAppsDisplayMode | None = None + """Current display mode (SEP-1865)""" - token: str - """The token returned by `gh auth token`. Treat as a secret.""" + locale: str | None = None + """BCP-47 locale, e.g. 'en-US'""" - type: ClassVar[str] = "gh-cli" - """Authentication via the `gh` CLI's saved credentials.""" + platform: MCPAppsHostContextDetailsPlatform | None = None + """Platform type for responsive design""" - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ + theme: Theme | None = None + """UI theme preference per SEP-1865""" + + time_zone: str | None = None + """IANA timezone, e.g. 'America/New_York'""" + + user_agent: str | None = None + """Host application identifier""" @staticmethod - def from_dict(obj: Any) -> 'GhCLIAuthInfo': + def from_dict(obj: Any) -> 'MCPAppsSetHostContextDetails': assert isinstance(obj, dict) - host = from_str(obj.get("host")) - login = from_str(obj.get("login")) - token = from_str(obj.get("token")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return GhCLIAuthInfo(host, login, token, copilot_user) + available_display_modes = from_union([lambda x: from_list(MCPAppsDisplayMode, x), from_none], obj.get("availableDisplayModes")) + display_mode = from_union([MCPAppsDisplayMode, from_none], obj.get("displayMode")) + locale = from_union([from_str, from_none], obj.get("locale")) + platform = from_union([MCPAppsHostContextDetailsPlatform, from_none], obj.get("platform")) + theme = from_union([Theme, from_none], obj.get("theme")) + time_zone = from_union([from_str, from_none], obj.get("timeZone")) + user_agent = from_union([from_str, from_none], obj.get("userAgent")) + return MCPAppsSetHostContextDetails(available_display_modes, display_mode, locale, platform, theme, time_zone, user_agent) def to_dict(self) -> dict: result: dict = {} - result["host"] = from_str(self.host) - result["login"] = from_str(self.login) - result["token"] = from_str(self.token) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + if self.available_display_modes is not None: + result["availableDisplayModes"] = from_union([lambda x: from_list(lambda x: to_enum(MCPAppsDisplayMode, x), x), from_none], self.available_display_modes) + if self.display_mode is not None: + result["displayMode"] = from_union([lambda x: to_enum(MCPAppsDisplayMode, x), from_none], self.display_mode) + if self.locale is not None: + result["locale"] = from_union([from_str, from_none], self.locale) + if self.platform is not None: + result["platform"] = from_union([lambda x: to_enum(MCPAppsHostContextDetailsPlatform, x), from_none], self.platform) + if self.theme is not None: + result["theme"] = from_union([lambda x: to_enum(Theme, x), from_none], self.theme) + if self.time_zone is not None: + result["timeZone"] = from_union([from_str, from_none], self.time_zone) + if self.user_agent is not None: + result["userAgent"] = from_union([from_str, from_none], self.user_agent) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HMACAuthInfo: - """Schema for the `HMACAuthInfo` type.""" - - hmac: str - """HMAC secret used to sign requests.""" - - host: Host - """Authentication host. HMAC auth always targets the public GitHub host.""" - - type: ClassVar[str] = "hmac" - """HMAC-based authentication used by GitHub-internal services.""" +class MCPAppsReadResourceResult: + """Resource contents returned by the MCP server.""" - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. - """ + contents: list[MCPAppsResourceContent] + """Resource contents returned by the server""" @staticmethod - def from_dict(obj: Any) -> 'HMACAuthInfo': + def from_dict(obj: Any) -> 'MCPAppsReadResourceResult': assert isinstance(obj, dict) - hmac = from_str(obj.get("hmac")) - host = Host(obj.get("host")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return HMACAuthInfo(hmac, host, copilot_user) + contents = from_list(MCPAppsResourceContent.from_dict, obj.get("contents")) + return MCPAppsReadResourceResult(contents) def to_dict(self) -> dict: result: dict = {} - result["hmac"] = from_str(self.hmac) - result["host"] = to_enum(Host, self.host) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + result["contents"] = from_list(lambda x: to_class(MCPAppsResourceContent, x), self.contents) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TokenAuthInfo: - """Schema for the `TokenAuthInfo` type.""" +class MCPServerConfigStdio: + """Stdio MCP server configuration launched as a child process.""" - host: str - """Authentication host.""" + command: str + """Executable command used to start the Stdio MCP server process.""" - token: str - """The token value itself. Treat as a secret.""" + args: list[str] | None = None + """Command-line arguments passed to the Stdio MCP server process.""" - type: ClassVar[str] = "token" - """SDK-side token authentication; the host configured the token directly via the SDK.""" + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. + cwd: str | None = None + """Working directory for the Stdio MCP server process.""" + + defer_tools: MCPServerConfigDeferTools | None = None + """Controls if tools provided by this server can be loaded on demand via tool search (auto) + or always included in the initial tool list (never) + """ + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + env: dict[str, str] | None = None + """Environment variables to pass to the Stdio MCP server process.""" + + filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None + """Content filtering mode to apply to all tools, or a map of tool name to content filtering + mode. + """ + is_default_server: bool | None = None + """Whether this server is a built-in fallback used when the user has not configured their + own server. """ + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" + + timeout: int | None = None + """Timeout in milliseconds for tool calls to this server.""" + + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" @staticmethod - def from_dict(obj: Any) -> 'TokenAuthInfo': + def from_dict(obj: Any) -> 'MCPServerConfigStdio': assert isinstance(obj, dict) - host = from_str(obj.get("host")) - token = from_str(obj.get("token")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return TokenAuthInfo(host, token, copilot_user) + command = from_str(obj.get("command")) + args = from_union([lambda x: from_list(from_str, x), from_none], obj.get("args")) + auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) + filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) + is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + timeout = from_union([from_int, from_none], obj.get("timeout")) + tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) + return MCPServerConfigStdio(command, args, auth, cwd, defer_tools, disable_tool_cache, env, filter_mapping, is_default_server, oidc, timeout, tools) def to_dict(self) -> dict: result: dict = {} - result["host"] = from_str(self.host) - result["token"] = from_str(self.token) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + result["command"] = from_str(self.command) + if self.args is not None: + result["args"] = from_union([lambda x: from_list(from_str, x), from_none], self.args) + if self.auth is not None: + result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.defer_tools is not None: + result["deferTools"] = from_union([lambda x: to_enum(MCPServerConfigDeferTools, x), from_none], self.defer_tools) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.env is not None: + result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) + if self.filter_mapping is not None: + result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) + if self.is_default_server is not None: + result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.timeout is not None: + result["timeout"] = from_union([from_int, from_none], self.timeout) + if self.tools is not None: + result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UserAuthInfo: - """Schema for the `UserAuthInfo` type.""" - - host: str - """Authentication host.""" - - login: str - """OAuth user login.""" - - type: ClassVar[str] = "user" - """OAuth user authentication. The token itself is held in the runtime's secret token store - (keyed by host+login) and is NOT carried in this struct. +class MCPOauthLoginRequest: + """Remote MCP server name and optional overrides controlling reauthentication, OAuth client + display name, callback success-page copy, and static OAuth client selection. """ - copilot_user: CopilotUserResponse | None = None - """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the - GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this - verbatim and does not re-fetch when set. + server_name: str + """Name of the remote MCP server to authenticate""" + + callback_success_message: str | None = None + """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. + """ + client_id: str | None = None + """Optional OAuth client ID override for this login. When set, the runtime uses this + pre-registered static client instead of dynamic client registration. + """ + client_name: str | None = None + """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. + """ + client_secret: str | None = None + """Optional OAuth client secret override for this login. The runtime treats this as an + ephemeral host-owned secret, uses it for this authentication attempt and does not persist + it. + """ + force_reauth: bool | None = None + """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. + """ + grant_type: MCPGrantType | None = None + """Optional OAuth grant type override for this login. Defaults to the server configuration, + or authorization_code when no grant type is specified. + """ + public_client: bool | None = None + """Optional override indicating whether the static OAuth client is public. When false, the + runtime treats it as confidential and uses the per-login clientSecret if provided, + otherwise retrieving the client secret from the MCP OAuth secret store. """ @staticmethod - def from_dict(obj: Any) -> 'UserAuthInfo': + def from_dict(obj: Any) -> 'MCPOauthLoginRequest': assert isinstance(obj, dict) - host = from_str(obj.get("host")) - login = from_str(obj.get("login")) - copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) - return UserAuthInfo(host, login, copilot_user) + server_name = from_str(obj.get("serverName")) + callback_success_message = from_union([from_str, from_none], obj.get("callbackSuccessMessage")) + client_id = from_union([from_str, from_none], obj.get("clientId")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + client_secret = from_union([from_str, from_none], obj.get("clientSecret")) + force_reauth = from_union([from_bool, from_none], obj.get("forceReauth")) + grant_type = from_union([MCPGrantType, from_none], obj.get("grantType")) + public_client = from_union([from_bool, from_none], obj.get("publicClient")) + return MCPOauthLoginRequest(server_name, callback_success_message, client_id, client_name, client_secret, force_reauth, grant_type, public_client) def to_dict(self) -> dict: result: dict = {} - result["host"] = from_str(self.host) - result["login"] = from_str(self.login) - result["type"] = self.type - if self.copilot_user is not None: - result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + result["serverName"] = from_str(self.server_name) + if self.callback_success_message is not None: + result["callbackSuccessMessage"] = from_union([from_str, from_none], self.callback_success_message) + if self.client_id is not None: + result["clientId"] = from_union([from_str, from_none], self.client_id) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.client_secret is not None: + result["clientSecret"] = from_union([from_str, from_none], self.client_secret) + if self.force_reauth is not None: + result["forceReauth"] = from_union([from_bool, from_none], self.force_reauth) + if self.grant_type is not None: + result["grantType"] = from_union([lambda x: to_enum(MCPGrantType, x), from_none], self.grant_type) + if self.public_client is not None: + result["publicClient"] = from_union([from_bool, from_none], self.public_client) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionDecisionApproveForIonApproval: - """Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) - - Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type. - - Schema for the `PermissionDecisionApproveForSessionApprovalRead` type. - - Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type. +class MCPServerConfig: + """MCP server configuration (stdio process or remote HTTP/SSE) - Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type. + Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart + the server with its already-registered configuration (config-free restart-by-name). - Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type. + MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server + with its already-registered configuration (config-free start-by-name). - Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type. + Stdio MCP server configuration launched as a child process. - Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type. + Remote MCP server configuration accessed over HTTP or SSE. + """ + args: list[str] | None = None + """Command-line arguments passed to the Stdio MCP server process.""" - Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type. + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` - type. + command: str | None = None + """Executable command used to start the Stdio MCP server process.""" - Approval to persist for this location + cwd: str | None = None + """Working directory for the Stdio MCP server process.""" - Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type. + defer_tools: MCPServerConfigDeferTools | None = None + """Controls if tools provided by this server can be loaded on demand via tool search (auto) + or always included in the initial tool list (never) + """ + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + env: dict[str, str] | None = None + """Environment variables to pass to the Stdio MCP server process.""" - Schema for the `PermissionDecisionApproveForLocationApprovalRead` type. + filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None + """Content filtering mode to apply to all tools, or a map of tool name to content filtering + mode. + """ + is_default_server: bool | None = None + """Whether this server is a built-in fallback used when the user has not configured their + own server. + """ + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type. + timeout: int | None = None + """Timeout in milliseconds for tool calls to this server.""" - Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type. + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" - Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type. + headers: dict[str, str] | None = None + """HTTP headers to include in requests to the remote MCP server.""" - Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type. + oauth_client_id: str | None = None + """OAuth client ID for a pre-registered remote MCP OAuth client.""" - Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type. + oauth_grant_type: MCPGrantType | None = None + """OAuth grant type to use when authenticating to the remote MCP server.""" - Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type. + oauth_public_client: bool | None = None + """Whether the configured OAuth client is public and does not require a client secret.""" - Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` - type. + type: MCPServerConfigHTTPType | None = None + """Remote transport type. Defaults to "http" when omitted.""" - The approval to add as a session-scoped rule + url: str | None = None + """URL of the remote MCP server endpoint.""" - The approval to persist for this location - """ - command_identifiers: list[str] | None = None - """Command identifiers covered by this approval.""" + @staticmethod + def from_dict(obj: Any) -> 'MCPServerConfig': + assert isinstance(obj, dict) + args = from_union([lambda x: from_list(from_str, x), from_none], obj.get("args")) + auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) + command = from_union([from_str, from_none], obj.get("command")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("env")) + filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) + is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + timeout = from_union([from_int, from_none], obj.get("timeout")) + tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + oauth_client_id = from_union([from_str, from_none], obj.get("oauthClientId")) + oauth_grant_type = from_union([MCPGrantType, from_none], obj.get("oauthGrantType")) + oauth_public_client = from_union([from_bool, from_none], obj.get("oauthPublicClient")) + type = from_union([MCPServerConfigHTTPType, from_none], obj.get("type")) + url = from_union([from_str, from_none], obj.get("url")) + return MCPServerConfig(args, auth, command, cwd, defer_tools, disable_tool_cache, env, filter_mapping, is_default_server, oidc, timeout, tools, headers, oauth_client_id, oauth_grant_type, oauth_public_client, type, url) - kind: ApprovalKind | None = None - """Approval scoped to specific command identifiers. + def to_dict(self) -> dict: + result: dict = {} + if self.args is not None: + result["args"] = from_union([lambda x: from_list(from_str, x), from_none], self.args) + if self.auth is not None: + result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) + if self.command is not None: + result["command"] = from_union([from_str, from_none], self.command) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.defer_tools is not None: + result["deferTools"] = from_union([lambda x: to_enum(MCPServerConfigDeferTools, x), from_none], self.defer_tools) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.env is not None: + result["env"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env) + if self.filter_mapping is not None: + result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) + if self.is_default_server is not None: + result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.timeout is not None: + result["timeout"] = from_union([from_int, from_none], self.timeout) + if self.tools is not None: + result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.oauth_client_id is not None: + result["oauthClientId"] = from_union([from_str, from_none], self.oauth_client_id) + if self.oauth_grant_type is not None: + result["oauthGrantType"] = from_union([lambda x: to_enum(MCPGrantType, x), from_none], self.oauth_grant_type) + if self.oauth_public_client is not None: + result["oauthPublicClient"] = from_union([from_bool, from_none], self.oauth_public_client) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(MCPServerConfigHTTPType, x), from_none], self.type) + if self.url is not None: + result["url"] = from_union([from_str, from_none], self.url) + return result - Approval covering read-only filesystem operations. +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerConfigHTTP: + """Remote MCP server configuration accessed over HTTP or SSE.""" - Approval covering filesystem write operations. + url: str + """URL of the remote MCP server endpoint.""" - Approval covering an MCP tool. + auth: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - Approval covering MCP sampling requests for a server. + defer_tools: MCPServerConfigDeferTools | None = None + """Controls if tools provided by this server can be loaded on demand via tool search (auto) + or always included in the initial tool list (never) + """ + disable_tool_cache: bool | None = None + """Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery + is unaffected. + """ + filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode | None = None + """Content filtering mode to apply to all tools, or a map of tool name to content filtering + mode. + """ + headers: dict[str, str] | None = None + """HTTP headers to include in requests to the remote MCP server.""" - Approval covering writes to long-term memory. + is_default_server: bool | None = None + """Whether this server is a built-in fallback used when the user has not configured their + own server. + """ + oauth_client_id: str | None = None + """OAuth client ID for a pre-registered remote MCP OAuth client.""" - Approval covering a custom tool. + oauth_grant_type: MCPGrantType | None = None + """OAuth grant type to use when authenticating to the remote MCP server.""" - Approval covering extension lifecycle operations such as enable, disable, or reload. + oauth_public_client: bool | None = None + """Whether the configured OAuth client is public and does not require a client secret.""" - Approval covering an extension's request to access a permission-gated capability. - """ - server_name: str | None = None - """MCP server name.""" + oidc: bool | MCPServerAuthConfigRedirectPort | None = None + """Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.""" - tool_name: str | None = None - """MCP tool name, or null to cover every tool on the server. + timeout: int | None = None + """Timeout in milliseconds for tool calls to this server.""" - Custom tool name. - """ - operation: str | None = None - """Optional operation identifier; when omitted, the approval covers all extension management - operations. - """ - extension_name: str | None = None - """Extension name.""" + tools: list[str] | None = None + """Tools to include. Defaults to all tools if not specified.""" - external_ref_marker_external_ref_user_tool_session_approval: str | None = None + type: MCPServerConfigHTTPType | None = None + """Remote transport type. Defaults to "http" when omitted.""" @staticmethod - def from_dict(obj: Any) -> 'PermissionDecisionApproveForIonApproval': + def from_dict(obj: Any) -> 'MCPServerConfigHTTP': assert isinstance(obj, dict) - command_identifiers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("commandIdentifiers")) - kind = from_union([ApprovalKind, from_none], obj.get("kind")) - server_name = from_union([from_str, from_none], obj.get("serverName")) - tool_name = from_union([from_none, from_str], obj.get("toolName")) - operation = from_union([from_str, from_none], obj.get("operation")) - extension_name = from_union([from_str, from_none], obj.get("extensionName")) - external_ref_marker_external_ref_user_tool_session_approval = from_union([from_str, from_none], obj.get("__externalRefMarker___ExternalRef_UserToolSessionApproval")) - return PermissionDecisionApproveForIonApproval(command_identifiers, kind, server_name, tool_name, operation, extension_name, external_ref_marker_external_ref_user_tool_session_approval) + url = from_str(obj.get("url")) + auth = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("auth")) + defer_tools = from_union([MCPServerConfigDeferTools, from_none], obj.get("deferTools")) + disable_tool_cache = from_union([from_bool, from_none], obj.get("disableToolCache")) + filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode, from_none], obj.get("filterMapping")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + is_default_server = from_union([from_bool, from_none], obj.get("isDefaultServer")) + oauth_client_id = from_union([from_str, from_none], obj.get("oauthClientId")) + oauth_grant_type = from_union([MCPGrantType, from_none], obj.get("oauthGrantType")) + oauth_public_client = from_union([from_bool, from_none], obj.get("oauthPublicClient")) + oidc = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict, from_none], obj.get("oidc")) + timeout = from_union([from_int, from_none], obj.get("timeout")) + tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) + type = from_union([MCPServerConfigHTTPType, from_none], obj.get("type")) + return MCPServerConfigHTTP(url, auth, defer_tools, disable_tool_cache, filter_mapping, headers, is_default_server, oauth_client_id, oauth_grant_type, oauth_public_client, oidc, timeout, tools, type) def to_dict(self) -> dict: result: dict = {} - if self.command_identifiers is not None: - result["commandIdentifiers"] = from_union([lambda x: from_list(from_str, x), from_none], self.command_identifiers) - if self.kind is not None: - result["kind"] = from_union([lambda x: to_enum(ApprovalKind, x), from_none], self.kind) - if self.server_name is not None: - result["serverName"] = from_union([from_str, from_none], self.server_name) - if self.tool_name is not None: - result["toolName"] = from_union([from_none, from_str], self.tool_name) - if self.operation is not None: - result["operation"] = from_union([from_str, from_none], self.operation) - if self.extension_name is not None: - result["extensionName"] = from_union([from_str, from_none], self.extension_name) - if self.external_ref_marker_external_ref_user_tool_session_approval is not None: - result["__externalRefMarker___ExternalRef_UserToolSessionApproval"] = from_union([from_str, from_none], self.external_ref_marker_external_ref_user_tool_session_approval) + result["url"] = from_str(self.url) + if self.auth is not None: + result["auth"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.auth) + if self.defer_tools is not None: + result["deferTools"] = from_union([lambda x: to_enum(MCPServerConfigDeferTools, x), from_none], self.defer_tools) + if self.disable_tool_cache is not None: + result["disableToolCache"] = from_union([from_bool, from_none], self.disable_tool_cache) + if self.filter_mapping is not None: + result["filterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x), from_none], self.filter_mapping) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.is_default_server is not None: + result["isDefaultServer"] = from_union([from_bool, from_none], self.is_default_server) + if self.oauth_client_id is not None: + result["oauthClientId"] = from_union([from_str, from_none], self.oauth_client_id) + if self.oauth_grant_type is not None: + result["oauthGrantType"] = from_union([lambda x: to_enum(MCPGrantType, x), from_none], self.oauth_grant_type) + if self.oauth_public_client is not None: + result["oauthPublicClient"] = from_union([from_bool, from_none], self.oauth_public_client) + if self.oidc is not None: + result["oidc"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x), from_none], self.oidc) + if self.timeout is not None: + result["timeout"] = from_union([from_int, from_none], self.timeout) + if self.tools is not None: + result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(MCPServerConfigHTTPType, x), from_none], self.type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class HandlePendingToolCallRequest: - """Pending external tool call request ID, with the tool result or an error describing why it - failed. - """ - request_id: str - """Request ID of the pending tool call""" +class MCPStartServersResult: + """MCP server startup filtering result.""" - error: str | None = None - """Error message if the tool call failed""" + filtered_servers: list[MCPFilteredServer] + """Servers filtered out before startup""" - result: ExternalToolTextResultForLlm | str | None = None - """Tool call result (string or expanded result object)""" + allowed_servers: list[MCPAllowedServer] | None = None + """Non-default servers allowed by policy""" @staticmethod - def from_dict(obj: Any) -> 'HandlePendingToolCallRequest': + def from_dict(obj: Any) -> 'MCPStartServersResult': assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - error = from_union([from_str, from_none], obj.get("error")) - result = from_union([ExternalToolTextResultForLlm.from_dict, from_str, from_none], obj.get("result")) - return HandlePendingToolCallRequest(request_id, error, result) + filtered_servers = from_list(MCPFilteredServer.from_dict, obj.get("filteredServers")) + allowed_servers = from_union([lambda x: from_list(MCPAllowedServer.from_dict, x), from_none], obj.get("allowedServers")) + return MCPStartServersResult(filtered_servers, allowed_servers) def to_dict(self) -> dict: result: dict = {} - result["requestId"] = from_str(self.request_id) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) - if self.result is not None: - result["result"] = from_union([lambda x: to_class(ExternalToolTextResultForLlm, x), from_str, from_none], self.result) + result["filteredServers"] = from_list(lambda x: to_class(MCPFilteredServer, x), self.filtered_servers) + if self.allowed_servers is not None: + result["allowedServers"] = from_union([lambda x: from_list(lambda x: to_class(MCPAllowedServer, x), x), from_none], self.allowed_servers) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class InstalledPlugin: - """Schema for the `InstalledPlugin` type.""" +class MCPHeadersHandlePendingHeadersRefreshRequest: + """Host response: supply dynamic headers or decline this refresh.""" - enabled: bool - """Whether the plugin is currently enabled""" + kind: MCPHeadersHandlePendingHeadersRefreshRequestKind + headers: dict[str, str] | None = None + """Headers to overlay onto the MCP request. Dynamic headers override static config headers + but do not replace SDK-managed request headers. + """ - installed_at: str - """Installation timestamp""" + @staticmethod + def from_dict(obj: Any) -> 'MCPHeadersHandlePendingHeadersRefreshRequest': + assert isinstance(obj, dict) + kind = MCPHeadersHandlePendingHeadersRefreshRequestKind(obj.get("kind")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + return MCPHeadersHandlePendingHeadersRefreshRequest(kind, headers) - marketplace: str - """Marketplace the plugin came from (empty string for direct repo installs)""" + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(MCPHeadersHandlePendingHeadersRefreshRequestKind, self.kind) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + return result - name: str - """Plugin name""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPHostState: + """Host-level state, omitted when no MCP host is initialized.""" - cache_path: str | None = None - """Path where the plugin is cached locally""" + clients: list[str] + """Names of currently-connected MCP clients.""" - source: InstalledPluginSource | str | None = None - """Source for direct repo installs (when marketplace is empty)""" + disabled_servers: list[str] + """Configured servers that are explicitly disabled.""" - version: str | None = None - """Version installed (if available)""" + failed_servers: dict[str, MCPServerFailureInfo] + """Map of server name to recorded connection failure.""" + + filtered_servers: list[str] + """Configured servers filtered out by MCP server policy.""" + + mcp3_p_enabled: bool + """Whether third-party MCP servers are policy-enabled for this session.""" + + needs_auth_servers: dict[str, MCPServerNeedsAuthInfo] + """Map of server name to recorded pending-auth state.""" + + pending_connections: list[str] + """Names of servers with in-flight connection attempts.""" @staticmethod - def from_dict(obj: Any) -> 'InstalledPlugin': + def from_dict(obj: Any) -> 'MCPHostState': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - installed_at = from_str(obj.get("installed_at")) - marketplace = from_str(obj.get("marketplace")) - name = from_str(obj.get("name")) - cache_path = from_union([from_str, from_none], obj.get("cache_path")) - source = from_union([InstalledPluginSource.from_dict, from_str, from_none], obj.get("source")) - version = from_union([from_str, from_none], obj.get("version")) - return InstalledPlugin(enabled, installed_at, marketplace, name, cache_path, source, version) + clients = from_list(from_str, obj.get("clients")) + disabled_servers = from_list(from_str, obj.get("disabledServers")) + failed_servers = from_dict(MCPServerFailureInfo.from_dict, obj.get("failedServers")) + filtered_servers = from_list(from_str, obj.get("filteredServers")) + mcp3_p_enabled = from_bool(obj.get("mcp3pEnabled")) + needs_auth_servers = from_dict(MCPServerNeedsAuthInfo.from_dict, obj.get("needsAuthServers")) + pending_connections = from_list(from_str, obj.get("pendingConnections")) + return MCPHostState(clients, disabled_servers, failed_servers, filtered_servers, mcp3_p_enabled, needs_auth_servers, pending_connections) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - result["installed_at"] = from_str(self.installed_at) - result["marketplace"] = from_str(self.marketplace) - result["name"] = from_str(self.name) - if self.cache_path is not None: - result["cache_path"] = from_union([from_str, from_none], self.cache_path) - if self.source is not None: - result["source"] = from_union([lambda x: to_class(InstalledPluginSource, x), from_str, from_none], self.source) - if self.version is not None: - result["version"] = from_union([from_str, from_none], self.version) + result["clients"] = from_list(from_str, self.clients) + result["disabledServers"] = from_list(from_str, self.disabled_servers) + result["failedServers"] = from_dict(lambda x: to_class(MCPServerFailureInfo, x), self.failed_servers) + result["filteredServers"] = from_list(from_str, self.filtered_servers) + result["mcp3pEnabled"] = from_bool(self.mcp3_p_enabled) + result["needsAuthServers"] = from_dict(lambda x: to_class(MCPServerNeedsAuthInfo, x), self.needs_auth_servers) + result["pendingConnections"] = from_list(from_str, self.pending_connections) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionInstalledPlugin: - """Schema for the `SessionInstalledPlugin` type.""" +class MCPOauthPendingRequestResponse: + """Host response to the pending OAuth request.""" - enabled: bool - """Whether the plugin is currently enabled""" + kind: MCPOauthPendingRequestResponseKind + access_token: str | None = None + """Access token acquired by the SDK host""" - installed_at: str - """Installation timestamp (ISO-8601)""" + expires_in: int | None = None + """Token lifetime in seconds, if known.""" - marketplace: str - """Marketplace the plugin came from (empty string for direct repo installs)""" + token_type: str | None = None + """OAuth token type. Defaults to Bearer when omitted.""" - name: str - """Plugin name""" + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthPendingRequestResponse': + assert isinstance(obj, dict) + kind = MCPOauthPendingRequestResponseKind(obj.get("kind")) + access_token = from_union([from_str, from_none], obj.get("accessToken")) + expires_in = from_union([from_int, from_none], obj.get("expiresIn")) + token_type = from_union([from_str, from_none], obj.get("tokenType")) + return MCPOauthPendingRequestResponse(kind, access_token, expires_in, token_type) - cache_path: str | None = None - """Path where the plugin is cached locally""" + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(MCPOauthPendingRequestResponseKind, self.kind) + if self.access_token is not None: + result["accessToken"] = from_union([from_str, from_none], self.access_token) + if self.expires_in is not None: + result["expiresIn"] = from_union([from_int, from_none], self.expires_in) + if self.token_type is not None: + result["tokenType"] = from_union([from_str, from_none], self.token_type) + return result - source: SessionInstalledPluginSource | str | None = None - """Source descriptor for direct repo installs (when marketplace is empty)""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPResourcesReadResult: + """Resource contents returned by the MCP server.""" - version: str | None = None - """Installed version, if known""" + contents: list[MCPResourceContent] + """Resource contents returned by the server""" @staticmethod - def from_dict(obj: Any) -> 'SessionInstalledPlugin': + def from_dict(obj: Any) -> 'MCPResourcesReadResult': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - installed_at = from_str(obj.get("installed_at")) - marketplace = from_str(obj.get("marketplace")) - name = from_str(obj.get("name")) - cache_path = from_union([from_str, from_none], obj.get("cache_path")) - source = from_union([SessionInstalledPluginSource.from_dict, from_str, from_none], obj.get("source")) - version = from_union([from_str, from_none], obj.get("version")) - return SessionInstalledPlugin(enabled, installed_at, marketplace, name, cache_path, source, version) + contents = from_list(MCPResourceContent.from_dict, obj.get("contents")) + return MCPResourcesReadResult(contents) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - result["installed_at"] = from_str(self.installed_at) - result["marketplace"] = from_str(self.marketplace) - result["name"] = from_str(self.name) - if self.cache_path is not None: - result["cache_path"] = from_union([from_str, from_none], self.cache_path) - if self.source is not None: - result["source"] = from_union([lambda x: to_class(SessionInstalledPluginSource, x), from_str, from_none], self.source) - if self.version is not None: - result["version"] = from_union([from_str, from_none], self.version) + result["contents"] = from_list(lambda x: to_class(MCPResourceContent, x), self.contents) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionEnrichMetadataResult: - """The enriched metadata records, with summary and context fields backfilled where - available. Sessions confirmed empty and unnamed are omitted. +class MCPSamplingExecutionResult: + """Outcome of an MCP sampling execution: success result, failure error, or cancellation.""" + + action: MCPSamplingExecutionAction + """Outcome of the sampling inference. 'success' produced a response; 'failure' encountered + an error (including agent-side rejection by content filter or criteria); 'cancelled' the + caller cancelled this execution via cancelSamplingExecution. """ - sessions: list[SessionMetadata] - """Enriched records, with summary and context backfilled. Sessions confirmed empty and - unnamed may be omitted. + error: str | None = None + """Error description, present when action='failure'.""" + + result: dict[str, Any] | None = None + """MCP CreateMessageResult payload (with optional 'tools' extension), present when + action='success'. Treated as opaque at the schema layer; consumers should + construct/consume it per the MCP CreateMessageResult shape. """ @staticmethod - def from_dict(obj: Any) -> 'SessionEnrichMetadataResult': + def from_dict(obj: Any) -> 'MCPSamplingExecutionResult': assert isinstance(obj, dict) - sessions = from_list(SessionMetadata.from_dict, obj.get("sessions")) - return SessionEnrichMetadataResult(sessions) + action = MCPSamplingExecutionAction(obj.get("action")) + error = from_union([from_str, from_none], obj.get("error")) + result = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("result")) + return MCPSamplingExecutionResult(action, error, result) def to_dict(self) -> dict: result: dict = {} - result["sessions"] = from_list(lambda x: to_class(SessionMetadata, x), self.sessions) + result["action"] = to_enum(MCPSamplingExecutionAction, self.action) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.result is not None: + result["result"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.result) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionList: - """Persisted sessions matching the filter, ordered most-recently-modified first.""" +class MCPSetEnvValueModeParams: + """Mode controlling how MCP server env values are resolved (`direct` or `indirect`).""" - sessions: list[SessionMetadata] - """Sessions ordered most-recently-modified first""" + mode: MCPSetEnvValueModeDetails + """How environment-variable values supplied to MCP servers are resolved. "direct" passes + literal string values; "indirect" treats values as references (e.g. names of environment + variables on the host) that the runtime resolves before launch. Defaults to the runtime's + startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI + prompt mode and ACP) set this to "direct". + """ @staticmethod - def from_dict(obj: Any) -> 'SessionList': + def from_dict(obj: Any) -> 'MCPSetEnvValueModeParams': assert isinstance(obj, dict) - sessions = from_list(SessionMetadata.from_dict, obj.get("sessions")) - return SessionList(sessions) + mode = MCPSetEnvValueModeDetails(obj.get("mode")) + return MCPSetEnvValueModeParams(mode) def to_dict(self) -> dict: result: dict = {} - result["sessions"] = from_list(lambda x: to_class(SessionMetadata, x), self.sessions) + result["mode"] = to_enum(MCPSetEnvValueModeDetails, self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsEnrichMetadataRequest: - """Session metadata records to enrich with summary and context information.""" +class MCPSetEnvValueModeResult: + """Env-value mode recorded on the session after the update.""" - sessions: list[SessionMetadata] - """Session metadata records to enrich. Records that already have summary and context are - returned unchanged. - """ + mode: MCPSetEnvValueModeDetails + """Mode recorded on the session after the update""" @staticmethod - def from_dict(obj: Any) -> 'SessionsEnrichMetadataRequest': + def from_dict(obj: Any) -> 'MCPSetEnvValueModeResult': assert isinstance(obj, dict) - sessions = from_list(SessionMetadata.from_dict, obj.get("sessions")) - return SessionsEnrichMetadataRequest(sessions) + mode = MCPSetEnvValueModeDetails(obj.get("mode")) + return MCPSetEnvValueModeResult(mode) def to_dict(self) -> dict: result: dict = {} - result["sessions"] = from_list(lambda x: to_class(SessionMetadata, x), self.sessions) + result["mode"] = to_enum(MCPSetEnvValueModeDetails, self.mode) return result # Experimental: this type is part of an experimental API and may change or be removed. -@dataclass -class SessionMetadataSnapshot: - """Point-in-time snapshot of slow-changing session identifier and state fields""" +class DebugCollectLogsEntryKind(Enum): + """Kind of source path to include. - already_in_use: bool - """True when the session was detected to be in use by another process at construction time. - Local consumers may surface a confirmation prompt before fully attaching. Always false - for new sessions. + Kind of caller-provided debug log entry. + + Whether the target is a single file or a directory of instruction files + + Entry type """ - current_mode: MetadataSnapshotCurrentMode - """The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')""" + DIRECTORY = "directory" + FILE = "file" - is_remote: bool - """Whether this is a remote session (i.e., one whose runtime executes elsewhere and is - steered through this process) +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionContextAttribution: + """Per-source token attribution snapshot for the current context window. The heaviest + individual messages are available separately via `metadata.getContextHeaviestMessages`. """ - modified_time: datetime - """ISO 8601 timestamp of when the session's persisted state was last modified on disk. For - new sessions, equals startTime. For resumed sessions, reflects the previous modification - time at construction. + buffer_tokens: int + """Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors + `SessionContextInfo.bufferTokens`. """ - session_id: str - """The unique identifier of the session""" - - start_time: datetime - """ISO 8601 timestamp of when the session started""" - - working_directory: str - """Absolute path to the session's current working directory""" - - client_name: str | None = None - """Runtime client name associated with the session (telemetry identifier).""" + categories: Categories + """The six normalized `/context` header buckets, computed from the same tokenization as + `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` + describe window capacity rather than occupied context, so the values do not sum to + `totalTokens`. + """ + compactions: Compactions + """Successful compaction history for the session.""" - initial_name: str | None = None - """User-provided name supplied at session construction (via `--name`), if any. Immutable - after construction. + compaction_threshold: int + """Token count at which background compaction starts. Mirrors + `SessionContextInfo.compactionThreshold`. """ - remote_metadata: MetadataSnapshotRemoteMetadata | None = None - """Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are - immutable for the lifetime of the session. + entries: list[Entry] + """Flat list of per-source attribution entries. Group by `kind` and render unrecognized + kinds generically. Nesting and rollups are expressed via `parentId`. """ - selected_model: str | None = None - """Currently selected model identifier, if any""" - - summary: str | None = None - """Short human-readable summary of the session, if known. Omitted when no summary has been - generated. + limit: int + """Prompt limit plus the model's output reserve: the full context window + `categories.freeSpace` and `categories.buffer` are measured against. Mirrors + `SessionContextInfo.limit`. """ - workspace: WorkspaceSummary | None = None - """Public-facing workspace metadata for this session, or null if the session has no - associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, - internal flags). + model_id: str + """The concrete model id the entire breakdown was tokenized against (feeds the per-model + token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the + literal `auto` sentinel, so totals are not undercounted. A single-model approximation of + a potentially multi-model Auto session. """ - workspace_path: str | None = None - """Absolute path to the session's workspace directory on disk, or null if the session has no - associated workspace + model_source: str + """How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: + `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected + model), `default` (a fallback before any model is known). + """ + prompt_token_limit: int + """Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` + context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + """ + total_tokens: int + """Total token count of the current context window the entries are measured against (system + message + conversation messages + tool definitions — the same total reported by + /context). Divide an entry's `tokens` by this to derive its share. """ @staticmethod - def from_dict(obj: Any) -> 'SessionMetadataSnapshot': + def from_dict(obj: Any) -> 'SessionContextAttribution': assert isinstance(obj, dict) - already_in_use = from_bool(obj.get("alreadyInUse")) - current_mode = MetadataSnapshotCurrentMode(obj.get("currentMode")) - is_remote = from_bool(obj.get("isRemote")) - modified_time = from_datetime(obj.get("modifiedTime")) - session_id = from_str(obj.get("sessionId")) - start_time = from_datetime(obj.get("startTime")) - working_directory = from_str(obj.get("workingDirectory")) - client_name = from_union([from_str, from_none], obj.get("clientName")) - initial_name = from_union([from_str, from_none], obj.get("initialName")) - remote_metadata = from_union([MetadataSnapshotRemoteMetadata.from_dict, from_none], obj.get("remoteMetadata")) - selected_model = from_union([from_str, from_none], obj.get("selectedModel")) - summary = from_union([from_str, from_none], obj.get("summary")) - workspace = from_union([WorkspaceSummary.from_dict, from_none], obj.get("workspace")) - workspace_path = from_union([from_none, from_str], obj.get("workspacePath")) - return SessionMetadataSnapshot(already_in_use, current_mode, is_remote, modified_time, session_id, start_time, working_directory, client_name, initial_name, remote_metadata, selected_model, summary, workspace, workspace_path) + buffer_tokens = from_int(obj.get("bufferTokens")) + categories = Categories.from_dict(obj.get("categories")) + compactions = Compactions.from_dict(obj.get("compactions")) + compaction_threshold = from_int(obj.get("compactionThreshold")) + entries = from_list(Entry.from_dict, obj.get("entries")) + limit = from_int(obj.get("limit")) + model_id = from_str(obj.get("modelId")) + model_source = from_str(obj.get("modelSource")) + prompt_token_limit = from_int(obj.get("promptTokenLimit")) + total_tokens = from_int(obj.get("totalTokens")) + return SessionContextAttribution(buffer_tokens, categories, compactions, compaction_threshold, entries, limit, model_id, model_source, prompt_token_limit, total_tokens) def to_dict(self) -> dict: result: dict = {} - result["alreadyInUse"] = from_bool(self.already_in_use) - result["currentMode"] = to_enum(MetadataSnapshotCurrentMode, self.current_mode) - result["isRemote"] = from_bool(self.is_remote) - result["modifiedTime"] = self.modified_time.isoformat() - result["sessionId"] = from_str(self.session_id) - result["startTime"] = self.start_time.isoformat() - result["workingDirectory"] = from_str(self.working_directory) - if self.client_name is not None: - result["clientName"] = from_union([from_str, from_none], self.client_name) - if self.initial_name is not None: - result["initialName"] = from_union([from_str, from_none], self.initial_name) - if self.remote_metadata is not None: - result["remoteMetadata"] = from_union([lambda x: to_class(MetadataSnapshotRemoteMetadata, x), from_none], self.remote_metadata) - if self.selected_model is not None: - result["selectedModel"] = from_union([from_str, from_none], self.selected_model) - if self.summary is not None: - result["summary"] = from_union([from_str, from_none], self.summary) - if self.workspace is not None: - result["workspace"] = from_union([lambda x: to_class(WorkspaceSummary, x), from_none], self.workspace) - result["workspacePath"] = from_union([from_none, from_str], self.workspace_path) + result["bufferTokens"] = from_int(self.buffer_tokens) + result["categories"] = to_class(Categories, self.categories) + result["compactions"] = to_class(Compactions, self.compactions) + result["compactionThreshold"] = from_int(self.compaction_threshold) + result["entries"] = from_list(lambda x: to_class(Entry, x), self.entries) + result["limit"] = from_int(self.limit) + result["modelId"] = from_str(self.model_id) + result["modelSource"] = from_str(self.model_source) + result["promptTokenLimit"] = from_int(self.prompt_token_limit) + result["totalTokens"] = from_int(self.total_tokens) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsConfigureParams: - """Patch of permission policy fields to apply (omit a field to leave it unchanged).""" +class MetadataContextInfoResult: + """Token breakdown for the session's current context window, or null if uninitialized.""" - additional_content_exclusion_policies: list[PermissionsConfigureAdditionalContentExclusionPolicy] | None = None - """If specified, replaces the host-supplied GitHub Content Exclusion policies on the session - (combined with natively-discovered policies when evaluating tool/file access). Omit to - leave the current policies unchanged. - """ - approve_all_read_permission_requests: bool | None = None - """If specified, sets whether path/URL read permission requests are auto-approved. Omit to - leave the current value unchanged. - """ - approve_all_tool_permission_requests: bool | None = None - """If specified, sets whether tool permission requests are auto-approved without prompting. - Omit to leave the current value unchanged. + context_info: SessionContextInfo | None = None + """Token breakdown for the current context window, or null if the session has not yet been + initialized (no system prompt or tool metadata cached). """ - paths: PermissionPathsConfig | None = None - """If specified, replaces the session's path-permission policy. The runtime constructs the - appropriate PathManager based on these inputs (rooted at the session's working - directory). Omit to leave the current path policy unchanged. + + @staticmethod + def from_dict(obj: Any) -> 'MetadataContextInfoResult': + assert isinstance(obj, dict) + context_info = from_union([SessionContextInfo.from_dict, from_none], obj.get("contextInfo")) + return MetadataContextInfoResult(context_info) + + def to_dict(self) -> dict: + result: dict = {} + if self.context_info is not None: + result["contextInfo"] = from_union([lambda x: to_class(SessionContextInfo, x), from_none], self.context_info) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MetadataSnapshotRemoteMetadata: + """Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are + immutable for the lifetime of the session. """ - rules: PermissionRulesSet | None = None - """If specified, replaces the session's approved/denied permission rules. Omit to leave the - current rules unchanged. + repository: MetadataSnapshotRemoteMetadataRepository + """The repository the remote session targets.""" + + pull_request_number: int | None = None + """The pull request number the remote session is associated with, if any.""" + + resource_id: str | None = None + """The original resource identifier (task ID or PR node ID), preserved across event-replay + reconstructions. Falls back to `sessionId` when absent. """ - urls: PermissionUrlsConfig | None = None - """If specified, replaces the session's URL-permission policy. The runtime constructs a - fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy - unchanged. + task_type: TaskType | None = None + """Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` + invocation. """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsConfigureParams': + def from_dict(obj: Any) -> 'MetadataSnapshotRemoteMetadata': assert isinstance(obj, dict) - additional_content_exclusion_policies = from_union([lambda x: from_list(PermissionsConfigureAdditionalContentExclusionPolicy.from_dict, x), from_none], obj.get("additionalContentExclusionPolicies")) - approve_all_read_permission_requests = from_union([from_bool, from_none], obj.get("approveAllReadPermissionRequests")) - approve_all_tool_permission_requests = from_union([from_bool, from_none], obj.get("approveAllToolPermissionRequests")) - paths = from_union([PermissionPathsConfig.from_dict, from_none], obj.get("paths")) - rules = from_union([PermissionRulesSet.from_dict, from_none], obj.get("rules")) - urls = from_union([PermissionUrlsConfig.from_dict, from_none], obj.get("urls")) - return PermissionsConfigureParams(additional_content_exclusion_policies, approve_all_read_permission_requests, approve_all_tool_permission_requests, paths, rules, urls) + repository = MetadataSnapshotRemoteMetadataRepository.from_dict(obj.get("repository")) + pull_request_number = from_union([from_int, from_none], obj.get("pullRequestNumber")) + resource_id = from_union([from_str, from_none], obj.get("resourceId")) + task_type = from_union([TaskType, from_none], obj.get("taskType")) + return MetadataSnapshotRemoteMetadata(repository, pull_request_number, resource_id, task_type) def to_dict(self) -> dict: result: dict = {} - if self.additional_content_exclusion_policies is not None: - result["additionalContentExclusionPolicies"] = from_union([lambda x: from_list(lambda x: to_class(PermissionsConfigureAdditionalContentExclusionPolicy, x), x), from_none], self.additional_content_exclusion_policies) - if self.approve_all_read_permission_requests is not None: - result["approveAllReadPermissionRequests"] = from_union([from_bool, from_none], self.approve_all_read_permission_requests) - if self.approve_all_tool_permission_requests is not None: - result["approveAllToolPermissionRequests"] = from_union([from_bool, from_none], self.approve_all_tool_permission_requests) - if self.paths is not None: - result["paths"] = from_union([lambda x: to_class(PermissionPathsConfig, x), from_none], self.paths) - if self.rules is not None: - result["rules"] = from_union([lambda x: to_class(PermissionRulesSet, x), from_none], self.rules) - if self.urls is not None: - result["urls"] = from_union([lambda x: to_class(PermissionUrlsConfig, x), from_none], self.urls) + result["repository"] = to_class(MetadataSnapshotRemoteMetadataRepository, self.repository) + if self.pull_request_number is not None: + result["pullRequestNumber"] = from_union([from_int, from_none], self.pull_request_number) + if self.resource_id is not None: + result["resourceId"] = from_union([from_str, from_none], self.resource_id) + if self.task_type is not None: + result["taskType"] = from_union([lambda x: to_enum(TaskType, x), from_none], self.task_type) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TasksGetProgressResult: - """Progress information for the task, or null when no task with that ID is tracked.""" +class ModelBillingTokenPrices: + """Token-level pricing information for this model""" - progress: TaskProgress | None = None - """Progress information for the task, discriminated by type. Returns null when no task with - this ID is currently tracked. + batch_size: int | None = None + """Number of tokens per standard billing batch""" + + cache_price: float | None = None + """Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens""" + + cache_read_price: float | None = None + """AI Credits cost per billing batch of cached (read) tokens""" + + cache_write_price: float | None = None + """AI Credits cost per billing batch of cache-write (cache creation) tokens.""" + + context_max: int | None = None + """Use maxPromptTokens instead. Prompt token budget for the default tier. The total context + window is this value plus the model's max_output_tokens. + """ + input_price: float | None = None + """AI Credits cost per billing batch of input tokens""" + + long_context: ModelBillingTokenPricesLongContext | None = None + """Long context tier pricing (available for models with extended context windows)""" + + max_prompt_tokens: int | None = None + """Prompt token budget for the default tier. The total context window is this value plus the + model's max_output_tokens. """ + output_price: float | None = None + """AI Credits cost per billing batch of output tokens""" @staticmethod - def from_dict(obj: Any) -> 'TasksGetProgressResult': + def from_dict(obj: Any) -> 'ModelBillingTokenPrices': assert isinstance(obj, dict) - progress = from_union([TaskProgress.from_dict, from_none], obj.get("progress")) - return TasksGetProgressResult(progress) + batch_size = from_union([from_int, from_none], obj.get("batchSize")) + cache_price = from_union([from_float, from_none], obj.get("cachePrice")) + cache_read_price = from_union([from_float, from_none], obj.get("cacheReadPrice")) + cache_write_price = from_union([from_float, from_none], obj.get("cacheWritePrice")) + context_max = from_union([from_int, from_none], obj.get("contextMax")) + input_price = from_union([from_float, from_none], obj.get("inputPrice")) + long_context = from_union([ModelBillingTokenPricesLongContext.from_dict, from_none], obj.get("longContext")) + max_prompt_tokens = from_union([from_int, from_none], obj.get("maxPromptTokens")) + output_price = from_union([from_float, from_none], obj.get("outputPrice")) + return ModelBillingTokenPrices(batch_size, cache_price, cache_read_price, cache_write_price, context_max, input_price, long_context, max_prompt_tokens, output_price) def to_dict(self) -> dict: result: dict = {} - if self.progress is not None: - result["progress"] = from_union([lambda x: to_class(TaskProgress, x), from_none], self.progress) + if self.batch_size is not None: + result["batchSize"] = from_union([from_int, from_none], self.batch_size) + if self.cache_price is not None: + result["cachePrice"] = from_union([to_float, from_none], self.cache_price) + if self.cache_read_price is not None: + result["cacheReadPrice"] = from_union([to_float, from_none], self.cache_read_price) + if self.cache_write_price is not None: + result["cacheWritePrice"] = from_union([to_float, from_none], self.cache_write_price) + if self.context_max is not None: + result["contextMax"] = from_union([from_int, from_none], self.context_max) + if self.input_price is not None: + result["inputPrice"] = from_union([to_float, from_none], self.input_price) + if self.long_context is not None: + result["longContext"] = from_union([lambda x: to_class(ModelBillingTokenPricesLongContext, x), from_none], self.long_context) + if self.max_prompt_tokens is not None: + result["maxPromptTokens"] = from_union([from_int, from_none], self.max_prompt_tokens) + if self.output_price is not None: + result["outputPrice"] = from_union([to_float, from_none], self.output_price) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationSchema: - """JSON Schema describing the form fields to present to the user""" +class ModelCapabilitiesLimits: + """Token limits for prompts, outputs, and context window""" - properties: dict[str, UIElicitationSchemaProperty] - """Form field definitions, keyed by field name""" + max_context_window_tokens: int | None = None + """Maximum total context window size in tokens""" - type: UIElicitationSchemaType - """Schema type indicator (always 'object')""" + max_output_tokens: int | None = None + """Maximum number of output/completion tokens""" - required: list[str] | None = None - """List of required field names""" + max_prompt_tokens: int | None = None + """Maximum number of prompt/input tokens""" + + vision: ModelCapabilitiesLimitsVision | None = None + """Vision-specific limits""" @staticmethod - def from_dict(obj: Any) -> 'UIElicitationSchema': + def from_dict(obj: Any) -> 'ModelCapabilitiesLimits': assert isinstance(obj, dict) - properties = from_dict(UIElicitationSchemaProperty.from_dict, obj.get("properties")) - type = UIElicitationSchemaType(obj.get("type")) - required = from_union([lambda x: from_list(from_str, x), from_none], obj.get("required")) - return UIElicitationSchema(properties, type, required) + max_context_window_tokens = from_union([from_int, from_none], obj.get("max_context_window_tokens")) + max_output_tokens = from_union([from_int, from_none], obj.get("max_output_tokens")) + max_prompt_tokens = from_union([from_int, from_none], obj.get("max_prompt_tokens")) + vision = from_union([ModelCapabilitiesLimitsVision.from_dict, from_none], obj.get("vision")) + return ModelCapabilitiesLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision) def to_dict(self) -> dict: result: dict = {} - result["properties"] = from_dict(lambda x: to_class(UIElicitationSchemaProperty, x), self.properties) - result["type"] = to_enum(UIElicitationSchemaType, self.type) - if self.required is not None: - result["required"] = from_union([lambda x: from_list(from_str, x), from_none], self.required) + if self.max_context_window_tokens is not None: + result["max_context_window_tokens"] = from_union([from_int, from_none], self.max_context_window_tokens) + if self.max_output_tokens is not None: + result["max_output_tokens"] = from_union([from_int, from_none], self.max_output_tokens) + if self.max_prompt_tokens is not None: + result["max_prompt_tokens"] = from_union([from_int, from_none], self.max_prompt_tokens) + if self.vision is not None: + result["vision"] = from_union([lambda x: to_class(ModelCapabilitiesLimitsVision, x), from_none], self.vision) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionsSetAdditionalPluginsRequest: - """Manager-wide additional plugins to register; replaces any previously-configured set.""" +class SessionModelPriceCategory: + """Cost-category metadata for a CAPI model.""" - plugins: list[InstalledPlugin] - """Manager-wide additional plugins to register. Replaces any previously-configured set. Pass - an empty array to clear. - """ + id: str + price_category: ModelPickerPriceCategory @staticmethod - def from_dict(obj: Any) -> 'SessionsSetAdditionalPluginsRequest': + def from_dict(obj: Any) -> 'SessionModelPriceCategory': assert isinstance(obj, dict) - plugins = from_list(InstalledPlugin.from_dict, obj.get("plugins")) - return SessionsSetAdditionalPluginsRequest(plugins) + id = from_str(obj.get("id")) + price_category = ModelPickerPriceCategory(obj.get("priceCategory")) + return SessionModelPriceCategory(id, price_category) def to_dict(self) -> dict: result: dict = {} - result["plugins"] = from_list(lambda x: to_class(InstalledPlugin, x), self.plugins) + result["id"] = from_str(self.id) + result["priceCategory"] = to_enum(ModelPickerPriceCategory, self.price_category) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class SessionUpdateOptionsParams: - """Patch of mutable session options to apply to the running session.""" +class ModelPolicy: + """Policy state (if applicable)""" - additional_content_exclusion_policies: list[Any] | None = None - """Additional content-exclusion policies to merge into the session's policy set. Opaque - shape; see `ContentExclusionApiResponse` in the runtime. - """ - agent_context: str | None = None - """Runtime context discriminator (e.g., `cli`, `actions`).""" + state: ModelPolicyState + """Current policy state for this model""" - ask_user_disabled: bool | None = None - """Whether to disable the `ask_user` tool (encourages autonomous behavior).""" + terms: str | None = None + """Usage terms or conditions for this model""" - available_tools: list[str] | None = None - """Allowlist of tool names available to this session.""" + @staticmethod + def from_dict(obj: Any) -> 'ModelPolicy': + assert isinstance(obj, dict) + state = ModelPolicyState(obj.get("state")) + terms = from_union([from_str, from_none], obj.get("terms")) + return ModelPolicy(state, terms) - client_name: str | None = None - """Identifier of the client driving the session.""" + def to_dict(self) -> dict: + result: dict = {} + result["state"] = to_enum(ModelPolicyState, self.state) + if self.terms is not None: + result["terms"] = from_union([from_str, from_none], self.terms) + return result - coauthor_enabled: bool | None = None - """Whether to include the `Co-authored-by` trailer in commit messages.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelCapabilitiesOverrideLimits: + """Token limits for prompts, outputs, and context window""" - continue_on_auto_mode: bool | None = None - """Whether to allow auto-mode continuation across turns.""" + max_context_window_tokens: int | None = None + """Maximum total context window size in tokens""" - copilot_url: str | None = None - """Override URL for the Copilot API endpoint.""" + max_output_tokens: int | None = None + """Maximum number of output/completion tokens""" - custom_agents_local_only: bool | None = None - """Whether to default custom agents to local-only execution.""" + max_prompt_tokens: int | None = None + """Maximum number of prompt/input tokens""" - disabled_instruction_sources: list[str] | None = None - """Instruction source IDs to exclude from the system prompt.""" + vision: ModelCapabilitiesOverrideLimitsVision | None = None + """Vision-specific limits""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimits': + assert isinstance(obj, dict) + max_context_window_tokens = from_union([from_int, from_none], obj.get("max_context_window_tokens")) + max_output_tokens = from_union([from_int, from_none], obj.get("max_output_tokens")) + max_prompt_tokens = from_union([from_int, from_none], obj.get("max_prompt_tokens")) + vision = from_union([ModelCapabilitiesOverrideLimitsVision.from_dict, from_none], obj.get("vision")) + return ModelCapabilitiesOverrideLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision) + + def to_dict(self) -> dict: + result: dict = {} + if self.max_context_window_tokens is not None: + result["max_context_window_tokens"] = from_union([from_int, from_none], self.max_context_window_tokens) + if self.max_output_tokens is not None: + result["max_output_tokens"] = from_union([from_int, from_none], self.max_output_tokens) + if self.max_prompt_tokens is not None: + result["max_prompt_tokens"] = from_union([from_int, from_none], self.max_prompt_tokens) + if self.vision is not None: + result["vision"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimitsVision, x), from_none], self.vision) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class NamedProviderConfig: + """A named BYOK provider connection (transport + credentials).""" + + base_url: str + """API endpoint URL.""" + + name: str + """Stable identifier referenced by BYOK model definitions. Must not contain '/'.""" + + api_key: str | None = None + """API key. Optional for local providers like Ollama.""" + + azure: ProviderConfigAzure | None = None + """Azure-specific provider options.""" + + bearer_token: str | None = None + """Bearer token for authentication. Sets the Authorization header directly. Takes precedence + over apiKey when both are set. + """ + has_bearer_token_provider: bool | None = None + """When true, the SDK client supplies bearer tokens on demand: the runtime calls the + client-session `providerToken.getToken` callback before each request and applies the + returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth + scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens + (including Anthropic's), not a provider-specific API-key header such as Anthropic's + `x-api-key`. The token-acquiring function itself stays on the SDK side and is never + serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, + the callback takes precedence: the runtime applies the token returned by + `providerToken.getToken` as the `Authorization: Bearer` header for each request and does + not send the static credential. + """ + headers: dict[str, str] | None = None + """Custom HTTP headers to include in all outbound requests to the provider.""" + + transport: ProviderTransport | None = None + """Provider transport. Defaults to "http".""" + + type: ProviderType | None = None + """Provider type. Defaults to "openai" for generic OpenAI-compatible APIs.""" + + wire_api: ProviderWireAPI | None = None + """Wire API format (openai/azure only). Defaults to "completions".""" + + @staticmethod + def from_dict(obj: Any) -> 'NamedProviderConfig': + assert isinstance(obj, dict) + base_url = from_str(obj.get("baseUrl")) + name = from_str(obj.get("name")) + api_key = from_union([from_str, from_none], obj.get("apiKey")) + azure = from_union([ProviderConfigAzure.from_dict, from_none], obj.get("azure")) + bearer_token = from_union([from_str, from_none], obj.get("bearerToken")) + has_bearer_token_provider = from_union([from_bool, from_none], obj.get("hasBearerTokenProvider")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + transport = from_union([ProviderTransport, from_none], obj.get("transport")) + type = from_union([ProviderType, from_none], obj.get("type")) + wire_api = from_union([ProviderWireAPI, from_none], obj.get("wireApi")) + return NamedProviderConfig(base_url, name, api_key, azure, bearer_token, has_bearer_token_provider, headers, transport, type, wire_api) + + def to_dict(self) -> dict: + result: dict = {} + result["baseUrl"] = from_str(self.base_url) + result["name"] = from_str(self.name) + if self.api_key is not None: + result["apiKey"] = from_union([from_str, from_none], self.api_key) + if self.azure is not None: + result["azure"] = from_union([lambda x: to_class(ProviderConfigAzure, x), from_none], self.azure) + if self.bearer_token is not None: + result["bearerToken"] = from_union([from_str, from_none], self.bearer_token) + if self.has_bearer_token_provider is not None: + result["hasBearerTokenProvider"] = from_union([from_bool, from_none], self.has_bearer_token_provider) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.transport is not None: + result["transport"] = from_union([lambda x: to_enum(ProviderTransport, x), from_none], self.transport) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(ProviderType, x), from_none], self.type) + if self.wire_api is not None: + result["wireApi"] = from_union([lambda x: to_enum(ProviderWireAPI, x), from_none], self.wire_api) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ProviderConfig: + """Custom model-provider configuration (BYOK).""" + + base_url: str + """API endpoint URL.""" + + api_key: str | None = None + """API key. Optional for local providers like Ollama.""" + + azure: ProviderConfigAzure | None = None + """Azure-specific provider options.""" + + bearer_token: str | None = None + """Bearer token for authentication. Sets the Authorization header directly. Takes precedence + over apiKey when both are set. + """ + has_bearer_token_provider: bool | None = None + """When true, the SDK client supplies bearer tokens on demand: the runtime calls the + client-session `providerToken.getToken` callback before each request and applies the + returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth + scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens + (including Anthropic's), not a provider-specific API-key header such as Anthropic's + `x-api-key`. The token-acquiring function itself stays on the SDK side and is never + serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, + the callback takes precedence: the runtime applies the token returned by + `providerToken.getToken` as the `Authorization: Bearer` header for each request and does + not send the static credential. + """ + headers: dict[str, str] | None = None + """Custom HTTP headers to include in all outbound requests to the provider.""" + + max_context_window_tokens: float | None = None + """Maximum context window tokens for the model.""" + + max_output_tokens: float | None = None + """Maximum output tokens for the model.""" + + max_prompt_tokens: float | None = None + """Maximum prompt/input tokens for the model.""" + + model_id: str | None = None + """Well-known model ID used for capability lookup. When set, agent behavior config and token + limits are inferred from this model. + """ + transport: ProviderTransport | None = None + """Provider transport. Defaults to "http".""" + + type: ProviderType | None = None + """Provider type. Defaults to "openai" for generic OpenAI-compatible APIs.""" + + wire_api: ProviderWireAPI | None = None + """Wire API format (openai/azure only). Defaults to "completions".""" + + wire_model: str | None = None + """The model identifier sent to the provider API for inference (the "wire" model), as + opposed to modelId which is the well-known base. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ProviderConfig': + assert isinstance(obj, dict) + base_url = from_str(obj.get("baseUrl")) + api_key = from_union([from_str, from_none], obj.get("apiKey")) + azure = from_union([ProviderConfigAzure.from_dict, from_none], obj.get("azure")) + bearer_token = from_union([from_str, from_none], obj.get("bearerToken")) + has_bearer_token_provider = from_union([from_bool, from_none], obj.get("hasBearerTokenProvider")) + headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("headers")) + max_context_window_tokens = from_union([from_float, from_none], obj.get("maxContextWindowTokens")) + max_output_tokens = from_union([from_float, from_none], obj.get("maxOutputTokens")) + max_prompt_tokens = from_union([from_float, from_none], obj.get("maxPromptTokens")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + transport = from_union([ProviderTransport, from_none], obj.get("transport")) + type = from_union([ProviderType, from_none], obj.get("type")) + wire_api = from_union([ProviderWireAPI, from_none], obj.get("wireApi")) + wire_model = from_union([from_str, from_none], obj.get("wireModel")) + return ProviderConfig(base_url, api_key, azure, bearer_token, has_bearer_token_provider, headers, max_context_window_tokens, max_output_tokens, max_prompt_tokens, model_id, transport, type, wire_api, wire_model) + + def to_dict(self) -> dict: + result: dict = {} + result["baseUrl"] = from_str(self.base_url) + if self.api_key is not None: + result["apiKey"] = from_union([from_str, from_none], self.api_key) + if self.azure is not None: + result["azure"] = from_union([lambda x: to_class(ProviderConfigAzure, x), from_none], self.azure) + if self.bearer_token is not None: + result["bearerToken"] = from_union([from_str, from_none], self.bearer_token) + if self.has_bearer_token_provider is not None: + result["hasBearerTokenProvider"] = from_union([from_bool, from_none], self.has_bearer_token_provider) + if self.headers is not None: + result["headers"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers) + if self.max_context_window_tokens is not None: + result["maxContextWindowTokens"] = from_union([to_float, from_none], self.max_context_window_tokens) + if self.max_output_tokens is not None: + result["maxOutputTokens"] = from_union([to_float, from_none], self.max_output_tokens) + if self.max_prompt_tokens is not None: + result["maxPromptTokens"] = from_union([to_float, from_none], self.max_prompt_tokens) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + if self.transport is not None: + result["transport"] = from_union([lambda x: to_enum(ProviderTransport, x), from_none], self.transport) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(ProviderType, x), from_none], self.type) + if self.wire_api is not None: + result["wireApi"] = from_union([lambda x: to_enum(ProviderWireAPI, x), from_none], self.wire_api) + if self.wire_model is not None: + result["wireModel"] = from_union([from_str, from_none], self.wire_model) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class OptionsUpdateAdditionalContentExclusionPolicyRule: + """Single content-exclusion rule supplied to `session.options.update`, with paths, match + conditions, and source. + """ + paths: list[str] + source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource + """Source descriptor for a `session.options.update` content-exclusion rule, with source name + and type. + """ + if_any_match: list[str] | None = None + if_none_match: list[str] | None = None + + @staticmethod + def from_dict(obj: Any) -> 'OptionsUpdateAdditionalContentExclusionPolicyRule': + assert isinstance(obj, dict) + paths = from_list(from_str, obj.get("paths")) + source = OptionsUpdateAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("source")) + if_any_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifAnyMatch")) + if_none_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifNoneMatch")) + return OptionsUpdateAdditionalContentExclusionPolicyRule(paths, source, if_any_match, if_none_match) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(from_str, self.paths) + result["source"] = to_class(OptionsUpdateAdditionalContentExclusionPolicyRuleSource, self.source) + if self.if_any_match is not None: + result["ifAnyMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_any_match) + if self.if_none_match is not None: + result["ifNoneMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_none_match) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PendingPermissionRequestList: + """List of pending permission requests reconstructed from event history.""" + + items: list[PendingPermissionRequest] + """Pending permission prompts reconstructed from the session's event history. Equivalent to + the set of `permission.requested` events that have not yet been followed by a matching + `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts + that were emitted before the client attached to the session. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PendingPermissionRequestList': + assert isinstance(obj, dict) + items = from_list(PendingPermissionRequest.from_dict, obj.get("items")) + return PendingPermissionRequestList(items) + + def to_dict(self) -> dict: + result: dict = {} + result["items"] = from_list(lambda x: to_class(PendingPermissionRequest, x), self.items) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocation: + """Permission-decision request variant to approve and persist a permission for a project + location, with approval details and location key. + """ + approval: PermissionDecisionApproveForLocationApproval + """Approval to persist for this location""" + + kind: ClassVar[str] = "approve-for-location" + """Approve and persist for this project location""" + + location_key: str + """Location key (git root or cwd) to persist the approval to""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocation': + assert isinstance(obj, dict) + approval = _load_PermissionDecisionApproveForLocationApproval(obj.get("approval")) + location_key = from_str(obj.get("locationKey")) + return PermissionDecisionApproveForLocation(approval, location_key) + + def to_dict(self) -> dict: + result: dict = {} + result["approval"] = (self.approval).to_dict() + result["kind"] = self.kind + result["locationKey"] = from_str(self.location_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalCommands: + """Location-scoped approval details for specific command identifiers.""" + + command_identifiers: list[str] + """Command identifiers covered by this approval.""" + + kind: ClassVar[str] = "commands" + """Approval scoped to specific command identifiers.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCommands': + assert isinstance(obj, dict) + command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) + return PermissionDecisionApproveForLocationApprovalCommands(command_identifiers) + + def to_dict(self) -> dict: + result: dict = {} + result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalCommands: + """Session-scoped approval details for specific command identifiers.""" + + command_identifiers: list[str] + """Command identifiers covered by this approval.""" + + kind: ClassVar[str] = "commands" + """Approval scoped to specific command identifiers.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCommands': + assert isinstance(obj, dict) + command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) + return PermissionDecisionApproveForSessionApprovalCommands(command_identifiers) + + def to_dict(self) -> dict: + result: dict = {} + result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsCommands: + """Location-persisted tool approval details for specific command identifiers.""" + + command_identifiers: list[str] + """Command identifiers covered by this approval.""" + + kind: ClassVar[str] = "commands" + """Approval scoped to specific command identifiers.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsCommands': + assert isinstance(obj, dict) + command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) + return PermissionsLocationsAddToolApprovalDetailsCommands(command_identifiers) + + def to_dict(self) -> dict: + result: dict = {} + result["commandIdentifiers"] = from_list(from_str, self.command_identifiers) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalCustomTool: + """Location-scoped approval details for a custom tool, keyed by tool name.""" + + kind: ClassVar[str] = "custom-tool" + """Approval covering a custom tool.""" + + tool_name: str + """Custom tool name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCustomTool': + assert isinstance(obj, dict) + tool_name = from_str(obj.get("toolName")) + return PermissionDecisionApproveForLocationApprovalCustomTool(tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["toolName"] = from_str(self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalCustomTool: + """Session-scoped approval details for a custom tool, keyed by tool name.""" + + kind: ClassVar[str] = "custom-tool" + """Approval covering a custom tool.""" + + tool_name: str + """Custom tool name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCustomTool': + assert isinstance(obj, dict) + tool_name = from_str(obj.get("toolName")) + return PermissionDecisionApproveForSessionApprovalCustomTool(tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["toolName"] = from_str(self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsCustomTool: + """Location-persisted tool approval details for a custom tool, keyed by tool name.""" + + kind: ClassVar[str] = "custom-tool" + """Approval covering a custom tool.""" + + tool_name: str + """Custom tool name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsCustomTool': + assert isinstance(obj, dict) + tool_name = from_str(obj.get("toolName")) + return PermissionsLocationsAddToolApprovalDetailsCustomTool(tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["toolName"] = from_str(self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalExtensionManagement: + """Location-scoped approval details for extension-management operations, optionally narrowed + by operation. + """ + kind: ClassVar[str] = "extension-management" + """Approval covering extension lifecycle operations such as enable, disable, or reload.""" + + operation: str | None = None + """Optional operation identifier; when omitted, the approval covers all extension management + operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalExtensionManagement': + assert isinstance(obj, dict) + operation = from_union([from_str, from_none], obj.get("operation")) + return PermissionDecisionApproveForLocationApprovalExtensionManagement(operation) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.operation is not None: + result["operation"] = from_union([from_str, from_none], self.operation) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalExtensionManagement: + """Session-scoped approval details for extension-management operations, optionally narrowed + by operation. + """ + kind: ClassVar[str] = "extension-management" + """Approval covering extension lifecycle operations such as enable, disable, or reload.""" + + operation: str | None = None + """Optional operation identifier; when omitted, the approval covers all extension management + operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalExtensionManagement': + assert isinstance(obj, dict) + operation = from_union([from_str, from_none], obj.get("operation")) + return PermissionDecisionApproveForSessionApprovalExtensionManagement(operation) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.operation is not None: + result["operation"] = from_union([from_str, from_none], self.operation) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsExtensionManagement: + """Location-persisted tool approval details for extension-management operations, optionally + narrowed by operation. + """ + kind: ClassVar[str] = "extension-management" + """Approval covering extension lifecycle operations such as enable, disable, or reload.""" + + operation: str | None = None + """Optional operation identifier; when omitted, the approval covers all extension management + operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsExtensionManagement': + assert isinstance(obj, dict) + operation = from_union([from_str, from_none], obj.get("operation")) + return PermissionsLocationsAddToolApprovalDetailsExtensionManagement(operation) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.operation is not None: + result["operation"] = from_union([from_str, from_none], self.operation) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalFactory: + """Location-scoped factory approval, optionally narrowed by approval key.""" + + kind: ClassVar[str] = "factory" + """Approval covering factory operations.""" + + approval_key: str | None = None + """Optional factory operation name or canonical approval key; when omitted, the approval + covers all factory operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalFactory': + assert isinstance(obj, dict) + approval_key = from_union([from_str, from_none], obj.get("approvalKey")) + return PermissionDecisionApproveForLocationApprovalFactory(approval_key) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approval_key is not None: + result["approvalKey"] = from_union([from_str, from_none], self.approval_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalFactory: + """Session-scoped factory approval, optionally narrowed by approval key.""" + + kind: ClassVar[str] = "factory" + """Approval covering factory operations.""" + + approval_key: str | None = None + """Optional factory operation name or canonical approval key; when omitted, the approval + covers all factory operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalFactory': + assert isinstance(obj, dict) + approval_key = from_union([from_str, from_none], obj.get("approvalKey")) + return PermissionDecisionApproveForSessionApprovalFactory(approval_key) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approval_key is not None: + result["approvalKey"] = from_union([from_str, from_none], self.approval_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsFactory: + """Location-persisted factory approval, optionally narrowed by approval key.""" + + kind: ClassVar[str] = "factory" + """Approval covering factory operations.""" + + approval_key: str | None = None + """Optional factory operation name or canonical approval key; when omitted, the approval + covers all factory operations. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsFactory': + assert isinstance(obj, dict) + approval_key = from_union([from_str, from_none], obj.get("approvalKey")) + return PermissionsLocationsAddToolApprovalDetailsFactory(approval_key) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approval_key is not None: + result["approvalKey"] = from_union([from_str, from_none], self.approval_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalMCP: + """Location-scoped approval details for an MCP server tool, or all tools on the server when + `toolName` is null. + """ + kind: ClassVar[str] = "mcp" + """Approval covering an MCP tool.""" + + server_name: str + """MCP server name.""" + + tool_name: str | None = None + """MCP tool name, or null to cover every tool on the server.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCP': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + tool_name = from_union([from_none, from_str], obj.get("toolName")) + return PermissionDecisionApproveForLocationApprovalMCP(server_name, tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + result["toolName"] = from_union([from_none, from_str], self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalMCP: + """Session-scoped approval details for an MCP server tool, or all tools on the server when + `toolName` is null. + """ + kind: ClassVar[str] = "mcp" + """Approval covering an MCP tool.""" + + server_name: str + """MCP server name.""" + + tool_name: str | None = None + """MCP tool name, or null to cover every tool on the server.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCP': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + tool_name = from_union([from_none, from_str], obj.get("toolName")) + return PermissionDecisionApproveForSessionApprovalMCP(server_name, tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + result["toolName"] = from_union([from_none, from_str], self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsMCP: + """Location-persisted tool approval details for an MCP server tool, or all tools when + `toolName` is null. + """ + kind: ClassVar[str] = "mcp" + """Approval covering an MCP tool.""" + + server_name: str + """MCP server name.""" + + tool_name: str | None = None + """MCP tool name, or null to cover every tool on the server.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMCP': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + tool_name = from_union([from_none, from_str], obj.get("toolName")) + return PermissionsLocationsAddToolApprovalDetailsMCP(server_name, tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + result["toolName"] = from_union([from_none, from_str], self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalMCPSampling: + """Location-scoped approval details for MCP sampling requests from a server.""" + + kind: ClassVar[str] = "mcp-sampling" + """Approval covering MCP sampling requests for a server.""" + + server_name: str + """MCP server name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCPSampling': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return PermissionDecisionApproveForLocationApprovalMCPSampling(server_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalMCPSampling: + """Session-scoped approval details for MCP sampling requests from a server.""" + + kind: ClassVar[str] = "mcp-sampling" + """Approval covering MCP sampling requests for a server.""" + + server_name: str + """MCP server name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCPSampling': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return PermissionDecisionApproveForSessionApprovalMCPSampling(server_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsMCPSampling: + """Location-persisted tool approval details for MCP sampling requests from a server.""" + + kind: ClassVar[str] = "mcp-sampling" + """Approval covering MCP sampling requests for a server.""" + + server_name: str + """MCP server name.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMCPSampling': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return PermissionsLocationsAddToolApprovalDetailsMCPSampling(server_name) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["serverName"] = from_str(self.server_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalMemory: + """Location-scoped approval details for writes to long-term memory.""" + + kind: ClassVar[str] = "memory" + """Approval covering writes to long-term memory.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMemory': + assert isinstance(obj, dict) + return PermissionDecisionApproveForLocationApprovalMemory() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalMemory: + """Session-scoped approval details for writes to long-term memory.""" + + kind: ClassVar[str] = "memory" + """Approval covering writes to long-term memory.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMemory': + assert isinstance(obj, dict) + return PermissionDecisionApproveForSessionApprovalMemory() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsMemory: + """Location-persisted tool approval details for writes to long-term memory.""" + + kind: ClassVar[str] = "memory" + """Approval covering writes to long-term memory.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsMemory': + assert isinstance(obj, dict) + return PermissionsLocationsAddToolApprovalDetailsMemory() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalRead: + """Location-scoped approval details for read-only filesystem operations.""" + + kind: ClassVar[str] = "read" + """Approval covering read-only filesystem operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalRead': + assert isinstance(obj, dict) + return PermissionDecisionApproveForLocationApprovalRead() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalRead: + """Session-scoped approval details for read-only filesystem operations.""" + + kind: ClassVar[str] = "read" + """Approval covering read-only filesystem operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalRead': + assert isinstance(obj, dict) + return PermissionDecisionApproveForSessionApprovalRead() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsRead: + """Location-persisted tool approval details for read-only filesystem operations.""" + + kind: ClassVar[str] = "read" + """Approval covering read-only filesystem operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsRead': + assert isinstance(obj, dict) + return PermissionsLocationsAddToolApprovalDetailsRead() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalWrite: + """Location-scoped approval details for filesystem write operations.""" + + kind: ClassVar[str] = "write" + """Approval covering filesystem write operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalWrite': + assert isinstance(obj, dict) + return PermissionDecisionApproveForLocationApprovalWrite() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalWrite: + """Session-scoped approval details for filesystem write operations.""" + + kind: ClassVar[str] = "write" + """Approval covering filesystem write operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalWrite': + assert isinstance(obj, dict) + return PermissionDecisionApproveForSessionApprovalWrite() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsWrite: + """Location-persisted tool approval details for filesystem write operations.""" + + kind: ClassVar[str] = "write" + """Approval covering filesystem write operations.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsWrite': + assert isinstance(obj, dict) + return PermissionsLocationsAddToolApprovalDetailsWrite() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSession: + """Permission-decision request variant to approve for the rest of the session, with optional + tool approval or URL domain. + """ + kind: ClassVar[str] = "approve-for-session" + """Approve and remember for the rest of the session""" + + approval: PermissionDecisionApproveForSessionApproval | None = None + """Session-scoped approval to remember (tool prompts only; omitted for path/url prompts)""" + + domain: str | None = None + """URL domain to approve for the rest of the session (URL prompts only)""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSession': + assert isinstance(obj, dict) + approval = from_union([_load_PermissionDecisionApproveForSessionApproval, from_none], obj.get("approval")) + domain = from_union([from_str, from_none], obj.get("domain")) + return PermissionDecisionApproveForSession(approval, domain) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approval is not None: + result["approval"] = from_union([lambda x: (x).to_dict(), from_none], self.approval) + if self.domain is not None: + result["domain"] = from_union([from_str, from_none], self.domain) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveOnce: + """Permission-decision request variant to approve only the current permission request.""" + + kind: ClassVar[str] = "approve-once" + """Approve this single request only""" + + approved_interactively: bool | None = None + """True only when a host surfaced this request to a user who approved it.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveOnce': + assert isinstance(obj, dict) + approved_interactively = from_union([from_bool, from_none], obj.get("approvedInteractively")) + return PermissionDecisionApproveOnce(approved_interactively) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approved_interactively is not None: + result["approvedInteractively"] = from_union([from_bool, from_none], self.approved_interactively) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApprovePermanently: + """Permission-decision request variant to permanently approve a URL domain across sessions.""" + + domain: str + """URL domain to approve permanently""" + + kind: ClassVar[str] = "approve-permanently" + """Approve and persist across sessions (URL prompts only)""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApprovePermanently': + assert isinstance(obj, dict) + domain = from_str(obj.get("domain")) + return PermissionDecisionApprovePermanently(domain) + + def to_dict(self) -> dict: + result: dict = {} + result["domain"] = from_str(self.domain) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproved: + """Permission-decision variant indicating the request was approved.""" + + kind: ClassVar[str] = "approved" + """The permission request was approved""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproved': + assert isinstance(obj, dict) + return PermissionDecisionApproved() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApprovedForLocation: + """Permission-decision variant indicating approval was persisted for a project location, + with approval details and location key. + """ + approval: UserToolSessionApproval + """The approval to persist for this location""" + + kind: ClassVar[str] = "approved-for-location" + """Approved and persisted for this project location""" + + location_key: str + """The location key (git root or cwd) to persist the approval to""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApprovedForLocation': + assert isinstance(obj, dict) + approval = UserToolSessionApproval.from_dict(obj.get("approval")) + location_key = from_str(obj.get("locationKey")) + return PermissionDecisionApprovedForLocation(approval, location_key) + + def to_dict(self) -> dict: + result: dict = {} + result["approval"] = to_class(UserToolSessionApproval, self.approval) + result["kind"] = self.kind + result["locationKey"] = from_str(self.location_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApprovedForSession: + """Permission-decision variant indicating approval was remembered for the session, with + approval details. + """ + approval: UserToolSessionApproval + """The approval to add as a session-scoped rule""" + + kind: ClassVar[str] = "approved-for-session" + """Approved and remembered for the rest of the session""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApprovedForSession': + assert isinstance(obj, dict) + approval = UserToolSessionApproval.from_dict(obj.get("approval")) + return PermissionDecisionApprovedForSession(approval) + + def to_dict(self) -> dict: + result: dict = {} + result["approval"] = to_class(UserToolSessionApproval, self.approval) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionCancelled: + """Permission-decision variant indicating the request was cancelled before use, with an + optional reason. + """ + kind: ClassVar[str] = "cancelled" + """The permission request was cancelled before a response was used""" + + reason: str | None = None + """Optional explanation of why the request was cancelled""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionCancelled': + assert isinstance(obj, dict) + reason = from_union([from_str, from_none], obj.get("reason")) + return PermissionDecisionCancelled(reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionContext: + """Optional informational context describing how and where the permission decision was made. + This does not affect permission behavior. + + Optional informational context describing how and where this response was made. Omit it + to preserve legacy behavior without attributing an origin. + """ + outcome: PermissionDecisionOutcome + """Disposition of the permission request as observed by the responding client.""" + + source: PermissionDecisionSource + """Controlled reason or actor responsible for the response.""" + + surface: PermissionDecisionSurface + """Client surface that submitted the response.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionContext': + assert isinstance(obj, dict) + outcome = PermissionDecisionOutcome(obj.get("outcome")) + source = PermissionDecisionSource(obj.get("source")) + surface = PermissionDecisionSurface(obj.get("surface")) + return PermissionDecisionContext(outcome, source, surface) + + def to_dict(self) -> dict: + result: dict = {} + result["outcome"] = to_enum(PermissionDecisionOutcome, self.outcome) + result["source"] = to_enum(PermissionDecisionSource, self.source) + result["surface"] = to_enum(PermissionDecisionSurface, self.surface) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionDeniedByContentExclusionPolicy: + """Permission-decision variant indicating denial by content-exclusion policy, with path and + message. + """ + kind: ClassVar[str] = "denied-by-content-exclusion-policy" + """Denied by the organization's content exclusion policy""" + + message: str + """Human-readable explanation of why the path was excluded""" + + path: str + """File path that triggered the exclusion""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionDeniedByContentExclusionPolicy': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + path = from_str(obj.get("path")) + return PermissionDecisionDeniedByContentExclusionPolicy(message, path) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["message"] = from_str(self.message) + result["path"] = from_str(self.path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionDeniedByPermissionRequestHook: + """Permission-decision variant indicating denial by a permission request hook, with optional + message and interrupt flag. + """ + kind: ClassVar[str] = "denied-by-permission-request-hook" + """Denied by a permission request hook registered by an extension or plugin""" + + interrupt: bool | None = None + """Whether to interrupt the current agent turn""" + + message: str | None = None + """Optional message from the hook explaining the denial""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionDeniedByPermissionRequestHook': + assert isinstance(obj, dict) + interrupt = from_union([from_bool, from_none], obj.get("interrupt")) + message = from_union([from_str, from_none], obj.get("message")) + return PermissionDecisionDeniedByPermissionRequestHook(interrupt, message) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.interrupt is not None: + result["interrupt"] = from_union([from_bool, from_none], self.interrupt) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionDeniedByRules: + """Permission-decision variant indicating explicit denial by permission rules, with the + matching rules. + """ + kind: ClassVar[str] = "denied-by-rules" + """Denied because approval rules explicitly blocked it""" + + rules: list[PermissionRule] + """Rules that denied the request""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionDeniedByRules': + assert isinstance(obj, dict) + rules = from_list(PermissionRule.from_dict, obj.get("rules")) + return PermissionDecisionDeniedByRules(rules) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["rules"] = from_list(lambda x: to_class(PermissionRule, x), self.rules) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionDeniedInteractivelyByUser: + """Permission-decision variant indicating the user denied an interactive prompt, with + optional feedback and force-reject flag. + """ + kind: ClassVar[str] = "denied-interactively-by-user" + """Denied by the user during an interactive prompt""" + + feedback: str | None = None + """Optional feedback from the user explaining the denial""" + + force_reject: bool | None = None + """Whether to force-reject the current agent turn""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionDeniedInteractivelyByUser': + assert isinstance(obj, dict) + feedback = from_union([from_str, from_none], obj.get("feedback")) + force_reject = from_union([from_bool, from_none], obj.get("forceReject")) + return PermissionDecisionDeniedInteractivelyByUser(feedback, force_reject) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.feedback is not None: + result["feedback"] = from_union([from_str, from_none], self.feedback) + if self.force_reject is not None: + result["forceReject"] = from_union([from_bool, from_none], self.force_reject) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser: + """Permission-decision variant indicating no approval rule matched and user confirmation was + unavailable. + """ + kind: ClassVar[str] = "denied-no-approval-rule-and-could-not-request-from-user" + """Denied because no approval rule matched and user confirmation was unavailable""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser': + assert isinstance(obj, dict) + return PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionReject: + """Permission-decision request variant to reject a pending permission request, with optional + feedback. + """ + kind: ClassVar[str] = "reject" + """Reject the request""" + + feedback: str | None = None + """Optional feedback explaining the rejection""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionReject': + assert isinstance(obj, dict) + feedback = from_union([from_str, from_none], obj.get("feedback")) + return PermissionDecisionReject(feedback) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.feedback is not None: + result["feedback"] = from_union([from_str, from_none], self.feedback) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionUserNotAvailable: + """Permission-decision variant indicating no user was available to confirm the request.""" + + kind: ClassVar[str] = "user-not-available" + """No user is available to confirm the request""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionUserNotAvailable': + assert isinstance(obj, dict) + return PermissionDecisionUserNotAvailable() + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionLocationApplyResult: + """Summary of persisted location permissions applied to the session.""" + + applied_directory_count: int + """Number of persisted allowed directories added to the live path manager""" + + applied_rule_count: int + """Number of location-scoped rules added to the live permission service""" + + applied_rules: list[PermissionRule] + """Location-scoped rules applied to the live permission service""" + + changed: bool + """Whether a different location was applied since the previous apply call""" + + location_key: str + """Location key used in the location-permissions store""" + + location_type: PermissionLocationType + """Whether the location is a git repo or directory""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionLocationApplyResult': + assert isinstance(obj, dict) + applied_directory_count = from_int(obj.get("appliedDirectoryCount")) + applied_rule_count = from_int(obj.get("appliedRuleCount")) + applied_rules = from_list(PermissionRule.from_dict, obj.get("appliedRules")) + changed = from_bool(obj.get("changed")) + location_key = from_str(obj.get("locationKey")) + location_type = PermissionLocationType(obj.get("locationType")) + return PermissionLocationApplyResult(applied_directory_count, applied_rule_count, applied_rules, changed, location_key, location_type) + + def to_dict(self) -> dict: + result: dict = {} + result["appliedDirectoryCount"] = from_int(self.applied_directory_count) + result["appliedRuleCount"] = from_int(self.applied_rule_count) + result["appliedRules"] = from_list(lambda x: to_class(PermissionRule, x), self.applied_rules) + result["changed"] = from_bool(self.changed) + result["locationKey"] = from_str(self.location_key) + result["locationType"] = to_enum(PermissionLocationType, self.location_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionLocationResolveResult: + """Resolved location-permissions key and type.""" + + location_key: str + """Location key used in the location-permissions store""" + + location_type: PermissionLocationType + """Whether the location is a git repo or directory""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionLocationResolveResult': + assert isinstance(obj, dict) + location_key = from_str(obj.get("locationKey")) + location_type = PermissionLocationType(obj.get("locationType")) + return PermissionLocationResolveResult(location_key, location_type) + + def to_dict(self) -> dict: + result: dict = {} + result["locationKey"] = from_str(self.location_key) + result["locationType"] = to_enum(PermissionLocationType, self.location_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsConfigureAdditionalContentExclusionPolicyRule: + """Single content-exclusion rule supplied to `session.permissions.configure`, with paths, + match conditions, and source. + """ + paths: list[str] + source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource + """Source descriptor for a `session.permissions.configure` content-exclusion rule, with + source name and type. + """ + if_any_match: list[str] | None = None + if_none_match: list[str] | None = None + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicyRule': + assert isinstance(obj, dict) + paths = from_list(from_str, obj.get("paths")) + source = PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("source")) + if_any_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifAnyMatch")) + if_none_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifNoneMatch")) + return PermissionsConfigureAdditionalContentExclusionPolicyRule(paths, source, if_any_match, if_none_match) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(from_str, self.paths) + result["source"] = to_class(PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, self.source) + if self.if_any_match is not None: + result["ifAnyMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_any_match) + if self.if_none_match is not None: + result["ifNoneMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_none_match) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsModifyRulesParams: + """Scope and add/remove instructions for modifying session- or location-scoped permission + rules. + """ + scope: PermissionsModifyRulesScope + """Whether the change applies to ephemeral session-scoped rules (cleared at session end) or + to location-scoped rules persisted via the location-permissions config file. + """ + add: list[PermissionRule] | None = None + """Rules to add to the scope. Applied before `remove`/`removeAll`.""" + + remove: list[PermissionRule] | None = None + """Specific rules to remove from the scope. Ignored when `removeAll` is true.""" + + remove_all: bool | None = None + """When true, removes every rule currently in the scope (after any `add` is applied). Useful + for clearing the location scope wholesale. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsModifyRulesParams': + assert isinstance(obj, dict) + scope = PermissionsModifyRulesScope(obj.get("scope")) + add = from_union([lambda x: from_list(PermissionRule.from_dict, x), from_none], obj.get("add")) + remove = from_union([lambda x: from_list(PermissionRule.from_dict, x), from_none], obj.get("remove")) + remove_all = from_union([from_bool, from_none], obj.get("removeAll")) + return PermissionsModifyRulesParams(scope, add, remove, remove_all) + + def to_dict(self) -> dict: + result: dict = {} + result["scope"] = to_enum(PermissionsModifyRulesScope, self.scope) + if self.add is not None: + result["add"] = from_union([lambda x: from_list(lambda x: to_class(PermissionRule, x), x), from_none], self.add) + if self.remove is not None: + result["remove"] = from_union([lambda x: from_list(lambda x: to_class(PermissionRule, x), x), from_none], self.remove) + if self.remove_all is not None: + result["removeAll"] = from_union([from_bool, from_none], self.remove_all) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PlanReadSQLTodosResult: + """Todo rows read from the session SQL database. Empty when no session database is available.""" + + rows: list[PlanSQLTodosRow] + """Rows from the session SQL todos table, ordered by creation time and id.""" + + @staticmethod + def from_dict(obj: Any) -> 'PlanReadSQLTodosResult': + assert isinstance(obj, dict) + rows = from_list(PlanSQLTodosRow.from_dict, obj.get("rows")) + return PlanReadSQLTodosResult(rows) + + def to_dict(self) -> dict: + result: dict = {} + result["rows"] = from_list(lambda x: to_class(PlanSQLTodosRow, x), self.rows) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PlanReadSQLTodosWithDependenciesResult: + """Todo rows + dependency edges read from the session SQL database.""" + + dependencies: list[PlanSQLTodoDependency] + """Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, + or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does + not affect the rows result and vice versa. + """ + rows: list[PlanSQLTodosRow] + """Rows from the session SQL todos table, ordered by creation time and id. Empty when no + database, no todos table, or the SELECT failed. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PlanReadSQLTodosWithDependenciesResult': + assert isinstance(obj, dict) + dependencies = from_list(PlanSQLTodoDependency.from_dict, obj.get("dependencies")) + rows = from_list(PlanSQLTodosRow.from_dict, obj.get("rows")) + return PlanReadSQLTodosWithDependenciesResult(dependencies, rows) + + def to_dict(self) -> dict: + result: dict = {} + result["dependencies"] = from_list(lambda x: to_class(PlanSQLTodoDependency, x), self.dependencies) + result["rows"] = from_list(lambda x: to_class(PlanSQLTodosRow, x), self.rows) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentSetPromptRequest: + """An in-memory authored prompt override for an available agent.""" + + id: str + """Stable effective agent id. Plugin namespace separators are normalized.""" + + prompt: str + """Replacement authored prompt. Empty text is valid.""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentSetPromptRequest': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + prompt = from_str(obj.get("prompt")) + return AgentSetPromptRequest(id, prompt) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + result["prompt"] = from_str(self.prompt) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DiscoveredMCPServer: + """MCP server discovered by `mcp.discover`, with config source, optional plugin source, + transport type, and enabled state. + """ + enabled: bool + """Whether the server is enabled (not in the disabled list)""" + + name: str + """Server name (config key)""" + + source: McpServerSource + """Configuration source: user, workspace, plugin, or builtin""" + + source_plugin: str | None = None + """Plugin name that provided this server, when source is plugin.""" + + source_plugin_version: str | None = None + """Plugin version that provided this server, when source is plugin.""" + + type: DiscoveredMCPServerType | None = None + """Server transport type: stdio, http, sse (deprecated), or memory""" + + @staticmethod + def from_dict(obj: Any) -> 'DiscoveredMCPServer': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + name = from_str(obj.get("name")) + source = McpServerSource(obj.get("source")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + type = from_union([DiscoveredMCPServerType, from_none], obj.get("type")) + return DiscoveredMCPServer(enabled, name, source, source_plugin, source_plugin_version, type) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + result["name"] = from_str(self.name) + result["source"] = to_enum(McpServerSource, self.source) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(DiscoveredMCPServerType, x), from_none], self.type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstalledPluginInfo: + """Information about an installed plugin tracked in global state. + + The newly installed plugin's metadata + """ + enabled: bool + """Whether the plugin is currently enabled for new sessions""" + + marketplace: str + """Marketplace the plugin came from. Empty string ("") for direct repo / URL / local + installs. + """ + name: str + """Plugin name""" + + direct_source_id: str | None = None + """Opaque, stable hash identifying a direct (non-marketplace) install source. Present only + for direct repo / URL / local installs; absent for marketplace plugins. Same source + yields the same id; distinct sources never collide. + """ + version: str | None = None + """Installed version (when reported by the plugin manifest)""" + + @staticmethod + def from_dict(obj: Any) -> 'InstalledPluginInfo': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + marketplace = from_str(obj.get("marketplace")) + name = from_str(obj.get("name")) + direct_source_id = from_union([from_str, from_none], obj.get("directSourceId")) + version = from_union([from_str, from_none], obj.get("version")) + return InstalledPluginInfo(enabled, marketplace, name, direct_source_id, version) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + result["marketplace"] = from_str(self.marketplace) + result["name"] = from_str(self.name) + if self.direct_source_id is not None: + result["directSourceId"] = from_union([from_str, from_none], self.direct_source_id) + if self.version is not None: + result["version"] = from_union([from_str, from_none], self.version) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MarketplacePluginInfo: + """Plugin entry advertised by a marketplace.""" + + name: str + """Plugin name as listed in the marketplace catalog""" + + description: str | None = None + """Short description from the marketplace catalog, when present""" + + @staticmethod + def from_dict(obj: Any) -> 'MarketplacePluginInfo': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + description = from_union([from_str, from_none], obj.get("description")) + return MarketplacePluginInfo(name, description) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServer: + """MCP server status entry, including config source/plugin source and any connection error.""" + + name: str + """Server name (config key)""" + + status: McpServerStatus + """Connection status: connected, failed, needs-auth, pending, disabled, stopped, or + not_configured + """ + error: str | None = None + """Error message if the server failed to connect""" + + source: McpServerSource | None = None + """Configuration source: user, workspace, plugin, or builtin""" + + source_plugin: str | None = None + """Plugin name that provided this server, when source is plugin.""" + + source_plugin_version: str | None = None + """Plugin version that provided this server, when source is plugin.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPServer': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + status = McpServerStatus(obj.get("status")) + error = from_union([from_str, from_none], obj.get("error")) + source = from_union([McpServerSource, from_none], obj.get("source")) + source_plugin = from_union([from_str, from_none], obj.get("sourcePlugin")) + source_plugin_version = from_union([from_str, from_none], obj.get("sourcePluginVersion")) + return MCPServer(name, status, error, source, source_plugin, source_plugin_version) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["status"] = to_enum(McpServerStatus, self.status) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(McpServerSource, x), from_none], self.source) + if self.source_plugin is not None: + result["sourcePlugin"] = from_union([from_str, from_none], self.source_plugin) + if self.source_plugin_version is not None: + result["sourcePluginVersion"] = from_union([from_str, from_none], self.source_plugin_version) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginList: + """Plugins installed for the session, with their enabled state and version metadata.""" + + plugins: list[Plugin] + """Installed plugins""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginList': + assert isinstance(obj, dict) + plugins = from_list(Plugin.from_dict, obj.get("plugins")) + return PluginList(plugins) + + def to_dict(self) -> dict: + result: dict = {} + result["plugins"] = from_list(lambda x: to_class(Plugin, x), self.plugins) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginUpdateAllEntry: + """Per-plugin result from updating all plugins, with versions, skills installed, success + flag, and optional error. + """ + marketplace: str + """Marketplace the plugin came from. Empty string ("") for direct installs.""" + + name: str + """Plugin name that was updated""" + + success: bool + """Whether the update succeeded for this plugin""" + + error: str | None = None + """Error message (failure only)""" + + new_version: str | None = None + """Version after the update, when available""" + + previous_version: str | None = None + """Previously installed version, when available""" + + skills_installed: int | None = None + """Number of skills installed after the update (success only)""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginUpdateAllEntry': + assert isinstance(obj, dict) + marketplace = from_str(obj.get("marketplace")) + name = from_str(obj.get("name")) + success = from_bool(obj.get("success")) + error = from_union([from_str, from_none], obj.get("error")) + new_version = from_union([from_str, from_none], obj.get("newVersion")) + previous_version = from_union([from_str, from_none], obj.get("previousVersion")) + skills_installed = from_union([from_int, from_none], obj.get("skillsInstalled")) + return PluginUpdateAllEntry(marketplace, name, success, error, new_version, previous_version, skills_installed) + + def to_dict(self) -> dict: + result: dict = {} + result["marketplace"] = from_str(self.marketplace) + result["name"] = from_str(self.name) + result["success"] = from_bool(self.success) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.new_version is not None: + result["newVersion"] = from_union([from_str, from_none], self.new_version) + if self.previous_version is not None: + result["previousVersion"] = from_union([from_str, from_none], self.previous_version) + if self.skills_installed is not None: + result["skillsInstalled"] = from_union([from_int, from_none], self.skills_installed) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginsDisableRequest: + """Plugin names (or specs) to disable.""" + + names: list[str] + """Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. + Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. + Plugin-owned MCP servers are stopped in active sessions immediately; other plugin + contributions remain available until each session reloads plugins. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PluginsDisableRequest': + assert isinstance(obj, dict) + names = from_list(from_str, obj.get("names")) + return PluginsDisableRequest(names) + + def to_dict(self) -> dict: + result: dict = {} + result["names"] = from_list(from_str, self.names) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginsEnableRequest: + """Plugin names (or specs) to enable.""" + + names: list[str] + """Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. + Non-marketplace direct installs are always enabled and cannot be toggled via this API. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PluginsEnableRequest': + assert isinstance(obj, dict) + names = from_list(from_str, obj.get("names")) + return PluginsEnableRequest(names) + + def to_dict(self) -> dict: + result: dict = {} + result["names"] = from_list(from_str, self.names) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginsInstallRequest: + """Plugin source and optional working directory for relative-path resolution.""" + + source: str + """Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace + install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or + a local path. Direct (non-marketplace) installs are deprecated and will produce a + deprecationWarning in the result. + """ + working_directory: str | None = None + """Working directory used to resolve relative local paths in `source`. Defaults to the + server's current working directory. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PluginsInstallRequest': + assert isinstance(obj, dict) + source = from_str(obj.get("source")) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + return PluginsInstallRequest(source, working_directory) + + def to_dict(self) -> dict: + result: dict = {} + result["source"] = from_str(self.source) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginsUninstallRequest: + """Name (or spec) of the plugin to uninstall.""" + + name: str + """Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the + fully-qualified spec. + """ + direct_source_id: str | None = None + """Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall + when multiple installed plugins share the same name. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PluginsUninstallRequest': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + direct_source_id = from_union([from_none, from_str], obj.get("directSourceId")) + return PluginsUninstallRequest(name, direct_source_id) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + if self.direct_source_id is not None: + result["directSourceId"] = from_union([from_none, from_str], self.direct_source_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginsUpdateRequest: + """Name (or spec) of the plugin to update.""" + + name: str + """Plugin name or "plugin@marketplace" spec to update.""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginsUpdateRequest': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + return PluginsUpdateRequest(name) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ProviderEndpoint: + """A snapshot of the provider endpoint the session is currently configured to talk to.""" + + base_url: str + """Base URL to pass to the LLM client library.""" + + headers: dict[str, str] + """HTTP headers the caller must include on every outbound request.""" + + type: ProviderType + """Provider family. Matches the `type` field of a BYOK provider config.""" + + api_key: str | None = None + """A credential the caller should use with this endpoint. Omitted only when the endpoint + accepts unauthenticated requests. + """ + session_token: ProviderSessionToken | None = None + """Short-lived, rotating credential the caller must send on every request, in addition to + `apiKey` if one is present. Omitted when the endpoint does not require one. + """ + transport: ProviderTransport | None = None + """Transport to be used for provider requests.""" + + wire_api: ProviderWireAPI | None = None + """Wire API to be used, when required for the provider type.""" + + @staticmethod + def from_dict(obj: Any) -> 'ProviderEndpoint': + assert isinstance(obj, dict) + base_url = from_str(obj.get("baseUrl")) + headers = from_dict(from_str, obj.get("headers")) + type = ProviderType(obj.get("type")) + api_key = from_union([from_str, from_none], obj.get("apiKey")) + session_token = from_union([ProviderSessionToken.from_dict, from_none], obj.get("sessionToken")) + transport = from_union([ProviderTransport, from_none], obj.get("transport")) + wire_api = from_union([ProviderWireAPI, from_none], obj.get("wireApi")) + return ProviderEndpoint(base_url, headers, type, api_key, session_token, transport, wire_api) + + def to_dict(self) -> dict: + result: dict = {} + result["baseUrl"] = from_str(self.base_url) + result["headers"] = from_dict(from_str, self.headers) + result["type"] = to_enum(ProviderType, self.type) + if self.api_key is not None: + result["apiKey"] = from_union([from_str, from_none], self.api_key) + if self.session_token is not None: + result["sessionToken"] = from_union([lambda x: to_class(ProviderSessionToken, x), from_none], self.session_token) + if self.transport is not None: + result["transport"] = from_union([lambda x: to_enum(ProviderTransport, x), from_none], self.transport) + if self.wire_api is not None: + result["wireApi"] = from_union([lambda x: to_enum(ProviderWireAPI, x), from_none], self.wire_api) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubFileDiffSide: + """File location on the base side of the diff. Absent for additions. + + One side of a file diff (head or base) + + File location on the head side of the diff. Absent for deletions. + """ + path: str + """Repository-relative path to the file""" + + ref: str + """Git ref (branch, tag, or commit SHA) the file is read at""" + + repo: PushGitHubRepoRef + """Repository the file lives in""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubFileDiffSide': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + return PushAttachmentGitHubFileDiffSide(path, ref, repo) + + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubTreeComparisonSide: + """Base side of the comparison + + One side of a tree comparison (head or base) + + Head side of the comparison + """ + repo: PushGitHubRepoRef + """Repository the revision belongs to""" + + revision: str + """Git revision (branch, tag, or commit SHA)""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubTreeComparisonSide': + assert isinstance(obj, dict) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + revision = from_str(obj.get("revision")) + return PushAttachmentGitHubTreeComparisonSide(repo, revision) + + def to_dict(self) -> dict: + result: dict = {} + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["revision"] = from_str(self.revision) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentSelectionDetails: + """Position range of the selection within the file""" + + end: PushAttachmentSelectionDetailsEnd + """End position of the selection""" + + start: PushAttachmentSelectionDetailsStart + """Start position of the selection""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentSelectionDetails': + assert isinstance(obj, dict) + end = PushAttachmentSelectionDetailsEnd.from_dict(obj.get("end")) + start = PushAttachmentSelectionDetailsStart.from_dict(obj.get("start")) + return PushAttachmentSelectionDetails(end, start) + + def to_dict(self) -> dict: + result: dict = {} + result["end"] = to_class(PushAttachmentSelectionDetailsEnd, self.end) + result["start"] = to_class(PushAttachmentSelectionDetailsStart, self.start) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentBlob: + """Blob attachment with inline base64-encoded data""" + + data: str + """Base64-encoded content""" + + mime_type: str + """MIME type of the inline data""" + + type: ClassVar[str] = "blob" + """Attachment type discriminator""" + + display_name: str | None = None + """User-facing display name for the attachment""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentBlob': + assert isinstance(obj, dict) + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + display_name = from_union([from_str, from_none], obj.get("displayName")) + return PushAttachmentBlob(data, mime_type, display_name) + + def to_dict(self) -> dict: + result: dict = {} + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = self.type + if self.display_name is not None: + result["displayName"] = from_union([from_str, from_none], self.display_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentFile: + """File attachment""" + + display_name: str + """User-facing display name for the attachment""" + + path: str + """Absolute file path""" + + type: ClassVar[str] = "file" + """Attachment type discriminator""" + + line_range: PushAttachmentFileLineRange | None = None + """Optional line range to scope the attachment to a specific section of the file""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentFile': + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + path = from_str(obj.get("path")) + line_range = from_union([PushAttachmentFileLineRange.from_dict, from_none], obj.get("lineRange")) + return PushAttachmentFile(display_name, path, line_range) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["path"] = from_str(self.path) + result["type"] = self.type + if self.line_range is not None: + result["lineRange"] = from_union([lambda x: to_class(PushAttachmentFileLineRange, x), from_none], self.line_range) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubActionsJob: + """Pointer to a GitHub Actions job.""" + + job_id: int + """Job id within the workflow run""" + + job_name: str + """Display name of the job""" + + repo: PushGitHubRepoRef + """Repository the workflow run belongs to""" + + type: ClassVar[str] = "github_actions_job" + """Attachment type discriminator""" + + url: str + """URL to the job on GitHub""" + + workflow_name: str + """Display name of the workflow the job ran in""" + + conclusion: str | None = None + """Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent + for in-progress jobs. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubActionsJob': + assert isinstance(obj, dict) + job_id = from_int(obj.get("jobId")) + job_name = from_str(obj.get("jobName")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + workflow_name = from_str(obj.get("workflowName")) + conclusion = from_union([from_str, from_none], obj.get("conclusion")) + return PushAttachmentGitHubActionsJob(job_id, job_name, repo, url, workflow_name, conclusion) + + def to_dict(self) -> dict: + result: dict = {} + result["jobId"] = from_int(self.job_id) + result["jobName"] = from_str(self.job_name) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + result["workflowName"] = from_str(self.workflow_name) + if self.conclusion is not None: + result["conclusion"] = from_union([from_str, from_none], self.conclusion) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubCommit: + """Pointer to a GitHub commit.""" + + message: str + """First line of the commit message""" + + oid: str + """Full commit SHA""" + + repo: PushGitHubRepoRef + """Repository the commit belongs to""" + + type: ClassVar[str] = "github_commit" + """Attachment type discriminator""" + + url: str + """URL to the commit on GitHub""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubCommit': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + oid = from_str(obj.get("oid")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubCommit(message, oid, repo, url) + + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + result["oid"] = from_str(self.oid) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubFile: + """Pointer to a file in a GitHub repository at a specific ref.""" + + path: str + """Repository-relative path to the file""" + + ref: str + """Git ref the file is read at (branch, tag, or commit SHA)""" + + repo: PushGitHubRepoRef + """Repository the file lives in""" + + type: ClassVar[str] = "github_file" + """Attachment type discriminator""" + + url: str + """URL to the file on GitHub""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubFile': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubFile(path, ref, repo, url) + + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubReference: + """GitHub issue, pull request, or discussion reference""" + + number: int + """Issue, pull request, or discussion number""" + + reference_type: PushAttachmentGitHubReferenceTypeEnum + """Type of GitHub reference""" + + state: str + """Current state of the referenced item (e.g., open, closed, merged)""" + + title: str + """Title of the referenced item""" + + type: ClassVar[str] = "github_reference" + """Attachment type discriminator""" + + url: str + """URL to the referenced item on GitHub""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubReference': + assert isinstance(obj, dict) + number = from_int(obj.get("number")) + reference_type = PushAttachmentGitHubReferenceTypeEnum(obj.get("referenceType")) + state = from_str(obj.get("state")) + title = from_str(obj.get("title")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubReference(number, reference_type, state, title, url) + + def to_dict(self) -> dict: + result: dict = {} + result["number"] = from_int(self.number) + result["referenceType"] = to_enum(PushAttachmentGitHubReferenceTypeEnum, self.reference_type) + result["state"] = from_str(self.state) + result["title"] = from_str(self.title) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubRelease: + """Pointer to a GitHub release.""" + + name: str + """Human-readable release name""" + + repo: PushGitHubRepoRef + """Repository the release belongs to""" + + tag_name: str + """Git tag the release is anchored to""" + + type: ClassVar[str] = "github_release" + """Attachment type discriminator""" + + url: str + """URL to the release on GitHub""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubRelease': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + tag_name = from_str(obj.get("tagName")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubRelease(name, repo, tag_name, url) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["tagName"] = from_str(self.tag_name) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubRepository: + """Pointer to a GitHub repository.""" + + repo: PushGitHubRepoRef + """Repository pointer""" + + type: ClassVar[str] = "github_repository" + """Attachment type discriminator""" + + url: str + """URL to the repository on GitHub""" + + description: str | None = None + """Short description of the repository""" + + ref: str | None = None + """Git ref this attachment is anchored at (branch, tag, or commit). When absent the default + branch is implied. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubRepository': + assert isinstance(obj, dict) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + description = from_union([from_str, from_none], obj.get("description")) + ref = from_union([from_str, from_none], obj.get("ref")) + return PushAttachmentGitHubRepository(repo, url, description, ref) + + def to_dict(self) -> dict: + result: dict = {} + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.ref is not None: + result["ref"] = from_union([from_str, from_none], self.ref) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubSnippet: + """Pointer to a line range inside a file in a GitHub repository.""" + + line_range: PushAttachmentFileLineRange + """Line range the snippet covers""" + + path: str + """Repository-relative path to the file""" + + ref: str + """Git ref the file is read at (branch, tag, or commit SHA)""" + + repo: PushGitHubRepoRef + """Repository the file lives in""" + + type: ClassVar[str] = "github_snippet" + """Attachment type discriminator""" + + url: str + """URL to the snippet on GitHub (with line anchor)""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubSnippet': + assert isinstance(obj, dict) + line_range = PushAttachmentFileLineRange.from_dict(obj.get("lineRange")) + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = PushGitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubSnippet(line_range, path, ref, repo, url) + + def to_dict(self) -> dict: + result: dict = {} + result["lineRange"] = to_class(PushAttachmentFileLineRange, self.line_range) + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(PushGitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubURL: + """Generic GitHub URL reference.""" + + type: ClassVar[str] = "github_url" + """Attachment type discriminator""" + + url: str + """URL to the GitHub resource""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubURL': + assert isinstance(obj, dict) + url = from_str(obj.get("url")) + return PushAttachmentGitHubURL(url) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueInsertMessage: + """Serializable message fields accepted by queue.insertAt.""" + + prompt: str + """The user message text.""" + + agent_mode: SendAgentMode | None = None + """Optional explicit agent mode. When omitted, the session's current mode is assigned.""" + + attachments: list[Attachment] | None = None + """Optional attachments for the message.""" + + billable: bool | None = None + """Whether the message is billable.""" + + delivery: str | None = None + """Accepted for internal SendOptions compatibility but ignored; delivery is derived from + current session activity. + """ + display_prompt: str | None = None + """Optional user-facing display text.""" + + mode: SendMode | None = None + """Accepted for SendOptions compatibility but ignored; inserted items always use queued + delivery semantics. + """ + prepend: bool | None = None + """Accepted for SendOptions compatibility but ignored; the requested public position + controls placement. + """ + request_headers: dict[str, str] | None = None + """Per-turn request headers.""" + + required_tool: str | None = None + """Required tool name for the turn, when any.""" + + source: str | None = None + """Optional provenance source. `system` is rejected: it would hide the inserted row from + `pendingItems` and make it unaddressable while still executing, so inserted items must + stay visible. + """ + wait: bool | None = None + """Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by + the queue drain state. + """ + + @staticmethod + def from_dict(obj: Any) -> 'QueueInsertMessage': + assert isinstance(obj, dict) + prompt = from_str(obj.get("prompt")) + agent_mode = from_union([SendAgentMode, from_none], obj.get("agentMode")) + attachments = from_union([lambda x: from_list(Attachment.from_dict, x), from_none], obj.get("attachments")) + billable = from_union([from_bool, from_none], obj.get("billable")) + delivery = from_union([from_str, from_none], obj.get("delivery")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + mode = from_union([SendMode, from_none], obj.get("mode")) + prepend = from_union([from_bool, from_none], obj.get("prepend")) + request_headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("requestHeaders")) + required_tool = from_union([from_str, from_none], obj.get("requiredTool")) + source = from_union([from_str, from_none], obj.get("source")) + wait = from_union([from_bool, from_none], obj.get("wait")) + return QueueInsertMessage(prompt, agent_mode, attachments, billable, delivery, display_prompt, mode, prepend, request_headers, required_tool, source, wait) + + def to_dict(self) -> dict: + result: dict = {} + result["prompt"] = from_str(self.prompt) + if self.agent_mode is not None: + result["agentMode"] = from_union([lambda x: to_enum(SendAgentMode, x), from_none], self.agent_mode) + if self.attachments is not None: + result["attachments"] = from_union([lambda x: from_list(lambda x: to_class(Attachment, x), x), from_none], self.attachments) + if self.billable is not None: + result["billable"] = from_union([from_bool, from_none], self.billable) + if self.delivery is not None: + result["delivery"] = from_union([from_str, from_none], self.delivery) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(SendMode, x), from_none], self.mode) + if self.prepend is not None: + result["prepend"] = from_union([from_bool, from_none], self.prepend) + if self.request_headers is not None: + result["requestHeaders"] = from_union([lambda x: from_dict(from_str, x), from_none], self.request_headers) + if self.required_tool is not None: + result["requiredTool"] = from_union([from_str, from_none], self.required_tool) + if self.source is not None: + result["source"] = from_union([from_str, from_none], self.source) + if self.wait is not None: + result["wait"] = from_union([from_bool, from_none], self.wait) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SendRequest: + """Parameters for sending a user message to the session""" + + prompt: str + """The user message text""" + + agent_mode: SendAgentMode | None = None + """The UI mode the agent was in when this message was sent. Defaults to the session's + current mode. + """ + attachments: list[Attachment] | None = None + """Optional attachments (files, directories, selections, blobs, GitHub references) to + include with the message + """ + billable: bool | None = None + """If false, this message will not trigger a Premium Request Unit charge. User messages + default to billable. + """ + display_prompt: str | None = None + """If provided, this is shown in the timeline instead of `prompt`""" + + mode: SendMode | None = None + """How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` + interjects during an in-progress turn. + """ + prepend: bool | None = None + """If true, adds the message to the front of the queue instead of the end""" + + request_headers: dict[str, str] | None = None + """Custom HTTP headers to include in outbound model requests for this turn. Merged with + session-level provider headers; per-turn headers augment and overwrite session-level + headers with the same key. + """ + required_tool: str | None = None + """If set, the request will fail if the named tool is not available when this message is + among the user messages at the start of the current exchange + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + source: str | None = None + """Optional provenance tag copied to the resulting user.message event. Must be `user`, + `system`, `command-` for command-originated messages, `schedule-` + for scheduled prompts, or `agent-` for prompts sent by another agent. + """ + traceparent: str | None = None + """W3C Trace Context traceparent header for distributed tracing of this agent turn""" + + tracestate: str | None = None + """W3C Trace Context tracestate header for distributed tracing""" + + wait: bool | None = None + """If true, await completion of the agentic loop for this message before returning. Defaults + to false (fire-and-forget). When true, the result still contains the same `messageId`; + the caller can rely on the agent having processed the message before the call resolves. + Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally + blocks until the completed turn's event tail has been dispatched to this session's + in-process subscribers, so a subsequent read of subscriber state already reflects the + turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery + follows over the wire. Callers that need the stronger local guarantee on remote sessions + should await the event stream explicitly. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SendRequest': + assert isinstance(obj, dict) + prompt = from_str(obj.get("prompt")) + agent_mode = from_union([SendAgentMode, from_none], obj.get("agentMode")) + attachments = from_union([lambda x: from_list(Attachment.from_dict, x), from_none], obj.get("attachments")) + billable = from_union([from_bool, from_none], obj.get("billable")) + display_prompt = from_union([from_str, from_none], obj.get("displayPrompt")) + mode = from_union([SendMode, from_none], obj.get("mode")) + prepend = from_union([from_bool, from_none], obj.get("prepend")) + request_headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("requestHeaders")) + required_tool = from_union([from_str, from_none], obj.get("requiredTool")) + source = from_union([from_str, from_none], obj.get("source")) + traceparent = from_union([from_str, from_none], obj.get("traceparent")) + tracestate = from_union([from_str, from_none], obj.get("tracestate")) + wait = from_union([from_bool, from_none], obj.get("wait")) + return SendRequest(prompt, agent_mode, attachments, billable, display_prompt, mode, prepend, request_headers, required_tool, source, traceparent, tracestate, wait) + + def to_dict(self) -> dict: + result: dict = {} + result["prompt"] = from_str(self.prompt) + if self.agent_mode is not None: + result["agentMode"] = from_union([lambda x: to_enum(SendAgentMode, x), from_none], self.agent_mode) + if self.attachments is not None: + result["attachments"] = from_union([lambda x: from_list(lambda x: to_class(Attachment, x), x), from_none], self.attachments) + if self.billable is not None: + result["billable"] = from_union([from_bool, from_none], self.billable) + if self.display_prompt is not None: + result["displayPrompt"] = from_union([from_str, from_none], self.display_prompt) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(SendMode, x), from_none], self.mode) + if self.prepend is not None: + result["prepend"] = from_union([from_bool, from_none], self.prepend) + if self.request_headers is not None: + result["requestHeaders"] = from_union([lambda x: from_dict(from_str, x), from_none], self.request_headers) + if self.required_tool is not None: + result["requiredTool"] = from_union([from_str, from_none], self.required_tool) + if self.source is not None: + result["source"] = from_union([from_str, from_none], self.source) + if self.traceparent is not None: + result["traceparent"] = from_union([from_str, from_none], self.traceparent) + if self.tracestate is not None: + result["tracestate"] = from_union([from_str, from_none], self.tracestate) + if self.wait is not None: + result["wait"] = from_union([from_bool, from_none], self.wait) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueuePendingItems: + """User-facing pending queue entry, with kind and display text for a queued message, slash + command, or model change. + """ + agent_mode: SendAgentMode + """Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an + explicit mode report interactive. This is not necessarily the mode that will constrain + the turn: a plan or autopilot session applies its own write gate, continuation loop and + permission posture to every drained item regardless of the mode stored here. + """ + display_text: str + """Human-readable text to display for this queue entry in the UI""" + + id: str + """Stable opaque id for the canonical queued item. Batch rows share one id.""" + + kind: QueuePendingItemsKind + """Whether this item is a queued user message or a queued slash command / model change""" + + @staticmethod + def from_dict(obj: Any) -> 'QueuePendingItems': + assert isinstance(obj, dict) + agent_mode = SendAgentMode(obj.get("agentMode")) + display_text = from_str(obj.get("displayText")) + id = from_str(obj.get("id")) + kind = QueuePendingItemsKind(obj.get("kind")) + return QueuePendingItems(agent_mode, display_text, id, kind) + + def to_dict(self) -> dict: + result: dict = {} + result["agentMode"] = to_enum(SendAgentMode, self.agent_mode) + result["displayText"] = from_str(self.display_text) + result["id"] = from_str(self.id) + result["kind"] = to_enum(QueuePendingItemsKind, self.kind) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _RegisterExtensionToolsParams: + """Params to attach an extension loader's tools to a session.""" + + loader: Any + """In-process ExtensionLoader handle (CLI-only optimization). Marked internal: this field is + excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, + extension discovery/launch moves entirely into the runtime — the CLI passes pure config + (search paths, disabled ids) via SessionOptions instead. + """ + session_id: str + """Session to register extension tools on.""" + + options: SessionsRegisterExtensionToolsOnSessionOptions | None = None + """Optional registration options.""" + + @staticmethod + def from_dict(obj: Any) -> '_RegisterExtensionToolsParams': + assert isinstance(obj, dict) + loader = obj.get("loader") + session_id = from_str(obj.get("sessionId")) + options = from_union([SessionsRegisterExtensionToolsOnSessionOptions.from_dict, from_none], obj.get("options")) + return _RegisterExtensionToolsParams(loader, session_id, options) + + def to_dict(self) -> dict: + result: dict = {} + result["loader"] = self.loader + result["sessionId"] = from_str(self.session_id) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionsRegisterExtensionToolsOnSessionOptions, x), from_none], self.options) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteControlConfig: + """Configuration for the runtime-managed remote-control singleton.""" + + explicit: bool + """Whether the user explicitly requested remote (vs. implicit session-sync). Controls + warning surfacing for missing-repo cases. + """ + remote: bool + """Whether remote export should be enabled.""" + + silent: bool + """When true, suppresses timeline messages on successful setup.""" + + steerable: bool + """Whether the MC session may steer the local session (write mode).""" + + existing_mc_session: RemoteControlConfigExistingMcSession | None = None + """Reattach to an existing MC session without creating a new one.""" + + task_id: str | None = None + """Existing Mission Control task ID to attach the exported session to.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteControlConfig': + assert isinstance(obj, dict) + explicit = from_bool(obj.get("explicit")) + remote = from_bool(obj.get("remote")) + silent = from_bool(obj.get("silent")) + steerable = from_bool(obj.get("steerable")) + existing_mc_session = from_union([RemoteControlConfigExistingMcSession.from_dict, from_none], obj.get("existingMcSession")) + task_id = from_union([from_str, from_none], obj.get("taskId")) + return RemoteControlConfig(explicit, remote, silent, steerable, existing_mc_session, task_id) + + def to_dict(self) -> dict: + result: dict = {} + result["explicit"] = from_bool(self.explicit) + result["remote"] = from_bool(self.remote) + result["silent"] = from_bool(self.silent) + result["steerable"] = from_bool(self.steerable) + if self.existing_mc_session is not None: + result["existingMcSession"] = from_union([lambda x: to_class(RemoteControlConfigExistingMcSession, x), from_none], self.existing_mc_session) + if self.task_id is not None: + result["taskId"] = from_union([from_str, from_none], self.task_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteControlStatusActive: + """Remote control is connected to a local session.""" + + attached_session_id: str + """Session id remote control is pointed at.""" + + is_steerable: bool + """Whether the MC session may steer this session.""" + + state: ClassVar[str] = "active" + """Remote control state tag: active.""" + + # Internal: this field is an internal SDK API and is not part of the public surface. + awaiting_first_message: bool | None = None + """True while a read-only/session-sync export is deferred, awaiting the first `user.message` + before its MC session exists. Marked internal: this field is excluded from the public SDK + surface and is populated only on the CLI in-process path. + """ + frontend_url: str | None = None + """MC frontend URL for this session, when known.""" + + # Internal: this field is an internal SDK API and is not part of the public surface. + prompt_manager: Any = None + """In-process prompt-manager handle (CLI-only optimization). Marked internal: this field is + excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, + the same bidirectional prompt-routing handshake is expressed via dedicated remote-control + RPCs (register/resolve) rather than a shared in-process object. + """ + + @staticmethod + def from_dict(obj: Any) -> 'RemoteControlStatusActive': + assert isinstance(obj, dict) + attached_session_id = from_str(obj.get("attachedSessionId")) + is_steerable = from_bool(obj.get("isSteerable")) + awaiting_first_message = from_union([from_bool, from_none], obj.get("awaitingFirstMessage")) + frontend_url = from_union([from_str, from_none], obj.get("frontendUrl")) + prompt_manager = obj.get("promptManager") + return RemoteControlStatusActive(attached_session_id, is_steerable, awaiting_first_message, frontend_url, prompt_manager) + + def to_dict(self) -> dict: + result: dict = {} + result["attachedSessionId"] = from_str(self.attached_session_id) + result["isSteerable"] = from_bool(self.is_steerable) + result["state"] = self.state + if self.awaiting_first_message is not None: + result["awaitingFirstMessage"] = from_union([from_bool, from_none], self.awaiting_first_message) + if self.frontend_url is not None: + result["frontendUrl"] = from_union([from_str, from_none], self.frontend_url) + if self.prompt_manager is not None: + result["promptManager"] = self.prompt_manager + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteControlStatusConnecting: + """Remote control is in the middle of initial setup.""" + + attached_session_id: str + """Session id the connection is attaching to.""" + + state: ClassVar[str] = "connecting" + """Remote control state tag: connecting.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteControlStatusConnecting': + assert isinstance(obj, dict) + attached_session_id = from_str(obj.get("attachedSessionId")) + return RemoteControlStatusConnecting(attached_session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["attachedSessionId"] = from_str(self.attached_session_id) + result["state"] = self.state + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteControlStatusError: + """The last setup attempt failed. The singleton is otherwise off.""" + + error: str + """Human-readable error message from the last setup attempt.""" + + state: ClassVar[str] = "error" + """Remote control state tag: setup failed.""" + + attached_session_id: str | None = None + """Session id the failing setup attempt targeted, when known.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteControlStatusError': + assert isinstance(obj, dict) + error = from_str(obj.get("error")) + attached_session_id = from_union([from_str, from_none], obj.get("attachedSessionId")) + return RemoteControlStatusError(error, attached_session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["error"] = from_str(self.error) + result["state"] = self.state + if self.attached_session_id is not None: + result["attachedSessionId"] = from_union([from_str, from_none], self.attached_session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteControlStatusOff: + """Remote control is not connected.""" + + state: ClassVar[str] = "off" + """Remote control state tag: not connected.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteControlStatusOff': + assert isinstance(obj, dict) + return RemoteControlStatusOff() + + def to_dict(self) -> dict: + result: dict = {} + result["state"] = self.state + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteEnableRequest: + """Optional remote session mode ("off", "export", or "on"); defaults to enabling both export + and remote steering. + """ + mode: RemoteSessionMode | None = None + """Per-session remote mode. "off" disables remote, "export" exports session events to GitHub + without enabling remote steering, "on" enables both export and remote steering. + """ + + @staticmethod + def from_dict(obj: Any) -> 'RemoteEnableRequest': + assert isinstance(obj, dict) + mode = from_union([RemoteSessionMode, from_none], obj.get("mode")) + return RemoteEnableRequest(mode) + + def to_dict(self) -> dict: + result: dict = {} + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(RemoteSessionMode, x), from_none], self.mode) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SandboxConfigUserPolicyExperimental: + """Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is + absent. + + Platform-specific experimental policy fields. + """ + seatbelt: SandboxConfigUserPolicyExperimentalSeatbelt | None = None + """macOS seatbelt experimental options.""" + + @staticmethod + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyExperimental': + assert isinstance(obj, dict) + seatbelt = from_union([SandboxConfigUserPolicyExperimentalSeatbelt.from_dict, from_none], obj.get("seatbelt")) + return SandboxConfigUserPolicyExperimental(seatbelt) + + def to_dict(self) -> dict: + result: dict = {} + if self.seatbelt is not None: + result["seatbelt"] = from_union([lambda x: to_class(SandboxConfigUserPolicyExperimentalSeatbelt, x), from_none], self.seatbelt) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SandboxConfigUserPolicyNetwork: + """Network rules to merge into the base policy.""" + + allow_local_network: bool | None = None + """Whether traffic to local/loopback addresses is allowed.""" + + allow_outbound: bool | None = None + """Whether outbound network traffic is allowed at all.""" + + proxy: SandboxConfigUserPolicyNetworkProxy | None = None + """HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and + cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. + Credentials go in the separate `username`/`password` fields. A credential-free http:// + loopback proxy URL is routed through the localhost proxy automatically; an https:// or + authenticated loopback URL is used as-is. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SandboxConfigUserPolicyNetwork': + assert isinstance(obj, dict) + allow_local_network = from_union([from_bool, from_none], obj.get("allowLocalNetwork")) + allow_outbound = from_union([from_bool, from_none], obj.get("allowOutbound")) + proxy = from_union([SandboxConfigUserPolicyNetworkProxy.from_dict, from_none], obj.get("proxy")) + return SandboxConfigUserPolicyNetwork(allow_local_network, allow_outbound, proxy) + + def to_dict(self) -> dict: + result: dict = {} + if self.allow_local_network is not None: + result["allowLocalNetwork"] = from_union([from_bool, from_none], self.allow_local_network) + if self.allow_outbound is not None: + result["allowOutbound"] = from_union([from_bool, from_none], self.allow_outbound) + if self.proxy is not None: + result["proxy"] = from_union([lambda x: to_class(SandboxConfigUserPolicyNetworkProxy, x), from_none], self.proxy) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ScheduleAddResult: + """Result of registering or re-arming a scheduled prompt.""" + + entry: ScheduleEntry | None = None + """The registered or updated schedule entry.""" + + error: str | None = None + """User-facing validation error, when registration failed.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleAddResult': + assert isinstance(obj, dict) + entry = from_union([ScheduleEntry.from_dict, from_none], obj.get("entry")) + error = from_union([from_str, from_none], obj.get("error")) + return ScheduleAddResult(entry, error) + + def to_dict(self) -> dict: + result: dict = {} + if self.entry is not None: + result["entry"] = from_union([lambda x: to_class(ScheduleEntry, x), from_none], self.entry) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ScheduleList: + """Snapshot of the currently active recurring prompts for this session.""" + + entries: list[ScheduleEntry] + """Active scheduled prompts, ordered by id.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleList': + assert isinstance(obj, dict) + entries = from_list(ScheduleEntry.from_dict, obj.get("entries")) + return ScheduleList(entries) + + def to_dict(self) -> dict: + result: dict = {} + result["entries"] = from_list(lambda x: to_class(ScheduleEntry, x), self.entries) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ScheduleStopResult: + """Remove a scheduled prompt by id. The result entry is omitted if the id was unknown.""" + + entry: ScheduleEntry | None = None + """The removed entry, or omitted if no entry matched.""" + + @staticmethod + def from_dict(obj: Any) -> 'ScheduleStopResult': + assert isinstance(obj, dict) + entry = from_union([ScheduleEntry.from_dict, from_none], obj.get("entry")) + return ScheduleStopResult(entry) + + def to_dict(self) -> dict: + result: dict = {} + if self.entry is not None: + result["entry"] = from_union([lambda x: to_class(ScheduleEntry, x), from_none], self.entry) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SendMessagesRequest: + """Parameters for sending zero or more user messages to the session in a single turn. + Remote-backed (Mission Control) sessions do not support this method and will return an + error. + """ + messages: list[SendMessageItem] + """The user messages to append to the conversation, in order. May be empty, in which case a + single turn runs over the existing history with no new user message. + """ + agent_mode: SendAgentMode | None = None + """The UI mode the agent was in when these messages were sent. Defaults to the session's + current mode. + """ + mode: SendMode | None = None + """How to deliver the messages. `enqueue` (default) appends to the message queue. + `immediate` interjects during an in-progress turn. + """ + prepend: bool | None = None + """If true, adds the messages to the front of the queue instead of the end""" + + request_headers: dict[str, str] | None = None + """Custom HTTP headers to include in outbound model requests for this turn. Merged with + session-level provider headers; per-turn headers augment and overwrite session-level + headers with the same key. + """ + traceparent: str | None = None + """W3C Trace Context traceparent header for distributed tracing of this agent turn""" + + tracestate: str | None = None + """W3C Trace Context tracestate header for distributed tracing""" + + wait: bool | None = None + """If true, await completion of the agentic loop for this turn before returning. Defaults to + false (fire-and-forget). When true, the result still contains the same `messageIds`; the + caller can rely on the agent having processed the messages before the call resolves. + Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally + blocks until the completed turn's event tail has been dispatched to this session's + in-process subscribers, so a subsequent read of subscriber state already reflects the + turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery + follows over the wire. Callers that need the stronger local guarantee on remote sessions + should await the event stream explicitly. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SendMessagesRequest': + assert isinstance(obj, dict) + messages = from_list(SendMessageItem.from_dict, obj.get("messages")) + agent_mode = from_union([SendAgentMode, from_none], obj.get("agentMode")) + mode = from_union([SendMode, from_none], obj.get("mode")) + prepend = from_union([from_bool, from_none], obj.get("prepend")) + request_headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("requestHeaders")) + traceparent = from_union([from_str, from_none], obj.get("traceparent")) + tracestate = from_union([from_str, from_none], obj.get("tracestate")) + wait = from_union([from_bool, from_none], obj.get("wait")) + return SendMessagesRequest(messages, agent_mode, mode, prepend, request_headers, traceparent, tracestate, wait) + + def to_dict(self) -> dict: + result: dict = {} + result["messages"] = from_list(lambda x: to_class(SendMessageItem, x), self.messages) + if self.agent_mode is not None: + result["agentMode"] = from_union([lambda x: to_enum(SendAgentMode, x), from_none], self.agent_mode) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(SendMode, x), from_none], self.mode) + if self.prepend is not None: + result["prepend"] = from_union([from_bool, from_none], self.prepend) + if self.request_headers is not None: + result["requestHeaders"] = from_union([lambda x: from_dict(from_str, x), from_none], self.request_headers) + if self.traceparent is not None: + result["traceparent"] = from_union([from_str, from_none], self.traceparent) + if self.tracestate is not None: + result["tracestate"] = from_union([from_str, from_none], self.tracestate) + if self.wait is not None: + result["wait"] = from_union([from_bool, from_none], self.wait) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ServerSkillList: + """Skills discovered across global and project sources.""" + + skills: list[ServerSkill] + """All discovered skills across all sources""" + + errors: list[str] | None = None + """Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills + are excluded so host-local paths are not disclosed to multitenant callers. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ServerSkillList': + assert isinstance(obj, dict) + skills = from_list(ServerSkill.from_dict, obj.get("skills")) + errors = from_union([lambda x: from_list(from_str, x), from_none], obj.get("errors")) + return ServerSkillList(skills, errors) + + def to_dict(self) -> dict: + result: dict = {} + result["skills"] = from_list(lambda x: to_class(ServerSkill, x), self.skills) + if self.errors is not None: + result["errors"] = from_union([lambda x: from_list(from_str, x), from_none], self.errors) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSError: + """Describes a filesystem error.""" + + code: SessionFSErrorCode + """Error classification""" + + message: str | None = None + """Free-form detail about the error, for logging/diagnostics""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSError': + assert isinstance(obj, dict) + code = SessionFSErrorCode(obj.get("code")) + message = from_union([from_str, from_none], obj.get("message")) + return SessionFSError(code, message) + + def to_dict(self) -> dict: + result: dict = {} + result["code"] = to_enum(SessionFSErrorCode, self.code) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSetProviderRequest: + """Initial working directory, session-state path layout, and path conventions used to + register the calling SDK client as the session filesystem provider. + """ + conventions: SessionFSSetProviderConventions + """Path conventions used by this filesystem""" + + initial_cwd: str + """Initial working directory for sessions""" + + session_state_path: str + """Path within each session's SessionFs where the runtime stores files for that session""" + + capabilities: SessionFSSetProviderCapabilities | None = None + """Optional capabilities declared by the provider""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSetProviderRequest': + assert isinstance(obj, dict) + conventions = SessionFSSetProviderConventions(obj.get("conventions")) + initial_cwd = from_str(obj.get("initialCwd")) + session_state_path = from_str(obj.get("sessionStatePath")) + capabilities = from_union([SessionFSSetProviderCapabilities.from_dict, from_none], obj.get("capabilities")) + return SessionFSSetProviderRequest(conventions, initial_cwd, session_state_path, capabilities) + + def to_dict(self) -> dict: + result: dict = {} + result["conventions"] = to_enum(SessionFSSetProviderConventions, self.conventions) + result["initialCwd"] = from_str(self.initial_cwd) + result["sessionStatePath"] = from_str(self.session_state_path) + if self.capabilities is not None: + result["capabilities"] = from_union([lambda x: to_class(SessionFSSetProviderCapabilities, x), from_none], self.capabilities) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteQueryRequest: + """SQL query, query type, and optional bind parameters for executing a SQLite query against + the per-session database. The provider applies its SQLite busy timeout for every call. + """ + query: str + """SQL query to execute""" + + query_type: SessionFSSqliteQueryType + """How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT + (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) + """ + session_id: str + """Target session identifier""" + + params: dict[str, Any] | None = None + """Optional named bind parameters""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteQueryRequest': + assert isinstance(obj, dict) + query = from_str(obj.get("query")) + query_type = SessionFSSqliteQueryType(obj.get("queryType")) + session_id = from_str(obj.get("sessionId")) + params = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("params")) + return SessionFSSqliteQueryRequest(query, query_type, session_id, params) + + def to_dict(self) -> dict: + result: dict = {} + result["query"] = from_str(self.query) + result["queryType"] = to_enum(SessionFSSqliteQueryType, self.query_type) + result["sessionId"] = from_str(self.session_id) + if self.params is not None: + result["params"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.params) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteTransactionStatement: + """One statement in an atomic SQLite transaction.""" + + query: str + """SQL statement to execute.""" + + query_type: SessionFSSqliteQueryType + """How to execute the statement.""" + + params: dict[str, Any] | None = None + """Optional named bind parameters.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteTransactionStatement': + assert isinstance(obj, dict) + query = from_str(obj.get("query")) + query_type = SessionFSSqliteQueryType(obj.get("queryType")) + params = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("params")) + return SessionFSSqliteTransactionStatement(query, query_type, params) + + def to_dict(self) -> dict: + result: dict = {} + result["query"] = from_str(self.query) + result["queryType"] = to_enum(SessionFSSqliteQueryType, self.query_type) + if self.params is not None: + result["params"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.params) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteTransactionError: + """Classified SQLite transaction failure. busyOrLocked guarantees rollback; + postCommitAmbiguous must never be retried. + """ + error_class: SessionFSSqliteTransactionErrorClass + message: str + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteTransactionError': + assert isinstance(obj, dict) + error_class = SessionFSSqliteTransactionErrorClass(obj.get("errorClass")) + message = from_str(obj.get("message")) + return SessionFSSqliteTransactionError(error_class, message) + + def to_dict(self) -> dict: + result: dict = {} + result["errorClass"] = to_enum(SessionFSSqliteTransactionErrorClass, self.error_class) + result["message"] = from_str(self.message) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CompletionsGetTriggerCharactersResult: + """Characters that, when typed in the composer, should trigger a `completions.request`. + Empty when the session has no host-driven completions (e.g. local sessions, or a relay + host that does not advertise `completionTriggerCharacters`). + """ + trigger_characters: list[str] + """Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven + completions for the session. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CompletionsGetTriggerCharactersResult': + assert isinstance(obj, dict) + trigger_characters = from_list(from_str, obj.get("triggerCharacters")) + return CompletionsGetTriggerCharactersResult(trigger_characters) + + def to_dict(self) -> dict: + result: dict = {} + result["triggerCharacters"] = from_list(from_str, self.trigger_characters) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionHistoryCompactRequest: + custom_instructions: str | None = None + """Optional user-provided instructions to focus the compaction summary""" + + token_limit: int | None = None + """Context window token limit this compaction is targeting, recorded as the `tokenLimit` on + the persisted `session.compaction_start` / `session.compaction_complete` events. Set it + when the compaction targets a window other than the compacting model's own, e.g. + switching to a model with a smaller context window: the compaction still runs on the + current model, so the limit that motivated it would otherwise be lost. When absent, the + events record the compacting model's own resolved limit. Attribution metadata only - it + does not change how much the compaction removes. + """ + trigger: Trigger | None = None + """What initiated this compaction request, recorded as the `trigger` on the persisted + `session.compaction_start` / `session.compaction_complete` events. When absent, the + compaction is persisted without trigger attribution (initiator unknown). + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionHistoryCompactRequest': + assert isinstance(obj, dict) + custom_instructions = from_union([from_str, from_none], obj.get("customInstructions")) + token_limit = from_union([from_int, from_none], obj.get("tokenLimit")) + trigger = from_union([Trigger, from_none], obj.get("trigger")) + return SessionHistoryCompactRequest(custom_instructions, token_limit, trigger) + + def to_dict(self) -> dict: + result: dict = {} + if self.custom_instructions is not None: + result["customInstructions"] = from_union([from_str, from_none], self.custom_instructions) + if self.token_limit is not None: + result["tokenLimit"] = from_union([from_int, from_none], self.token_limit) + if self.trigger is not None: + result["trigger"] = from_union([lambda x: to_enum(Trigger, x), from_none], self.trigger) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionLimitPredictionPredictRequest: + client_type: SessionLimitPredictionClientType | None = None + """Client type to size for. Defaults to `cli-interactive`.""" + + model_id: str | None = None + """Optional model identifier override. If omitted, the session's current model is used.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionLimitPredictionPredictRequest': + assert isinstance(obj, dict) + client_type = from_union([SessionLimitPredictionClientType, from_none], obj.get("clientType")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + return SessionLimitPredictionPredictRequest(client_type, model_id) + + def to_dict(self) -> dict: + result: dict = {} + if self.client_type is not None: + result["clientType"] = from_union([lambda x: to_enum(SessionLimitPredictionClientType, x), from_none], self.client_type) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionLimitPredictionTierOption: + """Semantic usage tier and its AI-credit cap.""" + + cap: float + """AI-credit cap for this tier.""" + + tier: SessionLimitPredictionTier + + @staticmethod + def from_dict(obj: Any) -> 'SessionLimitPredictionTierOption': + assert isinstance(obj, dict) + cap = from_float(obj.get("cap")) + tier = SessionLimitPredictionTier(obj.get("tier")) + return SessionLimitPredictionTierOption(cap, tier) + + def to_dict(self) -> dict: + result: dict = {} + result["cap"] = to_float(self.cap) + result["tier"] = to_enum(SessionLimitPredictionTier, self.tier) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionOpenOptionsAdditionalContentExclusionPolicyRule: + """Single content-exclusion rule supplied to `sessions.open` options, with paths, match + conditions, and source. + """ + paths: list[str] + source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource + """Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.""" + + if_any_match: list[str] | None = None + if_none_match: list[str] | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionOpenOptionsAdditionalContentExclusionPolicyRule': + assert isinstance(obj, dict) + paths = from_list(from_str, obj.get("paths")) + source = SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("source")) + if_any_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifAnyMatch")) + if_none_match = from_union([lambda x: from_list(from_str, x), from_none], obj.get("ifNoneMatch")) + return SessionOpenOptionsAdditionalContentExclusionPolicyRule(paths, source, if_any_match, if_none_match) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(from_str, self.paths) + result["source"] = to_class(SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource, self.source) + if self.if_any_match is not None: + result["ifAnyMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_any_match) + if self.if_none_match is not None: + result["ifNoneMatch"] = from_union([lambda x: from_list(from_str, x), from_none], self.if_none_match) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ShellInitScript: + """A host-provided script sourced before each built-in shell command when its shell target + matches the active shell. + """ + path: str + """Path to the script to source.""" + + shell: ShellInitScriptShell + """Built-in shell that may source this script.""" + + @staticmethod + def from_dict(obj: Any) -> 'ShellInitScript': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + shell = ShellInitScriptShell(obj.get("shell")) + return ShellInitScript(path, shell) + + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["shell"] = to_enum(ShellInitScriptShell, self.shell) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenProgress: + """`sessions.open` handoff progress update with step, status, and optional message.""" + + status: SessionsOpenProgressStatus + """Step status.""" + + step: SessionsOpenProgressStep + """Handoff step.""" + + message: str | None = None + """Optional step message.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenProgress': + assert isinstance(obj, dict) + status = SessionsOpenProgressStatus(obj.get("status")) + step = SessionsOpenProgressStep(obj.get("step")) + message = from_union([from_str, from_none], obj.get("message")) + return SessionsOpenProgress(status, step, message) + + def to_dict(self) -> dict: + result: dict = {} + result["status"] = to_enum(SessionsOpenProgressStatus, self.status) + result["step"] = to_enum(SessionsOpenProgressStep, self.step) + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsJobSnapshot: + """Redacted job settings for a session. The job nonce is excluded.""" + + built_in_tool_availability: SessionSettingsBuiltInToolAvailabilitySnapshot | None = None + event_type: str | None = None + is_trigger_job: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsJobSnapshot': + assert isinstance(obj, dict) + built_in_tool_availability = from_union([SessionSettingsBuiltInToolAvailabilitySnapshot.from_dict, from_none], obj.get("builtInToolAvailability")) + event_type = from_union([from_str, from_none], obj.get("eventType")) + is_trigger_job = from_union([from_bool, from_none], obj.get("isTriggerJob")) + return SessionSettingsJobSnapshot(built_in_tool_availability, event_type, is_trigger_job) + + def to_dict(self) -> dict: + result: dict = {} + if self.built_in_tool_availability is not None: + result["builtInToolAvailability"] = from_union([lambda x: to_class(SessionSettingsBuiltInToolAvailabilitySnapshot, x), from_none], self.built_in_tool_availability) + if self.event_type is not None: + result["eventType"] = from_union([from_str, from_none], self.event_type) + if self.is_trigger_job is not None: + result["isTriggerJob"] = from_union([from_bool, from_none], self.is_trigger_job) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsListRequest: + """Optional source filter, metadata-load limit, and context filter applied to the returned + sessions. + """ + filter: SessionListFilter | None = None + """Optional filter applied to the returned sessions""" + + include_detached: bool | None = None + """When true, include detached maintenance sessions. Defaults to false for user-facing + session lists. + """ + metadata_limit: int | None = None + """When provided, only the first N local sessions (sorted by modification time, newest + first) load full metadata; remaining sessions return basic info only. Use 0 to return + only basic info for every local session. Has no effect on remote entries (which always + carry their full shape). + """ + source: SessionSource | None = None + """Which session sources to include. Defaults to `local` for backward compatibility.""" + + throw_on_error: bool | None = None + """Only meaningful when `source` includes remote. When true, propagates errors from the + remote service instead of silently returning an empty remote list. Defaults to false. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionsListRequest': + assert isinstance(obj, dict) + filter = from_union([SessionListFilter.from_dict, from_none], obj.get("filter")) + include_detached = from_union([from_bool, from_none], obj.get("includeDetached")) + metadata_limit = from_union([from_int, from_none], obj.get("metadataLimit")) + source = from_union([SessionSource, from_none], obj.get("source")) + throw_on_error = from_union([from_bool, from_none], obj.get("throwOnError")) + return SessionsListRequest(filter, include_detached, metadata_limit, source, throw_on_error) + + def to_dict(self) -> dict: + result: dict = {} + if self.filter is not None: + result["filter"] = from_union([lambda x: to_class(SessionListFilter, x), from_none], self.filter) + if self.include_detached is not None: + result["includeDetached"] = from_union([from_bool, from_none], self.include_detached) + if self.metadata_limit is not None: + result["metadataLimit"] = from_union([from_int, from_none], self.metadata_limit) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(SessionSource, x), from_none], self.source) + if self.throw_on_error is not None: + result["throwOnError"] = from_union([from_bool, from_none], self.throw_on_error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class VisibilityGetResult: + """Current sharing status and shareable GitHub URL for a session.""" + + synced: bool + """Whether the session has been synced to Mission Control (i.e. has a GitHub task). When + false, the session cannot be shared and `status`/`shareUrl` are absent. + """ + share_url: str | None = None + """Shareable GitHub URL for the session. Present when the session is synced and the URL can + be resolved. + """ + status: SessionVisibilityStatus | None = None + """Current sharing status. Absent when the session is not synced or the status could not be + retrieved (e.g. the user is not authenticated). + """ + + @staticmethod + def from_dict(obj: Any) -> 'VisibilityGetResult': + assert isinstance(obj, dict) + synced = from_bool(obj.get("synced")) + share_url = from_union([from_str, from_none], obj.get("shareUrl")) + status = from_union([SessionVisibilityStatus, from_none], obj.get("status")) + return VisibilityGetResult(synced, share_url, status) + + def to_dict(self) -> dict: + result: dict = {} + result["synced"] = from_bool(self.synced) + if self.share_url is not None: + result["shareUrl"] = from_union([from_str, from_none], self.share_url) + if self.status is not None: + result["status"] = from_union([lambda x: to_enum(SessionVisibilityStatus, x), from_none], self.status) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class VisibilitySetRequest: + """Desired sharing status for the session.""" + + status: SessionVisibilityStatus + """Sharing status to apply. "repo" makes the session visible to repository readers; + "unshared" restricts it to the creator and collaborators. + """ + + @staticmethod + def from_dict(obj: Any) -> 'VisibilitySetRequest': + assert isinstance(obj, dict) + status = SessionVisibilityStatus(obj.get("status")) + return VisibilitySetRequest(status) + + def to_dict(self) -> dict: + result: dict = {} + result["status"] = to_enum(SessionVisibilityStatus, self.status) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class VisibilitySetResult: + """Effective sharing status and shareable GitHub URL after updating session visibility.""" + + synced: bool + """Whether the session has been synced to Mission Control (i.e. has a GitHub task). When + false, the visibility change could not be applied and `status`/`shareUrl` are absent. + """ + share_url: str | None = None + """Shareable GitHub URL for the session. Present when the session is synced and the URL can + be resolved. + """ + status: SessionVisibilityStatus | None = None + """Effective sharing status after the update. May differ from the requested status for task + types that are already visible to repository readers by default. Absent when the update + could not be applied (e.g. the session is not synced or the user is not authenticated). + """ + + @staticmethod + def from_dict(obj: Any) -> 'VisibilitySetResult': + assert isinstance(obj, dict) + synced = from_bool(obj.get("synced")) + share_url = from_union([from_str, from_none], obj.get("shareUrl")) + status = from_union([SessionVisibilityStatus, from_none], obj.get("status")) + return VisibilitySetResult(synced, share_url, status) + + def to_dict(self) -> dict: + result: dict = {} + result["synced"] = from_bool(self.synced) + if self.share_url is not None: + result["shareUrl"] = from_union([from_str, from_none], self.share_url) + if self.status is not None: + result["status"] = from_union([lambda x: to_enum(SessionVisibilityStatus, x), from_none], self.status) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenAttach: + """Parameters for attaching to an already-active session by ID.""" + + kind: ClassVar[str] = "attach" + """Attach to an already-active in-process session by ID. Unlike `resume`, this does NOT + re-load from disk; the session must already be loaded by an earlier `create`/`resume` + call. Returns `status: 'not_found'` when no active session matches the id. Useful for + in-process consumers that need a fresh API handle to a session opened elsewhere (e.g., a + peer foreground-session switch). + """ + session_id: str + """Session ID to attach to.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenAttach': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + return SessionsOpenAttach(session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["sessionId"] = from_str(self.session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ShellKillRequest: + """Identifier of a process previously returned by "shell.exec" and the signal to send.""" + + process_id: str + """Process identifier returned by shell.exec""" + + signal: ShellKillSignal | None = None + """Signal to send (default: SIGTERM)""" + + @staticmethod + def from_dict(obj: Any) -> 'ShellKillRequest': + assert isinstance(obj, dict) + process_id = from_str(obj.get("processId")) + signal = from_union([ShellKillSignal, from_none], obj.get("signal")) + return ShellKillRequest(process_id, signal) + + def to_dict(self) -> dict: + result: dict = {} + result["processId"] = from_str(self.process_id) + if self.signal is not None: + result["signal"] = from_union([lambda x: to_enum(ShellKillSignal, x), from_none], self.signal) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentInfo: + """Agent metadata, including identifiers, display details, source, tools, model, MCP + servers, skills, and file path. + + The newly selected custom agent + """ + description: str + """Description of the agent's purpose""" + + display_name: str + """Human-readable display name""" + + id: str + """Stable identifier for selection. For most agents this is the same as `name`; for + plugin/builtin agents it may differ. Always populated; defaults to `name` when no + distinct id was assigned. + """ + name: str + """Name of the agent. Use `id` as the stable selection identifier.""" + + mcp_servers: dict[str, Any] | None = None + """MCP server configurations attached to this agent, keyed by server name. Server config + shape mirrors the MCP `mcpServers` schema. + """ + model: str | None = None + """Authored preferred model id for this agent. Runtime model selection may choose a + different model; omitted means no authored preference. + """ + path: str | None = None + """Absolute local file path of the agent definition. Only set for file-based agents loaded + from disk; remote agents do not have a path. + """ + prompt: str | None = None + """Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at + invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. + """ + skills: list[str] | None = None + """Skill names preloaded into this agent's context. Omitted means none.""" + + source: AgentInfoSource | None = None + """Where the agent definition was loaded from""" + + tools: list[str] | None = None + """Allowed tool names for this agent. Empty array means none; omitted means inherit defaults.""" + + user_invocable: bool | None = None + """Whether the agent can be selected directly by the user. Agents marked `false` are + subagent-only. + """ + + @staticmethod + def from_dict(obj: Any) -> 'AgentInfo': + assert isinstance(obj, dict) + description = from_str(obj.get("description")) + display_name = from_str(obj.get("displayName")) + id = from_str(obj.get("id")) + name = from_str(obj.get("name")) + mcp_servers = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("mcpServers")) + model = from_union([from_str, from_none], obj.get("model")) + path = from_union([from_str, from_none], obj.get("path")) + prompt = from_union([from_str, from_none], obj.get("prompt")) + skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skills")) + source = from_union([AgentInfoSource, from_none], obj.get("source")) + tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("tools")) + user_invocable = from_union([from_bool, from_none], obj.get("userInvocable")) + return AgentInfo(description, display_name, id, name, mcp_servers, model, path, prompt, skills, source, tools, user_invocable) + + def to_dict(self) -> dict: + result: dict = {} + result["description"] = from_str(self.description) + result["displayName"] = from_str(self.display_name) + result["id"] = from_str(self.id) + result["name"] = from_str(self.name) + if self.mcp_servers is not None: + result["mcpServers"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.mcp_servers) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + if self.prompt is not None: + result["prompt"] = from_union([from_str, from_none], self.prompt) + if self.skills is not None: + result["skills"] = from_union([lambda x: from_list(from_str, x), from_none], self.skills) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(AgentInfoSource, x), from_none], self.source) + if self.tools is not None: + result["tools"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools) + if self.user_invocable is not None: + result["userInvocable"] = from_union([from_bool, from_none], self.user_invocable) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillList: + """Skills available to the session, with their enabled state.""" + + skills: list[Skill] + """Available skills""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillList': + assert isinstance(obj, dict) + skills = from_list(Skill.from_dict, obj.get("skills")) + return SkillList(skills) + + def to_dict(self) -> dict: + result: dict = {} + result["skills"] = from_list(lambda x: to_class(Skill, x), self.skills) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillsConfigSetDisabledSkillsRequest: + """Skill names to mark as disabled in global configuration, replacing any previous list.""" + + disabled_skills: list[str] + """List of skill names to disable""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillsConfigSetDisabledSkillsRequest': + assert isinstance(obj, dict) + disabled_skills = from_list(from_str, obj.get("disabledSkills")) + return SkillsConfigSetDisabledSkillsRequest(disabled_skills) + + def to_dict(self) -> dict: + result: dict = {} + result["disabledSkills"] = from_list(from_str, self.disabled_skills) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillsInvokedSkill: + """Skill invocation record with name, path, content, allowed tools, and turn number.""" + + content: str + """Full content of the skill file""" + + invoked_at_turn: int + """Turn number when the skill was invoked""" + + name: str + """Unique identifier for the skill""" + + path: str + """Path to the SKILL.md file""" + + allowed_tools: list[str] | None = None + """Tools that should be auto-approved when this skill is active, captured at invocation time""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillsInvokedSkill': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + invoked_at_turn = from_int(obj.get("invokedAtTurn")) + name = from_str(obj.get("name")) + path = from_str(obj.get("path")) + allowed_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("allowedTools")) + return SkillsInvokedSkill(content, invoked_at_turn, name, path, allowed_tools) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["invokedAtTurn"] = from_int(self.invoked_at_turn) + result["name"] = from_str(self.name) + result["path"] = from_str(self.path) + if self.allowed_tools is not None: + result["allowedTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.allowed_tools) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillDiscoveryPath: + """Canonical directory where skills can be discovered or created, with scope, preference, + and optional project path. + """ + path: str + """Absolute path of the create/discovery target (may not exist on disk yet)""" + + preferred_for_creation: bool + """Whether this is the canonical directory to create a new skill in its tier. At most one + entry per tier is preferred; the `personal-agents` and `custom` scopes are never + preferred. + """ + scope: SkillDiscoveryScope + """Which tier this directory belongs to""" + + project_path: str | None = None + """The input project path this directory was derived from (only for project scope)""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillDiscoveryPath': + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + preferred_for_creation = from_bool(obj.get("preferredForCreation")) + scope = SkillDiscoveryScope(obj.get("scope")) + project_path = from_union([from_str, from_none], obj.get("projectPath")) + return SkillDiscoveryPath(path, preferred_for_creation, scope, project_path) + + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["preferredForCreation"] = from_bool(self.preferred_for_creation) + result["scope"] = to_enum(SkillDiscoveryScope, self.scope) + if self.project_path is not None: + result["projectPath"] = from_union([from_str, from_none], self.project_path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandAgentPromptResult: + """Slash-command invocation result that submits an agent prompt, with display prompt, + optional mode, optional user-facing notice, and settings-change flag. + """ + display_prompt: str + """Prompt text to display to the user""" + + kind: ClassVar[str] = "agent-prompt" + """Agent prompt result discriminator""" + + prompt: str + """Prompt to submit to the agent""" + + mode: SessionMode | None = None + """Optional target session mode for the agent prompt""" + + notice: str | None = None + """Optional user-facing notice to show before the prompt is submitted""" + + runtime_settings_changed: bool | None = None + """True when the invocation mutated user runtime settings; consumers caching settings should + refresh + """ + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandAgentPromptResult': + assert isinstance(obj, dict) + display_prompt = from_str(obj.get("displayPrompt")) + prompt = from_str(obj.get("prompt")) + mode = from_union([SessionMode, from_none], obj.get("mode")) + notice = from_union([from_str, from_none], obj.get("notice")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandAgentPromptResult(display_prompt, prompt, mode, notice, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["displayPrompt"] = from_str(self.display_prompt) + result["kind"] = self.kind + result["prompt"] = from_str(self.prompt) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(SessionMode, x), from_none], self.mode) + if self.notice is not None: + result["notice"] = from_union([from_str, from_none], self.notice) + if self.runtime_settings_changed is not None: + result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandCompletedResult: + """Slash-command invocation result indicating completion, with optional message and + settings-change flag. + """ + kind: ClassVar[str] = "completed" + """Completed result discriminator""" + + message: str | None = None + """Optional user-facing message describing the completed command""" + + runtime_settings_changed: bool | None = None + """True when the invocation mutated user runtime settings; consumers caching settings should + refresh + """ + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandCompletedResult': + assert isinstance(obj, dict) + message = from_union([from_str, from_none], obj.get("message")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandCompletedResult(message, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.message is not None: + result["message"] = from_union([from_str, from_none], self.message) + if self.runtime_settings_changed is not None: + result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandSelectSubcommandResult: + """Slash-command invocation result asking the client to present subcommand options for a + parent command. + """ + command: str + """Parent command name that requires subcommand selection""" + + kind: ClassVar[str] = "select-subcommand" + """Select subcommand result discriminator""" + + options: list[SlashCommandSelectSubcommandOption] + """Available subcommand options for the client to present""" + + title: str + """Human-readable title for the selection UI""" + + runtime_settings_changed: bool | None = None + """True when the invocation mutated user runtime settings; consumers caching settings should + refresh + """ + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandSelectSubcommandResult': + assert isinstance(obj, dict) + command = from_str(obj.get("command")) + options = from_list(SlashCommandSelectSubcommandOption.from_dict, obj.get("options")) + title = from_str(obj.get("title")) + runtime_settings_changed = from_union([from_bool, from_none], obj.get("runtimeSettingsChanged")) + return SlashCommandSelectSubcommandResult(command, options, title, runtime_settings_changed) + + def to_dict(self) -> dict: + result: dict = {} + result["command"] = from_str(self.command) + result["kind"] = self.kind + result["options"] = from_list(lambda x: to_class(SlashCommandSelectSubcommandOption, x), self.options) + result["title"] = from_str(self.title) + if self.runtime_settings_changed is not None: + result["runtimeSettingsChanged"] = from_union([from_bool, from_none], self.runtime_settings_changed) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskAgentProgress: + """Progress snapshot for an agent task, with recent activity lines and optional latest + intent. + """ + recent_activity: list[TaskProgressLine] + """Recent tool execution events converted to display lines""" + + type: TaskAgentInfoType + """Progress kind""" + + latest_intent: str | None = None + """The most recent intent reported by the agent""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskAgentProgress': + assert isinstance(obj, dict) + recent_activity = from_list(TaskProgressLine.from_dict, obj.get("recentActivity")) + type = TaskAgentInfoType(obj.get("type")) + latest_intent = from_union([from_str, from_none], obj.get("latestIntent")) + return TaskAgentProgress(recent_activity, type, latest_intent) + + def to_dict(self) -> dict: + result: dict = {} + result["recentActivity"] = from_list(lambda x: to_class(TaskProgressLine, x), self.recent_activity) + result["type"] = to_enum(TaskAgentInfoType, self.type) + if self.latest_intent is not None: + result["latestIntent"] = from_union([from_str, from_none], self.latest_intent) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskProgress: + """Progress snapshot for an agent task, with recent activity lines and optional latest + intent. + + Progress snapshot for a shell task, with recent stdout/stderr output and optional process + ID. + """ + type: TaskInfoType + """Progress kind""" + + latest_intent: str | None = None + """The most recent intent reported by the agent""" + + recent_activity: list[TaskProgressLine] | None = None + """Recent tool execution events converted to display lines""" + + pid: int | None = None + """Process ID when available""" + + recent_output: str | None = None + """Recent stdout/stderr lines from the running shell command""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskProgress': + assert isinstance(obj, dict) + type = TaskInfoType(obj.get("type")) + latest_intent = from_union([from_str, from_none], obj.get("latestIntent")) + recent_activity = from_union([lambda x: from_list(TaskProgressLine.from_dict, x), from_none], obj.get("recentActivity")) + pid = from_union([from_int, from_none], obj.get("pid")) + recent_output = from_union([from_str, from_none], obj.get("recentOutput")) + return TaskProgress(type, latest_intent, recent_activity, pid, recent_output) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = to_enum(TaskInfoType, self.type) + if self.latest_intent is not None: + result["latestIntent"] = from_union([from_str, from_none], self.latest_intent) + if self.recent_activity is not None: + result["recentActivity"] = from_union([lambda x: from_list(lambda x: to_class(TaskProgressLine, x), x), from_none], self.recent_activity) + if self.pid is not None: + result["pid"] = from_union([from_int, from_none], self.pid) + if self.recent_output is not None: + result["recentOutput"] = from_union([from_str, from_none], self.recent_output) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskShellInfo: + """Tracked shell task metadata, including ID, command, status, timing, attachment/execution + mode, log path, and PID. + """ + attachment_mode: TaskShellInfoAttachmentMode + """Whether the shell runs inside a managed PTY session or as an independent background + process + """ + command: str + """Command being executed""" + + description: str + """Short description of the task""" + + id: str + """Unique task identifier""" + + started_at: datetime + """ISO 8601 timestamp when the task was started""" + + status: TaskStatus + """Current lifecycle status of the task""" + + type: ClassVar[str] = "shell" + """Task kind""" + + can_promote_to_background: bool | None = None + """Whether this shell task can be promoted to background mode""" + + completed_at: datetime | None = None + """ISO 8601 timestamp when the task finished""" + + execution_mode: TaskExecutionMode | None = None + """Whether task execution is synchronously awaited or managed in the background""" + + log_path: str | None = None + """Path to the detached shell log, when available""" + + pid: int | None = None + """Process ID when available""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskShellInfo': + assert isinstance(obj, dict) + attachment_mode = TaskShellInfoAttachmentMode(obj.get("attachmentMode")) + command = from_str(obj.get("command")) + description = from_str(obj.get("description")) + id = from_str(obj.get("id")) + started_at = from_datetime(obj.get("startedAt")) + status = TaskStatus(obj.get("status")) + can_promote_to_background = from_union([from_bool, from_none], obj.get("canPromoteToBackground")) + completed_at = from_union([from_datetime, from_none], obj.get("completedAt")) + execution_mode = from_union([TaskExecutionMode, from_none], obj.get("executionMode")) + log_path = from_union([from_str, from_none], obj.get("logPath")) + pid = from_union([from_int, from_none], obj.get("pid")) + return TaskShellInfo(attachment_mode, command, description, id, started_at, status, can_promote_to_background, completed_at, execution_mode, log_path, pid) + + def to_dict(self) -> dict: + result: dict = {} + result["attachmentMode"] = to_enum(TaskShellInfoAttachmentMode, self.attachment_mode) + result["command"] = from_str(self.command) + result["description"] = from_str(self.description) + result["id"] = from_str(self.id) + result["startedAt"] = self.started_at.isoformat() + result["status"] = to_enum(TaskStatus, self.status) + result["type"] = self.type + if self.can_promote_to_background is not None: + result["canPromoteToBackground"] = from_union([from_bool, from_none], self.can_promote_to_background) + if self.completed_at is not None: + result["completedAt"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at) + if self.execution_mode is not None: + result["executionMode"] = from_union([lambda x: to_enum(TaskExecutionMode, x), from_none], self.execution_mode) + if self.log_path is not None: + result["logPath"] = from_union([from_str, from_none], self.log_path) + if self.pid is not None: + result["pid"] = from_union([from_int, from_none], self.pid) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskShellProgress: + """Progress snapshot for a shell task, with recent stdout/stderr output and optional process + ID. + """ + recent_output: str + """Recent stdout/stderr lines from the running shell command""" + + type: TaskShellInfoType + """Progress kind""" + + pid: int | None = None + """Process ID when available""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskShellProgress': + assert isinstance(obj, dict) + recent_output = from_str(obj.get("recentOutput")) + type = TaskShellInfoType(obj.get("type")) + pid = from_union([from_int, from_none], obj.get("pid")) + return TaskShellProgress(recent_output, type, pid) + + def to_dict(self) -> dict: + result: dict = {} + result["recentOutput"] = from_str(self.recent_output) + result["type"] = to_enum(TaskShellInfoType, self.type) + if self.pid is not None: + result["pid"] = from_union([from_int, from_none], self.pid) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPAppsCallToolRequest: + """MCP server, tool name, and arguments to invoke from an MCP App view.""" + + origin_server_name: str + """**Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the + app from this server only'), the call is rejected when this differs from `serverName`, + and rejected outright when missing. + """ + server_name: str + """MCP server hosting the tool""" + + tool_name: str + """MCP tool name""" + + arguments: dict[str, Any] | None = None + """Tool arguments""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPAppsCallToolRequest': + assert isinstance(obj, dict) + origin_server_name = from_str(obj.get("originServerName")) + server_name = from_str(obj.get("serverName")) + tool_name = from_str(obj.get("toolName")) + arguments = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("arguments")) + return MCPAppsCallToolRequest(origin_server_name, server_name, tool_name, arguments) + + def to_dict(self) -> dict: + result: dict = {} + result["originServerName"] = from_str(self.origin_server_name) + result["serverName"] = from_str(self.server_name) + result["toolName"] = from_str(self.tool_name) + if self.arguments is not None: + result["arguments"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.arguments) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPToolUI: + """Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` + block was present without recognized fields. + + Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. + """ + resource_uri: str | None = None + """URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use + `session.mcp.resources.read` to fetch its HTML and resource metadata. + """ + visibility: list[MCPToolUIVisibility] | None = None + """Tool visibility advertised by the server. When absent, MCP Apps defaults apply.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPToolUI': + assert isinstance(obj, dict) + resource_uri = from_union([from_str, from_none], obj.get("resourceUri")) + visibility = from_union([lambda x: from_list(MCPToolUIVisibility, x), from_none], obj.get("visibility")) + return MCPToolUI(resource_uri, visibility) + + def to_dict(self) -> dict: + result: dict = {} + if self.resource_uri is not None: + result["resourceUri"] = from_union([from_str, from_none], self.resource_uri) + if self.visibility is not None: + result["visibility"] = from_union([lambda x: from_list(lambda x: to_enum(MCPToolUIVisibility, x), x), from_none], self.visibility) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionLocationAddToolApprovalParams: + """Location-scoped tool approval to persist.""" + + approval: PermissionsLocationsAddToolApprovalDetails + """Tool approval to persist and apply""" + + location_key: str + """Location key (git root or cwd) to persist the approval to""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionLocationAddToolApprovalParams': + assert isinstance(obj, dict) + approval = _load_PermissionsLocationsAddToolApprovalDetails(obj.get("approval")) + location_key = from_str(obj.get("locationKey")) + return PermissionLocationAddToolApprovalParams(approval, location_key) + + def to_dict(self) -> dict: + result: dict = {} + result["approval"] = (self.approval).to_dict() + result["locationKey"] = from_str(self.location_key) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsEvaluatePredicateRequest: + """Named Rust-owned settings predicate to evaluate for this session.""" + + name: SessionSettingsPredicateName + """Predicate name. The runtime owns the raw feature-flag names and composition logic.""" + + tool_name: str | None = None + """Tool name for tool-scoped predicates such as trivial-change handling.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsEvaluatePredicateRequest': + assert isinstance(obj, dict) + name = SessionSettingsPredicateName(obj.get("name")) + tool_name = from_union([from_str, from_none], obj.get("toolName")) + return SessionSettingsEvaluatePredicateRequest(name, tool_name) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = to_enum(SessionSettingsPredicateName, self.name) + if self.tool_name is not None: + result["toolName"] = from_union([from_str, from_none], self.tool_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TaskAgentInfo: + """Tracked background agent task metadata, including IDs, status, timing, agent type, + prompt, model, result, and latest response. + """ + agent_type: str + """Type of agent running this task""" + + description: str + """Short description of the task""" + + id: str + """Unique task identifier""" + + prompt: str + """Most recent prompt delivered to the agent. Updated whenever the agent receives a + follow-up message. + """ + started_at: datetime + """ISO 8601 timestamp when the task was started""" + + status: TaskStatus + """Current lifecycle status of the task""" + + tool_call_id: str + """Tool call ID associated with this agent task""" + + type: ClassVar[str] = "agent" + """Task kind""" + + active_started_at: datetime | None = None + """ISO 8601 timestamp when the current active period began""" + + active_time_ms: int | None = None + """Accumulated active execution time in milliseconds""" + + can_promote_to_background: bool | None = None + """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. + """ + completed_at: datetime | None = None + """ISO 8601 timestamp when the task finished""" + + error: str | None = None + """Error message when the task failed""" + + execution_mode: TaskExecutionMode | None = None + """Whether task execution is synchronously awaited or managed in the background""" + + idle_since: datetime | None = None + """ISO 8601 timestamp when the agent entered idle state""" + + latest_response: str | None = None + """Most recent response text from the agent""" + + model: str | None = None + """Requested model override for the task when specified""" + + resolved_model: str | None = None + """Runtime model resolved for the task when available""" + + result: str | None = None + """Result text from the task when available""" + + @staticmethod + def from_dict(obj: Any) -> 'TaskAgentInfo': + assert isinstance(obj, dict) + agent_type = from_str(obj.get("agentType")) + description = from_str(obj.get("description")) + id = from_str(obj.get("id")) + prompt = from_str(obj.get("prompt")) + started_at = from_datetime(obj.get("startedAt")) + status = TaskStatus(obj.get("status")) + tool_call_id = from_str(obj.get("toolCallId")) + active_started_at = from_union([from_datetime, from_none], obj.get("activeStartedAt")) + active_time_ms = from_union([from_int, from_none], obj.get("activeTimeMs")) + can_promote_to_background = from_union([from_bool, from_none], obj.get("canPromoteToBackground")) + completed_at = from_union([from_datetime, from_none], obj.get("completedAt")) + error = from_union([from_str, from_none], obj.get("error")) + execution_mode = from_union([TaskExecutionMode, from_none], obj.get("executionMode")) + idle_since = from_union([from_datetime, from_none], obj.get("idleSince")) + latest_response = from_union([from_str, from_none], obj.get("latestResponse")) + model = from_union([from_str, from_none], obj.get("model")) + resolved_model = from_union([from_str, from_none], obj.get("resolvedModel")) + result = from_union([from_str, from_none], obj.get("result")) + return TaskAgentInfo(agent_type, description, id, prompt, started_at, status, tool_call_id, active_started_at, active_time_ms, can_promote_to_background, completed_at, error, execution_mode, idle_since, latest_response, model, resolved_model, result) + + def to_dict(self) -> dict: + result: dict = {} + result["agentType"] = from_str(self.agent_type) + result["description"] = from_str(self.description) + result["id"] = from_str(self.id) + result["prompt"] = from_str(self.prompt) + result["startedAt"] = self.started_at.isoformat() + result["status"] = to_enum(TaskStatus, self.status) + result["toolCallId"] = from_str(self.tool_call_id) + result["type"] = self.type + if self.active_started_at is not None: + result["activeStartedAt"] = from_union([lambda x: x.isoformat(), from_none], self.active_started_at) + if self.active_time_ms is not None: + result["activeTimeMs"] = from_union([from_int, from_none], self.active_time_ms) + if self.can_promote_to_background is not None: + result["canPromoteToBackground"] = from_union([from_bool, from_none], self.can_promote_to_background) + if self.completed_at is not None: + result["completedAt"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.execution_mode is not None: + result["executionMode"] = from_union([lambda x: to_enum(TaskExecutionMode, x), from_none], self.execution_mode) + if self.idle_since is not None: + result["idleSince"] = from_union([lambda x: x.isoformat(), from_none], self.idle_since) + if self.latest_response is not None: + result["latestResponse"] = from_union([from_str, from_none], self.latest_response) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.resolved_model is not None: + result["resolvedModel"] = from_union([from_str, from_none], self.resolved_model) + if self.result is not None: + result["result"] = from_union([from_str, from_none], self.result) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ToolList: + """Built-in tools available for the requested model, with their parameters and instructions.""" + + tools: list[Tool] + """List of available built-in tools with metadata""" + + @staticmethod + def from_dict(obj: Any) -> 'ToolList': + assert isinstance(obj, dict) + tools = from_list(Tool.from_dict, obj.get("tools")) + return ToolList(tools) + + def to_dict(self) -> dict: + result: dict = {} + result["tools"] = from_list(lambda x: to_class(Tool, x), self.tools) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UserRequestedShellCommandResult: + """Result of a user-requested shell command.""" + + output: str + """Captured command output""" + + success: bool + """Whether the command completed successfully""" + + tool_call_id: str + """Tool call id emitted for the shell execution""" + + error: str | None = None + """Error output when the execution failed""" + + exit_code: int | None = None + """Process exit code, when available""" + + @staticmethod + def from_dict(obj: Any) -> 'UserRequestedShellCommandResult': + assert isinstance(obj, dict) + output = from_str(obj.get("output")) + success = from_bool(obj.get("success")) + tool_call_id = from_str(obj.get("toolCallId")) + error = from_union([from_str, from_none], obj.get("error")) + exit_code = from_union([from_int, from_none], obj.get("exitCode")) + return UserRequestedShellCommandResult(output, success, tool_call_id, error, exit_code) + + def to_dict(self) -> dict: + result: dict = {} + result["output"] = from_str(self.output) + result["success"] = from_bool(self.success) + result["toolCallId"] = from_str(self.tool_call_id) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.exit_code is not None: + result["exitCode"] = from_union([from_int, from_none], self.exit_code) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingAutoModeSwitchRequest: + """Request ID of a pending `auto_mode_switch.requested` event and the user's response.""" + + request_id: str + """The unique request ID from the auto_mode_switch.requested event""" + + response: UIAutoModeSwitchResponse + """User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist + as setting), or no (decline). + """ + + @staticmethod + def from_dict(obj: Any) -> 'UIHandlePendingAutoModeSwitchRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + response = UIAutoModeSwitchResponse(obj.get("response")) + return UIHandlePendingAutoModeSwitchRequest(request_id, response) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["response"] = to_enum(UIAutoModeSwitchResponse, self.response) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationArrayAnyOfFieldItems: + """Schema applied to each item in the array.""" + + any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf] + """Selectable options, each with a value and a display label.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItems': + assert isinstance(obj, dict) + any_of = from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, obj.get("anyOf")) + return UIElicitationArrayAnyOfFieldItems(any_of) + + def to_dict(self) -> dict: + result: dict = {} + result["anyOf"] = from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), self.any_of) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationArrayEnumFieldItems: + """Schema applied to each item in the array.""" + + enum: list[str] + """Allowed string values for each selected item.""" + + type: UIElicitationArrayEnumFieldItemsType + """Type discriminator. Always "string".""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationArrayEnumFieldItems': + assert isinstance(obj, dict) + enum = from_list(from_str, obj.get("enum")) + type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) + return UIElicitationArrayEnumFieldItems(enum, type) + + def to_dict(self) -> dict: + result: dict = {} + result["enum"] = from_list(from_str, self.enum) + result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) + return result + +@dataclass +class UIElicitationArrayFieldItems: + """Schema applied to each item in the array.""" + + enum: list[str] | None = None + """Allowed string values for each selected item.""" + + type: UIElicitationArrayEnumFieldItemsType | None = None + """Type discriminator. Always "string".""" + + any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf] | None = None + """Selectable options, each with a value and a display label.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationArrayFieldItems': + assert isinstance(obj, dict) + enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enum")) + type = from_union([UIElicitationArrayEnumFieldItemsType, from_none], obj.get("type")) + any_of = from_union([lambda x: from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, x), from_none], obj.get("anyOf")) + return UIElicitationArrayFieldItems(enum, type, any_of) + + def to_dict(self) -> dict: + result: dict = {} + if self.enum is not None: + result["enum"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum) + if self.type is not None: + result["type"] = from_union([lambda x: to_enum(UIElicitationArrayEnumFieldItemsType, x), from_none], self.type) + if self.any_of is not None: + result["anyOf"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), x), from_none], self.any_of) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationStringEnumField: + """Single-select string field whose allowed values are defined inline.""" + + enum: list[str] + """Allowed string values.""" + + type: UIElicitationArrayEnumFieldItemsType + """Type discriminator. Always "string".""" + + default: str | None = None + """Default value selected when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + enum_names: list[str] | None = None + """Optional display labels for each enum value, in the same order as `enum`.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationStringEnumField': + assert isinstance(obj, dict) + enum = from_list(from_str, obj.get("enum")) + type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) + default = from_union([from_str, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enumNames")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationStringEnumField(enum, type, default, description, enum_names, title) + + def to_dict(self) -> dict: + result: dict = {} + result["enum"] = from_list(from_str, self.enum) + result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) + if self.default is not None: + result["default"] = from_union([from_str, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.enum_names is not None: + result["enumNames"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationSchemaPropertyString: + """Free-text string field with optional length and format constraints.""" + + type: UIElicitationArrayEnumFieldItemsType + """Type discriminator. Always "string".""" + + default: str | None = None + """Default value populated in the input when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + format: UIElicitationSchemaPropertyStringFormat | None = None + """Optional format hint that constrains the accepted input.""" + + max_length: int | None = None + """Maximum number of characters allowed.""" + + min_length: int | None = None + """Minimum number of characters required.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyString': + assert isinstance(obj, dict) + type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) + default = from_union([from_str, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get("format")) + max_length = from_union([from_int, from_none], obj.get("maxLength")) + min_length = from_union([from_int, from_none], obj.get("minLength")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationSchemaPropertyString(type, default, description, format, max_length, min_length, title) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) + if self.default is not None: + result["default"] = from_union([from_str, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.format is not None: + result["format"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format) + if self.max_length is not None: + result["maxLength"] = from_union([from_int, from_none], self.max_length) + if self.min_length is not None: + result["minLength"] = from_union([from_int, from_none], self.min_length) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationStringOneOfField: + """Single-select string field where each option pairs a value with a display label.""" + + one_of: list[UIElicitationStringOneOfFieldOneOf] + """Selectable options, each with a value and a display label.""" + + type: UIElicitationArrayEnumFieldItemsType + """Type discriminator. Always "string".""" + + default: str | None = None + """Default value selected when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationStringOneOfField': + assert isinstance(obj, dict) + one_of = from_list(UIElicitationStringOneOfFieldOneOf.from_dict, obj.get("oneOf")) + type = UIElicitationArrayEnumFieldItemsType(obj.get("type")) + default = from_union([from_str, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationStringOneOfField(one_of, type, default, description, title) + + def to_dict(self) -> dict: + result: dict = {} + result["oneOf"] = from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), self.one_of) + result["type"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type) + if self.default is not None: + result["default"] = from_union([from_str, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationResponse: + """The elicitation response (accept with form values, decline, or cancel)""" + + action: UIElicitationResponseAction + """The user's response: accept (submitted), decline (rejected), or cancel (dismissed)""" + + content: dict[str, float | bool | list[str] | str] | None = None + """The form values submitted by the user (present when action is 'accept')""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationResponse': + assert isinstance(obj, dict) + action = UIElicitationResponseAction(obj.get("action")) + 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")) + return UIElicitationResponse(action, content) + + def to_dict(self) -> dict: + result: dict = {} + result["action"] = to_enum(UIElicitationResponseAction, self.action) + if self.content is not None: + 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) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationSchemaPropertyBoolean: + """Boolean field rendered as a yes/no toggle.""" + + type: UIElicitationSchemaPropertyBooleanType + """Type discriminator. Always "boolean".""" + + default: bool | None = None + """Default value selected when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyBoolean': + assert isinstance(obj, dict) + type = UIElicitationSchemaPropertyBooleanType(obj.get("type")) + default = from_union([from_bool, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationSchemaPropertyBoolean(type, default, description, title) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = to_enum(UIElicitationSchemaPropertyBooleanType, self.type) + if self.default is not None: + result["default"] = from_union([from_bool, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationSchemaPropertyNumber: + """Numeric field accepting either a number or an integer.""" + + type: UIElicitationSchemaPropertyNumberType + """Numeric type accepted by the field.""" + + default: float | None = None + """Default value populated in the input when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + maximum: float | None = None + """Maximum allowed value (inclusive).""" + + minimum: float | None = None + """Minimum allowed value (inclusive).""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyNumber': + assert isinstance(obj, dict) + type = UIElicitationSchemaPropertyNumberType(obj.get("type")) + default = from_union([from_float, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + maximum = from_union([from_float, from_none], obj.get("maximum")) + minimum = from_union([from_float, from_none], obj.get("minimum")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationSchemaPropertyNumber(type, default, description, maximum, minimum, title) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = to_enum(UIElicitationSchemaPropertyNumberType, self.type) + if self.default is not None: + result["default"] = from_union([to_float, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.maximum is not None: + result["maximum"] = from_union([to_float, from_none], self.maximum) + if self.minimum is not None: + result["minimum"] = from_union([to_float, from_none], self.minimum) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIExitPlanModeResponse: + """User response for a pending exit-plan-mode request, with approval state, selected action, + auto-approve flag, and feedback. + """ + approved: bool + """Whether the plan was approved.""" + + auto_approve_edits: bool | None = None + """Whether subsequent edits should be auto-approved without confirmation.""" + + defer_implementation: bool | None = None + """When true, the agent is instructed to end its turn without starting implementation so the + client can restore the session model and auto-submit a fresh implementation turn on it. + Set only when a distinct plan configuration (a different model, reasoning effort, or + context tier) actually ran the planning turn. + """ + feedback: str | None = None + """Feedback from the user when they declined the plan or requested changes.""" + + selected_action: UIExitPlanModeAction | None = None + """The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, + otherwise 'interactive'. + """ + + @staticmethod + def from_dict(obj: Any) -> 'UIExitPlanModeResponse': + assert isinstance(obj, dict) + approved = from_bool(obj.get("approved")) + auto_approve_edits = from_union([from_bool, from_none], obj.get("autoApproveEdits")) + defer_implementation = from_union([from_bool, from_none], obj.get("deferImplementation")) + feedback = from_union([from_str, from_none], obj.get("feedback")) + selected_action = from_union([UIExitPlanModeAction, from_none], obj.get("selectedAction")) + return UIExitPlanModeResponse(approved, auto_approve_edits, defer_implementation, feedback, selected_action) + + def to_dict(self) -> dict: + result: dict = {} + result["approved"] = from_bool(self.approved) + if self.auto_approve_edits is not None: + result["autoApproveEdits"] = from_union([from_bool, from_none], self.auto_approve_edits) + if self.defer_implementation is not None: + result["deferImplementation"] = from_union([from_bool, from_none], self.defer_implementation) + if self.feedback is not None: + result["feedback"] = from_union([from_str, from_none], self.feedback) + if self.selected_action is not None: + result["selectedAction"] = from_union([lambda x: to_enum(UIExitPlanModeAction, x), from_none], self.selected_action) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UISessionLimitsExhaustedResponse: + """The selected session-limit action. + + The user's selected action for an exhausted session limit. + """ + action: UISessionLimitsExhaustedResponseAction + """Action selected by the user.""" + + additional_ai_credits: float | None = None + """AI Credits to add to the current max when action is 'add'.""" + + max_ai_credits: float | None = None + """New absolute max AI Credits when action is 'set'.""" + + @staticmethod + def from_dict(obj: Any) -> 'UISessionLimitsExhaustedResponse': + assert isinstance(obj, dict) + action = UISessionLimitsExhaustedResponseAction(obj.get("action")) + additional_ai_credits = from_union([from_float, from_none], obj.get("additionalAiCredits")) + max_ai_credits = from_union([from_float, from_none], obj.get("maxAiCredits")) + return UISessionLimitsExhaustedResponse(action, additional_ai_credits, max_ai_credits) + + def to_dict(self) -> dict: + result: dict = {} + result["action"] = to_enum(UISessionLimitsExhaustedResponseAction, self.action) + if self.additional_ai_credits is not None: + result["additionalAiCredits"] = from_union([to_float, from_none], self.additional_ai_credits) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([to_float, from_none], self.max_ai_credits) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingUserInputRequest: + """Request ID of a pending `user_input.requested` event and the user's response.""" + + request_id: str + """The unique request ID from the user_input.requested event""" + + response: UIUserInputResponse + """User response for a pending user-input request, with answer text and whether it was typed + freeform. + """ + + @staticmethod + def from_dict(obj: Any) -> 'UIHandlePendingUserInputRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + response = UIUserInputResponse.from_dict(obj.get("response")) + return UIHandlePendingUserInputRequest(request_id, response) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["response"] = to_class(UIUserInputResponse, self.response) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UsageMetricsModelMetric: + """Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and + per-token-type details. + """ + requests: UsageMetricsModelMetricRequests + """Request count and cost metrics for this model""" + + usage: UsageMetricsModelMetricUsage + """Token usage metrics for this model""" + + cache_expires_at: datetime | None = None + """Latest known prompt-cache expiration for this model. A timestamp in the past indicates + that the observed cache has expired. + """ + token_details: dict[str, UsageMetricsModelMetricTokenDetail] | None = None + """Token count details per type""" + + total_nano_aiu: float | None = None + """Accumulated nano-AI units cost for this model""" + + @staticmethod + def from_dict(obj: Any) -> 'UsageMetricsModelMetric': + assert isinstance(obj, dict) + requests = UsageMetricsModelMetricRequests.from_dict(obj.get("requests")) + usage = UsageMetricsModelMetricUsage.from_dict(obj.get("usage")) + cache_expires_at = from_union([from_datetime, from_none], obj.get("cacheExpiresAt")) + token_details = from_union([lambda x: from_dict(UsageMetricsModelMetricTokenDetail.from_dict, x), from_none], obj.get("tokenDetails")) + total_nano_aiu = from_union([from_float, from_none], obj.get("totalNanoAiu")) + return UsageMetricsModelMetric(requests, usage, cache_expires_at, token_details, total_nano_aiu) + + def to_dict(self) -> dict: + result: dict = {} + result["requests"] = to_class(UsageMetricsModelMetricRequests, self.requests) + result["usage"] = to_class(UsageMetricsModelMetricUsage, self.usage) + if self.cache_expires_at is not None: + result["cacheExpiresAt"] = from_union([lambda x: x.isoformat(), from_none], self.cache_expires_at) + if self.token_details is not None: + result["tokenDetails"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsModelMetricTokenDetail, x), x), from_none], self.token_details) + if self.total_nano_aiu is not None: + result["totalNanoAiu"] = from_union([to_float, from_none], self.total_nano_aiu) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UserSettingsGetResult: + """Per-key metadata for every known user setting (settings.json overlaid with the legacy + config.json, config.json wins), including settings left at their default. Excludes + repository- and enterprise-managed overrides. + """ + settings: dict[str, UserSettingMetadata] + """Every known user setting keyed by setting name, each with its effective value, default, + and whether it is at the default. + """ + + @staticmethod + def from_dict(obj: Any) -> 'UserSettingsGetResult': + assert isinstance(obj, dict) + settings = from_dict(UserSettingMetadata.from_dict, obj.get("settings")) + return UserSettingsGetResult(settings) + + def to_dict(self) -> dict: + result: dict = {} + result["settings"] = from_dict(lambda x: to_class(UserSettingMetadata, x), self.settings) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspaceDiffFileChange: + """A single changed file and its unified diff.""" + + change_type: WorkspaceDiffFileChangeType + """Type of change represented by this file diff.""" + + diff: str + """Unified diff content for the file. Empty when the diff was truncated.""" + + path: str + """Path to the changed file, relative to the workspace root when the file lives under it. A + file changed outside the workspace root keeps a `../`-relative path, or an absolute path + when no relative path exists (for example a different Windows drive). + """ + is_truncated: bool | None = None + """Whether the diff content was omitted because it exceeded the per-file size limit.""" + + old_path: str | None = None + """Original file path for renamed files.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspaceDiffFileChange': + assert isinstance(obj, dict) + change_type = WorkspaceDiffFileChangeType(obj.get("changeType")) + diff = from_str(obj.get("diff")) + path = from_str(obj.get("path")) + is_truncated = from_union([from_bool, from_none], obj.get("isTruncated")) + old_path = from_union([from_str, from_none], obj.get("oldPath")) + return WorkspaceDiffFileChange(change_type, diff, path, is_truncated, old_path) + + def to_dict(self) -> dict: + result: dict = {} + result["changeType"] = to_enum(WorkspaceDiffFileChangeType, self.change_type) + result["diff"] = from_str(self.diff) + result["path"] = from_str(self.path) + if self.is_truncated is not None: + result["isTruncated"] = from_union([from_bool, from_none], self.is_truncated) + if self.old_path is not None: + result["oldPath"] = from_union([from_str, from_none], self.old_path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesDiffRequest: + """Parameters for computing a workspace diff.""" + + mode: WorkspaceDiffMode + """Diff mode requested by the client.""" + + ignore_whitespace: bool | None = None + """When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesDiffRequest': + assert isinstance(obj, dict) + mode = WorkspaceDiffMode(obj.get("mode")) + ignore_whitespace = from_union([from_bool, from_none], obj.get("ignoreWhitespace")) + return WorkspacesDiffRequest(mode, ignore_whitespace) + + def to_dict(self) -> dict: + result: dict = {} + result["mode"] = to_enum(WorkspaceDiffMode, self.mode) + if self.ignore_whitespace is not None: + result["ignoreWhitespace"] = from_union([from_bool, from_none], self.ignore_whitespace) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesSaveLargePasteResult: + """Descriptor for the saved paste file, or null when the workspace is unavailable.""" + + saved: Saved | None = None + """Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, + non-infinite sessions, remote sessions) + """ + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesSaveLargePasteResult': + assert isinstance(obj, dict) + saved = from_union([Saved.from_dict, from_none], obj.get("saved")) + return WorkspacesSaveLargePasteResult(saved) + + def to_dict(self) -> dict: + result: dict = {} + result["saved"] = from_union([lambda x: to_class(Saved, x), from_none], self.saved) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentDiscoveryPathList: + """Canonical locations where custom agents can be created so the runtime will recognize them.""" + + paths: list[AgentDiscoveryPath] + """Canonical agent create/discovery directories, in priority order""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentDiscoveryPathList': + assert isinstance(obj, dict) + paths = from_list(AgentDiscoveryPath.from_dict, obj.get("paths")) + return AgentDiscoveryPathList(paths) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(lambda x: to_class(AgentDiscoveryPath, x), self.paths) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentRegistrySpawnRegistryTimeout: + """Spawn succeeded but the child did not publish a matching managed-server entry within the + timeout. + """ + child_pid: int + """Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance)""" + + kind: ClassVar[str] = "registry-timeout" + """Discriminator: spawn succeeded but child never registered""" + + log_capture: AgentRegistryLogCapture | None = None + """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentRegistrySpawnRegistryTimeout': + assert isinstance(obj, dict) + child_pid = from_int(obj.get("childPid")) + log_capture = from_union([AgentRegistryLogCapture.from_dict, from_none], obj.get("logCapture")) + return AgentRegistrySpawnRegistryTimeout(child_pid, log_capture) + + def to_dict(self) -> dict: + result: dict = {} + result["childPid"] = from_int(self.child_pid) + result["kind"] = self.kind + if self.log_capture is not None: + result["logCapture"] = from_union([lambda x: to_class(AgentRegistryLogCapture, x), from_none], self.log_capture) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SlashCommandInfo: + """Slash-command metadata with name, aliases, description, kind, input hint, execution + allowance, and schedulability. + """ + allow_during_agent_execution: bool + """Whether the command may run while an agent turn is active""" + + description: str + """Human-readable command description""" + + kind: SlashCommandKind + """Coarse command category for grouping and behavior: runtime built-in, skill-backed + command, or SDK/client-owned command + """ + name: str + """Canonical command name without a leading slash""" + + aliases: list[str] | None = None + """Canonical aliases without leading slashes""" + + experimental: bool | None = None + """Whether the command is experimental""" + + input: SlashCommandInput | None = None + """Optional unstructured input hint""" + + schedulable: bool | None = None + """Whether the command may be the target of `/every` / `/after` schedules. Resolution + happens at every tick, so only set this when the command is safe to re-invoke and + produces an agent prompt. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SlashCommandInfo': + assert isinstance(obj, dict) + allow_during_agent_execution = from_bool(obj.get("allowDuringAgentExecution")) + description = from_str(obj.get("description")) + kind = SlashCommandKind(obj.get("kind")) + name = from_str(obj.get("name")) + aliases = from_union([lambda x: from_list(from_str, x), from_none], obj.get("aliases")) + experimental = from_union([from_bool, from_none], obj.get("experimental")) + input = from_union([SlashCommandInput.from_dict, from_none], obj.get("input")) + schedulable = from_union([from_bool, from_none], obj.get("schedulable")) + return SlashCommandInfo(allow_during_agent_execution, description, kind, name, aliases, experimental, input, schedulable) + + def to_dict(self) -> dict: + result: dict = {} + result["allowDuringAgentExecution"] = from_bool(self.allow_during_agent_execution) + result["description"] = from_str(self.description) + result["kind"] = to_enum(SlashCommandKind, self.kind) + result["name"] = from_str(self.name) + if self.aliases is not None: + result["aliases"] = from_union([lambda x: from_list(from_str, x), from_none], self.aliases) + if self.experimental is not None: + result["experimental"] = from_union([from_bool, from_none], self.experimental) + if self.input is not None: + result["input"] = from_union([lambda x: to_class(SlashCommandInput, x), from_none], self.input) + if self.schedulable is not None: + result["schedulable"] = from_union([from_bool, from_none], self.schedulable) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteSessionConnectionResult: + """Remote session connection result.""" + + metadata: ConnectedRemoteSessionMetadata + """Metadata for a connected remote session.""" + + session_id: str + """SDK session ID for the connected remote session.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteSessionConnectionResult': + assert isinstance(obj, dict) + metadata = ConnectedRemoteSessionMetadata.from_dict(obj.get("metadata")) + session_id = from_str(obj.get("sessionId")) + return RemoteSessionConnectionResult(metadata, session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["metadata"] = to_class(ConnectedRemoteSessionMetadata, self.metadata) + result["sessionId"] = from_str(self.session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasHostContext: + """Host context supplied by the runtime.""" + + capabilities: CanvasHostContextCapabilities | None = None + """Host capabilities""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasHostContext': + assert isinstance(obj, dict) + capabilities = from_union([CanvasHostContextCapabilities.from_dict, from_none], obj.get("capabilities")) + return CanvasHostContext(capabilities) + + def to_dict(self) -> dict: + result: dict = {} + if self.capabilities is not None: + result["capabilities"] = from_union([lambda x: to_class(CanvasHostContextCapabilities, x), from_none], self.capabilities) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasList: + """Declared canvases available in this session.""" + + canvases: list[DiscoveredCanvas] + """Declared canvases available in this session""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasList': + assert isinstance(obj, dict) + canvases = from_list(DiscoveredCanvas.from_dict, obj.get("canvases")) + return CanvasList(canvases) + + def to_dict(self) -> dict: + result: dict = {} + result["canvases"] = from_list(lambda x: to_class(DiscoveredCanvas, x), self.canvases) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasListOpenResult: + """Live open-canvas snapshot.""" + + open_canvases: list[OpenCanvasInstance] + """Currently open canvas instances""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasListOpenResult': + assert isinstance(obj, dict) + open_canvases = from_list(OpenCanvasInstance.from_dict, obj.get("openCanvases")) + return CanvasListOpenResult(open_canvases) + + def to_dict(self) -> dict: + result: dict = {} + result["openCanvases"] = from_list(lambda x: to_class(OpenCanvasInstance, x), self.open_canvases) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsResult: + """Result of collecting a redacted debug bundle.""" + + entries: list[DebugCollectLogsCollectedEntry] + """Files included in the redacted bundle.""" + + kind: DebugCollectLogsResultKind + """Destination kind that was written.""" + + path: str + """Actual archive path or staging directory path written. This may differ from the requested + path when no-overwrite suffixing or fallback-to-temp-directory was needed. + """ + skipped_entries: list[DebugCollectLogsSkippedEntry] | None = None + """Optional files or directories that could not be included.""" + + @staticmethod + def from_dict(obj: Any) -> 'DebugCollectLogsResult': + assert isinstance(obj, dict) + entries = from_list(DebugCollectLogsCollectedEntry.from_dict, obj.get("entries")) + kind = DebugCollectLogsResultKind(obj.get("kind")) + path = from_str(obj.get("path")) + skipped_entries = from_union([lambda x: from_list(DebugCollectLogsSkippedEntry.from_dict, x), from_none], obj.get("skippedEntries")) + return DebugCollectLogsResult(entries, kind, path, skipped_entries) + + def to_dict(self) -> dict: + result: dict = {} + result["entries"] = from_list(lambda x: to_class(DebugCollectLogsCollectedEntry, x), self.entries) + result["kind"] = to_enum(DebugCollectLogsResultKind, self.kind) + result["path"] = from_str(self.path) + if self.skipped_entries is not None: + result["skippedEntries"] = from_union([lambda x: from_list(lambda x: to_class(DebugCollectLogsSkippedEntry, x), x), from_none], self.skipped_entries) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionManagedSettings: + """Managed settings an SDK host may inject at session startup. Only permissions are accepted + in this initial contract. + + Permissions-only enterprise policy injected by the SDK host at session create or resume. + Composes restrictively with self-fetched and device policy and is not persisted. + """ + permissions: SessionManagedPermissions | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionManagedSettings': + assert isinstance(obj, dict) + permissions = from_union([SessionManagedPermissions.from_dict, from_none], obj.get("permissions")) + return SessionManagedSettings(permissions) + + def to_dict(self) -> dict: + result: dict = {} + if self.permissions is not None: + result["permissions"] = from_union([lambda x: to_class(SessionManagedPermissions, x), from_none], self.permissions) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DiscoveredExtensions: + """Extensions discovered from persisted Copilot home state and their effective loading mode. + Launch-scoped additional plugins are not included. + """ + extensions: list[DiscoveredExtension] + """Discovered user and enabled installed-plugin extensions from persisted Copilot home state""" + + mode: DiscoveredExtensionMode + """Effective extension loading mode. Defaults to load_and_augment when unset.""" + + @staticmethod + def from_dict(obj: Any) -> 'DiscoveredExtensions': + assert isinstance(obj, dict) + extensions = from_list(DiscoveredExtension.from_dict, obj.get("extensions")) + mode = DiscoveredExtensionMode(obj.get("mode")) + return DiscoveredExtensions(extensions, mode) + + def to_dict(self) -> dict: + result: dict = {} + result["extensions"] = from_list(lambda x: to_class(DiscoveredExtension, x), self.extensions) + result["mode"] = to_enum(DiscoveredExtensionMode, self.mode) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ExtensionList: + """Extensions discovered for the session, with their current status.""" + + extensions: list[Extension] + """Discovered extensions and their current status""" + + @staticmethod + def from_dict(obj: Any) -> 'ExtensionList': + assert isinstance(obj, dict) + extensions = from_list(Extension.from_dict, obj.get("extensions")) + return ExtensionList(extensions) + + def to_dict(self) -> dict: + result: dict = {} + result["extensions"] = from_list(lambda x: to_class(Extension, x), self.extensions) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess: + """Location-scoped approval details for an extension's permission-gated capability access, + keyed by extension name. + """ + extension_name: str + """Extension name.""" + + kind: ClassVar[str] = "extension-permission-access" + """Approval covering an extension's request to access a permission-gated capability.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess': + assert isinstance(obj, dict) + extension_name = from_str(obj.get("extensionName")) + return PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess(extension_name) + + def to_dict(self) -> dict: + result: dict = {} + result["extensionName"] = from_str(self.extension_name) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess: + """Session-scoped approval details for an extension's permission-gated capability access, + keyed by extension name. + """ + extension_name: str + """Extension name.""" + + kind: ClassVar[str] = "extension-permission-access" + """Approval covering an extension's request to access a permission-gated capability.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess': + assert isinstance(obj, dict) + extension_name = from_str(obj.get("extensionName")) + return PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess(extension_name) + + def to_dict(self) -> dict: + result: dict = {} + result["extensionName"] = from_str(self.extension_name) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess: + """Location-persisted tool approval details for an extension's permission-gated capability + access, keyed by extension name. + """ + extension_name: str + """Extension name.""" + + kind: ClassVar[str] = "extension-permission-access" + """Approval covering an extension's request to access a permission-gated capability.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess': + assert isinstance(obj, dict) + extension_name = from_str(obj.get("extensionName")) + return PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess(extension_name) + + def to_dict(self) -> dict: + result: dict = {} + result["extensionName"] = from_str(self.extension_name) + result["kind"] = self.kind + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ExternalToolTextResultForLlm: + """Expanded external tool result payload""" + + text_result_for_llm: str + """Text result returned to the model""" + + binary_results_for_llm: list[ExternalToolTextResultForLlmBinaryResultsForLlm] | None = None + """Base64-encoded binary results returned to the model""" + + contents: list[ExternalToolTextResultForLlmContent] | None = None + """Structured content blocks from the tool""" + + error: str | None = None + """Optional error message for failed executions""" + + result_type: str | None = None + """Execution outcome classification. Optional for back-compat; normalized to 'success' (or + 'failure' when error is present) when missing or unrecognized. + """ + session_log: str | None = None + """Detailed log content for timeline display""" + + tool_references: list[str] | None = None + """Tool references returned by a tool-search override: names of deferred tools to surface to + the model. When set, the tool result is materialized as `tool_reference` content blocks + (rather than plain text) so the model knows which deferred tools are now available. + """ + tool_telemetry: dict[str, Any] | None = None + """Optional tool-specific telemetry""" + + @staticmethod + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlm': + assert isinstance(obj, dict) + text_result_for_llm = from_str(obj.get("textResultForLlm")) + binary_results_for_llm = from_union([lambda x: from_list(ExternalToolTextResultForLlmBinaryResultsForLlm.from_dict, x), from_none], obj.get("binaryResultsForLlm")) + contents = from_union([lambda x: from_list(_load_ExternalToolTextResultForLlmContent, x), from_none], obj.get("contents")) + error = from_union([from_str, from_none], obj.get("error")) + result_type = from_union([from_str, from_none], obj.get("resultType")) + session_log = from_union([from_str, from_none], obj.get("sessionLog")) + tool_references = from_union([lambda x: from_list(from_str, x), from_none], obj.get("toolReferences")) + tool_telemetry = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("toolTelemetry")) + return ExternalToolTextResultForLlm(text_result_for_llm, binary_results_for_llm, contents, error, result_type, session_log, tool_references, tool_telemetry) + + def to_dict(self) -> dict: + result: dict = {} + result["textResultForLlm"] = from_str(self.text_result_for_llm) + if self.binary_results_for_llm is not None: + result["binaryResultsForLlm"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmBinaryResultsForLlm, x), x), from_none], self.binary_results_for_llm) + if self.contents is not None: + result["contents"] = from_union([lambda x: from_list(lambda x: (x).to_dict(), x), from_none], self.contents) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.result_type is not None: + result["resultType"] = from_union([from_str, from_none], self.result_type) + if self.session_log is not None: + result["sessionLog"] = from_union([from_str, from_none], self.session_log) + if self.tool_references is not None: + result["toolReferences"] = from_union([lambda x: from_list(from_str, x), from_none], self.tool_references) + if self.tool_telemetry is not None: + result["toolTelemetry"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.tool_telemetry) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ExternalToolTextResultForLlmContentResourceLink: + """Resource link content block referencing an external resource""" + + name: str + """Resource name identifier""" + + type: ClassVar[str] = "resource_link" + """Content block type discriminator""" + + uri: str + """URI identifying the resource""" + + description: str | None = None + """Human-readable description of the resource""" + + icons: list[ExternalToolTextResultForLlmContentResourceLinkIcon] | None = None + """Icons associated with this resource""" + + mime_type: str | None = None + """MIME type of the resource content""" + + size: int | None = None + """Size of the resource in bytes""" + + title: str | None = None + """Human-readable display title for the resource""" + + @staticmethod + def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLink': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + uri = from_str(obj.get("uri")) + description = from_union([from_str, from_none], obj.get("description")) + icons = from_union([lambda x: from_list(ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict, x), from_none], obj.get("icons")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + size = from_union([from_int, from_none], obj.get("size")) + title = from_union([from_str, from_none], obj.get("title")) + return ExternalToolTextResultForLlmContentResourceLink(name, uri, description, icons, mime_type, size, title) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["type"] = self.type + result["uri"] = from_str(self.uri) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.icons is not None: + result["icons"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, x), x), from_none], self.icons) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.size is not None: + result["size"] = from_union([from_int, from_none], self.size) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunTerminal: + """Prompt-safe terminal factory outcome.""" + + error: str | None = None + failure: FactoryRunFailure | None = None + reason: str | None = None + result_preview: str | None = None + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunTerminal': + assert isinstance(obj, dict) + error = from_union([from_str, from_none], obj.get("error")) + failure = from_union([FactoryRunFailure.from_dict, from_none], obj.get("failure")) + reason = from_union([from_str, from_none], obj.get("reason")) + result_preview = from_union([from_str, from_none], obj.get("resultPreview")) + return FactoryRunTerminal(error, failure, reason, result_preview) + + def to_dict(self) -> dict: + result: dict = {} + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.failure is not None: + result["failure"] = from_union([lambda x: to_class(FactoryRunFailure, x), from_none], self.failure) + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.result_preview is not None: + result["resultPreview"] = from_union([from_str, from_none], self.result_preview) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunResult: + """Terminal resumed run envelope. + + Complete current or terminal factory run envelope. + """ + run_id: str + """Factory run identifier.""" + + status: FactoryRunStatus + """Current or terminal factory run status.""" + + error: str | None = None + """Error message for an errored run.""" + + failure: FactoryRunFailure | None = None + """Machine-readable failure details for an errored run.""" + + reason: str | None = None + """Reason for a halted or cancelled run.""" + + result: Any = None + """Completed factory result.""" + + snapshot: Any = None + """Partial journal and progress snapshot for a halted, cancelled, or errored run.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunResult': + assert isinstance(obj, dict) + run_id = from_str(obj.get("runId")) + status = FactoryRunStatus(obj.get("status")) + error = from_union([from_str, from_none], obj.get("error")) + failure = from_union([FactoryRunFailure.from_dict, from_none], obj.get("failure")) + reason = from_union([from_str, from_none], obj.get("reason")) + result = obj.get("result") + snapshot = obj.get("snapshot") + return FactoryRunResult(run_id, status, error, failure, reason, result, snapshot) + + def to_dict(self) -> dict: + result: dict = {} + result["runId"] = from_str(self.run_id) + result["status"] = to_enum(FactoryRunStatus, self.status) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.failure is not None: + result["failure"] = from_union([lambda x: to_class(FactoryRunFailure, x), from_none], self.failure) + if self.reason is not None: + result["reason"] = from_union([from_str, from_none], self.reason) + if self.result is not None: + result["result"] = self.result + if self.snapshot is not None: + result["snapshot"] = self.snapshot + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryLogRequest: + """Parameters for recording factory progress.""" + + execution_token: str + """Opaque token identifying the current factory execution attempt.""" + + lines: list[FactoryLogLine] + """Ordered progress lines to append.""" + + run_id: str + """Factory run identifier.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryLogRequest': + assert isinstance(obj, dict) + execution_token = from_str(obj.get("executionToken")) + lines = from_list(FactoryLogLine.from_dict, obj.get("lines")) + run_id = from_str(obj.get("runId")) + return FactoryLogRequest(execution_token, lines, run_id) + + def to_dict(self) -> dict: + result: dict = {} + result["executionToken"] = from_str(self.execution_token) + result["lines"] = from_list(lambda x: to_class(FactoryLogLine, x), self.lines) + result["runId"] = from_str(self.run_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryProgressPage: + """A bidirectional page of factory progress.""" + + has_more_newer: bool + has_more_older: bool + records: list[FactoryProgressLine] + revision: int + """Run revision reflected by this page.""" + + newest_seq: int | None = None + oldest_seq: int | None = None + + @staticmethod + def from_dict(obj: Any) -> 'FactoryProgressPage': + assert isinstance(obj, dict) + has_more_newer = from_bool(obj.get("hasMoreNewer")) + has_more_older = from_bool(obj.get("hasMoreOlder")) + records = from_list(FactoryProgressLine.from_dict, obj.get("records")) + revision = from_int(obj.get("revision")) + newest_seq = from_union([from_int, from_none], obj.get("newestSeq")) + oldest_seq = from_union([from_int, from_none], obj.get("oldestSeq")) + return FactoryProgressPage(has_more_newer, has_more_older, records, revision, newest_seq, oldest_seq) + + def to_dict(self) -> dict: + result: dict = {} + result["hasMoreNewer"] = from_bool(self.has_more_newer) + result["hasMoreOlder"] = from_bool(self.has_more_older) + result["records"] = from_list(lambda x: to_class(FactoryProgressLine, x), self.records) + result["revision"] = from_int(self.revision) + result["newestSeq"] = from_union([from_int, from_none], self.newest_seq) + result["oldestSeq"] = from_union([from_int, from_none], self.oldest_seq) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunRequest: + """Parameters for invoking a registered factory.""" + + args: Any + """Factory input value.""" + + name: str + """Registered factory name.""" + + options: RunOptions | None = None + """Factory invocation options.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunRequest': + assert isinstance(obj, dict) + args = obj.get("args") + name = from_str(obj.get("name")) + options = from_union([RunOptions.from_dict, from_none], obj.get("options")) + return FactoryRunRequest(args, name, options) + + def to_dict(self) -> dict: + result: dict = {} + result["args"] = self.args + result["name"] = from_str(self.name) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(RunOptions, x), from_none], self.options) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class HistoryRewindResult: + """Structured outcome of a rewind request.""" + + outcome: HistoryRewindOutcome + """Overall rewind outcome. This discriminates the result: it governs which of the remaining + fields are populated, so consumers must switch on it before reading `eventsRemoved`, + `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that + populate it. + """ + restored_files: list[str] + """Absolute paths restored to their captured preimages. Always empty for conversation-only + rewinds and for the unavailable outcomes (`session-busy`, + `file-change-tracking-disabled`, `unsupported-remote-session`); only + conversation-and-files outcomes that reached the file-restore stage populate it. + """ + skipped_files: list[HistorySkippedFileRestore] + """Captured files intentionally left unchanged. Always empty for conversation-only rewinds + and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, + `unsupported-remote-session`); only conversation-and-files outcomes that reached the + file-restore stage populate it. + """ + error: str | None = None + """Failure detail. Set only for the failure and partial-failure outcomes + (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, + `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the + unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, + `unsupported-remote-session`). + """ + events_removed: int | None = None + """Number of persisted events removed by conversation truncation. Present only when + truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and + `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, + `file-change-tracking-disabled`, `unsupported-remote-session`) and for + `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + """ + + @staticmethod + def from_dict(obj: Any) -> 'HistoryRewindResult': + assert isinstance(obj, dict) + outcome = HistoryRewindOutcome(obj.get("outcome")) + restored_files = from_list(from_str, obj.get("restoredFiles")) + skipped_files = from_list(HistorySkippedFileRestore.from_dict, obj.get("skippedFiles")) + error = from_union([from_str, from_none], obj.get("error")) + events_removed = from_union([from_int, from_none], obj.get("eventsRemoved")) + return HistoryRewindResult(outcome, restored_files, skipped_files, error, events_removed) + + def to_dict(self) -> dict: + result: dict = {} + result["outcome"] = to_enum(HistoryRewindOutcome, self.outcome) + result["restoredFiles"] = from_list(from_str, self.restored_files) + result["skippedFiles"] = from_list(lambda x: to_class(HistorySkippedFileRestore, x), self.skipped_files) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.events_removed is not None: + result["eventsRemoved"] = from_union([from_int, from_none], self.events_removed) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class HistoryPreviewRewindResult: + """Files and aggregate changes for a prospective rewind.""" + + available: bool + """Whether file restore is available for this session. This is authoritative: switch on it + and read `reason` only when it is false. + """ + file_count: int + """Number of unique files in the preview.""" + + files: list[HistoryRewindFilePreview] + """Files ordered by path.""" + + reason: HistoryRewindUnavailableReason | None = None + """Why file restore is unavailable, when applicable. Populated only when `available` is + false and never set when `available` is true. + """ + + @staticmethod + def from_dict(obj: Any) -> 'HistoryPreviewRewindResult': + assert isinstance(obj, dict) + available = from_bool(obj.get("available")) + file_count = from_int(obj.get("fileCount")) + files = from_list(HistoryRewindFilePreview.from_dict, obj.get("files")) + reason = from_union([HistoryRewindUnavailableReason, from_none], obj.get("reason")) + return HistoryPreviewRewindResult(available, file_count, files, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["available"] = from_bool(self.available) + result["fileCount"] = from_int(self.file_count) + result["files"] = from_list(lambda x: to_class(HistoryRewindFilePreview, x), self.files) + if self.reason is not None: + result["reason"] = from_union([lambda x: to_enum(HistoryRewindUnavailableReason, x), from_none], self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstalledPlugin: + """Installed plugin record from global state, with marketplace, version, install time, + enabled state, cache path, and source. + """ + enabled: bool + """Whether the plugin is currently enabled""" + + installed_at: str + """Installation timestamp""" + + marketplace: str + """Marketplace the plugin came from (empty string for direct repo installs)""" + + name: str + """Plugin name""" + + cache_path: str | None = None + """Path where the plugin is cached locally""" + + source: InstalledPluginSource | str | None = None + """Source for direct repo installs (when marketplace is empty)""" + + source_sha: str | None = None + """Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus + its resolved source subtree — NOT a Git commit SHA) captured at marketplace + install/update time. Auto-update compares it against the freshly recomputed fingerprint + to detect a content change that does not bump the version. Absent for pre-existing + installs and for direct (non-marketplace) installs. + """ + version: str | None = None + """Version installed (if available)""" + + @staticmethod + def from_dict(obj: Any) -> 'InstalledPlugin': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + installed_at = from_str(obj.get("installed_at")) + marketplace = from_str(obj.get("marketplace")) + name = from_str(obj.get("name")) + cache_path = from_union([from_str, from_none], obj.get("cache_path")) + source = from_union([InstalledPluginSource.from_dict, from_str, from_none], obj.get("source")) + source_sha = from_union([from_str, from_none], obj.get("source_sha")) + version = from_union([from_str, from_none], obj.get("version")) + return InstalledPlugin(enabled, installed_at, marketplace, name, cache_path, source, source_sha, version) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + result["installed_at"] = from_str(self.installed_at) + result["marketplace"] = from_str(self.marketplace) + result["name"] = from_str(self.name) + if self.cache_path is not None: + result["cache_path"] = from_union([from_str, from_none], self.cache_path) + if self.source is not None: + result["source"] = from_union([lambda x: to_class(InstalledPluginSource, x), from_str, from_none], self.source) + if self.source_sha is not None: + result["source_sha"] = from_union([from_str, from_none], self.source_sha) + if self.version is not None: + result["version"] = from_union([from_str, from_none], self.version) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionInstalledPlugin: + """Installed plugin record for a session, with marketplace, version, install time, enabled + state, cache path, and source. + """ + enabled: bool + """Whether the plugin is currently enabled""" + + installed_at: str + """Installation timestamp (ISO-8601)""" + + marketplace: str + """Marketplace the plugin came from (empty string for direct repo installs)""" + + name: str + """Plugin name""" + + cache_path: str | None = None + """Path where the plugin is cached locally""" + + source: SessionInstalledPluginSource | str | None = None + """Source descriptor for direct repo installs (when marketplace is empty)""" + + source_sha: str | None = None + """Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus + its resolved source subtree — NOT a Git commit SHA) captured at marketplace + install/update time. Auto-update compares it against the freshly recomputed fingerprint + to detect a content change that does not bump the version. Absent for pre-existing + installs and for direct (non-marketplace) installs. + """ + version: str | None = None + """Installed version, if known""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionInstalledPlugin': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + installed_at = from_str(obj.get("installed_at")) + marketplace = from_str(obj.get("marketplace")) + name = from_str(obj.get("name")) + cache_path = from_union([from_str, from_none], obj.get("cache_path")) + source = from_union([SessionInstalledPluginSource.from_dict, from_str, from_none], obj.get("source")) + source_sha = from_union([from_str, from_none], obj.get("source_sha")) + version = from_union([from_str, from_none], obj.get("version")) + return SessionInstalledPlugin(enabled, installed_at, marketplace, name, cache_path, source, source_sha, version) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + result["installed_at"] = from_str(self.installed_at) + result["marketplace"] = from_str(self.marketplace) + result["name"] = from_str(self.name) + if self.cache_path is not None: + result["cache_path"] = from_union([from_str, from_none], self.cache_path) + if self.source is not None: + result["source"] = from_union([lambda x: to_class(SessionInstalledPluginSource, x), from_str, from_none], self.source) + if self.source_sha is not None: + result["source_sha"] = from_union([from_str, from_none], self.source_sha) + if self.version is not None: + result["version"] = from_union([from_str, from_none], self.version) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstructionsGetSourcesResult: + """Instruction sources loaded for the session, in merge order.""" + + sources: list[InstructionSource] + """Instruction sources for the session""" + + @staticmethod + def from_dict(obj: Any) -> 'InstructionsGetSourcesResult': + assert isinstance(obj, dict) + sources = from_list(InstructionSource.from_dict, obj.get("sources")) + return InstructionsGetSourcesResult(sources) + + def to_dict(self) -> dict: + result: dict = {} + result["sources"] = from_list(lambda x: to_class(InstructionSource, x), self.sources) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ServerInstructionSourceList: + """Instruction sources discovered across user, repository, and plugin sources.""" + + sources: list[InstructionSource] + """All discovered instruction sources""" + + @staticmethod + def from_dict(obj: Any) -> 'ServerInstructionSourceList': + assert isinstance(obj, dict) + sources = from_list(InstructionSource.from_dict, obj.get("sources")) + return ServerInstructionSourceList(sources) + + def to_dict(self) -> dict: + result: dict = {} + result["sources"] = from_list(lambda x: to_class(InstructionSource, x), self.sources) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class LocalSessionMetadataValue: + """Persisted local session metadata, including identifiers, timestamps, summary/name, + client, context, detached state, and task ID. + + Local session metadata, omitted when the session does not exist. + """ + is_remote: bool + """Always false for local sessions.""" + + modified_time: str + """Last-modified time of the session's persisted state, as ISO 8601""" + + session_id: str + """Stable session identifier""" + + start_time: str + """Session creation time as an ISO 8601 timestamp""" + + client_name: str | None = None + """Runtime client name that created/last resumed this session""" + + context: SessionContext | None = None + """Pre-resolved working-directory context for session startup.""" + + is_detached: bool | None = None + """True for detached maintenance sessions that should be hidden from normal resume lists.""" + + mc_task_id: str | None = None + """GitHub task ID, when this local session is bound to one. Only present for local sessions + exported to remote control. + """ + name: str | None = None + """Optional human-friendly name set via /rename""" + + summary: str | None = None + """Short summary of the session, when one has been derived""" + + @staticmethod + def from_dict(obj: Any) -> 'LocalSessionMetadataValue': + assert isinstance(obj, dict) + is_remote = from_bool(obj.get("isRemote")) + modified_time = from_str(obj.get("modifiedTime")) + session_id = from_str(obj.get("sessionId")) + start_time = from_str(obj.get("startTime")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + context = from_union([SessionContext.from_dict, from_none], obj.get("context")) + is_detached = from_union([from_bool, from_none], obj.get("isDetached")) + mc_task_id = from_union([from_str, from_none], obj.get("mcTaskId")) + name = from_union([from_str, from_none], obj.get("name")) + summary = from_union([from_str, from_none], obj.get("summary")) + return LocalSessionMetadataValue(is_remote, modified_time, session_id, start_time, client_name, context, is_detached, mc_task_id, name, summary) + + def to_dict(self) -> dict: + result: dict = {} + result["isRemote"] = from_bool(self.is_remote) + result["modifiedTime"] = from_str(self.modified_time) + result["sessionId"] = from_str(self.session_id) + result["startTime"] = from_str(self.start_time) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.context is not None: + result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) + if self.is_detached is not None: + result["isDetached"] = from_union([from_bool, from_none], self.is_detached) + if self.mc_task_id is not None: + result["mcTaskId"] = from_union([from_str, from_none], self.mc_task_id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.summary is not None: + result["summary"] = from_union([from_str, from_none], self.summary) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class RemoteSessionMetadataValue: + """Remote session metadata for the session to hand off (typically obtained from + `sessions.list` with `source: "remote"`). + + Full remote-session metadata in wire-portable form. + + Remote session metadata, present when status is `connected`. + """ + is_remote: bool + """Always true for remote sessions.""" + + modified_time: str + """Last-modified time as an ISO 8601 timestamp.""" + + remote_session_ids: list[str] + """Backing remote session IDs (most recent first).""" + + repository: RemoteSessionMetadataRepository + """GitHub repository the remote session belongs to.""" + + session_id: str + """Stable session identifier.""" + + start_time: str + """Session creation time as an ISO 8601 timestamp.""" + + context: SessionContext | None = None + """Most recent working directory context.""" + + name: str | None = None + """Optional human-friendly name set via /rename.""" + + pull_request_number: int | None = None + """Pull request number associated with the session.""" + + resource_id: str | None = None + """Original remote resource identifier (task ID or PR node ID).""" + + stale_at: str | None = None + """Deadline (ISO 8601) at which a CLI remote session becomes stale without further + heartbeats. + """ + state: str | None = None + """Server-side task state returned by GitHub.""" + + summary: str | None = None + """Short summary of the session, when one has been derived.""" + + task_type: TaskType | None = None + """Whether the remote task originated from CCA or CLI `--remote`.""" + + @staticmethod + def from_dict(obj: Any) -> 'RemoteSessionMetadataValue': + assert isinstance(obj, dict) + is_remote = from_bool(obj.get("isRemote")) + modified_time = from_str(obj.get("modifiedTime")) + remote_session_ids = from_list(from_str, obj.get("remoteSessionIds")) + repository = RemoteSessionMetadataRepository.from_dict(obj.get("repository")) + session_id = from_str(obj.get("sessionId")) + start_time = from_str(obj.get("startTime")) + context = from_union([SessionContext.from_dict, from_none], obj.get("context")) + name = from_union([from_str, from_none], obj.get("name")) + pull_request_number = from_union([from_int, from_none], obj.get("pullRequestNumber")) + resource_id = from_union([from_str, from_none], obj.get("resourceId")) + stale_at = from_union([from_str, from_none], obj.get("staleAt")) + state = from_union([from_str, from_none], obj.get("state")) + summary = from_union([from_str, from_none], obj.get("summary")) + task_type = from_union([TaskType, from_none], obj.get("taskType")) + return RemoteSessionMetadataValue(is_remote, modified_time, remote_session_ids, repository, session_id, start_time, context, name, pull_request_number, resource_id, stale_at, state, summary, task_type) + + def to_dict(self) -> dict: + result: dict = {} + result["isRemote"] = from_bool(self.is_remote) + result["modifiedTime"] = from_str(self.modified_time) + result["remoteSessionIds"] = from_list(from_str, self.remote_session_ids) + result["repository"] = to_class(RemoteSessionMetadataRepository, self.repository) + result["sessionId"] = from_str(self.session_id) + result["startTime"] = from_str(self.start_time) + if self.context is not None: + result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.pull_request_number is not None: + result["pullRequestNumber"] = from_union([from_int, from_none], self.pull_request_number) + if self.resource_id is not None: + result["resourceId"] = from_union([from_str, from_none], self.resource_id) + if self.stale_at is not None: + result["staleAt"] = from_union([from_str, from_none], self.stale_at) + if self.state is not None: + result["state"] = from_union([from_str, from_none], self.state) + if self.summary is not None: + result["summary"] = from_union([from_str, from_none], self.summary) + if self.task_type is not None: + result["taskType"] = from_union([lambda x: to_enum(TaskType, x), from_none], self.task_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsGetLastForContextRequest: + """Optional working-directory context used to score session relevance.""" + + context: SessionContext | None = None + """Optional working-directory context used to score session relevance. When omitted the + most-recently-modified session wins. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionsGetLastForContextRequest': + assert isinstance(obj, dict) + context = from_union([SessionContext.from_dict, from_none], obj.get("context")) + return SessionsGetLastForContextRequest(context) + + def to_dict(self) -> dict: + result: dict = {} + if self.context is not None: + result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MetadataRecordContextChangeRequest: + """Updated working-directory/git context to record on the session.""" + + context: SessionWorkingDirectoryContext + """Updated working directory and git context. Emitted as the new payload of + `session.context_changed`. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MetadataRecordContextChangeRequest': + assert isinstance(obj, dict) + context = SessionWorkingDirectoryContext.from_dict(obj.get("context")) + return MetadataRecordContextChangeRequest(context) + + def to_dict(self) -> dict: + result: dict = {} + result["context"] = to_class(SessionWorkingDirectoryContext, self.context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionPathsConfig: + """If specified, replaces the session's path-permission policy. The runtime constructs the + appropriate PathManager based on these inputs (rooted at the session's working + directory). Omit to leave the current path policy unchanged. + """ + additional_directories: list[str] | None = None + """Additional directories to allow tool access to (in addition to the session's working + directory). When `unrestricted` is true, these are still pre-populated on the + UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention + completion). + """ + include_temp_directory: bool | None = None + """Whether to include the system temp directory in the allowed list (defaults to true). + Ignored when `unrestricted` is true. + """ + unrestricted: bool | None = None + """If true, the runtime allows access to all paths without prompting. Equivalent to + constructing an UnrestrictedPathManager. + """ + workspace_path: str | None = None + """Workspace root path (special-cased to be allowed even before the directory exists). + Ignored when `unrestricted` is true. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionPathsConfig': + assert isinstance(obj, dict) + additional_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("additionalDirectories")) + include_temp_directory = from_union([from_bool, from_none], obj.get("includeTempDirectory")) + unrestricted = from_union([from_bool, from_none], obj.get("unrestricted")) + workspace_path = from_union([from_str, from_none], obj.get("workspacePath")) + return PermissionPathsConfig(additional_directories, include_temp_directory, unrestricted, workspace_path) + + def to_dict(self) -> dict: + result: dict = {} + if self.additional_directories is not None: + result["additionalDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.additional_directories) + if self.include_temp_directory is not None: + result["includeTempDirectory"] = from_union([from_bool, from_none], self.include_temp_directory) + if self.unrestricted is not None: + result["unrestricted"] = from_union([from_bool, from_none], self.unrestricted) + if self.workspace_path is not None: + result["workspacePath"] = from_union([from_str, from_none], self.workspace_path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspaceSummary: + """Public-facing projection of workspace metadata for SDK / TUI consumers""" + + id: str + """Workspace identifier (1:1 with sessionId)""" + + branch: str | None = None + """Branch checked out at session start, if any""" + + created_at: datetime | None = None + """ISO 8601 timestamp when the workspace was created""" + + cwd: str | None = None + """Current working directory at session start""" + + git_root: str | None = None + """Resolved git root for cwd, if any""" + + host_type: HostType | None = None + """Repository host type, if known""" + + name: str | None = None + """Display name for the session, if set""" + + repository: str | None = None + """Repository identifier in 'owner/repo' or 'org/project/repo' format, if any""" + + updated_at: datetime | None = None + """ISO 8601 timestamp when the workspace was last updated""" + + user_named: bool | None = None + """Whether the display name was explicitly set by the user""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspaceSummary': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + branch = from_union([from_str, from_none], obj.get("branch")) + created_at = from_union([from_datetime, from_none], obj.get("created_at")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + git_root = from_union([from_str, from_none], obj.get("git_root")) + host_type = from_union([HostType, from_none], obj.get("host_type")) + name = from_union([from_str, from_none], obj.get("name")) + repository = from_union([from_str, from_none], obj.get("repository")) + updated_at = from_union([from_datetime, from_none], obj.get("updated_at")) + user_named = from_union([from_bool, from_none], obj.get("user_named")) + return WorkspaceSummary(id, branch, created_at, cwd, git_root, host_type, name, repository, updated_at, user_named) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.created_at is not None: + result["created_at"] = from_union([lambda x: x.isoformat(), from_none], self.created_at) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.git_root is not None: + result["git_root"] = from_union([from_str, from_none], self.git_root) + if self.host_type is not None: + result["host_type"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.repository is not None: + result["repository"] = from_union([from_str, from_none], self.repository) + if self.updated_at is not None: + result["updated_at"] = from_union([lambda x: x.isoformat(), from_none], self.updated_at) + if self.user_named is not None: + result["user_named"] = from_union([from_bool, from_none], self.user_named) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesCheckpoints: + """Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint + filename. + """ + filename: str + """Filename of the checkpoint within the workspace checkpoints directory""" + + number: int + """Checkpoint number assigned by the workspace manager""" + + title: str + """Human-readable checkpoint title""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesCheckpoints': + assert isinstance(obj, dict) + filename = from_str(obj.get("filename")) + number = from_int(obj.get("number")) + title = from_str(obj.get("title")) + return WorkspacesCheckpoints(filename, number, title) + + def to_dict(self) -> dict: + result: dict = {} + result["filename"] = from_str(self.filename) + result["number"] = from_int(self.number) + result["title"] = from_str(self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesGetWorkspaceResult: + """Current workspace metadata for the session, including its absolute filesystem path when + available. + """ + path: str | None = None + """Absolute filesystem path to the workspace directory. Omitted when the session has no + workspace (e.g. remote sessions). + """ + workspace: Workspace | None = None + """Current workspace metadata, or null if not available""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesGetWorkspaceResult': + assert isinstance(obj, dict) + path = from_union([from_str, from_none], obj.get("path")) + workspace = from_union([Workspace.from_dict, from_none], obj.get("workspace")) + return WorkspacesGetWorkspaceResult(path, workspace) + + def to_dict(self) -> dict: + result: dict = {} + if self.path is not None: + result["path"] = from_union([from_str, from_none], self.path) + result["workspace"] = from_union([lambda x: to_class(Workspace, x), from_none], self.workspace) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesUpdateMetadataRequest: + """Workspace metadata fields to update.""" + + context: Any = None + """Opaque workspace context supplied by the session host.""" + + name: str | None = None + """Optional workspace display name override.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesUpdateMetadataRequest': + assert isinstance(obj, dict) + context = obj.get("context") + name = from_union([from_str, from_none], obj.get("name")) + return WorkspacesUpdateMetadataRequest(context, name) + + def to_dict(self) -> dict: + result: dict = {} + if self.context is not None: + result["context"] = self.context + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPAppsHostContext: + """Current host context advertised to MCP App guests.""" + + context: MCPAppsHostContextDetails + """Current host context""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPAppsHostContext': + assert isinstance(obj, dict) + context = MCPAppsHostContextDetails.from_dict(obj.get("context")) + return MCPAppsHostContext(context) + + def to_dict(self) -> dict: + result: dict = {} + result["context"] = to_class(MCPAppsHostContextDetails, self.context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPAppsSetHostContextRequest: + """Host context to advertise to MCP App guests.""" + + context: MCPAppsSetHostContextDetails + """Host context advertised to MCP App guests""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPAppsSetHostContextRequest': + assert isinstance(obj, dict) + context = MCPAppsSetHostContextDetails.from_dict(obj.get("context")) + return MCPAppsSetHostContextRequest(context) + + def to_dict(self) -> dict: + result: dict = {} + result["context"] = to_class(MCPAppsSetHostContextDetails, self.context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPConfigAddRequest: + """MCP server name and configuration to add to user configuration.""" + + config: MCPServerConfig + """MCP server configuration (stdio process or remote HTTP/SSE)""" + + name: str + """Unique name for the MCP server""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPConfigAddRequest': + assert isinstance(obj, dict) + config = MCPServerConfig.from_dict(obj.get("config")) + name = from_str(obj.get("name")) + return MCPConfigAddRequest(config, name) + + def to_dict(self) -> dict: + result: dict = {} + result["config"] = to_class(MCPServerConfig, self.config) + result["name"] = from_str(self.name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPConfigList: + """User-configured MCP servers, keyed by server name.""" + + servers: dict[str, MCPServerConfig] + """All MCP servers from user config, keyed by name""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPConfigList': + assert isinstance(obj, dict) + servers = from_dict(MCPServerConfig.from_dict, obj.get("servers")) + return MCPConfigList(servers) + + def to_dict(self) -> dict: + result: dict = {} + result["servers"] = from_dict(lambda x: to_class(MCPServerConfig, x), self.servers) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPConfigUpdateRequest: + """MCP server name and replacement configuration to write to user configuration.""" + + config: MCPServerConfig + """MCP server configuration (stdio process or remote HTTP/SSE)""" + + name: str + """Name of the MCP server to update""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPConfigUpdateRequest': + assert isinstance(obj, dict) + config = MCPServerConfig.from_dict(obj.get("config")) + name = from_str(obj.get("name")) + return MCPConfigUpdateRequest(config, name) + + def to_dict(self) -> dict: + result: dict = {} + result["config"] = to_class(MCPServerConfig, self.config) + result["name"] = from_str(self.name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPRestartServerRequest: + """Server name and optional replacement configuration for an individual MCP server restart. + Omit `config` for a config-free restart-by-name of an already-configured server. + """ + server_name: str + """Name of the MCP server to restart""" + + config: MCPServerConfig | None = None + """Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart + the server with its already-registered configuration (config-free restart-by-name). + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPRestartServerRequest': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + config = from_union([MCPServerConfig.from_dict, from_none], obj.get("config")) + return MCPRestartServerRequest(server_name, config) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + if self.config is not None: + result["config"] = from_union([lambda x: to_class(MCPServerConfig, x), from_none], self.config) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPStartServerRequest: + """Server name and optional configuration for an individual MCP server start. Omit `config` + for a config-free start-by-name of an already-configured server. + """ + server_name: str + """Name of the MCP server to start""" + + config: MCPServerConfig | None = None + """MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server + with its already-registered configuration (config-free start-by-name). + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPStartServerRequest': + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + config = from_union([MCPServerConfig.from_dict, from_none], obj.get("config")) + return MCPStartServerRequest(server_name, config) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + if self.config is not None: + result["config"] = from_union([lambda x: to_class(MCPServerConfig, x), from_none], self.config) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPHeadersHandlePendingHeadersRefreshRequestRequest: + """MCP headers refresh request id and the host response.""" + + request_id: str + """Headers refresh request identifier from mcp.headers_refresh_required""" + + result: MCPHeadersHandlePendingHeadersRefreshRequest + """Host response: supply dynamic headers or decline this refresh.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPHeadersHandlePendingHeadersRefreshRequestRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + result = MCPHeadersHandlePendingHeadersRefreshRequest.from_dict(obj.get("result")) + return MCPHeadersHandlePendingHeadersRefreshRequestRequest(request_id, result) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["result"] = to_class(MCPHeadersHandlePendingHeadersRefreshRequest, self.result) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPOauthHandlePendingRequest: + """Pending MCP OAuth request ID and host-provided token or cancellation response.""" + + request_id: str + """OAuth request identifier from the mcp.oauth_required event""" + + result: MCPOauthPendingRequestResponse + """Host response to the pending OAuth request.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPOauthHandlePendingRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + result = MCPOauthPendingRequestResponse.from_dict(obj.get("result")) + return MCPOauthHandlePendingRequest(request_id, result) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["result"] = to_class(MCPOauthPendingRequestResponse, self.result) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsEntry: + """A caller-provided server-local file or directory to include in the debug bundle.""" + + bundle_path: str + """Relative path to use inside the staged bundle/archive.""" + + kind: DebugCollectLogsEntryKind + """Kind of source path to include.""" + + path: str + """Server-local source path to read.""" + + redaction: DebugCollectLogsRedaction | None = None + """How text content from this entry should be redacted. Defaults to plain-text.""" + + required: bool | None = None + """When true, collection fails if this entry cannot be read. Defaults to false, which + records the entry in `skippedEntries`. + """ + + @staticmethod + def from_dict(obj: Any) -> 'DebugCollectLogsEntry': + assert isinstance(obj, dict) + bundle_path = from_str(obj.get("bundlePath")) + kind = DebugCollectLogsEntryKind(obj.get("kind")) + path = from_str(obj.get("path")) + redaction = from_union([DebugCollectLogsRedaction, from_none], obj.get("redaction")) + required = from_union([from_bool, from_none], obj.get("required")) + return DebugCollectLogsEntry(bundle_path, kind, path, redaction, required) + + def to_dict(self) -> dict: + result: dict = {} + result["bundlePath"] = from_str(self.bundle_path) + result["kind"] = to_enum(DebugCollectLogsEntryKind, self.kind) + result["path"] = from_str(self.path) + if self.redaction is not None: + result["redaction"] = from_union([lambda x: to_enum(DebugCollectLogsRedaction, x), from_none], self.redaction) + if self.required is not None: + result["required"] = from_union([from_bool, from_none], self.required) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstructionDiscoveryPath: + """Canonical file or directory where custom instructions can be discovered or created, with + location, kind, preference, and project path. + """ + kind: DebugCollectLogsEntryKind + """Whether the target is a single file or a directory of instruction files""" + + location: InstructionLocation + """Which tier this target belongs to""" + + path: str + """Absolute path of the file or directory (may not exist on disk yet)""" + + preferred_for_creation: bool + """Whether this is the canonical target to create new instructions in its tier. At most one + entry per tier is preferred. + """ + project_path: str | None = None + """The input project path this target was derived from (only for repository targets)""" + + @staticmethod + def from_dict(obj: Any) -> 'InstructionDiscoveryPath': + assert isinstance(obj, dict) + kind = DebugCollectLogsEntryKind(obj.get("kind")) + location = InstructionLocation(obj.get("location")) + path = from_str(obj.get("path")) + preferred_for_creation = from_bool(obj.get("preferredForCreation")) + project_path = from_union([from_str, from_none], obj.get("projectPath")) + return InstructionDiscoveryPath(kind, location, path, preferred_for_creation, project_path) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(DebugCollectLogsEntryKind, self.kind) + result["location"] = to_enum(InstructionLocation, self.location) + result["path"] = from_str(self.path) + result["preferredForCreation"] = from_bool(self.preferred_for_creation) + if self.project_path is not None: + result["projectPath"] = from_union([from_str, from_none], self.project_path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSReaddirWithTypesEntry: + """Directory entry returned by session filesystem `readdirWithTypes`, with name and entry + type. + """ + name: str + """Entry name""" + + type: DebugCollectLogsEntryKind + """Entry type""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesEntry': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + type = DebugCollectLogsEntryKind(obj.get("type")) + return SessionFSReaddirWithTypesEntry(name, type) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["type"] = to_enum(DebugCollectLogsEntryKind, self.type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MetadataContextAttributionResult: + """Per-source attribution breakdown for the session's current context window, or null if + uninitialized. + """ + context_attribution: SessionContextAttribution | None = None + """Per-source context-window attribution, or null if the session has not yet been + initialized (no system prompt or tool metadata cached). + """ + + @staticmethod + def from_dict(obj: Any) -> 'MetadataContextAttributionResult': + assert isinstance(obj, dict) + context_attribution = from_union([SessionContextAttribution.from_dict, from_none], obj.get("contextAttribution")) + return MetadataContextAttributionResult(context_attribution) + + def to_dict(self) -> dict: + result: dict = {} + if self.context_attribution is not None: + result["contextAttribution"] = from_union([lambda x: to_class(SessionContextAttribution, x), from_none], self.context_attribution) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelBilling: + """Billing information""" + + discount_percent: int | None = None + """Whole-number percentage discount (0-100) applied to usage billed through this model. + Populated for the synthetic `auto` model, where requests routed by auto-mode are billed + at a reduced rate; absent for concrete models. + """ + multiplier: float | None = None + """Billing cost multiplier relative to the base rate""" + + promo: ModelBillingPromo | None = None + """Active server-driven promotion for this model, if any. Present when the model is being + promoted with a discount, which may be time-boxed or open-ended. + """ + token_prices: ModelBillingTokenPrices | None = None + """Token-level pricing information for this model""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelBilling': + assert isinstance(obj, dict) + discount_percent = from_union([from_int, from_none], obj.get("discountPercent")) + multiplier = from_union([from_float, from_none], obj.get("multiplier")) + promo = from_union([ModelBillingPromo.from_dict, from_none], obj.get("promo")) + token_prices = from_union([ModelBillingTokenPrices.from_dict, from_none], obj.get("tokenPrices")) + return ModelBilling(discount_percent, multiplier, promo, token_prices) + + def to_dict(self) -> dict: + result: dict = {} + if self.discount_percent is not None: + result["discountPercent"] = from_union([from_int, from_none], self.discount_percent) + if self.multiplier is not None: + result["multiplier"] = from_union([to_float, from_none], self.multiplier) + if self.promo is not None: + result["promo"] = from_union([lambda x: to_class(ModelBillingPromo, x), from_none], self.promo) + if self.token_prices is not None: + result["tokenPrices"] = from_union([lambda x: to_class(ModelBillingTokenPrices, x), from_none], self.token_prices) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionModelList: + """The list of models available to this session.""" + + list: list[Any] + """Available models, ordered with the most preferred default first. Includes both Copilot + (CAPI) models and any registry BYOK models; a BYOK model appears under its + provider-qualified selection id (`provider/id`). + """ + model_price_categories: list[SessionModelPriceCategory] | None = None + """Cost categories for the full CAPI catalog, including picker-disabled models that Auto may + select. Metadata only; entries absent from `list` are not manually selectable. + """ + quota_snapshots: dict[str, Any] | None = None + """Per-quota snapshots returned alongside the model list, keyed by quota type.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionModelList': + assert isinstance(obj, dict) + list = from_list(lambda x: x, obj.get("list")) + model_price_categories = from_union([lambda x: from_list(SessionModelPriceCategory.from_dict, x), from_none], obj.get("modelPriceCategories")) + quota_snapshots = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("quotaSnapshots")) + return SessionModelList(list, model_price_categories, quota_snapshots) + + def to_dict(self) -> dict: + result: dict = {} + result["list"] = from_list(lambda x: x, self.list) + if self.model_price_categories is not None: + result["modelPriceCategories"] = from_union([lambda x: from_list(lambda x: to_class(SessionModelPriceCategory, x), x), from_none], self.model_price_categories) + if self.quota_snapshots is not None: + result["quotaSnapshots"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.quota_snapshots) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ModelCapabilitiesOverride: + """Optional capability overrides (vision, tool_calls, reasoning, etc.). + + Override individual model capabilities resolved by the runtime + + Initial model capability overrides. + + Per-property model capability overrides for the selected model. + """ + limits: ModelCapabilitiesOverrideLimits | None = None + """Token limits for prompts, outputs, and context window""" + + supports: ModelCapabilitiesOverrideSupports | None = None + """Feature flags indicating what the model supports""" + + @staticmethod + def from_dict(obj: Any) -> 'ModelCapabilitiesOverride': + assert isinstance(obj, dict) + limits = from_union([ModelCapabilitiesOverrideLimits.from_dict, from_none], obj.get("limits")) + supports = from_union([ModelCapabilitiesOverrideSupports.from_dict, from_none], obj.get("supports")) + return ModelCapabilitiesOverride(limits, supports) + + def to_dict(self) -> dict: + result: dict = {} + if self.limits is not None: + result["limits"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimits, x), from_none], self.limits) + if self.supports is not None: + result["supports"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideSupports, x), from_none], self.supports) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ProviderTokenAcquireRequest: + """Asks the SDK client to acquire a bearer token for a BYOK provider whose config set + `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; + the runtime does no caching, so this is sent once per request. + """ + provider_name: str + """Name of the BYOK provider needing a token. For the legacy whole-session `provider` this + is the implicit provider name; for named providers it is `NamedProviderConfig.name`. + """ + session_id: str + """Target session identifier""" + + @staticmethod + def from_dict(obj: Any) -> 'ProviderTokenAcquireRequest': + assert isinstance(obj, dict) + provider_name = from_str(obj.get("providerName")) + session_id = from_str(obj.get("sessionId")) + return ProviderTokenAcquireRequest(provider_name, session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["providerName"] = from_str(self.provider_name) + result["sessionId"] = from_str(self.session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class OptionsUpdateAdditionalContentExclusionPolicy: + """Content-exclusion policy supplied to `session.options.update`, with rules, last-updated + data, and scope. + """ + last_updated_at: Any + rules: list[OptionsUpdateAdditionalContentExclusionPolicyRule] + scope: AdditionalContentExclusionPolicyScope + """Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration.""" + + @staticmethod + def from_dict(obj: Any) -> 'OptionsUpdateAdditionalContentExclusionPolicy': + assert isinstance(obj, dict) + last_updated_at = obj.get("last_updated_at") + rules = from_list(OptionsUpdateAdditionalContentExclusionPolicyRule.from_dict, obj.get("rules")) + scope = AdditionalContentExclusionPolicyScope(obj.get("scope")) + return OptionsUpdateAdditionalContentExclusionPolicy(last_updated_at, rules, scope) + + def to_dict(self) -> dict: + result: dict = {} + result["last_updated_at"] = self.last_updated_at + result["rules"] = from_list(lambda x: to_class(OptionsUpdateAdditionalContentExclusionPolicyRule, x), self.rules) + result["scope"] = to_enum(AdditionalContentExclusionPolicyScope, self.scope) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionDecisionRequest: + """Pending permission request ID and the decision to apply (approve/reject and scope).""" + + request_id: str + """Request ID of the pending permission request""" + + result: PermissionDecision + """The client's response to the pending permission prompt""" + + decision_context: PermissionDecisionContext | None = None + """Optional informational context describing how and where this response was made. Omit it + to preserve legacy behavior without attributing an origin. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionDecisionRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + result = _load_PermissionDecision(obj.get("result")) + decision_context = from_union([PermissionDecisionContext.from_dict, from_none], obj.get("decisionContext")) + return PermissionDecisionRequest(request_id, result, decision_context) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["result"] = (self.result).to_dict() + if self.decision_context is not None: + result["decisionContext"] = from_union([lambda x: to_class(PermissionDecisionContext, x), from_none], self.decision_context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsConfigureAdditionalContentExclusionPolicy: + """Content-exclusion policy supplied to `session.permissions.configure`, with rules, + last-updated data, and scope. + """ + last_updated_at: Any + rules: list[PermissionsConfigureAdditionalContentExclusionPolicyRule] + scope: AdditionalContentExclusionPolicyScope + """Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` + enumeration. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsConfigureAdditionalContentExclusionPolicy': + assert isinstance(obj, dict) + last_updated_at = obj.get("last_updated_at") + rules = from_list(PermissionsConfigureAdditionalContentExclusionPolicyRule.from_dict, obj.get("rules")) + scope = AdditionalContentExclusionPolicyScope(obj.get("scope")) + return PermissionsConfigureAdditionalContentExclusionPolicy(last_updated_at, rules, scope) + + def to_dict(self) -> dict: + result: dict = {} + result["last_updated_at"] = self.last_updated_at + result["rules"] = from_list(lambda x: to_class(PermissionsConfigureAdditionalContentExclusionPolicyRule, x), self.rules) + result["scope"] = to_enum(AdditionalContentExclusionPolicyScope, self.scope) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPDiscoverResult: + """MCP servers discovered from user, workspace, plugin, and built-in sources.""" + + servers: list[DiscoveredMCPServer] + """MCP servers discovered from all sources""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPDiscoverResult': + assert isinstance(obj, dict) + servers = from_list(DiscoveredMCPServer.from_dict, obj.get("servers")) + return MCPDiscoverResult(servers) + + def to_dict(self) -> dict: + result: dict = {} + result["servers"] = from_list(lambda x: to_class(DiscoveredMCPServer, x), self.servers) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginInstallResult: + """Result of installing a plugin.""" + + plugin: InstalledPluginInfo + """The newly installed plugin's metadata""" + + skills_installed: int + """Number of skills discovered and installed from the plugin""" + + deprecation_warning: str | None = None + """Set when the install path is deprecated (e.g. direct repo / URL / local installs). + Callers should surface this to end users. + """ + post_install_message: str | None = None + """Optional post-install message provided by the plugin (e.g. setup instructions)""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginInstallResult': + assert isinstance(obj, dict) + plugin = InstalledPluginInfo.from_dict(obj.get("plugin")) + skills_installed = from_int(obj.get("skillsInstalled")) + deprecation_warning = from_union([from_str, from_none], obj.get("deprecationWarning")) + post_install_message = from_union([from_str, from_none], obj.get("postInstallMessage")) + return PluginInstallResult(plugin, skills_installed, deprecation_warning, post_install_message) + + def to_dict(self) -> dict: + result: dict = {} + result["plugin"] = to_class(InstalledPluginInfo, self.plugin) + result["skillsInstalled"] = from_int(self.skills_installed) + if self.deprecation_warning is not None: + result["deprecationWarning"] = from_union([from_str, from_none], self.deprecation_warning) + if self.post_install_message is not None: + result["postInstallMessage"] = from_union([from_str, from_none], self.post_install_message) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginListResult: + """Plugins installed in user/global state.""" + + plugins: list[InstalledPluginInfo] + """Installed plugins""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginListResult': + assert isinstance(obj, dict) + plugins = from_list(InstalledPluginInfo.from_dict, obj.get("plugins")) + return PluginListResult(plugins) + + def to_dict(self) -> dict: + result: dict = {} + result["plugins"] = from_list(lambda x: to_class(InstalledPluginInfo, x), self.plugins) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MarketplaceBrowseResult: + """Plugins advertised by the marketplace.""" + + plugins: list[MarketplacePluginInfo] + """Plugins advertised by the marketplace""" + + @staticmethod + def from_dict(obj: Any) -> 'MarketplaceBrowseResult': + assert isinstance(obj, dict) + plugins = from_list(MarketplacePluginInfo.from_dict, obj.get("plugins")) + return MarketplaceBrowseResult(plugins) + + def to_dict(self) -> dict: + result: dict = {} + result["plugins"] = from_list(lambda x: to_class(MarketplacePluginInfo, x), self.plugins) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPServerList: + """MCP servers configured for the session, with their connection status and host-level state.""" + + servers: list[MCPServer] + """Configured MCP servers""" + + host: MCPHostState | None = None + """Host-level state, omitted when no MCP host is initialized.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPServerList': + assert isinstance(obj, dict) + servers = from_list(MCPServer.from_dict, obj.get("servers")) + host = from_union([MCPHostState.from_dict, from_none], obj.get("host")) + return MCPServerList(servers, host) + + def to_dict(self) -> dict: + result: dict = {} + result["servers"] = from_list(lambda x: to_class(MCPServer, x), self.servers) + if self.host is not None: + result["host"] = from_union([lambda x: to_class(MCPHostState, x), from_none], self.host) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PluginUpdateAllResult: + """Result of updating all installed plugins.""" + + results: list[PluginUpdateAllEntry] + """Per-plugin update results in deterministic order.""" + + @staticmethod + def from_dict(obj: Any) -> 'PluginUpdateAllResult': + assert isinstance(obj, dict) + results = from_list(PluginUpdateAllEntry.from_dict, obj.get("results")) + return PluginUpdateAllResult(results) + + def to_dict(self) -> dict: + result: dict = {} + result["results"] = from_list(lambda x: to_class(PluginUpdateAllEntry, x), self.results) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubFileDiff: + """Pointer to a single-file diff. At least one of `head` and `base` must be present.""" + + type: ClassVar[str] = "github_file_diff" + """Attachment type discriminator""" + + url: str + """URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL)""" + + base: PushAttachmentGitHubFileDiffSide | None = None + """File location on the base side of the diff. Absent for additions.""" + + head: PushAttachmentGitHubFileDiffSide | None = None + """File location on the head side of the diff. Absent for deletions.""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubFileDiff': + assert isinstance(obj, dict) + url = from_str(obj.get("url")) + base = from_union([PushAttachmentGitHubFileDiffSide.from_dict, from_none], obj.get("base")) + head = from_union([PushAttachmentGitHubFileDiffSide.from_dict, from_none], obj.get("head")) + return PushAttachmentGitHubFileDiff(url, base, head) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = self.type + result["url"] = from_str(self.url) + if self.base is not None: + result["base"] = from_union([lambda x: to_class(PushAttachmentGitHubFileDiffSide, x), from_none], self.base) + if self.head is not None: + result["head"] = from_union([lambda x: to_class(PushAttachmentGitHubFileDiffSide, x), from_none], self.head) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentGitHubTreeComparison: + """Pointer to a comparison between two git revisions.""" + + base: PushAttachmentGitHubTreeComparisonSide + """Base side of the comparison""" + + head: PushAttachmentGitHubTreeComparisonSide + """Head side of the comparison""" + + type: ClassVar[str] = "github_tree_comparison" + """Attachment type discriminator""" + + url: str + """URL to the comparison on GitHub""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentGitHubTreeComparison': + assert isinstance(obj, dict) + base = PushAttachmentGitHubTreeComparisonSide.from_dict(obj.get("base")) + head = PushAttachmentGitHubTreeComparisonSide.from_dict(obj.get("head")) + url = from_str(obj.get("url")) + return PushAttachmentGitHubTreeComparison(base, head, url) + + def to_dict(self) -> dict: + result: dict = {} + result["base"] = to_class(PushAttachmentGitHubTreeComparisonSide, self.base) + result["head"] = to_class(PushAttachmentGitHubTreeComparisonSide, self.head) + result["type"] = self.type + result["url"] = from_str(self.url) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PushAttachmentSelection: + """Code selection attachment from an editor""" + + display_name: str + """User-facing display name for the selection""" + + file_path: str + """Absolute path to the file containing the selection""" + + selection: PushAttachmentSelectionDetails + """Position range of the selection within the file""" + + text: str + """The selected text content""" + + type: ClassVar[str] = "selection" + """Attachment type discriminator""" + + @staticmethod + def from_dict(obj: Any) -> 'PushAttachmentSelection': + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + file_path = from_str(obj.get("filePath")) + selection = PushAttachmentSelectionDetails.from_dict(obj.get("selection")) + text = from_str(obj.get("text")) + return PushAttachmentSelection(display_name, file_path, selection, text) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["filePath"] = from_str(self.file_path) + result["selection"] = to_class(PushAttachmentSelectionDetails, self.selection) + result["text"] = from_str(self.text) + result["type"] = self.type + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueInsertAtRequest: + """Parameters for inserting a queued message at a public visible position.""" + + message: QueueInsertMessage + position: int + """Zero-based position in the public visible queue. Values outside the queue clamp to an end.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueInsertAtRequest': + assert isinstance(obj, dict) + message = QueueInsertMessage.from_dict(obj.get("message")) + position = from_int(obj.get("position")) + return QueueInsertAtRequest(message, position) + + def to_dict(self) -> dict: + result: dict = {} + result["message"] = to_class(QueueInsertMessage, self.message) + result["position"] = from_int(self.position) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueuePendingItemsResult: + """Snapshot of the session's pending queued items and immediate-steering messages.""" + + items: list[QueuePendingItems] + """Pending queued items in submission order. Includes user messages, queued slash commands, + and queued model changes; omits internal system items. + """ + steering_messages: list[str] + """Display text for messages currently in the immediate steering queue (interjections sent + during a running turn). + """ + + @staticmethod + def from_dict(obj: Any) -> 'QueuePendingItemsResult': + assert isinstance(obj, dict) + items = from_list(QueuePendingItems.from_dict, obj.get("items")) + steering_messages = from_list(from_str, obj.get("steeringMessages")) + return QueuePendingItemsResult(items, steering_messages) + + def to_dict(self) -> dict: + result: dict = {} + result["items"] = from_list(lambda x: to_class(QueuePendingItems, x), self.items) + result["steeringMessages"] = from_list(from_str, self.steering_messages) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class QueueSnapshotResult: + """Internal snapshot of native queue state for local session orchestration.""" + + items: list[QueuePendingItems] + """User-facing pending items in FIFO order.""" + + steering_messages: list[str] + """Immediate steering messages waiting for an active turn.""" + + item_orders: list[int] | None = None + """Insertion orders for queued items, aligned with `items`.""" + + steering_message_orders: list[int] | None = None + """Insertion orders for immediate steering messages, aligned with `steeringMessages`.""" + + @staticmethod + def from_dict(obj: Any) -> 'QueueSnapshotResult': + assert isinstance(obj, dict) + items = from_list(QueuePendingItems.from_dict, obj.get("items")) + steering_messages = from_list(from_str, obj.get("steeringMessages")) + item_orders = from_union([lambda x: from_list(from_int, x), from_none], obj.get("itemOrders")) + steering_message_orders = from_union([lambda x: from_list(from_int, x), from_none], obj.get("steeringMessageOrders")) + return QueueSnapshotResult(items, steering_messages, item_orders, steering_message_orders) + + def to_dict(self) -> dict: + result: dict = {} + result["items"] = from_list(lambda x: to_class(QueuePendingItems, x), self.items) + result["steeringMessages"] = from_list(from_str, self.steering_messages) + if self.item_orders is not None: + result["itemOrders"] = from_union([lambda x: from_list(from_int, x), from_none], self.item_orders) + if self.steering_message_orders is not None: + result["steeringMessageOrders"] = from_union([lambda x: from_list(from_int, x), from_none], self.steering_message_orders) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsStartRemoteControlRequest: + """Parameters for attaching the remote-control singleton to a session.""" + + config: RemoteControlConfig + """Configuration for the runtime-managed remote-control singleton.""" + + session_id: str + """Local session id to attach remote control to.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsStartRemoteControlRequest': + assert isinstance(obj, dict) + config = RemoteControlConfig.from_dict(obj.get("config")) + session_id = from_str(obj.get("sessionId")) + return SessionsStartRemoteControlRequest(config, session_id) + + def to_dict(self) -> dict: + result: dict = {} + result["config"] = to_class(RemoteControlConfig, self.config) + result["sessionId"] = from_str(self.session_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SandboxConfigUserPolicy: + """User-managed sandbox policy fragment merged into the auto-discovered base policy.""" + + experimental: SandboxConfigUserPolicyExperimental | None = None + """Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is + absent. + """ + filesystem: SandboxConfigUserPolicyFilesystem | None = None + """Filesystem rules to merge into the base policy.""" + + network: SandboxConfigUserPolicyNetwork | None = None + """Network rules to merge into the base policy.""" + + seatbelt: SandboxConfigUserPolicySeatbelt | None = None + """macOS seatbelt options to merge into the base policy.""" + + @staticmethod + def from_dict(obj: Any) -> 'SandboxConfigUserPolicy': + assert isinstance(obj, dict) + experimental = from_union([SandboxConfigUserPolicyExperimental.from_dict, from_none], obj.get("experimental")) + filesystem = from_union([SandboxConfigUserPolicyFilesystem.from_dict, from_none], obj.get("filesystem")) + network = from_union([SandboxConfigUserPolicyNetwork.from_dict, from_none], obj.get("network")) + seatbelt = from_union([SandboxConfigUserPolicySeatbelt.from_dict, from_none], obj.get("seatbelt")) + return SandboxConfigUserPolicy(experimental, filesystem, network, seatbelt) + + def to_dict(self) -> dict: + result: dict = {} + if self.experimental is not None: + result["experimental"] = from_union([lambda x: to_class(SandboxConfigUserPolicyExperimental, x), from_none], self.experimental) + if self.filesystem is not None: + result["filesystem"] = from_union([lambda x: to_class(SandboxConfigUserPolicyFilesystem, x), from_none], self.filesystem) + if self.network is not None: + result["network"] = from_union([lambda x: to_class(SandboxConfigUserPolicyNetwork, x), from_none], self.network) + if self.seatbelt is not None: + result["seatbelt"] = from_union([lambda x: to_class(SandboxConfigUserPolicySeatbelt, x), from_none], self.seatbelt) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSReadFileResult: + """File content as a UTF-8 string, or a filesystem error if the read failed.""" + + content: str + """File content as UTF-8 string""" + + error: SessionFSError | None = None + """Describes a filesystem error.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSReadFileResult': + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) + return SessionFSReadFileResult(content, error) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSReaddirResult: + """Names of entries in the requested directory, or a filesystem error if the read failed.""" + + entries: list[str] + """Entry names in the directory""" + + error: SessionFSError | None = None + """Describes a filesystem error.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSReaddirResult': + assert isinstance(obj, dict) + entries = from_list(from_str, obj.get("entries")) + error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) + return SessionFSReaddirResult(entries, error) + + def to_dict(self) -> dict: + result: dict = {} + result["entries"] = from_list(from_str, self.entries) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteQueryResult: + """Query results including rows, columns, and rows affected, or a filesystem error if + execution failed. + """ + columns: list[str] + """Column names from the result set""" + + rows: list[dict[str, Any]] + """For SELECT: array of row objects. For others: empty array.""" + + rows_affected: int + """Number of rows affected (for INSERT/UPDATE/DELETE)""" + + error: SessionFSError | None = None + """Describes a filesystem error.""" + + last_insert_rowid: int | None = None + """SQLite last_insert_rowid() value for INSERT.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteQueryResult': + assert isinstance(obj, dict) + columns = from_list(from_str, obj.get("columns")) + rows = from_list(lambda x: from_dict(lambda x: x, x), obj.get("rows")) + rows_affected = from_int(obj.get("rowsAffected")) + error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) + last_insert_rowid = from_union([from_int, from_none], obj.get("lastInsertRowid")) + return SessionFSSqliteQueryResult(columns, rows, rows_affected, error, last_insert_rowid) + + def to_dict(self) -> dict: + result: dict = {} + result["columns"] = from_list(from_str, self.columns) + result["rows"] = from_list(lambda x: from_dict(lambda x: x, x), self.rows) + result["rowsAffected"] = from_int(self.rows_affected) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + if self.last_insert_rowid is not None: + result["lastInsertRowid"] = from_union([from_int, from_none], self.last_insert_rowid) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSStatResult: + """Filesystem metadata for the requested path, or a filesystem error if the stat failed.""" + + birthtime: datetime + """ISO 8601 timestamp of creation""" + + is_directory: bool + """Whether the path is a directory""" + + is_file: bool + """Whether the path is a file""" + + mtime: datetime + """ISO 8601 timestamp of last modification""" + + size: int + """File size in bytes""" + + error: SessionFSError | None = None + """Describes a filesystem error.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSStatResult': + assert isinstance(obj, dict) + birthtime = from_datetime(obj.get("birthtime")) + is_directory = from_bool(obj.get("isDirectory")) + is_file = from_bool(obj.get("isFile")) + mtime = from_datetime(obj.get("mtime")) + size = from_int(obj.get("size")) + error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) + return SessionFSStatResult(birthtime, is_directory, is_file, mtime, size, error) + + def to_dict(self) -> dict: + result: dict = {} + result["birthtime"] = self.birthtime.isoformat() + result["isDirectory"] = from_bool(self.is_directory) + result["isFile"] = from_bool(self.is_file) + result["mtime"] = self.mtime.isoformat() + result["size"] = from_int(self.size) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteTransactionRequest: + """Statements to execute atomically. Providers apply busy handling for every call.""" + + session_id: str + """Target session identifier""" + + statements: list[SessionFSSqliteTransactionStatement] + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteTransactionRequest': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + statements = from_list(SessionFSSqliteTransactionStatement.from_dict, obj.get("statements")) + return SessionFSSqliteTransactionRequest(session_id, statements) + + def to_dict(self) -> dict: + result: dict = {} + result["sessionId"] = from_str(self.session_id) + result["statements"] = from_list(lambda x: to_class(SessionFSSqliteTransactionStatement, x), self.statements) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionOpenOptionsAdditionalContentExclusionPolicy: + """Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated + data, and scope. + """ + last_updated_at: Any + rules: list[SessionOpenOptionsAdditionalContentExclusionPolicyRule] + scope: AdditionalContentExclusionPolicyScope + """Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` + enumeration. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionOpenOptionsAdditionalContentExclusionPolicy': + assert isinstance(obj, dict) + last_updated_at = obj.get("last_updated_at") + rules = from_list(SessionOpenOptionsAdditionalContentExclusionPolicyRule.from_dict, obj.get("rules")) + scope = AdditionalContentExclusionPolicyScope(obj.get("scope")) + return SessionOpenOptionsAdditionalContentExclusionPolicy(last_updated_at, rules, scope) + + def to_dict(self) -> dict: + result: dict = {} + result["last_updated_at"] = self.last_updated_at + result["rules"] = from_list(lambda x: to_class(SessionOpenOptionsAdditionalContentExclusionPolicyRule, x), self.rules) + result["scope"] = to_enum(AdditionalContentExclusionPolicyScope, self.scope) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ShellOptions: + """Per-session settings for built-in shell tools.""" + + init_profile: ShellInitProfile | None = None + """Controls automatic non-interactive profile loading where supported. Explicit initScripts + are unaffected. + """ + init_scripts: list[ShellInitScript] | None = None + """Ordered host-provided script paths sourced before each built-in shell command when the + entry's shell target matches the active shell. Use these for rc files, environment setup + scripts, + or other custom scripts. A script that returns a nonzero status is reported, and later + scripts + and the user command continue while the shell remains running. Because scripts are + sourced into + the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating + behavior + can prevent continuation. Script standard output is preserved; Bash script stderr is + discarded, + PowerShell exception messages are replaced, and runtime-generated failure notices omit + configured script paths. When sandboxing is enabled, each script must already be readable + under + the active sandbox filesystem policy. Pass an empty array to clear the list. + """ + process_flags: list[str] | None = None + """Flags passed to the active built-in shell process on startup, replacing its default + flags. + When omitted, the built-in Bash shell uses `--norc --noprofile`, + and the built-in PowerShell shell uses `-NoProfile -NoLogo`. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ShellOptions': + assert isinstance(obj, dict) + init_profile = from_union([ShellInitProfile, from_none], obj.get("initProfile")) + init_scripts = from_union([lambda x: from_list(ShellInitScript.from_dict, x), from_none], obj.get("initScripts")) + process_flags = from_union([lambda x: from_list(from_str, x), from_none], obj.get("processFlags")) + return ShellOptions(init_profile, init_scripts, process_flags) + + def to_dict(self) -> dict: + result: dict = {} + if self.init_profile is not None: + result["initProfile"] = from_union([lambda x: to_enum(ShellInitProfile, x), from_none], self.init_profile) + if self.init_scripts is not None: + result["initScripts"] = from_union([lambda x: from_list(lambda x: to_class(ShellInitScript, x), x), from_none], self.init_scripts) + if self.process_flags is not None: + result["processFlags"] = from_union([lambda x: from_list(from_str, x), from_none], self.process_flags) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionSettingsSnapshot: + """Redacted, serializable view of session runtime settings for SDK boundary consumers. + Secrets and raw feature flags are intentionally excluded. + """ + job: SessionSettingsJobSnapshot + model: SessionSettingsModelSnapshot + online_evaluation: SessionSettingsOnlineEvaluationSnapshot + repo: SessionSettingsRepoSnapshot + validation: SessionSettingsValidationSnapshot + client_name: str | None = None + start_time_ms: float | None = None + timeout_ms: float | None = None + version: str | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionSettingsSnapshot': + assert isinstance(obj, dict) + job = SessionSettingsJobSnapshot.from_dict(obj.get("job")) + model = SessionSettingsModelSnapshot.from_dict(obj.get("model")) + online_evaluation = SessionSettingsOnlineEvaluationSnapshot.from_dict(obj.get("onlineEvaluation")) + repo = SessionSettingsRepoSnapshot.from_dict(obj.get("repo")) + validation = SessionSettingsValidationSnapshot.from_dict(obj.get("validation")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + start_time_ms = from_union([from_float, from_none], obj.get("startTimeMs")) + timeout_ms = from_union([from_float, from_none], obj.get("timeoutMs")) + version = from_union([from_str, from_none], obj.get("version")) + return SessionSettingsSnapshot(job, model, online_evaluation, repo, validation, client_name, start_time_ms, timeout_ms, version) + + def to_dict(self) -> dict: + result: dict = {} + result["job"] = to_class(SessionSettingsJobSnapshot, self.job) + result["model"] = to_class(SessionSettingsModelSnapshot, self.model) + result["onlineEvaluation"] = to_class(SessionSettingsOnlineEvaluationSnapshot, self.online_evaluation) + result["repo"] = to_class(SessionSettingsRepoSnapshot, self.repo) + result["validation"] = to_class(SessionSettingsValidationSnapshot, self.validation) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.start_time_ms is not None: + result["startTimeMs"] = from_union([to_float, from_none], self.start_time_ms) + if self.timeout_ms is not None: + result["timeoutMs"] = from_union([to_float, from_none], self.timeout_ms) + if self.version is not None: + result["version"] = from_union([from_str, from_none], self.version) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentGetCurrentResult: + """The currently selected custom agent, or null when using the default agent.""" + + agent: AgentInfo | None = None + """Currently selected custom agent, or null if using the default agent""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentGetCurrentResult': + assert isinstance(obj, dict) + agent = from_union([AgentInfo.from_dict, from_none], obj.get("agent")) + return AgentGetCurrentResult(agent) + + def to_dict(self) -> dict: + result: dict = {} + if self.agent is not None: + result["agent"] = from_union([lambda x: to_class(AgentInfo, x), from_none], self.agent) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentList: + """Agents available to the session.""" + + agents: list[AgentInfo] + """Available agents""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentList': + assert isinstance(obj, dict) + agents = from_list(AgentInfo.from_dict, obj.get("agents")) + return AgentList(agents) + + def to_dict(self) -> dict: + result: dict = {} + result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentReloadResult: + """Custom agents available to the session after reloading definitions from disk.""" + + agents: list[AgentInfo] + """Reloaded custom agents""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentReloadResult': + assert isinstance(obj, dict) + agents = from_list(AgentInfo.from_dict, obj.get("agents")) + return AgentReloadResult(agents) + + def to_dict(self) -> dict: + result: dict = {} + result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentSelectResult: + """The newly selected custom agent.""" + + agent: AgentInfo + """The newly selected custom agent""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentSelectResult': + assert isinstance(obj, dict) + agent = AgentInfo.from_dict(obj.get("agent")) + return AgentSelectResult(agent) + + def to_dict(self) -> dict: + result: dict = {} + result["agent"] = to_class(AgentInfo, self.agent) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ServerAgentList: + """Agents discovered across user, project, plugin, and remote sources.""" + + agents: list[AgentInfo] + """All discovered agents across all sources""" + + @staticmethod + def from_dict(obj: Any) -> 'ServerAgentList': + assert isinstance(obj, dict) + agents = from_list(AgentInfo.from_dict, obj.get("agents")) + return ServerAgentList(agents) + + def to_dict(self) -> dict: + result: dict = {} + result["agents"] = from_list(lambda x: to_class(AgentInfo, x), self.agents) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionAgentListRequest: + include_built_in_agents: bool | None = None + """When true, request the session's configured built-in agents alongside custom agents. + Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, + but does not evaluate transient invocation requirements such as model availability. + Built-in metadata may be omitted when the session cannot project it, such as a relay + session. + """ + include_prompt: bool | None = None + """When true, request authored base prompt text on each AgentInfo. Prompt text may be + omitted when unavailable, such as for agents projected through a relay session. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionAgentListRequest': + assert isinstance(obj, dict) + include_built_in_agents = from_union([from_bool, from_none], obj.get("includeBuiltInAgents")) + include_prompt = from_union([from_bool, from_none], obj.get("includePrompt")) + return SessionAgentListRequest(include_built_in_agents, include_prompt) + + def to_dict(self) -> dict: + result: dict = {} + if self.include_built_in_agents is not None: + result["includeBuiltInAgents"] = from_union([from_bool, from_none], self.include_built_in_agents) + if self.include_prompt is not None: + result["includePrompt"] = from_union([from_bool, from_none], self.include_prompt) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillsGetInvokedResult: + """Skills invoked during this session, ordered by invocation time (most recent last).""" + + skills: list[SkillsInvokedSkill] + """Skills invoked during this session, ordered by invocation time (most recent last)""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillsGetInvokedResult': + assert isinstance(obj, dict) + skills = from_list(SkillsInvokedSkill.from_dict, obj.get("skills")) + return SkillsGetInvokedResult(skills) + + def to_dict(self) -> dict: + result: dict = {} + result["skills"] = from_list(lambda x: to_class(SkillsInvokedSkill, x), self.skills) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SkillDiscoveryPathList: + """Canonical locations where skills can be created so the runtime will recognize them.""" + + paths: list[SkillDiscoveryPath] + """Canonical skill create/discovery directories, in priority order""" + + @staticmethod + def from_dict(obj: Any) -> 'SkillDiscoveryPathList': + assert isinstance(obj, dict) + paths = from_list(SkillDiscoveryPath.from_dict, obj.get("paths")) + return SkillDiscoveryPathList(paths) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(lambda x: to_class(SkillDiscoveryPath, x), self.paths) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TasksGetProgressResult: + """Progress information for the task, or null when no task with that ID is tracked.""" + + progress: TaskProgress | None = None + """Progress information for the task, discriminated by type. Returns null when no task with + this ID is currently tracked. + """ + + @staticmethod + def from_dict(obj: Any) -> 'TasksGetProgressResult': + assert isinstance(obj, dict) + progress = from_union([TaskProgress.from_dict, from_none], obj.get("progress")) + return TasksGetProgressResult(progress) + + def to_dict(self) -> dict: + result: dict = {} + if self.progress is not None: + result["progress"] = from_union([lambda x: to_class(TaskProgress, x), from_none], self.progress) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPTools: + """MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery + metadata. + """ + name: str + """Tool name.""" + + description: str | None = None + """Tool description, when provided.""" + + ui: MCPToolUI | None = None + """Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` + block was present without recognized fields. + """ + + @staticmethod + def from_dict(obj: Any) -> 'MCPTools': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + description = from_union([from_str, from_none], obj.get("description")) + ui = from_union([MCPToolUI.from_dict, from_none], obj.get("ui")) + return MCPTools(name, description, ui) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.ui is not None: + result["ui"] = from_union([lambda x: to_class(MCPToolUI, x), from_none], self.ui) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationArrayAnyOfField: + """Multi-select string field where each option pairs a value with a display label.""" + + items: UIElicitationArrayAnyOfFieldItems + """Schema applied to each item in the array.""" + + type: UIElicitationArrayAnyOfFieldType + """Type discriminator. Always "array".""" + + default: list[str] | None = None + """Default values selected when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + max_items: int | None = None + """Maximum number of items the user may select.""" + + min_items: int | None = None + """Minimum number of items the user must select.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfField': + assert isinstance(obj, dict) + items = UIElicitationArrayAnyOfFieldItems.from_dict(obj.get("items")) + type = UIElicitationArrayAnyOfFieldType(obj.get("type")) + default = from_union([lambda x: from_list(from_str, x), from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + max_items = from_union([from_int, from_none], obj.get("maxItems")) + min_items = from_union([from_int, from_none], obj.get("minItems")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationArrayAnyOfField(items, type, default, description, max_items, min_items, title) + + def to_dict(self) -> dict: + result: dict = {} + result["items"] = to_class(UIElicitationArrayAnyOfFieldItems, self.items) + result["type"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type) + if self.default is not None: + result["default"] = from_union([lambda x: from_list(from_str, x), from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.max_items is not None: + result["maxItems"] = from_union([from_int, from_none], self.max_items) + if self.min_items is not None: + result["minItems"] = from_union([from_int, from_none], self.min_items) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationArrayEnumField: + """Multi-select string field whose allowed values are defined inline.""" + + items: UIElicitationArrayEnumFieldItems + """Schema applied to each item in the array.""" + + type: UIElicitationArrayAnyOfFieldType + """Type discriminator. Always "array".""" + + default: list[str] | None = None + """Default values selected when the form is first shown.""" + + description: str | None = None + """Help text describing the field.""" + + max_items: int | None = None + """Maximum number of items the user may select.""" + + min_items: int | None = None + """Minimum number of items the user must select.""" + + title: str | None = None + """Human-readable label for the field.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationArrayEnumField': + assert isinstance(obj, dict) + items = UIElicitationArrayEnumFieldItems.from_dict(obj.get("items")) + type = UIElicitationArrayAnyOfFieldType(obj.get("type")) + default = from_union([lambda x: from_list(from_str, x), from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + max_items = from_union([from_int, from_none], obj.get("maxItems")) + min_items = from_union([from_int, from_none], obj.get("minItems")) + title = from_union([from_str, from_none], obj.get("title")) + return UIElicitationArrayEnumField(items, type, default, description, max_items, min_items, title) + + def to_dict(self) -> dict: + result: dict = {} + result["items"] = to_class(UIElicitationArrayEnumFieldItems, self.items) + result["type"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type) + if self.default is not None: + result["default"] = from_union([lambda x: from_list(from_str, x), from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.max_items is not None: + result["maxItems"] = from_union([from_int, from_none], self.max_items) + if self.min_items is not None: + result["minItems"] = from_union([from_int, from_none], self.min_items) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationSchemaProperty: + """Definition for a single elicitation form field. + + Single-select string field whose allowed values are defined inline. + + Single-select string field where each option pairs a value with a display label. + + Multi-select string field whose allowed values are defined inline. + + Multi-select string field where each option pairs a value with a display label. + + Boolean field rendered as a yes/no toggle. + + Free-text string field with optional length and format constraints. + + Numeric field accepting either a number or an integer. + """ + type: UIElicitationSchemaPropertyType + """Type discriminator. Always "string". + + Type discriminator. Always "array". + + Type discriminator. Always "boolean". + + Numeric type accepted by the field. + """ + default: float | bool | list[str] | str | None = None + """Default value selected when the form is first shown. + + Default values selected when the form is first shown. + + Default value populated in the input when the form is first shown. + """ + description: str | None = None + """Help text describing the field.""" + + enum: list[str] | None = None + """Allowed string values.""" + + enum_names: list[str] | None = None + """Optional display labels for each enum value, in the same order as `enum`.""" + + title: str | None = None + """Human-readable label for the field.""" + + one_of: list[UIElicitationStringOneOfFieldOneOf] | None = None + """Selectable options, each with a value and a display label.""" + + items: UIElicitationArrayFieldItems | None = None + """Schema applied to each item in the array.""" + + max_items: int | None = None + """Maximum number of items the user may select.""" + + min_items: int | None = None + """Minimum number of items the user must select.""" + + format: UIElicitationSchemaPropertyStringFormat | None = None + """Optional format hint that constrains the accepted input.""" + + max_length: int | None = None + """Maximum number of characters allowed.""" + + min_length: int | None = None + """Minimum number of characters required.""" + + maximum: float | None = None + """Maximum allowed value (inclusive).""" + + minimum: float | None = None + """Minimum allowed value (inclusive).""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationSchemaProperty': + assert isinstance(obj, dict) + type = UIElicitationSchemaPropertyType(obj.get("type")) + default = from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], obj.get("default")) + description = from_union([from_str, from_none], obj.get("description")) + enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enum")) + enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get("enumNames")) + title = from_union([from_str, from_none], obj.get("title")) + one_of = from_union([lambda x: from_list(UIElicitationStringOneOfFieldOneOf.from_dict, x), from_none], obj.get("oneOf")) + items = from_union([UIElicitationArrayFieldItems.from_dict, from_none], obj.get("items")) + max_items = from_union([from_int, from_none], obj.get("maxItems")) + min_items = from_union([from_int, from_none], obj.get("minItems")) + format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get("format")) + max_length = from_union([from_int, from_none], obj.get("maxLength")) + min_length = from_union([from_int, from_none], obj.get("minLength")) + maximum = from_union([from_float, from_none], obj.get("maximum")) + minimum = from_union([from_float, from_none], obj.get("minimum")) + return UIElicitationSchemaProperty(type, default, description, enum, enum_names, title, one_of, items, max_items, min_items, format, max_length, min_length, maximum, minimum) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = to_enum(UIElicitationSchemaPropertyType, self.type) + if self.default is not None: + result["default"] = from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], self.default) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.enum is not None: + result["enum"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum) + if self.enum_names is not None: + result["enumNames"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + if self.one_of is not None: + result["oneOf"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), x), from_none], self.one_of) + if self.items is not None: + result["items"] = from_union([lambda x: to_class(UIElicitationArrayFieldItems, x), from_none], self.items) + if self.max_items is not None: + result["maxItems"] = from_union([from_int, from_none], self.max_items) + if self.min_items is not None: + result["minItems"] = from_union([from_int, from_none], self.min_items) + if self.format is not None: + result["format"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format) + if self.max_length is not None: + result["maxLength"] = from_union([from_int, from_none], self.max_length) + if self.min_length is not None: + result["minLength"] = from_union([from_int, from_none], self.min_length) + if self.maximum is not None: + result["maximum"] = from_union([to_float, from_none], self.maximum) + if self.minimum is not None: + result["minimum"] = from_union([to_float, from_none], self.minimum) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingElicitationRequest: + """Pending elicitation request ID and the user's response (accept/decline/cancel + form + values). + """ + request_id: str + """The unique request ID from the elicitation.requested event""" + + result: UIElicitationResponse + """The elicitation response (accept with form values, decline, or cancel)""" + + @staticmethod + def from_dict(obj: Any) -> 'UIHandlePendingElicitationRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + result = UIElicitationResponse.from_dict(obj.get("result")) + return UIHandlePendingElicitationRequest(request_id, result) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["result"] = to_class(UIElicitationResponse, self.result) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingExitPlanModeRequest: + """Request ID of a pending `exit_plan_mode.requested` event and the user's response.""" + + request_id: str + """The unique request ID from the exit_plan_mode.requested event""" + + response: UIExitPlanModeResponse + """User response for a pending exit-plan-mode request, with approval state, selected action, + auto-approve flag, and feedback. + """ + + @staticmethod + def from_dict(obj: Any) -> 'UIHandlePendingExitPlanModeRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + response = UIExitPlanModeResponse.from_dict(obj.get("response")) + return UIHandlePendingExitPlanModeRequest(request_id, response) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["response"] = to_class(UIExitPlanModeResponse, self.response) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIHandlePendingSessionLimitsExhaustedRequest: + """Request ID of a pending `session_limits_exhausted.requested` event and the user's + selected limit action. + """ + request_id: str + """The unique request ID from the session_limits_exhausted.requested event""" + + response: UISessionLimitsExhaustedResponse + """The selected session-limit action.""" + + @staticmethod + def from_dict(obj: Any) -> 'UIHandlePendingSessionLimitsExhaustedRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + response = UISessionLimitsExhaustedResponse.from_dict(obj.get("response")) + return UIHandlePendingSessionLimitsExhaustedRequest(request_id, response) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["response"] = to_class(UISessionLimitsExhaustedResponse, self.response) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UsageGetMetricsResult: + """Accumulated session usage metrics, including premium request cost, token counts, model + breakdown, and code-change totals. + """ + code_changes: UsageMetricsCodeChanges + """Aggregated code change metrics""" + + last_call_input_tokens: int + """Input tokens from the most recent main-agent API call""" + + last_call_output_tokens: int + """Output tokens from the most recent main-agent API call""" + + model_metrics: dict[str, UsageMetricsModelMetric] + """Per-model token and request metrics, keyed by model identifier""" + + session_start_time: datetime + """ISO 8601 timestamp when the session started""" + + total_api_duration_ms: int + """Total time spent in model API calls (milliseconds)""" + + total_premium_request_cost: float + """Total user-initiated premium request cost across all models (may be fractional due to + multipliers) + """ + total_user_requests: int + """Raw count of user-initiated API requests""" + + current_model: str | None = None + """Currently active model identifier""" + + token_details: dict[str, UsageMetricsTokenDetail] | None = None + """Session-wide per-token-type accumulated token counts""" + + total_nano_aiu: float | None = None + """Session-wide accumulated nano-AI units cost""" + + @staticmethod + def from_dict(obj: Any) -> 'UsageGetMetricsResult': + assert isinstance(obj, dict) + code_changes = UsageMetricsCodeChanges.from_dict(obj.get("codeChanges")) + last_call_input_tokens = from_int(obj.get("lastCallInputTokens")) + last_call_output_tokens = from_int(obj.get("lastCallOutputTokens")) + model_metrics = from_dict(UsageMetricsModelMetric.from_dict, obj.get("modelMetrics")) + session_start_time = from_datetime(obj.get("sessionStartTime")) + total_api_duration_ms = from_int(obj.get("totalApiDurationMs")) + total_premium_request_cost = from_float(obj.get("totalPremiumRequestCost")) + total_user_requests = from_int(obj.get("totalUserRequests")) + current_model = from_union([from_str, from_none], obj.get("currentModel")) + token_details = from_union([lambda x: from_dict(UsageMetricsTokenDetail.from_dict, x), from_none], obj.get("tokenDetails")) + total_nano_aiu = from_union([from_float, from_none], obj.get("totalNanoAiu")) + 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) + + def to_dict(self) -> dict: + result: dict = {} + result["codeChanges"] = to_class(UsageMetricsCodeChanges, self.code_changes) + result["lastCallInputTokens"] = from_int(self.last_call_input_tokens) + result["lastCallOutputTokens"] = from_int(self.last_call_output_tokens) + result["modelMetrics"] = from_dict(lambda x: to_class(UsageMetricsModelMetric, x), self.model_metrics) + result["sessionStartTime"] = self.session_start_time.isoformat() + result["totalApiDurationMs"] = from_int(self.total_api_duration_ms) + result["totalPremiumRequestCost"] = to_float(self.total_premium_request_cost) + result["totalUserRequests"] = from_int(self.total_user_requests) + if self.current_model is not None: + result["currentModel"] = from_union([from_str, from_none], self.current_model) + if self.token_details is not None: + result["tokenDetails"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsTokenDetail, x), x), from_none], self.token_details) + if self.total_nano_aiu is not None: + result["totalNanoAiu"] = from_union([to_float, from_none], self.total_nano_aiu) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspaceDiffResult: + """Workspace diff result for the requested mode.""" + + changes: list[WorkspaceDiffFileChange] + """Changed files and their unified diffs.""" + + is_fallback: bool + """Whether the requested diff fell back to unstaged changes, either because branch diff + failed or session diff was unavailable. + """ + mode: WorkspaceDiffMode + """Effective mode used for the returned changes.""" + + requested_mode: WorkspaceDiffMode + """Diff mode requested by the client.""" + + base_branch: str | None = None + """Default branch used for a branch diff, when branch mode was requested.""" + + unavailable_reason: HistoryRewindUnavailableReason | None = None + """Why the session diff could not be produced, when applicable. Set only when `session` mode + was requested and `isFallback` is true, so a client can tell the permanent + `file-change-tracking-disabled` apart from the transient `session-busy`, which the same + request answers once the session settles. Never set for `unstaged` or `branch` mode, and + never `unsupported-remote-session`: a remote session's captures live on its own host, so + a `session`-mode diff is rejected for one rather than answered with a controller-side + fallback. + """ + + @staticmethod + def from_dict(obj: Any) -> 'WorkspaceDiffResult': + assert isinstance(obj, dict) + changes = from_list(WorkspaceDiffFileChange.from_dict, obj.get("changes")) + is_fallback = from_bool(obj.get("isFallback")) + mode = WorkspaceDiffMode(obj.get("mode")) + requested_mode = WorkspaceDiffMode(obj.get("requestedMode")) + base_branch = from_union([from_str, from_none], obj.get("baseBranch")) + unavailable_reason = from_union([HistoryRewindUnavailableReason, from_none], obj.get("unavailableReason")) + return WorkspaceDiffResult(changes, is_fallback, mode, requested_mode, base_branch, unavailable_reason) + + def to_dict(self) -> dict: + result: dict = {} + result["changes"] = from_list(lambda x: to_class(WorkspaceDiffFileChange, x), self.changes) + result["isFallback"] = from_bool(self.is_fallback) + result["mode"] = to_enum(WorkspaceDiffMode, self.mode) + result["requestedMode"] = to_enum(WorkspaceDiffMode, self.requested_mode) + if self.base_branch is not None: + result["baseBranch"] = from_union([from_str, from_none], self.base_branch) + if self.unavailable_reason is not None: + result["unavailableReason"] = from_union([lambda x: to_enum(HistoryRewindUnavailableReason, x), from_none], self.unavailable_reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CommandList: + """Slash commands available in the session, after applying any include/exclude filters.""" + + commands: list[SlashCommandInfo] + """Commands available in this session""" + + @staticmethod + def from_dict(obj: Any) -> 'CommandList': + assert isinstance(obj, dict) + commands = from_list(SlashCommandInfo.from_dict, obj.get("commands")) + return CommandList(commands) + + def to_dict(self) -> dict: + result: dict = {} + result["commands"] = from_list(lambda x: to_class(SlashCommandInfo, x), self.commands) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasProviderCloseRequest: + """Canvas close parameters sent to the provider.""" + + canvas_id: str + """Provider-local canvas identifier""" + + extension_id: str + """Owning provider identifier""" + + instance_id: str + """Canvas instance identifier""" + + session_id: str + """Target session identifier""" + + host: CanvasHostContext | None = None + """Host context supplied by the runtime.""" + + session: CanvasSessionContext | None = None + """Session context supplied by the runtime.""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasProviderCloseRequest': + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + session_id = from_str(obj.get("sessionId")) + host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) + session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) + return CanvasProviderCloseRequest(canvas_id, extension_id, instance_id, session_id, host, session) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + result["sessionId"] = from_str(self.session_id) + if self.host is not None: + result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) + if self.session is not None: + result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasProviderInvokeActionRequest: + """Canvas action invocation parameters sent to the provider.""" + + action_name: str + """Action name to invoke""" + + canvas_id: str + """Provider-local canvas identifier""" + + extension_id: str + """Owning provider identifier""" + + instance_id: str + """Canvas instance identifier""" + + session_id: str + """Target session identifier""" + + host: CanvasHostContext | None = None + """Host context supplied by the runtime.""" + + input: Any = None + """Action input""" + + session: CanvasSessionContext | None = None + """Session context supplied by the runtime.""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasProviderInvokeActionRequest': + assert isinstance(obj, dict) + action_name = from_str(obj.get("actionName")) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + session_id = from_str(obj.get("sessionId")) + host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) + input = obj.get("input") + session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) + return CanvasProviderInvokeActionRequest(action_name, canvas_id, extension_id, instance_id, session_id, host, input, session) + + def to_dict(self) -> dict: + result: dict = {} + result["actionName"] = from_str(self.action_name) + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + result["sessionId"] = from_str(self.session_id) + if self.host is not None: + result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) + if self.input is not None: + result["input"] = self.input + if self.session is not None: + result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasProviderOpenRequest: + """Canvas open parameters sent to the provider.""" + + canvas_id: str + """Provider-local canvas identifier""" + + extension_id: str + """Owning provider identifier""" + + instance_id: str + """Stable caller-supplied canvas instance identifier""" + + session_id: str + """Target session identifier""" + + host: CanvasHostContext | None = None + """Host context supplied by the runtime.""" + + input: Any = None + """Canvas open input""" + + session: CanvasSessionContext | None = None + """Session context supplied by the runtime.""" + + @staticmethod + def from_dict(obj: Any) -> 'CanvasProviderOpenRequest': + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + session_id = from_str(obj.get("sessionId")) + host = from_union([CanvasHostContext.from_dict, from_none], obj.get("host")) + input = obj.get("input") + session = from_union([CanvasSessionContext.from_dict, from_none], obj.get("session")) + return CanvasProviderOpenRequest(canvas_id, extension_id, instance_id, session_id, host, input, session) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + result["sessionId"] = from_str(self.session_id) + if self.host is not None: + result["host"] = from_union([lambda x: to_class(CanvasHostContext, x), from_none], self.host) + if self.input is not None: + result["input"] = self.input + if self.session is not None: + result["session"] = from_union([lambda x: to_class(CanvasSessionContext, x), from_none], self.session) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class HandlePendingToolCallRequest: + """Pending external tool call request ID, with the tool result or an error describing why it + failed. + """ + request_id: str + """Request ID of the pending tool call""" + + error: str | None = None + """Error message if the tool call failed""" + + result: ExternalToolTextResultForLlm | str | None = None + """Tool call result (string or expanded result object)""" + + @staticmethod + def from_dict(obj: Any) -> 'HandlePendingToolCallRequest': + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + error = from_union([from_str, from_none], obj.get("error")) + result = from_union([ExternalToolTextResultForLlm.from_dict, from_str, from_none], obj.get("result")) + return HandlePendingToolCallRequest(request_id, error, result) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + if self.error is not None: + result["error"] = from_union([from_str, from_none], self.error) + if self.result is not None: + result["result"] = from_union([lambda x: to_class(ExternalToolTextResultForLlm, x), from_str, from_none], self.result) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunSummary: + """Durable factory run summary with read-time live overlays.""" + + consumed: FactoryRunConsumed + created_at: int + declared_limits: FactoryDeclaredLimits + declared_phase_count: int + description: str + factory_name: str + live_agent_count: int + observed_at: int + revision: int + run_id: str + status: FactoryRunStatus + total_spawned_agent_count: int + updated_at: int + active_segment_started_at: int | None = None + approved: FactoryDeclaredLimits | None = None + completed_at: int | None = None + current_phase: FactoryCurrentPhase | None = None + started_at: int | None = None + terminal: FactoryRunTerminal | None = None + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunSummary': + assert isinstance(obj, dict) + consumed = FactoryRunConsumed.from_dict(obj.get("consumed")) + created_at = from_int(obj.get("createdAt")) + declared_limits = FactoryDeclaredLimits.from_dict(obj.get("declaredLimits")) + declared_phase_count = from_int(obj.get("declaredPhaseCount")) + description = from_str(obj.get("description")) + factory_name = from_str(obj.get("factoryName")) + live_agent_count = from_int(obj.get("liveAgentCount")) + observed_at = from_int(obj.get("observedAt")) + revision = from_int(obj.get("revision")) + run_id = from_str(obj.get("runId")) + status = FactoryRunStatus(obj.get("status")) + total_spawned_agent_count = from_int(obj.get("totalSpawnedAgentCount")) + updated_at = from_int(obj.get("updatedAt")) + active_segment_started_at = from_union([from_int, from_none], obj.get("activeSegmentStartedAt")) + approved = from_union([FactoryDeclaredLimits.from_dict, from_none], obj.get("approved")) + completed_at = from_union([from_int, from_none], obj.get("completedAt")) + current_phase = from_union([FactoryCurrentPhase.from_dict, from_none], obj.get("currentPhase")) + started_at = from_union([from_int, from_none], obj.get("startedAt")) + terminal = from_union([FactoryRunTerminal.from_dict, from_none], obj.get("terminal")) + return FactoryRunSummary(consumed, created_at, declared_limits, declared_phase_count, description, factory_name, live_agent_count, observed_at, revision, run_id, status, total_spawned_agent_count, updated_at, active_segment_started_at, approved, completed_at, current_phase, started_at, terminal) + + def to_dict(self) -> dict: + result: dict = {} + result["consumed"] = to_class(FactoryRunConsumed, self.consumed) + result["createdAt"] = from_int(self.created_at) + result["declaredLimits"] = to_class(FactoryDeclaredLimits, self.declared_limits) + result["declaredPhaseCount"] = from_int(self.declared_phase_count) + result["description"] = from_str(self.description) + result["factoryName"] = from_str(self.factory_name) + result["liveAgentCount"] = from_int(self.live_agent_count) + result["observedAt"] = from_int(self.observed_at) + result["revision"] = from_int(self.revision) + result["runId"] = from_str(self.run_id) + result["status"] = to_enum(FactoryRunStatus, self.status) + result["totalSpawnedAgentCount"] = from_int(self.total_spawned_agent_count) + result["updatedAt"] = from_int(self.updated_at) + result["activeSegmentStartedAt"] = from_union([from_int, from_none], self.active_segment_started_at) + result["approved"] = from_union([lambda x: to_class(FactoryDeclaredLimits, x), from_none], self.approved) + result["completedAt"] = from_union([from_int, from_none], self.completed_at) + result["currentPhase"] = from_union([lambda x: to_class(FactoryCurrentPhase, x), from_none], self.current_phase) + result["startedAt"] = from_union([from_int, from_none], self.started_at) + result["terminal"] = from_union([lambda x: to_class(FactoryRunTerminal, x), from_none], self.terminal) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryResumeResult: + """Resolved persisted factory identity and resumed run envelope.""" + + factory_name: str + """Persisted factory name resolved for the resumed run.""" + + run: FactoryRunResult + """Terminal resumed run envelope.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryResumeResult': + assert isinstance(obj, dict) + factory_name = from_str(obj.get("factoryName")) + run = FactoryRunResult.from_dict(obj.get("run")) + return FactoryResumeResult(factory_name, run) + + def to_dict(self) -> dict: + result: dict = {} + result["factoryName"] = from_str(self.factory_name) + result["run"] = to_class(FactoryRunResult, self.run) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunDetail: + """Full factory run observability detail.""" + + agents: list[FactoryAgentSummary] + consumed: FactoryRunConsumed + created_at: int + declared_limits: FactoryDeclaredLimits + declared_phase_count: int + description: str + factory_name: str + live_agent_count: int + observed_at: int + phases: list[FactoryPhaseObservation] + progress: FactoryProgressPage + revision: int + run_id: str + status: FactoryRunStatus + total_spawned_agent_count: int + updated_at: int + active_segment_started_at: int | None = None + approved: FactoryDeclaredLimits | None = None + completed_at: int | None = None + current_phase: FactoryCurrentPhase | None = None + started_at: int | None = None + terminal: FactoryRunTerminal | None = None + + @staticmethod + def from_dict(obj: Any) -> 'FactoryRunDetail': + assert isinstance(obj, dict) + agents = from_list(FactoryAgentSummary.from_dict, obj.get("agents")) + consumed = FactoryRunConsumed.from_dict(obj.get("consumed")) + created_at = from_int(obj.get("createdAt")) + declared_limits = FactoryDeclaredLimits.from_dict(obj.get("declaredLimits")) + declared_phase_count = from_int(obj.get("declaredPhaseCount")) + description = from_str(obj.get("description")) + factory_name = from_str(obj.get("factoryName")) + live_agent_count = from_int(obj.get("liveAgentCount")) + observed_at = from_int(obj.get("observedAt")) + phases = from_list(FactoryPhaseObservation.from_dict, obj.get("phases")) + progress = FactoryProgressPage.from_dict(obj.get("progress")) + revision = from_int(obj.get("revision")) + run_id = from_str(obj.get("runId")) + status = FactoryRunStatus(obj.get("status")) + total_spawned_agent_count = from_int(obj.get("totalSpawnedAgentCount")) + updated_at = from_int(obj.get("updatedAt")) + active_segment_started_at = from_union([from_int, from_none], obj.get("activeSegmentStartedAt")) + approved = from_union([FactoryDeclaredLimits.from_dict, from_none], obj.get("approved")) + completed_at = from_union([from_int, from_none], obj.get("completedAt")) + current_phase = from_union([FactoryCurrentPhase.from_dict, from_none], obj.get("currentPhase")) + started_at = from_union([from_int, from_none], obj.get("startedAt")) + terminal = from_union([FactoryRunTerminal.from_dict, from_none], obj.get("terminal")) + return FactoryRunDetail(agents, consumed, created_at, declared_limits, declared_phase_count, description, factory_name, live_agent_count, observed_at, phases, progress, revision, run_id, status, total_spawned_agent_count, updated_at, active_segment_started_at, approved, completed_at, current_phase, started_at, terminal) + + def to_dict(self) -> dict: + result: dict = {} + result["agents"] = from_list(lambda x: to_class(FactoryAgentSummary, x), self.agents) + result["consumed"] = to_class(FactoryRunConsumed, self.consumed) + result["createdAt"] = from_int(self.created_at) + result["declaredLimits"] = to_class(FactoryDeclaredLimits, self.declared_limits) + result["declaredPhaseCount"] = from_int(self.declared_phase_count) + result["description"] = from_str(self.description) + result["factoryName"] = from_str(self.factory_name) + result["liveAgentCount"] = from_int(self.live_agent_count) + result["observedAt"] = from_int(self.observed_at) + result["phases"] = from_list(lambda x: to_class(FactoryPhaseObservation, x), self.phases) + result["progress"] = to_class(FactoryProgressPage, self.progress) + result["revision"] = from_int(self.revision) + result["runId"] = from_str(self.run_id) + result["status"] = to_enum(FactoryRunStatus, self.status) + result["totalSpawnedAgentCount"] = from_int(self.total_spawned_agent_count) + result["updatedAt"] = from_int(self.updated_at) + result["activeSegmentStartedAt"] = from_union([from_int, from_none], self.active_segment_started_at) + result["approved"] = from_union([lambda x: to_class(FactoryDeclaredLimits, x), from_none], self.approved) + result["completedAt"] = from_union([from_int, from_none], self.completed_at) + result["currentPhase"] = from_union([lambda x: to_class(FactoryCurrentPhase, x), from_none], self.current_phase) + result["startedAt"] = from_union([from_int, from_none], self.started_at) + result["terminal"] = from_union([lambda x: to_class(FactoryRunTerminal, x), from_none], self.terminal) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsSetAdditionalPluginsRequest: + """Manager-wide additional plugins to register; replaces any previously-configured set.""" + + plugins: list[InstalledPlugin] + """Manager-wide additional plugins to register. Replaces any previously-configured set. Pass + an empty array to clear. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionsSetAdditionalPluginsRequest': + assert isinstance(obj, dict) + plugins = from_list(InstalledPlugin.from_dict, obj.get("plugins")) + return SessionsSetAdditionalPluginsRequest(plugins) + + def to_dict(self) -> dict: + result: dict = {} + result["plugins"] = from_list(lambda x: to_class(InstalledPlugin, x), self.plugins) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionEnrichMetadataResult: + """The enriched metadata records, with summary and context fields backfilled where + available. Sessions confirmed empty and unnamed are omitted. + """ + sessions: list[LocalSessionMetadataValue] + """Enriched records, with summary and context backfilled. Sessions confirmed empty and + unnamed may be omitted. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionEnrichMetadataResult': + assert isinstance(obj, dict) + sessions = from_list(LocalSessionMetadataValue.from_dict, obj.get("sessions")) + return SessionEnrichMetadataResult(sessions) + + def to_dict(self) -> dict: + result: dict = {} + result["sessions"] = from_list(lambda x: to_class(LocalSessionMetadataValue, x), self.sessions) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsEnrichMetadataRequest: + """Session metadata records to enrich with summary and context information.""" + + sessions: list[LocalSessionMetadataValue] + """Session metadata records to enrich. Records that already have summary and context are + returned unchanged. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionsEnrichMetadataRequest': + assert isinstance(obj, dict) + sessions = from_list(LocalSessionMetadataValue.from_dict, obj.get("sessions")) + return SessionsEnrichMetadataRequest(sessions) + + def to_dict(self) -> dict: + result: dict = {} + result["sessions"] = from_list(lambda x: to_class(LocalSessionMetadataValue, x), self.sessions) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsGetMetadataResult: + """Persisted local session metadata when the session exists.""" + + session: LocalSessionMetadataValue | None = None + """Local session metadata, omitted when the session does not exist.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsGetMetadataResult': + assert isinstance(obj, dict) + session = from_union([LocalSessionMetadataValue.from_dict, from_none], obj.get("session")) + return SessionsGetMetadataResult(session) + + def to_dict(self) -> dict: + result: dict = {} + if self.session is not None: + result["session"] = from_union([lambda x: to_class(LocalSessionMetadataValue, x), from_none], self.session) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionOpenResult: + """Result of opening a session.""" + + status: SessionsOpenStatus + """Outcome of the open request.""" + + metadata: RemoteSessionMetadataValue | None = None + """Remote session metadata, present when status is `connected`.""" + + progress: list[SessionsOpenProgress] | None = None + """Handoff progress steps, present when status is `handed_off`.""" + + remote_session_id: str | None = None + """Remote session ID, present when status is `connected`.""" + + # Internal: this field is an internal SDK API and is not part of the public surface. + session_api: Any = None + """In-process SessionClientApi handle for the opened session, returned to CLI callers as a + transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK + consumers should construct per-session clients from `sessionId` instead. + """ + session_id: str | None = None + """Opened session ID. Omitted when status is `not_found`.""" + + startup_prompts: list[str] | None = None + """Startup prompts queued by user-level hook configs at session creation. Only populated + when status is `created`; resumed sessions return an empty array. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionOpenResult': + assert isinstance(obj, dict) + status = SessionsOpenStatus(obj.get("status")) + metadata = from_union([RemoteSessionMetadataValue.from_dict, from_none], obj.get("metadata")) + progress = from_union([lambda x: from_list(SessionsOpenProgress.from_dict, x), from_none], obj.get("progress")) + remote_session_id = from_union([from_str, from_none], obj.get("remoteSessionId")) + session_api = obj.get("sessionApi") + session_id = from_union([from_str, from_none], obj.get("sessionId")) + startup_prompts = from_union([lambda x: from_list(from_str, x), from_none], obj.get("startupPrompts")) + return SessionOpenResult(status, metadata, progress, remote_session_id, session_api, session_id, startup_prompts) + + def to_dict(self) -> dict: + result: dict = {} + result["status"] = to_enum(SessionsOpenStatus, self.status) + if self.metadata is not None: + result["metadata"] = from_union([lambda x: to_class(RemoteSessionMetadataValue, x), from_none], self.metadata) + if self.progress is not None: + result["progress"] = from_union([lambda x: from_list(lambda x: to_class(SessionsOpenProgress, x), x), from_none], self.progress) + if self.remote_session_id is not None: + result["remoteSessionId"] = from_union([from_str, from_none], self.remote_session_id) + if self.session_api is not None: + result["sessionApi"] = self.session_api + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) + if self.startup_prompts is not None: + result["startupPrompts"] = from_union([lambda x: from_list(from_str, x), from_none], self.startup_prompts) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionMetadataSnapshot: + """Point-in-time snapshot of slow-changing session identifier and state fields""" + + already_in_use: bool + """True when the session was detected to be in use by another process at construction time. + Local consumers may surface a confirmation prompt before fully attaching. Always false + for new sessions. + """ + current_mode: MetadataSnapshotCurrentMode + """The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')""" + + is_remote: bool + """Whether this is a remote session (i.e., one whose runtime executes elsewhere and is + steered through this process) + """ + modified_time: datetime + """ISO 8601 timestamp of when the session's persisted state was last modified on disk. For + new sessions, equals startTime. For resumed sessions, reflects the previous modification + time at construction. + """ + session_id: str + """The unique identifier of the session""" + + start_time: datetime + """ISO 8601 timestamp of when the session started""" + + working_directory: str + """Absolute path to the session's current working directory""" + + client_name: str | None = None + """Runtime client name associated with the session (telemetry identifier).""" + + initial_name: str | None = None + """User-provided name supplied at session construction (via `--name`), if any. Immutable + after construction. + """ + remote_metadata: MetadataSnapshotRemoteMetadata | None = None + """Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are + immutable for the lifetime of the session. + """ + selected_model: str | None = None + """Currently selected model identifier, if any""" + + session_limits: SessionLimitsConfig | None = None + """Current session limits, or null when no limits are active""" + + summary: str | None = None + """Short human-readable summary of the session, if known. Omitted when no summary has been + generated. + """ + workspace: WorkspaceSummary | None = None + """Public-facing workspace metadata for this session, or null if the session has no + associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, + internal flags). + """ + workspace_path: str | None = None + """Absolute path to the session's workspace directory on disk, or null if the session has no + associated workspace + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionMetadataSnapshot': + assert isinstance(obj, dict) + already_in_use = from_bool(obj.get("alreadyInUse")) + current_mode = MetadataSnapshotCurrentMode(obj.get("currentMode")) + is_remote = from_bool(obj.get("isRemote")) + modified_time = from_datetime(obj.get("modifiedTime")) + session_id = from_str(obj.get("sessionId")) + start_time = from_datetime(obj.get("startTime")) + working_directory = from_str(obj.get("workingDirectory")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + initial_name = from_union([from_str, from_none], obj.get("initialName")) + remote_metadata = from_union([MetadataSnapshotRemoteMetadata.from_dict, from_none], obj.get("remoteMetadata")) + selected_model = from_union([from_str, from_none], obj.get("selectedModel")) + session_limits = from_union([SessionLimitsConfig.from_dict, from_none], obj.get("sessionLimits")) + summary = from_union([from_str, from_none], obj.get("summary")) + workspace = from_union([WorkspaceSummary.from_dict, from_none], obj.get("workspace")) + workspace_path = from_union([from_none, from_str], obj.get("workspacePath")) + return SessionMetadataSnapshot(already_in_use, current_mode, is_remote, modified_time, session_id, start_time, working_directory, client_name, initial_name, remote_metadata, selected_model, session_limits, summary, workspace, workspace_path) + + def to_dict(self) -> dict: + result: dict = {} + result["alreadyInUse"] = from_bool(self.already_in_use) + result["currentMode"] = to_enum(MetadataSnapshotCurrentMode, self.current_mode) + result["isRemote"] = from_bool(self.is_remote) + result["modifiedTime"] = self.modified_time.isoformat() + result["sessionId"] = from_str(self.session_id) + result["startTime"] = self.start_time.isoformat() + result["workingDirectory"] = from_str(self.working_directory) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.initial_name is not None: + result["initialName"] = from_union([from_str, from_none], self.initial_name) + if self.remote_metadata is not None: + result["remoteMetadata"] = from_union([lambda x: to_class(MetadataSnapshotRemoteMetadata, x), from_none], self.remote_metadata) + if self.selected_model is not None: + result["selectedModel"] = from_union([from_str, from_none], self.selected_model) + result["sessionLimits"] = from_union([lambda x: to_class(SessionLimitsConfig, x), from_none], self.session_limits) + if self.summary is not None: + result["summary"] = from_union([from_str, from_none], self.summary) + if self.workspace is not None: + result["workspace"] = from_union([lambda x: to_class(WorkspaceSummary, x), from_none], self.workspace) + result["workspacePath"] = from_union([from_none, from_str], self.workspace_path) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class WorkspacesListCheckpointsResult: + """Workspace checkpoints in chronological order; empty when the workspace is not enabled.""" + + checkpoints: list[WorkspacesCheckpoints] + """Workspace checkpoints in chronological order. Empty when workspace is not enabled.""" + + @staticmethod + def from_dict(obj: Any) -> 'WorkspacesListCheckpointsResult': + assert isinstance(obj, dict) + checkpoints = from_list(WorkspacesCheckpoints.from_dict, obj.get("checkpoints")) + return WorkspacesListCheckpointsResult(checkpoints) + + def to_dict(self) -> dict: + result: dict = {} + result["checkpoints"] = from_list(lambda x: to_class(WorkspacesCheckpoints, x), self.checkpoints) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class DebugCollectLogsRequest: + """Options for collecting a redacted session debug bundle.""" + + destination: DebugCollectLogsDestination + """Where the redacted bundle should be written. Use `archive` to produce a .tgz, or + `directory` to stage redacted files for caller-managed upload/post-processing. + """ + additional_entries: list[DebugCollectLogsEntry] | None = None + """Caller-provided server-local files or directories to include in addition to the runtime's + built-in session diagnostics. This lets host applications add their own diagnostics + without changing the API shape. + """ + include: DebugCollectLogsInclude | None = None + """Which built-in session diagnostics to include. Omitted fields default to true.""" + + @staticmethod + def from_dict(obj: Any) -> 'DebugCollectLogsRequest': + assert isinstance(obj, dict) + destination = DebugCollectLogsDestination.from_dict(obj.get("destination")) + additional_entries = from_union([lambda x: from_list(DebugCollectLogsEntry.from_dict, x), from_none], obj.get("additionalEntries")) + include = from_union([DebugCollectLogsInclude.from_dict, from_none], obj.get("include")) + return DebugCollectLogsRequest(destination, additional_entries, include) + + def to_dict(self) -> dict: + result: dict = {} + result["destination"] = to_class(DebugCollectLogsDestination, self.destination) + if self.additional_entries is not None: + result["additionalEntries"] = from_union([lambda x: from_list(lambda x: to_class(DebugCollectLogsEntry, x), x), from_none], self.additional_entries) + if self.include is not None: + result["include"] = from_union([lambda x: to_class(DebugCollectLogsInclude, x), from_none], self.include) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class InstructionDiscoveryPathList: + """Canonical files and directories where custom instructions can be created so the runtime + will recognize them. + """ + paths: list[InstructionDiscoveryPath] + """Canonical instruction create/discovery files and directories, in priority order""" + + @staticmethod + def from_dict(obj: Any) -> 'InstructionDiscoveryPathList': + assert isinstance(obj, dict) + paths = from_list(InstructionDiscoveryPath.from_dict, obj.get("paths")) + return InstructionDiscoveryPathList(paths) + + def to_dict(self) -> dict: + result: dict = {} + result["paths"] = from_list(lambda x: to_class(InstructionDiscoveryPath, x), self.paths) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSReaddirWithTypesResult: + """Entries in the requested directory paired with file/directory type information, or a + filesystem error if the read failed. + """ + entries: list[SessionFSReaddirWithTypesEntry] + """Directory entries with type information""" + + error: SessionFSError | None = None + """Describes a filesystem error.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesResult': + assert isinstance(obj, dict) + entries = from_list(SessionFSReaddirWithTypesEntry.from_dict, obj.get("entries")) + error = from_union([SessionFSError.from_dict, from_none], obj.get("error")) + return SessionFSReaddirWithTypesResult(entries, error) + + def to_dict(self) -> dict: + result: dict = {} + result["entries"] = from_list(lambda x: to_class(SessionFSReaddirWithTypesEntry, x), self.entries) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ProviderModelConfig: + """A BYOK model definition referencing a named provider.""" + + id: str + """Provider-local model id, unique within its provider. The session-wide selection id (shown + in the model list and passed to switchTo) is the provider-qualified `provider/id`. + """ + provider: str + """Name of the NamedProviderConfig that serves this model.""" + + capabilities: ModelCapabilitiesOverride | None = None + """Optional capability overrides (vision, tool_calls, reasoning, etc.).""" + + max_context_window_tokens: float | None = None + """Maximum context window tokens for the model.""" + + max_output_tokens: float | None = None + """Maximum output tokens for the model.""" + + max_prompt_tokens: float | None = None + """Maximum prompt/input tokens for the model.""" + + model_id: str | None = None + """Well-known base model id used for behavior/capability/config lookup. Defaults to `id`.""" + + name: str | None = None + """Display name for model pickers. Defaults to the provider-qualified selection id + (`provider/id`). + """ + wire_model: str | None = None + """The model name sent to the provider API for inference. Defaults to `id`.""" + + @staticmethod + def from_dict(obj: Any) -> 'ProviderModelConfig': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + provider = from_str(obj.get("provider")) + capabilities = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get("capabilities")) + max_context_window_tokens = from_union([from_float, from_none], obj.get("maxContextWindowTokens")) + max_output_tokens = from_union([from_float, from_none], obj.get("maxOutputTokens")) + max_prompt_tokens = from_union([from_float, from_none], obj.get("maxPromptTokens")) + model_id = from_union([from_str, from_none], obj.get("modelId")) + name = from_union([from_str, from_none], obj.get("name")) + wire_model = from_union([from_str, from_none], obj.get("wireModel")) + return ProviderModelConfig(id, provider, capabilities, max_context_window_tokens, max_output_tokens, max_prompt_tokens, model_id, name, wire_model) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + result["provider"] = from_str(self.provider) + if self.capabilities is not None: + result["capabilities"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.capabilities) + if self.max_context_window_tokens is not None: + result["maxContextWindowTokens"] = from_union([to_float, from_none], self.max_context_window_tokens) + if self.max_output_tokens is not None: + result["maxOutputTokens"] = from_union([to_float, from_none], self.max_output_tokens) + if self.max_prompt_tokens is not None: + result["maxPromptTokens"] = from_union([to_float, from_none], self.max_prompt_tokens) + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.wire_model is not None: + result["wireModel"] = from_union([from_str, from_none], self.wire_model) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsConfigureParams: + """Patch of permission policy fields to apply (omit a field to leave it unchanged).""" + + additional_content_exclusion_policies: list[PermissionsConfigureAdditionalContentExclusionPolicy] | None = None + """If specified, replaces the host-supplied GitHub Content Exclusion policies on the session + (combined with natively-discovered policies when evaluating tool/file access). Omit to + leave the current policies unchanged. + """ + approve_all_read_permission_requests: bool | None = None + """If specified, sets whether path/URL read permission requests are auto-approved. Omit to + leave the current value unchanged. + """ + approve_all_tool_permission_requests: bool | None = None + """If specified, sets whether tool permission requests are auto-approved without prompting. + Omit to leave the current value unchanged. + """ + paths: PermissionPathsConfig | None = None + """If specified, replaces the session's path-permission policy. The runtime constructs the + appropriate PathManager based on these inputs (rooted at the session's working + directory). Omit to leave the current path policy unchanged. + """ + rules: PermissionRulesSet | None = None + """If specified, replaces the session's approved/denied permission rules. Omit to leave the + current rules unchanged. + """ + urls: PermissionUrlsConfig | None = None + """If specified, replaces the session's URL-permission policy. The runtime constructs a + fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy + unchanged. + """ + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsConfigureParams': + assert isinstance(obj, dict) + additional_content_exclusion_policies = from_union([lambda x: from_list(PermissionsConfigureAdditionalContentExclusionPolicy.from_dict, x), from_none], obj.get("additionalContentExclusionPolicies")) + approve_all_read_permission_requests = from_union([from_bool, from_none], obj.get("approveAllReadPermissionRequests")) + approve_all_tool_permission_requests = from_union([from_bool, from_none], obj.get("approveAllToolPermissionRequests")) + paths = from_union([PermissionPathsConfig.from_dict, from_none], obj.get("paths")) + rules = from_union([PermissionRulesSet.from_dict, from_none], obj.get("rules")) + urls = from_union([PermissionUrlsConfig.from_dict, from_none], obj.get("urls")) + return PermissionsConfigureParams(additional_content_exclusion_policies, approve_all_read_permission_requests, approve_all_tool_permission_requests, paths, rules, urls) + + def to_dict(self) -> dict: + result: dict = {} + if self.additional_content_exclusion_policies is not None: + result["additionalContentExclusionPolicies"] = from_union([lambda x: from_list(lambda x: to_class(PermissionsConfigureAdditionalContentExclusionPolicy, x), x), from_none], self.additional_content_exclusion_policies) + if self.approve_all_read_permission_requests is not None: + result["approveAllReadPermissionRequests"] = from_union([from_bool, from_none], self.approve_all_read_permission_requests) + if self.approve_all_tool_permission_requests is not None: + result["approveAllToolPermissionRequests"] = from_union([from_bool, from_none], self.approve_all_tool_permission_requests) + if self.paths is not None: + result["paths"] = from_union([lambda x: to_class(PermissionPathsConfig, x), from_none], self.paths) + if self.rules is not None: + result["rules"] = from_union([lambda x: to_class(PermissionRulesSet, x), from_none], self.rules) + if self.urls is not None: + result["urls"] = from_union([lambda x: to_class(PermissionUrlsConfig, x), from_none], self.urls) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SandboxConfig: + """Resolved sandbox configuration.""" + + enabled: bool + """Whether sandboxing is enabled for the session.""" + + add_current_working_directory: bool | None = None + """Whether to auto-add the current working directory to readwritePaths. Default: true.""" + + allow_dev_tool_access: bool | None = None + """Whether to auto-grant read access to common developer-tool caches, registries, and + toolchains in their default home locations (cargo, go, npm, Maven, and more), plus + read-write access to (and, on Unix, up-front creation of) the scratch caches builds write + on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so + builds work without extra configuration; a relocated CARGO_HOME additionally gets its + Cargo lock files granted read-write. Default: true (enabled by default; set to false to + opt out). + """ + auth: SandboxConfigAuth | None = None + """Credential-injection capability flags.""" + + user_policy: SandboxConfigUserPolicy | None = None + """User-managed sandbox policy fragment merged into the auto-discovered base policy.""" + + @staticmethod + def from_dict(obj: Any) -> 'SandboxConfig': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + add_current_working_directory = from_union([from_bool, from_none], obj.get("addCurrentWorkingDirectory")) + allow_dev_tool_access = from_union([from_bool, from_none], obj.get("allowDevToolAccess")) + auth = from_union([SandboxConfigAuth.from_dict, from_none], obj.get("auth")) + user_policy = from_union([SandboxConfigUserPolicy.from_dict, from_none], obj.get("userPolicy")) + return SandboxConfig(enabled, add_current_working_directory, allow_dev_tool_access, auth, user_policy) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + if self.add_current_working_directory is not None: + result["addCurrentWorkingDirectory"] = from_union([from_bool, from_none], self.add_current_working_directory) + if self.allow_dev_tool_access is not None: + result["allowDevToolAccess"] = from_union([from_bool, from_none], self.allow_dev_tool_access) + if self.auth is not None: + result["auth"] = from_union([lambda x: to_class(SandboxConfigAuth, x), from_none], self.auth) + if self.user_policy is not None: + result["userPolicy"] = from_union([lambda x: to_class(SandboxConfigUserPolicy, x), from_none], self.user_policy) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionFSSqliteTransactionResult: + """Per-statement results, or a classified transaction error.""" + + results: list[SessionFSSqliteQueryResult] + error: SessionFSSqliteTransactionError | None = None + + @staticmethod + def from_dict(obj: Any) -> 'SessionFSSqliteTransactionResult': + assert isinstance(obj, dict) + results = from_list(SessionFSSqliteQueryResult.from_dict, obj.get("results")) + error = from_union([SessionFSSqliteTransactionError.from_dict, from_none], obj.get("error")) + return SessionFSSqliteTransactionResult(results, error) + + def to_dict(self) -> dict: + result: dict = {} + result["results"] = from_list(lambda x: to_class(SessionFSSqliteQueryResult, x), self.results) + if self.error is not None: + result["error"] = from_union([lambda x: to_class(SessionFSSqliteTransactionError, x), from_none], self.error) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPListToolsResult: + """Tools exposed by the connected MCP server. Throws when the server is not connected.""" + + tools: list[MCPTools] + """Tools exposed by the server.""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPListToolsResult': + assert isinstance(obj, dict) + tools = from_list(MCPTools.from_dict, obj.get("tools")) + return MCPListToolsResult(tools) + + def to_dict(self) -> dict: + result: dict = {} + result["tools"] = from_list(lambda x: to_class(MCPTools, x), self.tools) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationSchema: + """JSON Schema describing the form fields to present to the user""" + + properties: dict[str, UIElicitationSchemaProperty] + """Form field definitions, keyed by field name""" + + type: UIElicitationSchemaType + """Schema type indicator (always 'object')""" + + required: list[str] | None = None + """List of required field names""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationSchema': + assert isinstance(obj, dict) + properties = from_dict(UIElicitationSchemaProperty.from_dict, obj.get("properties")) + type = UIElicitationSchemaType(obj.get("type")) + required = from_union([lambda x: from_list(from_str, x), from_none], obj.get("required")) + return UIElicitationSchema(properties, type, required) + + def to_dict(self) -> dict: + result: dict = {} + result["properties"] = from_dict(lambda x: to_class(UIElicitationSchemaProperty, x), self.properties) + result["type"] = to_enum(UIElicitationSchemaType, self.type) + if self.required is not None: + result["required"] = from_union([lambda x: from_list(from_str, x), from_none], self.required) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryListRunsResult: + """A page of factory runs in durable creation order.""" + + runs: list[FactoryRunSummary] + has_more_newer: bool | None = None + """Whether terminal runs newer than this page exist.""" + + newest_seq: int | None = None + """Newest terminal-run cursor in this page, or null when the terminal window is empty.""" + + oldest_seq: int | None = None + """Oldest terminal-run cursor in this page, or null when the terminal window is empty.""" + + omitted_older: int | None = None + """Number of terminal runs older than this page.""" + + @staticmethod + def from_dict(obj: Any) -> 'FactoryListRunsResult': + assert isinstance(obj, dict) + runs = from_list(FactoryRunSummary.from_dict, obj.get("runs")) + has_more_newer = from_union([from_bool, from_none], obj.get("hasMoreNewer")) + newest_seq = from_union([from_int, from_none], obj.get("newestSeq")) + oldest_seq = from_union([from_int, from_none], obj.get("oldestSeq")) + omitted_older = from_union([from_int, from_none], obj.get("omittedOlder")) + return FactoryListRunsResult(runs, has_more_newer, newest_seq, oldest_seq, omitted_older) + + def to_dict(self) -> dict: + result: dict = {} + result["runs"] = from_list(lambda x: to_class(FactoryRunSummary, x), self.runs) + if self.has_more_newer is not None: + result["hasMoreNewer"] = from_union([from_bool, from_none], self.has_more_newer) + if self.newest_seq is not None: + result["newestSeq"] = from_union([from_int, from_none], self.newest_seq) + if self.oldest_seq is not None: + result["oldestSeq"] = from_union([from_int, from_none], self.oldest_seq) + if self.omitted_older is not None: + result["omittedOlder"] = from_union([from_int, from_none], self.omitted_older) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class BuiltInModelCatalogEntry: + """A well-known model in the runtime's built-in catalog.""" + + id: str + """Well-known runtime model ID suitable for `ProviderConfig.modelId` or + `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or + model name and does not indicate CAPI entitlement or provider availability. + """ + + @staticmethod + def from_dict(obj: Any) -> 'BuiltInModelCatalogEntry': + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + return BuiltInModelCatalogEntry(id) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class ProviderAddRequest: + """BYOK providers and/or models to add to the session's registry at runtime. Both fields are + optional; provide providers, models, or both. + """ + models: list[ProviderModelConfig] | None = None + """BYOK model definitions to register. Each must reference a provider that is already + registered or included in this same call. Selection ids (`provider/id`) must be unique + across the registry. + """ + providers: list[NamedProviderConfig] | None = None + """Named BYOK provider connections to register, additive to any providers already in the + registry. Each name must be unique across the registry and must not contain '/'. + """ + + @staticmethod + def from_dict(obj: Any) -> 'ProviderAddRequest': + assert isinstance(obj, dict) + models = from_union([lambda x: from_list(ProviderModelConfig.from_dict, x), from_none], obj.get("models")) + providers = from_union([lambda x: from_list(NamedProviderConfig.from_dict, x), from_none], obj.get("providers")) + return ProviderAddRequest(models, providers) + + def to_dict(self) -> dict: + result: dict = {} + if self.models is not None: + result["models"] = from_union([lambda x: from_list(lambda x: to_class(ProviderModelConfig, x), x), from_none], self.models) + if self.providers is not None: + result["providers"] = from_union([lambda x: from_list(lambda x: to_class(NamedProviderConfig, x), x), from_none], self.providers) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionOpenOptions: + """Session construction options. + + Session resume options. + + Session options for the connection. + + Session options for cloud session creation. + + Session construction options for the new local session. + """ + additional_content_exclusion_policies: list[SessionOpenOptionsAdditionalContentExclusionPolicy] | None = None + """Additional content-exclusion policies to merge into the session policy set.""" + + additional_directories: list[str] | None = None + """Additional directories the agent may access beyond the working directory. Each entry is + granted to the session's file-access allow-list and surfaced to the model (system prompt + context and `@`-mention completion). Absolute paths are recommended; a relative path is + resolved against the session's working directory. Nonexistent or unresolvable entries are + skipped with a warning. This is applied on both session creation and resume, and is not + persisted: a resumed session that omits this option does not retain previously supplied + directories (re-supply them, exactly as the CLI re-passes `--add-dir`). + """ + agent_context: str | None = None + """Runtime context discriminator for agent filtering.""" + + allow_all_mcp_server_instructions: bool | None = None + """Whether to include instructions from every MCP server in the system prompt instead of + only allowlisted servers. + """ + ask_user_disabled: bool | None = None + """Whether ask_user is explicitly disabled.""" + + auth_info: AuthInfo | None = None + """Initial authentication info for the session.""" + + available_tools: list[str] | None = None + """Allowlist of available tool names.""" + + capi: CapiSessionOptions | None = None + """Options scoped to the built-in CAPI (Copilot API) provider.""" + + client_kind: str | None = None + """Structured client kind used for runtime behavior gates.""" + + client_name: str | None = None + """Identifier of the client driving the session.""" + + coauthor_enabled: bool | None = None + """Whether commit-message coauthor trailers are enabled.""" + + config_dir: str | None = None + """Override Copilot configuration directory.""" + + continue_on_auto_mode: bool | None = None + """Whether auto-mode continuation is enabled.""" + + copilot_url: str | None = None + """Override URL for the Copilot API endpoint.""" + + custom_agents_local_only: bool | None = None + """Whether custom agents default to local-only execution.""" + + detached_from_spawning_parent_engagement_id: str | None = None + """Parent engagement ID for detached child telemetry rollup.""" + + detached_from_spawning_parent_session_id: str | None = None + """Parent session ID for detached child telemetry rollup.""" + + disabled_instruction_sources: list[str] | None = None + """Instruction source IDs disabled for this session.""" + + disabled_mcp_servers: list[str] | None = None + """MCP server names disabled for this session. Disabled servers are not started or + authenticated on create or cold resume. + """ + disabled_skills: list[str] | None = None + """Skill IDs disabled for this session.""" + + enable_citations: bool | None = None + """Experimental: enable native model citations (Anthropic models today), normalized onto the + `assistant.message` event. Off by default; may change or be removed while the citations + surface is experimental. + """ + enable_file_change_tracking: bool | None = None + """Opt in to capturing file changes for session rewind and session diff. Capture cannot + reconstruct changes made before it was enabled. On create it starts capture from the + first turn. It is also honored on resume: for a session that already has tracked prior + turns, tracking continues automatically even if this is omitted; passing it on resume + additionally enables tracking for an eligible session that has no prior root turn yet. + Resuming a session whose prior root turns were never tracked has no restorable baseline, + so tracking stays disabled for it and rewind reports file change tracking as unavailable; + the resume itself still succeeds, so sessions that predate tracking remain loadable. The + opt-in is only rejected when the session can never track (a subagent session, or one + without local session storage). It is intentionally absent from the mutable options + update because enabling it after edits have occurred would create an incomplete, + misleading baseline. Subagents share the parent session's capture store and are not + tracked as separate rewind points: a file a subagent writes is attributed to whichever + root user turn was open when the capture was staged, just before the tool body ran. A + turn cannot open while a staged capture is still in flight, so a subagent tool that + staged under the spawning turn stays attributed to it however late the write lands, while + a capture it stages after the user's next message belongs to that later turn. Attribution + decides which turn's rewind point counts and file preview include that write; it does not + narrow which rewinds revert it, because a rewind restores every capture from the selected + turn onward, so the earlier spawning turn reverts it as well. + """ + enable_managed_settings: bool | None = None + """Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.""" + + enable_on_demand_instruction_discovery: bool | None = None + """Whether on-demand custom instruction discovery is enabled.""" + + enable_script_safety: bool | None = None + """Whether shell-script safety heuristics are enabled.""" + + enable_streaming: bool | None = None + """Whether model responses stream as delta events.""" + + env_value_mode: MCPSetEnvValueModeDetails | None = None + """How MCP server environment values are interpreted.""" + + events_log_directory: str | None = None + """Override directory for session event logs.""" + + events_log_includes_subagents: bool | None = None + """Whether subagent callback events should be forwarded into the session event log sink.""" + + excluded_builtin_agents: list[str] | None = None + """Built-in subagent names to exclude from this session. Excluded built-ins are hidden from + agent discovery and cannot be dispatched unless a custom agent with the same name is + available. + """ + excluded_tools: list[str] | None = None + """Denylist of tool names.""" + + # Internal: this field is an internal SDK API and is not part of the public surface. + exp_assignments: Any = None + """ExP assignment ('flight') data injected by an SDK integrator, in the same JSON shape the + Copilot CLI fetches from the experimentation service (CopilotExpAssignmentResponse). When + supplied this is fed into the FeatureFlagService exactly like CLI-fetched assignments and + ExP-backed flags wait for it. When absent the session does not block on ExP. + """ + feature_flags: dict[str, bool] | None = None + """Feature-flag values resolved by the host.""" + + included_builtin_agents: list[str] | None = None + """Built-in subagent names to include in this session. When specified, only these built-ins + are available, subject to runtime availability and exclusions. Custom agents with the + same name remain available. + """ + installed_plugins: list[InstalledPlugin] | None = None + """Installed plugins visible to the session.""" + + integration_id: str | None = None + """Stable integration identifier for analytics.""" + + is_experimental_mode: bool | None = None + """Whether experimental behavior is enabled.""" + + log_interactive_shells: bool | None = None + """Whether interactive shell sessions are logged.""" + + lsp_client_name: str | None = None + """Identifier sent to LSP-style integrations.""" + + managed_settings: SessionManagedSettings | None = None + """Permissions-only enterprise policy injected by the SDK host at session create or resume. + Composes restrictively with self-fetched and device policy and is not persisted. + """ + max_inline_binary_bytes: int | None = None + """Maximum decoded byte size of a single inline model-facing binary tool result persisted in + session events (default 10 MB). + """ + memory: MemoryConfiguration | None = None + """Memory configuration for this session.""" + + model: str | None = None + """Initial model identifier.""" + + model_capabilities_overrides: ModelCapabilitiesOverride | None = None + """Initial model capability overrides.""" + + models: list[ProviderModelConfig] | None = None + """BYOK model definitions added to the selectable model list, each referencing a provider + name. + """ + name: str | None = None + """Optional human-friendly session name.""" + + provider: ProviderConfig | None = None + """Custom model-provider configuration (BYOK).""" + + providers: list[NamedProviderConfig] | None = None + """Named BYOK provider connections, additive to CAPI auth. Combining with `provider` is + rejected. + """ + reasoning_effort: str | None = None + """Initial reasoning effort level. CAPI values are model-defined and validated against the + selected model; BYOK providers may define additional values. When omitted, no effort + override is applied. + """ + reasoning_summary: ReasoningSummary | None = None + """Initial reasoning summary mode for supported model clients.""" + + remote_defaulted_on: bool | None = None + """Telemetry-only remote-defaulted flag.""" + + remote_exporting: bool | None = None + """Telemetry-only remote exporting flag.""" + + remote_steerable: bool | None = None + """Whether this session supports remote steering.""" + + running_in_interactive_mode: bool | None = None + """Whether the host is an interactive UI.""" + + sandbox_config: SandboxConfig | None = None + """Resolved sandbox configuration.""" + + session_capabilities: list[SessionCapability] | None = None + """Capabilities enabled for this session.""" + + session_id: str | None = None + """Optional stable session identifier to use for a new session.""" + + session_limits: SessionLimitsConfig | None = None + """Initial session limits.""" + + shell: ShellOptions | None = None + """Per-session settings for built-in shell tools.""" + + shell_init_profile: str | None = None + """Use shell.initProfile instead. Shell init profile.""" + + shell_process_flags: list[str] | None = None + """PowerShell process flags applied to built-in and user-requested shell commands.""" + + skill_directories: list[str] | None = None + """Additional directories to search for skills.""" + + skip_custom_instructions: bool | None = None + """Whether to skip custom instruction sources.""" + + trajectory_file: str | None = None + """Optional trajectory output file path.""" + + verbosity: Verbosity | None = None + """Initial output verbosity level for supported models.""" + + working_directory: str | None = None + """Working directory to anchor the session.""" + + working_directory_context: SessionContext | None = None + """Pre-resolved working-directory context for session startup.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionOpenOptions': + assert isinstance(obj, dict) + additional_content_exclusion_policies = from_union([lambda x: from_list(SessionOpenOptionsAdditionalContentExclusionPolicy.from_dict, x), from_none], obj.get("additionalContentExclusionPolicies")) + additional_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("additionalDirectories")) + agent_context = from_union([from_str, from_none], obj.get("agentContext")) + allow_all_mcp_server_instructions = from_union([from_bool, from_none], obj.get("allowAllMcpServerInstructions")) + ask_user_disabled = from_union([from_bool, from_none], obj.get("askUserDisabled")) + auth_info = from_union([_load_AuthInfo, from_none], obj.get("authInfo")) + available_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("availableTools")) + capi = from_union([CapiSessionOptions.from_dict, from_none], obj.get("capi")) + client_kind = from_union([from_str, from_none], obj.get("clientKind")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + coauthor_enabled = from_union([from_bool, from_none], obj.get("coauthorEnabled")) + config_dir = from_union([from_str, from_none], obj.get("configDir")) + continue_on_auto_mode = from_union([from_bool, from_none], obj.get("continueOnAutoMode")) + copilot_url = from_union([from_str, from_none], obj.get("copilotUrl")) + custom_agents_local_only = from_union([from_bool, from_none], obj.get("customAgentsLocalOnly")) + detached_from_spawning_parent_engagement_id = from_union([from_str, from_none], obj.get("detachedFromSpawningParentEngagementId")) + detached_from_spawning_parent_session_id = from_union([from_str, from_none], obj.get("detachedFromSpawningParentSessionId")) + disabled_instruction_sources = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledInstructionSources")) + disabled_mcp_servers = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledMcpServers")) + disabled_skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledSkills")) + enable_citations = from_union([from_bool, from_none], obj.get("enableCitations")) + enable_file_change_tracking = from_union([from_bool, from_none], obj.get("enableFileChangeTracking")) + enable_managed_settings = from_union([from_bool, from_none], obj.get("enableManagedSettings")) + enable_on_demand_instruction_discovery = from_union([from_bool, from_none], obj.get("enableOnDemandInstructionDiscovery")) + enable_script_safety = from_union([from_bool, from_none], obj.get("enableScriptSafety")) + enable_streaming = from_union([from_bool, from_none], obj.get("enableStreaming")) + env_value_mode = from_union([MCPSetEnvValueModeDetails, from_none], obj.get("envValueMode")) + events_log_directory = from_union([from_str, from_none], obj.get("eventsLogDirectory")) + events_log_includes_subagents = from_union([from_bool, from_none], obj.get("eventsLogIncludesSubagents")) + excluded_builtin_agents = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludedBuiltinAgents")) + excluded_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludedTools")) + exp_assignments = obj.get("expAssignments") + feature_flags = from_union([lambda x: from_dict(from_bool, x), from_none], obj.get("featureFlags")) + included_builtin_agents = from_union([lambda x: from_list(from_str, x), from_none], obj.get("includedBuiltinAgents")) + installed_plugins = from_union([lambda x: from_list(InstalledPlugin.from_dict, x), from_none], obj.get("installedPlugins")) + integration_id = from_union([from_str, from_none], obj.get("integrationId")) + is_experimental_mode = from_union([from_bool, from_none], obj.get("isExperimentalMode")) + log_interactive_shells = from_union([from_bool, from_none], obj.get("logInteractiveShells")) + lsp_client_name = from_union([from_str, from_none], obj.get("lspClientName")) + managed_settings = from_union([SessionManagedSettings.from_dict, from_none], obj.get("managedSettings")) + max_inline_binary_bytes = from_union([from_int, from_none], obj.get("maxInlineBinaryBytes")) + memory = from_union([MemoryConfiguration.from_dict, from_none], obj.get("memory")) + model = from_union([from_str, from_none], obj.get("model")) + model_capabilities_overrides = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get("modelCapabilitiesOverrides")) + models = from_union([lambda x: from_list(ProviderModelConfig.from_dict, x), from_none], obj.get("models")) + name = from_union([from_str, from_none], obj.get("name")) + provider = from_union([ProviderConfig.from_dict, from_none], obj.get("provider")) + providers = from_union([lambda x: from_list(NamedProviderConfig.from_dict, x), from_none], obj.get("providers")) + reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) + reasoning_summary = from_union([ReasoningSummary, from_none], obj.get("reasoningSummary")) + remote_defaulted_on = from_union([from_bool, from_none], obj.get("remoteDefaultedOn")) + remote_exporting = from_union([from_bool, from_none], obj.get("remoteExporting")) + remote_steerable = from_union([from_bool, from_none], obj.get("remoteSteerable")) + running_in_interactive_mode = from_union([from_bool, from_none], obj.get("runningInInteractiveMode")) + sandbox_config = from_union([SandboxConfig.from_dict, from_none], obj.get("sandboxConfig")) + session_capabilities = from_union([lambda x: from_list(SessionCapability, x), from_none], obj.get("sessionCapabilities")) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + session_limits = from_union([SessionLimitsConfig.from_dict, from_none], obj.get("sessionLimits")) + shell = from_union([ShellOptions.from_dict, from_none], obj.get("shell")) + shell_init_profile = from_union([from_str, from_none], obj.get("shellInitProfile")) + shell_process_flags = from_union([lambda x: from_list(from_str, x), from_none], obj.get("shellProcessFlags")) + skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skillDirectories")) + skip_custom_instructions = from_union([from_bool, from_none], obj.get("skipCustomInstructions")) + trajectory_file = from_union([from_str, from_none], obj.get("trajectoryFile")) + verbosity = from_union([Verbosity, from_none], obj.get("verbosity")) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + working_directory_context = from_union([SessionContext.from_dict, from_none], obj.get("workingDirectoryContext")) + return SessionOpenOptions(additional_content_exclusion_policies, additional_directories, agent_context, allow_all_mcp_server_instructions, ask_user_disabled, auth_info, available_tools, capi, client_kind, client_name, coauthor_enabled, config_dir, continue_on_auto_mode, copilot_url, custom_agents_local_only, detached_from_spawning_parent_engagement_id, detached_from_spawning_parent_session_id, disabled_instruction_sources, disabled_mcp_servers, disabled_skills, enable_citations, enable_file_change_tracking, enable_managed_settings, enable_on_demand_instruction_discovery, enable_script_safety, enable_streaming, env_value_mode, events_log_directory, events_log_includes_subagents, excluded_builtin_agents, excluded_tools, exp_assignments, feature_flags, included_builtin_agents, installed_plugins, integration_id, is_experimental_mode, log_interactive_shells, lsp_client_name, managed_settings, max_inline_binary_bytes, memory, model, model_capabilities_overrides, models, name, provider, providers, reasoning_effort, reasoning_summary, remote_defaulted_on, remote_exporting, remote_steerable, running_in_interactive_mode, sandbox_config, session_capabilities, session_id, session_limits, shell, shell_init_profile, shell_process_flags, skill_directories, skip_custom_instructions, trajectory_file, verbosity, working_directory, working_directory_context) + + def to_dict(self) -> dict: + result: dict = {} + if self.additional_content_exclusion_policies is not None: + result["additionalContentExclusionPolicies"] = from_union([lambda x: from_list(lambda x: to_class(SessionOpenOptionsAdditionalContentExclusionPolicy, x), x), from_none], self.additional_content_exclusion_policies) + if self.additional_directories is not None: + result["additionalDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.additional_directories) + if self.agent_context is not None: + result["agentContext"] = from_union([from_str, from_none], self.agent_context) + if self.allow_all_mcp_server_instructions is not None: + result["allowAllMcpServerInstructions"] = from_union([from_bool, from_none], self.allow_all_mcp_server_instructions) + if self.ask_user_disabled is not None: + result["askUserDisabled"] = from_union([from_bool, from_none], self.ask_user_disabled) + if self.auth_info is not None: + result["authInfo"] = from_union([lambda x: (x).to_dict(), from_none], self.auth_info) + if self.available_tools is not None: + result["availableTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.available_tools) + if self.capi is not None: + result["capi"] = from_union([lambda x: to_class(CapiSessionOptions, x), from_none], self.capi) + if self.client_kind is not None: + result["clientKind"] = from_union([from_str, from_none], self.client_kind) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.coauthor_enabled is not None: + result["coauthorEnabled"] = from_union([from_bool, from_none], self.coauthor_enabled) + if self.config_dir is not None: + result["configDir"] = from_union([from_str, from_none], self.config_dir) + if self.continue_on_auto_mode is not None: + result["continueOnAutoMode"] = from_union([from_bool, from_none], self.continue_on_auto_mode) + if self.copilot_url is not None: + result["copilotUrl"] = from_union([from_str, from_none], self.copilot_url) + if self.custom_agents_local_only is not None: + result["customAgentsLocalOnly"] = from_union([from_bool, from_none], self.custom_agents_local_only) + if self.detached_from_spawning_parent_engagement_id is not None: + result["detachedFromSpawningParentEngagementId"] = from_union([from_str, from_none], self.detached_from_spawning_parent_engagement_id) + if self.detached_from_spawning_parent_session_id is not None: + result["detachedFromSpawningParentSessionId"] = from_union([from_str, from_none], self.detached_from_spawning_parent_session_id) + if self.disabled_instruction_sources is not None: + result["disabledInstructionSources"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_instruction_sources) + if self.disabled_mcp_servers is not None: + result["disabledMcpServers"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_mcp_servers) + if self.disabled_skills is not None: + result["disabledSkills"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_skills) + if self.enable_citations is not None: + result["enableCitations"] = from_union([from_bool, from_none], self.enable_citations) + if self.enable_file_change_tracking is not None: + result["enableFileChangeTracking"] = from_union([from_bool, from_none], self.enable_file_change_tracking) + if self.enable_managed_settings is not None: + result["enableManagedSettings"] = from_union([from_bool, from_none], self.enable_managed_settings) + if self.enable_on_demand_instruction_discovery is not None: + result["enableOnDemandInstructionDiscovery"] = from_union([from_bool, from_none], self.enable_on_demand_instruction_discovery) + if self.enable_script_safety is not None: + result["enableScriptSafety"] = from_union([from_bool, from_none], self.enable_script_safety) + if self.enable_streaming is not None: + result["enableStreaming"] = from_union([from_bool, from_none], self.enable_streaming) + if self.env_value_mode is not None: + result["envValueMode"] = from_union([lambda x: to_enum(MCPSetEnvValueModeDetails, x), from_none], self.env_value_mode) + if self.events_log_directory is not None: + result["eventsLogDirectory"] = from_union([from_str, from_none], self.events_log_directory) + if self.events_log_includes_subagents is not None: + result["eventsLogIncludesSubagents"] = from_union([from_bool, from_none], self.events_log_includes_subagents) + if self.excluded_builtin_agents is not None: + result["excludedBuiltinAgents"] = from_union([lambda x: from_list(from_str, x), from_none], self.excluded_builtin_agents) + if self.excluded_tools is not None: + result["excludedTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.excluded_tools) + if self.exp_assignments is not None: + result["expAssignments"] = self.exp_assignments + if self.feature_flags is not None: + result["featureFlags"] = from_union([lambda x: from_dict(from_bool, x), from_none], self.feature_flags) + if self.included_builtin_agents is not None: + result["includedBuiltinAgents"] = from_union([lambda x: from_list(from_str, x), from_none], self.included_builtin_agents) + if self.installed_plugins is not None: + result["installedPlugins"] = from_union([lambda x: from_list(lambda x: to_class(InstalledPlugin, x), x), from_none], self.installed_plugins) + if self.integration_id is not None: + result["integrationId"] = from_union([from_str, from_none], self.integration_id) + if self.is_experimental_mode is not None: + result["isExperimentalMode"] = from_union([from_bool, from_none], self.is_experimental_mode) + if self.log_interactive_shells is not None: + result["logInteractiveShells"] = from_union([from_bool, from_none], self.log_interactive_shells) + if self.lsp_client_name is not None: + result["lspClientName"] = from_union([from_str, from_none], self.lsp_client_name) + if self.managed_settings is not None: + result["managedSettings"] = from_union([lambda x: to_class(SessionManagedSettings, x), from_none], self.managed_settings) + if self.max_inline_binary_bytes is not None: + result["maxInlineBinaryBytes"] = from_union([from_int, from_none], self.max_inline_binary_bytes) + if self.memory is not None: + result["memory"] = from_union([lambda x: to_class(MemoryConfiguration, x), from_none], self.memory) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.model_capabilities_overrides is not None: + result["modelCapabilitiesOverrides"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.model_capabilities_overrides) + if self.models is not None: + result["models"] = from_union([lambda x: from_list(lambda x: to_class(ProviderModelConfig, x), x), from_none], self.models) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.provider is not None: + result["provider"] = from_union([lambda x: to_class(ProviderConfig, x), from_none], self.provider) + if self.providers is not None: + result["providers"] = from_union([lambda x: from_list(lambda x: to_class(NamedProviderConfig, x), x), from_none], self.providers) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + if self.reasoning_summary is not None: + result["reasoningSummary"] = from_union([lambda x: to_enum(ReasoningSummary, x), from_none], self.reasoning_summary) + if self.remote_defaulted_on is not None: + result["remoteDefaultedOn"] = from_union([from_bool, from_none], self.remote_defaulted_on) + if self.remote_exporting is not None: + result["remoteExporting"] = from_union([from_bool, from_none], self.remote_exporting) + if self.remote_steerable is not None: + result["remoteSteerable"] = from_union([from_bool, from_none], self.remote_steerable) + if self.running_in_interactive_mode is not None: + result["runningInInteractiveMode"] = from_union([from_bool, from_none], self.running_in_interactive_mode) + if self.sandbox_config is not None: + result["sandboxConfig"] = from_union([lambda x: to_class(SandboxConfig, x), from_none], self.sandbox_config) + if self.session_capabilities is not None: + result["sessionCapabilities"] = from_union([lambda x: from_list(lambda x: to_enum(SessionCapability, x), x), from_none], self.session_capabilities) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) + if self.session_limits is not None: + result["sessionLimits"] = from_union([lambda x: to_class(SessionLimitsConfig, x), from_none], self.session_limits) + if self.shell is not None: + result["shell"] = from_union([lambda x: to_class(ShellOptions, x), from_none], self.shell) + if self.shell_init_profile is not None: + result["shellInitProfile"] = from_union([from_str, from_none], self.shell_init_profile) + if self.shell_process_flags is not None: + result["shellProcessFlags"] = from_union([lambda x: from_list(from_str, x), from_none], self.shell_process_flags) + if self.skill_directories is not None: + result["skillDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories) + if self.skip_custom_instructions is not None: + result["skipCustomInstructions"] = from_union([from_bool, from_none], self.skip_custom_instructions) + if self.trajectory_file is not None: + result["trajectoryFile"] = from_union([from_str, from_none], self.trajectory_file) + if self.verbosity is not None: + result["verbosity"] = from_union([lambda x: to_enum(Verbosity, x), from_none], self.verbosity) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + if self.working_directory_context is not None: + result["workingDirectoryContext"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.working_directory_context) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionUpdateOptionsParams: + """Patch of mutable session options to apply to the running session.""" + + additional_content_exclusion_policies: list[OptionsUpdateAdditionalContentExclusionPolicy] | None = None + """Additional content-exclusion policies to merge into the session's policy set.""" + + agent_context: str | None = None + """Runtime context discriminator (e.g., `cli`, `actions`).""" + + allow_all_mcp_server_instructions: bool | None = None + """Whether to include instructions from every MCP server in the system prompt instead of + only allowlisted servers. + """ + ask_user_disabled: bool | None = None + """Whether to disable the `ask_user` tool (encourages autonomous behavior).""" + + available_tools: list[str] | None = None + """Allowlist of tool names available to this session.""" + + capi: CapiSessionOptions | None = None + """Options scoped to the built-in CAPI (Copilot API) provider.""" + + client_name: str | None = None + """Identifier of the client driving the session.""" + + coauthor_enabled: bool | None = None + """Whether to include the `Co-authored-by` trailer in commit messages.""" + + context_tier: OptionsUpdateContextTier | None = None + """Context tier for models with tiered pricing. The session uses this to derive effective + `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits + honor the selected tier. + """ + continue_on_auto_mode: bool | None = None + """Whether to allow auto-mode continuation across turns.""" + + copilot_url: str | None = None + """Override URL for the Copilot API endpoint.""" + + custom_agents_local_only: bool | None = None + """Whether to default custom agents to local-only execution.""" + + disabled_instruction_sources: list[str] | None = None + """Instruction source IDs to exclude from the system prompt.""" disabled_skills: list[str] | None = None """Skill IDs that should be excluded from this session.""" - enable_file_hooks: bool | None = None - """Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK - callback hook mechanism. + enable_file_hooks: bool | None = None + """Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK + callback hook mechanism. + """ + enable_host_git_operations: bool | None = None + """Whether to enable host git operations (context resolution, child repo scanning, git info + in system prompt). + """ + enable_on_demand_instruction_discovery: bool | None = None + """Whether to discover custom instructions on demand after successful file views (AGENTS.md + / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with + `skipCustomInstructions`. + """ + enable_reasoning_summaries: bool | None = None + """Whether to surface reasoning-summary events from the model.""" + + enable_script_safety: bool | None = None + """Whether shell-script safety heuristics are enabled.""" + + enable_session_store: bool | None = None + """Whether to enable cross-session store writes and reads.""" + + enable_skills: bool | None = None + """Whether to enable skill directory scanning and loading. Falls back to + enableConfigDiscovery when unset. + """ + enable_streaming: bool | None = None + """Whether to stream model responses.""" + + env_value_mode: MCPSetEnvValueModeDetails | None = None + """How env values are passed to MCP servers (`direct` inlines literal values; `indirect` + resolves at launch). + """ + events_log_directory: str | None = None + """Override directory for the session-events log. When unset, the runtime's default events + log directory is used. + """ + events_log_includes_subagents: bool | None = None + """Whether subagent callback events should be forwarded into the session event log sink.""" + + excluded_builtin_agents: list[str] | None = None + """Built-in subagent names to exclude from this session. Excluded built-ins are hidden from + agent discovery and cannot be dispatched unless a custom agent with the same name is + available. + """ + excluded_tools: list[str] | None = None + """Denylist of tool names for this session.""" + + feature_flags: dict[str, bool] | None = None + """Map of feature-flag IDs to their boolean enabled state.""" + + included_builtin_agents: list[str] | None = None + """Built-in subagent names to include in this session. When specified, only these built-ins + are available, subject to runtime availability and exclusions. Custom agents with the + same name remain available. Set to null to remove the allowlist restriction. + """ + installed_plugins: list[SessionInstalledPlugin] | None = None + """Full set of installed plugins for the session. Replaces the existing list; the runtime + invalidates the skills cache only when the list materially changes. + """ + integration_id: str | None = None + """Stable integration identifier used for analytics and rate-limit attribution.""" + + is_experimental_mode: bool | None = None + """Whether experimental capabilities are enabled.""" + + log_interactive_shells: bool | None = None + """Whether interactive shell sessions are logged.""" + + lsp_client_name: str | None = None + """Identifier sent to LSP-style integrations.""" + + manage_schedule_enabled: bool | None = None + """Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the + per-session schedule registry; this flag only controls tool exposure (typically gated to + staff users). + """ + max_inline_binary_bytes: int | None = None + """Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) + persisted inline in session events and re-presented to the model on later turns / resume. + Larger results are persisted as a metadata-only marker and shown to the model as a short + text note. Defaults to 10 MB. + """ + model: str | None = None + """The model ID to use for assistant turns.""" + + model_capabilities_overrides: ModelCapabilitiesOverride | None = None + """Per-property model capability overrides for the selected model.""" + + organization_custom_instructions: str | None = None + """Organization-level custom instructions to inject into the system prompt.""" + + provider: ProviderConfig | None = None + """Custom model-provider configuration (BYOK).""" + + reasoning_effort: str | None = None + """Reasoning effort for the selected model. CAPI values are model-defined and validated + against the selected model; BYOK providers may define additional values. When omitted, no + effort override is applied. + """ + reasoning_summary: ReasoningSummary | None = None + """Reasoning summary mode for supported model clients.""" + + running_in_interactive_mode: bool | None = None + """Whether the session is running in an interactive UI.""" + + sandbox_config: SandboxConfig | None = None + """Resolved sandbox configuration.""" + + session_capabilities: list[SessionCapability] | None = None + """Replaces the session's capability set with the given list. Use to enable or disable + capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the + field to leave the existing capability set unchanged. + """ + session_limits: SessionLimitsConfig | None = None + """Optional session limits. Pass null to clear the session limits.""" + + shell: ShellOptions | None = None + """Per-session settings for built-in shell tools.""" + + shell_init_profile: str | None = None + """Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`).""" + + shell_process_flags: list[str] | None = None + """PowerShell process flags applied to built-in and user-requested shell commands.""" + + skill_directories: list[str] | None = None + """Additional directories to search for skills.""" + + skip_custom_instructions: bool | None = None + """Whether to skip loading custom instruction sources.""" + + skip_embedding_retrieval: bool | None = None + """Whether to skip embedding retrieval pipeline initialization and execution.""" + + suppress_custom_agent_prompt: bool | None = None + """When true, the selected custom agent's prompt is not injected into the user message + (skill context is still injected). Used by automation triggers where the agent prompt is + already in the problem statement. + """ + tool_filter_precedence: OptionsUpdateToolFilterPrecedence | None = None + """Controls how availableTools (allowlist) and excludedTools (denylist) combine when both + are set. + """ + trajectory_file: str | None = None + """Optional path for trajectory output.""" + + verbosity: Verbosity | None = None + """Output verbosity level for supported models.""" + + working_directory: str | None = None + """Absolute working-directory path for shell tools.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionUpdateOptionsParams': + assert isinstance(obj, dict) + additional_content_exclusion_policies = from_union([lambda x: from_list(OptionsUpdateAdditionalContentExclusionPolicy.from_dict, x), from_none], obj.get("additionalContentExclusionPolicies")) + agent_context = from_union([from_str, from_none], obj.get("agentContext")) + allow_all_mcp_server_instructions = from_union([from_bool, from_none], obj.get("allowAllMcpServerInstructions")) + ask_user_disabled = from_union([from_bool, from_none], obj.get("askUserDisabled")) + available_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("availableTools")) + capi = from_union([CapiSessionOptions.from_dict, from_none], obj.get("capi")) + client_name = from_union([from_str, from_none], obj.get("clientName")) + coauthor_enabled = from_union([from_bool, from_none], obj.get("coauthorEnabled")) + context_tier = from_union([OptionsUpdateContextTier, from_none], obj.get("contextTier")) + continue_on_auto_mode = from_union([from_bool, from_none], obj.get("continueOnAutoMode")) + copilot_url = from_union([from_str, from_none], obj.get("copilotUrl")) + custom_agents_local_only = from_union([from_bool, from_none], obj.get("customAgentsLocalOnly")) + disabled_instruction_sources = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledInstructionSources")) + disabled_skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledSkills")) + enable_file_hooks = from_union([from_bool, from_none], obj.get("enableFileHooks")) + enable_host_git_operations = from_union([from_bool, from_none], obj.get("enableHostGitOperations")) + enable_on_demand_instruction_discovery = from_union([from_bool, from_none], obj.get("enableOnDemandInstructionDiscovery")) + enable_reasoning_summaries = from_union([from_bool, from_none], obj.get("enableReasoningSummaries")) + enable_script_safety = from_union([from_bool, from_none], obj.get("enableScriptSafety")) + enable_session_store = from_union([from_bool, from_none], obj.get("enableSessionStore")) + enable_skills = from_union([from_bool, from_none], obj.get("enableSkills")) + enable_streaming = from_union([from_bool, from_none], obj.get("enableStreaming")) + env_value_mode = from_union([MCPSetEnvValueModeDetails, from_none], obj.get("envValueMode")) + events_log_directory = from_union([from_str, from_none], obj.get("eventsLogDirectory")) + events_log_includes_subagents = from_union([from_bool, from_none], obj.get("eventsLogIncludesSubagents")) + excluded_builtin_agents = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludedBuiltinAgents")) + excluded_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludedTools")) + feature_flags = from_union([lambda x: from_dict(from_bool, x), from_none], obj.get("featureFlags")) + included_builtin_agents = from_union([lambda x: from_list(from_str, x), from_none], obj.get("includedBuiltinAgents")) + installed_plugins = from_union([lambda x: from_list(SessionInstalledPlugin.from_dict, x), from_none], obj.get("installedPlugins")) + integration_id = from_union([from_str, from_none], obj.get("integrationId")) + is_experimental_mode = from_union([from_bool, from_none], obj.get("isExperimentalMode")) + log_interactive_shells = from_union([from_bool, from_none], obj.get("logInteractiveShells")) + lsp_client_name = from_union([from_str, from_none], obj.get("lspClientName")) + manage_schedule_enabled = from_union([from_bool, from_none], obj.get("manageScheduleEnabled")) + max_inline_binary_bytes = from_union([from_int, from_none], obj.get("maxInlineBinaryBytes")) + model = from_union([from_str, from_none], obj.get("model")) + model_capabilities_overrides = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get("modelCapabilitiesOverrides")) + organization_custom_instructions = from_union([from_str, from_none], obj.get("organizationCustomInstructions")) + provider = from_union([ProviderConfig.from_dict, from_none], obj.get("provider")) + reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) + reasoning_summary = from_union([ReasoningSummary, from_none], obj.get("reasoningSummary")) + running_in_interactive_mode = from_union([from_bool, from_none], obj.get("runningInInteractiveMode")) + sandbox_config = from_union([SandboxConfig.from_dict, from_none], obj.get("sandboxConfig")) + session_capabilities = from_union([lambda x: from_list(SessionCapability, x), from_none], obj.get("sessionCapabilities")) + session_limits = from_union([SessionLimitsConfig.from_dict, from_none], obj.get("sessionLimits")) + shell = from_union([ShellOptions.from_dict, from_none], obj.get("shell")) + shell_init_profile = from_union([from_str, from_none], obj.get("shellInitProfile")) + shell_process_flags = from_union([lambda x: from_list(from_str, x), from_none], obj.get("shellProcessFlags")) + skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skillDirectories")) + skip_custom_instructions = from_union([from_bool, from_none], obj.get("skipCustomInstructions")) + skip_embedding_retrieval = from_union([from_bool, from_none], obj.get("skipEmbeddingRetrieval")) + suppress_custom_agent_prompt = from_union([from_bool, from_none], obj.get("suppressCustomAgentPrompt")) + tool_filter_precedence = from_union([OptionsUpdateToolFilterPrecedence, from_none], obj.get("toolFilterPrecedence")) + trajectory_file = from_union([from_str, from_none], obj.get("trajectoryFile")) + verbosity = from_union([Verbosity, from_none], obj.get("verbosity")) + working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) + return SessionUpdateOptionsParams(additional_content_exclusion_policies, agent_context, allow_all_mcp_server_instructions, ask_user_disabled, available_tools, capi, client_name, coauthor_enabled, context_tier, continue_on_auto_mode, copilot_url, custom_agents_local_only, disabled_instruction_sources, disabled_skills, enable_file_hooks, enable_host_git_operations, enable_on_demand_instruction_discovery, enable_reasoning_summaries, enable_script_safety, enable_session_store, enable_skills, enable_streaming, env_value_mode, events_log_directory, events_log_includes_subagents, excluded_builtin_agents, excluded_tools, feature_flags, included_builtin_agents, installed_plugins, integration_id, is_experimental_mode, log_interactive_shells, lsp_client_name, manage_schedule_enabled, max_inline_binary_bytes, model, model_capabilities_overrides, organization_custom_instructions, provider, reasoning_effort, reasoning_summary, running_in_interactive_mode, sandbox_config, session_capabilities, session_limits, shell, shell_init_profile, shell_process_flags, skill_directories, skip_custom_instructions, skip_embedding_retrieval, suppress_custom_agent_prompt, tool_filter_precedence, trajectory_file, verbosity, working_directory) + + def to_dict(self) -> dict: + result: dict = {} + if self.additional_content_exclusion_policies is not None: + result["additionalContentExclusionPolicies"] = from_union([lambda x: from_list(lambda x: to_class(OptionsUpdateAdditionalContentExclusionPolicy, x), x), from_none], self.additional_content_exclusion_policies) + if self.agent_context is not None: + result["agentContext"] = from_union([from_str, from_none], self.agent_context) + if self.allow_all_mcp_server_instructions is not None: + result["allowAllMcpServerInstructions"] = from_union([from_bool, from_none], self.allow_all_mcp_server_instructions) + if self.ask_user_disabled is not None: + result["askUserDisabled"] = from_union([from_bool, from_none], self.ask_user_disabled) + if self.available_tools is not None: + result["availableTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.available_tools) + if self.capi is not None: + result["capi"] = from_union([lambda x: to_class(CapiSessionOptions, x), from_none], self.capi) + if self.client_name is not None: + result["clientName"] = from_union([from_str, from_none], self.client_name) + if self.coauthor_enabled is not None: + result["coauthorEnabled"] = from_union([from_bool, from_none], self.coauthor_enabled) + if self.context_tier is not None: + result["contextTier"] = from_union([lambda x: to_enum(OptionsUpdateContextTier, x), from_none], self.context_tier) + if self.continue_on_auto_mode is not None: + result["continueOnAutoMode"] = from_union([from_bool, from_none], self.continue_on_auto_mode) + if self.copilot_url is not None: + result["copilotUrl"] = from_union([from_str, from_none], self.copilot_url) + if self.custom_agents_local_only is not None: + result["customAgentsLocalOnly"] = from_union([from_bool, from_none], self.custom_agents_local_only) + if self.disabled_instruction_sources is not None: + result["disabledInstructionSources"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_instruction_sources) + if self.disabled_skills is not None: + result["disabledSkills"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_skills) + if self.enable_file_hooks is not None: + result["enableFileHooks"] = from_union([from_bool, from_none], self.enable_file_hooks) + if self.enable_host_git_operations is not None: + result["enableHostGitOperations"] = from_union([from_bool, from_none], self.enable_host_git_operations) + if self.enable_on_demand_instruction_discovery is not None: + result["enableOnDemandInstructionDiscovery"] = from_union([from_bool, from_none], self.enable_on_demand_instruction_discovery) + if self.enable_reasoning_summaries is not None: + result["enableReasoningSummaries"] = from_union([from_bool, from_none], self.enable_reasoning_summaries) + if self.enable_script_safety is not None: + result["enableScriptSafety"] = from_union([from_bool, from_none], self.enable_script_safety) + if self.enable_session_store is not None: + result["enableSessionStore"] = from_union([from_bool, from_none], self.enable_session_store) + if self.enable_skills is not None: + result["enableSkills"] = from_union([from_bool, from_none], self.enable_skills) + if self.enable_streaming is not None: + result["enableStreaming"] = from_union([from_bool, from_none], self.enable_streaming) + if self.env_value_mode is not None: + result["envValueMode"] = from_union([lambda x: to_enum(MCPSetEnvValueModeDetails, x), from_none], self.env_value_mode) + if self.events_log_directory is not None: + result["eventsLogDirectory"] = from_union([from_str, from_none], self.events_log_directory) + if self.events_log_includes_subagents is not None: + result["eventsLogIncludesSubagents"] = from_union([from_bool, from_none], self.events_log_includes_subagents) + if self.excluded_builtin_agents is not None: + result["excludedBuiltinAgents"] = from_union([lambda x: from_list(from_str, x), from_none], self.excluded_builtin_agents) + if self.excluded_tools is not None: + result["excludedTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.excluded_tools) + if self.feature_flags is not None: + result["featureFlags"] = from_union([lambda x: from_dict(from_bool, x), from_none], self.feature_flags) + if self.included_builtin_agents is not None: + result["includedBuiltinAgents"] = from_union([lambda x: from_list(from_str, x), from_none], self.included_builtin_agents) + if self.installed_plugins is not None: + result["installedPlugins"] = from_union([lambda x: from_list(lambda x: to_class(SessionInstalledPlugin, x), x), from_none], self.installed_plugins) + if self.integration_id is not None: + result["integrationId"] = from_union([from_str, from_none], self.integration_id) + if self.is_experimental_mode is not None: + result["isExperimentalMode"] = from_union([from_bool, from_none], self.is_experimental_mode) + if self.log_interactive_shells is not None: + result["logInteractiveShells"] = from_union([from_bool, from_none], self.log_interactive_shells) + if self.lsp_client_name is not None: + result["lspClientName"] = from_union([from_str, from_none], self.lsp_client_name) + if self.manage_schedule_enabled is not None: + result["manageScheduleEnabled"] = from_union([from_bool, from_none], self.manage_schedule_enabled) + if self.max_inline_binary_bytes is not None: + result["maxInlineBinaryBytes"] = from_union([from_int, from_none], self.max_inline_binary_bytes) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.model_capabilities_overrides is not None: + result["modelCapabilitiesOverrides"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.model_capabilities_overrides) + if self.organization_custom_instructions is not None: + result["organizationCustomInstructions"] = from_union([from_str, from_none], self.organization_custom_instructions) + if self.provider is not None: + result["provider"] = from_union([lambda x: to_class(ProviderConfig, x), from_none], self.provider) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) + if self.reasoning_summary is not None: + result["reasoningSummary"] = from_union([lambda x: to_enum(ReasoningSummary, x), from_none], self.reasoning_summary) + if self.running_in_interactive_mode is not None: + result["runningInInteractiveMode"] = from_union([from_bool, from_none], self.running_in_interactive_mode) + if self.sandbox_config is not None: + result["sandboxConfig"] = from_union([lambda x: to_class(SandboxConfig, x), from_none], self.sandbox_config) + if self.session_capabilities is not None: + result["sessionCapabilities"] = from_union([lambda x: from_list(lambda x: to_enum(SessionCapability, x), x), from_none], self.session_capabilities) + if self.session_limits is not None: + result["sessionLimits"] = from_union([lambda x: to_class(SessionLimitsConfig, x), from_none], self.session_limits) + if self.shell is not None: + result["shell"] = from_union([lambda x: to_class(ShellOptions, x), from_none], self.shell) + if self.shell_init_profile is not None: + result["shellInitProfile"] = from_union([from_str, from_none], self.shell_init_profile) + if self.shell_process_flags is not None: + result["shellProcessFlags"] = from_union([lambda x: from_list(from_str, x), from_none], self.shell_process_flags) + if self.skill_directories is not None: + result["skillDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories) + if self.skip_custom_instructions is not None: + result["skipCustomInstructions"] = from_union([from_bool, from_none], self.skip_custom_instructions) + if self.skip_embedding_retrieval is not None: + result["skipEmbeddingRetrieval"] = from_union([from_bool, from_none], self.skip_embedding_retrieval) + if self.suppress_custom_agent_prompt is not None: + result["suppressCustomAgentPrompt"] = from_union([from_bool, from_none], self.suppress_custom_agent_prompt) + if self.tool_filter_precedence is not None: + result["toolFilterPrecedence"] = from_union([lambda x: to_enum(OptionsUpdateToolFilterPrecedence, x), from_none], self.tool_filter_precedence) + if self.trajectory_file is not None: + result["trajectoryFile"] = from_union([from_str, from_none], self.trajectory_file) + if self.verbosity is not None: + result["verbosity"] = from_union([lambda x: to_enum(Verbosity, x), from_none], self.verbosity) + if self.working_directory is not None: + result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UIElicitationRequest: + """Prompt message and JSON schema describing the form fields to elicit from the user.""" + + message: str + """Message describing what information is needed from the user""" + + requested_schema: UIElicitationSchema + """JSON Schema describing the form fields to present to the user""" + + @staticmethod + def from_dict(obj: Any) -> 'UIElicitationRequest': + assert isinstance(obj, dict) + message = from_str(obj.get("message")) + requested_schema = UIElicitationSchema.from_dict(obj.get("requestedSchema")) + return UIElicitationRequest(message, requested_schema) + + def to_dict(self) -> dict: + result: dict = {} + result["message"] = from_str(self.message) + result["requestedSchema"] = to_class(UIElicitationSchema, self.requested_schema) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class BuiltInModelCatalog: + """The running runtime's complete catalog of well-known built-in model IDs, including + supported models and additional IDs with built-in metadata. + """ + models: list[BuiltInModelCatalogEntry] + """Built-in model entries.""" + + @staticmethod + def from_dict(obj: Any) -> 'BuiltInModelCatalog': + assert isinstance(obj, dict) + models = from_list(BuiltInModelCatalogEntry.from_dict, obj.get("models")) + return BuiltInModelCatalog(models) + + def to_dict(self) -> dict: + result: dict = {} + result["models"] = from_list(lambda x: to_class(BuiltInModelCatalogEntry, x), self.models) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenCreate: + """Parameters for creating a new local session.""" + + kind: ClassVar[str] = "create" + """Create a new local session.""" + + emit_start: bool | None = None + """Whether to emit session.start during creation. Defaults to true.""" + + options: SessionOpenOptions | None = None + """Session construction options.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenCreate': + assert isinstance(obj, dict) + emit_start = from_union([from_bool, from_none], obj.get("emitStart")) + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + return SessionsOpenCreate(emit_start, options) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.emit_start is not None: + result["emitStart"] = from_union([from_bool, from_none], self.emit_start) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenRemote: + """Parameters for connecting to a live remote session.""" + + kind: ClassVar[str] = "remote" + """Connect to a live remote session.""" + + remote_session_id: str + """Remote session identifier to connect to.""" + + options: SessionOpenOptions | None = None + """Session options for the connection.""" + + repository: RemoteSessionRepository | None = None + """Repository context for the remote session.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenRemote': + assert isinstance(obj, dict) + remote_session_id = from_str(obj.get("remoteSessionId")) + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + repository = from_union([RemoteSessionRepository.from_dict, from_none], obj.get("repository")) + return SessionsOpenRemote(remote_session_id, options, repository) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["remoteSessionId"] = from_str(self.remote_session_id) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + if self.repository is not None: + result["repository"] = from_union([lambda x: to_class(RemoteSessionRepository, x), from_none], self.repository) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenResume: + """Parameters for resuming a specific local session.""" + + kind: ClassVar[str] = "resume" + """Resume a specific local session by ID or prefix.""" + + session_id: str + """Session ID or unique prefix to resume.""" + + options: SessionOpenOptions | None = None + """Session resume options.""" + + resume: bool | None = None + """Whether to emit session.resume after loading. Defaults to true.""" + + suppress_resume_workspace_metadata_writeback: bool | None = None + """Suppress workspace.yaml metadata writeback when resuming from an incidental cwd.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenResume': + assert isinstance(obj, dict) + session_id = from_str(obj.get("sessionId")) + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + resume = from_union([from_bool, from_none], obj.get("resume")) + suppress_resume_workspace_metadata_writeback = from_union([from_bool, from_none], obj.get("suppressResumeWorkspaceMetadataWriteback")) + return SessionsOpenResume(session_id, options, resume, suppress_resume_workspace_metadata_writeback) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["sessionId"] = from_str(self.session_id) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + if self.resume is not None: + result["resume"] = from_union([from_bool, from_none], self.resume) + if self.suppress_resume_workspace_metadata_writeback is not None: + result["suppressResumeWorkspaceMetadataWriteback"] = from_union([from_bool, from_none], self.suppress_resume_workspace_metadata_writeback) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenResumeLast: + """Parameters for resuming the most relevant local session.""" + + kind: ClassVar[str] = "resumeLast" + """Resume the most relevant existing local session.""" + + context: SessionContext | None = None + """Working-directory context used to choose the most relevant session.""" + + options: SessionOpenOptions | None = None + """Session resume options.""" + + suppress_resume_workspace_metadata_writeback: bool | None = None + """Suppress workspace.yaml metadata writeback when resuming from an incidental cwd.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenResumeLast': + assert isinstance(obj, dict) + context = from_union([SessionContext.from_dict, from_none], obj.get("context")) + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + suppress_resume_workspace_metadata_writeback = from_union([from_bool, from_none], obj.get("suppressResumeWorkspaceMetadataWriteback")) + return SessionsOpenResumeLast(context, options, suppress_resume_workspace_metadata_writeback) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.context is not None: + result["context"] = from_union([lambda x: to_class(SessionContext, x), from_none], self.context) + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + if self.suppress_resume_workspace_metadata_writeback is not None: + result["suppressResumeWorkspaceMetadataWriteback"] = from_union([from_bool, from_none], self.suppress_resume_workspace_metadata_writeback) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CopilotUserResponse: + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ + access_type_sku: str | None = None + """Copilot access SKU identifier (e.g. `free_limited_copilot`, + `copilot_for_business_seat_quota`) used to gate model and feature access. + """ + analytics_tracking_id: str | None = None + """Opaque analytics tracking identifier for the user, forwarded from the Copilot API.""" + + assigned_date: Any = None + """Date the Copilot seat was assigned to the user, if applicable.""" + + can_signup_for_limited: bool | None = None + """Whether the user is eligible to sign up for the free/limited Copilot tier.""" + + can_upgrade_plan: bool | None = None + """Whether the user is able to upgrade their Copilot plan.""" + + chat_enabled: bool | None = None + """Whether Copilot chat is enabled for the user.""" + + cli_remote_control_enabled: bool | None = None + """Whether CLI remote control is enabled for the user.""" + + cloud_session_storage_enabled: bool | None = None + """Whether cloud session storage is enabled for the user.""" + + codex_agent_enabled: bool | None = None + """Whether the Codex agent is enabled for the user.""" + + copilot_plan: str | None = None + """Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`).""" + + copilotignore_enabled: bool | None = None + """Whether `.copilotignore` content-exclusion support is enabled for the user.""" + + endpoints: CopilotUserResponseEndpoints | None = None + """Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.""" + + is_mcp_enabled: Any = None + """Whether MCP (Model Context Protocol) support is enabled for the user.""" + + is_staff: bool | None = None + """Whether the user is a GitHub/Microsoft staff member.""" + + limited_user_quotas: dict[str, float] | None = None + """Per-category quota allotments for free/limited-tier users, keyed by quota category.""" + + limited_user_reset_date: str | None = None + """Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API.""" + + login: str | None = None + """GitHub login of the authenticated user.""" + + monthly_quotas: dict[str, float] | None = None + """Per-category monthly quota allotments, keyed by quota category.""" + + organization_list: Any = None + """Organizations the user belongs to, each with an optional login and display name.""" + + organization_login_list: list[str] | None = None + """Logins of the organizations the user belongs to.""" + + quota_reset_date: str | None = None + """Date the user's usage quota next resets, as a raw string from the Copilot API; see + `quota_reset_date_utc` for the UTC-normalized value. + """ + quota_reset_date_utc: str | None = None + """UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets).""" + + quota_snapshots: dict[str, CopilotUserResponseQuotaSnapshots | None] | None = None + """Quota snapshot map from the raw Copilot user-response passthrough, with chat, + completions, premium-interactions, and other entries. + """ + restricted_telemetry: bool | None = None + """Whether the user's telemetry is subject to restricted-data handling.""" + + te: bool | None = None + """Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side + eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime. + """ + token_based_billing: bool | None = None + """Whether the account is on usage-based (token/AI-credit) billing rather than a fixed + premium-request quota. + """ + + @staticmethod + def from_dict(obj: Any) -> 'CopilotUserResponse': + assert isinstance(obj, dict) + access_type_sku = from_union([from_str, from_none], obj.get("access_type_sku")) + analytics_tracking_id = from_union([from_str, from_none], obj.get("analytics_tracking_id")) + assigned_date = obj.get("assigned_date") + can_signup_for_limited = from_union([from_bool, from_none], obj.get("can_signup_for_limited")) + can_upgrade_plan = from_union([from_bool, from_none], obj.get("can_upgrade_plan")) + chat_enabled = from_union([from_bool, from_none], obj.get("chat_enabled")) + cli_remote_control_enabled = from_union([from_bool, from_none], obj.get("cli_remote_control_enabled")) + cloud_session_storage_enabled = from_union([from_bool, from_none], obj.get("cloud_session_storage_enabled")) + codex_agent_enabled = from_union([from_bool, from_none], obj.get("codex_agent_enabled")) + copilot_plan = from_union([from_str, from_none], obj.get("copilot_plan")) + copilotignore_enabled = from_union([from_bool, from_none], obj.get("copilotignore_enabled")) + endpoints = from_union([CopilotUserResponseEndpoints.from_dict, from_none], obj.get("endpoints")) + is_mcp_enabled = obj.get("is_mcp_enabled") + is_staff = from_union([from_bool, from_none], obj.get("is_staff")) + limited_user_quotas = from_union([lambda x: from_dict(from_float, x), from_none], obj.get("limited_user_quotas")) + limited_user_reset_date = from_union([from_str, from_none], obj.get("limited_user_reset_date")) + login = from_union([from_str, from_none], obj.get("login")) + monthly_quotas = from_union([lambda x: from_dict(from_float, x), from_none], obj.get("monthly_quotas")) + organization_list = obj.get("organization_list") + organization_login_list = from_union([lambda x: from_list(from_str, x), from_none], obj.get("organization_login_list")) + quota_reset_date = from_union([from_str, from_none], obj.get("quota_reset_date")) + quota_reset_date_utc = from_union([from_str, from_none], obj.get("quota_reset_date_utc")) + quota_snapshots = from_union([lambda x: from_dict(lambda x: from_union([CopilotUserResponseQuotaSnapshots.from_dict, from_none], x), x), from_none], obj.get("quota_snapshots")) + restricted_telemetry = from_union([from_bool, from_none], obj.get("restricted_telemetry")) + te = from_union([from_bool, from_none], obj.get("te")) + token_based_billing = from_union([from_bool, from_none], obj.get("token_based_billing")) + return CopilotUserResponse(access_type_sku, analytics_tracking_id, assigned_date, can_signup_for_limited, can_upgrade_plan, chat_enabled, cli_remote_control_enabled, cloud_session_storage_enabled, codex_agent_enabled, copilot_plan, copilotignore_enabled, endpoints, is_mcp_enabled, is_staff, limited_user_quotas, limited_user_reset_date, login, monthly_quotas, organization_list, organization_login_list, quota_reset_date, quota_reset_date_utc, quota_snapshots, restricted_telemetry, te, token_based_billing) + + def to_dict(self) -> dict: + result: dict = {} + if self.access_type_sku is not None: + result["access_type_sku"] = from_union([from_str, from_none], self.access_type_sku) + if self.analytics_tracking_id is not None: + result["analytics_tracking_id"] = from_union([from_str, from_none], self.analytics_tracking_id) + if self.assigned_date is not None: + result["assigned_date"] = self.assigned_date + if self.can_signup_for_limited is not None: + result["can_signup_for_limited"] = from_union([from_bool, from_none], self.can_signup_for_limited) + if self.can_upgrade_plan is not None: + result["can_upgrade_plan"] = from_union([from_bool, from_none], self.can_upgrade_plan) + if self.chat_enabled is not None: + result["chat_enabled"] = from_union([from_bool, from_none], self.chat_enabled) + if self.cli_remote_control_enabled is not None: + result["cli_remote_control_enabled"] = from_union([from_bool, from_none], self.cli_remote_control_enabled) + if self.cloud_session_storage_enabled is not None: + result["cloud_session_storage_enabled"] = from_union([from_bool, from_none], self.cloud_session_storage_enabled) + if self.codex_agent_enabled is not None: + result["codex_agent_enabled"] = from_union([from_bool, from_none], self.codex_agent_enabled) + if self.copilot_plan is not None: + result["copilot_plan"] = from_union([from_str, from_none], self.copilot_plan) + if self.copilotignore_enabled is not None: + result["copilotignore_enabled"] = from_union([from_bool, from_none], self.copilotignore_enabled) + if self.endpoints is not None: + result["endpoints"] = from_union([lambda x: to_class(CopilotUserResponseEndpoints, x), from_none], self.endpoints) + if self.is_mcp_enabled is not None: + result["is_mcp_enabled"] = self.is_mcp_enabled + if self.is_staff is not None: + result["is_staff"] = from_union([from_bool, from_none], self.is_staff) + if self.limited_user_quotas is not None: + result["limited_user_quotas"] = from_union([lambda x: from_dict(to_float, x), from_none], self.limited_user_quotas) + if self.limited_user_reset_date is not None: + result["limited_user_reset_date"] = from_union([from_str, from_none], self.limited_user_reset_date) + if self.login is not None: + result["login"] = from_union([from_str, from_none], self.login) + if self.monthly_quotas is not None: + result["monthly_quotas"] = from_union([lambda x: from_dict(to_float, x), from_none], self.monthly_quotas) + if self.organization_list is not None: + result["organization_list"] = self.organization_list + if self.organization_login_list is not None: + result["organization_login_list"] = from_union([lambda x: from_list(from_str, x), from_none], self.organization_login_list) + if self.quota_reset_date is not None: + result["quota_reset_date"] = from_union([from_str, from_none], self.quota_reset_date) + if self.quota_reset_date_utc is not None: + result["quota_reset_date_utc"] = from_union([from_str, from_none], self.quota_reset_date_utc) + if self.quota_snapshots is not None: + result["quota_snapshots"] = from_union([lambda x: from_dict(lambda x: from_union([lambda x: to_class(CopilotUserResponseQuotaSnapshots, x), from_none], x), x), from_none], self.quota_snapshots) + if self.restricted_telemetry is not None: + result["restricted_telemetry"] = from_union([from_bool, from_none], self.restricted_telemetry) + if self.te is not None: + result["te"] = from_union([from_bool, from_none], self.te) + if self.token_based_billing is not None: + result["token_based_billing"] = from_union([from_bool, from_none], self.token_based_billing) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentRegistryLiveTargetEntry: + """Full registry entry for the spawned child. Lets the controller call + `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a + TOCTOU window). + """ + copilot_version: str + """Copilot CLI version that wrote the entry""" + + host: str + """Bind host for the entry's JSON-RPC server""" + + kind: AgentRegistryLiveTargetEntryKind + """Process kind tag for the registry entry""" + + last_seen_ms: int + """Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness)""" + + pid: int + """Operating-system pid of the process owning this entry""" + + port: int + """TCP port the entry's JSON-RPC server is listening on""" + + schema_version: int + """Registry entry schema version (1 = ui-server, 2 = managed-server)""" + + started_at: str + """ISO 8601 timestamp captured at registration""" + + attention_kind: AgentRegistryLiveTargetEntryAttentionKind | None = None + """Kind of attention required when status === "attention". Meaningful only when status === + "attention". + """ + branch: str | None = None + """Git branch of the session (when known)""" + + cwd: str | None = None + """Working directory of the session (when known)""" + + last_terminal_event: AgentRegistryLiveTargetEntryLastTerminalEvent | None = None + """How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done + from done_cancelled. + """ + model: str | None = None + """Model identifier currently selected for the session""" + + session_id: str | None = None + """Session ID of the foreground session for this entry""" + + session_name: str | None = None + """Friendly session name (when set)""" + + status: AgentRegistryLiveTargetEntryStatus | None = None + """Coarse lifecycle status of the foreground session""" + + status_revision: int | None = None + """Monotonic per-publisher revision counter incremented on every status update. Lets + watchers detect transient flips. + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + token: str | None = None + """Connection token (null when the target is unauthenticated)""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentRegistryLiveTargetEntry': + assert isinstance(obj, dict) + copilot_version = from_str(obj.get("copilotVersion")) + host = from_str(obj.get("host")) + kind = AgentRegistryLiveTargetEntryKind(obj.get("kind")) + last_seen_ms = from_int(obj.get("lastSeenMs")) + pid = from_int(obj.get("pid")) + port = from_int(obj.get("port")) + schema_version = from_int(obj.get("schemaVersion")) + started_at = from_str(obj.get("startedAt")) + attention_kind = from_union([AgentRegistryLiveTargetEntryAttentionKind, from_none], obj.get("attentionKind")) + branch = from_union([from_str, from_none], obj.get("branch")) + cwd = from_union([from_str, from_none], obj.get("cwd")) + last_terminal_event = from_union([AgentRegistryLiveTargetEntryLastTerminalEvent, from_none], obj.get("lastTerminalEvent")) + model = from_union([from_str, from_none], obj.get("model")) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + session_name = from_union([from_str, from_none], obj.get("sessionName")) + status = from_union([AgentRegistryLiveTargetEntryStatus, from_none], obj.get("status")) + status_revision = from_union([from_int, from_none], obj.get("statusRevision")) + token = from_union([from_none, from_str], obj.get("token")) + return AgentRegistryLiveTargetEntry(copilot_version, host, kind, last_seen_ms, pid, port, schema_version, started_at, attention_kind, branch, cwd, last_terminal_event, model, session_id, session_name, status, status_revision, token) + + def to_dict(self) -> dict: + result: dict = {} + result["copilotVersion"] = from_str(self.copilot_version) + result["host"] = from_str(self.host) + result["kind"] = to_enum(AgentRegistryLiveTargetEntryKind, self.kind) + result["lastSeenMs"] = from_int(self.last_seen_ms) + result["pid"] = from_int(self.pid) + result["port"] = from_int(self.port) + result["schemaVersion"] = from_int(self.schema_version) + result["startedAt"] = from_str(self.started_at) + if self.attention_kind is not None: + result["attentionKind"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryAttentionKind, x), from_none], self.attention_kind) + if self.branch is not None: + result["branch"] = from_union([from_str, from_none], self.branch) + if self.cwd is not None: + result["cwd"] = from_union([from_str, from_none], self.cwd) + if self.last_terminal_event is not None: + result["lastTerminalEvent"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryLastTerminalEvent, x), from_none], self.last_terminal_event) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) + if self.session_name is not None: + result["sessionName"] = from_union([from_str, from_none], self.session_name) + if self.status is not None: + result["status"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryStatus, x), from_none], self.status) + if self.status_revision is not None: + result["statusRevision"] = from_union([from_int, from_none], self.status_revision) + if self.token is not None: + result["token"] = from_union([from_none, from_str], self.token) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentRegistrySpawnRequest: + """Inputs to spawn a managed-server child via the controller's spawn delegate.""" + + cwd: str + """Working directory for the spawned child (must be an existing directory)""" + + agent_name: str | None = None + """Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own + default. + """ + initial_prompt: str | None = None + """Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it + post-attach via the standard LocalRpcSession.send path). + """ + model: str | None = None + """Model identifier to apply to the new session""" + + name: str | None = None + """Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing + whitespace, <=100 chars, no control chars, no double quotes. + """ + permission_mode: AgentRegistrySpawnPermissionMode | None = None + """Permission posture for the new session. 'yolo' requires the controller-local session to + currently be in allow-all mode. + """ + + @staticmethod + def from_dict(obj: Any) -> 'AgentRegistrySpawnRequest': + assert isinstance(obj, dict) + cwd = from_str(obj.get("cwd")) + agent_name = from_union([from_str, from_none], obj.get("agentName")) + initial_prompt = from_union([from_str, from_none], obj.get("initialPrompt")) + model = from_union([from_str, from_none], obj.get("model")) + name = from_union([from_str, from_none], obj.get("name")) + permission_mode = from_union([AgentRegistrySpawnPermissionMode, from_none], obj.get("permissionMode")) + return AgentRegistrySpawnRequest(cwd, agent_name, initial_prompt, model, name, permission_mode) + + def to_dict(self) -> dict: + result: dict = {} + result["cwd"] = from_str(self.cwd) + if self.agent_name is not None: + result["agentName"] = from_union([from_str, from_none], self.agent_name) + if self.initial_prompt is not None: + result["initialPrompt"] = from_union([from_str, from_none], self.initial_prompt) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.name is not None: + result["name"] = from_union([from_str, from_none], self.name) + if self.permission_mode is not None: + result["permissionMode"] = from_union([lambda x: to_enum(AgentRegistrySpawnPermissionMode, x), from_none], self.permission_mode) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AgentRegistrySpawnSpawned: + """Managed-server child was spawned and registered successfully.""" + + entry: AgentRegistryLiveTargetEntry + """Full registry entry for the spawned child. Lets the controller call + `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a + TOCTOU window). + """ + kind: ClassVar[str] = "spawned" + """Discriminator: managed-server child spawned successfully""" + + initial_prompt_error: str | None = None + """If the delegate attempted to send the initial prompt and failed, the categorized error + message. """ - enable_host_git_operations: bool | None = None - """Whether to enable host git operations (context resolution, child repo scanning, git info - in system prompt). + initial_prompt_sent: bool | None = None + """Whether the delegate already sent the initial prompt. Always omitted in the current + wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send + path. """ - enable_on_demand_instruction_discovery: bool | None = None - """Whether to discover custom instructions on demand after successful file views (AGENTS.md - / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with - `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. + log_capture: AgentRegistryLogCapture | None = None + """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" + + @staticmethod + def from_dict(obj: Any) -> 'AgentRegistrySpawnSpawned': + assert isinstance(obj, dict) + entry = AgentRegistryLiveTargetEntry.from_dict(obj.get("entry")) + initial_prompt_error = from_union([from_str, from_none], obj.get("initialPromptError")) + initial_prompt_sent = from_union([from_bool, from_none], obj.get("initialPromptSent")) + log_capture = from_union([AgentRegistryLogCapture.from_dict, from_none], obj.get("logCapture")) + return AgentRegistrySpawnSpawned(entry, initial_prompt_error, initial_prompt_sent, log_capture) + + def to_dict(self) -> dict: + result: dict = {} + result["entry"] = to_class(AgentRegistryLiveTargetEntry, self.entry) + result["kind"] = self.kind + if self.initial_prompt_error is not None: + result["initialPromptError"] = from_union([from_str, from_none], self.initial_prompt_error) + if self.initial_prompt_sent is not None: + result["initialPromptSent"] = from_union([from_bool, from_none], self.initial_prompt_sent) + if self.log_capture is not None: + result["logCapture"] = from_union([lambda x: to_class(AgentRegistryLogCapture, x), from_none], self.log_capture) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class APIKeyAuthInfo: + """Authentication-info variant for API-key authentication to a non-GitHub LLM provider, + carrying the secret `apiKey` and host. """ - enable_reasoning_summaries: bool | None = None - """Whether to surface reasoning-summary events from the model.""" + api_key: str + """The API key. Treat as a secret.""" - enable_script_safety: bool | None = None - """Whether shell-script safety heuristics are enabled.""" + host: str + """Authentication host.""" - enable_session_store: bool | None = None - """Whether to enable cross-session store writes and reads.""" + type: ClassVar[str] = "api-key" + """API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style).""" - enable_skills: bool | None = None - """Whether to enable skill directory scanning and loading. Falls back to - enableConfigDiscovery when unset. + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. """ - enable_streaming: bool | None = None - """Whether to stream model responses.""" - env_value_mode: MCPSetEnvValueModeDetails | None = None - """How env values are passed to MCP servers (`direct` inlines literal values; `indirect` - resolves at launch). + @staticmethod + def from_dict(obj: Any) -> 'APIKeyAuthInfo': + assert isinstance(obj, dict) + api_key = from_str(obj.get("apiKey")) + host = from_str(obj.get("host")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return APIKeyAuthInfo(api_key, host, copilot_user) + + def to_dict(self) -> dict: + result: dict = {} + result["apiKey"] = from_str(self.api_key) + result["host"] = from_str(self.host) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CopilotAPITokenAuthInfo: + """Authentication-info variant for direct Copilot API token auth sourced from environment + variables, with public GitHub host. """ - events_log_directory: str | None = None - """Override directory for the session-events log. When unset, the runtime's default events - log directory is used. + host: Host + """Authentication host (always the public GitHub host).""" + + type: ClassVar[str] = "copilot-api-token" + """Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` + environment-variable pair. The token itself is read from the environment by the runtime, + not carried in this struct. + """ + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. """ - excluded_tools: list[str] | None = None - """Denylist of tool names for this session.""" - feature_flags: dict[str, bool] | None = None - """Map of feature-flag IDs to their boolean enabled state.""" + @staticmethod + def from_dict(obj: Any) -> 'CopilotAPITokenAuthInfo': + assert isinstance(obj, dict) + host = Host(obj.get("host")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return CopilotAPITokenAuthInfo(host, copilot_user) - installed_plugins: list[SessionInstalledPlugin] | None = None - """Full set of installed plugins for the session. Replaces the existing list; the runtime - invalidates the skills cache only when the list materially changes. + def to_dict(self) -> dict: + result: dict = {} + result["host"] = to_enum(Host, self.host) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CurrentToolMetadata: + """Lightweight metadata for a currently initialized session tool""" + + description: str + """Tool description""" + + name: str + """Model-facing tool name""" + + defer_loading: bool | None = None + """Whether the tool is loaded on demand via tool search""" + + input_schema: dict[str, Any] | None = None + """JSON Schema for tool input""" + + mcp_server_name: str | None = None + """MCP server name for MCP-backed tools""" + + mcp_tool_name: str | None = None + """Raw MCP tool name for MCP-backed tools""" + + namespaced_name: str | None = None + """Optional MCP/config namespaced tool name""" + + @staticmethod + def from_dict(obj: Any) -> 'CurrentToolMetadata': + assert isinstance(obj, dict) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + defer_loading = from_union([from_bool, from_none], obj.get("deferLoading")) + input_schema = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("input_schema")) + mcp_server_name = from_union([from_str, from_none], obj.get("mcpServerName")) + mcp_tool_name = from_union([from_str, from_none], obj.get("mcpToolName")) + namespaced_name = from_union([from_str, from_none], obj.get("namespacedName")) + return CurrentToolMetadata(description, name, defer_loading, input_schema, mcp_server_name, mcp_tool_name, namespaced_name) + + def to_dict(self) -> dict: + result: dict = {} + result["description"] = from_str(self.description) + result["name"] = from_str(self.name) + if self.defer_loading is not None: + result["deferLoading"] = from_union([from_bool, from_none], self.defer_loading) + if self.input_schema is not None: + result["input_schema"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.input_schema) + if self.mcp_server_name is not None: + result["mcpServerName"] = from_union([from_str, from_none], self.mcp_server_name) + if self.mcp_tool_name is not None: + result["mcpToolName"] = from_union([from_str, from_none], self.mcp_tool_name) + if self.namespaced_name is not None: + result["namespacedName"] = from_union([from_str, from_none], self.namespaced_name) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class EnvAuthInfo: + """Authentication-info variant for a token sourced from an environment variable, with host, + optional login, token, and env var name. """ - integration_id: str | None = None - """Stable integration identifier used for analytics and rate-limit attribution.""" + env_var: str + """Name of the environment variable the token was sourced from.""" - is_experimental_mode: bool | None = None - """Whether experimental capabilities are enabled.""" + host: str + """Authentication host (e.g. https://github.com or a GHES host).""" - log_interactive_shells: bool | None = None - """Whether interactive shell sessions are logged.""" + token: str + """The token value itself. Treat as a secret.""" - lsp_client_name: str | None = None - """Identifier sent to LSP-style integrations.""" + type: ClassVar[str] = "env" + """Personal access token (PAT) or server-to-server token sourced from an environment + variable. + """ + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ + login: str | None = None + """User login associated with the token. Undefined for server-to-server tokens (those + starting with `ghs_`). + """ + + @staticmethod + def from_dict(obj: Any) -> 'EnvAuthInfo': + assert isinstance(obj, dict) + env_var = from_str(obj.get("envVar")) + host = from_str(obj.get("host")) + token = from_str(obj.get("token")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + login = from_union([from_str, from_none], obj.get("login")) + return EnvAuthInfo(env_var, host, token, copilot_user, login) + + def to_dict(self) -> dict: + result: dict = {} + result["envVar"] = from_str(self.env_var) + result["host"] = from_str(self.host) + result["token"] = from_str(self.token) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + if self.login is not None: + result["login"] = from_union([from_str, from_none], self.login) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class GhCLIAuthInfo: + """Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh + auth token` value. + """ + host: str + """Authentication host.""" + + login: str + """User login as reported by `gh auth status`.""" + + token: str + """The token returned by `gh auth token`. Treat as a secret.""" + + type: ClassVar[str] = "gh-cli" + """Authentication via the `gh` CLI's saved credentials.""" + + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ + + @staticmethod + def from_dict(obj: Any) -> 'GhCLIAuthInfo': + assert isinstance(obj, dict) + host = from_str(obj.get("host")) + login = from_str(obj.get("login")) + token = from_str(obj.get("token")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return GhCLIAuthInfo(host, login, token, copilot_user) - manage_schedule_enabled: bool | None = None - """Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the - per-session schedule registry; this flag only controls tool exposure (typically gated to - staff users). - """ - model: str | None = None - """The model ID to use for assistant turns.""" + def to_dict(self) -> dict: + result: dict = {} + result["host"] = from_str(self.host) + result["login"] = from_str(self.login) + result["token"] = from_str(self.token) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + return result - organization_custom_instructions: str | None = None - """Organization-level custom instructions to inject into the system prompt.""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class GitHubTelemetryEvent: + """A single telemetry event in the runtime's native GitHub-shaped telemetry format, + forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing + GitHubTelemetryNotification distinguishes standard from restricted events; the payload + shape is identical for both. - provider: Any = None - """Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the - runtime. + The telemetry event, in the runtime's native GitHub-shaped telemetry format. """ - reasoning_effort: str | None = None - """Reasoning effort for the selected model (model-defined enum).""" + kind: str + """Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed).""" - running_in_interactive_mode: bool | None = None - """Whether the session is running in an interactive UI.""" + metrics: dict[str, float] + """Numeric metrics as a map from key to value.""" - sandbox_config: Any = None - """Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime.""" + properties: dict[str, str] + """String-valued properties as a map from key to value.""" - shell_init_profile: str | None = None - """Shell init profile (`None` or `NonInteractive`).""" + client: GitHubTelemetryClientInfo | None = None + """Client environment metadata.""" - shell_process_flags: list[str] | None = None - """Per-shell process flags (e.g., `pwsh` arguments).""" + copilot_tracking_id: str | None = None + """Copilot tracking ID for user-level attribution.""" - skill_directories: list[str] | None = None - """Additional directories to search for skills.""" + created_at: str | None = None + """Timestamp when the event was created (ISO 8601 format).""" - skip_custom_instructions: bool | None = None - """Whether to skip loading custom instruction sources.""" + exp_assignment_context: str | None = None + """Experiment assignment context.""" - skip_embedding_retrieval: bool | None = None - """Whether to skip embedding retrieval pipeline initialization and execution.""" + features: dict[str, str] | None = None + """Feature flags enabled for this session, as a map from flag to value.""" - tool_filter_precedence: OptionsUpdateToolFilterPrecedence | None = None - """Controls how availableTools (allowlist) and excludedTools (denylist) combine when both - are set. - """ - trajectory_file: str | None = None - """Optional path for trajectory output.""" + model_call_id: str | None = None + """Reference to the model call that produced this event.""" - working_directory: str | None = None - """Absolute working-directory path for shell tools.""" + session_id: str | None = None + """Session identifier the event belongs to.""" @staticmethod - def from_dict(obj: Any) -> 'SessionUpdateOptionsParams': + def from_dict(obj: Any) -> 'GitHubTelemetryEvent': assert isinstance(obj, dict) - additional_content_exclusion_policies = from_union([lambda x: from_list(lambda x: x, x), from_none], obj.get("additionalContentExclusionPolicies")) - agent_context = from_union([from_str, from_none], obj.get("agentContext")) - ask_user_disabled = from_union([from_bool, from_none], obj.get("askUserDisabled")) - available_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("availableTools")) - client_name = from_union([from_str, from_none], obj.get("clientName")) - coauthor_enabled = from_union([from_bool, from_none], obj.get("coauthorEnabled")) - continue_on_auto_mode = from_union([from_bool, from_none], obj.get("continueOnAutoMode")) - copilot_url = from_union([from_str, from_none], obj.get("copilotUrl")) - custom_agents_local_only = from_union([from_bool, from_none], obj.get("customAgentsLocalOnly")) - disabled_instruction_sources = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledInstructionSources")) - disabled_skills = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledSkills")) - enable_file_hooks = from_union([from_bool, from_none], obj.get("enableFileHooks")) - enable_host_git_operations = from_union([from_bool, from_none], obj.get("enableHostGitOperations")) - enable_on_demand_instruction_discovery = from_union([from_bool, from_none], obj.get("enableOnDemandInstructionDiscovery")) - enable_reasoning_summaries = from_union([from_bool, from_none], obj.get("enableReasoningSummaries")) - enable_script_safety = from_union([from_bool, from_none], obj.get("enableScriptSafety")) - enable_session_store = from_union([from_bool, from_none], obj.get("enableSessionStore")) - enable_skills = from_union([from_bool, from_none], obj.get("enableSkills")) - enable_streaming = from_union([from_bool, from_none], obj.get("enableStreaming")) - env_value_mode = from_union([MCPSetEnvValueModeDetails, from_none], obj.get("envValueMode")) - events_log_directory = from_union([from_str, from_none], obj.get("eventsLogDirectory")) - excluded_tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get("excludedTools")) - feature_flags = from_union([lambda x: from_dict(from_bool, x), from_none], obj.get("featureFlags")) - installed_plugins = from_union([lambda x: from_list(SessionInstalledPlugin.from_dict, x), from_none], obj.get("installedPlugins")) - integration_id = from_union([from_str, from_none], obj.get("integrationId")) - is_experimental_mode = from_union([from_bool, from_none], obj.get("isExperimentalMode")) - log_interactive_shells = from_union([from_bool, from_none], obj.get("logInteractiveShells")) - lsp_client_name = from_union([from_str, from_none], obj.get("lspClientName")) - manage_schedule_enabled = from_union([from_bool, from_none], obj.get("manageScheduleEnabled")) - model = from_union([from_str, from_none], obj.get("model")) - organization_custom_instructions = from_union([from_str, from_none], obj.get("organizationCustomInstructions")) - provider = obj.get("provider") - reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) - running_in_interactive_mode = from_union([from_bool, from_none], obj.get("runningInInteractiveMode")) - sandbox_config = obj.get("sandboxConfig") - shell_init_profile = from_union([from_str, from_none], obj.get("shellInitProfile")) - shell_process_flags = from_union([lambda x: from_list(from_str, x), from_none], obj.get("shellProcessFlags")) - skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get("skillDirectories")) - skip_custom_instructions = from_union([from_bool, from_none], obj.get("skipCustomInstructions")) - skip_embedding_retrieval = from_union([from_bool, from_none], obj.get("skipEmbeddingRetrieval")) - tool_filter_precedence = from_union([OptionsUpdateToolFilterPrecedence, from_none], obj.get("toolFilterPrecedence")) - trajectory_file = from_union([from_str, from_none], obj.get("trajectoryFile")) - working_directory = from_union([from_str, from_none], obj.get("workingDirectory")) - return SessionUpdateOptionsParams(additional_content_exclusion_policies, agent_context, ask_user_disabled, available_tools, client_name, coauthor_enabled, continue_on_auto_mode, copilot_url, custom_agents_local_only, disabled_instruction_sources, disabled_skills, enable_file_hooks, enable_host_git_operations, enable_on_demand_instruction_discovery, enable_reasoning_summaries, enable_script_safety, enable_session_store, enable_skills, enable_streaming, env_value_mode, events_log_directory, excluded_tools, feature_flags, installed_plugins, integration_id, is_experimental_mode, log_interactive_shells, lsp_client_name, manage_schedule_enabled, model, organization_custom_instructions, provider, reasoning_effort, running_in_interactive_mode, sandbox_config, shell_init_profile, shell_process_flags, skill_directories, skip_custom_instructions, skip_embedding_retrieval, tool_filter_precedence, trajectory_file, working_directory) + kind = from_str(obj.get("kind")) + metrics = from_dict(from_float, obj.get("metrics")) + properties = from_dict(from_str, obj.get("properties")) + client = from_union([GitHubTelemetryClientInfo.from_dict, from_none], obj.get("client")) + copilot_tracking_id = from_union([from_str, from_none], obj.get("copilot_tracking_id")) + created_at = from_union([from_str, from_none], obj.get("created_at")) + exp_assignment_context = from_union([from_str, from_none], obj.get("exp_assignment_context")) + features = from_union([lambda x: from_dict(from_str, x), from_none], obj.get("features")) + model_call_id = from_union([from_str, from_none], obj.get("model_call_id")) + session_id = from_union([from_str, from_none], obj.get("session_id")) + return GitHubTelemetryEvent(kind, metrics, properties, client, copilot_tracking_id, created_at, exp_assignment_context, features, model_call_id, session_id) def to_dict(self) -> dict: result: dict = {} - if self.additional_content_exclusion_policies is not None: - result["additionalContentExclusionPolicies"] = from_union([lambda x: from_list(lambda x: x, x), from_none], self.additional_content_exclusion_policies) - if self.agent_context is not None: - result["agentContext"] = from_union([from_str, from_none], self.agent_context) - if self.ask_user_disabled is not None: - result["askUserDisabled"] = from_union([from_bool, from_none], self.ask_user_disabled) - if self.available_tools is not None: - result["availableTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.available_tools) - if self.client_name is not None: - result["clientName"] = from_union([from_str, from_none], self.client_name) - if self.coauthor_enabled is not None: - result["coauthorEnabled"] = from_union([from_bool, from_none], self.coauthor_enabled) - if self.continue_on_auto_mode is not None: - result["continueOnAutoMode"] = from_union([from_bool, from_none], self.continue_on_auto_mode) - if self.copilot_url is not None: - result["copilotUrl"] = from_union([from_str, from_none], self.copilot_url) - if self.custom_agents_local_only is not None: - result["customAgentsLocalOnly"] = from_union([from_bool, from_none], self.custom_agents_local_only) - if self.disabled_instruction_sources is not None: - result["disabledInstructionSources"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_instruction_sources) - if self.disabled_skills is not None: - result["disabledSkills"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_skills) - if self.enable_file_hooks is not None: - result["enableFileHooks"] = from_union([from_bool, from_none], self.enable_file_hooks) - if self.enable_host_git_operations is not None: - result["enableHostGitOperations"] = from_union([from_bool, from_none], self.enable_host_git_operations) - if self.enable_on_demand_instruction_discovery is not None: - result["enableOnDemandInstructionDiscovery"] = from_union([from_bool, from_none], self.enable_on_demand_instruction_discovery) - if self.enable_reasoning_summaries is not None: - result["enableReasoningSummaries"] = from_union([from_bool, from_none], self.enable_reasoning_summaries) - if self.enable_script_safety is not None: - result["enableScriptSafety"] = from_union([from_bool, from_none], self.enable_script_safety) - if self.enable_session_store is not None: - result["enableSessionStore"] = from_union([from_bool, from_none], self.enable_session_store) - if self.enable_skills is not None: - result["enableSkills"] = from_union([from_bool, from_none], self.enable_skills) - if self.enable_streaming is not None: - result["enableStreaming"] = from_union([from_bool, from_none], self.enable_streaming) - if self.env_value_mode is not None: - result["envValueMode"] = from_union([lambda x: to_enum(MCPSetEnvValueModeDetails, x), from_none], self.env_value_mode) - if self.events_log_directory is not None: - result["eventsLogDirectory"] = from_union([from_str, from_none], self.events_log_directory) - if self.excluded_tools is not None: - result["excludedTools"] = from_union([lambda x: from_list(from_str, x), from_none], self.excluded_tools) - if self.feature_flags is not None: - result["featureFlags"] = from_union([lambda x: from_dict(from_bool, x), from_none], self.feature_flags) - if self.installed_plugins is not None: - result["installedPlugins"] = from_union([lambda x: from_list(lambda x: to_class(SessionInstalledPlugin, x), x), from_none], self.installed_plugins) - if self.integration_id is not None: - result["integrationId"] = from_union([from_str, from_none], self.integration_id) - if self.is_experimental_mode is not None: - result["isExperimentalMode"] = from_union([from_bool, from_none], self.is_experimental_mode) - if self.log_interactive_shells is not None: - result["logInteractiveShells"] = from_union([from_bool, from_none], self.log_interactive_shells) - if self.lsp_client_name is not None: - result["lspClientName"] = from_union([from_str, from_none], self.lsp_client_name) - if self.manage_schedule_enabled is not None: - result["manageScheduleEnabled"] = from_union([from_bool, from_none], self.manage_schedule_enabled) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) - if self.organization_custom_instructions is not None: - result["organizationCustomInstructions"] = from_union([from_str, from_none], self.organization_custom_instructions) - if self.provider is not None: - result["provider"] = self.provider - if self.reasoning_effort is not None: - result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) - if self.running_in_interactive_mode is not None: - result["runningInInteractiveMode"] = from_union([from_bool, from_none], self.running_in_interactive_mode) - if self.sandbox_config is not None: - result["sandboxConfig"] = self.sandbox_config - if self.shell_init_profile is not None: - result["shellInitProfile"] = from_union([from_str, from_none], self.shell_init_profile) - if self.shell_process_flags is not None: - result["shellProcessFlags"] = from_union([lambda x: from_list(from_str, x), from_none], self.shell_process_flags) - if self.skill_directories is not None: - result["skillDirectories"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories) - if self.skip_custom_instructions is not None: - result["skipCustomInstructions"] = from_union([from_bool, from_none], self.skip_custom_instructions) - if self.skip_embedding_retrieval is not None: - result["skipEmbeddingRetrieval"] = from_union([from_bool, from_none], self.skip_embedding_retrieval) - if self.tool_filter_precedence is not None: - result["toolFilterPrecedence"] = from_union([lambda x: to_enum(OptionsUpdateToolFilterPrecedence, x), from_none], self.tool_filter_precedence) - if self.trajectory_file is not None: - result["trajectoryFile"] = from_union([from_str, from_none], self.trajectory_file) - if self.working_directory is not None: - result["workingDirectory"] = from_union([from_str, from_none], self.working_directory) + result["kind"] = from_str(self.kind) + result["metrics"] = from_dict(to_float, self.metrics) + result["properties"] = from_dict(from_str, self.properties) + if self.client is not None: + result["client"] = from_union([lambda x: to_class(GitHubTelemetryClientInfo, x), from_none], self.client) + if self.copilot_tracking_id is not None: + result["copilot_tracking_id"] = from_union([from_str, from_none], self.copilot_tracking_id) + if self.created_at is not None: + result["created_at"] = from_union([from_str, from_none], self.created_at) + if self.exp_assignment_context is not None: + result["exp_assignment_context"] = from_union([from_str, from_none], self.exp_assignment_context) + if self.features is not None: + result["features"] = from_union([lambda x: from_dict(from_str, x), from_none], self.features) + if self.model_call_id is not None: + result["model_call_id"] = from_union([from_str, from_none], self.model_call_id) + if self.session_id is not None: + result["session_id"] = from_union([from_str, from_none], self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class UIElicitationRequest: - """Prompt message and JSON schema describing the form fields to elicit from the user.""" - - message: str - """Message describing what information is needed from the user""" +class GitHubTelemetryNotification: + """Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the + runtime forwards to a host connection that opted into telemetry forwarding during the + `server.connect` handshake. + """ + event: GitHubTelemetryEvent + """The telemetry event, in the runtime's native GitHub-shaped telemetry format.""" - requested_schema: UIElicitationSchema - """JSON Schema describing the form fields to present to the user""" + restricted: bool + """Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route + restricted events to first-party Microsoft stores only. + """ + session_id: str | None = None + """Session the telemetry event belongs to, when it is session-scoped. Omitted for + sessionless events (for example, `server.sendTelemetry` calls with no session id), which + are still forwarded to opted-in connections. + """ @staticmethod - def from_dict(obj: Any) -> 'UIElicitationRequest': + def from_dict(obj: Any) -> 'GitHubTelemetryNotification': assert isinstance(obj, dict) - message = from_str(obj.get("message")) - requested_schema = UIElicitationSchema.from_dict(obj.get("requestedSchema")) - return UIElicitationRequest(message, requested_schema) + event = GitHubTelemetryEvent.from_dict(obj.get("event")) + restricted = from_bool(obj.get("restricted")) + session_id = from_union([from_str, from_none], obj.get("sessionId")) + return GitHubTelemetryNotification(event, restricted, session_id) def to_dict(self) -> dict: result: dict = {} - result["message"] = from_str(self.message) - result["requestedSchema"] = to_class(UIElicitationSchema, self.requested_schema) + result["event"] = to_class(GitHubTelemetryEvent, self.event) + result["restricted"] = from_bool(self.restricted) + if self.session_id is not None: + result["sessionId"] = from_union([from_str, from_none], self.session_id) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistryLiveTargetEntry: - """Full registry entry for the spawned child. Lets the controller call - `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a - TOCTOU window). +class HMACAuthInfo: + """Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub + host and HMAC secret. """ - copilot_version: str - """Copilot CLI version that wrote the entry""" - - host: str - """Bind host for the entry's JSON-RPC server""" + hmac: str + """HMAC secret used to sign requests.""" - kind: AgentRegistryLiveTargetEntryKind - """Process kind tag for the registry entry""" + host: Host + """Authentication host. HMAC auth always targets the public GitHub host.""" - last_seen_ms: int - """Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness)""" + type: ClassVar[str] = "hmac" + """HMAC-based authentication used by GitHub-internal services.""" - pid: int - """Operating-system pid of the process owning this entry""" + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ - port: int - """TCP port the entry's JSON-RPC server is listening on""" + @staticmethod + def from_dict(obj: Any) -> 'HMACAuthInfo': + assert isinstance(obj, dict) + hmac = from_str(obj.get("hmac")) + host = Host(obj.get("host")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return HMACAuthInfo(hmac, host, copilot_user) - schema_version: int - """Registry entry schema version (1 = ui-server, 2 = managed-server)""" + def to_dict(self) -> dict: + result: dict = {} + result["hmac"] = from_str(self.hmac) + result["host"] = to_enum(Host, self.host) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) + return result - started_at: str - """ISO 8601 timestamp captured at registration""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPExecuteSamplingParams: + """Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.""" - attention_kind: AgentRegistryLiveTargetEntryAttentionKind | None = None - """Kind of attention required when status === "attention". Meaningful only when status === - "attention". + request: dict[str, Any] + """Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. + Treated as opaque at the schema layer; the runtime converts the embedded MCP messages + into the OpenAI chat-completion shape internally. """ - branch: str | None = None - """Git branch of the session (when known)""" - - cwd: str | None = None - """Working directory of the session (when known)""" + request_id: str + """Caller-provided unique identifier for this sampling execution. Use this same ID with + cancelSamplingExecution to cancel the in-flight call. Must be unique within the session + for the lifetime of the call. + """ + server_name: str + """Name of the MCP server that initiated the sampling request""" - last_terminal_event: AgentRegistryLiveTargetEntryLastTerminalEvent | None = None - """How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done - from done_cancelled. + mcp_request_id: Any = None + """The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate + the inference with the originating MCP request for telemetry; this is distinct from + `requestId` (which is the schema-level cancellation handle). """ - model: str | None = None - """Model identifier currently selected for the session""" + @staticmethod + def from_dict(obj: Any) -> 'MCPExecuteSamplingParams': + assert isinstance(obj, dict) + mcp_request_id = obj.get("mcpRequestId") + request = from_dict(lambda x: x, obj.get("request")) + request_id = from_str(obj.get("requestId")) + server_name = from_str(obj.get("serverName")) + return MCPExecuteSamplingParams(mcp_request_id, request, request_id, server_name) - session_id: str | None = None - """Session ID of the foreground session for this entry""" + def to_dict(self) -> dict: + result: dict = {} + result["mcpRequestId"] = self.mcp_request_id + result["request"] = from_dict(lambda x: x, self.request) + result["requestId"] = from_str(self.request_id) + result["serverName"] = from_str(self.server_name) + return result - session_name: str | None = None - """Friendly session name (when set)""" +# Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class MCPRegisterExternalClientRequest: + """Registration parameters for an external MCP client.""" - status: AgentRegistryLiveTargetEntryStatus | None = None - """Coarse lifecycle status of the foreground session""" + server_name: str + """Logical server name for the external client""" - status_revision: int | None = None - """Monotonic per-publisher revision counter incremented on every status update. Lets - watchers detect transient flips. + client: Any = None + """In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC + boundary. + """ + config: Any = None + """In-process server config (MCPServerConfig) paired with the in-process client/transport. + Marked internal alongside its companions. + """ + transport: Any = None + """In-process MCP Transport instance. Marked internal: cannot be serialized across the + JSON-RPC boundary. """ - # Internal: this field is an internal SDK API and is not part of the public surface. - token: str | None = None - """Connection token (null when the target is unauthenticated)""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistryLiveTargetEntry': + def from_dict(obj: Any) -> 'MCPRegisterExternalClientRequest': assert isinstance(obj, dict) - copilot_version = from_str(obj.get("copilotVersion")) - host = from_str(obj.get("host")) - kind = AgentRegistryLiveTargetEntryKind(obj.get("kind")) - last_seen_ms = from_int(obj.get("lastSeenMs")) - pid = from_int(obj.get("pid")) - port = from_int(obj.get("port")) - schema_version = from_int(obj.get("schemaVersion")) - started_at = from_str(obj.get("startedAt")) - attention_kind = from_union([AgentRegistryLiveTargetEntryAttentionKind, from_none], obj.get("attentionKind")) - branch = from_union([from_str, from_none], obj.get("branch")) - cwd = from_union([from_str, from_none], obj.get("cwd")) - last_terminal_event = from_union([AgentRegistryLiveTargetEntryLastTerminalEvent, from_none], obj.get("lastTerminalEvent")) - model = from_union([from_str, from_none], obj.get("model")) - session_id = from_union([from_str, from_none], obj.get("sessionId")) - session_name = from_union([from_str, from_none], obj.get("sessionName")) - status = from_union([AgentRegistryLiveTargetEntryStatus, from_none], obj.get("status")) - status_revision = from_union([from_int, from_none], obj.get("statusRevision")) - token = from_union([from_none, from_str], obj.get("token")) - return AgentRegistryLiveTargetEntry(copilot_version, host, kind, last_seen_ms, pid, port, schema_version, started_at, attention_kind, branch, cwd, last_terminal_event, model, session_id, session_name, status, status_revision, token) + client = obj.get("client") + config = obj.get("config") + server_name = from_str(obj.get("serverName")) + transport = obj.get("transport") + return MCPRegisterExternalClientRequest(client, config, server_name, transport) def to_dict(self) -> dict: result: dict = {} - result["copilotVersion"] = from_str(self.copilot_version) - result["host"] = from_str(self.host) - result["kind"] = to_enum(AgentRegistryLiveTargetEntryKind, self.kind) - result["lastSeenMs"] = from_int(self.last_seen_ms) - result["pid"] = from_int(self.pid) - result["port"] = from_int(self.port) - result["schemaVersion"] = from_int(self.schema_version) - result["startedAt"] = from_str(self.started_at) - if self.attention_kind is not None: - result["attentionKind"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryAttentionKind, x), from_none], self.attention_kind) - if self.branch is not None: - result["branch"] = from_union([from_str, from_none], self.branch) - if self.cwd is not None: - result["cwd"] = from_union([from_str, from_none], self.cwd) - if self.last_terminal_event is not None: - result["lastTerminalEvent"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryLastTerminalEvent, x), from_none], self.last_terminal_event) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) - if self.session_id is not None: - result["sessionId"] = from_union([from_str, from_none], self.session_id) - if self.session_name is not None: - result["sessionName"] = from_union([from_str, from_none], self.session_name) - if self.status is not None: - result["status"] = from_union([lambda x: to_enum(AgentRegistryLiveTargetEntryStatus, x), from_none], self.status) - if self.status_revision is not None: - result["statusRevision"] = from_union([from_int, from_none], self.status_revision) - if self.token is not None: - result["token"] = from_union([from_none, from_str], self.token) + result["client"] = self.client + result["config"] = self.config + result["serverName"] = from_str(self.server_name) + result["transport"] = self.transport return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistrySpawnRequest: - """Inputs to spawn a managed-server child via the controller's spawn delegate.""" +class MCPResourceAnnotations: + """Model/client annotations associated with this resource - cwd: str - """Working directory for the spawned child (must be an existing directory)""" + Standard MCP resource annotations plus preserved non-standard annotation fields. - agent_name: str | None = None - """Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own - default. - """ - initial_prompt: str | None = None - """Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it - post-attach via the standard LocalRpcSession.send path). + Model/client annotations associated with this template """ - model: str | None = None - """Model identifier to apply to the new session""" + additional_properties: dict[str, Any] | None = None + """Server-provided non-standard annotation fields preserved from the MCP response""" - name: str | None = None - """Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing - whitespace, <=100 chars, no control chars, no double quotes. - """ - permission_mode: AgentRegistrySpawnPermissionMode | None = None - """Permission posture for the new session. 'yolo' requires the controller-local session to - currently be in allow-all mode. - """ + audience: list[str] | None = None + """Intended audience roles for this resource""" + + last_modified: str | None = None + """Last-modified timestamp hint""" + + priority: float | None = None + """Priority hint for model/client use""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistrySpawnRequest': + def from_dict(obj: Any) -> 'MCPResourceAnnotations': assert isinstance(obj, dict) - cwd = from_str(obj.get("cwd")) - agent_name = from_union([from_str, from_none], obj.get("agentName")) - initial_prompt = from_union([from_str, from_none], obj.get("initialPrompt")) - model = from_union([from_str, from_none], obj.get("model")) - name = from_union([from_str, from_none], obj.get("name")) - permission_mode = from_union([AgentRegistrySpawnPermissionMode, from_none], obj.get("permissionMode")) - return AgentRegistrySpawnRequest(cwd, agent_name, initial_prompt, model, name, permission_mode) + additional_properties = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("additionalProperties")) + audience = from_union([lambda x: from_list(from_str, x), from_none], obj.get("audience")) + last_modified = from_union([from_str, from_none], obj.get("lastModified")) + priority = from_union([from_float, from_none], obj.get("priority")) + return MCPResourceAnnotations(additional_properties, audience, last_modified, priority) def to_dict(self) -> dict: result: dict = {} - result["cwd"] = from_str(self.cwd) - if self.agent_name is not None: - result["agentName"] = from_union([from_str, from_none], self.agent_name) - if self.initial_prompt is not None: - result["initialPrompt"] = from_union([from_str, from_none], self.initial_prompt) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) - if self.name is not None: - result["name"] = from_union([from_str, from_none], self.name) - if self.permission_mode is not None: - result["permissionMode"] = from_union([lambda x: to_enum(AgentRegistrySpawnPermissionMode, x), from_none], self.permission_mode) + if self.additional_properties is not None: + result["additionalProperties"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.additional_properties) + if self.audience is not None: + result["audience"] = from_union([lambda x: from_list(from_str, x), from_none], self.audience) + if self.last_modified is not None: + result["lastModified"] = from_union([from_str, from_none], self.last_modified) + if self.priority is not None: + result["priority"] = from_union([to_float, from_none], self.priority) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class AgentRegistrySpawnSpawned: - """Managed-server child was spawned and registered successfully.""" - - entry: AgentRegistryLiveTargetEntry - """Full registry entry for the spawned child. Lets the controller call - `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a - TOCTOU window). +class MCPResource: + """An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, + MIME type, size, icons, annotations, and metadata. Server-provided fields outside the + standard descriptor shape are exposed under `additionalProperties`. """ - kind: ClassVar[str] = "spawned" - """Discriminator: managed-server child spawned successfully""" + name: str + """The programmatic name of the resource""" - initial_prompt_error: str | None = None - """If the delegate attempted to send the initial prompt and failed, the categorized error - message. - """ - initial_prompt_sent: bool | None = None - """Whether the delegate already sent the initial prompt. Always omitted in the current - wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send - path. - """ - log_capture: AgentRegistryLogCapture | None = None - """Per-spawn log-capture outcome; populated from spawnLiveTarget.""" + uri: str + """The resource URI (e.g. ui://... or file:///...)""" + + meta: dict[str, Any] | None = None + """Resource-level metadata""" + + additional_properties: dict[str, Any] | None = None + """Server-provided non-standard descriptor fields preserved from the MCP response""" + + annotations: MCPResourceAnnotations | None = None + """Model/client annotations associated with this resource""" + + description: str | None = None + """Optional description of what this resource represents""" + + icons: list[MCPResourceIcon] | None = None + """Icons associated with this resource""" + + mime_type: str | None = None + """MIME type of the resource, if known""" + + size: int | None = None + """Resource size in bytes, when known""" + + title: str | None = None + """Optional human-readable display title""" @staticmethod - def from_dict(obj: Any) -> 'AgentRegistrySpawnSpawned': + def from_dict(obj: Any) -> 'MCPResource': assert isinstance(obj, dict) - entry = AgentRegistryLiveTargetEntry.from_dict(obj.get("entry")) - initial_prompt_error = from_union([from_str, from_none], obj.get("initialPromptError")) - initial_prompt_sent = from_union([from_bool, from_none], obj.get("initialPromptSent")) - log_capture = from_union([AgentRegistryLogCapture.from_dict, from_none], obj.get("logCapture")) - return AgentRegistrySpawnSpawned(entry, initial_prompt_error, initial_prompt_sent, log_capture) + name = from_str(obj.get("name")) + uri = from_str(obj.get("uri")) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) + additional_properties = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("additionalProperties")) + annotations = from_union([MCPResourceAnnotations.from_dict, from_none], obj.get("annotations")) + description = from_union([from_str, from_none], obj.get("description")) + icons = from_union([lambda x: from_list(MCPResourceIcon.from_dict, x), from_none], obj.get("icons")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + size = from_union([from_int, from_none], obj.get("size")) + title = from_union([from_str, from_none], obj.get("title")) + return MCPResource(name, uri, meta, additional_properties, annotations, description, icons, mime_type, size, title) def to_dict(self) -> dict: result: dict = {} - result["entry"] = to_class(AgentRegistryLiveTargetEntry, self.entry) - result["kind"] = self.kind - if self.initial_prompt_error is not None: - result["initialPromptError"] = from_union([from_str, from_none], self.initial_prompt_error) - if self.initial_prompt_sent is not None: - result["initialPromptSent"] = from_union([from_bool, from_none], self.initial_prompt_sent) - if self.log_capture is not None: - result["logCapture"] = from_union([lambda x: to_class(AgentRegistryLogCapture, x), from_none], self.log_capture) + result["name"] = from_str(self.name) + result["uri"] = from_str(self.uri) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) + if self.additional_properties is not None: + result["additionalProperties"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.additional_properties) + if self.annotations is not None: + result["annotations"] = from_union([lambda x: to_class(MCPResourceAnnotations, x), from_none], self.annotations) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.icons is not None: + result["icons"] = from_union([lambda x: from_list(lambda x: to_class(MCPResourceIcon, x), x), from_none], self.icons) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.size is not None: + result["size"] = from_union([from_int, from_none], self.size) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class CurrentToolMetadata: - """Lightweight metadata for a currently initialized session tool""" +class MCPResourceTemplate: + """An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, + name, and optional title, description, MIME type, icons, annotations, and metadata. + Server-provided fields outside the standard descriptor shape are exposed under + `additionalProperties`. + """ + name: str + """The programmatic name of the resource template""" - description: str - """Tool description""" + uri_template: str + """An RFC 6570 URI template for constructing resource URIs""" - name: str - """Model-facing tool name""" + meta: dict[str, Any] | None = None + """Resource-template-level metadata""" - defer_loading: bool | None = None - """Whether the tool is loaded on demand via tool search""" + additional_properties: dict[str, Any] | None = None + """Server-provided non-standard descriptor fields preserved from the MCP response""" - input_schema: dict[str, Any] | None = None - """JSON Schema for tool input""" + annotations: MCPResourceAnnotations | None = None + """Model/client annotations associated with this template""" - mcp_server_name: str | None = None - """MCP server name for MCP-backed tools""" + description: str | None = None + """Optional description of what this template is for""" - mcp_tool_name: str | None = None - """Raw MCP tool name for MCP-backed tools""" + icons: list[MCPResourceIcon] | None = None + """Icons associated with resources matching this template""" - namespaced_name: str | None = None - """Optional MCP/config namespaced tool name""" + mime_type: str | None = None + """MIME type for resources matching this template, if uniform""" + + title: str | None = None + """Optional human-readable display title""" + + @staticmethod + def from_dict(obj: Any) -> 'MCPResourceTemplate': + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + uri_template = from_str(obj.get("uriTemplate")) + meta = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("_meta")) + additional_properties = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("additionalProperties")) + annotations = from_union([MCPResourceAnnotations.from_dict, from_none], obj.get("annotations")) + description = from_union([from_str, from_none], obj.get("description")) + icons = from_union([lambda x: from_list(MCPResourceIcon.from_dict, x), from_none], obj.get("icons")) + mime_type = from_union([from_str, from_none], obj.get("mimeType")) + title = from_union([from_str, from_none], obj.get("title")) + return MCPResourceTemplate(name, uri_template, meta, additional_properties, annotations, description, icons, mime_type, title) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["uriTemplate"] = from_str(self.uri_template) + if self.meta is not None: + result["_meta"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.meta) + if self.additional_properties is not None: + result["additionalProperties"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.additional_properties) + if self.annotations is not None: + result["annotations"] = from_union([lambda x: to_class(MCPResourceAnnotations, x), from_none], self.annotations) + if self.description is not None: + result["description"] = from_union([from_str, from_none], self.description) + if self.icons is not None: + result["icons"] = from_union([lambda x: from_list(lambda x: to_class(MCPResourceIcon, x), x), from_none], self.icons) + if self.mime_type is not None: + result["mimeType"] = from_union([from_str, from_none], self.mime_type) + if self.title is not None: + result["title"] = from_union([from_str, from_none], self.title) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class MCPResourcesListResult: + """One page of resources advertised by the named MCP server.""" + + resources: list[MCPResource] + """Resources advertised by the server (proxied MCP `resources/list`)""" + + next_cursor: str | None = None + """Opaque cursor for the next page, if the server has more resources""" @staticmethod - def from_dict(obj: Any) -> 'CurrentToolMetadata': + def from_dict(obj: Any) -> 'MCPResourcesListResult': assert isinstance(obj, dict) - description = from_str(obj.get("description")) - name = from_str(obj.get("name")) - defer_loading = from_union([from_bool, from_none], obj.get("deferLoading")) - input_schema = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get("input_schema")) - mcp_server_name = from_union([from_str, from_none], obj.get("mcpServerName")) - mcp_tool_name = from_union([from_str, from_none], obj.get("mcpToolName")) - namespaced_name = from_union([from_str, from_none], obj.get("namespacedName")) - return CurrentToolMetadata(description, name, defer_loading, input_schema, mcp_server_name, mcp_tool_name, namespaced_name) + resources = from_list(MCPResource.from_dict, obj.get("resources")) + next_cursor = from_union([from_str, from_none], obj.get("nextCursor")) + return MCPResourcesListResult(resources, next_cursor) def to_dict(self) -> dict: result: dict = {} - result["description"] = from_str(self.description) - result["name"] = from_str(self.name) - if self.defer_loading is not None: - result["deferLoading"] = from_union([from_bool, from_none], self.defer_loading) - if self.input_schema is not None: - result["input_schema"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.input_schema) - if self.mcp_server_name is not None: - result["mcpServerName"] = from_union([from_str, from_none], self.mcp_server_name) - if self.mcp_tool_name is not None: - result["mcpToolName"] = from_union([from_str, from_none], self.mcp_tool_name) - if self.namespaced_name is not None: - result["namespacedName"] = from_union([from_str, from_none], self.namespaced_name) + result["resources"] = from_list(lambda x: to_class(MCPResource, x), self.resources) + if self.next_cursor is not None: + result["nextCursor"] = from_union([from_str, from_none], self.next_cursor) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class MCPExecuteSamplingParams: - """Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.""" +class MCPResourcesListTemplatesResult: + """One page of resource templates advertised by the named MCP server.""" - mcp_request_id: float | str - """The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate - the inference with the originating MCP request for telemetry; this is distinct from - `requestId` (which is the schema-level cancellation handle). - """ - request: dict[str, Any] - """Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. - Treated as opaque at the schema layer; the runtime converts the embedded MCP messages - into the OpenAI chat-completion shape internally. - """ - request_id: str - """Caller-provided unique identifier for this sampling execution. Use this same ID with - cancelSamplingExecution to cancel the in-flight call. Must be unique within the session - for the lifetime of the call. - """ - server_name: str - """Name of the MCP server that initiated the sampling request""" + resource_templates: list[MCPResourceTemplate] + """Resource templates advertised by the server (proxied MCP `resources/templates/list`)""" + + next_cursor: str | None = None + """Opaque cursor for the next page, if the server has more resource templates""" @staticmethod - def from_dict(obj: Any) -> 'MCPExecuteSamplingParams': + def from_dict(obj: Any) -> 'MCPResourcesListTemplatesResult': assert isinstance(obj, dict) - mcp_request_id = from_union([from_float, from_str], obj.get("mcpRequestId")) - request = from_dict(lambda x: x, obj.get("request")) - request_id = from_str(obj.get("requestId")) - server_name = from_str(obj.get("serverName")) - return MCPExecuteSamplingParams(mcp_request_id, request, request_id, server_name) + resource_templates = from_list(MCPResourceTemplate.from_dict, obj.get("resourceTemplates")) + next_cursor = from_union([from_str, from_none], obj.get("nextCursor")) + return MCPResourcesListTemplatesResult(resource_templates, next_cursor) def to_dict(self) -> dict: result: dict = {} - result["mcpRequestId"] = from_union([to_float, from_str], self.mcp_request_id) - result["request"] = from_dict(lambda x: x, self.request) - result["requestId"] = from_str(self.request_id) - result["serverName"] = from_str(self.server_name) + result["resourceTemplates"] = from_list(lambda x: to_class(MCPResourceTemplate, x), self.resource_templates) + if self.next_cursor is not None: + result["nextCursor"] = from_union([from_str, from_none], self.next_cursor) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -15278,6 +28093,7 @@ def to_dict(self) -> dict: result["modelId"] = from_str(self.model_id) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelCapabilities: """Model capabilities and limits""" @@ -15303,6 +28119,7 @@ def to_dict(self) -> dict: result["supports"] = from_union([lambda x: to_class(ModelCapabilitiesSupports, x), from_none], self.supports) return result +# Experimental: this type is part of an experimental API and may change or be removed. class ModelPickerCategory(Enum): """Model capability category for grouping in the model picker""" @@ -15310,10 +28127,12 @@ class ModelPickerCategory(Enum): POWERFUL = "powerful" VERSATILE = "versatile" +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass class Model: - """Schema for the `Model` type.""" - + """Copilot model metadata, including identifier, display name, capabilities, policy, + billing, reasoning efforts, and picker categories. + """ capabilities: ModelCapabilities """Model capabilities and limits""" @@ -15326,9 +28145,6 @@ class Model: billing: ModelBilling | None = None """Billing information""" - default_reasoning_effort: str | None = None - """Default reasoning effort level (only present if model supports reasoning effort)""" - model_picker_category: ModelPickerCategory | None = None """Model capability category for grouping in the model picker""" @@ -15348,12 +28164,11 @@ def from_dict(obj: Any) -> 'Model': id = from_str(obj.get("id")) name = from_str(obj.get("name")) billing = from_union([ModelBilling.from_dict, from_none], obj.get("billing")) - default_reasoning_effort = from_union([from_str, from_none], obj.get("defaultReasoningEffort")) model_picker_category = from_union([ModelPickerCategory, from_none], obj.get("modelPickerCategory")) model_picker_price_category = from_union([ModelPickerPriceCategory, from_none], obj.get("modelPickerPriceCategory")) policy = from_union([ModelPolicy.from_dict, from_none], obj.get("policy")) supported_reasoning_efforts = from_union([lambda x: from_list(from_str, x), from_none], obj.get("supportedReasoningEfforts")) - return Model(capabilities, id, name, billing, default_reasoning_effort, model_picker_category, model_picker_price_category, policy, supported_reasoning_efforts) + return Model(capabilities, id, name, billing, model_picker_category, model_picker_price_category, policy, supported_reasoning_efforts) def to_dict(self) -> dict: result: dict = {} @@ -15362,8 +28177,6 @@ def to_dict(self) -> dict: result["name"] = from_str(self.name) if self.billing is not None: result["billing"] = from_union([lambda x: to_class(ModelBilling, x), from_none], self.billing) - if self.default_reasoning_effort is not None: - result["defaultReasoningEffort"] = from_union([from_str, from_none], self.default_reasoning_effort) if self.model_picker_category is not None: result["modelPickerCategory"] = from_union([lambda x: to_enum(ModelPickerCategory, x), from_none], self.model_picker_category) if self.model_picker_price_category is not None: @@ -15374,6 +28187,7 @@ def to_dict(self) -> dict: result["supportedReasoningEfforts"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_reasoning_efforts) return result +# Experimental: this type is part of an experimental API and may change or be removed. @dataclass class ModelList: """List of Copilot models available to the resolved user, including capabilities and billing @@ -15400,43 +28214,62 @@ class ModelSwitchToRequest: context tier. """ model_id: str - """Model identifier to switch to""" - - context_tier: ModelCurrentContextTier | None = None - """Explicit context tier for the selected model. `"default"` / `"long_context"` pin the - tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier - untouched. + """Model selection id to switch to, as returned by `list`. A bare id (e.g. + `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id + (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. + """ + context_tier: ContextTier | None = None + """Explicit context tier for the selected model. `"default"` / `"long_context"` apply the + requested tier; omit this field to use normal model behavior with no explicit tier. + """ + defer_if_model_change_queued: bool | None = None + """When true, defer this switch (enqueue it) if another model change is already queued, even + when no turn is active — so it drains last (FIFO) and wins over the already-queued + change. Intended for genuine user-initiated model selections; internal restore/reapply + switches omit it and apply immediately when no turn is active. When no other model change + is queued this has no effect (a switch still applies immediately unless a turn is active). """ model_capabilities: ModelCapabilitiesOverride | None = None """Override individual model capabilities resolved by the runtime""" reasoning_effort: str | None = None - """Reasoning effort level to use for the model. "none" disables reasoning.""" - + """Reasoning effort level to use for the model. CAPI values are model-defined and validated + against the selected model; BYOK providers may define additional values. "none" disables + reasoning. When omitted, no effort override is applied. + """ reasoning_summary: ReasoningSummary | None = None """Reasoning summary mode to request for supported model clients""" + verbosity: Verbosity | None = None + """Output verbosity level to request for supported models""" + @staticmethod def from_dict(obj: Any) -> 'ModelSwitchToRequest': assert isinstance(obj, dict) model_id = from_str(obj.get("modelId")) - context_tier = from_union([ModelCurrentContextTier, from_none], obj.get("contextTier")) + context_tier = from_union([ContextTier, from_none], obj.get("contextTier")) + defer_if_model_change_queued = from_union([from_bool, from_none], obj.get("deferIfModelChangeQueued")) model_capabilities = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get("modelCapabilities")) reasoning_effort = from_union([from_str, from_none], obj.get("reasoningEffort")) reasoning_summary = from_union([ReasoningSummary, from_none], obj.get("reasoningSummary")) - return ModelSwitchToRequest(model_id, context_tier, model_capabilities, reasoning_effort, reasoning_summary) + verbosity = from_union([Verbosity, from_none], obj.get("verbosity")) + return ModelSwitchToRequest(model_id, context_tier, defer_if_model_change_queued, model_capabilities, reasoning_effort, reasoning_summary, verbosity) def to_dict(self) -> dict: result: dict = {} result["modelId"] = from_str(self.model_id) if self.context_tier is not None: - result["contextTier"] = from_union([lambda x: to_enum(ModelCurrentContextTier, x), from_none], self.context_tier) + result["contextTier"] = from_union([lambda x: to_enum(ContextTier, x), from_none], self.context_tier) + if self.defer_if_model_change_queued is not None: + result["deferIfModelChangeQueued"] = from_union([from_bool, from_none], self.defer_if_model_change_queued) if self.model_capabilities is not None: result["modelCapabilities"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.model_capabilities) if self.reasoning_effort is not None: result["reasoningEffort"] = from_union([from_str, from_none], self.reasoning_effort) if self.reasoning_summary is not None: result["reasoningSummary"] = from_union([lambda x: to_enum(ReasoningSummary, x), from_none], self.reasoning_summary) + if self.verbosity is not None: + result["verbosity"] = from_union([lambda x: to_enum(Verbosity, x), from_none], self.verbosity) return result # Experimental: this type is part of an experimental API and may change or be removed. @@ -15451,198 +28284,562 @@ class PermissionsSetAAllSource(Enum): # Experimental: this type is part of an experimental API and may change or be removed. @dataclass class PermissionsSetAllowAllRequest: - """Whether to enable full allow-all permissions for the session.""" + """Allow-all mode to apply for the session.""" + + enabled: bool | None = None + """Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is + treated as `mode: "on"` and any other value is treated as `mode: "off"`. + """ + mode: PermissionsAllowAllMode | None = None + """Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM + auto-approval; `off` disables both. + """ + model: str | None = None + """Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when + `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge + model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. + """ + source: PermissionsSetAAllSource | None = None + """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsSetAllowAllRequest': + assert isinstance(obj, dict) + enabled = from_union([from_bool, from_none], obj.get("enabled")) + mode = from_union([PermissionsAllowAllMode, from_none], obj.get("mode")) + model = from_union([from_str, from_none], obj.get("model")) + source = from_union([PermissionsSetAAllSource, from_none], obj.get("source")) + return PermissionsSetAllowAllRequest(enabled, mode, model, source) + + def to_dict(self) -> dict: + result: dict = {} + if self.enabled is not None: + result["enabled"] = from_union([from_bool, from_none], self.enabled) + if self.mode is not None: + result["mode"] = from_union([lambda x: to_enum(PermissionsAllowAllMode, x), from_none], self.mode) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(PermissionsSetAAllSource, x), from_none], self.source) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionsSetApproveAllRequest: + """Allow-all toggle for tool permission requests, with an optional telemetry source.""" + + enabled: bool + """Whether to auto-approve all tool permission requests""" + + source: PermissionsSetAAllSource | None = None + """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" + + @staticmethod + def from_dict(obj: Any) -> 'PermissionsSetApproveAllRequest': + assert isinstance(obj, dict) + enabled = from_bool(obj.get("enabled")) + source = from_union([PermissionsSetAAllSource, from_none], obj.get("source")) + return PermissionsSetApproveAllRequest(enabled, source) + + def to_dict(self) -> dict: + result: dict = {} + result["enabled"] = from_bool(self.enabled) + if self.source is not None: + result["source"] = from_union([lambda x: to_enum(PermissionsSetAAllSource, x), from_none], self.source) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +# Internal: this type is an internal SDK API and is not part of the public surface. +@dataclass +class _RegisterExtensionToolsResult: + """Handle for releasing the extension tool registration.""" + + unsubscribe: Any + """In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an + explicit `extensions.unregister` RPC in the SDK migration. + """ + + @staticmethod + def from_dict(obj: Any) -> '_RegisterExtensionToolsResult': + assert isinstance(obj, dict) + unsubscribe = obj.get("unsubscribe") + return _RegisterExtensionToolsResult(unsubscribe) + + def to_dict(self) -> dict: + result: dict = {} + result["unsubscribe"] = self.unsubscribe + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionLimitPredictionDetails: + """Explainable AI-credit session-limit prediction. + + Predicted session limit details. + """ + baseline_data: SessionLimitPredictionBaselineData + """Baseline data provenance.""" + + client_type: SessionLimitPredictionClientType + """Client population used for the prediction.""" + + model_id: str + """Model identifier used for lookup.""" + + recommended_cap: float + """Recommended maximum AI credits for this session.""" + + recommended_tier: SessionLimitPredictionTier + """Tier chosen as the recommended cap.""" + + source: SessionLimitPredictionSource + """Baseline fallback level used to create the prediction.""" + + source_key: str + """Key matched at the source level, such as a model id, family id, or `global`.""" + + tiers: list[SessionLimitPredictionTierOption] + """Ordered usage tiers and their AI-credit caps.""" + + family: str | None = None + """Resolved model family when known.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionLimitPredictionDetails': + assert isinstance(obj, dict) + baseline_data = SessionLimitPredictionBaselineData.from_dict(obj.get("baselineData")) + client_type = SessionLimitPredictionClientType(obj.get("clientType")) + model_id = from_str(obj.get("modelId")) + recommended_cap = from_float(obj.get("recommendedCap")) + recommended_tier = SessionLimitPredictionTier(obj.get("recommendedTier")) + source = SessionLimitPredictionSource(obj.get("source")) + source_key = from_str(obj.get("sourceKey")) + tiers = from_list(SessionLimitPredictionTierOption.from_dict, obj.get("tiers")) + family = from_union([from_str, from_none], obj.get("family")) + return SessionLimitPredictionDetails(baseline_data, client_type, model_id, recommended_cap, recommended_tier, source, source_key, tiers, family) + + def to_dict(self) -> dict: + result: dict = {} + result["baselineData"] = to_class(SessionLimitPredictionBaselineData, self.baseline_data) + result["clientType"] = to_enum(SessionLimitPredictionClientType, self.client_type) + result["modelId"] = from_str(self.model_id) + result["recommendedCap"] = to_float(self.recommended_cap) + result["recommendedTier"] = to_enum(SessionLimitPredictionTier, self.recommended_tier) + result["source"] = to_enum(SessionLimitPredictionSource, self.source) + result["sourceKey"] = from_str(self.source_key) + result["tiers"] = from_list(lambda x: to_class(SessionLimitPredictionTierOption, x), self.tiers) + if self.family is not None: + result["family"] = from_union([from_str, from_none], self.family) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionLimitPredictionResult: + """Prediction result. Available results include prediction details; unavailable results + include an explicit reason. + """ + kind: SessionLimitPredictionResultKind + prediction: SessionLimitPredictionDetails | None = None + """Predicted session limit details.""" + + reason: SessionLimitPredictionUnavailableReason | None = None + """Reason no prediction is available.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionLimitPredictionResult': + assert isinstance(obj, dict) + kind = SessionLimitPredictionResultKind(obj.get("kind")) + prediction = from_union([SessionLimitPredictionDetails.from_dict, from_none], obj.get("prediction")) + reason = from_union([SessionLimitPredictionUnavailableReason, from_none], obj.get("reason")) + return SessionLimitPredictionResult(kind, prediction, reason) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = to_enum(SessionLimitPredictionResultKind, self.kind) + if self.prediction is not None: + result["prediction"] = from_union([lambda x: to_class(SessionLimitPredictionDetails, x), from_none], self.prediction) + if self.reason is not None: + result["reason"] = from_union([lambda x: to_enum(SessionLimitPredictionUnavailableReason, x), from_none], self.reason) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionProviderGetEndpointRequest: + model_id: str | None = None + """Model identifier the caller intends to use against the returned endpoint. Used to pick + the correct wire shape. Omit to use whichever model the session is currently using. + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionProviderGetEndpointRequest': + assert isinstance(obj, dict) + model_id = from_union([from_str, from_none], obj.get("modelId")) + return SessionProviderGetEndpointRequest(model_id) + + def to_dict(self) -> dict: + result: dict = {} + if self.model_id is not None: + result["modelId"] = from_union([from_str, from_none], self.model_id) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenCloud: + """Parameters for creating a new cloud session.""" + + kind: ClassVar[str] = "cloud" + """Create a new cloud (coding-agent) session.""" + + # Internal: this field is an internal SDK API and is not part of the public surface. + on_task_created: Any = None + """In-process callback invoked when the cloud task is created (before connection). Marked + internal because a function reference cannot cross the JSON-RPC boundary. Disappears in + the SDK migration: the field is purely cosmetic (it flips a single CLI phase label from + 'creating' to 'connecting') and the wire-clean version just drops the intermediate phase. + """ + options: SessionOpenOptions | None = None + """Session options for cloud session creation.""" + + owner: str | None = None + """Optional owner (user or organization login) to associate with the cloud session when no + repository is provided. Ignored when `repository` is set (the repo's owner takes + precedence). + """ + repository: RemoteSessionRepository | None = None + """Repository for the cloud session.""" + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenCloud': + assert isinstance(obj, dict) + on_task_created = obj.get("onTaskCreated") + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + owner = from_union([from_str, from_none], obj.get("owner")) + repository = from_union([RemoteSessionRepository.from_dict, from_none], obj.get("repository")) + return SessionsOpenCloud(on_task_created, options, owner, repository) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.on_task_created is not None: + result["onTaskCreated"] = self.on_task_created + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + if self.owner is not None: + result["owner"] = from_union([from_str, from_none], self.owner) + if self.repository is not None: + result["repository"] = from_union([lambda x: to_class(RemoteSessionRepository, x), from_none], self.repository) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionsOpenHandoff: + """Parameters for fetching a remote session and handing it off to a new local session.""" + + kind: ClassVar[str] = "handoff" + """Fetch a remote session and hand it off to a new local session.""" + + metadata: RemoteSessionMetadataValue + """Remote session metadata for the session to hand off (typically obtained from + `sessions.list` with `source: "remote"`). + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + on_confirm: Any = None + """In-process confirmation callback `(request) => boolean | Promise` invoked when + the handoff needs the caller to confirm a non-fatal blocker (e.g. a repository mismatch + between the current working directory and the remote session). Returning `true` proceeds + with the handoff; returning `false` (or omitting the callback) aborts it. Marked internal + because a function reference cannot cross the JSON-RPC boundary, for the same reasons as + `onProgress`. + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + on_progress: Any = None + """In-process progress callback `(update) => void` invoked for each handoff step. Marked + internal because a function reference cannot cross the JSON-RPC boundary. The host-side + `handoffSession` is already declared as `AsyncGenerator`; + the schema layer flattens it because it does not yet support streaming methods. The + wire-clean replacement is to expose the AsyncGenerator directly (or use vscode-jsonrpc + `$/progress` notifications) once the schema/transport layer supports it. + """ + options: SessionOpenOptions | None = None + """Session construction options for the new local session.""" + + task_type: TaskType | None = None + """Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient + session). + """ + + @staticmethod + def from_dict(obj: Any) -> 'SessionsOpenHandoff': + assert isinstance(obj, dict) + metadata = RemoteSessionMetadataValue.from_dict(obj.get("metadata")) + on_confirm = obj.get("onConfirm") + on_progress = obj.get("onProgress") + options = from_union([SessionOpenOptions.from_dict, from_none], obj.get("options")) + task_type = from_union([TaskType, from_none], obj.get("taskType")) + return SessionsOpenHandoff(metadata, on_confirm, on_progress, options, task_type) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + result["metadata"] = to_class(RemoteSessionMetadataValue, self.metadata) + if self.on_confirm is not None: + result["onConfirm"] = self.on_confirm + if self.on_progress is not None: + result["onProgress"] = self.on_progress + if self.options is not None: + result["options"] = from_union([lambda x: to_class(SessionOpenOptions, x), from_none], self.options) + if self.task_type is not None: + result["taskType"] = from_union([lambda x: to_enum(TaskType, x), from_none], self.task_type) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SubagentSettingsEntry: + """Subagent model, reasoning effort, and context tier settings""" + + context_tier: SubagentSettingsEntryContextTier | None = None + """Context tier override for matching subagents""" + + effort_level: str | None = None + """Reasoning effort override for matching subagents""" + + model: str | None = None + """Model override for matching subagents""" + + @staticmethod + def from_dict(obj: Any) -> 'SubagentSettingsEntry': + assert isinstance(obj, dict) + context_tier = from_union([SubagentSettingsEntryContextTier, from_none], obj.get("contextTier")) + effort_level = from_union([from_str, from_none], obj.get("effortLevel")) + model = from_union([from_str, from_none], obj.get("model")) + return SubagentSettingsEntry(context_tier, effort_level, model) + + def to_dict(self) -> dict: + result: dict = {} + if self.context_tier is not None: + result["contextTier"] = from_union([lambda x: to_enum(SubagentSettingsEntryContextTier, x), from_none], self.context_tier) + if self.effort_level is not None: + result["effortLevel"] = from_union([from_str, from_none], self.effort_level) + if self.model is not None: + result["model"] = from_union([from_str, from_none], self.model) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SubagentSettings: + """Configured per-agent subagent overrides""" + + agents: dict[str, SubagentSettingsEntry] | None = None + """Per-agent settings keyed by subagent agent_type""" + + disabled_subagents: list[str] | None = None + """Names of subagents the user has turned off; they cannot be dispatched""" + + max_concurrency: int | None = None + """Maximum number of subagents that can run concurrently; applies to usage-based billing + users only + """ + max_depth: int | None = None + """Maximum subagent nesting depth; applies to usage-based billing users only""" + + @staticmethod + def from_dict(obj: Any) -> 'SubagentSettings': + assert isinstance(obj, dict) + agents = from_union([lambda x: from_dict(SubagentSettingsEntry.from_dict, x), from_none], obj.get("agents")) + disabled_subagents = from_union([lambda x: from_list(from_str, x), from_none], obj.get("disabledSubagents")) + max_concurrency = from_union([from_int, from_none], obj.get("maxConcurrency")) + max_depth = from_union([from_int, from_none], obj.get("maxDepth")) + return SubagentSettings(agents, disabled_subagents, max_concurrency, max_depth) + + def to_dict(self) -> dict: + result: dict = {} + if self.agents is not None: + result["agents"] = from_union([lambda x: from_dict(lambda x: to_class(SubagentSettingsEntry, x), x), from_none], self.agents) + if self.disabled_subagents is not None: + result["disabledSubagents"] = from_union([lambda x: from_list(from_str, x), from_none], self.disabled_subagents) + if self.max_concurrency is not None: + result["maxConcurrency"] = from_union([from_int, from_none], self.max_concurrency) + if self.max_depth is not None: + result["maxDepth"] = from_union([from_int, from_none], self.max_depth) + return result + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class TokenAuthInfo: + """Authentication-info variant for SDK-configured token authentication, carrying host and + the secret token value. + """ + host: str + """Authentication host.""" + + token: str + """The token value itself. Treat as a secret.""" - enabled: bool - """Whether to enable full allow-all permissions""" + type: ClassVar[str] = "token" + """SDK-side token authentication; the host configured the token directly via the SDK.""" - source: PermissionsSetAAllSource | None = None - """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetAllowAllRequest': + def from_dict(obj: Any) -> 'TokenAuthInfo': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - source = from_union([PermissionsSetAAllSource, from_none], obj.get("source")) - return PermissionsSetAllowAllRequest(enabled, source) + host = from_str(obj.get("host")) + token = from_str(obj.get("token")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return TokenAuthInfo(host, token, copilot_user) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - if self.source is not None: - result["source"] = from_union([lambda x: to_enum(PermissionsSetAAllSource, x), from_none], self.source) + result["host"] = from_str(self.host) + result["token"] = from_str(self.token) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class PermissionsSetApproveAllRequest: - """Allow-all toggle for tool permission requests, with an optional telemetry source.""" - - enabled: bool - """Whether to auto-approve all tool permission requests""" +class ToolsGetCurrentMetadataResult: + """Current lightweight tool metadata snapshot for the session.""" - source: PermissionsSetAAllSource | None = None - """Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.""" + tools: list[CurrentToolMetadata] | None = None + """Current tool metadata, or null when tools have not been initialized yet""" @staticmethod - def from_dict(obj: Any) -> 'PermissionsSetApproveAllRequest': + def from_dict(obj: Any) -> 'ToolsGetCurrentMetadataResult': assert isinstance(obj, dict) - enabled = from_bool(obj.get("enabled")) - source = from_union([PermissionsSetAAllSource, from_none], obj.get("source")) - return PermissionsSetApproveAllRequest(enabled, source) + tools = from_union([lambda x: from_list(CurrentToolMetadata.from_dict, x), from_none], obj.get("tools")) + return ToolsGetCurrentMetadataResult(tools) def to_dict(self) -> dict: result: dict = {} - result["enabled"] = from_bool(self.enabled) - if self.source is not None: - result["source"] = from_union([lambda x: to_enum(PermissionsSetAAllSource, x), from_none], self.source) + result["tools"] = from_union([lambda x: from_list(lambda x: to_class(CurrentToolMetadata, x), x), from_none], self.tools) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class TaskAgentInfo: - """Schema for the `TaskAgentInfo` type.""" - - agent_type: str - """Type of agent running this task""" - - description: str - """Short description of the task""" - - id: str - """Unique task identifier""" - - prompt: str - """Prompt passed to the agent""" - - started_at: datetime - """ISO 8601 timestamp when the task was started""" +class UIEphemeralQueryRequest: + """Transient question to answer without adding it to conversation history.""" - status: TaskStatus - """Current lifecycle status of the task""" - - tool_call_id: str - """Tool call ID associated with this agent task""" - - type: ClassVar[str] = "agent" - """Task kind""" + question: str + """Question to answer from the current conversation context.""" - active_started_at: datetime | None = None - """ISO 8601 timestamp when the current active period began""" - - active_time_ms: int | None = None - """Accumulated active execution time in milliseconds""" - - can_promote_to_background: bool | None = None - """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. + # Internal: this field is an internal SDK API and is not part of the public surface. + abort_signal: Any = None + """In-process `AbortSignal` forwarded to the model client to cancel an in-flight request. + Marked internal: excluded from the public SDK surface. Replaced by an explicit + cancellation token + cancel RPC in the SDK migration. + """ + # Internal: this field is an internal SDK API and is not part of the public surface. + on_chunk: Any = None + """In-process streaming callback `(text) => void` invoked with each token as the model emits + it. Marked internal: excluded from the public SDK surface. In a process-separated SDK + this is replaced by a streaming RPC that yields chunks and a final answer. """ - completed_at: datetime | None = None - """ISO 8601 timestamp when the task finished""" - - error: str | None = None - """Error message when the task failed""" - - execution_mode: TaskExecutionMode | None = None - """Whether task execution is synchronously awaited or managed in the background""" - idle_since: datetime | None = None - """ISO 8601 timestamp when the agent entered idle state""" + @staticmethod + def from_dict(obj: Any) -> 'UIEphemeralQueryRequest': + assert isinstance(obj, dict) + question = from_str(obj.get("question")) + abort_signal = obj.get("abortSignal") + on_chunk = obj.get("onChunk") + return UIEphemeralQueryRequest(question, abort_signal, on_chunk) - latest_response: str | None = None - """Most recent response text from the agent""" + def to_dict(self) -> dict: + result: dict = {} + result["question"] = from_str(self.question) + if self.abort_signal is not None: + result["abortSignal"] = self.abort_signal + if self.on_chunk is not None: + result["onChunk"] = self.on_chunk + return result - model: str | None = None - """Model used for the task when specified""" +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class UpdateSubagentSettingsRequest: + """Subagent settings to apply to the current session""" - result: str | None = None - """Result text from the task when available""" + subagents: SubagentSettings | None = None + """Subagent settings to apply, or null to clear the live session override""" @staticmethod - def from_dict(obj: Any) -> 'TaskAgentInfo': + def from_dict(obj: Any) -> 'UpdateSubagentSettingsRequest': assert isinstance(obj, dict) - agent_type = from_str(obj.get("agentType")) - description = from_str(obj.get("description")) - id = from_str(obj.get("id")) - prompt = from_str(obj.get("prompt")) - started_at = from_datetime(obj.get("startedAt")) - status = TaskStatus(obj.get("status")) - tool_call_id = from_str(obj.get("toolCallId")) - active_started_at = from_union([from_datetime, from_none], obj.get("activeStartedAt")) - active_time_ms = from_union([from_int, from_none], obj.get("activeTimeMs")) - can_promote_to_background = from_union([from_bool, from_none], obj.get("canPromoteToBackground")) - completed_at = from_union([from_datetime, from_none], obj.get("completedAt")) - error = from_union([from_str, from_none], obj.get("error")) - execution_mode = from_union([TaskExecutionMode, from_none], obj.get("executionMode")) - idle_since = from_union([from_datetime, from_none], obj.get("idleSince")) - latest_response = from_union([from_str, from_none], obj.get("latestResponse")) - model = from_union([from_str, from_none], obj.get("model")) - result = from_union([from_str, from_none], obj.get("result")) - return TaskAgentInfo(agent_type, description, id, prompt, started_at, status, tool_call_id, active_started_at, active_time_ms, can_promote_to_background, completed_at, error, execution_mode, idle_since, latest_response, model, result) + subagents = from_union([SubagentSettings.from_dict, from_none], obj.get("subagents")) + return UpdateSubagentSettingsRequest(subagents) def to_dict(self) -> dict: result: dict = {} - result["agentType"] = from_str(self.agent_type) - result["description"] = from_str(self.description) - result["id"] = from_str(self.id) - result["prompt"] = from_str(self.prompt) - result["startedAt"] = self.started_at.isoformat() - result["status"] = to_enum(TaskStatus, self.status) - result["toolCallId"] = from_str(self.tool_call_id) - result["type"] = self.type - if self.active_started_at is not None: - result["activeStartedAt"] = from_union([lambda x: x.isoformat(), from_none], self.active_started_at) - if self.active_time_ms is not None: - result["activeTimeMs"] = from_union([from_int, from_none], self.active_time_ms) - if self.can_promote_to_background is not None: - result["canPromoteToBackground"] = from_union([from_bool, from_none], self.can_promote_to_background) - if self.completed_at is not None: - result["completedAt"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at) - if self.error is not None: - result["error"] = from_union([from_str, from_none], self.error) - if self.execution_mode is not None: - result["executionMode"] = from_union([lambda x: to_enum(TaskExecutionMode, x), from_none], self.execution_mode) - if self.idle_since is not None: - result["idleSince"] = from_union([lambda x: x.isoformat(), from_none], self.idle_since) - if self.latest_response is not None: - result["latestResponse"] = from_union([from_str, from_none], self.latest_response) - if self.model is not None: - result["model"] = from_union([from_str, from_none], self.model) - if self.result is not None: - result["result"] = from_union([from_str, from_none], self.result) + if self.subagents is not None: + result["subagents"] = from_union([lambda x: to_class(SubagentSettings, x), from_none], self.subagents) return result # Experimental: this type is part of an experimental API and may change or be removed. @dataclass -class ToolsGetCurrentMetadataResult: - """Current lightweight tool metadata snapshot for the session.""" +class UserAuthInfo: + """Authentication-info variant for OAuth user auth, with host and login; the token remains + in the runtime secret store. + """ + host: str + """Authentication host.""" - tools: list[CurrentToolMetadata] | None = None - """Current tool metadata, or null when tools have not been initialized yet""" + login: str + """OAuth user login.""" + + type: ClassVar[str] = "user" + """OAuth user authentication. The token itself is held in the runtime's secret token store + (keyed by host+login) and is NOT carried in this struct. + """ + copilot_user: CopilotUserResponse | None = None + """Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the + GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this + verbatim and does not re-fetch when set. + """ @staticmethod - def from_dict(obj: Any) -> 'ToolsGetCurrentMetadataResult': + def from_dict(obj: Any) -> 'UserAuthInfo': assert isinstance(obj, dict) - tools = from_union([lambda x: from_list(CurrentToolMetadata.from_dict, x), from_none], obj.get("tools")) - return ToolsGetCurrentMetadataResult(tools) + host = from_str(obj.get("host")) + login = from_str(obj.get("login")) + copilot_user = from_union([CopilotUserResponse.from_dict, from_none], obj.get("copilotUser")) + return UserAuthInfo(host, login, copilot_user) def to_dict(self) -> dict: result: dict = {} - result["tools"] = from_union([lambda x: from_list(lambda x: to_class(CurrentToolMetadata, x), x), from_none], self.tools) + result["host"] = from_str(self.host) + result["login"] = from_str(self.login) + result["type"] = self.type + if self.copilot_user is not None: + result["copilotUser"] = from_union([lambda x: to_class(CopilotUserResponse, x), from_none], self.copilot_user) return result @dataclass class RPC: abort_request: AbortRequest abort_result: AbortResult + account_all_users: AccountAllUsers + account_get_all_users_result: list[AccountAllUsers] + account_get_current_auth_result: AccountGetCurrentAuthResult account_get_quota_request: AccountGetQuotaRequest account_get_quota_result: AccountGetQuotaResult + account_login_request: AccountLoginRequest + account_login_result: AccountLoginResult + account_logout_request: AccountLogoutRequest + account_logout_result: AccountLogoutResult account_quota_snapshot: AccountQuotaSnapshot + adaptive_thinking_support: AdaptiveThinkingSupport + agent_discovery_path: AgentDiscoveryPath + agent_discovery_path_list: AgentDiscoveryPathList + agent_discovery_path_scope: AgentDiscoveryPathScope agent_get_current_result: AgentGetCurrentResult agent_info: AgentInfo agent_info_source: AgentInfoSource agent_list: AgentList + agent_list_request: Any agent_registry_live_target_entry: AgentRegistryLiveTargetEntry agent_registry_live_target_entry_attention_kind: AgentRegistryLiveTargetEntryAttentionKind agent_registry_live_target_entry_kind: AgentRegistryLiveTargetEntryKind @@ -15660,20 +28857,25 @@ class RPC: agent_registry_spawn_validation_error_field: AgentRegistrySpawnValidationErrorField agent_registry_spawn_validation_error_reason: AgentRegistrySpawnValidationErrorReason agent_reload_result: AgentReloadResult + agents_discover_request: AgentsDiscoverRequest agent_select_request: AgentSelectRequest agent_select_result: AgentSelectResult + agent_set_prompt_request: AgentSetPromptRequest + agents_get_discovery_paths_request: AgentsGetDiscoveryPathsRequest allow_all_permission_set_result: AllowAllPermissionSetResult allow_all_permission_state: AllowAllPermissionState api_key_auth_info: APIKeyAuthInfo auth_info: AuthInfo auth_info_type: AuthInfoType + built_in_model_catalog: BuiltInModelCatalog + built_in_model_catalog_entry: BuiltInModelCatalogEntry + cancel_user_requested_shell_command_result: CancelUserRequestedShellCommandResult canvas_action: CanvasAction canvas_action_invoke_request: CanvasActionInvokeRequest canvas_action_invoke_result: Any canvas_close_request: CanvasCloseRequest canvas_host_context: CanvasHostContext canvas_host_context_capabilities: CanvasHostContextCapabilities - canvas_instance_availability: CanvasInstanceAvailability canvas_json_schema: Any canvas_list: CanvasList canvas_list_open_result: CanvasListOpenResult @@ -15683,20 +28885,29 @@ class RPC: canvas_provider_open_request: CanvasProviderOpenRequest canvas_provider_open_result: CanvasProviderOpenResult canvas_session_context: CanvasSessionContext + capi_session_options: CapiSessionOptions command_list: CommandList commands_handle_pending_command_request: CommandsHandlePendingCommandRequest commands_handle_pending_command_result: CommandsHandlePendingCommandResult commands_invoke_request: CommandsInvokeRequest - commands_list_request: CommandsListRequest + commands_list_request: Any commands_respond_to_queued_command_request: CommandsRespondToQueuedCommandRequest commands_respond_to_queued_command_result: CommandsRespondToQueuedCommandResult + completions_get_trigger_characters_result: CompletionsGetTriggerCharactersResult + completions_request_request: CompletionsRequestRequest + completions_request_result: CompletionsRequestResult + configure_session_extensions_params: _ConfigureSessionExtensionsParams connected_remote_session_metadata: ConnectedRemoteSessionMetadata connected_remote_session_metadata_kind: ConnectedRemoteSessionMetadataKind connected_remote_session_metadata_repository: ConnectedRemoteSessionMetadataRepository connect_remote_session_params: ConnectRemoteSessionParams connect_request: _ConnectRequest connect_result: _ConnectResult + content_exclusion_check_paths_request: ContentExclusionCheckPathsRequest + content_exclusion_check_paths_result: ContentExclusionCheckPathsResult + content_exclusion_path_check: ContentExclusionPathCheck content_filter_mode: ContentFilterMode + context_heaviest_message: ContextHeaviestMessage copilot_api_token_auth_info: CopilotAPITokenAuthInfo copilot_user_response: CopilotUserResponse copilot_user_response_endpoints: CopilotUserResponseEndpoints @@ -15706,7 +28917,26 @@ class RPC: copilot_user_response_quota_snapshots_premium_interactions: CopilotUserResponseQuotaSnapshotsPremiumInteractions current_model: CurrentModel current_tool_metadata: CurrentToolMetadata + debug_collect_logs_collected_entry: DebugCollectLogsCollectedEntry + debug_collect_logs_destination: DebugCollectLogsDestination + debug_collect_logs_entry: DebugCollectLogsEntry + debug_collect_logs_entry_kind: DebugCollectLogsEntryKind + debug_collect_logs_include: DebugCollectLogsInclude + debug_collect_logs_redaction: DebugCollectLogsRedaction + debug_collect_logs_request: DebugCollectLogsRequest + debug_collect_logs_result: DebugCollectLogsResult + debug_collect_logs_result_kind: DebugCollectLogsResultKind + debug_collect_logs_skipped_entry: DebugCollectLogsSkippedEntry + debug_collect_logs_source: DebugCollectLogsSource + disable_bypass_permissions_mode: DisableBypassPermissionsMode discovered_canvas: DiscoveredCanvas + discovered_extension: DiscoveredExtension + discovered_extension_mode: DiscoveredExtensionMode + discovered_extension_plugin: DiscoveredExtensionPlugin + discovered_extensions: DiscoveredExtensions + discovered_extensions_disable_request: DiscoveredExtensionsDisableRequest + discovered_extensions_enable_request: DiscoveredExtensionsEnableRequest + discovered_extension_source: DiscoveredExtensionSource discovered_mcp_server: DiscoveredMCPServer discovered_mcp_server_type: DiscoveredMCPServerType enqueue_command_params: EnqueueCommandParams @@ -15718,10 +28948,15 @@ class RPC: event_log_types: list[str] | EventLogTypes events_agent_scope: EventsAgentScope events_cursor_status: EventsCursorStatus + events_read_direction: EventsReadDirection events_read_result: EventsReadResult execute_command_params: ExecuteCommandParams execute_command_result: ExecuteCommandResult extension: Extension + extension_context_push_input: ExtensionContextPushInput + extension_launch_profile: ExtensionLaunchProfile + extension_launch_provider_resolve_request: ExtensionLaunchProviderResolveRequest + extension_launch_provider_resolve_result: ExtensionLaunchProviderResolveResult extension_list: ExtensionList extensions_disable_request: ExtensionsDisableRequest extensions_enable_request: ExtensionsEnableRequest @@ -15739,8 +28974,47 @@ class RPC: external_tool_text_result_for_llm_content_resource_link: ExternalToolTextResultForLlmContentResourceLink external_tool_text_result_for_llm_content_resource_link_icon: ExternalToolTextResultForLlmContentResourceLinkIcon external_tool_text_result_for_llm_content_resource_link_icon_theme: Theme + external_tool_text_result_for_llm_content_shell_exit: ExternalToolTextResultForLlmContentShellExit external_tool_text_result_for_llm_content_terminal: ExternalToolTextResultForLlmContentTerminal external_tool_text_result_for_llm_content_text: ExternalToolTextResultForLlmContentText + factory_abort_request: FactoryAbortRequest + factory_ack_result: FactoryACKResult + factory_agent_options: FactoryAgentOptions + factory_agent_request: FactoryAgentRequest + factory_agent_result: FactoryAgentResult + factory_agent_summary: FactoryAgentSummary + factory_cancel_request: FactoryCancelRequest + factory_current_phase: FactoryCurrentPhase + factory_declared_limits: FactoryDeclaredLimits + factory_durable_operation: FactoryDurableOperation + factory_execute_request: FactoryExecuteRequest + factory_execute_result: FactoryExecuteResult + factory_get_run_progress_request: FactoryGetRunProgressRequest + factory_get_run_request: FactoryGetRunRequest + factory_journal_get_request: FactoryJournalGetRequest + factory_journal_get_result: FactoryJournalGetResult + factory_journal_put_request: FactoryJournalPutRequest + factory_list_runs_request: FactoryListRunsRequest + factory_list_runs_result: FactoryListRunsResult + factory_log_line: FactoryLogLine + factory_log_line_kind: FactoryLogLineKind + factory_log_request: FactoryLogRequest + factory_phase_observation: FactoryPhaseObservation + factory_phase_status: FactoryPhaseStatus + factory_progress_line: FactoryProgressLine + factory_progress_page: FactoryProgressPage + factory_resume_request: FactoryResumeRequest + factory_resume_result: FactoryResumeResult + factory_run_consumed: FactoryRunConsumed + factory_run_detail: FactoryRunDetail + factory_run_failure: FactoryRunFailure + factory_run_failure_kind: FactoryRunFailureKind + factory_run_limits: FactoryRunLimits + factory_run_request: FactoryRunRequest + factory_run_result: FactoryRunResult + factory_run_status: FactoryRunStatus + factory_run_summary: FactoryRunSummary + factory_run_terminal: FactoryRunTerminal filter_mapping: dict[str, ContentFilterMode] | ContentFilterMode fleet_start_request: FleetStartRequest fleet_start_result: FleetStartResult @@ -15748,29 +29022,82 @@ class RPC: folder_trust_check_params: FolderTrustCheckParams folder_trust_check_result: FolderTrustCheckResult gh_cli_auth_info: GhCLIAuthInfo + git_hub_telemetry_client_info: GitHubTelemetryClientInfo + git_hub_telemetry_event: GitHubTelemetryEvent + git_hub_telemetry_notification: GitHubTelemetryNotification handle_pending_tool_call_request: HandlePendingToolCallRequest handle_pending_tool_call_result: HandlePendingToolCallResult history_abort_manual_compaction_result: HistoryAbortManualCompactionResult history_cancel_background_compaction_result: HistoryCancelBackgroundCompactionResult + history_clear_context_request: HistoryClearContextRequest + history_clear_context_result: HistoryClearContextResult history_compact_context_window: HistoryCompactContextWindow - history_compact_request: HistoryCompactRequest + history_compact_request: Any history_compact_result: HistoryCompactResult + history_file_restore_skip_reason: HistoryFileRestoreSkipReason + history_list_rewind_points_result: HistoryListRewindPointsResult + history_preview_rewind_request: HistoryPreviewRewindRequest + history_preview_rewind_result: HistoryPreviewRewindResult + history_rewind_change_type: HistoryRewindChangeType + history_rewind_file_preview: HistoryRewindFilePreview + history_rewind_mode: HistoryRewindMode + history_rewind_outcome: HistoryRewindOutcome + history_rewind_point: HistoryRewindPoint + history_rewind_request: HistoryRewindRequest + history_rewind_result: HistoryRewindResult + history_rewind_unavailable_reason: HistoryRewindUnavailableReason + history_skipped_file_restore: HistorySkippedFileRestore history_summarize_for_handoff_result: HistorySummarizeForHandoffResult history_truncate_request: HistoryTruncateRequest history_truncate_result: HistoryTruncateResult hmac_auth_info: HMACAuthInfo + hook_invoke_request: _HookInvokeRequest + hook_invoke_response: _HookInvokeResponse + hook_type: _HookType installed_plugin: InstalledPlugin + installed_plugin_info: InstalledPluginInfo installed_plugin_source: InstalledPluginSource | str - installed_plugin_source_github: InstalledPluginSourceGithub + installed_plugin_source_git_hub: InstalledPluginSourceGitHub installed_plugin_source_local: InstalledPluginSourceLocal installed_plugin_source_url: InstalledPluginSourceURL + instruction_discovery_path: InstructionDiscoveryPath + instruction_discovery_path_kind: DebugCollectLogsEntryKind + instruction_discovery_path_list: InstructionDiscoveryPathList + instruction_discovery_path_location: InstructionLocation + instructions_discover_request: InstructionsDiscoverRequest + instructions_get_discovery_paths_request: InstructionsGetDiscoveryPathsRequest instructions_get_sources_result: InstructionsGetSourcesResult - instructions_sources: InstructionsSources - instructions_sources_location: InstructionsSourcesLocation - instructions_sources_type: InstructionsSourcesType + instruction_source: InstructionSource + instruction_source_location: InstructionLocation + instruction_source_type: InstructionSourceType + interrupt_main_turn_request: InterruptMainTurnRequest + interrupt_main_turn_result: InterruptMainTurnResult + llm_inference_headers: dict[str, list[str]] + llm_inference_http_request_chunk_request: LlmInferenceHTTPRequestChunkRequest + llm_inference_http_request_chunk_result: LlmInferenceHTTPRequestChunkResult + llm_inference_http_request_start_request: LlmInferenceHTTPRequestStartRequest + llm_inference_http_request_start_result: LlmInferenceHTTPRequestStartResult + llm_inference_http_request_start_transport: LlmInferenceHTTPRequestStartTransport + llm_inference_http_response_chunk_error: LlmInferenceHTTPResponseChunkError + llm_inference_http_response_chunk_request: LlmInferenceHTTPResponseChunkRequest + llm_inference_http_response_chunk_result: LlmInferenceHTTPResponseChunkResult + llm_inference_http_response_start_request: LlmInferenceHTTPResponseStartRequest + llm_inference_http_response_start_result: LlmInferenceHTTPResponseStartResult + llm_inference_set_provider_result: LlmInferenceSetProviderResult + local_session_metadata_value: LocalSessionMetadataValue log_request: LogRequest log_result: LogResult lsp_initialize_request: LspInitializeRequest + managed_settings_read_result: ManagedSettingsReadResult + marketplace_add_result: MarketplaceAddResult + marketplace_browse_result: MarketplaceBrowseResult + marketplace_info: MarketplaceInfo + marketplace_list_result: MarketplaceListResult + marketplace_plugin_info: MarketplacePluginInfo + marketplace_refresh_entry: MarketplaceRefreshEntry + marketplace_refresh_result: MarketplaceRefreshResult + marketplace_remove_result: MarketplaceRemoveResult + mcp_allowed_server: MCPAllowedServer mcp_apps_call_tool_request: MCPAppsCallToolRequest mcp_apps_diagnose_capability: MCPAppsDiagnoseCapability mcp_apps_diagnose_request: MCPAppsDiagnoseRequest @@ -15801,6 +29128,8 @@ class RPC: mcp_config_list: MCPConfigList mcp_config_remove_request: MCPConfigRemoveRequest mcp_config_update_request: MCPConfigUpdateRequest + mcp_configure_git_hub_request: MCPConfigureGitHubRequest + mcp_configure_git_hub_result: MCPConfigureGitHubResult mcp_disable_request: MCPDisableRequest mcp_discover_request: MCPDiscoverRequest mcp_discover_result: MCPDiscoverResult @@ -15808,23 +29137,67 @@ class RPC: mcp_execute_sampling_params: MCPExecuteSamplingParams mcp_execute_sampling_request: dict[str, Any] mcp_execute_sampling_result: dict[str, Any] + mcp_filtered_server: MCPFilteredServer + mcp_headers_handle_pending_headers_refresh_request: MCPHeadersHandlePendingHeadersRefreshRequest + mcp_headers_handle_pending_headers_refresh_request_request: MCPHeadersHandlePendingHeadersRefreshRequestRequest + mcp_headers_handle_pending_headers_refresh_request_result: MCPHeadersHandlePendingHeadersRefreshRequestResult + mcp_host_state: MCPHostState + mcp_is_server_running_request: MCPIsServerRunningRequest + mcp_is_server_running_result: MCPIsServerRunningResult + mcp_list_tools_request: MCPListToolsRequest + mcp_list_tools_result: MCPListToolsResult + mcp_oauth_authentication_state_changed_request: MCPOauthAuthenticationStateChangedRequest + mcp_oauth_handle_pending_request: MCPOauthHandlePendingRequest + mcp_oauth_handle_pending_result: MCPOauthHandlePendingResult + mcp_oauth_login_grant_type: MCPGrantType mcp_oauth_login_request: MCPOauthLoginRequest mcp_oauth_login_result: MCPOauthLoginResult + mcp_oauth_pending_request_response: MCPOauthPendingRequestResponse + mcp_oauth_respond_request: MCPOauthRespondRequest + mcp_oauth_respond_result: MCPOauthRespondResult + mcp_register_external_client_request: MCPRegisterExternalClientRequest + mcp_reload_with_config_request: MCPReloadWithConfigRequest mcp_remove_git_hub_result: MCPRemoveGitHubResult + mcp_resource: MCPResource + mcp_resource_annotations: MCPResourceAnnotations + mcp_resource_content: MCPResourceContent + mcp_resource_icon: MCPResourceIcon + mcp_resources_list_request: MCPResourcesListRequest + mcp_resources_list_result: MCPResourcesListResult + mcp_resources_list_templates_request: MCPResourcesListTemplatesRequest + mcp_resources_list_templates_result: MCPResourcesListTemplatesResult + mcp_resources_read_request: MCPResourcesReadRequest + mcp_resources_read_result: MCPResourcesReadResult + mcp_resource_template: MCPResourceTemplate + mcp_restart_server_request: MCPRestartServerRequest mcp_sampling_execution_action: MCPSamplingExecutionAction mcp_sampling_execution_result: MCPSamplingExecutionResult mcp_server: MCPServer mcp_server_auth_config: bool | MCPServerAuthConfigRedirectPort mcp_server_auth_config_redirect_port: MCPServerAuthConfigRedirectPort mcp_server_config: MCPServerConfig + mcp_server_config_defer_tools: MCPServerConfigDeferTools mcp_server_config_http: MCPServerConfigHTTP - mcp_server_config_http_oauth_grant_type: MCPServerConfigHTTPOauthGrantType + mcp_server_config_http_oauth_grant_type: MCPGrantType mcp_server_config_http_type: MCPServerConfigHTTPType mcp_server_config_stdio: MCPServerConfigStdio + mcp_server_failure_info: MCPServerFailureInfo mcp_server_list: MCPServerList + mcp_server_needs_auth_info: MCPServerNeedsAuthInfo mcp_set_env_value_mode_details: MCPSetEnvValueModeDetails mcp_set_env_value_mode_params: MCPSetEnvValueModeParams mcp_set_env_value_mode_result: MCPSetEnvValueModeResult + mcp_start_server_request: MCPStartServerRequest + mcp_start_servers_result: MCPStartServersResult + mcp_stop_server_request: MCPStopServerRequest + mcp_tools: MCPTools + mcp_tool_ui: MCPToolUI + mcp_tool_ui_visibility: MCPToolUIVisibility + mcp_unregister_external_client_request: MCPUnregisterExternalClientRequest + memory_configuration: MemoryConfiguration + metadata_context_attribution_result: MetadataContextAttributionResult + metadata_context_heaviest_messages_request: MetadataContextHeaviestMessagesRequest + metadata_context_heaviest_messages_result: MetadataContextHeaviestMessagesResult metadata_context_info_request: MetadataContextInfoRequest metadata_context_info_result: MetadataContextInfoResult metadata_is_processing_result: MetadataIsProcessingResult @@ -15837,9 +29210,10 @@ class RPC: metadata_snapshot_current_mode: MetadataSnapshotCurrentMode metadata_snapshot_remote_metadata: MetadataSnapshotRemoteMetadata metadata_snapshot_remote_metadata_repository: MetadataSnapshotRemoteMetadataRepository - metadata_snapshot_remote_metadata_task_type: MetadataSnapshotRemoteMetadataTaskType + metadata_snapshot_remote_metadata_task_type: TaskType model: Model model_billing: ModelBilling + model_billing_promo: ModelBillingPromo model_billing_token_prices: ModelBillingTokenPrices model_billing_token_prices_long_context: ModelBillingTokenPricesLongContext model_capabilities: ModelCapabilities @@ -15850,9 +29224,8 @@ class RPC: model_capabilities_override_limits_vision: ModelCapabilitiesOverrideLimitsVision model_capabilities_override_supports: ModelCapabilitiesOverrideSupports model_capabilities_supports: ModelCapabilitiesSupports - model_current_context_tier: ModelCurrentContextTier model_list: ModelList - model_list_request: ModelListRequest + model_list_request: Any model_picker_category: ModelPickerCategory model_picker_price_category: ModelPickerPriceCategory model_policy: ModelPolicy @@ -15863,12 +29236,19 @@ class RPC: model_switch_to_request: ModelSwitchToRequest model_switch_to_result: ModelSwitchToResult mode_set_request: ModeSetRequest + named_provider_config: NamedProviderConfig name_get_result: NameGetResult name_set_auto_request: NameSetAutoRequest name_set_auto_result: NameSetAutoResult name_set_request: NameSetRequest open_canvas_instance: OpenCanvasInstance + options_update_additional_content_exclusion_policy: OptionsUpdateAdditionalContentExclusionPolicy + options_update_additional_content_exclusion_policy_rule: OptionsUpdateAdditionalContentExclusionPolicyRule + options_update_additional_content_exclusion_policy_rule_source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource + options_update_additional_content_exclusion_policy_scope: AdditionalContentExclusionPolicyScope + options_update_context_tier: OptionsUpdateContextTier options_update_env_value_mode: MCPSetEnvValueModeDetails + options_update_reasoning_summary: ReasoningSummary options_update_tool_filter_precedence: OptionsUpdateToolFilterPrecedence pending_permission_request: PendingPermissionRequest pending_permission_request_list: PendingPermissionRequestList @@ -15882,6 +29262,7 @@ class RPC: permission_decision_approve_for_location_approval_custom_tool: PermissionDecisionApproveForLocationApprovalCustomTool permission_decision_approve_for_location_approval_extension_management: PermissionDecisionApproveForLocationApprovalExtensionManagement permission_decision_approve_for_location_approval_extension_permission_access: PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess + permission_decision_approve_for_location_approval_factory: PermissionDecisionApproveForLocationApprovalFactory permission_decision_approve_for_location_approval_mcp: PermissionDecisionApproveForLocationApprovalMCP permission_decision_approve_for_location_approval_mcp_sampling: PermissionDecisionApproveForLocationApprovalMCPSampling permission_decision_approve_for_location_approval_memory: PermissionDecisionApproveForLocationApprovalMemory @@ -15893,6 +29274,7 @@ class RPC: permission_decision_approve_for_session_approval_custom_tool: PermissionDecisionApproveForSessionApprovalCustomTool permission_decision_approve_for_session_approval_extension_management: PermissionDecisionApproveForSessionApprovalExtensionManagement permission_decision_approve_for_session_approval_extension_permission_access: PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess + permission_decision_approve_for_session_approval_factory: PermissionDecisionApproveForSessionApprovalFactory permission_decision_approve_for_session_approval_mcp: PermissionDecisionApproveForSessionApprovalMCP permission_decision_approve_for_session_approval_mcp_sampling: PermissionDecisionApproveForSessionApprovalMCPSampling permission_decision_approve_for_session_approval_memory: PermissionDecisionApproveForSessionApprovalMemory @@ -15901,13 +29283,17 @@ class RPC: permission_decision_approve_once: PermissionDecisionApproveOnce permission_decision_approve_permanently: PermissionDecisionApprovePermanently permission_decision_cancelled: PermissionDecisionCancelled + permission_decision_context: PermissionDecisionContext permission_decision_denied_by_content_exclusion_policy: PermissionDecisionDeniedByContentExclusionPolicy permission_decision_denied_by_permission_request_hook: PermissionDecisionDeniedByPermissionRequestHook permission_decision_denied_by_rules: PermissionDecisionDeniedByRules permission_decision_denied_interactively_by_user: PermissionDecisionDeniedInteractivelyByUser permission_decision_denied_no_approval_rule_and_could_not_request_from_user: PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser + permission_decision_outcome: PermissionDecisionOutcome permission_decision_reject: PermissionDecisionReject permission_decision_request: PermissionDecisionRequest + permission_decision_source: PermissionDecisionSource + permission_decision_surface: PermissionDecisionSurface permission_decision_user_not_available: PermissionDecisionUserNotAvailable permission_location_add_tool_approval_params: PermissionLocationAddToolApprovalParams permission_location_apply_params: PermissionLocationApplyParams @@ -15926,10 +29312,11 @@ class RPC: permission_prompt_shown_notification: PermissionPromptShownNotification permission_request_result: PermissionRequestResult permission_rules_set: PermissionRulesSet + permissions_allow_all_mode: PermissionsAllowAllMode permissions_configure_additional_content_exclusion_policy: PermissionsConfigureAdditionalContentExclusionPolicy permissions_configure_additional_content_exclusion_policy_rule: PermissionsConfigureAdditionalContentExclusionPolicyRule permissions_configure_additional_content_exclusion_policy_rule_source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource - permissions_configure_additional_content_exclusion_policy_scope: PermissionsConfigureAdditionalContentExclusionPolicyScope + permissions_configure_additional_content_exclusion_policy_scope: AdditionalContentExclusionPolicyScope permissions_configure_params: PermissionsConfigureParams permissions_configure_result: PermissionsConfigureResult permissions_folder_trust_add_trusted_result: PermissionsFolderTrustAddTrustedResult @@ -15939,6 +29326,7 @@ class RPC: permissions_locations_add_tool_approval_details_custom_tool: PermissionsLocationsAddToolApprovalDetailsCustomTool permissions_locations_add_tool_approval_details_extension_management: PermissionsLocationsAddToolApprovalDetailsExtensionManagement permissions_locations_add_tool_approval_details_extension_permission_access: PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess + permissions_locations_add_tool_approval_details_factory: PermissionsLocationsAddToolApprovalDetailsFactory permissions_locations_add_tool_approval_details_mcp: PermissionsLocationsAddToolApprovalDetailsMCP permissions_locations_add_tool_approval_details_mcp_sampling: PermissionsLocationsAddToolApprovalDetailsMCPSampling permissions_locations_add_tool_approval_details_memory: PermissionsLocationsAddToolApprovalDetailsMemory @@ -15968,50 +29356,166 @@ class RPC: ping_request: PingRequest ping_result: PingResult plan_read_result: PlanReadResult + plan_read_sql_todos_result: PlanReadSQLTodosResult + plan_read_sql_todos_with_dependencies_result: PlanReadSQLTodosWithDependenciesResult + plan_sql_todo_dependency: PlanSQLTodoDependency + plan_sql_todos_row: PlanSQLTodosRow plan_update_request: PlanUpdateRequest plugin: Plugin + plugin_install_result: PluginInstallResult plugin_list: PluginList + plugin_list_result: PluginListResult + plugins_disable_request: PluginsDisableRequest + plugins_enable_request: PluginsEnableRequest + plugins_install_request: PluginsInstallRequest + plugins_marketplaces_add_request: PluginsMarketplacesAddRequest + plugins_marketplaces_browse_request: PluginsMarketplacesBrowseRequest + plugins_marketplaces_refresh_request: PluginsMarketplacesRefreshRequest + plugins_marketplaces_remove_request: PluginsMarketplacesRemoveRequest + plugins_reload_request: Any + plugins_uninstall_request: PluginsUninstallRequest + plugins_update_request: PluginsUpdateRequest + plugin_update_all_entry: PluginUpdateAllEntry + plugin_update_all_result: PluginUpdateAllResult + plugin_update_result: PluginUpdateResult + provider_add_request: ProviderAddRequest + provider_add_result: ProviderAddResult + provider_config: ProviderConfig + provider_config_azure: ProviderConfigAzure + provider_config_transport: ProviderTransport + provider_config_type: ProviderType + provider_config_wire_api: ProviderWireAPI + provider_endpoint: ProviderEndpoint + provider_endpoint_transport: ProviderTransport + provider_endpoint_type: ProviderType + provider_endpoint_wire_api: ProviderWireAPI + provider_get_endpoint_request: Any + provider_model_config: ProviderModelConfig + provider_session_token: ProviderSessionToken + provider_token_acquire_request: ProviderTokenAcquireRequest + provider_token_acquire_result: ProviderTokenAcquireResult + push_attachment: PushAttachment + push_attachment_blob: PushAttachmentBlob + push_attachment_directory: PushAttachmentDirectory + push_attachment_file: PushAttachmentFile + push_attachment_file_line_range: PushAttachmentFileLineRange + push_attachment_git_hub_actions_job: PushAttachmentGitHubActionsJob + push_attachment_git_hub_commit: PushAttachmentGitHubCommit + push_attachment_git_hub_file: PushAttachmentGitHubFile + push_attachment_git_hub_file_diff: PushAttachmentGitHubFileDiff + push_attachment_git_hub_file_diff_side: PushAttachmentGitHubFileDiffSide + push_attachment_git_hub_reference: PushAttachmentGitHubReference + push_attachment_git_hub_reference_type: PushAttachmentGitHubReferenceTypeEnum + push_attachment_git_hub_release: PushAttachmentGitHubRelease + push_attachment_git_hub_repository: PushAttachmentGitHubRepository + push_attachment_git_hub_snippet: PushAttachmentGitHubSnippet + push_attachment_git_hub_tree_comparison: PushAttachmentGitHubTreeComparison + push_attachment_git_hub_tree_comparison_side: PushAttachmentGitHubTreeComparisonSide + push_attachment_git_hub_url: PushAttachmentGitHubURL + push_attachment_selection: PushAttachmentSelection + push_attachment_selection_details: PushAttachmentSelectionDetails + push_attachment_selection_details_end: PushAttachmentSelectionDetailsEnd + push_attachment_selection_details_start: PushAttachmentSelectionDetailsStart + push_git_hub_repo_ref: PushGitHubRepoRef + queue_begin_deferred_idle_drain_request: QueueBeginDeferredIdleDrainRequest + queue_begin_deferred_idle_drain_result: QueueBeginDeferredIdleDrainResult + queue_consume_system_notifications_request: QueueConsumeSystemNotificationsRequest queued_command_handled: QueuedCommandHandled queued_command_not_handled: QueuedCommandNotHandled queued_command_result: QueuedCommandResult + queue_defer_session_idle_request: QueueDeferSessionIdleRequest + queue_duplicate_at_request: QueueDuplicateAtRequest + queue_duplicate_at_result: QueueDuplicateAtResult + queue_enqueue_resume_pending_result: QueueEnqueueResumePendingResult + queue_finish_deferred_idle_drain_request: QueueFinishDeferredIdleDrainRequest + queue_finish_deferred_idle_drain_result: QueueFinishDeferredIdleDrainResult + queue_has_pending_result: QueueHasPendingResult + queue_insert_at_request: QueueInsertAtRequest + queue_insert_at_result: QueueInsertAtResult + queue_insert_message: QueueInsertMessage + queue_move_item_request: QueueMoveItemRequest + queue_move_item_result: QueueMoveItemResult queue_pending_items: QueuePendingItems queue_pending_items_kind: QueuePendingItemsKind queue_pending_items_result: QueuePendingItemsResult + queue_remove_at_request: QueueRemoveAtRequest + queue_remove_at_result: QueueRemoveAtResult queue_remove_most_recent_result: QueueRemoveMostRecentResult + queue_send_now_request: QueueSendNowRequest + queue_send_now_result: QueueSendNowResult + queue_set_drain_paused_request: QueueSetDrainPausedRequest + queue_snapshot_result: QueueSnapshotResult + queue_update_text_request: QueueUpdateTextRequest + queue_update_text_result: QueueUpdateTextResult register_event_interest_params: RegisterEventInterestParams register_event_interest_result: RegisterEventInterestResult + register_extension_tools_params: _RegisterExtensionToolsParams + register_extension_tools_result: _RegisterExtensionToolsResult release_event_interest_params: ReleaseEventInterestParams + remote_control_config: RemoteControlConfig + remote_control_config_existing_mc_session: RemoteControlConfigExistingMcSession + remote_control_status: RemoteControlStatus + remote_control_status_active: RemoteControlStatusActive + remote_control_status_connecting: RemoteControlStatusConnecting + remote_control_status_error: RemoteControlStatusError + remote_control_status_off: RemoteControlStatusOff + remote_control_status_result: RemoteControlStatusResult + remote_control_stop_result: RemoteControlStopResult + remote_control_transfer_result: RemoteControlTransferResult remote_enable_request: RemoteEnableRequest remote_enable_result: RemoteEnableResult remote_notify_steerable_changed_request: RemoteNotifySteerableChangedRequest remote_notify_steerable_changed_result: RemoteNotifySteerableChangedResult remote_session_connection_result: RemoteSessionConnectionResult + remote_session_metadata_repository: RemoteSessionMetadataRepository + remote_session_metadata_task_type: TaskType + remote_session_metadata_value: RemoteSessionMetadataValue remote_session_mode: RemoteSessionMode + remote_session_repository: RemoteSessionRepository + run_options: RunOptions + sandbox_config: SandboxConfig + sandbox_config_auth: SandboxConfigAuth + sandbox_config_user_policy: SandboxConfigUserPolicy + sandbox_config_user_policy_experimental: SandboxConfigUserPolicyExperimental + sandbox_config_user_policy_experimental_seatbelt: SandboxConfigUserPolicyExperimentalSeatbelt + sandbox_config_user_policy_filesystem: SandboxConfigUserPolicyFilesystem + sandbox_config_user_policy_network: SandboxConfigUserPolicyNetwork + sandbox_config_user_policy_network_proxy: SandboxConfigUserPolicyNetworkProxy + sandbox_config_user_policy_seatbelt: SandboxConfigUserPolicySeatbelt + schedule_add_at_request: ScheduleAddAtRequest + schedule_add_cron_request: ScheduleAddCronRequest + schedule_add_request: ScheduleAddRequest + schedule_add_result: ScheduleAddResult + schedule_add_self_paced_request: ScheduleAddSelfPacedRequest schedule_entry: ScheduleEntry + schedule_has_self_paced_result: ScheduleHasSelfPacedResult schedule_list: ScheduleList + schedule_rearm_self_paced_request: ScheduleRearmSelfPacedRequest schedule_stop_request: ScheduleStopRequest schedule_stop_result: ScheduleStopResult secrets_add_filter_values_request: SecretsAddFilterValuesRequest secrets_add_filter_values_result: SecretsAddFilterValuesResult send_agent_mode: SendAgentMode - send_attachment: SendAttachment - send_attachment_blob: SendAttachmentBlob - send_attachment_directory: SendAttachmentDirectory - send_attachment_file: SendAttachmentFile - send_attachment_file_line_range: SendAttachmentFileLineRange - send_attachment_github_reference: SendAttachmentGithubReference - send_attachment_github_reference_type: SendAttachmentGithubReferenceTypeEnum - send_attachment_selection: SendAttachmentSelection - send_attachment_selection_details: SendAttachmentSelectionDetails - send_attachment_selection_details_end: SendAttachmentSelectionDetailsEnd - send_attachment_selection_details_start: SendAttachmentSelectionDetailsStart + send_attachments_to_message_params: SendAttachmentsToMessageParams + send_message_item: SendMessageItem + send_messages_request: SendMessagesRequest + send_messages_result: SendMessagesResult send_mode: SendMode send_request: SendRequest send_result: SendResult + send_system_notification_request: SendSystemNotificationRequest + server_agent_list: ServerAgentList + server_instruction_source_list: ServerInstructionSourceList server_skill: ServerSkill server_skill_list: ServerSkillList + session_activity: SessionActivity + session_agent_list_request: SessionAgentListRequest session_auth_status: SessionAuthStatus session_bulk_delete_result: SessionBulkDeleteResult + session_cancel_all_background_agents_result: int + session_capability: SessionCapability + session_commands_list_request: SessionCommandsListRequest + session_completion_item: SessionCompletionItem session_context: SessionContext session_context_host_type: HostType session_enrich_metadata_result: SessionEnrichMetadataResult @@ -16024,7 +29528,7 @@ class RPC: session_fs_readdir_request: SessionFSReaddirRequest session_fs_readdir_result: SessionFSReaddirResult session_fs_readdir_with_types_entry: SessionFSReaddirWithTypesEntry - session_fs_readdir_with_types_entry_type: SessionFSReaddirWithTypesEntryType + session_fs_readdir_with_types_entry_type: DebugCollectLogsEntryKind session_fs_readdir_with_types_request: SessionFSReaddirWithTypesRequest session_fs_readdir_with_types_result: SessionFSReaddirWithTypesResult session_fs_read_file_request: SessionFSReadFileRequest @@ -16040,48 +29544,110 @@ class RPC: session_fs_sqlite_query_request: SessionFSSqliteQueryRequest session_fs_sqlite_query_result: SessionFSSqliteQueryResult session_fs_sqlite_query_type: SessionFSSqliteQueryType + session_fs_sqlite_transaction_error: SessionFSSqliteTransactionError + session_fs_sqlite_transaction_error_class: SessionFSSqliteTransactionErrorClass + session_fs_sqlite_transaction_request: SessionFSSqliteTransactionRequest + session_fs_sqlite_transaction_result: SessionFSSqliteTransactionResult + session_fs_sqlite_transaction_statement: SessionFSSqliteTransactionStatement session_fs_stat_request: SessionFSStatRequest session_fs_stat_result: SessionFSStatResult session_fs_write_file_request: SessionFSWriteFileRequest + session_history_compact_request: SessionHistoryCompactRequest session_installed_plugin: SessionInstalledPlugin session_installed_plugin_source: SessionInstalledPluginSource | str - session_installed_plugin_source_github: SessionInstalledPluginSourceGithub + session_installed_plugin_source_git_hub: SessionInstalledPluginSourceGitHub session_installed_plugin_source_local: SessionInstalledPluginSourceLocal session_installed_plugin_source_url: SessionInstalledPluginSourceURL + session_limit_prediction_baseline_data: SessionLimitPredictionBaselineData + session_limit_prediction_client_type: SessionLimitPredictionClientType + session_limit_prediction_details: SessionLimitPredictionDetails + session_limit_prediction_predict_request: SessionLimitPredictionPredictRequest + session_limit_prediction_request: Any + session_limit_prediction_result: SessionLimitPredictionResult + session_limit_prediction_source: SessionLimitPredictionSource + session_limit_prediction_tier: SessionLimitPredictionTier + session_limit_prediction_tier_option: SessionLimitPredictionTierOption + session_limit_prediction_unavailable_reason: SessionLimitPredictionUnavailableReason session_list: SessionList + session_list_entry: SessionListEntry session_list_filter: SessionListFilter session_load_deferred_repo_hooks_result: SessionLoadDeferredRepoHooksResult session_log_level: SessionLogLevel + session_managed_permissions: SessionManagedPermissions + session_managed_settings: SessionManagedSettings session_mcp_apps_call_tool_result: dict[str, Any] - session_metadata: SessionMetadata session_metadata_snapshot: SessionMetadataSnapshot session_mode: SessionMode session_model_list: SessionModelList + session_model_list_request: SessionModelListRequest + session_model_price_category: SessionModelPriceCategory + session_open_options: SessionOpenOptions + session_open_options_additional_content_exclusion_policy: SessionOpenOptionsAdditionalContentExclusionPolicy + session_open_options_additional_content_exclusion_policy_rule: SessionOpenOptionsAdditionalContentExclusionPolicyRule + session_open_options_additional_content_exclusion_policy_rule_source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource + session_open_options_additional_content_exclusion_policy_scope: AdditionalContentExclusionPolicyScope + session_open_options_env_value_mode: MCPSetEnvValueModeDetails + session_open_options_reasoning_summary: ReasoningSummary + session_open_params: SessionOpenParams + session_open_result: SessionOpenResult + session_plugins_reload_request: SessionPluginsReloadRequest + session_provider_get_endpoint_request: SessionProviderGetEndpointRequest session_prune_result: SessionPruneResult sessions_bulk_delete_request: SessionsBulkDeleteRequest sessions_check_in_use_request: SessionsCheckInUseRequest sessions_check_in_use_result: SessionsCheckInUseResult sessions_close_request: SessionsCloseRequest sessions_close_result: SessionsCloseResult + sessions_delete_request: SessionsDeleteRequest sessions_enrich_metadata_request: SessionsEnrichMetadataRequest session_set_credentials_params: SessionSetCredentialsParams session_set_credentials_result: SessionSetCredentialsResult + session_settings_built_in_tool_availability_snapshot: SessionSettingsBuiltInToolAvailabilitySnapshot + session_settings_evaluate_predicate_request: SessionSettingsEvaluatePredicateRequest + session_settings_evaluate_predicate_result: SessionSettingsEvaluatePredicateResult + session_settings_job_snapshot: SessionSettingsJobSnapshot + session_settings_model_snapshot: SessionSettingsModelSnapshot + session_settings_online_evaluation_snapshot: SessionSettingsOnlineEvaluationSnapshot + session_settings_predicate_name: SessionSettingsPredicateName + session_settings_repo_snapshot: SessionSettingsRepoSnapshot + session_settings_snapshot: SessionSettingsSnapshot + session_settings_validation_snapshot: SessionSettingsValidationSnapshot sessions_find_by_prefix_request: SessionsFindByPrefixRequest sessions_find_by_prefix_result: SessionsFindByPrefixResult sessions_find_by_task_id_request: SessionsFindByTaskIDRequest sessions_find_by_task_id_result: SessionsFindByTaskIDResult sessions_fork_request: SessionsForkRequest sessions_fork_result: SessionsForkResult + sessions_get_board_entry_count_request: SessionsGetBoardEntryCountRequest + sessions_get_board_entry_count_result: SessionsGetBoardEntryCountResult sessions_get_event_file_path_request: SessionsGetEventFilePathRequest sessions_get_event_file_path_result: SessionsGetEventFilePathResult sessions_get_last_for_context_request: SessionsGetLastForContextRequest sessions_get_last_for_context_result: SessionsGetLastForContextResult + sessions_get_metadata_request: SessionsGetMetadataRequest + sessions_get_metadata_result: SessionsGetMetadataResult sessions_get_persisted_remote_steerable_request: SessionsGetPersistedRemoteSteerableRequest sessions_get_persisted_remote_steerable_result: SessionsGetPersistedRemoteSteerableResult session_sizes: SessionSizes + sessions_list_non_empty_session_ids_request: SessionsListNonEmptySessionIDSRequest + sessions_list_non_empty_session_ids_result: SessionsListNonEmptySessionIDSResult sessions_list_request: SessionsListRequest sessions_load_deferred_repo_hooks_request: SessionsLoadDeferredRepoHooksRequest + sessions_open_attach: SessionsOpenAttach + sessions_open_cloud: SessionsOpenCloud + sessions_open_create: SessionsOpenCreate + sessions_open_handoff: SessionsOpenHandoff + sessions_open_handoff_task_type: TaskType + sessions_open_progress: SessionsOpenProgress + sessions_open_progress_status: SessionsOpenProgressStatus + sessions_open_progress_step: SessionsOpenProgressStep + sessions_open_remote: SessionsOpenRemote + sessions_open_resume: SessionsOpenResume + sessions_open_resume_last: SessionsOpenResumeLast + sessions_open_status: SessionsOpenStatus + session_source: SessionSource sessions_prune_old_request: SessionsPruneOldRequest + sessions_register_extension_tools_on_session_options: SessionsRegisterExtensionToolsOnSessionOptions sessions_release_lock_request: SessionsReleaseLockRequest sessions_release_lock_result: SessionsReleaseLockResult sessions_reload_plugin_hooks_request: SessionsReloadPluginHooksRequest @@ -16090,22 +29656,38 @@ class RPC: sessions_save_result: SessionsSaveResult sessions_set_additional_plugins_request: SessionsSetAdditionalPluginsRequest sessions_set_additional_plugins_result: SessionsSetAdditionalPluginsResult + sessions_set_remote_control_steering_request: SessionsSetRemoteControlSteeringRequest + sessions_start_remote_control_request: SessionsStartRemoteControlRequest + sessions_stop_remote_control_request: SessionsStopRemoteControlRequest + sessions_transfer_remote_control_request: SessionsTransferRemoteControlRequest + session_telemetry_engagement: SessionTelemetryEngagement session_update_options_params: SessionUpdateOptionsParams session_update_options_result: SessionUpdateOptionsResult + session_visibility_status: SessionVisibilityStatus session_working_directory_context: SessionWorkingDirectoryContext session_working_directory_context_host_type: HostType + shell_cancel_user_requested_request: ShellCancelUserRequestedRequest shell_exec_request: ShellExecRequest shell_exec_result: ShellExecResult + shell_execute_user_requested_request: ShellExecuteUserRequestedRequest + shell_init_profile: ShellInitProfile + shell_init_script: ShellInitScript + shell_init_script_shell: ShellInitScriptShell shell_kill_request: ShellKillRequest shell_kill_result: ShellKillResult shell_kill_signal: ShellKillSignal + shell_options: ShellOptions shutdown_request: ShutdownRequest skill: Skill + skill_discovery_path: SkillDiscoveryPath + skill_discovery_path_list: SkillDiscoveryPathList + skill_discovery_scope: SkillDiscoveryScope skill_list: SkillList skills_config_set_disabled_skills_request: SkillsConfigSetDisabledSkillsRequest skills_disable_request: SkillsDisableRequest skills_discover_request: SkillsDiscoverRequest skills_enable_request: SkillsEnableRequest + skills_get_discovery_paths_request: SkillsGetDiscoveryPathsRequest skills_get_invoked_result: SkillsGetInvokedResult skills_invoked_skill: SkillsInvokedSkill skills_load_diagnostics: SkillsLoadDiagnostics @@ -16113,12 +29695,15 @@ class RPC: slash_command_completed_result: SlashCommandCompletedResult slash_command_info: SlashCommandInfo slash_command_input: SlashCommandInput + slash_command_input_choice: SlashCommandInputChoice slash_command_input_completion: SlashCommandInputCompletion slash_command_invocation_result: SlashCommandInvocationResult slash_command_kind: SlashCommandKind slash_command_select_subcommand_option: SlashCommandSelectSubcommandOption slash_command_select_subcommand_result: SlashCommandSelectSubcommandResult slash_command_text_result: SlashCommandTextResult + subagent_settings_entry: SubagentSettingsEntry + subagent_settings_entry_context_tier: SubagentSettingsEntryContextTier task_agent_info: TaskAgentInfo task_agent_progress: TaskAgentProgress task_execution_mode: TaskExecutionMode @@ -16152,6 +29737,7 @@ class RPC: tools_get_current_metadata_result: ToolsGetCurrentMetadataResult tools_initialize_and_validate_result: ToolsInitializeAndValidateResult tools_list_request: ToolsListRequest + tools_update_subagent_settings_result: ToolsUpdateSubagentSettingsResult ui_auto_mode_switch_response: UIAutoModeSwitchResponse ui_elicitation_array_any_of_field: UIElicitationArrayAnyOfField ui_elicitation_array_any_of_field_items: UIElicitationArrayAnyOfFieldItems @@ -16174,6 +29760,8 @@ class RPC: ui_elicitation_string_enum_field: UIElicitationStringEnumField ui_elicitation_string_one_of_field: UIElicitationStringOneOfField ui_elicitation_string_one_of_field_one_of: UIElicitationStringOneOfFieldOneOf + ui_ephemeral_query_request: UIEphemeralQueryRequest + ui_ephemeral_query_result: UIEphemeralQueryResult ui_exit_plan_mode_action: UIExitPlanModeAction ui_exit_plan_mode_response: UIExitPlanModeResponse ui_handle_pending_auto_mode_switch_request: UIHandlePendingAutoModeSwitchRequest @@ -16182,11 +29770,15 @@ class RPC: ui_handle_pending_result: UIHandlePendingResult ui_handle_pending_sampling_request: UIHandlePendingSamplingRequest ui_handle_pending_sampling_response: dict[str, Any] + ui_handle_pending_session_limits_exhausted_request: UIHandlePendingSessionLimitsExhaustedRequest ui_handle_pending_user_input_request: UIHandlePendingUserInputRequest ui_register_direct_auto_mode_switch_handler_result: UIRegisterDirectAutoModeSwitchHandlerResult + ui_session_limits_exhausted_response: UISessionLimitsExhaustedResponse + ui_session_limits_exhausted_response_action: UISessionLimitsExhaustedResponseAction ui_unregister_direct_auto_mode_switch_handler_request: UIUnregisterDirectAutoModeSwitchHandlerRequest ui_unregister_direct_auto_mode_switch_handler_result: UIUnregisterDirectAutoModeSwitchHandlerResult ui_user_input_response: UIUserInputResponse + update_subagent_settings_request: UpdateSubagentSettingsRequest usage_get_metrics_result: UsageGetMetricsResult usage_metrics_code_changes: UsageMetricsCodeChanges usage_metrics_model_metric: UsageMetricsModelMetric @@ -16195,25 +29787,45 @@ class RPC: usage_metrics_model_metric_usage: UsageMetricsModelMetricUsage usage_metrics_token_detail: UsageMetricsTokenDetail user_auth_info: UserAuthInfo + user_requested_shell_command_result: UserRequestedShellCommandResult + user_setting_metadata: UserSettingMetadata + user_settings_get_result: UserSettingsGetResult + user_settings_set_request: UserSettingsSetRequest + user_settings_set_result: UserSettingsSetResult + visibility_get_result: VisibilityGetResult + visibility_set_request: VisibilitySetRequest + visibility_set_result: VisibilitySetResult workspace_diff_file_change: WorkspaceDiffFileChange workspace_diff_file_change_type: WorkspaceDiffFileChangeType workspace_diff_mode: WorkspaceDiffMode workspace_diff_result: WorkspaceDiffResult + workspaces_add_summary_request: WorkspacesAddSummaryRequest + workspaces_add_summary_result: WorkspacesAddSummaryResult + workspaces_autopilot_objective_exists_result: WorkspacesAutopilotObjectiveExistsResult workspaces_checkpoints: WorkspacesCheckpoints workspaces_create_file_request: WorkspacesCreateFileRequest + workspaces_delete_autopilot_objective_result: WorkspacesDeleteAutopilotObjectiveResult workspaces_diff_request: WorkspacesDiffRequest + workspaces_ensure_request: WorkspacesEnsureRequest workspaces_get_workspace_result: WorkspacesGetWorkspaceResult workspaces_list_checkpoints_result: WorkspacesListCheckpointsResult workspaces_list_files_result: WorkspacesListFilesResult + workspaces_read_autopilot_objective_result: WorkspacesReadAutopilotObjectiveResult workspaces_read_checkpoint_request: WorkspacesReadCheckpointRequest workspaces_read_checkpoint_result: WorkspacesReadCheckpointResult workspaces_read_file_request: WorkspacesReadFileRequest workspaces_read_file_result: WorkspacesReadFileResult workspaces_save_large_paste_request: WorkspacesSaveLargePasteRequest workspaces_save_large_paste_result: WorkspacesSaveLargePasteResult + workspaces_truncate_summaries_request: WorkspacesTruncateSummariesRequest workspace_summary_host_type: HostType + workspaces_update_metadata_request: WorkspacesUpdateMetadataRequest workspaces_workspace_details_host_type: HostType + workspaces_write_autopilot_objective_request: WorkspacesWriteAutopilotObjectiveRequest + workspaces_write_autopilot_objective_result: WorkspacesWriteAutopilotObjectiveResult + session_context_attribution: SessionContextAttribution | None = None session_context_info: SessionContextInfo | None = None + subagent_settings: SubagentSettings | None = None task_progress: TaskProgress | None = None workspace_summary: WorkspaceSummary | None = None @@ -16222,13 +29834,25 @@ def from_dict(obj: Any) -> 'RPC': assert isinstance(obj, dict) abort_request = AbortRequest.from_dict(obj.get("AbortRequest")) abort_result = AbortResult.from_dict(obj.get("AbortResult")) + account_all_users = AccountAllUsers.from_dict(obj.get("AccountAllUsers")) + account_get_all_users_result = from_list(AccountAllUsers.from_dict, obj.get("AccountGetAllUsersResult")) + account_get_current_auth_result = AccountGetCurrentAuthResult.from_dict(obj.get("AccountGetCurrentAuthResult")) account_get_quota_request = AccountGetQuotaRequest.from_dict(obj.get("AccountGetQuotaRequest")) account_get_quota_result = AccountGetQuotaResult.from_dict(obj.get("AccountGetQuotaResult")) + account_login_request = AccountLoginRequest.from_dict(obj.get("AccountLoginRequest")) + account_login_result = AccountLoginResult.from_dict(obj.get("AccountLoginResult")) + account_logout_request = AccountLogoutRequest.from_dict(obj.get("AccountLogoutRequest")) + account_logout_result = AccountLogoutResult.from_dict(obj.get("AccountLogoutResult")) account_quota_snapshot = AccountQuotaSnapshot.from_dict(obj.get("AccountQuotaSnapshot")) + adaptive_thinking_support = AdaptiveThinkingSupport(obj.get("AdaptiveThinkingSupport")) + agent_discovery_path = AgentDiscoveryPath.from_dict(obj.get("AgentDiscoveryPath")) + agent_discovery_path_list = AgentDiscoveryPathList.from_dict(obj.get("AgentDiscoveryPathList")) + agent_discovery_path_scope = AgentDiscoveryPathScope(obj.get("AgentDiscoveryPathScope")) agent_get_current_result = AgentGetCurrentResult.from_dict(obj.get("AgentGetCurrentResult")) agent_info = AgentInfo.from_dict(obj.get("AgentInfo")) agent_info_source = AgentInfoSource(obj.get("AgentInfoSource")) agent_list = AgentList.from_dict(obj.get("AgentList")) + agent_list_request = obj.get("AgentListRequest") agent_registry_live_target_entry = AgentRegistryLiveTargetEntry.from_dict(obj.get("AgentRegistryLiveTargetEntry")) agent_registry_live_target_entry_attention_kind = AgentRegistryLiveTargetEntryAttentionKind(obj.get("AgentRegistryLiveTargetEntryAttentionKind")) agent_registry_live_target_entry_kind = AgentRegistryLiveTargetEntryKind(obj.get("AgentRegistryLiveTargetEntryKind")) @@ -16246,20 +29870,25 @@ def from_dict(obj: Any) -> 'RPC': agent_registry_spawn_validation_error_field = AgentRegistrySpawnValidationErrorField(obj.get("AgentRegistrySpawnValidationErrorField")) agent_registry_spawn_validation_error_reason = AgentRegistrySpawnValidationErrorReason(obj.get("AgentRegistrySpawnValidationErrorReason")) agent_reload_result = AgentReloadResult.from_dict(obj.get("AgentReloadResult")) + agents_discover_request = AgentsDiscoverRequest.from_dict(obj.get("AgentsDiscoverRequest")) agent_select_request = AgentSelectRequest.from_dict(obj.get("AgentSelectRequest")) agent_select_result = AgentSelectResult.from_dict(obj.get("AgentSelectResult")) + agent_set_prompt_request = AgentSetPromptRequest.from_dict(obj.get("AgentSetPromptRequest")) + agents_get_discovery_paths_request = AgentsGetDiscoveryPathsRequest.from_dict(obj.get("AgentsGetDiscoveryPathsRequest")) allow_all_permission_set_result = AllowAllPermissionSetResult.from_dict(obj.get("AllowAllPermissionSetResult")) allow_all_permission_state = AllowAllPermissionState.from_dict(obj.get("AllowAllPermissionState")) api_key_auth_info = APIKeyAuthInfo.from_dict(obj.get("ApiKeyAuthInfo")) auth_info = _load_AuthInfo(obj.get("AuthInfo")) auth_info_type = AuthInfoType(obj.get("AuthInfoType")) + built_in_model_catalog = BuiltInModelCatalog.from_dict(obj.get("BuiltInModelCatalog")) + built_in_model_catalog_entry = BuiltInModelCatalogEntry.from_dict(obj.get("BuiltInModelCatalogEntry")) + cancel_user_requested_shell_command_result = CancelUserRequestedShellCommandResult.from_dict(obj.get("CancelUserRequestedShellCommandResult")) canvas_action = CanvasAction.from_dict(obj.get("CanvasAction")) canvas_action_invoke_request = CanvasActionInvokeRequest.from_dict(obj.get("CanvasActionInvokeRequest")) canvas_action_invoke_result = obj.get("CanvasActionInvokeResult") canvas_close_request = CanvasCloseRequest.from_dict(obj.get("CanvasCloseRequest")) canvas_host_context = CanvasHostContext.from_dict(obj.get("CanvasHostContext")) canvas_host_context_capabilities = CanvasHostContextCapabilities.from_dict(obj.get("CanvasHostContextCapabilities")) - canvas_instance_availability = CanvasInstanceAvailability(obj.get("CanvasInstanceAvailability")) canvas_json_schema = obj.get("CanvasJsonSchema") canvas_list = CanvasList.from_dict(obj.get("CanvasList")) canvas_list_open_result = CanvasListOpenResult.from_dict(obj.get("CanvasListOpenResult")) @@ -16269,20 +29898,29 @@ def from_dict(obj: Any) -> 'RPC': canvas_provider_open_request = CanvasProviderOpenRequest.from_dict(obj.get("CanvasProviderOpenRequest")) canvas_provider_open_result = CanvasProviderOpenResult.from_dict(obj.get("CanvasProviderOpenResult")) canvas_session_context = CanvasSessionContext.from_dict(obj.get("CanvasSessionContext")) + capi_session_options = CapiSessionOptions.from_dict(obj.get("CapiSessionOptions")) command_list = CommandList.from_dict(obj.get("CommandList")) commands_handle_pending_command_request = CommandsHandlePendingCommandRequest.from_dict(obj.get("CommandsHandlePendingCommandRequest")) commands_handle_pending_command_result = CommandsHandlePendingCommandResult.from_dict(obj.get("CommandsHandlePendingCommandResult")) commands_invoke_request = CommandsInvokeRequest.from_dict(obj.get("CommandsInvokeRequest")) - commands_list_request = CommandsListRequest.from_dict(obj.get("CommandsListRequest")) + commands_list_request = obj.get("CommandsListRequest") commands_respond_to_queued_command_request = CommandsRespondToQueuedCommandRequest.from_dict(obj.get("CommandsRespondToQueuedCommandRequest")) commands_respond_to_queued_command_result = CommandsRespondToQueuedCommandResult.from_dict(obj.get("CommandsRespondToQueuedCommandResult")) + completions_get_trigger_characters_result = CompletionsGetTriggerCharactersResult.from_dict(obj.get("CompletionsGetTriggerCharactersResult")) + completions_request_request = CompletionsRequestRequest.from_dict(obj.get("CompletionsRequestRequest")) + completions_request_result = CompletionsRequestResult.from_dict(obj.get("CompletionsRequestResult")) + configure_session_extensions_params = _ConfigureSessionExtensionsParams.from_dict(obj.get("ConfigureSessionExtensionsParams")) connected_remote_session_metadata = ConnectedRemoteSessionMetadata.from_dict(obj.get("ConnectedRemoteSessionMetadata")) connected_remote_session_metadata_kind = ConnectedRemoteSessionMetadataKind(obj.get("ConnectedRemoteSessionMetadataKind")) connected_remote_session_metadata_repository = ConnectedRemoteSessionMetadataRepository.from_dict(obj.get("ConnectedRemoteSessionMetadataRepository")) connect_remote_session_params = ConnectRemoteSessionParams.from_dict(obj.get("ConnectRemoteSessionParams")) connect_request = _ConnectRequest.from_dict(obj.get("ConnectRequest")) connect_result = _ConnectResult.from_dict(obj.get("ConnectResult")) + content_exclusion_check_paths_request = ContentExclusionCheckPathsRequest.from_dict(obj.get("ContentExclusionCheckPathsRequest")) + content_exclusion_check_paths_result = ContentExclusionCheckPathsResult.from_dict(obj.get("ContentExclusionCheckPathsResult")) + content_exclusion_path_check = ContentExclusionPathCheck.from_dict(obj.get("ContentExclusionPathCheck")) content_filter_mode = ContentFilterMode(obj.get("ContentFilterMode")) + context_heaviest_message = ContextHeaviestMessage.from_dict(obj.get("ContextHeaviestMessage")) copilot_api_token_auth_info = CopilotAPITokenAuthInfo.from_dict(obj.get("CopilotApiTokenAuthInfo")) copilot_user_response = CopilotUserResponse.from_dict(obj.get("CopilotUserResponse")) copilot_user_response_endpoints = CopilotUserResponseEndpoints.from_dict(obj.get("CopilotUserResponseEndpoints")) @@ -16292,7 +29930,26 @@ def from_dict(obj: Any) -> 'RPC': copilot_user_response_quota_snapshots_premium_interactions = CopilotUserResponseQuotaSnapshotsPremiumInteractions.from_dict(obj.get("CopilotUserResponseQuotaSnapshotsPremiumInteractions")) current_model = CurrentModel.from_dict(obj.get("CurrentModel")) current_tool_metadata = CurrentToolMetadata.from_dict(obj.get("CurrentToolMetadata")) + debug_collect_logs_collected_entry = DebugCollectLogsCollectedEntry.from_dict(obj.get("DebugCollectLogsCollectedEntry")) + debug_collect_logs_destination = DebugCollectLogsDestination.from_dict(obj.get("DebugCollectLogsDestination")) + debug_collect_logs_entry = DebugCollectLogsEntry.from_dict(obj.get("DebugCollectLogsEntry")) + debug_collect_logs_entry_kind = DebugCollectLogsEntryKind(obj.get("DebugCollectLogsEntryKind")) + debug_collect_logs_include = DebugCollectLogsInclude.from_dict(obj.get("DebugCollectLogsInclude")) + debug_collect_logs_redaction = DebugCollectLogsRedaction(obj.get("DebugCollectLogsRedaction")) + debug_collect_logs_request = DebugCollectLogsRequest.from_dict(obj.get("DebugCollectLogsRequest")) + debug_collect_logs_result = DebugCollectLogsResult.from_dict(obj.get("DebugCollectLogsResult")) + debug_collect_logs_result_kind = DebugCollectLogsResultKind(obj.get("DebugCollectLogsResultKind")) + debug_collect_logs_skipped_entry = DebugCollectLogsSkippedEntry.from_dict(obj.get("DebugCollectLogsSkippedEntry")) + debug_collect_logs_source = DebugCollectLogsSource(obj.get("DebugCollectLogsSource")) + disable_bypass_permissions_mode = DisableBypassPermissionsMode(obj.get("DisableBypassPermissionsMode")) discovered_canvas = DiscoveredCanvas.from_dict(obj.get("DiscoveredCanvas")) + discovered_extension = DiscoveredExtension.from_dict(obj.get("DiscoveredExtension")) + discovered_extension_mode = DiscoveredExtensionMode(obj.get("DiscoveredExtensionMode")) + discovered_extension_plugin = DiscoveredExtensionPlugin.from_dict(obj.get("DiscoveredExtensionPlugin")) + discovered_extensions = DiscoveredExtensions.from_dict(obj.get("DiscoveredExtensions")) + discovered_extensions_disable_request = DiscoveredExtensionsDisableRequest.from_dict(obj.get("DiscoveredExtensionsDisableRequest")) + discovered_extensions_enable_request = DiscoveredExtensionsEnableRequest.from_dict(obj.get("DiscoveredExtensionsEnableRequest")) + discovered_extension_source = DiscoveredExtensionSource(obj.get("DiscoveredExtensionSource")) discovered_mcp_server = DiscoveredMCPServer.from_dict(obj.get("DiscoveredMcpServer")) discovered_mcp_server_type = DiscoveredMCPServerType(obj.get("DiscoveredMcpServerType")) enqueue_command_params = EnqueueCommandParams.from_dict(obj.get("EnqueueCommandParams")) @@ -16304,10 +29961,15 @@ def from_dict(obj: Any) -> 'RPC': event_log_types = from_union([lambda x: from_list(from_str, x), EventLogTypes], obj.get("EventLogTypes")) events_agent_scope = EventsAgentScope(obj.get("EventsAgentScope")) events_cursor_status = EventsCursorStatus(obj.get("EventsCursorStatus")) + events_read_direction = EventsReadDirection(obj.get("EventsReadDirection")) events_read_result = EventsReadResult.from_dict(obj.get("EventsReadResult")) execute_command_params = ExecuteCommandParams.from_dict(obj.get("ExecuteCommandParams")) execute_command_result = ExecuteCommandResult.from_dict(obj.get("ExecuteCommandResult")) extension = Extension.from_dict(obj.get("Extension")) + extension_context_push_input = ExtensionContextPushInput.from_dict(obj.get("ExtensionContextPushInput")) + extension_launch_profile = ExtensionLaunchProfile.from_dict(obj.get("ExtensionLaunchProfile")) + extension_launch_provider_resolve_request = ExtensionLaunchProviderResolveRequest.from_dict(obj.get("ExtensionLaunchProviderResolveRequest")) + extension_launch_provider_resolve_result = ExtensionLaunchProviderResolveResult.from_dict(obj.get("ExtensionLaunchProviderResolveResult")) extension_list = ExtensionList.from_dict(obj.get("ExtensionList")) extensions_disable_request = ExtensionsDisableRequest.from_dict(obj.get("ExtensionsDisableRequest")) extensions_enable_request = ExtensionsEnableRequest.from_dict(obj.get("ExtensionsEnableRequest")) @@ -16325,8 +29987,47 @@ def from_dict(obj: Any) -> 'RPC': external_tool_text_result_for_llm_content_resource_link = ExternalToolTextResultForLlmContentResourceLink.from_dict(obj.get("ExternalToolTextResultForLlmContentResourceLink")) external_tool_text_result_for_llm_content_resource_link_icon = ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict(obj.get("ExternalToolTextResultForLlmContentResourceLinkIcon")) external_tool_text_result_for_llm_content_resource_link_icon_theme = Theme(obj.get("ExternalToolTextResultForLlmContentResourceLinkIconTheme")) + external_tool_text_result_for_llm_content_shell_exit = ExternalToolTextResultForLlmContentShellExit.from_dict(obj.get("ExternalToolTextResultForLlmContentShellExit")) external_tool_text_result_for_llm_content_terminal = ExternalToolTextResultForLlmContentTerminal.from_dict(obj.get("ExternalToolTextResultForLlmContentTerminal")) external_tool_text_result_for_llm_content_text = ExternalToolTextResultForLlmContentText.from_dict(obj.get("ExternalToolTextResultForLlmContentText")) + factory_abort_request = FactoryAbortRequest.from_dict(obj.get("FactoryAbortRequest")) + factory_ack_result = FactoryACKResult.from_dict(obj.get("FactoryAckResult")) + factory_agent_options = FactoryAgentOptions.from_dict(obj.get("FactoryAgentOptions")) + factory_agent_request = FactoryAgentRequest.from_dict(obj.get("FactoryAgentRequest")) + factory_agent_result = FactoryAgentResult.from_dict(obj.get("FactoryAgentResult")) + factory_agent_summary = FactoryAgentSummary.from_dict(obj.get("FactoryAgentSummary")) + factory_cancel_request = FactoryCancelRequest.from_dict(obj.get("FactoryCancelRequest")) + factory_current_phase = FactoryCurrentPhase.from_dict(obj.get("FactoryCurrentPhase")) + factory_declared_limits = FactoryDeclaredLimits.from_dict(obj.get("FactoryDeclaredLimits")) + factory_durable_operation = FactoryDurableOperation(obj.get("FactoryDurableOperation")) + factory_execute_request = FactoryExecuteRequest.from_dict(obj.get("FactoryExecuteRequest")) + factory_execute_result = FactoryExecuteResult.from_dict(obj.get("FactoryExecuteResult")) + factory_get_run_progress_request = FactoryGetRunProgressRequest.from_dict(obj.get("FactoryGetRunProgressRequest")) + factory_get_run_request = FactoryGetRunRequest.from_dict(obj.get("FactoryGetRunRequest")) + factory_journal_get_request = FactoryJournalGetRequest.from_dict(obj.get("FactoryJournalGetRequest")) + factory_journal_get_result = FactoryJournalGetResult.from_dict(obj.get("FactoryJournalGetResult")) + factory_journal_put_request = FactoryJournalPutRequest.from_dict(obj.get("FactoryJournalPutRequest")) + factory_list_runs_request = FactoryListRunsRequest.from_dict(obj.get("FactoryListRunsRequest")) + factory_list_runs_result = FactoryListRunsResult.from_dict(obj.get("FactoryListRunsResult")) + factory_log_line = FactoryLogLine.from_dict(obj.get("FactoryLogLine")) + factory_log_line_kind = FactoryLogLineKind(obj.get("FactoryLogLineKind")) + factory_log_request = FactoryLogRequest.from_dict(obj.get("FactoryLogRequest")) + factory_phase_observation = FactoryPhaseObservation.from_dict(obj.get("FactoryPhaseObservation")) + factory_phase_status = FactoryPhaseStatus(obj.get("FactoryPhaseStatus")) + factory_progress_line = FactoryProgressLine.from_dict(obj.get("FactoryProgressLine")) + factory_progress_page = FactoryProgressPage.from_dict(obj.get("FactoryProgressPage")) + factory_resume_request = FactoryResumeRequest.from_dict(obj.get("FactoryResumeRequest")) + factory_resume_result = FactoryResumeResult.from_dict(obj.get("FactoryResumeResult")) + factory_run_consumed = FactoryRunConsumed.from_dict(obj.get("FactoryRunConsumed")) + factory_run_detail = FactoryRunDetail.from_dict(obj.get("FactoryRunDetail")) + factory_run_failure = FactoryRunFailure.from_dict(obj.get("FactoryRunFailure")) + factory_run_failure_kind = FactoryRunFailureKind(obj.get("FactoryRunFailureKind")) + factory_run_limits = FactoryRunLimits.from_dict(obj.get("FactoryRunLimits")) + factory_run_request = FactoryRunRequest.from_dict(obj.get("FactoryRunRequest")) + factory_run_result = FactoryRunResult.from_dict(obj.get("FactoryRunResult")) + factory_run_status = FactoryRunStatus(obj.get("FactoryRunStatus")) + factory_run_summary = FactoryRunSummary.from_dict(obj.get("FactoryRunSummary")) + factory_run_terminal = FactoryRunTerminal.from_dict(obj.get("FactoryRunTerminal")) filter_mapping = from_union([lambda x: from_dict(ContentFilterMode, x), ContentFilterMode], obj.get("FilterMapping")) fleet_start_request = FleetStartRequest.from_dict(obj.get("FleetStartRequest")) fleet_start_result = FleetStartResult.from_dict(obj.get("FleetStartResult")) @@ -16334,29 +30035,82 @@ def from_dict(obj: Any) -> 'RPC': folder_trust_check_params = FolderTrustCheckParams.from_dict(obj.get("FolderTrustCheckParams")) folder_trust_check_result = FolderTrustCheckResult.from_dict(obj.get("FolderTrustCheckResult")) gh_cli_auth_info = GhCLIAuthInfo.from_dict(obj.get("GhCliAuthInfo")) + git_hub_telemetry_client_info = GitHubTelemetryClientInfo.from_dict(obj.get("GitHubTelemetryClientInfo")) + git_hub_telemetry_event = GitHubTelemetryEvent.from_dict(obj.get("GitHubTelemetryEvent")) + git_hub_telemetry_notification = GitHubTelemetryNotification.from_dict(obj.get("GitHubTelemetryNotification")) handle_pending_tool_call_request = HandlePendingToolCallRequest.from_dict(obj.get("HandlePendingToolCallRequest")) handle_pending_tool_call_result = HandlePendingToolCallResult.from_dict(obj.get("HandlePendingToolCallResult")) history_abort_manual_compaction_result = HistoryAbortManualCompactionResult.from_dict(obj.get("HistoryAbortManualCompactionResult")) history_cancel_background_compaction_result = HistoryCancelBackgroundCompactionResult.from_dict(obj.get("HistoryCancelBackgroundCompactionResult")) + history_clear_context_request = HistoryClearContextRequest.from_dict(obj.get("HistoryClearContextRequest")) + history_clear_context_result = HistoryClearContextResult.from_dict(obj.get("HistoryClearContextResult")) history_compact_context_window = HistoryCompactContextWindow.from_dict(obj.get("HistoryCompactContextWindow")) - history_compact_request = HistoryCompactRequest.from_dict(obj.get("HistoryCompactRequest")) + history_compact_request = obj.get("HistoryCompactRequest") history_compact_result = HistoryCompactResult.from_dict(obj.get("HistoryCompactResult")) + history_file_restore_skip_reason = HistoryFileRestoreSkipReason(obj.get("HistoryFileRestoreSkipReason")) + history_list_rewind_points_result = HistoryListRewindPointsResult.from_dict(obj.get("HistoryListRewindPointsResult")) + history_preview_rewind_request = HistoryPreviewRewindRequest.from_dict(obj.get("HistoryPreviewRewindRequest")) + history_preview_rewind_result = HistoryPreviewRewindResult.from_dict(obj.get("HistoryPreviewRewindResult")) + history_rewind_change_type = HistoryRewindChangeType(obj.get("HistoryRewindChangeType")) + history_rewind_file_preview = HistoryRewindFilePreview.from_dict(obj.get("HistoryRewindFilePreview")) + history_rewind_mode = HistoryRewindMode(obj.get("HistoryRewindMode")) + history_rewind_outcome = HistoryRewindOutcome(obj.get("HistoryRewindOutcome")) + history_rewind_point = HistoryRewindPoint.from_dict(obj.get("HistoryRewindPoint")) + history_rewind_request = HistoryRewindRequest.from_dict(obj.get("HistoryRewindRequest")) + history_rewind_result = HistoryRewindResult.from_dict(obj.get("HistoryRewindResult")) + history_rewind_unavailable_reason = HistoryRewindUnavailableReason(obj.get("HistoryRewindUnavailableReason")) + history_skipped_file_restore = HistorySkippedFileRestore.from_dict(obj.get("HistorySkippedFileRestore")) history_summarize_for_handoff_result = HistorySummarizeForHandoffResult.from_dict(obj.get("HistorySummarizeForHandoffResult")) history_truncate_request = HistoryTruncateRequest.from_dict(obj.get("HistoryTruncateRequest")) history_truncate_result = HistoryTruncateResult.from_dict(obj.get("HistoryTruncateResult")) hmac_auth_info = HMACAuthInfo.from_dict(obj.get("HMACAuthInfo")) + hook_invoke_request = _HookInvokeRequest.from_dict(obj.get("HookInvokeRequest")) + hook_invoke_response = _HookInvokeResponse.from_dict(obj.get("HookInvokeResponse")) + hook_type = _HookType(obj.get("HookType")) installed_plugin = InstalledPlugin.from_dict(obj.get("InstalledPlugin")) + installed_plugin_info = InstalledPluginInfo.from_dict(obj.get("InstalledPluginInfo")) installed_plugin_source = from_union([InstalledPluginSource.from_dict, from_str], obj.get("InstalledPluginSource")) - installed_plugin_source_github = InstalledPluginSourceGithub.from_dict(obj.get("InstalledPluginSourceGithub")) + installed_plugin_source_git_hub = InstalledPluginSourceGitHub.from_dict(obj.get("InstalledPluginSourceGitHub")) installed_plugin_source_local = InstalledPluginSourceLocal.from_dict(obj.get("InstalledPluginSourceLocal")) installed_plugin_source_url = InstalledPluginSourceURL.from_dict(obj.get("InstalledPluginSourceUrl")) + instruction_discovery_path = InstructionDiscoveryPath.from_dict(obj.get("InstructionDiscoveryPath")) + instruction_discovery_path_kind = DebugCollectLogsEntryKind(obj.get("InstructionDiscoveryPathKind")) + instruction_discovery_path_list = InstructionDiscoveryPathList.from_dict(obj.get("InstructionDiscoveryPathList")) + instruction_discovery_path_location = InstructionLocation(obj.get("InstructionDiscoveryPathLocation")) + instructions_discover_request = InstructionsDiscoverRequest.from_dict(obj.get("InstructionsDiscoverRequest")) + instructions_get_discovery_paths_request = InstructionsGetDiscoveryPathsRequest.from_dict(obj.get("InstructionsGetDiscoveryPathsRequest")) instructions_get_sources_result = InstructionsGetSourcesResult.from_dict(obj.get("InstructionsGetSourcesResult")) - instructions_sources = InstructionsSources.from_dict(obj.get("InstructionsSources")) - instructions_sources_location = InstructionsSourcesLocation(obj.get("InstructionsSourcesLocation")) - instructions_sources_type = InstructionsSourcesType(obj.get("InstructionsSourcesType")) + instruction_source = InstructionSource.from_dict(obj.get("InstructionSource")) + instruction_source_location = InstructionLocation(obj.get("InstructionSourceLocation")) + instruction_source_type = InstructionSourceType(obj.get("InstructionSourceType")) + interrupt_main_turn_request = InterruptMainTurnRequest.from_dict(obj.get("InterruptMainTurnRequest")) + interrupt_main_turn_result = InterruptMainTurnResult.from_dict(obj.get("InterruptMainTurnResult")) + llm_inference_headers = from_dict(lambda x: from_list(from_str, x), obj.get("LlmInferenceHeaders")) + llm_inference_http_request_chunk_request = LlmInferenceHTTPRequestChunkRequest.from_dict(obj.get("LlmInferenceHttpRequestChunkRequest")) + llm_inference_http_request_chunk_result = LlmInferenceHTTPRequestChunkResult.from_dict(obj.get("LlmInferenceHttpRequestChunkResult")) + llm_inference_http_request_start_request = LlmInferenceHTTPRequestStartRequest.from_dict(obj.get("LlmInferenceHttpRequestStartRequest")) + llm_inference_http_request_start_result = LlmInferenceHTTPRequestStartResult.from_dict(obj.get("LlmInferenceHttpRequestStartResult")) + llm_inference_http_request_start_transport = LlmInferenceHTTPRequestStartTransport(obj.get("LlmInferenceHttpRequestStartTransport")) + llm_inference_http_response_chunk_error = LlmInferenceHTTPResponseChunkError.from_dict(obj.get("LlmInferenceHttpResponseChunkError")) + llm_inference_http_response_chunk_request = LlmInferenceHTTPResponseChunkRequest.from_dict(obj.get("LlmInferenceHttpResponseChunkRequest")) + llm_inference_http_response_chunk_result = LlmInferenceHTTPResponseChunkResult.from_dict(obj.get("LlmInferenceHttpResponseChunkResult")) + llm_inference_http_response_start_request = LlmInferenceHTTPResponseStartRequest.from_dict(obj.get("LlmInferenceHttpResponseStartRequest")) + llm_inference_http_response_start_result = LlmInferenceHTTPResponseStartResult.from_dict(obj.get("LlmInferenceHttpResponseStartResult")) + llm_inference_set_provider_result = LlmInferenceSetProviderResult.from_dict(obj.get("LlmInferenceSetProviderResult")) + local_session_metadata_value = LocalSessionMetadataValue.from_dict(obj.get("LocalSessionMetadataValue")) log_request = LogRequest.from_dict(obj.get("LogRequest")) log_result = LogResult.from_dict(obj.get("LogResult")) lsp_initialize_request = LspInitializeRequest.from_dict(obj.get("LspInitializeRequest")) + managed_settings_read_result = ManagedSettingsReadResult.from_dict(obj.get("ManagedSettingsReadResult")) + marketplace_add_result = MarketplaceAddResult.from_dict(obj.get("MarketplaceAddResult")) + marketplace_browse_result = MarketplaceBrowseResult.from_dict(obj.get("MarketplaceBrowseResult")) + marketplace_info = MarketplaceInfo.from_dict(obj.get("MarketplaceInfo")) + marketplace_list_result = MarketplaceListResult.from_dict(obj.get("MarketplaceListResult")) + marketplace_plugin_info = MarketplacePluginInfo.from_dict(obj.get("MarketplacePluginInfo")) + marketplace_refresh_entry = MarketplaceRefreshEntry.from_dict(obj.get("MarketplaceRefreshEntry")) + marketplace_refresh_result = MarketplaceRefreshResult.from_dict(obj.get("MarketplaceRefreshResult")) + marketplace_remove_result = MarketplaceRemoveResult.from_dict(obj.get("MarketplaceRemoveResult")) + mcp_allowed_server = MCPAllowedServer.from_dict(obj.get("McpAllowedServer")) mcp_apps_call_tool_request = MCPAppsCallToolRequest.from_dict(obj.get("McpAppsCallToolRequest")) mcp_apps_diagnose_capability = MCPAppsDiagnoseCapability.from_dict(obj.get("McpAppsDiagnoseCapability")) mcp_apps_diagnose_request = MCPAppsDiagnoseRequest.from_dict(obj.get("McpAppsDiagnoseRequest")) @@ -16387,6 +30141,8 @@ def from_dict(obj: Any) -> 'RPC': mcp_config_list = MCPConfigList.from_dict(obj.get("McpConfigList")) mcp_config_remove_request = MCPConfigRemoveRequest.from_dict(obj.get("McpConfigRemoveRequest")) mcp_config_update_request = MCPConfigUpdateRequest.from_dict(obj.get("McpConfigUpdateRequest")) + mcp_configure_git_hub_request = MCPConfigureGitHubRequest.from_dict(obj.get("McpConfigureGitHubRequest")) + mcp_configure_git_hub_result = MCPConfigureGitHubResult.from_dict(obj.get("McpConfigureGitHubResult")) mcp_disable_request = MCPDisableRequest.from_dict(obj.get("McpDisableRequest")) mcp_discover_request = MCPDiscoverRequest.from_dict(obj.get("McpDiscoverRequest")) mcp_discover_result = MCPDiscoverResult.from_dict(obj.get("McpDiscoverResult")) @@ -16394,23 +30150,67 @@ def from_dict(obj: Any) -> 'RPC': mcp_execute_sampling_params = MCPExecuteSamplingParams.from_dict(obj.get("McpExecuteSamplingParams")) mcp_execute_sampling_request = from_dict(lambda x: x, obj.get("McpExecuteSamplingRequest")) mcp_execute_sampling_result = from_dict(lambda x: x, obj.get("McpExecuteSamplingResult")) + mcp_filtered_server = MCPFilteredServer.from_dict(obj.get("McpFilteredServer")) + mcp_headers_handle_pending_headers_refresh_request = MCPHeadersHandlePendingHeadersRefreshRequest.from_dict(obj.get("McpHeadersHandlePendingHeadersRefreshRequest")) + mcp_headers_handle_pending_headers_refresh_request_request = MCPHeadersHandlePendingHeadersRefreshRequestRequest.from_dict(obj.get("McpHeadersHandlePendingHeadersRefreshRequestRequest")) + mcp_headers_handle_pending_headers_refresh_request_result = MCPHeadersHandlePendingHeadersRefreshRequestResult.from_dict(obj.get("McpHeadersHandlePendingHeadersRefreshRequestResult")) + mcp_host_state = MCPHostState.from_dict(obj.get("McpHostState")) + mcp_is_server_running_request = MCPIsServerRunningRequest.from_dict(obj.get("McpIsServerRunningRequest")) + mcp_is_server_running_result = MCPIsServerRunningResult.from_dict(obj.get("McpIsServerRunningResult")) + mcp_list_tools_request = MCPListToolsRequest.from_dict(obj.get("McpListToolsRequest")) + mcp_list_tools_result = MCPListToolsResult.from_dict(obj.get("McpListToolsResult")) + mcp_oauth_authentication_state_changed_request = MCPOauthAuthenticationStateChangedRequest.from_dict(obj.get("McpOauthAuthenticationStateChangedRequest")) + mcp_oauth_handle_pending_request = MCPOauthHandlePendingRequest.from_dict(obj.get("McpOauthHandlePendingRequest")) + mcp_oauth_handle_pending_result = MCPOauthHandlePendingResult.from_dict(obj.get("McpOauthHandlePendingResult")) + mcp_oauth_login_grant_type = MCPGrantType(obj.get("McpOauthLoginGrantType")) mcp_oauth_login_request = MCPOauthLoginRequest.from_dict(obj.get("McpOauthLoginRequest")) mcp_oauth_login_result = MCPOauthLoginResult.from_dict(obj.get("McpOauthLoginResult")) + mcp_oauth_pending_request_response = MCPOauthPendingRequestResponse.from_dict(obj.get("McpOauthPendingRequestResponse")) + mcp_oauth_respond_request = MCPOauthRespondRequest.from_dict(obj.get("McpOauthRespondRequest")) + mcp_oauth_respond_result = MCPOauthRespondResult.from_dict(obj.get("McpOauthRespondResult")) + mcp_register_external_client_request = MCPRegisterExternalClientRequest.from_dict(obj.get("McpRegisterExternalClientRequest")) + mcp_reload_with_config_request = MCPReloadWithConfigRequest.from_dict(obj.get("McpReloadWithConfigRequest")) mcp_remove_git_hub_result = MCPRemoveGitHubResult.from_dict(obj.get("McpRemoveGitHubResult")) + mcp_resource = MCPResource.from_dict(obj.get("McpResource")) + mcp_resource_annotations = MCPResourceAnnotations.from_dict(obj.get("McpResourceAnnotations")) + mcp_resource_content = MCPResourceContent.from_dict(obj.get("McpResourceContent")) + mcp_resource_icon = MCPResourceIcon.from_dict(obj.get("McpResourceIcon")) + mcp_resources_list_request = MCPResourcesListRequest.from_dict(obj.get("McpResourcesListRequest")) + mcp_resources_list_result = MCPResourcesListResult.from_dict(obj.get("McpResourcesListResult")) + mcp_resources_list_templates_request = MCPResourcesListTemplatesRequest.from_dict(obj.get("McpResourcesListTemplatesRequest")) + mcp_resources_list_templates_result = MCPResourcesListTemplatesResult.from_dict(obj.get("McpResourcesListTemplatesResult")) + mcp_resources_read_request = MCPResourcesReadRequest.from_dict(obj.get("McpResourcesReadRequest")) + mcp_resources_read_result = MCPResourcesReadResult.from_dict(obj.get("McpResourcesReadResult")) + mcp_resource_template = MCPResourceTemplate.from_dict(obj.get("McpResourceTemplate")) + mcp_restart_server_request = MCPRestartServerRequest.from_dict(obj.get("McpRestartServerRequest")) mcp_sampling_execution_action = MCPSamplingExecutionAction(obj.get("McpSamplingExecutionAction")) mcp_sampling_execution_result = MCPSamplingExecutionResult.from_dict(obj.get("McpSamplingExecutionResult")) mcp_server = MCPServer.from_dict(obj.get("McpServer")) mcp_server_auth_config = from_union([from_bool, MCPServerAuthConfigRedirectPort.from_dict], obj.get("McpServerAuthConfig")) mcp_server_auth_config_redirect_port = MCPServerAuthConfigRedirectPort.from_dict(obj.get("McpServerAuthConfigRedirectPort")) mcp_server_config = MCPServerConfig.from_dict(obj.get("McpServerConfig")) + mcp_server_config_defer_tools = MCPServerConfigDeferTools(obj.get("McpServerConfigDeferTools")) mcp_server_config_http = MCPServerConfigHTTP.from_dict(obj.get("McpServerConfigHttp")) - mcp_server_config_http_oauth_grant_type = MCPServerConfigHTTPOauthGrantType(obj.get("McpServerConfigHttpOauthGrantType")) + mcp_server_config_http_oauth_grant_type = MCPGrantType(obj.get("McpServerConfigHttpOauthGrantType")) mcp_server_config_http_type = MCPServerConfigHTTPType(obj.get("McpServerConfigHttpType")) mcp_server_config_stdio = MCPServerConfigStdio.from_dict(obj.get("McpServerConfigStdio")) + mcp_server_failure_info = MCPServerFailureInfo.from_dict(obj.get("McpServerFailureInfo")) mcp_server_list = MCPServerList.from_dict(obj.get("McpServerList")) + mcp_server_needs_auth_info = MCPServerNeedsAuthInfo.from_dict(obj.get("McpServerNeedsAuthInfo")) mcp_set_env_value_mode_details = MCPSetEnvValueModeDetails(obj.get("McpSetEnvValueModeDetails")) mcp_set_env_value_mode_params = MCPSetEnvValueModeParams.from_dict(obj.get("McpSetEnvValueModeParams")) mcp_set_env_value_mode_result = MCPSetEnvValueModeResult.from_dict(obj.get("McpSetEnvValueModeResult")) + mcp_start_server_request = MCPStartServerRequest.from_dict(obj.get("McpStartServerRequest")) + mcp_start_servers_result = MCPStartServersResult.from_dict(obj.get("McpStartServersResult")) + mcp_stop_server_request = MCPStopServerRequest.from_dict(obj.get("McpStopServerRequest")) + mcp_tools = MCPTools.from_dict(obj.get("McpTools")) + mcp_tool_ui = MCPToolUI.from_dict(obj.get("McpToolUi")) + mcp_tool_ui_visibility = MCPToolUIVisibility(obj.get("McpToolUiVisibility")) + mcp_unregister_external_client_request = MCPUnregisterExternalClientRequest.from_dict(obj.get("McpUnregisterExternalClientRequest")) + memory_configuration = MemoryConfiguration.from_dict(obj.get("MemoryConfiguration")) + metadata_context_attribution_result = MetadataContextAttributionResult.from_dict(obj.get("MetadataContextAttributionResult")) + metadata_context_heaviest_messages_request = MetadataContextHeaviestMessagesRequest.from_dict(obj.get("MetadataContextHeaviestMessagesRequest")) + metadata_context_heaviest_messages_result = MetadataContextHeaviestMessagesResult.from_dict(obj.get("MetadataContextHeaviestMessagesResult")) metadata_context_info_request = MetadataContextInfoRequest.from_dict(obj.get("MetadataContextInfoRequest")) metadata_context_info_result = MetadataContextInfoResult.from_dict(obj.get("MetadataContextInfoResult")) metadata_is_processing_result = MetadataIsProcessingResult.from_dict(obj.get("MetadataIsProcessingResult")) @@ -16423,9 +30223,10 @@ def from_dict(obj: Any) -> 'RPC': metadata_snapshot_current_mode = MetadataSnapshotCurrentMode(obj.get("MetadataSnapshotCurrentMode")) metadata_snapshot_remote_metadata = MetadataSnapshotRemoteMetadata.from_dict(obj.get("MetadataSnapshotRemoteMetadata")) metadata_snapshot_remote_metadata_repository = MetadataSnapshotRemoteMetadataRepository.from_dict(obj.get("MetadataSnapshotRemoteMetadataRepository")) - metadata_snapshot_remote_metadata_task_type = MetadataSnapshotRemoteMetadataTaskType(obj.get("MetadataSnapshotRemoteMetadataTaskType")) + metadata_snapshot_remote_metadata_task_type = TaskType(obj.get("MetadataSnapshotRemoteMetadataTaskType")) model = Model.from_dict(obj.get("Model")) model_billing = ModelBilling.from_dict(obj.get("ModelBilling")) + model_billing_promo = ModelBillingPromo.from_dict(obj.get("ModelBillingPromo")) model_billing_token_prices = ModelBillingTokenPrices.from_dict(obj.get("ModelBillingTokenPrices")) model_billing_token_prices_long_context = ModelBillingTokenPricesLongContext.from_dict(obj.get("ModelBillingTokenPricesLongContext")) model_capabilities = ModelCapabilities.from_dict(obj.get("ModelCapabilities")) @@ -16436,9 +30237,8 @@ def from_dict(obj: Any) -> 'RPC': model_capabilities_override_limits_vision = ModelCapabilitiesOverrideLimitsVision.from_dict(obj.get("ModelCapabilitiesOverrideLimitsVision")) model_capabilities_override_supports = ModelCapabilitiesOverrideSupports.from_dict(obj.get("ModelCapabilitiesOverrideSupports")) model_capabilities_supports = ModelCapabilitiesSupports.from_dict(obj.get("ModelCapabilitiesSupports")) - model_current_context_tier = ModelCurrentContextTier(obj.get("ModelCurrentContextTier")) model_list = ModelList.from_dict(obj.get("ModelList")) - model_list_request = ModelListRequest.from_dict(obj.get("ModelListRequest")) + model_list_request = obj.get("ModelListRequest") model_picker_category = ModelPickerCategory(obj.get("ModelPickerCategory")) model_picker_price_category = ModelPickerPriceCategory(obj.get("ModelPickerPriceCategory")) model_policy = ModelPolicy.from_dict(obj.get("ModelPolicy")) @@ -16449,12 +30249,19 @@ def from_dict(obj: Any) -> 'RPC': model_switch_to_request = ModelSwitchToRequest.from_dict(obj.get("ModelSwitchToRequest")) model_switch_to_result = ModelSwitchToResult.from_dict(obj.get("ModelSwitchToResult")) mode_set_request = ModeSetRequest.from_dict(obj.get("ModeSetRequest")) + named_provider_config = NamedProviderConfig.from_dict(obj.get("NamedProviderConfig")) name_get_result = NameGetResult.from_dict(obj.get("NameGetResult")) name_set_auto_request = NameSetAutoRequest.from_dict(obj.get("NameSetAutoRequest")) name_set_auto_result = NameSetAutoResult.from_dict(obj.get("NameSetAutoResult")) name_set_request = NameSetRequest.from_dict(obj.get("NameSetRequest")) open_canvas_instance = OpenCanvasInstance.from_dict(obj.get("OpenCanvasInstance")) + options_update_additional_content_exclusion_policy = OptionsUpdateAdditionalContentExclusionPolicy.from_dict(obj.get("OptionsUpdateAdditionalContentExclusionPolicy")) + options_update_additional_content_exclusion_policy_rule = OptionsUpdateAdditionalContentExclusionPolicyRule.from_dict(obj.get("OptionsUpdateAdditionalContentExclusionPolicyRule")) + options_update_additional_content_exclusion_policy_rule_source = OptionsUpdateAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("OptionsUpdateAdditionalContentExclusionPolicyRuleSource")) + options_update_additional_content_exclusion_policy_scope = AdditionalContentExclusionPolicyScope(obj.get("OptionsUpdateAdditionalContentExclusionPolicyScope")) + options_update_context_tier = OptionsUpdateContextTier(obj.get("OptionsUpdateContextTier")) options_update_env_value_mode = MCPSetEnvValueModeDetails(obj.get("OptionsUpdateEnvValueMode")) + options_update_reasoning_summary = ReasoningSummary(obj.get("OptionsUpdateReasoningSummary")) options_update_tool_filter_precedence = OptionsUpdateToolFilterPrecedence(obj.get("OptionsUpdateToolFilterPrecedence")) pending_permission_request = PendingPermissionRequest.from_dict(obj.get("PendingPermissionRequest")) pending_permission_request_list = PendingPermissionRequestList.from_dict(obj.get("PendingPermissionRequestList")) @@ -16468,6 +30275,7 @@ def from_dict(obj: Any) -> 'RPC': permission_decision_approve_for_location_approval_custom_tool = PermissionDecisionApproveForLocationApprovalCustomTool.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalCustomTool")) permission_decision_approve_for_location_approval_extension_management = PermissionDecisionApproveForLocationApprovalExtensionManagement.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalExtensionManagement")) permission_decision_approve_for_location_approval_extension_permission_access = PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess")) + permission_decision_approve_for_location_approval_factory = PermissionDecisionApproveForLocationApprovalFactory.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalFactory")) permission_decision_approve_for_location_approval_mcp = PermissionDecisionApproveForLocationApprovalMCP.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalMcp")) permission_decision_approve_for_location_approval_mcp_sampling = PermissionDecisionApproveForLocationApprovalMCPSampling.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalMcpSampling")) permission_decision_approve_for_location_approval_memory = PermissionDecisionApproveForLocationApprovalMemory.from_dict(obj.get("PermissionDecisionApproveForLocationApprovalMemory")) @@ -16479,6 +30287,7 @@ def from_dict(obj: Any) -> 'RPC': permission_decision_approve_for_session_approval_custom_tool = PermissionDecisionApproveForSessionApprovalCustomTool.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalCustomTool")) permission_decision_approve_for_session_approval_extension_management = PermissionDecisionApproveForSessionApprovalExtensionManagement.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalExtensionManagement")) permission_decision_approve_for_session_approval_extension_permission_access = PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess")) + permission_decision_approve_for_session_approval_factory = PermissionDecisionApproveForSessionApprovalFactory.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalFactory")) permission_decision_approve_for_session_approval_mcp = PermissionDecisionApproveForSessionApprovalMCP.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalMcp")) permission_decision_approve_for_session_approval_mcp_sampling = PermissionDecisionApproveForSessionApprovalMCPSampling.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalMcpSampling")) permission_decision_approve_for_session_approval_memory = PermissionDecisionApproveForSessionApprovalMemory.from_dict(obj.get("PermissionDecisionApproveForSessionApprovalMemory")) @@ -16487,13 +30296,17 @@ def from_dict(obj: Any) -> 'RPC': permission_decision_approve_once = PermissionDecisionApproveOnce.from_dict(obj.get("PermissionDecisionApproveOnce")) permission_decision_approve_permanently = PermissionDecisionApprovePermanently.from_dict(obj.get("PermissionDecisionApprovePermanently")) permission_decision_cancelled = PermissionDecisionCancelled.from_dict(obj.get("PermissionDecisionCancelled")) + permission_decision_context = PermissionDecisionContext.from_dict(obj.get("PermissionDecisionContext")) permission_decision_denied_by_content_exclusion_policy = PermissionDecisionDeniedByContentExclusionPolicy.from_dict(obj.get("PermissionDecisionDeniedByContentExclusionPolicy")) permission_decision_denied_by_permission_request_hook = PermissionDecisionDeniedByPermissionRequestHook.from_dict(obj.get("PermissionDecisionDeniedByPermissionRequestHook")) permission_decision_denied_by_rules = PermissionDecisionDeniedByRules.from_dict(obj.get("PermissionDecisionDeniedByRules")) permission_decision_denied_interactively_by_user = PermissionDecisionDeniedInteractivelyByUser.from_dict(obj.get("PermissionDecisionDeniedInteractivelyByUser")) permission_decision_denied_no_approval_rule_and_could_not_request_from_user = PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser.from_dict(obj.get("PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser")) + permission_decision_outcome = PermissionDecisionOutcome(obj.get("PermissionDecisionOutcome")) permission_decision_reject = PermissionDecisionReject.from_dict(obj.get("PermissionDecisionReject")) permission_decision_request = PermissionDecisionRequest.from_dict(obj.get("PermissionDecisionRequest")) + permission_decision_source = PermissionDecisionSource(obj.get("PermissionDecisionSource")) + permission_decision_surface = PermissionDecisionSurface(obj.get("PermissionDecisionSurface")) permission_decision_user_not_available = PermissionDecisionUserNotAvailable.from_dict(obj.get("PermissionDecisionUserNotAvailable")) permission_location_add_tool_approval_params = PermissionLocationAddToolApprovalParams.from_dict(obj.get("PermissionLocationAddToolApprovalParams")) permission_location_apply_params = PermissionLocationApplyParams.from_dict(obj.get("PermissionLocationApplyParams")) @@ -16512,10 +30325,11 @@ def from_dict(obj: Any) -> 'RPC': permission_prompt_shown_notification = PermissionPromptShownNotification.from_dict(obj.get("PermissionPromptShownNotification")) permission_request_result = PermissionRequestResult.from_dict(obj.get("PermissionRequestResult")) permission_rules_set = PermissionRulesSet.from_dict(obj.get("PermissionRulesSet")) + permissions_allow_all_mode = PermissionsAllowAllMode(obj.get("PermissionsAllowAllMode")) permissions_configure_additional_content_exclusion_policy = PermissionsConfigureAdditionalContentExclusionPolicy.from_dict(obj.get("PermissionsConfigureAdditionalContentExclusionPolicy")) permissions_configure_additional_content_exclusion_policy_rule = PermissionsConfigureAdditionalContentExclusionPolicyRule.from_dict(obj.get("PermissionsConfigureAdditionalContentExclusionPolicyRule")) permissions_configure_additional_content_exclusion_policy_rule_source = PermissionsConfigureAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("PermissionsConfigureAdditionalContentExclusionPolicyRuleSource")) - permissions_configure_additional_content_exclusion_policy_scope = PermissionsConfigureAdditionalContentExclusionPolicyScope(obj.get("PermissionsConfigureAdditionalContentExclusionPolicyScope")) + permissions_configure_additional_content_exclusion_policy_scope = AdditionalContentExclusionPolicyScope(obj.get("PermissionsConfigureAdditionalContentExclusionPolicyScope")) permissions_configure_params = PermissionsConfigureParams.from_dict(obj.get("PermissionsConfigureParams")) permissions_configure_result = PermissionsConfigureResult.from_dict(obj.get("PermissionsConfigureResult")) permissions_folder_trust_add_trusted_result = PermissionsFolderTrustAddTrustedResult.from_dict(obj.get("PermissionsFolderTrustAddTrustedResult")) @@ -16525,6 +30339,7 @@ def from_dict(obj: Any) -> 'RPC': permissions_locations_add_tool_approval_details_custom_tool = PermissionsLocationsAddToolApprovalDetailsCustomTool.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsCustomTool")) permissions_locations_add_tool_approval_details_extension_management = PermissionsLocationsAddToolApprovalDetailsExtensionManagement.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsExtensionManagement")) permissions_locations_add_tool_approval_details_extension_permission_access = PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess")) + permissions_locations_add_tool_approval_details_factory = PermissionsLocationsAddToolApprovalDetailsFactory.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsFactory")) permissions_locations_add_tool_approval_details_mcp = PermissionsLocationsAddToolApprovalDetailsMCP.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsMcp")) permissions_locations_add_tool_approval_details_mcp_sampling = PermissionsLocationsAddToolApprovalDetailsMCPSampling.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsMcpSampling")) permissions_locations_add_tool_approval_details_memory = PermissionsLocationsAddToolApprovalDetailsMemory.from_dict(obj.get("PermissionsLocationsAddToolApprovalDetailsMemory")) @@ -16554,50 +30369,166 @@ def from_dict(obj: Any) -> 'RPC': ping_request = PingRequest.from_dict(obj.get("PingRequest")) ping_result = PingResult.from_dict(obj.get("PingResult")) plan_read_result = PlanReadResult.from_dict(obj.get("PlanReadResult")) + plan_read_sql_todos_result = PlanReadSQLTodosResult.from_dict(obj.get("PlanReadSqlTodosResult")) + plan_read_sql_todos_with_dependencies_result = PlanReadSQLTodosWithDependenciesResult.from_dict(obj.get("PlanReadSqlTodosWithDependenciesResult")) + plan_sql_todo_dependency = PlanSQLTodoDependency.from_dict(obj.get("PlanSqlTodoDependency")) + plan_sql_todos_row = PlanSQLTodosRow.from_dict(obj.get("PlanSqlTodosRow")) plan_update_request = PlanUpdateRequest.from_dict(obj.get("PlanUpdateRequest")) plugin = Plugin.from_dict(obj.get("Plugin")) + plugin_install_result = PluginInstallResult.from_dict(obj.get("PluginInstallResult")) plugin_list = PluginList.from_dict(obj.get("PluginList")) + plugin_list_result = PluginListResult.from_dict(obj.get("PluginListResult")) + plugins_disable_request = PluginsDisableRequest.from_dict(obj.get("PluginsDisableRequest")) + plugins_enable_request = PluginsEnableRequest.from_dict(obj.get("PluginsEnableRequest")) + plugins_install_request = PluginsInstallRequest.from_dict(obj.get("PluginsInstallRequest")) + plugins_marketplaces_add_request = PluginsMarketplacesAddRequest.from_dict(obj.get("PluginsMarketplacesAddRequest")) + plugins_marketplaces_browse_request = PluginsMarketplacesBrowseRequest.from_dict(obj.get("PluginsMarketplacesBrowseRequest")) + plugins_marketplaces_refresh_request = PluginsMarketplacesRefreshRequest.from_dict(obj.get("PluginsMarketplacesRefreshRequest")) + plugins_marketplaces_remove_request = PluginsMarketplacesRemoveRequest.from_dict(obj.get("PluginsMarketplacesRemoveRequest")) + plugins_reload_request = obj.get("PluginsReloadRequest") + plugins_uninstall_request = PluginsUninstallRequest.from_dict(obj.get("PluginsUninstallRequest")) + plugins_update_request = PluginsUpdateRequest.from_dict(obj.get("PluginsUpdateRequest")) + plugin_update_all_entry = PluginUpdateAllEntry.from_dict(obj.get("PluginUpdateAllEntry")) + plugin_update_all_result = PluginUpdateAllResult.from_dict(obj.get("PluginUpdateAllResult")) + plugin_update_result = PluginUpdateResult.from_dict(obj.get("PluginUpdateResult")) + provider_add_request = ProviderAddRequest.from_dict(obj.get("ProviderAddRequest")) + provider_add_result = ProviderAddResult.from_dict(obj.get("ProviderAddResult")) + provider_config = ProviderConfig.from_dict(obj.get("ProviderConfig")) + provider_config_azure = ProviderConfigAzure.from_dict(obj.get("ProviderConfigAzure")) + provider_config_transport = ProviderTransport(obj.get("ProviderConfigTransport")) + provider_config_type = ProviderType(obj.get("ProviderConfigType")) + provider_config_wire_api = ProviderWireAPI(obj.get("ProviderConfigWireApi")) + provider_endpoint = ProviderEndpoint.from_dict(obj.get("ProviderEndpoint")) + provider_endpoint_transport = ProviderTransport(obj.get("ProviderEndpointTransport")) + provider_endpoint_type = ProviderType(obj.get("ProviderEndpointType")) + provider_endpoint_wire_api = ProviderWireAPI(obj.get("ProviderEndpointWireApi")) + provider_get_endpoint_request = obj.get("ProviderGetEndpointRequest") + provider_model_config = ProviderModelConfig.from_dict(obj.get("ProviderModelConfig")) + provider_session_token = ProviderSessionToken.from_dict(obj.get("ProviderSessionToken")) + provider_token_acquire_request = ProviderTokenAcquireRequest.from_dict(obj.get("ProviderTokenAcquireRequest")) + provider_token_acquire_result = ProviderTokenAcquireResult.from_dict(obj.get("ProviderTokenAcquireResult")) + push_attachment = _load_PushAttachment(obj.get("PushAttachment")) + push_attachment_blob = PushAttachmentBlob.from_dict(obj.get("PushAttachmentBlob")) + push_attachment_directory = PushAttachmentDirectory.from_dict(obj.get("PushAttachmentDirectory")) + push_attachment_file = PushAttachmentFile.from_dict(obj.get("PushAttachmentFile")) + push_attachment_file_line_range = PushAttachmentFileLineRange.from_dict(obj.get("PushAttachmentFileLineRange")) + push_attachment_git_hub_actions_job = PushAttachmentGitHubActionsJob.from_dict(obj.get("PushAttachmentGitHubActionsJob")) + push_attachment_git_hub_commit = PushAttachmentGitHubCommit.from_dict(obj.get("PushAttachmentGitHubCommit")) + push_attachment_git_hub_file = PushAttachmentGitHubFile.from_dict(obj.get("PushAttachmentGitHubFile")) + push_attachment_git_hub_file_diff = PushAttachmentGitHubFileDiff.from_dict(obj.get("PushAttachmentGitHubFileDiff")) + push_attachment_git_hub_file_diff_side = PushAttachmentGitHubFileDiffSide.from_dict(obj.get("PushAttachmentGitHubFileDiffSide")) + push_attachment_git_hub_reference = PushAttachmentGitHubReference.from_dict(obj.get("PushAttachmentGitHubReference")) + push_attachment_git_hub_reference_type = PushAttachmentGitHubReferenceTypeEnum(obj.get("PushAttachmentGitHubReferenceType")) + push_attachment_git_hub_release = PushAttachmentGitHubRelease.from_dict(obj.get("PushAttachmentGitHubRelease")) + push_attachment_git_hub_repository = PushAttachmentGitHubRepository.from_dict(obj.get("PushAttachmentGitHubRepository")) + push_attachment_git_hub_snippet = PushAttachmentGitHubSnippet.from_dict(obj.get("PushAttachmentGitHubSnippet")) + push_attachment_git_hub_tree_comparison = PushAttachmentGitHubTreeComparison.from_dict(obj.get("PushAttachmentGitHubTreeComparison")) + push_attachment_git_hub_tree_comparison_side = PushAttachmentGitHubTreeComparisonSide.from_dict(obj.get("PushAttachmentGitHubTreeComparisonSide")) + push_attachment_git_hub_url = PushAttachmentGitHubURL.from_dict(obj.get("PushAttachmentGitHubUrl")) + push_attachment_selection = PushAttachmentSelection.from_dict(obj.get("PushAttachmentSelection")) + push_attachment_selection_details = PushAttachmentSelectionDetails.from_dict(obj.get("PushAttachmentSelectionDetails")) + push_attachment_selection_details_end = PushAttachmentSelectionDetailsEnd.from_dict(obj.get("PushAttachmentSelectionDetailsEnd")) + push_attachment_selection_details_start = PushAttachmentSelectionDetailsStart.from_dict(obj.get("PushAttachmentSelectionDetailsStart")) + push_git_hub_repo_ref = PushGitHubRepoRef.from_dict(obj.get("PushGitHubRepoRef")) + queue_begin_deferred_idle_drain_request = QueueBeginDeferredIdleDrainRequest.from_dict(obj.get("QueueBeginDeferredIdleDrainRequest")) + queue_begin_deferred_idle_drain_result = QueueBeginDeferredIdleDrainResult.from_dict(obj.get("QueueBeginDeferredIdleDrainResult")) + queue_consume_system_notifications_request = QueueConsumeSystemNotificationsRequest.from_dict(obj.get("QueueConsumeSystemNotificationsRequest")) queued_command_handled = QueuedCommandHandled.from_dict(obj.get("QueuedCommandHandled")) queued_command_not_handled = QueuedCommandNotHandled.from_dict(obj.get("QueuedCommandNotHandled")) queued_command_result = _load_QueuedCommandResult(obj.get("QueuedCommandResult")) + queue_defer_session_idle_request = QueueDeferSessionIdleRequest.from_dict(obj.get("QueueDeferSessionIdleRequest")) + queue_duplicate_at_request = QueueDuplicateAtRequest.from_dict(obj.get("QueueDuplicateAtRequest")) + queue_duplicate_at_result = QueueDuplicateAtResult.from_dict(obj.get("QueueDuplicateAtResult")) + queue_enqueue_resume_pending_result = QueueEnqueueResumePendingResult.from_dict(obj.get("QueueEnqueueResumePendingResult")) + queue_finish_deferred_idle_drain_request = QueueFinishDeferredIdleDrainRequest.from_dict(obj.get("QueueFinishDeferredIdleDrainRequest")) + queue_finish_deferred_idle_drain_result = QueueFinishDeferredIdleDrainResult.from_dict(obj.get("QueueFinishDeferredIdleDrainResult")) + queue_has_pending_result = QueueHasPendingResult.from_dict(obj.get("QueueHasPendingResult")) + queue_insert_at_request = QueueInsertAtRequest.from_dict(obj.get("QueueInsertAtRequest")) + queue_insert_at_result = QueueInsertAtResult.from_dict(obj.get("QueueInsertAtResult")) + queue_insert_message = QueueInsertMessage.from_dict(obj.get("QueueInsertMessage")) + queue_move_item_request = QueueMoveItemRequest.from_dict(obj.get("QueueMoveItemRequest")) + queue_move_item_result = QueueMoveItemResult.from_dict(obj.get("QueueMoveItemResult")) queue_pending_items = QueuePendingItems.from_dict(obj.get("QueuePendingItems")) queue_pending_items_kind = QueuePendingItemsKind(obj.get("QueuePendingItemsKind")) queue_pending_items_result = QueuePendingItemsResult.from_dict(obj.get("QueuePendingItemsResult")) + queue_remove_at_request = QueueRemoveAtRequest.from_dict(obj.get("QueueRemoveAtRequest")) + queue_remove_at_result = QueueRemoveAtResult.from_dict(obj.get("QueueRemoveAtResult")) queue_remove_most_recent_result = QueueRemoveMostRecentResult.from_dict(obj.get("QueueRemoveMostRecentResult")) + queue_send_now_request = QueueSendNowRequest.from_dict(obj.get("QueueSendNowRequest")) + queue_send_now_result = QueueSendNowResult.from_dict(obj.get("QueueSendNowResult")) + queue_set_drain_paused_request = QueueSetDrainPausedRequest.from_dict(obj.get("QueueSetDrainPausedRequest")) + queue_snapshot_result = QueueSnapshotResult.from_dict(obj.get("QueueSnapshotResult")) + queue_update_text_request = QueueUpdateTextRequest.from_dict(obj.get("QueueUpdateTextRequest")) + queue_update_text_result = QueueUpdateTextResult.from_dict(obj.get("QueueUpdateTextResult")) register_event_interest_params = RegisterEventInterestParams.from_dict(obj.get("RegisterEventInterestParams")) register_event_interest_result = RegisterEventInterestResult.from_dict(obj.get("RegisterEventInterestResult")) + register_extension_tools_params = _RegisterExtensionToolsParams.from_dict(obj.get("RegisterExtensionToolsParams")) + register_extension_tools_result = _RegisterExtensionToolsResult.from_dict(obj.get("RegisterExtensionToolsResult")) release_event_interest_params = ReleaseEventInterestParams.from_dict(obj.get("ReleaseEventInterestParams")) + remote_control_config = RemoteControlConfig.from_dict(obj.get("RemoteControlConfig")) + remote_control_config_existing_mc_session = RemoteControlConfigExistingMcSession.from_dict(obj.get("RemoteControlConfigExistingMcSession")) + remote_control_status = _load_RemoteControlStatus(obj.get("RemoteControlStatus")) + remote_control_status_active = RemoteControlStatusActive.from_dict(obj.get("RemoteControlStatusActive")) + remote_control_status_connecting = RemoteControlStatusConnecting.from_dict(obj.get("RemoteControlStatusConnecting")) + remote_control_status_error = RemoteControlStatusError.from_dict(obj.get("RemoteControlStatusError")) + remote_control_status_off = RemoteControlStatusOff.from_dict(obj.get("RemoteControlStatusOff")) + remote_control_status_result = RemoteControlStatusResult.from_dict(obj.get("RemoteControlStatusResult")) + remote_control_stop_result = RemoteControlStopResult.from_dict(obj.get("RemoteControlStopResult")) + remote_control_transfer_result = RemoteControlTransferResult.from_dict(obj.get("RemoteControlTransferResult")) remote_enable_request = RemoteEnableRequest.from_dict(obj.get("RemoteEnableRequest")) remote_enable_result = RemoteEnableResult.from_dict(obj.get("RemoteEnableResult")) remote_notify_steerable_changed_request = RemoteNotifySteerableChangedRequest.from_dict(obj.get("RemoteNotifySteerableChangedRequest")) remote_notify_steerable_changed_result = RemoteNotifySteerableChangedResult.from_dict(obj.get("RemoteNotifySteerableChangedResult")) remote_session_connection_result = RemoteSessionConnectionResult.from_dict(obj.get("RemoteSessionConnectionResult")) + remote_session_metadata_repository = RemoteSessionMetadataRepository.from_dict(obj.get("RemoteSessionMetadataRepository")) + remote_session_metadata_task_type = TaskType(obj.get("RemoteSessionMetadataTaskType")) + remote_session_metadata_value = RemoteSessionMetadataValue.from_dict(obj.get("RemoteSessionMetadataValue")) remote_session_mode = RemoteSessionMode(obj.get("RemoteSessionMode")) + remote_session_repository = RemoteSessionRepository.from_dict(obj.get("RemoteSessionRepository")) + run_options = RunOptions.from_dict(obj.get("RunOptions")) + sandbox_config = SandboxConfig.from_dict(obj.get("SandboxConfig")) + sandbox_config_auth = SandboxConfigAuth.from_dict(obj.get("SandboxConfigAuth")) + sandbox_config_user_policy = SandboxConfigUserPolicy.from_dict(obj.get("SandboxConfigUserPolicy")) + sandbox_config_user_policy_experimental = SandboxConfigUserPolicyExperimental.from_dict(obj.get("SandboxConfigUserPolicyExperimental")) + sandbox_config_user_policy_experimental_seatbelt = SandboxConfigUserPolicyExperimentalSeatbelt.from_dict(obj.get("SandboxConfigUserPolicyExperimentalSeatbelt")) + sandbox_config_user_policy_filesystem = SandboxConfigUserPolicyFilesystem.from_dict(obj.get("SandboxConfigUserPolicyFilesystem")) + sandbox_config_user_policy_network = SandboxConfigUserPolicyNetwork.from_dict(obj.get("SandboxConfigUserPolicyNetwork")) + sandbox_config_user_policy_network_proxy = SandboxConfigUserPolicyNetworkProxy.from_dict(obj.get("SandboxConfigUserPolicyNetworkProxy")) + sandbox_config_user_policy_seatbelt = SandboxConfigUserPolicySeatbelt.from_dict(obj.get("SandboxConfigUserPolicySeatbelt")) + schedule_add_at_request = ScheduleAddAtRequest.from_dict(obj.get("ScheduleAddAtRequest")) + schedule_add_cron_request = ScheduleAddCronRequest.from_dict(obj.get("ScheduleAddCronRequest")) + schedule_add_request = ScheduleAddRequest.from_dict(obj.get("ScheduleAddRequest")) + schedule_add_result = ScheduleAddResult.from_dict(obj.get("ScheduleAddResult")) + schedule_add_self_paced_request = ScheduleAddSelfPacedRequest.from_dict(obj.get("ScheduleAddSelfPacedRequest")) schedule_entry = ScheduleEntry.from_dict(obj.get("ScheduleEntry")) + schedule_has_self_paced_result = ScheduleHasSelfPacedResult.from_dict(obj.get("ScheduleHasSelfPacedResult")) schedule_list = ScheduleList.from_dict(obj.get("ScheduleList")) + schedule_rearm_self_paced_request = ScheduleRearmSelfPacedRequest.from_dict(obj.get("ScheduleRearmSelfPacedRequest")) schedule_stop_request = ScheduleStopRequest.from_dict(obj.get("ScheduleStopRequest")) schedule_stop_result = ScheduleStopResult.from_dict(obj.get("ScheduleStopResult")) secrets_add_filter_values_request = SecretsAddFilterValuesRequest.from_dict(obj.get("SecretsAddFilterValuesRequest")) secrets_add_filter_values_result = SecretsAddFilterValuesResult.from_dict(obj.get("SecretsAddFilterValuesResult")) send_agent_mode = SendAgentMode(obj.get("SendAgentMode")) - send_attachment = _load_SendAttachment(obj.get("SendAttachment")) - send_attachment_blob = SendAttachmentBlob.from_dict(obj.get("SendAttachmentBlob")) - send_attachment_directory = SendAttachmentDirectory.from_dict(obj.get("SendAttachmentDirectory")) - send_attachment_file = SendAttachmentFile.from_dict(obj.get("SendAttachmentFile")) - send_attachment_file_line_range = SendAttachmentFileLineRange.from_dict(obj.get("SendAttachmentFileLineRange")) - send_attachment_github_reference = SendAttachmentGithubReference.from_dict(obj.get("SendAttachmentGithubReference")) - send_attachment_github_reference_type = SendAttachmentGithubReferenceTypeEnum(obj.get("SendAttachmentGithubReferenceType")) - send_attachment_selection = SendAttachmentSelection.from_dict(obj.get("SendAttachmentSelection")) - send_attachment_selection_details = SendAttachmentSelectionDetails.from_dict(obj.get("SendAttachmentSelectionDetails")) - send_attachment_selection_details_end = SendAttachmentSelectionDetailsEnd.from_dict(obj.get("SendAttachmentSelectionDetailsEnd")) - send_attachment_selection_details_start = SendAttachmentSelectionDetailsStart.from_dict(obj.get("SendAttachmentSelectionDetailsStart")) + send_attachments_to_message_params = SendAttachmentsToMessageParams.from_dict(obj.get("SendAttachmentsToMessageParams")) + send_message_item = SendMessageItem.from_dict(obj.get("SendMessageItem")) + send_messages_request = SendMessagesRequest.from_dict(obj.get("SendMessagesRequest")) + send_messages_result = SendMessagesResult.from_dict(obj.get("SendMessagesResult")) send_mode = SendMode(obj.get("SendMode")) send_request = SendRequest.from_dict(obj.get("SendRequest")) send_result = SendResult.from_dict(obj.get("SendResult")) + send_system_notification_request = SendSystemNotificationRequest.from_dict(obj.get("SendSystemNotificationRequest")) + server_agent_list = ServerAgentList.from_dict(obj.get("ServerAgentList")) + server_instruction_source_list = ServerInstructionSourceList.from_dict(obj.get("ServerInstructionSourceList")) server_skill = ServerSkill.from_dict(obj.get("ServerSkill")) server_skill_list = ServerSkillList.from_dict(obj.get("ServerSkillList")) + session_activity = SessionActivity.from_dict(obj.get("SessionActivity")) + session_agent_list_request = SessionAgentListRequest.from_dict(obj.get("SessionAgentListRequest")) session_auth_status = SessionAuthStatus.from_dict(obj.get("SessionAuthStatus")) session_bulk_delete_result = SessionBulkDeleteResult.from_dict(obj.get("SessionBulkDeleteResult")) + session_cancel_all_background_agents_result = from_int(obj.get("SessionCancelAllBackgroundAgentsResult")) + session_capability = SessionCapability(obj.get("SessionCapability")) + session_commands_list_request = SessionCommandsListRequest.from_dict(obj.get("SessionCommandsListRequest")) + session_completion_item = SessionCompletionItem.from_dict(obj.get("SessionCompletionItem")) session_context = SessionContext.from_dict(obj.get("SessionContext")) session_context_host_type = HostType(obj.get("SessionContextHostType")) session_enrich_metadata_result = SessionEnrichMetadataResult.from_dict(obj.get("SessionEnrichMetadataResult")) @@ -16610,7 +30541,7 @@ def from_dict(obj: Any) -> 'RPC': session_fs_readdir_request = SessionFSReaddirRequest.from_dict(obj.get("SessionFsReaddirRequest")) session_fs_readdir_result = SessionFSReaddirResult.from_dict(obj.get("SessionFsReaddirResult")) session_fs_readdir_with_types_entry = SessionFSReaddirWithTypesEntry.from_dict(obj.get("SessionFsReaddirWithTypesEntry")) - session_fs_readdir_with_types_entry_type = SessionFSReaddirWithTypesEntryType(obj.get("SessionFsReaddirWithTypesEntryType")) + session_fs_readdir_with_types_entry_type = DebugCollectLogsEntryKind(obj.get("SessionFsReaddirWithTypesEntryType")) session_fs_readdir_with_types_request = SessionFSReaddirWithTypesRequest.from_dict(obj.get("SessionFsReaddirWithTypesRequest")) session_fs_readdir_with_types_result = SessionFSReaddirWithTypesResult.from_dict(obj.get("SessionFsReaddirWithTypesResult")) session_fs_read_file_request = SessionFSReadFileRequest.from_dict(obj.get("SessionFsReadFileRequest")) @@ -16626,48 +30557,110 @@ def from_dict(obj: Any) -> 'RPC': session_fs_sqlite_query_request = SessionFSSqliteQueryRequest.from_dict(obj.get("SessionFsSqliteQueryRequest")) session_fs_sqlite_query_result = SessionFSSqliteQueryResult.from_dict(obj.get("SessionFsSqliteQueryResult")) session_fs_sqlite_query_type = SessionFSSqliteQueryType(obj.get("SessionFsSqliteQueryType")) + session_fs_sqlite_transaction_error = SessionFSSqliteTransactionError.from_dict(obj.get("SessionFsSqliteTransactionError")) + session_fs_sqlite_transaction_error_class = SessionFSSqliteTransactionErrorClass(obj.get("SessionFsSqliteTransactionErrorClass")) + session_fs_sqlite_transaction_request = SessionFSSqliteTransactionRequest.from_dict(obj.get("SessionFsSqliteTransactionRequest")) + session_fs_sqlite_transaction_result = SessionFSSqliteTransactionResult.from_dict(obj.get("SessionFsSqliteTransactionResult")) + session_fs_sqlite_transaction_statement = SessionFSSqliteTransactionStatement.from_dict(obj.get("SessionFsSqliteTransactionStatement")) session_fs_stat_request = SessionFSStatRequest.from_dict(obj.get("SessionFsStatRequest")) session_fs_stat_result = SessionFSStatResult.from_dict(obj.get("SessionFsStatResult")) session_fs_write_file_request = SessionFSWriteFileRequest.from_dict(obj.get("SessionFsWriteFileRequest")) + session_history_compact_request = SessionHistoryCompactRequest.from_dict(obj.get("SessionHistoryCompactRequest")) session_installed_plugin = SessionInstalledPlugin.from_dict(obj.get("SessionInstalledPlugin")) session_installed_plugin_source = from_union([SessionInstalledPluginSource.from_dict, from_str], obj.get("SessionInstalledPluginSource")) - session_installed_plugin_source_github = SessionInstalledPluginSourceGithub.from_dict(obj.get("SessionInstalledPluginSourceGithub")) + session_installed_plugin_source_git_hub = SessionInstalledPluginSourceGitHub.from_dict(obj.get("SessionInstalledPluginSourceGitHub")) session_installed_plugin_source_local = SessionInstalledPluginSourceLocal.from_dict(obj.get("SessionInstalledPluginSourceLocal")) session_installed_plugin_source_url = SessionInstalledPluginSourceURL.from_dict(obj.get("SessionInstalledPluginSourceUrl")) + session_limit_prediction_baseline_data = SessionLimitPredictionBaselineData.from_dict(obj.get("SessionLimitPredictionBaselineData")) + session_limit_prediction_client_type = SessionLimitPredictionClientType(obj.get("SessionLimitPredictionClientType")) + session_limit_prediction_details = SessionLimitPredictionDetails.from_dict(obj.get("SessionLimitPredictionDetails")) + session_limit_prediction_predict_request = SessionLimitPredictionPredictRequest.from_dict(obj.get("SessionLimitPredictionPredictRequest")) + session_limit_prediction_request = obj.get("SessionLimitPredictionRequest") + session_limit_prediction_result = SessionLimitPredictionResult.from_dict(obj.get("SessionLimitPredictionResult")) + session_limit_prediction_source = SessionLimitPredictionSource(obj.get("SessionLimitPredictionSource")) + session_limit_prediction_tier = SessionLimitPredictionTier(obj.get("SessionLimitPredictionTier")) + session_limit_prediction_tier_option = SessionLimitPredictionTierOption.from_dict(obj.get("SessionLimitPredictionTierOption")) + session_limit_prediction_unavailable_reason = SessionLimitPredictionUnavailableReason(obj.get("SessionLimitPredictionUnavailableReason")) session_list = SessionList.from_dict(obj.get("SessionList")) + session_list_entry = _load_SessionListEntry(obj.get("SessionListEntry")) session_list_filter = SessionListFilter.from_dict(obj.get("SessionListFilter")) session_load_deferred_repo_hooks_result = SessionLoadDeferredRepoHooksResult.from_dict(obj.get("SessionLoadDeferredRepoHooksResult")) session_log_level = SessionLogLevel(obj.get("SessionLogLevel")) + session_managed_permissions = SessionManagedPermissions.from_dict(obj.get("SessionManagedPermissions")) + session_managed_settings = SessionManagedSettings.from_dict(obj.get("SessionManagedSettings")) session_mcp_apps_call_tool_result = from_dict(lambda x: x, obj.get("SessionMcpAppsCallToolResult")) - session_metadata = SessionMetadata.from_dict(obj.get("SessionMetadata")) session_metadata_snapshot = SessionMetadataSnapshot.from_dict(obj.get("SessionMetadataSnapshot")) session_mode = SessionMode(obj.get("SessionMode")) session_model_list = SessionModelList.from_dict(obj.get("SessionModelList")) + session_model_list_request = SessionModelListRequest.from_dict(obj.get("SessionModelListRequest")) + session_model_price_category = SessionModelPriceCategory.from_dict(obj.get("SessionModelPriceCategory")) + session_open_options = SessionOpenOptions.from_dict(obj.get("SessionOpenOptions")) + session_open_options_additional_content_exclusion_policy = SessionOpenOptionsAdditionalContentExclusionPolicy.from_dict(obj.get("SessionOpenOptionsAdditionalContentExclusionPolicy")) + session_open_options_additional_content_exclusion_policy_rule = SessionOpenOptionsAdditionalContentExclusionPolicyRule.from_dict(obj.get("SessionOpenOptionsAdditionalContentExclusionPolicyRule")) + session_open_options_additional_content_exclusion_policy_rule_source = SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource.from_dict(obj.get("SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource")) + session_open_options_additional_content_exclusion_policy_scope = AdditionalContentExclusionPolicyScope(obj.get("SessionOpenOptionsAdditionalContentExclusionPolicyScope")) + session_open_options_env_value_mode = MCPSetEnvValueModeDetails(obj.get("SessionOpenOptionsEnvValueMode")) + session_open_options_reasoning_summary = ReasoningSummary(obj.get("SessionOpenOptionsReasoningSummary")) + session_open_params = _load_SessionOpenParams(obj.get("SessionOpenParams")) + session_open_result = SessionOpenResult.from_dict(obj.get("SessionOpenResult")) + session_plugins_reload_request = SessionPluginsReloadRequest.from_dict(obj.get("SessionPluginsReloadRequest")) + session_provider_get_endpoint_request = SessionProviderGetEndpointRequest.from_dict(obj.get("SessionProviderGetEndpointRequest")) session_prune_result = SessionPruneResult.from_dict(obj.get("SessionPruneResult")) sessions_bulk_delete_request = SessionsBulkDeleteRequest.from_dict(obj.get("SessionsBulkDeleteRequest")) sessions_check_in_use_request = SessionsCheckInUseRequest.from_dict(obj.get("SessionsCheckInUseRequest")) sessions_check_in_use_result = SessionsCheckInUseResult.from_dict(obj.get("SessionsCheckInUseResult")) sessions_close_request = SessionsCloseRequest.from_dict(obj.get("SessionsCloseRequest")) sessions_close_result = SessionsCloseResult.from_dict(obj.get("SessionsCloseResult")) + sessions_delete_request = SessionsDeleteRequest.from_dict(obj.get("SessionsDeleteRequest")) sessions_enrich_metadata_request = SessionsEnrichMetadataRequest.from_dict(obj.get("SessionsEnrichMetadataRequest")) session_set_credentials_params = SessionSetCredentialsParams.from_dict(obj.get("SessionSetCredentialsParams")) session_set_credentials_result = SessionSetCredentialsResult.from_dict(obj.get("SessionSetCredentialsResult")) + session_settings_built_in_tool_availability_snapshot = SessionSettingsBuiltInToolAvailabilitySnapshot.from_dict(obj.get("SessionSettingsBuiltInToolAvailabilitySnapshot")) + session_settings_evaluate_predicate_request = SessionSettingsEvaluatePredicateRequest.from_dict(obj.get("SessionSettingsEvaluatePredicateRequest")) + session_settings_evaluate_predicate_result = SessionSettingsEvaluatePredicateResult.from_dict(obj.get("SessionSettingsEvaluatePredicateResult")) + session_settings_job_snapshot = SessionSettingsJobSnapshot.from_dict(obj.get("SessionSettingsJobSnapshot")) + session_settings_model_snapshot = SessionSettingsModelSnapshot.from_dict(obj.get("SessionSettingsModelSnapshot")) + session_settings_online_evaluation_snapshot = SessionSettingsOnlineEvaluationSnapshot.from_dict(obj.get("SessionSettingsOnlineEvaluationSnapshot")) + session_settings_predicate_name = SessionSettingsPredicateName(obj.get("SessionSettingsPredicateName")) + session_settings_repo_snapshot = SessionSettingsRepoSnapshot.from_dict(obj.get("SessionSettingsRepoSnapshot")) + session_settings_snapshot = SessionSettingsSnapshot.from_dict(obj.get("SessionSettingsSnapshot")) + session_settings_validation_snapshot = SessionSettingsValidationSnapshot.from_dict(obj.get("SessionSettingsValidationSnapshot")) sessions_find_by_prefix_request = SessionsFindByPrefixRequest.from_dict(obj.get("SessionsFindByPrefixRequest")) sessions_find_by_prefix_result = SessionsFindByPrefixResult.from_dict(obj.get("SessionsFindByPrefixResult")) sessions_find_by_task_id_request = SessionsFindByTaskIDRequest.from_dict(obj.get("SessionsFindByTaskIDRequest")) sessions_find_by_task_id_result = SessionsFindByTaskIDResult.from_dict(obj.get("SessionsFindByTaskIDResult")) sessions_fork_request = SessionsForkRequest.from_dict(obj.get("SessionsForkRequest")) sessions_fork_result = SessionsForkResult.from_dict(obj.get("SessionsForkResult")) + sessions_get_board_entry_count_request = SessionsGetBoardEntryCountRequest.from_dict(obj.get("SessionsGetBoardEntryCountRequest")) + sessions_get_board_entry_count_result = SessionsGetBoardEntryCountResult.from_dict(obj.get("SessionsGetBoardEntryCountResult")) sessions_get_event_file_path_request = SessionsGetEventFilePathRequest.from_dict(obj.get("SessionsGetEventFilePathRequest")) sessions_get_event_file_path_result = SessionsGetEventFilePathResult.from_dict(obj.get("SessionsGetEventFilePathResult")) sessions_get_last_for_context_request = SessionsGetLastForContextRequest.from_dict(obj.get("SessionsGetLastForContextRequest")) sessions_get_last_for_context_result = SessionsGetLastForContextResult.from_dict(obj.get("SessionsGetLastForContextResult")) + sessions_get_metadata_request = SessionsGetMetadataRequest.from_dict(obj.get("SessionsGetMetadataRequest")) + sessions_get_metadata_result = SessionsGetMetadataResult.from_dict(obj.get("SessionsGetMetadataResult")) sessions_get_persisted_remote_steerable_request = SessionsGetPersistedRemoteSteerableRequest.from_dict(obj.get("SessionsGetPersistedRemoteSteerableRequest")) sessions_get_persisted_remote_steerable_result = SessionsGetPersistedRemoteSteerableResult.from_dict(obj.get("SessionsGetPersistedRemoteSteerableResult")) session_sizes = SessionSizes.from_dict(obj.get("SessionSizes")) + sessions_list_non_empty_session_ids_request = SessionsListNonEmptySessionIDSRequest.from_dict(obj.get("SessionsListNonEmptySessionIdsRequest")) + sessions_list_non_empty_session_ids_result = SessionsListNonEmptySessionIDSResult.from_dict(obj.get("SessionsListNonEmptySessionIdsResult")) sessions_list_request = SessionsListRequest.from_dict(obj.get("SessionsListRequest")) sessions_load_deferred_repo_hooks_request = SessionsLoadDeferredRepoHooksRequest.from_dict(obj.get("SessionsLoadDeferredRepoHooksRequest")) + sessions_open_attach = SessionsOpenAttach.from_dict(obj.get("SessionsOpenAttach")) + sessions_open_cloud = SessionsOpenCloud.from_dict(obj.get("SessionsOpenCloud")) + sessions_open_create = SessionsOpenCreate.from_dict(obj.get("SessionsOpenCreate")) + sessions_open_handoff = SessionsOpenHandoff.from_dict(obj.get("SessionsOpenHandoff")) + sessions_open_handoff_task_type = TaskType(obj.get("SessionsOpenHandoffTaskType")) + sessions_open_progress = SessionsOpenProgress.from_dict(obj.get("SessionsOpenProgress")) + sessions_open_progress_status = SessionsOpenProgressStatus(obj.get("SessionsOpenProgressStatus")) + sessions_open_progress_step = SessionsOpenProgressStep(obj.get("SessionsOpenProgressStep")) + sessions_open_remote = SessionsOpenRemote.from_dict(obj.get("SessionsOpenRemote")) + sessions_open_resume = SessionsOpenResume.from_dict(obj.get("SessionsOpenResume")) + sessions_open_resume_last = SessionsOpenResumeLast.from_dict(obj.get("SessionsOpenResumeLast")) + sessions_open_status = SessionsOpenStatus(obj.get("SessionsOpenStatus")) + session_source = SessionSource(obj.get("SessionSource")) sessions_prune_old_request = SessionsPruneOldRequest.from_dict(obj.get("SessionsPruneOldRequest")) + sessions_register_extension_tools_on_session_options = SessionsRegisterExtensionToolsOnSessionOptions.from_dict(obj.get("SessionsRegisterExtensionToolsOnSessionOptions")) sessions_release_lock_request = SessionsReleaseLockRequest.from_dict(obj.get("SessionsReleaseLockRequest")) sessions_release_lock_result = SessionsReleaseLockResult.from_dict(obj.get("SessionsReleaseLockResult")) sessions_reload_plugin_hooks_request = SessionsReloadPluginHooksRequest.from_dict(obj.get("SessionsReloadPluginHooksRequest")) @@ -16676,22 +30669,38 @@ def from_dict(obj: Any) -> 'RPC': sessions_save_result = SessionsSaveResult.from_dict(obj.get("SessionsSaveResult")) sessions_set_additional_plugins_request = SessionsSetAdditionalPluginsRequest.from_dict(obj.get("SessionsSetAdditionalPluginsRequest")) sessions_set_additional_plugins_result = SessionsSetAdditionalPluginsResult.from_dict(obj.get("SessionsSetAdditionalPluginsResult")) + sessions_set_remote_control_steering_request = SessionsSetRemoteControlSteeringRequest.from_dict(obj.get("SessionsSetRemoteControlSteeringRequest")) + sessions_start_remote_control_request = SessionsStartRemoteControlRequest.from_dict(obj.get("SessionsStartRemoteControlRequest")) + sessions_stop_remote_control_request = SessionsStopRemoteControlRequest.from_dict(obj.get("SessionsStopRemoteControlRequest")) + sessions_transfer_remote_control_request = SessionsTransferRemoteControlRequest.from_dict(obj.get("SessionsTransferRemoteControlRequest")) + session_telemetry_engagement = SessionTelemetryEngagement.from_dict(obj.get("SessionTelemetryEngagement")) session_update_options_params = SessionUpdateOptionsParams.from_dict(obj.get("SessionUpdateOptionsParams")) session_update_options_result = SessionUpdateOptionsResult.from_dict(obj.get("SessionUpdateOptionsResult")) + session_visibility_status = SessionVisibilityStatus(obj.get("SessionVisibilityStatus")) session_working_directory_context = SessionWorkingDirectoryContext.from_dict(obj.get("SessionWorkingDirectoryContext")) session_working_directory_context_host_type = HostType(obj.get("SessionWorkingDirectoryContextHostType")) + shell_cancel_user_requested_request = ShellCancelUserRequestedRequest.from_dict(obj.get("ShellCancelUserRequestedRequest")) shell_exec_request = ShellExecRequest.from_dict(obj.get("ShellExecRequest")) shell_exec_result = ShellExecResult.from_dict(obj.get("ShellExecResult")) + shell_execute_user_requested_request = ShellExecuteUserRequestedRequest.from_dict(obj.get("ShellExecuteUserRequestedRequest")) + shell_init_profile = ShellInitProfile(obj.get("ShellInitProfile")) + shell_init_script = ShellInitScript.from_dict(obj.get("ShellInitScript")) + shell_init_script_shell = ShellInitScriptShell(obj.get("ShellInitScriptShell")) shell_kill_request = ShellKillRequest.from_dict(obj.get("ShellKillRequest")) shell_kill_result = ShellKillResult.from_dict(obj.get("ShellKillResult")) shell_kill_signal = ShellKillSignal(obj.get("ShellKillSignal")) + shell_options = ShellOptions.from_dict(obj.get("ShellOptions")) shutdown_request = ShutdownRequest.from_dict(obj.get("ShutdownRequest")) skill = Skill.from_dict(obj.get("Skill")) + skill_discovery_path = SkillDiscoveryPath.from_dict(obj.get("SkillDiscoveryPath")) + skill_discovery_path_list = SkillDiscoveryPathList.from_dict(obj.get("SkillDiscoveryPathList")) + skill_discovery_scope = SkillDiscoveryScope(obj.get("SkillDiscoveryScope")) skill_list = SkillList.from_dict(obj.get("SkillList")) skills_config_set_disabled_skills_request = SkillsConfigSetDisabledSkillsRequest.from_dict(obj.get("SkillsConfigSetDisabledSkillsRequest")) skills_disable_request = SkillsDisableRequest.from_dict(obj.get("SkillsDisableRequest")) skills_discover_request = SkillsDiscoverRequest.from_dict(obj.get("SkillsDiscoverRequest")) skills_enable_request = SkillsEnableRequest.from_dict(obj.get("SkillsEnableRequest")) + skills_get_discovery_paths_request = SkillsGetDiscoveryPathsRequest.from_dict(obj.get("SkillsGetDiscoveryPathsRequest")) skills_get_invoked_result = SkillsGetInvokedResult.from_dict(obj.get("SkillsGetInvokedResult")) skills_invoked_skill = SkillsInvokedSkill.from_dict(obj.get("SkillsInvokedSkill")) skills_load_diagnostics = SkillsLoadDiagnostics.from_dict(obj.get("SkillsLoadDiagnostics")) @@ -16699,12 +30708,15 @@ def from_dict(obj: Any) -> 'RPC': slash_command_completed_result = SlashCommandCompletedResult.from_dict(obj.get("SlashCommandCompletedResult")) slash_command_info = SlashCommandInfo.from_dict(obj.get("SlashCommandInfo")) slash_command_input = SlashCommandInput.from_dict(obj.get("SlashCommandInput")) + slash_command_input_choice = SlashCommandInputChoice.from_dict(obj.get("SlashCommandInputChoice")) slash_command_input_completion = SlashCommandInputCompletion(obj.get("SlashCommandInputCompletion")) slash_command_invocation_result = _load_SlashCommandInvocationResult(obj.get("SlashCommandInvocationResult")) slash_command_kind = SlashCommandKind(obj.get("SlashCommandKind")) slash_command_select_subcommand_option = SlashCommandSelectSubcommandOption.from_dict(obj.get("SlashCommandSelectSubcommandOption")) slash_command_select_subcommand_result = SlashCommandSelectSubcommandResult.from_dict(obj.get("SlashCommandSelectSubcommandResult")) slash_command_text_result = SlashCommandTextResult.from_dict(obj.get("SlashCommandTextResult")) + subagent_settings_entry = SubagentSettingsEntry.from_dict(obj.get("SubagentSettingsEntry")) + subagent_settings_entry_context_tier = SubagentSettingsEntryContextTier(obj.get("SubagentSettingsEntryContextTier")) task_agent_info = TaskAgentInfo.from_dict(obj.get("TaskAgentInfo")) task_agent_progress = TaskAgentProgress.from_dict(obj.get("TaskAgentProgress")) task_execution_mode = TaskExecutionMode(obj.get("TaskExecutionMode")) @@ -16738,6 +30750,7 @@ def from_dict(obj: Any) -> 'RPC': tools_get_current_metadata_result = ToolsGetCurrentMetadataResult.from_dict(obj.get("ToolsGetCurrentMetadataResult")) tools_initialize_and_validate_result = ToolsInitializeAndValidateResult.from_dict(obj.get("ToolsInitializeAndValidateResult")) tools_list_request = ToolsListRequest.from_dict(obj.get("ToolsListRequest")) + tools_update_subagent_settings_result = ToolsUpdateSubagentSettingsResult.from_dict(obj.get("ToolsUpdateSubagentSettingsResult")) ui_auto_mode_switch_response = UIAutoModeSwitchResponse(obj.get("UIAutoModeSwitchResponse")) ui_elicitation_array_any_of_field = UIElicitationArrayAnyOfField.from_dict(obj.get("UIElicitationArrayAnyOfField")) ui_elicitation_array_any_of_field_items = UIElicitationArrayAnyOfFieldItems.from_dict(obj.get("UIElicitationArrayAnyOfFieldItems")) @@ -16760,6 +30773,8 @@ def from_dict(obj: Any) -> 'RPC': ui_elicitation_string_enum_field = UIElicitationStringEnumField.from_dict(obj.get("UIElicitationStringEnumField")) ui_elicitation_string_one_of_field = UIElicitationStringOneOfField.from_dict(obj.get("UIElicitationStringOneOfField")) ui_elicitation_string_one_of_field_one_of = UIElicitationStringOneOfFieldOneOf.from_dict(obj.get("UIElicitationStringOneOfFieldOneOf")) + ui_ephemeral_query_request = UIEphemeralQueryRequest.from_dict(obj.get("UIEphemeralQueryRequest")) + ui_ephemeral_query_result = UIEphemeralQueryResult.from_dict(obj.get("UIEphemeralQueryResult")) ui_exit_plan_mode_action = UIExitPlanModeAction(obj.get("UIExitPlanModeAction")) ui_exit_plan_mode_response = UIExitPlanModeResponse.from_dict(obj.get("UIExitPlanModeResponse")) ui_handle_pending_auto_mode_switch_request = UIHandlePendingAutoModeSwitchRequest.from_dict(obj.get("UIHandlePendingAutoModeSwitchRequest")) @@ -16768,11 +30783,15 @@ def from_dict(obj: Any) -> 'RPC': ui_handle_pending_result = UIHandlePendingResult.from_dict(obj.get("UIHandlePendingResult")) ui_handle_pending_sampling_request = UIHandlePendingSamplingRequest.from_dict(obj.get("UIHandlePendingSamplingRequest")) ui_handle_pending_sampling_response = from_dict(lambda x: x, obj.get("UIHandlePendingSamplingResponse")) + ui_handle_pending_session_limits_exhausted_request = UIHandlePendingSessionLimitsExhaustedRequest.from_dict(obj.get("UIHandlePendingSessionLimitsExhaustedRequest")) ui_handle_pending_user_input_request = UIHandlePendingUserInputRequest.from_dict(obj.get("UIHandlePendingUserInputRequest")) ui_register_direct_auto_mode_switch_handler_result = UIRegisterDirectAutoModeSwitchHandlerResult.from_dict(obj.get("UIRegisterDirectAutoModeSwitchHandlerResult")) + ui_session_limits_exhausted_response = UISessionLimitsExhaustedResponse.from_dict(obj.get("UISessionLimitsExhaustedResponse")) + ui_session_limits_exhausted_response_action = UISessionLimitsExhaustedResponseAction(obj.get("UISessionLimitsExhaustedResponseAction")) ui_unregister_direct_auto_mode_switch_handler_request = UIUnregisterDirectAutoModeSwitchHandlerRequest.from_dict(obj.get("UIUnregisterDirectAutoModeSwitchHandlerRequest")) ui_unregister_direct_auto_mode_switch_handler_result = UIUnregisterDirectAutoModeSwitchHandlerResult.from_dict(obj.get("UIUnregisterDirectAutoModeSwitchHandlerResult")) ui_user_input_response = UIUserInputResponse.from_dict(obj.get("UIUserInputResponse")) + update_subagent_settings_request = UpdateSubagentSettingsRequest.from_dict(obj.get("UpdateSubagentSettingsRequest")) usage_get_metrics_result = UsageGetMetricsResult.from_dict(obj.get("UsageGetMetricsResult")) usage_metrics_code_changes = UsageMetricsCodeChanges.from_dict(obj.get("UsageMetricsCodeChanges")) usage_metrics_model_metric = UsageMetricsModelMetric.from_dict(obj.get("UsageMetricsModelMetric")) @@ -16781,40 +30800,72 @@ def from_dict(obj: Any) -> 'RPC': usage_metrics_model_metric_usage = UsageMetricsModelMetricUsage.from_dict(obj.get("UsageMetricsModelMetricUsage")) usage_metrics_token_detail = UsageMetricsTokenDetail.from_dict(obj.get("UsageMetricsTokenDetail")) user_auth_info = UserAuthInfo.from_dict(obj.get("UserAuthInfo")) + user_requested_shell_command_result = UserRequestedShellCommandResult.from_dict(obj.get("UserRequestedShellCommandResult")) + user_setting_metadata = UserSettingMetadata.from_dict(obj.get("UserSettingMetadata")) + user_settings_get_result = UserSettingsGetResult.from_dict(obj.get("UserSettingsGetResult")) + user_settings_set_request = UserSettingsSetRequest.from_dict(obj.get("UserSettingsSetRequest")) + user_settings_set_result = UserSettingsSetResult.from_dict(obj.get("UserSettingsSetResult")) + visibility_get_result = VisibilityGetResult.from_dict(obj.get("VisibilityGetResult")) + visibility_set_request = VisibilitySetRequest.from_dict(obj.get("VisibilitySetRequest")) + visibility_set_result = VisibilitySetResult.from_dict(obj.get("VisibilitySetResult")) workspace_diff_file_change = WorkspaceDiffFileChange.from_dict(obj.get("WorkspaceDiffFileChange")) workspace_diff_file_change_type = WorkspaceDiffFileChangeType(obj.get("WorkspaceDiffFileChangeType")) workspace_diff_mode = WorkspaceDiffMode(obj.get("WorkspaceDiffMode")) workspace_diff_result = WorkspaceDiffResult.from_dict(obj.get("WorkspaceDiffResult")) + workspaces_add_summary_request = WorkspacesAddSummaryRequest.from_dict(obj.get("WorkspacesAddSummaryRequest")) + workspaces_add_summary_result = WorkspacesAddSummaryResult.from_dict(obj.get("WorkspacesAddSummaryResult")) + workspaces_autopilot_objective_exists_result = WorkspacesAutopilotObjectiveExistsResult.from_dict(obj.get("WorkspacesAutopilotObjectiveExistsResult")) workspaces_checkpoints = WorkspacesCheckpoints.from_dict(obj.get("WorkspacesCheckpoints")) workspaces_create_file_request = WorkspacesCreateFileRequest.from_dict(obj.get("WorkspacesCreateFileRequest")) + workspaces_delete_autopilot_objective_result = WorkspacesDeleteAutopilotObjectiveResult.from_dict(obj.get("WorkspacesDeleteAutopilotObjectiveResult")) workspaces_diff_request = WorkspacesDiffRequest.from_dict(obj.get("WorkspacesDiffRequest")) + workspaces_ensure_request = WorkspacesEnsureRequest.from_dict(obj.get("WorkspacesEnsureRequest")) workspaces_get_workspace_result = WorkspacesGetWorkspaceResult.from_dict(obj.get("WorkspacesGetWorkspaceResult")) workspaces_list_checkpoints_result = WorkspacesListCheckpointsResult.from_dict(obj.get("WorkspacesListCheckpointsResult")) workspaces_list_files_result = WorkspacesListFilesResult.from_dict(obj.get("WorkspacesListFilesResult")) + workspaces_read_autopilot_objective_result = WorkspacesReadAutopilotObjectiveResult.from_dict(obj.get("WorkspacesReadAutopilotObjectiveResult")) workspaces_read_checkpoint_request = WorkspacesReadCheckpointRequest.from_dict(obj.get("WorkspacesReadCheckpointRequest")) workspaces_read_checkpoint_result = WorkspacesReadCheckpointResult.from_dict(obj.get("WorkspacesReadCheckpointResult")) workspaces_read_file_request = WorkspacesReadFileRequest.from_dict(obj.get("WorkspacesReadFileRequest")) workspaces_read_file_result = WorkspacesReadFileResult.from_dict(obj.get("WorkspacesReadFileResult")) workspaces_save_large_paste_request = WorkspacesSaveLargePasteRequest.from_dict(obj.get("WorkspacesSaveLargePasteRequest")) workspaces_save_large_paste_result = WorkspacesSaveLargePasteResult.from_dict(obj.get("WorkspacesSaveLargePasteResult")) + workspaces_truncate_summaries_request = WorkspacesTruncateSummariesRequest.from_dict(obj.get("WorkspacesTruncateSummariesRequest")) workspace_summary_host_type = HostType(obj.get("WorkspaceSummaryHostType")) + workspaces_update_metadata_request = WorkspacesUpdateMetadataRequest.from_dict(obj.get("WorkspacesUpdateMetadataRequest")) workspaces_workspace_details_host_type = HostType(obj.get("WorkspacesWorkspaceDetailsHostType")) + workspaces_write_autopilot_objective_request = WorkspacesWriteAutopilotObjectiveRequest.from_dict(obj.get("WorkspacesWriteAutopilotObjectiveRequest")) + workspaces_write_autopilot_objective_result = WorkspacesWriteAutopilotObjectiveResult.from_dict(obj.get("WorkspacesWriteAutopilotObjectiveResult")) + session_context_attribution = from_union([SessionContextAttribution.from_dict, from_none], obj.get("SessionContextAttribution")) session_context_info = from_union([SessionContextInfo.from_dict, from_none], obj.get("SessionContextInfo")) + subagent_settings = from_union([SubagentSettings.from_dict, from_none], obj.get("SubagentSettings")) task_progress = from_union([TaskProgress.from_dict, from_none], obj.get("TaskProgress")) workspace_summary = from_union([WorkspaceSummary.from_dict, from_none], obj.get("WorkspaceSummary")) - return RPC(abort_request, abort_result, account_get_quota_request, account_get_quota_result, account_quota_snapshot, agent_get_current_result, agent_info, agent_info_source, agent_list, agent_registry_live_target_entry, agent_registry_live_target_entry_attention_kind, agent_registry_live_target_entry_kind, agent_registry_live_target_entry_last_terminal_event, agent_registry_live_target_entry_status, agent_registry_log_capture, agent_registry_log_capture_open_error_reason, agent_registry_spawn_error, agent_registry_spawn_permission_mode, agent_registry_spawn_registry_timeout, agent_registry_spawn_request, agent_registry_spawn_result, agent_registry_spawn_spawned, agent_registry_spawn_validation_error, agent_registry_spawn_validation_error_field, agent_registry_spawn_validation_error_reason, agent_reload_result, agent_select_request, agent_select_result, allow_all_permission_set_result, allow_all_permission_state, api_key_auth_info, auth_info, auth_info_type, canvas_action, canvas_action_invoke_request, canvas_action_invoke_result, canvas_close_request, canvas_host_context, canvas_host_context_capabilities, canvas_instance_availability, canvas_json_schema, canvas_list, canvas_list_open_result, canvas_open_request, canvas_provider_close_request, canvas_provider_invoke_action_request, canvas_provider_open_request, canvas_provider_open_result, canvas_session_context, command_list, commands_handle_pending_command_request, commands_handle_pending_command_result, commands_invoke_request, commands_list_request, commands_respond_to_queued_command_request, commands_respond_to_queued_command_result, connected_remote_session_metadata, connected_remote_session_metadata_kind, connected_remote_session_metadata_repository, connect_remote_session_params, connect_request, connect_result, content_filter_mode, copilot_api_token_auth_info, copilot_user_response, copilot_user_response_endpoints, copilot_user_response_quota_snapshots, copilot_user_response_quota_snapshots_chat, copilot_user_response_quota_snapshots_completions, copilot_user_response_quota_snapshots_premium_interactions, current_model, current_tool_metadata, discovered_canvas, discovered_mcp_server, discovered_mcp_server_type, enqueue_command_params, enqueue_command_result, env_auth_info, event_log_read_request, event_log_release_interest_result, event_log_tail_result, event_log_types, events_agent_scope, events_cursor_status, events_read_result, execute_command_params, execute_command_result, 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_binary_results_for_llm, external_tool_text_result_for_llm_binary_results_for_llm_type, 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, fleet_start_request, fleet_start_result, folder_trust_add_params, folder_trust_check_params, folder_trust_check_result, gh_cli_auth_info, handle_pending_tool_call_request, handle_pending_tool_call_result, history_abort_manual_compaction_result, history_cancel_background_compaction_result, history_compact_context_window, history_compact_request, history_compact_result, history_summarize_for_handoff_result, history_truncate_request, history_truncate_result, hmac_auth_info, installed_plugin, installed_plugin_source, installed_plugin_source_github, installed_plugin_source_local, installed_plugin_source_url, instructions_get_sources_result, instructions_sources, instructions_sources_location, instructions_sources_type, log_request, log_result, lsp_initialize_request, mcp_apps_call_tool_request, mcp_apps_diagnose_capability, mcp_apps_diagnose_request, mcp_apps_diagnose_result, mcp_apps_diagnose_server, mcp_apps_host_context, mcp_apps_host_context_details, mcp_apps_host_context_details_available_display_mode, mcp_apps_host_context_details_display_mode, mcp_apps_host_context_details_platform, mcp_apps_host_context_details_theme, mcp_apps_list_tools_request, mcp_apps_list_tools_result, mcp_apps_read_resource_request, mcp_apps_read_resource_result, mcp_apps_resource_content, mcp_apps_set_host_context_details, mcp_apps_set_host_context_details_available_display_mode, mcp_apps_set_host_context_details_display_mode, mcp_apps_set_host_context_details_platform, mcp_apps_set_host_context_details_theme, mcp_apps_set_host_context_request, mcp_cancel_sampling_execution_params, mcp_cancel_sampling_execution_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_execute_sampling_params, mcp_execute_sampling_request, mcp_execute_sampling_result, mcp_oauth_login_request, mcp_oauth_login_result, mcp_remove_git_hub_result, mcp_sampling_execution_action, mcp_sampling_execution_result, mcp_server, mcp_server_auth_config, mcp_server_auth_config_redirect_port, mcp_server_config, mcp_server_config_http, mcp_server_config_http_oauth_grant_type, mcp_server_config_http_type, mcp_server_config_stdio, mcp_server_list, mcp_set_env_value_mode_details, mcp_set_env_value_mode_params, mcp_set_env_value_mode_result, metadata_context_info_request, metadata_context_info_result, metadata_is_processing_result, metadata_recompute_context_tokens_request, metadata_recompute_context_tokens_result, metadata_record_context_change_request, metadata_record_context_change_result, metadata_set_working_directory_request, metadata_set_working_directory_result, metadata_snapshot_current_mode, metadata_snapshot_remote_metadata, metadata_snapshot_remote_metadata_repository, metadata_snapshot_remote_metadata_task_type, model, model_billing, model_billing_token_prices, model_billing_token_prices_long_context, 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_current_context_tier, model_list, model_list_request, model_picker_category, model_picker_price_category, model_policy, model_policy_state, model_set_reasoning_effort_request, model_set_reasoning_effort_result, models_list_request, model_switch_to_request, model_switch_to_result, mode_set_request, name_get_result, name_set_auto_request, name_set_auto_result, name_set_request, open_canvas_instance, options_update_env_value_mode, options_update_tool_filter_precedence, pending_permission_request, pending_permission_request_list, permission_decision, permission_decision_approved, permission_decision_approved_for_location, permission_decision_approved_for_session, 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_extension_management, permission_decision_approve_for_location_approval_extension_permission_access, 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_extension_management, permission_decision_approve_for_session_approval_extension_permission_access, 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_cancelled, permission_decision_denied_by_content_exclusion_policy, permission_decision_denied_by_permission_request_hook, permission_decision_denied_by_rules, permission_decision_denied_interactively_by_user, permission_decision_denied_no_approval_rule_and_could_not_request_from_user, permission_decision_reject, permission_decision_request, permission_decision_user_not_available, permission_location_add_tool_approval_params, permission_location_apply_params, permission_location_apply_result, permission_location_resolve_params, permission_location_resolve_result, permission_location_type, permission_paths_add_params, permission_paths_allowed_check_params, permission_paths_allowed_check_result, permission_paths_config, permission_paths_list, permission_paths_update_primary_params, permission_paths_workspace_check_params, permission_paths_workspace_check_result, permission_prompt_shown_notification, permission_request_result, permission_rules_set, permissions_configure_additional_content_exclusion_policy, permissions_configure_additional_content_exclusion_policy_rule, permissions_configure_additional_content_exclusion_policy_rule_source, permissions_configure_additional_content_exclusion_policy_scope, permissions_configure_params, permissions_configure_result, permissions_folder_trust_add_trusted_result, permissions_get_allow_all_request, permissions_locations_add_tool_approval_details, permissions_locations_add_tool_approval_details_commands, permissions_locations_add_tool_approval_details_custom_tool, permissions_locations_add_tool_approval_details_extension_management, permissions_locations_add_tool_approval_details_extension_permission_access, permissions_locations_add_tool_approval_details_mcp, permissions_locations_add_tool_approval_details_mcp_sampling, permissions_locations_add_tool_approval_details_memory, permissions_locations_add_tool_approval_details_read, permissions_locations_add_tool_approval_details_write, permissions_locations_add_tool_approval_result, permissions_modify_rules_params, permissions_modify_rules_result, permissions_modify_rules_scope, permissions_notify_prompt_shown_result, permissions_paths_add_result, permissions_paths_list_request, permissions_paths_update_primary_result, permissions_pending_requests_request, permissions_reset_session_approvals_request, permissions_reset_session_approvals_result, permissions_set_allow_all_request, permissions_set_allow_all_source, permissions_set_approve_all_request, permissions_set_approve_all_result, permissions_set_approve_all_source, permissions_set_required_request, permissions_set_required_result, permissions_urls_set_unrestricted_mode_result, permission_urls_config, permission_urls_set_unrestricted_mode_params, ping_request, ping_result, plan_read_result, plan_update_request, plugin, plugin_list, queued_command_handled, queued_command_not_handled, queued_command_result, queue_pending_items, queue_pending_items_kind, queue_pending_items_result, queue_remove_most_recent_result, register_event_interest_params, register_event_interest_result, release_event_interest_params, remote_enable_request, remote_enable_result, remote_notify_steerable_changed_request, remote_notify_steerable_changed_result, remote_session_connection_result, remote_session_mode, schedule_entry, schedule_list, schedule_stop_request, schedule_stop_result, secrets_add_filter_values_request, secrets_add_filter_values_result, send_agent_mode, send_attachment, send_attachment_blob, send_attachment_directory, send_attachment_file, send_attachment_file_line_range, send_attachment_github_reference, send_attachment_github_reference_type, send_attachment_selection, send_attachment_selection_details, send_attachment_selection_details_end, send_attachment_selection_details_start, send_mode, send_request, send_result, server_skill, server_skill_list, session_auth_status, session_bulk_delete_result, session_context, session_context_host_type, session_enrich_metadata_result, 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_capabilities, session_fs_set_provider_conventions, session_fs_set_provider_request, session_fs_set_provider_result, session_fs_sqlite_exists_request, session_fs_sqlite_exists_result, session_fs_sqlite_query_request, session_fs_sqlite_query_result, session_fs_sqlite_query_type, session_fs_stat_request, session_fs_stat_result, session_fs_write_file_request, session_installed_plugin, session_installed_plugin_source, session_installed_plugin_source_github, session_installed_plugin_source_local, session_installed_plugin_source_url, session_list, session_list_filter, session_load_deferred_repo_hooks_result, session_log_level, session_mcp_apps_call_tool_result, session_metadata, session_metadata_snapshot, session_mode, session_model_list, session_prune_result, sessions_bulk_delete_request, sessions_check_in_use_request, sessions_check_in_use_result, sessions_close_request, sessions_close_result, sessions_enrich_metadata_request, session_set_credentials_params, session_set_credentials_result, sessions_find_by_prefix_request, sessions_find_by_prefix_result, sessions_find_by_task_id_request, sessions_find_by_task_id_result, sessions_fork_request, sessions_fork_result, sessions_get_event_file_path_request, sessions_get_event_file_path_result, sessions_get_last_for_context_request, sessions_get_last_for_context_result, sessions_get_persisted_remote_steerable_request, sessions_get_persisted_remote_steerable_result, session_sizes, sessions_list_request, sessions_load_deferred_repo_hooks_request, sessions_prune_old_request, sessions_release_lock_request, sessions_release_lock_result, sessions_reload_plugin_hooks_request, sessions_reload_plugin_hooks_result, sessions_save_request, sessions_save_result, sessions_set_additional_plugins_request, sessions_set_additional_plugins_result, session_update_options_params, session_update_options_result, session_working_directory_context, session_working_directory_context_host_type, shell_exec_request, shell_exec_result, shell_kill_request, shell_kill_result, shell_kill_signal, shutdown_request, skill, skill_list, skills_config_set_disabled_skills_request, skills_disable_request, skills_discover_request, skills_enable_request, skills_get_invoked_result, skills_invoked_skill, skills_load_diagnostics, slash_command_agent_prompt_result, slash_command_completed_result, slash_command_info, slash_command_input, slash_command_input_completion, slash_command_invocation_result, slash_command_kind, slash_command_select_subcommand_option, slash_command_select_subcommand_result, slash_command_text_result, task_agent_info, task_agent_progress, task_execution_mode, task_info, task_list, task_progress_line, tasks_cancel_request, tasks_cancel_result, tasks_get_current_promotable_result, tasks_get_progress_request, tasks_get_progress_result, task_shell_info, task_shell_info_attachment_mode, task_shell_progress, tasks_promote_current_to_background_result, tasks_promote_to_background_request, tasks_promote_to_background_result, tasks_refresh_result, tasks_remove_request, tasks_remove_result, tasks_send_message_request, tasks_send_message_result, tasks_start_agent_request, tasks_start_agent_result, task_status, tasks_wait_for_pending_result, telemetry_set_feature_overrides_request, token_auth_info, tool, tool_list, tools_get_current_metadata_result, tools_initialize_and_validate_result, tools_list_request, ui_auto_mode_switch_response, 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_exit_plan_mode_action, ui_exit_plan_mode_response, ui_handle_pending_auto_mode_switch_request, ui_handle_pending_elicitation_request, ui_handle_pending_exit_plan_mode_request, ui_handle_pending_result, ui_handle_pending_sampling_request, ui_handle_pending_sampling_response, ui_handle_pending_user_input_request, ui_register_direct_auto_mode_switch_handler_result, ui_unregister_direct_auto_mode_switch_handler_request, ui_unregister_direct_auto_mode_switch_handler_result, ui_user_input_response, 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, user_auth_info, workspace_diff_file_change, workspace_diff_file_change_type, workspace_diff_mode, workspace_diff_result, workspaces_checkpoints, workspaces_create_file_request, workspaces_diff_request, workspaces_get_workspace_result, workspaces_list_checkpoints_result, workspaces_list_files_result, workspaces_read_checkpoint_request, workspaces_read_checkpoint_result, workspaces_read_file_request, workspaces_read_file_result, workspaces_save_large_paste_request, workspaces_save_large_paste_result, workspace_summary_host_type, workspaces_workspace_details_host_type, session_context_info, task_progress, workspace_summary) + return RPC(abort_request, abort_result, account_all_users, account_get_all_users_result, account_get_current_auth_result, account_get_quota_request, account_get_quota_result, account_login_request, account_login_result, account_logout_request, account_logout_result, account_quota_snapshot, adaptive_thinking_support, agent_discovery_path, agent_discovery_path_list, agent_discovery_path_scope, agent_get_current_result, agent_info, agent_info_source, agent_list, agent_list_request, agent_registry_live_target_entry, agent_registry_live_target_entry_attention_kind, agent_registry_live_target_entry_kind, agent_registry_live_target_entry_last_terminal_event, agent_registry_live_target_entry_status, agent_registry_log_capture, agent_registry_log_capture_open_error_reason, agent_registry_spawn_error, agent_registry_spawn_permission_mode, agent_registry_spawn_registry_timeout, agent_registry_spawn_request, agent_registry_spawn_result, agent_registry_spawn_spawned, agent_registry_spawn_validation_error, agent_registry_spawn_validation_error_field, agent_registry_spawn_validation_error_reason, agent_reload_result, agents_discover_request, agent_select_request, agent_select_result, agent_set_prompt_request, agents_get_discovery_paths_request, allow_all_permission_set_result, allow_all_permission_state, api_key_auth_info, auth_info, auth_info_type, built_in_model_catalog, built_in_model_catalog_entry, cancel_user_requested_shell_command_result, canvas_action, canvas_action_invoke_request, canvas_action_invoke_result, canvas_close_request, canvas_host_context, canvas_host_context_capabilities, canvas_json_schema, canvas_list, canvas_list_open_result, canvas_open_request, canvas_provider_close_request, canvas_provider_invoke_action_request, canvas_provider_open_request, canvas_provider_open_result, canvas_session_context, capi_session_options, command_list, commands_handle_pending_command_request, commands_handle_pending_command_result, commands_invoke_request, commands_list_request, commands_respond_to_queued_command_request, commands_respond_to_queued_command_result, completions_get_trigger_characters_result, completions_request_request, completions_request_result, configure_session_extensions_params, connected_remote_session_metadata, connected_remote_session_metadata_kind, connected_remote_session_metadata_repository, connect_remote_session_params, connect_request, connect_result, content_exclusion_check_paths_request, content_exclusion_check_paths_result, content_exclusion_path_check, content_filter_mode, context_heaviest_message, copilot_api_token_auth_info, copilot_user_response, copilot_user_response_endpoints, copilot_user_response_quota_snapshots, copilot_user_response_quota_snapshots_chat, copilot_user_response_quota_snapshots_completions, copilot_user_response_quota_snapshots_premium_interactions, current_model, current_tool_metadata, debug_collect_logs_collected_entry, debug_collect_logs_destination, debug_collect_logs_entry, debug_collect_logs_entry_kind, debug_collect_logs_include, debug_collect_logs_redaction, debug_collect_logs_request, debug_collect_logs_result, debug_collect_logs_result_kind, debug_collect_logs_skipped_entry, debug_collect_logs_source, disable_bypass_permissions_mode, discovered_canvas, discovered_extension, discovered_extension_mode, discovered_extension_plugin, discovered_extensions, discovered_extensions_disable_request, discovered_extensions_enable_request, discovered_extension_source, discovered_mcp_server, discovered_mcp_server_type, enqueue_command_params, enqueue_command_result, env_auth_info, event_log_read_request, event_log_release_interest_result, event_log_tail_result, event_log_types, events_agent_scope, events_cursor_status, events_read_direction, events_read_result, execute_command_params, execute_command_result, extension, extension_context_push_input, extension_launch_profile, extension_launch_provider_resolve_request, extension_launch_provider_resolve_result, 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_binary_results_for_llm, external_tool_text_result_for_llm_binary_results_for_llm_type, 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_shell_exit, external_tool_text_result_for_llm_content_terminal, external_tool_text_result_for_llm_content_text, factory_abort_request, factory_ack_result, factory_agent_options, factory_agent_request, factory_agent_result, factory_agent_summary, factory_cancel_request, factory_current_phase, factory_declared_limits, factory_durable_operation, factory_execute_request, factory_execute_result, factory_get_run_progress_request, factory_get_run_request, factory_journal_get_request, factory_journal_get_result, factory_journal_put_request, factory_list_runs_request, factory_list_runs_result, factory_log_line, factory_log_line_kind, factory_log_request, factory_phase_observation, factory_phase_status, factory_progress_line, factory_progress_page, factory_resume_request, factory_resume_result, factory_run_consumed, factory_run_detail, factory_run_failure, factory_run_failure_kind, factory_run_limits, factory_run_request, factory_run_result, factory_run_status, factory_run_summary, factory_run_terminal, filter_mapping, fleet_start_request, fleet_start_result, folder_trust_add_params, folder_trust_check_params, folder_trust_check_result, gh_cli_auth_info, git_hub_telemetry_client_info, git_hub_telemetry_event, git_hub_telemetry_notification, handle_pending_tool_call_request, handle_pending_tool_call_result, history_abort_manual_compaction_result, history_cancel_background_compaction_result, history_clear_context_request, history_clear_context_result, history_compact_context_window, history_compact_request, history_compact_result, history_file_restore_skip_reason, history_list_rewind_points_result, history_preview_rewind_request, history_preview_rewind_result, history_rewind_change_type, history_rewind_file_preview, history_rewind_mode, history_rewind_outcome, history_rewind_point, history_rewind_request, history_rewind_result, history_rewind_unavailable_reason, history_skipped_file_restore, history_summarize_for_handoff_result, history_truncate_request, history_truncate_result, hmac_auth_info, hook_invoke_request, hook_invoke_response, hook_type, installed_plugin, installed_plugin_info, installed_plugin_source, installed_plugin_source_git_hub, installed_plugin_source_local, installed_plugin_source_url, instruction_discovery_path, instruction_discovery_path_kind, instruction_discovery_path_list, instruction_discovery_path_location, instructions_discover_request, instructions_get_discovery_paths_request, instructions_get_sources_result, instruction_source, instruction_source_location, instruction_source_type, interrupt_main_turn_request, interrupt_main_turn_result, llm_inference_headers, llm_inference_http_request_chunk_request, llm_inference_http_request_chunk_result, llm_inference_http_request_start_request, llm_inference_http_request_start_result, llm_inference_http_request_start_transport, llm_inference_http_response_chunk_error, llm_inference_http_response_chunk_request, llm_inference_http_response_chunk_result, llm_inference_http_response_start_request, llm_inference_http_response_start_result, llm_inference_set_provider_result, local_session_metadata_value, log_request, log_result, lsp_initialize_request, managed_settings_read_result, marketplace_add_result, marketplace_browse_result, marketplace_info, marketplace_list_result, marketplace_plugin_info, marketplace_refresh_entry, marketplace_refresh_result, marketplace_remove_result, mcp_allowed_server, mcp_apps_call_tool_request, mcp_apps_diagnose_capability, mcp_apps_diagnose_request, mcp_apps_diagnose_result, mcp_apps_diagnose_server, mcp_apps_host_context, mcp_apps_host_context_details, mcp_apps_host_context_details_available_display_mode, mcp_apps_host_context_details_display_mode, mcp_apps_host_context_details_platform, mcp_apps_host_context_details_theme, mcp_apps_list_tools_request, mcp_apps_list_tools_result, mcp_apps_read_resource_request, mcp_apps_read_resource_result, mcp_apps_resource_content, mcp_apps_set_host_context_details, mcp_apps_set_host_context_details_available_display_mode, mcp_apps_set_host_context_details_display_mode, mcp_apps_set_host_context_details_platform, mcp_apps_set_host_context_details_theme, mcp_apps_set_host_context_request, mcp_cancel_sampling_execution_params, mcp_cancel_sampling_execution_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_configure_git_hub_request, mcp_configure_git_hub_result, mcp_disable_request, mcp_discover_request, mcp_discover_result, mcp_enable_request, mcp_execute_sampling_params, mcp_execute_sampling_request, mcp_execute_sampling_result, mcp_filtered_server, mcp_headers_handle_pending_headers_refresh_request, mcp_headers_handle_pending_headers_refresh_request_request, mcp_headers_handle_pending_headers_refresh_request_result, mcp_host_state, mcp_is_server_running_request, mcp_is_server_running_result, mcp_list_tools_request, mcp_list_tools_result, mcp_oauth_authentication_state_changed_request, mcp_oauth_handle_pending_request, mcp_oauth_handle_pending_result, mcp_oauth_login_grant_type, mcp_oauth_login_request, mcp_oauth_login_result, mcp_oauth_pending_request_response, mcp_oauth_respond_request, mcp_oauth_respond_result, mcp_register_external_client_request, mcp_reload_with_config_request, mcp_remove_git_hub_result, mcp_resource, mcp_resource_annotations, mcp_resource_content, mcp_resource_icon, mcp_resources_list_request, mcp_resources_list_result, mcp_resources_list_templates_request, mcp_resources_list_templates_result, mcp_resources_read_request, mcp_resources_read_result, mcp_resource_template, mcp_restart_server_request, mcp_sampling_execution_action, mcp_sampling_execution_result, mcp_server, mcp_server_auth_config, mcp_server_auth_config_redirect_port, mcp_server_config, mcp_server_config_defer_tools, mcp_server_config_http, mcp_server_config_http_oauth_grant_type, mcp_server_config_http_type, mcp_server_config_stdio, mcp_server_failure_info, mcp_server_list, mcp_server_needs_auth_info, mcp_set_env_value_mode_details, mcp_set_env_value_mode_params, mcp_set_env_value_mode_result, mcp_start_server_request, mcp_start_servers_result, mcp_stop_server_request, mcp_tools, mcp_tool_ui, mcp_tool_ui_visibility, mcp_unregister_external_client_request, memory_configuration, metadata_context_attribution_result, metadata_context_heaviest_messages_request, metadata_context_heaviest_messages_result, metadata_context_info_request, metadata_context_info_result, metadata_is_processing_result, metadata_recompute_context_tokens_request, metadata_recompute_context_tokens_result, metadata_record_context_change_request, metadata_record_context_change_result, metadata_set_working_directory_request, metadata_set_working_directory_result, metadata_snapshot_current_mode, metadata_snapshot_remote_metadata, metadata_snapshot_remote_metadata_repository, metadata_snapshot_remote_metadata_task_type, model, model_billing, model_billing_promo, model_billing_token_prices, model_billing_token_prices_long_context, 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_list_request, model_picker_category, model_picker_price_category, model_policy, model_policy_state, model_set_reasoning_effort_request, model_set_reasoning_effort_result, models_list_request, model_switch_to_request, model_switch_to_result, mode_set_request, named_provider_config, name_get_result, name_set_auto_request, name_set_auto_result, name_set_request, open_canvas_instance, options_update_additional_content_exclusion_policy, options_update_additional_content_exclusion_policy_rule, options_update_additional_content_exclusion_policy_rule_source, options_update_additional_content_exclusion_policy_scope, options_update_context_tier, options_update_env_value_mode, options_update_reasoning_summary, options_update_tool_filter_precedence, pending_permission_request, pending_permission_request_list, permission_decision, permission_decision_approved, permission_decision_approved_for_location, permission_decision_approved_for_session, 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_extension_management, permission_decision_approve_for_location_approval_extension_permission_access, permission_decision_approve_for_location_approval_factory, 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_extension_management, permission_decision_approve_for_session_approval_extension_permission_access, permission_decision_approve_for_session_approval_factory, 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_cancelled, permission_decision_context, permission_decision_denied_by_content_exclusion_policy, permission_decision_denied_by_permission_request_hook, permission_decision_denied_by_rules, permission_decision_denied_interactively_by_user, permission_decision_denied_no_approval_rule_and_could_not_request_from_user, permission_decision_outcome, permission_decision_reject, permission_decision_request, permission_decision_source, permission_decision_surface, permission_decision_user_not_available, permission_location_add_tool_approval_params, permission_location_apply_params, permission_location_apply_result, permission_location_resolve_params, permission_location_resolve_result, permission_location_type, permission_paths_add_params, permission_paths_allowed_check_params, permission_paths_allowed_check_result, permission_paths_config, permission_paths_list, permission_paths_update_primary_params, permission_paths_workspace_check_params, permission_paths_workspace_check_result, permission_prompt_shown_notification, permission_request_result, permission_rules_set, permissions_allow_all_mode, permissions_configure_additional_content_exclusion_policy, permissions_configure_additional_content_exclusion_policy_rule, permissions_configure_additional_content_exclusion_policy_rule_source, permissions_configure_additional_content_exclusion_policy_scope, permissions_configure_params, permissions_configure_result, permissions_folder_trust_add_trusted_result, permissions_get_allow_all_request, permissions_locations_add_tool_approval_details, permissions_locations_add_tool_approval_details_commands, permissions_locations_add_tool_approval_details_custom_tool, permissions_locations_add_tool_approval_details_extension_management, permissions_locations_add_tool_approval_details_extension_permission_access, permissions_locations_add_tool_approval_details_factory, permissions_locations_add_tool_approval_details_mcp, permissions_locations_add_tool_approval_details_mcp_sampling, permissions_locations_add_tool_approval_details_memory, permissions_locations_add_tool_approval_details_read, permissions_locations_add_tool_approval_details_write, permissions_locations_add_tool_approval_result, permissions_modify_rules_params, permissions_modify_rules_result, permissions_modify_rules_scope, permissions_notify_prompt_shown_result, permissions_paths_add_result, permissions_paths_list_request, permissions_paths_update_primary_result, permissions_pending_requests_request, permissions_reset_session_approvals_request, permissions_reset_session_approvals_result, permissions_set_allow_all_request, permissions_set_allow_all_source, permissions_set_approve_all_request, permissions_set_approve_all_result, permissions_set_approve_all_source, permissions_set_required_request, permissions_set_required_result, permissions_urls_set_unrestricted_mode_result, permission_urls_config, permission_urls_set_unrestricted_mode_params, ping_request, ping_result, plan_read_result, plan_read_sql_todos_result, plan_read_sql_todos_with_dependencies_result, plan_sql_todo_dependency, plan_sql_todos_row, plan_update_request, plugin, plugin_install_result, plugin_list, plugin_list_result, plugins_disable_request, plugins_enable_request, plugins_install_request, plugins_marketplaces_add_request, plugins_marketplaces_browse_request, plugins_marketplaces_refresh_request, plugins_marketplaces_remove_request, plugins_reload_request, plugins_uninstall_request, plugins_update_request, plugin_update_all_entry, plugin_update_all_result, plugin_update_result, provider_add_request, provider_add_result, provider_config, provider_config_azure, provider_config_transport, provider_config_type, provider_config_wire_api, provider_endpoint, provider_endpoint_transport, provider_endpoint_type, provider_endpoint_wire_api, provider_get_endpoint_request, provider_model_config, provider_session_token, provider_token_acquire_request, provider_token_acquire_result, push_attachment, push_attachment_blob, push_attachment_directory, push_attachment_file, push_attachment_file_line_range, push_attachment_git_hub_actions_job, push_attachment_git_hub_commit, push_attachment_git_hub_file, push_attachment_git_hub_file_diff, push_attachment_git_hub_file_diff_side, push_attachment_git_hub_reference, push_attachment_git_hub_reference_type, push_attachment_git_hub_release, push_attachment_git_hub_repository, push_attachment_git_hub_snippet, push_attachment_git_hub_tree_comparison, push_attachment_git_hub_tree_comparison_side, push_attachment_git_hub_url, push_attachment_selection, push_attachment_selection_details, push_attachment_selection_details_end, push_attachment_selection_details_start, push_git_hub_repo_ref, queue_begin_deferred_idle_drain_request, queue_begin_deferred_idle_drain_result, queue_consume_system_notifications_request, queued_command_handled, queued_command_not_handled, queued_command_result, queue_defer_session_idle_request, queue_duplicate_at_request, queue_duplicate_at_result, queue_enqueue_resume_pending_result, queue_finish_deferred_idle_drain_request, queue_finish_deferred_idle_drain_result, queue_has_pending_result, queue_insert_at_request, queue_insert_at_result, queue_insert_message, queue_move_item_request, queue_move_item_result, queue_pending_items, queue_pending_items_kind, queue_pending_items_result, queue_remove_at_request, queue_remove_at_result, queue_remove_most_recent_result, queue_send_now_request, queue_send_now_result, queue_set_drain_paused_request, queue_snapshot_result, queue_update_text_request, queue_update_text_result, register_event_interest_params, register_event_interest_result, register_extension_tools_params, register_extension_tools_result, release_event_interest_params, remote_control_config, remote_control_config_existing_mc_session, remote_control_status, remote_control_status_active, remote_control_status_connecting, remote_control_status_error, remote_control_status_off, remote_control_status_result, remote_control_stop_result, remote_control_transfer_result, remote_enable_request, remote_enable_result, remote_notify_steerable_changed_request, remote_notify_steerable_changed_result, remote_session_connection_result, remote_session_metadata_repository, remote_session_metadata_task_type, remote_session_metadata_value, remote_session_mode, remote_session_repository, run_options, sandbox_config, sandbox_config_auth, sandbox_config_user_policy, sandbox_config_user_policy_experimental, sandbox_config_user_policy_experimental_seatbelt, sandbox_config_user_policy_filesystem, sandbox_config_user_policy_network, sandbox_config_user_policy_network_proxy, sandbox_config_user_policy_seatbelt, schedule_add_at_request, schedule_add_cron_request, schedule_add_request, schedule_add_result, schedule_add_self_paced_request, schedule_entry, schedule_has_self_paced_result, schedule_list, schedule_rearm_self_paced_request, schedule_stop_request, schedule_stop_result, secrets_add_filter_values_request, secrets_add_filter_values_result, send_agent_mode, send_attachments_to_message_params, send_message_item, send_messages_request, send_messages_result, send_mode, send_request, send_result, send_system_notification_request, server_agent_list, server_instruction_source_list, server_skill, server_skill_list, session_activity, session_agent_list_request, session_auth_status, session_bulk_delete_result, session_cancel_all_background_agents_result, session_capability, session_commands_list_request, session_completion_item, session_context, session_context_host_type, session_enrich_metadata_result, 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_capabilities, session_fs_set_provider_conventions, session_fs_set_provider_request, session_fs_set_provider_result, session_fs_sqlite_exists_request, session_fs_sqlite_exists_result, session_fs_sqlite_query_request, session_fs_sqlite_query_result, session_fs_sqlite_query_type, session_fs_sqlite_transaction_error, session_fs_sqlite_transaction_error_class, session_fs_sqlite_transaction_request, session_fs_sqlite_transaction_result, session_fs_sqlite_transaction_statement, session_fs_stat_request, session_fs_stat_result, session_fs_write_file_request, session_history_compact_request, session_installed_plugin, session_installed_plugin_source, session_installed_plugin_source_git_hub, session_installed_plugin_source_local, session_installed_plugin_source_url, session_limit_prediction_baseline_data, session_limit_prediction_client_type, session_limit_prediction_details, session_limit_prediction_predict_request, session_limit_prediction_request, session_limit_prediction_result, session_limit_prediction_source, session_limit_prediction_tier, session_limit_prediction_tier_option, session_limit_prediction_unavailable_reason, session_list, session_list_entry, session_list_filter, session_load_deferred_repo_hooks_result, session_log_level, session_managed_permissions, session_managed_settings, session_mcp_apps_call_tool_result, session_metadata_snapshot, session_mode, session_model_list, session_model_list_request, session_model_price_category, session_open_options, session_open_options_additional_content_exclusion_policy, session_open_options_additional_content_exclusion_policy_rule, session_open_options_additional_content_exclusion_policy_rule_source, session_open_options_additional_content_exclusion_policy_scope, session_open_options_env_value_mode, session_open_options_reasoning_summary, session_open_params, session_open_result, session_plugins_reload_request, session_provider_get_endpoint_request, session_prune_result, sessions_bulk_delete_request, sessions_check_in_use_request, sessions_check_in_use_result, sessions_close_request, sessions_close_result, sessions_delete_request, sessions_enrich_metadata_request, session_set_credentials_params, session_set_credentials_result, session_settings_built_in_tool_availability_snapshot, session_settings_evaluate_predicate_request, session_settings_evaluate_predicate_result, session_settings_job_snapshot, session_settings_model_snapshot, session_settings_online_evaluation_snapshot, session_settings_predicate_name, session_settings_repo_snapshot, session_settings_snapshot, session_settings_validation_snapshot, sessions_find_by_prefix_request, sessions_find_by_prefix_result, sessions_find_by_task_id_request, sessions_find_by_task_id_result, sessions_fork_request, sessions_fork_result, sessions_get_board_entry_count_request, sessions_get_board_entry_count_result, sessions_get_event_file_path_request, sessions_get_event_file_path_result, sessions_get_last_for_context_request, sessions_get_last_for_context_result, sessions_get_metadata_request, sessions_get_metadata_result, sessions_get_persisted_remote_steerable_request, sessions_get_persisted_remote_steerable_result, session_sizes, sessions_list_non_empty_session_ids_request, sessions_list_non_empty_session_ids_result, sessions_list_request, sessions_load_deferred_repo_hooks_request, sessions_open_attach, sessions_open_cloud, sessions_open_create, sessions_open_handoff, sessions_open_handoff_task_type, sessions_open_progress, sessions_open_progress_status, sessions_open_progress_step, sessions_open_remote, sessions_open_resume, sessions_open_resume_last, sessions_open_status, session_source, sessions_prune_old_request, sessions_register_extension_tools_on_session_options, sessions_release_lock_request, sessions_release_lock_result, sessions_reload_plugin_hooks_request, sessions_reload_plugin_hooks_result, sessions_save_request, sessions_save_result, sessions_set_additional_plugins_request, sessions_set_additional_plugins_result, sessions_set_remote_control_steering_request, sessions_start_remote_control_request, sessions_stop_remote_control_request, sessions_transfer_remote_control_request, session_telemetry_engagement, session_update_options_params, session_update_options_result, session_visibility_status, session_working_directory_context, session_working_directory_context_host_type, shell_cancel_user_requested_request, shell_exec_request, shell_exec_result, shell_execute_user_requested_request, shell_init_profile, shell_init_script, shell_init_script_shell, shell_kill_request, shell_kill_result, shell_kill_signal, shell_options, shutdown_request, skill, skill_discovery_path, skill_discovery_path_list, skill_discovery_scope, skill_list, skills_config_set_disabled_skills_request, skills_disable_request, skills_discover_request, skills_enable_request, skills_get_discovery_paths_request, skills_get_invoked_result, skills_invoked_skill, skills_load_diagnostics, slash_command_agent_prompt_result, slash_command_completed_result, slash_command_info, slash_command_input, slash_command_input_choice, slash_command_input_completion, slash_command_invocation_result, slash_command_kind, slash_command_select_subcommand_option, slash_command_select_subcommand_result, slash_command_text_result, subagent_settings_entry, subagent_settings_entry_context_tier, task_agent_info, task_agent_progress, task_execution_mode, task_info, task_list, task_progress_line, tasks_cancel_request, tasks_cancel_result, tasks_get_current_promotable_result, tasks_get_progress_request, tasks_get_progress_result, task_shell_info, task_shell_info_attachment_mode, task_shell_progress, tasks_promote_current_to_background_result, tasks_promote_to_background_request, tasks_promote_to_background_result, tasks_refresh_result, tasks_remove_request, tasks_remove_result, tasks_send_message_request, tasks_send_message_result, tasks_start_agent_request, tasks_start_agent_result, task_status, tasks_wait_for_pending_result, telemetry_set_feature_overrides_request, token_auth_info, tool, tool_list, tools_get_current_metadata_result, tools_initialize_and_validate_result, tools_list_request, tools_update_subagent_settings_result, ui_auto_mode_switch_response, 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_ephemeral_query_request, ui_ephemeral_query_result, ui_exit_plan_mode_action, ui_exit_plan_mode_response, ui_handle_pending_auto_mode_switch_request, ui_handle_pending_elicitation_request, ui_handle_pending_exit_plan_mode_request, ui_handle_pending_result, ui_handle_pending_sampling_request, ui_handle_pending_sampling_response, ui_handle_pending_session_limits_exhausted_request, ui_handle_pending_user_input_request, ui_register_direct_auto_mode_switch_handler_result, ui_session_limits_exhausted_response, ui_session_limits_exhausted_response_action, ui_unregister_direct_auto_mode_switch_handler_request, ui_unregister_direct_auto_mode_switch_handler_result, ui_user_input_response, update_subagent_settings_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, user_auth_info, user_requested_shell_command_result, user_setting_metadata, user_settings_get_result, user_settings_set_request, user_settings_set_result, visibility_get_result, visibility_set_request, visibility_set_result, workspace_diff_file_change, workspace_diff_file_change_type, workspace_diff_mode, workspace_diff_result, workspaces_add_summary_request, workspaces_add_summary_result, workspaces_autopilot_objective_exists_result, workspaces_checkpoints, workspaces_create_file_request, workspaces_delete_autopilot_objective_result, workspaces_diff_request, workspaces_ensure_request, workspaces_get_workspace_result, workspaces_list_checkpoints_result, workspaces_list_files_result, workspaces_read_autopilot_objective_result, workspaces_read_checkpoint_request, workspaces_read_checkpoint_result, workspaces_read_file_request, workspaces_read_file_result, workspaces_save_large_paste_request, workspaces_save_large_paste_result, workspaces_truncate_summaries_request, workspace_summary_host_type, workspaces_update_metadata_request, workspaces_workspace_details_host_type, workspaces_write_autopilot_objective_request, workspaces_write_autopilot_objective_result, session_context_attribution, session_context_info, subagent_settings, task_progress, workspace_summary) def to_dict(self) -> dict: result: dict = {} result["AbortRequest"] = to_class(AbortRequest, self.abort_request) result["AbortResult"] = to_class(AbortResult, self.abort_result) + result["AccountAllUsers"] = to_class(AccountAllUsers, self.account_all_users) + result["AccountGetAllUsersResult"] = from_list(lambda x: to_class(AccountAllUsers, x), self.account_get_all_users_result) + result["AccountGetCurrentAuthResult"] = to_class(AccountGetCurrentAuthResult, self.account_get_current_auth_result) result["AccountGetQuotaRequest"] = to_class(AccountGetQuotaRequest, self.account_get_quota_request) result["AccountGetQuotaResult"] = to_class(AccountGetQuotaResult, self.account_get_quota_result) + result["AccountLoginRequest"] = to_class(AccountLoginRequest, self.account_login_request) + result["AccountLoginResult"] = to_class(AccountLoginResult, self.account_login_result) + result["AccountLogoutRequest"] = to_class(AccountLogoutRequest, self.account_logout_request) + result["AccountLogoutResult"] = to_class(AccountLogoutResult, self.account_logout_result) result["AccountQuotaSnapshot"] = to_class(AccountQuotaSnapshot, self.account_quota_snapshot) + result["AdaptiveThinkingSupport"] = to_enum(AdaptiveThinkingSupport, self.adaptive_thinking_support) + result["AgentDiscoveryPath"] = to_class(AgentDiscoveryPath, self.agent_discovery_path) + result["AgentDiscoveryPathList"] = to_class(AgentDiscoveryPathList, self.agent_discovery_path_list) + result["AgentDiscoveryPathScope"] = to_enum(AgentDiscoveryPathScope, self.agent_discovery_path_scope) result["AgentGetCurrentResult"] = to_class(AgentGetCurrentResult, self.agent_get_current_result) result["AgentInfo"] = to_class(AgentInfo, self.agent_info) result["AgentInfoSource"] = to_enum(AgentInfoSource, self.agent_info_source) result["AgentList"] = to_class(AgentList, self.agent_list) + result["AgentListRequest"] = self.agent_list_request result["AgentRegistryLiveTargetEntry"] = to_class(AgentRegistryLiveTargetEntry, self.agent_registry_live_target_entry) result["AgentRegistryLiveTargetEntryAttentionKind"] = to_enum(AgentRegistryLiveTargetEntryAttentionKind, self.agent_registry_live_target_entry_attention_kind) result["AgentRegistryLiveTargetEntryKind"] = to_enum(AgentRegistryLiveTargetEntryKind, self.agent_registry_live_target_entry_kind) @@ -16832,20 +30883,25 @@ def to_dict(self) -> dict: result["AgentRegistrySpawnValidationErrorField"] = to_enum(AgentRegistrySpawnValidationErrorField, self.agent_registry_spawn_validation_error_field) result["AgentRegistrySpawnValidationErrorReason"] = to_enum(AgentRegistrySpawnValidationErrorReason, self.agent_registry_spawn_validation_error_reason) result["AgentReloadResult"] = to_class(AgentReloadResult, self.agent_reload_result) + result["AgentsDiscoverRequest"] = to_class(AgentsDiscoverRequest, self.agents_discover_request) result["AgentSelectRequest"] = to_class(AgentSelectRequest, self.agent_select_request) result["AgentSelectResult"] = to_class(AgentSelectResult, self.agent_select_result) + result["AgentSetPromptRequest"] = to_class(AgentSetPromptRequest, self.agent_set_prompt_request) + result["AgentsGetDiscoveryPathsRequest"] = to_class(AgentsGetDiscoveryPathsRequest, self.agents_get_discovery_paths_request) result["AllowAllPermissionSetResult"] = to_class(AllowAllPermissionSetResult, self.allow_all_permission_set_result) result["AllowAllPermissionState"] = to_class(AllowAllPermissionState, self.allow_all_permission_state) result["ApiKeyAuthInfo"] = to_class(APIKeyAuthInfo, self.api_key_auth_info) result["AuthInfo"] = (self.auth_info).to_dict() result["AuthInfoType"] = to_enum(AuthInfoType, self.auth_info_type) + result["BuiltInModelCatalog"] = to_class(BuiltInModelCatalog, self.built_in_model_catalog) + result["BuiltInModelCatalogEntry"] = to_class(BuiltInModelCatalogEntry, self.built_in_model_catalog_entry) + result["CancelUserRequestedShellCommandResult"] = to_class(CancelUserRequestedShellCommandResult, self.cancel_user_requested_shell_command_result) result["CanvasAction"] = to_class(CanvasAction, self.canvas_action) result["CanvasActionInvokeRequest"] = to_class(CanvasActionInvokeRequest, self.canvas_action_invoke_request) result["CanvasActionInvokeResult"] = self.canvas_action_invoke_result result["CanvasCloseRequest"] = to_class(CanvasCloseRequest, self.canvas_close_request) result["CanvasHostContext"] = to_class(CanvasHostContext, self.canvas_host_context) result["CanvasHostContextCapabilities"] = to_class(CanvasHostContextCapabilities, self.canvas_host_context_capabilities) - result["CanvasInstanceAvailability"] = to_enum(CanvasInstanceAvailability, self.canvas_instance_availability) result["CanvasJsonSchema"] = self.canvas_json_schema result["CanvasList"] = to_class(CanvasList, self.canvas_list) result["CanvasListOpenResult"] = to_class(CanvasListOpenResult, self.canvas_list_open_result) @@ -16855,20 +30911,29 @@ def to_dict(self) -> dict: result["CanvasProviderOpenRequest"] = to_class(CanvasProviderOpenRequest, self.canvas_provider_open_request) result["CanvasProviderOpenResult"] = to_class(CanvasProviderOpenResult, self.canvas_provider_open_result) result["CanvasSessionContext"] = to_class(CanvasSessionContext, self.canvas_session_context) + result["CapiSessionOptions"] = to_class(CapiSessionOptions, self.capi_session_options) result["CommandList"] = to_class(CommandList, self.command_list) result["CommandsHandlePendingCommandRequest"] = to_class(CommandsHandlePendingCommandRequest, self.commands_handle_pending_command_request) result["CommandsHandlePendingCommandResult"] = to_class(CommandsHandlePendingCommandResult, self.commands_handle_pending_command_result) result["CommandsInvokeRequest"] = to_class(CommandsInvokeRequest, self.commands_invoke_request) - result["CommandsListRequest"] = to_class(CommandsListRequest, self.commands_list_request) + result["CommandsListRequest"] = self.commands_list_request result["CommandsRespondToQueuedCommandRequest"] = to_class(CommandsRespondToQueuedCommandRequest, self.commands_respond_to_queued_command_request) result["CommandsRespondToQueuedCommandResult"] = to_class(CommandsRespondToQueuedCommandResult, self.commands_respond_to_queued_command_result) + result["CompletionsGetTriggerCharactersResult"] = to_class(CompletionsGetTriggerCharactersResult, self.completions_get_trigger_characters_result) + result["CompletionsRequestRequest"] = to_class(CompletionsRequestRequest, self.completions_request_request) + result["CompletionsRequestResult"] = to_class(CompletionsRequestResult, self.completions_request_result) + result["ConfigureSessionExtensionsParams"] = to_class(_ConfigureSessionExtensionsParams, self.configure_session_extensions_params) result["ConnectedRemoteSessionMetadata"] = to_class(ConnectedRemoteSessionMetadata, self.connected_remote_session_metadata) result["ConnectedRemoteSessionMetadataKind"] = to_enum(ConnectedRemoteSessionMetadataKind, self.connected_remote_session_metadata_kind) result["ConnectedRemoteSessionMetadataRepository"] = to_class(ConnectedRemoteSessionMetadataRepository, self.connected_remote_session_metadata_repository) result["ConnectRemoteSessionParams"] = to_class(ConnectRemoteSessionParams, self.connect_remote_session_params) result["ConnectRequest"] = to_class(_ConnectRequest, self.connect_request) result["ConnectResult"] = to_class(_ConnectResult, self.connect_result) + result["ContentExclusionCheckPathsRequest"] = to_class(ContentExclusionCheckPathsRequest, self.content_exclusion_check_paths_request) + result["ContentExclusionCheckPathsResult"] = to_class(ContentExclusionCheckPathsResult, self.content_exclusion_check_paths_result) + result["ContentExclusionPathCheck"] = to_class(ContentExclusionPathCheck, self.content_exclusion_path_check) result["ContentFilterMode"] = to_enum(ContentFilterMode, self.content_filter_mode) + result["ContextHeaviestMessage"] = to_class(ContextHeaviestMessage, self.context_heaviest_message) result["CopilotApiTokenAuthInfo"] = to_class(CopilotAPITokenAuthInfo, self.copilot_api_token_auth_info) result["CopilotUserResponse"] = to_class(CopilotUserResponse, self.copilot_user_response) result["CopilotUserResponseEndpoints"] = to_class(CopilotUserResponseEndpoints, self.copilot_user_response_endpoints) @@ -16878,7 +30943,26 @@ def to_dict(self) -> dict: result["CopilotUserResponseQuotaSnapshotsPremiumInteractions"] = to_class(CopilotUserResponseQuotaSnapshotsPremiumInteractions, self.copilot_user_response_quota_snapshots_premium_interactions) result["CurrentModel"] = to_class(CurrentModel, self.current_model) result["CurrentToolMetadata"] = to_class(CurrentToolMetadata, self.current_tool_metadata) + result["DebugCollectLogsCollectedEntry"] = to_class(DebugCollectLogsCollectedEntry, self.debug_collect_logs_collected_entry) + result["DebugCollectLogsDestination"] = to_class(DebugCollectLogsDestination, self.debug_collect_logs_destination) + result["DebugCollectLogsEntry"] = to_class(DebugCollectLogsEntry, self.debug_collect_logs_entry) + result["DebugCollectLogsEntryKind"] = to_enum(DebugCollectLogsEntryKind, self.debug_collect_logs_entry_kind) + result["DebugCollectLogsInclude"] = to_class(DebugCollectLogsInclude, self.debug_collect_logs_include) + result["DebugCollectLogsRedaction"] = to_enum(DebugCollectLogsRedaction, self.debug_collect_logs_redaction) + result["DebugCollectLogsRequest"] = to_class(DebugCollectLogsRequest, self.debug_collect_logs_request) + result["DebugCollectLogsResult"] = to_class(DebugCollectLogsResult, self.debug_collect_logs_result) + result["DebugCollectLogsResultKind"] = to_enum(DebugCollectLogsResultKind, self.debug_collect_logs_result_kind) + result["DebugCollectLogsSkippedEntry"] = to_class(DebugCollectLogsSkippedEntry, self.debug_collect_logs_skipped_entry) + result["DebugCollectLogsSource"] = to_enum(DebugCollectLogsSource, self.debug_collect_logs_source) + result["DisableBypassPermissionsMode"] = to_enum(DisableBypassPermissionsMode, self.disable_bypass_permissions_mode) result["DiscoveredCanvas"] = to_class(DiscoveredCanvas, self.discovered_canvas) + result["DiscoveredExtension"] = to_class(DiscoveredExtension, self.discovered_extension) + result["DiscoveredExtensionMode"] = to_enum(DiscoveredExtensionMode, self.discovered_extension_mode) + result["DiscoveredExtensionPlugin"] = to_class(DiscoveredExtensionPlugin, self.discovered_extension_plugin) + result["DiscoveredExtensions"] = to_class(DiscoveredExtensions, self.discovered_extensions) + result["DiscoveredExtensionsDisableRequest"] = to_class(DiscoveredExtensionsDisableRequest, self.discovered_extensions_disable_request) + result["DiscoveredExtensionsEnableRequest"] = to_class(DiscoveredExtensionsEnableRequest, self.discovered_extensions_enable_request) + result["DiscoveredExtensionSource"] = to_enum(DiscoveredExtensionSource, self.discovered_extension_source) result["DiscoveredMcpServer"] = to_class(DiscoveredMCPServer, self.discovered_mcp_server) result["DiscoveredMcpServerType"] = to_enum(DiscoveredMCPServerType, self.discovered_mcp_server_type) result["EnqueueCommandParams"] = to_class(EnqueueCommandParams, self.enqueue_command_params) @@ -16890,10 +30974,15 @@ def to_dict(self) -> dict: result["EventLogTypes"] = from_union([lambda x: from_list(from_str, x), lambda x: to_enum(EventLogTypes, x)], self.event_log_types) result["EventsAgentScope"] = to_enum(EventsAgentScope, self.events_agent_scope) result["EventsCursorStatus"] = to_enum(EventsCursorStatus, self.events_cursor_status) + result["EventsReadDirection"] = to_enum(EventsReadDirection, self.events_read_direction) result["EventsReadResult"] = to_class(EventsReadResult, self.events_read_result) result["ExecuteCommandParams"] = to_class(ExecuteCommandParams, self.execute_command_params) result["ExecuteCommandResult"] = to_class(ExecuteCommandResult, self.execute_command_result) result["Extension"] = to_class(Extension, self.extension) + result["ExtensionContextPushInput"] = to_class(ExtensionContextPushInput, self.extension_context_push_input) + result["ExtensionLaunchProfile"] = to_class(ExtensionLaunchProfile, self.extension_launch_profile) + result["ExtensionLaunchProviderResolveRequest"] = to_class(ExtensionLaunchProviderResolveRequest, self.extension_launch_provider_resolve_request) + result["ExtensionLaunchProviderResolveResult"] = to_class(ExtensionLaunchProviderResolveResult, self.extension_launch_provider_resolve_result) result["ExtensionList"] = to_class(ExtensionList, self.extension_list) result["ExtensionsDisableRequest"] = to_class(ExtensionsDisableRequest, self.extensions_disable_request) result["ExtensionsEnableRequest"] = to_class(ExtensionsEnableRequest, self.extensions_enable_request) @@ -16911,8 +31000,47 @@ def to_dict(self) -> dict: result["ExternalToolTextResultForLlmContentResourceLink"] = to_class(ExternalToolTextResultForLlmContentResourceLink, self.external_tool_text_result_for_llm_content_resource_link) result["ExternalToolTextResultForLlmContentResourceLinkIcon"] = to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, self.external_tool_text_result_for_llm_content_resource_link_icon) result["ExternalToolTextResultForLlmContentResourceLinkIconTheme"] = to_enum(Theme, self.external_tool_text_result_for_llm_content_resource_link_icon_theme) + result["ExternalToolTextResultForLlmContentShellExit"] = to_class(ExternalToolTextResultForLlmContentShellExit, self.external_tool_text_result_for_llm_content_shell_exit) result["ExternalToolTextResultForLlmContentTerminal"] = to_class(ExternalToolTextResultForLlmContentTerminal, self.external_tool_text_result_for_llm_content_terminal) result["ExternalToolTextResultForLlmContentText"] = to_class(ExternalToolTextResultForLlmContentText, self.external_tool_text_result_for_llm_content_text) + result["FactoryAbortRequest"] = to_class(FactoryAbortRequest, self.factory_abort_request) + result["FactoryAckResult"] = to_class(FactoryACKResult, self.factory_ack_result) + result["FactoryAgentOptions"] = to_class(FactoryAgentOptions, self.factory_agent_options) + result["FactoryAgentRequest"] = to_class(FactoryAgentRequest, self.factory_agent_request) + result["FactoryAgentResult"] = to_class(FactoryAgentResult, self.factory_agent_result) + result["FactoryAgentSummary"] = to_class(FactoryAgentSummary, self.factory_agent_summary) + result["FactoryCancelRequest"] = to_class(FactoryCancelRequest, self.factory_cancel_request) + result["FactoryCurrentPhase"] = to_class(FactoryCurrentPhase, self.factory_current_phase) + result["FactoryDeclaredLimits"] = to_class(FactoryDeclaredLimits, self.factory_declared_limits) + result["FactoryDurableOperation"] = to_enum(FactoryDurableOperation, self.factory_durable_operation) + result["FactoryExecuteRequest"] = to_class(FactoryExecuteRequest, self.factory_execute_request) + result["FactoryExecuteResult"] = to_class(FactoryExecuteResult, self.factory_execute_result) + result["FactoryGetRunProgressRequest"] = to_class(FactoryGetRunProgressRequest, self.factory_get_run_progress_request) + result["FactoryGetRunRequest"] = to_class(FactoryGetRunRequest, self.factory_get_run_request) + result["FactoryJournalGetRequest"] = to_class(FactoryJournalGetRequest, self.factory_journal_get_request) + result["FactoryJournalGetResult"] = to_class(FactoryJournalGetResult, self.factory_journal_get_result) + result["FactoryJournalPutRequest"] = to_class(FactoryJournalPutRequest, self.factory_journal_put_request) + result["FactoryListRunsRequest"] = to_class(FactoryListRunsRequest, self.factory_list_runs_request) + result["FactoryListRunsResult"] = to_class(FactoryListRunsResult, self.factory_list_runs_result) + result["FactoryLogLine"] = to_class(FactoryLogLine, self.factory_log_line) + result["FactoryLogLineKind"] = to_enum(FactoryLogLineKind, self.factory_log_line_kind) + result["FactoryLogRequest"] = to_class(FactoryLogRequest, self.factory_log_request) + result["FactoryPhaseObservation"] = to_class(FactoryPhaseObservation, self.factory_phase_observation) + result["FactoryPhaseStatus"] = to_enum(FactoryPhaseStatus, self.factory_phase_status) + result["FactoryProgressLine"] = to_class(FactoryProgressLine, self.factory_progress_line) + result["FactoryProgressPage"] = to_class(FactoryProgressPage, self.factory_progress_page) + result["FactoryResumeRequest"] = to_class(FactoryResumeRequest, self.factory_resume_request) + result["FactoryResumeResult"] = to_class(FactoryResumeResult, self.factory_resume_result) + result["FactoryRunConsumed"] = to_class(FactoryRunConsumed, self.factory_run_consumed) + result["FactoryRunDetail"] = to_class(FactoryRunDetail, self.factory_run_detail) + result["FactoryRunFailure"] = to_class(FactoryRunFailure, self.factory_run_failure) + result["FactoryRunFailureKind"] = to_enum(FactoryRunFailureKind, self.factory_run_failure_kind) + result["FactoryRunLimits"] = to_class(FactoryRunLimits, self.factory_run_limits) + result["FactoryRunRequest"] = to_class(FactoryRunRequest, self.factory_run_request) + result["FactoryRunResult"] = to_class(FactoryRunResult, self.factory_run_result) + result["FactoryRunStatus"] = to_enum(FactoryRunStatus, self.factory_run_status) + result["FactoryRunSummary"] = to_class(FactoryRunSummary, self.factory_run_summary) + result["FactoryRunTerminal"] = to_class(FactoryRunTerminal, self.factory_run_terminal) result["FilterMapping"] = from_union([lambda x: from_dict(lambda x: to_enum(ContentFilterMode, x), x), lambda x: to_enum(ContentFilterMode, x)], self.filter_mapping) result["FleetStartRequest"] = to_class(FleetStartRequest, self.fleet_start_request) result["FleetStartResult"] = to_class(FleetStartResult, self.fleet_start_result) @@ -16920,29 +31048,82 @@ def to_dict(self) -> dict: result["FolderTrustCheckParams"] = to_class(FolderTrustCheckParams, self.folder_trust_check_params) result["FolderTrustCheckResult"] = to_class(FolderTrustCheckResult, self.folder_trust_check_result) result["GhCliAuthInfo"] = to_class(GhCLIAuthInfo, self.gh_cli_auth_info) + result["GitHubTelemetryClientInfo"] = to_class(GitHubTelemetryClientInfo, self.git_hub_telemetry_client_info) + result["GitHubTelemetryEvent"] = to_class(GitHubTelemetryEvent, self.git_hub_telemetry_event) + result["GitHubTelemetryNotification"] = to_class(GitHubTelemetryNotification, self.git_hub_telemetry_notification) result["HandlePendingToolCallRequest"] = to_class(HandlePendingToolCallRequest, self.handle_pending_tool_call_request) result["HandlePendingToolCallResult"] = to_class(HandlePendingToolCallResult, self.handle_pending_tool_call_result) result["HistoryAbortManualCompactionResult"] = to_class(HistoryAbortManualCompactionResult, self.history_abort_manual_compaction_result) result["HistoryCancelBackgroundCompactionResult"] = to_class(HistoryCancelBackgroundCompactionResult, self.history_cancel_background_compaction_result) + result["HistoryClearContextRequest"] = to_class(HistoryClearContextRequest, self.history_clear_context_request) + result["HistoryClearContextResult"] = to_class(HistoryClearContextResult, self.history_clear_context_result) result["HistoryCompactContextWindow"] = to_class(HistoryCompactContextWindow, self.history_compact_context_window) - result["HistoryCompactRequest"] = to_class(HistoryCompactRequest, self.history_compact_request) + result["HistoryCompactRequest"] = self.history_compact_request result["HistoryCompactResult"] = to_class(HistoryCompactResult, self.history_compact_result) + result["HistoryFileRestoreSkipReason"] = to_enum(HistoryFileRestoreSkipReason, self.history_file_restore_skip_reason) + result["HistoryListRewindPointsResult"] = to_class(HistoryListRewindPointsResult, self.history_list_rewind_points_result) + result["HistoryPreviewRewindRequest"] = to_class(HistoryPreviewRewindRequest, self.history_preview_rewind_request) + result["HistoryPreviewRewindResult"] = to_class(HistoryPreviewRewindResult, self.history_preview_rewind_result) + result["HistoryRewindChangeType"] = to_enum(HistoryRewindChangeType, self.history_rewind_change_type) + result["HistoryRewindFilePreview"] = to_class(HistoryRewindFilePreview, self.history_rewind_file_preview) + result["HistoryRewindMode"] = to_enum(HistoryRewindMode, self.history_rewind_mode) + result["HistoryRewindOutcome"] = to_enum(HistoryRewindOutcome, self.history_rewind_outcome) + result["HistoryRewindPoint"] = to_class(HistoryRewindPoint, self.history_rewind_point) + result["HistoryRewindRequest"] = to_class(HistoryRewindRequest, self.history_rewind_request) + result["HistoryRewindResult"] = to_class(HistoryRewindResult, self.history_rewind_result) + result["HistoryRewindUnavailableReason"] = to_enum(HistoryRewindUnavailableReason, self.history_rewind_unavailable_reason) + result["HistorySkippedFileRestore"] = to_class(HistorySkippedFileRestore, self.history_skipped_file_restore) result["HistorySummarizeForHandoffResult"] = to_class(HistorySummarizeForHandoffResult, self.history_summarize_for_handoff_result) result["HistoryTruncateRequest"] = to_class(HistoryTruncateRequest, self.history_truncate_request) result["HistoryTruncateResult"] = to_class(HistoryTruncateResult, self.history_truncate_result) result["HMACAuthInfo"] = to_class(HMACAuthInfo, self.hmac_auth_info) + result["HookInvokeRequest"] = to_class(_HookInvokeRequest, self.hook_invoke_request) + result["HookInvokeResponse"] = to_class(_HookInvokeResponse, self.hook_invoke_response) + result["HookType"] = to_enum(_HookType, self.hook_type) result["InstalledPlugin"] = to_class(InstalledPlugin, self.installed_plugin) + result["InstalledPluginInfo"] = to_class(InstalledPluginInfo, self.installed_plugin_info) result["InstalledPluginSource"] = from_union([lambda x: to_class(InstalledPluginSource, x), from_str], self.installed_plugin_source) - result["InstalledPluginSourceGithub"] = to_class(InstalledPluginSourceGithub, self.installed_plugin_source_github) + result["InstalledPluginSourceGitHub"] = to_class(InstalledPluginSourceGitHub, self.installed_plugin_source_git_hub) result["InstalledPluginSourceLocal"] = to_class(InstalledPluginSourceLocal, self.installed_plugin_source_local) result["InstalledPluginSourceUrl"] = to_class(InstalledPluginSourceURL, self.installed_plugin_source_url) + result["InstructionDiscoveryPath"] = to_class(InstructionDiscoveryPath, self.instruction_discovery_path) + result["InstructionDiscoveryPathKind"] = to_enum(DebugCollectLogsEntryKind, self.instruction_discovery_path_kind) + result["InstructionDiscoveryPathList"] = to_class(InstructionDiscoveryPathList, self.instruction_discovery_path_list) + result["InstructionDiscoveryPathLocation"] = to_enum(InstructionLocation, self.instruction_discovery_path_location) + result["InstructionsDiscoverRequest"] = to_class(InstructionsDiscoverRequest, self.instructions_discover_request) + result["InstructionsGetDiscoveryPathsRequest"] = to_class(InstructionsGetDiscoveryPathsRequest, self.instructions_get_discovery_paths_request) result["InstructionsGetSourcesResult"] = to_class(InstructionsGetSourcesResult, self.instructions_get_sources_result) - result["InstructionsSources"] = to_class(InstructionsSources, self.instructions_sources) - result["InstructionsSourcesLocation"] = to_enum(InstructionsSourcesLocation, self.instructions_sources_location) - result["InstructionsSourcesType"] = to_enum(InstructionsSourcesType, self.instructions_sources_type) + result["InstructionSource"] = to_class(InstructionSource, self.instruction_source) + result["InstructionSourceLocation"] = to_enum(InstructionLocation, self.instruction_source_location) + result["InstructionSourceType"] = to_enum(InstructionSourceType, self.instruction_source_type) + result["InterruptMainTurnRequest"] = to_class(InterruptMainTurnRequest, self.interrupt_main_turn_request) + result["InterruptMainTurnResult"] = to_class(InterruptMainTurnResult, self.interrupt_main_turn_result) + result["LlmInferenceHeaders"] = from_dict(lambda x: from_list(from_str, x), self.llm_inference_headers) + result["LlmInferenceHttpRequestChunkRequest"] = to_class(LlmInferenceHTTPRequestChunkRequest, self.llm_inference_http_request_chunk_request) + result["LlmInferenceHttpRequestChunkResult"] = to_class(LlmInferenceHTTPRequestChunkResult, self.llm_inference_http_request_chunk_result) + result["LlmInferenceHttpRequestStartRequest"] = to_class(LlmInferenceHTTPRequestStartRequest, self.llm_inference_http_request_start_request) + result["LlmInferenceHttpRequestStartResult"] = to_class(LlmInferenceHTTPRequestStartResult, self.llm_inference_http_request_start_result) + result["LlmInferenceHttpRequestStartTransport"] = to_enum(LlmInferenceHTTPRequestStartTransport, self.llm_inference_http_request_start_transport) + result["LlmInferenceHttpResponseChunkError"] = to_class(LlmInferenceHTTPResponseChunkError, self.llm_inference_http_response_chunk_error) + result["LlmInferenceHttpResponseChunkRequest"] = to_class(LlmInferenceHTTPResponseChunkRequest, self.llm_inference_http_response_chunk_request) + result["LlmInferenceHttpResponseChunkResult"] = to_class(LlmInferenceHTTPResponseChunkResult, self.llm_inference_http_response_chunk_result) + result["LlmInferenceHttpResponseStartRequest"] = to_class(LlmInferenceHTTPResponseStartRequest, self.llm_inference_http_response_start_request) + result["LlmInferenceHttpResponseStartResult"] = to_class(LlmInferenceHTTPResponseStartResult, self.llm_inference_http_response_start_result) + result["LlmInferenceSetProviderResult"] = to_class(LlmInferenceSetProviderResult, self.llm_inference_set_provider_result) + result["LocalSessionMetadataValue"] = to_class(LocalSessionMetadataValue, self.local_session_metadata_value) result["LogRequest"] = to_class(LogRequest, self.log_request) result["LogResult"] = to_class(LogResult, self.log_result) result["LspInitializeRequest"] = to_class(LspInitializeRequest, self.lsp_initialize_request) + result["ManagedSettingsReadResult"] = to_class(ManagedSettingsReadResult, self.managed_settings_read_result) + result["MarketplaceAddResult"] = to_class(MarketplaceAddResult, self.marketplace_add_result) + result["MarketplaceBrowseResult"] = to_class(MarketplaceBrowseResult, self.marketplace_browse_result) + result["MarketplaceInfo"] = to_class(MarketplaceInfo, self.marketplace_info) + result["MarketplaceListResult"] = to_class(MarketplaceListResult, self.marketplace_list_result) + result["MarketplacePluginInfo"] = to_class(MarketplacePluginInfo, self.marketplace_plugin_info) + result["MarketplaceRefreshEntry"] = to_class(MarketplaceRefreshEntry, self.marketplace_refresh_entry) + result["MarketplaceRefreshResult"] = to_class(MarketplaceRefreshResult, self.marketplace_refresh_result) + result["MarketplaceRemoveResult"] = to_class(MarketplaceRemoveResult, self.marketplace_remove_result) + result["McpAllowedServer"] = to_class(MCPAllowedServer, self.mcp_allowed_server) result["McpAppsCallToolRequest"] = to_class(MCPAppsCallToolRequest, self.mcp_apps_call_tool_request) result["McpAppsDiagnoseCapability"] = to_class(MCPAppsDiagnoseCapability, self.mcp_apps_diagnose_capability) result["McpAppsDiagnoseRequest"] = to_class(MCPAppsDiagnoseRequest, self.mcp_apps_diagnose_request) @@ -16973,6 +31154,8 @@ def to_dict(self) -> dict: result["McpConfigList"] = to_class(MCPConfigList, self.mcp_config_list) result["McpConfigRemoveRequest"] = to_class(MCPConfigRemoveRequest, self.mcp_config_remove_request) result["McpConfigUpdateRequest"] = to_class(MCPConfigUpdateRequest, self.mcp_config_update_request) + result["McpConfigureGitHubRequest"] = to_class(MCPConfigureGitHubRequest, self.mcp_configure_git_hub_request) + result["McpConfigureGitHubResult"] = to_class(MCPConfigureGitHubResult, self.mcp_configure_git_hub_result) result["McpDisableRequest"] = to_class(MCPDisableRequest, self.mcp_disable_request) result["McpDiscoverRequest"] = to_class(MCPDiscoverRequest, self.mcp_discover_request) result["McpDiscoverResult"] = to_class(MCPDiscoverResult, self.mcp_discover_result) @@ -16980,23 +31163,67 @@ def to_dict(self) -> dict: result["McpExecuteSamplingParams"] = to_class(MCPExecuteSamplingParams, self.mcp_execute_sampling_params) result["McpExecuteSamplingRequest"] = from_dict(lambda x: x, self.mcp_execute_sampling_request) result["McpExecuteSamplingResult"] = from_dict(lambda x: x, self.mcp_execute_sampling_result) + result["McpFilteredServer"] = to_class(MCPFilteredServer, self.mcp_filtered_server) + result["McpHeadersHandlePendingHeadersRefreshRequest"] = to_class(MCPHeadersHandlePendingHeadersRefreshRequest, self.mcp_headers_handle_pending_headers_refresh_request) + result["McpHeadersHandlePendingHeadersRefreshRequestRequest"] = to_class(MCPHeadersHandlePendingHeadersRefreshRequestRequest, self.mcp_headers_handle_pending_headers_refresh_request_request) + result["McpHeadersHandlePendingHeadersRefreshRequestResult"] = to_class(MCPHeadersHandlePendingHeadersRefreshRequestResult, self.mcp_headers_handle_pending_headers_refresh_request_result) + result["McpHostState"] = to_class(MCPHostState, self.mcp_host_state) + result["McpIsServerRunningRequest"] = to_class(MCPIsServerRunningRequest, self.mcp_is_server_running_request) + result["McpIsServerRunningResult"] = to_class(MCPIsServerRunningResult, self.mcp_is_server_running_result) + result["McpListToolsRequest"] = to_class(MCPListToolsRequest, self.mcp_list_tools_request) + result["McpListToolsResult"] = to_class(MCPListToolsResult, self.mcp_list_tools_result) + result["McpOauthAuthenticationStateChangedRequest"] = to_class(MCPOauthAuthenticationStateChangedRequest, self.mcp_oauth_authentication_state_changed_request) + result["McpOauthHandlePendingRequest"] = to_class(MCPOauthHandlePendingRequest, self.mcp_oauth_handle_pending_request) + result["McpOauthHandlePendingResult"] = to_class(MCPOauthHandlePendingResult, self.mcp_oauth_handle_pending_result) + result["McpOauthLoginGrantType"] = to_enum(MCPGrantType, self.mcp_oauth_login_grant_type) result["McpOauthLoginRequest"] = to_class(MCPOauthLoginRequest, self.mcp_oauth_login_request) result["McpOauthLoginResult"] = to_class(MCPOauthLoginResult, self.mcp_oauth_login_result) + result["McpOauthPendingRequestResponse"] = to_class(MCPOauthPendingRequestResponse, self.mcp_oauth_pending_request_response) + result["McpOauthRespondRequest"] = to_class(MCPOauthRespondRequest, self.mcp_oauth_respond_request) + result["McpOauthRespondResult"] = to_class(MCPOauthRespondResult, self.mcp_oauth_respond_result) + result["McpRegisterExternalClientRequest"] = to_class(MCPRegisterExternalClientRequest, self.mcp_register_external_client_request) + result["McpReloadWithConfigRequest"] = to_class(MCPReloadWithConfigRequest, self.mcp_reload_with_config_request) result["McpRemoveGitHubResult"] = to_class(MCPRemoveGitHubResult, self.mcp_remove_git_hub_result) + result["McpResource"] = to_class(MCPResource, self.mcp_resource) + result["McpResourceAnnotations"] = to_class(MCPResourceAnnotations, self.mcp_resource_annotations) + result["McpResourceContent"] = to_class(MCPResourceContent, self.mcp_resource_content) + result["McpResourceIcon"] = to_class(MCPResourceIcon, self.mcp_resource_icon) + result["McpResourcesListRequest"] = to_class(MCPResourcesListRequest, self.mcp_resources_list_request) + result["McpResourcesListResult"] = to_class(MCPResourcesListResult, self.mcp_resources_list_result) + result["McpResourcesListTemplatesRequest"] = to_class(MCPResourcesListTemplatesRequest, self.mcp_resources_list_templates_request) + result["McpResourcesListTemplatesResult"] = to_class(MCPResourcesListTemplatesResult, self.mcp_resources_list_templates_result) + result["McpResourcesReadRequest"] = to_class(MCPResourcesReadRequest, self.mcp_resources_read_request) + result["McpResourcesReadResult"] = to_class(MCPResourcesReadResult, self.mcp_resources_read_result) + result["McpResourceTemplate"] = to_class(MCPResourceTemplate, self.mcp_resource_template) + result["McpRestartServerRequest"] = to_class(MCPRestartServerRequest, self.mcp_restart_server_request) result["McpSamplingExecutionAction"] = to_enum(MCPSamplingExecutionAction, self.mcp_sampling_execution_action) result["McpSamplingExecutionResult"] = to_class(MCPSamplingExecutionResult, self.mcp_sampling_execution_result) result["McpServer"] = to_class(MCPServer, self.mcp_server) result["McpServerAuthConfig"] = from_union([from_bool, lambda x: to_class(MCPServerAuthConfigRedirectPort, x)], self.mcp_server_auth_config) result["McpServerAuthConfigRedirectPort"] = to_class(MCPServerAuthConfigRedirectPort, self.mcp_server_auth_config_redirect_port) result["McpServerConfig"] = to_class(MCPServerConfig, self.mcp_server_config) + result["McpServerConfigDeferTools"] = to_enum(MCPServerConfigDeferTools, self.mcp_server_config_defer_tools) result["McpServerConfigHttp"] = to_class(MCPServerConfigHTTP, self.mcp_server_config_http) - result["McpServerConfigHttpOauthGrantType"] = to_enum(MCPServerConfigHTTPOauthGrantType, self.mcp_server_config_http_oauth_grant_type) + result["McpServerConfigHttpOauthGrantType"] = to_enum(MCPGrantType, self.mcp_server_config_http_oauth_grant_type) result["McpServerConfigHttpType"] = to_enum(MCPServerConfigHTTPType, self.mcp_server_config_http_type) result["McpServerConfigStdio"] = to_class(MCPServerConfigStdio, self.mcp_server_config_stdio) + result["McpServerFailureInfo"] = to_class(MCPServerFailureInfo, self.mcp_server_failure_info) result["McpServerList"] = to_class(MCPServerList, self.mcp_server_list) + result["McpServerNeedsAuthInfo"] = to_class(MCPServerNeedsAuthInfo, self.mcp_server_needs_auth_info) result["McpSetEnvValueModeDetails"] = to_enum(MCPSetEnvValueModeDetails, self.mcp_set_env_value_mode_details) result["McpSetEnvValueModeParams"] = to_class(MCPSetEnvValueModeParams, self.mcp_set_env_value_mode_params) result["McpSetEnvValueModeResult"] = to_class(MCPSetEnvValueModeResult, self.mcp_set_env_value_mode_result) + result["McpStartServerRequest"] = to_class(MCPStartServerRequest, self.mcp_start_server_request) + result["McpStartServersResult"] = to_class(MCPStartServersResult, self.mcp_start_servers_result) + result["McpStopServerRequest"] = to_class(MCPStopServerRequest, self.mcp_stop_server_request) + result["McpTools"] = to_class(MCPTools, self.mcp_tools) + result["McpToolUi"] = to_class(MCPToolUI, self.mcp_tool_ui) + result["McpToolUiVisibility"] = to_enum(MCPToolUIVisibility, self.mcp_tool_ui_visibility) + result["McpUnregisterExternalClientRequest"] = to_class(MCPUnregisterExternalClientRequest, self.mcp_unregister_external_client_request) + result["MemoryConfiguration"] = to_class(MemoryConfiguration, self.memory_configuration) + result["MetadataContextAttributionResult"] = to_class(MetadataContextAttributionResult, self.metadata_context_attribution_result) + result["MetadataContextHeaviestMessagesRequest"] = to_class(MetadataContextHeaviestMessagesRequest, self.metadata_context_heaviest_messages_request) + result["MetadataContextHeaviestMessagesResult"] = to_class(MetadataContextHeaviestMessagesResult, self.metadata_context_heaviest_messages_result) result["MetadataContextInfoRequest"] = to_class(MetadataContextInfoRequest, self.metadata_context_info_request) result["MetadataContextInfoResult"] = to_class(MetadataContextInfoResult, self.metadata_context_info_result) result["MetadataIsProcessingResult"] = to_class(MetadataIsProcessingResult, self.metadata_is_processing_result) @@ -17009,9 +31236,10 @@ def to_dict(self) -> dict: result["MetadataSnapshotCurrentMode"] = to_enum(MetadataSnapshotCurrentMode, self.metadata_snapshot_current_mode) result["MetadataSnapshotRemoteMetadata"] = to_class(MetadataSnapshotRemoteMetadata, self.metadata_snapshot_remote_metadata) result["MetadataSnapshotRemoteMetadataRepository"] = to_class(MetadataSnapshotRemoteMetadataRepository, self.metadata_snapshot_remote_metadata_repository) - result["MetadataSnapshotRemoteMetadataTaskType"] = to_enum(MetadataSnapshotRemoteMetadataTaskType, self.metadata_snapshot_remote_metadata_task_type) + result["MetadataSnapshotRemoteMetadataTaskType"] = to_enum(TaskType, self.metadata_snapshot_remote_metadata_task_type) result["Model"] = to_class(Model, self.model) result["ModelBilling"] = to_class(ModelBilling, self.model_billing) + result["ModelBillingPromo"] = to_class(ModelBillingPromo, self.model_billing_promo) result["ModelBillingTokenPrices"] = to_class(ModelBillingTokenPrices, self.model_billing_token_prices) result["ModelBillingTokenPricesLongContext"] = to_class(ModelBillingTokenPricesLongContext, self.model_billing_token_prices_long_context) result["ModelCapabilities"] = to_class(ModelCapabilities, self.model_capabilities) @@ -17022,9 +31250,8 @@ def to_dict(self) -> dict: result["ModelCapabilitiesOverrideLimitsVision"] = to_class(ModelCapabilitiesOverrideLimitsVision, self.model_capabilities_override_limits_vision) result["ModelCapabilitiesOverrideSupports"] = to_class(ModelCapabilitiesOverrideSupports, self.model_capabilities_override_supports) result["ModelCapabilitiesSupports"] = to_class(ModelCapabilitiesSupports, self.model_capabilities_supports) - result["ModelCurrentContextTier"] = to_enum(ModelCurrentContextTier, self.model_current_context_tier) result["ModelList"] = to_class(ModelList, self.model_list) - result["ModelListRequest"] = to_class(ModelListRequest, self.model_list_request) + result["ModelListRequest"] = self.model_list_request result["ModelPickerCategory"] = to_enum(ModelPickerCategory, self.model_picker_category) result["ModelPickerPriceCategory"] = to_enum(ModelPickerPriceCategory, self.model_picker_price_category) result["ModelPolicy"] = to_class(ModelPolicy, self.model_policy) @@ -17035,12 +31262,19 @@ def to_dict(self) -> dict: result["ModelSwitchToRequest"] = to_class(ModelSwitchToRequest, self.model_switch_to_request) result["ModelSwitchToResult"] = to_class(ModelSwitchToResult, self.model_switch_to_result) result["ModeSetRequest"] = to_class(ModeSetRequest, self.mode_set_request) + result["NamedProviderConfig"] = to_class(NamedProviderConfig, self.named_provider_config) result["NameGetResult"] = to_class(NameGetResult, self.name_get_result) result["NameSetAutoRequest"] = to_class(NameSetAutoRequest, self.name_set_auto_request) result["NameSetAutoResult"] = to_class(NameSetAutoResult, self.name_set_auto_result) result["NameSetRequest"] = to_class(NameSetRequest, self.name_set_request) result["OpenCanvasInstance"] = to_class(OpenCanvasInstance, self.open_canvas_instance) + result["OptionsUpdateAdditionalContentExclusionPolicy"] = to_class(OptionsUpdateAdditionalContentExclusionPolicy, self.options_update_additional_content_exclusion_policy) + result["OptionsUpdateAdditionalContentExclusionPolicyRule"] = to_class(OptionsUpdateAdditionalContentExclusionPolicyRule, self.options_update_additional_content_exclusion_policy_rule) + result["OptionsUpdateAdditionalContentExclusionPolicyRuleSource"] = to_class(OptionsUpdateAdditionalContentExclusionPolicyRuleSource, self.options_update_additional_content_exclusion_policy_rule_source) + result["OptionsUpdateAdditionalContentExclusionPolicyScope"] = to_enum(AdditionalContentExclusionPolicyScope, self.options_update_additional_content_exclusion_policy_scope) + result["OptionsUpdateContextTier"] = to_enum(OptionsUpdateContextTier, self.options_update_context_tier) result["OptionsUpdateEnvValueMode"] = to_enum(MCPSetEnvValueModeDetails, self.options_update_env_value_mode) + result["OptionsUpdateReasoningSummary"] = to_enum(ReasoningSummary, self.options_update_reasoning_summary) result["OptionsUpdateToolFilterPrecedence"] = to_enum(OptionsUpdateToolFilterPrecedence, self.options_update_tool_filter_precedence) result["PendingPermissionRequest"] = to_class(PendingPermissionRequest, self.pending_permission_request) result["PendingPermissionRequestList"] = to_class(PendingPermissionRequestList, self.pending_permission_request_list) @@ -17054,6 +31288,7 @@ def to_dict(self) -> dict: result["PermissionDecisionApproveForLocationApprovalCustomTool"] = to_class(PermissionDecisionApproveForLocationApprovalCustomTool, self.permission_decision_approve_for_location_approval_custom_tool) result["PermissionDecisionApproveForLocationApprovalExtensionManagement"] = to_class(PermissionDecisionApproveForLocationApprovalExtensionManagement, self.permission_decision_approve_for_location_approval_extension_management) result["PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess"] = to_class(PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess, self.permission_decision_approve_for_location_approval_extension_permission_access) + result["PermissionDecisionApproveForLocationApprovalFactory"] = to_class(PermissionDecisionApproveForLocationApprovalFactory, self.permission_decision_approve_for_location_approval_factory) result["PermissionDecisionApproveForLocationApprovalMcp"] = to_class(PermissionDecisionApproveForLocationApprovalMCP, self.permission_decision_approve_for_location_approval_mcp) result["PermissionDecisionApproveForLocationApprovalMcpSampling"] = to_class(PermissionDecisionApproveForLocationApprovalMCPSampling, self.permission_decision_approve_for_location_approval_mcp_sampling) result["PermissionDecisionApproveForLocationApprovalMemory"] = to_class(PermissionDecisionApproveForLocationApprovalMemory, self.permission_decision_approve_for_location_approval_memory) @@ -17065,6 +31300,7 @@ def to_dict(self) -> dict: result["PermissionDecisionApproveForSessionApprovalCustomTool"] = to_class(PermissionDecisionApproveForSessionApprovalCustomTool, self.permission_decision_approve_for_session_approval_custom_tool) result["PermissionDecisionApproveForSessionApprovalExtensionManagement"] = to_class(PermissionDecisionApproveForSessionApprovalExtensionManagement, self.permission_decision_approve_for_session_approval_extension_management) result["PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess"] = to_class(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess, self.permission_decision_approve_for_session_approval_extension_permission_access) + result["PermissionDecisionApproveForSessionApprovalFactory"] = to_class(PermissionDecisionApproveForSessionApprovalFactory, self.permission_decision_approve_for_session_approval_factory) result["PermissionDecisionApproveForSessionApprovalMcp"] = to_class(PermissionDecisionApproveForSessionApprovalMCP, self.permission_decision_approve_for_session_approval_mcp) result["PermissionDecisionApproveForSessionApprovalMcpSampling"] = to_class(PermissionDecisionApproveForSessionApprovalMCPSampling, self.permission_decision_approve_for_session_approval_mcp_sampling) result["PermissionDecisionApproveForSessionApprovalMemory"] = to_class(PermissionDecisionApproveForSessionApprovalMemory, self.permission_decision_approve_for_session_approval_memory) @@ -17073,13 +31309,17 @@ def to_dict(self) -> dict: result["PermissionDecisionApproveOnce"] = to_class(PermissionDecisionApproveOnce, self.permission_decision_approve_once) result["PermissionDecisionApprovePermanently"] = to_class(PermissionDecisionApprovePermanently, self.permission_decision_approve_permanently) result["PermissionDecisionCancelled"] = to_class(PermissionDecisionCancelled, self.permission_decision_cancelled) + result["PermissionDecisionContext"] = to_class(PermissionDecisionContext, self.permission_decision_context) result["PermissionDecisionDeniedByContentExclusionPolicy"] = to_class(PermissionDecisionDeniedByContentExclusionPolicy, self.permission_decision_denied_by_content_exclusion_policy) result["PermissionDecisionDeniedByPermissionRequestHook"] = to_class(PermissionDecisionDeniedByPermissionRequestHook, self.permission_decision_denied_by_permission_request_hook) result["PermissionDecisionDeniedByRules"] = to_class(PermissionDecisionDeniedByRules, self.permission_decision_denied_by_rules) result["PermissionDecisionDeniedInteractivelyByUser"] = to_class(PermissionDecisionDeniedInteractivelyByUser, self.permission_decision_denied_interactively_by_user) result["PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser"] = to_class(PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser, self.permission_decision_denied_no_approval_rule_and_could_not_request_from_user) + result["PermissionDecisionOutcome"] = to_enum(PermissionDecisionOutcome, self.permission_decision_outcome) result["PermissionDecisionReject"] = to_class(PermissionDecisionReject, self.permission_decision_reject) result["PermissionDecisionRequest"] = to_class(PermissionDecisionRequest, self.permission_decision_request) + result["PermissionDecisionSource"] = to_enum(PermissionDecisionSource, self.permission_decision_source) + result["PermissionDecisionSurface"] = to_enum(PermissionDecisionSurface, self.permission_decision_surface) result["PermissionDecisionUserNotAvailable"] = to_class(PermissionDecisionUserNotAvailable, self.permission_decision_user_not_available) result["PermissionLocationAddToolApprovalParams"] = to_class(PermissionLocationAddToolApprovalParams, self.permission_location_add_tool_approval_params) result["PermissionLocationApplyParams"] = to_class(PermissionLocationApplyParams, self.permission_location_apply_params) @@ -17098,10 +31338,11 @@ def to_dict(self) -> dict: result["PermissionPromptShownNotification"] = to_class(PermissionPromptShownNotification, self.permission_prompt_shown_notification) result["PermissionRequestResult"] = to_class(PermissionRequestResult, self.permission_request_result) result["PermissionRulesSet"] = to_class(PermissionRulesSet, self.permission_rules_set) + result["PermissionsAllowAllMode"] = to_enum(PermissionsAllowAllMode, self.permissions_allow_all_mode) result["PermissionsConfigureAdditionalContentExclusionPolicy"] = to_class(PermissionsConfigureAdditionalContentExclusionPolicy, self.permissions_configure_additional_content_exclusion_policy) result["PermissionsConfigureAdditionalContentExclusionPolicyRule"] = to_class(PermissionsConfigureAdditionalContentExclusionPolicyRule, self.permissions_configure_additional_content_exclusion_policy_rule) result["PermissionsConfigureAdditionalContentExclusionPolicyRuleSource"] = to_class(PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, self.permissions_configure_additional_content_exclusion_policy_rule_source) - result["PermissionsConfigureAdditionalContentExclusionPolicyScope"] = to_enum(PermissionsConfigureAdditionalContentExclusionPolicyScope, self.permissions_configure_additional_content_exclusion_policy_scope) + result["PermissionsConfigureAdditionalContentExclusionPolicyScope"] = to_enum(AdditionalContentExclusionPolicyScope, self.permissions_configure_additional_content_exclusion_policy_scope) result["PermissionsConfigureParams"] = to_class(PermissionsConfigureParams, self.permissions_configure_params) result["PermissionsConfigureResult"] = to_class(PermissionsConfigureResult, self.permissions_configure_result) result["PermissionsFolderTrustAddTrustedResult"] = to_class(PermissionsFolderTrustAddTrustedResult, self.permissions_folder_trust_add_trusted_result) @@ -17111,6 +31352,7 @@ def to_dict(self) -> dict: result["PermissionsLocationsAddToolApprovalDetailsCustomTool"] = to_class(PermissionsLocationsAddToolApprovalDetailsCustomTool, self.permissions_locations_add_tool_approval_details_custom_tool) result["PermissionsLocationsAddToolApprovalDetailsExtensionManagement"] = to_class(PermissionsLocationsAddToolApprovalDetailsExtensionManagement, self.permissions_locations_add_tool_approval_details_extension_management) result["PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess"] = to_class(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess, self.permissions_locations_add_tool_approval_details_extension_permission_access) + result["PermissionsLocationsAddToolApprovalDetailsFactory"] = to_class(PermissionsLocationsAddToolApprovalDetailsFactory, self.permissions_locations_add_tool_approval_details_factory) result["PermissionsLocationsAddToolApprovalDetailsMcp"] = to_class(PermissionsLocationsAddToolApprovalDetailsMCP, self.permissions_locations_add_tool_approval_details_mcp) result["PermissionsLocationsAddToolApprovalDetailsMcpSampling"] = to_class(PermissionsLocationsAddToolApprovalDetailsMCPSampling, self.permissions_locations_add_tool_approval_details_mcp_sampling) result["PermissionsLocationsAddToolApprovalDetailsMemory"] = to_class(PermissionsLocationsAddToolApprovalDetailsMemory, self.permissions_locations_add_tool_approval_details_memory) @@ -17140,50 +31382,166 @@ def to_dict(self) -> dict: result["PingRequest"] = to_class(PingRequest, self.ping_request) result["PingResult"] = to_class(PingResult, self.ping_result) result["PlanReadResult"] = to_class(PlanReadResult, self.plan_read_result) + result["PlanReadSqlTodosResult"] = to_class(PlanReadSQLTodosResult, self.plan_read_sql_todos_result) + result["PlanReadSqlTodosWithDependenciesResult"] = to_class(PlanReadSQLTodosWithDependenciesResult, self.plan_read_sql_todos_with_dependencies_result) + result["PlanSqlTodoDependency"] = to_class(PlanSQLTodoDependency, self.plan_sql_todo_dependency) + result["PlanSqlTodosRow"] = to_class(PlanSQLTodosRow, self.plan_sql_todos_row) result["PlanUpdateRequest"] = to_class(PlanUpdateRequest, self.plan_update_request) result["Plugin"] = to_class(Plugin, self.plugin) + result["PluginInstallResult"] = to_class(PluginInstallResult, self.plugin_install_result) result["PluginList"] = to_class(PluginList, self.plugin_list) + result["PluginListResult"] = to_class(PluginListResult, self.plugin_list_result) + result["PluginsDisableRequest"] = to_class(PluginsDisableRequest, self.plugins_disable_request) + result["PluginsEnableRequest"] = to_class(PluginsEnableRequest, self.plugins_enable_request) + result["PluginsInstallRequest"] = to_class(PluginsInstallRequest, self.plugins_install_request) + result["PluginsMarketplacesAddRequest"] = to_class(PluginsMarketplacesAddRequest, self.plugins_marketplaces_add_request) + result["PluginsMarketplacesBrowseRequest"] = to_class(PluginsMarketplacesBrowseRequest, self.plugins_marketplaces_browse_request) + result["PluginsMarketplacesRefreshRequest"] = to_class(PluginsMarketplacesRefreshRequest, self.plugins_marketplaces_refresh_request) + result["PluginsMarketplacesRemoveRequest"] = to_class(PluginsMarketplacesRemoveRequest, self.plugins_marketplaces_remove_request) + result["PluginsReloadRequest"] = self.plugins_reload_request + result["PluginsUninstallRequest"] = to_class(PluginsUninstallRequest, self.plugins_uninstall_request) + result["PluginsUpdateRequest"] = to_class(PluginsUpdateRequest, self.plugins_update_request) + result["PluginUpdateAllEntry"] = to_class(PluginUpdateAllEntry, self.plugin_update_all_entry) + result["PluginUpdateAllResult"] = to_class(PluginUpdateAllResult, self.plugin_update_all_result) + result["PluginUpdateResult"] = to_class(PluginUpdateResult, self.plugin_update_result) + result["ProviderAddRequest"] = to_class(ProviderAddRequest, self.provider_add_request) + result["ProviderAddResult"] = to_class(ProviderAddResult, self.provider_add_result) + result["ProviderConfig"] = to_class(ProviderConfig, self.provider_config) + result["ProviderConfigAzure"] = to_class(ProviderConfigAzure, self.provider_config_azure) + result["ProviderConfigTransport"] = to_enum(ProviderTransport, self.provider_config_transport) + result["ProviderConfigType"] = to_enum(ProviderType, self.provider_config_type) + result["ProviderConfigWireApi"] = to_enum(ProviderWireAPI, self.provider_config_wire_api) + result["ProviderEndpoint"] = to_class(ProviderEndpoint, self.provider_endpoint) + result["ProviderEndpointTransport"] = to_enum(ProviderTransport, self.provider_endpoint_transport) + result["ProviderEndpointType"] = to_enum(ProviderType, self.provider_endpoint_type) + result["ProviderEndpointWireApi"] = to_enum(ProviderWireAPI, self.provider_endpoint_wire_api) + result["ProviderGetEndpointRequest"] = self.provider_get_endpoint_request + result["ProviderModelConfig"] = to_class(ProviderModelConfig, self.provider_model_config) + result["ProviderSessionToken"] = to_class(ProviderSessionToken, self.provider_session_token) + result["ProviderTokenAcquireRequest"] = to_class(ProviderTokenAcquireRequest, self.provider_token_acquire_request) + result["ProviderTokenAcquireResult"] = to_class(ProviderTokenAcquireResult, self.provider_token_acquire_result) + result["PushAttachment"] = (self.push_attachment).to_dict() + result["PushAttachmentBlob"] = to_class(PushAttachmentBlob, self.push_attachment_blob) + result["PushAttachmentDirectory"] = to_class(PushAttachmentDirectory, self.push_attachment_directory) + result["PushAttachmentFile"] = to_class(PushAttachmentFile, self.push_attachment_file) + result["PushAttachmentFileLineRange"] = to_class(PushAttachmentFileLineRange, self.push_attachment_file_line_range) + result["PushAttachmentGitHubActionsJob"] = to_class(PushAttachmentGitHubActionsJob, self.push_attachment_git_hub_actions_job) + result["PushAttachmentGitHubCommit"] = to_class(PushAttachmentGitHubCommit, self.push_attachment_git_hub_commit) + result["PushAttachmentGitHubFile"] = to_class(PushAttachmentGitHubFile, self.push_attachment_git_hub_file) + result["PushAttachmentGitHubFileDiff"] = to_class(PushAttachmentGitHubFileDiff, self.push_attachment_git_hub_file_diff) + result["PushAttachmentGitHubFileDiffSide"] = to_class(PushAttachmentGitHubFileDiffSide, self.push_attachment_git_hub_file_diff_side) + result["PushAttachmentGitHubReference"] = to_class(PushAttachmentGitHubReference, self.push_attachment_git_hub_reference) + result["PushAttachmentGitHubReferenceType"] = to_enum(PushAttachmentGitHubReferenceTypeEnum, self.push_attachment_git_hub_reference_type) + result["PushAttachmentGitHubRelease"] = to_class(PushAttachmentGitHubRelease, self.push_attachment_git_hub_release) + result["PushAttachmentGitHubRepository"] = to_class(PushAttachmentGitHubRepository, self.push_attachment_git_hub_repository) + result["PushAttachmentGitHubSnippet"] = to_class(PushAttachmentGitHubSnippet, self.push_attachment_git_hub_snippet) + result["PushAttachmentGitHubTreeComparison"] = to_class(PushAttachmentGitHubTreeComparison, self.push_attachment_git_hub_tree_comparison) + result["PushAttachmentGitHubTreeComparisonSide"] = to_class(PushAttachmentGitHubTreeComparisonSide, self.push_attachment_git_hub_tree_comparison_side) + result["PushAttachmentGitHubUrl"] = to_class(PushAttachmentGitHubURL, self.push_attachment_git_hub_url) + result["PushAttachmentSelection"] = to_class(PushAttachmentSelection, self.push_attachment_selection) + result["PushAttachmentSelectionDetails"] = to_class(PushAttachmentSelectionDetails, self.push_attachment_selection_details) + result["PushAttachmentSelectionDetailsEnd"] = to_class(PushAttachmentSelectionDetailsEnd, self.push_attachment_selection_details_end) + result["PushAttachmentSelectionDetailsStart"] = to_class(PushAttachmentSelectionDetailsStart, self.push_attachment_selection_details_start) + result["PushGitHubRepoRef"] = to_class(PushGitHubRepoRef, self.push_git_hub_repo_ref) + result["QueueBeginDeferredIdleDrainRequest"] = to_class(QueueBeginDeferredIdleDrainRequest, self.queue_begin_deferred_idle_drain_request) + result["QueueBeginDeferredIdleDrainResult"] = to_class(QueueBeginDeferredIdleDrainResult, self.queue_begin_deferred_idle_drain_result) + result["QueueConsumeSystemNotificationsRequest"] = to_class(QueueConsumeSystemNotificationsRequest, self.queue_consume_system_notifications_request) result["QueuedCommandHandled"] = to_class(QueuedCommandHandled, self.queued_command_handled) result["QueuedCommandNotHandled"] = to_class(QueuedCommandNotHandled, self.queued_command_not_handled) result["QueuedCommandResult"] = (self.queued_command_result).to_dict() + result["QueueDeferSessionIdleRequest"] = to_class(QueueDeferSessionIdleRequest, self.queue_defer_session_idle_request) + result["QueueDuplicateAtRequest"] = to_class(QueueDuplicateAtRequest, self.queue_duplicate_at_request) + result["QueueDuplicateAtResult"] = to_class(QueueDuplicateAtResult, self.queue_duplicate_at_result) + result["QueueEnqueueResumePendingResult"] = to_class(QueueEnqueueResumePendingResult, self.queue_enqueue_resume_pending_result) + result["QueueFinishDeferredIdleDrainRequest"] = to_class(QueueFinishDeferredIdleDrainRequest, self.queue_finish_deferred_idle_drain_request) + result["QueueFinishDeferredIdleDrainResult"] = to_class(QueueFinishDeferredIdleDrainResult, self.queue_finish_deferred_idle_drain_result) + result["QueueHasPendingResult"] = to_class(QueueHasPendingResult, self.queue_has_pending_result) + result["QueueInsertAtRequest"] = to_class(QueueInsertAtRequest, self.queue_insert_at_request) + result["QueueInsertAtResult"] = to_class(QueueInsertAtResult, self.queue_insert_at_result) + result["QueueInsertMessage"] = to_class(QueueInsertMessage, self.queue_insert_message) + result["QueueMoveItemRequest"] = to_class(QueueMoveItemRequest, self.queue_move_item_request) + result["QueueMoveItemResult"] = to_class(QueueMoveItemResult, self.queue_move_item_result) result["QueuePendingItems"] = to_class(QueuePendingItems, self.queue_pending_items) result["QueuePendingItemsKind"] = to_enum(QueuePendingItemsKind, self.queue_pending_items_kind) result["QueuePendingItemsResult"] = to_class(QueuePendingItemsResult, self.queue_pending_items_result) + result["QueueRemoveAtRequest"] = to_class(QueueRemoveAtRequest, self.queue_remove_at_request) + result["QueueRemoveAtResult"] = to_class(QueueRemoveAtResult, self.queue_remove_at_result) result["QueueRemoveMostRecentResult"] = to_class(QueueRemoveMostRecentResult, self.queue_remove_most_recent_result) + result["QueueSendNowRequest"] = to_class(QueueSendNowRequest, self.queue_send_now_request) + result["QueueSendNowResult"] = to_class(QueueSendNowResult, self.queue_send_now_result) + result["QueueSetDrainPausedRequest"] = to_class(QueueSetDrainPausedRequest, self.queue_set_drain_paused_request) + result["QueueSnapshotResult"] = to_class(QueueSnapshotResult, self.queue_snapshot_result) + result["QueueUpdateTextRequest"] = to_class(QueueUpdateTextRequest, self.queue_update_text_request) + result["QueueUpdateTextResult"] = to_class(QueueUpdateTextResult, self.queue_update_text_result) result["RegisterEventInterestParams"] = to_class(RegisterEventInterestParams, self.register_event_interest_params) result["RegisterEventInterestResult"] = to_class(RegisterEventInterestResult, self.register_event_interest_result) + result["RegisterExtensionToolsParams"] = to_class(_RegisterExtensionToolsParams, self.register_extension_tools_params) + result["RegisterExtensionToolsResult"] = to_class(_RegisterExtensionToolsResult, self.register_extension_tools_result) result["ReleaseEventInterestParams"] = to_class(ReleaseEventInterestParams, self.release_event_interest_params) + result["RemoteControlConfig"] = to_class(RemoteControlConfig, self.remote_control_config) + result["RemoteControlConfigExistingMcSession"] = to_class(RemoteControlConfigExistingMcSession, self.remote_control_config_existing_mc_session) + result["RemoteControlStatus"] = (self.remote_control_status).to_dict() + result["RemoteControlStatusActive"] = to_class(RemoteControlStatusActive, self.remote_control_status_active) + result["RemoteControlStatusConnecting"] = to_class(RemoteControlStatusConnecting, self.remote_control_status_connecting) + result["RemoteControlStatusError"] = to_class(RemoteControlStatusError, self.remote_control_status_error) + result["RemoteControlStatusOff"] = to_class(RemoteControlStatusOff, self.remote_control_status_off) + result["RemoteControlStatusResult"] = to_class(RemoteControlStatusResult, self.remote_control_status_result) + result["RemoteControlStopResult"] = to_class(RemoteControlStopResult, self.remote_control_stop_result) + result["RemoteControlTransferResult"] = to_class(RemoteControlTransferResult, self.remote_control_transfer_result) result["RemoteEnableRequest"] = to_class(RemoteEnableRequest, self.remote_enable_request) result["RemoteEnableResult"] = to_class(RemoteEnableResult, self.remote_enable_result) result["RemoteNotifySteerableChangedRequest"] = to_class(RemoteNotifySteerableChangedRequest, self.remote_notify_steerable_changed_request) result["RemoteNotifySteerableChangedResult"] = to_class(RemoteNotifySteerableChangedResult, self.remote_notify_steerable_changed_result) result["RemoteSessionConnectionResult"] = to_class(RemoteSessionConnectionResult, self.remote_session_connection_result) + result["RemoteSessionMetadataRepository"] = to_class(RemoteSessionMetadataRepository, self.remote_session_metadata_repository) + result["RemoteSessionMetadataTaskType"] = to_enum(TaskType, self.remote_session_metadata_task_type) + result["RemoteSessionMetadataValue"] = to_class(RemoteSessionMetadataValue, self.remote_session_metadata_value) result["RemoteSessionMode"] = to_enum(RemoteSessionMode, self.remote_session_mode) + result["RemoteSessionRepository"] = to_class(RemoteSessionRepository, self.remote_session_repository) + result["RunOptions"] = to_class(RunOptions, self.run_options) + result["SandboxConfig"] = to_class(SandboxConfig, self.sandbox_config) + result["SandboxConfigAuth"] = to_class(SandboxConfigAuth, self.sandbox_config_auth) + result["SandboxConfigUserPolicy"] = to_class(SandboxConfigUserPolicy, self.sandbox_config_user_policy) + result["SandboxConfigUserPolicyExperimental"] = to_class(SandboxConfigUserPolicyExperimental, self.sandbox_config_user_policy_experimental) + result["SandboxConfigUserPolicyExperimentalSeatbelt"] = to_class(SandboxConfigUserPolicyExperimentalSeatbelt, self.sandbox_config_user_policy_experimental_seatbelt) + result["SandboxConfigUserPolicyFilesystem"] = to_class(SandboxConfigUserPolicyFilesystem, self.sandbox_config_user_policy_filesystem) + result["SandboxConfigUserPolicyNetwork"] = to_class(SandboxConfigUserPolicyNetwork, self.sandbox_config_user_policy_network) + result["SandboxConfigUserPolicyNetworkProxy"] = to_class(SandboxConfigUserPolicyNetworkProxy, self.sandbox_config_user_policy_network_proxy) + result["SandboxConfigUserPolicySeatbelt"] = to_class(SandboxConfigUserPolicySeatbelt, self.sandbox_config_user_policy_seatbelt) + result["ScheduleAddAtRequest"] = to_class(ScheduleAddAtRequest, self.schedule_add_at_request) + result["ScheduleAddCronRequest"] = to_class(ScheduleAddCronRequest, self.schedule_add_cron_request) + result["ScheduleAddRequest"] = to_class(ScheduleAddRequest, self.schedule_add_request) + result["ScheduleAddResult"] = to_class(ScheduleAddResult, self.schedule_add_result) + result["ScheduleAddSelfPacedRequest"] = to_class(ScheduleAddSelfPacedRequest, self.schedule_add_self_paced_request) result["ScheduleEntry"] = to_class(ScheduleEntry, self.schedule_entry) + result["ScheduleHasSelfPacedResult"] = to_class(ScheduleHasSelfPacedResult, self.schedule_has_self_paced_result) result["ScheduleList"] = to_class(ScheduleList, self.schedule_list) + result["ScheduleRearmSelfPacedRequest"] = to_class(ScheduleRearmSelfPacedRequest, self.schedule_rearm_self_paced_request) result["ScheduleStopRequest"] = to_class(ScheduleStopRequest, self.schedule_stop_request) result["ScheduleStopResult"] = to_class(ScheduleStopResult, self.schedule_stop_result) result["SecretsAddFilterValuesRequest"] = to_class(SecretsAddFilterValuesRequest, self.secrets_add_filter_values_request) result["SecretsAddFilterValuesResult"] = to_class(SecretsAddFilterValuesResult, self.secrets_add_filter_values_result) result["SendAgentMode"] = to_enum(SendAgentMode, self.send_agent_mode) - result["SendAttachment"] = (self.send_attachment).to_dict() - result["SendAttachmentBlob"] = to_class(SendAttachmentBlob, self.send_attachment_blob) - result["SendAttachmentDirectory"] = to_class(SendAttachmentDirectory, self.send_attachment_directory) - result["SendAttachmentFile"] = to_class(SendAttachmentFile, self.send_attachment_file) - result["SendAttachmentFileLineRange"] = to_class(SendAttachmentFileLineRange, self.send_attachment_file_line_range) - result["SendAttachmentGithubReference"] = to_class(SendAttachmentGithubReference, self.send_attachment_github_reference) - result["SendAttachmentGithubReferenceType"] = to_enum(SendAttachmentGithubReferenceTypeEnum, self.send_attachment_github_reference_type) - result["SendAttachmentSelection"] = to_class(SendAttachmentSelection, self.send_attachment_selection) - result["SendAttachmentSelectionDetails"] = to_class(SendAttachmentSelectionDetails, self.send_attachment_selection_details) - result["SendAttachmentSelectionDetailsEnd"] = to_class(SendAttachmentSelectionDetailsEnd, self.send_attachment_selection_details_end) - result["SendAttachmentSelectionDetailsStart"] = to_class(SendAttachmentSelectionDetailsStart, self.send_attachment_selection_details_start) + result["SendAttachmentsToMessageParams"] = to_class(SendAttachmentsToMessageParams, self.send_attachments_to_message_params) + result["SendMessageItem"] = to_class(SendMessageItem, self.send_message_item) + result["SendMessagesRequest"] = to_class(SendMessagesRequest, self.send_messages_request) + result["SendMessagesResult"] = to_class(SendMessagesResult, self.send_messages_result) result["SendMode"] = to_enum(SendMode, self.send_mode) result["SendRequest"] = to_class(SendRequest, self.send_request) result["SendResult"] = to_class(SendResult, self.send_result) + result["SendSystemNotificationRequest"] = to_class(SendSystemNotificationRequest, self.send_system_notification_request) + result["ServerAgentList"] = to_class(ServerAgentList, self.server_agent_list) + result["ServerInstructionSourceList"] = to_class(ServerInstructionSourceList, self.server_instruction_source_list) result["ServerSkill"] = to_class(ServerSkill, self.server_skill) result["ServerSkillList"] = to_class(ServerSkillList, self.server_skill_list) + result["SessionActivity"] = to_class(SessionActivity, self.session_activity) + result["SessionAgentListRequest"] = to_class(SessionAgentListRequest, self.session_agent_list_request) result["SessionAuthStatus"] = to_class(SessionAuthStatus, self.session_auth_status) result["SessionBulkDeleteResult"] = to_class(SessionBulkDeleteResult, self.session_bulk_delete_result) + result["SessionCancelAllBackgroundAgentsResult"] = from_int(self.session_cancel_all_background_agents_result) + result["SessionCapability"] = to_enum(SessionCapability, self.session_capability) + result["SessionCommandsListRequest"] = to_class(SessionCommandsListRequest, self.session_commands_list_request) + result["SessionCompletionItem"] = to_class(SessionCompletionItem, self.session_completion_item) result["SessionContext"] = to_class(SessionContext, self.session_context) result["SessionContextHostType"] = to_enum(HostType, self.session_context_host_type) result["SessionEnrichMetadataResult"] = to_class(SessionEnrichMetadataResult, self.session_enrich_metadata_result) @@ -17196,7 +31554,7 @@ def to_dict(self) -> dict: result["SessionFsReaddirRequest"] = to_class(SessionFSReaddirRequest, self.session_fs_readdir_request) result["SessionFsReaddirResult"] = to_class(SessionFSReaddirResult, self.session_fs_readdir_result) result["SessionFsReaddirWithTypesEntry"] = to_class(SessionFSReaddirWithTypesEntry, self.session_fs_readdir_with_types_entry) - result["SessionFsReaddirWithTypesEntryType"] = to_enum(SessionFSReaddirWithTypesEntryType, self.session_fs_readdir_with_types_entry_type) + result["SessionFsReaddirWithTypesEntryType"] = to_enum(DebugCollectLogsEntryKind, self.session_fs_readdir_with_types_entry_type) result["SessionFsReaddirWithTypesRequest"] = to_class(SessionFSReaddirWithTypesRequest, self.session_fs_readdir_with_types_request) result["SessionFsReaddirWithTypesResult"] = to_class(SessionFSReaddirWithTypesResult, self.session_fs_readdir_with_types_result) result["SessionFsReadFileRequest"] = to_class(SessionFSReadFileRequest, self.session_fs_read_file_request) @@ -17212,48 +31570,110 @@ def to_dict(self) -> dict: result["SessionFsSqliteQueryRequest"] = to_class(SessionFSSqliteQueryRequest, self.session_fs_sqlite_query_request) result["SessionFsSqliteQueryResult"] = to_class(SessionFSSqliteQueryResult, self.session_fs_sqlite_query_result) result["SessionFsSqliteQueryType"] = to_enum(SessionFSSqliteQueryType, self.session_fs_sqlite_query_type) + result["SessionFsSqliteTransactionError"] = to_class(SessionFSSqliteTransactionError, self.session_fs_sqlite_transaction_error) + result["SessionFsSqliteTransactionErrorClass"] = to_enum(SessionFSSqliteTransactionErrorClass, self.session_fs_sqlite_transaction_error_class) + result["SessionFsSqliteTransactionRequest"] = to_class(SessionFSSqliteTransactionRequest, self.session_fs_sqlite_transaction_request) + result["SessionFsSqliteTransactionResult"] = to_class(SessionFSSqliteTransactionResult, self.session_fs_sqlite_transaction_result) + result["SessionFsSqliteTransactionStatement"] = to_class(SessionFSSqliteTransactionStatement, self.session_fs_sqlite_transaction_statement) result["SessionFsStatRequest"] = to_class(SessionFSStatRequest, self.session_fs_stat_request) result["SessionFsStatResult"] = to_class(SessionFSStatResult, self.session_fs_stat_result) result["SessionFsWriteFileRequest"] = to_class(SessionFSWriteFileRequest, self.session_fs_write_file_request) + result["SessionHistoryCompactRequest"] = to_class(SessionHistoryCompactRequest, self.session_history_compact_request) result["SessionInstalledPlugin"] = to_class(SessionInstalledPlugin, self.session_installed_plugin) result["SessionInstalledPluginSource"] = from_union([lambda x: to_class(SessionInstalledPluginSource, x), from_str], self.session_installed_plugin_source) - result["SessionInstalledPluginSourceGithub"] = to_class(SessionInstalledPluginSourceGithub, self.session_installed_plugin_source_github) + result["SessionInstalledPluginSourceGitHub"] = to_class(SessionInstalledPluginSourceGitHub, self.session_installed_plugin_source_git_hub) result["SessionInstalledPluginSourceLocal"] = to_class(SessionInstalledPluginSourceLocal, self.session_installed_plugin_source_local) result["SessionInstalledPluginSourceUrl"] = to_class(SessionInstalledPluginSourceURL, self.session_installed_plugin_source_url) + result["SessionLimitPredictionBaselineData"] = to_class(SessionLimitPredictionBaselineData, self.session_limit_prediction_baseline_data) + result["SessionLimitPredictionClientType"] = to_enum(SessionLimitPredictionClientType, self.session_limit_prediction_client_type) + result["SessionLimitPredictionDetails"] = to_class(SessionLimitPredictionDetails, self.session_limit_prediction_details) + result["SessionLimitPredictionPredictRequest"] = to_class(SessionLimitPredictionPredictRequest, self.session_limit_prediction_predict_request) + result["SessionLimitPredictionRequest"] = self.session_limit_prediction_request + result["SessionLimitPredictionResult"] = to_class(SessionLimitPredictionResult, self.session_limit_prediction_result) + result["SessionLimitPredictionSource"] = to_enum(SessionLimitPredictionSource, self.session_limit_prediction_source) + result["SessionLimitPredictionTier"] = to_enum(SessionLimitPredictionTier, self.session_limit_prediction_tier) + result["SessionLimitPredictionTierOption"] = to_class(SessionLimitPredictionTierOption, self.session_limit_prediction_tier_option) + result["SessionLimitPredictionUnavailableReason"] = to_enum(SessionLimitPredictionUnavailableReason, self.session_limit_prediction_unavailable_reason) result["SessionList"] = to_class(SessionList, self.session_list) + result["SessionListEntry"] = (self.session_list_entry).to_dict() result["SessionListFilter"] = to_class(SessionListFilter, self.session_list_filter) result["SessionLoadDeferredRepoHooksResult"] = to_class(SessionLoadDeferredRepoHooksResult, self.session_load_deferred_repo_hooks_result) result["SessionLogLevel"] = to_enum(SessionLogLevel, self.session_log_level) + result["SessionManagedPermissions"] = to_class(SessionManagedPermissions, self.session_managed_permissions) + result["SessionManagedSettings"] = to_class(SessionManagedSettings, self.session_managed_settings) result["SessionMcpAppsCallToolResult"] = from_dict(lambda x: x, self.session_mcp_apps_call_tool_result) - result["SessionMetadata"] = to_class(SessionMetadata, self.session_metadata) result["SessionMetadataSnapshot"] = to_class(SessionMetadataSnapshot, self.session_metadata_snapshot) result["SessionMode"] = to_enum(SessionMode, self.session_mode) result["SessionModelList"] = to_class(SessionModelList, self.session_model_list) + result["SessionModelListRequest"] = to_class(SessionModelListRequest, self.session_model_list_request) + result["SessionModelPriceCategory"] = to_class(SessionModelPriceCategory, self.session_model_price_category) + result["SessionOpenOptions"] = to_class(SessionOpenOptions, self.session_open_options) + result["SessionOpenOptionsAdditionalContentExclusionPolicy"] = to_class(SessionOpenOptionsAdditionalContentExclusionPolicy, self.session_open_options_additional_content_exclusion_policy) + result["SessionOpenOptionsAdditionalContentExclusionPolicyRule"] = to_class(SessionOpenOptionsAdditionalContentExclusionPolicyRule, self.session_open_options_additional_content_exclusion_policy_rule) + result["SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource"] = to_class(SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource, self.session_open_options_additional_content_exclusion_policy_rule_source) + result["SessionOpenOptionsAdditionalContentExclusionPolicyScope"] = to_enum(AdditionalContentExclusionPolicyScope, self.session_open_options_additional_content_exclusion_policy_scope) + result["SessionOpenOptionsEnvValueMode"] = to_enum(MCPSetEnvValueModeDetails, self.session_open_options_env_value_mode) + result["SessionOpenOptionsReasoningSummary"] = to_enum(ReasoningSummary, self.session_open_options_reasoning_summary) + result["SessionOpenParams"] = (self.session_open_params).to_dict() + result["SessionOpenResult"] = to_class(SessionOpenResult, self.session_open_result) + result["SessionPluginsReloadRequest"] = to_class(SessionPluginsReloadRequest, self.session_plugins_reload_request) + result["SessionProviderGetEndpointRequest"] = to_class(SessionProviderGetEndpointRequest, self.session_provider_get_endpoint_request) result["SessionPruneResult"] = to_class(SessionPruneResult, self.session_prune_result) result["SessionsBulkDeleteRequest"] = to_class(SessionsBulkDeleteRequest, self.sessions_bulk_delete_request) result["SessionsCheckInUseRequest"] = to_class(SessionsCheckInUseRequest, self.sessions_check_in_use_request) result["SessionsCheckInUseResult"] = to_class(SessionsCheckInUseResult, self.sessions_check_in_use_result) result["SessionsCloseRequest"] = to_class(SessionsCloseRequest, self.sessions_close_request) result["SessionsCloseResult"] = to_class(SessionsCloseResult, self.sessions_close_result) + result["SessionsDeleteRequest"] = to_class(SessionsDeleteRequest, self.sessions_delete_request) result["SessionsEnrichMetadataRequest"] = to_class(SessionsEnrichMetadataRequest, self.sessions_enrich_metadata_request) result["SessionSetCredentialsParams"] = to_class(SessionSetCredentialsParams, self.session_set_credentials_params) result["SessionSetCredentialsResult"] = to_class(SessionSetCredentialsResult, self.session_set_credentials_result) + result["SessionSettingsBuiltInToolAvailabilitySnapshot"] = to_class(SessionSettingsBuiltInToolAvailabilitySnapshot, self.session_settings_built_in_tool_availability_snapshot) + result["SessionSettingsEvaluatePredicateRequest"] = to_class(SessionSettingsEvaluatePredicateRequest, self.session_settings_evaluate_predicate_request) + result["SessionSettingsEvaluatePredicateResult"] = to_class(SessionSettingsEvaluatePredicateResult, self.session_settings_evaluate_predicate_result) + result["SessionSettingsJobSnapshot"] = to_class(SessionSettingsJobSnapshot, self.session_settings_job_snapshot) + result["SessionSettingsModelSnapshot"] = to_class(SessionSettingsModelSnapshot, self.session_settings_model_snapshot) + result["SessionSettingsOnlineEvaluationSnapshot"] = to_class(SessionSettingsOnlineEvaluationSnapshot, self.session_settings_online_evaluation_snapshot) + result["SessionSettingsPredicateName"] = to_enum(SessionSettingsPredicateName, self.session_settings_predicate_name) + result["SessionSettingsRepoSnapshot"] = to_class(SessionSettingsRepoSnapshot, self.session_settings_repo_snapshot) + result["SessionSettingsSnapshot"] = to_class(SessionSettingsSnapshot, self.session_settings_snapshot) + result["SessionSettingsValidationSnapshot"] = to_class(SessionSettingsValidationSnapshot, self.session_settings_validation_snapshot) result["SessionsFindByPrefixRequest"] = to_class(SessionsFindByPrefixRequest, self.sessions_find_by_prefix_request) result["SessionsFindByPrefixResult"] = to_class(SessionsFindByPrefixResult, self.sessions_find_by_prefix_result) result["SessionsFindByTaskIDRequest"] = to_class(SessionsFindByTaskIDRequest, self.sessions_find_by_task_id_request) result["SessionsFindByTaskIDResult"] = to_class(SessionsFindByTaskIDResult, self.sessions_find_by_task_id_result) result["SessionsForkRequest"] = to_class(SessionsForkRequest, self.sessions_fork_request) result["SessionsForkResult"] = to_class(SessionsForkResult, self.sessions_fork_result) + result["SessionsGetBoardEntryCountRequest"] = to_class(SessionsGetBoardEntryCountRequest, self.sessions_get_board_entry_count_request) + result["SessionsGetBoardEntryCountResult"] = to_class(SessionsGetBoardEntryCountResult, self.sessions_get_board_entry_count_result) result["SessionsGetEventFilePathRequest"] = to_class(SessionsGetEventFilePathRequest, self.sessions_get_event_file_path_request) result["SessionsGetEventFilePathResult"] = to_class(SessionsGetEventFilePathResult, self.sessions_get_event_file_path_result) result["SessionsGetLastForContextRequest"] = to_class(SessionsGetLastForContextRequest, self.sessions_get_last_for_context_request) result["SessionsGetLastForContextResult"] = to_class(SessionsGetLastForContextResult, self.sessions_get_last_for_context_result) + result["SessionsGetMetadataRequest"] = to_class(SessionsGetMetadataRequest, self.sessions_get_metadata_request) + result["SessionsGetMetadataResult"] = to_class(SessionsGetMetadataResult, self.sessions_get_metadata_result) result["SessionsGetPersistedRemoteSteerableRequest"] = to_class(SessionsGetPersistedRemoteSteerableRequest, self.sessions_get_persisted_remote_steerable_request) result["SessionsGetPersistedRemoteSteerableResult"] = to_class(SessionsGetPersistedRemoteSteerableResult, self.sessions_get_persisted_remote_steerable_result) result["SessionSizes"] = to_class(SessionSizes, self.session_sizes) + result["SessionsListNonEmptySessionIdsRequest"] = to_class(SessionsListNonEmptySessionIDSRequest, self.sessions_list_non_empty_session_ids_request) + result["SessionsListNonEmptySessionIdsResult"] = to_class(SessionsListNonEmptySessionIDSResult, self.sessions_list_non_empty_session_ids_result) result["SessionsListRequest"] = to_class(SessionsListRequest, self.sessions_list_request) result["SessionsLoadDeferredRepoHooksRequest"] = to_class(SessionsLoadDeferredRepoHooksRequest, self.sessions_load_deferred_repo_hooks_request) + result["SessionsOpenAttach"] = to_class(SessionsOpenAttach, self.sessions_open_attach) + result["SessionsOpenCloud"] = to_class(SessionsOpenCloud, self.sessions_open_cloud) + result["SessionsOpenCreate"] = to_class(SessionsOpenCreate, self.sessions_open_create) + result["SessionsOpenHandoff"] = to_class(SessionsOpenHandoff, self.sessions_open_handoff) + result["SessionsOpenHandoffTaskType"] = to_enum(TaskType, self.sessions_open_handoff_task_type) + result["SessionsOpenProgress"] = to_class(SessionsOpenProgress, self.sessions_open_progress) + result["SessionsOpenProgressStatus"] = to_enum(SessionsOpenProgressStatus, self.sessions_open_progress_status) + result["SessionsOpenProgressStep"] = to_enum(SessionsOpenProgressStep, self.sessions_open_progress_step) + result["SessionsOpenRemote"] = to_class(SessionsOpenRemote, self.sessions_open_remote) + result["SessionsOpenResume"] = to_class(SessionsOpenResume, self.sessions_open_resume) + result["SessionsOpenResumeLast"] = to_class(SessionsOpenResumeLast, self.sessions_open_resume_last) + result["SessionsOpenStatus"] = to_enum(SessionsOpenStatus, self.sessions_open_status) + result["SessionSource"] = to_enum(SessionSource, self.session_source) result["SessionsPruneOldRequest"] = to_class(SessionsPruneOldRequest, self.sessions_prune_old_request) + result["SessionsRegisterExtensionToolsOnSessionOptions"] = to_class(SessionsRegisterExtensionToolsOnSessionOptions, self.sessions_register_extension_tools_on_session_options) result["SessionsReleaseLockRequest"] = to_class(SessionsReleaseLockRequest, self.sessions_release_lock_request) result["SessionsReleaseLockResult"] = to_class(SessionsReleaseLockResult, self.sessions_release_lock_result) result["SessionsReloadPluginHooksRequest"] = to_class(SessionsReloadPluginHooksRequest, self.sessions_reload_plugin_hooks_request) @@ -17262,22 +31682,38 @@ def to_dict(self) -> dict: result["SessionsSaveResult"] = to_class(SessionsSaveResult, self.sessions_save_result) result["SessionsSetAdditionalPluginsRequest"] = to_class(SessionsSetAdditionalPluginsRequest, self.sessions_set_additional_plugins_request) result["SessionsSetAdditionalPluginsResult"] = to_class(SessionsSetAdditionalPluginsResult, self.sessions_set_additional_plugins_result) + result["SessionsSetRemoteControlSteeringRequest"] = to_class(SessionsSetRemoteControlSteeringRequest, self.sessions_set_remote_control_steering_request) + result["SessionsStartRemoteControlRequest"] = to_class(SessionsStartRemoteControlRequest, self.sessions_start_remote_control_request) + result["SessionsStopRemoteControlRequest"] = to_class(SessionsStopRemoteControlRequest, self.sessions_stop_remote_control_request) + result["SessionsTransferRemoteControlRequest"] = to_class(SessionsTransferRemoteControlRequest, self.sessions_transfer_remote_control_request) + result["SessionTelemetryEngagement"] = to_class(SessionTelemetryEngagement, self.session_telemetry_engagement) result["SessionUpdateOptionsParams"] = to_class(SessionUpdateOptionsParams, self.session_update_options_params) result["SessionUpdateOptionsResult"] = to_class(SessionUpdateOptionsResult, self.session_update_options_result) + result["SessionVisibilityStatus"] = to_enum(SessionVisibilityStatus, self.session_visibility_status) result["SessionWorkingDirectoryContext"] = to_class(SessionWorkingDirectoryContext, self.session_working_directory_context) result["SessionWorkingDirectoryContextHostType"] = to_enum(HostType, self.session_working_directory_context_host_type) + result["ShellCancelUserRequestedRequest"] = to_class(ShellCancelUserRequestedRequest, self.shell_cancel_user_requested_request) result["ShellExecRequest"] = to_class(ShellExecRequest, self.shell_exec_request) result["ShellExecResult"] = to_class(ShellExecResult, self.shell_exec_result) + result["ShellExecuteUserRequestedRequest"] = to_class(ShellExecuteUserRequestedRequest, self.shell_execute_user_requested_request) + result["ShellInitProfile"] = to_enum(ShellInitProfile, self.shell_init_profile) + result["ShellInitScript"] = to_class(ShellInitScript, self.shell_init_script) + result["ShellInitScriptShell"] = to_enum(ShellInitScriptShell, self.shell_init_script_shell) result["ShellKillRequest"] = to_class(ShellKillRequest, self.shell_kill_request) result["ShellKillResult"] = to_class(ShellKillResult, self.shell_kill_result) result["ShellKillSignal"] = to_enum(ShellKillSignal, self.shell_kill_signal) + result["ShellOptions"] = to_class(ShellOptions, self.shell_options) result["ShutdownRequest"] = to_class(ShutdownRequest, self.shutdown_request) result["Skill"] = to_class(Skill, self.skill) + result["SkillDiscoveryPath"] = to_class(SkillDiscoveryPath, self.skill_discovery_path) + result["SkillDiscoveryPathList"] = to_class(SkillDiscoveryPathList, self.skill_discovery_path_list) + result["SkillDiscoveryScope"] = to_enum(SkillDiscoveryScope, self.skill_discovery_scope) result["SkillList"] = to_class(SkillList, self.skill_list) result["SkillsConfigSetDisabledSkillsRequest"] = to_class(SkillsConfigSetDisabledSkillsRequest, self.skills_config_set_disabled_skills_request) result["SkillsDisableRequest"] = to_class(SkillsDisableRequest, self.skills_disable_request) result["SkillsDiscoverRequest"] = to_class(SkillsDiscoverRequest, self.skills_discover_request) result["SkillsEnableRequest"] = to_class(SkillsEnableRequest, self.skills_enable_request) + result["SkillsGetDiscoveryPathsRequest"] = to_class(SkillsGetDiscoveryPathsRequest, self.skills_get_discovery_paths_request) result["SkillsGetInvokedResult"] = to_class(SkillsGetInvokedResult, self.skills_get_invoked_result) result["SkillsInvokedSkill"] = to_class(SkillsInvokedSkill, self.skills_invoked_skill) result["SkillsLoadDiagnostics"] = to_class(SkillsLoadDiagnostics, self.skills_load_diagnostics) @@ -17285,12 +31721,15 @@ def to_dict(self) -> dict: result["SlashCommandCompletedResult"] = to_class(SlashCommandCompletedResult, self.slash_command_completed_result) result["SlashCommandInfo"] = to_class(SlashCommandInfo, self.slash_command_info) result["SlashCommandInput"] = to_class(SlashCommandInput, self.slash_command_input) + result["SlashCommandInputChoice"] = to_class(SlashCommandInputChoice, self.slash_command_input_choice) result["SlashCommandInputCompletion"] = to_enum(SlashCommandInputCompletion, self.slash_command_input_completion) result["SlashCommandInvocationResult"] = (self.slash_command_invocation_result).to_dict() result["SlashCommandKind"] = to_enum(SlashCommandKind, self.slash_command_kind) result["SlashCommandSelectSubcommandOption"] = to_class(SlashCommandSelectSubcommandOption, self.slash_command_select_subcommand_option) result["SlashCommandSelectSubcommandResult"] = to_class(SlashCommandSelectSubcommandResult, self.slash_command_select_subcommand_result) result["SlashCommandTextResult"] = to_class(SlashCommandTextResult, self.slash_command_text_result) + result["SubagentSettingsEntry"] = to_class(SubagentSettingsEntry, self.subagent_settings_entry) + result["SubagentSettingsEntryContextTier"] = to_enum(SubagentSettingsEntryContextTier, self.subagent_settings_entry_context_tier) result["TaskAgentInfo"] = to_class(TaskAgentInfo, self.task_agent_info) result["TaskAgentProgress"] = to_class(TaskAgentProgress, self.task_agent_progress) result["TaskExecutionMode"] = to_enum(TaskExecutionMode, self.task_execution_mode) @@ -17324,6 +31763,7 @@ def to_dict(self) -> dict: result["ToolsGetCurrentMetadataResult"] = to_class(ToolsGetCurrentMetadataResult, self.tools_get_current_metadata_result) result["ToolsInitializeAndValidateResult"] = to_class(ToolsInitializeAndValidateResult, self.tools_initialize_and_validate_result) result["ToolsListRequest"] = to_class(ToolsListRequest, self.tools_list_request) + result["ToolsUpdateSubagentSettingsResult"] = to_class(ToolsUpdateSubagentSettingsResult, self.tools_update_subagent_settings_result) result["UIAutoModeSwitchResponse"] = to_enum(UIAutoModeSwitchResponse, self.ui_auto_mode_switch_response) result["UIElicitationArrayAnyOfField"] = to_class(UIElicitationArrayAnyOfField, self.ui_elicitation_array_any_of_field) result["UIElicitationArrayAnyOfFieldItems"] = to_class(UIElicitationArrayAnyOfFieldItems, self.ui_elicitation_array_any_of_field_items) @@ -17346,6 +31786,8 @@ def to_dict(self) -> dict: result["UIElicitationStringEnumField"] = to_class(UIElicitationStringEnumField, self.ui_elicitation_string_enum_field) result["UIElicitationStringOneOfField"] = to_class(UIElicitationStringOneOfField, self.ui_elicitation_string_one_of_field) result["UIElicitationStringOneOfFieldOneOf"] = to_class(UIElicitationStringOneOfFieldOneOf, self.ui_elicitation_string_one_of_field_one_of) + result["UIEphemeralQueryRequest"] = to_class(UIEphemeralQueryRequest, self.ui_ephemeral_query_request) + result["UIEphemeralQueryResult"] = to_class(UIEphemeralQueryResult, self.ui_ephemeral_query_result) result["UIExitPlanModeAction"] = to_enum(UIExitPlanModeAction, self.ui_exit_plan_mode_action) result["UIExitPlanModeResponse"] = to_class(UIExitPlanModeResponse, self.ui_exit_plan_mode_response) result["UIHandlePendingAutoModeSwitchRequest"] = to_class(UIHandlePendingAutoModeSwitchRequest, self.ui_handle_pending_auto_mode_switch_request) @@ -17354,11 +31796,15 @@ def to_dict(self) -> dict: result["UIHandlePendingResult"] = to_class(UIHandlePendingResult, self.ui_handle_pending_result) result["UIHandlePendingSamplingRequest"] = to_class(UIHandlePendingSamplingRequest, self.ui_handle_pending_sampling_request) result["UIHandlePendingSamplingResponse"] = from_dict(lambda x: x, self.ui_handle_pending_sampling_response) + result["UIHandlePendingSessionLimitsExhaustedRequest"] = to_class(UIHandlePendingSessionLimitsExhaustedRequest, self.ui_handle_pending_session_limits_exhausted_request) result["UIHandlePendingUserInputRequest"] = to_class(UIHandlePendingUserInputRequest, self.ui_handle_pending_user_input_request) result["UIRegisterDirectAutoModeSwitchHandlerResult"] = to_class(UIRegisterDirectAutoModeSwitchHandlerResult, self.ui_register_direct_auto_mode_switch_handler_result) + result["UISessionLimitsExhaustedResponse"] = to_class(UISessionLimitsExhaustedResponse, self.ui_session_limits_exhausted_response) + result["UISessionLimitsExhaustedResponseAction"] = to_enum(UISessionLimitsExhaustedResponseAction, self.ui_session_limits_exhausted_response_action) result["UIUnregisterDirectAutoModeSwitchHandlerRequest"] = to_class(UIUnregisterDirectAutoModeSwitchHandlerRequest, self.ui_unregister_direct_auto_mode_switch_handler_request) result["UIUnregisterDirectAutoModeSwitchHandlerResult"] = to_class(UIUnregisterDirectAutoModeSwitchHandlerResult, self.ui_unregister_direct_auto_mode_switch_handler_result) result["UIUserInputResponse"] = to_class(UIUserInputResponse, self.ui_user_input_response) + result["UpdateSubagentSettingsRequest"] = to_class(UpdateSubagentSettingsRequest, self.update_subagent_settings_request) result["UsageGetMetricsResult"] = to_class(UsageGetMetricsResult, self.usage_get_metrics_result) result["UsageMetricsCodeChanges"] = to_class(UsageMetricsCodeChanges, self.usage_metrics_code_changes) result["UsageMetricsModelMetric"] = to_class(UsageMetricsModelMetric, self.usage_metrics_model_metric) @@ -17367,25 +31813,45 @@ def to_dict(self) -> dict: result["UsageMetricsModelMetricUsage"] = to_class(UsageMetricsModelMetricUsage, self.usage_metrics_model_metric_usage) result["UsageMetricsTokenDetail"] = to_class(UsageMetricsTokenDetail, self.usage_metrics_token_detail) result["UserAuthInfo"] = to_class(UserAuthInfo, self.user_auth_info) + result["UserRequestedShellCommandResult"] = to_class(UserRequestedShellCommandResult, self.user_requested_shell_command_result) + result["UserSettingMetadata"] = to_class(UserSettingMetadata, self.user_setting_metadata) + result["UserSettingsGetResult"] = to_class(UserSettingsGetResult, self.user_settings_get_result) + result["UserSettingsSetRequest"] = to_class(UserSettingsSetRequest, self.user_settings_set_request) + result["UserSettingsSetResult"] = to_class(UserSettingsSetResult, self.user_settings_set_result) + result["VisibilityGetResult"] = to_class(VisibilityGetResult, self.visibility_get_result) + result["VisibilitySetRequest"] = to_class(VisibilitySetRequest, self.visibility_set_request) + result["VisibilitySetResult"] = to_class(VisibilitySetResult, self.visibility_set_result) result["WorkspaceDiffFileChange"] = to_class(WorkspaceDiffFileChange, self.workspace_diff_file_change) result["WorkspaceDiffFileChangeType"] = to_enum(WorkspaceDiffFileChangeType, self.workspace_diff_file_change_type) result["WorkspaceDiffMode"] = to_enum(WorkspaceDiffMode, self.workspace_diff_mode) result["WorkspaceDiffResult"] = to_class(WorkspaceDiffResult, self.workspace_diff_result) + result["WorkspacesAddSummaryRequest"] = to_class(WorkspacesAddSummaryRequest, self.workspaces_add_summary_request) + result["WorkspacesAddSummaryResult"] = to_class(WorkspacesAddSummaryResult, self.workspaces_add_summary_result) + result["WorkspacesAutopilotObjectiveExistsResult"] = to_class(WorkspacesAutopilotObjectiveExistsResult, self.workspaces_autopilot_objective_exists_result) result["WorkspacesCheckpoints"] = to_class(WorkspacesCheckpoints, self.workspaces_checkpoints) result["WorkspacesCreateFileRequest"] = to_class(WorkspacesCreateFileRequest, self.workspaces_create_file_request) + result["WorkspacesDeleteAutopilotObjectiveResult"] = to_class(WorkspacesDeleteAutopilotObjectiveResult, self.workspaces_delete_autopilot_objective_result) result["WorkspacesDiffRequest"] = to_class(WorkspacesDiffRequest, self.workspaces_diff_request) + result["WorkspacesEnsureRequest"] = to_class(WorkspacesEnsureRequest, self.workspaces_ensure_request) result["WorkspacesGetWorkspaceResult"] = to_class(WorkspacesGetWorkspaceResult, self.workspaces_get_workspace_result) result["WorkspacesListCheckpointsResult"] = to_class(WorkspacesListCheckpointsResult, self.workspaces_list_checkpoints_result) result["WorkspacesListFilesResult"] = to_class(WorkspacesListFilesResult, self.workspaces_list_files_result) + result["WorkspacesReadAutopilotObjectiveResult"] = to_class(WorkspacesReadAutopilotObjectiveResult, self.workspaces_read_autopilot_objective_result) result["WorkspacesReadCheckpointRequest"] = to_class(WorkspacesReadCheckpointRequest, self.workspaces_read_checkpoint_request) result["WorkspacesReadCheckpointResult"] = to_class(WorkspacesReadCheckpointResult, self.workspaces_read_checkpoint_result) result["WorkspacesReadFileRequest"] = to_class(WorkspacesReadFileRequest, self.workspaces_read_file_request) result["WorkspacesReadFileResult"] = to_class(WorkspacesReadFileResult, self.workspaces_read_file_result) result["WorkspacesSaveLargePasteRequest"] = to_class(WorkspacesSaveLargePasteRequest, self.workspaces_save_large_paste_request) result["WorkspacesSaveLargePasteResult"] = to_class(WorkspacesSaveLargePasteResult, self.workspaces_save_large_paste_result) + result["WorkspacesTruncateSummariesRequest"] = to_class(WorkspacesTruncateSummariesRequest, self.workspaces_truncate_summaries_request) result["WorkspaceSummaryHostType"] = to_enum(HostType, self.workspace_summary_host_type) + result["WorkspacesUpdateMetadataRequest"] = to_class(WorkspacesUpdateMetadataRequest, self.workspaces_update_metadata_request) result["WorkspacesWorkspaceDetailsHostType"] = to_enum(HostType, self.workspaces_workspace_details_host_type) + result["WorkspacesWriteAutopilotObjectiveRequest"] = to_class(WorkspacesWriteAutopilotObjectiveRequest, self.workspaces_write_autopilot_objective_request) + result["WorkspacesWriteAutopilotObjectiveResult"] = to_class(WorkspacesWriteAutopilotObjectiveResult, self.workspaces_write_autopilot_objective_result) + result["SessionContextAttribution"] = from_union([lambda x: to_class(SessionContextAttribution, x), from_none], self.session_context_attribution) result["SessionContextInfo"] = from_union([lambda x: to_class(SessionContextInfo, x), from_none], self.session_context_info) + result["SubagentSettings"] = from_union([lambda x: to_class(SubagentSettings, x), from_none], self.subagent_settings) result["TaskProgress"] = from_union([lambda x: to_class(TaskProgress, x), from_none], self.task_progress) result["WorkspaceSummary"] = from_union([lambda x: to_class(WorkspaceSummary, x), from_none], self.workspace_summary) return result @@ -17409,7 +31875,7 @@ def _load_AgentRegistrySpawnResult(obj: Any) -> "AgentRegistrySpawnResult": case "validation-error": return AgentRegistrySpawnValidationError.from_dict(obj) case _: raise ValueError(f"Unknown AgentRegistrySpawnResult kind: {kind!r}") -# The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. +# Initial authentication info for the session. AuthInfo = HMACAuthInfo | EnvAuthInfo | TokenAuthInfo | CopilotAPITokenAuthInfo | UserAuthInfo | GhCLIAuthInfo | APIKeyAuthInfo def _load_AuthInfo(obj: Any) -> "AuthInfo": @@ -17426,7 +31892,7 @@ def _load_AuthInfo(obj: Any) -> "AuthInfo": case _: raise ValueError(f"Unknown AuthInfo type: {kind!r}") # A content block within a tool result, which may be text, terminal output, image, audio, or a resource -ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource +ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentShellExit | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource def _load_ExternalToolTextResultForLlmContent(obj: Any) -> "ExternalToolTextResultForLlmContent": assert isinstance(obj, dict) @@ -17434,6 +31900,7 @@ def _load_ExternalToolTextResultForLlmContent(obj: Any) -> "ExternalToolTextResu match kind: case "text": return ExternalToolTextResultForLlmContentText.from_dict(obj) case "terminal": return ExternalToolTextResultForLlmContentTerminal.from_dict(obj) + case "shell_exit": return ExternalToolTextResultForLlmContentShellExit.from_dict(obj) case "image": return ExternalToolTextResultForLlmContentImage.from_dict(obj) case "audio": return ExternalToolTextResultForLlmContentAudio.from_dict(obj) case "resource_link": return ExternalToolTextResultForLlmContentResourceLink.from_dict(obj) @@ -17465,7 +31932,7 @@ def _load_PermissionDecision(obj: Any) -> "PermissionDecision": case _: raise ValueError(f"Unknown PermissionDecision kind: {kind!r}") # Approval to persist for this location -PermissionDecisionApproveForLocationApproval = PermissionDecisionApproveForLocationApprovalCommands | PermissionDecisionApproveForLocationApprovalRead | PermissionDecisionApproveForLocationApprovalWrite | PermissionDecisionApproveForLocationApprovalMCP | PermissionDecisionApproveForLocationApprovalMCPSampling | PermissionDecisionApproveForLocationApprovalMemory | PermissionDecisionApproveForLocationApprovalCustomTool | PermissionDecisionApproveForLocationApprovalExtensionManagement | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess +PermissionDecisionApproveForLocationApproval = PermissionDecisionApproveForLocationApprovalCommands | PermissionDecisionApproveForLocationApprovalRead | PermissionDecisionApproveForLocationApprovalWrite | PermissionDecisionApproveForLocationApprovalMCP | PermissionDecisionApproveForLocationApprovalMCPSampling | PermissionDecisionApproveForLocationApprovalMemory | PermissionDecisionApproveForLocationApprovalCustomTool | PermissionDecisionApproveForLocationApprovalExtensionManagement | PermissionDecisionApproveForLocationApprovalFactory | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess def _load_PermissionDecisionApproveForLocationApproval(obj: Any) -> "PermissionDecisionApproveForLocationApproval": assert isinstance(obj, dict) @@ -17479,11 +31946,12 @@ def _load_PermissionDecisionApproveForLocationApproval(obj: Any) -> "PermissionD case "memory": return PermissionDecisionApproveForLocationApprovalMemory.from_dict(obj) case "custom-tool": return PermissionDecisionApproveForLocationApprovalCustomTool.from_dict(obj) case "extension-management": return PermissionDecisionApproveForLocationApprovalExtensionManagement.from_dict(obj) + case "factory": return PermissionDecisionApproveForLocationApprovalFactory.from_dict(obj) case "extension-permission-access": return PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionDecisionApproveForLocationApproval kind: {kind!r}") # Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) -PermissionDecisionApproveForSessionApproval = PermissionDecisionApproveForSessionApprovalCommands | PermissionDecisionApproveForSessionApprovalRead | PermissionDecisionApproveForSessionApprovalWrite | PermissionDecisionApproveForSessionApprovalMCP | PermissionDecisionApproveForSessionApprovalMCPSampling | PermissionDecisionApproveForSessionApprovalMemory | PermissionDecisionApproveForSessionApprovalCustomTool | PermissionDecisionApproveForSessionApprovalExtensionManagement | PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess +PermissionDecisionApproveForSessionApproval = PermissionDecisionApproveForSessionApprovalCommands | PermissionDecisionApproveForSessionApprovalRead | PermissionDecisionApproveForSessionApprovalWrite | PermissionDecisionApproveForSessionApprovalMCP | PermissionDecisionApproveForSessionApprovalMCPSampling | PermissionDecisionApproveForSessionApprovalMemory | PermissionDecisionApproveForSessionApprovalCustomTool | PermissionDecisionApproveForSessionApprovalExtensionManagement | PermissionDecisionApproveForSessionApprovalFactory | PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess def _load_PermissionDecisionApproveForSessionApproval(obj: Any) -> "PermissionDecisionApproveForSessionApproval": assert isinstance(obj, dict) @@ -17497,11 +31965,12 @@ def _load_PermissionDecisionApproveForSessionApproval(obj: Any) -> "PermissionDe case "memory": return PermissionDecisionApproveForSessionApprovalMemory.from_dict(obj) case "custom-tool": return PermissionDecisionApproveForSessionApprovalCustomTool.from_dict(obj) case "extension-management": return PermissionDecisionApproveForSessionApprovalExtensionManagement.from_dict(obj) + case "factory": return PermissionDecisionApproveForSessionApprovalFactory.from_dict(obj) case "extension-permission-access": return PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionDecisionApproveForSessionApproval kind: {kind!r}") # Tool approval to persist and apply -PermissionsLocationsAddToolApprovalDetails = PermissionsLocationsAddToolApprovalDetailsCommands | PermissionsLocationsAddToolApprovalDetailsRead | PermissionsLocationsAddToolApprovalDetailsWrite | PermissionsLocationsAddToolApprovalDetailsMCP | PermissionsLocationsAddToolApprovalDetailsMCPSampling | PermissionsLocationsAddToolApprovalDetailsMemory | PermissionsLocationsAddToolApprovalDetailsCustomTool | PermissionsLocationsAddToolApprovalDetailsExtensionManagement | PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess +PermissionsLocationsAddToolApprovalDetails = PermissionsLocationsAddToolApprovalDetailsCommands | PermissionsLocationsAddToolApprovalDetailsRead | PermissionsLocationsAddToolApprovalDetailsWrite | PermissionsLocationsAddToolApprovalDetailsMCP | PermissionsLocationsAddToolApprovalDetailsMCPSampling | PermissionsLocationsAddToolApprovalDetailsMemory | PermissionsLocationsAddToolApprovalDetailsCustomTool | PermissionsLocationsAddToolApprovalDetailsExtensionManagement | PermissionsLocationsAddToolApprovalDetailsFactory | PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess def _load_PermissionsLocationsAddToolApprovalDetails(obj: Any) -> "PermissionsLocationsAddToolApprovalDetails": assert isinstance(obj, dict) @@ -17515,9 +31984,34 @@ def _load_PermissionsLocationsAddToolApprovalDetails(obj: Any) -> "PermissionsLo case "memory": return PermissionsLocationsAddToolApprovalDetailsMemory.from_dict(obj) case "custom-tool": return PermissionsLocationsAddToolApprovalDetailsCustomTool.from_dict(obj) case "extension-management": return PermissionsLocationsAddToolApprovalDetailsExtensionManagement.from_dict(obj) + case "factory": return PermissionsLocationsAddToolApprovalDetailsFactory.from_dict(obj) case "extension-permission-access": return PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionsLocationsAddToolApprovalDetails kind: {kind!r}") +# Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context. +PushAttachment = PushAttachmentFile | PushAttachmentDirectory | PushAttachmentSelection | PushAttachmentGitHubReference | PushAttachmentGitHubCommit | PushAttachmentGitHubRelease | PushAttachmentGitHubActionsJob | PushAttachmentGitHubRepository | PushAttachmentGitHubFileDiff | PushAttachmentGitHubTreeComparison | PushAttachmentGitHubURL | PushAttachmentGitHubFile | PushAttachmentGitHubSnippet | PushAttachmentBlob | ExtensionContextPushInput + +def _load_PushAttachment(obj: Any) -> "PushAttachment": + assert isinstance(obj, dict) + kind = obj.get("type") + match kind: + case "file": return PushAttachmentFile.from_dict(obj) + case "directory": return PushAttachmentDirectory.from_dict(obj) + case "selection": return PushAttachmentSelection.from_dict(obj) + case "github_reference": return PushAttachmentGitHubReference.from_dict(obj) + case "github_commit": return PushAttachmentGitHubCommit.from_dict(obj) + case "github_release": return PushAttachmentGitHubRelease.from_dict(obj) + case "github_actions_job": return PushAttachmentGitHubActionsJob.from_dict(obj) + case "github_repository": return PushAttachmentGitHubRepository.from_dict(obj) + case "github_file_diff": return PushAttachmentGitHubFileDiff.from_dict(obj) + case "github_tree_comparison": return PushAttachmentGitHubTreeComparison.from_dict(obj) + case "github_url": return PushAttachmentGitHubURL.from_dict(obj) + case "github_file": return PushAttachmentGitHubFile.from_dict(obj) + case "github_snippet": return PushAttachmentGitHubSnippet.from_dict(obj) + case "blob": return PushAttachmentBlob.from_dict(obj) + case "extension_context": return ExtensionContextPushInput.from_dict(obj) + case _: raise ValueError(f"Unknown PushAttachment type: {kind!r}") + # Result of the queued command execution. QueuedCommandResult = QueuedCommandHandled | QueuedCommandNotHandled @@ -17525,25 +32019,51 @@ def _load_QueuedCommandResult(obj: Any) -> "QueuedCommandResult": assert isinstance(obj, dict) kind = obj.get("handled") match kind: - case "true": return QueuedCommandHandled.from_dict(obj) - case "false": return QueuedCommandNotHandled.from_dict(obj) + case True: return QueuedCommandHandled.from_dict(obj) + case False: return QueuedCommandNotHandled.from_dict(obj) case _: raise ValueError(f"Unknown QueuedCommandResult handled: {kind!r}") -# A user message attachment — a file, directory, code selection, blob, or GitHub reference -SendAttachment = SendAttachmentFile | SendAttachmentDirectory | SendAttachmentSelection | SendAttachmentGithubReference | SendAttachmentBlob +# State of the runtime-managed remote-control singleton. +RemoteControlStatus = RemoteControlStatusOff | RemoteControlStatusConnecting | RemoteControlStatusActive | RemoteControlStatusError -def _load_SendAttachment(obj: Any) -> "SendAttachment": +def _load_RemoteControlStatus(obj: Any) -> "RemoteControlStatus": assert isinstance(obj, dict) - kind = obj.get("type") + kind = obj.get("state") + match kind: + case "off": return RemoteControlStatusOff.from_dict(obj) + case "connecting": return RemoteControlStatusConnecting.from_dict(obj) + case "active": return RemoteControlStatusActive.from_dict(obj) + case "error": return RemoteControlStatusError.from_dict(obj) + case _: raise ValueError(f"Unknown RemoteControlStatus state: {kind!r}") + +# Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields. +SessionListEntry = LocalSessionMetadataValue | RemoteSessionMetadataValue + +def _load_SessionListEntry(obj: Any) -> "SessionListEntry": + assert isinstance(obj, dict) + kind = obj.get("isRemote") + match kind: + case False: return LocalSessionMetadataValue.from_dict(obj) + case True: return RemoteSessionMetadataValue.from_dict(obj) + case _: raise ValueError(f"Unknown SessionListEntry isRemote: {kind!r}") + +# Open a session by creating, resuming, attaching, connecting to a remote, or handing off. +SessionOpenParams = SessionsOpenCreate | SessionsOpenResume | SessionsOpenResumeLast | SessionsOpenAttach | SessionsOpenRemote | SessionsOpenCloud | SessionsOpenHandoff + +def _load_SessionOpenParams(obj: Any) -> "SessionOpenParams": + assert isinstance(obj, dict) + kind = obj.get("kind") match kind: - case "file": return SendAttachmentFile.from_dict(obj) - case "directory": return SendAttachmentDirectory.from_dict(obj) - case "selection": return SendAttachmentSelection.from_dict(obj) - case "github_reference": return SendAttachmentGithubReference.from_dict(obj) - case "blob": return SendAttachmentBlob.from_dict(obj) - case _: raise ValueError(f"Unknown SendAttachment type: {kind!r}") - -# Result of invoking the slash command (text output, prompt to send to the agent, or completion). + case "create": return SessionsOpenCreate.from_dict(obj) + case "resume": return SessionsOpenResume.from_dict(obj) + case "resumeLast": return SessionsOpenResumeLast.from_dict(obj) + case "attach": return SessionsOpenAttach.from_dict(obj) + case "remote": return SessionsOpenRemote.from_dict(obj) + case "cloud": return SessionsOpenCloud.from_dict(obj) + case "handoff": return SessionsOpenHandoff.from_dict(obj) + case _: raise ValueError(f"Unknown SessionOpenParams kind: {kind!r}") + +# Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). SlashCommandInvocationResult = SlashCommandTextResult | SlashCommandAgentPromptResult | SlashCommandCompletedResult | SlashCommandSelectSubcommandResult def _load_SlashCommandInvocationResult(obj: Any) -> "SlashCommandInvocationResult": @@ -17556,7 +32076,7 @@ def _load_SlashCommandInvocationResult(obj: Any) -> "SlashCommandInvocationResul case "select-subcommand": return SlashCommandSelectSubcommandResult.from_dict(obj) case _: raise ValueError(f"Unknown SlashCommandInvocationResult kind: {kind!r}") -# Schema for the `TaskInfo` type. +# Tracked task union returned by task APIs, containing either an agent task or a shell task. TaskInfo = TaskAgentInfo | TaskShellInfo def _load_TaskInfo(obj: Any) -> "TaskInfo": @@ -17568,11 +32088,19 @@ def _load_TaskInfo(obj: Any) -> "TaskInfo": case _: raise ValueError(f"Unknown TaskInfo type: {kind!r}") +AccountGetAllUsersResult = list +AgentListRequest = Any CanvasActionInvokeResult = Any CanvasJsonSchema = Any +CommandsListRequest = Any ExternalToolResult = ExternalToolTextResultForLlm ExternalToolTextResultForLlmContentResourceLinkIconTheme = Theme FilterMapping = dict +HistoryCompactRequest = Any +InstructionDiscoveryPathKind = DebugCollectLogsEntryKind +InstructionDiscoveryPathLocation = InstructionLocation +InstructionSourceLocation = InstructionLocation +LlmInferenceHeaders = dict McpAppsHostContextDetailsAvailableDisplayMode = MCPAppsDisplayMode McpAppsHostContextDetailsDisplayMode = MCPAppsDisplayMode McpAppsHostContextDetailsTheme = Theme @@ -17582,12 +32110,35 @@ def _load_TaskInfo(obj: Any) -> "TaskInfo": McpAppsSetHostContextDetailsTheme = Theme McpExecuteSamplingRequest = dict McpExecuteSamplingResult = dict +McpOauthLoginGrantType = MCPGrantType McpServerAuthConfig = bool +McpServerConfigHttpOauthGrantType = MCPGrantType +MetadataSnapshotRemoteMetadataTaskType = TaskType +ModelListRequest = Any +OptionsUpdateAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope OptionsUpdateEnvValueMode = MCPSetEnvValueModeDetails +OptionsUpdateReasoningSummary = ReasoningSummary +PermissionsConfigureAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope PermissionsSetAllowAllSource = PermissionsSetAAllSource PermissionsSetApproveAllSource = PermissionsSetAAllSource +PluginsReloadRequest = Any +ProviderConfigTransport = ProviderTransport +ProviderConfigType = ProviderType +ProviderConfigWireApi = ProviderWireAPI +ProviderEndpointTransport = ProviderTransport +ProviderEndpointType = ProviderType +ProviderEndpointWireApi = ProviderWireAPI +ProviderGetEndpointRequest = Any +RemoteSessionMetadataTaskType = TaskType +SessionCancelAllBackgroundAgentsResult = int SessionContextHostType = HostType +SessionFsReaddirWithTypesEntryType = DebugCollectLogsEntryKind +SessionLimitPredictionRequest = Any SessionMcpAppsCallToolResult = dict +SessionOpenOptionsAdditionalContentExclusionPolicyScope = AdditionalContentExclusionPolicyScope +SessionOpenOptionsEnvValueMode = MCPSetEnvValueModeDetails +SessionOpenOptionsReasoningSummary = ReasoningSummary +SessionsOpenHandoffTaskType = TaskType SessionWorkingDirectoryContextHostType = HostType TaskInfoExecutionMode = TaskExecutionMode TaskInfoStatus = TaskStatus @@ -17622,6 +32173,7 @@ def _patch_model_capabilities(data: dict) -> dict: return data +# Experimental: this API group is experimental and may change or be removed. class ServerModelsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17631,7 +32183,12 @@ async def list(self, params: ModelsListRequest, *, timeout: float | None = None) params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return ModelList.from_dict(_patch_model_capabilities(await self._client.request("models.list", params_dict, **_timeout_kwargs(timeout)))) + async def get_built_in_catalog(self, *, timeout: float | None = None) -> BuiltInModelCatalog: + "Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access.\n\nReturns:\n The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata." + return BuiltInModelCatalog.from_dict(await self._client.request("models.getBuiltInCatalog", {}, **_timeout_kwargs(timeout))) + +# Experimental: this API group is experimental and may change or be removed. class ServerToolsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17642,6 +32199,7 @@ async def list(self, params: ToolsListRequest, *, timeout: float | None = None) return ToolList.from_dict(await self._client.request("tools.list", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. class ServerAccountApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17651,7 +32209,26 @@ async def get_quota(self, params: AccountGetQuotaRequest, *, timeout: float | No params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return AccountGetQuotaResult.from_dict(await self._client.request("account.getQuota", params_dict, **_timeout_kwargs(timeout))) + async def get_current_auth(self, *, timeout: float | None = None) -> AccountGetCurrentAuthResult: + "Gets the currently active authentication credentials from the global auth manager.\n\nReturns:\n Current authentication state" + return AccountGetCurrentAuthResult.from_dict(await self._client.request("account.getCurrentAuth", {}, **_timeout_kwargs(timeout))) + + async def get_all_users(self, *, timeout: float | None = None) -> list: + "Gets all authenticated users available for account switching.\n\nReturns:\n List of all authenticated users" + return list(await self._client.request("account.getAllUsers", {}, **_timeout_kwargs(timeout))) + + async def login(self, params: AccountLoginRequest, *, timeout: float | None = None) -> AccountLoginResult: + "Stores authentication credentials after successful login (e.g., device code flow).\n\nArgs:\n params: Credentials to store after successful authentication\n\nReturns:\n Result of a successful login; throws on failure" + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return AccountLoginResult.from_dict(await self._client.request("account.login", params_dict, **_timeout_kwargs(timeout))) + + async def logout(self, params: AccountLogoutRequest, *, timeout: float | None = None) -> AccountLogoutResult: + "Removes user authentication from keychain and persisted state.\n\nArgs:\n params: User to log out\n\nReturns:\n Logout result indicating if more users remain" + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return AccountLogoutResult.from_dict(await self._client.request("account.logout", params_dict, **_timeout_kwargs(timeout))) + +# Experimental: this API group is experimental and may change or be removed. class ServerSecretsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17662,6 +32239,7 @@ async def add_filter_values(self, params: SecretsAddFilterValuesRequest, *, time return SecretsAddFilterValuesResult.from_dict(await self._client.request("secrets.addFilterValues", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. class ServerMcpConfigApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17688,29 +32266,121 @@ async def remove(self, params: MCPConfigRemoveRequest, *, timeout: float | None async def enable(self, params: MCPConfigEnableRequest, *, timeout: float | None = None) -> None: "Enables MCP servers in user configuration for new sessions.\n\nArgs:\n params: MCP server names to enable for new sessions." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} - await self._client.request("mcp.config.enable", params_dict, **_timeout_kwargs(timeout)) + await self._client.request("mcp.config.enable", params_dict, **_timeout_kwargs(timeout)) + + async def disable(self, params: MCPConfigDisableRequest, *, timeout: float | None = None) -> None: + "Disables MCP servers in user configuration for new sessions.\n\nArgs:\n params: MCP server names to disable for new sessions." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("mcp.config.disable", params_dict, **_timeout_kwargs(timeout)) + + async def reload(self, *, timeout: float | None = None) -> None: + "Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk." + await self._client.request("mcp.config.reload", {}, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerMcpApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + self.config = ServerMcpConfigApi(client) + + async def discover(self, params: MCPDiscoverRequest, *, timeout: float | None = None) -> MCPDiscoverResult: + "Discovers MCP servers from user, workspace, plugin, and builtin sources.\n\nArgs:\n params: Optional working directory used as context for MCP server discovery.\n\nReturns:\n MCP servers discovered from user, workspace, plugin, and built-in sources." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return MCPDiscoverResult.from_dict(await self._client.request("mcp.discover", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerExtensionsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def discover(self, *, timeout: float | None = None) -> DiscoveredExtensions: + "Discovers user and enabled installed-plugin extensions from persisted Copilot home state, including enablement preferences. Launch-scoped additional plugins are not included.\n\nReturns:\n Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included." + return DiscoveredExtensions.from_dict(await self._client.request("extensions.discover", {}, **_timeout_kwargs(timeout))) + + async def enable(self, params: DiscoveredExtensionsEnableRequest, *, timeout: float | None = None) -> None: + "Persistently enables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.enable to update them.\n\nArgs:\n params: Source-qualified extension identifiers to persistently enable for future sessions." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("extensions.enable", params_dict, **_timeout_kwargs(timeout)) + + async def disable(self, params: DiscoveredExtensionsDisableRequest, *, timeout: float | None = None) -> None: + "Persistently disables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.disable to update them.\n\nArgs:\n params: Source-qualified extension identifiers to persistently disable for future sessions." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("extensions.disable", params_dict, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerPluginsMarketplacesApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def list(self, *, timeout: float | None = None) -> MarketplaceListResult: + "Lists all registered marketplaces (defaults + user-added).\n\nReturns:\n All registered marketplaces, including built-in defaults." + return MarketplaceListResult.from_dict(await self._client.request("plugins.marketplaces.list", {}, **_timeout_kwargs(timeout))) + + async def add(self, params: PluginsMarketplacesAddRequest, *, timeout: float | None = None) -> MarketplaceAddResult: + "Registers a new marketplace from a source (owner/repo, URL, or local path).\n\nArgs:\n params: Marketplace source and optional working directory for relative-path resolution.\n\nReturns:\n Result of registering a new marketplace." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return MarketplaceAddResult.from_dict(await self._client.request("plugins.marketplaces.add", params_dict, **_timeout_kwargs(timeout))) + + async def remove(self, params: PluginsMarketplacesRemoveRequest, *, timeout: float | None = None) -> MarketplaceRemoveResult: + "Removes a previously-registered marketplace. When the marketplace has dependent plugins and `force` is not set, the marketplace is left intact and the result lists the dependents so the caller can decide whether to retry with `force=true`.\n\nArgs:\n params: Name of the marketplace to remove and an optional force flag.\n\nReturns:\n Outcome of the remove attempt, including dependent-plugin info when applicable." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return MarketplaceRemoveResult.from_dict(await self._client.request("plugins.marketplaces.remove", params_dict, **_timeout_kwargs(timeout))) - async def disable(self, params: MCPConfigDisableRequest, *, timeout: float | None = None) -> None: - "Disables MCP servers in user configuration for new sessions.\n\nArgs:\n params: MCP server names to disable for new sessions." + async def browse(self, params: PluginsMarketplacesBrowseRequest, *, timeout: float | None = None) -> MarketplaceBrowseResult: + "Lists plugins advertised by a registered marketplace.\n\nArgs:\n params: Name of the marketplace whose plugin catalog to fetch.\n\nReturns:\n Plugins advertised by the marketplace." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} - await self._client.request("mcp.config.disable", params_dict, **_timeout_kwargs(timeout)) + return MarketplaceBrowseResult.from_dict(await self._client.request("plugins.marketplaces.browse", params_dict, **_timeout_kwargs(timeout))) - async def reload(self, *, timeout: float | None = None) -> None: - "Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk." - await self._client.request("mcp.config.reload", {}, **_timeout_kwargs(timeout)) + async def refresh(self, params: PluginsMarketplacesRefreshRequest, *, timeout: float | None = None) -> MarketplaceRefreshResult: + "Re-fetches one or all registered marketplace catalogs.\n\nArgs:\n params: Optional marketplace name; omit to refresh all.\n\nReturns:\n Result of refreshing one or more marketplace catalogs." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return MarketplaceRefreshResult.from_dict(await self._client.request("plugins.marketplaces.refresh", params_dict, **_timeout_kwargs(timeout))) -class ServerMcpApi: +# Experimental: this API group is experimental and may change or be removed. +class ServerPluginsApi: def __init__(self, client: "JsonRpcClient"): self._client = client - self.config = ServerMcpConfigApi(client) + self.marketplaces = ServerPluginsMarketplacesApi(client) - async def discover(self, params: MCPDiscoverRequest, *, timeout: float | None = None) -> MCPDiscoverResult: - "Discovers MCP servers from user, workspace, plugin, and builtin sources.\n\nArgs:\n params: Optional working directory used as context for MCP server discovery.\n\nReturns:\n MCP servers discovered from user, workspace, plugin, and built-in sources." + async def list(self, *, timeout: float | None = None) -> PluginListResult: + "Lists plugins installed in user/global state.\n\nReturns:\n Plugins installed in user/global state." + return PluginListResult.from_dict(await self._client.request("plugins.list", {}, **_timeout_kwargs(timeout))) + + async def install(self, params: PluginsInstallRequest, *, timeout: float | None = None) -> PluginInstallResult: + "Installs a plugin from a marketplace, GitHub repo, URL, or local path.\n\nArgs:\n params: Plugin source and optional working directory for relative-path resolution.\n\nReturns:\n Result of installing a plugin." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} - return MCPDiscoverResult.from_dict(await self._client.request("mcp.discover", params_dict, **_timeout_kwargs(timeout))) + return PluginInstallResult.from_dict(await self._client.request("plugins.install", params_dict, **_timeout_kwargs(timeout))) + + async def uninstall(self, params: PluginsUninstallRequest, *, timeout: float | None = None) -> None: + "Uninstalls an installed plugin.\n\nArgs:\n params: Name (or spec) of the plugin to uninstall." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("plugins.uninstall", params_dict, **_timeout_kwargs(timeout)) + + async def update(self, params: PluginsUpdateRequest, *, timeout: float | None = None) -> PluginUpdateResult: + "Updates an installed plugin to its latest published version.\n\nArgs:\n params: Name (or spec) of the plugin to update.\n\nReturns:\n Result of updating a single plugin." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return PluginUpdateResult.from_dict(await self._client.request("plugins.update", params_dict, **_timeout_kwargs(timeout))) + + async def update_all(self, *, timeout: float | None = None) -> PluginUpdateAllResult: + "Updates every installed plugin to its latest published version.\n\nReturns:\n Result of updating all installed plugins." + return PluginUpdateAllResult.from_dict(await self._client.request("plugins.updateAll", {}, **_timeout_kwargs(timeout))) + + async def enable(self, params: PluginsEnableRequest, *, timeout: float | None = None) -> None: + "Enables installed plugins for new sessions.\n\nArgs:\n params: Plugin names (or specs) to enable." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("plugins.enable", params_dict, **_timeout_kwargs(timeout)) + + async def disable(self, params: PluginsDisableRequest, *, timeout: float | None = None) -> None: + "Disables installed plugins for new sessions.\n\nArgs:\n params: Plugin names (or specs) to disable." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("plugins.disable", params_dict, **_timeout_kwargs(timeout)) +# Experimental: this API group is experimental and may change or be removed. class ServerSkillsConfigApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17721,6 +32391,7 @@ async def set_disabled_skills(self, params: SkillsConfigSetDisabledSkillsRequest await self._client.request("skills.config.setDisabledSkills", params_dict, **_timeout_kwargs(timeout)) +# Experimental: this API group is experimental and may change or be removed. class ServerSkillsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17731,7 +32402,55 @@ async def discover(self, params: SkillsDiscoverRequest, *, timeout: float | None params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return ServerSkillList.from_dict(await self._client.request("skills.discover", params_dict, **_timeout_kwargs(timeout))) + async def get_discovery_paths(self, params: SkillsGetDiscoveryPathsRequest, *, timeout: float | None = None) -> SkillDiscoveryPathList: + "Returns the canonical directories where a client may create skills that the runtime will recognize, including ones that do not exist yet. Project directories become active once created.\n\nArgs:\n params: Optional project paths to enumerate.\n\nReturns:\n Canonical locations where skills can be created so the runtime will recognize them." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SkillDiscoveryPathList.from_dict(await self._client.request("skills.getDiscoveryPaths", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerAgentsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def discover(self, params: AgentsDiscoverRequest, *, timeout: float | None = None) -> ServerAgentList: + "Discovers custom agents across user, project, plugin, and remote sources.\n\nArgs:\n params: Optional project paths to include in agent discovery.\n\nReturns:\n Agents discovered across user, project, plugin, and remote sources." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return ServerAgentList.from_dict(await self._client.request("agents.discover", params_dict, **_timeout_kwargs(timeout))) + + async def get_discovery_paths(self, params: AgentsGetDiscoveryPathsRequest, *, timeout: float | None = None) -> AgentDiscoveryPathList: + "Returns the canonical directories where a client may create custom agents that the runtime will recognize, including ones that do not exist yet. Project directories become active once created.\n\nArgs:\n params: Optional project paths to include when enumerating agent discovery directories.\n\nReturns:\n Canonical locations where custom agents can be created so the runtime will recognize them." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return AgentDiscoveryPathList.from_dict(await self._client.request("agents.getDiscoveryPaths", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerInstructionsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def discover(self, params: InstructionsDiscoverRequest, *, timeout: float | None = None) -> ServerInstructionSourceList: + "Discovers instruction sources across user, repository, and plugin sources.\n\nArgs:\n params: Optional project paths to include in instruction discovery.\n\nReturns:\n Instruction sources discovered across user, repository, and plugin sources." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return ServerInstructionSourceList.from_dict(await self._client.request("instructions.discover", params_dict, **_timeout_kwargs(timeout))) + + async def get_discovery_paths(self, params: InstructionsGetDiscoveryPathsRequest, *, timeout: float | None = None) -> InstructionDiscoveryPathList: + "Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created.\n\nArgs:\n params: Optional project paths to include when enumerating instruction discovery targets.\n\nReturns:\n Canonical files and directories where custom instructions can be created so the runtime will recognize them." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return InstructionDiscoveryPathList.from_dict(await self._client.request("instructions.getDiscoveryPaths", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerCommandsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def list(self, *, timeout: float | None = None) -> CommandList: + "Lists the well-known built-in slash commands that work as the first message in a new session (e.g. /plan, /env), without requiring an active session. Commands that depend on session state, authentication, or a synced session are omitted.\n\nReturns:\n Slash commands available in the session, after applying any include/exclude filters." + return CommandList.from_dict(await self._client.request("commands.list", {}, **_timeout_kwargs(timeout))) + +# Experimental: this API group is experimental and may change or be removed. class ServerUserSettingsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17740,13 +32459,44 @@ async def reload(self, *, timeout: float | None = None) -> None: "Drops this runtime process's in-memory user settings cache so the next settings read observes disk." await self._client.request("user.settings.reload", {}, **_timeout_kwargs(timeout)) + async def get(self, *, timeout: float | None = None) -> UserSettingsGetResult: + "Lists every known user setting (settings.json overlaid with the legacy config.json, config.json wins), each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time.\n\nReturns:\n Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides." + return UserSettingsGetResult.from_dict(await self._client.request("user.settings.get", {}, **_timeout_kwargs(timeout))) + + async def set(self, params: UserSettingsSetRequest, *, timeout: float | None = None) -> UserSettingsSetResult: + "Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed. Returns the keys whose new value is shadowed by a legacy config.json entry (config.json wins on read), which the runtime leaves in place — such writes do not take effect until the legacy value is removed.\n\nArgs:\n params: Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.\n\nReturns:\n Outcome of writing user settings." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return UserSettingsSetResult.from_dict(await self._client.request("user.settings.set", params_dict, **_timeout_kwargs(timeout))) + +# Experimental: this API group is experimental and may change or be removed. class ServerUserApi: def __init__(self, client: "JsonRpcClient"): self._client = client self.settings = ServerUserSettingsApi(client) +# Experimental: this API group is experimental and may change or be removed. +class ServerManagedSettingsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def read(self, *, timeout: float | None = None) -> ManagedSettingsReadResult: + "Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session.\n\nReturns:\n Validated device-managed settings discovered before a session exists." + return ManagedSettingsReadResult.from_dict(await self._client.request("managedSettings.read", {}, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class ServerRuntimeApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def shutdown(self, *, timeout: float | None = None) -> None: + "Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process." + await self._client.request("runtime.shutdown", {}, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. class ServerSessionFsApi: def __init__(self, client: "JsonRpcClient"): self._client = client @@ -17757,11 +32507,36 @@ async def set_provider(self, params: SessionFSSetProviderRequest, *, timeout: fl return SessionFSSetProviderResult.from_dict(await self._client.request("sessionFs.setProvider", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class ServerLlmInferenceApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def set_provider(self, *, timeout: float | None = None) -> LlmInferenceSetProviderResult: + "Registers an SDK client as the LLM inference callback provider.\n\nReturns:\n Indicates whether the calling client was registered as the LLM inference provider." + return LlmInferenceSetProviderResult.from_dict(await self._client.request("llmInference.setProvider", {}, **_timeout_kwargs(timeout))) + + async def http_response_start(self, params: LlmInferenceHTTPResponseStartRequest, *, timeout: float | None = None) -> LlmInferenceHTTPResponseStartResult: + "Delivers the response head (status + headers) for an in-flight request, correlated by the requestId the runtime supplied in httpRequestStart. Must be called exactly once per request before any httpResponseChunk frames.\n\nArgs:\n params: Response head.\n\nReturns:\n Whether the start frame was accepted." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return LlmInferenceHTTPResponseStartResult.from_dict(await self._client.request("llmInference.httpResponseStart", params_dict, **_timeout_kwargs(timeout))) + + async def http_response_chunk(self, params: LlmInferenceHTTPResponseChunkRequest, *, timeout: float | None = None) -> LlmInferenceHTTPResponseChunkResult: + "Delivers a body byte range (or a terminal transport error) for an in-flight response, correlated by requestId. Set `end` true on the last chunk. When `error` is set the response terminates with a transport-level failure and the runtime raises an APIConnectionError.\n\nArgs:\n params: A response body chunk or terminal error.\n\nReturns:\n Whether the chunk was accepted." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return LlmInferenceHTTPResponseChunkResult.from_dict(await self._client.request("llmInference.httpResponseChunk", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class ServerSessionsApi: def __init__(self, client: "JsonRpcClient"): self._client = client + async def open(self, params: SessionOpenParams, *, timeout: float | None = None) -> SessionOpenResult: + "Creates or resumes a local session and returns the opened session ID.\n\nArgs:\n params: Open a session by creating, resuming, attaching, connecting to a remote, or handing off.\n\nReturns:\n Result of opening a session." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionOpenResult.from_dict(await self._client.request("sessions.open", params_dict, **_timeout_kwargs(timeout))) + async def fork(self, params: SessionsForkRequest, *, timeout: float | None = None) -> SessionsForkResult: "Creates a new session by forking persisted history from an existing session.\n\nArgs:\n params: Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.\n\nReturns:\n Identifier and optional friendly name assigned to the newly forked session." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} @@ -17773,7 +32548,7 @@ async def connect(self, params: ConnectRemoteSessionParams, *, timeout: float | return RemoteSessionConnectionResult.from_dict(await self._client.request("sessions.connect", params_dict, **_timeout_kwargs(timeout))) async def list(self, params: SessionsListRequest, *, timeout: float | None = None) -> SessionList: - "Lists persisted sessions, optionally filtered by working-directory context.\n\nArgs:\n params: Optional metadata-load limit and filters applied to the returned sessions.\n\nReturns:\n Persisted sessions matching the filter, ordered most-recently-modified first." + "Lists sessions, optionally filtered by source and working-directory context. Returned entries are discriminated by `isRemote`: local entries carry only the lightweight `LocalSessionMetadataValue` shape; remote entries carry the full `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.).\n\nArgs:\n params: Optional source filter, metadata-load limit, and context filter applied to the returned sessions.\n\nReturns:\n Sessions matching the filter, ordered most-recently-modified first." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return SessionList.from_dict(await self._client.request("sessions.list", params_dict, **_timeout_kwargs(timeout))) @@ -17792,11 +32567,6 @@ async def get_last_for_context(self, params: SessionsGetLastForContextRequest, * params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return SessionsGetLastForContextResult.from_dict(await self._client.request("sessions.getLastForContext", params_dict, **_timeout_kwargs(timeout))) - async def get_event_file_path(self, params: SessionsGetEventFilePathRequest, *, timeout: float | None = None) -> SessionsGetEventFilePathResult: - "Computes the absolute path to a session's persisted events.jsonl file.\n\nArgs:\n params: Session ID whose event-log file path to compute.\n\nReturns:\n Absolute path to the session's events.jsonl file on disk." - params_dict = {k: v for k, v in params.to_dict().items() if v is not None} - return SessionsGetEventFilePathResult.from_dict(await self._client.request("sessions.getEventFilePath", params_dict, **_timeout_kwargs(timeout))) - async def get_sizes(self, *, timeout: float | None = None) -> SessionSizes: "Returns the on-disk byte size of each session's workspace directory.\n\nReturns:\n Map of sessionId -> on-disk size in bytes for each session's workspace directory." return SessionSizes.from_dict(await self._client.request("sessions.getSizes", {}, **_timeout_kwargs(timeout))) @@ -17806,11 +32576,6 @@ async def check_in_use(self, params: SessionsCheckInUseRequest, *, timeout: floa params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return SessionsCheckInUseResult.from_dict(await self._client.request("sessions.checkInUse", params_dict, **_timeout_kwargs(timeout))) - async def get_persisted_remote_steerable(self, params: SessionsGetPersistedRemoteSteerableRequest, *, timeout: float | None = None) -> SessionsGetPersistedRemoteSteerableResult: - "Returns a session's persisted remote-steerable flag, if any has been recorded.\n\nArgs:\n params: Session ID to look up the persisted remote-steerable flag for.\n\nReturns:\n The session's persisted remote-steerable flag, or omitted when no value has been persisted." - params_dict = {k: v for k, v in params.to_dict().items() if v is not None} - return SessionsGetPersistedRemoteSteerableResult.from_dict(await self._client.request("sessions.getPersistedRemoteSteerable", params_dict, **_timeout_kwargs(timeout))) - async def close(self, params: SessionsCloseRequest, *, timeout: float | None = None) -> SessionsCloseResult: "Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and disposes the active session.\n\nArgs:\n params: Session ID to close.\n\nReturns:\n Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} @@ -17856,6 +32621,30 @@ async def set_additional_plugins(self, params: SessionsSetAdditionalPluginsReque params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return SessionsSetAdditionalPluginsResult.from_dict(await self._client.request("sessions.setAdditionalPlugins", params_dict, **_timeout_kwargs(timeout))) + async def start_remote_control(self, params: SessionsStartRemoteControlRequest, *, timeout: float | None = None) -> RemoteControlStatusResult: + "Attaches the runtime-managed remote-control singleton to a session, awaiting initial setup. If remote control is already attached to a different session, the singleton is transferred (preserving the underlying Mission Control connection). Returns the final status.\n\nArgs:\n params: Parameters for attaching the remote-control singleton to a session.\n\nReturns:\n Wrapper for the singleton's current status." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return RemoteControlStatusResult.from_dict(await self._client.request("sessions.startRemoteControl", params_dict, **_timeout_kwargs(timeout))) + + async def transfer_remote_control(self, params: SessionsTransferRemoteControlRequest, *, timeout: float | None = None) -> RemoteControlTransferResult: + "Atomically rebinds the remote-control singleton to a different session, preserving the underlying Mission Control connection. When `expectedFromSessionId` is provided and does not match the singleton's current `attachedSessionId`, the transfer is rejected with `transferred: false` and the current status is returned unchanged.\n\nArgs:\n params: Parameters for atomically rebinding the remote-control singleton.\n\nReturns:\n Outcome of a transferRemoteControl call." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return RemoteControlTransferResult.from_dict(await self._client.request("sessions.transferRemoteControl", params_dict, **_timeout_kwargs(timeout))) + + async def set_remote_control_steering(self, params: SessionsSetRemoteControlSteeringRequest, *, timeout: float | None = None) -> RemoteControlStatusResult: + "Patches the steering state of the active remote-control singleton. When remote control is off, this is a no-op and the off status is returned. Today only `enabled: true` is actionable on the underlying exporter; passing `false` is reserved for future use.\n\nArgs:\n params: Patch for the singleton's steering state.\n\nReturns:\n Wrapper for the singleton's current status." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return RemoteControlStatusResult.from_dict(await self._client.request("sessions.setRemoteControlSteering", params_dict, **_timeout_kwargs(timeout))) + + async def stop_remote_control(self, params: SessionsStopRemoteControlRequest, *, timeout: float | None = None) -> RemoteControlStopResult: + "Stops the remote-control singleton. When `expectedSessionId` is provided and does not match the singleton's current `attachedSessionId`, the stop is rejected with `stopped: false` and the current status is returned unchanged (unless `force` is set, in which case the singleton is unconditionally torn down).\n\nArgs:\n params: Parameters for stopping the remote-control singleton.\n\nReturns:\n Outcome of a stopRemoteControl call." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return RemoteControlStopResult.from_dict(await self._client.request("sessions.stopRemoteControl", params_dict, **_timeout_kwargs(timeout))) + + async def get_remote_control_status(self, *, timeout: float | None = None) -> RemoteControlStatusResult: + "Returns the current state of the remote-control singleton, including the attached session id and frontend URL when active.\n\nReturns:\n Wrapper for the singleton's current status." + return RemoteControlStatusResult.from_dict(await self._client.request("sessions.getRemoteControlStatus", {}, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class ServerAgentRegistryApi: @@ -17877,44 +32666,116 @@ def __init__(self, client: "JsonRpcClient"): self.account = ServerAccountApi(client) self.secrets = ServerSecretsApi(client) self.mcp = ServerMcpApi(client) + self.extensions = ServerExtensionsApi(client) + self.plugins = ServerPluginsApi(client) self.skills = ServerSkillsApi(client) + self.agents = ServerAgentsApi(client) + self.instructions = ServerInstructionsApi(client) + self.commands = ServerCommandsApi(client) self.user = ServerUserApi(client) + self.managed_settings = ServerManagedSettingsApi(client) + self.runtime = ServerRuntimeApi(client) self.session_fs = ServerSessionFsApi(client) + self.llm_inference = ServerLlmInferenceApi(client) self.sessions = ServerSessionsApi(client) self.agent_registry = ServerAgentRegistryApi(client) async def ping(self, params: PingRequest, *, timeout: float | None = None) -> PingResult: - "Checks server responsiveness and returns protocol information.\n\nArgs:\n params: Optional message to echo back to the caller.\n\nReturns:\n Server liveness response, including the echoed message, current server timestamp, and protocol version." + "Checks server responsiveness and returns protocol information.\n\nArgs:\n params: Optional message to echo back to the caller.\n\nReturns:\n Server liveness response, including the echoed message, current server timestamp, and protocol version.\n\n.. warning:: This API is experimental and may change or be removed in future versions." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return PingResult.from_dict(await self._client.request("ping", params_dict, **_timeout_kwargs(timeout))) + async def register_extension_launch_provider(self, *, timeout: float | None = None) -> None: + "Registers the calling SDK client as the per-entrypoint extension launch provider. Call before creating any sessions. When omitted, the runtime temporarily falls back to its built-in Node launcher for backward compatibility.\n\n.. warning:: This API is experimental and may change or be removed in future versions." + await self._client.request("registerExtensionLaunchProvider", {}, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalServerSessionsApi: + def __init__(self, client: "JsonRpcClient"): + self._client = client + + async def _get_metadata(self, params: SessionsGetMetadataRequest, *, timeout: float | None = None) -> SessionsGetMetadataResult: + "Reads lightweight persisted metadata for one local session without opening it.\n\nArgs:\n params: Session ID whose persisted metadata should be read.\n\nReturns:\n Persisted local session metadata when the session exists.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionsGetMetadataResult.from_dict(await self._client.request("sessions.getMetadata", params_dict, **_timeout_kwargs(timeout))) + + async def _list_non_empty_session_ids(self, params: SessionsListNonEmptySessionIDSRequest, *, timeout: float | None = None) -> SessionsListNonEmptySessionIDSResult: + "Lists recent local session IDs that contain user-visible history, omitting housekeeping-only sessions.\n\nArgs:\n params: Limit for non-empty local session IDs.\n\nReturns:\n Recent local session IDs that contain user-visible history.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionsListNonEmptySessionIDSResult.from_dict(await self._client.request("sessions.listNonEmptySessionIds", params_dict, **_timeout_kwargs(timeout))) + + async def _get_event_file_path(self, params: SessionsGetEventFilePathRequest, *, timeout: float | None = None) -> SessionsGetEventFilePathResult: + "Computes the absolute path to a session's persisted events.jsonl file. Internal: filesystem paths are only meaningful in-process (CLI and runtime share a filesystem). Currently used by the CLI's contribution-graph feature to read historical events directly. Remote SDK consumers must not depend on this; a proper event-query API would replace it if the contribution graph ever needed to work over the wire.\n\nArgs:\n params: Session ID whose event-log file path to compute.\n\nReturns:\n Absolute path to the session's events.jsonl file on disk.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionsGetEventFilePathResult.from_dict(await self._client.request("sessions.getEventFilePath", params_dict, **_timeout_kwargs(timeout))) + + async def _get_persisted_remote_steerable(self, params: SessionsGetPersistedRemoteSteerableRequest, *, timeout: float | None = None) -> SessionsGetPersistedRemoteSteerableResult: + "Returns a session's persisted remote-steerable flag, if any has been recorded. Internal: this is CLI-specific book-keeping used by `--continue` / `--resume` to inherit the prior session's remote-steerable preference. SDK consumers that want similar behavior should manage their own persistence around start/stop calls rather than relying on this runtime-side flag.\n\nArgs:\n params: Session ID to look up the persisted remote-steerable flag for.\n\nReturns:\n The session's persisted remote-steerable flag, or omitted when no value has been persisted.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionsGetPersistedRemoteSteerableResult.from_dict(await self._client.request("sessions.getPersistedRemoteSteerable", params_dict, **_timeout_kwargs(timeout))) + + async def _delete(self, params: SessionsDeleteRequest, *, timeout: float | None = None) -> None: + "Deletes one local session from disk after running the same lifecycle hooks as the session manager.\n\nArgs:\n params: Session ID to delete from disk.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("sessions.delete", params_dict, **_timeout_kwargs(timeout)) + + async def _get_board_entry_count(self, params: SessionsGetBoardEntryCountRequest, *, timeout: float | None = None) -> SessionsGetBoardEntryCountResult: + "Gets the dynamic-context board entry count associated with a session, when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, `rem_consolidation_complete`) can pair START / END board counts around the detached rem-agent spawn. \"Dynamic context board\" is a runtime-internal concept that is not part of the public SDK contract; the long-term plan is to relocate the telemetry emission into the runtime so this method can be deleted entirely.\n\nArgs:\n params: Session ID whose board entry count should be returned.\n\nReturns:\n Dynamic-context board entry count, when available.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return SessionsGetBoardEntryCountResult.from_dict(await self._client.request("sessions.getBoardEntryCount", params_dict, **_timeout_kwargs(timeout))) + + async def _register_extension_tools_on_session(self, params: _RegisterExtensionToolsParams, *, timeout: float | None = None) -> _RegisterExtensionToolsResult: + "Registers extension-provided tools on the given session, gated by an optional `enabled` callback. Returns an opaque unsubscribe function the caller must invoke to deregister the tools when the extension is torn down. Marked internal because `loader`, `enabled`, and the returned `unsubscribe` are in-process handles that cannot cross the JSON-RPC boundary. Disappears once extension discovery / launch / tool registration are owned by the runtime: SDK consumers will pass pure config (search paths, disabled ids) via `SessionOptions` and the runtime will resolve, launch, register, and tear down extensions itself.\n\nArgs:\n params: Params to attach an extension loader's tools to a session.\n\nReturns:\n Handle for releasing the extension tool registration.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + return _RegisterExtensionToolsResult.from_dict(await self._client.request("sessions.registerExtensionToolsOnSession", params_dict, **_timeout_kwargs(timeout))) + + async def _configure_session_extensions(self, params: _ConfigureSessionExtensionsParams, *, timeout: float | None = None) -> None: + "Attaches (or detaches) an in-process ExtensionController delegate for the given session, used by shared-API surfaces that need to query or modify the session's extension state. Pass `controller: undefined` to detach. Marked internal because the controller is an in-process object that cannot cross the JSON-RPC boundary. Disappears alongside `registerExtensionToolsOnSession`: once the runtime owns extension management, the public surface exposes list/enable/disable/reload as dedicated RPCs served by the runtime.\n\nArgs:\n params: Params to attach or detach an in-process ExtensionController delegate.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict = {k: v for k, v in params.to_dict().items() if v is not None} + await self._client.request("sessions.configureSessionExtensions", params_dict, **_timeout_kwargs(timeout)) + class _InternalServerRpc: """Internal SDK server-scoped RPC methods. Not part of the public API.""" def __init__(self, client: "JsonRpcClient"): self._client = client + self.sessions = _InternalServerSessionsApi(client) async def _connect(self, params: _ConnectRequest, *, timeout: float | None = None) -> _ConnectResult: - "Performs the SDK server connection handshake and validates the optional connection token.\n\nArgs:\n params: Optional connection token presented by the SDK client during the handshake.\n\nReturns:\n Handshake result reporting the server's protocol version and package version on success.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + "Performs the SDK server connection handshake and validates the optional connection token. Marked internal because this is JSON-RPC transport plumbing invoked automatically by an SDK client's own `connect()` wrapper, not a user-facing method. Stays internal as long as the SDK client owns the handshake; would only become public if the SDK ever exposed the raw schema surface to consumers without a connection wrapper.\n\nArgs:\n params: Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding).\n\nReturns:\n Handshake result reporting the server's protocol version and package version on success.\n\n.. warning:: This API is experimental and may change or be removed in future versions.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." params_dict = {k: v for k, v in params.to_dict().items() if v is not None} return _ConnectResult.from_dict(await self._client.request("connect", params_dict, **_timeout_kwargs(timeout))) # Experimental: this API group is experimental and may change or be removed. -class AuthApi: +class GitHubAuthApi: def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id async def get_status(self, *, timeout: float | None = None) -> SessionAuthStatus: "Gets authentication status and account metadata for the session.\n\nReturns:\n Authentication status and account metadata for the session." - return SessionAuthStatus.from_dict(await self._client.request("session.auth.getStatus", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + return SessionAuthStatus.from_dict(await self._client.request("session.gitHubAuth.getStatus", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) async def set_credentials(self, params: SessionSetCredentialsParams, *, timeout: float | None = None) -> SessionSetCredentialsResult: "Updates the session's auth credentials used for outbound model and API requests.\n\nArgs:\n params: New auth credentials to install on the session. Omit to leave credentials unchanged.\n\nReturns:\n Indicates whether the credential update succeeded." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id - return SessionSetCredentialsResult.from_dict(await self._client.request("session.auth.setCredentials", params_dict, **_timeout_kwargs(timeout))) + return SessionSetCredentialsResult.from_dict(await self._client.request("session.gitHubAuth.setCredentials", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class DebugApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def collect_logs(self, params: DebugCollectLogsRequest, *, timeout: float | None = None) -> DebugCollectLogsResult: + "Collects a redacted session debug log bundle into a local archive or staging directory. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape.\n\nArgs:\n params: Options for collecting a redacted session debug bundle.\n\nReturns:\n Result of collecting a redacted debug bundle." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return DebugCollectLogsResult.from_dict(await self._client.request("session.debug.collectLogs", params_dict, **_timeout_kwargs(timeout))) # Experimental: this API group is experimental and may change or be removed. @@ -17958,6 +32819,87 @@ async def close(self, params: CanvasCloseRequest, *, timeout: float | None = Non await self._client.request("session.canvas.close", params_dict, **_timeout_kwargs(timeout)) +# Experimental: this API group is experimental and may change or be removed. +class FactoryJournalApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def get(self, params: FactoryJournalGetRequest, *, timeout: float | None = None) -> FactoryJournalGetResult: + "Reads a memoized factory journal entry.\n\nArgs:\n params: Parameters for reading a factory journal entry.\n\nReturns:\n Result of reading a factory journal entry." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryJournalGetResult.from_dict(await self._client.request("session.factory.journal.get", params_dict, **_timeout_kwargs(timeout))) + + async def put(self, params: FactoryJournalPutRequest, *, timeout: float | None = None) -> FactoryACKResult: + "Stores a memoized factory journal entry.\n\nArgs:\n params: Parameters for storing a factory journal entry.\n\nReturns:\n Acknowledgement that a factory request was accepted." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryACKResult.from_dict(await self._client.request("session.factory.journal.put", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class FactoryApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + self.journal = FactoryJournalApi(client, session_id) + + async def run(self, params: FactoryRunRequest, *, timeout: float | None = None) -> FactoryRunResult: + "Runs a registered factory by name at the top level.\n\nArgs:\n params: Parameters for invoking a registered factory.\n\nReturns:\n Complete current or terminal factory run envelope." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryRunResult.from_dict(await self._client.request("session.factory.run", params_dict, **_timeout_kwargs(timeout))) + + async def resume(self, params: FactoryResumeRequest, *, timeout: float | None = None) -> FactoryResumeResult: + "Resumes a factory run using its persisted name, arguments, journal, and accounting.\n\nArgs:\n params: Parameters for resuming a factory run from its persisted identity.\n\nReturns:\n Resolved persisted factory identity and resumed run envelope." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryResumeResult.from_dict(await self._client.request("session.factory.resume", params_dict, **_timeout_kwargs(timeout))) + + async def get_run(self, params: FactoryGetRunRequest, *, timeout: float | None = None) -> FactoryRunResult: + "Gets the current or settled envelope for a factory run.\n\nArgs:\n params: Parameters for retrieving a factory run.\n\nReturns:\n Complete current or terminal factory run envelope." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryRunResult.from_dict(await self._client.request("session.factory.getRun", params_dict, **_timeout_kwargs(timeout))) + + async def list_runs(self, params: FactoryListRunsRequest, *, timeout: float | None = None) -> FactoryListRunsResult: + "Lists durable factory runs for this session in creation order.\n\nArgs:\n params: Parameters for paging factory runs.\n\nReturns:\n A page of factory runs in durable creation order." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryListRunsResult.from_dict(await self._client.request("session.factory.listRuns", params_dict, **_timeout_kwargs(timeout))) + + async def get_run_detail(self, params: FactoryGetRunRequest, *, timeout: float | None = None) -> FactoryRunDetail: + "Gets durable and live observability detail for one factory run.\n\nArgs:\n params: Parameters for retrieving a factory run.\n\nReturns:\n Full factory run observability detail." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryRunDetail.from_dict(await self._client.request("session.factory.getRunDetail", params_dict, **_timeout_kwargs(timeout))) + + async def get_run_progress(self, params: FactoryGetRunProgressRequest, *, timeout: float | None = None) -> FactoryProgressPage: + "Pages durable progress for one factory run.\n\nArgs:\n params: Parameters for paging factory progress.\n\nReturns:\n A bidirectional page of factory progress." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryProgressPage.from_dict(await self._client.request("session.factory.getRunProgress", params_dict, **_timeout_kwargs(timeout))) + + async def cancel(self, params: FactoryCancelRequest, *, timeout: float | None = None) -> FactoryRunResult: + "Requests cancellation of a factory run and returns its run envelope.\n\nArgs:\n params: Parameters for cancelling a factory run.\n\nReturns:\n Complete current or terminal factory run envelope." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryRunResult.from_dict(await self._client.request("session.factory.cancel", params_dict, **_timeout_kwargs(timeout))) + + async def log(self, params: FactoryLogRequest, *, timeout: float | None = None) -> FactoryACKResult: + "Records a batch of ordered factory progress lines.\n\nArgs:\n params: Parameters for recording factory progress.\n\nReturns:\n Acknowledgement that a factory request was accepted." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryACKResult.from_dict(await self._client.request("session.factory.log", params_dict, **_timeout_kwargs(timeout))) + + async def agent(self, params: FactoryAgentRequest, *, timeout: float | None = None) -> FactoryAgentResult: + "Runs one factory-scoped subagent and returns its result.\n\nArgs:\n params: Parameters for one factory-scoped subagent call.\n\nReturns:\n Result of one factory-scoped subagent call." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return FactoryAgentResult.from_dict(await self._client.request("session.factory.agent", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class ModelApi: def __init__(self, client: "JsonRpcClient", session_id: str): @@ -17965,7 +32907,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._session_id = session_id async def get_current(self, *, timeout: float | None = None) -> CurrentModel: - "Gets the currently selected model for the session.\n\nReturns:\n The currently selected model, reasoning effort, and context tier for the session." + "Gets the currently selected model for the session.\n\nReturns:\n The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume." return CurrentModel.from_dict(await self._client.request("session.model.getCurrent", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) async def switch_to(self, params: ModelSwitchToRequest, *, timeout: float | None = None) -> ModelSwitchToResult: @@ -17980,7 +32922,7 @@ async def set_reasoning_effort(self, params: ModelSetReasoningEffortRequest, *, params_dict["sessionId"] = self._session_id return ModelSetReasoningEffortResult.from_dict(await self._client.request("session.model.setReasoningEffort", params_dict, **_timeout_kwargs(timeout))) - async def list(self, params: ModelListRequest | None = None, *, timeout: float | None = None) -> SessionModelList: + async def list(self, params: SessionModelListRequest | None = None, *, timeout: float | None = None) -> SessionModelList: "Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's.\n\nArgs:\n params: Optional listing options.\n\nReturns:\n The list of models available to this session." 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 {} params_dict["sessionId"] = self._session_id @@ -18047,6 +32989,14 @@ async def delete(self, *, timeout: float | None = None) -> None: "Deletes the session plan file from the workspace." await self._client.request("session.plan.delete", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + async def read_sql_todos(self, *, timeout: float | None = None) -> PlanReadSQLTodosResult: + "Reads todo rows from the session SQL database for plan rendering.\n\nReturns:\n Todo rows read from the session SQL database. Empty when no session database is available." + return PlanReadSQLTodosResult.from_dict(await self._client.request("session.plan.readSqlTodos", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def read_sql_todos_with_dependencies(self, *, timeout: float | None = None) -> PlanReadSQLTodosWithDependenciesResult: + "Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren't available. Clients should call this on session start and after every `session.todos_changed` event to refresh structured-UI rendering.\n\nReturns:\n Todo rows + dependency edges read from the session SQL database." + return PlanReadSQLTodosWithDependenciesResult.from_dict(await self._client.request("session.plan.readSqlTodosWithDependencies", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class WorkspacesApi: @@ -18058,6 +33008,18 @@ async def get_workspace(self, *, timeout: float | None = None) -> WorkspacesGetW "Gets current workspace metadata for the session.\n\nReturns:\n Current workspace metadata for the session, including its absolute filesystem path when available." return WorkspacesGetWorkspaceResult.from_dict(await self._client.request("session.workspaces.getWorkspace", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def update_metadata(self, params: WorkspacesUpdateMetadataRequest, *, timeout: float | None = None) -> WorkspacesGetWorkspaceResult: + "Updates workspace metadata for a local session and returns the refreshed workspace.\n\nArgs:\n params: Workspace metadata fields to update.\n\nReturns:\n Current workspace metadata for the session, including its absolute filesystem path when available." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return WorkspacesGetWorkspaceResult.from_dict(await self._client.request("session.workspaces.updateMetadata", params_dict, **_timeout_kwargs(timeout))) + + async def ensure(self, params: WorkspacesEnsureRequest, *, timeout: float | None = None) -> WorkspacesGetWorkspaceResult: + "Ensures a local session workspace exists and returns it.\n\nArgs:\n params: Optional session context used when creating a local workspace.\n\nReturns:\n Current workspace metadata for the session, including its absolute filesystem path when available." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return WorkspacesGetWorkspaceResult.from_dict(await self._client.request("session.workspaces.ensure", params_dict, **_timeout_kwargs(timeout))) + async def list_files(self, *, timeout: float | None = None) -> WorkspacesListFilesResult: "Lists files stored in the session workspace files directory.\n\nReturns:\n Relative paths of files stored in the session workspace files directory." return WorkspacesListFilesResult.from_dict(await self._client.request("session.workspaces.listFiles", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) @@ -18084,6 +33046,36 @@ async def read_checkpoint(self, params: WorkspacesReadCheckpointRequest, *, time params_dict["sessionId"] = self._session_id return WorkspacesReadCheckpointResult.from_dict(await self._client.request("session.workspaces.readCheckpoint", params_dict, **_timeout_kwargs(timeout))) + async def add_summary(self, params: WorkspacesAddSummaryRequest, *, timeout: float | None = None) -> WorkspacesAddSummaryResult: + "Adds a compaction summary checkpoint to the local session workspace.\n\nArgs:\n params: Compaction summary checkpoint to persist.\n\nReturns:\n Persisted summary metadata and refreshed workspace metadata." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return WorkspacesAddSummaryResult.from_dict(await self._client.request("session.workspaces.addSummary", params_dict, **_timeout_kwargs(timeout))) + + async def truncate_summaries(self, params: WorkspacesTruncateSummariesRequest, *, timeout: float | None = None) -> WorkspacesGetWorkspaceResult: + "Truncates local workspace compaction summaries after a rollback.\n\nArgs:\n params: Rollback point for local workspace summaries.\n\nReturns:\n Current workspace metadata for the session, including its absolute filesystem path when available." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return WorkspacesGetWorkspaceResult.from_dict(await self._client.request("session.workspaces.truncateSummaries", params_dict, **_timeout_kwargs(timeout))) + + async def read_autopilot_objective(self, *, timeout: float | None = None) -> WorkspacesReadAutopilotObjectiveResult: + "Reads the autopilot objective state file from the local session workspace.\n\nReturns:\n Autopilot objective file content, or null when missing." + return WorkspacesReadAutopilotObjectiveResult.from_dict(await self._client.request("session.workspaces.readAutopilotObjective", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def write_autopilot_objective(self, params: WorkspacesWriteAutopilotObjectiveRequest, *, timeout: float | None = None) -> WorkspacesWriteAutopilotObjectiveResult: + "Writes the autopilot objective state file in the local session workspace.\n\nArgs:\n params: Autopilot objective file content to persist.\n\nReturns:\n Result of writing the autopilot objective file." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return WorkspacesWriteAutopilotObjectiveResult.from_dict(await self._client.request("session.workspaces.writeAutopilotObjective", params_dict, **_timeout_kwargs(timeout))) + + async def delete_autopilot_objective(self, *, timeout: float | None = None) -> WorkspacesDeleteAutopilotObjectiveResult: + "Deletes the autopilot objective state file from the local session workspace.\n\nReturns:\n Result of deleting the autopilot objective file." + return WorkspacesDeleteAutopilotObjectiveResult.from_dict(await self._client.request("session.workspaces.deleteAutopilotObjective", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def autopilot_objective_exists(self, *, timeout: float | None = None) -> WorkspacesAutopilotObjectiveExistsResult: + "Checks whether the local session workspace has an autopilot objective state file.\n\nReturns:\n Whether the autopilot objective file exists." + return WorkspacesAutopilotObjectiveExistsResult.from_dict(await self._client.request("session.workspaces.autopilotObjectiveExists", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def save_large_paste(self, params: WorkspacesSaveLargePasteRequest, *, timeout: float | None = None) -> WorkspacesSaveLargePasteResult: "Saves pasted content as a UTF-8 file in the session workspace.\n\nArgs:\n params: Pasted content to save as a UTF-8 file in the session workspace.\n\nReturns:\n Descriptor for the saved paste file, or null when the workspace is unavailable." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18091,12 +33083,29 @@ async def save_large_paste(self, params: WorkspacesSaveLargePasteRequest, *, tim return WorkspacesSaveLargePasteResult.from_dict(await self._client.request("session.workspaces.saveLargePaste", params_dict, **_timeout_kwargs(timeout))) async def diff(self, params: WorkspacesDiffRequest, *, timeout: float | None = None) -> WorkspaceDiffResult: - "Computes a diff for the session workspace.\n\nArgs:\n params: Parameters for computing a workspace diff.\n\nReturns:\n Workspace diff result for the requested mode." + "Computes a diff for the session workspace. Never rejects for a busy session: a `session`-mode diff that cannot read the session's file-change captures falls back to an unstaged git diff with `isFallback: true` and reports why in `unavailableReason`.\n\nArgs:\n params: Parameters for computing a workspace diff.\n\nReturns:\n Workspace diff result for the requested mode." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return WorkspaceDiffResult.from_dict(await self._client.request("session.workspaces.diff", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class CompletionsApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def get_trigger_characters(self, *, timeout: float | None = None) -> CompletionsGetTriggerCharactersResult: + "Gets the characters that should trigger host-driven completions for the session. Empty disables host-driven completions (e.g. local sessions, or a relay host that does not advertise them).\n\nReturns:\n Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`)." + return CompletionsGetTriggerCharactersResult.from_dict(await self._client.request("session.completions.getTriggerCharacters", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def request(self, params: CompletionsRequestRequest, *, timeout: float | None = None) -> CompletionsRequestResult: + "Requests host-driven completion items for the current composer input. Returns an empty list when the host has no items or does not support completions.\n\nArgs:\n params: Request host-driven completions for the current composer input.\n\nReturns:\n Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return CompletionsRequestResult.from_dict(await self._client.request("session.completions.request", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class InstructionsApi: def __init__(self, client: "JsonRpcClient", session_id: str): @@ -18127,9 +33136,17 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id - async def list(self, *, timeout: float | None = None) -> AgentList: - "Lists custom agents available to the session.\n\nReturns:\n Custom agents available to the session." - return AgentList.from_dict(await self._client.request("session.agent.list", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def list(self, params: SessionAgentListRequest | None = None, *, timeout: float | None = None) -> AgentList: + "Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents.\n\nArgs:\n params: Controls whether built-in agents and authored prompt text are included.\n\nReturns:\n Agents available to the session." + 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 {} + params_dict["sessionId"] = self._session_id + return AgentList.from_dict(await self._client.request("session.agent.list", params_dict, **_timeout_kwargs(timeout))) + + async def set_prompt(self, params: AgentSetPromptRequest, *, timeout: float | None = None) -> None: + "Sets an in-memory authored prompt override for an available agent. For built-in agents, this replaces only the static base prompt while preserving runtime-owned dynamic prompt composition and behavior. The special `general-purpose` agent is not overrideable. Overrides are not persisted; resumed and forked sessions start without them, so the host must re-apply them.\n\nArgs:\n params: An in-memory authored prompt override for an available agent." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.agent.setPrompt", params_dict, **_timeout_kwargs(timeout)) async def get_current(self, *, timeout: float | None = None) -> AgentGetCurrentResult: "Gets the currently selected custom agent for the session.\n\nReturns:\n The currently selected custom agent, or null when using the default agent." @@ -18254,12 +33271,43 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id + async def handle_pending_request(self, params: MCPOauthHandlePendingRequest, *, timeout: float | None = None) -> MCPOauthHandlePendingResult: + "Resolves a pending MCP OAuth request with a host-provided token or cancellation. The pending request is emitted as mcp.oauth_required with the data necessary to authorize the request.\n\nArgs:\n params: Pending MCP OAuth request ID and host-provided token or cancellation response.\n\nReturns:\n Indicates whether the pending MCP OAuth response was accepted." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPOauthHandlePendingResult.from_dict(await self._client.request("session.mcp.oauth.handlePendingRequest", params_dict, **_timeout_kwargs(timeout))) + + async def authentication_state_changed(self, params: MCPOauthAuthenticationStateChangedRequest, *, timeout: float | None = None) -> None: + "Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed.\n\nArgs:\n params: Identifies the MCP server whose persisted OAuth credentials were updated." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.oauth.authenticationStateChanged", params_dict, **_timeout_kwargs(timeout)) + async def login(self, params: MCPOauthLoginRequest, *, timeout: float | None = None) -> MCPOauthLoginResult: - "Starts OAuth authentication for a remote MCP server.\n\nArgs:\n params: Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy.\n\nReturns:\n OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server." + "Starts OAuth authentication for a remote MCP server.\n\nArgs:\n params: Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.\n\nReturns:\n OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return MCPOauthLoginResult.from_dict(await self._client.request("session.mcp.oauth.login", params_dict, **_timeout_kwargs(timeout))) + async def respond(self, params: MCPOauthRespondRequest, *, timeout: float | None = None) -> MCPOauthRespondResult: + "Responds to a pending MCP OAuth authorization request by its request id.\n\nArgs:\n params: Pending MCP OAuth request id to respond to.\n\nReturns:\n Indicates whether the pending MCP OAuth response was accepted." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPOauthRespondResult.from_dict(await self._client.request("session.mcp.oauth.respond", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class McpHeadersApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def handle_pending_headers_refresh_request(self, params: MCPHeadersHandlePendingHeadersRefreshRequestRequest, *, timeout: float | None = None) -> MCPHeadersHandlePendingHeadersRefreshRequestResult: + "Responds to a pending MCP dynamic headers refresh request. Hosts that subscribe to `mcp.headers_refresh_required` use this to provide short-lived per-server headers or to indicate that no dynamic headers are available for this refresh.\n\nArgs:\n params: MCP headers refresh request id and the host response.\n\nReturns:\n Indicates whether the pending MCP headers refresh response was accepted." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPHeadersHandlePendingHeadersRefreshRequestResult.from_dict(await self._client.request("session.mcp.headers.handlePendingHeadersRefreshRequest", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class McpAppsApi: @@ -18279,27 +33327,52 @@ async def list_tools(self, params: MCPAppsListToolsRequest, *, timeout: float | params_dict["sessionId"] = self._session_id return MCPAppsListToolsResult.from_dict(await self._client.request("session.mcp.apps.listTools", params_dict, **_timeout_kwargs(timeout))) - async def call_tool(self, params: MCPAppsCallToolRequest, *, timeout: float | None = None) -> dict: - "Call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check that prevents an app iframe from invoking model-only tools. Returns the standard MCP `CallToolResult`.\n\nArgs:\n params: MCP server, tool name, and arguments to invoke from an MCP App view.\n\nReturns:\n Standard MCP CallToolResult" + async def call_tool(self, params: MCPAppsCallToolRequest, *, timeout: float | None = None) -> dict: + "Call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check that prevents an app iframe from invoking model-only tools. Returns the standard MCP `CallToolResult`.\n\nArgs:\n params: MCP server, tool name, and arguments to invoke from an MCP App view.\n\nReturns:\n Standard MCP CallToolResult" + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return dict(await self._client.request("session.mcp.apps.callTool", params_dict, **_timeout_kwargs(timeout))) + + async def set_host_context(self, params: MCPAppsSetHostContextRequest, *, timeout: float | None = None) -> None: + "Replace the host context returned to MCP App guests on `ui/initialize`. Hosts use this to advertise theme, locale, or other metadata to the guest UI.\n\nArgs:\n params: Host context to advertise to MCP App guests." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.apps.setHostContext", params_dict, **_timeout_kwargs(timeout)) + + async def get_host_context(self, *, timeout: float | None = None) -> MCPAppsHostContext: + "Read the current host context advertised to MCP App guests.\n\nReturns:\n Current host context advertised to MCP App guests." + return MCPAppsHostContext.from_dict(await self._client.request("session.mcp.apps.getHostContext", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def diagnose(self, params: MCPAppsDiagnoseRequest, *, timeout: float | None = None) -> MCPAppsDiagnoseResult: + "Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, feature-flag state, advertised extension, and how many tools have `_meta.ui` populated.\n\nArgs:\n params: MCP server to diagnose MCP Apps wiring for.\n\nReturns:\n Diagnostic snapshot of MCP Apps wiring for the named server." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPAppsDiagnoseResult.from_dict(await self._client.request("session.mcp.apps.diagnose", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class McpResourcesApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def read(self, params: MCPResourcesReadRequest, *, timeout: float | None = None) -> MCPResourcesReadResult: + "Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`).\n\nArgs:\n params: MCP server and resource URI to fetch.\n\nReturns:\n Resource contents returned by the MCP server." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id - return dict(await self._client.request("session.mcp.apps.callTool", params_dict, **_timeout_kwargs(timeout))) + return MCPResourcesReadResult.from_dict(await self._client.request("session.mcp.resources.read", params_dict, **_timeout_kwargs(timeout))) - async def set_host_context(self, params: MCPAppsSetHostContextRequest, *, timeout: float | None = None) -> None: - "Replace the host context returned to MCP App guests on `ui/initialize`. Hosts use this to advertise theme, locale, or other metadata to the guest UI.\n\nArgs:\n params: Host context to advertise to MCP App guests." + async def list(self, params: MCPResourcesListRequest, *, timeout: float | None = None) -> MCPResourcesListResult: + "Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`.\n\nArgs:\n params: MCP server whose resources to enumerate.\n\nReturns:\n One page of resources advertised by the named MCP server." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id - await self._client.request("session.mcp.apps.setHostContext", params_dict, **_timeout_kwargs(timeout)) - - async def get_host_context(self, *, timeout: float | None = None) -> MCPAppsHostContext: - "Read the current host context advertised to MCP App guests.\n\nReturns:\n Current host context advertised to MCP App guests." - return MCPAppsHostContext.from_dict(await self._client.request("session.mcp.apps.getHostContext", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + return MCPResourcesListResult.from_dict(await self._client.request("session.mcp.resources.list", params_dict, **_timeout_kwargs(timeout))) - async def diagnose(self, params: MCPAppsDiagnoseRequest, *, timeout: float | None = None) -> MCPAppsDiagnoseResult: - "Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, feature-flag state, advertised extension, and how many tools have `_meta.ui` populated.\n\nArgs:\n params: MCP server to diagnose MCP Apps wiring for.\n\nReturns:\n Diagnostic snapshot of MCP Apps wiring for the named server." + async def list_templates(self, params: MCPResourcesListTemplatesRequest, *, timeout: float | None = None) -> MCPResourcesListTemplatesResult: + "Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`.\n\nArgs:\n params: MCP server whose resource templates to enumerate.\n\nReturns:\n One page of resource templates advertised by the named MCP server." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id - return MCPAppsDiagnoseResult.from_dict(await self._client.request("session.mcp.apps.diagnose", params_dict, **_timeout_kwargs(timeout))) + return MCPResourcesListTemplatesResult.from_dict(await self._client.request("session.mcp.resources.listTemplates", params_dict, **_timeout_kwargs(timeout))) # Experimental: this API group is experimental and may change or be removed. @@ -18308,12 +33381,20 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id self.oauth = McpOauthApi(client, session_id) + self.headers = McpHeadersApi(client, session_id) self.apps = McpAppsApi(client, session_id) + self.resources = McpResourcesApi(client, session_id) async def list(self, *, timeout: float | None = None) -> MCPServerList: - "Lists MCP servers configured for the session and their connection status.\n\nReturns:\n MCP servers configured for the session, with their connection status." + "Lists MCP servers configured for the session, their connection status, and host-level state. The host-level state (disabled/filtered servers, failed/needs-auth/pending connections, mcp3p policy, full config) is empty/zero when no MCP host has been initialized for the session.\n\nReturns:\n MCP servers configured for the session, with their connection status and host-level state." return MCPServerList.from_dict(await self._client.request("session.mcp.list", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def list_tools(self, params: MCPListToolsRequest, *, timeout: float | None = None) -> MCPListToolsResult: + "Lists the tools exposed by a connected MCP server on this session's host. This performs a live `tools/list` request. Tool UI metadata is returned independently of whether MCP Apps rendering is enabled for the session.\n\nArgs:\n params: Server name whose tool list should be returned.\n\nReturns:\n Tools exposed by the connected MCP server. Throws when the server is not connected." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPListToolsResult.from_dict(await self._client.request("session.mcp.listTools", params_dict, **_timeout_kwargs(timeout))) + async def enable(self, params: MCPEnableRequest, *, timeout: float | None = None) -> None: "Enables an MCP server for the session.\n\nArgs:\n params: Name of the MCP server to enable for the session." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18352,6 +33433,30 @@ async def remove_git_hub(self, *, timeout: float | None = None) -> MCPRemoveGitH "Removes the auto-managed `github` MCP server when present.\n\nReturns:\n Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove)." return MCPRemoveGitHubResult.from_dict(await self._client.request("session.mcp.removeGitHub", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def start_server(self, params: MCPStartServerRequest, *, timeout: float | None = None) -> None: + "Starts an individual MCP server on the live session. Omit `config` for a config-free start-by-name of an already-configured server (reuses the server's already-registered configuration); supply `config` to start from a caller-supplied configuration. Session-scoped and ephemeral: the server is added to this session's running set only and is reaped when the session ends. Does NOT modify persistent user configuration (`mcp.config.*`), so it does not affect future sessions. The server surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / `session.mcp_server_status_changed` events like any other server.\n\nArgs:\n params: Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.startServer", params_dict, **_timeout_kwargs(timeout)) + + async def restart_server(self, params: MCPRestartServerRequest, *, timeout: float | None = None) -> None: + "Restarts an individual MCP server on the live session (stops then starts). Omit `config` for a config-free restart-by-name of an already-configured server; supply `config` to restart with a replacement configuration. Session-scoped and ephemeral: does NOT modify persistent user configuration (`mcp.config.*`).\n\nArgs:\n params: Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.restartServer", params_dict, **_timeout_kwargs(timeout)) + + async def stop_server(self, params: MCPStopServerRequest, *, timeout: float | None = None) -> None: + "Stops an individual MCP server on the session's host.\n\nArgs:\n params: Server name for an individual MCP server stop." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.stopServer", params_dict, **_timeout_kwargs(timeout)) + + async def is_server_running(self, params: MCPIsServerRunningRequest, *, timeout: float | None = None) -> MCPIsServerRunningResult: + "Checks whether a named MCP server is currently running on the session's host.\n\nArgs:\n params: Server name to check running status for.\n\nReturns:\n Whether the named MCP server is running." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPIsServerRunningResult.from_dict(await self._client.request("session.mcp.isServerRunning", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class PluginsApi: @@ -18363,6 +33468,31 @@ async def list(self, *, timeout: float | None = None) -> PluginList: "Lists plugins installed for the session.\n\nReturns:\n Plugins installed for the session, with their enabled state and version metadata." return PluginList.from_dict(await self._client.request("session.plugins.list", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def reload(self, params: SessionPluginsReloadRequest | None = None, *, timeout: float | None = None) -> None: + "Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.\n\nArgs:\n params: Optional flags controlling which side effects the reload performs." + 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 {} + params_dict["sessionId"] = self._session_id + await self._client.request("session.plugins.reload", params_dict, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class ProviderApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def get_endpoint(self, params: SessionProviderGetEndpointRequest | None = None, *, timeout: float | None = None) -> ProviderEndpoint: + "Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses.\n\nArgs:\n params: Optional model identifier to scope the endpoint snapshot to.\n\nReturns:\n A snapshot of the provider endpoint the session is currently configured to talk to." + 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 {} + params_dict["sessionId"] = self._session_id + return ProviderEndpoint.from_dict(await self._client.request("session.provider.getEndpoint", params_dict, **_timeout_kwargs(timeout))) + + async def add(self, params: ProviderAddRequest, *, timeout: float | None = None) -> ProviderAddResult: + "Adds BYOK providers and/or models to the session's registry at runtime, extending the additive registry built from the session's `providers`/`models` options. Both fields are optional, so a call may add providers only, models only, or both. Within a single call providers are registered before models, so a model may reference a provider added in the same call; across calls a model may reference any provider already registered (from session creation or a prior add). A model whose referenced provider is not registered by the end of the call is rejected. Newly added models become selectable via `model.list` / `model.switchTo` and are inherited by sub-agents spawned afterwards.\n\nArgs:\n params: BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.\n\nReturns:\n The selectable model entries synthesized for the models added by this call." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ProviderAddResult.from_dict(await self._client.request("session.provider.add", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class OptionsApi: @@ -18416,6 +33546,12 @@ async def reload(self, *, timeout: float | None = None) -> None: "Reloads extension definitions and processes for the session." await self._client.request("session.extensions.reload", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + async def send_attachments_to_message(self, params: SendAttachmentsToMessageParams, *, timeout: float | None = None) -> None: + "Push attachments into the next user-message turn from an extension. The host should surface them as composer pills and forward them via the next session.send call. Callable only by extension-owned connections.\n\nArgs:\n params: Parameters for session.extensions.sendAttachmentsToMessage." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.extensions.sendAttachmentsToMessage", params_dict, **_timeout_kwargs(timeout)) + # Experimental: this API group is experimental and may change or be removed. class ToolsApi: @@ -18437,6 +33573,12 @@ async def get_current_metadata(self, *, timeout: float | None = None) -> ToolsGe "Returns lightweight metadata for the session's currently initialized tools.\n\nReturns:\n Current lightweight tool metadata snapshot for the session." return ToolsGetCurrentMetadataResult.from_dict(await self._client.request("session.tools.getCurrentMetadata", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def update_subagent_settings(self, params: UpdateSubagentSettingsRequest, *, timeout: float | None = None) -> ToolsUpdateSubagentSettingsResult: + "Updates the current session's live subagent settings after user settings change. The persisted user settings remain the source of truth for future sessions.\n\nArgs:\n params: Subagent settings to apply to the current session\n\nReturns:\n Empty result after applying subagent settings" + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ToolsUpdateSubagentSettingsResult.from_dict(await self._client.request("session.tools.updateSubagentSettings", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class CommandsApi: @@ -18444,14 +33586,14 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id - async def list(self, params: CommandsListRequest | None = None, *, timeout: float | None = None) -> CommandList: + async def list(self, params: SessionCommandsListRequest | None = None, *, timeout: float | None = None) -> CommandList: "Lists slash commands available in the session.\n\nArgs:\n params: Optional filters controlling which command sources to include in the listing.\n\nReturns:\n Slash commands available in the session, after applying any include/exclude filters." 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 {} params_dict["sessionId"] = self._session_id return CommandList.from_dict(await self._client.request("session.commands.list", params_dict, **_timeout_kwargs(timeout))) async def invoke(self, params: CommandsInvokeRequest, *, timeout: float | None = None) -> SlashCommandInvocationResult: - "Invokes a slash command in the session.\n\nArgs:\n params: Slash command name and optional raw input string to invoke.\n\nReturns:\n Result of invoking the slash command (text output, prompt to send to the agent, or completion)." + "Invokes a slash command in the session.\n\nArgs:\n params: Slash command name and optional raw input string to invoke.\n\nReturns:\n Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection)." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return _load_SlashCommandInvocationResult(await self._client.request("session.commands.invoke", params_dict, **_timeout_kwargs(timeout))) @@ -18487,6 +33629,10 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id + async def get_engagement_id(self, *, timeout: float | None = None) -> SessionTelemetryEngagement: + "Gets the telemetry engagement ID currently associated with the session, when available.\n\nReturns:\n Telemetry engagement ID for the session, when available." + return SessionTelemetryEngagement.from_dict(await self._client.request("session.telemetry.getEngagementId", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def set_feature_overrides(self, params: TelemetrySetFeatureOverridesRequest, *, timeout: float | None = None) -> None: "Sets feature override key/value pairs to attach to subsequent telemetry events for the session.\n\nArgs:\n params: Feature override key/value pairs to attach to subsequent telemetry events from this session." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18500,6 +33646,12 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id + async def ephemeral_query(self, params: UIEphemeralQueryRequest, *, timeout: float | None = None) -> UIEphemeralQueryResult: + "Runs a transient no-tools model query against the current conversation context.\n\nArgs:\n params: Transient question to answer without adding it to conversation history.\n\nReturns:\n Transient answer generated from current conversation context." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return UIEphemeralQueryResult.from_dict(await self._client.request("session.ui.ephemeralQuery", params_dict, **_timeout_kwargs(timeout))) + async def elicitation(self, params: UIElicitationRequest, *, timeout: float | None = None) -> UIElicitationResponse: "Requests structured input from a UI-capable client.\n\nArgs:\n params: Prompt message and JSON schema describing the form fields to elicit from the user.\n\nReturns:\n The elicitation response (accept with form values, decline, or cancel)" params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18530,6 +33682,12 @@ async def handle_pending_auto_mode_switch(self, params: UIHandlePendingAutoModeS params_dict["sessionId"] = self._session_id return UIHandlePendingResult.from_dict(await self._client.request("session.ui.handlePendingAutoModeSwitch", params_dict, **_timeout_kwargs(timeout))) + async def handle_pending_session_limits_exhausted(self, params: UIHandlePendingSessionLimitsExhaustedRequest, *, timeout: float | None = None) -> UIHandlePendingResult: + "Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action.\n\nArgs:\n params: Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action.\n\nReturns:\n Indicates whether the pending UI request was resolved by this call." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return UIHandlePendingResult.from_dict(await self._client.request("session.ui.handlePendingSessionLimitsExhausted", params_dict, **_timeout_kwargs(timeout))) + async def handle_pending_exit_plan_mode(self, params: UIHandlePendingExitPlanModeRequest, *, timeout: float | None = None) -> UIHandlePendingResult: "Resolves a pending `exit_plan_mode.requested` event with the user's response.\n\nArgs:\n params: Request ID of a pending `exit_plan_mode.requested` event and the user's response.\n\nReturns:\n Indicates whether the pending UI request was resolved by this call." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18672,13 +33830,13 @@ async def set_approve_all(self, params: PermissionsSetApproveAllRequest, *, time return PermissionsSetApproveAllResult.from_dict(await self._client.request("session.permissions.setApproveAll", params_dict, **_timeout_kwargs(timeout))) async def set_allow_all(self, params: PermissionsSetAllowAllRequest, *, timeout: float | None = None) -> AllowAllPermissionSetResult: - "Enables or disables full allow-all permissions (tools, paths, and URLs) for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the unrestricted path and URL managers and emits `session.permissions_changed` on transition. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire.\n\nArgs:\n params: Whether to enable full allow-all permissions for the session.\n\nReturns:\n Indicates whether the operation succeeded and reports the post-mutation state." + "Sets the allow-all permission mode for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. The `on` mode swaps in unrestricted path and URL managers and emits `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths active while attaching LLM safety recommendations. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire.\n\nArgs:\n params: Allow-all mode to apply for the session.\n\nReturns:\n Indicates whether the operation succeeded and reports the post-mutation state." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return AllowAllPermissionSetResult.from_dict(await self._client.request("session.permissions.setAllowAll", params_dict, **_timeout_kwargs(timeout))) async def get_allow_all(self, *, timeout: float | None = None) -> AllowAllPermissionState: - "Returns whether full allow-all permissions are currently active for the session.\n\nReturns:\n Current full allow-all permission state." + "Returns the current allow-all permission mode for the session.\n\nReturns:\n Current allow-all permission mode." return AllowAllPermissionState.from_dict(await self._client.request("session.permissions.getAllowAll", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) async def modify_rules(self, params: PermissionsModifyRulesParams, *, timeout: float | None = None) -> PermissionsModifyRulesResult: @@ -18693,9 +33851,11 @@ async def set_required(self, params: PermissionsSetRequiredRequest, *, timeout: params_dict["sessionId"] = self._session_id return PermissionsSetRequiredResult.from_dict(await self._client.request("session.permissions.setRequired", params_dict, **_timeout_kwargs(timeout))) - async def reset_session_approvals(self, *, timeout: float | None = None) -> PermissionsResetSessionApprovalsResult: - "Clears session-scoped tool permission approvals.\n\nReturns:\n Indicates whether the operation succeeded." - return PermissionsResetSessionApprovalsResult.from_dict(await self._client.request("session.permissions.resetSessionApprovals", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def reset_session_approvals(self, params: PermissionsResetSessionApprovalsRequest, *, timeout: float | None = None) -> PermissionsResetSessionApprovalsResult: + "Clears session-scoped tool permission approvals.\n\nArgs:\n params: Clears session-scoped tool permission approvals, and optionally the location-scoped ones.\n\nReturns:\n Indicates whether the operation succeeded." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return PermissionsResetSessionApprovalsResult.from_dict(await self._client.request("session.permissions.resetSessionApprovals", params_dict, **_timeout_kwargs(timeout))) async def notify_prompt_shown(self, params: PermissionPromptShownNotification, *, timeout: float | None = None) -> PermissionsNotifyPromptShownResult: "Notifies the runtime that a permission prompt UI has been shown to the user.\n\nArgs:\n params: Notification payload describing the permission prompt that the client just rendered.\n\nReturns:\n Indicates whether the operation succeeded." @@ -18718,20 +33878,34 @@ async def is_processing(self, *, timeout: float | None = None) -> MetadataIsProc "Reports whether the local session is currently processing user/agent messages.\n\nReturns:\n Indicates whether the local session is currently processing a turn or background continuation." return MetadataIsProcessingResult.from_dict(await self._client.request("session.metadata.isProcessing", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def activity(self, *, timeout: float | None = None) -> SessionActivity: + "Returns a snapshot of activity flags for the session.\n\nReturns:\n Current activity flags for the session." + return SessionActivity.from_dict(await self._client.request("session.metadata.activity", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def context_info(self, params: MetadataContextInfoRequest, *, timeout: float | None = None) -> MetadataContextInfoResult: "Returns the token breakdown for the session's current context window for a given model.\n\nArgs:\n params: Model identifier and token limits used to compute the context-info breakdown.\n\nReturns:\n Token breakdown for the session's current context window, or null if uninitialized." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return MetadataContextInfoResult.from_dict(await self._client.request("session.metadata.contextInfo", params_dict, **_timeout_kwargs(timeout))) + async def get_context_attribution(self, *, timeout: float | None = None) -> MetadataContextAttributionResult: + "Returns the experimental per-source attribution breakdown of the session's current context window as a flat list of entries (skills, subagents, MCP servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via parentId), plus the successful compaction count. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. Returns null until the session has initialized its system prompt and tool metadata.\n\nReturns:\n Per-source attribution breakdown for the session's current context window, or null if uninitialized." + return MetadataContextAttributionResult.from_dict(await self._client.request("session.metadata.getContextAttribution", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def get_context_heaviest_messages(self, params: MetadataContextHeaviestMessagesRequest, *, timeout: float | None = None) -> MetadataContextHeaviestMessagesResult: + "Returns the largest individual messages currently in the session's context window, most-expensive first. Companion to `metadata.getContextAttribution`. Returns an empty list until the session has initialized.\n\nArgs:\n params: Parameters for the heaviest-messages query.\n\nReturns:\n The heaviest individual messages in the session's context window, most-expensive first." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MetadataContextHeaviestMessagesResult.from_dict(await self._client.request("session.metadata.getContextHeaviestMessages", params_dict, **_timeout_kwargs(timeout))) + async def record_context_change(self, params: MetadataRecordContextChangeRequest, *, timeout: float | None = None) -> MetadataRecordContextChangeResult: - "Records a working-directory/git context change and emits a `session.context_changed` event.\n\nArgs:\n params: Updated working-directory/git context to record on the session.\n\nReturns:\n Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode)." + "Records a working-directory/git context change and emits a `session.context_changed` event. For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event): a local session's working directory is authoritative and is moved via `metadata.setWorkingDirectory` (or an SDK `session.resume` that supplies a `workingDirectory`), not by this method.\n\nArgs:\n params: Updated working-directory/git context to record on the session.\n\nReturns:\n Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return MetadataRecordContextChangeResult.from_dict(await self._client.request("session.metadata.recordContextChange", params_dict, **_timeout_kwargs(timeout))) async def set_working_directory(self, params: MetadataSetWorkingDirectoryRequest, *, timeout: float | None = None) -> MetadataSetWorkingDirectoryResult: - "Updates the session's recorded working directory.\n\nArgs:\n params: Absolute path to set as the session's new working directory.\n\nReturns:\n Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path." + "Updates the session's working directory. For local sessions the target is validated first (an absolute path that exists on disk) and the permission primary directory is re-based; a rejected validation fails the call before any session state changes.\n\nArgs:\n params: Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is.\n\nReturns:\n Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return MetadataSetWorkingDirectoryResult.from_dict(await self._client.request("session.metadata.setWorkingDirectory", params_dict, **_timeout_kwargs(timeout))) @@ -18743,6 +33917,19 @@ async def recompute_context_tokens(self, params: MetadataRecomputeContextTokensR return MetadataRecomputeContextTokensResult.from_dict(await self._client.request("session.metadata.recomputeContextTokens", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class ContentExclusionApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def check_paths(self, params: ContentExclusionCheckPathsRequest, *, timeout: float | None = None) -> ContentExclusionCheckPathsResult: + "Checks local file system absolute paths within the session working directory against its content-exclusion policy. Results preserve input order. Unsupported paths/filesystems and unavailable policy evaluation return available false, and callers must treat every requested path as excluded.\n\nArgs:\n params: Local file system absolute paths within the session working directory to check against its content-exclusion policy.\n\nReturns:\n Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ContentExclusionCheckPathsResult.from_dict(await self._client.request("session.contentExclusion.checkPaths", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class ShellApi: def __init__(self, client: "JsonRpcClient", session_id: str): @@ -18750,17 +33937,29 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._session_id = session_id async def exec(self, params: ShellExecRequest, *, timeout: float | None = None) -> ShellExecResult: - "Starts a shell command and streams output through session notifications.\n\nArgs:\n params: Shell command to run, with optional working directory and timeout in milliseconds.\n\nReturns:\n Identifier of the spawned process, used to correlate streamed output and exit notifications." + "Starts a shell command and streams output through session notifications. The command runs as the leader of its own process group (POSIX) or in a dedicated job object (Windows), so a forced termination — via \"shell.kill\", the request timeout, or session disposal — signals that whole group/job rather than only the direct child. Two gaps are worth planning for: a command that exits on its own does not trigger that teardown, and on POSIX a descendant that moves itself into a new session or process group (for example via \"setsid\") leaves the signalled group, so either can leave a background process running.\n\nArgs:\n params: Shell command to run, with optional working directory and timeout in milliseconds.\n\nReturns:\n Identifier of the spawned process, used to correlate streamed output and exit notifications." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return ShellExecResult.from_dict(await self._client.request("session.shell.exec", params_dict, **_timeout_kwargs(timeout))) async def kill(self, params: ShellKillRequest, *, timeout: float | None = None) -> ShellKillResult: - "Sends a signal to a shell process previously started via \"shell.exec\".\n\nArgs:\n params: Identifier of a process previously returned by \"shell.exec\" and the signal to send.\n\nReturns:\n Indicates whether the signal was delivered; false if the process was unknown or already exited." + "Sends a signal to a shell process previously started via \"shell.exec\". The signal targets the command's whole process group (POSIX) or job object (Windows), so descendants still in that group are signalled too, not just the direct child. On POSIX a descendant that moved itself into a new session or process group (for example via \"setsid\") is no longer in the signalled group and survives.\n\nArgs:\n params: Identifier of a process previously returned by \"shell.exec\" and the signal to send.\n\nReturns:\n Indicates whether the signal was delivered; false if the process was unknown or already exited." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return ShellKillResult.from_dict(await self._client.request("session.shell.kill", params_dict, **_timeout_kwargs(timeout))) + async def execute_user_requested(self, params: ShellExecuteUserRequestedRequest, *, timeout: float | None = None) -> UserRequestedShellCommandResult: + "Executes a user-requested shell command through the session runtime.\n\nArgs:\n params: User-requested shell command and cancellation handle.\n\nReturns:\n Result of a user-requested shell command." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return UserRequestedShellCommandResult.from_dict(await self._client.request("session.shell.executeUserRequested", params_dict, **_timeout_kwargs(timeout))) + + async def cancel_user_requested(self, params: ShellCancelUserRequestedRequest, *, timeout: float | None = None) -> CancelUserRequestedShellCommandResult: + "Cancels a user-requested shell command by request ID.\n\nArgs:\n params: User-requested shell execution cancellation handle.\n\nReturns:\n Cancellation result for a user-requested shell command." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return CancelUserRequestedShellCommandResult.from_dict(await self._client.request("session.shell.cancelUserRequested", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class HistoryApi: @@ -18768,7 +33967,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id - async def compact(self, params: HistoryCompactRequest | None = None, *, timeout: float | None = None) -> HistoryCompactResult: + async def compact(self, params: SessionHistoryCompactRequest | None = None, *, timeout: float | None = None) -> HistoryCompactResult: "Compacts the session history to reduce context usage.\n\nArgs:\n params: Optional compaction parameters.\n\nReturns:\n Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown." 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 {} params_dict["sessionId"] = self._session_id @@ -18780,6 +33979,22 @@ async def truncate(self, params: HistoryTruncateRequest, *, timeout: float | Non params_dict["sessionId"] = self._session_id return HistoryTruncateResult.from_dict(await self._client.request("session.history.truncate", params_dict, **_timeout_kwargs(timeout))) + async def list_rewind_points(self, *, timeout: float | None = None) -> HistoryListRewindPointsResult: + "Lists the user turns that the session can rewind to. Never rejects for a busy session: rewind reads need the session's file-change captures to be settled, so a session that still holds active work answers with `unavailableReason: \"session-busy\"` and no points, which the caller can retry.\n\nReturns:\n Rewind points and file-change-tracking availability for the session." + return HistoryListRewindPointsResult.from_dict(await self._client.request("session.history.listRewindPoints", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def preview_rewind(self, params: HistoryPreviewRewindRequest, *, timeout: float | None = None) -> HistoryPreviewRewindResult: + "Previews the files that a conversation-and-files rewind would restore.\n\nArgs:\n params: Event boundary to preview for conversation-and-files rewind.\n\nReturns:\n Files and aggregate changes for a prospective rewind." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return HistoryPreviewRewindResult.from_dict(await self._client.request("session.history.previewRewind", params_dict, **_timeout_kwargs(timeout))) + + async def rewind(self, params: HistoryRewindRequest, *, timeout: float | None = None) -> HistoryRewindResult: + "Rewinds the session conversation, optionally restoring files changed by the discarded turns. Not crash-atomic: file restore and conversation truncation are separate stores, applied in that order, so a process crash between them can leave the workspace rewound while the conversation still contains the discarded turns. There is no recovery journal; re-running the same rewind is the recovery path for a crash before truncation lands, since file restore is idempotent (already-restored files are reported as skipped) and truncation is re-derived from the still-retained boundary event. After truncation lands that boundary no longer exists, so the same request is rejected; the only stage that can still be outstanding is snapshot pruning, whose failure leaves orphan snapshots the capture store tolerates. The reverse inconsistency cannot occur, because truncation is never applied before file restore succeeds.\n\nArgs:\n params: Boundary and mode for rewinding session history.\n\nReturns:\n Structured outcome of a rewind request." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return HistoryRewindResult.from_dict(await self._client.request("session.history.rewind", params_dict, **_timeout_kwargs(timeout))) + async def cancel_background_compaction(self, *, timeout: float | None = None) -> HistoryCancelBackgroundCompactionResult: "Cancels any in-progress background compaction on a local session.\n\nReturns:\n Indicates whether an in-progress background compaction was cancelled." return HistoryCancelBackgroundCompactionResult.from_dict(await self._client.request("session.history.cancelBackgroundCompaction", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) @@ -18792,6 +34007,12 @@ async def summarize_for_handoff(self, *, timeout: float | None = None) -> Histor "Produces a markdown summary of the session's conversation context for hand-off scenarios.\n\nReturns:\n Markdown summary of the conversation context (empty when not available)." return HistorySummarizeForHandoffResult.from_dict(await self._client.request("session.history.summarizeForHandoff", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def clear_context(self, params: HistoryClearContextRequest, *, timeout: float | None = None) -> HistoryClearContextResult: + "Clears the session's conversation history, keeping only system and developer messages, and seeds the fresh context window with a first user message. Must be called from inside a tool handler: the clear has to drop the results of the tool calls its wipe orphans, and it rejects when no tool call is in flight.\n\nArgs:\n params: Parameters for clearing the conversation and seeding the window that replaces it.\n\nReturns:\n What a successful clear removed. A clear that could not be applied rejects instead of reporting a count." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return HistoryClearContextResult.from_dict(await self._client.request("session.history.clearContext", params_dict, **_timeout_kwargs(timeout))) + # Experimental: this API group is experimental and may change or be removed. class QueueApi: @@ -18803,6 +34024,48 @@ async def pending_items(self, *, timeout: float | None = None) -> QueuePendingIt "Returns the local session's pending user-facing queued items and steering messages.\n\nReturns:\n Snapshot of the session's pending queued items and immediate-steering messages." return QueuePendingItemsResult.from_dict(await self._client.request("session.queue.pendingItems", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def move_item(self, params: QueueMoveItemRequest, *, timeout: float | None = None) -> QueueMoveItemResult: + "Moves an addressable queued item to a public visible position.\n\nArgs:\n params: Parameters for moving a queued item by stable id.\n\nReturns:\n Result of moving a queued item." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueMoveItemResult.from_dict(await self._client.request("session.queue.moveItem", params_dict, **_timeout_kwargs(timeout))) + + async def insert_at(self, params: QueueInsertAtRequest, *, timeout: float | None = None) -> QueueInsertAtResult: + "Inserts a new queued message at a public visible position.\n\nArgs:\n params: Parameters for inserting a queued message at a public visible position.\n\nReturns:\n Result of inserting a queued message." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueInsertAtResult.from_dict(await self._client.request("session.queue.insertAt", params_dict, **_timeout_kwargs(timeout))) + + async def remove_at(self, params: QueueRemoveAtRequest, *, timeout: float | None = None) -> QueueRemoveAtResult: + "Removes an addressable queued item by its stable id.\n\nArgs:\n params: Parameters for removing a queued item by stable id.\n\nReturns:\n Result of removing a queued item." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueRemoveAtResult.from_dict(await self._client.request("session.queue.removeAt", params_dict, **_timeout_kwargs(timeout))) + + async def update_text(self, params: QueueUpdateTextRequest, *, timeout: float | None = None) -> QueueUpdateTextResult: + "Updates the text of an addressable single-message queue item.\n\nArgs:\n params: Parameters for editing a single queued message.\n\nReturns:\n Result of editing a queued message." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueUpdateTextResult.from_dict(await self._client.request("session.queue.updateText", params_dict, **_timeout_kwargs(timeout))) + + async def duplicate_at(self, params: QueueDuplicateAtRequest, *, timeout: float | None = None) -> QueueDuplicateAtResult: + "Duplicates an addressable queued item immediately after its source.\n\nArgs:\n params: Parameters for duplicating a queued item.\n\nReturns:\n Result of duplicating a queued item." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueDuplicateAtResult.from_dict(await self._client.request("session.queue.duplicateAt", params_dict, **_timeout_kwargs(timeout))) + + async def set_drain_paused(self, params: QueueSetDrainPausedRequest, *, timeout: float | None = None) -> None: + "Acquires or releases the queued-lane drain pause.\n\nArgs:\n params: Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.queue.setDrainPaused", params_dict, **_timeout_kwargs(timeout)) + + async def send_now(self, params: QueueSendNowRequest, *, timeout: float | None = None) -> QueueSendNowResult: + "Moves an addressable queued message into the live turn's steering lane.\n\nArgs:\n params: Parameters for steering a queued message into a live turn.\n\nReturns:\n Result of trying to steer a queued message into a live turn." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueSendNowResult.from_dict(await self._client.request("session.queue.sendNow", params_dict, **_timeout_kwargs(timeout))) + async def remove_most_recent(self, *, timeout: float | None = None) -> QueueRemoveMostRecentResult: "Removes the most recently queued user-facing item (LIFO).\n\nReturns:\n Indicates whether a user-facing pending item was removed." return QueueRemoveMostRecentResult.from_dict(await self._client.request("session.queue.removeMostRecent", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) @@ -18819,7 +34082,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self._session_id = session_id async def read(self, params: EventLogReadRequest, *, timeout: float | None = None) -> EventsReadResult: - "Reads a batch of session events from a cursor, optionally waiting for new events.\n\nArgs:\n params: Cursor, batch size, and optional long-poll/filter parameters for reading session events.\n\nReturns:\n Batch of session events returned by a read, with cursor and continuation metadata." + "Reads a batch of session events from a cursor, optionally waiting for new events. Supports tail-first reads via `direction: backward`.\n\nArgs:\n params: Cursor, batch size, and optional long-poll/filter parameters for reading session events.\n\nReturns:\n Batch of session events returned by a read, with cursor and continuation metadata." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return EventsReadResult.from_dict(await self._client.request("session.eventLog.read", params_dict, **_timeout_kwargs(timeout))) @@ -18852,6 +34115,19 @@ async def get_metrics(self, *, timeout: float | None = None) -> UsageGetMetricsR return UsageGetMetricsResult.from_dict(await self._client.request("session.usage.getMetrics", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class LimitPredictionApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def predict(self, params: SessionLimitPredictionPredictRequest | None = None, *, timeout: float | None = None) -> SessionLimitPredictionResult: + "Predicts an AI-credit session limit for the session's resolved model. Returns an unavailable result instead of falling back when the current model is unresolved auto.\n\nArgs:\n params: Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model.\n\nReturns:\n Prediction result. Available results include prediction details; unavailable results include an explicit reason." + 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 {} + params_dict["sessionId"] = self._session_id + return SessionLimitPredictionResult.from_dict(await self._client.request("session.limitPrediction.predict", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class RemoteApi: def __init__(self, client: "JsonRpcClient", session_id: str): @@ -18875,6 +34151,23 @@ async def notify_steerable_changed(self, params: RemoteNotifySteerableChangedReq return RemoteNotifySteerableChangedResult.from_dict(await self._client.request("session.remote.notifySteerableChanged", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class VisibilityApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def get(self, *, timeout: float | None = None) -> VisibilityGetResult: + "Returns the session's current Mission Control sharing status and shareable GitHub URL. Reflects whether the synced session is visible to repository readers (\"repo\") or restricted to its creator and collaborators (\"unshared\").\n\nReturns:\n Current sharing status and shareable GitHub URL for a session." + return VisibilityGetResult.from_dict(await self._client.request("session.visibility.get", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def set(self, params: VisibilitySetRequest, *, timeout: float | None = None) -> VisibilitySetResult: + "Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers. Returns the effective status and shareable GitHub URL after the change.\n\nArgs:\n params: Desired sharing status for the session.\n\nReturns:\n Effective sharing status and shareable GitHub URL after updating session visibility." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return VisibilitySetResult.from_dict(await self._client.request("session.visibility.set", params_dict, **_timeout_kwargs(timeout))) + + # Experimental: this API group is experimental and may change or be removed. class ScheduleApi: def __init__(self, client: "JsonRpcClient", session_id: str): @@ -18897,13 +34190,16 @@ class SessionRpc: def __init__(self, client: "JsonRpcClient", session_id: str): self._client = client self._session_id = session_id - self.auth = AuthApi(client, session_id) + self.git_hub_auth = GitHubAuthApi(client, session_id) + self.debug = DebugApi(client, session_id) self.canvas = CanvasApi(client, session_id) + self.factory = FactoryApi(client, session_id) self.model = ModelApi(client, session_id) self.mode = ModeApi(client, session_id) self.name = NameApi(client, session_id) self.plan = PlanApi(client, session_id) self.workspaces = WorkspacesApi(client, session_id) + self.completions = CompletionsApi(client, session_id) self.instructions = InstructionsApi(client, session_id) self.fleet = FleetApi(client, session_id) self.agent = AgentApi(client, session_id) @@ -18911,6 +34207,7 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self.skills = SkillsApi(client, session_id) self.mcp = McpApi(client, session_id) self.plugins = PluginsApi(client, session_id) + self.provider = ProviderApi(client, session_id) self.options = OptionsApi(client, session_id) self.lsp = LspApi(client, session_id) self.extensions = ExtensionsApi(client, session_id) @@ -18920,12 +34217,15 @@ def __init__(self, client: "JsonRpcClient", session_id: str): self.ui = UiApi(client, session_id) self.permissions = PermissionsApi(client, session_id) self.metadata = MetadataApi(client, session_id) + self.content_exclusion = ContentExclusionApi(client, session_id) self.shell = ShellApi(client, session_id) self.history = HistoryApi(client, session_id) self.queue = QueueApi(client, session_id) self.event_log = EventLogApi(client, session_id) self.usage = UsageApi(client, session_id) + self.limit_prediction = LimitPredictionApi(client, session_id) self.remote = RemoteApi(client, session_id) + self.visibility = VisibilityApi(client, session_id) self.schedule = ScheduleApi(client, session_id) async def suspend(self, *, timeout: float | None = None) -> None: @@ -18938,12 +34238,28 @@ async def send(self, params: SendRequest, *, timeout: float | None = None) -> Se params_dict["sessionId"] = self._session_id return SendResult.from_dict(await self._client.request("session.send", params_dict, **_timeout_kwargs(timeout))) + async def send_messages(self, params: SendMessagesRequest, *, timeout: float | None = None) -> SendMessagesResult: + "Sends zero or more user messages to the session in a single turn and returns their message IDs. All provided messages are appended to the conversation in order, then exactly one agent turn runs over the resulting history. When the list is empty, one turn runs over the existing history with no new user message. Remote-backed (Mission Control) sessions do not support this method and will return an error.\n\nArgs:\n params: Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error.\n\nReturns:\n Result of sending zero or more user messages\n\n.. warning:: This API is experimental and may change or be removed in future versions." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return SendMessagesResult.from_dict(await self._client.request("session.sendMessages", params_dict, **_timeout_kwargs(timeout))) + async def abort(self, params: AbortRequest, *, timeout: float | None = None) -> AbortResult: "Aborts the current agent turn.\n\nArgs:\n params: Parameters for aborting the current turn\n\nReturns:\n Result of aborting the current turn\n\n.. warning:: This API is experimental and may change or be removed in future versions." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} params_dict["sessionId"] = self._session_id return AbortResult.from_dict(await self._client.request("session.abort", params_dict, **_timeout_kwargs(timeout))) + async def interrupt_main_turn(self, params: InterruptMainTurnRequest, *, timeout: float | None = None) -> InterruptMainTurnResult: + "Interrupts the current main agent turn while leaving running background work (subagents, sidekicks, and promoted attached shells) alive. No-op when the main loop is not processing.\n\nArgs:\n params: Parameters for interrupting the main agent turn.\n\nReturns:\n Result of interrupting the main agent turn.\n\n.. warning:: This API is experimental and may change or be removed in future versions." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return InterruptMainTurnResult.from_dict(await self._client.request("session.interruptMainTurn", params_dict, **_timeout_kwargs(timeout))) + + async def cancel_all_background_agents(self, *, timeout: float | None = None) -> int: + "Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop. Promoted attached shells are left running.\n\nReturns:\n The number of running background agents (task-registry agents) that were cancelled.\n\n.. warning:: This API is experimental and may change or be removed in future versions." + return int(await self._client.request("session.cancelAllBackgroundAgents", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + async def shutdown(self, params: ShutdownRequest, *, timeout: float | None = None) -> None: "Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down.\n\nArgs:\n params: Parameters for shutting down the session\n\n.. warning:: This API is experimental and may change or be removed in future versions." params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} @@ -18957,6 +34273,178 @@ async def log(self, params: LogRequest, *, timeout: float | None = None) -> LogR return LogResult.from_dict(await self._client.request("session.log", params_dict, **_timeout_kwargs(timeout))) +# Experimental: this API group is experimental and may change or be removed. +class _InternalMcpApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _reload_with_config(self, params: MCPReloadWithConfigRequest, *, timeout: float | None = None) -> MCPStartServersResult: + "Reloads MCP server connections for the session with an explicit host-provided configuration.\n\nArgs:\n params: Opaque MCP reload configuration.\n\nReturns:\n MCP server startup filtering result.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPStartServersResult.from_dict(await self._client.request("session.mcp.reloadWithConfig", params_dict, **_timeout_kwargs(timeout))) + + async def _configure_git_hub(self, params: MCPConfigureGitHubRequest, *, timeout: float | None = None) -> MCPConfigureGitHubResult: + "Configures the built-in GitHub MCP server for the session's current auth context.\n\nArgs:\n params: Opaque auth info used to configure GitHub MCP.\n\nReturns:\n Result of configuring GitHub MCP.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return MCPConfigureGitHubResult.from_dict(await self._client.request("session.mcp.configureGitHub", params_dict, **_timeout_kwargs(timeout))) + + async def _register_external_client(self, params: MCPRegisterExternalClientRequest, *, timeout: float | None = None) -> None: + "Registers a pre-connected external MCP client (e.g. IDE) on the session's host. The caller retains lifecycle ownership of the client and transport. Marked internal because the `client` and `transport` arguments are in-process MCP SDK instances that cannot be serialized across the JSON-RPC boundary; once the CLI moves on top of the SDK, external clients will be expressed as transport configs the runtime can construct itself.\n\nArgs:\n params: Registration parameters for an external MCP client.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.registerExternalClient", params_dict, **_timeout_kwargs(timeout)) + + async def _unregister_external_client(self, params: MCPUnregisterExternalClientRequest, *, timeout: float | None = None) -> None: + "Unregisters a previously registered external MCP client by server name. Marked internal as the paired companion of `registerExternalClient`: only in-process callers that registered a client this way can meaningfully unregister it. Disappears alongside `registerExternalClient`: once external clients are described to the runtime as config rather than handed in as instances, lifecycle (including deregistration) is owned entirely by the runtime.\n\nArgs:\n params: Server name identifying the external client to remove.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.mcp.unregisterExternalClient", params_dict, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalSettingsApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _snapshot(self, *, timeout: float | None = None) -> SessionSettingsSnapshot: + "Returns a redacted snapshot of session runtime settings, with secrets and raw feature flags excluded. Internal: the runtime settings shape is a runtime-internal surface and is deliberately kept out of the public SDK, because consumers should not depend on the runtime's internal settings layout. It remains callable in-process and is expected to be reworked as the runtime internals are consolidated.\n\nReturns:\n Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return SessionSettingsSnapshot.from_dict(await self._client.request("session.settings.snapshot", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _evaluate_predicate(self, params: SessionSettingsEvaluatePredicateRequest, *, timeout: float | None = None) -> SessionSettingsEvaluatePredicateResult: + "Evaluates a named Rust-owned settings predicate without exposing raw feature flags. Internal: the raw feature-flag names and composition are runtime-internal, so this predicate-evaluation helper is kept out of the public SDK surface and is callable in-process only.\n\nArgs:\n params: Named Rust-owned settings predicate to evaluate for this session.\n\nReturns:\n Result of evaluating a Rust-owned settings predicate.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return SessionSettingsEvaluatePredicateResult.from_dict(await self._client.request("session.settings.evaluatePredicate", params_dict, **_timeout_kwargs(timeout))) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalQueueApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _snapshot(self, *, timeout: float | None = None) -> QueueSnapshotResult: + "Returns the internal native queue snapshot for in-process session orchestration.\n\nReturns:\n Internal snapshot of native queue state for local session orchestration.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return QueueSnapshotResult.from_dict(await self._client.request("session.queue.snapshot", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _has_pending(self, *, timeout: float | None = None) -> QueueHasPendingResult: + "Reports whether the local session has native queued work pending.\n\nReturns:\n Whether the native queue has pending work.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return QueueHasPendingResult.from_dict(await self._client.request("session.queue.hasPending", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _begin_deferred_idle_drain(self, params: QueueBeginDeferredIdleDrainRequest, *, timeout: float | None = None) -> QueueBeginDeferredIdleDrainResult: + "Begins a native deferred-idle drain when background work has quiesced.\n\nArgs:\n params: Inputs for starting a deferred-idle drain.\n\nReturns:\n Whether a deferred-idle drain should run.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueBeginDeferredIdleDrainResult.from_dict(await self._client.request("session.queue.beginDeferredIdleDrain", params_dict, **_timeout_kwargs(timeout))) + + async def _finish_deferred_idle_drain(self, params: QueueFinishDeferredIdleDrainRequest, *, timeout: float | None = None) -> QueueFinishDeferredIdleDrainResult: + "Finishes a native deferred-idle drain and reports whether to drain queue work or emit idle.\n\nArgs:\n params: Inputs for completing a deferred-idle drain.\n\nReturns:\n Action selected by the native deferred-idle drain.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueFinishDeferredIdleDrainResult.from_dict(await self._client.request("session.queue.finishDeferredIdleDrain", params_dict, **_timeout_kwargs(timeout))) + + async def _defer_session_idle(self, params: QueueDeferSessionIdleRequest, *, timeout: float | None = None) -> None: + "Marks session.idle as deferred by native background work state.\n\nArgs:\n params: Inputs for marking session.idle deferred in native state.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.queue.deferSessionIdle", params_dict, **_timeout_kwargs(timeout)) + + async def _consume_system_notifications(self, params: QueueConsumeSystemNotificationsRequest, *, timeout: float | None = None) -> QueueRemoveMostRecentResult: + "Consumes queued native system notifications matching an internal filter.\n\nArgs:\n params: Internal filter for consuming queued system notifications.\n\nReturns:\n Indicates whether a user-facing pending item was removed.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return QueueRemoveMostRecentResult.from_dict(await self._client.request("session.queue.consumeSystemNotifications", params_dict, **_timeout_kwargs(timeout))) + + async def _enqueue_resume_pending(self, *, timeout: float | None = None) -> QueueEnqueueResumePendingResult: + "Enqueues the internal resume-pending wake item when orphan handling needs a follow-up turn.\n\nReturns:\n Result of enqueueing the resume-pending wake item.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return QueueEnqueueResumePendingResult.from_dict(await self._client.request("session.queue.enqueueResumePending", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _process(self, *, timeout: float | None = None) -> None: + "Drains the native local-session work queue for in-process session orchestration.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + await self._client.request("session.queue.process", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class _InternalScheduleApi: + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + + async def _hydrate(self, *, timeout: float | None = None) -> None: + "Hydrates the native schedule registry from persisted session events.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + await self._client.request("session.schedule.hydrate", {"sessionId": self._session_id}, **_timeout_kwargs(timeout)) + + async def _has_self_paced(self, *, timeout: float | None = None) -> ScheduleHasSelfPacedResult: + "Reports whether the session has an active self-paced scheduled prompt.\n\nReturns:\n Whether the session currently has an active self-paced schedule.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + return ScheduleHasSelfPacedResult.from_dict(await self._client.request("session.schedule.hasSelfPaced", {"sessionId": self._session_id}, **_timeout_kwargs(timeout))) + + async def _add(self, params: ScheduleAddRequest, *, timeout: float | None = None) -> ScheduleAddResult: + "Registers a relative-interval scheduled prompt.\n\nArgs:\n params: Register a relative-interval scheduled prompt.\n\nReturns:\n Result of registering or re-arming a scheduled prompt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ScheduleAddResult.from_dict(await self._client.request("session.schedule.add", params_dict, **_timeout_kwargs(timeout))) + + async def _add_cron(self, params: ScheduleAddCronRequest, *, timeout: float | None = None) -> ScheduleAddResult: + "Registers a recurring cron scheduled prompt.\n\nArgs:\n params: Register a cron scheduled prompt.\n\nReturns:\n Result of registering or re-arming a scheduled prompt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ScheduleAddResult.from_dict(await self._client.request("session.schedule.addCron", params_dict, **_timeout_kwargs(timeout))) + + async def _add_at(self, params: ScheduleAddAtRequest, *, timeout: float | None = None) -> ScheduleAddResult: + "Registers an absolute-time scheduled prompt.\n\nArgs:\n params: Register an absolute-time scheduled prompt.\n\nReturns:\n Result of registering or re-arming a scheduled prompt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ScheduleAddResult.from_dict(await self._client.request("session.schedule.addAt", params_dict, **_timeout_kwargs(timeout))) + + async def _add_self_paced(self, params: ScheduleAddSelfPacedRequest, *, timeout: float | None = None) -> ScheduleAddResult: + "Registers a self-paced scheduled prompt.\n\nArgs:\n params: Register a self-paced scheduled prompt.\n\nReturns:\n Result of registering or re-arming a scheduled prompt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ScheduleAddResult.from_dict(await self._client.request("session.schedule.addSelfPaced", params_dict, **_timeout_kwargs(timeout))) + + async def _rearm_self_paced(self, params: ScheduleRearmSelfPacedRequest, *, timeout: float | None = None) -> ScheduleAddResult: + "Re-arms an active self-paced scheduled prompt.\n\nArgs:\n params: Re-arm a self-paced scheduled prompt.\n\nReturns:\n Result of registering or re-arming a scheduled prompt.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + return ScheduleAddResult.from_dict(await self._client.request("session.schedule.rearmSelfPaced", params_dict, **_timeout_kwargs(timeout))) + + +class _InternalSessionRpc: + """Internal SDK session-scoped RPC methods. Not part of the public API.""" + def __init__(self, client: "JsonRpcClient", session_id: str): + self._client = client + self._session_id = session_id + self.mcp = _InternalMcpApi(client, session_id) + self.settings = _InternalSettingsApi(client, session_id) + self.queue = _InternalQueueApi(client, session_id) + self.schedule = _InternalScheduleApi(client, session_id) + + async def _send_system_notification(self, params: SendSystemNotificationRequest, *, timeout: float | None = None) -> None: + "Queues or sends an internal system notification to the session according to its passive policy.\n\nArgs:\n params: Internal request for sending a system notification.\n\n.. warning:: This API is experimental and may change or be removed in future versions.\n\n:meta private:\n\nInternal SDK API; not part of the public surface." + params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} + params_dict["sessionId"] = self._session_id + await self._client.request("session.sendSystemNotification", params_dict, **_timeout_kwargs(timeout)) + + +# Experimental: this API group is experimental and may change or be removed. +class ProviderTokenHandler(Protocol): + async def get_token(self, params: ProviderTokenAcquireRequest) -> ProviderTokenAcquireResult: + "Asks the SDK client to get a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Session-scoped: the runtime calls it back on the connection that most recently supplied that provider's config for the session (the creating connection, or a resuming connection if the session was resumed — distinct providers may be owned by different connections), passing the provider name, and uses the returned token as the Authorization header for the outbound model request. The runtime does no caching — it calls this once per outbound request; the SDK consumer owns token acquisition, caching, and refresh.\n\nArgs:\n params: Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request.\n\nReturns:\n A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh." + pass + +# Experimental: this API group is experimental and may change or be removed. +class FactoryHandler(Protocol): + async def execute(self, params: FactoryExecuteRequest) -> FactoryExecuteResult: + "Asks the owning extension connection to execute a registered factory closure.\n\nArgs:\n params: Parameters sent to the owning extension to execute a factory closure.\n\nReturns:\n Result returned by an extension factory closure." + pass + async def abort(self, params: FactoryAbortRequest) -> FactoryACKResult: + "Asks the owning extension connection to abort a running factory cooperatively.\n\nArgs:\n params: Parameters for cooperatively aborting a factory body.\n\nReturns:\n Acknowledgement that a factory request was accepted." + pass + # Experimental: this API group is experimental and may change or be removed. class SessionFsHandler(Protocol): async def read_file(self, params: SessionFSReadFileRequest) -> SessionFSReadFileResult: @@ -18990,7 +34478,10 @@ async def rename(self, params: SessionFSRenameRequest) -> SessionFSError | None: "Renames or moves a path in the client-provided session filesystem.\n\nArgs:\n params: Source and destination paths for renaming or moving an entry in the client-provided session filesystem.\n\nReturns:\n Describes a filesystem error." pass async def sqlite_query(self, params: SessionFSSqliteQueryRequest) -> SessionFSSqliteQueryResult: - "Executes a SQLite query against the per-session database.\n\nArgs:\n params: SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.\n\nReturns:\n Query results including rows, columns, and rows affected, or a filesystem error if execution failed." + "Executes a SQLite query against the per-session database. Providers apply busy handling for every call.\n\nArgs:\n params: SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call.\n\nReturns:\n Query results including rows, columns, and rows affected, or a filesystem error if execution failed." + pass + async def sqlite_transaction(self, params: SessionFSSqliteTransactionRequest) -> SessionFSSqliteTransactionResult: + "Executes SQLite statements atomically on the provider-owned connection.\n\nArgs:\n params: Statements to execute atomically. Providers apply busy handling for every call.\n\nReturns:\n Per-statement results, or a classified transaction error." pass async def sqlite_exists(self, params: SessionFSSqliteExistsRequest) -> SessionFSSqliteExistsResult: "Checks whether the per-session SQLite database already exists, without creating it.\n\nArgs:\n params: Identifies the target session.\n\nReturns:\n Indicates whether the per-session SQLite database already exists." @@ -19010,6 +34501,8 @@ async def invoke(self, params: CanvasProviderInvokeActionRequest) -> Any: @dataclass class ClientSessionApiHandlers: + provider_token: ProviderTokenHandler | None = None + factory: FactoryHandler | None = None session_fs: SessionFsHandler | None = None canvas: CanvasHandler | None = None @@ -19018,6 +34511,27 @@ def register_client_session_api_handlers( get_handlers: Callable[[str], ClientSessionApiHandlers], ) -> None: """Register client-session request handlers on a JSON-RPC connection.""" + async def handle_provider_token_get_token(params: dict) -> dict | None: + request = ProviderTokenAcquireRequest.from_dict(params) + handler = get_handlers(request.session_id).provider_token + if handler is None: raise RuntimeError(f"No provider_token handler registered for session: {request.session_id}") + result = await handler.get_token(request) + return result.to_dict() + client.set_request_handler("providerToken.getToken", handle_provider_token_get_token) + async def handle_factory_execute(params: dict) -> dict | None: + request = FactoryExecuteRequest.from_dict(params) + handler = get_handlers(request.session_id).factory + if handler is None: raise RuntimeError(f"No factory handler registered for session: {request.session_id}") + result = await handler.execute(request) + return result.to_dict() + client.set_request_handler("factory.execute", handle_factory_execute) + async def handle_factory_abort(params: dict) -> dict | None: + request = FactoryAbortRequest.from_dict(params) + handler = get_handlers(request.session_id).factory + if handler is None: raise RuntimeError(f"No factory handler registered for session: {request.session_id}") + result = await handler.abort(request) + return result.to_dict() + client.set_request_handler("factory.abort", handle_factory_abort) async def handle_session_fs_read_file(params: dict) -> dict | None: request = SessionFSReadFileRequest.from_dict(params) handler = get_handlers(request.session_id).session_fs @@ -19095,6 +34609,13 @@ async def handle_session_fs_sqlite_query(params: dict) -> dict | None: result = await handler.sqlite_query(request) return result.to_dict() client.set_request_handler("sessionFs.sqliteQuery", handle_session_fs_sqlite_query) + async def handle_session_fs_sqlite_transaction(params: dict) -> dict | None: + request = SessionFSSqliteTransactionRequest.from_dict(params) + handler = get_handlers(request.session_id).session_fs + if handler is None: raise RuntimeError(f"No session_fs handler registered for session: {request.session_id}") + result = await handler.sqlite_transaction(request) + return result.to_dict() + client.set_request_handler("sessionFs.sqliteTransaction", handle_session_fs_sqlite_transaction) async def handle_session_fs_sqlite_exists(params: dict) -> dict | None: request = SessionFSSqliteExistsRequest.from_dict(params) handler = get_handlers(request.session_id).session_fs @@ -19123,3 +34644,1283 @@ async def handle_canvas_action_invoke(params: dict) -> dict | None: result = await handler.invoke(request) return result.value if hasattr(result, 'value') else result client.set_request_handler("canvas.action.invoke", handle_canvas_action_invoke) + +# Experimental: this API group is experimental and may change or be removed. +class HooksHandler(Protocol): + async def invoke(self, params: _HookInvokeRequest) -> _HookInvokeResponse: + "Dispatches one SDK callback hook from the runtime to the connection that registered it. Internal transport plumbing: clients opt in through session initialization and the Rust hook processor owns ordering, policy, timeout, and callback routing.\n\nArgs:\n params: Runtime-owned wire payload for a server-to-client hook callback invocation.\n\nReturns:\n Optional output returned by an SDK callback hook." + pass + +# Experimental: this API group is experimental and may change or be removed. +class ExtensionLaunchProviderHandler(Protocol): + async def resolve(self, params: ExtensionLaunchProviderResolveRequest) -> ExtensionLaunchProviderResolveResult: + "Asks the registered SDK client to resolve an opaque process launch profile for one discovered extension entrypoint immediately before launch or reload. The provider must respond within 15 seconds.\n\nArgs:\n params: A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile.\n\nReturns:\n The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint." + pass + +# Experimental: this API group is experimental and may change or be removed. +class LlmInferenceHandler(Protocol): + async def http_request_start(self, params: LlmInferenceHTTPRequestStartRequest) -> LlmInferenceHTTPRequestStartResult: + "Announces an outbound model-layer HTTP request the runtime wants the SDK client to service. Carries the request head only; the body always follows as one or more httpRequestChunk frames keyed by the same requestId, even when the body is empty (a single chunk with end=true).\n\nArgs:\n params: The head of an outbound model-layer HTTP request.\n\nReturns:\n Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed." + pass + async def http_request_chunk(self, params: LlmInferenceHTTPRequestChunkRequest) -> LlmInferenceHTTPRequestChunkResult: + "Delivers a body byte range (or a cancellation signal) for a request previously announced via httpRequestStart, correlated by requestId. The runtime fires at least one chunk per request — when there is no body, a single chunk with empty data and end=true. Mid-stream the runtime may send a chunk with cancel=true to abort the request; the SDK then stops issuing httpResponseChunk frames and may emit a terminal httpResponseChunk with error set.\n\nArgs:\n params: A request body chunk or cancellation signal.\n\nReturns:\n Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget." + pass + +# Experimental: this API group is experimental and may change or be removed. +class GitHubTelemetryHandler(Protocol): + async def event(self, params: GitHubTelemetryNotification) -> None: + "Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive every event the runtime emits after the handshake — across all sessions, plus sessionless events (for example, `server.sendTelemetry` calls with no session id).\n\nArgs:\n params: Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake." + pass + +@dataclass +class ClientGlobalApiHandlers: + hooks: HooksHandler | None = None + extension_launch_provider: ExtensionLaunchProviderHandler | None = None + llm_inference: LlmInferenceHandler | None = None + git_hub_telemetry: GitHubTelemetryHandler | None = None + +def register_client_global_api_handlers( + client: "JsonRpcClient", + handlers: ClientGlobalApiHandlers, +) -> None: + """Register client-global request handlers on a JSON-RPC connection. + + Unlike client-session handlers these methods carry no implicit + session_id dispatch key; a single set of handlers serves the entire + connection. + """ + async def handle_hooks_invoke(params: dict) -> dict | None: + request = _HookInvokeRequest.from_dict(params) + handler = handlers.hooks + if handler is None: raise RuntimeError("No hooks client-global handler registered") + result = await handler.invoke(request) + return result.to_dict() + client.set_request_handler("hooks.invoke", handle_hooks_invoke) + async def handle_extension_launch_provider_resolve(params: dict) -> dict | None: + request = ExtensionLaunchProviderResolveRequest.from_dict(params) + handler = handlers.extension_launch_provider + if handler is None: raise RuntimeError("No extension_launch_provider client-global handler registered") + result = await handler.resolve(request) + return result.to_dict() + client.set_request_handler("extensionLaunchProvider.resolve", handle_extension_launch_provider_resolve) + async def handle_llm_inference_http_request_start(params: dict) -> dict | None: + request = LlmInferenceHTTPRequestStartRequest.from_dict(params) + handler = handlers.llm_inference + if handler is None: raise RuntimeError("No llm_inference client-global handler registered") + result = await handler.http_request_start(request) + return result.to_dict() + client.set_request_handler("llmInference.httpRequestStart", handle_llm_inference_http_request_start) + async def handle_llm_inference_http_request_chunk(params: dict) -> dict | None: + request = LlmInferenceHTTPRequestChunkRequest.from_dict(params) + handler = handlers.llm_inference + if handler is None: raise RuntimeError("No llm_inference client-global handler registered") + result = await handler.http_request_chunk(request) + return result.to_dict() + client.set_request_handler("llmInference.httpRequestChunk", handle_llm_inference_http_request_chunk) + async def handle_git_hub_telemetry_event(params: dict) -> None: + request = GitHubTelemetryNotification.from_dict(params) + handler = handlers.git_hub_telemetry + if handler is None: return None + await handler.event(request) + return None + client.set_notification_method_handler("gitHubTelemetry.event", handle_git_hub_telemetry_event) + +__all__ = [ + "APIKeyAuthInfo", + "APIKeyAuthInfoType", + "AbortRequest", + "AbortResult", + "AccountAllUsers", + "AccountGetAllUsersResult", + "AccountGetCurrentAuthResult", + "AccountGetQuotaRequest", + "AccountGetQuotaResult", + "AccountLoginRequest", + "AccountLoginResult", + "AccountLogoutRequest", + "AccountLogoutResult", + "AccountQuotaSnapshot", + "AdaptiveThinkingSupport", + "AdditionalContentExclusionPolicyScope", + "AgentApi", + "AgentDiscoveryPath", + "AgentDiscoveryPathList", + "AgentDiscoveryPathScope", + "AgentGetCurrentResult", + "AgentInfo", + "AgentInfoSource", + "AgentList", + "AgentListRequest", + "AgentRegistryLiveTargetEntry", + "AgentRegistryLiveTargetEntryAttentionKind", + "AgentRegistryLiveTargetEntryKind", + "AgentRegistryLiveTargetEntryLastTerminalEvent", + "AgentRegistryLiveTargetEntryStatus", + "AgentRegistryLogCapture", + "AgentRegistryLogCaptureOpenErrorReason", + "AgentRegistrySpawnError", + "AgentRegistrySpawnErrorKind", + "AgentRegistrySpawnPermissionMode", + "AgentRegistrySpawnRegistryTimeout", + "AgentRegistrySpawnRegistryTimeoutKind", + "AgentRegistrySpawnRequest", + "AgentRegistrySpawnResult", + "AgentRegistrySpawnResultKind", + "AgentRegistrySpawnSpawned", + "AgentRegistrySpawnSpawnedKind", + "AgentRegistrySpawnValidationError", + "AgentRegistrySpawnValidationErrorField", + "AgentRegistrySpawnValidationErrorKind", + "AgentRegistrySpawnValidationErrorReason", + "AgentReloadResult", + "AgentSelectRequest", + "AgentSelectResult", + "AgentSetPromptRequest", + "AgentsDiscoverRequest", + "AgentsGetDiscoveryPathsRequest", + "AllowAllPermissionSetResult", + "AllowAllPermissionState", + "ApprovalKind", + "AuthInfo", + "AuthInfoType", + "BuiltInModelCatalog", + "BuiltInModelCatalogEntry", + "CancelUserRequestedShellCommandResult", + "CanvasAction", + "CanvasActionApi", + "CanvasActionInvokeRequest", + "CanvasActionInvokeResult", + "CanvasApi", + "CanvasCloseRequest", + "CanvasHandler", + "CanvasHostContext", + "CanvasHostContextCapabilities", + "CanvasJsonSchema", + "CanvasList", + "CanvasListOpenResult", + "CanvasOpenRequest", + "CanvasProviderCloseRequest", + "CanvasProviderInvokeActionRequest", + "CanvasProviderOpenRequest", + "CanvasProviderOpenResult", + "CanvasSessionContext", + "CapiSessionOptions", + "Categories", + "ClientGlobalApiHandlers", + "ClientSessionApiHandlers", + "CommandList", + "CommandsApi", + "CommandsHandlePendingCommandRequest", + "CommandsHandlePendingCommandResult", + "CommandsInvokeRequest", + "CommandsListRequest", + "CommandsRespondToQueuedCommandRequest", + "CommandsRespondToQueuedCommandResult", + "Compactions", + "CompletionsApi", + "CompletionsGetTriggerCharactersResult", + "CompletionsRequestRequest", + "CompletionsRequestResult", + "ConnectRemoteSessionParams", + "ConnectedRemoteSessionMetadata", + "ConnectedRemoteSessionMetadataKind", + "ConnectedRemoteSessionMetadataRepository", + "ContentExclusionApi", + "ContentExclusionCheckPathsRequest", + "ContentExclusionCheckPathsResult", + "ContentExclusionPathCheck", + "ContentFilterMode", + "ContextHeaviestMessage", + "CopilotAPITokenAuthInfo", + "CopilotAPITokenAuthInfoType", + "CopilotUserResponse", + "CopilotUserResponseEndpoints", + "CopilotUserResponseQuotaSnapshots", + "CopilotUserResponseQuotaSnapshotsChat", + "CopilotUserResponseQuotaSnapshotsCompletions", + "CopilotUserResponseQuotaSnapshotsPremiumInteractions", + "CurrentModel", + "CurrentToolMetadata", + "DebugApi", + "DebugCollectLogsCollectedEntry", + "DebugCollectLogsDestination", + "DebugCollectLogsEntry", + "DebugCollectLogsEntryKind", + "DebugCollectLogsInclude", + "DebugCollectLogsRedaction", + "DebugCollectLogsRequest", + "DebugCollectLogsResult", + "DebugCollectLogsResultKind", + "DebugCollectLogsSkippedEntry", + "DebugCollectLogsSource", + "DisableBypassPermissionsMode", + "DiscoveredCanvas", + "DiscoveredExtension", + "DiscoveredExtensionMode", + "DiscoveredExtensionPlugin", + "DiscoveredExtensionSource", + "DiscoveredExtensions", + "DiscoveredExtensionsDisableRequest", + "DiscoveredExtensionsEnableRequest", + "DiscoveredMCPServer", + "DiscoveredMCPServerType", + "EnqueueCommandParams", + "EnqueueCommandResult", + "Entry", + "EnvAuthInfo", + "EnvAuthInfoType", + "EventLogApi", + "EventLogReadRequest", + "EventLogReleaseInterestResult", + "EventLogTailResult", + "EventLogTypes", + "EventsAgentScope", + "EventsCursorStatus", + "EventsReadDirection", + "EventsReadResult", + "ExecuteCommandParams", + "ExecuteCommandResult", + "Extension", + "ExtensionContextPushInput", + "ExtensionContextPushInputType", + "ExtensionLaunchProfile", + "ExtensionLaunchProviderHandler", + "ExtensionLaunchProviderResolveRequest", + "ExtensionLaunchProviderResolveResult", + "ExtensionList", + "ExtensionSource", + "ExtensionStatus", + "ExtensionsApi", + "ExtensionsDisableRequest", + "ExtensionsEnableRequest", + "ExternalToolResult", + "ExternalToolTextResultForLlm", + "ExternalToolTextResultForLlmBinaryResultsForLlm", + "ExternalToolTextResultForLlmBinaryResultsForLlmType", + "ExternalToolTextResultForLlmContent", + "ExternalToolTextResultForLlmContentAudio", + "ExternalToolTextResultForLlmContentAudioType", + "ExternalToolTextResultForLlmContentImage", + "ExternalToolTextResultForLlmContentImageType", + "ExternalToolTextResultForLlmContentResource", + "ExternalToolTextResultForLlmContentResourceDetails", + "ExternalToolTextResultForLlmContentResourceLink", + "ExternalToolTextResultForLlmContentResourceLinkIcon", + "ExternalToolTextResultForLlmContentResourceLinkIconTheme", + "ExternalToolTextResultForLlmContentResourceLinkType", + "ExternalToolTextResultForLlmContentResourceType", + "ExternalToolTextResultForLlmContentShellExit", + "ExternalToolTextResultForLlmContentShellExitType", + "ExternalToolTextResultForLlmContentTerminal", + "ExternalToolTextResultForLlmContentTerminalType", + "ExternalToolTextResultForLlmContentText", + "ExternalToolTextResultForLlmContentType", + "FactoryACKResult", + "FactoryAbortRequest", + "FactoryAgentOptions", + "FactoryAgentRequest", + "FactoryAgentResult", + "FactoryAgentSummary", + "FactoryApi", + "FactoryCancelRequest", + "FactoryCurrentPhase", + "FactoryDeclaredLimits", + "FactoryDurableOperation", + "FactoryExecuteRequest", + "FactoryExecuteResult", + "FactoryGetRunProgressRequest", + "FactoryGetRunRequest", + "FactoryHandler", + "FactoryJournalApi", + "FactoryJournalGetRequest", + "FactoryJournalGetResult", + "FactoryJournalPutRequest", + "FactoryListRunsRequest", + "FactoryListRunsResult", + "FactoryLogLine", + "FactoryLogLineKind", + "FactoryLogRequest", + "FactoryPhaseObservation", + "FactoryPhaseStatus", + "FactoryProgressLine", + "FactoryProgressPage", + "FactoryResumeRequest", + "FactoryResumeResult", + "FactoryRunConsumed", + "FactoryRunDetail", + "FactoryRunFailure", + "FactoryRunFailureKind", + "FactoryRunFailureType", + "FactoryRunLimits", + "FactoryRunRequest", + "FactoryRunResult", + "FactoryRunStatus", + "FactoryRunSummary", + "FactoryRunTerminal", + "FilterMapping", + "FleetApi", + "FleetStartRequest", + "FleetStartResult", + "FluffySource", + "FolderTrustAddParams", + "FolderTrustCheckParams", + "FolderTrustCheckResult", + "GhCLIAuthInfo", + "GhCLIAuthInfoType", + "GitHubAuthApi", + "GitHubTelemetryClientInfo", + "GitHubTelemetryEvent", + "GitHubTelemetryHandler", + "GitHubTelemetryNotification", + "HMACAuthInfo", + "HMACAuthInfoType", + "HandlePendingToolCallRequest", + "HandlePendingToolCallResult", + "HistoryAbortManualCompactionResult", + "HistoryApi", + "HistoryCancelBackgroundCompactionResult", + "HistoryClearContextRequest", + "HistoryClearContextResult", + "HistoryCompactContextWindow", + "HistoryCompactRequest", + "HistoryCompactResult", + "HistoryFileRestoreSkipReason", + "HistoryListRewindPointsResult", + "HistoryPreviewRewindRequest", + "HistoryPreviewRewindResult", + "HistoryRewindChangeType", + "HistoryRewindFilePreview", + "HistoryRewindMode", + "HistoryRewindOutcome", + "HistoryRewindPoint", + "HistoryRewindRequest", + "HistoryRewindResult", + "HistoryRewindUnavailableReason", + "HistorySkippedFileRestore", + "HistorySummarizeForHandoffResult", + "HistoryTruncateRequest", + "HistoryTruncateResult", + "HooksHandler", + "Host", + "HostType", + "InstalledPlugin", + "InstalledPluginInfo", + "InstalledPluginSource", + "InstalledPluginSourceGitHub", + "InstalledPluginSourceLocal", + "InstalledPluginSourceURL", + "InstructionDiscoveryPath", + "InstructionDiscoveryPathKind", + "InstructionDiscoveryPathList", + "InstructionDiscoveryPathLocation", + "InstructionLocation", + "InstructionSource", + "InstructionSourceLocation", + "InstructionSourceType", + "InstructionsApi", + "InstructionsDiscoverRequest", + "InstructionsGetDiscoveryPathsRequest", + "InstructionsGetSourcesResult", + "InterruptMainTurnRequest", + "InterruptMainTurnResult", + "KindEnum", + "LimitPredictionApi", + "LlmInferenceHTTPRequestChunkRequest", + "LlmInferenceHTTPRequestChunkResult", + "LlmInferenceHTTPRequestStartRequest", + "LlmInferenceHTTPRequestStartResult", + "LlmInferenceHTTPRequestStartTransport", + "LlmInferenceHTTPResponseChunkError", + "LlmInferenceHTTPResponseChunkRequest", + "LlmInferenceHTTPResponseChunkResult", + "LlmInferenceHTTPResponseStartRequest", + "LlmInferenceHTTPResponseStartResult", + "LlmInferenceHandler", + "LlmInferenceHeaders", + "LlmInferenceSetProviderResult", + "LocalSessionMetadataValue", + "LogRequest", + "LogResult", + "LspApi", + "LspInitializeRequest", + "MCPAllowedServer", + "MCPAppsCallToolRequest", + "MCPAppsDiagnoseCapability", + "MCPAppsDiagnoseRequest", + "MCPAppsDiagnoseResult", + "MCPAppsDiagnoseServer", + "MCPAppsDisplayMode", + "MCPAppsHostContext", + "MCPAppsHostContextDetails", + "MCPAppsHostContextDetailsPlatform", + "MCPAppsListToolsRequest", + "MCPAppsListToolsResult", + "MCPAppsReadResourceRequest", + "MCPAppsReadResourceResult", + "MCPAppsResourceContent", + "MCPAppsSetHostContextDetails", + "MCPAppsSetHostContextRequest", + "MCPCancelSamplingExecutionParams", + "MCPCancelSamplingExecutionResult", + "MCPConfigAddRequest", + "MCPConfigDisableRequest", + "MCPConfigEnableRequest", + "MCPConfigList", + "MCPConfigRemoveRequest", + "MCPConfigUpdateRequest", + "MCPConfigureGitHubRequest", + "MCPConfigureGitHubResult", + "MCPDisableRequest", + "MCPDiscoverRequest", + "MCPDiscoverResult", + "MCPEnableRequest", + "MCPExecuteSamplingParams", + "MCPFilteredServer", + "MCPGrantType", + "MCPHeadersHandlePendingHeadersRefreshRequest", + "MCPHeadersHandlePendingHeadersRefreshRequestKind", + "MCPHeadersHandlePendingHeadersRefreshRequestRequest", + "MCPHeadersHandlePendingHeadersRefreshRequestResult", + "MCPHostState", + "MCPIsServerRunningRequest", + "MCPIsServerRunningResult", + "MCPListToolsRequest", + "MCPListToolsResult", + "MCPOauthAuthenticationStateChangedRequest", + "MCPOauthHandlePendingRequest", + "MCPOauthHandlePendingResult", + "MCPOauthLoginRequest", + "MCPOauthLoginResult", + "MCPOauthPendingRequestResponse", + "MCPOauthPendingRequestResponseKind", + "MCPOauthRespondRequest", + "MCPOauthRespondResult", + "MCPRegisterExternalClientRequest", + "MCPReloadWithConfigRequest", + "MCPRemoveGitHubResult", + "MCPResource", + "MCPResourceAnnotations", + "MCPResourceContent", + "MCPResourceIcon", + "MCPResourceTemplate", + "MCPResourcesListRequest", + "MCPResourcesListResult", + "MCPResourcesListTemplatesRequest", + "MCPResourcesListTemplatesResult", + "MCPResourcesReadRequest", + "MCPResourcesReadResult", + "MCPRestartServerRequest", + "MCPSamplingExecutionAction", + "MCPSamplingExecutionResult", + "MCPServer", + "MCPServerAuthConfigRedirectPort", + "MCPServerConfig", + "MCPServerConfigDeferTools", + "MCPServerConfigHTTP", + "MCPServerConfigHTTPType", + "MCPServerConfigStdio", + "MCPServerFailureInfo", + "MCPServerList", + "MCPServerNeedsAuthInfo", + "MCPSetEnvValueModeDetails", + "MCPSetEnvValueModeParams", + "MCPSetEnvValueModeResult", + "MCPStartServerRequest", + "MCPStartServersResult", + "MCPStopServerRequest", + "MCPToolUI", + "MCPToolUIVisibility", + "MCPTools", + "MCPUnregisterExternalClientRequest", + "ManagedSettingsReadResult", + "MarketplaceAddResult", + "MarketplaceBrowseResult", + "MarketplaceInfo", + "MarketplaceListResult", + "MarketplacePluginInfo", + "MarketplaceRefreshEntry", + "MarketplaceRefreshResult", + "MarketplaceRemoveResult", + "McpApi", + "McpAppsApi", + "McpAppsHostContextDetailsAvailableDisplayMode", + "McpAppsHostContextDetailsDisplayMode", + "McpAppsHostContextDetailsTheme", + "McpAppsSetHostContextDetailsAvailableDisplayMode", + "McpAppsSetHostContextDetailsDisplayMode", + "McpAppsSetHostContextDetailsPlatform", + "McpAppsSetHostContextDetailsTheme", + "McpExecuteSamplingRequest", + "McpExecuteSamplingResult", + "McpHeadersApi", + "McpOauthApi", + "McpOauthLoginGrantType", + "McpResourcesApi", + "McpServerAuthConfig", + "McpServerConfigHttpOauthGrantType", + "MemoryConfiguration", + "MetadataApi", + "MetadataContextAttributionResult", + "MetadataContextHeaviestMessagesRequest", + "MetadataContextHeaviestMessagesResult", + "MetadataContextInfoRequest", + "MetadataContextInfoResult", + "MetadataIsProcessingResult", + "MetadataRecomputeContextTokensRequest", + "MetadataRecomputeContextTokensResult", + "MetadataRecordContextChangeRequest", + "MetadataRecordContextChangeResult", + "MetadataSetWorkingDirectoryRequest", + "MetadataSetWorkingDirectoryResult", + "MetadataSnapshotCurrentMode", + "MetadataSnapshotRemoteMetadata", + "MetadataSnapshotRemoteMetadataRepository", + "MetadataSnapshotRemoteMetadataTaskType", + "ModeApi", + "ModeSetRequest", + "Model", + "ModelApi", + "ModelBilling", + "ModelBillingPromo", + "ModelBillingTokenPrices", + "ModelBillingTokenPricesLongContext", + "ModelCapabilities", + "ModelCapabilitiesLimits", + "ModelCapabilitiesLimitsVision", + "ModelCapabilitiesOverride", + "ModelCapabilitiesOverrideLimits", + "ModelCapabilitiesOverrideLimitsVision", + "ModelCapabilitiesOverrideSupports", + "ModelCapabilitiesSupports", + "ModelList", + "ModelListRequest", + "ModelPickerCategory", + "ModelPickerPriceCategory", + "ModelPolicy", + "ModelPolicyState", + "ModelSetReasoningEffortRequest", + "ModelSetReasoningEffortResult", + "ModelSwitchToRequest", + "ModelSwitchToResult", + "ModelsListRequest", + "NameApi", + "NameGetResult", + "NameSetAutoRequest", + "NameSetAutoResult", + "NameSetRequest", + "NamedProviderConfig", + "OpenCanvasInstance", + "OptionsApi", + "OptionsUpdateAdditionalContentExclusionPolicy", + "OptionsUpdateAdditionalContentExclusionPolicyRule", + "OptionsUpdateAdditionalContentExclusionPolicyRuleSource", + "OptionsUpdateAdditionalContentExclusionPolicyScope", + "OptionsUpdateContextTier", + "OptionsUpdateEnvValueMode", + "OptionsUpdateReasoningSummary", + "OptionsUpdateToolFilterPrecedence", + "PendingPermissionRequest", + "PendingPermissionRequestList", + "PermissionDecision", + "PermissionDecisionApproveForLocation", + "PermissionDecisionApproveForLocationApproval", + "PermissionDecisionApproveForLocationApprovalCommands", + "PermissionDecisionApproveForLocationApprovalCommandsKind", + "PermissionDecisionApproveForLocationApprovalCustomTool", + "PermissionDecisionApproveForLocationApprovalCustomToolKind", + "PermissionDecisionApproveForLocationApprovalExtensionManagement", + "PermissionDecisionApproveForLocationApprovalExtensionManagementKind", + "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess", + "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind", + "PermissionDecisionApproveForLocationApprovalFactory", + "PermissionDecisionApproveForLocationApprovalFactoryKind", + "PermissionDecisionApproveForLocationApprovalMCP", + "PermissionDecisionApproveForLocationApprovalMCPKind", + "PermissionDecisionApproveForLocationApprovalMCPSampling", + "PermissionDecisionApproveForLocationApprovalMCPSamplingKind", + "PermissionDecisionApproveForLocationApprovalMemory", + "PermissionDecisionApproveForLocationApprovalMemoryKind", + "PermissionDecisionApproveForLocationApprovalRead", + "PermissionDecisionApproveForLocationApprovalReadKind", + "PermissionDecisionApproveForLocationApprovalWrite", + "PermissionDecisionApproveForLocationApprovalWriteKind", + "PermissionDecisionApproveForLocationKind", + "PermissionDecisionApproveForSession", + "PermissionDecisionApproveForSessionApproval", + "PermissionDecisionApproveForSessionApprovalCommands", + "PermissionDecisionApproveForSessionApprovalCustomTool", + "PermissionDecisionApproveForSessionApprovalExtensionManagement", + "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess", + "PermissionDecisionApproveForSessionApprovalFactory", + "PermissionDecisionApproveForSessionApprovalMCP", + "PermissionDecisionApproveForSessionApprovalMCPSampling", + "PermissionDecisionApproveForSessionApprovalMemory", + "PermissionDecisionApproveForSessionApprovalRead", + "PermissionDecisionApproveForSessionApprovalWrite", + "PermissionDecisionApproveForSessionKind", + "PermissionDecisionApproveOnce", + "PermissionDecisionApproveOnceKind", + "PermissionDecisionApprovePermanently", + "PermissionDecisionApprovePermanentlyKind", + "PermissionDecisionApproved", + "PermissionDecisionApprovedForLocation", + "PermissionDecisionApprovedForLocationKind", + "PermissionDecisionApprovedForSession", + "PermissionDecisionApprovedForSessionKind", + "PermissionDecisionApprovedKind", + "PermissionDecisionCancelled", + "PermissionDecisionCancelledKind", + "PermissionDecisionContext", + "PermissionDecisionDeniedByContentExclusionPolicy", + "PermissionDecisionDeniedByContentExclusionPolicyKind", + "PermissionDecisionDeniedByPermissionRequestHook", + "PermissionDecisionDeniedByPermissionRequestHookKind", + "PermissionDecisionDeniedByRules", + "PermissionDecisionDeniedByRulesKind", + "PermissionDecisionDeniedInteractivelyByUser", + "PermissionDecisionDeniedInteractivelyByUserKind", + "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser", + "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind", + "PermissionDecisionKind", + "PermissionDecisionOutcome", + "PermissionDecisionReject", + "PermissionDecisionRejectKind", + "PermissionDecisionRequest", + "PermissionDecisionSource", + "PermissionDecisionSurface", + "PermissionDecisionUserNotAvailable", + "PermissionDecisionUserNotAvailableKind", + "PermissionLocationAddToolApprovalParams", + "PermissionLocationApplyParams", + "PermissionLocationApplyResult", + "PermissionLocationResolveParams", + "PermissionLocationResolveResult", + "PermissionLocationType", + "PermissionPathsAddParams", + "PermissionPathsAllowedCheckParams", + "PermissionPathsAllowedCheckResult", + "PermissionPathsConfig", + "PermissionPathsList", + "PermissionPathsUpdatePrimaryParams", + "PermissionPathsWorkspaceCheckParams", + "PermissionPathsWorkspaceCheckResult", + "PermissionPromptShownNotification", + "PermissionRequestResult", + "PermissionRulesSet", + "PermissionUrlsConfig", + "PermissionUrlsSetUnrestrictedModeParams", + "PermissionsAllowAllMode", + "PermissionsApi", + "PermissionsConfigureAdditionalContentExclusionPolicy", + "PermissionsConfigureAdditionalContentExclusionPolicyRule", + "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource", + "PermissionsConfigureAdditionalContentExclusionPolicyScope", + "PermissionsConfigureParams", + "PermissionsConfigureResult", + "PermissionsFolderTrustAddTrustedResult", + "PermissionsFolderTrustApi", + "PermissionsGetAllowAllRequest", + "PermissionsLocationsAddToolApprovalDetails", + "PermissionsLocationsAddToolApprovalDetailsCommands", + "PermissionsLocationsAddToolApprovalDetailsCustomTool", + "PermissionsLocationsAddToolApprovalDetailsExtensionManagement", + "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess", + "PermissionsLocationsAddToolApprovalDetailsFactory", + "PermissionsLocationsAddToolApprovalDetailsMCP", + "PermissionsLocationsAddToolApprovalDetailsMCPSampling", + "PermissionsLocationsAddToolApprovalDetailsMemory", + "PermissionsLocationsAddToolApprovalDetailsRead", + "PermissionsLocationsAddToolApprovalDetailsWrite", + "PermissionsLocationsAddToolApprovalResult", + "PermissionsLocationsApi", + "PermissionsModifyRulesParams", + "PermissionsModifyRulesResult", + "PermissionsModifyRulesScope", + "PermissionsNotifyPromptShownResult", + "PermissionsPathsAddResult", + "PermissionsPathsApi", + "PermissionsPathsListRequest", + "PermissionsPathsUpdatePrimaryResult", + "PermissionsPendingRequestsRequest", + "PermissionsResetSessionApprovalsRequest", + "PermissionsResetSessionApprovalsResult", + "PermissionsSetAAllSource", + "PermissionsSetAllowAllRequest", + "PermissionsSetAllowAllSource", + "PermissionsSetApproveAllRequest", + "PermissionsSetApproveAllResult", + "PermissionsSetApproveAllSource", + "PermissionsSetRequiredRequest", + "PermissionsSetRequiredResult", + "PermissionsUrlsApi", + "PermissionsUrlsSetUnrestrictedModeResult", + "PingRequest", + "PingResult", + "PlanApi", + "PlanReadResult", + "PlanReadSQLTodosResult", + "PlanReadSQLTodosWithDependenciesResult", + "PlanSQLTodoDependency", + "PlanSQLTodosRow", + "PlanUpdateRequest", + "Plugin", + "PluginInstallResult", + "PluginList", + "PluginListResult", + "PluginUpdateAllEntry", + "PluginUpdateAllResult", + "PluginUpdateResult", + "PluginsApi", + "PluginsDisableRequest", + "PluginsEnableRequest", + "PluginsInstallRequest", + "PluginsMarketplacesAddRequest", + "PluginsMarketplacesBrowseRequest", + "PluginsMarketplacesRefreshRequest", + "PluginsMarketplacesRemoveRequest", + "PluginsReloadRequest", + "PluginsUninstallRequest", + "PluginsUpdateRequest", + "ProviderAddRequest", + "ProviderAddResult", + "ProviderApi", + "ProviderConfig", + "ProviderConfigAzure", + "ProviderConfigTransport", + "ProviderConfigType", + "ProviderConfigWireApi", + "ProviderEndpoint", + "ProviderEndpointTransport", + "ProviderEndpointType", + "ProviderEndpointWireApi", + "ProviderGetEndpointRequest", + "ProviderModelConfig", + "ProviderSessionToken", + "ProviderTokenAcquireRequest", + "ProviderTokenAcquireResult", + "ProviderTokenHandler", + "ProviderTransport", + "ProviderType", + "ProviderWireAPI", + "PurpleSource", + "PushAttachment", + "PushAttachmentBlob", + "PushAttachmentBlobType", + "PushAttachmentDirectory", + "PushAttachmentFile", + "PushAttachmentFileLineRange", + "PushAttachmentFileType", + "PushAttachmentGitHubActionsJob", + "PushAttachmentGitHubActionsJobType", + "PushAttachmentGitHubCommit", + "PushAttachmentGitHubCommitType", + "PushAttachmentGitHubFile", + "PushAttachmentGitHubFileDiff", + "PushAttachmentGitHubFileDiffSide", + "PushAttachmentGitHubFileDiffType", + "PushAttachmentGitHubFileType", + "PushAttachmentGitHubReference", + "PushAttachmentGitHubReferenceType", + "PushAttachmentGitHubReferenceTypeEnum", + "PushAttachmentGitHubRelease", + "PushAttachmentGitHubReleaseType", + "PushAttachmentGitHubRepository", + "PushAttachmentGitHubRepositoryType", + "PushAttachmentGitHubSnippet", + "PushAttachmentGitHubSnippetType", + "PushAttachmentGitHubTreeComparison", + "PushAttachmentGitHubTreeComparisonSide", + "PushAttachmentGitHubTreeComparisonType", + "PushAttachmentGitHubURL", + "PushAttachmentGitHubURLType", + "PushAttachmentSelection", + "PushAttachmentSelectionDetails", + "PushAttachmentSelectionDetailsEnd", + "PushAttachmentSelectionDetailsStart", + "PushAttachmentSelectionType", + "PushAttachmentType", + "PushGitHubRepoRef", + "QueueApi", + "QueueBeginDeferredIdleDrainRequest", + "QueueBeginDeferredIdleDrainResult", + "QueueConsumeSystemNotificationsRequest", + "QueueDeferSessionIdleRequest", + "QueueDuplicateAtRequest", + "QueueDuplicateAtResult", + "QueueEnqueueResumePendingResult", + "QueueFinishDeferredIdleDrainRequest", + "QueueFinishDeferredIdleDrainResult", + "QueueHasPendingResult", + "QueueInsertAtRequest", + "QueueInsertAtResult", + "QueueInsertMessage", + "QueueMoveItemRequest", + "QueueMoveItemResult", + "QueuePendingItems", + "QueuePendingItemsKind", + "QueuePendingItemsResult", + "QueueRemoveAtRequest", + "QueueRemoveAtResult", + "QueueRemoveMostRecentResult", + "QueueSendNowRequest", + "QueueSendNowResult", + "QueueSetDrainPausedRequest", + "QueueSnapshotResult", + "QueueUpdateTextRequest", + "QueueUpdateTextResult", + "QueuedCommandHandled", + "QueuedCommandNotHandled", + "QueuedCommandResult", + "RPC", + "RegisterEventInterestParams", + "RegisterEventInterestResult", + "ReleaseEventInterestParams", + "RemoteApi", + "RemoteControlConfig", + "RemoteControlConfigExistingMcSession", + "RemoteControlStatus", + "RemoteControlStatusActive", + "RemoteControlStatusActiveState", + "RemoteControlStatusConnecting", + "RemoteControlStatusConnectingState", + "RemoteControlStatusError", + "RemoteControlStatusErrorState", + "RemoteControlStatusOff", + "RemoteControlStatusOffState", + "RemoteControlStatusResult", + "RemoteControlStatusState", + "RemoteControlStopResult", + "RemoteControlTransferResult", + "RemoteEnableRequest", + "RemoteEnableResult", + "RemoteNotifySteerableChangedRequest", + "RemoteNotifySteerableChangedResult", + "RemoteSessionConnectionResult", + "RemoteSessionMetadataRepository", + "RemoteSessionMetadataTaskType", + "RemoteSessionMetadataValue", + "RemoteSessionMode", + "RemoteSessionRepository", + "RunOptions", + "SandboxConfig", + "SandboxConfigAuth", + "SandboxConfigUserPolicy", + "SandboxConfigUserPolicyExperimental", + "SandboxConfigUserPolicyExperimentalSeatbelt", + "SandboxConfigUserPolicyFilesystem", + "SandboxConfigUserPolicyNetwork", + "SandboxConfigUserPolicyNetworkProxy", + "SandboxConfigUserPolicySeatbelt", + "Saved", + "ScheduleAddAtRequest", + "ScheduleAddCronRequest", + "ScheduleAddRequest", + "ScheduleAddResult", + "ScheduleAddSelfPacedRequest", + "ScheduleApi", + "ScheduleEntry", + "ScheduleHasSelfPacedResult", + "ScheduleList", + "ScheduleRearmSelfPacedRequest", + "ScheduleStopRequest", + "ScheduleStopResult", + "SecretsAddFilterValuesRequest", + "SecretsAddFilterValuesResult", + "SendAgentMode", + "SendAttachmentsToMessageParams", + "SendMessageItem", + "SendMessagesRequest", + "SendMessagesResult", + "SendMode", + "SendRequest", + "SendResult", + "SendSystemNotificationRequest", + "ServerAccountApi", + "ServerAgentList", + "ServerAgentRegistryApi", + "ServerAgentsApi", + "ServerCommandsApi", + "ServerExtensionsApi", + "ServerInstructionSourceList", + "ServerInstructionsApi", + "ServerLlmInferenceApi", + "ServerManagedSettingsApi", + "ServerMcpApi", + "ServerMcpConfigApi", + "ServerModelsApi", + "ServerPluginsApi", + "ServerPluginsMarketplacesApi", + "ServerRpc", + "ServerRuntimeApi", + "ServerSecretsApi", + "ServerSessionFsApi", + "ServerSessionsApi", + "ServerSkill", + "ServerSkillList", + "ServerSkillsApi", + "ServerSkillsConfigApi", + "ServerToolsApi", + "ServerUserApi", + "ServerUserSettingsApi", + "SessionActivity", + "SessionAgentListRequest", + "SessionAuthStatus", + "SessionBulkDeleteResult", + "SessionCancelAllBackgroundAgentsResult", + "SessionCapability", + "SessionCommandsListRequest", + "SessionCompletionItem", + "SessionContext", + "SessionContextAttribution", + "SessionContextHostType", + "SessionContextInfo", + "SessionEnrichMetadataResult", + "SessionFSAppendFileRequest", + "SessionFSError", + "SessionFSErrorCode", + "SessionFSExistsRequest", + "SessionFSExistsResult", + "SessionFSMkdirRequest", + "SessionFSReadFileRequest", + "SessionFSReadFileResult", + "SessionFSReaddirRequest", + "SessionFSReaddirResult", + "SessionFSReaddirWithTypesEntry", + "SessionFSReaddirWithTypesRequest", + "SessionFSReaddirWithTypesResult", + "SessionFSRenameRequest", + "SessionFSRmRequest", + "SessionFSSetProviderCapabilities", + "SessionFSSetProviderConventions", + "SessionFSSetProviderRequest", + "SessionFSSetProviderResult", + "SessionFSSqliteExistsRequest", + "SessionFSSqliteExistsResult", + "SessionFSSqliteQueryRequest", + "SessionFSSqliteQueryResult", + "SessionFSSqliteQueryType", + "SessionFSSqliteTransactionError", + "SessionFSSqliteTransactionErrorClass", + "SessionFSSqliteTransactionRequest", + "SessionFSSqliteTransactionResult", + "SessionFSSqliteTransactionStatement", + "SessionFSStatRequest", + "SessionFSStatResult", + "SessionFSWriteFileRequest", + "SessionFsHandler", + "SessionFsReaddirWithTypesEntryType", + "SessionHistoryCompactRequest", + "SessionInstalledPlugin", + "SessionInstalledPluginSource", + "SessionInstalledPluginSourceGitHub", + "SessionInstalledPluginSourceLocal", + "SessionInstalledPluginSourceURL", + "SessionLimitPredictionBaselineData", + "SessionLimitPredictionClientType", + "SessionLimitPredictionDetails", + "SessionLimitPredictionPredictRequest", + "SessionLimitPredictionRequest", + "SessionLimitPredictionResult", + "SessionLimitPredictionResultKind", + "SessionLimitPredictionSource", + "SessionLimitPredictionTier", + "SessionLimitPredictionTierOption", + "SessionLimitPredictionUnavailableReason", + "SessionList", + "SessionListEntry", + "SessionListFilter", + "SessionLoadDeferredRepoHooksResult", + "SessionLogLevel", + "SessionManagedPermissions", + "SessionManagedSettings", + "SessionMcpAppsCallToolResult", + "SessionMetadataSnapshot", + "SessionModelList", + "SessionModelListRequest", + "SessionModelPriceCategory", + "SessionOpenOptions", + "SessionOpenOptionsAdditionalContentExclusionPolicy", + "SessionOpenOptionsAdditionalContentExclusionPolicyRule", + "SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource", + "SessionOpenOptionsAdditionalContentExclusionPolicyScope", + "SessionOpenOptionsEnvValueMode", + "SessionOpenOptionsReasoningSummary", + "SessionOpenParams", + "SessionOpenParamsKind", + "SessionOpenResult", + "SessionPluginsReloadRequest", + "SessionProviderGetEndpointRequest", + "SessionPruneResult", + "SessionRpc", + "SessionSetCredentialsParams", + "SessionSetCredentialsResult", + "SessionSettingsBuiltInToolAvailabilitySnapshot", + "SessionSettingsEvaluatePredicateRequest", + "SessionSettingsEvaluatePredicateResult", + "SessionSettingsJobSnapshot", + "SessionSettingsModelSnapshot", + "SessionSettingsOnlineEvaluationSnapshot", + "SessionSettingsPredicateName", + "SessionSettingsRepoSnapshot", + "SessionSettingsSnapshot", + "SessionSettingsValidationSnapshot", + "SessionSizes", + "SessionSource", + "SessionTelemetryEngagement", + "SessionUpdateOptionsParams", + "SessionUpdateOptionsResult", + "SessionVisibilityStatus", + "SessionWorkingDirectoryContext", + "SessionWorkingDirectoryContextHostType", + "SessionsBulkDeleteRequest", + "SessionsCheckInUseRequest", + "SessionsCheckInUseResult", + "SessionsCloseRequest", + "SessionsCloseResult", + "SessionsDeleteRequest", + "SessionsEnrichMetadataRequest", + "SessionsFindByPrefixRequest", + "SessionsFindByPrefixResult", + "SessionsFindByTaskIDRequest", + "SessionsFindByTaskIDResult", + "SessionsForkRequest", + "SessionsForkResult", + "SessionsGetBoardEntryCountRequest", + "SessionsGetBoardEntryCountResult", + "SessionsGetEventFilePathRequest", + "SessionsGetEventFilePathResult", + "SessionsGetLastForContextRequest", + "SessionsGetLastForContextResult", + "SessionsGetMetadataRequest", + "SessionsGetMetadataResult", + "SessionsGetPersistedRemoteSteerableRequest", + "SessionsGetPersistedRemoteSteerableResult", + "SessionsListNonEmptySessionIDSRequest", + "SessionsListNonEmptySessionIDSResult", + "SessionsListRequest", + "SessionsLoadDeferredRepoHooksRequest", + "SessionsOpenAttach", + "SessionsOpenAttachKind", + "SessionsOpenCloud", + "SessionsOpenCloudKind", + "SessionsOpenCreate", + "SessionsOpenCreateKind", + "SessionsOpenHandoff", + "SessionsOpenHandoffKind", + "SessionsOpenHandoffTaskType", + "SessionsOpenProgress", + "SessionsOpenProgressStatus", + "SessionsOpenProgressStep", + "SessionsOpenRemote", + "SessionsOpenRemoteKind", + "SessionsOpenResume", + "SessionsOpenResumeKind", + "SessionsOpenResumeLast", + "SessionsOpenResumeLastKind", + "SessionsOpenStatus", + "SessionsPruneOldRequest", + "SessionsRegisterExtensionToolsOnSessionOptions", + "SessionsReleaseLockRequest", + "SessionsReleaseLockResult", + "SessionsReloadPluginHooksRequest", + "SessionsReloadPluginHooksResult", + "SessionsSaveRequest", + "SessionsSaveResult", + "SessionsSetAdditionalPluginsRequest", + "SessionsSetAdditionalPluginsResult", + "SessionsSetRemoteControlSteeringRequest", + "SessionsStartRemoteControlRequest", + "SessionsStopRemoteControlRequest", + "SessionsTransferRemoteControlRequest", + "ShellApi", + "ShellCancelUserRequestedRequest", + "ShellExecRequest", + "ShellExecResult", + "ShellExecuteUserRequestedRequest", + "ShellInitProfile", + "ShellInitScript", + "ShellInitScriptShell", + "ShellKillRequest", + "ShellKillResult", + "ShellKillSignal", + "ShellOptions", + "ShutdownRequest", + "Skill", + "SkillDiscoveryPath", + "SkillDiscoveryPathList", + "SkillDiscoveryScope", + "SkillList", + "SkillsApi", + "SkillsConfigSetDisabledSkillsRequest", + "SkillsDisableRequest", + "SkillsDiscoverRequest", + "SkillsEnableRequest", + "SkillsGetDiscoveryPathsRequest", + "SkillsGetInvokedResult", + "SkillsInvokedSkill", + "SkillsLoadDiagnostics", + "SlashCommandAgentPromptResult", + "SlashCommandAgentPromptResultKind", + "SlashCommandCompletedResult", + "SlashCommandCompletedResultKind", + "SlashCommandInfo", + "SlashCommandInput", + "SlashCommandInputChoice", + "SlashCommandInputCompletion", + "SlashCommandInvocationResult", + "SlashCommandInvocationResultKind", + "SlashCommandKind", + "SlashCommandSelectSubcommandOption", + "SlashCommandSelectSubcommandResult", + "SlashCommandSelectSubcommandResultKind", + "SlashCommandTextResult", + "StickySource", + "SubagentSettings", + "SubagentSettingsEntry", + "SubagentSettingsEntryContextTier", + "TaskAgentInfo", + "TaskAgentInfoType", + "TaskAgentProgress", + "TaskExecutionMode", + "TaskInfo", + "TaskInfoExecutionMode", + "TaskInfoStatus", + "TaskInfoType", + "TaskList", + "TaskProgress", + "TaskProgressLine", + "TaskShellInfo", + "TaskShellInfoAttachmentMode", + "TaskShellInfoType", + "TaskShellProgress", + "TaskStatus", + "TaskType", + "TasksApi", + "TasksCancelRequest", + "TasksCancelResult", + "TasksGetCurrentPromotableResult", + "TasksGetProgressRequest", + "TasksGetProgressResult", + "TasksPromoteCurrentToBackgroundResult", + "TasksPromoteToBackgroundRequest", + "TasksPromoteToBackgroundResult", + "TasksRefreshResult", + "TasksRemoveRequest", + "TasksRemoveResult", + "TasksSendMessageRequest", + "TasksSendMessageResult", + "TasksStartAgentRequest", + "TasksStartAgentResult", + "TasksWaitForPendingResult", + "TelemetryApi", + "TelemetrySetFeatureOverridesRequest", + "TentacledSource", + "Theme", + "TokenAuthInfo", + "TokenAuthInfoType", + "Tool", + "ToolList", + "ToolsApi", + "ToolsGetCurrentMetadataResult", + "ToolsInitializeAndValidateResult", + "ToolsListRequest", + "ToolsUpdateSubagentSettingsResult", + "Trigger", + "UIAutoModeSwitchResponse", + "UIElicitationArrayAnyOfField", + "UIElicitationArrayAnyOfFieldItems", + "UIElicitationArrayAnyOfFieldItemsAnyOf", + "UIElicitationArrayAnyOfFieldType", + "UIElicitationArrayEnumField", + "UIElicitationArrayEnumFieldItems", + "UIElicitationArrayEnumFieldItemsType", + "UIElicitationArrayFieldItems", + "UIElicitationRequest", + "UIElicitationResponse", + "UIElicitationResponseAction", + "UIElicitationResult", + "UIElicitationSchema", + "UIElicitationSchemaProperty", + "UIElicitationSchemaPropertyBoolean", + "UIElicitationSchemaPropertyBooleanType", + "UIElicitationSchemaPropertyNumber", + "UIElicitationSchemaPropertyNumberType", + "UIElicitationSchemaPropertyString", + "UIElicitationSchemaPropertyStringFormat", + "UIElicitationSchemaPropertyType", + "UIElicitationSchemaType", + "UIElicitationStringEnumField", + "UIElicitationStringOneOfField", + "UIElicitationStringOneOfFieldOneOf", + "UIEphemeralQueryRequest", + "UIEphemeralQueryResult", + "UIExitPlanModeAction", + "UIExitPlanModeResponse", + "UIHandlePendingAutoModeSwitchRequest", + "UIHandlePendingElicitationRequest", + "UIHandlePendingExitPlanModeRequest", + "UIHandlePendingResult", + "UIHandlePendingSamplingRequest", + "UIHandlePendingSessionLimitsExhaustedRequest", + "UIHandlePendingUserInputRequest", + "UIRegisterDirectAutoModeSwitchHandlerResult", + "UISessionLimitsExhaustedResponse", + "UISessionLimitsExhaustedResponseAction", + "UIUnregisterDirectAutoModeSwitchHandlerRequest", + "UIUnregisterDirectAutoModeSwitchHandlerResult", + "UIUserInputResponse", + "UiApi", + "UpdateSubagentSettingsRequest", + "UsageApi", + "UsageGetMetricsResult", + "UsageMetricsCodeChanges", + "UsageMetricsModelMetric", + "UsageMetricsModelMetricRequests", + "UsageMetricsModelMetricTokenDetail", + "UsageMetricsModelMetricUsage", + "UsageMetricsTokenDetail", + "UserAuthInfo", + "UserAuthInfoType", + "UserRequestedShellCommandResult", + "UserSettingMetadata", + "UserSettingsGetResult", + "UserSettingsSetRequest", + "UserSettingsSetResult", + "VisibilityApi", + "VisibilityGetResult", + "VisibilitySetRequest", + "VisibilitySetResult", + "Workspace", + "WorkspaceDiffFileChange", + "WorkspaceDiffFileChangeType", + "WorkspaceDiffMode", + "WorkspaceDiffResult", + "WorkspaceSummary", + "WorkspaceSummaryHostType", + "WorkspacesAddSummaryRequest", + "WorkspacesAddSummaryResult", + "WorkspacesApi", + "WorkspacesAutopilotObjectiveExistsResult", + "WorkspacesCheckpoints", + "WorkspacesCreateFileRequest", + "WorkspacesDeleteAutopilotObjectiveResult", + "WorkspacesDiffRequest", + "WorkspacesEnsureRequest", + "WorkspacesGetWorkspaceResult", + "WorkspacesListCheckpointsResult", + "WorkspacesListFilesResult", + "WorkspacesReadAutopilotObjectiveResult", + "WorkspacesReadCheckpointRequest", + "WorkspacesReadCheckpointResult", + "WorkspacesReadFileRequest", + "WorkspacesReadFileResult", + "WorkspacesSaveLargePasteRequest", + "WorkspacesSaveLargePasteResult", + "WorkspacesTruncateSummariesRequest", + "WorkspacesUpdateMetadataRequest", + "WorkspacesWorkspaceDetailsHostType", + "WorkspacesWriteAutopilotObjectiveRequest", + "WorkspacesWriteAutopilotObjectiveResult", + "rpc_from_dict", + "rpc_to_dict", +] diff --git a/python/copilot/generated/session_events.py b/python/copilot/generated/session_events.py index 1534b718b..4c3a53e53 100644 --- a/python/copilot/generated/session_events.py +++ b/python/copilot/generated/session_events.py @@ -51,8 +51,9 @@ def from_timedelta(x: Any) -> timedelta: def to_timedelta_int(x: timedelta) -> int: assert isinstance(x, timedelta) milliseconds = x.total_seconds() * 1000.0 - assert milliseconds.is_integer() - return int(milliseconds) + # Durations can carry sub-millisecond precision; round to the nearest whole ms + # using Python's default banker's rounding (round-half-to-even). + return round(milliseconds) def to_timedelta(x: timedelta) -> float: @@ -129,42 +130,53 @@ class SessionEventType(Enum): SESSION_TITLE_CHANGED = "session.title_changed" SESSION_SCHEDULE_CREATED = "session.schedule_created" SESSION_SCHEDULE_CANCELLED = "session.schedule_cancelled" + SESSION_SCHEDULE_REARMED = "session.schedule_rearmed" SESSION_AUTOPILOT_OBJECTIVE_CHANGED = "session.autopilot_objective_changed" SESSION_INFO = "session.info" SESSION_WARNING = "session.warning" SESSION_MODEL_CHANGE = "session.model_change" SESSION_MODE_CHANGED = "session.mode_changed" + SESSION_SESSION_LIMITS_CHANGED = "session.session_limits_changed" SESSION_PERMISSIONS_CHANGED = "session.permissions_changed" SESSION_PLAN_CHANGED = "session.plan_changed" + SESSION_TODOS_CHANGED = "session.todos_changed" SESSION_WORKSPACE_FILE_CHANGED = "session.workspace_file_changed" SESSION_HANDOFF = "session.handoff" SESSION_TRUNCATION = "session.truncation" SESSION_SNAPSHOT_REWIND = "session.snapshot_rewind" SESSION_SHUTDOWN = "session.shutdown" + SESSION_USAGE_CHECKPOINT = "session.usage_checkpoint" SESSION_CONTEXT_CHANGED = "session.context_changed" SESSION_USAGE_INFO = "session.usage_info" + SESSION_CONTEXT_CLEARED = "session.context_cleared" SESSION_COMPACTION_START = "session.compaction_start" SESSION_COMPACTION_COMPLETE = "session.compaction_complete" SESSION_TASK_COMPLETE = "session.task_complete" USER_MESSAGE = "user.message" PENDING_MESSAGES_MODIFIED = "pending_messages.modified" ASSISTANT_TURN_START = "assistant.turn_start" + ASSISTANT_TURN_RETRY = "assistant.turn_retry" ASSISTANT_INTENT = "assistant.intent" + ASSISTANT_SERVER_TOOL_PROGRESS = "assistant.server_tool_progress" ASSISTANT_REASONING = "assistant.reasoning" ASSISTANT_REASONING_DELTA = "assistant.reasoning_delta" + ASSISTANT_TOOL_CALL_DELTA = "assistant.tool_call_delta" ASSISTANT_STREAMING_DELTA = "assistant.streaming_delta" ASSISTANT_MESSAGE = "assistant.message" ASSISTANT_MESSAGE_START = "assistant.message_start" ASSISTANT_MESSAGE_DELTA = "assistant.message_delta" ASSISTANT_TURN_END = "assistant.turn_end" + ASSISTANT_IDLE = "assistant.idle" ASSISTANT_USAGE = "assistant.usage" MODEL_CALL_FAILURE = "model.call_failure" + MODEL_CALL_START = "model.call_start" ABORT = "abort" TOOL_USER_REQUESTED = "tool.user_requested" TOOL_EXECUTION_START = "tool.execution_start" TOOL_EXECUTION_PARTIAL_RESULT = "tool.execution_partial_result" TOOL_EXECUTION_PROGRESS = "tool.execution_progress" TOOL_EXECUTION_COMPLETE = "tool.execution_complete" + TOOL_SEARCH_ACTIVATED = "tool_search.activated" SKILL_INVOKED = "skill.invoked" SUBAGENT_STARTED = "subagent.started" SUBAGENT_COMPLETED = "subagent.completed" @@ -174,6 +186,8 @@ class SessionEventType(Enum): HOOK_START = "hook.start" HOOK_END = "hook.end" HOOK_PROGRESS = "hook.progress" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_BINARY_ASSET = "session.binary_asset" SYSTEM_MESSAGE = "system.message" SYSTEM_NOTIFICATION = "system.notification" PERMISSION_REQUESTED = "permission.requested" @@ -186,6 +200,8 @@ class SessionEventType(Enum): SAMPLING_COMPLETED = "sampling.completed" MCP_OAUTH_REQUIRED = "mcp.oauth_required" MCP_OAUTH_COMPLETED = "mcp.oauth_completed" + MCP_HEADERS_REFRESH_REQUIRED = "mcp.headers_refresh_required" + MCP_HEADERS_REFRESH_COMPLETED = "mcp.headers_refresh_completed" SESSION_CUSTOM_NOTIFICATION = "session.custom_notification" EXTERNAL_TOOL_REQUESTED = "external_tool.requested" EXTERNAL_TOOL_COMPLETED = "external_tool.completed" @@ -194,19 +210,43 @@ class SessionEventType(Enum): COMMAND_COMPLETED = "command.completed" AUTO_MODE_SWITCH_REQUESTED = "auto_mode_switch.requested" AUTO_MODE_SWITCH_COMPLETED = "auto_mode_switch.completed" + SESSION_LIMITS_EXHAUSTED_REQUESTED = "session_limits_exhausted.requested" + SESSION_LIMITS_EXHAUSTED_COMPLETED = "session_limits_exhausted.completed" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_AUTO_MODE_RESOLVED = "session.auto_mode_resolved" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_MANAGED_SETTINGS_RESOLVED = "session.managed_settings_resolved" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_MANAGED_SETTINGS_ENFORCED = "session.managed_settings_enforced" COMMANDS_CHANGED = "commands.changed" CAPABILITIES_CHANGED = "capabilities.changed" EXIT_PLAN_MODE_REQUESTED = "exit_plan_mode.requested" EXIT_PLAN_MODE_COMPLETED = "exit_plan_mode.completed" SESSION_TOOLS_UPDATED = "session.tools_updated" SESSION_BACKGROUND_TASKS_CHANGED = "session.background_tasks_changed" + # Experimental: this event is part of an experimental API and may change or be removed. + FACTORY_RUN_UPDATED = "factory.run_updated" SESSION_SKILLS_LOADED = "session.skills_loaded" SESSION_CUSTOM_AGENTS_UPDATED = "session.custom_agents_updated" SESSION_MCP_SERVERS_LOADED = "session.mcp_servers_loaded" SESSION_MCP_SERVER_STATUS_CHANGED = "session.mcp_server_status_changed" + MCP_TOOLS_LIST_CHANGED = "mcp.tools.list_changed" + MCP_RESOURCES_LIST_CHANGED = "mcp.resources.list_changed" + MCP_PROMPTS_LIST_CHANGED = "mcp.prompts.list_changed" SESSION_EXTENSIONS_LOADED = "session.extensions_loaded" + # Experimental: this event is part of an experimental API and may change or be removed. SESSION_CANVAS_OPENED = "session.canvas.opened" + # Experimental: this event is part of an experimental API and may change or be removed. SESSION_CANVAS_REGISTRY_CHANGED = "session.canvas.registry_changed" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_CANVAS_CLOSED = "session.canvas.closed" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_CANVAS_UNAVAILABLE = "session.canvas.unavailable" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_CANVAS_RECORDED = "session.canvas.recorded" + # Experimental: this event is part of an experimental API and may change or be removed. + SESSION_CANVAS_REMOVED = "session.canvas.removed" + SESSION_EXTENSIONS_ATTACHMENTS_PUSHED = "session.extensions.attachments_pushed" MCP_APP_TOOL_CALL_COMPLETE = "mcp_app.tool_call_complete" UNKNOWN = "unknown" @@ -271,16 +311,953 @@ class Data: def __init__(self, **kwargs: Any): self._values = {key: _compat_from_json_value(value) for key, value in kwargs.items()} + self._json_keys: dict[str, str] = {} + self._json_values: dict[str, Any] | None = None for key, value in self._values.items(): setattr(self, key, value) @staticmethod def from_dict(obj: Any) -> "Data": assert isinstance(obj, dict) - return Data(**{_compat_to_python_key(key): _compat_from_json_value(value) for key, value in obj.items()}) + data = Data() + data._values = {} + data._json_keys = {} + data._json_values = {} + for key, value in obj.items(): + py_key = _compat_to_python_key(key) + json_value = _compat_from_json_value(value) + data._values[py_key] = json_value + data._json_keys[py_key] = key + data._json_values[key] = json_value + setattr(data, py_key, data._values[py_key]) + return data def to_dict(self) -> dict: - return {_compat_to_json_key(key): _compat_to_json_value(value) for key, value in self._values.items() if value is not None} + if self._json_values is not None: + return {key: _compat_to_json_value(value) for key, value in self._json_values.items() if value is not None} + return {(self._json_keys.get(key) or _compat_to_json_key(key)): _compat_to_json_value(value) for key, value in self._values.items() if value is not None} + + +# Deprecated: this type is deprecated and will be removed in a future version. +@dataclass +class ToolExecutionCompleteContentTerminal: + "Deprecated for shell command exit metadata. Use ToolExecutionCompleteContentShellExit instead." + text: str + type: ClassVar[str] = "terminal" + cwd: str | None = None + exit_code: int | None = None + + @staticmethod + def from_dict(obj: Any) -> "ToolExecutionCompleteContentTerminal": + assert isinstance(obj, dict) + text = from_str(obj.get("text")) + cwd = from_union([from_none, from_str], obj.get("cwd")) + exit_code = from_union([from_none, from_int], obj.get("exitCode")) + return ToolExecutionCompleteContentTerminal( + text=text, + cwd=cwd, + exit_code=exit_code, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["text"] = from_str(self.text) + result["type"] = self.type + if self.cwd is not None: + result["cwd"] = from_union([from_none, from_str], self.cwd) + if self.exit_code is not None: + result["exitCode"] = from_union([from_none, to_int], self.exit_code) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class AssistantMessageServerTools: + "Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping" + provider: str + advisor_model: str | None = None + function_call_namespaces: dict[str, str] | None = None + items: list[Any] | None = None + raw_content_blocks: list[Any] | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageServerTools": + assert isinstance(obj, dict) + provider = from_str(obj.get("provider")) + advisor_model = from_union([from_none, from_str], obj.get("advisorModel")) + function_call_namespaces = from_union([from_none, lambda x: from_dict(from_str, x)], obj.get("functionCallNamespaces")) + items = from_union([from_none, lambda x: from_list(lambda x: x, x)], obj.get("items")) + raw_content_blocks = from_union([from_none, lambda x: from_list(lambda x: x, x)], obj.get("rawContentBlocks")) + return AssistantMessageServerTools( + provider=provider, + advisor_model=advisor_model, + function_call_namespaces=function_call_namespaces, + items=items, + raw_content_blocks=raw_content_blocks, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["provider"] = from_str(self.provider) + if self.advisor_model is not None: + result["advisorModel"] = from_union([from_none, from_str], self.advisor_model) + if self.function_call_namespaces is not None: + result["functionCallNamespaces"] = from_union([from_none, lambda x: from_dict(from_str, x)], self.function_call_namespaces) + if self.items is not None: + result["items"] = from_union([from_none, lambda x: from_list(lambda x: x, x)], self.items) + if self.raw_content_blocks is not None: + result["rawContentBlocks"] = from_union([from_none, lambda x: from_list(lambda x: x, x)], self.raw_content_blocks) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class BinaryAssetReference: + "A reference to binary data persisted once on a session.binary_asset event and shared by id" + asset_id: str + byte_length: int + mime_type: str + type: BinaryAssetReferenceType + description: str | None = None + metadata: dict[str, Any] | None = None + + @staticmethod + def from_dict(obj: Any) -> "BinaryAssetReference": + assert isinstance(obj, dict) + asset_id = from_str(obj.get("assetId")) + byte_length = from_int(obj.get("byteLength")) + mime_type = from_str(obj.get("mimeType")) + type = parse_enum(BinaryAssetReferenceType, obj.get("type")) + description = from_union([from_none, from_str], obj.get("description")) + metadata = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("metadata")) + return BinaryAssetReference( + asset_id=asset_id, + byte_length=byte_length, + mime_type=mime_type, + type=type, + description=description, + metadata=metadata, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["assetId"] = from_str(self.asset_id) + result["byteLength"] = to_int(self.byte_length) + result["mimeType"] = from_str(self.mime_type) + result["type"] = to_enum(BinaryAssetReferenceType, self.type) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.metadata is not None: + result["metadata"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.metadata) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasRegistryChangedCanvas: + "A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions." + canvas_id: str + description: str + display_name: str + extension_id: str + actions: list[CanvasRegistryChangedCanvasAction] | None = None + extension_name: str | None = None + icon: str | None = None + input_schema: Any = None + + @staticmethod + def from_dict(obj: Any) -> "CanvasRegistryChangedCanvas": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + description = from_str(obj.get("description")) + display_name = from_str(obj.get("displayName")) + extension_id = from_str(obj.get("extensionId")) + actions = from_union([from_none, lambda x: from_list(CanvasRegistryChangedCanvasAction.from_dict, x)], obj.get("actions")) + extension_name = from_union([from_none, from_str], obj.get("extensionName")) + icon = from_union([from_none, from_str], obj.get("icon")) + input_schema = obj.get("inputSchema") + return CanvasRegistryChangedCanvas( + canvas_id=canvas_id, + description=description, + display_name=display_name, + extension_id=extension_id, + actions=actions, + extension_name=extension_name, + icon=icon, + input_schema=input_schema, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["description"] = from_str(self.description) + result["displayName"] = from_str(self.display_name) + result["extensionId"] = from_str(self.extension_id) + if self.actions is not None: + result["actions"] = from_union([from_none, lambda x: from_list(lambda x: to_class(CanvasRegistryChangedCanvasAction, x), x)], self.actions) + if self.extension_name is not None: + result["extensionName"] = from_union([from_none, from_str], self.extension_name) + if self.icon is not None: + result["icon"] = from_union([from_none, from_str], self.icon) + if self.input_schema is not None: + result["inputSchema"] = self.input_schema + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CanvasRegistryChangedCanvasAction: + "A single action within a canvas declaration, with its name, optional description, and optional input schema." + name: str + description: str | None = None + input_schema: Any = None + + @staticmethod + def from_dict(obj: Any) -> "CanvasRegistryChangedCanvasAction": + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + description = from_union([from_none, from_str], obj.get("description")) + input_schema = obj.get("inputSchema") + return CanvasRegistryChangedCanvasAction( + name=name, + description=description, + input_schema=input_schema, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.input_schema is not None: + result["inputSchema"] = self.input_schema + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitableSource: + "A source supplied by a tool that should be made available to the model as citable content." + content: str + id: str + path: str | None = None + title: str | None = None + url: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "CitableSource": + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + id = from_str(obj.get("id")) + path = from_union([from_none, from_str], obj.get("path")) + title = from_union([from_none, from_str], obj.get("title")) + url = from_union([from_none, from_str], obj.get("url")) + return CitableSource( + content=content, + id=id, + path=path, + title=title, + url=url, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["id"] = from_str(self.id) + if self.path is not None: + result["path"] = from_union([from_none, from_str], self.path) + if self.title is not None: + result["title"] = from_union([from_none, from_str], self.title) + if self.url is not None: + result["url"] = from_union([from_none, from_str], self.url) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationLocationBlock: + "A content-block range within a structured source document." + end_block: int + start_block: int + type: ClassVar[str] = "block" + + @staticmethod + def from_dict(obj: Any) -> "CitationLocationBlock": + assert isinstance(obj, dict) + end_block = from_int(obj.get("endBlock")) + start_block = from_int(obj.get("startBlock")) + return CitationLocationBlock( + end_block=end_block, + start_block=start_block, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["endBlock"] = to_int(self.end_block) + result["startBlock"] = to_int(self.start_block) + result["type"] = self.type + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationLocationChar: + "A character range within the source's text content." + end_index: int + start_index: int + type: ClassVar[str] = "char" + + @staticmethod + def from_dict(obj: Any) -> "CitationLocationChar": + assert isinstance(obj, dict) + end_index = from_int(obj.get("endIndex")) + start_index = from_int(obj.get("startIndex")) + return CitationLocationChar( + end_index=end_index, + start_index=start_index, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["endIndex"] = to_int(self.end_index) + result["startIndex"] = to_int(self.start_index) + result["type"] = self.type + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationLocationPage: + "A page range within a paginated source document." + end_page: int + start_page: int + type: ClassVar[str] = "page" + + @staticmethod + def from_dict(obj: Any) -> "CitationLocationPage": + assert isinstance(obj, dict) + end_page = from_int(obj.get("endPage")) + start_page = from_int(obj.get("startPage")) + return CitationLocationPage( + end_page=end_page, + start_page=start_page, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["endPage"] = to_int(self.end_page) + result["startPage"] = to_int(self.start_page) + result["type"] = self.type + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationReference: + "A single citation occurrence linking a span of generated text to a supporting source." + source_id: str + cited_text: str | None = None + location: CitationLocation | None = None + provider_metadata: Any = None + + @staticmethod + def from_dict(obj: Any) -> "CitationReference": + assert isinstance(obj, dict) + source_id = from_str(obj.get("sourceId")) + cited_text = from_union([from_none, from_str], obj.get("citedText")) + location = from_union([from_none, _load_CitationLocation], obj.get("location")) + provider_metadata = obj.get("providerMetadata") + return CitationReference( + source_id=source_id, + cited_text=cited_text, + location=location, + provider_metadata=provider_metadata, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["sourceId"] = from_str(self.source_id) + if self.cited_text is not None: + result["citedText"] = from_union([from_none, from_str], self.cited_text) + if self.location is not None: + result["location"] = from_union([from_none, lambda x: x.to_dict()], self.location) + if self.provider_metadata is not None: + result["providerMetadata"] = self.provider_metadata + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationSource: + "A source that backs one or more cited spans in the assistant's response." + id: str + provider: CitationProvider + path: str | None = None + title: str | None = None + url: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "CitationSource": + assert isinstance(obj, dict) + id = from_str(obj.get("id")) + provider = parse_enum(CitationProvider, obj.get("provider")) + path = from_union([from_none, from_str], obj.get("path")) + title = from_union([from_none, from_str], obj.get("title")) + url = from_union([from_none, from_str], obj.get("url")) + return CitationSource( + id=id, + provider=provider, + path=path, + title=title, + url=url, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = from_str(self.id) + result["provider"] = to_enum(CitationProvider, self.provider) + if self.path is not None: + result["path"] = from_union([from_none, from_str], self.path) + if self.title is not None: + result["title"] = from_union([from_none, from_str], self.title) + if self.url is not None: + result["url"] = from_union([from_none, from_str], self.url) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class CitationSpan: + "A contiguous span of generated assistant text and the source references that support it." + end_index: int + references: list[CitationReference] + start_index: int + + @staticmethod + def from_dict(obj: Any) -> "CitationSpan": + assert isinstance(obj, dict) + end_index = from_int(obj.get("endIndex")) + references = from_list(CitationReference.from_dict, obj.get("references")) + start_index = from_int(obj.get("startIndex")) + return CitationSpan( + end_index=end_index, + references=references, + start_index=start_index, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["endIndex"] = to_int(self.end_index) + result["references"] = from_list(lambda x: to_class(CitationReference, x), self.references) + result["startIndex"] = to_int(self.start_index) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class Citations: + "Provider-agnostic citations linking spans of the assistant's response to their supporting sources." + sources: list[CitationSource] + spans: list[CitationSpan] + + @staticmethod + def from_dict(obj: Any) -> "Citations": + assert isinstance(obj, dict) + sources = from_list(CitationSource.from_dict, obj.get("sources")) + spans = from_list(CitationSpan.from_dict, obj.get("spans")) + return Citations( + sources=sources, + spans=spans, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["sources"] = from_list(lambda x: to_class(CitationSource, x), self.sources) + result["spans"] = from_list(lambda x: to_class(CitationSpan, x), self.spans) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class FactoryRunUpdatedData: + "Ephemeral invalidation signal for a changed factory run." + revision: int + run_id: str + + @staticmethod + def from_dict(obj: Any) -> "FactoryRunUpdatedData": + assert isinstance(obj, dict) + revision = from_int(obj.get("revision")) + run_id = from_str(obj.get("runId")) + return FactoryRunUpdatedData( + revision=revision, + run_id=run_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["revision"] = to_int(self.revision) + result["runId"] = from_str(self.run_id) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class OmittedBinaryResult: + "A binary result whose data was omitted from persistence due to the inline size limit" + byte_length: int + mime_type: str + omitted_reason: OmittedBinaryOmittedReason + type: OmittedBinaryType + description: str | None = None + metadata: dict[str, Any] | None = None + + @staticmethod + def from_dict(obj: Any) -> "OmittedBinaryResult": + assert isinstance(obj, dict) + byte_length = from_int(obj.get("byteLength")) + mime_type = from_str(obj.get("mimeType")) + omitted_reason = parse_enum(OmittedBinaryOmittedReason, obj.get("omittedReason")) + type = parse_enum(OmittedBinaryType, obj.get("type")) + description = from_union([from_none, from_str], obj.get("description")) + metadata = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("metadata")) + return OmittedBinaryResult( + byte_length=byte_length, + mime_type=mime_type, + omitted_reason=omitted_reason, + type=type, + description=description, + metadata=metadata, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["byteLength"] = to_int(self.byte_length) + result["mimeType"] = from_str(self.mime_type) + result["omittedReason"] = to_enum(OmittedBinaryOmittedReason, self.omitted_reason) + result["type"] = to_enum(OmittedBinaryType, self.type) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.metadata is not None: + result["metadata"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.metadata) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class PermissionAutoApproval: + "Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is \"auto\"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request." + recommendation: AutoApprovalRecommendation + failure_reason: AutoApprovalJudgeFailureReason | None = None + model: str | None = None + reason: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "PermissionAutoApproval": + assert isinstance(obj, dict) + recommendation = parse_enum(AutoApprovalRecommendation, obj.get("recommendation")) + failure_reason = from_union([from_none, lambda x: parse_enum(AutoApprovalJudgeFailureReason, x)], obj.get("failureReason")) + model = from_union([from_none, from_str], obj.get("model")) + reason = from_union([from_none, from_str], obj.get("reason")) + return PermissionAutoApproval( + recommendation=recommendation, + failure_reason=failure_reason, + model=model, + reason=reason, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["recommendation"] = to_enum(AutoApprovalRecommendation, self.recommendation) + if self.failure_reason is not None: + result["failureReason"] = from_union([from_none, lambda x: to_enum(AutoApprovalJudgeFailureReason, x)], self.failure_reason) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + if self.reason is not None: + result["reason"] = from_union([from_none, from_str], self.reason) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionAutoModeResolvedData: + "Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability." + chosen_model: str + available_models: list[str] | None = None + candidate_models: list[str] | None = None + category_scores: dict[str, float] | None = None + chosen_shortfall: float | None = None + confidence: float | None = None + end_to_end_latency_ms: float | None = None + fallback: bool | None = None + fallback_reason: str | None = None + has_image: bool | None = None + predicted_label: str | None = None + reasoning_bucket: AutoModeResolvedReasoningBucket | None = None + router_latency_ms: float | None = None + routing_method: str | None = None + sticky_override: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionAutoModeResolvedData": + assert isinstance(obj, dict) + chosen_model = from_str(obj.get("chosenModel")) + available_models = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("availableModels")) + candidate_models = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("candidateModels")) + category_scores = from_union([from_none, lambda x: from_dict(from_float, x)], obj.get("categoryScores")) + chosen_shortfall = from_union([from_none, from_float], obj.get("chosenShortfall")) + confidence = from_union([from_none, from_float], obj.get("confidence")) + end_to_end_latency_ms = from_union([from_none, from_float], obj.get("endToEndLatencyMs")) + fallback = from_union([from_none, from_bool], obj.get("fallback")) + fallback_reason = from_union([from_none, from_str], obj.get("fallbackReason")) + has_image = from_union([from_none, from_bool], obj.get("hasImage")) + predicted_label = from_union([from_none, from_str], obj.get("predictedLabel")) + reasoning_bucket = from_union([from_none, lambda x: parse_enum(AutoModeResolvedReasoningBucket, x)], obj.get("reasoningBucket")) + router_latency_ms = from_union([from_none, from_float], obj.get("routerLatencyMs")) + routing_method = from_union([from_none, from_str], obj.get("routingMethod")) + sticky_override = from_union([from_none, from_bool], obj.get("stickyOverride")) + return SessionAutoModeResolvedData( + chosen_model=chosen_model, + available_models=available_models, + candidate_models=candidate_models, + category_scores=category_scores, + chosen_shortfall=chosen_shortfall, + confidence=confidence, + end_to_end_latency_ms=end_to_end_latency_ms, + fallback=fallback, + fallback_reason=fallback_reason, + has_image=has_image, + predicted_label=predicted_label, + reasoning_bucket=reasoning_bucket, + router_latency_ms=router_latency_ms, + routing_method=routing_method, + sticky_override=sticky_override, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["chosenModel"] = from_str(self.chosen_model) + if self.available_models is not None: + result["availableModels"] = from_union([from_none, lambda x: from_list(from_str, x)], self.available_models) + if self.candidate_models is not None: + result["candidateModels"] = from_union([from_none, lambda x: from_list(from_str, x)], self.candidate_models) + if self.category_scores is not None: + result["categoryScores"] = from_union([from_none, lambda x: from_dict(to_float, x)], self.category_scores) + if self.chosen_shortfall is not None: + result["chosenShortfall"] = from_union([from_none, to_float], self.chosen_shortfall) + if self.confidence is not None: + result["confidence"] = from_union([from_none, to_float], self.confidence) + if self.end_to_end_latency_ms is not None: + result["endToEndLatencyMs"] = from_union([from_none, to_float], self.end_to_end_latency_ms) + if self.fallback is not None: + result["fallback"] = from_union([from_none, from_bool], self.fallback) + if self.fallback_reason is not None: + result["fallbackReason"] = from_union([from_none, from_str], self.fallback_reason) + if self.has_image is not None: + result["hasImage"] = from_union([from_none, from_bool], self.has_image) + if self.predicted_label is not None: + result["predictedLabel"] = from_union([from_none, from_str], self.predicted_label) + if self.reasoning_bucket is not None: + result["reasoningBucket"] = from_union([from_none, lambda x: to_enum(AutoModeResolvedReasoningBucket, x)], self.reasoning_bucket) + if self.router_latency_ms is not None: + result["routerLatencyMs"] = from_union([from_none, to_float], self.router_latency_ms) + if self.routing_method is not None: + result["routingMethod"] = from_union([from_none, from_str], self.routing_method) + if self.sticky_override is not None: + result["stickyOverride"] = from_union([from_none, from_bool], self.sticky_override) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasClosedData: + "Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID." + canvas_id: str + extension_id: str + instance_id: str + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasClosedData": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + return SessionCanvasClosedData( + canvas_id=canvas_id, + extension_id=extension_id, + instance_id=instance_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasOpenedData: + "Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input." + canvas_id: str + extension_id: str + instance_id: str + extension_name: str | None = None + icon: str | None = None + input: Any = None + status: str | None = None + title: str | None = None + url: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasOpenedData": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + extension_name = from_union([from_none, from_str], obj.get("extensionName")) + icon = from_union([from_none, from_str], obj.get("icon")) + input = obj.get("input") + status = from_union([from_none, from_str], obj.get("status")) + title = from_union([from_none, from_str], obj.get("title")) + url = from_union([from_none, from_str], obj.get("url")) + return SessionCanvasOpenedData( + canvas_id=canvas_id, + extension_id=extension_id, + instance_id=instance_id, + extension_name=extension_name, + icon=icon, + input=input, + status=status, + title=title, + url=url, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + if self.extension_name is not None: + result["extensionName"] = from_union([from_none, from_str], self.extension_name) + if self.icon is not None: + result["icon"] = from_union([from_none, from_str], self.icon) + if self.input is not None: + result["input"] = self.input + if self.status is not None: + result["status"] = from_union([from_none, from_str], self.status) + if self.title is not None: + result["title"] = from_union([from_none, from_str], self.title) + if self.url is not None: + result["url"] = from_union([from_none, from_str], self.url) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasRecordedData: + "Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability." + canvas_id: str + extension_id: str + instance_id: str + input: Any = None + title: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasRecordedData": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + input = obj.get("input") + title = from_union([from_none, from_str], obj.get("title")) + return SessionCanvasRecordedData( + canvas_id=canvas_id, + extension_id=extension_id, + instance_id=instance_id, + input=input, + title=title, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + if self.input is not None: + result["input"] = self.input + if self.title is not None: + result["title"] = from_union([from_none, from_str], self.title) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasRegistryChangedData: + "Payload of `session.canvas.registry_changed` listing the canvas declarations currently available." + canvases: list[CanvasRegistryChangedCanvas] + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasRegistryChangedData": + assert isinstance(obj, dict) + canvases = from_list(CanvasRegistryChangedCanvas.from_dict, obj.get("canvases")) + return SessionCanvasRegistryChangedData( + canvases=canvases, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvases"] = from_list(lambda x: to_class(CanvasRegistryChangedCanvas, x), self.canvases) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasRemovedData: + "Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay." + canvas_id: str + extension_id: str + instance_id: str + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasRemovedData": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + return SessionCanvasRemovedData( + canvas_id=canvas_id, + extension_id=extension_id, + instance_id=instance_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionCanvasUnavailableData: + "Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume." + canvas_id: str + extension_id: str + instance_id: str + + @staticmethod + def from_dict(obj: Any) -> "SessionCanvasUnavailableData": + assert isinstance(obj, dict) + canvas_id = from_str(obj.get("canvasId")) + extension_id = from_str(obj.get("extensionId")) + instance_id = from_str(obj.get("instanceId")) + return SessionCanvasUnavailableData( + canvas_id=canvas_id, + extension_id=extension_id, + instance_id=instance_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["canvasId"] = from_str(self.canvas_id) + result["extensionId"] = from_str(self.extension_id) + result["instanceId"] = from_str(self.instance_id) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionManagedSettingsEnforcedData: + "Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes." + action: ManagedSettingsEnforcedAction + fail_closed: bool + message: str + setting: str + escalation: ManagedSettingsEnforcedEscalation | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionManagedSettingsEnforcedData": + assert isinstance(obj, dict) + action = parse_enum(ManagedSettingsEnforcedAction, obj.get("action")) + fail_closed = from_bool(obj.get("failClosed")) + message = from_str(obj.get("message")) + setting = from_str(obj.get("setting")) + escalation = from_union([from_none, lambda x: parse_enum(ManagedSettingsEnforcedEscalation, x)], obj.get("escalation")) + return SessionManagedSettingsEnforcedData( + action=action, + fail_closed=fail_closed, + message=message, + setting=setting, + escalation=escalation, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["action"] = to_enum(ManagedSettingsEnforcedAction, self.action) + result["failClosed"] = from_bool(self.fail_closed) + result["message"] = from_str(self.message) + result["setting"] = from_str(self.setting) + if self.escalation is not None: + result["escalation"] = from_union([from_none, lambda x: to_enum(ManagedSettingsEnforcedEscalation, x)], self.escalation) + return result + + +# Experimental: this type is part of an experimental API and may change or be removed. +@dataclass +class SessionManagedSettingsResolvedData: + "Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes." + bypass_permissions_disabled: bool + device_managed: bool + fail_closed: bool + managed_keys: list[str] + server_managed: bool + source: ManagedSettingsResolvedSource + client_managed: bool | None = None + permissions_allow_intersected: bool | None = None + settings: Any = None + + @staticmethod + def from_dict(obj: Any) -> "SessionManagedSettingsResolvedData": + assert isinstance(obj, dict) + bypass_permissions_disabled = from_bool(obj.get("bypassPermissionsDisabled")) + device_managed = from_bool(obj.get("deviceManaged")) + fail_closed = from_bool(obj.get("failClosed")) + managed_keys = from_list(from_str, obj.get("managedKeys")) + server_managed = from_bool(obj.get("serverManaged")) + source = parse_enum(ManagedSettingsResolvedSource, obj.get("source")) + client_managed = from_union([from_none, from_bool], obj.get("clientManaged")) + permissions_allow_intersected = from_union([from_none, from_bool], obj.get("permissionsAllowIntersected")) + settings = obj.get("settings") + return SessionManagedSettingsResolvedData( + bypass_permissions_disabled=bypass_permissions_disabled, + device_managed=device_managed, + fail_closed=fail_closed, + managed_keys=managed_keys, + server_managed=server_managed, + source=source, + client_managed=client_managed, + permissions_allow_intersected=permissions_allow_intersected, + settings=settings, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["bypassPermissionsDisabled"] = from_bool(self.bypass_permissions_disabled) + result["deviceManaged"] = from_bool(self.device_managed) + result["failClosed"] = from_bool(self.fail_closed) + result["managedKeys"] = from_list(from_str, self.managed_keys) + result["serverManaged"] = from_bool(self.server_managed) + result["source"] = to_enum(ManagedSettingsResolvedSource, self.source) + if self.client_managed is not None: + result["clientManaged"] = from_union([from_none, from_bool], self.client_managed) + if self.permissions_allow_intersected is not None: + result["permissionsAllowIntersected"] = from_union([from_none, from_bool], self.permissions_allow_intersected) + if self.settings is not None: + result["settings"] = self.settings + return result @dataclass @@ -289,568 +1266,1470 @@ class AbortData: reason: AbortReason @staticmethod - def from_dict(obj: Any) -> "AbortData": + def from_dict(obj: Any) -> "AbortData": + assert isinstance(obj, dict) + reason = parse_enum(AbortReason, obj.get("reason")) + return AbortData( + reason=reason, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["reason"] = to_enum(AbortReason, self.reason) + return result + + +@dataclass +class AssistantIdleData: + "Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred" + aborted: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantIdleData": + assert isinstance(obj, dict) + aborted = from_union([from_none, from_bool], obj.get("aborted")) + return AssistantIdleData( + aborted=aborted, + ) + + def to_dict(self) -> dict: + result: dict = {} + if self.aborted is not None: + result["aborted"] = from_union([from_none, from_bool], self.aborted) + return result + + +@dataclass +class AssistantIntentData: + "Agent intent description for current activity or plan" + intent: str + + @staticmethod + def from_dict(obj: Any) -> "AssistantIntentData": + assert isinstance(obj, dict) + intent = from_str(obj.get("intent")) + return AssistantIntentData( + intent=intent, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["intent"] = from_str(self.intent) + return result + + +@dataclass +class AssistantMessageData: + "Assistant response containing text content, optional tool requests, and interaction metadata" + content: str + message_id: str + api_call_id: str | None = None + chunk_count: int | None = None + chunk_index: int | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + citations: Citations | None = None + client_request_id: str | None = None + encrypted_content: str | None = None + interaction_id: str | None = None + model: str | None = None + output_tokens: int | None = None + # Deprecated: this field is deprecated. + parent_tool_call_id: str | None = None + phase: str | None = None + reasoning_opaque: str | None = None + reasoning_text: str | None = None + reasoning_wire_field: str | None = None + request_id: str | None = None + rte: bool | None = None + server_tools: AssistantMessageServerTools | None = None + service_request_id: str | None = None + tool_requests: list[AssistantMessageToolRequest] | None = None + turn_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageData": + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + message_id = from_str(obj.get("messageId")) + api_call_id = from_union([from_none, from_str], obj.get("apiCallId")) + chunk_count = from_union([from_none, from_int], obj.get("chunkCount")) + chunk_index = from_union([from_none, from_int], obj.get("chunkIndex")) + citations = from_union([from_none, Citations.from_dict], obj.get("citations")) + client_request_id = from_union([from_none, from_str], obj.get("clientRequestId")) + encrypted_content = from_union([from_none, from_str], obj.get("encryptedContent")) + interaction_id = from_union([from_none, from_str], obj.get("interactionId")) + model = from_union([from_none, from_str], obj.get("model")) + output_tokens = from_union([from_none, from_int], obj.get("outputTokens")) + parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) + phase = from_union([from_none, from_str], obj.get("phase")) + reasoning_opaque = from_union([from_none, from_str], obj.get("reasoningOpaque")) + reasoning_text = from_union([from_none, from_str], obj.get("reasoningText")) + reasoning_wire_field = from_union([from_none, from_str], obj.get("reasoningWireField")) + request_id = from_union([from_none, from_str], obj.get("requestId")) + rte = from_union([from_none, from_bool], obj.get("rte")) + server_tools = from_union([from_none, AssistantMessageServerTools.from_dict], obj.get("serverTools")) + service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) + tool_requests = from_union([from_none, lambda x: from_list(AssistantMessageToolRequest.from_dict, x)], obj.get("toolRequests")) + turn_id = from_union([from_none, from_str], obj.get("turnId")) + return AssistantMessageData( + content=content, + message_id=message_id, + api_call_id=api_call_id, + chunk_count=chunk_count, + chunk_index=chunk_index, + citations=citations, + client_request_id=client_request_id, + encrypted_content=encrypted_content, + interaction_id=interaction_id, + model=model, + output_tokens=output_tokens, + parent_tool_call_id=parent_tool_call_id, + phase=phase, + reasoning_opaque=reasoning_opaque, + reasoning_text=reasoning_text, + reasoning_wire_field=reasoning_wire_field, + request_id=request_id, + rte=rte, + server_tools=server_tools, + service_request_id=service_request_id, + tool_requests=tool_requests, + turn_id=turn_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["messageId"] = from_str(self.message_id) + if self.api_call_id is not None: + result["apiCallId"] = from_union([from_none, from_str], self.api_call_id) + if self.chunk_count is not None: + result["chunkCount"] = from_union([from_none, to_int], self.chunk_count) + if self.chunk_index is not None: + result["chunkIndex"] = from_union([from_none, to_int], self.chunk_index) + if self.citations is not None: + result["citations"] = from_union([from_none, lambda x: to_class(Citations, x)], self.citations) + if self.client_request_id is not None: + result["clientRequestId"] = from_union([from_none, from_str], self.client_request_id) + if self.encrypted_content is not None: + result["encryptedContent"] = from_union([from_none, from_str], self.encrypted_content) + if self.interaction_id is not None: + result["interactionId"] = from_union([from_none, from_str], self.interaction_id) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + if self.output_tokens is not None: + result["outputTokens"] = from_union([from_none, to_int], self.output_tokens) + if self.parent_tool_call_id is not None: + result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) + if self.phase is not None: + result["phase"] = from_union([from_none, from_str], self.phase) + if self.reasoning_opaque is not None: + result["reasoningOpaque"] = from_union([from_none, from_str], self.reasoning_opaque) + if self.reasoning_text is not None: + result["reasoningText"] = from_union([from_none, from_str], self.reasoning_text) + if self.reasoning_wire_field is not None: + result["reasoningWireField"] = from_union([from_none, from_str], self.reasoning_wire_field) + if self.request_id is not None: + result["requestId"] = from_union([from_none, from_str], self.request_id) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) + if self.server_tools is not None: + result["serverTools"] = from_union([from_none, lambda x: to_class(AssistantMessageServerTools, x)], self.server_tools) + if self.service_request_id is not None: + result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) + if self.tool_requests is not None: + result["toolRequests"] = from_union([from_none, lambda x: from_list(lambda x: to_class(AssistantMessageToolRequest, x), x)], self.tool_requests) + if self.turn_id is not None: + result["turnId"] = from_union([from_none, from_str], self.turn_id) + return result + + +@dataclass +class AssistantMessageDeltaData: + "Streaming assistant message delta for incremental response updates" + delta_content: str + message_id: str + # Deprecated: this field is deprecated. + parent_tool_call_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageDeltaData": + assert isinstance(obj, dict) + delta_content = from_str(obj.get("deltaContent")) + message_id = from_str(obj.get("messageId")) + parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) + return AssistantMessageDeltaData( + delta_content=delta_content, + message_id=message_id, + parent_tool_call_id=parent_tool_call_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["deltaContent"] = from_str(self.delta_content) + result["messageId"] = from_str(self.message_id) + if self.parent_tool_call_id is not None: + result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) + return result + + +@dataclass +class AssistantMessageStartData: + "Streaming assistant message start metadata" + message_id: str + phase: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageStartData": + assert isinstance(obj, dict) + message_id = from_str(obj.get("messageId")) + phase = from_union([from_none, from_str], obj.get("phase")) + return AssistantMessageStartData( + message_id=message_id, + phase=phase, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["messageId"] = from_str(self.message_id) + if self.phase is not None: + result["phase"] = from_union([from_none, from_str], self.phase) + return result + + +@dataclass +class AssistantMessageToolRequest: + "A tool invocation request from the assistant" + name: str + tool_call_id: str + arguments: Any = None + intention_summary: str | None = None + mcp_server_name: str | None = None + mcp_tool_name: str | None = None + tool_title: str | None = None + type: AssistantMessageToolRequestType | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantMessageToolRequest": + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + tool_call_id = from_str(obj.get("toolCallId")) + arguments = obj.get("arguments") + intention_summary = from_union([from_none, from_str], obj.get("intentionSummary")) + mcp_server_name = from_union([from_none, from_str], obj.get("mcpServerName")) + mcp_tool_name = from_union([from_none, from_str], obj.get("mcpToolName")) + tool_title = from_union([from_none, from_str], obj.get("toolTitle")) + type = from_union([from_none, lambda x: parse_enum(AssistantMessageToolRequestType, x)], obj.get("type")) + return AssistantMessageToolRequest( + name=name, + tool_call_id=tool_call_id, + arguments=arguments, + intention_summary=intention_summary, + mcp_server_name=mcp_server_name, + mcp_tool_name=mcp_tool_name, + tool_title=tool_title, + type=type, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["toolCallId"] = from_str(self.tool_call_id) + if self.arguments is not None: + result["arguments"] = self.arguments + if self.intention_summary is not None: + result["intentionSummary"] = from_union([from_none, from_str], self.intention_summary) + if self.mcp_server_name is not None: + result["mcpServerName"] = from_union([from_none, from_str], self.mcp_server_name) + if self.mcp_tool_name is not None: + result["mcpToolName"] = from_union([from_none, from_str], self.mcp_tool_name) + if self.tool_title is not None: + result["toolTitle"] = from_union([from_none, from_str], self.tool_title) + if self.type is not None: + result["type"] = from_union([from_none, lambda x: to_enum(AssistantMessageToolRequestType, x)], self.type) + return result + + +@dataclass +class AssistantReasoningData: + "Assistant reasoning content for timeline display with complete thinking text" + content: str + reasoning_id: str + rte: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantReasoningData": + assert isinstance(obj, dict) + content = from_str(obj.get("content")) + reasoning_id = from_str(obj.get("reasoningId")) + rte = from_union([from_none, from_bool], obj.get("rte")) + return AssistantReasoningData( + content=content, + reasoning_id=reasoning_id, + rte=rte, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["content"] = from_str(self.content) + result["reasoningId"] = from_str(self.reasoning_id) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) + return result + + +@dataclass +class AssistantReasoningDeltaData: + "Streaming reasoning delta for incremental extended thinking updates" + delta_content: str + reasoning_id: str + + @staticmethod + def from_dict(obj: Any) -> "AssistantReasoningDeltaData": + assert isinstance(obj, dict) + delta_content = from_str(obj.get("deltaContent")) + reasoning_id = from_str(obj.get("reasoningId")) + return AssistantReasoningDeltaData( + delta_content=delta_content, + reasoning_id=reasoning_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["deltaContent"] = from_str(self.delta_content) + result["reasoningId"] = from_str(self.reasoning_id) + return result + + +@dataclass +class AssistantServerToolProgressData: + "Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message" + kind: str + output_index: int + status: str + + @staticmethod + def from_dict(obj: Any) -> "AssistantServerToolProgressData": + assert isinstance(obj, dict) + kind = from_str(obj.get("kind")) + output_index = from_int(obj.get("outputIndex")) + status = from_str(obj.get("status")) + return AssistantServerToolProgressData( + kind=kind, + output_index=output_index, + status=status, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = from_str(self.kind) + result["outputIndex"] = to_int(self.output_index) + result["status"] = from_str(self.status) + return result + + +@dataclass +class AssistantStreamingDeltaData: + "Streaming response progress with cumulative byte count" + total_response_size_bytes: int + + @staticmethod + def from_dict(obj: Any) -> "AssistantStreamingDeltaData": + assert isinstance(obj, dict) + total_response_size_bytes = from_int(obj.get("totalResponseSizeBytes")) + return AssistantStreamingDeltaData( + total_response_size_bytes=total_response_size_bytes, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["totalResponseSizeBytes"] = to_int(self.total_response_size_bytes) + return result + + +@dataclass +class AssistantToolCallDeltaData: + "Streaming tool-call input delta for incremental tool-call updates" + input_delta: str + tool_call_id: str + tool_name: str | None = None + tool_type: AssistantMessageToolRequestType | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantToolCallDeltaData": + assert isinstance(obj, dict) + input_delta = from_str(obj.get("inputDelta")) + tool_call_id = from_str(obj.get("toolCallId")) + tool_name = from_union([from_none, from_str], obj.get("toolName")) + tool_type = from_union([from_none, lambda x: parse_enum(AssistantMessageToolRequestType, x)], obj.get("toolType")) + return AssistantToolCallDeltaData( + input_delta=input_delta, + tool_call_id=tool_call_id, + tool_name=tool_name, + tool_type=tool_type, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["inputDelta"] = from_str(self.input_delta) + result["toolCallId"] = from_str(self.tool_call_id) + if self.tool_name is not None: + result["toolName"] = from_union([from_none, from_str], self.tool_name) + if self.tool_type is not None: + result["toolType"] = from_union([from_none, lambda x: to_enum(AssistantMessageToolRequestType, x)], self.tool_type) + return result + + +@dataclass +class AssistantTurnEndData: + "Turn completion metadata including the turn identifier" + turn_id: str + model: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantTurnEndData": + assert isinstance(obj, dict) + turn_id = from_str(obj.get("turnId")) + model = from_union([from_none, from_str], obj.get("model")) + return AssistantTurnEndData( + turn_id=turn_id, + model=model, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["turnId"] = from_str(self.turn_id) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + return result + + +@dataclass +class AssistantTurnRetryData: + "Metadata for an additional model inference attempt within an existing assistant turn" + turn_id: str + model: str | None = None + reason: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantTurnRetryData": + assert isinstance(obj, dict) + turn_id = from_str(obj.get("turnId")) + model = from_union([from_none, from_str], obj.get("model")) + reason = from_union([from_none, from_str], obj.get("reason")) + return AssistantTurnRetryData( + turn_id=turn_id, + model=model, + reason=reason, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["turnId"] = from_str(self.turn_id) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + if self.reason is not None: + result["reason"] = from_union([from_none, from_str], self.reason) + return result + + +@dataclass +class AssistantTurnStartData: + "Turn initialization metadata including identifier and interaction tracking" + turn_id: str + interaction_id: str | None = None + model: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantTurnStartData": + assert isinstance(obj, dict) + turn_id = from_str(obj.get("turnId")) + interaction_id = from_union([from_none, from_str], obj.get("interactionId")) + model = from_union([from_none, from_str], obj.get("model")) + return AssistantTurnStartData( + turn_id=turn_id, + interaction_id=interaction_id, + model=model, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["turnId"] = from_str(self.turn_id) + if self.interaction_id is not None: + result["interactionId"] = from_union([from_none, from_str], self.interaction_id) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + return result + + +@dataclass +class AssistantUsageCopilotUsage: + "Per-request cost and usage data from the CAPI copilot_usage response field" + total_nano_aiu: float + # Internal: this field is an internal SDK API and is not part of the public surface. + _token_details: list[AssistantUsageCopilotUsageTokenDetail] | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantUsageCopilotUsage": + assert isinstance(obj, dict) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + _token_details = from_union([from_none, lambda x: from_list(AssistantUsageCopilotUsageTokenDetail.from_dict, x)], obj.get("tokenDetails")) + return AssistantUsageCopilotUsage( + total_nano_aiu=total_nano_aiu, + _token_details=_token_details, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self._token_details is not None: + result["tokenDetails"] = from_union([from_none, lambda x: from_list(lambda x: to_class(AssistantUsageCopilotUsageTokenDetail, x), x)], self._token_details) + return result + + +@dataclass +class AssistantUsageCopilotUsageTokenDetail: + "Token usage detail for a single billing category" + batch_size: int + cost_per_batch: int + token_count: int + token_type: str + + @staticmethod + def from_dict(obj: Any) -> "AssistantUsageCopilotUsageTokenDetail": + assert isinstance(obj, dict) + batch_size = from_int(obj.get("batchSize")) + cost_per_batch = from_int(obj.get("costPerBatch")) + token_count = from_int(obj.get("tokenCount")) + token_type = from_str(obj.get("tokenType")) + return AssistantUsageCopilotUsageTokenDetail( + batch_size=batch_size, + cost_per_batch=cost_per_batch, + token_count=token_count, + token_type=token_type, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["batchSize"] = to_int(self.batch_size) + result["costPerBatch"] = to_int(self.cost_per_batch) + result["tokenCount"] = to_int(self.token_count) + result["tokenType"] = from_str(self.token_type) + return result + + +@dataclass +class AssistantUsageData: + "LLM API call usage metrics including tokens, costs, quotas, and billing information" + model: str + api_call_id: str | None = None + api_endpoint: AssistantUsageApiEndpoint | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _available_tool_count: int | None = None + cache_expires_at: datetime | None = None + cache_read_tokens: int | None = None + cache_write_tokens: int | None = None + content_filter_triggered: bool | None = None + copilot_usage: AssistantUsageCopilotUsage | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + cost: float | None = None + duration: timedelta | None = None + finish_reason: str | None = None + initiator: str | None = None + input_tokens: int | None = None + interaction_type: str | None = None + inter_token_latency: timedelta | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _num_tool_calls: int | None = None + output_tokens: int | None = None + # Deprecated: this field is deprecated. + parent_tool_call_id: str | None = None + provider_call_id: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _quota_snapshots: dict[str, _AssistantUsageQuotaSnapshot] | None = None + reasoning_effort: str | None = None + reasoning_tokens: int | None = None + rte: bool | None = None + service_request_id: str | None = None + time_to_first_token: timedelta | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tool_counts: dict[str, int] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _tool_token_count: int | None = None + + @staticmethod + def from_dict(obj: Any) -> "AssistantUsageData": + assert isinstance(obj, dict) + model = from_str(obj.get("model")) + api_call_id = from_union([from_none, from_str], obj.get("apiCallId")) + api_endpoint = from_union([from_none, lambda x: parse_enum(AssistantUsageApiEndpoint, x)], obj.get("apiEndpoint")) + _available_tool_count = from_union([from_none, from_int], obj.get("availableToolCount")) + cache_expires_at = from_union([from_none, from_datetime], obj.get("cacheExpiresAt")) + cache_read_tokens = from_union([from_none, from_int], obj.get("cacheReadTokens")) + cache_write_tokens = from_union([from_none, from_int], obj.get("cacheWriteTokens")) + content_filter_triggered = from_union([from_none, from_bool], obj.get("contentFilterTriggered")) + copilot_usage = from_union([from_none, AssistantUsageCopilotUsage.from_dict], obj.get("copilotUsage")) + cost = from_union([from_none, from_float], obj.get("cost")) + duration = from_union([from_none, from_timedelta], obj.get("duration")) + finish_reason = from_union([from_none, from_str], obj.get("finishReason")) + initiator = from_union([from_none, from_str], obj.get("initiator")) + input_tokens = from_union([from_none, from_int], obj.get("inputTokens")) + interaction_type = from_union([from_none, from_str], obj.get("interactionType")) + inter_token_latency = from_union([from_none, from_timedelta], obj.get("interTokenLatencyMs")) + _num_tool_calls = from_union([from_none, from_int], obj.get("numToolCalls")) + output_tokens = from_union([from_none, from_int], obj.get("outputTokens")) + parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) + provider_call_id = from_union([from_none, from_str], obj.get("providerCallId")) + _quota_snapshots = from_union([from_none, lambda x: from_dict(_AssistantUsageQuotaSnapshot.from_dict, x)], obj.get("quotaSnapshots")) + reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) + reasoning_tokens = from_union([from_none, from_int], obj.get("reasoningTokens")) + rte = from_union([from_none, from_bool], obj.get("rte")) + service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) + time_to_first_token = from_union([from_none, from_timedelta], obj.get("timeToFirstTokenMs")) + _tool_counts = from_union([from_none, lambda x: from_dict(from_int, x)], obj.get("toolCounts")) + _tool_token_count = from_union([from_none, from_int], obj.get("toolTokenCount")) + return AssistantUsageData( + model=model, + api_call_id=api_call_id, + api_endpoint=api_endpoint, + _available_tool_count=_available_tool_count, + cache_expires_at=cache_expires_at, + cache_read_tokens=cache_read_tokens, + cache_write_tokens=cache_write_tokens, + content_filter_triggered=content_filter_triggered, + copilot_usage=copilot_usage, + cost=cost, + duration=duration, + finish_reason=finish_reason, + initiator=initiator, + input_tokens=input_tokens, + interaction_type=interaction_type, + inter_token_latency=inter_token_latency, + _num_tool_calls=_num_tool_calls, + output_tokens=output_tokens, + parent_tool_call_id=parent_tool_call_id, + provider_call_id=provider_call_id, + _quota_snapshots=_quota_snapshots, + reasoning_effort=reasoning_effort, + reasoning_tokens=reasoning_tokens, + rte=rte, + service_request_id=service_request_id, + time_to_first_token=time_to_first_token, + _tool_counts=_tool_counts, + _tool_token_count=_tool_token_count, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["model"] = from_str(self.model) + if self.api_call_id is not None: + result["apiCallId"] = from_union([from_none, from_str], self.api_call_id) + if self.api_endpoint is not None: + result["apiEndpoint"] = from_union([from_none, lambda x: to_enum(AssistantUsageApiEndpoint, x)], self.api_endpoint) + if self._available_tool_count is not None: + result["availableToolCount"] = from_union([from_none, to_int], self._available_tool_count) + if self.cache_expires_at is not None: + result["cacheExpiresAt"] = from_union([from_none, to_datetime], self.cache_expires_at) + if self.cache_read_tokens is not None: + result["cacheReadTokens"] = from_union([from_none, to_int], self.cache_read_tokens) + if self.cache_write_tokens is not None: + result["cacheWriteTokens"] = from_union([from_none, to_int], self.cache_write_tokens) + if self.content_filter_triggered is not None: + result["contentFilterTriggered"] = from_union([from_none, from_bool], self.content_filter_triggered) + if self.copilot_usage is not None: + result["copilotUsage"] = from_union([from_none, lambda x: to_class(AssistantUsageCopilotUsage, x)], self.copilot_usage) + if self.cost is not None: + result["cost"] = from_union([from_none, to_float], self.cost) + if self.duration is not None: + result["duration"] = from_union([from_none, to_timedelta_int], self.duration) + if self.finish_reason is not None: + result["finishReason"] = from_union([from_none, from_str], self.finish_reason) + if self.initiator is not None: + result["initiator"] = from_union([from_none, from_str], self.initiator) + if self.input_tokens is not None: + result["inputTokens"] = from_union([from_none, to_int], self.input_tokens) + if self.interaction_type is not None: + result["interactionType"] = from_union([from_none, from_str], self.interaction_type) + if self.inter_token_latency is not None: + result["interTokenLatencyMs"] = from_union([from_none, to_timedelta], self.inter_token_latency) + if self._num_tool_calls is not None: + result["numToolCalls"] = from_union([from_none, to_int], self._num_tool_calls) + if self.output_tokens is not None: + result["outputTokens"] = from_union([from_none, to_int], self.output_tokens) + if self.parent_tool_call_id is not None: + result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) + if self.provider_call_id is not None: + result["providerCallId"] = from_union([from_none, from_str], self.provider_call_id) + if self._quota_snapshots is not None: + result["quotaSnapshots"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(_AssistantUsageQuotaSnapshot, x), x)], self._quota_snapshots) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) + if self.reasoning_tokens is not None: + result["reasoningTokens"] = from_union([from_none, to_int], self.reasoning_tokens) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) + if self.service_request_id is not None: + result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) + if self.time_to_first_token is not None: + result["timeToFirstTokenMs"] = from_union([from_none, to_timedelta], self.time_to_first_token) + if self._tool_counts is not None: + result["toolCounts"] = from_union([from_none, lambda x: from_dict(to_int, x)], self._tool_counts) + if self._tool_token_count is not None: + result["toolTokenCount"] = from_union([from_none, to_int], self._tool_token_count) + return result + + +@dataclass +class _AssistantUsageQuotaSnapshot: + "Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota." + # Internal: this field is an internal SDK API and is not part of the public surface. + _entitlement_requests: int + # Internal: this field is an internal SDK API and is not part of the public surface. + _is_unlimited_entitlement: bool + # Internal: this field is an internal SDK API and is not part of the public surface. + _overage: float + # Internal: this field is an internal SDK API and is not part of the public surface. + _overage_allowed_with_exhausted_quota: bool + # Internal: this field is an internal SDK API and is not part of the public surface. + _remaining_percentage: float + # Internal: this field is an internal SDK API and is not part of the public surface. + _usage_allowed_with_exhausted_quota: bool + # Internal: this field is an internal SDK API and is not part of the public surface. + _used_requests: int + # Internal: this field is an internal SDK API and is not part of the public surface. + _has_quota: bool | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _overage_entitlement: float | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _reset_date: datetime | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _token_based_billing: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "_AssistantUsageQuotaSnapshot": + assert isinstance(obj, dict) + _entitlement_requests = from_int(obj.get("entitlementRequests")) + _is_unlimited_entitlement = from_bool(obj.get("isUnlimitedEntitlement")) + _overage = from_float(obj.get("overage")) + _overage_allowed_with_exhausted_quota = from_bool(obj.get("overageAllowedWithExhaustedQuota")) + _remaining_percentage = from_float(obj.get("remainingPercentage")) + _usage_allowed_with_exhausted_quota = from_bool(obj.get("usageAllowedWithExhaustedQuota")) + _used_requests = from_int(obj.get("usedRequests")) + _has_quota = from_union([from_none, from_bool], obj.get("hasQuota")) + _overage_entitlement = from_union([from_none, from_float], obj.get("overageEntitlement")) + _reset_date = from_union([from_none, from_datetime], obj.get("resetDate")) + _token_based_billing = from_union([from_none, from_bool], obj.get("tokenBasedBilling")) + return _AssistantUsageQuotaSnapshot( + _entitlement_requests=_entitlement_requests, + _is_unlimited_entitlement=_is_unlimited_entitlement, + _overage=_overage, + _overage_allowed_with_exhausted_quota=_overage_allowed_with_exhausted_quota, + _remaining_percentage=_remaining_percentage, + _usage_allowed_with_exhausted_quota=_usage_allowed_with_exhausted_quota, + _used_requests=_used_requests, + _has_quota=_has_quota, + _overage_entitlement=_overage_entitlement, + _reset_date=_reset_date, + _token_based_billing=_token_based_billing, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["entitlementRequests"] = to_int(self._entitlement_requests) + result["isUnlimitedEntitlement"] = from_bool(self._is_unlimited_entitlement) + result["overage"] = to_float(self._overage) + result["overageAllowedWithExhaustedQuota"] = from_bool(self._overage_allowed_with_exhausted_quota) + result["remainingPercentage"] = to_float(self._remaining_percentage) + result["usageAllowedWithExhaustedQuota"] = from_bool(self._usage_allowed_with_exhausted_quota) + result["usedRequests"] = to_int(self._used_requests) + if self._has_quota is not None: + result["hasQuota"] = from_union([from_none, from_bool], self._has_quota) + if self._overage_entitlement is not None: + result["overageEntitlement"] = from_union([from_none, to_float], self._overage_entitlement) + if self._reset_date is not None: + result["resetDate"] = from_union([from_none, to_datetime], self._reset_date) + if self._token_based_billing is not None: + result["tokenBasedBilling"] = from_union([from_none, from_bool], self._token_based_billing) + return result + + +@dataclass +class AttachmentBlob: + "Blob attachment with inline base64-encoded data" + mime_type: str + type: ClassVar[str] = "blob" + asset_id: str | None = None + byte_length: int | None = None + data: str | None = None + display_name: str | None = None + omitted_reason: OmittedBinaryOmittedReason | None = None + + @staticmethod + def from_dict(obj: Any) -> "AttachmentBlob": + assert isinstance(obj, dict) + mime_type = from_str(obj.get("mimeType")) + asset_id = from_union([from_none, from_str], obj.get("assetId")) + byte_length = from_union([from_none, from_int], obj.get("byteLength")) + data = from_union([from_none, from_str], obj.get("data")) + display_name = from_union([from_none, from_str], obj.get("displayName")) + omitted_reason = from_union([from_none, lambda x: parse_enum(OmittedBinaryOmittedReason, x)], obj.get("omittedReason")) + return AttachmentBlob( + mime_type=mime_type, + asset_id=asset_id, + byte_length=byte_length, + data=data, + display_name=display_name, + omitted_reason=omitted_reason, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["mimeType"] = from_str(self.mime_type) + result["type"] = self.type + if self.asset_id is not None: + result["assetId"] = from_union([from_none, from_str], self.asset_id) + if self.byte_length is not None: + result["byteLength"] = from_union([from_none, to_int], self.byte_length) + if self.data is not None: + result["data"] = from_union([from_none, from_str], self.data) + if self.display_name is not None: + result["displayName"] = from_union([from_none, from_str], self.display_name) + if self.omitted_reason is not None: + result["omittedReason"] = from_union([from_none, lambda x: to_enum(OmittedBinaryOmittedReason, x)], self.omitted_reason) + return result + + +@dataclass +class AttachmentDirectory: + "Directory attachment" + display_name: str + path: str + type: ClassVar[str] = "directory" + tagged_files_entry: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AttachmentDirectory": + assert isinstance(obj, dict) + display_name = from_str(obj.get("displayName")) + path = from_str(obj.get("path")) + tagged_files_entry = from_union([from_none, from_str], obj.get("taggedFilesEntry")) + return AttachmentDirectory( + display_name=display_name, + path=path, + tagged_files_entry=tagged_files_entry, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["displayName"] = from_str(self.display_name) + result["path"] = from_str(self.path) + result["type"] = self.type + if self.tagged_files_entry is not None: + result["taggedFilesEntry"] = from_union([from_none, from_str], self.tagged_files_entry) + return result + + +@dataclass +class AttachmentExtensionContext: + "Structured context contributed by an extension. Composer pills displayed in the host are forwarded back through session.send.attachments, then rendered into the model prompt as an XML block." + captured_at: datetime + extension_id: str + title: str + type: ClassVar[str] = "extension_context" + canvas_id: str | None = None + instance_id: str | None = None + payload: Any = None + + @staticmethod + def from_dict(obj: Any) -> "AttachmentExtensionContext": + assert isinstance(obj, dict) + captured_at = from_datetime(obj.get("capturedAt")) + extension_id = from_str(obj.get("extensionId")) + title = from_str(obj.get("title")) + canvas_id = from_union([from_none, from_str], obj.get("canvasId")) + instance_id = from_union([from_none, from_str], obj.get("instanceId")) + payload = obj.get("payload") + return AttachmentExtensionContext( + captured_at=captured_at, + extension_id=extension_id, + title=title, + canvas_id=canvas_id, + instance_id=instance_id, + payload=payload, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["capturedAt"] = to_datetime(self.captured_at) + result["extensionId"] = from_str(self.extension_id) + result["title"] = from_str(self.title) + result["type"] = self.type + if self.canvas_id is not None: + result["canvasId"] = from_union([from_none, from_str], self.canvas_id) + if self.instance_id is not None: + result["instanceId"] = from_union([from_none, from_str], self.instance_id) + if self.payload is not None: + result["payload"] = self.payload + return result + + +@dataclass +class AttachmentFile: + "File attachment" + display_name: str + path: str + type: ClassVar[str] = "file" + asset_id: str | None = None + byte_length: int | None = None + line_range: AttachmentFileLineRange | None = None + mime_type: str | None = None + omitted_reason: OmittedBinaryOmittedReason | None = None + tagged_files_entry: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "AttachmentFile": assert isinstance(obj, dict) - reason = parse_enum(AbortReason, obj.get("reason")) - return AbortData( - reason=reason, + display_name = from_str(obj.get("displayName")) + path = from_str(obj.get("path")) + asset_id = from_union([from_none, from_str], obj.get("assetId")) + byte_length = from_union([from_none, from_int], obj.get("byteLength")) + line_range = from_union([from_none, AttachmentFileLineRange.from_dict], obj.get("lineRange")) + mime_type = from_union([from_none, from_str], obj.get("mimeType")) + omitted_reason = from_union([from_none, lambda x: parse_enum(OmittedBinaryOmittedReason, x)], obj.get("omittedReason")) + tagged_files_entry = from_union([from_none, from_str], obj.get("taggedFilesEntry")) + return AttachmentFile( + display_name=display_name, + path=path, + asset_id=asset_id, + byte_length=byte_length, + line_range=line_range, + mime_type=mime_type, + omitted_reason=omitted_reason, + tagged_files_entry=tagged_files_entry, ) def to_dict(self) -> dict: result: dict = {} - result["reason"] = to_enum(AbortReason, self.reason) + result["displayName"] = from_str(self.display_name) + result["path"] = from_str(self.path) + result["type"] = self.type + if self.asset_id is not None: + result["assetId"] = from_union([from_none, from_str], self.asset_id) + if self.byte_length is not None: + result["byteLength"] = from_union([from_none, to_int], self.byte_length) + if self.line_range is not None: + result["lineRange"] = from_union([from_none, lambda x: to_class(AttachmentFileLineRange, x)], self.line_range) + if self.mime_type is not None: + result["mimeType"] = from_union([from_none, from_str], self.mime_type) + if self.omitted_reason is not None: + result["omittedReason"] = from_union([from_none, lambda x: to_enum(OmittedBinaryOmittedReason, x)], self.omitted_reason) + if self.tagged_files_entry is not None: + result["taggedFilesEntry"] = from_union([from_none, from_str], self.tagged_files_entry) return result @dataclass -class AssistantIntentData: - "Agent intent description for current activity or plan" - intent: str +class AttachmentFileLineRange: + "Optional line range to scope the attachment to a specific section of the file" + end: int + start: int @staticmethod - def from_dict(obj: Any) -> "AssistantIntentData": + def from_dict(obj: Any) -> "AttachmentFileLineRange": assert isinstance(obj, dict) - intent = from_str(obj.get("intent")) - return AssistantIntentData( - intent=intent, + end = from_int(obj.get("end")) + start = from_int(obj.get("start")) + return AttachmentFileLineRange( + end=end, + start=start, ) def to_dict(self) -> dict: result: dict = {} - result["intent"] = from_str(self.intent) + result["end"] = to_int(self.end) + result["start"] = to_int(self.start) return result @dataclass -class AssistantMessageData: - "Assistant response containing text content, optional tool requests, and interaction metadata" - content: str - message_id: str - # Experimental: this field is part of an experimental API and may change or be removed. - anthropic_advisor_blocks: list[Any] | None = None - # Experimental: this field is part of an experimental API and may change or be removed. - anthropic_advisor_model: str | None = None - encrypted_content: str | None = None - interaction_id: str | None = None - model: str | None = None - output_tokens: int | None = None - # Deprecated: this field is deprecated. - parent_tool_call_id: str | None = None - phase: str | None = None - reasoning_opaque: str | None = None - reasoning_text: str | None = None - request_id: str | None = None - service_request_id: str | None = None - tool_requests: list[AssistantMessageToolRequest] | None = None - turn_id: str | None = None +class AttachmentGitHubActionsJob: + "Pointer to a GitHub Actions job." + job_id: int + job_name: str + repo: GitHubRepoRef + type: ClassVar[str] = "github_actions_job" + url: str + workflow_name: str + conclusion: str | None = None @staticmethod - def from_dict(obj: Any) -> "AssistantMessageData": + def from_dict(obj: Any) -> "AttachmentGitHubActionsJob": assert isinstance(obj, dict) - content = from_str(obj.get("content")) - message_id = from_str(obj.get("messageId")) - anthropic_advisor_blocks = from_union([from_none, lambda x: from_list(lambda x: x, x)], obj.get("anthropicAdvisorBlocks")) - anthropic_advisor_model = from_union([from_none, from_str], obj.get("anthropicAdvisorModel")) - encrypted_content = from_union([from_none, from_str], obj.get("encryptedContent")) - interaction_id = from_union([from_none, from_str], obj.get("interactionId")) - model = from_union([from_none, from_str], obj.get("model")) - output_tokens = from_union([from_none, from_int], obj.get("outputTokens")) - parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) - phase = from_union([from_none, from_str], obj.get("phase")) - reasoning_opaque = from_union([from_none, from_str], obj.get("reasoningOpaque")) - reasoning_text = from_union([from_none, from_str], obj.get("reasoningText")) - request_id = from_union([from_none, from_str], obj.get("requestId")) - service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) - tool_requests = from_union([from_none, lambda x: from_list(AssistantMessageToolRequest.from_dict, x)], obj.get("toolRequests")) - turn_id = from_union([from_none, from_str], obj.get("turnId")) - return AssistantMessageData( - content=content, - message_id=message_id, - anthropic_advisor_blocks=anthropic_advisor_blocks, - anthropic_advisor_model=anthropic_advisor_model, - encrypted_content=encrypted_content, - interaction_id=interaction_id, - model=model, - output_tokens=output_tokens, - parent_tool_call_id=parent_tool_call_id, - phase=phase, - reasoning_opaque=reasoning_opaque, - reasoning_text=reasoning_text, - request_id=request_id, - service_request_id=service_request_id, - tool_requests=tool_requests, - turn_id=turn_id, + job_id = from_int(obj.get("jobId")) + job_name = from_str(obj.get("jobName")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + workflow_name = from_str(obj.get("workflowName")) + conclusion = from_union([from_none, from_str], obj.get("conclusion")) + return AttachmentGitHubActionsJob( + job_id=job_id, + job_name=job_name, + repo=repo, + url=url, + workflow_name=workflow_name, + conclusion=conclusion, ) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["messageId"] = from_str(self.message_id) - if self.anthropic_advisor_blocks is not None: - result["anthropicAdvisorBlocks"] = from_union([from_none, lambda x: from_list(lambda x: x, x)], self.anthropic_advisor_blocks) - if self.anthropic_advisor_model is not None: - result["anthropicAdvisorModel"] = from_union([from_none, from_str], self.anthropic_advisor_model) - if self.encrypted_content is not None: - result["encryptedContent"] = from_union([from_none, from_str], self.encrypted_content) - if self.interaction_id is not None: - result["interactionId"] = from_union([from_none, from_str], self.interaction_id) - if self.model is not None: - result["model"] = from_union([from_none, from_str], self.model) - if self.output_tokens is not None: - result["outputTokens"] = from_union([from_none, to_int], self.output_tokens) - if self.parent_tool_call_id is not None: - result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) - if self.phase is not None: - result["phase"] = from_union([from_none, from_str], self.phase) - if self.reasoning_opaque is not None: - result["reasoningOpaque"] = from_union([from_none, from_str], self.reasoning_opaque) - if self.reasoning_text is not None: - result["reasoningText"] = from_union([from_none, from_str], self.reasoning_text) - if self.request_id is not None: - result["requestId"] = from_union([from_none, from_str], self.request_id) - if self.service_request_id is not None: - result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) - if self.tool_requests is not None: - result["toolRequests"] = from_union([from_none, lambda x: from_list(lambda x: to_class(AssistantMessageToolRequest, x), x)], self.tool_requests) - if self.turn_id is not None: - result["turnId"] = from_union([from_none, from_str], self.turn_id) + result["jobId"] = to_int(self.job_id) + result["jobName"] = from_str(self.job_name) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + result["workflowName"] = from_str(self.workflow_name) + if self.conclusion is not None: + result["conclusion"] = from_union([from_none, from_str], self.conclusion) return result @dataclass -class AssistantMessageDeltaData: - "Streaming assistant message delta for incremental response updates" - delta_content: str - message_id: str - # Deprecated: this field is deprecated. - parent_tool_call_id: str | None = None +class AttachmentGitHubCommit: + "Pointer to a GitHub commit." + message: str + oid: str + repo: GitHubRepoRef + type: ClassVar[str] = "github_commit" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantMessageDeltaData": + def from_dict(obj: Any) -> "AttachmentGitHubCommit": assert isinstance(obj, dict) - delta_content = from_str(obj.get("deltaContent")) - message_id = from_str(obj.get("messageId")) - parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) - return AssistantMessageDeltaData( - delta_content=delta_content, - message_id=message_id, - parent_tool_call_id=parent_tool_call_id, + message = from_str(obj.get("message")) + oid = from_str(obj.get("oid")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return AttachmentGitHubCommit( + message=message, + oid=oid, + repo=repo, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["deltaContent"] = from_str(self.delta_content) - result["messageId"] = from_str(self.message_id) - if self.parent_tool_call_id is not None: - result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) + result["message"] = from_str(self.message) + result["oid"] = from_str(self.oid) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantMessageStartData: - "Streaming assistant message start metadata" - message_id: str - phase: str | None = None +class AttachmentGitHubFile: + "Pointer to a file in a GitHub repository at a specific ref." + path: str + ref: str + repo: GitHubRepoRef + type: ClassVar[str] = "github_file" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantMessageStartData": + def from_dict(obj: Any) -> "AttachmentGitHubFile": assert isinstance(obj, dict) - message_id = from_str(obj.get("messageId")) - phase = from_union([from_none, from_str], obj.get("phase")) - return AssistantMessageStartData( - message_id=message_id, - phase=phase, + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return AttachmentGitHubFile( + path=path, + ref=ref, + repo=repo, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["messageId"] = from_str(self.message_id) - if self.phase is not None: - result["phase"] = from_union([from_none, from_str], self.phase) + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantMessageToolRequest: - "A tool invocation request from the assistant" - name: str - tool_call_id: str - arguments: Any = None - intention_summary: str | None = None - mcp_server_name: str | None = None - mcp_tool_name: str | None = None - tool_title: str | None = None - type: AssistantMessageToolRequestType | None = None +class AttachmentGitHubFileDiff: + "Pointer to a single-file diff. At least one of `head` and `base` must be present." + type: ClassVar[str] = "github_file_diff" + url: str + base: AttachmentGitHubFileDiffSide | None = None + head: AttachmentGitHubFileDiffSide | None = None @staticmethod - def from_dict(obj: Any) -> "AssistantMessageToolRequest": + def from_dict(obj: Any) -> "AttachmentGitHubFileDiff": assert isinstance(obj, dict) - name = from_str(obj.get("name")) - tool_call_id = from_str(obj.get("toolCallId")) - arguments = obj.get("arguments") - intention_summary = from_union([from_none, from_str], obj.get("intentionSummary")) - mcp_server_name = from_union([from_none, from_str], obj.get("mcpServerName")) - mcp_tool_name = from_union([from_none, from_str], obj.get("mcpToolName")) - tool_title = from_union([from_none, from_str], obj.get("toolTitle")) - type = from_union([from_none, lambda x: parse_enum(AssistantMessageToolRequestType, x)], obj.get("type")) - return AssistantMessageToolRequest( - name=name, - tool_call_id=tool_call_id, - arguments=arguments, - intention_summary=intention_summary, - mcp_server_name=mcp_server_name, - mcp_tool_name=mcp_tool_name, - tool_title=tool_title, - type=type, + url = from_str(obj.get("url")) + base = from_union([from_none, AttachmentGitHubFileDiffSide.from_dict], obj.get("base")) + head = from_union([from_none, AttachmentGitHubFileDiffSide.from_dict], obj.get("head")) + return AttachmentGitHubFileDiff( + url=url, + base=base, + head=head, ) def to_dict(self) -> dict: result: dict = {} - result["name"] = from_str(self.name) - result["toolCallId"] = from_str(self.tool_call_id) - if self.arguments is not None: - result["arguments"] = self.arguments - if self.intention_summary is not None: - result["intentionSummary"] = from_union([from_none, from_str], self.intention_summary) - if self.mcp_server_name is not None: - result["mcpServerName"] = from_union([from_none, from_str], self.mcp_server_name) - if self.mcp_tool_name is not None: - result["mcpToolName"] = from_union([from_none, from_str], self.mcp_tool_name) - if self.tool_title is not None: - result["toolTitle"] = from_union([from_none, from_str], self.tool_title) - if self.type is not None: - result["type"] = from_union([from_none, lambda x: to_enum(AssistantMessageToolRequestType, x)], self.type) + result["type"] = self.type + result["url"] = from_str(self.url) + if self.base is not None: + result["base"] = from_union([from_none, lambda x: to_class(AttachmentGitHubFileDiffSide, x)], self.base) + if self.head is not None: + result["head"] = from_union([from_none, lambda x: to_class(AttachmentGitHubFileDiffSide, x)], self.head) return result @dataclass -class AssistantReasoningData: - "Assistant reasoning content for timeline display with complete thinking text" - content: str - reasoning_id: str +class AttachmentGitHubFileDiffSide: + "One side of a file diff (head or base)" + path: str + ref: str + repo: GitHubRepoRef + + @staticmethod + def from_dict(obj: Any) -> "AttachmentGitHubFileDiffSide": + assert isinstance(obj, dict) + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + return AttachmentGitHubFileDiffSide( + path=path, + ref=ref, + repo=repo, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(GitHubRepoRef, self.repo) + return result + + +@dataclass +class AttachmentGitHubReference: + "GitHub issue, pull request, or discussion reference" + number: int + reference_type: AttachmentGitHubReferenceType + state: str + title: str + type: ClassVar[str] = "github_reference" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantReasoningData": + def from_dict(obj: Any) -> "AttachmentGitHubReference": assert isinstance(obj, dict) - content = from_str(obj.get("content")) - reasoning_id = from_str(obj.get("reasoningId")) - return AssistantReasoningData( - content=content, - reasoning_id=reasoning_id, + number = from_int(obj.get("number")) + reference_type = parse_enum(AttachmentGitHubReferenceType, obj.get("referenceType")) + state = from_str(obj.get("state")) + title = from_str(obj.get("title")) + url = from_str(obj.get("url")) + return AttachmentGitHubReference( + number=number, + reference_type=reference_type, + state=state, + title=title, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["content"] = from_str(self.content) - result["reasoningId"] = from_str(self.reasoning_id) + result["number"] = to_int(self.number) + result["referenceType"] = to_enum(AttachmentGitHubReferenceType, self.reference_type) + result["state"] = from_str(self.state) + result["title"] = from_str(self.title) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantReasoningDeltaData: - "Streaming reasoning delta for incremental extended thinking updates" - delta_content: str - reasoning_id: str +class AttachmentGitHubRelease: + "Pointer to a GitHub release." + name: str + repo: GitHubRepoRef + tag_name: str + type: ClassVar[str] = "github_release" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantReasoningDeltaData": + def from_dict(obj: Any) -> "AttachmentGitHubRelease": assert isinstance(obj, dict) - delta_content = from_str(obj.get("deltaContent")) - reasoning_id = from_str(obj.get("reasoningId")) - return AssistantReasoningDeltaData( - delta_content=delta_content, - reasoning_id=reasoning_id, + name = from_str(obj.get("name")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + tag_name = from_str(obj.get("tagName")) + url = from_str(obj.get("url")) + return AttachmentGitHubRelease( + name=name, + repo=repo, + tag_name=tag_name, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["deltaContent"] = from_str(self.delta_content) - result["reasoningId"] = from_str(self.reasoning_id) + result["name"] = from_str(self.name) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["tagName"] = from_str(self.tag_name) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantStreamingDeltaData: - "Streaming response progress with cumulative byte count" - total_response_size_bytes: int +class AttachmentGitHubRepository: + "Pointer to a GitHub repository." + repo: GitHubRepoRef + type: ClassVar[str] = "github_repository" + url: str + description: str | None = None + ref: str | None = None @staticmethod - def from_dict(obj: Any) -> "AssistantStreamingDeltaData": + def from_dict(obj: Any) -> "AttachmentGitHubRepository": assert isinstance(obj, dict) - total_response_size_bytes = from_int(obj.get("totalResponseSizeBytes")) - return AssistantStreamingDeltaData( - total_response_size_bytes=total_response_size_bytes, + repo = GitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + description = from_union([from_none, from_str], obj.get("description")) + ref = from_union([from_none, from_str], obj.get("ref")) + return AttachmentGitHubRepository( + repo=repo, + url=url, + description=description, + ref=ref, ) def to_dict(self) -> dict: result: dict = {} - result["totalResponseSizeBytes"] = to_int(self.total_response_size_bytes) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.ref is not None: + result["ref"] = from_union([from_none, from_str], self.ref) return result @dataclass -class AssistantTurnEndData: - "Turn completion metadata including the turn identifier" - turn_id: str +class AttachmentGitHubSnippet: + "Pointer to a line range inside a file in a GitHub repository." + line_range: AttachmentFileLineRange + path: str + ref: str + repo: GitHubRepoRef + type: ClassVar[str] = "github_snippet" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantTurnEndData": + def from_dict(obj: Any) -> "AttachmentGitHubSnippet": assert isinstance(obj, dict) - turn_id = from_str(obj.get("turnId")) - return AssistantTurnEndData( - turn_id=turn_id, + line_range = AttachmentFileLineRange.from_dict(obj.get("lineRange")) + path = from_str(obj.get("path")) + ref = from_str(obj.get("ref")) + repo = GitHubRepoRef.from_dict(obj.get("repo")) + url = from_str(obj.get("url")) + return AttachmentGitHubSnippet( + line_range=line_range, + path=path, + ref=ref, + repo=repo, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["turnId"] = from_str(self.turn_id) + result["lineRange"] = to_class(AttachmentFileLineRange, self.line_range) + result["path"] = from_str(self.path) + result["ref"] = from_str(self.ref) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantTurnStartData: - "Turn initialization metadata including identifier and interaction tracking" - turn_id: str - interaction_id: str | None = None +class AttachmentGitHubTreeComparison: + "Pointer to a comparison between two git revisions." + base: AttachmentGitHubTreeComparisonSide + head: AttachmentGitHubTreeComparisonSide + type: ClassVar[str] = "github_tree_comparison" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantTurnStartData": + def from_dict(obj: Any) -> "AttachmentGitHubTreeComparison": assert isinstance(obj, dict) - turn_id = from_str(obj.get("turnId")) - interaction_id = from_union([from_none, from_str], obj.get("interactionId")) - return AssistantTurnStartData( - turn_id=turn_id, - interaction_id=interaction_id, + base = AttachmentGitHubTreeComparisonSide.from_dict(obj.get("base")) + head = AttachmentGitHubTreeComparisonSide.from_dict(obj.get("head")) + url = from_str(obj.get("url")) + return AttachmentGitHubTreeComparison( + base=base, + head=head, + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["turnId"] = from_str(self.turn_id) - if self.interaction_id is not None: - result["interactionId"] = from_union([from_none, from_str], self.interaction_id) + result["base"] = to_class(AttachmentGitHubTreeComparisonSide, self.base) + result["head"] = to_class(AttachmentGitHubTreeComparisonSide, self.head) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class _AssistantUsageCopilotUsage: - "Per-request cost and usage data from the CAPI copilot_usage response field" - token_details: list[AssistantUsageCopilotUsageTokenDetail] - total_nano_aiu: float +class AttachmentGitHubTreeComparisonSide: + "One side of a tree comparison (head or base)" + repo: GitHubRepoRef + revision: str @staticmethod - def from_dict(obj: Any) -> "_AssistantUsageCopilotUsage": + def from_dict(obj: Any) -> "AttachmentGitHubTreeComparisonSide": assert isinstance(obj, dict) - token_details = from_list(AssistantUsageCopilotUsageTokenDetail.from_dict, obj.get("tokenDetails")) - total_nano_aiu = from_float(obj.get("totalNanoAiu")) - return _AssistantUsageCopilotUsage( - token_details=token_details, - total_nano_aiu=total_nano_aiu, + repo = GitHubRepoRef.from_dict(obj.get("repo")) + revision = from_str(obj.get("revision")) + return AttachmentGitHubTreeComparisonSide( + repo=repo, + revision=revision, ) def to_dict(self) -> dict: result: dict = {} - result["tokenDetails"] = from_list(lambda x: to_class(AssistantUsageCopilotUsageTokenDetail, x), self.token_details) - result["totalNanoAiu"] = to_float(self.total_nano_aiu) + result["repo"] = to_class(GitHubRepoRef, self.repo) + result["revision"] = from_str(self.revision) return result @dataclass -class AssistantUsageCopilotUsageTokenDetail: - "Token usage detail for a single billing category" - batch_size: int - cost_per_batch: int - token_count: int - token_type: str +class AttachmentGitHubUrl: + "Generic GitHub URL reference." + type: ClassVar[str] = "github_url" + url: str @staticmethod - def from_dict(obj: Any) -> "AssistantUsageCopilotUsageTokenDetail": + def from_dict(obj: Any) -> "AttachmentGitHubUrl": assert isinstance(obj, dict) - batch_size = from_int(obj.get("batchSize")) - cost_per_batch = from_int(obj.get("costPerBatch")) - token_count = from_int(obj.get("tokenCount")) - token_type = from_str(obj.get("tokenType")) - return AssistantUsageCopilotUsageTokenDetail( - batch_size=batch_size, - cost_per_batch=cost_per_batch, - token_count=token_count, - token_type=token_type, + url = from_str(obj.get("url")) + return AttachmentGitHubUrl( + url=url, ) def to_dict(self) -> dict: result: dict = {} - result["batchSize"] = to_int(self.batch_size) - result["costPerBatch"] = to_int(self.cost_per_batch) - result["tokenCount"] = to_int(self.token_count) - result["tokenType"] = from_str(self.token_type) + result["type"] = self.type + result["url"] = from_str(self.url) return result @dataclass -class AssistantUsageData: - "LLM API call usage metrics including tokens, costs, quotas, and billing information" - model: str - api_call_id: str | None = None - api_endpoint: AssistantUsageApiEndpoint | None = None - cache_read_tokens: int | None = None - cache_write_tokens: int | None = None - # Internal: this field is an internal SDK API and is not part of the public surface. - _copilot_usage: _AssistantUsageCopilotUsage | None = None - # Experimental: this field is part of an experimental API and may change or be removed. - cost: float | None = None - duration: timedelta | None = None - initiator: str | None = None - input_tokens: int | None = None - inter_token_latency: timedelta | None = None - output_tokens: int | None = None - # Deprecated: this field is deprecated. - parent_tool_call_id: str | None = None - provider_call_id: str | None = None - # Internal: this field is an internal SDK API and is not part of the public surface. - _quota_snapshots: dict[str, _AssistantUsageQuotaSnapshot] | None = None - reasoning_effort: str | None = None - reasoning_tokens: int | None = None - service_request_id: str | None = None - time_to_first_token: timedelta | None = None +class AttachmentSelection: + "Code selection attachment from an editor" + display_name: str + file_path: str + selection: AttachmentSelectionDetails + text: str + type: ClassVar[str] = "selection" @staticmethod - def from_dict(obj: Any) -> "AssistantUsageData": + def from_dict(obj: Any) -> "AttachmentSelection": assert isinstance(obj, dict) - model = from_str(obj.get("model")) - api_call_id = from_union([from_none, from_str], obj.get("apiCallId")) - api_endpoint = from_union([from_none, lambda x: parse_enum(AssistantUsageApiEndpoint, x)], obj.get("apiEndpoint")) - cache_read_tokens = from_union([from_none, from_int], obj.get("cacheReadTokens")) - cache_write_tokens = from_union([from_none, from_int], obj.get("cacheWriteTokens")) - _copilot_usage = from_union([from_none, _AssistantUsageCopilotUsage.from_dict], obj.get("copilotUsage")) - cost = from_union([from_none, from_float], obj.get("cost")) - duration = from_union([from_none, from_timedelta], obj.get("duration")) - initiator = from_union([from_none, from_str], obj.get("initiator")) - input_tokens = from_union([from_none, from_int], obj.get("inputTokens")) - inter_token_latency = from_union([from_none, from_timedelta], obj.get("interTokenLatencyMs")) - output_tokens = from_union([from_none, from_int], obj.get("outputTokens")) - parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) - provider_call_id = from_union([from_none, from_str], obj.get("providerCallId")) - _quota_snapshots = from_union([from_none, lambda x: from_dict(_AssistantUsageQuotaSnapshot.from_dict, x)], obj.get("quotaSnapshots")) - reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) - reasoning_tokens = from_union([from_none, from_int], obj.get("reasoningTokens")) - service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) - time_to_first_token = from_union([from_none, from_timedelta], obj.get("timeToFirstTokenMs")) - return AssistantUsageData( - model=model, - api_call_id=api_call_id, - api_endpoint=api_endpoint, - cache_read_tokens=cache_read_tokens, - cache_write_tokens=cache_write_tokens, - _copilot_usage=_copilot_usage, - cost=cost, - duration=duration, - initiator=initiator, - input_tokens=input_tokens, - inter_token_latency=inter_token_latency, - output_tokens=output_tokens, - parent_tool_call_id=parent_tool_call_id, - provider_call_id=provider_call_id, - _quota_snapshots=_quota_snapshots, - reasoning_effort=reasoning_effort, - reasoning_tokens=reasoning_tokens, - service_request_id=service_request_id, - time_to_first_token=time_to_first_token, + display_name = from_str(obj.get("displayName")) + file_path = from_str(obj.get("filePath")) + selection = AttachmentSelectionDetails.from_dict(obj.get("selection")) + text = from_str(obj.get("text")) + return AttachmentSelection( + display_name=display_name, + file_path=file_path, + selection=selection, + text=text, ) def to_dict(self) -> dict: result: dict = {} - result["model"] = from_str(self.model) - if self.api_call_id is not None: - result["apiCallId"] = from_union([from_none, from_str], self.api_call_id) - if self.api_endpoint is not None: - result["apiEndpoint"] = from_union([from_none, lambda x: to_enum(AssistantUsageApiEndpoint, x)], self.api_endpoint) - if self.cache_read_tokens is not None: - result["cacheReadTokens"] = from_union([from_none, to_int], self.cache_read_tokens) - if self.cache_write_tokens is not None: - result["cacheWriteTokens"] = from_union([from_none, to_int], self.cache_write_tokens) - if self._copilot_usage is not None: - result["copilotUsage"] = from_union([from_none, lambda x: to_class(_AssistantUsageCopilotUsage, x)], self._copilot_usage) - if self.cost is not None: - result["cost"] = from_union([from_none, to_float], self.cost) - if self.duration is not None: - result["duration"] = from_union([from_none, to_timedelta_int], self.duration) - if self.initiator is not None: - result["initiator"] = from_union([from_none, from_str], self.initiator) - if self.input_tokens is not None: - result["inputTokens"] = from_union([from_none, to_int], self.input_tokens) - if self.inter_token_latency is not None: - result["interTokenLatencyMs"] = from_union([from_none, to_timedelta], self.inter_token_latency) - if self.output_tokens is not None: - result["outputTokens"] = from_union([from_none, to_int], self.output_tokens) - if self.parent_tool_call_id is not None: - result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) - if self.provider_call_id is not None: - result["providerCallId"] = from_union([from_none, from_str], self.provider_call_id) - if self._quota_snapshots is not None: - result["quotaSnapshots"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(_AssistantUsageQuotaSnapshot, x), x)], self._quota_snapshots) - if self.reasoning_effort is not None: - result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) - if self.reasoning_tokens is not None: - result["reasoningTokens"] = from_union([from_none, to_int], self.reasoning_tokens) - if self.service_request_id is not None: - result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) - if self.time_to_first_token is not None: - result["timeToFirstTokenMs"] = from_union([from_none, to_timedelta_int], self.time_to_first_token) + result["displayName"] = from_str(self.display_name) + result["filePath"] = from_str(self.file_path) + result["selection"] = to_class(AttachmentSelectionDetails, self.selection) + result["text"] = from_str(self.text) + result["type"] = self.type + return result + + +@dataclass +class AttachmentSelectionDetails: + "Position range of the selection within the file" + end: AttachmentSelectionDetailsEnd + start: AttachmentSelectionDetailsStart + + @staticmethod + def from_dict(obj: Any) -> "AttachmentSelectionDetails": + assert isinstance(obj, dict) + end = AttachmentSelectionDetailsEnd.from_dict(obj.get("end")) + start = AttachmentSelectionDetailsStart.from_dict(obj.get("start")) + return AttachmentSelectionDetails( + end=end, + start=start, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["end"] = to_class(AttachmentSelectionDetailsEnd, self.end) + result["start"] = to_class(AttachmentSelectionDetailsStart, self.start) return result @dataclass -class _AssistantUsageQuotaSnapshot: - "Schema for the `_AssistantUsageQuotaSnapshot` type." - # Internal: this field is an internal SDK API and is not part of the public surface. - _entitlement_requests: int - # Internal: this field is an internal SDK API and is not part of the public surface. - _is_unlimited_entitlement: bool - # Internal: this field is an internal SDK API and is not part of the public surface. - _overage: float - # Internal: this field is an internal SDK API and is not part of the public surface. - _overage_allowed_with_exhausted_quota: bool - # Internal: this field is an internal SDK API and is not part of the public surface. - _remaining_percentage: float - # Internal: this field is an internal SDK API and is not part of the public surface. - _usage_allowed_with_exhausted_quota: bool - # Internal: this field is an internal SDK API and is not part of the public surface. - _used_requests: int - # Internal: this field is an internal SDK API and is not part of the public surface. - _reset_date: datetime | None = None +class AttachmentSelectionDetailsEnd: + "End position of the selection" + character: int + line: int @staticmethod - def from_dict(obj: Any) -> "_AssistantUsageQuotaSnapshot": + def from_dict(obj: Any) -> "AttachmentSelectionDetailsEnd": assert isinstance(obj, dict) - _entitlement_requests = from_int(obj.get("entitlementRequests")) - _is_unlimited_entitlement = from_bool(obj.get("isUnlimitedEntitlement")) - _overage = from_float(obj.get("overage")) - _overage_allowed_with_exhausted_quota = from_bool(obj.get("overageAllowedWithExhaustedQuota")) - _remaining_percentage = from_float(obj.get("remainingPercentage")) - _usage_allowed_with_exhausted_quota = from_bool(obj.get("usageAllowedWithExhaustedQuota")) - _used_requests = from_int(obj.get("usedRequests")) - _reset_date = from_union([from_none, from_datetime], obj.get("resetDate")) - return _AssistantUsageQuotaSnapshot( - _entitlement_requests=_entitlement_requests, - _is_unlimited_entitlement=_is_unlimited_entitlement, - _overage=_overage, - _overage_allowed_with_exhausted_quota=_overage_allowed_with_exhausted_quota, - _remaining_percentage=_remaining_percentage, - _usage_allowed_with_exhausted_quota=_usage_allowed_with_exhausted_quota, - _used_requests=_used_requests, - _reset_date=_reset_date, + character = from_int(obj.get("character")) + line = from_int(obj.get("line")) + return AttachmentSelectionDetailsEnd( + character=character, + line=line, ) def to_dict(self) -> dict: result: dict = {} - result["entitlementRequests"] = to_int(self._entitlement_requests) - result["isUnlimitedEntitlement"] = from_bool(self._is_unlimited_entitlement) - result["overage"] = to_float(self._overage) - result["overageAllowedWithExhaustedQuota"] = from_bool(self._overage_allowed_with_exhausted_quota) - result["remainingPercentage"] = to_float(self._remaining_percentage) - result["usageAllowedWithExhaustedQuota"] = from_bool(self._usage_allowed_with_exhausted_quota) - result["usedRequests"] = to_int(self._used_requests) - if self._reset_date is not None: - result["resetDate"] = from_union([from_none, to_datetime], self._reset_date) + result["character"] = to_int(self.character) + result["line"] = to_int(self.line) + return result + + +@dataclass +class AttachmentSelectionDetailsStart: + "Start position of the selection" + character: int + line: int + + @staticmethod + def from_dict(obj: Any) -> "AttachmentSelectionDetailsStart": + assert isinstance(obj, dict) + character = from_int(obj.get("character")) + line = from_int(obj.get("line")) + return AttachmentSelectionDetailsStart( + character=character, + line=line, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["character"] = to_int(self.character) + result["line"] = to_int(self.line) return result @@ -906,81 +2785,6 @@ def to_dict(self) -> dict: return result -@dataclass -class CanvasRegistryChangedCanvas: - "Schema for the `CanvasRegistryChangedCanvas` type." - canvas_id: str - description: str - display_name: str - extension_id: str - actions: list[CanvasRegistryChangedCanvasAction] | None = None - extension_name: str | None = None - input_schema: dict[str, Any] | None = None - - @staticmethod - def from_dict(obj: Any) -> "CanvasRegistryChangedCanvas": - assert isinstance(obj, dict) - canvas_id = from_str(obj.get("canvasId")) - description = from_str(obj.get("description")) - display_name = from_str(obj.get("displayName")) - extension_id = from_str(obj.get("extensionId")) - actions = from_union([from_none, lambda x: from_list(CanvasRegistryChangedCanvasAction.from_dict, x)], obj.get("actions")) - extension_name = from_union([from_none, from_str], obj.get("extensionName")) - input_schema = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("inputSchema")) - return CanvasRegistryChangedCanvas( - canvas_id=canvas_id, - description=description, - display_name=display_name, - extension_id=extension_id, - actions=actions, - extension_name=extension_name, - input_schema=input_schema, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["canvasId"] = from_str(self.canvas_id) - result["description"] = from_str(self.description) - result["displayName"] = from_str(self.display_name) - result["extensionId"] = from_str(self.extension_id) - if self.actions is not None: - result["actions"] = from_union([from_none, lambda x: from_list(lambda x: to_class(CanvasRegistryChangedCanvasAction, x), x)], self.actions) - if self.extension_name is not None: - result["extensionName"] = from_union([from_none, from_str], self.extension_name) - if self.input_schema is not None: - result["inputSchema"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.input_schema) - return result - - -@dataclass -class CanvasRegistryChangedCanvasAction: - "Schema for the `CanvasRegistryChangedCanvasAction` type." - name: str - description: str | None = None - input_schema: dict[str, Any] | None = None - - @staticmethod - def from_dict(obj: Any) -> "CanvasRegistryChangedCanvasAction": - assert isinstance(obj, dict) - name = from_str(obj.get("name")) - description = from_union([from_none, from_str], obj.get("description")) - input_schema = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("inputSchema")) - return CanvasRegistryChangedCanvasAction( - name=name, - description=description, - input_schema=input_schema, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["name"] = from_str(self.name) - if self.description is not None: - result["description"] = from_union([from_none, from_str], self.description) - if self.input_schema is not None: - result["inputSchema"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.input_schema) - return result - - @dataclass class CapabilitiesChangedData: "Session capability change notification" @@ -1106,7 +2910,7 @@ def to_dict(self) -> dict: @dataclass class CommandsChangedCommand: - "Schema for the `CommandsChangedCommand` type." + "A single slash command available in the session, as listed by the `commands.changed` event." name: str description: str | None = None @@ -1201,23 +3005,25 @@ def to_dict(self) -> dict: @dataclass class _CompactionCompleteCompactionTokensUsedCopilotUsage: "Per-request cost and usage data from the CAPI copilot_usage response field" - token_details: list[CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail] total_nano_aiu: float + # Internal: this field is an internal SDK API and is not part of the public surface. + _token_details: list[CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail] | None = None @staticmethod def from_dict(obj: Any) -> "_CompactionCompleteCompactionTokensUsedCopilotUsage": assert isinstance(obj, dict) - token_details = from_list(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.from_dict, obj.get("tokenDetails")) total_nano_aiu = from_float(obj.get("totalNanoAiu")) + _token_details = from_union([from_none, lambda x: from_list(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.from_dict, x)], obj.get("tokenDetails")) return _CompactionCompleteCompactionTokensUsedCopilotUsage( - token_details=token_details, total_nano_aiu=total_nano_aiu, + _token_details=_token_details, ) def to_dict(self) -> dict: result: dict = {} - result["tokenDetails"] = from_list(lambda x: to_class(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail, x), self.token_details) result["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self._token_details is not None: + result["tokenDetails"] = from_union([from_none, lambda x: from_list(lambda x: to_class(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail, x), x)], self._token_details) return result @@ -1254,7 +3060,7 @@ def to_dict(self) -> dict: @dataclass class CustomAgentsUpdatedAgent: - "Schema for the `CustomAgentsUpdatedAgent` type." + "A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override." description: str display_name: str id: str @@ -1407,7 +3213,7 @@ def to_dict(self) -> dict: @dataclass class EmbeddedBlobResourceContents: - "Schema for the `EmbeddedBlobResourceContents` type." + "Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob." blob: str uri: str mime_type: str | None = None @@ -1435,7 +3241,7 @@ def to_dict(self) -> dict: @dataclass class EmbeddedTextResourceContents: - "Schema for the `EmbeddedTextResourceContents` type." + "Embedded text resource contents identified by a URI, with an optional MIME type and a text payload." text: str uri: str mime_type: str | None = None @@ -1537,7 +3343,7 @@ def to_dict(self) -> dict: @dataclass class ExtensionsLoadedExtension: - "Schema for the `ExtensionsLoadedExtension` type." + "A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status." id: str name: str source: ExtensionsLoadedExtensionSource @@ -1636,6 +3442,93 @@ def to_dict(self) -> dict: return result +@dataclass +class FactoryPermissionPhase: + "A declared phase shown in a factory permission prompt." + title: str + detail: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "FactoryPermissionPhase": + assert isinstance(obj, dict) + title = from_str(obj.get("title")) + detail = from_union([from_none, from_str], obj.get("detail")) + return FactoryPermissionPhase( + title=title, + detail=detail, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["title"] = from_str(self.title) + if self.detail is not None: + result["detail"] = from_union([from_none, from_str], self.detail) + return result + + +@dataclass +class GitHubMcpToolConfig: + "Per-session configuration for the built-in GitHub MCP server" + additional_tools: list[str] | None = None + additional_toolsets: list[str] | None = None + enable_all_tools: bool | None = None + enable_insiders_mode: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "GitHubMcpToolConfig": + assert isinstance(obj, dict) + additional_tools = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("additionalTools")) + additional_toolsets = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("additionalToolsets")) + enable_all_tools = from_union([from_none, from_bool], obj.get("enableAllTools")) + enable_insiders_mode = from_union([from_none, from_bool], obj.get("enableInsidersMode")) + return GitHubMcpToolConfig( + additional_tools=additional_tools, + additional_toolsets=additional_toolsets, + enable_all_tools=enable_all_tools, + enable_insiders_mode=enable_insiders_mode, + ) + + def to_dict(self) -> dict: + result: dict = {} + if self.additional_tools is not None: + result["additionalTools"] = from_union([from_none, lambda x: from_list(from_str, x)], self.additional_tools) + if self.additional_toolsets is not None: + result["additionalToolsets"] = from_union([from_none, lambda x: from_list(from_str, x)], self.additional_toolsets) + if self.enable_all_tools is not None: + result["enableAllTools"] = from_union([from_none, from_bool], self.enable_all_tools) + if self.enable_insiders_mode is not None: + result["enableInsidersMode"] = from_union([from_none, from_bool], self.enable_insiders_mode) + return result + + +@dataclass +class GitHubRepoRef: + "Pointer to a GitHub repository." + name: str + owner: str + id: int | None = None + + @staticmethod + def from_dict(obj: Any) -> "GitHubRepoRef": + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + owner = from_str(obj.get("owner")) + id = from_union([from_none, from_int], obj.get("id")) + return GitHubRepoRef( + name=name, + owner=owner, + id=id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["owner"] = from_str(self.owner) + if self.id is not None: + result["id"] = from_union([from_none, to_int], self.id) + return result + + @dataclass class HandoffRepository: "Repository context for the handed-off session" @@ -1664,6 +3557,29 @@ def to_dict(self) -> dict: return result +@dataclass +class HeaderEntry: + "Single HTTP header entry as a name/value pair." + name: str + value: str + + @staticmethod + def from_dict(obj: Any) -> "HeaderEntry": + assert isinstance(obj, dict) + name = from_str(obj.get("name")) + value = from_str(obj.get("value")) + return HeaderEntry( + name=name, + value=value, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["name"] = from_str(self.name) + result["value"] = from_str(self.value) + return result + + @dataclass class HookEndData: "Hook invocation completion details including output, success status, and error information" @@ -1705,21 +3621,26 @@ def to_dict(self) -> dict: class HookEndError: "Error details when the hook failed" message: str + source: str | None = None stack: str | None = None @staticmethod def from_dict(obj: Any) -> "HookEndError": assert isinstance(obj, dict) message = from_str(obj.get("message")) + source = from_union([from_none, from_str], obj.get("source")) stack = from_union([from_none, from_str], obj.get("stack")) return HookEndError( message=message, + source=source, stack=stack, ) def to_dict(self) -> dict: result: dict = {} result["message"] = from_str(self.message) + if self.source is not None: + result["source"] = from_union([from_none, from_str], self.source) if self.stack is not None: result["stack"] = from_union([from_none, from_str], self.stack) return result @@ -1729,18 +3650,23 @@ def to_dict(self) -> dict: class HookProgressData: "Ephemeral progress update from a running hook process" message: str + temporary: bool | None = None @staticmethod def from_dict(obj: Any) -> "HookProgressData": assert isinstance(obj, dict) message = from_str(obj.get("message")) + temporary = from_union([from_none, from_bool], obj.get("temporary")) return HookProgressData( message=message, + temporary=temporary, ) def to_dict(self) -> dict: result: dict = {} result["message"] = from_str(self.message) + if self.temporary is not None: + result["temporary"] = from_union([from_none, from_bool], self.temporary) return result @@ -1864,77 +3790,182 @@ def to_dict(self) -> dict: @dataclass class McpAppToolCallCompleteToolMetaUI: - "Schema for the `McpAppToolCallCompleteToolMetaUI` type." + "MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result." resource_uri: str | None = None visibility: list[str] | None = None @staticmethod - def from_dict(obj: Any) -> "McpAppToolCallCompleteToolMetaUI": + def from_dict(obj: Any) -> "McpAppToolCallCompleteToolMetaUI": + assert isinstance(obj, dict) + resource_uri = from_union([from_none, from_str], obj.get("resourceUri")) + visibility = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("visibility")) + return McpAppToolCallCompleteToolMetaUI( + resource_uri=resource_uri, + visibility=visibility, + ) + + def to_dict(self) -> dict: + result: dict = {} + if self.resource_uri is not None: + result["resourceUri"] = from_union([from_none, from_str], self.resource_uri) + if self.visibility is not None: + result["visibility"] = from_union([from_none, lambda x: from_list(from_str, x)], self.visibility) + return result + + +@dataclass +class McpHeadersRefreshCompletedData: + "MCP headers refresh request completion notification" + outcome: McpHeadersRefreshCompletedOutcome + request_id: str + + @staticmethod + def from_dict(obj: Any) -> "McpHeadersRefreshCompletedData": + assert isinstance(obj, dict) + outcome = parse_enum(McpHeadersRefreshCompletedOutcome, obj.get("outcome")) + request_id = from_str(obj.get("requestId")) + return McpHeadersRefreshCompletedData( + outcome=outcome, + request_id=request_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["outcome"] = to_enum(McpHeadersRefreshCompletedOutcome, self.outcome) + result["requestId"] = from_str(self.request_id) + return result + + +@dataclass +class McpHeadersRefreshRequiredData: + "Dynamic headers refresh request for a remote MCP server" + reason: McpHeadersRefreshRequiredReason + request_id: str + server_name: str + server_url: str + + @staticmethod + def from_dict(obj: Any) -> "McpHeadersRefreshRequiredData": assert isinstance(obj, dict) - resource_uri = from_union([from_none, from_str], obj.get("resourceUri")) - visibility = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("visibility")) - return McpAppToolCallCompleteToolMetaUI( - resource_uri=resource_uri, - visibility=visibility, + reason = parse_enum(McpHeadersRefreshRequiredReason, obj.get("reason")) + request_id = from_str(obj.get("requestId")) + server_name = from_str(obj.get("serverName")) + server_url = from_str(obj.get("serverUrl")) + return McpHeadersRefreshRequiredData( + reason=reason, + request_id=request_id, + server_name=server_name, + server_url=server_url, ) def to_dict(self) -> dict: result: dict = {} - if self.resource_uri is not None: - result["resourceUri"] = from_union([from_none, from_str], self.resource_uri) - if self.visibility is not None: - result["visibility"] = from_union([from_none, lambda x: from_list(from_str, x)], self.visibility) + result["reason"] = to_enum(McpHeadersRefreshRequiredReason, self.reason) + result["requestId"] = from_str(self.request_id) + result["serverName"] = from_str(self.server_name) + result["serverUrl"] = from_str(self.server_url) return result @dataclass class McpOauthCompletedData: "MCP OAuth request completion notification" + outcome: McpOauthCompletionOutcome request_id: str @staticmethod def from_dict(obj: Any) -> "McpOauthCompletedData": assert isinstance(obj, dict) + outcome = parse_enum(McpOauthCompletionOutcome, obj.get("outcome")) request_id = from_str(obj.get("requestId")) return McpOauthCompletedData( + outcome=outcome, request_id=request_id, ) def to_dict(self) -> dict: result: dict = {} + result["outcome"] = to_enum(McpOauthCompletionOutcome, self.outcome) result["requestId"] = from_str(self.request_id) return result +@dataclass +class McpOauthHttpResponse: + "Raw HTTP response details from the OAuth auth challenge, as observed by the runtime." + headers: list[HeaderEntry] + status_code: int + body: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "McpOauthHttpResponse": + assert isinstance(obj, dict) + headers = from_list(HeaderEntry.from_dict, obj.get("headers")) + status_code = from_int(obj.get("statusCode")) + body = from_union([from_none, from_str], obj.get("body")) + return McpOauthHttpResponse( + headers=headers, + status_code=status_code, + body=body, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["headers"] = from_list(lambda x: to_class(HeaderEntry, x), self.headers) + result["statusCode"] = to_int(self.status_code) + if self.body is not None: + result["body"] = from_union([from_none, from_str], self.body) + return result + + @dataclass class McpOauthRequiredData: "OAuth authentication request for an MCP server" + reason: McpOauthRequestReason request_id: str server_name: str server_url: str + http_response: McpOauthHttpResponse | None = None + resource_metadata: str | None = None static_client_config: McpOauthRequiredStaticClientConfig | None = None + www_authenticate_params: McpOauthWWWAuthenticateParams | None = None @staticmethod def from_dict(obj: Any) -> "McpOauthRequiredData": assert isinstance(obj, dict) + reason = parse_enum(McpOauthRequestReason, obj.get("reason")) request_id = from_str(obj.get("requestId")) server_name = from_str(obj.get("serverName")) server_url = from_str(obj.get("serverUrl")) + http_response = from_union([from_none, McpOauthHttpResponse.from_dict], obj.get("httpResponse")) + resource_metadata = from_union([from_none, from_str], obj.get("resourceMetadata")) static_client_config = from_union([from_none, McpOauthRequiredStaticClientConfig.from_dict], obj.get("staticClientConfig")) + www_authenticate_params = from_union([from_none, McpOauthWWWAuthenticateParams.from_dict], obj.get("wwwAuthenticateParams")) return McpOauthRequiredData( + reason=reason, request_id=request_id, server_name=server_name, server_url=server_url, + http_response=http_response, + resource_metadata=resource_metadata, static_client_config=static_client_config, + www_authenticate_params=www_authenticate_params, ) def to_dict(self) -> dict: result: dict = {} + result["reason"] = to_enum(McpOauthRequestReason, self.reason) result["requestId"] = from_str(self.request_id) result["serverName"] = from_str(self.server_name) result["serverUrl"] = from_str(self.server_url) + if self.http_response is not None: + result["httpResponse"] = from_union([from_none, lambda x: to_class(McpOauthHttpResponse, x)], self.http_response) + if self.resource_metadata is not None: + result["resourceMetadata"] = from_union([from_none, from_str], self.resource_metadata) if self.static_client_config is not None: result["staticClientConfig"] = from_union([from_none, lambda x: to_class(McpOauthRequiredStaticClientConfig, x)], self.static_client_config) + if self.www_authenticate_params is not None: + result["wwwAuthenticateParams"] = from_union([from_none, lambda x: to_class(McpOauthWWWAuthenticateParams, x)], self.www_authenticate_params) return result @@ -1942,6 +3973,7 @@ def to_dict(self) -> dict: class McpOauthRequiredStaticClientConfig: "Static OAuth client configuration, if the server specifies one" client_id: str + client_secret: str | None = None grant_type: str | None = None public_client: bool | None = None @@ -1949,10 +3981,12 @@ class McpOauthRequiredStaticClientConfig: def from_dict(obj: Any) -> "McpOauthRequiredStaticClientConfig": assert isinstance(obj, dict) client_id = from_str(obj.get("clientId")) + client_secret = from_union([from_none, from_str], obj.get("clientSecret")) grant_type = from_union([from_none, from_str], obj.get("grantType")) public_client = from_union([from_none, from_bool], obj.get("publicClient")) return McpOauthRequiredStaticClientConfig( client_id=client_id, + client_secret=client_secret, grant_type=grant_type, public_client=public_client, ) @@ -1960,6 +3994,8 @@ def from_dict(obj: Any) -> "McpOauthRequiredStaticClientConfig": def to_dict(self) -> dict: result: dict = {} result["clientId"] = from_str(self.client_id) + if self.client_secret is not None: + result["clientSecret"] = from_union([from_none, from_str], self.client_secret) if self.grant_type is not None: result["grantType"] = from_union([from_none, from_str], self.grant_type) if self.public_client is not None: @@ -1967,9 +4003,77 @@ def to_dict(self) -> dict: return result +@dataclass +class McpOauthWWWAuthenticateParams: + "OAuth WWW-Authenticate parameters parsed from an MCP auth challenge" + error: str | None = None + resource_metadata_url: str | None = None + scope: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "McpOauthWWWAuthenticateParams": + assert isinstance(obj, dict) + error = from_union([from_none, from_str], obj.get("error")) + resource_metadata_url = from_union([from_none, from_str], obj.get("resourceMetadataUrl")) + scope = from_union([from_none, from_str], obj.get("scope")) + return McpOauthWWWAuthenticateParams( + error=error, + resource_metadata_url=resource_metadata_url, + scope=scope, + ) + + def to_dict(self) -> dict: + result: dict = {} + if self.error is not None: + result["error"] = from_union([from_none, from_str], self.error) + if self.resource_metadata_url is not None: + result["resourceMetadataUrl"] = from_union([from_none, from_str], self.resource_metadata_url) + if self.scope is not None: + result["scope"] = from_union([from_none, from_str], self.scope) + return result + + +@dataclass +class McpPromptsListChangedData: + "Payload identifying the MCP server associated with a list change." + server_name: str + + @staticmethod + def from_dict(obj: Any) -> "McpPromptsListChangedData": + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return McpPromptsListChangedData( + server_name=server_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + return result + + +@dataclass +class McpResourcesListChangedData: + "Payload identifying the MCP server associated with a list change." + server_name: str + + @staticmethod + def from_dict(obj: Any) -> "McpResourcesListChangedData": + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return McpResourcesListChangedData( + server_name=server_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + return result + + @dataclass class McpServersLoadedServer: - "Schema for the `McpServersLoadedServer` type." + "A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata." name: str status: McpServerStatus error: str | None = None @@ -2015,41 +4119,103 @@ def to_dict(self) -> dict: return result +@dataclass +class McpToolsListChangedData: + "Payload identifying the MCP server associated with a list change." + server_name: str + + @staticmethod + def from_dict(obj: Any) -> "McpToolsListChangedData": + assert isinstance(obj, dict) + server_name = from_str(obj.get("serverName")) + return McpToolsListChangedData( + server_name=server_name, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["serverName"] = from_str(self.server_name) + return result + + @dataclass class ModelCallFailureData: "Failed LLM API call metadata for telemetry" source: ModelCallFailureSource api_call_id: str | None = None + api_endpoint: AssistantUsageApiEndpoint | None = None + bad_request_kind: ModelCallFailureBadRequestKind | None = None duration: timedelta | None = None + error_code: str | None = None error_message: str | None = None + error_type: str | None = None + failure_kind: ModelCallFailureKind | None = None initiator: str | None = None + is_auto: bool | None = None + is_byok: bool | None = None + max_output_tokens: int | None = None + max_prompt_tokens: int | None = None model: str | None = None provider_call_id: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _quota_snapshots: dict[str, _AssistantUsageQuotaSnapshot] | None = None + reasoning_effort: str | None = None + request_fingerprint: ModelCallFailureRequestFingerprint | None = None + rte: bool | None = None service_request_id: str | None = None status_code: int | None = None + transport: ModelCallFailureTransport | None = None @staticmethod def from_dict(obj: Any) -> "ModelCallFailureData": assert isinstance(obj, dict) source = parse_enum(ModelCallFailureSource, obj.get("source")) api_call_id = from_union([from_none, from_str], obj.get("apiCallId")) + api_endpoint = from_union([from_none, lambda x: parse_enum(AssistantUsageApiEndpoint, x)], obj.get("apiEndpoint")) + bad_request_kind = from_union([from_none, lambda x: parse_enum(ModelCallFailureBadRequestKind, x)], obj.get("badRequestKind")) duration = from_union([from_none, from_timedelta], obj.get("durationMs")) + error_code = from_union([from_none, from_str], obj.get("errorCode")) error_message = from_union([from_none, from_str], obj.get("errorMessage")) + error_type = from_union([from_none, from_str], obj.get("errorType")) + failure_kind = from_union([from_none, lambda x: parse_enum(ModelCallFailureKind, x)], obj.get("failureKind")) initiator = from_union([from_none, from_str], obj.get("initiator")) + is_auto = from_union([from_none, from_bool], obj.get("isAuto")) + is_byok = from_union([from_none, from_bool], obj.get("isByok")) + max_output_tokens = from_union([from_none, from_int], obj.get("maxOutputTokens")) + max_prompt_tokens = from_union([from_none, from_int], obj.get("maxPromptTokens")) model = from_union([from_none, from_str], obj.get("model")) provider_call_id = from_union([from_none, from_str], obj.get("providerCallId")) + _quota_snapshots = from_union([from_none, lambda x: from_dict(_AssistantUsageQuotaSnapshot.from_dict, x)], obj.get("quotaSnapshots")) + reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) + request_fingerprint = from_union([from_none, ModelCallFailureRequestFingerprint.from_dict], obj.get("requestFingerprint")) + rte = from_union([from_none, from_bool], obj.get("rte")) service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) status_code = from_union([from_none, from_int], obj.get("statusCode")) + transport = from_union([from_none, lambda x: parse_enum(ModelCallFailureTransport, x)], obj.get("transport")) return ModelCallFailureData( source=source, api_call_id=api_call_id, + api_endpoint=api_endpoint, + bad_request_kind=bad_request_kind, duration=duration, + error_code=error_code, error_message=error_message, + error_type=error_type, + failure_kind=failure_kind, initiator=initiator, + is_auto=is_auto, + is_byok=is_byok, + max_output_tokens=max_output_tokens, + max_prompt_tokens=max_prompt_tokens, model=model, provider_call_id=provider_call_id, + _quota_snapshots=_quota_snapshots, + reasoning_effort=reasoning_effort, + request_fingerprint=request_fingerprint, + rte=rte, service_request_id=service_request_id, status_code=status_code, + transport=transport, ) def to_dict(self) -> dict: @@ -2057,20 +4223,122 @@ def to_dict(self) -> dict: result["source"] = to_enum(ModelCallFailureSource, self.source) if self.api_call_id is not None: result["apiCallId"] = from_union([from_none, from_str], self.api_call_id) + if self.api_endpoint is not None: + result["apiEndpoint"] = from_union([from_none, lambda x: to_enum(AssistantUsageApiEndpoint, x)], self.api_endpoint) + if self.bad_request_kind is not None: + result["badRequestKind"] = from_union([from_none, lambda x: to_enum(ModelCallFailureBadRequestKind, x)], self.bad_request_kind) if self.duration is not None: result["durationMs"] = from_union([from_none, to_timedelta_int], self.duration) + if self.error_code is not None: + result["errorCode"] = from_union([from_none, from_str], self.error_code) if self.error_message is not None: result["errorMessage"] = from_union([from_none, from_str], self.error_message) + if self.error_type is not None: + result["errorType"] = from_union([from_none, from_str], self.error_type) + if self.failure_kind is not None: + result["failureKind"] = from_union([from_none, lambda x: to_enum(ModelCallFailureKind, x)], self.failure_kind) if self.initiator is not None: result["initiator"] = from_union([from_none, from_str], self.initiator) + if self.is_auto is not None: + result["isAuto"] = from_union([from_none, from_bool], self.is_auto) + if self.is_byok is not None: + result["isByok"] = from_union([from_none, from_bool], self.is_byok) + if self.max_output_tokens is not None: + result["maxOutputTokens"] = from_union([from_none, to_int], self.max_output_tokens) + if self.max_prompt_tokens is not None: + result["maxPromptTokens"] = from_union([from_none, to_int], self.max_prompt_tokens) if self.model is not None: result["model"] = from_union([from_none, from_str], self.model) if self.provider_call_id is not None: result["providerCallId"] = from_union([from_none, from_str], self.provider_call_id) + if self._quota_snapshots is not None: + result["quotaSnapshots"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(_AssistantUsageQuotaSnapshot, x), x)], self._quota_snapshots) + if self.reasoning_effort is not None: + result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) + if self.request_fingerprint is not None: + result["requestFingerprint"] = from_union([from_none, lambda x: to_class(ModelCallFailureRequestFingerprint, x)], self.request_fingerprint) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) if self.service_request_id is not None: result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) if self.status_code is not None: result["statusCode"] = from_union([from_none, to_int], self.status_code) + if self.transport is not None: + result["transport"] = from_union([from_none, lambda x: to_enum(ModelCallFailureTransport, x)], self.transport) + return result + + +@dataclass +class ModelCallFailureRequestFingerprint: + "Content-free structural summary of the failing request for diagnosing malformed 4xx calls" + image_part_count: int + image_parts_missing_media_type: int + message_count: int + nameless_tool_call_count: int + tool_call_count: int + tool_result_message_count: int + last_message_role: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "ModelCallFailureRequestFingerprint": + assert isinstance(obj, dict) + image_part_count = from_int(obj.get("imagePartCount")) + image_parts_missing_media_type = from_int(obj.get("imagePartsMissingMediaType")) + message_count = from_int(obj.get("messageCount")) + nameless_tool_call_count = from_int(obj.get("namelessToolCallCount")) + tool_call_count = from_int(obj.get("toolCallCount")) + tool_result_message_count = from_int(obj.get("toolResultMessageCount")) + last_message_role = from_union([from_none, from_str], obj.get("lastMessageRole")) + return ModelCallFailureRequestFingerprint( + image_part_count=image_part_count, + image_parts_missing_media_type=image_parts_missing_media_type, + message_count=message_count, + nameless_tool_call_count=nameless_tool_call_count, + tool_call_count=tool_call_count, + tool_result_message_count=tool_result_message_count, + last_message_role=last_message_role, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["imagePartCount"] = to_int(self.image_part_count) + result["imagePartsMissingMediaType"] = to_int(self.image_parts_missing_media_type) + result["messageCount"] = to_int(self.message_count) + result["namelessToolCallCount"] = to_int(self.nameless_tool_call_count) + result["toolCallCount"] = to_int(self.tool_call_count) + result["toolResultMessageCount"] = to_int(self.tool_result_message_count) + if self.last_message_role is not None: + result["lastMessageRole"] = from_union([from_none, from_str], self.last_message_role) + return result + + +@dataclass +class ModelCallStartData: + "Model API dispatch metadata for internal telemetry" + turn_id: str + model: str | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _previous_response_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "ModelCallStartData": + assert isinstance(obj, dict) + turn_id = from_str(obj.get("turnId")) + model = from_union([from_none, from_str], obj.get("model")) + _previous_response_id = from_union([from_none, from_str], obj.get("previousResponseId")) + return ModelCallStartData( + turn_id=turn_id, + model=model, + _previous_response_id=_previous_response_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["turnId"] = from_str(self.turn_id) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) + if self._previous_response_id is not None: + result["previousResponseId"] = from_union([from_none, from_str], self._previous_response_id) return result @@ -2088,7 +4356,7 @@ def to_dict(self) -> dict: @dataclass class PermissionApproved: - "Schema for the `PermissionApproved` type." + "Permission response variant indicating the request was approved without persisting an approval rule." kind: ClassVar[str] = "approved" @staticmethod @@ -2105,7 +4373,7 @@ def to_dict(self) -> dict: @dataclass class PermissionApprovedForLocation: - "Schema for the `PermissionApprovedForLocation` type." + "Permission response variant that approves a request and persists the provided approval to a project location key." approval: UserToolSessionApproval kind: ClassVar[str] = "approved-for-location" location_key: str @@ -2130,7 +4398,7 @@ def to_dict(self) -> dict: @dataclass class PermissionApprovedForSession: - "Schema for the `PermissionApprovedForSession` type." + "Permission response variant that approves a request and remembers the provided approval for the rest of the session." approval: UserToolSessionApproval kind: ClassVar[str] = "approved-for-session" @@ -2151,7 +4419,7 @@ def to_dict(self) -> dict: @dataclass class PermissionCancelled: - "Schema for the `PermissionCancelled` type." + "Permission response variant indicating the request was cancelled before use, with an optional reason." kind: ClassVar[str] = "cancelled" reason: str | None = None @@ -2201,7 +4469,7 @@ def to_dict(self) -> dict: @dataclass class PermissionDeniedByContentExclusionPolicy: - "Schema for the `PermissionDeniedByContentExclusionPolicy` type." + "Permission response variant denying a path under content exclusion policy, with the path and message." kind: ClassVar[str] = "denied-by-content-exclusion-policy" message: str path: str @@ -2226,7 +4494,7 @@ def to_dict(self) -> dict: @dataclass class PermissionDeniedByPermissionRequestHook: - "Schema for the `PermissionDeniedByPermissionRequestHook` type." + "Permission response variant denied by a permission-request hook, with optional message and interrupt flag." kind: ClassVar[str] = "denied-by-permission-request-hook" interrupt: bool | None = None message: str | None = None @@ -2253,7 +4521,7 @@ def to_dict(self) -> dict: @dataclass class PermissionDeniedByRules: - "Schema for the `PermissionDeniedByRules` type." + "Permission response variant denied because matching approval rules explicitly blocked the request." kind: ClassVar[str] = "denied-by-rules" rules: list[PermissionRule] @@ -2274,7 +4542,7 @@ def to_dict(self) -> dict: @dataclass class PermissionDeniedInteractivelyByUser: - "Schema for the `PermissionDeniedInteractivelyByUser` type." + "Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag." kind: ClassVar[str] = "denied-interactively-by-user" feedback: str | None = None force_reject: bool | None = None @@ -2301,7 +4569,7 @@ def to_dict(self) -> dict: @dataclass class PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser: - "Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type." + "Permission response variant denied because no approval rule matched and user confirmation was unavailable." kind: ClassVar[str] = "denied-no-approval-rule-and-could-not-request-from-user" @staticmethod @@ -2324,6 +4592,9 @@ class PermissionPromptRequestCommands: full_command_text: str intention: str kind: ClassVar[str] = "commands" + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None + managed_approval_required: bool | None = None tool_call_id: str | None = None warning: str | None = None @@ -2334,6 +4605,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestCommands": command_identifiers = from_list(from_str, obj.get("commandIdentifiers")) full_command_text = from_str(obj.get("fullCommandText")) intention = from_str(obj.get("intention")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) warning = from_union([from_none, from_str], obj.get("warning")) return PermissionPromptRequestCommands( @@ -2341,6 +4614,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestCommands": command_identifiers=command_identifiers, full_command_text=full_command_text, intention=intention, + auto_approval=auto_approval, + managed_approval_required=managed_approval_required, tool_call_id=tool_call_id, warning=warning, ) @@ -2352,6 +4627,10 @@ def to_dict(self) -> dict: result["fullCommandText"] = from_str(self.full_command_text) result["intention"] = from_str(self.intention) result["kind"] = self.kind + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) if self.warning is not None: @@ -2366,6 +4645,8 @@ class PermissionPromptRequestCustomTool: tool_description: str tool_name: str args: Any = None + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None tool_call_id: str | None = None @staticmethod @@ -2374,11 +4655,13 @@ def from_dict(obj: Any) -> "PermissionPromptRequestCustomTool": tool_description = from_str(obj.get("toolDescription")) tool_name = from_str(obj.get("toolName")) args = obj.get("args") + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestCustomTool( tool_description=tool_description, tool_name=tool_name, args=args, + auto_approval=auto_approval, tool_call_id=tool_call_id, ) @@ -2389,6 +4672,8 @@ def to_dict(self) -> dict: result["toolName"] = from_str(self.tool_name) if self.args is not None: result["args"] = self.args + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2399,6 +4684,8 @@ class PermissionPromptRequestExtensionManagement: "Extension management permission prompt" kind: ClassVar[str] = "extension-management" operation: str + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None extension_name: str | None = None tool_call_id: str | None = None @@ -2406,10 +4693,12 @@ class PermissionPromptRequestExtensionManagement: def from_dict(obj: Any) -> "PermissionPromptRequestExtensionManagement": assert isinstance(obj, dict) operation = from_str(obj.get("operation")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) extension_name = from_union([from_none, from_str], obj.get("extensionName")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestExtensionManagement( operation=operation, + auto_approval=auto_approval, extension_name=extension_name, tool_call_id=tool_call_id, ) @@ -2418,6 +4707,8 @@ def to_dict(self) -> dict: result: dict = {} result["kind"] = self.kind result["operation"] = from_str(self.operation) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.extension_name is not None: result["extensionName"] = from_union([from_none, from_str], self.extension_name) if self.tool_call_id is not None: @@ -2431,6 +4722,8 @@ class PermissionPromptRequestExtensionPermissionAccess: capabilities: list[str] extension_name: str kind: ClassVar[str] = "extension-permission-access" + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None tool_call_id: str | None = None @staticmethod @@ -2438,10 +4731,12 @@ def from_dict(obj: Any) -> "PermissionPromptRequestExtensionPermissionAccess": assert isinstance(obj, dict) capabilities = from_list(from_str, obj.get("capabilities")) extension_name = from_str(obj.get("extensionName")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestExtensionPermissionAccess( capabilities=capabilities, extension_name=extension_name, + auto_approval=auto_approval, tool_call_id=tool_call_id, ) @@ -2450,6 +4745,105 @@ def to_dict(self) -> dict: result["capabilities"] = from_list(from_str, self.capabilities) result["extensionName"] = from_str(self.extension_name) result["kind"] = self.kind + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + return result + + +@dataclass +class PermissionPromptRequestFactory: + "Factory run or authoring permission prompt" + approval_key: str + can_persist_approval: bool + description: str + kind: ClassVar[str] = "factory" + name: str + operation: FactoryPermissionOperation + phases: list[FactoryPermissionPhase] + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None + declared_max_ai_credits: float | None = None + declared_max_concurrent_subagents: int | None = None + declared_max_total_subagents: int | None = None + declared_timeout_seconds: float | None = None + managed_approval_required: bool | None = None + max_ai_credits: float | None = None + max_concurrent_subagents: int | None = None + max_total_subagents: int | None = None + timeout_seconds: float | None = None + tool_call_id: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "PermissionPromptRequestFactory": + assert isinstance(obj, dict) + approval_key = from_str(obj.get("approvalKey")) + can_persist_approval = from_bool(obj.get("canPersistApproval")) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + operation = parse_enum(FactoryPermissionOperation, obj.get("operation")) + phases = from_list(FactoryPermissionPhase.from_dict, obj.get("phases")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + declared_max_ai_credits = from_union([from_none, from_float], obj.get("declaredMaxAiCredits")) + declared_max_concurrent_subagents = from_union([from_none, from_int], obj.get("declaredMaxConcurrentSubagents")) + declared_max_total_subagents = from_union([from_none, from_int], obj.get("declaredMaxTotalSubagents")) + declared_timeout_seconds = from_union([from_none, from_float], obj.get("declaredTimeoutSeconds")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + max_ai_credits = from_union([from_none, from_float], obj.get("maxAiCredits")) + max_concurrent_subagents = from_union([from_none, from_int], obj.get("maxConcurrentSubagents")) + max_total_subagents = from_union([from_none, from_int], obj.get("maxTotalSubagents")) + timeout_seconds = from_union([from_none, from_float], obj.get("timeoutSeconds")) + tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + return PermissionPromptRequestFactory( + approval_key=approval_key, + can_persist_approval=can_persist_approval, + description=description, + name=name, + operation=operation, + phases=phases, + auto_approval=auto_approval, + declared_max_ai_credits=declared_max_ai_credits, + declared_max_concurrent_subagents=declared_max_concurrent_subagents, + declared_max_total_subagents=declared_max_total_subagents, + declared_timeout_seconds=declared_timeout_seconds, + managed_approval_required=managed_approval_required, + max_ai_credits=max_ai_credits, + max_concurrent_subagents=max_concurrent_subagents, + max_total_subagents=max_total_subagents, + timeout_seconds=timeout_seconds, + tool_call_id=tool_call_id, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["approvalKey"] = from_str(self.approval_key) + result["canPersistApproval"] = from_bool(self.can_persist_approval) + result["description"] = from_str(self.description) + result["kind"] = self.kind + result["name"] = from_str(self.name) + result["operation"] = to_enum(FactoryPermissionOperation, self.operation) + result["phases"] = from_list(lambda x: to_class(FactoryPermissionPhase, x), self.phases) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.declared_max_ai_credits is not None: + result["declaredMaxAiCredits"] = from_union([from_none, to_float], self.declared_max_ai_credits) + if self.declared_max_concurrent_subagents is not None: + result["declaredMaxConcurrentSubagents"] = from_union([from_none, to_int], self.declared_max_concurrent_subagents) + if self.declared_max_total_subagents is not None: + result["declaredMaxTotalSubagents"] = from_union([from_none, to_int], self.declared_max_total_subagents) + if self.declared_timeout_seconds is not None: + result["declaredTimeoutSeconds"] = from_union([from_none, to_float], self.declared_timeout_seconds) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([from_none, to_float], self.max_ai_credits) + if self.max_concurrent_subagents is not None: + result["maxConcurrentSubagents"] = from_union([from_none, to_int], self.max_concurrent_subagents) + if self.max_total_subagents is not None: + result["maxTotalSubagents"] = from_union([from_none, to_int], self.max_total_subagents) + if self.timeout_seconds is not None: + result["timeoutSeconds"] = from_union([from_none, to_float], self.timeout_seconds) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2460,6 +4854,8 @@ class PermissionPromptRequestHook: "Hook confirmation permission prompt" kind: ClassVar[str] = "hook" tool_name: str + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None hook_message: str | None = None tool_args: Any = None tool_call_id: str | None = None @@ -2468,11 +4864,13 @@ class PermissionPromptRequestHook: def from_dict(obj: Any) -> "PermissionPromptRequestHook": assert isinstance(obj, dict) tool_name = from_str(obj.get("toolName")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) hook_message = from_union([from_none, from_str], obj.get("hookMessage")) tool_args = obj.get("toolArgs") tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestHook( tool_name=tool_name, + auto_approval=auto_approval, hook_message=hook_message, tool_args=tool_args, tool_call_id=tool_call_id, @@ -2482,6 +4880,8 @@ def to_dict(self) -> dict: result: dict = {} result["kind"] = self.kind result["toolName"] = from_str(self.tool_name) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.hook_message is not None: result["hookMessage"] = from_union([from_none, from_str], self.hook_message) if self.tool_args is not None: @@ -2498,7 +4898,9 @@ class PermissionPromptRequestMcp: server_name: str tool_name: str tool_title: str - args: Any | None = None + args: Any = None + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None tool_call_id: str | None = None @staticmethod @@ -2507,13 +4909,15 @@ def from_dict(obj: Any) -> "PermissionPromptRequestMcp": server_name = from_str(obj.get("serverName")) tool_name = from_str(obj.get("toolName")) tool_title = from_str(obj.get("toolTitle")) - args = from_union([from_none, lambda x: x], obj.get("args")) + args = obj.get("args") + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestMcp( server_name=server_name, tool_name=tool_name, tool_title=tool_title, args=args, + auto_approval=auto_approval, tool_call_id=tool_call_id, ) @@ -2524,7 +4928,9 @@ def to_dict(self) -> dict: result["toolName"] = from_str(self.tool_name) result["toolTitle"] = from_str(self.tool_title) if self.args is not None: - result["args"] = from_union([from_none, lambda x: x], self.args) + result["args"] = self.args + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2536,6 +4942,8 @@ class PermissionPromptRequestMemory: fact: str kind: ClassVar[str] = "memory" action: PermissionRequestMemoryAction | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None citations: str | None = None direction: PermissionRequestMemoryDirection | None = None reason: str | None = None @@ -2547,6 +4955,7 @@ def from_dict(obj: Any) -> "PermissionPromptRequestMemory": assert isinstance(obj, dict) fact = from_str(obj.get("fact")) action = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryAction, x)], obj.get("action")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) citations = from_union([from_none, from_str], obj.get("citations")) direction = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryDirection, x)], obj.get("direction")) reason = from_union([from_none, from_str], obj.get("reason")) @@ -2555,6 +4964,7 @@ def from_dict(obj: Any) -> "PermissionPromptRequestMemory": return PermissionPromptRequestMemory( fact=fact, action=action, + auto_approval=auto_approval, citations=citations, direction=direction, reason=reason, @@ -2568,6 +4978,8 @@ def to_dict(self) -> dict: result["kind"] = self.kind if self.action is not None: result["action"] = from_union([from_none, lambda x: to_enum(PermissionRequestMemoryAction, x)], self.action) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.citations is not None: result["citations"] = from_union([from_none, from_str], self.citations) if self.direction is not None: @@ -2587,6 +4999,8 @@ class PermissionPromptRequestPath: access_kind: PermissionPromptRequestPathAccessKind kind: ClassVar[str] = "path" paths: list[str] + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None tool_call_id: str | None = None @staticmethod @@ -2594,10 +5008,12 @@ def from_dict(obj: Any) -> "PermissionPromptRequestPath": assert isinstance(obj, dict) access_kind = parse_enum(PermissionPromptRequestPathAccessKind, obj.get("accessKind")) paths = from_list(from_str, obj.get("paths")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestPath( access_kind=access_kind, paths=paths, + auto_approval=auto_approval, tool_call_id=tool_call_id, ) @@ -2606,6 +5022,8 @@ def to_dict(self) -> dict: result["accessKind"] = to_enum(PermissionPromptRequestPathAccessKind, self.access_kind) result["kind"] = self.kind result["paths"] = from_list(from_str, self.paths) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2617,6 +5035,9 @@ class PermissionPromptRequestRead: intention: str kind: ClassVar[str] = "read" path: str + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None + managed_approval_required: bool | None = None tool_call_id: str | None = None @staticmethod @@ -2624,10 +5045,14 @@ def from_dict(obj: Any) -> "PermissionPromptRequestRead": assert isinstance(obj, dict) intention = from_str(obj.get("intention")) path = from_str(obj.get("path")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestRead( intention=intention, path=path, + auto_approval=auto_approval, + managed_approval_required=managed_approval_required, tool_call_id=tool_call_id, ) @@ -2636,6 +5061,10 @@ def to_dict(self) -> dict: result["intention"] = from_str(self.intention) result["kind"] = self.kind result["path"] = from_str(self.path) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2647,6 +5076,12 @@ class PermissionPromptRequestUrl: intention: str kind: ClassVar[str] = "url" url: str + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None + managed_approval_required: bool | None = None + redirected_from: str | None = None + request_sandbox_bypass: bool | None = None + request_sandbox_bypass_reason: str | None = None tool_call_id: str | None = None @staticmethod @@ -2654,10 +5089,20 @@ def from_dict(obj: Any) -> "PermissionPromptRequestUrl": assert isinstance(obj, dict) intention = from_str(obj.get("intention")) url = from_str(obj.get("url")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + redirected_from = from_union([from_none, from_str], obj.get("redirectedFrom")) + request_sandbox_bypass = from_union([from_none, from_bool], obj.get("requestSandboxBypass")) + request_sandbox_bypass_reason = from_union([from_none, from_str], obj.get("requestSandboxBypassReason")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestUrl( intention=intention, url=url, + auto_approval=auto_approval, + managed_approval_required=managed_approval_required, + redirected_from=redirected_from, + request_sandbox_bypass=request_sandbox_bypass, + request_sandbox_bypass_reason=request_sandbox_bypass_reason, tool_call_id=tool_call_id, ) @@ -2666,6 +5111,16 @@ def to_dict(self) -> dict: result["intention"] = from_str(self.intention) result["kind"] = self.kind result["url"] = from_str(self.url) + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + if self.redirected_from is not None: + result["redirectedFrom"] = from_union([from_none, from_str], self.redirected_from) + if self.request_sandbox_bypass is not None: + result["requestSandboxBypass"] = from_union([from_none, from_bool], self.request_sandbox_bypass) + if self.request_sandbox_bypass_reason is not None: + result["requestSandboxBypassReason"] = from_union([from_none, from_str], self.request_sandbox_bypass_reason) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2679,6 +5134,9 @@ class PermissionPromptRequestWrite: file_name: str intention: str kind: ClassVar[str] = "write" + # Experimental: this field is part of an experimental API and may change or be removed. + auto_approval: PermissionAutoApproval | None = None + managed_approval_required: bool | None = None new_file_contents: str | None = None tool_call_id: str | None = None @@ -2689,6 +5147,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestWrite": diff = from_str(obj.get("diff")) file_name = from_str(obj.get("fileName")) intention = from_str(obj.get("intention")) + auto_approval = from_union([from_none, PermissionAutoApproval.from_dict], obj.get("autoApproval")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) new_file_contents = from_union([from_none, from_str], obj.get("newFileContents")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionPromptRequestWrite( @@ -2696,6 +5156,8 @@ def from_dict(obj: Any) -> "PermissionPromptRequestWrite": diff=diff, file_name=file_name, intention=intention, + auto_approval=auto_approval, + managed_approval_required=managed_approval_required, new_file_contents=new_file_contents, tool_call_id=tool_call_id, ) @@ -2707,6 +5169,10 @@ def to_dict(self) -> dict: result["fileName"] = from_str(self.file_name) result["intention"] = from_str(self.intention) result["kind"] = self.kind + if self.auto_approval is not None: + result["autoApproval"] = from_union([from_none, lambda x: to_class(PermissionAutoApproval, x)], self.auto_approval) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) if self.new_file_contents is not None: result["newFileContents"] = from_union([from_none, from_str], self.new_file_contents) if self.tool_call_id is not None: @@ -2722,6 +5188,7 @@ class PermissionRequestCustomTool: tool_name: str args: Any = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestCustomTool": @@ -2730,11 +5197,13 @@ def from_dict(obj: Any) -> "PermissionRequestCustomTool": tool_name = from_str(obj.get("toolName")) args = obj.get("args") tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestCustomTool( tool_description=tool_description, tool_name=tool_name, args=args, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2746,6 +5215,8 @@ def to_dict(self) -> dict: result["args"] = self.args if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2756,6 +5227,7 @@ class PermissionRequestExtensionManagement: operation: str extension_name: str | None = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestExtensionManagement": @@ -2763,10 +5235,12 @@ def from_dict(obj: Any) -> "PermissionRequestExtensionManagement": operation = from_str(obj.get("operation")) extension_name = from_union([from_none, from_str], obj.get("extensionName")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestExtensionManagement( operation=operation, extension_name=extension_name, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2777,6 +5251,8 @@ def to_dict(self) -> dict: result["extensionName"] = from_union([from_none, from_str], self.extension_name) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2787,6 +5263,7 @@ class PermissionRequestExtensionPermissionAccess: extension_name: str kind: ClassVar[str] = "extension-permission-access" tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestExtensionPermissionAccess": @@ -2794,10 +5271,12 @@ def from_dict(obj: Any) -> "PermissionRequestExtensionPermissionAccess": capabilities = from_list(from_str, obj.get("capabilities")) extension_name = from_str(obj.get("extensionName")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestExtensionPermissionAccess( capabilities=capabilities, extension_name=extension_name, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2807,6 +5286,99 @@ def to_dict(self) -> dict: result["kind"] = self.kind if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + return result + + +@dataclass +class PermissionRequestFactory: + "Factory run or authoring permission request" + approval_key: str + can_persist_approval: bool + description: str + kind: ClassVar[str] = "factory" + name: str + operation: FactoryPermissionOperation + phases: list[FactoryPermissionPhase] + declared_max_ai_credits: float | None = None + declared_max_concurrent_subagents: int | None = None + declared_max_total_subagents: int | None = None + declared_timeout_seconds: float | None = None + max_ai_credits: float | None = None + max_concurrent_subagents: int | None = None + max_total_subagents: int | None = None + timeout_seconds: float | None = None + tool_call_id: str | None = None + managed_approval_required: bool | None = None + + @staticmethod + def from_dict(obj: Any) -> "PermissionRequestFactory": + assert isinstance(obj, dict) + approval_key = from_str(obj.get("approvalKey")) + can_persist_approval = from_bool(obj.get("canPersistApproval")) + description = from_str(obj.get("description")) + name = from_str(obj.get("name")) + operation = parse_enum(FactoryPermissionOperation, obj.get("operation")) + phases = from_list(FactoryPermissionPhase.from_dict, obj.get("phases")) + declared_max_ai_credits = from_union([from_none, from_float], obj.get("declaredMaxAiCredits")) + declared_max_concurrent_subagents = from_union([from_none, from_int], obj.get("declaredMaxConcurrentSubagents")) + declared_max_total_subagents = from_union([from_none, from_int], obj.get("declaredMaxTotalSubagents")) + declared_timeout_seconds = from_union([from_none, from_float], obj.get("declaredTimeoutSeconds")) + max_ai_credits = from_union([from_none, from_float], obj.get("maxAiCredits")) + max_concurrent_subagents = from_union([from_none, from_int], obj.get("maxConcurrentSubagents")) + max_total_subagents = from_union([from_none, from_int], obj.get("maxTotalSubagents")) + timeout_seconds = from_union([from_none, from_float], obj.get("timeoutSeconds")) + tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + return PermissionRequestFactory( + approval_key=approval_key, + can_persist_approval=can_persist_approval, + description=description, + name=name, + operation=operation, + phases=phases, + declared_max_ai_credits=declared_max_ai_credits, + declared_max_concurrent_subagents=declared_max_concurrent_subagents, + declared_max_total_subagents=declared_max_total_subagents, + declared_timeout_seconds=declared_timeout_seconds, + max_ai_credits=max_ai_credits, + max_concurrent_subagents=max_concurrent_subagents, + max_total_subagents=max_total_subagents, + timeout_seconds=timeout_seconds, + tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["approvalKey"] = from_str(self.approval_key) + result["canPersistApproval"] = from_bool(self.can_persist_approval) + result["description"] = from_str(self.description) + result["kind"] = self.kind + result["name"] = from_str(self.name) + result["operation"] = to_enum(FactoryPermissionOperation, self.operation) + result["phases"] = from_list(lambda x: to_class(FactoryPermissionPhase, x), self.phases) + if self.declared_max_ai_credits is not None: + result["declaredMaxAiCredits"] = from_union([from_none, to_float], self.declared_max_ai_credits) + if self.declared_max_concurrent_subagents is not None: + result["declaredMaxConcurrentSubagents"] = from_union([from_none, to_int], self.declared_max_concurrent_subagents) + if self.declared_max_total_subagents is not None: + result["declaredMaxTotalSubagents"] = from_union([from_none, to_int], self.declared_max_total_subagents) + if self.declared_timeout_seconds is not None: + result["declaredTimeoutSeconds"] = from_union([from_none, to_float], self.declared_timeout_seconds) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([from_none, to_float], self.max_ai_credits) + if self.max_concurrent_subagents is not None: + result["maxConcurrentSubagents"] = from_union([from_none, to_int], self.max_concurrent_subagents) + if self.max_total_subagents is not None: + result["maxTotalSubagents"] = from_union([from_none, to_int], self.max_total_subagents) + if self.timeout_seconds is not None: + result["timeoutSeconds"] = from_union([from_none, to_float], self.timeout_seconds) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2818,6 +5390,7 @@ class PermissionRequestHook: hook_message: str | None = None tool_args: Any = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestHook": @@ -2826,11 +5399,13 @@ def from_dict(obj: Any) -> "PermissionRequestHook": hook_message = from_union([from_none, from_str], obj.get("hookMessage")) tool_args = obj.get("toolArgs") tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestHook( tool_name=tool_name, hook_message=hook_message, tool_args=tool_args, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2843,6 +5418,8 @@ def to_dict(self) -> dict: result["toolArgs"] = self.tool_args if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2856,6 +5433,7 @@ class PermissionRequestMcp: tool_title: str args: Any = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestMcp": @@ -2866,6 +5444,7 @@ def from_dict(obj: Any) -> "PermissionRequestMcp": tool_title = from_str(obj.get("toolTitle")) args = obj.get("args") tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestMcp( read_only=read_only, server_name=server_name, @@ -2873,6 +5452,7 @@ def from_dict(obj: Any) -> "PermissionRequestMcp": tool_title=tool_title, args=args, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2886,6 +5466,8 @@ def to_dict(self) -> dict: result["args"] = self.args if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2900,6 +5482,7 @@ class PermissionRequestMemory: reason: str | None = None subject: str | None = None tool_call_id: str | None = None + managed_approval_required: bool | None = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestMemory": @@ -2911,6 +5494,7 @@ def from_dict(obj: Any) -> "PermissionRequestMemory": reason = from_union([from_none, from_str], obj.get("reason")) subject = from_union([from_none, from_str], obj.get("subject")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) return PermissionRequestMemory( fact=fact, action=action, @@ -2919,6 +5503,7 @@ def from_dict(obj: Any) -> "PermissionRequestMemory": reason=reason, subject=subject, tool_call_id=tool_call_id, + managed_approval_required=managed_approval_required, ) def to_dict(self) -> dict: @@ -2937,6 +5522,8 @@ def to_dict(self) -> dict: result["subject"] = from_union([from_none, from_str], self.subject) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) return result @@ -2946,6 +5533,9 @@ class PermissionRequestRead: intention: str kind: ClassVar[str] = "read" path: str + managed_approval_required: bool | None = None + request_sandbox_bypass: bool | None = None + request_sandbox_bypass_reason: str | None = None tool_call_id: str | None = None @staticmethod @@ -2953,10 +5543,16 @@ def from_dict(obj: Any) -> "PermissionRequestRead": assert isinstance(obj, dict) intention = from_str(obj.get("intention")) path = from_str(obj.get("path")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + request_sandbox_bypass = from_union([from_none, from_bool], obj.get("requestSandboxBypass")) + request_sandbox_bypass_reason = from_union([from_none, from_str], obj.get("requestSandboxBypassReason")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionRequestRead( intention=intention, path=path, + managed_approval_required=managed_approval_required, + request_sandbox_bypass=request_sandbox_bypass, + request_sandbox_bypass_reason=request_sandbox_bypass_reason, tool_call_id=tool_call_id, ) @@ -2965,6 +5561,12 @@ def to_dict(self) -> dict: result["intention"] = from_str(self.intention) result["kind"] = self.kind result["path"] = from_str(self.path) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + if self.request_sandbox_bypass is not None: + result["requestSandboxBypass"] = from_union([from_none, from_bool], self.request_sandbox_bypass) + if self.request_sandbox_bypass_reason is not None: + result["requestSandboxBypassReason"] = from_union([from_none, from_str], self.request_sandbox_bypass_reason) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -2981,6 +5583,10 @@ class PermissionRequestShell: kind: ClassVar[str] = "shell" possible_paths: list[str] possible_urls: list[PermissionRequestShellPossibleUrl] + command_segments: list[PermissionRequestShellCommandSegment] | None = None + managed_approval_required: bool | None = None + request_sandbox_bypass: bool | None = None + request_sandbox_bypass_reason: str | None = None tool_call_id: str | None = None warning: str | None = None @@ -2994,6 +5600,10 @@ def from_dict(obj: Any) -> "PermissionRequestShell": intention = from_str(obj.get("intention")) possible_paths = from_list(from_str, obj.get("possiblePaths")) possible_urls = from_list(PermissionRequestShellPossibleUrl.from_dict, obj.get("possibleUrls")) + command_segments = from_union([from_none, lambda x: from_list(PermissionRequestShellCommandSegment.from_dict, x)], obj.get("commandSegments")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + request_sandbox_bypass = from_union([from_none, from_bool], obj.get("requestSandboxBypass")) + request_sandbox_bypass_reason = from_union([from_none, from_str], obj.get("requestSandboxBypassReason")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) warning = from_union([from_none, from_str], obj.get("warning")) return PermissionRequestShell( @@ -3004,6 +5614,10 @@ def from_dict(obj: Any) -> "PermissionRequestShell": intention=intention, possible_paths=possible_paths, possible_urls=possible_urls, + command_segments=command_segments, + managed_approval_required=managed_approval_required, + request_sandbox_bypass=request_sandbox_bypass, + request_sandbox_bypass_reason=request_sandbox_bypass_reason, tool_call_id=tool_call_id, warning=warning, ) @@ -3018,6 +5632,14 @@ def to_dict(self) -> dict: result["kind"] = self.kind result["possiblePaths"] = from_list(from_str, self.possible_paths) result["possibleUrls"] = from_list(lambda x: to_class(PermissionRequestShellPossibleUrl, x), self.possible_urls) + if self.command_segments is not None: + result["commandSegments"] = from_union([from_none, lambda x: from_list(lambda x: to_class(PermissionRequestShellCommandSegment, x), x)], self.command_segments) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + if self.request_sandbox_bypass is not None: + result["requestSandboxBypass"] = from_union([from_none, from_bool], self.request_sandbox_bypass) + if self.request_sandbox_bypass_reason is not None: + result["requestSandboxBypassReason"] = from_union([from_none, from_str], self.request_sandbox_bypass_reason) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) if self.warning is not None: @@ -3027,7 +5649,7 @@ def to_dict(self) -> dict: @dataclass class PermissionRequestShellCommand: - "Schema for the `PermissionRequestShellCommand` type." + "A parsed command identifier in a shell permission request, including whether it is read-only." identifier: str read_only: bool @@ -3048,9 +5670,32 @@ def to_dict(self) -> dict: return result +@dataclass +class PermissionRequestShellCommandSegment: + "A parsed shell command segment used for argument-aware managed policy matching." + full_command_text: str + identifier: str + + @staticmethod + def from_dict(obj: Any) -> "PermissionRequestShellCommandSegment": + assert isinstance(obj, dict) + full_command_text = from_str(obj.get("fullCommandText")) + identifier = from_str(obj.get("identifier")) + return PermissionRequestShellCommandSegment( + full_command_text=full_command_text, + identifier=identifier, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["fullCommandText"] = from_str(self.full_command_text) + result["identifier"] = from_str(self.identifier) + return result + + @dataclass class PermissionRequestShellPossibleUrl: - "Schema for the `PermissionRequestShellPossibleUrl` type." + "A URL that may be accessed by a command in a shell permission request." url: str @staticmethod @@ -3073,6 +5718,10 @@ class PermissionRequestUrl: intention: str kind: ClassVar[str] = "url" url: str + managed_approval_required: bool | None = None + redirected_from: str | None = None + request_sandbox_bypass: bool | None = None + request_sandbox_bypass_reason: str | None = None tool_call_id: str | None = None @staticmethod @@ -3080,10 +5729,18 @@ def from_dict(obj: Any) -> "PermissionRequestUrl": assert isinstance(obj, dict) intention = from_str(obj.get("intention")) url = from_str(obj.get("url")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) + redirected_from = from_union([from_none, from_str], obj.get("redirectedFrom")) + request_sandbox_bypass = from_union([from_none, from_bool], obj.get("requestSandboxBypass")) + request_sandbox_bypass_reason = from_union([from_none, from_str], obj.get("requestSandboxBypassReason")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionRequestUrl( intention=intention, url=url, + managed_approval_required=managed_approval_required, + redirected_from=redirected_from, + request_sandbox_bypass=request_sandbox_bypass, + request_sandbox_bypass_reason=request_sandbox_bypass_reason, tool_call_id=tool_call_id, ) @@ -3092,6 +5749,14 @@ def to_dict(self) -> dict: result["intention"] = from_str(self.intention) result["kind"] = self.kind result["url"] = from_str(self.url) + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) + if self.redirected_from is not None: + result["redirectedFrom"] = from_union([from_none, from_str], self.redirected_from) + if self.request_sandbox_bypass is not None: + result["requestSandboxBypass"] = from_union([from_none, from_bool], self.request_sandbox_bypass) + if self.request_sandbox_bypass_reason is not None: + result["requestSandboxBypassReason"] = from_union([from_none, from_str], self.request_sandbox_bypass_reason) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -3105,7 +5770,10 @@ class PermissionRequestWrite: file_name: str intention: str kind: ClassVar[str] = "write" + managed_approval_required: bool | None = None new_file_contents: str | None = None + request_sandbox_bypass: bool | None = None + request_sandbox_bypass_reason: str | None = None tool_call_id: str | None = None @staticmethod @@ -3115,14 +5783,20 @@ def from_dict(obj: Any) -> "PermissionRequestWrite": diff = from_str(obj.get("diff")) file_name = from_str(obj.get("fileName")) intention = from_str(obj.get("intention")) + managed_approval_required = from_union([from_none, from_bool], obj.get("managedApprovalRequired")) new_file_contents = from_union([from_none, from_str], obj.get("newFileContents")) + request_sandbox_bypass = from_union([from_none, from_bool], obj.get("requestSandboxBypass")) + request_sandbox_bypass_reason = from_union([from_none, from_str], obj.get("requestSandboxBypassReason")) tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) return PermissionRequestWrite( can_offer_session_approval=can_offer_session_approval, diff=diff, file_name=file_name, intention=intention, + managed_approval_required=managed_approval_required, new_file_contents=new_file_contents, + request_sandbox_bypass=request_sandbox_bypass, + request_sandbox_bypass_reason=request_sandbox_bypass_reason, tool_call_id=tool_call_id, ) @@ -3133,8 +5807,14 @@ def to_dict(self) -> dict: result["fileName"] = from_str(self.file_name) result["intention"] = from_str(self.intention) result["kind"] = self.kind + if self.managed_approval_required is not None: + result["managedApprovalRequired"] = from_union([from_none, from_bool], self.managed_approval_required) if self.new_file_contents is not None: result["newFileContents"] = from_union([from_none, from_str], self.new_file_contents) + if self.request_sandbox_bypass is not None: + result["requestSandboxBypass"] = from_union([from_none, from_bool], self.request_sandbox_bypass) + if self.request_sandbox_bypass_reason is not None: + result["requestSandboxBypassReason"] = from_union([from_none, from_str], self.request_sandbox_bypass_reason) if self.tool_call_id is not None: result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @@ -3147,6 +5827,7 @@ class PermissionRequestedData: request_id: str prompt_request: PermissionPromptRequest | None = None resolved_by_hook: bool | None = None + risk_assessment: Any = None @staticmethod def from_dict(obj: Any) -> "PermissionRequestedData": @@ -3155,11 +5836,13 @@ def from_dict(obj: Any) -> "PermissionRequestedData": request_id = from_str(obj.get("requestId")) prompt_request = from_union([from_none, _load_PermissionPromptRequest], obj.get("promptRequest")) resolved_by_hook = from_union([from_none, from_bool], obj.get("resolvedByHook")) + risk_assessment = obj.get("riskAssessment") return PermissionRequestedData( permission_request=permission_request, request_id=request_id, prompt_request=prompt_request, resolved_by_hook=resolved_by_hook, + risk_assessment=risk_assessment, ) def to_dict(self) -> dict: @@ -3170,29 +5853,68 @@ def to_dict(self) -> dict: result["promptRequest"] = from_union([from_none, lambda x: x.to_dict()], self.prompt_request) if self.resolved_by_hook is not None: result["resolvedByHook"] = from_union([from_none, from_bool], self.resolved_by_hook) + if self.risk_assessment is not None: + result["riskAssessment"] = self.risk_assessment return result @dataclass class PermissionRule: - "Schema for the `PermissionRule` type." + "A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value." argument: str | None kind: str @staticmethod - def from_dict(obj: Any) -> "PermissionRule": + def from_dict(obj: Any) -> "PermissionRule": + assert isinstance(obj, dict) + argument = from_union([from_none, from_str], obj.get("argument")) + kind = from_str(obj.get("kind")) + return PermissionRule( + argument=argument, + kind=kind, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["argument"] = from_union([from_none, from_str], self.argument) + result["kind"] = from_str(self.kind) + return result + + +@dataclass +class PersistedBinaryImage: + "Binary result returned by a tool for the model" + data: str + mime_type: str + type: PersistedBinaryImageType + description: str | None = None + metadata: dict[str, Any] | None = None + + @staticmethod + def from_dict(obj: Any) -> "PersistedBinaryImage": assert isinstance(obj, dict) - argument = from_union([from_none, from_str], obj.get("argument")) - kind = from_str(obj.get("kind")) - return PermissionRule( - argument=argument, - kind=kind, + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + type = parse_enum(PersistedBinaryImageType, obj.get("type")) + description = from_union([from_none, from_str], obj.get("description")) + metadata = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("metadata")) + return PersistedBinaryImage( + data=data, + mime_type=mime_type, + type=type, + description=description, + metadata=metadata, ) def to_dict(self) -> dict: result: dict = {} - result["argument"] = from_union([from_none, from_str], self.argument) - result["kind"] = from_str(self.kind) + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = to_enum(PersistedBinaryImageType, self.type) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.metadata is not None: + result["metadata"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.metadata) return result @@ -3273,7 +5995,7 @@ def to_dict(self) -> dict: @dataclass class SessionBackgroundTasksChangedData: - "Schema for the `BackgroundTasksChangedData` type." + "Empty payload for `session.background_tasks_changed`, indicating background task state changed." @staticmethod def from_dict(obj: Any) -> "SessionBackgroundTasksChangedData": assert isinstance(obj, dict) @@ -3284,81 +6006,47 @@ def to_dict(self) -> dict: @dataclass -class SessionCanvasOpenedData: - "Schema for the `CanvasOpenedData` type." - availability: CanvasOpenedAvailability - canvas_id: str - extension_id: str - instance_id: str - reopen: bool - extension_name: str | None = None - input: Any = None - status: str | None = None - title: str | None = None - url: str | None = None - - @staticmethod - def from_dict(obj: Any) -> "SessionCanvasOpenedData": - assert isinstance(obj, dict) - availability = parse_enum(CanvasOpenedAvailability, obj.get("availability")) - canvas_id = from_str(obj.get("canvasId")) - extension_id = from_str(obj.get("extensionId")) - instance_id = from_str(obj.get("instanceId")) - reopen = from_bool(obj.get("reopen")) - extension_name = from_union([from_none, from_str], obj.get("extensionName")) - input = obj.get("input") - status = from_union([from_none, from_str], obj.get("status")) - title = from_union([from_none, from_str], obj.get("title")) - url = from_union([from_none, from_str], obj.get("url")) - return SessionCanvasOpenedData( - availability=availability, - canvas_id=canvas_id, - extension_id=extension_id, - instance_id=instance_id, - reopen=reopen, - extension_name=extension_name, - input=input, - status=status, - title=title, - url=url, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["availability"] = to_enum(CanvasOpenedAvailability, self.availability) - result["canvasId"] = from_str(self.canvas_id) - result["extensionId"] = from_str(self.extension_id) - result["instanceId"] = from_str(self.instance_id) - result["reopen"] = from_bool(self.reopen) - if self.extension_name is not None: - result["extensionName"] = from_union([from_none, from_str], self.extension_name) - if self.input is not None: - result["input"] = self.input - if self.status is not None: - result["status"] = from_union([from_none, from_str], self.status) - if self.title is not None: - result["title"] = from_union([from_none, from_str], self.title) - if self.url is not None: - result["url"] = from_union([from_none, from_str], self.url) - return result - - -@dataclass -class SessionCanvasRegistryChangedData: - "Schema for the `CanvasRegistryChangedData` type." - canvases: list[CanvasRegistryChangedCanvas] +class SessionBinaryAssetData: + "Canonical bytes for a content-addressed binary asset shared by reference across events" + asset_id: str + byte_length: int + data: str + mime_type: str + type: BinaryAssetType + description: str | None = None + metadata: dict[str, Any] | None = None @staticmethod - def from_dict(obj: Any) -> "SessionCanvasRegistryChangedData": + def from_dict(obj: Any) -> "SessionBinaryAssetData": assert isinstance(obj, dict) - canvases = from_list(CanvasRegistryChangedCanvas.from_dict, obj.get("canvases")) - return SessionCanvasRegistryChangedData( - canvases=canvases, + asset_id = from_str(obj.get("assetId")) + byte_length = from_int(obj.get("byteLength")) + data = from_str(obj.get("data")) + mime_type = from_str(obj.get("mimeType")) + type = parse_enum(BinaryAssetType, obj.get("type")) + description = from_union([from_none, from_str], obj.get("description")) + metadata = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("metadata")) + return SessionBinaryAssetData( + asset_id=asset_id, + byte_length=byte_length, + data=data, + mime_type=mime_type, + type=type, + description=description, + metadata=metadata, ) def to_dict(self) -> dict: result: dict = {} - result["canvases"] = from_list(lambda x: to_class(CanvasRegistryChangedCanvas, x), self.canvases) + result["assetId"] = from_str(self.asset_id) + result["byteLength"] = to_int(self.byte_length) + result["data"] = from_str(self.data) + result["mimeType"] = from_str(self.mime_type) + result["type"] = to_enum(BinaryAssetType, self.type) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) + if self.metadata is not None: + result["metadata"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.metadata) return result @@ -3378,10 +6066,13 @@ class SessionCompactionCompleteData: pre_compaction_tokens: int | None = None request_id: str | None = None service_request_id: str | None = None + status_code: int | None = None summary_content: str | None = None system_tokens: int | None = None + token_limit: int | None = None tokens_removed: int | None = None tool_definitions_tokens: int | None = None + trigger: CompactionTrigger | None = None @staticmethod def from_dict(obj: Any) -> "SessionCompactionCompleteData": @@ -3399,10 +6090,13 @@ def from_dict(obj: Any) -> "SessionCompactionCompleteData": pre_compaction_tokens = from_union([from_none, from_int], obj.get("preCompactionTokens")) request_id = from_union([from_none, from_str], obj.get("requestId")) service_request_id = from_union([from_none, from_str], obj.get("serviceRequestId")) + status_code = from_union([from_none, from_int], obj.get("statusCode")) summary_content = from_union([from_none, from_str], obj.get("summaryContent")) system_tokens = from_union([from_none, from_int], obj.get("systemTokens")) + token_limit = from_union([from_none, from_int], obj.get("tokenLimit")) tokens_removed = from_union([from_none, from_int], obj.get("tokensRemoved")) tool_definitions_tokens = from_union([from_none, from_int], obj.get("toolDefinitionsTokens")) + trigger = from_union([from_none, lambda x: parse_enum(CompactionTrigger, x)], obj.get("trigger")) return SessionCompactionCompleteData( success=success, checkpoint_number=checkpoint_number, @@ -3417,10 +6111,13 @@ def from_dict(obj: Any) -> "SessionCompactionCompleteData": pre_compaction_tokens=pre_compaction_tokens, request_id=request_id, service_request_id=service_request_id, + status_code=status_code, summary_content=summary_content, system_tokens=system_tokens, + token_limit=token_limit, tokens_removed=tokens_removed, tool_definitions_tokens=tool_definitions_tokens, + trigger=trigger, ) def to_dict(self) -> dict: @@ -3450,14 +6147,20 @@ def to_dict(self) -> dict: result["requestId"] = from_union([from_none, from_str], self.request_id) if self.service_request_id is not None: result["serviceRequestId"] = from_union([from_none, from_str], self.service_request_id) + if self.status_code is not None: + result["statusCode"] = from_union([from_none, to_int], self.status_code) if self.summary_content is not None: result["summaryContent"] = from_union([from_none, from_str], self.summary_content) if self.system_tokens is not None: result["systemTokens"] = from_union([from_none, to_int], self.system_tokens) + if self.token_limit is not None: + result["tokenLimit"] = from_union([from_none, to_int], self.token_limit) if self.tokens_removed is not None: result["tokensRemoved"] = from_union([from_none, to_int], self.tokens_removed) if self.tool_definitions_tokens is not None: result["toolDefinitionsTokens"] = from_union([from_none, to_int], self.tool_definitions_tokens) + if self.trigger is not None: + result["trigger"] = from_union([from_none, lambda x: to_enum(CompactionTrigger, x)], self.trigger) return result @@ -3465,29 +6168,49 @@ def to_dict(self) -> dict: class SessionCompactionStartData: "Context window breakdown at the start of LLM-powered conversation compaction" conversation_tokens: int | None = None + current_tokens: int | None = None + model: str | None = None system_tokens: int | None = None + token_limit: int | None = None tool_definitions_tokens: int | None = None + trigger: CompactionTrigger | None = None @staticmethod def from_dict(obj: Any) -> "SessionCompactionStartData": assert isinstance(obj, dict) conversation_tokens = from_union([from_none, from_int], obj.get("conversationTokens")) + current_tokens = from_union([from_none, from_int], obj.get("currentTokens")) + model = from_union([from_none, from_str], obj.get("model")) system_tokens = from_union([from_none, from_int], obj.get("systemTokens")) + token_limit = from_union([from_none, from_int], obj.get("tokenLimit")) tool_definitions_tokens = from_union([from_none, from_int], obj.get("toolDefinitionsTokens")) + trigger = from_union([from_none, lambda x: parse_enum(CompactionTrigger, x)], obj.get("trigger")) return SessionCompactionStartData( conversation_tokens=conversation_tokens, + current_tokens=current_tokens, + model=model, system_tokens=system_tokens, + token_limit=token_limit, tool_definitions_tokens=tool_definitions_tokens, + trigger=trigger, ) def to_dict(self) -> dict: result: dict = {} if self.conversation_tokens is not None: result["conversationTokens"] = from_union([from_none, to_int], self.conversation_tokens) + if self.current_tokens is not None: + result["currentTokens"] = from_union([from_none, to_int], self.current_tokens) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) if self.system_tokens is not None: result["systemTokens"] = from_union([from_none, to_int], self.system_tokens) + if self.token_limit is not None: + result["tokenLimit"] = from_union([from_none, to_int], self.token_limit) if self.tool_definitions_tokens is not None: result["toolDefinitionsTokens"] = from_union([from_none, to_int], self.tool_definitions_tokens) + if self.trigger is not None: + result["trigger"] = from_union([from_none, lambda x: to_enum(CompactionTrigger, x)], self.trigger) return result @@ -3500,6 +6223,7 @@ class SessionContextChangedData: git_root: str | None = None head_commit: str | None = None host_type: WorkingDirectoryContextHostType | None = None + pending_git_context: bool | None = None repository: str | None = None repository_host: str | None = None @@ -3512,6 +6236,7 @@ def from_dict(obj: Any) -> "SessionContextChangedData": git_root = from_union([from_none, from_str], obj.get("gitRoot")) head_commit = from_union([from_none, from_str], obj.get("headCommit")) host_type = from_union([from_none, lambda x: parse_enum(WorkingDirectoryContextHostType, x)], obj.get("hostType")) + pending_git_context = from_union([from_none, from_bool], obj.get("pendingGitContext")) repository = from_union([from_none, from_str], obj.get("repository")) repository_host = from_union([from_none, from_str], obj.get("repositoryHost")) return SessionContextChangedData( @@ -3521,6 +6246,7 @@ def from_dict(obj: Any) -> "SessionContextChangedData": git_root=git_root, head_commit=head_commit, host_type=host_type, + pending_git_context=pending_git_context, repository=repository, repository_host=repository_host, ) @@ -3538,6 +6264,8 @@ def to_dict(self) -> dict: result["headCommit"] = from_union([from_none, from_str], self.head_commit) if self.host_type is not None: result["hostType"] = from_union([from_none, lambda x: to_enum(WorkingDirectoryContextHostType, x)], self.host_type) + if self.pending_git_context is not None: + result["pendingGitContext"] = from_union([from_none, from_bool], self.pending_git_context) if self.repository is not None: result["repository"] = from_union([from_none, from_str], self.repository) if self.repository_host is not None: @@ -3545,9 +6273,33 @@ def to_dict(self) -> dict: return result +@dataclass +class SessionContextClearedData: + "Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages)" + messages_cleared: int + initial_message: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionContextClearedData": + assert isinstance(obj, dict) + messages_cleared = from_int(obj.get("messagesCleared")) + initial_message = from_union([from_none, from_str], obj.get("initialMessage")) + return SessionContextClearedData( + messages_cleared=messages_cleared, + initial_message=initial_message, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["messagesCleared"] = to_int(self.messages_cleared) + if self.initial_message is not None: + result["initialMessage"] = from_union([from_none, from_str], self.initial_message) + return result + + @dataclass class SessionCustomAgentsUpdatedData: - "Schema for the `CustomAgentsUpdatedData` type." + "Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors." agents: list[CustomAgentsUpdatedAgent] errors: list[str] warnings: list[str] @@ -3667,9 +6419,28 @@ def to_dict(self) -> dict: return result +@dataclass +class SessionExtensionsAttachmentsPushedData: + "Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send." + attachments: list[Attachment] + + @staticmethod + def from_dict(obj: Any) -> "SessionExtensionsAttachmentsPushedData": + assert isinstance(obj, dict) + attachments = from_list(_load_Attachment, obj.get("attachments")) + return SessionExtensionsAttachmentsPushedData( + attachments=attachments, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["attachments"] = from_list(lambda x: x.to_dict(), self.attachments) + return result + + @dataclass class SessionExtensionsLoadedData: - "Schema for the `ExtensionsLoadedData` type." + "Payload of `session.extensions_loaded` listing discovered extensions and their statuses." extensions: list[ExtensionsLoadedExtension] @staticmethod @@ -3736,7 +6507,7 @@ def to_dict(self) -> dict: @dataclass class SessionIdleData: - "Payload indicating the session is idle with no background agents in flight" + "Payload indicating the session is idle with no background agents or attached shell commands in flight" aborted: bool | None = None @staticmethod @@ -3787,9 +6558,108 @@ def to_dict(self) -> dict: return result +@dataclass +class SessionLimitsConfig: + "Optional session limits." + max_ai_credits: float | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionLimitsConfig": + assert isinstance(obj, dict) + max_ai_credits = from_union([from_none, from_float], obj.get("maxAiCredits")) + return SessionLimitsConfig( + max_ai_credits=max_ai_credits, + ) + + def to_dict(self) -> dict: + result: dict = {} + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([from_none, to_float], self.max_ai_credits) + return result + + +@dataclass +class SessionLimitsExhaustedCompletedData: + "Session limit exhaustion prompt completion notification." + request_id: str + response: SessionLimitsExhaustedResponse + + @staticmethod + def from_dict(obj: Any) -> "SessionLimitsExhaustedCompletedData": + assert isinstance(obj, dict) + request_id = from_str(obj.get("requestId")) + response = SessionLimitsExhaustedResponse.from_dict(obj.get("response")) + return SessionLimitsExhaustedCompletedData( + request_id=request_id, + response=response, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["requestId"] = from_str(self.request_id) + result["response"] = to_class(SessionLimitsExhaustedResponse, self.response) + return result + + +@dataclass +class SessionLimitsExhaustedRequestedData: + "Session limit exhaustion notification requiring user action." + max_ai_credits: float + request_id: str + used_ai_credits: float + + @staticmethod + def from_dict(obj: Any) -> "SessionLimitsExhaustedRequestedData": + assert isinstance(obj, dict) + max_ai_credits = from_float(obj.get("maxAiCredits")) + request_id = from_str(obj.get("requestId")) + used_ai_credits = from_float(obj.get("usedAiCredits")) + return SessionLimitsExhaustedRequestedData( + max_ai_credits=max_ai_credits, + request_id=request_id, + used_ai_credits=used_ai_credits, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["maxAiCredits"] = to_float(self.max_ai_credits) + result["requestId"] = from_str(self.request_id) + result["usedAiCredits"] = to_float(self.used_ai_credits) + return result + + +@dataclass +class SessionLimitsExhaustedResponse: + "The user's selected action for an exhausted session limit." + action: SessionLimitsExhaustedResponseAction + additional_ai_credits: float | None = None + max_ai_credits: float | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionLimitsExhaustedResponse": + assert isinstance(obj, dict) + action = parse_enum(SessionLimitsExhaustedResponseAction, obj.get("action")) + additional_ai_credits = from_union([from_none, from_float], obj.get("additionalAiCredits")) + max_ai_credits = from_union([from_none, from_float], obj.get("maxAiCredits")) + return SessionLimitsExhaustedResponse( + action=action, + additional_ai_credits=additional_ai_credits, + max_ai_credits=max_ai_credits, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["action"] = to_enum(SessionLimitsExhaustedResponseAction, self.action) + if self.additional_ai_credits is not None: + result["additionalAiCredits"] = from_union([from_none, to_float], self.additional_ai_credits) + if self.max_ai_credits is not None: + result["maxAiCredits"] = from_union([from_none, to_float], self.max_ai_credits) + return result + + @dataclass class SessionMcpServerStatusChangedData: - "Schema for the `McpServerStatusChangedData` type." + "Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error." server_name: str status: McpServerStatus error: str | None = None @@ -3817,7 +6687,7 @@ def to_dict(self) -> dict: @dataclass class SessionMcpServersLoadedData: - "Schema for the `McpServersLoadedData` type." + "Payload of `session.mcp_servers_loaded` listing MCP server status summaries." servers: list[McpServersLoadedServer] @staticmethod @@ -3862,24 +6732,28 @@ class SessionModelChangeData: "Model change details including previous and new model identifiers" new_model: str cause: str | None = None - context_tier: SessionModelChangeDataContextTier | None = None + context_tier: ContextTier | None = None previous_model: str | None = None previous_reasoning_effort: str | None = None previous_reasoning_summary: ReasoningSummary | None = None + previous_verbosity: Verbosity | None = None reasoning_effort: str | None = None reasoning_summary: ReasoningSummary | None = None + verbosity: Verbosity | None = None @staticmethod def from_dict(obj: Any) -> "SessionModelChangeData": assert isinstance(obj, dict) new_model = from_str(obj.get("newModel")) cause = from_union([from_none, from_str], obj.get("cause")) - context_tier = from_union([from_none, lambda x: parse_enum(SessionModelChangeDataContextTier, x)], obj.get("contextTier")) + context_tier = from_union([from_none, lambda x: parse_enum(ContextTier, x)], obj.get("contextTier")) previous_model = from_union([from_none, from_str], obj.get("previousModel")) previous_reasoning_effort = from_union([from_none, from_str], obj.get("previousReasoningEffort")) previous_reasoning_summary = from_union([from_none, lambda x: parse_enum(ReasoningSummary, x)], obj.get("previousReasoningSummary")) + previous_verbosity = from_union([from_none, lambda x: parse_enum(Verbosity, x)], obj.get("previousVerbosity")) reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) reasoning_summary = from_union([from_none, lambda x: parse_enum(ReasoningSummary, x)], obj.get("reasoningSummary")) + verbosity = from_union([from_none, lambda x: parse_enum(Verbosity, x)], obj.get("verbosity")) return SessionModelChangeData( new_model=new_model, cause=cause, @@ -3887,8 +6761,10 @@ def from_dict(obj: Any) -> "SessionModelChangeData": previous_model=previous_model, previous_reasoning_effort=previous_reasoning_effort, previous_reasoning_summary=previous_reasoning_summary, + previous_verbosity=previous_verbosity, reasoning_effort=reasoning_effort, reasoning_summary=reasoning_summary, + verbosity=verbosity, ) def to_dict(self) -> dict: @@ -3897,40 +6773,56 @@ def to_dict(self) -> dict: if self.cause is not None: result["cause"] = from_union([from_none, from_str], self.cause) if self.context_tier is not None: - result["contextTier"] = from_union([from_none, lambda x: to_enum(SessionModelChangeDataContextTier, x)], self.context_tier) + result["contextTier"] = from_union([from_none, lambda x: to_enum(ContextTier, x)], self.context_tier) if self.previous_model is not None: result["previousModel"] = from_union([from_none, from_str], self.previous_model) if self.previous_reasoning_effort is not None: result["previousReasoningEffort"] = from_union([from_none, from_str], self.previous_reasoning_effort) if self.previous_reasoning_summary is not None: result["previousReasoningSummary"] = from_union([from_none, lambda x: to_enum(ReasoningSummary, x)], self.previous_reasoning_summary) + if self.previous_verbosity is not None: + result["previousVerbosity"] = from_union([from_none, lambda x: to_enum(Verbosity, x)], self.previous_verbosity) if self.reasoning_effort is not None: result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) if self.reasoning_summary is not None: result["reasoningSummary"] = from_union([from_none, lambda x: to_enum(ReasoningSummary, x)], self.reasoning_summary) + if self.verbosity is not None: + result["verbosity"] = from_union([from_none, lambda x: to_enum(Verbosity, x)], self.verbosity) return result @dataclass class SessionPermissionsChangedData: - "Permissions change details carrying the aggregate allow-all boolean transition." + "Permissions change details carrying the aggregate allow-all transition." allow_all_permissions: bool previous_allow_all_permissions: bool + # Experimental: this field is part of an experimental API and may change or be removed. + allow_all_permission_mode: PermissionAllowAllMode | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + previous_allow_all_permission_mode: PermissionAllowAllMode | None = None @staticmethod def from_dict(obj: Any) -> "SessionPermissionsChangedData": assert isinstance(obj, dict) allow_all_permissions = from_bool(obj.get("allowAllPermissions")) previous_allow_all_permissions = from_bool(obj.get("previousAllowAllPermissions")) + allow_all_permission_mode = from_union([from_none, lambda x: parse_enum(PermissionAllowAllMode, x)], obj.get("allowAllPermissionMode")) + previous_allow_all_permission_mode = from_union([from_none, lambda x: parse_enum(PermissionAllowAllMode, x)], obj.get("previousAllowAllPermissionMode")) return SessionPermissionsChangedData( allow_all_permissions=allow_all_permissions, previous_allow_all_permissions=previous_allow_all_permissions, + allow_all_permission_mode=allow_all_permission_mode, + previous_allow_all_permission_mode=previous_allow_all_permission_mode, ) def to_dict(self) -> dict: result: dict = {} result["allowAllPermissions"] = from_bool(self.allow_all_permissions) result["previousAllowAllPermissions"] = from_bool(self.previous_allow_all_permissions) + if self.allow_all_permission_mode is not None: + result["allowAllPermissionMode"] = from_union([from_none, lambda x: to_enum(PermissionAllowAllMode, x)], self.allow_all_permission_mode) + if self.previous_allow_all_permission_mode is not None: + result["previousAllowAllPermissionMode"] = from_union([from_none, lambda x: to_enum(PermissionAllowAllMode, x)], self.previous_allow_all_permission_mode) return result @@ -3979,13 +6871,16 @@ class SessionResumeData: resume_time: datetime already_in_use: bool | None = None context: WorkingDirectoryContext | None = None - context_tier: SessionResumeDataContextTier | None = None + context_tier: ContextTier | None = None continue_pending_work: bool | None = None + events_file_size_bytes: int | None = None reasoning_effort: str | None = None reasoning_summary: ReasoningSummary | None = None remote_steerable: bool | None = None selected_model: str | None = None + session_limits: SessionLimitsConfig | None = None session_was_active: bool | None = None + verbosity: Verbosity | None = None @staticmethod def from_dict(obj: Any) -> "SessionResumeData": @@ -3994,13 +6889,16 @@ def from_dict(obj: Any) -> "SessionResumeData": resume_time = from_datetime(obj.get("resumeTime")) already_in_use = from_union([from_none, from_bool], obj.get("alreadyInUse")) context = from_union([from_none, WorkingDirectoryContext.from_dict], obj.get("context")) - context_tier = from_union([from_none, lambda x: parse_enum(SessionResumeDataContextTier, x)], obj.get("contextTier")) + context_tier = from_union([from_none, lambda x: parse_enum(ContextTier, x)], obj.get("contextTier")) continue_pending_work = from_union([from_none, from_bool], obj.get("continuePendingWork")) + events_file_size_bytes = from_union([from_none, from_int], obj.get("eventsFileSizeBytes")) reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) reasoning_summary = from_union([from_none, lambda x: parse_enum(ReasoningSummary, x)], obj.get("reasoningSummary")) remote_steerable = from_union([from_none, from_bool], obj.get("remoteSteerable")) selected_model = from_union([from_none, from_str], obj.get("selectedModel")) + session_limits = from_union([from_none, SessionLimitsConfig.from_dict], obj.get("sessionLimits")) session_was_active = from_union([from_none, from_bool], obj.get("sessionWasActive")) + verbosity = from_union([from_none, lambda x: parse_enum(Verbosity, x)], obj.get("verbosity")) return SessionResumeData( event_count=event_count, resume_time=resume_time, @@ -4008,11 +6906,14 @@ def from_dict(obj: Any) -> "SessionResumeData": context=context, context_tier=context_tier, continue_pending_work=continue_pending_work, + events_file_size_bytes=events_file_size_bytes, reasoning_effort=reasoning_effort, reasoning_summary=reasoning_summary, remote_steerable=remote_steerable, selected_model=selected_model, + session_limits=session_limits, session_was_active=session_was_active, + verbosity=verbosity, ) def to_dict(self) -> dict: @@ -4024,9 +6925,11 @@ def to_dict(self) -> dict: if self.context is not None: result["context"] = from_union([from_none, lambda x: to_class(WorkingDirectoryContext, x)], self.context) if self.context_tier is not None: - result["contextTier"] = from_union([from_none, lambda x: to_enum(SessionResumeDataContextTier, x)], self.context_tier) + result["contextTier"] = from_union([from_none, lambda x: to_enum(ContextTier, x)], self.context_tier) if self.continue_pending_work is not None: result["continuePendingWork"] = from_union([from_none, from_bool], self.continue_pending_work) + if self.events_file_size_bytes is not None: + result["eventsFileSizeBytes"] = from_union([from_none, to_int], self.events_file_size_bytes) if self.reasoning_effort is not None: result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) if self.reasoning_summary is not None: @@ -4035,8 +6938,12 @@ def to_dict(self) -> dict: result["remoteSteerable"] = from_union([from_none, from_bool], self.remote_steerable) if self.selected_model is not None: result["selectedModel"] = from_union([from_none, from_str], self.selected_model) + if self.session_limits is not None: + result["sessionLimits"] = from_union([from_none, lambda x: to_class(SessionLimitsConfig, x)], self.session_limits) if self.session_was_active is not None: result["sessionWasActive"] = from_union([from_none, from_bool], self.session_was_active) + if self.verbosity is not None: + result["verbosity"] = from_union([from_none, lambda x: to_enum(Verbosity, x)], self.verbosity) return result @@ -4063,36 +6970,104 @@ def to_dict(self) -> dict: class SessionScheduleCreatedData: "Scheduled prompt registered via /every or /after" id: int - interval: timedelta prompt: str + at: int | None = None + cron: str | None = None display_prompt: str | None = None + interval: timedelta | None = None + origin: ScheduleOrigin | None = None recurring: bool | None = None + self_paced: bool | None = None + tz: str | None = None @staticmethod def from_dict(obj: Any) -> "SessionScheduleCreatedData": assert isinstance(obj, dict) id = from_int(obj.get("id")) - interval = from_timedelta(obj.get("intervalMs")) prompt = from_str(obj.get("prompt")) + at = from_union([from_none, from_int], obj.get("at")) + cron = from_union([from_none, from_str], obj.get("cron")) display_prompt = from_union([from_none, from_str], obj.get("displayPrompt")) + interval = from_union([from_none, from_timedelta], obj.get("intervalMs")) + origin = from_union([from_none, lambda x: parse_enum(ScheduleOrigin, x)], obj.get("origin")) recurring = from_union([from_none, from_bool], obj.get("recurring")) + self_paced = from_union([from_none, from_bool], obj.get("selfPaced")) + tz = from_union([from_none, from_str], obj.get("tz")) return SessionScheduleCreatedData( id=id, - interval=interval, prompt=prompt, + at=at, + cron=cron, display_prompt=display_prompt, + interval=interval, + origin=origin, recurring=recurring, + self_paced=self_paced, + tz=tz, ) def to_dict(self) -> dict: result: dict = {} result["id"] = to_int(self.id) - result["intervalMs"] = to_timedelta_int(self.interval) result["prompt"] = from_str(self.prompt) + if self.at is not None: + result["at"] = from_union([from_none, to_int], self.at) + if self.cron is not None: + result["cron"] = from_union([from_none, from_str], self.cron) if self.display_prompt is not None: result["displayPrompt"] = from_union([from_none, from_str], self.display_prompt) + if self.interval is not None: + result["intervalMs"] = from_union([from_none, to_timedelta_int], self.interval) + if self.origin is not None: + result["origin"] = from_union([from_none, lambda x: to_enum(ScheduleOrigin, x)], self.origin) if self.recurring is not None: result["recurring"] = from_union([from_none, from_bool], self.recurring) + if self.self_paced is not None: + result["selfPaced"] = from_union([from_none, from_bool], self.self_paced) + if self.tz is not None: + result["tz"] = from_union([from_none, from_str], self.tz) + return result + + +@dataclass +class SessionScheduleRearmedData: + "Self-paced schedule re-armed for its next run" + id: int + next_run_at: int + + @staticmethod + def from_dict(obj: Any) -> "SessionScheduleRearmedData": + assert isinstance(obj, dict) + id = from_int(obj.get("id")) + next_run_at = from_int(obj.get("nextRunAt")) + return SessionScheduleRearmedData( + id=id, + next_run_at=next_run_at, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["id"] = to_int(self.id) + result["nextRunAt"] = to_int(self.next_run_at) + return result + + +@dataclass +class SessionSessionLimitsChangedData: + "Session limits update details. Null clears the limits." + session_limits: SessionLimitsConfig | None + + @staticmethod + def from_dict(obj: Any) -> "SessionSessionLimitsChangedData": + assert isinstance(obj, dict) + session_limits = from_union([from_none, SessionLimitsConfig.from_dict], obj.get("sessionLimits")) + return SessionSessionLimitsChangedData( + session_limits=session_limits, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["sessionLimits"] = from_union([from_none, lambda x: to_class(SessionLimitsConfig, x)], self.session_limits) return result @@ -4108,6 +7083,7 @@ class SessionShutdownData: current_model: str | None = None current_tokens: int | None = None error_reason: str | None = None + events_file_size_bytes: int | None = None system_tokens: int | None = None token_details: dict[str, ShutdownTokenDetail] | None = None tool_definitions_tokens: int | None = None @@ -4128,6 +7104,7 @@ def from_dict(obj: Any) -> "SessionShutdownData": current_model = from_union([from_none, from_str], obj.get("currentModel")) current_tokens = from_union([from_none, from_int], obj.get("currentTokens")) error_reason = from_union([from_none, from_str], obj.get("errorReason")) + events_file_size_bytes = from_union([from_none, from_int], obj.get("eventsFileSizeBytes")) system_tokens = from_union([from_none, from_int], obj.get("systemTokens")) token_details = from_union([from_none, lambda x: from_dict(ShutdownTokenDetail.from_dict, x)], obj.get("tokenDetails")) tool_definitions_tokens = from_union([from_none, from_int], obj.get("toolDefinitionsTokens")) @@ -4143,6 +7120,7 @@ def from_dict(obj: Any) -> "SessionShutdownData": current_model=current_model, current_tokens=current_tokens, error_reason=error_reason, + events_file_size_bytes=events_file_size_bytes, system_tokens=system_tokens, token_details=token_details, tool_definitions_tokens=tool_definitions_tokens, @@ -4165,6 +7143,8 @@ def to_dict(self) -> dict: result["currentTokens"] = from_union([from_none, to_int], self.current_tokens) if self.error_reason is not None: result["errorReason"] = from_union([from_none, from_str], self.error_reason) + if self.events_file_size_bytes is not None: + result["eventsFileSizeBytes"] = from_union([from_none, to_int], self.events_file_size_bytes) if self.system_tokens is not None: result["systemTokens"] = from_union([from_none, to_int], self.system_tokens) if self.token_details is not None: @@ -4180,7 +7160,7 @@ def to_dict(self) -> dict: @dataclass class SessionSkillsLoadedData: - "Schema for the `SkillsLoadedData` type." + "Payload of `session.skills_loaded` listing resolved skill metadata." skills: list[SkillsLoadedSkill] @staticmethod @@ -4230,12 +7210,15 @@ class SessionStartData: version: int already_in_use: bool | None = None context: WorkingDirectoryContext | None = None - context_tier: SessionStartDataContextTier | None = None + context_tier: ContextTier | None = None detached_from_spawning_parent_session_id: str | None = None + github_mcp_tool_config: GitHubMcpToolConfig | None = None reasoning_effort: str | None = None reasoning_summary: ReasoningSummary | None = None remote_steerable: bool | None = None selected_model: str | None = None + session_limits: SessionLimitsConfig | None = None + verbosity: Verbosity | None = None @staticmethod def from_dict(obj: Any) -> "SessionStartData": @@ -4247,12 +7230,15 @@ def from_dict(obj: Any) -> "SessionStartData": version = from_int(obj.get("version")) already_in_use = from_union([from_none, from_bool], obj.get("alreadyInUse")) context = from_union([from_none, WorkingDirectoryContext.from_dict], obj.get("context")) - context_tier = from_union([from_none, lambda x: parse_enum(SessionStartDataContextTier, x)], obj.get("contextTier")) + context_tier = from_union([from_none, lambda x: parse_enum(ContextTier, x)], obj.get("contextTier")) detached_from_spawning_parent_session_id = from_union([from_none, from_str], obj.get("detachedFromSpawningParentSessionId")) + github_mcp_tool_config = from_union([from_none, GitHubMcpToolConfig.from_dict], obj.get("githubMcpToolConfig")) reasoning_effort = from_union([from_none, from_str], obj.get("reasoningEffort")) reasoning_summary = from_union([from_none, lambda x: parse_enum(ReasoningSummary, x)], obj.get("reasoningSummary")) remote_steerable = from_union([from_none, from_bool], obj.get("remoteSteerable")) selected_model = from_union([from_none, from_str], obj.get("selectedModel")) + session_limits = from_union([from_none, SessionLimitsConfig.from_dict], obj.get("sessionLimits")) + verbosity = from_union([from_none, lambda x: parse_enum(Verbosity, x)], obj.get("verbosity")) return SessionStartData( copilot_version=copilot_version, producer=producer, @@ -4263,10 +7249,13 @@ def from_dict(obj: Any) -> "SessionStartData": context=context, context_tier=context_tier, detached_from_spawning_parent_session_id=detached_from_spawning_parent_session_id, + github_mcp_tool_config=github_mcp_tool_config, reasoning_effort=reasoning_effort, reasoning_summary=reasoning_summary, remote_steerable=remote_steerable, selected_model=selected_model, + session_limits=session_limits, + verbosity=verbosity, ) def to_dict(self) -> dict: @@ -4281,9 +7270,11 @@ def to_dict(self) -> dict: if self.context is not None: result["context"] = from_union([from_none, lambda x: to_class(WorkingDirectoryContext, x)], self.context) if self.context_tier is not None: - result["contextTier"] = from_union([from_none, lambda x: to_enum(SessionStartDataContextTier, x)], self.context_tier) + result["contextTier"] = from_union([from_none, lambda x: to_enum(ContextTier, x)], self.context_tier) if self.detached_from_spawning_parent_session_id is not None: result["detachedFromSpawningParentSessionId"] = from_union([from_none, from_str], self.detached_from_spawning_parent_session_id) + if self.github_mcp_tool_config is not None: + result["githubMcpToolConfig"] = from_union([from_none, lambda x: to_class(GitHubMcpToolConfig, x)], self.github_mcp_tool_config) if self.reasoning_effort is not None: result["reasoningEffort"] = from_union([from_none, from_str], self.reasoning_effort) if self.reasoning_summary is not None: @@ -4292,27 +7283,46 @@ def to_dict(self) -> dict: result["remoteSteerable"] = from_union([from_none, from_bool], self.remote_steerable) if self.selected_model is not None: result["selectedModel"] = from_union([from_none, from_str], self.selected_model) + if self.session_limits is not None: + result["sessionLimits"] = from_union([from_none, lambda x: to_class(SessionLimitsConfig, x)], self.session_limits) + if self.verbosity is not None: + result["verbosity"] = from_union([from_none, lambda x: to_enum(Verbosity, x)], self.verbosity) return result @dataclass class SessionTaskCompleteData: "Task completion notification with summary from the agent" + objective_id: int | None = None + outcome: TaskCompletionOutcome | None = None + reason: str | None = None success: bool | None = None summary: str | None = None @staticmethod def from_dict(obj: Any) -> "SessionTaskCompleteData": assert isinstance(obj, dict) + objective_id = from_union([from_none, from_int], obj.get("objectiveId")) + outcome = from_union([from_none, lambda x: parse_enum(TaskCompletionOutcome, x)], obj.get("outcome")) + reason = from_union([from_none, from_str], obj.get("reason")) success = from_union([from_none, from_bool], obj.get("success")) summary = from_union([from_none, from_str], obj.get("summary")) return SessionTaskCompleteData( + objective_id=objective_id, + outcome=outcome, + reason=reason, success=success, summary=summary, ) def to_dict(self) -> dict: result: dict = {} + if self.objective_id is not None: + result["objectiveId"] = from_union([from_none, to_int], self.objective_id) + if self.outcome is not None: + result["outcome"] = from_union([from_none, lambda x: to_enum(TaskCompletionOutcome, x)], self.outcome) + if self.reason is not None: + result["reason"] = from_union([from_none, from_str], self.reason) if self.success is not None: result["success"] = from_union([from_none, from_bool], self.success) if self.summary is not None: @@ -4339,9 +7349,21 @@ def to_dict(self) -> dict: return result +@dataclass +class SessionTodosChangedData: + "Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed." + @staticmethod + def from_dict(obj: Any) -> "SessionTodosChangedData": + assert isinstance(obj, dict) + return SessionTodosChangedData() + + def to_dict(self) -> dict: + return {} + + @dataclass class SessionToolsUpdatedData: - "Schema for the `ToolsUpdatedData` type." + "Payload of `session.tools_updated` identifying the model whose resolved tools were updated." model: str @staticmethod @@ -4394,14 +7416,45 @@ def from_dict(obj: Any) -> "SessionTruncationData": def to_dict(self) -> dict: result: dict = {} - result["messagesRemovedDuringTruncation"] = to_int(self.messages_removed_during_truncation) - result["performedBy"] = from_str(self.performed_by) - result["postTruncationMessagesLength"] = to_int(self.post_truncation_messages_length) - result["postTruncationTokensInMessages"] = to_int(self.post_truncation_tokens_in_messages) - result["preTruncationMessagesLength"] = to_int(self.pre_truncation_messages_length) - result["preTruncationTokensInMessages"] = to_int(self.pre_truncation_tokens_in_messages) - result["tokenLimit"] = to_int(self.token_limit) - result["tokensRemovedDuringTruncation"] = to_int(self.tokens_removed_during_truncation) + result["messagesRemovedDuringTruncation"] = to_int(self.messages_removed_during_truncation) + result["performedBy"] = from_str(self.performed_by) + result["postTruncationMessagesLength"] = to_int(self.post_truncation_messages_length) + result["postTruncationTokensInMessages"] = to_int(self.post_truncation_tokens_in_messages) + result["preTruncationMessagesLength"] = to_int(self.pre_truncation_messages_length) + result["preTruncationTokensInMessages"] = to_int(self.pre_truncation_tokens_in_messages) + result["tokenLimit"] = to_int(self.token_limit) + result["tokensRemovedDuringTruncation"] = to_int(self.tokens_removed_during_truncation) + return result + + +@dataclass +class SessionUsageCheckpointData: + "Durable session usage checkpoint for reconstructing aggregate accounting on resume" + total_nano_aiu: float + # Internal: this field is an internal SDK API and is not part of the public surface. + _model_cache_state: list[_UsageCheckpointModelCacheState] | None = None + # Internal: this field is an internal SDK API and is not part of the public surface. + _total_premium_requests: float | None = None + + @staticmethod + def from_dict(obj: Any) -> "SessionUsageCheckpointData": + assert isinstance(obj, dict) + total_nano_aiu = from_float(obj.get("totalNanoAiu")) + _model_cache_state = from_union([from_none, lambda x: from_list(_UsageCheckpointModelCacheState.from_dict, x)], obj.get("modelCacheState")) + _total_premium_requests = from_union([from_none, from_float], obj.get("totalPremiumRequests")) + return SessionUsageCheckpointData( + total_nano_aiu=total_nano_aiu, + _model_cache_state=_model_cache_state, + _total_premium_requests=_total_premium_requests, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["totalNanoAiu"] = to_float(self.total_nano_aiu) + if self._model_cache_state is not None: + result["modelCacheState"] = from_union([from_none, lambda x: from_list(lambda x: to_class(_UsageCheckpointModelCacheState, x), x)], self._model_cache_state) + if self._total_premium_requests is not None: + result["totalPremiumRequests"] = from_union([from_none, to_float], self._total_premium_requests) return result @@ -4532,7 +7585,7 @@ def to_dict(self) -> dict: @dataclass class ShutdownModelMetric: - "Schema for the `ShutdownModelMetric` type." + "Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details." requests: ShutdownModelMetricRequests usage: ShutdownModelMetricUsage token_details: dict[str, ShutdownModelMetricTokenDetail] | None = None @@ -4593,7 +7646,7 @@ def to_dict(self) -> dict: @dataclass class ShutdownModelMetricTokenDetail: - "Schema for the `ShutdownModelMetricTokenDetail` type." + "A token-type entry in a shutdown model metric, storing the accumulated token count." token_count: int @staticmethod @@ -4648,7 +7701,7 @@ def to_dict(self) -> dict: @dataclass class ShutdownTokenDetail: - "Schema for the `ShutdownTokenDetail` type." + "A session-wide shutdown token-type entry storing the accumulated token count." token_count: int @staticmethod @@ -4673,6 +7726,7 @@ class SkillInvokedData: path: str allowed_tools: list[str] | None = None description: str | None = None + model: str | None = None plugin_name: str | None = None plugin_version: str | None = None source: str | None = None @@ -4686,6 +7740,7 @@ def from_dict(obj: Any) -> "SkillInvokedData": path = from_str(obj.get("path")) allowed_tools = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("allowedTools")) description = from_union([from_none, from_str], obj.get("description")) + model = from_union([from_none, from_str], obj.get("model")) plugin_name = from_union([from_none, from_str], obj.get("pluginName")) plugin_version = from_union([from_none, from_str], obj.get("pluginVersion")) source = from_union([from_none, from_str], obj.get("source")) @@ -4696,6 +7751,7 @@ def from_dict(obj: Any) -> "SkillInvokedData": path=path, allowed_tools=allowed_tools, description=description, + model=model, plugin_name=plugin_name, plugin_version=plugin_version, source=source, @@ -4711,6 +7767,8 @@ def to_dict(self) -> dict: result["allowedTools"] = from_union([from_none, lambda x: from_list(from_str, x)], self.allowed_tools) if self.description is not None: result["description"] = from_union([from_none, from_str], self.description) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) if self.plugin_name is not None: result["pluginName"] = from_union([from_none, from_str], self.plugin_name) if self.plugin_version is not None: @@ -4724,12 +7782,14 @@ def to_dict(self) -> dict: @dataclass class SkillsLoadedSkill: - "Schema for the `SkillsLoadedSkill` type." + "A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint." description: str enabled: bool name: str source: SkillSource user_invocable: bool + argument_hint: str | None = None + command_name: str | None = None path: str | None = None @staticmethod @@ -4740,6 +7800,8 @@ def from_dict(obj: Any) -> "SkillsLoadedSkill": name = from_str(obj.get("name")) source = parse_enum(SkillSource, obj.get("source")) user_invocable = from_bool(obj.get("userInvocable")) + argument_hint = from_union([from_none, from_str], obj.get("argumentHint")) + command_name = from_union([from_none, from_str], obj.get("commandName")) path = from_union([from_none, from_str], obj.get("path")) return SkillsLoadedSkill( description=description, @@ -4747,6 +7809,8 @@ def from_dict(obj: Any) -> "SkillsLoadedSkill": name=name, source=source, user_invocable=user_invocable, + argument_hint=argument_hint, + command_name=command_name, path=path, ) @@ -4757,6 +7821,10 @@ def to_dict(self) -> dict: result["name"] = from_str(self.name) result["source"] = to_enum(SkillSource, self.source) result["userInvocable"] = from_bool(self.user_invocable) + if self.argument_hint is not None: + result["argumentHint"] = from_union([from_none, from_str], self.argument_hint) + if self.command_name is not None: + result["commandName"] = from_union([from_none, from_str], self.command_name) if self.path is not None: result["path"] = from_union([from_none, from_str], self.path) return result @@ -4768,6 +7836,7 @@ class SubagentCompletedData: agent_display_name: str agent_name: str tool_call_id: str + cancelled: bool | None = None duration: timedelta | None = None model: str | None = None total_tokens: int | None = None @@ -4779,6 +7848,7 @@ def from_dict(obj: Any) -> "SubagentCompletedData": agent_display_name = from_str(obj.get("agentDisplayName")) agent_name = from_str(obj.get("agentName")) tool_call_id = from_str(obj.get("toolCallId")) + cancelled = from_union([from_none, from_bool], obj.get("cancelled")) duration = from_union([from_none, from_timedelta], obj.get("durationMs")) model = from_union([from_none, from_str], obj.get("model")) total_tokens = from_union([from_none, from_int], obj.get("totalTokens")) @@ -4787,6 +7857,7 @@ def from_dict(obj: Any) -> "SubagentCompletedData": agent_display_name=agent_display_name, agent_name=agent_name, tool_call_id=tool_call_id, + cancelled=cancelled, duration=duration, model=model, total_tokens=total_tokens, @@ -4798,6 +7869,8 @@ def to_dict(self) -> dict: result["agentDisplayName"] = from_str(self.agent_display_name) result["agentName"] = from_str(self.agent_name) result["toolCallId"] = from_str(self.tool_call_id) + if self.cancelled is not None: + result["cancelled"] = from_union([from_none, from_bool], self.cancelled) if self.duration is not None: result["durationMs"] = from_union([from_none, to_timedelta_int], self.duration) if self.model is not None: @@ -4940,6 +8013,7 @@ class SystemMessageData: "System/developer instruction content with role and optional template metadata" content: str role: SystemMessageRole + interaction_id: str | None = None metadata: SystemMessageMetadata | None = None name: str | None = None @@ -4948,11 +8022,13 @@ def from_dict(obj: Any) -> "SystemMessageData": assert isinstance(obj, dict) content = from_str(obj.get("content")) role = parse_enum(SystemMessageRole, obj.get("role")) + interaction_id = from_union([from_none, from_str], obj.get("interactionId")) metadata = from_union([from_none, SystemMessageMetadata.from_dict], obj.get("metadata")) name = from_union([from_none, from_str], obj.get("name")) return SystemMessageData( content=content, role=role, + interaction_id=interaction_id, metadata=metadata, name=name, ) @@ -4961,6 +8037,8 @@ def to_dict(self) -> dict: result: dict = {} result["content"] = from_str(self.content) result["role"] = to_enum(SystemMessageRole, self.role) + if self.interaction_id is not None: + result["interactionId"] = from_union([from_none, from_str], self.interaction_id) if self.metadata is not None: result["metadata"] = from_union([from_none, lambda x: to_class(SystemMessageMetadata, x)], self.metadata) if self.name is not None: @@ -4995,7 +8073,7 @@ def to_dict(self) -> dict: @dataclass class SystemNotificationAgentCompleted: - "Schema for the `SystemNotificationAgentCompleted` type." + "System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt." agent_id: str agent_type: str status: SystemNotificationAgentCompletedStatus @@ -5034,7 +8112,7 @@ def to_dict(self) -> dict: @dataclass class SystemNotificationAgentIdle: - "Schema for the `SystemNotificationAgentIdle` type." + "System notification metadata for a background agent that became idle, including agent ID, type, and description." agent_id: str agent_type: str type: ClassVar[str] = "agent_idle" @@ -5085,9 +8163,69 @@ def to_dict(self) -> dict: return result +@dataclass +class SystemNotificationFactoryCompleted: + "System notification metadata for a factory execution attempt that reached a terminal state." + attempt: int + consumed_nano_aiu: int + consumed_subagents: int + elapsed_ms: int + factory_name: str + run_id: str + status: SystemNotificationFactoryCompletedStatus + type: ClassVar[str] = "factory_completed" + failure: Any = None + result_preview: str | None = None + retry_guidance: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "SystemNotificationFactoryCompleted": + assert isinstance(obj, dict) + attempt = from_int(obj.get("attempt")) + consumed_nano_aiu = from_int(obj.get("consumedNanoAiu")) + consumed_subagents = from_int(obj.get("consumedSubagents")) + elapsed_ms = from_int(obj.get("elapsedMs")) + factory_name = from_str(obj.get("factoryName")) + run_id = from_str(obj.get("runId")) + status = parse_enum(SystemNotificationFactoryCompletedStatus, obj.get("status")) + failure = obj.get("failure") + result_preview = from_union([from_none, from_str], obj.get("resultPreview")) + retry_guidance = from_union([from_none, from_str], obj.get("retryGuidance")) + return SystemNotificationFactoryCompleted( + attempt=attempt, + consumed_nano_aiu=consumed_nano_aiu, + consumed_subagents=consumed_subagents, + elapsed_ms=elapsed_ms, + factory_name=factory_name, + run_id=run_id, + status=status, + failure=failure, + result_preview=result_preview, + retry_guidance=retry_guidance, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["attempt"] = to_int(self.attempt) + result["consumedNanoAiu"] = to_int(self.consumed_nano_aiu) + result["consumedSubagents"] = to_int(self.consumed_subagents) + result["elapsedMs"] = to_int(self.elapsed_ms) + result["factoryName"] = from_str(self.factory_name) + result["runId"] = from_str(self.run_id) + result["status"] = to_enum(SystemNotificationFactoryCompletedStatus, self.status) + result["type"] = self.type + if self.failure is not None: + result["failure"] = self.failure + if self.result_preview is not None: + result["resultPreview"] = from_union([from_none, from_str], self.result_preview) + if self.retry_guidance is not None: + result["retryGuidance"] = from_union([from_none, from_str], self.retry_guidance) + return result + + @dataclass class SystemNotificationInstructionDiscovered: - "Schema for the `SystemNotificationInstructionDiscovered` type." + "System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool." source_path: str trigger_file: str trigger_tool: str @@ -5121,7 +8259,7 @@ def to_dict(self) -> dict: @dataclass class SystemNotificationNewInboxMessage: - "Schema for the `SystemNotificationNewInboxMessage` type." + "System notification metadata for a new inbox message, including entry ID, sender details, and summary." entry_id: str sender_name: str sender_type: str @@ -5154,7 +8292,7 @@ def to_dict(self) -> dict: @dataclass class SystemNotificationShellCompleted: - "Schema for the `SystemNotificationShellCompleted` type." + "System notification metadata for a shell session that completed, including shell ID, optional exit code, and description." shell_id: str type: ClassVar[str] = "shell_completed" description: str | None = None @@ -5185,7 +8323,7 @@ def to_dict(self) -> dict: @dataclass class SystemNotificationShellDetachedCompleted: - "Schema for the `SystemNotificationShellDetachedCompleted` type." + "System notification metadata for a detached shell session that completed, including shell ID and description." shell_id: str type: ClassVar[str] = "shell_detached_completed" description: str | None = None @@ -5209,6 +8347,28 @@ def to_dict(self) -> dict: return result +@dataclass +class SystemNotificationUnclassified: + "System notification metadata from an external host that does not match a runtime-owned notification kind." + type: ClassVar[str] = "unclassified" + metadata: Any = None + + @staticmethod + def from_dict(obj: Any) -> "SystemNotificationUnclassified": + assert isinstance(obj, dict) + metadata = obj.get("metadata") + return SystemNotificationUnclassified( + metadata=metadata, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["type"] = self.type + if self.metadata is not None: + result["metadata"] = self.metadata + return result + + @dataclass class ToolExecutionCompleteContentAudio: "Audio content block with base64-encoded data" @@ -5365,33 +8525,42 @@ def to_dict(self) -> dict: @dataclass -class ToolExecutionCompleteContentTerminal: - "Terminal/shell output content block with optional exit code and working directory" - text: str - type: ClassVar[str] = "terminal" +class ToolExecutionCompleteContentShellExit: + "Shell command exit metadata with optional output preview" + exit_code: int + shell_id: str + type: ClassVar[str] = "shell_exit" cwd: str | None = None - exit_code: int | None = None + output_preview: str | None = None + output_truncated: bool | None = None @staticmethod - def from_dict(obj: Any) -> "ToolExecutionCompleteContentTerminal": + def from_dict(obj: Any) -> "ToolExecutionCompleteContentShellExit": assert isinstance(obj, dict) - text = from_str(obj.get("text")) + exit_code = from_int(obj.get("exitCode")) + shell_id = from_str(obj.get("shellId")) cwd = from_union([from_none, from_str], obj.get("cwd")) - exit_code = from_union([from_none, from_int], obj.get("exitCode")) - return ToolExecutionCompleteContentTerminal( - text=text, - cwd=cwd, + output_preview = from_union([from_none, from_str], obj.get("outputPreview")) + output_truncated = from_union([from_none, from_bool], obj.get("outputTruncated")) + return ToolExecutionCompleteContentShellExit( exit_code=exit_code, + shell_id=shell_id, + cwd=cwd, + output_preview=output_preview, + output_truncated=output_truncated, ) def to_dict(self) -> dict: result: dict = {} - result["text"] = from_str(self.text) + result["exitCode"] = to_int(self.exit_code) + result["shellId"] = from_str(self.shell_id) result["type"] = self.type if self.cwd is not None: result["cwd"] = from_union([from_none, from_str], self.cwd) - if self.exit_code is not None: - result["exitCode"] = from_union([from_none, to_int], self.exit_code) + if self.output_preview is not None: + result["outputPreview"] = from_union([from_none, from_str], self.output_preview) + if self.output_truncated is not None: + result["outputTruncated"] = from_union([from_none, from_bool], self.output_truncated) return result @@ -5424,10 +8593,13 @@ class ToolExecutionCompleteData: error: ToolExecutionCompleteError | None = None interaction_id: str | None = None is_user_requested: bool | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + mcp_meta: Any = None model: str | None = None # Deprecated: this field is deprecated. parent_tool_call_id: str | None = None result: ToolExecutionCompleteResult | None = None + rte: bool | None = None sandboxed: bool | None = None tool_description: ToolExecutionCompleteToolDescription | None = None tool_telemetry: dict[str, Any] | None = None @@ -5441,9 +8613,11 @@ def from_dict(obj: Any) -> "ToolExecutionCompleteData": error = from_union([from_none, ToolExecutionCompleteError.from_dict], obj.get("error")) interaction_id = from_union([from_none, from_str], obj.get("interactionId")) is_user_requested = from_union([from_none, from_bool], obj.get("isUserRequested")) + mcp_meta = obj.get("mcpMeta") model = from_union([from_none, from_str], obj.get("model")) parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) result = from_union([from_none, ToolExecutionCompleteResult.from_dict], obj.get("result")) + rte = from_union([from_none, from_bool], obj.get("rte")) sandboxed = from_union([from_none, from_bool], obj.get("sandboxed")) tool_description = from_union([from_none, ToolExecutionCompleteToolDescription.from_dict], obj.get("toolDescription")) tool_telemetry = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get("toolTelemetry")) @@ -5454,9 +8628,11 @@ def from_dict(obj: Any) -> "ToolExecutionCompleteData": error=error, interaction_id=interaction_id, is_user_requested=is_user_requested, + mcp_meta=mcp_meta, model=model, parent_tool_call_id=parent_tool_call_id, result=result, + rte=rte, sandboxed=sandboxed, tool_description=tool_description, tool_telemetry=tool_telemetry, @@ -5473,12 +8649,16 @@ def to_dict(self) -> dict: result["interactionId"] = from_union([from_none, from_str], self.interaction_id) if self.is_user_requested is not None: result["isUserRequested"] = from_union([from_none, from_bool], self.is_user_requested) + if self.mcp_meta is not None: + result["mcpMeta"] = self.mcp_meta if self.model is not None: result["model"] = from_union([from_none, from_str], self.model) if self.parent_tool_call_id is not None: result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) if self.result is not None: result["result"] = from_union([from_none, lambda x: to_class(ToolExecutionCompleteResult, x)], self.result) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) if self.sandboxed is not None: result["sandboxed"] = from_union([from_none, from_bool], self.sandboxed) if self.tool_description is not None: @@ -5518,31 +8698,54 @@ def to_dict(self) -> dict: class ToolExecutionCompleteResult: "Tool execution result on success" content: str + # Experimental: this field is part of an experimental API and may change or be removed. + binary_results_for_llm: list[PersistedBinaryResult] | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + citable_sources: list[CitableSource] | None = None contents: list[ToolExecutionCompleteContent] | None = None detailed_content: str | None = None + # Experimental: this field is part of an experimental API and may change or be removed. + mcp_meta: Any = None + structured_content: Any = None ui_resource: ToolExecutionCompleteUIResource | None = None @staticmethod def from_dict(obj: Any) -> "ToolExecutionCompleteResult": assert isinstance(obj, dict) content = from_str(obj.get("content")) + binary_results_for_llm = from_union([from_none, lambda x: from_list(lambda x: from_union([PersistedBinaryImage.from_dict, OmittedBinaryResult.from_dict, BinaryAssetReference.from_dict], x), x)], obj.get("binaryResultsForLlm")) + citable_sources = from_union([from_none, lambda x: from_list(CitableSource.from_dict, x)], obj.get("citableSources")) contents = from_union([from_none, lambda x: from_list(_load_ToolExecutionCompleteContent, x)], obj.get("contents")) detailed_content = from_union([from_none, from_str], obj.get("detailedContent")) + mcp_meta = obj.get("mcpMeta") + structured_content = obj.get("structuredContent") ui_resource = from_union([from_none, ToolExecutionCompleteUIResource.from_dict], obj.get("uiResource")) return ToolExecutionCompleteResult( content=content, + binary_results_for_llm=binary_results_for_llm, + citable_sources=citable_sources, contents=contents, detailed_content=detailed_content, + mcp_meta=mcp_meta, + structured_content=structured_content, ui_resource=ui_resource, ) def to_dict(self) -> dict: result: dict = {} result["content"] = from_str(self.content) + if self.binary_results_for_llm is not None: + result["binaryResultsForLlm"] = from_union([from_none, lambda x: from_list(lambda x: from_union([lambda x: to_class(PersistedBinaryImage, x), lambda x: to_class(OmittedBinaryResult, x), lambda x: to_class(BinaryAssetReference, x)], x), x)], self.binary_results_for_llm) + if self.citable_sources is not None: + result["citableSources"] = from_union([from_none, lambda x: from_list(lambda x: to_class(CitableSource, x), x)], self.citable_sources) if self.contents is not None: result["contents"] = from_union([from_none, lambda x: from_list(lambda x: x.to_dict(), x)], self.contents) if self.detailed_content is not None: result["detailedContent"] = from_union([from_none, from_str], self.detailed_content) + if self.mcp_meta is not None: + result["mcpMeta"] = self.mcp_meta + if self.structured_content is not None: + result["structuredContent"] = self.structured_content if self.ui_resource is not None: result["uiResource"] = from_union([from_none, lambda x: to_class(ToolExecutionCompleteUIResource, x)], self.ui_resource) return result @@ -5599,7 +8802,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteToolDescriptionMetaUI: - "Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type." + "MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`." resource_uri: str | None = None visibility: list[ToolExecutionCompleteToolDescriptionMetaUIVisibility] | None = None @@ -5682,7 +8885,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUI: - "Schema for the `ToolExecutionCompleteUIResourceMetaUI` type." + "MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference." csp: ToolExecutionCompleteUIResourceMetaUICsp | None = None domain: str | None = None permissions: ToolExecutionCompleteUIResourceMetaUIPermissions | None = None @@ -5717,7 +8920,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUICsp: - "Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type." + "CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains." base_uri_domains: list[str] | None = None connect_domains: list[str] | None = None frame_domains: list[str] | None = None @@ -5752,7 +8955,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUIPermissions: - "Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type." + "Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write." camera: ToolExecutionCompleteUIResourceMetaUIPermissionsCamera | None = None clipboard_write: ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite | None = None geolocation: ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation | None = None @@ -5787,7 +8990,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUIPermissionsCamera: - "Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type." + "Marker object for camera permission on an MCP Apps UI resource." @staticmethod def from_dict(obj: Any) -> "ToolExecutionCompleteUIResourceMetaUIPermissionsCamera": assert isinstance(obj, dict) @@ -5799,7 +9002,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite: - "Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type." + "Marker object for clipboard-write permission on an MCP Apps UI resource." @staticmethod def from_dict(obj: Any) -> "ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite": assert isinstance(obj, dict) @@ -5811,7 +9014,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation: - "Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type." + "Marker object for geolocation permission on an MCP Apps UI resource." @staticmethod def from_dict(obj: Any) -> "ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation": assert isinstance(obj, dict) @@ -5823,7 +9026,7 @@ def to_dict(self) -> dict: @dataclass class ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone: - "Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type." + "Marker object for microphone permission on an MCP Apps UI resource." @staticmethod def from_dict(obj: Any) -> "ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone": assert isinstance(obj, dict) @@ -5888,8 +9091,12 @@ class ToolExecutionStartData: display_verbatim: bool | None = None mcp_server_name: str | None = None mcp_tool_name: str | None = None + model: str | None = None # Deprecated: this field is deprecated. parent_tool_call_id: str | None = None + rte: bool | None = None + shell_tool_info: ToolExecutionStartShellToolInfo | None = None + tool_description: ToolExecutionStartToolDescription | None = None turn_id: str | None = None @staticmethod @@ -5901,7 +9108,11 @@ def from_dict(obj: Any) -> "ToolExecutionStartData": display_verbatim = from_union([from_none, from_bool], obj.get("displayVerbatim")) mcp_server_name = from_union([from_none, from_str], obj.get("mcpServerName")) mcp_tool_name = from_union([from_none, from_str], obj.get("mcpToolName")) + model = from_union([from_none, from_str], obj.get("model")) parent_tool_call_id = from_union([from_none, from_str], obj.get("parentToolCallId")) + rte = from_union([from_none, from_bool], obj.get("rte")) + shell_tool_info = from_union([from_none, ToolExecutionStartShellToolInfo.from_dict], obj.get("shellToolInfo")) + tool_description = from_union([from_none, ToolExecutionStartToolDescription.from_dict], obj.get("toolDescription")) turn_id = from_union([from_none, from_str], obj.get("turnId")) return ToolExecutionStartData( tool_call_id=tool_call_id, @@ -5910,7 +9121,11 @@ def from_dict(obj: Any) -> "ToolExecutionStartData": display_verbatim=display_verbatim, mcp_server_name=mcp_server_name, mcp_tool_name=mcp_tool_name, + model=model, parent_tool_call_id=parent_tool_call_id, + rte=rte, + shell_tool_info=shell_tool_info, + tool_description=tool_description, turn_id=turn_id, ) @@ -5926,361 +9141,277 @@ def to_dict(self) -> dict: result["mcpServerName"] = from_union([from_none, from_str], self.mcp_server_name) if self.mcp_tool_name is not None: result["mcpToolName"] = from_union([from_none, from_str], self.mcp_tool_name) + if self.model is not None: + result["model"] = from_union([from_none, from_str], self.model) if self.parent_tool_call_id is not None: result["parentToolCallId"] = from_union([from_none, from_str], self.parent_tool_call_id) + if self.rte is not None: + result["rte"] = from_union([from_none, from_bool], self.rte) + if self.shell_tool_info is not None: + result["shellToolInfo"] = from_union([from_none, lambda x: to_class(ToolExecutionStartShellToolInfo, x)], self.shell_tool_info) + if self.tool_description is not None: + result["toolDescription"] = from_union([from_none, lambda x: to_class(ToolExecutionStartToolDescription, x)], self.tool_description) if self.turn_id is not None: result["turnId"] = from_union([from_none, from_str], self.turn_id) return result @dataclass -class ToolUserRequestedData: - "User-initiated tool invocation request with tool name and arguments" - tool_call_id: str - tool_name: str - arguments: Any = None - - @staticmethod - def from_dict(obj: Any) -> "ToolUserRequestedData": - assert isinstance(obj, dict) - tool_call_id = from_str(obj.get("toolCallId")) - tool_name = from_str(obj.get("toolName")) - arguments = obj.get("arguments") - return ToolUserRequestedData( - tool_call_id=tool_call_id, - tool_name=tool_name, - arguments=arguments, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["toolCallId"] = from_str(self.tool_call_id) - result["toolName"] = from_str(self.tool_name) - if self.arguments is not None: - result["arguments"] = self.arguments - return result - - -@dataclass -class UserInputCompletedData: - "User input request completion with the user's response" - request_id: str - answer: str | None = None - was_freeform: bool | None = None - - @staticmethod - def from_dict(obj: Any) -> "UserInputCompletedData": - assert isinstance(obj, dict) - request_id = from_str(obj.get("requestId")) - answer = from_union([from_none, from_str], obj.get("answer")) - was_freeform = from_union([from_none, from_bool], obj.get("wasFreeform")) - return UserInputCompletedData( - request_id=request_id, - answer=answer, - was_freeform=was_freeform, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["requestId"] = from_str(self.request_id) - if self.answer is not None: - result["answer"] = from_union([from_none, from_str], self.answer) - if self.was_freeform is not None: - result["wasFreeform"] = from_union([from_none, from_bool], self.was_freeform) - return result - - -@dataclass -class UserInputRequestedData: - "User input request notification with question and optional predefined choices" - question: str - request_id: str - allow_freeform: bool | None = None - choices: list[str] | None = None - tool_call_id: str | None = None - - @staticmethod - def from_dict(obj: Any) -> "UserInputRequestedData": - assert isinstance(obj, dict) - question = from_str(obj.get("question")) - request_id = from_str(obj.get("requestId")) - allow_freeform = from_union([from_none, from_bool], obj.get("allowFreeform")) - choices = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("choices")) - tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) - return UserInputRequestedData( - question=question, - request_id=request_id, - allow_freeform=allow_freeform, - choices=choices, - tool_call_id=tool_call_id, - ) - - def to_dict(self) -> dict: - result: dict = {} - result["question"] = from_str(self.question) - result["requestId"] = from_str(self.request_id) - if self.allow_freeform is not None: - result["allowFreeform"] = from_union([from_none, from_bool], self.allow_freeform) - if self.choices is not None: - result["choices"] = from_union([from_none, lambda x: from_list(from_str, x)], self.choices) - if self.tool_call_id is not None: - result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) - return result - - -@dataclass -class UserMessageAttachmentBlob: - "Blob attachment with inline base64-encoded data" - data: str - mime_type: str - type: ClassVar[str] = "blob" - display_name: str | None = None +class ToolExecutionStartShellToolInfo: + "Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs." + has_write_file_redirection: bool + possible_paths: list[str] + # Experimental: this field is part of an experimental API and may change or be removed. + display_command: str | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentBlob": + def from_dict(obj: Any) -> "ToolExecutionStartShellToolInfo": assert isinstance(obj, dict) - data = from_str(obj.get("data")) - mime_type = from_str(obj.get("mimeType")) - display_name = from_union([from_none, from_str], obj.get("displayName")) - return UserMessageAttachmentBlob( - data=data, - mime_type=mime_type, - display_name=display_name, + has_write_file_redirection = from_bool(obj.get("hasWriteFileRedirection")) + possible_paths = from_list(from_str, obj.get("possiblePaths")) + display_command = from_union([from_none, from_str], obj.get("displayCommand")) + return ToolExecutionStartShellToolInfo( + has_write_file_redirection=has_write_file_redirection, + possible_paths=possible_paths, + display_command=display_command, ) def to_dict(self) -> dict: result: dict = {} - result["data"] = from_str(self.data) - result["mimeType"] = from_str(self.mime_type) - result["type"] = self.type - if self.display_name is not None: - result["displayName"] = from_union([from_none, from_str], self.display_name) + result["hasWriteFileRedirection"] = from_bool(self.has_write_file_redirection) + result["possiblePaths"] = from_list(from_str, self.possible_paths) + if self.display_command is not None: + result["displayCommand"] = from_union([from_none, from_str], self.display_command) return result @dataclass -class UserMessageAttachmentDirectory: - "Directory attachment" - display_name: str - path: str - type: ClassVar[str] = "directory" +class ToolExecutionStartToolDescription: + "Tool definition metadata, present for MCP tools with MCP Apps support" + name: str + _meta: ToolExecutionStartToolDescriptionMeta | None = None + description: str | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentDirectory": + def from_dict(obj: Any) -> "ToolExecutionStartToolDescription": assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - path = from_str(obj.get("path")) - return UserMessageAttachmentDirectory( - display_name=display_name, - path=path, + name = from_str(obj.get("name")) + _meta = from_union([from_none, ToolExecutionStartToolDescriptionMeta.from_dict], obj.get("_meta")) + description = from_union([from_none, from_str], obj.get("description")) + return ToolExecutionStartToolDescription( + name=name, + _meta=_meta, + description=description, ) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["path"] = from_str(self.path) - result["type"] = self.type + result["name"] = from_str(self.name) + if self._meta is not None: + result["_meta"] = from_union([from_none, lambda x: to_class(ToolExecutionStartToolDescriptionMeta, x)], self._meta) + if self.description is not None: + result["description"] = from_union([from_none, from_str], self.description) return result @dataclass -class UserMessageAttachmentFile: - "File attachment" - display_name: str - path: str - type: ClassVar[str] = "file" - line_range: UserMessageAttachmentFileLineRange | None = None +class ToolExecutionStartToolDescriptionMeta: + "MCP Apps metadata for UI resource association" + ui: ToolExecutionStartToolDescriptionMetaUI | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentFile": + def from_dict(obj: Any) -> "ToolExecutionStartToolDescriptionMeta": assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - path = from_str(obj.get("path")) - line_range = from_union([from_none, UserMessageAttachmentFileLineRange.from_dict], obj.get("lineRange")) - return UserMessageAttachmentFile( - display_name=display_name, - path=path, - line_range=line_range, + ui = from_union([from_none, ToolExecutionStartToolDescriptionMetaUI.from_dict], obj.get("ui")) + return ToolExecutionStartToolDescriptionMeta( + ui=ui, ) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["path"] = from_str(self.path) - result["type"] = self.type - if self.line_range is not None: - result["lineRange"] = from_union([from_none, lambda x: to_class(UserMessageAttachmentFileLineRange, x)], self.line_range) + if self.ui is not None: + result["ui"] = from_union([from_none, lambda x: to_class(ToolExecutionStartToolDescriptionMetaUI, x)], self.ui) return result @dataclass -class UserMessageAttachmentFileLineRange: - "Optional line range to scope the attachment to a specific section of the file" - end: int - start: int +class ToolExecutionStartToolDescriptionMetaUI: + "MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`." + resource_uri: str | None = None + visibility: list[ToolExecutionStartToolDescriptionMetaUIVisibility] | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentFileLineRange": + def from_dict(obj: Any) -> "ToolExecutionStartToolDescriptionMetaUI": assert isinstance(obj, dict) - end = from_int(obj.get("end")) - start = from_int(obj.get("start")) - return UserMessageAttachmentFileLineRange( - end=end, - start=start, + resource_uri = from_union([from_none, from_str], obj.get("resourceUri")) + visibility = from_union([from_none, lambda x: from_list(lambda x: parse_enum(ToolExecutionStartToolDescriptionMetaUIVisibility, x), x)], obj.get("visibility")) + return ToolExecutionStartToolDescriptionMetaUI( + resource_uri=resource_uri, + visibility=visibility, ) def to_dict(self) -> dict: result: dict = {} - result["end"] = to_int(self.end) - result["start"] = to_int(self.start) + if self.resource_uri is not None: + result["resourceUri"] = from_union([from_none, from_str], self.resource_uri) + if self.visibility is not None: + result["visibility"] = from_union([from_none, lambda x: from_list(lambda x: to_enum(ToolExecutionStartToolDescriptionMetaUIVisibility, x), x)], self.visibility) return result @dataclass -class UserMessageAttachmentGithubReference: - "GitHub issue, pull request, or discussion reference" - number: int - reference_type: UserMessageAttachmentGithubReferenceType - state: str - title: str - type: ClassVar[str] = "github_reference" - url: str +class ToolSearchActivatedData: + "Persisted generic client-side tool activations restored when a session resumes." + strategy: str + tool_names: list[str] @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentGithubReference": + def from_dict(obj: Any) -> "ToolSearchActivatedData": assert isinstance(obj, dict) - number = from_int(obj.get("number")) - reference_type = parse_enum(UserMessageAttachmentGithubReferenceType, obj.get("referenceType")) - state = from_str(obj.get("state")) - title = from_str(obj.get("title")) - url = from_str(obj.get("url")) - return UserMessageAttachmentGithubReference( - number=number, - reference_type=reference_type, - state=state, - title=title, - url=url, + strategy = from_str(obj.get("strategy")) + tool_names = from_list(from_str, obj.get("toolNames")) + return ToolSearchActivatedData( + strategy=strategy, + tool_names=tool_names, ) def to_dict(self) -> dict: result: dict = {} - result["number"] = to_int(self.number) - result["referenceType"] = to_enum(UserMessageAttachmentGithubReferenceType, self.reference_type) - result["state"] = from_str(self.state) - result["title"] = from_str(self.title) - result["type"] = self.type - result["url"] = from_str(self.url) + result["strategy"] = from_str(self.strategy) + result["toolNames"] = from_list(from_str, self.tool_names) return result @dataclass -class UserMessageAttachmentSelection: - "Code selection attachment from an editor" - display_name: str - file_path: str - selection: UserMessageAttachmentSelectionDetails - text: str - type: ClassVar[str] = "selection" +class ToolUserRequestedData: + "User-initiated tool invocation request with tool name and arguments" + tool_call_id: str + tool_name: str + arguments: Any = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentSelection": + def from_dict(obj: Any) -> "ToolUserRequestedData": assert isinstance(obj, dict) - display_name = from_str(obj.get("displayName")) - file_path = from_str(obj.get("filePath")) - selection = UserMessageAttachmentSelectionDetails.from_dict(obj.get("selection")) - text = from_str(obj.get("text")) - return UserMessageAttachmentSelection( - display_name=display_name, - file_path=file_path, - selection=selection, - text=text, + tool_call_id = from_str(obj.get("toolCallId")) + tool_name = from_str(obj.get("toolName")) + arguments = obj.get("arguments") + return ToolUserRequestedData( + tool_call_id=tool_call_id, + tool_name=tool_name, + arguments=arguments, ) def to_dict(self) -> dict: result: dict = {} - result["displayName"] = from_str(self.display_name) - result["filePath"] = from_str(self.file_path) - result["selection"] = to_class(UserMessageAttachmentSelectionDetails, self.selection) - result["text"] = from_str(self.text) - result["type"] = self.type + result["toolCallId"] = from_str(self.tool_call_id) + result["toolName"] = from_str(self.tool_name) + if self.arguments is not None: + result["arguments"] = self.arguments return result @dataclass -class UserMessageAttachmentSelectionDetails: - "Position range of the selection within the file" - end: UserMessageAttachmentSelectionDetailsEnd - start: UserMessageAttachmentSelectionDetailsStart +class _UsageCheckpointModelCacheState: + "Internal prompt-cache expiration state for one model" + cache_expires_at: datetime + # Internal: this field is an internal SDK API and is not part of the public surface. + _cache_ttl_seconds: int + model_id: str @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentSelectionDetails": + def from_dict(obj: Any) -> "_UsageCheckpointModelCacheState": assert isinstance(obj, dict) - end = UserMessageAttachmentSelectionDetailsEnd.from_dict(obj.get("end")) - start = UserMessageAttachmentSelectionDetailsStart.from_dict(obj.get("start")) - return UserMessageAttachmentSelectionDetails( - end=end, - start=start, + cache_expires_at = from_datetime(obj.get("cacheExpiresAt")) + _cache_ttl_seconds = from_int(obj.get("cacheTtlSeconds")) + model_id = from_str(obj.get("modelId")) + return _UsageCheckpointModelCacheState( + cache_expires_at=cache_expires_at, + _cache_ttl_seconds=_cache_ttl_seconds, + model_id=model_id, ) def to_dict(self) -> dict: result: dict = {} - result["end"] = to_class(UserMessageAttachmentSelectionDetailsEnd, self.end) - result["start"] = to_class(UserMessageAttachmentSelectionDetailsStart, self.start) + result["cacheExpiresAt"] = to_datetime(self.cache_expires_at) + result["cacheTtlSeconds"] = to_int(self._cache_ttl_seconds) + result["modelId"] = from_str(self.model_id) return result @dataclass -class UserMessageAttachmentSelectionDetailsEnd: - "End position of the selection" - character: int - line: int +class UserInputCompletedData: + "User input request completion with the user's response" + request_id: str + answer: str | None = None + was_freeform: bool | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentSelectionDetailsEnd": + def from_dict(obj: Any) -> "UserInputCompletedData": assert isinstance(obj, dict) - character = from_int(obj.get("character")) - line = from_int(obj.get("line")) - return UserMessageAttachmentSelectionDetailsEnd( - character=character, - line=line, + request_id = from_str(obj.get("requestId")) + answer = from_union([from_none, from_str], obj.get("answer")) + was_freeform = from_union([from_none, from_bool], obj.get("wasFreeform")) + return UserInputCompletedData( + request_id=request_id, + answer=answer, + was_freeform=was_freeform, ) def to_dict(self) -> dict: result: dict = {} - result["character"] = to_int(self.character) - result["line"] = to_int(self.line) + result["requestId"] = from_str(self.request_id) + if self.answer is not None: + result["answer"] = from_union([from_none, from_str], self.answer) + if self.was_freeform is not None: + result["wasFreeform"] = from_union([from_none, from_bool], self.was_freeform) return result @dataclass -class UserMessageAttachmentSelectionDetailsStart: - "Start position of the selection" - character: int - line: int +class UserInputRequestedData: + "User input request notification with question and optional predefined choices" + question: str + request_id: str + allow_freeform: bool | None = None + choices: list[str] | None = None + tool_call_id: str | None = None @staticmethod - def from_dict(obj: Any) -> "UserMessageAttachmentSelectionDetailsStart": + def from_dict(obj: Any) -> "UserInputRequestedData": assert isinstance(obj, dict) - character = from_int(obj.get("character")) - line = from_int(obj.get("line")) - return UserMessageAttachmentSelectionDetailsStart( - character=character, - line=line, + question = from_str(obj.get("question")) + request_id = from_str(obj.get("requestId")) + allow_freeform = from_union([from_none, from_bool], obj.get("allowFreeform")) + choices = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("choices")) + tool_call_id = from_union([from_none, from_str], obj.get("toolCallId")) + return UserInputRequestedData( + question=question, + request_id=request_id, + allow_freeform=allow_freeform, + choices=choices, + tool_call_id=tool_call_id, ) def to_dict(self) -> dict: result: dict = {} - result["character"] = to_int(self.character) - result["line"] = to_int(self.line) + result["question"] = from_str(self.question) + result["requestId"] = from_str(self.request_id) + if self.allow_freeform is not None: + result["allowFreeform"] = from_union([from_none, from_bool], self.allow_freeform) + if self.choices is not None: + result["choices"] = from_union([from_none, lambda x: from_list(from_str, x)], self.choices) + if self.tool_call_id is not None: + result["toolCallId"] = from_union([from_none, from_str], self.tool_call_id) return result @dataclass class UserMessageData: - "Schema for the `UserMessageData` type." + "Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs." content: str agent_mode: UserMessageAgentMode | None = None - attachments: list[UserMessageAttachment] | None = None + attachments: list[Attachment] | None = None + delivery: UserMessageDelivery | None = None interaction_id: str | None = None is_autopilot_continuation: bool | None = None native_document_path_fallback_paths: list[str] | None = None @@ -6294,7 +9425,8 @@ def from_dict(obj: Any) -> "UserMessageData": assert isinstance(obj, dict) content = from_str(obj.get("content")) agent_mode = from_union([from_none, lambda x: parse_enum(UserMessageAgentMode, x)], obj.get("agentMode")) - attachments = from_union([from_none, lambda x: from_list(_load_UserMessageAttachment, x)], obj.get("attachments")) + attachments = from_union([from_none, lambda x: from_list(_load_Attachment, x)], obj.get("attachments")) + delivery = from_union([from_none, lambda x: parse_enum(UserMessageDelivery, x)], obj.get("delivery")) interaction_id = from_union([from_none, from_str], obj.get("interactionId")) is_autopilot_continuation = from_union([from_none, from_bool], obj.get("isAutopilotContinuation")) native_document_path_fallback_paths = from_union([from_none, lambda x: from_list(from_str, x)], obj.get("nativeDocumentPathFallbackPaths")) @@ -6306,6 +9438,7 @@ def from_dict(obj: Any) -> "UserMessageData": content=content, agent_mode=agent_mode, attachments=attachments, + delivery=delivery, interaction_id=interaction_id, is_autopilot_continuation=is_autopilot_continuation, native_document_path_fallback_paths=native_document_path_fallback_paths, @@ -6322,6 +9455,8 @@ def to_dict(self) -> dict: result["agentMode"] = from_union([from_none, lambda x: to_enum(UserMessageAgentMode, x)], self.agent_mode) if self.attachments is not None: result["attachments"] = from_union([from_none, lambda x: from_list(lambda x: x.to_dict(), x)], self.attachments) + if self.delivery is not None: + result["delivery"] = from_union([from_none, lambda x: to_enum(UserMessageDelivery, x)], self.delivery) if self.interaction_id is not None: result["interactionId"] = from_union([from_none, from_str], self.interaction_id) if self.is_autopilot_continuation is not None: @@ -6341,7 +9476,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalCommands: - "Schema for the `UserToolSessionApprovalCommands` type." + "Session-scoped tool-approval rule for specific shell command identifiers." command_identifiers: list[str] kind: ClassVar[str] = "commands" @@ -6362,7 +9497,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalCustomTool: - "Schema for the `UserToolSessionApprovalCustomTool` type." + "Session-scoped tool-approval rule for a custom tool, keyed by tool name." kind: ClassVar[str] = "custom-tool" tool_name: str @@ -6383,7 +9518,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalExtensionManagement: - "Schema for the `UserToolSessionApprovalExtensionManagement` type." + "Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation." kind: ClassVar[str] = "extension-management" operation: str | None = None @@ -6405,7 +9540,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalExtensionPermissionAccess: - "Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type." + "Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name." extension_name: str kind: ClassVar[str] = "extension-permission-access" @@ -6424,9 +9559,31 @@ def to_dict(self) -> dict: return result +@dataclass +class UserToolSessionApprovalFactory: + "Session-scoped factory approval, optionally narrowed by approval key." + kind: ClassVar[str] = "factory" + approval_key: str | None = None + + @staticmethod + def from_dict(obj: Any) -> "UserToolSessionApprovalFactory": + assert isinstance(obj, dict) + approval_key = from_union([from_none, from_str], obj.get("approvalKey")) + return UserToolSessionApprovalFactory( + approval_key=approval_key, + ) + + def to_dict(self) -> dict: + result: dict = {} + result["kind"] = self.kind + if self.approval_key is not None: + result["approvalKey"] = from_union([from_none, from_str], self.approval_key) + return result + + @dataclass class UserToolSessionApprovalMcp: - "Schema for the `UserToolSessionApprovalMcp` type." + "Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null." kind: ClassVar[str] = "mcp" server_name: str tool_name: str | None @@ -6451,7 +9608,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalMemory: - "Schema for the `UserToolSessionApprovalMemory` type." + "Session-scoped tool-approval rule for writes to long-term memory." kind: ClassVar[str] = "memory" @staticmethod @@ -6468,7 +9625,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalRead: - "Schema for the `UserToolSessionApprovalRead` type." + "Session-scoped tool-approval rule for read-only filesystem operations." kind: ClassVar[str] = "read" @staticmethod @@ -6485,7 +9642,7 @@ def to_dict(self) -> dict: @dataclass class UserToolSessionApprovalWrite: - "Schema for the `UserToolSessionApprovalWrite` type." + "Session-scoped tool-approval rule for filesystem write operations." kind: ClassVar[str] = "write" @staticmethod @@ -6509,6 +9666,7 @@ class WorkingDirectoryContext: git_root: str | None = None head_commit: str | None = None host_type: WorkingDirectoryContextHostType | None = None + pending_git_context: bool | None = None repository: str | None = None repository_host: str | None = None @@ -6521,6 +9679,7 @@ def from_dict(obj: Any) -> "WorkingDirectoryContext": git_root = from_union([from_none, from_str], obj.get("gitRoot")) head_commit = from_union([from_none, from_str], obj.get("headCommit")) host_type = from_union([from_none, lambda x: parse_enum(WorkingDirectoryContextHostType, x)], obj.get("hostType")) + pending_git_context = from_union([from_none, from_bool], obj.get("pendingGitContext")) repository = from_union([from_none, from_str], obj.get("repository")) repository_host = from_union([from_none, from_str], obj.get("repositoryHost")) return WorkingDirectoryContext( @@ -6530,6 +9689,7 @@ def from_dict(obj: Any) -> "WorkingDirectoryContext": git_root=git_root, head_commit=head_commit, host_type=host_type, + pending_git_context=pending_git_context, repository=repository, repository_host=repository_host, ) @@ -6547,6 +9707,8 @@ def to_dict(self) -> dict: result["headCommit"] = from_union([from_none, from_str], self.head_commit) if self.host_type is not None: result["hostType"] = from_union([from_none, lambda x: to_enum(WorkingDirectoryContextHostType, x)], self.host_type) + if self.pending_git_context is not None: + result["pendingGitContext"] = from_union([from_none, from_bool], self.pending_git_context) if self.repository is not None: result["repository"] = from_union([from_none, from_str], self.repository) if self.repository_host is not None: @@ -6554,6 +9716,38 @@ def to_dict(self) -> dict: return result +def _load_Attachment(obj: Any) -> "Attachment": + assert isinstance(obj, dict) + kind = obj.get("type") + match kind: + case "file": return AttachmentFile.from_dict(obj) + case "directory": return AttachmentDirectory.from_dict(obj) + case "selection": return AttachmentSelection.from_dict(obj) + case "github_reference": return AttachmentGitHubReference.from_dict(obj) + case "github_commit": return AttachmentGitHubCommit.from_dict(obj) + case "github_release": return AttachmentGitHubRelease.from_dict(obj) + case "github_actions_job": return AttachmentGitHubActionsJob.from_dict(obj) + case "github_repository": return AttachmentGitHubRepository.from_dict(obj) + case "github_file_diff": return AttachmentGitHubFileDiff.from_dict(obj) + case "github_tree_comparison": return AttachmentGitHubTreeComparison.from_dict(obj) + case "github_url": return AttachmentGitHubUrl.from_dict(obj) + case "github_file": return AttachmentGitHubFile.from_dict(obj) + case "github_snippet": return AttachmentGitHubSnippet.from_dict(obj) + case "blob": return AttachmentBlob.from_dict(obj) + case "extension_context": return AttachmentExtensionContext.from_dict(obj) + case _: raise ValueError(f"Unknown Attachment type: {kind!r}") + + +def _load_CitationLocation(obj: Any) -> "CitationLocation": + assert isinstance(obj, dict) + kind = obj.get("type") + match kind: + case "char": return CitationLocationChar.from_dict(obj) + case "page": return CitationLocationPage.from_dict(obj) + case "block": return CitationLocationBlock.from_dict(obj) + case _: raise ValueError(f"Unknown CitationLocation type: {kind!r}") + + def _load_PermissionPromptRequest(obj: Any) -> "PermissionPromptRequest": assert isinstance(obj, dict) kind = obj.get("kind") @@ -6568,6 +9762,7 @@ def _load_PermissionPromptRequest(obj: Any) -> "PermissionPromptRequest": case "path": return PermissionPromptRequestPath.from_dict(obj) case "hook": return PermissionPromptRequestHook.from_dict(obj) case "extension-management": return PermissionPromptRequestExtensionManagement.from_dict(obj) + case "factory": return PermissionPromptRequestFactory.from_dict(obj) case "extension-permission-access": return PermissionPromptRequestExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionPromptRequest kind: {kind!r}") @@ -6585,6 +9780,7 @@ def _load_PermissionRequest(obj: Any) -> "PermissionRequest": case "custom-tool": return PermissionRequestCustomTool.from_dict(obj) case "hook": return PermissionRequestHook.from_dict(obj) case "extension-management": return PermissionRequestExtensionManagement.from_dict(obj) + case "factory": return PermissionRequestFactory.from_dict(obj) case "extension-permission-access": return PermissionRequestExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown PermissionRequest kind: {kind!r}") @@ -6615,6 +9811,8 @@ def _load_SystemNotification(obj: Any) -> "SystemNotification": case "shell_completed": return SystemNotificationShellCompleted.from_dict(obj) case "shell_detached_completed": return SystemNotificationShellDetachedCompleted.from_dict(obj) case "instruction_discovered": return SystemNotificationInstructionDiscovered.from_dict(obj) + case "factory_completed": return SystemNotificationFactoryCompleted.from_dict(obj) + case "unclassified": return SystemNotificationUnclassified.from_dict(obj) case _: raise ValueError(f"Unknown SystemNotification type: {kind!r}") @@ -6624,6 +9822,7 @@ def _load_ToolExecutionCompleteContent(obj: Any) -> "ToolExecutionCompleteConten match kind: case "text": return ToolExecutionCompleteContentText.from_dict(obj) case "terminal": return ToolExecutionCompleteContentTerminal.from_dict(obj) + case "shell_exit": return ToolExecutionCompleteContentShellExit.from_dict(obj) case "image": return ToolExecutionCompleteContentImage.from_dict(obj) case "audio": return ToolExecutionCompleteContentAudio.from_dict(obj) case "resource_link": return ToolExecutionCompleteContentResourceLink.from_dict(obj) @@ -6631,18 +9830,6 @@ def _load_ToolExecutionCompleteContent(obj: Any) -> "ToolExecutionCompleteConten case _: raise ValueError(f"Unknown ToolExecutionCompleteContent type: {kind!r}") -def _load_UserMessageAttachment(obj: Any) -> "UserMessageAttachment": - assert isinstance(obj, dict) - kind = obj.get("type") - match kind: - case "file": return UserMessageAttachmentFile.from_dict(obj) - case "directory": return UserMessageAttachmentDirectory.from_dict(obj) - case "selection": return UserMessageAttachmentSelection.from_dict(obj) - case "github_reference": return UserMessageAttachmentGithubReference.from_dict(obj) - case "blob": return UserMessageAttachmentBlob.from_dict(obj) - case _: raise ValueError(f"Unknown UserMessageAttachment type: {kind!r}") - - def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": assert isinstance(obj, dict) kind = obj.get("kind") @@ -6654,32 +9841,41 @@ def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": case "memory": return UserToolSessionApprovalMemory.from_dict(obj) case "custom-tool": return UserToolSessionApprovalCustomTool.from_dict(obj) case "extension-management": return UserToolSessionApprovalExtensionManagement.from_dict(obj) + case "factory": return UserToolSessionApprovalFactory.from_dict(obj) case "extension-permission-access": return UserToolSessionApprovalExtensionPermissionAccess.from_dict(obj) case _: raise ValueError(f"Unknown UserToolSessionApproval kind: {kind!r}") # A content block within a tool result, which may be text, terminal output, image, audio, or a resource -ToolExecutionCompleteContent = ToolExecutionCompleteContentText | ToolExecutionCompleteContentTerminal | ToolExecutionCompleteContentImage | ToolExecutionCompleteContentAudio | ToolExecutionCompleteContentResourceLink | ToolExecutionCompleteContentResource +ToolExecutionCompleteContent = ToolExecutionCompleteContentText | ToolExecutionCompleteContentTerminal | ToolExecutionCompleteContentShellExit | ToolExecutionCompleteContentImage | ToolExecutionCompleteContentAudio | ToolExecutionCompleteContentResourceLink | ToolExecutionCompleteContentResource -# A user message attachment — a file, directory, code selection, blob, or GitHub reference -UserMessageAttachment = UserMessageAttachmentFile | UserMessageAttachmentDirectory | UserMessageAttachmentSelection | UserMessageAttachmentGithubReference | UserMessageAttachmentBlob +# A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset reference +PersistedBinaryResult = PersistedBinaryImage | OmittedBinaryResult | BinaryAssetReference + + +# A user message attachment — a file, directory, code selection, blob, GitHub reference, GitHub-anchored pointer, or extension-supplied context payload +Attachment = AttachmentFile | AttachmentDirectory | AttachmentSelection | AttachmentGitHubReference | AttachmentGitHubCommit | AttachmentGitHubRelease | AttachmentGitHubActionsJob | AttachmentGitHubRepository | AttachmentGitHubFileDiff | AttachmentGitHubTreeComparison | AttachmentGitHubUrl | AttachmentGitHubFile | AttachmentGitHubSnippet | AttachmentBlob | AttachmentExtensionContext # Derived user-facing permission prompt details for UI consumers -PermissionPromptRequest = PermissionPromptRequestCommands | PermissionPromptRequestWrite | PermissionPromptRequestRead | PermissionPromptRequestMcp | PermissionPromptRequestUrl | PermissionPromptRequestMemory | PermissionPromptRequestCustomTool | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement | PermissionPromptRequestExtensionPermissionAccess +PermissionPromptRequest = PermissionPromptRequestCommands | PermissionPromptRequestWrite | PermissionPromptRequestRead | PermissionPromptRequestMcp | PermissionPromptRequestUrl | PermissionPromptRequestMemory | PermissionPromptRequestCustomTool | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement | PermissionPromptRequestFactory | PermissionPromptRequestExtensionPermissionAccess # Details of the permission being requested -PermissionRequest = PermissionRequestShell | PermissionRequestWrite | PermissionRequestRead | PermissionRequestMcp | PermissionRequestUrl | PermissionRequestMemory | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement | PermissionRequestExtensionPermissionAccess +PermissionRequest = PermissionRequestShell | PermissionRequestWrite | PermissionRequestRead | PermissionRequestMcp | PermissionRequestUrl | PermissionRequestMemory | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement | PermissionRequestFactory | PermissionRequestExtensionPermissionAccess + + +# Location within a cited source (character, page, or content-block range) that supports a span. +CitationLocation = CitationLocationChar | CitationLocationPage | CitationLocationBlock # Structured metadata identifying what triggered this notification -SystemNotification = SystemNotificationAgentCompleted | SystemNotificationAgentIdle | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted | SystemNotificationInstructionDiscovered +SystemNotification = SystemNotificationAgentCompleted | SystemNotificationAgentIdle | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted | SystemNotificationInstructionDiscovered | SystemNotificationFactoryCompleted | SystemNotificationUnclassified # The approval to add as a session-scoped rule -UserToolSessionApproval = UserToolSessionApprovalCommands | UserToolSessionApprovalRead | UserToolSessionApprovalWrite | UserToolSessionApprovalMcp | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement | UserToolSessionApprovalExtensionPermissionAccess +UserToolSessionApproval = UserToolSessionApprovalCommands | UserToolSessionApprovalRead | UserToolSessionApprovalWrite | UserToolSessionApprovalMcp | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement | UserToolSessionApprovalFactory | UserToolSessionApprovalExtensionPermissionAccess # The embedded resource contents, either text or base64-encoded binary @@ -6690,6 +9886,56 @@ def _load_UserToolSessionApproval(obj: Any) -> "UserToolSessionApproval": PermissionResult = PermissionApproved | PermissionApprovedForSession | PermissionApprovedForLocation | PermissionCancelled | PermissionDeniedByRules | PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser | PermissionDeniedInteractivelyByUser | PermissionDeniedByContentExclusionPolicy | PermissionDeniedByPermissionRequestHook +# Experimental: this enum is part of an experimental API and may change or be removed. +class AutoApprovalJudgeFailureReason(Enum): + "Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs." + # The judge model call exceeded its deadline. + TIMEOUT = "timeout" + # The judge model call was cancelled before it returned. + ABORT = "abort" + # The judge model call completed but returned no content. + EMPTY_RESPONSE = "empty_response" + # The judge model call failed (for example a transport, authentication, or rate-limit error). + MODEL_ERROR = "model_error" + # The judge model replied, but the reply carried no ALLOW/DENY verdict. + PARSE_ERROR = "parse_error" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class AutoApprovalRecommendation(Enum): + "Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off)." + # The judge evaluated the request and recommends automatically approving it. + APPROVE = "approve" + # The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + REQUIRE_APPROVAL = "requireApproval" + # Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. + EXCLUDED = "excluded" + # The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. + ERROR = "error" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class CitationProvider(Enum): + "The system that produced a citation." + # Citation produced by an Anthropic (Claude) model response. + ANTHROPIC = "anthropic" + # Citation produced by an OpenAI model response. + OPENAI = "openai" + # Citation synthesized client-side by the runtime from tool output. + CLIENT = "client" + + +# Experimental: this enum is part of an experimental API and may change or be removed. +class PermissionAllowAllMode(Enum): + "Allow-all mode for the session." + # Permission requests follow the normal approval flow. + OFF = "off" + # Tool, path, and URL permission requests are automatically approved. + ON = "on" + # Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + AUTO = "auto" + + class AbortReason(Enum): "Finite reason code describing why the current turn was aborted" # The local user requested the abort, for example by pressing Ctrl+C in the CLI. @@ -6698,6 +9944,8 @@ class AbortReason(Enum): REMOTE_COMMAND = "remote_command" # An MCP server delivered a user.abort notification. USER_ABORT = "user_abort" + # Autopilot stopped the run because the active objective reached its user-set --max-ai-credits limit. + AUTOPILOT_CREDIT_LIMIT = "autopilot_credit_limit" class AssistantMessageToolRequestType(Enum): @@ -6720,6 +9968,26 @@ class AssistantUsageApiEndpoint(Enum): WS_RESPONSES = "ws:/responses" +class AttachmentGitHubReferenceType(Enum): + "Type of GitHub reference" + # GitHub issue reference. + ISSUE = "issue" + # GitHub pull request reference. + PR = "pr" + # GitHub discussion reference. + DISCUSSION = "discussion" + + +class AutoModeResolvedReasoningBucket(Enum): + "Coarse request-difficulty bucket for UX explainability" + # The request looks low-reasoning; a lighter model is appropriate. + LOW = "low" + # The request needs a moderate amount of reasoning. + MEDIUM = "medium" + # The request looks high-reasoning; a stronger model is appropriate. + HIGH = "high" + + class AutoModeSwitchResponse(Enum): "The user's auto-mode-switch choice" # Switch models for this request. @@ -6752,12 +10020,42 @@ class AutopilotObjectiveChangedStatus(Enum): COMPLETED = "completed" -class CanvasOpenedAvailability(Enum): - "Runtime-controlled routing state for the instance. \"ready\" when the provider connection is live; \"stale\" when the provider has gone away and the instance is awaiting rebinding." - # Provider connection is live; actions can be invoked. - READY = "ready" - # Provider has gone away; the instance is awaiting rebinding. - STALE = "stale" +class BinaryAssetReferenceType(Enum): + "Binary result type discriminator. Use \"image\" for images and \"resource\" for other binary data." + # Binary image data. + IMAGE = "image" + # Other binary resource data. + RESOURCE = "resource" + + +class BinaryAssetType(Enum): + "Binary asset type discriminator. Use \"image\" for images and \"resource\" otherwise." + # Binary image data. + IMAGE = "image" + # Other binary resource data. + RESOURCE = "resource" + + +class CompactionTrigger(Enum): + "What initiated a conversation compaction" + # Background compaction started automatically because context utilization crossed the background threshold. + THRESHOLD = "threshold" + # Compaction forced by a context-limit model response (e.g. HTTP 413) before retrying the request. + CONTEXT_LIMIT_RETRY = "context_limit_retry" + # User-requested compaction, e.g. the /compact command or the history.compact API. + MANUAL = "manual" + # Emergency compaction triggered by high process memory usage. + MEMORY_PRESSURE = "memory_pressure" + # Compaction requested while switching to a model with a smaller context window. + MODEL_SWITCH = "model_switch" + + +class ContextTier(Enum): + "Allowed values for the `ContextTier` enumeration." + # Default context tier with standard context window size. + DEFAULT = "default" + # Extended context tier with a larger context window. + LONG_CONTEXT = "long_context" class ElicitationCompletedAction(Enum): @@ -6796,6 +10094,10 @@ class ExtensionsLoadedExtensionSource(Enum): PROJECT = "project" # Extension discovered from the user's extension directory. USER = "user" + # Extension contributed by an installed plugin. + PLUGIN = "plugin" + # Extension discovered from the current session's state directory. + SESSION = "session" class ExtensionsLoadedExtensionStatus(Enum): @@ -6810,6 +10112,14 @@ class ExtensionsLoadedExtensionStatus(Enum): STARTING = "starting" +class FactoryPermissionOperation(Enum): + "Operation gated by a factory permission request." + # Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. + RUN = "run" + # Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. + AUTHOR = "author" + + class HandoffSourceType(Enum): "Origin type of the session being handed off" # The handoff originated from a remote session. @@ -6818,6 +10128,80 @@ class HandoffSourceType(Enum): LOCAL = "local" +class ManagedSettingsEnforcedAction(Enum): + "The category of runtime action that enterprise managed settings governed (blocked or capped)" + # An attempt to turn on a bypass-permissions ("yolo") escalation was refused or capped because policy disables bypass-permissions mode. + BYPASS_PERMISSIONS_BLOCKED = "bypass_permissions_blocked" + + +class ManagedSettingsEnforcedEscalation(Enum): + "For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused" + # Full allow-all ("/allow-all on") permissions — auto-approving tools, paths, and URLs. + ALLOW_ALL = "allow_all" + # Auto-approval of all tool permission requests. + APPROVE_ALL = "approve_all" + # Advisory auto-approval ("/allow-all auto") mode — keeps normal prompt paths and adds LLM-advised approval, distinct from full allow-all. + AUTO_APPROVAL = "auto_approval" + # Unrestricted filesystem access outside the session's allowed directories. + UNRESTRICTED_PATHS = "unrestricted_paths" + # Unrestricted URL fetch access. + UNRESTRICTED_URLS = "unrestricted_urls" + + +class ManagedSettingsResolvedSource(Enum): + "Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance." + # Only the server/account channel contributed. + SERVER = "server" + # Only the device MDM/plist/registry/file channel contributed. + DEVICE = "device" + # Only session-local SDK-host injection contributed. + CLIENT = "client" + # More than one channel contributed. Ordinary keys resolve device over server per key, while permissions compose restrictively across all present layers. + MIXED = "mixed" + # No managed policy is in force (no channel contributed). + NONE = "none" + + +class McpHeadersRefreshCompletedOutcome(Enum): + "How the pending MCP headers refresh request resolved." + # The host supplied dynamic headers. + HEADERS = "headers" + # The host responded with no dynamic headers. + NONE = "none" + # No response arrived within the bounded window. + TIMEOUT = "timeout" + + +class McpHeadersRefreshRequiredReason(Enum): + "Why dynamic headers are being requested." + # The transport is making its first dynamic header request for this server. + STARTUP = "startup" + # The previously cached dynamic headers expired. + TTL_EXPIRED = "ttl-expired" + # The server returned 401 and stale dynamic headers were invalidated. + AUTH_FAILED = "auth-failed" + + +class McpOauthCompletionOutcome(Enum): + "How the pending MCP OAuth request was completed" + # The request completed with a token-backed OAuth provider. + TOKEN = "token" + # The request completed without an OAuth provider. + CANCELLED = "cancelled" + + +class McpOauthRequestReason(Enum): + "Reason the runtime is requesting host-provided MCP OAuth credentials" + # Initial credentials are required before connecting to the MCP server. + INITIAL = "initial" + # The current host-provided credential was rejected and a replacement is requested. + REFRESH = "refresh" + # The server requires a new host authorization flow before continuing. + REAUTH = "reauth" + # The server requires a credential with additional scope or audience. + UPSCOPE = "upscope" + + class McpServerSource(Enum): "Configuration source: user, workspace, plugin, or builtin" # Server configured in the user's global MCP configuration. @@ -6831,7 +10215,7 @@ class McpServerSource(Enum): class McpServerStatus(Enum): - "Connection status: connected, failed, needs-auth, pending, disabled, or not_configured" + "Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured" # The server is connected and available. CONNECTED = "connected" # The server failed to connect or initialize. @@ -6842,6 +10226,8 @@ class McpServerStatus(Enum): PENDING = "pending" # The server is configured but disabled. DISABLED = "disabled" + # The server was intentionally stopped and can be restarted on demand when policy permits; a server quarantined by restrictive managed policy stays stopped and cannot be restarted until the policy allows it. + STOPPED = "stopped" # The server is not configured for this session. NOT_CONFIGURED = "not_configured" @@ -6858,6 +10244,22 @@ class McpServerTransport(Enum): MEMORY = "memory" +class ModelCallFailureBadRequestKind(Enum): + "For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures." + # The 400 response carried no error body (transient gateway/proxy signature). + BODYLESS = "bodyless" + # The 400 response carried a structured CAPI error envelope (deterministic validation failure). + STRUCTURED_ERROR = "structured_error" + + +class ModelCallFailureKind(Enum): + "Boundary that produced a model call failure" + # The provider returned an API error response. + API = "api" + # The request transport failed before a usable API response completed. + TRANSPORT = "transport" + + class ModelCallFailureSource(Enum): "Where the failed model call originated" # Model call from the top-level agent. @@ -6868,6 +10270,30 @@ class ModelCallFailureSource(Enum): MCP_SAMPLING = "mcp_sampling" +class ModelCallFailureTransport(Enum): + "Transport used for a failed model call" + # HTTP transport, including SSE streams. + HTTP = "http" + # WebSocket transport. + WEBSOCKET = "websocket" + + +class OmittedBinaryOmittedReason(Enum): + "Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable" + # Bytes exceeded the session's inline size limit. + TOO_LARGE = "too_large" + # The referenced binary asset could not be found (e.g. a truncated log). + ASSET_UNAVAILABLE = "asset_unavailable" + + +class OmittedBinaryType(Enum): + "Binary result type discriminator. Use \"image\" for images and \"resource\" for other binary data." + # Binary image data. + IMAGE = "image" + # Other binary resource data. + RESOURCE = "resource" + + class PermissionPromptRequestPathAccessKind(Enum): "Underlying permission kind that needs path approval" # Read access to a filesystem path. @@ -6894,6 +10320,14 @@ class PermissionRequestMemoryDirection(Enum): DOWNVOTE = "downvote" +class PersistedBinaryImageType(Enum): + "Binary result type discriminator. Use \"image\" for images and \"resource\" for other binary data." + # Binary image data. + IMAGE = "image" + # Other binary resource data. + RESOURCE = "resource" + + class PlanChangedOperation(Enum): "The type of operation performed on the plan file" # The plan file was created. @@ -6914,6 +10348,26 @@ class ReasoningSummary(Enum): DETAILED = "detailed" +class ScheduleOrigin(Enum): + "Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may." + # The schedule was created by an explicit user action, such as `/every` or `/after`. + USER = "user" + # The schedule was created by the agent via the `manage_schedule` tool. + MODEL = "model" + + +class SessionLimitsExhaustedResponseAction(Enum): + "User action selected for an exhausted session limit." + # Increase the current max by an exact AI Credits amount. + ADD = "add" + # Set a new absolute max AI Credits value. + SET = "set" + # Remove the current session limit. + UNSET = "unset" + # Leave the limit unchanged and cancel the blocked model request. + CANCEL = "cancel" + + class SessionMode(Enum): "The session mode the agent is operating in" # The agent is responding interactively to the user. @@ -6924,27 +10378,6 @@ class SessionMode(Enum): AUTOPILOT = "autopilot" -class SessionModelChangeDataContextTier(Enum): - # Default context tier with standard context window size. - DEFAULT = "default" - # Extended context tier with a larger context window. - LONG_CONTEXT = "long_context" - - -class SessionResumeDataContextTier(Enum): - # Default context tier with standard context window size. - DEFAULT = "default" - # Extended context tier with a larger context window. - LONG_CONTEXT = "long_context" - - -class SessionStartDataContextTier(Enum): - # Default context tier with standard context window size. - DEFAULT = "default" - # Extended context tier with a larger context window. - LONG_CONTEXT = "long_context" - - class ShutdownType(Enum): "Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\")" # The session ended normally. @@ -6997,6 +10430,28 @@ class SystemNotificationAgentCompletedStatus(Enum): FAILED = "failed" +class SystemNotificationFactoryCompletedStatus(Enum): + "Terminal status reached by a factory execution attempt." + # The factory completed successfully. + COMPLETED = "completed" + # The factory was halted. + HALTED = "halted" + # The factory was cancelled. + CANCELLED = "cancelled" + # The factory failed. + ERROR = "error" + + +class TaskCompletionOutcome(Enum): + "Semantic result of evaluating a task completion request" + # The completion request was accepted and the objective is complete. + COMPLETED = "completed" + # The completion request was rejected because more work or validation remains. + CONTINUE = "continue" + # Completion cannot proceed without intervention; the active objective is paused when one is identified. + BLOCKED = "blocked" + + class ToolExecutionCompleteContentResourceLinkIconTheme(Enum): "Theme variant this icon is intended for" # Icon intended for light themes. @@ -7013,6 +10468,14 @@ class ToolExecutionCompleteToolDescriptionMetaUIVisibility(Enum): APP = "app" +class ToolExecutionStartToolDescriptionMetaUIVisibility(Enum): + "Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration." + # Tool is callable by the model (LLM tool surface) + MODEL = "model" + # Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool + APP = "app" + + class UserMessageAgentMode(Enum): "The agent mode that was active when this message was sent" # The agent is responding interactively to the user. @@ -7025,14 +10488,24 @@ class UserMessageAgentMode(Enum): SHELL = "shell" -class UserMessageAttachmentGithubReferenceType(Enum): - "Type of GitHub reference" - # GitHub issue reference. - ISSUE = "issue" - # GitHub pull request reference. - PR = "pr" - # GitHub discussion reference. - DISCUSSION = "discussion" +class UserMessageDelivery(Enum): + "How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn." + # Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). + IDLE = "idle" + # Injected into the current in-flight run while the agent was busy (immediate mode). + STEERING = "steering" + # Enqueued while the agent was busy; processed as its own run afterward. + QUEUED = "queued" + + +class Verbosity(Enum): + "Output verbosity level used for supported model calls (e.g. \"low\", \"medium\", \"high\")" + # A terse response was requested. + LOW = "low" + # A medium amount of response detail was requested. + MEDIUM = "medium" + # A more detailed response was requested. + HIGH = "high" class WorkingDirectoryContextHostType(Enum): @@ -7051,7 +10524,7 @@ class WorkspaceFileChangedOperation(Enum): UPDATE = "update" -SessionEventData = SessionStartData | SessionResumeData | SessionRemoteSteerableChangedData | SessionErrorData | SessionIdleData | SessionTitleChangedData | SessionScheduleCreatedData | SessionScheduleCancelledData | SessionAutopilotObjectiveChangedData | SessionInfoData | SessionWarningData | SessionModelChangeData | SessionModeChangedData | SessionPermissionsChangedData | 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 | HookProgressData | SystemMessageData | SystemNotificationData | PermissionRequestedData | PermissionCompletedData | UserInputRequestedData | UserInputCompletedData | ElicitationRequestedData | ElicitationCompletedData | SamplingRequestedData | SamplingCompletedData | McpOauthRequiredData | McpOauthCompletedData | SessionCustomNotificationData | ExternalToolRequestedData | ExternalToolCompletedData | CommandQueuedData | CommandExecuteData | CommandCompletedData | AutoModeSwitchRequestedData | AutoModeSwitchCompletedData | CommandsChangedData | CapabilitiesChangedData | ExitPlanModeRequestedData | ExitPlanModeCompletedData | SessionToolsUpdatedData | SessionBackgroundTasksChangedData | SessionSkillsLoadedData | SessionCustomAgentsUpdatedData | SessionMcpServersLoadedData | SessionMcpServerStatusChangedData | SessionExtensionsLoadedData | SessionCanvasOpenedData | SessionCanvasRegistryChangedData | McpAppToolCallCompleteData | RawSessionEventData | Data +SessionEventData = SessionStartData | SessionResumeData | SessionRemoteSteerableChangedData | SessionErrorData | SessionIdleData | SessionTitleChangedData | SessionScheduleCreatedData | SessionScheduleCancelledData | SessionScheduleRearmedData | SessionAutopilotObjectiveChangedData | SessionInfoData | SessionWarningData | SessionModelChangeData | SessionModeChangedData | SessionSessionLimitsChangedData | SessionPermissionsChangedData | SessionPlanChangedData | SessionTodosChangedData | SessionWorkspaceFileChangedData | SessionHandoffData | SessionTruncationData | SessionSnapshotRewindData | SessionShutdownData | SessionUsageCheckpointData | SessionContextChangedData | SessionUsageInfoData | SessionContextClearedData | SessionCompactionStartData | SessionCompactionCompleteData | SessionTaskCompleteData | UserMessageData | PendingMessagesModifiedData | AssistantTurnStartData | AssistantTurnRetryData | AssistantIntentData | AssistantServerToolProgressData | AssistantReasoningData | AssistantReasoningDeltaData | AssistantToolCallDeltaData | AssistantStreamingDeltaData | AssistantMessageData | AssistantMessageStartData | AssistantMessageDeltaData | AssistantTurnEndData | AssistantIdleData | AssistantUsageData | ModelCallFailureData | ModelCallStartData | AbortData | ToolUserRequestedData | ToolExecutionStartData | ToolExecutionPartialResultData | ToolExecutionProgressData | ToolExecutionCompleteData | ToolSearchActivatedData | SkillInvokedData | SubagentStartedData | SubagentCompletedData | SubagentFailedData | SubagentSelectedData | SubagentDeselectedData | HookStartData | HookEndData | HookProgressData | SessionBinaryAssetData | SystemMessageData | SystemNotificationData | PermissionRequestedData | PermissionCompletedData | UserInputRequestedData | UserInputCompletedData | ElicitationRequestedData | ElicitationCompletedData | SamplingRequestedData | SamplingCompletedData | McpOauthRequiredData | McpOauthCompletedData | McpHeadersRefreshRequiredData | McpHeadersRefreshCompletedData | SessionCustomNotificationData | ExternalToolRequestedData | ExternalToolCompletedData | CommandQueuedData | CommandExecuteData | CommandCompletedData | AutoModeSwitchRequestedData | AutoModeSwitchCompletedData | SessionLimitsExhaustedRequestedData | SessionLimitsExhaustedCompletedData | SessionAutoModeResolvedData | SessionManagedSettingsResolvedData | SessionManagedSettingsEnforcedData | CommandsChangedData | CapabilitiesChangedData | ExitPlanModeRequestedData | ExitPlanModeCompletedData | SessionToolsUpdatedData | SessionBackgroundTasksChangedData | FactoryRunUpdatedData | SessionSkillsLoadedData | SessionCustomAgentsUpdatedData | SessionMcpServersLoadedData | SessionMcpServerStatusChangedData | McpToolsListChangedData | McpResourcesListChangedData | McpPromptsListChangedData | SessionExtensionsLoadedData | SessionCanvasOpenedData | SessionCanvasRegistryChangedData | SessionCanvasClosedData | SessionCanvasUnavailableData | SessionCanvasRecordedData | SessionCanvasRemovedData | SessionExtensionsAttachmentsPushedData | McpAppToolCallCompleteData | RawSessionEventData | Data @dataclass @@ -7085,42 +10558,53 @@ def from_dict(obj: Any) -> "SessionEvent": case SessionEventType.SESSION_TITLE_CHANGED: data = SessionTitleChangedData.from_dict(data_obj) case SessionEventType.SESSION_SCHEDULE_CREATED: data = SessionScheduleCreatedData.from_dict(data_obj) case SessionEventType.SESSION_SCHEDULE_CANCELLED: data = SessionScheduleCancelledData.from_dict(data_obj) + case SessionEventType.SESSION_SCHEDULE_REARMED: data = SessionScheduleRearmedData.from_dict(data_obj) case SessionEventType.SESSION_AUTOPILOT_OBJECTIVE_CHANGED: data = SessionAutopilotObjectiveChangedData.from_dict(data_obj) case SessionEventType.SESSION_INFO: data = SessionInfoData.from_dict(data_obj) case SessionEventType.SESSION_WARNING: data = SessionWarningData.from_dict(data_obj) case SessionEventType.SESSION_MODEL_CHANGE: data = SessionModelChangeData.from_dict(data_obj) case SessionEventType.SESSION_MODE_CHANGED: data = SessionModeChangedData.from_dict(data_obj) + case SessionEventType.SESSION_SESSION_LIMITS_CHANGED: data = SessionSessionLimitsChangedData.from_dict(data_obj) case SessionEventType.SESSION_PERMISSIONS_CHANGED: data = SessionPermissionsChangedData.from_dict(data_obj) case SessionEventType.SESSION_PLAN_CHANGED: data = SessionPlanChangedData.from_dict(data_obj) + case SessionEventType.SESSION_TODOS_CHANGED: data = SessionTodosChangedData.from_dict(data_obj) case SessionEventType.SESSION_WORKSPACE_FILE_CHANGED: data = SessionWorkspaceFileChangedData.from_dict(data_obj) case SessionEventType.SESSION_HANDOFF: data = SessionHandoffData.from_dict(data_obj) case SessionEventType.SESSION_TRUNCATION: data = SessionTruncationData.from_dict(data_obj) case SessionEventType.SESSION_SNAPSHOT_REWIND: data = SessionSnapshotRewindData.from_dict(data_obj) case SessionEventType.SESSION_SHUTDOWN: data = SessionShutdownData.from_dict(data_obj) + case SessionEventType.SESSION_USAGE_CHECKPOINT: data = SessionUsageCheckpointData.from_dict(data_obj) case SessionEventType.SESSION_CONTEXT_CHANGED: data = SessionContextChangedData.from_dict(data_obj) case SessionEventType.SESSION_USAGE_INFO: data = SessionUsageInfoData.from_dict(data_obj) + case SessionEventType.SESSION_CONTEXT_CLEARED: data = SessionContextClearedData.from_dict(data_obj) case SessionEventType.SESSION_COMPACTION_START: data = SessionCompactionStartData.from_dict(data_obj) case SessionEventType.SESSION_COMPACTION_COMPLETE: data = SessionCompactionCompleteData.from_dict(data_obj) case SessionEventType.SESSION_TASK_COMPLETE: data = SessionTaskCompleteData.from_dict(data_obj) case SessionEventType.USER_MESSAGE: data = UserMessageData.from_dict(data_obj) case SessionEventType.PENDING_MESSAGES_MODIFIED: data = PendingMessagesModifiedData.from_dict(data_obj) case SessionEventType.ASSISTANT_TURN_START: data = AssistantTurnStartData.from_dict(data_obj) + case SessionEventType.ASSISTANT_TURN_RETRY: data = AssistantTurnRetryData.from_dict(data_obj) case SessionEventType.ASSISTANT_INTENT: data = AssistantIntentData.from_dict(data_obj) + case SessionEventType.ASSISTANT_SERVER_TOOL_PROGRESS: data = AssistantServerToolProgressData.from_dict(data_obj) case SessionEventType.ASSISTANT_REASONING: data = AssistantReasoningData.from_dict(data_obj) case SessionEventType.ASSISTANT_REASONING_DELTA: data = AssistantReasoningDeltaData.from_dict(data_obj) + case SessionEventType.ASSISTANT_TOOL_CALL_DELTA: data = AssistantToolCallDeltaData.from_dict(data_obj) case SessionEventType.ASSISTANT_STREAMING_DELTA: data = AssistantStreamingDeltaData.from_dict(data_obj) case SessionEventType.ASSISTANT_MESSAGE: data = AssistantMessageData.from_dict(data_obj) case SessionEventType.ASSISTANT_MESSAGE_START: data = AssistantMessageStartData.from_dict(data_obj) case SessionEventType.ASSISTANT_MESSAGE_DELTA: data = AssistantMessageDeltaData.from_dict(data_obj) case SessionEventType.ASSISTANT_TURN_END: data = AssistantTurnEndData.from_dict(data_obj) + case SessionEventType.ASSISTANT_IDLE: data = AssistantIdleData.from_dict(data_obj) case SessionEventType.ASSISTANT_USAGE: data = AssistantUsageData.from_dict(data_obj) case SessionEventType.MODEL_CALL_FAILURE: data = ModelCallFailureData.from_dict(data_obj) + case SessionEventType.MODEL_CALL_START: data = ModelCallStartData.from_dict(data_obj) case SessionEventType.ABORT: data = AbortData.from_dict(data_obj) case SessionEventType.TOOL_USER_REQUESTED: data = ToolUserRequestedData.from_dict(data_obj) case SessionEventType.TOOL_EXECUTION_START: data = ToolExecutionStartData.from_dict(data_obj) case SessionEventType.TOOL_EXECUTION_PARTIAL_RESULT: data = ToolExecutionPartialResultData.from_dict(data_obj) case SessionEventType.TOOL_EXECUTION_PROGRESS: data = ToolExecutionProgressData.from_dict(data_obj) case SessionEventType.TOOL_EXECUTION_COMPLETE: data = ToolExecutionCompleteData.from_dict(data_obj) + case SessionEventType.TOOL_SEARCH_ACTIVATED: data = ToolSearchActivatedData.from_dict(data_obj) case SessionEventType.SKILL_INVOKED: data = SkillInvokedData.from_dict(data_obj) case SessionEventType.SUBAGENT_STARTED: data = SubagentStartedData.from_dict(data_obj) case SessionEventType.SUBAGENT_COMPLETED: data = SubagentCompletedData.from_dict(data_obj) @@ -7130,6 +10614,7 @@ def from_dict(obj: Any) -> "SessionEvent": case SessionEventType.HOOK_START: data = HookStartData.from_dict(data_obj) case SessionEventType.HOOK_END: data = HookEndData.from_dict(data_obj) case SessionEventType.HOOK_PROGRESS: data = HookProgressData.from_dict(data_obj) + case SessionEventType.SESSION_BINARY_ASSET: data = SessionBinaryAssetData.from_dict(data_obj) case SessionEventType.SYSTEM_MESSAGE: data = SystemMessageData.from_dict(data_obj) case SessionEventType.SYSTEM_NOTIFICATION: data = SystemNotificationData.from_dict(data_obj) case SessionEventType.PERMISSION_REQUESTED: data = PermissionRequestedData.from_dict(data_obj) @@ -7142,6 +10627,8 @@ def from_dict(obj: Any) -> "SessionEvent": case SessionEventType.SAMPLING_COMPLETED: data = SamplingCompletedData.from_dict(data_obj) case SessionEventType.MCP_OAUTH_REQUIRED: data = McpOauthRequiredData.from_dict(data_obj) case SessionEventType.MCP_OAUTH_COMPLETED: data = McpOauthCompletedData.from_dict(data_obj) + case SessionEventType.MCP_HEADERS_REFRESH_REQUIRED: data = McpHeadersRefreshRequiredData.from_dict(data_obj) + case SessionEventType.MCP_HEADERS_REFRESH_COMPLETED: data = McpHeadersRefreshCompletedData.from_dict(data_obj) case SessionEventType.SESSION_CUSTOM_NOTIFICATION: data = SessionCustomNotificationData.from_dict(data_obj) case SessionEventType.EXTERNAL_TOOL_REQUESTED: data = ExternalToolRequestedData.from_dict(data_obj) case SessionEventType.EXTERNAL_TOOL_COMPLETED: data = ExternalToolCompletedData.from_dict(data_obj) @@ -7150,19 +10637,33 @@ def from_dict(obj: Any) -> "SessionEvent": case SessionEventType.COMMAND_COMPLETED: data = CommandCompletedData.from_dict(data_obj) case SessionEventType.AUTO_MODE_SWITCH_REQUESTED: data = AutoModeSwitchRequestedData.from_dict(data_obj) case SessionEventType.AUTO_MODE_SWITCH_COMPLETED: data = AutoModeSwitchCompletedData.from_dict(data_obj) + case SessionEventType.SESSION_LIMITS_EXHAUSTED_REQUESTED: data = SessionLimitsExhaustedRequestedData.from_dict(data_obj) + case SessionEventType.SESSION_LIMITS_EXHAUSTED_COMPLETED: data = SessionLimitsExhaustedCompletedData.from_dict(data_obj) + case SessionEventType.SESSION_AUTO_MODE_RESOLVED: data = SessionAutoModeResolvedData.from_dict(data_obj) + case SessionEventType.SESSION_MANAGED_SETTINGS_RESOLVED: data = SessionManagedSettingsResolvedData.from_dict(data_obj) + case SessionEventType.SESSION_MANAGED_SETTINGS_ENFORCED: data = SessionManagedSettingsEnforcedData.from_dict(data_obj) case SessionEventType.COMMANDS_CHANGED: data = CommandsChangedData.from_dict(data_obj) case SessionEventType.CAPABILITIES_CHANGED: data = CapabilitiesChangedData.from_dict(data_obj) case SessionEventType.EXIT_PLAN_MODE_REQUESTED: data = ExitPlanModeRequestedData.from_dict(data_obj) case SessionEventType.EXIT_PLAN_MODE_COMPLETED: data = ExitPlanModeCompletedData.from_dict(data_obj) case SessionEventType.SESSION_TOOLS_UPDATED: data = SessionToolsUpdatedData.from_dict(data_obj) case SessionEventType.SESSION_BACKGROUND_TASKS_CHANGED: data = SessionBackgroundTasksChangedData.from_dict(data_obj) + case SessionEventType.FACTORY_RUN_UPDATED: data = FactoryRunUpdatedData.from_dict(data_obj) case SessionEventType.SESSION_SKILLS_LOADED: data = SessionSkillsLoadedData.from_dict(data_obj) case SessionEventType.SESSION_CUSTOM_AGENTS_UPDATED: data = SessionCustomAgentsUpdatedData.from_dict(data_obj) case SessionEventType.SESSION_MCP_SERVERS_LOADED: data = SessionMcpServersLoadedData.from_dict(data_obj) case SessionEventType.SESSION_MCP_SERVER_STATUS_CHANGED: data = SessionMcpServerStatusChangedData.from_dict(data_obj) + case SessionEventType.MCP_TOOLS_LIST_CHANGED: data = McpToolsListChangedData.from_dict(data_obj) + case SessionEventType.MCP_RESOURCES_LIST_CHANGED: data = McpResourcesListChangedData.from_dict(data_obj) + case SessionEventType.MCP_PROMPTS_LIST_CHANGED: data = McpPromptsListChangedData.from_dict(data_obj) case SessionEventType.SESSION_EXTENSIONS_LOADED: data = SessionExtensionsLoadedData.from_dict(data_obj) case SessionEventType.SESSION_CANVAS_OPENED: data = SessionCanvasOpenedData.from_dict(data_obj) case SessionEventType.SESSION_CANVAS_REGISTRY_CHANGED: data = SessionCanvasRegistryChangedData.from_dict(data_obj) + case SessionEventType.SESSION_CANVAS_CLOSED: data = SessionCanvasClosedData.from_dict(data_obj) + case SessionEventType.SESSION_CANVAS_UNAVAILABLE: data = SessionCanvasUnavailableData.from_dict(data_obj) + case SessionEventType.SESSION_CANVAS_RECORDED: data = SessionCanvasRecordedData.from_dict(data_obj) + case SessionEventType.SESSION_CANVAS_REMOVED: data = SessionCanvasRemovedData.from_dict(data_obj) + case SessionEventType.SESSION_EXTENSIONS_ATTACHMENTS_PUSHED: data = SessionExtensionsAttachmentsPushedData.from_dict(data_obj) case SessionEventType.MCP_APP_TOOL_CALL_COMPLETE: data = McpAppToolCallCompleteData.from_dict(data_obj) case _: data = RawSessionEventData.from_dict(data_obj) return SessionEvent( @@ -7197,3 +10698,352 @@ def session_event_from_dict(s: Any) -> SessionEvent: def session_event_to_dict(x: SessionEvent) -> Any: return x.to_dict() +__all__ = [ + "AbortData", + "AbortReason", + "AssistantIdleData", + "AssistantIntentData", + "AssistantMessageData", + "AssistantMessageDeltaData", + "AssistantMessageServerTools", + "AssistantMessageStartData", + "AssistantMessageToolRequest", + "AssistantMessageToolRequestType", + "AssistantReasoningData", + "AssistantReasoningDeltaData", + "AssistantServerToolProgressData", + "AssistantStreamingDeltaData", + "AssistantToolCallDeltaData", + "AssistantTurnEndData", + "AssistantTurnRetryData", + "AssistantTurnStartData", + "AssistantUsageApiEndpoint", + "AssistantUsageCopilotUsage", + "AssistantUsageCopilotUsageTokenDetail", + "AssistantUsageData", + "Attachment", + "AttachmentBlob", + "AttachmentDirectory", + "AttachmentExtensionContext", + "AttachmentFile", + "AttachmentFileLineRange", + "AttachmentGitHubActionsJob", + "AttachmentGitHubCommit", + "AttachmentGitHubFile", + "AttachmentGitHubFileDiff", + "AttachmentGitHubFileDiffSide", + "AttachmentGitHubReference", + "AttachmentGitHubReferenceType", + "AttachmentGitHubRelease", + "AttachmentGitHubRepository", + "AttachmentGitHubSnippet", + "AttachmentGitHubTreeComparison", + "AttachmentGitHubTreeComparisonSide", + "AttachmentGitHubUrl", + "AttachmentSelection", + "AttachmentSelectionDetails", + "AttachmentSelectionDetailsEnd", + "AttachmentSelectionDetailsStart", + "AutoApprovalJudgeFailureReason", + "AutoApprovalRecommendation", + "AutoModeResolvedReasoningBucket", + "AutoModeSwitchCompletedData", + "AutoModeSwitchRequestedData", + "AutoModeSwitchResponse", + "AutopilotObjectiveChangedOperation", + "AutopilotObjectiveChangedStatus", + "BinaryAssetReference", + "BinaryAssetReferenceType", + "BinaryAssetType", + "CanvasRegistryChangedCanvas", + "CanvasRegistryChangedCanvasAction", + "CapabilitiesChangedData", + "CapabilitiesChangedUI", + "CitableSource", + "CitationLocation", + "CitationLocationBlock", + "CitationLocationChar", + "CitationLocationPage", + "CitationProvider", + "CitationReference", + "CitationSource", + "CitationSpan", + "Citations", + "CommandCompletedData", + "CommandExecuteData", + "CommandQueuedData", + "CommandsChangedCommand", + "CommandsChangedData", + "CompactionCompleteCompactionTokensUsed", + "CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail", + "CompactionTrigger", + "ContextTier", + "CustomAgentsUpdatedAgent", + "Data", + "ElicitationCompletedAction", + "ElicitationCompletedData", + "ElicitationRequestedData", + "ElicitationRequestedMode", + "ElicitationRequestedSchema", + "EmbeddedBlobResourceContents", + "EmbeddedTextResourceContents", + "ExitPlanModeAction", + "ExitPlanModeCompletedData", + "ExitPlanModeRequestedData", + "ExtensionsLoadedExtension", + "ExtensionsLoadedExtensionSource", + "ExtensionsLoadedExtensionStatus", + "ExternalToolCompletedData", + "ExternalToolRequestedData", + "FactoryPermissionOperation", + "FactoryPermissionPhase", + "FactoryRunUpdatedData", + "GitHubMcpToolConfig", + "GitHubRepoRef", + "HandoffRepository", + "HandoffSourceType", + "HeaderEntry", + "HookEndData", + "HookEndError", + "HookProgressData", + "HookStartData", + "ManagedSettingsEnforcedAction", + "ManagedSettingsEnforcedEscalation", + "ManagedSettingsResolvedSource", + "McpAppToolCallCompleteData", + "McpAppToolCallCompleteError", + "McpAppToolCallCompleteToolMeta", + "McpAppToolCallCompleteToolMetaUI", + "McpHeadersRefreshCompletedData", + "McpHeadersRefreshCompletedOutcome", + "McpHeadersRefreshRequiredData", + "McpHeadersRefreshRequiredReason", + "McpOauthCompletedData", + "McpOauthCompletionOutcome", + "McpOauthHttpResponse", + "McpOauthRequestReason", + "McpOauthRequiredData", + "McpOauthRequiredStaticClientConfig", + "McpOauthWWWAuthenticateParams", + "McpPromptsListChangedData", + "McpResourcesListChangedData", + "McpServerSource", + "McpServerStatus", + "McpServerTransport", + "McpServersLoadedServer", + "McpToolsListChangedData", + "ModelCallFailureBadRequestKind", + "ModelCallFailureData", + "ModelCallFailureKind", + "ModelCallFailureRequestFingerprint", + "ModelCallFailureSource", + "ModelCallFailureTransport", + "ModelCallStartData", + "OmittedBinaryOmittedReason", + "OmittedBinaryResult", + "OmittedBinaryType", + "PendingMessagesModifiedData", + "PermissionAllowAllMode", + "PermissionApproved", + "PermissionApprovedForLocation", + "PermissionApprovedForSession", + "PermissionAutoApproval", + "PermissionCancelled", + "PermissionCompletedData", + "PermissionDeniedByContentExclusionPolicy", + "PermissionDeniedByPermissionRequestHook", + "PermissionDeniedByRules", + "PermissionDeniedInteractivelyByUser", + "PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser", + "PermissionPromptRequest", + "PermissionPromptRequestCommands", + "PermissionPromptRequestCustomTool", + "PermissionPromptRequestExtensionManagement", + "PermissionPromptRequestExtensionPermissionAccess", + "PermissionPromptRequestFactory", + "PermissionPromptRequestHook", + "PermissionPromptRequestMcp", + "PermissionPromptRequestMemory", + "PermissionPromptRequestPath", + "PermissionPromptRequestPathAccessKind", + "PermissionPromptRequestRead", + "PermissionPromptRequestUrl", + "PermissionPromptRequestWrite", + "PermissionRequest", + "PermissionRequestCustomTool", + "PermissionRequestExtensionManagement", + "PermissionRequestExtensionPermissionAccess", + "PermissionRequestFactory", + "PermissionRequestHook", + "PermissionRequestMcp", + "PermissionRequestMemory", + "PermissionRequestMemoryAction", + "PermissionRequestMemoryDirection", + "PermissionRequestRead", + "PermissionRequestShell", + "PermissionRequestShellCommand", + "PermissionRequestShellCommandSegment", + "PermissionRequestShellPossibleUrl", + "PermissionRequestUrl", + "PermissionRequestWrite", + "PermissionRequestedData", + "PermissionResult", + "PermissionRule", + "PersistedBinaryImage", + "PersistedBinaryImageType", + "PersistedBinaryResult", + "PlanChangedOperation", + "RawSessionEventData", + "ReasoningSummary", + "SamplingCompletedData", + "SamplingRequestedData", + "ScheduleOrigin", + "SessionAutoModeResolvedData", + "SessionAutopilotObjectiveChangedData", + "SessionBackgroundTasksChangedData", + "SessionBinaryAssetData", + "SessionCanvasClosedData", + "SessionCanvasOpenedData", + "SessionCanvasRecordedData", + "SessionCanvasRegistryChangedData", + "SessionCanvasRemovedData", + "SessionCanvasUnavailableData", + "SessionCompactionCompleteData", + "SessionCompactionStartData", + "SessionContextChangedData", + "SessionContextClearedData", + "SessionCustomAgentsUpdatedData", + "SessionCustomNotificationData", + "SessionErrorData", + "SessionEvent", + "SessionEventData", + "SessionEventType", + "SessionExtensionsAttachmentsPushedData", + "SessionExtensionsLoadedData", + "SessionHandoffData", + "SessionIdleData", + "SessionInfoData", + "SessionLimitsConfig", + "SessionLimitsExhaustedCompletedData", + "SessionLimitsExhaustedRequestedData", + "SessionLimitsExhaustedResponse", + "SessionLimitsExhaustedResponseAction", + "SessionManagedSettingsEnforcedData", + "SessionManagedSettingsResolvedData", + "SessionMcpServerStatusChangedData", + "SessionMcpServersLoadedData", + "SessionMode", + "SessionModeChangedData", + "SessionModelChangeData", + "SessionPermissionsChangedData", + "SessionPlanChangedData", + "SessionRemoteSteerableChangedData", + "SessionResumeData", + "SessionScheduleCancelledData", + "SessionScheduleCreatedData", + "SessionScheduleRearmedData", + "SessionSessionLimitsChangedData", + "SessionShutdownData", + "SessionSkillsLoadedData", + "SessionSnapshotRewindData", + "SessionStartData", + "SessionTaskCompleteData", + "SessionTitleChangedData", + "SessionTodosChangedData", + "SessionToolsUpdatedData", + "SessionTruncationData", + "SessionUsageCheckpointData", + "SessionUsageInfoData", + "SessionWarningData", + "SessionWorkspaceFileChangedData", + "ShutdownCodeChanges", + "ShutdownModelMetric", + "ShutdownModelMetricRequests", + "ShutdownModelMetricTokenDetail", + "ShutdownModelMetricUsage", + "ShutdownTokenDetail", + "ShutdownType", + "SkillInvokedData", + "SkillInvokedTrigger", + "SkillSource", + "SkillsLoadedSkill", + "SubagentCompletedData", + "SubagentDeselectedData", + "SubagentFailedData", + "SubagentSelectedData", + "SubagentStartedData", + "SystemMessageData", + "SystemMessageMetadata", + "SystemMessageRole", + "SystemNotification", + "SystemNotificationAgentCompleted", + "SystemNotificationAgentCompletedStatus", + "SystemNotificationAgentIdle", + "SystemNotificationData", + "SystemNotificationFactoryCompleted", + "SystemNotificationFactoryCompletedStatus", + "SystemNotificationInstructionDiscovered", + "SystemNotificationNewInboxMessage", + "SystemNotificationShellCompleted", + "SystemNotificationShellDetachedCompleted", + "SystemNotificationUnclassified", + "TaskCompletionOutcome", + "ToolExecutionCompleteContent", + "ToolExecutionCompleteContentAudio", + "ToolExecutionCompleteContentImage", + "ToolExecutionCompleteContentResource", + "ToolExecutionCompleteContentResourceDetails", + "ToolExecutionCompleteContentResourceLink", + "ToolExecutionCompleteContentResourceLinkIcon", + "ToolExecutionCompleteContentResourceLinkIconTheme", + "ToolExecutionCompleteContentShellExit", + "ToolExecutionCompleteContentTerminal", + "ToolExecutionCompleteContentText", + "ToolExecutionCompleteData", + "ToolExecutionCompleteError", + "ToolExecutionCompleteResult", + "ToolExecutionCompleteToolDescription", + "ToolExecutionCompleteToolDescriptionMeta", + "ToolExecutionCompleteToolDescriptionMetaUI", + "ToolExecutionCompleteToolDescriptionMetaUIVisibility", + "ToolExecutionCompleteUIResource", + "ToolExecutionCompleteUIResourceMeta", + "ToolExecutionCompleteUIResourceMetaUI", + "ToolExecutionCompleteUIResourceMetaUICsp", + "ToolExecutionCompleteUIResourceMetaUIPermissions", + "ToolExecutionCompleteUIResourceMetaUIPermissionsCamera", + "ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite", + "ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation", + "ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone", + "ToolExecutionPartialResultData", + "ToolExecutionProgressData", + "ToolExecutionStartData", + "ToolExecutionStartShellToolInfo", + "ToolExecutionStartToolDescription", + "ToolExecutionStartToolDescriptionMeta", + "ToolExecutionStartToolDescriptionMetaUI", + "ToolExecutionStartToolDescriptionMetaUIVisibility", + "ToolSearchActivatedData", + "ToolUserRequestedData", + "UserInputCompletedData", + "UserInputRequestedData", + "UserMessageAgentMode", + "UserMessageData", + "UserMessageDelivery", + "UserToolSessionApproval", + "UserToolSessionApprovalCommands", + "UserToolSessionApprovalCustomTool", + "UserToolSessionApprovalExtensionManagement", + "UserToolSessionApprovalExtensionPermissionAccess", + "UserToolSessionApprovalFactory", + "UserToolSessionApprovalMcp", + "UserToolSessionApprovalMemory", + "UserToolSessionApprovalRead", + "UserToolSessionApprovalWrite", + "Verbosity", + "WorkingDirectoryContext", + "WorkingDirectoryContextHostType", + "WorkspaceFileChangedOperation", + "session_event_from_dict", + "session_event_to_dict", +] diff --git a/python/copilot/rpc.py b/python/copilot/rpc.py new file mode 100644 index 000000000..73c3d976d --- /dev/null +++ b/python/copilot/rpc.py @@ -0,0 +1,13 @@ +"""Public re-export of the JSON-RPC request/response types. + +These types are auto-generated from the Copilot CLI protocol schemas. This +module is the stable public access point so callers can write +``copilot.rpc.SessionUpdateOptionsParams`` without depending on the internal +``copilot.generated`` package layout. +""" + +from .generated.rpc import * # noqa: F401, F403 +from .generated.rpc import ( + SessionFsReaddirWithTypesEntryType as SessionFSReaddirWithTypesEntryType, # noqa: F401 +) +from .generated.rpc import __all__ # noqa: F401 diff --git a/python/copilot/session.py b/python/copilot/session.py index f9bbb24c3..2399ab36e 100644 --- a/python/copilot/session.py +++ b/python/copilot/session.py @@ -36,14 +36,19 @@ CanvasProviderOpenResult, ClientSessionApiHandlers, CommandsHandlePendingCommandRequest, - ExternalToolTextResultForLlm, HandlePendingToolCallRequest, LogRequest, + MCPOauthHandlePendingRequest, + MCPOauthPendingRequestResponse, + MCPOauthPendingRequestResponseKind, ModelSwitchToRequest, PermissionDecision, PermissionDecisionApproveOnce, + PermissionDecisionContext, PermissionDecisionRequest, PermissionDecisionUserNotAvailable, + ProviderTokenAcquireRequest, + ProviderTokenAcquireResult, SessionLogLevel, SessionRpc, UIElicitationRequest, @@ -55,6 +60,9 @@ UIElicitationSchemaType, UIHandlePendingElicitationRequest, ) +from .generated.rpc import ( + ContextTier as _RpcContextTier, +) from .generated.rpc import ModelCapabilitiesOverride as _RpcModelCapabilitiesOverride from .generated.session_events import ( AssistantMessageData, @@ -62,8 +70,10 @@ CommandExecuteData, ElicitationRequestedData, ExternalToolRequestedData, + McpOauthRequiredData, PermissionRequest, PermissionRequestedData, + SessionCanvasClosedData, SessionCanvasOpenedData, SessionErrorData, SessionEvent, @@ -73,13 +83,23 @@ from .generated.session_events import ( ReasoningSummary as _RpcReasoningSummary, ) -from .tools import Tool, ToolHandler, ToolInvocation, ToolResult +from .tools import ( + Tool, + ToolHandler, + ToolInvocation, + ToolResult, + tool_result_to_external_tool_text_result_for_llm, +) logger = logging.getLogger(__name__) +# Fixed name of the runtime's built-in tool-search tool. A client can replace +# its behavior by registering a tool with this exact name and +# ``overrides_built_in_tool=True``. +_TOOL_SEARCH_TOOL_NAME = "tool_search_tool" + if TYPE_CHECKING: - from .client import ModelCapabilitiesOverride from .session_fs_provider import SessionFsProvider # Re-export SessionEvent under an alias used internally @@ -89,7 +109,68 @@ # Reasoning Effort # ============================================================================ -ReasoningEffort = Literal["low", "medium", "high", "xhigh"] + +@dataclass +class ModelVisionLimitsOverride: + supported_media_types: list[str] | None = None + max_prompt_images: int | None = None + max_prompt_image_size: int | None = None + + +@dataclass +class ModelLimitsOverride: + max_prompt_tokens: int | None = None + max_output_tokens: int | None = None + max_context_window_tokens: int | None = None + vision: ModelVisionLimitsOverride | None = None + + +@dataclass +class ModelSupportsOverride: + vision: bool | None = None + reasoning_effort: bool | None = None + + +@dataclass +class ModelCapabilitiesOverride: + supports: ModelSupportsOverride | None = None + limits: ModelLimitsOverride | None = None + + +def _capabilities_to_dict(caps: ModelCapabilitiesOverride) -> dict: + result: dict = {} + if caps.supports is not None: + s: dict = {} + if caps.supports.vision is not None: + s["vision"] = caps.supports.vision + if caps.supports.reasoning_effort is not None: + s["reasoningEffort"] = caps.supports.reasoning_effort + if s: + result["supports"] = s + if caps.limits is not None: + lim: dict = {} + if caps.limits.max_prompt_tokens is not None: + lim["maxPromptTokens"] = caps.limits.max_prompt_tokens + if caps.limits.max_output_tokens is not None: + lim["maxOutputTokens"] = caps.limits.max_output_tokens + if caps.limits.max_context_window_tokens is not None: + lim["maxContextWindowTokens"] = caps.limits.max_context_window_tokens + if caps.limits.vision is not None: + v: dict = {} + if caps.limits.vision.supported_media_types is not None: + v["supportedMediaTypes"] = caps.limits.vision.supported_media_types + if caps.limits.vision.max_prompt_images is not None: + v["maxPromptImages"] = caps.limits.vision.max_prompt_images + if caps.limits.vision.max_prompt_image_size is not None: + v["maxPromptImageSize"] = caps.limits.vision.max_prompt_image_size + if v: + lim["vision"] = v + if lim: + result["limits"] = lim + return result + + +ReasoningEffort = Literal["low", "medium", "high", "xhigh", "max"] ReasoningSummary = Literal["none", "concise", "detailed"] ContextTier = Literal["default", "long_context"] SessionFsConventions = Literal["posix", "windows"] @@ -189,10 +270,17 @@ class SystemMessageReplaceConfig(TypedDict): SectionTransformFn = Callable[[str], str | Awaitable[str]] """Transform callback: receives current section content, returns new content.""" -SectionOverrideAction = Literal["replace", "remove", "append", "prepend"] | SectionTransformFn -"""Override action: a string literal for static overrides, or a callback for transforms.""" +SectionOverrideAction = ( + Literal["replace", "remove", "append", "prepend", "preserve"] | SectionTransformFn +) +"""Override action: a string literal for static overrides, or a callback for transforms. + +``"preserve"`` is a no-op marker that opts an individually-addressable section out of a +group-level ``"remove"`` (e.g. keep ``tone`` when removing the ``identity`` group). +""" SystemMessageSection = Literal[ + "preamble", "identity", "tone", "tool_efficiency", @@ -207,7 +295,11 @@ class SystemMessageReplaceConfig(TypedDict): ] SYSTEM_MESSAGE_SECTIONS: dict[SystemMessageSection, str] = { - "identity": "Agent identity preamble and mode statement", + "preamble": "Agent identity preamble and mode statement", + "identity": ( + "Section group covering the identity preamble and its sibling sub-sections" + " (tone, tool efficiency, etc.)" + ), "tone": "Response style, conciseness rules, output formatting preferences", "tool_efficiency": "Tool usage patterns, parallel calling, batching guidelines", "environment_context": "CWD, OS, git root, directory listing, available tools", @@ -256,12 +348,11 @@ class SystemMessageCustomizeConfig(TypedDict, total=False): @dataclass class PermissionNoResult: - """Sentinel returned by a permission handler to leave the request unanswered. + """Sentinel that leaves an event-dispatched permission request unanswered. - Only meaningful against protocol-v1 servers. v2 servers reject ``no-result`` - responses; the SDK raises :class:`ValueError` if a v2 server receives one. - Mirrors the ``{kind: "no-result"}`` extension TS adds to its ``PermissionDecision`` - union (see ``nodejs/src/types.ts:883``). + During event-based permission dispatch, the SDK suppresses its response so + another connected client, such as a human-facing host, can answer the pending + request. Legacy direct callbacks require a concrete decision and cannot abstain. """ kind: Literal["no-result"] = "no-result" @@ -269,27 +360,143 @@ class PermissionNoResult: # The decision returned by a permission handler. Identical shape to the wire # ``PermissionDecision`` discriminated union, plus a :class:`PermissionNoResult` -# sentinel for v1 servers. Construct via the generated variant classes: +# sentinel that suppresses this SDK client's response. Construct via the +# generated variant classes: # ``PermissionDecisionApproveOnce()``, ``PermissionDecisionReject(feedback=...)``, # etc. The ``kind`` discriminator is baked in as a ``ClassVar`` default by # codegen, so callers must not pass it. PermissionRequestResult = PermissionDecision | PermissionNoResult +@dataclass +class AttributedPermissionResult: + """A permission result annotated with the context describing how it was reached. + + The Copilot runtime emits an ``auto_approval_decision`` telemetry event only + when a client supplies an explicit :class:`PermissionDecisionContext` alongside + its permission reply. Wrapping a :data:`PermissionRequestResult` with this class + forwards that context to the runtime as a sibling of the decision on the wire. + + The context is informational only — it never changes permission behavior. Build + instances via :func:`create_attributed_permission_result` rather than constructing + directly, so re-attributing an already-wrapped result replaces the context instead + of nesting. + """ + + result: PermissionRequestResult + """The underlying permission decision (or :class:`PermissionNoResult`).""" + + decision_context: PermissionDecisionContext + """Context describing how and where the decision was reached.""" + + +def create_attributed_permission_result( + result: PermissionRequestResult | AttributedPermissionResult, + decision_context: PermissionDecisionContext, +) -> AttributedPermissionResult: + """Annotate a permission result with the context describing how it was reached. + + Returns an :class:`AttributedPermissionResult` carrying ``result`` and + ``decision_context`` as siblings. If ``result`` is already an + :class:`AttributedPermissionResult`, its underlying decision is preserved and the + context is *replaced* — attribution never nests. + """ + if isinstance(result, AttributedPermissionResult): + result = result.result + return AttributedPermissionResult(result=result, decision_context=decision_context) + + +class PermissionInvocation(TypedDict, total=False): + session_id: Required[str] + managed_settings_enabled: NotRequired[bool] + + _PermissionHandlerFn = Callable[ - [PermissionRequest, dict[str, str]], - PermissionRequestResult | Awaitable[PermissionRequestResult], + [PermissionRequest, PermissionInvocation], + PermissionRequestResult + | AttributedPermissionResult + | Awaitable[PermissionRequestResult | AttributedPermissionResult], ] class PermissionHandler: @staticmethod def approve_all( - request: PermissionRequest, invocation: dict[str, str] + request: PermissionRequest, invocation: PermissionInvocation ) -> PermissionRequestResult: + if invocation.get("managed_settings_enabled", False): + raise RuntimeError("approve_all cannot be used when managed settings are enabled") + if getattr(request, "managed_approval_required", False) is True: + return PermissionNoResult() return PermissionDecisionApproveOnce() +# ============================================================================ +# MCP Auth Types +# ============================================================================ + + +class McpAuthWwwAuthenticateParams(TypedDict, total=False): + """Parsed parameters from an MCP server's WWW-Authenticate response.""" + + resourceMetadataUrl: str + scope: str + error: str + + +class McpAuthStaticClientConfig(TypedDict, total=False): + """Static OAuth client configuration supplied by the MCP server, if available.""" + + clientId: Required[str] + clientSecret: str + grantType: Literal["client_credentials"] + publicClient: bool + + +class McpAuthRequest(TypedDict, total=False): + """MCP OAuth request that the SDK host can satisfy with a host-acquired token.""" + + requestId: Required[str] + serverName: Required[str] + serverUrl: Required[str] + reason: Required[Literal["initial", "refresh", "reauth", "upscope"]] + wwwAuthenticateParams: McpAuthWwwAuthenticateParams + resourceMetadata: str + staticClientConfig: McpAuthStaticClientConfig + + +class McpAuthToken(TypedDict, total=False): + """Host-provided OAuth token data for a pending MCP OAuth request.""" + + accessToken: Required[str] + tokenType: str + expiresIn: int + + +class McpAuthResult(TypedDict, total=False): + """Result returned by an MCP auth request handler.""" + + kind: Required[Literal["token", "cancelled"]] + accessToken: str + tokenType: str + expiresIn: int + + +class McpAuthContext(TypedDict): + """Context for an MCP auth request handler invocation.""" + + sessionId: str + + +McpAuthHandlerResult = McpAuthResult | McpAuthToken | None + + +McpAuthHandler = Callable[ + [McpAuthRequest, McpAuthContext], + McpAuthHandlerResult | Awaitable[McpAuthHandlerResult], +] + + # ============================================================================ # User Input Request Types # ============================================================================ @@ -791,6 +998,28 @@ class UserPromptSubmittedHookOutput(TypedDict, total=False): ] +class UserPromptTransformedHookInput(TypedDict): + """Input for the user-prompt-transformed hook.""" + + sessionId: str + timestamp: datetime + workingDirectory: str + prompt: str + transformedPrompt: str + + +class UserPromptTransformedHookOutput(TypedDict, total=False): + """Output for the user-prompt-transformed hook.""" + + modifiedTransformedPrompt: str + + +UserPromptTransformedHandler = Callable[ + [UserPromptTransformedHookInput, dict[str, str]], + UserPromptTransformedHookOutput | None | Awaitable[UserPromptTransformedHookOutput | None], +] + + class SessionStartHookInput(TypedDict): """Input for session-start hook""" @@ -865,6 +1094,30 @@ class ErrorOccurredHookOutput(TypedDict, total=False): ] +class AgentStopHookInput(TypedDict): + """Input for the agent-stop hook.""" + + sessionId: str + timestamp: datetime + workingDirectory: str + stopReason: NotRequired[str] + transcriptPath: NotRequired[str] + stopHookActive: NotRequired[bool] + + +class AgentStopHookOutput(TypedDict, total=False): + """Output for the agent-stop hook.""" + + decision: Literal["block"] + reason: str + + +AgentStopHandler = Callable[ + [AgentStopHookInput, dict[str, str]], + AgentStopHookOutput | None | Awaitable[AgentStopHookOutput | None], +] + + class SessionHooks(TypedDict, total=False): """Configuration for session hooks""" @@ -873,9 +1126,11 @@ class SessionHooks(TypedDict, total=False): on_post_tool_use: PostToolUseHandler on_post_tool_use_failure: PostToolUseFailureHandler on_user_prompt_submitted: UserPromptSubmittedHandler + on_user_prompt_transformed: UserPromptTransformedHandler on_session_start: SessionStartHandler on_session_end: SessionEndHandler on_error_occurred: ErrorOccurredHandler + on_agent_stop: AgentStopHandler # ============================================================================ @@ -907,6 +1162,22 @@ class MCPHTTPServerConfig(TypedDict, total=False): MCPServerConfig = MCPStdioServerConfig | MCPHTTPServerConfig + +class GitHubMcpToolConfig(TypedDict, total=False): + """Configuration for the built-in GitHub MCP server. + + ``disable_form_deferral`` only applies to the built-in GitHub MCP server + and only has an effect when MCP Apps and form-backed GitHub tools are + enabled. + """ + + enable_all_tools: bool + additional_toolsets: list[str] + additional_tools: list[str] + enable_insiders_mode: bool + disable_form_deferral: bool + + # ============================================================================ # Custom Agent Configuration Types # ============================================================================ @@ -928,6 +1199,9 @@ class CustomAgentConfig(TypedDict, total=False): skills: NotRequired[list[str]] # Model identifier (e.g. "claude-haiku-4.5"); runtime falls back to parent model if unavailable model: NotRequired[str] + # Reasoning effort for this agent's model. When omitted, the runtime resolves + # model configuration, then inherits the parent effort only for the same model. + reasoning_effort: NotRequired[ReasoningEffort] class DefaultAgentConfig(TypedDict, total=False): @@ -963,6 +1237,13 @@ class InfiniteSessionConfig(TypedDict, total=False): buffer_exhaustion_threshold: float +class SessionLimitsConfig(TypedDict, total=False): + """Experimental limits for the session's current accounting window.""" + + # Maximum AI credits available to the session in the current accounting window. + max_ai_credits: float + + class LargeToolOutputConfig(TypedDict, total=False): """ Configuration for handling large tool outputs. @@ -980,6 +1261,39 @@ class LargeToolOutputConfig(TypedDict, total=False): output_directory: str +class ToolSearchConfig(TypedDict, total=False): + """ + Override for the runtime's built-in tool-search behavior. + + Tool search lets the model discover tools on demand instead of loading every + tool definition up front. When the total tool count exceeds the deferral + threshold, MCP and external tools are marked as deferred and surfaced through + the built-in ``tool_search_tool``. + + To override the tool-search tool's implementation, register a :class:`Tool` + named ``tool_search_tool`` with ``overrides_built_in_tool=True``. To customize + the in-prompt tool-search guidance, use the ``tool_instructions`` section of + the system message in ``"customize"`` mode. + """ + + # Toggle that enables or disables tool search. + enabled: bool + # Overrides the total tool count at which MCP and external tools are + # automatically deferred behind tool search. + defer_threshold: int + + +class MemoryConfiguration(TypedDict): + """ + Configuration for session memory. + + Controls whether the session can read and write persistent memory. + """ + + # Whether memory is enabled for the session. + enabled: bool + + # ============================================================================ # Session Configuration # ============================================================================ @@ -988,7 +1302,36 @@ class LargeToolOutputConfig(TypedDict, total=False): class AzureProviderOptions(TypedDict, total=False): """Azure-specific provider configuration""" - api_version: str # Azure API version. Defaults to "2024-10-21". + # Azure API version. When omitted, the runtime uses the GA versionless v1 route. + api_version: str + + +class ProviderTokenArgs(TypedDict): + """Arguments passed to a :data:`BearerTokenProvider` callback when the runtime + needs a fresh bearer token for a BYOK provider. + + **Experimental.** Part of the bearer-token-provider surface and may change or + be removed in future SDK or CLI releases. + """ + + # Name of the BYOK provider needing a token. For the singular, whole-session + # ``provider`` this is the implicit provider name ("default"); for + # ``NamedProviderConfig`` entries it is ``NamedProviderConfig.name``. + provider_name: str + + # Id of the session that triggered this token request. A client-level shared + # callback registered for many sessions can use this to resolve the owning + # session and scope token acquisition or caching per session. + session_id: str + + +# Per-request callback that resolves a bearer token on demand for a BYOK +# provider (for example via Azure Managed Identity). The Copilot SDK takes no +# identity dependency: supply a callback backed by your own identity library. +# Never serialized — setting it makes the SDK send ``hasBearerTokenProvider`` on +# the wire and answer the runtime's ``providerToken.getToken`` requests. May be +# sync or async. +BearerTokenProvider = Callable[[ProviderTokenArgs], str | Awaitable[str]] class ProviderConfig(TypedDict, total=False): @@ -996,6 +1339,11 @@ class ProviderConfig(TypedDict, total=False): type: Literal["openai", "azure", "anthropic"] wire_api: Literal["completions", "responses"] + # Transport for OpenAI Responses requests. Defaults to "http". Set + # "websockets" to deliver Responses API requests over a persistent WebSocket + # connection instead of HTTP. Applies to OpenAI-compatible providers using + # wire_api "responses". + transport: Literal["http", "websockets"] base_url: str api_key: str # Bearer token for authentication. Sets the Authorization header directly. @@ -1022,6 +1370,76 @@ class ProviderConfig(TypedDict, total=False): # Overrides the resolved model's default max output tokens. When hit, the # model stops generating and returns a truncated response. max_output_tokens: int + # Per-request callback that resolves a bearer token on demand for this BYOK + # provider (for example via Azure Managed Identity). Never serialized — the + # SDK sends hasBearerTokenProvider: true on the wire and answers the + # runtime's providerToken.getToken requests with this callback's result. + # When set alongside api_key/bearer_token, this callback takes precedence: the + # runtime applies the token it returns as the Authorization: Bearer header for + # each request and does not send the static credential. + bearer_token_provider: BearerTokenProvider + + +class NamedProviderConfig(TypedDict, total=False): + """A named BYOK provider connection (transport + credentials). + + Referenced by :class:`ProviderModelConfig` entries via ``name``. Unlike the + singular :class:`ProviderConfig` (which makes the whole session BYOK and + bypasses Copilot API authentication), named providers are additive: they + coexist with Copilot API auth so models from CAPI and one or more BYOK + providers can be mixed within a single session and across sub-agents. + + **Experimental.** Multi-provider BYOK configuration is experimental and may + change or be removed in future SDK or CLI releases. + """ + + # Stable identifier referenced by ProviderModelConfig.provider. Must not contain "/". + name: str + type: Literal["openai", "azure", "anthropic"] + wire_api: Literal["completions", "responses"] + base_url: str + api_key: str + # Bearer token for authentication. Sets the Authorization header directly. + # Takes precedence over api_key when both are set. + bearer_token: str + azure: AzureProviderOptions # Azure-specific options + headers: dict[str, str] + # Per-request bearer-token callback for this named BYOK provider. Never + # serialized; the SDK sends hasBearerTokenProvider: true and answers the + # runtime's providerToken.getToken requests. When set alongside + # api_key/bearer_token, this callback takes precedence: the runtime applies + # the token it returns as the Authorization: Bearer header for each request + # and does not send the static credential. + bearer_token_provider: BearerTokenProvider + + +class ProviderModelConfig(TypedDict, total=False): + """A BYOK model definition that references a :class:`NamedProviderConfig`. + + Added to the session's selectable model list. The session-wide selection id + (shown in the model list and passed to model switching) is the + provider-qualified ``provider/id``, so BYOK ids never collide with bare CAPI + ids. + + **Experimental.** Multi-provider BYOK configuration is experimental and may + change or be removed in future SDK or CLI releases. + """ + + # Provider-local model id, unique within its provider. + id: str + # Name of the NamedProviderConfig that serves this model. + provider: str + # Model name sent to the provider API for inference. Defaults to id. + wire_model: str + # Well-known base model id used for behavior/capability/config lookup. Defaults to id. + model_id: str + # Display name for model pickers. Defaults to the provider-qualified selection id. + name: str + max_prompt_tokens: int + max_context_window_tokens: int + max_output_tokens: int + # Optional capability overrides for the synthesized model. + capabilities: ModelCapabilitiesOverride SessionEventHandler = Callable[[SessionEvent], None] @@ -1064,6 +1482,38 @@ def _canvas_handler_error(err: Exception) -> JsonRpcError: ) +class _BearerTokenProviderAdapter: + """Routes runtime ``providerToken.getToken`` requests to the matching + per-provider :data:`BearerTokenProvider` callback registered on the session. + + The runtime calls this once per outbound request for a BYOK provider that + declared ``hasBearerTokenProvider: true``; it does no caching, so the SDK + consumer's callback (typically backed by an identity library) owns + acquisition, caching, and refresh. + """ + + def __init__(self, session: CopilotSession) -> None: + self._session = session + + async def get_token(self, params: ProviderTokenAcquireRequest) -> ProviderTokenAcquireResult: + provider_name = params.provider_name + with self._session._bearer_token_providers_lock: + callback = self._session._bearer_token_providers.get(provider_name) + if callback is None: + raise JsonRpcError( + -32603, + f"No bearer-token provider registered for provider: {provider_name!r}", + ) + args: ProviderTokenArgs = { + "provider_name": provider_name, + "session_id": params.session_id, + } + result = callback(args) + if inspect.isawaitable(result): + result = await result + return ProviderTokenAcquireResult(token=cast(str, result)) + + class CopilotSession: """ Represents a single conversation session with the Copilot CLI. @@ -1093,7 +1543,11 @@ class CopilotSession: """ def __init__( - self, session_id: str, client: Any, workspace_path: os.PathLike[str] | str | None = None + self, + session_id: str, + client: Any, + workspace_path: os.PathLike[str] | str | None = None, + managed_settings_enabled: bool = False, ): """ Initialize a new CopilotSession. @@ -1107,8 +1561,11 @@ def __init__( client: The internal client connection to the Copilot CLI. workspace_path: Path to the session workspace directory (when infinite sessions enabled). + managed_settings_enabled: Whether managed settings were enabled when + creating or resuming the session. """ self.session_id = session_id + self._managed_settings_enabled = managed_settings_enabled self._client = client self._workspace_path = os.fsdecode(workspace_path) if workspace_path is not None else None self._event_handlers: set[Callable[[SessionEvent], None]] = set() @@ -1117,6 +1574,8 @@ def __init__( self._tool_handlers_lock = threading.Lock() self._permission_handler: _PermissionHandlerFn | None = None self._permission_handler_lock = threading.Lock() + self._mcp_auth_handler: McpAuthHandler | None = None + self._mcp_auth_handler_lock = threading.Lock() self._user_input_handler: UserInputHandler | None = None self._user_input_handler_lock = threading.Lock() self._exit_plan_mode_handler: ExitPlanModeHandler | None = None @@ -1129,6 +1588,8 @@ def __init__( self._transform_callbacks_lock = threading.Lock() self._command_handlers: dict[str, CommandHandler] = {} self._command_handlers_lock = threading.Lock() + self._bearer_token_providers: dict[str, BearerTokenProvider] = {} + self._bearer_token_providers_lock = threading.Lock() self._elicitation_handler: ElicitationHandler | None = None self._elicitation_handler_lock = threading.Lock() self._capabilities: SessionCapabilities = {} @@ -1293,7 +1754,7 @@ async def send_and_wait( Exception: If the session has been disconnected or the connection fails. Example: - >>> from copilot.generated.session_events import AssistantMessageData + >>> from copilot.session_events import AssistantMessageData >>> response = await session.send_and_wait("What is 2+2?") >>> if response: ... match response.data: @@ -1393,7 +1854,7 @@ def on(self, handler: Callable[[SessionEvent], None]) -> Callable[[], None]: A function that, when called, unsubscribes the handler. Example: - >>> from copilot.generated.session_events import AssistantMessageData, SessionErrorData + >>> from copilot.session_events import AssistantMessageData, SessionErrorData >>> def handle_event(event): ... match event.data: ... case AssistantMessageData() as data: @@ -1504,6 +1965,58 @@ def _handle_broadcast_event(self, event: SessionEvent) -> None: ) ) + case McpOauthRequiredData() as data: + with self._mcp_auth_handler_lock: + handler = self._mcp_auth_handler + if not data.request_id: + return + if not handler: + logger.warning( + "Received MCP OAuth request without a registered MCP auth handler. " + "SessionId=%s, RequestId=%s", + self.session_id, + data.request_id, + ) + return + request: McpAuthRequest = { + "requestId": data.request_id, + "serverName": data.server_name, + "serverUrl": data.server_url, + "reason": data.reason.value, + } + if data.www_authenticate_params is not None: + request["wwwAuthenticateParams"] = {} + if data.www_authenticate_params.resource_metadata_url is not None: + request["wwwAuthenticateParams"]["resourceMetadataUrl"] = ( + data.www_authenticate_params.resource_metadata_url + ) + if data.www_authenticate_params.scope is not None: + request["wwwAuthenticateParams"]["scope"] = ( + data.www_authenticate_params.scope + ) + if data.www_authenticate_params.error is not None: + request["wwwAuthenticateParams"]["error"] = ( + data.www_authenticate_params.error + ) + if data.resource_metadata is not None: + request["resourceMetadata"] = data.resource_metadata + if data.static_client_config is not None: + static_client_config: McpAuthStaticClientConfig = { + "clientId": data.static_client_config.client_id, + } + if data.static_client_config.client_secret is not None: + static_client_config["clientSecret"] = ( + data.static_client_config.client_secret + ) + if data.static_client_config.grant_type is not None: + static_client_config["grantType"] = data.static_client_config.grant_type + if data.static_client_config.public_client is not None: + static_client_config["publicClient"] = ( + data.static_client_config.public_client + ) + request["staticClientConfig"] = static_client_config + asyncio.ensure_future(self._execute_mcp_auth_and_respond(request, handler)) + case CommandExecuteData() as data: request_id = data.request_id command_name = data.command_name @@ -1550,17 +2063,20 @@ def _handle_broadcast_event(self, event: SessionEvent) -> None: case SessionCanvasOpenedData() as data: try: - if ( - not data.instance_id - or not data.canvas_id - or not data.extension_id - or data.availability is None - ): + if not data.instance_id or not data.canvas_id or not data.extension_id: raise ValueError("missing required open canvas fields") self._upsert_open_canvas(OpenCanvasInstance.from_dict(data.to_dict())) except Exception as exc: logger.warning("failed to deserialize session.canvas.opened payload: %s", exc) + case SessionCanvasClosedData() as data: + try: + if not data.instance_id: + raise ValueError("missing required closed canvas fields") + self._remove_open_canvas(data.instance_id) + except Exception as exc: + logger.warning("failed to deserialize session.canvas.closed payload: %s", exc) + async def _execute_tool_and_respond( self, request_id: str, @@ -1573,11 +2089,25 @@ async def _execute_tool_and_respond( ) -> None: """Execute a tool handler and send the result back via HandlePendingToolCall RPC.""" try: + # The built-in tool-search tool receives a snapshot of the session's + # currently initialized tools so an override can filter the live + # catalog without issuing its own RPC. Fetch it only for that tool to + # avoid a round-trip on every tool call; a failed fetch leaves the + # snapshot as None rather than failing the tool. + available_tools = None + if tool_name == _TOOL_SEARCH_TOOL_NAME: + try: + metadata = await self.rpc.tools.get_current_metadata() + available_tools = metadata.tools + except Exception: + available_tools = None + invocation = ToolInvocation( session_id=self.session_id, tool_call_id=tool_call_id, tool_name=tool_name, arguments=arguments, + available_tools=available_tools, ) with trace_context(traceparent, tracestate): @@ -1634,12 +2164,7 @@ async def _execute_tool_and_respond( await self.rpc.tools.handle_pending_tool_call( HandlePendingToolCallRequest( request_id=request_id, - result=ExternalToolTextResultForLlm( - text_result_for_llm=tool_result.text_result_for_llm, - error=tool_result.error, - result_type=tool_result.result_type, - tool_telemetry=tool_result.tool_telemetry, - ), + result=tool_result_to_external_tool_text_result_for_llm(tool_result), ) ) log_timing( @@ -1672,7 +2197,13 @@ async def _execute_permission_and_respond( """Execute a permission handler and respond via RPC.""" try: handler_start = time.perf_counter() - result = handler(permission_request, {"session_id": self.session_id}) + result = handler( + permission_request, + { + "session_id": self.session_id, + "managed_settings_enabled": self._managed_settings_enabled, + }, + ) if inspect.isawaitable(result): result = await result log_timing( @@ -1684,7 +2215,11 @@ async def _execute_permission_and_respond( request_id=request_id, ) - result = cast(PermissionRequestResult, result) + result = cast("PermissionRequestResult | AttributedPermissionResult", result) + decision_context: PermissionDecisionContext | None = None + if isinstance(result, AttributedPermissionResult): + decision_context = result.decision_context + result = result.result if isinstance(result, PermissionNoResult): return @@ -1693,6 +2228,7 @@ async def _execute_permission_and_respond( PermissionDecisionRequest( request_id=request_id, result=result, + decision_context=decision_context, ) ) log_timing( @@ -1704,6 +2240,10 @@ async def _execute_permission_and_respond( request_id=request_id, ) except Exception: + logger.exception( + "Permission handler or response delivery failed", + extra={"session_id": self.session_id, "request_id": request_id}, + ) try: await self.rpc.permissions.handle_pending_permission_request( PermissionDecisionRequest( @@ -1714,6 +2254,59 @@ async def _execute_permission_and_respond( except (JsonRpcError, ProcessExitedError, OSError): pass # Connection lost or RPC error — nothing we can do + async def _execute_mcp_auth_and_respond( + self, + request: McpAuthRequest, + handler: McpAuthHandler, + ) -> None: + """Execute an MCP auth handler and respond via RPC.""" + request_id = request["requestId"] + try: + handler_start = time.perf_counter() + maybe_result = handler(request, {"sessionId": self.session_id}) + if inspect.isawaitable(maybe_result): + result = cast(McpAuthHandlerResult, await maybe_result) + else: + result = maybe_result + log_timing( + logger, + logging.DEBUG, + "CopilotSession._execute_mcp_auth_and_respond dispatch", + handler_start, + session_id=self.session_id, + request_id=request_id, + ) + + if result and result.get("kind", "token") == "token": + rpc_result = MCPOauthPendingRequestResponse( + kind=MCPOauthPendingRequestResponseKind.TOKEN, + access_token=result["accessToken"], + expires_in=result.get("expiresIn"), + token_type=result.get("tokenType"), + ) + else: + rpc_result = MCPOauthPendingRequestResponse( + kind=MCPOauthPendingRequestResponseKind.CANCELLED + ) + await self.rpc.mcp.oauth.handle_pending_request( + MCPOauthHandlePendingRequest( + request_id=request_id, + result=rpc_result, + ) + ) + except Exception: + try: + await self.rpc.mcp.oauth.handle_pending_request( + MCPOauthHandlePendingRequest( + request_id=request_id, + result=MCPOauthPendingRequestResponse( + kind=MCPOauthPendingRequestResponseKind.CANCELLED + ), + ) + ) + except (JsonRpcError, ProcessExitedError, OSError): + pass # Connection lost or RPC error — nothing we can do + async def _execute_command_and_respond( self, request_id: str, @@ -1866,6 +2459,28 @@ def _register_commands(self, commands: list[CommandDefinition] | None) -> None: for cmd in commands: self._command_handlers[cmd.name] = cmd.handler + def _register_bearer_token_providers( + self, providers: dict[str, BearerTokenProvider] | None + ) -> None: + """Register per-provider bearer-token callbacks for this session. + + The runtime never receives the callbacks themselves; the SDK strips them + from the provider config and instead sends ``hasBearerTokenProvider: + true``. When the runtime needs a token it issues a session-scoped + ``providerToken.getToken`` request, which the registered handler routes + to the matching per-provider callback. + + Args: + providers: Map of provider name -> callback, or None/empty to clear. + """ + with self._bearer_token_providers_lock: + self._bearer_token_providers.clear() + if not providers: + self._client_session_apis.provider_token = None + return + self._bearer_token_providers.update(providers) + self._client_session_apis.provider_token = _BearerTokenProviderAdapter(self) + def _register_elicitation_handler(self, handler: ElicitationHandler | None) -> None: """Register the elicitation handler for this session. @@ -1876,6 +2491,11 @@ def _register_elicitation_handler(self, handler: ElicitationHandler | None) -> N with self._elicitation_handler_lock: self._elicitation_handler = handler + def _register_mcp_auth_handler(self, handler: McpAuthHandler | None) -> None: + """Register the MCP auth handler for this session.""" + with self._mcp_auth_handler_lock: + self._mcp_auth_handler = handler + def _register_exit_plan_mode_handler(self, handler: ExitPlanModeHandler | None) -> None: """Register the exit-plan-mode handler for this session.""" with self._exit_plan_mode_handler_lock: @@ -1912,11 +2532,18 @@ def _upsert_open_canvas(self, instance: OpenCanvasInstance) -> None: return self._open_canvases.append(instance) + def _remove_open_canvas(self, instance_id: str) -> None: + with self._open_canvases_lock: + self._open_canvases = [ + canvas for canvas in self._open_canvases if canvas.instance_id != instance_id + ] + @property def open_canvases(self) -> list[OpenCanvasInstance]: """Open canvas instances currently known to be open for this session. - Populated from ``session.resume`` and live ``session.canvas.opened`` events. + Populated from ``session.resume`` and live ``session.canvas.opened`` and + ``session.canvas.closed`` events. """ with self._open_canvases_lock: return list(self._open_canvases) @@ -2011,7 +2638,13 @@ async def _handle_permission_request( try: handler_start = time.perf_counter() - result = handler(request, {"session_id": self.session_id}) + result = handler( + request, + { + "session_id": self.session_id, + "managed_settings_enabled": self._managed_settings_enabled, + }, + ) if inspect.isawaitable(result): result = await result log_timing( @@ -2021,11 +2654,14 @@ async def _handle_permission_request( handler_start, session_id=self.session_id, ) - return cast(PermissionRequestResult, result) + result = cast(PermissionRequestResult, result) + if isinstance(result, PermissionNoResult): + return PermissionDecisionUserNotAvailable() + return result except Exception: # pylint: disable=broad-except # Handler failed, deny permission. - logger.debug( - "Error handling permission request", + logger.error( + "Permission handler failed", extra={"session_id": self.session_id}, exc_info=True, ) @@ -2227,9 +2863,11 @@ async def _handle_hooks_invoke(self, hook_type: str, input_data: Any) -> Any: "postToolUse": hooks.get("on_post_tool_use"), "postToolUseFailure": hooks.get("on_post_tool_use_failure"), "userPromptSubmitted": hooks.get("on_user_prompt_submitted"), + "userPromptTransformed": hooks.get("on_user_prompt_transformed"), "sessionStart": hooks.get("on_session_start"), "sessionEnd": hooks.get("on_session_end"), "errorOccurred": hooks.get("on_error_occurred"), + "agentStop": hooks.get("on_agent_stop"), } handler = handler_map.get(hook_type) @@ -2246,6 +2884,8 @@ async def _handle_hooks_invoke(self, hook_type: str, input_data: Any) -> Any: transformed: dict[str, Any] = dict(input_data) if "cwd" in transformed: transformed["workingDirectory"] = transformed.pop("cwd") + if "stop_hook_active" in transformed: + transformed["stopHookActive"] = transformed.pop("stop_hook_active") timestamp = transformed.get("timestamp") if isinstance(timestamp, (int, float)): transformed["timestamp"] = datetime.fromtimestamp(timestamp / 1000, tz=UTC) @@ -2288,7 +2928,7 @@ async def get_events(self) -> list[SessionEvent]: Exception: If the session has been disconnected or the connection fails. Example: - >>> from copilot.generated.session_events import AssistantMessageData + >>> from copilot.session_events import AssistantMessageData >>> events = await session.get_events() >>> for event in events: ... match event.data: @@ -2394,6 +3034,7 @@ async def set_model( *, reasoning_effort: str | None = None, reasoning_summary: ReasoningSummary | None = None, + context_tier: ContextTier | None = None, model_capabilities: ModelCapabilitiesOverride | None = None, ) -> None: """ @@ -2403,25 +3044,25 @@ async def set_model( is preserved. Args: - model: Model ID to switch to (e.g., "gpt-4.1", "claude-sonnet-4"). + model: Model ID to switch to (e.g., "gpt-5.4", "claude-sonnet-4"). reasoning_effort: Optional reasoning effort level for the new model - (e.g., "low", "medium", "high", "xhigh"). + (e.g., "low", "medium", "high", "xhigh", "max"). reasoning_summary: Optional reasoning summary mode for supported models. Use "none" to suppress summary output regardless of whether reasoning is enabled. + context_tier: Optional context window tier for supported models. + Omit to use normal model behavior with no explicit tier. model_capabilities: Override individual model capabilities resolved by the runtime. Raises: Exception: If the session has been destroyed or the connection fails. Example: - >>> await session.set_model("gpt-4.1") + >>> await session.set_model("gpt-5.4") >>> await session.set_model("claude-sonnet-4.6", reasoning_effort="high") """ rpc_caps = None if model_capabilities is not None: - from .client import _capabilities_to_dict - rpc_caps = _RpcModelCapabilitiesOverride.from_dict( _capabilities_to_dict(model_capabilities) ) @@ -2434,6 +3075,7 @@ async def set_model( if reasoning_summary is not None else None ), + context_tier=(_RpcContextTier(context_tier) if context_tier is not None else None), model_capabilities=rpc_caps, ) ) diff --git a/python/copilot/session_events.py b/python/copilot/session_events.py new file mode 100644 index 000000000..584ab47f8 --- /dev/null +++ b/python/copilot/session_events.py @@ -0,0 +1,10 @@ +"""Public re-export of the session event types. + +These types are auto-generated from the Copilot CLI session-events schema. This +module is the stable public access point so callers can write +``copilot.session_events.AssistantMessageData`` without depending on the +internal ``copilot.generated`` package layout. +""" + +from .generated.session_events import * # noqa: F401, F403 +from .generated.session_events import __all__ # noqa: F401 diff --git a/python/copilot/session_fs_provider.py b/python/copilot/session_fs_provider.py index 355724da4..c9e90a644 100644 --- a/python/copilot/session_fs_provider.py +++ b/python/copilot/session_fs_provider.py @@ -34,11 +34,19 @@ SessionFSReadFileResult, SessionFSSqliteExistsResult, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionStatement, SessionFSStatResult, ) from .generated.rpc import ( SessionFSSqliteQueryResult as _GeneratedSqliteQueryResult, ) +from .generated.rpc import ( + SessionFSSqliteTransactionError as _GeneratedSqliteTransactionError, +) +from .generated.rpc import ( + SessionFSSqliteTransactionResult as _GeneratedSqliteTransactionResult, +) @dataclass @@ -130,11 +138,45 @@ async def sqlite_query( no result set is produced; the adapter will substitute an empty result. """ + async def sqlite_transaction( + self, + statements: list[SessionFSSqliteTransactionStatement], + ) -> list[SessionFsSqliteQueryResult]: + """Execute ``statements`` atomically against the per-session database. + + Return one result per statement, in order. Raise + :class:`SessionFsSqliteTransactionFailure` to tell the runtime how the + failure should be classified; any other exception is reported as + ``fatal``. + """ + raise SessionFsSqliteTransactionFailure( + "SQLite transactions are not supported by this SessionFs provider", + SessionFSSqliteTransactionErrorClass.FATAL, + ) + @abc.abstractmethod async def sqlite_exists(self) -> bool: """Return whether the provider has a SQLite database for this session.""" +class SessionFsSqliteTransactionFailure(Exception): + """Raised by a provider to classify a failed SQLite transaction. + + ``busy_or_locked`` guarantees the transaction rolled back and is safe to + retry; ``post_commit_ambiguous`` must never be retried. + """ + + def __init__( + self, + message: str, + error_class: SessionFSSqliteTransactionErrorClass = ( + SessionFSSqliteTransactionErrorClass.FATAL + ), + ) -> None: + super().__init__(message) + self.error_class = error_class + + @dataclass class SessionFsSqliteQueryResult: """Result of a SQLite query execution. @@ -294,6 +336,45 @@ async def sqlite_query(self, params: Any) -> _GeneratedSqliteQueryResult: last_insert_rowid=result.last_insert_rowid, ) + async def sqlite_transaction(self, params: Any) -> _GeneratedSqliteTransactionResult: + if not isinstance(self._p, SessionFsSqliteProvider): + return _GeneratedSqliteTransactionResult( + results=[], + error=_GeneratedSqliteTransactionError( + error_class=SessionFSSqliteTransactionErrorClass.FATAL, + message="SQLite is not supported by this SessionFs provider", + ), + ) + try: + results = await self._p.sqlite_transaction(list(params.statements)) + except SessionFsSqliteTransactionFailure as exc: + return _GeneratedSqliteTransactionResult( + results=[], + error=_GeneratedSqliteTransactionError( + error_class=exc.error_class, + message=str(exc), + ), + ) + except Exception as exc: + return _GeneratedSqliteTransactionResult( + results=[], + error=_GeneratedSqliteTransactionError( + error_class=SessionFSSqliteTransactionErrorClass.FATAL, + message=str(exc), + ), + ) + return _GeneratedSqliteTransactionResult( + results=[ + _GeneratedSqliteQueryResult( + columns=result.columns, + rows=result.rows, + rows_affected=result.rows_affected, + last_insert_rowid=result.last_insert_rowid, + ) + for result in results + ], + ) + async def sqlite_exists(self, params: Any) -> SessionFSSqliteExistsResult: if not isinstance(self._p, SessionFsSqliteProvider): return SessionFSSqliteExistsResult.from_dict({"exists": False}) diff --git a/python/copilot/tools.py b/python/copilot/tools.py index c6a29dc61..dc709cf7d 100644 --- a/python/copilot/tools.py +++ b/python/copilot/tools.py @@ -11,9 +11,18 @@ import json from collections.abc import Awaitable, Callable from dataclasses import dataclass, field -from typing import Any, Literal, TypeVar, get_type_hints, overload +from typing import TYPE_CHECKING, Any, Literal, TypeVar, get_type_hints, overload -from pydantic import BaseModel +from pydantic import BaseModel, ValidationError + +if TYPE_CHECKING: + from .generated.rpc import CurrentToolMetadata + +from .generated.rpc import ( + ExternalToolTextResultForLlm, + ExternalToolTextResultForLlmBinaryResultsForLlm, + ExternalToolTextResultForLlmBinaryResultsForLlmType, +) ToolResultType = Literal["success", "failure", "rejected", "denied", "timeout"] @@ -38,6 +47,7 @@ class ToolResult: binary_results_for_llm: list[ToolBinaryResult] | None = None session_log: str | None = None tool_telemetry: dict[str, Any] | None = None + tool_references: list[str] | None = None _from_exception: bool = field(default=False, repr=False) @@ -49,6 +59,14 @@ class ToolInvocation: tool_call_id: str = "" tool_name: str = "" arguments: Any = None + available_tools: list[CurrentToolMetadata] | None = None + """Snapshot of the session's currently initialized tools. + + Populated by the SDK only when this invocation targets the built-in + tool-search tool (``tool_search_tool``), so a tool-search override can + rank/filter the live catalog -- including MCP tools configured in settings -- + without issuing its own RPC. ``None`` for every other tool invocation. + """ ToolHandler = Callable[[ToolInvocation], ToolResult | Awaitable[ToolResult]] @@ -62,6 +80,13 @@ class Tool: parameters: dict[str, Any] | None = None overrides_built_in_tool: bool = False skip_permission: bool = False + defer: Literal["auto", "never"] | None = None + metadata: dict[str, Any] | None = None + #: When true, a successful call to this tool ends the agent turn: the + #: runtime halts instead of feeding the result back to the model for + #: another round. A failed call leaves the loop running so the model can + #: read the error and retry. + is_terminal: bool = False T = TypeVar("T", bound=BaseModel) @@ -75,6 +100,9 @@ def define_tool( description: str | None = None, overrides_built_in_tool: bool = False, skip_permission: bool = False, + defer: Literal["auto", "never"] | None = None, + metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Callable[[Callable[..., Any]], Tool]: pass @@ -88,6 +116,9 @@ def define_tool( handler: None = None, overrides_built_in_tool: bool = False, skip_permission: bool = False, + defer: Literal["auto", "never"] | None = None, + metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Tool: pass @@ -101,6 +132,9 @@ def define_tool( params_type: type[T], overrides_built_in_tool: bool = False, skip_permission: bool = False, + defer: Literal["auto", "never"] | None = None, + metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Tool: pass @@ -113,6 +147,9 @@ def define_tool( params_type: type[BaseModel] | None = None, overrides_built_in_tool: bool = False, skip_permission: bool = False, + defer: Literal["auto", "never"] | None = None, + metadata: dict[str, Any] | None = None, + is_terminal: bool = False, ) -> Tool | Callable[[Callable[[Any, ToolInvocation], Any]], Tool]: """ Define a tool with automatic JSON schema generation from Pydantic models. @@ -157,6 +194,18 @@ def lookup_issue(params: LookupIssueParams) -> str: to override a built-in tool of the same name. If not set and the name clashes with a built-in tool, the runtime will return an error. skip_permission: When True, the tool can execute without a permission prompt. + defer: Controls whether the tool may be deferred (loaded lazily via tool search) + rather than always pre-loaded. When "auto", the tool can be deferred + and surfaced through tool search. When "never", the tool is always + pre-loaded. Optional; defaults to "auto". + metadata: Opaque, host-defined metadata associated with the tool definition. + Keys are namespaced and not part of the stable public API; values + are not interpreted and may be recognized to inform host-specific + behavior. Unknown keys are preserved. + is_terminal: When True, a successful call to this tool ends the agent turn: + the runtime halts instead of feeding the result back to the model + for another round. A failed call leaves the loop running so the + model can read the error and retry. Returns: A Tool instance @@ -202,7 +251,21 @@ async def wrapped_handler(invocation: ToolInvocation) -> ToolResult: if takes_params: args = invocation.arguments or {} if ptype is not None and _is_pydantic_model(ptype): - call_args.append(ptype.model_validate(args)) + try: + call_args.append(ptype.model_validate(args)) + except ValidationError as exc: + # Highlight input validation problems to the LLM. + parts = [] + for err in exc.errors(): + loc = ".".join(map(str, err["loc"])) + msg = err["msg"] + parts.append(f"{loc}: {msg}" if loc else msg) + return ToolResult( + text_result_for_llm="Invalid tool arguments:\n" + "\n".join(parts), + result_type="failure", + error=str(exc), + tool_telemetry={}, + ) else: call_args.append(args) if takes_invocation: @@ -236,6 +299,9 @@ async def wrapped_handler(invocation: ToolInvocation) -> ToolResult: handler=wrapped_handler, overrides_built_in_tool=overrides_built_in_tool, skip_permission=skip_permission, + defer=defer, + metadata=metadata, + is_terminal=is_terminal, ) # If handler is provided, call decorator immediately @@ -254,6 +320,9 @@ async def wrapped_handler(invocation: ToolInvocation) -> ToolResult: handler=None, overrides_built_in_tool=overrides_built_in_tool, skip_permission=skip_permission, + defer=defer, + metadata=metadata, + is_terminal=is_terminal, ) # Otherwise return decorator for @define_tool(...) usage @@ -297,7 +366,7 @@ def _normalize_result(result: Any) -> ToolResult: # Everything else gets JSON-serialized (with Pydantic model support) def default(obj: Any) -> Any: if isinstance(obj, BaseModel): - return obj.model_dump() + return obj.model_dump(mode="json") raise TypeError(f"Object of type {type(obj).__name__} is not JSON serializable") try: @@ -360,3 +429,30 @@ def convert_mcp_call_tool_result(call_result: dict[str, Any]) -> ToolResult: result_type="failure" if call_result.get("isError") is True else "success", binary_results_for_llm=binary_results if binary_results else None, ) + + +def tool_result_to_external_tool_text_result_for_llm( + tool_result: ToolResult, +) -> ExternalToolTextResultForLlm: + """Convert a ToolResult into the RPC payload sent to HandlePendingToolCall.""" + binary_results_for_llm = None + if tool_result.binary_results_for_llm: + binary_results_for_llm = [ + ExternalToolTextResultForLlmBinaryResultsForLlm( + data=binary_result.data, + mime_type=binary_result.mime_type, + type=ExternalToolTextResultForLlmBinaryResultsForLlmType(binary_result.type), + description=binary_result.description or None, + ) + for binary_result in tool_result.binary_results_for_llm + ] + + return ExternalToolTextResultForLlm( + text_result_for_llm=tool_result.text_result_for_llm, + binary_results_for_llm=binary_results_for_llm, + error=tool_result.error, + result_type=tool_result.result_type, + session_log=tool_result.session_log, + tool_references=tool_result.tool_references, + tool_telemetry=tool_result.tool_telemetry, + ) diff --git a/python/e2e/_copilot_request_helpers.py b/python/e2e/_copilot_request_helpers.py new file mode 100644 index 000000000..2d91bc9bc --- /dev/null +++ b/python/e2e/_copilot_request_helpers.py @@ -0,0 +1,360 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""Shared fixtures and response-builder helpers for the CopilotRequestHandler e2e tests. + +The ``copilot_request_*`` tests have no recorded snapshots: the registered +handler fabricates well-formed model responses and the runtime routes all of +its model-layer HTTP/WebSocket traffic through that handler instead of the +CAPI proxy. These helpers centralise the synthetic CAPI shapes (model catalog, +policy, ``/responses`` SSE, ``/chat/completions``) so each test file can focus +on the behaviour it is exercising. + +The leading underscore keeps pytest from collecting this module as a test. +""" + +from __future__ import annotations + +import json +import os +import re + +import httpx +import pytest_asyncio + +from copilot import CopilotClient, CopilotRequestHandler, RuntimeConnection +from copilot.generated.session_events import AssistantMessageData + +from .testharness import E2ETestContext + +SYNTHETIC_TEXT = "OK from the synthetic stream." + + +def sse(event: str, data: dict) -> str: + """Frame a single Server-Sent Events message: ``event:``/``data:`` + blank line.""" + return f"event: {event}\ndata: {json.dumps(data)}\n\n" + + +def is_inference_url(url: str) -> bool: + """Return True if ``url`` is a model inference endpoint. + + Strips query parameters before matching so URLs like + ``/chat/completions?api-version=2024-02`` are handled correctly. + """ + path = url.lower().split("?", 1)[0] + return ( + path.endswith("/chat/completions") + or path.endswith("/responses") + or path.endswith("/v1/messages") + or path.endswith("/messages") + ) + + +def _wants_stream(body: bytes) -> bool: + return re.search(rb'"stream"\s*:\s*true', body) is not None + + +def model_catalog(supported_endpoints: list[str] | None = None) -> dict: + """The synthetic ``/models`` catalog payload.""" + model: dict = { + "id": "claude-sonnet-4.5", + "name": "Claude Sonnet 4.5", + "object": "model", + "vendor": "Anthropic", + "version": "1", + "preview": False, + "model_picker_enabled": True, + "capabilities": { + "type": "chat", + "family": "claude-sonnet-4.5", + "tokenizer": "o200k_base", + "limits": {"max_context_window_tokens": 200000, "max_output_tokens": 8192}, + "supports": { + "streaming": True, + "tool_calls": True, + "parallel_tool_calls": True, + "vision": True, + }, + }, + } + if supported_endpoints is not None: + model["supported_endpoints"] = supported_endpoints + return {"data": [model]} + + +def responses_events(text: str, resp_id: str = "resp_stub_1") -> list[dict]: + """The ordered ``/responses`` event objects the runtime's reducer expects.""" + return [ + { + "type": "response.created", + "response": { + "id": resp_id, + "object": "response", + "status": "in_progress", + "output": [], + }, + }, + { + "type": "response.output_item.added", + "output_index": 0, + "item": {"id": "msg_1", "type": "message", "role": "assistant", "content": []}, + }, + { + "type": "response.content_part.added", + "output_index": 0, + "content_index": 0, + "part": {"type": "output_text", "text": ""}, + }, + { + "type": "response.output_text.delta", + "output_index": 0, + "content_index": 0, + "delta": text, + }, + { + "type": "response.output_text.done", + "output_index": 0, + "content_index": 0, + "text": text, + }, + { + "type": "response.completed", + "response": { + "id": resp_id, + "object": "response", + "status": "completed", + "output": [ + { + "id": "msg_1", + "type": "message", + "role": "assistant", + "content": [{"type": "output_text", "text": text}], + } + ], + "usage": {"input_tokens": 5, "output_tokens": 7, "total_tokens": 12}, + }, + }, + ] + + +def build_non_inference_response( + url: str, supported_endpoints: list[str] | None = None +) -> httpx.Response: + """Build a minimal ``httpx.Response`` for non-inference model-layer requests.""" + path = url.lower().split("?", 1)[0] # strip query params before matching + if path.endswith("/models"): + return httpx.Response( + 200, + headers={"content-type": "application/json"}, + content=json.dumps(model_catalog(supported_endpoints)).encode(), + ) + if "/models/session" in path: + return httpx.Response(200, headers={"content-type": "application/json"}, content=b"{}") + if "/policy" in path: + return httpx.Response( + 200, + headers={"content-type": "application/json"}, + content=json.dumps({"state": "enabled"}).encode(), + ) + return httpx.Response(200, headers={"content-type": "application/json"}, content=b"{}") + + +def build_inference_response(request: httpx.Request, text: str = SYNTHETIC_TEXT) -> httpx.Response: + """Build a synthetic inference response for ``/responses`` or ``/chat/completions``. + + Dispatches by URL and the request body's ``stream`` flag: ``/responses`` + streams an SSE event sequence (or returns a buffered Responses object when + ``stream`` is false), ``/chat/completions`` streams chat-completion chunks + (or returns a buffered completion). + """ + body = request.content # already drained when send_request is called + wants_stream = _wants_stream(body) + url = str(request.url).lower() + + if "/responses" in url: + if not wants_stream: + return httpx.Response( + 200, + headers={"content-type": "application/json"}, + content=json.dumps(responses_events(text)[-1]["response"]).encode(), + ) + stream_body = "".join(sse(e["type"], e) for e in responses_events(text)) + return httpx.Response( + 200, + headers={"content-type": "text/event-stream"}, + content=stream_body.encode(), + ) + + if "/chat/completions" in url and wants_stream: + base = { + "id": "chatcmpl-stub-1", + "object": "chat.completion.chunk", + "created": 1, + "model": "claude-sonnet-4.5", + } + chunks = [ + { + **base, + "choices": [ + { + "index": 0, + "delta": {"role": "assistant", "content": ""}, + "finish_reason": None, + } + ], + }, + { + **base, + "choices": [{"index": 0, "delta": {"content": text}, "finish_reason": None}], + }, + { + **base, + "choices": [{"index": 0, "delta": {}, "finish_reason": "stop"}], + "usage": {"prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12}, + }, + ] + stream_body = ( + "".join("data: " + json.dumps(c) + "\n\n" for c in chunks) + "data: [DONE]\n\n" + ) + return httpx.Response( + 200, + headers={"content-type": "text/event-stream"}, + content=stream_body.encode(), + ) + + if url.endswith("/messages"): + if wants_stream: + events = [ + ( + "message_start", + { + "type": "message_start", + "message": { + "id": "msg_stub_1", + "type": "message", + "role": "assistant", + "model": "claude-sonnet-4.5", + "content": [], + "stop_reason": None, + "stop_sequence": None, + "usage": {"input_tokens": 5, "output_tokens": 1}, + }, + }, + ), + ( + "content_block_start", + { + "type": "content_block_start", + "index": 0, + "content_block": {"type": "text", "text": ""}, + }, + ), + ( + "content_block_delta", + { + "type": "content_block_delta", + "index": 0, + "delta": {"type": "text_delta", "text": text}, + }, + ), + ("content_block_stop", {"type": "content_block_stop", "index": 0}), + ( + "message_delta", + { + "type": "message_delta", + "delta": {"stop_reason": "end_turn", "stop_sequence": None}, + "usage": {"output_tokens": 7}, + }, + ), + ("message_stop", {"type": "message_stop"}), + ] + stream_body = "".join(sse(event, data) for event, data in events) + return httpx.Response( + 200, + headers={"content-type": "text/event-stream"}, + content=stream_body.encode(), + ) + return httpx.Response( + 200, + headers={"content-type": "application/json"}, + content=json.dumps( + { + "id": "msg_stub_1", + "type": "message", + "role": "assistant", + "model": "claude-sonnet-4.5", + "content": [{"type": "text", "text": text}], + "stop_reason": "end_turn", + "stop_sequence": None, + "usage": {"input_tokens": 5, "output_tokens": 7}, + } + ).encode(), + ) + + return httpx.Response( + 200, + headers={"content-type": "application/json"}, + content=json.dumps( + { + "id": "chatcmpl-stub-1", + "object": "chat.completion", + "created": 1, + "model": "claude-sonnet-4.5", + "choices": [ + { + "index": 0, + "message": {"role": "assistant", "content": text}, + "finish_reason": "stop", + } + ], + "usage": {"prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12}, + } + ).encode(), + ) + + +def assistant_text(event) -> str: + if event is not None and isinstance(event.data, AssistantMessageData): + return event.data.content + return "" + + +def build_isolated_client( + ctx: E2ETestContext, + handler: CopilotRequestHandler, + extra_env: dict[str, str] | None = None, +) -> CopilotClient: + """Build a CopilotClient wired to ``handler`` via ``request_handler``.""" + github_token = ( + "fake-token-for-e2e-tests" if os.environ.get("GITHUB_ACTIONS") == "true" else None + ) + env = ctx.get_env() + if extra_env: + env = {**env, **extra_env} + return CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=github_token, + request_handler=handler, + ) + + +def isolated_client_fixture(make_handler, extra_env: dict[str, str] | None = None): + """Build a module-scoped pytest-asyncio fixture yielding ``(client, handler)``.""" + + @pytest_asyncio.fixture(loop_scope="module") + async def _fixture(ctx: E2ETestContext): + handler = make_handler() + client = build_isolated_client(ctx, handler, extra_env) + try: + yield client, handler + finally: + try: + await client.stop() + except Exception: + # Best-effort teardown during fixture cleanup. + pass + + return _fixture diff --git a/python/e2e/conftest.py b/python/e2e/conftest.py index 35d05d101..f441097f3 100644 --- a/python/e2e/conftest.py +++ b/python/e2e/conftest.py @@ -1,9 +1,23 @@ """Shared pytest fixtures for e2e tests.""" +import os + import pytest import pytest_asyncio -from .testharness import E2ETestContext +from .testharness import E2ETestContext, is_inprocess_transport + +# Host-side auth resolution ranks HMAC above the GitHub token, so an ambient +# COPILOT_HMAC_KEY (CI sets one as a job-level credential) would be picked over +# the token the replay snapshots expect, yielding 401s. For the in-process +# transport the runtime is hosted in this test process and can capture the key as +# early as client construction, so neutralize it at module load — the analogue of +# .NET's InProcessEnvIsolation [ModuleInitializer] and Node's module-init guard. +# Out-of-process children resolve auth in their own process where the token already +# outranks HMAC. See https://github.com/github/copilot-sdk/issues/1934. +if is_inprocess_transport(): + os.environ.pop("COPILOT_HMAC_KEY", None) + os.environ.pop("CAPI_HMAC_KEY", None) @pytest.hookimpl(tryfirst=True, hookwrapper=True) @@ -24,7 +38,8 @@ async def ctx(request): await context.setup() yield context any_failed = request.session.stash.get("any_test_failed", False) - await context.teardown(test_failed=any_failed) + skip_writing_cache = any_failed or bool(os.environ.get("GITHUB_ACTIONS")) + await context.teardown(test_failed=skip_writing_cache) @pytest_asyncio.fixture(autouse=True, loop_scope="module") diff --git a/python/e2e/test_abort_e2e.py b/python/e2e/test_abort_e2e.py index 6711fb114..ce3a497f4 100644 --- a/python/e2e/test_abort_e2e.py +++ b/python/e2e/test_abort_e2e.py @@ -57,10 +57,25 @@ def on_event(event): types = [e.type.value for e in events] assert "assistant.message_delta" in types - # Session should be in a usable state after abort - follow_up = await session.send_and_wait("Say 'abort_recovery_ok'.", timeout=60.0) - assert follow_up is not None - assert "abort_recovery_ok" in (follow_up.data.content or "").lower() + # Session should be usable after abort. Wait for the specific recovery + # message rather than racing against a late idle from the aborted turn. + recovery_received: asyncio.Future = asyncio.get_event_loop().create_future() + + def check_recovery(event): + if ( + event.type.value == "assistant.message" + and "abort_recovery_ok" in (event.data.content or "").lower() + and not recovery_received.done() + ): + recovery_received.set_result(event) + + unsubscribe_recovery = session.on(check_recovery) + try: + await session.send("Say 'abort_recovery_ok'.") + recovery_message = await asyncio.wait_for(recovery_received, timeout=60.0) + assert "abort_recovery_ok" in (recovery_message.data.content or "").lower() + finally: + unsubscribe_recovery() finally: unsubscribe() await session.disconnect() diff --git a/python/e2e/test_agent_and_compact_rpc_e2e.py b/python/e2e/test_agent_and_compact_rpc_e2e.py index 14ea01ff2..300b2546a 100644 --- a/python/e2e/test_agent_and_compact_rpc_e2e.py +++ b/python/e2e/test_agent_and_compact_rpc_e2e.py @@ -5,7 +5,7 @@ import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import AgentSelectRequest +from copilot.rpc import AgentSelectRequest from copilot.session import PermissionHandler from .testharness import CLI_PATH, E2ETestContext diff --git a/python/e2e/test_builtin_tools_e2e.py b/python/e2e/test_builtin_tools_e2e.py index cd0627167..64b5c1295 100644 --- a/python/e2e/test_builtin_tools_e2e.py +++ b/python/e2e/test_builtin_tools_e2e.py @@ -14,6 +14,12 @@ pytestmark = pytest.mark.asyncio(loop_scope="module") +# Built-in tool tests spawn a real CLI subprocess and execute actual shell / +# file tools. Under slow/concurrent CI (notably Windows) this agent loop can +# briefly exceed the 60s send_and_wait default, so give it extra headroom while +# still failing fast on a genuine hang. +SEND_TIMEOUT = 120.0 + class TestBuiltinTools: async def test_should_capture_exit_code_in_output(self, ctx: E2ETestContext): @@ -22,7 +28,8 @@ async def test_should_capture_exit_code_in_output(self, ctx: E2ETestContext): ) try: message = await session.send_and_wait( - "Run 'echo hello && echo world'. Tell me the exact output." + "Run 'echo hello && echo world'. Tell me the exact output.", + timeout=SEND_TIMEOUT, ) content = message.data.content if message else "" assert "hello" in content @@ -40,8 +47,9 @@ async def test_should_capture_stderr_output(self, ctx: E2ETestContext): ) try: message = await session.send_and_wait( - "Run 'echo error_msg >&2; echo ok' and tell me what stderr said. " - "Reply with just the stderr content." + "Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. " + "Reply with just the stderr content.", + timeout=SEND_TIMEOUT, ) assert message is not None assert "error_msg" in message.data.content @@ -58,7 +66,8 @@ async def test_should_read_file_with_line_range(self, ctx: E2ETestContext): try: message = await session.send_and_wait( "Read lines 2 through 4 of the file 'lines.txt' in this directory. " - "Tell me what those lines contain." + "Tell me what those lines contain.", + timeout=SEND_TIMEOUT, ) content = message.data.content if message else "" assert "line2" in content @@ -73,7 +82,8 @@ async def test_should_handle_nonexistent_file_gracefully(self, ctx: E2ETestConte try: message = await session.send_and_wait( "Try to read the file 'does_not_exist.txt'. " - "If it doesn't exist, say 'FILE_NOT_FOUND'." + "If it doesn't exist, say 'FILE_NOT_FOUND'.", + timeout=SEND_TIMEOUT, ) content = message.data.content if message else "" assert re.search( @@ -94,7 +104,8 @@ async def test_should_edit_a_file_successfully(self, ctx: E2ETestContext): try: message = await session.send_and_wait( "Edit the file 'edit_me.txt': replace 'Hello World' with " - "'Hi Universe'. Then read it back and tell me its contents." + "'Hi Universe'. Then read it back and tell me its contents.", + timeout=SEND_TIMEOUT, ) assert message is not None assert "Hi Universe" in message.data.content @@ -108,7 +119,8 @@ async def test_should_create_a_new_file(self, ctx: E2ETestContext): try: message = await session.send_and_wait( "Create a file called 'new_file.txt' with the content " - "'Created by test'. Then read it back to confirm." + "'Created by test'. Then read it back to confirm.", + timeout=SEND_TIMEOUT, ) assert message is not None assert "Created by test" in message.data.content @@ -125,7 +137,8 @@ async def test_should_search_for_patterns_in_files(self, ctx: E2ETestContext): try: message = await session.send_and_wait( "Search for lines starting with 'ap' in the file 'data.txt'. " - "Tell me which lines matched." + "Tell me which lines matched.", + timeout=SEND_TIMEOUT, ) content = message.data.content if message else "" assert "apple" in content @@ -144,7 +157,8 @@ async def test_should_find_files_by_pattern(self, ctx: E2ETestContext): ) try: message = await session.send_and_wait( - "Find all .ts files in this directory (recursively). List the filenames you found." + "Find all .ts files in this directory (recursively). List the filenames you found.", + timeout=SEND_TIMEOUT, ) assert message is not None assert "index.ts" in message.data.content diff --git a/python/e2e/test_byok_bearer_token_provider_e2e.py b/python/e2e/test_byok_bearer_token_provider_e2e.py new file mode 100644 index 000000000..37dfbc009 --- /dev/null +++ b/python/e2e/test_byok_bearer_token_provider_e2e.py @@ -0,0 +1,255 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""E2E coverage for the experimental BYOK bearer-token-provider surface. + +Mirrors ``nodejs/test/e2e/byok_bearer_token_provider.e2e.test.ts``. A BYOK +provider config may carry a ``bearer_token_provider`` callback; the callback stays +entirely on the SDK/client side. The SDK strips it from the wire config, sets +the ``hasBearerTokenProvider`` flag, and the runtime calls back over the +session-scoped ``providerToken.getToken`` RPC before each outbound model +request, applying the returned token as the ``Authorization`` header. + +Like the other ``copilot_request_*`` tests, this one installs a client-global +``CopilotRequestHandler`` instead of using the CAPI proxy: the handler +fabricates the bootstrap (catalog/policy) responses and intercepts the +runtime's outbound BYOK request in-process, capturing the ``Authorization`` +header and returning a synthetic ``404``. It validates, against a real runtime: + 1. the callback's token reaches the model request as ``Authorization: Bearer ``; + 2. the runtime re-acquires a token per request (no runtime-side caching); + 3. per-provider dispatch routes each provider's turn to its own callback, and + the resulting token reaches that provider's endpoint. +""" + +from __future__ import annotations + +import re + +import httpx +import pytest +import pytest_asyncio + +from copilot import CopilotRequestContext, CopilotRequestHandler +from copilot.session import BearerTokenProvider, PermissionHandler + +from ._copilot_request_helpers import build_isolated_client, build_non_inference_response +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + +# Fake BYOK provider base URLs. These hosts are never actually dialed: the +# client-global request interceptor fully answers any request aimed at a +# ``.invalid`` host, so they only need to be syntactically valid, non-resolving +# URLs. Distinct hosts let the per-provider test assert routing by host. +PRIMARY_HOST = "byok-endpoint.invalid" +PRIMARY_BASE_URL = f"https://{PRIMARY_HOST}/v1" +RED_HOST = "byok-red.invalid" +RED_BASE_URL = f"https://{RED_HOST}/v1" +BLUE_HOST = "byok-blue.invalid" +BLUE_BASE_URL = f"https://{BLUE_HOST}/v1" + + +class _CapturingRequestHandler(CopilotRequestHandler): + """Client-global HTTP interceptor used in place of a real BYOK listener. + + The runtime invokes :meth:`send_request` for every model-layer HTTP request. + Requests aimed at a fake BYOK host are captured — recording the + ``Authorization`` header the runtime applied after calling the provider's + ``bearer_token_provider`` callback over ``providerToken.getToken`` — and answered + with a synthetic ``404`` (non-retryable, so each outbound model request + yields exactly one capture). Every other request (CAPI bootstrap: model + catalog, policy, …) is fabricated locally so no real network or CAPI proxy + is involved. + """ + + def __init__(self) -> None: + # (host, authorization) for each captured BYOK request, in arrival order. + self.captures: list[tuple[str, str | None]] = [] + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + url = httpx.URL(request.url) + host = url.host + if host.endswith(".invalid"): + self.captures.append((host, request.headers.get("authorization"))) + return httpx.Response( + 404, + headers={"content-type": "application/json"}, + json={"error": {"message": "fake byok endpoint"}}, + request=request, + ) + return build_non_inference_response(str(request.url)) + + def reset(self) -> None: + self.captures.clear() + + def auth_headers(self) -> list[str]: + """The ``Authorization`` headers captured across BYOK requests, in order.""" + return [auth for (_host, auth) in self.captures if auth is not None] + + def auth_header_for_host(self, host: str) -> str | None: + """The ``Authorization`` header captured for requests aimed at ``host``.""" + for captured_host, auth in self.captures: + if captured_host == host: + return auth + return None + + +@pytest_asyncio.fixture(loop_scope="module") +async def bearer_fixture(ctx: E2ETestContext): + handler = _CapturingRequestHandler() + client = build_isolated_client(ctx, handler) + await client.start() + try: + yield client, handler + finally: + try: + await client.stop() + except Exception: + # Best-effort teardown during fixture cleanup. + pass + + +async def _run_turn(client, providers, models, selection_id: str, prompt: str) -> None: + """Drive one BYOK turn; the synthetic 404 errors the turn, which is expected.""" + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model=selection_id, + providers=providers, + models=models, + ) + try: + # The interceptor always 404s, so the turn errors after the runtime has + # already sent the (token-bearing) request — which is all we assert on. + try: + await session.send_and_wait(prompt) + except Exception: + # The fake BYOK endpoint intentionally errors after capture. + pass + finally: + try: + await session.disconnect() + except Exception: + # ignore disconnect errors for the fake BYOK endpoint + pass + + +class TestByokBearerTokenProvider: + async def test_applies_the_callbacks_token_as_the_authorization_header(self, bearer_fixture): + client, handler = bearer_fixture + handler.reset() + + sentinel = "sentinel-bearer-token-abc123" + calls = 0 + + async def get_bearer_token(args) -> str: + nonlocal calls + calls += 1 + return sentinel + + providers = [ + { + "name": "mi", + "type": "openai", + "wire_api": "completions", + "base_url": PRIMARY_BASE_URL, + "bearer_token_provider": get_bearer_token, + } + ] + models = [{"id": "default", "provider": "mi", "wire_model": "byok-gpt-4o"}] + + await _run_turn(client, providers, models, "mi/default", "What is 5+5?") + + # The runtime acquired a token via the callback and applied it verbatim + # as the bearer credential on the outbound model request. + assert f"Bearer {sentinel}" in handler.auth_headers() + assert calls >= 1 + + async def test_reacquires_a_fresh_token_for_each_request(self, bearer_fixture): + client, handler = bearer_fixture + handler.reset() + + calls = 0 + + async def get_bearer_token(args) -> str: + nonlocal calls + calls += 1 + # A distinct token per acquisition proves the runtime re-invokes the + # callback per request rather than caching a previous token. + return f"rotating-token-{calls}" + + providers = [ + { + "name": "mi", + "type": "openai", + "wire_api": "completions", + "base_url": PRIMARY_BASE_URL, + "bearer_token_provider": get_bearer_token, + } + ] + models = [{"id": "default", "provider": "mi", "wire_model": "byok-gpt-4o"}] + + await _run_turn(client, providers, models, "mi/default", "What is 1+1?") + await _run_turn(client, providers, models, "mi/default", "What is 2+2?") + + # Each outbound request carries a freshly-acquired, distinct token. + auths = handler.auth_headers() + assert len(auths) >= 2 + assert re.match(r"^Bearer rotating-token-\d+$", auths[0]) + assert re.match(r"^Bearer rotating-token-\d+$", auths[1]) + assert auths[0] != auths[1] + assert calls >= 2 + + async def test_dispatches_token_acquisition_per_provider(self, bearer_fixture): + client, handler = bearer_fixture + handler.reset() + + token_by_provider = {"red": "token-for-red", "blue": "token-for-blue"} + acquired_for: list[str] = [] + + def make_callback(provider_name: str) -> BearerTokenProvider: + async def callback(args) -> str: + # The runtime forwards the requesting provider's name so the + # client can dispatch to the right credential. + assert args["provider_name"] == provider_name + # The runtime also forwards the owning session id so a + # client-level shared callback can resolve the session. + assert isinstance(args["session_id"], str) and args["session_id"] + acquired_for.append(provider_name) + return token_by_provider[provider_name] + + return callback + + providers = [ + { + "name": "red", + "type": "openai", + "wire_api": "completions", + "base_url": RED_BASE_URL, + "bearer_token_provider": make_callback("red"), + }, + { + "name": "blue", + "type": "openai", + "wire_api": "completions", + "base_url": BLUE_BASE_URL, + "bearer_token_provider": make_callback("blue"), + }, + ] + models = [ + {"id": "default", "provider": "red", "wire_model": "byok-gpt-4o"}, + {"id": "default", "provider": "blue", "wire_model": "byok-gpt-4o"}, + ] + + await _run_turn(client, providers, models, "red/default", "What is 3+3?") + await _run_turn(client, providers, models, "blue/default", "What is 4+4?") + + # Each provider's turn was authenticated with its own token AND that + # token was delivered to that provider's endpoint, proving per-provider + # dispatch (not a single session-global credential). + assert handler.auth_header_for_host(RED_HOST) == f"Bearer {token_by_provider['red']}" + assert handler.auth_header_for_host(BLUE_HOST) == f"Bearer {token_by_provider['blue']}" + assert "red" in acquired_for + assert "blue" in acquired_for diff --git a/python/e2e/test_canvas_e2e.py b/python/e2e/test_canvas_e2e.py index a464e5dc3..accb2661c 100644 --- a/python/e2e/test_canvas_e2e.py +++ b/python/e2e/test_canvas_e2e.py @@ -9,7 +9,7 @@ CanvasDeclaration, CanvasHandler, ) -from copilot.generated.rpc import ( +from copilot.rpc import ( CanvasActionInvokeRequest, CanvasCloseRequest, CanvasOpenRequest, diff --git a/python/e2e/test_client_lifecycle_e2e.py b/python/e2e/test_client_lifecycle_e2e.py index d5a2fb681..f1196a54e 100644 --- a/python/e2e/test_client_lifecycle_e2e.py +++ b/python/e2e/test_client_lifecycle_e2e.py @@ -187,7 +187,8 @@ async def test_should_receive_session_updated_lifecycle_event_for_non_ephemeral_ self, ctx: E2ETestContext ): """Changing session mode emits a session.updated lifecycle event.""" - from copilot.generated.rpc import ModeSetRequest, SessionMode + from copilot.rpc import ModeSetRequest + from copilot.session_events import SessionMode loop = asyncio.get_event_loop() updated: asyncio.Future = loop.create_future() diff --git a/python/e2e/test_client_options_e2e.py b/python/e2e/test_client_options_e2e.py index 8a503e4cb..fe1ed5482 100644 --- a/python/e2e/test_client_options_e2e.py +++ b/python/e2e/test_client_options_e2e.py @@ -20,11 +20,20 @@ import pytest -from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import PingRequest +from copilot import ( + CanvasDeclaration, + CloudSessionOptions, + CloudSessionRepository, + CopilotClient, + ExtensionInfo, + OpenCanvasInstance, + RemoteSessionMode, + RuntimeConnection, +) +from copilot.rpc import PingRequest from copilot.session import PermissionHandler -from .testharness import E2ETestContext +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -56,9 +65,7 @@ def _make_options( "connection": connection, "working_directory": ctx.work_dir, "env": ctx.get_env(), - "github_token": ( - "fake-token-for-e2e-tests" if os.environ.get("GITHUB_ACTIONS") == "true" else None - ), + "github_token": DEFAULT_GITHUB_TOKEN, } base.update(overrides) return base @@ -92,6 +99,7 @@ def _get_available_port() -> int: COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN, COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT, + OTEL_EXPORTER_OTLP_PROTOCOL: process.env.OTEL_EXPORTER_OTLP_PROTOCOL, COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH, COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE, COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME, @@ -146,6 +154,20 @@ def _get_available_port() -> int: writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null }); return; } + if (message.method === "session.resume") { + const sessionId = message.params?.sessionId ?? message.params?.session_id ?? "fake-session"; + writeResponse(message.id, { + sessionId, + workspacePath: null, + capabilities: null, + openCanvases: message.params?.openCanvases ?? [], + }); + return; + } + if (message.method === "session.options.update") { + writeResponse(message.id, { success: true }); + return; + } writeResponse(message.id, {}); } @@ -163,6 +185,14 @@ def _assert_arg_value(args: list[str], name: str, expected_value: str) -> None: assert args[index + 1] == expected_value +def _get_captured_request(capture_path: str, method: str) -> dict: + with open(capture_path) as f: + capture = json.load(f) + request = next((r for r in capture["requests"] if r["method"] == method), None) + assert request is not None, f"Expected {method} request in capture" + return request["params"] + + class TestClientOptions: async def test_should_listen_on_configured_tcp_port(self, ctx: E2ETestContext): port = _get_available_port() @@ -218,6 +248,7 @@ async def test_should_propagate_process_options_to_spawned_cli(self, ctx: E2ETes session_idle_timeout_seconds=17, telemetry={ "otlp_endpoint": "http://127.0.0.1:4318", + "otlp_protocol": "http/protobuf", "file_path": telemetry_path, "exporter_type": "file", "source_name": "python-sdk-e2e", @@ -246,6 +277,7 @@ async def test_should_propagate_process_options_to_spawned_cli(self, ctx: E2ETes assert env["COPILOT_SDK_AUTH_TOKEN"] == "process-option-token" assert env["COPILOT_OTEL_ENABLED"] == "true" assert env["OTEL_EXPORTER_OTLP_ENDPOINT"] == "http://127.0.0.1:4318" + assert env["OTEL_EXPORTER_OTLP_PROTOCOL"] == "http/protobuf" assert env["COPILOT_OTEL_FILE_EXPORTER_PATH"] == telemetry_path assert env["COPILOT_OTEL_EXPORTER_TYPE"] == "file" assert env["COPILOT_OTEL_SOURCE_NAME"] == "python-sdk-e2e" @@ -256,7 +288,9 @@ async def test_should_propagate_process_options_to_spawned_cli(self, ctx: E2ETes enable_config_discovery=True, enable_on_demand_instruction_discovery=True, include_sub_agent_streaming_events=False, + custom_agents_local_only=False, ) + session_id = session.session_id try: with open(capture_path) as f: capture = json.load(f) @@ -267,10 +301,358 @@ async def test_should_propagate_process_options_to_spawned_cli(self, ctx: E2ETes assert params["enableConfigDiscovery"] is True assert params["enableOnDemandInstructionDiscovery"] is True assert params["includeSubAgentStreamingEvents"] is False + assert params["customAgentsLocalOnly"] is False finally: await session.disconnect() + + resumed = await client.resume_session( + session_id, + on_permission_request=PermissionHandler.approve_all, + custom_agents_local_only=False, + ) + try: + with open(capture_path) as f: + capture = json.load(f) + resume_request = next( + r for r in capture["requests"] if r["method"] == "session.resume" + ) + assert resume_request["params"]["customAgentsLocalOnly"] is False + finally: + await resumed.disconnect() + finally: + try: + await client.stop() + except Exception: + await client.force_stop() + + async def test_should_send_empty_mode_custom_agent_locality_defaults(self, ctx: E2ETestContext): + cli_path = os.path.join(ctx.work_dir, "fake-cli-empty.js") + capture_path = os.path.join(ctx.work_dir, "fake-cli-empty-capture.json") + with open(cli_path, "w") as f: + f.write(FAKE_STDIO_CLI_SCRIPT) + + client = CopilotClient( + **_make_options( + ctx, + cli_path=cli_path, + cli_args=["--capture-file", capture_path], + mode="empty", + base_directory=ctx.work_dir, + use_logged_in_user=False, + ), + ) + try: + session = await client.create_session( + available_tools=["builtin:ask_user"], + on_permission_request=PermissionHandler.approve_all, + ) + session_id = session.session_id + await session.disconnect() + + resumed = await client.resume_session( + session_id, + available_tools=["builtin:ask_user"], + on_permission_request=PermissionHandler.approve_all, + ) + try: + with open(capture_path) as f: + capture = json.load(f) + create_request = next( + r for r in capture["requests"] if r["method"] == "session.create" + ) + resume_request = next( + r for r in capture["requests"] if r["method"] == "session.resume" + ) + assert create_request["params"]["customAgentsLocalOnly"] is True + assert resume_request["params"]["customAgentsLocalOnly"] is True + finally: + await resumed.disconnect() finally: try: await client.stop() except Exception: await client.force_stop() + + async def test_should_forward_advanced_session_options_in_create_wire_request( + self, ctx: E2ETestContext + ): + cli_path = os.path.join(ctx.work_dir, f"fake-cli-advanced-create-{os.getpid()}.js") + capture_path = os.path.join( + ctx.work_dir, f"fake-cli-advanced-create-capture-{os.getpid()}.json" + ) + output_directory = os.path.join(ctx.work_dir, "large-output-create") + with open(cli_path, "w") as f: + f.write(FAKE_STDIO_CLI_SCRIPT) + + client = CopilotClient( + **_make_options( + ctx, + cli_path=cli_path, + cli_args=["--capture-file", capture_path], + use_logged_in_user=False, + ) + ) + try: + await client.start() + session = await client.create_session( + client_name="advanced-create-client", + model="claude-sonnet-4.5", + reasoning_effort="medium", + reasoning_summary="detailed", + context_tier="long_context", + enable_citations=True, + capi={"enable_web_socket_responses": False}, + mcp_oauth_token_storage="persistent", + custom_agents=[ + { + "name": "agent-one", + "display_name": "Agent One", + "description": "Handles agent-one tasks.", + "prompt": "Be agent one.", + "tools": ["view"], + "infer": True, + "skills": ["create-skill"], + "model": "claude-haiku-4.5", + } + ], + default_agent={"excluded_tools": ["edit"]}, + agent="agent-one", + skill_directories=["skills-create"], + disabled_skills=["disabled-create-skill"], + plugin_directories=["plugins-create"], + infinite_sessions={ + "enabled": False, + "background_compaction_threshold": 0.5, + "buffer_exhaustion_threshold": 0.9, + }, + large_output={ + "enabled": True, + "max_size_bytes": 4096, + "output_directory": output_directory, + }, + memory={"enabled": True}, + github_token="session-create-token", + remote_session=RemoteSessionMode.EXPORT, + cloud=CloudSessionOptions( + repository=CloudSessionRepository( + owner="github", + name="copilot-sdk", + branch="main", + ) + ), + enable_mcp_apps=True, + request_canvas_renderer=True, + request_extensions=True, + extension_sdk_path="custom-extension-sdk", + extension_info=ExtensionInfo( + source="python-sdk-tests", + name="advanced-create-extension", + ), + canvases=[ + CanvasDeclaration( + id="advanced-create-canvas", + display_name="Advanced Create Canvas", + description="Covers create-time canvas options.", + ) + ], + providers=[ + { + "name": "create-provider", + "type": "openai", + "wire_api": "responses", + "base_url": "https://create-provider.example.test/v1", + "api_key": "create-provider-key", + "headers": {"X-Create-Provider": "yes"}, + } + ], + models=[ + { + "provider": "create-provider", + "id": "create-model", + "name": "Create Model", + "model_id": "claude-sonnet-4.5", + "wire_model": "create-wire-model", + "max_context_window_tokens": 12_000, + "max_prompt_tokens": 10_000, + "max_output_tokens": 2_000, + } + ], + on_permission_request=PermissionHandler.approve_all, + ) + try: + params = _get_captured_request(capture_path, "session.create") + assert params["clientName"] == "advanced-create-client" + assert params["model"] == "claude-sonnet-4.5" + assert params["reasoningEffort"] == "medium" + assert params["reasoningSummary"] == "detailed" + assert params["contextTier"] == "long_context" + assert params["enableCitations"] is True + assert params["capi"]["enableWebSocketResponses"] is False + assert params["mcpOAuthTokenStorage"] == "persistent" + assert params["agent"] == "agent-one" + assert params["defaultAgent"]["excludedTools"][0] == "edit" + assert params["customAgents"][0]["name"] == "agent-one" + assert params["pluginDirectories"][0] == "plugins-create" + assert params["disabledSkills"][0] == "disabled-create-skill" + assert params["infiniteSessions"]["enabled"] is False + assert params["largeOutput"]["enabled"] is True + assert params["largeOutput"]["maxSizeBytes"] == 4096 + assert params["largeOutput"]["outputDir"] == output_directory + assert params["memory"]["enabled"] is True + assert params["gitHubToken"] == "session-create-token" + assert params["remoteSession"] == "export" + assert params["cloud"]["repository"]["owner"] == "github" + assert params["requestMcpApps"] is True + assert params["requestCanvasRenderer"] is True + assert params["requestExtensions"] is True + assert params["extensionSdkPath"] == "custom-extension-sdk" + assert params["extensionInfo"]["name"] == "advanced-create-extension" + assert params["canvases"][0]["id"] == "advanced-create-canvas" + assert params["providers"][0]["name"] == "create-provider" + assert params["providers"][0]["wireApi"] == "responses" + assert params["models"][0]["id"] == "create-model" + assert params["models"][0]["maxContextWindowTokens"] == 12_000 + finally: + await session.disconnect() + finally: + await client.stop() + + async def test_should_forward_singular_provider_options_in_create_wire_request( + self, ctx: E2ETestContext + ): + cli_path = os.path.join(ctx.work_dir, f"fake-cli-provider-create-{os.getpid()}.js") + capture_path = os.path.join( + ctx.work_dir, f"fake-cli-provider-create-capture-{os.getpid()}.json" + ) + with open(cli_path, "w") as f: + f.write(FAKE_STDIO_CLI_SCRIPT) + + client = CopilotClient( + **_make_options( + ctx, + cli_path=cli_path, + cli_args=["--capture-file", capture_path], + use_logged_in_user=False, + ) + ) + try: + await client.start() + session = await client.create_session( + model="claude-sonnet-4.5", + provider={ + "type": "azure", + "wire_api": "responses", + "transport": "http", + "base_url": "https://azure-provider.example.test/openai", + "api_key": "provider-api-key", + "bearer_token": "provider-bearer-token", + "azure": {"api_version": "2024-02-15-preview"}, + "headers": {"X-Provider-Wire": "yes"}, + "model_id": "claude-sonnet-4.5", + "wire_model": "azure-deployment", + "max_prompt_tokens": 8192, + "max_output_tokens": 1024, + }, + on_permission_request=PermissionHandler.approve_all, + ) + try: + provider = _get_captured_request(capture_path, "session.create")["provider"] + assert provider["type"] == "azure" + assert provider["wireApi"] == "responses" + assert provider["transport"] == "http" + assert provider["baseUrl"] == "https://azure-provider.example.test/openai" + assert provider["apiKey"] == "provider-api-key" + assert provider["bearerToken"] == "provider-bearer-token" + assert provider["azure"]["apiVersion"] == "2024-02-15-preview" + assert provider["headers"]["X-Provider-Wire"] == "yes" + assert provider["modelId"] == "claude-sonnet-4.5" + assert provider["wireModel"] == "azure-deployment" + assert provider["maxPromptTokens"] == 8192 + assert provider["maxOutputTokens"] == 1024 + finally: + await session.disconnect() + finally: + await client.stop() + + async def test_should_forward_advanced_session_options_in_resume_wire_request( + self, ctx: E2ETestContext + ): + cli_path = os.path.join(ctx.work_dir, f"fake-cli-advanced-resume-{os.getpid()}.js") + capture_path = os.path.join( + ctx.work_dir, f"fake-cli-advanced-resume-capture-{os.getpid()}.json" + ) + output_directory = os.path.join(ctx.work_dir, "large-output-resume") + with open(cli_path, "w") as f: + f.write(FAKE_STDIO_CLI_SCRIPT) + + client = CopilotClient( + **_make_options( + ctx, + cli_path=cli_path, + cli_args=["--capture-file", capture_path], + use_logged_in_user=False, + ) + ) + try: + await client.start() + session = await client.resume_session( + "advanced-resume-session", + client_name="advanced-resume-client", + model="claude-haiku-4.5", + reasoning_effort="low", + reasoning_summary="none", + context_tier="default", + continue_pending_work=True, + mcp_oauth_token_storage="persistent", + plugin_directories=["plugins-resume"], + large_output={ + "enabled": False, + "max_size_bytes": 2048, + "output_directory": output_directory, + }, + memory={"enabled": False}, + remote_session=RemoteSessionMode.ON, + open_canvases=[ + OpenCanvasInstance( + canvas_id="resume-canvas", + extension_id="python-sdk-tests/resume-extension", + extension_name="Resume Extension", + instance_id="resume-canvas-1", + input={"start": 41}, + status="ready", + title="Resume Canvas", + url="https://example.com/resume-canvas", + ) + ], + on_permission_request=PermissionHandler.approve_all, + ) + try: + params = _get_captured_request(capture_path, "session.resume") + assert params["sessionId"] == "advanced-resume-session" + assert params["clientName"] == "advanced-resume-client" + assert params["model"] == "claude-haiku-4.5" + assert params["reasoningEffort"] == "low" + assert params["reasoningSummary"] == "none" + assert params["contextTier"] == "default" + assert params["continuePendingWork"] is True + assert params["mcpOAuthTokenStorage"] == "persistent" + assert params["pluginDirectories"][0] == "plugins-resume" + assert params["largeOutput"]["enabled"] is False + assert params["largeOutput"]["maxSizeBytes"] == 2048 + assert params["largeOutput"]["outputDir"] == output_directory + assert params["memory"]["enabled"] is False + assert params["remoteSession"] == "on" + + open_canvas = params["openCanvases"][0] + assert open_canvas["canvasId"] == "resume-canvas" + assert open_canvas["extensionId"] == "python-sdk-tests/resume-extension" + assert open_canvas["extensionName"] == "Resume Extension" + assert open_canvas["instanceId"] == "resume-canvas-1" + assert open_canvas["input"]["start"] == 41 + assert open_canvas["status"] == "ready" + assert open_canvas["title"] == "Resume Canvas" + assert open_canvas["url"] == "https://example.com/resume-canvas" + finally: + await session.disconnect() + finally: + await client.stop() diff --git a/python/e2e/test_compaction_e2e.py b/python/e2e/test_compaction_e2e.py index 85af017ae..73df54883 100644 --- a/python/e2e/test_compaction_e2e.py +++ b/python/e2e/test_compaction_e2e.py @@ -4,13 +4,13 @@ import pytest -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( SessionCompactionCompleteData, SessionCompactionStartData, SessionErrorData, SessionEventType, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext diff --git a/python/e2e/test_copilot_request_cancel_error_e2e.py b/python/e2e/test_copilot_request_cancel_error_e2e.py new file mode 100644 index 000000000..f32884a0e --- /dev/null +++ b/python/e2e/test_copilot_request_cancel_error_e2e.py @@ -0,0 +1,130 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""Cancellation and error coverage for CopilotRequestHandler. + +Mirrors ``nodejs/test/e2e/copilot_request_cancel_error.e2e.test.ts``. These +two scenarios exercise the handler's terminal paths that the happy-path +session-id and HTTP/WebSocket tests never reach: + +* **Error** — the handler throws from :meth:`CopilotRequestHandler.send_request` + for an inference request. The adapter reports a transport error back to the + runtime rather than hanging. +* **Runtime cancel** — the handler blocks an inference request indefinitely; + when the consumer aborts the turn the runtime cancels the in-flight request, + firing ``ctx.cancel_event``. The handler observes the abort (the ``cancel``-frame + path) instead of leaking a stuck request. + +Non-inference model-layer requests (catalog, policy, model session) are served +with minimal stubs so the turn reaches the inference step. +""" + +from __future__ import annotations + +import asyncio + +import httpx +import pytest + +from copilot import CopilotRequestContext, CopilotRequestHandler +from copilot.session import PermissionHandler + +from ._copilot_request_helpers import ( + is_inference_url, + isolated_client_fixture, +) + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +async def _wait_for(predicate, timeout_s: float) -> None: + loop = asyncio.get_event_loop() + start = loop.time() + while not predicate(): + if loop.time() - start > timeout_s: + raise TimeoutError("wait_for timed out") + await asyncio.sleep(0.05) + + +class _ThrowingHandler(CopilotRequestHandler): + """Throws from every inference request to exercise the error-reporting path.""" + + def __init__(self) -> None: + self.inference_attempts = 0 + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + url = str(request.url) + if not is_inference_url(url): + return await super().send_request(request, ctx) + self.inference_attempts += 1 + raise RuntimeError("synthetic-callback-transport-failure") + + +class _CancellingHandler(CopilotRequestHandler): + """Blocks every inference request until the runtime cancels it.""" + + def __init__(self) -> None: + self.inference_entered = False + self.saw_abort = False + self.abort_seen = asyncio.Event() + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + url = str(request.url) + if not is_inference_url(url): + return await super().send_request(request, ctx) + self.inference_entered = True + await ctx.cancel_event.wait() + self.saw_abort = True + self.abort_seen.set() + raise RuntimeError("cancelled by runtime") + + +throwing_client = isolated_client_fixture(_ThrowingHandler) +cancelling_client = isolated_client_fixture(_CancellingHandler) + + +class TestCopilotRequestHandlerError: + async def test_reports_thrown_callback_error_instead_of_hanging(self, throwing_client): + client, handler = throwing_client + await client.start() + session = await client.create_session(on_permission_request=PermissionHandler.approve_all) + try: + # The callback throws on inference; the turn surfaces an error (or + # completes without an assistant message) rather than hanging. + await session.send_and_wait("Say OK.") + except Exception: # noqa: BLE001 + # Any turn-level error is expected here; we only assert the callback + # was reached below. + pass + finally: + await session.disconnect() + + assert handler.inference_attempts > 0, ( + "expected the inference callback to be reached and raise" + ) + + +class TestCopilotRequestHandlerCancel: + async def test_fires_cancel_event_when_consumer_aborts_in_flight_request( + self, cancelling_client + ): + client, handler = cancelling_client + await client.start() + session = await client.create_session(on_permission_request=PermissionHandler.approve_all) + try: + await session.send("Say OK.") + await _wait_for(lambda: handler.inference_entered, 60.0) + await session.abort() + await asyncio.wait_for(handler.abort_seen.wait(), timeout=30.0) + finally: + await session.disconnect() + + assert handler.inference_entered is True, "expected the inference callback to be entered" + assert handler.saw_abort is True, ( + "expected the callback to observe runtime cancellation via cancel_event" + ) diff --git a/python/e2e/test_copilot_request_handler_e2e.py b/python/e2e/test_copilot_request_handler_e2e.py new file mode 100644 index 000000000..1811962e8 --- /dev/null +++ b/python/e2e/test_copilot_request_handler_e2e.py @@ -0,0 +1,284 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""E2E test for the idiomatic ``CopilotRequestHandler`` forwarding seams. + +Mirrors ``nodejs/test/e2e/copilot_request_handler.e2e.test.ts``. A single +handler subclass services BOTH transports against a per-test fake upstream: + +* HTTP — :meth:`send_request` rewrites the request to the local HTTP upstream, + mutates an outbound and a response header, and forwards via httpx. +* WebSocket — :meth:`open_websocket` rewrites the URL to the local WebSocket + upstream and returns a forwarding handler that counts messages in both + directions. + +Unlike the other inference tests (which fabricate responses inline), this one +exercises the default httpx / ``websockets`` forwarding machinery against a +real socket, proving the full chain runtime → handler → upstream → handler → +runtime is intact for whichever transport the agent turn selects. +""" + +from __future__ import annotations + +import json +import os +import threading +from dataclasses import dataclass, field +from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer + +import httpx +import pytest +import pytest_asyncio +from websockets.asyncio.server import serve as ws_serve + +from copilot import ( + CopilotClient, + CopilotRequestContext, + CopilotRequestHandler, + CopilotWebSocketForwarder, + RuntimeConnection, +) +from copilot.session import PermissionHandler + +from ._copilot_request_helpers import assistant_text, model_catalog, responses_events +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + +HTTP_TEXT = "OK from synthetic HTTP upstream." +WS_TEXT = "OK from synthetic WS upstream." + + +@dataclass +class _Counters: + http_requests: int = 0 + http_responses: int = 0 + ws_request_messages: int = 0 + ws_response_messages: int = 0 + + +@dataclass +class _Upstream: + http_url: str + ws_url: str + _http_server: ThreadingHTTPServer + _http_thread: threading.Thread + _ws_server: object + ws_requests: list[int] = field(default_factory=lambda: [0]) + + @property + def ws_request_count(self) -> int: + return self.ws_requests[0] + + async def close(self) -> None: + self._http_server.shutdown() + self._http_thread.join(timeout=5) + self._http_server.server_close() + self._ws_server.close() # type: ignore[attr-defined] + await self._ws_server.wait_closed() # type: ignore[attr-defined] + + +def _sse_body(text: str, resp_id: str) -> bytes: + out = "".join( + f"event: {event['type']}\ndata: {json.dumps(event)}\n\n" + for event in responses_events(text, resp_id) + ) + return out.encode("utf-8") + + +async def _start_fake_upstream() -> _Upstream: + class _Handler(BaseHTTPRequestHandler): + def log_message(self, *_args): # noqa: ANN002 - silence default logging + pass + + def _send(self, status: int, content_type: str, body: bytes) -> None: + self.send_response(status) + self.send_header("content-type", content_type) + self.send_header("content-length", str(len(body))) + self.end_headers() + self.wfile.write(body) + + def _route(self) -> None: + path = self.path.split("?", 1)[0].lower() + length = int(self.headers.get("content-length") or 0) + if length: + self.rfile.read(length) + if path.endswith("/models"): + self._send( + 200, + "application/json", + json.dumps( + model_catalog(supported_endpoints=["/responses", "ws:/responses"]) + ).encode("utf-8"), + ) + return + if path.endswith("/models/session"): + self._send(200, "application/json", b"{}") + return + if "/policy" in path: + self._send( + 200, + "application/json", + json.dumps({"state": "enabled"}).encode("utf-8"), + ) + return + if path.endswith("/responses"): + self._send(200, "text/event-stream", _sse_body(HTTP_TEXT, "resp_stub_http")) + return + self._send( + 404, + "application/json", + json.dumps({"error": "not_found", "path": path}).encode("utf-8"), + ) + + def do_GET(self): # noqa: N802 + self._route() + + def do_POST(self): # noqa: N802 + self._route() + + http_server = ThreadingHTTPServer(("127.0.0.1", 0), _Handler) + http_port = http_server.server_address[1] + http_thread = threading.Thread(target=http_server.serve_forever, daemon=True) + http_thread.start() + + ws_requests = [0] + + async def ws_handler(connection) -> None: + async for _raw in connection: + ws_requests[0] += 1 + for event in responses_events(WS_TEXT, "resp_stub_ws"): + await connection.send(json.dumps(event)) + + ws_server = await ws_serve(ws_handler, "127.0.0.1", 0) + ws_port = ws_server.sockets[0].getsockname()[1] + + return _Upstream( + http_url=f"http://127.0.0.1:{http_port}", + ws_url=f"ws://127.0.0.1:{ws_port}", + _http_server=http_server, + _http_thread=http_thread, + _ws_server=ws_server, + ws_requests=ws_requests, + ) + + +class _CountingSocketHandler(CopilotWebSocketForwarder): + """Forwarding WebSocket handler that counts messages in both directions.""" + + def __init__(self, ctx: CopilotRequestContext, counters: _Counters) -> None: + super().__init__(ctx) + self._counters = counters + + async def send_request_message(self, data: str | bytes) -> None: + self._counters.ws_request_messages += 1 + await super().send_request_message(data) + + async def send_response_message(self, data: str | bytes) -> None: + self._counters.ws_response_messages += 1 + await super().send_response_message(data) + + +class _TestHandler(CopilotRequestHandler): + def __init__(self, upstream: _Upstream, counters: _Counters) -> None: + self._upstream = upstream + self._counters = counters + self._client = httpx.AsyncClient(timeout=None, follow_redirects=False) + + def _rewrite_http(self, url: httpx.URL) -> httpx.URL: + up = httpx.URL(self._upstream.http_url) + return url.copy_with(scheme=up.scheme, host=up.host, port=up.port) + + def _rewrite_ws(self, url: str) -> str: + parsed = httpx.URL(url) + up = httpx.URL(self._upstream.ws_url) + return str(parsed.copy_with(scheme=up.scheme, host=up.host, port=up.port)) + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + self._counters.http_requests += 1 + headers = dict(request.headers) + headers["x-test-mutated"] = "1" + rewritten = httpx.Request( + request.method, + self._rewrite_http(request.url), + headers=headers, + content=request.content, + ) + response = await self._client.send(rewritten, stream=True) + self._counters.http_responses += 1 + response.headers["x-test-response-mutated"] = "1" + return response + + async def open_websocket(self, ctx: CopilotRequestContext): + ctx.url = self._rewrite_ws(ctx.url) + return _CountingSocketHandler(ctx, self._counters) + + async def aclose(self) -> None: + await self._client.aclose() + + +@dataclass +class _HandlerFixture: + client: CopilotClient + upstream: _Upstream + counters: _Counters + + +@pytest_asyncio.fixture(loop_scope="module") +async def handler_fixture(ctx: E2ETestContext): + upstream = await _start_fake_upstream() + counters = _Counters() + handler = _TestHandler(upstream, counters) + github_token = ( + "fake-token-for-e2e-tests" if os.environ.get("GITHUB_ACTIONS") == "true" else None + ) + env = {**ctx.get_env(), "COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES": "true"} + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=github_token, + request_handler=handler, + ) + try: + yield _HandlerFixture(client=client, upstream=upstream, counters=counters) + finally: + try: + await client.stop() + except Exception: + # Best-effort teardown during fixture cleanup. + pass + await handler.aclose() + await upstream.close() + + +class TestCopilotRequestHandler: + async def test_services_http_and_websocket_via_one_handler(self, handler_fixture): + fx = handler_fixture + await fx.client.start() + session = await fx.client.create_session( + on_permission_request=PermissionHandler.approve_all + ) + text = "" + try: + result = await session.send_and_wait("Say OK.") + text = assistant_text(result) + finally: + await session.disconnect() + + # The HTTP seam fired — the runtime issued model-layer GETs (catalog, + # policy) and possibly a single-shot inference through send_request. + assert fx.counters.http_requests > 0, "expected send_request to fire" + assert fx.counters.http_responses > 0, "expected send_request response mutation to fire" + + # The WebSocket seam fired — the main agent turn went over the WS path + # and we observed messages in both directions. + assert fx.counters.ws_request_messages > 0, "expected runtime → upstream ws messages" + assert fx.counters.ws_response_messages > 0, "expected upstream → runtime ws messages" + assert fx.upstream.ws_request_count > 0, "expected upstream WS to receive request messages" + + # Validate the final assistant response arrived (guards against truncated captures) + assert "OK from synthetic" in text and "upstream" in text diff --git a/python/e2e/test_copilot_request_session_id_e2e.py b/python/e2e/test_copilot_request_session_id_e2e.py new file mode 100644 index 000000000..81624d73d --- /dev/null +++ b/python/e2e/test_copilot_request_session_id_e2e.py @@ -0,0 +1,138 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# -------------------------------------------------------------------------------------------- + +"""E2E tests asserting the runtime threads its session id into the +CopilotRequestHandler for both CAPI and BYOK sessions. + +Mirrors ``nodejs/test/e2e/copilot_request_session_id.e2e.test.ts``. The handler +alone services every model-layer request (no upstream server, no CAPI proxy +acting as the inference endpoint), so the only source of ``ctx.session_id`` is +the runtime's own per-client threading. +""" + +from __future__ import annotations + +from dataclasses import dataclass + +import httpx +import pytest + +from copilot import CopilotRequestContext, CopilotRequestHandler +from copilot.session import PermissionHandler + +from ._copilot_request_helpers import ( + assistant_text, + build_inference_response, + build_non_inference_response, + is_inference_url, + isolated_client_fixture, +) + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +@dataclass +class _InterceptedRequest: + url: str + session_id: str | None + agent_id: str | None + parent_agent_id: str | None + interaction_type: str | None + + +class _SessionIdHandler(CopilotRequestHandler): + def __init__(self) -> None: + self.records: list[_InterceptedRequest] = [] + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + url = str(request.url) + self.records.append( + _InterceptedRequest( + url=url, + session_id=ctx.session_id, + agent_id=ctx.agent_id, + parent_agent_id=ctx.parent_agent_id, + interaction_type=ctx.interaction_type, + ) + ) + if is_inference_url(url): + return build_inference_response(request) + # Force /responses transport so the inference URL is predictable. + return build_non_inference_response(url, supported_endpoints=["/responses"]) + + +session_id_client = isolated_client_fixture(_SessionIdHandler) + + +def _assert_agent_metadata(record: _InterceptedRequest) -> None: + assert record.agent_id + assert record.interaction_type + + +class TestCopilotRequestSessionId: + capi_session_id: str | None = None + + async def test_threads_session_id_into_capi_session(self, session_id_client): + client, handler = session_id_client + await client.start() + baseline = len(handler.records) + session = await client.create_session(on_permission_request=PermissionHandler.approve_all) + TestCopilotRequestSessionId.capi_session_id = session.session_id + text = "" + try: + result = await session.send_and_wait("Say OK.") + text = assistant_text(result) + finally: + await session.disconnect() + + inference = [r for r in handler.records[baseline:] if is_inference_url(r.url)] + assert len(inference) > 0, "expected at least one intercepted inference request" + for r in inference: + assert r.session_id == session.session_id, ( + "CAPI inference request must carry the runtime session id" + ) + _assert_agent_metadata(r) + + # Validate the final assistant response arrived (guards against truncated captures) + assert "OK from the synthetic" in text + + async def test_threads_session_id_into_byok_session(self, session_id_client): + client, handler = session_id_client + await client.start() + baseline = len(handler.records) + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="claude-sonnet-4.5", + provider={ + "type": "openai", + "wire_api": "responses", + "base_url": "https://byok.invalid/v1", + "api_key": "byok-secret", + "model_id": "claude-sonnet-4.5", + "wire_model": "claude-sonnet-4.5", + }, + ) + byok_session_id = session.session_id + text = "" + try: + result = await session.send_and_wait("Say OK.") + text = assistant_text(result) + finally: + await session.disconnect() + + inference = [r for r in handler.records[baseline:] if is_inference_url(r.url)] + assert len(inference) > 0, "expected at least one intercepted BYOK inference request" + for r in inference: + assert r.session_id == byok_session_id, ( + "BYOK inference request must carry the runtime session id" + ) + _assert_agent_metadata(r) + + # Session ids are per-session, so the two turns must differ. + assert byok_session_id != TestCopilotRequestSessionId.capi_session_id + + # Validate the final assistant response arrived (guards against truncated captures) + assert "OK from the synthetic" in text diff --git a/python/e2e/test_event_fidelity_e2e.py b/python/e2e/test_event_fidelity_e2e.py index b85609640..25b18407a 100644 --- a/python/e2e/test_event_fidelity_e2e.py +++ b/python/e2e/test_event_fidelity_e2e.py @@ -6,7 +6,8 @@ import pytest -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( AssistantMessageData, AssistantUsageData, PendingMessagesModifiedData, @@ -15,7 +16,6 @@ ToolExecutionStartData, UserMessageData, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext diff --git a/python/e2e/test_github_telemetry_e2e.py b/python/e2e/test_github_telemetry_e2e.py new file mode 100644 index 000000000..976b0b616 --- /dev/null +++ b/python/e2e/test_github_telemetry_e2e.py @@ -0,0 +1,57 @@ +"""Live CLI E2E coverage for forwarded GitHub telemetry notifications.""" + +from __future__ import annotations + +import asyncio + +import pytest + +from copilot import CopilotClient, GitHubTelemetryNotification, RuntimeConnection +from copilot.session import PermissionHandler + +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext +from .testharness.context import get_cli_path_for_tests + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +class TestGitHubTelemetryE2E: + async def test_should_receive_session_start_github_telemetry(self, ctx: E2ETestContext): + received: list[GitHubTelemetryNotification] = [] + + def on_github_telemetry(notification: GitHubTelemetryNotification) -> None: + received.append(notification) + + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=get_cli_path_for_tests(), args=()), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + on_github_telemetry=on_github_telemetry, + ) + + session = None + try: + await client.start() + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + + for _ in range(600): + if received: + break + await asyncio.sleep(0.05) + + assert received + notification = received[0] + assert isinstance(notification.session_id, str) + assert notification.session_id + assert isinstance(notification.restricted, bool) + assert notification.event is not None + assert isinstance(notification.event.kind, str) + finally: + try: + if session is not None: + await session.disconnect() + finally: + await client.stop() diff --git a/python/e2e/test_hooks_e2e.py b/python/e2e/test_hooks_e2e.py index 088379d4c..d9a67cf03 100644 --- a/python/e2e/test_hooks_e2e.py +++ b/python/e2e/test_hooks_e2e.py @@ -18,10 +18,11 @@ class TestHooks: async def test_should_invoke_pretooluse_hook_when_model_runs_a_tool(self, ctx: E2ETestContext): """Test that preToolUse hook is invoked when model runs a tool""" pre_tool_use_inputs = [] + invocation_session_ids = [] async def on_pre_tool_use(input_data, invocation): pre_tool_use_inputs.append(input_data) - assert invocation["session_id"] == session.session_id + invocation_session_ids.append(invocation["session_id"]) # Allow the tool to run return {"permissionDecision": "allow"} @@ -37,6 +38,7 @@ async def on_pre_tool_use(input_data, invocation): # Should have received at least one preToolUse hook call assert len(pre_tool_use_inputs) > 0 + assert all(session_id == session.session_id for session_id in invocation_session_ids) # Should have received the tool name assert any(inp.get("toolName") for inp in pre_tool_use_inputs) @@ -48,10 +50,11 @@ async def test_should_invoke_posttooluse_hook_after_model_runs_a_tool( ): """Test that postToolUse hook is invoked after model runs a tool""" post_tool_use_inputs = [] + invocation_session_ids = [] async def on_post_tool_use(input_data, invocation): post_tool_use_inputs.append(input_data) - assert invocation["session_id"] == session.session_id + invocation_session_ids.append(invocation["session_id"]) return None session = await ctx.client.create_session( @@ -66,6 +69,7 @@ async def on_post_tool_use(input_data, invocation): # Should have received at least one postToolUse hook call assert len(post_tool_use_inputs) > 0 + assert all(session_id == session.session_id for session_id in invocation_session_ids) # Should have received the tool name and result assert any(inp.get("toolName") for inp in post_tool_use_inputs) diff --git a/python/e2e/test_hooks_extended_e2e.py b/python/e2e/test_hooks_extended_e2e.py index a0216e47f..7af20f32b 100644 --- a/python/e2e/test_hooks_extended_e2e.py +++ b/python/e2e/test_hooks_extended_e2e.py @@ -3,8 +3,9 @@ E2E coverage for every handler exposed on ``SessionHooks``: ``on_pre_tool_use``, ``on_post_tool_use``, ``on_post_tool_use_failure``, -``on_user_prompt_submitted``, ``on_session_start``, ``on_session_end``, -``on_error_occurred``. Output-shape behavior (modifiedPrompt / +``on_user_prompt_submitted``, ``on_user_prompt_transformed``, ``on_session_start``, +``on_session_end``, +``on_error_occurred``, ``on_agent_stop``. Output-shape behavior (modifiedPrompt / additionalContext / errorHandling / modifiedArgs / modifiedResult / sessionSummary) is asserted alongside hook invocation. """ @@ -28,10 +29,11 @@ async def test_should_invoke_userpromptsubmitted_hook_and_modify_prompt( self, ctx: E2ETestContext ): inputs: list[dict] = [] + invocation_session_ids: list[str] = [] async def on_user_prompt_submitted(input_data, invocation): inputs.append(input_data) - assert invocation["session_id"] + invocation_session_ids.append(invocation["session_id"]) return {"modifiedPrompt": "Reply with exactly: HOOKED_PROMPT"} session = await ctx.client.create_session( @@ -41,17 +43,45 @@ async def on_user_prompt_submitted(input_data, invocation): try: response = await session.send_and_wait("Say something else") assert inputs + assert all(session_id == session.session_id for session_id in invocation_session_ids) assert "Say something else" in inputs[0].get("prompt", "") assert "HOOKED_PROMPT" in (response.data.content or "") finally: await session.disconnect() + async def test_should_invoke_userprompttransformed_hook_and_modify_transformed_prompt( + self, ctx: E2ETestContext + ): + inputs: list[dict] = [] + + async def on_user_prompt_transformed(input_data, invocation): + assert invocation["session_id"] + inputs.append(input_data) + return {"modifiedTransformedPrompt": "Reply with exactly: HOOKED_TRANSFORMED_PROMPT"} + + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + hooks={"on_user_prompt_transformed": on_user_prompt_transformed}, + ) + try: + response = await session.send_and_wait("Answer the request above.") + assert inputs + assert "Answer the request above." in inputs[0]["prompt"] + assert "Answer the request above." in inputs[0]["transformedPrompt"] + assert "" in inputs[0]["transformedPrompt"] + assert inputs[0]["timestamp"].timestamp() > 0 + assert inputs[0]["workingDirectory"] + assert "HOOKED_TRANSFORMED_PROMPT" in (response.data.content or "") + finally: + await session.disconnect() + async def test_should_invoke_sessionstart_hook(self, ctx: E2ETestContext): inputs: list[dict] = [] + invocation_session_ids: list[str] = [] async def on_session_start(input_data, invocation): inputs.append(input_data) - assert invocation["session_id"] + invocation_session_ids.append(invocation["session_id"]) return {"additionalContext": "Session start hook context."} session = await ctx.client.create_session( @@ -61,6 +91,7 @@ async def on_session_start(input_data, invocation): try: await session.send_and_wait("Say hi") assert inputs + assert all(session_id == session.session_id for session_id in invocation_session_ids) assert inputs[0].get("source") == "new" assert inputs[0].get("workingDirectory") finally: @@ -68,13 +99,14 @@ async def on_session_start(input_data, invocation): async def test_should_invoke_sessionend_hook(self, ctx: E2ETestContext): inputs: list[dict] = [] + invocation_session_ids: list[str] = [] hook_invoked: asyncio.Future = asyncio.get_event_loop().create_future() async def on_session_end(input_data, invocation): inputs.append(input_data) + invocation_session_ids.append(invocation["session_id"]) if not hook_invoked.done(): hook_invoked.set_result(input_data) - assert invocation["session_id"] return {"sessionSummary": "session ended"} session = await ctx.client.create_session( @@ -85,13 +117,15 @@ async def on_session_end(input_data, invocation): await session.disconnect() await asyncio.wait_for(hook_invoked, 10.0) assert inputs + assert all(session_id == session.session_id for session_id in invocation_session_ids) async def test_should_register_erroroccurred_hook(self, ctx: E2ETestContext): inputs: list[dict] = [] + invocation_session_ids: list[str] = [] async def on_error_occurred(input_data, invocation): inputs.append(input_data) - assert invocation["session_id"] + invocation_session_ids.append(invocation["session_id"]) return {"errorHandling": "skip"} session = await ctx.client.create_session( @@ -102,10 +136,39 @@ async def on_error_occurred(input_data, invocation): await session.send_and_wait("Say hi") # Registration-only test: a healthy turn shouldn't fire OnErrorOccurred. assert not inputs + assert not invocation_session_ids assert session.session_id finally: await session.disconnect() + async def test_should_invoke_agentstop_hook_and_apply_block_response(self, ctx: E2ETestContext): + inputs: list[dict] = [] + + async def on_agent_stop(input_data, invocation): + assert invocation["session_id"] == session.session_id + inputs.append(input_data) + if len(inputs) == 1: + return { + "decision": "block", + "reason": "Reply with exactly: AGENT_STOP_CONTINUED", + } + return None + + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + hooks={"on_agent_stop": on_agent_stop}, + ) + try: + response = await session.send_and_wait("Reply with exactly: AGENT_STOP_INITIAL") + assert len(inputs) == 2 + assert inputs[0].get("stopHookActive") is not True + assert inputs[1].get("stopHookActive") is True + assert inputs[0].get("stopReason") == "end_turn" + assert inputs[0].get("transcriptPath") + assert "AGENT_STOP_CONTINUED" in (response.data.content or "") + finally: + await session.disconnect() + async def test_should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput( self, ctx: E2ETestContext ): @@ -161,7 +224,7 @@ async def test_should_allow_posttooluse_to_return_modifiedresult(self, ctx: E2ET async def on_post_tool_use(input_data, invocation): inputs.append(input_data) - if input_data.get("toolName") != "report_intent": + if input_data.get("toolName") != "view": return None return { "modifiedResult": { @@ -174,23 +237,28 @@ async def on_post_tool_use(input_data, invocation): session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, - available_tools=["report_intent"], hooks={"on_post_tool_use": on_post_tool_use}, ) try: response = await session.send_and_wait( - "Call the report_intent tool with intent 'Testing post hook', then reply done." + "Call the view tool to read the current directory, then reply done." ) - assert any(inp.get("toolName") == "report_intent" for inp in inputs) - assert (response.data.content or "").strip().rstrip(".") in {"Done", "done"} + assert any(inp.get("toolName") == "view" for inp in inputs) + assert "done" in (response.data.content or "").lower() finally: await session.disconnect() + @pytest.mark.skip( + reason="Fails with 1.0.64-0 runtime: built-in tools are not available when hooks " + "restrict availableTools, so the failure path cannot be exercised. " + "Follow up with runtime team." + ) async def test_should_invoke_posttoolusefailure_hook_for_failed_tool_result( self, ctx: E2ETestContext ): failure_inputs: list[dict] = [] post_tool_use_inputs: list[dict] = [] + invocation_session_ids: list[str] = [] async def on_post_tool_use(input_data, invocation): post_tool_use_inputs.append(input_data) @@ -198,7 +266,7 @@ async def on_post_tool_use(input_data, invocation): async def on_post_tool_use_failure(input_data, invocation): failure_inputs.append(input_data) - assert invocation["session_id"] == session.session_id + invocation_session_ids.append(invocation["session_id"]) return {"additionalContext": "HOOK_FAILURE_GUIDANCE_APPLIED"} session = await ctx.client.create_session( @@ -216,6 +284,7 @@ async def on_post_tool_use_failure(input_data, invocation): ) assert not post_tool_use_inputs assert len(failure_inputs) == 1 + assert all(session_id == session.session_id for session_id in invocation_session_ids) failure_input = failure_inputs[0] assert failure_input["toolName"] == "view" assert "does not exist" in failure_input["error"] diff --git a/python/e2e/test_inprocess_ffi_e2e.py b/python/e2e/test_inprocess_ffi_e2e.py new file mode 100644 index 000000000..c119c4ea4 --- /dev/null +++ b/python/e2e/test_inprocess_ffi_e2e.py @@ -0,0 +1,40 @@ +"""E2E smoke test for the in-process (FFI) transport. + +Starts a client over the in-process FFI transport, performs a ``ping`` +round-trip through the native runtime library, and stops cleanly. Resolution of +the transport from ``COPILOT_SDK_DEFAULT_CONNECTION`` is exercised by the full +E2E suite running under the ``inprocess`` CI matrix cell, not here. + +Mirrors nodejs/test/e2e/inprocess_ffi.e2e.test.ts. +""" + +from __future__ import annotations + +import pytest + +from copilot import CopilotClient, RuntimeConnection + +from .testharness import E2ETestContext +from .testharness.context import get_cli_path_for_tests + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +class TestInProcessFfi: + async def test_should_start_and_connect_over_in_process_ffi( + self, ctx: E2ETestContext, monkeypatch: pytest.MonkeyPatch + ): + # In-process hosting loads the runtime cdylib next to the resolved CLI + # entrypoint and lets the native host spawn the worker. ``ping`` is a + # purely local RPC round-trip, so no auth or replay proxy is involved. + # If the native library is unavailable, start() raises and the test fails. + monkeypatch.setenv("COPILOT_CLI_PATH", get_cli_path_for_tests()) + client = CopilotClient(connection=RuntimeConnection.for_inprocess()) + await client.start() + + try: + pong = await client.ping("ffi message") + assert pong.message == "pong: ffi message" + assert pong.timestamp is not None + finally: + await client.stop() diff --git a/python/e2e/test_mcp_and_agents_e2e.py b/python/e2e/test_mcp_and_agents_e2e.py index be017a1e5..e583dbdd7 100644 --- a/python/e2e/test_mcp_and_agents_e2e.py +++ b/python/e2e/test_mcp_and_agents_e2e.py @@ -8,8 +8,8 @@ import pytest -from copilot.generated.rpc import McpServerStatus from copilot.session import CustomAgentConfig, MCPServerConfig, PermissionHandler +from copilot.session_events import McpServerStatus from .testharness import E2ETestContext diff --git a/python/e2e/test_mcp_oauth_e2e.py b/python/e2e/test_mcp_oauth_e2e.py new file mode 100644 index 000000000..9d70597c3 --- /dev/null +++ b/python/e2e/test_mcp_oauth_e2e.py @@ -0,0 +1,347 @@ +import asyncio +import json +import os +from pathlib import Path +from typing import Any + +import httpx +import pytest + +from copilot.generated.rpc import ( + MCPAppsCallToolRequest, + MCPListToolsRequest, + MCPOauthHandlePendingRequest, + MCPOauthPendingRequestResponse, + MCPOauthPendingRequestResponseKind, +) +from copilot.session import MCPServerConfig, PermissionHandler +from copilot.session_events import McpServerStatus + +from .testharness import E2ETestContext, wait_for_condition + +TEST_MCP_OAUTH_SERVER = str( + (Path(__file__).parents[2] / "test" / "harness" / "test-mcp-oauth-server.mjs").resolve() +) +EXPECTED_TOKEN = "sdk-host-token" +REFRESH_TOKEN = f"{EXPECTED_TOKEN}-refresh" +UPSCOPE_TOKEN = f"{EXPECTED_TOKEN}-upscope" +REAUTH_TOKEN = f"{EXPECTED_TOKEN}-reauth" + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +async def _start_oauth_mcp_server() -> tuple[str, asyncio.subprocess.Process]: + process = await asyncio.create_subprocess_exec( + "node", + TEST_MCP_OAUTH_SERVER, + stdout=asyncio.subprocess.PIPE, + stderr=asyncio.subprocess.PIPE, + env={**os.environ, "EXPECTED_TOKEN": EXPECTED_TOKEN}, + ) + assert process.stdout is not None + + try: + line = await asyncio.wait_for(process.stdout.readline(), timeout=10) + except TimeoutError as exc: + await _stop_process(process) + assert process.stderr is not None + stderr = (await process.stderr.read()).decode(errors="replace") + raise TimeoutError(f"Timed out waiting for OAuth MCP server: {stderr}") from exc + if not line: + assert process.stderr is not None + stderr = (await process.stderr.read()).decode(errors="replace") + raise RuntimeError(f"OAuth MCP server exited before listening: {stderr}") + text = line.decode().strip() + if text.startswith("Listening: "): + return text.removeprefix("Listening: "), process + + await _stop_process(process) + raise RuntimeError(f"Unexpected OAuth MCP server startup line: {text}") + + +async def _stop_process(process: asyncio.subprocess.Process) -> None: + if process.returncode is not None: + return + process.terminate() + try: + await asyncio.wait_for(process.wait(), timeout=5) + except TimeoutError: + process.kill() + await process.wait() + + +async def _requests(base_url: str) -> list[dict[str, Any]]: + async with httpx.AsyncClient() as client: + response = await client.get(f"{base_url}/__requests") + response.raise_for_status() + return response.json() + + +async def _wait_for_mcp_server_status( + session, server_name: str, expected_status: McpServerStatus = McpServerStatus.CONNECTED +) -> None: + last_status = "" + + async def matches() -> bool: + nonlocal last_status + result = await session.rpc.mcp.list() + server = next((s for s in result.servers if s.name == server_name), None) + last_status = server.status.value if server is not None else "" + return server is not None and server.status == expected_status + + await wait_for_condition( + matches, + timeout=60.0, + poll_interval=0.2, + timeout_message=( + f"{server_name} did not reach {expected_status.value}; last status was {last_status}" + ), + ) + + +class TestMcpOAuth: + async def test_should_satisfy_mcp_oauth_using_host_provided_token(self, ctx: E2ETestContext): + url, process = await _start_oauth_mcp_server() + server_name = "oauth-protected-mcp" + observed_request = None + + def on_mcp_auth_request(request, _invocation): + nonlocal observed_request + observed_request = request + return { + "kind": "token", + "accessToken": EXPECTED_TOKEN, + "tokenType": "Bearer", + "expiresIn": 3600, + } + + try: + mcp_servers: dict[str, MCPServerConfig] = { + server_name: { + "type": "http", + "url": f"{url}/mcp", + "tools": ["*"], + } + } + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + mcp_servers=mcp_servers, + ) as session: + await _wait_for_mcp_server_status(session, server_name) + + tools = await session.rpc.mcp.list_tools( + MCPListToolsRequest(server_name=server_name) + ) + assert [tool.name for tool in tools.tools] == ["whoami"] + + assert observed_request is not None + assert observed_request["serverName"] == server_name + assert observed_request["serverUrl"] == f"{url}/mcp" + assert observed_request["reason"] == "initial" + assert observed_request["wwwAuthenticateParams"] == { + "resourceMetadataUrl": f"{url}/.well-known/oauth-protected-resource", + "scope": "mcp.read", + "error": "invalid_token", + } + assert json.loads(observed_request["resourceMetadata"]) == { + "resource": f"{url}/mcp", + "authorization_servers": [url], + "scopes_supported": ["mcp.read"], + "bearer_methods_supported": ["header"], + } + + requests = await _requests(url) + assert any(request["authorization"] is None for request in requests) + assert any( + request["authorization"] == f"Bearer {EXPECTED_TOKEN}" for request in requests + ) + finally: + await _stop_process(process) + + async def test_should_resolve_pending_mcp_oauth_request_with_direct_rpc( + self, ctx: E2ETestContext + ): + url, process = await _start_oauth_mcp_server() + server_name = "oauth-direct-rpc-mcp" + loop = asyncio.get_running_loop() + observed_request = loop.create_future() + release_handler = asyncio.Event() + + async def on_mcp_auth_request(request, _invocation): + if not observed_request.done(): + observed_request.set_result(request) + await release_handler.wait() + return {"kind": "token", "accessToken": EXPECTED_TOKEN} + + try: + mcp_servers: dict[str, MCPServerConfig] = { + server_name: { + "type": "http", + "url": f"{url}/mcp", + "tools": ["*"], + "oauthClientId": "sdk-e2e-client", + "oauthPublicClient": True, + } + } + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + mcp_servers=mcp_servers, + enable_mcp_apps=True, + ) as session: + connected = asyncio.create_task(_wait_for_mcp_server_status(session, server_name)) + try: + request = await asyncio.wait_for(observed_request, timeout=30.0) + assert request["serverName"] == server_name + assert request["serverUrl"] == f"{url}/mcp" + assert request["reason"] == "initial" + assert request["wwwAuthenticateParams"] == { + "resourceMetadataUrl": f"{url}/.well-known/oauth-protected-resource", + "scope": "mcp.read", + "error": "invalid_token", + } + + handled = await session.rpc.mcp.oauth.handle_pending_request( + MCPOauthHandlePendingRequest( + request_id=request["requestId"], + result=MCPOauthPendingRequestResponse( + kind=MCPOauthPendingRequestResponseKind.TOKEN, + access_token=EXPECTED_TOKEN, + token_type="Bearer", + expires_in=3600, + ), + ) + ) + assert handled.success is True + + connected_result = await asyncio.wait_for(connected, timeout=60.0) + assert connected_result is None + tools = await session.rpc.mcp.list_tools( + MCPListToolsRequest(server_name=server_name) + ) + assert [tool.name for tool in tools.tools] == ["whoami"] + finally: + release_handler.set() + if not connected.done(): + connected.cancel() + finally: + await _stop_process(process) + + async def test_should_request_replacement_tokens_across_mcp_oauth_lifecycle( + self, ctx: E2ETestContext + ): + url, process = await _start_oauth_mcp_server() + server_name = "oauth-lifecycle-mcp" + observed_requests: list[dict[str, Any]] = [] + refresh_count = 0 + + def on_mcp_auth_request(request, _invocation): + nonlocal refresh_count + observed_requests.append(request) + if request["reason"] == "refresh": + refresh_count += 1 + assert request["wwwAuthenticateParams"] == {"error": "invalid_token"} + if refresh_count > 1: + return {"kind": "cancelled"} + return {"kind": "token", "accessToken": REFRESH_TOKEN} + if request["reason"] == "upscope": + assert request["wwwAuthenticateParams"] == { + "resourceMetadataUrl": f"{url}/.well-known/oauth-protected-resource", + "scope": "mcp.write", + "error": "insufficient_scope", + } + return {"kind": "token", "accessToken": UPSCOPE_TOKEN} + if request["reason"] == "reauth": + return {"kind": "token", "accessToken": REAUTH_TOKEN} + return {"kind": "token", "accessToken": EXPECTED_TOKEN} + + try: + mcp_servers: dict[str, MCPServerConfig] = { + server_name: { + "type": "http", + "url": f"{url}/mcp", + "tools": ["*"], + } + } + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + mcp_servers=mcp_servers, + enable_mcp_apps=True, + ) as session: + await _wait_for_mcp_server_status(session, server_name) + + for scenario in ("refresh", "upscope", "reauth"): + result = await session.rpc.mcp.apps.call_tool( + MCPAppsCallToolRequest( + origin_server_name=server_name, + server_name=server_name, + tool_name="whoami", + arguments={"scenario": scenario}, + ) + ) + assert result["content"] == [{"type": "text", "text": "oauth-test-user"}] + + assert [request["reason"] for request in observed_requests] == [ + "initial", + "refresh", + "upscope", + "refresh", + "reauth", + ] + requests = await _requests(url) + assert any( + request["authorization"] == f"Bearer {REFRESH_TOKEN}" for request in requests + ) + assert any( + request["authorization"] == f"Bearer {UPSCOPE_TOKEN}" for request in requests + ) + assert any(request["authorization"] == f"Bearer {REAUTH_TOKEN}" for request in requests) + finally: + await _stop_process(process) + + async def test_should_cancel_pending_mcp_oauth_request(self, ctx: E2ETestContext): + url, process = await _start_oauth_mcp_server() + server_name = "oauth-cancelled-mcp" + observed_request = None + + def on_mcp_auth_request(request, _invocation): + nonlocal observed_request + observed_request = request + return {"kind": "cancelled"} + + try: + mcp_servers: dict[str, MCPServerConfig] = { + server_name: { + "type": "http", + "url": f"{url}/mcp", + "tools": ["*"], + } + } + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + mcp_servers=mcp_servers, + ) as session: + await _wait_for_mcp_server_status(session, server_name, McpServerStatus.NEEDS_AUTH) + + # The MCP connection is kicked off by session.create, but the SDK only registers + # its `mcp.oauth_required` event interest once create returns. If the server's + # initial 401 wins that race, the runtime records `needs-auth` WITHOUT invoking + # the host callback, so `observed_request` is briefly None even after `needs-auth` + # is observed. A later auth retry (now that interest is registered) invokes the + # callback with the same `initial` reason. Wait for the callback rather than + # sampling it the instant `needs-auth` first appears, which made this test flaky. + await wait_for_condition( + lambda: observed_request is not None, + timeout=60.0, + poll_interval=0.2, + timeout_message=f"{server_name} OAuth request did not reach the host callback", + ) + + assert observed_request is not None + assert observed_request["serverName"] == server_name + assert observed_request["reason"] == "initial" + finally: + await _stop_process(process) diff --git a/python/e2e/test_mode_handlers_e2e.py b/python/e2e/test_mode_handlers_e2e.py index 1d0c46354..f6173a4a5 100644 --- a/python/e2e/test_mode_handlers_e2e.py +++ b/python/e2e/test_mode_handlers_e2e.py @@ -6,7 +6,8 @@ import pytest -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( AutoModeSwitchCompletedData, AutoModeSwitchRequestedData, AutoModeSwitchResponse, @@ -16,7 +17,6 @@ SessionIdleData, SessionModelChangeData, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext @@ -35,7 +35,7 @@ async def mode_ctx(ctx: E2ETestContext): """Configure per-token user responses for mode-handler tests.""" proxy_url = ctx.proxy_url - ctx.client._options.env["COPILOT_DEBUG_GITHUB_API_URL"] = proxy_url + ctx.add_runtime_env("COPILOT_DEBUG_GITHUB_API_URL", proxy_url) await ctx.set_copilot_user_by_token( MODE_HANDLER_TOKEN, @@ -119,7 +119,7 @@ async def on_exit_plan_mode_request(request, invocation): assert len(exit_plan_mode_requests) == 1 request = exit_plan_mode_requests[0] assert request["summary"] == PLAN_SUMMARY - assert request["actions"] == ["interactive", "autopilot", "exit_only"] + assert request["actions"] == ["autopilot", "interactive", "exit_only"] assert request["recommendedAction"] == "interactive" assert request.get("planContent") is not None diff --git a/python/e2e/test_multi_client_e2e.py b/python/e2e/test_multi_client_e2e.py index 90492e883..91beb2239 100644 --- a/python/e2e/test_multi_client_e2e.py +++ b/python/e2e/test_multi_client_e2e.py @@ -15,7 +15,10 @@ from pydantic import BaseModel, Field from copilot import CopilotClient, RuntimeConnection, define_tool -from copilot.generated.rpc import PermissionDecisionApproveOnce, PermissionDecisionReject +from copilot.rpc import ( + PermissionDecisionApproveOnce, + PermissionDecisionReject, +) from copilot.session import PermissionHandler, PermissionNoResult from copilot.tools import ToolInvocation diff --git a/python/e2e/test_multi_provider_registry_e2e.py b/python/e2e/test_multi_provider_registry_e2e.py new file mode 100644 index 000000000..a20862455 --- /dev/null +++ b/python/e2e/test_multi_provider_registry_e2e.py @@ -0,0 +1,206 @@ +"""E2E tests for the experimental multi-provider BYOK registry. + +Validates that several named providers, several models per provider, and custom +agents bound to those provider-qualified models can coexist in one session, be +launched, and route inference to the configured provider with the configured +wire model and headers. +""" + +import pytest + +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +def _normalize_headers(headers) -> dict[str, str]: + if isinstance(headers, list): + flat: dict[str, str] = {} + for entry in headers: + if isinstance(entry, dict): + key = entry.get("name") or entry.get("key") + value = entry.get("value") + if key is not None: + flat[str(key).lower()] = str(value) + return flat + if isinstance(headers, dict): + flat = {} + for key, value in headers.items(): + if isinstance(value, list): + flat[str(key).lower()] = ", ".join(str(v) for v in value) + else: + flat[str(key).lower()] = str(value) + return flat + return {} + + +# A heterogeneous registry: two providers of different types, with multiple +# models each. Provider-qualified selection ids are alpha/sonnet, alpha/haiku, +# beta/opus, beta/haiku. +REGISTRY_PROVIDERS = [ + { + "name": "alpha", + "type": "openai", + "wire_api": "completions", + "base_url": "https://alpha.example.test/v1", + "api_key": "alpha-secret", + "headers": {"X-Provider": "alpha"}, + }, + { + "name": "beta", + "type": "anthropic", + "base_url": "https://beta.example.test", + "bearer_token": "beta-bearer", + "headers": {"X-Provider": "beta"}, + }, +] +REGISTRY_MODELS = [ + {"id": "sonnet", "provider": "alpha", "wire_model": "byok-gpt-4o", "max_prompt_tokens": 111111}, + {"id": "haiku", "provider": "alpha", "wire_model": "byok-gpt-4o-mini"}, + {"id": "opus", "provider": "beta", "wire_model": "byok-claude-3-opus"}, + {"id": "haiku", "provider": "beta", "wire_model": "byok-claude-3-haiku"}, +] +REGISTRY_AGENTS = [ + { + "name": "orchestrator", + "display_name": "Orchestrator", + "description": "Top-level planner.", + "prompt": "Plan and delegate.", + "model": "alpha/sonnet", + }, + { + "name": "researcher", + "display_name": "Researcher", + "description": "Deep research subagent.", + "prompt": "Research thoroughly.", + "model": "beta/opus", + }, + { + "name": "fast-helper", + "display_name": "Fast Helper", + "description": "Quick subagent.", + "prompt": "Answer quickly.", + "model": "alpha/haiku", + }, + { + "name": "summarizer", + "display_name": "Summarizer", + "description": "Summarizing subagent.", + "prompt": "Summarize.", + "model": "beta/haiku", + }, +] + + +class TestMultiProviderRegistry: + async def test_should_register_multiple_providers_with_custom_agents_bound_to_their_models( + self, ctx: E2ETestContext + ): + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + providers=REGISTRY_PROVIDERS, + models=REGISTRY_MODELS, + custom_agents=REGISTRY_AGENTS, + ) + + try: + result = await session.rpc.agent.list() + + # All four custom agents coexist in a single session. + assert result.agents is not None + assert len(result.agents) == 4 + + # Each agent is bound to its configured provider-qualified BYOK model. + by_name = {agent.name: agent for agent in result.agents} + assert by_name["orchestrator"].model == "alpha/sonnet" + assert by_name["researcher"].model == "beta/opus" + assert by_name["fast-helper"].model == "alpha/haiku" + assert by_name["summarizer"].model == "beta/haiku" + + # Models from BOTH providers are represented, proving the two + # providers and their models coexist within the same session. + bound_models = [agent.model or "" for agent in result.agents] + assert any(m.startswith("alpha/") for m in bound_models) + assert any(m.startswith("beta/") for m in bound_models) + finally: + await session.disconnect() + + async def _assert_routing( + self, + ctx: E2ETestContext, + selection_id: str, + expected_wire_model: str, + expected_provider_header: str, + ): + # Two OpenAI-compatible providers, both pointed at the replay proxy so + # their /chat/completions traffic is captured. They are distinguished on + # the wire by their per-provider X-Provider header. "alpha" carries two + # models (multiple models per provider); "delta" carries one. + providers = [ + { + "name": "alpha", + "type": "openai", + "wire_api": "completions", + "base_url": ctx.proxy_url, + "api_key": "alpha-secret", + "headers": {"X-Provider": "alpha"}, + }, + { + "name": "delta", + "type": "openai", + "wire_api": "completions", + "base_url": ctx.proxy_url, + "api_key": "delta-secret", + "headers": {"X-Provider": "delta"}, + }, + ] + models = [ + {"id": "sonnet", "provider": "alpha", "wire_model": "byok-gpt-4o"}, + {"id": "haiku", "provider": "alpha", "wire_model": "byok-gpt-4o-mini"}, + {"id": "turbo", "provider": "delta", "wire_model": "byok-gpt-4-turbo"}, + ] + + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + model=selection_id, + providers=providers, + models=models, + ) + + try: + await session.send_and_wait("What is 5+5?") + + exchanges = await ctx.get_exchanges() + assert len(exchanges) == 1 + exchange = exchanges[0] + + # The wire model sent to the provider is the selected model's + # wire_model, not its provider-qualified selection id. + assert exchange["request"]["model"] == expected_wire_model + + # The request carried the owning provider's custom header, proving + # the turn was dispatched against the correct provider connection. + headers = _normalize_headers(exchange.get("requestHeaders")) + assert headers.get("x-provider") == expected_provider_header + + # The provider's API key was applied as an Authorization header. + assert headers.get("authorization") + finally: + await session.disconnect() + + async def test_should_route_alpha_sonnet_turn_to_its_provider_and_wire_model( + self, ctx: E2ETestContext + ): + await self._assert_routing(ctx, "alpha/sonnet", "byok-gpt-4o", "alpha") + + async def test_should_route_alpha_haiku_turn_to_its_provider_and_wire_model( + self, ctx: E2ETestContext + ): + await self._assert_routing(ctx, "alpha/haiku", "byok-gpt-4o-mini", "alpha") + + async def test_should_route_delta_turbo_turn_to_its_provider_and_wire_model( + self, ctx: E2ETestContext + ): + await self._assert_routing(ctx, "delta/turbo", "byok-gpt-4-turbo", "delta") diff --git a/python/e2e/test_multi_turn_e2e.py b/python/e2e/test_multi_turn_e2e.py index 000da240e..4d7c52ac2 100644 --- a/python/e2e/test_multi_turn_e2e.py +++ b/python/e2e/test_multi_turn_e2e.py @@ -7,14 +7,14 @@ import pytest -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( AssistantMessageData, SessionIdleData, ToolExecutionCompleteData, ToolExecutionStartData, UserMessageData, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext diff --git a/python/e2e/test_pending_work_resume_e2e.py b/python/e2e/test_pending_work_resume_e2e.py index 237da06c6..64c06c042 100644 --- a/python/e2e/test_pending_work_resume_e2e.py +++ b/python/e2e/test_pending_work_resume_e2e.py @@ -11,13 +11,12 @@ from __future__ import annotations import asyncio -import os from typing import Any import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import ( +from copilot.rpc import ( HandlePendingToolCallRequest, PermissionDecisionRequest, PermissionDecisionUserNotAvailable, @@ -25,7 +24,7 @@ from copilot.session import PermissionHandler from copilot.tools import Tool, ToolInvocation, ToolResult -from .testharness import E2ETestContext, get_final_assistant_message +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -33,9 +32,6 @@ def _make_subprocess_client(ctx: E2ETestContext, *, use_stdio: bool = True) -> CopilotClient: - github_token = ( - "fake-token-for-e2e-tests" if os.environ.get("GITHUB_ACTIONS") == "true" else None - ) if use_stdio: connection = RuntimeConnection.for_stdio(path=ctx.cli_path) else: @@ -46,7 +42,7 @@ def _make_subprocess_client(ctx: E2ETestContext, *, use_stdio: bool = True) -> C connection=connection, working_directory=ctx.work_dir, env=ctx.get_env(), - github_token=github_token, + github_token=DEFAULT_GITHUB_TOKEN, ) @@ -143,7 +139,6 @@ async def test_should_continue_pending_permission_request_after_resume( release_original: asyncio.Future = asyncio.get_event_loop().create_future() captured_request: asyncio.Future = asyncio.get_event_loop().create_future() - resumed_tool_invoked = False async def hold_permission(request, _invocation): if not captured_request.done(): @@ -177,8 +172,6 @@ def original_tool_handler(args): await suspended_client.force_stop() def resumed_tool_handler(args): - nonlocal resumed_tool_invoked - resumed_tool_invoked = True return f"PERMISSION_RESUMED_{args['value'].upper()}" resumed_client = CopilotClient( @@ -206,12 +199,6 @@ def resumed_tool_handler(args): ) assert permission_result.success - answer = await get_final_assistant_message( - session2, timeout=PENDING_WORK_TIMEOUT - ) - - assert resumed_tool_invoked - assert "PERMISSION_RESUMED_ALPHA" in (answer.data.content or "") await session2.disconnect() finally: await _safe_force_stop(resumed_client) @@ -281,11 +268,6 @@ async def blocking_external_tool(args): ) assert tool_result.success - answer = await get_final_assistant_message( - session2, timeout=PENDING_WORK_TIMEOUT - ) - assert "EXTERNAL_RESUMED_BETA" in (answer.data.content or "") - await session2.disconnect() finally: await _safe_force_stop(resumed_client) @@ -439,7 +421,32 @@ async def test_should_resume_successfully_when_no_pending_work_exists( async def test_should_keep_pending_external_tool_handleable_on_warm_resume_when_continuependingwork_is_false( # noqa: E501 self, ctx: E2ETestContext ): - from copilot.generated.session_events import SessionResumeData + await self._assert_pending_external_tool_handleable_on_resume( + ctx, + disconnect_original_client=False, + expected_session_was_active=True, + expected_handle_result=True, + ) + + async def test_should_keep_pending_external_tool_handleable_on_cold_resume_when_continuependingwork_is_false( # noqa: E501 + self, ctx: E2ETestContext + ): + await self._assert_pending_external_tool_handleable_on_resume( + ctx, + disconnect_original_client=True, + expected_session_was_active=False, + expected_handle_result=False, + ) + + async def _assert_pending_external_tool_handleable_on_resume( + self, + ctx: E2ETestContext, + *, + disconnect_original_client: bool, + expected_session_was_active: bool, + expected_handle_result: bool, + ): + from copilot.session_events import SessionResumeData tool_started: asyncio.Future = asyncio.get_event_loop().create_future() release_original: asyncio.Future = asyncio.get_event_loop().create_future() @@ -479,7 +486,8 @@ async def blocking_external_tool(args): tool_events = await tool_request_task assert (await asyncio.wait_for(tool_started, PENDING_WORK_TIMEOUT)) == "beta" - await suspended_client.force_stop() + if disconnect_original_client: + await suspended_client.force_stop() resumed_client = CopilotClient( connection=RuntimeConnection.for_uri( @@ -487,47 +495,68 @@ async def blocking_external_tool(args): ) ) try: + # In warm mode the original client still owns the tool registration; + # re-registering it from the resumed client would cause a name-clash. + # In cold mode the original is gone, so we register a fresh throwing + # handler to assert the runtime doesn't re-invoke the tool on resume + # (orphan auto-completion happens internally). + async def resumed_external_tool(args): + raise AssertionError("Resumed-session handler should not be invoked") + + resume_tools = ( + [_make_pending_tool("resume_external_tool", resumed_external_tool)] + if disconnect_original_client + else None + ) session2 = await resumed_client.resume_session( session_id, on_permission_request=PermissionHandler.approve_all, continue_pending_work=False, + tools=resume_tools, ) - # Verify resume event: continue_pending_work=False and session_was_active=True messages = await session2.get_events() resume_events = [m for m in messages if isinstance(m.data, SessionResumeData)] assert len(resume_events) == 1, "Expected exactly one session.resume event" resume_event = resume_events[0] assert resume_event.data.continue_pending_work is False - assert resume_event.data.session_was_active is True + assert resume_event.data.session_was_active is expected_session_was_active - # The pending tool call should still be satisfiable + # Warm: the runtime still has the pending request, so + # HandlePendingToolCall succeeds. Cold: the runtime auto-completed + # the orphaned tool call with a synthetic interrupt result during + # resume, so HandlePendingToolCall reports success=False. The + # session should still be healthy for new turns. tool_result = await session2.rpc.tools.handle_pending_tool_call( HandlePendingToolCallRequest( request_id=tool_events["resume_external_tool"].data.request_id, result="EXTERNAL_RESUMED_BETA", ) ) - assert tool_result.success - - # continue_pending_work=False may interrupt agent continuation before - # a final assistant message, but the pending call should still accept - # an explicit completion. + assert tool_result.success is expected_handle_result assert invocation_count == 1 + if not expected_handle_result: + follow_up = await session2.send_and_wait( + "Reply with exactly: COLD_RESUMED_FOLLOWUP", + timeout=PENDING_WORK_TIMEOUT, + ) + assert "COLD_RESUMED_FOLLOWUP" in (follow_up.data.content or "") + await session2.disconnect() finally: await _safe_force_stop(resumed_client) finally: if not release_original.done(): release_original.set_result("ORIGINAL_SHOULD_NOT_WIN") + await _safe_force_stop(suspended_client) finally: await _safe_force_stop(server) async def test_should_report_continuependingwork_true_in_resume_event( self, ctx: E2ETestContext ): - from copilot.generated.session_events import SessionResumeData + from copilot.session_events import SessionResumeData server = _make_subprocess_client(ctx, use_stdio=False) await server.start() diff --git a/python/e2e/test_per_session_auth_e2e.py b/python/e2e/test_per_session_auth_e2e.py index 0aa42cdaa..a8d13dc1d 100644 --- a/python/e2e/test_per_session_auth_e2e.py +++ b/python/e2e/test_per_session_auth_e2e.py @@ -18,7 +18,7 @@ async def auth_ctx(ctx: E2ETestContext): # Redirect GitHub API calls to the proxy so per-session auth token # resolution (fetchCopilotUser) is intercepted. Must be set before the # CLI subprocess is spawned (i.e., before the first create_session call). - ctx.client._options.env["COPILOT_DEBUG_GITHUB_API_URL"] = proxy_url + ctx.add_runtime_env("COPILOT_DEBUG_GITHUB_API_URL", proxy_url) await ctx.set_copilot_user_by_token( "token-alice", @@ -58,7 +58,7 @@ async def test_should_create_session_with_github_token_and_check_auth_status( github_token="token-alice", ) - auth_status = await session.rpc.auth.get_status() + auth_status = await session.rpc.git_hub_auth.get_status() assert auth_status.is_authenticated is True assert auth_status.login == "alice" assert auth_status.copilot_plan == "individual_pro" @@ -77,8 +77,8 @@ async def test_should_isolate_auth_between_sessions_with_different_tokens( github_token="token-bob", ) - status_a = await session_a.rpc.auth.get_status() - status_b = await session_b.rpc.auth.get_status() + status_a = await session_a.rpc.git_hub_auth.get_status() + status_b = await session_b.rpc.git_hub_auth.get_status() assert status_a.is_authenticated is True assert status_a.login == "alice" @@ -108,7 +108,7 @@ async def test_should_return_unauthenticated_when_no_token_provided( on_permission_request=PermissionHandler.approve_all, ) - auth_status = await session.rpc.auth.get_status() + auth_status = await session.rpc.git_hub_auth.get_status() # Without a per-session token, there is no per-session identity. # In CI the process-level fake token may still authenticate globally, # so we check login rather than is_authenticated. On some platforms diff --git a/python/e2e/test_permissions_e2e.py b/python/e2e/test_permissions_e2e.py index 84aeec3a2..c6c644c93 100644 --- a/python/e2e/test_permissions_e2e.py +++ b/python/e2e/test_permissions_e2e.py @@ -6,17 +6,17 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( PermissionDecisionApproveOnce, PermissionDecisionReject, PermissionDecisionUserNotAvailable, ) -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler, PermissionNoResult, PermissionRequestResult +from copilot.session_events import ( PermissionRequest, SessionIdleData, ToolExecutionCompleteData, ) -from copilot.session import PermissionHandler, PermissionNoResult, PermissionRequestResult from .testharness import E2ETestContext from .testharness.helper import read_file, write_file @@ -411,7 +411,7 @@ async def test_should_short_circuit_permission_handler_when_set_approve_all_enab self, ctx: E2ETestContext ): """When set_approve_all is true, the runtime short-circuits the handler.""" - from copilot.generated.rpc import PermissionsSetApproveAllRequest + from copilot.rpc import PermissionsSetApproveAllRequest handler_call_count = 0 @@ -452,7 +452,7 @@ def on_event(event): unsubscribe() finally: try: - from copilot.generated.rpc import PermissionsSetApproveAllRequest + from copilot.rpc import PermissionsSetApproveAllRequest await session.rpc.permissions.set_approve_all( PermissionsSetApproveAllRequest(enabled=False) diff --git a/python/e2e/test_provider_endpoint_e2e.py b/python/e2e/test_provider_endpoint_e2e.py new file mode 100644 index 000000000..875a95b91 --- /dev/null +++ b/python/e2e/test_provider_endpoint_e2e.py @@ -0,0 +1,117 @@ +"""E2E tests for session.provider.getEndpoint.""" + +# session.provider.getEndpoint is gated behind COPILOT_ALLOW_GET_PROVIDER_ENDPOINT; +# the harness env passed to the CLI subprocess opts in for this test file. + +import re + +import pytest + +from copilot.client import CopilotClient, RuntimeConnection +from copilot.generated.rpc import ProviderEndpointType, ProviderEndpointWireApi +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +@pytest.fixture(scope="module") +async def provider_ctx(ctx: E2ETestContext): + env = {**ctx.get_env(), "COPILOT_ALLOW_GET_PROVIDER_ENDPOINT": "true"} + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=env["GITHUB_TOKEN"], + ) + try: + yield ctx, client + finally: + await client.stop() + + +class TestProviderEndpoint: + async def test_returns_byok_provider_endpoint_when_custom_provider_is_configured( + self, provider_ctx: tuple[E2ETestContext, CopilotClient] + ): + _, client = provider_ctx + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + provider={ + "type": "openai", + "wire_api": "completions", + "base_url": "https://api.example.test/v1", + "api_key": "byok-secret", + "headers": {"X-Custom-Header": "byok-yes"}, + }, + ) + + try: + endpoint = await session.rpc.provider.get_endpoint() + + assert endpoint.type == ProviderEndpointType.OPENAI + assert endpoint.wire_api == ProviderEndpointWireApi.COMPLETIONS + assert endpoint.base_url == "https://api.example.test/v1" + assert endpoint.api_key == "byok-secret" + assert endpoint.headers["X-Custom-Header"] == "byok-yes" + # BYOK sessions never issue a CAPI session token. + assert endpoint.session_token is None + finally: + try: + await session.disconnect() + except Exception: + pass # disconnect may fail since the BYOK provider URL is fake + + async def test_returns_capi_provider_endpoint_for_oauth_authenticated_session( + self, provider_ctx: tuple[E2ETestContext, CopilotClient] + ): + _, client = provider_ctx + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + + try: + endpoint = await session.rpc.provider.get_endpoint() + + assert endpoint.type in ( + ProviderEndpointType.OPENAI, + ProviderEndpointType.AZURE, + ProviderEndpointType.ANTHROPIC, + ) + # wire_api is omitted for anthropic; otherwise one of the OpenAI shapes. + if endpoint.type != ProviderEndpointType.ANTHROPIC: + assert endpoint.wire_api in ( + ProviderEndpointWireApi.COMPLETIONS, + ProviderEndpointWireApi.RESPONSES, + ) + + # CAPI baseUrl is the (proxy) Copilot API URL injected by the harness. + assert re.match(r"^https?://", endpoint.base_url) + + # For CAPI OAuth sessions the api_key is the resolved GitHub bearer. + assert isinstance(endpoint.api_key, str) + assert len(endpoint.api_key) > 0 + + # Standard CAPI headers must be present, and Authorization is + # surfaced as the runtime sends it (`Bearer `). + assert isinstance(endpoint.headers["Copilot-Integration-Id"], str) + assert re.search(r"Copilot", endpoint.headers["User-Agent"], re.IGNORECASE) + assert isinstance(endpoint.headers["X-GitHub-Api-Version"], str) + assert re.search(r"[0-9a-f-]{8,}", endpoint.headers["X-Interaction-Id"]) + assert endpoint.headers["Authorization"] == f"Bearer {endpoint.api_key}" + + # When the omit-model_id path returned an auto-mode session token, + # it must use the documented header name. The harness may have a + # non-auto model selected, in which case the field is simply + # omitted. + if endpoint.session_token is not None: + assert endpoint.session_token.header == "Copilot-Session-Token" + assert len(endpoint.session_token.token) > 0 + # When provided, expires_at should be a parseable ISO timestamp. + if endpoint.session_token.expires_at is not None: + from datetime import datetime + + datetime.fromisoformat(endpoint.session_token.expires_at.replace("Z", "+00:00")) + finally: + await session.disconnect() diff --git a/python/e2e/test_rewind_e2e.py b/python/e2e/test_rewind_e2e.py new file mode 100644 index 000000000..e3db37915 --- /dev/null +++ b/python/e2e/test_rewind_e2e.py @@ -0,0 +1,88 @@ +"""E2E coverage for rewinding tracked files and conversation history.""" + +from __future__ import annotations + +import asyncio +import os +from pathlib import Path + +import pytest + +from copilot.rpc import ( + HistoryPreviewRewindRequest, + HistoryRewindMode, + HistoryRewindOutcome, + HistoryRewindRequest, +) +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + +FILE_NAME = "rewind-sdk.txt" +FILE_CONTENT = "SDK rewind content" + + +def _same_path(left: str | Path, right: str | Path) -> bool: + return os.path.normcase(os.path.abspath(left)) == os.path.normcase(os.path.abspath(right)) + + +class TestRewind: + async def test_should_restore_tracked_file_and_conversation(self, ctx: E2ETestContext): + file_path = Path(ctx.work_dir) / FILE_NAME + session = await ctx.client.create_session( + model="claude-sonnet-4.5", + enable_file_change_tracking=True, + on_permission_request=PermissionHandler.approve_all, + ) + + try: + response = await session.send_and_wait( + f"Use the create tool to create {FILE_NAME} containing exactly {FILE_CONTENT}. " + "After the tool succeeds, reply with exactly SDK_REWIND_DONE." + ) + + assert response is not None + assert response.data.content == "SDK_REWIND_DONE" + assert file_path.read_text(encoding="utf-8") == FILE_CONTENT + + rewind_points = await session.rpc.history.list_rewind_points() + deadline = asyncio.get_running_loop().time() + 10 + while ( + rewind_points.unavailable_reason is not None + and asyncio.get_running_loop().time() < deadline + ): + await asyncio.sleep(0.1) + rewind_points = await session.rpc.history.list_rewind_points() + + assert rewind_points.unavailable_reason is None + assert rewind_points.file_change_tracking_enabled + assert len(rewind_points.points) == 1 + rewind_point = rewind_points.points[0] + assert rewind_point.can_restore_files + assert rewind_point.file_count == 1 + + preview = await session.rpc.history.preview_rewind( + HistoryPreviewRewindRequest(event_id=rewind_point.event_id) + ) + assert preview.available + assert len(preview.files) == 1 + assert _same_path(preview.files[0].path, file_path) + + rewind = await session.rpc.history.rewind( + HistoryRewindRequest( + event_id=rewind_point.event_id, + mode=HistoryRewindMode.CONVERSATION_AND_FILES, + ) + ) + assert rewind.outcome == HistoryRewindOutcome.SUCCESS + assert rewind.events_removed is not None and rewind.events_removed > 0 + assert len(rewind.restored_files) == 1 + assert _same_path(rewind.restored_files[0], file_path) + assert not file_path.exists() + + events = await session.get_events() + assert all(str(event.id) != rewind_point.event_id for event in events) + finally: + await session.disconnect() diff --git a/python/e2e/test_rpc_commands_e2e.py b/python/e2e/test_rpc_commands_e2e.py index 2e2693237..32fbc5b18 100644 --- a/python/e2e/test_rpc_commands_e2e.py +++ b/python/e2e/test_rpc_commands_e2e.py @@ -4,12 +4,12 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( CommandsInvokeRequest, - CommandsListRequest, CommandsRespondToQueuedCommandRequest, ExecuteCommandParams, QueuedCommandHandled, + SessionCommandsListRequest, SlashCommandKind, SlashCommandTextResult, ) @@ -33,7 +33,7 @@ async def test_should_list_builtin_and_client_commands(self, ctx: E2ETestContext ], ) try: - commands = await session.rpc.commands.list(CommandsListRequest()) + commands = await session.rpc.commands.list(SessionCommandsListRequest()) by_name = {command.name: command for command in commands.commands} builtins = [ diff --git a/python/e2e/test_rpc_e2e.py b/python/e2e/test_rpc_e2e.py index b825db060..444063572 100644 --- a/python/e2e/test_rpc_e2e.py +++ b/python/e2e/test_rpc_e2e.py @@ -3,7 +3,10 @@ import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import ModelsListRequest, PingRequest +from copilot.rpc import ( + ModelsListRequest, + PingRequest, +) from copilot.session import PermissionHandler from .testharness import CLI_PATH, E2ETestContext @@ -90,7 +93,7 @@ async def test_should_call_session_rpc_model_get_current(self, ctx: E2ETestConte @pytest.mark.skip(reason="session.model.switchTo not yet implemented in CLI") async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext): """Test calling session.rpc.model.switchTo""" - from copilot.generated.rpc import ModelSwitchToRequest + from copilot.rpc import ModelSwitchToRequest session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, model="claude-sonnet-4.5" @@ -113,7 +116,8 @@ async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext @pytest.mark.asyncio async def test_get_and_set_session_mode(self): """Test getting and setting session mode""" - from copilot.generated.rpc import ModeSetRequest, SessionMode + from copilot.rpc import ModeSetRequest + from copilot.session_events import SessionMode client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) @@ -145,7 +149,7 @@ async def test_get_and_set_session_mode(self): @pytest.mark.asyncio async def test_read_update_and_delete_plan(self): """Test reading, updating, and deleting plan""" - from copilot.generated.rpc import PlanUpdateRequest + from copilot.rpc import PlanUpdateRequest client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) @@ -185,7 +189,7 @@ async def test_read_update_and_delete_plan(self): @pytest.mark.asyncio async def test_create_list_and_read_workspace_files(self): """Test creating, listing, and reading workspace files""" - from copilot.generated.rpc import ( + from copilot.rpc import ( WorkspacesCreateFileRequest, WorkspacesReadFileRequest, ) diff --git a/python/e2e/test_rpc_event_log_e2e.py b/python/e2e/test_rpc_event_log_e2e.py index 402d12790..5e5cc3909 100644 --- a/python/e2e/test_rpc_event_log_e2e.py +++ b/python/e2e/test_rpc_event_log_e2e.py @@ -9,7 +9,7 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( EventLogReadRequest, EventsCursorStatus, NameSetRequest, @@ -17,12 +17,12 @@ RegisterEventInterestParams, ReleaseEventInterestParams, ) -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( PlanChangedOperation, SessionPlanChangedData, SessionTitleChangedData, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext diff --git a/python/e2e/test_rpc_event_side_effects_e2e.py b/python/e2e/test_rpc_event_side_effects_e2e.py index 9725e211a..ce3951aac 100644 --- a/python/e2e/test_rpc_event_side_effects_e2e.py +++ b/python/e2e/test_rpc_event_side_effects_e2e.py @@ -11,16 +11,17 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( HistoryTruncateRequest, ModeSetRequest, NameSetRequest, PlanUpdateRequest, - SessionMode, WorkspacesCreateFileRequest, ) -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( PlanChangedOperation, + SessionMode, SessionModeChangedData, SessionPlanChangedData, SessionSnapshotRewindData, @@ -28,7 +29,6 @@ SessionWorkspaceFileChangedData, WorkspaceFileChangedOperation, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext @@ -207,7 +207,7 @@ async def test_should_emit_snapshot_rewind_event_and_remove_events_on_truncate( self, ctx: E2ETestContext ): """Truncating history emits a session.snapshot_rewind event.""" - from copilot.generated.session_events import UserMessageData + from copilot.session_events import UserMessageData session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, @@ -249,7 +249,7 @@ def on_event(event): async def test_should_allow_session_use_after_truncate(self, ctx: E2ETestContext): """Session remains usable after history truncation.""" - from copilot.generated.session_events import UserMessageData + from copilot.session_events import UserMessageData session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, diff --git a/python/e2e/test_rpc_mcp_and_skills_e2e.py b/python/e2e/test_rpc_mcp_and_skills_e2e.py index 06c66f9ce..14231dbbd 100644 --- a/python/e2e/test_rpc_mcp_and_skills_e2e.py +++ b/python/e2e/test_rpc_mcp_and_skills_e2e.py @@ -16,7 +16,7 @@ import pytest import pytest_asyncio -from copilot.generated.rpc import ( +from copilot.rpc import ( ExtensionsDisableRequest, ExtensionsEnableRequest, MCPAppsCallToolRequest, @@ -33,7 +33,6 @@ MCPExecuteSamplingParams, MCPRemoveGitHubResult, MCPSamplingExecutionAction, - McpServerStatus, MCPSetEnvValueModeDetails, MCPSetEnvValueModeParams, SkillsDisableRequest, @@ -41,6 +40,7 @@ Theme, ) from copilot.session import PermissionHandler +from copilot.session_events import McpServerStatus from .testharness import E2ETestContext diff --git a/python/e2e/test_rpc_mcp_config_e2e.py b/python/e2e/test_rpc_mcp_config_e2e.py index d9229adff..efa41cda2 100644 --- a/python/e2e/test_rpc_mcp_config_e2e.py +++ b/python/e2e/test_rpc_mcp_config_e2e.py @@ -11,14 +11,14 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( MCPConfigAddRequest, MCPConfigDisableRequest, MCPConfigEnableRequest, MCPConfigRemoveRequest, MCPConfigUpdateRequest, + MCPGrantType, MCPServerConfig, - MCPServerConfigHTTPOauthGrantType, MCPServerConfigHTTPType, ) @@ -76,7 +76,7 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon headers={"Authorization": "Bearer token"}, oauth_client_id="client-id", oauth_public_client=False, - oauth_grant_type=MCPServerConfigHTTPOauthGrantType.CLIENT_CREDENTIALS, + oauth_grant_type=MCPGrantType.CLIENT_CREDENTIALS, tools=["*"], timeout=3000, ) @@ -85,7 +85,7 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon url="https://example.com/updated-mcp", oauth_client_id="updated-client-id", oauth_public_client=True, - oauth_grant_type=MCPServerConfigHTTPOauthGrantType.AUTHORIZATION_CODE, + oauth_grant_type=MCPGrantType.AUTHORIZATION_CODE, tools=["updated-tool"], timeout=4000, ) @@ -102,7 +102,7 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon assert added.headers["Authorization"] == "Bearer token" assert added.oauth_client_id == "client-id" assert added.oauth_public_client is False - assert added.oauth_grant_type == MCPServerConfigHTTPOauthGrantType.CLIENT_CREDENTIALS + assert added.oauth_grant_type == MCPGrantType.CLIENT_CREDENTIALS await ctx.client.rpc.mcp.config.update( MCPConfigUpdateRequest(name=server_name, config=updated_config) @@ -112,7 +112,7 @@ async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestCon assert updated.url == "https://example.com/updated-mcp" assert updated.oauth_client_id == "updated-client-id" assert updated.oauth_public_client is True - assert updated.oauth_grant_type == MCPServerConfigHTTPOauthGrantType.AUTHORIZATION_CODE + assert updated.oauth_grant_type == MCPGrantType.AUTHORIZATION_CODE assert updated.tools is not None and updated.tools[0] == "updated-tool" assert updated.timeout == 4000 finally: diff --git a/python/e2e/test_rpc_mcp_lifecycle_e2e.py b/python/e2e/test_rpc_mcp_lifecycle_e2e.py new file mode 100644 index 000000000..a16603706 --- /dev/null +++ b/python/e2e/test_rpc_mcp_lifecycle_e2e.py @@ -0,0 +1,151 @@ +""" +E2E coverage for session-scoped MCP lifecycle RPC methods. + +Mirrors ``dotnet/test/E2E/RpcMcpLifecycleE2ETests.cs`` (snapshot category +``rpc_mcp_lifecycle``). +""" + +from __future__ import annotations + +import uuid +from pathlib import Path + +import pytest + +from copilot.rpc import ( + MCPIsServerRunningRequest, + MCPListToolsRequest, + MCPStopServerRequest, +) +from copilot.session import PermissionHandler +from copilot.session_events import McpServerStatus + +from .testharness import E2ETestContext, wait_for_condition + +pytestmark = pytest.mark.asyncio(loop_scope="module") + +TEST_MCP_SERVER = str( + (Path(__file__).parents[2] / "test" / "harness" / "test-mcp-server.mjs").resolve() +) +TEST_HARNESS_DIR = str((Path(__file__).parents[2] / "test" / "harness").resolve()) + + +def _test_mcp_servers(*server_names: str) -> dict[str, dict]: + return { + server_name: { + "command": "node", + "args": [TEST_MCP_SERVER], + "tools": ["*"], + "working_directory": TEST_HARNESS_DIR, + } + for server_name in server_names + } + + +async def _wait_for_mcp_server_status( + session, + server_name: str, + expected_status: McpServerStatus = McpServerStatus.CONNECTED, +) -> None: + last_status = "" + + async def connected() -> bool: + nonlocal last_status + result = await session.rpc.mcp.list() + server = next((s for s in result.servers if s.name == server_name), None) + if server is not None: + last_status = server.status + if server is None: + last_status = "" + return False + return server.status == expected_status + + await wait_for_condition( + connected, + timeout=60.0, + poll_interval=0.2, + timeout_message=( + f"{server_name} did not reach {expected_status.value}; last status was {last_status}" + ), + ) + + +async def _wait_for_mcp_running(session, server_name: str, expected_running: bool) -> None: + async def matches() -> bool: + result = await session.rpc.mcp.is_server_running( + MCPIsServerRunningRequest(server_name=server_name) + ) + return result.running is expected_running + + await wait_for_condition( + matches, + timeout=60.0, + poll_interval=0.2, + timeout_message=f"{server_name} running={expected_running}", + ) + + +def _assert_not_unhandled_method(message: str) -> None: + assert "Unhandled method".lower() not in message.lower() + + +class TestRpcMcpLifecycle: + async def test_should_list_tools_and_report_running_status_for_connected_server( + self, ctx: E2ETestContext + ): + server_name = "rpc-lifecycle-list-server" + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + mcp_servers=_test_mcp_servers(server_name), + ) as session: + await _wait_for_mcp_server_status(session, server_name) + + tools = await session.rpc.mcp.list_tools(MCPListToolsRequest(server_name=server_name)) + assert tools.tools is not None + assert len(tools.tools) > 0 + assert all((tool.name or "").strip() for tool in tools.tools) + + running = await session.rpc.mcp.is_server_running( + MCPIsServerRunningRequest(server_name=server_name) + ) + assert running.running is True + + missing = await session.rpc.mcp.is_server_running( + MCPIsServerRunningRequest(server_name=f"missing-{uuid.uuid4().hex}") + ) + assert missing.running is False + + async def test_should_throw_when_listing_tools_for_unconnected_server( + self, ctx: E2ETestContext + ): + server_name = "rpc-lifecycle-unconnected-host" + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + mcp_servers=_test_mcp_servers(server_name), + ) as session: + await _wait_for_mcp_server_status(session, server_name) + + with pytest.raises(Exception) as excinfo: + await session.rpc.mcp.list_tools( + MCPListToolsRequest(server_name=f"missing-{uuid.uuid4().hex}") + ) + message = str(excinfo.value) + _assert_not_unhandled_method(message) + assert "not connected" in message.lower() + + async def test_should_stop_running_mcp_server(self, ctx: E2ETestContext): + server_name = "rpc-lifecycle-stop-server" + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + mcp_servers=_test_mcp_servers(server_name), + ) as session: + await _wait_for_mcp_server_status(session, server_name) + assert ( + await session.rpc.mcp.is_server_running( + MCPIsServerRunningRequest(server_name=server_name) + ) + ).running is True + + await session.rpc.mcp.stop_server(MCPStopServerRequest(server_name=server_name)) + + await _wait_for_mcp_running(session, server_name, expected_running=False) diff --git a/python/e2e/test_rpc_queue_e2e.py b/python/e2e/test_rpc_queue_e2e.py index 9630216aa..edd286aa4 100644 --- a/python/e2e/test_rpc_queue_e2e.py +++ b/python/e2e/test_rpc_queue_e2e.py @@ -8,7 +8,7 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( CommandsRespondToQueuedCommandRequest, EnqueueCommandParams, QueuedCommandHandled, @@ -17,8 +17,8 @@ RegisterEventInterestParams, ReleaseEventInterestParams, ) -from copilot.generated.session_events import CommandQueuedData from copilot.session import PermissionHandler +from copilot.session_events import CommandQueuedData from .testharness import E2ETestContext diff --git a/python/e2e/test_rpc_remote_e2e.py b/python/e2e/test_rpc_remote_e2e.py index b2ccfc671..0d60c368c 100644 --- a/python/e2e/test_rpc_remote_e2e.py +++ b/python/e2e/test_rpc_remote_e2e.py @@ -7,14 +7,13 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( RemoteEnableRequest, RemoteNotifySteerableChangedRequest, RemoteSessionMode, - SessionsGetPersistedRemoteSteerableRequest, ) -from copilot.generated.session_events import SessionRemoteSteerableChangedData from copilot.session import PermissionHandler +from copilot.session_events import SessionRemoteSteerableChangedData from .testharness import E2ETestContext @@ -78,18 +77,10 @@ async def test_notify_steerable_changed_event_and_persist_flag(self, ctx: E2ETes RemoteNotifySteerableChangedRequest(remote_steerable=True) ) await _wait_for_remote_steerable_event(session, True) - persisted = await ctx.client.rpc.sessions.get_persisted_remote_steerable( - SessionsGetPersistedRemoteSteerableRequest(session_id=session.session_id) - ) - assert persisted.remote_steerable is True await session.rpc.remote.notify_steerable_changed( RemoteNotifySteerableChangedRequest(remote_steerable=False) ) await _wait_for_remote_steerable_event(session, False) - persisted = await ctx.client.rpc.sessions.get_persisted_remote_steerable( - SessionsGetPersistedRemoteSteerableRequest(session_id=session.session_id) - ) - assert persisted.remote_steerable is False finally: await session.disconnect() diff --git a/python/e2e/test_rpc_schedule_e2e.py b/python/e2e/test_rpc_schedule_e2e.py index 83244f9d9..fdceac8dc 100644 --- a/python/e2e/test_rpc_schedule_e2e.py +++ b/python/e2e/test_rpc_schedule_e2e.py @@ -4,7 +4,7 @@ import pytest -from copilot.generated.rpc import ScheduleStopRequest +from copilot.rpc import ScheduleStopRequest from copilot.session import PermissionHandler from .testharness import E2ETestContext diff --git a/python/e2e/test_rpc_server_e2e.py b/python/e2e/test_rpc_server_e2e.py index cdfe16edc..e7c4a446c 100644 --- a/python/e2e/test_rpc_server_e2e.py +++ b/python/e2e/test_rpc_server_e2e.py @@ -14,9 +14,17 @@ import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import ( +from copilot.rpc import ( AccountGetQuotaRequest, + AgentsDiscoverRequest, + AgentsGetDiscoveryPathsRequest, ConnectRemoteSessionParams, + InstructionsDiscoverRequest, + InstructionsGetDiscoveryPathsRequest, + LlmInferenceHTTPResponseChunkError, + LlmInferenceHTTPResponseChunkRequest, + LlmInferenceHTTPResponseStartRequest, + LocalSessionMetadataValue, MCPDiscoverRequest, ModelsListRequest, PingRequest, @@ -26,16 +34,13 @@ SessionFSSetProviderConventions, SessionFSSetProviderRequest, SessionListFilter, - SessionMetadata, SessionsBulkDeleteRequest, SessionsCheckInUseRequest, SessionsCloseRequest, SessionsEnrichMetadataRequest, SessionsFindByPrefixRequest, SessionsFindByTaskIDRequest, - SessionsGetEventFilePathRequest, SessionsGetLastForContextRequest, - SessionsGetPersistedRemoteSteerableRequest, SessionsListRequest, SessionsLoadDeferredRepoHooksRequest, SessionsPruneOldRequest, @@ -45,11 +50,12 @@ SessionsSetAdditionalPluginsRequest, SkillsConfigSetDisabledSkillsRequest, SkillsDiscoverRequest, + SkillsGetDiscoveryPathsRequest, ToolsListRequest, ) from copilot.session import PermissionHandler -from .testharness import E2ETestContext +from .testharness import E2ETestContext, wait_for_condition pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -70,10 +76,16 @@ def _create_skill_directory(work_dir: str, skill_name: str, description: str) -> return str(skills_dir) +def _paths_equal(left: str, right: str | None) -> bool: + if right is None: + return False + return os.path.normcase(os.path.abspath(left)) == os.path.normcase(os.path.abspath(right)) + + @pytest.fixture(scope="module") async def authed_ctx(ctx: E2ETestContext): """Configure proxy to redirect GitHub user lookups so per-token auth works.""" - ctx.client._options.env["COPILOT_DEBUG_GITHUB_API_URL"] = ctx.proxy_url + ctx.add_runtime_env("COPILOT_DEBUG_GITHUB_API_URL", ctx.proxy_url) return ctx @@ -125,6 +137,44 @@ async def test_should_call_rpc_ping_with_typed_params_and_result(self, ctx: E2ET assert result.message == "pong: typed rpc test" assert result.timestamp is not None + async def test_should_reject_llm_inference_response_frames_for_missing_request( + self, ctx: E2ETestContext + ): + await ctx.client.start() + + start = await ctx.client.rpc.llm_inference.http_response_start( + LlmInferenceHTTPResponseStartRequest( + request_id="missing-llm-inference-request", + status=200, + status_text="OK", + headers={"content-type": ["text/event-stream"]}, + ) + ) + assert start.accepted is False + + chunk = await ctx.client.rpc.llm_inference.http_response_chunk( + LlmInferenceHTTPResponseChunkRequest( + request_id="missing-llm-inference-request", + data="data: {}\n\n", + binary=False, + end=False, + ) + ) + assert chunk.accepted is False + + error = await ctx.client.rpc.llm_inference.http_response_chunk( + LlmInferenceHTTPResponseChunkRequest( + request_id="missing-llm-inference-request", + data="", + end=True, + error=LlmInferenceHTTPResponseChunkError( + message="No pending LLM inference request.", + code="missing_request", + ), + ) + ) + assert error.accepted is False + async def test_should_call_rpc_models_list_with_typed_result(self, authed_ctx: E2ETestContext): token = "rpc-models-token" await _configure_user(authed_ctx, token) @@ -232,38 +282,63 @@ async def test_should_add_secret_filter_values(self, ctx: E2ETestContext): # error from anyio. We don't want it to fail the test. pass - async def test_should_list_find_and_inspect_persisted_session_state(self, ctx: E2ETestContext): + async def test_should_list_find_and_inspect_persisted_session_state( + self, authed_ctx: E2ETestContext + ): + token = os.environ.get("GITHUB_TOKEN", "fakevalue") + await _configure_user(authed_ctx, token) + client = _make_authed_client(authed_ctx, token) + session_id = str(uuid.uuid4()) - working_directory = Path(ctx.work_dir) / f"server-rpc-list-{uuid.uuid4().hex}" + working_directory = Path(authed_ctx.work_dir) / f"server-rpc-list-{uuid.uuid4().hex}" working_directory.mkdir(parents=True, exist_ok=True) missing_task_id = f"missing-task-{uuid.uuid4().hex}" missing_session_id = str(uuid.uuid4()) - - session = await ctx.client.create_session( - session_id=session_id, - working_directory=str(working_directory), - on_permission_request=PermissionHandler.approve_all, - ) + session = None try: - await session.log("SERVER_RPC_LIST_READY") - save = await ctx.client.rpc.sessions.save(SessionsSaveRequest(session_id=session_id)) - assert save is not None + await client.start() + session = await client.create_session( + session_id=session_id, + working_directory=str(working_directory), + on_permission_request=PermissionHandler.approve_all, + ) - event_path = await ctx.client.rpc.sessions.get_event_file_path( - SessionsGetEventFilePathRequest(session_id=session_id) + await session.send( + "Record a turn for sessions.list discriminator coverage", mode="enqueue" ) - assert event_path.file_path - assert os.path.isabs(event_path.file_path) - assert os.path.basename(event_path.file_path) == "events.jsonl" - assert session_id.lower() in event_path.file_path.lower() - - listed = await ctx.client.rpc.sessions.list( - SessionsListRequest( - filter=SessionListFilter(cwd=str(working_directory)), - metadata_limit=0, + + listed = None + + async def session_is_listed() -> bool: + nonlocal listed + # Re-save on every attempt: on slower runners the enqueued turn is not + # necessarily recorded yet when the first save runs, so a single save + # followed by a fixed sleep races the CLI's own persistence. + save = await client.rpc.sessions.save(SessionsSaveRequest(session_id=session_id)) + assert save is not None + listed = await client.rpc.sessions.list( + SessionsListRequest( + filter=SessionListFilter(cwd=str(working_directory)), + metadata_limit=0, + ) ) + return any(item.session_id == session_id for item in listed.sessions or []) + + await wait_for_condition( + session_is_listed, + timeout=60.0, + timeout_message=( + "Timed out waiting for the saved session to be returned by sessions.list." + ), ) + + assert listed is not None assert listed.sessions is not None + assert len(listed.sessions) >= 1 + matching = [item for item in listed.sessions if item.session_id == session_id] + assert len(matching) == 1 + assert isinstance(matching[0], LocalSessionMetadataValue) + assert matching[0].is_remote is False assert all( item.context is None or os.path.normcase(os.path.abspath(item.context.cwd)) @@ -271,37 +346,40 @@ async def test_should_list_find_and_inspect_persisted_session_state(self, ctx: E for item in listed.sessions ) - by_prefix = await ctx.client.rpc.sessions.find_by_prefix( + by_prefix = await client.rpc.sessions.find_by_prefix( SessionsFindByPrefixRequest(prefix=session_id[:8]) ) assert by_prefix.session_id in (None, session_id) - by_task = await ctx.client.rpc.sessions.find_by_task_id( + by_task = await client.rpc.sessions.find_by_task_id( SessionsFindByTaskIDRequest(task_id=missing_task_id) ) assert by_task.session_id is None - last_for_context = await ctx.client.rpc.sessions.get_last_for_context( + last_for_context = await client.rpc.sessions.get_last_for_context( SessionsGetLastForContextRequest(context=SessionContext(cwd=str(working_directory))) ) assert last_for_context.session_id in (None, session_id) - sizes = await ctx.client.rpc.sessions.get_sizes() + sizes = await client.rpc.sessions.get_sizes() assert sizes.sizes is not None if session_id in sizes.sizes: assert sizes.sizes[session_id] >= 0 - in_use = await ctx.client.rpc.sessions.check_in_use( + in_use = await client.rpc.sessions.check_in_use( SessionsCheckInUseRequest(session_ids=[session_id, missing_session_id]) ) assert missing_session_id not in in_use.in_use - - remote_steerable = await ctx.client.rpc.sessions.get_persisted_remote_steerable( - SessionsGetPersistedRemoteSteerableRequest(session_id=session_id) - ) - assert remote_steerable.remote_steerable is None finally: - await session.disconnect() + if session is not None: + await session.disconnect() + try: + await client.stop() + except ExceptionGroup: + # Intentional: shutting down the per-test client can race the + # CLI's own teardown and surface as an aggregated cancellation + # error from anyio. We don't want it to fail the test. + pass async def test_should_enrich_basic_session_metadata(self, ctx: E2ETestContext): session_id = str(uuid.uuid4()) @@ -320,7 +398,7 @@ async def test_should_enrich_basic_session_metadata(self, ctx: E2ETestContext): result = await ctx.client.rpc.sessions.enrich_metadata( SessionsEnrichMetadataRequest( sessions=[ - SessionMetadata( + LocalSessionMetadataValue( is_remote=False, modified_time=now, session_id=session_id, @@ -459,6 +537,68 @@ async def test_should_discover_server_mcp_and_skills(self, ctx: E2ETestContext): assert discovered.enabled is True assert discovered.path.endswith(os.path.join(skill_name, "SKILL.md")) + skill_paths = await ctx.client.rpc.skills.get_discovery_paths( + SkillsGetDiscoveryPathsRequest( + project_paths=[ctx.work_dir], + exclude_host_skills=True, + ) + ) + project_skill_path = next( + ( + path + for path in skill_paths.paths + if _paths_equal(ctx.work_dir, path.project_path) and path.preferred_for_creation + ), + None, + ) + assert project_skill_path is not None + assert project_skill_path.path.strip() + + agents = await ctx.client.rpc.agents.discover( + AgentsDiscoverRequest(project_paths=[ctx.work_dir], exclude_host_agents=True) + ) + assert all(agent.name.strip() for agent in agents.agents) + + agent_paths = await ctx.client.rpc.agents.get_discovery_paths( + AgentsGetDiscoveryPathsRequest( + project_paths=[ctx.work_dir], + exclude_host_agents=True, + ) + ) + project_agent_path = next( + ( + path + for path in agent_paths.paths + if _paths_equal(ctx.work_dir, path.project_path) and path.preferred_for_creation + ), + None, + ) + assert project_agent_path is not None + assert project_agent_path.path.strip() + + instructions = await ctx.client.rpc.instructions.discover( + InstructionsDiscoverRequest( + project_paths=[ctx.work_dir], + exclude_host_instructions=True, + ) + ) + assert all( + source.id.strip() and source.label.strip() and source.source_path.strip() + for source in instructions.sources + ) + + instruction_paths = await ctx.client.rpc.instructions.get_discovery_paths( + InstructionsGetDiscoveryPathsRequest( + project_paths=[ctx.work_dir], + exclude_host_instructions=True, + ) + ) + assert instruction_paths.paths + assert any( + _paths_equal(ctx.work_dir, path.project_path) for path in instruction_paths.paths + ) + assert all(path.path.strip() for path in instruction_paths.paths) + try: await ctx.client.rpc.skills.config.set_disabled_skills( SkillsConfigSetDisabledSkillsRequest(disabled_skills=[skill_name]) diff --git a/python/e2e/test_rpc_server_misc_e2e.py b/python/e2e/test_rpc_server_misc_e2e.py new file mode 100644 index 000000000..d5ade1aec --- /dev/null +++ b/python/e2e/test_rpc_server_misc_e2e.py @@ -0,0 +1,235 @@ +""" +E2E coverage for miscellaneous server-scoped RPC methods. + +Mirrors ``dotnet/test/E2E/RpcServerMiscE2ETests.cs`` (snapshot category +``rpc_server_misc``). +""" + +from __future__ import annotations + +import contextlib +import shutil +import uuid +from pathlib import Path + +import pytest + +from copilot import CopilotClient, RuntimeConnection +from copilot.rpc import ( + AccountLoginRequest, + AccountLogoutRequest, + AgentRegistrySpawnRequest, + SendAttachmentsToMessageParams, + SessionsOpenResumeLast, + SessionsOpenStatus, + UserSettingsSetRequest, +) +from copilot.session import PermissionHandler + +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext, wait_for_condition + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +def _create_dedicated_client(ctx: E2ETestContext) -> CopilotClient: + return CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + ) + + +async def _create_isolated_client( + ctx: E2ETestContext, github_token: str | None = DEFAULT_GITHUB_TOKEN +) -> tuple[CopilotClient, Path]: + home = Path(ctx.work_dir) / f"copilot-e2e-misc-home-{uuid.uuid4().hex}" + home.mkdir(parents=True) + env = ctx.get_env() + for key in ("COPILOT_HOME", "GH_CONFIG_DIR", "XDG_CONFIG_HOME", "XDG_STATE_HOME"): + env[key] = str(home) + env["COPILOT_DEBUG_GITHUB_API_URL"] = ctx.proxy_url + if github_token is None: + env["GH_TOKEN"] = "" + env["GITHUB_TOKEN"] = "" + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=github_token, + use_logged_in_user=False if github_token is None else None, + ) + await client.start() + return client, home + + +async def _stop_client(client: CopilotClient) -> None: + with contextlib.suppress(ExceptionGroup, Exception): + await client.stop() + + +async def _dispose_isolated(client: CopilotClient, home: Path) -> None: + await _stop_client(client) + with contextlib.suppress(OSError): + shutil.rmtree(home, ignore_errors=True) + + +class TestRpcServerMisc: + async def test_should_reload_user_settings(self, ctx: E2ETestContext): + await ctx.client.start() + + await ctx.client.rpc.user.settings.reload() + + async def test_should_get_set_and_clear_user_settings(self, ctx: E2ETestContext): + client, home = await _create_isolated_client(ctx) + try: + before = await client.rpc.user.settings.get() + assert len(before.settings) > 0 + for key, setting in before.settings.items(): + assert key.strip() + assert isinstance(setting.is_default, bool) + + setting_key, setting = next( + (key, value) + for key, value in before.settings.items() + if isinstance(value.value, bool) + ) + toggled_value = setting.value is not True + + set_result = await client.rpc.user.settings.set( + UserSettingsSetRequest(settings={setting_key: toggled_value}) + ) + assert setting_key not in set_result.shadowed_keys + + await client.rpc.user.settings.reload() + after_set = await client.rpc.user.settings.get() + assert after_set.settings[setting_key].is_default is False + assert after_set.settings[setting_key].value is toggled_value + + await client.rpc.user.settings.set(UserSettingsSetRequest(settings={setting_key: None})) + await client.rpc.user.settings.reload() + after_clear = await client.rpc.user.settings.get() + assert after_clear.settings[setting_key].is_default is True + finally: + await _dispose_isolated(client, home) + + async def test_should_login_list_get_current_auth_and_logout_account(self, ctx: E2ETestContext): + login = f"rpc-account-{uuid.uuid4().hex}" + token = f"rpc-account-token-{uuid.uuid4().hex}" + await ctx.set_copilot_user_by_token( + token, + { + "login": login, + "copilot_plan": "individual_pro", + "endpoints": { + "api": ctx.proxy_url, + "telemetry": "https://localhost:1/telemetry", + }, + "analytics_tracking_id": "rpc-account-tracking-id", + }, + ) + + client, home = await _create_isolated_client(ctx, github_token=None) + try: + initial = await client.rpc.account.get_current_auth() + assert initial.auth_info is None + + login_result = await client.rpc.account.login( + AccountLoginRequest(host="https://github.com", login=login, token=token) + ) + assert isinstance(login_result.stored_in_vault, bool) + + current = await client.rpc.account.get_current_auth() + assert current.auth_errors is None + assert current.auth_info is not None + assert current.auth_info.type == "user" + assert current.auth_info.host == "https://github.com" + assert current.auth_info.login == login + + users = await client.rpc.account.get_all_users() + assert isinstance(users, list) + account = next( + ( + user + for user in users + if user.auth_info.type == "user" + and getattr(user.auth_info, "login", None) == login + ), + None, + ) + if account is not None: + assert account.token == token + + logout = await client.rpc.account.logout( + AccountLogoutRequest(auth_info=current.auth_info) + ) + assert logout.has_more_users is False + + after_logout = await client.rpc.account.get_current_auth() + assert after_logout.auth_info is None + finally: + await _dispose_isolated(client, home) + + async def test_should_report_agent_registry_spawn_gate_closed(self, ctx: E2ETestContext): + client, home = await _create_isolated_client(ctx) + try: + with pytest.raises(Exception) as excinfo: + await client.rpc.agent_registry.spawn(AgentRegistrySpawnRequest(cwd=ctx.work_dir)) + + message = str(excinfo.value) + assert "Unhandled method".lower() not in message.lower() + assert "agentRegistry.spawn".lower() in message.lower() + assert "not enabled" in message.lower() or "no delegate" in message.lower(), message + finally: + await _dispose_isolated(client, home) + + async def test_should_shut_down_owned_runtime(self, ctx: E2ETestContext): + client = _create_dedicated_client(ctx) + try: + await client.start() + await client.rpc.user.settings.reload() + + await client.rpc.runtime.shutdown() + + async def stopped_serving() -> bool: + try: + await client.rpc.user.settings.reload(timeout=1.0) + return False + except Exception: + return True + + await wait_for_condition( + stopped_serving, + timeout=15.0, + poll_interval=0.1, + timeout_message="Runtime kept serving RPCs after a graceful shutdown.", + ) + finally: + await _stop_client(client) + + async def test_should_report_not_found_when_opening_session_without_context( + self, ctx: E2ETestContext + ): + client, home = await _create_isolated_client(ctx) + try: + result = await client.rpc.sessions.open(SessionsOpenResumeLast()) + + assert result.status == SessionsOpenStatus.NOT_FOUND + assert result.session_id is None + finally: + await _dispose_isolated(client, home) + + async def test_should_reject_send_attachments_from_non_extension_connection( + self, ctx: E2ETestContext + ): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + with pytest.raises(Exception) as excinfo: + await session.rpc.extensions.send_attachments_to_message( + SendAttachmentsToMessageParams(attachments=[]) + ) + + message = str(excinfo.value) + assert "Unhandled method".lower() not in message.lower() + assert "extension" in message.lower() diff --git a/python/e2e/test_rpc_server_plugins_e2e.py b/python/e2e/test_rpc_server_plugins_e2e.py new file mode 100644 index 000000000..538d1692f --- /dev/null +++ b/python/e2e/test_rpc_server_plugins_e2e.py @@ -0,0 +1,293 @@ +""" +E2E coverage for server-scoped plugin and marketplace RPC methods. + +Mirrors ``dotnet/test/E2E/RpcServerPluginsE2ETests.cs`` (snapshot +category ``rpc_server_plugins``). +""" + +from __future__ import annotations + +import contextlib +import shutil +import uuid +from pathlib import Path + +import pytest + +from copilot import CopilotClient, RuntimeConnection +from copilot.rpc import ( + PluginsDisableRequest, + PluginsEnableRequest, + PluginsInstallRequest, + PluginsMarketplacesAddRequest, + PluginsMarketplacesBrowseRequest, + PluginsMarketplacesRefreshRequest, + PluginsMarketplacesRemoveRequest, + PluginsUninstallRequest, + PluginsUpdateRequest, +) + +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + +MARKETPLACE_NAME = "csharp-e2e-marketplace" +PLUGIN_NAME = "csharp-e2e-plugin" +DIRECT_PLUGIN_NAME = "csharp-e2e-direct" + + +def _write_skill_file(plugin_dir: Path) -> None: + skill = """--- +name: csharp-e2e-skill +description: A demo skill contributed by the E2E test plugin. +--- +# Demo Skill + +This skill exists so the plugin reports at least one installed skill. +""" + (plugin_dir / "SKILL.md").write_text(skill, encoding="utf-8", newline="\n") + + +def _create_local_marketplace_fixture(ctx: E2ETestContext) -> Path: + directory = Path(ctx.work_dir) / f"copilot-e2e-mp-{uuid.uuid4().hex}" + directory.mkdir(parents=True) + manifest = f"""{{ + "name": "{MARKETPLACE_NAME}", + "owner": {{ "name": "Copilot SDK E2E" }}, + "metadata": {{ "description": "Local marketplace fixture for SDK E2E tests." }}, + "plugins": [ + {{ + "name": "{PLUGIN_NAME}", + "source": "./{PLUGIN_NAME}", + "description": "E2E demo plugin advertised by the local marketplace.", + "version": "1.0.0" + }} + ] +}} +""" + (directory / "marketplace.json").write_text(manifest, encoding="utf-8", newline="\n") + plugin_dir = directory / PLUGIN_NAME + plugin_dir.mkdir() + _write_skill_file(plugin_dir) + return directory + + +def _create_direct_plugin_fixture(ctx: E2ETestContext) -> Path: + directory = Path(ctx.work_dir) / f"copilot-e2e-plugin-{uuid.uuid4().hex}" + directory.mkdir(parents=True) + manifest = f"""{{ + "name": "{DIRECT_PLUGIN_NAME}", + "description": "E2E demo plugin installed directly from a local path.", + "version": "1.0.0" +}} +""" + (directory / "plugin.json").write_text(manifest, encoding="utf-8", newline="\n") + _write_skill_file(directory) + return directory + + +async def _create_isolated_client(ctx: E2ETestContext) -> tuple[CopilotClient, Path]: + home = Path(ctx.work_dir) / f"copilot-e2e-home-{uuid.uuid4().hex}" + home.mkdir(parents=True) + env = ctx.get_env() + for key in ("COPILOT_HOME", "GH_CONFIG_DIR", "XDG_CONFIG_HOME", "XDG_STATE_HOME"): + env[key] = str(home) + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=DEFAULT_GITHUB_TOKEN, + ) + await client.start() + return client, home + + +async def _dispose_isolated(client: CopilotClient, home: Path, fixture_dir: Path | None) -> None: + with contextlib.suppress(ExceptionGroup): + await client.stop() + with contextlib.suppress(OSError): + shutil.rmtree(home, ignore_errors=True) + if fixture_dir is not None: + with contextlib.suppress(OSError): + shutil.rmtree(fixture_dir, ignore_errors=True) + + +class TestRpcServerPlugins: + async def test_should_install_and_list_plugin_from_local_marketplace(self, ctx: E2ETestContext): + marketplace_dir = _create_local_marketplace_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + await client.rpc.plugins.marketplaces.add( + PluginsMarketplacesAddRequest(source=str(marketplace_dir)) + ) + + spec = f"{PLUGIN_NAME}@{MARKETPLACE_NAME}" + install = await client.rpc.plugins.install(PluginsInstallRequest(source=spec)) + + assert install.plugin.name == PLUGIN_NAME + assert install.plugin.marketplace == MARKETPLACE_NAME + assert install.plugin.enabled is True + assert install.skills_installed >= 1 + assert install.deprecation_warning is None + + after_install = await client.rpc.plugins.list() + listed = [ + p + for p in after_install.plugins + if p.name == PLUGIN_NAME and p.marketplace == MARKETPLACE_NAME + ] + assert len(listed) == 1 + assert listed[0].enabled is True + + finally: + await _dispose_isolated(client, home, marketplace_dir) + + async def test_should_enable_and_disable_marketplace_plugin(self, ctx: E2ETestContext): + marketplace_dir = _create_local_marketplace_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + spec = f"{PLUGIN_NAME}@{MARKETPLACE_NAME}" + await client.rpc.plugins.marketplaces.add( + PluginsMarketplacesAddRequest(source=str(marketplace_dir)) + ) + await client.rpc.plugins.install(PluginsInstallRequest(source=spec)) + + await client.rpc.plugins.disable(PluginsDisableRequest(names=[spec])) + assert _single_marketplace_plugin(await client.rpc.plugins.list()).enabled is False + + await client.rpc.plugins.enable(PluginsEnableRequest(names=[spec])) + assert _single_marketplace_plugin(await client.rpc.plugins.list()).enabled is True + finally: + await _dispose_isolated(client, home, marketplace_dir) + + async def test_should_update_single_marketplace_plugin(self, ctx: E2ETestContext): + marketplace_dir = _create_local_marketplace_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + spec = f"{PLUGIN_NAME}@{MARKETPLACE_NAME}" + await client.rpc.plugins.marketplaces.add( + PluginsMarketplacesAddRequest(source=str(marketplace_dir)) + ) + await client.rpc.plugins.install(PluginsInstallRequest(source=spec)) + + update = await client.rpc.plugins.update(PluginsUpdateRequest(name=spec)) + + assert update.skills_installed >= 1 + assert update.previous_version == "1.0.0" + assert update.new_version == "1.0.0" + finally: + await _dispose_isolated(client, home, marketplace_dir) + + async def test_should_update_all_installed_plugins(self, ctx: E2ETestContext): + marketplace_dir = _create_local_marketplace_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + spec = f"{PLUGIN_NAME}@{MARKETPLACE_NAME}" + await client.rpc.plugins.marketplaces.add( + PluginsMarketplacesAddRequest(source=str(marketplace_dir)) + ) + await client.rpc.plugins.install(PluginsInstallRequest(source=spec)) + + result = await client.rpc.plugins.update_all() + + entries = [ + r + for r in result.results + if r.name == PLUGIN_NAME and r.marketplace == MARKETPLACE_NAME + ] + assert len(entries) == 1 + entry = entries[0] + assert entry.success is True, entry.error + assert entry.skills_installed is not None and entry.skills_installed >= 1 + finally: + await _dispose_isolated(client, home, marketplace_dir) + + async def test_should_install_direct_local_plugin_with_deprecation_warning( + self, ctx: E2ETestContext + ): + plugin_dir = _create_direct_plugin_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + install = await client.rpc.plugins.install( + PluginsInstallRequest(source=str(plugin_dir)) + ) + + assert install.plugin.name == DIRECT_PLUGIN_NAME + assert install.plugin.marketplace == "" + assert install.deprecation_warning is not None + assert "deprecated" in install.deprecation_warning.lower() + assert install.skills_installed >= 1 + + after_install = await client.rpc.plugins.list() + assert len([p for p in after_install.plugins if p.name == DIRECT_PLUGIN_NAME]) == 1 + assert install.plugin.direct_source_id + + await client.rpc.plugins.uninstall( + PluginsUninstallRequest( + name=DIRECT_PLUGIN_NAME, + direct_source_id=install.plugin.direct_source_id, + ) + ) + + after_uninstall = await client.rpc.plugins.list() + assert not any(p.name == DIRECT_PLUGIN_NAME for p in after_uninstall.plugins) + finally: + await _dispose_isolated(client, home, plugin_dir) + + async def test_should_list_browse_refresh_and_remove_local_marketplace( + self, ctx: E2ETestContext + ): + marketplace_dir = _create_local_marketplace_fixture(ctx) + client, home = await _create_isolated_client(ctx) + try: + add = await client.rpc.plugins.marketplaces.add( + PluginsMarketplacesAddRequest(source=str(marketplace_dir)) + ) + assert add.name == MARKETPLACE_NAME + + marketplaces = await client.rpc.plugins.marketplaces.list() + mine = [m for m in marketplaces.marketplaces if m.name == MARKETPLACE_NAME] + assert len(mine) == 1 + assert mine[0].is_default is not True + assert any(m.is_default is True for m in marketplaces.marketplaces) + + browse = await client.rpc.plugins.marketplaces.browse( + PluginsMarketplacesBrowseRequest(name=MARKETPLACE_NAME) + ) + advertised = [p for p in browse.plugins if p.name == PLUGIN_NAME] + assert len(advertised) == 1 + assert (advertised[0].description or "").strip() + + refresh = await client.rpc.plugins.marketplaces.refresh( + PluginsMarketplacesRefreshRequest(name=MARKETPLACE_NAME) + ) + refreshed = [r for r in refresh.results if r.name == MARKETPLACE_NAME] + assert len(refreshed) == 1 + assert refreshed[0].success is True, refreshed[0].error + + remove = await client.rpc.plugins.marketplaces.remove( + PluginsMarketplacesRemoveRequest(name=MARKETPLACE_NAME) + ) + assert remove.removed is True + + after_remove = await client.rpc.plugins.marketplaces.list() + assert not any(m.name == MARKETPLACE_NAME for m in after_remove.marketplaces) + finally: + await _dispose_isolated(client, home, marketplace_dir) + + async def test_should_reload_mcp_config_cache(self, ctx: E2ETestContext): + client, home = await _create_isolated_client(ctx) + try: + await client.rpc.mcp.config.reload() + finally: + await _dispose_isolated(client, home, None) + + +def _single_marketplace_plugin(plugin_list): + plugins = [ + p + for p in plugin_list.plugins + if p.name == PLUGIN_NAME and p.marketplace == MARKETPLACE_NAME + ] + assert len(plugins) == 1 + return plugins[0] diff --git a/python/e2e/test_rpc_server_remote_control_e2e.py b/python/e2e/test_rpc_server_remote_control_e2e.py new file mode 100644 index 000000000..0fe2cc1b3 --- /dev/null +++ b/python/e2e/test_rpc_server_remote_control_e2e.py @@ -0,0 +1,130 @@ +""" +E2E coverage for server-scoped remote-control RPC methods. + +Mirrors ``dotnet/test/E2E/RpcServerRemoteControlE2ETests.cs`` (snapshot +category ``rpc_server_remote_control``). +""" + +from __future__ import annotations + +import contextlib +import uuid + +import pytest + +from copilot import CopilotClient, RuntimeConnection +from copilot.rpc import ( + RemoteControlConfig, + RemoteControlStatusOff, + SessionsSetRemoteControlSteeringRequest, + SessionsStartRemoteControlRequest, + SessionsStopRemoteControlRequest, + SessionsTransferRemoteControlRequest, +) + +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +def _create_dedicated_client(ctx: E2ETestContext) -> CopilotClient: + return CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + ) + + +async def _stop_client(client: CopilotClient) -> None: + with contextlib.suppress(ExceptionGroup): + await client.stop() + + +class TestRpcServerRemoteControl: + async def test_should_report_remote_control_status_as_off(self, ctx: E2ETestContext): + client = _create_dedicated_client(ctx) + try: + await client.start() + + result = await client.rpc.sessions.get_remote_control_status() + + assert isinstance(result.status, RemoteControlStatusOff) + assert result.status.state == "off" + finally: + await _stop_client(client) + + async def test_should_treat_set_steering_as_no_op_when_off(self, ctx: E2ETestContext): + client = _create_dedicated_client(ctx) + try: + await client.start() + + result = await client.rpc.sessions.set_remote_control_steering( + SessionsSetRemoteControlSteeringRequest(enabled=False) + ) + + assert isinstance(result.status, RemoteControlStatusOff) + finally: + await _stop_client(client) + + async def test_should_report_not_stopped_when_remote_control_is_off(self, ctx: E2ETestContext): + client = _create_dedicated_client(ctx) + try: + await client.start() + + result = await client.rpc.sessions.stop_remote_control( + SessionsStopRemoteControlRequest() + ) + + assert result.stopped is False + assert isinstance(result.status, RemoteControlStatusOff) + finally: + await _stop_client(client) + + async def test_should_reject_transfer_when_off_with_compare_and_swap(self, ctx: E2ETestContext): + client = _create_dedicated_client(ctx) + try: + await client.start() + + result = await client.rpc.sessions.transfer_remote_control( + SessionsTransferRemoteControlRequest( + to_session_id=f"rc-to-{uuid.uuid4().hex}", + expected_from_session_id=f"rc-from-{uuid.uuid4().hex}", + ) + ) + + assert result.transferred is False + assert isinstance(result.status, RemoteControlStatusOff) + finally: + await _stop_client(client) + + async def test_should_reach_runtime_when_starting_remote_control_for_unknown_session( + self, ctx: E2ETestContext + ): + client = _create_dedicated_client(ctx) + try: + await client.start() + + try: + with pytest.raises(Exception) as excinfo: + await client.rpc.sessions.start_remote_control( + SessionsStartRemoteControlRequest( + session_id=f"missing-session-{uuid.uuid4().hex}", + config=RemoteControlConfig( + explicit=False, + remote=False, + silent=True, + steerable=False, + ), + ) + ) + message = str(excinfo.value) + assert "Unhandled method".lower() not in message.lower() + assert "session" in message.lower() or "remote" in message.lower(), message + finally: + with contextlib.suppress(Exception): + await client.rpc.sessions.stop_remote_control( + SessionsStopRemoteControlRequest(force=True) + ) + finally: + await _stop_client(client) diff --git a/python/e2e/test_rpc_session_state_e2e.py b/python/e2e/test_rpc_session_state_e2e.py index 62e1c1105..f4b03d2e6 100644 --- a/python/e2e/test_rpc_session_state_e2e.py +++ b/python/e2e/test_rpc_session_state_e2e.py @@ -16,7 +16,7 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( AuthInfoType, CopilotUserResponse, CopilotUserResponseEndpoints, @@ -33,28 +33,29 @@ ModeSetRequest, NameSetAutoRequest, NameSetRequest, + PermissionsResetSessionApprovalsRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, - SessionMode, SessionSetCredentialsParams, SessionsForkRequest, SessionUpdateOptionsParams, SessionWorkingDirectoryContext, ShutdownRequest, - ShutdownType, TelemetrySetFeatureOverridesRequest, UserAuthInfo, WorkspacesCreateFileRequest, WorkspacesReadFileRequest, ) -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( AssistantMessageData, SessionContextChangedData, + SessionMode, SessionShutdownData, SessionTitleChangedData, + ShutdownType, UserMessageData, ) -from copilot.session import PermissionHandler from .testharness import E2ETestContext @@ -111,26 +112,39 @@ async def test_should_call_session_rpc_model_get_current(self, ctx: E2ETestConte finally: await session.disconnect() - async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext): - session = await ctx.client.create_session( - on_permission_request=PermissionHandler.approve_all, - model="claude-sonnet-4.5", - ) + async def test_should_call_session_rpc_model_switchto(self, ctx: E2ETestContext): + # The runtime caches /models per (auth, base_url) for 30 minutes (see + # capi_client.rs LIST_MODELS_CACHE). Tests in this class share one CLI + # subprocess and proxy URL via the module-scoped `ctx` fixture, so the + # first snapshot's models list is reused by every later test. switch_to + # needs gpt-5.4 in the cache; rather than poisoning every other snapshot + # we spin up an isolated context with its own subprocess and proxy → its + # own (auth, base_url) cache key. + isolated_ctx = E2ETestContext() + await isolated_ctx.setup() try: - before = await session.rpc.model.get_current() - assert before.model_id - - result = await session.rpc.model.switch_to( - ModelSwitchToRequest(model_id="gpt-4.1", reasoning_effort="high") + await isolated_ctx.configure_for_test( + "rpc_session_state", "should_call_session_rpc_model_switchto" + ) + session = await isolated_ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="claude-sonnet-4.5", ) - after = await session.rpc.model.get_current() + try: + before = await session.rpc.model.get_current() + assert before.model_id + + result = await session.rpc.model.switch_to( + ModelSwitchToRequest(model_id="gpt-5.4", reasoning_effort="high") + ) + assert result.model_id == "gpt-5.4" - assert result.model_id == "gpt-4.1" - # Python's current RPC surface resolves the requested override but does - # not mutate the live session model selection. - assert after.model_id == before.model_id + after = await session.rpc.model.get_current() + assert after.model_id == "gpt-5.4" + finally: + await session.disconnect() finally: - await session.disconnect() + await isolated_ctx.teardown() async def test_should_get_and_set_session_mode(self, ctx: E2ETestContext): session = await ctx.client.create_session( @@ -246,7 +260,6 @@ async def test_should_call_metadata_snapshot_set_working_directory_and_record_co ): first_dir = _create_unique_directory(ctx, "metadata-first") second_dir = _create_unique_directory(ctx, "metadata-second") - context_dir = _create_unique_directory(ctx, "metadata-context") branch = f"rpc-context-{uuid.uuid4().hex}" session = await ctx.client.create_session( @@ -291,10 +304,13 @@ def on_event(event): unsubscribe = session.on(on_event) try: + # For local sessions the CLI treats the session cwd as authoritative, so a + # record_context_change that reports a divergent cwd is ignored and emits + # no event. Report the current working directory (second_dir) to observe it. result = await session.rpc.metadata.record_context_change( MetadataRecordContextChangeRequest( context=SessionWorkingDirectoryContext( - cwd=context_dir, + cwd=second_dir, git_root=first_dir, branch=branch, repository="github/copilot-sdk-e2e", @@ -308,7 +324,7 @@ def on_event(event): assert result is not None event = await asyncio.wait_for(context_future, timeout=15.0) - assert _path_equals(context_dir, event.data.cwd) + assert _path_equals(second_dir, event.data.cwd) assert _path_equals(first_dir, event.data.git_root) assert event.data.branch == branch assert event.data.repository == "github/copilot-sdk-e2e" @@ -429,7 +445,7 @@ async def test_should_set_auth_credentials(self, ctx: E2ETestContext): ) try: login = f"sdk-rpc-{uuid.uuid4().hex}" - result = await session.rpc.auth.set_credentials( + result = await session.rpc.git_hub_auth.set_credentials( SessionSetCredentialsParams( credentials=UserAuthInfo( host="https://github.com", @@ -449,7 +465,7 @@ async def test_should_set_auth_credentials(self, ctx: E2ETestContext): ) assert result.success is True - status = await session.rpc.auth.get_status() + status = await session.rpc.git_hub_auth.get_status() assert status.is_authenticated is True assert status.auth_type == AuthInfoType.USER assert status.host == "https://github.com" @@ -579,7 +595,9 @@ async def test_should_call_session_usage_and_permission_rpcs(self, ctx: E2ETestC ) assert approve_all.success - reset = await session.rpc.permissions.reset_session_approvals() + reset = await session.rpc.permissions.reset_session_approvals( + PermissionsResetSessionApprovalsRequest() + ) assert reset.success finally: await session.rpc.permissions.set_approve_all( @@ -745,7 +763,7 @@ async def test_should_update_existing_workspace_file_with_update_operation( import asyncio import uuid - from copilot.generated.session_events import ( + from copilot.session_events import ( SessionWorkspaceFileChangedData, WorkspaceFileChangedOperation, ) @@ -803,7 +821,7 @@ async def test_should_emit_title_changed_event_each_time_name_set_is_called( import asyncio import uuid - from copilot.generated.session_events import SessionTitleChangedData + from copilot.session_events import SessionTitleChangedData session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, diff --git a/python/e2e/test_rpc_session_state_extras_e2e.py b/python/e2e/test_rpc_session_state_extras_e2e.py new file mode 100644 index 000000000..5d0d881a0 --- /dev/null +++ b/python/e2e/test_rpc_session_state_extras_e2e.py @@ -0,0 +1,303 @@ +""" +E2E coverage for additional session-scoped RPC methods. + +Mirrors ``dotnet/test/E2E/RpcSessionStateExtrasE2ETests.cs`` (snapshot +category ``rpc_session_state_extras``). +""" + +from __future__ import annotations + +import contextlib +import json +import time + +import pytest + +from copilot import CopilotClient, RuntimeConnection +from copilot.rpc import ( + CompletionsRequestRequest, + MetadataContextHeaviestMessagesRequest, + ModelSwitchToRequest, + NamedProviderConfig, + PermissionsSetAllowAllRequest, + ProviderAddRequest, + ProviderModelConfig, + ProviderType, + ProviderWireAPI, + SessionVisibilityStatus, + SubagentSettings, + SubagentSettingsEntry, + SubagentSettingsEntryContextTier, + UpdateSubagentSettingsRequest, + VisibilitySetRequest, +) +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +def _make_authed_client(ctx: E2ETestContext, token: str) -> CopilotClient: + env = ctx.get_env() + env["COPILOT_DEBUG_GITHUB_API_URL"] = ctx.proxy_url + return CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=env, + github_token=token, + ) + + +async def _configure_user(ctx: E2ETestContext, token: str) -> None: + await ctx.set_copilot_user_by_token( + token, + { + "login": "rpc-session-extras-user", + "copilot_plan": "individual_pro", + "endpoints": { + "api": ctx.proxy_url, + "telemetry": "https://localhost:1/telemetry", + }, + "analytics_tracking_id": "rpc-session-extras-tracking-id", + }, + ) + + +async def _stop_client(client: CopilotClient) -> None: + with contextlib.suppress(ExceptionGroup): + await client.stop() + + +class TestRpcSessionStateExtras: + async def test_should_list_models_for_session(self, ctx: E2ETestContext): + token = "rpc-session-model-list-token" + await _configure_user(ctx, token) + client = _make_authed_client(ctx, token) + try: + async with await client.create_session( + model="claude-sonnet-4.5", + on_permission_request=PermissionHandler.approve_all, + github_token=token, + ) as session: + result = await session.rpc.model.list() + + assert result.list is not None + assert len(result.list) > 0 + assert any( + "claude-sonnet-4.5" in json.dumps(model, sort_keys=True) + for model in result.list + ) + finally: + await _stop_client(client) + + async def test_should_report_session_activity_when_idle(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + activity = await session.rpc.metadata.activity() + + assert activity.has_active_work is False + assert activity.abortable is False + + async def test_should_add_byok_provider_and_model_at_runtime(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + provider_name = f"sdk-runtime-provider-{time.time_ns()}" + model_id = "sdk-runtime-model" + selection_id = f"{provider_name}/{model_id}" + + added = await session.rpc.provider.add( + ProviderAddRequest( + providers=[ + NamedProviderConfig( + name=provider_name, + type=ProviderType.OPENAI, + wire_api=ProviderWireAPI.COMPLETIONS, + base_url="https://api.example.test/v1", + api_key="runtime-provider-secret", + headers={"X-SDK-Provider": "runtime"}, + ) + ], + models=[ + ProviderModelConfig( + provider=provider_name, + id=model_id, + name="SDK Runtime Model", + model_id="claude-sonnet-4.5", + wire_model="wire-sdk-runtime-model", + max_context_window_tokens=4096, + max_prompt_tokens=3072, + max_output_tokens=1024, + ) + ], + ) + ) + + assert len(added.models) == 1 + assert selection_id in json.dumps(added.models[0], sort_keys=True) + assert "SDK Runtime Model" in json.dumps(added.models[0], sort_keys=True) + + listed = await session.rpc.model.list() + assert any(selection_id in json.dumps(model, sort_keys=True) for model in listed.list) + + switched = await session.rpc.model.switch_to( + ModelSwitchToRequest(model_id=selection_id) + ) + assert switched.model_id == selection_id + assert (await session.rpc.model.get_current()).model_id == selection_id + + async def test_should_return_empty_completions_when_host_does_not_provide_them( + self, ctx: E2ETestContext + ): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + triggers = await session.rpc.completions.get_trigger_characters() + assert triggers.trigger_characters == [] + + completions = await session.rpc.completions.request( + CompletionsRequestRequest(text="Use @", offset=5) + ) + assert completions.items == [] + + async def test_should_report_visibility_as_unsynced_for_local_session( + self, ctx: E2ETestContext + ): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + initial = await session.rpc.visibility.get() + assert initial.synced is False + assert initial.status is None + assert initial.share_url is None + + updated = await session.rpc.visibility.set( + VisibilitySetRequest(status=SessionVisibilityStatus.REPO) + ) + assert updated.synced is False + assert updated.status is None + assert updated.share_url is None + + async def test_should_get_and_set_allowall_permissions(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + try: + initial = await session.rpc.permissions.get_allow_all() + assert initial.enabled is False + + enable = await session.rpc.permissions.set_allow_all( + PermissionsSetAllowAllRequest(enabled=True) + ) + assert enable.success is True + assert enable.enabled is True + assert (await session.rpc.permissions.get_allow_all()).enabled is True + + disable = await session.rpc.permissions.set_allow_all( + PermissionsSetAllowAllRequest(enabled=False) + ) + assert disable.success is True + assert disable.enabled is False + assert (await session.rpc.permissions.get_allow_all()).enabled is False + finally: + with contextlib.suppress(Exception): + await session.rpc.permissions.set_allow_all( + PermissionsSetAllowAllRequest(enabled=False) + ) + + async def test_should_get_context_attribution_and_heaviest_messages_after_turn( + self, ctx: E2ETestContext + ): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + answer = await session.send_and_wait("Say CONTEXT_METADATA_OK exactly.", timeout=60.0) + assert answer is not None + assert "CONTEXT_METADATA_OK" in (answer.data.content or "") + + attribution = await session.rpc.metadata.get_context_attribution() + assert attribution.context_attribution is not None + context_attribution = attribution.context_attribution + assert context_attribution.total_tokens > 0 + assert len(context_attribution.entries) > 0 + for entry in context_attribution.entries: + assert entry.id.strip() + assert entry.kind.strip() + assert entry.label.strip() + assert entry.tokens >= 0 + for key in entry.attributes or {}: + assert key.strip() + + heaviest = await session.rpc.metadata.get_context_heaviest_messages( + MetadataContextHeaviestMessagesRequest(limit=2) + ) + assert heaviest.total_tokens > 0 + assert len(heaviest.messages) <= 2 + for message in heaviest.messages: + assert message.id.strip() + assert message.tokens >= 0 + + async def test_should_update_and_clear_live_subagent_settings(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + await session.rpc.tools.update_subagent_settings( + UpdateSubagentSettingsRequest( + subagents=SubagentSettings( + { + "general-purpose": SubagentSettingsEntry( + model="claude-haiku-4.5", + effort_level="low", + context_tier=SubagentSettingsEntryContextTier.DEFAULT, + ) + } + ) + ) + ) + + await session.rpc.tools.update_subagent_settings( + UpdateSubagentSettingsRequest(subagents=None) + ) + + async def test_should_read_empty_sql_todos_for_fresh_session(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + result = await session.rpc.plan.read_sql_todos() + + assert result.rows is not None + assert result.rows == [] + + async def test_should_get_telemetry_engagement_id(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + result = await session.rpc.telemetry.get_engagement_id() + + assert result is not None + + async def test_should_get_current_tool_metadata_after_initialization(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + answer = await session.send_and_wait("What is 2+2?", timeout=60.0) + assert answer is not None + + result = await session.rpc.tools.get_current_metadata() + + assert result.tools is not None + assert len(result.tools) > 0 + assert all((tool.name or "").strip() for tool in result.tools) + assert all(tool.description is not None for tool in result.tools) + + async def test_should_reload_session_plugins(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + await session.rpc.plugins.reload() + + plugins = await session.rpc.plugins.list() + assert plugins.plugins is not None + assert all((plugin.name or "").strip() for plugin in plugins.plugins) diff --git a/python/e2e/test_rpc_shell_and_fleet_e2e.py b/python/e2e/test_rpc_shell_and_fleet_e2e.py index 32177cbbd..d5a88456a 100644 --- a/python/e2e/test_rpc_shell_and_fleet_e2e.py +++ b/python/e2e/test_rpc_shell_and_fleet_e2e.py @@ -15,15 +15,19 @@ import pytest -from copilot.generated.rpc import FleetStartRequest, ShellExecRequest, ShellKillRequest -from copilot.generated.session_events import ( +from copilot.rpc import ( + FleetStartRequest, + ShellExecRequest, + ShellKillRequest, +) +from copilot.session import PermissionHandler +from copilot.session_events import ( AssistantMessageData, SessionErrorData, ToolExecutionCompleteData, ToolExecutionStartData, UserMessageData, ) -from copilot.session import PermissionHandler from copilot.tools import Tool, ToolInvocation, ToolResult from .testharness import E2ETestContext diff --git a/python/e2e/test_rpc_shell_user_requested_e2e.py b/python/e2e/test_rpc_shell_user_requested_e2e.py new file mode 100644 index 000000000..11775e5fc --- /dev/null +++ b/python/e2e/test_rpc_shell_user_requested_e2e.py @@ -0,0 +1,122 @@ +""" +E2E coverage for session-scoped user-requested shell RPC methods. + +Mirrors ``dotnet/test/E2E/RpcShellUserRequestedE2ETests.cs`` (snapshot +category ``rpc_shell_user_requested``). +""" + +from __future__ import annotations + +import asyncio +import contextlib +import sys +import uuid +from pathlib import Path + +import pytest + +from copilot.rpc import ShellCancelUserRequestedRequest, ShellExecuteUserRequestedRequest +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext, wait_for_condition + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +def _create_marker_then_sleep_command(marker_path: Path, seconds: int) -> str: + if sys.platform == "win32": + return ( + f"Set-Content -LiteralPath '{marker_path}' -Value 'running'; " + f"Start-Sleep -Seconds {seconds}" + ) + return f"printf '%s' running > '{marker_path}'; sleep {seconds}" + + +class TestRpcShellUserRequested: + async def test_should_execute_user_requested_shell_command(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + marker = f"copilotusershell{uuid.uuid4().hex}" + request_id = f"req-{uuid.uuid4().hex}" + + result = await session.rpc.shell.execute_user_requested( + ShellExecuteUserRequestedRequest(command=f"echo {marker}", request_id=request_id) + ) + + assert result.success is True, f"Expected success. Error: {result.error}" + assert result.exit_code == 0 + assert marker in result.output + assert (result.tool_call_id or "").strip() + + async def test_should_cancel_user_requested_shell_command(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + missing = await session.rpc.shell.cancel_user_requested( + ShellCancelUserRequestedRequest(request_id=f"missing-{uuid.uuid4().hex}") + ) + assert missing.cancelled is False + + request_id = f"req-{uuid.uuid4().hex}" + marker_path = Path(ctx.home_dir) / f"shell-cancel-{uuid.uuid4().hex}.txt" + execute_task = asyncio.create_task( + session.rpc.shell.execute_user_requested( + ShellExecuteUserRequestedRequest( + request_id=request_id, + command=_create_marker_then_sleep_command(marker_path, seconds=60), + ) + ) + ) + + try: + await wait_for_condition( + marker_path.exists, + timeout=30.0, + poll_interval=0.1, + timeout_message=( + f"Timed out waiting for the shell command to create '{marker_path}'." + ), + ) + + async def cancel_took_effect() -> bool: + result = await session.rpc.shell.cancel_user_requested( + ShellCancelUserRequestedRequest(request_id=request_id) + ) + return result.cancelled + + await wait_for_condition( + cancel_took_effect, + timeout=15.0, + poll_interval=0.1, + timeout_message=( + "Timed out waiting for the user-requested shell command " + "to become cancellable." + ), + ) + + await wait_for_condition( + execute_task.done, + timeout=30.0, + poll_interval=0.1, + timeout_message="Timed out waiting for cancelled shell command to finish.", + ) + result = await execute_task + assert result.success is False + finally: + if not execute_task.done(): + with contextlib.suppress(Exception): + await session.rpc.shell.cancel_user_requested( + ShellCancelUserRequestedRequest(request_id=request_id) + ) + with contextlib.suppress(Exception): + await wait_for_condition( + execute_task.done, + timeout=30.0, + poll_interval=0.1, + timeout_message="Timed out draining shell command task.", + ) + if not execute_task.done(): + execute_task.cancel() + with contextlib.suppress(OSError): + marker_path.unlink(missing_ok=True) diff --git a/python/e2e/test_rpc_tasks_and_handlers_e2e.py b/python/e2e/test_rpc_tasks_and_handlers_e2e.py index 5a4caf741..f0dd8f757 100644 --- a/python/e2e/test_rpc_tasks_and_handlers_e2e.py +++ b/python/e2e/test_rpc_tasks_and_handlers_e2e.py @@ -11,9 +11,12 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( CommandsHandlePendingCommandRequest, HandlePendingToolCallRequest, + MCPHeadersHandlePendingHeadersRefreshRequest, + MCPHeadersHandlePendingHeadersRefreshRequestKind, + MCPHeadersHandlePendingHeadersRefreshRequestRequest, PermissionDecisionApproveForLocation, PermissionDecisionApproveForLocationApprovalCustomTool, PermissionDecisionApproveForSession, @@ -41,12 +44,18 @@ UIHandlePendingElicitationRequest, UIHandlePendingExitPlanModeRequest, UIHandlePendingSamplingRequest, + UIHandlePendingSessionLimitsExhaustedRequest, UIHandlePendingUserInputRequest, + UISessionLimitsExhaustedResponse, + UISessionLimitsExhaustedResponseAction, UIUnregisterDirectAutoModeSwitchHandlerRequest, UIUserInputResponse, ) -from copilot.generated.session_events import AssistantMessageData, SessionErrorData from copilot.session import PermissionHandler +from copilot.session_events import ( + AssistantMessageData, + SessionErrorData, +) from .testharness import E2ETestContext @@ -250,6 +259,37 @@ async def test_should_return_expected_results_for_missing_pending_handler_reques ) ) assert location_approval.success is False + + session_limits = await session.rpc.ui.handle_pending_session_limits_exhausted( + UIHandlePendingSessionLimitsExhaustedRequest( + request_id="missing-session-limits-request", + response=UISessionLimitsExhaustedResponse( + action=UISessionLimitsExhaustedResponseAction.CANCEL + ), + ) + ) + assert session_limits.success is False + + headers = await session.rpc.mcp.headers.handle_pending_headers_refresh_request( + MCPHeadersHandlePendingHeadersRefreshRequestRequest( + request_id="missing-headers-refresh-request", + result=MCPHeadersHandlePendingHeadersRefreshRequest( + kind=MCPHeadersHandlePendingHeadersRefreshRequestKind.HEADERS, + headers={"X-SDK-Test": "missing"}, + ), + ) + ) + assert headers.success is False + + no_headers = await session.rpc.mcp.headers.handle_pending_headers_refresh_request( + MCPHeadersHandlePendingHeadersRefreshRequestRequest( + request_id="missing-headers-refresh-none-request", + result=MCPHeadersHandlePendingHeadersRefreshRequest( + kind=MCPHeadersHandlePendingHeadersRefreshRequestKind.NONE, + ), + ) + ) + assert no_headers.success is False finally: await session.disconnect() @@ -332,7 +372,11 @@ async def test_should_report_implemented_error_for_invalid_task_agent_model( async def test_should_start_background_agent_and_report_task_details(self, ctx: E2ETestContext): """Start a background agent task and verify task details then remove it.""" - from copilot.generated.rpc import TaskAgentInfo, TaskInfoExecutionMode, TaskInfoStatus + from copilot.rpc import ( + TaskAgentInfo, + TaskInfoExecutionMode, + TaskInfoStatus, + ) session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, @@ -401,20 +445,28 @@ def on_event(event): 60.0, f"Task {task_id} did not produce a final observable state", ) - assert found_task is not None, f"Task {task_id} disappeared before it completed" - assert "TASK_AGENT_DONE" in (found_task.latest_response or found_task.result or "") - await asyncio.wait_for(task_completion_notification, timeout=30.0) - - if found_task.status == TaskInfoStatus.IDLE: - cancel = await session.rpc.tasks.cancel(TasksCancelRequest(id=task_id)) - assert cancel.cancelled is True - - # Remove the task - remove = await session.rpc.tasks.remove(TasksRemoveRequest(id=task_id)) - assert remove.removed is True + if found_task is not None: + assert "TASK_AGENT_DONE" in (found_task.latest_response or found_task.result or "") + + if found_task.status == TaskInfoStatus.IDLE: + cancel = await session.rpc.tasks.cancel(TasksCancelRequest(id=task_id)) + assert cancel.cancelled is True + + remove = await session.rpc.tasks.remove(TasksRemoveRequest(id=task_id)) + # Completion delivery also removes finished tasks, so this call may lose that race. + assert remove.removed or task_completion_notification.done(), ( + f"Task {task_id} was not removed before its completion " + "notification was delivered" + ) after_remove = await session.rpc.tasks.list() - assert not any(t.id == task_id for t in (after_remove.tasks or [])) + task_after_remove = next( + (task for task in (after_remove.tasks or []) if task.id == task_id), + None, + ) + assert task_after_remove is None + + await asyncio.wait_for(task_completion_notification, timeout=30.0) finally: unsubscribe() await session.disconnect() diff --git a/python/e2e/test_rpc_ui_ephemeral_query_e2e.py b/python/e2e/test_rpc_ui_ephemeral_query_e2e.py new file mode 100644 index 000000000..117fe083d --- /dev/null +++ b/python/e2e/test_rpc_ui_ephemeral_query_e2e.py @@ -0,0 +1,33 @@ +""" +E2E coverage for session-scoped UI ephemeral query RPC. + +Mirrors ``dotnet/test/E2E/RpcUiEphemeralQueryE2ETests.cs`` (snapshot +category ``rpc_ui_ephemeral_query``). +""" + +from __future__ import annotations + +import pytest + +from copilot.rpc import UIEphemeralQueryRequest +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +class TestRpcUiEphemeralQuery: + async def test_should_answer_ephemeral_query(self, ctx: E2ETestContext): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + result = await session.rpc.ui.ephemeral_query( + UIEphemeralQueryRequest( + question="In one word, what is the primary color of a clear daytime sky?" + ) + ) + + assert result is not None + assert (result.answer or "").strip() + assert "blue" in result.answer.lower() diff --git a/python/e2e/test_rpc_workspace_checkpoints_e2e.py b/python/e2e/test_rpc_workspace_checkpoints_e2e.py index 82e419570..a4ad9cf7e 100644 --- a/python/e2e/test_rpc_workspace_checkpoints_e2e.py +++ b/python/e2e/test_rpc_workspace_checkpoints_e2e.py @@ -8,7 +8,7 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( WorkspaceDiffFileChangeType, WorkspaceDiffMode, WorkspacesDiffRequest, diff --git a/python/e2e/test_session_config_e2e.py b/python/e2e/test_session_config_e2e.py index 0a5a4a1e4..62dc67189 100644 --- a/python/e2e/test_session_config_e2e.py +++ b/python/e2e/test_session_config_e2e.py @@ -1,15 +1,29 @@ """E2E tests for session configuration including model capabilities overrides.""" import base64 +import json import os import uuid +import httpx import pytest -from copilot import ModelCapabilitiesOverride, ModelSupportsOverride +from copilot import ( + CopilotClient, + CopilotRequestHandler, + ModelCapabilitiesOverride, + ModelSupportsOverride, + RuntimeConnection, +) +from copilot.copilot_request_handler import CopilotRequestContext from copilot.session import PermissionHandler -from .testharness import E2ETestContext +from ._copilot_request_helpers import ( + build_inference_response, + build_non_inference_response, + is_inference_url, +) +from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -86,6 +100,91 @@ def _get_tool_names(exchange: dict) -> list[str]: return names +async def _send_and_get_next_exchange(session, ctx: E2ETestContext, prompt: str) -> dict: + existing_count = len(await ctx.get_exchanges()) + await session.send_and_wait(prompt) + exchanges = await ctx.get_exchanges() + assert len(exchanges) > existing_count + return exchanges[existing_count] + + +def _assert_session_limits_status(exchange: dict, expected_remaining: str) -> None: + for message in exchange.get("request", {}).get("messages", []): + content = message.get("content") + if message.get("role") == "user" and isinstance(content, str): + if "" in content: + assert f"Remaining session limits: {expected_remaining}." in content + assert ( + "Be frugal; avoid optional exploration and unnecessary tool calls." in content + ) + return + raise AssertionError("Expected session limits status message") + + +def _get_task_agent_types(exchange: dict) -> list[str]: + for tool in exchange.get("request", {}).get("tools", []) or []: + function = tool.get("function") if isinstance(tool, dict) else None + if isinstance(function, dict) and function.get("name") == "task": + parameters = function.get("parameters") + assert isinstance(parameters, dict) + values = parameters["properties"]["agent_type"]["enum"] + assert isinstance(values, list) + return [str(value) for value in values] + raise AssertionError("Expected task tool in request") + + +class _RecordingRequestHandler(CopilotRequestHandler): + def __init__(self): + self.records: list[tuple[str, bytes]] = [] + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + del ctx + self.records.append((str(request.url), request.content)) + if is_inference_url(str(request.url)): + return build_inference_response(request) + return build_non_inference_response(str(request.url)) + + def inference_requests(self) -> list[tuple[str, bytes]]: + return [(url, body) for url, body in self.records if is_inference_url(url)] + + +def _create_pdf_attachment() -> dict: + pdf_text = ( + "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n" + ) + return { + "type": "blob", + "data": base64.b64encode(pdf_text.encode("ascii")).decode("ascii"), + "displayName": "citation-source.pdf", + "mimeType": "application/pdf", + } + + +def _create_anthropic_provider() -> dict: + return { + "type": "anthropic", + "base_url": "https://anthropic-citations.invalid/v1", + "api_key": "test-provider-key", + "model_id": "claude-sonnet-4.5", + "wire_model": "claude-sonnet-4.5", + } + + +def _assert_anthropic_document_citations_enabled(request_body: bytes) -> None: + body = json.loads(request_body.decode("utf-8")) + document_blocks = [ + block + for message in body["messages"] + for block in message["content"] + if block.get("type") == "document" + ] + assert len(document_blocks) == 1 + assert document_blocks[0]["title"] == "citation-source.pdf" + assert document_blocks[0]["citations"] == {"enabled": True} + + PNG_1X1 = base64.b64decode( "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==" ) @@ -162,7 +261,7 @@ async def test_vision_enabled_then_disabled_via_setmodel(self, ctx: E2ETestConte await session.disconnect() async def test_should_use_custom_sessionid(self, ctx: E2ETestContext): - from copilot.generated.session_events import SessionStartData + from copilot.session_events import SessionStartData requested_session_id = str(uuid.uuid4()) session = await ctx.client.create_session( @@ -287,6 +386,161 @@ async def test_should_use_provider_model_id_as_wire_model(self, ctx: E2ETestCont await session.disconnect() + async def test_should_apply_session_limits_on_create(self, ctx: E2ETestContext): + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + session_limits={"max_ai_credits": 30}, + ) + + exchange = await _send_and_get_next_exchange( + session, ctx, "Acknowledge the current session limits." + ) + _assert_session_limits_status(exchange, "30 AI credits") + + await session.disconnect() + + async def test_should_apply_session_limits_on_resume(self, ctx: E2ETestContext): + session1 = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + session2 = await ctx.client.resume_session( + session1.session_id, + on_permission_request=PermissionHandler.approve_all, + session_limits={"max_ai_credits": 30}, + ) + + exchange = await _send_and_get_next_exchange( + session2, ctx, "Acknowledge the current session limits." + ) + _assert_session_limits_status(exchange, "30 AI credits") + + await session2.disconnect() + await session1.disconnect() + + async def test_should_apply_excluded_built_in_agents_on_create(self, ctx: E2ETestContext): + excluded_agent = "explore" + prompt = "What is 1+1?" + + baseline_session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + baseline_exchange = await _send_and_get_next_exchange(baseline_session, ctx, prompt) + assert excluded_agent in _get_task_agent_types(baseline_exchange) + await baseline_session.disconnect() + + excluded_session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + excluded_builtin_agents=[excluded_agent], + ) + excluded_exchange = await _send_and_get_next_exchange(excluded_session, ctx, prompt) + agent_types = _get_task_agent_types(excluded_exchange) + assert agent_types + assert excluded_agent not in agent_types + + await excluded_session.disconnect() + + async def test_should_apply_excluded_built_in_agents_on_resume(self, ctx: E2ETestContext): + excluded_agent = "explore" + session1 = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + session2 = await ctx.client.resume_session( + session1.session_id, + on_permission_request=PermissionHandler.approve_all, + excluded_builtin_agents=[excluded_agent], + ) + + exchange = await _send_and_get_next_exchange(session2, ctx, "What is 1+1?") + agent_types = _get_task_agent_types(exchange) + assert agent_types + assert excluded_agent not in agent_types + + await session2.disconnect() + await session1.disconnect() + + async def test_should_enable_citations_for_anthropic_file_attachments_on_create( + self, ctx: E2ETestContext + ): + handler = _RecordingRequestHandler() + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + request_handler=handler, + ) + await client.start() + try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="claude-sonnet-4.5", + enable_citations=True, + provider=_create_anthropic_provider(), + ) + try: + await session.send_and_wait( + "Summarize the attached PDF with citations enabled.", + attachments=[_create_pdf_attachment()], + ) + inference_requests = handler.inference_requests() + assert len(inference_requests) == 1 + _assert_anthropic_document_citations_enabled(inference_requests[0][1]) + finally: + await session.disconnect() + finally: + await client.stop() + + async def test_should_enable_citations_for_anthropic_file_attachments_on_resume( + self, ctx: E2ETestContext + ): + handler = _RecordingRequestHandler() + connection_token = "python-citation-resume-token" + server_client = CopilotClient( + connection=RuntimeConnection.for_tcp( + path=ctx.cli_path, + connection_token=connection_token, + ), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + request_handler=handler, + ) + await server_client.start() + try: + session1 = await server_client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + assert server_client.runtime_port is not None + resume_client = CopilotClient( + connection=RuntimeConnection.for_uri( + f"localhost:{server_client.runtime_port}", + connection_token=connection_token, + ) + ) + try: + session2 = await resume_client.resume_session( + session1.session_id, + on_permission_request=PermissionHandler.approve_all, + model="claude-sonnet-4.5", + enable_citations=True, + provider=_create_anthropic_provider(), + ) + try: + await session2.send_and_wait( + "Summarize the attached PDF with citations enabled.", + attachments=[_create_pdf_attachment()], + ) + inference_requests = handler.inference_requests() + assert len(inference_requests) == 1 + _assert_anthropic_document_citations_enabled(inference_requests[0][1]) + finally: + await session2.disconnect() + finally: + await resume_client.stop() + await session1.disconnect() + finally: + await server_client.stop() + async def test_should_use_workingdirectory_for_tool_execution(self, ctx: E2ETestContext): sub_dir = os.path.join(ctx.work_dir, "subproject") os.makedirs(sub_dir, exist_ok=True) diff --git a/python/e2e/test_session_e2e.py b/python/e2e/test_session_e2e.py index 69e166801..b6f173f75 100644 --- a/python/e2e/test_session_e2e.py +++ b/python/e2e/test_session_e2e.py @@ -7,11 +7,16 @@ import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.session_events import SessionModelChangeData from copilot.session import PermissionHandler +from copilot.session_events import SessionModelChangeData from copilot.tools import Tool, ToolResult -from .testharness import E2ETestContext, get_final_assistant_message, get_next_event_of_type +from .testharness import ( + DEFAULT_GITHUB_TOKEN, + E2ETestContext, + get_final_assistant_message, + get_next_event_of_type, +) pytestmark = pytest.mark.asyncio(loop_scope="module") @@ -275,6 +280,40 @@ async def test_should_resume_a_session_using_a_new_client(self, ctx: E2ETestCont finally: await new_client.force_stop() + async def test_resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured( # noqa: E501 + self, ctx: E2ETestContext + ): + def on_mcp_auth_request(_request, _invocation): + return {"kind": "cancelled"} + + session1 = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + ) + session_id = session1.session_id + answer = await session1.send_and_wait("What is 1+1?") + assert answer is not None + assert "2" in answer.data.content + + github_token = DEFAULT_GITHUB_TOKEN if os.environ.get("GITHUB_ACTIONS") == "true" else None + new_client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=ctx.cli_path), + working_directory=ctx.work_dir, + env=ctx.get_env(), + github_token=github_token, + ) + + try: + session2 = await new_client.resume_session( + session_id, + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=on_mcp_auth_request, + ) + assert session2.session_id == session_id + await session2.disconnect() + finally: + await new_client.force_stop() + async def test_should_throw_error_resuming_nonexistent_session(self, ctx: E2ETestContext): with pytest.raises(Exception): await ctx.client.resume_session( @@ -513,7 +552,11 @@ async def test_should_abort_a_session(self, ctx: E2ETestContext): assert len(abort_events) > 0, "Expected an abort event in messages" # We should be able to send another message - answer = await session.send_and_wait("What is 2+2?") + wait_for_answer = asyncio.create_task( + get_next_event_of_type(session, "assistant.message", timeout=60.0) + ) + await session.send("What is 2+2?") + answer = await wait_for_answer assert "4" in answer.data.content async def test_should_receive_session_events(self, ctx: E2ETestContext): @@ -636,27 +679,36 @@ async def test_should_set_model_with_reasoning_effort(self, ctx: E2ETestContext) """Test that setModel passes reasoningEffort and it appears in the model_change event.""" import asyncio - session = await ctx.client.create_session( - on_permission_request=PermissionHandler.approve_all - ) + isolated_ctx = E2ETestContext() + await isolated_ctx.setup() + try: + await isolated_ctx.configure_for_test( + "session", "should_set_model_with_reasoningeffort" + ) + session = await isolated_ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all + ) - model_change_event = asyncio.get_event_loop().create_future() + model_change_event = asyncio.get_event_loop().create_future() - def on_event(event): - if model_change_event.done(): - return + def on_event(event): + if model_change_event.done(): + return - match event.data: - case SessionModelChangeData() as data: - model_change_event.set_result(data) + match event.data: + case SessionModelChangeData() as data: + model_change_event.set_result(data) - session.on(on_event) + session.on(on_event) - await session.set_model("gpt-4.1", reasoning_effort="high") + await session.set_model("gpt-5.4", reasoning_effort="high") - data = await asyncio.wait_for(model_change_event, timeout=30) - assert data.new_model == "gpt-4.1" - assert data.reasoning_effort == "high" + data = await asyncio.wait_for(model_change_event, timeout=30) + assert data.new_model == "gpt-5.4" + assert data.reasoning_effort == "high" + await session.disconnect() + finally: + await isolated_ctx.teardown() async def test_should_accept_blob_attachments(self, ctx: E2ETestContext): # Write the image to disk so the model can view it @@ -688,7 +740,7 @@ async def test_should_accept_blob_attachments(self, ctx: E2ETestContext): await session.disconnect() async def test_should_send_with_file_attachment(self, ctx: E2ETestContext): - from copilot.generated.session_events import UserMessageData + from copilot.session_events import UserMessageData file_path = os.path.join(ctx.work_dir, "attached-file.txt") with open(file_path, "w", encoding="utf-8") as f: @@ -726,7 +778,7 @@ async def test_should_send_with_file_attachment(self, ctx: E2ETestContext): await session.disconnect() async def test_should_send_with_directory_attachment(self, ctx: E2ETestContext): - from copilot.generated.session_events import UserMessageData + from copilot.session_events import UserMessageData directory_path = os.path.join(ctx.work_dir, "attached-directory") os.makedirs(directory_path, exist_ok=True) @@ -761,7 +813,7 @@ async def test_should_send_with_directory_attachment(self, ctx: E2ETestContext): await session.disconnect() async def test_should_send_with_selection_attachment(self, ctx: E2ETestContext): - from copilot.generated.session_events import UserMessageData + from copilot.session_events import UserMessageData file_path = os.path.join(ctx.work_dir, "selected-file.cs") with open(file_path, "w", encoding="utf-8") as f: @@ -1088,7 +1140,10 @@ async def _disconnect(): async def test_should_send_with_mode_property(self, ctx: E2ETestContext): """Per-message `agent_mode` is forwarded and echoed back on user.message.""" - from copilot.generated.session_events import UserMessageAgentMode, UserMessageData + from copilot.session_events import ( + UserMessageAgentMode, + UserMessageData, + ) session = await ctx.client.create_session( on_permission_request=PermissionHandler.approve_all, diff --git a/python/e2e/test_session_fs_e2e.py b/python/e2e/test_session_fs_e2e.py index 9d00057ec..bb6e47af7 100644 --- a/python/e2e/test_session_fs_e2e.py +++ b/python/e2e/test_session_fs_e2e.py @@ -18,12 +18,15 @@ SessionFsConfig, define_tool, ) -from copilot.generated.rpc import ( +from copilot.rpc import ( SessionFSReaddirWithTypesEntry, SessionFSReaddirWithTypesEntryType, ) -from copilot.generated.session_events import SessionCompactionCompleteData, SessionEvent from copilot.session import PermissionHandler +from copilot.session_events import ( + SessionCompactionCompleteData, + SessionEvent, +) from copilot.session_fs_provider import SessionFsFileInfo, SessionFsProvider from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext @@ -232,9 +235,7 @@ async def test_should_write_workspace_metadata_via_sessionfs( workspace_yaml_path = provider_path( provider_root, session.session_id, f"{SESSION_STATE_PATH}/workspace.yaml" ) - await wait_for_path(workspace_yaml_path) - yaml_content = workspace_yaml_path.read_text(encoding="utf-8") - assert "id:" in yaml_content + await wait_for_content(workspace_yaml_path, "id:") # Checkpoint index should also exist index_path = provider_path( @@ -247,7 +248,7 @@ async def test_should_write_workspace_metadata_via_sessionfs( async def test_should_persist_plan_md_via_sessionfs( self, ctx: E2ETestContext, session_fs_client: CopilotClient ): - from copilot.generated.rpc import PlanUpdateRequest + from copilot.rpc import PlanUpdateRequest provider_root = Path(ctx.work_dir) / "provider" session = await session_fs_client.create_session( @@ -262,14 +263,12 @@ async def test_should_persist_plan_md_via_sessionfs( plan_path = provider_path( provider_root, session.session_id, f"{SESSION_STATE_PATH}/plan.md" ) - await wait_for_path(plan_path) - content = plan_path.read_text(encoding="utf-8") - assert "# Test Plan" in content + await wait_for_content(plan_path, "# Test Plan") await session.disconnect() async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestContext): - from copilot.generated.rpc import ( + from copilot.rpc import ( SessionFSAppendFileRequest, SessionFSExistsRequest, SessionFSMkdirRequest, @@ -281,6 +280,8 @@ async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestCon SessionFSSqliteExistsRequest, SessionFSSqliteQueryRequest, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionRequest, SessionFSStatRequest, SessionFSWriteFileRequest, ) @@ -388,7 +389,7 @@ async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestCon SessionFSStatRequest(session_id=session_id, path="/workspace/nested/missing.txt") ) assert missing.error is not None - from copilot.generated.rpc import SessionFSErrorCode + from copilot.rpc import SessionFSErrorCode assert missing.error.code == SessionFSErrorCode.ENOENT @@ -404,6 +405,15 @@ async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestCon assert sqlite_query.error is not None assert sqlite_query.error.code == SessionFSErrorCode.UNKNOWN + sqlite_transaction = await handler.sqlite_transaction( + SessionFSSqliteTransactionRequest(session_id=session_id, statements=[]) + ) + assert sqlite_transaction.results == [] + assert sqlite_transaction.error is not None + assert ( + sqlite_transaction.error.error_class == SessionFSSqliteTransactionErrorClass.FATAL + ) + sqlite_exists = await handler.sqlite_exists( SessionFSSqliteExistsRequest(session_id=session_id) ) @@ -417,7 +427,7 @@ async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestCon pass async def test_sessionfsprovider_converts_exceptions_to_rpc_errors(self): - from copilot.generated.rpc import ( + from copilot.rpc import ( SessionFSAppendFileRequest, SessionFSErrorCode, SessionFSExistsRequest, @@ -430,6 +440,8 @@ async def test_sessionfsprovider_converts_exceptions_to_rpc_errors(self): SessionFSSqliteExistsRequest, SessionFSSqliteQueryRequest, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionRequest, SessionFSStatRequest, SessionFSWriteFileRequest, ) @@ -537,6 +549,12 @@ def assert_fs_error(error) -> None: assert sqlite_query.columns == [] assert sqlite_query.rows == [] assert sqlite_query.rows_affected == 0 + sqlite_transaction = await handler.sqlite_transaction( + SessionFSSqliteTransactionRequest(session_id=sid, statements=[]) + ) + assert sqlite_transaction.results == [] + assert sqlite_transaction.error is not None + assert sqlite_transaction.error.error_class == SessionFSSqliteTransactionErrorClass.FATAL sqlite_exists = await handler.sqlite_exists(SessionFSSqliteExistsRequest(session_id=sid)) assert sqlite_exists.exists is False @@ -614,7 +632,7 @@ async def rm(self, path: str, recursive: bool, force: bool) -> None: async def rename(self, src: str, dest: str) -> None: d = self._path(dest) d.parent.mkdir(parents=True, exist_ok=True) - self._path(src).rename(d) + self._path(src).replace(d) def create_test_session_fs_handler(provider_root: Path): @@ -625,7 +643,8 @@ def create_handler(session): def provider_path(provider_root: Path, session_id: str, path: str) -> Path: - return provider_root / session_id / path.lstrip("/") + relative_path = path.replace("\\", "/").lstrip("/") + return provider_root / session_id / relative_path def find_tool_call_result(messages: list[SessionEvent], tool_name: str) -> str | None: diff --git a/python/e2e/test_session_fs_sqlite_e2e.py b/python/e2e/test_session_fs_sqlite_e2e.py index 565c55336..f48bcd2cd 100644 --- a/python/e2e/test_session_fs_sqlite_e2e.py +++ b/python/e2e/test_session_fs_sqlite_e2e.py @@ -8,15 +8,18 @@ import sqlite3 import tempfile from pathlib import Path +from typing import Any import pytest import pytest_asyncio from copilot import CopilotClient, RuntimeConnection, SessionFsConfig -from copilot.generated.rpc import ( +from copilot.rpc import ( SessionFSReaddirWithTypesEntry, SessionFSReaddirWithTypesEntryType, SessionFSSqliteQueryType, + SessionFSSqliteTransactionErrorClass, + SessionFSSqliteTransactionStatement, ) from copilot.session import PermissionHandler from copilot.session_fs_provider import ( @@ -24,6 +27,7 @@ SessionFsProvider, SessionFsSqliteProvider, SessionFsSqliteQueryResult, + SessionFsSqliteTransactionFailure, ) from .testharness import DEFAULT_GITHUB_TOKEN, E2ETestContext @@ -151,6 +155,46 @@ async def sqlite_query( query: str, params: dict[str, float | str | None] | None = None, ) -> SessionFsSqliteQueryResult | None: + return self._run_statement(self._get_or_create_db(), query_type, query, params) + + async def sqlite_transaction( + self, + statements: list[SessionFSSqliteTransactionStatement], + ) -> list[SessionFsSqliteQueryResult]: + db = self._get_or_create_db() + db.execute("BEGIN IMMEDIATE") + try: + results = [ + self._run_statement( + db, statement.query_type, statement.query, statement.params, commit=False + ) + for statement in statements + ] + except Exception as exc: + db.rollback() + message = str(exc) + error_class = ( + SessionFSSqliteTransactionErrorClass.BUSY_OR_LOCKED + if "locked" in message or "busy" in message + else SessionFSSqliteTransactionErrorClass.FATAL + ) + raise SessionFsSqliteTransactionFailure(message, error_class) from exc + try: + db.commit() + except Exception as exc: + raise SessionFsSqliteTransactionFailure( + str(exc), SessionFSSqliteTransactionErrorClass.POST_COMMIT_AMBIGUOUS + ) from exc + return results + + def _run_statement( + self, + db: sqlite3.Connection, + query_type: SessionFSSqliteQueryType, + query: str, + params: dict[str, Any] | None = None, + commit: bool = True, + ) -> SessionFsSqliteQueryResult: self._sqlite_calls.append( { "sessionId": self._session_id, @@ -159,14 +203,16 @@ async def sqlite_query( } ) - db = self._get_or_create_db() trimmed = query.strip() if not trimmed: return SessionFsSqliteQueryResult(columns=[], rows=[], rows_affected=0) if query_type == SessionFSSqliteQueryType.EXEC: - db.executescript(trimmed) - db.commit() + if commit: + db.executescript(trimmed) + db.commit() + else: + db.execute(trimmed) return SessionFsSqliteQueryResult(columns=[], rows=[], rows_affected=0) if query_type == SessionFSSqliteQueryType.QUERY: @@ -177,7 +223,8 @@ async def sqlite_query( # run (INSERT/UPDATE/DELETE) cursor = db.execute(trimmed, params or {}) - db.commit() + if commit: + db.commit() return SessionFsSqliteQueryResult( columns=[], rows=[], diff --git a/python/e2e/test_session_todos_changed_e2e.py b/python/e2e/test_session_todos_changed_e2e.py new file mode 100644 index 000000000..8911ffb11 --- /dev/null +++ b/python/e2e/test_session_todos_changed_e2e.py @@ -0,0 +1,47 @@ +"""E2E coverage for session.todos_changed and SQL todo dependency reads.""" + +from __future__ import annotations + +import asyncio + +import pytest + +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext, get_next_event_of_type + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +PROMPT = ( + "Use the sql tool exactly once to execute all three of the following statements " + "together, in this exact order, in a single sql tool call (a single query string " + "containing all three statements):\n" + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n" + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n" + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n" + "Then stop. Do not insert any other rows or create any other tables." +) + + +class TestSessionTodosChanged: + async def test_fires_session_todos_changed_and_exposes_rows_and_dependencies( + self, ctx: E2ETestContext + ): + async with await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) as session: + todos_changed = asyncio.create_task( + get_next_event_of_type(session, "session.todos_changed", timeout=120.0) + ) + await session.send_and_wait(PROMPT, timeout=120.0) + await todos_changed + + result = await session.rpc.plan.read_sql_todos_with_dependencies() + ids = sorted(row.id for row in result.rows if row.id) + assert ids == ["alpha", "beta"] + + assert any( + dependency.todo_id == "beta" and dependency.depends_on == "alpha" + for dependency in result.dependencies + ) diff --git a/python/e2e/test_skills_e2e.py b/python/e2e/test_skills_e2e.py index c31632fda..e9aba98f2 100644 --- a/python/e2e/test_skills_e2e.py +++ b/python/e2e/test_skills_e2e.py @@ -7,8 +7,8 @@ import pytest -from copilot.generated.rpc import SkillSource from copilot.session import CustomAgentConfig, PermissionHandler +from copilot.session_events import SkillSource from .testharness import E2ETestContext diff --git a/python/e2e/test_streaming_fidelity_e2e.py b/python/e2e/test_streaming_fidelity_e2e.py index 79b34fc91..a644acb83 100644 --- a/python/e2e/test_streaming_fidelity_e2e.py +++ b/python/e2e/test_streaming_fidelity_e2e.py @@ -155,34 +155,44 @@ async def test_should_not_produce_deltas_after_session_resume_with_streaming_dis finally: await new_client.force_stop() - async def test_should_emit_streaming_deltas_with_reasoning_effort_configured( - self, ctx: E2ETestContext - ): + async def test_should_emit_streaming_deltas_with_reasoning_effort_configured(self): """Streaming + reasoning_effort produces delta events and session.start shows effort.""" - from copilot.generated.session_events import SessionStartData - - session = await ctx.client.create_session( - on_permission_request=PermissionHandler.approve_all, - streaming=True, - reasoning_effort="high", - ) - - events = [] - session.on(lambda event: events.append(event)) + from copilot.session_events import SessionStartData + isolated_ctx = E2ETestContext() + await isolated_ctx.setup() try: - await session.send_and_wait("What is 15 * 17?", timeout=60.0) - - delta_events = [e for e in events if e.type.value == "assistant.message_delta"] - assert len(delta_events) >= 1, "Expected delta events with streaming=True" - - assistant_events = [e for e in events if e.type.value == "assistant.message"] - assert len(assistant_events) >= 1, "Expected final assistant.message" + await isolated_ctx.configure_for_test( + "streaming_fidelity", + "should_emit_streaming_deltas_with_reasoning_effort_configured", + ) + session = await isolated_ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + model="gpt-5.4", + streaming=True, + reasoning_effort="high", + ) - # Check session.start event (from get_events) has reasoning_effort - all_msgs = await session.get_events() - start_event = next((e for e in all_msgs if isinstance(e.data, SessionStartData)), None) - assert start_event is not None, "Expected session.start event" - assert start_event.data.reasoning_effort == "high" + events = [] + session.on(lambda event: events.append(event)) + + try: + await session.send_and_wait("What is 15 * 17?", timeout=60.0) + + delta_events = [e for e in events if e.type.value == "assistant.message_delta"] + assert len(delta_events) >= 1, "Expected delta events with streaming=True" + + assistant_events = [e for e in events if e.type.value == "assistant.message"] + assert len(assistant_events) >= 1, "Expected final assistant.message" + + # Check session.start event (from get_events) has reasoning_effort + all_msgs = await session.get_events() + start_event = next( + (e for e in all_msgs if isinstance(e.data, SessionStartData)), None + ) + assert start_event is not None, "Expected session.start event" + assert start_event.data.reasoning_effort == "high" + finally: + await session.disconnect() finally: - await session.disconnect() + await isolated_ctx.teardown() diff --git a/python/e2e/test_subagent_hooks_e2e.py b/python/e2e/test_subagent_hooks_e2e.py index 1ca2a54c1..da70265a0 100644 --- a/python/e2e/test_subagent_hooks_e2e.py +++ b/python/e2e/test_subagent_hooks_e2e.py @@ -3,10 +3,14 @@ fire for tool calls made by sub-agents spawned via the task tool. """ +from __future__ import annotations + import os +import httpx import pytest +from copilot import CopilotRequestContext, CopilotRequestHandler from copilot.client import CopilotClient, RuntimeConnection from copilot.session import PermissionHandler @@ -16,12 +20,56 @@ pytestmark = pytest.mark.asyncio(loop_scope="module") +class _RecordingRequestHandler(CopilotRequestHandler): + def __init__(self) -> None: + self.records: list[dict[str, str | None]] = [] + + async def send_request( + self, request: httpx.Request, ctx: CopilotRequestContext + ) -> httpx.Response: + self.records.append( + { + "url": str(request.url), + "agent_id": ctx.agent_id, + "parent_agent_id": ctx.parent_agent_id, + "interaction_type": ctx.interaction_type, + } + ) + return await super().send_request(request, ctx) + + +def _is_inference_url(url: str) -> bool: + u = url.lower() + return ( + u.endswith("/chat/completions") + or u.endswith("/responses") + or u.endswith("/v1/messages") + or u.endswith("/messages") + ) + + +def _assert_subagent_request_metadata(records: list[dict[str, str | None]]) -> None: + inference = [r for r in records if _is_inference_url(r["url"] or "")] + assert len(inference) > 0, "request handler should observe inference requests" + + subagent_request = next((r for r in inference if r["parent_agent_id"]), None) + assert subagent_request is not None, ( + "sub-agent inference request should carry a parent_agent_id" + ) + assert subagent_request["agent_id"], "sub-agent inference request should carry an agent_id" + assert subagent_request["interaction_type"], ( + "sub-agent inference request should carry an interaction_type" + ) + assert subagent_request["parent_agent_id"] != subagent_request["agent_id"] + + class TestSubagentHooks: async def test_should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls( self, ctx: E2ETestContext ): """Test that preToolUse/postToolUse hooks fire for sub-agent tool calls""" hook_log = [] + request_handler = _RecordingRequestHandler() async def on_pre_tool_use(input_data, invocation): hook_log.append( @@ -54,6 +102,7 @@ async def on_post_tool_use(input_data, invocation): working_directory=ctx.work_dir, env=env, github_token=github_token, + request_handler=request_handler, ) session = await client.create_session( @@ -87,6 +136,7 @@ async def on_post_tool_use(input_data, invocation): assert view_pre[0]["sessionId"] != task_pre[0]["sessionId"], ( "Sub-agent tool hooks should have a different sessionId than parent tool hooks" ) + _assert_subagent_request_metadata(request_handler.records) await session.disconnect() await client.stop() diff --git a/python/e2e/test_suspend_e2e.py b/python/e2e/test_suspend_e2e.py index b0f74140c..d0a117fff 100644 --- a/python/e2e/test_suspend_e2e.py +++ b/python/e2e/test_suspend_e2e.py @@ -15,7 +15,7 @@ import pytest from copilot import CopilotClient, RuntimeConnection -from copilot.generated.rpc import PermissionDecisionUserNotAvailable +from copilot.rpc import PermissionDecisionUserNotAvailable from copilot.session import PermissionHandler from copilot.tools import Tool, ToolInvocation, ToolResult diff --git a/python/e2e/test_system_message_sections_e2e.py b/python/e2e/test_system_message_sections_e2e.py new file mode 100644 index 000000000..d6017dba6 --- /dev/null +++ b/python/e2e/test_system_message_sections_e2e.py @@ -0,0 +1,73 @@ +""" +Copyright (c) Microsoft Corporation. + +Tests for system message sections functionality +""" + +import pytest + +from copilot.session import PermissionHandler + +from .testharness import E2ETestContext + +pytestmark = pytest.mark.asyncio(loop_scope="module") + + +class TestSystemMessageSections: + async def test_should_use_replaced_identity_section_in_response(self, ctx: E2ETestContext): + """Test that replacing the identity section causes the assistant to adopt a new persona""" + session = await ctx.client.create_session( + system_message={ + "mode": "customize", + "sections": { + "identity": { + "action": "replace", + "content": ( + "You are a helpful gardening assistant called Botanica." + " You only answer questions about plants and gardening." + ), + }, + }, + }, + on_permission_request=PermissionHandler.approve_all, + ) + + response = await session.send_and_wait("Who are you?") + + assert response is not None, "Expected a response from the assistant" + content = response.data.content.lower() + assert "botanica" in content or "garden" in content or "plant" in content, ( + f"Expected response to reflect the replaced identity section," + f" but got: {response.data.content}" + ) + + await session.disconnect() + + async def test_should_use_replaced_preamble_section_in_response(self, ctx: E2ETestContext): + """Test that replacing only the preamble section changes the assistant persona""" + session = await ctx.client.create_session( + system_message={ + "mode": "customize", + "sections": { + "preamble": { + "action": "replace", + "content": ( + "You are a helpful gardening assistant called Botanica." + " You only answer questions about plants and gardening." + ), + }, + }, + }, + on_permission_request=PermissionHandler.approve_all, + ) + + response = await session.send_and_wait("Who are you?") + + assert response is not None, "Expected a response from the assistant" + content = response.data.content.lower() + assert "botanica" in content or "garden" in content or "plant" in content, ( + f"Expected response to reflect the replaced preamble section," + f" but got: {response.data.content}" + ) + + await session.disconnect() diff --git a/python/e2e/test_telemetry_e2e.py b/python/e2e/test_telemetry_e2e.py index f18a9fb88..14c03ada3 100644 --- a/python/e2e/test_telemetry_e2e.py +++ b/python/e2e/test_telemetry_e2e.py @@ -13,7 +13,6 @@ from __future__ import annotations -import asyncio import json import os import uuid @@ -45,22 +44,14 @@ def _is_root_span(entry: dict[str, Any]) -> bool: return parent in ("", "0000000000000000") -async def _read_telemetry_entries( - path: Path, complete: Any, *, timeout: float = 30.0 -) -> list[dict[str, Any]]: - deadline = asyncio.get_event_loop().time() + timeout - while asyncio.get_event_loop().time() < deadline: - if path.exists() and path.stat().st_size > 0: - entries: list[dict[str, Any]] = [] - for line in path.read_text(encoding="utf-8").splitlines(): - line = line.strip() - if not line: - continue - entries.append(json.loads(line)) - if entries and complete(entries): - return entries - await asyncio.sleep(0.1) - raise TimeoutError(f"Timed out waiting for telemetry records in '{path}'.") +def _read_telemetry_entries(path: Path) -> list[dict[str, Any]]: + entries: list[dict[str, Any]] = [] + for line in path.read_text(encoding="utf-8").splitlines(): + line = line.strip() + if not line: + continue + entries.append(json.loads(line)) + return entries class TestTelemetryExport: @@ -119,14 +110,7 @@ def echo(invocation: ToolInvocation) -> ToolResult: finally: await client.stop() - entries = await _read_telemetry_entries( - telemetry_path, - lambda items: any( - item.get("type") == "span" - and _string_attribute(item, "gen_ai.operation.name") == "invoke_agent" - for item in items - ), - ) + entries = _read_telemetry_entries(telemetry_path) spans = [item for item in entries if item.get("type") == "span"] assert spans @@ -186,6 +170,7 @@ async def test_default_values_are_unset(self): # constructor leaves every field unset (equivalent to C#'s null defaults). cfg: TelemetryConfig = TelemetryConfig() assert cfg.get("otlp_endpoint") is None + assert cfg.get("otlp_protocol") is None assert cfg.get("file_path") is None assert cfg.get("exporter_type") is None assert cfg.get("source_name") is None @@ -194,12 +179,14 @@ async def test_default_values_are_unset(self): async def test_can_set_all_properties(self): cfg: TelemetryConfig = TelemetryConfig( otlp_endpoint="http://localhost:4318", + otlp_protocol="http/protobuf", file_path="/tmp/traces.json", exporter_type="otlp-http", source_name="my-app", capture_content=True, ) assert cfg["otlp_endpoint"] == "http://localhost:4318" + assert cfg["otlp_protocol"] == "http/protobuf" assert cfg["file_path"] == "/tmp/traces.json" assert cfg["exporter_type"] == "otlp-http" assert cfg["source_name"] == "my-app" diff --git a/python/e2e/test_tools_e2e.py b/python/e2e/test_tools_e2e.py index 2f121b46d..1421dbaf4 100644 --- a/python/e2e/test_tools_e2e.py +++ b/python/e2e/test_tools_e2e.py @@ -5,8 +5,11 @@ import pytest from pydantic import BaseModel, Field -from copilot import define_tool -from copilot.generated.rpc import PermissionDecisionApproveOnce, PermissionDecisionReject +from copilot import ToolSet, define_tool +from copilot.rpc import ( + PermissionDecisionApproveOnce, + PermissionDecisionReject, +) from copilot.session import PermissionHandler, PermissionNoResult from copilot.tools import Tool, ToolInvocation, ToolResult @@ -45,6 +48,49 @@ def encrypt_string(params: EncryptParams, invocation: ToolInvocation) -> str: assistant_message = await get_final_assistant_message(session) assert "HELLO" in assistant_message.data.content + async def test_low_level_tool_definition(self, ctx: E2ETestContext): + class PhaseArgs(BaseModel): + phase: str = Field( + description="Current phase", + pattern="^(searching|analyzing|done)$", + ) + + class SearchArgs(BaseModel): + keyword: str + + current_phase = "" + + @define_tool("set_current_phase", description="Sets the current phase of the agent") + def set_current_phase(params: PhaseArgs, invocation: ToolInvocation) -> str: + nonlocal current_phase + current_phase = params.phase + return f"Phase set to {params.phase}" + + @define_tool("search_items", description="Search for items by keyword") + def search_items(params: SearchArgs, invocation: ToolInvocation) -> str: + args = invocation.arguments or {} + keyword = str(args.get("keyword", "")) + assert keyword == "copilot" + return "Found: item_alpha, item_beta" + + session = await ctx.client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=ToolSet().add_custom("*").add_builtin("web_fetch"), + tools=[set_current_phase, search_items], + ) + + prompt = ( + "First, set the current phase to 'analyzing'. Then search for items with " + "keyword 'copilot'. Report the phase and search results." + ) + await session.send(prompt) + assistant_message = await get_final_assistant_message(session) + content = assistant_message.data.content or "" + assert content != "" + assert "analyzing" in content.lower() + assert "item_alpha" in content.lower() or "item_beta" in content.lower() + assert current_phase == "analyzing" + async def test_handles_tool_calling_errors(self, ctx: E2ETestContext): @define_tool("get_user_location", description="Gets the user's location") def get_user_location() -> str: diff --git a/python/e2e/test_ui_elicitation_multi_client_e2e.py b/python/e2e/test_ui_elicitation_multi_client_e2e.py index 398b83ee8..05589d0d2 100644 --- a/python/e2e/test_ui_elicitation_multi_client_e2e.py +++ b/python/e2e/test_ui_elicitation_multi_client_e2e.py @@ -17,12 +17,12 @@ import pytest_asyncio from copilot import CopilotClient, RuntimeConnection -from copilot.generated.session_events import CapabilitiesChangedData from copilot.session import ( ElicitationContext, ElicitationResult, PermissionHandler, ) +from copilot.session_events import CapabilitiesChangedData from .testharness.context import SNAPSHOTS_DIR, get_cli_path_for_tests from .testharness.proxy import CapiProxy @@ -193,8 +193,8 @@ async def test_client_receives_commands_changed_when_another_client_joins_with_c self, mctx: ElicitationMultiClientContext ): """Client 1 receives `commands.changed` when client 2 joins with commands.""" - from copilot.generated.session_events import CommandsChangedData from copilot.session import CommandDefinition + from copilot.session_events import CommandsChangedData session1 = await mctx.client1.create_session( on_permission_request=PermissionHandler.approve_all, diff --git a/python/e2e/testharness/__init__.py b/python/e2e/testharness/__init__.py index 28558d687..75ce76d9c 100644 --- a/python/e2e/testharness/__init__.py +++ b/python/e2e/testharness/__init__.py @@ -1,7 +1,7 @@ """Test harness for E2E tests.""" -from .context import CLI_PATH, DEFAULT_GITHUB_TOKEN, E2ETestContext -from .helper import get_final_assistant_message, get_next_event_of_type +from .context import CLI_PATH, DEFAULT_GITHUB_TOKEN, E2ETestContext, is_inprocess_transport +from .helper import get_final_assistant_message, get_next_event_of_type, wait_for_condition from .proxy import CapiProxy __all__ = [ @@ -11,4 +11,6 @@ "CapiProxy", "get_final_assistant_message", "get_next_event_of_type", + "wait_for_condition", + "is_inprocess_transport", ] diff --git a/python/e2e/testharness/context.py b/python/e2e/testharness/context.py index a5bfee28d..2171e25f2 100644 --- a/python/e2e/testharness/context.py +++ b/python/e2e/testharness/context.py @@ -11,30 +11,89 @@ import shutil import tempfile import time +from collections.abc import Sequence from pathlib import Path from typing import Any from copilot import CopilotClient, RuntimeConnection +from copilot._cli_version import get_npm_platform from .proxy import CapiProxy +def _cli_platform_package_names(npm_platform: str | None = None) -> list[str]: + """Return candidate ``@github/copilot-*`` directory names, best match first. + + Mirrors ``getCliPlatformPackageNames()`` in ``nodejs/src/client.ts``: as of CLI + 1.0.64-1 the runnable ``index.js`` ships in a platform package such as + ``copilot-darwin-arm64``. On Linux both libc variants are listed (the detected + one first) because npm installs exactly one of them and musl probing can come up + empty in minimal containers. + """ + primary = npm_platform or get_npm_platform() + names = [f"copilot-{primary}"] + if primary.startswith("linux"): + arch = primary.rsplit("-", 1)[-1] + for variant in (f"linux-{arch}", f"linuxmusl-{arch}"): + name = f"copilot-{variant}" + if name not in names: + names.append(name) + return names + + +def _find_cli_in_node_modules(github_modules: Path, package_names: Sequence[str]) -> str | None: + """Return the resolved ``index.js`` of the first installed candidate package. + + Only exact package names are probed, so unrelated ``copilot-*`` directories + (e.g. ``copilot-language-server``) can never be mistaken for the CLI. + """ + for name in package_names: + candidate = github_modules / name / "index.js" + if candidate.exists(): + return str(candidate.resolve()) + return None + + +def _installed_cli_package_names(github_modules: Path) -> list[str]: + """Return the ``copilot-*`` directory names present, for error messages only. + + Selection never globs — that was the #2103 bug. This exists so a failure can + say what *is* installed, which is the difference between a dead-end "run npm + install" and a message that diagnoses itself on a mixed-architecture host. + """ + if not github_modules.is_dir(): + return [] + return sorted(path.name for path in github_modules.glob("copilot-*") if path.is_dir()) + + def get_cli_path_for_tests() -> str: """Get CLI path for E2E tests. - Uses COPILOT_CLI_PATH env var if set, otherwise node_modules CLI. + Uses COPILOT_CLI_PATH env var if set, otherwise the platform-specific CLI + package in the sibling nodejs directory's node_modules. """ env_path = os.environ.get("COPILOT_CLI_PATH") if env_path and Path(env_path).exists(): return str(Path(env_path).resolve()) - # Look for CLI in sibling nodejs directory's node_modules + # Look for CLI in sibling nodejs directory's node_modules. As of CLI 1.0.64-1 + # the @github/copilot package is a thin loader; the runnable index.js ships in + # the installed platform package (e.g. @github/copilot-linux-x64), so pick the + # one built for this host rather than whichever sorts first (#2103). base_path = Path(__file__).parents[3] - full_path = base_path / "nodejs" / "node_modules" / "@github" / "copilot" / "index.js" - if full_path.exists(): - return str(full_path.resolve()) + github_modules = base_path / "nodejs" / "node_modules" / "@github" + package_names = _cli_platform_package_names() + found = _find_cli_in_node_modules(github_modules, package_names) + if found is not None: + return found - raise RuntimeError("CLI not found for tests. Run 'npm install' in the nodejs directory.") + installed = _installed_cli_package_names(github_modules) + raise RuntimeError( + f"CLI not found for tests under {github_modules} " + f"(tried: {', '.join(package_names)}; " + f"present: {', '.join(installed) or 'none'}). " + "Run 'npm install' in the nodejs directory, or set COPILOT_CLI_PATH." + ) CLI_PATH = get_cli_path_for_tests() @@ -42,6 +101,15 @@ def get_cli_path_for_tests() -> str: DEFAULT_GITHUB_TOKEN = "fake-token-for-e2e-tests" +def is_inprocess_transport() -> bool: + """Return True when the E2E suite should run over the in-process (FFI) transport. + + Selected by the ``inprocess`` CI matrix cell via + ``COPILOT_SDK_DEFAULT_CONNECTION=inprocess``. Mirrors the Node/.NET harnesses. + """ + return (os.environ.get("COPILOT_SDK_DEFAULT_CONNECTION") or "").lower() == "inprocess" + + class E2ETestContext: """Holds shared resources for E2E tests.""" @@ -52,6 +120,10 @@ def __init__(self): self.proxy_url: str = "" self._proxy: CapiProxy | None = None self._client: CopilotClient | None = None + self._inprocess: bool = is_inprocess_transport() + self._client_inprocess: bool = False + self._restore_env: list[tuple[str, str | None]] = [] + self._restore_cwd: str | None = None async def setup(self, cli_args: list[str] | None = None): """Set up the test context with a shared client. @@ -79,16 +151,87 @@ async def setup(self, cli_args: list[str] | None = None): }, ) - # Create the shared client (like Node.js/Go do) - self._client = CopilotClient( - connection=RuntimeConnection.for_stdio( - path=self.cli_path, - args=tuple(cli_args or []), - ), - working_directory=self.work_dir, - env=self.get_env(), - github_token=DEFAULT_GITHUB_TOKEN, + # Create the shared client (like Node.js/Go do). The in-process (FFI) + # transport loads the runtime into this test host process, so it cannot + # honor a per-client working_directory or env block: the worker inherits + # this process's ambient cwd and environment. We therefore mirror the + # per-test redirects, isolated home, and credentials onto the real process + # (os.environ writes reach native getenv on CPython) and chdir into the + # work dir, then create the client without working_directory/env. This + # matches the Node/.NET in-process harnesses. + self._client_inprocess = self._inprocess and not cli_args + if self._client_inprocess: + self._apply_inprocess_environment() + self._client = CopilotClient( + connection=RuntimeConnection.for_inprocess(), + github_token=DEFAULT_GITHUB_TOKEN, + ) + else: + self._client = CopilotClient( + connection=RuntimeConnection.for_stdio( + path=self.cli_path, + args=tuple(cli_args or []), + ), + working_directory=self.work_dir, + env=self.get_env(), + github_token=DEFAULT_GITHUB_TOKEN, + ) + + def _apply_inprocess_environment(self) -> None: + """Mirror the isolated test environment onto the real process for in-process hosting. + + The in-process worker inherits this process's environment and cwd at + spawn, so the per-test redirects must live on ``os.environ`` and the + process cwd. Auth flows via GH_TOKEN/GITHUB_TOKEN (the FFI argv omits the + stdio ``--auth-token-env`` wiring) and HMAC is disabled so host-side auth + resolution matches the replay snapshots. Restored in ``teardown``. + """ + inprocess_env = dict(self.get_env()) + inprocess_env.update( + { + "GH_TOKEN": DEFAULT_GITHUB_TOKEN, + "GITHUB_TOKEN": DEFAULT_GITHUB_TOKEN, + "COPILOT_CLI_PATH": self.cli_path, + "COPILOT_HMAC_KEY": "", + "CAPI_HMAC_KEY": "", + } ) + for key, value in inprocess_env.items(): + self._restore_env.append((key, os.environ.get(key))) + os.environ[key] = value + + self._restore_cwd = os.getcwd() + os.chdir(self.work_dir) + + def add_runtime_env(self, key: str, value: str) -> None: + """Set an env var seen by the runtime, honoring the active transport. + + Child-process transports read env from the client's env block, but the + in-process worker inherits *this* process's environment, so the var must + live on ``os.environ`` (and be restored in teardown). Must be called + before the runtime starts (i.e., before the first ``create_session``). + """ + if self._client_inprocess: + self._restore_env.append((key, os.environ.get(key))) + os.environ[key] = value + else: + options = self.client._options + if options.env is None: + options.env = {} + options.env[key] = value + + def _restore_inprocess_environment(self) -> None: + """Undo the in-process environment mirror and cwd change from setup.""" + for key, previous in reversed(self._restore_env): + if previous is None: + os.environ.pop(key, None) + else: + os.environ[key] = previous + self._restore_env = [] + if self._restore_cwd is not None: + with contextlib.suppress(OSError): + os.chdir(self._restore_cwd) + self._restore_cwd = None async def teardown(self, test_failed: bool = False): """Clean up the test context. @@ -103,6 +246,9 @@ async def teardown(self, test_failed: bool = False): pass # stop() completes all cleanup before raising; safe to ignore in teardown self._client = None + if self._client_inprocess: + self._restore_inprocess_environment() + if self._proxy: await self._proxy.stop(skip_writing_cache=test_failed) self._proxy = None @@ -151,6 +297,12 @@ def get_env(self) -> dict: env.update( { "COPILOT_API_URL": self.proxy_url, + # Route GitHub API calls (e.g. the MCP registry policy check) to + # the replay proxy so MCP enablement stays hermetic. Without this + # the CLI reaches the real api.github.com, which is slow/unreachable + # on macOS CI runners and makes MCP servers time out before + # reaching connected. + "COPILOT_DEBUG_GITHUB_API_URL": self.proxy_url, "COPILOT_HOME": self.home_dir, "COPILOT_SDK_AUTH_TOKEN": DEFAULT_GITHUB_TOKEN, "GH_CONFIG_DIR": self.home_dir, @@ -158,6 +310,8 @@ def get_env(self) -> dict: "XDG_CONFIG_HOME": self.home_dir, "XDG_STATE_HOME": self.home_dir, "GITHUB_TOKEN": DEFAULT_GITHUB_TOKEN, + "COPILOT_MCP_APPS": "true", + "MCP_APPS": "true", } ) return env diff --git a/python/e2e/testharness/helper.py b/python/e2e/testharness/helper.py index d64ee00b8..7933dd9ec 100644 --- a/python/e2e/testharness/helper.py +++ b/python/e2e/testharness/helper.py @@ -3,10 +3,13 @@ """ import asyncio +import inspect import os +import time +from collections.abc import Awaitable, Callable from copilot import CopilotSession -from copilot.generated.session_events import ( +from copilot.session_events import ( AssistantMessageData, SessionErrorData, SessionIdleData, @@ -139,6 +142,31 @@ def read_file(work_dir: str, filename: str) -> str: return f.read() +async def wait_for_condition( + condition: Callable[[], bool | Awaitable[bool]], + *, + timeout: float = 120.0, + poll_interval: float = 0.1, + timeout_message: str = "Timed out waiting for condition.", +) -> None: + """Poll until condition returns true, with timeout only as a failsafe.""" + deadline = time.monotonic() + timeout + while time.monotonic() < deadline: + result = condition() + if inspect.isawaitable(result): + result = await result + if result: + return + await asyncio.sleep(poll_interval) + + result = condition() + if inspect.isawaitable(result): + result = await result + if result: + return + raise TimeoutError(timeout_message) + + async def get_next_event_of_type(session: CopilotSession, event_type: str, timeout: float = 30.0): """ Wait for and return the next event of a specific type from a session. diff --git a/python/pyproject.toml b/python/pyproject.toml index 897c5466d..e96c587a6 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -4,12 +4,14 @@ build-backend = "setuptools.build_meta" [project] name = "github-copilot-sdk" -version = "0.1.0" +# Placeholder; the real version is injected at publish time (see +# .github/workflows/publish.yml). Kept as a dev sentinel so source/editable +# installs never report a stale real version, matching the .NET and Rust SDKs. +version = "0.0.0.dev0" description = "Python SDK for GitHub Copilot CLI" readme = "README.md" requires-python = ">=3.11" license = "MIT" -# license-files is set by scripts/build-wheels.mjs for bundled CLI wheels authors = [ {name = "GitHub", email = "opensource@github.com"} ] @@ -25,6 +27,7 @@ classifiers = [ dependencies = [ "python-dateutil>=2.9.0.post0", "pydantic>=2.0", + "httpx>=0.24.0", ] [project.urls] @@ -32,21 +35,22 @@ Homepage = "https://github.com/github/copilot-sdk" Repository = "https://github.com/github/copilot-sdk" [project.optional-dependencies] +telemetry = [ + "opentelemetry-api>=1.0.0", +] + +[dependency-groups] dev = [ - "ruff>=0.1.0", + "ruff==0.16.0", "ty>=0.0.2,<0.0.25", "pytest>=7.0.0", "pytest-asyncio>=0.21.0", "pytest-timeout>=2.0.0", - "httpx>=0.24.0", + "pytest-xdist>=3.6.0", + "websockets>=12.0", "opentelemetry-sdk>=1.0.0", ] -telemetry = [ - "opentelemetry-api>=1.0.0", -] -# Use find with a glob so that the copilot.bin subpackage (created dynamically -# by scripts/build-wheels.mjs during publishing) is included in platform wheels. [tool.setuptools.packages.find] where = ["."] include = ["copilot*"] @@ -89,3 +93,7 @@ python_files = "test_*.py" python_classes = "Test*" python_functions = "test_*" asyncio_mode = "auto" +# Bound every test so a deadlock fails fast with a stack dump instead of occupying the +# whole CI leg until GitHub's 6-hour job limit. The full suite runs in ~10 minutes, so no +# individual test legitimately approaches this. +timeout = 300 diff --git a/python/samples/chat.py b/python/samples/chat.py index 2e48c7ed5..18b9ccd9f 100644 --- a/python/samples/chat.py +++ b/python/samples/chat.py @@ -1,12 +1,12 @@ import asyncio from copilot import CopilotClient -from copilot.generated.session_events import ( +from copilot.session import PermissionHandler +from copilot.session_events import ( AssistantMessageData, AssistantReasoningData, ToolExecutionStartData, ) -from copilot.session import PermissionHandler BLUE = "\033[34m" RESET = "\033[0m" diff --git a/python/samples/manual_tool_resume.py b/python/samples/manual_tool_resume.py index 995f66406..dd8c10bc0 100644 --- a/python/samples/manual_tool_resume.py +++ b/python/samples/manual_tool_resume.py @@ -2,8 +2,11 @@ from typing import TypeVar from copilot import CopilotClient, Tool -from copilot.generated.rpc import HandlePendingToolCallRequest, PermissionDecisionRequest -from copilot.generated.session_events import ( +from copilot.rpc import ( + HandlePendingToolCallRequest, + PermissionDecisionRequest, +) +from copilot.session_events import ( AssistantMessageData, ExternalToolRequestedData, PermissionRequestedData, diff --git a/python/scripts/build-wheels.mjs b/python/scripts/build-wheels.mjs deleted file mode 100644 index c9d49b414..000000000 --- a/python/scripts/build-wheels.mjs +++ /dev/null @@ -1,373 +0,0 @@ -#!/usr/bin/env node -/** - * Build platform-specific Python wheels with bundled Copilot CLI binaries. - * - * Downloads the Copilot CLI binary for each platform from the npm registry - * and builds a wheel that includes it. - * - * Usage: - * node scripts/build-wheels.mjs [--platform PLATFORM] [--output-dir DIR] - * - * --platform: Build for specific platform only (linux-x64, linux-arm64, darwin-x64, - * darwin-arm64, win32-x64, win32-arm64). If not specified, builds all. - * --output-dir: Directory for output wheels (default: dist/) - */ - -import { execSync } from "node:child_process"; -import { - createWriteStream, - existsSync, - mkdirSync, - readFileSync, - writeFileSync, - chmodSync, - rmSync, - cpSync, - readdirSync, - statSync, -} from "node:fs"; -import { dirname, join } from "node:path"; -import { pipeline } from "node:stream/promises"; -import { fileURLToPath } from "node:url"; - -const __filename = fileURLToPath(import.meta.url); -const __dirname = dirname(__filename); -const pythonDir = dirname(__dirname); -const repoRoot = dirname(pythonDir); - -// Platform mappings: npm package suffix -> [wheel platform tag, binary name] -// Based on Node 24.11 binaries being included in the wheels -const PLATFORMS = { - "linux-x64": ["manylinux_2_28_x86_64", "copilot"], - "linux-arm64": ["manylinux_2_28_aarch64", "copilot"], - "darwin-x64": ["macosx_10_9_x86_64", "copilot"], - "darwin-arm64": ["macosx_11_0_arm64", "copilot"], - "win32-x64": ["win_amd64", "copilot.exe"], - "win32-arm64": ["win_arm64", "copilot.exe"], -}; - -function getCliVersion() { - const packageLockPath = join(repoRoot, "nodejs", "package-lock.json"); - if (!existsSync(packageLockPath)) { - throw new Error( - `package-lock.json not found at ${packageLockPath}. Run 'npm install' in nodejs/ first.` - ); - } - - const packageLock = JSON.parse(readFileSync(packageLockPath, "utf-8")); - const version = packageLock.packages?.["node_modules/@github/copilot"]?.version; - - if (!version) { - throw new Error("Could not find @github/copilot version in package-lock.json"); - } - - return version; -} - -function getPkgVersion() { - const pyprojectPath = join(pythonDir, "pyproject.toml"); - const content = readFileSync(pyprojectPath, "utf-8"); - const match = content.match(/version\s*=\s*"([^"]+)"/); - if (!match) { - throw new Error("Could not find version in pyproject.toml"); - } - return match[1]; -} - -async function downloadCliBinary(platform, cliVersion, cacheDir) { - const [, binaryName] = PLATFORMS[platform]; - const cachedBinary = join(cacheDir, binaryName); - - // Check cache - if (existsSync(cachedBinary)) { - console.log(` Using cached ${binaryName}`); - return cachedBinary; - } - - const tarballUrl = `https://registry.npmjs.org/@github/copilot-${platform}/-/copilot-${platform}-${cliVersion}.tgz`; - console.log(` Downloading from ${tarballUrl}...`); - - // Download tarball - const response = await fetch(tarballUrl); - if (!response.ok) { - throw new Error(`Failed to download: ${response.status} ${response.statusText}`); - } - - // Extract to cache dir - mkdirSync(cacheDir, { recursive: true }); - - const tarballPath = join(cacheDir, `copilot-${platform}-${cliVersion}.tgz`); - const fileStream = createWriteStream(tarballPath); - - await pipeline(response.body, fileStream); - - // Extract binary from tarball using system tar - // On Windows, use the system32 tar to avoid Git Bash tar issues - const tarCmd = process.platform === "win32" - ? `"${process.env.SystemRoot}\\System32\\tar.exe"` - : "tar"; - - try { - execSync(`${tarCmd} -xzf "${tarballPath}" -C "${cacheDir}" --strip-components=1 "package/${binaryName}"`, { - stdio: "inherit", - }); - } catch (e) { - // Clean up on failure - if (existsSync(tarballPath)) { - rmSync(tarballPath); - } - throw new Error(`Failed to extract binary: ${e.message}`); - } - - // Clean up tarball - rmSync(tarballPath); - - // Verify binary exists - if (!existsSync(cachedBinary)) { - throw new Error(`Binary not found after extraction: ${cachedBinary}`); - } - - // Make executable on Unix - if (!binaryName.endsWith(".exe")) { - chmodSync(cachedBinary, 0o755); - } - - const size = statSync(cachedBinary).size / 1024 / 1024; - console.log(` Downloaded ${binaryName} (${size.toFixed(1)} MB)`); - - return cachedBinary; -} - -function getCliLicensePath() { - // Use license from node_modules (requires npm ci in nodejs/ first) - const licensePath = join(repoRoot, "nodejs", "node_modules", "@github", "copilot", "LICENSE.md"); - if (!existsSync(licensePath)) { - throw new Error( - `CLI LICENSE.md not found at ${licensePath}. Run 'npm ci' in nodejs/ first.` - ); - } - return licensePath; -} - -async function buildWheel(platform, pkgVersion, cliVersion, outputDir, licensePath) { - const [wheelTag, binaryName] = PLATFORMS[platform]; - console.log(`\nBuilding wheel for ${platform}...`); - - // Cache directory includes version - const cacheDir = join(pythonDir, ".cli-cache", cliVersion, platform); - - // Download/get cached binary - const binaryPath = await downloadCliBinary(platform, cliVersion, cacheDir); - - // Create temp build directory - const buildDir = join(pythonDir, ".build-temp", platform); - if (existsSync(buildDir)) { - rmSync(buildDir, { recursive: true }); - } - mkdirSync(buildDir, { recursive: true }); - - // Copy package source - const pkgDir = join(buildDir, "copilot"); - cpSync(join(pythonDir, "copilot"), pkgDir, { recursive: true }); - - // Create bin directory and copy binary - const binDir = join(pkgDir, "bin"); - mkdirSync(binDir, { recursive: true }); - cpSync(binaryPath, join(binDir, binaryName)); - - // Create VERSION file - writeFileSync(join(binDir, "VERSION"), cliVersion); - - // Create __init__.py - writeFileSync(join(binDir, "__init__.py"), '"""Bundled Copilot CLI binary."""\n'); - - // Copy and modify pyproject.toml for bundled CLI wheel - let pyprojectContent = readFileSync(join(pythonDir, "pyproject.toml"), "utf-8"); - - // Update SPDX expression and add license-files for both SDK and bundled CLI licenses - pyprojectContent = pyprojectContent.replace( - 'license = "MIT"', - 'license = "MIT AND LicenseRef-Copilot-CLI"\nlicense-files = ["LICENSE", "CLI-LICENSE.md"]' - ); - - // Add package-data configuration - const packageDataConfig = ` -[tool.setuptools.package-data] -"copilot.bin" = ["*"] -`; - pyprojectContent = pyprojectContent.replace("\n[tool.ruff]", `${packageDataConfig}\n[tool.ruff]`); - writeFileSync(join(buildDir, "pyproject.toml"), pyprojectContent); - - // Copy README - if (existsSync(join(pythonDir, "README.md"))) { - cpSync(join(pythonDir, "README.md"), join(buildDir, "README.md")); - } - - // Copy SDK LICENSE - cpSync(join(repoRoot, "LICENSE"), join(buildDir, "LICENSE")); - - // Copy CLI LICENSE - cpSync(licensePath, join(buildDir, "CLI-LICENSE.md")); - - // Build wheel using uv (faster and doesn't require build package to be installed) - const distDir = join(buildDir, "dist"); - execSync("uv build --wheel", { - cwd: buildDir, - stdio: "inherit", - }); - - // Find built wheel - const wheels = readdirSync(distDir).filter((f) => f.endsWith(".whl")); - if (wheels.length === 0) { - throw new Error("No wheel found after build"); - } - - const srcWheel = join(distDir, wheels[0]); - const newName = wheels[0].replace("-py3-none-any.whl", `-py3-none-${wheelTag}.whl`); - const destWheel = join(outputDir, newName); - - // Repack wheel with correct platform tag - await repackWheelWithPlatform(srcWheel, destWheel, wheelTag); - - // Clean up build dir - rmSync(buildDir, { recursive: true }); - - const size = statSync(destWheel).size / 1024 / 1024; - console.log(` Built ${newName} (${size.toFixed(1)} MB)`); - - return destWheel; -} - -async function repackWheelWithPlatform(srcWheel, destWheel, platformTag) { - // Write Python script to temp file to avoid shell escaping issues - const script = ` -import sys -import zipfile -import tempfile -from pathlib import Path - -src_wheel = Path(sys.argv[1]) -dest_wheel = Path(sys.argv[2]) -platform_tag = sys.argv[3] - -with tempfile.TemporaryDirectory() as tmpdir: - tmpdir = Path(tmpdir) - - # Extract wheel - with zipfile.ZipFile(src_wheel, 'r') as zf: - zf.extractall(tmpdir) - - # Restore executable bit on the CLI binary (setuptools strips it) - for bin_path in (tmpdir / 'copilot' / 'bin').iterdir(): - if bin_path.name in ('copilot', 'copilot.exe'): - bin_path.chmod(0o755) - - # Find and update WHEEL file - wheel_info_dirs = list(tmpdir.glob('*.dist-info')) - if not wheel_info_dirs: - raise RuntimeError('No .dist-info directory found in wheel') - - wheel_info_dir = wheel_info_dirs[0] - wheel_file = wheel_info_dir / 'WHEEL' - - with open(wheel_file) as f: - wheel_content = f.read() - - wheel_content = wheel_content.replace('Tag: py3-none-any', f'Tag: py3-none-{platform_tag}') - - with open(wheel_file, 'w') as f: - f.write(wheel_content) - - # Regenerate RECORD file - record_file = wheel_info_dir / 'RECORD' - records = [] - for path in tmpdir.rglob('*'): - if path.is_file() and path.name != 'RECORD': - rel_path = path.relative_to(tmpdir) - records.append(f'{rel_path},,') - records.append(f'{wheel_info_dir.name}/RECORD,,') - - with open(record_file, 'w') as f: - f.write('\\n'.join(records)) - - # Create new wheel - dest_wheel.parent.mkdir(parents=True, exist_ok=True) - if dest_wheel.exists(): - dest_wheel.unlink() - - with zipfile.ZipFile(dest_wheel, 'w', zipfile.ZIP_DEFLATED) as zf: - for path in tmpdir.rglob('*'): - if path.is_file(): - zf.write(path, path.relative_to(tmpdir)) -`; - - // Write script to temp file - const scriptPath = join(pythonDir, ".build-temp", "repack_wheel.py"); - mkdirSync(dirname(scriptPath), { recursive: true }); - writeFileSync(scriptPath, script); - - try { - execSync(`python "${scriptPath}" "${srcWheel}" "${destWheel}" "${platformTag}"`, { - stdio: "inherit", - }); - } finally { - // Clean up script - rmSync(scriptPath); - } -} - -async function main() { - const args = process.argv.slice(2); - let platform = null; - let outputDir = join(pythonDir, "dist"); - - // Parse args - for (let i = 0; i < args.length; i++) { - if (args[i] === "--platform" && args[i + 1]) { - platform = args[++i]; - if (!PLATFORMS[platform]) { - console.error(`Invalid platform: ${platform}`); - console.error(`Valid platforms: ${Object.keys(PLATFORMS).join(", ")}`); - process.exit(1); - } - } else if (args[i] === "--output-dir" && args[i + 1]) { - outputDir = args[++i]; - } - } - - const cliVersion = getCliVersion(); - const pkgVersion = getPkgVersion(); - - console.log(`CLI version: ${cliVersion}`); - console.log(`Package version: ${pkgVersion}`); - - mkdirSync(outputDir, { recursive: true }); - - // Get CLI license from node_modules - const licensePath = getCliLicensePath(); - - const platforms = platform ? [platform] : Object.keys(PLATFORMS); - const wheels = []; - - for (const p of platforms) { - try { - const wheel = await buildWheel(p, pkgVersion, cliVersion, outputDir, licensePath); - wheels.push(wheel); - } catch (e) { - console.error(`Error building wheel for ${p}:`, e.message); - if (platform) { - process.exit(1); - } - } - } - - console.log(`\nBuilt ${wheels.length} wheel(s):`); - for (const wheel of wheels) { - console.log(` ${wheel}`); - } -} - -main().catch((e) => { - console.error(e); - process.exit(1); -}); diff --git a/python/scripts/inject-cli-version.mjs b/python/scripts/inject-cli-version.mjs new file mode 100644 index 000000000..359e7f680 --- /dev/null +++ b/python/scripts/inject-cli-version.mjs @@ -0,0 +1,56 @@ +#!/usr/bin/env node +/** + * inject-cli-version.mjs + * + * Reads the pinned @github/copilot version from nodejs/package-lock.json and + * writes it into python/copilot/_cli_version.py, replacing the `CLI_VERSION = None` + * sentinel with the concrete version string. + * + * Run from the repository root: + * node python/scripts/inject-cli-version.mjs + */ + +import { readFileSync, writeFileSync } from "fs"; +import { join, dirname } from "path"; +import { fileURLToPath } from "url"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); +const repoRoot = join(__dirname, "..", ".."); + +// Read version from nodejs/package-lock.json +const lockPath = join(repoRoot, "nodejs", "package-lock.json"); +const lock = JSON.parse(readFileSync(lockPath, "utf-8")); + +// The version is in packages["node_modules/@github/copilot"].version +const copilotPkg = lock.packages?.["node_modules/@github/copilot"]; +if (!copilotPkg?.version) { + console.error( + "Error: Could not find @github/copilot version in nodejs/package-lock.json" + ); + process.exit(1); +} +const version = copilotPkg.version; +console.log(`Injecting CLI_VERSION = "${version}"`); + +// Patch _cli_version.py +const versionFile = join(__dirname, "..", "copilot", "_cli_version.py"); +let content = readFileSync(versionFile, "utf-8"); + +const sentinel = 'CLI_VERSION: str | None = None'; +const replacement = `CLI_VERSION: str | None = "${version}"`; + +if (!content.includes(sentinel)) { + // Check if already injected + if (content.includes(`CLI_VERSION: str | None = "`)) { + console.log("CLI_VERSION already injected, updating..."); + content = content.replace(/CLI_VERSION: str \| None = ".*?"/, `CLI_VERSION: str | None = "${version}"`); + } else { + console.error(`Error: Could not find sentinel '${sentinel}' in _cli_version.py`); + process.exit(1); + } +} else { + content = content.replace(sentinel, replacement); +} + +writeFileSync(versionFile, content); +console.log(`Done. _cli_version.py now has CLI_VERSION = "${version}"`); diff --git a/python/test_canvas.py b/python/test_canvas.py index 9e12a1850..684cef6b7 100644 --- a/python/test_canvas.py +++ b/python/test_canvas.py @@ -14,23 +14,23 @@ CanvasDeclaration, CanvasError, CanvasHandler, + CanvasProviderIdentity, ExtensionInfo, OpenCanvasInstance, ) -from copilot.generated.rpc import ( - CanvasInstanceAvailability, +from copilot.rpc import ( CanvasProviderCloseRequest, CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, CanvasProviderOpenResult, ) -from copilot.generated.session_events import ( - CanvasOpenedAvailability, +from copilot.session import CopilotSession +from copilot.session_events import ( + SessionCanvasClosedData, SessionCanvasOpenedData, SessionEvent, SessionEventType, ) -from copilot.session import CopilotSession def test_canvas_declaration_serializes_camelcase_and_drops_optional(): @@ -68,6 +68,16 @@ def test_extension_info_serializes(): assert info.to_dict() == {"source": "github-app", "name": "my-ext"} +def test_canvas_provider_identity_serializes(): + provider = CanvasProviderIdentity(id="app:builtin:window-1", name="Built-in") + assert provider.to_dict() == {"id": "app:builtin:window-1", "name": "Built-in"} + + +def test_canvas_provider_identity_drops_optional_name(): + provider = CanvasProviderIdentity(id="app:builtin:window-1") + assert provider.to_dict() == {"id": "app:builtin:window-1"} + + def test_canvas_open_response_drops_none_fields(): assert CanvasProviderOpenResult().to_dict() == {} assert CanvasProviderOpenResult(url="https://x", status="ok").to_dict() == { @@ -204,11 +214,9 @@ def test_register_canvas_handler_can_clear_generated_handler(): def test_set_open_canvases_round_trip(): inst = OpenCanvasInstance( - availability=CanvasInstanceAvailability.READY, canvas_id="c", extension_id="e", instance_id="i", - reopen=False, ) session = CopilotSession("sess-1", client=None) session._set_open_canvases([inst]) @@ -221,11 +229,9 @@ def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFi session._dispatch_event( SessionEvent( data=SessionCanvasOpenedData( - availability=CanvasOpenedAvailability.READY, canvas_id="", extension_id="project:counter", instance_id="missing-canvas-id", - reopen=False, ), id=uuid4(), timestamp=datetime.now(UTC), @@ -235,12 +241,10 @@ def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFi session._dispatch_event( SessionEvent( data=SessionCanvasOpenedData( - availability=CanvasOpenedAvailability.READY, canvas_id="counter", extension_id="project:counter", extension_name="Counter Provider", instance_id="counter-1", - reopen=False, input={"seed": 1}, status="ready", title="Counter", @@ -254,11 +258,9 @@ def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFi session._dispatch_event( SessionEvent( data=SessionCanvasOpenedData( - availability=CanvasOpenedAvailability.STALE, canvas_id="logs", extension_id="project:logs", instance_id="logs-1", - reopen=False, title="Logs", ), id=uuid4(), @@ -276,12 +278,10 @@ def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFi session._dispatch_event( SessionEvent( data=SessionCanvasOpenedData( - availability=CanvasOpenedAvailability.STALE, canvas_id="counter", extension_id="project:counter", extension_name="Counter Provider", instance_id="counter-1", - reopen=True, input={"seed": 2}, status="reconnected", title="Counter Updated", @@ -300,6 +300,72 @@ def test_session_canvas_opened_updates_open_canvases(caplog: pytest.LogCaptureFi assert open_canvases[0].status == "reconnected" assert open_canvases[0].url == "https://example.test/counter-updated" assert open_canvases[0].input == {"seed": 2} - assert open_canvases[0].reopen is True - assert open_canvases[0].availability == CanvasInstanceAvailability.STALE assert open_canvases[1].instance_id == "logs-1" + + +def test_session_canvas_closed_removes_open_canvases(caplog: pytest.LogCaptureFixture): + session = CopilotSession("sess-1", client=None) + + for canvas_id, instance_id in (("counter", "counter-1"), ("logs", "logs-1")): + session._dispatch_event( + SessionEvent( + data=SessionCanvasOpenedData( + canvas_id=canvas_id, + extension_id=f"project:{canvas_id}", + instance_id=instance_id, + ), + id=uuid4(), + timestamp=datetime.now(UTC), + type=SessionEventType.SESSION_CANVAS_OPENED, + ) + ) + assert [canvas.instance_id for canvas in session.open_canvases] == [ + "counter-1", + "logs-1", + ] + + # Closing one instance removes it; the other remains. + session._dispatch_event( + SessionEvent( + data=SessionCanvasClosedData( + canvas_id="counter", + extension_id="project:counter", + instance_id="counter-1", + ), + id=uuid4(), + timestamp=datetime.now(UTC), + type=SessionEventType.SESSION_CANVAS_CLOSED, + ) + ) + assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"] + + # Closing an absent instance is a no-op (idempotent). + session._dispatch_event( + SessionEvent( + data=SessionCanvasClosedData( + canvas_id="counter", + extension_id="project:counter", + instance_id="counter-1", + ), + id=uuid4(), + timestamp=datetime.now(UTC), + type=SessionEventType.SESSION_CANVAS_CLOSED, + ) + ) + assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"] + + # A closed event with an empty instance_id warns and leaves the snapshot intact. + session._dispatch_event( + SessionEvent( + data=SessionCanvasClosedData( + canvas_id="logs", + extension_id="project:logs", + instance_id="", + ), + id=uuid4(), + timestamp=datetime.now(UTC), + type=SessionEventType.SESSION_CANVAS_CLOSED, + ) + ) + assert "failed to deserialize session.canvas.closed payload" in caplog.text + assert [canvas.instance_id for canvas in session.open_canvases] == ["logs-1"] diff --git a/python/test_cli_download.py b/python/test_cli_download.py new file mode 100644 index 000000000..36952919d --- /dev/null +++ b/python/test_cli_download.py @@ -0,0 +1,53 @@ +"""Tests for the in-process runtime library download integrity checks.""" + +from __future__ import annotations + +import base64 +import hashlib +from unittest.mock import patch + +import pytest + +from copilot import _cli_download + + +def _integrity(data: bytes, algo: str = "sha512") -> str: + digest = hashlib.new(algo, data).digest() + return f"{algo}-{base64.b64encode(digest).decode('ascii')}" + + +class TestVerifyIntegrity: + def test_accepts_matching_checksum(self): + data = b"native-library-bytes" + _cli_download._verify_integrity(data, _integrity(data)) + + def test_rejects_mismatched_checksum(self): + with pytest.raises(RuntimeError, match="Integrity mismatch"): + _cli_download._verify_integrity(b"tampered", _integrity(b"original")) + + def test_rejects_unsupported_algorithm(self): + # Fail closed rather than silently skipping verification of native code. + with pytest.raises(RuntimeError, match="Unsupported integrity algorithm"): + _cli_download._verify_integrity(b"bytes", "md5-deadbeef") + + +class TestEnsureRuntimeLibraryFailsClosed: + def test_raises_when_integrity_unavailable(self, tmp_path): + """A missing npm integrity value must abort the download, not load unverified code.""" + cli_path = tmp_path / "copilot" + cli_path.write_bytes(b"#!/bin/sh\n") + + with ( + patch("copilot._ffi_runtime_host.resolve_library_path", return_value=None), + patch.object(_cli_download, "_should_skip_download", return_value=False), + patch.object(_cli_download, "get_npm_platform", return_value="linux-x64"), + patch.object(_cli_download, "get_runtime_lib_url", return_value="https://example/lib"), + patch.object(_cli_download, "_fetch_url_bytes", return_value=b"tarball-bytes"), + patch.object(_cli_download, "_fetch_runtime_integrity", return_value=None), + patch.object(_cli_download, "_extract_runtime_node") as extract, + ): + with pytest.raises(RuntimeError, match="refusing to load unverified native code"): + _cli_download.ensure_runtime_library(str(cli_path), version="1.2.3") + + # The library bytes must never be extracted/written when verification is impossible. + extract.assert_not_called() diff --git a/python/test_client.py b/python/test_client.py index b1c687204..cf4bdf192 100644 --- a/python/test_client.py +++ b/python/test_client.py @@ -4,13 +4,22 @@ This file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.py instead. """ +import asyncio +import inspect +import os from datetime import UTC, datetime -from unittest.mock import AsyncMock, patch +from tempfile import TemporaryDirectory +from unittest.mock import AsyncMock, Mock, patch import pytest from copilot import ( + CanvasProviderIdentity, + CapiSessionOptions, CopilotClient, + ExtensionInfo, + ModelBillingTokenPrices, + ModelBillingTokenPricesLongContext, RuntimeConnection, StdioRuntimeConnection, define_tool, @@ -18,53 +27,1147 @@ from copilot.client import ( CloudSessionOptions, CloudSessionRepository, + CopilotExpAssignmentResponse, + ExpConfigEntry, + ManagedSettings, + ManagedSettingsPermissions, + ModelBilling, ModelCapabilities, ModelInfo, ModelLimits, ModelSupports, ) from copilot.session import PermissionHandler +from copilot.session_events import ( + McpOauthRequestReason, + McpOauthRequiredData, + McpOauthRequiredStaticClientConfig, + McpOauthWWWAuthenticateParams, + SessionEvent, + SessionEventType, +) +from copilot.tools import Tool from e2e.testharness import CLI_PATH -class TestPermissionHandlerOptional: - @pytest.mark.asyncio - async def test_create_session_allows_missing_permission_handler(self): - client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) - await client.start() - try: - session = await client.create_session() - assert session.session_id - finally: - await client.force_stop() +def test_inprocess_connection_has_no_child_process_options(): + connection = RuntimeConnection.for_inprocess() + + assert list(inspect.signature(RuntimeConnection.for_inprocess).parameters) == [] + assert not hasattr(connection, "path") + assert not hasattr(connection, "args") + + +class TestBuiltinPluginDirectories: + @staticmethod + async def _start_client(paths=None): + client = CopilotClient( + connection=RuntimeConnection.for_uri("localhost:1234"), + builtin_plugin_directories=paths, + ) + client._connect_to_server = AsyncMock() + client._verify_protocol_version = AsyncMock() + client._client = Mock() + client._client.request = AsyncMock(return_value={}) + + await client.start() + return client + + @pytest.mark.asyncio + @pytest.mark.parametrize("paths", [None, []]) + async def test_default_or_empty_does_not_call_rpc(self, paths): + client = await self._start_client(paths) + + client._client.request.assert_not_awaited() + + @pytest.mark.asyncio + async def test_configured_paths_call_rpc_once_before_start_completes(self): + paths = [ + os.path.abspath("plugins/core"), + os.path.abspath("plugins/github"), + ] + + client = await self._start_client(paths) + + client._client.request.assert_awaited_once_with( + "plugins.builtin.set", + {"paths": paths}, + ) + + def test_relative_path_is_rejected(self): + with pytest.raises(ValueError, match="builtin_plugin_directories.*absolute paths"): + CopilotClient( + connection=RuntimeConnection.for_uri("localhost:1234"), + builtin_plugin_directories=["plugins/core"], + ) + + +class TestClientShutdown: + @pytest.mark.asyncio + async def test_stop_requests_runtime_shutdown_for_owned_process(self): + calls: list[str] = [] + process = Mock() + process.poll.return_value = None + process.wait.return_value = 0 + + class Runtime: + async def shutdown(self, *, timeout=None): + calls.append("runtime.shutdown") + + client = CopilotClient(connection=RuntimeConnection.for_stdio(path="copilot")) + client._rpc = Mock(runtime=Runtime()) + client._process = process + client._cli_process = process + client._is_external_server = False + + await client.stop() + + assert calls == ["runtime.shutdown"] + # The runtime never self-exits after runtime.shutdown (it keeps its + # JSON-RPC server alive to send the response and leaves termination to + # the caller), so stop() terminates the owned process. The mocked + # process exits on terminate() (wait returns immediately), so we never + # escalate to kill(). + process.terminate.assert_called_once() + process.kill.assert_not_called() + + @pytest.mark.asyncio + async def test_force_stop_and_external_stop_do_not_request_runtime_shutdown(self): + calls: list[str] = [] + process = Mock() + + class Runtime: + async def shutdown(self): + calls.append("runtime.shutdown") + + force_client = CopilotClient(connection=RuntimeConnection.for_stdio(path="copilot")) + force_client._rpc = Mock(runtime=Runtime()) + force_client._process = process + force_client._cli_process = process + force_client._is_external_server = False + + await force_client.force_stop() + + assert calls == [] + process.kill.assert_called_once() + + external_client = CopilotClient(connection=RuntimeConnection.for_uri("localhost:1234")) + external_client._rpc = Mock(runtime=Runtime()) + external_client._is_external_server = True + + await external_client.stop() + + assert calls == [] + + @pytest.mark.asyncio + async def test_force_stop_external_server_clears_process_references(self): + process = Mock() + client = CopilotClient(connection=RuntimeConnection.for_uri("localhost:1234")) + client._is_external_server = True + client._process = process + client._cli_process = process + + await client.force_stop() + + process.terminate.assert_called_once() + assert client._process is None + assert client._cli_process is None + + +class TestPermissionHandlerOptional: + @pytest.mark.asyncio + async def test_create_session_allows_missing_permission_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + session = await client.create_session() + assert session.session_id + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_session_allows_none_permission_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + session = await client.create_session(on_permission_request=None) + assert session.session_id + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_resume_session_allows_none_permission_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all + ) + resumed = await client.resume_session(session.session_id, on_permission_request=None) + assert resumed.session_id == session.session_id + finally: + await client.force_stop() + + +class TestCreateSessionConfig: + @pytest.mark.asyncio + async def test_additional_directories_forwarded_on_create_and_resume(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + captured.append((method, params)) + if method == "session.create": + result = {"sessionId": params["sessionId"], "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + if method == "session.resume": + return {"sessionId": params["sessionId"], "workspacePath": None} + return {} + + client._client.request = mock_request + await client.create_session( + session_id="create-with-additional-directories", + additional_directories=["/repo/shared", "/repo/generated"], + ) + await client.resume_session( + "resume-with-additional-directories", + additional_directories=["/repo/resumed"], + ) + + create_payload = next( + params for method, params in captured if method == "session.create" + ) + resume_payload = next( + params for method, params in captured if method == "session.resume" + ) + assert create_payload["additionalDirectories"] == ["/repo/shared", "/repo/generated"] + assert resume_payload["additionalDirectories"] == ["/repo/resumed"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_mcp_auth_handler_registers_interest_in_create_session(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + captured.append((method, params)) + if method == "session.eventLog.registerInterest": + return {"id": "interest-1"} + if method == "session.create": + result = {"sessionId": params["sessionId"], "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=lambda request: {"kind": "cancelled"}, + ) + + create_method, create_payload = captured[0] + interest_method, interest_payload = captured[1] + assert create_method == "session.create" + assert interest_method == "session.eventLog.registerInterest" + assert interest_payload["eventType"] == "mcp.oauth_required" + assert interest_payload["sessionId"] == create_payload["sessionId"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_mcp_auth_interest_is_not_registered_without_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + captured.append((method, params)) + if method == "session.create": + result = {"sessionId": params["sessionId"], "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + if method == "session.resume": + return {"sessionId": params["sessionId"], "workspacePath": None} + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_event=lambda event: None, + ) + await client.resume_session( + "session-without-auth", + on_permission_request=PermissionHandler.approve_all, + on_event=lambda event: None, + ) + + assert session.session_id + assert not any( + method == "session.eventLog.registerInterest" + and params["eventType"] == "mcp.oauth_required" + for method, params in captured + ) + assert any( + method == "session.create" and params["requestPermission"] is True + for method, params in captured + ) + assert any( + method == "session.resume" and params["requestPermission"] is True + for method, params in captured + ) + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_mcp_auth_handler_registers_interest_after_resume(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + captured.append((method, params)) + if method == "session.eventLog.registerInterest": + return {"id": "interest-1"} + if method == "session.resume": + return {"sessionId": params["sessionId"], "workspacePath": None} + return {} + + client._client.request = mock_request + await client.resume_session( + "session-with-auth", + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=lambda request: {"kind": "cancelled"}, + ) + + resume_method, resume_payload = captured[0] + interest_method, interest_payload = captured[1] + assert resume_method == "session.resume" + assert resume_payload["requestPermission"] is True + assert interest_method == "session.eventLog.registerInterest" + assert interest_payload == { + "sessionId": "session-with-auth", + "eventType": "mcp.oauth_required", + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_mcp_auth_handler_registers_interest_after_cloud_create_only_with_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + create_count = 0 + + async def mock_request(method, params, **kwargs): + nonlocal create_count + captured.append((method, params)) + if method == "session.eventLog.registerInterest": + return {"id": "interest-1"} + if method == "session.create": + create_count += 1 + result = { + "sessionId": f"server-assigned-session-{create_count}", + "workspacePath": None, + } + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + cloud = CloudSessionOptions( + repository=CloudSessionRepository( + owner="github", + name="copilot-sdk", + branch="main", + ) + ) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + cloud=cloud, + ) + + assert not any( + method == "session.eventLog.registerInterest" + and params["eventType"] == "mcp.oauth_required" + for method, params in captured + ) + + captured.clear() + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=lambda request: {"kind": "cancelled"}, + cloud=cloud, + ) + + create_method, _create_payload = captured[0] + interest_method, interest_payload = captured[1] + assert create_method == "session.create" + assert interest_method == "session.eventLog.registerInterest" + assert interest_payload == { + "sessionId": "server-assigned-session-2", + "eventType": "mcp.oauth_required", + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_mcp_auth_required_event_sends_host_token(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + if method == "session.mcp.oauth.handlePendingRequest": + captured.append((method, params)) + return {"success": True} + if method == "session.create": + result = {"sessionId": params["sessionId"], "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + if method == "session.eventLog.registerInterest": + return {"id": "interest-1"} + return {} + + client._client.request = mock_request + observed_request = None + + def handle_mcp_auth_request(request, invocation): + nonlocal observed_request + observed_request = request + assert invocation == {"sessionId": session.session_id} + return { + "accessToken": "host-token", + "tokenType": "Bearer", + } + + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + on_mcp_auth_request=handle_mcp_auth_request, + ) + + session._dispatch_event( + SessionEvent( + data=McpOauthRequiredData( + request_id="oauth-request", + server_name="oauth-server", + server_url="https://example.com/mcp", + reason=McpOauthRequestReason.INITIAL, + www_authenticate_params=McpOauthWWWAuthenticateParams( + resource_metadata_url="https://example.com/.well-known/oauth-protected-resource" + ), + resource_metadata='{"resource":"https://example.com/mcp"}', + static_client_config=McpOauthRequiredStaticClientConfig( + client_id="static-client", + client_secret="static-secret", + grant_type="client_credentials", + public_client=False, + ), + ), + id="evt-1", + timestamp="2026-01-01T00:00:00Z", + type=SessionEventType.MCP_OAUTH_REQUIRED, + ephemeral=True, + parent_id=None, + ) + ) + + for _ in range(200): + if captured: + break + await asyncio.sleep(0.005) + + assert observed_request is not None + assert observed_request["resourceMetadata"] == '{"resource":"https://example.com/mcp"}' + assert observed_request["wwwAuthenticateParams"]["resourceMetadataUrl"] == ( + "https://example.com/.well-known/oauth-protected-resource" + ) + assert observed_request["staticClientConfig"] == { + "clientId": "static-client", + "clientSecret": "static-secret", + "grantType": "client_credentials", + "publicClient": False, + } + assert captured == [ + ( + "session.mcp.oauth.handlePendingRequest", + { + "sessionId": session.session_id, + "requestId": "oauth-request", + "result": { + "kind": "token", + "accessToken": "host-token", + "tokenType": "Bearer", + }, + }, + ) + ] + + observed_request = None + session._dispatch_event( + SessionEvent( + data=McpOauthRequiredData( + request_id="oauth-request-without-metadata", + server_name="oauth-server", + server_url="https://example.com/mcp", + reason=McpOauthRequestReason.INITIAL, + ), + id="evt-2", + timestamp="2026-01-01T00:00:00Z", + type=SessionEventType.MCP_OAUTH_REQUIRED, + ephemeral=True, + parent_id=None, + ) + ) + + for _ in range(200): + if observed_request is not None: + break + await asyncio.sleep(0.005) + + assert observed_request is not None + assert "resourceMetadata" not in observed_request + assert "wwwAuthenticateParams" not in observed_request + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_session_forwards_cloud_options(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method == "session.create": + # Cloud sessions: server assigns the id if the client didn't. + sid = params.get("sessionId") or "server-assigned-session" + result = {"sessionId": sid, "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + cloud=CloudSessionOptions( + repository=CloudSessionRepository( + owner="github", + name="copilot-sdk", + branch="main", + ) + ), + ) + + assert captured["session.create"]["cloud"] == { + "repository": { + "owner": "github", + "name": "copilot-sdk", + "branch": "main", + } + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_github_mcp_tool_config(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + config = { + "enable_all_tools": True, + "additional_toolsets": ["repos"], + "additional_tools": ["get_issue"], + "enable_insiders_mode": True, + "disable_form_deferral": True, + } + session = await client.create_session(github_mcp_tool_config=config) + await client.resume_session(session.session_id, github_mcp_tool_config=config) + + expected = { + "enableAllTools": True, + "additionalToolsets": ["repos"], + "additionalTools": ["get_issue"], + "enableInsidersMode": True, + "disableFormDeferral": True, + } + assert captured["session.create"]["githubMcpToolConfig"] == expected + assert captured["session.resume"]["githubMcpToolConfig"] == expected + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_reasoning_summary(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + reasoning_summary="concise", + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + reasoning_summary="none", + ) + + assert captured["session.create"]["reasoningSummary"] == "concise" + assert captured["session.resume"]["reasoningSummary"] == "none" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_enable_experimental_mode(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + enable_experimental_mode=False, + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + enable_experimental_mode=True, + ) + + assert captured["session.create"]["isExperimentalMode"] is False + assert captured["session.resume"]["isExperimentalMode"] is True + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_managed_settings(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + enable_managed_settings=True, + managed_settings=ManagedSettings( + permissions=ManagedSettingsPermissions( + disable_bypass_permissions_mode="disable", + deny=["Shell(git push)"], + ask=["Domain(publish.example)"], + allow=["Read(**)"], + ) + ), + ) + resumed_session = await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + managed_settings=ManagedSettings( + permissions=ManagedSettingsPermissions(ask=["Domain(publish.example)"]) + ), + ) + + assert session._managed_settings_enabled is True + assert resumed_session._managed_settings_enabled is True + assert captured["session.create"]["enableManagedSettings"] is True + assert captured["session.create"]["managedSettings"] == { + "permissions": { + "disableBypassPermissionsMode": "disable", + "deny": ["Shell(git push)"], + "ask": ["Domain(publish.example)"], + "allow": ["Read(**)"], + } + } + assert captured["session.resume"]["managedSettings"] == { + "permissions": {"ask": ["Domain(publish.example)"]} + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_default_enable_experimental_mode_by_mode(self): + with TemporaryDirectory() as base_directory: + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + mode="empty", + base_directory=base_directory, + ) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + if method == "session.options.update": + return {"success": True} + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + ) + + assert captured["session.create"]["isExperimentalMode"] is False + assert captured["session.resume"]["isExperimentalMode"] is False + finally: + await client.force_stop() + + async def test_managed_settings_omitted_when_not_supplied(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method == "session.create": + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + + assert "managedSettings" not in captured["session.create"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_managed_settings_preserves_empty_arrays(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method == "session.create": + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + managed_settings=ManagedSettings( + permissions=ManagedSettingsPermissions(deny=[], ask=[], allow=[]) + ), + ) + + assert captured["session.create"]["managedSettings"] == { + "permissions": {"deny": [], "ask": [], "allow": []} + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_context_tier(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + context_tier="long_context", + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + context_tier="default", + ) + + assert captured["session.create"]["contextTier"] == "long_context" + assert captured["session.resume"]["contextTier"] == "default" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_tool_metadata(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + metadata = {"github.com/copilot:safeForTelemetry": {"name": True, "inputsNames": False}} + tool = Tool(name="my_tool", description="a tool", metadata=metadata) + plain_tool = Tool(name="plain_tool", description="a tool") + + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + tools=[tool, plain_tool], + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + tools=[tool], + ) + + create_tools = captured["session.create"]["tools"] + assert create_tools[0]["metadata"] == metadata + # Omitted when unset. + assert "metadata" not in create_tools[1] + assert captured["session.resume"]["tools"][0]["metadata"] == metadata + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_tool_is_terminal(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + tool = Tool(name="my_tool", description="a tool", is_terminal=True) + plain_tool = Tool(name="plain_tool", description="a tool") + + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + tools=[tool, plain_tool], + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + tools=[tool], + ) + + create_tools = captured["session.create"]["tools"] + assert create_tools[0]["isTerminal"] is True + # Omitted when left at its default. + assert "isTerminal" not in create_tools[1] + assert captured["session.resume"]["tools"][0]["isTerminal"] is True + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_canvas_provider(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + extension_info=ExtensionInfo(source="github-app", name="counter"), + canvas_provider=CanvasProviderIdentity(id="app:builtin:window-1", name="Built-in"), + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + canvas_provider=CanvasProviderIdentity(id="app:builtin:window-1"), + ) + + assert captured["session.create"]["canvasProvider"] == { + "id": "app:builtin:window-1", + "name": "Built-in", + } + assert captured["session.create"]["extensionInfo"] == { + "source": "github-app", + "name": "counter", + } + assert captured["session.resume"]["canvasProvider"] == { + "id": "app:builtin:window-1", + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_new_session_options(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + enable_citations=True, + enable_file_change_tracking=True, + excluded_builtin_agents=["explore"], + session_limits={"max_ai_credits": 30}, + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + enable_citations=False, + enable_file_change_tracking=False, + excluded_builtin_agents=["task"], + session_limits={"max_ai_credits": 15}, + ) + + assert captured["session.create"]["enableCitations"] is True + assert captured["session.create"]["enableFileChangeTracking"] is True + assert captured["session.create"]["excludedBuiltinAgents"] == ["explore"] + assert captured["session.create"]["sessionLimits"] == {"maxAiCredits": 30} + assert captured["session.resume"]["enableCitations"] is False + assert captured["session.resume"]["enableFileChangeTracking"] is False + assert captured["session.resume"]["excludedBuiltinAgents"] == ["task"] + assert captured["session.resume"]["sessionLimits"] == {"maxAiCredits": 15} + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_capi_options(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + create_capi: CapiSessionOptions = {"enable_web_socket_responses": False} + resume_capi: CapiSessionOptions = {"enable_web_socket_responses": True} + + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + capi=create_capi, + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + capi=resume_capi, + ) + + assert captured["session.create"]["capi"] == { + "enableWebSocketResponses": False, + } + assert captured["session.resume"]["capi"] == { + "enableWebSocketResponses": True, + } + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_and_resume_session_forward_plugin_directories_and_large_output(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + return {} + + client._client.request = mock_request + + plugin_dirs = ["/tmp/plugins/a", "/tmp/plugins/b"] + disabled_mcp_servers = ["local-files", "remote-github"] + large_output = { + "enabled": True, + "max_size_bytes": 1024, + "output_directory": "/tmp/large-output", + } + expected_large_output_wire = { + "enabled": True, + "maxSizeBytes": 1024, + "outputDir": "/tmp/large-output", + } + + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + plugin_directories=plugin_dirs, + disabled_mcp_servers=disabled_mcp_servers, + large_output=large_output, + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + plugin_directories=plugin_dirs, + disabled_mcp_servers=disabled_mcp_servers, + large_output=large_output, + ) + + assert captured["session.create"]["pluginDirectories"] == plugin_dirs + assert captured["session.create"]["disabledMcpServers"] == disabled_mcp_servers + assert captured["session.create"]["largeOutput"] == expected_large_output_wire + assert captured["session.resume"]["pluginDirectories"] == plugin_dirs + assert captured["session.resume"]["disabledMcpServers"] == disabled_mcp_servers + assert captured["session.resume"]["largeOutput"] == expected_large_output_wire - @pytest.mark.asyncio - async def test_create_session_allows_none_permission_handler(self): - client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) - await client.start() - try: - session = await client.create_session(on_permission_request=None) - assert session.session_id - finally: - await client.force_stop() + empty_session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + disabled_mcp_servers=[], + ) + await client.resume_session( + empty_session.session_id, + on_permission_request=PermissionHandler.approve_all, + disabled_mcp_servers=[], + ) + assert captured["session.create"]["disabledMcpServers"] == [] + assert captured["session.resume"]["disabledMcpServers"] == [] - @pytest.mark.asyncio - async def test_resume_session_allows_none_permission_handler(self): - client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) - await client.start() - try: - session = await client.create_session( - on_permission_request=PermissionHandler.approve_all + omitted_session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, ) - resumed = await client.resume_session(session.session_id, on_permission_request=None) - assert resumed.session_id == session.session_id + await client.resume_session( + omitted_session.session_id, + on_permission_request=PermissionHandler.approve_all, + ) + assert "disabledMcpServers" not in captured["session.create"] + assert "disabledMcpServers" not in captured["session.resume"] finally: await client.force_stop() - -class TestCreateSessionConfig: @pytest.mark.asyncio - async def test_create_session_forwards_cloud_options(self): + async def test_create_and_resume_session_forward_memory(self): client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) await client.start() try: @@ -72,10 +1175,8 @@ async def test_create_session_forwards_cloud_options(self): async def mock_request(method, params, **kwargs): captured[method] = params - if method == "session.create": - # Cloud sessions: server assigns the id if the client didn't. - sid = params.get("sessionId") or "server-assigned-session" - result = {"sessionId": sid, "workspacePath": None} + if method in ("session.create", "session.resume"): + result = {"sessionId": params.get("sessionId") or "session-1"} callback = kwargs.get("on_response_inline") if callback is not None: callback(result) @@ -83,29 +1184,24 @@ async def mock_request(method, params, **kwargs): return {} client._client.request = mock_request - await client.create_session( + + session = await client.create_session( on_permission_request=PermissionHandler.approve_all, - cloud=CloudSessionOptions( - repository=CloudSessionRepository( - owner="github", - name="copilot-sdk", - branch="main", - ) - ), + memory={"enabled": True}, + ) + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + memory={"enabled": False}, ) - assert captured["session.create"]["cloud"] == { - "repository": { - "owner": "github", - "name": "copilot-sdk", - "branch": "main", - } - } + assert captured["session.create"]["memory"] == {"enabled": True} + assert captured["session.resume"]["memory"] == {"enabled": False} finally: await client.force_stop() @pytest.mark.asyncio - async def test_create_and_resume_session_forward_reasoning_summary(self): + async def test_create_and_resume_session_omit_memory_when_unset(self): client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) await client.start() try: @@ -122,23 +1218,22 @@ async def mock_request(method, params, **kwargs): return {} client._client.request = mock_request + session = await client.create_session( on_permission_request=PermissionHandler.approve_all, - reasoning_summary="concise", ) await client.resume_session( session.session_id, on_permission_request=PermissionHandler.approve_all, - reasoning_summary="none", ) - assert captured["session.create"]["reasoningSummary"] == "concise" - assert captured["session.resume"]["reasoningSummary"] == "none" + assert "memory" not in captured["session.create"] + assert "memory" not in captured["session.resume"] finally: await client.force_stop() @pytest.mark.asyncio - async def test_create_and_resume_session_forward_context_tier(self): + async def test_create_and_resume_session_forward_exp_assignments(self): client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) await client.start() try: @@ -155,23 +1250,41 @@ async def mock_request(method, params, **kwargs): return {} client._client.request = mock_request + + create_assignments = CopilotExpAssignmentResponse( + configs=[ExpConfigEntry(id="exp-create")] + ) + resume_assignments = CopilotExpAssignmentResponse( + configs=[ExpConfigEntry(id="exp-resume")] + ) + session = await client.create_session( on_permission_request=PermissionHandler.approve_all, - context_tier="long_context", + exp_assignments=create_assignments, ) await client.resume_session( session.session_id, on_permission_request=PermissionHandler.approve_all, - context_tier="default", + exp_assignments=resume_assignments, ) - assert captured["session.create"]["contextTier"] == "long_context" - assert captured["session.resume"]["contextTier"] == "default" + assert captured["session.create"]["expAssignments"] == { + "Features": [], + "Flights": {}, + "Configs": [{"Id": "exp-create", "Parameters": {}}], + "AssignmentContext": "", + } + assert captured["session.resume"]["expAssignments"] == { + "Features": [], + "Flights": {}, + "Configs": [{"Id": "exp-resume", "Parameters": {}}], + "AssignmentContext": "", + } finally: await client.force_stop() @pytest.mark.asyncio - async def test_create_and_resume_session_forward_plugin_directories_and_large_output(self): + async def test_create_and_resume_session_omit_exp_assignments_when_unset(self): client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) await client.start() try: @@ -189,34 +1302,16 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request - plugin_dirs = ["/tmp/plugins/a", "/tmp/plugins/b"] - large_output = { - "enabled": True, - "max_size_bytes": 1024, - "output_directory": "/tmp/large-output", - } - expected_large_output_wire = { - "enabled": True, - "maxSizeBytes": 1024, - "outputDir": "/tmp/large-output", - } - session = await client.create_session( on_permission_request=PermissionHandler.approve_all, - plugin_directories=plugin_dirs, - large_output=large_output, ) await client.resume_session( session.session_id, on_permission_request=PermissionHandler.approve_all, - plugin_directories=plugin_dirs, - large_output=large_output, ) - assert captured["session.create"]["pluginDirectories"] == plugin_dirs - assert captured["session.create"]["largeOutput"] == expected_large_output_wire - assert captured["session.resume"]["pluginDirectories"] == plugin_dirs - assert captured["session.resume"]["largeOutput"] == expected_large_output_wire + assert "expAssignments" not in captured["session.create"] + assert "expAssignments" not in captured["session.resume"] finally: await client.force_stop() @@ -441,6 +1536,70 @@ def grep(params) -> str: await client.force_stop() +class TestDefer: + @pytest.mark.asyncio + async def test_defer_sent_in_tool_definition(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + + @define_tool(description="Fetch issue details", defer="auto") + def lookup_issue(params) -> str: + return "ok" + + await client.create_session( + on_permission_request=PermissionHandler.approve_all, tools=[lookup_issue] + ) + tool_defs = captured["session.create"]["tools"] + assert len(tool_defs) == 1 + assert tool_defs[0]["name"] == "lookup_issue" + assert tool_defs[0]["defer"] == "auto" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_resume_session_sends_defer(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all + ) + + captured = {} + + async def mock_request(method, params, **kwargs): + captured[method] = params + return {"sessionId": params["sessionId"]} + + client._client.request = mock_request + + @define_tool(description="Fetch issue details", defer="auto") + def lookup_issue(params) -> str: + return "ok" + + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + tools=[lookup_issue], + ) + tool_defs = captured["session.resume"]["tools"] + assert len(tool_defs) == 1 + assert tool_defs[0]["defer"] == "auto" + finally: + await client.force_stop() + + class TestInstructionDirectories: @pytest.mark.asyncio async def test_create_session_sends_instruction_directories(self): @@ -504,6 +1663,80 @@ async def mock_request(method, params, **kwargs): await client.force_stop() +class TestModelBilling: + def test_token_prices_round_trip(self): + """ModelBilling.from_dict/to_dict round-trips tokenPrices and longContext.""" + wire = { + "multiplier": 1.5, + "tokenPrices": { + "inputPrice": 2.0, + "outputPrice": 8.0, + "cachePrice": 0.5, + "batchSize": 1000000, + "contextMax": 128000, + "longContext": { + "inputPrice": 4.0, + "outputPrice": 16.0, + "cachePrice": 1.0, + "contextMax": 1000000, + }, + }, + } + + billing = ModelBilling.from_dict(wire) + + assert billing.multiplier == 1.5 + assert isinstance(billing.token_prices, ModelBillingTokenPrices) + prices = billing.token_prices + assert prices.input_price == 2.0 + assert prices.output_price == 8.0 + assert prices.cache_price == 0.5 + assert prices.batch_size == 1000000 + assert prices.context_max == 128000 + assert isinstance(prices.long_context, ModelBillingTokenPricesLongContext) + long_context = prices.long_context + assert long_context.input_price == 4.0 + assert long_context.output_price == 16.0 + assert long_context.cache_price == 1.0 + assert long_context.context_max == 1000000 + + assert billing.to_dict() == wire + + def test_token_prices_absent(self): + """ModelBilling without tokenPrices leaves token_prices unset.""" + billing = ModelBilling.from_dict({"multiplier": 1.0}) + assert billing.token_prices is None + assert billing.to_dict() == {"multiplier": 1.0} + + def test_token_prices_empty_object_round_trip(self): + """ModelBilling preserves present but empty tokenPrices.""" + billing = ModelBilling.from_dict({"tokenPrices": {}}) + + assert isinstance(billing.token_prices, ModelBillingTokenPrices) + prices = billing.token_prices + assert prices.input_price is None + assert prices.output_price is None + assert prices.cache_price is None + assert prices.batch_size is None + assert prices.context_max is None + assert prices.long_context is None + assert billing.to_dict() == {"tokenPrices": {}} + + def test_long_context_empty_object_round_trip(self): + """ModelBilling preserves present but empty longContext.""" + billing = ModelBilling.from_dict({"tokenPrices": {"longContext": {}}}) + + assert isinstance(billing.token_prices, ModelBillingTokenPrices) + prices = billing.token_prices + assert isinstance(prices.long_context, ModelBillingTokenPricesLongContext) + long_context = prices.long_context + assert long_context.input_price is None + assert long_context.output_price is None + assert long_context.cache_price is None + assert long_context.context_max is None + assert billing.to_dict() == {"tokenPrices": {"longContext": {}}} + + class TestOnListModels: @pytest.mark.asyncio async def test_list_models_with_custom_handler(self): @@ -810,6 +2043,7 @@ async def mock_request(method, params, **kwargs): "wire_model": "my-finetune-v3", "max_prompt_tokens": 100_000, "max_output_tokens": 4096, + "transport": "websockets", }, ) @@ -820,6 +2054,7 @@ async def mock_request(method, params, **kwargs): assert provider["wireModel"] == "my-finetune-v3" assert provider["maxPromptTokens"] == 100_000 assert provider["maxOutputTokens"] == 4096 + assert provider["transport"] == "websockets" finally: await client.force_stop() @@ -1132,17 +2367,100 @@ async def mock_request(method, params, **kwargs): return await original_request(method, params, **kwargs) client._client.request = mock_request - await session.set_model("gpt-4.1", reasoning_summary="detailed") + await session.set_model( + "gpt-4.1", + reasoning_summary="detailed", + context_tier="long_context", + ) assert captured["session.model.switchTo"]["sessionId"] == session.session_id assert captured["session.model.switchTo"]["modelId"] == "gpt-4.1" assert captured["session.model.switchTo"]["reasoningSummary"] == "detailed" + assert captured["session.model.switchTo"]["contextTier"] == "long_context" + finally: + await client.force_stop() + + +class TestMcpOAuthTokenStorage: + @pytest.mark.asyncio + async def test_create_session_defaults_mcp_oauth_token_storage_to_in_memory_in_empty_mode( + self, + ): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + mode="empty", + base_directory="/tmp/copilot-test", + ) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + ) + assert captured["session.create"]["mcpOAuthTokenStorage"] == "in-memory" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_session_does_not_send_mcp_oauth_token_storage_in_copilot_cli_mode( + self, + ): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + assert "mcpOAuthTokenStorage" not in captured["session.create"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_session_forwards_explicit_mcp_oauth_token_storage(self): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + mode="empty", + base_directory="/tmp/copilot-test", + ) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + mcp_oauth_token_storage="persistent", + ) + assert captured["session.create"]["mcpOAuthTokenStorage"] == "persistent" finally: await client.force_stop() - -class TestMcpOAuthTokenStorage: @pytest.mark.asyncio - async def test_create_session_defaults_mcp_oauth_token_storage_to_in_memory_in_empty_mode( + async def test_resume_session_defaults_mcp_oauth_token_storage_to_in_memory_in_empty_mode( self, ): client = CopilotClient( @@ -1153,47 +2471,67 @@ async def test_create_session_defaults_mcp_oauth_token_storage_to_in_memory_in_e await client.start() try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + ) + captured = {} original_request = client._client.request async def mock_request(method, params, **kwargs): captured[method] = params + if method == "session.resume": + return {"sessionId": session.session_id} return await original_request(method, params, **kwargs) client._client.request = mock_request - await client.create_session( + await client.resume_session( + session.session_id, on_permission_request=PermissionHandler.approve_all, available_tools=[], ) - assert captured["session.create"]["mcpOAuthTokenStorage"] == "in-memory" + assert captured["session.resume"]["mcpOAuthTokenStorage"] == "in-memory" finally: await client.force_stop() @pytest.mark.asyncio - async def test_create_session_does_not_send_mcp_oauth_token_storage_in_copilot_cli_mode( - self, - ): - client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + async def test_resume_session_forwards_explicit_mcp_oauth_token_storage(self): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + mode="empty", + base_directory="/tmp/copilot-test", + ) await client.start() try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all, + available_tools=[], + ) + captured = {} original_request = client._client.request async def mock_request(method, params, **kwargs): captured[method] = params + if method == "session.resume": + return {"sessionId": session.session_id} return await original_request(method, params, **kwargs) client._client.request = mock_request - await client.create_session( + await client.resume_session( + session.session_id, on_permission_request=PermissionHandler.approve_all, + available_tools=[], + mcp_oauth_token_storage="persistent", ) - assert "mcpOAuthTokenStorage" not in captured["session.create"] + assert captured["session.resume"]["mcpOAuthTokenStorage"] == "persistent" finally: await client.force_stop() @pytest.mark.asyncio - async def test_create_session_forwards_explicit_mcp_oauth_token_storage(self): + async def test_create_session_defaults_memory_to_disabled_in_empty_mode(self): client = CopilotClient( connection=RuntimeConnection.for_stdio(path=CLI_PATH), mode="empty", @@ -1213,16 +2551,13 @@ async def mock_request(method, params, **kwargs): await client.create_session( on_permission_request=PermissionHandler.approve_all, available_tools=[], - mcp_oauth_token_storage="persistent", ) - assert captured["session.create"]["mcpOAuthTokenStorage"] == "persistent" + assert captured["session.create"]["memory"] == {"enabled": False} finally: await client.force_stop() @pytest.mark.asyncio - async def test_resume_session_defaults_mcp_oauth_token_storage_to_in_memory_in_empty_mode( - self, - ): + async def test_create_session_forwards_explicit_memory_in_empty_mode(self): client = CopilotClient( connection=RuntimeConnection.for_stdio(path=CLI_PATH), mode="empty", @@ -1231,32 +2566,25 @@ async def test_resume_session_defaults_mcp_oauth_token_storage_to_in_memory_in_e await client.start() try: - session = await client.create_session( - on_permission_request=PermissionHandler.approve_all, - available_tools=[], - ) - captured = {} original_request = client._client.request async def mock_request(method, params, **kwargs): captured[method] = params - if method == "session.resume": - return {"sessionId": session.session_id} return await original_request(method, params, **kwargs) client._client.request = mock_request - await client.resume_session( - session.session_id, + await client.create_session( on_permission_request=PermissionHandler.approve_all, available_tools=[], + memory={"enabled": True}, ) - assert captured["session.resume"]["mcpOAuthTokenStorage"] == "in-memory" + assert captured["session.create"]["memory"] == {"enabled": True} finally: await client.force_stop() @pytest.mark.asyncio - async def test_resume_session_forwards_explicit_mcp_oauth_token_storage(self): + async def test_resume_session_defaults_memory_to_disabled_in_empty_mode(self): client = CopilotClient( connection=RuntimeConnection.for_stdio(path=CLI_PATH), mode="empty", @@ -1284,9 +2612,8 @@ async def mock_request(method, params, **kwargs): session.session_id, on_permission_request=PermissionHandler.approve_all, available_tools=[], - mcp_oauth_token_storage="persistent", ) - assert captured["session.resume"]["mcpOAuthTokenStorage"] == "persistent" + assert captured["session.resume"]["memory"] == {"enabled": False} finally: await client.force_stop() @@ -1357,6 +2684,32 @@ def test_model_field_is_omitted_when_absent(self): wire = client._convert_custom_agent_to_wire_format(agent) assert "model" not in wire + def test_reasoning_effort_is_forwarded_in_camel_case(self): + from copilot.client import CopilotClient + from copilot.session import CustomAgentConfig + + client = CopilotClient.__new__(CopilotClient) + agent: CustomAgentConfig = { + "name": "reasoning-agent", + "prompt": "Think carefully.", + "reasoning_effort": "high", + } + wire = client._convert_custom_agent_to_wire_format(agent) + assert wire["reasoningEffort"] == "high" + assert "reasoning_effort" not in wire + + def test_reasoning_effort_is_omitted_when_absent(self): + from copilot.client import CopilotClient + from copilot.session import CustomAgentConfig + + client = CopilotClient.__new__(CopilotClient) + agent: CustomAgentConfig = { + "name": "default-agent", + "prompt": "Use runtime defaults.", + } + wire = client._convert_custom_agent_to_wire_format(agent) + assert "reasoningEffort" not in wire + class TestPostToolUseFailureHookDispatch: """Unit tests for the postToolUseFailure handler dispatch.""" @@ -1438,3 +2791,321 @@ def on_failure(input_data, invocation): }, ) assert result == {"additionalContext": "sync-ok"} + + +class TestAgentStopHookDispatch: + """Unit tests for the agentStop handler dispatch.""" + + @pytest.mark.asyncio + async def test_dispatches_to_on_agent_stop(self): + from copilot.session import CopilotSession, SessionHooks + + captured: dict = {} + + async def on_agent_stop(input_data, invocation): + captured["input"] = input_data + captured["invocation"] = invocation + return {"decision": "block", "reason": "finish the remaining work"} + + session = CopilotSession.__new__(CopilotSession) + CopilotSession.__init__(session, "sess-123", client=None) + session._hooks = SessionHooks(on_agent_stop=on_agent_stop) # type: ignore[typeddict-item] + + result = await session._handle_hooks_invoke( + "agentStop", + { + "sessionId": "sess-x", + "timestamp": 1700000000, + "cwd": "/work", + "stopReason": "end_turn", + "transcriptPath": "/tmp/transcript.jsonl", + "stop_hook_active": True, + }, + ) + + assert result == {"decision": "block", "reason": "finish the remaining work"} + assert captured["input"]["stopReason"] == "end_turn" + assert captured["input"]["transcriptPath"] == "/tmp/transcript.jsonl" + assert captured["input"]["stopHookActive"] is True + assert captured["input"]["workingDirectory"] == "/work" + assert captured["input"]["timestamp"] == datetime.fromtimestamp(1700000000 / 1000, tz=UTC) + assert captured["invocation"] == {"session_id": "sess-123"} + + +class TestGitHubTelemetry: + """Unit tests for the experimental gitHubTelemetry.event consumer surface.""" + + @pytest.mark.asyncio + async def test_create_session_enables_forwarding_when_handler_registered(self): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + on_github_telemetry=lambda _notification: None, + ) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + assert captured["session.create"]["enableGitHubTelemetryForwarding"] is True + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_create_session_omits_forwarding_without_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.create_session( + on_permission_request=PermissionHandler.approve_all, + ) + assert "enableGitHubTelemetryForwarding" not in captured["session.create"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_resume_session_enables_forwarding_when_handler_registered(self): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + on_github_telemetry=lambda _notification: None, + ) + await client.start() + + try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all + ) + + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method == "session.resume": + return {"sessionId": session.session_id} + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + ) + assert captured["session.resume"]["enableGitHubTelemetryForwarding"] is True + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_resume_session_omits_forwarding_without_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + session = await client.create_session( + on_permission_request=PermissionHandler.approve_all + ) + + captured = {} + original_request = client._client.request + + async def mock_request(method, params, **kwargs): + captured[method] = params + if method == "session.resume": + return {"sessionId": session.session_id} + return await original_request(method, params, **kwargs) + + client._client.request = mock_request + await client.resume_session( + session.session_id, + on_permission_request=PermissionHandler.approve_all, + ) + assert "enableGitHubTelemetryForwarding" not in captured["session.resume"] + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_connect_enables_forwarding_when_handler_registered(self): + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + on_github_telemetry=lambda _notification: None, + ) + captured = {} + + class _FakeClient: + async def request(self, method, params, **kwargs): + captured[method] = params + return {"ok": True, "protocolVersion": 3, "version": "test"} + + client._client = _FakeClient() + await client._verify_protocol_version() + assert captured["connect"]["enableGitHubTelemetryForwarding"] is True + + @pytest.mark.asyncio + async def test_connect_omits_forwarding_without_handler(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + captured = {} + + class _FakeClient: + async def request(self, method, params, **kwargs): + captured[method] = params + return {"ok": True, "protocolVersion": 3, "version": "test"} + + client._client = _FakeClient() + await client._verify_protocol_version() + assert "enableGitHubTelemetryForwarding" not in captured["connect"] + + @pytest.mark.asyncio + async def test_event_routes_to_handler(self): + from copilot.generated.rpc import GitHubTelemetryNotification + + received: list = [] + + def on_telemetry(notification): + received.append(notification) + + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + on_github_telemetry=on_telemetry, + ) + await client.start() + + try: + # gitHubTelemetry.event is a JSON-RPC *notification*: the generated + # client-global dispatcher wires it into the notification-handler + # table, never the request-handler table. Regressing to request-style + # dispatch would drop the runtime's id-less telemetry frames. + assert "gitHubTelemetry.event" in client._client.notification_method_handlers + assert "gitHubTelemetry.event" not in client._client.request_handlers + + # Drive a real id-less notification frame through the dispatcher to + # exercise the full from_dict decode + adapter + user-callback path. + client._client._handle_message( + { + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": { + "sessionId": "sess-telemetry", + "restricted": True, + "event": { + "kind": "tool_call_executed", + "metrics": {"duration_ms": 12.5}, + "properties": {"tool": "shell"}, + "session_id": "sess-telemetry", + }, + }, + } + ) + + # Notifications dispatch onto the event loop; yield until delivered. + for _ in range(100): + if received: + break + await asyncio.sleep(0.01) + + assert len(received) == 1 + notification = received[0] + assert isinstance(notification, GitHubTelemetryNotification) + assert notification.session_id == "sess-telemetry" + assert notification.restricted is True + assert notification.event.kind == "tool_call_executed" + assert notification.event.metrics["duration_ms"] == 12.5 + assert notification.event.properties["tool"] == "shell" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_event_routes_to_async_handler(self): + from copilot.generated.rpc import GitHubTelemetryNotification + + received: list = [] + delivered = asyncio.Event() + + async def on_telemetry(notification): + await asyncio.sleep(0) + received.append(notification) + delivered.set() + + client = CopilotClient( + connection=RuntimeConnection.for_stdio(path=CLI_PATH), + on_github_telemetry=on_telemetry, + ) + await client.start() + + try: + client._client._handle_message( + { + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": { + "sessionId": "sess-async-telemetry", + "restricted": False, + "event": { + "kind": "tool_call_executed", + "metrics": {"duration_ms": 3.5}, + "properties": {"tool": "python"}, + "session_id": "sess-async-telemetry", + }, + }, + } + ) + + await asyncio.wait_for(delivered.wait(), timeout=1) + + assert len(received) == 1 + notification = received[0] + assert isinstance(notification, GitHubTelemetryNotification) + assert notification.session_id == "sess-async-telemetry" + assert notification.restricted is False + assert notification.event.kind == "tool_call_executed" + assert notification.event.metrics["duration_ms"] == 3.5 + assert notification.event.properties["tool"] == "python" + finally: + await client.force_stop() + + @pytest.mark.asyncio + async def test_event_not_forwarded_without_option(self): + # Client-global handlers are always registered (so that hooks.invoke works), + # but without the on_github_telemetry option the telemetry adapter is inert: + # incoming events must not be forwarded to any callback. + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + + try: + assert client._on_github_telemetry is None + + # Dispatching a telemetry event is a harmless no-op when not opted in. + client._client._handle_message( + { + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": { + "sessionId": "sess-no-telemetry", + "restricted": False, + "event": { + "kind": "tool_call_executed", + "metrics": {"duration_ms": 1.0}, + "properties": {"tool": "shell"}, + "session_id": "sess-no-telemetry", + }, + }, + } + ) + await asyncio.sleep(0) + finally: + await client.force_stop() diff --git a/python/test_codegen_type_names.py b/python/test_codegen_type_names.py new file mode 100644 index 000000000..5242f1c78 --- /dev/null +++ b/python/test_codegen_type_names.py @@ -0,0 +1,29 @@ +import re +import types + +from copilot.generated import rpc + + +def test_permission_approval_exports_are_union_aliases(): + approval_exports = [ + name + for name in rpc.__all__ + if re.fullmatch(r"PermissionDecisionApproveFor.*Approval", name) + ] + assert approval_exports + + for name in approval_exports: + exported = getattr(rpc, name) + assert isinstance(exported, types.UnionType), ( + f"{name} must be a union alias, not a synthetic dataclass" + ) + + +def test_permission_approval_union_loaders_deserialize_expected_variants(): + session = rpc._load_PermissionDecisionApproveForSessionApproval( + {"kind": "commands", "commandIdentifiers": ["git status"]} + ) + location = rpc._load_PermissionDecisionApproveForLocationApproval({"kind": "read"}) + + assert isinstance(session, rpc.PermissionDecisionApproveForSessionApprovalCommands) + assert isinstance(location, rpc.PermissionDecisionApproveForLocationApprovalRead) diff --git a/python/test_commands_and_elicitation.py b/python/test_commands_and_elicitation.py index 8f1a64074..b1905b935 100644 --- a/python/test_commands_and_elicitation.py +++ b/python/test_commands_and_elicitation.py @@ -155,7 +155,7 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request # Simulate a command.execute broadcast event - from copilot.generated.session_events import ( + from copilot.session_events import ( CommandExecuteData, SessionEvent, SessionEventType, @@ -223,7 +223,7 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request - from copilot.generated.session_events import ( + from copilot.session_events import ( CommandExecuteData, SessionEvent, SessionEventType, @@ -277,7 +277,7 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request - from copilot.generated.session_events import ( + from copilot.session_events import ( CommandExecuteData, SessionEvent, SessionEventType, @@ -675,7 +675,7 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request - from copilot.generated.session_events import ( + from copilot.session_events import ( ElicitationRequestedData, SessionEvent, SessionEventType, @@ -734,7 +734,7 @@ async def mock_request(method, params, **kwargs): client._client.request = mock_request - from copilot.generated.session_events import ( + from copilot.session_events import ( ElicitationRequestedData, ElicitationRequestedSchema, SessionEvent, @@ -793,7 +793,7 @@ async def test_capabilities_changed_event_updates_session(self): ) session._set_capabilities({}) - from copilot.generated.session_events import ( + from copilot.session_events import ( CapabilitiesChangedData, CapabilitiesChangedUI, SessionEvent, diff --git a/python/test_e2e_harness_cli_path.py b/python/test_e2e_harness_cli_path.py new file mode 100644 index 000000000..8a50ba7a5 --- /dev/null +++ b/python/test_e2e_harness_cli_path.py @@ -0,0 +1,146 @@ +"""Unit tests for the E2E harness's Copilot CLI platform-package resolution. + +Regression coverage for github/copilot-sdk#2103: the harness used to return the +first ``@github/copilot-*`` directory in alphabetical order instead of the package +built for the current platform. +""" + +from __future__ import annotations + +from pathlib import Path + +import pytest + +from copilot._cli_version import get_npm_platform +from e2e.testharness import context + + +def _make_package(github_modules: Path, name: str) -> Path: + """Create ``//index.js`` and return the entrypoint path.""" + package_dir = github_modules / name + package_dir.mkdir(parents=True, exist_ok=True) + index = package_dir / "index.js" + index.write_text("// fake CLI entrypoint\n") + return index + + +class TestCliPlatformPackageNames: + def test_non_linux_platform_yields_single_candidate(self): + assert context._cli_platform_package_names("darwin-arm64") == ["copilot-darwin-arm64"] + + def test_windows_platform_yields_single_candidate(self): + assert context._cli_platform_package_names("win32-x64") == ["copilot-win32-x64"] + + def test_glibc_linux_also_considers_musl_variant(self): + assert context._cli_platform_package_names("linux-x64") == [ + "copilot-linux-x64", + "copilot-linuxmusl-x64", + ] + + def test_musl_linux_prefers_musl_then_falls_back_to_glibc(self): + assert context._cli_platform_package_names("linuxmusl-arm64") == [ + "copilot-linuxmusl-arm64", + "copilot-linux-arm64", + ] + + def test_defaults_to_current_host_platform(self): + assert context._cli_platform_package_names()[0] == f"copilot-{get_npm_platform()}" + + +class TestFindCliInNodeModules: + def test_skips_alphabetically_earlier_foreign_package(self, tmp_path): + # The #2103 regression: "aardvark" sorts before every real platform name. + _make_package(tmp_path, "copilot-aardvark-x64") + expected = _make_package(tmp_path, "copilot-darwin-arm64") + found = context._find_cli_in_node_modules(tmp_path, ["copilot-darwin-arm64"]) + assert found == str(expected.resolve()) + + def test_returns_none_when_no_candidate_is_installed(self, tmp_path): + _make_package(tmp_path, "copilot-win32-x64") + assert context._find_cli_in_node_modules(tmp_path, ["copilot-darwin-arm64"]) is None + + def test_ignores_non_platform_copilot_packages(self, tmp_path): + _make_package(tmp_path, "copilot-language-server") + assert context._find_cli_in_node_modules(tmp_path, ["copilot-linux-x64"]) is None + + def test_prefers_earlier_candidate_when_both_libc_variants_exist(self, tmp_path): + expected = _make_package(tmp_path, "copilot-linuxmusl-x64") + _make_package(tmp_path, "copilot-linux-x64") + found = context._find_cli_in_node_modules( + tmp_path, ["copilot-linuxmusl-x64", "copilot-linux-x64"] + ) + assert found == str(expected.resolve()) + + def test_returns_none_when_package_dir_has_no_index_js(self, tmp_path): + (tmp_path / "copilot-linux-x64").mkdir() + assert context._find_cli_in_node_modules(tmp_path, ["copilot-linux-x64"]) is None + + def test_returns_none_when_github_modules_is_absent(self, tmp_path): + missing = tmp_path / "missing" + assert context._find_cli_in_node_modules(missing, ["copilot-linux-x64"]) is None + + +class TestInstalledCliPackageNames: + def test_lists_platform_directories_sorted(self, tmp_path): + _make_package(tmp_path, "copilot-win32-x64") + _make_package(tmp_path, "copilot-darwin-arm64") + (tmp_path / "not-copilot").mkdir() + assert context._installed_cli_package_names(tmp_path) == [ + "copilot-darwin-arm64", + "copilot-win32-x64", + ] + + def test_returns_empty_when_directory_is_absent(self, tmp_path): + assert context._installed_cli_package_names(tmp_path / "missing") == [] + + +class TestGetCliPathForTests: + def test_env_var_takes_precedence(self, tmp_path, monkeypatch): + cli = tmp_path / "custom-cli.js" + cli.write_text("// custom entrypoint\n") + monkeypatch.setenv("COPILOT_CLI_PATH", str(cli)) + assert context.get_cli_path_for_tests() == str(cli.resolve()) + + def test_error_names_the_packages_tried_and_the_remedy(self, monkeypatch): + monkeypatch.delenv("COPILOT_CLI_PATH", raising=False) + monkeypatch.setattr( + context, "_cli_platform_package_names", lambda *_: ["copilot-linux-x64"] + ) + monkeypatch.setattr(context, "_find_cli_in_node_modules", lambda *_: None) + with pytest.raises(RuntimeError) as excinfo: + context.get_cli_path_for_tests() + message = str(excinfo.value) + assert "copilot-linux-x64" in message + assert "npm install" in message + assert "COPILOT_CLI_PATH" in message + + def test_error_names_the_searched_directory(self, monkeypatch): + monkeypatch.delenv("COPILOT_CLI_PATH", raising=False) + seen: list[Path] = [] + + def fake_find(github_modules, package_names): + seen.append(github_modules) + return None + + monkeypatch.setattr(context, "_cli_platform_package_names", lambda *_: ["copilot-nope-x64"]) + monkeypatch.setattr(context, "_find_cli_in_node_modules", fake_find) + with pytest.raises(RuntimeError) as excinfo: + context.get_cli_path_for_tests() + assert seen, "get_cli_path_for_tests must consult _find_cli_in_node_modules" + assert seen[0].name == "@github" + assert seen[0].parent.name == "node_modules" + assert seen[0].parent.parent.name == "nodejs" + assert str(seen[0]) in str(excinfo.value) + + def test_error_lists_the_packages_actually_installed(self, monkeypatch): + monkeypatch.delenv("COPILOT_CLI_PATH", raising=False) + monkeypatch.setattr(context, "_cli_platform_package_names", lambda *_: ["copilot-nope-x64"]) + monkeypatch.setattr(context, "_find_cli_in_node_modules", lambda *_: None) + monkeypatch.setattr( + context, "_installed_cli_package_names", lambda *_: ["copilot-darwin-arm64"] + ) + with pytest.raises(RuntimeError) as excinfo: + context.get_cli_path_for_tests() + message = str(excinfo.value) + assert "present: copilot-darwin-arm64" in message + assert "copilot-nope-x64" in message diff --git a/python/test_event_forward_compatibility.py b/python/test_event_forward_compatibility.py index 8950f839b..2e8015a97 100644 --- a/python/test_event_forward_compatibility.py +++ b/python/test_event_forward_compatibility.py @@ -12,18 +12,20 @@ import pytest -from copilot.generated.session_events import ( +from copilot.session_events import ( + AttachmentGitHubReferenceType, Data, ElicitationCompletedAction, ElicitationRequestedMode, ElicitationRequestedSchema, + ManagedSettingsResolvedSource, PermissionPromptRequestMemory, PermissionRequestMemory, PermissionRequestMemoryAction, SessionEventType, + SessionManagedSettingsResolvedData, SessionTaskCompleteData, UserMessageAgentMode, - UserMessageAttachmentGithubReferenceType, session_event_from_dict, session_event_to_dict, ) @@ -49,6 +51,20 @@ def test_unknown_event_type_maps_to_unknown(self): event = session_event_from_dict(unknown_event) assert event.type == SessionEventType.UNKNOWN, f"Expected UNKNOWN, got {event.type}" + def test_internal_event_type_maps_to_unknown(self): + """Internal events should use the forward-compatible raw event path.""" + internal_event = { + "id": str(uuid4()), + "timestamp": datetime.now().isoformat(), + "parentId": None, + "type": "session.memory_changed", + "data": {}, + } + + event = session_event_from_dict(internal_event) + assert event.type == SessionEventType.UNKNOWN + assert session_event_to_dict(event)["type"] == "session.memory_changed" + def test_known_event_preserves_top_level_agent_id(self): """Known events should preserve the top-level sub-agent envelope ID.""" known_event = { @@ -115,13 +131,49 @@ def test_explicit_generated_symbols_remain_available(self): assert ElicitationCompletedAction.ACCEPT.value == "accept" assert UserMessageAgentMode.INTERACTIVE.value == "interactive" assert ElicitationRequestedMode.FORM.value == "form" - assert UserMessageAttachmentGithubReferenceType.PR.value == "pr" + assert AttachmentGitHubReferenceType.PR.value == "pr" schema = ElicitationRequestedSchema( properties={"answer": {"type": "string"}}, type="object" ) assert schema.to_dict()["type"] == "object" + def test_managed_settings_client_provenance_round_trips(self): + """Managed settings events should preserve truthful client provenance.""" + assert [source.value for source in ManagedSettingsResolvedSource] == [ + "server", + "device", + "client", + "mixed", + "none", + ] + + client = SessionManagedSettingsResolvedData( + bypass_permissions_disabled=True, + client_managed=True, + device_managed=False, + fail_closed=False, + managed_keys=["permissions"], + server_managed=False, + source=ManagedSettingsResolvedSource.CLIENT, + ) + serialized = client.to_dict() + assert serialized["source"] == "client" + assert serialized["clientManaged"] is True + assert SessionManagedSettingsResolvedData.from_dict(serialized) == client + + mixed = SessionManagedSettingsResolvedData( + bypass_permissions_disabled=True, + device_managed=True, + fail_closed=False, + managed_keys=["permissions"], + server_managed=True, + source=ManagedSettingsResolvedSource.MIXED, + ) + serialized = mixed.to_dict() + assert serialized["source"] == "mixed" + assert "clientManaged" not in serialized + def test_data_shim_preserves_raw_mapping_values(self): """Compatibility Data should keep arbitrary nested mappings as plain dicts.""" parsed = Data.from_dict( @@ -138,6 +190,22 @@ def test_data_shim_preserves_raw_mapping_values(self): constructed = Data(arguments={"tool_call_id": "call-1"}) assert constructed.to_dict() == {"arguments": {"tool_call_id": "call-1"}} + def test_data_shim_preserves_abbreviation_json_keys_on_round_trip(self): + """Data.from_dict(x).to_dict() should preserve JSON keys with abbreviations. + + Regression test for github/copilot-sdk#1138: keys like userURL, sessionID, + and OAuthToken were rewritten on round-trip because _compat_to_json_key could + not reconstruct the original camelCase abbreviation casing. + """ + for key in ["userURL", "sessionID", "XMLPayload", "serverIP", "OAuthToken"]: + incoming = {key: 42} + assert Data.from_dict(incoming).to_dict() == incoming + + def test_data_shim_preserves_colliding_json_keys_on_round_trip(self): + """Data.from_dict(x).to_dict() should preserve keys with the same Python name.""" + colliding_keys = {"userURL": 42, "userUrl": 43} + assert Data.from_dict(colliding_keys).to_dict() == colliding_keys + def test_missing_optional_fields_remain_none_after_parsing(self): """Generated event models should leave missing optional fields as None. diff --git a/python/test_managed_permissions.py b/python/test_managed_permissions.py new file mode 100644 index 000000000..ca07556da --- /dev/null +++ b/python/test_managed_permissions.py @@ -0,0 +1,121 @@ +import pytest + +from copilot.rpc import PermissionDecisionApproveOnce, PermissionDecisionUserNotAvailable +from copilot.session import CopilotSession, PermissionHandler, PermissionNoResult +from copilot.session_events import ( + PermissionRequestCustomTool, + PermissionRequestedData, + PermissionRequestRead, +) + + +def test_permission_event_exposes_managed_approval_required() -> None: + data = PermissionRequestedData.from_dict( + { + "permissionRequest": { + "kind": "read", + "intention": "Read managed content", + "path": "/workspace/file.txt", + "managedApprovalRequired": True, + }, + "requestId": "permission-1", + } + ) + + assert data.permission_request.managed_approval_required is True + assert data.to_dict()["permissionRequest"]["managedApprovalRequired"] is True + + +def test_managed_metadata_preserves_existing_positional_constructor_order() -> None: + request = PermissionRequestCustomTool( + "Run a custom tool", + "custom_tool", + {"value": 1}, + "tool-call-1", + ) + + assert request.tool_call_id == "tool-call-1" + assert request.managed_approval_required is None + + read_request = PermissionRequestRead( + "Read content", + "/workspace/file.txt", + True, + False, + "Use the sandbox", + "tool-call-2", + ) + + assert read_request.managed_approval_required is True + assert read_request.request_sandbox_bypass is False + assert read_request.request_sandbox_bypass_reason == "Use the sandbox" + assert read_request.tool_call_id == "tool-call-2" + + +def test_approve_all_rejects_managed_settings_session() -> None: + request = PermissionRequestRead( + intention="Read ordinary content", + path="/workspace/file.txt", + ) + + with pytest.raises(RuntimeError, match="managed settings are enabled"): + PermissionHandler.approve_all( + request, + {"session_id": "session-1", "managed_settings_enabled": True}, + ) + + +def test_approve_all_rejects_managed_request_in_managed_settings_session() -> None: + request = PermissionRequestRead( + intention="Read managed content", + path="/workspace/file.txt", + managed_approval_required=True, + ) + + with pytest.raises(RuntimeError, match="managed settings are enabled"): + PermissionHandler.approve_all( + request, + {"session_id": "session-1", "managed_settings_enabled": True}, + ) + + +def test_approve_all_approves_ordinary_request() -> None: + request = PermissionRequestRead( + intention="Read ordinary content", + path="/workspace/file.txt", + ) + + assert isinstance( + PermissionHandler.approve_all( + request, + {"session_id": "session-1", "managed_settings_enabled": False}, + ), + PermissionDecisionApproveOnce, + ) + + +def test_approve_all_leaves_managed_request_pending_when_session_flag_is_absent() -> None: + request = PermissionRequestRead( + intention="Read managed content", + path="/workspace/file.txt", + managed_approval_required=True, + ) + + assert isinstance( + PermissionHandler.approve_all(request, {"session_id": "session-1"}), + PermissionNoResult, + ) + + +async def test_legacy_permission_callback_rejects_no_result() -> None: + request = PermissionRequestRead( + intention="Read managed content", + path="/workspace/file.txt", + managed_approval_required=True, + ) + session = CopilotSession("session-1", client=None) + session._register_permission_handler(lambda _request, _invocation: PermissionNoResult()) + + result = await session._handle_permission_request(request) + + assert isinstance(result, PermissionDecisionUserNotAvailable) diff --git a/python/test_permission_decision_context.py b/python/test_permission_decision_context.py new file mode 100644 index 000000000..2b013942d --- /dev/null +++ b/python/test_permission_decision_context.py @@ -0,0 +1,99 @@ +from unittest.mock import AsyncMock, MagicMock + +from copilot.rpc import ( + PermissionDecisionApproveOnce, + PermissionDecisionContext, + PermissionDecisionOutcome, + PermissionDecisionSource, + PermissionDecisionSurface, +) +from copilot.session import ( + AttributedPermissionResult, + CopilotSession, + PermissionNoResult, + create_attributed_permission_result, +) +from copilot.session_events import PermissionRequestRead + + +def _context() -> PermissionDecisionContext: + return PermissionDecisionContext( + outcome=PermissionDecisionOutcome.AUTO_APPROVED, + source=PermissionDecisionSource.HOST_POLICY, + surface=PermissionDecisionSurface.SDK, + ) + + +def _session_with_captured_rpc() -> tuple[CopilotSession, AsyncMock]: + session = CopilotSession("session-1", client=None) + handle = AsyncMock() + rpc = MagicMock() + rpc.permissions.handle_pending_permission_request = handle + session._rpc = rpc + return session, handle + + +async def test_decision_context_serialized_as_sibling_of_result() -> None: + session, handle = _session_with_captured_rpc() + request = PermissionRequestRead(intention="Read", path="/workspace/file.txt") + + def handler(_request, _invocation): + return create_attributed_permission_result(PermissionDecisionApproveOnce(), _context()) + + await session._execute_permission_and_respond("permission-1", request, handler) + + handle.assert_awaited_once() + sent = handle.await_args.args[0] + params = sent.to_dict() + + assert params["decisionContext"] == { + "outcome": "auto_approved", + "source": "host_policy", + "surface": "sdk", + } + assert "decisionContext" not in params["result"] + assert params["result"]["kind"] == "approve-once" + + +async def test_no_context_omits_decision_context_key() -> None: + session, handle = _session_with_captured_rpc() + request = PermissionRequestRead(intention="Read", path="/workspace/file.txt") + + def handler(_request, _invocation): + return PermissionDecisionApproveOnce() + + await session._execute_permission_and_respond("permission-1", request, handler) + + handle.assert_awaited_once() + params = handle.await_args.args[0].to_dict() + + assert "decisionContext" not in params + assert params["result"]["kind"] == "approve-once" + + +def test_attributed_result_replaces_rather_than_nests() -> None: + first = PermissionDecisionContext( + outcome=PermissionDecisionOutcome.PROMPTED_USER, + source=PermissionDecisionSource.HUMAN_RESPONSE, + surface=PermissionDecisionSurface.TUI, + ) + second = _context() + + once_wrapped = create_attributed_permission_result(PermissionDecisionApproveOnce(), first) + twice_wrapped = create_attributed_permission_result(once_wrapped, second) + + assert isinstance(twice_wrapped, AttributedPermissionResult) + assert isinstance(twice_wrapped.result, PermissionDecisionApproveOnce) + assert twice_wrapped.decision_context is second + + +async def test_no_result_with_context_still_suppresses_response() -> None: + session, handle = _session_with_captured_rpc() + request = PermissionRequestRead(intention="Read", path="/workspace/file.txt") + + def handler(_request, _invocation): + return create_attributed_permission_result(PermissionNoResult(), _context()) + + await session._execute_permission_and_respond("permission-1", request, handler) + + handle.assert_not_awaited() diff --git a/python/test_rpc_generated.py b/python/test_rpc_generated.py index 5d003da42..5556a77c3 100644 --- a/python/test_rpc_generated.py +++ b/python/test_rpc_generated.py @@ -1,12 +1,21 @@ """Tests for generated RPC method behavior.""" +import json from unittest.mock import AsyncMock import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( CommandsApi, CommandsInvokeRequest, + CommandsRespondToQueuedCommandRequest, + LocalSessionMetadataValue, + QueuedCommandHandled, + QueuedCommandNotHandled, + RemoteControlStatusOff, + RemoteControlStatusResult, + RemoteSessionMetadataValue, + SessionList, SlashCommandTextResult, ) @@ -22,3 +31,77 @@ async def test_commands_invoke_deserializes_slash_command_result(): assert isinstance(result, SlashCommandTextResult) assert result.text == "hello" assert result.markdown is True + + +def test_remote_control_status_deserializes_string_discriminated_union(): + result = RemoteControlStatusResult.from_dict({"status": {"state": "off"}}) + + assert isinstance(result.status, RemoteControlStatusOff) + assert result.status.state == "off" + assert result.status.to_dict() == {"state": "off"} + + +def test_session_list_deserializes_boolean_discriminated_entries(): + payload = { + "sessions": [ + { + "sessionId": "example-local", + "startTime": "2026-07-26T10:00:00.000Z", + "modifiedTime": "2026-07-26T10:05:00.000Z", + "isRemote": False, + }, + { + "sessionId": "example-remote", + "startTime": "2026-07-26T11:00:00.000Z", + "modifiedTime": "2026-07-26T11:05:00.000Z", + "isRemote": True, + "remoteSessionIds": ["example-remote"], + "repository": {"owner": "github", "name": "copilot-sdk", "branch": "main"}, + }, + ] + } + + result = SessionList.from_dict(payload) + + local, remote = result.sessions + assert isinstance(local, LocalSessionMetadataValue) + assert local.session_id == "example-local" + assert local.is_remote is False + assert isinstance(remote, RemoteSessionMetadataValue) + assert remote.session_id == "example-remote" + assert remote.is_remote is True + assert remote.repository.owner == "github" + + +@pytest.mark.parametrize( + ("handled", "expected_type"), + [(True, QueuedCommandHandled), (False, QueuedCommandNotHandled)], +) +def test_queued_command_result_deserializes_boolean_discriminator(handled, expected_type): + request = CommandsRespondToQueuedCommandRequest.from_dict( + {"requestId": "example-request", "result": {"handled": handled}} + ) + + assert isinstance(request.result, expected_type) + + +@pytest.mark.parametrize( + ("variant", "expected_handled", "expected_json"), + [ + (QueuedCommandHandled(), True, '{"handled": true}'), + (QueuedCommandNotHandled(), False, '{"handled": false}'), + ], +) +def test_queued_command_result_serializes_boolean_discriminator( + variant, expected_handled, expected_json +): + encoded = variant.to_dict() + + assert encoded["handled"] is expected_handled + assert json.dumps(encoded) == expected_json + + request = CommandsRespondToQueuedCommandRequest(request_id="example-request", result=variant) + round_tripped = CommandsRespondToQueuedCommandRequest.from_dict(request.to_dict()) + + assert request.to_dict()["result"]["handled"] is expected_handled + assert isinstance(round_tripped.result, type(variant)) diff --git a/python/test_rpc_timeout.py b/python/test_rpc_timeout.py index 17254b08e..7e85729ca 100644 --- a/python/test_rpc_timeout.py +++ b/python/test_rpc_timeout.py @@ -4,7 +4,7 @@ import pytest -from copilot.generated.rpc import ( +from copilot.rpc import ( FleetApi, FleetStartRequest, ModeApi, @@ -13,9 +13,9 @@ PlanApi, ServerModelsApi, ServerToolsApi, - SessionMode, ToolsListRequest, ) +from copilot.session_events import SessionMode class TestRpcTimeout: diff --git a/python/test_telemetry.py b/python/test_telemetry.py index 6481fd525..8a34f19b2 100644 --- a/python/test_telemetry.py +++ b/python/test_telemetry.py @@ -77,6 +77,7 @@ def test_telemetry_env_var_mapping(self): """TelemetryConfig fields map to expected environment variable names.""" config: TelemetryConfig = { "otlp_endpoint": "http://localhost:4318", + "otlp_protocol": "http/protobuf", "file_path": "/tmp/traces.jsonl", "exporter_type": "file", "source_name": "test-app", @@ -87,6 +88,8 @@ def test_telemetry_env_var_mapping(self): env["COPILOT_OTEL_ENABLED"] = "true" if "otlp_endpoint" in config: env["OTEL_EXPORTER_OTLP_ENDPOINT"] = config["otlp_endpoint"] + if "otlp_protocol" in config: + env["OTEL_EXPORTER_OTLP_PROTOCOL"] = config["otlp_protocol"] if "file_path" in config: env["COPILOT_OTEL_FILE_EXPORTER_PATH"] = config["file_path"] if "exporter_type" in config: @@ -100,6 +103,7 @@ def test_telemetry_env_var_mapping(self): assert env["COPILOT_OTEL_ENABLED"] == "true" assert env["OTEL_EXPORTER_OTLP_ENDPOINT"] == "http://localhost:4318" + assert env["OTEL_EXPORTER_OTLP_PROTOCOL"] == "http/protobuf" assert env["COPILOT_OTEL_FILE_EXPORTER_PATH"] == "/tmp/traces.jsonl" assert env["COPILOT_OTEL_EXPORTER_TYPE"] == "file" assert env["COPILOT_OTEL_SOURCE_NAME"] == "test-app" diff --git a/python/test_tool_set.py b/python/test_tool_set.py index 6a65e0df2..0674b488a 100644 --- a/python/test_tool_set.py +++ b/python/test_tool_set.py @@ -6,6 +6,7 @@ from copilot import BUILTIN_TOOLS_ISOLATED, CopilotClient, ToolSet, UriRuntimeConnection from copilot._mode import ( + _custom_agents_local_only_default, _embedding_cache_storage_default, _enable_file_hooks_default, _enable_host_git_operations_default, @@ -198,6 +199,7 @@ class TestEmptyModeBooleanDefaults: (_enable_host_git_operations_default, False), (_enable_session_store_default, False), (_enable_skills_default, False), + (_custom_agents_local_only_default, True), ], ) def test_empty_mode_defaults(self, helper, empty_default): @@ -213,6 +215,7 @@ def test_empty_mode_defaults(self, helper, empty_default): _enable_host_git_operations_default, _enable_session_store_default, _enable_skills_default, + _custom_agents_local_only_default, ], ) def test_caller_wins(self, helper): @@ -229,6 +232,7 @@ def test_caller_wins(self, helper): _enable_host_git_operations_default, _enable_session_store_default, _enable_skills_default, + _custom_agents_local_only_default, ], ) def test_copilot_cli_does_not_change(self, helper): diff --git a/python/test_tools.py b/python/test_tools.py index d583b59c0..97de41df4 100644 --- a/python/test_tools.py +++ b/python/test_tools.py @@ -3,14 +3,17 @@ import json import pytest -from pydantic import BaseModel, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from copilot import define_tool +from copilot.generated.rpc import ExternalToolTextResultForLlm from copilot.tools import ( + ToolBinaryResult, ToolInvocation, ToolResult, _normalize_result, convert_mcp_call_tool_result, + tool_result_to_external_tool_text_result_for_llm, ) @@ -197,6 +200,91 @@ def failing_tool(params: Params, invocation: ToolInvocation) -> str: # But the actual error is stored internally assert result.error == "secret error message" + async def test_validation_error_is_surfaced_to_llm(self): + class Params(BaseModel): + username: str + + @field_validator("username") + @classmethod + def check_username(cls, v: str) -> str: + if v == "admin": + raise ValueError("username 'admin' is reserved") + return v + + @define_tool("validate", description="A validating tool") + def validating_tool(params: Params) -> str: + return "ok" + + invocation = ToolInvocation( + session_id="s1", + tool_call_id="c1", + tool_name="validate", + arguments={"username": "admin"}, + ) + + result = await validating_tool.handler(invocation) + + assert result.result_type == "failure" + assert result.text_result_for_llm.startswith("Invalid tool arguments:") + assert "username 'admin' is reserved" in result.text_result_for_llm + # Full detail is retained in the debug field. + assert result.error is not None + + async def test_validation_error_extra_forbid_includes_field_name(self): + class Params(BaseModel): + model_config = ConfigDict(extra="forbid") + + request: str + + @define_tool("strict", description="A strict tool") + def strict_tool(params: Params) -> str: + return "ok" + + invocation = ToolInvocation( + session_id="s1", + tool_call_id="c1", + tool_name="strict", + arguments={"request": "ok", "extra_field": "unexpected"}, + ) + + result = await strict_tool.handler(invocation) + + assert result.result_type == "failure" + assert result.text_result_for_llm.startswith("Invalid tool arguments:") + # The offending key name is carried in `loc` even though the generic + # message is "Extra inputs are not permitted". + assert "extra_field" in result.text_result_for_llm + assert result.error is not None + + async def test_validation_error_from_handler_body_is_redacted(self): + class Params(BaseModel): + pass + + class Internal(BaseModel): + count: int + + @define_tool("body", description="A tool that validates internally") + def body_tool(params: Params) -> str: + Internal.model_validate({"count": "secret-not-an-int"}) + return "ok" + + invocation = ToolInvocation( + session_id="s1", + tool_call_id="c1", + tool_name="body", + arguments={}, + ) + + result = await body_tool.handler(invocation) + + assert result.result_type == "failure" + # A ValidationError from the handler body must not be surfaced as an + # argument-validation error; it stays redacted like any other exception. + assert not result.text_result_for_llm.startswith("Invalid tool arguments:") + assert "secret-not-an-int" not in result.text_result_for_llm + assert "error" in result.text_result_for_llm.lower() + assert result.error is not None + async def test_function_style_api(self): class Params(BaseModel): value: str @@ -301,6 +389,44 @@ class Item(BaseModel): assert parsed == [{"name": "a", "value": 1}, {"name": "b", "value": 2}] assert result.result_type == "success" + def test_pydantic_model_with_non_primitive_fields_is_serialized(self): + from datetime import date, datetime + from decimal import Decimal + from enum import Enum + from uuid import UUID + + class Status(Enum): + ACTIVE = "active" + + class Record(BaseModel): + id: UUID + created: datetime + day: date + score: Decimal + status: Status + tags: set[str] + + record = Record( + id=UUID("12345678-1234-5678-1234-567812345678"), + created=datetime(2026, 1, 15, 10, 30, 0), + day=date(2026, 1, 15), + score=Decimal("99.5"), + status=Status.ACTIVE, + tags={"python", "sdk"}, + ) + result = _normalize_result(record) + parsed = json.loads(result.text_result_for_llm) + assert parsed == { + "id": "12345678-1234-5678-1234-567812345678", + "created": "2026-01-15T10:30:00", + "day": "2026-01-15", + "score": "99.5", + "status": "active", + "tags": parsed["tags"], + } + assert set(parsed["tags"]) == {"python", "sdk"} + assert result.result_type == "success" + def test_raises_for_unserializable_value(self): # Functions cannot be JSON serialized with pytest.raises(TypeError, match="Failed to serialize"): @@ -427,3 +553,84 @@ def test_call_tool_result_dict_is_json_serialized_by_normalize(self): result = _normalize_result({"content": [{"type": "text", "text": "hello"}]}) parsed = json.loads(result.text_result_for_llm) assert parsed == {"content": [{"type": "text", "text": "hello"}]} + + +class TestToolReferences: + def test_tool_references_pass_through_normalize(self): + input_result = ToolResult( + text_result_for_llm="found 2 tools", + result_type="success", + tool_references=["get_weather", "check_status"], + ) + result = _normalize_result(input_result) + assert result.tool_references == ["get_weather", "check_status"] + + def test_tool_references_serialized_to_wire(self): + wire = ExternalToolTextResultForLlm( + text_result_for_llm="found 2 tools", + result_type="success", + tool_references=["get_weather", "check_status"], + ) + data = wire.to_dict() + assert data["toolReferences"] == ["get_weather", "check_status"] + + def test_tool_references_omitted_when_none(self): + wire = ExternalToolTextResultForLlm( + text_result_for_llm="ok", + result_type="success", + ) + assert "toolReferences" not in wire.to_dict() + + def test_tool_references_round_trip_from_wire(self): + wire = ExternalToolTextResultForLlm.from_dict( + { + "textResultForLlm": "found tools", + "resultType": "success", + "toolReferences": ["alpha", "beta"], + } + ) + assert wire.tool_references == ["alpha", "beta"] + + +class TestToolResultToExternalToolTextResultForLlm: + def test_forwards_binary_results_and_session_log(self): + tool_result = ToolResult( + text_result_for_llm="screenshot captured", + binary_results_for_llm=[ + ToolBinaryResult( + data="base64data", + mime_type="image/png", + type="image", + description="screenshot.png", + ) + ], + session_log="tool execution details", + tool_telemetry={"duration_ms": 42}, + ) + + rpc_result = tool_result_to_external_tool_text_result_for_llm(tool_result) + + assert rpc_result.text_result_for_llm == "screenshot captured" + assert rpc_result.session_log == "tool execution details" + assert rpc_result.tool_telemetry == {"duration_ms": 42} + assert rpc_result.binary_results_for_llm is not None + assert len(rpc_result.binary_results_for_llm) == 1 + assert rpc_result.binary_results_for_llm[0].data == "base64data" + assert rpc_result.binary_results_for_llm[0].mime_type == "image/png" + assert rpc_result.binary_results_for_llm[0].type.value == "image" + assert rpc_result.binary_results_for_llm[0].description == "screenshot.png" + + def test_omits_binary_results_when_none(self): + tool_result = ToolResult(text_result_for_llm="done") + rpc_result = tool_result_to_external_tool_text_result_for_llm(tool_result) + assert rpc_result.binary_results_for_llm is None + assert rpc_result.session_log is None + + def test_forwards_tool_references(self): + tool_result = ToolResult( + text_result_for_llm="found tools", + result_type="success", + tool_references=["get_weather", "check_status"], + ) + rpc_result = tool_result_to_external_tool_text_result_for_llm(tool_result) + assert rpc_result.tool_references == ["get_weather", "check_status"] diff --git a/rust/.gitignore b/rust/.gitignore index c4095ffc0..c149fa394 100644 --- a/rust/.gitignore +++ b/rust/.gitignore @@ -1,3 +1,4 @@ /target Cargo.lock.bak cli-version.txt +cli-version-in-process.txt diff --git a/rust/Cargo.lock b/rust/Cargo.lock index 1676f2f91..8de679798 100644 --- a/rust/Cargo.lock +++ b/rust/Cargo.lock @@ -43,6 +43,12 @@ dependencies = [ "syn", ] +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + [[package]] name = "base64" version = "0.22.1" @@ -70,6 +76,12 @@ version = "3.20.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5d20789868f4b01b2f2caec9f5c4e0213b41e3e5702a50157d699ae31ced2fcb" +[[package]] +name = "byteorder" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + [[package]] name = "bytes" version = "1.11.1" @@ -92,6 +104,22 @@ version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + [[package]] name = "cpufeatures" version = "0.2.17" @@ -126,6 +154,12 @@ dependencies = [ "typenum", ] +[[package]] +name = "data-encoding" +version = "2.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4ae5f15dda3c708c0ade84bfee31ccab44a3da4f88015ed22f63732abe300c8" + [[package]] name = "derive_arbitrary" version = "1.4.2" @@ -246,12 +280,33 @@ dependencies = [ "miniz_oxide", ] +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + [[package]] name = "foldhash" version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" +[[package]] +name = "foreign-types" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1" +dependencies = [ + "foreign-types-shared", +] + +[[package]] +name = "foreign-types-shared" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" + [[package]] name = "form_urlencoded" version = "1.2.2" @@ -261,6 +316,15 @@ dependencies = [ "percent-encoding", ] +[[package]] +name = "futures-channel" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07bbe89c50d7a535e539b8c17bc0b49bdb77747034daa8087407d655f3f7cc1d" +dependencies = [ + "futures-core", +] + [[package]] name = "futures-core" version = "0.3.32" @@ -278,6 +342,23 @@ dependencies = [ "futures-util", ] +[[package]] +name = "futures-io" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cecba35d7ad927e23624b22ad55235f2239cfa44fd10428eecbeba6d6a717718" + +[[package]] +name = "futures-macro" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e835b70203e41293343137df5c0664546da5745f82ec9b84d40be8336958447b" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "futures-sink" version = "0.3.32" @@ -297,7 +378,11 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "389ca41296e6190b48053de0321d02a77f32f8a5d2461dd38762c0593805c6d6" dependencies = [ "futures-core", + "futures-io", + "futures-macro", + "futures-sink", "futures-task", + "memchr", "pin-project-lite", "slab", ] @@ -341,11 +426,19 @@ name = "github-copilot-sdk" version = "0.0.0-dev" dependencies = [ "async-trait", + "base64", + "bytes", "dirs", "flate2", + "futures-util", "getrandom 0.2.17", + "http", + "indexmap", + "libloading", + "native-tls", "parking_lot", "regex", + "reqwest", "rusqlite", "schemars", "serde", @@ -356,6 +449,7 @@ dependencies = [ "tempfile", "tokio", "tokio-stream", + "tokio-tungstenite", "tokio-util", "tracing", "ureq", @@ -363,6 +457,25 @@ dependencies = [ "zip", ] +[[package]] +name = "h2" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6cb093c84e8bd9b188d4c4a8cb6579fc016968d14c99882163cd3ff402a4f155" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap", + "slab", + "tokio", + "tokio-util", + "tracing", +] + [[package]] name = "hashbrown" version = "0.15.5" @@ -393,6 +506,120 @@ version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" +[[package]] +name = "http" +version = "1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6970f50e31d6fc17d3fa27329444bfa74e196cf62e95052a3f6fee181dba6425" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1efedce1fb8e6913f23e0c92de8e62cd5b772a67e7b3946df930a62566c93184" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b021d93e26becf5dc7e1b75b1bed1fd93124b374ceb73f43d4d4eafec896a64a" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "hyper" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "55281c53a1894c864990125767da440a4e630446785086f52523b20033b74498" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "h2", + "http", + "http-body", + "httparse", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33ca68d021ef39cf6463ab54c1d0f5daf03377b70561305bb89a8f83aab66e0f" +dependencies = [ + "http", + "hyper", + "hyper-util", + "rustls", + "tokio", + "tokio-rustls", + "tower-service", +] + +[[package]] +name = "hyper-tls" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0" +dependencies = [ + "bytes", + "http-body-util", + "hyper", + "hyper-util", + "native-tls", + "tokio", + "tokio-native-tls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96547c2556ec9d12fb1578c4eaf448b04993e7fb79cbaad930a656880a6bdfa0" +dependencies = [ + "base64", + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2", + "tokio", + "tower-service", + "tracing", +] + [[package]] name = "icu_collections" version = "2.2.0" @@ -514,12 +741,29 @@ dependencies = [ "serde_core", ] +[[package]] +name = "ipnet" +version = "2.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d98f6fed1fde3f8c21bc40a1abb88dd75e67924f9cffc3ef95607bad8017f8e2" + [[package]] name = "itoa" version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" +[[package]] +name = "js-sys" +version = "0.3.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03d04c30968dffe80775bd4d7fb676131cd04a1fb46d2686dbffbaec2d9dfd31" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + [[package]] name = "leb128fmt" version = "0.1.0" @@ -532,6 +776,16 @@ version = "0.2.186" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66" +[[package]] +name = "libloading" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7c4b02199fee7c5d21a5ae7d8cfa79a6ef5bb2fc834d6e9058e89c825efdc55" +dependencies = [ + "cfg-if", + "windows-link", +] + [[package]] name = "libredox" version = "0.1.16" @@ -609,12 +863,72 @@ dependencies = [ "windows-sys 0.61.2", ] +[[package]] +name = "native-tls" +version = "0.2.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "465500e14ea162429d264d44189adc38b199b62b1c21eea9f69e4b73cb03bbf2" +dependencies = [ + "libc", + "log", + "openssl", + "openssl-probe", + "openssl-sys", + "schannel", + "security-framework", + "security-framework-sys", + "tempfile", +] + [[package]] name = "once_cell" version = "1.21.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +[[package]] +name = "openssl" +version = "0.10.81" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77823a27f0babb03091cb9ed9ef80af3b39dbc82f97e8fa530374b7dafd87a45" +dependencies = [ + "bitflags", + "cfg-if", + "foreign-types", + "libc", + "openssl-macros", + "openssl-sys", +] + +[[package]] +name = "openssl-macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "openssl-probe" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c87def4c32ab89d880effc9e097653c8da5d6ef28e6b539d313baaacfbafcbe" + +[[package]] +name = "openssl-sys" +version = "0.9.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b47e7e6bb2c38cd930d25a23b40fa52e068c10e85f3e03a7f5ba5aaca5713695" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + [[package]] name = "option-ext" version = "0.2.0" @@ -677,6 +991,15 @@ dependencies = [ "zerovec", ] +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy", +] + [[package]] name = "prettyplease" version = "0.2.37" @@ -711,6 +1034,36 @@ version = "6.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" +[[package]] +name = "rand" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca0ecfa931c29007047d1bc58e623ab12e5590e8c7cc53200d5202b69266d8a" +dependencies = [ + "libc", + "rand_chacha", + "rand_core", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core", +] + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom 0.2.17", +] + [[package]] name = "redox_syscall" version = "0.5.18" @@ -789,6 +1142,47 @@ version = "0.8.10" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a" +[[package]] +name = "reqwest" +version = "0.12.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eddd3ca559203180a307f12d114c268abf583f59b03cb906fd0b3ff8646c1147" +dependencies = [ + "base64", + "bytes", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-tls", + "hyper-util", + "js-sys", + "log", + "native-tls", + "percent-encoding", + "pin-project-lite", + "rustls-pki-types", + "serde", + "serde_json", + "serde_urlencoded", + "sync_wrapper", + "tokio", + "tokio-native-tls", + "tokio-util", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "wasm-streams", + "web-sys", +] + [[package]] name = "ring" version = "0.17.14" @@ -836,9 +1230,7 @@ version = "0.23.40" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ef86cd5876211988985292b91c96a8f2d298df24e75989a43a3c73f2d4d8168b" dependencies = [ - "log", "once_cell", - "ring", "rustls-pki-types", "rustls-webpki", "subtle", @@ -865,6 +1257,18 @@ dependencies = [ "untrusted", ] +[[package]] +name = "rustversion" +version = "1.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" + +[[package]] +name = "ryu" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f" + [[package]] name = "scc" version = "2.4.0" @@ -874,6 +1278,15 @@ dependencies = [ "sdd", ] +[[package]] +name = "schannel" +version = "0.1.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91c1b7e4904c873ef0710c1f407dde2e6287de2bebc1bbbf7d430bb7cbffd939" +dependencies = [ + "windows-sys 0.61.2", +] + [[package]] name = "schemars" version = "1.2.1" @@ -911,6 +1324,29 @@ version = "3.0.10" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "490dcfcbfef26be6800d11870ff2df8774fa6e86d047e3e8c8a76b25655e41ca" +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags", + "core-foundation", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + [[package]] name = "semver" version = "1.0.28" @@ -971,6 +1407,18 @@ dependencies = [ "zmij", ] +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + [[package]] name = "serial_test" version = "3.4.0" @@ -997,6 +1445,17 @@ dependencies = [ "syn", ] +[[package]] +name = "sha1" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3bf829a2d51ab4a5ddf1352d8470c140cadc8301b2ae1789db023f01cedd6ba" +dependencies = [ + "cfg-if", + "cpufeatures", + "digest", +] + [[package]] name = "sha2" version = "0.10.9" @@ -1075,6 +1534,15 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + [[package]] name = "synstructure" version = "0.13.2" @@ -1088,9 +1556,9 @@ dependencies = [ [[package]] name = "tar" -version = "0.4.45" +version = "0.4.46" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "22692a6476a21fa75fdfc11d452fda482af402c008cdbaf3476414e122040973" +checksum = "3f6221d9a6003c78398e3b239969f352578258df48c8eb051caadae0015bc840" dependencies = [ "filetime", "libc", @@ -1187,6 +1655,26 @@ dependencies = [ "syn", ] +[[package]] +name = "tokio-native-tls" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2" +dependencies = [ + "native-tls", + "tokio", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1729aa945f29d91ba541258c8df89027d5792d85a8841fb65e8bf0f4ede4ef61" +dependencies = [ + "rustls", + "tokio", +] + [[package]] name = "tokio-stream" version = "0.1.18" @@ -1199,6 +1687,20 @@ dependencies = [ "tokio-util", ] +[[package]] +name = "tokio-tungstenite" +version = "0.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "edc5f74e248dc973e0dbb7b74c7e0d6fcc301c694ff50049504004ef4d0cdcd9" +dependencies = [ + "futures-util", + "log", + "native-tls", + "tokio", + "tokio-native-tls", + "tungstenite", +] + [[package]] name = "tokio-util" version = "0.7.18" @@ -1212,6 +1714,51 @@ dependencies = [ "tokio", ] +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cfcf7e2740e6fc6d4d688b4ef00650406bb94adf4731e43c096c3a19fe40840" +dependencies = [ + "bitflags", + "bytes", + "futures-util", + "http", + "http-body", + "pin-project-lite", + "tower", + "tower-layer", + "tower-service", + "url", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + [[package]] name = "tracing" version = "0.1.44" @@ -1243,6 +1790,31 @@ dependencies = [ "once_cell", ] +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "tungstenite" +version = "0.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18e5b8366ee7a95b16d32197d0b2604b43a0be89dc5fac9f8e96ccafbaedda8a" +dependencies = [ + "byteorder", + "bytes", + "data-encoding", + "http", + "httparse", + "log", + "native-tls", + "rand", + "sha1", + "thiserror 1.0.69", + "utf-8", +] + [[package]] name = "typenum" version = "1.20.0" @@ -1275,11 +1847,9 @@ checksum = "02d1a66277ed75f640d608235660df48c8e3c19f3b4edb6a263315626cc3c01d" dependencies = [ "base64", "log", + "native-tls", "once_cell", - "rustls", - "rustls-pki-types", "url", - "webpki-roots 0.26.11", ] [[package]] @@ -1294,6 +1864,12 @@ dependencies = [ "serde", ] +[[package]] +name = "utf-8" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9" + [[package]] name = "utf8_iter" version = "1.0.4" @@ -1321,6 +1897,15 @@ version = "0.9.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" +[[package]] +name = "want" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfa7760aed19e106de2c7c0b581b509f2f25d3dacaf737cb82ac61bc6d760b0e" +dependencies = [ + "try-lock", +] + [[package]] name = "wasi" version = "0.11.1+wasi-snapshot-preview1" @@ -1345,6 +1930,61 @@ dependencies = [ "wit-bindgen 0.51.0", ] +[[package]] +name = "wasm-bindgen" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ddb3f79143bced6de84270411622a2699cee572fc0875aeaf1e7867cf9fca1a" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.75" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "503b14d284f2c8dac03b819967e155ea753f573586193b2b2c95990cb5d69280" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e21a184b13fb19e157296e2c46056aec9092264fab83e4ba59e68c61b323c3d" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fecefd9c35bd935a20fc3fc344b5f29138961e4f47fb03297d88f2587afb5ebd" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23939e44bb9a5d7576fa2b563dc2e136628f1224e88a8deed09e04858b77871f" +dependencies = [ + "unicode-ident", +] + [[package]] name = "wasm-encoder" version = "0.244.0" @@ -1367,6 +2007,19 @@ dependencies = [ "wasmparser", ] +[[package]] +name = "wasm-streams" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15053d8d85c7eccdbefef60f06769760a563c7f0a9d6902a13d35c7800b0ad65" +dependencies = [ + "futures-util", + "js-sys", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + [[package]] name = "wasmparser" version = "0.244.0" @@ -1380,21 +2033,13 @@ dependencies = [ ] [[package]] -name = "webpki-roots" -version = "0.26.11" +name = "web-sys" +version = "0.3.102" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "521bc38abb08001b01866da9f51eb7c5d647a19260e00054a8c7fd5f9e57f7a9" +checksum = "a6430a72df5eb332242960fe84b3002a241163998241eb596d4f739b9757061d" dependencies = [ - "webpki-roots 1.0.7", -] - -[[package]] -name = "webpki-roots" -version = "1.0.7" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "52f5ee44c96cf55f1b349600768e3ece3a8f26010c05265ab73f945bb1a2eb9d" -dependencies = [ - "rustls-pki-types", + "js-sys", + "wasm-bindgen", ] [[package]] @@ -1684,6 +2329,26 @@ dependencies = [ "synstructure", ] +[[package]] +name = "zerocopy" +version = "0.8.52" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce1022995ff5ff5d841ad7d994facc23098cd40152f2c1d11cd607c6f530653f" +dependencies = [ + "zerocopy-derive", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.52" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ae7f38b72ec2a254e2b87ef277cf2cd4fb97cbebf944faa6f33354da0867930" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "zerofrom" version = "0.1.7" diff --git a/rust/Cargo.toml b/rust/Cargo.toml index 44c4b369e..0f18a9b15 100644 --- a/rust/Cargo.toml +++ b/rust/Cargo.toml @@ -3,7 +3,7 @@ name = "github-copilot-sdk" version = "0.0.0-dev" edition = "2024" rust-version = "1.94.0" -description = "Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC. Technical preview, pre-1.0." +description = "Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC." keywords = ["copilot", "github", "ai", "json-rpc", "sdk"] categories = ["api-bindings", "development-tools"] repository = "https://github.com/github/copilot-sdk" @@ -13,6 +13,7 @@ readme = "README.md" license = "MIT" include = [ "src/**/*", + "build/**/*", "examples/**/*", "tests/**/*", "build.rs", @@ -20,6 +21,7 @@ include = [ "README.md", "LICENSE", "cli-version.txt", + "cli-version-in-process.txt", ] [lib] @@ -28,6 +30,7 @@ name = "github_copilot_sdk" [features] default = ["bundled-cli"] bundled-cli = ["dep:tar", "dep:flate2", "dep:zip"] +bundled-in-process = ["bundled-cli", "dep:libloading"] derive = ["dep:schemars"] test-support = [] @@ -40,6 +43,7 @@ rustdoc-args = ["--cfg", "docsrs"] [dependencies] async-trait = "0.1" +indexmap = { version = "2", features = ["serde"] } schemars = { version = "1", optional = true } serde = { version = "1", features = ["derive"] } serde_json = "1" @@ -48,18 +52,25 @@ tokio-stream = { version = "0.1", features = ["sync"] } tokio-util = { version = "0.7", default-features = false } tracing = "0.1" dirs = "5" +libloading = { version = "0.8", optional = true } parking_lot = "0.12" regex = "1" getrandom = "0.2" uuid = { version = "1", default-features = false, features = ["v4"] } +flate2 = { version = "1", optional = true } +tar = { version = "0.4", optional = true } +# LLM inference callback transport: idiomatic HTTP/WebSocket forwarding for the +# `CopilotRequestHandler`, plus base64/byte/stream plumbing for the chunk protocol. +base64 = "0.22" +bytes = "1" +http = "1" +futures-util = "0.3" +reqwest = { version = "0.12", default-features = false, features = ["stream", "http2", "default-tls"] } +tokio-tungstenite = { version = "0.24", default-features = false, features = ["connect", "native-tls"] } [target.'cfg(windows)'.dependencies] zip = { version = "2", default-features = false, features = ["deflate"], optional = true } -[target.'cfg(not(windows))'.dependencies] -flate2 = { version = "1", optional = true } -tar = { version = "0.4", optional = true } - [dev-dependencies] rusqlite = { version = "0.35", features = ["bundled"] } schemars = "1" @@ -80,9 +91,12 @@ name = "protocol_version_test" required-features = ["test-support"] [build-dependencies] +base64 = "0.22" dirs = "5" flate2 = "1" +serde_json = "1" sha2 = "0.10" tar = "0.4" -ureq = { version = "2", default-features = false, features = ["tls"] } +ureq = { version = "2", default-features = false, features = ["native-tls"] } +native-tls = "0.2" zip = { version = "2", default-features = false, features = ["deflate"] } diff --git a/rust/README.md b/rust/README.md index 651c5c771..29fe67355 100644 --- a/rust/README.md +++ b/rust/README.md @@ -2,11 +2,15 @@ A Rust SDK for programmatic access to the GitHub Copilot CLI. -> **Note:** This SDK is in technical preview and may change in breaking ways. +See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivalent SDKs in TypeScript, Python, Go, .NET, and Java. The Rust SDK seeks parity with those SDKs; see [Differences From Other SDKs](#differences-from-other-sdks) below for the small set of intentional divergences. -See [github/copilot-sdk](https://github.com/github/copilot-sdk) for the equivalent SDKs in TypeScript, Python, Go, and .NET. The Rust SDK seeks parity with those SDKs; see [Differences From Other SDKs](#differences-from-other-sdks) below for the small set of intentional divergences. +**Releases:** [github.com/github/copilot-sdk/releases](https://github.com/github/copilot-sdk/releases) — combined release notes for all SDK languages. -**Releases:** [github.com/github/copilot-sdk/releases?q=rust%2F](https://github.com/github/copilot-sdk/releases?q=rust%2F) — per-version release notes for the Rust crate. +## Prerequisites + +To use the SDK, you'll need: + +- Rust 1.94.0 or later ## Quick Start @@ -27,6 +31,12 @@ client.stop().await.ok(); # } ``` +When targeting MCP tools configured through `mcp_servers`, remember the runtime +tool name is `-`. For `available_tools` and +`excluded_tools`, prefer `ToolSet::new().add_mcp("-")` +or the raw `mcp:-` form. For `custom_agents[].tools` +and `default_agent.excluded_tools`, use `-` directly. + ## Architecture ```text @@ -66,17 +76,31 @@ let pong = client.ping("hello").await?; client.stop().await?; ``` +After `Client::start` succeeds, inspect its startup cost without parsing logs: + +```rust,ignore +let timings = client.startup_timings().expect("started by Client::start"); +println!( + "startup={}ms transport={}ms handshake={}ms", + timings.total_ms, timings.transport_setup_ms, timings.handshake_ms +); +``` + +Transport-specific phases are optional. For example, `port_wait_ms` is present +only for TCP and `process_spawn_ms` is absent for external and in-process +transports. + **`ClientOptions`:** -| Field | Type | Description | -| ------------- | --------------------------- | --------------------------------------------------------------- | -| `program` | `CliProgram` | `Resolve` (default: auto-detect) or `Path(PathBuf)` (explicit) | -| `prefix_args` | `Vec` | Args before `--server` (e.g. script path for node) | -| `cwd` | `PathBuf` | Working directory for CLI process | -| `env` | `Vec<(OsString, OsString)>` | Environment variables for CLI process | -| `env_remove` | `Vec` | Environment variables to remove | -| `extra_args` | `Vec` | Extra CLI flags | -| `transport` | `Transport` | `Stdio` (default), `Tcp { port }`, or `External { host, port }` | +| Field | Type | Description | +| ------------------- | --------------------------- | ----------------------------------------------------------------- | +| `program` | `CliProgram` | `Resolve` (default: auto-detect) or `Path(PathBuf)` (explicit) | +| `prefix_args` | `Vec` | Args before `--server` (e.g. script path for node) | +| `working_directory` | `PathBuf` | Working directory for CLI process (empty = host process's cwd) | +| `env` | `Vec<(OsString, OsString)>` | Environment variables for CLI process | +| `env_remove` | `Vec` | Environment variables to remove | +| `extra_args` | `Vec` | Extra CLI flags | +| `transport` | `Transport` | `Default`, `Stdio`, `InProcess`, `Tcp`, or `External` | With the default `CliProgram::Resolve`, `Client::start()` resolves the CLI in this order: an explicit `CliProgram::Path(path)`, the `COPILOT_CLI_PATH` env var, then the bundled CLI that was embedded at build time. There is no PATH scanning — if you've opted out of bundling (`default-features = false`) you must supply either `CliProgram::Path` or `COPILOT_CLI_PATH`. @@ -84,6 +108,8 @@ With the default `CliProgram::Resolve`, `Client::start()` resolves the CLI in th Created via `Client::create_session` or `Client::resume_session`. Owns an internal event loop that dispatches CLI callbacks to the focused handler traits you install on `SessionConfig`, and broadcasts session events through `subscribe()`. +`SessionConfig::working_directory` sets the session working directory. When unset, the runtime uses its process working directory. + ```rust,ignore use github_copilot_sdk::MessageOptions; @@ -118,7 +144,7 @@ let files = session.rpc().workspaces().list_files().await?; let content = session .rpc() .workspaces() - .read_file(github_copilot_sdk::generated::api_types::WorkspacesReadFileRequest { + .read_file(github_copilot_sdk::rpc::WorkspacesReadFileRequest { path: "plan.md".to_string(), }) .await?; @@ -128,7 +154,7 @@ let plan = session.rpc().plan().read().await?; session .rpc() .plan() - .update(github_copilot_sdk::generated::api_types::PlanUpdateRequest { + .update(github_copilot_sdk::rpc::PlanUpdateRequest { content: "Updated plan content".to_string(), }) .await?; @@ -137,7 +163,7 @@ session session .rpc() .fleet() - .start(github_copilot_sdk::generated::api_types::FleetStartRequest { + .start(github_copilot_sdk::rpc::FleetStartRequest { prompt: Some("Implement the auth module".to_string()), }) .await?; @@ -165,7 +191,7 @@ let tasks = session.rpc().tasks().list().await?.tasks; let forked = client .rpc() .sessions() - .fork(github_copilot_sdk::generated::api_types::SessionsForkRequest { + .fork(github_copilot_sdk::rpc::SessionsForkRequest { session_id: "session-id".into(), to_event_id: None, }) @@ -206,6 +232,10 @@ impl PermissionHandler for MyPermissions { _rid: RequestId, data: PermissionRequestData, ) -> PermissionResult { + if data.managed_approval_required == Some(true) { + return PermissionResult::no_result(); + } + if data.extra.get("tool").and_then(|v| v.as_str()) == Some("view") { PermissionResult::approve_once() } else { @@ -226,7 +256,7 @@ let config = SessionConfig::default() .with_user_input_handler(h); ``` -The built-in `ApproveAllHandler` and `DenyAllHandler` implement `PermissionHandler` for the common cases. To observe streamed session events (assistant messages, tool calls, etc.), call `session.subscribe()` — see [Streaming](#streaming) below. +The built-in `ApproveAllHandler` and `DenyAllHandler` implement `PermissionHandler` for the common cases. When `enable_managed_settings` is true, `ApproveAllHandler` logs an error and returns a user-not-available decision; custom handlers can inspect `managed_approval_required` when implementing a human-facing confirmation flow. To observe streamed session events (assistant messages, tool calls, etc.), call `session.subscribe()` — see [Streaming](#streaming) below. ### SessionConfig @@ -290,7 +320,7 @@ let session = client .await?; ``` -**Hook events:** `PreToolUse`, `PostToolUse`, `PostToolUseFailure`, `UserPromptSubmitted`, `SessionStart`, `SessionEnd`, `ErrorOccurred`. Each carries typed input/output structs. `PostToolUse` only fires on success; override `on_post_tool_use_failure` to observe failed tool calls. Return `HookOutput::None` for events you don't handle. +**Hook events:** `PreToolUse`, `PostToolUse`, `PostToolUseFailure`, `UserPromptSubmitted`, `UserPromptTransformed`, `SessionStart`, `SessionEnd`, `ErrorOccurred`. Each carries typed input/output structs. `PostToolUse` only fires on success; override `on_post_tool_use_failure` to observe failed tool calls. Return `HookOutput::None` for events you don't handle. ### System Message Transforms @@ -406,6 +436,8 @@ Reach for the `ToolHandler` trait directly when you need shared state across mul Set a permission policy directly on `SessionConfig` with the chainable builders. They install a synthesized `PermissionHandler` so only permission requests are intercepted; every other event flows through unchanged. +When `enable_managed_settings` is true, the approve-all policy logs an error and returns a user-not-available decision. Custom handlers can inspect `managed_approval_required` for human-facing confirmation logic. + ```rust,ignore let session = client .create_session( @@ -567,6 +599,23 @@ config.infinite_sessions = Some(infinite); The CLI emits `session.compaction_start` / `session.compaction_complete` events around each compaction. The session id remains stable across compactions; resume with `Client::resume_session` to pick up a prior conversation. Workspace state lives under `~/.copilot/session-state/{sessionId}` by default — override with `workspace_path` to relocate. +`enable_session_store` on `SessionConfig` enables the cross-session store for search and retrieval across sessions. When unset in the default client mode, the runtime default applies (enabled). In `Empty` mode, defaults to disabled. + +### Memory + +Configure the runtime memory feature for a session: +For more background, see [About GitHub Copilot Memory](https://docs.github.com/en/copilot/concepts/agents/copilot-memory). + +```rust,ignore +use github_copilot_sdk::types::{MemoryConfiguration, SessionConfig}; + +let config = SessionConfig::default().with_memory(MemoryConfiguration::enabled()); +``` + +`MemoryConfiguration` is accepted on both `Client::create_session` and `Client::resume_session` (via `ResumeSessionConfig::with_memory`). `enabled` toggles the feature. + +The client mode affects the default: in the default `ClientMode::CopilotCli` the SDK leaves `memory` unset so the runtime applies its own default, while `ClientMode::Empty` defaults `memory` to disabled unless you set it explicitly. + ### Custom Providers (BYOK) Route model traffic through your own inference endpoint instead of GitHub's hosted models: @@ -590,11 +639,12 @@ Provider types include `"openai"`, `"azure"`, and `"anthropic"`. Set `wire_api` Forward OpenTelemetry signals from the spawned CLI process to your collector: ```rust,ignore -use github_copilot_sdk::{ClientOptions, OtelExporterType, TelemetryConfig}; +use github_copilot_sdk::{ClientOptions, OtelExporterType, OtlpHttpProtocol, TelemetryConfig}; let mut telem = TelemetryConfig::default(); telem.exporter_type = Some(OtelExporterType::OtlpHttp); telem.otlp_endpoint = Some("http://localhost:4318".to_string()); +telem.otlp_protocol = Some(OtlpHttpProtocol::HttpProtobuf); telem.source_name = Some("my-app".to_string()); let mut opts = ClientOptions::default(); @@ -602,7 +652,7 @@ opts.telemetry = Some(telem); let client = Client::start(opts).await?; ``` -The SDK injects the appropriate environment variables (`COPILOT_OTEL_EXPORTER_TYPE`, `OTEL_EXPORTER_OTLP_ENDPOINT`, ...) into the spawned CLI process. The SDK takes no OpenTelemetry dependency; the CLI itself owns the exporter pipeline. Caller-supplied `ClientOptions::env` entries override telemetry-injected values. +The SDK injects the appropriate environment variables (`COPILOT_OTEL_EXPORTER_TYPE`, `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_PROTOCOL`, ...) into the spawned CLI process. The SDK takes no OpenTelemetry dependency; the CLI itself owns the exporter pipeline. Caller-supplied `ClientOptions::env` entries override telemetry-injected values. ### Progress Reporting (`send_and_wait`) @@ -729,7 +779,7 @@ none of them are scheduled for removal. caller-supplied `AsyncRead` / `AsyncWrite`. Useful for testing, in-process embedding, or custom transports. Other SDKs are spawn-only or fixed-stdio. -- **`enum Transport { Stdio, Tcp, External }`** — explicit, exhaustive +- **`enum Transport { Default, Stdio, InProcess, Tcp, External }`** — explicit transport selector on `ClientOptions::transport`. Node/Python/Go rely on conditional config field combinations instead. - **Split `prefix_args` / `extra_args`** on `ClientOptions` — separate @@ -756,7 +806,18 @@ none of them are scheduled for removal. ## Embedded CLI -The SDK provisions the Copilot CLI binary at build time. By default the `bundled-cli` feature embeds the verified binary directly in your compiled crate, so end-user binaries are self-contained — no env var setup, no separate install, just `cargo build`. +The SDK provisions its runtime at build time. By default the `bundled-cli` +feature embeds the verified child-process runtime in your compiled crate. +Enable `bundled-in-process` to additionally embed the native runtime library +and use `Transport::InProcess`: + +```toml +github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] } +``` + +`CliProgram::Path` and raw `ClientOptions::extra_args` apply only to +child-process transports. Set `COPILOT_CLI_PATH` only when using an externally +provisioned compatible runtime package with in-process transport. For builds that prefer a smaller artifact, disable the `bundled-cli` feature: @@ -775,7 +836,7 @@ github-copilot-sdk = { version = "0.1", default-features = false } > together. > > **Convenience on the build machine only.** As a special case, -> `build.rs` downloads and SHA-verifies the compatible CLI version and +> `build.rs` downloads and integrity-verifies the compatible CLI version and > drops it into the build machine's per-user cache; the runtime > resolver on that same machine will pick it up automatically. This > makes local development and CI ergonomic, but it does **not** carry @@ -792,8 +853,11 @@ github-copilot-sdk = { version = "0.1", default-features = false } The resolved version is baked into the crate via `cargo:rustc-env=COPILOT_SDK_CLI_VERSION` regardless of mode. The runtime resolver consumes it to recompute the on-disk path by convention, so no absolute paths leak into the rlib. -2. **Build time:** `build.rs` downloads the platform-appropriate archive from the [`github/copilot-cli` GitHub Releases](https://github.com/github/copilot-cli/releases) (`copilot-{platform}.tar.gz` on macOS/Linux, `.zip` on Windows), live-fetches the matching `SHA256SUMS.txt`, and verifies the archive hash. Then: - - **`bundled-cli` on (default, release):** embeds the raw archive bytes via `include_bytes!()`. Runtime extracts on first `Client::start()`. +2. **Build time:** `build.rs` downloads the platform-specific npm package and + verifies its `sha512` integrity against the lockfile or publish snapshot. + Then: + - **`bundled-cli` on (default):** creates and embeds a minimal archive containing only the CLI executable. + - **`bundled-in-process` on:** the minimal archive additionally contains the platform-native runtime library (`.dll`, `.so`, or `.dylib`); no other npm package files are embedded. - **`bundled-cli` off:** extracts the binary directly into the platform cache (staging file + atomic rename), idempotent across rebuilds. If the extracted binary is already present at the expected path, the download is skipped entirely — the extracted binary *is* the cache. 3. **Runtime:** in both modes the binary lives at: @@ -879,10 +943,11 @@ Supported: `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`, `win32-x64` ## Features -| Feature | Default | Description | -| -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bundled-cli` | ✓ | Build-time CLI embedding. Pulls in `tar`+`flate2` (Linux/macOS) or `zip` (Windows). Disable via `default-features = false` to opt out (e.g. when shipping a smaller binary or when always supplying the CLI via `CliProgram::Path` / `COPILOT_CLI_PATH`). | -| `derive` | — | `schema_for::()` for generating JSON Schema from Rust types (adds `schemars`). Enable when defining [tool parameters](#tool-registration). | +| Feature | Default | Description | +| ------- | ------- | ----------- | +| `bundled-cli` | ✓ | Embeds only the CLI executable. Disable via `default-features = false` when supplying the CLI via `CliProgram::Path` or `COPILOT_CLI_PATH`. | +| `bundled-in-process` | — | Enables `Transport::InProcess`, implies `bundled-cli`, and additionally embeds only the platform-native runtime library. | +| `derive` | — | `schema_for::()` for generating JSON Schema from Rust types (adds `schemars`). | ```toml # These examples use registry syntax for illustration; until the crate is @@ -891,9 +956,31 @@ Supported: `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`, `win32-x64` # Default — bundles the Copilot CLI in your binary. github-copilot-sdk = "0.1" -# Opt out of bundling — resolve CLI from COPILOT_CLI_PATH or system PATH instead. +# Enable the in-process transport and bundle its native runtime library. +github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] } + +# Opt out of bundling — supply the CLI explicitly at runtime. github-copilot-sdk = { version = "0.1", default-features = false } # Derive JSON Schema for tool parameters (adds to default bundled-cli). github-copilot-sdk = { version = "0.1", features = ["derive"] } ``` + +## Development + +Tests require a supported [Node.js version](../nodejs/README.md#prerequisites). From the repository root: + +```bash +cd nodejs +npm ci +``` + +```bash +cd test/harness +npm ci +``` + +```bash +cd rust +cargo test --features test-support +``` diff --git a/rust/RELEASING.md b/rust/RELEASING.md index de0252de8..06e362f54 100644 --- a/rust/RELEASING.md +++ b/rust/RELEASING.md @@ -1,8 +1,7 @@ # Releasing `github-copilot-sdk` -The Rust crate ships through the same unified `publish.yml` workflow -as the Node, .NET, and Python SDKs. There is no Rust-specific release -workflow. +The Rust crate ships through the unified `publish.yml` workflow +alongside the other SDKs. There is no Rust-specific release workflow. ## TL;DR @@ -16,9 +15,11 @@ workflow. prerelease version requirement to install it. - `unstable` — skipped for Rust (Cargo doesn't have a clean equivalent of npm's `unstable` dist-tag). -4. The workflow publishes all four SDKs at the shared computed - version, tags `rust/vX.Y.Z`, and creates a Rust-scoped GitHub - Release with auto-generated notes since the previous Rust tag. +4. For `latest` and `prerelease`, the workflow publishes all SDKs at + the shared computed version, tags `rust/vX.Y.Z` for source + traceability, and creates one combined `vX.Y.Z` GitHub Release. + The `unstable` channel publishes only the Node.js SDK and does not + create a GitHub Release. ## Version, tag, and release notes @@ -26,14 +27,11 @@ workflow. as a placeholder. CI overrides it at publish time with the version computed by `publish.yml` (or an explicit `version` workflow input). - **Tag:** `rust/vX.Y.Z` (matches the `go/vX.Y.Z` style used elsewhere - in this repo). The historical `rust-v0.1.0` tag from the - release-plz era stays valid as a starting point for auto-generated - release notes. -- **Release notes:** auto-generated by `gh release --generate-notes` - from PR titles between the previous Rust tag and the new one. - Write descriptive PR titles for any change that touches the Rust - surface; that's the only place those changes will be visible to - Rust users. + in this repo). The tag identifies the source used for that crate + version. +- **Release notes:** generated for the combined `vX.Y.Z` GitHub + Release. Write descriptive PR titles for changes that touch the Rust + surface so they are represented accurately in the shared notes. ## Cargo prerelease semantics @@ -59,8 +57,8 @@ cargo yank --version X.Y.Z github-copilot-sdk Yanking does *not* delete the version — existing `Cargo.lock` files keep working — but it stops new resolutions from picking it. Follow -up with a patch release that fixes the bug, and add a note to the -yanked version's GitHub Release explaining why. +up with a patch release that fixes the bug, and update the combined +GitHub Release notes to explain why. Reverse with `cargo yank --undo --version X.Y.Z github-copilot-sdk` if the yank was a mistake. @@ -90,6 +88,5 @@ git push origin rust/vX.Y.Z perl -i -pe 's/^version = ".*"$/version = "0.0.0-dev"/' Cargo.toml ``` -Manual publishes skip the auto-generated GitHub Release. Run -`gh release create rust/vX.Y.Z --generate-notes` after pushing the -tag. +Manual publishes skip the combined GitHub Release. Create or update the +matching `vX.Y.Z` release after pushing the tag. diff --git a/rust/build.rs b/rust/build.rs index 630a0d100..d04cf2870 100644 --- a/rust/build.rs +++ b/rust/build.rs @@ -1,668 +1,11 @@ -use std::io::Read; -use std::path::{Path, PathBuf}; -use std::time::Duration; +#[cfg(feature = "bundled-in-process")] +#[path = "build/in_process.rs"] +mod implementation; -use sha2::Digest; +#[cfg(not(feature = "bundled-in-process"))] +#[path = "build/out_of_process.rs"] +mod implementation; fn main() { - println!("cargo:rerun-if-env-changed=COPILOT_SKIP_CLI_DOWNLOAD"); - println!("cargo:rerun-if-env-changed=COPILOT_CLI_EXTRACT_DIR"); - println!("cargo:rerun-if-env-changed=BUNDLED_CLI_CACHE_DIR"); - println!("cargo::rustc-check-cfg=cfg(has_bundled_cli)"); - println!("cargo::rustc-check-cfg=cfg(has_extracted_cli)"); - println!("cargo:rerun-if-changed=cli-version.txt"); - - // Only declare the lockfile rerun when the lockfile actually exists. - // Cargo treats `rerun-if-changed` for a missing path as "always rerun" - // — so unconditionally declaring this on consumers without a sibling - // `nodejs/` (vendored slots, published crates) would force build.rs - // to re-run on every `cargo build` even when nothing has changed. - // The lockfile path is only the source-of-truth in this repo's - // contributor builds; everywhere else `cli-version.txt` is canonical. - let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); - let lockfile = Path::new(&manifest_dir) - .join("..") - .join("nodejs") - .join("package-lock.json"); - if lockfile.is_file() { - println!("cargo:rerun-if-changed={}", lockfile.display()); - } - - // Hard opt-out: disable the entire download / bundle / cache mechanism - // in one step. For consumers who always supply the CLI via - // `CliProgram::Path` or `COPILOT_CLI_PATH` and don't want build.rs to - // touch the network (offline builds, locked-down CI, etc.). Works - // regardless of the `bundled-cli` cargo feature state — with neither - // `has_bundled_cli` nor `has_extracted_cli` emitted, runtime resolution - // falls straight through to `Error::BinaryNotFound` unless an explicit - // path source resolves first. - if std::env::var_os("COPILOT_SKIP_CLI_DOWNLOAD").is_some() { - println!( - "cargo:warning=COPILOT_SKIP_CLI_DOWNLOAD is set — skipping CLI download/bundle/cache" - ); - return; - } - - let Some(platform) = target_platform() else { - println!("cargo:warning=Unsupported target platform for Copilot CLI bundling — skipping"); - return; - }; - - let out_dir = std::env::var("OUT_DIR").expect("OUT_DIR is always set by cargo"); - let out = Path::new(&out_dir); - - // Resolve version + per-asset SHA-256 from one of two sources, in order: - // 1. `cli-version.txt` snapshot at the crate root (published-crate - // consumer; generated by the publish workflow). Combined format: - // `version=X` line + per-asset hash lines. Committing the hashes - // makes the publish workflow the trust boundary — an attacker who - // later re-points the release tag can't silently poison consumer - // builds. - // 2. Sibling `../nodejs/package-lock.json` (contributor build inside - // the github/copilot-sdk repo; live SHA256SUMS.txt fetch). Matches - // the .NET `_GetCopilotCliVersion` MSBuild target and the Go - // `cmd/bundler` tool. - let (version, expected_hash) = resolve_version_and_hash(platform.asset_name); - - // Bake the version into the crate regardless of mode. This is the - // single source of truth for "what CLI version did build.rs target", - // consumed by both the embed-mode path computation in embeddedcli.rs - // and the runtime path computation in resolve.rs (when `bundled-cli` - // is off). It's a small, machine-independent datum: no absolute - // paths, no username/home leakage, so sccache / cross-machine - // `target/` reuse stays cache-coherent. - println!("cargo:rustc-env=COPILOT_SDK_CLI_VERSION={version}"); - - let base_url = format!("https://github.com/github/copilot-cli/releases/download/v{version}"); - let cache_dir = std::env::var("BUNDLED_CLI_CACHE_DIR") - .ok() - .map(std::path::PathBuf::from); - - // Versioned cache key since copilot asset names don't include the version. - let cache_key = format!("v{version}-{}", platform.asset_name); - - if std::env::var_os("CARGO_FEATURE_BUNDLED_CLI").is_some() { - // Embed mode: we need the archive bytes to bake into the rlib, so - // always run the download (cache hit short-circuits inside - // `cached_download`). - let archive = cached_download( - &format!("{base_url}/{}", platform.asset_name), - &cache_key, - &expected_hash, - &cache_dir, - ); - verify_binary_present_in_archive(&archive, platform.binary_name, platform.asset_name); - emit_embedded(out, &archive); - println!("cargo:rustc-cfg=has_bundled_cli"); - } else { - // With `bundled-cli` off the extracted binary *is* the cache. - // Skip the upstream download entirely when it already exists at - // the expected path. No two separate caches. - // - // Runtime resolution (see `src/resolve.rs::extracted_cli_path`) - // recomputes this same path from `COPILOT_SDK_CLI_VERSION` + the - // OS-derived binary name + optional `COPILOT_CLI_EXTRACT_DIR`, - // so we don't bake an absolute path into the crate. - let install_dir = extracted_install_dir(&version); - let final_path = install_dir.join(platform.binary_name); - - // Invalidate build.rs whenever the cached binary disappears (cache GC, - // manual rm, OS reset, switching extract dir). Without this, cargo - // replays the saved `has_extracted_cli` cfg from its build-script - // output cache even when the file is gone, and runtime resolution - // fails with BinaryNotFound. - println!("cargo:rerun-if-changed={}", final_path.display()); - - if !final_path.is_file() { - let archive = cached_download( - &format!("{base_url}/{}", platform.asset_name), - &cache_key, - &expected_hash, - &cache_dir, - ); - verify_binary_present_in_archive(&archive, platform.binary_name, platform.asset_name); - extract_to_cache(&archive, &install_dir, platform); - } - - // Re-check after potential download+extract above; not an `else` - // because we need to verify the extraction actually produced the file. - if final_path.is_file() { - println!("cargo:rustc-cfg=has_extracted_cli"); - } - } -} - -/// Install directory used when `bundled-cli` is off. Mirrors the runtime -/// convention in `src/resolve.rs::extracted_cli_path`: both sides MUST -/// compute the same path from the same inputs, otherwise the runtime -/// resolver won't find what build.rs extracted. -/// -/// If `COPILOT_CLI_EXTRACT_DIR` is set the binary lives directly under -/// that directory (no per-version subdir) — useful for vendored slots and -/// for `.cargo/config.toml [env]`-style pinning that's symmetric between -/// build-time write and runtime read. Otherwise the binary lives under -/// `/github-copilot-sdk/cli//`. -fn extracted_install_dir(version: &str) -> PathBuf { - if let Some(custom) = std::env::var_os("COPILOT_CLI_EXTRACT_DIR") { - PathBuf::from(custom) - } else { - let cache = dirs::cache_dir().unwrap_or_else(std::env::temp_dir); - cache - .join("github-copilot-sdk") - .join("cli") - .join(sanitize_version(version)) - } -} - -/// Emit the `bundled_cli.rs` glue + `copilot_cli.archive` blob into `OUT_DIR` -/// for embed mode (`bundled-cli` cargo feature on). The version is exposed -/// crate-wide via the unconditional `cargo:rustc-env=COPILOT_SDK_CLI_VERSION` -/// emit; the binary name is OS-derived at runtime — so all we need to -/// generate here is the archive blob include. -fn emit_embedded(out: &Path, archive: &[u8]) { - std::fs::write(out.join("copilot_cli.archive"), archive) - .expect("failed to write copilot_cli.archive"); - - let generated = r#"// Auto-generated by github-copilot-sdk build.rs. Do not edit. -pub(super) static CLI_ARCHIVE: &[u8] = include_bytes!("copilot_cli.archive"); -"#; - - std::fs::write(out.join("bundled_cli.rs"), generated).expect("failed to write bundled_cli.rs"); -} - -/// Resolve the CLI version and the expected SHA-256 hash for the current -/// target's archive. Picks one of two sources in order. Panics with a clear -/// error if neither is available. -fn resolve_version_and_hash(asset_name: &str) -> (String, String) { - let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); - - // 1. Snapshot file at the crate root (published-crate consumer, - // vendored-slot consumer). Combined version + per-asset hashes. - let snapshot = Path::new(&manifest_dir).join("cli-version.txt"); - if snapshot.is_file() { - let contents = std::fs::read_to_string(&snapshot) - .unwrap_or_else(|e| panic!("failed to read {}: {e}", snapshot.display())); - return parse_snapshot(&contents, asset_name) - .unwrap_or_else(|e| panic!("invalid {}: {e}", snapshot.display())); - } - - // 2. Lockfile fallback (contributor build inside github/copilot-sdk) — - // read version, fetch live SHA256SUMS. - let lockfile = Path::new(&manifest_dir) - .join("..") - .join("nodejs") - .join("package-lock.json"); - if lockfile.is_file() { - let version = read_version_from_package_lock(&lockfile); - let hash = fetch_live_sha256(&version, asset_name); - return (version, hash); - } - - panic!( - "Could not resolve the Copilot CLI version.\n\ - Tried:\n\ - - {} (missing)\n\ - - {} (missing)\n\ - In a published crate or vendored slot, `cli-version.txt` should be present.\n\ - Inside the github/copilot-sdk repo, `../nodejs/package-lock.json` is the source.", - snapshot.display(), - lockfile.display(), - ); -} - -/// Parse the `cli-version.txt` snapshot file. Format is one `key=value` per -/// line. The first non-comment line is `version=X.Y.Z`; subsequent lines map -/// asset filename to hex SHA-256. Blank lines and lines starting with `#` -/// are skipped. -fn parse_snapshot(contents: &str, asset_name: &str) -> Result<(String, String), String> { - let mut version: Option = None; - let mut hash: Option = None; - for (line_no, raw) in contents.lines().enumerate() { - let line = raw.trim(); - if line.is_empty() || line.starts_with('#') { - continue; - } - let (key, value) = line - .split_once('=') - .ok_or_else(|| format!("line {}: expected `key=value`, got `{raw}`", line_no + 1))?; - match key.trim() { - "version" => version = Some(value.trim().to_string()), - k if k == asset_name => hash = Some(value.trim().to_string()), - _ => {} - } - } - let version = version.ok_or("missing `version=` line")?; - let hash = hash.ok_or_else(|| format!("missing hash for asset `{asset_name}`"))?; - Ok((version, hash)) -} - -/// Read the `@github/copilot` version from `nodejs/package-lock.json`. -fn read_version_from_package_lock(path: &Path) -> String { - let contents = std::fs::read_to_string(path) - .unwrap_or_else(|e| panic!("failed to read {}: {e}", path.display())); - // Minimal JSON walk: find `"node_modules/@github/copilot"` object and - // its `"version"` field. Full JSON parsing keeps build.rs dep-light by - // using a regex; the file is generated by npm and we're matching an - // exact key path. - let key = "\"node_modules/@github/copilot\""; - let key_pos = contents - .find(key) - .unwrap_or_else(|| panic!("{} does not contain {key}", path.display())); - let after_key = &contents[key_pos + key.len()..]; - let version_key = "\"version\""; - let v_pos = after_key - .find(version_key) - .unwrap_or_else(|| panic!("no `version` field found near {key} in {}", path.display())); - let after_v = &after_key[v_pos + version_key.len()..]; - let q1 = after_v.find('"').expect("malformed version"); - let after_q1 = &after_v[q1 + 1..]; - let q2 = after_q1.find('"').expect("malformed version"); - after_q1[..q2].to_string() -} - -/// Fetch the live `SHA256SUMS.txt` for the given version from GitHub Releases -/// and pluck out the entry for `asset_name`. -fn fetch_live_sha256(version: &str, asset_name: &str) -> String { - let base_url = format!("https://github.com/github/copilot-cli/releases/download/v{version}"); - let checksums_url = format!("{base_url}/SHA256SUMS.txt"); - let checksums = download_with_retry(&checksums_url); - let checksums_text = - std::str::from_utf8(&checksums).expect("checksums file is not valid UTF-8"); - find_sha256_for_asset(checksums_text, asset_name) -} - -#[derive(Clone, Copy)] -struct Platform { - asset_name: &'static str, - binary_name: &'static str, -} - -fn target_platform() -> Option { - let os = std::env::var("CARGO_CFG_TARGET_OS").ok()?; - let arch = std::env::var("CARGO_CFG_TARGET_ARCH").ok()?; - - match (os.as_str(), arch.as_str()) { - ("macos", "aarch64") => Some(Platform { - asset_name: "copilot-darwin-arm64.tar.gz", - binary_name: "copilot", - }), - ("macos", "x86_64") => Some(Platform { - asset_name: "copilot-darwin-x64.tar.gz", - binary_name: "copilot", - }), - ("linux", "x86_64") => Some(Platform { - asset_name: "copilot-linux-x64.tar.gz", - binary_name: "copilot", - }), - ("linux", "aarch64") => Some(Platform { - asset_name: "copilot-linux-arm64.tar.gz", - binary_name: "copilot", - }), - ("windows", "x86_64") => Some(Platform { - asset_name: "copilot-win32-x64.zip", - binary_name: "copilot.exe", - }), - ("windows", "aarch64") => Some(Platform { - asset_name: "copilot-win32-arm64.zip", - binary_name: "copilot.exe", - }), - _ => None, - } -} - -/// Write the single binary entry from `archive` to -/// `/` and return the resulting path. -/// Idempotent — returns the existing path if a previous build already -/// populated the target. -/// -/// Uses file-level staging + atomic rename so a concurrent reader during -/// a parallel `cargo build` race never observes a partially-written -/// binary. `fs::rename` for files is atomic on both Unix and Windows -/// (Windows uses `MoveFileExW` with `MOVEFILE_REPLACE_EXISTING`); for -/// directories it is not, which is why we stage at file granularity. -fn extract_to_cache(archive: &[u8], install_dir: &Path, platform: Platform) -> PathBuf { - let final_path = install_dir.join(platform.binary_name); - - // Caller already gated on `final_path.is_file()`; this is a safety - // net for any future caller that forgets. - if final_path.is_file() { - return final_path; - } - - std::fs::create_dir_all(install_dir).unwrap_or_else(|e| { - panic!( - "failed to create install dir {}: {e}", - install_dir.display() - ) - }); - - let bytes = extract_binary_bytes(archive, platform); - - // Staging file is a sibling of the final binary so the rename stays - // on the same filesystem (cross-fs rename is not atomic). PID + nanos - // disambiguate concurrent builds racing on the same cache. - let nanos = std::time::SystemTime::now() - .duration_since(std::time::UNIX_EPOCH) - .map(|d| d.as_nanos()) - .unwrap_or(0); - let staging_path = install_dir.join(format!( - ".{}.staging-{}-{nanos}", - platform.binary_name, - std::process::id(), - )); - - if let Err(e) = std::fs::write(&staging_path, &bytes) { - let _ = std::fs::remove_file(&staging_path); - panic!( - "failed to write staging file {}: {e}", - staging_path.display() - ); - } - - #[cfg(unix)] - { - use std::os::unix::fs::PermissionsExt; - if let Err(e) = - std::fs::set_permissions(&staging_path, std::fs::Permissions::from_mode(0o755)) - { - let _ = std::fs::remove_file(&staging_path); - panic!("failed to chmod {}: {e}", staging_path.display()); - } - } - - // Atomic file-replace on both Unix and Windows. If a concurrent build - // already produced the same file the rename overwrites it; the bytes - // are SHA-verified-identical so replacement is safe. - if let Err(e) = std::fs::rename(&staging_path, &final_path) { - let _ = std::fs::remove_file(&staging_path); - panic!( - "failed to rename {} -> {}: {e}", - staging_path.display(), - final_path.display() - ); - } - - // Surface where the binary landed so contributors can find it. Quiet - // on the hot path: the caller's `is_file()` short-circuit (and the - // safety net at the top of this function) means this only fires on a - // true cache miss. - println!( - "cargo:warning=Extracted Copilot CLI to {}", - final_path.display() - ); - - final_path -} - -/// Replace characters outside `[a-zA-Z0-9._-]` with `_` so the version -/// string is always safe to use as a path component. Kept in sync with -/// `embeddedcli::sanitize_version` and `resolve::sanitize_version` so all -/// three resolve to the same cache directory for any given version. -fn sanitize_version(version: &str) -> String { - version - .chars() - .map(|c| match c { - 'a'..='z' | 'A'..='Z' | '0'..='9' | '.' | '-' | '_' => c, - _ => '_', - }) - .collect() -} - -/// Extract the single `binary_name` entry from the release archive. Reused -/// between embed mode's `verify_binary_present_in_archive` and the -/// `extract_to_cache` path used when `bundled-cli` is off. Panics if the -/// entry isn't found — callers have already invoked -/// `verify_binary_present_in_archive`. -fn extract_binary_bytes(archive: &[u8], platform: Platform) -> Vec { - if platform.asset_name.ends_with(".zip") { - let cursor = std::io::Cursor::new(archive); - let mut zip = zip::ZipArchive::new(cursor) - .unwrap_or_else(|e| panic!("failed to open zip archive: {e}")); - for i in 0..zip.len() { - let mut entry = zip - .by_index(i) - .unwrap_or_else(|e| panic!("failed to read zip entry {i}: {e}")); - let name = entry.name().to_string(); - if name == platform.binary_name || name.ends_with(&format!("/{}", platform.binary_name)) - { - let mut bytes = Vec::with_capacity(entry.size() as usize); - std::io::copy(&mut entry, &mut bytes) - .unwrap_or_else(|e| panic!("failed to read zip entry bytes: {e}")); - return bytes; - } - } - } else { - let gz = flate2::read::GzDecoder::new(archive); - let mut tar = tar::Archive::new(gz); - for entry in tar - .entries() - .unwrap_or_else(|e| panic!("failed to read tar entries: {e}")) - { - let mut entry = entry.unwrap_or_else(|e| panic!("failed to read tar entry: {e}")); - let path = entry - .path() - .unwrap_or_else(|e| panic!("failed to read tar entry path: {e}")); - let name = path.to_string_lossy().into_owned(); - if name == platform.binary_name || name.ends_with(&format!("/{}", platform.binary_name)) - { - let mut bytes = Vec::with_capacity(entry.size() as usize); - entry - .read_to_end(&mut bytes) - .unwrap_or_else(|e| panic!("failed to read tar entry bytes: {e}")); - return bytes; - } - } - } - panic!( - "binary `{}` not found in archive `{}`", - platform.binary_name, platform.asset_name - ); -} - -/// Read a file from the download cache, or download it (with retries) and save -/// to cache. Verifies SHA-256 on every path. Evicts stale/corrupt cache entries -/// automatically. Cache I/O failures are treated as cache misses — they never -/// break the build. -fn cached_download( - url: &str, - cache_key: &str, - expected_hash: &str, - cache_dir: &Option, -) -> Vec { - if let Some(dir) = cache_dir { - let cached_path = dir.join(cache_key); - if cached_path.is_file() { - match std::fs::read(&cached_path) { - Ok(data) if hex_sha256(&data) == expected_hash => { - // Silent cache hit — nothing to surface. - return data; - } - Ok(_) => { - println!("cargo:warning=Cached archive hash mismatch, re-downloading"); - let _ = std::fs::remove_file(&cached_path); - } - Err(e) => { - println!( - "cargo:warning=Failed to read cache {}, re-downloading: {e}", - cached_path.display() - ); - } - } - } - } - - println!("cargo:warning=Downloading {url}"); - let data = download_with_retry(url); - let actual_hash = hex_sha256(&data); - if actual_hash != expected_hash { - panic!( - "Archive integrity check failed for {url}!\n expected: {expected_hash}\n actual: {actual_hash}\n \ - This could indicate a corrupted download or a supply-chain attack." - ); - } - - if let Some(dir) = cache_dir { - if let Err(e) = std::fs::create_dir_all(dir) { - println!( - "cargo:warning=Failed to create cache directory {}: {e}", - dir.display() - ); - } else { - let cached_path = dir.join(cache_key); - println!("cargo:warning=Caching archive at {}", cached_path.display()); - if let Err(e) = std::fs::write(&cached_path, &data) { - println!( - "cargo:warning=Failed to write cache file {}: {e}", - cached_path.display() - ); - } - } - } - - data -} - -/// Maximum number of HTTP attempts (one initial + this many retries on transient errors). -const MAX_RETRIES: u32 = 3; - -/// Download `url` with bounded retries on transient network errors. Backoff is -/// exponential starting at 1s. 4xx responses fail fast; 5xx and connect/read -/// errors are retried. -fn download_with_retry(url: &str) -> Vec { - let mut attempt = 0u32; - loop { - attempt += 1; - match try_download(url) { - Ok(bytes) => return bytes, - Err(err) if err.transient && attempt <= MAX_RETRIES => { - let backoff = Duration::from_secs(1u64 << (attempt - 1)); - println!( - "cargo:warning=Transient download failure for {url} (attempt {attempt}/{}): {} — retrying in {}s", - MAX_RETRIES + 1, - err.message, - backoff.as_secs(), - ); - std::thread::sleep(backoff); - } - Err(err) => panic!("Failed to download {url}: {}", err.message), - } - } -} - -struct DownloadError { - message: String, - transient: bool, -} - -fn try_download(url: &str) -> Result, DownloadError> { - let agent = ureq::AgentBuilder::new() - .timeout_connect(Duration::from_secs(30)) - .timeout_read(Duration::from_secs(120)) - .build(); - - match agent.get(url).call() { - Ok(response) => { - let mut bytes = Vec::new(); - response - .into_reader() - .read_to_end(&mut bytes) - .map_err(|e| DownloadError { - message: format!("read error: {e}"), - transient: true, - })?; - Ok(bytes) - } - // 5xx — server-side, treat as transient. - Err(ureq::Error::Status(code, response)) if (500..600).contains(&code) => { - Err(DownloadError { - message: format!("HTTP {code} {}", response.status_text()), - transient: true, - }) - } - // 4xx — client-side, fail fast. - Err(ureq::Error::Status(code, response)) => Err(DownloadError { - message: format!("HTTP {code} {}", response.status_text()), - transient: false, - }), - // Transport-layer (DNS, connect, TLS, read timeout) — treat as transient. - Err(ureq::Error::Transport(t)) => Err(DownloadError { - message: format!("transport error: {t}"), - transient: true, - }), - } -} - -fn find_sha256_for_asset(sums: &str, asset_name: &str) -> String { - for line in sums.lines() { - // Format: " " (two spaces) - if let Some((hash, name)) = line.split_once(" ") - && name.trim() == asset_name - { - return hash.trim().to_string(); - } - } - panic!("SHA256SUMS.txt does not contain an entry for {asset_name}"); -} - -fn sha256(data: &[u8]) -> [u8; 32] { - let mut hasher = sha2::Sha256::new(); - hasher.update(data); - hasher.finalize().into() -} - -/// Walks the downloaded archive at build time to confirm an entry matching -/// `binary_name` exists. Panics with a clear message if not — defends against -/// silent breakage if the upstream archive layout ever changes. -fn verify_binary_present_in_archive(archive: &[u8], binary_name: &str, asset_name: &str) { - let found = if asset_name.ends_with(".zip") { - archive_contains_zip_entry(archive, binary_name) - } else { - archive_contains_tar_entry(archive, binary_name) - }; - if !found { - panic!( - "Copilot CLI archive `{asset_name}` does not contain an entry named `{binary_name}`. \ - The upstream archive layout may have changed; runtime extraction would fail. \ - Update `verify_binary_present_in_archive` in build.rs and the matching `extract_binary` in src/embeddedcli.rs." - ); - } -} - -fn archive_contains_tar_entry(targz: &[u8], binary_name: &str) -> bool { - let gz = flate2::read::GzDecoder::new(targz); - let mut archive = tar::Archive::new(gz); - let Ok(entries) = archive.entries() else { - return false; - }; - for entry in entries.flatten() { - let Ok(path) = entry.path() else { - continue; - }; - let name = path.to_string_lossy(); - if name == binary_name || name.ends_with(&format!("/{binary_name}")) { - return true; - } - } - false -} - -fn archive_contains_zip_entry(zip_bytes: &[u8], binary_name: &str) -> bool { - let cursor = std::io::Cursor::new(zip_bytes); - let Ok(mut archive) = zip::ZipArchive::new(cursor) else { - return false; - }; - for i in 0..archive.len() { - let Ok(entry) = archive.by_index(i) else { - continue; - }; - let name = entry.name(); - if name == binary_name || name.ends_with(&format!("/{binary_name}")) { - return true; - } - } - false -} - -fn hex_sha256(data: &[u8]) -> String { - sha256(data).iter().map(|b| format!("{b:02x}")).collect() + implementation::main(); } diff --git a/rust/build/in_process.rs b/rust/build/in_process.rs new file mode 100644 index 000000000..5826fbfa7 --- /dev/null +++ b/rust/build/in_process.rs @@ -0,0 +1,726 @@ +use std::io::{Read, Write}; +use std::path::{Path, PathBuf}; +use std::time::Duration; + +use base64::Engine; +use sha2::Digest; + +pub(crate) fn main() { + println!("cargo:rerun-if-env-changed=DOCS_RS"); + println!("cargo:rerun-if-env-changed=COPILOT_SKIP_CLI_DOWNLOAD"); + println!("cargo:rerun-if-env-changed=COPILOT_CLI_EXTRACT_DIR"); + println!("cargo:rerun-if-env-changed=BUNDLED_CLI_CACHE_DIR"); + println!("cargo::rustc-check-cfg=cfg(has_bundled_cli)"); + println!("cargo::rustc-check-cfg=cfg(has_extracted_cli)"); + println!("cargo:rerun-if-changed=cli-version-in-process.txt"); + + // Only declare the lockfile rerun when the lockfile actually exists. + // Cargo treats `rerun-if-changed` for a missing path as "always rerun" + // — so unconditionally declaring this on consumers without a sibling + // `nodejs/` (vendored slots, published crates) would force build.rs + // to re-run on every `cargo build` even when nothing has changed. + // The lockfile path is only the source-of-truth in this repo's + // contributor builds; everywhere else `cli-version-in-process.txt` is canonical. + let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); + let lockfile = Path::new(&manifest_dir) + .join("..") + .join("nodejs") + .join("package-lock.json"); + if lockfile.is_file() { + println!("cargo:rerun-if-changed={}", lockfile.display()); + } + + // Hard opt-out: disable the entire download / bundle / cache mechanism + // in one step. For consumers who always supply the CLI via + // `CliProgram::Path` or `COPILOT_CLI_PATH` and don't want build.rs to + // touch the network (offline builds, locked-down CI, etc.). Works + // regardless of the `bundled-cli` cargo feature state — with neither + // `has_bundled_cli` nor `has_extracted_cli` emitted, runtime resolution + // falls straight through to `Error::BinaryNotFound` unless an explicit + // path source resolves first. + if std::env::var_os("COPILOT_SKIP_CLI_DOWNLOAD").is_some() { + println!( + "cargo:warning=COPILOT_SKIP_CLI_DOWNLOAD is set — skipping CLI download/bundle/cache" + ); + return; + } + + // docs.rs builds in a sandboxed environment without network access. + // Skip the CLI download so documentation can be generated successfully. + if std::env::var_os("DOCS_RS").is_some() { + println!("cargo:warning=DOCS_RS is set — skipping CLI download/bundle/cache"); + return; + } + + let Some(platform) = target_platform() else { + println!("cargo:warning=Unsupported target platform for Copilot CLI bundling — skipping"); + return; + }; + + let out_dir = std::env::var("OUT_DIR").expect("OUT_DIR is always set by cargo"); + let out = Path::new(&out_dir); + + // Resolve version + npm integrity from one of two sources, in order: + // 1. `cli-version-in-process.txt` snapshot at the crate root (published-crate + // consumer; generated by the publish workflow). Combined format: + // `version=X` line + per-package integrity lines. Committing these + // makes the publish workflow the trust boundary — an attacker who + // later re-points the release tag can't silently poison consumer + // builds. + // 2. Sibling `../nodejs/package-lock.json` (contributor build inside + // the github/copilot-sdk repo), whose platform-package integrity is + // the same trust source npm uses. + let (version, expected_integrity) = resolve_version_and_integrity(platform.package_name); + + // Bake the version into the crate regardless of mode. This is the + // single source of truth for "what CLI version did build.rs target", + // consumed by both the embed-mode path computation in embeddedcli.rs + // and the runtime path computation in resolve.rs (when `bundled-cli` + // is off). It's a small, machine-independent datum: no absolute + // paths, no username/home leakage, so sccache / cross-machine + // `target/` reuse stays cache-coherent. + println!("cargo:rustc-env=COPILOT_SDK_CLI_VERSION={version}"); + + let archive_name = format!("{}-{version}.tgz", platform.package_name); + let download_url = format!( + "https://registry.npmjs.org/@github/{}/-/{}", + platform.package_name, archive_name + ); + let cache_dir = std::env::var("BUNDLED_CLI_CACHE_DIR") + .ok() + .map(std::path::PathBuf::from); + + let cache_key = format!("v{version}-{archive_name}"); + let include_runtime = std::env::var_os("CARGO_FEATURE_BUNDLED_IN_PROCESS").is_some(); + + if std::env::var_os("CARGO_FEATURE_BUNDLED_CLI").is_some() { + let archive = cached_download(&download_url, &cache_key, &expected_integrity, &cache_dir); + verify_binary_present_in_archive(&archive, platform.binary_name, &archive_name); + emit_embedded(out, &archive, platform, include_runtime); + println!("cargo:rustc-cfg=has_bundled_cli"); + } else { + // With `bundled-cli` off the extracted binary *is* the cache. + // Skip the upstream download entirely when it already exists at + // the expected path. No two separate caches. + // + // Runtime resolution (see `src/resolve.rs::extracted_cli_path`) + // recomputes this same path from `COPILOT_SDK_CLI_VERSION` + the + // OS-derived binary name + optional `COPILOT_CLI_EXTRACT_DIR`, + // so we don't bake an absolute path into the crate. + let install_dir = extracted_install_dir(&version); + let final_path = install_dir.join(platform.binary_name); + + // Invalidate build.rs whenever the cached binary disappears (cache GC, + // manual rm, OS reset, switching extract dir). Without this, cargo + // replays the saved `has_extracted_cli` cfg from its build-script + // output cache even when the file is gone, and runtime resolution + // fails with BinaryNotFound. + println!("cargo:rerun-if-changed={}", final_path.display()); + + if !final_path.is_file() { + let archive = + cached_download(&download_url, &cache_key, &expected_integrity, &cache_dir); + verify_binary_present_in_archive(&archive, platform.binary_name, &archive_name); + extract_to_cache(&archive, &install_dir, platform); + } + + // Re-check after potential download+extract above; not an `else` + // because we need to verify the extraction actually produced the file. + if final_path.is_file() { + println!("cargo:rustc-cfg=has_extracted_cli"); + } + } +} + +/// Install directory used when `bundled-cli` is off. Mirrors the runtime +/// convention in `src/resolve.rs::extracted_cli_path`: both sides MUST +/// compute the same path from the same inputs, otherwise the runtime +/// resolver won't find what build.rs extracted. +/// +/// If `COPILOT_CLI_EXTRACT_DIR` is set the binary lives directly under +/// that directory (no per-version subdir) — useful for vendored slots and +/// for `.cargo/config.toml [env]`-style pinning that's symmetric between +/// build-time write and runtime read. Otherwise the binary lives under +/// `/github-copilot-sdk/cli//`. +fn extracted_install_dir(version: &str) -> PathBuf { + if let Some(custom) = std::env::var_os("COPILOT_CLI_EXTRACT_DIR") { + PathBuf::from(custom) + } else { + let cache = dirs::cache_dir().unwrap_or_else(std::env::temp_dir); + cache + .join("github-copilot-sdk") + .join("cli") + .join(sanitize_version(version)) + } +} + +/// Emit the `bundled_cli.rs` glue + `copilot_cli.archive` blob into `OUT_DIR` +/// for embed mode (`bundled-cli` cargo feature on). The version is exposed +/// crate-wide via the unconditional `cargo:rustc-env=COPILOT_SDK_CLI_VERSION` +/// emit; the binary name is OS-derived at runtime — so all we need to +/// generate here is the archive blob include. +fn emit_embedded(out: &Path, package: &[u8], platform: Platform, include_runtime: bool) { + let archive = build_embedded_archive(package, platform, include_runtime); + std::fs::write(out.join("copilot_cli.archive"), archive) + .expect("failed to write copilot_cli.archive"); + + let generated = r#"// Auto-generated by github-copilot-sdk build.rs. Do not edit. +pub(super) static CLI_ARCHIVE: &[u8] = include_bytes!("copilot_cli.archive"); +"#; + + std::fs::write(out.join("bundled_cli.rs"), generated).expect("failed to write bundled_cli.rs"); +} + +fn build_embedded_archive(package: &[u8], platform: Platform, include_runtime: bool) -> Vec { + let encoder = flate2::GzBuilder::new() + .mtime(0) + .write(Vec::new(), flate2::Compression::default()); + let mut archive = tar::Builder::new(encoder); + append_archive_file( + &mut archive, + platform.binary_name, + &extract_binary_bytes(package, platform), + 0o755, + ); + if include_runtime { + let runtime = extract_runtime_library_bytes(package).unwrap_or_else(|| { + panic!( + "package `{}` does not contain the native runtime library required by the `bundled-in-process` feature", + platform.package_name + ) + }); + append_archive_file( + &mut archive, + platform.runtime_library_name(), + &runtime, + 0o644, + ); + } + let encoder = archive + .into_inner() + .expect("failed to finish minimal embedded CLI archive"); + encoder + .finish() + .expect("failed to compress minimal embedded CLI archive") +} + +fn append_archive_file( + archive: &mut tar::Builder, + path: &str, + bytes: &[u8], + mode: u32, +) { + let mut header = tar::Header::new_gnu(); + header.set_size(bytes.len() as u64); + header.set_mode(mode); + header.set_uid(0); + header.set_gid(0); + header.set_mtime(0); + header.set_cksum(); + archive + .append_data(&mut header, path, bytes) + .unwrap_or_else(|e| panic!("failed to add `{path}` to embedded CLI archive: {e}")); +} + +/// Resolve the CLI version and npm integrity for the current target's +/// platform package. Picks one of two sources in order. Panics with a clear +/// error if neither is available. +fn resolve_version_and_integrity(package_name: &str) -> (String, String) { + let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); + + // 1. Snapshot file at the crate root (published-crate consumer, + // vendored-slot consumer). Combined version + per-asset hashes. + let snapshot = Path::new(&manifest_dir).join("cli-version-in-process.txt"); + if snapshot.is_file() { + let contents = std::fs::read_to_string(&snapshot) + .unwrap_or_else(|e| panic!("failed to read {}: {e}", snapshot.display())); + return parse_snapshot(&contents, package_name) + .unwrap_or_else(|e| panic!("invalid {}: {e}", snapshot.display())); + } + + // 2. Lockfile fallback (contributor build inside github/copilot-sdk). + let lockfile = Path::new(&manifest_dir) + .join("..") + .join("nodejs") + .join("package-lock.json"); + if lockfile.is_file() { + return read_version_and_integrity_from_package_lock(&lockfile, package_name); + } + + panic!( + "Could not resolve the Copilot CLI version.\n\ + Tried:\n\ + - {} (missing)\n\ + - {} (missing)\n\ + In a published crate or vendored slot, `cli-version-in-process.txt` should be present.\n\ + Inside the github/copilot-sdk repo, `../nodejs/package-lock.json` is the source.", + snapshot.display(), + lockfile.display(), + ); +} + +/// Parse the `cli-version-in-process.txt` snapshot file. Format is one `key=value` per +/// line. The first non-comment line is `version=X.Y.Z`; subsequent lines map +/// platform package name to npm integrity. Blank lines and lines starting with `#` +/// are skipped. +fn parse_snapshot(contents: &str, package_name: &str) -> Result<(String, String), String> { + let mut version: Option = None; + let mut integrity: Option = None; + for (line_no, raw) in contents.lines().enumerate() { + let line = raw.trim(); + if line.is_empty() || line.starts_with('#') { + continue; + } + let Some((key, value)) = line.split_once('=') else { + return Err(format!( + "line {}: expected `key=value`, got `{raw}`", + line_no + 1 + )); + }; + match key.trim() { + "version" => version = Some(value.trim().to_string()), + k if k == package_name => integrity = Some(value.trim().to_string()), + _ => {} + } + } + let version = version.ok_or("missing `version=` line")?; + let integrity = + integrity.ok_or_else(|| format!("missing integrity for package `{package_name}`"))?; + Ok((version, integrity)) +} + +fn read_version_and_integrity_from_package_lock( + path: &Path, + package_name: &str, +) -> (String, String) { + let contents = std::fs::read_to_string(path) + .unwrap_or_else(|e| panic!("failed to read {}: {e}", path.display())); + let lock: serde_json::Value = serde_json::from_str(&contents) + .unwrap_or_else(|e| panic!("failed to parse {}: {e}", path.display())); + let cli_key = "node_modules/@github/copilot"; + let version = lock["packages"][cli_key]["version"] + .as_str() + .unwrap_or_else(|| panic!("{cli_key} has no version in {}", path.display())); + let platform_key = format!("node_modules/@github/{package_name}"); + let integrity = lock["packages"][&platform_key]["integrity"] + .as_str() + .unwrap_or_else(|| panic!("{platform_key} has no integrity in {}", path.display())); + (version.to_string(), integrity.to_string()) +} + +#[derive(Clone, Copy)] +struct Platform { + package_name: &'static str, + binary_name: &'static str, +} + +impl Platform { + fn runtime_library_name(&self) -> &'static str { + if self.package_name.contains("win32") { + "copilot_runtime.dll" + } else if self.package_name.contains("darwin") { + "libcopilot_runtime.dylib" + } else { + "libcopilot_runtime.so" + } + } +} + +fn target_platform() -> Option { + let os = std::env::var("CARGO_CFG_TARGET_OS").ok()?; + let arch = std::env::var("CARGO_CFG_TARGET_ARCH").ok()?; + let target_env = std::env::var("CARGO_CFG_TARGET_ENV").unwrap_or_default(); + + match (os.as_str(), arch.as_str(), target_env.as_str()) { + ("macos", "aarch64", _) => Some(Platform { + package_name: "copilot-darwin-arm64", + binary_name: "copilot", + }), + ("macos", "x86_64", _) => Some(Platform { + package_name: "copilot-darwin-x64", + binary_name: "copilot", + }), + ("linux", "x86_64", "musl") => Some(Platform { + package_name: "copilot-linuxmusl-x64", + binary_name: "copilot", + }), + ("linux", "aarch64", "musl") => Some(Platform { + package_name: "copilot-linuxmusl-arm64", + binary_name: "copilot", + }), + ("linux", "x86_64", _) => Some(Platform { + package_name: "copilot-linux-x64", + binary_name: "copilot", + }), + ("linux", "aarch64", _) => Some(Platform { + package_name: "copilot-linux-arm64", + binary_name: "copilot", + }), + ("windows", "x86_64", _) => Some(Platform { + package_name: "copilot-win32-x64", + binary_name: "copilot.exe", + }), + ("windows", "aarch64", _) => Some(Platform { + package_name: "copilot-win32-arm64", + binary_name: "copilot.exe", + }), + _ => None, + } +} + +/// Write the single binary entry from `archive` to +/// `/` and return the resulting path. +/// Idempotent — returns the existing path if a previous build already +/// populated the target. +/// +/// Uses file-level staging + atomic rename so a concurrent reader during +/// a parallel `cargo build` race never observes a partially-written +/// binary. `fs::rename` for files is atomic on both Unix and Windows +/// (Windows uses `MoveFileExW` with `MOVEFILE_REPLACE_EXISTING`); for +/// directories it is not, which is why we stage at file granularity. +fn extract_to_cache(archive: &[u8], install_dir: &Path, platform: Platform) -> PathBuf { + let final_path = install_dir.join(platform.binary_name); + + // Caller already gated on `final_path.is_file()`; this is a safety + // net for any future caller that forgets. + if final_path.is_file() { + return final_path; + } + + std::fs::create_dir_all(install_dir).unwrap_or_else(|e| { + panic!( + "failed to create install dir {}: {e}", + install_dir.display() + ) + }); + + let bytes = extract_binary_bytes(archive, platform); + + // Staging file is a sibling of the final binary so the rename stays + // on the same filesystem (cross-fs rename is not atomic). PID + nanos + // disambiguate concurrent builds racing on the same cache. + let nanos = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_nanos()) + .unwrap_or(0); + let staging_path = install_dir.join(format!( + ".{}.staging-{}-{nanos}", + platform.binary_name, + std::process::id(), + )); + + { + let mut f = std::fs::File::create(&staging_path).unwrap_or_else(|e| { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to create staging file {}: {e}", + staging_path.display() + ); + }); + + if let Err(e) = f.write_all(&bytes) { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to write staging file {}: {e}", + staging_path.display() + ); + } + + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt; + if let Err(e) = f.set_permissions(std::fs::Permissions::from_mode(0o755)) { + let _ = std::fs::remove_file(&staging_path); + panic!("failed to chmod {}: {e}", staging_path.display()); + } + } + + // Backdate the staged binary to the Unix epoch before it lands. We emit + // `cargo:rerun-if-changed` on `final_path` (see caller) so a *deleted* + // cache binary forces a re-extract — but cargo stamps the build-script + // `output` reference when the script is spawned, seconds before this + // freshly-downloaded binary is written. A current mtime would therefore + // be *newer* than that reference, so the next identical `cargo` + // invocation would see the watched file as "changed" and pointlessly + // rerun build.rs + recompile the crate + relink every downstream crate. + // Pinning to the epoch keeps the file unambiguously older than any real + // build reference; `rename` preserves mtime (same inode), so it lands + // already-backdated and a no-change rebuild stays a true no-op. The + // deleted-file recovery contract is untouched: a missing file can't be + // stat'd, so cargo still treats it as stale and reruns regardless. + // + // Best-effort: a filesystem that refuses the epoch (e.g. FAT's 1980 floor + // clamps it — still older than any real reference) or rejects the call + // just reverts to the pre-fix redundant-rebuild behaviour, never a broken + // build. + if let Err(e) = f.set_modified(std::time::SystemTime::UNIX_EPOCH) { + println!( + "cargo:warning=Could not backdate {} (a redundant rebuild may occur): {e}", + staging_path.display() + ); + } + } + + // Atomic file-replace on both Unix and Windows. If a concurrent build + // already produced the same file the rename overwrites it; the bytes + // are integrity-verified-identical so replacement is safe. + if let Err(e) = std::fs::rename(&staging_path, &final_path) { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to rename {} -> {}: {e}", + staging_path.display(), + final_path.display() + ); + } + + // Surface where the binary landed so contributors can find it. Quiet + // on the hot path: the caller's `is_file()` short-circuit (and the + // safety net at the top of this function) means this only fires on a + // true cache miss. + println!( + "cargo:warning=Extracted Copilot CLI to {}", + final_path.display() + ); + + final_path +} + +fn extract_runtime_library_bytes(archive: &[u8]) -> Option> { + let gz = flate2::read::GzDecoder::new(archive); + let mut tar = tar::Archive::new(gz); + for entry in tar.entries().ok()? { + let mut entry = entry.ok()?; + let name = entry.path().ok()?.to_string_lossy().into_owned(); + if name == "runtime.node" || name.ends_with("/runtime.node") { + let mut bytes = Vec::with_capacity(entry.size() as usize); + entry.read_to_end(&mut bytes).ok()?; + return Some(bytes); + } + } + None +} + +/// Replace characters outside `[a-zA-Z0-9._-]` with `_` so the version +/// string is always safe to use as a path component. Kept in sync with +/// `embeddedcli::sanitize_version` and `resolve::sanitize_version` so all +/// three resolve to the same cache directory for any given version. +fn sanitize_version(version: &str) -> String { + version + .chars() + .map(|c| match c { + 'a'..='z' | 'A'..='Z' | '0'..='9' | '.' | '-' | '_' => c, + _ => '_', + }) + .collect() +} + +/// Extract the single `binary_name` entry from the npm package archive. Reused +/// between embed mode's `verify_binary_present_in_archive` and the +/// `extract_to_cache` path used when `bundled-cli` is off. Panics if the +/// entry isn't found — callers have already invoked +/// `verify_binary_present_in_archive`. +fn extract_binary_bytes(archive: &[u8], platform: Platform) -> Vec { + let gz = flate2::read::GzDecoder::new(archive); + let mut tar = tar::Archive::new(gz); + for entry in tar + .entries() + .unwrap_or_else(|e| panic!("failed to read tar entries: {e}")) + { + let mut entry = entry.unwrap_or_else(|e| panic!("failed to read tar entry: {e}")); + let path = entry + .path() + .unwrap_or_else(|e| panic!("failed to read tar entry path: {e}")); + let name = path.to_string_lossy().into_owned(); + if name == platform.binary_name || name.ends_with(&format!("/{}", platform.binary_name)) { + let mut bytes = Vec::with_capacity(entry.size() as usize); + entry + .read_to_end(&mut bytes) + .unwrap_or_else(|e| panic!("failed to read tar entry bytes: {e}")); + return bytes; + } + } + panic!( + "binary `{}` not found in package `{}`", + platform.binary_name, platform.package_name + ); +} + +/// Read a file from the download cache, or download it (with retries) and save +/// to cache. Verifies npm integrity on every path. Evicts stale/corrupt cache entries +/// automatically. Cache I/O failures are treated as cache misses — they never +/// break the build. +fn cached_download( + url: &str, + cache_key: &str, + expected_integrity: &str, + cache_dir: &Option, +) -> Vec { + if let Some(dir) = cache_dir { + let cached_path = dir.join(cache_key); + if cached_path.is_file() { + match std::fs::read(&cached_path) { + Ok(data) if verify_integrity(&data, expected_integrity) => { + // Silent cache hit — nothing to surface. + return data; + } + Ok(_) => { + println!("cargo:warning=Cached archive hash mismatch, re-downloading"); + let _ = std::fs::remove_file(&cached_path); + } + Err(e) => { + println!( + "cargo:warning=Failed to read cache {}, re-downloading: {e}", + cached_path.display() + ); + } + } + } + } + + println!("cargo:warning=Downloading {url}"); + let data = download_with_retry(url); + if !verify_integrity(&data, expected_integrity) { + panic!( + "Archive integrity check failed for {url}!\n expected: {expected_integrity}\n \ + This could indicate a corrupted download or a supply-chain attack." + ); + } + + if let Some(dir) = cache_dir { + if let Err(e) = std::fs::create_dir_all(dir) { + println!( + "cargo:warning=Failed to create cache directory {}: {e}", + dir.display() + ); + } else { + let cached_path = dir.join(cache_key); + println!("cargo:warning=Caching archive at {}", cached_path.display()); + if let Err(e) = std::fs::write(&cached_path, &data) { + println!( + "cargo:warning=Failed to write cache file {}: {e}", + cached_path.display() + ); + } + } + } + + data +} + +/// Maximum number of HTTP attempts (one initial + this many retries on transient errors). +const MAX_RETRIES: u32 = 3; + +/// Download `url` with bounded retries on transient network errors. Backoff is +/// exponential starting at 1s. 4xx responses fail fast; 5xx and connect/read +/// errors are retried. +fn download_with_retry(url: &str) -> Vec { + let mut attempt = 0u32; + loop { + attempt += 1; + match try_download(url) { + Ok(bytes) => return bytes, + Err(err) if err.transient && attempt <= MAX_RETRIES => { + let backoff = Duration::from_secs(1u64 << (attempt - 1)); + println!( + "cargo:warning=Transient download failure for {url} (attempt {attempt}/{}): {} — retrying in {}s", + MAX_RETRIES + 1, + err.message, + backoff.as_secs(), + ); + std::thread::sleep(backoff); + } + Err(err) => panic!("Failed to download {url}: {}", err.message), + } + } +} + +struct DownloadError { + message: String, + transient: bool, +} + +fn try_download(url: &str) -> Result, DownloadError> { + let connector = native_tls::TlsConnector::new().map_err(|e| DownloadError { + message: format!("native-tls init error: {e}"), + transient: false, + })?; + let agent = ureq::AgentBuilder::new() + .tls_connector(std::sync::Arc::new(connector)) + .timeout_connect(Duration::from_secs(30)) + .timeout_read(Duration::from_secs(120)) + .build(); + + match agent.get(url).call() { + Ok(response) => { + let mut bytes = Vec::new(); + response + .into_reader() + .read_to_end(&mut bytes) + .map_err(|e| DownloadError { + message: format!("read error: {e}"), + transient: true, + })?; + Ok(bytes) + } + // 5xx — server-side, treat as transient. + Err(ureq::Error::Status(code, response)) if (500..600).contains(&code) => { + Err(DownloadError { + message: format!("HTTP {code} {}", response.status_text()), + transient: true, + }) + } + // 4xx — client-side, fail fast. + Err(ureq::Error::Status(code, response)) => Err(DownloadError { + message: format!("HTTP {code} {}", response.status_text()), + transient: false, + }), + // Transport-layer (DNS, connect, TLS, read timeout) — treat as transient. + Err(ureq::Error::Transport(t)) => Err(DownloadError { + message: format!("transport error: {t}"), + transient: true, + }), + } +} + +/// Walks the downloaded archive at build time to confirm an entry matching +/// `binary_name` exists. Panics with a clear message if not. +fn verify_binary_present_in_archive(archive: &[u8], binary_name: &str, package_name: &str) { + let found = archive_contains_tar_entry(archive, binary_name); + if !found { + panic!( + "Copilot CLI package `{package_name}` does not contain an entry named `{binary_name}`. \ + The package layout may have changed; runtime extraction would fail. \ + Update `verify_binary_present_in_archive` in build.rs and the matching `extract_binary` in src/embeddedcli.rs." + ); + } +} + +fn archive_contains_tar_entry(targz: &[u8], binary_name: &str) -> bool { + let gz = flate2::read::GzDecoder::new(targz); + let mut archive = tar::Archive::new(gz); + let Ok(entries) = archive.entries() else { + return false; + }; + for entry in entries.flatten() { + let Ok(path) = entry.path() else { + continue; + }; + let name = path.to_string_lossy(); + if name == binary_name || name.ends_with(&format!("/{binary_name}")) { + return true; + } + } + false +} + +fn verify_integrity(data: &[u8], integrity: &str) -> bool { + let Some(encoded) = integrity.strip_prefix("sha512-") else { + return false; + }; + let Ok(expected) = base64::engine::general_purpose::STANDARD.decode(encoded) else { + return false; + }; + let mut hasher = sha2::Sha512::new(); + hasher.update(data); + hasher.finalize().as_slice() == expected +} diff --git a/rust/build/out_of_process.rs b/rust/build/out_of_process.rs new file mode 100644 index 000000000..b8cd3acc3 --- /dev/null +++ b/rust/build/out_of_process.rs @@ -0,0 +1,717 @@ +use std::io::{Read, Write}; +use std::path::{Path, PathBuf}; +use std::time::Duration; + +use sha2::Digest; + +pub(crate) fn main() { + println!("cargo:rerun-if-env-changed=DOCS_RS"); + println!("cargo:rerun-if-env-changed=COPILOT_SKIP_CLI_DOWNLOAD"); + println!("cargo:rerun-if-env-changed=COPILOT_CLI_EXTRACT_DIR"); + println!("cargo:rerun-if-env-changed=BUNDLED_CLI_CACHE_DIR"); + println!("cargo::rustc-check-cfg=cfg(has_bundled_cli)"); + println!("cargo::rustc-check-cfg=cfg(has_extracted_cli)"); + println!("cargo:rerun-if-changed=cli-version.txt"); + + // Only declare the lockfile rerun when the lockfile actually exists. + // Cargo treats `rerun-if-changed` for a missing path as "always rerun" + // — so unconditionally declaring this on consumers without a sibling + // `nodejs/` (vendored slots, published crates) would force build.rs + // to re-run on every `cargo build` even when nothing has changed. + // The lockfile path is only the source-of-truth in this repo's + // contributor builds; everywhere else `cli-version.txt` is canonical. + let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); + let lockfile = Path::new(&manifest_dir) + .join("..") + .join("nodejs") + .join("package-lock.json"); + if lockfile.is_file() { + println!("cargo:rerun-if-changed={}", lockfile.display()); + } + + // Hard opt-out: disable the entire download / bundle / cache mechanism + // in one step. For consumers who always supply the CLI via + // `CliProgram::Path` or `COPILOT_CLI_PATH` and don't want build.rs to + // touch the network (offline builds, locked-down CI, etc.). Works + // regardless of the `bundled-cli` cargo feature state — with neither + // `has_bundled_cli` nor `has_extracted_cli` emitted, runtime resolution + // falls straight through to `Error::BinaryNotFound` unless an explicit + // path source resolves first. + if std::env::var_os("COPILOT_SKIP_CLI_DOWNLOAD").is_some() { + println!( + "cargo:warning=COPILOT_SKIP_CLI_DOWNLOAD is set — skipping CLI download/bundle/cache" + ); + return; + } + + // docs.rs builds in a sandboxed environment without network access. + // Skip the CLI download so documentation can be generated successfully. + if std::env::var_os("DOCS_RS").is_some() { + println!("cargo:warning=DOCS_RS is set — skipping CLI download/bundle/cache"); + return; + } + + let Some(platform) = target_platform() else { + println!("cargo:warning=Unsupported target platform for Copilot CLI bundling — skipping"); + return; + }; + + let out_dir = std::env::var("OUT_DIR").expect("OUT_DIR is always set by cargo"); + let out = Path::new(&out_dir); + + // Resolve version + per-asset SHA-256 from one of two sources, in order: + // 1. `cli-version.txt` snapshot at the crate root (published-crate + // consumer; generated by the publish workflow). Combined format: + // `version=X` line + per-asset hash lines. Committing the hashes + // makes the publish workflow the trust boundary — an attacker who + // later re-points the release tag can't silently poison consumer + // builds. + // 2. Sibling `../nodejs/package-lock.json` (contributor build inside + // the github/copilot-sdk repo; live SHA256SUMS.txt fetch). Matches + // the .NET `_GetCopilotCliVersion` MSBuild target and the Go + // `cmd/bundler` tool. + let (version, expected_hash) = resolve_version_and_hash(platform.asset_name); + + // Bake the version into the crate regardless of mode. This is the + // single source of truth for "what CLI version did build.rs target", + // consumed by both the embed-mode path computation in embeddedcli.rs + // and the runtime path computation in resolve.rs (when `bundled-cli` + // is off). It's a small, machine-independent datum: no absolute + // paths, no username/home leakage, so sccache / cross-machine + // `target/` reuse stays cache-coherent. + println!("cargo:rustc-env=COPILOT_SDK_CLI_VERSION={version}"); + + let base_url = format!("https://github.com/github/copilot-cli/releases/download/v{version}"); + let cache_dir = std::env::var("BUNDLED_CLI_CACHE_DIR") + .ok() + .map(std::path::PathBuf::from); + + // Versioned cache key since copilot asset names don't include the version. + let cache_key = format!("v{version}-{}", platform.asset_name); + + if std::env::var_os("CARGO_FEATURE_BUNDLED_CLI").is_some() { + // Embed mode: we need the archive bytes to bake into the rlib, so + // always run the download (cache hit short-circuits inside + // `cached_download`). + let archive = cached_download( + &format!("{base_url}/{}", platform.asset_name), + &cache_key, + &expected_hash, + &cache_dir, + ); + verify_binary_present_in_archive(&archive, platform.binary_name, platform.asset_name); + emit_embedded(out, &archive); + println!("cargo:rustc-cfg=has_bundled_cli"); + } else { + // With `bundled-cli` off the extracted binary *is* the cache. + // Skip the upstream download entirely when it already exists at + // the expected path. No two separate caches. + // + // Runtime resolution (see `src/resolve.rs::extracted_cli_path`) + // recomputes this same path from `COPILOT_SDK_CLI_VERSION` + the + // OS-derived binary name + optional `COPILOT_CLI_EXTRACT_DIR`, + // so we don't bake an absolute path into the crate. + let install_dir = extracted_install_dir(&version); + let final_path = install_dir.join(platform.binary_name); + + // Invalidate build.rs whenever the cached binary disappears (cache GC, + // manual rm, OS reset, switching extract dir). Without this, cargo + // replays the saved `has_extracted_cli` cfg from its build-script + // output cache even when the file is gone, and runtime resolution + // fails with BinaryNotFound. + println!("cargo:rerun-if-changed={}", final_path.display()); + + if !final_path.is_file() { + let archive = cached_download( + &format!("{base_url}/{}", platform.asset_name), + &cache_key, + &expected_hash, + &cache_dir, + ); + verify_binary_present_in_archive(&archive, platform.binary_name, platform.asset_name); + extract_to_cache(&archive, &install_dir, platform); + } + + // Re-check after potential download+extract above; not an `else` + // because we need to verify the extraction actually produced the file. + if final_path.is_file() { + println!("cargo:rustc-cfg=has_extracted_cli"); + } + } +} + +/// Install directory used when `bundled-cli` is off. Mirrors the runtime +/// convention in `src/resolve.rs::extracted_cli_path`: both sides MUST +/// compute the same path from the same inputs, otherwise the runtime +/// resolver won't find what build.rs extracted. +/// +/// If `COPILOT_CLI_EXTRACT_DIR` is set the binary lives directly under +/// that directory (no per-version subdir) — useful for vendored slots and +/// for `.cargo/config.toml [env]`-style pinning that's symmetric between +/// build-time write and runtime read. Otherwise the binary lives under +/// `/github-copilot-sdk/cli//`. +fn extracted_install_dir(version: &str) -> PathBuf { + if let Some(custom) = std::env::var_os("COPILOT_CLI_EXTRACT_DIR") { + PathBuf::from(custom) + } else { + let cache = dirs::cache_dir().unwrap_or_else(std::env::temp_dir); + cache + .join("github-copilot-sdk") + .join("cli") + .join(sanitize_version(version)) + } +} + +/// Emit the `bundled_cli.rs` glue + `copilot_cli.archive` blob into `OUT_DIR` +/// for embed mode (`bundled-cli` cargo feature on). The version is exposed +/// crate-wide via the unconditional `cargo:rustc-env=COPILOT_SDK_CLI_VERSION` +/// emit; the binary name is OS-derived at runtime — so all we need to +/// generate here is the archive blob include. +fn emit_embedded(out: &Path, archive: &[u8]) { + std::fs::write(out.join("copilot_cli.archive"), archive) + .expect("failed to write copilot_cli.archive"); + + let generated = r#"// Auto-generated by github-copilot-sdk build.rs. Do not edit. +pub(super) static CLI_ARCHIVE: &[u8] = include_bytes!("copilot_cli.archive"); +"#; + + std::fs::write(out.join("bundled_cli.rs"), generated).expect("failed to write bundled_cli.rs"); +} + +/// Resolve the CLI version and the expected SHA-256 hash for the current +/// target's archive. Picks one of two sources in order. Panics with a clear +/// error if neither is available. +fn resolve_version_and_hash(asset_name: &str) -> (String, String) { + let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR is set"); + + // 1. Snapshot file at the crate root (published-crate consumer, + // vendored-slot consumer). Combined version + per-asset hashes. + let snapshot = Path::new(&manifest_dir).join("cli-version.txt"); + if snapshot.is_file() { + let contents = std::fs::read_to_string(&snapshot) + .unwrap_or_else(|e| panic!("failed to read {}: {e}", snapshot.display())); + return parse_snapshot(&contents, asset_name) + .unwrap_or_else(|e| panic!("invalid {}: {e}", snapshot.display())); + } + + // 2. Lockfile fallback (contributor build inside github/copilot-sdk) — + // read version, fetch live SHA256SUMS. + let lockfile = Path::new(&manifest_dir) + .join("..") + .join("nodejs") + .join("package-lock.json"); + if lockfile.is_file() { + let version = read_version_from_package_lock(&lockfile); + let hash = fetch_live_sha256(&version, asset_name); + return (version, hash); + } + + panic!( + "Could not resolve the Copilot CLI version.\n\ + Tried:\n\ + - {} (missing)\n\ + - {} (missing)\n\ + In a published crate or vendored slot, `cli-version.txt` should be present.\n\ + Inside the github/copilot-sdk repo, `../nodejs/package-lock.json` is the source.", + snapshot.display(), + lockfile.display(), + ); +} + +/// Parse the `cli-version.txt` snapshot file. Format is one `key=value` per +/// line. The first non-comment line is `version=X.Y.Z`; subsequent lines map +/// asset filename to hex SHA-256. Blank lines and lines starting with `#` +/// are skipped. +fn parse_snapshot(contents: &str, asset_name: &str) -> Result<(String, String), String> { + let mut version: Option = None; + let mut hash: Option = None; + for (line_no, raw) in contents.lines().enumerate() { + let line = raw.trim(); + if line.is_empty() || line.starts_with('#') { + continue; + } + let Some((key, value)) = line.split_once('=') else { + return Err(format!( + "line {}: expected `key=value`, got `{raw}`", + line_no + 1 + )); + }; + match key.trim() { + "version" => version = Some(value.trim().to_string()), + k if k == asset_name => hash = Some(value.trim().to_string()), + _ => {} + } + } + let version = version.ok_or("missing `version=` line")?; + let hash = hash.ok_or_else(|| format!("missing hash for asset `{asset_name}`"))?; + Ok((version, hash)) +} + +/// Read the `@github/copilot` version from `nodejs/package-lock.json`. +fn read_version_from_package_lock(path: &Path) -> String { + let contents = std::fs::read_to_string(path) + .unwrap_or_else(|e| panic!("failed to read {}: {e}", path.display())); + // Minimal JSON walk: find `"node_modules/@github/copilot"` object and + // its `"version"` field. Full JSON parsing keeps build.rs dep-light by + // using a regex; the file is generated by npm and we're matching an + // exact key path. + let key = "\"node_modules/@github/copilot\""; + let key_pos = contents + .find(key) + .unwrap_or_else(|| panic!("{} does not contain {key}", path.display())); + let after_key = &contents[key_pos + key.len()..]; + let version_key = "\"version\""; + let v_pos = after_key + .find(version_key) + .unwrap_or_else(|| panic!("no `version` field found near {key} in {}", path.display())); + let after_v = &after_key[v_pos + version_key.len()..]; + let q1 = after_v.find('"').expect("malformed version"); + let after_q1 = &after_v[q1 + 1..]; + let q2 = after_q1.find('"').expect("malformed version"); + after_q1[..q2].to_string() +} + +/// Fetch the live `SHA256SUMS.txt` for the given version from GitHub Releases +/// and pluck out the entry for `asset_name`. +fn fetch_live_sha256(version: &str, asset_name: &str) -> String { + let base_url = format!("https://github.com/github/copilot-cli/releases/download/v{version}"); + let checksums_url = format!("{base_url}/SHA256SUMS.txt"); + let checksums = download_with_retry(&checksums_url); + let checksums_text = + std::str::from_utf8(&checksums).expect("checksums file is not valid UTF-8"); + find_sha256_for_asset(checksums_text, asset_name) +} + +#[derive(Clone, Copy)] +struct Platform { + asset_name: &'static str, + binary_name: &'static str, +} + +fn target_platform() -> Option { + let os = std::env::var("CARGO_CFG_TARGET_OS").ok()?; + let arch = std::env::var("CARGO_CFG_TARGET_ARCH").ok()?; + + match (os.as_str(), arch.as_str()) { + ("macos", "aarch64") => Some(Platform { + asset_name: "copilot-darwin-arm64.tar.gz", + binary_name: "copilot", + }), + ("macos", "x86_64") => Some(Platform { + asset_name: "copilot-darwin-x64.tar.gz", + binary_name: "copilot", + }), + ("linux", "x86_64") => Some(Platform { + asset_name: "copilot-linux-x64.tar.gz", + binary_name: "copilot", + }), + ("linux", "aarch64") => Some(Platform { + asset_name: "copilot-linux-arm64.tar.gz", + binary_name: "copilot", + }), + ("windows", "x86_64") => Some(Platform { + asset_name: "copilot-win32-x64.zip", + binary_name: "copilot.exe", + }), + ("windows", "aarch64") => Some(Platform { + asset_name: "copilot-win32-arm64.zip", + binary_name: "copilot.exe", + }), + _ => None, + } +} + +/// Write the single binary entry from `archive` to +/// `/` and return the resulting path. +/// Idempotent — returns the existing path if a previous build already +/// populated the target. +/// +/// Uses file-level staging + atomic rename so a concurrent reader during +/// a parallel `cargo build` race never observes a partially-written +/// binary. `fs::rename` for files is atomic on both Unix and Windows +/// (Windows uses `MoveFileExW` with `MOVEFILE_REPLACE_EXISTING`); for +/// directories it is not, which is why we stage at file granularity. +fn extract_to_cache(archive: &[u8], install_dir: &Path, platform: Platform) -> PathBuf { + let final_path = install_dir.join(platform.binary_name); + + // Caller already gated on `final_path.is_file()`; this is a safety + // net for any future caller that forgets. + if final_path.is_file() { + return final_path; + } + + std::fs::create_dir_all(install_dir).unwrap_or_else(|e| { + panic!( + "failed to create install dir {}: {e}", + install_dir.display() + ) + }); + + let bytes = extract_binary_bytes(archive, platform); + + // Staging file is a sibling of the final binary so the rename stays + // on the same filesystem (cross-fs rename is not atomic). PID + nanos + // disambiguate concurrent builds racing on the same cache. + let nanos = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_nanos()) + .unwrap_or(0); + let staging_path = install_dir.join(format!( + ".{}.staging-{}-{nanos}", + platform.binary_name, + std::process::id(), + )); + + { + let mut f = std::fs::File::create(&staging_path).unwrap_or_else(|e| { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to create staging file {}: {e}", + staging_path.display() + ); + }); + + if let Err(e) = f.write_all(&bytes) { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to write staging file {}: {e}", + staging_path.display() + ); + } + + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt; + if let Err(e) = f.set_permissions(std::fs::Permissions::from_mode(0o755)) { + let _ = std::fs::remove_file(&staging_path); + panic!("failed to chmod {}: {e}", staging_path.display()); + } + } + + // Backdate the staged binary to the Unix epoch before it lands. We emit + // `cargo:rerun-if-changed` on `final_path` (see caller) so a *deleted* + // cache binary forces a re-extract — but cargo stamps the build-script + // `output` reference when the script is spawned, seconds before this + // freshly-downloaded binary is written. A current mtime would therefore + // be *newer* than that reference, so the next identical `cargo` + // invocation would see the watched file as "changed" and pointlessly + // rerun build.rs + recompile the crate + relink every downstream crate. + // Pinning to the epoch keeps the file unambiguously older than any real + // build reference; `rename` preserves mtime (same inode), so it lands + // already-backdated and a no-change rebuild stays a true no-op. The + // deleted-file recovery contract is untouched: a missing file can't be + // stat'd, so cargo still treats it as stale and reruns regardless. + // + // Best-effort: a filesystem that refuses the epoch (e.g. FAT's 1980 floor + // clamps it — still older than any real reference) or rejects the call + // just reverts to the pre-fix redundant-rebuild behaviour, never a broken + // build. + if let Err(e) = f.set_modified(std::time::SystemTime::UNIX_EPOCH) { + println!( + "cargo:warning=Could not backdate {} (a redundant rebuild may occur): {e}", + staging_path.display() + ); + } + } + + // Atomic file-replace on both Unix and Windows. If a concurrent build + // already produced the same file the rename overwrites it; the bytes + // are SHA-verified-identical so replacement is safe. + if let Err(e) = std::fs::rename(&staging_path, &final_path) { + let _ = std::fs::remove_file(&staging_path); + panic!( + "failed to rename {} -> {}: {e}", + staging_path.display(), + final_path.display() + ); + } + + // Surface where the binary landed so contributors can find it. Quiet + // on the hot path: the caller's `is_file()` short-circuit (and the + // safety net at the top of this function) means this only fires on a + // true cache miss. + println!( + "cargo:warning=Extracted Copilot CLI to {}", + final_path.display() + ); + + final_path +} + +/// Replace characters outside `[a-zA-Z0-9._-]` with `_` so the version +/// string is always safe to use as a path component. Kept in sync with +/// `embeddedcli::sanitize_version` and `resolve::sanitize_version` so all +/// three resolve to the same cache directory for any given version. +fn sanitize_version(version: &str) -> String { + version + .chars() + .map(|c| match c { + 'a'..='z' | 'A'..='Z' | '0'..='9' | '.' | '-' | '_' => c, + _ => '_', + }) + .collect() +} + +/// Extract the single `binary_name` entry from the release archive. Reused +/// between embed mode's `verify_binary_present_in_archive` and the +/// `extract_to_cache` path used when `bundled-cli` is off. Panics if the +/// entry isn't found — callers have already invoked +/// `verify_binary_present_in_archive`. +fn extract_binary_bytes(archive: &[u8], platform: Platform) -> Vec { + if platform.asset_name.ends_with(".zip") { + let cursor = std::io::Cursor::new(archive); + let mut zip = zip::ZipArchive::new(cursor) + .unwrap_or_else(|e| panic!("failed to open zip archive: {e}")); + for i in 0..zip.len() { + let mut entry = zip + .by_index(i) + .unwrap_or_else(|e| panic!("failed to read zip entry {i}: {e}")); + let name = entry.name().to_string(); + if name == platform.binary_name || name.ends_with(&format!("/{}", platform.binary_name)) + { + let mut bytes = Vec::with_capacity(entry.size() as usize); + std::io::copy(&mut entry, &mut bytes) + .unwrap_or_else(|e| panic!("failed to read zip entry bytes: {e}")); + return bytes; + } + } + } else { + let gz = flate2::read::GzDecoder::new(archive); + let mut tar = tar::Archive::new(gz); + for entry in tar + .entries() + .unwrap_or_else(|e| panic!("failed to read tar entries: {e}")) + { + let mut entry = entry.unwrap_or_else(|e| panic!("failed to read tar entry: {e}")); + let path = entry + .path() + .unwrap_or_else(|e| panic!("failed to read tar entry path: {e}")); + let name = path.to_string_lossy().into_owned(); + if name == platform.binary_name || name.ends_with(&format!("/{}", platform.binary_name)) + { + let mut bytes = Vec::with_capacity(entry.size() as usize); + entry + .read_to_end(&mut bytes) + .unwrap_or_else(|e| panic!("failed to read tar entry bytes: {e}")); + return bytes; + } + } + } + panic!( + "binary `{}` not found in archive `{}`", + platform.binary_name, platform.asset_name + ); +} + +/// Read a file from the download cache, or download it (with retries) and save +/// to cache. Verifies SHA-256 on every path. Evicts stale/corrupt cache entries +/// automatically. Cache I/O failures are treated as cache misses — they never +/// break the build. +fn cached_download( + url: &str, + cache_key: &str, + expected_hash: &str, + cache_dir: &Option, +) -> Vec { + if let Some(dir) = cache_dir { + let cached_path = dir.join(cache_key); + if cached_path.is_file() { + match std::fs::read(&cached_path) { + Ok(data) if hex_sha256(&data) == expected_hash => { + // Silent cache hit — nothing to surface. + return data; + } + Ok(_) => { + println!("cargo:warning=Cached archive hash mismatch, re-downloading"); + let _ = std::fs::remove_file(&cached_path); + } + Err(e) => { + println!( + "cargo:warning=Failed to read cache {}, re-downloading: {e}", + cached_path.display() + ); + } + } + } + } + + println!("cargo:warning=Downloading {url}"); + let data = download_with_retry(url); + let actual_hash = hex_sha256(&data); + if actual_hash != expected_hash { + panic!( + "Archive integrity check failed for {url}!\n expected: {expected_hash}\n actual: {actual_hash}\n \ + This could indicate a corrupted download or a supply-chain attack." + ); + } + + if let Some(dir) = cache_dir { + if let Err(e) = std::fs::create_dir_all(dir) { + println!( + "cargo:warning=Failed to create cache directory {}: {e}", + dir.display() + ); + } else { + let cached_path = dir.join(cache_key); + println!("cargo:warning=Caching archive at {}", cached_path.display()); + if let Err(e) = std::fs::write(&cached_path, &data) { + println!( + "cargo:warning=Failed to write cache file {}: {e}", + cached_path.display() + ); + } + } + } + + data +} + +/// Maximum number of HTTP attempts (one initial + this many retries on transient errors). +const MAX_RETRIES: u32 = 3; + +/// Download `url` with bounded retries on transient network errors. Backoff is +/// exponential starting at 1s. 4xx responses fail fast; 5xx and connect/read +/// errors are retried. +fn download_with_retry(url: &str) -> Vec { + let mut attempt = 0u32; + loop { + attempt += 1; + match try_download(url) { + Ok(bytes) => return bytes, + Err(err) if err.transient && attempt <= MAX_RETRIES => { + let backoff = Duration::from_secs(1u64 << (attempt - 1)); + println!( + "cargo:warning=Transient download failure for {url} (attempt {attempt}/{}): {} — retrying in {}s", + MAX_RETRIES + 1, + err.message, + backoff.as_secs(), + ); + std::thread::sleep(backoff); + } + Err(err) => panic!("Failed to download {url}: {}", err.message), + } + } +} + +struct DownloadError { + message: String, + transient: bool, +} + +fn try_download(url: &str) -> Result, DownloadError> { + let connector = native_tls::TlsConnector::new().map_err(|e| DownloadError { + message: format!("native-tls init error: {e}"), + transient: false, + })?; + let agent = ureq::AgentBuilder::new() + .tls_connector(std::sync::Arc::new(connector)) + .timeout_connect(Duration::from_secs(30)) + .timeout_read(Duration::from_secs(120)) + .build(); + + match agent.get(url).call() { + Ok(response) => { + let mut bytes = Vec::new(); + response + .into_reader() + .read_to_end(&mut bytes) + .map_err(|e| DownloadError { + message: format!("read error: {e}"), + transient: true, + })?; + Ok(bytes) + } + // 5xx — server-side, treat as transient. + Err(ureq::Error::Status(code, response)) if (500..600).contains(&code) => { + Err(DownloadError { + message: format!("HTTP {code} {}", response.status_text()), + transient: true, + }) + } + // 4xx — client-side, fail fast. + Err(ureq::Error::Status(code, response)) => Err(DownloadError { + message: format!("HTTP {code} {}", response.status_text()), + transient: false, + }), + // Transport-layer (DNS, connect, TLS, read timeout) — treat as transient. + Err(ureq::Error::Transport(t)) => Err(DownloadError { + message: format!("transport error: {t}"), + transient: true, + }), + } +} + +fn find_sha256_for_asset(sums: &str, asset_name: &str) -> String { + for line in sums.lines() { + // Format: " " (two spaces) + if let Some((hash, name)) = line.split_once(" ") + && name.trim() == asset_name + { + return hash.trim().to_string(); + } + } + panic!("SHA256SUMS.txt does not contain an entry for {asset_name}"); +} + +fn sha256(data: &[u8]) -> [u8; 32] { + let mut hasher = sha2::Sha256::new(); + hasher.update(data); + hasher.finalize().into() +} + +/// Walks the downloaded archive at build time to confirm an entry matching +/// `binary_name` exists. Panics with a clear message if not — defends against +/// silent breakage if the upstream archive layout ever changes. +fn verify_binary_present_in_archive(archive: &[u8], binary_name: &str, asset_name: &str) { + let found = if asset_name.ends_with(".zip") { + archive_contains_zip_entry(archive, binary_name) + } else { + archive_contains_tar_entry(archive, binary_name) + }; + if !found { + panic!( + "Copilot CLI archive `{asset_name}` does not contain an entry named `{binary_name}`. \ + The upstream archive layout may have changed; runtime extraction would fail. \ + Update `verify_binary_present_in_archive` in build.rs and the matching `extract_binary` in src/embeddedcli.rs." + ); + } +} + +fn archive_contains_tar_entry(targz: &[u8], binary_name: &str) -> bool { + let gz = flate2::read::GzDecoder::new(targz); + let mut archive = tar::Archive::new(gz); + let Ok(entries) = archive.entries() else { + return false; + }; + for entry in entries.flatten() { + let Ok(path) = entry.path() else { + continue; + }; + let name = path.to_string_lossy(); + if name == binary_name || name.ends_with(&format!("/{binary_name}")) { + return true; + } + } + false +} + +fn archive_contains_zip_entry(zip_bytes: &[u8], binary_name: &str) -> bool { + let cursor = std::io::Cursor::new(zip_bytes); + let Ok(mut archive) = zip::ZipArchive::new(cursor) else { + return false; + }; + for i in 0..archive.len() { + let Ok(entry) = archive.by_index(i) else { + continue; + }; + let name = entry.name(); + if name == binary_name || name.ends_with(&format!("/{binary_name}")) { + return true; + } + } + false +} + +fn hex_sha256(data: &[u8]) -> String { + sha256(data).iter().map(|b| format!("{b:02x}")).collect() +} diff --git a/rust/examples/manual_tool_resume.rs b/rust/examples/manual_tool_resume.rs index 9ce9f0964..ad8ad5a04 100644 --- a/rust/examples/manual_tool_resume.rs +++ b/rust/examples/manual_tool_resume.rs @@ -2,11 +2,11 @@ use std::time::Duration; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ HandlePendingToolCallRequest, PermissionDecision, PermissionDecisionApproveOnce, PermissionDecisionApproveOnceKind, PermissionDecisionRequest, }; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::session_events::{ AssistantMessageData, ExternalToolRequestedData, PermissionRequestedData, SessionEventType, }; use github_copilot_sdk::subscription::RecvError; @@ -113,8 +113,10 @@ async fn main() -> Result<(), Box> { .rpc() .permissions() .handle_pending_permission_request(PermissionDecisionRequest { + decision_context: None, request_id: permission.request_id, result: PermissionDecision::ApproveOnce(PermissionDecisionApproveOnce { + approved_interactively: None, kind: PermissionDecisionApproveOnceKind::ApproveOnce, }), }) diff --git a/rust/scripts/snapshot-bundled-in-process-version.sh b/rust/scripts/snapshot-bundled-in-process-version.sh new file mode 100755 index 000000000..8743f9d17 --- /dev/null +++ b/rust/scripts/snapshot-bundled-in-process-version.sh @@ -0,0 +1,55 @@ +#!/usr/bin/env bash +# +# Snapshot the Copilot CLI version + per-platform npm integrity values for the +# rust crate's bundled-in-process build path. + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +RUST_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)" +REPO_ROOT="$(cd "${RUST_DIR}/.." && pwd)" +LOCKFILE="${REPO_ROOT}/nodejs/package-lock.json" +OUTPUT="${RUST_DIR}/cli-version-in-process.txt" + +if [[ ! -f "${LOCKFILE}" ]]; then + echo "error: ${LOCKFILE} not found" >&2 + exit 1 +fi + +VERSION="$(node -e "console.log(require('${LOCKFILE}').packages['node_modules/@github/copilot'].version)")" +if [[ -z "${VERSION}" ]]; then + echo "error: could not read @github/copilot version from ${LOCKFILE}" >&2 + exit 1 +fi + +PACKAGES=( + "copilot-darwin-arm64" + "copilot-darwin-x64" + "copilot-linux-arm64" + "copilot-linux-x64" + "copilot-linuxmusl-arm64" + "copilot-linuxmusl-x64" + "copilot-win32-arm64" + "copilot-win32-x64" +) + +declare -A INTEGRITIES +for package in "${PACKAGES[@]}"; do + integrity="$(node -e "console.log(require('${LOCKFILE}').packages['node_modules/@github/${package}'].integrity)")" + if [[ -z "${integrity}" ]]; then + echo "error: package-lock.json missing integrity for @github/${package}" >&2 + exit 1 + fi + INTEGRITIES[$package]="${integrity}" +done + +{ + echo "# Auto-generated by rust/scripts/snapshot-bundled-in-process-version.sh" + echo "# Do not edit. Regenerated by the publish workflow on every release." + echo "version=${VERSION}" + for package in "${PACKAGES[@]}"; do + echo "${package}=${INTEGRITIES[$package]}" + done +} > "${OUTPUT}" + +echo "Wrote ${OUTPUT} (version=${VERSION}, ${#PACKAGES[@]} integrity values)" diff --git a/rust/src/canvas.rs b/rust/src/canvas.rs index 675e0c606..ddb92a11e 100644 --- a/rust/src/canvas.rs +++ b/rust/src/canvas.rs @@ -140,7 +140,7 @@ pub type CanvasResult = Result; /// The handler receives every inbound `canvas.open` / `canvas.close` / /// `canvas.action.invoke` JSON-RPC request the runtime issues for this /// session and decides — typically by inspecting -/// [`CanvasProviderOpenRequest::canvas_id`](crate::generated::api_types::CanvasProviderOpenRequest::canvas_id) +/// [`CanvasProviderOpenRequest::canvas_id`](crate::rpc::CanvasProviderOpenRequest::canvas_id) /// — which application-side canvas should handle the call. /// /// The SDK does not maintain a per-canvas registry; multiplexing across diff --git a/rust/src/copilot_request_handler.rs b/rust/src/copilot_request_handler.rs new file mode 100644 index 000000000..961ae3876 --- /dev/null +++ b/rust/src/copilot_request_handler.rs @@ -0,0 +1,1222 @@ +//! Connection-level interception of the model-layer HTTP and WebSocket traffic +//! the runtime issues — for both CAPI and BYOK sessions. +//! +//! When [`ClientOptions::request_handler`](crate::ClientOptions::request_handler) +//! is set, the SDK registers itself as the runtime's request handler on +//! [`Client::start`](crate::Client::start). From then on, whenever the runtime +//! would issue a model-layer request (inference, `/models`, `/policy`, …) it +//! asks the registered [`CopilotRequestHandler`] to service it instead of making +//! the call itself. +//! +//! [`CopilotRequestHandler`] is the single seam consumers implement: one HTTP +//! send method and one WebSocket factory, each defaulting to transparent +//! pass-through to the real upstream. Override +//! [`send_request`](CopilotRequestHandler::send_request) to mutate / replace HTTP +//! requests, or [`open_websocket`](CopilotRequestHandler::open_websocket) to +//! mutate the handshake or return a custom [`CopilotWebSocketHandler`]. +//! +//! # Cancellation +//! +//! [`CopilotRequestContext::cancel`] fires when the runtime cancels the +//! in-flight request (for example because the agent turn was aborted). Forward +//! it to the upstream call so it is torn down too, and stop writing the response. + +use std::collections::HashMap; +use std::pin::Pin; +use std::sync::{Arc, LazyLock, OnceLock, Weak}; + +use async_trait::async_trait; +use base64::Engine; +use bytes::Bytes; +use futures_util::{SinkExt, Stream, StreamExt}; +use http::HeaderMap; +use http::header::{HeaderName, HeaderValue}; +use parking_lot::Mutex; +use tokio::net::TcpStream; +use tokio::sync::{Mutex as AsyncMutex, mpsc}; +use tokio_tungstenite::tungstenite::Message; +use tokio_tungstenite::tungstenite::client::IntoClientRequest; +use tokio_tungstenite::{MaybeTlsStream, WebSocketStream, connect_async}; +use tokio_util::sync::CancellationToken; +use tracing::warn; + +use crate::generated::api_types::{ + LlmInferenceHttpRequestChunkRequest, LlmInferenceHttpRequestStartRequest, + LlmInferenceHttpRequestStartTransport, LlmInferenceHttpResponseChunkError, + LlmInferenceHttpResponseChunkRequest, LlmInferenceHttpResponseStartRequest, +}; +use crate::{ + Client, ClientInner, JsonRpcRequest, JsonRpcResponse, RequestId, SessionId, error_codes, +}; + +const METHOD_HTTP_REQUEST_START: &str = "llmInference.httpRequestStart"; +const METHOD_HTTP_REQUEST_CHUNK: &str = "llmInference.httpRequestChunk"; + +/// Transport the runtime would otherwise use for an intercepted request. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] +pub enum CopilotRequestTransport { + /// Plain HTTP or SSE. Each response body frame is an opaque byte range. + #[default] + Http, + /// Full-duplex WebSocket. Each request/response body frame maps to exactly + /// one WebSocket message. + WebSocket, +} + +impl CopilotRequestTransport { + fn from_wire(value: Option) -> Self { + match value { + Some(LlmInferenceHttpRequestStartTransport::Websocket) => Self::WebSocket, + _ => Self::Http, + } + } +} + +/// Error returned by a [`CopilotRequestHandler`] hook or the response stream. +#[derive(Debug)] +#[non_exhaustive] +pub enum CopilotRequestError { + /// The response was used after the RPC connection to the runtime closed. + ConnectionClosed, + + /// The response state machine was violated (for example `start` called + /// twice, or a write before `start`). + InvalidState(String), + + /// An upstream transport failure while forwarding the request. + Upstream(String), + + /// A failure surfaced by the consumer's own handler. + Handler(String), + + /// An RPC error talking to the runtime. + Rpc(crate::Error), +} + +impl CopilotRequestError { + /// Construct a handler-level error from a message — the idiomatic way for a + /// consumer to fail an intercepted request. + pub fn message(message: impl Into) -> Self { + Self::Handler(message.into()) + } +} + +impl std::fmt::Display for CopilotRequestError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::ConnectionClosed => { + f.write_str("Copilot request response used after RPC connection closed") + } + Self::InvalidState(message) | Self::Upstream(message) | Self::Handler(message) => { + f.write_str(message) + } + Self::Rpc(err) => write!(f, "{err}"), + } + } +} + +impl std::error::Error for CopilotRequestError { + fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { + match self { + Self::Rpc(err) => Some(err), + _ => None, + } + } +} + +impl From for CopilotRequestError { + fn from(err: crate::Error) -> Self { + Self::Rpc(err) + } +} + +/// Context describing an intercepted request, shared by the HTTP and WebSocket +/// seams. +#[derive(Clone)] +#[non_exhaustive] +pub struct CopilotRequestContext { + /// Opaque runtime-minted request id, stable across the request lifecycle. + pub request_id: String, + /// Id of the runtime session that triggered this request, or `None` when it + /// was issued outside any session (for example the startup model catalog). + pub session_id: Option, + /// Stable per-agent-instance id for the agent trajectory that issued this request. + pub agent_id: Option, + /// Id of the parent agent when this request was issued by a subagent. + pub parent_agent_id: Option, + /// Runtime classification for the interaction that produced this request. + pub interaction_type: Option, + /// Transport the runtime would otherwise use. + pub transport: CopilotRequestTransport, + /// Absolute request URL. + pub url: String, + /// Request headers, multi-valued. + pub headers: HeaderMap, + /// Fires when the runtime cancels this in-flight request. + pub cancel: CancellationToken, +} + +/// Streaming response body: a sequence of byte chunks or a terminal error. +pub type CopilotHttpResponseBody = + Pin> + Send>>; + +/// A buffered HTTP request handed to [`CopilotRequestHandler::send_request`]. +#[non_exhaustive] +pub struct CopilotHttpRequest { + /// HTTP method (`GET`, `POST`, …). + pub method: String, + /// Absolute request URL. + pub url: String, + /// Request headers. + pub headers: HeaderMap, + /// Fully-buffered request body. + pub body: Vec, + /// Fires when the runtime cancels the request. + pub cancel: CancellationToken, +} + +/// A streaming HTTP response returned by [`CopilotRequestHandler::send_request`]. +#[non_exhaustive] +pub struct CopilotHttpResponse { + /// HTTP status code. + pub status: u16, + /// Optional status reason phrase. + pub status_text: Option, + /// Response headers. + pub headers: HeaderMap, + /// Streaming response body. + pub body: CopilotHttpResponseBody, +} + +impl CopilotHttpResponse { + /// Build a response with the given parts. + pub fn new( + status: u16, + status_text: Option, + headers: HeaderMap, + body: CopilotHttpResponseBody, + ) -> Self { + Self { + status, + status_text, + headers, + body, + } + } +} + +/// A single WebSocket message flowing through a [`CopilotWebSocketHandler`]. +#[derive(Clone)] +pub struct CopilotWebSocketMessage { + /// Message payload. + pub data: Vec, + /// Whether the payload is a binary frame (`true`) or a text frame (`false`). + pub binary: bool, +} + +impl CopilotWebSocketMessage { + /// A UTF-8 text message. Binary messages are constructed directly via the + /// public `data` / `binary` fields. + pub fn from_text(data: impl Into) -> Self { + Self { + data: data.into().into_bytes(), + binary: false, + } + } +} + +/// The runtime-facing side of a WebSocket: a [`CopilotWebSocketHandler`] writes +/// upstream→runtime messages here. +#[derive(Clone)] +pub struct CopilotWebSocketResponse { + exchange: Arc, +} + +impl CopilotWebSocketResponse { + fn new(exchange: Arc) -> Self { + Self { exchange } + } + + /// Forward one upstream message to the runtime. + pub async fn send_message( + &self, + message: CopilotWebSocketMessage, + ) -> Result<(), CopilotRequestError> { + self.exchange.ensure_ws_started().await?; + if message.binary { + self.exchange.write_binary(&message.data).await + } else { + let text = String::from_utf8_lossy(&message.data); + self.exchange.write_text(&text).await + } + } + + /// End the runtime response stream (the upstream connection closed). + pub async fn close(&self) -> Result<(), CopilotRequestError> { + self.exchange.end_response().await + } + + async fn fail( + &self, + message: impl Into, + code: Option, + ) -> Result<(), CopilotRequestError> { + self.exchange.error_response(message, code).await + } +} + +/// A per-connection WebSocket handler. The default implementation +/// ([`CopilotWebSocketForwarder`]) bridges to the real upstream; +/// override [`CopilotRequestHandler::open_websocket`] to supply a custom one. +#[async_trait] +pub trait CopilotWebSocketHandler: Send + Sync { + /// Forward one runtime→upstream message. + async fn send_request_message( + &self, + message: CopilotWebSocketMessage, + ) -> Result<(), CopilotRequestError>; + + /// Tear down the upstream connection. + async fn close(&self) -> Result<(), CopilotRequestError>; +} + +/// The connection-level Copilot request seam. +/// +/// One implementor services both transports. Defaults forward transparently to +/// the real upstream, so overriding nothing yields a pass-through; override a +/// method to mutate or replace traffic. +#[async_trait] +pub trait CopilotRequestHandler: Send + Sync + 'static { + /// Service one intercepted HTTP request. Default: forward to the real + /// upstream via [`forward_http`]. Override to mutate the request before + /// forwarding, mutate the response after, or replace the call entirely. + async fn send_request( + &self, + request: CopilotHttpRequest, + _ctx: &CopilotRequestContext, + ) -> Result { + forward_http(request).await + } + + /// Open a per-connection WebSocket handler. Default: a + /// [`CopilotWebSocketForwarder`] wired to the real upstream. + /// Override to mutate the handshake (URL / headers via `ctx`) or return a + /// custom handler. + /// + /// Unlike the other SDKs, Rust passes `response` — the runtime-facing sink + /// for upstream→runtime messages — as a second argument here rather than + /// exposing a base-class `send_response_message` helper. A custom handler + /// must store this `CopilotWebSocketResponse` in the returned handler struct + /// and call [`CopilotWebSocketResponse::send_message`] on it to push + /// upstream messages back to the runtime. + async fn open_websocket( + &self, + ctx: &CopilotRequestContext, + response: CopilotWebSocketResponse, + ) -> Result, CopilotRequestError> { + let handler = CopilotWebSocketForwarder::builder(ctx.url.clone(), ctx.headers.clone()) + .connect(response) + .await?; + Ok(Box::new(handler)) + } +} + +/// Forward through a shared handler, so an `Arc` can be registered while the +/// consumer retains a handle (for example to read state the handler records). +#[async_trait] +impl CopilotRequestHandler for Arc { + async fn send_request( + &self, + request: CopilotHttpRequest, + ctx: &CopilotRequestContext, + ) -> Result { + (**self).send_request(request, ctx).await + } + + async fn open_websocket( + &self, + ctx: &CopilotRequestContext, + response: CopilotWebSocketResponse, + ) -> Result, CopilotRequestError> { + (**self).open_websocket(ctx, response).await + } +} +/// fresh upstream connection. +const FORBIDDEN_HEADERS: &[&str] = &[ + "host", + "connection", + "content-length", + "transfer-encoding", + "keep-alive", + "upgrade", + "proxy-connection", + "te", + "trailer", +]; + +fn is_forbidden_header(name: &HeaderName) -> bool { + let name = name.as_str(); + FORBIDDEN_HEADERS.contains(&name) || name.starts_with("sec-websocket") +} + +/// Drop headers that belong to the inbound connection rather than the request. +fn strip_forbidden_headers(headers: &mut HeaderMap) { + let forbidden: Vec = headers + .keys() + .filter(|name| is_forbidden_header(name)) + .cloned() + .collect(); + for name in forbidden { + headers.remove(&name); + } +} + +static SHARED_HTTP_CLIENT: LazyLock = LazyLock::new(|| { + reqwest::Client::builder() + .redirect(reqwest::redirect::Policy::none()) + .build() + .expect("default reqwest client must build") +}); + +/// Forward an HTTP request to its real upstream and stream the response back. +/// +/// This is the default behaviour of [`CopilotRequestHandler::send_request`]; +/// consumers that mutate a request can call it to forward the mutated request. +pub async fn forward_http( + request: CopilotHttpRequest, +) -> Result { + let method = reqwest::Method::from_bytes(request.method.as_bytes()) + .map_err(|e| CopilotRequestError::InvalidState(format!("invalid HTTP method: {e}")))?; + + let mut headers = request.headers; + strip_forbidden_headers(&mut headers); + + let mut builder = SHARED_HTTP_CLIENT + .request(method, &request.url) + .headers(headers); + if !request.body.is_empty() { + builder = builder.body(request.body); + } + + let response = tokio::select! { + _ = request.cancel.cancelled() => { + return Err(CopilotRequestError::message("Request cancelled by runtime")); + } + result = builder.send() => result.map_err(|e| CopilotRequestError::Upstream(e.to_string()))?, + }; + + let status = response.status().as_u16(); + let status_text = response.status().canonical_reason().map(str::to_string); + let headers = response.headers().clone(); + let body = response + .bytes_stream() + .map(|item| item.map_err(|e| CopilotRequestError::Upstream(e.to_string()))); + + Ok(CopilotHttpResponse { + status, + status_text, + headers, + body: Box::pin(body), + }) +} + +type UpstreamWrite = + futures_util::stream::SplitSink>, Message>; + +/// Transform applied to a WebSocket message; return `None` to drop it. +pub type WebSocketTransform = + Arc Option + Send + Sync>; + +/// Builder for a [`CopilotWebSocketForwarder`]. +pub struct CopilotWebSocketForwarderBuilder { + url: String, + headers: HeaderMap, + on_send_request_message: Option, + on_send_response_message: Option, +} + +impl CopilotWebSocketForwarderBuilder { + /// Hook runtime→upstream messages (mutate or drop before forwarding). + pub fn on_send_request_message(mut self, transform: WebSocketTransform) -> Self { + self.on_send_request_message = Some(transform); + self + } + + /// Hook upstream→runtime messages (mutate or drop before forwarding). + pub fn on_send_response_message(mut self, transform: WebSocketTransform) -> Self { + self.on_send_response_message = Some(transform); + self + } + + /// Dial the upstream WebSocket and begin pumping upstream→runtime messages + /// into `response`. + pub async fn connect( + self, + response: CopilotWebSocketResponse, + ) -> Result { + let mut request = + self.url.as_str().into_client_request().map_err(|e| { + CopilotRequestError::Upstream(format!("invalid websocket url: {e}")) + })?; + for (name, value) in &self.headers { + if is_forbidden_header(name) { + continue; + } + request.headers_mut().append(name.clone(), value.clone()); + } + + let (stream, _) = connect_async(request) + .await + .map_err(|e| CopilotRequestError::Upstream(format!("websocket connect failed: {e}")))?; + let (write, mut read) = stream.split(); + + let cancel = CancellationToken::new(); + let loop_cancel = cancel.clone(); + let on_response = self.on_send_response_message.clone(); + tokio::spawn(async move { + loop { + tokio::select! { + _ = loop_cancel.cancelled() => break, + msg = read.next() => match msg { + Some(Ok(Message::Text(text))) => { + let message = CopilotWebSocketMessage::from_text(text); + if let Some(out) = apply_transform(&on_response, message) { + let _ = response.send_message(out).await; + } + } + Some(Ok(Message::Binary(data))) => { + let message = CopilotWebSocketMessage { data, binary: true }; + if let Some(out) = apply_transform(&on_response, message) { + let _ = response.send_message(out).await; + } + } + Some(Ok(Message::Close(_))) | None => break, + Some(Ok(_)) => continue, + Some(Err(e)) => { + let _ = response.fail(e.to_string(), None).await; + return; + } + } + } + } + let _ = response.close().await; + }); + + Ok(CopilotWebSocketForwarder { + write: AsyncMutex::new(Some(write)), + on_send_request_message: self.on_send_request_message, + cancel, + }) + } +} + +/// The default WebSocket handler: forwards each runtime message to the real +/// upstream and each upstream message back to the runtime. Mutate by supplying +/// transforms on the [builder](CopilotWebSocketForwarder::builder). +pub struct CopilotWebSocketForwarder { + write: AsyncMutex>, + on_send_request_message: Option, + cancel: CancellationToken, +} + +impl CopilotWebSocketForwarder { + /// Start building a forwarding handler for `url` with the given upstream + /// handshake headers. + pub fn builder(url: String, headers: HeaderMap) -> CopilotWebSocketForwarderBuilder { + CopilotWebSocketForwarderBuilder { + url, + headers, + on_send_request_message: None, + on_send_response_message: None, + } + } +} + +#[async_trait] +impl CopilotWebSocketHandler for CopilotWebSocketForwarder { + async fn send_request_message( + &self, + message: CopilotWebSocketMessage, + ) -> Result<(), CopilotRequestError> { + let Some(message) = apply_transform(&self.on_send_request_message, message) else { + return Ok(()); + }; + let ws_message = if message.binary { + Message::Binary(message.data) + } else { + let text = match String::from_utf8(message.data) { + Ok(text) => text, + Err(err) => String::from_utf8_lossy(err.as_bytes()).into_owned(), + }; + Message::Text(text) + }; + let mut guard = self.write.lock().await; + if let Some(write) = guard.as_mut() { + write + .send(ws_message) + .await + .map_err(|e| CopilotRequestError::Upstream(e.to_string()))?; + } + Ok(()) + } + + async fn close(&self) -> Result<(), CopilotRequestError> { + self.cancel.cancel(); + let mut guard = self.write.lock().await; + if let Some(mut write) = guard.take() { + let _ = write.send(Message::Close(None)).await; + let _ = write.close().await; + } + Ok(()) + } +} + +fn apply_transform( + transform: &Option, + message: CopilotWebSocketMessage, +) -> Option { + match transform { + Some(f) => f(message), + None => Some(message), + } +} + +/// Mutable response state machine for a single exchange. +#[derive(Default)] +struct ResponseState { + started: bool, + finished: bool, +} + +/// One intercepted request in flight. +/// +/// Carries the request metadata plus the body byte stream the runtime feeds in +/// via `httpRequestChunk` frames, and emits the handler's response straight back +/// to the runtime through the generated `llmInference` server API — a single +/// object the dispatcher owns and the handler drives. +/// Request context populated when the matching `httpRequestStart` frame +/// arrives. Held behind a `OnceLock` so the owning [`CopilotRequestExchange`] +/// can be created bare by a body chunk that races ahead of its start frame. +#[derive(Default)] +struct RequestMeta { + session_id: Option, + agent_id: Option, + parent_agent_id: Option, + interaction_type: Option, + method: String, + url: String, + headers: HeaderMap, + transport: CopilotRequestTransport, +} + +struct CopilotRequestExchange { + request_id: String, + meta: OnceLock, + cancel: CancellationToken, + client: Weak, + /// Sender feeding the request body stream. Dropped (set to `None`) on `end` + /// or `cancel` to close the stream. + body_tx: Mutex>>>, + body_rx: AsyncMutex>>, + state: Mutex, +} + +impl CopilotRequestExchange { + fn new(request_id: String, client: Weak) -> Self { + let (body_tx, body_rx) = mpsc::unbounded_channel(); + Self { + request_id, + meta: OnceLock::new(), + cancel: CancellationToken::new(), + client, + body_tx: Mutex::new(Some(body_tx)), + body_rx: AsyncMutex::new(body_rx), + state: Mutex::new(ResponseState::default()), + } + } + + /// Fill in the request context once the matching start frame arrives. + fn set_context(&self, params: LlmInferenceHttpRequestStartRequest) { + let _ = self.meta.set(RequestMeta { + session_id: params.session_id.map(SessionId::into_inner), + agent_id: params.agent_id, + parent_agent_id: params.parent_agent_id, + interaction_type: params.interaction_type, + method: params.method, + url: params.url, + headers: headers_from_wire(¶ms.headers), + transport: CopilotRequestTransport::from_wire(params.transport), + }); + } + + /// Request metadata. Always populated before the handler runs; the + /// defaulted fallback only guards the (contract-impossible) case of a body + /// chunk with no preceding start frame. + fn meta(&self) -> &RequestMeta { + self.meta.get_or_init(RequestMeta::default) + } + + fn context(&self) -> CopilotRequestContext { + let meta = self.meta(); + CopilotRequestContext { + request_id: self.request_id.clone(), + session_id: meta.session_id.clone(), + agent_id: meta.agent_id.clone(), + parent_agent_id: meta.parent_agent_id.clone(), + interaction_type: meta.interaction_type.clone(), + transport: meta.transport, + url: meta.url.clone(), + headers: meta.headers.clone(), + cancel: self.cancel.clone(), + } + } + + fn client(&self) -> Result { + self.client + .upgrade() + .map(Client::from_inner) + .ok_or(CopilotRequestError::ConnectionClosed) + } + + fn request_id(&self) -> RequestId { + RequestId::new(self.request_id.clone()) + } + + // --- Request body feed (driven by the dispatcher as frames arrive) --- + + fn push_chunk(&self, data: Vec) { + if let Some(tx) = self.body_tx.lock().as_ref() { + let _ = tx.send(data); + } + } + + fn push_end(&self) { + *self.body_tx.lock() = None; + } + + fn push_cancel(&self) { + self.cancel.cancel(); + *self.body_tx.lock() = None; + } + + async fn recv_body(&self) -> Option> { + self.body_rx.lock().await.recv().await + } + + async fn drain_body(&self) -> Vec { + let mut buf = Vec::new(); + let mut rx = self.body_rx.lock().await; + while let Some(frame) = rx.recv().await { + buf.extend_from_slice(&frame); + } + buf + } + + // --- Response emit (driven by the handler). Strict state machine: --- + // start_response once -> 0..N write -> exactly one of + // end_response / error_response. + + fn started(&self) -> bool { + self.state.lock().started + } + + fn finished(&self) -> bool { + self.state.lock().finished + } + + async fn start_response( + &self, + status: u16, + status_text: Option, + headers: HeaderMap, + ) -> Result<(), CopilotRequestError> { + { + let mut state = self.state.lock(); + if state.started { + return Err(CopilotRequestError::InvalidState( + "response start() called twice".to_string(), + )); + } + if state.finished { + return Err(CopilotRequestError::InvalidState( + "response already finished".to_string(), + )); + } + state.started = true; + } + let request = LlmInferenceHttpResponseStartRequest { + headers: headers_to_wire(&headers), + request_id: self.request_id(), + status: i64::from(status), + status_text, + }; + self.client()? + .rpc() + .llm_inference() + .http_response_start(request) + .await?; + Ok(()) + } + + /// Start the WebSocket upgrade head (status 101) once, ignoring repeat + /// calls. The dispatcher emits it eagerly before pumping; later writes call + /// this as a harmless no-op backstop. + async fn ensure_ws_started(&self) -> Result<(), CopilotRequestError> { + if self.started() { + return Ok(()); + } + self.start_response(101, None, HeaderMap::new()).await + } + + async fn write_text(&self, text: &str) -> Result<(), CopilotRequestError> { + self.write(text.to_string(), false).await + } + + async fn write_binary(&self, data: &[u8]) -> Result<(), CopilotRequestError> { + let encoded = base64::engine::general_purpose::STANDARD.encode(data); + self.write(encoded, true).await + } + + async fn write(&self, data: String, binary: bool) -> Result<(), CopilotRequestError> { + { + let state = self.state.lock(); + if !state.started { + return Err(CopilotRequestError::InvalidState( + "response write called before start()".to_string(), + )); + } + if state.finished { + return Err(CopilotRequestError::InvalidState( + "response write called after end()/error()".to_string(), + )); + } + } + let request = LlmInferenceHttpResponseChunkRequest { + binary: binary.then_some(true), + data, + end: Some(false), + error: None, + request_id: self.request_id(), + }; + self.client()? + .rpc() + .llm_inference() + .http_response_chunk(request) + .await?; + Ok(()) + } + + async fn end_response(&self) -> Result<(), CopilotRequestError> { + { + let mut state = self.state.lock(); + if state.finished { + return Ok(()); + } + state.finished = true; + } + let request = LlmInferenceHttpResponseChunkRequest { + binary: None, + data: String::new(), + end: Some(true), + error: None, + request_id: self.request_id(), + }; + self.client()? + .rpc() + .llm_inference() + .http_response_chunk(request) + .await?; + Ok(()) + } + + async fn error_response( + &self, + message: impl Into, + code: Option, + ) -> Result<(), CopilotRequestError> { + { + let mut state = self.state.lock(); + if state.finished { + return Ok(()); + } + state.finished = true; + } + let request = LlmInferenceHttpResponseChunkRequest { + binary: None, + data: String::new(), + end: Some(true), + error: Some(LlmInferenceHttpResponseChunkError { + code, + message: message.into(), + }), + request_id: self.request_id(), + }; + self.client()? + .rpc() + .llm_inference() + .http_response_chunk(request) + .await?; + Ok(()) + } +} + +/// Drive one exchange through the registered handler, dispatching by transport. +async fn drive_exchange( + exchange: &Arc, + handler: &Arc, +) -> Result<(), CopilotRequestError> { + let ctx = exchange.context(); + let meta = exchange.meta(); + match meta.transport { + CopilotRequestTransport::Http => { + let body = exchange.drain_body().await; + let request = CopilotHttpRequest { + method: meta.method.clone(), + url: meta.url.clone(), + headers: meta.headers.clone(), + body, + cancel: ctx.cancel.clone(), + }; + let response = handler.send_request(request, &ctx).await?; + stream_http_response(response, exchange, &ctx.cancel).await + } + CopilotRequestTransport::WebSocket => { + // The runtime blocks the WebSocket connect until it receives the 101 + // response head (the upgrade acknowledgement) and only then forwards + // inbound messages as request-body chunks. Emit it eagerly here — + // waiting for the first upstream message would deadlock, since the + // upstream stays silent until it receives a request message the + // runtime won't send before the upgrade completes. + exchange.ensure_ws_started().await?; + let response = CopilotWebSocketResponse::new(exchange.clone()); + let ws = handler.open_websocket(&ctx, response).await?; + let result = pump_websocket_requests(ws.as_ref(), exchange, &ctx.cancel).await; + let _ = ws.close().await; + match result { + Ok(()) => exchange.end_response().await, + Err(err) if ctx.cancel.is_cancelled() => { + exchange + .error_response( + "Request cancelled by runtime", + Some("cancelled".to_string()), + ) + .await?; + let _ = err; + Ok(()) + } + Err(err) => Err(err), + } + } + } +} + +/// Stream an HTTP response into the runtime, honouring cancellation. +async fn stream_http_response( + response: CopilotHttpResponse, + exchange: &CopilotRequestExchange, + cancel: &CancellationToken, +) -> Result<(), CopilotRequestError> { + exchange + .start_response(response.status, response.status_text, response.headers) + .await?; + + let mut body = response.body; + loop { + tokio::select! { + _ = cancel.cancelled() => { + return exchange + .error_response("Request cancelled by runtime", Some("cancelled".to_string())) + .await; + } + next = body.next() => match next { + Some(Ok(chunk)) => { + for piece in chunk.chunks(32 * 1024) { + exchange.write_binary(piece).await?; + } + } + Some(Err(e)) => { + return exchange.error_response(e.to_string(), None).await; + } + None => break, + } + } + } + exchange.end_response().await +} + +/// Forward runtime→upstream WebSocket messages until the runtime closes its side +/// or cancels. +async fn pump_websocket_requests( + handler: &dyn CopilotWebSocketHandler, + exchange: &CopilotRequestExchange, + cancel: &CancellationToken, +) -> Result<(), CopilotRequestError> { + loop { + tokio::select! { + _ = cancel.cancelled() => { + return Err(CopilotRequestError::message("Request cancelled by runtime")); + } + frame = exchange.recv_body() => match frame { + Some(data) => { + handler + .send_request_message(CopilotWebSocketMessage { data, binary: false }) + .await?; + } + None => return Ok(()), + } + } + } +} + +/// Drive the exchange's response to a terminal state once the handler returns, +/// covering handlers that error, get cancelled, or forget to finalize. +async fn finalize_exchange( + exchange: &CopilotRequestExchange, + result: Result<(), CopilotRequestError>, +) { + match result { + Ok(()) => { + if !exchange.finished() { + fail_via_response( + exchange, + 502, + "Copilot request handler returned without finalising the response".to_string(), + ) + .await; + } + } + Err(err) => { + if exchange.finished() { + return; + } + if exchange.cancel.is_cancelled() { + if !exchange.started() { + let _ = exchange.start_response(499, None, HeaderMap::new()).await; + } + let _ = exchange + .error_response( + "Request cancelled by runtime", + Some("cancelled".to_string()), + ) + .await; + } else { + fail_via_response(exchange, 502, err.to_string()).await; + } + } + } +} + +async fn fail_via_response(exchange: &CopilotRequestExchange, status: u16, message: String) { + if !exchange.started() { + let _ = exchange + .start_response(status, None, HeaderMap::new()) + .await; + } + let _ = exchange.error_response(message, None).await; +} + +/// Routes inbound `llmInference.*` requests to the registered handler, +/// reassembling each request's streaming body and acking every frame. +pub(crate) struct CopilotRequestDispatcher { + handler: Arc, + client: OnceLock>, + pending: Mutex>>, +} + +impl CopilotRequestDispatcher { + pub(crate) fn new(handler: Arc) -> Self { + Self { + handler, + client: OnceLock::new(), + pending: Mutex::new(HashMap::new()), + } + } + + pub(crate) fn set_client(&self, client: Weak) { + let _ = self.client.set(client); + } + + fn client(&self) -> Option { + self.client + .get() + .and_then(Weak::upgrade) + .map(Client::from_inner) + } + + fn client_weak(&self) -> Weak { + self.client.get().cloned().unwrap_or_else(Weak::new) + } + + pub(crate) async fn dispatch(self: &Arc, request: JsonRpcRequest) { + match request.method.as_str() { + METHOD_HTTP_REQUEST_START => self.handle_start(request).await, + METHOD_HTTP_REQUEST_CHUNK => self.handle_chunk(request).await, + other => { + warn!(method = other, "unknown llmInference request method"); + self.send_error(request.id, "unknown llmInference method") + .await; + } + } + } + + fn get_or_create_exchange(&self, request_id: String) -> Arc { + // The runtime dispatches httpRequestStart and httpRequestChunk frames + // independently. get-or-create keeps the adapter correct regardless of + // arrival order: a body chunk (including the terminal end frame) that + // races ahead of its start frame is buffered into the same exchange + // rather than dropped, which would otherwise hang the body drain. + self.pending + .lock() + .entry(request_id.clone()) + .or_insert_with(|| { + Arc::new(CopilotRequestExchange::new(request_id, self.client_weak())) + }) + .clone() + } + + async fn handle_start(self: &Arc, request: JsonRpcRequest) { + let id = request.id; + let Some(params) = parse_params::(&request) else { + self.send_error(id, "invalid llmInference.httpRequestStart params") + .await; + return; + }; + + // Adopt any exchange a racing chunk already created — with its buffered + // body — rather than dropping those frames. + let request_id = params.request_id.clone().into_inner(); + let exchange = self.get_or_create_exchange(request_id.clone()); + exchange.set_context(params); + + let handler = self.handler.clone(); + let dispatcher = Arc::clone(self); + let exchange_for_task = exchange.clone(); + tokio::spawn(async move { + let result = drive_exchange(&exchange_for_task, &handler).await; + finalize_exchange(&exchange_for_task, result).await; + dispatcher.remove_pending(&request_id); + }); + + self.ack(id).await; + } + + async fn handle_chunk(&self, request: JsonRpcRequest) { + let id = request.id; + let Some(params) = parse_params::(&request) else { + self.send_error(id, "invalid llmInference.httpRequestChunk params") + .await; + return; + }; + + // May arrive before the matching start frame; get-or-create so the body + // is buffered, never lost. + let exchange = self.get_or_create_exchange(params.request_id.to_string()); + apply_chunk(&exchange, ¶ms); + + self.ack(id).await; + } + + fn remove_pending(&self, request_id: &str) { + self.pending.lock().remove(request_id); + } + + async fn ack(&self, id: u64) { + let Some(client) = self.client() else { + return; + }; + let _ = client + .send_response(&JsonRpcResponse { + jsonrpc: "2.0".to_string(), + id, + result: Some(serde_json::json!({})), + error: None, + }) + .await; + } + + async fn send_error(&self, id: u64, message: &str) { + let Some(client) = self.client() else { + return; + }; + let _ = client + .send_response(&JsonRpcResponse { + jsonrpc: "2.0".to_string(), + id, + result: None, + error: Some(crate::JsonRpcError { + code: error_codes::INTERNAL_ERROR, + message: message.to_string(), + data: None, + }), + }) + .await; + } +} + +/// Apply one body chunk to a pending request: route data into the body stream, +/// or terminate it on `end` / `cancel`. +fn apply_chunk(exchange: &CopilotRequestExchange, params: &LlmInferenceHttpRequestChunkRequest) { + if params.cancel == Some(true) { + exchange.push_cancel(); + return; + } + + if !params.data.is_empty() { + let decoded = if params.binary == Some(true) { + match base64::engine::general_purpose::STANDARD.decode(params.data.as_bytes()) { + Ok(bytes) => bytes, + Err(e) => { + warn!(error = %e, "failed to decode base64 llmInference body chunk"); + return; + } + } + } else { + params.data.clone().into_bytes() + }; + exchange.push_chunk(decoded); + } + + if params.end == Some(true) { + exchange.push_end(); + } +} + +fn parse_params(request: &JsonRpcRequest) -> Option { + request + .params + .as_ref() + .and_then(|p| serde_json::from_value(p.clone()).ok()) +} + +/// Convert a wire header map into an [`http::HeaderMap`], skipping any entry the +/// `http` crate rejects. +fn headers_from_wire(wire: &HashMap>) -> HeaderMap { + let mut headers = HeaderMap::new(); + for (name, values) in wire { + let Ok(header_name) = HeaderName::from_bytes(name.as_bytes()) else { + continue; + }; + for value in values { + let Ok(header_value) = HeaderValue::from_str(value) else { + continue; + }; + headers.append(header_name.clone(), header_value); + } + } + headers +} + +/// Convert an [`http::HeaderMap`] into the wire header map, dropping values that +/// are not valid UTF-8. +fn headers_to_wire(headers: &HeaderMap) -> HashMap> { + let mut wire: HashMap> = HashMap::new(); + for (name, value) in headers { + let Ok(value) = value.to_str() else { + continue; + }; + wire.entry(name.as_str().to_string()) + .or_default() + .push(value.to_string()); + } + wire +} diff --git a/rust/src/embeddedcli.rs b/rust/src/embeddedcli.rs index a92f37d46..40900a4d2 100644 --- a/rust/src/embeddedcli.rs +++ b/rust/src/embeddedcli.rs @@ -2,31 +2,47 @@ //! crate (gated on the `bundled-cli` cargo feature, which is in the default //! feature set). //! -//! build.rs downloads the platform's `copilot-{platform}.{tar.gz,zip}` -//! archive from GitHub Releases, SHA-256 verifies it against the version -//! pinned in `cli-version.txt` (or `../nodejs/package-lock.json` when -//! building inside the github/copilot-sdk repo itself), and embeds the -//! **raw archive bytes** -//! into the consumer's compiled artifact via `include_bytes!()`. Extraction -//! to a real on-disk path is deferred until the first call to -//! [`path`] / [`install_at`] — at which point the bytes are part of the -//! consumer's signed binary and trusted, so no further hashing is done. +//! Normal builds embed the platform release archive from GitHub Releases. +//! Builds with `bundled-in-process` instead embed a minimal archive from the +//! platform npm package containing the CLI executable and native runtime +//! library. Extraction to a real on-disk path is deferred until the first call +//! to [`path`] / [`install_at`]. +//! +//! The embedded bytes are part of the consumer's signed binary and therefore +//! trusted *as the source of truth* — but the bytes that land on disk are not. +//! A non-atomic write, a multi-process race, or antivirus quarantining the +//! freshly-written executable can leave a truncated or corrupt image that, if +//! handed back as "good", fails to launch (e.g. Windows `ERROR_BAD_EXE_FORMAT`). +//! Installation therefore: extracts to a unique temp file in the target dir, +//! fsyncs and marks it executable, verifies the staged bytes against the +//! trusted in-memory image, atomically renames it into place, re-verifies the +//! published file, and records an integrity marker. Subsequent runs trust an +//! existing install only after a cheap re-check (size marker + executable-image +//! header); anything that looks truncated or quarantined is re-extracted, and +//! the whole publish is retried before surfacing a clear, actionable error. -#[cfg(has_bundled_cli)] +// The atomic-publish + verify helpers (and their unit tests) are pure +// std-only logic that doesn't touch the embedded archive, so they compile +// whenever the binary is bundled *or* we're building the test harness — +// the standard `cargo test --no-default-features` job has `has_bundled_cli` +// off but still needs to exercise them. +#[cfg(any(has_bundled_cli, test))] use std::fs; -#[cfg(all(has_bundled_cli, not(windows)))] +#[cfg(all(has_bundled_cli, any(feature = "bundled-in-process", not(windows))))] use std::io::Read; -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] use std::io::Write; use std::path::{Path, PathBuf}; use std::sync::OnceLock; +#[cfg(any(has_bundled_cli, test))] +use std::sync::atomic::{AtomicU64, Ordering}; #[cfg(has_bundled_cli)] use tracing::{info, warn}; // When the `bundled-cli` cargo feature is enabled and the target platform is -// supported, build.rs generates `bundled_cli.rs` exposing the raw archive -// bytes. The CLI version is exposed crate-wide via the +// supported, build.rs generates `bundled_cli.rs` exposing the selected archive. +// The CLI version is exposed crate-wide via the // `cargo:rustc-env=COPILOT_SDK_CLI_VERSION` emit (see `build.rs`), and the // binary name is OS-derived — so no other generated constants are needed. #[cfg(has_bundled_cli)] @@ -61,10 +77,11 @@ static INSTALLED_PATH: OnceLock> = OnceLock::new(); /// and returns the resulting path. The cache dir comes from /// [`dirs::cache_dir()`] — `%LOCALAPPDATA%` on Windows, /// `~/Library/Caches/` on macOS, `$XDG_CACHE_HOME` (or `~/.cache/`) on -/// Linux. Subsequent calls return the cached result. The extraction -/// is skipped when the target file already exists — the per-version -/// install directory and the assumption that the consumer's binary is -/// trusted mean no further hashing is needed. +/// Linux. Subsequent calls return the cached result. Extraction +/// is skipped when a previously-published binary is still present and +/// passes a cheap integrity re-check (size marker + executable-image +/// header); a truncated, empty, or quarantined binary is re-extracted +/// rather than returned. /// /// Returns `None` if no CLI was embedded at build time. #[cfg(feature = "bundled-cli")] @@ -93,7 +110,9 @@ pub(crate) fn path() -> Option { /// default `/github-copilot-sdk/cli//` location /// (see [`path`] for the per-platform mapping). /// -/// Idempotent: skips extraction if the target binary already exists. +/// Idempotent: skips extraction when an already-published binary passes the +/// integrity re-check (size marker + executable-image header), and +/// re-extracts a corrupt or quarantined one. /// Returns `None` when the SDK was built without a bundled CLI. #[cfg(feature = "bundled-cli")] #[allow(dead_code)] // Used by resolve.rs when ClientOptions::bundled_cli_extract_dir is set. @@ -128,40 +147,340 @@ fn default_install_dir(version: &str) -> PathBuf { } } +/// Number of times we re-extract + re-publish the binary before giving up. +/// A single transient failure (e.g. antivirus briefly locking or quarantining +/// the freshly-written file) is retried; a persistent one surfaces a clear +/// error rather than handing back a broken path. +#[cfg(has_bundled_cli)] +const MAX_PUBLISH_ATTEMPTS: u32 = 3; + +// Natural platform shared-library name for the in-process FFI runtime. +#[cfg(all(has_bundled_cli, feature = "bundled-in-process", windows))] +const RUNTIME_LIBRARY_NAME: &str = "copilot_runtime.dll"; +#[cfg(all(has_bundled_cli, feature = "bundled-in-process", target_os = "macos"))] +const RUNTIME_LIBRARY_NAME: &str = "libcopilot_runtime.dylib"; +#[cfg(all( + has_bundled_cli, + feature = "bundled-in-process", + not(windows), + not(target_os = "macos") +))] +const RUNTIME_LIBRARY_NAME: &str = "libcopilot_runtime.so"; + #[cfg(has_bundled_cli)] fn install(install_dir: &Path, archive: &[u8]) -> Result { + let final_path = install_cli(install_dir, archive)?; + #[cfg(feature = "bundled-in-process")] + { + install_runtime_library(install_dir, archive)?; + } + Ok(final_path) +} + +#[cfg(all(has_bundled_cli, feature = "bundled-in-process"))] +fn install_runtime_library(install_dir: &Path, archive: &[u8]) -> Result<(), EmbeddedCliError> { + let target = install_dir.join(RUNTIME_LIBRARY_NAME); + if fs::metadata(&target).map(|m| m.len() > 0).unwrap_or(false) { + return Ok(()); + } + let bytes = extract_binary(archive, RUNTIME_LIBRARY_NAME)?; + if bytes.is_empty() { + return Err(EmbeddedCliError::with_message( + EmbeddedCliErrorKind::Verification, + "embedded runtime library is empty", + )); + } + let tmp = write_temp_file(install_dir, &bytes)?; + if let Err(e) = publish(&tmp, &target) { + let _ = fs::remove_file(&tmp); + return Err(e); + } + tracing::debug!(path = %target.display(), "in-process FFI runtime library installed"); + Ok(()) +} + +#[cfg(has_bundled_cli)] +fn install_cli(install_dir: &Path, archive: &[u8]) -> Result { let verbose = std::env::var("COPILOT_CLI_INSTALL_VERBOSE").ok().as_deref() == Some("1"); fs::create_dir_all(install_dir) .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::CreateDir, e))?; let final_path = install_dir.join(CLI_BINARY_NAME); + let marker_path = marker_path(install_dir); - // Per-version install dir means a present file at this path is the - // binary we want — no need to hash-verify the bytes are unchanged. - if final_path.is_file() { + // Fast path: a previous install left both the binary and the integrity + // marker we wrote *after* verifying it. Re-validate cheaply (size + + // executable-image magic) so a binary that was later truncated or + // quarantined by antivirus is re-extracted instead of trusted blindly. + if existing_install_is_valid(&final_path, &marker_path) { if verbose { eprintln!("embedded CLI already installed at {}", final_path.display()); } return Ok(final_path); } + // The bytes extracted from the embedded archive are part of the + // consumer's trusted, signed binary — so they are the known-good + // reference we verify the on-disk file against after publishing. let start = std::time::Instant::now(); let bytes = extract_binary(archive, CLI_BINARY_NAME)?; - write_binary(&final_path, &bytes)?; + if bytes.is_empty() { + return Err(EmbeddedCliError::with_message( + EmbeddedCliErrorKind::Verification, + "extracted CLI binary is empty", + )); + } - if verbose { - eprintln!( - "embedded CLI extracted to {} in {:?}", - final_path.display(), - start.elapsed() - ); + let mut last_err: Option = None; + for attempt in 1..=MAX_PUBLISH_ATTEMPTS { + match publish_verified(install_dir, &final_path, &marker_path, &bytes) { + Ok(()) => { + if verbose { + eprintln!( + "embedded CLI extracted to {} in {:?}", + final_path.display(), + start.elapsed() + ); + } + return Ok(final_path); + } + Err(e) => { + // Another process may have raced us and published the same + // good binary; if what's on disk matches our trusted bytes, + // accept its install rather than fighting over it. + if verify_on_disk_matches(&final_path, &bytes).is_ok() { + let _ = write_marker(&marker_path, bytes.len() as u64); + return Ok(final_path); + } + warn!(attempt, error = %e, "embedded CLI publish attempt failed; retrying"); + last_err = Some(e); + } + } } - Ok(final_path) + Err(EmbeddedCliError::with_source( + EmbeddedCliErrorKind::Blocked, + last_err, + )) } -#[cfg(all(has_bundled_cli, not(windows)))] +/// Path of the integrity marker written next to the installed binary. Its +/// presence (and recorded size) is proof a previous run published a verified +/// binary, letting the fast path skip re-extraction without trusting a bare +/// `is_file()` check. +#[cfg(any(has_bundled_cli, test))] +fn marker_path(install_dir: &Path) -> PathBuf { + install_dir.join(".copilot-cli.ok") +} + +/// Cheap, allocation-light validity check for an already-installed binary: +/// the file exists and is non-empty, an integrity marker recording its +/// expected size is present and matches, and the first bytes look like a +/// valid executable image for this platform. Catches the realistic failure +/// modes (zero-length / truncated / quarantined-to-garbage) without re-reading +/// the whole file. +#[cfg(any(has_bundled_cli, test))] +fn existing_install_is_valid(final_path: &Path, marker_path: &Path) -> bool { + let Ok(meta) = fs::metadata(final_path) else { + return false; + }; + if !meta.is_file() || meta.len() == 0 { + return false; + } + match read_marker_len(marker_path) { + Some(expected) if expected == meta.len() => looks_like_valid_image(final_path), + _ => false, + } +} + +/// Extract → stage in a unique temp file in the *same* directory → verify the +/// staged bytes → atomically rename into place → re-verify the published file +/// → write the integrity marker. Every step that can leave a partial file +/// cleans up after itself, so a failure never leaves a half-written binary at +/// the final path. +#[cfg(any(has_bundled_cli, test))] +fn publish_verified( + install_dir: &Path, + final_path: &Path, + marker_path: &Path, + bytes: &[u8], +) -> Result<(), EmbeddedCliError> { + let tmp = write_temp_file(install_dir, bytes)?; + + // Verify the staged copy before it ever becomes the live binary, so a + // short write or in-flight antivirus tampering is caught here. + if let Err(e) = verify_on_disk_matches(&tmp, bytes) { + let _ = fs::remove_file(&tmp); + return Err(e); + } + + if let Err(e) = publish(&tmp, final_path) { + let _ = fs::remove_file(&tmp); + return Err(e); + } + + // Re-verify after the rename: catches the window where antivirus + // quarantines or rewrites the file between staging and publishing. + verify_on_disk_matches(final_path, bytes)?; + + write_marker(marker_path, bytes.len() as u64)?; + Ok(()) +} + +/// Write `contents` to a uniquely-named temp file in `dir` (same filesystem as +/// the final path so the later rename is atomic), flushing and fsync-ing the +/// bytes to disk and marking it executable on unix before returning its path. +#[cfg(any(has_bundled_cli, test))] +fn write_temp_file(dir: &Path, contents: &[u8]) -> Result { + static COUNTER: AtomicU64 = AtomicU64::new(0); + let nanos = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_nanos()) + .unwrap_or(0); + let unique = format!( + ".copilot-cli.tmp.{}.{}.{}", + std::process::id(), + COUNTER.fetch_add(1, Ordering::Relaxed), + nanos + ); + let tmp = dir.join(unique); + + // `create_new` guarantees we never clobber a sibling's in-flight temp + // file (the pid + counter + nanos name already makes that practically + // impossible). + let mut file = fs::OpenOptions::new() + .write(true) + .create_new(true) + .open(&tmp) + .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?; + + if let Err(e) = file + .write_all(contents) + .and_then(|()| file.flush()) + .and_then(|()| file.sync_all()) + { + drop(file); + let _ = fs::remove_file(&tmp); + return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e)); + } + + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt; + if let Err(e) = fs::set_permissions(&tmp, fs::Permissions::from_mode(0o755)) { + drop(file); + let _ = fs::remove_file(&tmp); + return Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e)); + } + } + + drop(file); + Ok(tmp) +} + +/// Atomically move the staged temp file onto `final_path`. +/// +/// `rename` replaces the target atomically on POSIX, but on Windows it fails +/// when the target already exists — so on that error we remove the stale file +/// and retry. The remove-then-rename is the only non-atomic window, and it's +/// guarded upstream: callers re-verify the published file and, on a lost race, +/// accept a peer's identical install instead of erroring. +#[cfg(any(has_bundled_cli, test))] +fn publish(tmp: &Path, final_path: &Path) -> Result<(), EmbeddedCliError> { + match fs::rename(tmp, final_path) { + Ok(()) => Ok(()), + Err(_) if final_path.exists() => { + let _ = fs::remove_file(final_path); + fs::rename(tmp, final_path) + .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Publish, e)) + } + Err(e) => Err(EmbeddedCliError::new(EmbeddedCliErrorKind::Publish, e)), + } +} + +/// Read the file at `path` and confirm it byte-for-byte matches the trusted +/// `expected` image. Size is checked first so the common corruption case +/// (truncation) produces a precise error. +#[cfg(any(has_bundled_cli, test))] +fn verify_on_disk_matches(path: &Path, expected: &[u8]) -> Result<(), EmbeddedCliError> { + let actual = fs::read(path).map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?; + if actual.len() != expected.len() { + return Err(EmbeddedCliError::with_message( + EmbeddedCliErrorKind::Verification, + format!( + "size mismatch: on-disk {} bytes, expected {} bytes", + actual.len(), + expected.len() + ), + )); + } + if actual != expected { + return Err(EmbeddedCliError::with_message( + EmbeddedCliErrorKind::Verification, + "on-disk binary differs from the embedded image", + )); + } + Ok(()) +} + +/// Best-effort check that the first bytes of `path` are a valid executable +/// image header for the current platform (PE on Windows, Mach-O on macOS, +/// ELF elsewhere). Returns `false` on any I/O error or unrecognized header. +#[cfg(any(has_bundled_cli, test))] +fn looks_like_valid_image(path: &Path) -> bool { + use std::io::Read as _; + let mut buf = [0u8; 4]; + let Ok(mut file) = fs::File::open(path) else { + return false; + }; + let Ok(read) = file.read(&mut buf) else { + return false; + }; + let head = &buf[..read]; + + #[cfg(windows)] + { + head.starts_with(b"MZ") + } + #[cfg(target_os = "macos")] + { + matches!( + head, + [0xfe, 0xed, 0xfa, 0xce] // Mach-O 32-bit + | [0xfe, 0xed, 0xfa, 0xcf] // Mach-O 64-bit + | [0xce, 0xfa, 0xed, 0xfe] // byte-swapped 32-bit + | [0xcf, 0xfa, 0xed, 0xfe] // byte-swapped 64-bit + | [0xca, 0xfe, 0xba, 0xbe] // universal (fat) + | [0xbe, 0xba, 0xfe, 0xca] // byte-swapped universal + ) + } + #[cfg(all(not(windows), not(target_os = "macos")))] + { + head.starts_with(b"\x7fELF") + } +} + +/// Write the integrity marker recording the published binary's size. Best +/// effort: a torn write just means the next run can't parse it and re-extracts. +#[cfg(any(has_bundled_cli, test))] +fn write_marker(marker_path: &Path, size: u64) -> Result<(), EmbeddedCliError> { + fs::write(marker_path, size.to_string()) + .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e)) +} + +/// Parse the size recorded in the integrity marker, or `None` if it's missing +/// or unparsable. +#[cfg(any(has_bundled_cli, test))] +fn read_marker_len(marker_path: &Path) -> Option { + fs::read_to_string(marker_path) + .ok()? + .trim() + .parse::() + .ok() +} + +#[cfg(all(has_bundled_cli, any(feature = "bundled-in-process", not(windows))))] fn extract_binary(archive: &[u8], binary_name: &str) -> Result, EmbeddedCliError> { let gz = flate2::read::GzDecoder::new(archive); let mut tar = tar::Archive::new(gz); @@ -186,7 +505,7 @@ fn extract_binary(archive: &[u8], binary_name: &str) -> Result, Embedded Err(EmbeddedCliErrorKind::BinaryNotFoundInArchive.into()) } -#[cfg(all(has_bundled_cli, windows))] +#[cfg(all(has_bundled_cli, not(feature = "bundled-in-process"), windows))] fn extract_binary(archive: &[u8], binary_name: &str) -> Result, EmbeddedCliError> { let cursor = std::io::Cursor::new(archive); let mut zip = zip::ZipArchive::new(cursor) @@ -217,65 +536,61 @@ fn sanitize_version(version: &str) -> String { .collect() } -#[cfg(has_bundled_cli)] -fn write_binary(path: &Path, data: &[u8]) -> Result<(), EmbeddedCliError> { - let mut file = fs::OpenOptions::new() - .write(true) - .create(true) - .truncate(true) - .open(path) - .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?; - - file.write_all(data) - .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?; - - #[cfg(unix)] - { - use std::os::unix::fs::PermissionsExt; - fs::set_permissions(path, fs::Permissions::from_mode(0o755)) - .map_err(|e| EmbeddedCliError::new(EmbeddedCliErrorKind::Io, e))?; - } - - Ok(()) -} - -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] #[derive(Clone, Copy, Debug, PartialEq, Eq)] #[allow(dead_code)] enum EmbeddedCliErrorKind { CreateDir, - #[cfg(not(windows))] + #[cfg(any(feature = "bundled-in-process", not(windows)))] Archive, - #[cfg(windows)] + #[cfg(all(not(feature = "bundled-in-process"), windows))] Zip, BinaryNotFoundInArchive, Io, + /// Atomically renaming the staged temp file onto the final path failed. + Publish, + /// The published (or staged) file didn't match the trusted embedded image. + Verification, + /// Extraction kept producing a corrupt/missing binary across all retries — + /// most likely antivirus interference. + Blocked, } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] impl std::fmt::Display for EmbeddedCliErrorKind { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { EmbeddedCliErrorKind::CreateDir => f.write_str("failed to create install directory"), - #[cfg(not(windows))] + #[cfg(any(feature = "bundled-in-process", not(windows)))] EmbeddedCliErrorKind::Archive => f.write_str("failed to read archive entry"), - #[cfg(windows)] + #[cfg(all(not(feature = "bundled-in-process"), windows))] EmbeddedCliErrorKind::Zip => f.write_str("failed to read zip archive"), EmbeddedCliErrorKind::BinaryNotFoundInArchive => { f.write_str("CLI binary not found in embedded archive") } EmbeddedCliErrorKind::Io => f.write_str("I/O error"), + EmbeddedCliErrorKind::Publish => { + f.write_str("failed to publish the extracted CLI binary") + } + EmbeddedCliErrorKind::Verification => { + f.write_str("extracted CLI binary failed integrity verification") + } + EmbeddedCliErrorKind::Blocked => f.write_str( + "bundled CLI appears blocked or corrupt after multiple attempts \ + (possibly quarantined by antivirus)", + ), } } } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] #[allow(dead_code)] struct EmbeddedCliError { repr: crate::errors::Repr, } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] +#[allow(dead_code)] impl EmbeddedCliError { fn new(kind: EmbeddedCliErrorKind, error: E) -> Self where @@ -288,9 +603,29 @@ impl EmbeddedCliError { }), } } + + fn with_message( + kind: EmbeddedCliErrorKind, + message: impl Into>, + ) -> Self { + Self { + repr: crate::errors::Repr::SimpleMessage(kind, message.into()), + } + } + + /// Build an error from `kind`, attaching the last failure as the source + /// when one is available so the actionable message still carries context. + fn with_source(kind: EmbeddedCliErrorKind, source: Option) -> Self { + match source { + Some(source) => Self::new(kind, Box::new(source)), + None => Self { + repr: crate::errors::Repr::Simple(kind), + }, + } + } } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] impl From for EmbeddedCliError { fn from(kind: EmbeddedCliErrorKind) -> Self { Self { @@ -299,7 +634,7 @@ impl From for EmbeddedCliError { } } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] impl std::fmt::Display for EmbeddedCliError { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match &self.repr { @@ -312,14 +647,14 @@ impl std::fmt::Display for EmbeddedCliError { } } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] impl std::fmt::Debug for EmbeddedCliError { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "EmbeddedCliError({self})") } } -#[cfg(has_bundled_cli)] +#[cfg(any(has_bundled_cli, test))] impl std::error::Error for EmbeddedCliError { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match &self.repr { @@ -328,3 +663,182 @@ impl std::error::Error for EmbeddedCliError { } } } + +#[cfg(test)] +mod tests { + use super::*; + + #[cfg(all(has_bundled_cli, feature = "bundled-in-process"))] + #[test] + fn embedded_archive_contains_only_expected_files() { + let gz = flate2::read::GzDecoder::new(build_time::CLI_ARCHIVE); + let mut archive = tar::Archive::new(gz); + let mut names: Vec = archive + .entries() + .expect("archive entries") + .map(|entry| { + entry + .expect("archive entry") + .path() + .expect("archive path") + .to_string_lossy() + .into_owned() + }) + .collect(); + names.sort(); + + let mut expected = vec![ + CLI_BINARY_NAME.to_string(), + RUNTIME_LIBRARY_NAME.to_string(), + ]; + expected.sort(); + assert_eq!(names, expected); + } + + /// Bytes whose header looks like a valid executable image on the host + /// platform, so `looks_like_valid_image` accepts them. `extra` padding + /// bytes follow the magic so size checks have something to disagree about. + fn fake_image(extra: usize) -> Vec { + let mut bytes = Vec::new(); + #[cfg(windows)] + bytes.extend_from_slice(b"MZ\x90\x00"); + #[cfg(target_os = "macos")] + bytes.extend_from_slice(&[0xfe, 0xed, 0xfa, 0xcf]); + #[cfg(all(not(windows), not(target_os = "macos")))] + bytes.extend_from_slice(b"\x7fELF"); + bytes.extend(std::iter::repeat_n(0xAB, extra)); + bytes + } + + #[test] + fn publish_verified_writes_and_records_marker() { + let dir = tempfile::tempdir().expect("tempdir"); + let final_path = dir.path().join("copilot-bin"); + let marker = marker_path(dir.path()); + let bytes = fake_image(2048); + + publish_verified(dir.path(), &final_path, &marker, &bytes).expect("publish"); + + assert!(final_path.is_file(), "binary should be published"); + assert_eq!(fs::read(&final_path).expect("read"), bytes); + assert_eq!(read_marker_len(&marker), Some(bytes.len() as u64)); + assert!(existing_install_is_valid(&final_path, &marker)); + + // No leftover temp files in the install dir. + let leftovers: Vec<_> = fs::read_dir(dir.path()) + .expect("read_dir") + .filter_map(|e| e.ok()) + .filter(|e| e.file_name().to_string_lossy().contains(".tmp.")) + .collect(); + assert!(leftovers.is_empty(), "temp files should be cleaned up"); + } + + #[test] + fn publish_overwrites_an_existing_binary() { + let dir = tempfile::tempdir().expect("tempdir"); + let final_path = dir.path().join("copilot-bin"); + let marker = marker_path(dir.path()); + + // Pre-existing (stale) binary at the destination. + fs::write(&final_path, b"old contents").expect("seed"); + + let bytes = fake_image(512); + publish_verified(dir.path(), &final_path, &marker, &bytes).expect("publish"); + + assert_eq!(fs::read(&final_path).expect("read"), bytes); + } + + #[test] + fn corrupt_or_unmarked_install_is_rejected() { + let dir = tempfile::tempdir().expect("tempdir"); + let final_path = dir.path().join("copilot-bin"); + let marker = marker_path(dir.path()); + let bytes = fake_image(4096); + + // Missing binary entirely. + assert!(!existing_install_is_valid(&final_path, &marker)); + + // Valid binary but no marker (e.g. installed by an older SDK). + fs::write(&final_path, &bytes).expect("write binary"); + assert!( + !existing_install_is_valid(&final_path, &marker), + "an install without a marker must not be trusted" + ); + + // Marker present but the binary was later truncated (partial write / + // antivirus). Marker still records the original full size. + write_marker(&marker, bytes.len() as u64).expect("marker"); + assert!(existing_install_is_valid(&final_path, &marker)); + fs::write(&final_path, &bytes[..bytes.len() / 2]).expect("truncate"); + assert!( + !existing_install_is_valid(&final_path, &marker), + "a truncated binary must be detected via the size marker" + ); + + // Zero-length binary (quarantined to empty). + fs::write(&final_path, b"").expect("empty"); + assert!(!existing_install_is_valid(&final_path, &marker)); + } + + #[test] + fn invalid_image_header_is_rejected() { + let dir = tempfile::tempdir().expect("tempdir"); + let final_path = dir.path().join("copilot-bin"); + let marker = marker_path(dir.path()); + + // Right size, has a marker, but the bytes are not a valid image. + let garbage = vec![0u8; 4096]; + fs::write(&final_path, &garbage).expect("write garbage"); + write_marker(&marker, garbage.len() as u64).expect("marker"); + + assert!( + !existing_install_is_valid(&final_path, &marker), + "a non-executable image must be rejected even with a matching marker" + ); + } + + #[test] + fn verification_rejects_size_and_content_mismatch() { + let dir = tempfile::tempdir().expect("tempdir"); + let path = dir.path().join("staged"); + let expected = fake_image(1024); + + // Exact match passes. + fs::write(&path, &expected).expect("write"); + verify_on_disk_matches(&path, &expected).expect("exact match should verify"); + + // Truncated -> size mismatch. + fs::write(&path, &expected[..100]).expect("truncate"); + assert!(verify_on_disk_matches(&path, &expected).is_err()); + + // Same length, different bytes -> content mismatch. + let mut tampered = expected.clone(); + *tampered.last_mut().expect("non-empty") ^= 0xFF; + fs::write(&path, &tampered).expect("tamper"); + assert!(verify_on_disk_matches(&path, &expected).is_err()); + + // Missing file -> I/O error. + fs::remove_file(&path).expect("remove"); + assert!(verify_on_disk_matches(&path, &expected).is_err()); + } + + #[test] + fn temp_files_are_unique_and_synced() { + let dir = tempfile::tempdir().expect("tempdir"); + let data = fake_image(256); + + let a = write_temp_file(dir.path(), &data).expect("temp a"); + let b = write_temp_file(dir.path(), &data).expect("temp b"); + + assert_ne!(a, b, "temp file names must be unique"); + assert_eq!(fs::read(&a).expect("read a"), data); + assert_eq!(fs::read(&b).expect("read b"), data); + + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt; + let mode = fs::metadata(&a).expect("meta").permissions().mode(); + assert_eq!(mode & 0o777, 0o755, "temp binary should be executable"); + } + } +} diff --git a/rust/src/errors.rs b/rust/src/errors.rs index 5690f6412..6e05bbfae 100644 --- a/rust/src/errors.rs +++ b/rust/src/errors.rs @@ -63,6 +63,12 @@ pub enum ProtocolErrorKind { max: u32, }, + /// The CLI server reported a protocol version that can't be represented by the SDK. + InvalidProtocolVersion { + /// Version reported by the server. + server: i64, + }, + /// The CLI server's protocol version changed between calls. VersionChanged { /// Previously negotiated version. @@ -94,6 +100,9 @@ impl fmt::Display for ProtocolErrorKind { "version mismatch: server={server}, supported={min}\u{2013}{max}" ) } + ProtocolErrorKind::InvalidProtocolVersion { server } => { + write!(f, "invalid protocol version: server={server}") + } ProtocolErrorKind::VersionChanged { previous, current } => { write!(f, "version changed: was {previous}, now {current}") } diff --git a/rust/src/ffi.rs b/rust/src/ffi.rs new file mode 100644 index 000000000..f784b1a6d --- /dev/null +++ b/rust/src/ffi.rs @@ -0,0 +1,633 @@ +//! In-process FFI transport: hosts the Copilot runtime by loading its native +//! library and speaking JSON-RPC over its C ABI, +//! instead of spawning a CLI child process and communicating over stdio/TCP. +//! +//! The runtime's `host_start` export spawns the residual TypeScript worker +//! itself — the packaged single-file CLI (`copilot --embedded-host`) or, for +//! dev, `node dist-cli/index.js --embedded-host`. JSON-RPC frames are pumped +//! across the ABI: writes go to `connection_write`; inbound frames arrive on a +//! native callback that feeds an async reader. The framing is unchanged — the +//! same LSP `Content-Length:` frames the stdio transport uses. + +use std::collections::HashMap; +use std::ffi::c_void; +use std::path::{Path, PathBuf}; +use std::pin::Pin; +use std::sync::atomic::{AtomicBool, AtomicPtr, AtomicU32, AtomicUsize, Ordering}; +use std::sync::{Arc, OnceLock}; +use std::task::{Context, Poll}; + +use libloading::Library; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; +use tokio::sync::mpsc; +use tracing::debug; + +use crate::{Error, ErrorKind}; + +type OutboundCallback = unsafe extern "C" fn(*mut c_void, *const u8, usize); +type HostStartFn = unsafe extern "C" fn(*const u8, usize, *const u8, usize) -> u32; +type HostShutdownFn = unsafe extern "C" fn(u32) -> bool; +#[allow(clippy::type_complexity)] +type ConnectionOpenFn = unsafe extern "C" fn( + u32, + OutboundCallback, + *mut c_void, + *const u8, + usize, + *const u8, + usize, + *const u8, + usize, +) -> u32; +type ConnectionWriteFn = unsafe extern "C" fn(u32, *const u8, usize) -> bool; +type ConnectionCloseFn = unsafe extern "C" fn(u32) -> bool; + +/// State handed to the native side as `user_data` so the outbound callback can +/// route inbound frames back to the reader. +struct CallbackState { + tx: mpsc::UnboundedSender>, + active_callbacks: AtomicUsize, + closing: AtomicBool, +} + +extern "C" fn on_outbound(user_data: *mut c_void, bytes: *const u8, len: usize) { + if user_data.is_null() || bytes.is_null() || len == 0 { + return; + } + let state = unsafe { &*(user_data as *const CallbackState) }; + state.active_callbacks.fetch_add(1, Ordering::SeqCst); + if state.closing.load(Ordering::SeqCst) { + state.active_callbacks.fetch_sub(1, Ordering::SeqCst); + return; + } + let slice = unsafe { std::slice::from_raw_parts(bytes, len) }; + let _ = state.tx.send(slice.to_vec()); + state.active_callbacks.fetch_sub(1, Ordering::SeqCst); +} + +/// Bound exports and connection lifecycle state, shared between the +/// [`FfiWriter`] and the owning [`Client`]. The cdylib itself is loaded +/// process-globally and never unloaded (see [`load_library`]), so this holds +/// only the bound fn pointers and connection state. +pub(crate) struct FfiShared { + host_shutdown: HostShutdownFn, + connection_write: ConnectionWriteFn, + connection_close: ConnectionCloseFn, + server_id: AtomicU32, + connection_id: AtomicU32, + callback_state: AtomicPtr, + closed: AtomicBool, + operation_lock: parking_lot::Mutex<()>, + library_path: PathBuf, +} + +// The raw fn pointers and the boxed callback state are safe to move across +// threads: the native side copies buffers synchronously and the callback only +// forwards to a thread-safe channel sender. +unsafe impl Send for FfiShared {} +unsafe impl Sync for FfiShared {} + +impl FfiShared { + /// Close the connection, shut the host down, and free the callback state. + /// Idempotent; called from [`Client::stop`], drop, and on startup failure. + pub(crate) fn close(&self) { + let _operation = self.operation_lock.lock(); + if self.closed.swap(true, Ordering::SeqCst) { + return; + } + let state = self.callback_state.load(Ordering::SeqCst); + if !state.is_null() { + unsafe { &*state }.closing.store(true, Ordering::SeqCst); + } + let conn = self.connection_id.swap(0, Ordering::SeqCst); + if conn != 0 { + unsafe { (self.connection_close)(conn) }; + } + let server = self.server_id.swap(0, Ordering::SeqCst); + if server != 0 { + unsafe { (self.host_shutdown)(server) }; + } + // Free the callback state only after the connection is closed and the + // host is shut down, so native can no longer invoke the callback. + let state = self + .callback_state + .swap(std::ptr::null_mut(), Ordering::SeqCst); + if !state.is_null() { + while unsafe { &*state }.active_callbacks.load(Ordering::SeqCst) != 0 { + std::thread::yield_now(); + } + drop(unsafe { Box::from_raw(state) }); + } + debug!(library = %self.library_path.display(), "FFI runtime connection closed"); + } + + fn write_frame(&self, frame: &[u8]) -> bool { + let _operation = self.operation_lock.lock(); + if self.closed.load(Ordering::SeqCst) { + return false; + } + let conn = self.connection_id.load(Ordering::SeqCst); + if conn == 0 { + return false; + } + unsafe { (self.connection_write)(conn, frame.as_ptr(), frame.len()) } + } +} + +impl Drop for FfiShared { + fn drop(&mut self) { + self.close(); + } +} + +/// Read side of the FFI transport, fed by the native outbound callback via an +/// unbounded channel. Implements [`AsyncRead`] for the JSON-RPC read loop. +pub(crate) struct FfiReader { + rx: mpsc::UnboundedReceiver>, + leftover: Vec, + pos: usize, +} + +impl AsyncRead for FfiReader { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + if self.pos >= self.leftover.len() { + match self.rx.poll_recv(cx) { + Poll::Ready(Some(chunk)) => { + self.leftover = chunk; + self.pos = 0; + } + Poll::Ready(None) => return Poll::Ready(Ok(())), + Poll::Pending => return Poll::Pending, + } + } + let available = self.leftover.len() - self.pos; + let n = available.min(buf.remaining()); + let start = self.pos; + buf.put_slice(&self.leftover[start..start + n]); + self.pos += n; + Poll::Ready(Ok(())) + } +} + +/// Write side of the FFI transport. Each frame is forwarded synchronously to +/// the native `connection_write` export (native copies before returning). +pub(crate) struct FfiWriter { + shared: Arc, +} + +impl AsyncWrite for FfiWriter { + fn poll_write( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + if self.shared.write_frame(buf) { + Poll::Ready(Ok(buf.len())) + } else { + Poll::Ready(Err(std::io::Error::new( + std::io::ErrorKind::BrokenPipe, + "failed to write a frame to the in-process runtime connection", + ))) + } + } + + fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } + + fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } +} + +/// Prepared FFI host: the bound cdylib exports plus the spawn arguments needed +/// to start the runtime worker. The cdylib is loaded process-globally and never +/// unloaded (see [`load_library`]). +pub(crate) struct FfiHost { + library_path: PathBuf, + entrypoint: PathBuf, + environment: Vec<(String, String)>, + args: Vec, + host_start: HostStartFn, + host_shutdown: HostShutdownFn, + connection_open: ConnectionOpenFn, + connection_write: ConnectionWriteFn, + connection_close: ConnectionCloseFn, +} + +// SAFETY: as for `FfiShared` — the bound exports are plain fn pointers, safe to +// move to the blocking thread that starts the host. +unsafe impl Send for FfiHost {} + +impl FfiHost { + /// Load the cdylib next to `entrypoint` and bind its exports. + /// + /// `entrypoint` is the packaged single-file CLI binary or, for dev, a + /// `.js` file launched via `node`. The native library is resolved relative + /// to the entrypoint directory, supporting both packaged and development + /// layouts. + pub(crate) fn create( + entrypoint: &Path, + environment: Vec<(String, String)>, + args: Vec, + ) -> Result { + let entrypoint = std::fs::canonicalize(entrypoint) + .map(path_for_child_process) + .map_err(|e| { + Error::with_message( + ErrorKind::InvalidConfig, + format!( + "failed to resolve in-process CLI entrypoint '{}': {e}", + entrypoint.display() + ), + ) + })?; + let library_path = + std::fs::canonicalize(resolve_library_path(&entrypoint)?).map_err(|e| { + Error::with_message( + ErrorKind::InvalidConfig, + format!("failed to resolve in-process runtime library: {e}"), + ) + })?; + let lib = load_library(&library_path)?; + + let host_start = *bind::(lib, b"copilot_runtime_host_start\0", &library_path)?; + let host_shutdown = + *bind::(lib, b"copilot_runtime_host_shutdown\0", &library_path)?; + let connection_open = + *bind::(lib, b"copilot_runtime_connection_open\0", &library_path)?; + let connection_write = + *bind::(lib, b"copilot_runtime_connection_write\0", &library_path)?; + let connection_close = + *bind::(lib, b"copilot_runtime_connection_close\0", &library_path)?; + + Ok(Self { + library_path, + entrypoint, + environment, + args, + host_start, + host_shutdown, + connection_open, + connection_write, + connection_close, + }) + } + + /// Start the runtime worker and open the FFI JSON-RPC connection. + /// + /// `host_start` blocks until the worker connects back and signals + /// readiness (up to ~30s), and must not run on an async executor thread, so + /// the blocking handshake is offloaded to [`tokio::task::spawn_blocking`]. + pub(crate) async fn start(self) -> Result<(FfiReader, FfiWriter, Arc), Error> { + tokio::task::spawn_blocking(move || self.start_blocking()) + .await + .map_err(|e| { + Error::with_message( + ErrorKind::InvalidConfig, + format!("in-process runtime startup task failed: {e}"), + ) + })? + } + + fn start_blocking(self) -> Result<(FfiReader, FfiWriter, Arc), Error> { + let argv = build_argv_json(&self.entrypoint, &self.args); + let env = build_env_json(&self.environment); + + let (env_ptr, env_len) = match &env { + Some(bytes) => (bytes.as_ptr(), bytes.len()), + None => (std::ptr::null(), 0), + }; + + let server_id = unsafe { (self.host_start)(argv.as_ptr(), argv.len(), env_ptr, env_len) }; + + if server_id == 0 { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + format!( + "copilot_runtime_host_start failed (library '{}', entrypoint '{}')", + self.library_path.display(), + self.entrypoint.display() + ), + )); + } + + let (tx, rx) = mpsc::unbounded_channel::>(); + let state_ptr = Box::into_raw(Box::new(CallbackState { + tx, + active_callbacks: AtomicUsize::new(0), + closing: AtomicBool::new(false), + })); + let connection_id = unsafe { + (self.connection_open)( + server_id, + on_outbound, + state_ptr as *mut c_void, + std::ptr::null(), + 0, + std::ptr::null(), + 0, + std::ptr::null(), + 0, + ) + }; + if connection_id == 0 { + drop(unsafe { Box::from_raw(state_ptr) }); + unsafe { (self.host_shutdown)(server_id) }; + return Err(Error::with_message( + ErrorKind::InvalidConfig, + "copilot_runtime_connection_open failed", + )); + } + + let shared = Arc::new(FfiShared { + host_shutdown: self.host_shutdown, + connection_write: self.connection_write, + connection_close: self.connection_close, + server_id: AtomicU32::new(server_id), + connection_id: AtomicU32::new(connection_id), + callback_state: AtomicPtr::new(state_ptr), + closed: AtomicBool::new(false), + operation_lock: parking_lot::Mutex::new(()), + library_path: self.library_path.clone(), + }); + + debug!( + library = %self.library_path.display(), + server_id, connection_id, "FFI runtime host started" + ); + + let reader = FfiReader { + rx, + leftover: Vec::new(), + pos: 0, + }; + let writer = FfiWriter { + shared: Arc::clone(&shared), + }; + Ok((reader, writer, shared)) + } +} + +fn bind<'lib, T>( + lib: &'lib Library, + symbol: &[u8], + library_path: &Path, +) -> Result, Error> { + match unsafe { lib.get::(symbol) } { + Ok(export) => Ok(export), + Err(e) => Err(Error::with_message( + ErrorKind::InvalidConfig, + format!( + "in-process runtime library '{}' is missing an expected export ({}): {e}", + library_path.display(), + String::from_utf8_lossy(symbol.strip_suffix(b"\0").unwrap_or(symbol)) + ), + )), + } +} + +/// Loads the runtime cdylib once per process and never unloads it, returning a +/// `'static` reference. Subsequent loads of the same path reuse the first +/// handle. +/// +/// The library stays mapped because native worker threads can outlive an +/// individual connection teardown. +fn load_library(library_path: &Path) -> Result<&'static Library, Error> { + static LIBRARIES: OnceLock>> = + OnceLock::new(); + let cache = LIBRARIES.get_or_init(|| parking_lot::Mutex::new(HashMap::new())); + + let mut guard = cache.lock(); + if let Some(lib) = guard.get(library_path) { + return Ok(*lib); + } + + let lib = unsafe { Library::new(library_path) }.map_err(|e| { + Error::with_message( + ErrorKind::InvalidConfig, + format!( + "failed to load in-process runtime library '{}': {e}", + library_path.display() + ), + ) + })?; + // Leak the library so it is never unloaded for the process lifetime. + let leaked: &'static Library = Box::leak(Box::new(lib)); + guard.insert(library_path.to_path_buf(), leaked); + Ok(leaked) +} + +/// The natural platform shared-library file name for the runtime cdylib — the +/// `.node` file renamed to what the Rust cdylib would be called on this OS. +fn natural_library_name() -> &'static str { + if cfg!(windows) { + "copilot_runtime.dll" + } else if cfg!(target_os = "macos") { + "libcopilot_runtime.dylib" + } else { + "libcopilot_runtime.so" + } +} + +/// The package prebuild folder name for the current host. +pub(crate) fn prebuilds_folder() -> Option { + let platform = if cfg!(target_os = "windows") { + "win32" + } else if cfg!(target_os = "macos") { + "darwin" + } else if cfg!(target_os = "linux") { + "linux" + } else { + return None; + }; + let arch = if cfg!(target_arch = "x86_64") { + "x64" + } else if cfg!(target_arch = "aarch64") { + "arm64" + } else { + return None; + }; + Some(format!("{platform}-{arch}")) +} + +fn resolve_library_path(entrypoint: &Path) -> Result { + let dir = entrypoint.parent().ok_or_else(|| { + Error::with_message( + ErrorKind::InvalidConfig, + format!( + "could not determine directory for CLI entrypoint '{}'", + entrypoint.display() + ), + ) + })?; + + // Bundled/flat layout: natural shared-library name next to the CLI. + let flat = dir.join(natural_library_name()); + if flat.is_file() { + return Ok(flat); + } + + // Development package layout. + let prebuilds = + prebuilds_folder().map(|folder| dir.join("prebuilds").join(folder).join("runtime.node")); + if let Some(prebuilds_path) = &prebuilds + && prebuilds_path.is_file() + { + return Ok(prebuilds_path.clone()); + } + + Err(Error::with_message( + ErrorKind::BinaryNotFound { + name: natural_library_name().into(), + hint: Some(format!( + "native runtime library not found next to '{}'. Enable the \ + `bundled-in-process` feature or set COPILOT_CLI_PATH to a compatible CLI package.", + entrypoint.display() + )), + }, + "native runtime library not found", + )) +} + +#[cfg(windows)] +fn path_for_child_process(path: PathBuf) -> PathBuf { + use std::ffi::OsString; + use std::os::windows::ffi::{OsStrExt, OsStringExt}; + + const VERBATIM_PREFIX: &[u16] = &[b'\\' as u16, b'\\' as u16, b'?' as u16, b'\\' as u16]; + const UNC_PREFIX: &[u16] = &[b'U' as u16, b'N' as u16, b'C' as u16, b'\\' as u16]; + + let encoded: Vec = path.as_os_str().encode_wide().collect(); + let Some(stripped) = encoded.strip_prefix(VERBATIM_PREFIX) else { + return path; + }; + let normalized = if let Some(unc_path) = stripped.strip_prefix(UNC_PREFIX) { + let mut result = vec![b'\\' as u16, b'\\' as u16]; + result.extend_from_slice(unc_path); + result + } else { + stripped.to_vec() + }; + PathBuf::from(OsString::from_wide(&normalized)) +} + +#[cfg(not(windows))] +fn path_for_child_process(path: PathBuf) -> PathBuf { + path +} + +fn build_argv_json(entrypoint: &Path, extra_args: &[String]) -> Vec { + // A `.js` entrypoint (dev / dist-cli) is launched via node; the packaged + // single-file CLI binary embeds its own Node and is invoked directly. + let entrypoint_str = entrypoint.to_string_lossy().into_owned(); + let is_js = entrypoint + .extension() + .and_then(|ext| ext.to_str()) + .is_some_and(|ext| ext.eq_ignore_ascii_case("js")); + let mut argv: Vec = if is_js { + vec![ + "node".to_string(), + entrypoint_str, + "--embedded-host".to_string(), + "--no-auto-update".to_string(), + ] + } else { + vec![ + entrypoint_str, + "--embedded-host".to_string(), + "--no-auto-update".to_string(), + ] + }; + argv.extend_from_slice(extra_args); + serde_json::to_vec(&argv).expect("argv serializes") +} + +fn build_env_json(environment: &[(String, String)]) -> Option> { + if environment.is_empty() { + return None; + } + let map: serde_json::Map = environment + .iter() + .map(|(k, v)| (k.clone(), serde_json::Value::String(v.clone()))) + .collect(); + Some(serde_json::to_vec(&map).expect("env serializes")) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn argv_pins_worker_and_appends_client_options() { + let argv: Vec = serde_json::from_slice(&build_argv_json( + Path::new("copilot"), + &["--log-level".into(), "debug".into()], + )) + .unwrap(); + + assert_eq!( + argv, + [ + "copilot", + "--embedded-host", + "--no-auto-update", + "--log-level", + "debug" + ] + ); + } + + #[test] + fn javascript_entrypoint_uses_node() { + let argv: Vec = + serde_json::from_slice(&build_argv_json(Path::new("index.js"), &[])).unwrap(); + + assert_eq!( + argv, + ["node", "index.js", "--embedded-host", "--no-auto-update"] + ); + } + + #[cfg(windows)] + #[test] + fn child_process_path_removes_windows_verbatim_prefix() { + assert_eq!( + path_for_child_process(PathBuf::from(r"\\?\D:\a\copilot-sdk\index.js")), + PathBuf::from(r"D:\a\copilot-sdk\index.js") + ); + assert_eq!( + path_for_child_process(PathBuf::from(r"\\?\UNC\server\share\copilot-sdk\index.js")), + PathBuf::from(r"\\server\share\copilot-sdk\index.js") + ); + } + + #[test] + fn environment_is_omitted_when_empty() { + assert_eq!(build_env_json(&[]), None); + } + + #[test] + fn environment_serializes_worker_overrides() { + let env: serde_json::Value = serde_json::from_slice( + &build_env_json(&[ + ("COPILOT_HOME".into(), "state".into()), + ("COPILOT_DISABLE_KEYTAR".into(), "1".into()), + ]) + .unwrap(), + ) + .unwrap(); + + assert_eq!( + env, + serde_json::json!({ + "COPILOT_HOME": "state", + "COPILOT_DISABLE_KEYTAR": "1", + }) + ); + } +} diff --git a/rust/src/generated/api_types.rs b/rust/src/generated/api_types.rs index 39157f858..caf9457a8 100644 --- a/rust/src/generated/api_types.rs +++ b/rust/src/generated/api_types.rs @@ -1,14 +1,18 @@ //! Auto-generated from api.schema.json — do not edit manually. #![allow(clippy::large_enum_variant)] +#![allow(deprecated)] +#![allow(dead_code)] +#![allow(rustdoc::invalid_html_tags)] use std::collections::HashMap; use serde::{Deserialize, Serialize}; use super::session_events::{ - AbortReason, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, - ReasoningSummary, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, + AbortReason, ContextTier, McpServerSource, McpServerStatus, PermissionPromptRequest, + PermissionRule, ReasoningSummary, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, + UserToolSessionApproval, Verbosity, }; use crate::types::{RequestId, SessionEvent, SessionId}; @@ -20,10 +24,20 @@ pub mod rpc_methods { pub const CONNECT: &str = "connect"; /// `models.list` pub const MODELS_LIST: &str = "models.list"; + /// `models.getBuiltInCatalog` + pub const MODELS_GETBUILTINCATALOG: &str = "models.getBuiltInCatalog"; /// `tools.list` pub const TOOLS_LIST: &str = "tools.list"; /// `account.getQuota` pub const ACCOUNT_GETQUOTA: &str = "account.getQuota"; + /// `account.getCurrentAuth` + pub const ACCOUNT_GETCURRENTAUTH: &str = "account.getCurrentAuth"; + /// `account.getAllUsers` + pub const ACCOUNT_GETALLUSERS: &str = "account.getAllUsers"; + /// `account.login` + pub const ACCOUNT_LOGIN: &str = "account.login"; + /// `account.logout` + pub const ACCOUNT_LOGOUT: &str = "account.logout"; /// `secrets.addFilterValues` pub const SECRETS_ADDFILTERVALUES: &str = "secrets.addFilterValues"; /// `mcp.config.list` @@ -42,20 +56,84 @@ pub mod rpc_methods { pub const MCP_CONFIG_RELOAD: &str = "mcp.config.reload"; /// `mcp.discover` pub const MCP_DISCOVER: &str = "mcp.discover"; + /// `extensions.discover` + pub const EXTENSIONS_DISCOVER: &str = "extensions.discover"; + /// `extensions.enable` + pub const EXTENSIONS_ENABLE: &str = "extensions.enable"; + /// `extensions.disable` + pub const EXTENSIONS_DISABLE: &str = "extensions.disable"; + /// `registerExtensionLaunchProvider` + pub const REGISTEREXTENSIONLAUNCHPROVIDER: &str = "registerExtensionLaunchProvider"; + /// `plugins.list` + pub const PLUGINS_LIST: &str = "plugins.list"; + /// `plugins.install` + pub const PLUGINS_INSTALL: &str = "plugins.install"; + /// `plugins.uninstall` + pub const PLUGINS_UNINSTALL: &str = "plugins.uninstall"; + /// `plugins.update` + pub const PLUGINS_UPDATE: &str = "plugins.update"; + /// `plugins.updateAll` + pub const PLUGINS_UPDATEALL: &str = "plugins.updateAll"; + /// `plugins.enable` + pub const PLUGINS_ENABLE: &str = "plugins.enable"; + /// `plugins.disable` + pub const PLUGINS_DISABLE: &str = "plugins.disable"; + /// `plugins.marketplaces.list` + pub const PLUGINS_MARKETPLACES_LIST: &str = "plugins.marketplaces.list"; + /// `plugins.marketplaces.add` + pub const PLUGINS_MARKETPLACES_ADD: &str = "plugins.marketplaces.add"; + /// `plugins.marketplaces.remove` + pub const PLUGINS_MARKETPLACES_REMOVE: &str = "plugins.marketplaces.remove"; + /// `plugins.marketplaces.browse` + pub const PLUGINS_MARKETPLACES_BROWSE: &str = "plugins.marketplaces.browse"; + /// `plugins.marketplaces.refresh` + pub const PLUGINS_MARKETPLACES_REFRESH: &str = "plugins.marketplaces.refresh"; /// `skills.config.setDisabledSkills` pub const SKILLS_CONFIG_SETDISABLEDSKILLS: &str = "skills.config.setDisabledSkills"; /// `skills.discover` pub const SKILLS_DISCOVER: &str = "skills.discover"; + /// `skills.getDiscoveryPaths` + pub const SKILLS_GETDISCOVERYPATHS: &str = "skills.getDiscoveryPaths"; + /// `agents.discover` + pub const AGENTS_DISCOVER: &str = "agents.discover"; + /// `agents.getDiscoveryPaths` + pub const AGENTS_GETDISCOVERYPATHS: &str = "agents.getDiscoveryPaths"; + /// `instructions.discover` + pub const INSTRUCTIONS_DISCOVER: &str = "instructions.discover"; + /// `instructions.getDiscoveryPaths` + pub const INSTRUCTIONS_GETDISCOVERYPATHS: &str = "instructions.getDiscoveryPaths"; + /// `commands.list` + pub const COMMANDS_LIST: &str = "commands.list"; /// `user.settings.reload` pub const USER_SETTINGS_RELOAD: &str = "user.settings.reload"; + /// `user.settings.get` + pub const USER_SETTINGS_GET: &str = "user.settings.get"; + /// `user.settings.set` + pub const USER_SETTINGS_SET: &str = "user.settings.set"; + /// `managedSettings.read` + pub const MANAGEDSETTINGS_READ: &str = "managedSettings.read"; + /// `runtime.shutdown` + pub const RUNTIME_SHUTDOWN: &str = "runtime.shutdown"; /// `sessionFs.setProvider` pub const SESSIONFS_SETPROVIDER: &str = "sessionFs.setProvider"; + /// `llmInference.setProvider` + pub const LLMINFERENCE_SETPROVIDER: &str = "llmInference.setProvider"; + /// `llmInference.httpResponseStart` + pub const LLMINFERENCE_HTTPRESPONSESTART: &str = "llmInference.httpResponseStart"; + /// `llmInference.httpResponseChunk` + pub const LLMINFERENCE_HTTPRESPONSECHUNK: &str = "llmInference.httpResponseChunk"; + /// `sessions.open` + pub const SESSIONS_OPEN: &str = "sessions.open"; /// `sessions.fork` pub const SESSIONS_FORK: &str = "sessions.fork"; /// `sessions.connect` pub const SESSIONS_CONNECT: &str = "sessions.connect"; /// `sessions.list` pub const SESSIONS_LIST: &str = "sessions.list"; + /// `sessions.getMetadata` + pub const SESSIONS_GETMETADATA: &str = "sessions.getMetadata"; + /// `sessions.listNonEmptySessionIds` + pub const SESSIONS_LISTNONEMPTYSESSIONIDS: &str = "sessions.listNonEmptySessionIds"; /// `sessions.findByTaskId` pub const SESSIONS_FINDBYTASKID: &str = "sessions.findByTaskId"; /// `sessions.findByPrefix` @@ -74,6 +152,8 @@ pub mod rpc_methods { pub const SESSIONS_CLOSE: &str = "sessions.close"; /// `sessions.bulkDelete` pub const SESSIONS_BULKDELETE: &str = "sessions.bulkDelete"; + /// `sessions.delete` + pub const SESSIONS_DELETE: &str = "sessions.delete"; /// `sessions.pruneOld` pub const SESSIONS_PRUNEOLD: &str = "sessions.pruneOld"; /// `sessions.save` @@ -88,20 +168,47 @@ pub mod rpc_methods { pub const SESSIONS_LOADDEFERREDREPOHOOKS: &str = "sessions.loadDeferredRepoHooks"; /// `sessions.setAdditionalPlugins` pub const SESSIONS_SETADDITIONALPLUGINS: &str = "sessions.setAdditionalPlugins"; + /// `sessions.getBoardEntryCount` + pub const SESSIONS_GETBOARDENTRYCOUNT: &str = "sessions.getBoardEntryCount"; + /// `sessions.startRemoteControl` + pub const SESSIONS_STARTREMOTECONTROL: &str = "sessions.startRemoteControl"; + /// `sessions.transferRemoteControl` + pub const SESSIONS_TRANSFERREMOTECONTROL: &str = "sessions.transferRemoteControl"; + /// `sessions.setRemoteControlSteering` + pub const SESSIONS_SETREMOTECONTROLSTEERING: &str = "sessions.setRemoteControlSteering"; + /// `sessions.stopRemoteControl` + pub const SESSIONS_STOPREMOTECONTROL: &str = "sessions.stopRemoteControl"; + /// `sessions.getRemoteControlStatus` + pub const SESSIONS_GETREMOTECONTROLSTATUS: &str = "sessions.getRemoteControlStatus"; + /// `sessions.registerExtensionToolsOnSession` + pub const SESSIONS_REGISTEREXTENSIONTOOLSONSESSION: &str = + "sessions.registerExtensionToolsOnSession"; + /// `sessions.configureSessionExtensions` + pub const SESSIONS_CONFIGURESESSIONEXTENSIONS: &str = "sessions.configureSessionExtensions"; /// `agentRegistry.spawn` pub const AGENTREGISTRY_SPAWN: &str = "agentRegistry.spawn"; /// `session.suspend` pub const SESSION_SUSPEND: &str = "session.suspend"; /// `session.send` pub const SESSION_SEND: &str = "session.send"; + /// `session.sendMessages` + pub const SESSION_SENDMESSAGES: &str = "session.sendMessages"; + /// `session.sendSystemNotification` + pub const SESSION_SENDSYSTEMNOTIFICATION: &str = "session.sendSystemNotification"; /// `session.abort` pub const SESSION_ABORT: &str = "session.abort"; + /// `session.interruptMainTurn` + pub const SESSION_INTERRUPTMAINTURN: &str = "session.interruptMainTurn"; + /// `session.cancelAllBackgroundAgents` + pub const SESSION_CANCELALLBACKGROUNDAGENTS: &str = "session.cancelAllBackgroundAgents"; /// `session.shutdown` pub const SESSION_SHUTDOWN: &str = "session.shutdown"; - /// `session.auth.getStatus` - pub const SESSION_AUTH_GETSTATUS: &str = "session.auth.getStatus"; - /// `session.auth.setCredentials` - pub const SESSION_AUTH_SETCREDENTIALS: &str = "session.auth.setCredentials"; + /// `session.gitHubAuth.getStatus` + pub const SESSION_GITHUBAUTH_GETSTATUS: &str = "session.gitHubAuth.getStatus"; + /// `session.gitHubAuth.setCredentials` + pub const SESSION_GITHUBAUTH_SETCREDENTIALS: &str = "session.gitHubAuth.setCredentials"; + /// `session.debug.collectLogs` + pub const SESSION_DEBUG_COLLECTLOGS: &str = "session.debug.collectLogs"; /// `session.canvas.list` pub const SESSION_CANVAS_LIST: &str = "session.canvas.list"; /// `session.canvas.listOpen` @@ -112,6 +219,28 @@ pub mod rpc_methods { pub const SESSION_CANVAS_CLOSE: &str = "session.canvas.close"; /// `session.canvas.action.invoke` pub const SESSION_CANVAS_ACTION_INVOKE: &str = "session.canvas.action.invoke"; + /// `session.factory.run` + pub const SESSION_FACTORY_RUN: &str = "session.factory.run"; + /// `session.factory.resume` + pub const SESSION_FACTORY_RESUME: &str = "session.factory.resume"; + /// `session.factory.getRun` + pub const SESSION_FACTORY_GETRUN: &str = "session.factory.getRun"; + /// `session.factory.listRuns` + pub const SESSION_FACTORY_LISTRUNS: &str = "session.factory.listRuns"; + /// `session.factory.getRunDetail` + pub const SESSION_FACTORY_GETRUNDETAIL: &str = "session.factory.getRunDetail"; + /// `session.factory.getRunProgress` + pub const SESSION_FACTORY_GETRUNPROGRESS: &str = "session.factory.getRunProgress"; + /// `session.factory.cancel` + pub const SESSION_FACTORY_CANCEL: &str = "session.factory.cancel"; + /// `session.factory.log` + pub const SESSION_FACTORY_LOG: &str = "session.factory.log"; + /// `session.factory.agent` + pub const SESSION_FACTORY_AGENT: &str = "session.factory.agent"; + /// `session.factory.journal.get` + pub const SESSION_FACTORY_JOURNAL_GET: &str = "session.factory.journal.get"; + /// `session.factory.journal.put` + pub const SESSION_FACTORY_JOURNAL_PUT: &str = "session.factory.journal.put"; /// `session.model.getCurrent` pub const SESSION_MODEL_GETCURRENT: &str = "session.model.getCurrent"; /// `session.model.switchTo` @@ -136,8 +265,17 @@ pub mod rpc_methods { pub const SESSION_PLAN_UPDATE: &str = "session.plan.update"; /// `session.plan.delete` pub const SESSION_PLAN_DELETE: &str = "session.plan.delete"; + /// `session.plan.readSqlTodos` + pub const SESSION_PLAN_READSQLTODOS: &str = "session.plan.readSqlTodos"; + /// `session.plan.readSqlTodosWithDependencies` + pub const SESSION_PLAN_READSQLTODOSWITHDEPENDENCIES: &str = + "session.plan.readSqlTodosWithDependencies"; /// `session.workspaces.getWorkspace` pub const SESSION_WORKSPACES_GETWORKSPACE: &str = "session.workspaces.getWorkspace"; + /// `session.workspaces.updateMetadata` + pub const SESSION_WORKSPACES_UPDATEMETADATA: &str = "session.workspaces.updateMetadata"; + /// `session.workspaces.ensure` + pub const SESSION_WORKSPACES_ENSURE: &str = "session.workspaces.ensure"; /// `session.workspaces.listFiles` pub const SESSION_WORKSPACES_LISTFILES: &str = "session.workspaces.listFiles"; /// `session.workspaces.readFile` @@ -148,16 +286,39 @@ pub mod rpc_methods { pub const SESSION_WORKSPACES_LISTCHECKPOINTS: &str = "session.workspaces.listCheckpoints"; /// `session.workspaces.readCheckpoint` pub const SESSION_WORKSPACES_READCHECKPOINT: &str = "session.workspaces.readCheckpoint"; + /// `session.workspaces.addSummary` + pub const SESSION_WORKSPACES_ADDSUMMARY: &str = "session.workspaces.addSummary"; + /// `session.workspaces.truncateSummaries` + pub const SESSION_WORKSPACES_TRUNCATESUMMARIES: &str = "session.workspaces.truncateSummaries"; + /// `session.workspaces.readAutopilotObjective` + pub const SESSION_WORKSPACES_READAUTOPILOTOBJECTIVE: &str = + "session.workspaces.readAutopilotObjective"; + /// `session.workspaces.writeAutopilotObjective` + pub const SESSION_WORKSPACES_WRITEAUTOPILOTOBJECTIVE: &str = + "session.workspaces.writeAutopilotObjective"; + /// `session.workspaces.deleteAutopilotObjective` + pub const SESSION_WORKSPACES_DELETEAUTOPILOTOBJECTIVE: &str = + "session.workspaces.deleteAutopilotObjective"; + /// `session.workspaces.autopilotObjectiveExists` + pub const SESSION_WORKSPACES_AUTOPILOTOBJECTIVEEXISTS: &str = + "session.workspaces.autopilotObjectiveExists"; /// `session.workspaces.saveLargePaste` pub const SESSION_WORKSPACES_SAVELARGEPASTE: &str = "session.workspaces.saveLargePaste"; /// `session.workspaces.diff` pub const SESSION_WORKSPACES_DIFF: &str = "session.workspaces.diff"; + /// `session.completions.getTriggerCharacters` + pub const SESSION_COMPLETIONS_GETTRIGGERCHARACTERS: &str = + "session.completions.getTriggerCharacters"; + /// `session.completions.request` + pub const SESSION_COMPLETIONS_REQUEST: &str = "session.completions.request"; /// `session.instructions.getSources` pub const SESSION_INSTRUCTIONS_GETSOURCES: &str = "session.instructions.getSources"; /// `session.fleet.start` pub const SESSION_FLEET_START: &str = "session.fleet.start"; /// `session.agent.list` pub const SESSION_AGENT_LIST: &str = "session.agent.list"; + /// `session.agent.setPrompt` + pub const SESSION_AGENT_SETPROMPT: &str = "session.agent.setPrompt"; /// `session.agent.getCurrent` pub const SESSION_AGENT_GETCURRENT: &str = "session.agent.getCurrent"; /// `session.agent.select` @@ -203,12 +364,16 @@ pub mod rpc_methods { pub const SESSION_SKILLS_ENSURELOADED: &str = "session.skills.ensureLoaded"; /// `session.mcp.list` pub const SESSION_MCP_LIST: &str = "session.mcp.list"; + /// `session.mcp.listTools` + pub const SESSION_MCP_LISTTOOLS: &str = "session.mcp.listTools"; /// `session.mcp.enable` pub const SESSION_MCP_ENABLE: &str = "session.mcp.enable"; /// `session.mcp.disable` pub const SESSION_MCP_DISABLE: &str = "session.mcp.disable"; /// `session.mcp.reload` pub const SESSION_MCP_RELOAD: &str = "session.mcp.reload"; + /// `session.mcp.reloadWithConfig` + pub const SESSION_MCP_RELOADWITHCONFIG: &str = "session.mcp.reloadWithConfig"; /// `session.mcp.executeSampling` pub const SESSION_MCP_EXECUTESAMPLING: &str = "session.mcp.executeSampling"; /// `session.mcp.cancelSamplingExecution` @@ -217,8 +382,33 @@ pub mod rpc_methods { pub const SESSION_MCP_SETENVVALUEMODE: &str = "session.mcp.setEnvValueMode"; /// `session.mcp.removeGitHub` pub const SESSION_MCP_REMOVEGITHUB: &str = "session.mcp.removeGitHub"; + /// `session.mcp.configureGitHub` + pub const SESSION_MCP_CONFIGUREGITHUB: &str = "session.mcp.configureGitHub"; + /// `session.mcp.startServer` + pub const SESSION_MCP_STARTSERVER: &str = "session.mcp.startServer"; + /// `session.mcp.restartServer` + pub const SESSION_MCP_RESTARTSERVER: &str = "session.mcp.restartServer"; + /// `session.mcp.stopServer` + pub const SESSION_MCP_STOPSERVER: &str = "session.mcp.stopServer"; + /// `session.mcp.registerExternalClient` + pub const SESSION_MCP_REGISTEREXTERNALCLIENT: &str = "session.mcp.registerExternalClient"; + /// `session.mcp.unregisterExternalClient` + pub const SESSION_MCP_UNREGISTEREXTERNALCLIENT: &str = "session.mcp.unregisterExternalClient"; + /// `session.mcp.isServerRunning` + pub const SESSION_MCP_ISSERVERRUNNING: &str = "session.mcp.isServerRunning"; + /// `session.mcp.oauth.handlePendingRequest` + pub const SESSION_MCP_OAUTH_HANDLEPENDINGREQUEST: &str = + "session.mcp.oauth.handlePendingRequest"; + /// `session.mcp.oauth.authenticationStateChanged` + pub const SESSION_MCP_OAUTH_AUTHENTICATIONSTATECHANGED: &str = + "session.mcp.oauth.authenticationStateChanged"; /// `session.mcp.oauth.login` pub const SESSION_MCP_OAUTH_LOGIN: &str = "session.mcp.oauth.login"; + /// `session.mcp.oauth.respond` + pub const SESSION_MCP_OAUTH_RESPOND: &str = "session.mcp.oauth.respond"; + /// `session.mcp.headers.handlePendingHeadersRefreshRequest` + pub const SESSION_MCP_HEADERS_HANDLEPENDINGHEADERSREFRESHREQUEST: &str = + "session.mcp.headers.handlePendingHeadersRefreshRequest"; /// `session.mcp.apps.readResource` pub const SESSION_MCP_APPS_READRESOURCE: &str = "session.mcp.apps.readResource"; /// `session.mcp.apps.listTools` @@ -231,8 +421,20 @@ pub mod rpc_methods { pub const SESSION_MCP_APPS_GETHOSTCONTEXT: &str = "session.mcp.apps.getHostContext"; /// `session.mcp.apps.diagnose` pub const SESSION_MCP_APPS_DIAGNOSE: &str = "session.mcp.apps.diagnose"; + /// `session.mcp.resources.read` + pub const SESSION_MCP_RESOURCES_READ: &str = "session.mcp.resources.read"; + /// `session.mcp.resources.list` + pub const SESSION_MCP_RESOURCES_LIST: &str = "session.mcp.resources.list"; + /// `session.mcp.resources.listTemplates` + pub const SESSION_MCP_RESOURCES_LISTTEMPLATES: &str = "session.mcp.resources.listTemplates"; /// `session.plugins.list` pub const SESSION_PLUGINS_LIST: &str = "session.plugins.list"; + /// `session.plugins.reload` + pub const SESSION_PLUGINS_RELOAD: &str = "session.plugins.reload"; + /// `session.provider.getEndpoint` + pub const SESSION_PROVIDER_GETENDPOINT: &str = "session.provider.getEndpoint"; + /// `session.provider.add` + pub const SESSION_PROVIDER_ADD: &str = "session.provider.add"; /// `session.options.update` pub const SESSION_OPTIONS_UPDATE: &str = "session.options.update"; /// `session.lsp.initialize` @@ -245,12 +447,17 @@ pub mod rpc_methods { pub const SESSION_EXTENSIONS_DISABLE: &str = "session.extensions.disable"; /// `session.extensions.reload` pub const SESSION_EXTENSIONS_RELOAD: &str = "session.extensions.reload"; + /// `session.extensions.sendAttachmentsToMessage` + pub const SESSION_EXTENSIONS_SENDATTACHMENTSTOMESSAGE: &str = + "session.extensions.sendAttachmentsToMessage"; /// `session.tools.handlePendingToolCall` pub const SESSION_TOOLS_HANDLEPENDINGTOOLCALL: &str = "session.tools.handlePendingToolCall"; /// `session.tools.initializeAndValidate` pub const SESSION_TOOLS_INITIALIZEANDVALIDATE: &str = "session.tools.initializeAndValidate"; /// `session.tools.getCurrentMetadata` pub const SESSION_TOOLS_GETCURRENTMETADATA: &str = "session.tools.getCurrentMetadata"; + /// `session.tools.updateSubagentSettings` + pub const SESSION_TOOLS_UPDATESUBAGENTSETTINGS: &str = "session.tools.updateSubagentSettings"; /// `session.commands.list` pub const SESSION_COMMANDS_LIST: &str = "session.commands.list"; /// `session.commands.invoke` @@ -264,8 +471,12 @@ pub mod rpc_methods { /// `session.commands.respondToQueuedCommand` pub const SESSION_COMMANDS_RESPONDTOQUEUEDCOMMAND: &str = "session.commands.respondToQueuedCommand"; + /// `session.telemetry.getEngagementId` + pub const SESSION_TELEMETRY_GETENGAGEMENTID: &str = "session.telemetry.getEngagementId"; /// `session.telemetry.setFeatureOverrides` pub const SESSION_TELEMETRY_SETFEATUREOVERRIDES: &str = "session.telemetry.setFeatureOverrides"; + /// `session.ui.ephemeralQuery` + pub const SESSION_UI_EPHEMERALQUERY: &str = "session.ui.ephemeralQuery"; /// `session.ui.elicitation` pub const SESSION_UI_ELICITATION: &str = "session.ui.elicitation"; /// `session.ui.handlePendingElicitation` @@ -277,6 +488,9 @@ pub mod rpc_methods { /// `session.ui.handlePendingAutoModeSwitch` pub const SESSION_UI_HANDLEPENDINGAUTOMODESWITCH: &str = "session.ui.handlePendingAutoModeSwitch"; + /// `session.ui.handlePendingSessionLimitsExhausted` + pub const SESSION_UI_HANDLEPENDINGSESSIONLIMITSEXHAUSTED: &str = + "session.ui.handlePendingSessionLimitsExhausted"; /// `session.ui.handlePendingExitPlanMode` pub const SESSION_UI_HANDLEPENDINGEXITPLANMODE: &str = "session.ui.handlePendingExitPlanMode"; /// `session.ui.registerDirectAutoModeSwitchHandler` @@ -342,8 +556,16 @@ pub mod rpc_methods { pub const SESSION_METADATA_SNAPSHOT: &str = "session.metadata.snapshot"; /// `session.metadata.isProcessing` pub const SESSION_METADATA_ISPROCESSING: &str = "session.metadata.isProcessing"; + /// `session.metadata.activity` + pub const SESSION_METADATA_ACTIVITY: &str = "session.metadata.activity"; /// `session.metadata.contextInfo` pub const SESSION_METADATA_CONTEXTINFO: &str = "session.metadata.contextInfo"; + /// `session.metadata.getContextAttribution` + pub const SESSION_METADATA_GETCONTEXTATTRIBUTION: &str = + "session.metadata.getContextAttribution"; + /// `session.metadata.getContextHeaviestMessages` + pub const SESSION_METADATA_GETCONTEXTHEAVIESTMESSAGES: &str = + "session.metadata.getContextHeaviestMessages"; /// `session.metadata.recordContextChange` pub const SESSION_METADATA_RECORDCONTEXTCHANGE: &str = "session.metadata.recordContextChange"; /// `session.metadata.setWorkingDirectory` @@ -351,14 +573,30 @@ pub mod rpc_methods { /// `session.metadata.recomputeContextTokens` pub const SESSION_METADATA_RECOMPUTECONTEXTTOKENS: &str = "session.metadata.recomputeContextTokens"; + /// `session.settings.snapshot` + pub const SESSION_SETTINGS_SNAPSHOT: &str = "session.settings.snapshot"; + /// `session.settings.evaluatePredicate` + pub const SESSION_SETTINGS_EVALUATEPREDICATE: &str = "session.settings.evaluatePredicate"; + /// `session.contentExclusion.checkPaths` + pub const SESSION_CONTENTEXCLUSION_CHECKPATHS: &str = "session.contentExclusion.checkPaths"; /// `session.shell.exec` pub const SESSION_SHELL_EXEC: &str = "session.shell.exec"; /// `session.shell.kill` pub const SESSION_SHELL_KILL: &str = "session.shell.kill"; + /// `session.shell.executeUserRequested` + pub const SESSION_SHELL_EXECUTEUSERREQUESTED: &str = "session.shell.executeUserRequested"; + /// `session.shell.cancelUserRequested` + pub const SESSION_SHELL_CANCELUSERREQUESTED: &str = "session.shell.cancelUserRequested"; /// `session.history.compact` pub const SESSION_HISTORY_COMPACT: &str = "session.history.compact"; /// `session.history.truncate` pub const SESSION_HISTORY_TRUNCATE: &str = "session.history.truncate"; + /// `session.history.listRewindPoints` + pub const SESSION_HISTORY_LISTREWINDPOINTS: &str = "session.history.listRewindPoints"; + /// `session.history.previewRewind` + pub const SESSION_HISTORY_PREVIEWREWIND: &str = "session.history.previewRewind"; + /// `session.history.rewind` + pub const SESSION_HISTORY_REWIND: &str = "session.history.rewind"; /// `session.history.cancelBackgroundCompaction` pub const SESSION_HISTORY_CANCELBACKGROUNDCOMPACTION: &str = "session.history.cancelBackgroundCompaction"; @@ -366,12 +604,45 @@ pub mod rpc_methods { pub const SESSION_HISTORY_ABORTMANUALCOMPACTION: &str = "session.history.abortManualCompaction"; /// `session.history.summarizeForHandoff` pub const SESSION_HISTORY_SUMMARIZEFORHANDOFF: &str = "session.history.summarizeForHandoff"; + /// `session.history.clearContext` + pub const SESSION_HISTORY_CLEARCONTEXT: &str = "session.history.clearContext"; /// `session.queue.pendingItems` pub const SESSION_QUEUE_PENDINGITEMS: &str = "session.queue.pendingItems"; + /// `session.queue.snapshot` + pub const SESSION_QUEUE_SNAPSHOT: &str = "session.queue.snapshot"; + /// `session.queue.moveItem` + pub const SESSION_QUEUE_MOVEITEM: &str = "session.queue.moveItem"; + /// `session.queue.insertAt` + pub const SESSION_QUEUE_INSERTAT: &str = "session.queue.insertAt"; + /// `session.queue.removeAt` + pub const SESSION_QUEUE_REMOVEAT: &str = "session.queue.removeAt"; + /// `session.queue.updateText` + pub const SESSION_QUEUE_UPDATETEXT: &str = "session.queue.updateText"; + /// `session.queue.duplicateAt` + pub const SESSION_QUEUE_DUPLICATEAT: &str = "session.queue.duplicateAt"; + /// `session.queue.setDrainPaused` + pub const SESSION_QUEUE_SETDRAINPAUSED: &str = "session.queue.setDrainPaused"; + /// `session.queue.sendNow` + pub const SESSION_QUEUE_SENDNOW: &str = "session.queue.sendNow"; + /// `session.queue.hasPending` + pub const SESSION_QUEUE_HASPENDING: &str = "session.queue.hasPending"; + /// `session.queue.beginDeferredIdleDrain` + pub const SESSION_QUEUE_BEGINDEFERREDIDLEDRAIN: &str = "session.queue.beginDeferredIdleDrain"; + /// `session.queue.finishDeferredIdleDrain` + pub const SESSION_QUEUE_FINISHDEFERREDIDLEDRAIN: &str = "session.queue.finishDeferredIdleDrain"; + /// `session.queue.deferSessionIdle` + pub const SESSION_QUEUE_DEFERSESSIONIDLE: &str = "session.queue.deferSessionIdle"; /// `session.queue.removeMostRecent` pub const SESSION_QUEUE_REMOVEMOSTRECENT: &str = "session.queue.removeMostRecent"; /// `session.queue.clear` pub const SESSION_QUEUE_CLEAR: &str = "session.queue.clear"; + /// `session.queue.consumeSystemNotifications` + pub const SESSION_QUEUE_CONSUMESYSTEMNOTIFICATIONS: &str = + "session.queue.consumeSystemNotifications"; + /// `session.queue.enqueueResumePending` + pub const SESSION_QUEUE_ENQUEUERESUMEPENDING: &str = "session.queue.enqueueResumePending"; + /// `session.queue.process` + pub const SESSION_QUEUE_PROCESS: &str = "session.queue.process"; /// `session.eventLog.read` pub const SESSION_EVENTLOG_READ: &str = "session.eventLog.read"; /// `session.eventLog.tail` @@ -382,16 +653,42 @@ pub mod rpc_methods { pub const SESSION_EVENTLOG_RELEASEINTEREST: &str = "session.eventLog.releaseInterest"; /// `session.usage.getMetrics` pub const SESSION_USAGE_GETMETRICS: &str = "session.usage.getMetrics"; + /// `session.limitPrediction.predict` + pub const SESSION_LIMITPREDICTION_PREDICT: &str = "session.limitPrediction.predict"; /// `session.remote.enable` pub const SESSION_REMOTE_ENABLE: &str = "session.remote.enable"; /// `session.remote.disable` pub const SESSION_REMOTE_DISABLE: &str = "session.remote.disable"; /// `session.remote.notifySteerableChanged` pub const SESSION_REMOTE_NOTIFYSTEERABLECHANGED: &str = "session.remote.notifySteerableChanged"; + /// `session.visibility.get` + pub const SESSION_VISIBILITY_GET: &str = "session.visibility.get"; + /// `session.visibility.set` + pub const SESSION_VISIBILITY_SET: &str = "session.visibility.set"; /// `session.schedule.list` pub const SESSION_SCHEDULE_LIST: &str = "session.schedule.list"; + /// `session.schedule.hydrate` + pub const SESSION_SCHEDULE_HYDRATE: &str = "session.schedule.hydrate"; + /// `session.schedule.hasSelfPaced` + pub const SESSION_SCHEDULE_HASSELFPACED: &str = "session.schedule.hasSelfPaced"; + /// `session.schedule.add` + pub const SESSION_SCHEDULE_ADD: &str = "session.schedule.add"; + /// `session.schedule.addCron` + pub const SESSION_SCHEDULE_ADDCRON: &str = "session.schedule.addCron"; + /// `session.schedule.addAt` + pub const SESSION_SCHEDULE_ADDAT: &str = "session.schedule.addAt"; + /// `session.schedule.addSelfPaced` + pub const SESSION_SCHEDULE_ADDSELFPACED: &str = "session.schedule.addSelfPaced"; + /// `session.schedule.rearmSelfPaced` + pub const SESSION_SCHEDULE_REARMSELFPACED: &str = "session.schedule.rearmSelfPaced"; /// `session.schedule.stop` pub const SESSION_SCHEDULE_STOP: &str = "session.schedule.stop"; + /// `providerToken.getToken` + pub const PROVIDERTOKEN_GETTOKEN: &str = "providerToken.getToken"; + /// `factory.execute` + pub const FACTORY_EXECUTE: &str = "factory.execute"; + /// `factory.abort` + pub const FACTORY_ABORT: &str = "factory.abort"; /// `sessionFs.readFile` pub const SESSIONFS_READFILE: &str = "sessionFs.readFile"; /// `sessionFs.writeFile` @@ -414,6 +711,8 @@ pub mod rpc_methods { pub const SESSIONFS_RENAME: &str = "sessionFs.rename"; /// `sessionFs.sqliteQuery` pub const SESSIONFS_SQLITEQUERY: &str = "sessionFs.sqliteQuery"; + /// `sessionFs.sqliteTransaction` + pub const SESSIONFS_SQLITETRANSACTION: &str = "sessionFs.sqliteTransaction"; /// `sessionFs.sqliteExists` pub const SESSIONFS_SQLITEEXISTS: &str = "sessionFs.sqliteExists"; /// `canvas.open` @@ -458,7 +757,51 @@ pub struct AbortResult { pub success: bool, } +/// Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountAllUsers { + /// Authentication information for this user + pub auth_info: serde_json::Value, + /// Associated token, if available + #[serde(skip_serializing_if = "Option::is_none")] + pub token: Option, +} + +/// Current authentication state +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountGetCurrentAuthResult { + /// Authentication errors from the last auth attempt, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_errors: Option>, + /// Current authentication information, if authenticated + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_info: Option, +} + /// Optional GitHub token used to look up quota for a specific user instead of the global auth context. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AccountGetQuotaRequest { @@ -467,7 +810,14 @@ pub struct AccountGetQuotaRequest { pub git_hub_token: Option, } -/// Schema for the `AccountQuotaSnapshot` type. +/// Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AccountQuotaSnapshot { @@ -491,6 +841,13 @@ pub struct AccountQuotaSnapshot { } /// Quota usage snapshots for the resolved user, keyed by quota type. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AccountGetQuotaResult { @@ -498,7 +855,108 @@ pub struct AccountGetQuotaResult { pub quota_snapshots: HashMap, } -/// Schema for the `AgentInfo` type. +/// Credentials to store after successful authentication +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountLoginRequest { + /// GitHub host URL + pub host: String, + /// User login/username + pub login: String, + /// GitHub authentication token + pub token: String, +} + +/// Result of a successful login; throws on failure +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountLoginResult { + /// Whether the credential was persisted to a secure store (system keychain, or the config file when plaintext storage is enabled). False when no secure store was available and the token was not saved, so the consumer can decide how to proceed. + pub stored_in_vault: bool, +} + +/// User to log out +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountLogoutRequest { + /// Authentication information for the user to log out + pub auth_info: serde_json::Value, +} + +/// Logout result indicating if more users remain +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AccountLogoutResult { + /// Whether other authenticated users remain after logout + pub has_more_users: bool, +} + +/// Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentDiscoveryPath { + /// Absolute path of the search/create directory (may not exist on disk yet) + pub path: String, + /// Whether this is the canonical directory to create a new agent in its tier. At most one entry per tier is preferred. + pub preferred_for_creation: bool, + /// The input project path this directory was derived from (only for project scope) + #[serde(skip_serializing_if = "Option::is_none")] + pub project_path: Option, + /// Which tier this directory belongs to + pub scope: AgentDiscoveryPathScope, +} + +/// Canonical locations where custom agents can be created so the runtime will recognize them. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentDiscoveryPathList { + /// Canonical agent create/discovery directories, in priority order + pub paths: Vec, +} + +/// Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path. /// ///
    /// @@ -525,14 +983,17 @@ pub struct AgentInfo { ///
    #[serde(skip_serializing_if = "Option::is_none")] pub mcp_servers: Option>, - /// Preferred model id for this agent. When omitted, inherits the outer agent's model. + /// Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference. #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, - /// Unique identifier of the custom agent + /// Name of the agent. Use `id` as the stable selection identifier. pub name: String, /// Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path. #[serde(skip_serializing_if = "Option::is_none")] pub path: Option, + /// Authored base prompt for the agent. Runtime prompt assembly may add dynamic context at invocation time. Omitted from `session.agent.list` unless `includePrompt` is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt: Option, /// Skill names preloaded into this agent's context. Omitted means none. #[serde(skip_serializing_if = "Option::is_none")] pub skills: Option>, @@ -562,7 +1023,7 @@ pub struct AgentGetCurrentResult { pub agent: AgentInfo, } -/// Custom agents available to the session. +/// Agents available to the session. /// ///
    /// @@ -573,10 +1034,29 @@ pub struct AgentGetCurrentResult { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AgentList { - /// Available custom agents + /// Available agents pub agents: Vec, } +/// Controls whether built-in agents and authored prompt text are included. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentListRequest { + /// When true, request the session's configured built-in agents alongside custom agents. Listing applies feature, context, inclusion, exclusion, and user-disabled-agent policy, but does not evaluate transient invocation requirements such as model availability. Built-in metadata may be omitted when the session cannot project it, such as a relay session. + #[serde(skip_serializing_if = "Option::is_none")] + pub include_built_in_agents: Option, + /// When true, request authored base prompt text on each AgentInfo. Prompt text may be omitted when unavailable, such as for agents projected through a relay session. + #[serde(skip_serializing_if = "Option::is_none")] + pub include_prompt: Option, +} + /// Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window). /// ///
    @@ -794,6 +1274,25 @@ pub struct AgentReloadResult { pub agents: Vec, } +/// Optional project paths to include in agent discovery. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentsDiscoverRequest { + /// When true, omit the host's agents (the user-level agent directory and all plugin agents), leaving only project and remote agents. For multitenant deployments. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_agents: Option, + /// Optional list of project directory paths to scan for project-scoped agents. When omitted or empty, only user/plugin/remote-independent agents are returned (no project scan). + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, +} + /// Name of the custom agent to select for subsequent turns. /// ///
    @@ -824,6 +1323,42 @@ pub struct AgentSelectResult { pub agent: AgentInfo, } +/// An in-memory authored prompt override for an available agent. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentSetPromptRequest { + /// Stable effective agent id. Plugin namespace separators are normalized. + pub id: String, + /// Replacement authored prompt. Empty text is valid. + pub prompt: String, +} + +/// Optional project paths to include when enumerating agent discovery directories. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentsGetDiscoveryPathsRequest { + /// When true, omit the host's user-level agent directory, leaving only project directories. For multitenant deployments (mirrors `discover`'s `excludeHostAgents`). + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_agents: Option, + /// Optional list of project directory paths. When omitted or empty, only the user-level directory is returned. + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, +} + /// Indicates whether the operation succeeded and reports the post-mutation state. /// ///
    @@ -835,13 +1370,16 @@ pub struct AgentSelectResult { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AllowAllPermissionSetResult { - /// Authoritative allow-all state after the mutation + /// Authoritative full allow-all state after the mutation pub enabled: bool, + /// Authoritative allow-all mode after the mutation + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, /// Whether the operation succeeded pub success: bool, } -/// Current full allow-all permission state. +/// Current allow-all permission mode. /// ///
    /// @@ -854,9 +1392,12 @@ pub struct AllowAllPermissionSetResult { pub struct AllowAllPermissionState { /// Whether full allow-all permissions are currently active pub enabled: bool, + /// Current allow-all mode + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } -/// Schema for the `CopilotUserResponseEndpoints` type. +/// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. /// ///
    /// @@ -869,6 +1410,8 @@ pub struct AllowAllPermissionState { pub struct CopilotUserResponseEndpoints { #[serde(skip_serializing_if = "Option::is_none")] pub api: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub exp: Option, #[serde(rename = "origin-tracker", skip_serializing_if = "Option::is_none")] pub origin_tracker: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -877,7 +1420,7 @@ pub struct CopilotUserResponseEndpoints { pub telemetry: Option, } -/// Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. +/// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
    /// @@ -888,36 +1431,48 @@ pub struct CopilotUserResponseEndpoints { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CopilotUserResponseQuotaSnapshotsChat { + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. #[serde(skip_serializing_if = "Option::is_none")] pub entitlement: Option, + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. #[serde(rename = "has_quota", skip_serializing_if = "Option::is_none")] pub has_quota: Option, + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. #[serde(rename = "overage_count", skip_serializing_if = "Option::is_none")] pub overage_count: Option, + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. #[serde(rename = "overage_permitted", skip_serializing_if = "Option::is_none")] pub overage_permitted: Option, + /// Percentage of the entitlement remaining at the snapshot timestamp. #[serde(rename = "percent_remaining", skip_serializing_if = "Option::is_none")] pub percent_remaining: Option, + /// Identifier of the quota bucket this snapshot describes. #[serde(rename = "quota_id", skip_serializing_if = "Option::is_none")] pub quota_id: Option, + /// Amount of quota remaining at the snapshot timestamp. #[serde(rename = "quota_remaining", skip_serializing_if = "Option::is_none")] pub quota_remaining: Option, + /// Unix epoch time, in seconds, when this quota next resets. #[serde(rename = "quota_reset_at", skip_serializing_if = "Option::is_none")] pub quota_reset_at: Option, + /// Remaining entitlement/quota amount at the snapshot timestamp. #[serde(skip_serializing_if = "Option::is_none")] pub remaining: Option, + /// UTC timestamp when this snapshot was captured. #[serde(rename = "timestamp_utc", skip_serializing_if = "Option::is_none")] pub timestamp_utc: Option, + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. #[serde( rename = "token_based_billing", skip_serializing_if = "Option::is_none" )] pub token_based_billing: Option, + /// Whether the entitlement for this category is unlimited. #[serde(skip_serializing_if = "Option::is_none")] pub unlimited: Option, } -/// Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. +/// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
    /// @@ -928,36 +1483,48 @@ pub struct CopilotUserResponseQuotaSnapshotsChat { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CopilotUserResponseQuotaSnapshotsCompletions { + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. #[serde(skip_serializing_if = "Option::is_none")] pub entitlement: Option, + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. #[serde(rename = "has_quota", skip_serializing_if = "Option::is_none")] pub has_quota: Option, + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. #[serde(rename = "overage_count", skip_serializing_if = "Option::is_none")] pub overage_count: Option, + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. #[serde(rename = "overage_permitted", skip_serializing_if = "Option::is_none")] pub overage_permitted: Option, + /// Percentage of the entitlement remaining at the snapshot timestamp. #[serde(rename = "percent_remaining", skip_serializing_if = "Option::is_none")] pub percent_remaining: Option, + /// Identifier of the quota bucket this snapshot describes. #[serde(rename = "quota_id", skip_serializing_if = "Option::is_none")] pub quota_id: Option, + /// Amount of quota remaining at the snapshot timestamp. #[serde(rename = "quota_remaining", skip_serializing_if = "Option::is_none")] pub quota_remaining: Option, + /// Unix epoch time, in seconds, when this quota next resets. #[serde(rename = "quota_reset_at", skip_serializing_if = "Option::is_none")] pub quota_reset_at: Option, + /// Remaining entitlement/quota amount at the snapshot timestamp. #[serde(skip_serializing_if = "Option::is_none")] pub remaining: Option, + /// UTC timestamp when this snapshot was captured. #[serde(rename = "timestamp_utc", skip_serializing_if = "Option::is_none")] pub timestamp_utc: Option, + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. #[serde( rename = "token_based_billing", skip_serializing_if = "Option::is_none" )] pub token_based_billing: Option, + /// Whether the entitlement for this category is unlimited. #[serde(skip_serializing_if = "Option::is_none")] pub unlimited: Option, } -/// Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. +/// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. /// ///
    /// @@ -968,36 +1535,48 @@ pub struct CopilotUserResponseQuotaSnapshotsCompletions { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CopilotUserResponseQuotaSnapshotsPremiumInteractions { + /// Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement. #[serde(skip_serializing_if = "Option::is_none")] pub entitlement: Option, + /// Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets. #[serde(rename = "has_quota", skip_serializing_if = "Option::is_none")] pub has_quota: Option, + /// Count of additional pay-per-request usage consumed this period beyond the entitlement. #[serde(rename = "overage_count", skip_serializing_if = "Option::is_none")] pub overage_count: Option, + /// Whether usage may continue at pay-per-request rates once the entitlement is exhausted. #[serde(rename = "overage_permitted", skip_serializing_if = "Option::is_none")] pub overage_permitted: Option, + /// Percentage of the entitlement remaining at the snapshot timestamp. #[serde(rename = "percent_remaining", skip_serializing_if = "Option::is_none")] pub percent_remaining: Option, + /// Identifier of the quota bucket this snapshot describes. #[serde(rename = "quota_id", skip_serializing_if = "Option::is_none")] pub quota_id: Option, + /// Amount of quota remaining at the snapshot timestamp. #[serde(rename = "quota_remaining", skip_serializing_if = "Option::is_none")] pub quota_remaining: Option, + /// Unix epoch time, in seconds, when this quota next resets. #[serde(rename = "quota_reset_at", skip_serializing_if = "Option::is_none")] pub quota_reset_at: Option, + /// Remaining entitlement/quota amount at the snapshot timestamp. #[serde(skip_serializing_if = "Option::is_none")] pub remaining: Option, + /// UTC timestamp when this snapshot was captured. #[serde(rename = "timestamp_utc", skip_serializing_if = "Option::is_none")] pub timestamp_utc: Option, + /// Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count. #[serde( rename = "token_based_billing", skip_serializing_if = "Option::is_none" )] pub token_based_billing: Option, + /// Whether the entitlement for this category is unlimited. #[serde(skip_serializing_if = "Option::is_none")] pub unlimited: Option, } -/// Schema for the `CopilotUserResponseQuotaSnapshots` type. +/// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. /// ///
    /// @@ -1008,13 +1587,13 @@ pub struct CopilotUserResponseQuotaSnapshotsPremiumInteractions { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CopilotUserResponseQuotaSnapshots { - /// Schema for the `CopilotUserResponseQuotaSnapshotsChat` type. + /// Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. #[serde(skip_serializing_if = "Option::is_none")] pub chat: Option, - /// Schema for the `CopilotUserResponseQuotaSnapshotsCompletions` type. + /// Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. #[serde(skip_serializing_if = "Option::is_none")] pub completions: Option, - /// Schema for the `CopilotUserResponseQuotaSnapshotsPremiumInteractions` type. + /// Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields. #[serde( rename = "premium_interactions", skip_serializing_if = "Option::is_none" @@ -1033,85 +1612,115 @@ pub struct CopilotUserResponseQuotaSnapshots { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CopilotUserResponse { + /// Copilot access SKU identifier (e.g. `free_limited_copilot`, `copilot_for_business_seat_quota`) used to gate model and feature access. #[serde(rename = "access_type_sku", skip_serializing_if = "Option::is_none")] pub access_type_sku: Option, + /// Opaque analytics tracking identifier for the user, forwarded from the Copilot API. #[serde( rename = "analytics_tracking_id", skip_serializing_if = "Option::is_none" )] pub analytics_tracking_id: Option, + /// Date the Copilot seat was assigned to the user, if applicable. #[serde(rename = "assigned_date", skip_serializing_if = "Option::is_none")] pub assigned_date: Option, + /// Whether the user is eligible to sign up for the free/limited Copilot tier. #[serde( rename = "can_signup_for_limited", skip_serializing_if = "Option::is_none" )] pub can_signup_for_limited: Option, + /// Whether the user is able to upgrade their Copilot plan. + #[serde(rename = "can_upgrade_plan", skip_serializing_if = "Option::is_none")] + pub can_upgrade_plan: Option, + /// Whether Copilot chat is enabled for the user. #[serde(rename = "chat_enabled", skip_serializing_if = "Option::is_none")] pub chat_enabled: Option, + /// Whether CLI remote control is enabled for the user. #[serde( rename = "cli_remote_control_enabled", skip_serializing_if = "Option::is_none" )] pub cli_remote_control_enabled: Option, + /// Whether cloud session storage is enabled for the user. #[serde( rename = "cloud_session_storage_enabled", skip_serializing_if = "Option::is_none" )] pub cloud_session_storage_enabled: Option, + /// Whether the Codex agent is enabled for the user. #[serde( rename = "codex_agent_enabled", skip_serializing_if = "Option::is_none" )] pub codex_agent_enabled: Option, + /// Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`). #[serde(rename = "copilot_plan", skip_serializing_if = "Option::is_none")] pub copilot_plan: Option, + /// Whether `.copilotignore` content-exclusion support is enabled for the user. #[serde( rename = "copilotignore_enabled", skip_serializing_if = "Option::is_none" )] pub copilotignore_enabled: Option, - /// Schema for the `CopilotUserResponseEndpoints` type. + /// Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough. #[serde(skip_serializing_if = "Option::is_none")] pub endpoints: Option, + /// Whether MCP (Model Context Protocol) support is enabled for the user. #[serde(rename = "is_mcp_enabled", skip_serializing_if = "Option::is_none")] pub is_mcp_enabled: Option, + /// Whether the user is a GitHub/Microsoft staff member. + #[serde(rename = "is_staff", skip_serializing_if = "Option::is_none")] + pub is_staff: Option, + /// Per-category quota allotments for free/limited-tier users, keyed by quota category. #[serde( rename = "limited_user_quotas", skip_serializing_if = "Option::is_none" )] pub limited_user_quotas: Option>, + /// Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API. #[serde( rename = "limited_user_reset_date", skip_serializing_if = "Option::is_none" )] pub limited_user_reset_date: Option, + /// GitHub login of the authenticated user. #[serde(skip_serializing_if = "Option::is_none")] pub login: Option, + /// Per-category monthly quota allotments, keyed by quota category. #[serde(rename = "monthly_quotas", skip_serializing_if = "Option::is_none")] pub monthly_quotas: Option>, + /// Organizations the user belongs to, each with an optional login and display name. #[serde(rename = "organization_list", skip_serializing_if = "Option::is_none")] pub organization_list: Option, + /// Logins of the organizations the user belongs to. #[serde( rename = "organization_login_list", skip_serializing_if = "Option::is_none" )] pub organization_login_list: Option>, + /// Date the user's usage quota next resets, as a raw string from the Copilot API; see `quota_reset_date_utc` for the UTC-normalized value. #[serde(rename = "quota_reset_date", skip_serializing_if = "Option::is_none")] pub quota_reset_date: Option, + /// UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets). #[serde( rename = "quota_reset_date_utc", skip_serializing_if = "Option::is_none" )] pub quota_reset_date_utc: Option, - /// Schema for the `CopilotUserResponseQuotaSnapshots` type. + /// Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries. #[serde(rename = "quota_snapshots", skip_serializing_if = "Option::is_none")] pub quota_snapshots: Option, + /// Whether the user's telemetry is subject to restricted-data handling. #[serde( rename = "restricted_telemetry", skip_serializing_if = "Option::is_none" )] pub restricted_telemetry: Option, + /// Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub te: Option, + /// Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota. #[serde( rename = "token_based_billing", skip_serializing_if = "Option::is_none" @@ -1119,7 +1728,7 @@ pub struct CopilotUserResponse { pub token_based_billing: Option, } -/// Schema for the `ApiKeyAuthInfo` type. +/// Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host. /// ///
    /// @@ -1141,7 +1750,7 @@ pub struct ApiKeyAuthInfo { pub r#type: ApiKeyAuthInfoType, } -/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. +/// Blob attachment with inline base64-encoded data /// ///
    /// @@ -1151,18 +1760,29 @@ pub struct ApiKeyAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasAction { - /// Description of the action +pub struct AttachmentBlob { + /// Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// JSON Schema for the action input + pub asset_id: Option, + /// Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. #[serde(skip_serializing_if = "Option::is_none")] - pub input_schema: Option, - /// Action name exposed by the canvas provider - pub name: String, + pub byte_length: Option, + /// Base64-encoded content. Present on input and for external consumers; replaced by an internal `assetId` reference in persisted events when interned to a content-addressed asset. + #[serde(skip_serializing_if = "Option::is_none")] + pub data: Option, + /// User-facing display name for the attachment + #[serde(skip_serializing_if = "Option::is_none")] + pub display_name: Option, + /// MIME type of the inline data + pub mime_type: String, + /// Internal: why model-facing bytes are absent from persistence. Absent externally. + #[serde(skip_serializing_if = "Option::is_none")] + pub omitted_reason: Option, + /// Attachment type discriminator + pub r#type: AttachmentBlobType, } -/// Canvas action invocation parameters. +/// Directory attachment /// ///
    /// @@ -1172,17 +1792,19 @@ pub struct CanvasAction { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasActionInvokeRequest { - /// Action name to invoke - pub action_name: String, - /// Action input +pub struct AttachmentDirectory { + /// User-facing display name for the attachment + pub display_name: String, + /// Absolute directory path + pub path: String, + /// Frozen rendered line this attachment contributed to the prompt block (e.g. "* /path (12 items)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Open canvas instance identifier - pub instance_id: String, + pub tagged_files_entry: Option, + /// Attachment type discriminator + pub r#type: AttachmentDirectoryType, } -/// Canvas action invocation result. +/// Structured context contributed by an extension. Composer pills displayed in the host are forwarded back through session.send.attachments, then rendered into the model prompt as an XML block. /// ///
    /// @@ -1192,13 +1814,27 @@ pub struct CanvasActionInvokeRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasActionInvokeResult { - /// Provider-supplied action result +pub struct AttachmentExtensionContext { + /// Provider-local canvas identifier when the push was bound to a canvas instance #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, + pub canvas_id: Option, + /// ISO 8601 timestamp captured by the runtime when the push was accepted + pub captured_at: String, + /// Owning extension identifier. Runtime-derived from the caller's connection when produced via session.extensions.sendAttachmentsToMessage; preserved verbatim on subsequent transports. + pub extension_id: String, + /// Open canvas instance identifier when the push was bound to a canvas instance + #[serde(skip_serializing_if = "Option::is_none")] + pub instance_id: Option, + /// Caller-supplied JSON payload + #[serde(skip_serializing_if = "Option::is_none")] + pub payload: Option, + /// Human-readable composer pill label + pub title: String, + /// Attachment type discriminator + pub r#type: AttachmentExtensionContextType, } -/// Canvas close parameters. +/// Optional line range to scope the attachment to a specific section of the file /// ///
    /// @@ -1208,12 +1844,14 @@ pub struct CanvasActionInvokeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasCloseRequest { - /// Open canvas instance identifier - pub instance_id: String, +pub struct AttachmentFileLineRange { + /// End line number (1-based, inclusive) + pub end: i64, + /// Start line number (1-based) + pub start: i64, } -/// Host capabilities +/// File attachment /// ///
    /// @@ -1223,13 +1861,34 @@ pub struct CanvasCloseRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasHostContextCapabilities { - /// Whether canvas rendering is supported +pub struct AttachmentFile { + /// Internal: content-addressed id of the session.binary_asset event holding this attachment's model-facing bytes (e.g. "sha256:..."). Absent externally. #[serde(skip_serializing_if = "Option::is_none")] - pub canvases: Option, + pub asset_id: Option, + /// Internal: decoded byte length of the attachment's model-facing bytes. Absent externally. + #[serde(skip_serializing_if = "Option::is_none")] + pub byte_length: Option, + /// User-facing display name for the attachment + pub display_name: String, + /// Optional line range to scope the attachment to a specific section of the file + #[serde(skip_serializing_if = "Option::is_none")] + pub line_range: Option, + /// Internal: MIME type of the file's model-facing bytes (post-resize for images). Set when the file's bytes are interned to an asset. Absent externally. + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Internal: why model-facing bytes are absent from persistence. Absent externally. + #[serde(skip_serializing_if = "Option::is_none")] + pub omitted_reason: Option, + /// Absolute file path + pub path: String, + /// Frozen rendered line this attachment contributed to the prompt block (e.g. "* /path (123 lines)"). Captured at send time so resumed history reproduces the exact text the model saw, independent of later filesystem changes. Present only for attachments routed to (mutually exclusive with assetId, which marks bytes sent natively). + #[serde(skip_serializing_if = "Option::is_none")] + pub tagged_files_entry: Option, + /// Attachment type discriminator + pub r#type: AttachmentFileType, } -/// Host context supplied by the runtime. +/// Pointer to a GitHub repository. /// ///
    /// @@ -1239,13 +1898,17 @@ pub struct CanvasHostContextCapabilities { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasHostContext { - /// Host capabilities +pub struct GitHubRepoRef { + /// Numeric GitHub repository id #[serde(skip_serializing_if = "Option::is_none")] - pub capabilities: Option, + pub id: Option, + /// Repository name (without owner) + pub name: String, + /// Repository owner login (user or organization) + pub owner: String, } -/// Canvas available in the current session. +/// Pointer to a GitHub Actions job. /// ///
    /// @@ -1255,27 +1918,25 @@ pub struct CanvasHostContext { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct DiscoveredCanvas { - /// Actions the agent or host may invoke on an open instance +pub struct AttachmentGitHubActionsJob { + /// Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. #[serde(skip_serializing_if = "Option::is_none")] - pub actions: Option>, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Short, single-sentence description shown to the agent in canvas catalogs. - pub description: String, - /// Human-readable canvas name - pub display_name: String, - /// Owning provider identifier - pub extension_id: String, - /// Owning extension display name, when available - #[serde(skip_serializing_if = "Option::is_none")] - pub extension_name: Option, - /// JSON Schema for canvas open input - #[serde(skip_serializing_if = "Option::is_none")] - pub input_schema: Option, + pub conclusion: Option, + /// Job id within the workflow run + pub job_id: i64, + /// Display name of the job + pub job_name: String, + /// Repository the workflow run belongs to + pub repo: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubActionsJobType, + /// URL to the job on GitHub + pub url: String, + /// Display name of the workflow the job ran in + pub workflow_name: String, } -/// Declared canvases available in this session. +/// Pointer to a GitHub commit. /// ///
    /// @@ -1285,12 +1946,20 @@ pub struct DiscoveredCanvas { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasList { - /// Declared canvases available in this session - pub canvases: Vec, +pub struct AttachmentGitHubCommit { + /// First line of the commit message + pub message: String, + /// Full commit SHA + pub oid: String, + /// Repository the commit belongs to + pub repo: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubCommitType, + /// URL to the commit on GitHub + pub url: String, } -/// Open canvas instance snapshot. +/// Pointer to a file in a GitHub repository at a specific ref. /// ///
    /// @@ -1300,35 +1969,20 @@ pub struct CanvasList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct OpenCanvasInstance { - /// Runtime-controlled routing state for an open canvas instance. - pub availability: CanvasInstanceAvailability, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Owning provider identifier - pub extension_id: String, - /// Owning extension display name, when available - #[serde(skip_serializing_if = "Option::is_none")] - pub extension_name: Option, - /// Input supplied when the instance was opened - #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Stable caller-supplied canvas instance identifier - pub instance_id: String, - /// Whether this snapshot came from an idempotent reopen - pub reopen: bool, - /// Provider-supplied status text - #[serde(skip_serializing_if = "Option::is_none")] - pub status: Option, - /// Rendered title - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// URL for web-rendered canvases - #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, +pub struct AttachmentGitHubFile { + /// Repository-relative path to the file + pub path: String, + /// Git ref the file is read at (branch, tag, or commit SHA) + pub r#ref: String, + /// Repository the file lives in + pub repo: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubFileType, + /// URL to the file on GitHub + pub url: String, } -/// Live open-canvas snapshot. +/// One side of a file diff (head or base) /// ///
    /// @@ -1338,12 +1992,16 @@ pub struct OpenCanvasInstance { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasListOpenResult { - /// Currently open canvas instances - pub open_canvases: Vec, +pub struct AttachmentGitHubFileDiffSide { + /// Repository-relative path to the file + pub path: String, + /// Git ref (branch, tag, or commit SHA) the file is read at + pub r#ref: String, + /// Repository the file lives in + pub repo: GitHubRepoRef, } -/// Canvas open parameters. +/// Pointer to a single-file diff. At least one of `head` and `base` must be present. /// ///
    /// @@ -1353,20 +2011,20 @@ pub struct CanvasListOpenResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasOpenRequest { - /// Provider-local canvas identifier - pub canvas_id: String, - /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. +pub struct AttachmentGitHubFileDiff { + /// File location on the base side of the diff. Absent for additions. #[serde(skip_serializing_if = "Option::is_none")] - pub extension_id: Option, - /// Canvas open input + pub base: Option, + /// File location on the head side of the diff. Absent for deletions. #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Caller-supplied stable instance identifier - pub instance_id: String, + pub head: Option, + /// Attachment type discriminator + pub r#type: AttachmentGitHubFileDiffType, + /// URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + pub url: String, } -/// Session context supplied by the runtime. +/// GitHub issue, pull request, or discussion reference /// ///
    /// @@ -1376,13 +2034,22 @@ pub struct CanvasOpenRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasSessionContext { - /// Active session working directory, when known. - #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, +pub struct AttachmentGitHubReference { + /// Issue, pull request, or discussion number + pub number: i64, + /// Type of GitHub reference + pub reference_type: AttachmentGitHubReferenceType, + /// Current state of the referenced item (e.g., open, closed, merged) + pub state: String, + /// Title of the referenced item + pub title: String, + /// Attachment type discriminator + pub r#type: AttachmentGitHubReferenceType, + /// URL to the referenced item on GitHub + pub url: String, } -/// Canvas close parameters sent to the provider. +/// Pointer to a GitHub release. /// ///
    /// @@ -1392,24 +2059,20 @@ pub struct CanvasSessionContext { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasProviderCloseRequest { - /// Target session identifier - pub session_id: SessionId, - /// Owning provider identifier - pub extension_id: String, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Canvas instance identifier - pub instance_id: String, - /// Host context supplied by the runtime. - #[serde(skip_serializing_if = "Option::is_none")] - pub host: Option, - /// Session context supplied by the runtime. - #[serde(skip_serializing_if = "Option::is_none")] - pub session: Option, +pub struct AttachmentGitHubRelease { + /// Human-readable release name + pub name: String, + /// Repository the release belongs to + pub repo: GitHubRepoRef, + /// Git tag the release is anchored to + pub tag_name: String, + /// Attachment type discriminator + pub r#type: AttachmentGitHubReleaseType, + /// URL to the release on GitHub + pub url: String, } -/// Canvas action invocation parameters sent to the provider. +/// Pointer to a GitHub repository. /// ///
    /// @@ -1419,29 +2082,22 @@ pub struct CanvasProviderCloseRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasProviderInvokeActionRequest { - /// Target session identifier - pub session_id: SessionId, - /// Owning provider identifier - pub extension_id: String, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Canvas instance identifier - pub instance_id: String, - /// Action name to invoke - pub action_name: String, - /// Action input - #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Host context supplied by the runtime. +pub struct AttachmentGitHubRepository { + /// Short description of the repository #[serde(skip_serializing_if = "Option::is_none")] - pub host: Option, - /// Session context supplied by the runtime. + pub description: Option, + /// Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. #[serde(skip_serializing_if = "Option::is_none")] - pub session: Option, + pub r#ref: Option, + /// Repository pointer + pub repo: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubRepositoryType, + /// URL to the repository on GitHub + pub url: String, } -/// Canvas open parameters sent to the provider. +/// Pointer to a line range inside a file in a GitHub repository. /// ///
    /// @@ -1451,27 +2107,22 @@ pub struct CanvasProviderInvokeActionRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasProviderOpenRequest { - /// Target session identifier - pub session_id: SessionId, - /// Owning provider identifier - pub extension_id: String, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Stable caller-supplied canvas instance identifier - pub instance_id: String, - /// Canvas open input - #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Host context supplied by the runtime. - #[serde(skip_serializing_if = "Option::is_none")] - pub host: Option, - /// Session context supplied by the runtime. - #[serde(skip_serializing_if = "Option::is_none")] - pub session: Option, +pub struct AttachmentGitHubSnippet { + /// Line range the snippet covers + pub line_range: AttachmentFileLineRange, + /// Repository-relative path to the file + pub path: String, + /// Git ref the file is read at (branch, tag, or commit SHA) + pub r#ref: String, + /// Repository the file lives in + pub repo: GitHubRepoRef, + /// Attachment type discriminator + pub r#type: AttachmentGitHubSnippetType, + /// URL to the snippet on GitHub (with line anchor) + pub url: String, } -/// Canvas open result returned by the provider. +/// One side of a tree comparison (head or base) /// ///
    /// @@ -1481,19 +2132,14 @@ pub struct CanvasProviderOpenRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasProviderOpenResult { - /// Provider-supplied status text - #[serde(skip_serializing_if = "Option::is_none")] - pub status: Option, - /// Provider-supplied title - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// URL for web-rendered canvases - #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, +pub struct AttachmentGitHubTreeComparisonSide { + /// Repository the revision belongs to + pub repo: GitHubRepoRef, + /// Git revision (branch, tag, or commit SHA) + pub revision: String, } -/// Optional unstructured input hint +/// Pointer to a comparison between two git revisions. /// ///
    /// @@ -1503,21 +2149,18 @@ pub struct CanvasProviderOpenResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandInput { - /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) - #[serde(skip_serializing_if = "Option::is_none")] - pub completion: Option, - /// Hint to display when command input has not been provided - pub hint: String, - /// When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace - #[serde(skip_serializing_if = "Option::is_none")] - pub preserve_multiline_input: Option, - /// When true, the command requires non-empty input; clients should render the input hint as required - #[serde(skip_serializing_if = "Option::is_none")] - pub required: Option, +pub struct AttachmentGitHubTreeComparison { + /// Base side of the comparison + pub base: AttachmentGitHubTreeComparisonSide, + /// Head side of the comparison + pub head: AttachmentGitHubTreeComparisonSide, + /// Attachment type discriminator + pub r#type: AttachmentGitHubTreeComparisonType, + /// URL to the comparison on GitHub + pub url: String, } -/// Schema for the `SlashCommandInfo` type. +/// Generic GitHub URL reference. /// ///
    /// @@ -1527,27 +2170,14 @@ pub struct SlashCommandInput { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandInfo { - /// Canonical aliases without leading slashes - #[serde(skip_serializing_if = "Option::is_none")] - pub aliases: Option>, - /// Whether the command may run while an agent turn is active - pub allow_during_agent_execution: bool, - /// Human-readable command description - pub description: String, - /// Whether the command is experimental - #[serde(skip_serializing_if = "Option::is_none")] - pub experimental: Option, - /// Optional unstructured input hint - #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command - pub kind: SlashCommandKind, - /// Canonical command name without a leading slash - pub name: String, +pub struct AttachmentGitHubUrl { + /// Attachment type discriminator + pub r#type: AttachmentGitHubUrlType, + /// URL to the GitHub resource + pub url: String, } -/// Slash commands available in the session, after applying any include/exclude filters. +/// End position of the selection /// ///
    /// @@ -1557,12 +2187,14 @@ pub struct SlashCommandInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandList { - /// Commands available in this session - pub commands: Vec, +pub struct AttachmentSelectionDetailsEnd { + /// End character offset within the line (0-based) + pub character: i64, + /// End line number (0-based) + pub line: i64, } -/// Pending command request ID and an optional error if the client handler failed. +/// Start position of the selection /// ///
    /// @@ -1572,15 +2204,14 @@ pub struct CommandList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsHandlePendingCommandRequest { - /// Error message if the command handler failed - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Request ID from the command invocation event - pub request_id: RequestId, +pub struct AttachmentSelectionDetailsStart { + /// Start character offset within the line (0-based) + pub character: i64, + /// Start line number (0-based) + pub line: i64, } -/// Indicates whether the pending client-handled command was completed successfully. +/// Position range of the selection within the file /// ///
    /// @@ -1590,12 +2221,14 @@ pub struct CommandsHandlePendingCommandRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsHandlePendingCommandResult { - /// Whether the command was handled successfully - pub success: bool, +pub struct AttachmentSelectionDetails { + /// End position of the selection + pub end: AttachmentSelectionDetailsEnd, + /// Start position of the selection + pub start: AttachmentSelectionDetailsStart, } -/// Slash command name and optional raw input string to invoke. +/// Code selection attachment from an editor /// ///
    /// @@ -1605,15 +2238,20 @@ pub struct CommandsHandlePendingCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsInvokeRequest { - /// Raw input after the command name - #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Command name. Leading slashes are stripped and the name is matched case-insensitively. - pub name: String, +pub struct AttachmentSelection { + /// User-facing display name for the selection + pub display_name: String, + /// Absolute path to the file containing the selection + pub file_path: String, + /// Position range of the selection within the file + pub selection: AttachmentSelectionDetails, + /// The selected text content + pub text: String, + /// Attachment type discriminator + pub r#type: AttachmentSelectionType, } -/// Optional filters controlling which command sources to include in the listing. +/// A well-known model in the runtime's built-in catalog. /// ///
    /// @@ -1623,19 +2261,12 @@ pub struct CommandsInvokeRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsListRequest { - /// Include runtime built-in commands - #[serde(skip_serializing_if = "Option::is_none")] - pub include_builtins: Option, - /// Include commands registered by protocol clients, including SDK clients and extensions - #[serde(skip_serializing_if = "Option::is_none")] - pub include_client_commands: Option, - /// Include enabled user-invocable skills and commands - #[serde(skip_serializing_if = "Option::is_none")] - pub include_skills: Option, +pub struct BuiltInModelCatalogEntry { + /// Well-known runtime model ID suitable for `ProviderConfig.modelId` or `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability. + pub id: String, } -/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). +/// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. /// ///
    /// @@ -1645,14 +2276,12 @@ pub struct CommandsListRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsRespondToQueuedCommandRequest { - /// Request ID from the `command.queued` event the host is responding to. - pub request_id: RequestId, - /// Result of the queued command execution. - pub result: serde_json::Value, +pub struct BuiltInModelCatalog { + /// Built-in model entries. + pub models: Vec, } -/// Indicates whether the queued-command response was matched to a pending request. +/// Cancellation result for a user-requested shell command. /// ///
    /// @@ -1662,12 +2291,12 @@ pub struct CommandsRespondToQueuedCommandRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CommandsRespondToQueuedCommandResult { - /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. - pub success: bool, +pub struct CancelUserRequestedShellCommandResult { + /// Whether an in-flight execution was found and signalled to cancel + pub cancelled: bool, } -/// Repository associated with the connected remote session. +/// Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool. /// ///
    /// @@ -1677,16 +2306,18 @@ pub struct CommandsRespondToQueuedCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ConnectedRemoteSessionMetadataRepository { - /// Branch associated with the remote session. - pub branch: String, - /// Repository name. +pub struct CanvasAction { + /// Description of the action + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// JSON Schema for the action input + #[serde(skip_serializing_if = "Option::is_none")] + pub input_schema: Option, + /// Action name exposed by the canvas provider pub name: String, - /// Repository owner or organization login. - pub owner: String, } -/// Metadata for a connected remote session. +/// Canvas action invocation parameters. /// ///
    /// @@ -1696,38 +2327,17 @@ pub struct ConnectedRemoteSessionMetadataRepository { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ConnectedRemoteSessionMetadata { - /// Neutral SDK discriminator for the connected remote session kind. - pub kind: ConnectedRemoteSessionMetadataKind, - /// Last session update time as an ISO 8601 string. - pub modified_time: String, - /// Optional friendly session name. - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Pull request number associated with the session. - #[serde(skip_serializing_if = "Option::is_none")] - pub pull_request_number: Option, - /// Repository associated with the connected remote session. - pub repository: ConnectedRemoteSessionMetadataRepository, - /// Original remote resource identifier. - #[serde(skip_serializing_if = "Option::is_none")] - pub resource_id: Option, - /// SDK session ID for the connected remote session. - pub session_id: SessionId, - /// Remote session staleness deadline as an ISO 8601 string. - #[serde(skip_serializing_if = "Option::is_none")] - pub stale_at: Option, - /// Session start time as an ISO 8601 string. - pub start_time: String, - /// Remote session state returned by the backing service. - #[serde(skip_serializing_if = "Option::is_none")] - pub state: Option, - /// Optional session summary. +pub struct CanvasActionInvokeRequest { + /// Action name to invoke + pub action_name: String, + /// Action input #[serde(skip_serializing_if = "Option::is_none")] - pub summary: Option, + pub input: Option, + /// Open canvas instance identifier + pub instance_id: String, } -/// Remote session connection parameters. +/// Canvas action invocation result. /// ///
    /// @@ -1737,33 +2347,13 @@ pub struct ConnectedRemoteSessionMetadata { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ConnectRemoteSessionParams { - /// Session ID to connect to. - pub session_id: SessionId, -} - -/// Optional connection token presented by the SDK client during the handshake. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub(crate) struct ConnectRequest { - /// Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN +pub struct CanvasActionInvokeResult { + /// Provider-supplied action result #[serde(skip_serializing_if = "Option::is_none")] - pub token: Option, -} - -/// Handshake result reporting the server's protocol version and package version on success. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub(crate) struct ConnectResult { - /// Always true on success - pub ok: bool, - /// Server protocol version number - pub protocol_version: i64, - /// Server package version - pub version: String, + pub result: Option, } -/// Schema for the `CopilotApiTokenAuthInfo` type. +/// Canvas close parameters. /// ///
    /// @@ -1773,17 +2363,12 @@ pub(crate) struct ConnectResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CopilotApiTokenAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Authentication host (always the public GitHub host). - pub host: CopilotApiTokenAuthInfoHost, - /// Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. - pub r#type: CopilotApiTokenAuthInfoType, +pub struct CanvasCloseRequest { + /// Open canvas instance identifier + pub instance_id: String, } -/// The currently selected model, reasoning effort, and context tier for the session. +/// Host capabilities /// ///
    /// @@ -1793,19 +2378,13 @@ pub struct CopilotApiTokenAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CurrentModel { - /// Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. - #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, - /// Currently active model identifier - #[serde(skip_serializing_if = "Option::is_none")] - pub model_id: Option, - /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. +pub struct CanvasHostContextCapabilities { + /// Whether canvas rendering is supported #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, + pub canvases: Option, } -/// Lightweight metadata for a currently initialized session tool +/// Host context supplied by the runtime. /// ///
    /// @@ -1815,44 +2394,13 @@ pub struct CurrentModel { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CurrentToolMetadata { - /// Whether the tool is loaded on demand via tool search - #[serde(skip_serializing_if = "Option::is_none")] - pub defer_loading: Option, - /// Tool description - pub description: String, - /// JSON Schema for tool input - #[serde(rename = "input_schema", skip_serializing_if = "Option::is_none")] - pub input_schema: Option>, - /// MCP server name for MCP-backed tools - #[serde(skip_serializing_if = "Option::is_none")] - pub mcp_server_name: Option, - /// Raw MCP tool name for MCP-backed tools - #[serde(skip_serializing_if = "Option::is_none")] - pub mcp_tool_name: Option, - /// Model-facing tool name - pub name: String, - /// Optional MCP/config namespaced tool name - #[serde(skip_serializing_if = "Option::is_none")] - pub namespaced_name: Option, -} - -/// Schema for the `DiscoveredMcpServer` type. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct DiscoveredMcpServer { - /// Whether the server is enabled (not in the disabled list) - pub enabled: bool, - /// Server name (config key) - pub name: String, - /// Configuration source: user, workspace, plugin, or builtin - pub source: McpServerSource, - /// Server transport type: stdio, http, sse (deprecated), or memory +pub struct CanvasHostContext { + /// Host capabilities #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, + pub capabilities: Option, } -/// Slash-prefixed command string to enqueue for FIFO processing. +/// Canvas available in the current session. /// ///
    /// @@ -1862,12 +2410,30 @@ pub struct DiscoveredMcpServer { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EnqueueCommandParams { - /// Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. - pub command: String, +pub struct DiscoveredCanvas { + /// Actions the agent or host may invoke on an open instance + #[serde(skip_serializing_if = "Option::is_none")] + pub actions: Option>, + /// Provider-local canvas identifier + pub canvas_id: String, + /// Short, single-sentence description shown to the agent in canvas catalogs. + pub description: String, + /// Human-readable canvas name + pub display_name: String, + /// Owning provider identifier + pub extension_id: String, + /// Owning extension display name, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub extension_name: Option, + /// Host-local PNG path for the canvas icon, when supplied + #[serde(skip_serializing_if = "Option::is_none")] + pub icon: Option, + /// JSON Schema for canvas open input + #[serde(skip_serializing_if = "Option::is_none")] + pub input_schema: Option, } -/// Indicates whether the command was accepted into the local execution queue. +/// Declared canvases available in this session. /// ///
    /// @@ -1877,12 +2443,12 @@ pub struct EnqueueCommandParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EnqueueCommandResult { - /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). - pub queued: bool, +pub struct CanvasList { + /// Declared canvases available in this session + pub canvases: Vec, } -/// Schema for the `EnvAuthInfo` type. +/// Open canvas instance snapshot. /// ///
    /// @@ -1892,24 +2458,34 @@ pub struct EnqueueCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EnvAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. +pub struct OpenCanvasInstance { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Owning extension display name, when available #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Name of the environment variable the token was sourced from. - pub env_var: String, - /// Authentication host (e.g. https://github.com or a GHES host). - pub host: String, - /// User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). + pub extension_name: Option, + /// Host-local PNG path for the canvas icon, when supplied #[serde(skip_serializing_if = "Option::is_none")] - pub login: Option, - /// The token value itself. Treat as a secret. - pub token: String, - /// Personal access token (PAT) or server-to-server token sourced from an environment variable. - pub r#type: EnvAuthInfoType, + pub icon: Option, + /// Input supplied when the instance was opened + #[serde(skip_serializing_if = "Option::is_none")] + pub input: Option, + /// Stable caller-supplied canvas instance identifier + pub instance_id: String, + /// Provider-supplied status text + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Rendered title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL for web-rendered canvases + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, } -/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. +/// Live open-canvas snapshot. /// ///
    /// @@ -1919,25 +2495,12 @@ pub struct EnvAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EventLogReadRequest { - /// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. - #[serde(skip_serializing_if = "Option::is_none")] - pub agent_scope: Option, - /// Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. - #[serde(skip_serializing_if = "Option::is_none")] - pub cursor: Option, - /// Maximum number of events to return in this batch (1–1000, default 200). - #[serde(skip_serializing_if = "Option::is_none")] - pub max: Option, - /// Either '*' to receive all event types, or a non-empty list of event types to receive - #[serde(skip_serializing_if = "Option::is_none")] - pub types: Option, - /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). - #[serde(skip_serializing_if = "Option::is_none")] - pub wait_ms: Option, +pub struct CanvasListOpenResult { + /// Currently open canvas instances + pub open_canvases: Vec, } -/// Indicates whether the operation succeeded. +/// Canvas open parameters. /// ///
    /// @@ -1947,12 +2510,20 @@ pub struct EventLogReadRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EventLogReleaseInterestResult { - /// Whether the operation succeeded - pub success: bool, +pub struct CanvasOpenRequest { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier. Optional when the canvasId is unique across providers; required to disambiguate when multiple providers register the same canvasId. + #[serde(skip_serializing_if = "Option::is_none")] + pub extension_id: Option, + /// Canvas open input + #[serde(skip_serializing_if = "Option::is_none")] + pub input: Option, + /// Caller-supplied stable instance identifier + pub instance_id: String, } -/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). +/// Session context supplied by the runtime. /// ///
    /// @@ -1962,12 +2533,13 @@ pub struct EventLogReleaseInterestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EventLogTailResult { - /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). - pub cursor: String, +pub struct CanvasSessionContext { + /// Active session working directory, when known. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// Batch of session events returned by a read, with cursor and continuation metadata. +/// Canvas close parameters sent to the provider. /// ///
    /// @@ -1977,35 +2549,24 @@ pub struct EventLogTailResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct EventsReadResult { - /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. - pub cursor: String, - /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. - pub cursor_status: EventsCursorStatus, - /// Events are delivered in two batches per read: persisted events first (in append order), then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral events do not interleave within a single read. - pub events: Vec, - /// True when the read returned `max` events and more events are available immediately. When false, the next read with a non-zero `waitMs` will block until a new event arrives or the wait expires. - pub has_more: bool, -} - -/// Slash command name and argument string to execute synchronously. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ExecuteCommandParams { - /// Argument string to pass to the command (empty string if none). - pub args: String, - /// Name of the slash command to invoke (without the leading '/'). - pub command_name: String, +pub struct CanvasProviderCloseRequest { + /// Target session identifier + pub session_id: SessionId, + /// Owning provider identifier + pub extension_id: String, + /// Provider-local canvas identifier + pub canvas_id: String, + /// Canvas instance identifier + pub instance_id: String, + /// Host context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Session context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub session: Option, } -/// Error message produced while executing the command, if any. +/// Canvas action invocation parameters sent to the provider. /// ///
    /// @@ -2015,13 +2576,29 @@ pub struct ExecuteCommandParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExecuteCommandResult { - /// Error message produced while executing the command, if any. Omitted when the handler succeeded. +pub struct CanvasProviderInvokeActionRequest { + /// Target session identifier + pub session_id: SessionId, + /// Owning provider identifier + pub extension_id: String, + /// Provider-local canvas identifier + pub canvas_id: String, + /// Canvas instance identifier + pub instance_id: String, + /// Action name to invoke + pub action_name: String, + /// Action input #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, + pub input: Option, + /// Host context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Session context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub session: Option, } -/// Schema for the `Extension` type. +/// Canvas open parameters sent to the provider. /// ///
    /// @@ -2031,21 +2608,27 @@ pub struct ExecuteCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct Extension { - /// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper') - pub id: String, - /// Extension name (directory name) - pub name: String, - /// Process ID if the extension is running +pub struct CanvasProviderOpenRequest { + /// Target session identifier + pub session_id: SessionId, + /// Owning provider identifier + pub extension_id: String, + /// Provider-local canvas identifier + pub canvas_id: String, + /// Stable caller-supplied canvas instance identifier + pub instance_id: String, + /// Canvas open input #[serde(skip_serializing_if = "Option::is_none")] - pub pid: Option, - /// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) - pub source: ExtensionSource, - /// Current status: running, disabled, failed, or starting - pub status: ExtensionStatus, + pub input: Option, + /// Host context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Session context supplied by the runtime. + #[serde(skip_serializing_if = "Option::is_none")] + pub session: Option, } -/// Extensions discovered for the session, with their current status. +/// Canvas open result returned by the provider. /// ///
    /// @@ -2055,12 +2638,19 @@ pub struct Extension { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExtensionList { - /// Discovered extensions and their current status - pub extensions: Vec, +pub struct CanvasProviderOpenResult { + /// Provider-supplied status text + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Provider-supplied title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL for web-rendered canvases + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, } -/// Source-qualified extension identifier to disable for the session. +/// Options scoped to the built-in CAPI (Copilot API) provider. /// ///
    /// @@ -2070,12 +2660,13 @@ pub struct ExtensionList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExtensionsDisableRequest { - /// Source-qualified extension ID to disable - pub id: String, +pub struct CapiSessionOptions { + /// Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when the model advertises `ws:/responses` support; set to `false` to force the HTTP Responses transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting this to `false` is equivalent to the `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_web_socket_responses: Option, } -/// Source-qualified extension identifier to enable for the session. +/// A literal choice the command input accepts, with a human-facing description /// ///
    /// @@ -2085,12 +2676,14 @@ pub struct ExtensionsDisableRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExtensionsEnableRequest { - /// Source-qualified extension ID to enable - pub id: String, +pub struct SlashCommandInputChoice { + /// Human-readable description shown alongside the choice + pub description: String, + /// The literal choice value (e.g. 'on', 'off', 'show') + pub name: String, } -/// Binary result returned by a tool for the model +/// Optional unstructured input hint /// ///
    /// @@ -2100,22 +2693,24 @@ pub struct ExtensionsEnableRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmBinaryResultsForLlm { - /// Base64-encoded binary data - pub data: String, - /// Human-readable description of the binary data +pub struct SlashCommandInput { + /// Optional literal choices the input accepts, each with a human-facing description; clients may render these as selectable options #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Optional metadata from the producing tool. + pub choices: Option>, + /// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) #[serde(skip_serializing_if = "Option::is_none")] - pub metadata: Option>, - /// MIME type of the binary data - pub mime_type: String, - /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. - pub r#type: ExternalToolTextResultForLlmBinaryResultsForLlmType, + pub completion: Option, + /// Hint to display when command input has not been provided + pub hint: String, + /// When true, clients should pass the full text after the command name as a single argument rather than splitting on whitespace + #[serde(skip_serializing_if = "Option::is_none")] + pub preserve_multiline_input: Option, + /// When true, the command requires non-empty input; clients should render the input hint as required + #[serde(skip_serializing_if = "Option::is_none")] + pub required: Option, } -/// Expanded external tool result payload +/// Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability. /// ///
    /// @@ -2125,30 +2720,30 @@ pub struct ExternalToolTextResultForLlmBinaryResultsForLlm { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlm { - /// Base64-encoded binary results returned to the model - #[serde(skip_serializing_if = "Option::is_none")] - pub binary_results_for_llm: Option>, - /// Structured content blocks from the tool - #[serde(skip_serializing_if = "Option::is_none")] - pub contents: Option>, - /// Optional error message for failed executions +pub struct SlashCommandInfo { + /// Canonical aliases without leading slashes #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized. + pub aliases: Option>, + /// Whether the command may run while an agent turn is active + pub allow_during_agent_execution: bool, + /// Human-readable command description + pub description: String, + /// Whether the command is experimental #[serde(skip_serializing_if = "Option::is_none")] - pub result_type: Option, - /// Detailed log content for timeline display + pub experimental: Option, + /// Optional unstructured input hint #[serde(skip_serializing_if = "Option::is_none")] - pub session_log: Option, - /// Text result returned to the model - pub text_result_for_llm: String, - /// Optional tool-specific telemetry + pub input: Option, + /// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command + pub kind: SlashCommandKind, + /// Canonical command name without a leading slash + pub name: String, + /// Whether the command may be the target of `/every` / `/after` schedules. Resolution happens at every tick, so only set this when the command is safe to re-invoke and produces an agent prompt. #[serde(skip_serializing_if = "Option::is_none")] - pub tool_telemetry: Option>, + pub schedulable: Option, } -/// Audio content block with base64-encoded data +/// Slash commands available in the session, after applying any include/exclude filters. /// ///
    /// @@ -2158,16 +2753,12 @@ pub struct ExternalToolTextResultForLlm { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentAudio { - /// Base64-encoded audio data - pub data: String, - /// MIME type of the audio (e.g., audio/wav, audio/mpeg) - pub mime_type: String, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentAudioType, +pub struct CommandList { + /// Commands available in this session + pub commands: Vec, } -/// Image content block with base64-encoded data +/// Pending command request ID and an optional error if the client handler failed. /// ///
    /// @@ -2177,16 +2768,15 @@ pub struct ExternalToolTextResultForLlmContentAudio { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentImage { - /// Base64-encoded image data - pub data: String, - /// MIME type of the image (e.g., image/png, image/jpeg) - pub mime_type: String, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentImageType, +pub struct CommandsHandlePendingCommandRequest { + /// Error message if the command handler failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Request ID from the command invocation event + pub request_id: RequestId, } -/// Embedded resource content block with inline text or binary data +/// Indicates whether the pending client-handled command was completed successfully. /// ///
    /// @@ -2196,14 +2786,12 @@ pub struct ExternalToolTextResultForLlmContentImage { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentResource { - /// The embedded resource contents, either text or base64-encoded binary - pub resource: serde_json::Value, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentResourceType, +pub struct CommandsHandlePendingCommandResult { + /// Whether the command was handled successfully + pub success: bool, } -/// Icon image for a resource +/// Slash command name and optional raw input string to invoke. /// ///
    /// @@ -2213,21 +2801,15 @@ pub struct ExternalToolTextResultForLlmContentResource { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentResourceLinkIcon { - /// MIME type of the icon image - #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Available icon sizes (e.g., ['16x16', '32x32']) - #[serde(skip_serializing_if = "Option::is_none")] - pub sizes: Option>, - /// URL or path to the icon image - pub src: String, - /// Theme variant this icon is intended for +pub struct CommandsInvokeRequest { + /// Raw input after the command name #[serde(skip_serializing_if = "Option::is_none")] - pub theme: Option, + pub input: Option, + /// Command name. Leading slashes are stripped and the name is matched case-insensitively. + pub name: String, } -/// Resource link content block referencing an external resource +/// Optional filters controlling which command sources to include in the listing. /// ///
    /// @@ -2237,31 +2819,19 @@ pub struct ExternalToolTextResultForLlmContentResourceLinkIcon { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentResourceLink { - /// Human-readable description of the resource - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Icons associated with this resource - #[serde(skip_serializing_if = "Option::is_none")] - pub icons: Option>, - /// MIME type of the resource content +pub struct CommandsListRequest { + /// Include runtime built-in commands #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Resource name identifier - pub name: String, - /// Size of the resource in bytes + pub include_builtins: Option, + /// Include commands registered by protocol clients, including SDK clients and extensions #[serde(skip_serializing_if = "Option::is_none")] - pub size: Option, - /// Human-readable display title for the resource + pub include_client_commands: Option, + /// Include enabled user-invocable skills and commands #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentResourceLinkType, - /// URI identifying the resource - pub uri: String, + pub include_skills: Option, } -/// Terminal/shell output content block with optional exit code and working directory +/// Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). /// ///
    /// @@ -2271,20 +2841,14 @@ pub struct ExternalToolTextResultForLlmContentResourceLink { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentTerminal { - /// Working directory where the command was executed - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Process exit code, if the command has completed - #[serde(skip_serializing_if = "Option::is_none")] - pub exit_code: Option, - /// Terminal/shell output text - pub text: String, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentTerminalType, +pub struct CommandsRespondToQueuedCommandRequest { + /// Request ID from the `command.queued` event the host is responding to. + pub request_id: RequestId, + /// Result of the queued command execution. + pub result: serde_json::Value, } -/// Plain text content block +/// Indicates whether the queued-command response was matched to a pending request. /// ///
    /// @@ -2294,14 +2858,12 @@ pub struct ExternalToolTextResultForLlmContentTerminal { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ExternalToolTextResultForLlmContentText { - /// The text content - pub text: String, - /// Content block type discriminator - pub r#type: ExternalToolTextResultForLlmContentTextType, +pub struct CommandsRespondToQueuedCommandResult { + /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + pub success: bool, } -/// Optional user prompt to combine with the fleet orchestration instructions. +/// Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). /// ///
    /// @@ -2311,13 +2873,12 @@ pub struct ExternalToolTextResultForLlmContentText { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FleetStartRequest { - /// Optional user prompt to combine with fleet instructions - #[serde(skip_serializing_if = "Option::is_none")] - pub prompt: Option, +pub struct CompletionsGetTriggerCharactersResult { + /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + pub trigger_characters: Vec, } -/// Indicates whether fleet mode was successfully activated. +/// Request host-driven completions for the current composer input. /// ///
    /// @@ -2327,12 +2888,14 @@ pub struct FleetStartRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FleetStartResult { - /// Whether fleet mode was successfully activated - pub started: bool, +pub struct CompletionsRequestRequest { + /// Cursor offset within `text`, in UTF-16 code units. + pub offset: i64, + /// The full composed composer input. + pub text: String, } -/// Folder path to add to trusted folders. +/// A single host-driven completion. Accepting an item replaces `[rangeStart, rangeEnd)` (UTF-16 code units) in the composer with `insertText`; when the range is absent, the active token around the cursor is replaced. /// ///
    /// @@ -2342,12 +2905,24 @@ pub struct FleetStartResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FolderTrustAddParams { - /// Folder path to mark as trusted - pub path: String, +pub struct SessionCompletionItem { + /// Text spliced into the composer when the item is accepted. + pub insert_text: String, + /// Render-kind hint for the picker row (e.g. `"document"`, `"directory"`), derived from the host's display kind. + #[serde(skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Primary display label for the picker row. Falls back to `insertText` when absent. + #[serde(skip_serializing_if = "Option::is_none")] + pub label: Option, + /// End (exclusive) of the replacement range in `text`, in UTF-16 code units. + #[serde(skip_serializing_if = "Option::is_none")] + pub range_end: Option, + /// Start of the replacement range in `text`, in UTF-16 code units. + #[serde(skip_serializing_if = "Option::is_none")] + pub range_start: Option, } -/// Folder path to check for trust. +/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. /// ///
    /// @@ -2357,12 +2932,12 @@ pub struct FolderTrustAddParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FolderTrustCheckParams { - /// Folder path to check - pub path: String, +pub struct CompletionsRequestResult { + /// Completion items in host-ranked order. + pub items: Vec, } -/// Folder trust check result. +/// Params to attach or detach an in-process ExtensionController delegate. /// ///
    /// @@ -2372,12 +2947,16 @@ pub struct FolderTrustCheckParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct FolderTrustCheckResult { - /// Whether the folder is trusted - pub trusted: bool, +pub(crate) struct ConfigureSessionExtensionsParams { + /// In-process ExtensionController delegate (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. The post-SDK extension surface exposes list/enable/disable/reload via dedicated RPCs served by the runtime. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) controller: Option, + /// Session to attach the extension controller delegate to. + pub session_id: SessionId, } -/// Schema for the `GhCliAuthInfo` type. +/// Repository associated with the connected remote session. /// ///
    /// @@ -2387,21 +2966,16 @@ pub struct FolderTrustCheckResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct GhCliAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Authentication host. - pub host: String, - /// User login as reported by `gh auth status`. - pub login: String, - /// The token returned by `gh auth token`. Treat as a secret. - pub token: String, - /// Authentication via the `gh` CLI's saved credentials. - pub r#type: GhCliAuthInfoType, +pub struct ConnectedRemoteSessionMetadataRepository { + /// Branch associated with the remote session. + pub branch: String, + /// Repository name. + pub name: String, + /// Repository owner or organization login. + pub owner: String, } -/// Pending external tool call request ID, with the tool result or an error describing why it failed. +/// Metadata for a connected remote session. /// ///
    /// @@ -2411,18 +2985,38 @@ pub struct GhCliAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HandlePendingToolCallRequest { - /// Error message if the tool call failed +pub struct ConnectedRemoteSessionMetadata { + /// Neutral SDK discriminator for the connected remote session kind. + pub kind: ConnectedRemoteSessionMetadataKind, + /// Last session update time as an ISO 8601 string. + pub modified_time: String, + /// Optional friendly session name. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Request ID of the pending tool call - pub request_id: RequestId, - /// Tool call result (string or expanded result object) + pub name: Option, + /// Pull request number associated with the session. #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, + pub pull_request_number: Option, + /// Repository associated with the connected remote session. + pub repository: ConnectedRemoteSessionMetadataRepository, + /// Original remote resource identifier. + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_id: Option, + /// SDK session ID for the connected remote session. + pub session_id: SessionId, + /// Remote session staleness deadline as an ISO 8601 string. + #[serde(skip_serializing_if = "Option::is_none")] + pub stale_at: Option, + /// Session start time as an ISO 8601 string. + pub start_time: String, + /// Remote session state returned by the backing service. + #[serde(skip_serializing_if = "Option::is_none")] + pub state: Option, + /// Optional session summary. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, } -/// Indicates whether the external tool call result was handled successfully. +/// Remote session connection parameters. /// ///
    /// @@ -2432,12 +3026,12 @@ pub struct HandlePendingToolCallRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HandlePendingToolCallResult { - /// Whether the tool call result was handled successfully - pub success: bool, +pub struct ConnectRemoteSessionParams { + /// Session ID to connect to. + pub session_id: SessionId, } -/// Indicates whether an in-progress manual compaction was aborted. +/// Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). /// ///
    /// @@ -2447,12 +3041,16 @@ pub struct HandlePendingToolCallResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryAbortManualCompactionResult { - /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. - pub aborted: bool, +pub(crate) struct ConnectRequest { + /// Opt this connection in to GitHub telemetry forwarding for its lifetime. When set, the runtime forwards every internal telemetry event it emits — across all sessions, plus sessionless events — to this connection over the `gitHubTelemetry.event` notification. Regular events are also written to the runtime's normal GitHub/CTS path (dual-write); host-only compatibility events are forward-only and intentionally skip that path. Intended for first-party hosts that re-emit the events into their own telemetry stores. Both unrestricted and restricted events are forwarded, each tagged with a `restricted` discriminator; a backstop drops restricted events when restricted telemetry is disabled — using the process-global gate for ordinary events and an explicit session-scoped decision for host-only events. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_git_hub_telemetry_forwarding: Option, + /// Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN + #[serde(skip_serializing_if = "Option::is_none")] + pub token: Option, } -/// Indicates whether an in-progress background compaction was cancelled. +/// Handshake result reporting the server's protocol version and package version on success. /// ///
    /// @@ -2462,12 +3060,16 @@ pub struct HistoryAbortManualCompactionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryCancelBackgroundCompactionResult { - /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. - pub cancelled: bool, +pub(crate) struct ConnectResult { + /// Always true on success + pub ok: bool, + /// Server protocol version number + pub protocol_version: i64, + /// Server package version + pub version: String, } -/// Post-compaction context window usage breakdown +/// Local file system absolute paths within the session working directory to check against its content-exclusion policy. /// ///
    /// @@ -2477,25 +3079,12 @@ pub struct HistoryCancelBackgroundCompactionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryCompactContextWindow { - /// Token count from non-system messages (user, assistant, tool) - #[serde(skip_serializing_if = "Option::is_none")] - pub conversation_tokens: Option, - /// Current total tokens in the context window (system + conversation + tool definitions) - pub current_tokens: i64, - /// Current number of messages in the conversation - pub messages_length: i64, - /// Token count from system message(s) - #[serde(skip_serializing_if = "Option::is_none")] - pub system_tokens: Option, - /// Maximum token count for the model's context window - pub token_limit: i64, - /// Token count from tool definitions - #[serde(skip_serializing_if = "Option::is_none")] - pub tool_definitions_tokens: Option, +pub struct ContentExclusionCheckPathsRequest { + /// Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates. + pub paths: Vec, } -/// Optional compaction parameters. +/// Content-exclusion decision for one requested path. /// ///
    /// @@ -2505,13 +3094,14 @@ pub struct HistoryCompactContextWindow { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryCompactRequest { - /// Optional user-provided instructions to focus the compaction summary - #[serde(skip_serializing_if = "Option::is_none")] - pub custom_instructions: Option, +pub struct ContentExclusionPathCheck { + /// Whether the session's complete content-exclusion policy excludes the path. + pub excluded: bool, + /// The path supplied by the caller. + pub path: String, } -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. /// ///
    /// @@ -2521,22 +3111,14 @@ pub struct HistoryCompactRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryCompactResult { - /// Post-compaction context window usage breakdown - #[serde(skip_serializing_if = "Option::is_none")] - pub context_window: Option, - /// Number of messages removed during compaction - pub messages_removed: i64, - /// Whether compaction completed successfully - pub success: bool, - /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). - #[serde(skip_serializing_if = "Option::is_none")] - pub summary_content: Option, - /// Number of tokens freed by compaction - pub tokens_removed: i64, +pub struct ContentExclusionCheckPathsResult { + /// Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded. + pub available: bool, + /// Per-path decisions in request order. Empty when available is false. + pub checks: Vec, } -/// Markdown summary of the conversation context (empty when not available). +/// A single large message currently in context. /// ///
    /// @@ -2546,12 +3128,18 @@ pub struct HistoryCompactResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistorySummarizeForHandoffResult { - /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. - pub summary: String, +pub struct ContextHeaviestMessage { + /// Stable identifier for this message within the snapshot. + pub id: String, + /// Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only. + pub label: String, + /// Role of the chat message (`user`, `assistant`, or `tool`). + pub role: String, + /// Token count currently in context for this individual message. + pub tokens: i64, } -/// Identifier of the event to truncate to; this event and all later events are removed. +/// Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host. /// ///
    /// @@ -2561,12 +3149,17 @@ pub struct HistorySummarizeForHandoffResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryTruncateRequest { - /// Event ID to truncate to. This event and all events after it are removed from the session. - pub event_id: String, +pub struct CopilotApiTokenAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Authentication host (always the public GitHub host). + pub host: CopilotApiTokenAuthInfoHost, + /// Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. + pub r#type: CopilotApiTokenAuthInfoType, } -/// Number of events that were removed by the truncation. +/// The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. /// ///
    /// @@ -2576,12 +3169,19 @@ pub struct HistoryTruncateRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HistoryTruncateResult { - /// Number of events that were removed - pub events_removed: i64, +pub struct CurrentModel { + /// Context tier for models that support multiple context-window sizes. + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Currently active model identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, } -/// Schema for the `HMACAuthInfo` type. +/// Lightweight metadata for a currently initialized session tool /// ///
    /// @@ -2591,19 +3191,29 @@ pub struct HistoryTruncateResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct HMACAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. +pub struct CurrentToolMetadata { + /// Whether the tool is loaded on demand via tool search #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// HMAC secret used to sign requests. - pub hmac: String, - /// Authentication host. HMAC auth always targets the public GitHub host. - pub host: HMACAuthInfoHost, - /// HMAC-based authentication used by GitHub-internal services. - pub r#type: HMACAuthInfoType, + pub defer_loading: Option, + /// Tool description + pub description: String, + /// JSON Schema for tool input + #[serde(rename = "input_schema", skip_serializing_if = "Option::is_none")] + pub input_schema: Option>, + /// MCP server name for MCP-backed tools + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp_server_name: Option, + /// Raw MCP tool name for MCP-backed tools + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp_tool_name: Option, + /// Model-facing tool name + pub name: String, + /// Optional MCP/config namespaced tool name + #[serde(skip_serializing_if = "Option::is_none")] + pub namespaced_name: Option, } -/// Schema for the `InstalledPlugin` type. +/// A file included in the redacted debug bundle. /// ///
    /// @@ -2613,28 +3223,35 @@ pub struct HMACAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstalledPlugin { - /// Path where the plugin is cached locally - #[serde(rename = "cache_path", skip_serializing_if = "Option::is_none")] - pub cache_path: Option, - /// Whether the plugin is currently enabled - pub enabled: bool, - /// Installation timestamp - #[serde(rename = "installed_at")] - pub installed_at: String, - /// Marketplace the plugin came from (empty string for direct repo installs) - pub marketplace: String, - /// Plugin name - pub name: String, - /// Source for direct repo installs (when marketplace is empty) +pub struct DebugCollectLogsCollectedEntry { + /// Relative path of the file in the staged bundle/archive. + pub bundle_path: String, + /// Redacted output size in bytes. + pub size_bytes: i64, + /// Source category for this entry. + pub source: DebugCollectLogsSource, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct DebugCollectLogsDestinationArchive { + pub kind: DebugCollectLogsDestinationArchiveKind, + /// When true, create the archive atomically without overwriting an existing file by appending ` (N)` before the extension as needed. Defaults to false. #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, - /// Version installed (if available) - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option, + pub no_overwrite: Option, + /// Absolute or server-relative path for the .tgz archive to create. + pub output_path: String, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct DebugCollectLogsDestinationDirectory { + pub kind: DebugCollectLogsDestinationDirectoryKind, + /// Directory where redacted files should be staged. The directory is created if needed. + pub output_directory: String, } -/// Schema for the `InstalledPluginSourceGithub` type. +/// A caller-provided server-local file or directory to include in the debug bundle. /// ///
    /// @@ -2644,17 +3261,22 @@ pub struct InstalledPlugin { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstalledPluginSourceGithub { +pub struct DebugCollectLogsEntry { + /// Relative path to use inside the staged bundle/archive. + pub bundle_path: String, + /// Kind of source path to include. + pub kind: DebugCollectLogsEntryKind, + /// Server-local source path to read. + pub path: String, + /// How text content from this entry should be redacted. Defaults to plain-text. #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, + pub redaction: Option, + /// When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`. #[serde(skip_serializing_if = "Option::is_none")] - pub r#ref: Option, - pub repo: String, - /// Constant value. Always "github". - pub source: InstalledPluginSourceGithubSource, + pub required: Option, } -/// Schema for the `InstalledPluginSourceLocal` type. +/// Built-in session diagnostics to include in the bundle. Omitted fields default to true. /// ///
    /// @@ -2664,13 +3286,31 @@ pub struct InstalledPluginSourceGithub { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstalledPluginSourceLocal { - pub path: String, - /// Constant value. Always "local". - pub source: InstalledPluginSourceLocalSource, +pub struct DebugCollectLogsInclude { + /// Server-local path to the current process log. When set, it is included as `process.log` and its directory is searched for prior logs from the same session. + #[serde(skip_serializing_if = "Option::is_none")] + pub current_process_log_path: Option, + /// Include the session event log (`events.jsonl`). Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub events: Option, + /// Server-local path to the session's events.jsonl file. Internal callers normally omit this and let the runtime derive it from the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_path: Option, + /// Maximum number of previous process logs to include. Defaults to 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_process_log_limit: Option, + /// Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions. + #[serde(skip_serializing_if = "Option::is_none")] + pub process_log_directory: Option, + /// Include process logs for the session. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub process_logs: Option, + /// Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_logs: Option, } -/// Schema for the `InstalledPluginSourceUrl` type. +/// Options for collecting a redacted session debug bundle. /// ///
    /// @@ -2678,19 +3318,20 @@ pub struct InstalledPluginSourceLocal { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstalledPluginSourceUrl { +pub struct DebugCollectLogsRequest { + /// Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape. #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, + pub additional_entries: Option>, + /// Where the redacted bundle should be written. Use `archive` to produce a .tgz, or `directory` to stage redacted files for caller-managed upload/post-processing. + pub destination: DebugCollectLogsDestination, + /// Which built-in session diagnostics to include. Omitted fields default to true. #[serde(skip_serializing_if = "Option::is_none")] - pub r#ref: Option, - /// Constant value. Always "url". - pub source: InstalledPluginSourceUrlSource, - pub url: String, + pub include: Option, } -/// Schema for the `InstructionsSources` type. +/// An optional debug bundle entry that could not be included. /// ///
    /// @@ -2700,31 +3341,39 @@ pub struct InstalledPluginSourceUrl { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstructionsSources { - /// Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files - #[serde(skip_serializing_if = "Option::is_none")] - pub apply_to: Option>, - /// Raw content of the instruction file - pub content: String, - /// When true, this source starts disabled and must be toggled on by the user +pub struct DebugCollectLogsSkippedEntry { + /// Relative path requested for this bundle entry. + pub bundle_path: String, + /// Server-local source path that could not be read. #[serde(skip_serializing_if = "Option::is_none")] - pub default_disabled: Option, - /// Short description (body after frontmatter) for use in instruction tables + pub path: Option, + /// Reason the entry was skipped. + pub reason: String, +} + +/// Result of collecting a redacted debug bundle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct DebugCollectLogsResult { + /// Files included in the redacted bundle. + pub entries: Vec, + /// Destination kind that was written. + pub kind: DebugCollectLogsResultKind, + /// Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed. + pub path: String, + /// Optional files or directories that could not be included. #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Unique identifier for this source (used for toggling) - pub id: String, - /// Human-readable label - pub label: String, - /// Where this source lives — used for UI grouping - pub location: InstructionsSourcesLocation, - /// File path relative to repo or absolute for home - pub source_path: String, - /// Category of instruction source — used for merge logic - pub r#type: InstructionsSourcesType, + pub skipped_entries: Option>, } -/// Instruction sources loaded for the session, in merge order. +/// Installed plugin that contributes a discovered extension. /// ///
    /// @@ -2734,12 +3383,12 @@ pub struct InstructionsSources { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct InstructionsGetSourcesResult { - /// Instruction sources for the session - pub sources: Vec, +pub struct DiscoveredExtensionPlugin { + /// Installed plugin name + pub name: String, } -/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. +/// Discovered extension metadata and persistent enablement state. /// ///
    /// @@ -2749,27 +3398,23 @@ pub struct InstructionsGetSourcesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LogRequest { - /// When true, the message is transient and not persisted to the session event log on disk - #[serde(skip_serializing_if = "Option::is_none")] - pub ephemeral: Option, - /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". - #[serde(skip_serializing_if = "Option::is_none")] - pub level: Option, - /// Human-readable message - pub message: String, - /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. - #[serde(skip_serializing_if = "Option::is_none")] - pub tip: Option, - /// Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". - #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, - /// Optional URL the user can open in their browser for more details +pub struct DiscoveredExtension { + /// Whether this extension's persistent per-ID preference is enabled + pub enabled: bool, + /// Source-qualified ID accepted by both server and session extension enablement methods + pub id: String, + /// Human-readable extension name + pub name: String, + /// Absolute path to the extension entry module, suitable for revealing it in a file manager + pub path: String, + /// Containing plugin metadata for plugin-contributed extensions #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, + pub plugin: Option, + /// Discovery source + pub source: DiscoveredExtensionSource, } -/// Identifier of the session event that was emitted for the log message. +/// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. /// ///
    /// @@ -2779,12 +3424,14 @@ pub struct LogRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LogResult { - /// The unique identifier of the emitted session event - pub event_id: String, +pub struct DiscoveredExtensions { + /// Discovered user and enabled installed-plugin extensions from persisted Copilot home state + pub extensions: Vec, + /// Effective extension loading mode. Defaults to load_and_augment when unset. + pub mode: DiscoveredExtensionMode, } -/// Parameters for (re)loading the merged LSP configuration set. +/// Source-qualified extension identifiers to persistently disable for future sessions. /// ///
    /// @@ -2794,19 +3441,12 @@ pub struct LogResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct LspInitializeRequest { - /// Force re-initialization even when LSP configs were already loaded for the working directory. - #[serde(skip_serializing_if = "Option::is_none")] - pub force: Option, - /// Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). - #[serde(skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. - #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, +pub struct DiscoveredExtensionsDisableRequest { + /// Source-qualified user or plugin extension IDs to disable + pub ids: Vec, } -/// MCP server, tool name, and arguments to invoke from an MCP App view. +/// Source-qualified extension identifiers to persistently enable for future sessions. /// ///
    /// @@ -2816,19 +3456,12 @@ pub struct LspInitializeRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsCallToolRequest { - /// Tool arguments - #[serde(skip_serializing_if = "Option::is_none")] - pub arguments: Option>, - /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. - pub origin_server_name: String, - /// MCP server hosting the tool - pub server_name: String, - /// MCP tool name - pub tool_name: String, +pub struct DiscoveredExtensionsEnableRequest { + /// Source-qualified user or plugin extension IDs to enable + pub ids: Vec, } -/// Capability negotiation snapshot +/// MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state. /// ///
    /// @@ -2838,16 +3471,25 @@ pub struct McpAppsCallToolRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsDiagnoseCapability { - /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers - pub advertised: bool, - /// Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on - pub feature_flag_enabled: bool, - /// Whether the session has the `mcp-apps` capability - pub session_has_mcp_apps: bool, +pub struct DiscoveredMcpServer { + /// Whether the server is enabled (not in the disabled list) + pub enabled: bool, + /// Server name (config key) + pub name: String, + /// Configuration source: user, workspace, plugin, or builtin + pub source: McpServerSource, + /// Plugin name that provided this server, when source is plugin. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin: Option, + /// Plugin version that provided this server, when source is plugin. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_version: Option, + /// Server transport type: stdio, http, sse (deprecated), or memory + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, } -/// MCP server to diagnose MCP Apps wiring for. +/// Slash-prefixed command string to enqueue for FIFO processing. /// ///
    /// @@ -2857,12 +3499,12 @@ pub struct McpAppsDiagnoseCapability { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsDiagnoseRequest { - /// MCP server to probe - pub server_name: String, +pub struct EnqueueCommandParams { + /// Slash-prefixed command string to enqueue, e.g. '/compact' or '/model gpt-4'. Queued FIFO with any in-flight items; if the session is idle, processing kicks off immediately. + pub command: String, } -/// What the server returned for this session +/// Indicates whether the command was accepted into the local execution queue. /// ///
    /// @@ -2872,18 +3514,12 @@ pub struct McpAppsDiagnoseRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsDiagnoseServer { - /// Whether the named server is currently connected - pub connected: bool, - /// Up to 5 tool names with `_meta.ui` for quick inspection - pub sample_tool_names: Vec, - /// Total tools returned by the server's tools/list - pub tool_count: f64, - /// Tools whose `_meta.ui` is populated (resourceUri and/or visibility set) - pub tools_with_ui_meta: f64, +pub struct EnqueueCommandResult { + /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). + pub queued: bool, } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name. /// ///
    /// @@ -2893,14 +3529,24 @@ pub struct McpAppsDiagnoseServer { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsDiagnoseResult { - /// Capability negotiation snapshot - pub capability: McpAppsDiagnoseCapability, - /// What the server returned for this session - pub server: McpAppsDiagnoseServer, +pub struct EnvAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Name of the environment variable the token was sourced from. + pub env_var: String, + /// Authentication host (e.g. https://github.com or a GHES host). + pub host: String, + /// User login associated with the token. Undefined for server-to-server tokens (those starting with `ghs_`). + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// The token value itself. Treat as a secret. + pub token: String, + /// Personal access token (PAT) or server-to-server token sourced from an environment variable. + pub r#type: EnvAuthInfoType, } -/// Current host context +/// Cursor, batch size, and optional long-poll/filter parameters for reading session events. /// ///
    /// @@ -2910,31 +3556,34 @@ pub struct McpAppsDiagnoseResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsHostContextDetails { - /// Display modes the host supports +pub struct EventLogReadRequest { + /// Optional non-empty list of subagent identifiers. When provided, only events owned by one of these agents are returned; ownership recognizes the event envelope's agentId plus legacy data.agentId and data.parentToolCallId markers. This filter takes precedence over agentScope. #[serde(skip_serializing_if = "Option::is_none")] - pub available_display_modes: Option>, - /// Current display mode (SEP-1865) + pub agent_ids: Option>, + /// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. #[serde(skip_serializing_if = "Option::is_none")] - pub display_mode: Option, - /// BCP-47 locale, e.g. 'en-US' + pub agent_scope: Option, + /// Opaque cursor returned by a previous read. Omit on the first call to start from the beginning of the session's persisted history. #[serde(skip_serializing_if = "Option::is_none")] - pub locale: Option, - /// Platform type for responsive design + pub cursor: Option, + /// Direction to page through the session's persisted event history. 'forward' (default) pages from the cursor toward newer events (or from the start of history when no cursor is given). 'backward' enables tail-first reads: with no cursor it returns the NEWEST `max` events, and the returned cursor pages toward OLDER events on subsequent backward reads. Events within a returned batch are always in chronological (oldest-to-newest) order, even for a backward read. Backward reads cover PERSISTED history only; ephemeral events are never returned by a backward read. `direction` selects the INITIAL read only: the returned cursor is self-describing, so a continuation read pages in the cursor's own direction regardless of the `direction` passed alongside it — a forward cursor always pages forward and a backward cursor always pages backward. Pass the direction that matches the cursor to avoid confusion. #[serde(skip_serializing_if = "Option::is_none")] - pub platform: Option, - /// UI theme preference per SEP-1865 + pub direction: Option, + /// When false, skip ephemeral events entirely and return only durable (persisted) events. History-backfill callers that discard ephemerals anyway should set this so the read is bounded by the durable log length instead of racing the ephemeral ring on a busy session. Defaults to true (ephemerals are interleaved with durable events in creation order). Ignored by backward reads, which always cover persisted history only. #[serde(skip_serializing_if = "Option::is_none")] - pub theme: Option, - /// IANA timezone, e.g. 'America/New_York' + pub include_ephemeral: Option, + /// Maximum number of events to return in this batch (1–1000, default 200). #[serde(skip_serializing_if = "Option::is_none")] - pub time_zone: Option, - /// Host application identifier + pub max: Option, + /// Either '*' to receive all event types, or a non-empty list of event types to receive #[serde(skip_serializing_if = "Option::is_none")] - pub user_agent: Option, + pub types: Option, + /// Milliseconds to wait for new events when the cursor is at the tail of history. 0 (default) returns immediately even if no events are available. Capped at 30000ms. Ephemeral events that arrive during the wait are delivered in this batch but are NOT replayable on a subsequent read (use a non-zero waitMs in your next call to capture future ephemerals as they happen). This applies to forward reads only: a backward read always returns immediately and ignores `waitMs`, because backward paging covers persisted history only while new events append at the tail (the opposite end from a backward page), so no blocking or ephemeral delivery can occur. + #[serde(skip_serializing_if = "Option::is_none")] + pub wait_ms: Option, } -/// Current host context advertised to MCP App guests. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -2944,12 +3593,12 @@ pub struct McpAppsHostContextDetails { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsHostContext { - /// Current host context - pub context: McpAppsHostContextDetails, +pub struct EventLogReleaseInterestResult { + /// Whether the operation succeeded + pub success: bool, } -/// MCP server to list app-callable tools for. +/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). /// ///
    /// @@ -2959,14 +3608,12 @@ pub struct McpAppsHostContext { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsListToolsRequest { - /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. - pub origin_server_name: String, - /// MCP server hosting the app - pub server_name: String, +pub struct EventLogTailResult { + /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). + pub cursor: String, } -/// App-callable tools from the named MCP server. +/// Batch of session events returned by a read, with cursor and continuation metadata. /// ///
    /// @@ -2976,12 +3623,18 @@ pub struct McpAppsListToolsRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsListToolsResult { - /// App-callable tools from the server - pub tools: Vec>, +pub struct EventsReadResult { + /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing `direction: backward` with it (the cursor is also self-describing, so backward paging continues correctly). + pub cursor: String, + /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history. For a forward read the fallback starts from the beginning of the remaining history; for a backward read it falls back to the tail (the newest window). Because the fallback page is a fresh boundary snapshot rather than a continuation of the requested cursor, it may overlap events the consumer has already rendered — a backward fallback to the tail in particular can repeat the newest window. On 'expired', consumers should reset or rebase their local pagination state (or deduplicate by event id) before continuing from the returned cursor rather than blindly appending/prepending the fallback page. + pub cursor_status: EventsCursorStatus, + /// Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set `includeEphemeral: false` to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order. + pub events: Vec, + /// True when more events are available in the read's direction. For a forward read, true means the batch returned `max` events and more are available immediately. For a backward read, true means older persisted events remain before the returned window. + pub has_more: bool, } -/// MCP server and resource URI to fetch. +/// Slash command name and argument string to execute synchronously. /// ///
    /// @@ -2991,14 +3644,14 @@ pub struct McpAppsListToolsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsReadResourceRequest { - /// Name of the MCP server hosting the resource - pub server_name: String, - /// Resource URI (typically ui://...) - pub uri: String, +pub struct ExecuteCommandParams { + /// Argument string to pass to the command (empty string if none). + pub args: String, + /// Name of the slash command to invoke (without the leading '/'). + pub command_name: String, } -/// Schema for the `McpAppsResourceContent` type. +/// Error message produced while executing the command, if any. /// ///
    /// @@ -3008,24 +3661,13 @@ pub struct McpAppsReadResourceRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsResourceContent { - /// Resource-level metadata (CSP, permissions, etc.) - #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] - pub meta: Option>, - /// Base64-encoded binary content - #[serde(skip_serializing_if = "Option::is_none")] - pub blob: Option, - /// MIME type of the content +pub struct ExecuteCommandResult { + /// Error message produced while executing the command, if any. Omitted when the handler succeeded. #[serde(skip_serializing_if = "Option::is_none")] - pub mime_type: Option, - /// Text content (e.g. HTML) - #[serde(skip_serializing_if = "Option::is_none")] - pub text: Option, - /// The resource URI (typically ui://...) - pub uri: String, + pub error: Option, } -/// Resource contents returned by the MCP server. +/// Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID. /// ///
    /// @@ -3035,12 +3677,21 @@ pub struct McpAppsResourceContent { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsReadResourceResult { - /// Resource contents returned by the server - pub contents: Vec, +pub struct Extension { + /// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') + pub id: String, + /// Extension name (directory name) + pub name: String, + /// Process ID if the extension is running + #[serde(skip_serializing_if = "Option::is_none")] + pub pid: Option, + /// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) + pub source: ExtensionSource, + /// Current status: running, disabled, failed, or starting + pub status: ExtensionStatus, } -/// Host context advertised to MCP App guests +/// Slim input shape for extension_context attachments; identity fields are runtime-derived. /// ///
    /// @@ -3050,31 +3701,16 @@ pub struct McpAppsReadResourceResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsSetHostContextDetails { - /// Display modes the host supports - #[serde(skip_serializing_if = "Option::is_none")] - pub available_display_modes: Option>, - /// Current display mode (SEP-1865) - #[serde(skip_serializing_if = "Option::is_none")] - pub display_mode: Option, - /// BCP-47 locale, e.g. 'en-US' - #[serde(skip_serializing_if = "Option::is_none")] - pub locale: Option, - /// Platform type for responsive design - #[serde(skip_serializing_if = "Option::is_none")] - pub platform: Option, - /// UI theme preference per SEP-1865 - #[serde(skip_serializing_if = "Option::is_none")] - pub theme: Option, - /// IANA timezone, e.g. 'America/New_York' - #[serde(skip_serializing_if = "Option::is_none")] - pub time_zone: Option, - /// Host application identifier - #[serde(skip_serializing_if = "Option::is_none")] - pub user_agent: Option, +pub struct ExtensionContextPushInput { + /// Caller-supplied JSON payload (required, may be null but not undefined) + pub payload: serde_json::Value, + /// Human-readable composer pill label + pub title: String, + /// Attachment type discriminator + pub r#type: ExtensionContextPushInputType, } -/// Host context to advertise to MCP App guests. +/// Opaque integrator-owned process launch profile for one extension entrypoint. /// ///
    /// @@ -3084,12 +3720,16 @@ pub struct McpAppsSetHostContextDetails { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpAppsSetHostContextRequest { - /// Host context advertised to MCP App guests - pub context: McpAppsSetHostContextDetails, +pub struct ExtensionLaunchProfile { + /// Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint. + pub args: Vec, + /// Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence. + pub env: HashMap, + /// Executable used to launch the extension entrypoint. + pub executable: String, } -/// The requestId previously passed to executeSampling that should be cancelled. +/// A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile. /// ///
    /// @@ -3099,12 +3739,18 @@ pub struct McpAppsSetHostContextRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpCancelSamplingExecutionParams { - /// The requestId previously passed to executeSampling that should be cancelled - pub request_id: RequestId, +pub struct ExtensionLaunchProviderResolveRequest { + /// Source-qualified extension identifier. + pub id: String, + /// Absolute path to the discovered extension entrypoint. + pub module_path: String, + /// Human-readable extension name. + pub name: String, + /// Discovery source for the extension entrypoint. + pub source: ExtensionSource, } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint. /// ///
    /// @@ -3114,64 +3760,13 @@ pub struct McpCancelSamplingExecutionParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpCancelSamplingExecutionResult { - /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). - pub cancelled: bool, -} - -/// MCP server name and configuration to add to user configuration. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigAddRequest { - /// MCP server configuration (stdio process or remote HTTP/SSE) - pub config: serde_json::Value, - /// Unique name for the MCP server - pub name: String, -} - -/// MCP server names to disable for new sessions. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigDisableRequest { - /// 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. - pub names: Vec, -} - -/// MCP server names to enable for new sessions. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigEnableRequest { - /// 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. - pub names: Vec, -} - -/// User-configured MCP servers, keyed by server name. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigList { - /// All MCP servers from user config, keyed by name - pub servers: HashMap, -} - -/// MCP server name to remove from user configuration. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigRemoveRequest { - /// Name of the MCP server to remove - pub name: String, -} - -/// MCP server name and replacement configuration to write to user configuration. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigUpdateRequest { - /// MCP server configuration (stdio process or remote HTTP/SSE) - pub config: serde_json::Value, - /// Name of the MCP server to update - pub name: String, +pub struct ExtensionLaunchProviderResolveResult { + /// Opaque launch profile, omitted when this provider does not support the entrypoint. + #[serde(skip_serializing_if = "Option::is_none")] + pub launch: Option, } -/// Name of the MCP server to disable for the session. +/// Extensions discovered for the session, with their current status. /// ///
    /// @@ -3181,29 +3776,12 @@ pub struct McpConfigUpdateRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpDisableRequest { - /// Name of the MCP server to disable - pub server_name: String, -} - -/// Optional working directory used as context for MCP server discovery. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpDiscoverRequest { - /// Working directory used as context for discovery (e.g., plugin resolution) - #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, -} - -/// MCP servers discovered from user, workspace, plugin, and built-in sources. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpDiscoverResult { - /// MCP servers discovered from all sources - pub servers: Vec, +pub struct ExtensionList { + /// Discovered extensions and their current status + pub extensions: Vec, } -/// Name of the MCP server to enable for the session. +/// Source-qualified extension identifier to disable for the session. /// ///
    /// @@ -3213,12 +3791,12 @@ pub struct McpDiscoverResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpEnableRequest { - /// Name of the MCP server to enable - pub server_name: String, +pub struct ExtensionsDisableRequest { + /// Source-qualified extension ID to disable + pub id: String, } -/// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. +/// Source-qualified extension identifier to enable for the session. /// ///
    /// @@ -3228,9 +3806,12 @@ pub struct McpEnableRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpExecuteSamplingRequest {} +pub struct ExtensionsEnableRequest { + /// Source-qualified extension ID to enable + pub id: String, +} -/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. +/// Binary result returned by a tool for the model /// ///
    /// @@ -3240,18 +3821,22 @@ pub struct McpExecuteSamplingRequest {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpExecuteSamplingParams { - /// The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). - pub mcp_request_id: serde_json::Value, - /// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. - pub request: McpExecuteSamplingRequest, - /// Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. - pub request_id: RequestId, - /// Name of the MCP server that initiated the sampling request - pub server_name: String, +pub struct ExternalToolTextResultForLlmBinaryResultsForLlm { + /// Base64-encoded binary data + pub data: String, + /// Human-readable description of the binary data + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Optional metadata from the producing tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option>, + /// MIME type of the binary data + pub mime_type: String, + /// Binary result type discriminator. Use "image" for images and "resource" for other binary data. + pub r#type: ExternalToolTextResultForLlmBinaryResultsForLlmType, } -/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. +/// Expanded external tool result payload /// ///
    /// @@ -3261,21 +3846,33 @@ pub struct McpExecuteSamplingParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpOauthLoginRequest { - /// 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. +pub struct ExternalToolTextResultForLlm { + /// Base64-encoded binary results returned to the model #[serde(skip_serializing_if = "Option::is_none")] - pub callback_success_message: Option, - /// 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. + pub binary_results_for_llm: Option>, + /// Structured content blocks from the tool #[serde(skip_serializing_if = "Option::is_none")] - pub client_name: Option, - /// 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. + pub contents: Option>, + /// Optional error message for failed executions #[serde(skip_serializing_if = "Option::is_none")] - pub force_reauth: Option, - /// Name of the remote MCP server to authenticate - pub server_name: String, + pub error: Option, + /// Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized. + #[serde(skip_serializing_if = "Option::is_none")] + pub result_type: Option, + /// Detailed log content for timeline display + #[serde(skip_serializing_if = "Option::is_none")] + pub session_log: Option, + /// Text result returned to the model + pub text_result_for_llm: String, + /// Tool references returned by a tool-search override: names of deferred tools to surface to the model. When set, the tool result is materialized as `tool_reference` content blocks (rather than plain text) so the model knows which deferred tools are now available. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_references: Option>, + /// Optional tool-specific telemetry + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_telemetry: Option>, } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Audio content block with base64-encoded data /// ///
    /// @@ -3285,13 +3882,16 @@ pub struct McpOauthLoginRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpOauthLoginResult { - /// 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub authorization_url: Option, +pub struct ExternalToolTextResultForLlmContentAudio { + /// Base64-encoded audio data + pub data: String, + /// MIME type of the audio (e.g., audio/wav, audio/mpeg) + pub mime_type: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentAudioType, } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// Image content block with base64-encoded data /// ///
    /// @@ -3301,12 +3901,16 @@ pub struct McpOauthLoginResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpRemoveGitHubResult { - /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). - pub removed: bool, +pub struct ExternalToolTextResultForLlmContentImage { + /// Base64-encoded image data + pub data: String, + /// MIME type of the image (e.g., image/png, image/jpeg) + pub mime_type: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentImageType, } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// Embedded resource content block with inline text or binary data /// ///
    /// @@ -3316,18 +3920,14 @@ pub struct McpRemoveGitHubResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpSamplingExecutionResult { - /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. - pub action: McpSamplingExecutionAction, - /// Error description, present when action='failure'. - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. - #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, +pub struct ExternalToolTextResultForLlmContentResource { + /// The embedded resource contents, either text or base64-encoded binary + pub resource: serde_json::Value, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentResourceType, } -/// Schema for the `McpServer` type. +/// Icon image for a resource /// ///
    /// @@ -3337,105 +3937,55 @@ pub struct McpSamplingExecutionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServer { - /// Error message if the server failed to connect +pub struct ExternalToolTextResultForLlmContentResourceLinkIcon { + /// MIME type of the icon image #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Server name (config key) - pub name: String, - /// Configuration source: user, workspace, plugin, or builtin - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured - pub status: McpServerStatus, -} - -/// Authentication settings with optional redirect port configuration. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpServerAuthConfigRedirectPort { - /// Fixed port for the OAuth redirect callback server. - #[serde(skip_serializing_if = "Option::is_none")] - pub redirect_port: Option, -} - -/// Remote MCP server configuration accessed over HTTP or SSE. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpServerConfigHttp { - /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - #[serde(skip_serializing_if = "Option::is_none")] - pub auth: Option, - /// Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. - #[serde(skip_serializing_if = "Option::is_none")] - pub filter_mapping: Option, - /// HTTP headers to include in requests to the remote MCP server. - #[serde(skip_serializing_if = "Option::is_none")] - pub headers: Option>, - /// Whether this server is a built-in fallback used when the user has not configured their own server. - #[serde(skip_serializing_if = "Option::is_none")] - pub is_default_server: Option, - /// OAuth client ID for a pre-registered remote MCP OAuth client. - #[serde(skip_serializing_if = "Option::is_none")] - pub oauth_client_id: Option, - /// OAuth grant type to use when authenticating to the remote MCP server. - #[serde(skip_serializing_if = "Option::is_none")] - pub oauth_grant_type: Option, - /// Whether the configured OAuth client is public and does not require a client secret. - #[serde(skip_serializing_if = "Option::is_none")] - pub oauth_public_client: Option, - /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - #[serde(skip_serializing_if = "Option::is_none")] - pub oidc: Option, - /// Timeout in milliseconds for tool calls to this server. - #[serde(skip_serializing_if = "Option::is_none")] - pub timeout: Option, - /// Tools to include. Defaults to all tools if not specified. + pub mime_type: Option, + /// Available icon sizes (e.g., ['16x16', '32x32']) #[serde(skip_serializing_if = "Option::is_none")] - pub tools: Option>, - /// Remote transport type. Defaults to "http" when omitted. + pub sizes: Option>, + /// URL or path to the icon image + pub src: String, + /// Theme variant this icon is intended for #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, - /// URL of the remote MCP server endpoint. - pub url: String, + pub theme: Option, } -/// Stdio MCP server configuration launched as a child process. +/// Resource link content block referencing an external resource +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServerConfigStdio { - /// Command-line arguments passed to the Stdio MCP server process. - #[serde(skip_serializing_if = "Option::is_none")] - pub args: Option>, - /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. - #[serde(skip_serializing_if = "Option::is_none")] - pub auth: Option, - /// Executable command used to start the Stdio MCP server process. - pub command: String, - /// Working directory for the Stdio MCP server process. - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Environment variables to pass to the Stdio MCP server process. - #[serde(skip_serializing_if = "Option::is_none")] - pub env: Option>, - /// Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. +pub struct ExternalToolTextResultForLlmContentResourceLink { + /// Human-readable description of the resource #[serde(skip_serializing_if = "Option::is_none")] - pub filter_mapping: Option, - /// Whether this server is a built-in fallback used when the user has not configured their own server. + pub description: Option, + /// Icons associated with this resource #[serde(skip_serializing_if = "Option::is_none")] - pub is_default_server: Option, - /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. + pub icons: Option>, + /// MIME type of the resource content #[serde(skip_serializing_if = "Option::is_none")] - pub oidc: Option, - /// Timeout in milliseconds for tool calls to this server. + pub mime_type: Option, + /// Resource name identifier + pub name: String, + /// Size of the resource in bytes #[serde(skip_serializing_if = "Option::is_none")] - pub timeout: Option, - /// Tools to include. Defaults to all tools if not specified. + pub size: Option, + /// Human-readable display title for the resource #[serde(skip_serializing_if = "Option::is_none")] - pub tools: Option>, + pub title: Option, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentResourceLinkType, + /// URI identifying the resource + pub uri: String, } -/// MCP servers configured for the session, with their connection status. +/// Shell command exit metadata with optional output preview /// ///
    /// @@ -3445,12 +3995,25 @@ pub struct McpServerConfigStdio { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpServerList { - /// Configured MCP servers - pub servers: Vec, +pub struct ExternalToolTextResultForLlmContentShellExit { + /// Working directory where the shell command was executed + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Exit code from the completed shell command + pub exit_code: i64, + /// Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_preview: Option, + /// Whether outputPreview is known to be incomplete or truncated + #[serde(skip_serializing_if = "Option::is_none")] + pub output_truncated: Option, + /// Shell id, as assigned by Copilot runtime + pub shell_id: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentShellExitType, } -/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +/// Terminal/shell output content block with optional exit code and working directory /// ///
    /// @@ -3460,12 +4023,20 @@ pub struct McpServerList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpSetEnvValueModeParams { - /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". - pub mode: McpSetEnvValueModeDetails, +pub struct ExternalToolTextResultForLlmContentTerminal { + /// Working directory where the command was executed + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Process exit code, if the command has completed + #[serde(skip_serializing_if = "Option::is_none")] + pub exit_code: Option, + /// Terminal/shell output text + pub text: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentTerminalType, } -/// Env-value mode recorded on the session after the update. +/// Plain text content block /// ///
    /// @@ -3475,12 +4046,14 @@ pub struct McpSetEnvValueModeParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct McpSetEnvValueModeResult { - /// Mode recorded on the session after the update - pub mode: McpSetEnvValueModeDetails, +pub struct ExternalToolTextResultForLlmContentText { + /// The text content + pub text: String, + /// Content block type discriminator + pub r#type: ExternalToolTextResultForLlmContentTextType, } -/// Model identifier and token limits used to compute the context-info breakdown. +/// Parameters for cooperatively aborting a factory body. /// ///
    /// @@ -3490,43 +4063,14 @@ pub struct McpSetEnvValueModeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataContextInfoRequest { - /// Maximum output tokens allowed by the target model. Pass 0 if unknown. - pub output_token_limit: i64, - /// Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. - pub prompt_token_limit: i64, - /// Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. - #[serde(skip_serializing_if = "Option::is_none")] - pub selected_model: Option, -} - -/// Token-usage breakdown for the session's current context window -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct MetadataContextInfoResultContextInfo { - /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) - pub buffer_tokens: i64, - /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) - pub compaction_threshold: i64, - /// Tokens consumed by user/assistant/tool messages - pub conversation_tokens: i64, - /// Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. - pub limit: i64, - /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) - pub mcp_tools_tokens: i64, - /// The model used for token counting - pub model_name: String, - /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) - pub prompt_token_limit: i64, - /// Tokens consumed by the system prompt - pub system_tokens: i64, - /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) - pub tool_definitions_tokens: i64, - /// Sum of system, conversation and tool-definition tokens - pub total_tokens: i64, +pub struct FactoryAbortRequest { + /// Target session identifier + pub session_id: SessionId, + /// Factory run identifier. + pub run_id: String, } -/// Token breakdown for the session's current context window, or null if uninitialized. +/// Acknowledgement that a factory request was accepted. /// ///
    /// @@ -3536,12 +4080,9 @@ pub struct MetadataContextInfoResultContextInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataContextInfoResult { - /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). - pub context_info: Option, -} +pub struct FactoryAckResult {} -/// Indicates whether the local session is currently processing a turn or background continuation. +/// Options for one factory-scoped subagent call. /// ///
    /// @@ -3551,12 +4092,28 @@ pub struct MetadataContextInfoResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataIsProcessingResult { - /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. - pub processing: bool, +pub struct FactoryAgentOptions { + /// Optional custom agent name for the subagent. This field is accepted but not yet honored. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent: Option, + /// Optional context tier for the subagent. This field is accepted but not yet honored. + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Optional label distinguishing otherwise identical memoized agent calls. + #[serde(skip_serializing_if = "Option::is_none")] + pub label: Option, + /// Optional model identifier for the subagent. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Optional reasoning effort for the subagent. This field is accepted but not yet honored. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Optional JSON Schema for structured agent output. + #[serde(skip_serializing_if = "Option::is_none")] + pub schema: Option, } -/// Model identifier to use when re-tokenizing the session's existing messages. +/// Parameters for one factory-scoped subagent call. /// ///
    /// @@ -3566,12 +4123,18 @@ pub struct MetadataIsProcessingResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataRecomputeContextTokensRequest { - /// Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. - pub model_id: String, +pub struct FactoryAgentRequest { + /// Opaque token identifying the current factory execution attempt. + pub execution_token: String, + /// Factory run identifier that owns the subagent. + pub factory_run_id: String, + /// Subagent execution options. + pub opts: FactoryAgentOptions, + /// Prompt to send to the subagent. + pub prompt: String, } -/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. +/// Result of one factory-scoped subagent call. /// ///
    /// @@ -3581,16 +4144,13 @@ pub struct MetadataRecomputeContextTokensRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataRecomputeContextTokensResult { - /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). - pub messages_token_count: i64, - /// Tokens contributed by system/developer prompt snapshots. - pub system_token_count: i64, - /// Sum of tokens across chat-context and system-context messages currently held by the session. - pub total_tokens: i64, +pub struct FactoryAgentResult { + /// Agent result, omitted when the agent produced no result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, } -/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. +/// Prompt-safe durable identity and live status for a direct factory agent. /// ///
    /// @@ -3600,33 +4160,28 @@ pub struct MetadataRecomputeContextTokensResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkingDirectoryContext { - /// Merge-base commit SHA (fork point from the remote default branch) - #[serde(skip_serializing_if = "Option::is_none")] - pub base_commit: Option, - /// Current git branch name - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// Current working directory path - pub cwd: String, - /// Root directory of the git repository, resolved via git rev-parse +pub struct FactoryAgentSummary { + pub active_ms: i64, #[serde(skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Head commit of the current git branch + pub activity: Option, + pub agent_id: String, + pub agent_type: String, #[serde(skip_serializing_if = "Option::is_none")] - pub head_commit: Option, - /// Hosting platform type of the repository + pub completed_at: Option, + pub label: String, + pub phase_id: Option, #[serde(skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) + pub requested_model: Option, #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - /// Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + pub resolved_model: Option, + pub run_id: String, #[serde(skip_serializing_if = "Option::is_none")] - pub repository_host: Option, + pub started_at: Option, + pub status: String, + pub tool_call_id: String, } -/// Updated working-directory/git context to record on the session. +/// Parameters for cancelling a factory run. /// ///
    /// @@ -3636,12 +4191,12 @@ pub struct SessionWorkingDirectoryContext { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataRecordContextChangeRequest { - /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. - pub context: SessionWorkingDirectoryContext, +pub struct FactoryCancelRequest { + /// Factory run identifier. + pub run_id: String, } -/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). +/// Current factory phase identity. /// ///
    /// @@ -3651,9 +4206,12 @@ pub struct MetadataRecordContextChangeRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataRecordContextChangeResult {} +pub struct FactoryCurrentPhase { + pub id: String, + pub ordinal: Option, +} -/// Absolute path to set as the session's new working directory. +/// Declared or approved factory resource ceilings. /// ///
    /// @@ -3663,12 +4221,18 @@ pub struct MetadataRecordContextChangeResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataSetWorkingDirectoryRequest { - /// Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. - pub working_directory: String, +pub struct FactoryDeclaredLimits { + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrent_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub max_total_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_seconds: Option, } -/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. +/// Parameters sent to the owning extension to execute a factory closure. /// ///
    /// @@ -3678,12 +4242,20 @@ pub struct MetadataSetWorkingDirectoryRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataSetWorkingDirectoryResult { - /// Working directory after the update - pub working_directory: String, +pub struct FactoryExecuteRequest { + /// Target session identifier + pub session_id: SessionId, + /// Registered factory name. + pub name: String, + /// Factory run identifier. + pub run_id: String, + /// Opaque token identifying this factory execution attempt. + pub execution_token: String, + /// Factory input value. + pub args: serde_json::Value, } -/// The repository the remote session targets. +/// Result returned by an extension factory closure. /// ///
    /// @@ -3693,16 +4265,13 @@ pub struct MetadataSetWorkingDirectoryResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataSnapshotRemoteMetadataRepository { - /// The branch the remote session is operating on. - pub branch: String, - /// The GitHub repository name (without owner). - pub name: String, - /// The GitHub owner (user or organization) of the target repository. - pub owner: String, +pub struct FactoryExecuteResult { + /// Factory result value. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, } -/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. +/// Parameters for paging factory progress. /// ///
    /// @@ -3712,176 +4281,119 @@ pub struct MetadataSnapshotRemoteMetadataRepository { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct MetadataSnapshotRemoteMetadata { - /// The pull request number the remote session is associated with, if any. - #[serde(skip_serializing_if = "Option::is_none")] - pub pull_request_number: Option, - /// The repository the remote session targets. - pub repository: MetadataSnapshotRemoteMetadataRepository, - /// The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. - #[serde(skip_serializing_if = "Option::is_none")] - pub resource_id: Option, - /// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. - #[serde(skip_serializing_if = "Option::is_none")] - pub task_type: Option, -} - -/// Long context tier pricing (available for models with extended context windows) -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelBillingTokenPricesLongContext { - /// AI Credits cost per billing batch of cached tokens - #[serde(skip_serializing_if = "Option::is_none")] - pub cache_price: Option, - /// Maximum context window tokens for the long context tier - #[serde(skip_serializing_if = "Option::is_none")] - pub context_max: Option, - /// AI Credits cost per billing batch of input tokens - #[serde(skip_serializing_if = "Option::is_none")] - pub input_price: Option, - /// AI Credits cost per billing batch of output tokens - #[serde(skip_serializing_if = "Option::is_none")] - pub output_price: Option, -} - -/// Token-level pricing information for this model -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelBillingTokenPrices { - /// Number of tokens per standard billing batch - #[serde(skip_serializing_if = "Option::is_none")] - pub batch_size: Option, - /// AI Credits cost per billing batch of cached tokens +pub struct FactoryGetRunProgressRequest { + /// Exclusive forward cursor. #[serde(skip_serializing_if = "Option::is_none")] - pub cache_price: Option, - /// Maximum context window tokens for the default tier - #[serde(skip_serializing_if = "Option::is_none")] - pub context_max: Option, - /// AI Credits cost per billing batch of input tokens - #[serde(skip_serializing_if = "Option::is_none")] - pub input_price: Option, - /// Long context tier pricing (available for models with extended context windows) - #[serde(skip_serializing_if = "Option::is_none")] - pub long_context: Option, - /// AI Credits cost per billing batch of output tokens + pub after_seq: Option, + /// Exclusive backward cursor. #[serde(skip_serializing_if = "Option::is_none")] - pub output_price: Option, -} - -/// Billing information -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelBilling { - /// Billing cost multiplier relative to the base rate + pub before_seq: Option, + /// Maximum records to return. Defaults to 200 and is capped at 500. #[serde(skip_serializing_if = "Option::is_none")] - pub multiplier: Option, - /// Token-level pricing information for this model + pub limit: Option, + /// Optional phase identifier used to scope records and cursors. #[serde(skip_serializing_if = "Option::is_none")] - pub token_prices: Option, -} - -/// Vision-specific limits -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesLimitsVision { - /// Maximum image size in bytes - #[serde(rename = "max_prompt_image_size")] - pub max_prompt_image_size: i64, - /// Maximum number of images per prompt - #[serde(rename = "max_prompt_images")] - pub max_prompt_images: i64, - /// MIME types the model accepts - #[serde(rename = "supported_media_types")] - pub supported_media_types: Vec, + pub phase_id: Option, + /// Factory run identifier. + pub run_id: String, } -/// Token limits for prompts, outputs, and context window +/// Parameters for retrieving a factory run. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesLimits { - /// Maximum total context window size in tokens - #[serde( - rename = "max_context_window_tokens", - skip_serializing_if = "Option::is_none" - )] - pub max_context_window_tokens: Option, - /// Maximum number of output/completion tokens - #[serde(rename = "max_output_tokens", skip_serializing_if = "Option::is_none")] - pub max_output_tokens: Option, - /// Maximum number of prompt/input tokens - #[serde(rename = "max_prompt_tokens", skip_serializing_if = "Option::is_none")] - pub max_prompt_tokens: Option, - /// Vision-specific limits - #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, +pub struct FactoryGetRunRequest { + /// Factory run identifier. + pub run_id: String, } -/// Feature flags indicating what the model supports +/// Parameters for reading a factory journal entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesSupports { - /// Whether this model supports reasoning effort configuration - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, - /// Whether this model supports vision/image input - #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, +pub struct FactoryJournalGetRequest { + /// Opaque token identifying the current factory execution attempt. + pub execution_token: String, + /// Namespaced journal key. + pub key: String, + /// Factory run identifier. + pub run_id: String, } -/// Model capabilities and limits +/// Result of reading a factory journal entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilities { - /// Token limits for prompts, outputs, and context window - #[serde(skip_serializing_if = "Option::is_none")] - pub limits: Option, - /// Feature flags indicating what the model supports +pub struct FactoryJournalGetResult { + /// Whether the journal contained the requested key. + pub hit: bool, + /// Cached JSON result. The hit field distinguishes a cached JSON null from a miss. #[serde(skip_serializing_if = "Option::is_none")] - pub supports: Option, + pub result_json: Option, } -/// Policy state (if applicable) +/// Parameters for storing a factory journal entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelPolicy { - /// Current policy state for this model - pub state: ModelPolicyState, - /// Usage terms or conditions for this model - #[serde(skip_serializing_if = "Option::is_none")] - pub terms: Option, +pub struct FactoryJournalPutRequest { + /// Opaque token identifying the current factory execution attempt. + pub execution_token: String, + /// Namespaced journal key. + pub key: String, + /// JSON result to memoize. + pub result_json: serde_json::Value, + /// Factory run identifier. + pub run_id: String, } -/// Schema for the `Model` type. +/// Parameters for paging factory runs. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct Model { - /// Billing information +pub struct FactoryListRunsRequest { + /// Exclusive forward cursor. #[serde(skip_serializing_if = "Option::is_none")] - pub billing: Option, - /// Model capabilities and limits - pub capabilities: ModelCapabilities, - /// Default reasoning effort level (only present if model supports reasoning effort) - #[serde(skip_serializing_if = "Option::is_none")] - pub default_reasoning_effort: Option, - /// Model identifier (e.g., "claude-sonnet-4.5") - pub id: String, - /// Model capability category for grouping in the model picker - #[serde(skip_serializing_if = "Option::is_none")] - pub model_picker_category: Option, - /// Relative cost tier for token-based billing users - #[serde(skip_serializing_if = "Option::is_none")] - pub model_picker_price_category: Option, - /// Display name - pub name: String, - /// Policy state (if applicable) + pub after_seq: Option, + /// Exclusive backward cursor. #[serde(skip_serializing_if = "Option::is_none")] - pub policy: Option, - /// Supported reasoning effort levels (only present if model supports reasoning effort) + pub before_seq: Option, + /// Maximum terminal runs to return. Defaults to 200 and is capped at 500. #[serde(skip_serializing_if = "Option::is_none")] - pub supported_reasoning_efforts: Option>, + pub limit: Option, } -/// Vision-specific limits +/// Durable factory resource consumption. /// ///
    /// @@ -3891,25 +4403,13 @@ pub struct Model { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesOverrideLimitsVision { - /// Maximum image size in bytes - #[serde( - rename = "max_prompt_image_size", - skip_serializing_if = "Option::is_none" - )] - pub max_prompt_image_size: Option, - /// Maximum number of images per prompt - #[serde(rename = "max_prompt_images", skip_serializing_if = "Option::is_none")] - pub max_prompt_images: Option, - /// MIME types the model accepts - #[serde( - rename = "supported_media_types", - skip_serializing_if = "Option::is_none" - )] - pub supported_media_types: Option>, +pub struct FactoryRunConsumed { + pub active_ms: i64, + pub nano_aiu: i64, + pub subagents: i64, } -/// Token limits for prompts, outputs, and context window +/// Prompt-safe terminal factory outcome. /// ///
    /// @@ -3919,25 +4419,18 @@ pub struct ModelCapabilitiesOverrideLimitsVision { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesOverrideLimits { - /// Maximum total context window size in tokens - #[serde( - rename = "max_context_window_tokens", - skip_serializing_if = "Option::is_none" - )] - pub max_context_window_tokens: Option, - /// Maximum number of output/completion tokens - #[serde(rename = "max_output_tokens", skip_serializing_if = "Option::is_none")] - pub max_output_tokens: Option, - /// Maximum number of prompt/input tokens - #[serde(rename = "max_prompt_tokens", skip_serializing_if = "Option::is_none")] - pub max_prompt_tokens: Option, - /// Vision-specific limits +pub struct FactoryRunTerminal { #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, + pub error: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub failure: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub result_preview: Option, } -/// Feature flags indicating what the model supports +/// Durable factory run summary with read-time live overlays. /// ///
    /// @@ -3947,16 +4440,29 @@ pub struct ModelCapabilitiesOverrideLimits { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesOverrideSupports { - /// Whether this model supports reasoning effort configuration - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, - /// Whether this model supports vision/image input - #[serde(skip_serializing_if = "Option::is_none")] - pub vision: Option, +pub struct FactoryRunSummary { + pub active_segment_started_at: Option, + pub approved: Option, + pub completed_at: Option, + pub consumed: FactoryRunConsumed, + pub created_at: i64, + pub current_phase: Option, + pub declared_limits: FactoryDeclaredLimits, + pub declared_phase_count: i64, + pub description: String, + pub factory_name: String, + pub live_agent_count: i64, + pub observed_at: i64, + pub revision: i64, + pub run_id: String, + pub started_at: Option, + pub status: FactoryRunStatus, + pub terminal: Option, + pub total_spawned_agent_count: i64, + pub updated_at: i64, } -/// Override individual model capabilities resolved by the runtime +/// A page of factory runs in durable creation order. /// ///
    /// @@ -3966,24 +4472,23 @@ pub struct ModelCapabilitiesOverrideSupports { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelCapabilitiesOverride { - /// Token limits for prompts, outputs, and context window +pub struct FactoryListRunsResult { + /// Whether terminal runs newer than this page exist. #[serde(skip_serializing_if = "Option::is_none")] - pub limits: Option, - /// Feature flags indicating what the model supports + pub has_more_newer: Option, + /// Newest terminal-run cursor in this page, or null when the terminal window is empty. #[serde(skip_serializing_if = "Option::is_none")] - pub supports: Option, -} - -/// List of Copilot models available to the resolved user, including capabilities and billing metadata. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelList { - /// List of available models with full metadata - pub models: Vec, + pub newest_seq: Option, + /// Oldest terminal-run cursor in this page, or null when the terminal window is empty. + #[serde(skip_serializing_if = "Option::is_none")] + pub oldest_seq: Option, + /// Number of terminal runs older than this page. + #[serde(skip_serializing_if = "Option::is_none")] + pub omitted_older: Option, + pub runs: Vec, } -/// Optional listing options. +/// One ordered factory progress line. /// ///
    /// @@ -3993,13 +4498,16 @@ pub struct ModelList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelListRequest { - /// If true, bypasses the per-session model list cache and re-fetches from CAPI. - #[serde(skip_serializing_if = "Option::is_none")] - pub skip_cache: Option, +pub struct FactoryLogLine { + /// Progress line kind. + pub kind: FactoryLogLineKind, + /// Monotonic sequence number within the factory run. + pub seq: i64, + /// Progress text. + pub text: String, } -/// Reasoning effort level to apply to the currently selected model. +/// Parameters for recording factory progress. /// ///
    /// @@ -4009,12 +4517,16 @@ pub struct ModelListRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelSetReasoningEffortRequest { - /// Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. - pub reasoning_effort: String, +pub struct FactoryLogRequest { + /// Opaque token identifying the current factory execution attempt. + pub execution_token: String, + /// Ordered progress lines to append. + pub lines: Vec, + /// Factory run identifier. + pub run_id: String, } -/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. +/// Durable lifecycle and timing for one factory phase. /// ///
    /// @@ -4024,21 +4536,26 @@ pub struct ModelSetReasoningEffortRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelSetReasoningEffortResult { - /// Reasoning effort level recorded on the session after the update - pub reasoning_effort: String, -} - -/// Optional GitHub token used to list models for a specific user instead of the global auth context. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelsListRequest { - /// 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. +pub struct FactoryPhaseObservation { + pub accumulated_active_ms: i64, #[serde(skip_serializing_if = "Option::is_none")] - pub git_hub_token: Option, + pub completed_at: Option, + pub current_active_ms: i64, + #[serde(skip_serializing_if = "Option::is_none")] + pub detail: Option, + pub entry_count: i64, + pub id: String, + pub last_entered_run_attempt: i64, + pub live_agent_count: i64, + pub ordinal: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub started_at: Option, + pub status: FactoryPhaseStatus, + pub title: String, + pub total_agent_count: i64, } -/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. +/// One durable factory progress record. /// ///
    /// @@ -4048,24 +4565,22 @@ pub struct ModelsListRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelSwitchToRequest { - /// Explicit context tier for the selected model. `"default"` / `"long_context"` pin the tier; `null` clears any previous explicit choice; `undefined` leaves the existing tier untouched. - #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, - /// Override individual model capabilities resolved by the runtime - #[serde(skip_serializing_if = "Option::is_none")] - pub model_capabilities: Option, - /// Model identifier to switch to - pub model_id: String, - /// Reasoning effort level to use for the model. "none" disables reasoning. - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, - /// Reasoning summary mode to request for supported model clients - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_summary: Option, +pub struct FactoryProgressLine { + /// Resume attempt that emitted this record. + pub attempt: i64, + /// Progress record kind. + pub kind: FactoryLogLineKind, + /// Phase active when the record was emitted, or null before any phase. + pub phase_id: Option, + /// Epoch milliseconds when the record was persisted. + pub recorded_at: i64, + /// Global monotonic sequence number within the run. + pub seq: i64, + /// Prompt-safe progress text. + pub text: String, } -/// The model identifier active on the session after the switch. +/// A bidirectional page of factory progress. /// ///
    /// @@ -4075,13 +4590,17 @@ pub struct ModelSwitchToRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModelSwitchToResult { - /// Currently active model identifier after the switch - #[serde(skip_serializing_if = "Option::is_none")] - pub model_id: Option, +pub struct FactoryProgressPage { + pub has_more_newer: bool, + pub has_more_older: bool, + pub newest_seq: Option, + pub oldest_seq: Option, + pub records: Vec, + /// Run revision reflected by this page. + pub revision: i64, } -/// Agent interaction mode to apply to the session. +/// Wire-only per-invocation factory resource ceiling overrides. /// ///
    /// @@ -4091,12 +4610,22 @@ pub struct ModelSwitchToResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ModeSetRequest { - /// The session mode the agent is operating in - pub mode: SessionMode, +pub struct FactoryRunLimits { + /// Maximum AI credits consumed by factory subagents and their descendants. The post-paid ceiling is soft: parallel turns can settle beyond it before the run stops. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, + /// Maximum number of factory subagents that may run concurrently. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrent_subagents: Option, + /// Maximum total number of factory subagents that may be admitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_total_subagents: Option, + /// Maximum accumulated active-execution time in seconds. Active execution includes the entire extension body, subprocess waits, queued-agent waits, and sleeps; time between resumed attempts is not counted. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_seconds: Option, } -/// The session's friendly name, or null when not yet set. +/// Parameters for resuming a factory run from its persisted identity. /// ///
    /// @@ -4106,12 +4635,15 @@ pub struct ModeSetRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct NameGetResult { - /// The session name (user-set or auto-generated), or null if not yet set - pub name: Option, +pub struct FactoryResumeRequest { + /// Optional per-invocation resource ceiling overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Factory run identifier. + pub run_id: String, } -/// Auto-generated session summary to apply as the session's name when no user-set name exists. +/// Complete current or terminal factory run envelope. /// ///
    /// @@ -4121,12 +4653,29 @@ pub struct NameGetResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct NameSetAutoRequest { - /// Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. - pub summary: String, +pub struct FactoryRunResult { + /// Error message for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Machine-readable failure details for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub failure: Option, + /// Reason for a halted or cancelled run. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Completed factory result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, + /// Factory run identifier. + pub run_id: String, + /// Partial journal and progress snapshot for a halted, cancelled, or errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub snapshot: Option, + /// Current or terminal factory run status. + pub status: FactoryRunStatus, } -/// Indicates whether the auto-generated summary was applied as the session's name. +/// Resolved persisted factory identity and resumed run envelope. /// ///
    /// @@ -4136,12 +4685,14 @@ pub struct NameSetAutoRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct NameSetAutoResult { - /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. - pub applied: bool, +pub struct FactoryResumeResult { + /// Persisted factory name resolved for the resumed run. + pub factory_name: String, + /// Terminal resumed run envelope. + pub run: FactoryRunResult, } -/// New friendly name to apply to the session. +/// Full factory run observability detail. /// ///
    /// @@ -4151,12 +4702,32 @@ pub struct NameSetAutoResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct NameSetRequest { - /// New session name (1–100 characters, trimmed of leading/trailing whitespace) - pub name: String, +pub struct FactoryRunDetail { + pub active_segment_started_at: Option, + pub agents: Vec, + pub approved: Option, + pub completed_at: Option, + pub consumed: FactoryRunConsumed, + pub created_at: i64, + pub current_phase: Option, + pub declared_limits: FactoryDeclaredLimits, + pub declared_phase_count: i64, + pub description: String, + pub factory_name: String, + pub live_agent_count: i64, + pub observed_at: i64, + pub phases: Vec, + pub progress: FactoryProgressPage, + pub revision: i64, + pub run_id: String, + pub started_at: Option, + pub status: FactoryRunStatus, + pub terminal: Option, + pub total_spawned_agent_count: i64, + pub updated_at: i64, } -/// Schema for the `PendingPermissionRequest` type. +/// Options controlling factory invocation. /// ///
    /// @@ -4164,16 +4735,18 @@ pub struct NameSetRequest { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PendingPermissionRequest { - /// The user-facing permission prompt details (commands, write, read, mcp, url, memory, custom-tool, path, hook) - pub request: PermissionPromptRequest, - /// Unique identifier for the pending permission request - pub request_id: RequestId, +pub struct RunOptions { + /// Per-invocation resource ceiling overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Run identifier whose journal and progress should seed this resumed run. + #[serde(skip_serializing_if = "Option::is_none")] + pub resume_from_run_id: Option, } -/// List of pending permission requests reconstructed from event history. +/// Parameters for invoking a registered factory. /// ///
    /// @@ -4183,12 +4756,17 @@ pub struct PendingPermissionRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PendingPermissionRequestList { - /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. - pub items: Vec, +pub struct FactoryRunRequest { + /// Factory input value. + pub args: serde_json::Value, + /// Registered factory name. + pub name: String, + /// Factory invocation options. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, } -/// Schema for the `PermissionDecisionApproveOnce` type. +/// Optional user prompt to combine with the fleet orchestration instructions. /// ///
    /// @@ -4198,12 +4776,13 @@ pub struct PendingPermissionRequestList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveOnce { - /// Approve this single request only - pub kind: PermissionDecisionApproveOnceKind, +pub struct FleetStartRequest { + /// Optional user prompt to combine with fleet instructions + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt: Option, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalCommands` type. +/// Indicates whether fleet mode was successfully activated. /// ///
    /// @@ -4213,14 +4792,12 @@ pub struct PermissionDecisionApproveOnce { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalCommands { - /// Command identifiers covered by this approval. - pub command_identifiers: Vec, - /// Approval scoped to specific command identifiers. - pub kind: PermissionDecisionApproveForSessionApprovalCommandsKind, +pub struct FleetStartResult { + /// Whether fleet mode was successfully activated + pub started: bool, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalRead` type. +/// Folder path to add to trusted folders. /// ///
    /// @@ -4230,12 +4807,12 @@ pub struct PermissionDecisionApproveForSessionApprovalCommands { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalRead { - /// Approval covering read-only filesystem operations. - pub kind: PermissionDecisionApproveForSessionApprovalReadKind, +pub struct FolderTrustAddParams { + /// Folder path to mark as trusted + pub path: String, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalWrite` type. +/// Folder path to check for trust. /// ///
    /// @@ -4245,12 +4822,12 @@ pub struct PermissionDecisionApproveForSessionApprovalRead { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalWrite { - /// Approval covering filesystem write operations. - pub kind: PermissionDecisionApproveForSessionApprovalWriteKind, +pub struct FolderTrustCheckParams { + /// Folder path to check + pub path: String, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMcp` type. +/// Folder trust check result. /// ///
    /// @@ -4260,16 +4837,12 @@ pub struct PermissionDecisionApproveForSessionApprovalWrite { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalMcp { - /// Approval covering an MCP tool. - pub kind: PermissionDecisionApproveForSessionApprovalMcpKind, - /// MCP server name. - pub server_name: String, - /// MCP tool name, or null to cover every tool on the server. - pub tool_name: Option, +pub struct FolderTrustCheckResult { + /// Whether the folder is trusted + pub trusted: bool, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMcpSampling` type. +/// Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value. /// ///
    /// @@ -4279,14 +4852,21 @@ pub struct PermissionDecisionApproveForSessionApprovalMcp { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalMcpSampling { - /// Approval covering MCP sampling requests for a server. - pub kind: PermissionDecisionApproveForSessionApprovalMcpSamplingKind, - /// MCP server name. - pub server_name: String, +pub struct GhCliAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Authentication host. + pub host: String, + /// User login as reported by `gh auth status`. + pub login: String, + /// The token returned by `gh auth token`. Treat as a secret. + pub token: String, + /// Authentication via the `gh` CLI's saved credentials. + pub r#type: GhCliAuthInfoType, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalMemory` type. +/// Client environment metadata describing the process that produced a telemetry event. /// ///
    /// @@ -4296,12 +4876,40 @@ pub struct PermissionDecisionApproveForSessionApprovalMcpSampling { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalMemory { - /// Approval covering writes to long-term memory. - pub kind: PermissionDecisionApproveForSessionApprovalMemoryKind, +pub struct GitHubTelemetryClientInfo { + /// Copilot CLI version string. + #[serde(rename = "cli_version")] + pub cli_version: String, + /// Name of the client application. + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Type of client. + #[serde(rename = "client_type", skip_serializing_if = "Option::is_none")] + pub client_type: Option, + /// Copilot subscription plan, when known. + #[serde(rename = "copilot_plan", skip_serializing_if = "Option::is_none")] + pub copilot_plan: Option, + /// Stable machine identifier for the device. + #[serde(rename = "dev_device_id", skip_serializing_if = "Option::is_none")] + pub dev_device_id: Option, + /// Whether the user is a GitHub/Microsoft staff member. + #[serde(rename = "is_staff", skip_serializing_if = "Option::is_none")] + pub is_staff: Option, + /// Node.js runtime version string. + #[serde(rename = "node_version")] + pub node_version: String, + /// Operating system architecture (e.g. arm64, x64). + #[serde(rename = "os_arch")] + pub os_arch: String, + /// Operating system platform (e.g. darwin, linux, win32). + #[serde(rename = "os_platform")] + pub os_platform: String, + /// Operating system version string. + #[serde(rename = "os_version")] + pub os_version: String, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalCustomTool` type. +/// A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts. The `restricted` flag on the enclosing GitHubTelemetryNotification distinguishes standard from restricted events; the payload shape is identical for both. /// ///
    /// @@ -4311,14 +4919,43 @@ pub struct PermissionDecisionApproveForSessionApprovalMemory { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalCustomTool { - /// Approval covering a custom tool. - pub kind: PermissionDecisionApproveForSessionApprovalCustomToolKind, - /// Custom tool name. - pub tool_name: String, +pub struct GitHubTelemetryEvent { + /// Client environment metadata. + #[serde(skip_serializing_if = "Option::is_none")] + pub client: Option, + /// Copilot tracking ID for user-level attribution. + #[serde( + rename = "copilot_tracking_id", + skip_serializing_if = "Option::is_none" + )] + pub copilot_tracking_id: Option, + /// Timestamp when the event was created (ISO 8601 format). + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Experiment assignment context. + #[serde( + rename = "exp_assignment_context", + skip_serializing_if = "Option::is_none" + )] + pub exp_assignment_context: Option, + /// Feature flags enabled for this session, as a map from flag to value. + #[serde(skip_serializing_if = "Option::is_none")] + pub features: Option>, + /// Event type/kind (e.g. get_completion_with_tools_turn, tool_call_executed). + pub kind: String, + /// Numeric metrics as a map from key to value. + pub metrics: HashMap, + /// Reference to the model call that produced this event. + #[serde(rename = "model_call_id", skip_serializing_if = "Option::is_none")] + pub model_call_id: Option, + /// String-valued properties as a map from key to value. + pub properties: HashMap, + /// Session identifier the event belongs to. + #[serde(rename = "session_id", skip_serializing_if = "Option::is_none")] + pub session_id: Option, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionManagement` type. +/// Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake. /// ///
    /// @@ -4328,15 +4965,17 @@ pub struct PermissionDecisionApproveForSessionApprovalCustomTool { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalExtensionManagement { - /// Approval covering extension lifecycle operations such as enable, disable, or reload. - pub kind: PermissionDecisionApproveForSessionApprovalExtensionManagementKind, - /// Optional operation identifier; when omitted, the approval covers all extension management operations. +pub struct GitHubTelemetryNotification { + /// The telemetry event, in the runtime's native GitHub-shaped telemetry format. + pub event: GitHubTelemetryEvent, + /// Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only. + pub restricted: bool, + /// Session the telemetry event belongs to, when it is session-scoped. Omitted for sessionless events (for example, `server.sendTelemetry` calls with no session id), which are still forwarded to opted-in connections. #[serde(skip_serializing_if = "Option::is_none")] - pub operation: Option, + pub session_id: Option, } -/// Schema for the `PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess` type. +/// Pending external tool call request ID, with the tool result or an error describing why it failed. /// ///
    /// @@ -4346,14 +4985,18 @@ pub struct PermissionDecisionApproveForSessionApprovalExtensionManagement { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { - /// Extension name. - pub extension_name: String, - /// Approval covering an extension's request to access a permission-gated capability. - pub kind: PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKind, +pub struct HandlePendingToolCallRequest { + /// Error message if the tool call failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Request ID of the pending tool call + pub request_id: RequestId, + /// Tool call result (string or expanded result object) + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, } -/// Schema for the `PermissionDecisionApproveForSession` type. +/// Indicates whether the external tool call result was handled successfully. /// ///
    /// @@ -4363,18 +5006,12 @@ pub struct PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForSession { - /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) - #[serde(skip_serializing_if = "Option::is_none")] - pub approval: Option, - /// URL domain to approve for the rest of the session (URL prompts only) - #[serde(skip_serializing_if = "Option::is_none")] - pub domain: Option, - /// Approve and remember for the rest of the session - pub kind: PermissionDecisionApproveForSessionKind, +pub struct HandlePendingToolCallResult { + /// Whether the tool call result was handled successfully + pub success: bool, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalCommands` type. +/// Indicates whether an in-progress manual compaction was aborted. /// ///
    /// @@ -4384,14 +5021,12 @@ pub struct PermissionDecisionApproveForSession { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalCommands { - /// Command identifiers covered by this approval. - pub command_identifiers: Vec, - /// Approval scoped to specific command identifiers. - pub kind: PermissionDecisionApproveForLocationApprovalCommandsKind, +pub struct HistoryAbortManualCompactionResult { + /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. + pub aborted: bool, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalRead` type. +/// Indicates whether an in-progress background compaction was cancelled. /// ///
    /// @@ -4401,12 +5036,12 @@ pub struct PermissionDecisionApproveForLocationApprovalCommands { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalRead { - /// Approval covering read-only filesystem operations. - pub kind: PermissionDecisionApproveForLocationApprovalReadKind, +pub struct HistoryCancelBackgroundCompactionResult { + /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. + pub cancelled: bool, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalWrite` type. +/// Parameters for clearing the conversation and seeding the window that replaces it. /// ///
    /// @@ -4416,12 +5051,12 @@ pub struct PermissionDecisionApproveForLocationApprovalRead { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalWrite { - /// Approval covering filesystem write operations. - pub kind: PermissionDecisionApproveForLocationApprovalWriteKind, +pub struct HistoryClearContextRequest { + /// First user message of the fresh context window. Required: a cleared window holding only system and developer messages is not a conversation a model can answer, so every clear seeds the window it creates. Delivered by the enclosing turn driver once the agentic loop exits, which is why the call must be made from inside a tool handler. + pub prompt: String, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMcp` type. +/// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. /// ///
    /// @@ -4431,16 +5066,12 @@ pub struct PermissionDecisionApproveForLocationApprovalWrite { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalMcp { - /// Approval covering an MCP tool. - pub kind: PermissionDecisionApproveForLocationApprovalMcpKind, - /// MCP server name. - pub server_name: String, - /// MCP tool name, or null to cover every tool on the server. - pub tool_name: Option, +pub struct HistoryClearContextResult { + /// Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. + pub messages_cleared: i64, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMcpSampling` type. +/// Post-compaction context window usage breakdown /// ///
    /// @@ -4450,14 +5081,25 @@ pub struct PermissionDecisionApproveForLocationApprovalMcp { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalMcpSampling { - /// Approval covering MCP sampling requests for a server. - pub kind: PermissionDecisionApproveForLocationApprovalMcpSamplingKind, - /// MCP server name. - pub server_name: String, +pub struct HistoryCompactContextWindow { + /// Token count from non-system messages (user, assistant, tool) + #[serde(skip_serializing_if = "Option::is_none")] + pub conversation_tokens: Option, + /// Current total tokens in the context window (system + conversation + tool definitions) + pub current_tokens: i64, + /// Current number of messages in the conversation + pub messages_length: i64, + /// Token count from system message(s) + #[serde(skip_serializing_if = "Option::is_none")] + pub system_tokens: Option, + /// Maximum token count for the model's context window + pub token_limit: i64, + /// Token count from tool definitions + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_definitions_tokens: Option, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalMemory` type. +/// Optional compaction parameters. /// ///
    /// @@ -4467,12 +5109,19 @@ pub struct PermissionDecisionApproveForLocationApprovalMcpSampling { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalMemory { - /// Approval covering writes to long-term memory. - pub kind: PermissionDecisionApproveForLocationApprovalMemoryKind, +pub struct HistoryCompactRequest { + /// Optional user-provided instructions to focus the compaction summary + #[serde(skip_serializing_if = "Option::is_none")] + pub custom_instructions: Option, + /// Context window token limit this compaction is targeting, recorded as the `tokenLimit` on the persisted `session.compaction_start` / `session.compaction_complete` events. Set it when the compaction targets a window other than the compacting model's own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model's own resolved limit. Attribution metadata only - it does not change how much the compaction removes. + #[serde(skip_serializing_if = "Option::is_none")] + pub token_limit: Option, + /// What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). + #[serde(skip_serializing_if = "Option::is_none")] + pub trigger: Option, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalCustomTool` type. +/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. /// ///
    /// @@ -4482,14 +5131,22 @@ pub struct PermissionDecisionApproveForLocationApprovalMemory { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalCustomTool { - /// Approval covering a custom tool. - pub kind: PermissionDecisionApproveForLocationApprovalCustomToolKind, - /// Custom tool name. - pub tool_name: String, +pub struct HistoryCompactResult { + /// Post-compaction context window usage breakdown + #[serde(skip_serializing_if = "Option::is_none")] + pub context_window: Option, + /// Number of messages removed during compaction + pub messages_removed: i64, + /// Whether compaction completed successfully + pub success: bool, + /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + #[serde(skip_serializing_if = "Option::is_none")] + pub summary_content: Option, + /// Number of tokens freed by compaction + pub tokens_removed: i64, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionManagement` type. +/// A root user turn that the session can rewind to. /// ///
    /// @@ -4499,15 +5156,28 @@ pub struct PermissionDecisionApproveForLocationApprovalCustomTool { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalExtensionManagement { - /// Approval covering extension lifecycle operations such as enable, disable, or reload. - pub kind: PermissionDecisionApproveForLocationApprovalExtensionManagementKind, - /// Optional operation identifier; when omitted, the approval covers all extension management operations. - #[serde(skip_serializing_if = "Option::is_none")] - pub operation: Option, +pub struct HistoryRewindPoint { + /// Whether at least one file in this turn or a later turn can be restored. + pub can_restore_files: bool, + /// ID of the user.message event that begins the discarded suffix. + pub event_id: String, + /// Number of unique files in this turn and all later turns that have captured changes. + pub file_count: i64, + /// Whether this turn was an automatically injected autopilot continuation. + pub is_autopilot_continuation: bool, + /// Lines added by this turn's captured file changes. + pub lines_added: i64, + /// Lines removed by this turn's captured file changes. + pub lines_removed: i64, + /// ISO timestamp of the user turn. + pub timestamp: String, + /// Whether this turn itself captured any file changes. + pub turn_changed_files: bool, + /// User-visible message text for the turn. + pub user_message: String, } -/// Schema for the `PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess` type. +/// Rewind points and file-change-tracking availability for the session. /// ///
    /// @@ -4517,14 +5187,17 @@ pub struct PermissionDecisionApproveForLocationApprovalExtensionManagement { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { - /// Extension name. - pub extension_name: String, - /// Approval covering an extension's request to access a permission-gated capability. - pub kind: PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind, +pub struct HistoryListRewindPointsResult { + /// Whether this session captured file changes from its first turn. + pub file_change_tracking_enabled: bool, + /// Root user turns in chronological order. Empty when `unavailableReason` is set. + pub points: Vec, + /// Why the listed points could not be produced, when applicable; the points list is empty whenever it is set. `unsupported-remote-session` is permanent for the session and comes with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the file-change captures cannot be read while work that may still mutate them is in flight; the same request succeeds once the session settles, so a client that wants points should retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an untracked local session still lists conversation-only points and reports that through `fileChangeTrackingEnabled: false`. + #[serde(skip_serializing_if = "Option::is_none")] + pub unavailable_reason: Option, } -/// Schema for the `PermissionDecisionApproveForLocation` type. +/// Event boundary to preview for conversation-and-files rewind. /// ///
    /// @@ -4532,18 +5205,14 @@ pub struct PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproveForLocation { - /// Approval to persist for this location - pub approval: PermissionDecisionApproveForLocationApproval, - /// Approve and persist for this project location - pub kind: PermissionDecisionApproveForLocationKind, - /// Location key (git root or cwd) to persist the approval to - pub location_key: String, +pub struct HistoryPreviewRewindRequest { + /// ID of the user.message event that begins the discarded suffix. + pub event_id: String, } -/// Schema for the `PermissionDecisionApprovePermanently` type. +/// A file that a conversation-and-files rewind would restore. /// ///
    /// @@ -4553,14 +5222,18 @@ pub struct PermissionDecisionApproveForLocation { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApprovePermanently { - /// URL domain to approve permanently - pub domain: String, - /// Approve and persist across sessions (URL prompts only) - pub kind: PermissionDecisionApprovePermanentlyKind, +pub struct HistoryRewindFilePreview { + /// Aggregate change made across the discarded turns. + pub change_type: HistoryRewindChangeType, + /// Lines added across the discarded turns. + pub lines_added: i64, + /// Lines removed across the discarded turns. + pub lines_removed: i64, + /// Absolute path of the captured file. + pub path: String, } -/// Schema for the `PermissionDecisionReject` type. +/// Files and aggregate changes for a prospective rewind. /// ///
    /// @@ -4570,15 +5243,19 @@ pub struct PermissionDecisionApprovePermanently { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionReject { - /// Optional feedback explaining the rejection +pub struct HistoryPreviewRewindResult { + /// Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. + pub available: bool, + /// Number of unique files in the preview. + pub file_count: i64, + /// Files ordered by path. + pub files: Vec, + /// Why file restore is unavailable, when applicable. Populated only when `available` is false and never set when `available` is true. #[serde(skip_serializing_if = "Option::is_none")] - pub feedback: Option, - /// Reject the request - pub kind: PermissionDecisionRejectKind, + pub reason: Option, } -/// Schema for the `PermissionDecisionUserNotAvailable` type. +/// Boundary and mode for rewinding session history. /// ///
    /// @@ -4588,12 +5265,14 @@ pub struct PermissionDecisionReject { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionUserNotAvailable { - /// No user is available to confirm the request - pub kind: PermissionDecisionUserNotAvailableKind, +pub struct HistoryRewindRequest { + /// ID of the user.message event that begins the discarded suffix. + pub event_id: String, + /// Whether to rewind only conversation history or also restore captured files. + pub mode: HistoryRewindMode, } -/// Schema for the `PermissionDecisionApproved` type. +/// A captured file that rewind intentionally left unchanged. /// ///
    /// @@ -4603,12 +5282,14 @@ pub struct PermissionDecisionUserNotAvailable { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApproved { - /// The permission request was approved - pub kind: PermissionDecisionApprovedKind, +pub struct HistorySkippedFileRestore { + /// Absolute path of the skipped file. + pub path: String, + /// Reason the file was not restored. + pub reason: HistoryFileRestoreSkipReason, } -/// Schema for the `PermissionDecisionApprovedForSession` type. +/// Structured outcome of a rewind request. /// ///
    /// @@ -4616,16 +5297,24 @@ pub struct PermissionDecisionApproved { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApprovedForSession { - /// The approval to add as a session-scoped rule - pub approval: UserToolSessionApproval, - /// Approved and remembered for the rest of the session - pub kind: PermissionDecisionApprovedForSessionKind, +pub struct HistoryRewindResult { + /// Failure detail. Set only for the failure and partial-failure outcomes (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`). + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Number of persisted events removed by conversation truncation. Present only when truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`) and for `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_removed: Option, + /// Overall rewind outcome. This discriminates the result: it governs which of the remaining fields are populated, so consumers must switch on it before reading `eventsRemoved`, `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that populate it. + pub outcome: HistoryRewindOutcome, + /// Absolute paths restored to their captured preimages. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + pub restored_files: Vec, + /// Captured files intentionally left unchanged. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + pub skipped_files: Vec, } -/// Schema for the `PermissionDecisionApprovedForLocation` type. +/// Markdown summary of the conversation context (empty when not available). /// ///
    /// @@ -4633,18 +5322,14 @@ pub struct PermissionDecisionApprovedForSession { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionApprovedForLocation { - /// The approval to persist for this location - pub approval: UserToolSessionApproval, - /// Approved and persisted for this project location - pub kind: PermissionDecisionApprovedForLocationKind, - /// The location key (git root or cwd) to persist the approval to - pub location_key: String, +pub struct HistorySummarizeForHandoffResult { + /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. + pub summary: String, } -/// Schema for the `PermissionDecisionCancelled` type. +/// Identifier of the event to truncate to; this event and all later events are removed. /// ///
    /// @@ -4654,15 +5339,12 @@ pub struct PermissionDecisionApprovedForLocation { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionCancelled { - /// The permission request was cancelled before a response was used - pub kind: PermissionDecisionCancelledKind, - /// Optional explanation of why the request was cancelled - #[serde(skip_serializing_if = "Option::is_none")] - pub reason: Option, +pub struct HistoryTruncateRequest { + /// Event ID to truncate to. This event and all events after it are removed from the session. + pub event_id: String, } -/// Schema for the `PermissionDecisionDeniedByRules` type. +/// Number of events that were removed by the truncation. /// ///
    /// @@ -4672,14 +5354,18 @@ pub struct PermissionDecisionCancelled { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedByRules { - /// Denied because approval rules explicitly blocked it - pub kind: PermissionDecisionDeniedByRulesKind, - /// Rules that denied the request - pub rules: Vec, +pub struct HistoryTruncateResult { + /// Failure detail when checkpointCleanupFailed is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub checkpoint_cleanup_error: Option, + /// True when conversation truncation succeeded but post-truncation workspace checkpoint cleanup failed. History is already truncated; callers may still prune snapshots but should report a checkpoint-cleanup rather than a truncation failure. + #[serde(skip_serializing_if = "Option::is_none")] + pub checkpoint_cleanup_failed: Option, + /// Number of events that were removed + pub events_removed: i64, } -/// Schema for the `PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. +/// Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret. /// ///
    /// @@ -4689,52 +5375,37 @@ pub struct PermissionDecisionDeniedByRules { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { - /// Denied because no approval rule matched and user confirmation was unavailable - pub kind: PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind, +pub struct HMACAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// HMAC secret used to sign requests. + pub hmac: String, + /// Authentication host. HMAC auth always targets the public GitHub host. + pub host: HMACAuthInfoHost, + /// HMAC-based authentication used by GitHub-internal services. + pub r#type: HMACAuthInfoType, } -/// Schema for the `PermissionDecisionDeniedInteractivelyByUser` type. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Runtime-owned wire payload for a server-to-client hook callback invocation. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedInteractivelyByUser { - /// Optional feedback from the user explaining the denial - #[serde(skip_serializing_if = "Option::is_none")] - pub feedback: Option, - /// Whether to force-reject the current agent turn - #[serde(skip_serializing_if = "Option::is_none")] - pub force_reject: Option, - /// Denied by the user during an interactive prompt - pub kind: PermissionDecisionDeniedInteractivelyByUserKind, +pub(crate) struct HookInvokeRequest { + #[doc(hidden)] + pub(crate) hook_type: HookType, + pub input: serde_json::Value, + pub session_id: SessionId, } -/// Schema for the `PermissionDecisionDeniedByContentExclusionPolicy` type. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Optional output returned by an SDK callback hook. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedByContentExclusionPolicy { - /// Denied by the organization's content exclusion policy - pub kind: PermissionDecisionDeniedByContentExclusionPolicyKind, - /// Human-readable explanation of why the path was excluded - pub message: String, - /// File path that triggered the exclusion - pub path: String, +pub(crate) struct HookInvokeResponse { + #[serde(skip_serializing_if = "Option::is_none")] + pub output: Option, } -/// Schema for the `PermissionDecisionDeniedByPermissionRequestHook` type. +/// Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source. /// ///
    /// @@ -4744,18 +5415,31 @@ pub struct PermissionDecisionDeniedByContentExclusionPolicy { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionDeniedByPermissionRequestHook { - /// Whether to interrupt the current agent turn +pub struct InstalledPlugin { + /// Path where the plugin is cached locally + #[serde(rename = "cache_path", skip_serializing_if = "Option::is_none")] + pub cache_path: Option, + /// Whether the plugin is currently enabled + pub enabled: bool, + /// Installation timestamp + #[serde(rename = "installed_at")] + pub installed_at: String, + /// Marketplace the plugin came from (empty string for direct repo installs) + pub marketplace: String, + /// Plugin name + pub name: String, + /// Source for direct repo installs (when marketplace is empty) #[serde(skip_serializing_if = "Option::is_none")] - pub interrupt: Option, - /// Denied by a permission request hook registered by an extension or plugin - pub kind: PermissionDecisionDeniedByPermissionRequestHookKind, - /// Optional message from the hook explaining the denial + pub source: Option, + /// Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + #[serde(rename = "source_sha", skip_serializing_if = "Option::is_none")] + pub source_sha: Option, + /// Version installed (if available) #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, + pub version: Option, } -/// Pending permission request ID and the decision to apply (approve/reject and scope). +/// Information about an installed plugin tracked in global state. /// ///
    /// @@ -4763,16 +5447,24 @@ pub struct PermissionDecisionDeniedByPermissionRequestHook { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionDecisionRequest { - /// Request ID of the pending permission request - pub request_id: RequestId, - /// The client's response to the pending permission prompt - pub result: PermissionDecision, +pub struct InstalledPluginInfo { + /// Opaque, stable hash identifying a direct (non-marketplace) install source. Present only for direct repo / URL / local installs; absent for marketplace plugins. Same source yields the same id; distinct sources never collide. + #[serde(skip_serializing_if = "Option::is_none")] + pub direct_source_id: Option, + /// Whether the plugin is currently enabled for new sessions + pub enabled: bool, + /// Marketplace the plugin came from. Empty string ("") for direct repo / URL / local installs. + pub marketplace: String, + /// Plugin name + pub name: String, + /// Installed version (when reported by the plugin manifest) + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsCommands` type. +/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. /// ///
    /// @@ -4782,14 +5474,20 @@ pub struct PermissionDecisionRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsCommands { - /// Command identifiers covered by this approval. - pub command_identifiers: Vec, - /// Approval scoped to specific command identifiers. - pub kind: PermissionsLocationsAddToolApprovalDetailsCommandsKind, +pub struct InstalledPluginSourceGitHub { + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + pub repo: String, + /// Optional full 40-character hexadecimal commit SHA. + #[serde(skip_serializing_if = "Option::is_none")] + pub sha: Option, + /// Constant value. Always "github". + pub source: InstalledPluginSourceGitHubSource, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsRead` type. +/// Source descriptor for a direct local plugin install, with a local filesystem path. /// ///
    /// @@ -4799,12 +5497,13 @@ pub struct PermissionsLocationsAddToolApprovalDetailsCommands { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsRead { - /// Approval covering read-only filesystem operations. - pub kind: PermissionsLocationsAddToolApprovalDetailsReadKind, +pub struct InstalledPluginSourceLocal { + pub path: String, + /// Constant value. Always "local". + pub source: InstalledPluginSourceLocalSource, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsWrite` type. +/// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. /// ///
    /// @@ -4814,12 +5513,20 @@ pub struct PermissionsLocationsAddToolApprovalDetailsRead { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsWrite { - /// Approval covering filesystem write operations. - pub kind: PermissionsLocationsAddToolApprovalDetailsWriteKind, +pub struct InstalledPluginSourceUrl { + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + /// Optional full 40-character hexadecimal commit SHA. + #[serde(skip_serializing_if = "Option::is_none")] + pub sha: Option, + /// Constant value. Always "url". + pub source: InstalledPluginSourceUrlSource, + pub url: String, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcp` type. +/// Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path. /// ///
    /// @@ -4829,16 +5536,21 @@ pub struct PermissionsLocationsAddToolApprovalDetailsWrite { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsMcp { - /// Approval covering an MCP tool. - pub kind: PermissionsLocationsAddToolApprovalDetailsMcpKind, - /// MCP server name. - pub server_name: String, - /// MCP tool name, or null to cover every tool on the server. - pub tool_name: Option, +pub struct InstructionDiscoveryPath { + /// Whether the target is a single file or a directory of instruction files + pub kind: InstructionDiscoveryPathKind, + /// Which tier this target belongs to + pub location: InstructionDiscoveryPathLocation, + /// Absolute path of the file or directory (may not exist on disk yet) + pub path: String, + /// Whether this is the canonical target to create new instructions in its tier. At most one entry per tier is preferred. + pub preferred_for_creation: bool, + /// The input project path this target was derived from (only for repository targets) + #[serde(skip_serializing_if = "Option::is_none")] + pub project_path: Option, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMcpSampling` type. +/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. /// ///
    /// @@ -4848,14 +5560,12 @@ pub struct PermissionsLocationsAddToolApprovalDetailsMcp { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsMcpSampling { - /// Approval covering MCP sampling requests for a server. - pub kind: PermissionsLocationsAddToolApprovalDetailsMcpSamplingKind, - /// MCP server name. - pub server_name: String, +pub struct InstructionDiscoveryPathList { + /// Canonical instruction create/discovery files and directories, in priority order + pub paths: Vec, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsMemory` type. +/// Optional project paths to include in instruction discovery. /// ///
    /// @@ -4865,12 +5575,16 @@ pub struct PermissionsLocationsAddToolApprovalDetailsMcpSampling { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsMemory { - /// Approval covering writes to long-term memory. - pub kind: PermissionsLocationsAddToolApprovalDetailsMemoryKind, +pub struct InstructionsDiscoverRequest { + /// When true, omit the host's instruction sources (user/home-level files and plugin rules), leaving only repository and working-directory sources. For multitenant deployments. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_instructions: Option, + /// Optional list of project directory paths to scan for repository/working-directory instruction sources. When omitted or empty, only user-level and plugin instruction sources are returned (no project scan). + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsCustomTool` type. +/// Optional project paths to include when enumerating instruction discovery targets. /// ///
    /// @@ -4880,14 +5594,16 @@ pub struct PermissionsLocationsAddToolApprovalDetailsMemory { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsCustomTool { - /// Approval covering a custom tool. - pub kind: PermissionsLocationsAddToolApprovalDetailsCustomToolKind, - /// Custom tool name. - pub tool_name: String, +pub struct InstructionsGetDiscoveryPathsRequest { + /// When true, omit the host's user-level instruction targets, leaving only repository targets. For multitenant deployments (mirrors `discover`'s `excludeHostInstructions`). + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_instructions: Option, + /// Optional list of project directory paths. When omitted or empty, only the user-level targets are returned. + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionManagement` type. +/// Loaded instruction source for a session, including path, content, category, location, applicability, and optional description. /// ///
    /// @@ -4897,15 +5613,34 @@ pub struct PermissionsLocationsAddToolApprovalDetailsCustomTool { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsExtensionManagement { - /// Approval covering extension lifecycle operations such as enable, disable, or reload. - pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionManagementKind, - /// Optional operation identifier; when omitted, the approval covers all extension management operations. +pub struct InstructionSource { + /// Glob pattern(s) from frontmatter — when set, this instruction applies only to matching files #[serde(skip_serializing_if = "Option::is_none")] - pub operation: Option, + pub apply_to: Option>, + /// Raw content of the instruction file + pub content: String, + /// When true, this source starts disabled and must be toggled on by the user + #[serde(skip_serializing_if = "Option::is_none")] + pub default_disabled: Option, + /// Short description (body after frontmatter) for use in instruction tables + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Unique identifier for this source (used for toggling) + pub id: String, + /// Human-readable label + pub label: String, + /// Where this source lives — used for UI grouping + pub location: InstructionSourceLocation, + /// The project path this source was discovered from. Only set by sessionless discovery for repository, working-directory, and project-scoped plugin sources, where it disambiguates sources across multiple workspace roots. The session-scoped getSources leaves it unset. + #[serde(skip_serializing_if = "Option::is_none")] + pub project_path: Option, + /// File path relative to repo or absolute for home + pub source_path: String, + /// Category of instruction source — used for merge logic + pub r#type: InstructionSourceType, } -/// Schema for the `PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess` type. +/// Instruction sources loaded for the session, in merge order. /// ///
    /// @@ -4915,14 +5650,12 @@ pub struct PermissionsLocationsAddToolApprovalDetailsExtensionManagement { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { - /// Extension name. - pub extension_name: String, - /// Approval covering an extension's request to access a permission-gated capability. - pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind, +pub struct InstructionsGetSourcesResult { + /// Instruction sources for the session + pub sources: Vec, } -/// Location-scoped tool approval to persist. +/// Parameters for interrupting the main agent turn. /// ///
    /// @@ -4930,16 +5663,15 @@ pub struct PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] +#[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionLocationAddToolApprovalParams { - /// Tool approval to persist and apply - pub approval: PermissionsLocationsAddToolApprovalDetails, - /// Location key (git root or cwd) to persist the approval to - pub location_key: String, +pub struct InterruptMainTurnRequest { + /// When true, the user's queued prompts are preserved and run as the next turn once the interrupted turn unwinds; when false (the default), the queue is cleared like a plain abort. + #[serde(skip_serializing_if = "Option::is_none")] + pub flush_queued: Option, } -/// Working directory to load persisted location permissions for. +/// Result of interrupting the main agent turn. /// ///
    /// @@ -4949,12 +5681,78 @@ pub struct PermissionLocationAddToolApprovalParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionLocationApplyParams { - /// Working directory whose persisted location permissions should be applied - pub working_directory: String, +pub struct InterruptMainTurnResult { + /// Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + pub interrupted: bool, } -/// Summary of persisted location permissions applied to the session. +/// A request body chunk or cancellation signal. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LlmInferenceHttpRequestChunkRequest { + /// Identity of the agent invocation (one agentic loop) this body chunk belongs to, matching the `agentInvocationId` semantics on httpRequestStart. Carried per chunk so a persistent transport can attribute successive turns correctly: when a WebSocket connection is reused across turns, the httpRequestStart identity reflects only the turn that opened the connection, so each later turn stamps its own invocation id here. Absent when the runtime has no invocation context for the request, or on the plain-HTTP transport where every request has its own httpRequestStart. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_invocation_id: Option, + /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + #[serde(skip_serializing_if = "Option::is_none")] + pub binary: Option, + /// When true, the runtime is cancelling the in-flight request (e.g. upstream consumer aborted). `data` is ignored. Implies end-of-request. + #[serde(skip_serializing_if = "Option::is_none")] + pub cancel: Option, + /// Optional human-readable reason for the cancellation, propagated for logging. + #[serde(skip_serializing_if = "Option::is_none")] + pub cancel_reason: Option, + /// Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty. + pub data: String, + /// When true, this is the final body chunk for the request. The SDK may rely on having received an end-marked chunk before treating the request body as complete. + #[serde(skip_serializing_if = "Option::is_none")] + pub end: Option, + /// Matches the requestId from the originating httpRequestStart frame. + pub request_id: RequestId, +} + +/// Acknowledgement. The SDK is free to ignore the ack and treat chunk delivery as fire-and-forget. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LlmInferenceHttpRequestChunkResult {} + +/// The head of an outbound model-layer HTTP request. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LlmInferenceHttpRequestStartRequest { + /// Stable identity of the agent trajectory that issued this request. Present when the request originates from an agent turn; absent for requests outside any agent context. This is the same identity used by lifecycle and bridged session events and remains constant across turns and retries. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_id: Option, + /// Identity of the agent invocation (one agentic loop) that issued this request. It remains fixed across physical retries within the invocation and is distinct from the stable trajectory `agentId`. A caller-supplied invocation id always takes precedence (this covers auxiliary calls that have no model call id). Otherwise, first-party CAPI requests fall back to the runtime's agent task id — the same value the runtime emits as the `X-Agent-Task-Id` header — while custom-provider requests fall back to the model call id. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_invocation_id: Option, + pub headers: HashMap>, + /// Coarse classification of the interaction that produced this request. Open string for forward-compatibility; known values include `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, and `conversation-user`. Absent when the runtime did not classify the request. Comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` header from this same context. + #[serde(skip_serializing_if = "Option::is_none")] + pub interaction_type: Option, + /// HTTP method, e.g. GET, POST. + pub method: String, + /// Stable identity of the immediate parent trajectory. Present for child trajectories such as subagents and conversation-sampling requests; absent for root-agent and non-agent requests. + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_agent_id: Option, + /// Opaque runtime-minted id, unique per in-flight request. The SDK uses this to correlate httpRequestChunk frames and to address its httpResponseStart / httpResponseChunk replies back to the runtime. + pub request_id: RequestId, + /// Id of the runtime session that triggered this request, when one is in scope. Absent for requests issued outside any session (e.g. startup model-catalog or capability resolution). This is a payload field — not a dispatch key — because the client-global API is registered process-wide rather than per session. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, + /// Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Absolute request URL. + pub url: String, +} + +/// Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LlmInferenceHttpRequestStartResult {} + +/// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. /// ///
    /// @@ -4964,22 +5762,15 @@ pub struct PermissionLocationApplyParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionLocationApplyResult { - /// Number of persisted allowed directories added to the live path manager - pub applied_directory_count: i64, - /// Number of location-scoped rules added to the live permission service - pub applied_rule_count: i64, - /// Location-scoped rules applied to the live permission service - pub applied_rules: Vec, - /// Whether a different location was applied since the previous apply call - pub changed: bool, - /// Location key used in the location-permissions store - pub location_key: String, - /// Whether the location is a git repo or directory - pub location_type: PermissionLocationType, +pub struct LlmInferenceHttpResponseChunkError { + /// Optional machine-readable error code. + #[serde(skip_serializing_if = "Option::is_none")] + pub code: Option, + /// Human-readable failure description. + pub message: String, } -/// Working directory to resolve into a location-permissions key. +/// A response body chunk or terminal error. /// ///
    /// @@ -4989,12 +5780,23 @@ pub struct PermissionLocationApplyResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionLocationResolveParams { - /// Working directory whose permission location should be resolved - pub working_directory: String, +pub struct LlmInferenceHttpResponseChunkRequest { + /// When true, `data` is base64-encoded bytes. When absent or false, `data` is UTF-8 text. + #[serde(skip_serializing_if = "Option::is_none")] + pub binary: Option, + /// Body byte range. UTF-8 text when `binary` is absent or false; base64-encoded bytes when `binary` is true. May be empty (e.g. when the response body is empty: send a single chunk with empty data and end=true). + pub data: String, + /// When true, this is the final body chunk for the response. The runtime treats the response body as complete after receiving an end-marked chunk. + #[serde(skip_serializing_if = "Option::is_none")] + pub end: Option, + /// Set to terminate the response with a transport-level failure. Implies end-of-stream; any further chunks for this requestId are ignored. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Matches the requestId from the originating httpRequestStart frame. + pub request_id: RequestId, } -/// Resolved location-permissions key and type. +/// Whether the chunk was accepted. /// ///
    /// @@ -5004,14 +5806,12 @@ pub struct PermissionLocationResolveParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionLocationResolveResult { - /// Location key used in the location-permissions store - pub location_key: String, - /// Whether the location is a git repo or directory - pub location_type: PermissionLocationType, +pub struct LlmInferenceHttpResponseChunkResult { + /// True when the chunk was matched to a pending request; false when unknown. + pub accepted: bool, } -/// Directory path to add to the session's allowed directories. +/// Response head. /// ///
    /// @@ -5021,12 +5821,18 @@ pub struct PermissionLocationResolveResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsAddParams { - /// Directory to add to the allow-list. The runtime resolves and validates the path before adding. - pub path: String, +pub struct LlmInferenceHttpResponseStartRequest { + pub headers: HashMap>, + /// Matches the requestId from the originating httpRequestStart frame. + pub request_id: RequestId, + /// HTTP status code. + pub status: i64, + /// Optional HTTP status reason phrase. + #[serde(skip_serializing_if = "Option::is_none")] + pub status_text: Option, } -/// Path to evaluate against the session's allowed directories. +/// Whether the start frame was accepted. /// ///
    /// @@ -5036,12 +5842,12 @@ pub struct PermissionPathsAddParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsAllowedCheckParams { - /// Path to check against the session's allowed directories - pub path: String, +pub struct LlmInferenceHttpResponseStartResult { + /// True when the response start was matched to a pending request; false when unknown. + pub accepted: bool, } -/// Indicates whether the supplied path is within the session's allowed directories. +/// Indicates whether the calling client was registered as the LLM inference provider. /// ///
    /// @@ -5051,12 +5857,12 @@ pub struct PermissionPathsAllowedCheckParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsAllowedCheckResult { - /// Whether the path is within the session's allowed directories - pub allowed: bool, +pub struct LlmInferenceSetProviderResult { + /// Whether the provider was set successfully + pub success: bool, } -/// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. +/// Pre-resolved working-directory context for session startup. /// ///
    /// @@ -5066,22 +5872,24 @@ pub struct PermissionPathsAllowedCheckResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsConfig { - /// Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). +pub struct SessionContext { + /// Active git branch #[serde(skip_serializing_if = "Option::is_none")] - pub additional_directories: Option>, - /// Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. + pub branch: Option, + /// Most recent working directory for this session + pub cwd: String, + /// Git repository root, if the cwd was inside a git repo #[serde(skip_serializing_if = "Option::is_none")] - pub include_temp_directory: Option, - /// If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. + pub git_root: Option, + /// Repository host type #[serde(skip_serializing_if = "Option::is_none")] - pub unrestricted: Option, - /// Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. + pub host_type: Option, + /// Repository slug in `owner/name` form, when known #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_path: Option, + pub repository: Option, } -/// Snapshot of the session's allow-listed directories and primary working directory. +/// Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID. /// ///
    /// @@ -5091,14 +5899,36 @@ pub struct PermissionPathsConfig { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsList { - /// All directories currently allowed for tool access on this session. - pub directories: Vec, - /// The primary working directory for this session. - pub primary: String, +pub struct LocalSessionMetadataValue { + /// Runtime client name that created/last resumed this session + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Pre-resolved working-directory context for session startup. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, + /// True for detached maintenance sessions that should be hidden from normal resume lists. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_detached: Option, + /// Always false for local sessions. + pub is_remote: bool, + /// GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + #[serde(skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + /// Last-modified time of the session's persisted state, as ISO 8601 + pub modified_time: String, + /// Optional human-friendly name set via /rename + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Stable session identifier + pub session_id: SessionId, + /// Session creation time as an ISO 8601 timestamp + pub start_time: String, + /// Short summary of the session, when one has been derived + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, } -/// Directory path to set as the session's new primary working directory. +/// Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. /// ///
    /// @@ -5108,12 +5938,27 @@ pub struct PermissionPathsList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsUpdatePrimaryParams { - /// Directory to set as the new primary working directory for the session's permission policy. - pub path: String, +pub struct LogRequest { + /// When true, the message is transient and not persisted to the session event log on disk + #[serde(skip_serializing_if = "Option::is_none")] + pub ephemeral: Option, + /// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". + #[serde(skip_serializing_if = "Option::is_none")] + pub level: Option, + /// Human-readable message + pub message: String, + /// Optional actionable tip displayed alongside the message. Only honored on `level: "info"`. + #[serde(skip_serializing_if = "Option::is_none")] + pub tip: Option, + /// Domain category for this log entry (e.g., "mcp", "subscription", "policy", "model"). Maps to `infoType`/`warningType`/`errorType` on the emitted event. Defaults to "notification". + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, + /// Optional URL the user can open in their browser for more details + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, } -/// Path to evaluate against the session's workspace (primary) directory. +/// Identifier of the session event that was emitted for the log message. /// ///
    /// @@ -5123,12 +5968,12 @@ pub struct PermissionPathsUpdatePrimaryParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsWorkspaceCheckParams { - /// Path to check against the session workspace directory - pub path: String, +pub struct LogResult { + /// The unique identifier of the emitted session event + pub event_id: String, } -/// Indicates whether the supplied path is within the session's workspace directory. +/// Parameters for (re)loading the merged LSP configuration set. /// ///
    /// @@ -5138,12 +5983,19 @@ pub struct PermissionPathsWorkspaceCheckParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPathsWorkspaceCheckResult { - /// Whether the path is within the session workspace directory - pub allowed: bool, +pub struct LspInitializeRequest { + /// Force re-initialization even when LSP configs were already loaded for the working directory. + #[serde(skip_serializing_if = "Option::is_none")] + pub force: Option, + /// Git root used as the boundary when traversing for project-level LSP configs (supports monorepos). + #[serde(skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Working directory used to load project-level LSP configs. Defaults to the session working directory when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// Notification payload describing the permission prompt that the client just rendered. +/// Validated device-managed settings discovered before a session exists. /// ///
    /// @@ -5153,12 +6005,16 @@ pub struct PermissionPathsWorkspaceCheckResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionPromptShownNotification { - /// Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). - pub message: String, +pub struct ManagedSettingsReadResult { + /// Discovery or validation error text when managed settings could not be read safely. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_message: Option, + /// Validated, canonical managed-settings JSON. Omitted when no managed settings were discovered or when discovered settings failed validation. + #[serde(skip_serializing_if = "Option::is_none")] + pub settings_json: Option, } -/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// Result of registering a new marketplace. /// ///
    /// @@ -5168,12 +6024,12 @@ pub struct PermissionPromptShownNotification { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionRequestResult { - /// Whether the permission request was handled successfully - pub success: bool, +pub struct MarketplaceAddResult { + /// Final name of the marketplace as resolved from its manifest + pub name: String, } -/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. +/// Plugin entry advertised by a marketplace. /// ///
    /// @@ -5183,14 +6039,15 @@ pub struct PermissionRequestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionRulesSet { - /// Rules that auto-approve matching requests - pub approved: Vec, - /// Rules that auto-deny matching requests - pub denied: Vec, +pub struct MarketplacePluginInfo { + /// Short description from the marketplace catalog, when present + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Plugin name as listed in the marketplace catalog + pub name: String, } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. +/// Plugins advertised by the marketplace. /// ///
    /// @@ -5200,12 +6057,12 @@ pub struct PermissionRulesSet { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { - pub name: String, - pub r#type: String, +pub struct MarketplaceBrowseResult { + /// Plugins advertised by the marketplace + pub plugins: Vec, } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type. +/// Registered marketplace summary. /// ///
    /// @@ -5215,17 +6072,17 @@ pub struct PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureAdditionalContentExclusionPolicyRule { +pub struct MarketplaceInfo { + /// True when this is a default marketplace shipped with the runtime. Defaults are not removable. #[serde(skip_serializing_if = "Option::is_none")] - pub if_any_match: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - pub if_none_match: Option>, - pub paths: Vec, - /// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type. - pub source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, + pub is_default: Option, + /// Marketplace name (matches the @marketplace suffix in plugin specs) + pub name: String, + /// Human-readable description of where the marketplace data is fetched from (e.g. "GitHub: owner/repo"). + pub source: String, } -/// Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type. +/// All registered marketplaces, including built-in defaults. /// ///
    /// @@ -5235,15 +6092,12 @@ pub struct PermissionsConfigureAdditionalContentExclusionPolicyRule { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureAdditionalContentExclusionPolicy { - #[serde(rename = "last_updated_at")] - pub last_updated_at: serde_json::Value, - pub rules: Vec, - /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. - pub scope: PermissionsConfigureAdditionalContentExclusionPolicyScope, +pub struct MarketplaceListResult { + /// Registered marketplaces + pub marketplaces: Vec, } -/// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. +/// Per-marketplace refresh result, including marketplace name, success flag, and optional failure error. /// ///
    /// @@ -5253,16 +6107,17 @@ pub struct PermissionsConfigureAdditionalContentExclusionPolicy { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionUrlsConfig { - /// Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. +pub struct MarketplaceRefreshEntry { + /// Error message (failure only) #[serde(skip_serializing_if = "Option::is_none")] - pub initial_allowed: Option>, - /// If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. - #[serde(skip_serializing_if = "Option::is_none")] - pub unrestricted: Option, + pub error: Option, + /// Marketplace name that was refreshed + pub name: String, + /// Whether the refresh succeeded + pub success: bool, } -/// Patch of permission policy fields to apply (omit a field to leave it unchanged). +/// Result of refreshing one or more marketplace catalogs. /// ///
    /// @@ -5272,29 +6127,12 @@ pub struct PermissionUrlsConfig { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureParams { - /// If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub additional_content_exclusion_policies: - Option>, - /// If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub approve_all_read_permission_requests: Option, - /// If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub approve_all_tool_permission_requests: Option, - /// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub paths: Option, - /// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub rules: Option, - /// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. - #[serde(skip_serializing_if = "Option::is_none")] - pub urls: Option, +pub struct MarketplaceRefreshResult { + /// Per-marketplace refresh results in deterministic order. + pub results: Vec, } -/// Indicates whether the operation succeeded. +/// Outcome of the remove attempt, including dependent-plugin info when applicable. /// ///
    /// @@ -5304,12 +6142,15 @@ pub struct PermissionsConfigureParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsConfigureResult { - /// Whether the operation succeeded - pub success: bool, +pub struct MarketplaceRemoveResult { + /// Names of installed plugins that prevented removal. Populated only when `removed=false`. + #[serde(skip_serializing_if = "Option::is_none")] + pub dependent_plugins: Option>, + /// True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. + pub removed: bool, } -/// Indicates whether the operation succeeded. +/// MCP server allowed by policy, with server name and optional PII-free explanatory note. /// ///
    /// @@ -5319,12 +6160,15 @@ pub struct PermissionsConfigureResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsFolderTrustAddTrustedResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAllowedServer { + /// Allowed server name + pub name: String, + /// PII-free note explaining why the server was allowed + #[serde(skip_serializing_if = "Option::is_none")] + pub redacted_note: Option, } -/// No parameters. +/// MCP server, tool name, and arguments to invoke from an MCP App view. /// ///
    /// @@ -5334,9 +6178,19 @@ pub struct PermissionsFolderTrustAddTrustedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsGetAllowAllRequest {} +pub struct McpAppsCallToolRequest { + /// Tool arguments + #[serde(skip_serializing_if = "Option::is_none")] + pub arguments: Option>, + /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + pub origin_server_name: String, + /// MCP server hosting the tool + pub server_name: String, + /// MCP tool name + pub tool_name: String, +} -/// Indicates whether the operation succeeded. +/// Capability negotiation snapshot /// ///
    /// @@ -5346,12 +6200,16 @@ pub struct PermissionsGetAllowAllRequest {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsLocationsAddToolApprovalResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsDiagnoseCapability { + /// Whether the runtime advertises `extensions.io.modelcontextprotocol/ui` to MCP servers + pub advertised: bool, + /// Whether the MCP_APPS feature flag (or COPILOT_MCP_APPS env override) is on + pub feature_flag_enabled: bool, + /// Whether the session has the `mcp-apps` capability + pub session_has_mcp_apps: bool, } -/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. +/// MCP server to diagnose MCP Apps wiring for. /// ///
    /// @@ -5361,21 +6219,12 @@ pub struct PermissionsLocationsAddToolApprovalResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsModifyRulesParams { - /// Rules to add to the scope. Applied before `remove`/`removeAll`. - #[serde(skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// Specific rules to remove from the scope. Ignored when `removeAll` is true. - #[serde(skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. - #[serde(skip_serializing_if = "Option::is_none")] - pub remove_all: Option, - /// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. - pub scope: PermissionsModifyRulesScope, +pub struct McpAppsDiagnoseRequest { + /// MCP server to probe + pub server_name: String, } -/// Indicates whether the operation succeeded. +/// What the server returned for this session /// ///
    /// @@ -5385,12 +6234,18 @@ pub struct PermissionsModifyRulesParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsModifyRulesResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsDiagnoseServer { + /// Whether the named server is currently connected + pub connected: bool, + /// Up to 5 tool names with `_meta.ui` for quick inspection + pub sample_tool_names: Vec, + /// Total tools returned by the server's tools/list + pub tool_count: f64, + /// Tools whose `_meta.ui` is populated (resourceUri and/or visibility set) + pub tools_with_ui_meta: f64, } -/// Indicates whether the operation succeeded. +/// Diagnostic snapshot of MCP Apps wiring for the named server. /// ///
    /// @@ -5400,12 +6255,14 @@ pub struct PermissionsModifyRulesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsNotifyPromptShownResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsDiagnoseResult { + /// Capability negotiation snapshot + pub capability: McpAppsDiagnoseCapability, + /// What the server returned for this session + pub server: McpAppsDiagnoseServer, } -/// Indicates whether the operation succeeded. +/// Current host context /// ///
    /// @@ -5415,12 +6272,31 @@ pub struct PermissionsNotifyPromptShownResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPathsAddResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsHostContextDetails { + /// Display modes the host supports + #[serde(skip_serializing_if = "Option::is_none")] + pub available_display_modes: Option>, + /// Current display mode (SEP-1865) + #[serde(skip_serializing_if = "Option::is_none")] + pub display_mode: Option, + /// BCP-47 locale, e.g. 'en-US' + #[serde(skip_serializing_if = "Option::is_none")] + pub locale: Option, + /// Platform type for responsive design + #[serde(skip_serializing_if = "Option::is_none")] + pub platform: Option, + /// UI theme preference per SEP-1865 + #[serde(skip_serializing_if = "Option::is_none")] + pub theme: Option, + /// IANA timezone, e.g. 'America/New_York' + #[serde(skip_serializing_if = "Option::is_none")] + pub time_zone: Option, + /// Host application identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub user_agent: Option, } -/// No parameters; returns the session's allow-listed directories. +/// Current host context advertised to MCP App guests. /// ///
    /// @@ -5430,9 +6306,12 @@ pub struct PermissionsPathsAddResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPathsListRequest {} +pub struct McpAppsHostContext { + /// Current host context + pub context: McpAppsHostContextDetails, +} -/// Indicates whether the operation succeeded. +/// MCP server to list app-callable tools for. /// ///
    /// @@ -5442,12 +6321,14 @@ pub struct PermissionsPathsListRequest {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPathsUpdatePrimaryResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsListToolsRequest { + /// **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing. + pub origin_server_name: String, + /// MCP server hosting the app + pub server_name: String, } -/// No parameters; returns currently-pending permission requests for the session. +/// App-callable tools from the named MCP server. /// ///
    /// @@ -5457,9 +6338,12 @@ pub struct PermissionsPathsUpdatePrimaryResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsPendingRequestsRequest {} +pub struct McpAppsListToolsResult { + /// App-callable tools from the server + pub tools: Vec>, +} -/// No parameters; clears all session-scoped tool permission approvals. +/// MCP server and resource URI to fetch. /// ///
    /// @@ -5469,9 +6353,14 @@ pub struct PermissionsPendingRequestsRequest {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsResetSessionApprovalsRequest {} +pub struct McpAppsReadResourceRequest { + /// Name of the MCP server hosting the resource + pub server_name: String, + /// Resource URI (typically ui://...) + pub uri: String, +} -/// Indicates whether the operation succeeded. +/// MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata. /// ///
    /// @@ -5481,12 +6370,24 @@ pub struct PermissionsResetSessionApprovalsRequest {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsResetSessionApprovalsResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsResourceContent { + /// Resource-level metadata (CSP, permissions, etc.) + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// Base64-encoded binary content + #[serde(skip_serializing_if = "Option::is_none")] + pub blob: Option, + /// MIME type of the content + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Text content (e.g. HTML) + #[serde(skip_serializing_if = "Option::is_none")] + pub text: Option, + /// The resource URI (typically ui://...) + pub uri: String, } -/// Whether to enable full allow-all permissions for the session. +/// Resource contents returned by the MCP server. /// ///
    /// @@ -5496,15 +6397,12 @@ pub struct PermissionsResetSessionApprovalsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsSetAllowAllRequest { - /// Whether to enable full allow-all permissions - pub enabled: bool, - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, +pub struct McpAppsReadResourceResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// Allow-all toggle for tool permission requests, with an optional telemetry source. +/// Host context advertised to MCP App guests /// ///
    /// @@ -5514,15 +6412,31 @@ pub struct PermissionsSetAllowAllRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsSetApproveAllRequest { - /// Whether to auto-approve all tool permission requests - pub enabled: bool, - /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +pub struct McpAppsSetHostContextDetails { + /// Display modes the host supports #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, + pub available_display_modes: Option>, + /// Current display mode (SEP-1865) + #[serde(skip_serializing_if = "Option::is_none")] + pub display_mode: Option, + /// BCP-47 locale, e.g. 'en-US' + #[serde(skip_serializing_if = "Option::is_none")] + pub locale: Option, + /// Platform type for responsive design + #[serde(skip_serializing_if = "Option::is_none")] + pub platform: Option, + /// UI theme preference per SEP-1865 + #[serde(skip_serializing_if = "Option::is_none")] + pub theme: Option, + /// IANA timezone, e.g. 'America/New_York' + #[serde(skip_serializing_if = "Option::is_none")] + pub time_zone: Option, + /// Host application identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub user_agent: Option, } -/// Indicates whether the operation succeeded. +/// Host context to advertise to MCP App guests. /// ///
    /// @@ -5532,12 +6446,12 @@ pub struct PermissionsSetApproveAllRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsSetApproveAllResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpAppsSetHostContextRequest { + /// Host context advertised to MCP App guests + pub context: McpAppsSetHostContextDetails, } -/// Toggles whether permission prompts should be bridged into session events for this client. +/// The requestId previously passed to executeSampling that should be cancelled. /// ///
    /// @@ -5547,12 +6461,12 @@ pub struct PermissionsSetApproveAllResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsSetRequiredRequest { - /// Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). - pub required: bool, +pub struct McpCancelSamplingExecutionParams { + /// The requestId previously passed to executeSampling that should be cancelled + pub request_id: RequestId, } -/// Indicates whether the operation succeeded. +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. /// ///
    /// @@ -5562,12 +6476,12 @@ pub struct PermissionsSetRequiredRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsSetRequiredResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpCancelSamplingExecutionResult { + /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). + pub cancelled: bool, } -/// Indicates whether the operation succeeded. +/// MCP server name and configuration to add to user configuration. /// ///
    /// @@ -5577,12 +6491,14 @@ pub struct PermissionsSetRequiredResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionsUrlsSetUnrestrictedModeResult { - /// Whether the operation succeeded - pub success: bool, +pub struct McpConfigAddRequest { + /// MCP server configuration (stdio process or remote HTTP/SSE) + pub config: serde_json::Value, + /// Unique name for the MCP server + pub name: String, } -/// Whether the URL-permission policy should run in unrestricted mode. +/// MCP server names to disable for new sessions. /// ///
    /// @@ -5592,33 +6508,12 @@ pub struct PermissionsUrlsSetUnrestrictedModeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PermissionUrlsSetUnrestrictedModeParams { - /// Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. - pub enabled: bool, -} - -/// Optional message to echo back to the caller. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct PingRequest { - /// Optional message to echo back - #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, -} - -/// Server liveness response, including the echoed message, current server timestamp, and protocol version. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct PingResult { - /// Echoed message (or default greeting) - pub message: String, - /// Server protocol version number - pub protocol_version: i64, - /// ISO 8601 timestamp when the server handled the ping - pub timestamp: String, +pub struct McpConfigDisableRequest { + /// 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. + pub names: Vec, } -/// Existence, contents, and resolved path of the session plan file. +/// MCP server names to enable for new sessions. /// ///
    /// @@ -5628,16 +6523,12 @@ pub struct PingResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PlanReadResult { - /// The content of the plan file, or null if it does not exist - pub content: Option, - /// Whether the plan file exists in the workspace - pub exists: bool, - /// Absolute file path of the plan file, or null if workspace is not enabled - pub path: Option, +pub struct McpConfigEnableRequest { + /// 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. + pub names: Vec, } -/// Replacement contents to write to the session plan file. +/// User-configured MCP servers, keyed by server name. /// ///
    /// @@ -5647,12 +6538,12 @@ pub struct PlanReadResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PlanUpdateRequest { - /// The new content for the plan file - pub content: String, +pub struct McpConfigList { + /// All MCP servers from user config, keyed by name + pub servers: HashMap, } -/// Schema for the `Plugin` type. +/// MCP server name to remove from user configuration. /// ///
    /// @@ -5662,19 +6553,12 @@ pub struct PlanUpdateRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct Plugin { - /// Whether the plugin is currently enabled - pub enabled: bool, - /// Marketplace the plugin came from - pub marketplace: String, - /// Plugin name +pub struct McpConfigRemoveRequest { + /// Name of the MCP server to remove pub name: String, - /// Installed version - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option, } -/// Plugins installed for the session, with their enabled state and version metadata. +/// MCP server name and replacement configuration to write to user configuration. /// ///
    /// @@ -5684,12 +6568,14 @@ pub struct Plugin { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct PluginList { - /// Installed plugins - pub plugins: Vec, +pub struct McpConfigUpdateRequest { + /// MCP server configuration (stdio process or remote HTTP/SSE) + pub config: serde_json::Value, + /// Name of the MCP server to update + pub name: String, } -/// Schema for the `QueuedCommandHandled` type. +/// Opaque auth info used to configure GitHub MCP. /// ///
    /// @@ -5699,15 +6585,13 @@ pub struct PluginList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct QueuedCommandHandled { - /// The host actually executed the queued command. - pub handled: bool, - /// When true, the runtime will not process subsequent queued commands until a new request comes in. - #[serde(skip_serializing_if = "Option::is_none")] - pub stop_processing_queue: Option, +pub(crate) struct McpConfigureGitHubRequest { + /// Opaque runtime auth info for GitHub MCP configuration. Marked internal: an in-process runtime shape (configureGitHubMcp is a no-op over the wire). + #[doc(hidden)] + pub(crate) auth_info: serde_json::Value, } -/// Schema for the `QueuedCommandNotHandled` type. +/// Result of configuring GitHub MCP. /// ///
    /// @@ -5717,12 +6601,12 @@ pub struct QueuedCommandHandled { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct QueuedCommandNotHandled { - /// The host did not execute the queued command. Unblocks the queue without claiming the command was processed (e.g. when the handler threw before completing). - pub handled: bool, +pub struct McpConfigureGitHubResult { + /// Whether GitHub MCP configuration changed. + pub changed: bool, } -/// Schema for the `QueuePendingItems` type. +/// Name of the MCP server to disable for the session. /// ///
    /// @@ -5732,14 +6616,12 @@ pub struct QueuedCommandNotHandled { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct QueuePendingItems { - /// Human-readable text to display for this queue entry in the UI - pub display_text: String, - /// Whether this item is a queued user message or a queued slash command / model change - pub kind: QueuePendingItemsKind, +pub struct McpDisableRequest { + /// Name of the MCP server to disable + pub server_name: String, } -/// Snapshot of the session's pending queued items and immediate-steering messages. +/// Optional working directory used as context for MCP server discovery. /// ///
    /// @@ -5749,14 +6631,13 @@ pub struct QueuePendingItems { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct QueuePendingItemsResult { - /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. - pub items: Vec, - /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). - pub steering_messages: Vec, +pub struct McpDiscoverRequest { + /// Working directory used as context for discovery (e.g., plugin resolution) + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// Indicates whether a user-facing pending item was removed. +/// MCP servers discovered from user, workspace, plugin, and built-in sources. /// ///
    /// @@ -5766,12 +6647,12 @@ pub struct QueuePendingItemsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct QueueRemoveMostRecentResult { - /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. - pub removed: bool, +pub struct McpDiscoverResult { + /// MCP servers discovered from all sources + pub servers: Vec, } -/// Event type to register consumer interest for, used by runtime gating logic. +/// Name of the MCP server to enable for the session. /// ///
    /// @@ -5781,12 +6662,12 @@ pub struct QueueRemoveMostRecentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RegisterEventInterestParams { - /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates the full interactive OAuth flow to the consumer; when no interest is registered the runtime installs a browserless fallback that silently reuses cached tokens). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. - pub event_type: String, +pub struct McpEnableRequest { + /// Name of the MCP server to enable + pub server_name: String, } -/// Opaque handle representing an event-type interest registration. +/// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. /// ///
    /// @@ -5796,12 +6677,9 @@ pub struct RegisterEventInterestParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RegisterEventInterestResult { - /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. - pub handle: String, -} +pub struct McpExecuteSamplingRequest {} -/// Opaque handle previously returned by `registerInterest` to release. +/// Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. /// ///
    /// @@ -5811,12 +6689,18 @@ pub struct RegisterEventInterestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ReleaseEventInterestParams { - /// Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. - pub handle: String, +pub struct McpExecuteSamplingParams { + /// The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle). + pub mcp_request_id: serde_json::Value, + /// Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event. Treated as opaque at the schema layer; the runtime converts the embedded MCP messages into the OpenAI chat-completion shape internally. + pub request: McpExecuteSamplingRequest, + /// Caller-provided unique identifier for this sampling execution. Use this same ID with cancelSamplingExecution to cancel the in-flight call. Must be unique within the session for the lifetime of the call. + pub request_id: RequestId, + /// Name of the MCP server that initiated the sampling request + pub server_name: String, } -/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. +/// MCP server filtered by policy, with name, reason, and optional redacted reason. /// ///
    /// @@ -5826,13 +6710,36 @@ pub struct ReleaseEventInterestParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteEnableRequest { - /// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. +pub struct McpFilteredServer { + /// Deprecated. This field is no longer populated. + #[doc(hidden)] + #[deprecated] #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, + pub enterprise_name: Option, + /// Filtered server name + pub name: String, + /// Human-readable filter reason + pub reason: String, + /// PII-free filter reason + #[serde(skip_serializing_if = "Option::is_none")] + pub redacted_reason: Option, } -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpHeadersHandlePendingHeadersRefreshRequestHeaders { + /// Headers to overlay onto the MCP request. Dynamic headers override static config headers but do not replace SDK-managed request headers. + pub headers: HashMap, + pub kind: McpHeadersHandlePendingHeadersRefreshRequestHeadersKind, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpHeadersHandlePendingHeadersRefreshRequestNone { + pub kind: McpHeadersHandlePendingHeadersRefreshRequestNoneKind, +} + +/// MCP headers refresh request id and the host response. /// ///
    /// @@ -5840,17 +6747,16 @@ pub struct RemoteEnableRequest { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteEnableResult { - /// Whether remote steering is enabled - pub remote_steerable: bool, - /// GitHub frontend URL for this session - #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, +pub struct McpHeadersHandlePendingHeadersRefreshRequestRequest { + /// Headers refresh request identifier from mcp.headers_refresh_required + pub request_id: RequestId, + /// Host response: supply dynamic headers or decline this refresh. + pub result: McpHeadersHandlePendingHeadersRefreshRequest, } -/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. +/// Indicates whether the pending MCP headers refresh response was accepted. /// ///
    /// @@ -5860,12 +6766,12 @@ pub struct RemoteEnableResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteNotifySteerableChangedRequest { - /// Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. - pub remote_steerable: bool, +pub struct McpHeadersHandlePendingHeadersRefreshRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. +/// Recorded MCP server connection failure. /// ///
    /// @@ -5875,9 +6781,14 @@ pub struct RemoteNotifySteerableChangedRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteNotifySteerableChangedResult {} +pub struct McpServerFailureInfo { + /// Failure message produced when the MCP server connection failed. + pub message: String, + /// epoch-ms timestamp at which the failure was recorded. + pub timestamp: i64, +} -/// Remote session connection result. +/// Recorded MCP server pending-auth state. /// ///
    /// @@ -5887,14 +6798,12 @@ pub struct RemoteNotifySteerableChangedResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct RemoteSessionConnectionResult { - /// Metadata for a connected remote session. - pub metadata: ConnectedRemoteSessionMetadata, - /// SDK session ID for the connected remote session. - pub session_id: SessionId, +pub struct McpServerNeedsAuthInfo { + /// epoch-ms timestamp at which the server signalled it needs authentication. + pub timestamp: i64, } -/// Schema for the `ScheduleEntry` type. +/// Host-level state, omitted when no MCP host is initialized. /// ///
    /// @@ -5904,23 +6813,24 @@ pub struct RemoteSessionConnectionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ScheduleEntry { - /// Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. - #[serde(skip_serializing_if = "Option::is_none")] - pub display_prompt: Option, - /// Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). - pub id: i64, - /// Interval between scheduled ticks, in milliseconds. - pub interval_ms: i64, - /// ISO 8601 timestamp when the next tick is scheduled to fire. - pub next_run_at: String, - /// Prompt text that gets enqueued on every tick. - pub prompt: String, - /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). - pub recurring: bool, +pub struct McpHostState { + /// Names of currently-connected MCP clients. + pub clients: Vec, + /// Configured servers that are explicitly disabled. + pub disabled_servers: Vec, + /// Map of server name to recorded connection failure. + pub failed_servers: HashMap, + /// Configured servers filtered out by MCP server policy. + pub filtered_servers: Vec, + /// Whether third-party MCP servers are policy-enabled for this session. + pub mcp3p_enabled: bool, + /// Map of server name to recorded pending-auth state. + pub needs_auth_servers: HashMap, + /// Names of servers with in-flight connection attempts. + pub pending_connections: Vec, } -/// Snapshot of the currently active recurring prompts for this session. +/// Server name to check running status for. /// ///
    /// @@ -5930,12 +6840,12 @@ pub struct ScheduleEntry { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ScheduleList { - /// Active scheduled prompts, ordered by id. - pub entries: Vec, +pub struct McpIsServerRunningRequest { + /// Name of the MCP server to check + pub server_name: String, } -/// Identifier of the scheduled prompt to remove. +/// Whether the named MCP server is running. /// ///
    /// @@ -5945,12 +6855,12 @@ pub struct ScheduleList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ScheduleStopRequest { - /// Id of the scheduled prompt to remove. - pub id: i64, +pub struct McpIsServerRunningResult { + /// True if the server has an active client and transport. + pub running: bool, } -/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +/// Server name whose tool list should be returned. /// ///
    /// @@ -5960,29 +6870,12 @@ pub struct ScheduleStopRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ScheduleStopResult { - /// The removed entry, or omitted if no entry matched. - #[serde(skip_serializing_if = "Option::is_none")] - pub entry: Option, -} - -/// Secret values to add to the redaction filter. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SecretsAddFilterValuesRequest { - /// Raw secret values to register for redaction - pub values: Vec, -} - -/// Confirmation that the secret values were registered. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SecretsAddFilterValuesResult { - /// Whether the values were successfully registered - pub ok: bool, +pub struct McpListToolsRequest { + /// Name of the connected MCP server whose tools to list. + pub server_name: String, } -/// Blob attachment with inline base64-encoded data +/// Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block. /// ///
    /// @@ -5992,19 +6885,16 @@ pub struct SecretsAddFilterValuesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentBlob { - /// Base64-encoded content - pub data: String, - /// User-facing display name for the attachment +pub struct McpToolUi { + /// URI of the tool's MCP App resource, typically a `ui://` resource identifier. Use `session.mcp.resources.read` to fetch its HTML and resource metadata. #[serde(skip_serializing_if = "Option::is_none")] - pub display_name: Option, - /// MIME type of the inline data - pub mime_type: String, - /// Attachment type discriminator - pub r#type: SendAttachmentBlobType, + pub resource_uri: Option, + /// Tool visibility advertised by the server. When absent, MCP Apps defaults apply. + #[serde(skip_serializing_if = "Option::is_none")] + pub visibility: Option>, } -/// Directory attachment +/// MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata. /// ///
    /// @@ -6014,16 +6904,18 @@ pub struct SendAttachmentBlob { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentDirectory { - /// User-facing display name for the attachment - pub display_name: String, - /// Absolute directory path - pub path: String, - /// Attachment type discriminator - pub r#type: SendAttachmentDirectoryType, +pub struct McpTools { + /// Tool description, when provided. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Tool name. + pub name: String, + /// Normalized MCP Apps discovery metadata. An empty object indicates that a valid `_meta.ui` block was present without recognized fields. + #[serde(skip_serializing_if = "Option::is_none")] + pub ui: Option, } -/// Optional line range to scope the attachment to a specific section of the file +/// Tools exposed by the connected MCP server. Throws when the server is not connected. /// ///
    /// @@ -6033,14 +6925,12 @@ pub struct SendAttachmentDirectory { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentFileLineRange { - /// End line number (1-based, inclusive) - pub end: i64, - /// Start line number (1-based) - pub start: i64, +pub struct McpListToolsResult { + /// Tools exposed by the server. + pub tools: Vec, } -/// File attachment +/// Identifies the MCP server whose persisted OAuth credentials were updated. /// ///
    /// @@ -6050,44 +6940,36 @@ pub struct SendAttachmentFileLineRange { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentFile { - /// User-facing display name for the attachment - pub display_name: String, - /// Optional line range to scope the attachment to a specific section of the file +pub struct McpOauthAuthenticationStateChangedRequest { + /// Whether the target session must mint a session-scoped access token instead of reusing a shared access token persisted by another session. #[serde(skip_serializing_if = "Option::is_none")] - pub line_range: Option, - /// Absolute file path - pub path: String, - /// Attachment type discriminator - pub r#type: SendAttachmentFileType, + pub refresh_session_token: Option, + /// Name of the MCP server whose OAuth credentials were updated. Omit only when the host cannot identify the server. + #[serde(skip_serializing_if = "Option::is_none")] + pub server_name: Option, } -/// GitHub issue, pull request, or discussion reference -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentGithubReference { - /// Issue, pull request, or discussion number - pub number: i64, - /// Type of GitHub reference - pub reference_type: SendAttachmentGithubReferenceType, - /// Current state of the referenced item (e.g., open, closed, merged) - pub state: String, - /// Title of the referenced item - pub title: String, - /// Attachment type discriminator - pub r#type: SendAttachmentGithubReferenceType, - /// URL to the referenced item on GitHub - pub url: String, +pub struct McpOauthPendingRequestResponseToken { + /// Access token acquired by the SDK host + pub access_token: String, + /// Token lifetime in seconds, if known. + #[serde(skip_serializing_if = "Option::is_none")] + pub expires_in: Option, + pub kind: McpOauthPendingRequestResponseTokenKind, + /// OAuth token type. Defaults to Bearer when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub token_type: Option, } -/// End position of the selection +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthPendingRequestResponseCancelled { + pub kind: McpOauthPendingRequestResponseCancelledKind, +} + +/// Pending MCP OAuth request ID and host-provided token or cancellation response. /// ///
    /// @@ -6095,16 +6977,16 @@ pub struct SendAttachmentGithubReference { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentSelectionDetailsEnd { - /// End character offset within the line (0-based) - pub character: i64, - /// End line number (0-based) - pub line: i64, +pub struct McpOauthHandlePendingRequest { + /// OAuth request identifier from the mcp.oauth_required event + pub request_id: RequestId, + /// Host response to the pending OAuth request. + pub result: McpOauthPendingRequestResponse, } -/// Start position of the selection +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
    /// @@ -6114,14 +6996,12 @@ pub struct SendAttachmentSelectionDetailsEnd { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentSelectionDetailsStart { - /// Start character offset within the line (0-based) - pub character: i64, - /// Start line number (0-based) - pub line: i64, +pub struct McpOauthHandlePendingResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Position range of the selection within the file +/// Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. /// ///
    /// @@ -6131,14 +7011,33 @@ pub struct SendAttachmentSelectionDetailsStart { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentSelectionDetails { - /// End position of the selection - pub end: SendAttachmentSelectionDetailsEnd, - /// Start position of the selection - pub start: SendAttachmentSelectionDetailsStart, +pub struct McpOauthLoginRequest { + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub callback_success_message: Option, + /// Optional OAuth client ID override for this login. When set, the runtime uses this pre-registered static client instead of dynamic client registration. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_id: Option, + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Optional OAuth client secret override for this login. The runtime treats this as an ephemeral host-owned secret, uses it for this authentication attempt and does not persist it. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_secret: Option, + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub force_reauth: Option, + /// Optional OAuth grant type override for this login. Defaults to the server configuration, or authorization_code when no grant type is specified. + #[serde(skip_serializing_if = "Option::is_none")] + pub grant_type: Option, + /// Optional override indicating whether the static OAuth client is public. When false, the runtime treats it as confidential and uses the per-login clientSecret if provided, otherwise retrieving the client secret from the MCP OAuth secret store. + #[serde(skip_serializing_if = "Option::is_none")] + pub public_client: Option, + /// Name of the remote MCP server to authenticate + pub server_name: String, } -/// Code selection attachment from an editor +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. /// ///
    /// @@ -6148,20 +7047,13 @@ pub struct SendAttachmentSelectionDetails { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendAttachmentSelection { - /// User-facing display name for the selection - pub display_name: String, - /// Absolute path to the file containing the selection - pub file_path: String, - /// Position range of the selection within the file - pub selection: SendAttachmentSelectionDetails, - /// The selected text content - pub text: String, - /// Attachment type discriminator - pub r#type: SendAttachmentSelectionType, +pub struct McpOauthLoginResult { + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub authorization_url: Option, } -/// Parameters for sending a user message to the session +/// Pending MCP OAuth request id to respond to. /// ///
    /// @@ -6171,49 +7063,12 @@ pub struct SendAttachmentSelection { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendRequest { - /// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. - #[serde(skip_serializing_if = "Option::is_none")] - pub agent_mode: Option, - /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message - #[serde(skip_serializing_if = "Option::is_none")] - pub attachments: Option>, - /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. - #[serde(skip_serializing_if = "Option::is_none")] - pub billable: Option, - /// If provided, this is shown in the timeline instead of `prompt` - #[serde(skip_serializing_if = "Option::is_none")] - pub display_prompt: Option, - /// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. - #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// If true, adds the message to the front of the queue instead of the end - #[serde(skip_serializing_if = "Option::is_none")] - pub prepend: Option, - /// The user message text - pub prompt: String, - /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. - #[serde(skip_serializing_if = "Option::is_none")] - pub request_headers: Option>, - /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange - #[serde(skip_serializing_if = "Option::is_none")] - pub required_tool: Option, - /// Optional provenance tag copied to the resulting user.message event. Supported values are `system`, `command-*`, and `schedule-*`. - #[doc(hidden)] - #[serde(skip_serializing_if = "Option::is_none")] - pub(crate) source: Option, - /// W3C Trace Context traceparent header for distributed tracing of this agent turn - #[serde(skip_serializing_if = "Option::is_none")] - pub traceparent: Option, - /// W3C Trace Context tracestate header for distributed tracing - #[serde(skip_serializing_if = "Option::is_none")] - pub tracestate: Option, - /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. - #[serde(skip_serializing_if = "Option::is_none")] - pub wait: Option, +pub struct McpOauthRespondRequest { + /// OAuth request identifier from the mcp.oauth_required event + pub request_id: RequestId, } -/// Result of sending a user message +/// Indicates whether the pending MCP OAuth response was accepted. /// ///
    /// @@ -6223,42 +7078,36 @@ pub struct SendRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SendResult { - /// Unique identifier assigned to the message - pub message_id: String, -} - -/// Schema for the `ServerSkill` type. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ServerSkill { - /// Description of what the skill does - pub description: String, - /// Whether the skill is currently enabled (based on global config) - pub enabled: bool, - /// Unique identifier for the skill - pub name: String, - /// Absolute path to the skill file - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - /// The project path this skill belongs to (only for project/inherited skills) - #[serde(skip_serializing_if = "Option::is_none")] - pub project_path: Option, - /// Source location type (e.g., project, personal-copilot, plugin, builtin) - pub source: SkillSource, - /// Whether the skill can be invoked by the user as a slash command - pub user_invocable: bool, +pub struct McpOauthRespondResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, } -/// Skills discovered across global and project sources. +/// Registration parameters for an external MCP client. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ServerSkillList { - /// All discovered skills across all sources - pub skills: Vec, +pub(crate) struct McpRegisterExternalClientRequest { + /// In-process MCP Client instance. Marked internal: cannot be serialized across the JSON-RPC boundary. + #[doc(hidden)] + pub(crate) client: serde_json::Value, + /// In-process server config (MCPServerConfig) paired with the in-process client/transport. Marked internal alongside its companions. + #[doc(hidden)] + pub(crate) config: serde_json::Value, + /// Logical server name for the external client + pub server_name: String, + /// In-process MCP Transport instance. Marked internal: cannot be serialized across the JSON-RPC boundary. + #[doc(hidden)] + pub(crate) transport: serde_json::Value, } -/// Authentication status and account metadata for the session. +/// Opaque MCP reload configuration. /// ///
    /// @@ -6268,27 +7117,13 @@ pub struct ServerSkillList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAuthStatus { - /// Authentication type - #[serde(skip_serializing_if = "Option::is_none")] - pub auth_type: Option, - /// Copilot plan tier (e.g., individual_pro, business) - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_plan: Option, - /// Authentication host URL - #[serde(skip_serializing_if = "Option::is_none")] - pub host: Option, - /// Whether the session has resolved authentication - pub is_authenticated: bool, - /// Authenticated login/username, if available - #[serde(skip_serializing_if = "Option::is_none")] - pub login: Option, - /// Human-readable authentication status description - #[serde(skip_serializing_if = "Option::is_none")] - pub status_message: Option, +pub(crate) struct McpReloadWithConfigRequest { + /// Opaque runtime MCP reload configuration. Marked internal: an in-process runtime shape (reloadMcpServers throws over the wire). + #[doc(hidden)] + pub(crate) config: serde_json::Value, } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). /// ///
    /// @@ -6298,12 +7133,12 @@ pub struct SessionAuthStatus { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionBulkDeleteResult { - /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). - pub freed_bytes: HashMap, +pub struct McpRemoveGitHubResult { + /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). + pub removed: bool, } -/// Schema for the `SessionContext` type. +/// Standard MCP resource annotations plus preserved non-standard annotation fields. /// ///
    /// @@ -6313,24 +7148,22 @@ pub struct SessionBulkDeleteResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionContext { - /// Active git branch +pub struct McpResourceAnnotations { + /// Server-provided non-standard annotation fields preserved from the MCP response #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// Most recent working directory for this session - pub cwd: String, - /// Git repository root, if the cwd was inside a git repo + pub additional_properties: Option>, + /// Intended audience roles for this resource #[serde(skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Repository host type + pub audience: Option>, + /// Last-modified timestamp hint #[serde(skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Repository slug in `owner/name` form, when known + pub last_modified: Option, + /// Priority hint for model/client use #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, + pub priority: Option, } -/// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). +/// A resource icon descriptor plus preserved non-standard icon fields. /// ///
    /// @@ -6340,30 +7173,24 @@ pub struct SessionContext { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionContextInfo { - /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) - pub buffer_tokens: i64, - /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) - pub compaction_threshold: i64, - /// Tokens consumed by user/assistant/tool messages - pub conversation_tokens: i64, - /// Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. - pub limit: i64, - /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) - pub mcp_tools_tokens: i64, - /// The model used for token counting - pub model_name: String, - /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) - pub prompt_token_limit: i64, - /// Tokens consumed by the system prompt - pub system_tokens: i64, - /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) - pub tool_definitions_tokens: i64, - /// Sum of system, conversation and tool-definition tokens - pub total_tokens: i64, +pub struct McpResourceIcon { + /// Server-provided non-standard icon fields preserved from the MCP response + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_properties: Option>, + /// Icon MIME type, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Icon sizes hint + #[serde(skip_serializing_if = "Option::is_none")] + pub sizes: Option, + /// Icon URI + pub src: String, + /// Theme hint for this icon + #[serde(skip_serializing_if = "Option::is_none")] + pub theme: Option, } -/// Schema for the `SessionMetadata` type. +/// An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. /// ///
    /// @@ -6373,36 +7200,38 @@ pub struct SessionContextInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadata { - /// Runtime client name that created/last resumed this session +pub struct McpResource { + /// Resource-level metadata + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// Server-provided non-standard descriptor fields preserved from the MCP response #[serde(skip_serializing_if = "Option::is_none")] - pub client_name: Option, - /// Schema for the `SessionContext` type. + pub additional_properties: Option>, + /// Model/client annotations associated with this resource #[serde(skip_serializing_if = "Option::is_none")] - pub context: Option, - /// True for detached maintenance sessions that should be hidden from normal resume lists. + pub annotations: Option, + /// Optional description of what this resource represents #[serde(skip_serializing_if = "Option::is_none")] - pub is_detached: Option, - /// True for remote (GitHub) sessions; false for local - pub is_remote: bool, - /// GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control. + pub description: Option, + /// Icons associated with this resource #[serde(skip_serializing_if = "Option::is_none")] - pub mc_task_id: Option, - /// Last-modified time of the session's persisted state, as ISO 8601 - pub modified_time: String, - /// Optional human-friendly name set via /rename + pub icons: Option>, + /// MIME type of the resource, if known #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Stable session identifier - pub session_id: SessionId, - /// Session creation time as an ISO 8601 timestamp - pub start_time: String, - /// Short summary of the session, when one has been derived + pub mime_type: Option, + /// The programmatic name of the resource + pub name: String, + /// Resource size in bytes, when known #[serde(skip_serializing_if = "Option::is_none")] - pub summary: Option, + pub size: Option, + /// Optional human-readable display title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// The resource URI (e.g. ui://... or file:///...) + pub uri: String, } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata. /// ///
    /// @@ -6412,12 +7241,24 @@ pub struct SessionMetadata { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEnrichMetadataResult { - /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. - pub sessions: Vec, +pub struct McpResourceContent { + /// Resource-level metadata (CSP, permissions, etc.) + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// Base64-encoded binary content + #[serde(skip_serializing_if = "Option::is_none")] + pub blob: Option, + /// MIME type of the content + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Text content (e.g. HTML) + #[serde(skip_serializing_if = "Option::is_none")] + pub text: Option, + /// The resource URI + pub uri: String, } -/// File path, content to append, and optional mode for the client-provided session filesystem. +/// MCP server whose resources to enumerate. /// ///
    /// @@ -6427,19 +7268,15 @@ pub struct SessionEnrichMetadataResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsAppendFileRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, - /// Content to append - pub content: String, - /// Optional POSIX-style mode for newly created files +pub struct McpResourcesListRequest { + /// Opaque MCP pagination cursor from a prior `nextCursor` value #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, + pub cursor: Option, + /// Name of the MCP server whose resources to enumerate + pub server_name: String, } -/// Describes a filesystem error. +/// One page of resources advertised by the named MCP server. /// ///
    /// @@ -6449,15 +7286,15 @@ pub struct SessionFsAppendFileRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsError { - /// Error classification - pub code: SessionFsErrorCode, - /// Free-form detail about the error, for logging/diagnostics +pub struct McpResourcesListResult { + /// Opaque cursor for the next page, if the server has more resources #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, + pub next_cursor: Option, + /// Resources advertised by the server (proxied MCP `resources/list`) + pub resources: Vec, } -/// Path to test for existence in the client-provided session filesystem. +/// MCP server whose resource templates to enumerate. /// ///
    /// @@ -6467,14 +7304,15 @@ pub struct SessionFsError { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsExistsRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, +pub struct McpResourcesListTemplatesRequest { + /// Opaque MCP pagination cursor from a prior `nextCursor` value + #[serde(skip_serializing_if = "Option::is_none")] + pub cursor: Option, + /// Name of the MCP server whose resource templates to enumerate + pub server_name: String, } -/// Indicates whether the requested path exists in the client-provided session filesystem. +/// An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`. /// ///
    /// @@ -6484,12 +7322,35 @@ pub struct SessionFsExistsRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsExistsResult { - /// Whether the path exists - pub exists: bool, +pub struct McpResourceTemplate { + /// Resource-template-level metadata + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option>, + /// Server-provided non-standard descriptor fields preserved from the MCP response + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_properties: Option>, + /// Model/client annotations associated with this template + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, + /// Optional description of what this template is for + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Icons associated with resources matching this template + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + /// MIME type for resources matching this template, if uniform + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// The programmatic name of the resource template + pub name: String, + /// Optional human-readable display title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// An RFC 6570 URI template for constructing resource URIs + pub uri_template: String, } -/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. +/// One page of resource templates advertised by the named MCP server. /// ///
    /// @@ -6499,20 +7360,15 @@ pub struct SessionFsExistsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsMkdirRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, - /// Create parent directories as needed - #[serde(skip_serializing_if = "Option::is_none")] - pub recursive: Option, - /// Optional POSIX-style mode for newly created directories +pub struct McpResourcesListTemplatesResult { + /// Opaque cursor for the next page, if the server has more resource templates #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, + pub next_cursor: Option, + /// Resource templates advertised by the server (proxied MCP `resources/templates/list`) + pub resource_templates: Vec, } -/// Directory path whose entries should be listed from the client-provided session filesystem. +/// MCP server and resource URI to fetch. /// ///
    /// @@ -6522,14 +7378,14 @@ pub struct SessionFsMkdirRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReaddirRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, +pub struct McpResourcesReadRequest { + /// Name of the MCP server hosting the resource + pub server_name: String, + /// Resource URI + pub uri: String, } -/// Names of entries in the requested directory, or a filesystem error if the read failed. +/// Resource contents returned by the MCP server. /// ///
    /// @@ -6539,15 +7395,12 @@ pub struct SessionFsReaddirRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReaddirResult { - /// Entry names in the directory - pub entries: Vec, - /// Describes a filesystem error. - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, +pub struct McpResourcesReadResult { + /// Resource contents returned by the server + pub contents: Vec, } -/// Schema for the `SessionFsReaddirWithTypesEntry` type. +/// Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. /// ///
    /// @@ -6557,14 +7410,15 @@ pub struct SessionFsReaddirResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReaddirWithTypesEntry { - /// Entry name - pub name: String, - /// Entry type - pub r#type: SessionFsReaddirWithTypesEntryType, +pub struct McpRestartServerRequest { + /// Replacement MCP server configuration (stdio process or remote HTTP/SSE). Omit to restart the server with its already-registered configuration (config-free restart-by-name). + #[serde(skip_serializing_if = "Option::is_none")] + pub config: Option, + /// Name of the MCP server to restart + pub server_name: String, } -/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. /// ///
    /// @@ -6574,14 +7428,18 @@ pub struct SessionFsReaddirWithTypesEntry { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReaddirWithTypesRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, +pub struct McpSamplingExecutionResult { + /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. + pub action: McpSamplingExecutionAction, + /// Error description, present when action='failure'. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, } -/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. +/// MCP server status entry, including config source/plugin source and any connection error. /// ///
    /// @@ -6591,15 +7449,26 @@ pub struct SessionFsReaddirWithTypesRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReaddirWithTypesResult { - /// Directory entries with type information - pub entries: Vec, - /// Describes a filesystem error. +pub struct McpServer { + /// Error message if the server failed to connect #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, + pub error: Option, + /// Server name (config key) + pub name: String, + /// Configuration source: user, workspace, plugin, or builtin + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Plugin name that provided this server, when source is plugin. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin: Option, + /// Plugin version that provided this server, when source is plugin. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_plugin_version: Option, + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured + pub status: McpServerStatus, } -/// Path of the file to read from the client-provided session filesystem. +/// Authentication settings with optional redirect port configuration. /// ///
    /// @@ -6609,14 +7478,13 @@ pub struct SessionFsReaddirWithTypesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReadFileRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, +pub struct McpServerAuthConfigRedirectPort { + /// Fixed port for the OAuth redirect callback server. + #[serde(skip_serializing_if = "Option::is_none")] + pub redirect_port: Option, } -/// File content as a UTF-8 string, or a filesystem error if the read failed. +/// Remote MCP server configuration accessed over HTTP or SSE. /// ///
    /// @@ -6626,15 +7494,51 @@ pub struct SessionFsReadFileRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsReadFileResult { - /// File content as UTF-8 string - pub content: String, - /// Describes a filesystem error. +pub struct McpServerConfigHttp { + /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, + pub auth: Option, + /// Controls if tools provided by this server can be loaded on demand via tool search (auto) or always included in the initial tool list (never) + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_tools: Option, + /// Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_tool_cache: Option, + /// Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub filter_mapping: Option, + /// HTTP headers to include in requests to the remote MCP server. + #[serde(skip_serializing_if = "Option::is_none")] + pub headers: Option>, + /// Whether this server is a built-in fallback used when the user has not configured their own server. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_default_server: Option, + /// OAuth client ID for a pre-registered remote MCP OAuth client. + #[serde(skip_serializing_if = "Option::is_none")] + pub oauth_client_id: Option, + /// OAuth grant type to use when authenticating to the remote MCP server. + #[serde(skip_serializing_if = "Option::is_none")] + pub oauth_grant_type: Option, + /// Whether the configured OAuth client is public and does not require a client secret. + #[serde(skip_serializing_if = "Option::is_none")] + pub oauth_public_client: Option, + /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub oidc: Option, + /// Timeout in milliseconds for tool calls to this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout: Option, + /// Tools to include. Defaults to all tools if not specified. + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option>, + /// Remote transport type. Defaults to "http" when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, + /// URL of the remote MCP server endpoint. + pub url: String, } -/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. +/// Stdio MCP server configuration launched as a child process. /// ///
    /// @@ -6644,16 +7548,45 @@ pub struct SessionFsReadFileResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsRenameRequest { - /// Target session identifier - pub session_id: SessionId, - /// Source path using SessionFs conventions - pub src: String, - /// Destination path using SessionFs conventions - pub dest: String, +pub struct McpServerConfigStdio { + /// Command-line arguments passed to the Stdio MCP server process. + #[serde(skip_serializing_if = "Option::is_none")] + pub args: Option>, + /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub auth: Option, + /// Executable command used to start the Stdio MCP server process. + pub command: String, + /// Working directory for the Stdio MCP server process. + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Controls if tools provided by this server can be loaded on demand via tool search (auto) or always included in the initial tool list (never) + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_tools: Option, + /// Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_tool_cache: Option, + /// Environment variables to pass to the Stdio MCP server process. + #[serde(skip_serializing_if = "Option::is_none")] + pub env: Option>, + /// Content filtering mode to apply to all tools, or a map of tool name to content filtering mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub filter_mapping: Option, + /// Whether this server is a built-in fallback used when the user has not configured their own server. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_default_server: Option, + /// Set to `true` to use defaults, or provide an object with additional auth or OIDC settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub oidc: Option, + /// Timeout in milliseconds for tool calls to this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout: Option, + /// Tools to include. Defaults to all tools if not specified. + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option>, } -/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. +/// MCP servers configured for the session, with their connection status and host-level state. /// ///
    /// @@ -6663,52 +7596,63 @@ pub struct SessionFsRenameRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsRmRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, - /// Remove directories and their contents recursively - #[serde(skip_serializing_if = "Option::is_none")] - pub recursive: Option, - /// Ignore errors if the path does not exist +pub struct McpServerList { + /// Host-level state, omitted when no MCP host is initialized. #[serde(skip_serializing_if = "Option::is_none")] - pub force: Option, + pub host: Option, + /// Configured MCP servers + pub servers: Vec, } -/// Optional capabilities declared by the provider +/// Mode controlling how MCP server env values are resolved (`direct` or `indirect`). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSetProviderCapabilities { - /// Whether the provider supports SQLite query/exists operations - #[serde(skip_serializing_if = "Option::is_none")] - pub sqlite: Option, +pub struct McpSetEnvValueModeParams { + /// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". + pub mode: McpSetEnvValueModeDetails, } -/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. +/// Env-value mode recorded on the session after the update. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSetProviderRequest { - /// Optional capabilities declared by the provider - #[serde(skip_serializing_if = "Option::is_none")] - pub capabilities: Option, - /// Path conventions used by this filesystem - pub conventions: SessionFsSetProviderConventions, - /// Initial working directory for sessions - pub initial_cwd: String, - /// Path within each session's SessionFs where the runtime stores files for that session - pub session_state_path: String, +pub struct McpSetEnvValueModeResult { + /// Mode recorded on the session after the update + pub mode: McpSetEnvValueModeDetails, } -/// Indicates whether the calling client was registered as the session filesystem provider. +/// Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSetProviderResult { - /// Whether the provider was set successfully - pub success: bool, +pub struct McpStartServerRequest { + /// MCP server configuration (stdio process or remote HTTP/SSE). Omit to start the server with its already-registered configuration (config-free start-by-name). + #[serde(skip_serializing_if = "Option::is_none")] + pub config: Option, + /// Name of the MCP server to start + pub server_name: String, } -/// Indicates whether the per-session SQLite database already exists. +/// MCP server startup filtering result. /// ///
    /// @@ -6718,12 +7662,15 @@ pub struct SessionFsSetProviderResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSqliteExistsResult { - /// Whether the session database already exists - pub exists: bool, +pub struct McpStartServersResult { + /// Non-default servers allowed by policy + #[serde(skip_serializing_if = "Option::is_none")] + pub allowed_servers: Option>, + /// Servers filtered out before startup + pub filtered_servers: Vec, } -/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. +/// Server name for an individual MCP server stop. /// ///
    /// @@ -6733,19 +7680,12 @@ pub struct SessionFsSqliteExistsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSqliteQueryRequest { - /// Target session identifier - pub session_id: SessionId, - /// SQL query to execute - pub query: String, - /// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) - pub query_type: SessionFsSqliteQueryType, - /// Optional named bind parameters - #[serde(skip_serializing_if = "Option::is_none")] - pub params: Option>, +pub struct McpStopServerRequest { + /// Name of the MCP server to stop + pub server_name: String, } -/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. +/// Server name identifying the external client to remove. /// ///
    /// @@ -6755,22 +7695,100 @@ pub struct SessionFsSqliteQueryRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSqliteQueryResult { - /// Column names from the result set - pub columns: Vec, - /// Describes a filesystem error. +pub(crate) struct McpUnregisterExternalClientRequest { + /// Server name of the external client to unregister + pub server_name: String, +} + +/// Memory configuration for this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MemoryConfiguration { + /// Whether memory is enabled for the session. + pub enabled: bool, +} + +/// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MetadataContextAttributionResultContextAttributionCategories { + /// Output reserve plus post-blocking-threshold buffer. + pub buffer: i64, + /// Custom-instructions tokens (0 when none are configured). + pub custom_instructions: i64, + /// Remaining unused window capacity (clamped at 0). + pub free_space: i64, + /// MCP tool-definition tokens. + pub mcp_tools: i64, + /// Conversation (user/assistant/tool) message tokens. + pub messages: i64, + /// System prompt tokens, excluding custom instructions. + pub system_prompt: i64, + /// Non-MCP tool-definition tokens. + pub system_tools: i64, +} + +/// Successful compaction history for the session. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MetadataContextAttributionResultContextAttributionCompactions { + /// Number of successful compactions in this session. + pub count: i64, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MetadataContextAttributionResultContextAttributionEntriesItem { + /// Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// SQLite last_insert_rowid() value for INSERT. + pub attributes: Option>, + /// Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. + pub id: String, + /// Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + pub kind: String, + /// Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. + pub label: String, + /// Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. #[serde(skip_serializing_if = "Option::is_none")] - pub last_insert_rowid: Option, - /// For SELECT: array of row objects. For others: empty array. - pub rows: Vec>, - /// Number of rows affected (for INSERT/UPDATE/DELETE) - pub rows_affected: i64, + pub parent_id: Option, + /// Token count currently in context attributable to this entry. + pub tokens: i64, } -/// Path whose metadata should be returned from the client-provided session filesystem. +/// Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MetadataContextAttributionResultContextAttribution { + /// Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. + pub buffer_tokens: i64, + /// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. + pub categories: MetadataContextAttributionResultContextAttributionCategories, + /// Successful compaction history for the session. + pub compactions: MetadataContextAttributionResultContextAttributionCompactions, + /// Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. + pub compaction_threshold: i64, + /// Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. + pub entries: Vec, + /// Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. + pub limit: i64, + /// The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. + pub model_id: String, + /// How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). + pub model_source: String, + /// Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + pub prompt_token_limit: i64, + /// Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. + pub total_tokens: i64, +} + +/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. /// ///
    /// @@ -6780,14 +7798,12 @@ pub struct SessionFsSqliteQueryResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsStatRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, +pub struct MetadataContextAttributionResult { + /// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + pub context_attribution: Option, } -/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. +/// Parameters for the heaviest-messages query. /// ///
    /// @@ -6797,23 +7813,13 @@ pub struct SessionFsStatRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsStatResult { - /// ISO 8601 timestamp of creation - pub birthtime: String, - /// Describes a filesystem error. +pub struct MetadataContextHeaviestMessagesRequest { + /// Maximum number of messages to return, most-expensive first. Omit for the server default. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether the path is a directory - pub is_directory: bool, - /// Whether the path is a file - pub is_file: bool, - /// ISO 8601 timestamp of last modification - pub mtime: String, - /// File size in bytes - pub size: i64, + pub limit: Option, } -/// File path, content to write, and optional mode for the client-provided session filesystem. +/// The heaviest individual messages in the session's context window, most-expensive first. /// ///
    /// @@ -6823,19 +7829,14 @@ pub struct SessionFsStatResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsWriteFileRequest { - /// Target session identifier - pub session_id: SessionId, - /// Path using SessionFs conventions - pub path: String, - /// Content to write - pub content: String, - /// Optional POSIX-style mode for newly created files - #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, +pub struct MetadataContextHeaviestMessagesResult { + /// Heaviest messages, most-expensive first. + pub messages: Vec, + /// Total token count of the current context window, so callers can compute each message's share without a second call. + pub total_tokens: i64, } -/// Schema for the `SessionInstalledPlugin` type. +/// Model identifier and token limits used to compute the context-info breakdown. /// ///
    /// @@ -6845,28 +7846,43 @@ pub struct SessionFsWriteFileRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstalledPlugin { - /// Path where the plugin is cached locally - #[serde(rename = "cache_path", skip_serializing_if = "Option::is_none")] - pub cache_path: Option, - /// Whether the plugin is currently enabled - pub enabled: bool, - /// Installation timestamp (ISO-8601) - #[serde(rename = "installed_at")] - pub installed_at: String, - /// Marketplace the plugin came from (empty string for direct repo installs) - pub marketplace: String, - /// Plugin name - pub name: String, - /// Source descriptor for direct repo installs (when marketplace is empty) - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option, - /// Installed version, if known +pub struct MetadataContextInfoRequest { + /// Maximum output tokens allowed by the target model. Pass 0 if unknown. + pub output_token_limit: i64, + /// Maximum prompt tokens allowed by the target model. Pass 0 to use the runtime default. + pub prompt_token_limit: i64, + /// Model identifier used for tokenization. Omit to use the session default. Used both for token counting and to compute display values. #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option, + pub selected_model: Option, +} + +/// Token-usage breakdown for the session's current context window +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct MetadataContextInfoResultContextInfo { + /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) + pub buffer_tokens: i64, + /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) + pub compaction_threshold: i64, + /// Tokens consumed by user/assistant/tool messages + pub conversation_tokens: i64, + /// Prompt token limit plus the model's full output token limit. + pub limit: i64, + /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) + pub mcp_tools_tokens: i64, + /// The model used for token counting + pub model_name: String, + /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) + pub prompt_token_limit: i64, + /// Tokens consumed by the system prompt + pub system_tokens: i64, + /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) + pub tool_definitions_tokens: i64, + /// Sum of system, conversation and tool-definition tokens + pub total_tokens: i64, } -/// Schema for the `SessionInstalledPluginSourceGithub` type. +/// Token breakdown for the session's current context window, or null if uninitialized. /// ///
    /// @@ -6876,17 +7892,12 @@ pub struct SessionInstalledPlugin { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstalledPluginSourceGithub { - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub r#ref: Option, - pub repo: String, - /// Constant value. Always "github". - pub source: SessionInstalledPluginSourceGithubSource, +pub struct MetadataContextInfoResult { + /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + pub context_info: Option, } -/// Schema for the `SessionInstalledPluginSourceLocal` type. +/// Indicates whether the local session is currently processing a turn or background continuation. /// ///
    /// @@ -6896,13 +7907,12 @@ pub struct SessionInstalledPluginSourceGithub { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstalledPluginSourceLocal { - pub path: String, - /// Constant value. Always "local". - pub source: SessionInstalledPluginSourceLocalSource, +pub struct MetadataIsProcessingResult { + /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. + pub processing: bool, } -/// Schema for the `SessionInstalledPluginSourceUrl` type. +/// Model identifier to use when re-tokenizing the session's existing messages. /// ///
    /// @@ -6912,17 +7922,12 @@ pub struct SessionInstalledPluginSourceLocal { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstalledPluginSourceUrl { - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub r#ref: Option, - /// Constant value. Always "url". - pub source: SessionInstalledPluginSourceUrlSource, - pub url: String, +pub struct MetadataRecomputeContextTokensRequest { + /// Model identifier used for tokenization. The runtime token-counts both chat-context and system-context messages against this model. + pub model_id: String, } -/// Persisted sessions matching the filter, ordered most-recently-modified first. +/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. /// ///
    /// @@ -6932,12 +7937,16 @@ pub struct SessionInstalledPluginSourceUrl { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionList { - /// Sessions ordered most-recently-modified first - pub sessions: Vec, +pub struct MetadataRecomputeContextTokensResult { + /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). + pub messages_token_count: i64, + /// Tokens contributed by system/developer prompt snapshots. + pub system_token_count: i64, + /// Sum of tokens across chat-context and system-context messages currently held by the session. + pub total_tokens: i64, } -/// Optional filter applied to the returned sessions +/// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. /// ///
    /// @@ -6947,22 +7956,33 @@ pub struct SessionList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionListFilter { - /// Match sessions whose context.branch equals this value +pub struct SessionWorkingDirectoryContext { + /// Merge-base commit SHA (fork point from the remote default branch) #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// Match sessions whose context.cwd equals this value + pub base_commit: Option, + /// Current git branch name #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Match sessions whose context.gitRoot equals this value + pub branch: Option, + /// Current working directory path + pub cwd: String, + /// Root directory of the git repository, resolved via git rev-parse #[serde(skip_serializing_if = "Option::is_none")] pub git_root: Option, - /// Match sessions whose context.repository equals this value + /// Head commit of the current git branch + #[serde(skip_serializing_if = "Option::is_none")] + pub head_commit: Option, + /// Hosting platform type of the repository + #[serde(skip_serializing_if = "Option::is_none")] + pub host_type: Option, + /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) #[serde(skip_serializing_if = "Option::is_none")] pub repository: Option, + /// Raw host string from the git remote URL (e.g. "github.com", "dev.azure.com") + #[serde(skip_serializing_if = "Option::is_none")] + pub repository_host: Option, } -/// Queued repo-level startup prompts and the total hook command count after loading. +/// Updated working-directory/git context to record on the session. /// ///
    /// @@ -6972,46 +7992,24 @@ pub struct SessionListFilter { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionLoadDeferredRepoHooksResult { - /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. - pub hook_count: i64, - /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. - pub startup_prompts: Vec, +pub struct MetadataRecordContextChangeRequest { + /// Updated working directory and git context. Emitted as the new payload of `session.context_changed`. + pub context: SessionWorkingDirectoryContext, } -/// Public-facing projection of workspace metadata for SDK / TUI consumers +/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSnapshotWorkspace { - /// Branch checked out at session start, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// ISO 8601 timestamp when the workspace was created - #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] - pub created_at: Option, - /// Current working directory at session start - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Resolved git root for cwd, if any - #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Repository host type, if known - #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Workspace identifier (1:1 with sessionId) - pub id: String, - /// Display name for the session, if set - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - /// ISO 8601 timestamp when the workspace was last updated - #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] - pub updated_at: Option, -} +pub struct MetadataRecordContextChangeResult {} -/// Point-in-time snapshot of slow-changing session identifier and state fields +/// Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. /// ///
    /// @@ -7021,43 +8019,12 @@ pub struct SessionMetadataSnapshotWorkspace { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSnapshot { - /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. - pub already_in_use: bool, - /// Runtime client name associated with the session (telemetry identifier). - #[serde(skip_serializing_if = "Option::is_none")] - pub client_name: Option, - /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') - pub current_mode: MetadataSnapshotCurrentMode, - /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. - #[serde(skip_serializing_if = "Option::is_none")] - pub initial_name: Option, - /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) - pub is_remote: bool, - /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. - pub modified_time: String, - /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. - #[serde(skip_serializing_if = "Option::is_none")] - pub remote_metadata: Option, - /// Currently selected model identifier, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub selected_model: Option, - /// The unique identifier of the session - pub session_id: SessionId, - /// ISO 8601 timestamp of when the session started - pub start_time: String, - /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. - #[serde(skip_serializing_if = "Option::is_none")] - pub summary: Option, - /// Absolute path to the session's current working directory +pub struct MetadataSetWorkingDirectoryRequest { + /// Absolute path to set as the session's working directory. The runtime updates the session's recorded cwd so subsequent operations (shell tools, file lookups, telemetry) anchor to it. pub working_directory: String, - /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). - pub workspace: Option, - /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace - pub workspace_path: Option, } -/// The list of models available to this session. +/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. /// ///
    /// @@ -7067,15 +8034,12 @@ pub struct SessionMetadataSnapshot { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelList { - /// Available models, ordered with the most preferred default first. - pub list: Vec, - /// Per-quota snapshots returned alongside the model list, keyed by quota type. - #[serde(skip_serializing_if = "Option::is_none")] - pub quota_snapshots: Option>, +pub struct MetadataSetWorkingDirectoryResult { + /// Working directory after the update + pub working_directory: String, } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// The repository the remote session targets. /// ///
    /// @@ -7085,20 +8049,16 @@ pub struct SessionModelList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPruneResult { - /// Session IDs that would be deleted in dry-run mode (always empty otherwise) - pub candidates: Vec, - /// Session IDs that were deleted (always empty in dry-run mode) - pub deleted: Vec, - /// True when no deletions were actually performed - pub dry_run: bool, - /// Total bytes freed (actual when not dry-run, projected when dry-run) - pub freed_bytes: i64, - /// Session IDs that were skipped (e.g., named sessions) - pub skipped: Vec, +pub struct MetadataSnapshotRemoteMetadataRepository { + /// The branch the remote session is operating on. + pub branch: String, + /// The GitHub repository name (without owner). + pub name: String, + /// The GitHub owner (user or organization) of the target repository. + pub owner: String, } -/// Session IDs to close, deactivate, and delete from disk. +/// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. /// ///
    /// @@ -7108,12 +8068,21 @@ pub struct SessionPruneResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsBulkDeleteRequest { - /// Session IDs to close, deactivate, and delete from disk - pub session_ids: Vec, +pub struct MetadataSnapshotRemoteMetadata { + /// The pull request number the remote session is associated with, if any. + #[serde(skip_serializing_if = "Option::is_none")] + pub pull_request_number: Option, + /// The repository the remote session targets. + pub repository: MetadataSnapshotRemoteMetadataRepository, + /// The original resource identifier (task ID or PR node ID), preserved across event-replay reconstructions. Falls back to `sessionId` when absent. + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_id: Option, + /// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. + #[serde(skip_serializing_if = "Option::is_none")] + pub task_type: Option, } -/// Session IDs to test for live in-use locks. +/// Active server-driven promotion for a model, including its discount and optional expiry. /// ///
    /// @@ -7123,12 +8092,22 @@ pub struct SessionsBulkDeleteRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsCheckInUseRequest { - /// Session IDs to test for live in-use locks - pub session_ids: Vec, +pub struct ModelBillingPromo { + /// Percentage discount (0-100) applied while the promotion is active. May be fractional. + #[serde(skip_serializing_if = "Option::is_none")] + pub discount_percent: Option, + /// UTC ISO 8601 timestamp marking when the promotion ends. Optional: an open-ended promotion omits this field. When present, the API only surfaces a promo whose expiry parses and is in the future, so consumers should treat a past value as expired. + #[serde(skip_serializing_if = "Option::is_none")] + pub ends_at: Option, + /// Stable identifier for the promotion campaign. + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + /// Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, } -/// Session IDs from the input set that are currently in use by another process. +/// Long context tier pricing (available for models with extended context windows) /// ///
    /// @@ -7138,12 +8117,35 @@ pub struct SessionsCheckInUseRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsCheckInUseResult { - /// Session IDs from the input set that are currently held by another running process via an alive lock file - pub in_use: Vec, +pub struct ModelBillingTokenPricesLongContext { + /// Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_price: Option, + /// AI Credits cost per billing batch of cached (read) tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_read_price: Option, + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write_price: Option, + /// Use maxPromptTokens instead. Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub context_max: Option, + /// AI Credits cost per billing batch of input tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub input_price: Option, + /// Prompt token budget for the long context tier. The total context window is this value plus the model's max_output_tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// AI Credits cost per billing batch of output tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub output_price: Option, } -/// Session ID to close. +/// Token-level pricing information for this model /// ///
    /// @@ -7153,12 +8155,41 @@ pub struct SessionsCheckInUseResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsCloseRequest { - /// Session ID to close - pub session_id: SessionId, +pub struct ModelBillingTokenPrices { + /// Number of tokens per standard billing batch + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size: Option, + /// Use cacheReadPrice instead. AI Credits cost per billing batch of cached tokens + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_price: Option, + /// AI Credits cost per billing batch of cached (read) tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_read_price: Option, + /// AI Credits cost per billing batch of cache-write (cache creation) tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_write_price: Option, + /// Use maxPromptTokens instead. Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub context_max: Option, + /// AI Credits cost per billing batch of input tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub input_price: Option, + /// Long context tier pricing (available for models with extended context windows) + #[serde(skip_serializing_if = "Option::is_none")] + pub long_context: Option, + /// Prompt token budget for the default tier. The total context window is this value plus the model's max_output_tokens. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// AI Credits cost per billing batch of output tokens + #[serde(skip_serializing_if = "Option::is_none")] + pub output_price: Option, } -/// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. +/// Billing information /// ///
    /// @@ -7168,9 +8199,22 @@ pub struct SessionsCloseRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsCloseResult {} +pub struct ModelBilling { + /// Whole-number percentage discount (0-100) applied to usage billed through this model. Populated for the synthetic `auto` model, where requests routed by auto-mode are billed at a reduced rate; absent for concrete models. + #[serde(skip_serializing_if = "Option::is_none")] + pub discount_percent: Option, + /// Billing cost multiplier relative to the base rate + #[serde(skip_serializing_if = "Option::is_none")] + pub multiplier: Option, + /// Active server-driven promotion for this model, if any. Present when the model is being promoted with a discount, which may be time-boxed or open-ended. + #[serde(skip_serializing_if = "Option::is_none")] + pub promo: Option, + /// Token-level pricing information for this model + #[serde(skip_serializing_if = "Option::is_none")] + pub token_prices: Option, +} -/// Session metadata records to enrich with summary and context information. +/// Vision-specific limits /// ///
    /// @@ -7180,12 +8224,19 @@ pub struct SessionsCloseResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsEnrichMetadataRequest { - /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. - pub sessions: Vec, +pub struct ModelCapabilitiesLimitsVision { + /// Maximum image size in bytes + #[serde(rename = "max_prompt_image_size")] + pub max_prompt_image_size: i64, + /// Maximum number of images per prompt + #[serde(rename = "max_prompt_images")] + pub max_prompt_images: i64, + /// MIME types the model accepts + #[serde(rename = "supported_media_types")] + pub supported_media_types: Vec, } -/// New auth credentials to install on the session. Omit to leave credentials unchanged. +/// Token limits for prompts, outputs, and context window /// ///
    /// @@ -7195,13 +8246,25 @@ pub struct SessionsEnrichMetadataRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSetCredentialsParams { - /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. +pub struct ModelCapabilitiesLimits { + /// Maximum total context window size in tokens + #[serde( + rename = "max_context_window_tokens", + skip_serializing_if = "Option::is_none" + )] + pub max_context_window_tokens: Option, + /// Maximum number of output/completion tokens + #[serde(rename = "max_output_tokens", skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Maximum number of prompt/input tokens + #[serde(rename = "max_prompt_tokens", skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// Vision-specific limits #[serde(skip_serializing_if = "Option::is_none")] - pub credentials: Option, + pub vision: Option, } -/// Indicates whether the credential update succeeded. +/// Feature flags indicating what the model supports /// ///
    /// @@ -7211,12 +8274,19 @@ pub struct SessionSetCredentialsParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSetCredentialsResult { - /// Whether the operation succeeded - pub success: bool, +pub struct ModelCapabilitiesSupports { + /// Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + #[serde(rename = "adaptive_thinking", skip_serializing_if = "Option::is_none")] + pub adaptive_thinking: Option, + /// Whether this model supports reasoning effort configuration + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Whether this model supports vision/image input + #[serde(skip_serializing_if = "Option::is_none")] + pub vision: Option, } -/// UUID prefix to resolve to a unique session ID. +/// Model capabilities and limits /// ///
    /// @@ -7226,12 +8296,16 @@ pub struct SessionSetCredentialsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsFindByPrefixRequest { - /// UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when there is no match or the prefix matches multiple sessions. - pub prefix: String, +pub struct ModelCapabilities { + /// Token limits for prompts, outputs, and context window + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Feature flags indicating what the model supports + #[serde(skip_serializing_if = "Option::is_none")] + pub supports: Option, } -/// Session ID matching the prefix, omitted when no unique match exists. +/// Policy state (if applicable) /// ///
    /// @@ -7241,13 +8315,15 @@ pub struct SessionsFindByPrefixRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsFindByPrefixResult { - /// Omitted when no unique session matches the prefix (no match or ambiguous) +pub struct ModelPolicy { + /// Current policy state for this model + pub state: ModelPolicyState, + /// Usage terms or conditions for this model #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, + pub terms: Option, } -/// GitHub task ID to look up. +/// Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories. /// ///
    /// @@ -7257,28 +8333,59 @@ pub struct SessionsFindByPrefixResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsFindByTaskIDRequest { - /// GitHub task ID to look up - pub task_id: String, -} - -/// ID of the local session bound to the given GitHub task, or omitted when none. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface +pub struct Model { + /// Billing information + #[serde(skip_serializing_if = "Option::is_none")] + pub billing: Option, + /// Model capabilities and limits + pub capabilities: ModelCapabilities, + /// Model identifier (e.g., "claude-sonnet-4.5") + pub id: String, + /// Model capability category for grouping in the model picker + #[serde(skip_serializing_if = "Option::is_none")] + pub model_picker_category: Option, + /// Relative cost tier for token-based billing users + #[serde(skip_serializing_if = "Option::is_none")] + pub model_picker_price_category: Option, + /// Display name + pub name: String, + /// Policy state (if applicable) + #[serde(skip_serializing_if = "Option::is_none")] + pub policy: Option, + /// Supported reasoning effort levels (only present if model supports reasoning effort) + #[serde(skip_serializing_if = "Option::is_none")] + pub supported_reasoning_efforts: Option>, +} + +/// Vision-specific limits +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface /// and may change or be removed in future SDK or CLI releases. /// ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsFindByTaskIDResult { - /// Omitted when no local session is bound to that GitHub task - #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, +pub struct ModelCapabilitiesOverrideLimitsVision { + /// Maximum image size in bytes + #[serde( + rename = "max_prompt_image_size", + skip_serializing_if = "Option::is_none" + )] + pub max_prompt_image_size: Option, + /// Maximum number of images per prompt + #[serde(rename = "max_prompt_images", skip_serializing_if = "Option::is_none")] + pub max_prompt_images: Option, + /// MIME types the model accepts + #[serde( + rename = "supported_media_types", + skip_serializing_if = "Option::is_none" + )] + pub supported_media_types: Option>, } -/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. +/// Token limits for prompts, outputs, and context window /// ///
    /// @@ -7288,18 +8395,25 @@ pub struct SessionsFindByTaskIDResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsForkRequest { - /// Optional friendly name to assign to the forked session. - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Source session ID to fork from - pub session_id: SessionId, - /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included. +pub struct ModelCapabilitiesOverrideLimits { + /// Maximum total context window size in tokens + #[serde( + rename = "max_context_window_tokens", + skip_serializing_if = "Option::is_none" + )] + pub max_context_window_tokens: Option, + /// Maximum number of output/completion tokens + #[serde(rename = "max_output_tokens", skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Maximum number of prompt/input tokens + #[serde(rename = "max_prompt_tokens", skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// Vision-specific limits #[serde(skip_serializing_if = "Option::is_none")] - pub to_event_id: Option, + pub vision: Option, } -/// Identifier and optional friendly name assigned to the newly forked session. +/// Feature flags indicating what the model supports /// ///
    /// @@ -7309,15 +8423,19 @@ pub struct SessionsForkRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsForkResult { - /// Friendly name assigned to the forked session, if any. +pub struct ModelCapabilitiesOverrideSupports { + /// Resolved Anthropic adaptive-thinking capability — unsupported / optional / required. 'required' models reject thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8). + #[serde(rename = "adaptive_thinking", skip_serializing_if = "Option::is_none")] + pub adaptive_thinking: Option, + /// Whether this model supports reasoning effort configuration #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// The new forked session's ID - pub session_id: SessionId, + pub reasoning_effort: Option, + /// Whether this model supports vision/image input + #[serde(skip_serializing_if = "Option::is_none")] + pub vision: Option, } -/// Session ID whose event-log file path to compute. +/// Optional capability overrides (vision, tool_calls, reasoning, etc.). /// ///
    /// @@ -7327,12 +8445,16 @@ pub struct SessionsForkResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetEventFilePathRequest { - /// Session ID whose event-log file path to compute - pub session_id: SessionId, +pub struct ModelCapabilitiesOverride { + /// Token limits for prompts, outputs, and context window + #[serde(skip_serializing_if = "Option::is_none")] + pub limits: Option, + /// Feature flags indicating what the model supports + #[serde(skip_serializing_if = "Option::is_none")] + pub supports: Option, } -/// Absolute path to the session's events.jsonl file on disk. +/// List of Copilot models available to the resolved user, including capabilities and billing metadata. /// ///
    /// @@ -7342,12 +8464,12 @@ pub struct SessionsGetEventFilePathRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetEventFilePathResult { - /// Absolute path to the session's events.jsonl file - pub file_path: String, +pub struct ModelList { + /// List of available models with full metadata + pub models: Vec, } -/// Optional working-directory context used to score session relevance. +/// Optional listing options. /// ///
    /// @@ -7357,13 +8479,13 @@ pub struct SessionsGetEventFilePathResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetLastForContextRequest { - /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. +pub struct ModelListRequest { + /// If true, bypasses the per-session model list cache and re-fetches from CAPI. #[serde(skip_serializing_if = "Option::is_none")] - pub context: Option, + pub skip_cache: Option, } -/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +/// Reasoning effort level to apply to the currently selected model. /// ///
    /// @@ -7373,13 +8495,12 @@ pub struct SessionsGetLastForContextRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetLastForContextResult { - /// Most-relevant session ID for the supplied context, or omitted when no sessions exist - #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, +pub struct ModelSetReasoningEffortRequest { + /// Reasoning effort level to apply to the currently selected model. The host is responsible for validating the value against the model's supported levels before calling. + pub reasoning_effort: String, } -/// Session ID to look up the persisted remote-steerable flag for. +/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. /// ///
    /// @@ -7389,12 +8510,12 @@ pub struct SessionsGetLastForContextResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetPersistedRemoteSteerableRequest { - /// Session ID to look up the persisted remote-steerable flag for - pub session_id: SessionId, +pub struct ModelSetReasoningEffortResult { + /// Reasoning effort level recorded on the session after the update + pub reasoning_effort: String, } -/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +/// Optional GitHub token used to list models for a specific user instead of the global auth context. /// ///
    /// @@ -7404,13 +8525,13 @@ pub struct SessionsGetPersistedRemoteSteerableRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetPersistedRemoteSteerableResult { - /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted +pub struct ModelsListRequest { + /// 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. #[serde(skip_serializing_if = "Option::is_none")] - pub remote_steerable: Option, + pub git_hub_token: Option, } -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. /// ///
    /// @@ -7420,12 +8541,30 @@ pub struct SessionsGetPersistedRemoteSteerableResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSizes { - /// Map of sessionId -> on-disk size in bytes for the session's workspace directory - pub sizes: HashMap, +pub struct ModelSwitchToRequest { + /// Explicit context tier for the selected model. `"default"` / `"long_context"` apply the requested tier; omit this field to use normal model behavior with no explicit tier. + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// When true, defer this switch (enqueue it) if another model change is already queued, even when no turn is active — so it drains last (FIFO) and wins over the already-queued change. Intended for genuine user-initiated model selections; internal restore/reapply switches omit it and apply immediately when no turn is active. When no other model change is queued this has no effect (a switch still applies immediately unless a turn is active). + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_if_model_change_queued: Option, + /// Override individual model capabilities resolved by the runtime + #[serde(skip_serializing_if = "Option::is_none")] + pub model_capabilities: Option, + /// Model selection id to switch to, as returned by `list`. A bare id (e.g. `claude-sonnet-4.6`) names a Copilot (CAPI) model; a provider-qualified id (`provider/id`, e.g. `acme/claude-sonnet`) targets a registry BYOK model. + pub model_id: String, + /// Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted, no effort override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Reasoning summary mode to request for supported model clients + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_summary: Option, + /// Output verbosity level to request for supported models + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, } -/// Optional metadata-load limit and filters applied to the returned sessions. +/// The model identifier active on the session after the switch. /// ///
    /// @@ -7435,19 +8574,16 @@ pub struct SessionSizes { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsListRequest { - /// Optional filter applied to the returned sessions - #[serde(skip_serializing_if = "Option::is_none")] - pub filter: Option, - /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. +pub struct ModelSwitchToResult { + /// True when the switch was deferred (enqueued as a cancellable `/model` command) because a turn was active or another model change was already queued, rather than applied immediately. When true, the session's live model is unchanged until the queued change drains. #[serde(skip_serializing_if = "Option::is_none")] - pub include_detached: Option, - /// When provided, only the first N sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every session. + pub deferred: Option, + /// Currently active model identifier after the switch #[serde(skip_serializing_if = "Option::is_none")] - pub metadata_limit: Option, + pub model_id: Option, } -/// Active session ID whose deferred repo-level hooks should be loaded. +/// Agent interaction mode to apply to the session. /// ///
    /// @@ -7457,12 +8593,12 @@ pub struct SessionsListRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsLoadDeferredRepoHooksRequest { - /// Active session ID whose deferred repo-level hooks should be loaded - pub session_id: SessionId, +pub struct ModeSetRequest { + /// The session mode the agent is operating in + pub mode: SessionMode, } -/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). +/// Azure-specific provider options. /// ///
    /// @@ -7472,21 +8608,13 @@ pub struct SessionsLoadDeferredRepoHooksRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsPruneOldRequest { - /// When true, only report what would be deleted without performing any deletion - #[serde(skip_serializing_if = "Option::is_none")] - pub dry_run: Option, - /// Session IDs that should never be considered for pruning - #[serde(skip_serializing_if = "Option::is_none")] - pub exclude_session_ids: Option>, - /// When true, named sessions (set via /rename) are also eligible for pruning +pub struct ProviderConfigAzure { + /// API version. When set, uses the versioned deployment route. When omitted, uses the GA versionless v1 route. #[serde(skip_serializing_if = "Option::is_none")] - pub include_named: Option, - /// Delete sessions whose modifiedTime is at least this many days old - pub older_than_days: i64, + pub api_version: Option, } -/// Session ID whose in-use lock should be released. +/// A named BYOK provider connection (transport + credentials). /// ///
    /// @@ -7496,12 +8624,38 @@ pub struct SessionsPruneOldRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReleaseLockRequest { - /// Session ID whose in-use lock should be released - pub session_id: SessionId, +pub struct NamedProviderConfig { + /// API key. Optional for local providers like Ollama. + #[serde(skip_serializing_if = "Option::is_none")] + pub api_key: Option, + /// Azure-specific provider options. + #[serde(skip_serializing_if = "Option::is_none")] + pub azure: Option, + /// API endpoint URL. + pub base_url: String, + /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. + #[serde(skip_serializing_if = "Option::is_none")] + pub bearer_token: Option, + /// When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. + #[serde(skip_serializing_if = "Option::is_none")] + pub has_bearer_token_provider: Option, + /// Custom HTTP headers to include in all outbound requests to the provider. + #[serde(skip_serializing_if = "Option::is_none")] + pub headers: Option>, + /// Stable identifier referenced by BYOK model definitions. Must not contain '/'. + pub name: String, + /// Provider transport. Defaults to "http". + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, + /// Wire API format (openai/azure only). Defaults to "completions". + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_api: Option, } -/// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. +/// The session's friendly name, or null when not yet set. /// ///
    /// @@ -7511,9 +8665,12 @@ pub struct SessionsReleaseLockRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReleaseLockResult {} +pub struct NameGetResult { + /// The session name (user-set or auto-generated), or null if not yet set + pub name: Option, +} -/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +/// Auto-generated session summary to apply as the session's name when no user-set name exists. /// ///
    /// @@ -7523,15 +8680,12 @@ pub struct SessionsReleaseLockResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReloadPluginHooksRequest { - /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. - #[serde(skip_serializing_if = "Option::is_none")] - pub defer_repo_hooks: Option, - /// Active session ID to reload hooks for - pub session_id: SessionId, +pub struct NameSetAutoRequest { + /// Auto-generated session summary. Empty/whitespace-only values are ignored; values are trimmed before persisting. + pub summary: String, } -/// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. +/// Indicates whether the auto-generated summary was applied as the session's name. /// ///
    /// @@ -7541,9 +8695,12 @@ pub struct SessionsReloadPluginHooksRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsReloadPluginHooksResult {} +pub struct NameSetAutoResult { + /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. + pub applied: bool, +} -/// Session ID whose pending events should be flushed to disk. +/// New friendly name to apply to the session. /// ///
    /// @@ -7553,12 +8710,12 @@ pub struct SessionsReloadPluginHooksResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSaveRequest { - /// Session ID whose pending events should be flushed to disk - pub session_id: SessionId, +pub struct NameSetRequest { + /// New session name (1–100 characters, trimmed of leading/trailing whitespace) + pub name: String, } -/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). +/// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. /// ///
    /// @@ -7568,9 +8725,12 @@ pub struct SessionsSaveRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSaveResult {} +pub struct OptionsUpdateAdditionalContentExclusionPolicyRuleSource { + pub name: String, + pub r#type: String, +} -/// Manager-wide additional plugins to register; replaces any previously-configured set. +/// Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source. /// ///
    /// @@ -7580,12 +8740,17 @@ pub struct SessionsSaveResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSetAdditionalPluginsRequest { - /// Manager-wide additional plugins to register. Replaces any previously-configured set. Pass an empty array to clear. - pub plugins: Vec, +pub struct OptionsUpdateAdditionalContentExclusionPolicyRule { + #[serde(skip_serializing_if = "Option::is_none")] + pub if_any_match: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub if_none_match: Option>, + pub paths: Vec, + /// Source descriptor for a `session.options.update` content-exclusion rule, with source name and type. + pub source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource, } -/// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. +/// Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope. /// ///
    /// @@ -7595,9 +8760,15 @@ pub struct SessionsSetAdditionalPluginsRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsSetAdditionalPluginsResult {} +pub struct OptionsUpdateAdditionalContentExclusionPolicy { + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + pub rules: Vec, + /// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. + pub scope: OptionsUpdateAdditionalContentExclusionPolicyScope, +} -/// Patch of mutable session options to apply to the running session. +/// Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details. /// ///
    /// @@ -7605,162 +8776,16 @@ pub struct SessionsSetAdditionalPluginsResult {} /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUpdateOptionsParams { - /// Additional content-exclusion policies to merge into the session's policy set. Opaque shape; see `ContentExclusionApiResponse` in the runtime. - /// - ///
    - /// - /// **Experimental.** This type is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. - /// - ///
    - #[serde(skip_serializing_if = "Option::is_none")] - pub additional_content_exclusion_policies: Option>, - /// Runtime context discriminator (e.g., `cli`, `actions`). - #[serde(skip_serializing_if = "Option::is_none")] - pub agent_context: Option, - /// Whether to disable the `ask_user` tool (encourages autonomous behavior). - #[serde(skip_serializing_if = "Option::is_none")] - pub ask_user_disabled: Option, - /// Allowlist of tool names available to this session. - #[serde(skip_serializing_if = "Option::is_none")] - pub available_tools: Option>, - /// Identifier of the client driving the session. - #[serde(skip_serializing_if = "Option::is_none")] - pub client_name: Option, - /// Whether to include the `Co-authored-by` trailer in commit messages. - #[serde(skip_serializing_if = "Option::is_none")] - pub coauthor_enabled: Option, - /// Whether to allow auto-mode continuation across turns. - #[serde(skip_serializing_if = "Option::is_none")] - pub continue_on_auto_mode: Option, - /// Override URL for the Copilot API endpoint. - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_url: Option, - /// Whether to default custom agents to local-only execution. - #[serde(skip_serializing_if = "Option::is_none")] - pub custom_agents_local_only: Option, - /// Instruction source IDs to exclude from the system prompt. - #[serde(skip_serializing_if = "Option::is_none")] - pub disabled_instruction_sources: Option>, - /// Skill IDs that should be excluded from this session. - #[serde(skip_serializing_if = "Option::is_none")] - pub disabled_skills: Option>, - /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_file_hooks: Option, - /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_host_git_operations: Option, - /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions` and the runtime-side `ON_DEMAND_INSTRUCTIONS` feature flag. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_on_demand_instruction_discovery: Option, - /// Whether to surface reasoning-summary events from the model. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_reasoning_summaries: Option, - /// Whether shell-script safety heuristics are enabled. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_script_safety: Option, - /// Whether to enable cross-session store writes and reads. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_session_store: Option, - /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_skills: Option, - /// Whether to stream model responses. - #[serde(skip_serializing_if = "Option::is_none")] - pub enable_streaming: Option, - /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). - #[serde(skip_serializing_if = "Option::is_none")] - pub env_value_mode: Option, - /// Override directory for the session-events log. When unset, the runtime's default events log directory is used. - #[serde(skip_serializing_if = "Option::is_none")] - pub events_log_directory: Option, - /// Denylist of tool names for this session. - #[serde(skip_serializing_if = "Option::is_none")] - pub excluded_tools: Option>, - /// Map of feature-flag IDs to their boolean enabled state. - #[serde(skip_serializing_if = "Option::is_none")] - pub feature_flags: Option>, - /// Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. - #[serde(skip_serializing_if = "Option::is_none")] - pub installed_plugins: Option>, - /// Stable integration identifier used for analytics and rate-limit attribution. - #[serde(skip_serializing_if = "Option::is_none")] - pub integration_id: Option, - /// Whether experimental capabilities are enabled. - #[serde(skip_serializing_if = "Option::is_none")] - pub is_experimental_mode: Option, - /// Whether interactive shell sessions are logged. - #[serde(skip_serializing_if = "Option::is_none")] - pub log_interactive_shells: Option, - /// Identifier sent to LSP-style integrations. - #[serde(skip_serializing_if = "Option::is_none")] - pub lsp_client_name: Option, - /// Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). - #[serde(skip_serializing_if = "Option::is_none")] - pub manage_schedule_enabled: Option, - /// The model ID to use for assistant turns. - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Organization-level custom instructions to inject into the system prompt. - #[serde(skip_serializing_if = "Option::is_none")] - pub organization_custom_instructions: Option, - /// Custom model-provider configuration (BYOK). Opaque shape; see `ProviderConfig` in the runtime. - /// - ///
    - /// - /// **Experimental.** This type is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. - /// - ///
    - #[serde(skip_serializing_if = "Option::is_none")] - pub provider: Option, - /// Reasoning effort for the selected model (model-defined enum). - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, - /// Whether the session is running in an interactive UI. - #[serde(skip_serializing_if = "Option::is_none")] - pub running_in_interactive_mode: Option, - /// Sandbox configuration shape; opaque to SDK consumers. See `SandboxConfig` in the runtime. - /// - ///
    - /// - /// **Experimental.** This type is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. - /// - ///
    - #[serde(skip_serializing_if = "Option::is_none")] - pub sandbox_config: Option, - /// Shell init profile (`None` or `NonInteractive`). - #[serde(skip_serializing_if = "Option::is_none")] - pub shell_init_profile: Option, - /// Per-shell process flags (e.g., `pwsh` arguments). - #[serde(skip_serializing_if = "Option::is_none")] - pub shell_process_flags: Option>, - /// Additional directories to search for skills. - #[serde(skip_serializing_if = "Option::is_none")] - pub skill_directories: Option>, - /// Whether to skip loading custom instruction sources. - #[serde(skip_serializing_if = "Option::is_none")] - pub skip_custom_instructions: Option, - /// Whether to skip embedding retrieval pipeline initialization and execution. - #[serde(skip_serializing_if = "Option::is_none")] - pub skip_embedding_retrieval: Option, - /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. - #[serde(skip_serializing_if = "Option::is_none")] - pub tool_filter_precedence: Option, - /// Optional path for trajectory output. - #[serde(skip_serializing_if = "Option::is_none")] - pub trajectory_file: Option, - /// Absolute working-directory path for shell tools. - #[serde(skip_serializing_if = "Option::is_none")] - pub working_directory: Option, +pub struct PendingPermissionRequest { + /// The user-facing permission prompt details (commands, write, read, mcp, url, memory, custom-tool, path, hook) + pub request: PermissionPromptRequest, + /// Unique identifier for the pending permission request + pub request_id: RequestId, } -/// Indicates whether the session options patch was applied successfully. +/// List of pending permission requests reconstructed from event history. /// ///
    /// @@ -7770,12 +8795,12 @@ pub struct SessionUpdateOptionsParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUpdateOptionsResult { - /// Whether the operation succeeded - pub success: bool, +pub struct PendingPermissionRequestList { + /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. + pub items: Vec, } -/// Shell command to run, with optional working directory and timeout in milliseconds. +/// Permission-decision request variant to approve only the current permission request. /// ///
    /// @@ -7785,18 +8810,15 @@ pub struct SessionUpdateOptionsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShellExecRequest { - /// Shell command to execute - pub command: String, - /// Working directory (defaults to session working directory) - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Timeout in milliseconds (default: 30000) +pub struct PermissionDecisionApproveOnce { + /// True only when a host surfaced this request to a user who approved it. #[serde(skip_serializing_if = "Option::is_none")] - pub timeout: Option, + pub approved_interactively: Option, + /// Approve this single request only + pub kind: PermissionDecisionApproveOnceKind, } -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// Session-scoped approval details for specific command identifiers. /// ///
    /// @@ -7806,12 +8828,14 @@ pub struct ShellExecRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShellExecResult { - /// Unique identifier for tracking streamed output - pub process_id: String, +pub struct PermissionDecisionApproveForSessionApprovalCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionDecisionApproveForSessionApprovalCommandsKind, } -/// Identifier of a process previously returned by "shell.exec" and the signal to send. +/// Session-scoped approval details for read-only filesystem operations. /// ///
    /// @@ -7821,15 +8845,12 @@ pub struct ShellExecResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShellKillRequest { - /// Process identifier returned by shell.exec - pub process_id: String, - /// Signal to send (default: SIGTERM) - #[serde(skip_serializing_if = "Option::is_none")] - pub signal: Option, +pub struct PermissionDecisionApproveForSessionApprovalRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionDecisionApproveForSessionApprovalReadKind, } -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// Session-scoped approval details for filesystem write operations. /// ///
    /// @@ -7839,12 +8860,12 @@ pub struct ShellKillRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShellKillResult { - /// Whether the signal was sent successfully - pub killed: bool, +pub struct PermissionDecisionApproveForSessionApprovalWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionDecisionApproveForSessionApprovalWriteKind, } -/// Parameters for shutting down the session +/// Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. /// ///
    /// @@ -7854,16 +8875,16 @@ pub struct ShellKillResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ShutdownRequest { - /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. - #[serde(skip_serializing_if = "Option::is_none")] - pub reason: Option, - /// Why the session is being shut down. Defaults to "routine" when omitted. - #[serde(skip_serializing_if = "Option::is_none")] - pub r#type: Option, +pub struct PermissionDecisionApproveForSessionApprovalMcp { + /// Approval covering an MCP tool. + pub kind: PermissionDecisionApproveForSessionApprovalMcpKind, + /// MCP server name. + pub server_name: String, + /// MCP tool name, or null to cover every tool on the server. + pub tool_name: Option, } -/// Schema for the `Skill` type. +/// Session-scoped approval details for MCP sampling requests from a server. /// ///
    /// @@ -7873,26 +8894,14 @@ pub struct ShutdownRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct Skill { - /// Description of what the skill does - pub description: String, - /// Whether the skill is currently enabled - pub enabled: bool, - /// Unique identifier for the skill - pub name: String, - /// Absolute path to the skill file - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - /// Name of the plugin that provides the skill, when source is 'plugin' - #[serde(skip_serializing_if = "Option::is_none")] - pub plugin_name: Option, - /// Source location type (e.g., project, personal-copilot, plugin, builtin) - pub source: SkillSource, - /// Whether the skill can be invoked by the user as a slash command - pub user_invocable: bool, +pub struct PermissionDecisionApproveForSessionApprovalMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionDecisionApproveForSessionApprovalMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// Skills available to the session, with their enabled state. +/// Session-scoped approval details for writes to long-term memory. /// ///
    /// @@ -7902,20 +8911,29 @@ pub struct Skill { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillList { - /// Available skills - pub skills: Vec, +pub struct PermissionDecisionApproveForSessionApprovalMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionDecisionApproveForSessionApprovalMemoryKind, } -/// Skill names to mark as disabled in global configuration, replacing any previous list. +/// Session-scoped approval details for a custom tool, keyed by tool name. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsConfigSetDisabledSkillsRequest { - /// List of skill names to disable - pub disabled_skills: Vec, +pub struct PermissionDecisionApproveForSessionApprovalCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionDecisionApproveForSessionApprovalCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Name of the skill to disable for the session. +/// Session-scoped approval details for extension-management operations, optionally narrowed by operation. /// ///
    /// @@ -7925,24 +8943,15 @@ pub struct SkillsConfigSetDisabledSkillsRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsDisableRequest { - /// Name of the skill to disable - pub name: String, -} - -/// Optional project paths and additional skill directories to include in discovery. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SkillsDiscoverRequest { - /// Optional list of project directory paths to scan for project-scoped skills - #[serde(skip_serializing_if = "Option::is_none")] - pub project_paths: Option>, - /// Optional list of additional skill directory paths to include +pub struct PermissionDecisionApproveForSessionApprovalExtensionManagement { + /// Approval covering extension lifecycle operations such as enable, disable, or reload. + pub kind: PermissionDecisionApproveForSessionApprovalExtensionManagementKind, + /// Optional operation identifier; when omitted, the approval covers all extension management operations. #[serde(skip_serializing_if = "Option::is_none")] - pub skill_directories: Option>, + pub operation: Option, } -/// Name of the skill to enable for the session. +/// Session-scoped factory approval, optionally narrowed by approval key. /// ///
    /// @@ -7952,12 +8961,15 @@ pub struct SkillsDiscoverRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsEnableRequest { - /// Name of the skill to enable - pub name: String, +pub struct PermissionDecisionApproveForSessionApprovalFactory { + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + #[serde(skip_serializing_if = "Option::is_none")] + pub approval_key: Option, + /// Approval covering factory operations. + pub kind: PermissionDecisionApproveForSessionApprovalFactoryKind, } -/// Schema for the `SkillsInvokedSkill` type. +/// Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
    /// @@ -7967,21 +8979,14 @@ pub struct SkillsEnableRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsInvokedSkill { - /// Tools that should be auto-approved when this skill is active, captured at invocation time - #[serde(skip_serializing_if = "Option::is_none")] - pub allowed_tools: Option>, - /// Full content of the skill file - pub content: String, - /// Turn number when the skill was invoked - pub invoked_at_turn: i64, - /// Unique identifier for the skill - pub name: String, - /// Path to the SKILL.md file - pub path: String, +pub struct PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess { + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to access a permission-gated capability. + pub kind: PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKind, } -/// Skills invoked during this session, ordered by invocation time (most recent last). +/// Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain. /// ///
    /// @@ -7991,12 +8996,18 @@ pub struct SkillsInvokedSkill { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsGetInvokedResult { - /// Skills invoked during this session, ordered by invocation time (most recent last) - pub skills: Vec, +pub struct PermissionDecisionApproveForSession { + /// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) + #[serde(skip_serializing_if = "Option::is_none")] + pub approval: Option, + /// URL domain to approve for the rest of the session (URL prompts only) + #[serde(skip_serializing_if = "Option::is_none")] + pub domain: Option, + /// Approve and remember for the rest of the session + pub kind: PermissionDecisionApproveForSessionKind, } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// Location-scoped approval details for specific command identifiers. /// ///
    /// @@ -8006,14 +9017,14 @@ pub struct SkillsGetInvokedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsLoadDiagnostics { - /// Errors emitted while loading skills (e.g. skills that failed to load entirely) - pub errors: Vec, - /// Warnings emitted while loading skills (e.g. skills that loaded but had issues) - pub warnings: Vec, +pub struct PermissionDecisionApproveForLocationApprovalCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionDecisionApproveForLocationApprovalCommandsKind, } -/// Schema for the `SlashCommandAgentPromptResult` type. +/// Location-scoped approval details for read-only filesystem operations. /// ///
    /// @@ -8023,22 +9034,12 @@ pub struct SkillsLoadDiagnostics { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandAgentPromptResult { - /// Prompt text to display to the user - pub display_prompt: String, - /// Agent prompt result discriminator - pub kind: SlashCommandAgentPromptResultKind, - /// Optional target session mode for the agent prompt - #[serde(skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// Prompt to submit to the agent - pub prompt: String, - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh - #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, +pub struct PermissionDecisionApproveForLocationApprovalRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionDecisionApproveForLocationApprovalReadKind, } -/// Schema for the `SlashCommandCompletedResult` type. +/// Location-scoped approval details for filesystem write operations. /// ///
    /// @@ -8048,18 +9049,12 @@ pub struct SlashCommandAgentPromptResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandCompletedResult { - /// Completed result discriminator - pub kind: SlashCommandCompletedResultKind, - /// Optional user-facing message describing the completed command - #[serde(skip_serializing_if = "Option::is_none")] - pub message: Option, - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh - #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, +pub struct PermissionDecisionApproveForLocationApprovalWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionDecisionApproveForLocationApprovalWriteKind, } -/// Schema for the `SlashCommandTextResult` type. +/// Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null. /// ///
    /// @@ -8069,23 +9064,16 @@ pub struct SlashCommandCompletedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandTextResult { - /// Text result discriminator - pub kind: SlashCommandTextResultKind, - /// Whether text contains Markdown - #[serde(skip_serializing_if = "Option::is_none")] - pub markdown: Option, - /// Whether ANSI sequences should be preserved - #[serde(skip_serializing_if = "Option::is_none")] - pub preserve_ansi: Option, - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh - #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, - /// Text output for the client to render - pub text: String, +pub struct PermissionDecisionApproveForLocationApprovalMcp { + /// Approval covering an MCP tool. + pub kind: PermissionDecisionApproveForLocationApprovalMcpKind, + /// MCP server name. + pub server_name: String, + /// MCP tool name, or null to cover every tool on the server. + pub tool_name: Option, } -/// Schema for the `SlashCommandSelectSubcommandOption` type. +/// Location-scoped approval details for MCP sampling requests from a server. /// ///
    /// @@ -8095,17 +9083,14 @@ pub struct SlashCommandTextResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandSelectSubcommandOption { - /// Human-readable description of the subcommand - pub description: String, - /// Optional group label for organizing options - #[serde(skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Subcommand name to invoke - pub name: String, +pub struct PermissionDecisionApproveForLocationApprovalMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionDecisionApproveForLocationApprovalMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// Schema for the `SlashCommandSelectSubcommandResult` type. +/// Location-scoped approval details for writes to long-term memory. /// ///
    /// @@ -8115,21 +9100,12 @@ pub struct SlashCommandSelectSubcommandOption { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SlashCommandSelectSubcommandResult { - /// Parent command name that requires subcommand selection - pub command: String, - /// Select subcommand result discriminator - pub kind: SlashCommandSelectSubcommandResultKind, - /// Available subcommand options for the client to present - pub options: Vec, - /// True when the invocation mutated user runtime settings; consumers caching settings should refresh - #[serde(skip_serializing_if = "Option::is_none")] - pub runtime_settings_changed: Option, - /// Human-readable title for the selection UI - pub title: String, +pub struct PermissionDecisionApproveForLocationApprovalMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionDecisionApproveForLocationApprovalMemoryKind, } -/// Schema for the `TaskAgentInfo` type. +/// Location-scoped approval details for a custom tool, keyed by tool name. /// ///
    /// @@ -8139,56 +9115,14 @@ pub struct SlashCommandSelectSubcommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskAgentInfo { - /// ISO 8601 timestamp when the current active period began - #[serde(skip_serializing_if = "Option::is_none")] - pub active_started_at: Option, - /// Accumulated active execution time in milliseconds - #[serde(skip_serializing_if = "Option::is_none")] - pub active_time_ms: Option, - /// Type of agent running this task - pub agent_type: String, - /// 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub can_promote_to_background: Option, - /// ISO 8601 timestamp when the task finished - #[serde(skip_serializing_if = "Option::is_none")] - pub completed_at: Option, - /// Short description of the task - pub description: String, - /// Error message when the task failed - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether task execution is synchronously awaited or managed in the background - #[serde(skip_serializing_if = "Option::is_none")] - pub execution_mode: Option, - /// Unique task identifier - pub id: String, - /// ISO 8601 timestamp when the agent entered idle state - #[serde(skip_serializing_if = "Option::is_none")] - pub idle_since: Option, - /// Most recent response text from the agent - #[serde(skip_serializing_if = "Option::is_none")] - pub latest_response: Option, - /// Model used for the task when specified - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Prompt passed to the agent - pub prompt: String, - /// Result text from the task when available - #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, - /// ISO 8601 timestamp when the task was started - pub started_at: String, - /// Current lifecycle status of the task - pub status: TaskStatus, - /// Tool call ID associated with this agent task - pub tool_call_id: String, - /// Task kind - pub r#type: TaskAgentInfoType, +pub struct PermissionDecisionApproveForLocationApprovalCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionDecisionApproveForLocationApprovalCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Schema for the `TaskProgressLine` type. +/// Location-scoped approval details for extension-management operations, optionally narrowed by operation. /// ///
    /// @@ -8198,14 +9132,15 @@ pub struct TaskAgentInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskProgressLine { - /// Display message, e.g., "▸ bash", "✓ edit src/foo.ts" - pub message: String, - /// ISO 8601 timestamp when this event occurred - pub timestamp: String, +pub struct PermissionDecisionApproveForLocationApprovalExtensionManagement { + /// Approval covering extension lifecycle operations such as enable, disable, or reload. + pub kind: PermissionDecisionApproveForLocationApprovalExtensionManagementKind, + /// Optional operation identifier; when omitted, the approval covers all extension management operations. + #[serde(skip_serializing_if = "Option::is_none")] + pub operation: Option, } -/// Schema for the `TaskAgentProgress` type. +/// Location-scoped factory approval, optionally narrowed by approval key. /// ///
    /// @@ -8215,17 +9150,15 @@ pub struct TaskProgressLine { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskAgentProgress { - /// The most recent intent reported by the agent +pub struct PermissionDecisionApproveForLocationApprovalFactory { + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. #[serde(skip_serializing_if = "Option::is_none")] - pub latest_intent: Option, - /// Recent tool execution events converted to display lines - pub recent_activity: Vec, - /// Progress kind - pub r#type: TaskAgentProgressType, + pub approval_key: Option, + /// Approval covering factory operations. + pub kind: PermissionDecisionApproveForLocationApprovalFactoryKind, } -/// Background tasks currently tracked by the session. +/// Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
    /// @@ -8235,12 +9168,14 @@ pub struct TaskAgentProgress { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskList { - /// Currently tracked tasks - pub tasks: Vec, +pub struct PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess { + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to access a permission-gated capability. + pub kind: PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind, } -/// Identifier of the background task to cancel. +/// Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key. /// ///
    /// @@ -8248,14 +9183,18 @@ pub struct TaskList { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksCancelRequest { - /// Task identifier - pub id: String, +pub struct PermissionDecisionApproveForLocation { + /// Approval to persist for this location + pub approval: PermissionDecisionApproveForLocationApproval, + /// Approve and persist for this project location + pub kind: PermissionDecisionApproveForLocationKind, + /// Location key (git root or cwd) to persist the approval to + pub location_key: String, } -/// Indicates whether the background task was successfully cancelled. +/// Permission-decision request variant to permanently approve a URL domain across sessions. /// ///
    /// @@ -8265,12 +9204,14 @@ pub struct TasksCancelRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksCancelResult { - /// Whether the task was successfully cancelled - pub cancelled: bool, +pub struct PermissionDecisionApprovePermanently { + /// URL domain to approve permanently + pub domain: String, + /// Approve and persist across sessions (URL prompts only) + pub kind: PermissionDecisionApprovePermanentlyKind, } -/// The first sync-waiting task that can currently be promoted to background mode. +/// Permission-decision request variant to reject a pending permission request, with optional feedback. /// ///
    /// @@ -8280,13 +9221,15 @@ pub struct TasksCancelResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksGetCurrentPromotableResult { - /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. +pub struct PermissionDecisionReject { + /// Optional feedback explaining the rejection #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, + pub feedback: Option, + /// Reject the request + pub kind: PermissionDecisionRejectKind, } -/// Identifier of the background task to fetch progress for. +/// Permission-decision variant indicating no user was available to confirm the request. /// ///
    /// @@ -8296,12 +9239,12 @@ pub struct TasksGetCurrentPromotableResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksGetProgressRequest { - /// Task identifier (agent ID or shell ID) - pub id: String, +pub struct PermissionDecisionUserNotAvailable { + /// No user is available to confirm the request + pub kind: PermissionDecisionUserNotAvailableKind, } -/// Progress information for the task, or null when no task with that ID is tracked. +/// Permission-decision variant indicating the request was approved. /// ///
    /// @@ -8311,12 +9254,12 @@ pub struct TasksGetProgressRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksGetProgressResult { - /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. - pub progress: Option, +pub struct PermissionDecisionApproved { + /// The permission request was approved + pub kind: PermissionDecisionApprovedKind, } -/// Schema for the `TaskShellInfo` type. +/// Permission-decision variant indicating approval was remembered for the session, with approval details. /// ///
    /// @@ -8324,41 +9267,16 @@ pub struct TasksGetProgressResult { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskShellInfo { - /// Whether the shell runs inside a managed PTY session or as an independent background process - pub attachment_mode: TaskShellInfoAttachmentMode, - /// Whether this shell task can be promoted to background mode - #[serde(skip_serializing_if = "Option::is_none")] - pub can_promote_to_background: Option, - /// Command being executed - pub command: String, - /// ISO 8601 timestamp when the task finished - #[serde(skip_serializing_if = "Option::is_none")] - pub completed_at: Option, - /// Short description of the task - pub description: String, - /// Whether task execution is synchronously awaited or managed in the background - #[serde(skip_serializing_if = "Option::is_none")] - pub execution_mode: Option, - /// Unique task identifier - pub id: String, - /// Path to the detached shell log, when available - #[serde(skip_serializing_if = "Option::is_none")] - pub log_path: Option, - /// Process ID when available - #[serde(skip_serializing_if = "Option::is_none")] - pub pid: Option, - /// ISO 8601 timestamp when the task was started - pub started_at: String, - /// Current lifecycle status of the task - pub status: TaskStatus, - /// Task kind - pub r#type: TaskShellInfoType, +pub struct PermissionDecisionApprovedForSession { + /// The approval to add as a session-scoped rule + pub approval: UserToolSessionApproval, + /// Approved and remembered for the rest of the session + pub kind: PermissionDecisionApprovedForSessionKind, } -/// Schema for the `TaskShellProgress` type. +/// Permission-decision variant indicating approval was persisted for a project location, with approval details and location key. /// ///
    /// @@ -8366,19 +9284,18 @@ pub struct TaskShellInfo { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TaskShellProgress { - /// Process ID when available - #[serde(skip_serializing_if = "Option::is_none")] - pub pid: Option, - /// Recent stdout/stderr lines from the running shell command - pub recent_output: String, - /// Progress kind - pub r#type: TaskShellProgressType, +pub struct PermissionDecisionApprovedForLocation { + /// The approval to persist for this location + pub approval: UserToolSessionApproval, + /// Approved and persisted for this project location + pub kind: PermissionDecisionApprovedForLocationKind, + /// The location key (git root or cwd) to persist the approval to + pub location_key: String, } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// Permission-decision variant indicating the request was cancelled before use, with an optional reason. /// ///
    /// @@ -8388,13 +9305,15 @@ pub struct TaskShellProgress { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksPromoteCurrentToBackgroundResult { - /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. +pub struct PermissionDecisionCancelled { + /// The permission request was cancelled before a response was used + pub kind: PermissionDecisionCancelledKind, + /// Optional explanation of why the request was cancelled #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, + pub reason: Option, } -/// Identifier of the task to promote to background mode. +/// Permission-decision variant indicating explicit denial by permission rules, with the matching rules. /// ///
    /// @@ -8404,12 +9323,14 @@ pub struct TasksPromoteCurrentToBackgroundResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksPromoteToBackgroundRequest { - /// Task identifier - pub id: String, +pub struct PermissionDecisionDeniedByRules { + /// Denied because approval rules explicitly blocked it + pub kind: PermissionDecisionDeniedByRulesKind, + /// Rules that denied the request + pub rules: Vec, } -/// Indicates whether the task was successfully promoted to background mode. +/// Permission-decision variant indicating no approval rule matched and user confirmation was unavailable. /// ///
    /// @@ -8419,12 +9340,12 @@ pub struct TasksPromoteToBackgroundRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksPromoteToBackgroundResult { - /// Whether the task was successfully promoted to background mode - pub promoted: bool, +pub struct PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser { + /// Denied because no approval rule matched and user confirmation was unavailable + pub kind: PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind, } -/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. +/// Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag. /// ///
    /// @@ -8434,9 +9355,18 @@ pub struct TasksPromoteToBackgroundResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksRefreshResult {} +pub struct PermissionDecisionDeniedInteractivelyByUser { + /// Optional feedback from the user explaining the denial + #[serde(skip_serializing_if = "Option::is_none")] + pub feedback: Option, + /// Whether to force-reject the current agent turn + #[serde(skip_serializing_if = "Option::is_none")] + pub force_reject: Option, + /// Denied by the user during an interactive prompt + pub kind: PermissionDecisionDeniedInteractivelyByUserKind, +} -/// Identifier of the completed or cancelled task to remove from tracking. +/// Permission-decision variant indicating denial by content-exclusion policy, with path and message. /// ///
    /// @@ -8446,12 +9376,16 @@ pub struct TasksRefreshResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksRemoveRequest { - /// Task identifier - pub id: String, +pub struct PermissionDecisionDeniedByContentExclusionPolicy { + /// Denied by the organization's content exclusion policy + pub kind: PermissionDecisionDeniedByContentExclusionPolicyKind, + /// Human-readable explanation of why the path was excluded + pub message: String, + /// File path that triggered the exclusion + pub path: String, } -/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag. /// ///
    /// @@ -8461,12 +9395,18 @@ pub struct TasksRemoveRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksRemoveResult { - /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). - pub removed: bool, +pub struct PermissionDecisionDeniedByPermissionRequestHook { + /// Whether to interrupt the current agent turn + #[serde(skip_serializing_if = "Option::is_none")] + pub interrupt: Option, + /// Denied by a permission request hook registered by an extension or plugin + pub kind: PermissionDecisionDeniedByPermissionRequestHookKind, + /// Optional message from the hook explaining the denial + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, } -/// Identifier of the target agent task, message content, and optional sender agent ID. +/// Optional informational context describing how and where the permission decision was made. This does not affect permission behavior. /// ///
    /// @@ -8476,17 +9416,16 @@ pub struct TasksRemoveResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksSendMessageRequest { - /// Agent ID of the sender, if sent on behalf of another agent - #[serde(skip_serializing_if = "Option::is_none")] - pub from_agent_id: Option, - /// Agent task identifier - pub id: String, - /// Message content to send to the agent - pub message: String, +pub struct PermissionDecisionContext { + /// Disposition of the permission request as observed by the responding client. + pub outcome: PermissionDecisionOutcome, + /// Controlled reason or actor responsible for the response. + pub source: PermissionDecisionSource, + /// Client surface that submitted the response. + pub surface: PermissionDecisionSurface, } -/// Indicates whether the message was delivered, with an error message when delivery failed. +/// Pending permission request ID and the decision to apply (approve/reject and scope). /// ///
    /// @@ -8494,17 +9433,19 @@ pub struct TasksSendMessageRequest { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksSendMessageResult { - /// Error message if delivery failed +pub struct PermissionDecisionRequest { + /// Optional informational context describing how and where this response was made. Omit it to preserve legacy behavior without attributing an origin. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether the message was successfully delivered or steered - pub sent: bool, + pub decision_context: Option, + /// Request ID of the pending permission request + pub request_id: RequestId, + /// The client's response to the pending permission prompt + pub result: PermissionDecision, } -/// Agent type, prompt, name, and optional description and model override for the new task. +/// Location-persisted tool approval details for specific command identifiers. /// ///
    /// @@ -8514,22 +9455,14 @@ pub struct TasksSendMessageResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksStartAgentRequest { - /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose') - pub agent_type: String, - /// Short description of the task - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Optional model override - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, - /// Short name for the agent, used to generate a human-readable ID - pub name: String, - /// Task prompt for the agent - pub prompt: String, +pub struct PermissionsLocationsAddToolApprovalDetailsCommands { + /// Command identifiers covered by this approval. + pub command_identifiers: Vec, + /// Approval scoped to specific command identifiers. + pub kind: PermissionsLocationsAddToolApprovalDetailsCommandsKind, } -/// Identifier assigned to the newly started background agent task. +/// Location-persisted tool approval details for read-only filesystem operations. /// ///
    /// @@ -8539,12 +9472,12 @@ pub struct TasksStartAgentRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksStartAgentResult { - /// Generated agent ID for the background task - pub agent_id: String, +pub struct PermissionsLocationsAddToolApprovalDetailsRead { + /// Approval covering read-only filesystem operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsReadKind, } -/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +/// Location-persisted tool approval details for filesystem write operations. /// ///
    /// @@ -8554,9 +9487,12 @@ pub struct TasksStartAgentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TasksWaitForPendingResult {} +pub struct PermissionsLocationsAddToolApprovalDetailsWrite { + /// Approval covering filesystem write operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsWriteKind, +} -/// Feature override key/value pairs to attach to subsequent telemetry events from this session. +/// Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null. /// ///
    /// @@ -8566,12 +9502,16 @@ pub struct TasksWaitForPendingResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TelemetrySetFeatureOverridesRequest { - /// Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. - pub features: HashMap, +pub struct PermissionsLocationsAddToolApprovalDetailsMcp { + /// Approval covering an MCP tool. + pub kind: PermissionsLocationsAddToolApprovalDetailsMcpKind, + /// MCP server name. + pub server_name: String, + /// MCP tool name, or null to cover every tool on the server. + pub tool_name: Option, } -/// Schema for the `TokenAuthInfo` type. +/// Location-persisted tool approval details for MCP sampling requests from a server. /// ///
    /// @@ -8581,46 +9521,14 @@ pub struct TelemetrySetFeatureOverridesRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct TokenAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Authentication host. - pub host: String, - /// The token value itself. Treat as a secret. - pub token: String, - /// SDK-side token authentication; the host configured the token directly via the SDK. - pub r#type: TokenAuthInfoType, -} - -/// Schema for the `Tool` type. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct Tool { - /// Description of what the tool does - pub description: String, - /// Optional instructions for how to use this tool effectively - #[serde(skip_serializing_if = "Option::is_none")] - pub instructions: Option, - /// Tool identifier (e.g., "bash", "grep", "str_replace_editor") - pub name: String, - /// Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP tools) - #[serde(skip_serializing_if = "Option::is_none")] - pub namespaced_name: Option, - /// JSON Schema for the tool's input parameters - #[serde(skip_serializing_if = "Option::is_none")] - pub parameters: Option>, -} - -/// Built-in tools available for the requested model, with their parameters and instructions. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ToolList { - /// List of available built-in tools with metadata - pub tools: Vec, +pub struct PermissionsLocationsAddToolApprovalDetailsMcpSampling { + /// Approval covering MCP sampling requests for a server. + pub kind: PermissionsLocationsAddToolApprovalDetailsMcpSamplingKind, + /// MCP server name. + pub server_name: String, } -/// Current lightweight tool metadata snapshot for the session. +/// Location-persisted tool approval details for writes to long-term memory. /// ///
    /// @@ -8630,12 +9538,12 @@ pub struct ToolList { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ToolsGetCurrentMetadataResult { - /// Current tool metadata, or null when tools have not been initialized yet - pub tools: Option>, +pub struct PermissionsLocationsAddToolApprovalDetailsMemory { + /// Approval covering writes to long-term memory. + pub kind: PermissionsLocationsAddToolApprovalDetailsMemoryKind, } -/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +/// Location-persisted tool approval details for a custom tool, keyed by tool name. /// ///
    /// @@ -8645,18 +9553,14 @@ pub struct ToolsGetCurrentMetadataResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct ToolsInitializeAndValidateResult {} - -/// Optional model identifier whose tool overrides should be applied to the listing. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ToolsListRequest { - /// Optional model ID — when provided, the returned tool list reflects model-specific overrides - #[serde(skip_serializing_if = "Option::is_none")] - pub model: Option, +pub struct PermissionsLocationsAddToolApprovalDetailsCustomTool { + /// Approval covering a custom tool. + pub kind: PermissionsLocationsAddToolApprovalDetailsCustomToolKind, + /// Custom tool name. + pub tool_name: String, } -/// Schema for the `UIElicitationArrayAnyOfFieldItemsAnyOf` type. +/// Location-persisted tool approval details for extension-management operations, optionally narrowed by operation. /// ///
    /// @@ -8666,14 +9570,15 @@ pub struct ToolsListRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationArrayAnyOfFieldItemsAnyOf { - /// Value submitted when this option is selected. - pub r#const: String, - /// Display label for this option. - pub title: String, -} +pub struct PermissionsLocationsAddToolApprovalDetailsExtensionManagement { + /// Approval covering extension lifecycle operations such as enable, disable, or reload. + pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionManagementKind, + /// Optional operation identifier; when omitted, the approval covers all extension management operations. + #[serde(skip_serializing_if = "Option::is_none")] + pub operation: Option, +} -/// Schema applied to each item in the array. +/// Location-persisted factory approval, optionally narrowed by approval key. /// ///
    /// @@ -8683,12 +9588,15 @@ pub struct UIElicitationArrayAnyOfFieldItemsAnyOf { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationArrayAnyOfFieldItems { - /// Selectable options, each with a value and a display label. - pub any_of: Vec, +pub struct PermissionsLocationsAddToolApprovalDetailsFactory { + /// Optional factory operation name or canonical approval key; when omitted, the approval covers all factory operations. + #[serde(skip_serializing_if = "Option::is_none")] + pub approval_key: Option, + /// Approval covering factory operations. + pub kind: PermissionsLocationsAddToolApprovalDetailsFactoryKind, } -/// Multi-select string field where each option pairs a value with a display label. +/// Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name. /// ///
    /// @@ -8698,29 +9606,14 @@ pub struct UIElicitationArrayAnyOfFieldItems { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationArrayAnyOfField { - /// Default values selected when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option>, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Schema applied to each item in the array. - pub items: UIElicitationArrayAnyOfFieldItems, - /// Maximum number of items the user may select. - #[serde(skip_serializing_if = "Option::is_none")] - pub max_items: Option, - /// Minimum number of items the user must select. - #[serde(skip_serializing_if = "Option::is_none")] - pub min_items: Option, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "array". - pub r#type: UIElicitationArrayAnyOfFieldType, +pub struct PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess { + /// Extension name. + pub extension_name: String, + /// Approval covering an extension's request to access a permission-gated capability. + pub kind: PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind, } -/// Schema applied to each item in the array. +/// Location-scoped tool approval to persist. /// ///
    /// @@ -8728,16 +9621,16 @@ pub struct UIElicitationArrayAnyOfField { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationArrayEnumFieldItems { - /// Allowed string values for each selected item. - pub r#enum: Vec, - /// Type discriminator. Always "string". - pub r#type: UIElicitationArrayEnumFieldItemsType, +pub struct PermissionLocationAddToolApprovalParams { + /// Tool approval to persist and apply + pub approval: PermissionsLocationsAddToolApprovalDetails, + /// Location key (git root or cwd) to persist the approval to + pub location_key: String, } -/// Multi-select string field whose allowed values are defined inline. +/// Working directory to load persisted location permissions for. /// ///
    /// @@ -8747,29 +9640,12 @@ pub struct UIElicitationArrayEnumFieldItems { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationArrayEnumField { - /// Default values selected when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option>, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Schema applied to each item in the array. - pub items: UIElicitationArrayEnumFieldItems, - /// Maximum number of items the user may select. - #[serde(skip_serializing_if = "Option::is_none")] - pub max_items: Option, - /// Minimum number of items the user must select. - #[serde(skip_serializing_if = "Option::is_none")] - pub min_items: Option, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "array". - pub r#type: UIElicitationArrayEnumFieldType, +pub struct PermissionLocationApplyParams { + /// Working directory whose persisted location permissions should be applied + pub working_directory: String, } -/// JSON Schema describing the form fields to present to the user +/// Summary of persisted location permissions applied to the session. /// ///
    /// @@ -8779,17 +9655,22 @@ pub struct UIElicitationArrayEnumField { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationSchema { - /// Form field definitions, keyed by field name - pub properties: HashMap, - /// List of required field names - #[serde(skip_serializing_if = "Option::is_none")] - pub required: Option>, - /// Schema type indicator (always 'object') - pub r#type: UIElicitationSchemaType, +pub struct PermissionLocationApplyResult { + /// Number of persisted allowed directories added to the live path manager + pub applied_directory_count: i64, + /// Number of location-scoped rules added to the live permission service + pub applied_rule_count: i64, + /// Location-scoped rules applied to the live permission service + pub applied_rules: Vec, + /// Whether a different location was applied since the previous apply call + pub changed: bool, + /// Location key used in the location-permissions store + pub location_key: String, + /// Whether the location is a git repo or directory + pub location_type: PermissionLocationType, } -/// Prompt message and JSON schema describing the form fields to elicit from the user. +/// Working directory to resolve into a location-permissions key. /// ///
    /// @@ -8799,14 +9680,12 @@ pub struct UIElicitationSchema { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationRequest { - /// Message describing what information is needed from the user - pub message: String, - /// JSON Schema describing the form fields to present to the user - pub requested_schema: UIElicitationSchema, +pub struct PermissionLocationResolveParams { + /// Working directory whose permission location should be resolved + pub working_directory: String, } -/// The elicitation response (accept with form values, decline, or cancel) +/// Resolved location-permissions key and type. /// ///
    /// @@ -8816,15 +9695,14 @@ pub struct UIElicitationRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationResponse { - /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) - pub action: UIElicitationResponseAction, - /// The form values submitted by the user (present when action is 'accept') - #[serde(skip_serializing_if = "Option::is_none")] - pub content: Option>, +pub struct PermissionLocationResolveResult { + /// Location key used in the location-permissions store + pub location_key: String, + /// Whether the location is a git repo or directory + pub location_type: PermissionLocationType, } -/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// Directory path to add to the session's allowed directories. /// ///
    /// @@ -8834,12 +9712,12 @@ pub struct UIElicitationResponse { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationResult { - /// Whether the response was accepted. False if the request was already resolved by another client. - pub success: bool, +pub struct PermissionPathsAddParams { + /// Directory to add to the allow-list. The runtime resolves and validates the path before adding. + pub path: String, } -/// Boolean field rendered as a yes/no toggle. +/// Path to evaluate against the session's allowed directories. /// ///
    /// @@ -8849,21 +9727,12 @@ pub struct UIElicitationResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationSchemaPropertyBoolean { - /// Default value selected when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "boolean". - pub r#type: UIElicitationSchemaPropertyBooleanType, +pub struct PermissionPathsAllowedCheckParams { + /// Path to check against the session's allowed directories + pub path: String, } -/// Numeric field accepting either a number or an integer. +/// Indicates whether the supplied path is within the session's allowed directories. /// ///
    /// @@ -8873,27 +9742,12 @@ pub struct UIElicitationSchemaPropertyBoolean { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationSchemaPropertyNumber { - /// Default value populated in the input when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Maximum allowed value (inclusive). - #[serde(skip_serializing_if = "Option::is_none")] - pub maximum: Option, - /// Minimum allowed value (inclusive). - #[serde(skip_serializing_if = "Option::is_none")] - pub minimum: Option, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Numeric type accepted by the field. - pub r#type: UIElicitationSchemaPropertyNumberType, +pub struct PermissionPathsAllowedCheckResult { + /// Whether the path is within the session's allowed directories + pub allowed: bool, } -/// Free-text string field with optional length and format constraints. +/// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. /// ///
    /// @@ -8903,30 +9757,22 @@ pub struct UIElicitationSchemaPropertyNumber { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationSchemaPropertyString { - /// Default value populated in the input when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Optional format hint that constrains the accepted input. +pub struct PermissionPathsConfig { + /// Additional directories to allow tool access to (in addition to the session's working directory). When `unrestricted` is true, these are still pre-populated on the UnrestrictedPathManager so they remain visible via getDirectories() (e.g. for @-mention completion). #[serde(skip_serializing_if = "Option::is_none")] - pub format: Option, - /// Maximum number of characters allowed. + pub additional_directories: Option>, + /// Whether to include the system temp directory in the allowed list (defaults to true). Ignored when `unrestricted` is true. #[serde(skip_serializing_if = "Option::is_none")] - pub max_length: Option, - /// Minimum number of characters required. + pub include_temp_directory: Option, + /// If true, the runtime allows access to all paths without prompting. Equivalent to constructing an UnrestrictedPathManager. #[serde(skip_serializing_if = "Option::is_none")] - pub min_length: Option, - /// Human-readable label for the field. + pub unrestricted: Option, + /// Workspace root path (special-cased to be allowed even before the directory exists). Ignored when `unrestricted` is true. #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "string". - pub r#type: UIElicitationSchemaPropertyStringType, + pub workspace_path: Option, } -/// Single-select string field whose allowed values are defined inline. +/// Snapshot of the session's allow-listed directories and primary working directory. /// ///
    /// @@ -8936,26 +9782,14 @@ pub struct UIElicitationSchemaPropertyString { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationStringEnumField { - /// Default value selected when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Allowed string values. - pub r#enum: Vec, - /// Optional display labels for each enum value, in the same order as `enum`. - #[serde(skip_serializing_if = "Option::is_none")] - pub enum_names: Option>, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "string". - pub r#type: UIElicitationStringEnumFieldType, +pub struct PermissionPathsList { + /// All directories currently allowed for tool access on this session. + pub directories: Vec, + /// The primary working directory for this session. + pub primary: String, } -/// Schema for the `UIElicitationStringOneOfFieldOneOf` type. +/// Directory path to set as the session's new primary working directory. /// ///
    /// @@ -8965,14 +9799,12 @@ pub struct UIElicitationStringEnumField { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationStringOneOfFieldOneOf { - /// Value submitted when this option is selected. - pub r#const: String, - /// Display label for this option. - pub title: String, +pub struct PermissionPathsUpdatePrimaryParams { + /// Directory to set as the new primary working directory for the session's permission policy. + pub path: String, } -/// Single-select string field where each option pairs a value with a display label. +/// Path to evaluate against the session's workspace (primary) directory. /// ///
    /// @@ -8982,23 +9814,12 @@ pub struct UIElicitationStringOneOfFieldOneOf { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIElicitationStringOneOfField { - /// Default value selected when the form is first shown. - #[serde(skip_serializing_if = "Option::is_none")] - pub default: Option, - /// Help text describing the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option, - /// Selectable options, each with a value and a display label. - pub one_of: Vec, - /// Human-readable label for the field. - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// Type discriminator. Always "string". - pub r#type: UIElicitationStringOneOfFieldType, +pub struct PermissionPathsWorkspaceCheckParams { + /// Path to check against the session workspace directory + pub path: String, } -/// Schema for the `UIExitPlanModeResponse` type. +/// Indicates whether the supplied path is within the session's workspace directory. /// ///
    /// @@ -9008,21 +9829,12 @@ pub struct UIElicitationStringOneOfField { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIExitPlanModeResponse { - /// Whether the plan was approved. - pub approved: bool, - /// Whether subsequent edits should be auto-approved without confirmation. - #[serde(skip_serializing_if = "Option::is_none")] - pub auto_approve_edits: Option, - /// Feedback from the user when they declined the plan or requested changes. - #[serde(skip_serializing_if = "Option::is_none")] - pub feedback: Option, - /// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. - #[serde(skip_serializing_if = "Option::is_none")] - pub selected_action: Option, +pub struct PermissionPathsWorkspaceCheckResult { + /// Whether the path is within the session workspace directory + pub allowed: bool, } -/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +/// Notification payload describing the permission prompt that the client just rendered. /// ///
    /// @@ -9032,14 +9844,12 @@ pub struct UIExitPlanModeResponse { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingAutoModeSwitchRequest { - /// The unique request ID from the auto_mode_switch.requested event - pub request_id: RequestId, - /// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). - pub response: UIAutoModeSwitchResponse, +pub struct PermissionPromptShownNotification { + /// Human-readable description of the prompt the user is being asked to approve. Used by the runtime to fire the registered `permission_prompt` notification hook (e.g. terminal bell, desktop notification). + pub message: String, } -/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +/// Indicates whether the permission decision was applied; false when the request was already resolved. /// ///
    /// @@ -9049,14 +9859,12 @@ pub struct UIHandlePendingAutoModeSwitchRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingElicitationRequest { - /// The unique request ID from the elicitation.requested event - pub request_id: RequestId, - /// The elicitation response (accept with form values, decline, or cancel) - pub result: UIElicitationResponse, +pub struct PermissionRequestResult { + /// Whether the permission request was handled successfully + pub success: bool, } -/// Request ID of a pending `exit_plan_mode.requested` event and the user's response. +/// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. /// ///
    /// @@ -9066,14 +9874,14 @@ pub struct UIHandlePendingElicitationRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingExitPlanModeRequest { - /// The unique request ID from the exit_plan_mode.requested event - pub request_id: RequestId, - /// Schema for the `UIExitPlanModeResponse` type. - pub response: UIExitPlanModeResponse, +pub struct PermissionRulesSet { + /// Rules that auto-approve matching requests + pub approved: Vec, + /// Rules that auto-deny matching requests + pub denied: Vec, } -/// Indicates whether the pending UI request was resolved by this call. +/// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. /// ///
    /// @@ -9083,12 +9891,12 @@ pub struct UIHandlePendingExitPlanModeRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingResult { - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - pub success: bool, +pub struct PermissionsConfigureAdditionalContentExclusionPolicyRuleSource { + pub name: String, + pub r#type: String, } -/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +/// Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source. /// ///
    /// @@ -9098,9 +9906,17 @@ pub struct UIHandlePendingResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingSamplingResponse {} +pub struct PermissionsConfigureAdditionalContentExclusionPolicyRule { + #[serde(skip_serializing_if = "Option::is_none")] + pub if_any_match: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub if_none_match: Option>, + pub paths: Vec, + /// Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type. + pub source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource, +} -/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +/// Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope. /// ///
    /// @@ -9110,15 +9926,15 @@ pub struct UIHandlePendingSamplingResponse {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingSamplingRequest { - /// The unique request ID from the sampling.requested event - pub request_id: RequestId, - /// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. - #[serde(skip_serializing_if = "Option::is_none")] - pub response: Option, +pub struct PermissionsConfigureAdditionalContentExclusionPolicy { + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + pub rules: Vec, + /// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. + pub scope: PermissionsConfigureAdditionalContentExclusionPolicyScope, } -/// Schema for the `UIUserInputResponse` type. +/// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. /// ///
    /// @@ -9128,14 +9944,16 @@ pub struct UIHandlePendingSamplingRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIUserInputResponse { - /// The user's answer text - pub answer: String, - /// True if the user typed a freeform response, false if they selected a presented choice. Used by telemetry to differentiate between free text input and choice selection. - pub was_freeform: bool, +pub struct PermissionUrlsConfig { + /// Initial list of allowed URL/domain patterns. Patterns may include path components. Ignored when `unrestricted` is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub initial_allowed: Option>, + /// If true, the runtime allows access to all URLs without prompting. Initial allow-list is ignored when this is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub unrestricted: Option, } -/// Request ID of a pending `user_input.requested` event and the user's response. +/// Patch of permission policy fields to apply (omit a field to leave it unchanged). /// ///
    /// @@ -9145,14 +9963,29 @@ pub struct UIUserInputResponse { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIHandlePendingUserInputRequest { - /// The unique request ID from the user_input.requested event - pub request_id: RequestId, - /// Schema for the `UIUserInputResponse` type. - pub response: UIUserInputResponse, +pub struct PermissionsConfigureParams { + /// If specified, replaces the host-supplied GitHub Content Exclusion policies on the session (combined with natively-discovered policies when evaluating tool/file access). Omit to leave the current policies unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_content_exclusion_policies: + Option>, + /// If specified, sets whether path/URL read permission requests are auto-approved. Omit to leave the current value unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub approve_all_read_permission_requests: Option, + /// If specified, sets whether tool permission requests are auto-approved without prompting. Omit to leave the current value unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub approve_all_tool_permission_requests: Option, + /// If specified, replaces the session's path-permission policy. The runtime constructs the appropriate PathManager based on these inputs (rooted at the session's working directory). Omit to leave the current path policy unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub paths: Option, + /// If specified, replaces the session's approved/denied permission rules. Omit to leave the current rules unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub rules: Option, + /// If specified, replaces the session's URL-permission policy. The runtime constructs a fresh DefaultUrlManager based on these inputs. Omit to leave the current URL policy unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub urls: Option, } -/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9162,12 +9995,12 @@ pub struct UIHandlePendingUserInputRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIRegisterDirectAutoModeSwitchHandlerResult { - /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. - pub handle: String, +pub struct PermissionsConfigureResult { + /// Whether the operation succeeded + pub success: bool, } -/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9177,12 +10010,12 @@ pub struct UIRegisterDirectAutoModeSwitchHandlerResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIUnregisterDirectAutoModeSwitchHandlerRequest { - /// Handle previously returned by `registerDirectAutoModeSwitchHandler` - pub handle: String, +pub struct PermissionsFolderTrustAddTrustedResult { + /// Whether the operation succeeded + pub success: bool, } -/// Indicates whether the handle was active and the registration count was decremented. +/// No parameters. /// ///
    /// @@ -9192,12 +10025,9 @@ pub struct UIUnregisterDirectAutoModeSwitchHandlerRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UIUnregisterDirectAutoModeSwitchHandlerResult { - /// True if the handle was active and decremented the counter; false if the handle was unknown. - pub unregistered: bool, -} +pub struct PermissionsGetAllowAllRequest {} -/// Aggregated code change metrics +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9207,18 +10037,12 @@ pub struct UIUnregisterDirectAutoModeSwitchHandlerResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsCodeChanges { - /// Distinct file paths modified during the session - pub files_modified: Vec, - /// Number of distinct files modified - pub files_modified_count: i64, - /// Total lines of code added - pub lines_added: i64, - /// Total lines of code removed - pub lines_removed: i64, +pub struct PermissionsLocationsAddToolApprovalResult { + /// Whether the operation succeeded + pub success: bool, } -/// Request count and cost metrics for this model +/// Scope and add/remove instructions for modifying session- or location-scoped permission rules. /// ///
    /// @@ -9228,14 +10052,21 @@ pub struct UsageMetricsCodeChanges { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsModelMetricRequests { - /// User-initiated premium request cost (with multiplier applied) - pub cost: f64, - /// Number of API requests made with this model - pub count: i64, +pub struct PermissionsModifyRulesParams { + /// Rules to add to the scope. Applied before `remove`/`removeAll`. + #[serde(skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// Specific rules to remove from the scope. Ignored when `removeAll` is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// When true, removes every rule currently in the scope (after any `add` is applied). Useful for clearing the location scope wholesale. + #[serde(skip_serializing_if = "Option::is_none")] + pub remove_all: Option, + /// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. + pub scope: PermissionsModifyRulesScope, } -/// Schema for the `UsageMetricsModelMetricTokenDetail` type. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9245,12 +10076,12 @@ pub struct UsageMetricsModelMetricRequests { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsModelMetricTokenDetail { - /// Accumulated token count for this token type - pub token_count: i64, +pub struct PermissionsModifyRulesResult { + /// Whether the operation succeeded + pub success: bool, } -/// Token usage metrics for this model +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9260,21 +10091,12 @@ pub struct UsageMetricsModelMetricTokenDetail { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsModelMetricUsage { - /// Total tokens read from prompt cache - pub cache_read_tokens: i64, - /// Total tokens written to prompt cache - pub cache_write_tokens: i64, - /// Total input tokens consumed - pub input_tokens: i64, - /// Total output tokens produced - pub output_tokens: i64, - /// Total output tokens used for reasoning - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_tokens: Option, +pub struct PermissionsNotifyPromptShownResult { + /// Whether the operation succeeded + pub success: bool, } -/// Schema for the `UsageMetricsModelMetric` type. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9284,20 +10106,12 @@ pub struct UsageMetricsModelMetricUsage { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsModelMetric { - /// Request count and cost metrics for this model - pub requests: UsageMetricsModelMetricRequests, - /// Token count details per type - #[serde(skip_serializing_if = "Option::is_none")] - pub token_details: Option>, - /// Accumulated nano-AI units cost for this model - #[serde(skip_serializing_if = "Option::is_none")] - pub total_nano_aiu: Option, - /// Token usage metrics for this model - pub usage: UsageMetricsModelMetricUsage, +pub struct PermissionsPathsAddResult { + /// Whether the operation succeeded + pub success: bool, } -/// Schema for the `UsageMetricsTokenDetail` type. +/// No parameters; returns the session's allow-listed directories. /// ///
    /// @@ -9307,12 +10121,9 @@ pub struct UsageMetricsModelMetric { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageMetricsTokenDetail { - /// Accumulated token count for this token type - pub token_count: i64, -} +pub struct PermissionsPathsListRequest {} -/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9322,35 +10133,12 @@ pub struct UsageMetricsTokenDetail { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UsageGetMetricsResult { - /// Aggregated code change metrics - pub code_changes: UsageMetricsCodeChanges, - /// Currently active model identifier - #[serde(skip_serializing_if = "Option::is_none")] - pub current_model: Option, - /// Input tokens from the most recent main-agent API call - pub last_call_input_tokens: i64, - /// Output tokens from the most recent main-agent API call - pub last_call_output_tokens: i64, - /// Per-model token and request metrics, keyed by model identifier - pub model_metrics: HashMap, - /// ISO 8601 timestamp when the session started - pub session_start_time: String, - /// Session-wide per-token-type accumulated token counts - #[serde(skip_serializing_if = "Option::is_none")] - pub token_details: Option>, - /// Total time spent in model API calls (milliseconds) - pub total_api_duration_ms: i64, - /// Session-wide accumulated nano-AI units cost - #[serde(skip_serializing_if = "Option::is_none")] - pub total_nano_aiu: Option, - /// Total user-initiated premium request cost across all models (may be fractional due to multipliers) - pub total_premium_request_cost: f64, - /// Raw count of user-initiated API requests - pub total_user_requests: i64, +pub struct PermissionsPathsUpdatePrimaryResult { + /// Whether the operation succeeded + pub success: bool, } -/// Schema for the `UserAuthInfo` type. +/// No parameters; returns currently-pending permission requests for the session. /// ///
    /// @@ -9360,19 +10148,9 @@ pub struct UsageGetMetricsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct UserAuthInfo { - /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. - #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_user: Option, - /// Authentication host. - pub host: String, - /// OAuth user login. - pub login: String, - /// OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct. - pub r#type: UserAuthInfoType, -} +pub struct PermissionsPendingRequestsRequest {} -/// A single changed file and its unified diff. +/// Clears session-scoped tool permission approvals, and optionally the location-scoped ones. /// ///
    /// @@ -9382,22 +10160,13 @@ pub struct UserAuthInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspaceDiffFileChange { - /// Type of change represented by this file diff. - pub change_type: WorkspaceDiffFileChangeType, - /// Unified diff content for the file. Empty when the diff was truncated. - pub diff: String, - /// Whether the diff content was omitted because it exceeded the per-file size limit. - #[serde(skip_serializing_if = "Option::is_none")] - pub is_truncated: Option, - /// Original file path for renamed files. +pub struct PermissionsResetSessionApprovalsRequest { + /// Whether location-scoped approvals are cleared too. Defaults to `true`. #[serde(skip_serializing_if = "Option::is_none")] - pub old_path: Option, - /// Path to the changed file, relative to the workspace root. - pub path: String, + pub include_location: Option, } -/// Workspace diff result for the requested mode. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9407,21 +10176,37 @@ pub struct WorkspaceDiffFileChange { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspaceDiffResult { - /// Default branch used for a branch diff, when branch mode was requested. +pub struct PermissionsResetSessionApprovalsResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Allow-all mode to apply for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionsSetAllowAllRequest { + /// Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`. #[serde(skip_serializing_if = "Option::is_none")] - pub base_branch: Option, - /// Changed files and their unified diffs. - pub changes: Vec, - /// Whether a requested branch diff fell back to unstaged changes because branch diff failed. - pub is_fallback: bool, - /// Effective mode used for the returned changes. - pub mode: WorkspaceDiffMode, - /// Diff mode requested by the client. - pub requested_mode: WorkspaceDiffMode, + pub enabled: Option, + /// Allow-all mode to apply. `on` enables full allow-all; `auto` enables advisory LLM auto-approval; `off` disables both. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session resolves a default judge model: `gpt-5.5` for CAPI sessions and the session's active model for BYOK sessions. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, } -/// Schema for the `WorkspacesCheckpoints` type. +/// Allow-all toggle for tool permission requests, with an optional telemetry source. /// ///
    /// @@ -9431,16 +10216,15 @@ pub struct WorkspaceDiffResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesCheckpoints { - /// Filename of the checkpoint within the workspace checkpoints directory - pub filename: String, - /// Checkpoint number assigned by the workspace manager - pub number: i64, - /// Human-readable checkpoint title - pub title: String, +pub struct PermissionsSetApproveAllRequest { + /// Whether to auto-approve all tool permission requests + pub enabled: bool, + /// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, } -/// Relative path and UTF-8 content for the workspace file to create or overwrite. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9450,14 +10234,12 @@ pub struct WorkspacesCheckpoints { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesCreateFileRequest { - /// File content to write as a UTF-8 string - pub content: String, - /// Relative path within the workspace files directory - pub path: String, +pub struct PermissionsSetApproveAllResult { + /// Whether the operation succeeded + pub success: bool, } -/// Parameters for computing a workspace diff. +/// Toggles whether permission prompts should be bridged into session events for this client. /// ///
    /// @@ -9467,54 +10249,27 @@ pub struct WorkspacesCreateFileRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesDiffRequest { - /// Diff mode requested by the client. - pub mode: WorkspaceDiffMode, +pub struct PermissionsSetRequiredRequest { + /// Whether the client wants `permission.requested` events bridged from the session-owned permission service. CLI clients that render prompt UI set this to `true` for as long as their listener is mounted; headless callers leave it unset (the default is `false`). + pub required: bool, } +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesGetWorkspaceResultWorkspace { - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - #[serde( - rename = "chronicle_sync_dismissed", - skip_serializing_if = "Option::is_none" - )] - pub chronicle_sync_dismissed: Option, - #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] - pub client_name: Option, - #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] - pub created_at: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] - pub host_type: Option, - pub id: String, - #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] - pub mc_last_event_id: Option, - #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] - pub mc_session_id: Option, - #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] - pub mc_task_id: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] - pub remote_steerable: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] - pub summary_count: Option, - #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] - pub updated_at: Option, - #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] - pub user_named: Option, +pub struct PermissionsSetRequiredResult { + /// Whether the operation succeeded + pub success: bool, } -/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// Indicates whether the operation succeeded. /// ///
    /// @@ -9524,15 +10279,12 @@ pub struct WorkspacesGetWorkspaceResultWorkspace { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesGetWorkspaceResult { - /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - /// Current workspace metadata, or null if not available - pub workspace: Option, +pub struct PermissionsUrlsSetUnrestrictedModeResult { + /// Whether the operation succeeded + pub success: bool, } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Whether the URL-permission policy should run in unrestricted mode. /// ///
    /// @@ -9542,12 +10294,12 @@ pub struct WorkspacesGetWorkspaceResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesListCheckpointsResult { - /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. - pub checkpoints: Vec, +pub struct PermissionUrlsSetUnrestrictedModeParams { + /// Whether to allow access to all URLs without prompting. Toggles the runtime's URL-permission policy in place. + pub enabled: bool, } -/// Relative paths of files stored in the session workspace files directory. +/// Optional message to echo back to the caller. /// ///
    /// @@ -9557,12 +10309,13 @@ pub struct WorkspacesListCheckpointsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesListFilesResult { - /// Relative file paths in the workspace files directory - pub files: Vec, +pub struct PingRequest { + /// Optional message to echo back + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, } -/// Checkpoint number to read. +/// Server liveness response, including the echoed message, current server timestamp, and protocol version. /// ///
    /// @@ -9572,12 +10325,16 @@ pub struct WorkspacesListFilesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesReadCheckpointRequest { - /// Checkpoint number to read - pub number: i64, +pub struct PingResult { + /// Echoed message (or default greeting) + pub message: String, + /// Server protocol version number + pub protocol_version: i64, + /// ISO 8601 timestamp when the server handled the ping + pub timestamp: String, } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// Existence, contents, and resolved path of the session plan file. /// ///
    /// @@ -9587,12 +10344,16 @@ pub struct WorkspacesReadCheckpointRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesReadCheckpointResult { - /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing +pub struct PlanReadResult { + /// The content of the plan file, or null if it does not exist pub content: Option, + /// Whether the plan file exists in the workspace + pub exists: bool, + /// Absolute file path of the plan file, or null if workspace is not enabled + pub path: Option, } -/// Relative path of the workspace file to read. +/// A single todo row read from the session SQL `todos` table. All fields are optional because the SQL schema is best-effort and the agent may not have populated every column. /// ///
    /// @@ -9602,12 +10363,22 @@ pub struct WorkspacesReadCheckpointResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesReadFileRequest { - /// Relative path within the workspace files directory - pub path: String, +pub struct PlanSqlTodosRow { + /// Todo description. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Todo identifier. + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + /// Todo status. + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Todo title. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, } -/// Contents of the requested workspace file as a UTF-8 string. +/// Todo rows read from the session SQL database. Empty when no session database is available. /// ///
    /// @@ -9617,12 +10388,12 @@ pub struct WorkspacesReadFileRequest { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesReadFileResult { - /// File content as a UTF-8 string - pub content: String, +pub struct PlanReadSqlTodosResult { + /// Rows from the session SQL todos table, ordered by creation time and id. + pub rows: Vec, } -/// Pasted content to save as a UTF-8 file in the session workspace. +/// A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another. /// ///
    /// @@ -9632,23 +10403,31 @@ pub struct WorkspacesReadFileResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesSaveLargePasteRequest { - /// Pasted content to save as a UTF-8 file - pub content: String, +pub struct PlanSqlTodoDependency { + /// ID of the todo it depends on. + pub depends_on: String, + /// ID of the todo that has the dependency. + pub todo_id: String, } +/// Todo rows + dependency edges read from the session SQL database. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesSaveLargePasteResultSaved { - /// Filename within the workspace files directory - pub filename: String, - /// Absolute filesystem path to the saved paste file - pub file_path: String, - /// Size of the saved file in bytes - pub size_bytes: i64, +pub struct PlanReadSqlTodosWithDependenciesResult { + /// Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does not affect the rows result and vice versa. + pub dependencies: Vec, + /// Rows from the session SQL todos table, ordered by creation time and id. Empty when no database, no todos table, or the SELECT failed. + pub rows: Vec, } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// Replacement contents to write to the session plan file. /// ///
    /// @@ -9658,12 +10437,12 @@ pub struct WorkspacesSaveLargePasteResultSaved { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspacesSaveLargePasteResult { - /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) - pub saved: Option, +pub struct PlanUpdateRequest { + /// The new content for the plan file + pub content: String, } -/// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). +/// Session plugin metadata, with name, marketplace, optional version, and enabled state. /// ///
    /// @@ -9673,68 +10452,42 @@ pub struct WorkspacesSaveLargePasteResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct WorkspaceSummary { - /// Branch checked out at session start, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// ISO 8601 timestamp when the workspace was created - #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] - pub created_at: Option, - /// Current working directory at session start - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Resolved git root for cwd, if any - #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Repository host type, if known - #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Workspace identifier (1:1 with sessionId) - pub id: String, - /// Display name for the session, if set - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any +pub struct Plugin { + /// Whether the plugin is currently enabled + pub enabled: bool, + /// Marketplace the plugin came from + pub marketplace: String, + /// Plugin name + pub name: String, + /// Installed version #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - /// ISO 8601 timestamp when the workspace was last updated - #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] - pub updated_at: Option, + pub version: Option, } -/// List of Copilot models available to the resolved user, including capabilities and billing metadata. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ModelsListResult { - /// List of available models with full metadata - pub models: Vec, -} - -/// Built-in tools available for the requested model, with their parameters and instructions. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct ToolsListResult { - /// List of available built-in tools with metadata - pub tools: Vec, -} - -/// User-configured MCP servers, keyed by server name. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct McpConfigListResult { - /// All MCP servers from user config, keyed by name - pub servers: HashMap, -} - -/// Skills discovered across global and project sources. +/// Result of installing a plugin. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SkillsDiscoverResult { - /// All discovered skills across all sources - pub skills: Vec, +pub struct PluginInstallResult { + /// Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warning: Option, + /// The newly installed plugin's metadata + pub plugin: InstalledPluginInfo, + /// Optional post-install message provided by the plugin (e.g. setup instructions) + #[serde(skip_serializing_if = "Option::is_none")] + pub post_install_message: Option, + /// Number of skills discovered and installed from the plugin + pub skills_installed: i64, } -/// Remote session connection result. +/// Plugins installed for the session, with their enabled state and version metadata. /// ///
    /// @@ -9744,14 +10497,12 @@ pub struct SkillsDiscoverResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsConnectResult { - /// Metadata for a connected remote session. - pub metadata: ConnectedRemoteSessionMetadata, - /// SDK session ID for the connected remote session. - pub session_id: SessionId, +pub struct PluginList { + /// Installed plugins + pub plugins: Vec, } -/// Persisted sessions matching the filter, ordered most-recently-modified first. +/// Plugins installed in user/global state. /// ///
    /// @@ -9761,12 +10512,12 @@ pub struct SessionsConnectResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsListResult { - /// Sessions ordered most-recently-modified first - pub sessions: Vec, +pub struct PluginListResult { + /// Installed plugins + pub plugins: Vec, } -/// ID of the local session bound to the given GitHub task, or omitted when none. +/// Plugin names (or specs) to disable. /// ///
    /// @@ -9776,13 +10527,12 @@ pub struct SessionsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsFindByTaskIdResult { - /// Omitted when no local session is bound to that GitHub task - #[serde(skip_serializing_if = "Option::is_none")] - pub session_id: Option, +pub struct PluginsDisableRequest { + /// Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins. + pub names: Vec, } -/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// Plugin names (or specs) to enable. /// ///
    /// @@ -9792,12 +10542,12 @@ pub struct SessionsFindByTaskIdResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsGetSizesResult { - /// Map of sessionId -> on-disk size in bytes for the session's workspace directory - pub sizes: HashMap, +pub struct PluginsEnableRequest { + /// Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API. + pub names: Vec, } -/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// Plugin source and optional working directory for relative-path resolution. /// ///
    /// @@ -9807,12 +10557,15 @@ pub struct SessionsGetSizesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsBulkDeleteResult { - /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). - pub freed_bytes: HashMap, +pub struct PluginsInstallRequest { + /// Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result. + pub source: String, + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// Marketplace source and optional working directory for relative-path resolution. /// ///
    /// @@ -9822,20 +10575,15 @@ pub struct SessionsBulkDeleteResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsPruneOldResult { - /// Session IDs that would be deleted in dry-run mode (always empty otherwise) - pub candidates: Vec, - /// Session IDs that were deleted (always empty in dry-run mode) - pub deleted: Vec, - /// True when no deletions were actually performed - pub dry_run: bool, - /// Total bytes freed (actual when not dry-run, projected when dry-run) - pub freed_bytes: i64, - /// Session IDs that were skipped (e.g., named sessions) - pub skipped: Vec, +pub struct PluginsMarketplacesAddRequest { + /// Marketplace source. Accepts the same forms as the CLI: "owner/repo" or "owner/repo#ref" (GitHub), an http/https/ssh URL (optionally with #ref), a git scp-style URL (user@host:path), or a local path. The marketplace's own name (from its manifest) is used as the registration key. + pub source: String, + /// Working directory used to resolve relative local paths in `source`. Defaults to the server's current working directory. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, } -/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// Name of the marketplace whose plugin catalog to fetch. /// ///
    /// @@ -9845,12 +10593,12 @@ pub struct SessionsPruneOldResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsEnrichMetadataResult { - /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. - pub sessions: Vec, +pub struct PluginsMarketplacesBrowseRequest { + /// Marketplace name to browse + pub name: String, } -/// Queued repo-level startup prompts and the total hook command count after loading. +/// Optional marketplace name; omit to refresh all. /// ///
    /// @@ -9860,14 +10608,13 @@ pub struct SessionsEnrichMetadataResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionsLoadDeferredRepoHooksResult { - /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. - pub hook_count: i64, - /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. - pub startup_prompts: Vec, +pub struct PluginsMarketplacesRefreshRequest { + /// Marketplace name to refresh. When omitted, every registered marketplace is refreshed. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, } -/// Identifies the target session. +/// Name of the marketplace to remove and an optional force flag. /// ///
    /// @@ -9877,12 +10624,15 @@ pub struct SessionsLoadDeferredRepoHooksResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSuspendParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PluginsMarketplacesRemoveRequest { + /// When true, also uninstall every plugin sourced from this marketplace. When false (default), removal is a no-op if any plugin from this marketplace is installed and the dependent plugin names are returned in the result. + #[serde(skip_serializing_if = "Option::is_none")] + pub force: Option, + /// Marketplace name to remove + pub name: String, } -/// Result of sending a user message +/// Optional flags controlling which side effects the reload performs. /// ///
    /// @@ -9892,12 +10642,25 @@ pub struct SessionSuspendParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSendResult { - /// Unique identifier assigned to the message - pub message_id: String, +pub struct PluginsReloadRequest { + /// When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`. + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_repo_hooks: Option, + /// Re-run custom-agent discovery after refreshing plugins. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub reload_custom_agents: Option, + /// Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session). + #[serde(skip_serializing_if = "Option::is_none")] + pub reload_extensions: Option, + /// Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub reload_hooks: Option, + /// Reload MCP server connections after refreshing plugins. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub reload_mcp: Option, } -/// Result of aborting the current turn +/// Name (or spec) of the plugin to uninstall. /// ///
    /// @@ -9907,15 +10670,15 @@ pub struct SessionSendResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAbortResult { - /// Error message if the abort failed +pub struct PluginsUninstallRequest { + /// Stable source identity for a direct (non-marketplace) install. Disambiguates uninstall when multiple installed plugins share the same name. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether the abort completed successfully - pub success: bool, + pub direct_source_id: Option, + /// Plugin name or "plugin@marketplace" spec to uninstall. When ambiguous, prefer the fully-qualified spec. + pub name: String, } -/// Identifies the target session. +/// Name (or spec) of the plugin to update. /// ///
    /// @@ -9925,12 +10688,12 @@ pub struct SessionAbortResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAuthGetStatusParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PluginsUpdateRequest { + /// Plugin name or "plugin@marketplace" spec to update. + pub name: String, } -/// Authentication status and account metadata for the session. +/// Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error. /// ///
    /// @@ -9940,27 +10703,28 @@ pub struct SessionAuthGetStatusParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAuthGetStatusResult { - /// Authentication type - #[serde(skip_serializing_if = "Option::is_none")] - pub auth_type: Option, - /// Copilot plan tier (e.g., individual_pro, business) +pub struct PluginUpdateAllEntry { + /// Error message (failure only) #[serde(skip_serializing_if = "Option::is_none")] - pub copilot_plan: Option, - /// Authentication host URL + pub error: Option, + /// Marketplace the plugin came from. Empty string ("") for direct installs. + pub marketplace: String, + /// Plugin name that was updated + pub name: String, + /// Version after the update, when available #[serde(skip_serializing_if = "Option::is_none")] - pub host: Option, - /// Whether the session has resolved authentication - pub is_authenticated: bool, - /// Authenticated login/username, if available + pub new_version: Option, + /// Previously installed version, when available #[serde(skip_serializing_if = "Option::is_none")] - pub login: Option, - /// Human-readable authentication status description + pub previous_version: Option, + /// Number of skills installed after the update (success only) #[serde(skip_serializing_if = "Option::is_none")] - pub status_message: Option, + pub skills_installed: Option, + /// Whether the update succeeded for this plugin + pub success: bool, } -/// Indicates whether the credential update succeeded. +/// Result of updating all installed plugins. /// ///
    /// @@ -9970,12 +10734,12 @@ pub struct SessionAuthGetStatusResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAuthSetCredentialsResult { - /// Whether the operation succeeded - pub success: bool, +pub struct PluginUpdateAllResult { + /// Per-plugin update results in deterministic order. + pub results: Vec, } -/// Identifies the target session. +/// Result of updating a single plugin. /// ///
    /// @@ -9985,12 +10749,18 @@ pub struct SessionAuthSetCredentialsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PluginUpdateResult { + /// Version after the update, when reported by the plugin manifest + #[serde(skip_serializing_if = "Option::is_none")] + pub new_version: Option, + /// Version that was previously installed, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_version: Option, + /// Number of skills discovered and installed after the update + pub skills_installed: i64, } -/// Declared canvases available in this session. +/// A BYOK model definition referencing a named provider. /// ///
    /// @@ -10000,12 +10770,35 @@ pub struct SessionCanvasListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListResult { - /// Declared canvases available in this session - pub canvases: Vec, +pub struct ProviderModelConfig { + /// Optional capability overrides (vision, tool_calls, reasoning, etc.). + #[serde(skip_serializing_if = "Option::is_none")] + pub capabilities: Option, + /// Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified `provider/id`. + pub id: String, + /// Maximum context window tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_context_window_tokens: Option, + /// Maximum output tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Maximum prompt/input tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// Well-known base model id used for behavior/capability/config lookup. Defaults to `id`. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Display name for model pickers. Defaults to the provider-qualified selection id (`provider/id`). + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Name of the NamedProviderConfig that serves this model. + pub provider: String, + /// The model name sent to the provider API for inference. Defaults to `id`. + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_model: Option, } -/// Identifies the target session. +/// BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. /// ///
    /// @@ -10015,12 +10808,16 @@ pub struct SessionCanvasListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListOpenParams { - /// Target session identifier - pub session_id: SessionId, +pub struct ProviderAddRequest { + /// BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry. + #[serde(skip_serializing_if = "Option::is_none")] + pub models: Option>, + /// Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'. + #[serde(skip_serializing_if = "Option::is_none")] + pub providers: Option>, } -/// Live open-canvas snapshot. +/// The selectable model entries synthesized for the models added by this call. /// ///
    /// @@ -10030,12 +10827,12 @@ pub struct SessionCanvasListOpenParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasListOpenResult { - /// Currently open canvas instances - pub open_canvases: Vec, +pub struct ProviderAddResult { + /// Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added. + pub models: Vec, } -/// Open canvas instance snapshot. +/// Custom model-provider configuration (BYOK). /// ///
    /// @@ -10045,35 +10842,51 @@ pub struct SessionCanvasListOpenResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasOpenResult { - /// Runtime-controlled routing state for an open canvas instance. - pub availability: CanvasInstanceAvailability, - /// Provider-local canvas identifier - pub canvas_id: String, - /// Owning provider identifier - pub extension_id: String, - /// Owning extension display name, when available +pub struct ProviderConfig { + /// API key. Optional for local providers like Ollama. #[serde(skip_serializing_if = "Option::is_none")] - pub extension_name: Option, - /// Input supplied when the instance was opened + pub api_key: Option, + /// Azure-specific provider options. #[serde(skip_serializing_if = "Option::is_none")] - pub input: Option, - /// Stable caller-supplied canvas instance identifier - pub instance_id: String, - /// Whether this snapshot came from an idempotent reopen - pub reopen: bool, - /// Provider-supplied status text + pub azure: Option, + /// API endpoint URL. + pub base_url: String, + /// Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set. #[serde(skip_serializing_if = "Option::is_none")] - pub status: Option, - /// Rendered title + pub bearer_token: Option, + /// When true, the SDK client supplies bearer tokens on demand: the runtime calls the client-session `providerToken.getToken` callback before each request and applies the returned token as an `Authorization: Bearer ` header. This is the bearer/OAuth scheme used by Azure AD / managed-identity tokens and provider OAuth access tokens (including Anthropic's), not a provider-specific API-key header such as Anthropic's `x-api-key`. The token-acquiring function itself stays on the SDK side and is never serialized; only this flag crosses the wire. When set alongside `apiKey`/`bearerToken`, the callback takes precedence: the runtime applies the token returned by `providerToken.getToken` as the `Authorization: Bearer` header for each request and does not send the static credential. #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// URL for web-rendered canvases + pub has_bearer_token_provider: Option, + /// Custom HTTP headers to include in all outbound requests to the provider. #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, + pub headers: Option>, + /// Maximum context window tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_context_window_tokens: Option, + /// Maximum output tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Maximum prompt/input tokens for the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Provider transport. Defaults to "http". + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, + /// Wire API format (openai/azure only). Defaults to "completions". + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_api: Option, + /// The model identifier sent to the provider API for inference (the "wire" model), as opposed to modelId which is the well-known base. + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_model: Option, } -/// Canvas action invocation result. +/// Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. /// ///
    /// @@ -10083,13 +10896,20 @@ pub struct SessionCanvasOpenResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasActionInvokeResult { - /// Provider-supplied action result +pub struct ProviderSessionToken { + /// When the token expires, if known. Callers should refresh by calling `getEndpoint` again before this time, or reactively on any 401/403 response from `baseUrl`. #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, + pub expires_at: Option, + /// HTTP header name the token must be sent under. + pub header: String, + /// The model the token is bound to, when applicable. When set, the token is only valid for requests against this model. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// The short-lived token value. + pub token: String, } -/// Identifies the target session. +/// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
    /// @@ -10099,12 +10919,28 @@ pub struct SessionCanvasActionInvokeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelGetCurrentParams { - /// Target session identifier - pub session_id: SessionId, +pub struct ProviderEndpoint { + /// A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + #[serde(skip_serializing_if = "Option::is_none")] + pub api_key: Option, + /// Base URL to pass to the LLM client library. + pub base_url: String, + /// HTTP headers the caller must include on every outbound request. + pub headers: HashMap, + /// Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_token: Option, + /// Transport to be used for provider requests. + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Provider family. Matches the `type` field of a BYOK provider config. + pub r#type: ProviderEndpointType, + /// Wire API to be used, when required for the provider type. + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_api: Option, } -/// The currently selected model, reasoning effort, and context tier for the session. +/// Optional model identifier to scope the endpoint snapshot to. /// ///
    /// @@ -10114,19 +10950,13 @@ pub struct SessionModelGetCurrentParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelGetCurrentResult { - /// Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. - #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, - /// Currently active model identifier +pub struct ProviderGetEndpointRequest { + /// Model identifier the caller intends to use against the returned endpoint. Used to pick the correct wire shape. Omit to use whichever model the session is currently using. #[serde(skip_serializing_if = "Option::is_none")] pub model_id: Option, - /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. - #[serde(skip_serializing_if = "Option::is_none")] - pub reasoning_effort: Option, } -/// The model identifier active on the session after the switch. +/// Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request. /// ///
    /// @@ -10136,13 +10966,14 @@ pub struct SessionModelGetCurrentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelSwitchToResult { - /// Currently active model identifier after the switch - #[serde(skip_serializing_if = "Option::is_none")] - pub model_id: Option, +pub struct ProviderTokenAcquireRequest { + /// Target session identifier + pub session_id: SessionId, + /// Name of the BYOK provider needing a token. For the legacy whole-session `provider` this is the implicit provider name; for named providers it is `NamedProviderConfig.name`. + pub provider_name: String, } -/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. +/// A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. /// ///
    /// @@ -10152,12 +10983,12 @@ pub struct SessionModelSwitchToResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelSetReasoningEffortResult { - /// Reasoning effort level recorded on the session after the update - pub reasoning_effort: String, +pub struct ProviderTokenAcquireResult { + /// The bearer token value (without the `Bearer ` prefix). + pub token: String, } -/// The list of models available to this session. +/// Blob attachment with inline base64-encoded data /// ///
    /// @@ -10167,15 +10998,19 @@ pub struct SessionModelSetReasoningEffortResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModelListResult { - /// Available models, ordered with the most preferred default first. - pub list: Vec, - /// Per-quota snapshots returned alongside the model list, keyed by quota type. +pub struct PushAttachmentBlob { + /// Base64-encoded content + pub data: String, + /// User-facing display name for the attachment #[serde(skip_serializing_if = "Option::is_none")] - pub quota_snapshots: Option>, + pub display_name: Option, + /// MIME type of the inline data + pub mime_type: String, + /// Attachment type discriminator + pub r#type: PushAttachmentBlobType, } -/// Identifies the target session. +/// Directory attachment /// ///
    /// @@ -10185,12 +11020,16 @@ pub struct SessionModelListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionModeGetParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentDirectory { + /// User-facing display name for the attachment + pub display_name: String, + /// Absolute directory path + pub path: String, + /// Attachment type discriminator + pub r#type: PushAttachmentDirectoryType, } -/// Identifies the target session. +/// Optional line range to scope the attachment to a specific section of the file /// ///
    /// @@ -10200,12 +11039,14 @@ pub struct SessionModeGetParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionNameGetParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentFileLineRange { + /// End line number (1-based, inclusive) + pub end: i64, + /// Start line number (1-based) + pub start: i64, } -/// The session's friendly name, or null when not yet set. +/// File attachment /// ///
    /// @@ -10215,12 +11056,19 @@ pub struct SessionNameGetParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionNameGetResult { - /// The session name (user-set or auto-generated), or null if not yet set - pub name: Option, +pub struct PushAttachmentFile { + /// User-facing display name for the attachment + pub display_name: String, + /// Optional line range to scope the attachment to a specific section of the file + #[serde(skip_serializing_if = "Option::is_none")] + pub line_range: Option, + /// Absolute file path + pub path: String, + /// Attachment type discriminator + pub r#type: PushAttachmentFileType, } -/// Indicates whether the auto-generated summary was applied as the session's name. +/// Pointer to a GitHub repository. /// ///
    /// @@ -10230,12 +11078,17 @@ pub struct SessionNameGetResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionNameSetAutoResult { - /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. - pub applied: bool, +pub struct PushGitHubRepoRef { + /// Numeric GitHub repository id + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + /// Repository name (without owner) + pub name: String, + /// Repository owner login (user or organization) + pub owner: String, } -/// Identifies the target session. +/// Pointer to a GitHub Actions job. /// ///
    /// @@ -10245,12 +11098,25 @@ pub struct SessionNameSetAutoResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPlanReadParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentGitHubActionsJob { + /// Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs. + #[serde(skip_serializing_if = "Option::is_none")] + pub conclusion: Option, + /// Job id within the workflow run + pub job_id: i64, + /// Display name of the job + pub job_name: String, + /// Repository the workflow run belongs to + pub repo: PushGitHubRepoRef, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubActionsJobType, + /// URL to the job on GitHub + pub url: String, + /// Display name of the workflow the job ran in + pub workflow_name: String, } -/// Existence, contents, and resolved path of the session plan file. +/// Pointer to a GitHub commit. /// ///
    /// @@ -10260,16 +11126,20 @@ pub struct SessionPlanReadParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPlanReadResult { - /// The content of the plan file, or null if it does not exist - pub content: Option, - /// Whether the plan file exists in the workspace - pub exists: bool, - /// Absolute file path of the plan file, or null if workspace is not enabled - pub path: Option, +pub struct PushAttachmentGitHubCommit { + /// First line of the commit message + pub message: String, + /// Full commit SHA + pub oid: String, + /// Repository the commit belongs to + pub repo: PushGitHubRepoRef, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubCommitType, + /// URL to the commit on GitHub + pub url: String, } -/// Identifies the target session. +/// Pointer to a file in a GitHub repository at a specific ref. /// ///
    /// @@ -10279,12 +11149,20 @@ pub struct SessionPlanReadResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPlanDeleteParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentGitHubFile { + /// Repository-relative path to the file + pub path: String, + /// Git ref the file is read at (branch, tag, or commit SHA) + pub r#ref: String, + /// Repository the file lives in + pub repo: PushGitHubRepoRef, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubFileType, + /// URL to the file on GitHub + pub url: String, } -/// Identifies the target session. +/// One side of a file diff (head or base) /// ///
    /// @@ -10294,54 +11172,39 @@ pub struct SessionPlanDeleteParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesGetWorkspaceParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentGitHubFileDiffSide { + /// Repository-relative path to the file + pub path: String, + /// Git ref (branch, tag, or commit SHA) the file is read at + pub r#ref: String, + /// Repository the file lives in + pub repo: PushGitHubRepoRef, } +/// Pointer to a single-file diff. At least one of `head` and `base` must be present. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesGetWorkspaceResultWorkspace { - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - #[serde( - rename = "chronicle_sync_dismissed", - skip_serializing_if = "Option::is_none" - )] - pub chronicle_sync_dismissed: Option, - #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] - pub client_name: Option, - #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] - pub created_at: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. - #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] - pub host_type: Option, - pub id: String, - #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] - pub mc_last_event_id: Option, - #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] - pub mc_session_id: Option, - #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] - pub mc_task_id: Option, +pub struct PushAttachmentGitHubFileDiff { + /// File location on the base side of the diff. Absent for additions. #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] - pub remote_steerable: Option, + pub base: Option, + /// File location on the head side of the diff. Absent for deletions. #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] - pub summary_count: Option, - #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] - pub updated_at: Option, - #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] - pub user_named: Option, + pub head: Option, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubFileDiffType, + /// URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL) + pub url: String, } -/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// GitHub issue, pull request, or discussion reference /// ///
    /// @@ -10351,15 +11214,22 @@ pub struct SessionWorkspacesGetWorkspaceResultWorkspace { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesGetWorkspaceResult { - /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). - #[serde(skip_serializing_if = "Option::is_none")] - pub path: Option, - /// Current workspace metadata, or null if not available - pub workspace: Option, +pub struct PushAttachmentGitHubReference { + /// Issue, pull request, or discussion number + pub number: i64, + /// Type of GitHub reference + pub reference_type: PushAttachmentGitHubReferenceType, + /// Current state of the referenced item (e.g., open, closed, merged) + pub state: String, + /// Title of the referenced item + pub title: String, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubReferenceType, + /// URL to the referenced item on GitHub + pub url: String, } -/// Identifies the target session. +/// Pointer to a GitHub release. /// ///
    /// @@ -10369,12 +11239,20 @@ pub struct SessionWorkspacesGetWorkspaceResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesListFilesParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentGitHubRelease { + /// Human-readable release name + pub name: String, + /// Repository the release belongs to + pub repo: PushGitHubRepoRef, + /// Git tag the release is anchored to + pub tag_name: String, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubReleaseType, + /// URL to the release on GitHub + pub url: String, } -/// Relative paths of files stored in the session workspace files directory. +/// Pointer to a GitHub repository. /// ///
    /// @@ -10384,12 +11262,22 @@ pub struct SessionWorkspacesListFilesParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesListFilesResult { - /// Relative file paths in the workspace files directory - pub files: Vec, +pub struct PushAttachmentGitHubRepository { + /// Short description of the repository + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + /// Repository pointer + pub repo: PushGitHubRepoRef, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubRepositoryType, + /// URL to the repository on GitHub + pub url: String, } -/// Contents of the requested workspace file as a UTF-8 string. +/// Pointer to a line range inside a file in a GitHub repository. /// ///
    /// @@ -10399,12 +11287,22 @@ pub struct SessionWorkspacesListFilesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesReadFileResult { - /// File content as a UTF-8 string - pub content: String, +pub struct PushAttachmentGitHubSnippet { + /// Line range the snippet covers + pub line_range: PushAttachmentFileLineRange, + /// Repository-relative path to the file + pub path: String, + /// Git ref the file is read at (branch, tag, or commit SHA) + pub r#ref: String, + /// Repository the file lives in + pub repo: PushGitHubRepoRef, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubSnippetType, + /// URL to the snippet on GitHub (with line anchor) + pub url: String, } -/// Identifies the target session. +/// One side of a tree comparison (head or base) /// ///
    /// @@ -10414,12 +11312,14 @@ pub struct SessionWorkspacesReadFileResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesListCheckpointsParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentGitHubTreeComparisonSide { + /// Repository the revision belongs to + pub repo: PushGitHubRepoRef, + /// Git revision (branch, tag, or commit SHA) + pub revision: String, } -/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// Pointer to a comparison between two git revisions. /// ///
    /// @@ -10429,12 +11329,18 @@ pub struct SessionWorkspacesListCheckpointsParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesListCheckpointsResult { - /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. - pub checkpoints: Vec, +pub struct PushAttachmentGitHubTreeComparison { + /// Base side of the comparison + pub base: PushAttachmentGitHubTreeComparisonSide, + /// Head side of the comparison + pub head: PushAttachmentGitHubTreeComparisonSide, + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubTreeComparisonType, + /// URL to the comparison on GitHub + pub url: String, } -/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// Generic GitHub URL reference. /// ///
    /// @@ -10444,23 +11350,14 @@ pub struct SessionWorkspacesListCheckpointsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesReadCheckpointResult { - /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing - pub content: Option, -} - -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesSaveLargePasteResultSaved { - /// Filename within the workspace files directory - pub filename: String, - /// Absolute filesystem path to the saved paste file - pub file_path: String, - /// Size of the saved file in bytes - pub size_bytes: i64, +pub struct PushAttachmentGitHubUrl { + /// Attachment type discriminator + pub r#type: PushAttachmentGitHubUrlType, + /// URL to the GitHub resource + pub url: String, } -/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// End position of the selection /// ///
    /// @@ -10470,12 +11367,14 @@ pub struct SessionWorkspacesSaveLargePasteResultSaved { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesSaveLargePasteResult { - /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) - pub saved: Option, +pub struct PushAttachmentSelectionDetailsEnd { + /// End character offset within the line (0-based) + pub character: i64, + /// End line number (0-based) + pub line: i64, } -/// Workspace diff result for the requested mode. +/// Start position of the selection /// ///
    /// @@ -10485,21 +11384,14 @@ pub struct SessionWorkspacesSaveLargePasteResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionWorkspacesDiffResult { - /// Default branch used for a branch diff, when branch mode was requested. - #[serde(skip_serializing_if = "Option::is_none")] - pub base_branch: Option, - /// Changed files and their unified diffs. - pub changes: Vec, - /// Whether a requested branch diff fell back to unstaged changes because branch diff failed. - pub is_fallback: bool, - /// Effective mode used for the returned changes. - pub mode: WorkspaceDiffMode, - /// Diff mode requested by the client. - pub requested_mode: WorkspaceDiffMode, +pub struct PushAttachmentSelectionDetailsStart { + /// Start character offset within the line (0-based) + pub character: i64, + /// Start line number (0-based) + pub line: i64, } -/// Identifies the target session. +/// Position range of the selection within the file /// ///
    /// @@ -10509,12 +11401,14 @@ pub struct SessionWorkspacesDiffResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstructionsGetSourcesParams { - /// Target session identifier - pub session_id: SessionId, +pub struct PushAttachmentSelectionDetails { + /// End position of the selection + pub end: PushAttachmentSelectionDetailsEnd, + /// Start position of the selection + pub start: PushAttachmentSelectionDetailsStart, } -/// Instruction sources loaded for the session, in merge order. +/// Code selection attachment from an editor /// ///
    /// @@ -10524,12 +11418,20 @@ pub struct SessionInstructionsGetSourcesParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionInstructionsGetSourcesResult { - /// Instruction sources for the session - pub sources: Vec, +pub struct PushAttachmentSelection { + /// User-facing display name for the selection + pub display_name: String, + /// Absolute path to the file containing the selection + pub file_path: String, + /// Position range of the selection within the file + pub selection: PushAttachmentSelectionDetails, + /// The selected text content + pub text: String, + /// Attachment type discriminator + pub r#type: PushAttachmentSelectionType, } -/// Indicates whether fleet mode was successfully activated. +/// Inputs for starting a deferred-idle drain. /// ///
    /// @@ -10539,12 +11441,12 @@ pub struct SessionInstructionsGetSourcesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFleetStartResult { - /// Whether fleet mode was successfully activated - pub started: bool, +pub struct QueueBeginDeferredIdleDrainRequest { + /// Whether the host still has active background work. + pub active_background_work: bool, } -/// Identifies the target session. +/// Whether a deferred-idle drain should run. /// ///
    /// @@ -10554,12 +11456,12 @@ pub struct SessionFleetStartResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueBeginDeferredIdleDrainResult { + /// True when the host should run finishDeferredIdleDrain asynchronously. + pub should_drain: bool, } -/// Custom agents available to the session. +/// Internal filter for consuming queued system notifications. /// ///
    /// @@ -10569,12 +11471,12 @@ pub struct SessionAgentListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentListResult { - /// Available custom agents - pub agents: Vec, +pub struct QueueConsumeSystemNotificationsRequest { + /// Opaque runtime-owned filter object. + pub filter: serde_json::Value, } -/// Identifies the target session. +/// Queued-command response indicating the host executed the command, with an optional flag to stop queue processing. /// ///
    /// @@ -10584,12 +11486,15 @@ pub struct SessionAgentListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentGetCurrentParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueuedCommandHandled { + /// The host actually executed the queued command. + pub handled: bool, + /// When true, the runtime will not process subsequent queued commands until a new request comes in. + #[serde(skip_serializing_if = "Option::is_none")] + pub stop_processing_queue: Option, } -/// The currently selected custom agent, or null when using the default agent. +/// Queued-command response indicating the host did not execute the command and the queue may continue. /// ///
    /// @@ -10599,12 +11504,12 @@ pub struct SessionAgentGetCurrentParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentGetCurrentResult { - /// Currently selected custom agent, or null if using the default agent - pub agent: AgentInfo, +pub struct QueuedCommandNotHandled { + /// The host did not execute the queued command. Unblocks the queue without claiming the command was processed (e.g. when the handler threw before completing). + pub handled: bool, } -/// The newly selected custom agent. +/// Inputs for marking session.idle deferred in native state. /// ///
    /// @@ -10614,12 +11519,12 @@ pub struct SessionAgentGetCurrentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentSelectResult { - /// The newly selected custom agent - pub agent: AgentInfo, +pub struct QueueDeferSessionIdleRequest { + /// Whether the deferred idle was caused by an aborted foreground turn. + pub aborted: bool, } -/// Identifies the target session. +/// Parameters for duplicating a queued item. /// ///
    /// @@ -10629,12 +11534,11 @@ pub struct SessionAgentSelectResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentDeselectParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueDuplicateAtRequest { + pub id: String, } -/// Identifies the target session. +/// Result of duplicating a queued item. /// ///
    /// @@ -10644,12 +11548,12 @@ pub struct SessionAgentDeselectParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentReloadParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueDuplicateAtResult { + /// Fresh stable opaque id assigned to the duplicate. + pub id: String, } -/// Custom agents available to the session after reloading definitions from disk. +/// Result of enqueueing the resume-pending wake item. /// ///
    /// @@ -10659,12 +11563,12 @@ pub struct SessionAgentReloadParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionAgentReloadResult { - /// Reloaded custom agents - pub agents: Vec, +pub struct QueueEnqueueResumePendingResult { + /// True when a wake item was newly queued. + pub queued: bool, } -/// Identifier assigned to the newly started background agent task. +/// Inputs for completing a deferred-idle drain. /// ///
    /// @@ -10674,12 +11578,14 @@ pub struct SessionAgentReloadResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksStartAgentResult { - /// Generated agent ID for the background task - pub agent_id: String, +pub struct QueueFinishDeferredIdleDrainRequest { + /// Whether the host still has active background work. + pub active_background_work: bool, + /// Whether native queued work remains. + pub has_pending: bool, } -/// Identifies the target session. +/// Action selected by the native deferred-idle drain. /// ///
    /// @@ -10689,12 +11595,14 @@ pub struct SessionTasksStartAgentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueFinishDeferredIdleDrainResult { + /// Whether the deferred idle was caused by an aborted foreground turn. + pub aborted: bool, + /// One of none, processQueue, or emitSessionIdle. + pub action: String, } -/// Background tasks currently tracked by the session. +/// Whether the native queue has pending work. /// ///
    /// @@ -10704,12 +11612,12 @@ pub struct SessionTasksListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksListResult { - /// Currently tracked tasks - pub tasks: Vec, +pub struct QueueHasPendingResult { + /// True when queued or immediate native work is pending. + pub has_pending: bool, } -/// Identifies the target session. +/// Serializable message fields accepted by queue.insertAt. /// ///
    /// @@ -10719,12 +11627,45 @@ pub struct SessionTasksListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksRefreshParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueInsertMessage { + /// Optional explicit agent mode. When omitted, the session's current mode is assigned. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_mode: Option, + /// Optional attachments for the message. + #[serde(skip_serializing_if = "Option::is_none")] + pub attachments: Option>, + /// Whether the message is billable. + #[serde(skip_serializing_if = "Option::is_none")] + pub billable: Option, + /// Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity. + #[serde(skip_serializing_if = "Option::is_none")] + pub delivery: Option, + /// Optional user-facing display text. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// Accepted for SendOptions compatibility but ignored; inserted items always use queued delivery semantics. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// Accepted for SendOptions compatibility but ignored; the requested public position controls placement. + #[serde(skip_serializing_if = "Option::is_none")] + pub prepend: Option, + /// The user message text. + pub prompt: String, + /// Per-turn request headers. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_headers: Option>, + /// Required tool name for the turn, when any. + #[serde(skip_serializing_if = "Option::is_none")] + pub required_tool: Option, + /// Optional provenance source. `system` is rejected: it would hide the inserted row from `pendingItems` and make it unaddressable while still executing, so inserted items must stay visible. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state. + #[serde(skip_serializing_if = "Option::is_none")] + pub wait: Option, } -/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. +/// Parameters for inserting a queued message at a public visible position. /// ///
    /// @@ -10734,9 +11675,13 @@ pub struct SessionTasksRefreshParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksRefreshResult {} +pub struct QueueInsertAtRequest { + pub message: QueueInsertMessage, + /// Zero-based position in the public visible queue. Values outside the queue clamp to an end. + pub position: i64, +} -/// Identifies the target session. +/// Result of inserting a queued message. /// ///
    /// @@ -10746,12 +11691,12 @@ pub struct SessionTasksRefreshResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksWaitForPendingParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueInsertAtResult { + /// Fresh stable opaque id assigned to the inserted item. + pub id: String, } -/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +/// Parameters for moving a queued item by stable id. /// ///
    /// @@ -10761,9 +11706,14 @@ pub struct SessionTasksWaitForPendingParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksWaitForPendingResult {} +pub struct QueueMoveItemRequest { + /// Stable opaque queued-item id. + pub id: String, + /// Zero-based target position in the public visible queue. Values outside the queue clamp to an end. + pub to_position: i64, +} -/// Progress information for the task, or null when no task with that ID is tracked. +/// Result of moving a queued item. /// ///
    /// @@ -10773,12 +11723,12 @@ pub struct SessionTasksWaitForPendingResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksGetProgressResult { - /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. - pub progress: Option, +pub struct QueueMoveItemResult { + /// True when the item changed position; false when it was already at the requested position. + pub changed: bool, } -/// Identifies the target session. +/// User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change. /// ///
    /// @@ -10788,12 +11738,18 @@ pub struct SessionTasksGetProgressResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksGetCurrentPromotableParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueuePendingItems { + /// Agent mode stored on this queued entry, as stamped when it was enqueued. Items without an explicit mode report interactive. This is not necessarily the mode that will constrain the turn: a plan or autopilot session applies its own write gate, continuation loop and permission posture to every drained item regardless of the mode stored here. + pub agent_mode: SendAgentMode, + /// Human-readable text to display for this queue entry in the UI + pub display_text: String, + /// Stable opaque id for the canonical queued item. Batch rows share one id. + pub id: String, + /// Whether this item is a queued user message or a queued slash command / model change + pub kind: QueuePendingItemsKind, } -/// The first sync-waiting task that can currently be promoted to background mode. +/// Snapshot of the session's pending queued items and immediate-steering messages. /// ///
    /// @@ -10803,13 +11759,14 @@ pub struct SessionTasksGetCurrentPromotableParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksGetCurrentPromotableResult { - /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. - #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, +pub struct QueuePendingItemsResult { + /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. + pub items: Vec, + /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + pub steering_messages: Vec, } -/// Indicates whether the task was successfully promoted to background mode. +/// Parameters for removing a queued item by stable id. /// ///
    /// @@ -10819,12 +11776,11 @@ pub struct SessionTasksGetCurrentPromotableResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksPromoteToBackgroundResult { - /// Whether the task was successfully promoted to background mode - pub promoted: bool, +pub struct QueueRemoveAtRequest { + pub id: String, } -/// Identifies the target session. +/// Result of removing a queued item. /// ///
    /// @@ -10834,12 +11790,12 @@ pub struct SessionTasksPromoteToBackgroundResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksPromoteCurrentToBackgroundParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueRemoveAtResult { + /// True when the addressed item was removed. + pub removed: bool, } -/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// Indicates whether a user-facing pending item was removed. /// ///
    /// @@ -10849,13 +11805,12 @@ pub struct SessionTasksPromoteCurrentToBackgroundParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksPromoteCurrentToBackgroundResult { - /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. - #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, +pub struct QueueRemoveMostRecentResult { + /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + pub removed: bool, } -/// Indicates whether the background task was successfully cancelled. +/// Parameters for steering a queued message into a live turn. /// ///
    /// @@ -10865,12 +11820,11 @@ pub struct SessionTasksPromoteCurrentToBackgroundResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksCancelResult { - /// Whether the task was successfully cancelled - pub cancelled: bool, +pub struct QueueSendNowRequest { + pub id: String, } -/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// Result of trying to steer a queued message into a live turn. /// ///
    /// @@ -10880,12 +11834,12 @@ pub struct SessionTasksCancelResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksRemoveResult { - /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). - pub removed: bool, +pub struct QueueSendNowResult { + /// True when the item was accepted into the steering lane; false when no main turn was live. + pub steered: bool, } -/// Indicates whether the message was delivered, with an error message when delivery failed. +/// Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. /// ///
    /// @@ -10895,15 +11849,11 @@ pub struct SessionTasksRemoveResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionTasksSendMessageResult { - /// Error message if delivery failed - #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// Whether the message was successfully delivered or steered - pub sent: bool, +pub struct QueueSetDrainPausedRequest { + pub paused: bool, } -/// Identifies the target session. +/// Internal snapshot of native queue state for local session orchestration. /// ///
    /// @@ -10913,12 +11863,20 @@ pub struct SessionTasksSendMessageResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueSnapshotResult { + /// Insertion orders for queued items, aligned with `items`. + #[serde(skip_serializing_if = "Option::is_none")] + pub item_orders: Option>, + /// User-facing pending items in FIFO order. + pub items: Vec, + /// Insertion orders for immediate steering messages, aligned with `steeringMessages`. + #[serde(skip_serializing_if = "Option::is_none")] + pub steering_message_orders: Option>, + /// Immediate steering messages waiting for an active turn. + pub steering_messages: Vec, } -/// Skills available to the session, with their enabled state. +/// Parameters for editing a single queued message. /// ///
    /// @@ -10928,12 +11886,14 @@ pub struct SessionSkillsListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsListResult { - /// Available skills - pub skills: Vec, +pub struct QueueUpdateTextRequest { + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + pub id: String, + pub prompt: String, } -/// Identifies the target session. +/// Result of editing a queued message. /// ///
    /// @@ -10943,12 +11903,12 @@ pub struct SessionSkillsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsGetInvokedParams { - /// Target session identifier - pub session_id: SessionId, +pub struct QueueUpdateTextResult { + /// True when the stored text changed. + pub updated: bool, } -/// Skills invoked during this session, ordered by invocation time (most recent last). +/// Event type to register consumer interest for, used by runtime gating logic. /// ///
    /// @@ -10958,12 +11918,12 @@ pub struct SessionSkillsGetInvokedParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsGetInvokedResult { - /// Skills invoked during this session, ordered by invocation time (most recent last) - pub skills: Vec, +pub struct RegisterEventInterestParams { + /// The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates interactive OAuth token acquisition to the consumer via `mcp.oauth_required` events; when no interest is registered the runtime still attempts non-interactive reconnect from cached or refreshable tokens, and only marks the server `needs-auth` if usable credentials are unavailable — it does not open a browser or start interactive OAuth without a consumer). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`. + pub event_type: String, } -/// Identifies the target session. +/// Opaque handle representing an event-type interest registration. /// ///
    /// @@ -10973,12 +11933,12 @@ pub struct SessionSkillsGetInvokedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsReloadParams { - /// Target session identifier - pub session_id: SessionId, +pub struct RegisterEventInterestResult { + /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. + pub handle: String, } -/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// Optional registration options. /// ///
    /// @@ -10988,14 +11948,14 @@ pub struct SessionSkillsReloadParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsReloadResult { - /// Errors emitted while loading skills (e.g. skills that failed to load entirely) - pub errors: Vec, - /// Warnings emitted while loading skills (e.g. skills that loaded but had issues) - pub warnings: Vec, +pub struct SessionsRegisterExtensionToolsOnSessionOptions { + /// In-process `() => boolean` gating callback (CLI-only optimization). Marked internal: replaced by runtime-side enable/disable RPCs in the SDK migration. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) enabled: Option, } -/// Identifies the target session. +/// Params to attach an extension loader's tools to a session. /// ///
    /// @@ -11005,12 +11965,18 @@ pub struct SessionSkillsReloadResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionSkillsEnsureLoadedParams { - /// Target session identifier +pub(crate) struct RegisterExtensionToolsParams { + /// In-process ExtensionLoader handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, extension discovery/launch moves entirely into the runtime — the CLI passes pure config (search paths, disabled ids) via SessionOptions instead. + #[doc(hidden)] + pub(crate) loader: serde_json::Value, + /// Optional registration options. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Session to register extension tools on. pub session_id: SessionId, } -/// Identifies the target session. +/// Handle for releasing the extension tool registration. /// ///
    /// @@ -11020,12 +11986,13 @@ pub struct SessionSkillsEnsureLoadedParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpListParams { - /// Target session identifier - pub session_id: SessionId, +pub(crate) struct RegisterExtensionToolsResult { + /// In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an explicit `extensions.unregister` RPC in the SDK migration. + #[doc(hidden)] + pub(crate) unsubscribe: serde_json::Value, } -/// MCP servers configured for the session, with their connection status. +/// Opaque handle previously returned by `registerInterest` to release. /// ///
    /// @@ -11035,12 +12002,12 @@ pub struct SessionMcpListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpListResult { - /// Configured MCP servers - pub servers: Vec, +pub struct ReleaseEventInterestParams { + /// Handle returned by a previous `registerInterest` call. Idempotent: releasing an unknown or already-released handle is a no-op (returns success). When the last outstanding handle for an event type is released, the runtime reverts to its 'no consumer' code path for that event type. + pub handle: String, } -/// Identifies the target session. +/// Reattach to an existing MC session without creating a new one. /// ///
    /// @@ -11050,12 +12017,14 @@ pub struct SessionMcpListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpReloadParams { - /// Target session identifier - pub session_id: SessionId, +pub struct RemoteControlConfigExistingMcSession { + /// Existing MC session ID to reattach to. + pub mc_session_id: String, + /// Existing MC task ID for the reattached session. + pub mc_task_id: String, } -/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// Configuration for the runtime-managed remote-control singleton. /// ///
    /// @@ -11065,18 +12034,24 @@ pub struct SessionMcpReloadParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpExecuteSamplingResult { - /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. - pub action: McpSamplingExecutionAction, - /// Error description, present when action='failure'. +pub struct RemoteControlConfig { + /// Reattach to an existing MC session without creating a new one. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, - /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + pub existing_mc_session: Option, + /// Whether the user explicitly requested remote (vs. implicit session-sync). Controls warning surfacing for missing-repo cases. + pub explicit: bool, + /// Whether remote export should be enabled. + pub remote: bool, + /// When true, suppresses timeline messages on successful setup. + pub silent: bool, + /// Whether the MC session may steer the local session (write mode). + pub steerable: bool, + /// Existing Mission Control task ID to attach the exported session to. #[serde(skip_serializing_if = "Option::is_none")] - pub result: Option, + pub task_id: Option, } -/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// Remote control is connected to a local session. /// ///
    /// @@ -11086,12 +12061,27 @@ pub struct SessionMcpExecuteSamplingResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpCancelSamplingExecutionResult { - /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). - pub cancelled: bool, +pub struct RemoteControlStatusActive { + /// Session id remote control is pointed at. + pub attached_session_id: String, + /// True while a read-only/session-sync export is deferred, awaiting the first `user.message` before its MC session exists. Marked internal: this field is excluded from the public SDK surface and is populated only on the CLI in-process path. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) awaiting_first_message: Option, + /// MC frontend URL for this session, when known. + #[serde(skip_serializing_if = "Option::is_none")] + pub frontend_url: Option, + /// Whether the MC session may steer this session. + pub is_steerable: bool, + /// In-process prompt-manager handle (CLI-only optimization). Marked internal: this field is excluded from the public SDK surface. When the CLI migrates to a process-separated SDK, the same bidirectional prompt-routing handshake is expressed via dedicated remote-control RPCs (register/resolve) rather than a shared in-process object. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) prompt_manager: Option, + /// Remote control state tag: active. + pub state: RemoteControlStatusActiveState, } -/// Env-value mode recorded on the session after the update. +/// Remote control is in the middle of initial setup. /// ///
    /// @@ -11101,12 +12091,14 @@ pub struct SessionMcpCancelSamplingExecutionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpSetEnvValueModeResult { - /// Mode recorded on the session after the update - pub mode: McpSetEnvValueModeDetails, +pub struct RemoteControlStatusConnecting { + /// Session id the connection is attaching to. + pub attached_session_id: String, + /// Remote control state tag: connecting. + pub state: RemoteControlStatusConnectingState, } -/// Identifies the target session. +/// The last setup attempt failed. The singleton is otherwise off. /// ///
    /// @@ -11116,12 +12108,17 @@ pub struct SessionMcpSetEnvValueModeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpRemoveGitHubParams { - /// Target session identifier - pub session_id: SessionId, +pub struct RemoteControlStatusError { + /// Session id the failing setup attempt targeted, when known. + #[serde(skip_serializing_if = "Option::is_none")] + pub attached_session_id: Option, + /// Human-readable error message from the last setup attempt. + pub error: String, + /// Remote control state tag: setup failed. + pub state: RemoteControlStatusErrorState, } -/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// Remote control is not connected. /// ///
    /// @@ -11131,12 +12128,12 @@ pub struct SessionMcpRemoveGitHubParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpRemoveGitHubResult { - /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). - pub removed: bool, +pub struct RemoteControlStatusOff { + /// Remote control state tag: not connected. + pub state: RemoteControlStatusOffState, } -/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// Wrapper for the singleton's current status. /// ///
    /// @@ -11146,13 +12143,12 @@ pub struct SessionMcpRemoveGitHubResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpOauthLoginResult { - /// 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. - #[serde(skip_serializing_if = "Option::is_none")] - pub authorization_url: Option, +pub struct RemoteControlStatusResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, } -/// Resource contents returned by the MCP server. +/// Outcome of a stopRemoteControl call. /// ///
    /// @@ -11162,12 +12158,14 @@ pub struct SessionMcpOauthLoginResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsReadResourceResult { - /// Resource contents returned by the server - pub contents: Vec, +pub struct RemoteControlStopResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, + /// Whether the singleton was actually torn down by this call. + pub stopped: bool, } -/// App-callable tools from the named MCP server. +/// Outcome of a transferRemoteControl call. /// ///
    /// @@ -11177,12 +12175,14 @@ pub struct SessionMcpAppsReadResourceResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsListToolsResult { - /// App-callable tools from the server - pub tools: Vec>, +pub struct RemoteControlTransferResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, + /// Whether the rebinding actually happened. + pub transferred: bool, } -/// Identifies the target session. +/// Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. /// ///
    /// @@ -11192,12 +12192,13 @@ pub struct SessionMcpAppsListToolsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsGetHostContextParams { - /// Target session identifier - pub session_id: SessionId, +pub struct RemoteEnableRequest { + /// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } -/// Current host context advertised to MCP App guests. +/// GitHub URL for the session and a flag indicating whether remote steering is enabled. /// ///
    /// @@ -11207,12 +12208,15 @@ pub struct SessionMcpAppsGetHostContextParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsGetHostContextResult { - /// Current host context - pub context: McpAppsHostContextDetails, +pub struct RemoteEnableResult { + /// Whether remote steering is enabled + pub remote_steerable: bool, + /// GitHub frontend URL for this session + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, } -/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// New remote-steerability state to persist as a `session.remote_steerable_changed` event. /// ///
    /// @@ -11222,14 +12226,12 @@ pub struct SessionMcpAppsGetHostContextResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMcpAppsDiagnoseResult { - /// Capability negotiation snapshot - pub capability: McpAppsDiagnoseCapability, - /// What the server returned for this session - pub server: McpAppsDiagnoseServer, +pub struct RemoteNotifySteerableChangedRequest { + /// Whether the session now supports remote steering via GitHub. The runtime persists this as a `session.remote_steerable_changed` event so resume/replay sees the up-to-date capability. + pub remote_steerable: bool, } -/// Identifies the target session. +/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. /// ///
    /// @@ -11239,12 +12241,9 @@ pub struct SessionMcpAppsDiagnoseResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPluginsListParams { - /// Target session identifier - pub session_id: SessionId, -} +pub struct RemoteNotifySteerableChangedResult {} -/// Plugins installed for the session, with their enabled state and version metadata. +/// Remote session connection result. /// ///
    /// @@ -11254,12 +12253,14 @@ pub struct SessionPluginsListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPluginsListResult { - /// Installed plugins - pub plugins: Vec, +pub struct RemoteSessionConnectionResult { + /// Metadata for a connected remote session. + pub metadata: ConnectedRemoteSessionMetadata, + /// SDK session ID for the connected remote session. + pub session_id: SessionId, } -/// Indicates whether the session options patch was applied successfully. +/// GitHub repository the remote session belongs to. /// ///
    /// @@ -11269,12 +12270,16 @@ pub struct SessionPluginsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionOptionsUpdateResult { - /// Whether the operation succeeded - pub success: bool, +pub struct RemoteSessionMetadataRepository { + /// Branch associated with the remote session. + pub branch: String, + /// Repository name. + pub name: String, + /// Repository owner. + pub owner: String, } -/// Identifies the target session. +/// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). /// ///
    /// @@ -11284,12 +12289,46 @@ pub struct SessionOptionsUpdateResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionExtensionsListParams { - /// Target session identifier +pub struct RemoteSessionMetadataValue { + /// Most recent working directory context. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, + /// Always true for remote sessions. + pub is_remote: bool, + /// Last-modified time as an ISO 8601 timestamp. + pub modified_time: String, + /// Optional human-friendly name set via /rename. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Pull request number associated with the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub pull_request_number: Option, + /// Backing remote session IDs (most recent first). + pub remote_session_ids: Vec, + /// GitHub repository the remote session belongs to. + pub repository: RemoteSessionMetadataRepository, + /// Original remote resource identifier (task ID or PR node ID). + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_id: Option, + /// Stable session identifier. pub session_id: SessionId, + /// Deadline (ISO 8601) at which a CLI remote session becomes stale without further heartbeats. + #[serde(skip_serializing_if = "Option::is_none")] + pub stale_at: Option, + /// Session creation time as an ISO 8601 timestamp. + pub start_time: String, + /// Server-side task state returned by GitHub. + #[serde(skip_serializing_if = "Option::is_none")] + pub state: Option, + /// Short summary of the session, when one has been derived. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + /// Whether the remote task originated from CCA or CLI `--remote`. + #[serde(skip_serializing_if = "Option::is_none")] + pub task_type: Option, } -/// Extensions discovered for the session, with their current status. +/// Repository context for the remote session. /// ///
    /// @@ -11299,12 +12338,17 @@ pub struct SessionExtensionsListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionExtensionsListResult { - /// Discovered extensions and their current status - pub extensions: Vec, +pub struct RemoteSessionRepository { + /// Optional branch associated with the remote session. + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Repository name. + pub name: String, + /// Repository owner or organization login. + pub owner: String, } -/// Identifies the target session. +/// Credential-injection capability flags applied while the sandbox is enabled. /// ///
    /// @@ -11314,12 +12358,16 @@ pub struct SessionExtensionsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionExtensionsReloadParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SandboxConfigAuth { + /// Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in). + #[serde(skip_serializing_if = "Option::is_none")] + pub gh: Option, + /// Whether to inject git credentials as an `http..extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's own helper before the sandbox is applied. Default: false (opt-in). + #[serde(skip_serializing_if = "Option::is_none")] + pub git: Option, } -/// Indicates whether the external tool call result was handled successfully. +/// macOS seatbelt experimental options. /// ///
    /// @@ -11329,12 +12377,13 @@ pub struct SessionExtensionsReloadParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsHandlePendingToolCallResult { - /// Whether the tool call result was handled successfully - pub success: bool, +pub struct SandboxConfigUserPolicyExperimentalSeatbelt { + /// Whether the macOS seatbelt profile may access the keychain. + #[serde(skip_serializing_if = "Option::is_none")] + pub keychain_access: Option, } -/// Identifies the target session. +/// Platform-specific experimental policy fields. /// ///
    /// @@ -11344,12 +12393,13 @@ pub struct SessionToolsHandlePendingToolCallResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsInitializeAndValidateParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SandboxConfigUserPolicyExperimental { + /// macOS seatbelt experimental options. + #[serde(skip_serializing_if = "Option::is_none")] + pub seatbelt: Option, } -/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +/// Filesystem rules to merge into the base policy. /// ///
    /// @@ -11359,9 +12409,22 @@ pub struct SessionToolsInitializeAndValidateParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsInitializeAndValidateResult {} +pub struct SandboxConfigUserPolicyFilesystem { + /// Whether to clear the policy when the session exits. + #[serde(skip_serializing_if = "Option::is_none")] + pub clear_policy_on_exit: Option, + /// Paths explicitly denied. + #[serde(skip_serializing_if = "Option::is_none")] + pub denied_paths: Option>, + /// Paths granted read-only access. + #[serde(skip_serializing_if = "Option::is_none")] + pub readonly_paths: Option>, + /// Paths granted read/write access. + #[serde(skip_serializing_if = "Option::is_none")] + pub readwrite_paths: Option>, +} -/// Identifies the target session. +/// HTTP proxy configuration for sandboxed traffic. /// ///
    /// @@ -11371,12 +12434,18 @@ pub struct SessionToolsInitializeAndValidateResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsGetCurrentMetadataParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SandboxConfigUserPolicyNetworkProxy { + /// Optional password for proxy authentication, combined with the URL at spawn time. The persisted value may be a literal password, a `${secret:…}` reference resolved from the OS keychain, or a `${VAR}`/`$VAR` environment reference; it is resolved just before the sandboxed process routes through the proxy. The /sandbox dialog stores a real password in the OS keychain and persists only a `${secret:…}` placeholder (never plaintext in settings.json); the field is masked in the dialog and redacted by /settings show. + #[serde(skip_serializing_if = "Option::is_none")] + pub password: Option, + /// Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is. + pub url: String, + /// Optional username for proxy authentication. Combined with the URL (and `password`) into `user:pass@host` when the sandboxed process routes through the proxy. + #[serde(skip_serializing_if = "Option::is_none")] + pub username: Option, } -/// Current lightweight tool metadata snapshot for the session. +/// Network rules to merge into the base policy. /// ///
    /// @@ -11386,12 +12455,19 @@ pub struct SessionToolsGetCurrentMetadataParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionToolsGetCurrentMetadataResult { - /// Current tool metadata, or null when tools have not been initialized yet - pub tools: Option>, +pub struct SandboxConfigUserPolicyNetwork { + /// Whether traffic to local/loopback addresses is allowed. + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_local_network: Option, + /// Whether outbound network traffic is allowed at all. + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_outbound: Option, + /// HTTP proxy the sandboxed process routes traffic through. Enforced on Windows and cooperative (honored by well-behaved tools, not strictly enforced) on Linux and macOS. Credentials go in the separate `username`/`password` fields. A credential-free http:// loopback proxy URL is routed through the localhost proxy automatically; an https:// or authenticated loopback URL is used as-is. + #[serde(skip_serializing_if = "Option::is_none")] + pub proxy: Option, } -/// Slash commands available in the session, after applying any include/exclude filters. +/// macOS seatbelt-specific options. /// ///
    /// @@ -11401,12 +12477,13 @@ pub struct SessionToolsGetCurrentMetadataResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsListResult { - /// Commands available in this session - pub commands: Vec, +pub struct SandboxConfigUserPolicySeatbelt { + /// Whether the macOS seatbelt profile may access the keychain. + #[serde(skip_serializing_if = "Option::is_none")] + pub keychain_access: Option, } -/// Indicates whether the pending client-handled command was completed successfully. +/// User-managed sandbox policy fragment merged into the auto-discovered base policy. /// ///
    /// @@ -11416,12 +12493,22 @@ pub struct SessionCommandsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsHandlePendingCommandResult { - /// Whether the command was handled successfully - pub success: bool, +pub struct SandboxConfigUserPolicy { + /// Deprecated legacy location for `seatbelt`; read only when the top-level `seatbelt` is absent. + #[serde(skip_serializing_if = "Option::is_none")] + pub experimental: Option, + /// Filesystem rules to merge into the base policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub filesystem: Option, + /// Network rules to merge into the base policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub network: Option, + /// macOS seatbelt options to merge into the base policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub seatbelt: Option, } -/// Error message produced while executing the command, if any. +/// Resolved sandbox configuration. /// ///
    /// @@ -11431,13 +12518,24 @@ pub struct SessionCommandsHandlePendingCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsExecuteResult { - /// Error message produced while executing the command, if any. Omitted when the handler succeeded. +pub struct SandboxConfig { + /// Whether to auto-add the current working directory to readwritePaths. Default: true. #[serde(skip_serializing_if = "Option::is_none")] - pub error: Option, + pub add_current_working_directory: Option, + /// Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without extra configuration; a relocated CARGO_HOME additionally gets its Cargo lock files granted read-write. Default: true (enabled by default; set to false to opt out). + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_dev_tool_access: Option, + /// Credential-injection capability flags. + #[serde(skip_serializing_if = "Option::is_none")] + pub auth: Option, + /// Whether sandboxing is enabled for the session. + pub enabled: bool, + /// User-managed sandbox policy fragment merged into the auto-discovered base policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub user_policy: Option, } -/// Indicates whether the command was accepted into the local execution queue. +/// Register an absolute-time scheduled prompt. /// ///
    /// @@ -11447,12 +12545,20 @@ pub struct SessionCommandsExecuteResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsEnqueueResult { - /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). - pub queued: bool, +pub struct ScheduleAddAtRequest { + /// Epoch milliseconds when the prompt should fire. + pub at: i64, + /// Optional display-only prompt label. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// Prompt text to enqueue when the schedule fires. + pub prompt: String, + /// Whether the schedule should re-arm after each tick. Defaults to false. + #[serde(skip_serializing_if = "Option::is_none")] + pub recurring: Option, } -/// Indicates whether the queued-command response was matched to a pending request. +/// Register a cron scheduled prompt. /// ///
    /// @@ -11462,12 +12568,23 @@ pub struct SessionCommandsEnqueueResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCommandsRespondToQueuedCommandResult { - /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. - pub success: bool, +pub struct ScheduleAddCronRequest { + /// 5-field cron expression. + pub cron: String, + /// Optional display-only prompt label. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// Prompt text to enqueue when the schedule fires. + pub prompt: String, + /// Whether the schedule should re-arm after each tick. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub recurring: Option, + /// IANA timezone for evaluating the cron expression. + #[serde(skip_serializing_if = "Option::is_none")] + pub tz: Option, } -/// The elicitation response (accept with form values, decline, or cancel) +/// Register a relative-interval scheduled prompt. /// ///
    /// @@ -11477,15 +12594,20 @@ pub struct SessionCommandsRespondToQueuedCommandResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiElicitationResult { - /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) - pub action: UIElicitationResponseAction, - /// The form values submitted by the user (present when action is 'accept') +pub struct ScheduleAddRequest { + /// Optional display-only prompt label. #[serde(skip_serializing_if = "Option::is_none")] - pub content: Option>, + pub display_prompt: Option, + /// Human-readable interval such as `30s`, `5m`, or `2h`. + pub interval: String, + /// Prompt text to enqueue when the schedule fires. + pub prompt: String, + /// Whether the schedule should re-arm after each tick. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub recurring: Option, } -/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time. /// ///
    /// @@ -11495,12 +12617,36 @@ pub struct SessionUiElicitationResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiHandlePendingElicitationResult { - /// Whether the response was accepted. False if the request was already resolved by another client. - pub success: bool, +pub struct ScheduleEntry { + /// Absolute fire time (epoch milliseconds) for a one-shot calendar schedule. + #[serde(skip_serializing_if = "Option::is_none")] + pub at: Option, + /// 5-field cron expression for a recurring calendar schedule, evaluated in `tz`. + #[serde(skip_serializing_if = "Option::is_none")] + pub cron: Option, + /// Display-only label for the prompt as shown in the UI (e.g. `/skill-name` for a skill-invocation schedule). The actual enqueued prompt is `prompt`. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// Sequential id assigned by the runtime within the session. Stable across resumes (rebuilt from the event log). + pub id: i64, + /// Interval between scheduled ticks, in milliseconds (relative-interval schedules). + #[serde(skip_serializing_if = "Option::is_none")] + pub interval_ms: Option, + /// ISO 8601 timestamp when the next tick is scheduled to fire. + pub next_run_at: String, + /// Prompt text that gets enqueued on every tick. + pub prompt: String, + /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`). + pub recurring: bool, + /// True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled. + #[serde(skip_serializing_if = "Option::is_none")] + pub self_paced: Option, + /// IANA timezone the `cron` expression is evaluated in. + #[serde(skip_serializing_if = "Option::is_none")] + pub tz: Option, } -/// Indicates whether the pending UI request was resolved by this call. +/// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -11510,12 +12656,16 @@ pub struct SessionUiHandlePendingElicitationResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiHandlePendingUserInputResult { - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - pub success: bool, +pub struct ScheduleAddResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, } -/// Indicates whether the pending UI request was resolved by this call. +/// Register a self-paced scheduled prompt. /// ///
    /// @@ -11525,12 +12675,15 @@ pub struct SessionUiHandlePendingUserInputResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiHandlePendingSamplingResult { - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - pub success: bool, +pub struct ScheduleAddSelfPacedRequest { + /// Optional display-only prompt label. + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// Prompt text to enqueue when the schedule fires. + pub prompt: String, } -/// Indicates whether the pending UI request was resolved by this call. +/// Whether the session currently has an active self-paced schedule. /// ///
    /// @@ -11540,12 +12693,12 @@ pub struct SessionUiHandlePendingSamplingResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiHandlePendingAutoModeSwitchResult { - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - pub success: bool, +pub struct ScheduleHasSelfPacedResult { + /// True when at least one active schedule is self-paced. + pub has_self_paced: bool, } -/// Indicates whether the pending UI request was resolved by this call. +/// Snapshot of the currently active recurring prompts for this session. /// ///
    /// @@ -11555,12 +12708,12 @@ pub struct SessionUiHandlePendingAutoModeSwitchResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiHandlePendingExitPlanModeResult { - /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. - pub success: bool, +pub struct ScheduleList { + /// Active scheduled prompts, ordered by id. + pub entries: Vec, } -/// Identifies the target session. +/// Re-arm a self-paced scheduled prompt. /// ///
    /// @@ -11570,12 +12723,14 @@ pub struct SessionUiHandlePendingExitPlanModeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiRegisterDirectAutoModeSwitchHandlerParams { - /// Target session identifier - pub session_id: SessionId, +pub struct ScheduleRearmSelfPacedRequest { + /// Epoch milliseconds when the prompt should next fire. + pub at: i64, + /// Id of the self-paced scheduled prompt. + pub id: i64, } -/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). +/// Identifier of the scheduled prompt to remove. /// ///
    /// @@ -11585,12 +12740,12 @@ pub struct SessionUiRegisterDirectAutoModeSwitchHandlerParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiRegisterDirectAutoModeSwitchHandlerResult { - /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. - pub handle: String, +pub struct ScheduleStopRequest { + /// Id of the scheduled prompt to remove. + pub id: i64, } -/// Indicates whether the handle was active and the registration count was decremented. +/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. /// ///
    /// @@ -11600,12 +12755,13 @@ pub struct SessionUiRegisterDirectAutoModeSwitchHandlerResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUiUnregisterDirectAutoModeSwitchHandlerResult { - /// True if the handle was active and decremented the counter; false if the handle was unknown. - pub unregistered: bool, +pub struct ScheduleStopResult { + /// The removed entry, or omitted if no entry matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, } -/// Indicates whether the operation succeeded. +/// Secret values to add to the redaction filter. /// ///
    /// @@ -11615,12 +12771,12 @@ pub struct SessionUiUnregisterDirectAutoModeSwitchHandlerResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsConfigureResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SecretsAddFilterValuesRequest { + /// Raw secret values to register for redaction + pub values: Vec, } -/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// Confirmation that the secret values were registered. /// ///
    /// @@ -11630,12 +12786,12 @@ pub struct SessionPermissionsConfigureResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsHandlePendingPermissionRequestResult { - /// Whether the permission request was handled successfully - pub success: bool, +pub struct SecretsAddFilterValuesResult { + /// Whether the values were successfully registered + pub ok: bool, } -/// List of pending permission requests reconstructed from event history. +/// Parameters for session.extensions.sendAttachmentsToMessage. /// ///
    /// @@ -11645,12 +12801,15 @@ pub struct SessionPermissionsHandlePendingPermissionRequestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPendingRequestsResult { - /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. - pub items: Vec, +pub struct SendAttachmentsToMessageParams { + /// Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape. + pub attachments: Vec, + /// Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment. + #[serde(skip_serializing_if = "Option::is_none")] + pub instance_id: Option, } -/// Indicates whether the operation succeeded. +/// A single user message to append to the session as part of a `session.sendMessages` turn /// ///
    /// @@ -11660,12 +12819,29 @@ pub struct SessionPermissionsPendingRequestsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsSetApproveAllResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SendMessageItem { + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message + #[serde(skip_serializing_if = "Option::is_none")] + pub attachments: Option>, + /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) billable: Option, + /// If provided, this is shown in the timeline instead of `prompt` + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// The user message text + pub prompt: String, + /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange + #[serde(skip_serializing_if = "Option::is_none")] + pub required_tool: Option, + /// Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) source: Option, } -/// Indicates whether the operation succeeded and reports the post-mutation state. +/// Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. /// ///
    /// @@ -11675,29 +12851,33 @@ pub struct SessionPermissionsSetApproveAllResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsSetAllowAllResult { - /// Authoritative allow-all state after the mutation - pub enabled: bool, - /// Whether the operation succeeded - pub success: bool, -} - -/// Current full allow-all permission state. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SessionPermissionsGetAllowAllResult { - /// Whether full allow-all permissions are currently active - pub enabled: bool, +pub struct SendMessagesRequest { + /// The UI mode the agent was in when these messages were sent. Defaults to the session's current mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_mode: Option, + /// The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message. + pub messages: Vec, + /// How to deliver the messages. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// If true, adds the messages to the front of the queue instead of the end + #[serde(skip_serializing_if = "Option::is_none")] + pub prepend: Option, + /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_headers: Option>, + /// W3C Trace Context traceparent header for distributed tracing of this agent turn + #[serde(skip_serializing_if = "Option::is_none")] + pub traceparent: Option, + /// W3C Trace Context tracestate header for distributed tracing + #[serde(skip_serializing_if = "Option::is_none")] + pub tracestate: Option, + /// If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + #[serde(skip_serializing_if = "Option::is_none")] + pub wait: Option, } -/// Indicates whether the operation succeeded. +/// Result of sending zero or more user messages /// ///
    /// @@ -11707,12 +12887,12 @@ pub struct SessionPermissionsGetAllowAllResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsModifyRulesResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SendMessagesResult { + /// Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided. + pub message_ids: Vec, } -/// Indicates whether the operation succeeded. +/// Parameters for sending a user message to the session /// ///
    /// @@ -11722,12 +12902,49 @@ pub struct SessionPermissionsModifyRulesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsSetRequiredResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SendRequest { + /// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_mode: Option, + /// Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message + #[serde(skip_serializing_if = "Option::is_none")] + pub attachments: Option>, + /// If false, this message will not trigger a Premium Request Unit charge. User messages default to billable. + #[serde(skip_serializing_if = "Option::is_none")] + pub billable: Option, + /// If provided, this is shown in the timeline instead of `prompt` + #[serde(skip_serializing_if = "Option::is_none")] + pub display_prompt: Option, + /// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// If true, adds the message to the front of the queue instead of the end + #[serde(skip_serializing_if = "Option::is_none")] + pub prepend: Option, + /// The user message text + pub prompt: String, + /// Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_headers: Option>, + /// If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange + #[serde(skip_serializing_if = "Option::is_none")] + pub required_tool: Option, + /// Optional provenance tag copied to the resulting user.message event. Must be `user`, `system`, `command-` for command-originated messages, `schedule-` for scheduled prompts, or `agent-` for prompts sent by another agent. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) source: Option, + /// W3C Trace Context traceparent header for distributed tracing of this agent turn + #[serde(skip_serializing_if = "Option::is_none")] + pub traceparent: Option, + /// W3C Trace Context tracestate header for distributed tracing + #[serde(skip_serializing_if = "Option::is_none")] + pub tracestate: Option, + /// If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageId`; the caller can rely on the agent having processed the message before the call resolves. Transport-dependent tail semantics: on a LOCAL (in-process) session the wait additionally blocks until the completed turn's event tail has been dispatched to this session's in-process subscribers, so a subsequent read of subscriber state already reflects the turn; on a REMOTE session the wait resolves once the loop completes and mirrored delivery follows over the wire. Callers that need the stronger local guarantee on remote sessions should await the event stream explicitly. + #[serde(skip_serializing_if = "Option::is_none")] + pub wait: Option, } -/// Indicates whether the operation succeeded. +/// Result of sending a user message /// ///
    /// @@ -11737,12 +12954,12 @@ pub struct SessionPermissionsSetRequiredResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsResetSessionApprovalsResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SendResult { + /// Unique identifier assigned to the message + pub message_id: String, } -/// Indicates whether the operation succeeded. +/// Internal request for sending a system notification. /// ///
    /// @@ -11752,12 +12969,18 @@ pub struct SessionPermissionsResetSessionApprovalsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsNotifyPromptShownResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SendSystemNotificationRequest { + /// Optional structured notification kind. + #[serde(skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Notification text to deliver to the model. + pub message: String, + /// Internal delivery options, including passive policy. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, } -/// Snapshot of the session's allow-listed directories and primary working directory. +/// Agents discovered across user, project, plugin, and remote sources. /// ///
    /// @@ -11767,14 +12990,12 @@ pub struct SessionPermissionsNotifyPromptShownResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPathsListResult { - /// All directories currently allowed for tool access on this session. - pub directories: Vec, - /// The primary working directory for this session. - pub primary: String, +pub struct ServerAgentList { + /// All discovered agents across all sources + pub agents: Vec, } -/// Indicates whether the operation succeeded. +/// Instruction sources discovered across user, repository, and plugin sources. /// ///
    /// @@ -11784,12 +13005,12 @@ pub struct SessionPermissionsPathsListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPathsAddResult { - /// Whether the operation succeeded - pub success: bool, +pub struct ServerInstructionSourceList { + /// All discovered instruction sources + pub sources: Vec, } -/// Indicates whether the operation succeeded. +/// Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint. /// ///
    /// @@ -11799,12 +13020,32 @@ pub struct SessionPermissionsPathsAddResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPathsUpdatePrimaryResult { - /// Whether the operation succeeded - pub success: bool, +pub struct ServerSkill { + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + #[serde(skip_serializing_if = "Option::is_none")] + pub argument_hint: Option, + /// Canonical slash command name used to invoke the skill, without the leading '/' + #[serde(skip_serializing_if = "Option::is_none")] + pub command_name: Option, + /// Description of what the skill does + pub description: String, + /// Whether the skill is currently enabled (based on global config) + pub enabled: bool, + /// Unique identifier for the skill + pub name: String, + /// Absolute path to the skill file + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// The project path this skill belongs to (only for project/inherited skills) + #[serde(skip_serializing_if = "Option::is_none")] + pub project_path: Option, + /// Source location type (e.g., project, personal-copilot, plugin, builtin) + pub source: SkillSource, + /// Whether the skill can be invoked by the user as a slash command + pub user_invocable: bool, } -/// Indicates whether the supplied path is within the session's allowed directories. +/// Skills discovered across global and project sources. /// ///
    /// @@ -11814,12 +13055,15 @@ pub struct SessionPermissionsPathsUpdatePrimaryResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult { - /// Whether the path is within the session's allowed directories - pub allowed: bool, +pub struct ServerSkillList { + /// Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills are excluded so host-local paths are not disclosed to multitenant callers. + #[serde(skip_serializing_if = "Option::is_none")] + pub errors: Option>, + /// All discovered skills across all sources + pub skills: Vec, } -/// Indicates whether the supplied path is within the session's workspace directory. +/// Current activity flags for the session. /// ///
    /// @@ -11829,12 +13073,14 @@ pub struct SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsPathsIsPathWithinWorkspaceResult { - /// Whether the path is within the session workspace directory - pub allowed: bool, +pub struct SessionActivity { + /// Whether an in-flight operation can currently be aborted. + pub abortable: bool, + /// Whether the session currently has active work, including running turns or tasks. + pub has_active_work: bool, } -/// Resolved location-permissions key and type. +/// Authentication status and account metadata for the session. /// ///
    /// @@ -11844,14 +13090,27 @@ pub struct SessionPermissionsPathsIsPathWithinWorkspaceResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsLocationsResolveResult { - /// Location key used in the location-permissions store - pub location_key: String, - /// Whether the location is a git repo or directory - pub location_type: PermissionLocationType, +pub struct SessionAuthStatus { + /// Authentication type + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_type: Option, + /// Copilot plan tier (e.g., individual_pro, business) + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_plan: Option, + /// Authentication host URL + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Whether the session has resolved authentication + pub is_authenticated: bool, + /// Authenticated login/username, if available + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// Human-readable authentication status description + #[serde(skip_serializing_if = "Option::is_none")] + pub status_message: Option, } -/// Summary of persisted location permissions applied to the session. +/// Map of sessionId -> bytes freed by removing the session's workspace directory. /// ///
    /// @@ -11861,22 +13120,59 @@ pub struct SessionPermissionsLocationsResolveResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsLocationsApplyResult { - /// Number of persisted allowed directories added to the live path manager - pub applied_directory_count: i64, - /// Number of location-scoped rules added to the live permission service - pub applied_rule_count: i64, - /// Location-scoped rules applied to the live permission service - pub applied_rules: Vec, - /// Whether a different location was applied since the previous apply call - pub changed: bool, - /// Location key used in the location-permissions store - pub location_key: String, - /// Whether the location is a git repo or directory - pub location_type: PermissionLocationType, +pub struct SessionBulkDeleteResult { + /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). + pub freed_bytes: HashMap, } -/// Indicates whether the operation succeeded. +/// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionContextAttributionCategories { + /// Output reserve plus post-blocking-threshold buffer. + pub buffer: i64, + /// Custom-instructions tokens (0 when none are configured). + pub custom_instructions: i64, + /// Remaining unused window capacity (clamped at 0). + pub free_space: i64, + /// MCP tool-definition tokens. + pub mcp_tools: i64, + /// Conversation (user/assistant/tool) message tokens. + pub messages: i64, + /// System prompt tokens, excluding custom instructions. + pub system_prompt: i64, + /// Non-MCP tool-definition tokens. + pub system_tools: i64, +} + +/// Successful compaction history for the session. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionContextAttributionCompactions { + /// Number of successful compactions in this session. + pub count: i64, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionContextAttributionEntriesItem { + /// Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + #[serde(skip_serializing_if = "Option::is_none")] + pub attributes: Option>, + /// Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. + pub id: String, + /// Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + pub kind: String, + /// Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. + pub label: String, + /// Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_id: Option, + /// Token count currently in context attributable to this entry. + pub tokens: i64, +} + +/// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). /// ///
    /// @@ -11886,12 +13182,30 @@ pub struct SessionPermissionsLocationsApplyResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsLocationsAddToolApprovalResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SessionContextAttribution { + /// Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. + pub buffer_tokens: i64, + /// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. + pub categories: SessionContextAttributionCategories, + /// Successful compaction history for the session. + pub compactions: SessionContextAttributionCompactions, + /// Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. + pub compaction_threshold: i64, + /// Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. + pub entries: Vec, + /// Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. + pub limit: i64, + /// The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. + pub model_id: String, + /// How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). + pub model_source: String, + /// Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + pub prompt_token_limit: i64, + /// Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. + pub total_tokens: i64, } -/// Folder trust check result. +/// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). /// ///
    /// @@ -11901,12 +13215,30 @@ pub struct SessionPermissionsLocationsAddToolApprovalResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsFolderTrustIsTrustedResult { - /// Whether the folder is trusted - pub trusted: bool, +pub struct SessionContextInfo { + /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) + pub buffer_tokens: i64, + /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) + pub compaction_threshold: i64, + /// Tokens consumed by user/assistant/tool messages + pub conversation_tokens: i64, + /// Prompt token limit plus the model's full output token limit. + pub limit: i64, + /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) + pub mcp_tools_tokens: i64, + /// The model used for token counting + pub model_name: String, + /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) + pub prompt_token_limit: i64, + /// Tokens consumed by the system prompt + pub system_tokens: i64, + /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) + pub tool_definitions_tokens: i64, + /// Sum of system, conversation and tool-definition tokens + pub total_tokens: i64, } -/// Indicates whether the operation succeeded. +/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. /// ///
    /// @@ -11916,12 +13248,12 @@ pub struct SessionPermissionsFolderTrustIsTrustedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsFolderTrustAddTrustedResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SessionEnrichMetadataResult { + /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. + pub sessions: Vec, } -/// Indicates whether the operation succeeded. +/// File path, content to append, and optional mode for the client-provided session filesystem. /// ///
    /// @@ -11931,12 +13263,19 @@ pub struct SessionPermissionsFolderTrustAddTrustedResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionPermissionsUrlsSetUnrestrictedModeResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SessionFsAppendFileRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, + /// Content to append + pub content: String, + /// Optional POSIX-style mode for newly created files + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } -/// Identifier of the session event that was emitted for the log message. +/// Describes a filesystem error. /// ///
    /// @@ -11946,12 +13285,15 @@ pub struct SessionPermissionsUrlsSetUnrestrictedModeResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionLogResult { - /// The unique identifier of the emitted session event - pub event_id: String, +pub struct SessionFsError { + /// Error classification + pub code: SessionFsErrorCode, + /// Free-form detail about the error, for logging/diagnostics + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, } -/// Identifies the target session. +/// Path to test for existence in the client-provided session filesystem. /// ///
    /// @@ -11961,44 +13303,29 @@ pub struct SessionLogResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSnapshotParams { +pub struct SessionFsExistsRequest { /// Target session identifier pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Public-facing projection of workspace metadata for SDK / TUI consumers +/// Indicates whether the requested path exists in the client-provided session filesystem. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSnapshotResultWorkspace { - /// Branch checked out at session start, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub branch: Option, - /// ISO 8601 timestamp when the workspace was created - #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] - pub created_at: Option, - /// Current working directory at session start - #[serde(skip_serializing_if = "Option::is_none")] - pub cwd: Option, - /// Resolved git root for cwd, if any - #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] - pub git_root: Option, - /// Repository host type, if known - #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] - pub host_type: Option, - /// Workspace identifier (1:1 with sessionId) - pub id: String, - /// Display name for the session, if set - #[serde(skip_serializing_if = "Option::is_none")] - pub name: Option, - /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub repository: Option, - /// ISO 8601 timestamp when the workspace was last updated - #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] - pub updated_at: Option, +pub struct SessionFsExistsResult { + /// Whether the path exists + pub exists: bool, } -/// Point-in-time snapshot of slow-changing session identifier and state fields +/// Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode. /// ///
    /// @@ -12008,43 +13335,20 @@ pub struct SessionMetadataSnapshotResultWorkspace { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSnapshotResult { - /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. - pub already_in_use: bool, - /// Runtime client name associated with the session (telemetry identifier). - #[serde(skip_serializing_if = "Option::is_none")] - pub client_name: Option, - /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') - pub current_mode: MetadataSnapshotCurrentMode, - /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. - #[serde(skip_serializing_if = "Option::is_none")] - pub initial_name: Option, - /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) - pub is_remote: bool, - /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. - pub modified_time: String, - /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. - #[serde(skip_serializing_if = "Option::is_none")] - pub remote_metadata: Option, - /// Currently selected model identifier, if any - #[serde(skip_serializing_if = "Option::is_none")] - pub selected_model: Option, - /// The unique identifier of the session +pub struct SessionFsMkdirRequest { + /// Target session identifier pub session_id: SessionId, - /// ISO 8601 timestamp of when the session started - pub start_time: String, - /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. + /// Path using SessionFs conventions + pub path: String, + /// Create parent directories as needed #[serde(skip_serializing_if = "Option::is_none")] - pub summary: Option, - /// Absolute path to the session's current working directory - pub working_directory: String, - /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). - pub workspace: Option, - /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace - pub workspace_path: Option, + pub recursive: Option, + /// Optional POSIX-style mode for newly created directories + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } -/// Identifies the target session. +/// Directory path whose entries should be listed from the client-provided session filesystem. /// ///
    /// @@ -12054,12 +13358,14 @@ pub struct SessionMetadataSnapshotResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataIsProcessingParams { +pub struct SessionFsReaddirRequest { /// Target session identifier pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Indicates whether the local session is currently processing a turn or background continuation. +/// Names of entries in the requested directory, or a filesystem error if the read failed. /// ///
    /// @@ -12069,38 +13375,15 @@ pub struct SessionMetadataIsProcessingParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataIsProcessingResult { - /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. - pub processing: bool, -} - -/// Token-usage breakdown for the session's current context window -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct SessionMetadataContextInfoResultContextInfo { - /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) - pub buffer_tokens: i64, - /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) - pub compaction_threshold: i64, - /// Tokens consumed by user/assistant/tool messages - pub conversation_tokens: i64, - /// Total context limit for /context display. promptTokenLimit + min(32k or 64k, outputTokenLimit) depending on model. - pub limit: i64, - /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) - pub mcp_tools_tokens: i64, - /// The model used for token counting - pub model_name: String, - /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) - pub prompt_token_limit: i64, - /// Tokens consumed by the system prompt - pub system_tokens: i64, - /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) - pub tool_definitions_tokens: i64, - /// Sum of system, conversation and tool-definition tokens - pub total_tokens: i64, +pub struct SessionFsReaddirResult { + /// Entry names in the directory + pub entries: Vec, + /// Describes a filesystem error. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, } -/// Token breakdown for the session's current context window, or null if uninitialized. +/// Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type. /// ///
    /// @@ -12110,12 +13393,14 @@ pub struct SessionMetadataContextInfoResultContextInfo { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataContextInfoResult { - /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). - pub context_info: Option, +pub struct SessionFsReaddirWithTypesEntry { + /// Entry name + pub name: String, + /// Entry type + pub r#type: SessionFsReaddirWithTypesEntryType, } -/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). +/// Directory path whose entries (with type information) should be listed from the client-provided session filesystem. /// ///
    /// @@ -12125,9 +13410,14 @@ pub struct SessionMetadataContextInfoResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataRecordContextChangeResult {} +pub struct SessionFsReaddirWithTypesRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, +} -/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. +/// Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed. /// ///
    /// @@ -12137,12 +13427,15 @@ pub struct SessionMetadataRecordContextChangeResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataSetWorkingDirectoryResult { - /// Working directory after the update - pub working_directory: String, +pub struct SessionFsReaddirWithTypesResult { + /// Directory entries with type information + pub entries: Vec, + /// Describes a filesystem error. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, } -/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. +/// Path of the file to read from the client-provided session filesystem. /// ///
    /// @@ -12152,16 +13445,14 @@ pub struct SessionMetadataSetWorkingDirectoryResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionMetadataRecomputeContextTokensResult { - /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). - pub messages_token_count: i64, - /// Tokens contributed by system/developer prompt snapshots. - pub system_token_count: i64, - /// Sum of tokens across chat-context and system-context messages currently held by the session. - pub total_tokens: i64, +pub struct SessionFsReadFileRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// File content as a UTF-8 string, or a filesystem error if the read failed. /// ///
    /// @@ -12171,12 +13462,15 @@ pub struct SessionMetadataRecomputeContextTokensResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionShellExecResult { - /// Unique identifier for tracking streamed output - pub process_id: String, +pub struct SessionFsReadFileResult { + /// File content as UTF-8 string + pub content: String, + /// Describes a filesystem error. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, } -/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// Source and destination paths for renaming or moving an entry in the client-provided session filesystem. /// ///
    /// @@ -12186,12 +13480,16 @@ pub struct SessionShellExecResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionShellKillResult { - /// Whether the signal was sent successfully - pub killed: bool, +pub struct SessionFsRenameRequest { + /// Target session identifier + pub session_id: SessionId, + /// Source path using SessionFs conventions + pub src: String, + /// Destination path using SessionFs conventions + pub dest: String, } -/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// Path to remove from the client-provided session filesystem, with options for recursive removal and force. /// ///
    /// @@ -12201,22 +13499,20 @@ pub struct SessionShellKillResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryCompactResult { - /// Post-compaction context window usage breakdown +pub struct SessionFsRmRequest { + /// Target session identifier + pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, + /// Remove directories and their contents recursively #[serde(skip_serializing_if = "Option::is_none")] - pub context_window: Option, - /// Number of messages removed during compaction - pub messages_removed: i64, - /// Whether compaction completed successfully - pub success: bool, - /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + pub recursive: Option, + /// Ignore errors if the path does not exist #[serde(skip_serializing_if = "Option::is_none")] - pub summary_content: Option, - /// Number of tokens freed by compaction - pub tokens_removed: i64, + pub force: Option, } -/// Number of events that were removed by the truncation. +/// Optional capabilities declared by the provider /// ///
    /// @@ -12226,12 +13522,13 @@ pub struct SessionHistoryCompactResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryTruncateResult { - /// Number of events that were removed - pub events_removed: i64, +pub struct SessionFsSetProviderCapabilities { + /// Whether the provider supports SQLite query/exists operations + #[serde(skip_serializing_if = "Option::is_none")] + pub sqlite: Option, } -/// Identifies the target session. +/// Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. /// ///
    /// @@ -12241,12 +13538,19 @@ pub struct SessionHistoryTruncateResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryCancelBackgroundCompactionParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionFsSetProviderRequest { + /// Optional capabilities declared by the provider + #[serde(skip_serializing_if = "Option::is_none")] + pub capabilities: Option, + /// Path conventions used by this filesystem + pub conventions: SessionFsSetProviderConventions, + /// Initial working directory for sessions + pub initial_cwd: String, + /// Path within each session's SessionFs where the runtime stores files for that session + pub session_state_path: String, } -/// Indicates whether an in-progress background compaction was cancelled. +/// Indicates whether the calling client was registered as the session filesystem provider. /// ///
    /// @@ -12256,12 +13560,12 @@ pub struct SessionHistoryCancelBackgroundCompactionParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryCancelBackgroundCompactionResult { - /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. - pub cancelled: bool, +pub struct SessionFsSetProviderResult { + /// Whether the provider was set successfully + pub success: bool, } -/// Identifies the target session. +/// Indicates whether the per-session SQLite database already exists. /// ///
    /// @@ -12271,12 +13575,34 @@ pub struct SessionHistoryCancelBackgroundCompactionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryAbortManualCompactionParams { +pub struct SessionFsSqliteExistsResult { + /// Whether the session database already exists + pub exists: bool, +} + +/// SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database. The provider applies its SQLite busy timeout for every call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFsSqliteQueryRequest { /// Target session identifier pub session_id: SessionId, + /// SQL query to execute + pub query: String, + /// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) + pub query_type: SessionFsSqliteQueryType, + /// Optional named bind parameters + #[serde(skip_serializing_if = "Option::is_none")] + pub params: Option>, } -/// Indicates whether an in-progress manual compaction was aborted. +/// Query results including rows, columns, and rows affected, or a filesystem error if execution failed. /// ///
    /// @@ -12286,12 +13612,22 @@ pub struct SessionHistoryAbortManualCompactionParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistoryAbortManualCompactionResult { - /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. - pub aborted: bool, +pub struct SessionFsSqliteQueryResult { + /// Column names from the result set + pub columns: Vec, + /// Describes a filesystem error. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// SQLite last_insert_rowid() value for INSERT. + #[serde(skip_serializing_if = "Option::is_none")] + pub last_insert_rowid: Option, + /// For SELECT: array of row objects. For others: empty array. + pub rows: Vec>, + /// Number of rows affected (for INSERT/UPDATE/DELETE) + pub rows_affected: i64, } -/// Identifies the target session. +/// Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried. /// ///
    /// @@ -12301,12 +13637,12 @@ pub struct SessionHistoryAbortManualCompactionResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistorySummarizeForHandoffParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionFsSqliteTransactionError { + pub error_class: SessionFsSqliteTransactionErrorClass, + pub message: String, } -/// Markdown summary of the conversation context (empty when not available). +/// One statement in an atomic SQLite transaction. /// ///
    /// @@ -12316,12 +13652,17 @@ pub struct SessionHistorySummarizeForHandoffParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionHistorySummarizeForHandoffResult { - /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. - pub summary: String, +pub struct SessionFsSqliteTransactionStatement { + /// Optional named bind parameters. + #[serde(skip_serializing_if = "Option::is_none")] + pub params: Option>, + /// SQL statement to execute. + pub query: String, + /// How to execute the statement. + pub query_type: SessionFsSqliteQueryType, } -/// Identifies the target session. +/// Statements to execute atomically. Providers apply busy handling for every call. /// ///
    /// @@ -12331,12 +13672,13 @@ pub struct SessionHistorySummarizeForHandoffResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionQueuePendingItemsParams { +pub struct SessionFsSqliteTransactionRequest { /// Target session identifier pub session_id: SessionId, + pub statements: Vec, } -/// Snapshot of the session's pending queued items and immediate-steering messages. +/// Per-statement results, or a classified transaction error. /// ///
    /// @@ -12346,14 +13688,13 @@ pub struct SessionQueuePendingItemsParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionQueuePendingItemsResult { - /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. - pub items: Vec, - /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). - pub steering_messages: Vec, +pub struct SessionFsSqliteTransactionResult { + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + pub results: Vec, } -/// Identifies the target session. +/// Path whose metadata should be returned from the client-provided session filesystem. /// ///
    /// @@ -12363,12 +13704,14 @@ pub struct SessionQueuePendingItemsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionQueueRemoveMostRecentParams { +pub struct SessionFsStatRequest { /// Target session identifier pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, } -/// Indicates whether a user-facing pending item was removed. +/// Filesystem metadata for the requested path, or a filesystem error if the stat failed. /// ///
    /// @@ -12378,12 +13721,23 @@ pub struct SessionQueueRemoveMostRecentParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionQueueRemoveMostRecentResult { - /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. - pub removed: bool, +pub struct SessionFsStatResult { + /// ISO 8601 timestamp of creation + pub birthtime: String, + /// Describes a filesystem error. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether the path is a directory + pub is_directory: bool, + /// Whether the path is a file + pub is_file: bool, + /// ISO 8601 timestamp of last modification + pub mtime: String, + /// File size in bytes + pub size: i64, } -/// Identifies the target session. +/// File path, content to write, and optional mode for the client-provided session filesystem. /// ///
    /// @@ -12393,12 +13747,19 @@ pub struct SessionQueueRemoveMostRecentResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionQueueClearParams { +pub struct SessionFsWriteFileRequest { /// Target session identifier pub session_id: SessionId, + /// Path using SessionFs conventions + pub path: String, + /// Content to write + pub content: String, + /// Optional POSIX-style mode for newly created files + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, } -/// Batch of session events returned by a read, with cursor and continuation metadata. +/// Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source. /// ///
    /// @@ -12408,18 +13769,31 @@ pub struct SessionQueueClearParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEventLogReadResult { - /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. - pub cursor: String, - /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. - pub cursor_status: EventsCursorStatus, - /// Events are delivered in two batches per read: persisted events first (in append order), then ephemeral events (in seq order). When `waitMs > 0` and the catch-up batches were empty, post-wait events follow the same two-batch ordering. Persisted and ephemeral events do not interleave within a single read. - pub events: Vec, - /// True when the read returned `max` events and more events are available immediately. When false, the next read with a non-zero `waitMs` will block until a new event arrives or the wait expires. - pub has_more: bool, +pub struct SessionInstalledPlugin { + /// Path where the plugin is cached locally + #[serde(rename = "cache_path", skip_serializing_if = "Option::is_none")] + pub cache_path: Option, + /// Whether the plugin is currently enabled + pub enabled: bool, + /// Installation timestamp (ISO-8601) + #[serde(rename = "installed_at")] + pub installed_at: String, + /// Marketplace the plugin came from (empty string for direct repo installs) + pub marketplace: String, + /// Plugin name + pub name: String, + /// Source descriptor for direct repo installs (when marketplace is empty) + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Per-plugin source fingerprint (a SHA-256 hash of the plugin's catalog source spec plus its resolved source subtree — NOT a Git commit SHA) captured at marketplace install/update time. Auto-update compares it against the freshly recomputed fingerprint to detect a content change that does not bump the version. Absent for pre-existing installs and for direct (non-marketplace) installs. + #[serde(rename = "source_sha", skip_serializing_if = "Option::is_none")] + pub source_sha: Option, + /// Installed version, if known + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, } -/// Identifies the target session. +/// Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath. /// ///
    /// @@ -12429,12 +13803,20 @@ pub struct SessionEventLogReadResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEventLogTailParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionInstalledPluginSourceGitHub { + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + pub repo: String, + /// Optional full 40-character hexadecimal commit SHA. + #[serde(skip_serializing_if = "Option::is_none")] + pub sha: Option, + /// Constant value. Always "github". + pub source: SessionInstalledPluginSourceGitHubSource, } -/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). +/// Source descriptor for a direct local plugin install, with a local filesystem path. /// ///
    /// @@ -12444,12 +13826,13 @@ pub struct SessionEventLogTailParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEventLogTailResult { - /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). - pub cursor: String, +pub struct SessionInstalledPluginSourceLocal { + pub path: String, + /// Constant value. Always "local". + pub source: SessionInstalledPluginSourceLocalSource, } -/// Opaque handle representing an event-type interest registration. +/// Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath. /// ///
    /// @@ -12459,12 +13842,20 @@ pub struct SessionEventLogTailResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEventLogRegisterInterestResult { - /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. - pub handle: String, +pub struct SessionInstalledPluginSourceUrl { + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub r#ref: Option, + /// Optional full 40-character hexadecimal commit SHA. + #[serde(skip_serializing_if = "Option::is_none")] + pub sha: Option, + /// Constant value. Always "url". + pub source: SessionInstalledPluginSourceUrlSource, + pub url: String, } -/// Indicates whether the operation succeeded. +/// Baseline data provenance for a prediction. /// ///
    /// @@ -12474,12 +13865,14 @@ pub struct SessionEventLogRegisterInterestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionEventLogReleaseInterestResult { - /// Whether the operation succeeded - pub success: bool, +pub struct SessionLimitPredictionBaselineData { + /// End of the baseline data slice. + pub window_end: String, + /// Start of the baseline data slice. + pub window_start: String, } -/// Identifies the target session. +/// Semantic usage tier and its AI-credit cap. /// ///
    /// @@ -12489,12 +13882,13 @@ pub struct SessionEventLogReleaseInterestResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUsageGetMetricsParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionLimitPredictionTierOption { + /// AI-credit cap for this tier. + pub cap: f64, + pub tier: SessionLimitPredictionTier, } -/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// Explainable AI-credit session-limit prediction. /// ///
    /// @@ -12504,35 +13898,29 @@ pub struct SessionUsageGetMetricsParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionUsageGetMetricsResult { - /// Aggregated code change metrics - pub code_changes: UsageMetricsCodeChanges, - /// Currently active model identifier - #[serde(skip_serializing_if = "Option::is_none")] - pub current_model: Option, - /// Input tokens from the most recent main-agent API call - pub last_call_input_tokens: i64, - /// Output tokens from the most recent main-agent API call - pub last_call_output_tokens: i64, - /// Per-model token and request metrics, keyed by model identifier - pub model_metrics: HashMap, - /// ISO 8601 timestamp when the session started - pub session_start_time: String, - /// Session-wide per-token-type accumulated token counts - #[serde(skip_serializing_if = "Option::is_none")] - pub token_details: Option>, - /// Total time spent in model API calls (milliseconds) - pub total_api_duration_ms: i64, - /// Session-wide accumulated nano-AI units cost +pub struct SessionLimitPredictionDetails { + /// Baseline data provenance. + pub baseline_data: SessionLimitPredictionBaselineData, + /// Client population used for the prediction. + pub client_type: SessionLimitPredictionClientType, + /// Resolved model family when known. #[serde(skip_serializing_if = "Option::is_none")] - pub total_nano_aiu: Option, - /// Total user-initiated premium request cost across all models (may be fractional due to multipliers) - pub total_premium_request_cost: f64, - /// Raw count of user-initiated API requests - pub total_user_requests: i64, + pub family: Option, + /// Model identifier used for lookup. + pub model_id: String, + /// Recommended maximum AI credits for this session. + pub recommended_cap: f64, + /// Tier chosen as the recommended cap. + pub recommended_tier: SessionLimitPredictionTier, + /// Baseline fallback level used to create the prediction. + pub source: SessionLimitPredictionSource, + /// Key matched at the source level, such as a model id, family id, or `global`. + pub source_key: String, + /// Ordered usage tiers and their AI-credit caps. + pub tiers: Vec, } -/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +/// Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. /// ///
    /// @@ -12542,30 +13930,32 @@ pub struct SessionUsageGetMetricsResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionRemoteEnableResult { - /// Whether remote steering is enabled - pub remote_steerable: bool, - /// GitHub frontend URL for this session +pub struct SessionLimitPredictionRequest { + /// Client type to size for. Defaults to `cli-interactive`. #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, + pub client_type: Option, + /// Optional model identifier override. If omitted, the session's current model is used. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, } -/// Identifies the target session. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionRemoteDisableParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionLimitPredictionResultAvailable { + pub kind: SessionLimitPredictionResultAvailableKind, + /// Predicted session limit details. + pub prediction: SessionLimitPredictionDetails, } -/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitPredictionResultUnavailable { + pub kind: SessionLimitPredictionResultUnavailableKind, + /// Reason no prediction is available. + pub reason: SessionLimitPredictionUnavailableReason, +} + +/// Sessions matching the filter, ordered most-recently-modified first. /// ///
    /// @@ -12575,9 +13965,12 @@ pub struct SessionRemoteDisableParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionRemoteNotifySteerableChangedResult {} +pub struct SessionList { + /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + pub sessions: Vec, +} -/// Identifies the target session. +/// Optional filter applied to the returned sessions /// ///
    /// @@ -12587,12 +13980,22 @@ pub struct SessionRemoteNotifySteerableChangedResult {} ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionScheduleListParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionListFilter { + /// Match sessions whose context.branch equals this value + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// Match sessions whose context.cwd equals this value + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Match sessions whose context.gitRoot equals this value + #[serde(skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Match sessions whose context.repository equals this value + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, } -/// Snapshot of the currently active recurring prompts for this session. +/// Queued repo-level startup prompts and the total hook command count after loading. /// ///
    /// @@ -12602,12 +14005,14 @@ pub struct SessionScheduleListParams { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionScheduleListResult { - /// Active scheduled prompts, ordered by id. - pub entries: Vec, +pub struct SessionLoadDeferredRepoHooksResult { + /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. + pub hook_count: i64, + /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. + pub startup_prompts: Vec, } -/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +/// Enterprise permission policy expressed with the runtime's managed permission-rule syntax. /// ///
    /// @@ -12617,13 +14022,22 @@ pub struct SessionScheduleListResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionScheduleStopResult { - /// The removed entry, or omitted if no entry matched. +pub struct SessionManagedPermissions { + /// Permission rules that allow matching operations unless another managed source, deny, or ask rule restricts them. #[serde(skip_serializing_if = "Option::is_none")] - pub entry: Option, + pub allow: Option>, + /// Permission rules that require explicit human approval. + #[serde(skip_serializing_if = "Option::is_none")] + pub ask: Option>, + /// Permission rules that block matching operations. Deny has highest precedence. + #[serde(skip_serializing_if = "Option::is_none")] + pub deny: Option>, + /// When set to `disable`, prevents bypass/allow-all permission modes. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_bypass_permissions_mode: Option, } -/// Identifies the target session. +/// Managed settings an SDK host may inject at session startup. Only permissions are accepted in this initial contract. /// ///
    /// @@ -12633,44 +14047,47 @@ pub struct SessionScheduleStopResult { ///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionFsSqliteExistsParams { - /// Target session identifier - pub session_id: SessionId, +pub struct SessionManagedSettings { + #[serde(skip_serializing_if = "Option::is_none")] + pub permissions: Option, } -/// Canvas open result returned by the provider. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Public-facing projection of workspace metadata for SDK / TUI consumers #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct CanvasOpenResult { - /// Provider-supplied status text +pub struct SessionMetadataSnapshotWorkspace { + /// Branch checked out at session start, if any #[serde(skip_serializing_if = "Option::is_none")] - pub status: Option, - /// Provider-supplied title + pub branch: Option, + /// ISO 8601 timestamp when the workspace was created + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory at session start #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option, - /// URL for web-rendered canvases + pub cwd: Option, + /// Resolved git root for cwd, if any + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Repository host type, if known + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + /// Workspace identifier (1:1 with sessionId) + pub id: String, + /// Display name for the session, if set #[serde(skip_serializing_if = "Option::is_none")] - pub url: Option, + pub name: Option, + /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// ISO 8601 timestamp when the workspace was last updated + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the display name was explicitly set by the user + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, } -/// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    -pub type McpExecuteSamplingResult = HashMap; - -/// The form values submitted by the user (present when action is 'accept') +/// Point-in-time snapshot of slow-changing session identifier and state fields /// ///
    /// @@ -12678,9 +14095,47 @@ pub type McpExecuteSamplingResult = HashMap; /// and may change or be removed in future SDK or CLI releases. /// ///
    -pub type UIElicitationResponseContent = HashMap; +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataSnapshot { + /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. + pub already_in_use: bool, + /// Runtime client name associated with the session (telemetry identifier). + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') + pub current_mode: MetadataSnapshotCurrentMode, + /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. + #[serde(skip_serializing_if = "Option::is_none")] + pub initial_name: Option, + /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) + pub is_remote: bool, + /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. + pub modified_time: String, + /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_metadata: Option, + /// Currently selected model identifier, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub selected_model: Option, + /// The unique identifier of the session + pub session_id: SessionId, + /// Current session limits, or null when no limits are active + pub session_limits: Option, + /// ISO 8601 timestamp of when the session started + pub start_time: String, + /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + /// Absolute path to the session's current working directory + pub working_directory: String, + /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). + pub workspace: Option, + /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace + pub workspace_path: Option, +} -/// Standard MCP CallToolResult +/// Cost-category metadata for a CAPI model. /// ///
    /// @@ -12688,9 +14143,14 @@ pub type UIElicitationResponseContent = HashMap; /// and may change or be removed in future SDK or CLI releases. /// ///
    -pub type SessionMcpAppsCallToolResult = HashMap; +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelPriceCategory { + pub id: String, + pub price_category: ModelPickerPriceCategory, +} -/// Where the agent definition was loaded from +/// The list of models available to this session. /// ///
    /// @@ -12698,33 +14158,20 @@ pub type SessionMcpAppsCallToolResult = HashMap; /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentInfoSource { - /// Agent loaded from the user's personal agent configuration. - #[serde(rename = "user")] - User, - /// Agent loaded from the current project's repository configuration. - #[serde(rename = "project")] - Project, - /// Agent inherited from a parent project or workspace. - #[serde(rename = "inherited")] - Inherited, - /// Agent provided by a remote runtime or service. - #[serde(rename = "remote")] - Remote, - /// Agent contributed by an installed plugin. - #[serde(rename = "plugin")] - Plugin, - /// Agent built into the Copilot runtime. - #[serde(rename = "builtin")] - Builtin, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelList { + /// Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`). + pub list: Vec, + /// Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_price_categories: Option>, + /// Per-quota snapshots returned alongside the model list, keyed by quota type. + #[serde(skip_serializing_if = "Option::is_none")] + pub quota_snapshots: Option>, } -/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +/// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. /// ///
    /// @@ -12732,30 +14179,14 @@ pub enum AgentInfoSource { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistryLiveTargetEntryAttentionKind { - /// Session is blocked on an unrecoverable error - #[serde(rename = "error")] - Error, - /// Session is waiting for a tool-permission decision - #[serde(rename = "permission")] - Permission, - /// Session is waiting for the user to approve or reject a plan - #[serde(rename = "exit_plan")] - ExitPlan, - /// Session is waiting on an elicitation prompt - #[serde(rename = "elicitation")] - Elicitation, - /// Session is waiting for free-form user input - #[serde(rename = "user_input")] - UserInput, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource { + pub name: String, + pub r#type: String, } -/// Process kind tag for the registry entry +/// Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source. /// ///
    /// @@ -12763,21 +14194,19 @@ pub enum AgentRegistryLiveTargetEntryAttentionKind { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistryLiveTargetEntryKind { - /// Interactive Copilot CLI exposing a UI server (legacy/normal CLI process) - #[serde(rename = "ui-server")] - UiServer, - /// Headless `--server --managed-server` child spawned by a controller - #[serde(rename = "managed-server")] - ManagedServer, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOpenOptionsAdditionalContentExclusionPolicyRule { + #[serde(skip_serializing_if = "Option::is_none")] + pub if_any_match: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub if_none_match: Option>, + pub paths: Vec, + /// Source descriptor for a `sessions.open` content-exclusion rule, with source name and type. + pub source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource, } -/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +/// Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope. /// ///
    /// @@ -12785,21 +14214,17 @@ pub enum AgentRegistryLiveTargetEntryKind { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistryLiveTargetEntryLastTerminalEvent { - /// Last turn ended cleanly (model returned a final assistant message) - #[serde(rename = "turn_end")] - TurnEnd, - /// Last turn was aborted (e.g. user interrupted) - #[serde(rename = "abort")] - Abort, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOpenOptionsAdditionalContentExclusionPolicy { + #[serde(rename = "last_updated_at")] + pub last_updated_at: serde_json::Value, + pub rules: Vec, + /// Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. + pub scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope, } -/// Coarse lifecycle status of the foreground session +/// A host-provided script sourced before each built-in shell command when its shell target matches the active shell. /// ///
    /// @@ -12807,27 +14232,16 @@ pub enum AgentRegistryLiveTargetEntryLastTerminalEvent { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistryLiveTargetEntryStatus { - /// Session is actively processing a turn - #[serde(rename = "working")] - Working, - /// Session is idle, waiting for input - #[serde(rename = "waiting")] - Waiting, - /// Last turn completed successfully - #[serde(rename = "done")] - Done, - /// Session needs user attention (see attentionKind for the specific reason) - #[serde(rename = "attention")] - Attention, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellInitScript { + /// Path to the script to source. + pub path: String, + /// Built-in shell that may source this script. + pub shell: ShellInitScriptShell, } -/// Categorized reason for log-open failure +/// Per-session settings for built-in shell tools. /// ///
    /// @@ -12835,32 +14249,31 @@ pub enum AgentRegistryLiveTargetEntryStatus { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistryLogCaptureOpenErrorReason { - /// Filesystem permission denied opening the log file - #[serde(rename = "permission")] - Permission, - /// No space left on device - #[serde(rename = "disk_full")] - DiskFull, - /// Other / uncategorized open failure - #[serde(rename = "other")] - Other, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, -} - -/// Discriminator: child_process.spawn itself failed -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnErrorKind { - #[serde(rename = "spawn-error")] - #[default] - SpawnError, +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellOptions { + /// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. + #[serde(skip_serializing_if = "Option::is_none")] + pub init_profile: Option, + /// Ordered host-provided script paths sourced before each built-in shell command when the + /// entry's shell target matches the active shell. Use these for rc files, environment setup scripts, + /// or other custom scripts. A script that returns a nonzero status is reported, and later scripts + /// and the user command continue while the shell remains running. Because scripts are sourced into + /// the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating behavior + /// can prevent continuation. Script standard output is preserved; Bash script stderr is discarded, + /// PowerShell exception messages are replaced, and runtime-generated failure notices omit + /// configured script paths. When sandboxing is enabled, each script must already be readable under + /// the active sandbox filesystem policy. Pass an empty array to clear the list. + #[serde(skip_serializing_if = "Option::is_none")] + pub init_scripts: Option>, + /// Flags passed to the active built-in shell process on startup, replacing its default flags. + /// When omitted, the built-in Bash shell uses `--norc --noprofile`, + /// and the built-in PowerShell shell uses `-NoProfile -NoLogo`. + #[serde(skip_serializing_if = "Option::is_none")] + pub process_flags: Option>, } -/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. +/// Session construction options. /// ///
    /// @@ -12868,12 +14281,9689 @@ pub enum AgentRegistrySpawnErrorKind { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnPermissionMode { - /// Standard permission posture (prompts for each request) - #[serde(rename = "default")] - Default, - /// Full allow-all (requires the controller-local session to currently be in allow-all mode) +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOpenOptions { + /// Additional content-exclusion policies to merge into the session policy set. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_content_exclusion_policies: + Option>, + /// Additional directories the agent may access beyond the working directory. Each entry is granted to the session's file-access allow-list and surfaced to the model (system prompt context and `@`-mention completion). Absolute paths are recommended; a relative path is resolved against the session's working directory. Nonexistent or unresolvable entries are skipped with a warning. This is applied on both session creation and resume, and is not persisted: a resumed session that omits this option does not retain previously supplied directories (re-supply them, exactly as the CLI re-passes `--add-dir`). + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_directories: Option>, + /// Runtime context discriminator for agent filtering. + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_context: Option, + /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_all_mcp_server_instructions: Option, + /// Whether ask_user is explicitly disabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub ask_user_disabled: Option, + /// Initial authentication info for the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_info: Option, + /// Allowlist of available tool names. + #[serde(skip_serializing_if = "Option::is_none")] + pub available_tools: Option>, + /// Options scoped to the built-in CAPI (Copilot API) provider. + #[serde(skip_serializing_if = "Option::is_none")] + pub capi: Option, + /// Structured client kind used for runtime behavior gates. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_kind: Option, + /// Identifier of the client driving the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Whether commit-message coauthor trailers are enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub coauthor_enabled: Option, + /// Override Copilot configuration directory. + #[serde(skip_serializing_if = "Option::is_none")] + pub config_dir: Option, + /// Whether auto-mode continuation is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub continue_on_auto_mode: Option, + /// Override URL for the Copilot API endpoint. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_url: Option, + /// Whether custom agents default to local-only execution. + #[serde(skip_serializing_if = "Option::is_none")] + pub custom_agents_local_only: Option, + /// Parent engagement ID for detached child telemetry rollup. + #[serde(skip_serializing_if = "Option::is_none")] + pub detached_from_spawning_parent_engagement_id: Option, + /// Parent session ID for detached child telemetry rollup. + #[serde(skip_serializing_if = "Option::is_none")] + pub detached_from_spawning_parent_session_id: Option, + /// Instruction source IDs disabled for this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_instruction_sources: Option>, + /// MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume. + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_mcp_servers: Option>, + /// Skill IDs disabled for this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_skills: Option>, + /// Experimental: enable native model citations (Anthropic models today), normalized onto the `assistant.message` event. Off by default; may change or be removed while the citations surface is experimental. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_citations: Option, + /// Opt in to capturing file changes for session rewind and session diff. Capture cannot reconstruct changes made before it was enabled. On create it starts capture from the first turn. It is also honored on resume: for a session that already has tracked prior turns, tracking continues automatically even if this is omitted; passing it on resume additionally enables tracking for an eligible session that has no prior root turn yet. Resuming a session whose prior root turns were never tracked has no restorable baseline, so tracking stays disabled for it and rewind reports file change tracking as unavailable; the resume itself still succeeds, so sessions that predate tracking remain loadable. The opt-in is only rejected when the session can never track (a subagent session, or one without local session storage). It is intentionally absent from the mutable options update because enabling it after edits have occurred would create an incomplete, misleading baseline. Subagents share the parent session's capture store and are not tracked as separate rewind points: a file a subagent writes is attributed to whichever root user turn was open when the capture was staged, just before the tool body ran. A turn cannot open while a staged capture is still in flight, so a subagent tool that staged under the spawning turn stays attributed to it however late the write lands, while a capture it stages after the user's next message belongs to that later turn. Attribution decides which turn's rewind point counts and file preview include that write; it does not narrow which rewinds revert it, because a rewind restores every capture from the selected turn onward, so the earlier spawning turn reverts it as well. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_file_change_tracking: Option, + /// Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_managed_settings: Option, + /// Whether on-demand custom instruction discovery is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_on_demand_instruction_discovery: Option, + /// Whether shell-script safety heuristics are enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_script_safety: Option, + /// Whether model responses stream as delta events. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_streaming: Option, + /// How MCP server environment values are interpreted. + #[serde(skip_serializing_if = "Option::is_none")] + pub env_value_mode: Option, + /// Override directory for session event logs. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_log_directory: Option, + /// Whether subagent callback events should be forwarded into the session event log sink. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_log_includes_subagents: Option, + /// Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_builtin_agents: Option>, + /// Denylist of tool names. + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_tools: Option>, + /// ExP assignment ('flight') data injected by an SDK integrator, in the same JSON shape the Copilot CLI fetches from the experimentation service (CopilotExpAssignmentResponse). When supplied this is fed into the FeatureFlagService exactly like CLI-fetched assignments and ExP-backed flags wait for it. When absent the session does not block on ExP. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) exp_assignments: Option, + /// Feature-flag values resolved by the host. + #[serde(skip_serializing_if = "Option::is_none")] + pub feature_flags: Option>, + /// Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. + #[serde(skip_serializing_if = "Option::is_none")] + pub included_builtin_agents: Option>, + /// Installed plugins visible to the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub installed_plugins: Option>, + /// Stable integration identifier for analytics. + #[serde(skip_serializing_if = "Option::is_none")] + pub integration_id: Option, + /// Whether experimental behavior is enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_experimental_mode: Option, + /// Whether interactive shell sessions are logged. + #[serde(skip_serializing_if = "Option::is_none")] + pub log_interactive_shells: Option, + /// Identifier sent to LSP-style integrations. + #[serde(skip_serializing_if = "Option::is_none")] + pub lsp_client_name: Option, + /// Permissions-only enterprise policy injected by the SDK host at session create or resume. Composes restrictively with self-fetched and device policy and is not persisted. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_settings: Option, + /// Maximum decoded byte size of a single inline model-facing binary tool result persisted in session events (default 10 MB). + #[serde(skip_serializing_if = "Option::is_none")] + pub max_inline_binary_bytes: Option, + /// Memory configuration for this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub memory: Option, + /// Initial model identifier. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Initial model capability overrides. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_capabilities_overrides: Option, + /// BYOK model definitions added to the selectable model list, each referencing a provider name. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub models: Option>, + /// Optional human-friendly session name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Custom model-provider configuration (BYOK). + #[serde(skip_serializing_if = "Option::is_none")] + pub provider: Option, + /// Named BYOK provider connections, additive to CAPI auth. Combining with `provider` is rejected. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub providers: Option>, + /// Initial reasoning effort level. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Initial reasoning summary mode for supported model clients. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_summary: Option, + /// Telemetry-only remote-defaulted flag. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_defaulted_on: Option, + /// Telemetry-only remote exporting flag. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_exporting: Option, + /// Whether this session supports remote steering. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + /// Whether the host is an interactive UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub running_in_interactive_mode: Option, + /// Resolved sandbox configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub sandbox_config: Option, + /// Capabilities enabled for this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_capabilities: Option>, + /// Optional stable session identifier to use for a new session. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, + /// Initial session limits. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, + /// Per-session settings for built-in shell tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell: Option, + /// Use shell.initProfile instead. Shell init profile. + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_init_profile: Option, + /// PowerShell process flags applied to built-in and user-requested shell commands. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_process_flags: Option>, + /// Additional directories to search for skills. + #[serde(skip_serializing_if = "Option::is_none")] + pub skill_directories: Option>, + /// Whether to skip custom instruction sources. + #[serde(skip_serializing_if = "Option::is_none")] + pub skip_custom_instructions: Option, + /// Optional trajectory output file path. + #[serde(skip_serializing_if = "Option::is_none")] + pub trajectory_file: Option, + /// Initial output verbosity level for supported models. + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, + /// Working directory to anchor the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, + /// Pre-resolved working-directory context for session startup. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory_context: Option, +} + +/// Parameters for creating a new local session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenCreate { + /// Whether to emit session.start during creation. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub emit_start: Option, + /// Create a new local session. + pub kind: SessionsOpenCreateKind, + /// Session construction options. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, +} + +/// Parameters for resuming a specific local session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenResume { + /// Resume a specific local session by ID or prefix. + pub kind: SessionsOpenResumeKind, + /// Session resume options. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Whether to emit session.resume after loading. Defaults to true. + #[serde(skip_serializing_if = "Option::is_none")] + pub resume: Option, + /// Session ID or unique prefix to resume. + pub session_id: SessionId, + /// Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + #[serde(skip_serializing_if = "Option::is_none")] + pub suppress_resume_workspace_metadata_writeback: Option, +} + +/// Parameters for resuming the most relevant local session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenResumeLast { + /// Working-directory context used to choose the most relevant session. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, + /// Resume the most relevant existing local session. + pub kind: SessionsOpenResumeLastKind, + /// Session resume options. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Suppress workspace.yaml metadata writeback when resuming from an incidental cwd. + #[serde(skip_serializing_if = "Option::is_none")] + pub suppress_resume_workspace_metadata_writeback: Option, +} + +/// Parameters for attaching to an already-active session by ID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenAttach { + /// Attach to an already-active in-process session by ID. Unlike `resume`, this does NOT re-load from disk; the session must already be loaded by an earlier `create`/`resume` call. Returns `status: 'not_found'` when no active session matches the id. Useful for in-process consumers that need a fresh API handle to a session opened elsewhere (e.g., a peer foreground-session switch). + pub kind: SessionsOpenAttachKind, + /// Session ID to attach to. + pub session_id: SessionId, +} + +/// Parameters for connecting to a live remote session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenRemote { + /// Connect to a live remote session. + pub kind: SessionsOpenRemoteKind, + /// Session options for the connection. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Remote session identifier to connect to. + pub remote_session_id: SessionId, + /// Repository context for the remote session. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, +} + +/// Parameters for creating a new cloud session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenCloud { + /// Create a new cloud (coding-agent) session. + pub kind: SessionsOpenCloudKind, + /// In-process callback invoked when the cloud task is created (before connection). Marked internal because a function reference cannot cross the JSON-RPC boundary. Disappears in the SDK migration: the field is purely cosmetic (it flips a single CLI phase label from 'creating' to 'connecting') and the wire-clean version just drops the intermediate phase. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) on_task_created: Option, + /// Session options for cloud session creation. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Optional owner (user or organization login) to associate with the cloud session when no repository is provided. Ignored when `repository` is set (the repo's owner takes precedence). + #[serde(skip_serializing_if = "Option::is_none")] + pub owner: Option, + /// Repository for the cloud session. + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, +} + +/// Parameters for fetching a remote session and handing it off to a new local session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenHandoff { + /// Fetch a remote session and hand it off to a new local session. + pub kind: SessionsOpenHandoffKind, + /// Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`). + pub metadata: RemoteSessionMetadataValue, + /// In-process confirmation callback `(request) => boolean | Promise` invoked when the handoff needs the caller to confirm a non-fatal blocker (e.g. a repository mismatch between the current working directory and the remote session). Returning `true` proceeds with the handoff; returning `false` (or omitting the callback) aborts it. Marked internal because a function reference cannot cross the JSON-RPC boundary, for the same reasons as `onProgress`. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) on_confirm: Option, + /// In-process progress callback `(update) => void` invoked for each handoff step. Marked internal because a function reference cannot cross the JSON-RPC boundary. The host-side `handoffSession` is already declared as `AsyncGenerator`; the schema layer flattens it because it does not yet support streaming methods. The wire-clean replacement is to expose the AsyncGenerator directly (or use vscode-jsonrpc `$/progress` notifications) once the schema/transport layer supports it. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) on_progress: Option, + /// Session construction options for the new local session. + #[serde(skip_serializing_if = "Option::is_none")] + pub options: Option, + /// Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session). + #[serde(skip_serializing_if = "Option::is_none")] + pub task_type: Option, +} + +/// `sessions.open` handoff progress update with step, status, and optional message. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenProgress { + /// Optional step message. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// Step status. + pub status: SessionsOpenProgressStatus, + /// Handoff step. + pub step: SessionsOpenProgressStep, +} + +/// Result of opening a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOpenResult { + /// Remote session metadata, present when status is `connected`. + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option, + /// Handoff progress steps, present when status is `handed_off`. + #[serde(skip_serializing_if = "Option::is_none")] + pub progress: Option>, + /// Remote session ID, present when status is `connected`. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_session_id: Option, + /// In-process SessionClientApi handle for the opened session, returned to CLI callers as a transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK consumers should construct per-session clients from `sessionId` instead. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) session_api: Option, + /// Opened session ID. Omitted when status is `not_found`. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, + /// Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. + #[serde(skip_serializing_if = "Option::is_none")] + pub startup_prompts: Option>, + /// Outcome of the open request. + pub status: SessionsOpenStatus, +} + +/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPruneResult { + /// Session IDs that would be deleted in dry-run mode (always empty otherwise) + pub candidates: Vec, + /// Session IDs that were deleted (always empty in dry-run mode) + pub deleted: Vec, + /// True when no deletions were actually performed + pub dry_run: bool, + /// Total bytes freed (actual when not dry-run, projected when dry-run) + pub freed_bytes: i64, + /// Session IDs that were skipped (e.g., named sessions) + pub skipped: Vec, +} + +/// Session IDs to close, deactivate, and delete from disk. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsBulkDeleteRequest { + /// Session IDs to close, deactivate, and delete from disk + pub session_ids: Vec, +} + +/// Session IDs to test for live in-use locks. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsCheckInUseRequest { + /// Session IDs to test for live in-use locks + pub session_ids: Vec, +} + +/// Session IDs from the input set that are currently in use by another process. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsCheckInUseResult { + /// Session IDs from the input set that are currently held by another running process via an alive lock file + pub in_use: Vec, +} + +/// Session ID to close. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsCloseRequest { + /// Session ID to close + pub session_id: SessionId, +} + +/// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsCloseResult {} + +/// Session ID to delete from disk. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsDeleteRequest { + /// Session ID to delete + pub session_id: SessionId, + /// Internal resolved session directory path to delete + #[serde(skip_serializing_if = "Option::is_none")] + pub session_path: Option, +} + +/// Session metadata records to enrich with summary and context information. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsEnrichMetadataRequest { + /// Session metadata records to enrich. Records that already have summary and context are returned unchanged. + pub sessions: Vec, +} + +/// New auth credentials to install on the session. Omit to leave credentials unchanged. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSetCredentialsParams { + /// The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime installs the supplied value immediately for outbound model/API requests. When the credential carries a raw token (`token`, `env`, or `gh-cli`) but no `copilotUser`, the runtime additionally re-resolves `copilotUser` server-side (best-effort, asynchronously, after the synchronous install) so plan/quota/billing metadata regains fidelity; on resolution failure the verbatim credential remains installed. It does NOT otherwise validate the credential. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit. + #[serde(skip_serializing_if = "Option::is_none")] + pub credentials: Option, +} + +/// Indicates whether the credential update succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSetCredentialsResult { + /// Whether the session ended up with a populated `copilotUser` for the installed credentials. `true` when the supplied credential already carried `copilotUser` or it was successfully re-resolved server-side. `false` when the credential is installed without `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In both `false` cases the token swap still applied, but plan/quota/billing metadata is degraded. Present whenever a credential was supplied; omitted only when no credential was supplied (no-op call). + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user_resolved: Option, + /// Whether the operation succeeded + pub success: bool, +} + +/// Availability of built-in job tools surfaced to boundary consumers. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsBuiltInToolAvailabilitySnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub create_pull_request: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub report_progress: Option, +} + +/// Named Rust-owned settings predicate to evaluate for this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsEvaluatePredicateRequest { + /// Predicate name. The runtime owns the raw feature-flag names and composition logic. + pub name: SessionSettingsPredicateName, + /// Tool name for tool-scoped predicates such as trivial-change handling. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_name: Option, +} + +/// Result of evaluating a Rust-owned settings predicate. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsEvaluatePredicateResult { + pub enabled: bool, +} + +/// Redacted job settings for a session. The job nonce is excluded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsJobSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub built_in_tool_availability: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub event_type: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub is_trigger_job: Option, +} + +/// Redacted model routing settings for a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsModelSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub callback_url: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub default_reasoning_effort: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub instance_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, +} + +/// Online-evaluation settings safe to expose across the SDK boundary. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsOnlineEvaluationSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_online_evaluation: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_online_evaluation_output_file: Option, +} + +/// Redacted repository and GitHub host settings for a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsRepoSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub commit: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub host_protocol: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub owner_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub owner_name: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub pr_commit_count: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub read_write: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub secret_scanning_url: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub server_url: Option, +} + +/// Redacted validation and memory-tool settings for a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsValidationSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub advisory_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub codeql_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub code_review_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub code_review_model: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub dependabot_timeout: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub memory_store_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub memory_vote_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub secret_scanning_enabled: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout: Option, +} + +/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsSnapshot { + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + pub job: SessionSettingsJobSnapshot, + pub model: SessionSettingsModelSnapshot, + pub online_evaluation: SessionSettingsOnlineEvaluationSnapshot, + pub repo: SessionSettingsRepoSnapshot, + #[serde(skip_serializing_if = "Option::is_none")] + pub start_time_ms: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_ms: Option, + pub validation: SessionSettingsValidationSnapshot, + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, +} + +/// UUID prefix to resolve to a unique session ID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsFindByPrefixRequest { + /// UUID prefix (>=7 hex chars, <36 chars). Returns the unique session ID, or undefined when there is no match or the prefix matches multiple sessions. + pub prefix: String, +} + +/// Session ID matching the prefix, omitted when no unique match exists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsFindByPrefixResult { + /// Omitted when no unique session matches the prefix (no match or ambiguous) + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, +} + +/// GitHub task ID to look up. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsFindByTaskIDRequest { + /// GitHub task ID to look up + pub task_id: String, +} + +/// ID of the local session bound to the given GitHub task, or omitted when none. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsFindByTaskIDResult { + /// Omitted when no local session is bound to that GitHub task + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, +} + +/// Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsForkRequest { + /// Optional friendly name to assign to the forked session. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Source session ID to fork from + pub session_id: SessionId, + /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included. + #[serde(skip_serializing_if = "Option::is_none")] + pub to_event_id: Option, +} + +/// Identifier and optional friendly name assigned to the newly forked session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsForkResult { + /// Friendly name assigned to the forked session, if any. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// The new forked session's ID + pub session_id: SessionId, +} + +/// Session ID whose board entry count should be returned. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetBoardEntryCountRequest { + /// Session ID whose board entry count should be returned. + pub session_id: SessionId, +} + +/// Dynamic-context board entry count, when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetBoardEntryCountResult { + /// Board entry count, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub count: Option, +} + +/// Session ID whose event-log file path to compute. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetEventFilePathRequest { + /// Session ID whose event-log file path to compute + pub session_id: SessionId, +} + +/// Absolute path to the session's events.jsonl file on disk. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetEventFilePathResult { + /// Absolute path to the session's events.jsonl file + pub file_path: String, +} + +/// Optional working-directory context used to score session relevance. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetLastForContextRequest { + /// Optional working-directory context used to score session relevance. When omitted the most-recently-modified session wins. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, +} + +/// Most-relevant session ID for the supplied context, or omitted when no sessions exist. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetLastForContextResult { + /// Most-relevant session ID for the supplied context, or omitted when no sessions exist + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, +} + +/// Session ID whose persisted metadata should be read. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetMetadataRequest { + /// Session ID to inspect + pub session_id: SessionId, +} + +/// Persisted local session metadata when the session exists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetMetadataResult { + /// Local session metadata, omitted when the session does not exist. + #[serde(skip_serializing_if = "Option::is_none")] + pub session: Option, +} + +/// Session ID to look up the persisted remote-steerable flag for. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetPersistedRemoteSteerableRequest { + /// Session ID to look up the persisted remote-steerable flag for + pub session_id: SessionId, +} + +/// The session's persisted remote-steerable flag, or omitted when no value has been persisted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetPersistedRemoteSteerableResult { + /// The session's persisted remote-steerable flag if recorded; omitted when no value has been persisted + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, +} + +/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSizes { + /// Map of sessionId -> on-disk size in bytes for the session's workspace directory + pub sizes: HashMap, +} + +/// Limit for non-empty local session IDs. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsListNonEmptySessionIdsRequest { + /// Maximum number of session IDs to return. + #[serde(skip_serializing_if = "Option::is_none")] + pub limit: Option, +} + +/// Recent local session IDs that contain user-visible history. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsListNonEmptySessionIdsResult { + /// Session IDs ordered newest-first. + pub session_ids: Vec, +} + +/// Optional source filter, metadata-load limit, and context filter applied to the returned sessions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsListRequest { + /// Optional filter applied to the returned sessions + #[serde(skip_serializing_if = "Option::is_none")] + pub filter: Option, + /// When true, include detached maintenance sessions. Defaults to false for user-facing session lists. + #[serde(skip_serializing_if = "Option::is_none")] + pub include_detached: Option, + /// When provided, only the first N local sessions (sorted by modification time, newest first) load full metadata; remaining sessions return basic info only. Use 0 to return only basic info for every local session. Has no effect on remote entries (which always carry their full shape). + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata_limit: Option, + /// Which session sources to include. Defaults to `local` for backward compatibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, + /// Only meaningful when `source` includes remote. When true, propagates errors from the remote service instead of silently returning an empty remote list. Defaults to false. + #[serde(skip_serializing_if = "Option::is_none")] + pub throw_on_error: Option, +} + +/// Active session ID whose deferred repo-level hooks should be loaded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsLoadDeferredRepoHooksRequest { + /// Active session ID whose deferred repo-level hooks should be loaded + pub session_id: SessionId, +} + +/// Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsPruneOldRequest { + /// When true, only report what would be deleted without performing any deletion + #[serde(skip_serializing_if = "Option::is_none")] + pub dry_run: Option, + /// Session IDs that should never be considered for pruning + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_session_ids: Option>, + /// When true, named sessions (set via /rename) are also eligible for pruning + #[serde(skip_serializing_if = "Option::is_none")] + pub include_named: Option, + /// Delete sessions whose modifiedTime is at least this many days old + pub older_than_days: i64, +} + +/// Session ID whose in-use lock should be released. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsReleaseLockRequest { + /// Session ID whose in-use lock should be released + pub session_id: SessionId, +} + +/// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsReleaseLockResult {} + +/// Active session ID and an optional flag for deferring repo-level hooks until folder trust. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsReloadPluginHooksRequest { + /// When true, skip repo-level hooks. Use before folder trust is confirmed; loadDeferredRepoHooks loads them post-trust. + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_repo_hooks: Option, + /// Active session ID to reload hooks for + pub session_id: SessionId, +} + +/// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsReloadPluginHooksResult {} + +/// Session ID whose pending events should be flushed to disk. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSaveRequest { + /// Session ID whose pending events should be flushed to disk + pub session_id: SessionId, +} + +/// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSaveResult {} + +/// Manager-wide additional plugins to register; replaces any previously-configured set. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSetAdditionalPluginsRequest { + /// Manager-wide additional plugins to register. Replaces any previously-configured set. Pass an empty array to clear. + pub plugins: Vec, +} + +/// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSetAdditionalPluginsResult {} + +/// Patch for the singleton's steering state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSetRemoteControlSteeringRequest { + /// Target steering state. Today only `true` is actionable on the underlying exporter; `false` is reserved for future use. + pub enabled: bool, +} + +/// Parameters for attaching the remote-control singleton to a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsStartRemoteControlRequest { + /// Configuration for the runtime-managed remote-control singleton. + pub config: RemoteControlConfig, + /// Local session id to attach remote control to. + pub session_id: SessionId, +} + +/// Parameters for stopping the remote-control singleton. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsStopRemoteControlRequest { + /// When provided, the stop is rejected unless the singleton currently points at this session id (compare-and-swap semantics). + #[serde(skip_serializing_if = "Option::is_none")] + pub expected_session_id: Option, + /// When true, the singleton is unconditionally torn down regardless of `expectedSessionId`. Use during shutdown or explicit `/remote off`. + #[serde(skip_serializing_if = "Option::is_none")] + pub force: Option, +} + +/// Parameters for atomically rebinding the remote-control singleton. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsTransferRemoteControlRequest { + /// When provided, the transfer is rejected unless the singleton currently points at this session id (compare-and-swap semantics to avoid clobbering newer state). + #[serde(skip_serializing_if = "Option::is_none")] + pub expected_from_session_id: Option, + /// Local session id to point remote control at. + pub to_session_id: String, +} + +/// Telemetry engagement ID for the session, when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTelemetryEngagement { + /// Current telemetry engagement ID, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub engagement_id: Option, +} + +/// Patch of mutable session options to apply to the running session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUpdateOptionsParams { + /// Additional content-exclusion policies to merge into the session's policy set. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_content_exclusion_policies: + Option>, + /// Runtime context discriminator (e.g., `cli`, `actions`). + #[serde(skip_serializing_if = "Option::is_none")] + pub agent_context: Option, + /// Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers. + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_all_mcp_server_instructions: Option, + /// Whether to disable the `ask_user` tool (encourages autonomous behavior). + #[serde(skip_serializing_if = "Option::is_none")] + pub ask_user_disabled: Option, + /// Allowlist of tool names available to this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub available_tools: Option>, + /// Options scoped to the built-in CAPI (Copilot API) provider. + #[serde(skip_serializing_if = "Option::is_none")] + pub capi: Option, + /// Identifier of the client driving the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// Whether to include the `Co-authored-by` trailer in commit messages. + #[serde(skip_serializing_if = "Option::is_none")] + pub coauthor_enabled: Option, + /// Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Whether to allow auto-mode continuation across turns. + #[serde(skip_serializing_if = "Option::is_none")] + pub continue_on_auto_mode: Option, + /// Override URL for the Copilot API endpoint. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_url: Option, + /// Whether to default custom agents to local-only execution. + #[serde(skip_serializing_if = "Option::is_none")] + pub custom_agents_local_only: Option, + /// Instruction source IDs to exclude from the system prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_instruction_sources: Option>, + /// Skill IDs that should be excluded from this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_skills: Option>, + /// Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_file_hooks: Option, + /// Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt). + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_host_git_operations: Option, + /// Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_on_demand_instruction_discovery: Option, + /// Whether to surface reasoning-summary events from the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_reasoning_summaries: Option, + /// Whether shell-script safety heuristics are enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_script_safety: Option, + /// Whether to enable cross-session store writes and reads. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_session_store: Option, + /// Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_skills: Option, + /// Whether to stream model responses. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_streaming: Option, + /// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). + #[serde(skip_serializing_if = "Option::is_none")] + pub env_value_mode: Option, + /// Override directory for the session-events log. When unset, the runtime's default events log directory is used. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_log_directory: Option, + /// Whether subagent callback events should be forwarded into the session event log sink. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_log_includes_subagents: Option, + /// Built-in subagent names to exclude from this session. Excluded built-ins are hidden from agent discovery and cannot be dispatched unless a custom agent with the same name is available. + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_builtin_agents: Option>, + /// Denylist of tool names for this session. + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_tools: Option>, + /// Map of feature-flag IDs to their boolean enabled state. + #[serde(skip_serializing_if = "Option::is_none")] + pub feature_flags: Option>, + /// Built-in subagent names to include in this session. When specified, only these built-ins are available, subject to runtime availability and exclusions. Custom agents with the same name remain available. Set to null to remove the allowlist restriction. + #[serde(skip_serializing_if = "Option::is_none")] + pub included_builtin_agents: Option>, + /// Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes. + #[serde(skip_serializing_if = "Option::is_none")] + pub installed_plugins: Option>, + /// Stable integration identifier used for analytics and rate-limit attribution. + #[serde(skip_serializing_if = "Option::is_none")] + pub integration_id: Option, + /// Whether experimental capabilities are enabled. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_experimental_mode: Option, + /// Whether interactive shell sessions are logged. + #[serde(skip_serializing_if = "Option::is_none")] + pub log_interactive_shells: Option, + /// Identifier sent to LSP-style integrations. + #[serde(skip_serializing_if = "Option::is_none")] + pub lsp_client_name: Option, + /// Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users). + #[serde(skip_serializing_if = "Option::is_none")] + pub manage_schedule_enabled: Option, + /// Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_inline_binary_bytes: Option, + /// The model ID to use for assistant turns. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Per-property model capability overrides for the selected model. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_capabilities_overrides: Option, + /// Organization-level custom instructions to inject into the system prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub organization_custom_instructions: Option, + /// Custom model-provider configuration (BYOK). + #[serde(skip_serializing_if = "Option::is_none")] + pub provider: Option, + /// Reasoning effort for the selected model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. When omitted, no effort override is applied. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Reasoning summary mode for supported model clients. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_summary: Option, + /// Whether the session is running in an interactive UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub running_in_interactive_mode: Option, + /// Resolved sandbox configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub sandbox_config: Option, + /// Replaces the session's capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove `memory` for reproducible scripted runs). Omit the field to leave the existing capability set unchanged. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_capabilities: Option>, + /// Optional session limits. Pass null to clear the session limits. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, + /// Per-session settings for built-in shell tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell: Option, + /// Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`). + #[doc(hidden)] + #[deprecated] + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_init_profile: Option, + /// PowerShell process flags applied to built-in and user-requested shell commands. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_process_flags: Option>, + /// Additional directories to search for skills. + #[serde(skip_serializing_if = "Option::is_none")] + pub skill_directories: Option>, + /// Whether to skip loading custom instruction sources. + #[serde(skip_serializing_if = "Option::is_none")] + pub skip_custom_instructions: Option, + /// Whether to skip embedding retrieval pipeline initialization and execution. + #[serde(skip_serializing_if = "Option::is_none")] + pub skip_embedding_retrieval: Option, + /// When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement. + #[serde(skip_serializing_if = "Option::is_none")] + pub suppress_custom_agent_prompt: Option, + /// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_filter_precedence: Option, + /// Optional path for trajectory output. + #[serde(skip_serializing_if = "Option::is_none")] + pub trajectory_file: Option, + /// Output verbosity level for supported models. + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, + /// Absolute working-directory path for shell tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_directory: Option, +} + +/// Indicates whether the session options patch was applied successfully. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUpdateOptionsResult { + /// Number of hooks loaded from installed plugins, returned when installedPlugins is updated + #[serde(skip_serializing_if = "Option::is_none")] + pub plugin_hook_count: Option, + /// Whether the operation succeeded + pub success: bool, +} + +/// User-requested shell execution cancellation handle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellCancelUserRequestedRequest { + /// Request ID previously passed to executeUserRequested + pub request_id: RequestId, +} + +/// Shell command to run, with optional working directory and timeout in milliseconds. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellExecRequest { + /// Shell command to execute + pub command: String, + /// Working directory (defaults to session working directory) + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Timeout in milliseconds (default: 30000) + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout: Option, +} + +/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellExecResult { + /// Unique identifier for tracking streamed output + pub process_id: String, +} + +/// User-requested shell command and cancellation handle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellExecuteUserRequestedRequest { + /// Shell command to execute + pub command: String, + /// Caller-provided cancellation handle for this execution + pub request_id: RequestId, +} + +/// Identifier of a process previously returned by "shell.exec" and the signal to send. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellKillRequest { + /// Process identifier returned by shell.exec + pub process_id: String, + /// Signal to send (default: SIGTERM) + #[serde(skip_serializing_if = "Option::is_none")] + pub signal: Option, +} + +/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShellKillResult { + /// Whether the signal was sent successfully + pub killed: bool, +} + +/// Parameters for shutting down the session +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ShutdownRequest { + /// Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Why the session is being shut down. Defaults to "routine" when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub r#type: Option, +} + +/// Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Skill { + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + #[serde(skip_serializing_if = "Option::is_none")] + pub argument_hint: Option, + /// Canonical slash command name used to invoke the skill, without the leading '/' + #[serde(skip_serializing_if = "Option::is_none")] + pub command_name: Option, + /// Description of what the skill does + pub description: String, + /// Whether the skill is currently enabled + pub enabled: bool, + /// Unique identifier for the skill + pub name: String, + /// Absolute path to the skill file + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Name of the plugin that provides the skill, when source is 'plugin' + #[serde(skip_serializing_if = "Option::is_none")] + pub plugin_name: Option, + /// Source location type (e.g., project, personal-copilot, plugin, builtin) + pub source: SkillSource, + /// Whether the skill can be invoked by the user as a slash command + pub user_invocable: bool, +} + +/// Canonical directory where skills can be discovered or created, with scope, preference, and optional project path. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillDiscoveryPath { + /// Absolute path of the create/discovery target (may not exist on disk yet) + pub path: String, + /// Whether this is the canonical directory to create a new skill in its tier. At most one entry per tier is preferred; the `personal-agents` and `custom` scopes are never preferred. + pub preferred_for_creation: bool, + /// The input project path this directory was derived from (only for project scope) + #[serde(skip_serializing_if = "Option::is_none")] + pub project_path: Option, + /// Which tier this directory belongs to + pub scope: SkillDiscoveryScope, +} + +/// Canonical locations where skills can be created so the runtime will recognize them. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillDiscoveryPathList { + /// Canonical skill create/discovery directories, in priority order + pub paths: Vec, +} + +/// Skills available to the session, with their enabled state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillList { + /// Available skills + pub skills: Vec, +} + +/// Skill names to mark as disabled in global configuration, replacing any previous list. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsConfigSetDisabledSkillsRequest { + /// List of skill names to disable + pub disabled_skills: Vec, +} + +/// Name of the skill to disable for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsDisableRequest { + /// Name of the skill to disable + pub name: String, +} + +/// Optional project paths and additional skill directories to include in discovery. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsDiscoverRequest { + /// When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_skills: Option, + /// Optional list of project directory paths to scan for project-scoped skills + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, + /// Optional list of additional skill directory paths to include + #[serde(skip_serializing_if = "Option::is_none")] + pub skill_directories: Option>, +} + +/// Name of the skill to enable for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsEnableRequest { + /// Name of the skill to enable + pub name: String, +} + +/// Optional project paths to enumerate. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsGetDiscoveryPathsRequest { + /// When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments. + #[serde(skip_serializing_if = "Option::is_none")] + pub exclude_host_skills: Option, + /// Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned. + #[serde(skip_serializing_if = "Option::is_none")] + pub project_paths: Option>, +} + +/// Skill invocation record with name, path, content, allowed tools, and turn number. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsInvokedSkill { + /// Tools that should be auto-approved when this skill is active, captured at invocation time + #[serde(skip_serializing_if = "Option::is_none")] + pub allowed_tools: Option>, + /// Full content of the skill file + pub content: String, + /// Turn number when the skill was invoked + pub invoked_at_turn: i64, + /// Unique identifier for the skill + pub name: String, + /// Path to the SKILL.md file + pub path: String, +} + +/// Skills invoked during this session, ordered by invocation time (most recent last). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsGetInvokedResult { + /// Skills invoked during this session, ordered by invocation time (most recent last) + pub skills: Vec, +} + +/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsLoadDiagnostics { + /// Errors emitted while loading skills (e.g. skills that failed to load entirely) + pub errors: Vec, + /// Warnings emitted while loading skills (e.g. skills that loaded but had issues) + pub warnings: Vec, +} + +/// Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, optional user-facing notice, and settings-change flag. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandAgentPromptResult { + /// Prompt text to display to the user + pub display_prompt: String, + /// Agent prompt result discriminator + pub kind: SlashCommandAgentPromptResultKind, + /// Optional target session mode for the agent prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// Optional user-facing notice to show before the prompt is submitted + #[serde(skip_serializing_if = "Option::is_none")] + pub notice: Option, + /// Prompt to submit to the agent + pub prompt: String, + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, +} + +/// Slash-command invocation result indicating completion, with optional message and settings-change flag. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandCompletedResult { + /// Completed result discriminator + pub kind: SlashCommandCompletedResultKind, + /// Optional user-facing message describing the completed command + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, +} + +/// Slash-command invocation result containing text output plus Markdown/ANSI rendering flags. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandTextResult { + /// Text result discriminator + pub kind: SlashCommandTextResultKind, + /// Whether text contains Markdown + #[serde(skip_serializing_if = "Option::is_none")] + pub markdown: Option, + /// Whether ANSI sequences should be preserved + #[serde(skip_serializing_if = "Option::is_none")] + pub preserve_ansi: Option, + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, + /// Text output for the client to render + pub text: String, +} + +/// Selectable slash-command subcommand option with name, description, and optional group label. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandSelectSubcommandOption { + /// Human-readable description of the subcommand + pub description: String, + /// Optional group label for organizing options + #[serde(skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Subcommand name to invoke + pub name: String, +} + +/// Slash-command invocation result asking the client to present subcommand options for a parent command. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SlashCommandSelectSubcommandResult { + /// Parent command name that requires subcommand selection + pub command: String, + /// Select subcommand result discriminator + pub kind: SlashCommandSelectSubcommandResultKind, + /// Available subcommand options for the client to present + pub options: Vec, + /// True when the invocation mutated user runtime settings; consumers caching settings should refresh + #[serde(skip_serializing_if = "Option::is_none")] + pub runtime_settings_changed: Option, + /// Human-readable title for the selection UI + pub title: String, +} + +/// Subagent model, reasoning effort, and context tier settings +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SubagentSettingsEntry { + /// Context tier override for matching subagents + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Reasoning effort override for matching subagents + #[serde(skip_serializing_if = "Option::is_none")] + pub effort_level: Option, + /// Model override for matching subagents + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, +} + +/// Subagent settings to apply, or null to clear the live session override +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SubagentSettings { + /// Per-agent settings keyed by subagent agent_type + #[serde(skip_serializing_if = "Option::is_none")] + pub agents: Option>, + /// Names of subagents the user has turned off; they cannot be dispatched + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_subagents: Option>, + /// Maximum number of subagents that can run concurrently; applies to usage-based billing users only + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrency: Option, + /// Maximum subagent nesting depth; applies to usage-based billing users only + #[serde(skip_serializing_if = "Option::is_none")] + pub max_depth: Option, +} + +/// Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskAgentInfo { + /// ISO 8601 timestamp when the current active period began + #[serde(skip_serializing_if = "Option::is_none")] + pub active_started_at: Option, + /// Accumulated active execution time in milliseconds + #[serde(skip_serializing_if = "Option::is_none")] + pub active_time_ms: Option, + /// Type of agent running this task + pub agent_type: String, + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub can_promote_to_background: Option, + /// ISO 8601 timestamp when the task finished + #[serde(skip_serializing_if = "Option::is_none")] + pub completed_at: Option, + /// Short description of the task + pub description: String, + /// Error message when the task failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether task execution is synchronously awaited or managed in the background + #[serde(skip_serializing_if = "Option::is_none")] + pub execution_mode: Option, + /// Unique task identifier + pub id: String, + /// ISO 8601 timestamp when the agent entered idle state + #[serde(skip_serializing_if = "Option::is_none")] + pub idle_since: Option, + /// Most recent response text from the agent + #[serde(skip_serializing_if = "Option::is_none")] + pub latest_response: Option, + /// Requested model override for the task when specified + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Most recent prompt delivered to the agent. Updated whenever the agent receives a follow-up message. + pub prompt: String, + /// Runtime model resolved for the task when available + #[serde(skip_serializing_if = "Option::is_none")] + pub resolved_model: Option, + /// Result text from the task when available + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, + /// ISO 8601 timestamp when the task was started + pub started_at: String, + /// Current lifecycle status of the task + pub status: TaskStatus, + /// Tool call ID associated with this agent task + pub tool_call_id: String, + /// Task kind + pub r#type: TaskAgentInfoType, +} + +/// Timestamped display line for task progress output or recent agent activity. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskProgressLine { + /// Display message, e.g., "▸ bash", "✓ edit src/foo.ts" + pub message: String, + /// ISO 8601 timestamp when this event occurred + pub timestamp: String, +} + +/// Progress snapshot for an agent task, with recent activity lines and optional latest intent. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskAgentProgress { + /// The most recent intent reported by the agent + #[serde(skip_serializing_if = "Option::is_none")] + pub latest_intent: Option, + /// Recent tool execution events converted to display lines + pub recent_activity: Vec, + /// Progress kind + pub r#type: TaskAgentProgressType, +} + +/// Background tasks currently tracked by the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskList { + /// Currently tracked tasks + pub tasks: Vec, +} + +/// Identifier of the background task to cancel. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksCancelRequest { + /// Task identifier + pub id: String, +} + +/// Indicates whether the background task was successfully cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksCancelResult { + /// Whether the task was successfully cancelled + pub cancelled: bool, +} + +/// The first sync-waiting task that can currently be promoted to background mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksGetCurrentPromotableResult { + /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. + #[serde(skip_serializing_if = "Option::is_none")] + pub task: Option, +} + +/// Identifier of the background task to fetch progress for. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksGetProgressRequest { + /// Task identifier (agent ID or shell ID) + pub id: String, +} + +/// Progress information for the task, or null when no task with that ID is tracked. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksGetProgressResult { + /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. + pub progress: Option, +} + +/// Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskShellInfo { + /// Whether the shell runs inside a managed PTY session or as an independent background process + pub attachment_mode: TaskShellInfoAttachmentMode, + /// Whether this shell task can be promoted to background mode + #[serde(skip_serializing_if = "Option::is_none")] + pub can_promote_to_background: Option, + /// Command being executed + pub command: String, + /// ISO 8601 timestamp when the task finished + #[serde(skip_serializing_if = "Option::is_none")] + pub completed_at: Option, + /// Short description of the task + pub description: String, + /// Whether task execution is synchronously awaited or managed in the background + #[serde(skip_serializing_if = "Option::is_none")] + pub execution_mode: Option, + /// Unique task identifier + pub id: String, + /// Path to the detached shell log, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub log_path: Option, + /// Process ID when available + #[serde(skip_serializing_if = "Option::is_none")] + pub pid: Option, + /// ISO 8601 timestamp when the task was started + pub started_at: String, + /// Current lifecycle status of the task + pub status: TaskStatus, + /// Task kind + pub r#type: TaskShellInfoType, +} + +/// Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskShellProgress { + /// Process ID when available + #[serde(skip_serializing_if = "Option::is_none")] + pub pid: Option, + /// Recent stdout/stderr lines from the running shell command + pub recent_output: String, + /// Progress kind + pub r#type: TaskShellProgressType, +} + +/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksPromoteCurrentToBackgroundResult { + /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. + #[serde(skip_serializing_if = "Option::is_none")] + pub task: Option, +} + +/// Identifier of the task to promote to background mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksPromoteToBackgroundRequest { + /// Task identifier + pub id: String, +} + +/// Indicates whether the task was successfully promoted to background mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksPromoteToBackgroundResult { + /// Whether the task was successfully promoted to background mode + pub promoted: bool, +} + +/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksRefreshResult {} + +/// Identifier of the completed or cancelled task to remove from tracking. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksRemoveRequest { + /// Task identifier + pub id: String, +} + +/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksRemoveResult { + /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). + pub removed: bool, +} + +/// Identifier of the target agent task, message content, and optional sender agent ID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksSendMessageRequest { + /// Agent ID of the sender, if sent on behalf of another agent + #[serde(skip_serializing_if = "Option::is_none")] + pub from_agent_id: Option, + /// Agent task identifier + pub id: String, + /// Message content to send to the agent + pub message: String, +} + +/// Indicates whether the message was delivered, with an error message when delivery failed. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksSendMessageResult { + /// Error message if delivery failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether the message was successfully delivered or steered + pub sent: bool, +} + +/// Agent type, prompt, name, and optional description and model override for the new task. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksStartAgentRequest { + /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose') + pub agent_type: String, + /// Short description of the task + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Optional model override + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Short name for the agent, used to generate a human-readable ID + pub name: String, + /// Task prompt for the agent + pub prompt: String, +} + +/// Identifier assigned to the newly started background agent task. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksStartAgentResult { + /// Generated agent ID for the background task + pub agent_id: String, +} + +/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TasksWaitForPendingResult {} + +/// Feature override key/value pairs to attach to subsequent telemetry events from this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TelemetrySetFeatureOverridesRequest { + /// Override key/value pairs to attach to subsequent telemetry events from this session. Replaces any previously-set overrides. + pub features: HashMap, +} + +/// Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TokenAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Authentication host. + pub host: String, + /// The token value itself. Treat as a secret. + pub token: String, + /// SDK-side token authentication; the host configured the token directly via the SDK. + pub r#type: TokenAuthInfoType, +} + +/// Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Tool { + /// Description of what the tool does + pub description: String, + /// Optional instructions for how to use this tool effectively + #[serde(skip_serializing_if = "Option::is_none")] + pub instructions: Option, + /// Tool identifier (e.g., "bash", "grep", "str_replace_editor") + pub name: String, + /// Optional namespaced name for declarative filtering (e.g., "playwright/navigate" for MCP tools) + #[serde(skip_serializing_if = "Option::is_none")] + pub namespaced_name: Option, + /// JSON Schema for the tool's input parameters + #[serde(skip_serializing_if = "Option::is_none")] + pub parameters: Option>, +} + +/// Built-in tools available for the requested model, with their parameters and instructions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolList { + /// List of available built-in tools with metadata + pub tools: Vec, +} + +/// Current lightweight tool metadata snapshot for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsGetCurrentMetadataResult { + /// Current tool metadata, or null when tools have not been initialized yet + pub tools: Option>, +} + +/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsInitializeAndValidateResult {} + +/// Optional model identifier whose tool overrides should be applied to the listing. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsListRequest { + /// Optional model ID — when provided, the returned tool list reflects model-specific overrides + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, +} + +/// Empty result after applying subagent settings +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsUpdateSubagentSettingsResult {} + +/// Selectable option for a UI elicitation multi-select array item, with submitted value and display label. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationArrayAnyOfFieldItemsAnyOf { + /// Value submitted when this option is selected. + pub r#const: String, + /// Display label for this option. + pub title: String, +} + +/// Schema applied to each item in the array. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationArrayAnyOfFieldItems { + /// Selectable options, each with a value and a display label. + pub any_of: Vec, +} + +/// Multi-select string field where each option pairs a value with a display label. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationArrayAnyOfField { + /// Default values selected when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option>, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Schema applied to each item in the array. + pub items: UIElicitationArrayAnyOfFieldItems, + /// Maximum number of items the user may select. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_items: Option, + /// Minimum number of items the user must select. + #[serde(skip_serializing_if = "Option::is_none")] + pub min_items: Option, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "array". + pub r#type: UIElicitationArrayAnyOfFieldType, +} + +/// Schema applied to each item in the array. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationArrayEnumFieldItems { + /// Allowed string values for each selected item. + pub r#enum: Vec, + /// Type discriminator. Always "string". + pub r#type: UIElicitationArrayEnumFieldItemsType, +} + +/// Multi-select string field whose allowed values are defined inline. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationArrayEnumField { + /// Default values selected when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option>, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Schema applied to each item in the array. + pub items: UIElicitationArrayEnumFieldItems, + /// Maximum number of items the user may select. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_items: Option, + /// Minimum number of items the user must select. + #[serde(skip_serializing_if = "Option::is_none")] + pub min_items: Option, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "array". + pub r#type: UIElicitationArrayEnumFieldType, +} + +/// JSON Schema describing the form fields to present to the user +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationSchema { + /// Form field definitions, keyed by field name + pub properties: HashMap, + /// List of required field names + #[serde(skip_serializing_if = "Option::is_none")] + pub required: Option>, + /// Schema type indicator (always 'object') + pub r#type: UIElicitationSchemaType, +} + +/// Prompt message and JSON schema describing the form fields to elicit from the user. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationRequest { + /// Message describing what information is needed from the user + pub message: String, + /// JSON Schema describing the form fields to present to the user + pub requested_schema: UIElicitationSchema, +} + +/// The elicitation response (accept with form values, decline, or cancel) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationResponse { + /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) + pub action: UIElicitationResponseAction, + /// The form values submitted by the user (present when action is 'accept') + #[serde(skip_serializing_if = "Option::is_none")] + pub content: Option>, +} + +/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationResult { + /// Whether the response was accepted. False if the request was already resolved by another client. + pub success: bool, +} + +/// Boolean field rendered as a yes/no toggle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationSchemaPropertyBoolean { + /// Default value selected when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "boolean". + pub r#type: UIElicitationSchemaPropertyBooleanType, +} + +/// Numeric field accepting either a number or an integer. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationSchemaPropertyNumber { + /// Default value populated in the input when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Maximum allowed value (inclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub maximum: Option, + /// Minimum allowed value (inclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub minimum: Option, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Numeric type accepted by the field. + pub r#type: UIElicitationSchemaPropertyNumberType, +} + +/// Free-text string field with optional length and format constraints. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationSchemaPropertyString { + /// Default value populated in the input when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Optional format hint that constrains the accepted input. + #[serde(skip_serializing_if = "Option::is_none")] + pub format: Option, + /// Maximum number of characters allowed. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_length: Option, + /// Minimum number of characters required. + #[serde(skip_serializing_if = "Option::is_none")] + pub min_length: Option, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "string". + pub r#type: UIElicitationSchemaPropertyStringType, +} + +/// Single-select string field whose allowed values are defined inline. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationStringEnumField { + /// Default value selected when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Allowed string values. + pub r#enum: Vec, + /// Optional display labels for each enum value, in the same order as `enum`. + #[serde(skip_serializing_if = "Option::is_none")] + pub enum_names: Option>, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "string". + pub r#type: UIElicitationStringEnumFieldType, +} + +/// Selectable option for a UI elicitation single-select string field, with submitted value and display label. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationStringOneOfFieldOneOf { + /// Value submitted when this option is selected. + pub r#const: String, + /// Display label for this option. + pub title: String, +} + +/// Single-select string field where each option pairs a value with a display label. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIElicitationStringOneOfField { + /// Default value selected when the form is first shown. + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + /// Help text describing the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Selectable options, each with a value and a display label. + pub one_of: Vec, + /// Human-readable label for the field. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Type discriminator. Always "string". + pub r#type: UIElicitationStringOneOfFieldType, +} + +/// Transient question to answer without adding it to conversation history. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIEphemeralQueryRequest { + /// In-process `AbortSignal` forwarded to the model client to cancel an in-flight request. Marked internal: excluded from the public SDK surface. Replaced by an explicit cancellation token + cancel RPC in the SDK migration. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) abort_signal: Option, + /// In-process streaming callback `(text) => void` invoked with each token as the model emits it. Marked internal: excluded from the public SDK surface. In a process-separated SDK this is replaced by a streaming RPC that yields chunks and a final answer. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) on_chunk: Option, + /// Question to answer from the current conversation context. + pub question: String, +} + +/// Transient answer generated from current conversation context. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIEphemeralQueryResult { + /// Full assistant response text. + pub answer: String, +} + +/// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIExitPlanModeResponse { + /// Whether the plan was approved. + pub approved: bool, + /// Whether subsequent edits should be auto-approved without confirmation. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approve_edits: Option, + /// When true, the agent is instructed to end its turn without starting implementation so the client can restore the session model and auto-submit a fresh implementation turn on it. Set only when a distinct plan configuration (a different model, reasoning effort, or context tier) actually ran the planning turn. + #[serde(skip_serializing_if = "Option::is_none")] + pub defer_implementation: Option, + /// Feedback from the user when they declined the plan or requested changes. + #[serde(skip_serializing_if = "Option::is_none")] + pub feedback: Option, + /// The action the user selected. Defaults to 'autopilot' when autoApproveEdits is true, otherwise 'interactive'. + #[serde(skip_serializing_if = "Option::is_none")] + pub selected_action: Option, +} + +/// Request ID of a pending `auto_mode_switch.requested` event and the user's response. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingAutoModeSwitchRequest { + /// The unique request ID from the auto_mode_switch.requested event + pub request_id: RequestId, + /// User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline). + pub response: UIAutoModeSwitchResponse, +} + +/// Pending elicitation request ID and the user's response (accept/decline/cancel + form values). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingElicitationRequest { + /// The unique request ID from the elicitation.requested event + pub request_id: RequestId, + /// The elicitation response (accept with form values, decline, or cancel) + pub result: UIElicitationResponse, +} + +/// Request ID of a pending `exit_plan_mode.requested` event and the user's response. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingExitPlanModeRequest { + /// The unique request ID from the exit_plan_mode.requested event + pub request_id: RequestId, + /// User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback. + pub response: UIExitPlanModeResponse, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingSamplingResponse {} + +/// Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingSamplingRequest { + /// The unique request ID from the sampling.requested event + pub request_id: RequestId, + /// Optional sampling result payload. Omit to reject/cancel the sampling request without providing a result. + #[serde(skip_serializing_if = "Option::is_none")] + pub response: Option, +} + +/// The user's selected action for an exhausted session limit. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UISessionLimitsExhaustedResponse { + /// Action selected by the user. + pub action: UISessionLimitsExhaustedResponseAction, + /// AI Credits to add to the current max when action is 'add'. + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_ai_credits: Option, + /// New absolute max AI Credits when action is 'set'. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, +} + +/// Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingSessionLimitsExhaustedRequest { + /// The unique request ID from the session_limits_exhausted.requested event + pub request_id: RequestId, + /// The selected session-limit action. + pub response: UISessionLimitsExhaustedResponse, +} + +/// User response for a pending user-input request, with answer text and whether it was typed freeform. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIUserInputResponse { + /// The user's answer text + pub answer: String, + /// True if the user typed a freeform response, false if they selected a presented choice. Used by telemetry to differentiate between free text input and choice selection. + pub was_freeform: bool, +} + +/// Request ID of a pending `user_input.requested` event and the user's response. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIHandlePendingUserInputRequest { + /// The unique request ID from the user_input.requested event + pub request_id: RequestId, + /// User response for a pending user-input request, with answer text and whether it was typed freeform. + pub response: UIUserInputResponse, +} + +/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIRegisterDirectAutoModeSwitchHandlerResult { + /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. + pub handle: String, +} + +/// Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIUnregisterDirectAutoModeSwitchHandlerRequest { + /// Handle previously returned by `registerDirectAutoModeSwitchHandler` + pub handle: String, +} + +/// Indicates whether the handle was active and the registration count was decremented. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UIUnregisterDirectAutoModeSwitchHandlerResult { + /// True if the handle was active and decremented the counter; false if the handle was unknown. + pub unregistered: bool, +} + +/// Configured per-agent subagent overrides +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UpdateSubagentSettingsRequestSubagents { + /// Per-agent settings keyed by subagent agent_type + #[serde(skip_serializing_if = "Option::is_none")] + pub agents: Option>, + /// Names of subagents the user has turned off; they cannot be dispatched + #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_subagents: Option>, + /// Maximum number of subagents that can run concurrently; applies to usage-based billing users only + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrency: Option, + /// Maximum subagent nesting depth; applies to usage-based billing users only + #[serde(skip_serializing_if = "Option::is_none")] + pub max_depth: Option, +} + +/// Subagent settings to apply to the current session +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UpdateSubagentSettingsRequest { + /// Subagent settings to apply, or null to clear the live session override + pub subagents: Option, +} + +/// Aggregated code change metrics +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsCodeChanges { + /// Distinct file paths modified during the session + pub files_modified: Vec, + /// Number of distinct files modified + pub files_modified_count: i64, + /// Total lines of code added + pub lines_added: i64, + /// Total lines of code removed + pub lines_removed: i64, +} + +/// Request count and cost metrics for this model +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsModelMetricRequests { + /// User-initiated premium request cost (with multiplier applied) + pub cost: f64, + /// Number of API requests made with this model + pub count: i64, +} + +/// Per-model token-detail entry containing the accumulated token count for one token type. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsModelMetricTokenDetail { + /// Accumulated token count for this token type + pub token_count: i64, +} + +/// Token usage metrics for this model +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsModelMetricUsage { + /// Total tokens read from prompt cache + pub cache_read_tokens: i64, + /// Total tokens written to prompt cache + pub cache_write_tokens: i64, + /// Total input tokens consumed + pub input_tokens: i64, + /// Total output tokens produced + pub output_tokens: i64, + /// Total output tokens used for reasoning + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_tokens: Option, +} + +/// Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsModelMetric { + /// Latest known prompt-cache expiration for this model. A timestamp in the past indicates that the observed cache has expired. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_expires_at: Option, + /// Request count and cost metrics for this model + pub requests: UsageMetricsModelMetricRequests, + /// Token count details per type + #[serde(skip_serializing_if = "Option::is_none")] + pub token_details: Option>, + /// Accumulated nano-AI units cost for this model + #[serde(skip_serializing_if = "Option::is_none")] + pub total_nano_aiu: Option, + /// Token usage metrics for this model + pub usage: UsageMetricsModelMetricUsage, +} + +/// Session-wide token-detail entry containing the accumulated token count for one token type. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageMetricsTokenDetail { + /// Accumulated token count for this token type + pub token_count: i64, +} + +/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UsageGetMetricsResult { + /// Aggregated code change metrics + pub code_changes: UsageMetricsCodeChanges, + /// Currently active model identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub current_model: Option, + /// Input tokens from the most recent main-agent API call + pub last_call_input_tokens: i64, + /// Output tokens from the most recent main-agent API call + pub last_call_output_tokens: i64, + /// Per-model token and request metrics, keyed by model identifier + pub model_metrics: HashMap, + /// ISO 8601 timestamp when the session started + pub session_start_time: String, + /// Session-wide per-token-type accumulated token counts + #[serde(skip_serializing_if = "Option::is_none")] + pub token_details: Option>, + /// Total time spent in model API calls (milliseconds) + pub total_api_duration_ms: i64, + /// Session-wide accumulated nano-AI units cost + #[serde(skip_serializing_if = "Option::is_none")] + pub total_nano_aiu: Option, + /// Total user-initiated premium request cost across all models (may be fractional due to multipliers) + pub total_premium_request_cost: f64, + /// Raw count of user-initiated API requests + pub total_user_requests: i64, +} + +/// Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserAuthInfo { + /// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this verbatim and does not re-fetch when set. + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user: Option, + /// Authentication host. + pub host: String, + /// OAuth user login. + pub login: String, + /// OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct. + pub r#type: UserAuthInfoType, +} + +/// Result of a user-requested shell command. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserRequestedShellCommandResult { + /// Error output when the execution failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Process exit code, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub exit_code: Option, + /// Captured command output + pub output: String, + /// Whether the command completed successfully + pub success: bool, + /// Tool call id emitted for the shell execution + pub tool_call_id: String, +} + +/// A single user setting's effective value alongside its default, so consumers can render settings left at their default. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserSettingMetadata { + /// The centrally-known default for this setting (null when no default is registered). + pub default: serde_json::Value, + /// True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false. + pub is_default: bool, + /// The effective value: the user's value if set, otherwise the default. + pub value: serde_json::Value, +} + +/// Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserSettingsGetResult { + /// Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default. + pub settings: HashMap, +} + +/// Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserSettingsSetRequest { + /// Partial user settings to write, as a free-form object keyed by setting name + pub settings: serde_json::Value, +} + +/// Outcome of writing user settings. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserSettingsSetResult { + /// Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed. + pub shadowed_keys: Vec, +} + +/// Current sharing status and shareable GitHub URL for a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct VisibilityGetResult { + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + #[serde(skip_serializing_if = "Option::is_none")] + pub share_url: Option, + /// Current sharing status. Absent when the session is not synced or the status could not be retrieved (e.g. the user is not authenticated). + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent. + pub synced: bool, +} + +/// Desired sharing status for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct VisibilitySetRequest { + /// Sharing status to apply. "repo" makes the session visible to repository readers; "unshared" restricts it to the creator and collaborators. + pub status: SessionVisibilityStatus, +} + +/// Effective sharing status and shareable GitHub URL after updating session visibility. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct VisibilitySetResult { + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + #[serde(skip_serializing_if = "Option::is_none")] + pub share_url: Option, + /// Effective sharing status after the update. May differ from the requested status for task types that are already visible to repository readers by default. Absent when the update could not be applied (e.g. the session is not synced or the user is not authenticated). + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent. + pub synced: bool, +} + +/// A single changed file and its unified diff. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspaceDiffFileChange { + /// Type of change represented by this file diff. + pub change_type: WorkspaceDiffFileChangeType, + /// Unified diff content for the file. Empty when the diff was truncated. + pub diff: String, + /// Whether the diff content was omitted because it exceeded the per-file size limit. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_truncated: Option, + /// Original file path for renamed files. + #[serde(skip_serializing_if = "Option::is_none")] + pub old_path: Option, + /// Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive). + pub path: String, +} + +/// Workspace diff result for the requested mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspaceDiffResult { + /// Default branch used for a branch diff, when branch mode was requested. + #[serde(skip_serializing_if = "Option::is_none")] + pub base_branch: Option, + /// Changed files and their unified diffs. + pub changes: Vec, + /// Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable. + pub is_fallback: bool, + /// Effective mode used for the returned changes. + pub mode: WorkspaceDiffMode, + /// Diff mode requested by the client. + pub requested_mode: WorkspaceDiffMode, + /// Why the session diff could not be produced, when applicable. Set only when `session` mode was requested and `isFallback` is true, so a client can tell the permanent `file-change-tracking-disabled` apart from the transient `session-busy`, which the same request answers once the session settles. Never set for `unstaged` or `branch` mode, and never `unsupported-remote-session`: a remote session's captures live on its own host, so a `session`-mode diff is rejected for one rather than answered with a controller-side fallback. + #[serde(skip_serializing_if = "Option::is_none")] + pub unavailable_reason: Option, +} + +/// Compaction summary checkpoint to persist. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesAddSummaryRequest { + /// Markdown summary content to persist. + pub content: String, + /// Summary title shown in checkpoint listings. + pub title: String, +} + +/// Persisted summary metadata and refreshed workspace metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesAddSummaryResult { + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub workspace: Option, +} + +/// Whether the autopilot objective file exists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesAutopilotObjectiveExistsResult { + /// True when the objective file exists. + pub exists: bool, +} + +/// Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesCheckpoints { + /// Filename of the checkpoint within the workspace checkpoints directory + pub filename: String, + /// Checkpoint number assigned by the workspace manager + pub number: i64, + /// Human-readable checkpoint title + pub title: String, +} + +/// Relative path and UTF-8 content for the workspace file to create or overwrite. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesCreateFileRequest { + /// File content to write as a UTF-8 string + pub content: String, + /// Relative path within the workspace files directory + pub path: String, +} + +/// Result of deleting the autopilot objective file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesDeleteAutopilotObjectiveResult { + /// True when a file was deleted. + pub deleted: bool, +} + +/// Parameters for computing a workspace diff. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesDiffRequest { + /// When true, ignore whitespace-only changes (git `--ignore-all-space`). Defaults to false. + #[serde(skip_serializing_if = "Option::is_none")] + pub ignore_whitespace: Option, + /// Diff mode requested by the client. + pub mode: WorkspaceDiffMode, +} + +/// Optional session context used when creating a local workspace. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesEnsureRequest { + /// Opaque workspace context supplied by the session host. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesGetWorkspaceResultWorkspace { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + pub id: String, + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesGetWorkspaceResult { + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Current workspace metadata, or null if not available + pub workspace: Option, +} + +/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesListCheckpointsResult { + /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. + pub checkpoints: Vec, +} + +/// Relative paths of files stored in the session workspace files directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesListFilesResult { + /// Relative file paths in the workspace files directory + pub files: Vec, +} + +/// Autopilot objective file content, or null when missing. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesReadAutopilotObjectiveResult { + /// Autopilot objective file content, or null when missing. + pub content: Option, +} + +/// Checkpoint number to read. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesReadCheckpointRequest { + /// Checkpoint number to read + pub number: i64, +} + +/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesReadCheckpointResult { + /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing + pub content: Option, +} + +/// Relative path of the workspace file to read. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesReadFileRequest { + /// Relative path within the workspace files directory + pub path: String, +} + +/// Contents of the requested workspace file as a UTF-8 string. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesReadFileResult { + /// File content as a UTF-8 string + pub content: String, +} + +/// Pasted content to save as a UTF-8 file in the session workspace. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesSaveLargePasteRequest { + /// Pasted content to save as a UTF-8 file + pub content: String, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesSaveLargePasteResultSaved { + /// Filename within the workspace files directory + pub filename: String, + /// Absolute filesystem path to the saved paste file + pub file_path: String, + /// Size of the saved file in bytes + pub size_bytes: i64, +} + +/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesSaveLargePasteResult { + /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) + pub saved: Option, +} + +/// Rollback point for local workspace summaries. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesTruncateSummariesRequest { + /// Number of newest summaries to keep. + pub keep_count: i64, +} + +/// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspaceSummary { + /// Branch checked out at session start, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// ISO 8601 timestamp when the workspace was created + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory at session start + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Resolved git root for cwd, if any + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Repository host type, if known + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + /// Workspace identifier (1:1 with sessionId) + pub id: String, + /// Display name for the session, if set + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// ISO 8601 timestamp when the workspace was last updated + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the display name was explicitly set by the user + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Workspace metadata fields to update. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesUpdateMetadataRequest { + /// Opaque workspace context supplied by the session host. + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, + /// Optional workspace display name override. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, +} + +/// Autopilot objective file content to persist. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesWriteAutopilotObjectiveRequest { + /// Autopilot objective file content. + pub content: String, +} + +/// Result of writing the autopilot objective file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct WorkspacesWriteAutopilotObjectiveResult { + /// Filesystem operation performed. + pub operation: String, +} + +/// List of Copilot models available to the resolved user, including capabilities and billing metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ModelsListResult { + /// List of available models with full metadata + pub models: Vec, +} + +/// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ModelsGetBuiltInCatalogResult { + /// Built-in model entries. + pub models: Vec, +} + +/// Built-in tools available for the requested model, with their parameters and instructions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolsListResult { + /// List of available built-in tools with metadata + pub tools: Vec, +} + +/// User-configured MCP servers, keyed by server name. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpConfigListResult { + /// All MCP servers from user config, keyed by name + pub servers: HashMap, +} + +/// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ExtensionsDiscoverResult { + /// Discovered user and enabled installed-plugin extensions from persisted Copilot home state + pub extensions: Vec, + /// Effective extension loading mode. Defaults to load_and_augment when unset. + pub mode: DiscoveredExtensionMode, +} + +/// Plugins installed in user/global state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsListResult { + /// Installed plugins + pub plugins: Vec, +} + +/// Result of installing a plugin. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsInstallResult { + /// Set when the install path is deprecated (e.g. direct repo / URL / local installs). Callers should surface this to end users. + #[serde(skip_serializing_if = "Option::is_none")] + pub deprecation_warning: Option, + /// The newly installed plugin's metadata + pub plugin: InstalledPluginInfo, + /// Optional post-install message provided by the plugin (e.g. setup instructions) + #[serde(skip_serializing_if = "Option::is_none")] + pub post_install_message: Option, + /// Number of skills discovered and installed from the plugin + pub skills_installed: i64, +} + +/// Result of updating a single plugin. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsUpdateResult { + /// Version after the update, when reported by the plugin manifest + #[serde(skip_serializing_if = "Option::is_none")] + pub new_version: Option, + /// Version that was previously installed, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_version: Option, + /// Number of skills discovered and installed after the update + pub skills_installed: i64, +} + +/// Result of updating all installed plugins. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsUpdateAllResult { + /// Per-plugin update results in deterministic order. + pub results: Vec, +} + +/// All registered marketplaces, including built-in defaults. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesListResult { + /// Registered marketplaces + pub marketplaces: Vec, +} + +/// Result of registering a new marketplace. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesAddResult { + /// Final name of the marketplace as resolved from its manifest + pub name: String, +} + +/// Outcome of the remove attempt, including dependent-plugin info when applicable. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesRemoveResult { + /// Names of installed plugins that prevented removal. Populated only when `removed=false`. + #[serde(skip_serializing_if = "Option::is_none")] + pub dependent_plugins: Option>, + /// True when the marketplace was actually removed. False when removal was skipped because the marketplace has dependent plugins and `force` was not set. + pub removed: bool, +} + +/// Plugins advertised by the marketplace. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesBrowseResult { + /// Plugins advertised by the marketplace + pub plugins: Vec, +} + +/// Result of refreshing one or more marketplace catalogs. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PluginsMarketplacesRefreshResult { + /// Per-marketplace refresh results in deterministic order. + pub results: Vec, +} + +/// Skills discovered across global and project sources. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsDiscoverResult { + /// Messages for skills that failed to load (e.g. malformed SKILL.md). Empty when host skills are excluded so host-local paths are not disclosed to multitenant callers. + #[serde(skip_serializing_if = "Option::is_none")] + pub errors: Option>, + /// All discovered skills across all sources + pub skills: Vec, +} + +/// Canonical locations where skills can be created so the runtime will recognize them. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SkillsGetDiscoveryPathsResult { + /// Canonical skill create/discovery directories, in priority order + pub paths: Vec, +} + +/// Agents discovered across user, project, plugin, and remote sources. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentsDiscoverResult { + /// All discovered agents across all sources + pub agents: Vec, +} + +/// Canonical locations where custom agents can be created so the runtime will recognize them. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentsGetDiscoveryPathsResult { + /// Canonical agent create/discovery directories, in priority order + pub paths: Vec, +} + +/// Instruction sources discovered across user, repository, and plugin sources. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct InstructionsDiscoverResult { + /// All discovered instruction sources + pub sources: Vec, +} + +/// Canonical files and directories where custom instructions can be created so the runtime will recognize them. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct InstructionsGetDiscoveryPathsResult { + /// Canonical instruction create/discovery files and directories, in priority order + pub paths: Vec, +} + +/// Slash commands available in the session, after applying any include/exclude filters. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CommandsListResult { + /// Commands available in this session + pub commands: Vec, +} + +/// Result of opening a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsOpenResult { + /// Remote session metadata, present when status is `connected`. + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option, + /// Handoff progress steps, present when status is `handed_off`. + #[serde(skip_serializing_if = "Option::is_none")] + pub progress: Option>, + /// Remote session ID, present when status is `connected`. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_session_id: Option, + /// In-process SessionClientApi handle for the opened session, returned to CLI callers as a transitional shortcut. Marked internal so the public SDK surface does not expose it; SDK consumers should construct per-session clients from `sessionId` instead. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) session_api: Option, + /// Opened session ID. Omitted when status is `not_found`. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, + /// Startup prompts queued by user-level hook configs at session creation. Only populated when status is `created`; resumed sessions return an empty array. + #[serde(skip_serializing_if = "Option::is_none")] + pub startup_prompts: Option>, + /// Outcome of the open request. + pub status: SessionsOpenStatus, +} + +/// Remote session connection result. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsConnectResult { + /// Metadata for a connected remote session. + pub metadata: ConnectedRemoteSessionMetadata, + /// SDK session ID for the connected remote session. + pub session_id: SessionId, +} + +/// Sessions matching the filter, ordered most-recently-modified first. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsListResult { + /// Sessions ordered most-recently-modified first. Discriminated by `isRemote`. + pub sessions: Vec, +} + +/// ID of the local session bound to the given GitHub task, or omitted when none. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsFindByTaskIdResult { + /// Omitted when no local session is bound to that GitHub task + #[serde(skip_serializing_if = "Option::is_none")] + pub session_id: Option, +} + +/// Map of sessionId -> on-disk size in bytes for each session's workspace directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetSizesResult { + /// Map of sessionId -> on-disk size in bytes for the session's workspace directory + pub sizes: HashMap, +} + +/// Map of sessionId -> bytes freed by removing the session's workspace directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsBulkDeleteResult { + /// Map of sessionId -> bytes freed by removing the session's workspace directory. Sessions whose deletion failed are omitted from this map (failures are logged on the server but not surfaced per-id; check the map for absent IDs to detect them). + pub freed_bytes: HashMap, +} + +/// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsPruneOldResult { + /// Session IDs that would be deleted in dry-run mode (always empty otherwise) + pub candidates: Vec, + /// Session IDs that were deleted (always empty in dry-run mode) + pub deleted: Vec, + /// True when no deletions were actually performed + pub dry_run: bool, + /// Total bytes freed (actual when not dry-run, projected when dry-run) + pub freed_bytes: i64, + /// Session IDs that were skipped (e.g., named sessions) + pub skipped: Vec, +} + +/// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsEnrichMetadataResult { + /// Enriched records, with summary and context backfilled. Sessions confirmed empty and unnamed may be omitted. + pub sessions: Vec, +} + +/// Queued repo-level startup prompts and the total hook command count after loading. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsLoadDeferredRepoHooksResult { + /// Total hook command count (user + plugin + repo) loaded for the session by this call. Captured atomically with startupPrompts so callers don't need to read a separate counter. + pub hook_count: i64, + /// Repo-level startup prompts queued from repo hook configs. Empty on resume, when no repo configs were pending, or when disableAllHooks is set. + pub startup_prompts: Vec, +} + +/// Wrapper for the singleton's current status. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsStartRemoteControlResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, +} + +/// Outcome of a transferRemoteControl call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsTransferRemoteControlResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, + /// Whether the rebinding actually happened. + pub transferred: bool, +} + +/// Wrapper for the singleton's current status. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsSetRemoteControlSteeringResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, +} + +/// Outcome of a stopRemoteControl call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsStopRemoteControlResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, + /// Whether the singleton was actually torn down by this call. + pub stopped: bool, +} + +/// Wrapper for the singleton's current status. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionsGetRemoteControlStatusResult { + /// State of the runtime-managed remote-control singleton. + pub status: serde_json::Value, +} + +/// Handle for releasing the extension tool registration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct SessionsRegisterExtensionToolsOnSessionResult { + /// In-process unsubscribe function (CLI-only optimization). Marked internal: replaced by an explicit `extensions.unregister` RPC in the SDK migration. + #[doc(hidden)] + pub(crate) unsubscribe: serde_json::Value, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSuspendParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Result of sending a user message +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSendResult { + /// Unique identifier assigned to the message + pub message_id: String, +} + +/// Result of sending zero or more user messages +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSendMessagesResult { + /// Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided. + pub message_ids: Vec, +} + +/// Result of aborting the current turn +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAbortResult { + /// Error message if the abort failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether the abort completed successfully + pub success: bool, +} + +/// Result of interrupting the main agent turn. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionInterruptMainTurnResult { + /// Whether an in-flight main agent turn was interrupted. False when the main loop was not processing. + pub interrupted: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCancelAllBackgroundAgentsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionGitHubAuthGetStatusParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Authentication status and account metadata for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionGitHubAuthGetStatusResult { + /// Authentication type + #[serde(skip_serializing_if = "Option::is_none")] + pub auth_type: Option, + /// Copilot plan tier (e.g., individual_pro, business) + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_plan: Option, + /// Authentication host URL + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Whether the session has resolved authentication + pub is_authenticated: bool, + /// Authenticated login/username, if available + #[serde(skip_serializing_if = "Option::is_none")] + pub login: Option, + /// Human-readable authentication status description + #[serde(skip_serializing_if = "Option::is_none")] + pub status_message: Option, +} + +/// Indicates whether the credential update succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionGitHubAuthSetCredentialsResult { + /// Whether the session ended up with a populated `copilotUser` for the installed credentials. `true` when the supplied credential already carried `copilotUser` or it was successfully re-resolved server-side. `false` when the credential is installed without `copilotUser` — either re-resolution failed, or the variant cannot be re-resolved from the credential alone (only the raw-token variants `token`, `env`, and `gh-cli` can). In both `false` cases the token swap still applied, but plan/quota/billing metadata is degraded. Present whenever a credential was supplied; omitted only when no credential was supplied (no-op call). + #[serde(skip_serializing_if = "Option::is_none")] + pub copilot_user_resolved: Option, + /// Whether the operation succeeded + pub success: bool, +} + +/// Result of collecting a redacted debug bundle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionDebugCollectLogsResult { + /// Files included in the redacted bundle. + pub entries: Vec, + /// Destination kind that was written. + pub kind: DebugCollectLogsResultKind, + /// Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed. + pub path: String, + /// Optional files or directories that could not be included. + #[serde(skip_serializing_if = "Option::is_none")] + pub skipped_entries: Option>, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Declared canvases available in this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasListResult { + /// Declared canvases available in this session + pub canvases: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasListOpenParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Live open-canvas snapshot. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasListOpenResult { + /// Currently open canvas instances + pub open_canvases: Vec, +} + +/// Open canvas instance snapshot. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasOpenResult { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Owning extension display name, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub extension_name: Option, + /// Host-local PNG path for the canvas icon, when supplied + #[serde(skip_serializing_if = "Option::is_none")] + pub icon: Option, + /// Input supplied when the instance was opened + #[serde(skip_serializing_if = "Option::is_none")] + pub input: Option, + /// Stable caller-supplied canvas instance identifier + pub instance_id: String, + /// Provider-supplied status text + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Rendered title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL for web-rendered canvases + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +/// Canvas action invocation result. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasActionInvokeResult { + /// Provider-supplied action result + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, +} + +/// Complete current or terminal factory run envelope. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryRunResult { + /// Error message for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Machine-readable failure details for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub failure: Option, + /// Reason for a halted or cancelled run. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Completed factory result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, + /// Factory run identifier. + pub run_id: String, + /// Partial journal and progress snapshot for a halted, cancelled, or errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub snapshot: Option, + /// Current or terminal factory run status. + pub status: FactoryRunStatus, +} + +/// Resolved persisted factory identity and resumed run envelope. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryResumeResult { + /// Persisted factory name resolved for the resumed run. + pub factory_name: String, + /// Terminal resumed run envelope. + pub run: FactoryRunResult, +} + +/// Complete current or terminal factory run envelope. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryGetRunResult { + /// Error message for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Machine-readable failure details for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub failure: Option, + /// Reason for a halted or cancelled run. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Completed factory result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, + /// Factory run identifier. + pub run_id: String, + /// Partial journal and progress snapshot for a halted, cancelled, or errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub snapshot: Option, + /// Current or terminal factory run status. + pub status: FactoryRunStatus, +} + +/// A page of factory runs in durable creation order. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryListRunsResult { + /// Whether terminal runs newer than this page exist. + #[serde(skip_serializing_if = "Option::is_none")] + pub has_more_newer: Option, + /// Newest terminal-run cursor in this page, or null when the terminal window is empty. + #[serde(skip_serializing_if = "Option::is_none")] + pub newest_seq: Option, + /// Oldest terminal-run cursor in this page, or null when the terminal window is empty. + #[serde(skip_serializing_if = "Option::is_none")] + pub oldest_seq: Option, + /// Number of terminal runs older than this page. + #[serde(skip_serializing_if = "Option::is_none")] + pub omitted_older: Option, + pub runs: Vec, +} + +/// Full factory run observability detail. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryGetRunDetailResult { + pub active_segment_started_at: Option, + pub agents: Vec, + pub approved: Option, + pub completed_at: Option, + pub consumed: FactoryRunConsumed, + pub created_at: i64, + pub current_phase: Option, + pub declared_limits: FactoryDeclaredLimits, + pub declared_phase_count: i64, + pub description: String, + pub factory_name: String, + pub live_agent_count: i64, + pub observed_at: i64, + pub phases: Vec, + pub progress: FactoryProgressPage, + pub revision: i64, + pub run_id: String, + pub started_at: Option, + pub status: FactoryRunStatus, + pub terminal: Option, + pub total_spawned_agent_count: i64, + pub updated_at: i64, +} + +/// A bidirectional page of factory progress. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryGetRunProgressResult { + pub has_more_newer: bool, + pub has_more_older: bool, + pub newest_seq: Option, + pub oldest_seq: Option, + pub records: Vec, + /// Run revision reflected by this page. + pub revision: i64, +} + +/// Complete current or terminal factory run envelope. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryCancelResult { + /// Error message for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Machine-readable failure details for an errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub failure: Option, + /// Reason for a halted or cancelled run. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Completed factory result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, + /// Factory run identifier. + pub run_id: String, + /// Partial journal and progress snapshot for a halted, cancelled, or errored run. + #[serde(skip_serializing_if = "Option::is_none")] + pub snapshot: Option, + /// Current or terminal factory run status. + pub status: FactoryRunStatus, +} + +/// Acknowledgement that a factory request was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryLogResult {} + +/// Result of one factory-scoped subagent call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryAgentResult { + /// Agent result, omitted when the agent produced no result. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, +} + +/// Result of reading a factory journal entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryJournalGetResult { + /// Whether the journal contained the requested key. + pub hit: bool, + /// Cached JSON result. The hit field distinguishes a cached JSON null from a miss. + #[serde(skip_serializing_if = "Option::is_none")] + pub result_json: Option, +} + +/// Acknowledgement that a factory request was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFactoryJournalPutResult {} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelGetCurrentParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelGetCurrentResult { + /// Context tier for models that support multiple context-window sizes. + #[serde(skip_serializing_if = "Option::is_none")] + pub context_tier: Option, + /// Currently active model identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, +} + +/// The model identifier active on the session after the switch. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelSwitchToResult { + /// True when the switch was deferred (enqueued as a cancellable `/model` command) because a turn was active or another model change was already queued, rather than applied immediately. When true, the session's live model is unchanged until the queued change drains. + #[serde(skip_serializing_if = "Option::is_none")] + pub deferred: Option, + /// Currently active model identifier after the switch + #[serde(skip_serializing_if = "Option::is_none")] + pub model_id: Option, +} + +/// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelSetReasoningEffortResult { + /// Reasoning effort level recorded on the session after the update + pub reasoning_effort: String, +} + +/// The list of models available to this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModelListResult { + /// Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`). + pub list: Vec, + /// Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable. + #[serde(skip_serializing_if = "Option::is_none")] + pub model_price_categories: Option>, + /// Per-quota snapshots returned alongside the model list, keyed by quota type. + #[serde(skip_serializing_if = "Option::is_none")] + pub quota_snapshots: Option>, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionModeGetParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionNameGetParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The session's friendly name, or null when not yet set. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionNameGetResult { + /// The session name (user-set or auto-generated), or null if not yet set + pub name: Option, +} + +/// Indicates whether the auto-generated summary was applied as the session's name. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionNameSetAutoResult { + /// Whether the auto-generated summary was persisted. False if the session already has a user-set name, the summary normalized to empty, or the session does not have a workspace. + pub applied: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Existence, contents, and resolved path of the session plan file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadResult { + /// The content of the plan file, or null if it does not exist + pub content: Option, + /// Whether the plan file exists in the workspace + pub exists: bool, + /// Absolute file path of the plan file, or null if workspace is not enabled + pub path: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanDeleteParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadSqlTodosParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Todo rows read from the session SQL database. Empty when no session database is available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadSqlTodosResult { + /// Rows from the session SQL todos table, ordered by creation time and id. + pub rows: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadSqlTodosWithDependenciesParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Todo rows + dependency edges read from the session SQL database. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPlanReadSqlTodosWithDependenciesResult { + /// Edges from the session SQL todo_deps table. Empty when no database, no todo_deps table, or the SELECT failed. Read independently from `rows`, so a broken todo_deps table does not affect the rows result and vice versa. + pub dependencies: Vec, + /// Rows from the session SQL todos table, ordered by creation time and id. Empty when no database, no todos table, or the SELECT failed. + pub rows: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesGetWorkspaceParams { + /// Target session identifier + pub session_id: SessionId, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesGetWorkspaceResultWorkspace { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + pub id: String, + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesGetWorkspaceResult { + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Current workspace metadata, or null if not available + pub workspace: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesUpdateMetadataResultWorkspace { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + pub id: String, + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesUpdateMetadataResult { + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Current workspace metadata, or null if not available + pub workspace: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesEnsureResultWorkspace { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + pub id: String, + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesEnsureResult { + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Current workspace metadata, or null if not available + pub workspace: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesListFilesParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Relative paths of files stored in the session workspace files directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesListFilesResult { + /// Relative file paths in the workspace files directory + pub files: Vec, +} + +/// Contents of the requested workspace file as a UTF-8 string. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesReadFileResult { + /// File content as a UTF-8 string + pub content: String, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesListCheckpointsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Workspace checkpoints in chronological order; empty when the workspace is not enabled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesListCheckpointsResult { + /// Workspace checkpoints in chronological order. Empty when workspace is not enabled. + pub checkpoints: Vec, +} + +/// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesReadCheckpointResult { + /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing + pub content: Option, +} + +/// Persisted summary metadata and refreshed workspace metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesAddSummaryResult { + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub workspace: Option, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesTruncateSummariesResultWorkspace { + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + #[serde( + rename = "chronicle_sync_dismissed", + skip_serializing_if = "Option::is_none" + )] + pub chronicle_sync_dismissed: Option, + #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")] + pub client_name: Option, + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + pub id: String, + #[serde(rename = "mc_last_event_id", skip_serializing_if = "Option::is_none")] + pub mc_last_event_id: Option, + #[serde(rename = "mc_session_id", skip_serializing_if = "Option::is_none")] + pub mc_session_id: Option, + #[serde(rename = "mc_task_id", skip_serializing_if = "Option::is_none")] + pub mc_task_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "remote_steerable", skip_serializing_if = "Option::is_none")] + pub remote_steerable: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + #[serde(rename = "summary_count", skip_serializing_if = "Option::is_none")] + pub summary_count: Option, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Current workspace metadata for the session, including its absolute filesystem path when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesTruncateSummariesResult { + /// Absolute filesystem path to the workspace directory. Omitted when the session has no workspace (e.g. remote sessions). + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Current workspace metadata, or null if not available + pub workspace: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesReadAutopilotObjectiveParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Autopilot objective file content, or null when missing. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesReadAutopilotObjectiveResult { + /// Autopilot objective file content, or null when missing. + pub content: Option, +} + +/// Result of writing the autopilot objective file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesWriteAutopilotObjectiveResult { + /// Filesystem operation performed. + pub operation: String, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesDeleteAutopilotObjectiveParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Result of deleting the autopilot objective file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesDeleteAutopilotObjectiveResult { + /// True when a file was deleted. + pub deleted: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesAutopilotObjectiveExistsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Whether the autopilot objective file exists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesAutopilotObjectiveExistsResult { + /// True when the objective file exists. + pub exists: bool, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesSaveLargePasteResultSaved { + /// Filename within the workspace files directory + pub filename: String, + /// Absolute filesystem path to the saved paste file + pub file_path: String, + /// Size of the saved file in bytes + pub size_bytes: i64, +} + +/// Descriptor for the saved paste file, or null when the workspace is unavailable. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesSaveLargePasteResult { + /// Saved-paste descriptor, or null when the workspace is unavailable (e.g. CCA runtime, non-infinite sessions, remote sessions) + pub saved: Option, +} + +/// Workspace diff result for the requested mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionWorkspacesDiffResult { + /// Default branch used for a branch diff, when branch mode was requested. + #[serde(skip_serializing_if = "Option::is_none")] + pub base_branch: Option, + /// Changed files and their unified diffs. + pub changes: Vec, + /// Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable. + pub is_fallback: bool, + /// Effective mode used for the returned changes. + pub mode: WorkspaceDiffMode, + /// Diff mode requested by the client. + pub requested_mode: WorkspaceDiffMode, + /// Why the session diff could not be produced, when applicable. Set only when `session` mode was requested and `isFallback` is true, so a client can tell the permanent `file-change-tracking-disabled` apart from the transient `session-busy`, which the same request answers once the session settles. Never set for `unstaged` or `branch` mode, and never `unsupported-remote-session`: a remote session's captures live on its own host, so a `session`-mode diff is rejected for one rather than answered with a controller-side fallback. + #[serde(skip_serializing_if = "Option::is_none")] + pub unavailable_reason: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCompletionsGetTriggerCharactersParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCompletionsGetTriggerCharactersResult { + /// Trigger characters advertised by the host (e.g. `["@", "#"]`). Empty disables host-driven completions for the session. + pub trigger_characters: Vec, +} + +/// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCompletionsRequestResult { + /// Completion items in host-ranked order. + pub items: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionInstructionsGetSourcesParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Instruction sources loaded for the session, in merge order. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionInstructionsGetSourcesResult { + /// Instruction sources for the session + pub sources: Vec, +} + +/// Indicates whether fleet mode was successfully activated. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFleetStartResult { + /// Whether fleet mode was successfully activated + pub started: bool, +} + +/// Agents available to the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentListResult { + /// Available agents + pub agents: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentGetCurrentParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The currently selected custom agent, or null when using the default agent. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentGetCurrentResult { + /// Currently selected custom agent, or null if using the default agent + pub agent: AgentInfo, +} + +/// The newly selected custom agent. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentSelectResult { + /// The newly selected custom agent + pub agent: AgentInfo, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentDeselectParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentReloadParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Custom agents available to the session after reloading definitions from disk. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAgentReloadResult { + /// Reloaded custom agents + pub agents: Vec, +} + +/// Identifier assigned to the newly started background agent task. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksStartAgentResult { + /// Generated agent ID for the background task + pub agent_id: String, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Background tasks currently tracked by the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksListResult { + /// Currently tracked tasks + pub tasks: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksRefreshParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksRefreshResult {} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksWaitForPendingParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksWaitForPendingResult {} + +/// Progress information for the task, or null when no task with that ID is tracked. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksGetProgressResult { + /// Progress information for the task, discriminated by type. Returns null when no task with this ID is currently tracked. + pub progress: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksGetCurrentPromotableParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The first sync-waiting task that can currently be promoted to background mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksGetCurrentPromotableResult { + /// The first sync-waiting task (agent first, then shell) that can currently be promoted to background mode. Omitted if no such task exists. The returned task is guaranteed to have executionMode='sync' and canPromoteToBackground=true at the time of the call. + #[serde(skip_serializing_if = "Option::is_none")] + pub task: Option, +} + +/// Indicates whether the task was successfully promoted to background mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksPromoteToBackgroundResult { + /// Whether the task was successfully promoted to background mode + pub promoted: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksPromoteCurrentToBackgroundParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksPromoteCurrentToBackgroundResult { + /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. Atomic operation: avoids the race window of getCurrentPromotable + promoteToBackground. + #[serde(skip_serializing_if = "Option::is_none")] + pub task: Option, +} + +/// Indicates whether the background task was successfully cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksCancelResult { + /// Whether the task was successfully cancelled + pub cancelled: bool, +} + +/// Indicates whether the task was removed. False when the task does not exist or is still running/idle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksRemoveResult { + /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first). + pub removed: bool, +} + +/// Indicates whether the message was delivered, with an error message when delivery failed. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTasksSendMessageResult { + /// Error message if delivery failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Whether the message was successfully delivered or steered + pub sent: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Skills available to the session, with their enabled state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsListResult { + /// Available skills + pub skills: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsGetInvokedParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Skills invoked during this session, ordered by invocation time (most recent last). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsGetInvokedResult { + /// Skills invoked during this session, ordered by invocation time (most recent last) + pub skills: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsReloadParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsReloadResult { + /// Errors emitted while loading skills (e.g. skills that failed to load entirely) + pub errors: Vec, + /// Warnings emitted while loading skills (e.g. skills that loaded but had issues) + pub warnings: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSkillsEnsureLoadedParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// MCP servers configured for the session, with their connection status and host-level state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpListResult { + /// Host-level state, omitted when no MCP host is initialized. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + /// Configured MCP servers + pub servers: Vec, +} + +/// Tools exposed by the connected MCP server. Throws when the server is not connected. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpListToolsResult { + /// Tools exposed by the server. + pub tools: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpReloadParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// MCP server startup filtering result. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpReloadWithConfigResult { + /// Non-default servers allowed by policy + #[serde(skip_serializing_if = "Option::is_none")] + pub allowed_servers: Option>, + /// Servers filtered out before startup + pub filtered_servers: Vec, +} + +/// Outcome of an MCP sampling execution: success result, failure error, or cancellation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpExecuteSamplingResult { + /// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. + pub action: McpSamplingExecutionAction, + /// Error description, present when action='failure'. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option, +} + +/// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpCancelSamplingExecutionResult { + /// True if an in-flight execution with the given requestId was found and signalled to cancel. False when no such execution is in flight (already completed, never started, or cancelled by another caller). + pub cancelled: bool, +} + +/// Env-value mode recorded on the session after the update. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpSetEnvValueModeResult { + /// Mode recorded on the session after the update + pub mode: McpSetEnvValueModeDetails, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpRemoveGitHubParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpRemoveGitHubResult { + /// True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered). + pub removed: bool, +} + +/// Result of configuring GitHub MCP. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpConfigureGitHubResult { + /// Whether GitHub MCP configuration changed. + pub changed: bool, +} + +/// Whether the named MCP server is running. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpIsServerRunningResult { + /// True if the server has an active client and transport. + pub running: bool, +} + +/// Indicates whether the pending MCP OAuth response was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpOauthHandlePendingRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, +} + +/// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpOauthLoginResult { + /// 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. + #[serde(skip_serializing_if = "Option::is_none")] + pub authorization_url: Option, +} + +/// Indicates whether the pending MCP OAuth response was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpOauthRespondResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, +} + +/// Indicates whether the pending MCP headers refresh response was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpHeadersHandlePendingHeadersRefreshRequestResult { + /// Whether the response was accepted. False if the request was unknown, timed out, or already resolved. + pub success: bool, +} + +/// Resource contents returned by the MCP server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpAppsReadResourceResult { + /// Resource contents returned by the server + pub contents: Vec, +} + +/// App-callable tools from the named MCP server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpAppsListToolsResult { + /// App-callable tools from the server + pub tools: Vec>, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpAppsGetHostContextParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Current host context advertised to MCP App guests. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpAppsGetHostContextResult { + /// Current host context + pub context: McpAppsHostContextDetails, +} + +/// Diagnostic snapshot of MCP Apps wiring for the named server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpAppsDiagnoseResult { + /// Capability negotiation snapshot + pub capability: McpAppsDiagnoseCapability, + /// What the server returned for this session + pub server: McpAppsDiagnoseServer, +} + +/// Resource contents returned by the MCP server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpResourcesReadResult { + /// Resource contents returned by the server + pub contents: Vec, +} + +/// One page of resources advertised by the named MCP server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpResourcesListResult { + /// Opaque cursor for the next page, if the server has more resources + #[serde(skip_serializing_if = "Option::is_none")] + pub next_cursor: Option, + /// Resources advertised by the server (proxied MCP `resources/list`) + pub resources: Vec, +} + +/// One page of resource templates advertised by the named MCP server. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMcpResourcesListTemplatesResult { + /// Opaque cursor for the next page, if the server has more resource templates + #[serde(skip_serializing_if = "Option::is_none")] + pub next_cursor: Option, + /// Resource templates advertised by the server (proxied MCP `resources/templates/list`) + pub resource_templates: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPluginsListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Plugins installed for the session, with their enabled state and version metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPluginsListResult { + /// Installed plugins + pub plugins: Vec, +} + +/// A snapshot of the provider endpoint the session is currently configured to talk to. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionProviderGetEndpointResult { + /// A credential the caller should use with this endpoint. Omitted only when the endpoint accepts unauthenticated requests. + #[serde(skip_serializing_if = "Option::is_none")] + pub api_key: Option, + /// Base URL to pass to the LLM client library. + pub base_url: String, + /// HTTP headers the caller must include on every outbound request. + pub headers: HashMap, + /// Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present. Omitted when the endpoint does not require one. + #[serde(skip_serializing_if = "Option::is_none")] + pub session_token: Option, + /// Transport to be used for provider requests. + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, + /// Provider family. Matches the `type` field of a BYOK provider config. + pub r#type: ProviderEndpointType, + /// Wire API to be used, when required for the provider type. + #[serde(skip_serializing_if = "Option::is_none")] + pub wire_api: Option, +} + +/// The selectable model entries synthesized for the models added by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionProviderAddResult { + /// Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added. + pub models: Vec, +} + +/// Indicates whether the session options patch was applied successfully. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionOptionsUpdateResult { + /// Number of hooks loaded from installed plugins, returned when installedPlugins is updated + #[serde(skip_serializing_if = "Option::is_none")] + pub plugin_hook_count: Option, + /// Whether the operation succeeded + pub success: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionExtensionsListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Extensions discovered for the session, with their current status. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionExtensionsListResult { + /// Discovered extensions and their current status + pub extensions: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionExtensionsReloadParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether the external tool call result was handled successfully. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsHandlePendingToolCallResult { + /// Whether the tool call result was handled successfully + pub success: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsInitializeAndValidateParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsInitializeAndValidateResult {} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsGetCurrentMetadataParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Current lightweight tool metadata snapshot for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsGetCurrentMetadataResult { + /// Current tool metadata, or null when tools have not been initialized yet + pub tools: Option>, +} + +/// Empty result after applying subagent settings +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionToolsUpdateSubagentSettingsResult {} + +/// Slash commands available in the session, after applying any include/exclude filters. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCommandsListResult { + /// Commands available in this session + pub commands: Vec, +} + +/// Indicates whether the pending client-handled command was completed successfully. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCommandsHandlePendingCommandResult { + /// Whether the command was handled successfully + pub success: bool, +} + +/// Error message produced while executing the command, if any. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCommandsExecuteResult { + /// Error message produced while executing the command, if any. Omitted when the handler succeeded. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Indicates whether the command was accepted into the local execution queue. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCommandsEnqueueResult { + /// True when the command was accepted into the local execution queue. False when the call targets a session that does not support local command queueing (e.g. remote sessions). + pub queued: bool, +} + +/// Indicates whether the queued-command response was matched to a pending request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCommandsRespondToQueuedCommandResult { + /// Whether a pending queued command with the given request ID was found and resolved. False when the request was already resolved, cancelled, or unknown. + pub success: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTelemetryGetEngagementIdParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Telemetry engagement ID for the session, when available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTelemetryGetEngagementIdResult { + /// Current telemetry engagement ID, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub engagement_id: Option, +} + +/// Transient answer generated from current conversation context. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiEphemeralQueryResult { + /// Full assistant response text. + pub answer: String, +} + +/// The elicitation response (accept with form values, decline, or cancel) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiElicitationResult { + /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed) + pub action: UIElicitationResponseAction, + /// The form values submitted by the user (present when action is 'accept') + #[serde(skip_serializing_if = "Option::is_none")] + pub content: Option>, +} + +/// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingElicitationResult { + /// Whether the response was accepted. False if the request was already resolved by another client. + pub success: bool, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingUserInputResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingSamplingResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingAutoModeSwitchResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingSessionLimitsExhaustedResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Indicates whether the pending UI request was resolved by this call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiHandlePendingExitPlanModeResult { + /// True if the request was still pending and was resolved by this call. False if the request ID was unknown, already resolved by another client (e.g. GitHub), expired, or otherwise no longer pending. + pub success: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiRegisterDirectAutoModeSwitchHandlerParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiRegisterDirectAutoModeSwitchHandlerResult { + /// Opaque handle representing the registration. Pass this same handle to `unregisterDirectAutoModeSwitchHandler` when the in-process handler is no longer active. Multiple registrations are reference-counted; the server bridge will only dispatch auto-mode-switch requests when no handles are active. + pub handle: String, +} + +/// Indicates whether the handle was active and the registration count was decremented. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUiUnregisterDirectAutoModeSwitchHandlerResult { + /// True if the handle was active and decremented the counter; false if the handle was unknown. + pub unregistered: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsConfigureResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the permission decision was applied; false when the request was already resolved. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsHandlePendingPermissionRequestResult { + /// Whether the permission request was handled successfully + pub success: bool, +} + +/// List of pending permission requests reconstructed from event history. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPendingRequestsResult { + /// Pending permission prompts reconstructed from the session's event history. Equivalent to the set of `permission.requested` events that have not yet been followed by a matching `permission.completed` event. Used by clients (e.g. the CLI) to hydrate UI for prompts that were emitted before the client attached to the session. + pub items: Vec, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsSetApproveAllResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded and reports the post-mutation state. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsSetAllowAllResult { + /// Authoritative full allow-all state after the mutation + pub enabled: bool, + /// Authoritative allow-all mode after the mutation + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// Whether the operation succeeded + pub success: bool, +} + +/// Current allow-all permission mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsGetAllowAllResult { + /// Whether full allow-all permissions are currently active + pub enabled: bool, + /// Current allow-all mode + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsModifyRulesResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsSetRequiredResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsResetSessionApprovalsResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsNotifyPromptShownResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Snapshot of the session's allow-listed directories and primary working directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPathsListResult { + /// All directories currently allowed for tool access on this session. + pub directories: Vec, + /// The primary working directory for this session. + pub primary: String, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPathsAddResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPathsUpdatePrimaryResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the supplied path is within the session's allowed directories. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult { + /// Whether the path is within the session's allowed directories + pub allowed: bool, +} + +/// Indicates whether the supplied path is within the session's workspace directory. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsPathsIsPathWithinWorkspaceResult { + /// Whether the path is within the session workspace directory + pub allowed: bool, +} + +/// Resolved location-permissions key and type. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsLocationsResolveResult { + /// Location key used in the location-permissions store + pub location_key: String, + /// Whether the location is a git repo or directory + pub location_type: PermissionLocationType, +} + +/// Summary of persisted location permissions applied to the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsLocationsApplyResult { + /// Number of persisted allowed directories added to the live path manager + pub applied_directory_count: i64, + /// Number of location-scoped rules added to the live permission service + pub applied_rule_count: i64, + /// Location-scoped rules applied to the live permission service + pub applied_rules: Vec, + /// Whether a different location was applied since the previous apply call + pub changed: bool, + /// Location key used in the location-permissions store + pub location_key: String, + /// Whether the location is a git repo or directory + pub location_type: PermissionLocationType, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsLocationsAddToolApprovalResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Folder trust check result. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsFolderTrustIsTrustedResult { + /// Whether the folder is trusted + pub trusted: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsFolderTrustAddTrustedResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionPermissionsUrlsSetUnrestrictedModeResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Identifier of the session event that was emitted for the log message. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLogResult { + /// The unique identifier of the emitted session event + pub event_id: String, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataSnapshotParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Public-facing projection of workspace metadata for SDK / TUI consumers +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataSnapshotResultWorkspace { + /// Branch checked out at session start, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub branch: Option, + /// ISO 8601 timestamp when the workspace was created + #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")] + pub created_at: Option, + /// Current working directory at session start + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Resolved git root for cwd, if any + #[serde(rename = "git_root", skip_serializing_if = "Option::is_none")] + pub git_root: Option, + /// Repository host type, if known + #[serde(rename = "host_type", skip_serializing_if = "Option::is_none")] + pub host_type: Option, + /// Workspace identifier (1:1 with sessionId) + pub id: String, + /// Display name for the session, if set + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Repository identifier in 'owner/repo' or 'org/project/repo' format, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub repository: Option, + /// ISO 8601 timestamp when the workspace was last updated + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, + /// Whether the display name was explicitly set by the user + #[serde(rename = "user_named", skip_serializing_if = "Option::is_none")] + pub user_named: Option, +} + +/// Point-in-time snapshot of slow-changing session identifier and state fields +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataSnapshotResult { + /// True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions. + pub already_in_use: bool, + /// Runtime client name associated with the session (telemetry identifier). + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + /// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') + pub current_mode: MetadataSnapshotCurrentMode, + /// User-provided name supplied at session construction (via `--name`), if any. Immutable after construction. + #[serde(skip_serializing_if = "Option::is_none")] + pub initial_name: Option, + /// Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process) + pub is_remote: bool, + /// ISO 8601 timestamp of when the session's persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction. + pub modified_time: String, + /// Remote-session-specific metadata. Populated only when `isRemote` is true. Fields are immutable for the lifetime of the session. + #[serde(skip_serializing_if = "Option::is_none")] + pub remote_metadata: Option, + /// Currently selected model identifier, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub selected_model: Option, + /// The unique identifier of the session + pub session_id: SessionId, + /// Current session limits, or null when no limits are active + pub session_limits: Option, + /// ISO 8601 timestamp of when the session started + pub start_time: String, + /// Short human-readable summary of the session, if known. Omitted when no summary has been generated. + #[serde(skip_serializing_if = "Option::is_none")] + pub summary: Option, + /// Absolute path to the session's current working directory + pub working_directory: String, + /// Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags). + pub workspace: Option, + /// Absolute path to the session's workspace directory on disk, or null if the session has no associated workspace + pub workspace_path: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataIsProcessingParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether the local session is currently processing a turn or background continuation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataIsProcessingResult { + /// Whether the session is currently processing user/agent messages. False for non-local sessions (which don't run a local agentic loop). Reflects an in-flight turn or background continuation. + pub processing: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataActivityParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Current activity flags for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataActivityResult { + /// Whether an in-flight operation can currently be aborted. + pub abortable: bool, + /// Whether the session currently has active work, including running turns or tasks. + pub has_active_work: bool, +} + +/// Token-usage breakdown for the session's current context window +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataContextInfoResultContextInfo { + /// Output reserve plus tokens after the buffer-exhaustion blocking threshold (default 95%) + pub buffer_tokens: i64, + /// Token count at which background compaction starts (configurable percentage of promptTokenLimit) + pub compaction_threshold: i64, + /// Tokens consumed by user/assistant/tool messages + pub conversation_tokens: i64, + /// Prompt token limit plus the model's full output token limit. + pub limit: i64, + /// Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools) + pub mcp_tools_tokens: i64, + /// The model used for token counting + pub model_name: String, + /// Maximum prompt tokens allowed by the model (or DEFAULT_TOKEN_LIMIT if unspecified) + pub prompt_token_limit: i64, + /// Tokens consumed by the system prompt + pub system_tokens: i64, + /// Tokens consumed by tool definitions sent to the model (excludes deferred tools) + pub tool_definitions_tokens: i64, + /// Sum of system, conversation and tool-definition tokens + pub total_tokens: i64, +} + +/// Token breakdown for the session's current context window, or null if uninitialized. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataContextInfoResult { + /// Token breakdown for the current context window, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + pub context_info: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionResultContextAttributionCategories { + /// Output reserve plus post-blocking-threshold buffer. + pub buffer: i64, + /// Custom-instructions tokens (0 when none are configured). + pub custom_instructions: i64, + /// Remaining unused window capacity (clamped at 0). + pub free_space: i64, + /// MCP tool-definition tokens. + pub mcp_tools: i64, + /// Conversation (user/assistant/tool) message tokens. + pub messages: i64, + /// System prompt tokens, excluding custom instructions. + pub system_prompt: i64, + /// Non-MCP tool-definition tokens. + pub system_tools: i64, +} + +/// Successful compaction history for the session. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionResultContextAttributionCompactions { + /// Number of successful compactions in this session. + pub count: i64, +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionResultContextAttributionEntriesItem { + /// Supplementary per-entry metadata (e.g. `messageCount`, `role`, `evictable`, `pluginSource`). Values are stringified; parse as needed and ignore unrecognized keys. + #[serde(skip_serializing_if = "Option::is_none")] + pub attributes: Option>, + /// Identifier for this entry, formed by joining its `kind` and source name (e.g. `tool:bash`, `skill:tmux`, `toolDefinition:bash`); unique within the snapshot. Use it to match the same entry across snapshots, to correlate with other APIs (skill/agent/MCP registries), and as the `parentId` target for nesting. Distinct from the human-facing `label`. + pub id: String, + /// Source category for this entry. Not a closed set — tolerate unknown values. Known values today: `skill`, `subagent`, `mcpServer`, `tool`, `system`, `toolDefinition`, `plugin`. + pub kind: String, + /// Human-readable display label, e.g. `bash` or `skill: tmux`. Presentation-only; may be localized/reformatted without notice — do not key off it. + pub label: String, + /// Optional `id` of the parent entry: e.g. a `plugin` entry parenting its `skill`/`mcpServer` entries, or the `system` entry parenting `toolDefinition` entries. Omitted for top-level entries. + #[serde(skip_serializing_if = "Option::is_none")] + pub parent_id: Option, + /// Token count currently in context attributable to this entry. + pub tokens: i64, +} + +/// Per-source token attribution snapshot for the current context window. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionResultContextAttribution { + /// Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`. + pub buffer_tokens: i64, + /// The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`. + pub categories: SessionMetadataGetContextAttributionResultContextAttributionCategories, + /// Successful compaction history for the session. + pub compactions: SessionMetadataGetContextAttributionResultContextAttributionCompactions, + /// Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`. + pub compaction_threshold: i64, + /// Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`. + pub entries: Vec, + /// Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`. + pub limit: i64, + /// The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session. + pub model_id: String, + /// How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known). + pub model_source: String, + /// Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`. + pub prompt_token_limit: i64, + /// Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share. + pub total_tokens: i64, +} + +/// Per-source attribution breakdown for the session's current context window, or null if uninitialized. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextAttributionResult { + /// Per-source context-window attribution, or null if the session has not yet been initialized (no system prompt or tool metadata cached). + pub context_attribution: Option, +} + +/// The heaviest individual messages in the session's context window, most-expensive first. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataGetContextHeaviestMessagesResult { + /// Heaviest messages, most-expensive first. + pub messages: Vec, + /// Total token count of the current context window, so callers can compute each message's share without a second call. + pub total_tokens: i64, +} + +/// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataRecordContextChangeResult {} + +/// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataSetWorkingDirectoryResult { + /// Working directory after the update + pub working_directory: String, +} + +/// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionMetadataRecomputeContextTokensResult { + /// Tokens contributed by user/assistant/tool messages (excludes system/developer prompts). + pub messages_token_count: i64, + /// Tokens contributed by system/developer prompt snapshots. + pub system_token_count: i64, + /// Sum of tokens across chat-context and system-context messages currently held by the session. + pub total_tokens: i64, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsSnapshotParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSettingsSnapshotResult { + #[serde(skip_serializing_if = "Option::is_none")] + pub client_name: Option, + pub job: SessionSettingsJobSnapshot, + pub model: SessionSettingsModelSnapshot, + pub online_evaluation: SessionSettingsOnlineEvaluationSnapshot, + pub repo: SessionSettingsRepoSnapshot, + #[serde(skip_serializing_if = "Option::is_none")] + pub start_time_ms: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_ms: Option, + pub validation: SessionSettingsValidationSnapshot, + #[serde(skip_serializing_if = "Option::is_none")] + pub version: Option, +} + +/// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionContentExclusionCheckPathsResult { + /// Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded. + pub available: bool, + /// Per-path decisions in request order. Empty when available is false. + pub checks: Vec, +} + +/// Identifier of the spawned process, used to correlate streamed output and exit notifications. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionShellExecResult { + /// Unique identifier for tracking streamed output + pub process_id: String, +} + +/// Indicates whether the signal was delivered; false if the process was unknown or already exited. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionShellKillResult { + /// Whether the signal was sent successfully + pub killed: bool, +} + +/// Result of a user-requested shell command. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionShellExecuteUserRequestedResult { + /// Error output when the execution failed + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Process exit code, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub exit_code: Option, + /// Captured command output + pub output: String, + /// Whether the command completed successfully + pub success: bool, + /// Tool call id emitted for the shell execution + pub tool_call_id: String, +} + +/// Cancellation result for a user-requested shell command. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionShellCancelUserRequestedResult { + /// Whether an in-flight execution was found and signalled to cancel + pub cancelled: bool, +} + +/// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryCompactResult { + /// Post-compaction context window usage breakdown + #[serde(skip_serializing_if = "Option::is_none")] + pub context_window: Option, + /// Number of messages removed during compaction + pub messages_removed: i64, + /// Whether compaction completed successfully + pub success: bool, + /// Summary text produced by compaction. Omitted when compaction did not produce a summary (e.g. failure path). + #[serde(skip_serializing_if = "Option::is_none")] + pub summary_content: Option, + /// Number of tokens freed by compaction + pub tokens_removed: i64, +} + +/// Number of events that were removed by the truncation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryTruncateResult { + /// Failure detail when checkpointCleanupFailed is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub checkpoint_cleanup_error: Option, + /// True when conversation truncation succeeded but post-truncation workspace checkpoint cleanup failed. History is already truncated; callers may still prune snapshots but should report a checkpoint-cleanup rather than a truncation failure. + #[serde(skip_serializing_if = "Option::is_none")] + pub checkpoint_cleanup_failed: Option, + /// Number of events that were removed + pub events_removed: i64, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryListRewindPointsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Rewind points and file-change-tracking availability for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryListRewindPointsResult { + /// Whether this session captured file changes from its first turn. + pub file_change_tracking_enabled: bool, + /// Root user turns in chronological order. Empty when `unavailableReason` is set. + pub points: Vec, + /// Why the listed points could not be produced, when applicable; the points list is empty whenever it is set. `unsupported-remote-session` is permanent for the session and comes with `fileChangeTrackingEnabled: false`. `session-busy` is transient and only ever reported by a session that *is* tracking (`fileChangeTrackingEnabled: true`), because the file-change captures cannot be read while work that may still mutate them is in flight; the same request succeeds once the session settles, so a client that wants points should retry rather than treat it as a failure. It is never `file-change-tracking-disabled`: an untracked local session still lists conversation-only points and reports that through `fileChangeTrackingEnabled: false`. + #[serde(skip_serializing_if = "Option::is_none")] + pub unavailable_reason: Option, +} + +/// Files and aggregate changes for a prospective rewind. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryPreviewRewindResult { + /// Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false. + pub available: bool, + /// Number of unique files in the preview. + pub file_count: i64, + /// Files ordered by path. + pub files: Vec, + /// Why file restore is unavailable, when applicable. Populated only when `available` is false and never set when `available` is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, +} + +/// Structured outcome of a rewind request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryRewindResult { + /// Failure detail. Set only for the failure and partial-failure outcomes (`files-rolled-back`, `rollback-incomplete`, `truncation-failed`, `checkpoint-cleanup-failed`, `snapshot-prune-failed`); omitted for `success` and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`). + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Number of persisted events removed by conversation truncation. Present only when truncation succeeded (outcomes `success`, `checkpoint-cleanup-failed`, and `snapshot-prune-failed`); omitted for every unavailable outcome (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`) and for `truncation-failed`, `files-rolled-back`, and `rollback-incomplete`. + #[serde(skip_serializing_if = "Option::is_none")] + pub events_removed: Option, + /// Overall rewind outcome. This discriminates the result: it governs which of the remaining fields are populated, so consumers must switch on it before reading `eventsRemoved`, `restoredFiles`, `skippedFiles`, or `error`. See each field for the outcomes that populate it. + pub outcome: HistoryRewindOutcome, + /// Absolute paths restored to their captured preimages. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + pub restored_files: Vec, + /// Captured files intentionally left unchanged. Always empty for conversation-only rewinds and for the unavailable outcomes (`session-busy`, `file-change-tracking-disabled`, `unsupported-remote-session`); only conversation-and-files outcomes that reached the file-restore stage populate it. + pub skipped_files: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryCancelBackgroundCompactionParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether an in-progress background compaction was cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryCancelBackgroundCompactionResult { + /// Whether an in-progress background compaction was cancelled. False when no compaction was running, when the session is remote, or when the underlying processor was unavailable. + pub cancelled: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryAbortManualCompactionParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether an in-progress manual compaction was aborted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryAbortManualCompactionResult { + /// Whether an in-progress manual compaction was aborted. False when no manual compaction was running, when its abort controller was already aborted, or when the session is remote. + pub aborted: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistorySummarizeForHandoffParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Markdown summary of the conversation context (empty when not available). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistorySummarizeForHandoffResult { + /// Markdown summary of the conversation context produced by an LLM. Empty string when there are no messages or when the session does not support local summarization. + pub summary: String, +} + +/// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionHistoryClearContextResult { + /// Number of non-system, non-developer messages that were removed from the conversation. Zero only when the window already held no conversation. + pub messages_cleared: i64, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueuePendingItemsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Snapshot of the session's pending queued items and immediate-steering messages. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueuePendingItemsResult { + /// Pending queued items in submission order. Includes user messages, queued slash commands, and queued model changes; omits internal system items. + pub items: Vec, + /// Display text for messages currently in the immediate steering queue (interjections sent during a running turn). + pub steering_messages: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueSnapshotParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Internal snapshot of native queue state for local session orchestration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueSnapshotResult { + /// Insertion orders for queued items, aligned with `items`. + #[serde(skip_serializing_if = "Option::is_none")] + pub item_orders: Option>, + /// User-facing pending items in FIFO order. + pub items: Vec, + /// Insertion orders for immediate steering messages, aligned with `steeringMessages`. + #[serde(skip_serializing_if = "Option::is_none")] + pub steering_message_orders: Option>, + /// Immediate steering messages waiting for an active turn. + pub steering_messages: Vec, +} + +/// Result of moving a queued item. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueMoveItemResult { + /// True when the item changed position; false when it was already at the requested position. + pub changed: bool, +} + +/// Result of inserting a queued message. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueInsertAtResult { + /// Fresh stable opaque id assigned to the inserted item. + pub id: String, +} + +/// Result of removing a queued item. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueRemoveAtResult { + /// True when the addressed item was removed. + pub removed: bool, +} + +/// Result of editing a queued message. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueUpdateTextResult { + /// True when the stored text changed. + pub updated: bool, +} + +/// Result of duplicating a queued item. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueDuplicateAtResult { + /// Fresh stable opaque id assigned to the duplicate. + pub id: String, +} + +/// Result of trying to steer a queued message into a live turn. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueSendNowResult { + /// True when the item was accepted into the steering lane; false when no main turn was live. + pub steered: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueHasPendingParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Whether the native queue has pending work. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueHasPendingResult { + /// True when queued or immediate native work is pending. + pub has_pending: bool, +} + +/// Whether a deferred-idle drain should run. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueBeginDeferredIdleDrainResult { + /// True when the host should run finishDeferredIdleDrain asynchronously. + pub should_drain: bool, +} + +/// Action selected by the native deferred-idle drain. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueFinishDeferredIdleDrainResult { + /// Whether the deferred idle was caused by an aborted foreground turn. + pub aborted: bool, + /// One of none, processQueue, or emitSessionIdle. + pub action: String, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueRemoveMostRecentParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether a user-facing pending item was removed. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueRemoveMostRecentResult { + /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + pub removed: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueClearParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Indicates whether a user-facing pending item was removed. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueConsumeSystemNotificationsResult { + /// True if a user-facing pending item was removed (LIFO across both queues); false when no removable items remained. + pub removed: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueEnqueueResumePendingParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Result of enqueueing the resume-pending wake item. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueEnqueueResumePendingResult { + /// True when a wake item was newly queued. + pub queued: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionQueueProcessParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Batch of session events returned by a read, with cursor and continuation metadata. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionEventLogReadResult { + /// Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing `direction: backward` with it (the cursor is also self-describing, so backward paging continues correctly). + pub cursor: String, + /// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history. For a forward read the fallback starts from the beginning of the remaining history; for a backward read it falls back to the tail (the newest window). Because the fallback page is a fresh boundary snapshot rather than a continuation of the requested cursor, it may overlap events the consumer has already rendered — a backward fallback to the tail in particular can repeat the newest window. On 'expired', consumers should reset or rebase their local pagination state (or deduplicate by event id) before continuing from the returned cursor rather than blindly appending/prepending the fallback page. + pub cursor_status: EventsCursorStatus, + /// Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set `includeEphemeral: false` to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero `waitMs`. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order. + pub events: Vec, + /// True when more events are available in the read's direction. For a forward read, true means the batch returned `max` events and more are available immediately. For a backward read, true means older persisted events remain before the returned window. + pub has_more: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionEventLogTailParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionEventLogTailResult { + /// Opaque cursor pointing at the current tail of the session's persisted-events history. Pass back to `read` to receive only events that arrive AFTER this snapshot. When the session has no events, this returns the same sentinel as an unset cursor (i.e. equivalent to omitting the cursor on a first read). + pub cursor: String, +} + +/// Opaque handle representing an event-type interest registration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionEventLogRegisterInterestResult { + /// Opaque handle for this registration. Pass to releaseInterest to release. Each call to registerInterest produces a fresh handle, even when the same eventType is registered multiple times. + pub handle: String, +} + +/// Indicates whether the operation succeeded. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionEventLogReleaseInterestResult { + /// Whether the operation succeeded + pub success: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUsageGetMetricsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUsageGetMetricsResult { + /// Aggregated code change metrics + pub code_changes: UsageMetricsCodeChanges, + /// Currently active model identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub current_model: Option, + /// Input tokens from the most recent main-agent API call + pub last_call_input_tokens: i64, + /// Output tokens from the most recent main-agent API call + pub last_call_output_tokens: i64, + /// Per-model token and request metrics, keyed by model identifier + pub model_metrics: HashMap, + /// ISO 8601 timestamp when the session started + pub session_start_time: String, + /// Session-wide per-token-type accumulated token counts + #[serde(skip_serializing_if = "Option::is_none")] + pub token_details: Option>, + /// Total time spent in model API calls (milliseconds) + pub total_api_duration_ms: i64, + /// Session-wide accumulated nano-AI units cost + #[serde(skip_serializing_if = "Option::is_none")] + pub total_nano_aiu: Option, + /// Total user-initiated premium request cost across all models (may be fractional due to multipliers) + pub total_premium_request_cost: f64, + /// Raw count of user-initiated API requests + pub total_user_requests: i64, +} + +/// GitHub URL for the session and a flag indicating whether remote steering is enabled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionRemoteEnableResult { + /// Whether remote steering is enabled + pub remote_steerable: bool, + /// GitHub frontend URL for this session + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionRemoteDisableParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionRemoteNotifySteerableChangedResult {} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionVisibilityGetParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Current sharing status and shareable GitHub URL for a session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionVisibilityGetResult { + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + #[serde(skip_serializing_if = "Option::is_none")] + pub share_url: Option, + /// Current sharing status. Absent when the session is not synced or the status could not be retrieved (e.g. the user is not authenticated). + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent. + pub synced: bool, +} + +/// Effective sharing status and shareable GitHub URL after updating session visibility. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionVisibilitySetResult { + /// Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved. + #[serde(skip_serializing_if = "Option::is_none")] + pub share_url: Option, + /// Effective sharing status after the update. May differ from the requested status for task types that are already visible to repository readers by default. Absent when the update could not be applied (e.g. the session is not synced or the user is not authenticated). + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent. + pub synced: bool, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleListParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Snapshot of the currently active recurring prompts for this session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleListResult { + /// Active scheduled prompts, ordered by id. + pub entries: Vec, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleHydrateParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleHasSelfPacedParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Whether the session currently has an active self-paced schedule. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleHasSelfPacedResult { + /// True when at least one active schedule is self-paced. + pub has_self_paced: bool, +} + +/// Result of registering or re-arming a scheduled prompt. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleAddResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Result of registering or re-arming a scheduled prompt. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleAddCronResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Result of registering or re-arming a scheduled prompt. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleAddAtResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Result of registering or re-arming a scheduled prompt. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleAddSelfPacedResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Result of registering or re-arming a scheduled prompt. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleRearmSelfPacedResult { + /// The registered or updated schedule entry. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, + /// User-facing validation error, when registration failed. + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, +} + +/// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleStopResult { + /// The removed entry, or omitted if no entry matched. + #[serde(skip_serializing_if = "Option::is_none")] + pub entry: Option, +} + +/// A bearer token supplied by the SDK client for a BYOK provider. The runtime sets it as `Authorization: Bearer ` on the outbound request and does no caching; the SDK consumer owns token caching and refresh. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ProviderTokenGetTokenResult { + /// The bearer token value (without the `Bearer ` prefix). + pub token: String, +} + +/// Acknowledgement that a factory request was accepted. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FactoryAbortResult {} + +/// Identifies the target session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionFsSqliteExistsParams { + /// Target session identifier + pub session_id: SessionId, +} + +/// Canvas open result returned by the provider. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CanvasOpenResult { + /// Provider-supplied status text + #[serde(skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Provider-supplied title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL for web-rendered canvases + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +/// HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type LlmInferenceHeaders = HashMap>; + +/// MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'. Treated as opaque at the schema layer; consumers should construct/consume it per the MCP CreateMessageResult shape. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type McpExecuteSamplingResult = HashMap; + +/// The form values submitted by the user (present when action is 'accept') +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type UIElicitationResponseContent = HashMap; + +/// List of all authenticated users +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type AccountGetAllUsersResult = Vec; + +/// The number of running background agents (task-registry agents) that were cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type SessionCancelAllBackgroundAgentsResult = i64; + +/// Standard MCP CallToolResult +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +pub type SessionMcpAppsCallToolResult = HashMap; + +/// Resolved Anthropic adaptive-thinking capability for a model. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AdaptiveThinkingSupport { + /// The model does not accept thinking.type='adaptive' + #[serde(rename = "unsupported")] + Unsupported, + /// The model accepts adaptive thinking but also accepts thinking.type='enabled' + #[serde(rename = "optional")] + Optional, + /// The model only accepts adaptive thinking and rejects thinking.type='enabled' with HTTP 400 (e.g. opus-4.7/4.8) + #[serde(rename = "required")] + Required, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Which tier this directory belongs to +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentDiscoveryPathScope { + /// The user's personal agent configuration directory. + #[serde(rename = "user")] + User, + /// A project's repository agent directory. + #[serde(rename = "project")] + Project, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Where the agent definition was loaded from +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentInfoSource { + /// Agent loaded from the user's personal agent configuration. + #[serde(rename = "user")] + User, + /// Agent loaded from the current project's repository configuration. + #[serde(rename = "project")] + Project, + /// Agent inherited from a parent project or workspace. + #[serde(rename = "inherited")] + Inherited, + /// Agent provided by a remote runtime or service. + #[serde(rename = "remote")] + Remote, + /// Agent contributed by an installed plugin. + #[serde(rename = "plugin")] + Plugin, + /// Agent built into the Copilot runtime. + #[serde(rename = "builtin")] + Builtin, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Kind of attention required when status === "attention". Meaningful only when status === "attention". +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistryLiveTargetEntryAttentionKind { + /// Session is blocked on an unrecoverable error + #[serde(rename = "error")] + Error, + /// Session is waiting for a tool-permission decision + #[serde(rename = "permission")] + Permission, + /// Session is waiting for the user to approve or reject a plan + #[serde(rename = "exit_plan")] + ExitPlan, + /// Session is waiting on an elicitation prompt + #[serde(rename = "elicitation")] + Elicitation, + /// Session is waiting for free-form user input + #[serde(rename = "user_input")] + UserInput, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Process kind tag for the registry entry +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistryLiveTargetEntryKind { + /// Interactive Copilot CLI exposing a UI server (legacy/normal CLI process) + #[serde(rename = "ui-server")] + UiServer, + /// Headless `--server --managed-server` child spawned by a controller + #[serde(rename = "managed-server")] + ManagedServer, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistryLiveTargetEntryLastTerminalEvent { + /// Last turn ended cleanly (model returned a final assistant message) + #[serde(rename = "turn_end")] + TurnEnd, + /// Last turn was aborted (e.g. user interrupted) + #[serde(rename = "abort")] + Abort, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Coarse lifecycle status of the foreground session +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistryLiveTargetEntryStatus { + /// Session is actively processing a turn + #[serde(rename = "working")] + Working, + /// Session is idle, waiting for input + #[serde(rename = "waiting")] + Waiting, + /// Last turn completed successfully + #[serde(rename = "done")] + Done, + /// Session needs user attention (see attentionKind for the specific reason) + #[serde(rename = "attention")] + Attention, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Categorized reason for log-open failure +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistryLogCaptureOpenErrorReason { + /// Filesystem permission denied opening the log file + #[serde(rename = "permission")] + Permission, + /// No space left on device + #[serde(rename = "disk_full")] + DiskFull, + /// Other / uncategorized open failure + #[serde(rename = "other")] + Other, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Discriminator: child_process.spawn itself failed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnErrorKind { + #[serde(rename = "spawn-error")] + #[default] + SpawnError, +} + +/// Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnPermissionMode { + /// Standard permission posture (prompts for each request) + #[serde(rename = "default")] + Default, + /// Full allow-all (requires the controller-local session to currently be in allow-all mode) #[serde(rename = "yolo")] Yolo, /// Unknown variant for forward compatibility. @@ -12882,23 +23972,1395 @@ pub enum AgentRegistrySpawnPermissionMode { Unknown, } -/// Discriminator: spawn succeeded but child never registered +/// Discriminator: spawn succeeded but child never registered +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnRegistryTimeoutKind { + #[serde(rename = "registry-timeout")] + #[default] + RegistryTimeout, +} + +/// Discriminator: managed-server child spawned successfully +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnSpawnedKind { + #[serde(rename = "spawned")] + #[default] + Spawned, +} + +/// Which parameter field was invalid. Omitted when the rejection is not field-specific. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnValidationErrorField { + /// The cwd parameter + #[serde(rename = "cwd")] + Cwd, + /// The session name parameter + #[serde(rename = "name")] + Name, + /// The agentName parameter + #[serde(rename = "agentName")] + AgentName, + /// The model parameter + #[serde(rename = "model")] + Model, + /// The permissionMode parameter + #[serde(rename = "permissionMode")] + PermissionMode, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Discriminator: synchronous pre-validation rejected the request +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnValidationErrorKind { + #[serde(rename = "validation-error")] + #[default] + ValidationError, +} + +/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AgentRegistrySpawnValidationErrorReason { + /// Provided cwd does not exist on disk + #[serde(rename = "cwd-not-found")] + CwdNotFound, + /// Provided cwd exists but is not a directory + #[serde(rename = "cwd-not-directory")] + CwdNotDirectory, + /// Session name failed validateSessionName + #[serde(rename = "invalid-name")] + InvalidName, + /// Requested agent name was not found in builtin or custom agents + #[serde(rename = "unknown-agent")] + UnknownAgent, + /// Requested model is not available to this session + #[serde(rename = "unknown-model")] + UnknownModel, + /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode + #[serde(rename = "yolo-not-allowed")] + YoloNotAllowed, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Outcome of an agentRegistry.spawn call. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AgentRegistrySpawnResult { + Spawned(AgentRegistrySpawnSpawned), + SpawnError(AgentRegistrySpawnError), + RegistryTimeout(AgentRegistrySpawnRegistryTimeout), + ValidationError(AgentRegistrySpawnValidationError), +} + +/// Current or requested allow-all mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsAllowAllMode { + /// Permission requests follow the normal approval flow. + #[serde(rename = "off")] + Off, + /// Tool, path, and URL permission requests are automatically approved. + #[serde(rename = "on")] + On, + /// Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + #[serde(rename = "auto")] + Auto, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ApiKeyAuthInfoType { + #[serde(rename = "api-key")] + #[default] + ApiKey, +} + +/// Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum OmittedBinaryOmittedReason { + /// Bytes exceeded the session's inline size limit. + #[serde(rename = "too_large")] + TooLarge, + /// The referenced binary asset could not be found (e.g. a truncated log). + #[serde(rename = "asset_unavailable")] + AssetUnavailable, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentBlobType { + #[serde(rename = "blob")] + #[default] + Blob, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentDirectoryType { + #[serde(rename = "directory")] + #[default] + Directory, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentExtensionContextType { + #[serde(rename = "extension_context")] + #[default] + ExtensionContext, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentFileType { + #[serde(rename = "file")] + #[default] + File, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubActionsJobType { + #[serde(rename = "github_actions_job")] + #[default] + GitHubActionsJob, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubCommitType { + #[serde(rename = "github_commit")] + #[default] + GitHubCommit, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubFileType { + #[serde(rename = "github_file")] + #[default] + GitHubFile, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubFileDiffType { + #[serde(rename = "github_file_diff")] + #[default] + GitHubFileDiff, +} + +/// Type of GitHub reference +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubReferenceType { + /// GitHub issue reference. + #[serde(rename = "issue")] + Issue, + /// GitHub pull request reference. + #[serde(rename = "pr")] + Pr, + /// GitHub discussion reference. + #[serde(rename = "discussion")] + Discussion, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubReleaseType { + #[serde(rename = "github_release")] + #[default] + GitHubRelease, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubRepositoryType { + #[serde(rename = "github_repository")] + #[default] + GitHubRepository, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubSnippetType { + #[serde(rename = "github_snippet")] + #[default] + GitHubSnippet, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubTreeComparisonType { + #[serde(rename = "github_tree_comparison")] + #[default] + GitHubTreeComparison, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentGitHubUrlType { + #[serde(rename = "github_url")] + #[default] + GitHubUrl, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AttachmentSelectionType { + #[serde(rename = "selection")] + #[default] + Selection, +} + +/// Authentication type +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AuthInfoType { + /// Authentication provided by a GitHub App HMAC credential. + #[serde(rename = "hmac")] + Hmac, + /// Authentication resolved from environment-provided credentials. + #[serde(rename = "env")] + Env, + /// Authentication from an interactive user sign-in. + #[serde(rename = "user")] + User, + /// Authentication delegated to the GitHub CLI. + #[serde(rename = "gh-cli")] + GhCli, + /// Authentication from an API key credential. + #[serde(rename = "api-key")] + ApiKey, + /// Authentication from a GitHub token. + #[serde(rename = "token")] + Token, + /// Authentication from a Copilot API token. + #[serde(rename = "copilot-api-token")] + CopilotApiToken, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandInputCompletion { + /// Input should complete filesystem directories. + #[serde(rename = "directory")] + Directory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SlashCommandKind { + /// Command implemented by the runtime. + #[serde(rename = "builtin")] + Builtin, + /// Command backed by a skill. + #[serde(rename = "skill")] + Skill, + /// Command registered by an SDK client or extension. + #[serde(rename = "client")] + Client, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Neutral SDK discriminator for the connected remote session kind. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ConnectedRemoteSessionMetadataKind { + /// Remote CLI session. + #[serde(rename = "remote-session")] + RemoteSession, + /// GitHub Copilot coding agent session. + #[serde(rename = "coding-agent")] + CodingAgent, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Controls how MCP tool result content is filtered: none leaves content unchanged, markdown sanitizes HTML while preserving Markdown-friendly output, and hidden_characters removes characters that can hide directives. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ContentFilterMode { + /// Leave MCP tool result content unchanged. + #[serde(rename = "none")] + None, + /// Sanitize HTML while preserving Markdown-friendly output. + #[serde(rename = "markdown")] + Markdown, + /// Remove characters that can hide directives. + #[serde(rename = "hidden_characters")] + HiddenCharacters, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Authentication host (always the public GitHub host). +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CopilotApiTokenAuthInfoHost { + #[serde(rename = "https://github.com")] + #[default] + HttpsGitHubCom, +} + +/// Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CopilotApiTokenAuthInfoType { + #[serde(rename = "copilot-api-token")] + #[default] + CopilotApiToken, +} + +/// Source category for a collected debug bundle entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsSource { + /// Session event log. + #[serde(rename = "events")] + Events, + /// Process log for the session. + #[serde(rename = "process-log")] + ProcessLog, + /// Interactive shell log for the session. + #[serde(rename = "shell-log")] + ShellLog, + /// Caller-provided diagnostic entry. + #[serde(rename = "additional")] + Additional, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsDestinationArchiveKind { + #[serde(rename = "archive")] + #[default] + Archive, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsDestinationDirectoryKind { + #[serde(rename = "directory")] + #[default] + Directory, +} + +/// Destination for the redacted debug bundle. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DebugCollectLogsDestination { + Archive(DebugCollectLogsDestinationArchive), + Directory(DebugCollectLogsDestinationDirectory), +} + +/// Kind of caller-provided debug log entry. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsEntryKind { + /// Include a single server-local file. + #[serde(rename = "file")] + File, + /// Include files from a server-local directory recursively. + #[serde(rename = "directory")] + Directory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// How a collected debug entry should be redacted before being staged. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsRedaction { + /// Redact the file as plain UTF-8 log text. + #[serde(rename = "plain-text")] + PlainText, + /// Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. + #[serde(rename = "events-jsonl")] + EventsJsonl, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Destination kind that was written. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DebugCollectLogsResultKind { + /// A .tgz archive was written. + #[serde(rename = "archive")] + Archive, + /// A directory containing redacted files was written. + #[serde(rename = "directory")] + Directory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DisableBypassPermissionsMode { + #[serde(rename = "disable")] + Disable, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Persisted extension discovery source +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DiscoveredExtensionSource { + /// Extension discovered from the user's extensions directory. + #[serde(rename = "user")] + User, + /// Extension contributed by an installed plugin. + #[serde(rename = "plugin")] + Plugin, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Effective extension loading and agent-management mode +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DiscoveredExtensionMode { + /// Extensions are not loaded. + #[serde(rename = "disabled")] + Disabled, + /// Extensions are loaded, but the agent cannot create, reload, or manage them. + #[serde(rename = "load_only")] + LoadOnly, + /// Extensions are loaded and the agent can create, reload, and manage them. + #[serde(rename = "load_and_augment")] + LoadAndAugment, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Server transport type: stdio, http, sse (deprecated), or memory +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum DiscoveredMcpServerType { + /// Server communicates over stdio with a local child process. + #[serde(rename = "stdio")] + Stdio, + /// Server communicates over streamable HTTP. + #[serde(rename = "http")] + Http, + /// Server communicates over Server-Sent Events (deprecated). + #[serde(rename = "sse")] + Sse, + /// Server is backed by an in-memory runtime implementation. + #[serde(rename = "memory")] + Memory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Personal access token (PAT) or server-to-server token sourced from an environment variable. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum EnvAuthInfoType { + #[serde(rename = "env")] + #[default] + Env, +} + +/// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum EventsAgentScope { + /// Return main-agent events and typed subagent lifecycle events. + #[serde(rename = "primary")] + Primary, + /// Return events from all agents. + #[serde(rename = "all")] + All, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Direction to page through the session's persisted event history. 'forward' pages from the cursor toward newer events; 'backward' returns the newest window first (tail-first) and pages toward older events. Events within a returned batch are always chronological (oldest-to-newest), even for a backward read. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum EventsReadDirection { + /// Page from the cursor toward newer events (default). + #[serde(rename = "forward")] + Forward, + /// Tail-first: return the newest events and page toward older events. + #[serde(rename = "backward")] + Backward, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history (the beginning for a forward read, the tail for a backward read). The fallback page is a fresh boundary snapshot, not a continuation of the requested cursor, so it may overlap already-rendered events; on 'expired' a consumer should reset/rebase its pagination state (or deduplicate by event id) before continuing from the returned cursor. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum EventsCursorStatus { + /// The cursor was applied successfully. + #[serde(rename = "ok")] + Ok, + /// The cursor referred to history that is no longer available. + #[serde(rename = "expired")] + Expired, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExtensionSource { + /// Extension discovered from the current project's .github/extensions directory. + #[serde(rename = "project")] + Project, + /// Extension discovered from the user's ~/.copilot/extensions directory. + #[serde(rename = "user")] + User, + /// Extension contributed by an installed plugin. + #[serde(rename = "plugin")] + Plugin, + /// Extension discovered from the current session's state directory (loaded only for this session). + #[serde(rename = "session")] + Session, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Current status: running, disabled, failed, or starting +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExtensionStatus { + /// The extension process is running. + #[serde(rename = "running")] + Running, + /// The extension is installed but disabled. + #[serde(rename = "disabled")] + Disabled, + /// The extension failed to start or crashed. + #[serde(rename = "failed")] + Failed, + /// The extension process is starting. + #[serde(rename = "starting")] + Starting, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Attachment type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExtensionContextPushInputType { + #[serde(rename = "extension_context")] + #[default] + ExtensionContext, +} + +/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmBinaryResultsForLlmType { + /// Binary image data. + #[serde(rename = "image")] + Image, + /// Other binary resource data. + #[serde(rename = "resource")] + Resource, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentAudioType { + #[serde(rename = "audio")] + #[default] + Audio, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentImageType { + #[serde(rename = "image")] + #[default] + Image, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentResourceType { + #[serde(rename = "resource")] + #[default] + Resource, +} + +/// Theme variant this icon is intended for +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentResourceLinkIconTheme { + /// Icon intended for light themes. + #[serde(rename = "light")] + Light, + /// Icon intended for dark themes. + #[serde(rename = "dark")] + Dark, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentResourceLinkType { + #[serde(rename = "resource_link")] + #[default] + ResourceLink, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentShellExitType { + #[serde(rename = "shell_exit")] + #[default] + ShellExit, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentTerminalType { + #[serde(rename = "terminal")] + #[default] + Terminal, +} + +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ExternalToolTextResultForLlmContentTextType { + #[serde(rename = "text")] + #[default] + Text, +} + +/// Execution-critical factory storage operation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryDurableOperation { + /// Creating the durable run and declared phases. + #[serde(rename = "createRun")] + CreateRun, + /// Persisting the transition to running. + #[serde(rename = "markRunStarted")] + MarkRunStarted, + /// Persisting the terminal run envelope. + #[serde(rename = "finishRun")] + FinishRun, + /// Persisting subagent admission accounting. + #[serde(rename = "reserveAgent")] + ReserveAgent, + /// Rolling back an uncommitted subagent admission. + #[serde(rename = "releaseAgent")] + ReleaseAgent, + /// Persisting an idempotent model-usage charge. + #[serde(rename = "chargeCredit")] + ChargeCredit, + /// Persisting active execution time. + #[serde(rename = "addElapsed")] + AddElapsed, + /// Reading the authoritative AI-credit total. + #[serde(rename = "reconcileCreditTotal")] + ReconcileCreditTotal, + /// Reading a journal entry without treating storage failure as a cache miss. + #[serde(rename = "journalGet")] + JournalGet, + /// Persisting a journal entry before reporting success. + #[serde(rename = "journalPut")] + JournalPut, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Current or terminal state of a factory run. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryRunStatus { + /// The run was minted and is awaiting approval. + #[serde(rename = "pending")] + Pending, + /// The run is executing. + #[serde(rename = "running")] + Running, + /// The run completed successfully. + #[serde(rename = "completed")] + Completed, + /// The run was interrupted while resource budget remained. + #[serde(rename = "halted")] + Halted, + /// The run was cancelled before completion. + #[serde(rename = "cancelled")] + Cancelled, + /// The factory body failed or reached a cumulative resource ceiling. + #[serde(rename = "error")] + Error, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Kind of factory progress line. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryLogLineKind { + /// A narrator log line. + #[serde(rename = "log")] + Log, + /// A named factory phase marker. + #[serde(rename = "phase")] + Phase, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Derived lifecycle state of a factory phase. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryPhaseStatus { + /// The phase has not been entered yet. + #[serde(rename = "pending")] + Pending, + /// The phase is currently entered and accumulating active time. + #[serde(rename = "active")] + Active, + /// The phase was entered and has since been closed. + #[serde(rename = "completed")] + Completed, + /// The phase was never entered because a later phase was entered or the run reached a terminal state. + #[serde(rename = "skipped")] + Skipped, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Cumulative resource ceiling that stopped a factory run. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryRunFailureKind { + /// The run admitted the approved maximum total number of subagents. + #[serde(rename = "maxTotalSubagents")] + MaxTotalSubagents, + /// The run reached the approved accumulated active-execution time in seconds. + #[serde(rename = "timeoutSeconds")] + TimeoutSeconds, + /// The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. + #[serde(rename = "maxAiCredits")] + MaxAiCredits, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Authentication via the `gh` CLI's saved credentials. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum GhCliAuthInfoType { + #[serde(rename = "gh-cli")] + #[default] + GhCli, +} + +/// What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events. When absent, the compaction is persisted without trigger attribution (initiator unknown). +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryCompactRequestTrigger { + /// User-requested compaction, e.g. the /compact command or a direct history.compact call. + #[serde(rename = "manual")] + Manual, + /// Compaction requested while switching to a model with a smaller context window. + #[serde(rename = "model_switch")] + ModelSwitch, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Reason a captured file was not restored. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryFileRestoreSkipReason { + /// The file changed after Copilot's last captured write. + #[serde(rename = "user-modified")] + UserModified, + /// A faithful preimage was not captured. + #[serde(rename = "skipped-capture")] + SkippedCapture, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryRewindUnavailableReason { + /// The session did not opt into file-change tracking before its first turn. + #[serde(rename = "file-change-tracking-disabled")] + FileChangeTrackingDisabled, + /// The session still has work that may mutate files or history. Transient: the same request succeeds once the session settles, so callers should retry rather than treat it as a failure. + #[serde(rename = "session-busy")] + SessionBusy, + /// Remote-backed rewind routing is not supported. + #[serde(rename = "unsupported-remote-session")] + UnsupportedRemoteSession, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Aggregate file change represented by a rewind preview. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryRewindChangeType { + /// The discarded turns created the file. + #[serde(rename = "created")] + Created, + /// The discarded turns deleted the file. + #[serde(rename = "deleted")] + Deleted, + /// The discarded turns modified the file. + #[serde(rename = "modified")] + Modified, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Scope of a rewind operation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryRewindMode { + /// Discard conversation events while leaving files unchanged. + #[serde(rename = "conversation")] + Conversation, + /// Discard conversation events and restore captured files changed by those turns. + #[serde(rename = "conversation-and-files")] + ConversationAndFiles, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Outcome of a rewind request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HistoryRewindOutcome { + /// The requested rewind completed; reachable in either mode. + #[serde(rename = "success")] + Success, + /// The session still has work that may mutate files or history; reachable in either mode. + #[serde(rename = "session-busy")] + SessionBusy, + /// A conversation-and-files rewind was requested for a session that did not enable capture; conversation-only rewinds never produce this. + #[serde(rename = "file-change-tracking-disabled")] + FileChangeTrackingDisabled, + /// Remote-backed rewind routing is not supported; reachable in either mode. + #[serde(rename = "unsupported-remote-session")] + UnsupportedRemoteSession, + /// File restore failed and all applied file changes were rolled back; only conversation-and-files rewinds produce this. + #[serde(rename = "files-rolled-back")] + FilesRolledBack, + /// File restore failed and its rollback could not fully restore the pre-rewind state; only conversation-and-files rewinds produce this. + #[serde(rename = "rollback-incomplete")] + RollbackIncomplete, + /// Conversation truncation failed. In conversation-and-files mode any files that were restored are left in place because conversation history cannot be un-truncated; in conversation-only mode no files are restored. Consult restoredFiles for what, if anything, was applied. + #[serde(rename = "truncation-failed")] + TruncationFailed, + /// The conversation was rewound (and, in conversation-and-files mode, captured files were restored), but persisted checkpoints could not be cleaned up; reachable in either mode. + #[serde(rename = "checkpoint-cleanup-failed")] + CheckpointCleanupFailed, + /// Files and conversation were rewound, but obsolete file snapshots could not be removed; only conversation-and-files rewinds produce this. + #[serde(rename = "snapshot-prune-failed")] + SnapshotPruneFailed, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Authentication host. HMAC auth always targets the public GitHub host. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HMACAuthInfoHost { + #[serde(rename = "https://github.com")] + #[default] + HttpsGitHubCom, +} + +/// HMAC-based authentication used by GitHub-internal services. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HMACAuthInfoType { + #[serde(rename = "hmac")] + #[default] + Hmac, +} + +/// Hook event name dispatched through the SDK callback transport. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum HookType { + /// Runs before a tool is invoked. + #[serde(rename = "preToolUse")] + PreToolUse, + /// Runs before an MCP tool is invoked. + #[serde(rename = "preMcpToolCall")] + PreMcpToolCall, + /// Runs after a tool completes successfully. + #[serde(rename = "postToolUse")] + PostToolUse, + /// Runs after a tool fails. + #[serde(rename = "postToolUseFailure")] + PostToolUseFailure, + /// Runs after the user submits a prompt. + #[serde(rename = "userPromptSubmitted")] + UserPromptSubmitted, + /// Runs after the runtime transforms the submitted prompt for the model, before it is added to session history. + #[serde(rename = "userPromptTransformed")] + UserPromptTransformed, + /// Runs when a session starts. + #[serde(rename = "sessionStart")] + SessionStart, + /// Runs when a session ends. + #[serde(rename = "sessionEnd")] + SessionEnd, + /// Runs after an agent result is produced. + #[serde(rename = "postResult")] + PostResult, + /// Runs before a pull request description is generated. + #[serde(rename = "prePRDescription")] + PrePRDescription, + /// Runs when the agent encounters an error. + #[serde(rename = "errorOccurred")] + ErrorOccurred, + /// Runs when the agent stops. + #[serde(rename = "agentStop")] + AgentStop, + /// Runs when a subagent starts. + #[serde(rename = "subagentStart")] + SubagentStart, + /// Runs when a subagent stops. + #[serde(rename = "subagentStop")] + SubagentStop, + /// Runs before conversation context is compacted. + #[serde(rename = "preCompact")] + PreCompact, + /// Runs when the agent requests permission. + #[serde(rename = "permissionRequest")] + PermissionRequest, + /// Runs when the agent emits a notification. + #[serde(rename = "notification")] + Notification, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Constant value. Always "github". +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum InstalledPluginSourceGitHubSource { + #[serde(rename = "github")] + #[default] + GitHub, +} + +/// Constant value. Always "local". +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum InstalledPluginSourceLocalSource { + #[serde(rename = "local")] + #[default] + Local, +} + +/// Constant value. Always "url". +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum InstalledPluginSourceUrlSource { + #[serde(rename = "url")] + #[default] + Url, +} + +/// Whether the target is a single file or a directory of instruction files +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum InstructionDiscoveryPathKind { + /// The target is a single instruction file. + #[serde(rename = "file")] + File, + /// The target is a directory that holds instruction files. + #[serde(rename = "directory")] + Directory, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Which tier this target belongs to +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnRegistryTimeoutKind { - #[serde(rename = "registry-timeout")] +pub enum InstructionDiscoveryPathLocation { + /// Instructions live in user-level configuration. + #[serde(rename = "user")] + User, + /// Instructions live in repository-level configuration. + #[serde(rename = "repository")] + Repository, + /// Instructions live under the current working directory. + #[serde(rename = "working-directory")] + WorkingDirectory, + /// Instructions live in plugin-provided configuration. + #[serde(rename = "plugin")] + Plugin, + /// Unknown variant for forward compatibility. #[default] - RegistryTimeout, + #[serde(other)] + Unknown, } -/// Discriminator: managed-server child spawned successfully +/// Where this source lives — used for UI grouping +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnSpawnedKind { - #[serde(rename = "spawned")] +pub enum InstructionSourceLocation { + /// Instructions live in user-level configuration. + #[serde(rename = "user")] + User, + /// Instructions live in repository-level configuration. + #[serde(rename = "repository")] + Repository, + /// Instructions live under the current working directory. + #[serde(rename = "working-directory")] + WorkingDirectory, + /// Instructions live in plugin-provided configuration. + #[serde(rename = "plugin")] + Plugin, + /// Unknown variant for forward compatibility. #[default] - Spawned, + #[serde(other)] + Unknown, } -/// Which parameter field was invalid. Omitted when the rejection is not field-specific. +/// Category of instruction source — used for merge logic /// ///
    /// @@ -12907,37 +25369,50 @@ pub enum AgentRegistrySpawnSpawnedKind { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnValidationErrorField { - /// The cwd parameter - #[serde(rename = "cwd")] - Cwd, - /// The session name parameter - #[serde(rename = "name")] - Name, - /// The agentName parameter - #[serde(rename = "agentName")] - AgentName, - /// The model parameter +pub enum InstructionSourceType { + /// Instructions loaded from the user's home configuration. + #[serde(rename = "home")] + Home, + /// Instructions loaded from repository-scoped files. + #[serde(rename = "repo")] + Repo, + /// Instructions loaded from model-specific files. #[serde(rename = "model")] Model, - /// The permissionMode parameter - #[serde(rename = "permissionMode")] - PermissionMode, + /// Instructions loaded from VS Code instruction files. + #[serde(rename = "vscode")] + Vscode, + /// Instructions discovered from nested agent files. + #[serde(rename = "nested-agents")] + NestedAgents, + /// Instructions inherited from child instruction files. + #[serde(rename = "child-instructions")] + ChildInstructions, + /// Instructions supplied by an installed plugin. + #[serde(rename = "plugin")] + Plugin, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Discriminator: synchronous pre-validation rejected the request +/// Transport the runtime would otherwise use for this request. `http` (the default when absent) covers plain HTTP and SSE responses; `websocket` indicates a full-duplex message channel where each body chunk maps to one WebSocket message and the `binary` flag distinguishes text from binary frames. The SDK consumer uses this to decide whether to service the request with an HTTP client or a WebSocket client. It is the one piece of request metadata the consumer cannot reliably infer from the URL or headers alone. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnValidationErrorKind { - #[serde(rename = "validation-error")] +pub enum LlmInferenceHttpRequestStartTransport { + /// Plain HTTP or SSE response. Each body chunk is an opaque byte range; the response is a status line, headers, and a (possibly streamed) body. + #[serde(rename = "http")] + Http, + /// Full-duplex WebSocket channel. Each body chunk maps to exactly one WebSocket message and the `binary` flag distinguishes text from binary frames; request and response chunks flow concurrently. + #[serde(rename = "websocket")] + Websocket, + /// Unknown variant for forward compatibility. #[default] - ValidationError, + #[serde(other)] + Unknown, } -/// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names. +/// Repository host type /// ///
    /// @@ -12946,32 +25421,20 @@ pub enum AgentRegistrySpawnValidationErrorKind { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AgentRegistrySpawnValidationErrorReason { - /// Provided cwd does not exist on disk - #[serde(rename = "cwd-not-found")] - CwdNotFound, - /// Provided cwd exists but is not a directory - #[serde(rename = "cwd-not-directory")] - CwdNotDirectory, - /// Session name failed validateSessionName - #[serde(rename = "invalid-name")] - InvalidName, - /// Requested agent name was not found in builtin or custom agents - #[serde(rename = "unknown-agent")] - UnknownAgent, - /// Requested model is not available to this session - #[serde(rename = "unknown-model")] - UnknownModel, - /// Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode - #[serde(rename = "yolo-not-allowed")] - YoloNotAllowed, +pub enum SessionContextHostType { + /// Session repository is hosted on GitHub. + #[serde(rename = "github")] + GitHub, + /// Session repository is hosted on Azure DevOps. + #[serde(rename = "ado")] + Ado, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Outcome of an agentRegistry.spawn call. +/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". /// ///
    /// @@ -12979,24 +25442,49 @@ pub enum AgentRegistrySpawnValidationErrorReason { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] -#[serde(untagged)] -pub enum AgentRegistrySpawnResult { - Spawned(AgentRegistrySpawnSpawned), - SpawnError(AgentRegistrySpawnError), - RegistryTimeout(AgentRegistrySpawnRegistryTimeout), - ValidationError(AgentRegistrySpawnValidationError), +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLogLevel { + /// Informational message. + #[serde(rename = "info")] + Info, + /// Warning message that may require attention. + #[serde(rename = "warning")] + Warning, + /// Error message describing a failure. + #[serde(rename = "error")] + Error, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style). +/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ApiKeyAuthInfoType { - #[serde(rename = "api-key")] +pub enum McpAppsHostContextDetailsAvailableDisplayMode { + /// Rendered inline within the host conversation surface + #[serde(rename = "inline")] + Inline, + /// Rendered as a fullscreen overlay + #[serde(rename = "fullscreen")] + Fullscreen, + /// Rendered as a picture-in-picture floating panel + #[serde(rename = "pip")] + Pip, + /// Unknown variant for forward compatibility. #[default] - ApiKey, + #[serde(other)] + Unknown, } -/// Authentication type +/// Current display mode (SEP-1865) /// ///
    /// @@ -13005,35 +25493,70 @@ pub enum ApiKeyAuthInfoType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum AuthInfoType { - /// Authentication provided by a GitHub App HMAC credential. - #[serde(rename = "hmac")] - Hmac, - /// Authentication resolved from environment-provided credentials. - #[serde(rename = "env")] - Env, - /// Authentication from an interactive user sign-in. - #[serde(rename = "user")] - User, - /// Authentication delegated to the GitHub CLI. - #[serde(rename = "gh-cli")] - GhCli, - /// Authentication from an API key credential. - #[serde(rename = "api-key")] - ApiKey, - /// Authentication from a GitHub token. - #[serde(rename = "token")] - Token, - /// Authentication from a Copilot API token. - #[serde(rename = "copilot-api-token")] - CopilotApiToken, +pub enum McpAppsHostContextDetailsDisplayMode { + /// Rendered inline within the host conversation surface + #[serde(rename = "inline")] + Inline, + /// Rendered as a fullscreen overlay + #[serde(rename = "fullscreen")] + Fullscreen, + /// Rendered as a picture-in-picture floating panel + #[serde(rename = "pip")] + Pip, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Platform type for responsive design +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpAppsHostContextDetailsPlatform { + /// Host runs in a web browser + #[serde(rename = "web")] + Web, + /// Host runs as a desktop application + #[serde(rename = "desktop")] + Desktop, + /// Host runs on a mobile device + #[serde(rename = "mobile")] + Mobile, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// UI theme preference per SEP-1865 +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpAppsHostContextDetailsTheme { + /// Light UI theme + #[serde(rename = "light")] + Light, + /// Dark UI theme + #[serde(rename = "dark")] + Dark, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Runtime-controlled routing state for an open canvas instance. +/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. /// ///
    /// @@ -13042,20 +25565,23 @@ pub enum AuthInfoType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum CanvasInstanceAvailability { - /// The owning provider is currently connected and routing calls will be dispatched normally. - #[serde(rename = "ready")] - Ready, - /// The owning provider is not currently connected. Routing calls fail with canvas_provider_unavailable until the agent re-issues open_canvas (which rehydrates via a fresh canvas.open) or the provider reconnects. - #[serde(rename = "stale")] - Stale, +pub enum McpAppsSetHostContextDetailsAvailableDisplayMode { + /// Rendered inline within the host conversation surface + #[serde(rename = "inline")] + Inline, + /// Rendered as a fullscreen overlay + #[serde(rename = "fullscreen")] + Fullscreen, + /// Rendered as a picture-in-picture floating panel + #[serde(rename = "pip")] + Pip, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Optional completion hint for the input (e.g. 'directory' for filesystem path completion) +/// Current display mode (SEP-1865) /// ///
    /// @@ -13064,17 +25590,23 @@ pub enum CanvasInstanceAvailability { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SlashCommandInputCompletion { - /// Input should complete filesystem directories. - #[serde(rename = "directory")] - Directory, +pub enum McpAppsSetHostContextDetailsDisplayMode { + /// Rendered inline within the host conversation surface + #[serde(rename = "inline")] + Inline, + /// Rendered as a fullscreen overlay + #[serde(rename = "fullscreen")] + Fullscreen, + /// Rendered as a picture-in-picture floating panel + #[serde(rename = "pip")] + Pip, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command +/// Platform type for responsive design /// ///
    /// @@ -13083,23 +25615,23 @@ pub enum SlashCommandInputCompletion { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SlashCommandKind { - /// Command implemented by the runtime. - #[serde(rename = "builtin")] - Builtin, - /// Command backed by a skill. - #[serde(rename = "skill")] - Skill, - /// Command registered by an SDK client or extension. - #[serde(rename = "client")] - Client, +pub enum McpAppsSetHostContextDetailsPlatform { + /// Host runs in a web browser + #[serde(rename = "web")] + Web, + /// Host runs as a desktop application + #[serde(rename = "desktop")] + Desktop, + /// Host runs on a mobile device + #[serde(rename = "mobile")] + Mobile, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Neutral SDK discriminator for the connected remote session kind. +/// UI theme preference per SEP-1865 /// ///
    /// @@ -13108,54 +25640,100 @@ pub enum SlashCommandKind { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ConnectedRemoteSessionMetadataKind { - /// Remote CLI session. - #[serde(rename = "remote-session")] - RemoteSession, - /// GitHub Copilot coding agent session. - #[serde(rename = "coding-agent")] - CodingAgent, +pub enum McpAppsSetHostContextDetailsTheme { + /// Light UI theme + #[serde(rename = "light")] + Light, + /// Dark UI theme + #[serde(rename = "dark")] + Dark, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Controls how MCP tool result content is filtered: none leaves content unchanged, markdown sanitizes HTML while preserving Markdown-friendly output, and hidden_characters removes characters that can hide directives. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ContentFilterMode { - /// Leave MCP tool result content unchanged. +pub enum McpHeadersHandlePendingHeadersRefreshRequestHeadersKind { + #[serde(rename = "headers")] + #[default] + Headers, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpHeadersHandlePendingHeadersRefreshRequestNoneKind { #[serde(rename = "none")] + #[default] None, - /// Sanitize HTML while preserving Markdown-friendly output. - #[serde(rename = "markdown")] - Markdown, - /// Remove characters that can hide directives. - #[serde(rename = "hidden_characters")] - HiddenCharacters, +} + +/// Host response: supply dynamic headers or decline this refresh. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpHeadersHandlePendingHeadersRefreshRequest { + Headers(McpHeadersHandlePendingHeadersRefreshRequestHeaders), + None(McpHeadersHandlePendingHeadersRefreshRequestNone), +} + +/// Consumer allowed to call an MCP tool. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpToolUiVisibility { + /// The model may call the tool. + #[serde(rename = "model")] + Model, + /// An MCP App view may call the tool. + #[serde(rename = "app")] + App, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Authentication host (always the public GitHub host). #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum CopilotApiTokenAuthInfoHost { - #[serde(rename = "https://github.com")] +pub enum McpOauthPendingRequestResponseTokenKind { + #[serde(rename = "token")] #[default] - HttpsGithubCom, + Token, } -/// Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum CopilotApiTokenAuthInfoType { - #[serde(rename = "copilot-api-token")] +pub enum McpOauthPendingRequestResponseCancelledKind { + #[serde(rename = "cancelled")] #[default] - CopilotApiToken, + Cancelled, +} + +/// Host response to the pending OAuth request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum McpOauthPendingRequestResponse { + Token(McpOauthPendingRequestResponseToken), + Cancelled(McpOauthPendingRequestResponseCancelled), } -/// Context tier currently pinned for the session, when one is set. Reflects `Session.getContextTier()`, restored from the session journal on resume. +/// OAuth grant type override for this login. /// ///
    /// @@ -13164,49 +25742,67 @@ pub enum CopilotApiTokenAuthInfoType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ModelCurrentContextTier { - /// Use the model's default context window. - #[serde(rename = "default")] - Default, - /// Pin the session to the long-context tier when supported. - #[serde(rename = "long_context")] - LongContext, +pub enum McpOauthLoginGrantType { + /// Interactive browser-based OAuth flow using an authorization code, typically with PKCE. + #[serde(rename = "authorization_code")] + AuthorizationCode, + /// Headless OAuth flow where a confidential client authenticates directly with a client secret. + #[serde(rename = "client_credentials")] + ClientCredentials, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Server transport type: stdio, http, sse (deprecated), or memory +/// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum DiscoveredMcpServerType { - /// Server communicates over stdio with a local child process. - #[serde(rename = "stdio")] - Stdio, - /// Server communicates over streamable HTTP. - #[serde(rename = "http")] - Http, - /// Server communicates over Server-Sent Events (deprecated). - #[serde(rename = "sse")] - Sse, - /// Server is backed by an in-memory runtime implementation. - #[serde(rename = "memory")] - Memory, +pub enum McpSamplingExecutionAction { + /// The sampling inference completed and produced a result. + #[serde(rename = "success")] + Success, + /// The sampling inference failed or was rejected. + #[serde(rename = "failure")] + Failure, + /// The sampling inference was cancelled before completion. + #[serde(rename = "cancelled")] + Cancelled, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Personal access token (PAT) or server-to-server token sourced from an environment variable. +/// Controls if tools provided by this server can be loaded on demand via tool search (auto) or always included in the initial tool list (never) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum EnvAuthInfoType { - #[serde(rename = "env")] +pub enum McpServerConfigDeferTools { + /// Tools may be deferred under certain conditions + #[serde(rename = "auto")] + Auto, + /// Tools are always included in the initial tool list, even when tool search is enabled. + #[serde(rename = "never")] + Never, + /// Unknown variant for forward compatibility. #[default] - Env, + #[serde(other)] + Unknown, } -/// Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.' (matching the typed-subscription default behavior); 'all' returns events from all agents (matching wildcard-subscription behavior). Default is 'all' to preserve wildcard semantics for catch-up callers. +/// OAuth grant type to use when authenticating to the remote MCP server. /// ///
    /// @@ -13215,20 +25811,20 @@ pub enum EnvAuthInfoType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum EventsAgentScope { - /// Return main-agent events and typed subagent lifecycle events. - #[serde(rename = "primary")] - Primary, - /// Return events from all agents. - #[serde(rename = "all")] - All, +pub enum McpServerConfigHttpOauthGrantType { + /// Interactive browser-based authorization code flow with PKCE. + #[serde(rename = "authorization_code")] + AuthorizationCode, + /// Headless client credentials flow using the configured OAuth client. + #[serde(rename = "client_credentials")] + ClientCredentials, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history. +/// Remote transport type. Defaults to "http" when omitted. /// ///
    /// @@ -13237,20 +25833,20 @@ pub enum EventsAgentScope { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum EventsCursorStatus { - /// The cursor was applied successfully. - #[serde(rename = "ok")] - Ok, - /// The cursor referred to history that is no longer available. - #[serde(rename = "expired")] - Expired, +pub enum McpServerConfigHttpType { + /// Streamable HTTP transport. + #[serde(rename = "http")] + Http, + /// Server-Sent Events transport. + #[serde(rename = "sse")] + Sse, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/) +/// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". /// ///
    /// @@ -13259,20 +25855,20 @@ pub enum EventsCursorStatus { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExtensionSource { - /// Extension discovered from the current project's .github/extensions directory. - #[serde(rename = "project")] - Project, - /// Extension discovered from the user's ~/.copilot/extensions directory. - #[serde(rename = "user")] - User, +pub enum McpSetEnvValueModeDetails { + /// Treat MCP server environment values as literal strings. + #[serde(rename = "direct")] + Direct, + /// Treat MCP server environment values as host-side references to resolve before launch. + #[serde(rename = "indirect")] + Indirect, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current status: running, disabled, failed, or starting +/// Hosting platform type of the repository /// ///
    /// @@ -13281,26 +25877,20 @@ pub enum ExtensionSource { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExtensionStatus { - /// The extension process is running. - #[serde(rename = "running")] - Running, - /// The extension is installed but disabled. - #[serde(rename = "disabled")] - Disabled, - /// The extension failed to start or crashed. - #[serde(rename = "failed")] - Failed, - /// The extension process is starting. - #[serde(rename = "starting")] - Starting, +pub enum SessionWorkingDirectoryContextHostType { + /// The working directory repository is hosted on GitHub. + #[serde(rename = "github")] + GitHub, + /// The working directory repository is hosted on Azure DevOps. + #[serde(rename = "ado")] + Ado, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Binary result type discriminator. Use "image" for images and "resource" for other binary data. +/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') /// ///
    /// @@ -13309,44 +25899,23 @@ pub enum ExtensionStatus { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmBinaryResultsForLlmType { - /// Binary image data. - #[serde(rename = "image")] - Image, - /// Other binary resource data. - #[serde(rename = "resource")] - Resource, +pub enum MetadataSnapshotCurrentMode { + /// The agent is responding interactively to the user. + #[serde(rename = "interactive")] + Interactive, + /// The agent is preparing a plan before making changes. + #[serde(rename = "plan")] + Plan, + /// The agent is working autonomously toward task completion. + #[serde(rename = "autopilot")] + Autopilot, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentAudioType { - #[serde(rename = "audio")] - #[default] - Audio, -} - -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentImageType { - #[serde(rename = "image")] - #[default] - Image, -} - -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentResourceType { - #[serde(rename = "resource")] - #[default] - Resource, -} - -/// Theme variant this icon is intended for +/// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. /// ///
    /// @@ -13355,92 +25924,20 @@ pub enum ExternalToolTextResultForLlmContentResourceType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentResourceLinkIconTheme { - /// Icon intended for light themes. - #[serde(rename = "light")] - Light, - /// Icon intended for dark themes. - #[serde(rename = "dark")] - Dark, +pub enum MetadataSnapshotRemoteMetadataTaskType { + /// Remote task originated from Copilot Coding Agent. + #[serde(rename = "cca")] + Cca, + /// Remote task originated from a CLI remote-session invocation. + #[serde(rename = "cli")] + Cli, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentResourceLinkType { - #[serde(rename = "resource_link")] - #[default] - ResourceLink, -} - -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentTerminalType { - #[serde(rename = "terminal")] - #[default] - Terminal, -} - -/// Content block type discriminator -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ExternalToolTextResultForLlmContentTextType { - #[serde(rename = "text")] - #[default] - Text, -} - -/// Authentication via the `gh` CLI's saved credentials. -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum GhCliAuthInfoType { - #[serde(rename = "gh-cli")] - #[default] - GhCli, -} - -/// Authentication host. HMAC auth always targets the public GitHub host. -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum HMACAuthInfoHost { - #[serde(rename = "https://github.com")] - #[default] - HttpsGithubCom, -} - -/// HMAC-based authentication used by GitHub-internal services. -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum HMACAuthInfoType { - #[serde(rename = "hmac")] - #[default] - Hmac, -} - -/// Constant value. Always "github". -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceGithubSource { - #[serde(rename = "github")] - #[default] - Github, -} - -/// Constant value. Always "local". -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceLocalSource { - #[serde(rename = "local")] - #[default] - Local, -} - -/// Constant value. Always "url". -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstalledPluginSourceUrlSource { - #[serde(rename = "url")] - #[default] - Url, -} - -/// Where this source lives — used for UI grouping +/// Model capability category for grouping in the model picker /// ///
    /// @@ -13449,26 +25946,23 @@ pub enum InstalledPluginSourceUrlSource { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstructionsSourcesLocation { - /// Instructions live in user-level configuration. - #[serde(rename = "user")] - User, - /// Instructions live in repository-level configuration. - #[serde(rename = "repository")] - Repository, - /// Instructions live under the current working directory. - #[serde(rename = "working-directory")] - WorkingDirectory, - /// Instructions live in plugin-provided configuration. - #[serde(rename = "plugin")] - Plugin, +pub enum ModelPickerCategory { + /// Lightweight model category optimized for faster, lower-cost interactions. + #[serde(rename = "lightweight")] + Lightweight, + /// Versatile model category suitable for a broad range of tasks. + #[serde(rename = "versatile")] + Versatile, + /// Powerful model category optimized for complex tasks. + #[serde(rename = "powerful")] + Powerful, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Category of instruction source — used for merge logic +/// Relative cost tier for token-based billing users /// ///
    /// @@ -13477,35 +25971,26 @@ pub enum InstructionsSourcesLocation { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum InstructionsSourcesType { - /// Instructions loaded from the user's home configuration. - #[serde(rename = "home")] - Home, - /// Instructions loaded from repository-scoped files. - #[serde(rename = "repo")] - Repo, - /// Instructions loaded from model-specific files. - #[serde(rename = "model")] - Model, - /// Instructions loaded from VS Code instruction files. - #[serde(rename = "vscode")] - Vscode, - /// Instructions discovered from nested agent files. - #[serde(rename = "nested-agents")] - NestedAgents, - /// Instructions inherited from child instruction files. - #[serde(rename = "child-instructions")] - ChildInstructions, - /// Instructions supplied by an installed plugin. - #[serde(rename = "plugin")] - Plugin, +pub enum ModelPickerPriceCategory { + /// Lowest relative token cost tier. + #[serde(rename = "low")] + Low, + /// Medium relative token cost tier. + #[serde(rename = "medium")] + Medium, + /// High relative token cost tier. + #[serde(rename = "high")] + High, + /// Highest relative token cost tier. + #[serde(rename = "very_high")] + VeryHigh, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Log severity level. Determines how the message is displayed in the timeline. Defaults to "info". +/// Current policy state for this model /// ///
    /// @@ -13514,23 +25999,23 @@ pub enum InstructionsSourcesType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionLogLevel { - /// Informational message. - #[serde(rename = "info")] - Info, - /// Warning message that may require attention. - #[serde(rename = "warning")] - Warning, - /// Error message describing a failure. - #[serde(rename = "error")] - Error, +pub enum ModelPolicyState { + /// The model is enabled by policy. + #[serde(rename = "enabled")] + Enabled, + /// The model is disabled by policy. + #[serde(rename = "disabled")] + Disabled, + /// No explicit policy is configured for the model. + #[serde(rename = "unconfigured")] + Unconfigured, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration. +/// Provider transport. Defaults to "http". /// ///
    /// @@ -13539,23 +26024,20 @@ pub enum SessionLogLevel { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsHostContextDetailsAvailableDisplayMode { - /// Rendered inline within the host conversation surface - #[serde(rename = "inline")] - Inline, - /// Rendered as a fullscreen overlay - #[serde(rename = "fullscreen")] - Fullscreen, - /// Rendered as a picture-in-picture floating panel - #[serde(rename = "pip")] - Pip, +pub enum ProviderConfigTransport { + /// HTTP request/streaming transport. + #[serde(rename = "http")] + Http, + /// WebSocket transport. + #[serde(rename = "websockets")] + Websockets, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current display mode (SEP-1865) +/// Provider type. Defaults to "openai" for generic OpenAI-compatible APIs. /// ///
    /// @@ -13564,23 +26046,23 @@ pub enum McpAppsHostContextDetailsAvailableDisplayMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsHostContextDetailsDisplayMode { - /// Rendered inline within the host conversation surface - #[serde(rename = "inline")] - Inline, - /// Rendered as a fullscreen overlay - #[serde(rename = "fullscreen")] - Fullscreen, - /// Rendered as a picture-in-picture floating panel - #[serde(rename = "pip")] - Pip, +pub enum ProviderConfigType { + /// Generic OpenAI-compatible API. + #[serde(rename = "openai")] + Openai, + /// Azure OpenAI Service endpoint. + #[serde(rename = "azure")] + Azure, + /// Anthropic API endpoint. + #[serde(rename = "anthropic")] + Anthropic, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Platform type for responsive design +/// Wire API format (openai/azure only). Defaults to "completions". /// ///
    /// @@ -13589,23 +26071,42 @@ pub enum McpAppsHostContextDetailsDisplayMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsHostContextDetailsPlatform { - /// Host runs in a web browser - #[serde(rename = "web")] - Web, - /// Host runs as a desktop application - #[serde(rename = "desktop")] - Desktop, - /// Host runs on a mobile device - #[serde(rename = "mobile")] - Mobile, +pub enum ProviderConfigWireApi { + /// OpenAI Chat Completions wire format. + #[serde(rename = "completions")] + Completions, + /// OpenAI Responses API wire format. + #[serde(rename = "responses")] + Responses, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum OptionsUpdateAdditionalContentExclusionPolicyScope { + /// The content exclusion policy applies to the current repository. + #[serde(rename = "repo")] + Repo, + /// The content exclusion policy applies across all repositories. + #[serde(rename = "all")] + All, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// UI theme preference per SEP-1865 +/// Context tier for models with tiered pricing. The session uses this to derive effective `modelCapabilitiesOverrides` so compaction, truncation, token display, and request limits honor the selected tier. /// ///
    /// @@ -13614,20 +26115,20 @@ pub enum McpAppsHostContextDetailsPlatform { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsHostContextDetailsTheme { - /// Light UI theme - #[serde(rename = "light")] - Light, - /// Dark UI theme - #[serde(rename = "dark")] - Dark, +pub enum OptionsUpdateContextTier { + /// Use the model's default context tier and its standard token limits / pricing. + #[serde(rename = "default")] + Default, + /// Use the model's long-context tier (when available) so larger inputs are accepted and tier-specific pricing applies. + #[serde(rename = "long_context")] + LongContext, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration. +/// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). /// ///
    /// @@ -13636,23 +26137,20 @@ pub enum McpAppsHostContextDetailsTheme { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsSetHostContextDetailsAvailableDisplayMode { - /// Rendered inline within the host conversation surface - #[serde(rename = "inline")] - Inline, - /// Rendered as a fullscreen overlay - #[serde(rename = "fullscreen")] - Fullscreen, - /// Rendered as a picture-in-picture floating panel - #[serde(rename = "pip")] - Pip, +pub enum OptionsUpdateEnvValueMode { + /// Pass MCP server environment values as literal strings. + #[serde(rename = "direct")] + Direct, + /// Resolve MCP server environment values from host-side references. + #[serde(rename = "indirect")] + Indirect, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Current display mode (SEP-1865) +/// Reasoning summary mode for supported model clients. /// ///
    /// @@ -13661,23 +26159,23 @@ pub enum McpAppsSetHostContextDetailsAvailableDisplayMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsSetHostContextDetailsDisplayMode { - /// Rendered inline within the host conversation surface - #[serde(rename = "inline")] - Inline, - /// Rendered as a fullscreen overlay - #[serde(rename = "fullscreen")] - Fullscreen, - /// Rendered as a picture-in-picture floating panel - #[serde(rename = "pip")] - Pip, +pub enum OptionsUpdateReasoningSummary { + /// Do not request reasoning summaries from the model. + #[serde(rename = "none")] + None, + /// Request a concise summary of model reasoning. + #[serde(rename = "concise")] + Concise, + /// Request a detailed summary of model reasoning. + #[serde(rename = "detailed")] + Detailed, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Platform type for responsive design +/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. /// ///
    /// @@ -13686,23 +26184,108 @@ pub enum McpAppsSetHostContextDetailsDisplayMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsSetHostContextDetailsPlatform { - /// Host runs in a web browser - #[serde(rename = "web")] - Web, - /// Host runs as a desktop application - #[serde(rename = "desktop")] - Desktop, - /// Host runs on a mobile device - #[serde(rename = "mobile")] - Mobile, +pub enum OptionsUpdateToolFilterPrecedence { + /// If availableTools is set, it is the only constraint that applies (excludedTools is ignored). Preserves CLI / pre-existing client behavior. Default. + #[serde(rename = "available")] + Available, + /// A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND it does not match the denylist. Makes 'all except X' expressible by combining the two lists. + #[serde(rename = "excluded")] + Excluded, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// UI theme preference per SEP-1865 +/// Approve this single request only +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveOnceKind { + #[serde(rename = "approve-once")] + #[default] + ApproveOnce, +} + +/// Approval scoped to specific command identifiers. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalCommandsKind { + #[serde(rename = "commands")] + #[default] + Commands, +} + +/// Approval covering read-only filesystem operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalReadKind { + #[serde(rename = "read")] + #[default] + Read, +} + +/// Approval covering filesystem write operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalWriteKind { + #[serde(rename = "write")] + #[default] + Write, +} + +/// Approval covering an MCP tool. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalMcpKind { + #[serde(rename = "mcp")] + #[default] + Mcp, +} + +/// Approval covering MCP sampling requests for a server. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalMcpSamplingKind { + #[serde(rename = "mcp-sampling")] + #[default] + McpSampling, +} + +/// Approval covering writes to long-term memory. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalMemoryKind { + #[serde(rename = "memory")] + #[default] + Memory, +} + +/// Approval covering a custom tool. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalCustomToolKind { + #[serde(rename = "custom-tool")] + #[default] + CustomTool, +} + +/// Approval covering extension lifecycle operations such as enable, disable, or reload. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalExtensionManagementKind { + #[serde(rename = "extension-management")] + #[default] + ExtensionManagement, +} + +/// Approval covering factory operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + +/// Approval covering an extension's request to access a permission-gated capability. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKind { + #[serde(rename = "extension-permission-access")] + #[default] + ExtensionPermissionAccess, +} + +/// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) /// ///
    /// @@ -13710,21 +26293,110 @@ pub enum McpAppsSetHostContextDetailsPlatform { /// and may change or be removed in future SDK or CLI releases. /// ///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PermissionDecisionApproveForSessionApproval { + Commands(PermissionDecisionApproveForSessionApprovalCommands), + Read(PermissionDecisionApproveForSessionApprovalRead), + Write(PermissionDecisionApproveForSessionApprovalWrite), + Mcp(PermissionDecisionApproveForSessionApprovalMcp), + McpSampling(PermissionDecisionApproveForSessionApprovalMcpSampling), + Memory(PermissionDecisionApproveForSessionApprovalMemory), + CustomTool(PermissionDecisionApproveForSessionApprovalCustomTool), + ExtensionManagement(PermissionDecisionApproveForSessionApprovalExtensionManagement), + Factory(PermissionDecisionApproveForSessionApprovalFactory), + ExtensionPermissionAccess(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), +} + +/// Approve and remember for the rest of the session #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpAppsSetHostContextDetailsTheme { - /// Light UI theme - #[serde(rename = "light")] - Light, - /// Dark UI theme - #[serde(rename = "dark")] - Dark, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApproveForSessionKind { + #[serde(rename = "approve-for-session")] + #[default] + ApproveForSession, +} + +/// Approval scoped to specific command identifiers. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalCommandsKind { + #[serde(rename = "commands")] + #[default] + Commands, +} + +/// Approval covering read-only filesystem operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalReadKind { + #[serde(rename = "read")] + #[default] + Read, +} + +/// Approval covering filesystem write operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalWriteKind { + #[serde(rename = "write")] + #[default] + Write, +} + +/// Approval covering an MCP tool. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalMcpKind { + #[serde(rename = "mcp")] + #[default] + Mcp, +} + +/// Approval covering MCP sampling requests for a server. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalMcpSamplingKind { + #[serde(rename = "mcp-sampling")] + #[default] + McpSampling, +} + +/// Approval covering writes to long-term memory. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalMemoryKind { + #[serde(rename = "memory")] + #[default] + Memory, +} + +/// Approval covering a custom tool. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalCustomToolKind { + #[serde(rename = "custom-tool")] + #[default] + CustomTool, +} + +/// Approval covering extension lifecycle operations such as enable, disable, or reload. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalExtensionManagementKind { + #[serde(rename = "extension-management")] + #[default] + ExtensionManagement, +} + +/// Approval covering factory operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + +/// Approval covering an extension's request to access a permission-gated capability. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind { + #[serde(rename = "extension-permission-access")] #[default] - #[serde(other)] - Unknown, + ExtensionPermissionAccess, } -/// Outcome of the sampling inference. 'success' produced a response; 'failure' encountered an error (including agent-side rejection by content filter or criteria); 'cancelled' the caller cancelled this execution via cancelSamplingExecution. +/// Approval to persist for this location /// ///
    /// @@ -13732,216 +26404,183 @@ pub enum McpAppsSetHostContextDetailsTheme { /// and may change or be removed in future SDK or CLI releases. /// ///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PermissionDecisionApproveForLocationApproval { + Commands(PermissionDecisionApproveForLocationApprovalCommands), + Read(PermissionDecisionApproveForLocationApprovalRead), + Write(PermissionDecisionApproveForLocationApprovalWrite), + Mcp(PermissionDecisionApproveForLocationApprovalMcp), + McpSampling(PermissionDecisionApproveForLocationApprovalMcpSampling), + Memory(PermissionDecisionApproveForLocationApprovalMemory), + CustomTool(PermissionDecisionApproveForLocationApprovalCustomTool), + ExtensionManagement(PermissionDecisionApproveForLocationApprovalExtensionManagement), + Factory(PermissionDecisionApproveForLocationApprovalFactory), + ExtensionPermissionAccess( + PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess, + ), +} + +/// Approve and persist for this project location #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpSamplingExecutionAction { - /// The sampling inference completed and produced a result. - #[serde(rename = "success")] - Success, - /// The sampling inference failed or was rejected. - #[serde(rename = "failure")] - Failure, - /// The sampling inference was cancelled before completion. - #[serde(rename = "cancelled")] - Cancelled, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApproveForLocationKind { + #[serde(rename = "approve-for-location")] #[default] - #[serde(other)] - Unknown, + ApproveForLocation, } -/// OAuth grant type to use when authenticating to the remote MCP server. +/// Approve and persist across sessions (URL prompts only) #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpServerConfigHttpOauthGrantType { - /// Interactive browser-based authorization code flow with PKCE. - #[serde(rename = "authorization_code")] - AuthorizationCode, - /// Headless client credentials flow using the configured OAuth client. - #[serde(rename = "client_credentials")] - ClientCredentials, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApprovePermanentlyKind { + #[serde(rename = "approve-permanently")] #[default] - #[serde(other)] - Unknown, + ApprovePermanently, } -/// Remote transport type. Defaults to "http" when omitted. +/// Reject the request #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpServerConfigHttpType { - /// Streamable HTTP transport. - #[serde(rename = "http")] - Http, - /// Server-Sent Events transport. - #[serde(rename = "sse")] - Sse, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionRejectKind { + #[serde(rename = "reject")] #[default] - #[serde(other)] - Unknown, + Reject, } -/// How environment-variable values supplied to MCP servers are resolved. "direct" passes literal string values; "indirect" treats values as references (e.g. names of environment variables on the host) that the runtime resolves before launch. Defaults to the runtime's startup mode; clients that intentionally launch MCP servers with literal values (e.g. CLI prompt mode and ACP) set this to "direct". -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// No user is available to confirm the request #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum McpSetEnvValueModeDetails { - /// Treat MCP server environment values as literal strings. - #[serde(rename = "direct")] - Direct, - /// Treat MCP server environment values as host-side references to resolve before launch. - #[serde(rename = "indirect")] - Indirect, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionUserNotAvailableKind { + #[serde(rename = "user-not-available")] #[default] - #[serde(other)] - Unknown, + UserNotAvailable, } -/// Hosting platform type of the repository -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// The permission request was approved #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionWorkingDirectoryContextHostType { - /// The working directory repository is hosted on GitHub. - #[serde(rename = "github")] - Github, - /// The working directory repository is hosted on Azure DevOps. - #[serde(rename = "ado")] - Ado, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApprovedKind { + #[serde(rename = "approved")] #[default] - #[serde(other)] - Unknown, + Approved, } -/// The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot') -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Approved and remembered for the rest of the session #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum MetadataSnapshotCurrentMode { - /// The agent is responding interactively to the user. - #[serde(rename = "interactive")] - Interactive, - /// The agent is preparing a plan before making changes. - #[serde(rename = "plan")] - Plan, - /// The agent is working autonomously toward task completion. - #[serde(rename = "autopilot")] - Autopilot, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApprovedForSessionKind { + #[serde(rename = "approved-for-session")] #[default] - #[serde(other)] - Unknown, + ApprovedForSession, } -/// Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation. -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Approved and persisted for this project location #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum MetadataSnapshotRemoteMetadataTaskType { - /// Remote task originated from Copilot Coding Agent. - #[serde(rename = "cca")] - Cca, - /// Remote task originated from a CLI remote-session invocation. - #[serde(rename = "cli")] - Cli, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionApprovedForLocationKind { + #[serde(rename = "approved-for-location")] #[default] - #[serde(other)] - Unknown, + ApprovedForLocation, } -/// Model capability category for grouping in the model picker +/// The permission request was cancelled before a response was used #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ModelPickerCategory { - /// Lightweight model category optimized for faster, lower-cost interactions. - #[serde(rename = "lightweight")] - Lightweight, - /// Versatile model category suitable for a broad range of tasks. - #[serde(rename = "versatile")] - Versatile, - /// Powerful model category optimized for complex tasks. - #[serde(rename = "powerful")] - Powerful, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionCancelledKind { + #[serde(rename = "cancelled")] #[default] - #[serde(other)] - Unknown, + Cancelled, } -/// Relative cost tier for token-based billing users +/// Denied because approval rules explicitly blocked it #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ModelPickerPriceCategory { - /// Lowest relative token cost tier. - #[serde(rename = "low")] - Low, - /// Medium relative token cost tier. - #[serde(rename = "medium")] - Medium, - /// High relative token cost tier. - #[serde(rename = "high")] - High, - /// Highest relative token cost tier. - #[serde(rename = "very_high")] - VeryHigh, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionDeniedByRulesKind { + #[serde(rename = "denied-by-rules")] #[default] - #[serde(other)] - Unknown, + DeniedByRules, } -/// Current policy state for this model +/// Denied because no approval rule matched and user confirmation was unavailable #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ModelPolicyState { - /// The model is enabled by policy. - #[serde(rename = "enabled")] - Enabled, - /// The model is disabled by policy. - #[serde(rename = "disabled")] - Disabled, - /// No explicit policy is configured for the model. - #[serde(rename = "unconfigured")] - Unconfigured, - /// Unknown variant for forward compatibility. +pub enum PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind { + #[serde(rename = "denied-no-approval-rule-and-could-not-request-from-user")] #[default] - #[serde(other)] - Unknown, + DeniedNoApprovalRuleAndCouldNotRequestFromUser, +} + +/// Denied by the user during an interactive prompt +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionDeniedInteractivelyByUserKind { + #[serde(rename = "denied-interactively-by-user")] + #[default] + DeniedInteractivelyByUser, +} + +/// Denied by the organization's content exclusion policy +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionDeniedByContentExclusionPolicyKind { + #[serde(rename = "denied-by-content-exclusion-policy")] + #[default] + DeniedByContentExclusionPolicy, +} + +/// Denied by a permission request hook registered by an extension or plugin +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionDecisionDeniedByPermissionRequestHookKind { + #[serde(rename = "denied-by-permission-request-hook")] + #[default] + DeniedByPermissionRequestHook, +} + +/// The client's response to the pending permission prompt +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PermissionDecision { + ApproveOnce(PermissionDecisionApproveOnce), + ApproveForSession(PermissionDecisionApproveForSession), + ApproveForLocation(PermissionDecisionApproveForLocation), + ApprovePermanently(PermissionDecisionApprovePermanently), + Reject(PermissionDecisionReject), + UserNotAvailable(PermissionDecisionUserNotAvailable), + Approved(PermissionDecisionApproved), + ApprovedForSession(PermissionDecisionApprovedForSession), + ApprovedForLocation(PermissionDecisionApprovedForLocation), + Cancelled(PermissionDecisionCancelled), + DeniedByRules(PermissionDecisionDeniedByRules), + DeniedNoApprovalRuleAndCouldNotRequestFromUser( + PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser, + ), + DeniedInteractivelyByUser(PermissionDecisionDeniedInteractivelyByUser), + DeniedByContentExclusionPolicy(PermissionDecisionDeniedByContentExclusionPolicy), + DeniedByPermissionRequestHook(PermissionDecisionDeniedByPermissionRequestHook), } +/// Disposition of a permission request as observed by the responding client. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum ModelSwitchToRequestContextTier { - /// Use the model's default context window. - #[serde(rename = "default")] - Default, - /// Pin the session to the long-context tier when supported. - #[serde(rename = "long_context")] - LongContext, +pub enum PermissionDecisionOutcome { + /// The request was approved automatically without a new human decision. + #[serde(rename = "auto_approved")] + AutoApproved, + /// The request was denied without an interactive user decision; source records why. + #[serde(rename = "autopilot_denied")] + AutopilotDenied, + /// The response came from an interactive user prompt. + #[serde(rename = "prompted_user")] + PromptedUser, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch). +/// Controlled reason or actor responsible for a permission response. /// ///
    /// @@ -13950,20 +26589,26 @@ pub enum ModelSwitchToRequestContextTier { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum OptionsUpdateEnvValueMode { - /// Pass MCP server environment values as literal strings. - #[serde(rename = "direct")] - Direct, - /// Resolve MCP server environment values from host-side references. - #[serde(rename = "indirect")] - Indirect, +pub enum PermissionDecisionSource { + /// The response followed the auto-approval judge recommendation. + #[serde(rename = "judge_recommendation")] + JudgeRecommendation, + /// A human supplied the response through an interactive prompt. + #[serde(rename = "human_response")] + HumanResponse, + /// The host applied a standing policy or override rather than a judge recommendation or human decision. + #[serde(rename = "host_policy")] + HostPolicy, + /// The host denied the request because no interactive user response was available. + #[serde(rename = "unattended_fallback")] + UnattendedFallback, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set. +/// Client surface that submitted a permission response. /// ///
    /// @@ -13972,30 +26617,28 @@ pub enum OptionsUpdateEnvValueMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum OptionsUpdateToolFilterPrecedence { - /// If availableTools is set, it is the only constraint that applies (excludedTools is ignored). Preserves CLI / pre-existing client behavior. Default. - #[serde(rename = "available")] - Available, - /// A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND it does not match the denylist. Makes 'all except X' expressible by combining the two lists. - #[serde(rename = "excluded")] - Excluded, +pub enum PermissionDecisionSurface { + /// The interactive Copilot CLI terminal UI. + #[serde(rename = "tui")] + Tui, + /// The non-interactive Copilot CLI prompt mode. + #[serde(rename = "prompt_mode")] + PromptMode, + /// The Copilot App client. + #[serde(rename = "copilot_app")] + CopilotApp, + /// A generic Copilot SDK client. + #[serde(rename = "sdk")] + Sdk, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Approve this single request only -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveOnceKind { - #[serde(rename = "approve-once")] - #[default] - ApproveOnce, -} - /// Approval scoped to specific command identifiers. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalCommandsKind { +pub enum PermissionsLocationsAddToolApprovalDetailsCommandsKind { #[serde(rename = "commands")] #[default] Commands, @@ -14003,7 +26646,7 @@ pub enum PermissionDecisionApproveForSessionApprovalCommandsKind { /// Approval covering read-only filesystem operations. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalReadKind { +pub enum PermissionsLocationsAddToolApprovalDetailsReadKind { #[serde(rename = "read")] #[default] Read, @@ -14011,7 +26654,7 @@ pub enum PermissionDecisionApproveForSessionApprovalReadKind { /// Approval covering filesystem write operations. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalWriteKind { +pub enum PermissionsLocationsAddToolApprovalDetailsWriteKind { #[serde(rename = "write")] #[default] Write, @@ -14019,7 +26662,7 @@ pub enum PermissionDecisionApproveForSessionApprovalWriteKind { /// Approval covering an MCP tool. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalMcpKind { +pub enum PermissionsLocationsAddToolApprovalDetailsMcpKind { #[serde(rename = "mcp")] #[default] Mcp, @@ -14027,7 +26670,7 @@ pub enum PermissionDecisionApproveForSessionApprovalMcpKind { /// Approval covering MCP sampling requests for a server. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalMcpSamplingKind { +pub enum PermissionsLocationsAddToolApprovalDetailsMcpSamplingKind { #[serde(rename = "mcp-sampling")] #[default] McpSampling, @@ -14035,7 +26678,7 @@ pub enum PermissionDecisionApproveForSessionApprovalMcpSamplingKind { /// Approval covering writes to long-term memory. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalMemoryKind { +pub enum PermissionsLocationsAddToolApprovalDetailsMemoryKind { #[serde(rename = "memory")] #[default] Memory, @@ -14043,7 +26686,7 @@ pub enum PermissionDecisionApproveForSessionApprovalMemoryKind { /// Approval covering a custom tool. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalCustomToolKind { +pub enum PermissionsLocationsAddToolApprovalDetailsCustomToolKind { #[serde(rename = "custom-tool")] #[default] CustomTool, @@ -14051,21 +26694,29 @@ pub enum PermissionDecisionApproveForSessionApprovalCustomToolKind { /// Approval covering extension lifecycle operations such as enable, disable, or reload. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalExtensionManagementKind { +pub enum PermissionsLocationsAddToolApprovalDetailsExtensionManagementKind { #[serde(rename = "extension-management")] #[default] ExtensionManagement, } +/// Approval covering factory operations. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsLocationsAddToolApprovalDetailsFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + /// Approval covering an extension's request to access a permission-gated capability. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKind { +pub enum PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind { #[serde(rename = "extension-permission-access")] #[default] ExtensionPermissionAccess, } -/// Session-scoped approval to remember (tool prompts only; omitted for path/url prompts) +/// Tool approval to persist and apply /// ///
    /// @@ -14075,99 +26726,267 @@ pub enum PermissionDecisionApproveForSessionApprovalExtensionPermissionAccessKin ///
    #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(untagged)] -pub enum PermissionDecisionApproveForSessionApproval { - Commands(PermissionDecisionApproveForSessionApprovalCommands), - Read(PermissionDecisionApproveForSessionApprovalRead), - Write(PermissionDecisionApproveForSessionApprovalWrite), - Mcp(PermissionDecisionApproveForSessionApprovalMcp), - McpSampling(PermissionDecisionApproveForSessionApprovalMcpSampling), - Memory(PermissionDecisionApproveForSessionApprovalMemory), - CustomTool(PermissionDecisionApproveForSessionApprovalCustomTool), - ExtensionManagement(PermissionDecisionApproveForSessionApprovalExtensionManagement), - ExtensionPermissionAccess(PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess), +pub enum PermissionsLocationsAddToolApprovalDetails { + Commands(PermissionsLocationsAddToolApprovalDetailsCommands), + Read(PermissionsLocationsAddToolApprovalDetailsRead), + Write(PermissionsLocationsAddToolApprovalDetailsWrite), + Mcp(PermissionsLocationsAddToolApprovalDetailsMcp), + McpSampling(PermissionsLocationsAddToolApprovalDetailsMcpSampling), + Memory(PermissionsLocationsAddToolApprovalDetailsMemory), + CustomTool(PermissionsLocationsAddToolApprovalDetailsCustomTool), + ExtensionManagement(PermissionsLocationsAddToolApprovalDetailsExtensionManagement), + Factory(PermissionsLocationsAddToolApprovalDetailsFactory), + ExtensionPermissionAccess(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess), } -/// Approve and remember for the rest of the session +/// Whether the location is a git repo or directory +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForSessionKind { - #[serde(rename = "approve-for-session")] +pub enum PermissionLocationType { + /// The permission location is persisted at the git repository root. + #[serde(rename = "repo")] + Repo, + /// The permission location is persisted at the working directory. + #[serde(rename = "dir")] + Dir, + /// Unknown variant for forward compatibility. #[default] - ApproveForSession, + #[serde(other)] + Unknown, } -/// Approval scoped to specific command identifiers. +/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalCommandsKind { - #[serde(rename = "commands")] +pub enum PermissionsConfigureAdditionalContentExclusionPolicyScope { + /// The content exclusion policy applies to the current repository. + #[serde(rename = "repo")] + Repo, + /// The content exclusion policy applies across all repositories. + #[serde(rename = "all")] + All, + /// Unknown variant for forward compatibility. #[default] - Commands, + #[serde(other)] + Unknown, } -/// Approval covering read-only filesystem operations. +/// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsModifyRulesScope { + /// Apply the rule change only to this session. + #[serde(rename = "session")] + Session, + /// Persist the rule change for this project location. + #[serde(rename = "location")] + Location, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsSetAllowAllSource { + /// Allow-all was enabled from a CLI command-line flag. + #[serde(rename = "cli_flag")] + CliFlag, + /// Allow-all was enabled by a slash command. + #[serde(rename = "slash_command")] + SlashCommand, + /// Allow-all was enabled by confirming autopilot behavior. + #[serde(rename = "autopilot_confirmation")] + AutopilotConfirmation, + /// Allow-all was enabled through an RPC caller. + #[serde(rename = "rpc")] + Rpc, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionsSetApproveAllSource { + /// Allow-all was enabled from a CLI command-line flag. + #[serde(rename = "cli_flag")] + CliFlag, + /// Allow-all was enabled by a slash command. + #[serde(rename = "slash_command")] + SlashCommand, + /// Allow-all was enabled by confirming autopilot behavior. + #[serde(rename = "autopilot_confirmation")] + AutopilotConfirmation, + /// Allow-all was enabled through an RPC caller. + #[serde(rename = "rpc")] + Rpc, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Transport to be used for provider requests. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ProviderEndpointTransport { + /// HTTP request/streaming transport. + #[serde(rename = "http")] + Http, + /// WebSocket transport. + #[serde(rename = "websockets")] + Websockets, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Provider family. Matches the `type` field of a BYOK provider config. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ProviderEndpointType { + /// OpenAI-compatible endpoint (use the OpenAI client library). + #[serde(rename = "openai")] + Openai, + /// Azure OpenAI endpoint (use the OpenAI client library with the Azure base URL). + #[serde(rename = "azure")] + Azure, + /// Anthropic endpoint (use the Anthropic client library). + #[serde(rename = "anthropic")] + Anthropic, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Wire API to be used, when required for the provider type. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalReadKind { - #[serde(rename = "read")] +pub enum ProviderEndpointWireApi { + /// Classic chat-completions request shape. + #[serde(rename = "completions")] + Completions, + /// Newer responses request shape. + #[serde(rename = "responses")] + Responses, + /// Unknown variant for forward compatibility. #[default] - Read, + #[serde(other)] + Unknown, } -/// Approval covering filesystem write operations. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalWriteKind { - #[serde(rename = "write")] +pub enum PushAttachmentBlobType { + #[serde(rename = "blob")] #[default] - Write, + Blob, } -/// Approval covering an MCP tool. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalMcpKind { - #[serde(rename = "mcp")] +pub enum PushAttachmentDirectoryType { + #[serde(rename = "directory")] #[default] - Mcp, + Directory, } -/// Approval covering MCP sampling requests for a server. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalMcpSamplingKind { - #[serde(rename = "mcp-sampling")] +pub enum PushAttachmentFileType { + #[serde(rename = "file")] #[default] - McpSampling, + File, } -/// Approval covering writes to long-term memory. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalMemoryKind { - #[serde(rename = "memory")] +pub enum PushAttachmentGitHubActionsJobType { + #[serde(rename = "github_actions_job")] #[default] - Memory, + GitHubActionsJob, } -/// Approval covering a custom tool. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalCustomToolKind { - #[serde(rename = "custom-tool")] +pub enum PushAttachmentGitHubCommitType { + #[serde(rename = "github_commit")] #[default] - CustomTool, + GitHubCommit, } -/// Approval covering extension lifecycle operations such as enable, disable, or reload. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalExtensionManagementKind { - #[serde(rename = "extension-management")] +pub enum PushAttachmentGitHubFileType { + #[serde(rename = "github_file")] #[default] - ExtensionManagement, + GitHubFile, } -/// Approval covering an extension's request to access a permission-gated capability. +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKind { - #[serde(rename = "extension-permission-access")] +pub enum PushAttachmentGitHubFileDiffType { + #[serde(rename = "github_file_diff")] #[default] - ExtensionPermissionAccess, + GitHubFileDiff, } -/// Approval to persist for this location +/// Type of GitHub reference /// ///
    /// @@ -14175,127 +26994,272 @@ pub enum PermissionDecisionApproveForLocationApprovalExtensionPermissionAccessKi /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] -#[serde(untagged)] -pub enum PermissionDecisionApproveForLocationApproval { - Commands(PermissionDecisionApproveForLocationApprovalCommands), - Read(PermissionDecisionApproveForLocationApprovalRead), - Write(PermissionDecisionApproveForLocationApprovalWrite), - Mcp(PermissionDecisionApproveForLocationApprovalMcp), - McpSampling(PermissionDecisionApproveForLocationApprovalMcpSampling), - Memory(PermissionDecisionApproveForLocationApprovalMemory), - CustomTool(PermissionDecisionApproveForLocationApprovalCustomTool), - ExtensionManagement(PermissionDecisionApproveForLocationApprovalExtensionManagement), - ExtensionPermissionAccess( - PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess, - ), +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PushAttachmentGitHubReferenceType { + /// GitHub issue reference. + #[serde(rename = "issue")] + Issue, + /// GitHub pull request reference. + #[serde(rename = "pr")] + Pr, + /// GitHub discussion reference. + #[serde(rename = "discussion")] + Discussion, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Approve and persist for this project location +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApproveForLocationKind { - #[serde(rename = "approve-for-location")] +pub enum PushAttachmentGitHubReleaseType { + #[serde(rename = "github_release")] #[default] - ApproveForLocation, + GitHubRelease, } -/// Approve and persist across sessions (URL prompts only) +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApprovePermanentlyKind { - #[serde(rename = "approve-permanently")] +pub enum PushAttachmentGitHubRepositoryType { + #[serde(rename = "github_repository")] #[default] - ApprovePermanently, + GitHubRepository, } -/// Reject the request +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionRejectKind { - #[serde(rename = "reject")] +pub enum PushAttachmentGitHubSnippetType { + #[serde(rename = "github_snippet")] #[default] - Reject, + GitHubSnippet, } -/// No user is available to confirm the request +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionUserNotAvailableKind { - #[serde(rename = "user-not-available")] +pub enum PushAttachmentGitHubTreeComparisonType { + #[serde(rename = "github_tree_comparison")] #[default] - UserNotAvailable, + GitHubTreeComparison, } -/// The permission request was approved +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApprovedKind { - #[serde(rename = "approved")] +pub enum PushAttachmentGitHubUrlType { + #[serde(rename = "github_url")] #[default] - Approved, + GitHubUrl, } -/// Approved and remembered for the rest of the session +/// Attachment type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApprovedForSessionKind { - #[serde(rename = "approved-for-session")] +pub enum PushAttachmentSelectionType { + #[serde(rename = "selection")] #[default] - ApprovedForSession, + Selection, } -/// Approved and persisted for this project location +/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionApprovedForLocationKind { - #[serde(rename = "approved-for-location")] +pub enum SendAgentMode { + /// The agent is responding interactively to the user. + #[serde(rename = "interactive")] + Interactive, + /// The agent is preparing a plan before making changes. + #[serde(rename = "plan")] + Plan, + /// The agent is working autonomously toward task completion. + #[serde(rename = "autopilot")] + Autopilot, + /// The agent is in shell-focused UI mode. + #[serde(rename = "shell")] + Shell, + /// Unknown variant for forward compatibility. #[default] - ApprovedForLocation, + #[serde(other)] + Unknown, } -/// The permission request was cancelled before a response was used +/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionCancelledKind { - #[serde(rename = "cancelled")] +pub enum SendMode { + /// Append the message to the normal session queue. + #[serde(rename = "enqueue")] + Enqueue, + /// Interject the message during the in-progress turn. + #[serde(rename = "immediate")] + Immediate, + /// Unknown variant for forward compatibility. #[default] - Cancelled, + #[serde(other)] + Unknown, } -/// Denied because approval rules explicitly blocked it +/// Whether this item is a queued user message or a queued slash command / model change +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionDeniedByRulesKind { - #[serde(rename = "denied-by-rules")] +pub enum QueuePendingItemsKind { + /// A queued user message. + #[serde(rename = "message")] + Message, + /// A queued slash command or model-change command. + #[serde(rename = "command")] + Command, + /// Unknown variant for forward compatibility. #[default] - DeniedByRules, + #[serde(other)] + Unknown, } -/// Denied because no approval rule matched and user confirmation was unavailable +/// Remote control state tag: active. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind { - #[serde(rename = "denied-no-approval-rule-and-could-not-request-from-user")] +pub enum RemoteControlStatusActiveState { + #[serde(rename = "active")] #[default] - DeniedNoApprovalRuleAndCouldNotRequestFromUser, + Active, } -/// Denied by the user during an interactive prompt +/// Remote control state tag: connecting. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionDeniedInteractivelyByUserKind { - #[serde(rename = "denied-interactively-by-user")] +pub enum RemoteControlStatusConnectingState { + #[serde(rename = "connecting")] #[default] - DeniedInteractivelyByUser, + Connecting, } -/// Denied by the organization's content exclusion policy +/// Remote control state tag: setup failed. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionDeniedByContentExclusionPolicyKind { - #[serde(rename = "denied-by-content-exclusion-policy")] +pub enum RemoteControlStatusErrorState { + #[serde(rename = "error")] #[default] - DeniedByContentExclusionPolicy, + Error, } -/// Denied by a permission request hook registered by an extension or plugin +/// Remote control state tag: not connected. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionDecisionDeniedByPermissionRequestHookKind { - #[serde(rename = "denied-by-permission-request-hook")] +pub enum RemoteControlStatusOffState { + #[serde(rename = "off")] + #[default] + Off, +} + +/// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum RemoteSessionMode { + /// Disable remote session export and steering. + #[serde(rename = "off")] + Off, + /// Export session events to GitHub without enabling remote steering. + #[serde(rename = "export")] + Export, + /// Enable both remote session export and remote steering. + #[serde(rename = "on")] + On, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Whether the remote task originated from CCA or CLI `--remote`. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum RemoteSessionMetadataTaskType { + /// GitHub Copilot coding agent task. + #[serde(rename = "cca")] + Cca, + /// CLI remote task. + #[serde(rename = "cli")] + Cli, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Session capability enabled for this session +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionCapability { + /// TUI-specific prompt hints such as keyboard shortcuts. + #[serde(rename = "tui-hints")] + TuiHints, + /// Plan-mode handling and instructions. + #[serde(rename = "plan-mode")] + PlanMode, + /// Memory tool and memories prompt section. + #[serde(rename = "memory")] + Memory, + /// Copilot CLI documentation tool and prompt section. + #[serde(rename = "cli-documentation")] + CliDocumentation, + /// Interactive ask_user tool support. + #[serde(rename = "ask-user")] + AskUser, + /// Interactive CLI identity and behavior. + #[serde(rename = "interactive-mode")] + InteractiveMode, + /// Automatic hidden system notifications. + #[serde(rename = "system-notifications")] + SystemNotifications, + /// SDK elicitation support. + #[serde(rename = "elicitation")] + Elicitation, + /// Cross-session history tools and session-store SQL prompt/tool metadata. + #[serde(rename = "session-store")] + SessionStore, + /// MCP Apps UI passthrough. + #[serde(rename = "mcp-apps")] + McpApps, + /// Host-provided canvas rendering support. + #[serde(rename = "canvas-renderer")] + CanvasRenderer, + /// Unknown variant for forward compatibility. #[default] - DeniedByPermissionRequestHook, + #[serde(other)] + Unknown, } -/// The client's response to the pending permission prompt +/// Error classification /// ///
    /// @@ -14303,101 +27267,159 @@ pub enum PermissionDecisionDeniedByPermissionRequestHookKind { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] -#[serde(untagged)] -pub enum PermissionDecision { - ApproveOnce(PermissionDecisionApproveOnce), - ApproveForSession(PermissionDecisionApproveForSession), - ApproveForLocation(PermissionDecisionApproveForLocation), - ApprovePermanently(PermissionDecisionApprovePermanently), - Reject(PermissionDecisionReject), - UserNotAvailable(PermissionDecisionUserNotAvailable), - Approved(PermissionDecisionApproved), - ApprovedForSession(PermissionDecisionApprovedForSession), - ApprovedForLocation(PermissionDecisionApprovedForLocation), - Cancelled(PermissionDecisionCancelled), - DeniedByRules(PermissionDecisionDeniedByRules), - DeniedNoApprovalRuleAndCouldNotRequestFromUser( - PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser, - ), - DeniedInteractivelyByUser(PermissionDecisionDeniedInteractivelyByUser), - DeniedByContentExclusionPolicy(PermissionDecisionDeniedByContentExclusionPolicy), - DeniedByPermissionRequestHook(PermissionDecisionDeniedByPermissionRequestHook), -} - -/// Approval scoped to specific command identifiers. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsCommandsKind { - #[serde(rename = "commands")] +pub enum SessionFsErrorCode { + /// The requested path does not exist. + ENOENT, + /// The filesystem operation failed for an unspecified reason. + UNKNOWN, + /// Unknown variant for forward compatibility. #[default] - Commands, + #[serde(other)] + Unknown, } -/// Approval covering read-only filesystem operations. +/// Entry type +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsReadKind { - #[serde(rename = "read")] +pub enum SessionFsReaddirWithTypesEntryType { + /// The entry is a file. + #[serde(rename = "file")] + File, + /// The entry is a directory. + #[serde(rename = "directory")] + Directory, + /// Unknown variant for forward compatibility. #[default] - Read, + #[serde(other)] + Unknown, } -/// Approval covering filesystem write operations. +/// Path conventions used by this filesystem +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsWriteKind { - #[serde(rename = "write")] +pub enum SessionFsSetProviderConventions { + /// Paths use Windows path conventions. + #[serde(rename = "windows")] + Windows, + /// Paths use POSIX path conventions. + #[serde(rename = "posix")] + Posix, + /// Unknown variant for forward compatibility. #[default] - Write, + #[serde(other)] + Unknown, } -/// Approval covering an MCP tool. +/// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsMcpKind { - #[serde(rename = "mcp")] +pub enum SessionFsSqliteQueryType { + /// Execute DDL or multi-statement SQL without returning rows. + #[serde(rename = "exec")] + Exec, + /// Execute a SELECT-style query and return rows. + #[serde(rename = "query")] + Query, + /// Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. + #[serde(rename = "run")] + Run, + /// Unknown variant for forward compatibility. #[default] - Mcp, + #[serde(other)] + Unknown, } -/// Approval covering MCP sampling requests for a server. +/// SQLite transaction failure classification. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsMcpSamplingKind { - #[serde(rename = "mcp-sampling")] +pub enum SessionFsSqliteTransactionErrorClass { + /// SQLite reported BUSY or LOCKED before commit; the transaction was rolled back and may be retried. + #[serde(rename = "busyOrLocked")] + BusyOrLocked, + /// The statement, database, or provider failed definitively and must not be retried automatically. + #[serde(rename = "fatal")] + Fatal, + /// The transport failed after the provider may have committed; retrying could duplicate effects. + #[serde(rename = "postCommitAmbiguous")] + PostCommitAmbiguous, + /// Unknown variant for forward compatibility. #[default] - McpSampling, + #[serde(other)] + Unknown, } -/// Approval covering writes to long-term memory. +/// Constant value. Always "github". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsMemoryKind { - #[serde(rename = "memory")] +pub enum SessionInstalledPluginSourceGitHubSource { + #[serde(rename = "github")] #[default] - Memory, + GitHub, } -/// Approval covering a custom tool. +/// Constant value. Always "local". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsCustomToolKind { - #[serde(rename = "custom-tool")] +pub enum SessionInstalledPluginSourceLocalSource { + #[serde(rename = "local")] #[default] - CustomTool, + Local, } -/// Approval covering extension lifecycle operations such as enable, disable, or reload. +/// Constant value. Always "url". #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsExtensionManagementKind { - #[serde(rename = "extension-management")] +pub enum SessionInstalledPluginSourceUrlSource { + #[serde(rename = "url")] #[default] - ExtensionManagement, + Url, } -/// Approval covering an extension's request to access a permission-gated capability. +/// Client population used for the prediction baseline. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind { - #[serde(rename = "extension-permission-access")] +pub enum SessionLimitPredictionClientType { + /// Interactive CLI sessions where a user can accept, edit, or top up the limit. + #[serde(rename = "cli-interactive")] + CliInteractive, + /// Prompt/non-interactive CLI sessions where the initial limit must cover more of the run. + #[serde(rename = "cli-prompt")] + CliPrompt, + /// Unknown variant for forward compatibility. #[default] - ExtensionPermissionAccess, + #[serde(other)] + Unknown, } -/// Tool approval to persist and apply +/// Semantic usage tier used for a recommended cap or additional headroom. /// ///
    /// @@ -14405,21 +27427,27 @@ pub enum PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccessKind /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Serialize, Deserialize)] -#[serde(untagged)] -pub enum PermissionsLocationsAddToolApprovalDetails { - Commands(PermissionsLocationsAddToolApprovalDetailsCommands), - Read(PermissionsLocationsAddToolApprovalDetailsRead), - Write(PermissionsLocationsAddToolApprovalDetailsWrite), - Mcp(PermissionsLocationsAddToolApprovalDetailsMcp), - McpSampling(PermissionsLocationsAddToolApprovalDetailsMcpSampling), - Memory(PermissionsLocationsAddToolApprovalDetailsMemory), - CustomTool(PermissionsLocationsAddToolApprovalDetailsCustomTool), - ExtensionManagement(PermissionsLocationsAddToolApprovalDetailsExtensionManagement), - ExtensionPermissionAccess(PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess), +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitPredictionTier { + /// Recommended starting tier. + #[serde(rename = "recommended")] + Recommended, + /// Additional headroom for longer-running sessions. + #[serde(rename = "additional_headroom")] + AdditionalHeadroom, + /// Generous headroom for unusually high usage. + #[serde(rename = "generous_headroom")] + GenerousHeadroom, + /// Maximum available headroom tier. + #[serde(rename = "maximum_headroom")] + MaximumHeadroom, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, } -/// Whether the location is a git repo or directory +/// Baseline fallback level used to create the prediction. /// ///
    /// @@ -14428,20 +27456,37 @@ pub enum PermissionsLocationsAddToolApprovalDetails { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionLocationType { - /// The permission location is persisted at the git repository root. - #[serde(rename = "repo")] - Repo, - /// The permission location is persisted at the working directory. - #[serde(rename = "dir")] - Dir, +pub enum SessionLimitPredictionSource { + /// The prediction used the exact resolved model's baseline cell. + #[serde(rename = "model")] + Model, + /// The exact model was unavailable, so the prediction used the model family's baseline cell. + #[serde(rename = "family")] + Family, + /// No model or family cell was available, so the prediction used the global client-type baseline cell. + #[serde(rename = "global")] + Global, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitPredictionResultAvailableKind { + #[serde(rename = "available")] + #[default] + Available, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitPredictionResultUnavailableKind { + #[serde(rename = "unavailable")] + #[default] + Unavailable, +} + +/// Reason a prediction could not be computed. /// ///
    /// @@ -14450,20 +27495,35 @@ pub enum PermissionLocationType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsConfigureAdditionalContentExclusionPolicyScope { - /// The content exclusion policy applies to the current repository. - #[serde(rename = "repo")] - Repo, - /// The content exclusion policy applies across all repositories. - #[serde(rename = "all")] - All, +pub enum SessionLimitPredictionUnavailableReason { + /// The current model is auto and has not resolved to a concrete model yet. + #[serde(rename = "auto_unresolved")] + AutoUnresolved, + /// No model was provided and the session does not currently have a selected model. + #[serde(rename = "no_model")] + NoModel, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file. +/// Prediction result. Available results include prediction details; unavailable results include an explicit reason. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SessionLimitPredictionResult { + Available(SessionLimitPredictionResultAvailable), + Unavailable(SessionLimitPredictionResultUnavailable), +} + +/// Repository host type, if known /// ///
    /// @@ -14472,20 +27532,20 @@ pub enum PermissionsConfigureAdditionalContentExclusionPolicyScope { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsModifyRulesScope { - /// Apply the rule change only to this session. - #[serde(rename = "session")] - Session, - /// Persist the rule change for this project location. - #[serde(rename = "location")] - Location, +pub enum WorkspaceSummaryHostType { + /// Workspace summary repository is hosted on GitHub. + #[serde(rename = "github")] + GitHub, + /// Workspace summary repository is hosted on Azure DevOps. + #[serde(rename = "ado")] + Ado, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration. /// ///
    /// @@ -14494,26 +27554,20 @@ pub enum PermissionsModifyRulesScope { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsSetAllowAllSource { - /// Allow-all was enabled from a CLI command-line flag. - #[serde(rename = "cli_flag")] - CliFlag, - /// Allow-all was enabled by a slash command. - #[serde(rename = "slash_command")] - SlashCommand, - /// Allow-all was enabled by confirming autopilot behavior. - #[serde(rename = "autopilot_confirmation")] - AutopilotConfirmation, - /// Allow-all was enabled through an RPC caller. - #[serde(rename = "rpc")] - Rpc, +pub enum SessionOpenOptionsAdditionalContentExclusionPolicyScope { + /// The content exclusion policy applies to the current repository. + #[serde(rename = "repo")] + Repo, + /// The content exclusion policy applies across all repositories. + #[serde(rename = "all")] + All, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers. +/// How MCP server environment values are interpreted. /// ///
    /// @@ -14522,26 +27576,20 @@ pub enum PermissionsSetAllowAllSource { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum PermissionsSetApproveAllSource { - /// Allow-all was enabled from a CLI command-line flag. - #[serde(rename = "cli_flag")] - CliFlag, - /// Allow-all was enabled by a slash command. - #[serde(rename = "slash_command")] - SlashCommand, - /// Allow-all was enabled by confirming autopilot behavior. - #[serde(rename = "autopilot_confirmation")] - AutopilotConfirmation, - /// Allow-all was enabled through an RPC caller. - #[serde(rename = "rpc")] - Rpc, +pub enum SessionOpenOptionsEnvValueMode { + /// Pass MCP server environment values as literal strings. + #[serde(rename = "direct")] + Direct, + /// Resolve MCP server environment values from host-side references. + #[serde(rename = "indirect")] + Indirect, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Whether this item is a queued user message or a queued slash command / model change +/// Initial reasoning summary mode for supported model clients. /// ///
    /// @@ -14550,20 +27598,23 @@ pub enum PermissionsSetApproveAllSource { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum QueuePendingItemsKind { - /// A queued user message. - #[serde(rename = "message")] - Message, - /// A queued slash command or model-change command. - #[serde(rename = "command")] - Command, +pub enum SessionOpenOptionsReasoningSummary { + /// Do not request reasoning summaries from the model. + #[serde(rename = "none")] + None, + /// Request a concise summary of model reasoning. + #[serde(rename = "concise")] + Concise, + /// Request a detailed summary of model reasoning. + #[serde(rename = "detailed")] + Detailed, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Per-session remote mode. "off" disables remote, "export" exports session events to GitHub without enabling remote steering, "on" enables both export and remote steering. +/// Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected. /// ///
    /// @@ -14572,23 +27623,20 @@ pub enum QueuePendingItemsKind { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum RemoteSessionMode { - /// Disable remote session export and steering. - #[serde(rename = "off")] - Off, - /// Export session events to GitHub without enabling remote steering. - #[serde(rename = "export")] - Export, - /// Enable both remote session export and remote steering. - #[serde(rename = "on")] - On, +pub enum ShellInitProfile { + /// Disable automatic non-interactive profile loading. Explicit initScripts still run. + #[serde(rename = "none")] + None, + /// Allow automatic non-interactive profile loading when supported. Explicit initScripts still run. + #[serde(rename = "non-interactive")] + NonInteractive, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// The UI mode the agent was in when this message was sent. Defaults to the session's current mode. +/// Supported built-in shells for initialization scripts. /// ///
    /// @@ -14597,83 +27645,76 @@ pub enum RemoteSessionMode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAgentMode { - /// The agent is responding interactively to the user. - #[serde(rename = "interactive")] - Interactive, - /// The agent is preparing a plan before making changes. - #[serde(rename = "plan")] - Plan, - /// The agent is working autonomously toward task completion. - #[serde(rename = "autopilot")] - Autopilot, - /// The agent is in shell-focused UI mode. - #[serde(rename = "shell")] - Shell, +pub enum ShellInitScriptShell { + /// Source the script in the built-in Bash shell on macOS and Linux. + #[serde(rename = "bash")] + Bash, + /// Source the script in the built-in PowerShell shell on Windows. + #[serde(rename = "powershell")] + Powershell, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Attachment type discriminator +/// Create a new local session. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAttachmentBlobType { - #[serde(rename = "blob")] +pub enum SessionsOpenCreateKind { + #[serde(rename = "create")] #[default] - Blob, + Create, } -/// Attachment type discriminator +/// Resume a specific local session by ID or prefix. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAttachmentDirectoryType { - #[serde(rename = "directory")] +pub enum SessionsOpenResumeKind { + #[serde(rename = "resume")] #[default] - Directory, + Resume, } -/// Attachment type discriminator +/// Resume the most relevant existing local session. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAttachmentFileType { - #[serde(rename = "file")] +pub enum SessionsOpenResumeLastKind { + #[serde(rename = "resumeLast")] #[default] - File, + ResumeLast, } -/// Type of GitHub reference -/// -///
    -/// -/// **Experimental.** This type is part of an experimental wire-protocol surface -/// and may change or be removed in future SDK or CLI releases. -/// -///
    +/// Attach to an already-active in-process session by ID. Unlike `resume`, this does NOT re-load from disk; the session must already be loaded by an earlier `create`/`resume` call. Returns `status: 'not_found'` when no active session matches the id. Useful for in-process consumers that need a fresh API handle to a session opened elsewhere (e.g., a peer foreground-session switch). #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAttachmentGithubReferenceType { - /// GitHub issue reference. - #[serde(rename = "issue")] - Issue, - /// GitHub pull request reference. - #[serde(rename = "pr")] - Pr, - /// GitHub discussion reference. - #[serde(rename = "discussion")] - Discussion, - /// Unknown variant for forward compatibility. +pub enum SessionsOpenAttachKind { + #[serde(rename = "attach")] #[default] - #[serde(other)] - Unknown, + Attach, } -/// Attachment type discriminator +/// Connect to a live remote session. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendAttachmentSelectionType { - #[serde(rename = "selection")] +pub enum SessionsOpenRemoteKind { + #[serde(rename = "remote")] #[default] - Selection, + Remote, } -/// How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn. +/// Create a new cloud (coding-agent) session. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionsOpenCloudKind { + #[serde(rename = "cloud")] + #[default] + Cloud, +} + +/// Fetch a remote session and hand it off to a new local session. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionsOpenHandoffKind { + #[serde(rename = "handoff")] + #[default] + Handoff, +} + +/// Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session). /// ///
    /// @@ -14682,20 +27723,20 @@ pub enum SendAttachmentSelectionType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SendMode { - /// Append the message to the normal session queue. - #[serde(rename = "enqueue")] - Enqueue, - /// Interject the message during the in-progress turn. - #[serde(rename = "immediate")] - Immediate, +pub enum SessionsOpenHandoffTaskType { + /// GitHub Copilot coding agent task. + #[serde(rename = "cca")] + Cca, + /// CLI remote task. + #[serde(rename = "cli")] + Cli, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Repository host type +/// Open a session by creating, resuming, attaching, connecting to a remote, or handing off. /// ///
    /// @@ -14703,21 +27744,19 @@ pub enum SendMode { /// and may change or be removed in future SDK or CLI releases. /// ///
    -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionContextHostType { - /// Session repository is hosted on GitHub. - #[serde(rename = "github")] - Github, - /// Session repository is hosted on Azure DevOps. - #[serde(rename = "ado")] - Ado, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SessionOpenParams { + Create(SessionsOpenCreate), + Resume(SessionsOpenResume), + ResumeLast(SessionsOpenResumeLast), + Attach(SessionsOpenAttach), + Remote(SessionsOpenRemote), + Cloud(SessionsOpenCloud), + Handoff(SessionsOpenHandoff), } -/// Error classification +/// Step status. /// ///
    /// @@ -14726,18 +27765,20 @@ pub enum SessionContextHostType { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionFsErrorCode { - /// The requested path does not exist. - ENOENT, - /// The filesystem operation failed for an unspecified reason. - UNKNOWN, +pub enum SessionsOpenProgressStatus { + /// The step has started and has not yet finished. + #[serde(rename = "in-progress")] + InProgress, + /// The step has completed successfully. + #[serde(rename = "complete")] + Complete, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Entry type +/// Handoff step. /// ///
    /// @@ -14746,35 +27787,63 @@ pub enum SessionFsErrorCode { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionFsReaddirWithTypesEntryType { - /// The entry is a file. - #[serde(rename = "file")] - File, - /// The entry is a directory. - #[serde(rename = "directory")] - Directory, +pub enum SessionsOpenProgressStep { + /// Loading the source session's events from the remote service. + #[serde(rename = "load-session")] + LoadSession, + /// Validating that the local repository matches the remote session's repository. + #[serde(rename = "validate-repo")] + ValidateRepo, + /// Checking the local working tree for uncommitted changes that would block the handoff. + #[serde(rename = "check-changes")] + CheckChanges, + /// Checking out the branch associated with the remote session in the local working tree. + #[serde(rename = "checkout-branch")] + CheckoutBranch, + /// Creating the new local session and seeding it with the source session's events. + #[serde(rename = "create-session")] + CreateSession, + /// Persisting the newly-created local session to disk. + #[serde(rename = "save-session")] + SaveSession, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Path conventions used by this filesystem +/// Outcome of the open request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionFsSetProviderConventions { - /// Paths use Windows path conventions. - #[serde(rename = "windows")] - Windows, - /// Paths use POSIX path conventions. - #[serde(rename = "posix")] - Posix, +pub enum SessionsOpenStatus { + /// A new session was created. + #[serde(rename = "created")] + Created, + /// An existing session was loaded or reattached. + #[serde(rename = "resumed")] + Resumed, + /// No matching persisted session was found. + #[serde(rename = "not_found")] + NotFound, + /// Connected to an existing remote session. + #[serde(rename = "connected")] + Connected, + /// Remote session was handed off to a new local session. + #[serde(rename = "handed_off")] + HandedOff, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected) +/// Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract. /// ///
    /// @@ -14783,47 +27852,96 @@ pub enum SessionFsSetProviderConventions { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionFsSqliteQueryType { - /// Execute DDL or multi-statement SQL without returning rows. - #[serde(rename = "exec")] - Exec, - /// Execute a SELECT-style query and return rows. - #[serde(rename = "query")] - Query, - /// Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. - #[serde(rename = "run")] - Run, +pub enum SessionSettingsPredicateName { + /// Whether the security-tools feature flag enables security tool wiring. + #[serde(rename = "securityToolsEnabled")] + SecurityToolsEnabled, + /// Whether third-party security tools should receive the security prompt. + #[serde(rename = "thirdPartySecurityPromptEnabled")] + ThirdPartySecurityPromptEnabled, + /// Whether validation may run in parallel. + #[serde(rename = "parallelValidationEnabled")] + ParallelValidationEnabled, + /// Whether runtime timing telemetry is enabled. + #[serde(rename = "runtimeTimingTelemetryEnabled")] + RuntimeTimingTelemetryEnabled, + /// Whether the co-author hook is enabled. + #[serde(rename = "coAuthorHookEnabled")] + CoAuthorHookEnabled, + /// Whether Chronicle integration is enabled. + #[serde(rename = "chronicleEnabled")] + ChronicleEnabled, + /// Whether content-exclusion policy may self-fetch data. + #[serde(rename = "contentExclusionSelfFetchEnabled")] + ContentExclusionSelfFetchEnabled, + /// Whether Claude Opus token-limit caps should be applied. + #[serde(rename = "capClaudeOpusTokenLimitsEnabled")] + CapClaudeOpusTokenLimitsEnabled, + /// Whether code-review behavior is enabled. + #[serde(rename = "codeReviewFeatureEnabled")] + CodeReviewFeatureEnabled, + /// Whether CCA should use the TypeScript autofind behavior. + #[serde(rename = "ccaUseTsAutofindEnabled")] + CcaUseTsAutofindEnabled, + /// Whether the dependency checker is enabled. + #[serde(rename = "dependencyCheckerEnabled")] + DependencyCheckerEnabled, + /// Whether the Dependabot checker is enabled. + #[serde(rename = "dependabotCheckerEnabled")] + DependabotCheckerEnabled, + /// Whether the CodeQL checker is enabled. + #[serde(rename = "codeqlCheckerEnabled")] + CodeqlCheckerEnabled, + /// Whether trivial-change handling is enabled. + #[serde(rename = "trivialChangeEnabled")] + TrivialChangeEnabled, + /// Whether trivial-change skip behavior is enabled. + #[serde(rename = "trivialChangeSkipEnabled")] + TrivialChangeSkipEnabled, + /// Whether trivial-change handling is enabled for code review. + #[serde(rename = "trivialChangeEnabledForCodeReview")] + TrivialChangeEnabledForCodeReview, + /// Whether trivial-change skip behavior is enabled for code review. + #[serde(rename = "trivialChangeSkipEnabledForCodeReview")] + TrivialChangeSkipEnabledForCodeReview, + /// Whether trivial-change handling is enabled for a specific tool. + #[serde(rename = "trivialChangeEnabledForTool")] + TrivialChangeEnabledForTool, + /// Whether trivial-change skip behavior is enabled for a specific tool. + #[serde(rename = "trivialChangeSkipEnabledForTool")] + TrivialChangeSkipEnabledForTool, /// Unknown variant for forward compatibility. #[default] #[serde(other)] Unknown, } -/// Constant value. Always "github". -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionInstalledPluginSourceGithubSource { - #[serde(rename = "github")] - #[default] - Github, -} - -/// Constant value. Always "local". +/// Which session sources to include. Defaults to `local` for backward compatibility. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionInstalledPluginSourceLocalSource { +pub enum SessionSource { + /// Return only local sessions. #[serde(rename = "local")] - #[default] Local, -} - -/// Constant value. Always "url". -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionInstalledPluginSourceUrlSource { - #[serde(rename = "url")] + /// Return only remote sessions. + #[serde(rename = "remote")] + Remote, + /// Return both local and remote sessions. + #[serde(rename = "all")] + All, + /// Unknown variant for forward compatibility. #[default] - Url, + #[serde(other)] + Unknown, } -/// Repository host type, if known +/// Sharing status for a synced session. "repo" makes the session visible to anyone with read access to the repository; "unshared" restricts it to the creator and collaborators. /// ///
    /// @@ -14832,13 +27950,13 @@ pub enum SessionInstalledPluginSourceUrlSource { /// ///
    #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum WorkspaceSummaryHostType { - /// Workspace summary repository is hosted on GitHub. - #[serde(rename = "github")] - Github, - /// Workspace summary repository is hosted on Azure DevOps. - #[serde(rename = "ado")] - Ado, +pub enum SessionVisibilityStatus { + /// The session is visible to repository readers. + #[serde(rename = "repo")] + Repo, + /// The session is restricted to its creator and collaborators. + #[serde(rename = "unshared")] + Unshared, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -14867,6 +27985,34 @@ pub enum ShellKillSignal { Unknown, } +/// Which tier this directory belongs to +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SkillDiscoveryScope { + /// A project's repository skill directory. + #[serde(rename = "project")] + Project, + /// The user's personal Copilot skill directory. + #[serde(rename = "personal-copilot")] + PersonalCopilot, + /// The user's personal agents skill directory. + #[serde(rename = "personal-agents")] + PersonalAgents, + /// A configured custom skill directory. + #[serde(rename = "custom")] + Custom, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Agent prompt result discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SlashCommandAgentPromptResultKind { @@ -14899,7 +28045,7 @@ pub enum SlashCommandSelectSubcommandResultKind { SelectSubcommand, } -/// Result of invoking the slash command (text output, prompt to send to the agent, or completion). +/// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). /// ///
    /// @@ -14916,6 +28062,31 @@ pub enum SlashCommandInvocationResult { SelectSubcommand(SlashCommandSelectSubcommandResult), } +/// Context tier override for matching subagents +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SubagentSettingsEntryContextTier { + /// Inherit the parent session's effective context tier at dispatch time. + #[serde(rename = "inherit")] + Inherit, + /// Use the model's default context window. + #[serde(rename = "default")] + Default, + /// Pin the subagent to the long-context tier when supported. + #[serde(rename = "long_context")] + LongContext, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Whether task execution is synchronously awaited or managed in the background /// ///
    @@ -15223,6 +28394,34 @@ pub enum UIExitPlanModeAction { Unknown, } +/// User action selected for an exhausted session limit. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum UISessionLimitsExhaustedResponseAction { + /// Increase the current max by an exact AI Credits amount. + #[serde(rename = "add")] + Add, + /// Set a new absolute max AI Credits value. + #[serde(rename = "set")] + Set, + /// Remove the current session limit. + #[serde(rename = "unset")] + Unset, + /// Leave the limit unchanged and cancel the blocked model request. + #[serde(rename = "cancel")] + Cancel, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum UserAuthInfoType { @@ -15275,6 +28474,9 @@ pub enum WorkspaceDiffMode { /// Return changes compared with the default branch. #[serde(rename = "branch")] Branch, + /// Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). + #[serde(rename = "session")] + Session, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -15293,7 +28495,7 @@ pub enum WorkspaceDiffMode { pub enum WorkspacesWorkspaceDetailsHostType { /// Workspace repository is hosted on GitHub. #[serde(rename = "github")] - Github, + GitHub, /// Workspace repository is hosted on Azure DevOps. #[serde(rename = "ado")] Ado, diff --git a/rust/src/generated/mod.rs b/rust/src/generated/mod.rs index 5466a5e35..fcbba4170 100644 --- a/rust/src/generated/mod.rs +++ b/rust/src/generated/mod.rs @@ -1,4 +1,14 @@ -//! Auto-generated protocol types — do not edit manually. +//! Auto-generated protocol types — **not part of the public API**. +//! +//! This module is crate-private. Its layout, item visibility, and +//! naming may change at any time without notice. +//! +//! Public callers reach the generated types through the stable +//! re-export modules at the crate root: +//! +//! - [`crate::session_events`] for session event payload types +//! - [`crate::rpc`] for JSON-RPC request/response types and typed +//! namespace builders //! //! Generated from the Copilot protocol JSON Schemas by `scripts/codegen/rust.ts`. #![allow(missing_docs)] diff --git a/rust/src/generated/rpc.rs b/rust/src/generated/rpc.rs index 422bf7b83..fae4d7e16 100644 --- a/rust/src/generated/rpc.rs +++ b/rust/src/generated/rpc.rs @@ -7,6 +7,8 @@ #![allow(missing_docs)] #![allow(clippy::too_many_arguments)] +#![allow(deprecated)] +#![allow(dead_code)] use super::api_types::{rpc_methods, *}; use super::session_events::SessionMode; @@ -34,6 +36,48 @@ impl<'a> ClientRpc<'a> { } } + /// `agents.*` sub-namespace. + pub fn agents(&self) -> ClientRpcAgents<'a> { + ClientRpcAgents { + client: self.client, + } + } + + /// `commands.*` sub-namespace. + pub fn commands(&self) -> ClientRpcCommands<'a> { + ClientRpcCommands { + client: self.client, + } + } + + /// `extensions.*` sub-namespace. + pub fn extensions(&self) -> ClientRpcExtensions<'a> { + ClientRpcExtensions { + client: self.client, + } + } + + /// `instructions.*` sub-namespace. + pub fn instructions(&self) -> ClientRpcInstructions<'a> { + ClientRpcInstructions { + client: self.client, + } + } + + /// `llmInference.*` sub-namespace. + pub fn llm_inference(&self) -> ClientRpcLlmInference<'a> { + ClientRpcLlmInference { + client: self.client, + } + } + + /// `managedSettings.*` sub-namespace. + pub fn managed_settings(&self) -> ClientRpcManagedSettings<'a> { + ClientRpcManagedSettings { + client: self.client, + } + } + /// `mcp.*` sub-namespace. pub fn mcp(&self) -> ClientRpcMcp<'a> { ClientRpcMcp { @@ -48,6 +92,20 @@ impl<'a> ClientRpc<'a> { } } + /// `plugins.*` sub-namespace. + pub fn plugins(&self) -> ClientRpcPlugins<'a> { + ClientRpcPlugins { + client: self.client, + } + } + + /// `runtime.*` sub-namespace. + pub fn runtime(&self) -> ClientRpcRuntime<'a> { + ClientRpcRuntime { + client: self.client, + } + } + /// `secrets.*` sub-namespace. pub fn secrets(&self) -> ClientRpcSecrets<'a> { ClientRpcSecrets { @@ -101,6 +159,14 @@ impl<'a> ClientRpc<'a> { /// # Returns /// /// Server liveness response, including the echoed message, current server timestamp, and protocol version. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    pub async fn ping(&self, params: PingRequest) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self @@ -110,17 +176,25 @@ impl<'a> ClientRpc<'a> { Ok(serde_json::from_value(_value)?) } - /// Performs the SDK server connection handshake and validates the optional connection token. + /// Performs the SDK server connection handshake and validates the optional connection token. Marked internal because this is JSON-RPC transport plumbing invoked automatically by an SDK client's own `connect()` wrapper, not a user-facing method. Stays internal as long as the SDK client owns the handshake; would only become public if the SDK ever exposed the raw schema surface to consumers without a connection wrapper. /// /// Wire method: `connect`. /// /// # Parameters /// - /// * `params` - Optional connection token presented by the SDK client during the handshake. + /// * `params` - Parameters for the `server.connect` handshake: an optional connection token and optional connection-level opt-ins (e.g. GitHub telemetry forwarding). /// /// # Returns /// /// Handshake result reporting the server's protocol version and package version on success. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    pub(crate) async fn connect(&self, params: ConnectRequest) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self @@ -129,6 +203,29 @@ impl<'a> ClientRpc<'a> { .await?; Ok(serde_json::from_value(_value)?) } + + /// Registers the calling SDK client as the per-entrypoint extension launch provider. Call before creating any sessions. When omitted, the runtime temporarily falls back to its built-in Node launcher for backward compatibility. + /// + /// Wire method: `registerExtensionLaunchProvider`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn register_extension_launch_provider(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call( + rpc_methods::REGISTEREXTENSIONLAUNCHPROVIDER, + Some(wire_params), + ) + .await?; + Ok(()) + } } /// `account.*` RPCs. @@ -145,6 +242,14 @@ impl<'a> ClientRpcAccount<'a> { /// # Returns /// /// Quota usage snapshots for the resolved user, keyed by quota type. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    pub async fn get_quota(&self) -> Result { let wire_params = serde_json::json!({}); let _value = self @@ -165,6 +270,14 @@ impl<'a> ClientRpcAccount<'a> { /// # Returns /// /// Quota usage snapshots for the resolved user, keyed by quota type. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    pub async fn get_quota_with_params( &self, params: AccountGetQuotaRequest, @@ -176,6 +289,110 @@ impl<'a> ClientRpcAccount<'a> { .await?; Ok(serde_json::from_value(_value)?) } + + /// Gets the currently active authentication credentials from the global auth manager. + /// + /// Wire method: `account.getCurrentAuth`. + /// + /// # Returns + /// + /// Current authentication state + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_current_auth(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::ACCOUNT_GETCURRENTAUTH, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Gets all authenticated users available for account switching. + /// + /// Wire method: `account.getAllUsers`. + /// + /// # Returns + /// + /// List of all authenticated users + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_all_users(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::ACCOUNT_GETALLUSERS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Stores authentication credentials after successful login (e.g., device code flow). + /// + /// Wire method: `account.login`. + /// + /// # Parameters + /// + /// * `params` - Credentials to store after successful authentication + /// + /// # Returns + /// + /// Result of a successful login; throws on failure + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn login(&self, params: AccountLoginRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::ACCOUNT_LOGIN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Removes user authentication from keychain and persisted state. + /// + /// Wire method: `account.logout`. + /// + /// # Parameters + /// + /// * `params` - User to log out + /// + /// # Returns + /// + /// Logout result indicating if more users remain + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn logout(&self, params: AccountLogoutRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::ACCOUNT_LOGOUT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } } /// `agentRegistry.*` RPCs. @@ -217,281 +434,300 @@ impl<'a> ClientRpcAgentRegistry<'a> { } } -/// `mcp.*` RPCs. +/// `agents.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcMcp<'a> { +pub struct ClientRpcAgents<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcMcp<'a> { - /// `mcp.config.*` sub-namespace. - pub fn config(&self) -> ClientRpcMcpConfig<'a> { - ClientRpcMcpConfig { - client: self.client, - } +impl<'a> ClientRpcAgents<'a> { + /// Discovers custom agents across user, project, plugin, and remote sources. + /// + /// Wire method: `agents.discover`. + /// + /// # Parameters + /// + /// * `params` - Optional project paths to include in agent discovery. + /// + /// # Returns + /// + /// Agents discovered across user, project, plugin, and remote sources. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn discover(&self, params: AgentsDiscoverRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::AGENTS_DISCOVER, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } - /// Discovers MCP servers from user, workspace, plugin, and builtin sources. + /// Returns the canonical directories where a client may create custom agents that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. /// - /// Wire method: `mcp.discover`. + /// Wire method: `agents.getDiscoveryPaths`. /// /// # Parameters /// - /// * `params` - Optional working directory used as context for MCP server discovery. + /// * `params` - Optional project paths to include when enumerating agent discovery directories. /// /// # Returns /// - /// MCP servers discovered from user, workspace, plugin, and built-in sources. - pub async fn discover(&self, params: McpDiscoverRequest) -> Result { + /// Canonical locations where custom agents can be created so the runtime will recognize them. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_discovery_paths( + &self, + params: AgentsGetDiscoveryPathsRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::MCP_DISCOVER, Some(wire_params)) + .call(rpc_methods::AGENTS_GETDISCOVERYPATHS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `mcp.config.*` RPCs. +/// `commands.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcMcpConfig<'a> { +pub struct ClientRpcCommands<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcMcpConfig<'a> { - /// Lists MCP servers from user configuration. +impl<'a> ClientRpcCommands<'a> { + /// Lists the well-known built-in slash commands that work as the first message in a new session (e.g. /plan, /env), without requiring an active session. Commands that depend on session state, authentication, or a synced session are omitted. /// - /// Wire method: `mcp.config.list`. + /// Wire method: `commands.list`. /// /// # Returns /// - /// User-configured MCP servers, keyed by server name. - pub async fn list(&self) -> Result { + /// Slash commands available in the session, after applying any include/exclude filters. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::MCP_CONFIG_LIST, Some(wire_params)) + .call(rpc_methods::COMMANDS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Adds an MCP server to user configuration. +/// `extensions.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcExtensions<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcExtensions<'a> { + /// Discovers user and enabled installed-plugin extensions from persisted Copilot home state, including enablement preferences. Launch-scoped additional plugins are not included. /// - /// Wire method: `mcp.config.add`. + /// Wire method: `extensions.discover`. /// - /// # Parameters + /// # Returns /// - /// * `params` - MCP server name and configuration to add to user configuration. - pub async fn add(&self, params: McpConfigAddRequest) -> Result<(), Error> { - let wire_params = serde_json::to_value(params)?; + /// Extensions discovered from persisted Copilot home state and their effective loading mode. Launch-scoped additional plugins are not included. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn discover(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::MCP_CONFIG_ADD, Some(wire_params)) + .call(rpc_methods::EXTENSIONS_DISCOVER, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Updates an MCP server in user configuration. + /// Persistently enables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.enable to update them. /// - /// Wire method: `mcp.config.update`. + /// Wire method: `extensions.enable`. /// /// # Parameters /// - /// * `params` - MCP server name and replacement configuration to write to user configuration. - pub async fn update(&self, params: McpConfigUpdateRequest) -> Result<(), Error> { - let wire_params = serde_json::to_value(params)?; - let _value = self - .client - .call(rpc_methods::MCP_CONFIG_UPDATE, Some(wire_params)) - .await?; - Ok(()) - } - - /// Removes an MCP server from user configuration. + /// * `params` - Source-qualified extension identifiers to persistently enable for future sessions. /// - /// Wire method: `mcp.config.remove`. + ///
    /// - /// # Parameters + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. /// - /// * `params` - MCP server name to remove from user configuration. - pub async fn remove(&self, params: McpConfigRemoveRequest) -> Result<(), Error> { + ///
    + pub async fn enable(&self, params: DiscoveredExtensionsEnableRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::MCP_CONFIG_REMOVE, Some(wire_params)) + .call(rpc_methods::EXTENSIONS_ENABLE, Some(wire_params)) .await?; Ok(()) } - /// Enables MCP servers in user configuration for new sessions. + /// Persistently disables extension IDs for future sessions. Active sessions are unchanged; use session.extensions.disable to update them. /// - /// Wire method: `mcp.config.enable`. + /// Wire method: `extensions.disable`. /// /// # Parameters /// - /// * `params` - MCP server names to enable for new sessions. - pub async fn enable(&self, params: McpConfigEnableRequest) -> Result<(), Error> { - let wire_params = serde_json::to_value(params)?; - let _value = self - .client - .call(rpc_methods::MCP_CONFIG_ENABLE, Some(wire_params)) - .await?; - Ok(()) - } - - /// Disables MCP servers in user configuration for new sessions. + /// * `params` - Source-qualified extension identifiers to persistently disable for future sessions. /// - /// Wire method: `mcp.config.disable`. + ///
    /// - /// # Parameters + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. /// - /// * `params` - MCP server names to disable for new sessions. - pub async fn disable(&self, params: McpConfigDisableRequest) -> Result<(), Error> { + ///
    + pub async fn disable(&self, params: DiscoveredExtensionsDisableRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::MCP_CONFIG_DISABLE, Some(wire_params)) - .await?; - Ok(()) - } - - /// Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk. - /// - /// Wire method: `mcp.config.reload`. - pub async fn reload(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({}); - let _value = self - .client - .call(rpc_methods::MCP_CONFIG_RELOAD, Some(wire_params)) + .call(rpc_methods::EXTENSIONS_DISABLE, Some(wire_params)) .await?; Ok(()) } } -/// `models.*` RPCs. +/// `instructions.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcModels<'a> { +pub struct ClientRpcInstructions<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcModels<'a> { - /// Lists Copilot models available to the authenticated user. +impl<'a> ClientRpcInstructions<'a> { + /// Discovers instruction sources across user, repository, and plugin sources. /// - /// Wire method: `models.list`. + /// Wire method: `instructions.discover`. /// - /// # Returns + /// # Parameters /// - /// List of Copilot models available to the resolved user, including capabilities and billing metadata. - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({}); - let _value = self - .client - .call(rpc_methods::MODELS_LIST, Some(wire_params)) - .await?; - Ok(serde_json::from_value(_value)?) - } - - /// Lists Copilot models available to the authenticated user. + /// * `params` - Optional project paths to include in instruction discovery. /// - /// Wire method: `models.list`. + /// # Returns /// - /// # Parameters + /// Instruction sources discovered across user, repository, and plugin sources. /// - /// * `params` - Optional GitHub token used to list models for a specific user instead of the global auth context. + ///
    /// - /// # Returns + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. /// - /// List of Copilot models available to the resolved user, including capabilities and billing metadata. - pub async fn list_with_params(&self, params: ModelsListRequest) -> Result { + ///
    + pub async fn discover( + &self, + params: InstructionsDiscoverRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::MODELS_LIST, Some(wire_params)) + .call(rpc_methods::INSTRUCTIONS_DISCOVER, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `secrets.*` RPCs. -#[derive(Clone, Copy)] -pub struct ClientRpcSecrets<'a> { - pub(crate) client: &'a Client, -} -impl<'a> ClientRpcSecrets<'a> { - /// Registers secret values for redaction in session logs and exports. The SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens). + /// Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created. /// - /// Wire method: `secrets.addFilterValues`. + /// Wire method: `instructions.getDiscoveryPaths`. /// /// # Parameters /// - /// * `params` - Secret values to add to the redaction filter. + /// * `params` - Optional project paths to include when enumerating instruction discovery targets. /// /// # Returns /// - /// Confirmation that the secret values were registered. - pub async fn add_filter_values( + /// Canonical files and directories where custom instructions can be created so the runtime will recognize them. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_discovery_paths( &self, - params: SecretsAddFilterValuesRequest, - ) -> Result { + params: InstructionsGetDiscoveryPathsRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SECRETS_ADDFILTERVALUES, Some(wire_params)) + .call( + rpc_methods::INSTRUCTIONS_GETDISCOVERYPATHS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `sessionFs.*` RPCs. +/// `llmInference.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcSessionFs<'a> { +pub struct ClientRpcLlmInference<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcSessionFs<'a> { - /// Registers an SDK client as the session filesystem provider. +impl<'a> ClientRpcLlmInference<'a> { + /// Registers an SDK client as the LLM inference callback provider. /// - /// Wire method: `sessionFs.setProvider`. + /// Wire method: `llmInference.setProvider`. /// - /// # Parameters + /// # Returns /// - /// * `params` - Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. + /// Indicates whether the calling client was registered as the LLM inference provider. /// - /// # Returns + ///
    /// - /// Indicates whether the calling client was registered as the session filesystem provider. - pub async fn set_provider( - &self, - params: SessionFsSetProviderRequest, - ) -> Result { - let wire_params = serde_json::to_value(params)?; + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_provider(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONFS_SETPROVIDER, Some(wire_params)) + .call(rpc_methods::LLMINFERENCE_SETPROVIDER, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `sessions.*` RPCs. -#[derive(Clone, Copy)] -pub struct ClientRpcSessions<'a> { - pub(crate) client: &'a Client, -} -impl<'a> ClientRpcSessions<'a> { - /// Creates a new session by forking persisted history from an existing session. + /// Delivers the response head (status + headers) for an in-flight request, correlated by the requestId the runtime supplied in httpRequestStart. Must be called exactly once per request before any httpResponseChunk frames. /// - /// Wire method: `sessions.fork`. + /// Wire method: `llmInference.httpResponseStart`. /// /// # Parameters /// - /// * `params` - Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. + /// * `params` - Response head. /// /// # Returns /// - /// Identifier and optional friendly name assigned to the newly forked session. + /// Whether the start frame was accepted. /// ///
    /// @@ -500,26 +736,32 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn fork(&self, params: SessionsForkRequest) -> Result { + pub async fn http_response_start( + &self, + params: LlmInferenceHttpResponseStartRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_FORK, Some(wire_params)) + .call( + rpc_methods::LLMINFERENCE_HTTPRESPONSESTART, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Connects to an existing remote session and exposes it as an SDK session. + /// Delivers a body byte range (or a terminal transport error) for an in-flight response, correlated by requestId. Set `end` true on the last chunk. When `error` is set the response terminates with a transport-level failure and the runtime raises an APIConnectionError. /// - /// Wire method: `sessions.connect`. + /// Wire method: `llmInference.httpResponseChunk`. /// /// # Parameters /// - /// * `params` - Remote session connection parameters. + /// * `params` - A response body chunk or terminal error. /// /// # Returns /// - /// Remote session connection result. + /// Whether the chunk was accepted. /// ///
    /// @@ -528,25 +770,36 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn connect( + pub async fn http_response_chunk( &self, - params: ConnectRemoteSessionParams, - ) -> Result { + params: LlmInferenceHttpResponseChunkRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_CONNECT, Some(wire_params)) + .call( + rpc_methods::LLMINFERENCE_HTTPRESPONSECHUNK, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } +} + +/// `managedSettings.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcManagedSettings<'a> { + pub(crate) client: &'a Client, +} - /// Lists persisted sessions, optionally filtered by working-directory context. +impl<'a> ClientRpcManagedSettings<'a> { + /// Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session. /// - /// Wire method: `sessions.list`. + /// Wire method: `managedSettings.read`. /// /// # Returns /// - /// Persisted sessions matching the filter, ordered most-recently-modified first. + /// Validated device-managed settings discovered before a session exists. /// ///
    /// @@ -555,26 +808,41 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn read(&self) -> Result { let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONS_LIST, Some(wire_params)) + .call(rpc_methods::MANAGEDSETTINGS_READ, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} + +/// `mcp.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcMcp<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcMcp<'a> { + /// `mcp.config.*` sub-namespace. + pub fn config(&self) -> ClientRpcMcpConfig<'a> { + ClientRpcMcpConfig { + client: self.client, + } + } - /// Lists persisted sessions, optionally filtered by working-directory context. + /// Discovers MCP servers from user, workspace, plugin, and builtin sources. /// - /// Wire method: `sessions.list`. + /// Wire method: `mcp.discover`. /// /// # Parameters /// - /// * `params` - Optional metadata-load limit and filters applied to the returned sessions. + /// * `params` - Optional working directory used as context for MCP server discovery. /// /// # Returns /// - /// Persisted sessions matching the filter, ordered most-recently-modified first. + /// MCP servers discovered from user, workspace, plugin, and built-in sources. /// ///
    /// @@ -583,29 +851,30 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_with_params( - &self, - params: SessionsListRequest, - ) -> Result { + pub async fn discover(&self, params: McpDiscoverRequest) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_LIST, Some(wire_params)) + .call(rpc_methods::MCP_DISCOVER, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Finds the local session bound to a GitHub task ID, if any. - /// - /// Wire method: `sessions.findByTaskId`. - /// - /// # Parameters +/// `mcp.config.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcMcpConfig<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcMcpConfig<'a> { + /// Lists MCP servers from user configuration. /// - /// * `params` - GitHub task ID to look up. + /// Wire method: `mcp.config.list`. /// /// # Returns /// - /// ID of the local session bound to the given GitHub task, or omitted when none. + /// User-configured MCP servers, keyed by server name. /// ///
    /// @@ -614,29 +883,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn find_by_task_id( - &self, - params: SessionsFindByTaskIDRequest, - ) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONS_FINDBYTASKID, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a UUID prefix to a unique session ID, if exactly one session matches. + /// Adds an MCP server to user configuration. /// - /// Wire method: `sessions.findByPrefix`. + /// Wire method: `mcp.config.add`. /// /// # Parameters /// - /// * `params` - UUID prefix to resolve to a unique session ID. - /// - /// # Returns - /// - /// Session ID matching the prefix, omitted when no unique match exists. + /// * `params` - MCP server name and configuration to add to user configuration. /// ///
    /// @@ -645,29 +907,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn find_by_prefix( - &self, - params: SessionsFindByPrefixRequest, - ) -> Result { + pub async fn add(&self, params: McpConfigAddRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_FINDBYPREFIX, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_ADD, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Returns the most-relevant prior session for a given working-directory context. + /// Updates an MCP server in user configuration. /// - /// Wire method: `sessions.getLastForContext`. + /// Wire method: `mcp.config.update`. /// /// # Parameters /// - /// * `params` - Optional working-directory context used to score session relevance. - /// - /// # Returns - /// - /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. + /// * `params` - MCP server name and replacement configuration to write to user configuration. /// ///
    /// @@ -676,29 +931,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_last_for_context( - &self, - params: SessionsGetLastForContextRequest, - ) -> Result { + pub async fn update(&self, params: McpConfigUpdateRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_GETLASTFORCONTEXT, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_UPDATE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Computes the absolute path to a session's persisted events.jsonl file. + /// Removes an MCP server from user configuration. /// - /// Wire method: `sessions.getEventFilePath`. + /// Wire method: `mcp.config.remove`. /// /// # Parameters /// - /// * `params` - Session ID whose event-log file path to compute. - /// - /// # Returns - /// - /// Absolute path to the session's events.jsonl file on disk. + /// * `params` - MCP server name to remove from user configuration. /// ///
    /// @@ -707,25 +955,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_event_file_path( - &self, - params: SessionsGetEventFilePathRequest, - ) -> Result { + pub async fn remove(&self, params: McpConfigRemoveRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_GETEVENTFILEPATH, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_REMOVE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Returns the on-disk byte size of each session's workspace directory. + /// Enables MCP servers in user configuration for new sessions. /// - /// Wire method: `sessions.getSizes`. + /// Wire method: `mcp.config.enable`. /// - /// # Returns + /// # Parameters /// - /// Map of sessionId -> on-disk size in bytes for each session's workspace directory. + /// * `params` - MCP server names to enable for new sessions. /// ///
    /// @@ -734,26 +979,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_sizes(&self) -> Result { - let wire_params = serde_json::json!({}); + pub async fn enable(&self, params: McpConfigEnableRequest) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_GETSIZES, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_ENABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Returns the subset of the supplied session IDs that are currently held by another running process. + /// Disables MCP servers in user configuration for new sessions. /// - /// Wire method: `sessions.checkInUse`. + /// Wire method: `mcp.config.disable`. /// /// # Parameters /// - /// * `params` - Session IDs to test for live in-use locks. - /// - /// # Returns - /// - /// Session IDs from the input set that are currently in use by another process. + /// * `params` - MCP server names to disable for new sessions. /// ///
    /// @@ -762,29 +1003,18 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn check_in_use( - &self, - params: SessionsCheckInUseRequest, - ) -> Result { + pub async fn disable(&self, params: McpConfigDisableRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_CHECKINUSE, Some(wire_params)) + .call(rpc_methods::MCP_CONFIG_DISABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Returns a session's persisted remote-steerable flag, if any has been recorded. - /// - /// Wire method: `sessions.getPersistedRemoteSteerable`. - /// - /// # Parameters - /// - /// * `params` - Session ID to look up the persisted remote-steerable flag for. - /// - /// # Returns + /// Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk. /// - /// The session's persisted remote-steerable flag, or omitted when no value has been persisted. + /// Wire method: `mcp.config.reload`. /// ///
    /// @@ -793,32 +1023,30 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_persisted_remote_steerable( - &self, - params: SessionsGetPersistedRemoteSteerableRequest, - ) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn reload(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({}); let _value = self .client - .call( - rpc_methods::SESSIONS_GETPERSISTEDREMOTESTEERABLE, - Some(wire_params), - ) + .call(rpc_methods::MCP_CONFIG_RELOAD, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } +} - /// Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and disposes the active session. - /// - /// Wire method: `sessions.close`. - /// - /// # Parameters +/// `models.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcModels<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcModels<'a> { + /// Lists Copilot models available to the authenticated user. /// - /// * `params` - Session ID to close. + /// Wire method: `models.list`. /// /// # Returns /// - /// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. + /// List of Copilot models available to the resolved user, including capabilities and billing metadata. /// ///
    /// @@ -827,26 +1055,26 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn close(&self, params: SessionsCloseRequest) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONS_CLOSE, Some(wire_params)) + .call(rpc_methods::MODELS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Closes, deactivates, and deletes a set of sessions, returning the bytes freed per session. + /// Lists Copilot models available to the authenticated user. /// - /// Wire method: `sessions.bulkDelete`. + /// Wire method: `models.list`. /// /// # Parameters /// - /// * `params` - Session IDs to close, deactivate, and delete from disk. + /// * `params` - Optional GitHub token used to list models for a specific user instead of the global auth context. /// /// # Returns /// - /// Map of sessionId -> bytes freed by removing the session's workspace directory. + /// List of Copilot models available to the resolved user, including capabilities and billing metadata. /// ///
    /// @@ -855,29 +1083,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn bulk_delete( - &self, - params: SessionsBulkDeleteRequest, - ) -> Result { + pub async fn list_with_params(&self, params: ModelsListRequest) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_BULKDELETE, Some(wire_params)) + .call(rpc_methods::MODELS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Deletes sessions older than the given threshold, with optional dry-run and exclusion list. - /// - /// Wire method: `sessions.pruneOld`. - /// - /// # Parameters + /// Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access. /// - /// * `params` - Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). + /// Wire method: `models.getBuiltInCatalog`. /// /// # Returns /// - /// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. + /// The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata. /// ///
    /// @@ -886,29 +1107,37 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn prune_old( - &self, - params: SessionsPruneOldRequest, - ) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn get_built_in_catalog(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONS_PRUNEOLD, Some(wire_params)) + .call(rpc_methods::MODELS_GETBUILTINCATALOG, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Flushes a session's pending events to disk. - /// - /// Wire method: `sessions.save`. - /// - /// # Parameters +/// `plugins.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcPlugins<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcPlugins<'a> { + /// `plugins.marketplaces.*` sub-namespace. + pub fn marketplaces(&self) -> ClientRpcPluginsMarketplaces<'a> { + ClientRpcPluginsMarketplaces { + client: self.client, + } + } + + /// Lists plugins installed in user/global state. /// - /// * `params` - Session ID whose pending events should be flushed to disk. + /// Wire method: `plugins.list`. /// /// # Returns /// - /// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). + /// Plugins installed in user/global state. /// ///
    /// @@ -917,26 +1146,26 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn save(&self, params: SessionsSaveRequest) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::SESSIONS_SAVE, Some(wire_params)) + .call(rpc_methods::PLUGINS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Releases the in-use lock held by this process for a session. + /// Installs a plugin from a marketplace, GitHub repo, URL, or local path. /// - /// Wire method: `sessions.releaseLock`. + /// Wire method: `plugins.install`. /// /// # Parameters /// - /// * `params` - Session ID whose in-use lock should be released. + /// * `params` - Plugin source and optional working directory for relative-path resolution. /// /// # Returns /// - /// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. + /// Result of installing a plugin. /// ///
    /// @@ -945,29 +1174,25 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn release_lock( + pub async fn install( &self, - params: SessionsReleaseLockRequest, - ) -> Result { + params: PluginsInstallRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_RELEASELOCK, Some(wire_params)) + .call(rpc_methods::PLUGINS_INSTALL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Backfills missing summary and context fields on the supplied session metadata records. + /// Uninstalls an installed plugin. /// - /// Wire method: `sessions.enrichMetadata`. + /// Wire method: `plugins.uninstall`. /// /// # Parameters /// - /// * `params` - Session metadata records to enrich with summary and context information. - /// - /// # Returns - /// - /// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. + /// * `params` - Name (or spec) of the plugin to uninstall. /// ///
    /// @@ -976,29 +1201,26 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enrich_metadata( - &self, - params: SessionsEnrichMetadataRequest, - ) -> Result { + pub async fn uninstall(&self, params: PluginsUninstallRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_ENRICHMETADATA, Some(wire_params)) + .call(rpc_methods::PLUGINS_UNINSTALL, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Reloads user, plugin, and (optionally) repo hooks on the active session. + /// Updates an installed plugin to its latest published version. /// - /// Wire method: `sessions.reloadPluginHooks`. + /// Wire method: `plugins.update`. /// /// # Parameters /// - /// * `params` - Active session ID and an optional flag for deferring repo-level hooks until folder trust. + /// * `params` - Name (or spec) of the plugin to update. /// /// # Returns /// - /// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. + /// Result of updating a single plugin. /// ///
    /// @@ -1007,29 +1229,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reload_plugin_hooks( - &self, - params: SessionsReloadPluginHooksRequest, - ) -> Result { + pub async fn update(&self, params: PluginsUpdateRequest) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SESSIONS_RELOADPLUGINHOOKS, Some(wire_params)) + .call(rpc_methods::PLUGINS_UPDATE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Loads previously-deferred repo-level hooks on the active session, returning queued startup prompts. - /// - /// Wire method: `sessions.loadDeferredRepoHooks`. - /// - /// # Parameters + /// Updates every installed plugin to its latest published version. /// - /// * `params` - Active session ID whose deferred repo-level hooks should be loaded. + /// Wire method: `plugins.updateAll`. /// /// # Returns /// - /// Queued repo-level startup prompts and the total hook command count after loading. + /// Result of updating all installed plugins. /// ///
    /// @@ -1038,32 +1253,22 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn load_deferred_repo_hooks( - &self, - params: SessionsLoadDeferredRepoHooksRequest, - ) -> Result { - let wire_params = serde_json::to_value(params)?; + pub async fn update_all(&self) -> Result { + let wire_params = serde_json::json!({}); let _value = self .client - .call( - rpc_methods::SESSIONS_LOADDEFERREDREPOHOOKS, - Some(wire_params), - ) + .call(rpc_methods::PLUGINS_UPDATEALL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Replaces the manager-wide additional plugins registered with the session manager. + /// Enables installed plugins for new sessions. /// - /// Wire method: `sessions.setAdditionalPlugins`. + /// Wire method: `plugins.enable`. /// /// # Parameters /// - /// * `params` - Manager-wide additional plugins to register; replaces any previously-configured set. - /// - /// # Returns - /// - /// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. + /// * `params` - Plugin names (or specs) to enable. /// ///
    /// @@ -1072,191 +1277,1630 @@ impl<'a> ClientRpcSessions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_additional_plugins( - &self, - params: SessionsSetAdditionalPluginsRequest, - ) -> Result { + pub async fn enable(&self, params: PluginsEnableRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call( - rpc_methods::SESSIONS_SETADDITIONALPLUGINS, - Some(wire_params), - ) + .call(rpc_methods::PLUGINS_ENABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) - } -} - -/// `skills.*` RPCs. -#[derive(Clone, Copy)] -pub struct ClientRpcSkills<'a> { - pub(crate) client: &'a Client, -} - -impl<'a> ClientRpcSkills<'a> { - /// `skills.config.*` sub-namespace. - pub fn config(&self) -> ClientRpcSkillsConfig<'a> { - ClientRpcSkillsConfig { - client: self.client, - } + Ok(()) } - /// Discovers skills across global and project sources. + /// Disables installed plugins for new sessions. /// - /// Wire method: `skills.discover`. + /// Wire method: `plugins.disable`. /// /// # Parameters /// - /// * `params` - Optional project paths and additional skill directories to include in discovery. + /// * `params` - Plugin names (or specs) to disable. /// - /// # Returns + ///
    /// - /// Skills discovered across global and project sources. - pub async fn discover(&self, params: SkillsDiscoverRequest) -> Result { + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn disable(&self, params: PluginsDisableRequest) -> Result<(), Error> { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::SKILLS_DISCOVER, Some(wire_params)) + .call(rpc_methods::PLUGINS_DISABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } } -/// `skills.config.*` RPCs. +/// `plugins.marketplaces.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcSkillsConfig<'a> { +pub struct ClientRpcPluginsMarketplaces<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcSkillsConfig<'a> { - /// Replaces the global list of disabled skills. +impl<'a> ClientRpcPluginsMarketplaces<'a> { + /// Lists all registered marketplaces (defaults + user-added). /// - /// Wire method: `skills.config.setDisabledSkills`. + /// Wire method: `plugins.marketplaces.list`. + /// + /// # Returns + /// + /// All registered marketplaces, including built-in defaults. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::PLUGINS_MARKETPLACES_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Registers a new marketplace from a source (owner/repo, URL, or local path). + /// + /// Wire method: `plugins.marketplaces.add`. /// /// # Parameters /// - /// * `params` - Skill names to mark as disabled in global configuration, replacing any previous list. - pub async fn set_disabled_skills( + /// * `params` - Marketplace source and optional working directory for relative-path resolution. + /// + /// # Returns + /// + /// Result of registering a new marketplace. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn add( &self, - params: SkillsConfigSetDisabledSkillsRequest, - ) -> Result<(), Error> { + params: PluginsMarketplacesAddRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call( - rpc_methods::SKILLS_CONFIG_SETDISABLEDSKILLS, - Some(wire_params), - ) + .call(rpc_methods::PLUGINS_MARKETPLACES_ADD, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } -} -/// `tools.*` RPCs. -#[derive(Clone, Copy)] -pub struct ClientRpcTools<'a> { - pub(crate) client: &'a Client, -} + /// Removes a previously-registered marketplace. When the marketplace has dependent plugins and `force` is not set, the marketplace is left intact and the result lists the dependents so the caller can decide whether to retry with `force=true`. + /// + /// Wire method: `plugins.marketplaces.remove`. + /// + /// # Parameters + /// + /// * `params` - Name of the marketplace to remove and an optional force flag. + /// + /// # Returns + /// + /// Outcome of the remove attempt, including dependent-plugin info when applicable. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn remove( + &self, + params: PluginsMarketplacesRemoveRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::PLUGINS_MARKETPLACES_REMOVE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } -impl<'a> ClientRpcTools<'a> { - /// Lists built-in tools available for a model. + /// Lists plugins advertised by a registered marketplace. /// - /// Wire method: `tools.list`. + /// Wire method: `plugins.marketplaces.browse`. /// /// # Parameters /// - /// * `params` - Optional model identifier whose tool overrides should be applied to the listing. + /// * `params` - Name of the marketplace whose plugin catalog to fetch. /// /// # Returns /// - /// Built-in tools available for the requested model, with their parameters and instructions. - pub async fn list(&self, params: ToolsListRequest) -> Result { + /// Plugins advertised by the marketplace. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn browse( + &self, + params: PluginsMarketplacesBrowseRequest, + ) -> Result { let wire_params = serde_json::to_value(params)?; let _value = self .client - .call(rpc_methods::TOOLS_LIST, Some(wire_params)) + .call(rpc_methods::PLUGINS_MARKETPLACES_BROWSE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} -/// `user.*` RPCs. -#[derive(Clone, Copy)] -pub struct ClientRpcUser<'a> { - pub(crate) client: &'a Client, -} + /// Re-fetches one or all registered marketplace catalogs. + /// + /// Wire method: `plugins.marketplaces.refresh`. + /// + /// # Returns + /// + /// Result of refreshing one or more marketplace catalogs. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn refresh(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::PLUGINS_MARKETPLACES_REFRESH, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } -impl<'a> ClientRpcUser<'a> { - /// `user.settings.*` sub-namespace. - pub fn settings(&self) -> ClientRpcUserSettings<'a> { - ClientRpcUserSettings { - client: self.client, - } + /// Re-fetches one or all registered marketplace catalogs. + /// + /// Wire method: `plugins.marketplaces.refresh`. + /// + /// # Parameters + /// + /// * `params` - Optional marketplace name; omit to refresh all. + /// + /// # Returns + /// + /// Result of refreshing one or more marketplace catalogs. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn refresh_with_params( + &self, + params: PluginsMarketplacesRefreshRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::PLUGINS_MARKETPLACES_REFRESH, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } } -/// `user.settings.*` RPCs. +/// `runtime.*` RPCs. #[derive(Clone, Copy)] -pub struct ClientRpcUserSettings<'a> { +pub struct ClientRpcRuntime<'a> { pub(crate) client: &'a Client, } -impl<'a> ClientRpcUserSettings<'a> { - /// Drops this runtime process's in-memory user settings cache so the next settings read observes disk. +impl<'a> ClientRpcRuntime<'a> { + /// Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process. /// - /// Wire method: `user.settings.reload`. - pub async fn reload(&self) -> Result<(), Error> { + /// Wire method: `runtime.shutdown`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn shutdown(&self) -> Result<(), Error> { let wire_params = serde_json::json!({}); let _value = self .client - .call(rpc_methods::USER_SETTINGS_RELOAD, Some(wire_params)) + .call(rpc_methods::RUNTIME_SHUTDOWN, Some(wire_params)) .await?; Ok(()) } } -/// Typed view over a [`Session`]'s RPC namespace. +/// `secrets.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpc<'a> { - pub(crate) session: &'a Session, +pub struct ClientRpcSecrets<'a> { + pub(crate) client: &'a Client, } -impl<'a> SessionRpc<'a> { - /// `session.agent.*` sub-namespace. - pub fn agent(&self) -> SessionRpcAgent<'a> { - SessionRpcAgent { - session: self.session, - } - } - - /// `session.auth.*` sub-namespace. - pub fn auth(&self) -> SessionRpcAuth<'a> { - SessionRpcAuth { - session: self.session, - } +impl<'a> ClientRpcSecrets<'a> { + /// Registers secret values for redaction in session logs and exports. The SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens). + /// + /// Wire method: `secrets.addFilterValues`. + /// + /// # Parameters + /// + /// * `params` - Secret values to add to the redaction filter. + /// + /// # Returns + /// + /// Confirmation that the secret values were registered. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn add_filter_values( + &self, + params: SecretsAddFilterValuesRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SECRETS_ADDFILTERVALUES, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } +} - /// `session.canvas.*` sub-namespace. - pub fn canvas(&self) -> SessionRpcCanvas<'a> { - SessionRpcCanvas { - session: self.session, - } - } +/// `sessionFs.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcSessionFs<'a> { + pub(crate) client: &'a Client, +} - /// `session.commands.*` sub-namespace. - pub fn commands(&self) -> SessionRpcCommands<'a> { - SessionRpcCommands { - session: self.session, - } +impl<'a> ClientRpcSessionFs<'a> { + /// Registers an SDK client as the session filesystem provider. + /// + /// Wire method: `sessionFs.setProvider`. + /// + /// # Parameters + /// + /// * `params` - Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. + /// + /// # Returns + /// + /// Indicates whether the calling client was registered as the session filesystem provider. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_provider( + &self, + params: SessionFsSetProviderRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONFS_SETPROVIDER, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } +} - /// `session.eventLog.*` sub-namespace. - pub fn event_log(&self) -> SessionRpcEventLog<'a> { - SessionRpcEventLog { - session: self.session, - } - } +/// `sessions.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcSessions<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcSessions<'a> { + /// Creates or resumes a local session and returns the opened session ID. + /// + /// Wire method: `sessions.open`. + /// + /// # Returns + /// + /// Result of opening a session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn open(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::SESSIONS_OPEN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Creates a new session by forking persisted history from an existing session. + /// + /// Wire method: `sessions.fork`. + /// + /// # Parameters + /// + /// * `params` - Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session. + /// + /// # Returns + /// + /// Identifier and optional friendly name assigned to the newly forked session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn fork(&self, params: SessionsForkRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_FORK, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Connects to an existing remote session and exposes it as an SDK session. + /// + /// Wire method: `sessions.connect`. + /// + /// # Parameters + /// + /// * `params` - Remote session connection parameters. + /// + /// # Returns + /// + /// Remote session connection result. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn connect( + &self, + params: ConnectRemoteSessionParams, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_CONNECT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists sessions, optionally filtered by source and working-directory context. Returned entries are discriminated by `isRemote`: local entries carry only the lightweight `LocalSessionMetadataValue` shape; remote entries carry the full `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.). + /// + /// Wire method: `sessions.list`. + /// + /// # Returns + /// + /// Sessions matching the filter, ordered most-recently-modified first. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::SESSIONS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists sessions, optionally filtered by source and working-directory context. Returned entries are discriminated by `isRemote`: local entries carry only the lightweight `LocalSessionMetadataValue` shape; remote entries carry the full `RemoteSessionMetadataValue` shape (repository, PR number, taskType, etc.). + /// + /// Wire method: `sessions.list`. + /// + /// # Parameters + /// + /// * `params` - Optional source filter, metadata-load limit, and context filter applied to the returned sessions. + /// + /// # Returns + /// + /// Sessions matching the filter, ordered most-recently-modified first. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_with_params( + &self, + params: SessionsListRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reads lightweight persisted metadata for one local session without opening it. + /// + /// Wire method: `sessions.getMetadata`. + /// + /// # Parameters + /// + /// * `params` - Session ID whose persisted metadata should be read. + /// + /// # Returns + /// + /// Persisted local session metadata when the session exists. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn get_metadata( + &self, + params: SessionsGetMetadataRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_GETMETADATA, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists recent local session IDs that contain user-visible history, omitting housekeeping-only sessions. + /// + /// Wire method: `sessions.listNonEmptySessionIds`. + /// + /// # Parameters + /// + /// * `params` - Limit for non-empty local session IDs. + /// + /// # Returns + /// + /// Recent local session IDs that contain user-visible history. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn list_non_empty_session_ids( + &self, + params: SessionsListNonEmptySessionIdsRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_LISTNONEMPTYSESSIONIDS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Finds the local session bound to a GitHub task ID, if any. + /// + /// Wire method: `sessions.findByTaskId`. + /// + /// # Parameters + /// + /// * `params` - GitHub task ID to look up. + /// + /// # Returns + /// + /// ID of the local session bound to the given GitHub task, or omitted when none. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn find_by_task_id( + &self, + params: SessionsFindByTaskIDRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_FINDBYTASKID, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Resolves a UUID prefix to a unique session ID, if exactly one session matches. + /// + /// Wire method: `sessions.findByPrefix`. + /// + /// # Parameters + /// + /// * `params` - UUID prefix to resolve to a unique session ID. + /// + /// # Returns + /// + /// Session ID matching the prefix, omitted when no unique match exists. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn find_by_prefix( + &self, + params: SessionsFindByPrefixRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_FINDBYPREFIX, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the most-relevant prior session for a given working-directory context. + /// + /// Wire method: `sessions.getLastForContext`. + /// + /// # Parameters + /// + /// * `params` - Optional working-directory context used to score session relevance. + /// + /// # Returns + /// + /// Most-relevant session ID for the supplied context, or omitted when no sessions exist. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_last_for_context( + &self, + params: SessionsGetLastForContextRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_GETLASTFORCONTEXT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Computes the absolute path to a session's persisted events.jsonl file. Internal: filesystem paths are only meaningful in-process (CLI and runtime share a filesystem). Currently used by the CLI's contribution-graph feature to read historical events directly. Remote SDK consumers must not depend on this; a proper event-query API would replace it if the contribution graph ever needed to work over the wire. + /// + /// Wire method: `sessions.getEventFilePath`. + /// + /// # Parameters + /// + /// * `params` - Session ID whose event-log file path to compute. + /// + /// # Returns + /// + /// Absolute path to the session's events.jsonl file on disk. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn get_event_file_path( + &self, + params: SessionsGetEventFilePathRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_GETEVENTFILEPATH, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the on-disk byte size of each session's workspace directory. + /// + /// Wire method: `sessions.getSizes`. + /// + /// # Returns + /// + /// Map of sessionId -> on-disk size in bytes for each session's workspace directory. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_sizes(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::SESSIONS_GETSIZES, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the subset of the supplied session IDs that are currently held by another running process. + /// + /// Wire method: `sessions.checkInUse`. + /// + /// # Parameters + /// + /// * `params` - Session IDs to test for live in-use locks. + /// + /// # Returns + /// + /// Session IDs from the input set that are currently in use by another process. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn check_in_use( + &self, + params: SessionsCheckInUseRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_CHECKINUSE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns a session's persisted remote-steerable flag, if any has been recorded. Internal: this is CLI-specific book-keeping used by `--continue` / `--resume` to inherit the prior session's remote-steerable preference. SDK consumers that want similar behavior should manage their own persistence around start/stop calls rather than relying on this runtime-side flag. + /// + /// Wire method: `sessions.getPersistedRemoteSteerable`. + /// + /// # Parameters + /// + /// * `params` - Session ID to look up the persisted remote-steerable flag for. + /// + /// # Returns + /// + /// The session's persisted remote-steerable flag, or omitted when no value has been persisted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn get_persisted_remote_steerable( + &self, + params: SessionsGetPersistedRemoteSteerableRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_GETPERSISTEDREMOTESTEERABLE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and disposes the active session. + /// + /// Wire method: `sessions.close`. + /// + /// # Parameters + /// + /// * `params` - Session ID to close. + /// + /// # Returns + /// + /// Closes a session: emits shutdown, flushes pending events to disk, releases the in-use lock, disposes the active session. Idempotent: succeeds even if the session is not currently active. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn close(&self, params: SessionsCloseRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_CLOSE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Closes, deactivates, and deletes a set of sessions, returning the bytes freed per session. + /// + /// Wire method: `sessions.bulkDelete`. + /// + /// # Parameters + /// + /// * `params` - Session IDs to close, deactivate, and delete from disk. + /// + /// # Returns + /// + /// Map of sessionId -> bytes freed by removing the session's workspace directory. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn bulk_delete( + &self, + params: SessionsBulkDeleteRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_BULKDELETE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Deletes one local session from disk after running the same lifecycle hooks as the session manager. + /// + /// Wire method: `sessions.delete`. + /// + /// # Parameters + /// + /// * `params` - Session ID to delete from disk. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn delete(&self, params: SessionsDeleteRequest) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_DELETE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Deletes sessions older than the given threshold, with optional dry-run and exclusion list. + /// + /// Wire method: `sessions.pruneOld`. + /// + /// # Parameters + /// + /// * `params` - Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true). + /// + /// # Returns + /// + /// Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn prune_old( + &self, + params: SessionsPruneOldRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_PRUNEOLD, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Flushes a session's pending events to disk. + /// + /// Wire method: `sessions.save`. + /// + /// # Parameters + /// + /// * `params` - Session ID whose pending events should be flushed to disk. + /// + /// # Returns + /// + /// Flush a session's pending events to disk. No-op when no writer exists for the session (e.g., already closed). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn save(&self, params: SessionsSaveRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_SAVE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Releases the in-use lock held by this process for a session. + /// + /// Wire method: `sessions.releaseLock`. + /// + /// # Parameters + /// + /// * `params` - Session ID whose in-use lock should be released. + /// + /// # Returns + /// + /// Release the in-use lock held by this process for the given session. No-op when this process does not currently hold a lock for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn release_lock( + &self, + params: SessionsReleaseLockRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_RELEASELOCK, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Backfills missing summary and context fields on the supplied session metadata records. + /// + /// Wire method: `sessions.enrichMetadata`. + /// + /// # Parameters + /// + /// * `params` - Session metadata records to enrich with summary and context information. + /// + /// # Returns + /// + /// The enriched metadata records, with summary and context fields backfilled where available. Sessions confirmed empty and unnamed are omitted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn enrich_metadata( + &self, + params: SessionsEnrichMetadataRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_ENRICHMETADATA, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reloads user, plugin, and (optionally) repo hooks on the active session. + /// + /// Wire method: `sessions.reloadPluginHooks`. + /// + /// # Parameters + /// + /// * `params` - Active session ID and an optional flag for deferring repo-level hooks until folder trust. + /// + /// # Returns + /// + /// Reload all hooks (user, plugin, optionally repo) and apply them to the active session. Call after installing or removing plugins so their hooks take effect immediately. No-op when no active session matches the given sessionId. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn reload_plugin_hooks( + &self, + params: SessionsReloadPluginHooksRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_RELOADPLUGINHOOKS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Loads previously-deferred repo-level hooks on the active session, returning queued startup prompts. + /// + /// Wire method: `sessions.loadDeferredRepoHooks`. + /// + /// # Parameters + /// + /// * `params` - Active session ID whose deferred repo-level hooks should be loaded. + /// + /// # Returns + /// + /// Queued repo-level startup prompts and the total hook command count after loading. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn load_deferred_repo_hooks( + &self, + params: SessionsLoadDeferredRepoHooksRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_LOADDEFERREDREPOHOOKS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Replaces the manager-wide additional plugins registered with the session manager. + /// + /// Wire method: `sessions.setAdditionalPlugins`. + /// + /// # Parameters + /// + /// * `params` - Manager-wide additional plugins to register; replaces any previously-configured set. + /// + /// # Returns + /// + /// Replace the manager-wide additional plugins. New session creations and subsequent hook reloads see the new set; already-running sessions keep their existing hook installation until the next reload. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_additional_plugins( + &self, + params: SessionsSetAdditionalPluginsRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_SETADDITIONALPLUGINS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Gets the dynamic-context board entry count associated with a session, when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, `rem_consolidation_complete`) can pair START / END board counts around the detached rem-agent spawn. "Dynamic context board" is a runtime-internal concept that is not part of the public SDK contract; the long-term plan is to relocate the telemetry emission into the runtime so this method can be deleted entirely. + /// + /// Wire method: `sessions.getBoardEntryCount`. + /// + /// # Parameters + /// + /// * `params` - Session ID whose board entry count should be returned. + /// + /// # Returns + /// + /// Dynamic-context board entry count, when available. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn get_board_entry_count( + &self, + params: SessionsGetBoardEntryCountRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_GETBOARDENTRYCOUNT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Attaches the runtime-managed remote-control singleton to a session, awaiting initial setup. If remote control is already attached to a different session, the singleton is transferred (preserving the underlying Mission Control connection). Returns the final status. + /// + /// Wire method: `sessions.startRemoteControl`. + /// + /// # Parameters + /// + /// * `params` - Parameters for attaching the remote-control singleton to a session. + /// + /// # Returns + /// + /// Wrapper for the singleton's current status. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn start_remote_control( + &self, + params: SessionsStartRemoteControlRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_STARTREMOTECONTROL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Atomically rebinds the remote-control singleton to a different session, preserving the underlying Mission Control connection. When `expectedFromSessionId` is provided and does not match the singleton's current `attachedSessionId`, the transfer is rejected with `transferred: false` and the current status is returned unchanged. + /// + /// Wire method: `sessions.transferRemoteControl`. + /// + /// # Parameters + /// + /// * `params` - Parameters for atomically rebinding the remote-control singleton. + /// + /// # Returns + /// + /// Outcome of a transferRemoteControl call. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn transfer_remote_control( + &self, + params: SessionsTransferRemoteControlRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_TRANSFERREMOTECONTROL, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Patches the steering state of the active remote-control singleton. When remote control is off, this is a no-op and the off status is returned. Today only `enabled: true` is actionable on the underlying exporter; passing `false` is reserved for future use. + /// + /// Wire method: `sessions.setRemoteControlSteering`. + /// + /// # Parameters + /// + /// * `params` - Patch for the singleton's steering state. + /// + /// # Returns + /// + /// Wrapper for the singleton's current status. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_remote_control_steering( + &self, + params: SessionsSetRemoteControlSteeringRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_SETREMOTECONTROLSTEERING, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Stops the remote-control singleton. When `expectedSessionId` is provided and does not match the singleton's current `attachedSessionId`, the stop is rejected with `stopped: false` and the current status is returned unchanged (unless `force` is set, in which case the singleton is unconditionally torn down). + /// + /// Wire method: `sessions.stopRemoteControl`. + /// + /// # Returns + /// + /// Outcome of a stopRemoteControl call. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn stop_remote_control(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::SESSIONS_STOPREMOTECONTROL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Stops the remote-control singleton. When `expectedSessionId` is provided and does not match the singleton's current `attachedSessionId`, the stop is rejected with `stopped: false` and the current status is returned unchanged (unless `force` is set, in which case the singleton is unconditionally torn down). + /// + /// Wire method: `sessions.stopRemoteControl`. + /// + /// # Parameters + /// + /// * `params` - Parameters for stopping the remote-control singleton. + /// + /// # Returns + /// + /// Outcome of a stopRemoteControl call. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn stop_remote_control_with_params( + &self, + params: SessionsStopRemoteControlRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SESSIONS_STOPREMOTECONTROL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the current state of the remote-control singleton, including the attached session id and frontend URL when active. + /// + /// Wire method: `sessions.getRemoteControlStatus`. + /// + /// # Returns + /// + /// Wrapper for the singleton's current status. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_remote_control_status(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call( + rpc_methods::SESSIONS_GETREMOTECONTROLSTATUS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Registers extension-provided tools on the given session, gated by an optional `enabled` callback. Returns an opaque unsubscribe function the caller must invoke to deregister the tools when the extension is torn down. Marked internal because `loader`, `enabled`, and the returned `unsubscribe` are in-process handles that cannot cross the JSON-RPC boundary. Disappears once extension discovery / launch / tool registration are owned by the runtime: SDK consumers will pass pure config (search paths, disabled ids) via `SessionOptions` and the runtime will resolve, launch, register, and tear down extensions itself. + /// + /// Wire method: `sessions.registerExtensionToolsOnSession`. + /// + /// # Parameters + /// + /// * `params` - Params to attach an extension loader's tools to a session. + /// + /// # Returns + /// + /// Handle for releasing the extension tool registration. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn register_extension_tools_on_session( + &self, + params: RegisterExtensionToolsParams, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_REGISTEREXTENSIONTOOLSONSESSION, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Attaches (or detaches) an in-process ExtensionController delegate for the given session, used by shared-API surfaces that need to query or modify the session's extension state. Pass `controller: undefined` to detach. Marked internal because the controller is an in-process object that cannot cross the JSON-RPC boundary. Disappears alongside `registerExtensionToolsOnSession`: once the runtime owns extension management, the public surface exposes list/enable/disable/reload as dedicated RPCs served by the runtime. + /// + /// Wire method: `sessions.configureSessionExtensions`. + /// + /// # Parameters + /// + /// * `params` - Params to attach or detach an in-process ExtensionController delegate. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn configure_session_extensions( + &self, + params: ConfigureSessionExtensionsParams, + ) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SESSIONS_CONFIGURESESSIONEXTENSIONS, + Some(wire_params), + ) + .await?; + Ok(()) + } +} + +/// `skills.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcSkills<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcSkills<'a> { + /// `skills.config.*` sub-namespace. + pub fn config(&self) -> ClientRpcSkillsConfig<'a> { + ClientRpcSkillsConfig { + client: self.client, + } + } + + /// Discovers skills across global and project sources. + /// + /// Wire method: `skills.discover`. + /// + /// # Parameters + /// + /// * `params` - Optional project paths and additional skill directories to include in discovery. + /// + /// # Returns + /// + /// Skills discovered across global and project sources. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn discover(&self, params: SkillsDiscoverRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SKILLS_DISCOVER, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the canonical directories where a client may create skills that the runtime will recognize, including ones that do not exist yet. Project directories become active once created. + /// + /// Wire method: `skills.getDiscoveryPaths`. + /// + /// # Parameters + /// + /// * `params` - Optional project paths to enumerate. + /// + /// # Returns + /// + /// Canonical locations where skills can be created so the runtime will recognize them. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_discovery_paths( + &self, + params: SkillsGetDiscoveryPathsRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::SKILLS_GETDISCOVERYPATHS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `skills.config.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcSkillsConfig<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcSkillsConfig<'a> { + /// Replaces the global list of disabled skills. + /// + /// Wire method: `skills.config.setDisabledSkills`. + /// + /// # Parameters + /// + /// * `params` - Skill names to mark as disabled in global configuration, replacing any previous list. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_disabled_skills( + &self, + params: SkillsConfigSetDisabledSkillsRequest, + ) -> Result<(), Error> { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call( + rpc_methods::SKILLS_CONFIG_SETDISABLEDSKILLS, + Some(wire_params), + ) + .await?; + Ok(()) + } +} + +/// `tools.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcTools<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcTools<'a> { + /// Lists built-in tools available for a model. + /// + /// Wire method: `tools.list`. + /// + /// # Parameters + /// + /// * `params` - Optional model identifier whose tool overrides should be applied to the listing. + /// + /// # Returns + /// + /// Built-in tools available for the requested model, with their parameters and instructions. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self, params: ToolsListRequest) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::TOOLS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `user.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcUser<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcUser<'a> { + /// `user.settings.*` sub-namespace. + pub fn settings(&self) -> ClientRpcUserSettings<'a> { + ClientRpcUserSettings { + client: self.client, + } + } +} + +/// `user.settings.*` RPCs. +#[derive(Clone, Copy)] +pub struct ClientRpcUserSettings<'a> { + pub(crate) client: &'a Client, +} + +impl<'a> ClientRpcUserSettings<'a> { + /// Drops this runtime process's in-memory user settings cache so the next settings read observes disk. + /// + /// Wire method: `user.settings.reload`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn reload(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::USER_SETTINGS_RELOAD, Some(wire_params)) + .await?; + Ok(()) + } + + /// Lists every known user setting (settings.json overlaid with the legacy config.json, config.json wins), each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time. + /// + /// Wire method: `user.settings.get`. + /// + /// # Returns + /// + /// Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get(&self) -> Result { + let wire_params = serde_json::json!({}); + let _value = self + .client + .call(rpc_methods::USER_SETTINGS_GET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed. Returns the keys whose new value is shadowed by a legacy config.json entry (config.json wins on read), which the runtime leaves in place — such writes do not take effect until the legacy value is removed. + /// + /// Wire method: `user.settings.set`. + /// + /// # Parameters + /// + /// * `params` - Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed. + /// + /// # Returns + /// + /// Outcome of writing user settings. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set( + &self, + params: UserSettingsSetRequest, + ) -> Result { + let wire_params = serde_json::to_value(params)?; + let _value = self + .client + .call(rpc_methods::USER_SETTINGS_SET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// Typed view over a [`Session`]'s RPC namespace. +#[derive(Clone, Copy)] +pub struct SessionRpc<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpc<'a> { + /// `session.agent.*` sub-namespace. + pub fn agent(&self) -> SessionRpcAgent<'a> { + SessionRpcAgent { + session: self.session, + } + } + + /// `session.canvas.*` sub-namespace. + pub fn canvas(&self) -> SessionRpcCanvas<'a> { + SessionRpcCanvas { + session: self.session, + } + } + + /// `session.commands.*` sub-namespace. + pub fn commands(&self) -> SessionRpcCommands<'a> { + SessionRpcCommands { + session: self.session, + } + } + + /// `session.completions.*` sub-namespace. + pub fn completions(&self) -> SessionRpcCompletions<'a> { + SessionRpcCompletions { + session: self.session, + } + } + + /// `session.contentExclusion.*` sub-namespace. + pub fn content_exclusion(&self) -> SessionRpcContentExclusion<'a> { + SessionRpcContentExclusion { + session: self.session, + } + } + + /// `session.debug.*` sub-namespace. + pub fn debug(&self) -> SessionRpcDebug<'a> { + SessionRpcDebug { + session: self.session, + } + } + + /// `session.eventLog.*` sub-namespace. + pub fn event_log(&self) -> SessionRpcEventLog<'a> { + SessionRpcEventLog { + session: self.session, + } + } /// `session.extensions.*` sub-namespace. pub fn extensions(&self) -> SessionRpcExtensions<'a> { @@ -1265,177 +2909,3299 @@ impl<'a> SessionRpc<'a> { } } - /// `session.fleet.*` sub-namespace. - pub fn fleet(&self) -> SessionRpcFleet<'a> { - SessionRpcFleet { + /// `session.factory.*` sub-namespace. + pub fn factory(&self) -> SessionRpcFactory<'a> { + SessionRpcFactory { + session: self.session, + } + } + + /// `session.fleet.*` sub-namespace. + pub fn fleet(&self) -> SessionRpcFleet<'a> { + SessionRpcFleet { + session: self.session, + } + } + + /// `session.gitHubAuth.*` sub-namespace. + pub fn git_hub_auth(&self) -> SessionRpcGitHubAuth<'a> { + SessionRpcGitHubAuth { + session: self.session, + } + } + + /// `session.history.*` sub-namespace. + pub fn history(&self) -> SessionRpcHistory<'a> { + SessionRpcHistory { + session: self.session, + } + } + + /// `session.instructions.*` sub-namespace. + pub fn instructions(&self) -> SessionRpcInstructions<'a> { + SessionRpcInstructions { + session: self.session, + } + } + + /// `session.limitPrediction.*` sub-namespace. + pub fn limit_prediction(&self) -> SessionRpcLimitPrediction<'a> { + SessionRpcLimitPrediction { + session: self.session, + } + } + + /// `session.lsp.*` sub-namespace. + pub fn lsp(&self) -> SessionRpcLsp<'a> { + SessionRpcLsp { + session: self.session, + } + } + + /// `session.mcp.*` sub-namespace. + pub fn mcp(&self) -> SessionRpcMcp<'a> { + SessionRpcMcp { + session: self.session, + } + } + + /// `session.metadata.*` sub-namespace. + pub fn metadata(&self) -> SessionRpcMetadata<'a> { + SessionRpcMetadata { + session: self.session, + } + } + + /// `session.mode.*` sub-namespace. + pub fn mode(&self) -> SessionRpcMode<'a> { + SessionRpcMode { + session: self.session, + } + } + + /// `session.model.*` sub-namespace. + pub fn model(&self) -> SessionRpcModel<'a> { + SessionRpcModel { + session: self.session, + } + } + + /// `session.name.*` sub-namespace. + pub fn name(&self) -> SessionRpcName<'a> { + SessionRpcName { + session: self.session, + } + } + + /// `session.options.*` sub-namespace. + pub fn options(&self) -> SessionRpcOptions<'a> { + SessionRpcOptions { + session: self.session, + } + } + + /// `session.permissions.*` sub-namespace. + pub fn permissions(&self) -> SessionRpcPermissions<'a> { + SessionRpcPermissions { + session: self.session, + } + } + + /// `session.plan.*` sub-namespace. + pub fn plan(&self) -> SessionRpcPlan<'a> { + SessionRpcPlan { + session: self.session, + } + } + + /// `session.plugins.*` sub-namespace. + pub fn plugins(&self) -> SessionRpcPlugins<'a> { + SessionRpcPlugins { + session: self.session, + } + } + + /// `session.provider.*` sub-namespace. + pub fn provider(&self) -> SessionRpcProvider<'a> { + SessionRpcProvider { + session: self.session, + } + } + + /// `session.queue.*` sub-namespace. + pub fn queue(&self) -> SessionRpcQueue<'a> { + SessionRpcQueue { + session: self.session, + } + } + + /// `session.remote.*` sub-namespace. + pub fn remote(&self) -> SessionRpcRemote<'a> { + SessionRpcRemote { + session: self.session, + } + } + + /// `session.schedule.*` sub-namespace. + pub fn schedule(&self) -> SessionRpcSchedule<'a> { + SessionRpcSchedule { + session: self.session, + } + } + + /// `session.settings.*` sub-namespace. + pub fn settings(&self) -> SessionRpcSettings<'a> { + SessionRpcSettings { + session: self.session, + } + } + + /// `session.shell.*` sub-namespace. + pub fn shell(&self) -> SessionRpcShell<'a> { + SessionRpcShell { + session: self.session, + } + } + + /// `session.skills.*` sub-namespace. + pub fn skills(&self) -> SessionRpcSkills<'a> { + SessionRpcSkills { + session: self.session, + } + } + + /// `session.tasks.*` sub-namespace. + pub fn tasks(&self) -> SessionRpcTasks<'a> { + SessionRpcTasks { + session: self.session, + } + } + + /// `session.telemetry.*` sub-namespace. + pub fn telemetry(&self) -> SessionRpcTelemetry<'a> { + SessionRpcTelemetry { + session: self.session, + } + } + + /// `session.tools.*` sub-namespace. + pub fn tools(&self) -> SessionRpcTools<'a> { + SessionRpcTools { + session: self.session, + } + } + + /// `session.ui.*` sub-namespace. + pub fn ui(&self) -> SessionRpcUi<'a> { + SessionRpcUi { + session: self.session, + } + } + + /// `session.usage.*` sub-namespace. + pub fn usage(&self) -> SessionRpcUsage<'a> { + SessionRpcUsage { + session: self.session, + } + } + + /// `session.visibility.*` sub-namespace. + pub fn visibility(&self) -> SessionRpcVisibility<'a> { + SessionRpcVisibility { + session: self.session, + } + } + + /// `session.workspaces.*` sub-namespace. + pub fn workspaces(&self) -> SessionRpcWorkspaces<'a> { + SessionRpcWorkspaces { + session: self.session, + } + } + + /// Suspends the session while preserving persisted state for later resume. + /// + /// Wire method: `session.suspend`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn suspend(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SUSPEND, Some(wire_params)) + .await?; + Ok(()) + } + + /// Sends a user message to the session and returns its message ID. + /// + /// Wire method: `session.send`. + /// + /// # Parameters + /// + /// * `params` - Parameters for sending a user message to the session + /// + /// # Returns + /// + /// Result of sending a user message + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn send(&self, params: SendRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SEND, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Sends zero or more user messages to the session in a single turn and returns their message IDs. All provided messages are appended to the conversation in order, then exactly one agent turn runs over the resulting history. When the list is empty, one turn runs over the existing history with no new user message. Remote-backed (Mission Control) sessions do not support this method and will return an error. + /// + /// Wire method: `session.sendMessages`. + /// + /// # Parameters + /// + /// * `params` - Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error. + /// + /// # Returns + /// + /// Result of sending zero or more user messages + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn send_messages( + &self, + params: SendMessagesRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SENDMESSAGES, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Queues or sends an internal system notification to the session according to its passive policy. + /// + /// Wire method: `session.sendSystemNotification`. + /// + /// # Parameters + /// + /// * `params` - Internal request for sending a system notification. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn send_system_notification( + &self, + params: SendSystemNotificationRequest, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_SENDSYSTEMNOTIFICATION, + Some(wire_params), + ) + .await?; + Ok(()) + } + + /// Aborts the current agent turn. + /// + /// Wire method: `session.abort`. + /// + /// # Parameters + /// + /// * `params` - Parameters for aborting the current turn + /// + /// # Returns + /// + /// Result of aborting the current turn + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn abort(&self, params: AbortRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_ABORT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Interrupts the current main agent turn while leaving running background work (subagents, sidekicks, and promoted attached shells) alive. No-op when the main loop is not processing. + /// + /// Wire method: `session.interruptMainTurn`. + /// + /// # Parameters + /// + /// * `params` - Parameters for interrupting the main agent turn. + /// + /// # Returns + /// + /// Result of interrupting the main agent turn. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn interrupt_main_turn( + &self, + params: InterruptMainTurnRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_INTERRUPTMAINTURN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop. Promoted attached shells are left running. + /// + /// Wire method: `session.cancelAllBackgroundAgents`. + /// + /// # Returns + /// + /// The number of running background agents (task-registry agents) that were cancelled. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn cancel_all_background_agents( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_CANCELALLBACKGROUNDAGENTS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down. + /// + /// Wire method: `session.shutdown`. + /// + /// # Parameters + /// + /// * `params` - Parameters for shutting down the session + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn shutdown(&self, params: ShutdownRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SHUTDOWN, Some(wire_params)) + .await?; + Ok(()) + } + + /// Emits a user-visible session log event. + /// + /// Wire method: `session.log`. + /// + /// # Parameters + /// + /// * `params` - Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + /// + /// # Returns + /// + /// Identifier of the session event that was emitted for the log message. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn log(&self, params: LogRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_LOG, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.agent.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcAgent<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcAgent<'a> { + /// Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents. + /// + /// Wire method: `session.agent.list`. + /// + /// # Returns + /// + /// Agents available to the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents. + /// + /// Wire method: `session.agent.list`. + /// + /// # Parameters + /// + /// * `params` - Controls whether built-in agents and authored prompt text are included. + /// + /// # Returns + /// + /// Agents available to the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_with_params(&self, params: AgentListRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Sets an in-memory authored prompt override for an available agent. For built-in agents, this replaces only the static base prompt while preserving runtime-owned dynamic prompt composition and behavior. The special `general-purpose` agent is not overrideable. Overrides are not persisted; resumed and forked sessions start without them, so the host must re-apply them. + /// + /// Wire method: `session.agent.setPrompt`. + /// + /// # Parameters + /// + /// * `params` - An in-memory authored prompt override for an available agent. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_prompt(&self, params: AgentSetPromptRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_SETPROMPT, Some(wire_params)) + .await?; + Ok(()) + } + + /// Gets the currently selected custom agent for the session. + /// + /// Wire method: `session.agent.getCurrent`. + /// + /// # Returns + /// + /// The currently selected custom agent, or null when using the default agent. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_current(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_GETCURRENT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Selects a custom agent for subsequent turns in the session. + /// + /// Wire method: `session.agent.select`. + /// + /// # Parameters + /// + /// * `params` - Name of the custom agent to select for subsequent turns. + /// + /// # Returns + /// + /// The newly selected custom agent. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn select(&self, params: AgentSelectRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_SELECT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Clears the selected custom agent and returns the session to the default agent. + /// + /// Wire method: `session.agent.deselect`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn deselect(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_DESELECT, Some(wire_params)) + .await?; + Ok(()) + } + + /// Reloads custom agent definitions and returns the refreshed list. + /// + /// Wire method: `session.agent.reload`. + /// + /// # Returns + /// + /// Custom agents available to the session after reloading definitions from disk. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn reload(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_AGENT_RELOAD, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.canvas.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcCanvas<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcCanvas<'a> { + /// `session.canvas.action.*` sub-namespace. + pub fn action(&self) -> SessionRpcCanvasAction<'a> { + SessionRpcCanvasAction { + session: self.session, + } + } + + /// Lists canvases declared for the session. + /// + /// Wire method: `session.canvas.list`. + /// + /// # Returns + /// + /// Declared canvases available in this session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_CANVAS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists currently open canvas instances for the live session. + /// + /// Wire method: `session.canvas.listOpen`. + /// + /// # Returns + /// + /// Live open-canvas snapshot. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_open(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_CANVAS_LISTOPEN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Opens or focuses a canvas instance. + /// + /// Wire method: `session.canvas.open`. + /// + /// # Parameters + /// + /// * `params` - Canvas open parameters. + /// + /// # Returns + /// + /// Open canvas instance snapshot. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn open(&self, params: CanvasOpenRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_CANVAS_OPEN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Closes an open canvas instance. + /// + /// Wire method: `session.canvas.close`. + /// + /// # Parameters + /// + /// * `params` - Canvas close parameters. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn close(&self, params: CanvasCloseRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_CANVAS_CLOSE, Some(wire_params)) + .await?; + Ok(()) + } +} + +/// `session.canvas.action.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcCanvasAction<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcCanvasAction<'a> { + /// Invokes an action on an open canvas instance. + /// + /// Wire method: `session.canvas.action.invoke`. + /// + /// # Parameters + /// + /// * `params` - Canvas action invocation parameters. + /// + /// # Returns + /// + /// Canvas action invocation result. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn invoke( + &self, + params: CanvasActionInvokeRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_CANVAS_ACTION_INVOKE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.commands.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcCommands<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcCommands<'a> { + /// Lists slash commands available in the session. + /// + /// Wire method: `session.commands.list`. + /// + /// # Returns + /// + /// Slash commands available in the session, after applying any include/exclude filters. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMMANDS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists slash commands available in the session. + /// + /// Wire method: `session.commands.list`. + /// + /// # Parameters + /// + /// * `params` - Optional filters controlling which command sources to include in the listing. + /// + /// # Returns + /// + /// Slash commands available in the session, after applying any include/exclude filters. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_with_params( + &self, + params: CommandsListRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMMANDS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Invokes a slash command in the session. + /// + /// Wire method: `session.commands.invoke`. + /// + /// # Parameters + /// + /// * `params` - Slash command name and optional raw input string to invoke. + /// + /// # Returns + /// + /// Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn invoke( + &self, + params: CommandsInvokeRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMMANDS_INVOKE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reports completion of a pending client-handled slash command. + /// + /// Wire method: `session.commands.handlePendingCommand`. + /// + /// # Parameters + /// + /// * `params` - Pending command request ID and an optional error if the client handler failed. + /// + /// # Returns + /// + /// Indicates whether the pending client-handled command was completed successfully. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn handle_pending_command( + &self, + params: CommandsHandlePendingCommandRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_COMMANDS_HANDLEPENDINGCOMMAND, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Executes a slash command synchronously and returns any error. + /// + /// Wire method: `session.commands.execute`. + /// + /// # Parameters + /// + /// * `params` - Slash command name and argument string to execute synchronously. + /// + /// # Returns + /// + /// Error message produced while executing the command, if any. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn execute( + &self, + params: ExecuteCommandParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMMANDS_EXECUTE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Enqueues a slash command for FIFO processing on the local session. + /// + /// Wire method: `session.commands.enqueue`. + /// + /// # Parameters + /// + /// * `params` - Slash-prefixed command string to enqueue for FIFO processing. + /// + /// # Returns + /// + /// Indicates whether the command was accepted into the local execution queue. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn enqueue( + &self, + params: EnqueueCommandParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMMANDS_ENQUEUE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Reports whether the host actually executed a queued command and whether to continue processing. + /// + /// Wire method: `session.commands.respondToQueuedCommand`. + /// + /// # Parameters + /// + /// * `params` - Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). + /// + /// # Returns + /// + /// Indicates whether the queued-command response was matched to a pending request. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn respond_to_queued_command( + &self, + params: CommandsRespondToQueuedCommandRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_COMMANDS_RESPONDTOQUEUEDCOMMAND, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.completions.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcCompletions<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcCompletions<'a> { + /// Gets the characters that should trigger host-driven completions for the session. Empty disables host-driven completions (e.g. local sessions, or a relay host that does not advertise them). + /// + /// Wire method: `session.completions.getTriggerCharacters`. + /// + /// # Returns + /// + /// Characters that, when typed in the composer, should trigger a `completions.request`. Empty when the session has no host-driven completions (e.g. local sessions, or a relay host that does not advertise `completionTriggerCharacters`). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_trigger_characters( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_COMPLETIONS_GETTRIGGERCHARACTERS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Requests host-driven completion items for the current composer input. Returns an empty list when the host has no items or does not support completions. + /// + /// Wire method: `session.completions.request`. + /// + /// # Parameters + /// + /// * `params` - Request host-driven completions for the current composer input. + /// + /// # Returns + /// + /// Host-driven completion items for the current composer input. Empty when the host returns no items or does not support completions. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn request( + &self, + params: CompletionsRequestRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_COMPLETIONS_REQUEST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.contentExclusion.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcContentExclusion<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcContentExclusion<'a> { + /// Checks local file system absolute paths within the session working directory against its content-exclusion policy. Results preserve input order. Unsupported paths/filesystems and unavailable policy evaluation return available false, and callers must treat every requested path as excluded. + /// + /// Wire method: `session.contentExclusion.checkPaths`. + /// + /// # Parameters + /// + /// * `params` - Local file system absolute paths within the session working directory to check against its content-exclusion policy. + /// + /// # Returns + /// + /// Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn check_paths( + &self, + params: ContentExclusionCheckPathsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_CONTENTEXCLUSION_CHECKPATHS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.debug.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcDebug<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcDebug<'a> { + /// Collects a redacted session debug log bundle into a local archive or staging directory. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape. + /// + /// Wire method: `session.debug.collectLogs`. + /// + /// # Parameters + /// + /// * `params` - Options for collecting a redacted session debug bundle. + /// + /// # Returns + /// + /// Result of collecting a redacted debug bundle. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn collect_logs( + &self, + params: DebugCollectLogsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_DEBUG_COLLECTLOGS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.eventLog.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcEventLog<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcEventLog<'a> { + /// Reads a batch of session events from a cursor, optionally waiting for new events. Supports tail-first reads via `direction: backward`. + /// + /// Wire method: `session.eventLog.read`. + /// + /// # Parameters + /// + /// * `params` - Cursor, batch size, and optional long-poll/filter parameters for reading session events. + /// + /// # Returns + /// + /// Batch of session events returned by a read, with cursor and continuation metadata. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn read(&self, params: EventLogReadRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EVENTLOG_READ, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns a snapshot of the current tail cursor without consuming events. + /// + /// Wire method: `session.eventLog.tail`. + /// + /// # Returns + /// + /// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn tail(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EVENTLOG_TAIL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Registers consumer interest in an event type for runtime gating purposes. + /// + /// Wire method: `session.eventLog.registerInterest`. + /// + /// # Parameters + /// + /// * `params` - Event type to register consumer interest for, used by runtime gating logic. + /// + /// # Returns + /// + /// Opaque handle representing an event-type interest registration. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn register_interest( + &self, + params: RegisterEventInterestParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_EVENTLOG_REGISTERINTEREST, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Releases a consumer's previously-registered interest in an event type. + /// + /// Wire method: `session.eventLog.releaseInterest`. + /// + /// # Parameters + /// + /// * `params` - Opaque handle previously returned by `registerInterest` to release. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn release_interest( + &self, + params: ReleaseEventInterestParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_EVENTLOG_RELEASEINTEREST, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.extensions.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcExtensions<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcExtensions<'a> { + /// Lists extensions discovered for the session and their current status. + /// + /// Wire method: `session.extensions.list`. + /// + /// # Returns + /// + /// Extensions discovered for the session, with their current status. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EXTENSIONS_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Enables an extension for the session. + /// + /// Wire method: `session.extensions.enable`. + /// + /// # Parameters + /// + /// * `params` - Source-qualified extension identifier to enable for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn enable(&self, params: ExtensionsEnableRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EXTENSIONS_ENABLE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Disables an extension for the session. + /// + /// Wire method: `session.extensions.disable`. + /// + /// # Parameters + /// + /// * `params` - Source-qualified extension identifier to disable for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn disable(&self, params: ExtensionsDisableRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EXTENSIONS_DISABLE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Reloads extension definitions and processes for the session. + /// + /// Wire method: `session.extensions.reload`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn reload(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_EXTENSIONS_RELOAD, Some(wire_params)) + .await?; + Ok(()) + } + + /// Push attachments into the next user-message turn from an extension. The host should surface them as composer pills and forward them via the next session.send call. Callable only by extension-owned connections. + /// + /// Wire method: `session.extensions.sendAttachmentsToMessage`. + /// + /// # Parameters + /// + /// * `params` - Parameters for session.extensions.sendAttachmentsToMessage. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn send_attachments_to_message( + &self, + params: SendAttachmentsToMessageParams, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_EXTENSIONS_SENDATTACHMENTSTOMESSAGE, + Some(wire_params), + ) + .await?; + Ok(()) + } +} + +/// `session.factory.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcFactory<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcFactory<'a> { + /// `session.factory.journal.*` sub-namespace. + pub fn journal(&self) -> SessionRpcFactoryJournal<'a> { + SessionRpcFactoryJournal { + session: self.session, + } + } + + /// Runs a registered factory by name at the top level. + /// + /// Wire method: `session.factory.run`. + /// + /// # Parameters + /// + /// * `params` - Parameters for invoking a registered factory. + /// + /// # Returns + /// + /// Complete current or terminal factory run envelope. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn run(&self, params: FactoryRunRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_RUN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Resumes a factory run using its persisted name, arguments, journal, and accounting. + /// + /// Wire method: `session.factory.resume`. + /// + /// # Parameters + /// + /// * `params` - Parameters for resuming a factory run from its persisted identity. + /// + /// # Returns + /// + /// Resolved persisted factory identity and resumed run envelope. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn resume(&self, params: FactoryResumeRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_RESUME, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Gets the current or settled envelope for a factory run. + /// + /// Wire method: `session.factory.getRun`. + /// + /// # Parameters + /// + /// * `params` - Parameters for retrieving a factory run. + /// + /// # Returns + /// + /// Complete current or terminal factory run envelope. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_run(&self, params: FactoryGetRunRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_GETRUN, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists durable factory runs for this session in creation order. + /// + /// Wire method: `session.factory.listRuns`. + /// + /// # Parameters + /// + /// * `params` - Parameters for paging factory runs. + /// + /// # Returns + /// + /// A page of factory runs in durable creation order. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_runs( + &self, + params: FactoryListRunsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_LISTRUNS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Gets durable and live observability detail for one factory run. + /// + /// Wire method: `session.factory.getRunDetail`. + /// + /// # Parameters + /// + /// * `params` - Parameters for retrieving a factory run. + /// + /// # Returns + /// + /// Full factory run observability detail. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_run_detail( + &self, + params: FactoryGetRunRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_GETRUNDETAIL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Pages durable progress for one factory run. + /// + /// Wire method: `session.factory.getRunProgress`. + /// + /// # Parameters + /// + /// * `params` - Parameters for paging factory progress. + /// + /// # Returns + /// + /// A bidirectional page of factory progress. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_run_progress( + &self, + params: FactoryGetRunProgressRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_FACTORY_GETRUNPROGRESS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Requests cancellation of a factory run and returns its run envelope. + /// + /// Wire method: `session.factory.cancel`. + /// + /// # Parameters + /// + /// * `params` - Parameters for cancelling a factory run. + /// + /// # Returns + /// + /// Complete current or terminal factory run envelope. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn cancel(&self, params: FactoryCancelRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_CANCEL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Records a batch of ordered factory progress lines. + /// + /// Wire method: `session.factory.log`. + /// + /// # Parameters + /// + /// * `params` - Parameters for recording factory progress. + /// + /// # Returns + /// + /// Acknowledgement that a factory request was accepted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn log(&self, params: FactoryLogRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_LOG, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Runs one factory-scoped subagent and returns its result. + /// + /// Wire method: `session.factory.agent`. + /// + /// # Parameters + /// + /// * `params` - Parameters for one factory-scoped subagent call. + /// + /// # Returns + /// + /// Result of one factory-scoped subagent call. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn agent(&self, params: FactoryAgentRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_AGENT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.factory.journal.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcFactoryJournal<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcFactoryJournal<'a> { + /// Reads a memoized factory journal entry. + /// + /// Wire method: `session.factory.journal.get`. + /// + /// # Parameters + /// + /// * `params` - Parameters for reading a factory journal entry. + /// + /// # Returns + /// + /// Result of reading a factory journal entry. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get( + &self, + params: FactoryJournalGetRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_JOURNAL_GET, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Stores a memoized factory journal entry. + /// + /// Wire method: `session.factory.journal.put`. + /// + /// # Parameters + /// + /// * `params` - Parameters for storing a factory journal entry. + /// + /// # Returns + /// + /// Acknowledgement that a factory request was accepted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn put(&self, params: FactoryJournalPutRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FACTORY_JOURNAL_PUT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.fleet.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcFleet<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcFleet<'a> { + /// Starts fleet mode by submitting the fleet orchestration prompt to the session. + /// + /// Wire method: `session.fleet.start`. + /// + /// # Parameters + /// + /// * `params` - Optional user prompt to combine with the fleet orchestration instructions. + /// + /// # Returns + /// + /// Indicates whether fleet mode was successfully activated. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn start(&self, params: FleetStartRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_FLEET_START, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.gitHubAuth.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcGitHubAuth<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcGitHubAuth<'a> { + /// Gets authentication status and account metadata for the session. + /// + /// Wire method: `session.gitHubAuth.getStatus`. + /// + /// # Returns + /// + /// Authentication status and account metadata for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_status(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_GITHUBAUTH_GETSTATUS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Updates the session's auth credentials used for outbound model and API requests. + /// + /// Wire method: `session.gitHubAuth.setCredentials`. + /// + /// # Parameters + /// + /// * `params` - New auth credentials to install on the session. Omit to leave credentials unchanged. + /// + /// # Returns + /// + /// Indicates whether the credential update succeeded. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_credentials( + &self, + params: SessionSetCredentialsParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_GITHUBAUTH_SETCREDENTIALS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.history.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcHistory<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcHistory<'a> { + /// Compacts the session history to reduce context usage. + /// + /// Wire method: `session.history.compact`. + /// + /// # Returns + /// + /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn compact(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_HISTORY_COMPACT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Compacts the session history to reduce context usage. + /// + /// Wire method: `session.history.compact`. + /// + /// # Parameters + /// + /// * `params` - Optional compaction parameters. + /// + /// # Returns + /// + /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn compact_with_params( + &self, + params: HistoryCompactRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_HISTORY_COMPACT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Truncates persisted session history to a specific event. + /// + /// Wire method: `session.history.truncate`. + /// + /// # Parameters + /// + /// * `params` - Identifier of the event to truncate to; this event and all later events are removed. + /// + /// # Returns + /// + /// Number of events that were removed by the truncation. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn truncate( + &self, + params: HistoryTruncateRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_HISTORY_TRUNCATE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists the user turns that the session can rewind to. Never rejects for a busy session: rewind reads need the session's file-change captures to be settled, so a session that still holds active work answers with `unavailableReason: "session-busy"` and no points, which the caller can retry. + /// + /// Wire method: `session.history.listRewindPoints`. + /// + /// # Returns + /// + /// Rewind points and file-change-tracking availability for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_rewind_points(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_HISTORY_LISTREWINDPOINTS, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Previews the files that a conversation-and-files rewind would restore. + /// + /// Wire method: `session.history.previewRewind`. + /// + /// # Parameters + /// + /// * `params` - Event boundary to preview for conversation-and-files rewind. + /// + /// # Returns + /// + /// Files and aggregate changes for a prospective rewind. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn preview_rewind( + &self, + params: HistoryPreviewRewindRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_HISTORY_PREVIEWREWIND, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Rewinds the session conversation, optionally restoring files changed by the discarded turns. Not crash-atomic: file restore and conversation truncation are separate stores, applied in that order, so a process crash between them can leave the workspace rewound while the conversation still contains the discarded turns. There is no recovery journal; re-running the same rewind is the recovery path for a crash before truncation lands, since file restore is idempotent (already-restored files are reported as skipped) and truncation is re-derived from the still-retained boundary event. After truncation lands that boundary no longer exists, so the same request is rejected; the only stage that can still be outstanding is snapshot pruning, whose failure leaves orphan snapshots the capture store tolerates. The reverse inconsistency cannot occur, because truncation is never applied before file restore succeeds. + /// + /// Wire method: `session.history.rewind`. + /// + /// # Parameters + /// + /// * `params` - Boundary and mode for rewinding session history. + /// + /// # Returns + /// + /// Structured outcome of a rewind request. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn rewind(&self, params: HistoryRewindRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_HISTORY_REWIND, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Cancels any in-progress background compaction on a local session. + /// + /// Wire method: `session.history.cancelBackgroundCompaction`. + /// + /// # Returns + /// + /// Indicates whether an in-progress background compaction was cancelled. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn cancel_background_compaction( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_HISTORY_CANCELBACKGROUNDCOMPACTION, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Aborts any in-progress manual compaction on a local session. + /// + /// Wire method: `session.history.abortManualCompaction`. + /// + /// # Returns + /// + /// Indicates whether an in-progress manual compaction was aborted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn abort_manual_compaction( + &self, + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_HISTORY_ABORTMANUALCOMPACTION, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Produces a markdown summary of the session's conversation context for hand-off scenarios. + /// + /// Wire method: `session.history.summarizeForHandoff`. + /// + /// # Returns + /// + /// Markdown summary of the conversation context (empty when not available). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn summarize_for_handoff(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_HISTORY_SUMMARIZEFORHANDOFF, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Clears the session's conversation history, keeping only system and developer messages, and seeds the fresh context window with a first user message. Must be called from inside a tool handler: the clear has to drop the results of the tool calls its wipe orphans, and it rejects when no tool call is in flight. + /// + /// Wire method: `session.history.clearContext`. + /// + /// # Parameters + /// + /// * `params` - Parameters for clearing the conversation and seeding the window that replaces it. + /// + /// # Returns + /// + /// What a successful clear removed. A clear that could not be applied rejects instead of reporting a count. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn clear_context( + &self, + params: HistoryClearContextRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_HISTORY_CLEARCONTEXT, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.instructions.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcInstructions<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcInstructions<'a> { + /// Gets instruction sources loaded for the session. + /// + /// Wire method: `session.instructions.getSources`. + /// + /// # Returns + /// + /// Instruction sources loaded for the session, in merge order. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_sources(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_INSTRUCTIONS_GETSOURCES, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.limitPrediction.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcLimitPrediction<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcLimitPrediction<'a> { + /// Predicts an AI-credit session limit for the session's resolved model. Returns an unavailable result instead of falling back when the current model is unresolved auto. + /// + /// Wire method: `session.limitPrediction.predict`. + /// + /// # Returns + /// + /// Prediction result. Available results include prediction details; unavailable results include an explicit reason. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn predict(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_LIMITPREDICTION_PREDICT, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Predicts an AI-credit session limit for the session's resolved model. Returns an unavailable result instead of falling back when the current model is unresolved auto. + /// + /// Wire method: `session.limitPrediction.predict`. + /// + /// # Parameters + /// + /// * `params` - Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model. + /// + /// # Returns + /// + /// Prediction result. Available results include prediction details; unavailable results include an explicit reason. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn predict_with_params( + &self, + params: SessionLimitPredictionRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_LIMITPREDICTION_PREDICT, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } +} + +/// `session.lsp.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcLsp<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcLsp<'a> { + /// Loads the merged LSP configuration set for the session's working directory. + /// + /// Wire method: `session.lsp.initialize`. + /// + /// # Parameters + /// + /// * `params` - Parameters for (re)loading the merged LSP configuration set. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn initialize(&self, params: LspInitializeRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_LSP_INITIALIZE, Some(wire_params)) + .await?; + Ok(()) + } +} + +/// `session.mcp.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcp<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcMcp<'a> { + /// `session.mcp.apps.*` sub-namespace. + pub fn apps(&self) -> SessionRpcMcpApps<'a> { + SessionRpcMcpApps { session: self.session, } } - /// `session.history.*` sub-namespace. - pub fn history(&self) -> SessionRpcHistory<'a> { - SessionRpcHistory { + /// `session.mcp.headers.*` sub-namespace. + pub fn headers(&self) -> SessionRpcMcpHeaders<'a> { + SessionRpcMcpHeaders { session: self.session, } } - /// `session.instructions.*` sub-namespace. - pub fn instructions(&self) -> SessionRpcInstructions<'a> { - SessionRpcInstructions { + /// `session.mcp.oauth.*` sub-namespace. + pub fn oauth(&self) -> SessionRpcMcpOauth<'a> { + SessionRpcMcpOauth { session: self.session, } } - /// `session.lsp.*` sub-namespace. - pub fn lsp(&self) -> SessionRpcLsp<'a> { - SessionRpcLsp { + /// `session.mcp.resources.*` sub-namespace. + pub fn resources(&self) -> SessionRpcMcpResources<'a> { + SessionRpcMcpResources { session: self.session, } } - /// `session.mcp.*` sub-namespace. - pub fn mcp(&self) -> SessionRpcMcp<'a> { - SessionRpcMcp { - session: self.session, - } + /// Lists MCP servers configured for the session, their connection status, and host-level state. The host-level state (disabled/filtered servers, failed/needs-auth/pending connections, mcp3p policy, full config) is empty/zero when no MCP host has been initialized for the session. + /// + /// Wire method: `session.mcp.list`. + /// + /// # Returns + /// + /// MCP servers configured for the session, with their connection status and host-level state. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_LIST, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Lists the tools exposed by a connected MCP server on this session's host. This performs a live `tools/list` request. Tool UI metadata is returned independently of whether MCP Apps rendering is enabled for the session. + /// + /// Wire method: `session.mcp.listTools`. + /// + /// # Parameters + /// + /// * `params` - Server name whose tool list should be returned. + /// + /// # Returns + /// + /// Tools exposed by the connected MCP server. Throws when the server is not connected. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_tools( + &self, + params: McpListToolsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_LISTTOOLS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Enables an MCP server for the session. + /// + /// Wire method: `session.mcp.enable`. + /// + /// # Parameters + /// + /// * `params` - Name of the MCP server to enable for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn enable(&self, params: McpEnableRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_ENABLE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Disables an MCP server for the session. + /// + /// Wire method: `session.mcp.disable`. + /// + /// # Parameters + /// + /// * `params` - Name of the MCP server to disable for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn disable(&self, params: McpDisableRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_DISABLE, Some(wire_params)) + .await?; + Ok(()) + } + + /// Reloads MCP server connections for the session. + /// + /// Wire method: `session.mcp.reload`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn reload(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_RELOAD, Some(wire_params)) + .await?; + Ok(()) + } + + /// Reloads MCP server connections for the session with an explicit host-provided configuration. + /// + /// Wire method: `session.mcp.reloadWithConfig`. + /// + /// # Parameters + /// + /// * `params` - Opaque MCP reload configuration. + /// + /// # Returns + /// + /// MCP server startup filtering result. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn reload_with_config( + &self, + params: McpReloadWithConfigRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_RELOADWITHCONFIG, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Runs an MCP sampling inference on behalf of an MCP server. + /// + /// Wire method: `session.mcp.executeSampling`. + /// + /// # Parameters + /// + /// * `params` - Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + /// + /// # Returns + /// + /// Outcome of an MCP sampling execution: success result, failure error, or cancellation. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn execute_sampling( + &self, + params: McpExecuteSamplingParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_EXECUTESAMPLING, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Cancels an in-flight MCP sampling execution by request ID. + /// + /// Wire method: `session.mcp.cancelSamplingExecution`. + /// + /// # Parameters + /// + /// * `params` - The requestId previously passed to executeSampling that should be cancelled. + /// + /// # Returns + /// + /// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn cancel_sampling_execution( + &self, + params: McpCancelSamplingExecutionParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_CANCELSAMPLINGEXECUTION, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect). + /// + /// Wire method: `session.mcp.setEnvValueMode`. + /// + /// # Parameters + /// + /// * `params` - Mode controlling how MCP server env values are resolved (`direct` or `indirect`). + /// + /// # Returns + /// + /// Env-value mode recorded on the session after the update. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_env_value_mode( + &self, + params: McpSetEnvValueModeParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_SETENVVALUEMODE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Removes the auto-managed `github` MCP server when present. + /// + /// Wire method: `session.mcp.removeGitHub`. + /// + /// # Returns + /// + /// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn remove_git_hub(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_REMOVEGITHUB, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.metadata.*` sub-namespace. - pub fn metadata(&self) -> SessionRpcMetadata<'a> { - SessionRpcMetadata { - session: self.session, - } + /// Configures the built-in GitHub MCP server for the session's current auth context. + /// + /// Wire method: `session.mcp.configureGitHub`. + /// + /// # Parameters + /// + /// * `params` - Opaque auth info used to configure GitHub MCP. + /// + /// # Returns + /// + /// Result of configuring GitHub MCP. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn configure_git_hub( + &self, + params: McpConfigureGitHubRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_CONFIGUREGITHUB, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.mode.*` sub-namespace. - pub fn mode(&self) -> SessionRpcMode<'a> { - SessionRpcMode { - session: self.session, - } + /// Starts an individual MCP server on the live session. Omit `config` for a config-free start-by-name of an already-configured server (reuses the server's already-registered configuration); supply `config` to start from a caller-supplied configuration. Session-scoped and ephemeral: the server is added to this session's running set only and is reaped when the session ends. Does NOT modify persistent user configuration (`mcp.config.*`), so it does not affect future sessions. The server surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / `session.mcp_server_status_changed` events like any other server. + /// + /// Wire method: `session.mcp.startServer`. + /// + /// # Parameters + /// + /// * `params` - Server name and optional configuration for an individual MCP server start. Omit `config` for a config-free start-by-name of an already-configured server. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn start_server(&self, params: McpStartServerRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_STARTSERVER, Some(wire_params)) + .await?; + Ok(()) } - /// `session.model.*` sub-namespace. - pub fn model(&self) -> SessionRpcModel<'a> { - SessionRpcModel { - session: self.session, - } + /// Restarts an individual MCP server on the live session (stops then starts). Omit `config` for a config-free restart-by-name of an already-configured server; supply `config` to restart with a replacement configuration. Session-scoped and ephemeral: does NOT modify persistent user configuration (`mcp.config.*`). + /// + /// Wire method: `session.mcp.restartServer`. + /// + /// # Parameters + /// + /// * `params` - Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn restart_server(&self, params: McpRestartServerRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_RESTARTSERVER, Some(wire_params)) + .await?; + Ok(()) } - /// `session.name.*` sub-namespace. - pub fn name(&self) -> SessionRpcName<'a> { - SessionRpcName { - session: self.session, - } + /// Stops an individual MCP server on the session's host. + /// + /// Wire method: `session.mcp.stopServer`. + /// + /// # Parameters + /// + /// * `params` - Server name for an individual MCP server stop. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn stop_server(&self, params: McpStopServerRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_STOPSERVER, Some(wire_params)) + .await?; + Ok(()) } - /// `session.options.*` sub-namespace. - pub fn options(&self) -> SessionRpcOptions<'a> { - SessionRpcOptions { - session: self.session, - } + /// Registers a pre-connected external MCP client (e.g. IDE) on the session's host. The caller retains lifecycle ownership of the client and transport. Marked internal because the `client` and `transport` arguments are in-process MCP SDK instances that cannot be serialized across the JSON-RPC boundary; once the CLI moves on top of the SDK, external clients will be expressed as transport configs the runtime can construct itself. + /// + /// Wire method: `session.mcp.registerExternalClient`. + /// + /// # Parameters + /// + /// * `params` - Registration parameters for an external MCP client. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn register_external_client( + &self, + params: McpRegisterExternalClientRequest, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_REGISTEREXTERNALCLIENT, + Some(wire_params), + ) + .await?; + Ok(()) } - /// `session.permissions.*` sub-namespace. - pub fn permissions(&self) -> SessionRpcPermissions<'a> { - SessionRpcPermissions { - session: self.session, - } + /// Unregisters a previously registered external MCP client by server name. Marked internal as the paired companion of `registerExternalClient`: only in-process callers that registered a client this way can meaningfully unregister it. Disappears alongside `registerExternalClient`: once external clients are described to the runtime as config rather than handed in as instances, lifecycle (including deregistration) is owned entirely by the runtime. + /// + /// Wire method: `session.mcp.unregisterExternalClient`. + /// + /// # Parameters + /// + /// * `params` - Server name identifying the external client to remove. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub(crate) async fn unregister_external_client( + &self, + params: McpUnregisterExternalClientRequest, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_UNREGISTEREXTERNALCLIENT, + Some(wire_params), + ) + .await?; + Ok(()) } - /// `session.plan.*` sub-namespace. - pub fn plan(&self) -> SessionRpcPlan<'a> { - SessionRpcPlan { - session: self.session, - } + /// Checks whether a named MCP server is currently running on the session's host. + /// + /// Wire method: `session.mcp.isServerRunning`. + /// + /// # Parameters + /// + /// * `params` - Server name to check running status for. + /// + /// # Returns + /// + /// Whether the named MCP server is running. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn is_server_running( + &self, + params: McpIsServerRunningRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_ISSERVERRUNNING, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } +} - /// `session.plugins.*` sub-namespace. - pub fn plugins(&self) -> SessionRpcPlugins<'a> { - SessionRpcPlugins { - session: self.session, - } - } +/// `session.mcp.apps.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpApps<'a> { + pub(crate) session: &'a Session, +} - /// `session.queue.*` sub-namespace. - pub fn queue(&self) -> SessionRpcQueue<'a> { - SessionRpcQueue { - session: self.session, - } +impl<'a> SessionRpcMcpApps<'a> { + /// Fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) from a connected server. Requires the `mcp-apps` session capability. + /// + /// Wire method: `session.mcp.apps.readResource`. + /// + /// # Parameters + /// + /// * `params` - MCP server and resource URI to fetch. + /// + /// # Returns + /// + /// Resource contents returned by the MCP server. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn read_resource( + &self, + params: McpAppsReadResourceRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_APPS_READRESOURCE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.remote.*` sub-namespace. - pub fn remote(&self) -> SessionRpcRemote<'a> { - SessionRpcRemote { - session: self.session, - } + /// List tools that an MCP App view is allowed to call (SEP-1865 visibility filter). Returns tools whose `_meta.ui.visibility` is unset (default `["model","app"]`) or includes `"app"`. + /// + /// Wire method: `session.mcp.apps.listTools`. + /// + /// # Parameters + /// + /// * `params` - MCP server to list app-callable tools for. + /// + /// # Returns + /// + /// App-callable tools from the named MCP server. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn list_tools( + &self, + params: McpAppsListToolsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_APPS_LISTTOOLS, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.schedule.*` sub-namespace. - pub fn schedule(&self) -> SessionRpcSchedule<'a> { - SessionRpcSchedule { - session: self.session, - } + /// Call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check that prevents an app iframe from invoking model-only tools. Returns the standard MCP `CallToolResult`. + /// + /// Wire method: `session.mcp.apps.callTool`. + /// + /// # Parameters + /// + /// * `params` - MCP server, tool name, and arguments to invoke from an MCP App view. + /// + /// # Returns + /// + /// Standard MCP CallToolResult + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn call_tool( + &self, + params: McpAppsCallToolRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_APPS_CALLTOOL, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.shell.*` sub-namespace. - pub fn shell(&self) -> SessionRpcShell<'a> { - SessionRpcShell { - session: self.session, - } + /// Replace the host context returned to MCP App guests on `ui/initialize`. Hosts use this to advertise theme, locale, or other metadata to the guest UI. + /// + /// Wire method: `session.mcp.apps.setHostContext`. + /// + /// # Parameters + /// + /// * `params` - Host context to advertise to MCP App guests. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn set_host_context( + &self, + params: McpAppsSetHostContextRequest, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_APPS_SETHOSTCONTEXT, + Some(wire_params), + ) + .await?; + Ok(()) } - /// `session.skills.*` sub-namespace. - pub fn skills(&self) -> SessionRpcSkills<'a> { - SessionRpcSkills { - session: self.session, - } + /// Read the current host context advertised to MCP App guests. + /// + /// Wire method: `session.mcp.apps.getHostContext`. + /// + /// # Returns + /// + /// Current host context advertised to MCP App guests. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn get_host_context(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_APPS_GETHOSTCONTEXT, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.tasks.*` sub-namespace. - pub fn tasks(&self) -> SessionRpcTasks<'a> { - SessionRpcTasks { - session: self.session, - } + /// Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, feature-flag state, advertised extension, and how many tools have `_meta.ui` populated. + /// + /// Wire method: `session.mcp.apps.diagnose`. + /// + /// # Parameters + /// + /// * `params` - MCP server to diagnose MCP Apps wiring for. + /// + /// # Returns + /// + /// Diagnostic snapshot of MCP Apps wiring for the named server. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn diagnose( + &self, + params: McpAppsDiagnoseRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_MCP_APPS_DIAGNOSE, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) } +} - /// `session.telemetry.*` sub-namespace. - pub fn telemetry(&self) -> SessionRpcTelemetry<'a> { - SessionRpcTelemetry { - session: self.session, - } - } +/// `session.mcp.headers.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpHeaders<'a> { + pub(crate) session: &'a Session, +} - /// `session.tools.*` sub-namespace. - pub fn tools(&self) -> SessionRpcTools<'a> { - SessionRpcTools { - session: self.session, - } +impl<'a> SessionRpcMcpHeaders<'a> { + /// Responds to a pending MCP dynamic headers refresh request. Hosts that subscribe to `mcp.headers_refresh_required` use this to provide short-lived per-server headers or to indicate that no dynamic headers are available for this refresh. + /// + /// Wire method: `session.mcp.headers.handlePendingHeadersRefreshRequest`. + /// + /// # Parameters + /// + /// * `params` - MCP headers refresh request id and the host response. + /// + /// # Returns + /// + /// Indicates whether the pending MCP headers refresh response was accepted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn handle_pending_headers_refresh_request( + &self, + params: McpHeadersHandlePendingHeadersRefreshRequestRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_HEADERS_HANDLEPENDINGHEADERSREFRESHREQUEST, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) } +} - /// `session.ui.*` sub-namespace. - pub fn ui(&self) -> SessionRpcUi<'a> { - SessionRpcUi { - session: self.session, - } - } +/// `session.mcp.oauth.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpOauth<'a> { + pub(crate) session: &'a Session, +} - /// `session.usage.*` sub-namespace. - pub fn usage(&self) -> SessionRpcUsage<'a> { - SessionRpcUsage { - session: self.session, - } +impl<'a> SessionRpcMcpOauth<'a> { + /// Resolves a pending MCP OAuth request with a host-provided token or cancellation. The pending request is emitted as mcp.oauth_required with the data necessary to authorize the request. + /// + /// Wire method: `session.mcp.oauth.handlePendingRequest`. + /// + /// # Parameters + /// + /// * `params` - Pending MCP OAuth request ID and host-provided token or cancellation response. + /// + /// # Returns + /// + /// Indicates whether the pending MCP OAuth response was accepted. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn handle_pending_request( + &self, + params: McpOauthHandlePendingRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_OAUTH_HANDLEPENDINGREQUEST, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) } - /// `session.workspaces.*` sub-namespace. - pub fn workspaces(&self) -> SessionRpcWorkspaces<'a> { - SessionRpcWorkspaces { - session: self.session, - } + /// Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed. + /// + /// Wire method: `session.mcp.oauth.authenticationStateChanged`. + /// + /// # Parameters + /// + /// * `params` - Identifies the MCP server whose persisted OAuth credentials were updated. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn authentication_state_changed( + &self, + params: McpOauthAuthenticationStateChangedRequest, + ) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_MCP_OAUTH_AUTHENTICATIONSTATECHANGED, + Some(wire_params), + ) + .await?; + Ok(()) } - /// Suspends the session while preserving persisted state for later resume. + /// Starts OAuth authentication for a remote MCP server. /// - /// Wire method: `session.suspend`. + /// Wire method: `session.mcp.oauth.login`. + /// + /// # Parameters + /// + /// * `params` - Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection. + /// + /// # Returns + /// + /// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. /// ///
    /// @@ -1444,27 +6210,28 @@ impl<'a> SessionRpc<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn suspend(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn login(&self, params: McpOauthLoginRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SUSPEND, Some(wire_params)) + .call(rpc_methods::SESSION_MCP_OAUTH_LOGIN, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Sends a user message to the session and returns its message ID. + /// Responds to a pending MCP OAuth authorization request by its request id. /// - /// Wire method: `session.send`. + /// Wire method: `session.mcp.oauth.respond`. /// /// # Parameters /// - /// * `params` - Parameters for sending a user message to the session + /// * `params` - Pending MCP OAuth request id to respond to. /// /// # Returns /// - /// Result of sending a user message + /// Indicates whether the pending MCP OAuth response was accepted. /// ///
    /// @@ -1473,28 +6240,39 @@ impl<'a> SessionRpc<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn send(&self, params: SendRequest) -> Result { + pub async fn respond( + &self, + params: McpOauthRespondRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SEND, Some(wire_params)) + .call(rpc_methods::SESSION_MCP_OAUTH_RESPOND, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Aborts the current agent turn. +/// `session.mcp.resources.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcMcpResources<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcMcpResources<'a> { + /// Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`). /// - /// Wire method: `session.abort`. + /// Wire method: `session.mcp.resources.read`. /// /// # Parameters /// - /// * `params` - Parameters for aborting the current turn + /// * `params` - MCP server and resource URI to fetch. /// /// # Returns /// - /// Result of aborting the current turn + /// Resource contents returned by the MCP server. /// ///
    /// @@ -1503,24 +6281,31 @@ impl<'a> SessionRpc<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn abort(&self, params: AbortRequest) -> Result { + pub async fn read( + &self, + params: McpResourcesReadRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_ABORT, Some(wire_params)) + .call(rpc_methods::SESSION_MCP_RESOURCES_READ, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down. + /// Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`. /// - /// Wire method: `session.shutdown`. + /// Wire method: `session.mcp.resources.list`. /// /// # Parameters /// - /// * `params` - Parameters for shutting down the session + /// * `params` - MCP server whose resources to enumerate. + /// + /// # Returns + /// + /// One page of resources advertised by the named MCP server. /// ///
    /// @@ -1529,28 +6314,31 @@ impl<'a> SessionRpc<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn shutdown(&self, params: ShutdownRequest) -> Result<(), Error> { + pub async fn list( + &self, + params: McpResourcesListRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SHUTDOWN, Some(wire_params)) + .call(rpc_methods::SESSION_MCP_RESOURCES_LIST, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Emits a user-visible session log event. + /// Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`. /// - /// Wire method: `session.log`. + /// Wire method: `session.mcp.resources.listTemplates`. /// /// # Parameters /// - /// * `params` - Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip. + /// * `params` - MCP server whose resource templates to enumerate. /// /// # Returns /// - /// Identifier of the session event that was emitted for the log message. + /// One page of resource templates advertised by the named MCP server. /// ///
    /// @@ -1559,32 +6347,38 @@ impl<'a> SessionRpc<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn log(&self, params: LogRequest) -> Result { + pub async fn list_templates( + &self, + params: McpResourcesListTemplatesRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_LOG, Some(wire_params)) + .call( + rpc_methods::SESSION_MCP_RESOURCES_LISTTEMPLATES, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.agent.*` RPCs. +/// `session.metadata.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcAgent<'a> { +pub struct SessionRpcMetadata<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcAgent<'a> { - /// Lists custom agents available to the session. +impl<'a> SessionRpcMetadata<'a> { + /// Returns a snapshot of the session's identifying metadata, mode, agent, and remote info. /// - /// Wire method: `session.agent.list`. + /// Wire method: `session.metadata.snapshot`. /// /// # Returns /// - /// Custom agents available to the session. + /// Point-in-time snapshot of slow-changing session identifier and state fields /// ///
    /// @@ -1593,23 +6387,23 @@ impl<'a> SessionRpcAgent<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn snapshot(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_AGENT_LIST, Some(wire_params)) + .call(rpc_methods::SESSION_METADATA_SNAPSHOT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Gets the currently selected custom agent for the session. + /// Reports whether the local session is currently processing user/agent messages. /// - /// Wire method: `session.agent.getCurrent`. + /// Wire method: `session.metadata.isProcessing`. /// /// # Returns /// - /// The currently selected custom agent, or null when using the default agent. + /// Indicates whether the local session is currently processing a turn or background continuation. /// ///
    /// @@ -1618,27 +6412,55 @@ impl<'a> SessionRpcAgent<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_current(&self) -> Result { + pub async fn is_processing(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_AGENT_GETCURRENT, Some(wire_params)) + .call( + rpc_methods::SESSION_METADATA_ISPROCESSING, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Selects a custom agent for subsequent turns in the session. + /// Returns a snapshot of activity flags for the session. /// - /// Wire method: `session.agent.select`. + /// Wire method: `session.metadata.activity`. + /// + /// # Returns + /// + /// Current activity flags for the session. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn activity(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_METADATA_ACTIVITY, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } + + /// Returns the token breakdown for the session's current context window for a given model. + /// + /// Wire method: `session.metadata.contextInfo`. /// /// # Parameters /// - /// * `params` - Name of the custom agent to select for subsequent turns. + /// * `params` - Model identifier and token limits used to compute the context-info breakdown. /// /// # Returns /// - /// The newly selected custom agent. + /// Token breakdown for the session's current context window, or null if uninitialized. /// ///
    /// @@ -1647,20 +6469,27 @@ impl<'a> SessionRpcAgent<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn select(&self, params: AgentSelectRequest) -> Result { + pub async fn context_info( + &self, + params: MetadataContextInfoRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_AGENT_SELECT, Some(wire_params)) + .call(rpc_methods::SESSION_METADATA_CONTEXTINFO, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Clears the selected custom agent and returns the session to the default agent. + /// Returns the experimental per-source attribution breakdown of the session's current context window as a flat list of entries (skills, subagents, MCP servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via parentId), plus the successful compaction count. The heaviest individual messages are available separately via `metadata.getContextHeaviestMessages`. Returns null until the session has initialized its system prompt and tool metadata. /// - /// Wire method: `session.agent.deselect`. + /// Wire method: `session.metadata.getContextAttribution`. + /// + /// # Returns + /// + /// Per-source attribution breakdown for the session's current context window, or null if uninitialized. /// ///
    /// @@ -1669,23 +6498,30 @@ impl<'a> SessionRpcAgent<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn deselect(&self) -> Result<(), Error> { + pub async fn get_context_attribution(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_AGENT_DESELECT, Some(wire_params)) + .call( + rpc_methods::SESSION_METADATA_GETCONTEXTATTRIBUTION, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reloads custom agent definitions and returns the refreshed list. + /// Returns the largest individual messages currently in the session's context window, most-expensive first. Companion to `metadata.getContextAttribution`. Returns an empty list until the session has initialized. /// - /// Wire method: `session.agent.reload`. + /// Wire method: `session.metadata.getContextHeaviestMessages`. + /// + /// # Parameters + /// + /// * `params` - Parameters for the heaviest-messages query. /// /// # Returns /// - /// Custom agents available to the session after reloading definitions from disk. + /// The heaviest individual messages in the session's context window, most-expensive first. /// ///
    /// @@ -1694,31 +6530,70 @@ impl<'a> SessionRpcAgent<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reload(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn get_context_heaviest_messages( + &self, + params: MetadataContextHeaviestMessagesRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_AGENT_RELOAD, Some(wire_params)) + .call( + rpc_methods::SESSION_METADATA_GETCONTEXTHEAVIESTMESSAGES, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} -/// `session.auth.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcAuth<'a> { - pub(crate) session: &'a Session, -} + /// Records a working-directory/git context change and emits a `session.context_changed` event. For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event): a local session's working directory is authoritative and is moved via `metadata.setWorkingDirectory` (or an SDK `session.resume` that supplies a `workingDirectory`), not by this method. + /// + /// Wire method: `session.metadata.recordContextChange`. + /// + /// # Parameters + /// + /// * `params` - Updated working-directory/git context to record on the session. + /// + /// # Returns + /// + /// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). For a local session, a report whose `cwd` diverges from the session's current working directory is ignored (the call still succeeds but records nothing and emits no event); move a local session's working directory via `metadata.setWorkingDirectory` instead. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn record_context_change( + &self, + params: MetadataRecordContextChangeRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + let _value = self + .session + .client() + .call( + rpc_methods::SESSION_METADATA_RECORDCONTEXTCHANGE, + Some(wire_params), + ) + .await?; + Ok(serde_json::from_value(_value)?) + } -impl<'a> SessionRpcAuth<'a> { - /// Gets authentication status and account metadata for the session. + /// Updates the session's working directory. For local sessions the target is validated first (an absolute path that exists on disk) and the permission primary directory is re-based; a rejected validation fails the call before any session state changes. + /// + /// Wire method: `session.metadata.setWorkingDirectory`. + /// + /// # Parameters /// - /// Wire method: `session.auth.getStatus`. + /// * `params` - Absolute path to set as the session's new working directory. For local sessions the path must be absolute and exist on disk: it is validated before any session state changes, and a failing validation rejects the call with nothing mutated, persisted, or emitted. Remote sessions record the path as-is. /// /// # Returns /// - /// Authentication status and account metadata for the session. + /// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for any related side-effects (file index, etc.); it does NOT change the process working directory (a session's cwd is per-session, not process-global). For local sessions the runtime validates the target first (an absolute path that exists on disk) and re-bases the permission primary directory; a rejected validation fails the call before anything is mutated, persisted, or emitted. Location-scoped permission rules are then re-keyed to the new directory (best-effort). Remote sessions only record the path. /// ///
    /// @@ -1727,27 +6602,34 @@ impl<'a> SessionRpcAuth<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_status(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn set_working_directory( + &self, + params: MetadataSetWorkingDirectoryRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_AUTH_GETSTATUS, Some(wire_params)) + .call( + rpc_methods::SESSION_METADATA_SETWORKINGDIRECTORY, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's auth credentials used for outbound model and API requests. + /// Re-tokenizes the session's existing messages against a model and returns aggregate token totals. /// - /// Wire method: `session.auth.setCredentials`. + /// Wire method: `session.metadata.recomputeContextTokens`. /// /// # Parameters /// - /// * `params` - New auth credentials to install on the session. Omit to leave credentials unchanged. + /// * `params` - Model identifier to use when re-tokenizing the session's existing messages. /// /// # Returns /// - /// Indicates whether the credential update succeeded. + /// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. /// ///
    /// @@ -1756,42 +6638,38 @@ impl<'a> SessionRpcAuth<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_credentials( + pub async fn recompute_context_tokens( &self, - params: SessionSetCredentialsParams, - ) -> Result { + params: MetadataRecomputeContextTokensRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_AUTH_SETCREDENTIALS, Some(wire_params)) + .call( + rpc_methods::SESSION_METADATA_RECOMPUTECONTEXTTOKENS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.canvas.*` RPCs. +/// `session.mode.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcCanvas<'a> { +pub struct SessionRpcMode<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcCanvas<'a> { - /// `session.canvas.action.*` sub-namespace. - pub fn action(&self) -> SessionRpcCanvasAction<'a> { - SessionRpcCanvasAction { - session: self.session, - } - } - - /// Lists canvases declared for the session. +impl<'a> SessionRpcMode<'a> { + /// Gets the current agent interaction mode. /// - /// Wire method: `session.canvas.list`. + /// Wire method: `session.mode.get`. /// /// # Returns /// - /// Declared canvases available in this session. + /// The session mode the agent is operating in /// ///
    /// @@ -1800,23 +6678,23 @@ impl<'a> SessionRpcCanvas<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn get(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_CANVAS_LIST, Some(wire_params)) + .call(rpc_methods::SESSION_MODE_GET, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists currently open canvas instances for the live session. + /// Sets the current agent interaction mode. /// - /// Wire method: `session.canvas.listOpen`. + /// Wire method: `session.mode.set`. /// - /// # Returns + /// # Parameters /// - /// Live open-canvas snapshot. + /// * `params` - Agent interaction mode to apply to the session. /// ///
    /// @@ -1825,27 +6703,32 @@ impl<'a> SessionRpcCanvas<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_open(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn set(&self, params: ModeSetRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_CANVAS_LISTOPEN, Some(wire_params)) + .call(rpc_methods::SESSION_MODE_SET, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } +} - /// Opens or focuses a canvas instance. - /// - /// Wire method: `session.canvas.open`. - /// - /// # Parameters +/// `session.model.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcModel<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcModel<'a> { + /// Gets the currently selected model for the session. /// - /// * `params` - Canvas open parameters. + /// Wire method: `session.model.getCurrent`. /// /// # Returns /// - /// Open canvas instance snapshot. + /// The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume. /// ///
    /// @@ -1854,24 +6737,27 @@ impl<'a> SessionRpcCanvas<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn open(&self, params: CanvasOpenRequest) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn get_current(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_CANVAS_OPEN, Some(wire_params)) + .call(rpc_methods::SESSION_MODEL_GETCURRENT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Closes an open canvas instance. + /// Switches the session to a model and optional reasoning configuration. /// - /// Wire method: `session.canvas.close`. + /// Wire method: `session.model.switchTo`. /// /// # Parameters /// - /// * `params` - Canvas close parameters. + /// * `params` - Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + /// + /// # Returns + /// + /// The model identifier active on the session after the switch. /// ///
    /// @@ -1880,36 +6766,31 @@ impl<'a> SessionRpcCanvas<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn close(&self, params: CanvasCloseRequest) -> Result<(), Error> { + pub async fn switch_to( + &self, + params: ModelSwitchToRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_CANVAS_CLOSE, Some(wire_params)) + .call(rpc_methods::SESSION_MODEL_SWITCHTO, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } -} - -/// `session.canvas.action.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcCanvasAction<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcCanvasAction<'a> { - /// Invokes an action on an open canvas instance. + /// Updates the session's reasoning effort without changing the selected model. /// - /// Wire method: `session.canvas.action.invoke`. + /// Wire method: `session.model.setReasoningEffort`. /// /// # Parameters /// - /// * `params` - Canvas action invocation parameters. + /// * `params` - Reasoning effort level to apply to the currently selected model. /// /// # Returns /// - /// Canvas action invocation result. + /// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. /// ///
    /// @@ -1918,35 +6799,30 @@ impl<'a> SessionRpcCanvasAction<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn invoke( + pub async fn set_reasoning_effort( &self, - params: CanvasActionInvokeRequest, - ) -> Result { + params: ModelSetReasoningEffortRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_CANVAS_ACTION_INVOKE, Some(wire_params)) + .call( + rpc_methods::SESSION_MODEL_SETREASONINGEFFORT, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.commands.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcCommands<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcCommands<'a> { - /// Lists slash commands available in the session. + /// Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's. /// - /// Wire method: `session.commands.list`. + /// Wire method: `session.model.list`. /// /// # Returns /// - /// Slash commands available in the session, after applying any include/exclude filters. + /// The list of models available to this session. /// ///
    /// @@ -1955,27 +6831,27 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn list(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_COMMANDS_LIST, Some(wire_params)) + .call(rpc_methods::SESSION_MODEL_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists slash commands available in the session. + /// Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's. /// - /// Wire method: `session.commands.list`. + /// Wire method: `session.model.list`. /// /// # Parameters /// - /// * `params` - Optional filters controlling which command sources to include in the listing. + /// * `params` - Optional listing options. /// /// # Returns /// - /// Slash commands available in the session, after applying any include/exclude filters. + /// The list of models available to this session. /// ///
    /// @@ -1986,29 +6862,33 @@ impl<'a> SessionRpcCommands<'a> { ///
    pub async fn list_with_params( &self, - params: CommandsListRequest, - ) -> Result { + params: ModelListRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_COMMANDS_LIST, Some(wire_params)) + .call(rpc_methods::SESSION_MODEL_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Invokes a slash command in the session. - /// - /// Wire method: `session.commands.invoke`. - /// - /// # Parameters +/// `session.name.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcName<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcName<'a> { + /// Gets the session's friendly name. /// - /// * `params` - Slash command name and optional raw input string to invoke. + /// Wire method: `session.name.get`. /// /// # Returns /// - /// Result of invoking the slash command (text output, prompt to send to the agent, or completion). + /// The session's friendly name, or null when not yet set. /// ///
    /// @@ -2017,31 +6897,23 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn invoke( - &self, - params: CommandsInvokeRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn get(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_COMMANDS_INVOKE, Some(wire_params)) + .call(rpc_methods::SESSION_NAME_GET, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Reports completion of a pending client-handled slash command. + /// Sets the session's friendly name. /// - /// Wire method: `session.commands.handlePendingCommand`. + /// Wire method: `session.name.set`. /// /// # Parameters /// - /// * `params` - Pending command request ID and an optional error if the client handler failed. - /// - /// # Returns - /// - /// Indicates whether the pending client-handled command was completed successfully. + /// * `params` - New friendly name to apply to the session. /// ///
    /// @@ -2050,34 +6922,28 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_command( - &self, - params: CommandsHandlePendingCommandRequest, - ) -> Result { + pub async fn set(&self, params: NameSetRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_COMMANDS_HANDLEPENDINGCOMMAND, - Some(wire_params), - ) + .call(rpc_methods::SESSION_NAME_SET, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Executes a slash command synchronously and returns any error. + /// Persists an auto-generated session summary as the session's name when no user-set name exists. /// - /// Wire method: `session.commands.execute`. + /// Wire method: `session.name.setAuto`. /// /// # Parameters /// - /// * `params` - Slash command name and argument string to execute synchronously. + /// * `params` - Auto-generated session summary to apply as the session's name when no user-set name exists. /// /// # Returns /// - /// Error message produced while executing the command, if any. + /// Indicates whether the auto-generated summary was applied as the session's name. /// ///
    /// @@ -2086,31 +6952,36 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn execute( - &self, - params: ExecuteCommandParams, - ) -> Result { + pub async fn set_auto(&self, params: NameSetAutoRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_COMMANDS_EXECUTE, Some(wire_params)) + .call(rpc_methods::SESSION_NAME_SETAUTO, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Enqueues a slash command for FIFO processing on the local session. +/// `session.options.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcOptions<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcOptions<'a> { + /// Patches the genuinely-mutable subset of session options. /// - /// Wire method: `session.commands.enqueue`. + /// Wire method: `session.options.update`. /// /// # Parameters /// - /// * `params` - Slash-prefixed command string to enqueue for FIFO processing. + /// * `params` - Patch of mutable session options to apply to the running session. /// /// # Returns /// - /// Indicates whether the command was accepted into the local execution queue. + /// Indicates whether the session options patch was applied successfully. /// ///
    /// @@ -2119,31 +6990,67 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enqueue( + pub async fn update( &self, - params: EnqueueCommandParams, - ) -> Result { + params: SessionUpdateOptionsParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_COMMANDS_ENQUEUE, Some(wire_params)) + .call(rpc_methods::SESSION_OPTIONS_UPDATE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} + +/// `session.permissions.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPermissions<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPermissions<'a> { + /// `session.permissions.folderTrust.*` sub-namespace. + pub fn folder_trust(&self) -> SessionRpcPermissionsFolderTrust<'a> { + SessionRpcPermissionsFolderTrust { + session: self.session, + } + } - /// Reports whether the host actually executed a queued command and whether to continue processing. + /// `session.permissions.locations.*` sub-namespace. + pub fn locations(&self) -> SessionRpcPermissionsLocations<'a> { + SessionRpcPermissionsLocations { + session: self.session, + } + } + + /// `session.permissions.paths.*` sub-namespace. + pub fn paths(&self) -> SessionRpcPermissionsPaths<'a> { + SessionRpcPermissionsPaths { + session: self.session, + } + } + + /// `session.permissions.urls.*` sub-namespace. + pub fn urls(&self) -> SessionRpcPermissionsUrls<'a> { + SessionRpcPermissionsUrls { + session: self.session, + } + } + + /// Replaces selected permission policy fields (rules, paths, URLs, exclusions, allow-all flags) on the session. /// - /// Wire method: `session.commands.respondToQueuedCommand`. + /// Wire method: `session.permissions.configure`. /// /// # Parameters /// - /// * `params` - Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands). + /// * `params` - Patch of permission policy fields to apply (omit a field to leave it unchanged). /// /// # Returns /// - /// Indicates whether the queued-command response was matched to a pending request. + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2152,42 +7059,34 @@ impl<'a> SessionRpcCommands<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn respond_to_queued_command( + pub async fn configure( &self, - params: CommandsRespondToQueuedCommandRequest, - ) -> Result { + params: PermissionsConfigureParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_COMMANDS_RESPONDTOQUEUEDCOMMAND, + rpc_methods::SESSION_PERMISSIONS_CONFIGURE, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.eventLog.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcEventLog<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcEventLog<'a> { - /// Reads a batch of session events from a cursor, optionally waiting for new events. + /// Provides a decision for a pending tool permission request. /// - /// Wire method: `session.eventLog.read`. + /// Wire method: `session.permissions.handlePendingPermissionRequest`. /// /// # Parameters /// - /// * `params` - Cursor, batch size, and optional long-poll/filter parameters for reading session events. + /// * `params` - Pending permission request ID and the decision to apply (approve/reject and scope). /// /// # Returns /// - /// Batch of session events returned by a read, with cursor and continuation metadata. + /// Indicates whether the permission decision was applied; false when the request was already resolved. /// ///
    /// @@ -2196,24 +7095,30 @@ impl<'a> SessionRpcEventLog<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn read(&self, params: EventLogReadRequest) -> Result { + pub async fn handle_pending_permission_request( + &self, + params: PermissionDecisionRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_EVENTLOG_READ, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_HANDLEPENDINGPERMISSIONREQUEST, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns a snapshot of the current tail cursor without consuming events. + /// Reconstructs the set of pending tool permission requests from the session's event history. /// - /// Wire method: `session.eventLog.tail`. + /// Wire method: `session.permissions.pendingRequests`. /// /// # Returns /// - /// Snapshot of the current tail cursor without returning any events. Use this when a consumer wants to subscribe to live events going forward without first paginating through the entire persisted history (which would happen if `read` were called without a cursor on a long-lived session). + /// List of pending permission requests reconstructed from event history. /// ///
    /// @@ -2222,27 +7127,30 @@ impl<'a> SessionRpcEventLog<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn tail(&self) -> Result { + pub async fn pending_requests(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_EVENTLOG_TAIL, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PENDINGREQUESTS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Registers consumer interest in an event type for runtime gating purposes. + /// Enables or disables automatic approval of tool permission requests for the session. /// - /// Wire method: `session.eventLog.registerInterest`. + /// Wire method: `session.permissions.setApproveAll`. /// /// # Parameters /// - /// * `params` - Event type to register consumer interest for, used by runtime gating logic. + /// * `params` - Allow-all toggle for tool permission requests, with an optional telemetry source. /// /// # Returns /// - /// Opaque handle representing an event-type interest registration. + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2251,34 +7159,34 @@ impl<'a> SessionRpcEventLog<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn register_interest( + pub async fn set_approve_all( &self, - params: RegisterEventInterestParams, - ) -> Result { + params: PermissionsSetApproveAllRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_EVENTLOG_REGISTERINTEREST, + rpc_methods::SESSION_PERMISSIONS_SETAPPROVEALL, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Releases a consumer's previously-registered interest in an event type. + /// Sets the allow-all permission mode for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. The `on` mode swaps in unrestricted path and URL managers and emits `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths active while attaching LLM safety recommendations. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. /// - /// Wire method: `session.eventLog.releaseInterest`. + /// Wire method: `session.permissions.setAllowAll`. /// /// # Parameters /// - /// * `params` - Opaque handle previously returned by `registerInterest` to release. + /// * `params` - Allow-all mode to apply for the session. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Indicates whether the operation succeeded and reports the post-mutation state. /// ///
    /// @@ -2287,38 +7195,30 @@ impl<'a> SessionRpcEventLog<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn release_interest( + pub async fn set_allow_all( &self, - params: ReleaseEventInterestParams, - ) -> Result { + params: PermissionsSetAllowAllRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_EVENTLOG_RELEASEINTEREST, + rpc_methods::SESSION_PERMISSIONS_SETALLOWALL, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.extensions.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcExtensions<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcExtensions<'a> { - /// Lists extensions discovered for the session and their current status. + /// Returns the current allow-all permission mode for the session. /// - /// Wire method: `session.extensions.list`. + /// Wire method: `session.permissions.getAllowAll`. /// /// # Returns /// - /// Extensions discovered for the session, with their current status. + /// Current allow-all permission mode. /// ///
    /// @@ -2327,23 +7227,30 @@ impl<'a> SessionRpcExtensions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn get_allow_all(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_EXTENSIONS_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_GETALLOWALL, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Enables an extension for the session. + /// Adds or removes session-scoped or location-scoped permission rules. /// - /// Wire method: `session.extensions.enable`. + /// Wire method: `session.permissions.modifyRules`. /// /// # Parameters /// - /// * `params` - Source-qualified extension identifier to enable for the session. + /// * `params` - Scope and add/remove instructions for modifying session- or location-scoped permission rules. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2352,24 +7259,34 @@ impl<'a> SessionRpcExtensions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enable(&self, params: ExtensionsEnableRequest) -> Result<(), Error> { + pub async fn modify_rules( + &self, + params: PermissionsModifyRulesParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_EXTENSIONS_ENABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_MODIFYRULES, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Disables an extension for the session. + /// Sets whether the client wants permission prompts bridged into session events. /// - /// Wire method: `session.extensions.disable`. + /// Wire method: `session.permissions.setRequired`. /// /// # Parameters /// - /// * `params` - Source-qualified extension identifier to disable for the session. + /// * `params` - Toggles whether permission prompts should be bridged into session events for this client. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2378,20 +7295,34 @@ impl<'a> SessionRpcExtensions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn disable(&self, params: ExtensionsDisableRequest) -> Result<(), Error> { + pub async fn set_required( + &self, + params: PermissionsSetRequiredRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_EXTENSIONS_DISABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_SETREQUIRED, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reloads extension definitions and processes for the session. + /// Clears session-scoped tool permission approvals. /// - /// Wire method: `session.extensions.reload`. + /// Wire method: `session.permissions.resetSessionApprovals`. + /// + /// # Parameters + /// + /// * `params` - Clears session-scoped tool permission approvals, and optionally the location-scoped ones. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2400,35 +7331,34 @@ impl<'a> SessionRpcExtensions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reload(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn reset_session_approvals( + &self, + params: PermissionsResetSessionApprovalsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_EXTENSIONS_RELOAD, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_RESETSESSIONAPPROVALS, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } -} - -/// `session.fleet.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcFleet<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcFleet<'a> { - /// Starts fleet mode by submitting the fleet orchestration prompt to the session. + /// Notifies the runtime that a permission prompt UI has been shown to the user. /// - /// Wire method: `session.fleet.start`. + /// Wire method: `session.permissions.notifyPromptShown`. /// /// # Parameters /// - /// * `params` - Optional user prompt to combine with the fleet orchestration instructions. + /// * `params` - Notification payload describing the permission prompt that the client just rendered. /// /// # Returns /// - /// Indicates whether fleet mode was successfully activated. + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2437,61 +7367,42 @@ impl<'a> SessionRpcFleet<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn start(&self, params: FleetStartRequest) -> Result { + pub async fn notify_prompt_shown( + &self, + params: PermissionPromptShownNotification, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_FLEET_START, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_NOTIFYPROMPTSHOWN, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.history.*` RPCs. +/// `session.permissions.folderTrust.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcHistory<'a> { +pub struct SessionRpcPermissionsFolderTrust<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcHistory<'a> { - /// Compacts the session history to reduce context usage. - /// - /// Wire method: `session.history.compact`. - /// - /// # Returns - /// - /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. - /// - ///
    - /// - /// **Experimental.** This API is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. Pin both the - /// SDK and CLI versions if your code depends on it. - /// - ///
    - pub async fn compact(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); - let _value = self - .session - .client() - .call(rpc_methods::SESSION_HISTORY_COMPACT, Some(wire_params)) - .await?; - Ok(serde_json::from_value(_value)?) - } - - /// Compacts the session history to reduce context usage. +impl<'a> SessionRpcPermissionsFolderTrust<'a> { + /// Reports whether a folder is trusted according to the user's folder trust state. /// - /// Wire method: `session.history.compact`. + /// Wire method: `session.permissions.folderTrust.isTrusted`. /// /// # Parameters /// - /// * `params` - Optional compaction parameters. + /// * `params` - Folder path to check for trust. /// /// # Returns /// - /// Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown. + /// Folder trust check result. /// ///
    /// @@ -2500,31 +7411,34 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn compact_with_params( + pub async fn is_trusted( &self, - params: HistoryCompactRequest, - ) -> Result { + params: FolderTrustCheckParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_HISTORY_COMPACT, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ISTRUSTED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Truncates persisted session history to a specific event. + /// Adds a folder to the user's trusted folders list. /// - /// Wire method: `session.history.truncate`. + /// Wire method: `session.permissions.folderTrust.addTrusted`. /// /// # Parameters /// - /// * `params` - Identifier of the event to truncate to; this event and all later events are removed. + /// * `params` - Folder path to add to trusted folders. /// /// # Returns /// - /// Number of events that were removed by the truncation. + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2533,27 +7447,42 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn truncate( + pub async fn add_trusted( &self, - params: HistoryTruncateRequest, - ) -> Result { + params: FolderTrustAddParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_HISTORY_TRUNCATE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ADDTRUSTED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Cancels any in-progress background compaction on a local session. +/// `session.permissions.locations.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPermissionsLocations<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPermissionsLocations<'a> { + /// Resolves the permission location key and type for a working directory. /// - /// Wire method: `session.history.cancelBackgroundCompaction`. + /// Wire method: `session.permissions.locations.resolve`. + /// + /// # Parameters + /// + /// * `params` - Working directory to resolve into a location-permissions key. /// /// # Returns /// - /// Indicates whether an in-progress background compaction was cancelled. + /// Resolved location-permissions key and type. /// ///
    /// @@ -2562,28 +7491,34 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn cancel_background_compaction( + pub async fn resolve( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + params: PermissionLocationResolveParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_HISTORY_CANCELBACKGROUNDCOMPACTION, + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_RESOLVE, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Aborts any in-progress manual compaction on a local session. + /// Applies persisted location-scoped tool approvals and allowed directories for a working directory to this session's permission service. /// - /// Wire method: `session.history.abortManualCompaction`. + /// Wire method: `session.permissions.locations.apply`. + /// + /// # Parameters + /// + /// * `params` - Working directory to load persisted location permissions for. /// /// # Returns /// - /// Indicates whether an in-progress manual compaction was aborted. + /// Summary of persisted location permissions applied to the session. /// ///
    /// @@ -2592,28 +7527,34 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn abort_manual_compaction( + pub async fn apply( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + params: PermissionLocationApplyParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_HISTORY_ABORTMANUALCOMPACTION, + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_APPLY, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Produces a markdown summary of the session's conversation context for hand-off scenarios. + /// Persists a tool approval for a permission location and applies its rules to this session's live permission service. /// - /// Wire method: `session.history.summarizeForHandoff`. + /// Wire method: `session.permissions.locations.addToolApproval`. + /// + /// # Parameters + /// + /// * `params` - Location-scoped tool approval to persist. /// /// # Returns /// - /// Markdown summary of the conversation context (empty when not available). + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2622,13 +7563,17 @@ impl<'a> SessionRpcHistory<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn summarize_for_handoff(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn add_tool_approval( + &self, + params: PermissionLocationAddToolApprovalParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_HISTORY_SUMMARIZEFORHANDOFF, + rpc_methods::SESSION_PERMISSIONS_LOCATIONS_ADDTOOLAPPROVAL, Some(wire_params), ) .await?; @@ -2636,20 +7581,20 @@ impl<'a> SessionRpcHistory<'a> { } } -/// `session.instructions.*` RPCs. +/// `session.permissions.paths.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcInstructions<'a> { +pub struct SessionRpcPermissionsPaths<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcInstructions<'a> { - /// Gets instruction sources loaded for the session. +impl<'a> SessionRpcPermissionsPaths<'a> { + /// Returns the session's allowed directories and primary working directory. /// - /// Wire method: `session.instructions.getSources`. + /// Wire method: `session.permissions.paths.list`. /// /// # Returns /// - /// Instruction sources loaded for the session, in merge order. + /// Snapshot of the session's allow-listed directories and primary working directory. /// ///
    /// @@ -2658,34 +7603,30 @@ impl<'a> SessionRpcInstructions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_sources(&self) -> Result { + pub async fn list(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_INSTRUCTIONS_GETSOURCES, + rpc_methods::SESSION_PERMISSIONS_PATHS_LIST, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} -/// `session.lsp.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcLsp<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcLsp<'a> { - /// Loads the merged LSP configuration set for the session's working directory. + /// Adds a directory to the session's allow-list. /// - /// Wire method: `session.lsp.initialize`. + /// Wire method: `session.permissions.paths.add`. /// /// # Parameters /// - /// * `params` - Parameters for (re)loading the merged LSP configuration set. + /// * `params` - Directory path to add to the session's allowed directories. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2694,46 +7635,34 @@ impl<'a> SessionRpcLsp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn initialize(&self, params: LspInitializeRequest) -> Result<(), Error> { + pub async fn add( + &self, + params: PermissionPathsAddParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_LSP_INITIALIZE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ADD, + Some(wire_params), + ) .await?; - Ok(()) - } -} - -/// `session.mcp.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMcp<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcMcp<'a> { - /// `session.mcp.apps.*` sub-namespace. - pub fn apps(&self) -> SessionRpcMcpApps<'a> { - SessionRpcMcpApps { - session: self.session, - } - } - - /// `session.mcp.oauth.*` sub-namespace. - pub fn oauth(&self) -> SessionRpcMcpOauth<'a> { - SessionRpcMcpOauth { - session: self.session, - } + Ok(serde_json::from_value(_value)?) } - /// Lists MCP servers configured for the session and their connection status. + /// Updates the session's primary working directory used by the permission policy. /// - /// Wire method: `session.mcp.list`. + /// Wire method: `session.permissions.paths.updatePrimary`. + /// + /// # Parameters + /// + /// * `params` - Directory path to set as the session's new primary working directory. /// /// # Returns /// - /// MCP servers configured for the session, with their connection status. + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2742,23 +7671,34 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn update_primary( + &self, + params: PermissionPathsUpdatePrimaryParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_UPDATEPRIMARY, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Enables an MCP server for the session. + /// Reports whether a path falls within any of the session's allowed directories. /// - /// Wire method: `session.mcp.enable`. + /// Wire method: `session.permissions.paths.isPathWithinAllowedDirectories`. /// /// # Parameters /// - /// * `params` - Name of the MCP server to enable for the session. + /// * `params` - Path to evaluate against the session's allowed directories. + /// + /// # Returns + /// + /// Indicates whether the supplied path is within the session's allowed directories. /// ///
    /// @@ -2767,24 +7707,34 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enable(&self, params: McpEnableRequest) -> Result<(), Error> { + pub async fn is_path_within_allowed_directories( + &self, + params: PermissionPathsAllowedCheckParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_ENABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINALLOWEDDIRECTORIES, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Disables an MCP server for the session. + /// Reports whether a path falls within the session's workspace (primary) directory. /// - /// Wire method: `session.mcp.disable`. + /// Wire method: `session.permissions.paths.isPathWithinWorkspace`. /// /// # Parameters /// - /// * `params` - Name of the MCP server to disable for the session. + /// * `params` - Path to evaluate against the session's workspace (primary) directory. + /// + /// # Returns + /// + /// Indicates whether the supplied path is within the session's workspace directory. /// ///
    /// @@ -2793,20 +7743,42 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn disable(&self, params: McpDisableRequest) -> Result<(), Error> { + pub async fn is_path_within_workspace( + &self, + params: PermissionPathsWorkspaceCheckParams, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_DISABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINWORKSPACE, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } +} - /// Reloads MCP server connections for the session. +/// `session.permissions.urls.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPermissionsUrls<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPermissionsUrls<'a> { + /// Toggles the runtime's URL-permission policy between unrestricted and restricted modes. /// - /// Wire method: `session.mcp.reload`. + /// Wire method: `session.permissions.urls.setUnrestrictedMode`. + /// + /// # Parameters + /// + /// * `params` - Whether the URL-permission policy should run in unrestricted mode. + /// + /// # Returns + /// + /// Indicates whether the operation succeeded. /// ///
    /// @@ -2815,27 +7787,38 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reload(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn set_unrestricted_mode( + &self, + params: PermissionUrlsSetUnrestrictedModeParams, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_RELOAD, Some(wire_params)) + .call( + rpc_methods::SESSION_PERMISSIONS_URLS_SETUNRESTRICTEDMODE, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } +} - /// Runs an MCP sampling inference on behalf of an MCP server. - /// - /// Wire method: `session.mcp.executeSampling`. - /// - /// # Parameters +/// `session.plan.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPlan<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPlan<'a> { + /// Reads the session plan file from the workspace. /// - /// * `params` - Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference. + /// Wire method: `session.plan.read`. /// /// # Returns /// - /// Outcome of an MCP sampling execution: success result, failure error, or cancellation. + /// Existence, contents, and resolved path of the session plan file. /// ///
    /// @@ -2844,31 +7827,23 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn execute_sampling( - &self, - params: McpExecuteSamplingParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn read(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_EXECUTESAMPLING, Some(wire_params)) + .call(rpc_methods::SESSION_PLAN_READ, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Cancels an in-flight MCP sampling execution by request ID. + /// Writes new content to the session plan file. /// - /// Wire method: `session.mcp.cancelSamplingExecution`. + /// Wire method: `session.plan.update`. /// /// # Parameters /// - /// * `params` - The requestId previously passed to executeSampling that should be cancelled. - /// - /// # Returns - /// - /// Indicates whether an in-flight sampling execution with the given requestId was found and cancelled. + /// * `params` - Replacement contents to write to the session plan file. /// ///
    /// @@ -2877,34 +7852,20 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn cancel_sampling_execution( - &self, - params: McpCancelSamplingExecutionParams, - ) -> Result { + pub async fn update(&self, params: PlanUpdateRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_MCP_CANCELSAMPLINGEXECUTION, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLAN_UPDATE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect). - /// - /// Wire method: `session.mcp.setEnvValueMode`. - /// - /// # Parameters - /// - /// * `params` - Mode controlling how MCP server env values are resolved (`direct` or `indirect`). - /// - /// # Returns + /// Deletes the session plan file from the workspace. /// - /// Env-value mode recorded on the session after the update. + /// Wire method: `session.plan.delete`. /// ///
    /// @@ -2913,27 +7874,23 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_env_value_mode( - &self, - params: McpSetEnvValueModeParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn delete(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_SETENVVALUEMODE, Some(wire_params)) + .call(rpc_methods::SESSION_PLAN_DELETE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Removes the auto-managed `github` MCP server when present. + /// Reads todo rows from the session SQL database for plan rendering. /// - /// Wire method: `session.mcp.removeGitHub`. + /// Wire method: `session.plan.readSqlTodos`. /// /// # Returns /// - /// Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove). + /// Todo rows read from the session SQL database. Empty when no session database is available. /// ///
    /// @@ -2942,35 +7899,23 @@ impl<'a> SessionRpcMcp<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn remove_git_hub(&self) -> Result { + pub async fn read_sql_todos(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_REMOVEGITHUB, Some(wire_params)) + .call(rpc_methods::SESSION_PLAN_READSQLTODOS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.mcp.apps.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMcpApps<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcMcpApps<'a> { - /// Fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) from a connected server. Requires the `mcp-apps` session capability. - /// - /// Wire method: `session.mcp.apps.readResource`. - /// - /// # Parameters + /// Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren't available. Clients should call this on session start and after every `session.todos_changed` event to refresh structured-UI rendering. /// - /// * `params` - MCP server and resource URI to fetch. + /// Wire method: `session.plan.readSqlTodosWithDependencies`. /// /// # Returns /// - /// Resource contents returned by the MCP server. + /// Todo rows + dependency edges read from the session SQL database. /// ///
    /// @@ -2979,34 +7924,36 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn read_resource( + pub async fn read_sql_todos_with_dependencies( &self, - params: McpAppsReadResourceRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_MCP_APPS_READRESOURCE, + rpc_methods::SESSION_PLAN_READSQLTODOSWITHDEPENDENCIES, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } +} - /// List tools that an MCP App view is allowed to call (SEP-1865 visibility filter). Returns tools whose `_meta.ui.visibility` is unset (default `["model","app"]`) or includes `"app"`. - /// - /// Wire method: `session.mcp.apps.listTools`. - /// - /// # Parameters +/// `session.plugins.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcPlugins<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcPlugins<'a> { + /// Lists plugins installed for the session. /// - /// * `params` - MCP server to list app-callable tools for. + /// Wire method: `session.plugins.list`. /// /// # Returns /// - /// App-callable tools from the named MCP server. + /// Plugins installed for the session, with their enabled state and version metadata. /// ///
    /// @@ -3015,31 +7962,19 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_tools( - &self, - params: McpAppsListToolsRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_APPS_LISTTOOLS, Some(wire_params)) + .call(rpc_methods::SESSION_PLUGINS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Call an MCP tool from an MCP App view (SEP-1865). Enforces the visibility check that prevents an app iframe from invoking model-only tools. Returns the standard MCP `CallToolResult`. - /// - /// Wire method: `session.mcp.apps.callTool`. - /// - /// # Parameters - /// - /// * `params` - MCP server, tool name, and arguments to invoke from an MCP App view. - /// - /// # Returns + /// Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately. /// - /// Standard MCP CallToolResult + /// Wire method: `session.plugins.reload`. /// ///
    /// @@ -3048,27 +7983,23 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn call_tool( - &self, - params: McpAppsCallToolRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn reload(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_APPS_CALLTOOL, Some(wire_params)) + .call(rpc_methods::SESSION_PLUGINS_RELOAD, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Replace the host context returned to MCP App guests on `ui/initialize`. Hosts use this to advertise theme, locale, or other metadata to the guest UI. + /// Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately. /// - /// Wire method: `session.mcp.apps.setHostContext`. + /// Wire method: `session.plugins.reload`. /// /// # Parameters /// - /// * `params` - Host context to advertise to MCP App guests. + /// * `params` - Optional flags controlling which side effects the reload performs. /// ///
    /// @@ -3077,30 +8008,32 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_host_context( - &self, - params: McpAppsSetHostContextRequest, - ) -> Result<(), Error> { + pub async fn reload_with_params(&self, params: PluginsReloadRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_MCP_APPS_SETHOSTCONTEXT, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PLUGINS_RELOAD, Some(wire_params)) .await?; Ok(()) } +} - /// Read the current host context advertised to MCP App guests. +/// `session.provider.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcProvider<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcProvider<'a> { + /// Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses. /// - /// Wire method: `session.mcp.apps.getHostContext`. + /// Wire method: `session.provider.getEndpoint`. /// /// # Returns /// - /// Current host context advertised to MCP App guests. + /// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
    /// @@ -3109,30 +8042,27 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_host_context(&self) -> Result { + pub async fn get_endpoint(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_MCP_APPS_GETHOSTCONTEXT, - Some(wire_params), - ) + .call(rpc_methods::SESSION_PROVIDER_GETENDPOINT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Diagnose MCP Apps wiring for a specific MCP server. Reports the session capability, feature-flag state, advertised extension, and how many tools have `_meta.ui` populated. + /// Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses. /// - /// Wire method: `session.mcp.apps.diagnose`. + /// Wire method: `session.provider.getEndpoint`. /// /// # Parameters /// - /// * `params` - MCP server to diagnose MCP Apps wiring for. + /// * `params` - Optional model identifier to scope the endpoint snapshot to. /// /// # Returns /// - /// Diagnostic snapshot of MCP Apps wiring for the named server. + /// A snapshot of the provider endpoint the session is currently configured to talk to. /// ///
    /// @@ -3141,39 +8071,31 @@ impl<'a> SessionRpcMcpApps<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn diagnose( + pub async fn get_endpoint_with_params( &self, - params: McpAppsDiagnoseRequest, - ) -> Result { + params: ProviderGetEndpointRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_APPS_DIAGNOSE, Some(wire_params)) + .call(rpc_methods::SESSION_PROVIDER_GETENDPOINT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.mcp.oauth.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMcpOauth<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcMcpOauth<'a> { - /// Starts OAuth authentication for a remote MCP server. + /// Adds BYOK providers and/or models to the session's registry at runtime, extending the additive registry built from the session's `providers`/`models` options. Both fields are optional, so a call may add providers only, models only, or both. Within a single call providers are registered before models, so a model may reference a provider added in the same call; across calls a model may reference any provider already registered (from session creation or a prior add). A model whose referenced provider is not registered by the end of the call is rejected. Newly added models become selectable via `model.list` / `model.switchTo` and are inherited by sub-agents spawned afterwards. /// - /// Wire method: `session.mcp.oauth.login`. + /// Wire method: `session.provider.add`. /// /// # Parameters /// - /// * `params` - Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy. + /// * `params` - BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both. /// /// # Returns /// - /// OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server. + /// The selectable model entries synthesized for the models added by this call. /// ///
    /// @@ -3182,32 +8104,32 @@ impl<'a> SessionRpcMcpOauth<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn login(&self, params: McpOauthLoginRequest) -> Result { + pub async fn add(&self, params: ProviderAddRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MCP_OAUTH_LOGIN, Some(wire_params)) + .call(rpc_methods::SESSION_PROVIDER_ADD, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.metadata.*` RPCs. +/// `session.queue.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcMetadata<'a> { +pub struct SessionRpcQueue<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcMetadata<'a> { - /// Returns a snapshot of the session's identifying metadata, mode, agent, and remote info. +impl<'a> SessionRpcQueue<'a> { + /// Returns the local session's pending user-facing queued items and steering messages. /// - /// Wire method: `session.metadata.snapshot`. + /// Wire method: `session.queue.pendingItems`. /// /// # Returns /// - /// Point-in-time snapshot of slow-changing session identifier and state fields + /// Snapshot of the session's pending queued items and immediate-steering messages. /// ///
    /// @@ -3216,23 +8138,23 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn snapshot(&self) -> Result { + pub async fn pending_items(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_METADATA_SNAPSHOT, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_PENDINGITEMS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Reports whether the local session is currently processing user/agent messages. + /// Returns the internal native queue snapshot for in-process session orchestration. /// - /// Wire method: `session.metadata.isProcessing`. + /// Wire method: `session.queue.snapshot`. /// /// # Returns /// - /// Indicates whether the local session is currently processing a turn or background continuation. + /// Internal snapshot of native queue state for local session orchestration. /// ///
    /// @@ -3241,30 +8163,27 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn is_processing(&self) -> Result { + pub(crate) async fn snapshot(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_METADATA_ISPROCESSING, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_SNAPSHOT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns the token breakdown for the session's current context window for a given model. + /// Moves an addressable queued item to a public visible position. /// - /// Wire method: `session.metadata.contextInfo`. + /// Wire method: `session.queue.moveItem`. /// /// # Parameters /// - /// * `params` - Model identifier and token limits used to compute the context-info breakdown. + /// * `params` - Parameters for moving a queued item by stable id. /// /// # Returns /// - /// Token breakdown for the session's current context window, or null if uninitialized. + /// Result of moving a queued item. /// ///
    /// @@ -3273,31 +8192,31 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn context_info( + pub async fn move_item( &self, - params: MetadataContextInfoRequest, - ) -> Result { + params: QueueMoveItemRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_METADATA_CONTEXTINFO, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_MOVEITEM, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Records a working-directory/git context change and emits a `session.context_changed` event. + /// Inserts a new queued message at a public visible position. /// - /// Wire method: `session.metadata.recordContextChange`. + /// Wire method: `session.queue.insertAt`. /// /// # Parameters /// - /// * `params` - Updated working-directory/git context to record on the session. + /// * `params` - Parameters for inserting a queued message at a public visible position. /// /// # Returns /// - /// Notify the session that its working directory context has changed. Emits a `session.context_changed` event so consumers (telemetry, OTel tracker, ACP, the timeline UI) can react. Use this when the host has detected a cwd/branch/repo change outside the session's normal lifecycle (e.g., after a shell command in interactive mode). + /// Result of inserting a queued message. /// ///
    /// @@ -3306,34 +8225,31 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn record_context_change( + pub async fn insert_at( &self, - params: MetadataRecordContextChangeRequest, - ) -> Result { + params: QueueInsertAtRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_METADATA_RECORDCONTEXTCHANGE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_INSERTAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's recorded working directory. + /// Removes an addressable queued item by its stable id. /// - /// Wire method: `session.metadata.setWorkingDirectory`. + /// Wire method: `session.queue.removeAt`. /// /// # Parameters /// - /// * `params` - Absolute path to set as the session's new working directory. + /// * `params` - Parameters for removing a queued item by stable id. /// /// # Returns /// - /// Update the session's working directory. Used by the host when the user explicitly changes cwd (e.g., the `/cd` slash command). The host is responsible for `process.chdir` and any related side-effects (file index, etc.); this method only updates the session's own recorded path. + /// Result of removing a queued item. /// ///
    /// @@ -3342,34 +8258,31 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_working_directory( - &self, - params: MetadataSetWorkingDirectoryRequest, - ) -> Result { + pub async fn remove_at( + &self, + params: QueueRemoveAtRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_METADATA_SETWORKINGDIRECTORY, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_REMOVEAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Re-tokenizes the session's existing messages against a model and returns aggregate token totals. + /// Updates the text of an addressable single-message queue item. /// - /// Wire method: `session.metadata.recomputeContextTokens`. + /// Wire method: `session.queue.updateText`. /// /// # Parameters /// - /// * `params` - Model identifier to use when re-tokenizing the session's existing messages. + /// * `params` - Parameters for editing a single queued message. /// /// # Returns /// - /// Re-tokenize the session's existing messages against `modelId` and return the token totals. Useful for hosts that want an initial estimate of context usage on session resume, before the next agent turn fires `session.context_info_changed` events. Returns zeros for an empty session. + /// Result of editing a queued message. /// ///
    /// @@ -3378,38 +8291,31 @@ impl<'a> SessionRpcMetadata<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn recompute_context_tokens( + pub async fn update_text( &self, - params: MetadataRecomputeContextTokensRequest, - ) -> Result { + params: QueueUpdateTextRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_METADATA_RECOMPUTECONTEXTTOKENS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_UPDATETEXT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.mode.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcMode<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcMode<'a> { - /// Gets the current agent interaction mode. + /// Duplicates an addressable queued item immediately after its source. /// - /// Wire method: `session.mode.get`. + /// Wire method: `session.queue.duplicateAt`. + /// + /// # Parameters + /// + /// * `params` - Parameters for duplicating a queued item. /// /// # Returns /// - /// The session mode the agent is operating in + /// Result of duplicating a queued item. /// ///
    /// @@ -3418,23 +8324,27 @@ impl<'a> SessionRpcMode<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn duplicate_at( + &self, + params: QueueDuplicateAtRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MODE_GET, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_DUPLICATEAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets the current agent interaction mode. + /// Acquires or releases the queued-lane drain pause. /// - /// Wire method: `session.mode.set`. + /// Wire method: `session.queue.setDrainPaused`. /// /// # Parameters /// - /// * `params` - Agent interaction mode to apply to the session. + /// * `params` - Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it. /// ///
    /// @@ -3443,32 +8353,28 @@ impl<'a> SessionRpcMode<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set(&self, params: ModeSetRequest) -> Result<(), Error> { + pub async fn set_drain_paused(&self, params: QueueSetDrainPausedRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MODE_SET, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_SETDRAINPAUSED, Some(wire_params)) .await?; Ok(()) } -} - -/// `session.model.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcModel<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcModel<'a> { - /// Gets the currently selected model for the session. + /// Moves an addressable queued message into the live turn's steering lane. /// - /// Wire method: `session.model.getCurrent`. + /// Wire method: `session.queue.sendNow`. + /// + /// # Parameters + /// + /// * `params` - Parameters for steering a queued message into a live turn. /// /// # Returns /// - /// The currently selected model, reasoning effort, and context tier for the session. + /// Result of trying to steer a queued message into a live turn. /// ///
    /// @@ -3477,27 +8383,24 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_current(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn send_now(&self, params: QueueSendNowRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MODEL_GETCURRENT, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_SENDNOW, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Switches the session to a model and optional reasoning configuration. - /// - /// Wire method: `session.model.switchTo`. - /// - /// # Parameters + /// Reports whether the local session has native queued work pending. /// - /// * `params` - Target model identifier and optional reasoning effort, summary, capability overrides, and context tier. + /// Wire method: `session.queue.hasPending`. /// /// # Returns /// - /// The model identifier active on the session after the switch. + /// Whether the native queue has pending work. /// ///
    /// @@ -3506,31 +8409,27 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn switch_to( - &self, - params: ModelSwitchToRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub(crate) async fn has_pending(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_MODEL_SWITCHTO, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_HASPENDING, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's reasoning effort without changing the selected model. + /// Begins a native deferred-idle drain when background work has quiesced. /// - /// Wire method: `session.model.setReasoningEffort`. + /// Wire method: `session.queue.beginDeferredIdleDrain`. /// /// # Parameters /// - /// * `params` - Reasoning effort level to apply to the currently selected model. + /// * `params` - Inputs for starting a deferred-idle drain. /// /// # Returns /// - /// Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns. + /// Whether a deferred-idle drain should run. /// ///
    /// @@ -3539,30 +8438,34 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_reasoning_effort( + pub(crate) async fn begin_deferred_idle_drain( &self, - params: ModelSetReasoningEffortRequest, - ) -> Result { + params: QueueBeginDeferredIdleDrainRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_MODEL_SETREASONINGEFFORT, + rpc_methods::SESSION_QUEUE_BEGINDEFERREDIDLEDRAIN, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's. + /// Finishes a native deferred-idle drain and reports whether to drain queue work or emit idle. /// - /// Wire method: `session.model.list`. + /// Wire method: `session.queue.finishDeferredIdleDrain`. + /// + /// # Parameters + /// + /// * `params` - Inputs for completing a deferred-idle drain. /// /// # Returns /// - /// The list of models available to this session. + /// Action selected by the native deferred-idle drain. /// ///
    /// @@ -3571,27 +8474,30 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub(crate) async fn finish_deferred_idle_drain( + &self, + params: QueueFinishDeferredIdleDrainRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MODEL_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_FINISHDEFERREDIDLEDRAIN, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's. + /// Marks session.idle as deferred by native background work state. /// - /// Wire method: `session.model.list`. + /// Wire method: `session.queue.deferSessionIdle`. /// /// # Parameters /// - /// * `params` - Optional listing options. - /// - /// # Returns - /// - /// The list of models available to this session. + /// * `params` - Inputs for marking session.idle deferred in native state. /// ///
    /// @@ -3600,35 +8506,30 @@ impl<'a> SessionRpcModel<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_with_params( + pub(crate) async fn defer_session_idle( &self, - params: ModelListRequest, - ) -> Result { + params: QueueDeferSessionIdleRequest, + ) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_MODEL_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_DEFERSESSIONIDLE, + Some(wire_params), + ) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } -} - -/// `session.name.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcName<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcName<'a> { - /// Gets the session's friendly name. + /// Removes the most recently queued user-facing item (LIFO). /// - /// Wire method: `session.name.get`. + /// Wire method: `session.queue.removeMostRecent`. /// /// # Returns /// - /// The session's friendly name, or null when not yet set. + /// Indicates whether a user-facing pending item was removed. /// ///
    /// @@ -3637,23 +8538,22 @@ impl<'a> SessionRpcName<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get(&self) -> Result { + pub async fn remove_most_recent(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_NAME_GET, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_REMOVEMOSTRECENT, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets the session's friendly name. - /// - /// Wire method: `session.name.set`. - /// - /// # Parameters + /// Clears all pending queued items on the local session. /// - /// * `params` - New friendly name to apply to the session. + /// Wire method: `session.queue.clear`. /// ///
    /// @@ -3662,28 +8562,27 @@ impl<'a> SessionRpcName<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set(&self, params: NameSetRequest) -> Result<(), Error> { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn clear(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_NAME_SET, Some(wire_params)) + .call(rpc_methods::SESSION_QUEUE_CLEAR, Some(wire_params)) .await?; Ok(()) } - /// Persists an auto-generated session summary as the session's name when no user-set name exists. + /// Consumes queued native system notifications matching an internal filter. /// - /// Wire method: `session.name.setAuto`. + /// Wire method: `session.queue.consumeSystemNotifications`. /// /// # Parameters /// - /// * `params` - Auto-generated session summary to apply as the session's name when no user-set name exists. + /// * `params` - Internal filter for consuming queued system notifications. /// /// # Returns /// - /// Indicates whether the auto-generated summary was applied as the session's name. + /// Indicates whether a user-facing pending item was removed. /// ///
    /// @@ -3692,36 +8591,30 @@ impl<'a> SessionRpcName<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_auto(&self, params: NameSetAutoRequest) -> Result { + pub(crate) async fn consume_system_notifications( + &self, + params: QueueConsumeSystemNotificationsRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_NAME_SETAUTO, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_CONSUMESYSTEMNOTIFICATIONS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.options.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcOptions<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcOptions<'a> { - /// Patches the genuinely-mutable subset of session options. - /// - /// Wire method: `session.options.update`. + /// Enqueues the internal resume-pending wake item when orphan handling needs a follow-up turn. /// - /// # Parameters - /// - /// * `params` - Patch of mutable session options to apply to the running session. + /// Wire method: `session.queue.enqueueResumePending`. /// /// # Returns /// - /// Indicates whether the session options patch was applied successfully. + /// Result of enqueueing the resume-pending wake item. /// ///
    /// @@ -3730,67 +8623,24 @@ impl<'a> SessionRpcOptions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn update( + pub(crate) async fn enqueue_resume_pending( &self, - params: SessionUpdateOptionsParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_OPTIONS_UPDATE, Some(wire_params)) + .call( + rpc_methods::SESSION_QUEUE_ENQUEUERESUMEPENDING, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.permissions.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPermissions<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcPermissions<'a> { - /// `session.permissions.folderTrust.*` sub-namespace. - pub fn folder_trust(&self) -> SessionRpcPermissionsFolderTrust<'a> { - SessionRpcPermissionsFolderTrust { - session: self.session, - } - } - - /// `session.permissions.locations.*` sub-namespace. - pub fn locations(&self) -> SessionRpcPermissionsLocations<'a> { - SessionRpcPermissionsLocations { - session: self.session, - } - } - /// `session.permissions.paths.*` sub-namespace. - pub fn paths(&self) -> SessionRpcPermissionsPaths<'a> { - SessionRpcPermissionsPaths { - session: self.session, - } - } - - /// `session.permissions.urls.*` sub-namespace. - pub fn urls(&self) -> SessionRpcPermissionsUrls<'a> { - SessionRpcPermissionsUrls { - session: self.session, - } - } - - /// Replaces selected permission policy fields (rules, paths, URLs, exclusions, allow-all flags) on the session. - /// - /// Wire method: `session.permissions.configure`. - /// - /// # Parameters - /// - /// * `params` - Patch of permission policy fields to apply (omit a field to leave it unchanged). - /// - /// # Returns + /// Drains the native local-session work queue for in-process session orchestration. /// - /// Indicates whether the operation succeeded. + /// Wire method: `session.queue.process`. /// ///
    /// @@ -3799,34 +8649,35 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn configure( - &self, - params: PermissionsConfigureParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub(crate) async fn process(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_CONFIGURE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_QUEUE_PROCESS, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } +} - /// Provides a decision for a pending tool permission request. +/// `session.remote.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcRemote<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcRemote<'a> { + /// Enables remote session export or steering. /// - /// Wire method: `session.permissions.handlePendingPermissionRequest`. + /// Wire method: `session.remote.enable`. /// /// # Parameters /// - /// * `params` - Pending permission request ID and the decision to apply (approve/reject and scope). + /// * `params` - Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. /// /// # Returns /// - /// Indicates whether the permission decision was applied; false when the request was already resolved. + /// GitHub URL for the session and a flag indicating whether remote steering is enabled. /// ///
    /// @@ -3835,30 +8686,20 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_permission_request( - &self, - params: PermissionDecisionRequest, - ) -> Result { + pub async fn enable(&self, params: RemoteEnableRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_HANDLEPENDINGPERMISSIONREQUEST, - Some(wire_params), - ) + .call(rpc_methods::SESSION_REMOTE_ENABLE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Reconstructs the set of pending tool permission requests from the session's event history. - /// - /// Wire method: `session.permissions.pendingRequests`. - /// - /// # Returns + /// Disables remote session export and steering. /// - /// List of pending permission requests reconstructed from event history. + /// Wire method: `session.remote.disable`. /// ///
    /// @@ -3867,30 +8708,27 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn pending_requests(&self) -> Result { + pub async fn disable(&self) -> Result<(), Error> { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_PENDINGREQUESTS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_REMOTE_DISABLE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Enables or disables automatic approval of tool permission requests for the session. + /// Persists a remote-steerability change emitted by the host as a session event. /// - /// Wire method: `session.permissions.setApproveAll`. + /// Wire method: `session.remote.notifySteerableChanged`. /// /// # Parameters /// - /// * `params` - Allow-all toggle for tool permission requests, with an optional telemetry source. + /// * `params` - New remote-steerability state to persist as a `session.remote_steerable_changed` event. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. /// ///
    /// @@ -3899,34 +8737,38 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_approve_all( + pub async fn notify_steerable_changed( &self, - params: PermissionsSetApproveAllRequest, - ) -> Result { + params: RemoteNotifySteerableChangedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_SETAPPROVEALL, + rpc_methods::SESSION_REMOTE_NOTIFYSTEERABLECHANGED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Enables or disables full allow-all permissions (tools, paths, and URLs) for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the unrestricted path and URL managers and emits `session.permissions_changed` on transition. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire. - /// - /// Wire method: `session.permissions.setAllowAll`. - /// - /// # Parameters +/// `session.schedule.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcSchedule<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcSchedule<'a> { + /// Lists the session's currently active scheduled prompts. /// - /// * `params` - Whether to enable full allow-all permissions for the session. + /// Wire method: `session.schedule.list`. /// /// # Returns /// - /// Indicates whether the operation succeeded and reports the post-mutation state. + /// Snapshot of the currently active recurring prompts for this session. /// ///
    /// @@ -3935,30 +8777,19 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_allow_all( - &self, - params: PermissionsSetAllowAllRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_SETALLOWALL, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns whether full allow-all permissions are currently active for the session. - /// - /// Wire method: `session.permissions.getAllowAll`. - /// - /// # Returns + /// Hydrates the native schedule registry from persisted session events. /// - /// Current full allow-all permission state. + /// Wire method: `session.schedule.hydrate`. /// ///
    /// @@ -3967,30 +8798,23 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_allow_all(&self) -> Result { + pub(crate) async fn hydrate(&self) -> Result<(), Error> { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_GETALLOWALL, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_HYDRATE, Some(wire_params)) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Adds or removes session-scoped or location-scoped permission rules. - /// - /// Wire method: `session.permissions.modifyRules`. - /// - /// # Parameters + /// Reports whether the session has an active self-paced scheduled prompt. /// - /// * `params` - Scope and add/remove instructions for modifying session- or location-scoped permission rules. + /// Wire method: `session.schedule.hasSelfPaced`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Whether the session currently has an active self-paced schedule. /// ///
    /// @@ -3999,34 +8823,30 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn modify_rules( - &self, - params: PermissionsModifyRulesParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub(crate) async fn has_self_paced(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_MODIFYRULES, + rpc_methods::SESSION_SCHEDULE_HASSELFPACED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Sets whether the client wants permission prompts bridged into session events. + /// Registers a relative-interval scheduled prompt. /// - /// Wire method: `session.permissions.setRequired`. + /// Wire method: `session.schedule.add`. /// /// # Parameters /// - /// * `params` - Toggles whether permission prompts should be bridged into session events for this client. + /// * `params` - Register a relative-interval scheduled prompt. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -4035,30 +8855,28 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_required( - &self, - params: PermissionsSetRequiredRequest, - ) -> Result { + pub(crate) async fn add(&self, params: ScheduleAddRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_SETREQUIRED, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_ADD, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Clears session-scoped tool permission approvals. + /// Registers a recurring cron scheduled prompt. /// - /// Wire method: `session.permissions.resetSessionApprovals`. + /// Wire method: `session.schedule.addCron`. + /// + /// # Parameters + /// + /// * `params` - Register a cron scheduled prompt. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -4067,32 +8885,31 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reset_session_approvals( + pub(crate) async fn add_cron( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + params: ScheduleAddCronRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_RESETSESSIONAPPROVALS, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_ADDCRON, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Notifies the runtime that a permission prompt UI has been shown to the user. + /// Registers an absolute-time scheduled prompt. /// - /// Wire method: `session.permissions.notifyPromptShown`. + /// Wire method: `session.schedule.addAt`. /// /// # Parameters /// - /// * `params` - Notification payload describing the permission prompt that the client just rendered. + /// * `params` - Register an absolute-time scheduled prompt. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -4101,42 +8918,31 @@ impl<'a> SessionRpcPermissions<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn notify_prompt_shown( + pub(crate) async fn add_at( &self, - params: PermissionPromptShownNotification, - ) -> Result { + params: ScheduleAddAtRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_NOTIFYPROMPTSHOWN, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_ADDAT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.permissions.folderTrust.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPermissionsFolderTrust<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcPermissionsFolderTrust<'a> { - /// Reports whether a folder is trusted according to the user's folder trust state. + /// Registers a self-paced scheduled prompt. /// - /// Wire method: `session.permissions.folderTrust.isTrusted`. + /// Wire method: `session.schedule.addSelfPaced`. /// /// # Parameters /// - /// * `params` - Folder path to check for trust. + /// * `params` - Register a self-paced scheduled prompt. /// /// # Returns /// - /// Folder trust check result. + /// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -4145,34 +8951,34 @@ impl<'a> SessionRpcPermissionsFolderTrust<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn is_trusted( + pub(crate) async fn add_self_paced( &self, - params: FolderTrustCheckParams, - ) -> Result { + params: ScheduleAddSelfPacedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ISTRUSTED, + rpc_methods::SESSION_SCHEDULE_ADDSELFPACED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Adds a folder to the user's trusted folders list. + /// Re-arms an active self-paced scheduled prompt. /// - /// Wire method: `session.permissions.folderTrust.addTrusted`. + /// Wire method: `session.schedule.rearmSelfPaced`. /// /// # Parameters /// - /// * `params` - Folder path to add to trusted folders. + /// * `params` - Re-arm a self-paced scheduled prompt. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of registering or re-arming a scheduled prompt. /// ///
    /// @@ -4181,42 +8987,34 @@ impl<'a> SessionRpcPermissionsFolderTrust<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn add_trusted( + pub(crate) async fn rearm_self_paced( &self, - params: FolderTrustAddParams, - ) -> Result { + params: ScheduleRearmSelfPacedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_FOLDERTRUST_ADDTRUSTED, + rpc_methods::SESSION_SCHEDULE_REARMSELFPACED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.permissions.locations.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPermissionsLocations<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcPermissionsLocations<'a> { - /// Resolves the permission location key and type for a working directory. + /// Removes a scheduled prompt by id. /// - /// Wire method: `session.permissions.locations.resolve`. + /// Wire method: `session.schedule.stop`. /// /// # Parameters /// - /// * `params` - Working directory to resolve into a location-permissions key. + /// * `params` - Identifier of the scheduled prompt to remove. /// /// # Returns /// - /// Resolved location-permissions key and type. + /// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. /// ///
    /// @@ -4225,34 +9023,32 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn resolve( - &self, - params: PermissionLocationResolveParams, - ) -> Result { + pub async fn stop(&self, params: ScheduleStopRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_LOCATIONS_RESOLVE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SCHEDULE_STOP, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Applies persisted location-scoped tool approvals and allowed directories for a working directory to this session's permission service. - /// - /// Wire method: `session.permissions.locations.apply`. - /// - /// # Parameters +/// `session.settings.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcSettings<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcSettings<'a> { + /// Returns a redacted snapshot of session runtime settings, with secrets and raw feature flags excluded. Internal: the runtime settings shape is a runtime-internal surface and is deliberately kept out of the public SDK, because consumers should not depend on the runtime's internal settings layout. It remains callable in-process and is expected to be reworked as the runtime internals are consolidated. /// - /// * `params` - Working directory to load persisted location permissions for. + /// Wire method: `session.settings.snapshot`. /// /// # Returns /// - /// Summary of persisted location permissions applied to the session. + /// Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded. /// ///
    /// @@ -4261,34 +9057,27 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn apply( - &self, - params: PermissionLocationApplyParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub(crate) async fn snapshot(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_LOCATIONS_APPLY, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SETTINGS_SNAPSHOT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Persists a tool approval for a permission location and applies its rules to this session's live permission service. + /// Evaluates a named Rust-owned settings predicate without exposing raw feature flags. Internal: the raw feature-flag names and composition are runtime-internal, so this predicate-evaluation helper is kept out of the public SDK surface and is callable in-process only. /// - /// Wire method: `session.permissions.locations.addToolApproval`. + /// Wire method: `session.settings.evaluatePredicate`. /// /// # Parameters /// - /// * `params` - Location-scoped tool approval to persist. + /// * `params` - Named Rust-owned settings predicate to evaluate for this session. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Result of evaluating a Rust-owned settings predicate. /// ///
    /// @@ -4297,17 +9086,17 @@ impl<'a> SessionRpcPermissionsLocations<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn add_tool_approval( + pub(crate) async fn evaluate_predicate( &self, - params: PermissionLocationAddToolApprovalParams, - ) -> Result { + params: SessionSettingsEvaluatePredicateRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_LOCATIONS_ADDTOOLAPPROVAL, + rpc_methods::SESSION_SETTINGS_EVALUATEPREDICATE, Some(wire_params), ) .await?; @@ -4315,52 +9104,24 @@ impl<'a> SessionRpcPermissionsLocations<'a> { } } -/// `session.permissions.paths.*` RPCs. +/// `session.shell.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcPermissionsPaths<'a> { +pub struct SessionRpcShell<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcPermissionsPaths<'a> { - /// Returns the session's allowed directories and primary working directory. - /// - /// Wire method: `session.permissions.paths.list`. - /// - /// # Returns - /// - /// Snapshot of the session's allow-listed directories and primary working directory. - /// - ///
    - /// - /// **Experimental.** This API is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. Pin both the - /// SDK and CLI versions if your code depends on it. - /// - ///
    - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); - let _value = self - .session - .client() - .call( - rpc_methods::SESSION_PERMISSIONS_PATHS_LIST, - Some(wire_params), - ) - .await?; - Ok(serde_json::from_value(_value)?) - } - - /// Adds a directory to the session's allow-list. +impl<'a> SessionRpcShell<'a> { + /// Starts a shell command and streams output through session notifications. The command runs as the leader of its own process group (POSIX) or in a dedicated job object (Windows), so a forced termination — via "shell.kill", the request timeout, or session disposal — signals that whole group/job rather than only the direct child. Two gaps are worth planning for: a command that exits on its own does not trigger that teardown, and on POSIX a descendant that moves itself into a new session or process group (for example via "setsid") leaves the signalled group, so either can leave a background process running. /// - /// Wire method: `session.permissions.paths.add`. + /// Wire method: `session.shell.exec`. /// /// # Parameters /// - /// * `params` - Directory path to add to the session's allowed directories. + /// * `params` - Shell command to run, with optional working directory and timeout in milliseconds. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Identifier of the spawned process, used to correlate streamed output and exit notifications. /// ///
    /// @@ -4369,34 +9130,28 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn add( - &self, - params: PermissionPathsAddParams, - ) -> Result { + pub async fn exec(&self, params: ShellExecRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_PATHS_ADD, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SHELL_EXEC, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Updates the session's primary working directory used by the permission policy. + /// Sends a signal to a shell process previously started via "shell.exec". The signal targets the command's whole process group (POSIX) or job object (Windows), so descendants still in that group are signalled too, not just the direct child. On POSIX a descendant that moved itself into a new session or process group (for example via "setsid") is no longer in the signalled group and survives. /// - /// Wire method: `session.permissions.paths.updatePrimary`. + /// Wire method: `session.shell.kill`. /// /// # Parameters /// - /// * `params` - Directory path to set as the session's new primary working directory. + /// * `params` - Identifier of a process previously returned by "shell.exec" and the signal to send. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Indicates whether the signal was delivered; false if the process was unknown or already exited. /// ///
    /// @@ -4405,34 +9160,28 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn update_primary( - &self, - params: PermissionPathsUpdatePrimaryParams, - ) -> Result { + pub async fn kill(&self, params: ShellKillRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_PATHS_UPDATEPRIMARY, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SHELL_KILL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Reports whether a path falls within any of the session's allowed directories. + /// Executes a user-requested shell command through the session runtime. /// - /// Wire method: `session.permissions.paths.isPathWithinAllowedDirectories`. + /// Wire method: `session.shell.executeUserRequested`. /// /// # Parameters /// - /// * `params` - Path to evaluate against the session's allowed directories. + /// * `params` - User-requested shell command and cancellation handle. /// /// # Returns /// - /// Indicates whether the supplied path is within the session's allowed directories. + /// Result of a user-requested shell command. /// ///
    /// @@ -4441,34 +9190,34 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn is_path_within_allowed_directories( + pub async fn execute_user_requested( &self, - params: PermissionPathsAllowedCheckParams, - ) -> Result { + params: ShellExecuteUserRequestedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINALLOWEDDIRECTORIES, + rpc_methods::SESSION_SHELL_EXECUTEUSERREQUESTED, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Reports whether a path falls within the session's workspace (primary) directory. + /// Cancels a user-requested shell command by request ID. /// - /// Wire method: `session.permissions.paths.isPathWithinWorkspace`. + /// Wire method: `session.shell.cancelUserRequested`. /// /// # Parameters /// - /// * `params` - Path to evaluate against the session's workspace (primary) directory. + /// * `params` - User-requested shell execution cancellation handle. /// /// # Returns /// - /// Indicates whether the supplied path is within the session's workspace directory. + /// Cancellation result for a user-requested shell command. /// ///
    /// @@ -4477,17 +9226,17 @@ impl<'a> SessionRpcPermissionsPaths<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn is_path_within_workspace( + pub async fn cancel_user_requested( &self, - params: PermissionPathsWorkspaceCheckParams, - ) -> Result { + params: ShellCancelUserRequestedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_PERMISSIONS_PATHS_ISPATHWITHINWORKSPACE, + rpc_methods::SESSION_SHELL_CANCELUSERREQUESTED, Some(wire_params), ) .await?; @@ -4495,24 +9244,20 @@ impl<'a> SessionRpcPermissionsPaths<'a> { } } -/// `session.permissions.urls.*` RPCs. +/// `session.skills.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcPermissionsUrls<'a> { +pub struct SessionRpcSkills<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcPermissionsUrls<'a> { - /// Toggles the runtime's URL-permission policy between unrestricted and restricted modes. - /// - /// Wire method: `session.permissions.urls.setUnrestrictedMode`. - /// - /// # Parameters +impl<'a> SessionRpcSkills<'a> { + /// Lists skills available to the session. /// - /// * `params` - Whether the URL-permission policy should run in unrestricted mode. + /// Wire method: `session.skills.list`. /// /// # Returns /// - /// Indicates whether the operation succeeded. + /// Skills available to the session, with their enabled state. /// ///
    /// @@ -4521,38 +9266,23 @@ impl<'a> SessionRpcPermissionsUrls<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_unrestricted_mode( - &self, - params: PermissionUrlsSetUnrestrictedModeParams, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn list(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_PERMISSIONS_URLS_SETUNRESTRICTEDMODE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_SKILLS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} -/// `session.plan.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPlan<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcPlan<'a> { - /// Reads the session plan file from the workspace. + /// Returns the skills that have been invoked during this session. /// - /// Wire method: `session.plan.read`. + /// Wire method: `session.skills.getInvoked`. /// /// # Returns /// - /// Existence, contents, and resolved path of the session plan file. + /// Skills invoked during this session, ordered by invocation time (most recent last). /// ///
    /// @@ -4561,23 +9291,23 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn read(&self) -> Result { + pub async fn get_invoked(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_PLAN_READ, Some(wire_params)) + .call(rpc_methods::SESSION_SKILLS_GETINVOKED, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Writes new content to the session plan file. + /// Enables a skill for the session. /// - /// Wire method: `session.plan.update`. + /// Wire method: `session.skills.enable`. /// /// # Parameters /// - /// * `params` - Replacement contents to write to the session plan file. + /// * `params` - Name of the skill to enable for the session. /// ///
    /// @@ -4586,20 +9316,24 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn update(&self, params: PlanUpdateRequest) -> Result<(), Error> { + pub async fn enable(&self, params: SkillsEnableRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_PLAN_UPDATE, Some(wire_params)) + .call(rpc_methods::SESSION_SKILLS_ENABLE, Some(wire_params)) .await?; Ok(()) } - /// Deletes the session plan file from the workspace. + /// Disables a skill for the session. /// - /// Wire method: `session.plan.delete`. + /// Wire method: `session.skills.disable`. + /// + /// # Parameters + /// + /// * `params` - Name of the skill to disable for the session. /// ///
    /// @@ -4608,31 +9342,24 @@ impl<'a> SessionRpcPlan<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn delete(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn disable(&self, params: SkillsDisableRequest) -> Result<(), Error> { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_PLAN_DELETE, Some(wire_params)) + .call(rpc_methods::SESSION_SKILLS_DISABLE, Some(wire_params)) .await?; Ok(()) } -} - -/// `session.plugins.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcPlugins<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcPlugins<'a> { - /// Lists plugins installed for the session. + /// Reloads skill definitions for the session. /// - /// Wire method: `session.plugins.list`. + /// Wire method: `session.skills.reload`. /// /// # Returns /// - /// Plugins installed for the session, with their enabled state and version metadata. + /// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. /// ///
    /// @@ -4641,31 +9368,56 @@ impl<'a> SessionRpcPlugins<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn reload(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_PLUGINS_LIST, Some(wire_params)) + .call(rpc_methods::SESSION_SKILLS_RELOAD, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } + + /// Ensures the session's skill definitions have been loaded from disk. + /// + /// Wire method: `session.skills.ensureLoaded`. + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn ensure_loaded(&self) -> Result<(), Error> { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_SKILLS_ENSURELOADED, Some(wire_params)) + .await?; + Ok(()) + } } -/// `session.queue.*` RPCs. +/// `session.tasks.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcQueue<'a> { +pub struct SessionRpcTasks<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcQueue<'a> { - /// Returns the local session's pending user-facing queued items and steering messages. +impl<'a> SessionRpcTasks<'a> { + /// Starts a background agent task in the session. /// - /// Wire method: `session.queue.pendingItems`. + /// Wire method: `session.tasks.startAgent`. + /// + /// # Parameters + /// + /// * `params` - Agent type, prompt, name, and optional description and model override for the new task. /// /// # Returns /// - /// Snapshot of the session's pending queued items and immediate-steering messages. + /// Identifier assigned to the newly started background agent task. /// ///
    /// @@ -4674,23 +9426,27 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn pending_items(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn start_agent( + &self, + params: TasksStartAgentRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_QUEUE_PENDINGITEMS, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_STARTAGENT, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Removes the most recently queued user-facing item (LIFO). + /// Lists background tasks tracked by the session. /// - /// Wire method: `session.queue.removeMostRecent`. + /// Wire method: `session.tasks.list`. /// /// # Returns /// - /// Indicates whether a user-facing pending item was removed. + /// Background tasks currently tracked by the session. /// ///
    /// @@ -4699,22 +9455,23 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn remove_most_recent(&self) -> Result { + pub async fn list(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_QUEUE_REMOVEMOSTRECENT, - Some(wire_params), - ) + .call(rpc_methods::SESSION_TASKS_LIST, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Clears all pending queued items on the local session. + /// Refreshes metadata for any detached background shells the runtime knows about. /// - /// Wire method: `session.queue.clear`. + /// Wire method: `session.tasks.refresh`. + /// + /// # Returns + /// + /// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. /// ///
    /// @@ -4723,35 +9480,52 @@ impl<'a> SessionRpcQueue<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn clear(&self) -> Result<(), Error> { + pub async fn refresh(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_QUEUE_CLEAR, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_REFRESH, Some(wire_params)) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } -} -/// `session.remote.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcRemote<'a> { - pub(crate) session: &'a Session, -} + /// Waits for all in-flight background tasks and any follow-up turns to settle. + /// + /// Wire method: `session.tasks.waitForPending`. + /// + /// # Returns + /// + /// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). + /// + ///
    + /// + /// **Experimental.** This API is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. Pin both the + /// SDK and CLI versions if your code depends on it. + /// + ///
    + pub async fn wait_for_pending(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + let _value = self + .session + .client() + .call(rpc_methods::SESSION_TASKS_WAITFORPENDING, Some(wire_params)) + .await?; + Ok(serde_json::from_value(_value)?) + } -impl<'a> SessionRpcRemote<'a> { - /// Enables remote session export or steering. + /// Returns progress information for a background task by ID. /// - /// Wire method: `session.remote.enable`. + /// Wire method: `session.tasks.getProgress`. /// /// # Parameters /// - /// * `params` - Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering. + /// * `params` - Identifier of the background task to fetch progress for. /// /// # Returns /// - /// GitHub URL for the session and a flag indicating whether remote steering is enabled. + /// Progress information for the task, or null when no task with that ID is tracked. /// ///
    /// @@ -4760,20 +9534,27 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enable(&self, params: RemoteEnableRequest) -> Result { + pub async fn get_progress( + &self, + params: TasksGetProgressRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_REMOTE_ENABLE, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_GETPROGRESS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Disables remote session export and steering. + /// Returns the first sync-waiting task that can currently be promoted to background mode. /// - /// Wire method: `session.remote.disable`. + /// Wire method: `session.tasks.getCurrentPromotable`. + /// + /// # Returns + /// + /// The first sync-waiting task that can currently be promoted to background mode. /// ///
    /// @@ -4782,27 +9563,30 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn disable(&self) -> Result<(), Error> { + pub async fn get_current_promotable(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_REMOTE_DISABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_TASKS_GETCURRENTPROMOTABLE, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Persists a remote-steerability change emitted by the host as a session event. + /// Promotes an eligible synchronously-waited task so it continues running in the background. /// - /// Wire method: `session.remote.notifySteerableChanged`. + /// Wire method: `session.tasks.promoteToBackground`. /// /// # Parameters /// - /// * `params` - New remote-steerability state to persist as a `session.remote_steerable_changed` event. + /// * `params` - Identifier of the task to promote to background mode. /// /// # Returns /// - /// Persist a steerability change as a `session.remote_steerable_changed` event. Used by the host (CLI / SDK consumer) when it has just finished enabling or disabling steering on a remote exporter that the runtime does not directly own. + /// Indicates whether the task was successfully promoted to background mode. /// ///
    /// @@ -4811,38 +9595,30 @@ impl<'a> SessionRpcRemote<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn notify_steerable_changed( + pub async fn promote_to_background( &self, - params: RemoteNotifySteerableChangedRequest, - ) -> Result { + params: TasksPromoteToBackgroundRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_REMOTE_NOTIFYSTEERABLECHANGED, + rpc_methods::SESSION_TASKS_PROMOTETOBACKGROUND, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.schedule.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcSchedule<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcSchedule<'a> { - /// Lists the session's currently active scheduled prompts. + /// Atomically promotes the first promotable sync-waiting task to background mode and returns it. /// - /// Wire method: `session.schedule.list`. + /// Wire method: `session.tasks.promoteCurrentToBackground`. /// /// # Returns /// - /// Snapshot of the currently active recurring prompts for this session. + /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. /// ///
    /// @@ -4851,27 +9627,32 @@ impl<'a> SessionRpcSchedule<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { + pub async fn promote_current_to_background( + &self, + ) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_SCHEDULE_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_TASKS_PROMOTECURRENTTOBACKGROUND, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Removes a scheduled prompt by id. + /// Cancels a background task. /// - /// Wire method: `session.schedule.stop`. + /// Wire method: `session.tasks.cancel`. /// /// # Parameters /// - /// * `params` - Identifier of the scheduled prompt to remove. + /// * `params` - Identifier of the background task to cancel. /// /// # Returns /// - /// Remove a scheduled prompt by id. The result entry is omitted if the id was unknown. + /// Indicates whether the background task was successfully cancelled. /// ///
    /// @@ -4880,36 +9661,28 @@ impl<'a> SessionRpcSchedule<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn stop(&self, params: ScheduleStopRequest) -> Result { + pub async fn cancel(&self, params: TasksCancelRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SCHEDULE_STOP, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_CANCEL, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.shell.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcShell<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcShell<'a> { - /// Starts a shell command and streams output through session notifications. + /// Removes a completed or cancelled background task from tracking. /// - /// Wire method: `session.shell.exec`. + /// Wire method: `session.tasks.remove`. /// /// # Parameters /// - /// * `params` - Shell command to run, with optional working directory and timeout in milliseconds. + /// * `params` - Identifier of the completed or cancelled task to remove from tracking. /// /// # Returns /// - /// Identifier of the spawned process, used to correlate streamed output and exit notifications. + /// Indicates whether the task was removed. False when the task does not exist or is still running/idle. /// ///
    /// @@ -4918,28 +9691,28 @@ impl<'a> SessionRpcShell<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn exec(&self, params: ShellExecRequest) -> Result { + pub async fn remove(&self, params: TasksRemoveRequest) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SHELL_EXEC, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_REMOVE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Sends a signal to a shell process previously started via "shell.exec". + /// Sends a message to a background agent task. /// - /// Wire method: `session.shell.kill`. + /// Wire method: `session.tasks.sendMessage`. /// /// # Parameters /// - /// * `params` - Identifier of a process previously returned by "shell.exec" and the signal to send. + /// * `params` - Identifier of the target agent task, message content, and optional sender agent ID. /// /// # Returns /// - /// Indicates whether the signal was delivered; false if the process was unknown or already exited. + /// Indicates whether the message was delivered, with an error message when delivery failed. /// ///
    /// @@ -4948,57 +9721,35 @@ impl<'a> SessionRpcShell<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn kill(&self, params: ShellKillRequest) -> Result { + pub async fn send_message( + &self, + params: TasksSendMessageRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SHELL_KILL, Some(wire_params)) + .call(rpc_methods::SESSION_TASKS_SENDMESSAGE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.skills.*` RPCs. +/// `session.telemetry.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcSkills<'a> { +pub struct SessionRpcTelemetry<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcSkills<'a> { - /// Lists skills available to the session. - /// - /// Wire method: `session.skills.list`. - /// - /// # Returns - /// - /// Skills available to the session, with their enabled state. - /// - ///
    - /// - /// **Experimental.** This API is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. Pin both the - /// SDK and CLI versions if your code depends on it. - /// - ///
    - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); - let _value = self - .session - .client() - .call(rpc_methods::SESSION_SKILLS_LIST, Some(wire_params)) - .await?; - Ok(serde_json::from_value(_value)?) - } - - /// Returns the skills that have been invoked during this session. +impl<'a> SessionRpcTelemetry<'a> { + /// Gets the telemetry engagement ID currently associated with the session, when available. /// - /// Wire method: `session.skills.getInvoked`. + /// Wire method: `session.telemetry.getEngagementId`. /// /// # Returns /// - /// Skills invoked during this session, ordered by invocation time (most recent last). + /// Telemetry engagement ID for the session, when available. /// ///
    /// @@ -5007,23 +9758,26 @@ impl<'a> SessionRpcSkills<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_invoked(&self) -> Result { + pub async fn get_engagement_id(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_SKILLS_GETINVOKED, Some(wire_params)) + .call( + rpc_methods::SESSION_TELEMETRY_GETENGAGEMENTID, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Enables a skill for the session. + /// Sets feature override key/value pairs to attach to subsequent telemetry events for the session. /// - /// Wire method: `session.skills.enable`. + /// Wire method: `session.telemetry.setFeatureOverrides`. /// /// # Parameters /// - /// * `params` - Name of the skill to enable for the session. + /// * `params` - Feature override key/value pairs to attach to subsequent telemetry events from this session. /// ///
    /// @@ -5032,24 +9786,42 @@ impl<'a> SessionRpcSkills<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn enable(&self, params: SkillsEnableRequest) -> Result<(), Error> { + pub async fn set_feature_overrides( + &self, + params: TelemetrySetFeatureOverridesRequest, + ) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SKILLS_ENABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_TELEMETRY_SETFEATUREOVERRIDES, + Some(wire_params), + ) .await?; Ok(()) } +} - /// Disables a skill for the session. +/// `session.tools.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcTools<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcTools<'a> { + /// Provides the result for a pending external tool call. /// - /// Wire method: `session.skills.disable`. + /// Wire method: `session.tools.handlePendingToolCall`. /// /// # Parameters /// - /// * `params` - Name of the skill to disable for the session. + /// * `params` - Pending external tool call request ID, with the tool result or an error describing why it failed. + /// + /// # Returns + /// + /// Indicates whether the external tool call result was handled successfully. /// ///
    /// @@ -5058,24 +9830,30 @@ impl<'a> SessionRpcSkills<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn disable(&self, params: SkillsDisableRequest) -> Result<(), Error> { + pub async fn handle_pending_tool_call( + &self, + params: HandlePendingToolCallRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_SKILLS_DISABLE, Some(wire_params)) + .call( + rpc_methods::SESSION_TOOLS_HANDLEPENDINGTOOLCALL, + Some(wire_params), + ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Reloads skill definitions for the session. + /// Resolves, builds, and validates the runtime tool list for the session. /// - /// Wire method: `session.skills.reload`. + /// Wire method: `session.tools.initializeAndValidate`. /// /// # Returns /// - /// Diagnostics from reloading skill definitions, with warnings and errors as separate lists. + /// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. /// ///
    /// @@ -5084,56 +9862,26 @@ impl<'a> SessionRpcSkills<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn reload(&self) -> Result { + pub async fn initialize_and_validate(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_SKILLS_RELOAD, Some(wire_params)) + .call( + rpc_methods::SESSION_TOOLS_INITIALIZEANDVALIDATE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Ensures the session's skill definitions have been loaded from disk. - /// - /// Wire method: `session.skills.ensureLoaded`. - /// - ///
    - /// - /// **Experimental.** This API is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. Pin both the - /// SDK and CLI versions if your code depends on it. - /// - ///
    - pub async fn ensure_loaded(&self) -> Result<(), Error> { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); - let _value = self - .session - .client() - .call(rpc_methods::SESSION_SKILLS_ENSURELOADED, Some(wire_params)) - .await?; - Ok(()) - } -} - -/// `session.tasks.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcTasks<'a> { - pub(crate) session: &'a Session, -} - -impl<'a> SessionRpcTasks<'a> { - /// Starts a background agent task in the session. - /// - /// Wire method: `session.tasks.startAgent`. - /// - /// # Parameters + /// Returns lightweight metadata for the session's currently initialized tools. /// - /// * `params` - Agent type, prompt, name, and optional description and model override for the new task. + /// Wire method: `session.tools.getCurrentMetadata`. /// /// # Returns /// - /// Identifier assigned to the newly started background agent task. + /// Current lightweight tool metadata snapshot for the session. /// ///
    /// @@ -5142,27 +9890,30 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn start_agent( - &self, - params: TasksStartAgentRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn get_current_metadata(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_STARTAGENT, Some(wire_params)) + .call( + rpc_methods::SESSION_TOOLS_GETCURRENTMETADATA, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists background tasks tracked by the session. + /// Updates the current session's live subagent settings after user settings change. The persisted user settings remain the source of truth for future sessions. /// - /// Wire method: `session.tasks.list`. + /// Wire method: `session.tools.updateSubagentSettings`. + /// + /// # Parameters + /// + /// * `params` - Subagent settings to apply to the current session /// /// # Returns /// - /// Background tasks currently tracked by the session. + /// Empty result after applying subagent settings /// ///
    /// @@ -5171,23 +9922,42 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn update_subagent_settings( + &self, + params: UpdateSubagentSettingsRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_LIST, Some(wire_params)) + .call( + rpc_methods::SESSION_TOOLS_UPDATESUBAGENTSETTINGS, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Refreshes metadata for any detached background shells the runtime knows about. +/// `session.ui.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcUi<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcUi<'a> { + /// Runs a transient no-tools model query against the current conversation context. /// - /// Wire method: `session.tasks.refresh`. + /// Wire method: `session.ui.ephemeralQuery`. + /// + /// # Parameters + /// + /// * `params` - Transient question to answer without adding it to conversation history. /// /// # Returns /// - /// Refresh metadata for any detached background shells the runtime knows about. Use after a long pause to pick up exit/output state for shells running outside the agent loop. + /// Transient answer generated from current conversation context. /// ///
    /// @@ -5196,23 +9966,31 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn refresh(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn ephemeral_query( + &self, + params: UIEphemeralQueryRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_REFRESH, Some(wire_params)) + .call(rpc_methods::SESSION_UI_EPHEMERALQUERY, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Waits for all in-flight background tasks and any follow-up turns to settle. + /// Requests structured input from a UI-capable client. /// - /// Wire method: `session.tasks.waitForPending`. + /// Wire method: `session.ui.elicitation`. + /// + /// # Parameters + /// + /// * `params` - Prompt message and JSON schema describing the form fields to elicit from the user. /// /// # Returns /// - /// Wait until all in-flight background tasks (agents + shells) and any follow-up turns scheduled by their completions have settled. Returns when the runtime is fully drained or after an internal timeout (default 10 minutes; configurable via COPILOT_TASK_WAIT_TIMEOUT_SECONDS). + /// The elicitation response (accept with form values, decline, or cancel) /// ///
    /// @@ -5221,27 +9999,31 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn wait_for_pending(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn elicitation( + &self, + params: UIElicitationRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_WAITFORPENDING, Some(wire_params)) + .call(rpc_methods::SESSION_UI_ELICITATION, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns progress information for a background task by ID. + /// Provides the user response for a pending elicitation request. /// - /// Wire method: `session.tasks.getProgress`. + /// Wire method: `session.ui.handlePendingElicitation`. /// /// # Parameters /// - /// * `params` - Identifier of the background task to fetch progress for. + /// * `params` - Pending elicitation request ID and the user's response (accept/decline/cancel + form values). /// /// # Returns /// - /// Progress information for the task, or null when no task with that ID is tracked. + /// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. /// ///
    /// @@ -5250,27 +10032,34 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_progress( + pub async fn handle_pending_elicitation( &self, - params: TasksGetProgressRequest, - ) -> Result { + params: UIHandlePendingElicitationRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_GETPROGRESS, Some(wire_params)) + .call( + rpc_methods::SESSION_UI_HANDLEPENDINGELICITATION, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns the first sync-waiting task that can currently be promoted to background mode. + /// Resolves a pending `user_input.requested` event with the user's response. /// - /// Wire method: `session.tasks.getCurrentPromotable`. + /// Wire method: `session.ui.handlePendingUserInput`. + /// + /// # Parameters + /// + /// * `params` - Request ID of a pending `user_input.requested` event and the user's response. /// /// # Returns /// - /// The first sync-waiting task that can currently be promoted to background mode. + /// Indicates whether the pending UI request was resolved by this call. /// ///
    /// @@ -5279,30 +10068,34 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_current_promotable(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn handle_pending_user_input( + &self, + params: UIHandlePendingUserInputRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_TASKS_GETCURRENTPROMOTABLE, + rpc_methods::SESSION_UI_HANDLEPENDINGUSERINPUT, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Promotes an eligible synchronously-waited task so it continues running in the background. + /// Resolves a pending `sampling.requested` event with a sampling result, or rejects it. /// - /// Wire method: `session.tasks.promoteToBackground`. + /// Wire method: `session.ui.handlePendingSampling`. /// /// # Parameters /// - /// * `params` - Identifier of the task to promote to background mode. + /// * `params` - Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). /// /// # Returns /// - /// Indicates whether the task was successfully promoted to background mode. + /// Indicates whether the pending UI request was resolved by this call. /// ///
    /// @@ -5311,30 +10104,34 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn promote_to_background( + pub async fn handle_pending_sampling( &self, - params: TasksPromoteToBackgroundRequest, - ) -> Result { + params: UIHandlePendingSamplingRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_TASKS_PROMOTETOBACKGROUND, + rpc_methods::SESSION_UI_HANDLEPENDINGSAMPLING, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Atomically promotes the first promotable sync-waiting task to background mode and returns it. + /// Resolves a pending `auto_mode_switch.requested` event with the user's accept/decline decision. /// - /// Wire method: `session.tasks.promoteCurrentToBackground`. + /// Wire method: `session.ui.handlePendingAutoModeSwitch`. + /// + /// # Parameters + /// + /// * `params` - Request ID of a pending `auto_mode_switch.requested` event and the user's response. /// /// # Returns /// - /// The promoted task as it now exists in background mode, omitted if no promotable task was waiting. + /// Indicates whether the pending UI request was resolved by this call. /// ///
    /// @@ -5343,32 +10140,34 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn promote_current_to_background( + pub async fn handle_pending_auto_mode_switch( &self, - ) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + params: UIHandlePendingAutoModeSwitchRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_TASKS_PROMOTECURRENTTOBACKGROUND, + rpc_methods::SESSION_UI_HANDLEPENDINGAUTOMODESWITCH, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Cancels a background task. + /// Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action. /// - /// Wire method: `session.tasks.cancel`. + /// Wire method: `session.ui.handlePendingSessionLimitsExhausted`. /// /// # Parameters /// - /// * `params` - Identifier of the background task to cancel. + /// * `params` - Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action. /// /// # Returns /// - /// Indicates whether the background task was successfully cancelled. + /// Indicates whether the pending UI request was resolved by this call. /// ///
    /// @@ -5377,28 +10176,34 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn cancel(&self, params: TasksCancelRequest) -> Result { + pub async fn handle_pending_session_limits_exhausted( + &self, + params: UIHandlePendingSessionLimitsExhaustedRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_CANCEL, Some(wire_params)) + .call( + rpc_methods::SESSION_UI_HANDLEPENDINGSESSIONLIMITSEXHAUSTED, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Removes a completed or cancelled background task from tracking. + /// Resolves a pending `exit_plan_mode.requested` event with the user's response. /// - /// Wire method: `session.tasks.remove`. + /// Wire method: `session.ui.handlePendingExitPlanMode`. /// /// # Parameters /// - /// * `params` - Identifier of the completed or cancelled task to remove from tracking. + /// * `params` - Request ID of a pending `exit_plan_mode.requested` event and the user's response. /// /// # Returns /// - /// Indicates whether the task was removed. False when the task does not exist or is still running/idle. + /// Indicates whether the pending UI request was resolved by this call. /// ///
    /// @@ -5407,28 +10212,30 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn remove(&self, params: TasksRemoveRequest) -> Result { + pub async fn handle_pending_exit_plan_mode( + &self, + params: UIHandlePendingExitPlanModeRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_REMOVE, Some(wire_params)) + .call( + rpc_methods::SESSION_UI_HANDLEPENDINGEXITPLANMODE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Sends a message to a background agent task. - /// - /// Wire method: `session.tasks.sendMessage`. - /// - /// # Parameters + /// Registers an in-process handler for auto-mode-switch requests so the server bridge skips dispatch. /// - /// * `params` - Identifier of the target agent task, message content, and optional sender agent ID. + /// Wire method: `session.ui.registerDirectAutoModeSwitchHandler`. /// /// # Returns /// - /// Indicates whether the message was delivered, with an error message when delivery failed. + /// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). /// ///
    /// @@ -5437,35 +10244,32 @@ impl<'a> SessionRpcTasks<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn send_message( + pub async fn register_direct_auto_mode_switch_handler( &self, - params: TasksSendMessageRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_TASKS_SENDMESSAGE, Some(wire_params)) + .call( + rpc_methods::SESSION_UI_REGISTERDIRECTAUTOMODESWITCHHANDLER, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.telemetry.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcTelemetry<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcTelemetry<'a> { - /// Sets feature override key/value pairs to attach to subsequent telemetry events for the session. + /// Unregisters a previously-registered in-process auto-mode-switch handler by its opaque handle. /// - /// Wire method: `session.telemetry.setFeatureOverrides`. + /// Wire method: `session.ui.unregisterDirectAutoModeSwitchHandler`. /// /// # Parameters /// - /// * `params` - Feature override key/value pairs to attach to subsequent telemetry events from this session. + /// * `params` - Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. + /// + /// # Returns + /// + /// Indicates whether the handle was active and the registration count was decremented. /// ///
    /// @@ -5474,42 +10278,38 @@ impl<'a> SessionRpcTelemetry<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn set_feature_overrides( + pub async fn unregister_direct_auto_mode_switch_handler( &self, - params: TelemetrySetFeatureOverridesRequest, - ) -> Result<(), Error> { + params: UIUnregisterDirectAutoModeSwitchHandlerRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_TELEMETRY_SETFEATUREOVERRIDES, + rpc_methods::SESSION_UI_UNREGISTERDIRECTAUTOMODESWITCHHANDLER, Some(wire_params), ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } } -/// `session.tools.*` RPCs. +/// `session.usage.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcTools<'a> { +pub struct SessionRpcUsage<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcTools<'a> { - /// Provides the result for a pending external tool call. - /// - /// Wire method: `session.tools.handlePendingToolCall`. - /// - /// # Parameters +impl<'a> SessionRpcUsage<'a> { + /// Gets accumulated usage metrics for the session. /// - /// * `params` - Pending external tool call request ID, with the tool result or an error describing why it failed. + /// Wire method: `session.usage.getMetrics`. /// /// # Returns /// - /// Indicates whether the external tool call result was handled successfully. + /// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. /// ///
    /// @@ -5518,30 +10318,31 @@ impl<'a> SessionRpcTools<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_tool_call( - &self, - params: HandlePendingToolCallRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn get_metrics(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_TOOLS_HANDLEPENDINGTOOLCALL, - Some(wire_params), - ) + .call(rpc_methods::SESSION_USAGE_GETMETRICS, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } +} - /// Resolves, builds, and validates the runtime tool list for the session. +/// `session.visibility.*` RPCs. +#[derive(Clone, Copy)] +pub struct SessionRpcVisibility<'a> { + pub(crate) session: &'a Session, +} + +impl<'a> SessionRpcVisibility<'a> { + /// Returns the session's current Mission Control sharing status and shareable GitHub URL. Reflects whether the synced session is visible to repository readers ("repo") or restricted to its creator and collaborators ("unshared"). /// - /// Wire method: `session.tools.initializeAndValidate`. + /// Wire method: `session.visibility.get`. /// /// # Returns /// - /// Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation. + /// Current sharing status and shareable GitHub URL for a session. /// ///
    /// @@ -5550,26 +10351,27 @@ impl<'a> SessionRpcTools<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn initialize_and_validate(&self) -> Result { + pub async fn get(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_TOOLS_INITIALIZEANDVALIDATE, - Some(wire_params), - ) + .call(rpc_methods::SESSION_VISIBILITY_GET, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Returns lightweight metadata for the session's currently initialized tools. + /// Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers. Returns the effective status and shareable GitHub URL after the change. + /// + /// Wire method: `session.visibility.set`. + /// + /// # Parameters /// - /// Wire method: `session.tools.getCurrentMetadata`. + /// * `params` - Desired sharing status for the session. /// /// # Returns /// - /// Current lightweight tool metadata snapshot for the session. + /// Effective sharing status and shareable GitHub URL after updating session visibility. /// ///
    /// @@ -5578,38 +10380,32 @@ impl<'a> SessionRpcTools<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_current_metadata(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn set(&self, params: VisibilitySetRequest) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_TOOLS_GETCURRENTMETADATA, - Some(wire_params), - ) + .call(rpc_methods::SESSION_VISIBILITY_SET, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } } -/// `session.ui.*` RPCs. +/// `session.workspaces.*` RPCs. #[derive(Clone, Copy)] -pub struct SessionRpcUi<'a> { +pub struct SessionRpcWorkspaces<'a> { pub(crate) session: &'a Session, } -impl<'a> SessionRpcUi<'a> { - /// Requests structured input from a UI-capable client. - /// - /// Wire method: `session.ui.elicitation`. - /// - /// # Parameters +impl<'a> SessionRpcWorkspaces<'a> { + /// Gets current workspace metadata for the session. /// - /// * `params` - Prompt message and JSON schema describing the form fields to elicit from the user. + /// Wire method: `session.workspaces.getWorkspace`. /// /// # Returns /// - /// The elicitation response (accept with form values, decline, or cancel) + /// Current workspace metadata for the session, including its absolute filesystem path when available. /// ///
    /// @@ -5618,31 +10414,30 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn elicitation( - &self, - params: UIElicitationRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn get_workspace(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_UI_ELICITATION, Some(wire_params)) + .call( + rpc_methods::SESSION_WORKSPACES_GETWORKSPACE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Provides the user response for a pending elicitation request. + /// Updates workspace metadata for a local session and returns the refreshed workspace. /// - /// Wire method: `session.ui.handlePendingElicitation`. + /// Wire method: `session.workspaces.updateMetadata`. /// /// # Parameters /// - /// * `params` - Pending elicitation request ID and the user's response (accept/decline/cancel + form values). + /// * `params` - Workspace metadata fields to update. /// /// # Returns /// - /// Indicates whether the elicitation response was accepted; false if it was already resolved by another client. + /// Current workspace metadata for the session, including its absolute filesystem path when available. /// ///
    /// @@ -5651,34 +10446,34 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_elicitation( + pub async fn update_metadata( &self, - params: UIHandlePendingElicitationRequest, - ) -> Result { + params: WorkspacesUpdateMetadataRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_UI_HANDLEPENDINGELICITATION, + rpc_methods::SESSION_WORKSPACES_UPDATEMETADATA, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a pending `user_input.requested` event with the user's response. + /// Ensures a local session workspace exists and returns it. /// - /// Wire method: `session.ui.handlePendingUserInput`. + /// Wire method: `session.workspaces.ensure`. /// /// # Parameters /// - /// * `params` - Request ID of a pending `user_input.requested` event and the user's response. + /// * `params` - Optional session context used when creating a local workspace. /// /// # Returns /// - /// Indicates whether the pending UI request was resolved by this call. + /// Current workspace metadata for the session, including its absolute filesystem path when available. /// ///
    /// @@ -5687,34 +10482,27 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_user_input( + pub async fn ensure( &self, - params: UIHandlePendingUserInputRequest, - ) -> Result { + params: WorkspacesEnsureRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_UI_HANDLEPENDINGUSERINPUT, - Some(wire_params), - ) + .call(rpc_methods::SESSION_WORKSPACES_ENSURE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a pending `sampling.requested` event with a sampling result, or rejects it. - /// - /// Wire method: `session.ui.handlePendingSampling`. - /// - /// # Parameters + /// Lists files stored in the session workspace files directory. /// - /// * `params` - Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject). + /// Wire method: `session.workspaces.listFiles`. /// /// # Returns /// - /// Indicates whether the pending UI request was resolved by this call. + /// Relative paths of files stored in the session workspace files directory. /// ///
    /// @@ -5723,34 +10511,27 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_sampling( - &self, - params: UIHandlePendingSamplingRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + pub async fn list_files(&self) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call( - rpc_methods::SESSION_UI_HANDLEPENDINGSAMPLING, - Some(wire_params), - ) + .call(rpc_methods::SESSION_WORKSPACES_LISTFILES, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a pending `auto_mode_switch.requested` event with the user's accept/decline decision. + /// Reads a file from the session workspace files directory. /// - /// Wire method: `session.ui.handlePendingAutoModeSwitch`. + /// Wire method: `session.workspaces.readFile`. /// /// # Parameters /// - /// * `params` - Request ID of a pending `auto_mode_switch.requested` event and the user's response. + /// * `params` - Relative path of the workspace file to read. /// /// # Returns /// - /// Indicates whether the pending UI request was resolved by this call. + /// Contents of the requested workspace file as a UTF-8 string. /// ///
    /// @@ -5759,34 +10540,27 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_auto_mode_switch( + pub async fn read_file( &self, - params: UIHandlePendingAutoModeSwitchRequest, - ) -> Result { + params: WorkspacesReadFileRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call( - rpc_methods::SESSION_UI_HANDLEPENDINGAUTOMODESWITCH, - Some(wire_params), - ) + .call(rpc_methods::SESSION_WORKSPACES_READFILE, Some(wire_params)) .await?; Ok(serde_json::from_value(_value)?) } - /// Resolves a pending `exit_plan_mode.requested` event with the user's response. + /// Creates or overwrites a file in the session workspace files directory. /// - /// Wire method: `session.ui.handlePendingExitPlanMode`. + /// Wire method: `session.workspaces.createFile`. /// /// # Parameters /// - /// * `params` - Request ID of a pending `exit_plan_mode.requested` event and the user's response. - /// - /// # Returns - /// - /// Indicates whether the pending UI request was resolved by this call. + /// * `params` - Relative path and UTF-8 content for the workspace file to create or overwrite. /// ///
    /// @@ -5795,30 +10569,27 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn handle_pending_exit_plan_mode( - &self, - params: UIHandlePendingExitPlanModeRequest, - ) -> Result { + pub async fn create_file(&self, params: WorkspacesCreateFileRequest) -> Result<(), Error> { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_UI_HANDLEPENDINGEXITPLANMODE, + rpc_methods::SESSION_WORKSPACES_CREATEFILE, Some(wire_params), ) .await?; - Ok(serde_json::from_value(_value)?) + Ok(()) } - /// Registers an in-process handler for auto-mode-switch requests so the server bridge skips dispatch. + /// Lists workspace checkpoints in chronological order. /// - /// Wire method: `session.ui.registerDirectAutoModeSwitchHandler`. + /// Wire method: `session.workspaces.listCheckpoints`. /// /// # Returns /// - /// Register an in-process handler for `auto_mode_switch.requested` events. The caller still attaches the actual listener via the standard event-subscription mechanism; this registration solely tells the server bridge to skip its own dispatch (so a remote client doesn't race the in-process handler for the same requestId). + /// Workspace checkpoints in chronological order; empty when the workspace is not enabled. /// ///
    /// @@ -5827,32 +10598,30 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn register_direct_auto_mode_switch_handler( - &self, - ) -> Result { + pub async fn list_checkpoints(&self) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_UI_REGISTERDIRECTAUTOMODESWITCHHANDLER, + rpc_methods::SESSION_WORKSPACES_LISTCHECKPOINTS, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Unregisters a previously-registered in-process auto-mode-switch handler by its opaque handle. + /// Reads the content of a workspace checkpoint by number. /// - /// Wire method: `session.ui.unregisterDirectAutoModeSwitchHandler`. + /// Wire method: `session.workspaces.readCheckpoint`. /// /// # Parameters /// - /// * `params` - Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release. + /// * `params` - Checkpoint number to read. /// /// # Returns /// - /// Indicates whether the handle was active and the registration count was decremented. + /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. /// ///
    /// @@ -5861,38 +10630,34 @@ impl<'a> SessionRpcUi<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn unregister_direct_auto_mode_switch_handler( + pub async fn read_checkpoint( &self, - params: UIUnregisterDirectAutoModeSwitchHandlerRequest, - ) -> Result { + params: WorkspacesReadCheckpointRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_UI_UNREGISTERDIRECTAUTOMODESWITCHHANDLER, + rpc_methods::SESSION_WORKSPACES_READCHECKPOINT, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.usage.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcUsage<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcUsage<'a> { - /// Gets accumulated usage metrics for the session. + /// Adds a compaction summary checkpoint to the local session workspace. /// - /// Wire method: `session.usage.getMetrics`. + /// Wire method: `session.workspaces.addSummary`. + /// + /// # Parameters + /// + /// * `params` - Compaction summary checkpoint to persist. /// /// # Returns /// - /// Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals. + /// Persisted summary metadata and refreshed workspace metadata. /// ///
    /// @@ -5901,27 +10666,30 @@ impl<'a> SessionRpcUsage<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_metrics(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn add_summary( + &self, + params: WorkspacesAddSummaryRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() - .call(rpc_methods::SESSION_USAGE_GETMETRICS, Some(wire_params)) + .call( + rpc_methods::SESSION_WORKSPACES_ADDSUMMARY, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } -} - -/// `session.workspaces.*` RPCs. -#[derive(Clone, Copy)] -pub struct SessionRpcWorkspaces<'a> { - pub(crate) session: &'a Session, -} -impl<'a> SessionRpcWorkspaces<'a> { - /// Gets current workspace metadata for the session. + /// Truncates local workspace compaction summaries after a rollback. /// - /// Wire method: `session.workspaces.getWorkspace`. + /// Wire method: `session.workspaces.truncateSummaries`. + /// + /// # Parameters + /// + /// * `params` - Rollback point for local workspace summaries. /// /// # Returns /// @@ -5934,26 +10702,30 @@ impl<'a> SessionRpcWorkspaces<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn get_workspace(&self) -> Result { - let wire_params = serde_json::json!({ "sessionId": self.session.id() }); + pub async fn truncate_summaries( + &self, + params: WorkspacesTruncateSummariesRequest, + ) -> Result { + let mut wire_params = serde_json::to_value(params)?; + wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_WORKSPACES_GETWORKSPACE, + rpc_methods::SESSION_WORKSPACES_TRUNCATESUMMARIES, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Lists files stored in the session workspace files directory. + /// Reads the autopilot objective state file from the local session workspace. /// - /// Wire method: `session.workspaces.listFiles`. + /// Wire method: `session.workspaces.readAutopilotObjective`. /// /// # Returns /// - /// Relative paths of files stored in the session workspace files directory. + /// Autopilot objective file content, or null when missing. /// ///
    /// @@ -5962,27 +10734,32 @@ impl<'a> SessionRpcWorkspaces<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_files(&self) -> Result { + pub async fn read_autopilot_objective( + &self, + ) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() - .call(rpc_methods::SESSION_WORKSPACES_LISTFILES, Some(wire_params)) + .call( + rpc_methods::SESSION_WORKSPACES_READAUTOPILOTOBJECTIVE, + Some(wire_params), + ) .await?; Ok(serde_json::from_value(_value)?) } - /// Reads a file from the session workspace files directory. + /// Writes the autopilot objective state file in the local session workspace. /// - /// Wire method: `session.workspaces.readFile`. + /// Wire method: `session.workspaces.writeAutopilotObjective`. /// /// # Parameters /// - /// * `params` - Relative path of the workspace file to read. + /// * `params` - Autopilot objective file content to persist. /// /// # Returns /// - /// Contents of the requested workspace file as a UTF-8 string. + /// Result of writing the autopilot objective file. /// ///
    /// @@ -5991,56 +10768,30 @@ impl<'a> SessionRpcWorkspaces<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn read_file( + pub async fn write_autopilot_objective( &self, - params: WorkspacesReadFileRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); - let _value = self - .session - .client() - .call(rpc_methods::SESSION_WORKSPACES_READFILE, Some(wire_params)) - .await?; - Ok(serde_json::from_value(_value)?) - } - - /// Creates or overwrites a file in the session workspace files directory. - /// - /// Wire method: `session.workspaces.createFile`. - /// - /// # Parameters - /// - /// * `params` - Relative path and UTF-8 content for the workspace file to create or overwrite. - /// - ///
    - /// - /// **Experimental.** This API is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. Pin both the - /// SDK and CLI versions if your code depends on it. - /// - ///
    - pub async fn create_file(&self, params: WorkspacesCreateFileRequest) -> Result<(), Error> { + params: WorkspacesWriteAutopilotObjectiveRequest, + ) -> Result { let mut wire_params = serde_json::to_value(params)?; wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); let _value = self .session .client() .call( - rpc_methods::SESSION_WORKSPACES_CREATEFILE, + rpc_methods::SESSION_WORKSPACES_WRITEAUTOPILOTOBJECTIVE, Some(wire_params), ) .await?; - Ok(()) + Ok(serde_json::from_value(_value)?) } - /// Lists workspace checkpoints in chronological order. + /// Deletes the autopilot objective state file from the local session workspace. /// - /// Wire method: `session.workspaces.listCheckpoints`. + /// Wire method: `session.workspaces.deleteAutopilotObjective`. /// /// # Returns /// - /// Workspace checkpoints in chronological order; empty when the workspace is not enabled. + /// Result of deleting the autopilot objective file. /// ///
    /// @@ -6049,30 +10800,28 @@ impl<'a> SessionRpcWorkspaces<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn list_checkpoints(&self) -> Result { + pub async fn delete_autopilot_objective( + &self, + ) -> Result { let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_WORKSPACES_LISTCHECKPOINTS, + rpc_methods::SESSION_WORKSPACES_DELETEAUTOPILOTOBJECTIVE, Some(wire_params), ) .await?; Ok(serde_json::from_value(_value)?) } - /// Reads the content of a workspace checkpoint by number. - /// - /// Wire method: `session.workspaces.readCheckpoint`. - /// - /// # Parameters + /// Checks whether the local session workspace has an autopilot objective state file. /// - /// * `params` - Checkpoint number to read. + /// Wire method: `session.workspaces.autopilotObjectiveExists`. /// /// # Returns /// - /// Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing. + /// Whether the autopilot objective file exists. /// ///
    /// @@ -6081,17 +10830,15 @@ impl<'a> SessionRpcWorkspaces<'a> { /// SDK and CLI versions if your code depends on it. /// ///
    - pub async fn read_checkpoint( + pub async fn autopilot_objective_exists( &self, - params: WorkspacesReadCheckpointRequest, - ) -> Result { - let mut wire_params = serde_json::to_value(params)?; - wire_params["sessionId"] = serde_json::Value::String(self.session.id().to_string()); + ) -> Result { + let wire_params = serde_json::json!({ "sessionId": self.session.id() }); let _value = self .session .client() .call( - rpc_methods::SESSION_WORKSPACES_READCHECKPOINT, + rpc_methods::SESSION_WORKSPACES_AUTOPILOTOBJECTIVEEXISTS, Some(wire_params), ) .await?; @@ -6134,7 +10881,7 @@ impl<'a> SessionRpcWorkspaces<'a> { Ok(serde_json::from_value(_value)?) } - /// Computes a diff for the session workspace. + /// Computes a diff for the session workspace. Never rejects for a busy session: a `session`-mode diff that cannot read the session's file-change captures falls back to an unstaged git diff with `isFallback: true` and reports why in `unavailableReason`. /// /// Wire method: `session.workspaces.diff`. /// diff --git a/rust/src/generated/session_events.rs b/rust/src/generated/session_events.rs index cc88b3d86..913499a6f 100644 --- a/rust/src/generated/session_events.rs +++ b/rust/src/generated/session_events.rs @@ -1,5 +1,7 @@ //! Auto-generated from session-events.schema.json — do not edit manually. +#![allow(deprecated)] + use std::collections::HashMap; use serde::{Deserialize, Serialize}; @@ -25,6 +27,8 @@ pub enum SessionEventType { SessionScheduleCreated, #[serde(rename = "session.schedule_cancelled")] SessionScheduleCancelled, + #[serde(rename = "session.schedule_rearmed")] + SessionScheduleRearmed, #[serde(rename = "session.autopilot_objective_changed")] SessionAutopilotObjectiveChanged, #[serde(rename = "session.info")] @@ -35,10 +39,14 @@ pub enum SessionEventType { SessionModelChange, #[serde(rename = "session.mode_changed")] SessionModeChanged, + #[serde(rename = "session.session_limits_changed")] + SessionSessionLimitsChanged, #[serde(rename = "session.permissions_changed")] SessionPermissionsChanged, #[serde(rename = "session.plan_changed")] SessionPlanChanged, + #[serde(rename = "session.todos_changed")] + SessionTodosChanged, #[serde(rename = "session.workspace_file_changed")] SessionWorkspaceFileChanged, #[serde(rename = "session.handoff")] @@ -49,10 +57,14 @@ pub enum SessionEventType { SessionSnapshotRewind, #[serde(rename = "session.shutdown")] SessionShutdown, + #[serde(rename = "session.usage_checkpoint")] + SessionUsageCheckpoint, #[serde(rename = "session.context_changed")] SessionContextChanged, #[serde(rename = "session.usage_info")] SessionUsageInfo, + #[serde(rename = "session.context_cleared")] + SessionContextCleared, #[serde(rename = "session.compaction_start")] SessionCompactionStart, #[serde(rename = "session.compaction_complete")] @@ -65,12 +77,18 @@ pub enum SessionEventType { PendingMessagesModified, #[serde(rename = "assistant.turn_start")] AssistantTurnStart, + #[serde(rename = "assistant.turn_retry")] + AssistantTurnRetry, #[serde(rename = "assistant.intent")] AssistantIntent, + #[serde(rename = "assistant.server_tool_progress")] + AssistantServerToolProgress, #[serde(rename = "assistant.reasoning")] AssistantReasoning, #[serde(rename = "assistant.reasoning_delta")] AssistantReasoningDelta, + #[serde(rename = "assistant.tool_call_delta")] + AssistantToolCallDelta, #[serde(rename = "assistant.streaming_delta")] AssistantStreamingDelta, #[serde(rename = "assistant.message")] @@ -81,10 +99,14 @@ pub enum SessionEventType { AssistantMessageDelta, #[serde(rename = "assistant.turn_end")] AssistantTurnEnd, + #[serde(rename = "assistant.idle")] + AssistantIdle, #[serde(rename = "assistant.usage")] AssistantUsage, #[serde(rename = "model.call_failure")] ModelCallFailure, + #[serde(rename = "model.call_start")] + ModelCallStart, #[serde(rename = "abort")] Abort, #[serde(rename = "tool.user_requested")] @@ -97,6 +119,8 @@ pub enum SessionEventType { ToolExecutionProgress, #[serde(rename = "tool.execution_complete")] ToolExecutionComplete, + #[serde(rename = "tool_search.activated")] + ToolSearchActivated, #[serde(rename = "skill.invoked")] SkillInvoked, #[serde(rename = "subagent.started")] @@ -115,6 +139,15 @@ pub enum SessionEventType { HookEnd, #[serde(rename = "hook.progress")] HookProgress, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.binary_asset")] + SessionBinaryAsset, #[serde(rename = "system.message")] SystemMessage, #[serde(rename = "system.notification")] @@ -139,6 +172,10 @@ pub enum SessionEventType { McpOauthRequired, #[serde(rename = "mcp.oauth_completed")] McpOauthCompleted, + #[serde(rename = "mcp.headers_refresh_required")] + McpHeadersRefreshRequired, + #[serde(rename = "mcp.headers_refresh_completed")] + McpHeadersRefreshCompleted, #[serde(rename = "session.custom_notification")] SessionCustomNotification, #[serde(rename = "external_tool.requested")] @@ -155,6 +192,37 @@ pub enum SessionEventType { AutoModeSwitchRequested, #[serde(rename = "auto_mode_switch.completed")] AutoModeSwitchCompleted, + #[serde(rename = "session_limits_exhausted.requested")] + SessionLimitsExhaustedRequested, + #[serde(rename = "session_limits_exhausted.completed")] + SessionLimitsExhaustedCompleted, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.auto_mode_resolved")] + SessionAutoModeResolved, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.managed_settings_resolved")] + SessionManagedSettingsResolved, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.managed_settings_enforced")] + SessionManagedSettingsEnforced, #[serde(rename = "commands.changed")] CommandsChanged, #[serde(rename = "capabilities.changed")] @@ -167,6 +235,15 @@ pub enum SessionEventType { SessionToolsUpdated, #[serde(rename = "session.background_tasks_changed")] SessionBackgroundTasksChanged, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "factory.run_updated")] + FactoryRunUpdated, #[serde(rename = "session.skills_loaded")] SessionSkillsLoaded, #[serde(rename = "session.custom_agents_updated")] @@ -175,12 +252,70 @@ pub enum SessionEventType { SessionMcpServersLoaded, #[serde(rename = "session.mcp_server_status_changed")] SessionMcpServerStatusChanged, + #[serde(rename = "mcp.tools.list_changed")] + McpToolsListChanged, + #[serde(rename = "mcp.resources.list_changed")] + McpResourcesListChanged, + #[serde(rename = "mcp.prompts.list_changed")] + McpPromptsListChanged, #[serde(rename = "session.extensions_loaded")] SessionExtensionsLoaded, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    #[serde(rename = "session.canvas.opened")] SessionCanvasOpened, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    #[serde(rename = "session.canvas.registry_changed")] SessionCanvasRegistryChanged, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.closed")] + SessionCanvasClosed, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.unavailable")] + SessionCanvasUnavailable, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.recorded")] + SessionCanvasRecorded, + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.removed")] + SessionCanvasRemoved, + #[serde(rename = "session.extensions.attachments_pushed")] + SessionExtensionsAttachmentsPushed, #[serde(rename = "mcp_app.tool_call_complete")] McpAppToolCallComplete, /// Unknown event type for forward compatibility. @@ -211,6 +346,8 @@ pub enum SessionEventData { SessionScheduleCreated(SessionScheduleCreatedData), #[serde(rename = "session.schedule_cancelled")] SessionScheduleCancelled(SessionScheduleCancelledData), + #[serde(rename = "session.schedule_rearmed")] + SessionScheduleRearmed(SessionScheduleRearmedData), #[serde(rename = "session.autopilot_objective_changed")] SessionAutopilotObjectiveChanged(SessionAutopilotObjectiveChangedData), #[serde(rename = "session.info")] @@ -221,10 +358,14 @@ pub enum SessionEventData { SessionModelChange(SessionModelChangeData), #[serde(rename = "session.mode_changed")] SessionModeChanged(SessionModeChangedData), + #[serde(rename = "session.session_limits_changed")] + SessionSessionLimitsChanged(SessionSessionLimitsChangedData), #[serde(rename = "session.permissions_changed")] SessionPermissionsChanged(SessionPermissionsChangedData), #[serde(rename = "session.plan_changed")] SessionPlanChanged(SessionPlanChangedData), + #[serde(rename = "session.todos_changed")] + SessionTodosChanged(SessionTodosChangedData), #[serde(rename = "session.workspace_file_changed")] SessionWorkspaceFileChanged(SessionWorkspaceFileChangedData), #[serde(rename = "session.handoff")] @@ -235,10 +376,14 @@ pub enum SessionEventData { SessionSnapshotRewind(SessionSnapshotRewindData), #[serde(rename = "session.shutdown")] SessionShutdown(SessionShutdownData), + #[serde(rename = "session.usage_checkpoint")] + SessionUsageCheckpoint(SessionUsageCheckpointData), #[serde(rename = "session.context_changed")] SessionContextChanged(SessionContextChangedData), #[serde(rename = "session.usage_info")] SessionUsageInfo(SessionUsageInfoData), + #[serde(rename = "session.context_cleared")] + SessionContextCleared(SessionContextClearedData), #[serde(rename = "session.compaction_start")] SessionCompactionStart(SessionCompactionStartData), #[serde(rename = "session.compaction_complete")] @@ -251,12 +396,18 @@ pub enum SessionEventData { PendingMessagesModified(PendingMessagesModifiedData), #[serde(rename = "assistant.turn_start")] AssistantTurnStart(AssistantTurnStartData), + #[serde(rename = "assistant.turn_retry")] + AssistantTurnRetry(AssistantTurnRetryData), #[serde(rename = "assistant.intent")] AssistantIntent(AssistantIntentData), + #[serde(rename = "assistant.server_tool_progress")] + AssistantServerToolProgress(AssistantServerToolProgressData), #[serde(rename = "assistant.reasoning")] AssistantReasoning(AssistantReasoningData), #[serde(rename = "assistant.reasoning_delta")] AssistantReasoningDelta(AssistantReasoningDeltaData), + #[serde(rename = "assistant.tool_call_delta")] + AssistantToolCallDelta(AssistantToolCallDeltaData), #[serde(rename = "assistant.streaming_delta")] AssistantStreamingDelta(AssistantStreamingDeltaData), #[serde(rename = "assistant.message")] @@ -267,10 +418,14 @@ pub enum SessionEventData { AssistantMessageDelta(AssistantMessageDeltaData), #[serde(rename = "assistant.turn_end")] AssistantTurnEnd(AssistantTurnEndData), + #[serde(rename = "assistant.idle")] + AssistantIdle(AssistantIdleData), #[serde(rename = "assistant.usage")] AssistantUsage(AssistantUsageData), #[serde(rename = "model.call_failure")] ModelCallFailure(ModelCallFailureData), + #[serde(rename = "model.call_start")] + ModelCallStart(ModelCallStartData), #[serde(rename = "abort")] Abort(AbortData), #[serde(rename = "tool.user_requested")] @@ -283,6 +438,8 @@ pub enum SessionEventData { ToolExecutionProgress(ToolExecutionProgressData), #[serde(rename = "tool.execution_complete")] ToolExecutionComplete(ToolExecutionCompleteData), + #[serde(rename = "tool_search.activated")] + ToolSearchActivated(ToolSearchActivatedData), #[serde(rename = "skill.invoked")] SkillInvoked(SkillInvokedData), #[serde(rename = "subagent.started")] @@ -301,6 +458,8 @@ pub enum SessionEventData { HookEnd(HookEndData), #[serde(rename = "hook.progress")] HookProgress(HookProgressData), + #[serde(rename = "session.binary_asset")] + SessionBinaryAsset(SessionBinaryAssetData), #[serde(rename = "system.message")] SystemMessage(SystemMessageData), #[serde(rename = "system.notification")] @@ -325,6 +484,10 @@ pub enum SessionEventData { McpOauthRequired(McpOauthRequiredData), #[serde(rename = "mcp.oauth_completed")] McpOauthCompleted(McpOauthCompletedData), + #[serde(rename = "mcp.headers_refresh_required")] + McpHeadersRefreshRequired(McpHeadersRefreshRequiredData), + #[serde(rename = "mcp.headers_refresh_completed")] + McpHeadersRefreshCompleted(McpHeadersRefreshCompletedData), #[serde(rename = "session.custom_notification")] SessionCustomNotification(SessionCustomNotificationData), #[serde(rename = "external_tool.requested")] @@ -341,6 +504,37 @@ pub enum SessionEventData { AutoModeSwitchRequested(AutoModeSwitchRequestedData), #[serde(rename = "auto_mode_switch.completed")] AutoModeSwitchCompleted(AutoModeSwitchCompletedData), + #[serde(rename = "session_limits_exhausted.requested")] + SessionLimitsExhaustedRequested(SessionLimitsExhaustedRequestedData), + #[serde(rename = "session_limits_exhausted.completed")] + SessionLimitsExhaustedCompleted(SessionLimitsExhaustedCompletedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.auto_mode_resolved")] + SessionAutoModeResolved(SessionAutoModeResolvedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.managed_settings_resolved")] + SessionManagedSettingsResolved(SessionManagedSettingsResolvedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.managed_settings_enforced")] + SessionManagedSettingsEnforced(SessionManagedSettingsEnforcedData), #[serde(rename = "commands.changed")] CommandsChanged(CommandsChangedData), #[serde(rename = "capabilities.changed")] @@ -353,6 +547,15 @@ pub enum SessionEventData { SessionToolsUpdated(SessionToolsUpdatedData), #[serde(rename = "session.background_tasks_changed")] SessionBackgroundTasksChanged(SessionBackgroundTasksChangedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "factory.run_updated")] + FactoryRunUpdated(FactoryRunUpdatedData), #[serde(rename = "session.skills_loaded")] SessionSkillsLoaded(SessionSkillsLoadedData), #[serde(rename = "session.custom_agents_updated")] @@ -361,12 +564,70 @@ pub enum SessionEventData { SessionMcpServersLoaded(SessionMcpServersLoadedData), #[serde(rename = "session.mcp_server_status_changed")] SessionMcpServerStatusChanged(SessionMcpServerStatusChangedData), + #[serde(rename = "mcp.tools.list_changed")] + McpToolsListChanged(McpToolsListChangedData), + #[serde(rename = "mcp.resources.list_changed")] + McpResourcesListChanged(McpResourcesListChangedData), + #[serde(rename = "mcp.prompts.list_changed")] + McpPromptsListChanged(McpPromptsListChangedData), #[serde(rename = "session.extensions_loaded")] SessionExtensionsLoaded(SessionExtensionsLoadedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    #[serde(rename = "session.canvas.opened")] SessionCanvasOpened(SessionCanvasOpenedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    #[serde(rename = "session.canvas.registry_changed")] SessionCanvasRegistryChanged(SessionCanvasRegistryChangedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.closed")] + SessionCanvasClosed(SessionCanvasClosedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.unavailable")] + SessionCanvasUnavailable(SessionCanvasUnavailableData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.recorded")] + SessionCanvasRecorded(SessionCanvasRecordedData), + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(rename = "session.canvas.removed")] + SessionCanvasRemoved(SessionCanvasRemovedData), + #[serde(rename = "session.extensions.attachments_pushed")] + SessionExtensionsAttachmentsPushed(SessionExtensionsAttachmentsPushedData), #[serde(rename = "mcp_app.tool_call_complete")] McpAppToolCallComplete(McpAppToolCallCompleteData), } @@ -419,6 +680,9 @@ pub struct WorkingDirectoryContext { /// Hosting platform type of the repository (github or ado) #[serde(skip_serializing_if = "Option::is_none")] pub host_type: Option, + /// Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + #[serde(skip_serializing_if = "Option::is_none")] + pub pending_git_context: Option, /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) #[serde(skip_serializing_if = "Option::is_none")] pub repository: Option, @@ -427,6 +691,33 @@ pub struct WorkingDirectoryContext { pub repository_host: Option, } +/// Per-session configuration for the built-in GitHub MCP server +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubMcpToolConfig { + /// Additional GitHub MCP tools requested by the session + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_tools: Option>, + /// Additional GitHub MCP toolsets requested by the session + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_toolsets: Option>, + /// Whether to use the read-write endpoint and request all toolsets + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_all_tools: Option, + /// Whether to request the GitHub MCP insiders build + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_insiders_mode: Option, +} + +/// Optional session limits. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitsConfig { + /// Maximum AI Credits allowed across the session's current accounting window. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, +} + /// Session event "session.start". Session initialization metadata including context and configuration #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -439,12 +730,15 @@ pub struct SessionStartData { pub context: Option, /// Context tier selected at session creation time for models with tiered context pricing; null when no tier is selected (e.g., non-tiered model) #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, + pub context_tier: Option, /// Version string of the Copilot application pub copilot_version: String, /// When set, identifies a parent session whose context this session continues — e.g., a detached headless rem-agent run launched on the parent's interactive shutdown. Telemetry from this session is reported under the parent's session_id. #[serde(skip_serializing_if = "Option::is_none")] pub detached_from_spawning_parent_session_id: Option, + /// Per-session GitHub MCP override persisted for cold resume + #[serde(skip_serializing_if = "Option::is_none")] + pub github_mcp_tool_config: Option, /// Identifier of the software producing the events (e.g., "copilot-agent") pub producer: String, /// Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") @@ -461,8 +755,14 @@ pub struct SessionStartData { pub selected_model: Option, /// Unique identifier for the session pub session_id: SessionId, + /// Session limits configured at session creation time, if any + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, /// ISO 8601 timestamp when the session was created pub start_time: String, + /// Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, /// Schema version number for the session event format pub version: i64, } @@ -479,12 +779,15 @@ pub struct SessionResumeData { pub context: Option, /// Context tier currently selected at resume time; null when no tier is active #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, - /// 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. + pub context_tier: Option, + /// 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 or omitted, pending work is normally marked as interrupted unless the resume passively joined live work owned by another client; sessionWasActive distinguishes that case. #[serde(skip_serializing_if = "Option::is_none")] pub continue_pending_work: Option, /// Total number of persisted events in the session at the time of resume pub event_count: i64, + /// On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd + #[serde(skip_serializing_if = "Option::is_none")] + pub events_file_size_bytes: Option, /// Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max") #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_effort: Option, @@ -499,9 +802,15 @@ pub struct SessionResumeData { /// Model currently selected at resume time #[serde(skip_serializing_if = "Option::is_none")] pub selected_model: Option, - /// 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. + /// Session limits currently configured at resume time; null when no limits are active + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, + /// True when this resume passively joined a session that already had live work running in the runtime - an agent turn, a native queue run, a queued resume continuation, or an in-flight send (for example, an extension joining a session another client was actively driving). False (or omitted) when the session had no live work or when the resume explicitly abandoned pending work, including cold resumes and suspended sessions that remain resident in memory. #[serde(skip_serializing_if = "Option::is_none")] pub session_was_active: Option, + /// Output verbosity level used for model calls, if applicable (e.g. "low", "medium", "high") + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, } /// Session event "session.remote_steerable_changed". Notifies that the session's remote steering capability has changed @@ -543,7 +852,7 @@ pub struct SessionErrorData { pub url: Option, } -/// Session event "session.idle". Payload indicating the session is idle with no background agents in flight +/// Session event "session.idle". Payload indicating the session is idle with no background agents or attached shell commands in flight #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionIdleData { @@ -564,18 +873,34 @@ pub struct SessionTitleChangedData { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionScheduleCreatedData { + /// Absolute fire time (epoch milliseconds) for a one-shot calendar schedule + #[serde(skip_serializing_if = "Option::is_none")] + pub at: Option, + /// 5-field cron expression for a recurring calendar schedule, evaluated in `tz` + #[serde(skip_serializing_if = "Option::is_none")] + pub cron: Option, /// Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion) #[serde(skip_serializing_if = "Option::is_none")] pub display_prompt: Option, /// Sequential id assigned to the scheduled prompt within the session pub id: i64, - /// Interval between ticks in milliseconds - pub interval_ms: i64, + /// Interval between ticks in milliseconds (relative-interval schedules) + #[serde(skip_serializing_if = "Option::is_none")] + pub interval_ms: Option, + /// Who created the schedule (`user` or `model`). Persisted so a resumed session keeps gating non-user schedules from firing skills that opted out of model invocation. Absent on entries created before this field existed; a missing origin fails closed (treated the same as a non-user origin), so such a schedule may not resolve a `disable-model-invocation` skill. + #[serde(skip_serializing_if = "Option::is_none")] + pub origin: Option, /// Prompt text that gets enqueued on every tick pub prompt: String, /// Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`) #[serde(skip_serializing_if = "Option::is_none")] pub recurring: Option, + /// True for a self-paced (`dynamic`) schedule: no fixed cadence; the model arms each next run via the `manage_schedule` `wakeup` action. `nextRunAt` is model-controlled rather than auto-computed. + #[serde(skip_serializing_if = "Option::is_none")] + pub self_paced: Option, + /// IANA timezone the `cron` expression is evaluated in + #[serde(skip_serializing_if = "Option::is_none")] + pub tz: Option, } /// Session event "session.schedule_cancelled". Scheduled prompt cancelled from the schedule manager dialog @@ -586,6 +911,16 @@ pub struct SessionScheduleCancelledData { pub id: i64, } +/// Session event "session.schedule_rearmed". Self-paced schedule re-armed for its next run +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionScheduleRearmedData { + /// Id of the self-paced schedule that was re-armed + pub id: i64, + /// Absolute time (epoch milliseconds) the model armed the next run to fire + pub next_run_at: i64, +} + /// Session event "session.autopilot_objective_changed". Autopilot objective state file operation details indicating what changed #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -633,12 +968,12 @@ pub struct SessionWarningData { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionModelChangeData { - /// 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. + /// Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy. #[serde(skip_serializing_if = "Option::is_none")] pub cause: Option, /// Context tier after the model change; null explicitly clears a previously selected tier #[serde(skip_serializing_if = "Option::is_none")] - pub context_tier: Option, + pub context_tier: Option, /// Newly selected model identifier pub new_model: String, /// Model that was previously selected, if any @@ -650,12 +985,18 @@ pub struct SessionModelChangeData { /// Reasoning summary mode before the model change, if applicable #[serde(skip_serializing_if = "Option::is_none")] pub previous_reasoning_summary: Option, + /// Output verbosity level before the model change, if applicable + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_verbosity: Option, /// Reasoning effort level after the model change, if applicable #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_effort: Option, /// Reasoning summary mode after the model change, if applicable #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_summary: Option, + /// Output verbosity level after the model change, if applicable + #[serde(skip_serializing_if = "Option::is_none")] + pub verbosity: Option, } /// Session event "session.mode_changed". Agent mode change details including previous and new modes @@ -668,12 +1009,40 @@ pub struct SessionModeChangedData { pub previous_mode: SessionMode, } -/// Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all boolean transition. +/// Session event "session.session_limits_changed". Session limits update details. Null clears the limits. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionSessionLimitsChangedData { + /// Current session limits, or null when no limits are active + pub session_limits: Option, +} + +/// Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionPermissionsChangedData { + /// Allow-all mode after the change + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub allow_all_permission_mode: Option, /// Aggregate allow-all flag after the change pub allow_all_permissions: bool, + /// Allow-all mode before the change + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub previous_allow_all_permission_mode: Option, /// Aggregate allow-all flag before the change pub previous_allow_all_permissions: bool, } @@ -686,6 +1055,11 @@ pub struct SessionPlanChangedData { pub operation: PlanChangedOperation, } +/// Session event "session.todos_changed". Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionTodosChangedData {} + /// Session event "session.workspace_file_changed". Workspace file change details including path and operation type #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -804,7 +1178,7 @@ pub struct ShutdownModelMetricRequests { pub count: Option, } -/// Schema for the `ShutdownModelMetricTokenDetail` type. +/// A token-type entry in a shutdown model metric, storing the accumulated token count. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ShutdownModelMetricTokenDetail { @@ -829,7 +1203,7 @@ pub struct ShutdownModelMetricUsage { pub reasoning_tokens: Option, } -/// Schema for the `ShutdownModelMetric` type. +/// Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ShutdownModelMetric { @@ -852,7 +1226,7 @@ pub struct ShutdownModelMetric { pub usage: ShutdownModelMetricUsage, } -/// Schema for the `ShutdownTokenDetail` type. +/// A session-wide shutdown token-type entry storing the accumulated token count. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ShutdownTokenDetail { @@ -878,6 +1252,9 @@ pub struct SessionShutdownData { /// Error description when shutdownType is "error" #[serde(skip_serializing_if = "Option::is_none")] pub error_reason: Option, + /// On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd + #[serde(skip_serializing_if = "Option::is_none")] + pub events_file_size_bytes: Option, /// Per-model usage breakdown, keyed by model identifier pub model_metrics: HashMap, /// Unix timestamp (milliseconds) when the session started @@ -911,6 +1288,35 @@ pub struct SessionShutdownData { pub(crate) total_premium_requests: Option, } +/// Internal prompt-cache expiration state for one model +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct UsageCheckpointModelCacheState { + /// Latest known prompt-cache expiration + pub cache_expires_at: String, + /// Retained cache lifetime in seconds, used to refresh expiration after a cache read + #[doc(hidden)] + pub(crate) cache_ttl_seconds: i64, + /// Model identifier associated with this cache state + pub model_id: String, +} + +/// Session event "session.usage_checkpoint". Durable session usage checkpoint for reconstructing aggregate accounting on resume +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionUsageCheckpointData { + /// Internal per-model prompt-cache state used to restore expiration tracking on resume + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) model_cache_state: Option>, + /// Session-wide accumulated nano-AI units cost at checkpoint time + pub total_nano_aiu: f64, + /// Total number of premium API requests used at checkpoint time + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) total_premium_requests: Option, +} + /// Session event "session.context_changed". Updated working directory and git context after the change #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -932,6 +1338,9 @@ pub struct SessionContextChangedData { /// Hosting platform type of the repository (github or ado) #[serde(skip_serializing_if = "Option::is_none")] pub host_type: Option, + /// Set on the immediate preliminary event of a working-directory change, before the git context is resolved. A settled follow-up event (enriched with git context, or cwd-only for a non-repository) is always emitted afterward, so observers may defer to it. Absent on standalone/final events (e.g. relay context changes). + #[serde(skip_serializing_if = "Option::is_none")] + pub pending_git_context: Option, /// Repository identifier derived from the git remote URL ("owner/name" for GitHub, "org/project/repo" for Azure DevOps) #[serde(skip_serializing_if = "Option::is_none")] pub repository: Option, @@ -964,6 +1373,17 @@ pub struct SessionUsageInfoData { pub tool_definitions_tokens: Option, } +/// Session event "session.context_cleared". Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages) +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionContextClearedData { + /// Optional initial message set after clearing + #[serde(skip_serializing_if = "Option::is_none")] + pub initial_message: Option, + /// Number of conversation messages that were cleared + pub messages_cleared: i64, +} + /// Session event "session.compaction_start". Context window breakdown at the start of LLM-powered conversation compaction #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -971,12 +1391,24 @@ pub struct SessionCompactionStartData { /// Token count from non-system messages (user, assistant, tool) at compaction start #[serde(skip_serializing_if = "Option::is_none")] pub conversation_tokens: Option, + /// Total context tokens (system + conversation + tool definitions) at compaction start, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub current_tokens: Option, + /// Model identifier used for compaction, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Token count from system message(s) at compaction start #[serde(skip_serializing_if = "Option::is_none")] pub system_tokens: Option, + /// Model context window token limit the compaction is targeting, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub token_limit: Option, /// Token count from tool definitions at compaction start #[serde(skip_serializing_if = "Option::is_none")] pub tool_definitions_tokens: Option, + /// What initiated this compaction, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub trigger: Option, } /// Token usage detail for a single billing category @@ -998,7 +1430,10 @@ pub struct CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail { #[serde(rename_all = "camelCase")] pub(crate) struct CompactionCompleteCompactionTokensUsedCopilotUsage { /// Itemized token usage breakdown - pub token_details: Vec, + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) token_details: + Option>, /// Total cost in nano-AI units for this request pub total_nano_aiu: f64, } @@ -1071,6 +1506,9 @@ pub struct SessionCompactionCompleteData { /// Copilot service request ID (x-copilot-service-request-id header) for the compaction LLM call #[serde(skip_serializing_if = "Option::is_none")] pub service_request_id: Option, + /// For failed compaction only: the HTTP status code of the compaction LLM call failure, when it carried one. Absent for successful compaction and for failures without an HTTP status (e.g. an empty model response or a transport error). + #[serde(skip_serializing_if = "Option::is_none")] + pub status_code: Option, /// Whether compaction completed successfully pub success: bool, /// LLM-generated summary of the compacted conversation history @@ -1079,19 +1517,34 @@ pub struct SessionCompactionCompleteData { /// Token count from system message(s) after compaction #[serde(skip_serializing_if = "Option::is_none")] pub system_tokens: Option, + /// Model context window token limit the compaction was targeting, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub token_limit: Option, /// Number of tokens removed during compaction #[serde(skip_serializing_if = "Option::is_none")] pub tokens_removed: Option, /// Token count from tool definitions after compaction #[serde(skip_serializing_if = "Option::is_none")] pub tool_definitions_tokens: Option, + /// What initiated this compaction, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub trigger: Option, } /// Session event "session.task_complete". Task completion notification with summary from the agent #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionTaskCompleteData { - /// Whether the tool call succeeded. False when validation failed (e.g., invalid arguments) + /// Active autopilot objective ID evaluated by the completion reviewer + #[serde(skip_serializing_if = "Option::is_none")] + pub objective_id: Option, + /// Semantic completion decision. Absent on legacy events and invalid tool calls + #[serde(skip_serializing_if = "Option::is_none")] + pub outcome: Option, + /// Label-safe runtime rationale for the completion decision (e.g. a cancellation or pause/resume downgrade), when one applies. Reviewer-authored rationale is intentionally omitted here because this event has no IFC label channel; the reviewer's findings remain available through its own labeled sub-agent events + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Whether the task was accepted as complete. False when validation failed or completion was rejected or blocked by the reviewer #[serde(skip_serializing_if = "Option::is_none")] pub success: Option, /// Summary of the completed task, provided by the agent @@ -1099,7 +1552,7 @@ pub struct SessionTaskCompleteData { pub summary: Option, } -/// Session event "user.message". +/// Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserMessageData { @@ -1111,6 +1564,9 @@ pub struct UserMessageData { pub attachments: Option>, /// The user's message text as displayed in the timeline pub content: String, + /// How this message was delivered to the agentic loop relative to loop state (idle-start vs. steering/queued while busy). The timing axis; combine with `source` (origin) for the full picture. Used for telemetry attribution. + #[serde(skip_serializing_if = "Option::is_none")] + pub delivery: Option, /// CAPI interaction ID for correlating this user message with its turn #[serde(skip_serializing_if = "Option::is_none")] pub interaction_id: Option, @@ -1123,7 +1579,7 @@ pub struct UserMessageData { /// Parent agent task ID for background telemetry correlated to this user turn #[serde(skip_serializing_if = "Option::is_none")] pub parent_agent_task_id: Option, - /// Origin of this message, used for timeline filtering (e.g., "skill-pdf" for skill-injected messages that should be hidden from the user) + /// Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-` for an inter-agent prompt) #[serde(skip_serializing_if = "Option::is_none")] pub source: Option, /// Normalized document MIME types that were sent natively instead of through tagged_files XML @@ -1146,10 +1602,27 @@ pub struct AssistantTurnStartData { /// CAPI interaction ID for correlating this turn with upstream telemetry #[serde(skip_serializing_if = "Option::is_none")] pub interaction_id: Option, + /// Model identifier used for this turn, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Identifier for this turn within the agentic loop, typically a stringified turn number pub turn_id: String, } +/// Session event "assistant.turn_retry". Metadata for an additional model inference attempt within an existing assistant turn +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantTurnRetryData { + /// Model identifier used for this retry, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Provider or runtime classification that caused the retry, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// Identifier of the turn whose model inference is being retried + pub turn_id: String, +} + /// Session event "assistant.intent". Agent intent description for current activity or plan #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1158,14 +1631,28 @@ pub struct AssistantIntentData { pub intent: String, } -/// Session event "assistant.reasoning". Assistant reasoning content for timeline display with complete thinking text +/// Session event "assistant.server_tool_progress". Live progress signal for a provider-hosted server tool (e.g. hosted web search) while it runs, before the finalized serverTools envelope lands on the terminal assistant.message #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct AssistantReasoningData { - /// The complete extended thinking text from the model +pub struct AssistantServerToolProgressData { + /// Kind of hosted server tool that is running. Only `web_search` is emitted today. + pub kind: String, + /// Position of the hosted tool call in the response output. Stable across the call's lifecycle events (unlike the provider's per-event item id, which CAPI rotates), so the host keys the live in-progress row on it. + pub output_index: i64, + /// Lifecycle status of the hosted call: `in_progress`, `searching`, or `completed`. + pub status: String, +} + +/// Session event "assistant.reasoning". Assistant reasoning content for timeline display with complete thinking text +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantReasoningData { + /// The complete extended thinking text from the model pub content: String, /// Unique identifier for this reasoning block pub reasoning_id: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, } /// Session event "assistant.reasoning_delta". Streaming reasoning delta for incremental extended thinking updates @@ -1178,6 +1665,22 @@ pub struct AssistantReasoningDeltaData { pub reasoning_id: String, } +/// Session event "assistant.tool_call_delta". Streaming tool-call input delta for incremental tool-call updates +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantToolCallDeltaData { + /// Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input. + pub input_delta: String, + /// Tool call ID this delta belongs to, matching the corresponding assistant.message tool request + pub tool_call_id: String, + /// Name of the tool being invoked, when known from the stream + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_name: Option, + /// Tool call type, when known from the stream + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_type: Option, +} + /// Session event "assistant.streaming_delta". Streaming response progress with cumulative byte count #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1186,6 +1689,114 @@ pub struct AssistantStreamingDeltaData { pub total_response_size_bytes: i64, } +/// A source that backs one or more cited spans in the assistant's response. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CitationSource { + /// Stable, turn-scoped identifier for this source, referenced by CitationReference.sourceId. + pub id: String, + /// File path relative to the agent's workspace root, when the source is a file. + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// The system that produced this citation. + pub provider: CitationProvider, + /// Human-readable title of the source. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL of the source, when it is a web resource. + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +/// A single citation occurrence linking a span of generated text to a supporting source. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CitationReference { + /// The exact text from the source that supports the cited span, when provided by the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub cited_text: Option, + /// Location within the source that supports the cited span, when the provider reports one. + #[serde(skip_serializing_if = "Option::is_none")] + pub location: Option, + /// Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub provider_metadata: Option, + /// Identifier of the CitationSource this reference points to (CitationSource.id). + pub source_id: String, +} + +/// A contiguous span of generated assistant text and the source references that support it. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CitationSpan { + /// End offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, exclusive). + pub end_index: i64, + /// The sources that support this span of generated text. + pub references: Vec, + /// Start offset of the cited span within the final assistant message content (UTF-16 code units, zero-based, inclusive). + pub start_index: i64, +} + +/// Provider-agnostic citations linking spans of the assistant's response to their supporting sources. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Citations { + /// Deduplicated set of sources referenced by the citation spans. + pub sources: Vec, + /// Spans of generated text annotated with the sources that support them. + pub spans: Vec, +} + +/// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantMessageServerTools { + #[serde(skip_serializing_if = "Option::is_none")] + pub advisor_model: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub function_call_namespaces: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub items: Option>, + pub provider: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub raw_content_blocks: Option>, +} + /// A tool invocation request from the assistant #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1218,17 +1829,16 @@ pub struct AssistantMessageToolRequest { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AssistantMessageData { - /// Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping - /// - ///
    - /// - /// **Experimental.** This type is part of an experimental wire-protocol surface - /// and may change or be removed in future SDK or CLI releases. - /// - ///
    + /// Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances. + #[serde(skip_serializing_if = "Option::is_none")] + pub api_call_id: Option, + /// Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1. #[serde(skip_serializing_if = "Option::is_none")] - pub anthropic_advisor_blocks: Option>, - /// Anthropic advisor model ID used for this response, for timeline display on replay + pub chunk_count: Option, + /// Zero-based position of this message within its model call's response. Absent when the response was not split into chunks. + #[serde(skip_serializing_if = "Option::is_none")] + pub chunk_index: Option, + /// Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled. /// ///
    /// @@ -1237,7 +1847,10 @@ pub struct AssistantMessageData { /// ///
    #[serde(skip_serializing_if = "Option::is_none")] - pub anthropic_advisor_model: Option, + pub citations: Option, + /// Client-minted request id (x-request-id header) echoed by the server. Distinct from requestId (x-github-request-id) and serviceRequestId (x-copilot-service-request-id). + #[serde(skip_serializing_if = "Option::is_none")] + pub client_request_id: Option, /// The assistant's text response content pub content: String, /// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume. @@ -1268,9 +1881,17 @@ pub struct AssistantMessageData { /// Readable reasoning text from the model's extended thinking #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_text: Option, + /// OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns. + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_wire_field: Option, /// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs #[serde(skip_serializing_if = "Option::is_none")] pub request_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, + /// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping + #[serde(skip_serializing_if = "Option::is_none")] + pub server_tools: Option, /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation #[serde(skip_serializing_if = "Option::is_none")] pub service_request_id: Option, @@ -1312,10 +1933,22 @@ pub struct AssistantMessageDeltaData { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AssistantTurnEndData { + /// Model identifier used for this turn, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Identifier of the turn that has ended, matching the corresponding assistant.turn_start event pub turn_id: String, } +/// Session event "assistant.idle". Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AssistantIdleData { + /// True when the preceding agentic loop was cancelled via abort signal + #[serde(skip_serializing_if = "Option::is_none")] + pub aborted: Option, +} + /// Token usage detail for a single billing category #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1333,20 +1966,26 @@ pub struct AssistantUsageCopilotUsageTokenDetail { /// Per-request cost and usage data from the CAPI copilot_usage response field #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub(crate) struct AssistantUsageCopilotUsage { +pub struct AssistantUsageCopilotUsage { /// Itemized token usage breakdown - pub token_details: Vec, + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) token_details: Option>, /// Total cost in nano-AI units for this request pub total_nano_aiu: f64, } -/// Schema for the `AssistantUsageQuotaSnapshot` type. +/// Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub(crate) struct AssistantUsageQuotaSnapshot { /// Total requests allowed by the entitlement #[doc(hidden)] pub(crate) entitlement_requests: i64, + /// Whether the user currently has quota available for use + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) has_quota: Option, /// Whether the user has an unlimited usage entitlement #[doc(hidden)] pub(crate) is_unlimited_entitlement: bool, @@ -1356,6 +1995,10 @@ pub(crate) struct AssistantUsageQuotaSnapshot { /// Whether additional usage is allowed when quota is exhausted #[doc(hidden)] pub(crate) overage_allowed_with_exhausted_quota: bool, + /// Pay-as-you-go additional-usage budget cap in AI credits (1 credit = $0.01); present only when CAPI emits a finite value + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) overage_entitlement: Option, /// Percentage of quota remaining (0 to 100) #[doc(hidden)] pub(crate) remaining_percentage: f64, @@ -1363,6 +2006,10 @@ pub(crate) struct AssistantUsageQuotaSnapshot { #[doc(hidden)] #[serde(skip_serializing_if = "Option::is_none")] pub(crate) reset_date: Option, + /// Whether this snapshot uses token-based billing (AI-credits allocation) + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) token_based_billing: Option, /// Whether usage is still permitted after quota exhaustion #[doc(hidden)] pub(crate) usage_allowed_with_exhausted_quota: bool, @@ -1381,16 +2028,25 @@ pub struct AssistantUsageData { /// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary #[serde(skip_serializing_if = "Option::is_none")] pub api_endpoint: Option, + /// Number of tools available to the model for this call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) available_tool_count: Option, + /// Updated prompt-cache expiration for this model call. Present only when the call establishes or refreshes known cache state. + #[serde(skip_serializing_if = "Option::is_none")] + pub cache_expires_at: Option, /// Number of tokens read from prompt cache #[serde(skip_serializing_if = "Option::is_none")] pub cache_read_tokens: Option, /// Number of tokens written to prompt cache #[serde(skip_serializing_if = "Option::is_none")] pub cache_write_tokens: Option, + /// Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason. + #[serde(skip_serializing_if = "Option::is_none")] + pub content_filter_triggered: Option, /// Per-request cost and usage data from the CAPI copilot_usage response field - #[doc(hidden)] #[serde(skip_serializing_if = "Option::is_none")] - pub(crate) copilot_usage: Option, + pub copilot_usage: Option, /// Model multiplier cost for billing purposes /// ///
    @@ -1404,17 +2060,27 @@ pub struct AssistantUsageData { /// Duration of the API call in milliseconds #[serde(skip_serializing_if = "Option::is_none")] pub duration: Option, + /// Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter". + #[serde(skip_serializing_if = "Option::is_none")] + pub finish_reason: Option, /// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls #[serde(skip_serializing_if = "Option::is_none")] pub initiator: Option, /// Number of input tokens consumed #[serde(skip_serializing_if = "Option::is_none")] pub input_tokens: Option, + /// Coarse classification of the interaction that produced this call, mirroring the session's per-request agent context (e.g. `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, `conversation-user`). Non-billing; lets consumers attribute a model call to a call class (e.g. sub-agent/sidekick) independently of the billing initiator. Absent when the runtime did not classify the request. + #[serde(skip_serializing_if = "Option::is_none")] + pub interaction_type: Option, /// Average inter-token latency in milliseconds. Only available for streaming requests #[serde(skip_serializing_if = "Option::is_none")] pub inter_token_latency_ms: Option, /// Model identifier used for this API call pub model: String, + /// Number of tool calls returned by the model + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) num_tool_calls: Option, /// Number of output tokens produced #[serde(skip_serializing_if = "Option::is_none")] pub output_tokens: Option, @@ -1436,12 +2102,43 @@ pub struct AssistantUsageData { /// Number of output tokens used for reasoning (e.g., chain-of-thought) #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_tokens: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation #[serde(skip_serializing_if = "Option::is_none")] pub service_request_id: Option, /// Time to first token in milliseconds. Only available for streaming requests #[serde(skip_serializing_if = "Option::is_none")] - pub time_to_first_token_ms: Option, + pub time_to_first_token_ms: Option, + /// Tool-call counts keyed by tool name + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tool_counts: Option>, + /// Number of tokens used by tool definitions for this call + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) tool_token_count: Option, +} + +/// Content-free structural summary of the failing request for diagnosing malformed 4xx calls +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ModelCallFailureRequestFingerprint { + /// Total number of image content parts + pub image_part_count: i64, + /// Image parts whose media type cannot be determined (rejected by strict providers) + pub image_parts_missing_media_type: i64, + /// Role of the final message in the request + #[serde(skip_serializing_if = "Option::is_none")] + pub last_message_role: Option, + /// Total number of messages in the request + pub message_count: i64, + /// Tool calls whose name is missing or empty (rejected by strict providers) + pub nameless_tool_call_count: i64, + /// Total number of tool calls across assistant messages + pub tool_call_count: i64, + /// Number of "tool" result messages in the request + pub tool_result_message_count: i64, } /// Session event "model.call_failure". Failed LLM API call metadata for telemetry @@ -1451,21 +2148,60 @@ pub struct ModelCallFailureData { /// Completion ID from the model provider (e.g., chatcmpl-abc123) #[serde(skip_serializing_if = "Option::is_none")] pub api_call_id: Option, + /// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary + #[serde(skip_serializing_if = "Option::is_none")] + pub api_endpoint: Option, + /// For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. + #[serde(skip_serializing_if = "Option::is_none")] + pub bad_request_kind: Option, /// Duration of the failed API call in milliseconds #[serde(skip_serializing_if = "Option::is_none")] pub duration_ms: Option, + /// For HTTP 400 failures only: the `code` from the CAPI error envelope (e.g. 'model_max_prompt_tokens_exceeded') identifying which deterministic validation failure occurred. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_code: Option, /// Raw provider/runtime error message for restricted telemetry #[serde(skip_serializing_if = "Option::is_none")] pub error_message: Option, + /// For HTTP 400 failures only: the `type` from the CAPI error envelope (e.g. 'websocket_error'), a coarser companion to errorCode for envelopes that carry no code. Raw server-controlled string, emitted only through restricted telemetry. Absent for bodyless or non-400 failures. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_type: Option, + /// Whether the failure originated from an API response or the request transport + #[serde(skip_serializing_if = "Option::is_none")] + pub failure_kind: Option, /// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls #[serde(skip_serializing_if = "Option::is_none")] pub initiator: Option, + /// Whether the session selected Auto mode for the failed call + #[serde(skip_serializing_if = "Option::is_none")] + pub is_auto: Option, + /// Whether the failed call used a bring-your-own-key provider + #[serde(skip_serializing_if = "Option::is_none")] + pub is_byok: Option, + /// Effective maximum output-token limit for the failed call + #[serde(skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Effective maximum prompt-token limit for the failed call + #[serde(skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, /// Model identifier used for the failed API call #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, /// GitHub request tracing ID (x-github-request-id header) for server-side log correlation #[serde(skip_serializing_if = "Option::is_none")] pub provider_call_id: Option, + /// Per-quota usage snapshots parsed from the failed response's quota headers, keyed by quota identifier. Present when the error response carried quota headers (e.g. a 402 once the additional spend limit is reached) so the UI can refresh the quota display on failure. + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) quota_snapshots: Option>, + /// Reasoning effort level used for the failed model call, if applicable + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, + /// Content-free structural summary of the failing request. Contains only counts and shape flags (no prompt content), so it is safe for unrestricted telemetry. Populated only for client-error (4xx) failures. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_fingerprint: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, /// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation #[serde(skip_serializing_if = "Option::is_none")] pub service_request_id: Option, @@ -1474,6 +2210,24 @@ pub struct ModelCallFailureData { /// HTTP status code from the failed request #[serde(skip_serializing_if = "Option::is_none")] pub status_code: Option, + /// Transport used for the failed model call (http or websocket) + #[serde(skip_serializing_if = "Option::is_none")] + pub transport: Option, +} + +/// Session event "model.call_start". Model API dispatch metadata for internal telemetry +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ModelCallStartData { + /// Model identifier used for this API call, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Previous response or interaction identifier included in the model request, when present + #[doc(hidden)] + #[serde(skip_serializing_if = "Option::is_none")] + pub(crate) previous_response_id: Option, + /// Identifier of the assistant turn that initiated the model call + pub turn_id: String, } /// Session event "abort". Turn abort information including the reason for termination @@ -1497,6 +2251,61 @@ pub struct ToolUserRequestedData { pub tool_name: String, } +/// Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionStartShellToolInfo { + /// The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub display_command: Option, + /// Whether the command includes a file write redirection (e.g., > or >>). + pub has_write_file_redirection: bool, + /// File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. + pub possible_paths: Vec, +} + +/// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionStartToolDescriptionMetaUI { + /// URI of the UI resource + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_uri: Option, + /// Who can access this tool + #[serde(skip_serializing_if = "Option::is_none")] + pub visibility: Option>, +} + +/// MCP Apps metadata for UI resource association +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionStartToolDescriptionMeta { + /// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`. + #[serde(skip_serializing_if = "Option::is_none")] + pub ui: Option, +} + +/// Tool definition metadata, present for MCP tools with MCP Apps support +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionStartToolDescription { + /// MCP Apps metadata for UI resource association + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Tool description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Tool name + pub name: String, +} + /// Session event "tool.execution_start". Tool execution startup details including MCP server information when applicable #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1513,13 +2322,24 @@ pub struct ToolExecutionStartData { /// Original tool name on the MCP server, when the tool is an MCP tool #[serde(skip_serializing_if = "Option::is_none")] pub mcp_tool_name: Option, + /// Model identifier that generated this tool call + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Tool call ID of the parent tool invocation when this event originates from a sub-agent #[doc(hidden)] #[deprecated] #[serde(skip_serializing_if = "Option::is_none")] pub parent_tool_call_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, + /// Shell-tool path hints derived from the command at start time for shell tools (bash/powershell/local_shell). Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires. Absent for non-shell tools. + #[serde(skip_serializing_if = "Option::is_none")] + pub shell_tool_info: Option, /// Unique identifier for this tool call pub tool_call_id: String, + /// Tool definition metadata, present for MCP tools with MCP Apps support + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_description: Option, /// Name of the tool being executed pub tool_name: String, /// Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event @@ -1558,6 +2378,32 @@ pub struct ToolExecutionCompleteError { pub message: String, } +/// A source supplied by a tool that should be made available to the model as citable content. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct CitableSource { + /// The source text made available to the model as citable content. + pub content: String, + /// Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source. + pub id: String, + /// File path relative to the agent's workspace root, when the source is a file. + #[serde(skip_serializing_if = "Option::is_none")] + pub path: Option, + /// Human-readable title of the source. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// URL of the source, when it is a web resource. + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + /// Plain text content block #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1568,7 +2414,9 @@ pub struct ToolExecutionCompleteContentText { pub r#type: ToolExecutionCompleteContentTextType, } -/// Terminal/shell output content block with optional exit code and working directory +/// Deprecated for shell command exit metadata. Use ToolExecutionCompleteContentShellExit instead. +#[doc(hidden)] +#[deprecated] #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteContentTerminal { @@ -1584,6 +2432,27 @@ pub struct ToolExecutionCompleteContentTerminal { pub r#type: ToolExecutionCompleteContentTerminalType, } +/// Shell command exit metadata with optional output preview +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolExecutionCompleteContentShellExit { + /// Working directory where the shell command was executed + #[serde(skip_serializing_if = "Option::is_none")] + pub cwd: Option, + /// Exit code from the completed shell command + pub exit_code: i64, + /// Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output. + #[serde(skip_serializing_if = "Option::is_none")] + pub output_preview: Option, + /// Whether outputPreview is known to be incomplete or truncated + #[serde(skip_serializing_if = "Option::is_none")] + pub output_truncated: Option, + /// Shell id, as assigned by Copilot runtime + pub shell_id: String, + /// Content block type discriminator + pub r#type: ToolExecutionCompleteContentShellExitType, +} + /// Image content block with base64-encoded data #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1652,7 +2521,7 @@ pub struct ToolExecutionCompleteContentResourceLink { pub uri: String, } -/// Schema for the `EmbeddedTextResourceContents` type. +/// Embedded text resource contents identified by a URI, with an optional MIME type and a text payload. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct EmbeddedTextResourceContents { @@ -1665,7 +2534,7 @@ pub struct EmbeddedTextResourceContents { pub uri: String, } -/// Schema for the `EmbeddedBlobResourceContents` type. +/// Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct EmbeddedBlobResourceContents { @@ -1688,7 +2557,7 @@ pub struct ToolExecutionCompleteContentResource { pub r#type: ToolExecutionCompleteContentResourceType, } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. +/// CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUICsp { @@ -1702,54 +2571,54 @@ pub struct ToolExecutionCompleteUIResourceMetaUICsp { pub resource_domains: Option>, } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. +/// Marker object for camera permission on an MCP Apps UI resource. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUIPermissionsCamera {} -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. +/// Marker object for clipboard-write permission on an MCP Apps UI resource. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite {} -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. +/// Marker object for geolocation permission on an MCP Apps UI resource. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation {} -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. +/// Marker object for microphone permission on an MCP Apps UI resource. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone {} -/// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. +/// Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUIPermissions { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type. + /// Marker object for camera permission on an MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub camera: Option, - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type. + /// Marker object for clipboard-write permission on an MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub clipboard_write: Option, - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type. + /// Marker object for geolocation permission on an MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub geolocation: Option, - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type. + /// Marker object for microphone permission on an MCP Apps UI resource. #[serde(skip_serializing_if = "Option::is_none")] pub microphone: Option, } -/// Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. +/// MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMetaUI { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type. + /// CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains. #[serde(skip_serializing_if = "Option::is_none")] pub csp: Option, #[serde(skip_serializing_if = "Option::is_none")] pub domain: Option, - /// Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type. + /// Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write. #[serde(skip_serializing_if = "Option::is_none")] pub permissions: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -1760,7 +2629,7 @@ pub struct ToolExecutionCompleteUIResourceMetaUI { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteUIResourceMeta { - /// Schema for the `ToolExecutionCompleteUIResourceMetaUI` type. + /// MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference. #[serde(skip_serializing_if = "Option::is_none")] pub ui: Option, } @@ -1788,6 +2657,26 @@ pub struct ToolExecutionCompleteUIResource { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteResult { + /// Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub binary_results_for_llm: Option>, + /// Provider-neutral source material this tool makes available to the model as citable content. Persisted so it survives session resume. Experimental. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub citable_sources: Option>, /// Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency pub content: String, /// Structured content blocks (text, images, audio, resources) returned by the tool in their native format @@ -1796,12 +2685,25 @@ pub struct ToolExecutionCompleteResult { /// Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent. #[serde(skip_serializing_if = "Option::is_none")] pub detailed_content: Option, + /// FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels) — persisted as `{ ifc: ... }` (only the `ifc` key, not the whole `_meta`). Persisted so the FIDES IFC label survives session resume: the engine rehydrates accumulated taint by replaying these on load. Populated for ingress sources when FIDES IFC is on. Experimental. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp_meta: Option, + /// Structured content (arbitrary JSON) returned verbatim by the MCP tool + #[serde(skip_serializing_if = "Option::is_none")] + pub structured_content: Option, /// MCP Apps UI resource content for rendering in a sandboxed iframe #[serde(skip_serializing_if = "Option::is_none")] pub ui_resource: Option, } -/// Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. +/// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteToolDescriptionMetaUI { @@ -1817,7 +2719,7 @@ pub struct ToolExecutionCompleteToolDescriptionMetaUI { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ToolExecutionCompleteToolDescriptionMeta { - /// Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type. + /// MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`. #[serde(skip_serializing_if = "Option::is_none")] pub ui: Option, } @@ -1849,6 +2751,16 @@ pub struct ToolExecutionCompleteData { /// Whether this tool call was explicitly requested by the user rather than the assistant #[serde(skip_serializing_if = "Option::is_none")] pub is_user_requested: Option, + /// FIDES IFC label projected from tool ingress metadata (MCP `CallToolResult._meta` or synthesized built-in ingress labels). Persisted as `{ ifc: ... }` so the label survives session resume, including model-visible failure results. Experimental. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub mcp_meta: Option, /// Model identifier that generated this tool call #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, @@ -1860,6 +2772,8 @@ pub struct ToolExecutionCompleteData { /// Tool execution result on success #[serde(skip_serializing_if = "Option::is_none")] pub result: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub rte: Option, /// Whether this tool execution ran inside a sandbox container #[serde(skip_serializing_if = "Option::is_none")] pub sandboxed: Option, @@ -1878,6 +2792,16 @@ pub struct ToolExecutionCompleteData { pub turn_id: Option, } +/// Session event "tool_search.activated". Persisted generic client-side tool activations restored when a session resumes. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ToolSearchActivatedData { + /// Tool-search strategy that activated the definitions. + pub strategy: String, + /// Names of tool definitions activated by this search invocation. + pub tool_names: Vec, +} + /// Session event "skill.invoked". Skill invocation details including content, allowed tools, and plugin metadata #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -1890,6 +2814,9 @@ pub struct SkillInvokedData { /// Description of the skill from its SKILL.md frontmatter #[serde(skip_serializing_if = "Option::is_none")] pub description: Option, + /// Model identifier active when the skill was invoked, when known + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, /// Name of the invoked skill pub name: String, /// File path to the SKILL.md definition @@ -1900,7 +2827,7 @@ pub struct SkillInvokedData { /// Version of the plugin this skill originated from, when applicable #[serde(skip_serializing_if = "Option::is_none")] pub plugin_version: Option, - /// Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) + /// Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill) #[serde(skip_serializing_if = "Option::is_none")] pub source: Option, /// What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent) @@ -1918,7 +2845,7 @@ pub struct SubagentStartedData { pub agent_display_name: String, /// Internal name of the sub-agent pub agent_name: String, - /// Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck). + /// Model the sub-agent will run with, when known at start. #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, /// Tool call ID of the parent tool invocation that spawned this sub-agent @@ -1933,6 +2860,9 @@ pub struct SubagentCompletedData { pub agent_display_name: String, /// Internal name of the sub-agent pub agent_name: String, + /// Whether the sub-agent was torn down by cancellation - its own abort, or an ancestor being killed - instead of finishing its work. Cancellation is not a failure, so the run still reports completion; this distinguishes a torn-down sub-agent from one that ran to the end. + #[serde(skip_serializing_if = "Option::is_none")] + pub cancelled: Option, /// Wall-clock duration of the sub-agent execution in milliseconds #[serde(skip_serializing_if = "Option::is_none")] pub duration_ms: Option, @@ -1962,7 +2892,7 @@ pub struct SubagentFailedData { pub duration_ms: Option, /// Error message describing why the sub-agent failed pub error: String, - /// Model used by the sub-agent (if any model calls succeeded before failure) + /// Model selected for the sub-agent, when known #[serde(skip_serializing_if = "Option::is_none")] pub model: Option, /// Tool call ID of the parent tool invocation that spawned this sub-agent @@ -2011,6 +2941,9 @@ pub struct HookStartData { pub struct HookEndError { /// Human-readable error message pub message: String, + /// Source label of the hook that errored (e.g. the plugin it was loaded from), when known + #[serde(skip_serializing_if = "Option::is_none")] + pub source: Option, /// Error stack trace, when available #[serde(skip_serializing_if = "Option::is_none")] pub stack: Option, @@ -2040,6 +2973,31 @@ pub struct HookEndData { pub struct HookProgressData { /// Human-readable progress message from the hook process pub message: String, + /// When true, this status message replaces the previous temporary one instead of accumulating + #[serde(skip_serializing_if = "Option::is_none")] + pub temporary: Option, +} + +/// Session event "session.binary_asset". Canonical bytes for a content-addressed binary asset shared by reference across events +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionBinaryAssetData { + /// Content-addressed id for this binary asset (e.g. "sha256:..."). + pub asset_id: String, + /// Decoded byte length of the binary asset + pub byte_length: i64, + /// Base64-encoded binary data + pub data: String, + /// Human-readable description of the binary data + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Optional metadata from the producing tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option>, + /// MIME type of the binary asset + pub mime_type: String, + /// Binary asset type discriminator. Use "image" for images and "resource" otherwise. + pub r#type: BinaryAssetType, } /// Metadata about the prompt template and its construction @@ -2060,6 +3018,9 @@ pub struct SystemMessageMetadata { pub struct SystemMessageData { /// The system or developer prompt text sent as model input pub content: String, + /// Logical interaction identifier for the model run receiving this prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub interaction_id: Option, /// Metadata about the prompt template and its construction #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option, @@ -2080,7 +3041,7 @@ pub struct SystemNotificationData { pub kind: serde_json::Value, } -/// Schema for the `PermissionRequestShellCommand` type. +/// A parsed command identifier in a shell permission request, including whether it is read-only. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionRequestShellCommand { @@ -2090,7 +3051,17 @@ pub struct PermissionRequestShellCommand { pub read_only: bool, } -/// Schema for the `PermissionRequestShellPossibleUrl` type. +/// A parsed shell command segment used for argument-aware managed policy matching. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionRequestShellCommandSegment { + /// Full text of this command segment, including arguments + pub full_command_text: String, + /// Command identifier (e.g., executable name) + pub identifier: String, +} + +/// A URL that may be accessed by a command in a shell permission request. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionRequestShellPossibleUrl { @@ -2106,6 +3077,9 @@ pub struct PermissionRequestShell { pub can_offer_session_approval: bool, /// Parsed command identifiers found in the command text pub commands: Vec, + /// Parsed command segments, including arguments, used for managed policy matching + #[serde(skip_serializing_if = "Option::is_none")] + pub command_segments: Option>, /// The complete shell command text to be executed pub full_command_text: String, /// Whether the command includes a file write redirection (e.g., > or >>) @@ -2114,10 +3088,19 @@ pub struct PermissionRequestShell { pub intention: String, /// Permission kind discriminator pub kind: PermissionRequestShellKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// File paths that may be read or written by the command pub possible_paths: Vec, /// URLs that may be accessed by the command pub possible_urls: Vec, + /// True when the model has requested to run this command outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass: Option, + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass_reason: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2140,9 +3123,18 @@ pub struct PermissionRequestWrite { pub intention: String, /// Permission kind discriminator pub kind: PermissionRequestWriteKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Complete new file contents for newly created files #[serde(skip_serializing_if = "Option::is_none")] pub new_file_contents: Option, + /// True when a built-in file tool (apply_patch / str_replace_editor) asked to write a path the sandbox filesystem policy would block, and the host opted in via sandbox.allowBypass. This is a request, not a grant: the write happens unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass: Option, + /// Justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass_reason: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2156,8 +3148,17 @@ pub struct PermissionRequestRead { pub intention: String, /// Permission kind discriminator pub kind: PermissionRequestReadKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Path of the file or directory being read pub path: String, + /// True when the model has requested to run this search outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass: Option, + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass_reason: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2172,6 +3173,9 @@ pub struct PermissionRequestMcp { pub args: Option, /// Permission kind discriminator pub kind: PermissionRequestMcpKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Whether this MCP tool is read-only (no side effects) pub read_only: bool, /// Name of the MCP server providing the tool @@ -2193,6 +3197,18 @@ pub struct PermissionRequestUrl { pub intention: String, /// Permission kind discriminator pub kind: PermissionRequestUrlKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, + /// Immediately preceding URL when this request is for a redirect target + #[serde(skip_serializing_if = "Option::is_none")] + pub redirected_from: Option, + /// True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass: Option, + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass_reason: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2217,6 +3233,9 @@ pub struct PermissionRequestMemory { pub fact: String, /// Permission kind discriminator pub kind: PermissionRequestMemoryKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Reason for the vote (vote only) #[serde(skip_serializing_if = "Option::is_none")] pub reason: Option, @@ -2237,6 +3256,9 @@ pub struct PermissionRequestCustomTool { pub args: Option, /// Permission kind discriminator pub kind: PermissionRequestCustomToolKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2255,6 +3277,9 @@ pub struct PermissionRequestHook { pub hook_message: Option, /// Permission kind discriminator pub kind: PermissionRequestHookKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Arguments of the tool call being gated #[serde(skip_serializing_if = "Option::is_none")] pub tool_args: Option, @@ -2274,6 +3299,9 @@ pub struct PermissionRequestExtensionManagement { pub extension_name: Option, /// Permission kind discriminator pub kind: PermissionRequestExtensionManagementKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// The extension management operation (scaffold, reload) pub operation: String, /// Tool call ID that triggered this permission request @@ -2281,6 +3309,63 @@ pub struct PermissionRequestExtensionManagement { pub tool_call_id: Option, } +/// A declared phase shown in a factory permission prompt. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FactoryPermissionPhase { + /// Optional phase detail + #[serde(skip_serializing_if = "Option::is_none")] + pub detail: Option, + /// Phase title + pub title: String, +} + +/// Factory run or authoring permission request +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionRequestFactory { + /// Canonical key used for scoped factory approvals + pub approval_key: String, + /// Whether this factory is eligible for persistent approval + pub can_persist_approval: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_ai_credits: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_concurrent_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_total_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_timeout_seconds: Option, + /// Factory description + pub description: String, + /// Permission kind discriminator + pub kind: PermissionRequestFactoryKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, + /// Effective AI-credit limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, + /// Effective concurrent-subagent limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrent_subagents: Option, + /// Effective total-subagent limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_total_subagents: Option, + /// Factory name + pub name: String, + /// Factory operation, either run or author + pub operation: FactoryPermissionOperation, + /// Declared factory phases + pub phases: Vec, + /// Effective active-time limit in seconds; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_seconds: Option, + /// Tool call ID that triggered this permission request + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, +} + /// Extension permission access request #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -2291,15 +3376,52 @@ pub struct PermissionRequestExtensionPermissionAccess { pub extension_name: String, /// Permission kind discriminator pub kind: PermissionRequestExtensionPermissionAccessKind, + /// When true, managed policy requires an explicit user decision and automatic approval must be bypassed. + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, } +/// Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is "auto"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionAutoApproval { + /// Classified cause of an `error` recommendation. Absent for every other recommendation. + #[serde(skip_serializing_if = "Option::is_none")] + pub failure_reason: Option, + /// Model id that produced the recommendation, when the judge was consulted and reported one. Absent for `excluded` (the judge was not consulted) and for failures that occurred before a model was selected. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + /// Human-readable reason for the judge's recommendation, when available. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + /// The auto-approval safety judge's outcome for this request. + pub recommendation: AutoApprovalRecommendation, +} + /// Shell command permission prompt #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestCommands { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Whether the UI can offer session-wide approval for this command pattern pub can_offer_session_approval: bool, /// Command identifiers covered by this approval prompt @@ -2310,6 +3432,9 @@ pub struct PermissionPromptRequestCommands { pub intention: String, /// Prompt kind discriminator pub kind: PermissionPromptRequestCommandsKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2322,6 +3447,16 @@ pub struct PermissionPromptRequestCommands { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestWrite { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Whether the UI can offer session-wide approval for file write operations pub can_offer_session_approval: bool, /// Unified diff showing the proposed changes @@ -2332,6 +3467,9 @@ pub struct PermissionPromptRequestWrite { pub intention: String, /// Prompt kind discriminator pub kind: PermissionPromptRequestWriteKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Complete new file contents for newly created files #[serde(skip_serializing_if = "Option::is_none")] pub new_file_contents: Option, @@ -2344,10 +3482,23 @@ pub struct PermissionPromptRequestWrite { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestRead { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Human-readable description of why the file is being read pub intention: String, /// Prompt kind discriminator pub kind: PermissionPromptRequestReadKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, /// Path of the file or directory being read pub path: String, /// Tool call ID that triggered this permission request @@ -2362,6 +3513,16 @@ pub struct PermissionPromptRequestMcp { /// Arguments to pass to the MCP tool #[serde(skip_serializing_if = "Option::is_none")] pub args: Option, + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestMcpKind, /// Name of the MCP server providing the tool @@ -2379,10 +3540,32 @@ pub struct PermissionPromptRequestMcp { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestUrl { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Human-readable description of why the URL is being accessed pub intention: String, /// Prompt kind discriminator pub kind: PermissionPromptRequestUrlKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, + /// Immediately preceding URL when this prompt is for a redirect target + #[serde(skip_serializing_if = "Option::is_none")] + pub redirected_from: Option, + /// True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass: Option, + /// Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_sandbox_bypass_reason: Option, /// Tool call ID that triggered this permission request #[serde(skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, @@ -2397,6 +3580,16 @@ pub struct PermissionPromptRequestMemory { /// Whether this is a store or vote memory operation #[serde(skip_serializing_if = "Option::is_none")] pub action: Option, + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Source references for the stored fact (store only) #[serde(skip_serializing_if = "Option::is_none")] pub citations: Option, @@ -2424,7 +3617,17 @@ pub struct PermissionPromptRequestMemory { pub struct PermissionPromptRequestCustomTool { /// Arguments to pass to the custom tool #[serde(skip_serializing_if = "Option::is_none")] - pub args: Option, + pub args: Option, + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestCustomToolKind, /// Tool call ID that triggered this permission request @@ -2442,6 +3645,16 @@ pub struct PermissionPromptRequestCustomTool { pub struct PermissionPromptRequestPath { /// Underlying permission kind that needs path approval pub access_kind: PermissionPromptRequestPathAccessKind, + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Prompt kind discriminator pub kind: PermissionPromptRequestPathKind, /// File paths that require explicit approval @@ -2455,6 +3668,16 @@ pub struct PermissionPromptRequestPath { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestHook { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Optional message from the hook explaining why confirmation is needed #[serde(skip_serializing_if = "Option::is_none")] pub hook_message: Option, @@ -2474,6 +3697,16 @@ pub struct PermissionPromptRequestHook { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestExtensionManagement { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Name of the extension being managed #[serde(skip_serializing_if = "Option::is_none")] pub extension_name: Option, @@ -2486,10 +3719,76 @@ pub struct PermissionPromptRequestExtensionManagement { pub tool_call_id: Option, } +/// Factory run or authoring permission prompt +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PermissionPromptRequestFactory { + /// Canonical key used for scoped factory approvals + pub approval_key: String, + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, + /// Whether this factory is eligible for persistent approval + pub can_persist_approval: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_ai_credits: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_concurrent_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_max_total_subagents: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub declared_timeout_seconds: Option, + /// Factory description + pub description: String, + /// Prompt kind discriminator + pub kind: PermissionPromptRequestFactoryKind, + /// Whether managed policy requires a human response and forbids host auto-approval + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, + /// Effective AI-credit limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, + /// Effective concurrent-subagent limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_concurrent_subagents: Option, + /// Effective total-subagent limit; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub max_total_subagents: Option, + /// Factory name + pub name: String, + /// Factory operation, either run or author + pub operation: FactoryPermissionOperation, + /// Declared factory phases + pub phases: Vec, + /// Effective active-time limit in seconds; omitted means unlimited + #[serde(skip_serializing_if = "Option::is_none")] + pub timeout_seconds: Option, + /// Tool call ID that triggered this permission request + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_call_id: Option, +} + /// Extension permission access prompt #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionPromptRequestExtensionPermissionAccess { + /// Auto-approval judge information for this request; present only when auto mode is enabled. + /// + ///
    + /// + /// **Experimental.** This type is part of an experimental wire-protocol surface + /// and may change or be removed in future SDK or CLI releases. + /// + ///
    + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_approval: Option, /// Capabilities the extension is requesting pub capabilities: Vec, /// Name of the extension requesting permission access @@ -2515,9 +3814,12 @@ pub struct PermissionRequestedData { /// When true, this permission was already resolved by a permissionRequest hook and requires no client action #[serde(skip_serializing_if = "Option::is_none")] pub resolved_by_hook: Option, + /// Neutral risk metadata supplied by the tool host. Consumers may display this value but must not use it to bypass the permission decision. + #[serde(skip_serializing_if = "Option::is_none")] + pub risk_assessment: Option, } -/// Schema for the `PermissionApproved` type. +/// Permission response variant indicating the request was approved without persisting an approval rule. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionApproved { @@ -2525,7 +3827,7 @@ pub struct PermissionApproved { pub kind: PermissionApprovedKind, } -/// Schema for the `UserToolSessionApprovalCommands` type. +/// Session-scoped tool-approval rule for specific shell command identifiers. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalCommands { @@ -2535,7 +3837,7 @@ pub struct UserToolSessionApprovalCommands { pub kind: UserToolSessionApprovalCommandsKind, } -/// Schema for the `UserToolSessionApprovalRead` type. +/// Session-scoped tool-approval rule for read-only filesystem operations. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalRead { @@ -2543,7 +3845,7 @@ pub struct UserToolSessionApprovalRead { pub kind: UserToolSessionApprovalReadKind, } -/// Schema for the `UserToolSessionApprovalWrite` type. +/// Session-scoped tool-approval rule for filesystem write operations. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalWrite { @@ -2551,7 +3853,7 @@ pub struct UserToolSessionApprovalWrite { pub kind: UserToolSessionApprovalWriteKind, } -/// Schema for the `UserToolSessionApprovalMcp` type. +/// Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalMcp { @@ -2563,7 +3865,7 @@ pub struct UserToolSessionApprovalMcp { pub tool_name: Option, } -/// Schema for the `UserToolSessionApprovalMemory` type. +/// Session-scoped tool-approval rule for writes to long-term memory. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalMemory { @@ -2571,7 +3873,7 @@ pub struct UserToolSessionApprovalMemory { pub kind: UserToolSessionApprovalMemoryKind, } -/// Schema for the `UserToolSessionApprovalCustomTool` type. +/// Session-scoped tool-approval rule for a custom tool, keyed by tool name. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalCustomTool { @@ -2581,7 +3883,7 @@ pub struct UserToolSessionApprovalCustomTool { pub tool_name: String, } -/// Schema for the `UserToolSessionApprovalExtensionManagement` type. +/// Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalExtensionManagement { @@ -2592,7 +3894,18 @@ pub struct UserToolSessionApprovalExtensionManagement { pub operation: Option, } -/// Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type. +/// Session-scoped factory approval, optionally narrowed by approval key. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserToolSessionApprovalFactory { + /// Optional factory operation name or canonical approval key + #[serde(skip_serializing_if = "Option::is_none")] + pub approval_key: Option, + /// Factory approval kind + pub kind: UserToolSessionApprovalFactoryKind, +} + +/// Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct UserToolSessionApprovalExtensionPermissionAccess { @@ -2602,7 +3915,7 @@ pub struct UserToolSessionApprovalExtensionPermissionAccess { pub kind: UserToolSessionApprovalExtensionPermissionAccessKind, } -/// Schema for the `PermissionApprovedForSession` type. +/// Permission response variant that approves a request and remembers the provided approval for the rest of the session. #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionApprovedForSession { @@ -2612,7 +3925,7 @@ pub struct PermissionApprovedForSession { pub kind: PermissionApprovedForSessionKind, } -/// Schema for the `PermissionApprovedForLocation` type. +/// Permission response variant that approves a request and persists the provided approval to a project location key. #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionApprovedForLocation { @@ -2624,7 +3937,7 @@ pub struct PermissionApprovedForLocation { pub location_key: String, } -/// Schema for the `PermissionCancelled` type. +/// Permission response variant indicating the request was cancelled before use, with an optional reason. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionCancelled { @@ -2635,7 +3948,7 @@ pub struct PermissionCancelled { pub reason: Option, } -/// Schema for the `PermissionRule` type. +/// A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionRule { @@ -2645,7 +3958,7 @@ pub struct PermissionRule { pub kind: String, } -/// Schema for the `PermissionDeniedByRules` type. +/// Permission response variant denied because matching approval rules explicitly blocked the request. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionDeniedByRules { @@ -2655,7 +3968,7 @@ pub struct PermissionDeniedByRules { pub rules: Vec, } -/// Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type. +/// Permission response variant denied because no approval rule matched and user confirmation was unavailable. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser { @@ -2663,7 +3976,7 @@ pub struct PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser { pub kind: PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind, } -/// Schema for the `PermissionDeniedInteractivelyByUser` type. +/// Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionDeniedInteractivelyByUser { @@ -2677,7 +3990,7 @@ pub struct PermissionDeniedInteractivelyByUser { pub kind: PermissionDeniedInteractivelyByUserKind, } -/// Schema for the `PermissionDeniedByContentExclusionPolicy` type. +/// Permission response variant denying a path under content exclusion policy, with the path and message. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionDeniedByContentExclusionPolicy { @@ -2689,7 +4002,7 @@ pub struct PermissionDeniedByContentExclusionPolicy { pub path: String, } -/// Schema for the `PermissionDeniedByPermissionRequestHook` type. +/// Permission response variant denied by a permission-request hook, with optional message and interrupt flag. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct PermissionDeniedByPermissionRequestHook { @@ -2821,12 +4134,38 @@ pub struct SamplingCompletedData { pub request_id: RequestId, } +/// Single HTTP header entry as a name/value pair. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct HeaderEntry { + /// HTTP response header name as observed by the runtime. + pub name: String, + /// HTTP response header value as observed by the runtime. + pub value: String, +} + +/// Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthHttpResponse { + /// Complete UTF-8 response body for host-specific challenge handling, including an empty string for an empty body. Omitted when the complete body is not valid UTF-8; body read failures fail the HTTP operation rather than exposing a partial response. + #[serde(skip_serializing_if = "Option::is_none")] + pub body: Option, + /// HTTP response headers as observed by the runtime. Order and casing are transport-dependent, and duplicate header names may appear multiple times. + pub headers: Vec, + /// HTTP status code returned with the auth challenge. + pub status_code: i32, +} + /// Static OAuth client configuration, if the server specifies one #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpOauthRequiredStaticClientConfig { /// OAuth client ID for the server pub client_id: String, + /// Optional OAuth client secret for confidential static clients, when the runtime can resolve one + #[serde(skip_serializing_if = "Option::is_none")] + pub client_secret: Option, /// 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). #[serde(skip_serializing_if = "Option::is_none")] pub grant_type: Option, @@ -2835,12 +4174,35 @@ pub struct McpOauthRequiredStaticClientConfig { pub public_client: Option, } +/// OAuth WWW-Authenticate parameters parsed from an MCP auth challenge +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpOauthWWWAuthenticateParams { + /// OAuth error from the WWW-Authenticate error parameter, if present + #[serde(skip_serializing_if = "Option::is_none")] + pub error: Option, + /// Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_metadata_url: Option, + /// Requested OAuth scopes from the WWW-Authenticate scope parameter, if present + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, +} + /// Session event "mcp.oauth_required". OAuth authentication request for an MCP server #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpOauthRequiredData { - /// Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth() + /// Raw HTTP response details from the OAuth auth challenge, as observed by the runtime. Header order and casing are transport-dependent, and duplicate header names may appear multiple times. + #[serde(skip_serializing_if = "Option::is_none")] + pub http_response: Option, + /// Why the runtime is requesting host-provided OAuth credentials. + pub reason: McpOauthRequestReason, + /// Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest pub request_id: RequestId, + /// Raw OAuth protected-resource metadata document fetched for the MCP server, if available + #[serde(skip_serializing_if = "Option::is_none")] + pub resource_metadata: Option, /// Display name of the MCP server that requires OAuth pub server_name: String, /// URL of the MCP server that requires OAuth @@ -2848,16 +4210,45 @@ pub struct McpOauthRequiredData { /// Static OAuth client configuration, if the server specifies one #[serde(skip_serializing_if = "Option::is_none")] pub static_client_config: Option, + /// OAuth WWW-Authenticate parameters parsed from the auth challenge, if available + #[serde(skip_serializing_if = "Option::is_none")] + pub www_authenticate_params: Option, } /// Session event "mcp.oauth_completed". MCP OAuth request completion notification #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpOauthCompletedData { + /// How the pending OAuth request was completed + pub outcome: McpOauthCompletionOutcome, /// Request ID of the resolved OAuth request pub request_id: RequestId, } +/// Session event "mcp.headers_refresh_required". Dynamic headers refresh request for a remote MCP server +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpHeadersRefreshRequiredData { + /// Why dynamic headers are being requested. + pub reason: McpHeadersRefreshRequiredReason, + /// Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest() + pub request_id: RequestId, + /// Display name of the remote MCP server requesting headers + pub server_name: String, + /// URL of the remote MCP server requesting headers + pub server_url: String, +} + +/// Session event "mcp.headers_refresh_completed". MCP headers refresh request completion notification +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpHeadersRefreshCompletedData { + /// How the pending MCP headers refresh request resolved. + pub outcome: McpHeadersRefreshCompletedOutcome, + /// Request ID of the resolved headers refresh request + pub request_id: RequestId, +} + /// Session event "session.custom_notification". Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -2966,7 +4357,158 @@ pub struct AutoModeSwitchCompletedData { pub response: AutoModeSwitchResponse, } -/// Schema for the `CommandsChangedCommand` type. +/// Session event "session_limits_exhausted.requested". Session limit exhaustion notification requiring user action. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitsExhaustedRequestedData { + /// Configured max AI Credits for the current accounting window. + pub max_ai_credits: f64, + /// Unique identifier for this request; used to respond via session.ui.handlePendingSessionLimitsExhausted(). + pub request_id: RequestId, + /// AI Credits already consumed in the current accounting window. + pub used_ai_credits: f64, +} + +/// The user's selected action for an exhausted session limit. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitsExhaustedResponse { + /// Action selected by the user. + pub action: SessionLimitsExhaustedResponseAction, + /// AI Credits to add to the current max when action is 'add'. + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_ai_credits: Option, + /// New absolute max AI Credits when action is 'set'. + #[serde(skip_serializing_if = "Option::is_none")] + pub max_ai_credits: Option, +} + +/// Session event "session_limits_exhausted.completed". Session limit exhaustion prompt completion notification. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionLimitsExhaustedCompletedData { + /// Request ID of the resolved request; clients should dismiss any UI for this request. + pub request_id: RequestId, + /// The user's selected session-limit action. + pub response: SessionLimitsExhaustedResponse, +} + +/// Session event "session.auto_mode_resolved". Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event's experimental stability. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionAutoModeResolvedData { + /// Models offered to the router for this resolution + #[serde(skip_serializing_if = "Option::is_none")] + pub available_models: Option>, + /// Ordered candidate model list the router returned, when not a fallback + #[serde(skip_serializing_if = "Option::is_none")] + pub candidate_models: Option>, + /// Per-category classifier scores (0-1) behind the bucket: the granular HYDRA capability scores (reasoning, code_gen, debugging, tool_use), or the binary needs_reasoning/no_reasoning scores when HYDRA didn't run. Lets clients show a breakdown rather than just the bucket. + #[serde(skip_serializing_if = "Option::is_none")] + pub category_scores: Option>, + /// The concrete model the session will use after any intent refinement + pub chosen_model: String, + /// The chosen model's score shortfall relative to the top candidate + #[serde(skip_serializing_if = "Option::is_none")] + pub chosen_shortfall: Option, + /// Classifier confidence for the predicted label, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub confidence: Option, + /// End-to-end client wait time for the router request in milliseconds + #[serde(skip_serializing_if = "Option::is_none")] + pub end_to_end_latency_ms: Option, + /// Whether the router fell back to the standard Auto selection + #[serde(skip_serializing_if = "Option::is_none")] + pub fallback: Option, + /// Server-provided reason for falling back, when available + #[serde(skip_serializing_if = "Option::is_none")] + pub fallback_reason: Option, + /// Whether the routed prompt contained an image + #[serde(skip_serializing_if = "Option::is_none")] + pub has_image: Option, + /// The predicted classifier label (e.g. `needs_reasoning`), when available + #[serde(skip_serializing_if = "Option::is_none")] + pub predicted_label: Option, + /// Coarse request-difficulty bucket, for explaining why a model was chosen ("picked X because this looks like high-reasoning work") + #[serde(skip_serializing_if = "Option::is_none")] + pub reasoning_bucket: Option, + /// Server-reported router processing time in milliseconds + #[serde(skip_serializing_if = "Option::is_none")] + pub router_latency_ms: Option, + /// The routing method the server applied, when Auto Intent ran + #[serde(skip_serializing_if = "Option::is_none")] + pub routing_method: Option, + /// Whether a sticky model choice overrode the router result + #[serde(skip_serializing_if = "Option::is_none")] + pub sticky_override: Option, +} + +/// Session event "session.managed_settings_resolved". Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values per ordinary key, while permissions compose restrictively across device, server, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionManagedSettingsResolvedData { + /// Whether enterprise policy disables bypass-permissions ("yolo") mode for this session. Deny-wins across layers, and forced on when `failClosed` is true. + pub bypass_permissions_disabled: bool, + /// Whether a session-local permissions layer injected by the SDK host was present + #[serde(skip_serializing_if = "Option::is_none")] + pub client_managed: Option, + /// Whether an actual device MDM/plist/registry/file managed-settings layer was present + pub device_managed: bool, + /// Whether managed policy could not be determined (e.g. a failed server fetch) and the session fell back to the fail-closed restriction. When true, restrictions such as disabling bypass-permissions are enforced even though `settings` may be absent. + pub fail_closed: bool, + /// The setting keys under enterprise management in the effective managed settings (e.g. `model`, `enabledPlugins`, `permissions`). Empty when no managed settings are in force. + pub managed_keys: Vec, + /// Whether at least two managed sources supplied permission allowlists, so enforcement intersects them and the flattened settings payload omits `permissions.allow`. + #[serde(skip_serializing_if = "Option::is_none")] + pub permissions_allow_intersected: Option, + /// Whether the server (account/org) managed-settings layer was present + pub server_managed: bool, + /// The effective (resolved) managed settings values, so clients can render exactly what is enforced. Absent when no managed policy is in force. + #[serde(skip_serializing_if = "Option::is_none")] + pub settings: Option, + /// Channel summary: `server`, `device`, or `client` when exactly one channel contributed; `mixed` when multiple channels contributed; otherwise `none`. Consult the per-channel booleans for exact provenance. + pub source: ManagedSettingsResolvedSource, +} + +/// Session event "session.managed_settings_enforced". Runtime enforcement of enterprise managed settings: fires when the session blocks or caps a runtime action because enterprise policy governs it, so SDK clients can explain *why* an action was governed. Unlike `session.managed_settings_resolved` (which reports *what* is managed), this reports a concrete governed action — e.g. a user or host tried to turn on a bypass-permissions escalation while policy disables it. Emitted live (not persisted to the session event log) on user/host-initiated attempts only, never for silent policy application. Marked experimental while the managed-settings surface stabilizes. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionManagedSettingsEnforcedData { + /// The category of runtime action that managed policy governed. + pub action: ManagedSettingsEnforcedAction, + /// For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused. Absent for actions without a specific escalation primitive. + #[serde(skip_serializing_if = "Option::is_none")] + pub escalation: Option, + /// Whether the enforcement was forced by fail-closed handling (managed policy could not be determined) rather than an explicit managed setting. When true, `setting` still names the restriction that was applied. + pub fail_closed: bool, + /// A human-readable explanation of why the action was governed, suitable for surfacing to the user. + pub message: String, + /// The managed setting key responsible for the enforcement (e.g. `permissions.disableBypassPermissionsMode`). + pub setting: String, +} + +/// A single slash command available in the session, as listed by the `commands.changed` event. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CommandsChangedCommand { @@ -3045,7 +4587,7 @@ pub struct ExitPlanModeCompletedData { pub selected_action: Option, } -/// Session event "session.tools_updated". +/// Session event "session.tools_updated". Payload of `session.tools_updated` identifying the model whose resolved tools were updated. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionToolsUpdatedData { @@ -3053,15 +4595,37 @@ pub struct SessionToolsUpdatedData { pub model: String, } -/// Session event "session.background_tasks_changed". +/// Session event "session.background_tasks_changed". Empty payload for `session.background_tasks_changed`, indicating background task state changed. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionBackgroundTasksChangedData {} -/// Schema for the `SkillsLoadedSkill` type. +/// Session event "factory.run_updated". Ephemeral invalidation signal for a changed factory run. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FactoryRunUpdatedData { + /// Monotonic revision now available for the run. + pub revision: i64, + pub run_id: String, +} + +/// A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SkillsLoadedSkill { + /// Optional freeform hint describing the skill's expected arguments, from the `argument-hint` frontmatter field + #[serde(skip_serializing_if = "Option::is_none")] + pub argument_hint: Option, + /// Canonical slash command name used to invoke the skill, without the leading '/' + #[serde(skip_serializing_if = "Option::is_none")] + pub command_name: Option, /// Description of what the skill does pub description: String, /// Whether the skill is currently enabled @@ -3077,7 +4641,7 @@ pub struct SkillsLoadedSkill { pub user_invocable: bool, } -/// Session event "session.skills_loaded". +/// Session event "session.skills_loaded". Payload of `session.skills_loaded` listing resolved skill metadata. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionSkillsLoadedData { @@ -3085,7 +4649,7 @@ pub struct SessionSkillsLoadedData { pub skills: Vec, } -/// Schema for the `CustomAgentsUpdatedAgent` type. +/// A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CustomAgentsUpdatedAgent { @@ -3108,7 +4672,7 @@ pub struct CustomAgentsUpdatedAgent { pub user_invocable: bool, } -/// Session event "session.custom_agents_updated". +/// Session event "session.custom_agents_updated". Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionCustomAgentsUpdatedData { @@ -3120,7 +4684,7 @@ pub struct SessionCustomAgentsUpdatedData { pub warnings: Vec, } -/// Schema for the `McpServersLoadedServer` type. +/// A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpServersLoadedServer { @@ -3138,14 +4702,14 @@ pub struct McpServersLoadedServer { /// Configuration source: user, workspace, plugin, or builtin #[serde(skip_serializing_if = "Option::is_none")] pub source: Option, - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured pub status: McpServerStatus, /// Transport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server) #[serde(skip_serializing_if = "Option::is_none")] pub transport: Option, } -/// Session event "session.mcp_servers_loaded". +/// Session event "session.mcp_servers_loaded". Payload of `session.mcp_servers_loaded` listing MCP server status summaries. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionMcpServersLoadedData { @@ -3153,7 +4717,7 @@ pub struct SessionMcpServersLoadedData { pub servers: Vec, } -/// Session event "session.mcp_server_status_changed". +/// Session event "session.mcp_server_status_changed". Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionMcpServerStatusChangedData { @@ -3162,15 +4726,39 @@ pub struct SessionMcpServerStatusChangedData { pub error: Option, /// Name of the MCP server whose status changed pub server_name: String, - /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured + /// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured pub status: McpServerStatus, } -/// Schema for the `ExtensionsLoadedExtension` type. +/// Session event "mcp.tools.list_changed". Payload identifying the MCP server associated with a list change. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpToolsListChangedData { + /// Name of the MCP server whose list changed + pub server_name: String, +} + +/// Session event "mcp.resources.list_changed". Payload identifying the MCP server associated with a list change. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpResourcesListChangedData { + /// Name of the MCP server whose list changed + pub server_name: String, +} + +/// Session event "mcp.prompts.list_changed". Payload identifying the MCP server associated with a list change. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct McpPromptsListChangedData { + /// Name of the MCP server whose list changed + pub server_name: String, +} + +/// A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ExtensionsLoadedExtension { - /// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper') + /// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext') pub id: String, /// Extension name (directory name) pub name: String, @@ -3180,7 +4768,7 @@ pub struct ExtensionsLoadedExtension { pub status: ExtensionsLoadedExtensionStatus, } -/// Session event "session.extensions_loaded". +/// Session event "session.extensions_loaded". Payload of `session.extensions_loaded` listing discovered extensions and their statuses. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionExtensionsLoadedData { @@ -3188,12 +4776,17 @@ pub struct SessionExtensionsLoadedData { pub extensions: Vec, } -/// Session event "session.canvas.opened". +/// Session event "session.canvas.opened". Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional icon, title, status, URL, and input. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionCanvasOpenedData { - /// Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. - pub availability: CanvasOpenedAvailability, /// Provider-local canvas identifier pub canvas_id: String, /// Owning provider identifier @@ -3201,13 +4794,14 @@ pub struct SessionCanvasOpenedData { /// Owning extension display name, when available #[serde(skip_serializing_if = "Option::is_none")] pub extension_name: Option, + /// Host-local PNG path for the canvas icon, when supplied + #[serde(skip_serializing_if = "Option::is_none")] + pub icon: Option, /// Input supplied when the instance was opened #[serde(skip_serializing_if = "Option::is_none")] pub input: Option, /// Stable caller-supplied canvas instance identifier pub instance_id: String, - /// Whether this notification represents an idempotent reopen - pub reopen: bool, /// Provider-supplied status text #[serde(skip_serializing_if = "Option::is_none")] pub status: Option, @@ -3219,7 +4813,14 @@ pub struct SessionCanvasOpenedData { pub url: Option, } -/// Schema for the `CanvasRegistryChangedCanvasAction` type. +/// A single action within a canvas declaration, with its name, optional description, and optional input schema. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CanvasRegistryChangedCanvasAction { @@ -3228,12 +4829,19 @@ pub struct CanvasRegistryChangedCanvasAction { pub description: Option, /// JSON Schema for action input #[serde(skip_serializing_if = "Option::is_none")] - pub input_schema: Option>, + pub input_schema: Option, /// Action name pub name: String, } -/// Schema for the `CanvasRegistryChangedCanvas` type. +/// A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct CanvasRegistryChangedCanvas { @@ -3251,17 +4859,117 @@ pub struct CanvasRegistryChangedCanvas { /// Owning extension display name, when available #[serde(skip_serializing_if = "Option::is_none")] pub extension_name: Option, + /// Host-local PNG path for the canvas icon, when supplied + #[serde(skip_serializing_if = "Option::is_none")] + pub icon: Option, /// JSON Schema for canvas open input #[serde(skip_serializing_if = "Option::is_none")] - pub input_schema: Option>, + pub input_schema: Option, +} + +/// Session event "session.canvas.registry_changed". Payload of `session.canvas.registry_changed` listing the canvas declarations currently available. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasRegistryChangedData { + /// Canvas declarations currently available + pub canvases: Vec, +} + +/// Session event "session.canvas.closed". Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasClosedData { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Stable caller-supplied identifier of the canvas instance that was closed + pub instance_id: String, +} + +/// Session event "session.canvas.unavailable". Transient signal that an open canvas instance's provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent `session.canvas.opened` for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasUnavailableData { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Stable caller-supplied identifier of the canvas instance whose provider became unavailable + pub instance_id: String, +} + +/// Session event "session.canvas.recorded". Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasRecordedData { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Input supplied when the instance was opened + #[serde(skip_serializing_if = "Option::is_none")] + pub input: Option, + /// Stable caller-supplied canvas instance identifier + pub instance_id: String, + /// Rendered title + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, +} + +/// Session event "session.canvas.removed". Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionCanvasRemovedData { + /// Provider-local canvas identifier + pub canvas_id: String, + /// Owning provider identifier + pub extension_id: String, + /// Stable caller-supplied identifier of the canvas instance that was closed + pub instance_id: String, } -/// Session event "session.canvas.registry_changed". +/// Session event "session.extensions.attachments_pushed". Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] -pub struct SessionCanvasRegistryChangedData { - /// Canvas declarations currently available - pub canvases: Vec, +pub struct SessionExtensionsAttachmentsPushedData { + /// Attachments contributed by an extension; the host should surface these as composer pills and forward them via the next session.send call. + pub attachments: Vec, } /// Set when the underlying tools/call threw an error before returning a CallToolResult @@ -3272,7 +4980,7 @@ pub struct McpAppToolCallCompleteError { pub message: String, } -/// Schema for the `McpAppToolCallCompleteToolMetaUI` type. +/// MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpAppToolCallCompleteToolMetaUI { @@ -3288,7 +4996,7 @@ pub struct McpAppToolCallCompleteToolMetaUI { #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct McpAppToolCallCompleteToolMeta { - /// Schema for the `McpAppToolCallCompleteToolMetaUI` type. + /// MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result. #[serde(skip_serializing_if = "Option::is_none")] pub ui: Option, } @@ -3324,7 +5032,7 @@ pub struct McpAppToolCallCompleteData { pub enum WorkingDirectoryContextHostType { /// Repository is hosted on GitHub. #[serde(rename = "github")] - Github, + GitHub, /// Repository is hosted on Azure DevOps. #[serde(rename = "ado")] Ado, @@ -3334,8 +5042,9 @@ pub enum WorkingDirectoryContextHostType { Unknown, } +/// Allowed values for the `ContextTier` enumeration. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionStartDataContextTier { +pub enum ContextTier { /// Default context tier with standard context window size. #[serde(rename = "default")] Default, @@ -3366,14 +5075,33 @@ pub enum ReasoningSummary { Unknown, } +/// Output verbosity level used for supported model calls (e.g. "low", "medium", "high") #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionResumeDataContextTier { - /// Default context tier with standard context window size. - #[serde(rename = "default")] - Default, - /// Extended context tier with a larger context window. - #[serde(rename = "long_context")] - LongContext, +pub enum Verbosity { + /// A terse response was requested. + #[serde(rename = "low")] + Low, + /// A medium amount of response detail was requested. + #[serde(rename = "medium")] + Medium, + /// A more detailed response was requested. + #[serde(rename = "high")] + High, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool). Gates whether a scheduled skill that opted out of model invocation may fire: only user-created schedules may. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ScheduleOrigin { + /// The schedule was created by an explicit user action, such as `/every` or `/after`. + #[serde(rename = "user")] + User, + /// The schedule was created by the agent via the `manage_schedule` tool. + #[serde(rename = "model")] + Model, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -3419,20 +5147,6 @@ pub enum AutopilotObjectiveChangedStatus { Unknown, } -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum SessionModelChangeDataContextTier { - /// Default context tier with standard context window size. - #[serde(rename = "default")] - Default, - /// Extended context tier with a larger context window. - #[serde(rename = "long_context")] - LongContext, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, -} - /// The session mode the agent is operating in #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SessionMode { @@ -3451,6 +5165,31 @@ pub enum SessionMode { Unknown, } +/// Allow-all mode for the session. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionAllowAllMode { + /// Permission requests follow the normal approval flow. + #[serde(rename = "off")] + Off, + /// Tool, path, and URL permission requests are automatically approved. + #[serde(rename = "on")] + On, + /// Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. + #[serde(rename = "auto")] + Auto, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// The type of operation performed on the plan file #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PlanChangedOperation { @@ -3514,6 +5253,48 @@ pub enum ShutdownType { Unknown, } +/// What initiated a conversation compaction +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CompactionTrigger { + /// Background compaction started automatically because context utilization crossed the background threshold. + #[serde(rename = "threshold")] + Threshold, + /// Compaction forced by a context-limit model response (e.g. HTTP 413) before retrying the request. + #[serde(rename = "context_limit_retry")] + ContextLimitRetry, + /// User-requested compaction, e.g. the /compact command or the history.compact API. + #[serde(rename = "manual")] + Manual, + /// Emergency compaction triggered by high process memory usage. + #[serde(rename = "memory_pressure")] + MemoryPressure, + /// Compaction requested while switching to a model with a smaller context window. + #[serde(rename = "model_switch")] + ModelSwitch, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Semantic result of evaluating a task completion request +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum TaskCompletionOutcome { + /// The completion request was accepted and the objective is complete. + #[serde(rename = "completed")] + Completed, + /// The completion request was rejected because more work or validation remains. + #[serde(rename = "continue")] + Continue, + /// Completion cannot proceed without intervention; the active objective is paused when one is identified. + #[serde(rename = "blocked")] + Blocked, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// The agent mode that was active when this message was sent #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum UserMessageAgentMode { @@ -3535,6 +5316,24 @@ pub enum UserMessageAgentMode { Unknown, } +/// How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum UserMessageDelivery { + /// Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). + #[serde(rename = "idle")] + Idle, + /// Injected into the current in-flight run while the agent was busy (immediate mode). + #[serde(rename = "steering")] + Steering, + /// Enqueued while the agent was busy; processed as its own run afterward. + #[serde(rename = "queued")] + Queued, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent. #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum AssistantMessageToolRequestType { @@ -3550,6 +5349,31 @@ pub enum AssistantMessageToolRequestType { Unknown, } +/// The system that produced a citation. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum CitationProvider { + /// Citation produced by an Anthropic (Claude) model response. + #[serde(rename = "anthropic")] + Anthropic, + /// Citation produced by an OpenAI model response. + #[serde(rename = "openai")] + Openai, + /// Citation synthesized client-side by the runtime from tool output. + #[serde(rename = "client")] + Client, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum AssistantUsageApiEndpoint { @@ -3571,6 +5395,36 @@ pub enum AssistantUsageApiEndpoint { Unknown, } +/// For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ModelCallFailureBadRequestKind { + /// The 400 response carried no error body (transient gateway/proxy signature). + #[serde(rename = "bodyless")] + Bodyless, + /// The 400 response carried a structured CAPI error envelope (deterministic validation failure). + #[serde(rename = "structured_error")] + StructuredError, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Boundary that produced a model call failure +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ModelCallFailureKind { + /// The provider returned an API error response. + #[serde(rename = "api")] + Api, + /// The request transport failed before a usable API response completed. + #[serde(rename = "transport")] + Transport, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Where the failed model call originated #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum ModelCallFailureSource { @@ -3589,6 +5443,21 @@ pub enum ModelCallFailureSource { Unknown, } +/// Transport used for a failed model call +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ModelCallFailureTransport { + /// HTTP transport, including SSE streams. + #[serde(rename = "http")] + Http, + /// WebSocket transport. + #[serde(rename = "websocket")] + Websocket, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Finite reason code describing why the current turn was aborted #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum AbortReason { @@ -3601,6 +5470,24 @@ pub enum AbortReason { /// An MCP server delivered a user.abort notification. #[serde(rename = "user_abort")] UserAbort, + /// Autopilot stopped the run because the active objective reached its user-set --max-ai-credits limit. + #[serde(rename = "autopilot_credit_limit")] + AutopilotCreditLimit, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ToolExecutionStartToolDescriptionMetaUIVisibility { + /// Tool is callable by the model (LLM tool surface) + #[serde(rename = "model")] + Model, + /// Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool + #[serde(rename = "app")] + App, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -3623,6 +5510,14 @@ pub enum ToolExecutionCompleteContentTerminalType { Terminal, } +/// Content block type discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ToolExecutionCompleteContentShellExitType { + #[serde(rename = "shell_exit")] + #[default] + ShellExit, +} + /// Content block type discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum ToolExecutionCompleteContentImageType { @@ -3684,6 +5579,7 @@ pub enum ToolExecutionCompleteContentResourceType { pub enum ToolExecutionCompleteContent { Text(ToolExecutionCompleteContentText), Terminal(ToolExecutionCompleteContentTerminal), + ShellExit(ToolExecutionCompleteContentShellExit), Image(ToolExecutionCompleteContentImage), Audio(ToolExecutionCompleteContentAudio), ResourceLink(ToolExecutionCompleteContentResourceLink), @@ -3723,6 +5619,21 @@ pub enum SkillInvokedTrigger { Unknown, } +/// Binary asset type discriminator. Use "image" for images and "resource" otherwise. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum BinaryAssetType { + /// Binary image data. + #[serde(rename = "image")] + Image, + /// Other binary resource data. + #[serde(rename = "resource")] + Resource, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Message role: "system" for system prompts, "developer" for developer-injected instructions #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum SystemMessageRole { @@ -3840,6 +5751,29 @@ pub enum PermissionRequestExtensionManagementKind { ExtensionManagement, } +/// Permission kind discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionRequestFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + +/// Operation gated by a factory permission request. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum FactoryPermissionOperation { + /// Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. + #[serde(rename = "run")] + Run, + /// Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. + #[serde(rename = "author")] + Author, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Permission kind discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionRequestExtensionPermissionAccessKind { @@ -3861,9 +5795,69 @@ pub enum PermissionRequest { CustomTool(PermissionRequestCustomTool), Hook(PermissionRequestHook), ExtensionManagement(PermissionRequestExtensionManagement), + Factory(PermissionRequestFactory), ExtensionPermissionAccess(PermissionRequestExtensionPermissionAccess), } +/// Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AutoApprovalJudgeFailureReason { + /// The judge model call exceeded its deadline. + #[serde(rename = "timeout")] + Timeout, + /// The judge model call was cancelled before it returned. + #[serde(rename = "abort")] + Abort, + /// The judge model call completed but returned no content. + #[serde(rename = "empty_response")] + EmptyResponse, + /// The judge model call failed (for example a transport, authentication, or rate-limit error). + #[serde(rename = "model_error")] + ModelError, + /// The judge model replied, but the reply carried no ALLOW/DENY verdict. + #[serde(rename = "parse_error")] + ParseError, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off). +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol surface +/// and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AutoApprovalRecommendation { + /// The judge evaluated the request and recommends automatically approving it. + #[serde(rename = "approve")] + Approve, + /// The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. + #[serde(rename = "requireApproval")] + RequireApproval, + /// Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. + #[serde(rename = "excluded")] + Excluded, + /// The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. + #[serde(rename = "error")] + Error, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Prompt kind discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionPromptRequestCommandsKind { @@ -3962,6 +5956,14 @@ pub enum PermissionPromptRequestExtensionManagementKind { ExtensionManagement, } +/// Prompt kind discriminator +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum PermissionPromptRequestFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + /// Prompt kind discriminator #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum PermissionPromptRequestExtensionPermissionAccessKind { @@ -3984,6 +5986,7 @@ pub enum PermissionPromptRequest { Path(PermissionPromptRequestPath), Hook(PermissionPromptRequestHook), ExtensionManagement(PermissionPromptRequestExtensionManagement), + Factory(PermissionPromptRequestFactory), ExtensionPermissionAccess(PermissionPromptRequestExtensionPermissionAccess), } @@ -4051,6 +6054,14 @@ pub enum UserToolSessionApprovalExtensionManagementKind { ExtensionManagement, } +/// Factory approval kind +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum UserToolSessionApprovalFactoryKind { + #[serde(rename = "factory")] + #[default] + Factory, +} + /// Extension permission access approval kind #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum UserToolSessionApprovalExtensionPermissionAccessKind { @@ -4070,6 +6081,7 @@ pub enum UserToolSessionApproval { Memory(UserToolSessionApprovalMemory), CustomTool(UserToolSessionApprovalCustomTool), ExtensionManagement(UserToolSessionApprovalExtensionManagement), + Factory(UserToolSessionApprovalFactory), ExtensionPermissionAccess(UserToolSessionApprovalExtensionPermissionAccess), } @@ -4195,6 +6207,27 @@ pub enum ElicitationCompletedAction { Unknown, } +/// Reason the runtime is requesting host-provided MCP OAuth credentials +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpOauthRequestReason { + /// Initial credentials are required before connecting to the MCP server. + #[serde(rename = "initial")] + Initial, + /// The current host-provided credential was rejected and a replacement is requested. + #[serde(rename = "refresh")] + Refresh, + /// The server requires a new host authorization flow before continuing. + #[serde(rename = "reauth")] + Reauth, + /// The server requires a credential with additional scope or audience. + #[serde(rename = "upscope")] + Upscope, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// 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). #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum McpOauthRequiredStaticClientConfigGrantType { @@ -4203,6 +6236,57 @@ pub enum McpOauthRequiredStaticClientConfigGrantType { ClientCredentials, } +/// How the pending MCP OAuth request was completed +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpOauthCompletionOutcome { + /// The request completed with a token-backed OAuth provider. + #[serde(rename = "token")] + Token, + /// The request completed without an OAuth provider. + #[serde(rename = "cancelled")] + Cancelled, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Why dynamic headers are being requested. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpHeadersRefreshRequiredReason { + /// The transport is making its first dynamic header request for this server. + #[serde(rename = "startup")] + Startup, + /// The previously cached dynamic headers expired. + #[serde(rename = "ttl-expired")] + TtlExpired, + /// The server returned 401 and stale dynamic headers were invalidated. + #[serde(rename = "auth-failed")] + AuthFailed, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// How the pending MCP headers refresh request resolved. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum McpHeadersRefreshCompletedOutcome { + /// The host supplied dynamic headers. + #[serde(rename = "headers")] + Headers, + /// The host responded with no dynamic headers. + #[serde(rename = "none")] + None, + /// No response arrived within the bounded window. + #[serde(rename = "timeout")] + Timeout, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// The user's auto-mode-switch choice #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum AutoModeSwitchResponse { @@ -4221,6 +6305,105 @@ pub enum AutoModeSwitchResponse { Unknown, } +/// User action selected for an exhausted session limit. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum SessionLimitsExhaustedResponseAction { + /// Increase the current max by an exact AI Credits amount. + #[serde(rename = "add")] + Add, + /// Set a new absolute max AI Credits value. + #[serde(rename = "set")] + Set, + /// Remove the current session limit. + #[serde(rename = "unset")] + Unset, + /// Leave the limit unchanged and cancel the blocked model request. + #[serde(rename = "cancel")] + Cancel, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Coarse request-difficulty bucket for UX explainability +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum AutoModeResolvedReasoningBucket { + /// The request looks low-reasoning; a lighter model is appropriate. + #[serde(rename = "low")] + Low, + /// The request needs a moderate amount of reasoning. + #[serde(rename = "medium")] + Medium, + /// The request looks high-reasoning; a stronger model is appropriate. + #[serde(rename = "high")] + High, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// Summary of which managed-settings channels contributed to the effective session policy. Use the per-channel booleans for exact provenance. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ManagedSettingsResolvedSource { + /// Only the server/account channel contributed. + #[serde(rename = "server")] + Server, + /// Only the device MDM/plist/registry/file channel contributed. + #[serde(rename = "device")] + Device, + /// Only session-local SDK-host injection contributed. + #[serde(rename = "client")] + Client, + /// More than one channel contributed. Ordinary keys resolve device over server per key, while permissions compose restrictively across all present layers. + #[serde(rename = "mixed")] + Mixed, + /// No managed policy is in force (no channel contributed). + #[serde(rename = "none")] + None, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// The category of runtime action that enterprise managed settings governed (blocked or capped) +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ManagedSettingsEnforcedAction { + /// An attempt to turn on a bypass-permissions ("yolo") escalation was refused or capped because policy disables bypass-permissions mode. + #[serde(rename = "bypass_permissions_blocked")] + BypassPermissionsBlocked, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + +/// For a `bypass_permissions_blocked` action, which permission-escalation primitive was refused +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub enum ManagedSettingsEnforcedEscalation { + /// Full allow-all ("/allow-all on") permissions — auto-approving tools, paths, and URLs. + #[serde(rename = "allow_all")] + AllowAll, + /// Auto-approval of all tool permission requests. + #[serde(rename = "approve_all")] + ApproveAll, + /// Advisory auto-approval ("/allow-all auto") mode — keeps normal prompt paths and adds LLM-advised approval, distinct from full allow-all. + #[serde(rename = "auto_approval")] + AutoApproval, + /// Unrestricted filesystem access outside the session's allowed directories. + #[serde(rename = "unrestricted_paths")] + UnrestrictedPaths, + /// Unrestricted URL fetch access. + #[serde(rename = "unrestricted_urls")] + UnrestrictedUrls, + /// Unknown variant for forward compatibility. + #[default] + #[serde(other)] + Unknown, +} + /// Exit plan mode action #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum ExitPlanModeAction { @@ -4293,7 +6476,7 @@ pub enum McpServerSource { Unknown, } -/// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured +/// Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub enum McpServerStatus { /// The server is connected and available. @@ -4311,6 +6494,9 @@ pub enum McpServerStatus { /// The server is configured but disabled. #[serde(rename = "disabled")] Disabled, + /// The server was intentionally stopped and can be restarted on demand when policy permits; a server quarantined by restrictive managed policy stays stopped and cannot be restarted until the policy allows it. + #[serde(rename = "stopped")] + Stopped, /// The server is not configured for this session. #[serde(rename = "not_configured")] NotConfigured, @@ -4350,6 +6536,12 @@ pub enum ExtensionsLoadedExtensionSource { /// Extension discovered from the user's extension directory. #[serde(rename = "user")] User, + /// Extension contributed by an installed plugin. + #[serde(rename = "plugin")] + Plugin, + /// Extension discovered from the current session's state directory. + #[serde(rename = "session")] + Session, /// Unknown variant for forward compatibility. #[default] #[serde(other)] @@ -4376,18 +6568,3 @@ pub enum ExtensionsLoadedExtensionStatus { #[serde(other)] Unknown, } - -/// Runtime-controlled routing state for the instance. "ready" when the provider connection is live; "stale" when the provider has gone away and the instance is awaiting rebinding. -#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] -pub enum CanvasOpenedAvailability { - /// Provider connection is live; actions can be invoked. - #[serde(rename = "ready")] - Ready, - /// Provider has gone away; the instance is awaiting rebinding. - #[serde(rename = "stale")] - Stale, - /// Unknown variant for forward compatibility. - #[default] - #[serde(other)] - Unknown, -} diff --git a/rust/src/github_telemetry.rs b/rust/src/github_telemetry.rs new file mode 100644 index 000000000..9ef5c6e2e --- /dev/null +++ b/rust/src/github_telemetry.rs @@ -0,0 +1,28 @@ +//! GitHub telemetry forwarding callback surface. +//! +//! The runtime forwards per-session GitHub (hydro) telemetry to opted-in host +//! connections via the `gitHubTelemetry.event` JSON-RPC notification. The +//! payload types (`GitHubTelemetryNotification`, `GitHubTelemetryEvent`, +//! `GitHubTelemetryClientInfo`) are generated from the protocol schema and +//! re-exported here so consumers can register a callback against them via +//! [`ClientOptions::on_github_telemetry`](crate::ClientOptions::on_github_telemetry). +//! +//! Experimental: this surface is part of the GitHub telemetry forwarding +//! feature and may change or be removed without notice. + +use std::sync::Arc; + +#[doc(hidden)] +pub use crate::generated::api_types::{ + GitHubTelemetryClientInfo, GitHubTelemetryEvent, GitHubTelemetryNotification, +}; + +/// Callback invoked for each `gitHubTelemetry.event` notification forwarded by +/// the runtime to a connection that opted into telemetry forwarding. +/// +/// Set via +/// [`ClientOptions::on_github_telemetry`](crate::ClientOptions::on_github_telemetry). +/// Registering a callback auto-enables telemetry forwarding on every session +/// created or resumed by the client. +#[doc(hidden)] +pub type GitHubTelemetryCallback = Arc; diff --git a/rust/src/handler.rs b/rust/src/handler.rs index dadd1706f..f1f0d9566 100644 --- a/rust/src/handler.rs +++ b/rust/src/handler.rs @@ -19,8 +19,13 @@ use async_trait::async_trait; use serde::{Deserialize, Serialize}; use crate::generated::api_types::{ - PermissionDecision, PermissionDecisionApproveOnce, PermissionDecisionReject, - PermissionDecisionUserNotAvailable, + McpOauthPendingRequestResponse, McpOauthPendingRequestResponseCancelled, + McpOauthPendingRequestResponseCancelledKind, McpOauthPendingRequestResponseToken, + McpOauthPendingRequestResponseTokenKind, PermissionDecision, PermissionDecisionApproveOnce, + PermissionDecisionContext, PermissionDecisionReject, PermissionDecisionUserNotAvailable, +}; +use crate::session_events::{ + McpOauthRequestReason, McpOauthRequiredStaticClientConfig, McpOauthWWWAuthenticateParams, }; use crate::types::{ ElicitationRequest, ElicitationResult, ExitPlanModeData, PermissionRequestData, RequestId, @@ -30,13 +35,30 @@ use crate::types::{ /// Decision returned by a [`PermissionHandler`]. /// /// Either a concrete wire-level [`PermissionDecision`] (approve, reject, -/// approve-for-session, approve-permanently, user-not-available, …) or -/// [`PermissionResult::NoResult`], which tells the SDK to suppress its -/// response so another connected client can answer instead. +/// approve-for-session, approve-permanently, user-not-available, …) with +/// optional telemetry context, or [`PermissionResult::NoResult`], which tells +/// the SDK to suppress its response so another connected client can answer +/// instead. +/// +/// ``` +/// use github_copilot_sdk::handler::PermissionResult; +/// +/// fn is_decision(result: PermissionResult) -> bool { +/// match result { +/// PermissionResult::Decision { .. } => true, +/// PermissionResult::NoResult => false, +/// } +/// } +/// ``` #[derive(Debug, Clone)] pub enum PermissionResult { /// Send a permission decision on the wire. - Decision(PermissionDecision), + Decision { + /// The decision to send. + decision: PermissionDecision, + /// Optional context describing how and where the decision was reached. + context: Option, + }, /// Decline to respond to this request, allowing another connected /// client to answer instead. The SDK suppresses the response. NoResult, @@ -45,24 +67,31 @@ pub enum PermissionResult { impl PermissionResult { /// Approve this single request. pub fn approve_once() -> Self { - Self::Decision(PermissionDecision::ApproveOnce( - PermissionDecisionApproveOnce::default(), - )) + Self::Decision { + decision: PermissionDecision::ApproveOnce(PermissionDecisionApproveOnce::default()), + context: None, + } } /// Reject the request, optionally forwarding feedback to the LLM. pub fn reject(feedback: impl Into>) -> Self { - Self::Decision(PermissionDecision::Reject(PermissionDecisionReject { - feedback: feedback.into(), - ..Default::default() - })) + Self::Decision { + decision: PermissionDecision::Reject(PermissionDecisionReject { + feedback: feedback.into(), + ..Default::default() + }), + context: None, + } } /// Deny because no user is available to confirm. pub fn user_not_available() -> Self { - Self::Decision(PermissionDecision::UserNotAvailable( - PermissionDecisionUserNotAvailable::default(), - )) + Self::Decision { + decision: PermissionDecision::UserNotAvailable( + PermissionDecisionUserNotAvailable::default(), + ), + context: None, + } } /// Decline to respond, allowing another connected client to answer @@ -70,14 +99,50 @@ impl PermissionResult { pub fn no_result() -> Self { Self::NoResult } + + /// Attach provenance describing how and where this decision was made, + /// so the runtime can attribute auto-approval telemetry. + /// + /// It is a no-op on [`PermissionResult::NoResult`]. + /// + /// ```rust,no_run + /// # use github_copilot_sdk::handler::PermissionResult; + /// # use github_copilot_sdk::{ + /// # PermissionDecisionContext, PermissionDecisionOutcome, PermissionDecisionSource, + /// # PermissionDecisionSurface, + /// # }; + /// + /// let result = PermissionResult::approve_once().with_context(PermissionDecisionContext { + /// outcome: PermissionDecisionOutcome::AutoApproved, + /// source: PermissionDecisionSource::HostPolicy, + /// surface: PermissionDecisionSurface::Sdk, + /// }); + /// ``` + pub fn with_context(self, context: PermissionDecisionContext) -> Self { + match self { + Self::Decision { decision, .. } => Self::Decision { + decision, + context: Some(context), + }, + Self::NoResult => Self::NoResult, + } + } } impl From for PermissionResult { fn from(value: PermissionDecision) -> Self { - Self::Decision(value) + Self::Decision { + decision: value, + context: None, + } } } +pub(crate) fn permission_handler_failure(message: &str) -> PermissionResult { + tracing::error!(error = message, "permission handler failed"); + PermissionResult::user_not_available() +} + /// Response to a user input request. #[derive(Debug, Clone)] pub struct UserInputResponse { @@ -159,6 +224,75 @@ pub trait ElicitationHandler: Send + Sync + 'static { ) -> ElicitationResult; } +/// MCP OAuth request that the SDK host can satisfy with a host-acquired token. +#[derive(Debug, Clone)] +pub struct McpAuthRequest { + /// Identifier for the pending MCP OAuth request. + pub request_id: RequestId, + /// Display name of the MCP server that requires OAuth. + pub server_name: String, + /// URL of the MCP server that requires OAuth. + pub server_url: String, + /// Why the runtime is requesting host-provided OAuth credentials. + pub reason: McpOauthRequestReason, + /// Parsed WWW-Authenticate parameters from the MCP server, if available. + pub www_authenticate_params: Option, + /// Raw RFC 9728 protected-resource metadata JSON fetched by the runtime, if available. + pub resource_metadata: Option, + /// Static OAuth client configuration, if the server specifies one. + pub static_client_config: Option, +} + +/// Result returned by an MCP auth request handler. +#[derive(Debug, Clone)] +pub enum McpAuthResult { + /// Supplies host-acquired OAuth token data. + Token { + /// Access token acquired by the SDK host. + access_token: String, + /// OAuth token type. Defaults to Bearer when omitted. + token_type: Option, + /// Token lifetime in seconds, if known. + expires_in: Option, + }, + /// Declines or cancels the pending OAuth request. + Cancelled, +} + +impl McpAuthResult { + pub(crate) fn into_wire(self) -> McpOauthPendingRequestResponse { + match self { + Self::Token { + access_token, + token_type, + expires_in, + } => McpOauthPendingRequestResponse::Token(McpOauthPendingRequestResponseToken { + access_token, + token_type, + expires_in, + kind: McpOauthPendingRequestResponseTokenKind::Token, + }), + Self::Cancelled => { + McpOauthPendingRequestResponse::Cancelled(McpOauthPendingRequestResponseCancelled { + kind: McpOauthPendingRequestResponseCancelledKind::Cancelled, + }) + } + } + } +} + +/// Handler for MCP server OAuth requests. +#[async_trait] +pub trait McpAuthHandler: Send + Sync + 'static { + /// Resolve an MCP OAuth request with host token data or cancellation. + async fn handle( + &self, + session_id: SessionId, + request_id: RequestId, + request: McpAuthRequest, + ) -> McpAuthResult; +} + /// Handler for `user_input.requested` events from the `ask_user` tool. /// /// When unset, `requestUserInput: false` goes on the wire and the @@ -199,9 +333,12 @@ pub trait AutoModeSwitchHandler: Send + Sync + 'static { ) -> AutoModeSwitchResponse; } -/// A [`PermissionHandler`] that approves every request. Useful for CLI -/// tools, scripts, and tests that don't need interactive permission -/// prompts. +/// A [`PermissionHandler`] that approves ordinary requests when managed settings are disabled. +/// +/// When managed settings are enabled, the handler logs an error and returns a +/// user-not-available decision. As a defense-in-depth fallback, a request marked +/// as requiring managed approval is left unanswered even if the session flag is +/// absent. #[derive(Debug, Clone)] pub struct ApproveAllHandler; @@ -211,9 +348,17 @@ impl PermissionHandler for ApproveAllHandler { &self, _session_id: SessionId, _request_id: RequestId, - _data: PermissionRequestData, + data: PermissionRequestData, ) -> PermissionResult { - PermissionResult::approve_once() + if data.managed_settings_enabled { + permission_handler_failure( + "ApproveAllHandler cannot be used when managed settings are enabled", + ) + } else if data.managed_approval_required == Some(true) { + PermissionResult::no_result() + } else { + PermissionResult::approve_once() + } } } @@ -248,10 +393,49 @@ mod tests { .await; assert!(matches!( result, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } + )); + } + + #[tokio::test] + async fn approve_all_handler_fails_when_managed_settings_enabled() { + let result = ApproveAllHandler + .handle( + SessionId::from("s1"), + RequestId::new("1"), + PermissionRequestData { + managed_settings_enabled: true, + ..Default::default() + }, + ) + .await; + assert!(matches!( + result, + PermissionResult::Decision { + decision: PermissionDecision::UserNotAvailable(_), + .. + } )); } + #[tokio::test] + async fn approve_all_handler_leaves_managed_approval_pending() { + let result = ApproveAllHandler + .handle( + SessionId::from("s1"), + RequestId::new("1"), + PermissionRequestData { + managed_approval_required: Some(true), + ..Default::default() + }, + ) + .await; + assert!(matches!(result, PermissionResult::NoResult)); + } + #[tokio::test] async fn deny_all_handler_returns_denied() { let result = DenyAllHandler @@ -263,7 +447,29 @@ mod tests { .await; assert!(matches!( result, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); } + + #[test] + fn mcp_auth_result_token_converts_to_wire_response() { + let wire = McpAuthResult::Token { + access_token: "host-token".to_string(), + token_type: Some("Bearer".to_string()), + expires_in: Some(3600), + } + .into_wire(); + + match wire { + McpOauthPendingRequestResponse::Token(token) => { + assert_eq!(token.access_token, "host-token"); + assert_eq!(token.token_type.as_deref(), Some("Bearer")); + assert_eq!(token.expires_in, Some(3600)); + } + McpOauthPendingRequestResponse::Cancelled(_) => panic!("expected token response"), + } + } } diff --git a/rust/src/hooks.rs b/rust/src/hooks.rs index ec8cdfa3a..4986d6cb1 100644 --- a/rust/src/hooks.rs +++ b/rust/src/hooks.rs @@ -27,8 +27,8 @@ pub struct HookContext { pub struct PreToolUseInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -65,8 +65,8 @@ pub struct PreToolUseOutput { pub struct PreMcpToolCallInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -104,8 +104,8 @@ pub struct PreMcpToolCallOutput { pub struct PostToolUseInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -144,8 +144,8 @@ pub struct PostToolUseOutput { pub struct PostToolUseFailureInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -175,8 +175,8 @@ pub struct PostToolUseFailureOutput { pub struct UserPromptSubmittedInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -199,14 +199,40 @@ pub struct UserPromptSubmittedOutput { pub suppress_output: Option, } +/// Input for the `userPromptTransformed` hook. +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct UserPromptTransformedInput { + /// The runtime session ID of the session that triggered the hook. + pub session_id: String, + /// Unix timestamp in ms. + pub timestamp: f64, + /// Working directory. + #[serde(rename = "cwd")] + pub working_directory: PathBuf, + /// The prompt after any `userPromptSubmitted` hooks have run. + pub prompt: String, + /// The model-facing prompt after runtime transformations. + pub transformed_prompt: String, +} + +/// Output for the `userPromptTransformed` hook. +#[derive(Debug, Clone, Default, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct UserPromptTransformedOutput { + /// Replacement model-facing prompt to persist and send to the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub modified_transformed_prompt: Option, +} + /// Input for the `sessionStart` hook. #[derive(Debug, Clone, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SessionStartInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -235,8 +261,8 @@ pub struct SessionStartOutput { pub struct SessionEndInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -271,8 +297,8 @@ pub struct SessionEndOutput { pub struct ErrorOccurredInput { /// The runtime session ID of the session that triggered the hook. pub session_id: String, - /// Unix timestamp (ms). - pub timestamp: i64, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, /// Working directory. #[serde(rename = "cwd")] pub working_directory: PathBuf, @@ -302,6 +328,40 @@ pub struct ErrorOccurredOutput { pub user_notification: Option, } +/// Input for the `agentStop` hook, received when the top-level agent reaches a natural stop. +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentStopInput { + /// The runtime session ID of the session that triggered the hook. + pub session_id: String, + /// Unix timestamp in ms (the runtime serializes this as a JSON float). + pub timestamp: f64, + /// Working directory. + #[serde(rename = "cwd")] + pub working_directory: PathBuf, + /// Reason the agent stopped. + #[serde(default)] + pub stop_reason: Option, + /// Path to the on-disk session transcript. + #[serde(default)] + pub transcript_path: Option, + /// Whether this stop follows a previous block decision from the hook. + #[serde(default, rename = "stop_hook_active")] + pub stop_hook_active: Option, +} + +/// Output for the `agentStop` hook. +#[derive(Debug, Clone, Default, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct AgentStopOutput { + /// Set to `"block"` to keep the agent running. + #[serde(skip_serializing_if = "Option::is_none")] + pub decision: Option, + /// Follow-up instruction supplied when the stop is blocked. + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, +} + /// Events dispatched to [`SessionHooks::on_hook`] at CLI lifecycle points. /// /// Each variant carries the typed input for that hook plus the shared @@ -347,6 +407,13 @@ pub enum HookEvent { /// Session context. ctx: HookContext, }, + /// Fired after the runtime transforms a submitted prompt. + UserPromptTransformed { + /// Typed input data. + input: UserPromptTransformedInput, + /// Session context. + ctx: HookContext, + }, /// Fired at session creation or resume. SessionStart { /// Typed input data. @@ -368,6 +435,13 @@ pub enum HookEvent { /// Session context. ctx: HookContext, }, + /// Fired when the top-level agent reaches a natural stop. + AgentStop { + /// Typed input data. + input: AgentStopInput, + /// Session context. + ctx: HookContext, + }, } /// Response from [`SessionHooks::on_hook`] back to the SDK. @@ -389,12 +463,16 @@ pub enum HookOutput { PostToolUseFailure(PostToolUseFailureOutput), /// Response for a user-prompt-submitted hook. UserPromptSubmitted(UserPromptSubmittedOutput), + /// Response for a user-prompt-transformed hook. + UserPromptTransformed(UserPromptTransformedOutput), /// Response for a session-start hook. SessionStart(SessionStartOutput), /// Response for a session-end hook. SessionEnd(SessionEndOutput), /// Response for an error-occurred hook. ErrorOccurred(ErrorOccurredOutput), + /// Response for an agent-stop hook. + AgentStop(AgentStopOutput), } impl HookOutput { @@ -406,9 +484,11 @@ impl HookOutput { Self::PostToolUse(_) => "PostToolUse", Self::PostToolUseFailure(_) => "PostToolUseFailure", Self::UserPromptSubmitted(_) => "UserPromptSubmitted", + Self::UserPromptTransformed(_) => "UserPromptTransformed", Self::SessionStart(_) => "SessionStart", Self::SessionEnd(_) => "SessionEnd", Self::ErrorOccurred(_) => "ErrorOccurred", + Self::AgentStop(_) => "AgentStop", } } } @@ -462,6 +542,11 @@ pub trait SessionHooks: Send + Sync + 'static { .await .map(HookOutput::UserPromptSubmitted) .unwrap_or(HookOutput::None), + HookEvent::UserPromptTransformed { input, ctx } => self + .on_user_prompt_transformed(input, ctx) + .await + .map(HookOutput::UserPromptTransformed) + .unwrap_or(HookOutput::None), HookEvent::SessionStart { input, ctx } => self .on_session_start(input, ctx) .await @@ -477,6 +562,11 @@ pub trait SessionHooks: Send + Sync + 'static { .await .map(HookOutput::ErrorOccurred) .unwrap_or(HookOutput::None), + HookEvent::AgentStop { input, ctx } => self + .on_agent_stop(input, ctx) + .await + .map(HookOutput::AgentStop) + .unwrap_or(HookOutput::None), } } @@ -534,6 +624,16 @@ pub trait SessionHooks: Send + Sync + 'static { None } + /// Called after the runtime transforms a submitted prompt. Return + /// `Some(output)` to replace the model-facing content before it is stored. + async fn on_user_prompt_transformed( + &self, + _input: UserPromptTransformedInput, + _ctx: HookContext, + ) -> Option { + None + } + /// Called at session creation or resume. Return `Some(output)` to /// inject startup context. async fn on_session_start( @@ -563,6 +663,16 @@ pub trait SessionHooks: Send + Sync + 'static { ) -> Option { None } + + /// Called when the top-level agent reaches a natural stop. Return a block + /// decision to keep the agent running with a follow-up instruction. + async fn on_agent_stop( + &self, + _input: AgentStopInput, + _ctx: HookContext, + ) -> Option { + None + } } /// Dispatches a `hooks.invoke` request to [`SessionHooks::on_hook`]. @@ -601,6 +711,10 @@ pub(crate) async fn dispatch_hook( let input: UserPromptSubmittedInput = serde_json::from_value(raw_input)?; HookEvent::UserPromptSubmitted { input, ctx } } + "userPromptTransformed" => { + let input: UserPromptTransformedInput = serde_json::from_value(raw_input)?; + HookEvent::UserPromptTransformed { input, ctx } + } "sessionStart" => { let input: SessionStartInput = serde_json::from_value(raw_input)?; HookEvent::SessionStart { input, ctx } @@ -613,6 +727,10 @@ pub(crate) async fn dispatch_hook( let input: ErrorOccurredInput = serde_json::from_value(raw_input)?; HookEvent::ErrorOccurred { input, ctx } } + "agentStop" => { + let input: AgentStopInput = serde_json::from_value(raw_input)?; + HookEvent::AgentStop { input, ctx } + } _ => { tracing::warn!( hook_type = hook_type, @@ -645,9 +763,13 @@ pub(crate) async fn dispatch_hook( ("userPromptSubmitted", HookOutput::UserPromptSubmitted(o)) => { Some(serde_json::to_value(o)?) } + ("userPromptTransformed", HookOutput::UserPromptTransformed(o)) => { + Some(serde_json::to_value(o)?) + } ("sessionStart", HookOutput::SessionStart(o)) => Some(serde_json::to_value(o)?), ("sessionEnd", HookOutput::SessionEnd(o)) => Some(serde_json::to_value(o)?), ("errorOccurred", HookOutput::ErrorOccurred(o)) => Some(serde_json::to_value(o)?), + ("agentStop", HookOutput::AgentStop(o)) => Some(serde_json::to_value(o)?), _ => { tracing::warn!( hook_type = hook_type, @@ -689,6 +811,14 @@ mod tests { ..Default::default() }) } + HookEvent::UserPromptTransformed { input, .. } => { + HookOutput::UserPromptTransformed(UserPromptTransformedOutput { + modified_transformed_prompt: Some(format!( + "[transformed] {}", + input.transformed_prompt + )), + }) + } _ => HookOutput::None, } } @@ -749,6 +879,30 @@ mod tests { assert_eq!(result["output"]["modifiedPrompt"], "[prefixed] hello world"); } + #[tokio::test] + async fn dispatch_user_prompt_transformed() { + let hooks = TestHooks; + let input = serde_json::json!({ + "sessionId": "sess-1", + "timestamp": 1234567890, + "cwd": "/tmp", + "prompt": "hello world", + "transformedPrompt": "now\nhello world" + }); + let result = dispatch_hook( + &hooks, + &SessionId::new("sess-1"), + "userPromptTransformed", + input, + ) + .await + .unwrap(); + assert_eq!( + result["output"]["modifiedTransformedPrompt"], + "[transformed] now\nhello world" + ); + } + #[tokio::test] async fn dispatch_unregistered_hook_returns_empty() { let hooks = TestHooks; @@ -981,4 +1135,50 @@ mod tests { assert_eq!(result["output"]["errorHandling"], "retry"); assert_eq!(result["output"]["retryCount"], 3); } + + #[tokio::test] + async fn dispatch_agent_stop_block() { + struct AgentStopHooks; + #[async_trait] + impl SessionHooks for AgentStopHooks { + async fn on_agent_stop( + &self, + input: AgentStopInput, + ctx: HookContext, + ) -> Option { + assert_eq!(ctx.session_id, SessionId::new("sess-1")); + assert_eq!(input.session_id, "sess-1"); + assert_eq!(input.stop_reason.as_deref(), Some("end_turn")); + assert_eq!( + input.transcript_path, + Some(PathBuf::from("/tmp/transcript.jsonl")) + ); + assert_eq!(input.stop_hook_active, Some(true)); + Some(AgentStopOutput { + decision: Some("block".to_string()), + reason: Some("finish the remaining work".to_string()), + }) + } + } + + let input = serde_json::json!({ + "sessionId": "sess-1", + "timestamp": 1234567890, + "cwd": "/tmp", + "stopReason": "end_turn", + "transcriptPath": "/tmp/transcript.jsonl", + "stop_hook_active": true + }); + let result = dispatch_hook( + &AgentStopHooks, + &SessionId::new("sess-1"), + "agentStop", + input, + ) + .await + .unwrap(); + + assert_eq!(result["output"]["decision"], "block"); + assert_eq!(result["output"]["reason"], "finish the remaining work"); + } } diff --git a/rust/src/jsonrpc.rs b/rust/src/jsonrpc.rs index fbdc96505..25a405080 100644 --- a/rust/src/jsonrpc.rs +++ b/rust/src/jsonrpc.rs @@ -169,6 +169,68 @@ impl JsonRpcResponse { const CONTENT_LENGTH_HEADER: &str = "Content-Length: "; +/// Rewrites unpaired UTF-16 surrogate escapes to `\uFFFD`. +/// +/// Returns `None` when the body contains no unpaired surrogate, so valid +/// frames do not incur a repair allocation. +fn repair_lone_surrogates(body: &[u8]) -> Option> { + fn hex_escape_at(body: &[u8], index: usize) -> Option { + let digits = body.get(index + 2..index + 6)?; + let text = std::str::from_utf8(digits).ok()?; + u16::from_str_radix(text, 16).ok() + } + + let mut repaired = None; + let mut in_string = false; + let mut index = 0; + + while index < body.len() { + let byte = body[index]; + + if !in_string { + in_string = byte == b'"'; + index += 1; + continue; + } + + match byte { + b'"' => { + in_string = false; + index += 1; + } + // Consume non-Unicode escapes whole so an escaped backslash cannot + // be mistaken for the start of a surrogate escape. + b'\\' if body.get(index + 1) != Some(&b'u') => index += 2, + b'\\' => { + let Some(unit) = hex_escape_at(body, index) else { + index += 2; + continue; + }; + + let is_pair = (0xD800..0xDC00).contains(&unit) + && body.get(index + 6) == Some(&b'\\') + && body.get(index + 7) == Some(&b'u') + && hex_escape_at(body, index + 6) + .is_some_and(|low| (0xDC00..0xE000).contains(&low)); + + if is_pair { + index += 12; + continue; + } + + if (0xD800..0xE000).contains(&unit) { + let output = repaired.get_or_insert_with(|| body.to_vec()); + output[index..index + 6].copy_from_slice(br"\ufffd"); + } + index += 6; + } + _ => index += 1, + } + } + + repaired +} + /// One framed JSON-RPC message handed to the writer actor. /// /// `frame` is the fully serialized bytes (header + body); the caller pays @@ -428,8 +490,26 @@ impl JsonRpcClient { let mut body = vec![0u8; length]; reader.read_exact(&mut body).await?; - let message: JsonRpcMessage = serde_json::from_slice(&body)?; - Ok(Some(message)) + match serde_json::from_slice::(&body) { + Ok(message) => Ok(Some(message)), + Err(error) => { + // Dropping an undecodable frame could leave its pending + // request waiting forever because this layer has no timeout. + match repair_lone_surrogates(&body) + .and_then(|repaired| serde_json::from_slice::(&repaired).ok()) + { + Some(message) => { + warn!( + error = %error, + length, + "recovered JSON-RPC frame containing unpaired UTF-16 surrogates" + ); + Ok(Some(message)) + } + None => Err(error.into()), + } + } + } } /// Send a JSON-RPC request and wait for the matching response. diff --git a/rust/src/lib.rs b/rust/src/lib.rs index 515ab4a55..5c0674469 100644 --- a/rust/src/lib.rs +++ b/rust/src/lib.rs @@ -10,7 +10,18 @@ mod canvas_dispatch; #[cfg(feature = "bundled-cli")] pub(crate) mod embeddedcli; mod errors; +/// In-process FFI transport hosting the runtime cdylib (`Transport::InProcess`). +#[cfg(feature = "bundled-in-process")] +pub(crate) mod ffi; pub use errors::*; +/// Connection-level Copilot request handler — intercept and replace the +/// model-layer HTTP and WebSocket traffic the runtime issues for both CAPI and +/// BYOK sessions. +pub mod copilot_request_handler; +/// GitHub telemetry forwarding callback surface (experimental). Public but +/// `#[doc(hidden)]` — re-exports the generated telemetry payload types. +#[doc(hidden)] +pub mod github_telemetry; /// Event handler traits for session lifecycle. pub mod handler; /// Lifecycle hook callbacks (pre/post tool use, prompt submission, session start/end). @@ -18,6 +29,9 @@ pub mod hooks; mod jsonrpc; /// Permission-policy helpers that produce a [`handler::PermissionHandler`]. pub mod permission; +/// BYOK bearer-token provider callbacks. +pub mod provider_token; +mod provider_token_dispatch; /// GitHub Copilot CLI binary resolution (env var, embedded, dev cache). pub(crate) mod resolve; mod router; @@ -26,6 +40,8 @@ pub mod session; /// Custom session filesystem provider (virtualizable filesystem layer). pub mod session_fs; mod session_fs_dispatch; +/// Per-phase timing breakdown for [`Client::start`]. +pub mod startup_timings; /// Event subscription handles returned by `subscribe()` methods. pub mod subscription; /// Typed tool definition framework and dispatch router. @@ -38,8 +54,18 @@ pub mod transforms; pub mod types; mod wire; -/// Auto-generated protocol types from Copilot JSON Schemas. -pub mod generated; +/// Session event payload types — auto-generated from the protocol schema. +pub mod session_events; + +/// JSON-RPC request/response types and typed namespace builders for +/// [`Client::rpc`] and [`session::Session::rpc`](crate::session::Session::rpc). +pub mod rpc; + +// Auto-generated protocol-type modules. Crate-private so the only public +// access path is via the `session_events` and `rpc` facade modules above — +// callers can never depend on the implementation-detail layout under +// `generated::*`. +pub(crate) mod generated; /// Client-level mode ([`ClientMode`]) and the [`ToolSet`] builder for /// source-qualified tool filter patterns. @@ -49,15 +75,20 @@ use std::ffi::OsString; use std::path::{Path, PathBuf}; use std::process::Stdio; use std::sync::{Arc, OnceLock}; -use std::time::Instant; +use std::time::{Duration, Instant}; use async_trait::async_trait; -// JSON-RPC wire types are internal transport details (like Go SDK's internal/jsonrpc2/). +/// Re-export of [`indexmap::IndexMap`], used for order-preserving maps in the +/// public API (e.g. [`Tool::parameters`](types::Tool::parameters) and +/// `SessionConfig::mcp_servers`) so serialized key order stays deterministic. +pub use indexmap::IndexMap; +// JSON-RPC wire types are internal transport details. // External callers interact via Client/Session methods, not raw RPC. pub(crate) use jsonrpc::{ JsonRpcClient, JsonRpcError, JsonRpcNotification, JsonRpcRequest, JsonRpcResponse, error_codes, }; pub use mode::{BUILTIN_TOOLS_ISOLATED, ClientMode, ToolSet}; +pub use provider_token::{BearerTokenError, BearerTokenProvider, ProviderTokenArgs}; /// Re-exported JSON-RPC internals for integration tests (requires `test-support` feature). #[cfg(feature = "test-support")] @@ -77,18 +108,47 @@ pub use types::*; mod sdk_protocol_version; pub use sdk_protocol_version::{SDK_PROTOCOL_VERSION, get_sdk_protocol_version}; +pub use startup_timings::StartupTimings; pub use subscription::{EventSubscription, LifecycleSubscription}; /// Minimum protocol version this SDK can communicate with. const MIN_PROTOCOL_VERSION: u32 = 3; +const RUNTIME_SHUTDOWN_TIMEOUT: Duration = Duration::from_secs(10); + +fn record_optional_millis(span: &tracing::Span, field: &'static str, value: Option) { + match value { + Some(value) => { + span.record(field, value); + } + None => { + span.record(field, "None"); + } + } +} /// How the SDK communicates with the CLI server. #[derive(Debug, Default)] #[non_exhaustive] pub enum Transport { - /// Communicate over stdin/stdout pipes (default). + /// Resolve the transport from `COPILOT_SDK_DEFAULT_CONNECTION`, falling + /// back to [`Transport::Stdio`] when the variable is unset. #[default] + Default, + /// Communicate over stdin/stdout pipes (default). Stdio, + /// Host the runtime in-process over FFI (no child process). + /// + /// Loads the native runtime library and speaks JSON-RPC over its C ABI. + /// This is **experimental**. Per-client [`ClientOptions::program`], + /// [`ClientOptions::extra_args`], [`ClientOptions::working_directory`], + /// [`ClientOptions::env`]/[`ClientOptions::env_remove`], + /// and [`ClientOptions::telemetry`] are not supported because native + /// runtime code shares the host process. Typed runtime options such as + /// authentication, log level, and [`ClientOptions::base_directory`] remain + /// supported. + /// + /// Requires the `bundled-in-process` Cargo feature. + InProcess, /// Spawn the CLI with `--port` and connect via TCP. Tcp { /// Port to listen on (0 for OS-assigned). @@ -145,8 +205,10 @@ pub const HAS_BUNDLED_CLI: bool = cfg!(has_bundled_cli); /// it directly so callers (health checks, diagnostics, version probes) /// can reach the bundled binary without spinning up a full [`Client`]. /// -/// Subsequent calls return the cached result. Extraction is skipped -/// when the target file already exists. +/// Subsequent calls return the cached result. Extraction is skipped when +/// an already-published binary passes a cheap integrity re-check; a +/// truncated, empty, or antivirus-quarantined binary is re-extracted and +/// re-verified rather than returned. /// /// Returns `None` when the `bundled-cli` feature is off, the target /// platform isn't supported by `build.rs`, or extraction failed (the @@ -178,18 +240,25 @@ pub fn install_bundled_cli() -> Option { /// This skips auto-resolution entirely. #[non_exhaustive] pub struct ClientOptions { - /// How to locate the CLI binary. + /// How to locate the child-process runtime. pub program: CliProgram, /// Arguments prepended before `--server` (e.g. the script path for node). pub prefix_args: Vec, /// Working directory for the CLI process. + /// + /// Setting this option is not supported with [`Transport::InProcess`]. pub working_directory: PathBuf, /// Environment variables set on the child process. pub env: Vec<(OsString, OsString)>, /// Environment variable names to remove from the child process. pub env_remove: Vec, - /// Extra CLI flags appended after the transport-specific arguments. + /// Extra flags for child-process transports. pub extra_args: Vec, + /// Absolute paths to trusted plugin directories bundled by the host. + /// + /// When non-empty, [`Client::start`] replaces the runtime's complete + /// trusted built-in plugin directory set before sessions can be created. + pub builtin_plugin_directories: Vec, /// Transport mode used to communicate with the CLI server. pub transport: Transport, /// GitHub token for authentication. When set, the SDK passes the token @@ -227,6 +296,24 @@ pub struct ClientOptions { /// [`SessionFsProvider`] via /// [`SessionConfig::with_session_fs_provider`](crate::SessionConfig::with_session_fs_provider). pub session_fs: Option, + /// Connection-level Copilot request handler configuration. + /// + /// When set, the SDK registers itself as the runtime's request handler + /// during [`Client::start`], so the runtime routes its model-layer HTTP and + /// WebSocket traffic — for both CAPI and BYOK sessions — through the + /// configured + /// [`CopilotRequestHandler`] + /// instead of issuing the calls itself. + pub request_handler: Option>, + /// Connection-level GitHub telemetry forwarding callback (experimental). + /// + /// When set, every session created or resumed on this client opts into + /// telemetry forwarding (`enableGitHubTelemetryForwarding`) and the + /// callback is invoked for each `gitHubTelemetry.event` notification the + /// runtime forwards. `#[doc(hidden)]`, consistent with the experimental + /// telemetry payload types. + #[doc(hidden)] + pub on_github_telemetry: Option, /// Optional [`TraceContextProvider`] used to inject W3C Trace Context /// headers (`traceparent` / `tracestate`) on outbound `session.create`, /// `session.resume`, and `session.send` requests. @@ -286,6 +373,10 @@ impl std::fmt::Debug for ClientOptions { .field("env", &self.env) .field("env_remove", &self.env_remove) .field("extra_args", &self.extra_args) + .field( + "builtin_plugin_directories", + &self.builtin_plugin_directories, + ) .field("transport", &self.transport) .field( "github_token", @@ -302,6 +393,14 @@ impl std::fmt::Debug for ClientOptions { &self.on_list_models.as_ref().map(|_| ""), ) .field("session_fs", &self.session_fs) + .field( + "request_handler", + &self.request_handler.as_ref().map(|_| ""), + ) + .field( + "on_github_telemetry", + &self.on_github_telemetry.as_ref().map(|_| ""), + ) .field( "on_get_trace_context", &self.on_get_trace_context.as_ref().map(|_| ""), @@ -392,6 +491,32 @@ impl OtelExporterType { } } +/// OTLP HTTP protocol used by the CLI's OpenTelemetry OTLP exporter. +/// +/// Maps to the standard `OTEL_EXPORTER_OTLP_PROTOCOL` environment variable on +/// the spawned CLI process. Wire values are `"http/json"` and +/// `"http/protobuf"`. +#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)] +#[non_exhaustive] +pub enum OtlpHttpProtocol { + /// Export using OTLP/HTTP JSON. + #[serde(rename = "http/json")] + HttpJson, + /// Export using OTLP/HTTP protobuf. + #[serde(rename = "http/protobuf")] + HttpProtobuf, +} + +impl OtlpHttpProtocol { + /// Environment-variable value (`"http/json"` or `"http/protobuf"`). + pub fn as_str(self) -> &'static str { + match self { + Self::HttpJson => "http/json", + Self::HttpProtobuf => "http/protobuf", + } + } +} + /// OpenTelemetry configuration forwarded to the spawned GitHub Copilot CLI /// process. /// @@ -407,6 +532,7 @@ impl OtelExporterType { /// |----------------------|-------------------------------------------------------| /// | (any field set) | `COPILOT_OTEL_ENABLED=true` | /// | [`otlp_endpoint`] | `OTEL_EXPORTER_OTLP_ENDPOINT` | +/// | [`otlp_protocol`] | `OTEL_EXPORTER_OTLP_PROTOCOL` | /// | [`file_path`] | `COPILOT_OTEL_FILE_EXPORTER_PATH` | /// | [`exporter_type`] | `COPILOT_OTEL_EXPORTER_TYPE` | /// | [`source_name`] | `COPILOT_OTEL_SOURCE_NAME` | @@ -420,6 +546,7 @@ impl OtelExporterType { /// added without breaking callers. /// /// [`otlp_endpoint`]: Self::otlp_endpoint +/// [`otlp_protocol`]: Self::otlp_protocol /// [`file_path`]: Self::file_path /// [`exporter_type`]: Self::exporter_type /// [`source_name`]: Self::source_name @@ -429,6 +556,8 @@ impl OtelExporterType { pub struct TelemetryConfig { /// OTLP HTTP endpoint URL for trace/metric export. pub otlp_endpoint: Option, + /// OTLP HTTP protocol for all signals. + pub otlp_protocol: Option, /// File path for JSON-lines trace output. pub file_path: Option, /// Exporter backend type. Typically [`OtelExporterType::OtlpHttp`] or @@ -457,6 +586,12 @@ impl TelemetryConfig { self } + /// Set the OTLP HTTP protocol for all signals. + pub fn with_otlp_protocol(mut self, protocol: OtlpHttpProtocol) -> Self { + self.otlp_protocol = Some(protocol); + self + } + /// Set the file path for JSON-lines trace output. pub fn with_file_path(mut self, path: impl Into) -> Self { self.file_path = Some(path.into()); @@ -489,6 +624,7 @@ impl TelemetryConfig { /// to decide whether to set `COPILOT_OTEL_ENABLED`. pub fn is_empty(&self) -> bool { self.otlp_endpoint.is_none() + && self.otlp_protocol.is_none() && self.file_path.is_none() && self.exporter_type.is_none() && self.source_name.is_none() @@ -501,10 +637,11 @@ impl Default for ClientOptions { Self { program: CliProgram::Resolve, prefix_args: Vec::new(), - working_directory: std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")), + working_directory: PathBuf::new(), env: Vec::new(), env_remove: Vec::new(), extra_args: Vec::new(), + builtin_plugin_directories: Vec::new(), transport: Transport::default(), github_token: None, use_logged_in_user: None, @@ -512,6 +649,8 @@ impl Default for ClientOptions { session_idle_timeout_seconds: None, on_list_models: None, session_fs: None, + request_handler: None, + on_github_telemetry: None, on_get_trace_context: None, telemetry: None, base_directory: None, @@ -542,7 +681,7 @@ impl ClientOptions { Self::default() } - /// How to locate the CLI binary. See [`CliProgram`]. + /// How to locate the child-process runtime. See [`CliProgram`]. pub fn with_program(mut self, program: impl Into) -> Self { self.program = program.into(); self @@ -595,6 +734,19 @@ impl ClientOptions { self } + /// Set trusted plugin directories bundled by the host. + /// + /// Every path must be absolute; invalid paths are rejected by + /// [`Client::start`]. + pub fn with_builtin_plugin_directories(mut self, paths: I) -> Self + where + I: IntoIterator, + P: Into, + { + self.builtin_plugin_directories = paths.into_iter().map(Into::into).collect(); + self + } + /// Transport mode used to communicate with the CLI server. See [`Transport`]. pub fn with_transport(mut self, transport: Transport) -> Self { self.transport = transport; @@ -644,6 +796,32 @@ impl ClientOptions { self } + /// Register a connection-level Copilot request handler. The runtime will + /// route its model-layer HTTP and WebSocket traffic through the handler + /// configured here instead of issuing the calls itself. The handler is + /// wrapped in `Arc` internally. + pub fn with_request_handler(mut self, handler: H) -> Self + where + H: crate::copilot_request_handler::CopilotRequestHandler, + { + self.request_handler = Some(Arc::new(handler)); + self + } + + /// Register a connection-level GitHub telemetry forwarding callback + /// (internal/experimental). Registering a callback auto-enables telemetry + /// forwarding on every session created or resumed on this client; the + /// callback fires for each forwarded `gitHubTelemetry.event` notification. + /// The callback is wrapped in `Arc` internally. + #[doc(hidden)] + pub fn with_on_github_telemetry(mut self, callback: F) -> Self + where + F: Fn(crate::github_telemetry::GitHubTelemetryNotification) + Send + Sync + 'static, + { + self.on_github_telemetry = Some(Arc::new(callback)); + self + } + /// Set the [`TraceContextProvider`] used to inject W3C Trace Context /// headers on outbound `session.create` / `session.resume` / /// `session.send` requests. The provider is wrapped in `Arc` internally. @@ -734,6 +912,85 @@ fn generate_connection_token() -> String { hex } +/// Environment variable that overrides the transport used when the caller +/// leaves [`ClientOptions::transport`] at [`Transport::Default`]. +/// Accepts `"inprocess"` or `"stdio"` (case-insensitive); unset preserves +/// stdio. Any other value is an error. +const DEFAULT_CONNECTION_ENV_VAR: &str = "COPILOT_SDK_DEFAULT_CONNECTION"; + +/// Resolve a transport override from [`DEFAULT_CONNECTION_ENV_VAR`]. +fn resolve_default_transport(options: &ClientOptions) -> Result { + let configured = options + .env + .iter() + .find(|(key, _)| { + key.to_string_lossy() + .eq_ignore_ascii_case(DEFAULT_CONNECTION_ENV_VAR) + }) + .map(|(_, value)| value.to_string_lossy().into_owned()); + let process = std::env::var(DEFAULT_CONNECTION_ENV_VAR).ok(); + resolve_default_transport_value(configured.as_deref().or(process.as_deref())) +} + +fn resolve_default_transport_value(value: Option<&str>) -> Result { + match value { + None => Ok(Transport::Stdio), + Some(v) if v.is_empty() || v.eq_ignore_ascii_case("stdio") => Ok(Transport::Stdio), + Some(v) if v.eq_ignore_ascii_case("inprocess") => Ok(Transport::InProcess), + Some(v) => Err(Error::with_message( + ErrorKind::InvalidConfig, + format!( + "invalid {DEFAULT_CONNECTION_ENV_VAR} value '{v}'. \ + Expected 'inprocess', 'stdio', or unset." + ), + )), + } +} + +#[cfg(any(feature = "bundled-in-process", test))] +fn validate_inprocess_options(options: &ClientOptions) -> Result<()> { + if !matches!(&options.program, CliProgram::Resolve) { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + "ClientOptions::program is not supported with Transport::InProcess; \ + set COPILOT_CLI_PATH only when using an externally provisioned runtime package", + )); + } + if !options.extra_args.is_empty() { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + "ClientOptions::extra_args is not supported with Transport::InProcess; \ + use typed client options instead", + )); + } + + let unsupported = if !options.working_directory.as_os_str().is_empty() { + Some("working_directory") + } else if !options.env.is_empty() { + Some("env") + } else if !options.env_remove.is_empty() { + Some("env_remove") + } else if options.telemetry.is_some() { + Some("telemetry") + } else if !options.prefix_args.is_empty() { + Some("prefix_args") + } else { + None + }; + + if let Some(option) = unsupported { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + format!( + "ClientOptions::{option} is not supported with Transport::InProcess; \ + configure process-global settings on the host process instead" + ), + )); + } + + Ok(()) +} + /// Connection to a GitHub Copilot CLI server (stdio, TCP, or external). /// /// Cheaply cloneable — cloning shares the underlying connection. @@ -754,6 +1011,10 @@ impl std::fmt::Debug for Client { struct ClientInner { child: parking_lot::Mutex>, + #[cfg(feature = "bundled-in-process")] + /// In-process FFI runtime host, set only for [`Transport::InProcess`]. + /// Closing it tears down the native runtime connection. + ffi_host: parking_lot::Mutex>>, rpc: JsonRpcClient, cwd: PathBuf, request_rx: parking_lot::Mutex>>, @@ -766,6 +1027,14 @@ struct ClientInner { models_cache: parking_lot::Mutex>>>, session_fs_configured: bool, session_fs_sqlite_declared: bool, + /// Inbound `llmInference.*` dispatcher, installed when + /// [`ClientOptions::request_handler`] is set. + llm_inference: OnceLock>, + /// Connection-level GitHub telemetry forwarding callback, set from + /// [`ClientOptions::on_github_telemetry`]. Drives the + /// `enableGitHubTelemetryForwarding` wire flag and the + /// `gitHubTelemetry.event` notification dispatch. + on_github_telemetry: Option, on_get_trace_context: Option>, /// Token sent in the `connect` handshake. Auto-generated when the /// SDK spawns its own CLI in TCP mode and no explicit token is set; @@ -775,6 +1044,10 @@ struct ClientInner { /// SDK [`ClientMode`] captured at start time. Drives empty-mode safe /// defaults inside `create_session` / `resume_session`. pub(crate) mode: ClientMode, + /// Per-phase startup timing breakdown, populated once at the end of + /// [`Client::start`]. Empty for clients built via [`Client::from_streams`] + /// or [`Client::from_transport`] directly. + startup_timings: OnceLock, } impl Client { @@ -792,6 +1065,22 @@ impl Client { /// backend. pub async fn start(options: ClientOptions) -> Result { let start_time = Instant::now(); + let mut timings = StartupTimings::default(); + let mut options = options; + if matches!(options.transport, Transport::Default) { + options.transport = resolve_default_transport(&options)?; + } + if matches!(options.transport, Transport::InProcess) { + #[cfg(not(feature = "bundled-in-process"))] + { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + "Transport::InProcess requires the `bundled-in-process` Cargo feature", + )); + } + #[cfg(feature = "bundled-in-process")] + validate_inprocess_options(&options)?; + } if options.mode == ClientMode::Empty && options.base_directory.is_none() && options.session_fs.is_none() @@ -805,6 +1094,30 @@ impl Client { if let Some(cfg) = &options.session_fs { validate_session_fs_config(cfg)?; } + let builtin_plugin_directories = options + .builtin_plugin_directories + .iter() + .map(|path| { + if !path.is_absolute() { + return Err(Error::with_message( + ErrorKind::InvalidConfig, + format!( + "builtin_plugin_directories must contain only absolute paths: {}", + path.display() + ), + )); + } + path.to_str().map(str::to_owned).ok_or_else(|| { + Error::with_message( + ErrorKind::InvalidConfig, + format!( + "builtin_plugin_directories must contain valid UTF-8 paths: {}", + path.display() + ), + ) + }) + }) + .collect::>>()?; // Auth options only make sense when the SDK spawns the CLI; with an // external server, the server manages its own auth. if matches!(options.transport, Transport::External { .. }) { @@ -846,9 +1159,9 @@ impl Client { // to the server. For Tcp, the SDK auto-generates one when the // caller leaves it unset so the loopback listener is safe by // default. - let mut options = options; let effective_connection_token: Option = match &mut options.transport { - Transport::Stdio => None, + Transport::Default => unreachable!("default transport resolved above"), + Transport::Stdio | Transport::InProcess => None, Transport::Tcp { connection_token, .. } => Some( @@ -861,6 +1174,7 @@ impl Client { } => connection_token.clone(), }; let session_fs_config = options.session_fs.clone(); + let request_handler = options.request_handler.clone(); let session_fs_sqlite_declared = session_fs_config .as_ref() .and_then(|c| c.capabilities.as_ref()) @@ -871,9 +1185,16 @@ impl Client { path.clone() } CliProgram::Resolve => { + let resolve_start = Instant::now(); let resolved = resolve::copilot_binary_with_extract_dir( options.bundled_cli_extract_dir.as_deref(), )?; + let resolve_elapsed = resolve_start.elapsed(); + timings.program_resolve_ms = Some(StartupTimings::millis(resolve_elapsed)); + debug!( + elapsed_ms = resolve_elapsed.as_millis(), + "Client::start CLI program resolution complete" + ); info!(path = %resolved.display(), "resolved copilot CLI"); #[cfg(windows)] { @@ -891,8 +1212,18 @@ impl Client { resolved } }; + let working_directory = { + let cwd = options.working_directory.clone(); + if cwd.as_os_str().is_empty() { + std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")) + } else { + cwd + } + }; + let transport_setup_start = Instant::now(); let client = match options.transport { + Transport::Default => unreachable!("default transport resolved above"), Transport::External { ref host, port, @@ -912,11 +1243,12 @@ impl Client { reader, writer, None, - options.working_directory, + working_directory, options.on_list_models, session_fs_config.is_some(), session_fs_sqlite_declared, options.on_get_trace_context, + options.on_github_telemetry, effective_connection_token.clone(), options.mode, )? @@ -925,7 +1257,10 @@ impl Client { port, connection_token: _, } => { - let (mut child, actual_port) = Self::spawn_tcp(&program, &options, port).await?; + let (mut child, actual_port, spawn_elapsed, port_wait_elapsed) = + Self::spawn_tcp(&program, &options, &working_directory, port).await?; + timings.process_spawn_ms = Some(StartupTimings::millis(spawn_elapsed)); + timings.port_wait_ms = Some(StartupTimings::millis(port_wait_elapsed)); let connect_start = Instant::now(); let stream = TcpStream::connect(("127.0.0.1", actual_port)).await?; debug!( @@ -939,17 +1274,20 @@ impl Client { reader, writer, Some(child), - options.working_directory, + working_directory, options.on_list_models, session_fs_config.is_some(), session_fs_sqlite_declared, options.on_get_trace_context, + options.on_github_telemetry, effective_connection_token.clone(), options.mode, )? } Transport::Stdio => { - let mut child = Self::spawn_stdio(&program, &options)?; + let (mut child, spawn_elapsed) = + Self::spawn_stdio(&program, &options, &working_directory)?; + timings.process_spawn_ms = Some(StartupTimings::millis(spawn_elapsed)); let stdin = child.stdin.take().expect("stdin is piped"); let stdout = child.stdout.take().expect("stdout is piped"); Self::drain_stderr(&mut child); @@ -957,26 +1295,99 @@ impl Client { stdout, stdin, Some(child), - options.working_directory, + working_directory, options.on_list_models, session_fs_config.is_some(), session_fs_sqlite_declared, options.on_get_trace_context, + options.on_github_telemetry, effective_connection_token.clone(), options.mode, )? } + Transport::InProcess => { + #[cfg(feature = "bundled-in-process")] + { + info!(runtime_path = %program.display(), "hosting copilot runtime in-process (FFI)"); + let mut environment = Vec::new(); + if let Some(base_directory) = &options.base_directory { + let value = base_directory.to_str().ok_or_else(|| { + Error::with_message( + ErrorKind::InvalidConfig, + "base_directory must be valid UTF-8 for Transport::InProcess", + ) + })?; + environment.push(("COPILOT_HOME".to_string(), value.to_string())); + } + if options.mode == ClientMode::Empty { + environment.push(("COPILOT_DISABLE_KEYTAR".to_string(), "1".to_string())); + } + if let Some(github_token) = &options.github_token { + environment + .push(("COPILOT_SDK_AUTH_TOKEN".to_string(), github_token.clone())); + } + let mut args = Vec::new(); + args.extend( + Self::log_level_args(&options) + .into_iter() + .map(str::to_string), + ); + args.extend(Self::session_idle_timeout_args(&options)); + args.extend(Self::remote_args(&options)); + if options.github_token.is_some() { + args.extend([ + "--auth-token-env".to_string(), + "COPILOT_SDK_AUTH_TOKEN".to_string(), + ]); + } + let use_logged_in_user = options + .use_logged_in_user + .unwrap_or(options.github_token.is_none()); + if !use_logged_in_user { + args.push("--no-auto-login".to_string()); + } + let host = crate::ffi::FfiHost::create(&program, environment, args)?; + let (reader, writer, shared) = host.start().await?; + let client = Self::from_transport( + reader, + writer, + None, + working_directory, + options.on_list_models, + session_fs_config.is_some(), + session_fs_sqlite_declared, + options.on_get_trace_context, + options.on_github_telemetry, + effective_connection_token.clone(), + options.mode, + )?; + *client.inner.ffi_host.lock() = Some(shared); + client + } + #[cfg(not(feature = "bundled-in-process"))] + unreachable!("in-process feature validation returned above") + } }; - + timings.transport_setup_ms = StartupTimings::millis(transport_setup_start.elapsed()); debug!( elapsed_ms = start_time.elapsed().as_millis(), "Client::start transport setup complete" ); + let handshake_start = Instant::now(); client.verify_protocol_version().await?; + timings.handshake_ms = StartupTimings::millis(handshake_start.elapsed()); debug!( elapsed_ms = start_time.elapsed().as_millis(), "Client::start protocol verification complete" ); + if !builtin_plugin_directories.is_empty() { + client + .call( + "plugins.builtin.set", + Some(serde_json::json!({ "paths": builtin_plugin_directories })), + ) + .await?; + } if let Some(cfg) = session_fs_config { let session_fs_start = Instant::now(); let capabilities = cfg.capabilities.as_ref().map(|c| { @@ -991,11 +1402,61 @@ impl Client { session_state_path: cfg.session_state_path, }; client.rpc().session_fs().set_provider(request).await?; + let session_fs_elapsed = session_fs_start.elapsed(); + timings.session_fs_ms = Some(StartupTimings::millis(session_fs_elapsed)); debug!( - elapsed_ms = session_fs_start.elapsed().as_millis(), + elapsed_ms = session_fs_elapsed.as_millis(), "Client::start session filesystem setup complete" ); } + if let Some(handler) = request_handler { + let llm_inference_start = Instant::now(); + let dispatcher = Arc::new(copilot_request_handler::CopilotRequestDispatcher::new( + handler, + )); + dispatcher.set_client(Arc::downgrade(&client.inner)); + let _ = client.inner.llm_inference.set(dispatcher.clone()); + // Start the router early (before any session is registered) so the + // startup model catalog request is dispatched to the handler. + client.inner.router.ensure_started( + &client.inner.notification_tx, + &client.inner.request_rx, + Some(dispatcher.clone()), + client.inner.on_github_telemetry.clone(), + ); + client.rpc().llm_inference().set_provider().await?; + let llm_inference_elapsed = llm_inference_start.elapsed(); + timings.llm_handler_ms = Some(StartupTimings::millis(llm_inference_elapsed)); + debug!( + elapsed_ms = llm_inference_elapsed.as_millis(), + "Client::start Copilot request handler registration complete" + ); + } + timings.total_ms = StartupTimings::millis(start_time.elapsed()); + // A span allows optional fields to retain their numeric type when + // present while recording an explicit "None" when a phase did not run. + let timings_span = tracing::debug_span!( + "Client::start timings", + program_resolve_ms = tracing::field::Empty, + process_spawn_ms = tracing::field::Empty, + port_wait_ms = tracing::field::Empty, + transport_setup_ms = timings.transport_setup_ms, + handshake_ms = timings.handshake_ms, + session_fs_ms = tracing::field::Empty, + llm_handler_ms = tracing::field::Empty, + total_ms = timings.total_ms, + ); + record_optional_millis( + &timings_span, + "program_resolve_ms", + timings.program_resolve_ms, + ); + record_optional_millis(&timings_span, "process_spawn_ms", timings.process_spawn_ms); + record_optional_millis(&timings_span, "port_wait_ms", timings.port_wait_ms); + record_optional_millis(&timings_span, "session_fs_ms", timings.session_fs_ms); + record_optional_millis(&timings_span, "llm_handler_ms", timings.llm_handler_ms); + timings_span.in_scope(|| debug!("Client::start timings")); + let _ = client.inner.startup_timings.set(timings); debug!( elapsed_ms = start_time.elapsed().as_millis(), "Client::start complete" @@ -1021,6 +1482,7 @@ impl Client { false, None, None, + None, ClientMode::default(), ) } @@ -1049,6 +1511,7 @@ impl Client { false, Some(provider), None, + None, ClientMode::default(), ) } @@ -1072,11 +1535,37 @@ impl Client { false, false, None, + None, token, ClientMode::default(), ) } + /// Construct a [`Client`] from raw streams with a preset GitHub telemetry + /// callback, for integration testing telemetry forwarding. + #[doc(hidden)] + #[cfg(any(test, feature = "test-support"))] + pub fn from_streams_with_github_telemetry( + reader: impl AsyncRead + Unpin + Send + 'static, + writer: impl AsyncWrite + Unpin + Send + 'static, + cwd: PathBuf, + on_github_telemetry: crate::github_telemetry::GitHubTelemetryCallback, + ) -> Result { + Self::from_transport( + reader, + writer, + None, + cwd, + None, + false, + false, + None, + Some(on_github_telemetry), + None, + ClientMode::default(), + ) + } + /// Public test-only wrapper around the random connection-token /// generator used by [`Client::start`] when the SDK spawns a TCP /// server without an explicit token. Lets integration tests @@ -1097,6 +1586,7 @@ impl Client { session_fs_configured: bool, session_fs_sqlite_declared: bool, on_get_trace_context: Option>, + on_github_telemetry: Option, effective_connection_token: Option, mode: ClientMode, ) -> Result { @@ -1116,6 +1606,8 @@ impl Client { let client = Self { inner: Arc::new(ClientInner { child: parking_lot::Mutex::new(child), + #[cfg(feature = "bundled-in-process")] + ffi_host: parking_lot::Mutex::new(None), rpc, cwd, request_rx: parking_lot::Mutex::new(Some(request_rx)), @@ -1128,9 +1620,12 @@ impl Client { models_cache: parking_lot::Mutex::new(Arc::new(tokio::sync::OnceCell::new())), session_fs_configured, session_fs_sqlite_declared, + llm_inference: OnceLock::new(), + on_github_telemetry, on_get_trace_context, effective_connection_token, mode, + startup_timings: OnceLock::new(), }), }; client.spawn_lifecycle_dispatcher(); @@ -1146,8 +1641,8 @@ impl Client { /// notifications via [`ClientInner::lifecycle_tx`] to subscribers /// returned by [`Self::subscribe_lifecycle`]. fn spawn_lifecycle_dispatcher(&self) { - let inner = Arc::clone(&self.inner); - let mut notif_rx = inner.notification_tx.subscribe(); + let mut notif_rx = self.inner.notification_tx.subscribe(); + let lifecycle_tx = self.inner.lifecycle_tx.clone(); tokio::spawn(async move { loop { match notif_rx.recv().await { @@ -1171,7 +1666,7 @@ impl Client { }; // `send` only errors when there are no subscribers — that's // the normal case before any consumer calls subscribe_lifecycle. - let _ = inner.lifecycle_tx.send(event); + let _ = lifecycle_tx.send(event); } Err(tokio::sync::broadcast::error::RecvError::Lagged(n)) => { warn!(missed = n, "lifecycle dispatcher lagged"); @@ -1182,8 +1677,9 @@ impl Client { }); } - fn build_command(program: &Path, options: &ClientOptions) -> Command { + fn build_command(program: &Path, options: &ClientOptions, working_directory: &Path) -> Command { let mut command = Command::new(program); + command.kill_on_drop(true); for arg in &options.prefix_args { command.arg(arg); } @@ -1199,6 +1695,9 @@ impl Client { if let Some(endpoint) = &telemetry.otlp_endpoint { command.env("OTEL_EXPORTER_OTLP_ENDPOINT", endpoint); } + if let Some(protocol) = telemetry.otlp_protocol { + command.env("OTEL_EXPORTER_OTLP_PROTOCOL", protocol.as_str()); + } if let Some(path) = &telemetry.file_path { command.env("COPILOT_OTEL_FILE_EXPORTER_PATH", path); } @@ -1237,7 +1736,7 @@ impl Client { command.env_remove(key); } command - .current_dir(&options.working_directory) + .current_dir(working_directory) .stdout(Stdio::piped()) .stderr(Stdio::piped()); @@ -1300,9 +1799,13 @@ impl Client { } } - fn spawn_stdio(program: &Path, options: &ClientOptions) -> Result { - info!(cwd = ?options.working_directory, program = %program.display(), "spawning copilot CLI (stdio)"); - let mut command = Self::build_command(program, options); + fn spawn_stdio( + program: &Path, + options: &ClientOptions, + working_directory: &Path, + ) -> Result<(Child, Duration)> { + info!(cwd = ?working_directory, program = %program.display(), "spawning copilot CLI (stdio)"); + let mut command = Self::build_command(program, options, working_directory); command .args(["--server", "--stdio", "--no-auto-update"]) .args(Self::log_level_args(options)) @@ -1313,16 +1816,22 @@ impl Client { .stdin(Stdio::piped()); let spawn_start = Instant::now(); let child = command.spawn()?; + let spawn_elapsed = spawn_start.elapsed(); debug!( - elapsed_ms = spawn_start.elapsed().as_millis(), + elapsed_ms = spawn_elapsed.as_millis(), "Client::spawn_stdio subprocess spawned" ); - Ok(child) + Ok((child, spawn_elapsed)) } - async fn spawn_tcp(program: &Path, options: &ClientOptions, port: u16) -> Result<(Child, u16)> { - info!(cwd = ?options.working_directory, program = %program.display(), port = %port, "spawning copilot CLI (tcp)"); - let mut command = Self::build_command(program, options); + async fn spawn_tcp( + program: &Path, + options: &ClientOptions, + working_directory: &Path, + port: u16, + ) -> Result<(Child, u16, Duration, Duration)> { + info!(cwd = ?working_directory, program = %program.display(), port = %port, "spawning copilot CLI (tcp)"); + let mut command = Self::build_command(program, options, working_directory); command .args(["--server", "--port", &port.to_string(), "--no-auto-update"]) .args(Self::log_level_args(options)) @@ -1333,8 +1842,9 @@ impl Client { .stdin(Stdio::null()); let spawn_start = Instant::now(); let mut child = command.spawn()?; + let spawn_elapsed = spawn_start.elapsed(); debug!( - elapsed_ms = spawn_start.elapsed().as_millis(), + elapsed_ms = spawn_elapsed.as_millis(), "Client::spawn_tcp subprocess spawned" ); let stdout = child.stdout.take().expect("stdout is piped"); @@ -1371,13 +1881,14 @@ impl Client { .map_err(|_| Error::from(ErrorKind::Protocol(ProtocolErrorKind::CliStartupTimeout)))? .map_err(|_| Error::from(ErrorKind::Protocol(ProtocolErrorKind::CliStartupFailed)))?; + let port_wait_elapsed = port_wait_start.elapsed(); debug!( - elapsed_ms = port_wait_start.elapsed().as_millis(), + elapsed_ms = port_wait_elapsed.as_millis(), port = actual_port, "Client::spawn_tcp TCP port wait complete" ); info!(port = %actual_port, "CLI server listening"); - Ok((child, actual_port)) + Ok((child, actual_port, spawn_elapsed, port_wait_elapsed)) } fn drain_stderr(child: &mut Child) { @@ -1506,6 +2017,11 @@ impl Client { self.inner.rpc.write(response).await } + /// Reconstruct a [`Client`] handle from a shared inner pointer. + pub(crate) fn from_inner(inner: Arc) -> Self { + Self { inner } + } + /// Take the receiver for incoming JSON-RPC requests from the CLI. /// /// Can only be called once — subsequent calls return `None`. @@ -1525,9 +2041,12 @@ impl Client { &self, session_id: &SessionId, ) -> crate::router::SessionChannels { - self.inner - .router - .ensure_started(&self.inner.notification_tx, &self.inner.request_rx); + self.inner.router.ensure_started( + &self.inner.notification_tx, + &self.inner.request_rx, + self.inner.llm_inference.get().cloned(), + self.inner.on_github_telemetry.clone(), + ); self.inner.router.register(session_id) } @@ -1546,6 +2065,16 @@ impl Client { self.inner.negotiated_protocol_version.get().copied() } + /// Returns the per-phase [`StartupTimings`] breakdown captured during + /// [`start`](Self::start), if available. + /// + /// Returns `None` for clients created via + /// [`from_streams`](Self::from_streams), which bypasses the timed startup + /// sequence. + pub fn startup_timings(&self) -> Option { + self.inner.startup_timings.get().cloned() + } + /// Verify the CLI server's protocol version is within the supported range. /// /// Called automatically by [`start`](Self::start). Call manually after @@ -1627,13 +2156,26 @@ impl Client { /// param. Server-side, the token is required when the server was /// started with `COPILOT_CONNECTION_TOKEN`. async fn connect_handshake(&self) -> Result> { - let result = self - .rpc() - .connect(crate::generated::api_types::ConnectRequest { - token: self.inner.effective_connection_token.clone(), - }) + let params = crate::generated::api_types::ConnectRequest { + token: self.inner.effective_connection_token.clone(), + enable_git_hub_telemetry_forwarding: self + .inner + .on_github_telemetry + .is_some() + .then_some(true), + }; + let value = self + .call( + crate::generated::api_types::rpc_methods::CONNECT, + Some(serde_json::to_value(params)?), + ) .await?; - Ok(u32::try_from(result.protocol_version).ok()) + let result: crate::generated::api_types::ConnectResult = serde_json::from_value(value)?; + Ok(Some(u32::try_from(result.protocol_version).map_err( + |_| ProtocolErrorKind::InvalidProtocolVersion { + server: result.protocol_version, + }, + )?)) } /// Send a `ping` RPC and return the typed [`PingResponse`]. @@ -1710,6 +2252,60 @@ impl Client { Ok(()) } + /// Start this client's notification and request router on the current runtime. + /// This is test-harness plumbing, not part of the supported SDK API. + #[cfg(feature = "test-support")] + #[doc(hidden)] + pub fn start_router_for_test(&self) { + self.inner.router.ensure_started( + &self.inner.notification_tx, + &self.inner.request_rx, + self.inner.llm_inference.get().cloned(), + self.inner.on_github_telemetry.clone(), + ); + } + + #[cfg(feature = "test-support")] + #[doc(hidden)] + /// Disconnect and delete every session owned by this test client's isolated + /// runtime. This is test-harness plumbing, not part of the supported SDK API. + pub async fn cleanup_sessions_for_test(&self) -> Result<()> { + let mut first_error = None; + + for session_id in self.inner.router.session_ids() { + if let Err(error) = self + .call( + "session.destroy", + Some(serde_json::json!({ "sessionId": session_id })), + ) + .await + && first_error.is_none() + { + first_error = Some(error); + } + self.inner.router.unregister(&session_id); + } + + match self.list_sessions(None).await { + Ok(sessions) => { + for session in sessions { + if let Err(error) = self.delete_session(&session.session_id).await + && first_error.is_none() + { + first_error = Some(error); + } + } + } + Err(error) if first_error.is_none() => first_error = Some(error), + Err(_) => {} + } + + match first_error { + Some(error) => Err(error), + None => Ok(()), + } + } + /// Return the ID of the most recently updated session, if any. /// /// Useful for resuming the last conversation when the session ID was @@ -1808,8 +2404,9 @@ impl Client { /// Cooperatively shut down the client and the CLI child process. /// /// Walks every still-registered session and sends `session.destroy` - /// for each one, then kills the CLI child. Errors from per-session - /// destroys and the final child-kill are collected into + /// for each one, asks SDK-owned runtimes to shut down, then kills the + /// CLI child. Errors from per-session destroys, runtime shutdown, and + /// the final child-kill are collected into /// [`StopErrors`] rather than short-circuiting on the first failure /// — so callers see the full picture of teardown. /// @@ -1858,13 +2455,74 @@ impl Client { self.inner.router.unregister(&session_id); } + let should_shutdown_runtime = self.inner.child.lock().is_some(); + #[cfg(feature = "bundled-in-process")] + let should_shutdown_runtime = + should_shutdown_runtime || self.inner.ffi_host.lock().is_some(); + if should_shutdown_runtime { + let runtime_shutdown_start = Instant::now(); + match tokio::time::timeout(RUNTIME_SHUTDOWN_TIMEOUT, self.rpc().runtime().shutdown()) + .await + { + Ok(Ok(())) => { + debug!( + elapsed_ms = runtime_shutdown_start.elapsed().as_millis(), + "Client::stop runtime shutdown complete" + ); + } + Ok(Err(e)) => { + warn!( + elapsed_ms = runtime_shutdown_start.elapsed().as_millis(), + error = %e, + "runtime.shutdown failed during Client::stop", + ); + errors.push(e); + } + Err(_) => { + let e = std::io::Error::new( + std::io::ErrorKind::TimedOut, + "runtime.shutdown timed out during Client::stop", + ); + warn!( + elapsed_ms = runtime_shutdown_start.elapsed().as_millis(), + timeout = ?RUNTIME_SHUTDOWN_TIMEOUT, + error = %e, + "runtime.shutdown timed out during Client::stop", + ); + errors.push(e.into()); + } + } + } + let child = self.inner.child.lock().take(); *self.inner.state.lock() = ConnectionState::Disconnected; *self.inner.models_cache.lock() = Arc::new(tokio::sync::OnceCell::new()); - if let Some(mut child) = child - && let Err(e) = child.kill().await + if let Some(mut child) = child { + match child.try_wait() { + Ok(Some(_status)) => {} + Ok(None) => { + // The runtime completes all cleanup before responding to + // runtime.shutdown and then leaves termination to us; it + // deliberately keeps its JSON-RPC server alive to send the + // response and never self-exits. Waiting for a self-exit + // that will never come just wastes time, so terminate the + // child immediately. + if let Err(e) = child.kill().await { + errors.push(e.into()); + } + } + Err(e) => errors.push(e.into()), + } + } + + // The runtime.shutdown RPC above already asked the runtime to clean up; + // closing here tears down the transport. + #[cfg(feature = "bundled-in-process")] { - errors.push(e.into()); + if let Some(host) = self.inner.ffi_host.lock().take() { + self.inner.rpc.force_close(); + host.close(); + } } info!(pid = ?pid, errors = errors.len(), "CLI process stopped"); @@ -1913,6 +2571,12 @@ impl Client { error!(pid = ?pid, error = %e, "failed to send kill signal"); } self.inner.rpc.force_close(); + #[cfg(feature = "bundled-in-process")] + { + if let Some(host) = self.inner.ffi_host.lock().take() { + host.close(); + } + } // Drop all session channels so any awaiters see a closed channel // instead of waiting for responses that will never arrive. self.inner.router.clear(); @@ -1969,6 +2633,13 @@ impl Drop for ClientInner { info!(pid = ?pid, "kill signal sent for CLI process on drop"); } } + #[cfg(feature = "bundled-in-process")] + { + if let Some(host) = self.ffi_host.lock().take() { + self.rpc.force_close(); + host.close(); + } + } } } @@ -2033,6 +2704,63 @@ mod tests { assert!(opts.enable_remote_sessions); } + #[test] + fn default_transport_values_resolve_without_process_state() { + assert!(matches!( + resolve_default_transport_value(None).unwrap(), + Transport::Stdio + )); + assert!(matches!( + resolve_default_transport_value(Some("stdio")).unwrap(), + Transport::Stdio + )); + assert!(matches!( + resolve_default_transport_value(Some("INPROCESS")).unwrap(), + Transport::InProcess + )); + assert!(resolve_default_transport_value(Some("tcp")).is_err()); + } + + #[test] + fn inprocess_rejects_process_scoped_options() { + let invalid = [ + ClientOptions::new().with_cwd("."), + ClientOptions::new().with_env([("KEY", "value")]), + ClientOptions::new().with_env_remove(["KEY"]), + ClientOptions::new().with_telemetry(TelemetryConfig::default()), + ClientOptions::new().with_prefix_args(["index.js"]), + ClientOptions::new().with_program(CliProgram::Path("copilot".into())), + ClientOptions::new().with_extra_args(["--verbose"]), + ]; + + for options in invalid { + assert!(validate_inprocess_options(&options).is_err()); + } + } + + #[test] + fn inprocess_allows_typed_runtime_options() { + let options = ClientOptions::new() + .with_base_directory("state") + .with_log_level(LogLevel::Debug) + .with_session_idle_timeout_seconds(10) + .with_github_token("token") + .with_use_logged_in_user(false) + .with_enable_remote_sessions(true); + + assert!(validate_inprocess_options(&options).is_ok()); + } + + #[cfg(not(feature = "bundled-in-process"))] + #[tokio::test] + async fn inprocess_requires_cargo_feature() { + let error = Client::start(ClientOptions::new().with_transport(Transport::InProcess)) + .await + .unwrap_err(); + + assert!(error.to_string().contains("bundled-in-process")); + } + #[test] fn is_transport_failure_rejects_other_protocol_errors() { let err = Error::from(ErrorKind::Protocol(ProtocolErrorKind::CliStartupTimeout)); @@ -2046,7 +2774,7 @@ mod tests { env_remove: vec![std::ffi::OsString::from("COPILOT_SDK_AUTH_TOKEN")], ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); // get_envs() iter yields the latest action per key — None means removed. let action = cmd .as_std() @@ -2070,7 +2798,7 @@ mod tests { )], ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); let value = cmd .as_std() .get_envs() @@ -2085,7 +2813,7 @@ mod tests { github_token: Some("just-the-token".to_string()), ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); let value = cmd .as_std() .get_envs() @@ -2105,12 +2833,14 @@ mod tests { fn telemetry_config_builder_composes() { let cfg = TelemetryConfig::new() .with_otlp_endpoint("http://collector:4318") + .with_otlp_protocol(OtlpHttpProtocol::HttpProtobuf) .with_file_path(PathBuf::from("/var/log/copilot.jsonl")) .with_exporter_type(OtelExporterType::OtlpHttp) .with_source_name("my-app") .with_capture_content(true); assert_eq!(cfg.otlp_endpoint.as_deref(), Some("http://collector:4318")); + assert_eq!(cfg.otlp_protocol, Some(OtlpHttpProtocol::HttpProtobuf)); assert_eq!( cfg.file_path.as_deref(), Some(Path::new("/var/log/copilot.jsonl")), @@ -2122,11 +2852,28 @@ mod tests { assert!(TelemetryConfig::new().is_empty()); } + #[test] + fn otlp_http_protocol_serde_matches_env_value() { + for (protocol, wire) in [ + (OtlpHttpProtocol::HttpJson, "http/json"), + (OtlpHttpProtocol::HttpProtobuf, "http/protobuf"), + ] { + assert_eq!(protocol.as_str(), wire); + + let serialized = serde_json::to_string(&protocol).unwrap(); + assert_eq!(serialized, format!("\"{wire}\"")); + + let deserialized: OtlpHttpProtocol = serde_json::from_str(&serialized).unwrap(); + assert_eq!(deserialized, protocol); + } + } + #[test] fn build_command_sets_otel_env_when_telemetry_enabled() { let opts = ClientOptions { telemetry: Some(TelemetryConfig { otlp_endpoint: Some("http://collector:4318".to_string()), + otlp_protocol: Some(OtlpHttpProtocol::HttpProtobuf), file_path: Some(PathBuf::from("/var/log/copilot.jsonl")), exporter_type: Some(OtelExporterType::OtlpHttp), source_name: Some("my-app".to_string()), @@ -2134,7 +2881,7 @@ mod tests { }), ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert_eq!( env_value(&cmd, "COPILOT_OTEL_ENABLED"), Some(std::ffi::OsStr::new("true")), @@ -2143,6 +2890,10 @@ mod tests { env_value(&cmd, "OTEL_EXPORTER_OTLP_ENDPOINT"), Some(std::ffi::OsStr::new("http://collector:4318")), ); + assert_eq!( + env_value(&cmd, "OTEL_EXPORTER_OTLP_PROTOCOL"), + Some(std::ffi::OsStr::new("http/protobuf")), + ); assert_eq!( env_value(&cmd, "COPILOT_OTEL_FILE_EXPORTER_PATH"), Some(std::ffi::OsStr::new("/var/log/copilot.jsonl")), @@ -2164,10 +2915,11 @@ mod tests { #[test] fn build_command_omits_otel_env_when_telemetry_none() { let opts = ClientOptions::default(); - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); for key in [ "COPILOT_OTEL_ENABLED", "OTEL_EXPORTER_OTLP_ENDPOINT", + "OTEL_EXPORTER_OTLP_PROTOCOL", "COPILOT_OTEL_FILE_EXPORTER_PATH", "COPILOT_OTEL_EXPORTER_TYPE", "COPILOT_OTEL_SOURCE_NAME", @@ -2189,7 +2941,7 @@ mod tests { }), ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); // The one set field plus the implicit enabled flag should propagate. assert_eq!( env_value(&cmd, "COPILOT_OTEL_ENABLED"), @@ -2201,6 +2953,7 @@ mod tests { ); // None of the other fields should leak as env vars. for key in [ + "OTEL_EXPORTER_OTLP_PROTOCOL", "COPILOT_OTEL_FILE_EXPORTER_PATH", "COPILOT_OTEL_EXPORTER_TYPE", "COPILOT_OTEL_SOURCE_NAME", @@ -2223,7 +2976,7 @@ mod tests { )], ..Default::default() }; - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert_eq!( env_value(&cmd, "OTEL_EXPORTER_OTLP_ENDPOINT"), Some(std::ffi::OsStr::new("http://from-user-env:4318")), @@ -2234,14 +2987,14 @@ mod tests { #[test] fn build_command_sets_copilot_home_env_when_configured() { let opts = ClientOptions::new().with_base_directory(PathBuf::from("/custom/copilot")); - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert_eq!( env_value(&cmd, "COPILOT_HOME"), Some(std::ffi::OsStr::new("/custom/copilot")), ); let opts = ClientOptions::default(); - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert!(env_value(&cmd, "COPILOT_HOME").is_none()); } @@ -2251,14 +3004,14 @@ mod tests { port: 0, connection_token: Some("secret-token".to_string()), }); - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert_eq!( env_value(&cmd, "COPILOT_CONNECTION_TOKEN"), Some(std::ffi::OsStr::new("secret-token")), ); let opts = ClientOptions::default(); - let cmd = Client::build_command(Path::new("/bin/echo"), &opts); + let cmd = Client::build_command(Path::new("/bin/echo"), &opts, Path::new("/tmp")); assert!(env_value(&cmd, "COPILOT_CONNECTION_TOKEN").is_none()); } @@ -2309,8 +3062,9 @@ mod tests { }), ..Default::default() }; - let cmd_true = Client::build_command(Path::new("/bin/echo"), &opts_true); - let cmd_false = Client::build_command(Path::new("/bin/echo"), &opts_false); + let cmd_true = Client::build_command(Path::new("/bin/echo"), &opts_true, Path::new("/tmp")); + let cmd_false = + Client::build_command(Path::new("/bin/echo"), &opts_false, Path::new("/tmp")); assert_eq!( env_value( &cmd_true, @@ -2498,6 +3252,7 @@ mod tests { let (client_write, _server_read) = tokio::io::duplex(8192); let (_server_write, client_read) = tokio::io::duplex(8192); let client = Client::from_streams(client_read, client_write, std::env::temp_dir()).unwrap(); + assert!(client.startup_timings().is_none()); let session_id = SessionId::new("resume-cancel-test"); let handle = tokio::spawn({ let client = client.clone(); @@ -2516,10 +3271,111 @@ mod tests { client.force_stop(); } + #[cfg(any(unix, windows))] + #[tokio::test] + async fn dropping_last_client_kills_spawned_cli() { + let temp = tempfile::tempdir().unwrap(); + let ready = temp.path().join("ready"); + let survived = temp.path().join("survived"); + let child = test_child_command(temp.path(), &ready, &survived) + .spawn() + .unwrap(); + let (client_write, _server_read) = tokio::io::duplex(64); + let (_server_write, client_read) = tokio::io::duplex(64); + let client = Client::from_transport( + client_read, + client_write, + Some(child), + temp.path().to_path_buf(), + None, + false, + false, + None, + None, + None, + ClientMode::default(), + ) + .unwrap(); + + wait_for_test_child(&ready).await; + drop(client); + + assert_test_child_killed(&survived).await; + } + + #[cfg(any(unix, windows))] + #[tokio::test] + async fn spawned_child_is_killed_when_dropped() { + let temp = tempfile::tempdir().unwrap(); + let ready = temp.path().join("ready"); + let survived = temp.path().join("survived"); + let child = test_child_command(temp.path(), &ready, &survived) + .spawn() + .unwrap(); + + wait_for_test_child(&ready).await; + drop(child); + + assert_test_child_killed(&survived).await; + } + + #[cfg(any(unix, windows))] + fn test_child_command(temp: &Path, ready: &Path, survived: &Path) -> Command { + #[cfg(unix)] + let mut command = { + let mut command = + Client::build_command(Path::new("sh"), &ClientOptions::default(), temp); + command.args([ + "-c", + "printf ready > \"$READY\"; sleep 1; printf survived > \"$SURVIVED\"", + ]); + command + }; + #[cfg(windows)] + let mut command = { + let mut command = + Client::build_command(Path::new("powershell.exe"), &ClientOptions::default(), temp); + command.args([ + "-NoLogo", + "-NoProfile", + "-NonInteractive", + "-Command", + "Set-Content -LiteralPath $env:READY ready; Start-Sleep -Seconds 1; Set-Content -LiteralPath $env:SURVIVED survived", + ]); + command + }; + command.env("READY", ready).env("SURVIVED", survived); + command + } + + #[cfg(any(unix, windows))] + async fn wait_for_test_child(ready: &Path) { + let deadline = tokio::time::Instant::now() + Duration::from_secs(30); + while !ready.exists() { + assert!( + tokio::time::Instant::now() < deadline, + "child did not report readiness" + ); + tokio::time::sleep(Duration::from_millis(10)).await; + } + } + + #[cfg(any(unix, windows))] + async fn assert_test_child_killed(survived: &Path) { + tokio::time::sleep(Duration::from_millis(1500)).await; + + assert!( + !survived.exists(), + "child survived after its owner was dropped" + ); + } + fn client_with_list_models_handler(handler: Arc) -> Client { Client { inner: Arc::new(ClientInner { child: parking_lot::Mutex::new(None), + #[cfg(feature = "bundled-in-process")] + ffi_host: parking_lot::Mutex::new(None), rpc: { let (req_tx, _req_rx) = mpsc::unbounded_channel(); let (notif_tx, _notif_rx) = broadcast::channel(16); @@ -2538,9 +3394,12 @@ mod tests { models_cache: parking_lot::Mutex::new(Arc::new(tokio::sync::OnceCell::new())), session_fs_configured: false, session_fs_sqlite_declared: false, + llm_inference: OnceLock::new(), + on_github_telemetry: None, on_get_trace_context: None, effective_connection_token: None, mode: ClientMode::default(), + startup_timings: OnceLock::new(), }), } } diff --git a/rust/src/mode.rs b/rust/src/mode.rs index c86b03071..2b1ab897c 100644 --- a/rust/src/mode.rs +++ b/rust/src/mode.rs @@ -12,7 +12,7 @@ use std::collections::HashMap; -use crate::types::{SectionOverride, SystemMessageConfig}; +use crate::types::{MemoryConfiguration, SectionOverride, SystemMessageConfig}; /// Controls SDK defaults for ambient CLI-style behavior. /// @@ -33,6 +33,14 @@ pub enum ClientMode { Empty, } +/// Resolve the effective custom-agents locality setting for a client mode. +pub(crate) fn resolve_custom_agents_local_only( + mode: ClientMode, + custom_agents_local_only: Option, +) -> Option { + custom_agents_local_only.or_else(|| (mode == ClientMode::Empty).then_some(true)) +} + /// Tool name character set enforced by the runtime at every registration /// boundary. Mirrors the runtime's `VALID_TOOL_NAME_REGEX`. fn is_valid_tool_name(name: &str) -> bool { @@ -266,10 +274,52 @@ pub(crate) fn system_message_for_mode( } } +/// Returns the memory configuration to use, adjusted for the current mode. +/// +/// In [`ClientMode::Empty`] the memory feature defaults to disabled so an app +/// must opt in explicitly. In [`ClientMode::CopilotCli`] no SDK default is +/// applied: the configuration is left unset so the runtime applies its own +/// default for the memory feature. A value supplied by the app always wins. +pub(crate) fn memory_for_mode( + mode: ClientMode, + supplied: Option, +) -> Option { + match supplied { + Some(config) => Some(config), + None if mode == ClientMode::Empty => Some(MemoryConfiguration::disabled()), + None => None, + } +} + +/// Returns the `enable_experimental_mode` value to send for the given mode. +pub(crate) fn experimental_mode_for_mode(mode: ClientMode, supplied: Option) -> Option { + if mode == ClientMode::Empty { + Some(supplied.unwrap_or(false)) + } else { + supplied + } +} + #[cfg(test)] mod tests { use super::*; + #[test] + fn custom_agents_local_only_respects_mode_and_caller_value() { + assert_eq!( + resolve_custom_agents_local_only(ClientMode::Empty, None), + Some(true) + ); + assert_eq!( + resolve_custom_agents_local_only(ClientMode::Empty, Some(false)), + Some(false) + ); + assert_eq!( + resolve_custom_agents_local_only(ClientMode::CopilotCli, None), + None + ); + } + #[test] fn tool_set_emits_source_qualified_patterns() { let v = ToolSet::new() @@ -464,4 +514,57 @@ mod tests { let env = secs.get("environment_context").unwrap(); assert_eq!(env.action.as_deref(), Some("remove")); } + + #[test] + fn memory_copilot_cli_leaves_unset_when_not_supplied() { + assert_eq!(memory_for_mode(ClientMode::CopilotCli, None), None); + } + + #[test] + fn memory_copilot_cli_preserves_supplied() { + assert_eq!( + memory_for_mode(ClientMode::CopilotCli, Some(MemoryConfiguration::enabled())), + Some(MemoryConfiguration::enabled()) + ); + } + + #[test] + fn memory_empty_defaults_to_disabled() { + assert_eq!( + memory_for_mode(ClientMode::Empty, None), + Some(MemoryConfiguration::disabled()) + ); + } + + #[test] + fn memory_empty_preserves_supplied() { + assert_eq!( + memory_for_mode(ClientMode::Empty, Some(MemoryConfiguration::enabled())), + Some(MemoryConfiguration::enabled()) + ); + } + + #[test] + fn experimental_mode_defaults_false_in_empty_mode() { + assert_eq!( + experimental_mode_for_mode(ClientMode::Empty, None), + Some(false) + ); + assert_eq!( + experimental_mode_for_mode(ClientMode::Empty, Some(true)), + Some(true) + ); + assert_eq!( + experimental_mode_for_mode(ClientMode::Empty, Some(false)), + Some(false) + ); + } + + #[test] + fn experimental_mode_remains_runtime_controlled_in_copilot_cli_mode() { + assert_eq!( + experimental_mode_for_mode(ClientMode::CopilotCli, None), + None + ); + } } diff --git a/rust/src/permission.rs b/rust/src/permission.rs index 2ddd773a3..57c078570 100644 --- a/rust/src/permission.rs +++ b/rust/src/permission.rs @@ -16,10 +16,14 @@ use std::sync::Arc; use async_trait::async_trait; -use crate::handler::{PermissionHandler, PermissionResult}; +use crate::handler::{PermissionHandler, PermissionResult, permission_handler_failure}; use crate::types::{PermissionRequestData, RequestId, SessionId}; -/// Return a [`PermissionHandler`] that approves every request. +/// Return a [`PermissionHandler`] that approves requests when managed settings +/// are disabled. +/// +/// When managed settings are enabled, the handler logs an error and returns a +/// user-not-available decision. pub fn approve_all() -> Arc { Arc::new(PolicyHandler { policy: Policy::ApproveAll, @@ -93,8 +97,7 @@ pub(crate) fn resolve_handler( ) -> Option> { match (handler, policy) { (_, Some(policy)) => Some(Arc::new(PolicyHandler { policy })), - (Some(h), None) => Some(h), - (None, None) => None, + (handler, None) => handler, } } @@ -116,7 +119,15 @@ impl PermissionHandler for PolicyHandler { Policy::Predicate(f) => f(&data), }; if approved { - PermissionResult::approve_once() + if matches!(self.policy, Policy::ApproveAll) && data.managed_settings_enabled { + permission_handler_failure( + "approve-all policy cannot be used when managed settings are enabled", + ) + } else if data.managed_approval_required == Some(true) { + PermissionResult::no_result() + } else { + PermissionResult::approve_once() + } } else { PermissionResult::reject(None) } @@ -140,7 +151,25 @@ mod tests { assert!(matches!( h.handle(SessionId::from("s"), RequestId::new("1"), data()) .await, - PermissionResult::Decision(crate::types::PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: crate::types::PermissionDecision::ApproveOnce(_), + .. + } + )); + } + + #[tokio::test] + async fn approve_all_fails_when_managed_settings_enabled() { + let h = approve_all(); + let mut request = data(); + request.managed_settings_enabled = true; + assert!(matches!( + h.handle(SessionId::from("s"), RequestId::new("1"), request) + .await, + PermissionResult::Decision { + decision: crate::types::PermissionDecision::UserNotAvailable(_), + .. + } )); } @@ -150,7 +179,10 @@ mod tests { assert!(matches!( h.handle(SessionId::from("s"), RequestId::new("1"), data()) .await, - PermissionResult::Decision(crate::types::PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: crate::types::PermissionDecision::Reject(_), + .. + } )); } @@ -160,7 +192,37 @@ mod tests { assert!(matches!( h.handle(SessionId::from("s"), RequestId::new("1"), data()) .await, - PermissionResult::Decision(crate::types::PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: crate::types::PermissionDecision::Reject(_), + .. + } + )); + } + + #[tokio::test] + async fn approve_if_leaves_managed_approval_pending_when_predicate_approves() { + let h = approve_if(|_| true); + let mut request = data(); + request.managed_approval_required = Some(true); + assert!(matches!( + h.handle(SessionId::from("s"), RequestId::new("1"), request) + .await, + PermissionResult::NoResult + )); + } + + #[tokio::test] + async fn approve_if_still_rejects_managed_request_when_predicate_denies() { + let h = approve_if(|_| false); + let mut request = data(); + request.managed_approval_required = Some(true); + assert!(matches!( + h.handle(SessionId::from("s"), RequestId::new("1"), request) + .await, + PermissionResult::Decision { + decision: crate::types::PermissionDecision::Reject(_), + .. + } )); } @@ -185,7 +247,10 @@ mod tests { resolved .handle(SessionId::from("s"), RequestId::new("1"), data()) .await, - PermissionResult::Decision(crate::types::PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: crate::types::PermissionDecision::Reject(_), + .. + } )); } @@ -208,7 +273,10 @@ mod tests { resolved .handle(SessionId::from("s"), RequestId::new("1"), data()) .await, - PermissionResult::Decision(crate::types::PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: crate::types::PermissionDecision::ApproveOnce(_), + .. + } )); } diff --git a/rust/src/provider_token.rs b/rust/src/provider_token.rs new file mode 100644 index 000000000..a8b75f196 --- /dev/null +++ b/rust/src/provider_token.rs @@ -0,0 +1,112 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +//! BYOK bearer-token provider callbacks. +//! +//!
    +//! +//! **Experimental.** These types are part of an experimental wire-protocol +//! surface and may change or be removed in future SDK or CLI releases. +//! +//!
    + +use std::future::Future; + +use async_trait::async_trait; + +/// Arguments passed to a BYOK bearer-token provider callback. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol +/// surface and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct ProviderTokenArgs { + /// Name of the BYOK provider needing a token. + /// + /// This is `"default"` for the singular whole-session provider, otherwise + /// the named provider's `name`. + pub provider_name: String, + + /// Id of the session that triggered this token request. + /// + /// A client-level shared callback registered for many sessions can use this + /// to resolve the owning session and scope token acquisition or caching per + /// session. + pub session_id: String, +} + +/// Error returned by a [`BearerTokenProvider`]. +/// +///
    +/// +/// **Experimental.** This type is part of an experimental wire-protocol +/// surface and may change or be removed in future SDK or CLI releases. +/// +///
    +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct BearerTokenError { + message: String, +} + +impl BearerTokenError { + /// Construct a bearer-token error with a human-readable message. + pub fn message(message: impl Into) -> Self { + Self { + message: message.into(), + } + } + + /// Return the human-readable error message. + pub fn as_str(&self) -> &str { + &self.message + } +} + +impl std::fmt::Display for BearerTokenError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.message) + } +} + +impl std::error::Error for BearerTokenError {} + +impl From for BearerTokenError { + fn from(message: String) -> Self { + Self::message(message) + } +} + +impl From<&str> for BearerTokenError { + fn from(message: &str) -> Self { + Self::message(message) + } +} + +/// Provider-side callback used to acquire bearer tokens for BYOK providers. +/// +///
    +/// +/// **Experimental.** This trait is part of an experimental wire-protocol +/// surface and may change or be removed in future SDK or CLI releases. +/// +///
    +#[async_trait] +pub trait BearerTokenProvider: Send + Sync { + /// Acquire a bearer token without the `Bearer ` prefix. + async fn get_token(&self, args: ProviderTokenArgs) -> Result; +} + +#[async_trait] +impl BearerTokenProvider for F +where + F: Fn(ProviderTokenArgs) -> Fut + Send + Sync, + Fut: Future> + Send, +{ + async fn get_token(&self, args: ProviderTokenArgs) -> Result { + (self)(args).await + } +} diff --git a/rust/src/provider_token_dispatch.rs b/rust/src/provider_token_dispatch.rs new file mode 100644 index 000000000..0631260a4 --- /dev/null +++ b/rust/src/provider_token_dispatch.rs @@ -0,0 +1,158 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +//! Inbound `providerToken.*` JSON-RPC request dispatch helpers. + +use std::collections::HashMap; +use std::sync::Arc; + +use serde::Serialize; +use serde_json::Value; +use tracing::warn; + +use crate::generated::api_types::{ + ProviderTokenAcquireRequest, ProviderTokenAcquireResult, rpc_methods, +}; +use crate::provider_token::{BearerTokenError, BearerTokenProvider, ProviderTokenArgs}; +use crate::{Client, JsonRpcRequest, JsonRpcResponse, error_codes}; + +async fn respond(client: &Client, request_id: u64, result: T) { + let value = match serde_json::to_value(&result) { + Ok(value) => value, + Err(error) => { + warn!(error = %error, "failed to serialize provider token response"); + send_error( + client, + request_id, + error_codes::INTERNAL_ERROR, + "serialization failure", + ) + .await; + return; + } + }; + + let _ = client + .send_response(&JsonRpcResponse { + jsonrpc: "2.0".to_string(), + id: request_id, + result: Some(value), + error: None, + }) + .await; +} + +async fn send_error(client: &Client, request_id: u64, code: i32, message: &str) { + let _ = client + .send_response(&JsonRpcResponse { + jsonrpc: "2.0".to_string(), + id: request_id, + result: None, + error: Some(crate::JsonRpcError { + code, + message: message.to_string(), + data: None, + }), + }) + .await; +} + +async fn parse_params( + client: &Client, + request: &JsonRpcRequest, +) -> Option { + let params = request + .params + .as_ref() + .cloned() + .unwrap_or(Value::Object(serde_json::Map::new())); + match serde_json::from_value(params) { + Ok(params) => Some(params), + Err(error) => { + send_error( + client, + request.id, + error_codes::INVALID_PARAMS, + &format!("invalid params: {error}"), + ) + .await; + None + } + } +} + +fn token_provider_or_err( + providers: &HashMap>, + provider_name: &str, +) -> Result, BearerTokenError> { + providers.get(provider_name).cloned().ok_or_else(|| { + BearerTokenError::message(format!( + "No bearer-token provider installed for BYOK provider {provider_name:?}" + )) + }) +} + +async fn get_token( + client: &Client, + providers: &HashMap>, + request: JsonRpcRequest, +) { + let Some(params) = parse_params::(client, &request).await else { + return; + }; + + let token_provider = match token_provider_or_err(providers, ¶ms.provider_name) { + Ok(provider) => provider, + Err(error) => { + send_error( + client, + request.id, + error_codes::INTERNAL_ERROR, + &error.to_string(), + ) + .await; + return; + } + }; + + match token_provider + .get_token(ProviderTokenArgs { + provider_name: params.provider_name, + session_id: params.session_id.into_inner(), + }) + .await + { + Ok(token) => respond(client, request.id, ProviderTokenAcquireResult { token }).await, + Err(error) => { + send_error( + client, + request.id, + error_codes::INTERNAL_ERROR, + &format!("Bearer-token provider failed: {error}"), + ) + .await; + } + } +} + +pub(crate) async fn dispatch( + client: &Client, + providers: &HashMap>, + request: JsonRpcRequest, +) { + let method = request.method.as_str(); + match method { + rpc_methods::PROVIDERTOKEN_GETTOKEN => get_token(client, providers, request).await, + _ => { + warn!(method = %method, "unknown providerToken.* method"); + send_error( + client, + request.id, + error_codes::METHOD_NOT_FOUND, + &format!("unknown method: {method}"), + ) + .await; + } + } +} diff --git a/rust/src/router.rs b/rust/src/router.rs index e14630e03..adc192382 100644 --- a/rust/src/router.rs +++ b/rust/src/router.rs @@ -85,6 +85,8 @@ impl SessionRouter { &self, notification_tx: &broadcast::Sender, request_rx: &Mutex>>, + llm_inference: Option>, + github_telemetry: Option, ) { let mut started = self.started.lock(); if *started { @@ -99,6 +101,40 @@ impl SessionRouter { loop { match notif_rx.recv().await { Ok(notification) => { + // Client-global `gitHubTelemetry.event` notifications carry + // no routable session and are surfaced to the consumer + // callback (if any) registered at client construction. + if notification.method == "gitHubTelemetry.event" { + if let Some(ref callback) = github_telemetry { + let Some(ref params) = notification.params else { + continue; + }; + match serde_json::from_value::< + crate::github_telemetry::GitHubTelemetryNotification, + >(params.clone()) + { + Ok(telemetry) => { + if std::panic::catch_unwind(std::panic::AssertUnwindSafe( + || callback(telemetry), + )) + .is_err() + { + warn!( + "gitHubTelemetry.event callback panicked; \ + continuing notification routing" + ); + } + } + Err(e) => { + warn!( + error = %e, + "failed to deserialize gitHubTelemetry.event notification" + ); + } + } + } + continue; + } if notification.method != "session.event" { continue; } @@ -145,6 +181,20 @@ impl SessionRouter { let sessions = self.sessions.clone(); tokio::spawn(async move { while let Some(request) = rx.recv().await { + // Client-global `llmInference.*` requests carry no routable + // session and are handled by the inference dispatcher. + if request.method.starts_with("llmInference.") { + if let Some(dispatcher) = &llm_inference { + dispatcher.dispatch(request).await; + } else { + warn!( + method = %request.method, + "llmInference request with no provider registered" + ); + } + continue; + } + let session_id = request .params .as_ref() diff --git a/rust/src/rpc.rs b/rust/src/rpc.rs new file mode 100644 index 000000000..a08a501cb --- /dev/null +++ b/rust/src/rpc.rs @@ -0,0 +1,12 @@ +//! JSON-RPC request/response types and typed namespace builders. +//! +//! All types are auto-generated from the Copilot CLI protocol schemas. +//! This module is the stable public access point — the underlying +//! crate-private modules where the types are defined are an +//! implementation detail whose layout may change. +//! +//! Use the [`crate::Client::rpc`] and [`crate::session::Session::rpc`] helper +//! methods to obtain a typed view over the protocol surface. + +pub use crate::generated::api_types::*; +pub use crate::generated::rpc::*; diff --git a/rust/src/session.rs b/rust/src/session.rs index 6a1e4f92c..99e793015 100644 --- a/rust/src/session.rs +++ b/rust/src/session.rs @@ -11,16 +11,21 @@ use tokio_util::sync::CancellationToken; use tracing::{Instrument, warn}; use crate::canvas::CanvasHandler; -use crate::generated::api_types::{LogRequest, ModelSwitchToRequest, OpenCanvasInstance}; +use crate::generated::api_types::{ + LogRequest, ModelSwitchToRequest, OpenCanvasInstance, PermissionDecisionRequest, + RegisterEventInterestParams, ToolsGetCurrentMetadataResult, rpc_methods, +}; use crate::generated::session_events::{ - CommandExecuteData, ElicitationRequestedData, ExternalToolRequestedData, SessionErrorData, - SessionEventType, + CommandExecuteData, ElicitationRequestedData, ExternalToolRequestedData, McpOauthRequiredData, + SessionCanvasClosedData, SessionErrorData, SessionEventType, }; use crate::handler::{ AutoModeSwitchHandler, AutoModeSwitchResponse, ElicitationHandler, ExitPlanModeHandler, - PermissionHandler, PermissionResult, UserInputHandler, UserInputResponse, + McpAuthHandler, McpAuthRequest, McpAuthResult, PermissionHandler, PermissionResult, + UserInputHandler, UserInputResponse, }; use crate::hooks::SessionHooks; +use crate::provider_token::BearerTokenProvider; use crate::session_fs::SessionFsProvider; use crate::trace_context::inject_trace_context; use crate::transforms::SystemMessageTransform; @@ -37,6 +42,11 @@ use crate::{ error_codes, }; +/// Fixed name of the runtime's built-in tool-search tool. A client can replace +/// its behavior by registering a tool with this exact name and +/// `overrides_built_in_tool` set to `true`. +const TOOL_SEARCH_TOOL_NAME: &str = "tool_search_tool"; + /// Bundle of the per-session callbacks the SDK dispatches to. Built from a /// [`SessionConfig`] / [`ResumeSessionConfig`] at /// [`Client::create_session`] / [`Client::resume_session`] time. Each @@ -47,13 +57,22 @@ use crate::{ #[derive(Clone)] pub(crate) struct SessionHandlers { pub permission: Option>, + pub managed_settings_enabled: bool, pub elicitation: Option>, + pub mcp_auth: Option>, pub user_input: Option>, pub exit_plan_mode: Option>, pub auto_mode_switch: Option>, pub tools: Arc>>, } +fn has_managed_settings( + enable_managed_settings: Option, + managed_settings: Option<&crate::types::ManagedSettings>, +) -> bool { + enable_managed_settings == Some(true) || managed_settings.is_some() +} + /// Shared state between a [`Session`] and its event loop, used by [`Session::send_and_wait`]. struct IdleWaiter { tx: oneshot::Sender, Error>>, @@ -524,8 +543,10 @@ impl Session { model_id: model.to_string(), reasoning_effort: opts.reasoning_effort, reasoning_summary: opts.reasoning_summary, + verbosity: None, + context_tier: opts.context_tier, model_capabilities: opts.model_capabilities, - ..ModelSwitchToRequest::default() + defer_if_model_change_queued: None, }; self.rpc().model().switch_to(request).await?; Ok(()) @@ -837,6 +858,9 @@ impl Client { crate::mode::validate_tool_filter_list("excluded_tools", config.excluded_tools.as_deref())?; config.system_message = crate::mode::system_message_for_mode(mode, config.system_message.take()); + config.memory = crate::mode::memory_for_mode(mode, config.memory.take()); + config.enable_experimental_mode = + crate::mode::experimental_mode_for_mode(mode, config.enable_experimental_mode); if mode == crate::ClientMode::Empty { if config.enable_session_telemetry.is_none() { config.enable_session_telemetry = Some(false); @@ -866,11 +890,15 @@ impl Client { if mode == crate::ClientMode::Empty && config.embedding_cache_storage.is_none() { config.embedding_cache_storage = Some("in-memory".into()); } + config.custom_agents_local_only = + crate::mode::resolve_custom_agents_local_only(mode, config.custom_agents_local_only); let opt_skip_custom_instructions = config.skip_custom_instructions; let opt_custom_agents_local_only = config.custom_agents_local_only; let opt_coauthor_enabled = config.coauthor_enabled; let opt_manage_schedule_enabled = config.manage_schedule_enabled; - let (wire, mut runtime) = config.into_wire(local_session_id.clone())?; + let (mut wire, mut runtime) = config.into_wire(local_session_id.clone())?; + wire.enable_github_telemetry_forwarding = + self.inner.on_github_telemetry.is_some().then_some(true); let permission_handler = crate::permission::resolve_handler( runtime.permission_handler.take(), @@ -878,7 +906,12 @@ impl Client { ); let handlers = SessionHandlers { permission: permission_handler, + managed_settings_enabled: has_managed_settings( + wire.enable_managed_settings, + wire.managed_settings.as_ref(), + ), elicitation: runtime.elicitation_handler.take(), + mcp_auth: runtime.mcp_auth_handler.take(), user_input: runtime.user_input_handler.take(), exit_plan_mode: runtime.exit_plan_mode_handler.take(), auto_mode_switch: runtime.auto_mode_switch_handler.take(), @@ -892,6 +925,8 @@ impl Client { let command_handlers = build_command_handler_map(runtime.commands.as_deref()); let canvas_handler = runtime.canvas_handler.take(); let session_fs_provider = runtime.session_fs_provider.take(); + let bearer_token_providers = std::mem::take(&mut runtime.bearer_token_providers); + let has_mcp_auth_handler = handlers.mcp_auth.is_some(); if self.inner.session_fs_configured && session_fs_provider.is_none() { return Err(ErrorKind::Session(SessionErrorKind::SessionFsProviderRequired).into()); } @@ -1010,6 +1045,7 @@ impl Client { command_handlers, canvas_handler, session_fs_provider, + bearer_token_providers, channels, idle_waiter.clone(), capabilities.clone(), @@ -1026,6 +1062,9 @@ impl Client { "Client::create_session local setup complete" ); *capabilities.write() = create_result.capabilities.unwrap_or_default(); + if has_mcp_auth_handler { + register_mcp_auth_interest(self, &session_id).await?; + } tracing::debug!( elapsed_ms = total_start.elapsed().as_millis(), @@ -1092,6 +1131,9 @@ impl Client { crate::mode::validate_tool_filter_list("excluded_tools", config.excluded_tools.as_deref())?; config.system_message = crate::mode::system_message_for_mode(mode, config.system_message.take()); + config.memory = crate::mode::memory_for_mode(mode, config.memory.take()); + config.enable_experimental_mode = + crate::mode::experimental_mode_for_mode(mode, config.enable_experimental_mode); if mode == crate::ClientMode::Empty { if config.enable_session_telemetry.is_none() { config.enable_session_telemetry = Some(false); @@ -1121,11 +1163,15 @@ impl Client { if mode == crate::ClientMode::Empty && config.embedding_cache_storage.is_none() { config.embedding_cache_storage = Some("in-memory".into()); } + config.custom_agents_local_only = + crate::mode::resolve_custom_agents_local_only(mode, config.custom_agents_local_only); let opt_skip_custom_instructions = config.skip_custom_instructions; let opt_custom_agents_local_only = config.custom_agents_local_only; let opt_coauthor_enabled = config.coauthor_enabled; let opt_manage_schedule_enabled = config.manage_schedule_enabled; - let (wire, mut runtime) = config.into_wire()?; + let (mut wire, mut runtime) = config.into_wire()?; + wire.enable_github_telemetry_forwarding = + self.inner.on_github_telemetry.is_some().then_some(true); let permission_handler = crate::permission::resolve_handler( runtime.permission_handler.take(), @@ -1133,7 +1179,12 @@ impl Client { ); let handlers = SessionHandlers { permission: permission_handler, + managed_settings_enabled: has_managed_settings( + wire.enable_managed_settings, + wire.managed_settings.as_ref(), + ), elicitation: runtime.elicitation_handler.take(), + mcp_auth: runtime.mcp_auth_handler.take(), user_input: runtime.user_input_handler.take(), exit_plan_mode: runtime.exit_plan_mode_handler.take(), auto_mode_switch: runtime.auto_mode_switch_handler.take(), @@ -1147,6 +1198,8 @@ impl Client { let command_handlers = build_command_handler_map(runtime.commands.as_deref()); let canvas_handler = runtime.canvas_handler.take(); let session_fs_provider = runtime.session_fs_provider.take(); + let bearer_token_providers = std::mem::take(&mut runtime.bearer_token_providers); + let has_mcp_auth_handler = handlers.mcp_auth.is_some(); if self.inner.session_fs_configured && session_fs_provider.is_none() { return Err(ErrorKind::Session(SessionErrorKind::SessionFsProviderRequired).into()); } @@ -1181,6 +1234,7 @@ impl Client { command_handlers, canvas_handler, session_fs_provider, + bearer_token_providers, channels, idle_waiter.clone(), capabilities.clone(), @@ -1232,6 +1286,9 @@ impl Client { }) .into()); } + if has_mcp_auth_handler { + register_mcp_auth_interest(self, &session_id).await?; + } // Reload skills after resume (best-effort). let skills_reload_start = Instant::now(); @@ -1375,6 +1432,10 @@ fn upsert_open_canvas_snapshot( } } +fn remove_open_canvas_snapshot(snapshots: &mut Vec, instance_id: &str) { + snapshots.retain(|open| open.instance_id != instance_id); +} + #[allow(clippy::too_many_arguments)] fn spawn_event_loop( session_id: SessionId, @@ -1385,6 +1446,7 @@ fn spawn_event_loop( command_handlers: Arc, canvas_handler: Option>, session_fs_provider: Option>, + bearer_token_providers: HashMap>, channels: crate::router::SessionChannels, idle_waiter: Arc>>, capabilities: Arc>, @@ -1403,14 +1465,27 @@ fn spawn_event_loop( loop { // `mpsc::UnboundedReceiver::recv` and // `CancellationToken::cancelled` are both cancel-safe per - // RFD 400. The selected branch's `await`'d handler is - // *not* mid-cancelled by the select — once a branch fires - // it runs to completion within the loop's iteration. - // Spawned child tasks inside `handle_notification` - // (permission/tool/elicitation callbacks) intentionally - // outlive the parent loop and own their own cleanup; - // this is RFD 400's "spawn background tasks to perform - // cancel-unsafe operations" pattern and is correct as-is. + // RFD 400. + // + // Inbound JSON-RPC *requests* are dispatched fire-and-forget: + // each `handle_request` runs in its own spawned task that + // awaits the handler and sends that request's response. This + // mirrors the other Copilot SDKs and moves concurrency to the + // request-dispatch boundary, so any slow handler — not just + // `userInput.request` (which can stay pending for the full + // input backstop of several minutes), but also `exitPlanMode`, + // `autoModeSwitch`, hooks, transforms, or canvas/session-FS + // providers — cannot park the reader loop and starve sibling + // requests or co-emitted notifications. JSON-RPC permits + // concurrent requests and out-of-order responses, so the SDK + // does not serialize them. + // + // `handle_notification` is awaited inline because it only + // performs fast dispatch work; its slow interactive callbacks + // (permission/tool/elicitation) are themselves spawned as child + // tasks. All of these spawned tasks intentionally outlive the + // parent loop and own their own cleanup — RFD 400's "spawn + // background tasks to perform cancel-unsafe operations" pattern. tokio::select! { _ = shutdown.cancelled() => break, Some(notification) = notifications.recv() => { @@ -1419,15 +1494,33 @@ fn spawn_event_loop( ).await; } Some(request) = requests.recv() => { - let ctx = RequestDispatchContext { - client: &client, - handlers: &handlers, - hooks: hooks.as_deref(), - transforms: transforms.as_deref(), - canvas_handler: canvas_handler.as_ref(), - session_fs_provider: session_fs_provider.as_ref(), - }; - handle_request(&session_id, ctx, request).await; + // Clone the Arc-backed dispatch context into the task so + // the spawned `handle_request` future is `'static`. All + // clones are cheap (Arc refcount bumps / small maps). + let span = tracing::error_span!("session_request_handler", session_id = %session_id); + let session_id = session_id.clone(); + let client = client.clone(); + let handlers = handlers.clone(); + let hooks = hooks.clone(); + let transforms = transforms.clone(); + let canvas_handler = canvas_handler.clone(); + let session_fs_provider = session_fs_provider.clone(); + let bearer_token_providers = bearer_token_providers.clone(); + tokio::spawn( + async move { + let ctx = RequestDispatchContext { + client: &client, + handlers: &handlers, + hooks: hooks.as_deref(), + transforms: transforms.as_deref(), + canvas_handler: canvas_handler.as_ref(), + session_fs_provider: session_fs_provider.as_ref(), + bearer_token_providers: &bearer_token_providers, + }; + handle_request(&session_id, ctx, request).await; + } + .instrument(span), + ); } else => break, } @@ -1451,17 +1544,71 @@ fn extract_request_id(data: &Value) -> Option { .map(RequestId::new) } -/// Map a [`PermissionResult`] to the `result` payload sent back to the -/// server via `session.permissions.handlePendingPermissionRequest`. +fn permission_request_data( + event_data: &Value, + managed_settings_enabled: bool, +) -> PermissionRequestData { + let request_data = event_data + .get("permissionRequest") + .cloned() + .unwrap_or_else(|| event_data.clone()); + let managed_approval_required = match request_data.get("managedApprovalRequired") { + None => None, + Some(Value::Bool(value)) => Some(*value), + Some(_) => Some(true), + }; + match serde_json::from_value::(request_data) { + Ok(mut data) => { + data.extra = event_data.clone(); + data.managed_settings_enabled = managed_settings_enabled; + data + } + Err(_) => PermissionRequestData { + kind: None, + tool_call_id: None, + managed_approval_required, + managed_settings_enabled, + extra: event_data.clone(), + }, + } +} + +/// Build the full `session.permissions.handlePendingPermissionRequest` +/// params for a permission result. +/// +/// `decisionContext` is a sibling of `result` and is only present when the +/// handler attributed the decision — omitting it preserves legacy behavior. /// /// Returns `None` when the SDK must not send a response. -fn notification_permission_payload(result: &PermissionResult) -> Option { - match result { - PermissionResult::NoResult => None, - PermissionResult::Decision(decision) => Some( - serde_json::to_value(decision).expect("serializing permission decision should succeed"), - ), - } +fn permission_response_params( + session_id: &SessionId, + request_id: &RequestId, + result: &PermissionResult, +) -> Option { + let (decision, decision_context) = match result { + PermissionResult::Decision { decision, context } => (decision, context.clone()), + PermissionResult::NoResult => return None, + }; + let mut params = serde_json::to_value(PermissionDecisionRequest { + decision_context, + request_id: request_id.clone(), + result: decision.clone(), + }) + .expect("serializing permission response should succeed"); + params["sessionId"] = + serde_json::to_value(session_id).expect("serializing session ID should succeed"); + Some(params) +} + +async fn register_mcp_auth_interest(client: &Client, session_id: &SessionId) -> Result<(), Error> { + let mut params = serde_json::to_value(RegisterEventInterestParams { + event_type: "mcp.oauth_required".to_string(), + })?; + params["sessionId"] = Value::String(session_id.to_string()); + client + .call(rpc_methods::SESSION_EVENTLOG_REGISTERINTEREST, Some(params)) + .await?; + Ok(()) } fn tool_failure_result(message: impl Into) -> ToolResult { @@ -1473,6 +1620,7 @@ fn tool_failure_result(message: impl Into) -> ToolResult { session_log: None, error: Some(message), tool_telemetry: None, + tool_references: None, }) } @@ -1572,6 +1720,18 @@ async fn handle_notification( Err(e) => warn!(error = %e, "failed to deserialize session.canvas.opened payload"), } } + if event_type == SessionEventType::SessionCanvasClosed { + match serde_json::from_value::(notification.event.data.clone()) { + Ok(closed) => { + if closed.instance_id.is_empty() { + warn!("failed to deserialize session.canvas.closed payload"); + } else { + remove_open_canvas_snapshot(&mut open_canvases.write(), &closed.instance_id); + } + } + Err(e) => warn!(error = %e, "failed to deserialize session.canvas.closed payload"), + } + } // Fan out the event to runtime subscribers (`Session::subscribe`). `send` // only errors when there are no receivers, which is the normal case @@ -1612,14 +1772,10 @@ async fn handle_notification( }; let client = client.clone(); let sid = session_id.clone(); - let data: PermissionRequestData = - serde_json::from_value(notification.event.data.clone()).unwrap_or_else(|_| { - PermissionRequestData { - kind: None, - tool_call_id: None, - extra: notification.event.data.clone(), - } - }); + let data = permission_request_data( + ¬ification.event.data, + handlers.managed_settings_enabled, + ); let span = tracing::error_span!( "permission_request_handler", session_id = %sid, @@ -1637,7 +1793,8 @@ async fn handle_notification( request_id = %request_id, "PermissionHandler::handle dispatch" ); - let Some(result_value) = notification_permission_payload(&result) else { + let Some(params) = permission_response_params(&sid, &request_id, &result) + else { // Handler returned Deferred / NoResult — it will // call handlePendingPermissionRequest itself (or // leave the request unanswered). @@ -1646,12 +1803,8 @@ async fn handle_notification( let rpc_start = Instant::now(); let _ = client .call( - "session.permissions.handlePendingPermissionRequest", - Some(serde_json::json!({ - "sessionId": sid, - "requestId": request_id, - "result": result_value, - })), + rpc_methods::SESSION_PERMISSIONS_HANDLEPENDINGPERMISSIONREQUEST, + Some(params), ) .await; tracing::debug!( @@ -1752,6 +1905,30 @@ async fn handle_notification( } let tool_call_id = data.tool_call_id.clone(); let tool_name = data.tool_name.clone(); + // The built-in tool-search tool receives a snapshot of the + // session's currently initialized tools so an override can + // filter the live catalog without issuing its own RPC. Fetch + // it only for that tool to avoid a round-trip on every tool + // call; a failed fetch leaves the snapshot `None` rather than + // failing the tool. + let available_tools = if tool_name == TOOL_SEARCH_TOOL_NAME { + match client + .call( + rpc_methods::SESSION_TOOLS_GETCURRENTMETADATA, + Some(serde_json::json!({ "sessionId": sid })), + ) + .await + { + Ok(value) => { + serde_json::from_value::(value) + .ok() + .and_then(|result| result.tools) + } + Err(_) => None, + } + } else { + None + }; let invocation = ToolInvocation { session_id: sid.clone(), tool_call_id: data.tool_call_id, @@ -1759,6 +1936,7 @@ async fn handle_notification( arguments: data .arguments .unwrap_or(Value::Object(serde_json::Map::new())), + available_tools, traceparent: data.traceparent, tracestate: data.tracestate, }; @@ -1919,6 +2097,91 @@ async fn handle_notification( .instrument(span), ); } + SessionEventType::McpOauthRequired => { + let Some(request_id) = extract_request_id(¬ification.event.data) else { + return; + }; + let Some(mcp_auth_handler) = handlers.mcp_auth.clone() else { + warn!( + session_id = %session_id, + request_id = %request_id, + "received MCP OAuth request without a registered MCP auth handler" + ); + return; + }; + let data: McpOauthRequiredData = + match serde_json::from_value(notification.event.data.clone()) { + Ok(d) => d, + Err(e) => { + warn!(error = %e, "failed to deserialize MCP OAuth request"); + return; + } + }; + let request = McpAuthRequest { + request_id: request_id.clone(), + server_name: data.server_name, + server_url: data.server_url, + reason: data.reason, + www_authenticate_params: data.www_authenticate_params, + resource_metadata: data.resource_metadata, + static_client_config: data.static_client_config, + }; + let client = client.clone(); + let sid = session_id.clone(); + let span = tracing::error_span!( + "mcp_auth_request_handler", + session_id = %sid, + request_id = %request_id + ); + tokio::spawn( + async move { + let cancel = McpAuthResult::Cancelled; + let handler_task = tokio::spawn({ + let sid = sid.clone(); + let request_id = request_id.clone(); + let span = tracing::error_span!( + "mcp_auth_callback", + session_id = %sid, + request_id = %request_id + ); + async move { + let handler_start = Instant::now(); + let response = mcp_auth_handler + .handle(sid.clone(), request_id.clone(), request) + .await; + tracing::debug!( + elapsed_ms = handler_start.elapsed().as_millis(), + session_id = %sid, + request_id = %request_id, + "McpAuthHandler::handle dispatch" + ); + response + } + .instrument(span) + }); + let result = match handler_task.await { + Ok(result) => result, + Err(_) => cancel, + }; + let rpc_start = Instant::now(); + let _ = client + .call( + "session.mcp.oauth.handlePendingRequest", + Some(serde_json::json!({ + "sessionId": sid, + "requestId": request_id, + "result": result.into_wire(), + })), + ) + .await; + tracing::debug!( + elapsed_ms = rpc_start.elapsed().as_millis(), + "Session::handle_notification MCP auth response sent" + ); + } + .instrument(span), + ); + } SessionEventType::CommandExecute => { let data: CommandExecuteData = match serde_json::from_value(notification.event.data.clone()) { @@ -1992,6 +2255,7 @@ struct RequestDispatchContext<'a> { transforms: Option<&'a dyn SystemMessageTransform>, canvas_handler: Option<&'a Arc>, session_fs_provider: Option<&'a Arc>, + bearer_token_providers: &'a HashMap>, } /// Process a JSON-RPC request from the CLI. @@ -2007,6 +2271,7 @@ async fn handle_request( let transforms = ctx.transforms; let canvas_handler = ctx.canvas_handler; let session_fs_provider = ctx.session_fs_provider; + let bearer_token_providers = ctx.bearer_token_providers; if request.method.starts_with("sessionFs.") { crate::session_fs_dispatch::dispatch(client, session_fs_provider, request).await; @@ -2018,6 +2283,11 @@ async fn handle_request( return; } + if request.method == crate::generated::api_types::rpc_methods::PROVIDERTOKEN_GETTOKEN { + crate::provider_token_dispatch::dispatch(client, bearer_token_providers, request).await; + return; + } + match request.method.as_str() { "hooks.invoke" => { let params = request.params.as_ref(); @@ -2304,31 +2574,200 @@ fn inject_transform_sections_resume( mod tests { use serde_json::json; - use super::notification_permission_payload; + use super::{has_managed_settings, permission_request_data, permission_response_params}; use crate::handler::PermissionResult; + use crate::types::{ + PermissionDecisionContext, PermissionDecisionOutcome, PermissionDecisionSource, + PermissionDecisionSurface, RequestId, SessionId, + }; #[test] - fn notification_payload_suppresses_no_result() { - assert!(notification_permission_payload(&PermissionResult::NoResult).is_none()); + fn direct_injection_enables_managed_safeguards() { + let settings = crate::types::ManagedSettings::default(); + assert!(has_managed_settings(None, Some(&settings))); + assert!(!has_managed_settings(None, None)); + } + + fn attribution_context() -> PermissionDecisionContext { + PermissionDecisionContext { + outcome: PermissionDecisionOutcome::AutoApproved, + source: PermissionDecisionSource::JudgeRecommendation, + surface: PermissionDecisionSurface::CopilotApp, + } + } + + #[test] + fn response_params_omit_decision_context_without_attribution() { + for (result, expected) in [ + ( + PermissionResult::approve_once(), + json!({ "kind": "approve-once" }), + ), + (PermissionResult::reject(None), json!({ "kind": "reject" })), + ( + PermissionResult::reject(Some("bad".to_string())), + json!({ "kind": "reject", "feedback": "bad" }), + ), + ( + PermissionResult::user_not_available(), + json!({ "kind": "user-not-available" }), + ), + ] { + let params = permission_response_params( + &SessionId::from("session-1"), + &RequestId::from("permission-1"), + &result, + ) + .unwrap(); + assert_eq!( + params, + json!({ + "sessionId": "session-1", + "requestId": "permission-1", + "result": expected, + }) + ); + } } #[test] - fn notification_payload_serializes_decisions() { + fn response_params_forward_decision_context_alongside_result() { + let params = permission_response_params( + &SessionId::from("session-1"), + &RequestId::from("permission-1"), + &PermissionResult::approve_once().with_context(attribution_context()), + ) + .unwrap(); assert_eq!( - notification_permission_payload(&PermissionResult::approve_once()), - Some(json!({ "kind": "approve-once" })) + params, + json!({ + "sessionId": "session-1", + "requestId": "permission-1", + "result": { "kind": "approve-once" }, + "decisionContext": { + "outcome": "auto_approved", + "source": "judge_recommendation", + "surface": "copilot_app", + }, + }) ); - assert_eq!( - notification_permission_payload(&PermissionResult::reject(None)), - Some(json!({ "kind": "reject" })) + // The context is a sibling of `result`, never nested inside it. + assert!(params["result"].get("decisionContext").is_none()); + } + + #[test] + fn response_params_suppressed_for_no_result() { + assert!( + permission_response_params( + &SessionId::from("session-1"), + &RequestId::from("permission-1"), + &PermissionResult::NoResult, + ) + .is_none() ); + } + + #[test] + fn with_context_is_a_no_op_on_no_result() { + let result = PermissionResult::no_result().with_context(attribution_context()); + assert!(matches!(result, PermissionResult::NoResult)); + } + + #[test] + fn with_context_replaces_rather_than_nests() { + let result = PermissionResult::approve_once() + .with_context(attribution_context()) + .with_context(PermissionDecisionContext { + outcome: PermissionDecisionOutcome::PromptedUser, + source: PermissionDecisionSource::HumanResponse, + surface: PermissionDecisionSurface::Sdk, + }); + let params = permission_response_params( + &SessionId::from("session-1"), + &RequestId::from("permission-1"), + &result, + ) + .unwrap(); assert_eq!( - notification_permission_payload(&PermissionResult::reject(Some("bad".to_string()))), - Some(json!({ "kind": "reject", "feedback": "bad" })) + params["decisionContext"], + json!({ + "outcome": "prompted_user", + "source": "human_response", + "surface": "sdk", + }) + ); + } + + #[test] + fn permission_request_data_reads_nested_managed_approval_metadata() { + let data = permission_request_data( + &json!({ + "requestId": "permission-1", + "permissionRequest": { + "kind": "read", + "managedApprovalRequired": true, + "path": "/workspace/file.txt" + } + }), + false, ); + + assert_eq!(data.managed_approval_required, Some(true)); assert_eq!( - notification_permission_payload(&PermissionResult::user_not_available()), - Some(json!({ "kind": "user-not-available" })) + data.extra["permissionRequest"]["path"], + "/workspace/file.txt" + ); + } + + #[test] + fn permission_request_data_preserves_managed_flag_when_other_fields_are_malformed() { + let data = permission_request_data( + &json!({ + "requestId": "permission-1", + "permissionRequest": { + "kind": "read", + "managedApprovalRequired": true, + "toolCallId": 42 + } + }), + false, ); + + assert_eq!(data.managed_approval_required, Some(true)); + assert_eq!(data.extra["requestId"], "permission-1"); + } + + #[test] + fn permission_request_data_fails_closed_for_malformed_managed_flag() { + let data = permission_request_data( + &json!({ + "requestId": "permission-1", + "permissionRequest": { + "kind": "read", + "managedApprovalRequired": "yes", + "path": "/workspace/file.txt" + } + }), + false, + ); + + assert_eq!(data.managed_approval_required, Some(true)); + } + + #[test] + fn permission_request_data_preserves_valid_false_managed_flag() { + let data = permission_request_data( + &json!({ + "requestId": "permission-1", + "permissionRequest": { + "kind": "read", + "managedApprovalRequired": false, + "path": "/workspace/file.txt" + } + }), + false, + ); + + assert_eq!(data.managed_approval_required, Some(false)); } } diff --git a/rust/src/session_events.rs b/rust/src/session_events.rs new file mode 100644 index 000000000..a41de9415 --- /dev/null +++ b/rust/src/session_events.rs @@ -0,0 +1,8 @@ +//! Session event payload types — auto-generated from the +//! `session-events.schema.json` protocol schema. +//! +//! This is the stable public access point for the generated event types. +//! The underlying crate-private module where the types are defined is +//! an implementation detail whose layout may change. + +pub use crate::generated::session_events::*; diff --git a/rust/src/session_fs.rs b/rust/src/session_fs.rs index da4d3e3c9..87868101f 100644 --- a/rust/src/session_fs.rs +++ b/rust/src/session_fs.rs @@ -47,11 +47,14 @@ use std::fmt; use async_trait::async_trait; -pub use crate::generated::api_types::SessionFsSqliteQueryType; use crate::generated::api_types::{ SessionFsError, SessionFsErrorCode, SessionFsReaddirWithTypesEntry, SessionFsReaddirWithTypesEntryType, SessionFsSetProviderConventions, SessionFsStatResult, }; +pub use crate::generated::api_types::{ + SessionFsSqliteQueryType, SessionFsSqliteTransactionErrorClass, + SessionFsSqliteTransactionStatement, +}; use crate::{Custom, Repr}; /// Optional capabilities declared by a session filesystem provider. @@ -528,10 +531,76 @@ pub trait SessionFsSqliteProvider: Send + Sync { params: Option<&HashMap>, ) -> Result, FsError>; + /// Execute `statements` atomically against the provider's per-session + /// database, returning one result per statement, in order. + /// + /// Return `Err` with a [`SessionFsSqliteTransactionError`] describing how + /// the failure should be classified. `BusyOrLocked` guarantees the + /// transaction rolled back and is safe to retry; `PostCommitAmbiguous` + /// must never be retried. + async fn sqlite_transaction( + &self, + _statements: &[SessionFsSqliteTransactionStatement], + ) -> Result, SessionFsSqliteTransactionError> { + Err(SessionFsSqliteTransactionError::fatal( + "SQLite transactions are not supported by this SessionFs provider", + )) + } + /// Check whether the provider has a SQLite database for this session. async fn sqlite_exists(&self) -> Result; } +/// Classified SQLite transaction failure returned by +/// [`SessionFsSqliteProvider::sqlite_transaction`]. +#[derive(Debug, Clone)] +pub struct SessionFsSqliteTransactionError { + /// How the runtime should classify the failure. + pub error_class: SessionFsSqliteTransactionErrorClass, + /// Human-readable failure description. + pub message: String, +} + +impl SessionFsSqliteTransactionError { + /// Create a `Fatal` transaction error with the given message. + pub fn fatal(message: impl Into) -> Self { + Self { + error_class: SessionFsSqliteTransactionErrorClass::Fatal, + message: message.into(), + } + } + + /// Create a `BusyOrLocked` transaction error with the given message. + pub fn busy_or_locked(message: impl Into) -> Self { + Self { + error_class: SessionFsSqliteTransactionErrorClass::BusyOrLocked, + message: message.into(), + } + } + + /// Create a `PostCommitAmbiguous` transaction error with the given message. + pub fn post_commit_ambiguous(message: impl Into) -> Self { + Self { + error_class: SessionFsSqliteTransactionErrorClass::PostCommitAmbiguous, + message: message.into(), + } + } +} + +impl std::fmt::Display for SessionFsSqliteTransactionError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.message) + } +} + +impl std::error::Error for SessionFsSqliteTransactionError {} + +impl From for SessionFsSqliteTransactionError { + fn from(error: FsError) -> Self { + Self::fatal(error.to_string()) + } +} + /// Result of a SQLite query execution via [`SessionFsSqliteProvider::sqlite_query`]. /// /// Same shape as the generated RPC type but without the `error` field, diff --git a/rust/src/session_fs_dispatch.rs b/rust/src/session_fs_dispatch.rs index 9c5780d37..c84981ac0 100644 --- a/rust/src/session_fs_dispatch.rs +++ b/rust/src/session_fs_dispatch.rs @@ -18,7 +18,10 @@ use crate::generated::api_types::{ SessionFsReaddirWithTypesRequest, SessionFsReaddirWithTypesResult, SessionFsRenameRequest, SessionFsRmRequest, SessionFsSqliteExistsParams, SessionFsSqliteExistsResult, SessionFsSqliteQueryRequest, SessionFsSqliteQueryResult as GeneratedSqliteQueryResult, - SessionFsStatRequest, SessionFsStatResult, SessionFsWriteFileRequest, + SessionFsSqliteTransactionError as GeneratedSqliteTransactionError, + SessionFsSqliteTransactionErrorClass, SessionFsSqliteTransactionRequest, + SessionFsSqliteTransactionResult as GeneratedSqliteTransactionResult, SessionFsStatRequest, + SessionFsStatResult, SessionFsWriteFileRequest, }; use crate::session_fs::SessionFsProvider; use crate::{Client, JsonRpcRequest, JsonRpcResponse, error_codes}; @@ -371,6 +374,69 @@ pub(crate) async fn sqlite_query( respond(client, id, result).await; } +pub(crate) async fn sqlite_transaction( + client: &Client, + provider: &Arc, + request: JsonRpcRequest, +) { + let params: SessionFsSqliteTransactionRequest = match parse_params(&request) { + Some(p) => p, + None => { + send_error( + client, + request.id, + "invalid sessionFs.sqliteTransaction params", + ) + .await; + return; + } + }; + let id = request.id; + let sqlite = match provider.sqlite() { + Some(s) => s, + None => { + // SQLite not supported — return a result-level error, not a + // transport error, so the CLI can surface it gracefully. + respond( + client, + id, + GeneratedSqliteTransactionResult { + results: Vec::new(), + error: Some(GeneratedSqliteTransactionError { + error_class: SessionFsSqliteTransactionErrorClass::Fatal, + message: "SQLite is not supported by this SessionFs provider".to_string(), + }), + }, + ) + .await; + return; + } + }; + let result = match sqlite.sqlite_transaction(¶ms.statements).await { + Ok(results) => GeneratedSqliteTransactionResult { + results: results + .into_iter() + .map(|result| GeneratedSqliteQueryResult { + columns: result.columns, + rows: result.rows, + rows_affected: result.rows_affected, + last_insert_rowid: result.last_insert_rowid, + error: None, + }) + .collect(), + error: None, + }, + Err(e) => GeneratedSqliteTransactionResult { + results: Vec::new(), + error: Some(GeneratedSqliteTransactionError { + error_class: e.error_class, + message: e.message, + }), + }, + }; + respond(client, id, result).await; +} + pub(crate) async fn sqlite_exists( client: &Client, provider: &Arc, @@ -431,6 +497,7 @@ pub(crate) async fn dispatch( "sessionFs.rm" => rm(client, &provider, request).await, "sessionFs.rename" => rename(client, &provider, request).await, "sessionFs.sqliteQuery" => sqlite_query(client, &provider, request).await, + "sessionFs.sqliteTransaction" => sqlite_transaction(client, &provider, request).await, "sessionFs.sqliteExists" => sqlite_exists(client, &provider, request).await, _ => { warn!(method = %method, "unknown sessionFs.* method"); diff --git a/rust/src/startup_timings.rs b/rust/src/startup_timings.rs new file mode 100644 index 000000000..7938a462b --- /dev/null +++ b/rust/src/startup_timings.rs @@ -0,0 +1,105 @@ +//! Per-phase timing breakdown for [`Client::start`](crate::Client::start). +//! +//! `Client::start` performs several sequential phases between "spawn the CLI" +//! and "client is ready to create sessions": resolving (and possibly +//! extracting) the CLI binary, spawning the subprocess, waiting for the TCP +//! port announcement, the `connect` protocol handshake, and the optional +//! `sessionFs.setProvider` / `llmInference.setProvider` registration RPCs. +//! +//! Each phase is already measured internally with an [`Instant`] and logged at +//! `debug`. [`StartupTimings`] aggregates those durations into a single value +//! so a host can attribute total startup latency ("time to first token" +//! groundwork) to a specific phase — e.g. separating "process exec cost" from +//! "handshake/negotiation cost" — instead of reconstructing it from scattered +//! log lines. +//! +//! Retrieve it after start via +//! [`Client::startup_timings`](crate::Client::startup_timings). +//! +//! [`Instant`]: std::time::Instant + +use std::time::Duration; + +/// Millisecond breakdown of the phases of [`Client::start`](crate::Client::start). +/// +/// Optional fields represent phases that do not run for every configuration: +/// `program_resolve_ms` is `None` when the caller supplies an explicit CLI path +/// (no resolution/extraction), `port_wait_ms` is `Some` only for the TCP +/// transport, and `session_fs_ms` / `llm_handler_ms` are `Some` only when the +/// corresponding option is configured. `process_spawn_ms` is `None` for +/// transports that do not spawn a subprocess (external server, in-process FFI +/// runtime). `transport_setup_ms`, `handshake_ms`, and `total_ms` are always +/// populated for a value returned by +/// [`Client::startup_timings`](crate::Client::startup_timings). +/// +/// Durations are whole milliseconds, matching the existing `elapsed_ms` +/// tracing fields. +#[derive(Debug, Clone, Default, PartialEq, Eq)] +#[non_exhaustive] +pub struct StartupTimings { + /// Time spent in `resolve::copilot_binary_with_extract_dir` locating (and, + /// for a bundled CLI, extracting) the copilot binary. `None` when the + /// caller passes an explicit [`CliProgram::Path`](crate::CliProgram::Path). + pub program_resolve_ms: Option, + /// Time spent spawning the CLI subprocess (`command.spawn()`). `None` for + /// the external-server and in-process transports, which do not spawn a + /// child. + pub process_spawn_ms: Option, + /// Time spent waiting for the TCP server to announce its listening port on + /// stdout. `Some` only for the TCP transport. + pub port_wait_ms: Option, + /// Total transport setup time. This includes spawning and connecting to a + /// subprocess, connecting to an external server, or starting the in-process + /// FFI runtime. `process_spawn_ms` and `port_wait_ms` provide nested detail + /// for spawned transports. + pub transport_setup_ms: u64, + /// Time spent on the `connect` protocol handshake in + /// [`Client::verify_protocol_version`](crate::Client::verify_protocol_version), + /// including the fallback to the legacy `ping` RPC. + pub handshake_ms: u64, + /// Time spent registering the filesystem provider via + /// `sessionFs.setProvider`. `Some` only when + /// [`ClientOptions::session_fs`](crate::ClientOptions::session_fs) is set. + pub session_fs_ms: Option, + /// Time spent registering the LLM inference provider via + /// `llmInference.setProvider`. `Some` only when + /// [`ClientOptions::request_handler`](crate::ClientOptions::request_handler) + /// is set. + pub llm_handler_ms: Option, + /// Total wall-clock time for [`Client::start`](crate::Client::start), from + /// entry to the client being ready. Always present. + pub total_ms: u64, +} + +impl StartupTimings { + /// Whole milliseconds of `duration`, saturating at [`u64::MAX`]. + pub(crate) fn millis(duration: Duration) -> u64 { + u64::try_from(duration.as_millis()).unwrap_or(u64::MAX) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn millis_truncates_to_whole_milliseconds() { + assert_eq!(StartupTimings::millis(Duration::from_micros(1_999)), 1); + assert_eq!(StartupTimings::millis(Duration::from_millis(250)), 250); + assert_eq!(StartupTimings::millis(Duration::ZERO), 0); + } + + #[test] + fn default_leaves_every_phase_unset() { + let timings = StartupTimings::default(); + assert_eq!(timings, StartupTimings::default()); + assert!(timings.program_resolve_ms.is_none()); + assert!(timings.process_spawn_ms.is_none()); + assert!(timings.port_wait_ms.is_none()); + assert_eq!(timings.transport_setup_ms, 0); + assert_eq!(timings.handshake_ms, 0); + assert!(timings.session_fs_ms.is_none()); + assert!(timings.llm_handler_ms.is_none()); + assert_eq!(timings.total_ms, 0); + } +} diff --git a/rust/src/tool.rs b/rust/src/tool.rs index 189bc6f21..344d2894c 100644 --- a/rust/src/tool.rs +++ b/rust/src/tool.rs @@ -13,9 +13,8 @@ //! Enable the `derive` feature for `schema_for`, which generates JSON //! Schema from Rust types via `schemars`. -use std::collections::HashMap; - use async_trait::async_trait; +use indexmap::IndexMap; /// Re-export of [`schemars::JsonSchema`] for deriving tool parameter schemas. #[cfg(feature = "derive")] pub use schemars::JsonSchema; @@ -80,14 +79,14 @@ pub fn schema_for() -> serde_json::Value { /// tool.parameters = tool_parameters(serde_json::json!({"type": "object"})); /// # let _ = tool; /// ``` -pub fn tool_parameters(schema: serde_json::Value) -> HashMap { +pub fn tool_parameters(schema: serde_json::Value) -> IndexMap { try_tool_parameters(schema).expect("tool parameter schema must be a JSON object") } /// Fallible variant of [`tool_parameters`] for callers handling dynamic schema input. pub fn try_tool_parameters( schema: serde_json::Value, -) -> Result, serde_json::Error> { +) -> Result, serde_json::Error> { serde_json::from_value(schema) } @@ -174,6 +173,7 @@ pub fn convert_mcp_call_tool_result(value: &serde_json::Value) -> Option = tool.parameters.keys().map(String::as_str).collect(); + assert_eq!( + keys, + ["additionalProperties", "properties", "required", "type"] + ); + } + #[test] fn convert_mcp_call_tool_result_collects_text_and_binary_content() { let result = convert_mcp_call_tool_result(&serde_json::json!({ @@ -566,6 +604,7 @@ mod tests { tool_call_id: "tc1".to_string(), tool_name: "echo".to_string(), arguments: serde_json::json!({"msg": "hello"}), + available_tools: None, traceparent: None, tracestate: None, }; @@ -606,6 +645,7 @@ mod tests { tool_call_id: "tc1".to_string(), tool_name: "weather".to_string(), arguments: serde_json::json!({"city": "Seattle"}), + available_tools: None, traceparent: None, tracestate: None, }; @@ -688,6 +728,7 @@ mod tests { tool_call_id: "tc1".to_string(), tool_name: "get_weather".to_string(), arguments: serde_json::json!({"city": "Seattle", "unit": "celsius"}), + available_tools: None, traceparent: None, tracestate: None, }; @@ -707,6 +748,7 @@ mod tests { tool_call_id: "tc1".to_string(), tool_name: "get_weather".to_string(), arguments: serde_json::json!({"wrong_field": 42}), + available_tools: None, traceparent: None, tracestate: None, }; @@ -728,6 +770,7 @@ mod tests { tool_call_id: "tc1".to_string(), tool_name: "get_weather".to_string(), arguments: serde_json::json!({"city": "Portland"}), + available_tools: None, traceparent: None, tracestate: None, }) diff --git a/rust/src/types.rs b/rust/src/types.rs index e4b9d48e2..392e0f840 100644 --- a/rust/src/types.rs +++ b/rust/src/types.rs @@ -9,21 +9,32 @@ use std::path::{Path, PathBuf}; use std::sync::Arc; use std::time::Duration; +use indexmap::IndexMap; use serde::{Deserialize, Serialize}; use serde_json::Value; use crate::canvas::{CanvasDeclaration, CanvasHandler}; -use crate::generated::api_types::OpenCanvasInstance; +pub use crate::copilot_request_handler::{ + CopilotHttpRequest, CopilotHttpResponse, CopilotHttpResponseBody, CopilotRequestContext, + CopilotRequestError, CopilotRequestHandler, CopilotRequestTransport, CopilotWebSocketForwarder, + CopilotWebSocketForwarderBuilder, CopilotWebSocketHandler, CopilotWebSocketMessage, + CopilotWebSocketResponse, WebSocketTransform, forward_http, +}; +use crate::generated::api_types::{CurrentToolMetadata, OpenCanvasInstance}; use crate::generated::session_events::ReasoningSummary; +/// Context window tier for models that support tiered context windows. +pub use crate::generated::session_events::{ContextTier, SessionLimitsConfig}; use crate::handler::{ - AutoModeSwitchHandler, ElicitationHandler, ExitPlanModeHandler, PermissionHandler, - UserInputHandler, + AutoModeSwitchHandler, ElicitationHandler, ExitPlanModeHandler, McpAuthHandler, + PermissionHandler, UserInputHandler, }; use crate::hooks::SessionHooks; +use crate::provider_token::BearerTokenProvider; pub use crate::session_fs::{ DirEntry, DirEntryKind, FileInfo, FsError, SessionFsCapabilities, SessionFsConfig, SessionFsConventions, SessionFsProvider, SessionFsSqliteProvider, SessionFsSqliteQueryResult, - SessionFsSqliteQueryType, + SessionFsSqliteQueryType, SessionFsSqliteTransactionError, + SessionFsSqliteTransactionErrorClass, SessionFsSqliteTransactionStatement, }; pub use crate::trace_context::{TraceContext, TraceContextProvider}; use crate::transforms::SystemMessageTransform; @@ -323,8 +334,8 @@ pub struct Tool { #[serde(default, skip_serializing_if = "Option::is_none")] pub instructions: Option, /// JSON Schema for the tool's input parameters. - #[serde(default, skip_serializing_if = "HashMap::is_empty")] - pub parameters: HashMap, + #[serde(default, skip_serializing_if = "IndexMap::is_empty")] + pub parameters: IndexMap, /// When `true`, this tool replaces a built-in tool of the same name /// (e.g. supplying a custom `grep` that the agent uses in place of the /// CLI's built-in implementation). @@ -335,6 +346,25 @@ pub struct Tool { /// access control. #[serde(default, skip_serializing_if = "is_false")] pub skip_permission: bool, + /// When `true`, a successful call to this tool ends the agent turn: the + /// runtime's tool phase halts instead of feeding the result back to the + /// model for another round. A failed call leaves the loop running so the + /// model can read the error and retry. + #[serde(default, skip_serializing_if = "is_false")] + pub is_terminal: bool, + /// Controls whether the tool may be deferred (loaded lazily via tool + /// search) rather than always pre-loaded. When [`DeferMode::Auto`], the + /// tool can be deferred and surfaced through tool search. When + /// [`DeferMode::Never`], the tool is always pre-loaded. `None` lets the + /// runtime decide. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub defer: Option, + /// Opaque, host-defined metadata associated with the tool definition. + /// Keys are namespaced and not part of the stable public API; values are + /// not interpreted and may be recognized to inform host-specific behavior. + /// Unknown keys are preserved and round-tripped untouched. + #[serde(default, skip_serializing_if = "IndexMap::is_empty")] + pub metadata: IndexMap, /// Optional runtime implementation. When `Some`, the SDK dispatches /// matching `external_tool.requested` broadcasts to this handler. /// When `None`, the tool is declaration-only. @@ -355,6 +385,17 @@ fn is_false(b: &bool) -> bool { !*b } +/// Controls whether a [`Tool`] may be deferred (loaded lazily via tool search) +/// rather than always pre-loaded. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "lowercase")] +pub enum DeferMode { + /// The tool can be deferred and surfaced through tool search. + Auto, + /// The tool is always pre-loaded. + Never, +} + impl Tool { /// Construct a new [`Tool`] with the given name and otherwise default /// values. The struct is `#[non_exhaustive]`, so external callers @@ -435,6 +476,33 @@ impl Tool { self } + /// Sets whether a successful call to this tool ends the agent turn. + /// + /// When `true`, the runtime's tool phase halts after a successful call + /// instead of feeding the result back to the model for another round. A + /// failed call leaves the loop running so the model can read the error and + /// retry. + #[must_use] + pub fn with_is_terminal(mut self, is_terminal: bool) -> Self { + self.is_terminal = is_terminal; + self + } + + /// Set the deferral mode controlling whether the tool may be loaded + /// lazily via tool search ([`DeferMode::Auto`]) or always pre-loaded + /// ([`DeferMode::Never`]). + pub fn with_defer(mut self, defer: DeferMode) -> Self { + self.defer = Some(defer); + self + } + + /// Set opaque, host-defined metadata for the tool. Keys are namespaced and + /// not part of the stable public API. Replaces any previously-set metadata. + pub fn with_metadata(mut self, metadata: IndexMap) -> Self { + self.metadata = metadata; + self + } + /// Attach a runtime implementation. The SDK will dispatch matching /// `external_tool.requested` broadcasts to `handler` for this tool's /// name. Without a handler the tool is declaration-only. @@ -462,6 +530,9 @@ impl std::fmt::Debug for Tool { .field("parameters", &self.parameters) .field("overrides_built_in_tool", &self.overrides_built_in_tool) .field("skip_permission", &self.skip_permission) + .field("is_terminal", &self.is_terminal) + .field("defer", &self.defer) + .field("metadata", &self.metadata) .field( "handler", &self.handler.as_ref().map(|_| "").unwrap_or("None"), @@ -578,7 +649,7 @@ pub struct CustomAgentConfig { pub prompt: String, /// MCP servers specific to this agent. #[serde(default, skip_serializing_if = "Option::is_none")] - pub mcp_servers: Option>, + pub mcp_servers: Option>, /// Whether the agent is available for model inference. #[serde(default, skip_serializing_if = "Option::is_none")] pub infer: Option, @@ -591,6 +662,12 @@ pub struct CustomAgentConfig { /// falling back to the parent session model if unavailable. #[serde(default, skip_serializing_if = "Option::is_none")] pub model: Option, + /// Reasoning effort level for this agent's model. + /// + /// When unset, the runtime resolves model configuration, then inherits the + /// parent effort only for the same model. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub reasoning_effort: Option, } impl CustomAgentConfig { @@ -632,7 +709,7 @@ impl CustomAgentConfig { } /// Configure agent-specific MCP servers. - pub fn with_mcp_servers(mut self, mcp_servers: HashMap) -> Self { + pub fn with_mcp_servers(mut self, mcp_servers: IndexMap) -> Self { self.mcp_servers = Some(mcp_servers); self } @@ -658,6 +735,12 @@ impl CustomAgentConfig { self.model = Some(model.into()); self } + + /// Set the reasoning effort level for this agent's model. + pub fn with_reasoning_effort(mut self, reasoning_effort: impl Into) -> Self { + self.reasoning_effort = Some(reasoning_effort.into()); + self + } } /// Configures the default (built-in) agent that handles turns when no @@ -722,6 +805,119 @@ impl LargeToolOutputConfig { } } +/// Overrides the runtime's built-in tool-search behavior. +/// +/// Tool search defers tools to keep the model's active tool set small. +/// To override the tool-search tool's implementation, register a [`Tool`] +/// named `"tool_search_tool"` with [`Tool::overrides_built_in_tool`] set to `true`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ToolSearchConfig { + /// Toggle to enable/disable tool search. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enabled: Option, + /// The tool count above which MCP and external tools are deferred behind + /// tool search. When unset, the runtime default (30) applies. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub defer_threshold: Option, +} + +impl ToolSearchConfig { + /// Construct an empty [`ToolSearchConfig`]; all fields default to unset + /// (the runtime applies its own defaults). + pub fn new() -> Self { + Self::default() + } + + /// Toggle that enables or disables tool search. + pub fn with_enabled(mut self, enabled: bool) -> Self { + self.enabled = Some(enabled); + self + } + + /// Set the tool count above which MCP and external tools are deferred + /// behind tool search. + pub fn with_defer_threshold(mut self, defer_threshold: u32) -> Self { + self.defer_threshold = Some(defer_threshold); + self + } +} + +/// Configuration for the built-in GitHub MCP server. +/// +/// `disable_form_deferral` only applies to the built-in GitHub MCP server and +/// only has an effect when MCP Apps and form-backed GitHub tools are enabled. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct GitHubMcpToolConfig { + /// Whether all GitHub MCP tools are enabled. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enable_all_tools: Option, + /// Additional GitHub MCP toolsets to enable. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub additional_toolsets: Option>, + /// Additional GitHub MCP tools to enable. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub additional_tools: Option>, + /// Whether GitHub MCP insiders mode is enabled. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enable_insiders_mode: Option, + /// Disables form deferral for GitHub MCP tools. This only applies to the + /// built-in GitHub MCP server and only has an effect when MCP Apps and + /// form-backed GitHub tools are enabled. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub disable_form_deferral: Option, +} + +impl GitHubMcpToolConfig { + /// Construct an empty GitHub MCP tool configuration. + pub fn new() -> Self { + Self::default() + } + + /// Set whether all GitHub MCP tools are enabled. + pub fn with_enable_all_tools(mut self, value: bool) -> Self { + self.enable_all_tools = Some(value); + self + } + + /// Set the additional GitHub MCP toolsets to enable. + pub fn with_additional_toolsets(mut self, values: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.additional_toolsets = Some(values.into_iter().map(Into::into).collect()); + self + } + + /// Set the additional GitHub MCP tools to enable. + pub fn with_additional_tools(mut self, values: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.additional_tools = Some(values.into_iter().map(Into::into).collect()); + self + } + + /// Set whether GitHub MCP insiders mode is enabled. + pub fn with_enable_insiders_mode(mut self, value: bool) -> Self { + self.enable_insiders_mode = Some(value); + self + } + + /// Disable form deferral for GitHub MCP tools. This only applies to the + /// built-in GitHub MCP server and only has an effect when MCP Apps and + /// form-backed GitHub tools are enabled. + pub fn with_disable_form_deferral(mut self, value: bool) -> Self { + self.disable_form_deferral = Some(value); + self + } +} + /// Configures infinite sessions: persistent workspaces with automatic /// context-window compaction. /// @@ -774,6 +970,42 @@ impl InfiniteSessionConfig { } } +/// Per-session configuration for the runtime memory feature. +/// +/// Supplied via [`SessionConfig::with_memory`] / +/// [`ResumeSessionConfig::with_memory`]. When a session is created or resumed +/// without a memory configuration, the runtime applies its own default for the +/// memory feature. +/// +/// The type is extensible: today it carries [`enabled`](Self::enabled), and +/// further tuning knobs can be added as optional fields without a breaking +/// change. +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct MemoryConfiguration { + /// Whether the memory feature is enabled for this session. + pub enabled: bool, +} + +impl MemoryConfiguration { + /// A configuration with the memory feature enabled. + pub fn enabled() -> Self { + Self { enabled: true } + } + + /// A configuration with the memory feature disabled. + pub fn disabled() -> Self { + Self { enabled: false } + } + + /// Set whether the memory feature is enabled. + pub fn with_enabled(mut self, enabled: bool) -> Self { + self.enabled = enabled; + self + } +} + /// GitHub repository metadata to associate with a cloud session. #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -844,6 +1076,42 @@ impl ExtensionInfo { } } +/// Stable identity for a host/SDK connection that supplies built-in canvases. +/// +/// When set on session create or resume, the runtime uses [`id`] verbatim as +/// the agent-facing canvas extension id, so canvases declared on a control +/// connection survive stdio reconnect and CLI process restart instead of being +/// re-keyed to a per-connection id. The id is opaque to the runtime; a +/// per-window-stable value such as `app:builtin:` is recommended. An +/// id beginning with `connection:` is reserved and ignored by the runtime. +/// +/// [`id`]: CanvasProviderIdentity::id +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct CanvasProviderIdentity { + /// Opaque, stable provider id used verbatim as the canvas extension id. + pub id: String, + /// Optional display name surfaced as the canvas extension name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, +} + +impl CanvasProviderIdentity { + /// Create a canvas provider identity from a stable opaque id. + pub fn new(id: impl Into) -> Self { + Self { + id: id.into(), + name: None, + } + } + + /// Set the optional display name surfaced as the canvas extension name. + pub fn with_name(mut self, name: impl Into) -> Self { + self.name = Some(name.into()); + self + } +} + /// Configuration for a single MCP server. /// /// MCP (Model Context Protocol) servers expose external tools to the @@ -857,8 +1125,8 @@ impl ExtensionInfo { /// /// ``` /// # use github_copilot_sdk::types::{McpServerConfig, McpStdioServerConfig, McpHttpServerConfig}; -/// # use std::collections::HashMap; -/// let mut servers = HashMap::new(); +/// # use github_copilot_sdk::IndexMap; +/// let mut servers = IndexMap::new(); /// servers.insert( /// "playwright".to_string(), /// McpServerConfig::Stdio(McpStdioServerConfig { @@ -950,7 +1218,7 @@ pub struct McpHttpServerConfig { /// Routes session requests through an alternative model provider /// (OpenAI-compatible, Azure, Anthropic, or local) instead of GitHub /// Copilot's default routing. -#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[derive(Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] #[non_exhaustive] pub struct ProviderConfig { @@ -962,6 +1230,12 @@ pub struct ProviderConfig { /// Defaults to `"completions"`. #[serde(default, skip_serializing_if = "Option::is_none")] pub wire_api: Option, + /// Transport for OpenAI Responses requests: `"http"` or `"websockets"`. + /// Defaults to `"http"`. Set `"websockets"` to deliver Responses API + /// requests over a persistent WebSocket connection instead of HTTP. + /// Applies to OpenAI-compatible providers using `wire_api` `"responses"`. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub transport: Option, /// API endpoint URL. pub base_url: String, /// API key. Optional for local providers like Ollama. @@ -972,6 +1246,12 @@ pub struct ProviderConfig { /// API key. Takes precedence over `api_key` when both are set. #[serde(default, skip_serializing_if = "Option::is_none")] pub bearer_token: Option, + /// **Experimental.** Callback used to acquire a bearer token before each + /// outbound request to this provider. + #[serde(skip)] + pub bearer_token_provider: Option>, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub(crate) has_bearer_token_provider: Option, /// Azure-specific options. #[serde(default, skip_serializing_if = "Option::is_none")] pub azure: Option, @@ -1003,6 +1283,30 @@ pub struct ProviderConfig { pub max_output_tokens: Option, } +impl std::fmt::Debug for ProviderConfig { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("ProviderConfig") + .field("provider_type", &self.provider_type) + .field("wire_api", &self.wire_api) + .field("transport", &self.transport) + .field("base_url", &self.base_url) + .field("api_key", &self.api_key) + .field("bearer_token", &self.bearer_token) + .field( + "bearer_token_provider", + &self.bearer_token_provider.as_ref().map(|_| ""), + ) + .field("has_bearer_token_provider", &self.has_bearer_token_provider) + .field("azure", &self.azure) + .field("headers", &self.headers) + .field("model_id", &self.model_id) + .field("wire_model", &self.wire_model) + .field("max_prompt_tokens", &self.max_prompt_tokens) + .field("max_output_tokens", &self.max_output_tokens) + .finish() + } +} + impl ProviderConfig { /// Construct a [`ProviderConfig`] with the required `base_url` set; /// all other fields default to unset. @@ -1025,6 +1329,13 @@ impl ProviderConfig { self } + /// Set the transport (`"http"` or `"websockets"`) for OpenAI Responses + /// requests. Defaults to `"http"`. + pub fn with_transport(mut self, transport: impl Into) -> Self { + self.transport = Some(transport.into()); + self + } + /// Set the API key. Optional for local providers like Ollama. pub fn with_api_key(mut self, api_key: impl Into) -> Self { self.api_key = Some(api_key.into()); @@ -1038,6 +1349,16 @@ impl ProviderConfig { self } + /// Set the callback used to acquire a bearer token before each outbound + /// request to this provider. + /// + /// **Experimental.** This method is part of an experimental wire-protocol + /// surface and may change or be removed in a future release. + pub fn with_bearer_token_provider(mut self, provider: Arc) -> Self { + self.bearer_token_provider = Some(provider); + self + } + /// Set Azure-specific options. pub fn with_azure(mut self, azure: AzureProviderOptions) -> Self { self.azure = Some(azure); @@ -1082,24 +1403,468 @@ impl ProviderConfig { } } +/// Provider-scoped Copilot API (CAPI) session options. +/// +/// WebSocket transport is the default for the CAPI Responses API whenever +/// the model advertises the `ws:/responses` endpoint. Set +/// [`enable_web_socket_responses`](Self::enable_web_socket_responses) to +/// `false` to force the HTTP Responses transport instead, which is useful +/// for users behind proxies where WebSockets fail. +/// +/// Setting it to `false` is equivalent to setting the +/// `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES` environment variable. The option +/// is scoped under the `capi` namespace because a single session can host +/// multiple providers, so transport choice is provider-level. +#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct CapiSessionOptions { + /// Whether to use WebSocket transport for CAPI Responses API calls. + /// + /// When `Some(false)`, the runtime uses HTTP Responses transport even if + /// the selected model advertises `ws:/responses`. When unset, the runtime + /// default applies (WebSocket transport when advertised). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enable_web_socket_responses: Option, +} + +impl CapiSessionOptions { + /// Construct CAPI session options with all fields unset. + pub fn new() -> Self { + Self::default() + } + + /// Set whether to use WebSocket transport for CAPI Responses API calls. + pub fn with_enable_web_socket_responses(mut self, enable: bool) -> Self { + self.enable_web_socket_responses = Some(enable); + self + } +} + /// Azure-specific provider options. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct AzureProviderOptions { - /// Azure API version. Defaults to `"2024-10-21"`. + /// Azure API version. When omitted, the runtime uses the GA versionless v1 route. #[serde(default, skip_serializing_if = "Option::is_none")] pub api_version: Option, } -/// Configuration for creating a new session via the `session.create` RPC. -/// -/// All fields are optional — the CLI applies sensible defaults. +/// A named BYOK provider connection in the multi-provider registry. /// -/// # Construction +/// **Experimental.** Multi-provider BYOK configuration is part of an +/// experimental surface and may change or be removed in a future release. /// -/// Two equivalent shapes are supported: +/// Unlike [`ProviderConfig`], which routes the whole session through a +/// single provider, named providers are additive: the session keeps its +/// default Copilot routing and exposes these providers' models alongside +/// it. Models are attached via [`ProviderModelConfig`], which references a +/// provider by [`name`](Self::name). +#[derive(Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct NamedProviderConfig { + /// Unique name used by [`ProviderModelConfig::provider`] to reference + /// this connection. + pub name: String, + /// Provider type: `"openai"`, `"azure"`, or `"anthropic"`. Defaults to + /// `"openai"` on the CLI. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub provider_type: Option, + /// API format (openai/azure only): `"completions"` or `"responses"`. + /// Defaults to `"completions"`. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub wire_api: Option, + /// API endpoint URL. + pub base_url: String, + /// API key. Optional for local providers like Ollama. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub api_key: Option, + /// Bearer token for authentication. Sets the `Authorization` header + /// directly. Takes precedence over `api_key` when both are set. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub bearer_token: Option, + /// **Experimental.** Callback used to acquire a bearer token before each + /// outbound request to this provider. + #[serde(skip)] + pub bearer_token_provider: Option>, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub(crate) has_bearer_token_provider: Option, + /// Azure-specific options. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub azure: Option, + /// Custom HTTP headers included in outbound provider requests. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub headers: Option>, +} + +impl std::fmt::Debug for NamedProviderConfig { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("NamedProviderConfig") + .field("name", &self.name) + .field("provider_type", &self.provider_type) + .field("wire_api", &self.wire_api) + .field("base_url", &self.base_url) + .field("api_key", &self.api_key) + .field("bearer_token", &self.bearer_token) + .field( + "bearer_token_provider", + &self.bearer_token_provider.as_ref().map(|_| ""), + ) + .field("has_bearer_token_provider", &self.has_bearer_token_provider) + .field("azure", &self.azure) + .field("headers", &self.headers) + .finish() + } +} + +impl NamedProviderConfig { + /// Construct a [`NamedProviderConfig`] with the required `name` and + /// `base_url` set; all other fields default to unset. + pub fn new(name: impl Into, base_url: impl Into) -> Self { + Self { + name: name.into(), + base_url: base_url.into(), + ..Self::default() + } + } + + /// Set the provider type (`"openai"`, `"azure"`, or `"anthropic"`). + pub fn with_provider_type(mut self, provider_type: impl Into) -> Self { + self.provider_type = Some(provider_type.into()); + self + } + + /// Set the API format (`"completions"` or `"responses"`; openai/azure only). + pub fn with_wire_api(mut self, wire_api: impl Into) -> Self { + self.wire_api = Some(wire_api.into()); + self + } + + /// Set the API key. Optional for local providers like Ollama. + pub fn with_api_key(mut self, api_key: impl Into) -> Self { + self.api_key = Some(api_key.into()); + self + } + + /// Set the bearer token used to populate the `Authorization` header. + /// Takes precedence over `api_key` when both are set. + pub fn with_bearer_token(mut self, bearer_token: impl Into) -> Self { + self.bearer_token = Some(bearer_token.into()); + self + } + + /// Set the callback used to acquire a bearer token before each outbound + /// request to this provider. + /// + /// **Experimental.** This method is part of an experimental wire-protocol + /// surface and may change or be removed in a future release. + pub fn with_bearer_token_provider(mut self, provider: Arc) -> Self { + self.bearer_token_provider = Some(provider); + self + } + + /// Set Azure-specific options. + pub fn with_azure(mut self, azure: AzureProviderOptions) -> Self { + self.azure = Some(azure); + self + } + + /// Set the custom HTTP headers attached to outbound provider requests. + pub fn with_headers(mut self, headers: HashMap) -> Self { + self.headers = Some(headers); + self + } +} + +fn prepare_bearer_token_providers( + provider: &mut Option, + providers: &mut Option>, +) -> HashMap> { + let mut bearer_token_providers = HashMap::new(); + + if let Some(provider) = provider.as_mut() + && let Some(token_provider) = provider.bearer_token_provider.take() + { + provider.has_bearer_token_provider = Some(true); + bearer_token_providers.insert("default".to_string(), token_provider); + } + + if let Some(providers) = providers.as_mut() { + for provider in providers { + if let Some(token_provider) = provider.bearer_token_provider.take() { + provider.has_bearer_token_provider = Some(true); + bearer_token_providers.insert(provider.name.clone(), token_provider); + } + } + } + + bearer_token_providers +} + +/// A BYOK model definition in the multi-provider registry. /// -/// 1. **Chained builder** (preferred for compile-time-known values): +/// **Experimental.** Multi-provider BYOK configuration is part of an +/// experimental surface and may change or be removed in a future release. +/// +/// References a [`NamedProviderConfig`] by [`provider`](Self::provider) and +/// becomes selectable under the provider-qualified id `provider/id`. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ProviderModelConfig { + /// Model identifier, unique within its provider. Combined with + /// [`provider`](Self::provider) to form the selection id `provider/id`. + pub id: String, + /// Name of the [`NamedProviderConfig`] this model is served by. + pub provider: String, + /// Model name sent to the provider API for inference. Use when the + /// provider's model name differs from [`id`](Self::id). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub wire_model: Option, + /// Well-known model ID used to look up agent config and default token + /// limits. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub model_id: Option, + /// Human-readable display name. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Overrides the resolved model's default max prompt tokens. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub max_prompt_tokens: Option, + /// Overrides the resolved model's default max context window tokens. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub max_context_window_tokens: Option, + /// Overrides the resolved model's default max output tokens. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub max_output_tokens: Option, + /// Per-property overrides for model capabilities, deep-merged over + /// runtime defaults. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub capabilities: Option, +} + +impl ProviderModelConfig { + /// Construct a [`ProviderModelConfig`] with the required `id` and + /// `provider` set; all other fields default to unset. + pub fn new(id: impl Into, provider: impl Into) -> Self { + Self { + id: id.into(), + provider: provider.into(), + ..Self::default() + } + } + + /// Set the model name sent to the provider API for inference. + pub fn with_wire_model(mut self, wire_model: impl Into) -> Self { + self.wire_model = Some(wire_model.into()); + self + } + + /// Set the well-known model ID used to look up agent config and default + /// token limits. + pub fn with_model_id(mut self, model_id: impl Into) -> Self { + self.model_id = Some(model_id.into()); + self + } + + /// Set the human-readable display name. + pub fn with_name(mut self, name: impl Into) -> Self { + self.name = Some(name.into()); + self + } + + /// Override the resolved model's default max prompt tokens. + pub fn with_max_prompt_tokens(mut self, max: i64) -> Self { + self.max_prompt_tokens = Some(max); + self + } + + /// Override the resolved model's default max context window tokens. + pub fn with_max_context_window_tokens(mut self, max: i64) -> Self { + self.max_context_window_tokens = Some(max); + self + } + + /// Override the resolved model's default max output tokens. + pub fn with_max_output_tokens(mut self, max: i64) -> Self { + self.max_output_tokens = Some(max); + self + } + + /// Set per-property model capability overrides. + pub fn with_capabilities( + mut self, + capabilities: crate::generated::api_types::ModelCapabilitiesOverride, + ) -> Self { + self.capabilities = Some(capabilities); + self + } +} + +/// A single ExP (Experiment Platform) flag value. +/// +/// ExP assignments resolve to a string, number, boolean, or null. +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ExpFlagValue { + /// A boolean flag value. + Bool(bool), + /// An integer flag value. + Integer(i64), + /// A floating-point flag value. + Float(f64), + /// A string flag value. + String(String), + /// A null flag value. + Null, +} + +/// A single configuration entry in a [`CopilotExpAssignmentResponse`]. +/// +/// Each entry carries an identifier and a bag of typed parameter values. +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "PascalCase")] +pub struct ExpConfigEntry { + /// Identifier of the configuration entry. + pub id: String, + /// Parameter values keyed by parameter name. + pub parameters: HashMap, +} + +/// ExP ("flight") assignment data, in the same JSON shape the Copilot CLI +/// fetches from the experimentation service. +/// +/// Field names serialize as PascalCase (`Features`, `Flights`, ...) to match +/// the on-the-wire contract consumed by the runtime. +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "PascalCase")] +pub struct CopilotExpAssignmentResponse { + /// Enabled feature names. + #[serde(default)] + pub features: Vec, + /// Assigned flights keyed by flight name. + #[serde(default)] + pub flights: HashMap, + /// Configuration entries carrying typed parameter values. + #[serde(default)] + pub configs: Vec, + /// Opaque parameter-group payload passed through untouched. Optional. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub parameter_groups: Option, + /// Version of the flighting configuration. Optional. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub flighting_version: Option, + /// Impression identifier for the assignment. Optional. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub impression_id: Option, + /// Assignment context string forwarded to CAPI and telemetry. + #[serde(default)] + pub assignment_context: String, +} + +/// Controls whether bypass-permissions mode is available in a managed session. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "lowercase")] +#[non_exhaustive] +pub enum DisableBypassPermissionsMode { + /// Turn off bypass-permissions mode. + Disable, +} + +/// Permission rules injected as a managed-settings layer at session bootstrap. +/// +/// All fields are optional; an omitted field imposes no constraint from this +/// layer. This layer composes restrictively with any server- or device-level +/// managed settings: [`deny`](Self::deny) and [`ask`](Self::ask) rules are +/// unioned across layers, every present [`allow`](Self::allow) list must admit a +/// tool for it to be allowed, and +/// [`disable_bypass_permissions_mode`](Self::disable_bypass_permissions_mode) is +/// honored if any layer sets it (deny-wins). +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ManagedSettingsPermissions { + /// When set to `"disable"`, bypass-permissions mode is turned off for the + /// session regardless of other layers. Serialized as + /// `disableBypassPermissionsMode`. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub disable_bypass_permissions_mode: Option, + /// Tool-permission patterns that are always denied. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub deny: Option>, + /// Tool-permission patterns that require an explicit ask. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub ask: Option>, + /// Tool-permission patterns that are allowed without prompting. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub allow: Option>, +} + +impl ManagedSettingsPermissions { + /// Sets the bypass-permissions policy for this managed layer. + pub fn with_disable_bypass_permissions_mode( + mut self, + value: DisableBypassPermissionsMode, + ) -> Self { + self.disable_bypass_permissions_mode = Some(value); + self + } + + /// Sets the rules that are always denied. + pub fn with_deny(mut self, rules: Vec) -> Self { + self.deny = Some(rules); + self + } + + /// Sets the rules that require explicit approval. + pub fn with_ask(mut self, rules: Vec) -> Self { + self.ask = Some(rules); + self + } + + /// Sets the rules that are allowed without prompting. + pub fn with_allow(mut self, rules: Vec) -> Self { + self.allow = Some(rules); + self + } +} + +/// Managed-settings layer injected at session startup. Currently carries only a +/// [`permissions`](Self::permissions) object. +/// +/// This layer is startup-only and is not persisted with the session. It must be +/// re-supplied on resume to remain in effect; omitting it on resume clears the +/// previously injected layer. It can be combined with +/// [`SessionConfig::enable_managed_settings`]. Older runtimes may ignore this +/// additive field, so hosts must not rely on injected policy until they ship a +/// compatible runtime. +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ManagedSettings { + /// Permission rules for this managed-settings layer. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub permissions: Option, +} + +impl ManagedSettings { + /// Sets the permissions-only managed policy. + pub fn with_permissions(mut self, permissions: ManagedSettingsPermissions) -> Self { + self.permissions = Some(permissions); + self + } +} + +/// Configuration for creating a new session via the `session.create` RPC. +/// +/// All fields are optional — the CLI applies sensible defaults. +/// +/// # Construction +/// +/// Two equivalent shapes are supported: +/// +/// 1. **Chained builder** (preferred for compile-time-known values): /// /// ``` /// # use github_copilot_sdk::types::SessionConfig; @@ -1183,12 +1948,21 @@ pub struct SessionConfig { pub extension_sdk_path: Option, /// Stable extension identity for canvas/tool providers on this connection. pub extension_info: Option, + /// Stable identity for a host/SDK connection that supplies built-in + /// canvases, so they survive reconnect and CLI restart. + pub canvas_provider: Option, /// Allowlist of built-in tool names the agent may use. pub available_tools: Option>, /// Blocklist of built-in tool names the agent must not use. pub excluded_tools: Option>, + /// Names of built-in agents to exclude from the session. + /// + /// Excluded built-in agents are hidden from discovery and cannot be + /// selected or invoked unless a custom agent with the same name is + /// configured. + pub excluded_builtin_agents: Option>, /// MCP server configurations passed through to the CLI. - pub mcp_servers: Option>, + pub mcp_servers: Option>, /// Controls how MCP OAuth tokens are stored for this session. /// /// - `"persistent"` — tokens are stored in the OS keychain (shared across sessions). @@ -1198,7 +1972,8 @@ pub struct SessionConfig { /// applied automatically at session creation/resume time. `None` means no /// explicit value is set and the runtime default takes effect. pub mcp_oauth_token_storage: Option, - /// When true, the CLI runs config discovery (MCP config files, skills, plugins). + /// Enables runtime discovery of supported configuration. Explicitly supplied + /// configuration takes precedence over discovered values. pub enable_config_discovery: Option, /// When true, skips embedding retrieval for this session. pub skip_embedding_retrieval: Option, @@ -1244,6 +2019,11 @@ pub struct SessionConfig { /// /// Defaults to `None` (treated as `false`). pub enable_mcp_apps: Option, + /// Configuration for the built-in GitHub MCP server. + /// + /// `disable_form_deferral` only applies to that server and only has an + /// effect when MCP Apps and form-backed GitHub tools are enabled. + pub github_mcp_tool_config: Option, /// Skill directory paths passed through to the GitHub Copilot CLI. pub skill_directories: Option>, /// Additional directories to search for custom instruction files. @@ -1253,9 +2033,17 @@ pub struct SessionConfig { pub plugin_directories: Option>, /// Configuration for large tool output handling, forwarded to the CLI. pub large_output: Option, + /// Overrides the runtime's built-in tool-search behavior, which defers + /// rarely used tools behind a searchable index. When unset, the runtime + /// default applies. + pub tool_search: Option, /// Skill names to disable. Skills in this set will not be available /// even if found in skill directories. pub disabled_skills: Option>, + /// Exact MCP server names to disable for this session. Disabled servers are + /// not started or authenticated on create or cold resume; a resident resume + /// cannot stop servers that are already running. + pub disabled_mcp_servers: Option>, /// Enable session hooks. When `true`, the CLI sends `hooks.invoke` /// RPC requests at key lifecycle points (pre/post tool use, prompt /// submission, session start/end, errors). @@ -1276,6 +2064,25 @@ pub struct SessionConfig { /// requests through this provider instead of the default Copilot /// routing. pub provider: Option, + /// Provider-scoped CAPI session options. + /// + /// Use this to opt out of the default WebSocket transport for CAPI + /// Responses API calls, equivalent to setting + /// `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`. + pub capi: Option, + /// **Experimental.** This field is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Named BYOK provider connections. Additive to the default Copilot + /// routing — unlike [`provider`](Self::provider), these do not switch + /// the whole session to BYOK. Referenced by [`models`](Self::models). + pub providers: Option>, + /// **Experimental.** This field is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// BYOK model definitions, each referencing a [`providers`](Self::providers) + /// entry by name. Selectable under the id `provider/id`. + pub models: Option>, /// Enables or disables internal session telemetry for this session. /// /// When `Some(false)`, disables session telemetry. When `None` or @@ -1284,15 +2091,28 @@ pub struct SessionConfig { /// telemetry is always disabled regardless of this setting. This is /// independent of [`ClientOptions::telemetry`](crate::ClientOptions::telemetry). pub enable_session_telemetry: Option, + /// **Experimental.** Enables native model citations for supported providers. + pub enable_citations: Option, + /// Opts in to capturing file changes from the first turn for session rewind + /// and cumulative session diff. + pub enable_file_change_tracking: Option, + /// **Experimental.** Limits applied to this session's current accounting window. + pub session_limits: Option, /// Per-property overrides for model capabilities, deep-merged over /// runtime defaults. pub model_capabilities: Option, + /// Per-session configuration for the runtime memory feature. + pub memory: Option, /// Override the default configuration directory location. When set, /// the session uses this directory for storing config and state. pub config_directory: Option, /// Working directory for the session. Tool operations resolve /// relative paths against this directory. pub working_directory: Option, + /// Additional directories the agent may access beyond the working directory. + /// Relative paths resolve against the session working directory. Re-supply + /// them when resuming a session. + pub additional_directories: Option>, /// Per-session GitHub token. Distinct from /// [`ClientOptions::github_token`](crate::ClientOptions::github_token), /// which authenticates the CLI process itself; this token determines @@ -1316,6 +2136,30 @@ pub struct SessionConfig { /// each command appears as `/name` for the user to invoke and the /// associated [`CommandHandler`] is called when executed. pub commands: Option>, + /// ExP assignment ("flight") data injected by a trusted integrator, in + /// the same JSON shape the Copilot CLI fetches from the experimentation + /// service (`CopilotExpAssignmentResponse`). When supplied, the runtime + /// feeds it into the same feature-flag path as CLI-fetched assignments. + /// When absent, the session does not block on ExP. Set via + /// [`with_exp_assignments`](Self::with_exp_assignments). + #[doc(hidden)] + pub exp_assignments: Option, + /// Opt-in: when `Some(true)`, the runtime self-fetches enterprise managed + /// settings (bypass-permissions policy) at session bootstrap using the + /// session's [`github_token`](Self::github_token). Requires `github_token` + /// to be set; if omitted, the runtime is expected to reject session creation + /// (fail-closed). When `None`, behaves exactly as before. Set via + /// [`with_enable_managed_settings`](Self::with_enable_managed_settings). + pub enable_managed_settings: Option, + /// Optional managed-settings layer injected at session bootstrap. Currently + /// carries a [`permissions`](ManagedSettingsPermissions) object that composes + /// restrictively with any server- or device-level managed settings. This + /// layer is startup-only and is not persisted: it must be re-supplied on + /// resume to remain in effect. Can be combined with + /// [`enable_managed_settings`](Self::enable_managed_settings). Serialized on + /// the wire as `managedSettings`. Set via + /// [`with_managed_settings`](Self::with_managed_settings). + pub managed_settings: Option, /// Custom session filesystem provider for this session. Required when /// the [`Client`](crate::Client) was started with /// [`ClientOptions::session_fs`](crate::ClientOptions::session_fs) set. @@ -1328,6 +2172,9 @@ pub struct SessionConfig { /// Optional elicitation-request handler. When `None`, /// `requestElicitation: false` goes on the wire. pub elicitation_handler: Option>, + /// Optional MCP OAuth request handler. When set, the SDK can satisfy MCP + /// server OAuth requests with host-acquired token data or cancellation. + pub mcp_auth_handler: Option>, /// Optional user-input handler. When `None`, /// `requestUserInput: false` goes on the wire and the `ask_user` /// tool is disabled. @@ -1355,10 +2202,15 @@ pub struct SessionConfig { /// Applied via `session.options.update` after create/resume. Defaults to /// `true` in [`crate::ClientMode::Empty`] when unset. pub skip_custom_instructions: Option, - /// Whether to constrain custom agents to local-only execution. Applied - /// via `session.options.update` after create/resume. Defaults to `true` - /// in [`crate::ClientMode::Empty`] when unset. + /// Whether to constrain custom agents to local-only execution. Sent with + /// the initial create request and maintained via `session.options.update`. + /// Defaults to `true` in [`crate::ClientMode::Empty`] when unset. pub custom_agents_local_only: Option, + /// Controls whether the session enables experimental features. + /// + /// Defaults to `false` in [`crate::ClientMode::Empty`] when unset; + /// in `copilot-cli` mode, leaving this unset lets the runtime decide. + pub enable_experimental_mode: Option, /// Whether to include the `Co-authored-by` trailer in commit messages. /// Applied via `session.options.update` after create/resume. Defaults to /// `false` in [`crate::ClientMode::Empty`] when unset. @@ -1390,8 +2242,10 @@ impl std::fmt::Debug for SessionConfig { .field("request_extensions", &self.request_extensions) .field("extension_sdk_path", &self.extension_sdk_path) .field("extension_info", &self.extension_info) + .field("canvas_provider", &self.canvas_provider) .field("available_tools", &self.available_tools) .field("excluded_tools", &self.excluded_tools) + .field("excluded_builtin_agents", &self.excluded_builtin_agents) .field("mcp_servers", &self.mcp_servers) .field("mcp_oauth_token_storage", &self.mcp_oauth_token_storage) .field("embedding_cache_storage", &self.embedding_cache_storage) @@ -1420,17 +2274,28 @@ impl std::fmt::Debug for SessionConfig { .field("instruction_directories", &self.instruction_directories) .field("plugin_directories", &self.plugin_directories) .field("large_output", &self.large_output) + .field("tool_search", &self.tool_search) .field("disabled_skills", &self.disabled_skills) + .field("disabled_mcp_servers", &self.disabled_mcp_servers) .field("hooks", &self.hooks) .field("custom_agents", &self.custom_agents) .field("default_agent", &self.default_agent) .field("agent", &self.agent) .field("infinite_sessions", &self.infinite_sessions) .field("provider", &self.provider) + .field("capi", &self.capi) .field("enable_session_telemetry", &self.enable_session_telemetry) + .field("enable_citations", &self.enable_citations) + .field( + "enable_file_change_tracking", + &self.enable_file_change_tracking, + ) + .field("session_limits", &self.session_limits) .field("model_capabilities", &self.model_capabilities) + .field("memory", &self.memory) .field("config_directory", &self.config_directory) .field("working_directory", &self.working_directory) + .field("additional_directories", &self.additional_directories) .field( "github_token", &self.github_token.as_ref().map(|_| ""), @@ -1442,6 +2307,10 @@ impl std::fmt::Debug for SessionConfig { &self.include_sub_agent_streaming_events, ) .field("commands", &self.commands) + .field("exp_assignments", &self.exp_assignments) + .field("enable_managed_settings", &self.enable_managed_settings) + .field("enable_experimental_mode", &self.enable_experimental_mode) + .field("managed_settings", &self.managed_settings) .field( "session_fs_provider", &self.session_fs_provider.as_ref().map(|_| ""), @@ -1454,6 +2323,10 @@ impl std::fmt::Debug for SessionConfig { "elicitation_handler", &self.elicitation_handler.as_ref().map(|_| ""), ) + .field( + "mcp_auth_handler", + &self.mcp_auth_handler.as_ref().map(|_| ""), + ) .field( "user_input_handler", &self.user_input_handler.as_ref().map(|_| ""), @@ -1501,8 +2374,10 @@ impl Default for SessionConfig { request_extensions: None, extension_sdk_path: None, extension_info: None, + canvas_provider: None, available_tools: None, excluded_tools: None, + excluded_builtin_agents: None, mcp_servers: None, mcp_oauth_token_storage: None, enable_config_discovery: None, @@ -1515,29 +2390,44 @@ impl Default for SessionConfig { enable_skills: None, embedding_cache_storage: None, enable_mcp_apps: None, + github_mcp_tool_config: None, skill_directories: None, instruction_directories: None, plugin_directories: None, large_output: None, + tool_search: None, disabled_skills: None, + disabled_mcp_servers: None, hooks: None, custom_agents: None, default_agent: None, agent: None, infinite_sessions: None, provider: None, + capi: None, + providers: None, + models: None, enable_session_telemetry: None, + enable_citations: None, + enable_file_change_tracking: None, + session_limits: None, model_capabilities: None, + memory: None, config_directory: None, working_directory: None, + additional_directories: None, github_token: None, remote_session: None, cloud: None, include_sub_agent_streaming_events: None, commands: None, + exp_assignments: None, + enable_managed_settings: None, + managed_settings: None, session_fs_provider: None, permission_handler: None, elicitation_handler: None, + mcp_auth_handler: None, user_input_handler: None, exit_plan_mode_handler: None, auto_mode_switch_handler: None, @@ -1546,6 +2436,7 @@ impl Default for SessionConfig { system_message_transform: None, skip_custom_instructions: None, custom_agents_local_only: None, + enable_experimental_mode: None, coauthor_enabled: None, manage_schedule_enabled: None, } @@ -1561,6 +2452,7 @@ pub(crate) struct SessionConfigRuntime { pub permission_handler: Option>, pub permission_policy: Option, pub elicitation_handler: Option>, + pub mcp_auth_handler: Option>, pub user_input_handler: Option>, pub exit_plan_mode_handler: Option>, pub auto_mode_switch_handler: Option>, @@ -1569,6 +2461,7 @@ pub(crate) struct SessionConfigRuntime { pub tool_handlers: HashMap>, pub canvas_handler: Option>, pub session_fs_provider: Option>, + pub bearer_token_providers: HashMap>, pub commands: Option>, } @@ -1579,7 +2472,7 @@ impl SessionConfig { /// /// Wire-format flags are derived from handler presence and the policy /// field; runtime fields are moved out into the returned runtime so - /// the deep `Vec` / `HashMap` clones the previous + /// the deep `Vec` / `IndexMap` clones the previous /// `&self`-based shape required are eliminated, and the order of /// reading-vs-moving is enforced at compile time. /// @@ -1620,6 +2513,8 @@ impl SessionConfig { }); let wire_canvases = self.canvases.clone(); let canvas_handler = self.canvas_handler.clone(); + let bearer_token_providers = + prepare_bearer_token_providers(&mut self.provider, &mut self.providers); let wire = crate::wire::SessionCreateWire { session_id, @@ -1636,8 +2531,10 @@ impl SessionConfig { request_extensions: self.request_extensions, extension_sdk_path: self.extension_sdk_path, extension_info: self.extension_info, + canvas_provider: self.canvas_provider, available_tools: self.available_tools, excluded_tools: self.excluded_tools, + excluded_builtin_agents: self.excluded_builtin_agents, tool_filter_precedence: "excluded", mcp_servers: self.mcp_servers, mcp_oauth_token_storage: self.mcp_oauth_token_storage, @@ -1657,32 +2554,50 @@ impl SessionConfig { request_auto_mode_switch, request_elicitation, request_mcp_apps: self.enable_mcp_apps.unwrap_or(false), + github_mcp_tool_config: self.github_mcp_tool_config, hooks: hooks_flag, skill_directories: self.skill_directories, instruction_directories: self.instruction_directories, plugin_directories: self.plugin_directories, large_output: self.large_output, + tool_search: self.tool_search, disabled_skills: self.disabled_skills, + disabled_mcp_servers: self.disabled_mcp_servers, custom_agents: self.custom_agents, + custom_agents_local_only: self.custom_agents_local_only, default_agent: self.default_agent, agent: self.agent, infinite_sessions: self.infinite_sessions, provider: self.provider, + capi: self.capi, + providers: self.providers, + models: self.models, enable_session_telemetry: self.enable_session_telemetry, + enable_citations: self.enable_citations, + enable_file_change_tracking: self.enable_file_change_tracking, + session_limits: self.session_limits, model_capabilities: self.model_capabilities, + memory: self.memory, config_dir: self.config_directory, working_directory: self.working_directory, + additional_directories: self.additional_directories, github_token: self.github_token, remote_session: self.remote_session, cloud: self.cloud, include_sub_agent_streaming_events: self.include_sub_agent_streaming_events, + enable_github_telemetry_forwarding: None, commands: wire_commands, + exp_assignments: self.exp_assignments, + enable_managed_settings: self.enable_managed_settings, + is_experimental_mode: self.enable_experimental_mode, + managed_settings: self.managed_settings, }; let runtime = SessionConfigRuntime { permission_handler: self.permission_handler, permission_policy: self.permission_policy, elicitation_handler: self.elicitation_handler, + mcp_auth_handler: self.mcp_auth_handler, user_input_handler: self.user_input_handler, exit_plan_mode_handler: self.exit_plan_mode_handler, auto_mode_switch_handler: self.auto_mode_switch_handler, @@ -1691,6 +2606,7 @@ impl SessionConfig { tool_handlers, canvas_handler, session_fs_provider: self.session_fs_provider, + bearer_token_providers, commands: self.commands, }; @@ -1712,6 +2628,12 @@ impl SessionConfig { self } + /// Install an [`McpAuthHandler`] for host-provided MCP OAuth tokens. + pub fn with_mcp_auth_handler(mut self, handler: Arc) -> Self { + self.mcp_auth_handler = Some(handler); + self + } + /// Install a [`UserInputHandler`]. Required for the `ask_user` tool /// to be enabled. pub fn with_user_input_handler(mut self, handler: Arc) -> Self { @@ -1893,6 +2815,13 @@ impl SessionConfig { self } + /// Set the canvas provider identity for this connection so host-supplied + /// canvases survive reconnect and CLI restart. + pub fn with_canvas_provider(mut self, canvas_provider: CanvasProviderIdentity) -> Self { + self.canvas_provider = Some(canvas_provider); + self + } + /// Set the allowlist of built-in tool names the agent may use. pub fn with_available_tools(mut self, tools: I) -> Self where @@ -1913,8 +2842,18 @@ impl SessionConfig { self } + /// Set the built-in agent names to exclude from the session. + pub fn with_excluded_builtin_agents(mut self, agents: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.excluded_builtin_agents = Some(agents.into_iter().map(Into::into).collect()); + self + } + /// Set MCP server configurations passed through to the CLI. - pub fn with_mcp_servers(mut self, servers: HashMap) -> Self { + pub fn with_mcp_servers(mut self, servers: IndexMap) -> Self { self.mcp_servers = Some(servers); self } @@ -1940,7 +2879,8 @@ impl SessionConfig { self } - /// Enable or disable CLI config discovery (MCP config files, skills, plugins). + /// Enables runtime discovery of supported configuration. Explicitly supplied + /// configuration takes precedence over discovered values. pub fn with_enable_config_discovery(mut self, enable: bool) -> Self { self.enable_config_discovery = Some(enable); self @@ -2001,6 +2941,12 @@ impl SessionConfig { self } + /// Set the built-in GitHub MCP server configuration. + pub fn with_github_mcp_tool_config(mut self, config: GitHubMcpToolConfig) -> Self { + self.github_mcp_tool_config = Some(config); + self + } + /// Set skill directory paths passed through to the CLI. pub fn with_skill_directories(mut self, paths: I) -> Self where @@ -2039,6 +2985,13 @@ impl SessionConfig { self } + /// Set the [`ToolSearchConfig`] overriding the runtime's built-in + /// tool-search behavior on session create. + pub fn with_tool_search(mut self, config: ToolSearchConfig) -> Self { + self.tool_search = Some(config); + self + } + /// Set the names of skills to disable (overrides skill discovery). pub fn with_disabled_skills(mut self, names: I) -> Self where @@ -2049,6 +3002,16 @@ impl SessionConfig { self } + /// Set exact MCP server names to disable for this session. + pub fn with_disabled_mcp_servers(mut self, names: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.disabled_mcp_servers = Some(names.into_iter().map(Into::into).collect()); + self + } + /// Set the custom agents (sub-agents) configured for this session. pub fn with_custom_agents>( mut self, @@ -2084,6 +3047,32 @@ impl SessionConfig { self } + /// Configure provider-scoped CAPI session options. + pub fn with_capi(mut self, capi: CapiSessionOptions) -> Self { + self.capi = Some(capi); + self + } + + /// **Experimental.** This method is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Set the named BYOK provider connections (additive multi-provider + /// registry). Attach models referencing these with [`Self::with_models`]. + pub fn with_providers(mut self, providers: Vec) -> Self { + self.providers = Some(providers); + self + } + + /// **Experimental.** This method is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Set the BYOK model definitions, each referencing a named provider + /// supplied via [`Self::with_providers`]. + pub fn with_models(mut self, models: Vec) -> Self { + self.models = Some(models); + self + } + /// Enable or disable internal session telemetry. /// /// See [`Self::enable_session_telemetry`] for default and BYOK behavior. @@ -2092,6 +3081,25 @@ impl SessionConfig { self } + /// **Experimental.** Enable native model citations for supported providers. + pub fn with_enable_citations(mut self, enable: bool) -> Self { + self.enable_citations = Some(enable); + self + } + + /// Opt in to capturing file changes from the first turn for session rewind + /// and cumulative session diff. + pub fn with_enable_file_change_tracking(mut self, enable: bool) -> Self { + self.enable_file_change_tracking = Some(enable); + self + } + + /// **Experimental.** Set limits for this session's current accounting window. + pub fn with_session_limits(mut self, limits: SessionLimitsConfig) -> Self { + self.session_limits = Some(limits); + self + } + /// Set per-property overrides for model capabilities. pub fn with_model_capabilities( mut self, @@ -2101,6 +3109,12 @@ impl SessionConfig { self } + /// Configure the runtime memory feature for this session. + pub fn with_memory(mut self, memory: MemoryConfiguration) -> Self { + self.memory = Some(memory); + self + } + /// Override the default configuration directory location. pub fn with_config_directory(mut self, dir: impl Into) -> Self { self.config_directory = Some(dir.into()); @@ -2114,6 +3128,16 @@ impl SessionConfig { self } + /// Set directories the agent may access beyond the working directory. + pub fn with_additional_directories(mut self, paths: I) -> Self + where + I: IntoIterator, + P: Into, + { + self.additional_directories = Some(paths.into_iter().map(Into::into).collect()); + self + } + /// Set the per-session GitHub token. Distinct from /// [`ClientOptions::github_token`](crate::ClientOptions::github_token); /// this token determines the GitHub identity used for content exclusion, @@ -2157,6 +3181,12 @@ impl SessionConfig { self } + /// Set [`enable_experimental_mode`](Self::enable_experimental_mode). + pub fn with_enable_experimental_mode(mut self, enable_experimental_mode: bool) -> Self { + self.enable_experimental_mode = Some(enable_experimental_mode); + self + } + /// Set [`Self::coauthor_enabled`]. pub fn with_coauthor_enabled(mut self, value: bool) -> Self { self.coauthor_enabled = Some(value); @@ -2168,9 +3198,39 @@ impl SessionConfig { self.manage_schedule_enabled = Some(value); self } -} -/// Configuration for resuming an existing session via the `session.resume` RPC. + /// Inject ExP assignment ("flight") data for this session, in the same + /// JSON shape the Copilot CLI fetches from the experimentation service + /// (`CopilotExpAssignmentResponse`). The runtime feeds it into the same + /// feature-flag path as CLI-fetched assignments and stamps it onto + /// telemetry and the CAPI request header. Intended for trusted + /// integrators that fetch ExP data out of process; malformed payloads + /// are dropped by the runtime (fail-open). + #[doc(hidden)] + pub fn with_exp_assignments(mut self, assignments: CopilotExpAssignmentResponse) -> Self { + self.exp_assignments = Some(assignments); + self + } + + /// Opt the runtime into self-fetching enterprise managed settings + /// (bypass-permissions policy) at session bootstrap using the session's + /// [`github_token`](Self::github_token). Requires `github_token` to be set; + /// if omitted, the runtime is expected to reject session creation + /// (fail-closed). + pub fn with_enable_managed_settings(mut self, enabled: bool) -> Self { + self.enable_managed_settings = Some(enabled); + self + } + + /// Inject a managed-settings layer (currently permission rules) at session + /// bootstrap. This layer is startup-only and is not persisted, so it must be + /// re-supplied on resume to remain in effect. Can be combined with + /// [`with_enable_managed_settings`](Self::with_enable_managed_settings). + pub fn with_managed_settings(mut self, managed_settings: ManagedSettings) -> Self { + self.managed_settings = Some(managed_settings); + self + } +} /// /// See [`SessionConfig`] for the construction patterns (chained `with_*` /// builder vs. direct field assignment for `Option` pass-through) and @@ -2182,6 +3242,9 @@ impl SessionConfig { pub struct ResumeSessionConfig { /// ID of the session to resume. pub session_id: SessionId, + /// Model to use for this session (e.g. `"gpt-4"`, `"claude-sonnet-4"`). + /// Can change the model when resuming. + pub model: Option, /// Application name sent as User-Agent context. pub client_name: Option, /// Desired reasoning effort to apply after resuming the session. @@ -2217,16 +3280,26 @@ pub struct ResumeSessionConfig { pub extension_sdk_path: Option, /// Stable extension identity for canvas/tool providers on this connection. pub extension_info: Option, + /// Stable identity for a host/SDK connection that supplies built-in + /// canvases, so they rehydrate against a stable extension id on resume. + pub canvas_provider: Option, /// Allowlist of tool names the agent may use. pub available_tools: Option>, /// Blocklist of built-in tool names. pub excluded_tools: Option>, + /// Names of built-in agents to exclude from the resumed session. + /// + /// Excluded built-in agents are hidden from discovery and cannot be + /// selected or invoked unless a custom agent with the same name is + /// configured. + pub excluded_builtin_agents: Option>, /// Re-supply MCP servers so they remain available after app restart. - pub mcp_servers: Option>, + pub mcp_servers: Option>, /// Controls how MCP OAuth tokens are stored for this session. /// See [`SessionConfig::mcp_oauth_token_storage`] for details. pub mcp_oauth_token_storage: Option, - /// Enable config discovery on resume. + /// Enables runtime discovery of supported configuration. Explicitly supplied + /// configuration takes precedence over discovered values. pub enable_config_discovery: Option, /// When true, skips embedding retrieval on resume. pub skip_embedding_retrieval: Option, @@ -2250,6 +3323,11 @@ pub struct ResumeSessionConfig { /// Enable MCP Apps (SEP-1865) UI passthrough on resume. See /// [`SessionConfig::enable_mcp_apps`]. Defaults to `None` (treated as `false`). pub enable_mcp_apps: Option, + /// Configuration for the built-in GitHub MCP server. + /// + /// `disable_form_deferral` only applies to that server and only has an + /// effect when MCP Apps and form-backed GitHub tools are enabled. + pub github_mcp_tool_config: Option, /// Skill directory paths passed through to the GitHub Copilot CLI on resume. pub skill_directories: Option>, /// Additional directories to search for custom instruction files on @@ -2259,8 +3337,14 @@ pub struct ResumeSessionConfig { pub plugin_directories: Option>, /// Configuration for large tool output handling, forwarded to the CLI on resume. pub large_output: Option, + /// Overrides the runtime's built-in tool-search behavior on resume. When + /// unset, the runtime default applies. + pub tool_search: Option, /// Skill names to disable on resume. pub disabled_skills: Option>, + /// Exact MCP server names to disable on resume. This prevents startup and + /// authentication during a cold resume, but cannot stop resident servers. + pub disabled_mcp_servers: Option>, /// Enable session hooks on resume. pub hooks: Option, /// Custom agents to re-supply on resume. @@ -2273,6 +3357,24 @@ pub struct ResumeSessionConfig { pub infinite_sessions: Option, /// Re-supply BYOK provider configuration on resume. pub provider: Option, + /// Re-supply provider-scoped CAPI session options on resume. + /// + /// Use this to opt out of the default WebSocket transport for CAPI + /// Responses API calls, equivalent to setting + /// `COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`. + pub capi: Option, + /// **Experimental.** This field is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Re-supply named BYOK provider connections on resume. Additive to + /// the default Copilot routing. Referenced by [`models`](Self::models). + pub providers: Option>, + /// **Experimental.** This field is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Re-supply BYOK model definitions on resume, each referencing a + /// [`providers`](Self::providers) entry by name. + pub models: Option>, /// Enables or disables internal session telemetry for this session. /// /// When `Some(false)`, disables session telemetry. When `None` or @@ -2281,12 +3383,25 @@ pub struct ResumeSessionConfig { /// telemetry is always disabled regardless of this setting. This is /// independent of [`ClientOptions::telemetry`](crate::ClientOptions::telemetry). pub enable_session_telemetry: Option, + /// **Experimental.** Enables native model citations for supported providers. + pub enable_citations: Option, + /// Opts in to capturing file changes for session rewind and cumulative + /// session diff when the resumed session has a valid baseline. Earlier + /// untracked changes cannot be reconstructed. + pub enable_file_change_tracking: Option, + /// **Experimental.** Limits applied to this session's current accounting window. + pub session_limits: Option, /// Per-property model capability overrides on resume. pub model_capabilities: Option, + /// Per-session configuration for the runtime memory feature on resume. + pub memory: Option, /// Override the default configuration directory location on resume. pub config_directory: Option, /// Per-session working directory on resume. pub working_directory: Option, + /// Additional directories the agent may access on resume. Relative paths + /// resolve against the session working directory. + pub additional_directories: Option>, /// Per-session GitHub token on resume. See /// [`SessionConfig::github_token`]. pub github_token: Option, @@ -2299,6 +3414,24 @@ pub struct ResumeSessionConfig { /// [`SessionConfig::commands`] — commands are not persisted server-side, /// so the resume payload re-supplies the registration. pub commands: Option>, + /// ExP assignment ("flight") data injected on resume. See + /// [`SessionConfig::exp_assignments`]. Re-supply on resume so the runtime + /// re-applies the assignments after a CLI process restart. Set via + /// [`with_exp_assignments`](Self::with_exp_assignments). + #[doc(hidden)] + pub exp_assignments: Option, + /// Opt-in flag injected on resume. See + /// [`SessionConfig::enable_managed_settings`]. Re-supply on resume so + /// the runtime re-applies the managed-settings self-fetch after a CLI + /// process restart. Set via + /// [`with_enable_managed_settings`](Self::with_enable_managed_settings). + pub enable_managed_settings: Option, + /// Optional managed-settings layer injected on resume. See + /// [`SessionConfig::managed_settings`]. This layer is not persisted, so it + /// must be re-supplied on resume to remain in effect; omitting it clears the + /// previously injected layer. Serialized on the wire as `managedSettings`. + /// Set via [`with_managed_settings`](Self::with_managed_settings). + pub managed_settings: Option, /// Custom session filesystem provider. Required on resume when the /// [`Client`](crate::Client) was started with /// [`ClientOptions::session_fs`](crate::ClientOptions::session_fs). @@ -2321,6 +3454,8 @@ pub struct ResumeSessionConfig { /// Optional elicitation handler. See /// [`SessionConfig::elicitation_handler`]. pub elicitation_handler: Option>, + /// Optional MCP OAuth handler. See [`SessionConfig::mcp_auth_handler`]. + pub mcp_auth_handler: Option>, /// Optional user-input handler. See /// [`SessionConfig::user_input_handler`]. pub user_input_handler: Option>, @@ -2340,6 +3475,11 @@ pub struct ResumeSessionConfig { pub skip_custom_instructions: Option, /// See [`SessionConfig::custom_agents_local_only`]. pub custom_agents_local_only: Option, + /// Controls whether the session enables experimental features. + /// + /// Defaults to `false` in [`crate::ClientMode::Empty`] when unset; + /// in `copilot-cli` mode, leaving this unset lets the runtime decide. + pub enable_experimental_mode: Option, /// See [`SessionConfig::coauthor_enabled`]. pub coauthor_enabled: Option, /// See [`SessionConfig::manage_schedule_enabled`]. @@ -2350,6 +3490,7 @@ impl std::fmt::Debug for ResumeSessionConfig { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("ResumeSessionConfig") .field("session_id", &self.session_id) + .field("model", &self.model) .field("client_name", &self.client_name) .field("reasoning_effort", &self.reasoning_effort) .field("reasoning_summary", &self.reasoning_summary) @@ -2367,8 +3508,10 @@ impl std::fmt::Debug for ResumeSessionConfig { .field("request_extensions", &self.request_extensions) .field("extension_sdk_path", &self.extension_sdk_path) .field("extension_info", &self.extension_info) + .field("canvas_provider", &self.canvas_provider) .field("available_tools", &self.available_tools) .field("excluded_tools", &self.excluded_tools) + .field("excluded_builtin_agents", &self.excluded_builtin_agents) .field("mcp_servers", &self.mcp_servers) .field("mcp_oauth_token_storage", &self.mcp_oauth_token_storage) .field("embedding_cache_storage", &self.embedding_cache_storage) @@ -2397,17 +3540,28 @@ impl std::fmt::Debug for ResumeSessionConfig { .field("instruction_directories", &self.instruction_directories) .field("plugin_directories", &self.plugin_directories) .field("large_output", &self.large_output) + .field("tool_search", &self.tool_search) .field("disabled_skills", &self.disabled_skills) + .field("disabled_mcp_servers", &self.disabled_mcp_servers) .field("hooks", &self.hooks) .field("custom_agents", &self.custom_agents) .field("default_agent", &self.default_agent) .field("agent", &self.agent) .field("infinite_sessions", &self.infinite_sessions) .field("provider", &self.provider) + .field("capi", &self.capi) .field("enable_session_telemetry", &self.enable_session_telemetry) + .field("enable_citations", &self.enable_citations) + .field( + "enable_file_change_tracking", + &self.enable_file_change_tracking, + ) + .field("session_limits", &self.session_limits) .field("model_capabilities", &self.model_capabilities) + .field("memory", &self.memory) .field("config_directory", &self.config_directory) .field("working_directory", &self.working_directory) + .field("additional_directories", &self.additional_directories) .field( "github_token", &self.github_token.as_ref().map(|_| ""), @@ -2418,6 +3572,10 @@ impl std::fmt::Debug for ResumeSessionConfig { &self.include_sub_agent_streaming_events, ) .field("commands", &self.commands) + .field("exp_assignments", &self.exp_assignments) + .field("enable_managed_settings", &self.enable_managed_settings) + .field("enable_experimental_mode", &self.enable_experimental_mode) + .field("managed_settings", &self.managed_settings) .field( "session_fs_provider", &self.session_fs_provider.as_ref().map(|_| ""), @@ -2499,9 +3657,12 @@ impl ResumeSessionConfig { }); let wire_canvases = self.canvases.clone(); let canvas_handler = self.canvas_handler.clone(); + let bearer_token_providers = + prepare_bearer_token_providers(&mut self.provider, &mut self.providers); let wire = crate::wire::SessionResumeWire { session_id: self.session_id, + model: self.model, client_name: self.client_name, reasoning_effort: self.reasoning_effort, reasoning_summary: self.reasoning_summary, @@ -2515,8 +3676,10 @@ impl ResumeSessionConfig { request_extensions: self.request_extensions, extension_sdk_path: self.extension_sdk_path, extension_info: self.extension_info, + canvas_provider: self.canvas_provider, available_tools: self.available_tools, excluded_tools: self.excluded_tools, + excluded_builtin_agents: self.excluded_builtin_agents, tool_filter_precedence: "excluded", mcp_servers: self.mcp_servers, mcp_oauth_token_storage: self.mcp_oauth_token_storage, @@ -2536,25 +3699,42 @@ impl ResumeSessionConfig { request_auto_mode_switch, request_elicitation, request_mcp_apps: self.enable_mcp_apps.unwrap_or(false), + github_mcp_tool_config: self.github_mcp_tool_config, hooks: hooks_flag, skill_directories: self.skill_directories, instruction_directories: self.instruction_directories, plugin_directories: self.plugin_directories, large_output: self.large_output, + tool_search: self.tool_search, disabled_skills: self.disabled_skills, + disabled_mcp_servers: self.disabled_mcp_servers, custom_agents: self.custom_agents, + custom_agents_local_only: self.custom_agents_local_only, default_agent: self.default_agent, agent: self.agent, infinite_sessions: self.infinite_sessions, provider: self.provider, + capi: self.capi, + providers: self.providers, + models: self.models, enable_session_telemetry: self.enable_session_telemetry, + enable_citations: self.enable_citations, + enable_file_change_tracking: self.enable_file_change_tracking, + session_limits: self.session_limits, model_capabilities: self.model_capabilities, + memory: self.memory, config_dir: self.config_directory, working_directory: self.working_directory, + additional_directories: self.additional_directories, github_token: self.github_token, remote_session: self.remote_session, include_sub_agent_streaming_events: self.include_sub_agent_streaming_events, + enable_github_telemetry_forwarding: None, commands: wire_commands, + exp_assignments: self.exp_assignments, + enable_managed_settings: self.enable_managed_settings, + is_experimental_mode: self.enable_experimental_mode, + managed_settings: self.managed_settings, suppress_resume_event: self.suppress_resume_event, continue_pending_work: self.continue_pending_work, }; @@ -2563,6 +3743,7 @@ impl ResumeSessionConfig { permission_handler: self.permission_handler, permission_policy: self.permission_policy, elicitation_handler: self.elicitation_handler, + mcp_auth_handler: self.mcp_auth_handler, user_input_handler: self.user_input_handler, exit_plan_mode_handler: self.exit_plan_mode_handler, auto_mode_switch_handler: self.auto_mode_switch_handler, @@ -2571,6 +3752,7 @@ impl ResumeSessionConfig { tool_handlers, canvas_handler, session_fs_provider: self.session_fs_provider, + bearer_token_providers, commands: self.commands, }; @@ -2584,6 +3766,7 @@ impl ResumeSessionConfig { pub fn new(session_id: SessionId) -> Self { Self { session_id, + model: None, client_name: None, reasoning_effort: None, reasoning_summary: None, @@ -2598,8 +3781,10 @@ impl ResumeSessionConfig { request_extensions: None, extension_sdk_path: None, extension_info: None, + canvas_provider: None, available_tools: None, excluded_tools: None, + excluded_builtin_agents: None, mcp_servers: None, mcp_oauth_token_storage: None, enable_config_discovery: None, @@ -2612,30 +3797,45 @@ impl ResumeSessionConfig { enable_skills: None, embedding_cache_storage: None, enable_mcp_apps: None, + github_mcp_tool_config: None, skill_directories: None, instruction_directories: None, plugin_directories: None, large_output: None, + tool_search: None, disabled_skills: None, + disabled_mcp_servers: None, hooks: None, custom_agents: None, default_agent: None, agent: None, infinite_sessions: None, provider: None, + capi: None, + providers: None, + models: None, enable_session_telemetry: None, + enable_citations: None, + enable_file_change_tracking: None, + session_limits: None, model_capabilities: None, + memory: None, config_directory: None, working_directory: None, + additional_directories: None, github_token: None, remote_session: None, include_sub_agent_streaming_events: None, commands: None, + exp_assignments: None, + enable_managed_settings: None, + managed_settings: None, session_fs_provider: None, suppress_resume_event: None, continue_pending_work: None, permission_handler: None, elicitation_handler: None, + mcp_auth_handler: None, user_input_handler: None, exit_plan_mode_handler: None, auto_mode_switch_handler: None, @@ -2644,6 +3844,7 @@ impl ResumeSessionConfig { system_message_transform: None, skip_custom_instructions: None, custom_agents_local_only: None, + enable_experimental_mode: None, coauthor_enabled: None, manage_schedule_enabled: None, } @@ -2661,6 +3862,12 @@ impl ResumeSessionConfig { self } + /// Install an [`McpAuthHandler`] for host-provided MCP OAuth tokens. + pub fn with_mcp_auth_handler(mut self, handler: Arc) -> Self { + self.mcp_auth_handler = Some(handler); + self + } + /// Install a [`UserInputHandler`] for the resumed session. pub fn with_user_input_handler(mut self, handler: Arc) -> Self { self.user_input_handler = Some(handler); @@ -2737,6 +3944,12 @@ impl ResumeSessionConfig { self } + /// Set the model identifier to switch to on resume (e.g. `"claude-sonnet-4"`). + pub fn with_model(mut self, model: impl Into) -> Self { + self.model = Some(model.into()); + self + } + /// Set the application name sent as `User-Agent` context. pub fn with_client_name(mut self, name: impl Into) -> Self { self.client_name = Some(name.into()); @@ -2828,6 +4041,13 @@ impl ResumeSessionConfig { self } + /// Set the canvas provider identity for this connection on resume so + /// host-supplied canvases rehydrate against a stable extension id. + pub fn with_canvas_provider(mut self, canvas_provider: CanvasProviderIdentity) -> Self { + self.canvas_provider = Some(canvas_provider); + self + } + /// Set the allowlist of tool names the agent may use. pub fn with_available_tools(mut self, tools: I) -> Self where @@ -2848,8 +4068,18 @@ impl ResumeSessionConfig { self } + /// Set the built-in agent names to exclude from the resumed session. + pub fn with_excluded_builtin_agents(mut self, agents: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.excluded_builtin_agents = Some(agents.into_iter().map(Into::into).collect()); + self + } + /// Re-supply MCP server configurations on resume. - pub fn with_mcp_servers(mut self, servers: HashMap) -> Self { + pub fn with_mcp_servers(mut self, servers: IndexMap) -> Self { self.mcp_servers = Some(servers); self } @@ -2870,7 +4100,8 @@ impl ResumeSessionConfig { self } - /// Enable or disable CLI config discovery on resume. + /// Enables runtime discovery of supported configuration. Explicitly supplied + /// configuration takes precedence over discovered values. pub fn with_enable_config_discovery(mut self, enable: bool) -> Self { self.enable_config_discovery = Some(enable); self @@ -2931,6 +4162,12 @@ impl ResumeSessionConfig { self } + /// Set the built-in GitHub MCP server configuration. + pub fn with_github_mcp_tool_config(mut self, config: GitHubMcpToolConfig) -> Self { + self.github_mcp_tool_config = Some(config); + self + } + /// Set skill directory paths passed through to the CLI on resume. pub fn with_skill_directories(mut self, paths: I) -> Self where @@ -2969,6 +4206,13 @@ impl ResumeSessionConfig { self } + /// Set the [`ToolSearchConfig`] overriding the runtime's built-in + /// tool-search behavior on resume. + pub fn with_tool_search(mut self, config: ToolSearchConfig) -> Self { + self.tool_search = Some(config); + self + } + /// Set the names of skills to disable on resume. pub fn with_disabled_skills(mut self, names: I) -> Self where @@ -2979,6 +4223,16 @@ impl ResumeSessionConfig { self } + /// Set exact MCP server names to disable for this session. + pub fn with_disabled_mcp_servers(mut self, names: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.disabled_mcp_servers = Some(names.into_iter().map(Into::into).collect()); + self + } + /// Re-supply custom agents on resume. pub fn with_custom_agents>( mut self, @@ -3012,16 +4266,61 @@ impl ResumeSessionConfig { self } - /// Enable or disable internal session telemetry on resume. + /// Re-supply provider-scoped CAPI session options on resume. + pub fn with_capi(mut self, capi: CapiSessionOptions) -> Self { + self.capi = Some(capi); + self + } + + /// **Experimental.** This method is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. /// - /// See [`Self::enable_session_telemetry`] for default and BYOK behavior. - pub fn with_enable_session_telemetry(mut self, enable: bool) -> Self { - self.enable_session_telemetry = Some(enable); + /// Re-supply the named BYOK provider connections on resume. Attach + /// models referencing these with [`Self::with_models`]. + pub fn with_providers(mut self, providers: Vec) -> Self { + self.providers = Some(providers); self } - /// Set per-property model capability overrides on resume. - pub fn with_model_capabilities( + /// **Experimental.** This method is part of an experimental multi-provider + /// BYOK surface and may change or be removed in a future release. + /// + /// Re-supply the BYOK model definitions on resume, each referencing a + /// named provider supplied via [`Self::with_providers`]. + pub fn with_models(mut self, models: Vec) -> Self { + self.models = Some(models); + self + } + + /// Enable or disable internal session telemetry on resume. + /// + /// See [`Self::enable_session_telemetry`] for default and BYOK behavior. + pub fn with_enable_session_telemetry(mut self, enable: bool) -> Self { + self.enable_session_telemetry = Some(enable); + self + } + + /// **Experimental.** Enable native model citations for supported providers on resume. + pub fn with_enable_citations(mut self, enable: bool) -> Self { + self.enable_citations = Some(enable); + self + } + + /// Opt in to capturing file changes for session rewind and cumulative + /// session diff when the resumed session has a valid baseline. + pub fn with_enable_file_change_tracking(mut self, enable: bool) -> Self { + self.enable_file_change_tracking = Some(enable); + self + } + + /// **Experimental.** Set limits for this session's current accounting window. + pub fn with_session_limits(mut self, limits: SessionLimitsConfig) -> Self { + self.session_limits = Some(limits); + self + } + + /// Set per-property model capability overrides on resume. + pub fn with_model_capabilities( mut self, capabilities: crate::generated::api_types::ModelCapabilitiesOverride, ) -> Self { @@ -3029,6 +4328,12 @@ impl ResumeSessionConfig { self } + /// Configure the runtime memory feature for the resumed session. + pub fn with_memory(mut self, memory: MemoryConfiguration) -> Self { + self.memory = Some(memory); + self + } + /// Override the default configuration directory location on resume. pub fn with_config_directory(mut self, dir: impl Into) -> Self { self.config_directory = Some(dir.into()); @@ -3041,6 +4346,16 @@ impl ResumeSessionConfig { self } + /// Set directories the agent may access beyond the working directory on resume. + pub fn with_additional_directories(mut self, paths: I) -> Self + where + I: IntoIterator, + P: Into, + { + self.additional_directories = Some(paths.into_iter().map(Into::into).collect()); + self + } + /// Set the per-session GitHub token on resume. See /// [`SessionConfig::github_token`] for distinction from the /// client-level token. @@ -3093,6 +4408,12 @@ impl ResumeSessionConfig { self } + /// Set [`enable_experimental_mode`](Self::enable_experimental_mode). + pub fn with_enable_experimental_mode(mut self, enable_experimental_mode: bool) -> Self { + self.enable_experimental_mode = Some(enable_experimental_mode); + self + } + /// Set [`Self::coauthor_enabled`]. pub fn with_coauthor_enabled(mut self, value: bool) -> Self { self.coauthor_enabled = Some(value); @@ -3104,6 +4425,30 @@ impl ResumeSessionConfig { self.manage_schedule_enabled = Some(value); self } + + /// Inject ExP assignment ("flight") data on resume. See + /// [`SessionConfig::with_exp_assignments`]. Re-supply the assignments on + /// resume so the runtime re-applies them after a CLI process restart. + #[doc(hidden)] + pub fn with_exp_assignments(mut self, assignments: CopilotExpAssignmentResponse) -> Self { + self.exp_assignments = Some(assignments); + self + } + + /// Opt the runtime into self-fetching enterprise managed settings on resume. + /// See [`SessionConfig::with_enable_managed_settings`]. + pub fn with_enable_managed_settings(mut self, enabled: bool) -> Self { + self.enable_managed_settings = Some(enabled); + self + } + + /// Inject a managed-settings layer (currently permission rules) on resume. + /// See [`SessionConfig::with_managed_settings`]. Must be re-supplied on + /// resume; omitting it clears the previously injected layer. + pub fn with_managed_settings(mut self, managed_settings: ManagedSettings) -> Self { + self.managed_settings = Some(managed_settings); + self + } } /// Controls how the system message is constructed. @@ -3158,11 +4503,12 @@ impl SystemMessageConfig { /// /// Used within [`SystemMessageConfig::sections`] when `mode` is `"customize"`. /// The `action` field determines the operation: `"replace"`, `"remove"`, -/// `"append"`, `"prepend"`, or `"transform"`. +/// `"append"`, `"prepend"`, `"preserve"`, or `"transform"`. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct SectionOverride { - /// Override action: `"replace"`, `"remove"`, `"append"`, `"prepend"`, or `"transform"`. + /// Override action: `"replace"`, `"remove"`, `"append"`, `"prepend"`, + /// `"preserve"`, or `"transform"`. #[serde(skip_serializing_if = "Option::is_none")] pub action: Option, /// Content for the override operation. @@ -3261,12 +4607,15 @@ impl LogOptions { #[derive(Debug, Clone, Default)] pub struct SetModelOptions { /// Reasoning effort for the new model (e.g. `"low"`, `"medium"`, - /// `"high"`, `"xhigh"`). + /// `"high"`, `"xhigh"`, `"max"`). pub reasoning_effort: Option, /// Reasoning summary mode for the new model. Use /// [`ReasoningSummary::None`] to suppress summary output regardless of /// whether reasoning is enabled. pub reasoning_summary: Option, + /// Explicit context window tier for the new model. Leave unset to use + /// normal model behavior with no explicit tier. + pub context_tier: Option, /// Override individual model capabilities resolved by the runtime. Only /// fields set on the override are applied; the rest fall back to the /// runtime-resolved values for the model. @@ -3286,6 +4635,12 @@ impl SetModelOptions { self } + /// Set [`context_tier`](Self::context_tier). + pub fn with_context_tier(mut self, tier: ContextTier) -> Self { + self.context_tier = Some(tier); + self + } + /// Set [`model_capabilities`](Self::model_capabilities). pub fn with_model_capabilities( mut self, @@ -3359,6 +4714,55 @@ pub enum GitHubReferenceType { Discussion, } +/// Pointer to a GitHub repository (owner/name plus optional numeric id). +/// +/// Used by the GitHub-anchored [`Attachment`] variants. Mirrors the field +/// shape of the generated `GitHubRepoRef`, but defined locally so it can +/// derive `Eq` for use inside the `Attachment` enum. +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubRepoPointer { + /// Numeric GitHub repository id. + #[serde(skip_serializing_if = "Option::is_none")] + pub id: Option, + /// Repository name (without owner). + pub name: String, + /// Repository owner login (user or organization). + pub owner: String, +} + +/// One side (head or base) of a GitHub single-file diff. +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubFileDiffSide { + /// Repository-relative path to the file. + pub path: String, + /// Git ref (branch, tag, or commit SHA) the file is read at. + pub r#ref: String, + /// Repository the file lives in. + pub repo: GitHubRepoPointer, +} + +/// One side (head or base) of a GitHub tree comparison. +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubTreeComparisonSide { + /// Repository the revision belongs to. + pub repo: GitHubRepoPointer, + /// Git revision (branch, tag, or commit SHA). + pub revision: String, +} + +/// Line range covered by a GitHub snippet attachment (1-based, inclusive end). +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GitHubSnippetLineRange { + /// Start line number (1-based). + pub start: i64, + /// End line number (1-based, inclusive). + pub end: i64, +} + /// An attachment included with a user message. #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] #[serde( @@ -3423,6 +4827,117 @@ pub enum Attachment { /// URL to the referenced item. url: String, }, + /// A pointer to a GitHub commit. + #[serde(rename = "github_commit")] + GitHubCommit { + /// First line of the commit message. + message: String, + /// Full commit SHA. + oid: String, + /// Repository the commit belongs to. + repo: GitHubRepoPointer, + /// URL to the commit on GitHub. + url: String, + }, + /// A pointer to a GitHub release. + #[serde(rename = "github_release")] + GitHubRelease { + /// Human-readable release name. + name: String, + /// Repository the release belongs to. + repo: GitHubRepoPointer, + /// Git tag the release is anchored to. + tag_name: String, + /// URL to the release on GitHub. + url: String, + }, + /// A pointer to a GitHub Actions job. + #[serde(rename = "github_actions_job")] + GitHubActionsJob { + /// Terminal conclusion of the job when finished (e.g. "success", + /// "failure", "cancelled"). Absent for in-progress jobs. + #[serde(skip_serializing_if = "Option::is_none")] + conclusion: Option, + /// Job id within the workflow run. + job_id: i64, + /// Display name of the job. + job_name: String, + /// Repository the workflow run belongs to. + repo: GitHubRepoPointer, + /// URL to the job on GitHub. + url: String, + /// Display name of the workflow the job ran in. + workflow_name: String, + }, + /// A pointer to a GitHub repository. + #[serde(rename = "github_repository")] + GitHubRepository { + /// Short description of the repository. + #[serde(skip_serializing_if = "Option::is_none")] + description: Option, + /// Git ref this attachment is anchored at (branch, tag, or commit). + /// When absent the default branch is implied. + #[serde(skip_serializing_if = "Option::is_none")] + r#ref: Option, + /// Repository pointer. + repo: GitHubRepoPointer, + /// URL to the repository on GitHub. + url: String, + }, + /// A pointer to a single-file diff. At least one of `head` and `base` is present. + #[serde(rename = "github_file_diff")] + GitHubFileDiff { + /// File location on the base side of the diff. Absent for additions. + #[serde(skip_serializing_if = "Option::is_none")] + base: Option, + /// File location on the head side of the diff. Absent for deletions. + #[serde(skip_serializing_if = "Option::is_none")] + head: Option, + /// URL to the diff on GitHub (e.g. a commit, compare, or PR-file URL). + url: String, + }, + /// A pointer to a comparison between two git revisions. + #[serde(rename = "github_tree_comparison")] + GitHubTreeComparison { + /// Base side of the comparison. + base: GitHubTreeComparisonSide, + /// Head side of the comparison. + head: GitHubTreeComparisonSide, + /// URL to the comparison on GitHub. + url: String, + }, + /// A generic GitHub URL reference. + #[serde(rename = "github_url")] + GitHubUrl { + /// URL to the GitHub resource. + url: String, + }, + /// A pointer to a file in a GitHub repository at a specific ref. + #[serde(rename = "github_file")] + GitHubFile { + /// Repository-relative path to the file. + path: String, + /// Git ref the file is read at (branch, tag, or commit SHA). + r#ref: String, + /// Repository the file lives in. + repo: GitHubRepoPointer, + /// URL to the file on GitHub. + url: String, + }, + /// A pointer to a line range inside a file in a GitHub repository. + #[serde(rename = "github_snippet")] + GitHubSnippet { + /// Line range the snippet covers. + line_range: GitHubSnippetLineRange, + /// Repository-relative path to the file. + path: String, + /// Git ref the file is read at (branch, tag, or commit SHA). + r#ref: String, + /// Repository the file lives in. + repo: GitHubRepoPointer, + /// URL to the snippet on GitHub (with line anchor). + url: String, + }, } impl Attachment { @@ -3433,7 +4948,16 @@ impl Attachment { | Self::Directory { display_name, .. } | Self::Selection { display_name, .. } | Self::Blob { display_name, .. } => display_name.as_deref(), - Self::GitHubReference { .. } => None, + Self::GitHubReference { .. } + | Self::GitHubCommit { .. } + | Self::GitHubRelease { .. } + | Self::GitHubActionsJob { .. } + | Self::GitHubRepository { .. } + | Self::GitHubFileDiff { .. } + | Self::GitHubTreeComparison { .. } + | Self::GitHubUrl { .. } + | Self::GitHubFile { .. } + | Self::GitHubSnippet { .. } => None, } } @@ -3476,7 +5000,16 @@ impl Attachment { | Self::Directory { display_name, .. } | Self::Selection { display_name, .. } | Self::Blob { display_name, .. } => *display_name = Some(derived_display_name), - Self::GitHubReference { .. } => {} + Self::GitHubReference { .. } + | Self::GitHubCommit { .. } + | Self::GitHubRelease { .. } + | Self::GitHubActionsJob { .. } + | Self::GitHubRepository { .. } + | Self::GitHubFileDiff { .. } + | Self::GitHubTreeComparison { .. } + | Self::GitHubUrl { .. } + | Self::GitHubFile { .. } + | Self::GitHubSnippet { .. } => {} } } @@ -3487,7 +5020,16 @@ impl Attachment { } Self::Selection { file_path, .. } => Some(attachment_name_from_path(file_path)), Self::Blob { .. } => Some("attachment".to_string()), - Self::GitHubReference { .. } => None, + Self::GitHubReference { .. } + | Self::GitHubCommit { .. } + | Self::GitHubRelease { .. } + | Self::GitHubActionsJob { .. } + | Self::GitHubRepository { .. } + | Self::GitHubFileDiff { .. } + | Self::GitHubTreeComparison { .. } + | Self::GitHubUrl { .. } + | Self::GitHubFile { .. } + | Self::GitHubSnippet { .. } => None, } } } @@ -3792,7 +5334,7 @@ pub struct SessionEvent { } impl SessionEvent { - /// Parse the string `event_type` into a typed [`SessionEventType`](crate::generated::SessionEventType) enum. + /// Parse the string `event_type` into a typed [`SessionEventType`](crate::session_events::SessionEventType) enum. /// /// Returns `SessionEventType::Unknown` for unrecognized event types, /// ensuring forward compatibility with newer CLI versions. @@ -3838,6 +5380,15 @@ pub struct ToolInvocation { pub tool_name: String, /// Tool arguments as JSON. pub arguments: Value, + /// Snapshot of the session's currently initialized tools. + /// + /// The SDK populates this only when the invocation targets the built-in + /// tool-search tool (`tool_search_tool`), so a tool-search override can + /// rank/filter the live catalog — including MCP tools configured in + /// settings — without issuing its own RPC. `None` for every other tool + /// invocation. This field is not part of the wire protocol. + #[serde(skip)] + pub available_tools: Option>, /// W3C Trace Context `traceparent` header propagated from the CLI's /// `execute_tool` span. Pass through to OpenTelemetry-aware code so /// child spans created inside the handler are parented to the CLI @@ -3901,8 +5452,14 @@ pub struct ToolBinaryResult { } /// Expanded tool result with metadata for the LLM and session log. +/// +/// This type is `#[non_exhaustive]`: it mirrors a growing wire shape, so +/// construct it via [`ToolResultExpanded::new`] plus the `with_*` chain +/// rather than a struct literal, allowing new fields to land without +/// breaking callers. #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] +#[non_exhaustive] pub struct ToolResultExpanded { /// Result text sent back to the LLM. pub text_result_for_llm: String, @@ -3920,6 +5477,60 @@ pub struct ToolResultExpanded { /// Tool-specific telemetry emitted with the result. #[serde(default, skip_serializing_if = "Option::is_none")] pub tool_telemetry: Option>, + /// Names of tools returned by a tool-search tool. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub tool_references: Option>, +} + +impl ToolResultExpanded { + /// Construct an expanded result with the required `text_result_for_llm` + /// and `result_type` (`"success"` or `"failure"`). All optional metadata + /// fields start unset; populate them with the `with_*` builders. + pub fn new(text_result_for_llm: impl Into, result_type: impl Into) -> Self { + Self { + text_result_for_llm: text_result_for_llm.into(), + result_type: result_type.into(), + binary_results_for_llm: None, + session_log: None, + error: None, + tool_telemetry: None, + tool_references: None, + } + } + + /// Set the binary payloads returned to the LLM. + pub fn with_binary_results(mut self, results: Vec) -> Self { + self.binary_results_for_llm = Some(results); + self + } + + /// Set the log message for the session timeline. + pub fn with_session_log(mut self, session_log: impl Into) -> Self { + self.session_log = Some(session_log.into()); + self + } + + /// Set the error message, marking the tool as failed. + pub fn with_error(mut self, error: impl Into) -> Self { + self.error = Some(error.into()); + self + } + + /// Set the tool-specific telemetry emitted with the result. + pub fn with_tool_telemetry(mut self, telemetry: HashMap) -> Self { + self.tool_telemetry = Some(telemetry); + self + } + + /// Set the names of tools returned by a tool-search tool. + pub fn with_tool_references(mut self, references: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.tool_references = Some(references.into_iter().map(Into::into).collect()); + self + } } /// Result of a tool invocation — either a plain text string or an expanded result. @@ -4156,12 +5767,15 @@ impl InputFormat { /// Re-exports of generated protocol types that are part of the SDK's /// public API surface. The canonical definitions live in -/// [`crate::generated::api_types`]; they live here so the crate-root +/// [`crate::rpc`]; they live here so the crate-root /// `pub use types::*` surfaces them alongside hand-written SDK types. pub use crate::generated::api_types::{ - Model, ModelBilling, ModelCapabilities, ModelCapabilitiesLimits, ModelCapabilitiesLimitsVision, + Model, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, + ModelCapabilities, ModelCapabilitiesLimits, ModelCapabilitiesLimitsVision, ModelCapabilitiesSupports, ModelList, ModelPolicy, PermissionDecision, - PermissionDecisionApproveOnce, PermissionDecisionReject, PermissionDecisionUserNotAvailable, + PermissionDecisionApproveOnce, PermissionDecisionContext, PermissionDecisionOutcome, + PermissionDecisionReject, PermissionDecisionSource, PermissionDecisionSurface, + PermissionDecisionUserNotAvailable, }; /// Permission categories the CLI may request approval for. @@ -4212,8 +5826,15 @@ pub struct PermissionRequestData { /// to a specific tool invocation. #[serde(default, skip_serializing_if = "Option::is_none")] pub tool_call_id: Option, - /// The full permission request params from the CLI. The shape varies by - /// permission type and CLI version, so we preserve it as `Value`. + /// Whether managed policy requires an explicit human decision. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub managed_approval_required: Option, + /// Whether managed settings are enabled for this session. + #[serde(default, skip_serializing_if = "is_false")] + pub managed_settings_enabled: bool, + /// The full permission event params from the CLI, including the request ID + /// and nested permission request. The shape varies by permission type and + /// CLI version, so we preserve it as `Value`. #[serde(flatten)] pub extra: Value, } @@ -4253,14 +5874,18 @@ impl Default for ExitPlanModeData { #[cfg(test)] mod tests { + use std::collections::HashMap; use std::path::PathBuf; use serde_json::json; use super::{ AgentMode, Attachment, AttachmentLineRange, AttachmentSelectionPosition, - AttachmentSelectionRange, ConnectionState, CustomAgentConfig, DeliveryMode, ExtensionInfo, - GitHubReferenceType, InfiniteSessionConfig, LargeToolOutputConfig, ProviderConfig, + AttachmentSelectionRange, AzureProviderOptions, CapiSessionOptions, ConnectionState, + CopilotExpAssignmentResponse, CustomAgentConfig, DeliveryMode, ExpConfigEntry, + ExpFlagValue, ExtensionInfo, GitHubMcpToolConfig, GitHubReferenceType, + InfiniteSessionConfig, LargeToolOutputConfig, McpServerConfig, McpStdioServerConfig, + MemoryConfiguration, NamedProviderConfig, ProviderConfig, ProviderModelConfig, ReasoningSummary, ResumeSessionConfig, SessionConfig, SessionEvent, SessionId, SystemMessageConfig, Tool, ToolBinaryResult, ToolResult, ToolResultExpanded, ToolResultResponse, ensure_attachment_display_names, @@ -4289,6 +5914,44 @@ mod tests { assert!(tool.skip_permission); } + #[test] + fn tool_defer_serialization() { + let tool = Tool::new("lookup").with_defer(super::DeferMode::Auto); + assert_eq!(tool.defer, Some(super::DeferMode::Auto)); + let value = serde_json::to_value(&tool).unwrap(); + assert_eq!(value.get("defer").unwrap(), &json!("auto")); + + let plain = Tool::new("plain"); + let value = serde_json::to_value(&plain).unwrap(); + assert!(value.get("defer").is_none()); + } + + #[test] + fn tool_metadata_serialization() { + use indexmap::IndexMap; + + let mut metadata = IndexMap::new(); + metadata.insert( + "github.com/copilot:safeForTelemetry".to_string(), + json!({ "name": true, "inputsNames": false }), + ); + let tool = Tool::new("lookup").with_metadata(metadata); + let value = serde_json::to_value(&tool).unwrap(); + assert_eq!( + value + .get("metadata") + .unwrap() + .get("github.com/copilot:safeForTelemetry") + .unwrap(), + &json!({ "name": true, "inputsNames": false }) + ); + + // Empty metadata is omitted on the wire. + let plain = Tool::new("plain"); + let value = serde_json::to_value(&plain).unwrap(); + assert!(value.get("metadata").is_none()); + } + #[test] fn custom_agent_config_builder_with_model() { let agent = CustomAgentConfig::new("my-agent", "You are helpful.") @@ -4314,6 +5977,28 @@ mod tests { assert!(wire.get("model").is_none()); } + #[test] + fn custom_agent_config_builder_with_reasoning_effort() { + let agent = + CustomAgentConfig::new("reasoning-agent", "prompt").with_reasoning_effort("high"); + assert_eq!(agent.reasoning_effort.as_deref(), Some("high")); + } + + #[test] + fn custom_agent_config_serializes_reasoning_effort() { + let agent = + CustomAgentConfig::new("reasoning-agent", "prompt").with_reasoning_effort("high"); + let wire = serde_json::to_value(&agent).unwrap(); + assert_eq!(wire["reasoningEffort"], "high"); + } + + #[test] + fn custom_agent_config_omits_reasoning_effort_when_none() { + let agent = CustomAgentConfig::new("default-agent", "prompt"); + let wire = serde_json::to_value(&agent).unwrap(); + assert!(wire.get("reasoningEffort").is_none()); + } + #[test] #[should_panic(expected = "tool parameter schema must be a JSON object")] fn tool_with_parameters_panics_on_non_object_value() { @@ -4335,6 +6020,7 @@ mod tests { session_log: None, error: None, tool_telemetry: None, + tool_references: None, }), }; @@ -4369,6 +6055,7 @@ mod tests { session_log: None, error: None, tool_telemetry: None, + tool_references: None, }), }; @@ -4378,6 +6065,70 @@ mod tests { assert!(wire["result"].get("binaryResultsForLlm").is_none()); } + #[test] + fn tool_result_expanded_serializes_tool_references() { + let response = ToolResultResponse { + result: ToolResult::Expanded( + ToolResultExpanded::new("found 2 tools", "success") + .with_tool_references(["get_weather", "check_status"]), + ), + }; + + let wire = serde_json::to_value(&response).unwrap(); + + assert_eq!( + wire, + json!({ + "result": { + "textResultForLlm": "found 2 tools", + "resultType": "success", + "toolReferences": ["get_weather", "check_status"] + } + }) + ); + } + + #[test] + fn tool_result_expanded_omits_tool_references_when_none() { + let response = ToolResultResponse { + result: ToolResult::Expanded(ToolResultExpanded::new("ok", "success")), + }; + + let wire = serde_json::to_value(&response).unwrap(); + + assert_eq!(wire["result"]["textResultForLlm"], "ok"); + assert!(wire["result"].get("toolReferences").is_none()); + } + + #[test] + fn tool_result_expanded_with_tool_references_accepts_owned_strings() { + // The builder is generic over `Into`, so an owned `Vec` + // must compile and populate the field just like a `&str` array. + let names: Vec = vec!["alpha".to_string(), "beta".to_string()]; + let expanded = ToolResultExpanded::new("ok", "success").with_tool_references(names); + + assert_eq!( + expanded.tool_references.as_deref(), + Some(["alpha".to_string(), "beta".to_string()].as_slice()) + ); + } + + #[test] + fn tool_result_expanded_deserializes_tool_references() { + let wire = json!({ + "textResultForLlm": "found tools", + "resultType": "success", + "toolReferences": ["alpha", "beta"] + }); + + let expanded: ToolResultExpanded = serde_json::from_value(wire).unwrap(); + + assert_eq!( + expanded.tool_references.as_deref(), + Some(["alpha".to_string(), "beta".to_string()].as_slice()) + ); + } + #[test] fn session_config_default_wire_flags_off_without_handlers() { let cfg = SessionConfig::default(); @@ -4413,6 +6164,35 @@ mod tests { assert!(!wire.request_mcp_apps); } + #[test] + fn custom_agents_local_only_serializes_on_create_and_resume() { + let (create_wire, _) = SessionConfig::default() + .with_custom_agents_local_only(false) + .into_wire(Some(SessionId::from("create-locality"))) + .expect("create config has no duplicate handlers"); + let create_json = serde_json::to_value(&create_wire).unwrap(); + assert_eq!(create_json["customAgentsLocalOnly"], false); + + let (resume_wire, _) = ResumeSessionConfig::new(SessionId::from("resume-locality")) + .with_custom_agents_local_only(false) + .into_wire() + .expect("resume config has no duplicate handlers"); + let resume_json = serde_json::to_value(&resume_wire).unwrap(); + assert_eq!(resume_json["customAgentsLocalOnly"], false); + + let (unset_create_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("create-unset"))) + .expect("create config has no duplicate handlers"); + let unset_create_json = serde_json::to_value(&unset_create_wire).unwrap(); + assert!(unset_create_json.get("customAgentsLocalOnly").is_none()); + + let (unset_resume_wire, _) = ResumeSessionConfig::new(SessionId::from("resume-unset")) + .into_wire() + .expect("resume config has no duplicate handlers"); + let unset_resume_json = serde_json::to_value(&unset_resume_wire).unwrap(); + assert!(unset_resume_json.get("customAgentsLocalOnly").is_none()); + } + #[test] fn session_config_enable_mcp_apps_sets_wire_flag_and_serializes() { let cfg = SessionConfig::default().with_enable_mcp_apps(true); @@ -4442,6 +6222,210 @@ mod tests { assert_eq!(json["requestMcpApps"], serde_json::Value::Bool(true)); } + #[test] + fn github_mcp_tool_config_serializes_for_create_and_resume() { + let github_config = GitHubMcpToolConfig::new() + .with_enable_all_tools(true) + .with_additional_toolsets(["repos"]) + .with_additional_tools(["get_issue"]) + .with_enable_insiders_mode(true) + .with_disable_form_deferral(true); + + let (create_wire, _) = SessionConfig::default() + .with_github_mcp_tool_config(github_config.clone()) + .into_wire(Some(SessionId::from("github-mcp"))) + .expect("create config has no duplicate handlers"); + assert_eq!( + serde_json::to_value(&create_wire).unwrap()["githubMcpToolConfig"], + serde_json::json!({ + "enableAllTools": true, + "additionalToolsets": ["repos"], + "additionalTools": ["get_issue"], + "enableInsidersMode": true, + "disableFormDeferral": true, + }) + ); + + let (resume_wire, _) = ResumeSessionConfig::new(SessionId::from("github-mcp")) + .with_github_mcp_tool_config(github_config) + .into_wire() + .expect("resume config has no duplicate handlers"); + assert!(resume_wire.github_mcp_tool_config.is_some()); + + let (unset_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("github-mcp-unset"))) + .expect("default config has no duplicate handlers"); + assert!( + serde_json::to_value(&unset_wire) + .unwrap() + .get("githubMcpToolConfig") + .is_none() + ); + } + + #[test] + fn memory_configuration_constructors_and_serde() { + assert!(MemoryConfiguration::enabled().enabled); + assert!(!MemoryConfiguration::disabled().enabled); + assert!(MemoryConfiguration::disabled().with_enabled(true).enabled); + + let json = serde_json::to_value(MemoryConfiguration::enabled()).unwrap(); + assert_eq!(json, serde_json::json!({ "enabled": true })); + } + + #[test] + fn session_config_with_memory_serializes() { + let (wire, _runtime) = SessionConfig::default() + .with_memory(MemoryConfiguration::enabled()) + .into_wire(Some(SessionId::from("memory-on"))) + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["memory"], serde_json::json!({ "enabled": true })); + + let (wire_off, _) = SessionConfig::default() + .with_memory(MemoryConfiguration::disabled()) + .into_wire(Some(SessionId::from("memory-off"))) + .expect("no duplicate handlers"); + let json_off = serde_json::to_value(&wire_off).unwrap(); + assert_eq!(json_off["memory"], serde_json::json!({ "enabled": false })); + + // Unset memory is omitted on the wire. + let (empty_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("memory-unset"))) + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("memory").is_none()); + } + + #[test] + fn resume_session_config_with_memory_serializes() { + let (wire, _runtime) = ResumeSessionConfig::new(SessionId::from("resume-memory-on")) + .with_memory(MemoryConfiguration::enabled()) + .into_wire() + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["memory"], serde_json::json!({ "enabled": true })); + + // Unset memory is omitted on the wire. + let (empty_wire, _) = ResumeSessionConfig::new(SessionId::from("resume-memory-unset")) + .into_wire() + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("memory").is_none()); + } + + fn sample_exp_assignments(context: &str) -> CopilotExpAssignmentResponse { + CopilotExpAssignmentResponse { + features: vec!["copilot_exp_flag".to_string()], + flights: HashMap::from([("copilot_exp_flag".to_string(), "treatment".to_string())]), + configs: vec![ExpConfigEntry { + id: "cfg-1".to_string(), + parameters: HashMap::from([ + ("threshold".to_string(), ExpFlagValue::Integer(5)), + ("enabled".to_string(), ExpFlagValue::Bool(true)), + ]), + }], + assignment_context: context.to_string(), + ..Default::default() + } + } + + #[test] + fn exp_flag_value_round_trips_all_variants() { + let values = serde_json::json!({ + "s": "text", + "i": 7, + "f": 1.5, + "b": true, + "n": null, + }); + let parsed: HashMap = serde_json::from_value(values.clone()).unwrap(); + assert_eq!(parsed["s"], ExpFlagValue::String("text".to_string())); + assert_eq!(parsed["i"], ExpFlagValue::Integer(7)); + assert_eq!(parsed["f"], ExpFlagValue::Float(1.5)); + assert_eq!(parsed["b"], ExpFlagValue::Bool(true)); + assert_eq!(parsed["n"], ExpFlagValue::Null); + assert_eq!(serde_json::to_value(&parsed).unwrap(), values); + } + + #[test] + fn session_config_with_exp_assignments_serializes() { + let assignments = sample_exp_assignments("ctx-123"); + let expected = serde_json::to_value(&assignments).unwrap(); + let (wire, _runtime) = SessionConfig::default() + .with_exp_assignments(assignments) + .into_wire(Some(SessionId::from("exp-on"))) + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["expAssignments"], expected); + assert_eq!(json["expAssignments"]["AssignmentContext"], "ctx-123"); + assert_eq!( + json["expAssignments"]["Flights"]["copilot_exp_flag"], + "treatment" + ); + + // Unset exp assignments are omitted on the wire. + let (empty_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("exp-unset"))) + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("expAssignments").is_none()); + } + + #[test] + fn resume_session_config_with_exp_assignments_serializes() { + let assignments = sample_exp_assignments("ctx-456"); + let expected = serde_json::to_value(&assignments).unwrap(); + let (wire, _runtime) = ResumeSessionConfig::new(SessionId::from("resume-exp-on")) + .with_exp_assignments(assignments) + .into_wire() + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["expAssignments"], expected); + + // Unset exp assignments are omitted on the wire. + let (empty_wire, _) = ResumeSessionConfig::new(SessionId::from("resume-exp-unset")) + .into_wire() + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("expAssignments").is_none()); + } + + #[test] + fn session_config_clone_preserves_exp_assignments() { + let assignments = sample_exp_assignments("ctx-clone"); + let config = SessionConfig::default().with_exp_assignments(assignments.clone()); + let cloned = config.clone(); + + assert_eq!(cloned.exp_assignments.as_ref(), Some(&assignments)); + + let (wire, _runtime) = cloned + .into_wire(Some(SessionId::from("exp-clone"))) + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!( + json["expAssignments"], + serde_json::to_value(&assignments).unwrap() + ); + } + + #[test] + fn resume_session_config_clone_preserves_exp_assignments() { + let assignments = sample_exp_assignments("ctx-clone-resume"); + let config = ResumeSessionConfig::new(SessionId::from("resume-exp-clone")) + .with_exp_assignments(assignments.clone()); + let cloned = config.clone(); + + assert_eq!(cloned.exp_assignments.as_ref(), Some(&assignments)); + + let (wire, _runtime) = cloned.into_wire().expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!( + json["expAssignments"], + serde_json::to_value(&assignments).unwrap() + ); + } + #[test] #[allow(clippy::field_reassign_with_default)] fn session_config_into_wire_serializes_bucket_b_fields() { @@ -4496,12 +6480,90 @@ mod tests { assert!(empty_json.get("cloud").is_none()); } + #[test] + fn session_config_into_wire_serializes_named_providers_and_models() { + let cfg = SessionConfig::default() + .with_providers(vec![ + NamedProviderConfig::new("my-openai", "https://api.example.com/v1") + .with_provider_type("openai") + .with_wire_api("responses") + .with_api_key("sk-test"), + ]) + .with_models(vec![ + ProviderModelConfig::new("gpt-x", "my-openai") + .with_wire_model("gpt-x-2025") + .with_max_output_tokens(2048), + ]); + + let (wire, _) = cfg + .into_wire(Some(SessionId::from("sess-providers"))) + .expect("no duplicate handlers"); + let wire_json = serde_json::to_value(&wire).unwrap(); + assert_eq!(wire_json["providers"][0]["name"], "my-openai"); + assert_eq!( + wire_json["providers"][0]["baseUrl"], + "https://api.example.com/v1" + ); + assert_eq!(wire_json["providers"][0]["type"], "openai"); + assert_eq!(wire_json["providers"][0]["wireApi"], "responses"); + assert_eq!(wire_json["providers"][0]["apiKey"], "sk-test"); + assert_eq!(wire_json["models"][0]["id"], "gpt-x"); + assert_eq!(wire_json["models"][0]["provider"], "my-openai"); + assert_eq!(wire_json["models"][0]["wireModel"], "gpt-x-2025"); + assert_eq!(wire_json["models"][0]["maxOutputTokens"], 2048); + + let (empty_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("empty"))) + .expect("default has no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("providers").is_none()); + assert!(empty_json.get("models").is_none()); + } + + #[test] + fn resume_config_into_wire_serializes_named_providers_and_models() { + let cfg = ResumeSessionConfig::new(SessionId::from("sess-resume")) + .with_providers(vec![ + NamedProviderConfig::new("my-azure", "https://example.openai.azure.com") + .with_provider_type("azure") + .with_azure(AzureProviderOptions { + api_version: Some("2024-10-21".to_string()), + }), + ]) + .with_models(vec![ + ProviderModelConfig::new("deploy-1", "my-azure").with_model_id("gpt-4o"), + ]); + + let (wire, _) = cfg.into_wire().expect("no duplicate handlers"); + let wire_json = serde_json::to_value(&wire).unwrap(); + assert_eq!(wire_json["providers"][0]["name"], "my-azure"); + assert_eq!(wire_json["providers"][0]["type"], "azure"); + assert_eq!( + wire_json["providers"][0]["azure"]["apiVersion"], + "2024-10-21" + ); + assert_eq!(wire_json["models"][0]["id"], "deploy-1"); + assert_eq!(wire_json["models"][0]["provider"], "my-azure"); + assert_eq!(wire_json["models"][0]["modelId"], "gpt-4o"); + + let (empty_wire, _) = ResumeSessionConfig::new(SessionId::from("empty")) + .into_wire() + .expect("default has no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("providers").is_none()); + assert!(empty_json.get("models").is_none()); + } + #[test] fn session_config_into_wire_serializes_plugin_directories_and_large_output() { use std::path::PathBuf; let cfg = SessionConfig { plugin_directories: Some(vec![PathBuf::from("/tmp/plugins")]), + disabled_mcp_servers: Some(vec![ + "local-files".to_string(), + "remote-github".to_string(), + ]), large_output: Some( LargeToolOutputConfig::new() .with_enabled(true) @@ -4516,6 +6578,10 @@ mod tests { .expect("no duplicate handlers"); let wire_json = serde_json::to_value(&wire).unwrap(); assert_eq!(wire_json["pluginDirectories"][0], "/tmp/plugins"); + assert_eq!( + wire_json["disabledMcpServers"], + serde_json::json!(["local-files", "remote-github"]) + ); assert_eq!(wire_json["largeOutput"]["enabled"], true); assert_eq!(wire_json["largeOutput"]["maxSizeBytes"], 1024); assert_eq!(wire_json["largeOutput"]["outputDir"], "/tmp/large-output"); @@ -4525,6 +6591,7 @@ mod tests { .expect("default has no duplicate handlers"); let empty_json = serde_json::to_value(&empty_wire).unwrap(); assert!(empty_json.get("pluginDirectories").is_none()); + assert!(empty_json.get("disabledMcpServers").is_none()); assert!(empty_json.get("largeOutput").is_none()); } @@ -4574,6 +6641,7 @@ mod tests { let mut cfg = ResumeSessionConfig::new(SessionId::from("sess-1")); cfg.plugin_directories = Some(vec![PathBuf::from("/tmp/plugins-r")]); + cfg.disabled_mcp_servers = Some(vec!["local-files-r".to_string()]); cfg.large_output = Some( LargeToolOutputConfig::new() .with_enabled(false) @@ -4584,6 +6652,10 @@ mod tests { let (wire, _) = cfg.into_wire().expect("no duplicate handlers"); let wire_json = serde_json::to_value(&wire).unwrap(); assert_eq!(wire_json["pluginDirectories"][0], "/tmp/plugins-r"); + assert_eq!( + wire_json["disabledMcpServers"], + serde_json::json!(["local-files-r"]) + ); assert_eq!(wire_json["largeOutput"]["enabled"], false); assert_eq!(wire_json["largeOutput"]["maxSizeBytes"], 2048); assert_eq!(wire_json["largeOutput"]["outputDir"], "/tmp/large-output-r"); @@ -4593,12 +6665,41 @@ mod tests { .expect("default resume has no duplicate handlers"); let empty_json = serde_json::to_value(&empty_wire).unwrap(); assert!(empty_json.get("pluginDirectories").is_none()); + assert!(empty_json.get("disabledMcpServers").is_none()); assert!(empty_json.get("largeOutput").is_none()); } + #[test] + fn session_config_clones_disabled_mcp_servers() { + let create = SessionConfig::default().with_disabled_mcp_servers(["local-files"]); + let mut create_clone = create.clone(); + create_clone + .disabled_mcp_servers + .as_mut() + .expect("configured disabled MCP servers") + .push("remote-github".to_string()); + assert_eq!( + create.disabled_mcp_servers.as_deref(), + Some(&["local-files".to_string()][..]) + ); + + let resume = ResumeSessionConfig::new(SessionId::from("sess-1")) + .with_disabled_mcp_servers(["local-files"]); + let mut resume_clone = resume.clone(); + resume_clone + .disabled_mcp_servers + .as_mut() + .expect("configured disabled MCP servers") + .push("remote-github".to_string()); + assert_eq!( + resume.disabled_mcp_servers.as_deref(), + Some(&["local-files".to_string()][..]) + ); + } + #[test] fn session_config_builder_composes() { - use std::collections::HashMap; + use indexmap::IndexMap; let cfg = SessionConfig::default() .with_session_id(SessionId::from("sess-1")) @@ -4611,16 +6712,19 @@ mod tests { .with_tools([Tool::new("greet")]) .with_available_tools(["bash", "view"]) .with_excluded_tools(["dangerous"]) - .with_mcp_servers(HashMap::new()) + .with_mcp_servers(IndexMap::new()) .with_mcp_oauth_token_storage("persistent") .with_enable_config_discovery(true) .with_enable_on_demand_instruction_discovery(true) .with_skill_directories([PathBuf::from("/tmp/skills")]) .with_disabled_skills(["broken-skill"]) + .with_disabled_mcp_servers(["local-files"]) .with_agent("researcher") .with_config_directory(PathBuf::from("/tmp/config")) .with_working_directory(PathBuf::from("/tmp/work")) + .with_additional_directories([PathBuf::from("/tmp/shared")]) .with_github_token("ghp_test") + .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) .with_enable_session_telemetry(false) .with_include_sub_agent_streaming_events(false) .with_extension_info(ExtensionInfo::new("github-app", "counter")); @@ -4653,10 +6757,22 @@ mod tests { cfg.disabled_skills.as_deref(), Some(&["broken-skill".to_string()][..]) ); + assert_eq!( + cfg.disabled_mcp_servers.as_deref(), + Some(&["local-files".to_string()][..]) + ); assert_eq!(cfg.agent.as_deref(), Some("researcher")); assert_eq!(cfg.config_directory, Some(PathBuf::from("/tmp/config"))); assert_eq!(cfg.working_directory, Some(PathBuf::from("/tmp/work"))); + assert_eq!( + cfg.additional_directories.as_deref(), + Some(&[PathBuf::from("/tmp/shared")][..]) + ); assert_eq!(cfg.github_token.as_deref(), Some("ghp_test")); + assert_eq!( + cfg.capi, + Some(CapiSessionOptions::new().with_enable_web_socket_responses(false)) + ); assert_eq!(cfg.enable_session_telemetry, Some(false)); assert_eq!(cfg.include_sub_agent_streaming_events, Some(false)); assert_eq!( @@ -4667,7 +6783,7 @@ mod tests { #[test] fn resume_session_config_builder_composes() { - use std::collections::HashMap; + use indexmap::IndexMap; let cfg = ResumeSessionConfig::new(SessionId::from("sess-2")) .with_client_name("test-app") @@ -4677,16 +6793,19 @@ mod tests { .with_tools([Tool::new("greet")]) .with_available_tools(["bash", "view"]) .with_excluded_tools(["dangerous"]) - .with_mcp_servers(HashMap::new()) + .with_mcp_servers(IndexMap::new()) .with_mcp_oauth_token_storage("persistent") .with_enable_config_discovery(true) .with_enable_on_demand_instruction_discovery(false) .with_skill_directories([PathBuf::from("/tmp/skills")]) .with_disabled_skills(["broken-skill"]) + .with_disabled_mcp_servers(["local-files"]) .with_agent("researcher") .with_config_directory(PathBuf::from("/tmp/config")) .with_working_directory(PathBuf::from("/tmp/work")) + .with_additional_directories([PathBuf::from("/tmp/shared")]) .with_github_token("ghp_test") + .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) .with_enable_session_telemetry(false) .with_include_sub_agent_streaming_events(true) .with_suppress_resume_event(true) @@ -4719,10 +6838,22 @@ mod tests { cfg.disabled_skills.as_deref(), Some(&["broken-skill".to_string()][..]) ); + assert_eq!( + cfg.disabled_mcp_servers.as_deref(), + Some(&["local-files".to_string()][..]) + ); assert_eq!(cfg.agent.as_deref(), Some("researcher")); assert_eq!(cfg.config_directory, Some(PathBuf::from("/tmp/config"))); assert_eq!(cfg.working_directory, Some(PathBuf::from("/tmp/work"))); + assert_eq!( + cfg.additional_directories.as_deref(), + Some(&[PathBuf::from("/tmp/shared")][..]) + ); assert_eq!(cfg.github_token.as_deref(), Some("ghp_test")); + assert_eq!( + cfg.capi, + Some(CapiSessionOptions::new().with_enable_web_socket_responses(false)) + ); assert_eq!(cfg.enable_session_telemetry, Some(false)); assert_eq!(cfg.include_sub_agent_streaming_events, Some(true)); assert_eq!(cfg.suppress_resume_event, Some(true)); @@ -4752,6 +6883,29 @@ mod tests { assert!(json.get("continuePendingWork").is_none()); } + #[test] + fn session_configs_serialize_additional_directories() { + let create = SessionConfig::default().with_additional_directories([ + PathBuf::from("/tmp/shared"), + PathBuf::from("/tmp/generated"), + ]); + let (create_wire, _) = create.into_wire(None).expect("no duplicate handlers"); + let create_json = serde_json::to_value(&create_wire).unwrap(); + assert_eq!( + create_json["additionalDirectories"], + serde_json::json!(["/tmp/shared", "/tmp/generated"]) + ); + + let resume = ResumeSessionConfig::new(SessionId::from("sess-1")) + .with_additional_directories([PathBuf::from("/tmp/resumed")]); + let (resume_wire, _) = resume.into_wire().expect("no duplicate handlers"); + let resume_json = serde_json::to_value(&resume_wire).unwrap(); + assert_eq!( + resume_json["additionalDirectories"], + serde_json::json!(["/tmp/resumed"]) + ); + } + /// The Rust field is `suppress_resume_event`, but the wire field stays /// `disableResume` to preserve compatibility with the runtime and other /// SDKs. @@ -4810,13 +6964,13 @@ mod tests { #[test] fn custom_agent_config_builder_composes() { - use std::collections::HashMap; + use indexmap::IndexMap; let cfg = CustomAgentConfig::new("researcher", "You are a research assistant.") .with_display_name("Research Assistant") .with_description("Investigates technical questions.") .with_tools(["bash", "view"]) - .with_mcp_servers(HashMap::new()) + .with_mcp_servers(IndexMap::new()) .with_infer(true) .with_skills(["rust-coding-skill"]); @@ -4839,6 +6993,51 @@ mod tests { ); } + #[test] + fn mcp_servers_serialize_in_insertion_order() { + use indexmap::IndexMap; + + // Regression: `mcp_servers` was a `HashMap`, so the server keys (and + // thus the `session.create` payload) serialized in a per-process + // random order; `IndexMap` pins them to insertion order. The long + // sequence makes a `HashMap` regression reproduce this exact order by + // chance only 1/N!, avoiding a flaky false pass. + let order = [ + "zebra", "quartz", "delta", "ivy", "mango", "bravo", "xenon", "amber", "falcon", + "ceres", "nova", "kelp", "otter", "yodel", "plum", "garnet", + ]; + let mut servers = IndexMap::new(); + for name in order { + servers.insert( + name.to_string(), + McpServerConfig::Stdio(McpStdioServerConfig { + command: "run".to_string(), + ..Default::default() + }), + ); + } + + let (wire, _runtime) = SessionConfig::default() + .with_mcp_servers(servers) + .into_wire(None) + .expect("into_wire should succeed"); + let json = serde_json::to_string(&wire).expect("serialize wire"); + + let positions: Vec = order + .iter() + .map(|name| { + json.find(&format!("\"{name}\"")) + .unwrap_or_else(|| panic!("server {name} missing from wire JSON")) + }) + .collect(); + let mut ascending = positions.clone(); + ascending.sort_unstable(); + assert_eq!( + positions, ascending, + "mcp server keys must serialize in insertion order: {json}" + ); + } + #[test] fn infinite_session_config_builder_composes() { let cfg = InfiniteSessionConfig::new() @@ -4861,6 +7060,7 @@ mod tests { let cfg = ProviderConfig::new("https://api.example.com") .with_provider_type("openai") .with_wire_api("completions") + .with_transport("websockets") .with_api_key("sk-test") .with_bearer_token("bearer-test") .with_headers(headers) @@ -4872,6 +7072,7 @@ mod tests { assert_eq!(cfg.base_url, "https://api.example.com"); assert_eq!(cfg.provider_type.as_deref(), Some("openai")); assert_eq!(cfg.wire_api.as_deref(), Some("completions")); + assert_eq!(cfg.transport.as_deref(), Some("websockets")); assert_eq!(cfg.api_key.as_deref(), Some("sk-test")); assert_eq!(cfg.bearer_token.as_deref(), Some("bearer-test")); assert_eq!( @@ -4901,6 +7102,61 @@ mod tests { assert!(wire_unset.get("maxOutputTokens").is_none()); } + #[test] + fn capi_session_options_builder_composes_and_serializes() { + let cfg = CapiSessionOptions::new().with_enable_web_socket_responses(false); + + assert_eq!(cfg.enable_web_socket_responses, Some(false)); + + let wire = serde_json::to_value(&cfg).unwrap(); + assert_eq!( + wire, + serde_json::json!({ "enableWebSocketResponses": false }) + ); + + let unset = CapiSessionOptions::new(); + let wire_unset = serde_json::to_value(&unset).unwrap(); + assert!(wire_unset.get("enableWebSocketResponses").is_none()); + } + + #[test] + fn session_config_with_capi_serializes() { + let (wire, _) = SessionConfig::default() + .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) + .into_wire(Some(SessionId::from("capi-create"))) + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!( + json["capi"], + serde_json::json!({ "enableWebSocketResponses": false }) + ); + + let (empty_wire, _) = SessionConfig::default() + .into_wire(Some(SessionId::from("capi-create-unset"))) + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("capi").is_none()); + } + + #[test] + fn resume_session_config_with_capi_serializes() { + let (wire, _) = ResumeSessionConfig::new(SessionId::from("capi-resume")) + .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) + .into_wire() + .expect("no duplicate handlers"); + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!( + json["capi"], + serde_json::json!({ "enableWebSocketResponses": false }) + ); + + let (empty_wire, _) = ResumeSessionConfig::new(SessionId::from("capi-resume-unset")) + .into_wire() + .expect("no duplicate handlers"); + let empty_json = serde_json::to_value(&empty_wire).unwrap(); + assert!(empty_json.get("capi").is_none()); + } + #[test] fn system_message_config_builder_composes() { use std::collections::HashMap; @@ -5160,6 +7416,153 @@ mod tests { Some("Track regressions".to_string()) ); } + + #[test] + fn github_anchored_attachment_variants_round_trip() { + let cases = vec![ + ( + "github_commit", + json!({ + "type": "github_commit", + "message": "Fix the thing", + "oid": "abc123", + "repo": { "id": 1, "name": "repo", "owner": "octocat" }, + "url": "https://github.com/octocat/repo/commit/abc123" + }), + ), + ( + "github_release", + json!({ + "type": "github_release", + "name": "v1.2.3", + "repo": { "name": "repo", "owner": "octocat" }, + "tagName": "v1.2.3", + "url": "https://github.com/octocat/repo/releases/tag/v1.2.3" + }), + ), + ( + "github_actions_job", + json!({ + "type": "github_actions_job", + "conclusion": "failure", + "jobId": 99, + "jobName": "build", + "repo": { "name": "repo", "owner": "octocat" }, + "url": "https://github.com/octocat/repo/actions/runs/1/job/99", + "workflowName": "CI" + }), + ), + ( + "github_repository", + json!({ + "type": "github_repository", + "description": "An example repository", + "ref": "main", + "repo": { "name": "repo", "owner": "octocat" }, + "url": "https://github.com/octocat/repo" + }), + ), + ( + "github_file_diff", + json!({ + "type": "github_file_diff", + "base": { + "path": "src/lib.rs", + "ref": "main", + "repo": { "name": "repo", "owner": "octocat" } + }, + "head": { + "path": "src/lib.rs", + "ref": "feature", + "repo": { "name": "repo", "owner": "octocat" } + }, + "url": "https://github.com/octocat/repo/compare/main...feature" + }), + ), + ( + "github_tree_comparison", + json!({ + "type": "github_tree_comparison", + "base": { + "repo": { "name": "repo", "owner": "octocat" }, + "revision": "main" + }, + "head": { + "repo": { "name": "repo", "owner": "octocat" }, + "revision": "feature" + }, + "url": "https://github.com/octocat/repo/compare/main...feature" + }), + ), + ( + "github_url", + json!({ + "type": "github_url", + "url": "https://github.com/octocat/repo/wiki" + }), + ), + ( + "github_file", + json!({ + "type": "github_file", + "path": "src/main.rs", + "ref": "main", + "repo": { "name": "repo", "owner": "octocat" }, + "url": "https://github.com/octocat/repo/blob/main/src/main.rs" + }), + ), + ( + "github_snippet", + json!({ + "type": "github_snippet", + "lineRange": { "start": 10, "end": 20 }, + "path": "src/main.rs", + "ref": "main", + "repo": { "name": "repo", "owner": "octocat" }, + "url": "https://github.com/octocat/repo/blob/main/src/main.rs#L10-L20" + }), + ), + ]; + + for (expected_type, input) in cases { + let attachment: Attachment = serde_json::from_value(input.clone()) + .unwrap_or_else(|err| panic!("{expected_type} should deserialize: {err}")); + + // Serialize to a string first: parsing into `serde_json::Value` would + // silently dedupe a duplicate `type` key, hiding the exact regression + // this test guards against (e.g. a wrapped generated struct emitting its + // own `type` alongside the enum tag). + let serialized_string = serde_json::to_string(&attachment) + .unwrap_or_else(|err| panic!("{expected_type} should serialize: {err}")); + + // Exactly one `type` key, carrying the expected discriminator. + assert_eq!( + serialized_string.matches("\"type\":").count(), + 1, + "{expected_type} must serialize a single `type` key" + ); + + let serialized: serde_json::Value = serde_json::from_str(&serialized_string) + .unwrap_or_else(|err| panic!("{expected_type} should reparse: {err}")); + assert_eq!( + serialized.get("type").and_then(|value| value.as_str()), + Some(expected_type), + "{expected_type} must serialize the correct discriminator" + ); + + // Round-trips without dropping fields. + assert_eq!( + serialized, input, + "{expected_type} should round-trip without data loss" + ); + let reparsed: Attachment = serde_json::from_value(serialized) + .unwrap_or_else(|err| panic!("{expected_type} should re-deserialize: {err}")); + assert_eq!( + reparsed, attachment, + "{expected_type} should re-deserialize to the same value" + ); + } + } } #[cfg(test)] @@ -5204,7 +7607,10 @@ mod permission_builder_tests { let h = resolve_create(cfg).expect("policy + handler yields handler"); assert!(matches!( dispatch(&h).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); } @@ -5214,7 +7620,10 @@ mod permission_builder_tests { let h = resolve_create(cfg).expect("policy alone yields handler"); assert!(matches!( dispatch(&h).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); } @@ -5232,11 +7641,17 @@ mod permission_builder_tests { let hb = resolve_create(b).unwrap(); assert!(matches!( dispatch(&ha).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); assert!(matches!( dispatch(&hb).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); } @@ -5252,11 +7667,17 @@ mod permission_builder_tests { let hb = resolve_create(b).unwrap(); assert!(matches!( dispatch(&ha).await, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); assert!(matches!( dispatch(&hb).await, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); } @@ -5268,7 +7689,10 @@ mod permission_builder_tests { let h = resolve_create(cfg).unwrap(); assert!(matches!( dispatch(&h).await, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); } @@ -5287,11 +7711,17 @@ mod permission_builder_tests { let hb = resolve_create(b).unwrap(); assert!(matches!( dispatch(&ha).await, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); assert!(matches!( dispatch(&hb).await, - PermissionResult::Decision(PermissionDecision::Reject(_)) + PermissionResult::Decision { + decision: PermissionDecision::Reject(_), + .. + } )); } @@ -5303,7 +7733,10 @@ mod permission_builder_tests { let h = resolve_resume(cfg).unwrap(); assert!(matches!( dispatch(&h).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); } @@ -5319,11 +7752,121 @@ mod permission_builder_tests { let hb = resolve_resume(b).unwrap(); assert!(matches!( dispatch(&ha).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); assert!(matches!( dispatch(&hb).await, - PermissionResult::Decision(PermissionDecision::ApproveOnce(_)) + PermissionResult::Decision { + decision: PermissionDecision::ApproveOnce(_), + .. + } )); } + + #[test] + fn session_config_enable_experimental_mode_serializes_when_set() { + let cfg = SessionConfig::default().with_enable_experimental_mode(false); + assert_eq!(cfg.enable_experimental_mode, Some(false)); + + let (wire, _runtime) = cfg + .into_wire(Some(SessionId::from("experimental-mode"))) + .expect("enable_experimental_mode config has no duplicate handlers"); + assert_eq!(wire.is_experimental_mode, Some(false)); + + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["isExperimentalMode"], serde_json::Value::Bool(false)); + } + + #[test] + fn session_config_enable_experimental_mode_omitted_when_none() { + let cfg = SessionConfig::default(); + assert_eq!(cfg.enable_experimental_mode, None); + + let (wire, _runtime) = cfg + .into_wire(Some(SessionId::from("no-experimental-mode"))) + .expect("default config has no duplicate handlers"); + assert_eq!(wire.is_experimental_mode, None); + + let json = serde_json::to_value(&wire).unwrap(); + assert!(json.get("isExperimentalMode").is_none()); + } + + #[test] + fn resume_session_config_enable_experimental_mode_serializes_when_set() { + let cfg = ResumeSessionConfig::new(SessionId::from("resume-experimental-mode")) + .with_enable_experimental_mode(false); + assert_eq!(cfg.enable_experimental_mode, Some(false)); + + let (wire, _runtime) = cfg + .into_wire() + .expect("resume enable_experimental_mode config has no duplicate handlers"); + assert_eq!(wire.is_experimental_mode, Some(false)); + + let json = serde_json::to_value(&wire).unwrap(); + assert_eq!(json["isExperimentalMode"], serde_json::Value::Bool(false)); + } + + #[test] + fn resume_session_config_enable_experimental_mode_omitted_when_none() { + let cfg = ResumeSessionConfig::new(SessionId::from("resume-no-experimental-mode")); + assert_eq!(cfg.enable_experimental_mode, None); + + let (wire, _runtime) = cfg + .into_wire() + .expect("default resume config has no duplicate handlers"); + assert_eq!(wire.is_experimental_mode, None); + + let json = serde_json::to_value(&wire).unwrap(); + assert!(json.get("isExperimentalMode").is_none()); + } +} + +#[cfg(test)] +mod is_terminal_tests { + use super::Tool; + + #[test] + fn is_terminal_serializes_as_camel_case_when_set() { + let tool = Tool { + name: "clear_context".to_owned(), + is_terminal: true, + ..Default::default() + }; + let value = serde_json::to_value(&tool).expect("tool serializes"); + assert_eq!( + value.get("isTerminal"), + Some(&serde_json::Value::Bool(true)) + ); + } + + #[test] + fn is_terminal_is_omitted_when_false() { + let tool = Tool { + name: "plain".to_owned(), + ..Default::default() + }; + let value = serde_json::to_value(&tool).expect("tool serializes"); + assert!(value.get("isTerminal").is_none()); + } + + /// `Tool` has a hand-written `Debug` impl, so a new field is only reported + /// if it is added there by hand. Guard against that drift. + #[test] + fn is_terminal_appears_in_debug_output() { + let terminal = Tool { + name: "clear_context".to_owned(), + is_terminal: true, + ..Default::default() + }; + assert!(format!("{terminal:?}").contains("is_terminal: true")); + + let plain = Tool { + name: "plain".to_owned(), + ..Default::default() + }; + assert!(format!("{plain:?}").contains("is_terminal: false")); + } } diff --git a/rust/src/wire.rs b/rust/src/wire.rs index de40720b2..21b61a7f9 100644 --- a/rust/src/wire.rs +++ b/rust/src/wire.rs @@ -13,9 +13,9 @@ //! configs hold trait-object handlers, the wire structs hold only the //! plain data the runtime needs. -use std::collections::HashMap; use std::path::PathBuf; +use indexmap::IndexMap; use serde::Serialize; use crate::canvas::CanvasDeclaration; @@ -24,9 +24,11 @@ use crate::generated::api_types::{ }; use crate::generated::session_events::ReasoningSummary; use crate::types::{ - CloudSessionOptions, CustomAgentConfig, DefaultAgentConfig, ExtensionInfo, - InfiniteSessionConfig, LargeToolOutputConfig, McpServerConfig, ProviderConfig, SessionId, - SystemMessageConfig, Tool, + CanvasProviderIdentity, CapiSessionOptions, CloudSessionOptions, CustomAgentConfig, + DefaultAgentConfig, ExtensionInfo, GitHubMcpToolConfig, InfiniteSessionConfig, + LargeToolOutputConfig, McpServerConfig, MemoryConfiguration, NamedProviderConfig, + ProviderConfig, ProviderModelConfig, SessionId, SessionLimitsConfig, SystemMessageConfig, Tool, + ToolSearchConfig, }; /// Wire representation of a slash command (name + description only). The @@ -73,14 +75,18 @@ pub(crate) struct SessionCreateWire { #[serde(skip_serializing_if = "Option::is_none")] pub extension_info: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub canvas_provider: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub available_tools: Option>, #[serde(skip_serializing_if = "Option::is_none")] pub excluded_tools: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_builtin_agents: Option>, /// SDK always sends `"excluded"` so include + exclude lists compose /// naturally (everything matching X except Y). pub tool_filter_precedence: &'static str, #[serde(skip_serializing_if = "Option::is_none")] - pub mcp_servers: Option>, + pub mcp_servers: Option>, #[serde(skip_serializing_if = "Option::is_none")] pub mcp_oauth_token_storage: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -108,6 +114,8 @@ pub(crate) struct SessionCreateWire { pub request_auto_mode_switch: bool, pub request_elicitation: bool, pub request_mcp_apps: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub github_mcp_tool_config: Option, pub hooks: bool, #[serde(skip_serializing_if = "Option::is_none")] pub skill_directories: Option>, @@ -118,10 +126,16 @@ pub(crate) struct SessionCreateWire { #[serde(skip_serializing_if = "Option::is_none")] pub large_output: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub tool_search: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub disabled_skills: Option>, #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_mcp_servers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] pub custom_agents: Option>, #[serde(skip_serializing_if = "Option::is_none")] + pub custom_agents_local_only: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub default_agent: Option, #[serde(skip_serializing_if = "Option::is_none")] pub agent: Option, @@ -130,13 +144,29 @@ pub(crate) struct SessionCreateWire { #[serde(skip_serializing_if = "Option::is_none")] pub provider: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub capi: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub providers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub models: Option>, + #[serde(skip_serializing_if = "Option::is_none")] pub enable_session_telemetry: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub enable_citations: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_file_change_tracking: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub model_capabilities: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub memory: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub config_dir: Option, #[serde(skip_serializing_if = "Option::is_none")] pub working_directory: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_directories: Option>, #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")] pub github_token: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -145,8 +175,21 @@ pub(crate) struct SessionCreateWire { pub cloud: Option, #[serde(skip_serializing_if = "Option::is_none")] pub include_sub_agent_streaming_events: Option, + #[serde( + rename = "enableGitHubTelemetryForwarding", + skip_serializing_if = "Option::is_none" + )] + pub enable_github_telemetry_forwarding: Option, #[serde(skip_serializing_if = "Option::is_none")] pub commands: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub exp_assignments: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_managed_settings: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub is_experimental_mode: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_settings: Option, } /// The exact JSON shape sent on the `session.resume` JSON-RPC request. @@ -155,6 +198,8 @@ pub(crate) struct SessionCreateWire { pub(crate) struct SessionResumeWire { pub session_id: SessionId, #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub client_name: Option, #[serde(skip_serializing_if = "Option::is_none")] pub reasoning_effort: Option, @@ -181,13 +226,17 @@ pub(crate) struct SessionResumeWire { #[serde(skip_serializing_if = "Option::is_none")] pub extension_info: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub canvas_provider: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub available_tools: Option>, #[serde(skip_serializing_if = "Option::is_none")] pub excluded_tools: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub excluded_builtin_agents: Option>, /// SDK always sends `"excluded"`. See create-wire docs. pub tool_filter_precedence: &'static str, #[serde(skip_serializing_if = "Option::is_none")] - pub mcp_servers: Option>, + pub mcp_servers: Option>, #[serde(skip_serializing_if = "Option::is_none")] pub mcp_oauth_token_storage: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -215,6 +264,8 @@ pub(crate) struct SessionResumeWire { pub request_auto_mode_switch: bool, pub request_elicitation: bool, pub request_mcp_apps: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub github_mcp_tool_config: Option, pub hooks: bool, #[serde(skip_serializing_if = "Option::is_none")] pub skill_directories: Option>, @@ -225,10 +276,16 @@ pub(crate) struct SessionResumeWire { #[serde(skip_serializing_if = "Option::is_none")] pub large_output: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub tool_search: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub disabled_skills: Option>, #[serde(skip_serializing_if = "Option::is_none")] + pub disabled_mcp_servers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] pub custom_agents: Option>, #[serde(skip_serializing_if = "Option::is_none")] + pub custom_agents_local_only: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub default_agent: Option, #[serde(skip_serializing_if = "Option::is_none")] pub agent: Option, @@ -237,19 +294,40 @@ pub(crate) struct SessionResumeWire { #[serde(skip_serializing_if = "Option::is_none")] pub provider: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub capi: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub providers: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub models: Option>, + #[serde(skip_serializing_if = "Option::is_none")] pub enable_session_telemetry: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub enable_citations: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_file_change_tracking: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub session_limits: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub model_capabilities: Option, #[serde(skip_serializing_if = "Option::is_none")] + pub memory: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub config_dir: Option, #[serde(skip_serializing_if = "Option::is_none")] pub working_directory: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_directories: Option>, #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")] pub github_token: Option, #[serde(skip_serializing_if = "Option::is_none")] pub remote_session: Option, #[serde(skip_serializing_if = "Option::is_none")] pub include_sub_agent_streaming_events: Option, + #[serde( + rename = "enableGitHubTelemetryForwarding", + skip_serializing_if = "Option::is_none" + )] + pub enable_github_telemetry_forwarding: Option, #[serde(skip_serializing_if = "Option::is_none")] pub commands: Option>, /// Maps to wire field `disableResume`. @@ -257,4 +335,12 @@ pub(crate) struct SessionResumeWire { pub suppress_resume_event: Option, #[serde(skip_serializing_if = "Option::is_none")] pub continue_pending_work: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub exp_assignments: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_managed_settings: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub is_experimental_mode: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub managed_settings: Option, } diff --git a/rust/tests/api_types_test.rs b/rust/tests/api_types_test.rs index 2a373a3b5..9b86b1367 100644 --- a/rust/tests/api_types_test.rs +++ b/rust/tests/api_types_test.rs @@ -3,10 +3,11 @@ #![allow(clippy::unwrap_used)] -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ Extension, ExtensionList, ExtensionSource, ExtensionStatus, ExtensionsDisableRequest, ExtensionsEnableRequest, FleetStartRequest, FleetStartResult, TasksStartAgentRequest, }; +use github_copilot_sdk::session_events::{PermissionRequest, PermissionRequestedData}; #[test] fn extension_running_has_expected_status_and_source() { @@ -84,6 +85,25 @@ fn tasks_start_agent_request_fields_are_accessible() { assert_eq!(request.description.as_deref(), Some("SDK task agent")); } +#[test] +fn permission_event_exposes_managed_approval_required() { + let data: PermissionRequestedData = serde_json::from_value(serde_json::json!({ + "permissionRequest": { + "kind": "read", + "intention": "Read managed content", + "path": "/workspace/file.txt", + "managedApprovalRequired": true + }, + "requestId": "permission-1" + })) + .unwrap(); + + let PermissionRequest::Read(request) = data.permission_request else { + panic!("expected read permission request"); + }; + assert_eq!(request.managed_approval_required, Some(true)); +} + fn running_extension(id: &str, name: &str) -> Extension { Extension { id: id.to_string(), diff --git a/rust/tests/builtin_plugin_directories_test.rs b/rust/tests/builtin_plugin_directories_test.rs new file mode 100644 index 000000000..f1310f9b0 --- /dev/null +++ b/rust/tests/builtin_plugin_directories_test.rs @@ -0,0 +1,135 @@ +#![allow(clippy::unwrap_used)] + +use std::path::PathBuf; + +use github_copilot_sdk::{CliProgram, Client, ClientOptions, ErrorKind, Transport}; +use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt}; +use tokio::net::TcpListener; + +async fn read_framed(reader: &mut (impl AsyncRead + Unpin)) -> serde_json::Value { + let mut header = String::new(); + loop { + let mut byte = [0u8; 1]; + reader.read_exact(&mut byte).await.unwrap(); + header.push(byte[0] as char); + if header.ends_with("\r\n\r\n") { + break; + } + } + let length = header + .trim() + .strip_prefix("Content-Length: ") + .unwrap() + .parse() + .unwrap(); + let mut body = vec![0; length]; + reader.read_exact(&mut body).await.unwrap(); + serde_json::from_slice(&body).unwrap() +} + +async fn write_result( + writer: &mut (impl AsyncWrite + Unpin), + request: &serde_json::Value, + result: serde_json::Value, +) { + let body = serde_json::to_vec(&serde_json::json!({ + "jsonrpc": "2.0", + "id": request["id"], + "result": result, + })) + .unwrap(); + writer + .write_all(format!("Content-Length: {}\r\n\r\n", body.len()).as_bytes()) + .await + .unwrap(); + writer.write_all(&body).await.unwrap(); + writer.flush().await.unwrap(); +} + +async fn run_start(paths: Option>) -> Vec { + let listener = TcpListener::bind(("127.0.0.1", 0)).await.unwrap(); + let address = listener.local_addr().unwrap(); + let expect_builtin = paths.as_ref().is_some_and(|paths| !paths.is_empty()); + + let server = tokio::spawn(async move { + let (stream, _) = listener.accept().await.unwrap(); + let (mut reader, mut writer) = tokio::io::split(stream); + let mut requests = Vec::new(); + + let connect = read_framed(&mut reader).await; + write_result( + &mut writer, + &connect, + serde_json::json!({ "ok": true, "protocolVersion": 3, "version": "test" }), + ) + .await; + requests.push(connect); + + if expect_builtin { + let builtin = read_framed(&mut reader).await; + write_result(&mut writer, &builtin, serde_json::json!({})).await; + requests.push(builtin); + } + requests + }); + + let mut options = ClientOptions::new() + .with_program(CliProgram::Path(std::env::current_exe().unwrap())) + .with_transport(Transport::External { + host: address.ip().to_string(), + port: address.port(), + connection_token: None, + }); + if let Some(paths) = paths { + options = options.with_builtin_plugin_directories(paths); + } + let client = Client::start(options).await.unwrap(); + let requests = server.await.unwrap(); + client.force_stop(); + requests +} + +#[tokio::test] +async fn default_and_empty_do_not_call_rpc() { + for paths in [None, Some(Vec::new())] { + let requests = run_start(paths).await; + assert_eq!(requests.len(), 1); + assert_eq!(requests[0]["method"], "connect"); + } +} + +#[tokio::test] +async fn configured_directories_call_rpc_once_before_start_completes() { + let cwd = std::env::current_dir().unwrap(); + let paths = vec![cwd.join("plugins/core"), cwd.join("plugins/github")]; + + let requests = run_start(Some(paths.clone())).await; + + assert_eq!(requests.len(), 2); + assert_eq!(requests[0]["method"], "connect"); + assert_eq!(requests[1]["method"], "plugins.builtin.set"); + assert_eq!( + requests[1]["params"], + serde_json::json!({ + "paths": paths + .iter() + .map(|path| path.to_str().unwrap()) + .collect::>() + }) + ); +} + +#[tokio::test] +async fn relative_directory_is_rejected() { + let options = ClientOptions::new() + .with_program(CliProgram::Path(std::env::current_exe().unwrap())) + .with_builtin_plugin_directories(["plugins/core"]); + + let error = match Client::start(options).await { + Ok(_) => panic!("relative path unexpectedly accepted"), + Err(error) => error, + }; + + assert_eq!(error.kind(), &ErrorKind::InvalidConfig); + assert!(error.to_string().contains("absolute paths")); +} diff --git a/rust/tests/cli_resolution_test.rs b/rust/tests/cli_resolution_test.rs index c3044a9e7..9e4927e67 100644 --- a/rust/tests/cli_resolution_test.rs +++ b/rust/tests/cli_resolution_test.rs @@ -196,21 +196,27 @@ async fn extract_dir_runtime_override_is_honored() { let _ = fake; } -/// Build-time version pin: `cli-version.txt` (when present) must be a -/// combined snapshot — a `version=X.Y.Z` line plus per-asset hash lines. +/// Build-time version pins, when present, must match the selected bundling +/// implementation's checksum format. /// When absent, build.rs falls through to `../nodejs/package-lock.json` — /// both are accepted, this test only checks the pin file's format if it's /// there. #[test] fn pin_file_when_present_is_well_formed() { let manifest_dir = env!("CARGO_MANIFEST_DIR"); - let pin = PathBuf::from(manifest_dir).join("cli-version.txt"); + let (filename, value_prefix) = if cfg!(feature = "bundled-in-process") { + ("cli-version-in-process.txt", Some("sha512-")) + } else { + ("cli-version.txt", None) + }; + let pin = PathBuf::from(manifest_dir).join(filename); if !pin.is_file() { // Contributor build path — no assertion needed. return; } - let contents = std::fs::read_to_string(&pin).expect("read cli-version.txt"); + let contents = std::fs::read_to_string(&pin).expect("read CLI version snapshot"); let mut saw_version = false; + let mut package_count = 0; for raw in contents.lines() { let line = raw.trim(); if line.is_empty() || line.starts_with('#') { @@ -222,9 +228,28 @@ fn pin_file_when_present_is_well_formed() { assert!(!value.trim().is_empty(), "empty value for key {key:?}"); if key.trim() == "version" { saw_version = true; + } else { + if let Some(prefix) = value_prefix { + assert!( + value.trim().starts_with(prefix), + "invalid npm integrity for key {key:?}" + ); + } else { + assert_eq!( + value.trim().len(), + 64, + "invalid SHA-256 hash for key {key:?}" + ); + assert!( + value.trim().bytes().all(|byte| byte.is_ascii_hexdigit()), + "invalid SHA-256 hash for key {key:?}" + ); + } + package_count += 1; } } - assert!(saw_version, "cli-version.txt missing `version=` line"); + assert!(saw_version, "{filename} missing `version=` line"); + assert_eq!(package_count, 6); } /// With `bundled-cli` on AND a supported target, `install_bundled_cli` @@ -246,6 +271,26 @@ fn install_bundled_cli_returns_extracted_path() { first, second, "install_bundled_cli must be idempotent across calls" ); + + #[cfg(feature = "bundled-in-process")] + { + let runtime_name = if cfg!(windows) { + "copilot_runtime.dll" + } else if cfg!(target_os = "macos") { + "libcopilot_runtime.dylib" + } else { + "libcopilot_runtime.so" + }; + let runtime = first + .parent() + .expect("install directory") + .join(runtime_name); + assert!( + runtime.is_file(), + "bundled runtime library was not installed: {}", + runtime.display() + ); + } } /// `install_bundled_cli` returns the same path the runtime resolver diff --git a/rust/tests/e2e.rs b/rust/tests/e2e.rs index b24a647cd..03723dfb1 100644 --- a/rust/tests/e2e.rs +++ b/rust/tests/e2e.rs @@ -7,6 +7,8 @@ mod abort; mod ask_user; #[path = "e2e/builtin_tools.rs"] mod builtin_tools; +#[path = "e2e/byok_bearer_token_provider.rs"] +mod byok_bearer_token_provider; #[path = "e2e/canvas.rs"] mod canvas; #[path = "e2e/client.rs"] @@ -21,18 +23,27 @@ mod client_options; mod commands; #[path = "e2e/compaction.rs"] mod compaction; +#[path = "e2e/copilot_request_handler.rs"] +mod copilot_request_handler; #[path = "e2e/elicitation.rs"] mod elicitation; #[path = "e2e/error_resilience.rs"] mod error_resilience; #[path = "e2e/event_fidelity.rs"] mod event_fidelity; +#[path = "e2e/github_telemetry.rs"] +mod github_telemetry; #[path = "e2e/hooks.rs"] mod hooks; #[path = "e2e/hooks_extended.rs"] mod hooks_extended; +#[cfg(feature = "bundled-in-process")] +#[path = "e2e/inprocess.rs"] +mod inprocess; #[path = "e2e/mcp_and_agents.rs"] mod mcp_and_agents; +#[path = "e2e/mcp_oauth.rs"] +mod mcp_oauth; #[path = "e2e/mode_empty.rs"] mod mode_empty; #[path = "e2e/mode_handlers.rs"] @@ -41,6 +52,8 @@ mod mode_handlers; mod multi_client; #[path = "e2e/multi_client_commands_elicitation.rs"] mod multi_client_commands_elicitation; +#[path = "e2e/multi_provider_registry.rs"] +mod multi_provider_registry; #[path = "e2e/multi_turn.rs"] mod multi_turn; #[path = "e2e/pending_work_resume.rs"] @@ -51,6 +64,10 @@ mod per_session_auth; mod permissions; #[path = "e2e/pre_mcp_tool_call_hook.rs"] mod pre_mcp_tool_call_hook; +#[path = "e2e/provider_endpoint.rs"] +mod provider_endpoint; +#[path = "e2e/rewind.rs"] +mod rewind; #[path = "e2e/rpc_additional_edge_cases.rs"] mod rpc_additional_edge_cases; #[path = "e2e/rpc_agent.rs"] @@ -63,6 +80,8 @@ mod rpc_event_side_effects; mod rpc_mcp_and_skills; #[path = "e2e/rpc_mcp_config.rs"] mod rpc_mcp_config; +#[path = "e2e/rpc_mcp_lifecycle.rs"] +mod rpc_mcp_lifecycle; #[path = "e2e/rpc_queue.rs"] mod rpc_queue; #[path = "e2e/rpc_remote.rs"] @@ -71,14 +90,26 @@ mod rpc_remote; mod rpc_schedule; #[path = "e2e/rpc_server.rs"] mod rpc_server; +#[path = "e2e/rpc_server_misc.rs"] +mod rpc_server_misc; +#[path = "e2e/rpc_server_plugins.rs"] +mod rpc_server_plugins; +#[path = "e2e/rpc_server_remote_control.rs"] +mod rpc_server_remote_control; #[path = "e2e/rpc_session_state.rs"] mod rpc_session_state; +#[path = "e2e/rpc_session_state_extras.rs"] +mod rpc_session_state_extras; #[path = "e2e/rpc_shell_and_fleet.rs"] mod rpc_shell_and_fleet; #[path = "e2e/rpc_shell_edge_cases.rs"] mod rpc_shell_edge_cases; +#[path = "e2e/rpc_shell_user_requested.rs"] +mod rpc_shell_user_requested; #[path = "e2e/rpc_tasks_and_handlers.rs"] mod rpc_tasks_and_handlers; +#[path = "e2e/rpc_ui_ephemeral_query.rs"] +mod rpc_ui_ephemeral_query; #[path = "e2e/rpc_workspace_checkpoints.rs"] mod rpc_workspace_checkpoints; #[path = "e2e/session.rs"] @@ -91,6 +122,8 @@ mod session_fs; mod session_fs_sqlite; #[path = "e2e/session_lifecycle.rs"] mod session_lifecycle; +#[path = "e2e/session_todos_changed.rs"] +mod session_todos_changed; #[path = "e2e/skills.rs"] mod skills; #[path = "e2e/streaming_fidelity.rs"] @@ -101,6 +134,8 @@ mod subagent_hooks; mod support; #[path = "e2e/suspend.rs"] mod suspend; +#[path = "e2e/system_message_sections.rs"] +mod system_message_sections; #[path = "e2e/system_message_transform.rs"] mod system_message_transform; #[path = "e2e/telemetry.rs"] diff --git a/rust/tests/e2e/abort.rs b/rust/tests/e2e/abort.rs index 33ef835d7..34fc66b60 100644 --- a/rust/tests/e2e/abort.rs +++ b/rust/tests/e2e/abort.rs @@ -1,8 +1,8 @@ use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::session_events::{AssistantMessageDeltaData, SessionEventType}; use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::session_events::{AssistantMessageDeltaData, SessionEventType}; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{Error, SessionConfig, Tool, ToolInvocation, ToolResult}; use serde_json::json; @@ -10,22 +10,24 @@ use tokio::sync::{Mutex, mpsc, oneshot}; use super::support::{ DEFAULT_TEST_TOKEN, assistant_message_content, recv_with_timeout, wait_for_event, - with_e2e_context, }; #[tokio::test] async fn should_abort_during_active_streaming() { - with_e2e_context("abort", "should_abort_during_active_streaming", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config().with_streaming(true)) - .await - .expect("create session"); - let events = session.subscribe(); + super::support::with_dedicated_e2e_context( + "abort", + "should_abort_during_active_streaming", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config().with_streaming(true)) + .await + .expect("create session"); + let events = session.subscribe(); - session + session .send( "Write a very long essay about the history of computing, covering every decade \ from the 1940s to the 2020s in great detail.", @@ -33,41 +35,55 @@ async fn should_abort_during_active_streaming() { .await .expect("send long streaming turn"); - let delta = wait_for_event(events, "assistant.message_delta", |event| { - event.parsed_type() == SessionEventType::AssistantMessageDelta + let delta = wait_for_event(events, "assistant.message_delta", |event| { + event.parsed_type() == SessionEventType::AssistantMessageDelta + }) + .await; + assert!( + !delta + .typed_data::() + .expect("assistant.message_delta data") + .delta_content + .is_empty() + ); + + session.abort().await.expect("abort session"); + + // Session should be usable after abort. Wait for the specific recovery + // message rather than racing against a late idle from the aborted turn. + let recovery_events = session.subscribe(); + session + .send("Say 'abort_recovery_ok'.") + .await + .expect("send recovery"); + let recovery = wait_for_event( + recovery_events, + "assistant.message containing abort_recovery_ok", + |event| { + event.parsed_type() == SessionEventType::AssistantMessage + && assistant_message_content(event) + .to_lowercase() + .contains("abort_recovery_ok") + }, + ) + .await; + assert!( + assistant_message_content(&recovery) + .to_lowercase() + .contains("abort_recovery_ok") + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); }) - .await; - assert!( - !delta - .typed_data::() - .expect("assistant.message_delta data") - .delta_content - .is_empty() - ); - - session.abort().await.expect("abort session"); - - let recovery = session - .send_and_wait("Say 'abort_recovery_ok'.") - .await - .expect("send recovery") - .expect("assistant message"); - assert!( - assistant_message_content(&recovery) - .to_lowercase() - .contains("abort_recovery_ok") - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + }, + ) .await; } #[tokio::test] async fn should_abort_during_active_tool_execution() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "abort", "should_abort_during_active_tool_execution", |ctx| { diff --git a/rust/tests/e2e/ask_user.rs b/rust/tests/e2e/ask_user.rs index 282af7d30..d7d089358 100644 --- a/rust/tests/e2e/ask_user.rs +++ b/rust/tests/e2e/ask_user.rs @@ -1,19 +1,22 @@ use std::sync::Arc; +use std::time::Duration; use async_trait::async_trait; use github_copilot_sdk::handler::{ - PermissionHandler, PermissionResult, UserInputHandler, UserInputResponse, + ApproveAllHandler, PermissionHandler, PermissionResult, UserInputHandler, UserInputResponse, }; -use github_copilot_sdk::{RequestId, SessionConfig, SessionId}; -use tokio::sync::mpsc; - -use super::support::{ - DEFAULT_TEST_TOKEN, assistant_message_content, recv_with_timeout, with_e2e_context, +use github_copilot_sdk::tool::ToolHandler; +use github_copilot_sdk::{ + Error, RequestId, SessionConfig, SessionId, Tool, ToolInvocation, ToolResult, }; +use serde_json::json; +use tokio::sync::{Notify, mpsc}; + +use super::support::{DEFAULT_TEST_TOKEN, assistant_message_content, recv_with_timeout}; #[tokio::test] async fn should_invoke_user_input_handler_when_model_uses_ask_user_tool() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "ask_user", "should_invoke_user_input_handler_when_model_uses_ask_user_tool", |ctx| { @@ -57,7 +60,7 @@ async fn should_invoke_user_input_handler_when_model_uses_ask_user_tool() { #[tokio::test] async fn should_receive_choices_in_user_input_request() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "ask_user", "should_receive_choices_in_user_input_request", |ctx| { @@ -102,7 +105,7 @@ async fn should_receive_choices_in_user_input_request() { #[tokio::test] async fn should_handle_freeform_user_input_response() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "ask_user", "should_handle_freeform_user_input_response", |ctx| { @@ -147,6 +150,78 @@ async fn should_handle_freeform_user_input_response() { .await; } +/// Regression test for the per-session event-loop starvation bug where a pending +/// `ask_user` (`userInput.request`) blocked the `tokio::select!` loop and starved +/// a sibling tool call co-emitted in the same turn (github/copilot-experiences#12540). +/// +/// The model emits both `set_marker` and `ask_user` in one assistant turn. The +/// `set_marker` tool fires a `Notify`; the user-input handler waits on that +/// `Notify` before answering. If `ask_user` were awaited inline, the loop could +/// never dispatch the `set_marker` notification, so the handler would never +/// observe the tool firing. With the handler spawned, both run concurrently and +/// the handler observes the sibling tool while its own request is still pending. +#[tokio::test] +async fn ask_user_does_not_block_sibling_tool_call_in_same_turn() { + super::support::with_shared_e2e_context( + &E2E, + "ask_user", + "ask_user_does_not_block_sibling_tool_call_in_same_turn", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + + // Fired by `set_marker` when the sibling tool executes. + let tool_fired = Arc::new(Notify::new()); + // Reports whether the user-input handler observed the sibling tool + // firing while its own `ask_user` request was still pending. + let (observed_tx, mut observed_rx) = mpsc::unbounded_channel(); + + let user_input_handler = Arc::new(SiblingAwareUserInputHandler { + tool_fired: tool_fired.clone(), + observed_tx, + }); + let tools = vec![set_marker_tool(tool_fired.clone())]; + + let session = client + .create_session( + SessionConfig::default() + .with_github_token(DEFAULT_TEST_TOKEN) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_user_input_handler( + user_input_handler as Arc, + ) + .with_tools(tools), + ) + .await + .expect("create session"); + + session + .send_and_wait( + "Call set_marker with value 'go' and, at the same time, use the ask_user \ + tool to ask me to choose between 'Option A' and 'Option B'. Wait for my \ + answer before continuing.", + ) + .await + .expect("send") + .expect("assistant message"); + + let observed = + recv_with_timeout(&mut observed_rx, "user input handler observation").await; + assert!( + observed, + "ask_user handler must observe the sibling set_marker tool executing while \ + its own userInput.request is still pending (event loop must not be starved)" + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + #[derive(Debug)] struct RecordedUserInputRequest { session_id: SessionId, @@ -204,3 +279,71 @@ impl PermissionHandler for RecordingUserInputHandler { PermissionResult::approve_once() } } + +/// A user-input handler that waits for a sibling tool to fire before answering, +/// then reports whether it observed that tool while its own request was pending. +struct SiblingAwareUserInputHandler { + tool_fired: Arc, + observed_tx: mpsc::UnboundedSender, +} + +#[async_trait] +impl UserInputHandler for SiblingAwareUserInputHandler { + async fn handle( + &self, + _session_id: SessionId, + _question: String, + choices: Option>, + _allow_freeform: Option, + ) -> Option { + // Wait (bounded) for the sibling `set_marker` tool to execute. On the + // buggy inline-await path the event loop is parked here, the tool + // notification is never dispatched, and this times out. + let observed = tokio::time::timeout(Duration::from_secs(30), self.tool_fired.notified()) + .await + .is_ok(); + let _ = self.observed_tx.send(observed); + + let answer = choices + .as_ref() + .and_then(|c| c.first()) + .cloned() + .unwrap_or_else(|| "Option A".to_string()); + Some(UserInputResponse { + answer, + was_freeform: false, + }) + } +} + +struct SetMarkerTool { + tool_fired: Arc, +} + +fn set_marker_tool(tool_fired: Arc) -> Tool { + Tool::new("set_marker") + .with_description("Records a marker value") + .with_parameters(json!({ + "type": "object", + "properties": { + "value": { "type": "string", "description": "Marker value" } + }, + "required": ["value"] + })) + .with_handler(Arc::new(SetMarkerTool { tool_fired })) +} + +#[async_trait] +impl ToolHandler for SetMarkerTool { + async fn call(&self, invocation: ToolInvocation) -> Result { + let value = invocation + .arguments + .get("value") + .and_then(serde_json::Value::as_str) + .unwrap_or_default(); + self.tool_fired.notify_one(); + Ok(ToolResult::Text(format!("MARKER_{}", value.to_uppercase()))) + } +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("ask_user", 4); diff --git a/rust/tests/e2e/builtin_tools.rs b/rust/tests/e2e/builtin_tools.rs index ca80c0774..12bcad4fa 100644 --- a/rust/tests/e2e/builtin_tools.rs +++ b/rust/tests/e2e/builtin_tools.rs @@ -1,8 +1,23 @@ -use super::support::{assistant_message_content, with_e2e_context}; +use std::time::Duration; + +use github_copilot_sdk::MessageOptions; + +use super::support::assistant_message_content; + +/// Built-in tool tests spawn a real CLI subprocess and execute actual shell / +/// file tools. Under concurrent Windows CI load (e2e runs 4-wide on a 4-vCPU +/// runner) this agent loop can briefly exceed the 60s `send_and_wait` default, +/// so give it extra headroom while still failing fast on a genuine hang. +const SEND_TIMEOUT: Duration = Duration::from_secs(120); + +fn message(prompt: &str) -> MessageOptions { + MessageOptions::from(prompt).with_wait_timeout(SEND_TIMEOUT) +} #[tokio::test] async fn should_capture_exit_code_in_output() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "builtin_tools", "should_capture_exit_code_in_output", |ctx| { @@ -15,7 +30,9 @@ async fn should_capture_exit_code_in_output() { .expect("create session"); let msg = session - .send_and_wait("Run 'echo hello && echo world'. Tell me the exact output.") + .send_and_wait(message( + "Run 'echo hello && echo world'. Tell me the exact output.", + )) .await .expect("send") .expect("assistant message"); @@ -33,7 +50,7 @@ async fn should_capture_exit_code_in_output() { #[tokio::test] async fn should_capture_stderr_output() { - with_e2e_context("builtin_tools", "should_capture_stderr_output", |ctx| { + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_capture_stderr_output", |ctx| { Box::pin(async move { if cfg!(windows) { return; @@ -46,7 +63,7 @@ async fn should_capture_stderr_output() { .expect("create session"); let msg = session - .send_and_wait("Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.") + .send_and_wait(message("Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. Reply with just the stderr content.")) .await .expect("send") .expect("assistant message"); @@ -61,7 +78,7 @@ async fn should_capture_stderr_output() { #[tokio::test] async fn should_read_file_with_line_range() { - with_e2e_context("builtin_tools", "should_read_file_with_line_range", |ctx| { + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_read_file_with_line_range", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); std::fs::write(ctx.work_dir().join("lines.txt"), "line1\nline2\nline3\nline4\nline5\n") @@ -73,7 +90,7 @@ async fn should_read_file_with_line_range() { .expect("create session"); let msg = session - .send_and_wait("Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.") + .send_and_wait(message("Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.")) .await .expect("send") .expect("assistant message"); @@ -90,7 +107,7 @@ async fn should_read_file_with_line_range() { #[tokio::test] async fn should_handle_nonexistent_file_gracefully() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_handle_nonexistent_file_gracefully", |ctx| { @@ -103,7 +120,7 @@ async fn should_handle_nonexistent_file_gracefully() { .expect("create session"); let msg = session - .send_and_wait("Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.") + .send_and_wait(message("Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.")) .await .expect("send") .expect("assistant message"); @@ -128,7 +145,7 @@ async fn should_handle_nonexistent_file_gracefully() { #[tokio::test] async fn should_edit_a_file_successfully() { - with_e2e_context("builtin_tools", "should_edit_a_file_successfully", |ctx| { + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_edit_a_file_successfully", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); std::fs::write(ctx.work_dir().join("edit_me.txt"), "Hello World\nGoodbye World\n") @@ -140,7 +157,7 @@ async fn should_edit_a_file_successfully() { .expect("create session"); let msg = session - .send_and_wait("Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.") + .send_and_wait(message("Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.")) .await .expect("send") .expect("assistant message"); @@ -155,7 +172,7 @@ async fn should_edit_a_file_successfully() { #[tokio::test] async fn should_create_a_new_file() { - with_e2e_context("builtin_tools", "should_create_a_new_file", |ctx| { + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_create_a_new_file", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -165,7 +182,7 @@ async fn should_create_a_new_file() { .expect("create session"); let msg = session - .send_and_wait("Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.") + .send_and_wait(message("Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.")) .await .expect("send") .expect("assistant message"); @@ -180,7 +197,7 @@ async fn should_create_a_new_file() { #[tokio::test] async fn should_search_for_patterns_in_files() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_search_for_patterns_in_files", |ctx| { @@ -195,7 +212,7 @@ async fn should_search_for_patterns_in_files() { .expect("create session"); let msg = session - .send_and_wait("Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.") + .send_and_wait(message("Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.")) .await .expect("send") .expect("assistant message"); @@ -213,7 +230,7 @@ async fn should_search_for_patterns_in_files() { #[tokio::test] async fn should_find_files_by_pattern() { - with_e2e_context("builtin_tools", "should_find_files_by_pattern", |ctx| { + super::support::with_shared_e2e_context(&E2E, "builtin_tools", "should_find_files_by_pattern", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let src = ctx.work_dir().join("src"); @@ -228,7 +245,7 @@ async fn should_find_files_by_pattern() { .expect("create session"); let msg = session - .send_and_wait("Find all .ts files in this directory (recursively). List the filenames you found.") + .send_and_wait(message("Find all .ts files in this directory (recursively). List the filenames you found.")) .await .expect("send") .expect("assistant message"); @@ -240,3 +257,5 @@ async fn should_find_files_by_pattern() { }) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("builtin_tools", 8); diff --git a/rust/tests/e2e/byok_bearer_token_provider.rs b/rust/tests/e2e/byok_bearer_token_provider.rs new file mode 100644 index 000000000..a7989d157 --- /dev/null +++ b/rust/tests/e2e/byok_bearer_token_provider.rs @@ -0,0 +1,355 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +use std::sync::Arc; +use std::sync::atomic::{AtomicUsize, Ordering}; + +use async_trait::async_trait; +use bytes::Bytes; +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::{ + BearerTokenError, CopilotHttpRequest, CopilotHttpResponse, CopilotRequestContext, + CopilotRequestError, CopilotRequestHandler, MessageOptions, NamedProviderConfig, + ProviderModelConfig, ProviderTokenArgs, SessionConfig, +}; +use http::HeaderMap; + +use super::support::with_e2e_context_no_snapshot; + +const PRIMARY_BASE_URL: &str = "https://byok-endpoint.invalid/v1"; +const RED_HOST: &str = "byok-red.invalid"; +const RED_BASE_URL: &str = "https://byok-red.invalid/v1"; +const BLUE_HOST: &str = "byok-blue.invalid"; +const BLUE_BASE_URL: &str = "https://byok-blue.invalid/v1"; + +#[derive(Debug, Clone)] +struct CapturedRequest { + host: String, + authorization: Option, +} + +#[derive(Default)] +struct CapturingRequestHandler { + captures: std::sync::Mutex>, +} + +impl CapturingRequestHandler { + fn auth_headers(&self) -> Vec { + self.captures + .lock() + .unwrap() + .iter() + .filter_map(|capture| capture.authorization.clone()) + .collect() + } + + fn auth_header_for_host(&self, host: &str) -> Option { + self.captures + .lock() + .unwrap() + .iter() + .find(|capture| capture.host == host) + .and_then(|capture| capture.authorization.clone()) + } + + fn reset(&self) { + self.captures.lock().unwrap().clear(); + } +} + +#[async_trait] +impl CopilotRequestHandler for CapturingRequestHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + _ctx: &CopilotRequestContext, + ) -> Result { + let uri: http::Uri = request + .url + .parse() + .map_err(|error| CopilotRequestError::message(format!("invalid URL: {error}")))?; + if let Some(host) = uri.host() + && host.ends_with(".invalid") + { + let authorization = request + .headers + .get("authorization") + .and_then(|value| value.to_str().ok()) + .map(str::to_string); + self.captures.lock().unwrap().push(CapturedRequest { + host: host.to_string(), + authorization, + }); + return Ok(json_response( + 404, + br#"{"error":{"message":"fake byok endpoint"}}"#.to_vec(), + )); + } + + Ok(synth_non_inference_response(&request.url)) + } +} + +fn json_response(status: u16, body: Vec) -> CopilotHttpResponse { + let mut headers = HeaderMap::new(); + headers.insert( + "content-type", + http::HeaderValue::from_static("application/json"), + ); + let body = futures_util::stream::iter([Ok::(Bytes::from(body))]); + CopilotHttpResponse::new(status, None, headers, Box::pin(body)) +} + +fn synth_non_inference_response(url: &str) -> CopilotHttpResponse { + let lower = url.to_lowercase(); + if lower.ends_with("/models") { + return json_response( + 200, + br#"{"data":[{"id":"gpt-4o","name":"GPT-4o","object":"model","vendor":"OpenAI","version":"1","preview":false,"model_picker_enabled":true,"capabilities":{"type":"chat","family":"gpt-4o","tokenizer":"o200k_base","limits":{"max_context_window_tokens":128000,"max_output_tokens":4096},"supports":{"streaming":true,"tool_calls":true,"parallel_tool_calls":true}}}]}"# + .to_vec(), + ); + } + if lower.contains("/models/session") { + return json_response(200, b"{}".to_vec()); + } + if lower.contains("/policy") { + return json_response(200, br#"{"state":"enabled"}"#.to_vec()); + } + json_response(200, b"{}".to_vec()) +} + +async fn run_turn( + client: &github_copilot_sdk::Client, + providers: Vec, + models: Vec, + selection_id: &str, + prompt: &str, +) { + let session = client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_model(selection_id) + .with_providers(providers) + .with_models(models), + ) + .await + .expect("create session"); + let _ = session.send_and_wait(MessageOptions::new(prompt)).await; + let _ = session.disconnect().await; +} + +#[tokio::test] +async fn callback_token_is_applied_as_authorization_header() { + // The runtime's LLM inference provider slot is process-global and is never released + // when the registering connection disconnects (runtime `shared_api/llm_inference.rs`). + // Over the in-process transport all clients share this process's runtime, so once a + // BYOK provider is registered here and the client stops, the dangling registration + // routes every later model-inference request (list-models, tool-using turns, hooks, + // …) to the dead connection and hangs them. Registering a BYOK provider in-process + // therefore poisons the shared runtime for the rest of the suite. The BYOK bearer-token + // wiring is covered over stdio (a separate child process per test); the SDK-side + // request/response plumbing is transport-agnostic. + if super::support::skip_inprocess( + "registering a BYOK LLM inference provider is process-global in-process and is never \ + released on disconnect, poisoning later model-inference tests", + ) { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(CapturingRequestHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + handler.reset(); + + let calls = Arc::new(AtomicUsize::new(0)); + let callback_calls = calls.clone(); + let providers = vec![ + NamedProviderConfig::new("mi", PRIMARY_BASE_URL) + .with_provider_type("openai") + .with_wire_api("completions") + .with_bearer_token_provider(Arc::new(move |_args: ProviderTokenArgs| { + let callback_calls = callback_calls.clone(); + async move { + callback_calls.fetch_add(1, Ordering::SeqCst); + Ok::<_, BearerTokenError>("sentinel-bearer-token-abc123".to_string()) + } + })), + ]; + let models = + vec![ProviderModelConfig::new("default", "mi").with_wire_model("byok-gpt-4o")]; + + run_turn(&client, providers, models, "mi/default", "What is 5+5?").await; + + assert!( + calls.load(Ordering::SeqCst) >= 1, + "expected callback to be invoked" + ); + // Validate the captured Authorization header is the final assertion. + assert!( + handler + .auth_headers() + .contains(&"Bearer sentinel-bearer-token-abc123".to_string()), + "expected captured Authorization headers to include the sentinel token, got {:?}", + handler.auth_headers() + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +#[tokio::test] +async fn reacquires_a_fresh_token_for_each_request() { + // The runtime registers the LLM inference provider per connection and, by design, + // never releases the slot on disconnect (runtime `shared_api/llm_inference.rs`). Over + // the in-process transport every client shares this process's runtime, so a second + // provider-registering client is refused ("Another client is already the LLM + // inference provider"). The BYOK bearer-token behavior over the in-process transport + // is covered by `callback_token_is_applied_as_authorization_header`; this scenario's + // provider-dispatch logic is transport-agnostic and is covered over stdio. + if super::support::skip_inprocess( + "llmInference.setProvider is process-global in-process; a second provider client is refused", + ) { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(CapturingRequestHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + handler.reset(); + + let calls = Arc::new(AtomicUsize::new(0)); + let callback_calls = calls.clone(); + let providers = vec![ + NamedProviderConfig::new("mi", PRIMARY_BASE_URL) + .with_provider_type("openai") + .with_wire_api("completions") + .with_bearer_token_provider(Arc::new(move |_args: ProviderTokenArgs| { + let callback_calls = callback_calls.clone(); + async move { + let call = callback_calls.fetch_add(1, Ordering::SeqCst) + 1; + Ok::<_, BearerTokenError>(format!("rotating-token-{call}")) + } + })), + ]; + let models = + vec![ProviderModelConfig::new("default", "mi").with_wire_model("byok-gpt-4o")]; + + run_turn( + &client, + providers.clone(), + models.clone(), + "mi/default", + "What is 1+1?", + ) + .await; + run_turn(&client, providers, models, "mi/default", "What is 2+2?").await; + + let auths = handler.auth_headers(); + assert!( + auths.len() >= 2, + "expected at least 2 captured Authorization headers, got {auths:?}" + ); + assert!( + auths[0].starts_with("Bearer rotating-token-") + && auths[1].starts_with("Bearer rotating-token-"), + "expected rotating-token bearer headers, got {auths:?}" + ); + assert!( + calls.load(Ordering::SeqCst) >= 2, + "expected callback to be invoked at least twice" + ); + // Validate the captured Authorization header is the final assertion. + assert_ne!( + auths[0], auths[1], + "expected distinct tokens per request, both were {:?}", + auths[0] + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +#[tokio::test] +async fn dispatches_token_acquisition_per_provider() { + // See `reacquires_a_fresh_token_for_each_request`: in-process, the process-global LLM + // inference provider registration is not released on disconnect, so this additional + // provider-registering client is refused. The BYOK transport path is covered in-process + // by `callback_token_is_applied_as_authorization_header`; the per-provider dispatch + // logic exercised here is transport-agnostic and covered over stdio. + if super::support::skip_inprocess( + "llmInference.setProvider is process-global in-process; a second provider client is refused", + ) { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(CapturingRequestHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + handler.reset(); + + let acquired_for = Arc::new(std::sync::Mutex::new(Vec::new())); + let make_provider = + |name: &'static str, base_url: &'static str, token: &'static str| { + let acquired_for = acquired_for.clone(); + NamedProviderConfig::new(name, base_url) + .with_provider_type("openai") + .with_wire_api("completions") + .with_bearer_token_provider(Arc::new(move |args: ProviderTokenArgs| { + let acquired_for = acquired_for.clone(); + async move { + assert_eq!(args.provider_name, name); + assert!( + !args.session_id.is_empty(), + "expected a non-empty session id in token args" + ); + acquired_for.lock().unwrap().push(name.to_string()); + Ok::<_, BearerTokenError>(token.to_string()) + } + })) + }; + let providers = vec![ + make_provider("red", RED_BASE_URL, "token-for-red"), + make_provider("blue", BLUE_BASE_URL, "token-for-blue"), + ]; + let models = vec![ + ProviderModelConfig::new("default", "red").with_wire_model("byok-gpt-4o"), + ProviderModelConfig::new("default", "blue").with_wire_model("byok-gpt-4o"), + ]; + + run_turn( + &client, + providers.clone(), + models.clone(), + "red/default", + "What is 3+3?", + ) + .await; + run_turn(&client, providers, models, "blue/default", "What is 4+4?").await; + + let acquired = acquired_for.lock().unwrap().clone(); + assert!(acquired.contains(&"red".to_string())); + assert!(acquired.contains(&"blue".to_string())); + assert_eq!( + handler.auth_header_for_host(RED_HOST).as_deref(), + Some("Bearer token-for-red") + ); + // Validate the captured Authorization header is the final assertion. + assert_eq!( + handler.auth_header_for_host(BLUE_HOST).as_deref(), + Some("Bearer token-for-blue") + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} diff --git a/rust/tests/e2e/canvas.rs b/rust/tests/e2e/canvas.rs index 5cd7abb9f..2418e9e5a 100644 --- a/rust/tests/e2e/canvas.rs +++ b/rust/tests/e2e/canvas.rs @@ -2,7 +2,7 @@ use std::sync::Arc; use async_trait::async_trait; use github_copilot_sdk::canvas::{CanvasDeclaration, CanvasHandler, CanvasResult}; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ CanvasAction, CanvasProviderCloseRequest, CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, CanvasProviderOpenResult, }; @@ -10,8 +10,6 @@ use github_copilot_sdk::types::ExtensionInfo; use parking_lot::Mutex; use serde_json::{Value, json}; -use super::support::with_e2e_context; - struct TestCanvasHandler { open_calls: Mutex>, close_calls: Mutex>, @@ -74,33 +72,38 @@ fn canvas_session_config( #[tokio::test] async fn canvas_list_discovers_declared_canvases() { - with_e2e_context("canvas", "canvas_list_discovers_declared_canvases", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let handler = Arc::new(TestCanvasHandler::new()); - let session = client - .create_session(canvas_session_config(ctx, handler)) - .await - .expect("create session"); - - let result = session.rpc().canvas().list().await.expect("list canvases"); - - assert_eq!(result.canvases.len(), 1); - assert_eq!(result.canvases[0].canvas_id, "counter"); - assert_eq!(result.canvases[0].display_name, "Counter"); - assert_eq!(result.canvases[0].description, "Tracks a counter value."); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "canvas", + "canvas_list_discovers_declared_canvases", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let handler = Arc::new(TestCanvasHandler::new()); + let session = client + .create_session(canvas_session_config(ctx, handler)) + .await + .expect("create session"); + + let result = session.rpc().canvas().list().await.expect("list canvases"); + + assert_eq!(result.canvases.len(), 1); + assert_eq!(result.canvases[0].canvas_id, "counter"); + assert_eq!(result.canvases[0].display_name, "Counter"); + assert_eq!(result.canvases[0].description, "Tracks a counter value."); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn canvas_open_round_trip() { - with_e2e_context("canvas", "canvas_open_round_trip", |ctx| { + super::support::with_shared_e2e_context(&E2E, "canvas", "canvas_open_round_trip", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -116,14 +119,12 @@ async fn canvas_open_round_trip() { let open_result = session .rpc() .canvas() - .open( - github_copilot_sdk::generated::api_types::CanvasOpenRequest { - canvas_id: "counter".to_string(), - instance_id: "counter-1".to_string(), - extension_id: Some(canvas.extension_id.clone()), - input: Some(json!({ "start": 41 })), - }, - ) + .open(github_copilot_sdk::rpc::CanvasOpenRequest { + canvas_id: "counter".to_string(), + instance_id: "counter-1".to_string(), + extension_id: Some(canvas.extension_id.clone()), + input: Some(json!({ "start": 41 })), + }) .await .expect("open canvas"); @@ -160,68 +161,69 @@ async fn canvas_open_round_trip() { #[tokio::test] async fn canvas_invoke_action_round_trip() { - with_e2e_context("canvas", "canvas_invoke_action_round_trip", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let handler = Arc::new(TestCanvasHandler::new()); - let session = client - .create_session(canvas_session_config(ctx, handler.clone())) - .await - .expect("create session"); - - let canvas_list = session.rpc().canvas().list().await.expect("list canvases"); - let canvas = &canvas_list.canvases[0]; - - session - .rpc() - .canvas() - .open( - github_copilot_sdk::generated::api_types::CanvasOpenRequest { + super::support::with_shared_e2e_context( + &E2E, + "canvas", + "canvas_invoke_action_round_trip", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let handler = Arc::new(TestCanvasHandler::new()); + let session = client + .create_session(canvas_session_config(ctx, handler.clone())) + .await + .expect("create session"); + + let canvas_list = session.rpc().canvas().list().await.expect("list canvases"); + let canvas = &canvas_list.canvases[0]; + + session + .rpc() + .canvas() + .open(github_copilot_sdk::rpc::CanvasOpenRequest { canvas_id: "counter".to_string(), instance_id: "counter-2".to_string(), extension_id: Some(canvas.extension_id.clone()), input: Some(json!({})), - }, - ) - .await - .expect("open canvas"); - - let result = session - .rpc() - .canvas() - .action() - .invoke( - github_copilot_sdk::generated::api_types::CanvasActionInvokeRequest { + }) + .await + .expect("open canvas"); + + let result = session + .rpc() + .canvas() + .action() + .invoke(github_copilot_sdk::rpc::CanvasActionInvokeRequest { instance_id: "counter-2".to_string(), action_name: "increment".to_string(), input: Some(json!({ "delta": 1 })), - }, - ) - .await - .expect("invoke action"); - - assert_eq!(result.result, Some(json!({ "newValue": 42 }))); - - { - let actions = handler.action_calls.lock(); - assert_eq!(actions.len(), 1); - assert_eq!(actions[0].canvas_id, "counter"); - assert_eq!(actions[0].instance_id, "counter-2"); - assert_eq!(actions[0].action_name, "increment"); - assert_eq!(actions[0].input, Some(json!({ "delta": 1 }))); - } - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + }) + .await + .expect("invoke action"); + + assert_eq!(result.result, Some(json!({ "newValue": 42 }))); + + { + let actions = handler.action_calls.lock(); + assert_eq!(actions.len(), 1); + assert_eq!(actions[0].canvas_id, "counter"); + assert_eq!(actions[0].instance_id, "counter-2"); + assert_eq!(actions[0].action_name, "increment"); + assert_eq!(actions[0].input, Some(json!({ "delta": 1 }))); + } + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn canvas_close_round_trip() { - with_e2e_context("canvas", "canvas_close_round_trip", |ctx| { + super::support::with_shared_e2e_context(&E2E, "canvas", "canvas_close_round_trip", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -237,14 +239,12 @@ async fn canvas_close_round_trip() { session .rpc() .canvas() - .open( - github_copilot_sdk::generated::api_types::CanvasOpenRequest { - canvas_id: "counter".to_string(), - instance_id: "counter-3".to_string(), - extension_id: Some(canvas.extension_id.clone()), - input: Some(json!({})), - }, - ) + .open(github_copilot_sdk::rpc::CanvasOpenRequest { + canvas_id: "counter".to_string(), + instance_id: "counter-3".to_string(), + extension_id: Some(canvas.extension_id.clone()), + input: Some(json!({})), + }) .await .expect("open canvas"); @@ -253,11 +253,9 @@ async fn canvas_close_round_trip() { session .rpc() .canvas() - .close( - github_copilot_sdk::generated::api_types::CanvasCloseRequest { - instance_id: "counter-3".to_string(), - }, - ) + .close(github_copilot_sdk::rpc::CanvasCloseRequest { + instance_id: "counter-3".to_string(), + }) .await .expect("close canvas"); @@ -282,3 +280,4 @@ async fn canvas_close_round_trip() { }) .await; } +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard("canvas", 4); diff --git a/rust/tests/e2e/client.rs b/rust/tests/e2e/client.rs index 114e828ac..0ac4c9d45 100644 --- a/rust/tests/e2e/client.rs +++ b/rust/tests/e2e/client.rs @@ -6,13 +6,25 @@ use github_copilot_sdk::{ CliProgram, Client, ClientOptions, Error, ListModelsHandler, Model, Transport, }; -use super::support::with_e2e_context; +use super::support::{is_inprocess_default, with_e2e_context}; #[tokio::test] async fn should_start_ping_and_stop_stdio_client() { with_e2e_context("client", "should_start_ping_and_stop_stdio_client", |ctx| { Box::pin(async move { let client = ctx.start_client().await; + let timings = client.startup_timings().expect("startup timings"); + if is_inprocess_default() { + assert!(timings.program_resolve_ms.is_some()); + assert!(timings.process_spawn_ms.is_none()); + } else { + assert!(timings.program_resolve_ms.is_none()); + assert!(timings.process_spawn_ms.is_some()); + } + assert!(timings.port_wait_ms.is_none()); + assert!(timings.total_ms >= timings.transport_setup_ms); + assert!(timings.total_ms >= timings.handshake_ms); + let response = client.ping(Some("hello from rust")).await.expect("ping"); assert_eq!(response.message, "pong: hello from rust"); assert!(!response.timestamp.is_empty()); @@ -33,6 +45,13 @@ async fn should_start_ping_and_stop_tcp_client() { })) .await .expect("start TCP client"); + let timings = client.startup_timings().expect("startup timings"); + assert_eq!(timings.program_resolve_ms.is_some(), is_inprocess_default()); + assert!(timings.process_spawn_ms.is_some()); + assert!(timings.port_wait_ms.is_some()); + assert!(timings.total_ms >= timings.transport_setup_ms); + assert!(timings.total_ms >= timings.handshake_ms); + let response = client.ping(Some("tcp hello")).await.expect("ping"); assert_eq!(response.message, "pong: tcp hello"); @@ -64,8 +83,7 @@ async fn should_get_authenticated_status() { Box::pin(async move { ctx.set_default_copilot_user(); let client = Client::start( - ctx.client_options() - .with_github_token(super::support::DEFAULT_TEST_TOKEN), + ctx.client_options_with_github_token(super::support::DEFAULT_TEST_TOKEN), ) .await .expect("start client"); @@ -85,8 +103,7 @@ async fn should_list_models_when_authenticated() { Box::pin(async move { ctx.set_default_copilot_user(); let client = Client::start( - ctx.client_options() - .with_github_token(super::support::DEFAULT_TEST_TOKEN), + ctx.client_options_with_github_token(super::support::DEFAULT_TEST_TOKEN), ) .await .expect("start client"); diff --git a/rust/tests/e2e/client_api.rs b/rust/tests/e2e/client_api.rs index 951fe8720..35cdf6f28 100644 --- a/rust/tests/e2e/client_api.rs +++ b/rust/tests/e2e/client_api.rs @@ -1,41 +1,47 @@ use github_copilot_sdk::SessionId; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn should_delete_session_by_id() { - with_e2e_context("client_api", "should_delete_session_by_id", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let session_id = session.id().clone(); - - session.send_and_wait("Say OK.").await.expect("send"); - session.disconnect().await.expect("disconnect session"); - client - .delete_session(&session_id) - .await - .expect("delete session"); - - let metadata = client - .get_session_metadata(&session_id) - .await - .expect("get metadata"); - assert!(metadata.is_none()); - - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "client_api", + "should_delete_session_by_id", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let session_id = session.id().clone(); + + session.send_and_wait("Say OK.").await.expect("send"); + session.disconnect().await.expect("disconnect session"); + client + .delete_session(&session_id) + .await + .expect("delete session"); + + let metadata = client + .get_session_metadata(&session_id) + .await + .expect("get metadata"); + assert!(metadata.is_none()); + + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_report_error_when_deleting_unknown_session_id() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "client_api", "should_report_error_when_deleting_unknown_session_id", |ctx| { @@ -62,7 +68,7 @@ async fn should_report_error_when_deleting_unknown_session_id() { #[tokio::test] async fn should_get_null_last_session_id_before_any_sessions_exist() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "client_api", "should_get_null_last_session_id_before_any_sessions_exist", |ctx| { @@ -81,7 +87,8 @@ async fn should_get_null_last_session_id_before_any_sessions_exist() { #[tokio::test] async fn should_track_last_session_id_after_session_created() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "client_api", "should_track_last_session_id_after_session_created", |ctx| { @@ -122,7 +129,8 @@ async fn should_track_last_session_id_after_session_created() { #[tokio::test] async fn should_get_null_foreground_session_id_in_headless_mode() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "client_api", "should_get_null_foreground_session_id_in_headless_mode", |ctx| { @@ -144,7 +152,8 @@ async fn should_get_null_foreground_session_id_in_headless_mode() { #[tokio::test] async fn should_report_error_when_setting_foreground_session_in_headless_mode() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "client_api", "should_report_error_when_setting_foreground_session_in_headless_mode", |ctx| { @@ -175,3 +184,5 @@ async fn should_report_error_when_setting_foreground_session_in_headless_mode() ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("client_api", 5); diff --git a/rust/tests/e2e/client_options.rs b/rust/tests/e2e/client_options.rs index 8b1378917..fc1ceebb8 100644 --- a/rust/tests/e2e/client_options.rs +++ b/rust/tests/e2e/client_options.rs @@ -1 +1,501 @@ +use std::collections::HashMap; +use std::path::PathBuf; +use github_copilot_sdk::canvas::CanvasDeclaration; +use github_copilot_sdk::rpc::{OpenCanvasInstance, RemoteSessionMode}; +use github_copilot_sdk::session_events::{ReasoningSummary, SessionLimitsConfig}; +use github_copilot_sdk::{ + CliProgram, Client, ClientOptions, CopilotExpAssignmentResponse, ExtensionInfo, ProviderConfig, + ResumeSessionConfig, SessionConfig, SessionId, Transport, +}; +use serde::Deserialize; +use serde_json::{Value, json}; +use tempfile::TempDir; + +#[tokio::test] +async fn should_forward_advanced_session_creation_options_to_the_cli() { + let fake = FakeCli::new(); + let client = Client::start(fake.client_options("advanced-create-client-token")) + .await + .expect("start fake CLI client"); + + let config_dir = fake.path("config"); + let working_dir = fake.path("workspace"); + let extension_sdk_path = fake.path("extension-sdk"); + let session = client + .create_session( + SessionConfig::default() + .with_session_id("advanced-session-id") + .with_client_name("rust-sdk-e2e-client") + .with_model("claude-sonnet-4.5") + .with_reasoning_effort("low") + .with_reasoning_summary(ReasoningSummary::None) + .with_context_tier("long_context") + .with_config_directory(config_dir.clone()) + .with_enable_config_discovery(true) + .with_skip_embedding_retrieval(true) + .with_embedding_cache_storage("in-memory") + .with_organization_custom_instructions("organization guidance") + .with_enable_on_demand_instruction_discovery(true) + .with_enable_file_hooks(false) + .with_enable_host_git_operations(false) + .with_enable_session_store(false) + .with_enable_skills(false) + .with_working_directory(working_dir.clone()) + .with_streaming(true) + .with_include_sub_agent_streaming_events(false) + .with_available_tools(["read_file"]) + .with_excluded_tools(["bash"]) + .with_excluded_builtin_agents(["legacy-agent"]) + .with_enable_session_telemetry(false) + .with_enable_citations(true) + .with_session_limits(SessionLimitsConfig { + max_ai_credits: Some(42.0), + }) + .with_skip_custom_instructions(true) + .with_custom_agents_local_only(true) + .with_coauthor_enabled(false) + .with_manage_schedule_enabled(false) + .with_github_token("advanced-create-session-token") + .with_remote_session(RemoteSessionMode::Export) + .with_skill_directories([PathBuf::from("skills")]) + .with_plugin_directories([PathBuf::from("plugins")]) + .with_instruction_directories([PathBuf::from("instructions")]) + .with_disabled_skills(["disabled-skill"]) + .with_enable_mcp_apps(true) + .with_canvases([CanvasDeclaration::new( + "canvas", + "Canvas", + "Canvas description", + )]) + .with_request_canvas_renderer(true) + .with_request_extensions(true) + .with_extension_sdk_path(path_string(&extension_sdk_path)) + .with_extension_info(ExtensionInfo::new("github-app", "rust-e2e-extension")) + .with_exp_assignments(CopilotExpAssignmentResponse { + flights: HashMap::from([("feature".to_string(), "enabled".to_string())]), + assignment_context: "ctx".to_string(), + ..Default::default() + }), + ) + .await + .expect("create session"); + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + + let create = fake.captured_request("session.create"); + let params = create.params.as_object().expect("session.create params"); + assert_json_values( + params, + [ + ("sessionId", json!("advanced-session-id")), + ("clientName", json!("rust-sdk-e2e-client")), + ("model", json!("claude-sonnet-4.5")), + ("reasoningEffort", json!("low")), + ("reasoningSummary", json!("none")), + ("contextTier", json!("long_context")), + ("configDir", json!(path_string(&config_dir))), + ("enableConfigDiscovery", json!(true)), + ("skipEmbeddingRetrieval", json!(true)), + ("embeddingCacheStorage", json!("in-memory")), + ( + "organizationCustomInstructions", + json!("organization guidance"), + ), + ("enableOnDemandInstructionDiscovery", json!(true)), + ("enableFileHooks", json!(false)), + ("enableHostGitOperations", json!(false)), + ("enableSessionStore", json!(false)), + ("enableSkills", json!(false)), + ("workingDirectory", json!(path_string(&working_dir))), + ("streaming", json!(true)), + ("includeSubAgentStreamingEvents", json!(false)), + ("enableSessionTelemetry", json!(false)), + ("enableCitations", json!(true)), + ("gitHubToken", json!("advanced-create-session-token")), + ("remoteSession", json!("export")), + ("requestMcpApps", json!(true)), + ("requestCanvasRenderer", json!(true)), + ("requestExtensions", json!(true)), + ("extensionSdkPath", json!(path_string(&extension_sdk_path))), + ("envValueMode", json!("direct")), + ], + ); + assert_eq!(params["availableTools"], json!(["read_file"])); + assert_eq!(params["excludedTools"], json!(["bash"])); + assert_eq!(params["excludedBuiltinAgents"], json!(["legacy-agent"])); + assert_eq!(params["skillDirectories"], json!(["skills"])); + assert_eq!(params["pluginDirectories"], json!(["plugins"])); + assert_eq!(params["instructionDirectories"], json!(["instructions"])); + assert_eq!(params["disabledSkills"], json!(["disabled-skill"])); + assert_eq!(params["sessionLimits"]["maxAiCredits"], json!(42)); + assert_eq!( + params["extensionInfo"], + json!({ "source": "github-app", "name": "rust-e2e-extension" }) + ); + assert_eq!(params["canvases"][0]["id"], json!("canvas")); + assert_eq!(params["canvases"][0]["displayName"], json!("Canvas")); + assert_eq!( + params["canvases"][0]["description"], + json!("Canvas description") + ); + assert_eq!( + params["expAssignments"]["Flights"]["feature"], + json!("enabled") + ); + + let update = fake.captured_request("session.options.update"); + let update_params = update.params.as_object().expect("options update params"); + assert_json_values( + update_params, + [ + ("sessionId", json!("advanced-session-id")), + ("skipCustomInstructions", json!(true)), + ("customAgentsLocalOnly", json!(true)), + ("coauthorEnabled", json!(false)), + ("manageScheduleEnabled", json!(false)), + ], + ); +} + +#[tokio::test] +async fn should_forward_singular_provider_configuration_on_session_creation() { + let fake = FakeCli::new(); + let client = Client::start(fake.client_options("provider-client-token")) + .await + .expect("start fake CLI client"); + + let session = client + .create_session( + SessionConfig::default().with_provider( + ProviderConfig::new("https://models.example.test/v1") + .with_provider_type("openai") + .with_wire_api("responses") + .with_transport("websockets") + .with_api_key("provider-key") + .with_model_id("base-model") + .with_wire_model("wire-model") + .with_max_prompt_tokens(1000) + .with_max_output_tokens(2000) + .with_headers(HashMap::from([( + "x-provider".to_string(), + "rust".to_string(), + )])), + ), + ) + .await + .expect("create session"); + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + + let create = fake.captured_request("session.create"); + let provider = create.params["provider"] + .as_object() + .expect("provider params"); + assert_json_values( + provider, + [ + ("type", json!("openai")), + ("wireApi", json!("responses")), + ("transport", json!("websockets")), + ("baseUrl", json!("https://models.example.test/v1")), + ("apiKey", json!("provider-key")), + ("modelId", json!("base-model")), + ("wireModel", json!("wire-model")), + ("maxPromptTokens", json!(1000)), + ("maxOutputTokens", json!(2000)), + ], + ); + assert_eq!(provider["headers"]["x-provider"], json!("rust")); +} + +#[tokio::test] +async fn should_forward_advanced_session_resume_options_to_the_cli() { + let fake = FakeCli::new(); + let client = Client::start(fake.client_options("advanced-resume-client-token")) + .await + .expect("start fake CLI client"); + + let config_dir = fake.path("resume-config"); + let working_dir = fake.path("resume-workspace"); + let extension_sdk_path = fake.path("resume-extension-sdk"); + let session = client + .resume_session( + ResumeSessionConfig::new(SessionId::from("resume-session-id")) + .with_model("gpt-5-mini") + .with_reasoning_effort("low") + .with_reasoning_summary(ReasoningSummary::None) + .with_context_tier("long_context") + .with_working_directory(working_dir.clone()) + .with_config_directory(config_dir.clone()) + .with_enable_config_discovery(false) + .with_suppress_resume_event(true) + .with_continue_pending_work(false) + .with_streaming(true) + .with_include_sub_agent_streaming_events(false) + .with_github_token("advanced-resume-session-token") + .with_canvases([CanvasDeclaration::new( + "resume-canvas", + "Resume Canvas", + "Resume canvas description", + )]) + .with_open_canvases([OpenCanvasInstance { + canvas_id: "resume-canvas".to_string(), + extension_id: "github-app/rust-e2e-extension".to_string(), + extension_name: None, + icon: None, + input: Some(json!({ "value": "from-resume" })), + instance_id: "resume-instance".to_string(), + status: None, + title: None, + url: None, + }]) + .with_request_canvas_renderer(true) + .with_request_extensions(true) + .with_extension_sdk_path(path_string(&extension_sdk_path)) + .with_extension_info(ExtensionInfo::new("github-app", "rust-e2e-extension")) + .with_skip_custom_instructions(true) + .with_custom_agents_local_only(true) + .with_coauthor_enabled(false) + .with_manage_schedule_enabled(false) + .with_exp_assignments(CopilotExpAssignmentResponse { + flights: HashMap::from([("resumeFeature".to_string(), "enabled".to_string())]), + assignment_context: "ctx".to_string(), + ..Default::default() + }), + ) + .await + .expect("resume session"); + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + + let resume = fake.captured_request("session.resume"); + let params = resume.params.as_object().expect("session.resume params"); + assert_json_values( + params, + [ + ("sessionId", json!("resume-session-id")), + ("model", json!("gpt-5-mini")), + ("reasoningEffort", json!("low")), + ("reasoningSummary", json!("none")), + ("contextTier", json!("long_context")), + ("workingDirectory", json!(path_string(&working_dir))), + ("configDir", json!(path_string(&config_dir))), + ("enableConfigDiscovery", json!(false)), + ("disableResume", json!(true)), + ("continuePendingWork", json!(false)), + ("streaming", json!(true)), + ("includeSubAgentStreamingEvents", json!(false)), + ("gitHubToken", json!("advanced-resume-session-token")), + ("requestCanvasRenderer", json!(true)), + ("requestExtensions", json!(true)), + ("extensionSdkPath", json!(path_string(&extension_sdk_path))), + ("envValueMode", json!("direct")), + ], + ); + assert_eq!( + params["openCanvases"][0]["canvasId"], + json!("resume-canvas") + ); + assert_eq!( + params["openCanvases"][0]["extensionId"], + json!("github-app/rust-e2e-extension") + ); + assert_eq!( + params["openCanvases"][0]["instanceId"], + json!("resume-instance") + ); + assert_eq!( + params["extensionInfo"], + json!({ "source": "github-app", "name": "rust-e2e-extension" }) + ); + assert_eq!( + params["expAssignments"]["Flights"]["resumeFeature"], + json!("enabled") + ); + + let update = fake.captured_request("session.options.update"); + let update_params = update.params.as_object().expect("options update params"); + assert_json_values( + update_params, + [ + ("sessionId", json!("resume-session-id")), + ("skipCustomInstructions", json!(true)), + ("customAgentsLocalOnly", json!(true)), + ("coauthorEnabled", json!(false)), + ("manageScheduleEnabled", json!(false)), + ], + ); +} + +struct FakeCli { + _dir: TempDir, + script_path: PathBuf, + capture_path: PathBuf, + work_dir: PathBuf, +} + +impl FakeCli { + fn new() -> Self { + let dir = tempfile::tempdir().expect("create fake CLI temp dir"); + let script_path = dir.path().join("fake-cli.js"); + let capture_path = dir.path().join("fake-cli-capture.json"); + let work_dir = dir.path().join("cwd"); + std::fs::create_dir(&work_dir).expect("create fake CLI cwd"); + std::fs::write(&script_path, FAKE_STDIO_CLI_SCRIPT).expect("write fake CLI script"); + Self { + _dir: dir, + script_path, + capture_path, + work_dir, + } + } + + fn client_options(&self, token: &str) -> ClientOptions { + ClientOptions::new() + .with_program(CliProgram::Path(PathBuf::from("node"))) + .with_prefix_args([self.script_path.as_os_str().to_owned()]) + .with_cwd(&self.work_dir) + .with_extra_args([ + "--capture-file".to_string(), + self.capture_path.to_string_lossy().into_owned(), + ]) + .with_github_token(token) + .with_use_logged_in_user(false) + .with_transport(Transport::Stdio) + } + + fn path(&self, name: &str) -> PathBuf { + let path = self.work_dir.join(name); + std::fs::create_dir_all(&path).expect("create fake CLI test path"); + path + } + + fn captured_request(&self, method: &str) -> CapturedRequest { + let capture = self.capture(); + capture + .requests + .iter() + .find(|request| request.method == method) + .cloned() + .unwrap_or_else(|| panic!("expected {method} request in {capture:?}")) + } + + fn capture(&self) -> CapturedCli { + let text = std::fs::read_to_string(&self.capture_path).expect("read fake CLI capture file"); + serde_json::from_str(&text).expect("parse fake CLI capture file") + } +} + +#[derive(Debug, Deserialize)] +struct CapturedCli { + requests: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +struct CapturedRequest { + method: String, + #[serde(default)] + params: Value, +} + +fn assert_json_values<'a>( + object: &serde_json::Map, + expected: impl IntoIterator, +) { + for (key, expected_value) in expected { + assert_eq!( + object.get(key), + Some(&expected_value), + "unexpected value for key {key} in {object:?}" + ); + } +} + +fn path_string(path: &std::path::Path) -> String { + path.to_string_lossy().into_owned() +} + +const FAKE_STDIO_CLI_SCRIPT: &str = r#" +const fs = require("fs"); + +const captureIndex = process.argv.indexOf("--capture-file"); +const captureFile = captureIndex >= 0 ? process.argv[captureIndex + 1] : undefined; +const requests = []; + +function saveCapture() { + if (!captureFile) { + return; + } + fs.writeFileSync(captureFile, JSON.stringify({ + requests, + args: process.argv.slice(2), + cwd: process.cwd(), + env: { + COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN, + }, + })); +} + +saveCapture(); + +let buffer = Buffer.alloc(0); +process.stdin.on("data", chunk => { + buffer = Buffer.concat([buffer, chunk]); + processBuffer(); +}); +process.stdin.resume(); + +function processBuffer() { + while (true) { + const headerEnd = buffer.indexOf("\r\n\r\n"); + if (headerEnd < 0) return; + const header = buffer.subarray(0, headerEnd).toString("utf8"); + const match = /Content-Length:\s*(\d+)/i.exec(header); + if (!match) throw new Error("Missing Content-Length header"); + const length = Number(match[1]); + const bodyStart = headerEnd + 4; + const bodyEnd = bodyStart + length; + if (buffer.length < bodyEnd) return; + const body = buffer.subarray(bodyStart, bodyEnd).toString("utf8"); + buffer = buffer.subarray(bodyEnd); + handleMessage(JSON.parse(body)); + } +} + +function handleMessage(message) { + if (!Object.prototype.hasOwnProperty.call(message, "id")) { + return; + } + requests.push({ method: message.method, params: message.params }); + saveCapture(); + if (message.method === "connect") { + writeResponse(message.id, { ok: true, protocolVersion: 3, version: "fake" }); + return; + } + if (message.method === "ping") { + writeResponse(message.id, { message: "pong", protocolVersion: 3, timestamp: Date.now() }); + return; + } + if (message.method === "session.create") { + const sessionId = (message.params && message.params.sessionId) || "fake-session"; + writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null }); + return; + } + if (message.method === "session.resume") { + const sessionId = (message.params && message.params.sessionId) || "fake-session"; + writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null, openCanvases: [] }); + return; + } + if (message.method === "session.options.update") { + writeResponse(message.id, { success: true }); + return; + } + writeResponse(message.id, {}); +} + +function writeResponse(id, result) { + const body = JSON.stringify({ jsonrpc: "2.0", id, result }); + process.stdout.write("Content-Length: " + Buffer.byteLength(body, "utf8") + "\r\n\r\n" + body); +} +"#; diff --git a/rust/tests/e2e/commands.rs b/rust/tests/e2e/commands.rs index fccd87bf6..d110d3b35 100644 --- a/rust/tests/e2e/commands.rs +++ b/rust/tests/e2e/commands.rs @@ -1,21 +1,22 @@ use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ CommandsInvokeRequest, CommandsListRequest, CommandsRespondToQueuedCommandRequest, EnqueueCommandParams, ExecuteCommandParams, RegisterEventInterestParams, ReleaseEventInterestParams, SlashCommandInvocationResult, SlashCommandKind, }; -use github_copilot_sdk::generated::session_events::{CommandQueuedData, SessionEventType}; +use github_copilot_sdk::session_events::{CommandQueuedData, SessionEventType}; use github_copilot_sdk::{CommandContext, CommandDefinition, CommandHandler, RequestId}; use serde_json::json; use tokio::sync::mpsc; -use super::support::{recv_with_timeout, wait_for_event, with_e2e_context}; +use super::support::{recv_with_timeout, wait_for_event}; #[tokio::test] async fn session_commands_list_returns_builtins_and_respects_client_command_filter() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "commands", "session_with_commands_creates_successfully", |ctx| { @@ -85,7 +86,8 @@ async fn session_commands_list_returns_builtins_and_respects_client_command_filt #[tokio::test] async fn session_commands_invoke_known_builtin_returns_expected_result() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "commands", "session_with_no_commands_creates_successfully", |ctx| { @@ -129,7 +131,8 @@ async fn session_commands_invoke_known_builtin_returns_expected_result() { #[tokio::test] async fn session_commands_execute_runs_registered_command_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "commands", "session_with_commands_creates_successfully", |ctx| { @@ -175,7 +178,8 @@ async fn session_commands_execute_runs_registered_command_handler() { #[tokio::test] async fn session_commands_enqueue_and_respond_to_queued_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "commands", "session_with_no_commands_creates_successfully", |ctx| { @@ -278,7 +282,7 @@ impl CommandHandler for RecordingCommandHandler { } fn assert_command( - commands: &[github_copilot_sdk::generated::api_types::SlashCommandInfo], + commands: &[github_copilot_sdk::rpc::SlashCommandInfo], name: &str, kind: SlashCommandKind, ) { @@ -289,3 +293,5 @@ fn assert_command( assert_eq!(command.kind, kind); assert!(!command.description.trim().is_empty()); } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("commands", 4); diff --git a/rust/tests/e2e/compaction.rs b/rust/tests/e2e/compaction.rs index 0255ebecf..d56687d5f 100644 --- a/rust/tests/e2e/compaction.rs +++ b/rust/tests/e2e/compaction.rs @@ -1,10 +1,9 @@ -use github_copilot_sdk::generated::api_types::{LogRequest, SessionLogLevel}; - -use super::support::with_e2e_context; +use github_copilot_sdk::rpc::{LogRequest, SessionLogLevel}; #[tokio::test] async fn should_return_empty_handoff_summary_for_fresh_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "compaction", "should_return_empty_handoff_summary_for_fresh_session", |ctx| { @@ -34,7 +33,8 @@ async fn should_return_empty_handoff_summary_for_fresh_session() { #[tokio::test] async fn should_report_noop_when_cancelling_compaction_without_inflight_work() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "compaction", "should_report_noop_when_cancelling_compaction_without_inflight_work", |ctx| { @@ -71,7 +71,8 @@ async fn should_report_noop_when_cancelling_compaction_without_inflight_work() { #[tokio::test] async fn should_summarize_for_handoff_after_non_ephemeral_log_event() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "compaction", "should_summarize_for_handoff_after_non_ephemeral_log_event", |ctx| { @@ -111,3 +112,5 @@ async fn should_summarize_for_handoff_after_non_ephemeral_log_event() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("compaction", 3); diff --git a/rust/tests/e2e/copilot_request_handler.rs b/rust/tests/e2e/copilot_request_handler.rs new file mode 100644 index 000000000..46b4e510c --- /dev/null +++ b/rust/tests/e2e/copilot_request_handler.rs @@ -0,0 +1,867 @@ +//! End-to-end coverage for the Copilot request handler. +//! +//! These tests register a [`CopilotRequestHandler`] that either fabricates +//! well-formed model responses or forwards to a local upstream, then drive a +//! real agent turn and assert the runtime routed its model-layer HTTP/WebSocket +//! traffic through the handler. No recorded CAPI snapshot is used — the handler +//! replaces every outbound model call. +//! +//! Coverage mirrors the consolidated Node e2e set: +//! - `services_http_and_websocket_via_handler` — a single handler forwards both +//! HTTP and WebSocket traffic to local upstreams (streaming round-trip). +//! - `threads_session_id_into_inference` — the runtime threads its session id +//! into inference requests for both CAPI and BYOK sessions. +//! - `surfaces_handler_errors` — a handler that returns `Err` surfaces a +//! transport error rather than hanging the turn. +//! - `observes_runtime_driven_cancel` — a handler that blocks until the consumer +//! aborts observes the runtime-driven cancellation via `ctx.cancel`. + +use std::sync::Arc; +use std::sync::atomic::{AtomicBool, AtomicU32, Ordering}; +use std::time::{Duration, Instant}; + +use async_trait::async_trait; +use bytes::Bytes; +use futures_util::{SinkExt, StreamExt}; +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::session_events::AssistantMessageData; +use github_copilot_sdk::{ + CopilotHttpRequest, CopilotHttpResponse, CopilotRequestContext, CopilotRequestError, + CopilotRequestHandler, CopilotWebSocketForwarder, CopilotWebSocketHandler, + CopilotWebSocketResponse, MessageOptions, ProviderConfig, SessionConfig, SessionEvent, + forward_http, +}; +use http::header::{HeaderName, HeaderValue}; +use http::{HeaderMap, Uri}; +use serde_json::{Value, json}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; +use tokio::net::{TcpListener, TcpStream}; +use tokio_tungstenite::tungstenite::Message; + +use super::support::with_e2e_context_no_snapshot; + +const SYNTHETIC_TEXT: &str = "OK from the synthetic stream."; +const HANDLER_HTTP_TEXT: &str = "OK from synthetic HTTP upstream."; +const HANDLER_WS_TEXT: &str = "OK from synthetic WS upstream."; +const WS_SUPPORTED_ENDPOINTS: &[&str] = &["/responses", "ws:/responses"]; + +fn say_ok() -> MessageOptions { + MessageOptions::new("Say OK.").with_wait_timeout(Duration::from_secs(120)) +} + +fn header_map(pairs: &[(&str, &str)]) -> HeaderMap { + let mut headers = HeaderMap::new(); + for (name, value) in pairs { + headers.insert( + HeaderName::from_bytes(name.as_bytes()).unwrap(), + HeaderValue::from_str(value).unwrap(), + ); + } + headers +} + +fn json_headers() -> HeaderMap { + header_map(&[("content-type", "application/json")]) +} + +fn sse_headers() -> HeaderMap { + header_map(&[("content-type", "text/event-stream")]) +} + +fn assistant_text(event: &Option) -> String { + event + .as_ref() + .and_then(|e| e.typed_data::()) + .map(|data| data.content) + .unwrap_or_default() +} + +fn is_inference_url(url: &str) -> bool { + let url = url.to_lowercase(); + url.ends_with("/chat/completions") + || url.ends_with("/responses") + || url.ends_with("/v1/messages") + || url.ends_with("/messages") +} + +/// Detect `"stream": true` in a request body without depending on exact JSON +/// whitespace. +fn stream_true(body: &[u8]) -> bool { + let text = String::from_utf8_lossy(body); + let compact: String = text.chars().filter(|c| !c.is_whitespace()).collect(); + compact.contains("\"stream\":true") +} + +fn sse(event_type: &str, data: &Value) -> String { + format!( + "event: {event_type}\ndata: {}\n\n", + serde_json::to_string(data).unwrap() + ) +} + +fn model_catalog(supported_endpoints: Option<&[&str]>) -> String { + let mut model = json!({ + "id": "claude-sonnet-4.5", + "name": "Claude Sonnet 4.5", + "object": "model", + "vendor": "Anthropic", + "version": "1", + "preview": false, + "model_picker_enabled": true, + "capabilities": { + "type": "chat", + "family": "claude-sonnet-4.5", + "tokenizer": "o200k_base", + "limits": { + "max_context_window_tokens": 200000, + "max_output_tokens": 8192, + }, + "supports": { + "streaming": true, + "tool_calls": true, + "parallel_tool_calls": true, + "vision": true, + }, + }, + }); + if let Some(endpoints) = supported_endpoints { + model["supported_endpoints"] = json!(endpoints); + } + serde_json::to_string(&json!({ "data": [model] })).unwrap() +} + +/// The ordered `/responses` event objects the runtime's reducer expects. Used +/// raw (one object == one WebSocket message) for the WS path and SSE-framed for +/// the HTTP path. +fn responses_events(text: &str, resp_id: &str) -> Vec { + vec![ + json!({ + "type": "response.created", + "response": { "id": resp_id, "object": "response", "status": "in_progress", "output": [] }, + }), + json!({ + "type": "response.output_item.added", + "output_index": 0, + "item": { "id": "msg_1", "type": "message", "role": "assistant", "content": [] }, + }), + json!({ + "type": "response.content_part.added", + "output_index": 0, + "content_index": 0, + "part": { "type": "output_text", "text": "" }, + }), + json!({ "type": "response.output_text.delta", "output_index": 0, "content_index": 0, "delta": text }), + json!({ "type": "response.output_text.done", "output_index": 0, "content_index": 0, "text": text }), + json!({ + "type": "response.completed", + "response": { + "id": resp_id, + "object": "response", + "status": "completed", + "output": [{ + "id": "msg_1", + "type": "message", + "role": "assistant", + "content": [{ "type": "output_text", "text": text }], + }], + "usage": { "input_tokens": 5, "output_tokens": 7, "total_tokens": 12 }, + }, + }), + ] +} + +/// Build a streaming HTTP response from a sequence of body chunks. +fn http_response(status: u16, headers: HeaderMap, chunks: Vec>) -> CopilotHttpResponse { + let body = futures_util::stream::iter( + chunks + .into_iter() + .map(|chunk| Ok::(Bytes::from(chunk))), + ); + CopilotHttpResponse::new(status, None, headers, Box::pin(body)) +} + +/// Serve the model catalog, model session and policy endpoints with an +/// empty-JSON fallback for anything unrecognised. +fn synth_non_inference_response( + url: &str, + supported_endpoints: Option<&[&str]>, +) -> CopilotHttpResponse { + let lower = url.to_lowercase(); + if lower.ends_with("/models") { + return http_response( + 200, + json_headers(), + vec![model_catalog(supported_endpoints).into_bytes()], + ); + } + if lower.contains("/models/session") { + return http_response(200, HeaderMap::new(), vec![b"{}".to_vec()]); + } + if lower.contains("/policy") { + return http_response( + 200, + HeaderMap::new(), + vec![br#"{"state":"enabled"}"#.to_vec()], + ); + } + http_response(200, json_headers(), vec![b"{}".to_vec()]) +} + +/// Synthesize a well-formed inference response, dispatching by URL and the +/// request body's stream flag exactly as a real reverse proxy would. +fn synth_inference_response(url: &str, body: &[u8], text: &str) -> CopilotHttpResponse { + let wants_stream = stream_true(body); + let lower = url.to_lowercase(); + + if lower.contains("/responses") { + let events = responses_events(text, "resp_stub_1"); + if !wants_stream { + let last = serde_json::to_string(&events[events.len() - 1]["response"]).unwrap(); + return http_response(200, json_headers(), vec![last.into_bytes()]); + } + let chunks = events + .iter() + .map(|event| sse(event["type"].as_str().unwrap(), event).into_bytes()) + .collect(); + return http_response(200, sse_headers(), chunks); + } + + if lower.contains("/chat/completions") && wants_stream { + let base = || { + json!({ + "id": "chatcmpl-stub-1", + "object": "chat.completion.chunk", + "created": 1, + "model": "claude-sonnet-4.5", + }) + }; + let mut c1 = base(); + c1["choices"] = json!([{ "index": 0, "delta": { "role": "assistant", "content": "" }, "finish_reason": null }]); + let mut c2 = base(); + c2["choices"] = + json!([{ "index": 0, "delta": { "content": text }, "finish_reason": null }]); + let mut c3 = base(); + c3["choices"] = json!([{ "index": 0, "delta": {}, "finish_reason": "stop" }]); + c3["usage"] = json!({ "prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12 }); + let mut chunks: Vec> = [c1, c2, c3] + .iter() + .map(|chunk| { + format!("data: {}\n\n", serde_json::to_string(chunk).unwrap()).into_bytes() + }) + .collect(); + chunks.push(b"data: [DONE]\n\n".to_vec()); + return http_response(200, sse_headers(), chunks); + } + + let buffered = json!({ + "id": "chatcmpl-stub-1", + "object": "chat.completion", + "created": 1, + "model": "claude-sonnet-4.5", + "choices": [{ + "index": 0, + "message": { "role": "assistant", "content": text }, + "finish_reason": "stop", + }], + "usage": { "prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12 }, + }); + http_response( + 200, + json_headers(), + vec![serde_json::to_string(&buffered).unwrap().into_bytes()], + ) +} + +async fn wait_for_flag(flag: &AtomicBool, what: &str) { + let deadline = Instant::now() + Duration::from_secs(60); + while !flag.load(Ordering::SeqCst) { + assert!(Instant::now() < deadline, "timed out waiting for {what}"); + tokio::time::sleep(Duration::from_millis(50)).await; + } +} + +async fn session_send(session: &github_copilot_sdk::session::Session) -> Option { + session + .send_and_wait(say_ok()) + .await + .expect("send_and_wait") +} + +// --------------------------------------------------------------------------- +// Scenario 1: handler — one handler forwards both HTTP and WebSocket traffic to +// local upstreams, mutating traffic on the way through. +// --------------------------------------------------------------------------- + +#[derive(Clone, Default)] +struct HandlerCounters { + http_requests: Arc, + http_responses: Arc, + ws_request_messages: Arc, + ws_response_messages: Arc, + upstream_ws_requests: Arc, +} + +struct ForwardingHandler { + http_authority: String, + ws_authority: String, + counters: HandlerCounters, +} + +fn rewrite_authority( + url: &str, + scheme: &str, + authority: &str, +) -> Result { + let uri: Uri = url + .parse() + .map_err(|e| CopilotRequestError::message(format!("invalid url {url}: {e}")))?; + let path_and_query = uri.path_and_query().map(|p| p.as_str()).unwrap_or("/"); + Ok(format!("{scheme}://{authority}{path_and_query}")) +} + +#[async_trait] +impl CopilotRequestHandler for ForwardingHandler { + async fn send_request( + &self, + mut request: CopilotHttpRequest, + _ctx: &CopilotRequestContext, + ) -> Result { + self.counters.http_requests.fetch_add(1, Ordering::SeqCst); + request.url = rewrite_authority(&request.url, "http", &self.http_authority)?; + request + .headers + .insert("x-test-mutated", HeaderValue::from_static("1")); + let mut response = forward_http(request).await?; + self.counters.http_responses.fetch_add(1, Ordering::SeqCst); + response + .headers + .insert("x-test-response-mutated", HeaderValue::from_static("1")); + Ok(response) + } + + async fn open_websocket( + &self, + ctx: &CopilotRequestContext, + response: CopilotWebSocketResponse, + ) -> Result, CopilotRequestError> { + let ws_url = rewrite_authority(&ctx.url, "ws", &self.ws_authority)?; + let request_counter = self.counters.ws_request_messages.clone(); + let response_counter = self.counters.ws_response_messages.clone(); + let handler = CopilotWebSocketForwarder::builder(ws_url, ctx.headers.clone()) + .on_send_request_message(Arc::new(move |message| { + request_counter.fetch_add(1, Ordering::SeqCst); + Some(message) + })) + .on_send_response_message(Arc::new(move |message| { + response_counter.fetch_add(1, Ordering::SeqCst); + Some(message) + })) + .connect(response) + .await?; + Ok(Box::new(handler)) + } +} + +fn find_subsequence(haystack: &[u8], needle: &[u8]) -> Option { + haystack + .windows(needle.len()) + .position(|window| window == needle) +} + +fn route_http_upstream(path: &str) -> (u16, &'static str, String) { + if path.ends_with("/models") { + ( + 200, + "application/json", + model_catalog(Some(WS_SUPPORTED_ENDPOINTS)), + ) + } else if path.ends_with("/models/session") { + (200, "application/json", "{}".to_string()) + } else if path.contains("/policy") { + ( + 200, + "application/json", + r#"{"state":"enabled"}"#.to_string(), + ) + } else if path.ends_with("/responses") { + let mut body = String::new(); + for event in responses_events(HANDLER_HTTP_TEXT, "resp_stub_http") { + body.push_str(&sse(event["type"].as_str().unwrap(), &event)); + } + (200, "text/event-stream", body) + } else { + ( + 404, + "application/json", + r#"{"error":"not_found"}"#.to_string(), + ) + } +} + +async fn serve_http_conn(socket: &mut TcpStream) -> std::io::Result<()> { + let mut buf = Vec::new(); + let mut tmp = [0u8; 4096]; + let header_end = loop { + let n = socket.read(&mut tmp).await?; + if n == 0 { + return Ok(()); + } + buf.extend_from_slice(&tmp[..n]); + if let Some(pos) = find_subsequence(&buf, b"\r\n\r\n") { + break pos + 4; + } + }; + let head = String::from_utf8_lossy(&buf[..header_end]).to_string(); + let content_length = head + .lines() + .find_map(|line| { + let (name, value) = line.split_once(':')?; + if name.trim().eq_ignore_ascii_case("content-length") { + value.trim().parse::().ok() + } else { + None + } + }) + .unwrap_or(0); + let mut remaining = content_length.saturating_sub(buf.len() - header_end); + while remaining > 0 { + let n = socket.read(&mut tmp).await?; + if n == 0 { + break; + } + remaining = remaining.saturating_sub(n); + } + + let request_path = head + .lines() + .next() + .and_then(|line| line.split_whitespace().nth(1)) + .unwrap_or("/") + .split('?') + .next() + .unwrap_or("/") + .to_lowercase(); + let (status, content_type, body) = route_http_upstream(&request_path); + let reason = if status == 200 { "OK" } else { "Not Found" }; + let head = format!( + "HTTP/1.1 {status} {reason}\r\ncontent-type: {content_type}\r\ncontent-length: {}\r\nconnection: close\r\n\r\n", + body.len() + ); + socket.write_all(head.as_bytes()).await?; + socket.write_all(body.as_bytes()).await?; + socket.flush().await?; + let _ = socket.shutdown().await; + Ok(()) +} + +async fn start_http_upstream() -> String { + let listener = TcpListener::bind("127.0.0.1:0").await.unwrap(); + let authority = listener.local_addr().unwrap().to_string(); + tokio::spawn(async move { + while let Ok((mut socket, _)) = listener.accept().await { + tokio::spawn(async move { + let _ = serve_http_conn(&mut socket).await; + }); + } + }); + authority +} + +async fn start_ws_upstream(counters: HandlerCounters) -> String { + let listener = TcpListener::bind("127.0.0.1:0").await.unwrap(); + let authority = listener.local_addr().unwrap().to_string(); + tokio::spawn(async move { + while let Ok((socket, _)) = listener.accept().await { + let counters = counters.clone(); + tokio::spawn(async move { + let ws = match tokio_tungstenite::accept_async(socket).await { + Ok(ws) => ws, + Err(_) => return, + }; + let (mut write, mut read) = ws.split(); + while let Some(Ok(message)) = read.next().await { + match message { + Message::Text(_) | Message::Binary(_) => { + counters.upstream_ws_requests.fetch_add(1, Ordering::SeqCst); + for event in responses_events(HANDLER_WS_TEXT, "resp_stub_ws") { + let raw = serde_json::to_string(&event).unwrap(); + if write.send(Message::Text(raw)).await.is_err() { + return; + } + } + } + Message::Close(_) => break, + _ => {} + } + } + }); + } + }); + authority +} + +#[tokio::test] +async fn services_http_and_websocket_via_handler() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let counters = HandlerCounters::default(); + let http_authority = start_http_upstream().await; + let ws_authority = start_ws_upstream(counters.clone()).await; + + let handler = ForwardingHandler { + http_authority, + ws_authority, + counters: counters.clone(), + }; + let client = ctx + .start_llm_client( + handler, + &[("COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES", "true")], + ) + .await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let result = session + .send_and_wait(say_ok()) + .await + .expect("send_and_wait"); + let _ = session.disconnect().await; + + assert!( + counters.http_requests.load(Ordering::SeqCst) > 0, + "expected the HTTP forwarder to fire" + ); + assert!( + counters.http_responses.load(Ordering::SeqCst) > 0, + "expected the HTTP response mutation to fire" + ); + assert!( + counters.ws_request_messages.load(Ordering::SeqCst) > 0, + "expected runtime → upstream ws messages" + ); + assert!( + counters.ws_response_messages.load(Ordering::SeqCst) > 0, + "expected upstream → runtime ws messages" + ); + assert!( + counters.upstream_ws_requests.load(Ordering::SeqCst) > 0, + "expected the upstream WS to receive request messages" + ); + + // Validate the final assistant response arrived (guards against truncated captures) + let text = assistant_text(&result); + assert!( + text.contains("OK from synthetic") && text.contains("upstream"), + "expected synthetic upstream content in assistant reply, got {text:?}" + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +// --------------------------------------------------------------------------- +// Scenario 2: session id — the runtime threads the session id into CAPI and +// BYOK inference requests serviced entirely by the handler. +// --------------------------------------------------------------------------- + +#[derive(Default)] +struct RecordingHandler { + records: std::sync::Mutex>, +} + +#[derive(Clone)] +struct InterceptedRequest { + url: String, + session_id: Option, + agent_id: Option, + parent_agent_id: Option, + interaction_type: Option, +} + +impl RecordingHandler { + fn inference_records(&self) -> Vec { + self.records + .lock() + .unwrap() + .iter() + .filter(|record| is_inference_url(&record.url)) + .cloned() + .collect() + } +} + +#[async_trait] +impl CopilotRequestHandler for RecordingHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + ctx: &CopilotRequestContext, + ) -> Result { + self.records.lock().unwrap().push(InterceptedRequest { + url: request.url.clone(), + session_id: ctx.session_id.clone(), + agent_id: ctx.agent_id.clone(), + parent_agent_id: ctx.parent_agent_id.clone(), + interaction_type: ctx.interaction_type.clone(), + }); + if is_inference_url(&request.url) { + Ok(synth_inference_response( + &request.url, + &request.body, + SYNTHETIC_TEXT, + )) + } else { + Ok(synth_non_inference_response(&request.url, None)) + } + } +} + +#[tokio::test] +async fn threads_session_id_into_inference() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(RecordingHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + + // CAPI session. + let capi_session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create CAPI session"); + let capi_session_id = capi_session.id().as_str().to_string(); + let result = session_send(&capi_session).await; + let _ = capi_session.disconnect().await; + + let inference = handler.inference_records(); + assert!( + !inference.is_empty(), + "expected at least one intercepted inference request" + ); + for record in &inference { + assert_eq!( + record.session_id.as_deref(), + Some(capi_session_id.as_str()), + "CAPI inference request must carry the session id" + ); + assert_agent_metadata(record); + } + assert!( + assistant_text(&result).contains("OK from the synthetic"), + "expected synthetic content in CAPI reply, got {:?}", + assistant_text(&result) + ); + + // BYOK session. + let before = handler.inference_records().len(); + let byok_config = SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_model("claude-sonnet-4.5") + .with_provider( + ProviderConfig::new("https://byok.invalid/v1") + .with_provider_type("openai") + .with_wire_api("responses") + .with_api_key("byok-secret") + .with_model_id("claude-sonnet-4.5") + .with_wire_model("claude-sonnet-4.5"), + ); + let byok_session = client + .create_session(byok_config) + .await + .expect("create BYOK session"); + let byok_session_id = byok_session.id().as_str().to_string(); + let result = session_send(&byok_session).await; + let _ = byok_session.disconnect().await; + + let inference = handler.inference_records(); + assert!( + inference.len() > before, + "expected at least one intercepted BYOK inference request" + ); + for record in &inference[before..] { + assert_eq!( + record.session_id.as_deref(), + Some(byok_session_id.as_str()), + "BYOK inference request must carry the session id" + ); + assert_agent_metadata(record); + } + assert_ne!( + byok_session_id, capi_session_id, + "expected per-session ids to differ between turns" + ); + assert!( + assistant_text(&result).contains("OK from the synthetic"), + "expected synthetic content in BYOK reply, got {:?}", + assistant_text(&result) + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +fn assert_agent_metadata(record: &InterceptedRequest) { + assert!( + record.agent_id.as_deref().is_some_and(|id| !id.is_empty()), + "inference request must carry an agent id" + ); + if let Some(parent_agent_id) = record.parent_agent_id.as_deref() { + assert!( + !parent_agent_id.is_empty(), + "parent agent id must be non-empty when present" + ); + } + assert!( + record + .interaction_type + .as_deref() + .is_some_and(|kind| !kind.is_empty()), + "inference request must carry an interaction type" + ); +} + +// --------------------------------------------------------------------------- +// Scenario 3a: errors — a handler that returns `Err` on an inference request +// surfaces a transport error rather than hanging the turn. +// --------------------------------------------------------------------------- + +#[derive(Default)] +struct ThrowingHandler { + inference_attempts: AtomicU32, +} + +#[async_trait] +impl CopilotRequestHandler for ThrowingHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + _ctx: &CopilotRequestContext, + ) -> Result { + if !is_inference_url(&request.url) { + return Ok(synth_non_inference_response(&request.url, None)); + } + self.inference_attempts.fetch_add(1, Ordering::SeqCst); + Err(CopilotRequestError::message( + "synthetic-callback-transport-failure", + )) + } +} + +#[tokio::test] +async fn surfaces_handler_errors() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(ThrowingHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + // The handler returns Err from the inference seam; the agent layer + // surfaces it as an error rather than hanging. + let send_result = session.send_and_wait(say_ok()).await; + let _ = session.disconnect().await; + + assert!( + handler.inference_attempts.load(Ordering::SeqCst) > 0, + "expected the inference callback to be reached and raise" + ); + if let Err(err) = send_result { + assert!( + !err.to_string().is_empty(), + "expected a non-empty error string when an error surfaces" + ); + } + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +// --------------------------------------------------------------------------- +// Scenario 3b: runtime-driven cancel — the handler blocks an inference request +// until the consumer aborts the turn; the runtime cancels the in-flight request +// and the handler observes it via `ctx.cancel`. +// --------------------------------------------------------------------------- + +#[derive(Default)] +struct CancellingHandler { + inference_entered: AtomicBool, + saw_abort: AtomicBool, +} + +#[async_trait] +impl CopilotRequestHandler for CancellingHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + ctx: &CopilotRequestContext, + ) -> Result { + if !is_inference_url(&request.url) { + return Ok(synth_non_inference_response(&request.url, None)); + } + + // Inference: never produce a response. Wait for the runtime to cancel + // us, recording the abort, then propagate it as an error. + self.inference_entered.store(true, Ordering::SeqCst); + ctx.cancel.cancelled().await; + self.saw_abort.store(true, Ordering::SeqCst); + Err(CopilotRequestError::message("cancelled by runtime")) + } +} + +#[tokio::test] +async fn observes_runtime_driven_cancel() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = Arc::new(CancellingHandler::default()); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + session.send(say_ok()).await.expect("send"); + wait_for_flag(&handler.inference_entered, "inference entered").await; + session.abort().await.expect("abort"); + wait_for_flag(&handler.saw_abort, "consumer observed cancellation").await; + let _ = session.disconnect().await; + + assert!( + handler.inference_entered.load(Ordering::SeqCst), + "expected the inference callback to be entered" + ); + assert!( + handler.saw_abort.load(Ordering::SeqCst), + "expected the consumer to observe the runtime-driven cancellation" + ); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} diff --git a/rust/tests/e2e/elicitation.rs b/rust/tests/e2e/elicitation.rs index 5575e67f3..31da30adb 100644 --- a/rust/tests/e2e/elicitation.rs +++ b/rust/tests/e2e/elicitation.rs @@ -10,11 +10,12 @@ use github_copilot_sdk::{ use serde_json::json; use tokio::sync::Mutex; -use super::support::{DEFAULT_TEST_TOKEN, assert_uuid_like, with_e2e_context}; +use super::support::{DEFAULT_TEST_TOKEN, assert_uuid_like}; #[tokio::test] async fn defaults_capabilities_when_not_provided() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "defaults_capabilities_when_not_provided", |ctx| { @@ -39,7 +40,8 @@ async fn defaults_capabilities_when_not_provided() { #[tokio::test] async fn elicitation_throws_when_capability_is_missing() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "elicitation_throws_when_capability_is_missing", |ctx| { @@ -83,7 +85,8 @@ async fn elicitation_throws_when_capability_is_missing() { #[tokio::test] async fn sends_requestelicitation_when_handler_provided() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "sends_requestelicitation_when_handler_provided", |ctx| { @@ -115,7 +118,8 @@ async fn sends_requestelicitation_when_handler_provided() { #[tokio::test] async fn should_report_elicitation_capability_based_on_handler_presence() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "should_report_elicitation_capability_based_on_handler_presence", |ctx| { @@ -161,7 +165,8 @@ async fn should_report_elicitation_capability_based_on_handler_presence() { #[tokio::test] async fn session_without_elicitationhandler_creates_successfully() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "session_without_elicitationhandler_creates_successfully", |ctx| { @@ -185,7 +190,8 @@ async fn session_without_elicitationhandler_creates_successfully() { #[tokio::test] async fn confirm_returns_true_when_handler_accepts() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "confirm_returns_true_when_handler_accepts", |ctx| { @@ -215,7 +221,8 @@ async fn confirm_returns_true_when_handler_accepts() { #[tokio::test] async fn confirm_returns_false_when_handler_declines() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "confirm_returns_false_when_handler_declines", |ctx| { @@ -243,83 +250,94 @@ async fn confirm_returns_false_when_handler_declines() { #[tokio::test] async fn select_returns_selected_option() { - with_e2e_context("elicitation", "select_returns_selected_option", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - SessionConfig::default() - .with_github_token(DEFAULT_TEST_TOKEN) - .pipe_handler(QueuedElicitationHandler::new([accept( - json!({ "selection": "beta" }), - )])), - ) - .await - .expect("create session"); - - assert_eq!( - session - .ui() - .select("Choose", &["alpha", "beta"]) + super::support::with_shared_e2e_context( + &E2E, + "elicitation", + "select_returns_selected_option", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + SessionConfig::default() + .with_github_token(DEFAULT_TEST_TOKEN) + .pipe_handler(QueuedElicitationHandler::new([accept( + json!({ "selection": "beta" }), + )])), + ) .await - .expect("select") - .as_deref(), - Some("beta") - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + .expect("create session"); + + assert_eq!( + session + .ui() + .select("Choose", &["alpha", "beta"]) + .await + .expect("select") + .as_deref(), + Some("beta") + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn input_returns_freeform_value() { - with_e2e_context("elicitation", "input_returns_freeform_value", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - SessionConfig::default() - .with_github_token(DEFAULT_TEST_TOKEN) - .pipe_handler(QueuedElicitationHandler::new([accept( - json!({ "value": "typed value" }), - )])), - ) - .await - .expect("create session"); - let options = UiInputOptions { - title: Some("Value"), - description: Some("A value to test"), - min_length: Some(1), - max_length: Some(20), - default: Some("default"), - ..UiInputOptions::default() - }; - - assert_eq!( - session - .ui() - .input("Enter value", Some(&options)) + super::support::with_shared_e2e_context( + &E2E, + "elicitation", + "input_returns_freeform_value", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + SessionConfig::default() + .with_github_token(DEFAULT_TEST_TOKEN) + .pipe_handler(QueuedElicitationHandler::new([accept( + json!({ "value": "typed value" }), + )])), + ) .await - .expect("input") - .as_deref(), - Some("typed value") - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + .expect("create session"); + let options = UiInputOptions { + title: Some("Value"), + description: Some("A value to test"), + min_length: Some(1), + max_length: Some(20), + default: Some("default"), + ..UiInputOptions::default() + }; + + assert_eq!( + session + .ui() + .input("Enter value", Some(&options)) + .await + .expect("input") + .as_deref(), + Some("typed value") + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn elicitation_returns_all_action_shapes() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "elicitation", "elicitation_returns_all_action_shapes", |ctx| { @@ -606,3 +624,5 @@ fn cancel() -> ElicitationResult { content: None, } } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("elicitation", 10); diff --git a/rust/tests/e2e/event_fidelity.rs b/rust/tests/e2e/event_fidelity.rs index 3f9904425..7176a7e66 100644 --- a/rust/tests/e2e/event_fidelity.rs +++ b/rust/tests/e2e/event_fidelity.rs @@ -1,13 +1,14 @@ -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::session_events::{ AssistantMessageData, AssistantUsageData, SessionEventType, SessionUsageInfoData, ToolExecutionCompleteData, ToolExecutionStartData, UserMessageData, }; -use super::support::{collect_until_idle, event_types, with_e2e_context}; +use super::support::{collect_until_idle, event_types}; #[tokio::test] async fn should_include_valid_fields_on_all_events() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_include_valid_fields_on_all_events", |ctx| { @@ -54,7 +55,8 @@ async fn should_include_valid_fields_on_all_events() { #[tokio::test] async fn should_emit_tool_execution_events_with_correct_fields() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_tool_execution_events_with_correct_fields", |ctx| { @@ -99,7 +101,8 @@ async fn should_emit_tool_execution_events_with_correct_fields() { #[tokio::test] async fn should_emit_assistant_usage_event_after_model_call() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_assistant_usage_event_after_model_call", |ctx| { @@ -136,7 +139,8 @@ async fn should_emit_assistant_usage_event_after_model_call() { #[tokio::test] async fn should_emit_session_usage_info_event_after_model_call() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_session_usage_info_event_after_model_call", |ctx| { @@ -175,7 +179,8 @@ async fn should_emit_session_usage_info_event_after_model_call() { #[tokio::test] async fn should_emit_pending_messages_modified_event_when_message_queue_changes() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_pending_messages_modified_event_when_message_queue_changes", |ctx| { @@ -218,7 +223,8 @@ async fn should_emit_pending_messages_modified_event_when_message_queue_changes( #[tokio::test] async fn should_emit_events_in_correct_order_for_tool_using_conversation() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_events_in_correct_order_for_tool_using_conversation", |ctx| { @@ -265,7 +271,8 @@ async fn should_emit_events_in_correct_order_for_tool_using_conversation() { #[tokio::test] async fn should_emit_assistant_message_with_messageid() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_emit_assistant_message_with_messageid", |ctx| { @@ -299,7 +306,8 @@ async fn should_emit_assistant_message_with_messageid() { #[tokio::test] async fn should_preserve_message_order_in_getmessages_after_tool_use() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "event_fidelity", "should_preserve_message_order_in_getmessages_after_tool_use", |ctx| { @@ -366,3 +374,5 @@ async fn should_preserve_message_order_in_getmessages_after_tool_use() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("event_fidelity", 8); diff --git a/rust/tests/e2e/github_telemetry.rs b/rust/tests/e2e/github_telemetry.rs new file mode 100644 index 000000000..2047ee34f --- /dev/null +++ b/rust/tests/e2e/github_telemetry.rs @@ -0,0 +1,65 @@ +use std::sync::{Arc, Mutex}; +use std::time::Duration; + +use github_copilot_sdk::github_telemetry::GitHubTelemetryNotification; +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::{Client, SessionConfig}; + +use super::support::{DEFAULT_TEST_TOKEN, with_e2e_context_no_snapshot}; + +#[tokio::test] +async fn should_forward_github_telemetry_on_session_create() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + + let notifications = Arc::new(Mutex::new(Vec::::new())); + let collected = notifications.clone(); + let client = Client::start(ctx.client_options().with_on_github_telemetry(move |n| { + collected.lock().unwrap().push(n); + })) + .await + .expect("start client"); + let session = client + .create_session( + SessionConfig::default() + .with_github_token(DEFAULT_TEST_TOKEN) + .with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await + .expect("create session"); + + let deadline = tokio::time::Instant::now() + Duration::from_secs(30); + loop { + if !notifications.lock().unwrap().is_empty() { + break; + } + assert!( + tokio::time::Instant::now() < deadline, + "timed out waiting for github telemetry notification" + ); + tokio::time::sleep(Duration::from_millis(100)).await; + } + + { + let notifications = notifications.lock().unwrap(); + assert!(!notifications.is_empty()); + let first = notifications + .first() + .expect("github telemetry notification"); + assert!( + first + .session_id + .as_deref() + .is_some_and(|session_id| !session_id.is_empty()) + ); + let _: bool = first.restricted; + assert!(!first.event.kind.is_empty()); + } + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }) + .await; +} diff --git a/rust/tests/e2e/hooks.rs b/rust/tests/e2e/hooks.rs index d41dee621..051019073 100644 --- a/rust/tests/e2e/hooks.rs +++ b/rust/tests/e2e/hooks.rs @@ -1,3 +1,4 @@ +use std::collections::HashSet; use std::sync::Arc; use async_trait::async_trait; @@ -6,11 +7,12 @@ use github_copilot_sdk::hooks::{ }; use tokio::sync::mpsc; -use super::support::{recv_with_timeout, with_e2e_context}; +use super::support::recv_with_timeout; #[tokio::test] async fn should_invoke_pretooluse_hook_when_model_runs_a_tool() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks", "should_invoke_pretooluse_hook_when_model_runs_a_tool", |ctx| { @@ -50,7 +52,8 @@ async fn should_invoke_pretooluse_hook_when_model_runs_a_tool() { #[tokio::test] async fn should_invoke_posttooluse_hook_after_model_runs_a_tool() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks", "should_invoke_posttooluse_hook_after_model_runs_a_tool", |ctx| { @@ -91,7 +94,7 @@ async fn should_invoke_posttooluse_hook_after_model_runs_a_tool() { #[tokio::test] async fn should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "hooks", "should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call", |ctx| { @@ -122,7 +125,19 @@ async fn should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_cal let post = recv_with_timeout(&mut post_rx, "postToolUse hook").await; assert_eq!(pre.0, *session.id()); assert_eq!(post.0, *session.id()); - assert_eq!(pre.1, post.1); + + let mut pre_tools: HashSet = HashSet::from([pre.1]); + while let Ok((_, tool_name)) = pre_rx.try_recv() { + pre_tools.insert(tool_name); + } + let mut post_tools: HashSet = HashSet::from([post.1]); + while let Ok((_, tool_name, _)) = post_rx.try_recv() { + post_tools.insert(tool_name); + } + assert!( + pre_tools.intersection(&post_tools).next().is_some(), + "expected a tool to appear in both pre and post hooks, got pre={pre_tools:?} post={post_tools:?}" + ); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -134,7 +149,8 @@ async fn should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_cal #[tokio::test] async fn should_deny_tool_execution_when_pretooluse_returns_deny() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks", "should_deny_tool_execution_when_pretooluse_returns_deny", |ctx| { @@ -213,3 +229,4 @@ impl SessionHooks for RecordingHooks { None } } +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard("hooks", 4); diff --git a/rust/tests/e2e/hooks_extended.rs b/rust/tests/e2e/hooks_extended.rs index d4b6b0a55..dfd77ed7c 100644 --- a/rust/tests/e2e/hooks_extended.rs +++ b/rust/tests/e2e/hooks_extended.rs @@ -1,23 +1,26 @@ use std::sync::Arc; +use std::sync::atomic::{AtomicUsize, Ordering}; use async_trait::async_trait; use github_copilot_sdk::handler::ApproveAllHandler; use github_copilot_sdk::hooks::{ - ErrorOccurredInput, ErrorOccurredOutput, HookContext, PostToolUseFailureInput, - PostToolUseFailureOutput, PostToolUseInput, PostToolUseOutput, PreToolUseInput, - PreToolUseOutput, SessionEndInput, SessionEndOutput, SessionHooks, SessionStartInput, - SessionStartOutput, UserPromptSubmittedInput, UserPromptSubmittedOutput, + AgentStopInput, AgentStopOutput, ErrorOccurredInput, ErrorOccurredOutput, HookContext, + PostToolUseFailureInput, PostToolUseFailureOutput, PostToolUseInput, PostToolUseOutput, + PreToolUseInput, PreToolUseOutput, SessionEndInput, SessionEndOutput, SessionHooks, + SessionStartInput, SessionStartOutput, UserPromptSubmittedInput, UserPromptSubmittedOutput, + UserPromptTransformedInput, UserPromptTransformedOutput, }; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{Error, SessionConfig, Tool, ToolInvocation, ToolResult}; use serde_json::json; use tokio::sync::mpsc; -use super::support::{assistant_message_content, recv_with_timeout, with_e2e_context}; +use super::support::{assistant_message_content, recv_with_timeout}; #[tokio::test] async fn should_invoke_onsessionstart_hook_on_new_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_onsessionstart_hook_on_new_session", |ctx| { @@ -36,7 +39,7 @@ async fn should_invoke_onsessionstart_hook_on_new_session() { session.send_and_wait("Say hi").await.expect("send"); let input = recv_with_timeout(&mut rx, "sessionStart hook").await; assert_eq!(input.source, "new"); - assert!(input.timestamp > 0); + assert!(input.timestamp > 0.0); assert!(!input.working_directory.as_os_str().is_empty()); session.disconnect().await.expect("disconnect session"); @@ -49,7 +52,8 @@ async fn should_invoke_onsessionstart_hook_on_new_session() { #[tokio::test] async fn should_invoke_onuserpromptsubmitted_hook_when_sending_a_message() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_onuserpromptsubmitted_hook_when_sending_a_message", |ctx| { @@ -68,7 +72,7 @@ async fn should_invoke_onuserpromptsubmitted_hook_when_sending_a_message() { session.send_and_wait("Say hello").await.expect("send"); let input = recv_with_timeout(&mut rx, "userPromptSubmitted hook").await; assert!(input.prompt.contains("Say hello")); - assert!(input.timestamp > 0); + assert!(input.timestamp > 0.0); assert!(!input.working_directory.as_os_str().is_empty()); session.disconnect().await.expect("disconnect session"); @@ -81,7 +85,8 @@ async fn should_invoke_onuserpromptsubmitted_hook_when_sending_a_message() { #[tokio::test] async fn should_invoke_onsessionend_hook_when_session_is_disconnected() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_onsessionend_hook_when_session_is_disconnected", |ctx| { @@ -100,7 +105,7 @@ async fn should_invoke_onsessionend_hook_when_session_is_disconnected() { session.send_and_wait("Say hi").await.expect("send"); session.disconnect().await.expect("disconnect session"); let input = recv_with_timeout(&mut rx, "sessionEnd hook").await; - assert!(input.timestamp > 0); + assert!(input.timestamp > 0.0); assert!(!input.working_directory.as_os_str().is_empty()); client.stop().await.expect("stop client"); @@ -112,7 +117,8 @@ async fn should_invoke_onsessionend_hook_when_session_is_disconnected() { #[tokio::test] async fn should_invoke_onerroroccurred_hook_when_error_occurs() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_onerroroccurred_hook_when_error_occurs", |ctx| { @@ -129,7 +135,9 @@ async fn should_invoke_onerroroccurred_hook_when_error_occurs() { .expect("create session"); session.send_and_wait("Say hi").await.expect("send"); - assert!(rx.try_recv().is_err()); + rx.try_recv() + .map(drop) + .expect_err("errorOccurred hook should not run"); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -141,7 +149,8 @@ async fn should_invoke_onerroroccurred_hook_when_error_occurs() { #[tokio::test] async fn should_invoke_userpromptsubmitted_hook_and_modify_prompt() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_invoke_userpromptsubmitted_hook_and_modify_prompt", |ctx| { @@ -181,71 +190,126 @@ async fn should_invoke_userpromptsubmitted_hook_and_modify_prompt() { .await; } +#[tokio::test] +async fn should_invoke_userprompttransformed_hook_and_modify_transformed_prompt() { + super::support::with_shared_e2e_context( + &E2E, + "hooks_extended", + "should_invoke_userprompttransformed_hook_and_modify_transformed_prompt", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let (tx, mut rx) = mpsc::unbounded_channel(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_hooks(Arc::new(UserPromptTransformedHooks { tx })), + ) + .await + .expect("create session"); + + let answer = session + .send_and_wait("Answer the request above.") + .await + .expect("send") + .expect("assistant message"); + let input = recv_with_timeout(&mut rx, "userPromptTransformed hook").await; + assert!(input.prompt.contains("Answer the request above.")); + assert!( + input + .transformed_prompt + .contains("Answer the request above.") + ); + assert!(input.transformed_prompt.contains("")); + assert!(input.timestamp > 0.0); + assert!(!input.working_directory.as_os_str().is_empty()); + assert!(assistant_message_content(&answer).contains("HOOKED_TRANSFORMED_PROMPT")); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + #[tokio::test] async fn should_invoke_sessionstart_hook() { - with_e2e_context("hooks_extended", "should_invoke_sessionstart_hook", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let (tx, mut rx) = mpsc::unbounded_channel(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( - RecordingHooks::session_start( - tx, - Some(SessionStartOutput { - additional_context: Some("Session start hook context.".to_string()), - ..SessionStartOutput::default() - }), - ), - ))) - .await - .expect("create session"); - - session.send_and_wait("Say hi").await.expect("send"); - let input = recv_with_timeout(&mut rx, "sessionStart hook").await; - assert_eq!(input.source, "new"); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "hooks_extended", + "should_invoke_sessionstart_hook", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let (tx, mut rx) = mpsc::unbounded_channel(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( + RecordingHooks::session_start( + tx, + Some(SessionStartOutput { + additional_context: Some("Session start hook context.".to_string()), + ..SessionStartOutput::default() + }), + ), + ))) + .await + .expect("create session"); + + session.send_and_wait("Say hi").await.expect("send"); + let input = recv_with_timeout(&mut rx, "sessionStart hook").await; + assert_eq!(input.source, "new"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_invoke_sessionend_hook() { - with_e2e_context("hooks_extended", "should_invoke_sessionend_hook", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let (tx, mut rx) = mpsc::unbounded_channel(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( - RecordingHooks::session_end( - tx, - Some(SessionEndOutput { - session_summary: Some("session ended".to_string()), - ..SessionEndOutput::default() - }), - ), - ))) - .await - .expect("create session"); - - session.send_and_wait("Say bye").await.expect("send"); - session.disconnect().await.expect("disconnect session"); - let input = recv_with_timeout(&mut rx, "sessionEnd hook").await; - assert!(input.timestamp > 0); - - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "hooks_extended", + "should_invoke_sessionend_hook", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let (tx, mut rx) = mpsc::unbounded_channel(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( + RecordingHooks::session_end( + tx, + Some(SessionEndOutput { + session_summary: Some("session ended".to_string()), + ..SessionEndOutput::default() + }), + ), + ))) + .await + .expect("create session"); + + session.send_and_wait("Say bye").await.expect("send"); + session.disconnect().await.expect("disconnect session"); + let input = recv_with_timeout(&mut rx, "sessionEnd hook").await; + assert!(input.timestamp > 0.0); + + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_register_erroroccurred_hook() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_register_erroroccurred_hook", |ctx| { @@ -267,7 +331,52 @@ async fn should_register_erroroccurred_hook() { .expect("create session"); session.send_and_wait("Say hi").await.expect("send"); - assert!(rx.try_recv().is_err()); + rx.try_recv() + .map(drop) + .expect_err("errorOccurred hook should not run"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_invoke_agentstop_hook_and_apply_block_response() { + super::support::with_shared_e2e_context( + &E2E, + "hooks_extended", + "should_invoke_agentstop_hook_and_apply_block_response", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let (tx, mut rx) = mpsc::unbounded_channel(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( + AgentStopHooks { + tx, + call_count: AtomicUsize::new(0), + }, + ))) + .await + .expect("create session"); + + let answer = session + .send_and_wait("Reply with exactly: AGENT_STOP_INITIAL") + .await + .expect("send") + .expect("assistant message"); + let first = recv_with_timeout(&mut rx, "first agentStop hook").await; + let second = recv_with_timeout(&mut rx, "second agentStop hook").await; + + assert_ne!(first.stop_hook_active, Some(true)); + assert_eq!(second.stop_hook_active, Some(true)); + assert_eq!(first.stop_reason.as_deref(), Some("end_turn")); + assert!(first.transcript_path.is_some()); + assert!(assistant_message_content(&answer).contains("AGENT_STOP_CONTINUED")); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -279,7 +388,8 @@ async fn should_register_erroroccurred_hook() { #[tokio::test] async fn should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput", |ctx| { @@ -322,7 +432,8 @@ async fn should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput() { #[tokio::test] async fn should_allow_posttooluse_to_return_modifiedresult() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "hooks_extended", "should_allow_posttooluse_to_return_modifiedresult", |ctx| { @@ -333,7 +444,6 @@ async fn should_allow_posttooluse_to_return_modifiedresult() { let session = client .create_session( ctx.approve_all_session_config() - .with_available_tools(["report_intent"]) .with_hooks(Arc::new(RecordingHooks::post_tool(tx))), ) .await @@ -341,17 +451,22 @@ async fn should_allow_posttooluse_to_return_modifiedresult() { let answer = session .send_and_wait( - "Call the report_intent tool with intent 'Testing post hook', then reply done.", + "Call the view tool to read the current directory, then reply done.", ) .await .expect("send") .expect("assistant message"); - let mut saw_report_intent = false; + let mut saw_view = false; while let Ok(input) = rx.try_recv() { - saw_report_intent |= input.tool_name == "report_intent"; + saw_view |= input.tool_name == "view"; } - assert!(saw_report_intent, "expected postToolUse hook for report_intent"); - assert_eq!(assistant_message_content(&answer), "Done."); + assert!(saw_view, "expected postToolUse hook for view"); + assert!( + assistant_message_content(&answer) + .to_lowercase() + .contains("done"), + "expected assistant message to contain 'done'" + ); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -362,8 +477,9 @@ async fn should_allow_posttooluse_to_return_modifiedresult() { } #[tokio::test] +#[ignore = "Fails with 1.0.64-0 runtime: built-in tools are not available when hooks restrict availableTools, so the failure path cannot be exercised. Follow up with runtime team."] async fn should_invoke_posttoolusefailure_hook_for_failed_tool_result() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "hooks_extended", "should_invoke_posttoolusefailure_hook_for_failed_tool_result", |ctx| { @@ -392,7 +508,10 @@ async fn should_invoke_posttoolusefailure_hook_for_failed_tool_result() { .expect("assistant message"); let input = recv_with_timeout(&mut failure_rx, "postToolUseFailure hook").await; - assert!(post_rx.try_recv().is_err()); + post_rx + .try_recv() + .map(drop) + .expect_err("postToolUse hook should not run"); assert_eq!(input.tool_name, "view"); assert!(input.error.contains("does not exist")); assert!( @@ -400,7 +519,7 @@ async fn should_invoke_posttoolusefailure_hook_for_failed_tool_result() { .as_str() .is_some_and(|path| path.contains("missing.txt")) ); - assert!(input.timestamp > 0); + assert!(input.timestamp > 0.0); assert!(!input.working_directory.as_os_str().is_empty()); assert!( assistant_message_content(&answer).contains("HOOK_FAILURE_GUIDANCE_APPLIED") @@ -429,6 +548,48 @@ struct RecordingHooks { post_tool_failure: Option>, } +struct AgentStopHooks { + tx: mpsc::UnboundedSender, + call_count: AtomicUsize, +} + +struct UserPromptTransformedHooks { + tx: mpsc::UnboundedSender, +} + +#[async_trait] +impl SessionHooks for UserPromptTransformedHooks { + async fn on_user_prompt_transformed( + &self, + input: UserPromptTransformedInput, + ctx: HookContext, + ) -> Option { + assert!(!ctx.session_id.as_str().is_empty()); + let _ = self.tx.send(input); + Some(UserPromptTransformedOutput { + modified_transformed_prompt: Some( + "Reply with exactly: HOOKED_TRANSFORMED_PROMPT".to_string(), + ), + }) + } +} + +#[async_trait] +impl SessionHooks for AgentStopHooks { + async fn on_agent_stop( + &self, + input: AgentStopInput, + ctx: HookContext, + ) -> Option { + assert!(!ctx.session_id.as_str().is_empty()); + let _ = self.tx.send(input); + (self.call_count.fetch_add(1, Ordering::SeqCst) == 0).then(|| AgentStopOutput { + decision: Some("block".to_string()), + reason: Some("Reply with exactly: AGENT_STOP_CONTINUED".to_string()), + }) + } +} + impl RecordingHooks { fn session_start( tx: mpsc::UnboundedSender, @@ -583,8 +744,8 @@ impl SessionHooks for RecordingHooks { input: PostToolUseInput, _ctx: HookContext, ) -> Option { - let output = (self.post_tool.is_some() && input.tool_name == "report_intent").then(|| { - PostToolUseOutput { + let output = + (self.post_tool.is_some() && input.tool_name == "view").then(|| PostToolUseOutput { modified_result: Some(json!({ "textResultForLlm": "modified by post hook", "resultType": "success", @@ -592,8 +753,7 @@ impl SessionHooks for RecordingHooks { })), suppress_output: Some(false), ..PostToolUseOutput::default() - } - }); + }); if let Some(tx) = &self.post_tool { let _ = tx.send(input); } @@ -644,3 +804,5 @@ impl ToolHandler for EchoValueTool { )) } } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("hooks_extended", 12); diff --git a/rust/tests/e2e/inprocess.rs b/rust/tests/e2e/inprocess.rs new file mode 100644 index 000000000..ead05a0b5 --- /dev/null +++ b/rust/tests/e2e/inprocess.rs @@ -0,0 +1,31 @@ +use super::support::with_e2e_context; + +/// Starts an in-process client, performs a round-trip, and stops cleanly. +/// Fails hard if the in-process runtime library cannot be loaded. +#[tokio::test] +async fn should_start_ping_and_stop_inprocess_client() { + with_e2e_context("client", "should_start_ping_and_stop_stdio_client", |ctx| { + Box::pin(async move { + let client = ctx.start_inprocess_client().await; + let timings = client.startup_timings().expect("startup timings"); + assert!(timings.program_resolve_ms.is_some()); + assert!(timings.process_spawn_ms.is_none()); + assert!(timings.port_wait_ms.is_none()); + assert!(timings.total_ms >= timings.transport_setup_ms); + assert!(timings.total_ms >= timings.handshake_ms); + + let response = client + .ping(Some("hello from rust in-process")) + .await + .expect("ping over in-process FFI transport"); + assert_eq!(response.message, "pong: hello from rust in-process"); + assert!(!response.timestamp.is_empty()); + + let status = client.get_status().await.expect("get status"); + assert!(status.protocol_version > 0); + + client.stop().await.expect("stop in-process client"); + }) + }) + .await; +} diff --git a/rust/tests/e2e/mcp_oauth.rs b/rust/tests/e2e/mcp_oauth.rs new file mode 100644 index 000000000..fb202536c --- /dev/null +++ b/rust/tests/e2e/mcp_oauth.rs @@ -0,0 +1,574 @@ +use std::collections::HashMap; +use std::path::PathBuf; +use std::process::Stdio; +use std::sync::Arc; + +use async_trait::async_trait; +use github_copilot_sdk::handler::{McpAuthHandler, McpAuthRequest, McpAuthResult}; +use github_copilot_sdk::rpc::{McpAppsCallToolRequest, McpListToolsRequest}; +use github_copilot_sdk::session::Session; +use github_copilot_sdk::session_events::{McpOauthRequestReason, McpServerStatus}; +use github_copilot_sdk::{IndexMap, McpHttpServerConfig, McpServerConfig, RequestId, SessionId}; +use parking_lot::Mutex; +use serde::Deserialize; +use serde_json::Value; +use tokio::io::{AsyncBufReadExt, BufReader}; +use tokio::process::{Child, Command}; +use tokio::sync::Notify; + +use super::support::{wait_for_condition, with_e2e_context_no_snapshot}; + +const EXPECTED_TOKEN: &str = "sdk-host-token"; +const REFRESH_TOKEN: &str = "sdk-host-token-refresh"; +const UPSCOPE_TOKEN: &str = "sdk-host-token-upscope"; +const REAUTH_TOKEN: &str = "sdk-host-token-reauth"; + +#[tokio::test] +async fn should_satisfy_mcp_oauth_using_host_provided_token() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut oauth_server = OAuthMcpServer::start( + ctx.repo_root() + .join("test/harness/test-mcp-oauth-server.mjs"), + ) + .await; + let server_name = "oauth-protected-mcp"; + let handler = Arc::new(TokenAuthHandler::default()); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_mcp_auth_handler(handler.clone()) + .with_mcp_servers(IndexMap::from([( + server_name.to_string(), + McpServerConfig::Http(McpHttpServerConfig { + tools: Some(vec!["*".to_string()]), + timeout: None, + url: format!("{}/mcp", oauth_server.url), + headers: HashMap::new(), + }), + )])), + ) + .await + .expect("create session"); + + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await; + let tools = session + .rpc() + .mcp() + .list_tools(McpListToolsRequest { + server_name: server_name.to_string(), + }) + .await + .expect("list MCP tools"); + assert!(tools.tools.iter().any(|tool| tool.name == "whoami")); + + let request = handler + .request + .lock() + .clone() + .expect("MCP auth handler should be invoked"); + assert_eq!(request.server_name, server_name); + assert_eq!(request.server_url, format!("{}/mcp", oauth_server.url)); + assert_eq!(request.reason, McpOauthRequestReason::Initial); + let www_authenticate = request + .www_authenticate_params + .expect("WWW-Authenticate params"); + assert_eq!( + www_authenticate.resource_metadata_url, + Some(format!( + "{}/.well-known/oauth-protected-resource", + oauth_server.url + )) + ); + assert_eq!(www_authenticate.scope.as_deref(), Some("mcp.read")); + assert_eq!(www_authenticate.error.as_deref(), Some("invalid_token")); + let metadata: Value = serde_json::from_str( + request + .resource_metadata + .as_deref() + .expect("resource metadata"), + ) + .expect("parse resource metadata"); + assert_eq!(metadata["resource"], format!("{}/mcp", oauth_server.url)); + + let requests = oauth_server.requests().await; + assert!( + requests + .iter() + .any(|request| request.authorization.is_none()) + ); + assert!(requests.iter().any(|request| { + request.authorization.as_deref() == Some(&format!("Bearer {EXPECTED_TOKEN}")) + })); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + oauth_server.stop().await; + }) + }) + .await; +} + +#[tokio::test] +async fn should_request_replacement_tokens_across_mcp_oauth_lifecycle() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut oauth_server = OAuthMcpServer::start( + ctx.repo_root() + .join("test/harness/test-mcp-oauth-server.mjs"), + ) + .await; + let server_name = "oauth-lifecycle-mcp"; + let handler = Arc::new(LifecycleAuthHandler::default()); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_enable_mcp_apps(true) + .with_mcp_auth_handler(handler.clone()) + .with_mcp_servers(IndexMap::from([( + server_name.to_string(), + McpServerConfig::Http(McpHttpServerConfig { + tools: Some(vec!["*".to_string()]), + timeout: None, + url: format!("{}/mcp", oauth_server.url), + headers: HashMap::new(), + }), + )])), + ) + .await + .expect("create session"); + + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await; + call_whoami(&session, server_name, "refresh").await; + call_whoami(&session, server_name, "upscope").await; + call_whoami(&session, server_name, "reauth").await; + + assert_eq!( + handler.reasons.lock().as_slice(), + [ + McpOauthRequestReason::Initial, + McpOauthRequestReason::Refresh, + McpOauthRequestReason::Upscope, + McpOauthRequestReason::Refresh, + McpOauthRequestReason::Reauth, + ] + ); + + let requests = oauth_server.requests().await; + assert!(requests.iter().any(|request| { + request.authorization.as_deref() == Some(&format!("Bearer {REFRESH_TOKEN}")) + })); + assert!(requests.iter().any(|request| { + request.authorization.as_deref() == Some(&format!("Bearer {UPSCOPE_TOKEN}")) + })); + assert!(requests.iter().any(|request| { + request.authorization.as_deref() == Some(&format!("Bearer {REAUTH_TOKEN}")) + })); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + oauth_server.stop().await; + }) + }) + .await; +} + +#[tokio::test] +async fn should_cancel_pending_mcp_oauth_request() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut oauth_server = OAuthMcpServer::start( + ctx.repo_root() + .join("test/harness/test-mcp-oauth-server.mjs"), + ) + .await; + let server_name = "oauth-cancelled-mcp"; + let handler = Arc::new(CancelAuthHandler::default()); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_mcp_auth_handler(handler.clone()) + .with_mcp_servers(IndexMap::from([( + server_name.to_string(), + McpServerConfig::Http(McpHttpServerConfig { + tools: Some(vec!["*".to_string()]), + timeout: None, + url: format!("{}/mcp", oauth_server.url), + headers: HashMap::new(), + }), + )])), + ) + .await + .expect("create session"); + + wait_for_mcp_server_status(&session, server_name, McpServerStatus::NeedsAuth).await; + + // The MCP connection is kicked off by session.create, but the SDK only registers its + // `mcp.oauth_required` event interest once create returns. If the server's initial 401 + // wins that race, the runtime records `needs-auth` WITHOUT invoking the host callback, + // so `handler.request` is briefly `None` even after `needs-auth` is observed. A later + // auth retry (now that interest is registered) invokes the callback with the same + // `Initial` reason. Wait for the callback rather than sampling it the instant + // `needs-auth` first appears, which is what made this test flaky. + wait_for_condition("MCP OAuth request reaching the host callback", || async { + handler.request.lock().is_some() + }) + .await; + + let request = handler + .request + .lock() + .clone() + .expect("MCP auth handler should be invoked"); + assert_eq!(request.server_name, server_name); + assert_eq!(request.reason, McpOauthRequestReason::Initial); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + oauth_server.stop().await; + }) + }) + .await; +} + +#[tokio::test] +async fn should_resolve_pending_mcp_oauth_request_through_rpc() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut oauth_server = OAuthMcpServer::start( + ctx.repo_root() + .join("test/harness/test-mcp-oauth-server.mjs"), + ) + .await; + let server_name = "oauth-direct-rpc-mcp"; + let observed_request = Arc::new(Mutex::new(None)); + let request_observed = Arc::new(Notify::new()); + let release_handler = Arc::new(Notify::new()); + let handler = Arc::new(BlockingAuthHandler { + request: observed_request.clone(), + request_observed: request_observed.clone(), + release: release_handler.clone(), + }); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_enable_mcp_apps(true) + .with_mcp_auth_handler(handler) + .with_mcp_servers(IndexMap::from([( + server_name.to_string(), + McpServerConfig::Http(McpHttpServerConfig { + tools: Some(vec!["*".to_string()]), + timeout: None, + url: format!("{}/mcp", oauth_server.url), + headers: HashMap::new(), + }), + )])), + ) + .await + .expect("create session"); + + let connected = + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected); + tokio::pin!(connected); + tokio::select! { + () = request_observed.notified() => {} + () = &mut connected => panic!("MCP server connected before OAuth request was observed"), + } + let request = observed_request + .lock() + .clone() + .expect("MCP auth request"); + assert_eq!(request.server_name, server_name); + assert_eq!(request.server_url, format!("{}/mcp", oauth_server.url)); + assert_eq!(request.reason, McpOauthRequestReason::Initial); + let www_authenticate = request + .www_authenticate_params + .as_ref() + .expect("WWW-Authenticate params"); + assert_eq!( + www_authenticate.resource_metadata_url, + Some(format!( + "{}/.well-known/oauth-protected-resource", + oauth_server.url + )) + ); + assert_eq!(www_authenticate.scope.as_deref(), Some("mcp.read")); + assert_eq!(www_authenticate.error.as_deref(), Some("invalid_token")); + + let handled = session + .rpc() + .mcp() + .oauth() + .handle_pending_request(github_copilot_sdk::rpc::McpOauthHandlePendingRequest { + request_id: request.request_id, + result: github_copilot_sdk::rpc::McpOauthPendingRequestResponse::Token( + github_copilot_sdk::rpc::McpOauthPendingRequestResponseToken { + access_token: EXPECTED_TOKEN.to_string(), + expires_in: Some(3600), + kind: github_copilot_sdk::rpc::McpOauthPendingRequestResponseTokenKind::Token, + token_type: Some("Bearer".to_string()), + }, + ), + }) + .await + .expect("handle pending MCP OAuth request"); + assert!(handled.success); + + release_handler.notify_one(); + connected.await; + let tools = session + .rpc() + .mcp() + .list_tools(McpListToolsRequest { + server_name: server_name.to_string(), + }) + .await + .expect("list MCP tools"); + assert!(tools.tools.iter().any(|tool| tool.name == "whoami")); + let requests = oauth_server.requests().await; + assert!( + requests + .iter() + .any(|request| { + request.authorization.as_deref() == Some(&format!("Bearer {EXPECTED_TOKEN}")) + }) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + oauth_server.stop().await; + }) + }) + .await; +} + +#[derive(Default)] +struct TokenAuthHandler { + request: Mutex>, +} + +#[async_trait] +impl McpAuthHandler for TokenAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + request_id: RequestId, + request: McpAuthRequest, + ) -> McpAuthResult { + assert_eq!(request.request_id, request_id); + *self.request.lock() = Some(request); + McpAuthResult::Token { + access_token: EXPECTED_TOKEN.to_string(), + token_type: Some("Bearer".to_string()), + expires_in: Some(3600), + } + } +} + +#[derive(Default)] +struct LifecycleAuthHandler { + reasons: Mutex>, + refresh_count: Mutex, +} + +#[async_trait] +impl McpAuthHandler for LifecycleAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + request_id: RequestId, + request: McpAuthRequest, + ) -> McpAuthResult { + assert_eq!(request.request_id, request_id); + let reason = request.reason.clone(); + self.reasons.lock().push(reason.clone()); + let token = match reason { + McpOauthRequestReason::Refresh => { + let www_authenticate = request + .www_authenticate_params + .as_ref() + .expect("refresh WWW-Authenticate params"); + assert_eq!(www_authenticate.resource_metadata_url, None); + assert_eq!(www_authenticate.error.as_deref(), Some("invalid_token")); + let mut refresh_count = self.refresh_count.lock(); + *refresh_count += 1; + if *refresh_count > 1 { + return McpAuthResult::Cancelled; + } + REFRESH_TOKEN + } + McpOauthRequestReason::Upscope => { + let www_authenticate = request + .www_authenticate_params + .as_ref() + .expect("upscope WWW-Authenticate params"); + assert!( + www_authenticate + .resource_metadata_url + .as_deref() + .is_some_and(|url| url.ends_with("/.well-known/oauth-protected-resource")) + ); + assert_eq!(www_authenticate.scope.as_deref(), Some("mcp.write")); + assert_eq!( + www_authenticate.error.as_deref(), + Some("insufficient_scope") + ); + UPSCOPE_TOKEN + } + McpOauthRequestReason::Reauth => REAUTH_TOKEN, + _ => EXPECTED_TOKEN, + }; + McpAuthResult::Token { + access_token: token.to_string(), + token_type: None, + expires_in: None, + } + } +} + +#[derive(Default)] +struct CancelAuthHandler { + request: Mutex>, +} + +#[async_trait] +impl McpAuthHandler for CancelAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + request_id: RequestId, + request: McpAuthRequest, + ) -> McpAuthResult { + assert_eq!(request.request_id, request_id); + *self.request.lock() = Some(request); + McpAuthResult::Cancelled + } +} + +struct BlockingAuthHandler { + request: Arc>>, + request_observed: Arc, + release: Arc, +} + +#[async_trait] +impl McpAuthHandler for BlockingAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + request_id: RequestId, + request: McpAuthRequest, + ) -> McpAuthResult { + assert_eq!(request.request_id, request_id); + *self.request.lock() = Some(request); + self.request_observed.notify_one(); + self.release.notified().await; + McpAuthResult::Token { + access_token: EXPECTED_TOKEN.to_string(), + token_type: Some("Bearer".to_string()), + expires_in: Some(3600), + } + } +} + +#[derive(Deserialize)] +struct OAuthMcpRequest { + authorization: Option, +} + +struct OAuthMcpServer { + child: Child, + url: String, +} + +impl OAuthMcpServer { + async fn start(script: PathBuf) -> Self { + let mut child = Command::new("node") + .arg(script) + .env("EXPECTED_TOKEN", EXPECTED_TOKEN) + .stdout(Stdio::piped()) + .stderr(Stdio::piped()) + .kill_on_drop(true) + .spawn() + .expect("start OAuth MCP server"); + let stdout = child.stdout.take().expect("OAuth MCP stdout"); + let mut lines = BufReader::new(stdout).lines(); + let line = tokio::time::timeout(std::time::Duration::from_secs(10), lines.next_line()) + .await + .expect("OAuth MCP server startup timeout") + .expect("read OAuth MCP startup line") + .expect("OAuth MCP server stdout closed"); + let url = line + .strip_prefix("Listening: ") + .unwrap_or_else(|| panic!("unexpected OAuth MCP startup line: {line}")) + .to_string(); + Self { child, url } + } + + async fn requests(&self) -> Vec { + let text = reqwest::get(format!("{}/__requests", self.url)) + .await + .expect("fetch OAuth MCP requests") + .error_for_status() + .expect("OAuth MCP request status") + .text() + .await + .expect("read OAuth MCP requests"); + serde_json::from_str(&text).expect("decode OAuth MCP requests") + } + + async fn stop(&mut self) { + let _ = self.child.kill().await; + let _ = self.child.wait().await; + } +} + +async fn wait_for_mcp_server_status( + session: &Session, + server_name: &str, + expected_status: McpServerStatus, +) { + wait_for_condition("MCP server status", || async { + session + .rpc() + .mcp() + .list() + .await + .expect("list MCP servers") + .servers + .iter() + .any(|server| server.name == server_name && server.status == expected_status) + }) + .await; +} + +async fn call_whoami(session: &Session, server_name: &str, scenario: &str) { + let result = session + .rpc() + .mcp() + .apps() + .call_tool(McpAppsCallToolRequest { + arguments: Some(HashMap::from([( + "scenario".to_string(), + serde_json::Value::String(scenario.to_string()), + )])), + origin_server_name: server_name.to_string(), + server_name: server_name.to_string(), + tool_name: "whoami".to_string(), + }) + .await + .expect("call whoami"); + let content = result.get("content").expect("whoami content"); + assert_eq!( + content, + &serde_json::json!([{ "type": "text", "text": "oauth-test-user" }]) + ); +} diff --git a/rust/tests/e2e/mode_empty.rs b/rust/tests/e2e/mode_empty.rs index af1e9267e..2a62d66cf 100644 --- a/rust/tests/e2e/mode_empty.rs +++ b/rust/tests/e2e/mode_empty.rs @@ -12,10 +12,22 @@ use std::sync::Arc; use github_copilot_sdk::handler::ApproveAllHandler; use github_copilot_sdk::types::SystemMessageConfig; -use github_copilot_sdk::{BUILTIN_TOOLS_ISOLATED, Client, ClientMode, SessionConfig, ToolSet}; +use github_copilot_sdk::{BUILTIN_TOOLS_ISOLATED, ClientMode, SessionConfig, ToolSet}; use serde_json::Value; -use super::support::{assistant_message_content, with_e2e_context}; +use super::support::assistant_message_content; + +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::new("mode_empty", empty_shared_client_options, 6); + +fn empty_shared_client_options( + context: &super::support::E2eContext, +) -> github_copilot_sdk::ClientOptions { + context + .client_options() + .with_mode(ClientMode::Empty) + .with_base_directory(context.work_dir().to_path_buf()) +} const SHELL_TOOL_NAME: &str = if cfg!(windows) { "powershell" } else { "bash" }; @@ -85,17 +97,14 @@ fn system_message_from_request(exchange: &Value) -> String { #[tokio::test] async fn empty_mode_isolated_set_shell_tool_is_not_exposed() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_isolated_set_shell_tool_is_not_exposed", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() @@ -135,17 +144,14 @@ async fn empty_mode_isolated_set_shell_tool_is_not_exposed() { #[tokio::test] async fn empty_mode_builtin_star_exposes_all_built_in_tools() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_builtin_star_exposes_all_built_in_tools", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() @@ -175,17 +181,14 @@ async fn empty_mode_builtin_star_exposes_all_built_in_tools() { #[tokio::test] async fn empty_mode_excluded_tools_subtracts_from_available_tools() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_excluded_tools_subtracts_from_available_tools", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() @@ -217,17 +220,14 @@ async fn empty_mode_excluded_tools_subtracts_from_available_tools() { #[tokio::test] async fn empty_mode_strips_environment_context_from_the_system_message_by_default() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_strips_environment_context_from_the_system_message_by_default", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() @@ -274,17 +274,14 @@ async fn empty_mode_strips_environment_context_from_the_system_message_by_defaul #[tokio::test] async fn empty_mode_system_message_replace_llm_follows_caller_content_verbatim() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_system_message_replace_llm_follows_caller_content_verbatim", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() @@ -320,17 +317,14 @@ async fn empty_mode_system_message_replace_llm_follows_caller_content_verbatim() #[tokio::test] async fn empty_mode_append_caller_instruction_takes_effect_and_env_context_stripped() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_empty", "empty_mode_append_caller_instruction_takes_effect_and_env_context_stripped", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let options = ctx - .client_options() - .with_mode(ClientMode::Empty) - .with_base_directory(ctx.work_dir().to_path_buf()); - let client = Client::start(options).await.expect("start client"); + let client = ctx.start_client().await; let session = client .create_session( SessionConfig::default() diff --git a/rust/tests/e2e/mode_handlers.rs b/rust/tests/e2e/mode_handlers.rs index fc451ffb2..7ab6fe5bf 100644 --- a/rust/tests/e2e/mode_handlers.rs +++ b/rust/tests/e2e/mode_handlers.rs @@ -1,23 +1,21 @@ use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::SessionMode; -use github_copilot_sdk::generated::api_types::ModeSetRequest; -use github_copilot_sdk::generated::session_events::{ - AutoModeSwitchCompletedData, AutoModeSwitchRequestedData, - AutoModeSwitchResponse as EventAutoModeSwitchResponse, ExitPlanModeAction, - ExitPlanModeCompletedData, ExitPlanModeRequestedData, SessionEventType, SessionModelChangeData, -}; use github_copilot_sdk::handler::{ AutoModeSwitchHandler, AutoModeSwitchResponse as HandlerAutoModeSwitchResponse, ExitPlanModeHandler, ExitPlanModeResult, }; +use github_copilot_sdk::rpc::ModeSetRequest; +use github_copilot_sdk::session_events::{ + AutoModeSwitchCompletedData, AutoModeSwitchRequestedData, + AutoModeSwitchResponse as EventAutoModeSwitchResponse, ExitPlanModeAction, + ExitPlanModeCompletedData, ExitPlanModeRequestedData, SessionEventType, SessionMode, + SessionModelChangeData, +}; use github_copilot_sdk::{ExitPlanModeData, SessionConfig, SessionId}; use tokio::sync::mpsc; -use super::support::{ - recv_with_timeout, wait_for_event, wait_for_event_allowing_rate_limit, with_e2e_context, -}; +use super::support::{recv_with_timeout, wait_for_event, wait_for_event_allowing_rate_limit}; const MODE_HANDLER_TOKEN: &str = "mode-handler-token"; const PLAN_SUMMARY: &str = "Greeting file implementation plan"; @@ -64,7 +62,8 @@ impl AutoModeSwitchHandler for AutoModeHandler { #[tokio::test] async fn should_invoke_exit_plan_mode_handler_when_model_uses_tool() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_handlers", "should_invoke_exit_plan_mode_handler_when_model_uses_tool", |ctx| { @@ -134,7 +133,7 @@ async fn should_invoke_exit_plan_mode_handler_when_model_uses_tool() { assert_eq!(request.summary, PLAN_SUMMARY); assert_eq!( request.actions, - ["interactive", "autopilot", "exit_only"].map(str::to_string) + ["autopilot", "interactive", "exit_only"].map(str::to_string) ); assert_eq!(request.recommended_action, "interactive"); @@ -146,8 +145,8 @@ async fn should_invoke_exit_plan_mode_handler_when_model_uses_tool() { assert_eq!( requested_data.actions, [ - ExitPlanModeAction::Interactive, ExitPlanModeAction::Autopilot, + ExitPlanModeAction::Interactive, ExitPlanModeAction::ExitOnly, ] ); @@ -181,7 +180,8 @@ async fn should_invoke_exit_plan_mode_handler_when_model_uses_tool() { #[tokio::test] async fn should_invoke_auto_mode_switch_handler_when_rate_limited() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "mode_handlers", "should_invoke_auto_mode_switch_handler_when_rate_limited", |ctx| { @@ -288,3 +288,5 @@ async fn should_invoke_auto_mode_switch_handler_when_rate_limited() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("mode_handlers", 2); diff --git a/rust/tests/e2e/multi_client.rs b/rust/tests/e2e/multi_client.rs index 7566fb063..f6e573e3e 100644 --- a/rust/tests/e2e/multi_client.rs +++ b/rust/tests/e2e/multi_client.rs @@ -3,10 +3,10 @@ use std::sync::Arc; use std::sync::atomic::{AtomicUsize, Ordering}; use async_trait::async_trait; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::handler::{ApproveAllHandler, PermissionHandler, PermissionResult}; +use github_copilot_sdk::session_events::{ PermissionCompletedData, PermissionResult as EventPermissionResult, SessionEventType, }; -use github_copilot_sdk::handler::{ApproveAllHandler, PermissionHandler, PermissionResult}; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{ Client, PermissionRequestData, RequestId, ResumeSessionConfig, SessionConfig, SessionEvent, diff --git a/rust/tests/e2e/multi_client_commands_elicitation.rs b/rust/tests/e2e/multi_client_commands_elicitation.rs index be096bfa6..405d39ef5 100644 --- a/rust/tests/e2e/multi_client_commands_elicitation.rs +++ b/rust/tests/e2e/multi_client_commands_elicitation.rs @@ -2,12 +2,12 @@ use std::net::TcpListener; use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::session_events::{ - CapabilitiesChangedData, CommandsChangedData, SessionEventType, -}; use github_copilot_sdk::handler::{ ApproveAllHandler, ElicitationHandler, PermissionHandler, PermissionResult, }; +use github_copilot_sdk::session_events::{ + CapabilitiesChangedData, CommandsChangedData, SessionEventType, +}; use github_copilot_sdk::{ Client, CommandContext, CommandDefinition, CommandHandler, ElicitationRequest, ElicitationResult, RequestId, ResumeSessionConfig, SessionId, Transport, diff --git a/rust/tests/e2e/multi_provider_registry.rs b/rust/tests/e2e/multi_provider_registry.rs new file mode 100644 index 000000000..d07acd356 --- /dev/null +++ b/rust/tests/e2e/multi_provider_registry.rs @@ -0,0 +1,243 @@ +use std::collections::HashMap; + +use github_copilot_sdk::{ + CustomAgentConfig, MessageOptions, NamedProviderConfig, ProviderModelConfig, +}; +use serde_json::Value; + +const CATEGORY: &str = "multi_provider_registry"; + +fn headers(provider: &str) -> HashMap { + let mut map = HashMap::new(); + map.insert("X-Provider".to_string(), provider.to_string()); + map +} + +#[tokio::test] +async fn should_register_multiple_providers_with_custom_agents_bound_to_their_models() { + super::support::with_shared_e2e_context( + &E2E, + CATEGORY, + "should_register_multiple_providers_with_custom_agents_bound_to_their_models", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + + // A heterogeneous registry: two providers of different types, + // with multiple models each. Provider-qualified selection ids + // are alpha/sonnet, alpha/haiku, beta/opus, beta/haiku. + let session = client + .create_session( + ctx.approve_all_session_config() + .with_providers(vec![ + NamedProviderConfig::new("alpha", "https://alpha.example.test/v1") + .with_provider_type("openai") + .with_wire_api("completions") + .with_api_key("alpha-secret") + .with_headers(headers("alpha")), + NamedProviderConfig::new("beta", "https://beta.example.test") + .with_provider_type("anthropic") + .with_bearer_token("beta-bearer") + .with_headers(headers("beta")), + ]) + .with_models(vec![ + ProviderModelConfig::new("sonnet", "alpha") + .with_wire_model("byok-gpt-4o") + .with_max_prompt_tokens(111_111), + ProviderModelConfig::new("haiku", "alpha") + .with_wire_model("byok-gpt-4o-mini"), + ProviderModelConfig::new("opus", "beta") + .with_wire_model("byok-claude-3-opus"), + ProviderModelConfig::new("haiku", "beta") + .with_wire_model("byok-claude-3-haiku"), + ]) + .with_custom_agents([ + CustomAgentConfig::new("orchestrator", "Plan and delegate.") + .with_display_name("Orchestrator") + .with_description("Top-level planner.") + .with_model("alpha/sonnet"), + CustomAgentConfig::new("researcher", "Research thoroughly.") + .with_display_name("Researcher") + .with_description("Deep research subagent.") + .with_model("beta/opus"), + CustomAgentConfig::new("fast-helper", "Answer quickly.") + .with_display_name("Fast Helper") + .with_description("Quick subagent.") + .with_model("alpha/haiku"), + CustomAgentConfig::new("summarizer", "Summarize.") + .with_display_name("Summarizer") + .with_description("Summarizing subagent.") + .with_model("beta/haiku"), + ]), + ) + .await + .expect("create session"); + + let result = session.rpc().agent().list().await.expect("agent list"); + + // All four custom agents coexist in a single session. + assert_eq!(result.agents.len(), 4, "expected 4 custom agents"); + + // Each agent is bound to its configured provider-qualified model. + let bound = |name: &str| { + result + .agents + .iter() + .find(|agent| agent.name == name) + .and_then(|agent| agent.model.clone()) + .unwrap_or_default() + }; + assert_eq!(bound("orchestrator"), "alpha/sonnet"); + assert_eq!(bound("researcher"), "beta/opus"); + assert_eq!(bound("fast-helper"), "alpha/haiku"); + assert_eq!(bound("summarizer"), "beta/haiku"); + + // Models from BOTH providers are represented, proving the two + // providers and their models coexist within the same session. + let models: Vec = result + .agents + .iter() + .filter_map(|agent| agent.model.clone()) + .collect(); + assert!( + models.iter().any(|m| m.starts_with("alpha/")), + "expected an alpha-bound agent", + ); + assert!( + models.iter().any(|m| m.starts_with("beta/")), + "expected a beta-bound agent", + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +async fn assert_routing( + snapshot_name: &'static str, + selection_id: &'static str, + expected_wire_model: &'static str, + expected_provider_header: &'static str, +) { + super::support::with_shared_e2e_context(&E2E, CATEGORY, snapshot_name, move |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + + // Two OpenAI-compatible providers, both pointed at the replay proxy + // so their /chat/completions traffic is captured. They are + // distinguished on the wire by their per-provider X-Provider + // header. "alpha" carries two models (multiple models per + // provider); "delta" carries one. + let proxy_url = ctx.proxy_url().to_string(); + let session = client + .create_session( + ctx.approve_all_session_config() + .with_model(selection_id) + .with_providers(vec![ + NamedProviderConfig::new("alpha", proxy_url.clone()) + .with_provider_type("openai") + .with_wire_api("completions") + .with_api_key("alpha-secret") + .with_headers(headers("alpha")), + NamedProviderConfig::new("delta", proxy_url.clone()) + .with_provider_type("openai") + .with_wire_api("completions") + .with_api_key("delta-secret") + .with_headers(headers("delta")), + ]) + .with_models(vec![ + ProviderModelConfig::new("sonnet", "alpha") + .with_wire_model("byok-gpt-4o"), + ProviderModelConfig::new("haiku", "alpha") + .with_wire_model("byok-gpt-4o-mini"), + ProviderModelConfig::new("turbo", "delta") + .with_wire_model("byok-gpt-4-turbo"), + ]), + ) + .await + .expect("create session"); + + session + .send_and_wait(MessageOptions::new("What is 5+5?")) + .await + .expect("send"); + + let exchanges = ctx.exchanges(); + assert_eq!(exchanges.len(), 1, "expected exactly one captured exchange"); + let exchange = &exchanges[0]; + + // The wire model sent to the provider is the selected model's wire + // model, not its provider-qualified selection id. + let model = exchange + .get("request") + .and_then(|request| request.get("model")) + .and_then(Value::as_str) + .expect("request model"); + assert_eq!(model, expected_wire_model); + + let request_headers = exchange + .get("requestHeaders") + .and_then(Value::as_object) + .expect("request headers"); + + // The request carried the owning provider's custom header, proving + // the turn was dispatched against the correct provider connection. + let provider_header = request_headers + .iter() + .find(|(key, _)| key.eq_ignore_ascii_case("x-provider")) + .and_then(|(_, value)| value.as_str()) + .expect("x-provider header"); + assert_eq!(provider_header, expected_provider_header); + + // The provider's API key was applied as an Authorization header. + let has_authorization = request_headers + .iter() + .any(|(key, _)| key.eq_ignore_ascii_case("authorization")); + assert!(has_authorization, "expected an Authorization header"); + + // disconnect may fail since the BYOK provider URL is the proxy + let _ = session.disconnect().await; + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +#[tokio::test] +async fn should_route_alpha_sonnet_turn_to_its_provider_and_wire_model() { + assert_routing( + "should_route_alpha_sonnet_turn_to_its_provider_and_wire_model", + "alpha/sonnet", + "byok-gpt-4o", + "alpha", + ) + .await; +} + +#[tokio::test] +async fn should_route_alpha_haiku_turn_to_its_provider_and_wire_model() { + assert_routing( + "should_route_alpha_haiku_turn_to_its_provider_and_wire_model", + "alpha/haiku", + "byok-gpt-4o-mini", + "alpha", + ) + .await; +} + +#[tokio::test] +async fn should_route_delta_turbo_turn_to_its_provider_and_wire_model() { + assert_routing( + "should_route_delta_turbo_turn_to_its_provider_and_wire_model", + "delta/turbo", + "byok-gpt-4-turbo", + "delta", + ) + .await; +} +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard(CATEGORY, 4); diff --git a/rust/tests/e2e/multi_turn.rs b/rust/tests/e2e/multi_turn.rs index ba0961886..e57fe2294 100644 --- a/rust/tests/e2e/multi_turn.rs +++ b/rust/tests/e2e/multi_turn.rs @@ -1,13 +1,12 @@ use github_copilot_sdk::SessionEvent; -use github_copilot_sdk::generated::session_events::SessionEventType; +use github_copilot_sdk::session_events::SessionEventType; -use super::support::{ - assistant_message_content, collect_until_idle, event_types, with_e2e_context, -}; +use super::support::{assistant_message_content, collect_until_idle, event_types}; #[tokio::test] async fn should_use_tool_results_from_previous_turns() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "multi_turn", "should_use_tool_results_from_previous_turns", |ctx| { @@ -52,7 +51,8 @@ async fn should_use_tool_results_from_previous_turns() { #[tokio::test] async fn should_handle_file_creation_then_reading_across_turns() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "multi_turn", "should_handle_file_creation_then_reading_across_turns", |ctx| { @@ -154,3 +154,5 @@ fn index_of( .skip(start_index) .find_map(|(index, event)| (event.parsed_type() == event_type).then_some(index)) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("multi_turn", 2); diff --git a/rust/tests/e2e/pending_work_resume.rs b/rust/tests/e2e/pending_work_resume.rs index 0a782f980..f695e7114 100644 --- a/rust/tests/e2e/pending_work_resume.rs +++ b/rust/tests/e2e/pending_work_resume.rs @@ -2,11 +2,11 @@ use std::net::TcpListener; use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::api_types::HandlePendingToolCallRequest; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::rpc::HandlePendingToolCallRequest; +use github_copilot_sdk::session_events::{ AssistantMessageData, ExternalToolRequestedData, SessionEventType, SessionResumeData, }; -use github_copilot_sdk::handler::ApproveAllHandler; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{ Client, Error, RequestId, ResumeSessionConfig, SessionConfig, SessionId, Tool, ToolInvocation, diff --git a/rust/tests/e2e/per_session_auth.rs b/rust/tests/e2e/per_session_auth.rs index 24d379448..efb005b59 100644 --- a/rust/tests/e2e/per_session_auth.rs +++ b/rust/tests/e2e/per_session_auth.rs @@ -7,6 +7,9 @@ use super::support::with_e2e_context; #[tokio::test] async fn session_uses_client_token_when_no_session_token_is_supplied() { + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context( "per-session-auth", "session_uses_client_token_when_no_session_token_is_supplied", @@ -29,7 +32,7 @@ async fn session_uses_client_token_when_no_session_token_is_supplied() { .expect("create session"); let status = session .rpc() - .auth() + .git_hub_auth() .get_status() .await .expect("auth status"); @@ -47,6 +50,9 @@ async fn session_uses_client_token_when_no_session_token_is_supplied() { #[tokio::test] async fn session_token_overrides_client_token() { + if super::support::skip_inprocess("client-level GitHub tokens are not supported in-process") { + return; + } with_e2e_context( "per-session-auth", "session_token_overrides_client_token", @@ -70,7 +76,7 @@ async fn session_token_overrides_client_token() { .expect("create session"); let status = session .rpc() - .auth() + .git_hub_auth() .get_status() .await .expect("auth status"); @@ -93,7 +99,11 @@ async fn session_auth_status_is_unauthenticated_without_token() { "session_auth_status_is_unauthenticated_without_token", |ctx| { Box::pin(async move { - let client = ctx.start_client().await; + let client = github_copilot_sdk::Client::start( + ctx.client_options().with_use_logged_in_user(false), + ) + .await + .expect("start client"); let session = client .create_session( SessionConfig::default() @@ -103,7 +113,7 @@ async fn session_auth_status_is_unauthenticated_without_token() { .expect("create session"); let status = session .rpc() - .auth() + .git_hub_auth() .get_status() .await .expect("auth status"); diff --git a/rust/tests/e2e/permissions.rs b/rust/tests/e2e/permissions.rs index 3ad01193f..65b37928d 100644 --- a/rust/tests/e2e/permissions.rs +++ b/rust/tests/e2e/permissions.rs @@ -1,9 +1,9 @@ use std::sync::Arc; use async_trait::async_trait; -use github_copilot_sdk::generated::api_types::PermissionsSetApproveAllRequest; -use github_copilot_sdk::generated::session_events::{SessionEventType, ToolExecutionCompleteData}; use github_copilot_sdk::handler::{PermissionHandler, PermissionResult}; +use github_copilot_sdk::rpc::PermissionsSetApproveAllRequest; +use github_copilot_sdk::session_events::{SessionEventType, ToolExecutionCompleteData}; use github_copilot_sdk::{ PermissionRequestData, RequestId, ResumeSessionConfig, SessionConfig, SessionId, }; @@ -11,12 +11,13 @@ use tokio::sync::{mpsc, oneshot}; use super::support::{ DEFAULT_TEST_TOKEN, assistant_message_content, recv_with_timeout, wait_for_condition, - wait_for_event, with_e2e_context, + wait_for_event, }; #[tokio::test] async fn should_work_with_approve_all_permission_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_work_with_approve_all_permission_handler", |ctx| { @@ -49,9 +50,10 @@ async fn should_handle_permission_handler_errors_gracefully() { assert!(matches!( result, - PermissionResult::Decision( - github_copilot_sdk::types::PermissionDecision::UserNotAvailable(_) - ) + PermissionResult::Decision { + decision: github_copilot_sdk::types::PermissionDecision::UserNotAvailable(_), + .. + } )); } @@ -68,7 +70,8 @@ async fn should_handle_concurrent_permission_requests_from_parallel_tools() { #[tokio::test] async fn should_deny_permission_when_handler_returns_denied() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_deny_permission_when_handler_returns_denied", |ctx| { @@ -120,7 +123,8 @@ async fn should_deny_permission_when_handler_returns_denied() { #[tokio::test] async fn should_deny_tool_operations_when_handler_explicitly_denies() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_deny_tool_operations_when_handler_explicitly_denies", |ctx| { @@ -159,7 +163,8 @@ async fn should_deny_tool_operations_when_handler_explicitly_denies() { #[tokio::test] async fn should_handle_async_permission_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_handle_async_permission_handler", |ctx| { @@ -195,7 +200,7 @@ async fn should_handle_async_permission_handler() { #[tokio::test] async fn should_resume_session_with_permission_handler() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "permissions", "should_resume_session_with_permission_handler", |ctx| { @@ -250,7 +255,7 @@ async fn should_resume_session_with_permission_handler() { #[tokio::test] async fn should_deny_tool_operations_when_handler_explicitly_denies_after_resume() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "permissions", "should_deny_tool_operations_when_handler_explicitly_denies_after_resume", |ctx| { @@ -310,7 +315,8 @@ async fn should_deny_tool_operations_when_handler_explicitly_denies_after_resume #[tokio::test] async fn should_receive_toolcallid_in_permission_requests() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_receive_toolcallid_in_permission_requests", |ctx| { @@ -350,7 +356,8 @@ async fn should_receive_toolcallid_in_permission_requests() { #[tokio::test] async fn should_deny_permission_with_noresult_kind() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_deny_permission_with_noresult_kind", |ctx| { @@ -385,7 +392,8 @@ async fn should_deny_permission_with_noresult_kind() { #[tokio::test] async fn should_short_circuit_permission_handler_when_set_approve_all_enabled() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_short_circuit_permission_handler_when_set_approve_all_enabled", |ctx| { @@ -454,7 +462,8 @@ async fn should_short_circuit_permission_handler_when_set_approve_all_enabled() #[tokio::test] async fn should_wait_for_slow_permission_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_wait_for_slow_permission_handler", |ctx| { @@ -520,7 +529,8 @@ async fn should_wait_for_slow_permission_handler() { #[tokio::test] async fn should_invoke_permission_handler_for_write_operations() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "permissions", "should_invoke_permission_handler_for_write_operations", |ctx| { @@ -720,3 +730,5 @@ impl PermissionHandler for SlowPermissionHandler { PermissionResult::approve_once() } } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("permissions", 9); diff --git a/rust/tests/e2e/pre_mcp_tool_call_hook.rs b/rust/tests/e2e/pre_mcp_tool_call_hook.rs index 973672f70..31e69d106 100644 --- a/rust/tests/e2e/pre_mcp_tool_call_hook.rs +++ b/rust/tests/e2e/pre_mcp_tool_call_hook.rs @@ -1,23 +1,22 @@ -use std::collections::HashMap; use std::sync::Arc; use async_trait::async_trait; use github_copilot_sdk::hooks::{ HookContext, PreMcpToolCallInput, PreMcpToolCallOutput, SessionHooks, }; -use github_copilot_sdk::{McpServerConfig, McpStdioServerConfig}; +use github_copilot_sdk::{IndexMap, McpServerConfig, McpStdioServerConfig}; use serde_json::{Value, json}; use tokio::sync::mpsc; -use super::support::{assistant_message_content, recv_with_timeout, with_e2e_context}; +use super::support::{assistant_message_content, recv_with_timeout}; -fn meta_echo_mcp_servers(repo_root: &std::path::Path) -> HashMap { +fn meta_echo_mcp_servers(repo_root: &std::path::Path) -> IndexMap { let harness_dir = repo_root.join("test").join("harness"); let server_path = harness_dir .join("test-mcp-meta-echo-server.mjs") .to_string_lossy() .to_string(); - HashMap::from([( + IndexMap::from([( "meta-echo".to_string(), McpServerConfig::Stdio(McpStdioServerConfig { tools: Some(vec!["*".to_string()]), @@ -89,7 +88,7 @@ impl SessionHooks for RemoveMetaHooks { #[tokio::test] async fn should_set_meta_via_premcptoolcall_hook() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "pre_mcp_tool_call_hook", "should_set_meta_via_premcptoolcall_hook", |ctx| { @@ -127,7 +126,7 @@ async fn should_set_meta_via_premcptoolcall_hook() { assert_eq!(input.server_name, "meta-echo"); assert_eq!(input.tool_name, "echo_meta"); assert!(!input.working_directory.as_os_str().is_empty()); - assert!(input.timestamp > 0); + assert!(input.timestamp > 0.0); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -139,7 +138,7 @@ async fn should_set_meta_via_premcptoolcall_hook() { #[tokio::test] async fn should_replace_meta_via_premcptoolcall_hook() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "pre_mcp_tool_call_hook", "should_replace_meta_via_premcptoolcall_hook", |ctx| { @@ -187,7 +186,7 @@ async fn should_replace_meta_via_premcptoolcall_hook() { #[tokio::test] async fn should_remove_meta_via_premcptoolcall_hook() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "pre_mcp_tool_call_hook", "should_remove_meta_via_premcptoolcall_hook", |ctx| { @@ -232,3 +231,5 @@ async fn should_remove_meta_via_premcptoolcall_hook() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("pre_mcp_tool_call_hook", 3); diff --git a/rust/tests/e2e/provider_endpoint.rs b/rust/tests/e2e/provider_endpoint.rs new file mode 100644 index 000000000..3953aad66 --- /dev/null +++ b/rust/tests/e2e/provider_endpoint.rs @@ -0,0 +1,221 @@ +use std::collections::HashMap; +use std::ffi::OsString; +use std::sync::Arc; + +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::rpc::{ProviderEndpointType, ProviderEndpointWireApi}; +use github_copilot_sdk::{ProviderConfig, SessionConfig}; + +use super::support::{DEFAULT_TEST_TOKEN, with_e2e_context}; + +// session.provider.getEndpoint is gated behind COPILOT_ALLOW_GET_PROVIDER_ENDPOINT; +// the harness env passed to the CLI subprocess opts in for these tests. +fn opt_in_env() -> (OsString, OsString) { + ("COPILOT_ALLOW_GET_PROVIDER_ENDPOINT".into(), "true".into()) +} + +#[tokio::test] +#[allow(deprecated)] +async fn byok_provider_endpoint_returns_configured_endpoint() { + with_e2e_context( + "provider-endpoint", + "byok_provider_endpoint_returns_configured_endpoint", + |ctx| { + Box::pin(async move { + let mut options = ctx.client_options(); + if !super::support::is_inprocess_default() { + options.env.push(opt_in_env()); + } + let client = github_copilot_sdk::Client::start(options) + .await + .expect("start client"); + + let mut headers = HashMap::new(); + headers.insert("X-Custom-Header".to_string(), "byok-yes".to_string()); + + let session = client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_provider( + ProviderConfig::new("https://api.example.test/v1") + .with_provider_type("openai") + .with_wire_api("completions") + .with_api_key("byok-secret") + .with_headers(headers), + ), + ) + .await + .expect("create session"); + + let endpoint = session + .rpc() + .provider() + .get_endpoint() + .await + .expect("get_endpoint"); + + assert!( + matches!(endpoint.r#type, ProviderEndpointType::Openai), + "expected type=openai, got {:?}", + endpoint.r#type, + ); + assert!( + matches!( + endpoint.wire_api, + Some(ProviderEndpointWireApi::Completions) + ), + "expected wireApi=completions, got {:?}", + endpoint.wire_api, + ); + assert_eq!(endpoint.base_url, "https://api.example.test/v1"); + assert_eq!(endpoint.api_key.as_deref(), Some("byok-secret")); + assert_eq!( + endpoint.headers.get("X-Custom-Header").map(String::as_str), + Some("byok-yes"), + ); + assert!( + endpoint.session_token.is_none(), + "BYOK sessions never issue a CAPI session token", + ); + + // disconnect may fail since the BYOK provider URL is fake + let _ = session.disconnect().await; + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +#[allow(deprecated)] +async fn capi_provider_endpoint_returns_resolved_credentials() { + with_e2e_context( + "provider-endpoint", + "capi_provider_endpoint_returns_resolved_credentials", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut options = ctx.client_options_with_github_token(DEFAULT_TEST_TOKEN); + if !super::support::is_inprocess_default() { + options.env.push(opt_in_env()); + } + let client = github_copilot_sdk::Client::start(options) + .await + .expect("start client"); + + let session = client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await + .expect("create session"); + + let endpoint = session + .rpc() + .provider() + .get_endpoint() + .await + .expect("get_endpoint"); + + assert!( + matches!( + endpoint.r#type, + ProviderEndpointType::Openai + | ProviderEndpointType::Azure + | ProviderEndpointType::Anthropic + ), + "expected type in {{openai, azure, anthropic}}, got {:?}", + endpoint.r#type, + ); + if !matches!(endpoint.r#type, ProviderEndpointType::Anthropic) { + assert!( + matches!( + endpoint.wire_api, + Some(ProviderEndpointWireApi::Completions) + | Some(ProviderEndpointWireApi::Responses) + ), + "expected wireApi in {{completions, responses}}, got {:?}", + endpoint.wire_api, + ); + } + + assert!( + endpoint.base_url.starts_with("http://") + || endpoint.base_url.starts_with("https://"), + "expected http(s) baseUrl, got {}", + endpoint.base_url, + ); + + let api_key = endpoint + .api_key + .as_deref() + .expect("CAPI OAuth session must surface apiKey"); + assert!(!api_key.is_empty(), "apiKey must be non-empty"); + + let integration_id = endpoint + .headers + .get("Copilot-Integration-Id") + .expect("Copilot-Integration-Id header"); + assert!( + !integration_id.is_empty(), + "Copilot-Integration-Id must be non-empty", + ); + + let user_agent = endpoint + .headers + .get("User-Agent") + .expect("User-Agent header"); + assert!( + user_agent.to_ascii_lowercase().contains("copilot"), + "expected User-Agent to mention Copilot, got {user_agent}", + ); + + let api_version = endpoint + .headers + .get("X-GitHub-Api-Version") + .expect("X-GitHub-Api-Version header"); + assert!( + !api_version.is_empty(), + "X-GitHub-Api-Version must be non-empty", + ); + + let interaction_id = endpoint + .headers + .get("X-Interaction-Id") + .expect("X-Interaction-Id header"); + let hex_count = interaction_id + .chars() + .filter(|c| c.is_ascii_hexdigit() || *c == '-') + .count(); + assert!( + hex_count >= 8, + "expected X-Interaction-Id to look like a hex/uuid value, got {interaction_id}", + ); + + let authorization = endpoint + .headers + .get("Authorization") + .expect("Authorization header"); + assert_eq!(authorization, &format!("Bearer {api_key}")); + + if let Some(session_token) = endpoint.session_token.as_ref() { + assert_eq!(session_token.header, "Copilot-Session-Token"); + assert!( + !session_token.token.is_empty(), + "session token must be non-empty", + ); + if let Some(expires_at) = session_token.expires_at.as_deref() { + assert!(!expires_at.is_empty(), "expected non-empty expiresAt",); + } + } + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} diff --git a/rust/tests/e2e/rewind.rs b/rust/tests/e2e/rewind.rs new file mode 100644 index 000000000..990c45091 --- /dev/null +++ b/rust/tests/e2e/rewind.rs @@ -0,0 +1,131 @@ +use std::path::Path; +use std::time::Duration; + +use github_copilot_sdk::rpc::{ + HistoryListRewindPointsResult, HistoryPreviewRewindRequest, HistoryRewindMode, + HistoryRewindOutcome, HistoryRewindRequest, +}; + +use super::support::assistant_message_content; + +const FILE_NAME: &str = "rewind-sdk.txt"; +const FILE_CONTENT: &str = "SDK rewind content"; + +#[tokio::test] +async fn should_restore_tracked_file_and_conversation() { + super::support::with_shared_e2e_context( + &E2E, + "rewind", + "should_restore_tracked_file_and_conversation", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let file_path = ctx.work_dir().join(FILE_NAME); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_model("claude-sonnet-4.5") + .with_enable_file_change_tracking(true), + ) + .await + .expect("create session"); + + let response = session + .send_and_wait(format!( + "Use the create tool to create {FILE_NAME} containing exactly \ + {FILE_CONTENT}. After the tool succeeds, reply with exactly \ + SDK_REWIND_DONE." + )) + .await + .expect("send rewind setup prompt") + .expect("assistant message"); + assert_eq!(assistant_message_content(&response), "SDK_REWIND_DONE"); + assert_eq!( + std::fs::read_to_string(&file_path).expect("read tracked file"), + FILE_CONTENT + ); + + let rewind_points = wait_for_rewind_points(&session).await; + assert!(rewind_points.file_change_tracking_enabled); + assert_eq!(rewind_points.points.len(), 1); + let rewind_point = &rewind_points.points[0]; + assert!(rewind_point.can_restore_files); + assert_eq!(rewind_point.file_count, 1); + + let preview = session + .rpc() + .history() + .preview_rewind(HistoryPreviewRewindRequest { + event_id: rewind_point.event_id.clone(), + }) + .await + .expect("preview rewind"); + assert!(preview.available); + assert_eq!(preview.files.len(), 1); + assert_same_path(&file_path, Path::new(&preview.files[0].path)); + + let rewind = session + .rpc() + .history() + .rewind(HistoryRewindRequest { + event_id: rewind_point.event_id.clone(), + mode: HistoryRewindMode::ConversationAndFiles, + }) + .await + .expect("rewind conversation and files"); + assert_eq!(rewind.outcome, HistoryRewindOutcome::Success); + assert!(rewind.events_removed.is_some_and(|count| count > 0)); + assert_eq!(rewind.restored_files.len(), 1); + assert_same_path(&file_path, Path::new(&rewind.restored_files[0])); + assert!(!file_path.exists()); + + let events = session.get_events().await.expect("get events after rewind"); + assert!(events.iter().all(|event| event.id != rewind_point.event_id)); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +async fn wait_for_rewind_points( + session: &github_copilot_sdk::session::Session, +) -> HistoryListRewindPointsResult { + let deadline = tokio::time::Instant::now() + Duration::from_secs(10); + loop { + let result = session + .rpc() + .history() + .list_rewind_points() + .await + .expect("list rewind points"); + if result.unavailable_reason.is_none() { + return result; + } + assert!( + tokio::time::Instant::now() < deadline, + "timed out waiting for rewind points" + ); + tokio::time::sleep(Duration::from_millis(100)).await; + } +} + +fn assert_same_path(expected: &Path, actual: &Path) { + let expected = expected.to_string_lossy(); + let actual = actual.to_string_lossy(); + if cfg!(windows) { + let expected = expected.replace('\\', "/"); + let actual = actual.replace('\\', "/"); + assert!( + expected.eq_ignore_ascii_case(&actual), + "expected path {expected:?}, got {actual:?}" + ); + } else { + assert_eq!(expected, actual); + } +} + +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard("rewind", 1); diff --git a/rust/tests/e2e/rpc_additional_edge_cases.rs b/rust/tests/e2e/rpc_additional_edge_cases.rs index 35fa9265e..d7537f314 100644 --- a/rust/tests/e2e/rpc_additional_edge_cases.rs +++ b/rust/tests/e2e/rpc_additional_edge_cases.rs @@ -1,14 +1,16 @@ -use github_copilot_sdk::generated::SessionMode; -use github_copilot_sdk::generated::api_types::{ - ModeSetRequest, NameSetRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, - ShellExecRequest, WorkspacesCreateFileRequest, WorkspacesReadFileRequest, +use github_copilot_sdk::rpc::{ + ModeSetRequest, NameSetRequest, PermissionsResetSessionApprovalsRequest, + PermissionsSetApproveAllRequest, PlanUpdateRequest, ShellExecRequest, + WorkspacesCreateFileRequest, WorkspacesReadFileRequest, }; +use github_copilot_sdk::session_events::SessionMode; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn shell_exec_with_zero_timeout_does_not_kill_long_running_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "shell_exec_with_zero_timeout_does_not_kill_long_running_command", |ctx| { @@ -48,7 +50,8 @@ async fn shell_exec_with_zero_timeout_does_not_kill_long_running_command() { #[tokio::test] async fn workspaces_create_file_with_empty_content_round_trips() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "workspaces_create_file_with_empty_content_round_trips", |ctx| { @@ -97,7 +100,8 @@ async fn workspaces_create_file_with_empty_content_round_trips() { #[tokio::test] async fn workspaces_create_file_with_unicode_content_round_trips() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "workspaces_create_file_with_unicode_content_round_trips", |ctx| { @@ -140,7 +144,8 @@ async fn workspaces_create_file_with_unicode_content_round_trips() { #[tokio::test] async fn workspaces_create_file_with_large_content_round_trips() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "workspaces_create_file_with_large_content_round_trips", |ctx| { @@ -186,7 +191,8 @@ async fn workspaces_create_file_with_large_content_round_trips() { #[tokio::test] async fn plan_update_with_empty_content_then_read_returns_empty() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "plan_update_with_empty_content_then_read_returns_empty", |ctx| { @@ -219,7 +225,8 @@ async fn plan_update_with_empty_content_then_read_returns_empty() { #[tokio::test] async fn plan_delete_when_none_exists_is_idempotent() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "plan_delete_when_none_exists_is_idempotent", |ctx| { @@ -251,7 +258,8 @@ async fn plan_delete_when_none_exists_is_idempotent() { #[tokio::test] async fn mode_set_to_same_value_multiple_times_stays_stable() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "mode_set_to_same_value_multiple_times_stays_stable", |ctx| { @@ -288,7 +296,8 @@ async fn mode_set_to_same_value_multiple_times_stays_stable() { #[tokio::test] async fn name_set_with_unicode_round_trips() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "name_set_with_unicode_round_trips", |ctx| { @@ -322,7 +331,8 @@ async fn name_set_with_unicode_round_trips() { #[tokio::test] async fn usage_get_metrics_on_fresh_session_returns_zero_tokens() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "usage_get_metrics_on_fresh_session_returns_zero_tokens", |ctx| { @@ -350,7 +360,8 @@ async fn usage_get_metrics_on_fresh_session_returns_zero_tokens() { #[tokio::test] async fn permissions_reset_session_approvals_on_fresh_session_is_noop() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "permissions_reset_session_approvals_on_fresh_session_is_noop", |ctx| { @@ -365,7 +376,7 @@ async fn permissions_reset_session_approvals_on_fresh_session_is_noop() { let result = session .rpc() .permissions() - .reset_session_approvals() + .reset_session_approvals(PermissionsResetSessionApprovalsRequest::default()) .await .expect("reset approvals"); assert!(result.success); @@ -380,7 +391,8 @@ async fn permissions_reset_session_approvals_on_fresh_session_is_noop() { #[tokio::test] async fn permissions_set_approve_all_toggle_round_trips() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "permissions_set_approve_all_toggle_round_trips", |ctx| { @@ -439,7 +451,8 @@ async fn permissions_set_approve_all_toggle_round_trips() { #[tokio::test] async fn workspaces_createfile_then_listfiles_returns_all_files() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "workspaces_createfile_then_listfiles_returns_all_files", |ctx| { @@ -491,7 +504,8 @@ async fn workspaces_createfile_then_listfiles_returns_all_files() { #[tokio::test] async fn workspaces_getworkspace_returns_stable_result_across_calls() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_additional_edge_cases", "workspaces_getworkspace_returns_stable_result_across_calls", |ctx| { @@ -544,3 +558,5 @@ fn delayed_marker_command(marker_path: &std::path::Path) -> String { marker_path.display() ) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_additional_edge_cases", 13); diff --git a/rust/tests/e2e/rpc_agent.rs b/rust/tests/e2e/rpc_agent.rs index 47f9ff792..24fbd3067 100644 --- a/rust/tests/e2e/rpc_agent.rs +++ b/rust/tests/e2e/rpc_agent.rs @@ -1,43 +1,49 @@ use github_copilot_sdk::CustomAgentConfig; -use github_copilot_sdk::generated::api_types::{AgentInfo, AgentSelectRequest}; -use github_copilot_sdk::generated::session_events::SessionEventType; +use github_copilot_sdk::rpc::{AgentInfo, AgentSelectRequest}; +use github_copilot_sdk::session_events::SessionEventType; use serde_json::json; -use super::support::{wait_for_event, with_e2e_context}; +use super::support::wait_for_event; #[tokio::test] async fn should_list_available_custom_agents() { - with_e2e_context("rpc_agents", "should_list_available_custom_agents", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - ctx.approve_all_session_config() - .with_custom_agents(create_custom_agents()), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "rpc_agents", + "should_list_available_custom_agents", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_custom_agents(create_custom_agents()), + ) + .await + .expect("create session"); - let result = session.rpc().agent().list().await.expect("agent list"); - assert_agent(&result.agents, "test-agent", "Test Agent", "A test agent"); - assert_agent( - &result.agents, - "another-agent", - "Another Agent", - "Another test agent", - ); + let result = session.rpc().agent().list().await.expect("agent list"); + assert_agent(&result.agents, "test-agent", "Test Agent", "A test agent"); + assert_agent( + &result.agents, + "another-agent", + "Another Agent", + "Another test agent", + ); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_return_null_when_no_agent_is_selected() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_agents", "should_return_null_when_no_agent_is_selected", |ctx| { @@ -71,47 +77,53 @@ async fn should_return_null_when_no_agent_is_selected() { #[tokio::test] async fn should_select_and_get_current_agent() { - with_e2e_context("rpc_agents", "should_select_and_get_current_agent", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - ctx.approve_all_session_config() - .with_custom_agents([create_custom_agents().remove(0)]), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "rpc_agents", + "should_select_and_get_current_agent", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_custom_agents([create_custom_agents().remove(0)]), + ) + .await + .expect("create session"); - let selected = session - .rpc() - .agent() - .select(AgentSelectRequest { - name: "test-agent".to_string(), - }) - .await - .expect("select agent"); - assert_eq!(selected.agent.name, "test-agent"); - assert_eq!(selected.agent.display_name, "Test Agent"); + let selected = session + .rpc() + .agent() + .select(AgentSelectRequest { + name: "test-agent".to_string(), + }) + .await + .expect("select agent"); + assert_eq!(selected.agent.name, "test-agent"); + assert_eq!(selected.agent.display_name, "Test Agent"); - let current = session - .rpc() - .agent() - .get_current() - .await - .expect("get selected agent"); - assert_eq!(current.agent.name, "test-agent"); + let current = session + .rpc() + .agent() + .get_current() + .await + .expect("get selected agent"); + assert_eq!(current.agent.name, "test-agent"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_emit_subagent_selected_and_deselected_events() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_agents", "should_emit_subagent_selected_and_deselected_events", |ctx| { @@ -185,51 +197,57 @@ async fn should_emit_subagent_selected_and_deselected_events() { #[tokio::test] async fn should_deselect_current_agent() { - with_e2e_context("rpc_agents", "should_deselect_current_agent", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - ctx.approve_all_session_config() - .with_custom_agents([create_custom_agents().remove(0)]), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "rpc_agents", + "should_deselect_current_agent", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_custom_agents([create_custom_agents().remove(0)]), + ) + .await + .expect("create session"); - session - .rpc() - .agent() - .select(AgentSelectRequest { - name: "test-agent".to_string(), - }) - .await - .expect("select agent"); - session - .rpc() - .agent() - .deselect() - .await - .expect("deselect agent"); - let value = client - .call( - "session.agent.getCurrent", - Some(json!({ "sessionId": session.id() })), - ) - .await - .expect("get current agent"); - assert!(value.get("agent").is_some_and(serde_json::Value::is_null)); + session + .rpc() + .agent() + .select(AgentSelectRequest { + name: "test-agent".to_string(), + }) + .await + .expect("select agent"); + session + .rpc() + .agent() + .deselect() + .await + .expect("deselect agent"); + let value = client + .call( + "session.agent.getCurrent", + Some(json!({ "sessionId": session.id() })), + ) + .await + .expect("get current agent"); + assert!(value.get("agent").is_some_and(serde_json::Value::is_null)); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_return_empty_list_when_no_custom_agents_configured() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_agents", "should_return_empty_list_when_no_custom_agents_configured", |ctx| { @@ -254,46 +272,53 @@ async fn should_return_empty_list_when_no_custom_agents_configured() { #[tokio::test] async fn should_call_agent_reload() { - with_e2e_context("rpc_agents", "should_call_agent_reload", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let reload_agent = - CustomAgentConfig::new("reload-test-agent-rust", "You are a reload test agent.") - .with_display_name("Reload Test Agent") - .with_description("Used by the agent reload RPC test."); - let client = ctx.start_client().await; - let session = client - .create_session( - ctx.approve_all_session_config() - .with_custom_agents([reload_agent.clone()]), + super::support::with_shared_e2e_context( + &E2E, + "rpc_agents", + "should_call_agent_reload", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let reload_agent = CustomAgentConfig::new( + "reload-test-agent-rust", + "You are a reload test agent.", ) - .await - .expect("create session"); - - assert_agent( - &session - .rpc() - .agent() - .list() + .with_display_name("Reload Test Agent") + .with_description("Used by the agent reload RPC test."); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_custom_agents([reload_agent.clone()]), + ) .await - .expect("list before") - .agents, - "reload-test-agent-rust", - "Reload Test Agent", - "Used by the agent reload RPC test.", - ); - let reloaded = session.rpc().agent().reload().await.expect("reload agents"); - let current = session.rpc().agent().list().await.expect("list after"); - assert_eq!( - agent_names(&reloaded.agents), - agent_names(¤t.agents), - "reload result should match current list" - ); + .expect("create session"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + assert_agent( + &session + .rpc() + .agent() + .list() + .await + .expect("list before") + .agents, + "reload-test-agent-rust", + "Reload Test Agent", + "Used by the agent reload RPC test.", + ); + let reloaded = session.rpc().agent().reload().await.expect("reload agents"); + let current = session.rpc().agent().list().await.expect("list after"); + assert_eq!( + agent_names(&reloaded.agents), + agent_names(¤t.agents), + "reload result should match current list" + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } @@ -322,3 +347,5 @@ fn agent_names(agents: &[AgentInfo]) -> Vec<&str> { names.sort_unstable(); names } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_agents", 7); diff --git a/rust/tests/e2e/rpc_event_log.rs b/rust/tests/e2e/rpc_event_log.rs index a2c035f86..b116f3e50 100644 --- a/rust/tests/e2e/rpc_event_log.rs +++ b/rust/tests/e2e/rpc_event_log.rs @@ -1,17 +1,16 @@ -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ EventLogReadRequest, EventsCursorStatus, RegisterEventInterestParams, ReleaseEventInterestParams, }; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::session_events::{ PlanChangedOperation, SessionEventType, SessionPlanChangedData, SessionTitleChangedData, }; use serde_json::json; -use super::support::with_e2e_context; - #[tokio::test] async fn should_read_persisted_events_from_beginning() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_log", "should_read_persisted_events_from_beginning", |ctx| { @@ -25,21 +24,17 @@ async fn should_read_persisted_events_from_beginning() { session .rpc() .plan() - .update( - github_copilot_sdk::generated::api_types::PlanUpdateRequest { - content: "# event log plan".to_string(), - }, - ) + .update(github_copilot_sdk::rpc::PlanUpdateRequest { + content: "# event log plan".to_string(), + }) .await .expect("write plan"); client .rpc() .sessions() - .save( - github_copilot_sdk::generated::api_types::SessionsSaveRequest { - session_id: session.id().clone(), - }, - ) + .save(github_copilot_sdk::rpc::SessionsSaveRequest { + session_id: session.id().clone(), + }) .await .expect("save session"); @@ -47,8 +42,11 @@ async fn should_read_persisted_events_from_beginning() { .rpc() .event_log() .read(EventLogReadRequest { + agent_ids: None, agent_scope: None, cursor: None, + direction: None, + include_ephemeral: None, max: Some(100), types: Some(json!("*")), wait_ms: Some(0), @@ -74,7 +72,8 @@ async fn should_read_persisted_events_from_beginning() { #[tokio::test] async fn should_return_tail_cursor_and_read_empty_when_no_new_events() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_log", "should_return_tail_cursor_and_read_empty_when_no_new_events", |ctx| { @@ -92,8 +91,11 @@ async fn should_return_tail_cursor_and_read_empty_when_no_new_events() { .rpc() .event_log() .read(EventLogReadRequest { + agent_ids: None, agent_scope: None, cursor: Some(tail.cursor), + direction: None, + include_ephemeral: None, max: Some(10), types: Some(json!("*")), wait_ms: Some(0), @@ -114,7 +116,8 @@ async fn should_return_tail_cursor_and_read_empty_when_no_new_events() { #[tokio::test] async fn should_register_and_release_event_interest_idempotently() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_log", "should_register_and_release_event_interest_idempotently", |ctx| { @@ -160,7 +163,8 @@ async fn should_register_and_release_event_interest_idempotently() { #[tokio::test] async fn should_longpoll_with_types_filter_for_titlechanged_event() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_log", "should_longpoll_with_types_filter_for_titlechanged_event", |ctx| { @@ -174,8 +178,11 @@ async fn should_longpoll_with_types_filter_for_titlechanged_event() { let tail = session.rpc().event_log().tail().await.expect("tail"); let event_log = session.rpc().event_log(); let read_future = event_log.read(EventLogReadRequest { + agent_ids: None, agent_scope: None, cursor: Some(tail.cursor), + direction: None, + include_ephemeral: None, max: Some(10), types: Some(json!(["session.title_changed"])), wait_ms: Some(5_000), @@ -185,7 +192,7 @@ async fn should_longpoll_with_types_filter_for_titlechanged_event() { session .rpc() .name() - .set(github_copilot_sdk::generated::api_types::NameSetRequest { + .set(github_copilot_sdk::rpc::NameSetRequest { name: "Rust event log title".to_string(), }) .await @@ -208,3 +215,5 @@ async fn should_longpoll_with_types_filter_for_titlechanged_event() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_event_log", 4); diff --git a/rust/tests/e2e/rpc_event_side_effects.rs b/rust/tests/e2e/rpc_event_side_effects.rs index 9e5e2f1a4..e8d7b29b2 100644 --- a/rust/tests/e2e/rpc_event_side_effects.rs +++ b/rust/tests/e2e/rpc_event_side_effects.rs @@ -1,18 +1,19 @@ -use github_copilot_sdk::generated::SessionMode; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ HistoryTruncateRequest, ModeSetRequest, NameSetRequest, PlanUpdateRequest, WorkspacesCreateFileRequest, }; -use github_copilot_sdk::generated::session_events::{ - PlanChangedOperation, SessionEventType, SessionModeChangedData, SessionPlanChangedData, - SessionSnapshotRewindData, SessionTitleChangedData, SessionWorkspaceFileChangedData, +use github_copilot_sdk::session_events::{ + PlanChangedOperation, SessionEventType, SessionMode, SessionModeChangedData, + SessionPlanChangedData, SessionSnapshotRewindData, SessionTitleChangedData, + SessionWorkspaceFileChangedData, }; -use super::support::{assistant_message_content, wait_for_event, with_e2e_context}; +use super::support::{assistant_message_content, wait_for_event}; #[tokio::test] async fn should_emit_mode_changed_event_when_mode_set() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_mode_changed_event_when_mode_set", |ctx| { @@ -54,7 +55,8 @@ async fn should_emit_mode_changed_event_when_mode_set() { #[tokio::test] async fn should_emit_plan_changed_event_for_update_and_delete() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_plan_changed_event_for_update_and_delete", |ctx| { @@ -91,7 +93,8 @@ async fn should_emit_plan_changed_event_for_update_and_delete() { #[tokio::test] async fn should_emit_plan_changed_update_operation_on_second_update() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_plan_changed_update_operation_on_second_update", |ctx| { @@ -132,7 +135,8 @@ async fn should_emit_plan_changed_update_operation_on_second_update() { #[tokio::test] async fn should_emit_workspace_file_changed_event_when_file_created() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_workspace_file_changed_event_when_file_created", |ctx| { @@ -177,7 +181,8 @@ async fn should_emit_workspace_file_changed_event_when_file_created() { #[tokio::test] async fn should_emit_title_changed_event_when_name_set() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_title_changed_event_when_name_set", |ctx| { @@ -220,7 +225,8 @@ async fn should_emit_title_changed_event_when_name_set() { #[tokio::test] async fn should_emit_snapshot_rewind_event_and_remove_events_on_truncate() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_emit_snapshot_rewind_event_and_remove_events_on_truncate", |ctx| { @@ -281,7 +287,8 @@ async fn should_emit_snapshot_rewind_event_and_remove_events_on_truncate() { #[tokio::test] async fn should_allow_session_use_after_truncate() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_event_side_effects", "should_allow_session_use_after_truncate", |ctx| { @@ -351,3 +358,5 @@ fn wait_for_plan_event( == operation }) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_event_side_effects", 7); diff --git a/rust/tests/e2e/rpc_mcp_and_skills.rs b/rust/tests/e2e/rpc_mcp_and_skills.rs index 45233f97c..d5a295e07 100644 --- a/rust/tests/e2e/rpc_mcp_and_skills.rs +++ b/rust/tests/e2e/rpc_mcp_and_skills.rs @@ -1,24 +1,23 @@ use std::collections::HashMap; use std::path::Path; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ ExtensionsDisableRequest, ExtensionsEnableRequest, McpAppsCallToolRequest, - McpAppsDiagnoseRequest, McpAppsListToolsRequest, McpAppsReadResourceRequest, - McpAppsSetHostContextDetails, McpAppsSetHostContextDetailsAvailableDisplayMode, - McpAppsSetHostContextDetailsDisplayMode, McpAppsSetHostContextDetailsPlatform, - McpAppsSetHostContextDetailsTheme, McpAppsSetHostContextRequest, - McpCancelSamplingExecutionParams, McpDisableRequest, McpEnableRequest, - McpExecuteSamplingParams, McpExecuteSamplingRequest, McpOauthLoginRequest, - McpSamplingExecutionAction, McpSetEnvValueModeDetails, McpSetEnvValueModeParams, + McpAppsDiagnoseRequest, McpAppsListToolsRequest, McpAppsSetHostContextDetails, + McpAppsSetHostContextDetailsAvailableDisplayMode, McpAppsSetHostContextDetailsDisplayMode, + McpAppsSetHostContextDetailsPlatform, McpAppsSetHostContextDetailsTheme, + McpAppsSetHostContextRequest, McpCancelSamplingExecutionParams, McpDisableRequest, + McpEnableRequest, McpExecuteSamplingParams, McpExecuteSamplingRequest, McpOauthLoginRequest, + McpResourcesReadRequest, McpSamplingExecutionAction, McpSetEnvValueModeDetails, + McpSetEnvValueModeParams, PermissionsAllowAllMode, PermissionsSetAllowAllRequest, SkillsDisableRequest, SkillsEnableRequest, }; -use github_copilot_sdk::{McpServerConfig, McpStdioServerConfig}; - -use super::support::with_e2e_context; +use github_copilot_sdk::{IndexMap, McpServerConfig, McpStdioServerConfig}; #[tokio::test] async fn should_list_and_toggle_session_skills() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_list_and_toggle_session_skills", |ctx| { @@ -87,7 +86,8 @@ async fn should_list_and_toggle_session_skills() { #[tokio::test] async fn should_ensure_skills_are_loaded_and_list_invoked_skills() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_ensure_skills_are_loaded_and_list_invoked_skills", |ctx| { @@ -137,7 +137,8 @@ async fn should_ensure_skills_are_loaded_and_list_invoked_skills() { #[tokio::test] async fn should_reload_session_skills() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_reload_session_skills", |ctx| { @@ -183,7 +184,8 @@ async fn should_reload_session_skills() { #[tokio::test] async fn should_list_mcp_servers_with_configured_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_list_mcp_servers_with_configured_server", |ctx| { @@ -217,7 +219,8 @@ async fn should_list_mcp_servers_with_configured_server() { #[tokio::test] async fn should_set_mcp_env_value_mode_and_remove_github_server() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_set_mcp_env_value_mode_and_remove_github_server", |ctx| { @@ -256,7 +259,8 @@ async fn should_set_mcp_env_value_mode_and_remove_github_server() { #[tokio::test] async fn should_report_mcp_sampling_failure_and_cancel_missing_sampling() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_mcp_sampling_failure_and_cancel_missing_sampling", |ctx| { @@ -312,68 +316,87 @@ async fn should_report_mcp_sampling_failure_and_cancel_missing_sampling() { #[tokio::test] async fn should_list_plugins() { - with_e2e_context("rpc_mcp_and_skills", "should_list_plugins", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - - let result = session.rpc().plugins().list().await.expect("plugins list"); - assert!( - result.plugins.iter().all(|plugin| !plugin.name.is_empty()), - "plugins should have names: {:?}", - result.plugins - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_and_skills", + "should_list_plugins", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let result = session.rpc().plugins().list().await.expect("plugins list"); + assert!( + result.plugins.iter().all(|plugin| !plugin.name.is_empty()), + "plugins should have names: {:?}", + result.plugins + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_list_extensions() { - with_e2e_context("rpc_mcp_and_skills", "should_list_extensions", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = - github_copilot_sdk::Client::start(ctx.client_options().with_extra_args(["--yolo"])) + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_and_skills", + "should_list_extensions", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) .await - .expect("start yolo client"); - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - - let result = session - .rpc() - .extensions() - .list() - .await - .expect("extensions list"); - assert!( - result - .extensions - .iter() - .all(|extension| !extension.id.is_empty() && !extension.name.is_empty()), - "extensions should have ids and names: {:?}", - result.extensions - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + .expect("create session"); + session + .rpc() + .permissions() + .set_allow_all(PermissionsSetAllowAllRequest { + enabled: None, + mode: Some(PermissionsAllowAllMode::On), + model: None, + source: None, + }) + .await + .expect("enable allow-all"); + + let result = session + .rpc() + .extensions() + .list() + .await + .expect("extensions list"); + assert!( + result + .extensions + .iter() + .all(|extension| !extension.id.is_empty() && !extension.name.is_empty()), + "extensions should have ids and names: {:?}", + result.extensions + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_round_trip_mcp_app_host_context() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_round_trip_mcp_app_host_context", |ctx| { @@ -431,7 +454,8 @@ async fn should_round_trip_mcp_app_host_context() { #[tokio::test] async fn should_diagnose_and_report_mcp_app_capability_errors() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_diagnose_and_report_mcp_app_capability_errors", |ctx| { @@ -495,7 +519,8 @@ async fn should_diagnose_and_report_mcp_app_capability_errors() { #[tokio::test] async fn should_report_error_when_mcp_app_resource_is_not_available() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_error_when_mcp_app_resource_is_not_available", |ctx| { @@ -510,8 +535,8 @@ async fn should_report_error_when_mcp_app_resource_is_not_available() { let err = session .rpc() .mcp() - .apps() - .read_resource(McpAppsReadResourceRequest { + .resources() + .read(McpResourcesReadRequest { server_name: "missing-app-server".to_string(), uri: "ui://missing/resource.html".to_string(), }) @@ -536,7 +561,8 @@ async fn should_report_error_when_mcp_app_resource_is_not_available() { #[tokio::test] async fn should_report_error_when_mcp_host_is_not_initialized() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_error_when_mcp_host_is_not_initialized", |ctx| { @@ -573,6 +599,10 @@ async fn should_report_error_when_mcp_host_is_not_initialized() { callback_success_message: None, client_name: None, force_reauth: None, + client_id: None, + client_secret: None, + grant_type: None, + public_client: None, }), "MCP host is not available", ) @@ -588,7 +618,8 @@ async fn should_report_error_when_mcp_host_is_not_initialized() { #[tokio::test] async fn should_report_error_when_mcp_oauth_server_is_not_configured() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_error_when_mcp_oauth_server_is_not_configured", |ctx| { @@ -608,6 +639,10 @@ async fn should_report_error_when_mcp_oauth_server_is_not_configured() { callback_success_message: None, client_name: None, force_reauth: None, + client_id: None, + client_secret: None, + grant_type: None, + public_client: None, }), "is not configured", ) @@ -623,7 +658,8 @@ async fn should_report_error_when_mcp_oauth_server_is_not_configured() { #[tokio::test] async fn should_report_error_when_mcp_oauth_server_is_not_remote() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_error_when_mcp_oauth_server_is_not_remote", |ctx| { @@ -645,6 +681,10 @@ async fn should_report_error_when_mcp_oauth_server_is_not_remote() { callback_success_message: Some("Done".to_string()), client_name: Some("SDK E2E".to_string()), force_reauth: Some(true), + client_id: None, + client_secret: None, + grant_type: None, + public_client: None, }), "not a remote server", ) @@ -660,21 +700,29 @@ async fn should_report_error_when_mcp_oauth_server_is_not_remote() { #[tokio::test] async fn should_report_error_when_extensions_are_not_available() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_and_skills", "should_report_error_when_extensions_are_not_available", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); - let client = github_copilot_sdk::Client::start( - ctx.client_options().with_extra_args(["--yolo"]), - ) - .await - .expect("start client"); + let client = ctx.start_client().await; let session = client .create_session(ctx.approve_all_session_config()) .await .expect("create session"); + session + .rpc() + .permissions() + .set_allow_all(PermissionsSetAllowAllRequest { + enabled: None, + mode: Some(PermissionsAllowAllMode::On), + model: None, + source: None, + }) + .await + .expect("enable allow-all"); expect_err_contains( session.rpc().extensions().enable(ExtensionsEnableRequest { @@ -730,10 +778,10 @@ fn create_skill(skills_dir: &std::path::Path, skill_name: &str, description: &st } fn assert_skill( - list: github_copilot_sdk::generated::api_types::SkillList, + list: github_copilot_sdk::rpc::SkillList, skill_name: &str, enabled: bool, -) -> github_copilot_sdk::generated::api_types::Skill { +) -> github_copilot_sdk::rpc::Skill { let skill = list .skills .into_iter() @@ -749,14 +797,14 @@ fn assert_skill( skill } -fn test_mcp_servers(repo_root: &Path, server_name: &str) -> HashMap { +fn test_mcp_servers(repo_root: &Path, server_name: &str) -> IndexMap { let harness_dir = repo_root.join("test").join("harness"); let server_path = harness_dir .join("test-mcp-server.mjs") .to_string_lossy() .to_string(); - HashMap::from([( + IndexMap::from([( server_name.to_string(), McpServerConfig::Stdio(McpStdioServerConfig { tools: Some(vec!["*".to_string()]), @@ -787,3 +835,5 @@ async fn expect_err_contains( "expected error to contain {expected:?}, got {err}" ); } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_mcp_and_skills", 15); diff --git a/rust/tests/e2e/rpc_mcp_config.rs b/rust/tests/e2e/rpc_mcp_config.rs index 818d5119d..591d7d247 100644 --- a/rust/tests/e2e/rpc_mcp_config.rs +++ b/rust/tests/e2e/rpc_mcp_config.rs @@ -1,14 +1,13 @@ -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ McpConfigAddRequest, McpConfigDisableRequest, McpConfigEnableRequest, McpConfigRemoveRequest, McpConfigUpdateRequest, }; use serde_json::json; -use super::support::with_e2e_context; - #[tokio::test] async fn should_call_server_mcp_config_rpcs() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_config", "should_call_server_mcp_config_rpcs", |ctx| { @@ -91,7 +90,8 @@ async fn should_call_server_mcp_config_rpcs() { #[tokio::test] async fn should_round_trip_http_mcp_oauth_config_rpc() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_mcp_config", "should_round_trip_http_mcp_oauth_config_rpc", |ctx| { @@ -209,3 +209,5 @@ async fn should_round_trip_http_mcp_oauth_config_rpc() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_mcp_config", 2); diff --git a/rust/tests/e2e/rpc_mcp_lifecycle.rs b/rust/tests/e2e/rpc_mcp_lifecycle.rs new file mode 100644 index 000000000..9e135f1e9 --- /dev/null +++ b/rust/tests/e2e/rpc_mcp_lifecycle.rs @@ -0,0 +1,384 @@ +use std::path::Path; + +use github_copilot_sdk::rpc::{ + McpConfigureGitHubResult, McpIsServerRunningRequest, McpListToolsRequest, + McpStartServersResult, McpStopServerRequest, +}; +use github_copilot_sdk::session::Session; +use github_copilot_sdk::session_events::McpServerStatus; +use github_copilot_sdk::{Error, IndexMap, McpServerConfig, McpStdioServerConfig}; +use serde::de::DeserializeOwned; +use serde_json::{Value, json}; + +use super::support::wait_for_condition; + +#[tokio::test] +async fn should_list_tools_and_report_running_status_for_connected_server() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_list_tools_and_report_running_status_for_connected_server", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let server_name = "rpc-lifecycle-list-server"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), server_name), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await; + + let tools = session + .rpc() + .mcp() + .list_tools(McpListToolsRequest { + server_name: server_name.to_string(), + }) + .await + .expect("list MCP tools"); + assert!(!tools.tools.is_empty()); + assert!(tools.tools.iter().all(|tool| !tool.name.trim().is_empty())); + + assert!(is_mcp_server_running(&session, server_name).await); + assert!( + !is_mcp_server_running( + &session, + &format!("missing-{}", uuid::Uuid::new_v4().simple()) + ) + .await + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_throw_when_listing_tools_for_unconnected_server() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_throw_when_listing_tools_for_unconnected_server", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let server_name = "rpc-lifecycle-unconnected-host"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), server_name), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await; + + let err = session + .rpc() + .mcp() + .list_tools(McpListToolsRequest { + server_name: format!("missing-{}", uuid::Uuid::new_v4().simple()), + }) + .await + .expect_err("missing server should fail"); + assert_error_contains(&err, "not connected"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_stop_running_mcp_server() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_stop_running_mcp_server", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let server_name = "rpc-lifecycle-stop-server"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), server_name), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await; + assert!(is_mcp_server_running(&session, server_name).await); + + session + .rpc() + .mcp() + .stop_server(McpStopServerRequest { + server_name: server_name.to_string(), + }) + .await + .expect("stop MCP server"); + + wait_for_mcp_running(&session, server_name, false).await; + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_start_and_restart_mcp_server() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_start_and_restart_mcp_server", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let host_server = "rpc-lifecycle-host-server"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), host_server), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await; + + let started_server = "rpc-lifecycle-started-server"; + let config = test_mcp_server_config(ctx.repo_root()); + let config_value = serde_json::to_value(&config).expect("serialize MCP config"); + call_session_rpc( + &session, + "session.mcp.startServer", + json!({ "serverName": started_server, "config": config_value }), + ) + .await + .expect("start MCP server"); + wait_for_mcp_running(&session, started_server, true).await; + + let tools = session + .rpc() + .mcp() + .list_tools(McpListToolsRequest { + server_name: started_server.to_string(), + }) + .await + .expect("list started MCP tools"); + assert!(!tools.tools.is_empty()); + + let config_value = serde_json::to_value(&config).expect("serialize MCP config"); + call_session_rpc( + &session, + "session.mcp.restartServer", + json!({ "serverName": started_server, "config": config_value }), + ) + .await + .expect("restart MCP server"); + wait_for_mcp_running(&session, started_server, true).await; + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +// There is deliberately no e2e test for `session.mcp.registerExternalClient`. That method is +// marked `visibility: internal` in the shared API contract: its `client` and `transport` fields +// are live in-process MCP SDK instances, so it cannot be driven over JSON-RPC, and no SDK +// exposes it as a typed method. A raw-RPC test used to pass only because older CLIs routed +// internal methods generically; it never exercised a supported wire API. + +#[tokio::test] +async fn should_reload_mcp_servers_with_config() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_reload_mcp_servers_with_config", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let host_server = "rpc-lifecycle-reload-host"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), host_server), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await; + + let result: McpStartServersResult = call_session_rpc_typed( + &session, + "session.mcp.reloadWithConfig", + json!({ + "config": { + "mcpServers": {}, + "disabledServers": [] + } + }), + ) + .await + .expect("reload MCP with config"); + + assert!(result.filtered_servers.is_empty()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_configure_github_mcp_server() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_mcp_lifecycle", + "should_configure_github_mcp_server", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let host_server = "rpc-lifecycle-configure-host"; + let client = ctx.start_client().await; + let session = + client + .create_session(ctx.approve_all_session_config().with_mcp_servers( + create_test_mcp_servers(ctx.repo_root(), host_server), + )) + .await + .expect("create session"); + wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await; + + let result: McpConfigureGitHubResult = call_session_rpc_typed( + &session, + "session.mcp.configureGitHub", + json!({ "authInfo": { "type": "api-key" } }), + ) + .await + .expect("configure GitHub MCP"); + + assert!(!result.changed); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +fn create_test_mcp_servers( + repo_root: &Path, + server_name: &str, +) -> IndexMap { + IndexMap::from([(server_name.to_string(), test_mcp_server_config(repo_root))]) +} + +fn test_mcp_server_config(repo_root: &Path) -> McpServerConfig { + let harness_dir = repo_root.join("test").join("harness"); + let server_path = harness_dir + .join("test-mcp-server.mjs") + .to_string_lossy() + .to_string(); + McpServerConfig::Stdio(McpStdioServerConfig { + tools: Some(vec!["*".to_string()]), + command: if cfg!(windows) { + "node.exe".to_string() + } else { + "node".to_string() + }, + args: vec![server_path], + working_directory: Some(harness_dir.to_string_lossy().to_string()), + ..McpStdioServerConfig::default() + }) +} + +async fn wait_for_mcp_server_status( + session: &Session, + server_name: &str, + expected_status: McpServerStatus, +) { + wait_for_condition("MCP server status", || async { + session + .rpc() + .mcp() + .list() + .await + .expect("list MCP servers") + .servers + .iter() + .any(|server| server.name == server_name && server.status == expected_status) + }) + .await; +} + +async fn wait_for_mcp_running(session: &Session, server_name: &str, expected_running: bool) { + wait_for_condition("MCP server running state", || async { + is_mcp_server_running(session, server_name).await == expected_running + }) + .await; +} + +async fn is_mcp_server_running(session: &Session, server_name: &str) -> bool { + session + .rpc() + .mcp() + .is_server_running(McpIsServerRunningRequest { + server_name: server_name.to_string(), + }) + .await + .expect("check MCP running") + .running +} + +async fn call_session_rpc( + session: &Session, + method: &'static str, + mut params: Value, +) -> Result { + params["sessionId"] = json!(session.id()); + session.client().call(method, Some(params)).await +} + +async fn call_session_rpc_typed( + session: &Session, + method: &'static str, + params: Value, +) -> Result { + let value = call_session_rpc(session, method, params).await?; + Ok(serde_json::from_value(value)?) +} + +fn assert_error_contains(err: &Error, expected: &str) { + let message = err.to_string(); + assert!( + !message.to_ascii_lowercase().contains("unhandled method"), + "{message}" + ); + assert!( + message + .to_ascii_lowercase() + .contains(&expected.to_ascii_lowercase()), + "expected error to contain {expected:?}, got {message}" + ); +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_mcp_lifecycle", 6); diff --git a/rust/tests/e2e/rpc_queue.rs b/rust/tests/e2e/rpc_queue.rs index 41bf897bb..6f4f88165 100644 --- a/rust/tests/e2e/rpc_queue.rs +++ b/rust/tests/e2e/rpc_queue.rs @@ -1,13 +1,13 @@ -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ CommandsRespondToQueuedCommandRequest, EnqueueCommandParams, QueuePendingItems, QueuePendingItemsKind, RegisterEventInterestParams, ReleaseEventInterestParams, }; -use github_copilot_sdk::generated::session_events::{CommandQueuedData, SessionEventType}; use github_copilot_sdk::session::Session; +use github_copilot_sdk::session_events::{CommandQueuedData, SessionEventType}; use serde_json::json; use uuid::Uuid; -use super::support::{wait_for_condition, wait_for_event, with_e2e_context}; +use super::support::{wait_for_condition, wait_for_event}; fn is_pending_command(item: &QueuePendingItems, command: &str) -> bool { item.kind == QueuePendingItemsKind::Command @@ -66,7 +66,8 @@ async fn wait_for_queue_empty(session: &Session) { #[tokio::test] async fn fresh_queue_is_empty_and_empty_mutations_are_noops() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_queue", "fresh_queue_is_empty_and_empty_mutations_are_noops", |ctx| { @@ -115,7 +116,8 @@ async fn fresh_queue_is_empty_and_empty_mutations_are_noops() { #[tokio::test] async fn pendingitems_reports_queued_command_and_remove_and_clear_update_queue() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_queue", "pendingitems_reports_queued_command_and_remove_and_clear_update_queue", |ctx| { @@ -223,3 +225,5 @@ async fn pendingitems_reports_queued_command_and_remove_and_clear_update_queue() ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_queue", 2); diff --git a/rust/tests/e2e/rpc_remote.rs b/rust/tests/e2e/rpc_remote.rs index d6a8e35fe..e98f6c4fa 100644 --- a/rust/tests/e2e/rpc_remote.rs +++ b/rust/tests/e2e/rpc_remote.rs @@ -1,15 +1,12 @@ -use github_copilot_sdk::generated::api_types::{ - RemoteEnableRequest, RemoteSessionMode, SessionsGetPersistedRemoteSteerableRequest, -}; -use github_copilot_sdk::generated::session_events::{ - SessionEventType, SessionRemoteSteerableChangedData, -}; +use github_copilot_sdk::rpc::{RemoteEnableRequest, RemoteSessionMode}; +use github_copilot_sdk::session_events::{SessionEventType, SessionRemoteSteerableChangedData}; -use super::support::{wait_for_event, with_e2e_context}; +use super::support::wait_for_event; #[tokio::test] async fn should_treat_remote_off_as_noop_or_implemented_error() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_remote", "should_treat_remote_off_as_noop_or_implemented_error", |ctx| { @@ -49,7 +46,8 @@ async fn should_treat_remote_off_as_noop_or_implemented_error() { #[tokio::test] async fn should_treat_remote_disable_as_noop_or_implemented_error() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_remote", "should_treat_remote_disable_as_noop_or_implemented_error", |ctx| { @@ -78,7 +76,8 @@ async fn should_treat_remote_disable_as_noop_or_implemented_error() { #[tokio::test] async fn should_notify_steerable_changed_event_and_persist_flag() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_remote", "should_notify_steerable_changed_event_and_persist_flag", |ctx| { @@ -89,33 +88,25 @@ async fn should_notify_steerable_changed_event_and_persist_flag() { .create_session(ctx.approve_all_session_config()) .await .expect("create session"); - let changed = wait_for_event(session.subscribe(), "remote steerable changed", |event| { - event.parsed_type() == SessionEventType::SessionRemoteSteerableChanged - && event - .typed_data::() - .is_some_and(|data| data.remote_steerable) - }); + let changed = + wait_for_event(session.subscribe(), "remote steerable changed", |event| { + event.parsed_type() == SessionEventType::SessionRemoteSteerableChanged + && event + .typed_data::() + .is_some_and(|data| data.remote_steerable) + }); session .rpc() .remote() .notify_steerable_changed( - github_copilot_sdk::generated::api_types::RemoteNotifySteerableChangedRequest { + github_copilot_sdk::rpc::RemoteNotifySteerableChangedRequest { remote_steerable: true, }, ) .await .expect("notify remote steerable"); changed.await; - let persisted = client - .rpc() - .sessions() - .get_persisted_remote_steerable(SessionsGetPersistedRemoteSteerableRequest { - session_id: session.id().clone(), - }) - .await - .expect("persisted remote steerable"); - assert_eq!(persisted.remote_steerable, Some(true)); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -124,3 +115,5 @@ async fn should_notify_steerable_changed_event_and_persist_flag() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_remote", 3); diff --git a/rust/tests/e2e/rpc_schedule.rs b/rust/tests/e2e/rpc_schedule.rs index 32807958e..af8f6f59b 100644 --- a/rust/tests/e2e/rpc_schedule.rs +++ b/rust/tests/e2e/rpc_schedule.rs @@ -1,10 +1,9 @@ -use github_copilot_sdk::generated::api_types::ScheduleStopRequest; - -use super::support::with_e2e_context; +use github_copilot_sdk::rpc::ScheduleStopRequest; #[tokio::test] async fn should_list_no_schedules_for_fresh_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_schedule", "should_list_no_schedules_for_fresh_session", |ctx| { @@ -34,7 +33,8 @@ async fn should_list_no_schedules_for_fresh_session() { #[tokio::test] async fn should_return_null_entry_when_stopping_unknown_schedule() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_schedule", "should_return_null_entry_when_stopping_unknown_schedule", |ctx| { @@ -71,3 +71,5 @@ async fn should_return_null_entry_when_stopping_unknown_schedule() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_schedule", 2); diff --git a/rust/tests/e2e/rpc_server.rs b/rust/tests/e2e/rpc_server.rs index 5ce55f847..caa846ba0 100644 --- a/rust/tests/e2e/rpc_server.rs +++ b/rust/tests/e2e/rpc_server.rs @@ -1,23 +1,28 @@ -use github_copilot_sdk::Client; -use github_copilot_sdk::generated::api_types::{ - ConnectRemoteSessionParams, McpDiscoverRequest, NameSetRequest, PingRequest, +use std::collections::HashMap; + +use github_copilot_sdk::rpc::{ + AgentsDiscoverRequest, AgentsGetDiscoveryPathsRequest, ConnectRemoteSessionParams, + InstructionsDiscoverRequest, InstructionsGetDiscoveryPathsRequest, + LlmInferenceHttpResponseChunkRequest, LlmInferenceHttpResponseStartRequest, + LocalSessionMetadataValue, McpDiscoverRequest, NameSetRequest, PingRequest, SecretsAddFilterValuesRequest, SessionContext, SessionFsSetProviderConventions, - SessionFsSetProviderRequest, SessionListFilter, SessionMetadata, SessionsBulkDeleteRequest, + SessionFsSetProviderRequest, SessionListFilter, SessionsBulkDeleteRequest, SessionsCheckInUseRequest, SessionsCloseRequest, SessionsEnrichMetadataRequest, - SessionsFindByPrefixRequest, SessionsFindByTaskIDRequest, SessionsGetEventFilePathRequest, - SessionsGetLastForContextRequest, SessionsGetPersistedRemoteSteerableRequest, + SessionsFindByPrefixRequest, SessionsFindByTaskIDRequest, SessionsGetLastForContextRequest, SessionsListRequest, SessionsLoadDeferredRepoHooksRequest, SessionsPruneOldRequest, SessionsReleaseLockRequest, SessionsReloadPluginHooksRequest, SessionsSaveRequest, SessionsSetAdditionalPluginsRequest, SkillsConfigSetDisabledSkillsRequest, - SkillsDiscoverRequest, ToolsListRequest, + SkillsDiscoverRequest, SkillsGetDiscoveryPathsRequest, ToolsListRequest, }; +use github_copilot_sdk::{Client, RequestId}; use serde_json::json; -use super::support::with_e2e_context; +use super::support::{with_e2e_context, with_e2e_context_no_snapshot}; #[tokio::test] async fn should_call_rpc_ping_with_typed_params_and_result() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_call_rpc_ping_with_typed_params_and_result", |ctx| { @@ -50,7 +55,7 @@ async fn should_call_rpc_models_list_with_typed_result() { Box::pin(async move { let token = "rpc-models-token"; ctx.set_copilot_user_by_token_with_login(token, "rpc-user"); - let client = Client::start(ctx.client_options().with_github_token(token)) + let client = Client::start(ctx.client_options_with_github_token(token)) .await .expect("start client"); @@ -91,7 +96,7 @@ async fn should_call_rpc_account_get_quota_when_authenticated() { } })), ); - let client = Client::start(ctx.client_options().with_github_token(token)) + let client = Client::start(ctx.client_options_with_github_token(token)) .await .expect("start client"); @@ -114,7 +119,8 @@ async fn should_call_rpc_account_get_quota_when_authenticated() { #[tokio::test] async fn should_call_rpc_tools_list_with_typed_result() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_call_rpc_tools_list_with_typed_result", |ctx| { @@ -137,9 +143,53 @@ async fn should_call_rpc_tools_list_with_typed_result() { .await; } +#[tokio::test] +async fn should_reject_llm_response_frames_for_unknown_request() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + let request_id = RequestId::from("missing-llm-response-request"); + + let start = client + .rpc() + .llm_inference() + .http_response_start(LlmInferenceHttpResponseStartRequest { + headers: HashMap::from([( + "content-type".to_string(), + vec!["application/json".to_string()], + )]), + request_id: request_id.clone(), + status: 200, + status_text: Some("OK".to_string()), + }) + .await + .expect("send unknown LLM response start"); + assert!(!start.accepted); + + let chunk = client + .rpc() + .llm_inference() + .http_response_chunk(LlmInferenceHttpResponseChunkRequest { + binary: Some(false), + data: "{}".to_string(), + end: Some(true), + error: None, + request_id, + }) + .await + .expect("send unknown LLM response chunk"); + assert!(!chunk.accepted); + + client.stop().await.expect("stop client"); + }) + }) + .await; +} + #[tokio::test] async fn should_discover_server_mcp_and_skills() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_discover_server_mcp_and_skills", |ctx| { @@ -151,12 +201,13 @@ async fn should_discover_server_mcp_and_skills() { "Skill discovered by server-scoped RPC tests.", ); let client = ctx.start_client().await; + let project_path = ctx.work_dir().to_string_lossy().to_string(); let mcp = client .rpc() .mcp() .discover(McpDiscoverRequest { - working_directory: Some(ctx.work_dir().to_string_lossy().to_string()), + working_directory: Some(project_path.clone()), }) .await .expect("mcp discover"); @@ -166,6 +217,7 @@ async fn should_discover_server_mcp_and_skills() { .rpc() .skills() .discover(SkillsDiscoverRequest { + exclude_host_skills: None, project_paths: None, skill_directories: Some(vec![ skill_directory.to_string_lossy().to_string(), @@ -179,6 +231,101 @@ async fn should_discover_server_mcp_and_skills() { "Skill discovered by server-scoped RPC tests." ); + let skill_paths = client + .rpc() + .skills() + .get_discovery_paths(SkillsGetDiscoveryPathsRequest { + exclude_host_skills: Some(true), + project_paths: Some(vec![project_path.clone()]), + }) + .await + .expect("skills discovery paths"); + let project_skill_path = skill_paths + .paths + .iter() + .find(|path| { + path.project_path + .as_deref() + .is_some_and(|path| paths_equal(path, &project_path)) + && path.preferred_for_creation + }) + .expect("project skill discovery path"); + assert!(!project_skill_path.path.trim().is_empty()); + + let agents = client + .rpc() + .agents() + .discover(AgentsDiscoverRequest { + exclude_host_agents: Some(true), + project_paths: Some(vec![project_path.clone()]), + }) + .await + .expect("agents discover"); + assert!( + agents + .agents + .iter() + .all(|agent| !agent.name.trim().is_empty()) + ); + + let agent_paths = client + .rpc() + .agents() + .get_discovery_paths(AgentsGetDiscoveryPathsRequest { + exclude_host_agents: Some(true), + project_paths: Some(vec![project_path.clone()]), + }) + .await + .expect("agents discovery paths"); + let project_agent_path = agent_paths + .paths + .iter() + .find(|path| { + path.project_path + .as_deref() + .is_some_and(|path| paths_equal(path, &project_path)) + && path.preferred_for_creation + }) + .expect("project agent discovery path"); + assert!(!project_agent_path.path.trim().is_empty()); + + let instructions = client + .rpc() + .instructions() + .discover(InstructionsDiscoverRequest { + exclude_host_instructions: Some(true), + project_paths: Some(vec![project_path.clone()]), + }) + .await + .expect("instructions discover"); + assert!(instructions.sources.iter().all(|source| { + !source.id.trim().is_empty() + && !source.label.trim().is_empty() + && !source.source_path.trim().is_empty() + })); + + let instruction_paths = client + .rpc() + .instructions() + .get_discovery_paths(InstructionsGetDiscoveryPathsRequest { + exclude_host_instructions: Some(true), + project_paths: Some(vec![project_path.clone()]), + }) + .await + .expect("instructions discovery paths"); + assert!(!instruction_paths.paths.is_empty()); + assert!(instruction_paths.paths.iter().any(|path| { + path.project_path + .as_deref() + .is_some_and(|path| paths_equal(path, &project_path)) + })); + assert!( + instruction_paths + .paths + .iter() + .all(|path| !path.path.trim().is_empty()) + ); + client .rpc() .skills() @@ -192,6 +339,7 @@ async fn should_discover_server_mcp_and_skills() { .rpc() .skills() .discover(SkillsDiscoverRequest { + exclude_host_skills: None, project_paths: None, skill_directories: Some(vec![ skill_directory.to_string_lossy().to_string(), @@ -256,35 +404,41 @@ async fn should_call_rpc_sessionfs_setprovider_with_typed_result() { #[tokio::test] async fn should_add_secret_filter_values() { - with_e2e_context("rpc_server", "should_add_secret_filter_values", |ctx| { - Box::pin(async move { - let client = ctx.start_client().await; + super::support::with_shared_e2e_context( + &E2E, + "rpc_server", + "should_add_secret_filter_values", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; - let result = client - .rpc() - .secrets() - .add_filter_values(SecretsAddFilterValuesRequest { - values: vec!["rust-secret-value".to_string()], - }) - .await; - match result { - Ok(result) => assert!(result.ok), - Err(err) => { - let message = err.to_string(); - assert!(message.contains("COPILOT_ENABLE_SECRET_FILTERING")); - assert!(!message.contains("Unhandled method secrets.addFilterValues")); + let result = client + .rpc() + .secrets() + .add_filter_values(SecretsAddFilterValuesRequest { + values: vec!["rust-secret-value".to_string()], + }) + .await; + match result { + Ok(response) => assert!(response.ok), + Err(err) => { + let message = err.to_string(); + assert!(message.contains("COPILOT_ENABLE_SECRET_FILTERING")); + assert!(!message.contains("Unhandled method secrets.addFilterValues")); + } } - } - client.stop().await.expect("stop client"); - }) - }) + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_list_find_and_inspect_persisted_session_state() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_list_find_and_inspect_persisted_session_state", |ctx| { @@ -315,11 +469,12 @@ async fn should_list_find_and_inspect_persisted_session_state() { session.disconnect().await.expect("disconnect session"); let list = client.rpc().sessions().list().await.expect("list sessions"); - assert!( - list.sessions - .iter() - .all(|metadata| !metadata.session_id.as_str().is_empty()) - ); + assert!(list.sessions.iter().all(|metadata| { + metadata + .get("sessionId") + .and_then(serde_json::Value::as_str) + .is_some_and(|id| !id.is_empty()) + })); let filtered = client .rpc() .sessions() @@ -332,14 +487,17 @@ async fn should_list_find_and_inspect_persisted_session_state() { }), include_detached: None, metadata_limit: Some(10), + source: None, + throw_on_error: None, }) .await .expect("filtered sessions"); assert!(filtered.sessions.iter().all(|metadata| { metadata - .context - .as_ref() - .is_none_or(|context| context.cwd == ctx.work_dir().display().to_string()) + .get("context") + .and_then(|context| context.get("cwd")) + .and_then(serde_json::Value::as_str) + .is_none_or(|cwd| cwd == ctx.work_dir().display().to_string()) })); assert!( client @@ -391,20 +549,6 @@ async fn should_list_find_and_inspect_persisted_session_state() { .await .expect("check in use"); assert!(!in_use.in_use.iter().any(|id| id == "missing-session-id")); - assert!( - client - .rpc() - .sessions() - .get_persisted_remote_steerable( - SessionsGetPersistedRemoteSteerableRequest { - session_id: session_id.clone(), - }, - ) - .await - .expect("persisted remote steerable") - .remote_steerable - .is_none() - ); client.stop().await.expect("stop client"); }) @@ -415,7 +559,8 @@ async fn should_list_find_and_inspect_persisted_session_state() { #[tokio::test] async fn should_enrich_basic_session_metadata() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_enrich_basic_session_metadata", |ctx| { @@ -427,7 +572,7 @@ async fn should_enrich_basic_session_metadata() { .await .expect("create session"); let session_id = session.id().clone(); - let metadata = SessionMetadata { + let metadata = LocalSessionMetadataValue { client_name: None, context: Some(SessionContext { branch: None, @@ -469,7 +614,8 @@ async fn should_enrich_basic_session_metadata() { #[tokio::test] async fn should_close_active_session_and_release_lock() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_close_active_session_and_release_lock", |ctx| { @@ -520,7 +666,8 @@ async fn should_close_active_session_and_release_lock() { #[tokio::test] async fn should_prune_dryrun_and_bulkdelete_persisted_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_prune_dryrun_and_bulkdelete_persisted_session", |ctx| { @@ -567,7 +714,8 @@ async fn should_prune_dryrun_and_bulkdelete_persisted_session() { #[tokio::test] async fn should_set_additional_plugins_and_reload_deferred_hooks() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_set_additional_plugins_and_reload_deferred_hooks", |ctx| { @@ -617,44 +765,40 @@ async fn should_set_additional_plugins_and_reload_deferred_hooks() { #[tokio::test] async fn should_save_and_get_event_file_path() { - with_e2e_context("rpc_server", "should_save_and_get_event_file_path", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "rpc_server", + "should_save_and_get_event_file_path", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - client - .rpc() - .sessions() - .save(SessionsSaveRequest { - session_id: session.id().clone(), - }) - .await - .expect("save session"); - let path = client - .rpc() - .sessions() - .get_event_file_path(SessionsGetEventFilePathRequest { - session_id: session.id().clone(), - }) - .await - .expect("event file path") - .file_path; - assert!(path.ends_with("events.jsonl")); + client + .rpc() + .sessions() + .save(SessionsSaveRequest { + session_id: session.id().clone(), + }) + .await + .expect("save session"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_report_implemented_error_when_connecting_unknown_remote_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_server", "should_report_implemented_error_when_connecting_unknown_remote_session", |ctx| { @@ -702,10 +846,10 @@ fn create_skill_directory( } fn assert_server_skill( - list: github_copilot_sdk::generated::api_types::ServerSkillList, + list: github_copilot_sdk::rpc::ServerSkillList, skill_name: &str, enabled: bool, -) -> github_copilot_sdk::generated::api_types::ServerSkill { +) -> github_copilot_sdk::rpc::ServerSkill { let skill = list .skills .into_iter() @@ -720,3 +864,21 @@ fn assert_server_skill( ); skill } + +fn paths_equal(left: &str, right: &str) -> bool { + fn normalize(path: &str) -> String { + let mut normalized = path.replace('\\', "/"); + while normalized.ends_with('/') && normalized.len() > 1 { + normalized.pop(); + } + if cfg!(windows) { + normalized.to_ascii_lowercase() + } else { + normalized + } + } + + normalize(left) == normalize(right) +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_server", 11); diff --git a/rust/tests/e2e/rpc_server_misc.rs b/rust/tests/e2e/rpc_server_misc.rs new file mode 100644 index 000000000..47ae4ecbd --- /dev/null +++ b/rust/tests/e2e/rpc_server_misc.rs @@ -0,0 +1,366 @@ +use github_copilot_sdk::Client; +use github_copilot_sdk::rpc::{ + AccountLoginRequest, AccountLogoutRequest, AgentRegistrySpawnRequest, + SendAttachmentsToMessageParams, SessionsOpenStatus, UserSettingsSetRequest, +}; +use serde_json::{Map, Value, json}; + +use super::support::{wait_for_condition, with_e2e_context}; + +#[tokio::test] +async fn should_reload_user_settings() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_misc", + "should_reload_user_settings", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + client + .rpc() + .user() + .settings() + .reload() + .await + .expect("reload user settings"); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_get_set_and_clear_user_settings() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_misc", + "should_get_set_and_clear_user_settings", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let initial = client + .rpc() + .user() + .settings() + .get() + .await + .expect("get initial user settings"); + let (key, value) = initial + .settings + .iter() + .find_map(|(key, setting)| { + setting.value.as_bool().map(|value| (key.clone(), value)) + }) + .expect("at least one boolean user setting"); + let toggled = !value; + + let set = client + .rpc() + .user() + .settings() + .set(UserSettingsSetRequest { + settings: setting_patch(&key, json!(toggled)), + }) + .await + .expect("set user setting"); + assert!(set.shadowed_keys.is_empty()); + client + .rpc() + .user() + .settings() + .reload() + .await + .expect("reload after set"); + let after_set = client + .rpc() + .user() + .settings() + .get() + .await + .expect("get after set"); + let metadata = after_set.settings.get(&key).expect("updated setting"); + assert_eq!(metadata.value, json!(toggled)); + assert!(!metadata.is_default); + + let clear = client + .rpc() + .user() + .settings() + .set(UserSettingsSetRequest { + settings: setting_patch(&key, Value::Null), + }) + .await + .expect("clear user setting"); + assert!(clear.shadowed_keys.is_empty()); + client + .rpc() + .user() + .settings() + .reload() + .await + .expect("reload after clear"); + let after_clear = client + .rpc() + .user() + .settings() + .get() + .await + .expect("get after clear"); + assert!( + after_clear + .settings + .get(&key) + .expect("cleared setting") + .is_default + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_login_list_getcurrentauth_and_logout_account() { + with_e2e_context( + "rpc_server_misc", + "should_login_list_getcurrentauth_and_logout_account", + |ctx| { + Box::pin(async move { + ctx.set_copilot_user_by_token_with_login("rust-account-token", "rust-account-user"); + let client = Client::start(ctx.client_options().with_use_logged_in_user(false)) + .await + .expect("start no-token client"); + + let initial = client + .rpc() + .account() + .get_current_auth() + .await + .expect("get initial auth"); + assert!(initial.auth_info.is_none()); + + let login = client + .rpc() + .account() + .login(AccountLoginRequest { + host: "https://github.com".to_string(), + login: "rust-account-user".to_string(), + token: "rust-account-token".to_string(), + }) + .await + .expect("account login"); + let _stored_in_vault = login.stored_in_vault; + + let current = client + .rpc() + .account() + .get_current_auth() + .await + .expect("get current auth after login"); + let auth_info = current.auth_info.expect("auth info after login"); + assert_eq!(auth_info["login"], json!("rust-account-user")); + assert_eq!(auth_info["host"], json!("https://github.com")); + + let users = client + .rpc() + .account() + .get_all_users() + .await + .expect("get all users"); + if let Some(user) = users + .iter() + .find(|user| user.auth_info["login"] == json!("rust-account-user")) + { + user.token + .as_deref() + .filter(|token| *token == "rust-account-token") + .unwrap_or_else(|| { + panic!("expected stored account token, got {:?}", user.token) + }); + } + + let logout = client + .rpc() + .account() + .logout(AccountLogoutRequest { auth_info }) + .await + .expect("account logout"); + assert!(!logout.has_more_users); + assert!( + client + .rpc() + .account() + .get_current_auth() + .await + .expect("get auth after logout") + .auth_info + .is_none() + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_report_agent_registry_spawn_gate_closed() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_misc", + "should_report_agent_registry_spawn_gate_closed", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let err = client + .rpc() + .agent_registry() + .spawn(AgentRegistrySpawnRequest { + agent_name: None, + cwd: ctx.work_dir().to_string_lossy().to_string(), + initial_prompt: None, + model: None, + name: None, + permission_mode: None, + }) + .await + .expect_err("agent registry spawn should be gated"); + + let message = err.to_string(); + assert_not_unhandled(&message); + let lower = message.to_ascii_lowercase(); + assert!(lower.contains("agentregistry.spawn"), "{message}"); + assert!( + lower.contains("not enabled") || lower.contains("no delegate"), + "{message}" + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_shut_down_owned_runtime() { + with_e2e_context("rpc_server_misc", "should_shut_down_owned_runtime", |ctx| { + Box::pin(async move { + let client = Client::start(ctx.client_options()) + .await + .expect("start dedicated client"); + + client + .rpc() + .user() + .settings() + .reload() + .await + .expect("runtime should start live"); + + client + .rpc() + .runtime() + .shutdown() + .await + .expect("shut down runtime"); + + wait_for_condition("runtime to stop serving RPCs", || async { + client.rpc().user().settings().reload().await.is_err() + }) + .await; + + let _ = client.stop().await; + }) + }) + .await; +} + +#[tokio::test] +async fn should_report_not_found_when_opening_session_without_context() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_misc", + "should_report_not_found_when_opening_session_without_context", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .open() + .await + .expect("open session without context"); + + assert_eq!(result.status, SessionsOpenStatus::NotFound); + assert!(result.session_id.is_none()); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_reject_send_attachments_from_non_extension_connection() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_misc", + "should_reject_send_attachments_from_non_extension_connection", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let err = session + .rpc() + .extensions() + .send_attachments_to_message(SendAttachmentsToMessageParams { + attachments: Vec::new(), + instance_id: None, + }) + .await + .expect_err("normal session connection should be rejected"); + let message = err.to_string(); + assert_not_unhandled(&message); + assert!( + message.to_ascii_lowercase().contains("extension"), + "{message}" + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +fn assert_not_unhandled(message: &str) { + assert!( + !message.to_ascii_lowercase().contains("unhandled method"), + "{message}" + ); +} + +fn setting_patch(key: &str, value: Value) -> Value { + let mut settings = Map::new(); + settings.insert(key.to_string(), value); + Value::Object(settings) +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_server_misc", 5); diff --git a/rust/tests/e2e/rpc_server_plugins.rs b/rust/tests/e2e/rpc_server_plugins.rs new file mode 100644 index 000000000..df6072253 --- /dev/null +++ b/rust/tests/e2e/rpc_server_plugins.rs @@ -0,0 +1,547 @@ +use std::fs; +use std::path::Path; + +use github_copilot_sdk::rpc::{ + InstalledPluginInfo, PluginListResult, PluginsDisableRequest, PluginsEnableRequest, + PluginsInstallRequest, PluginsMarketplacesAddRequest, PluginsMarketplacesBrowseRequest, + PluginsMarketplacesRefreshRequest, PluginsMarketplacesRemoveRequest, PluginsUninstallRequest, + PluginsUpdateRequest, +}; + +const MARKETPLACE_NAME: &str = "csharp-e2e-marketplace"; +const PLUGIN_NAME: &str = "csharp-e2e-plugin"; +const DIRECT_PLUGIN_NAME: &str = "csharp-e2e-direct"; + +#[tokio::test] +async fn should_install_and_list_plugin_from_local_marketplace() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_install_and_list_plugin_from_local_marketplace", + |ctx| { + Box::pin(async move { + let marketplace = create_local_marketplace_fixture(); + let client = ctx.start_client().await; + let spec = format!("{PLUGIN_NAME}@{MARKETPLACE_NAME}"); + + client + .rpc() + .plugins() + .marketplaces() + .add(PluginsMarketplacesAddRequest { + source: marketplace.source(), + working_directory: None, + }) + .await + .expect("add marketplace"); + + let install = client + .rpc() + .plugins() + .install(PluginsInstallRequest { + source: spec, + working_directory: None, + }) + .await + .expect("install marketplace plugin"); + + assert_eq!(install.plugin.name, PLUGIN_NAME); + assert_eq!(install.plugin.marketplace, MARKETPLACE_NAME); + assert!(install.plugin.enabled); + assert!(install.skills_installed >= 1); + assert!(install.deprecation_warning.is_none()); + + let after_install = client.rpc().plugins().list().await.expect("list plugins"); + let listed = single_plugin(&after_install, PLUGIN_NAME, MARKETPLACE_NAME); + assert!(listed.enabled); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_enable_and_disable_marketplace_plugin() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_enable_and_disable_marketplace_plugin", + |ctx| { + Box::pin(async move { + let marketplace = create_local_marketplace_fixture(); + let client = ctx.start_client().await; + let spec = format!("{PLUGIN_NAME}@{MARKETPLACE_NAME}"); + + client + .rpc() + .plugins() + .marketplaces() + .add(PluginsMarketplacesAddRequest { + source: marketplace.source(), + working_directory: None, + }) + .await + .expect("add marketplace"); + client + .rpc() + .plugins() + .install(PluginsInstallRequest { + source: spec.clone(), + working_directory: None, + }) + .await + .expect("install marketplace plugin"); + + client + .rpc() + .plugins() + .disable(PluginsDisableRequest { + names: vec![spec.clone()], + }) + .await + .expect("disable plugin"); + assert!( + !single_plugin( + &client.rpc().plugins().list().await.expect("list disabled"), + PLUGIN_NAME, + MARKETPLACE_NAME + ) + .enabled + ); + + client + .rpc() + .plugins() + .enable(PluginsEnableRequest { names: vec![spec] }) + .await + .expect("enable plugin"); + assert!( + single_plugin( + &client.rpc().plugins().list().await.expect("list enabled"), + PLUGIN_NAME, + MARKETPLACE_NAME + ) + .enabled + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_update_single_marketplace_plugin() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_update_single_marketplace_plugin", + |ctx| { + Box::pin(async move { + let marketplace = create_local_marketplace_fixture(); + let client = ctx.start_client().await; + let spec = format!("{PLUGIN_NAME}@{MARKETPLACE_NAME}"); + + client + .rpc() + .plugins() + .marketplaces() + .add(PluginsMarketplacesAddRequest { + source: marketplace.source(), + working_directory: None, + }) + .await + .expect("add marketplace"); + client + .rpc() + .plugins() + .install(PluginsInstallRequest { + source: spec.clone(), + working_directory: None, + }) + .await + .expect("install marketplace plugin"); + + let update = client + .rpc() + .plugins() + .update(PluginsUpdateRequest { name: spec }) + .await + .expect("update plugin"); + + assert!(update.skills_installed >= 1); + assert_eq!(update.previous_version.as_deref(), Some("1.0.0")); + assert_eq!(update.new_version.as_deref(), Some("1.0.0")); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_update_all_installed_plugins() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_update_all_installed_plugins", + |ctx| { + Box::pin(async move { + let marketplace = create_local_marketplace_fixture(); + let client = ctx.start_client().await; + let spec = format!("{PLUGIN_NAME}@{MARKETPLACE_NAME}"); + + client + .rpc() + .plugins() + .marketplaces() + .add(PluginsMarketplacesAddRequest { + source: marketplace.source(), + working_directory: None, + }) + .await + .expect("add marketplace"); + client + .rpc() + .plugins() + .install(PluginsInstallRequest { + source: spec, + working_directory: None, + }) + .await + .expect("install marketplace plugin"); + + let result = client + .rpc() + .plugins() + .update_all() + .await + .expect("update all plugins"); + + let matches: Vec<_> = result + .results + .iter() + .filter(|entry| { + entry.name == PLUGIN_NAME && entry.marketplace == MARKETPLACE_NAME + }) + .collect(); + assert_eq!(matches.len(), 1, "expected one update entry: {result:?}"); + let entry = matches[0]; + assert!(entry.success, "{:?}", entry.error); + assert!(entry.skills_installed.unwrap_or_default() >= 1); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_install_direct_local_plugin_with_deprecation_warning() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_install_direct_local_plugin_with_deprecation_warning", + |ctx| { + Box::pin(async move { + let plugin = create_direct_plugin_fixture(); + let client = ctx.start_client().await; + + let install = client + .rpc() + .plugins() + .install(PluginsInstallRequest { + source: plugin.source(), + working_directory: None, + }) + .await + .expect("install direct plugin"); + + assert_eq!(install.plugin.name, DIRECT_PLUGIN_NAME); + assert_eq!(install.plugin.marketplace, ""); + let warning = install + .deprecation_warning + .as_deref() + .expect("direct installs should warn"); + assert!(warning.to_ascii_lowercase().contains("deprecated")); + assert!(install.skills_installed >= 1); + + let after_install = client.rpc().plugins().list().await.expect("list plugins"); + let direct_matches = after_install + .plugins + .iter() + .filter(|plugin| plugin.name == DIRECT_PLUGIN_NAME) + .count(); + assert_eq!( + direct_matches, 1, + "expected direct plugin in {after_install:?}" + ); + let direct_source_id = install.plugin.direct_source_id.clone(); + assert!( + direct_source_id.is_some(), + "expected direct plugin install to include direct_source_id" + ); + + client + .rpc() + .plugins() + .uninstall(PluginsUninstallRequest { + direct_source_id, + name: DIRECT_PLUGIN_NAME.to_string(), + }) + .await + .expect("uninstall direct plugin"); + + let after_uninstall = client + .rpc() + .plugins() + .list() + .await + .expect("list after uninstall"); + assert!( + !after_uninstall + .plugins + .iter() + .any(|plugin| plugin.name == DIRECT_PLUGIN_NAME) + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_list_browse_refresh_and_remove_local_marketplace() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_list_browse_refresh_and_remove_local_marketplace", + |ctx| { + Box::pin(async move { + let marketplace = create_local_marketplace_fixture(); + let client = ctx.start_client().await; + + let add = client + .rpc() + .plugins() + .marketplaces() + .add(PluginsMarketplacesAddRequest { + source: marketplace.source(), + working_directory: None, + }) + .await + .expect("add marketplace"); + assert_eq!(add.name, MARKETPLACE_NAME); + + let list = client + .rpc() + .plugins() + .marketplaces() + .list() + .await + .expect("list marketplaces"); + let mine: Vec<_> = list + .marketplaces + .iter() + .filter(|marketplace| marketplace.name == MARKETPLACE_NAME) + .collect(); + assert_eq!(mine.len(), 1, "expected local marketplace in {list:?}"); + assert_ne!(mine[0].is_default, Some(true)); + assert!( + list.marketplaces + .iter() + .any(|marketplace| marketplace.is_default == Some(true)) + ); + + let browse = client + .rpc() + .plugins() + .marketplaces() + .browse(PluginsMarketplacesBrowseRequest { + name: MARKETPLACE_NAME.to_string(), + }) + .await + .expect("browse marketplace"); + let advertised: Vec<_> = browse + .plugins + .iter() + .filter(|plugin| plugin.name == PLUGIN_NAME) + .collect(); + assert_eq!( + advertised.len(), + 1, + "expected advertised plugin in {browse:?}" + ); + assert!( + advertised[0] + .description + .as_deref() + .is_some_and(|description| !description.is_empty()) + ); + + let refresh = client + .rpc() + .plugins() + .marketplaces() + .refresh_with_params(PluginsMarketplacesRefreshRequest { + name: Some(MARKETPLACE_NAME.to_string()), + }) + .await + .expect("refresh marketplace"); + let refreshed: Vec<_> = refresh + .results + .iter() + .filter(|entry| entry.name == MARKETPLACE_NAME) + .collect(); + assert_eq!(refreshed.len(), 1, "expected refresh result in {refresh:?}"); + assert!(refreshed[0].success, "{:?}", refreshed[0].error); + + let remove = client + .rpc() + .plugins() + .marketplaces() + .remove(PluginsMarketplacesRemoveRequest { + force: None, + name: MARKETPLACE_NAME.to_string(), + }) + .await + .expect("remove marketplace"); + assert!(remove.removed); + + let after_remove = client + .rpc() + .plugins() + .marketplaces() + .list() + .await + .expect("list after remove"); + assert!( + !after_remove + .marketplaces + .iter() + .any(|marketplace| marketplace.name == MARKETPLACE_NAME) + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_reload_mcp_config_cache() { + super::support::with_dedicated_group_e2e_context( + &E2E, + "rpc_server_plugins", + "should_reload_mcp_config_cache", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + client + .rpc() + .mcp() + .config() + .reload() + .await + .expect("reload MCP config cache"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +struct LocalFixture { + dir: tempfile::TempDir, +} + +impl LocalFixture { + fn source(&self) -> String { + self.dir.path().to_string_lossy().to_string() + } +} + +fn create_local_marketplace_fixture() -> LocalFixture { + let dir = tempfile::Builder::new() + .prefix("copilot-e2e-mp-") + .tempdir() + .expect("create local marketplace fixture"); + let manifest = format!( + r#"{{ + "name": "{MARKETPLACE_NAME}", + "owner": {{ "name": "Copilot SDK E2E" }}, + "metadata": {{ "description": "Local marketplace fixture for SDK E2E tests." }}, + "plugins": [ + {{ + "name": "{PLUGIN_NAME}", + "source": "./{PLUGIN_NAME}", + "description": "E2E demo plugin advertised by the local marketplace.", + "version": "1.0.0" + }} + ] +}} +"# + ); + fs::write(dir.path().join("marketplace.json"), manifest).expect("write marketplace manifest"); + + let plugin_dir = dir.path().join(PLUGIN_NAME); + fs::create_dir_all(&plugin_dir).expect("create marketplace plugin directory"); + write_skill_file(&plugin_dir); + + LocalFixture { dir } +} + +fn create_direct_plugin_fixture() -> LocalFixture { + let dir = tempfile::Builder::new() + .prefix("copilot-e2e-plugin-") + .tempdir() + .expect("create direct plugin fixture"); + let manifest = format!( + r#"{{ + "name": "{DIRECT_PLUGIN_NAME}", + "description": "E2E demo plugin installed directly from a local path.", + "version": "1.0.0" +}} +"# + ); + fs::write(dir.path().join("plugin.json"), manifest).expect("write plugin manifest"); + write_skill_file(dir.path()); + + LocalFixture { dir } +} + +fn write_skill_file(plugin_dir: &Path) { + let skill = r#"--- +name: csharp-e2e-skill +description: A demo skill contributed by the E2E test plugin. +--- +# Demo Skill + +This skill exists so the plugin reports at least one installed skill. +"#; + fs::write(plugin_dir.join("SKILL.md"), skill).expect("write skill file"); +} + +fn single_plugin<'a>( + list: &'a PluginListResult, + name: &str, + marketplace: &str, +) -> &'a InstalledPluginInfo { + let matches: Vec<_> = list + .plugins + .iter() + .filter(|plugin| plugin.name == name && plugin.marketplace == marketplace) + .collect(); + assert_eq!(matches.len(), 1, "expected one plugin in {list:?}"); + matches[0] +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_server_plugins", 7); diff --git a/rust/tests/e2e/rpc_server_remote_control.rs b/rust/tests/e2e/rpc_server_remote_control.rs new file mode 100644 index 000000000..49809235c --- /dev/null +++ b/rust/tests/e2e/rpc_server_remote_control.rs @@ -0,0 +1,184 @@ +use github_copilot_sdk::SessionId; +use github_copilot_sdk::rpc::{ + RemoteControlConfig, SessionsSetRemoteControlSteeringRequest, + SessionsStartRemoteControlRequest, SessionsStopRemoteControlRequest, + SessionsTransferRemoteControlRequest, +}; +use serde_json::Value; + +#[tokio::test] +async fn should_report_remote_control_status_as_off() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_remote_control", + "should_report_remote_control_status_as_off", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .get_remote_control_status() + .await + .expect("get remote control status"); + + assert_status_off(&result.status); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_treat_set_steering_as_no_op_when_off() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_remote_control", + "should_treat_set_steering_as_no_op_when_off", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .set_remote_control_steering(SessionsSetRemoteControlSteeringRequest { + enabled: false, + }) + .await + .expect("set remote control steering"); + + assert_status_off(&result.status); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_report_not_stopped_when_remote_control_is_off() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_remote_control", + "should_report_not_stopped_when_remote_control_is_off", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .stop_remote_control() + .await + .expect("stop remote control"); + + assert!(!result.stopped); + assert_status_off(&result.status); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_reject_transfer_when_off_with_compare_and_swap() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_remote_control", + "should_reject_transfer_when_off_with_compare_and_swap", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .transfer_remote_control(SessionsTransferRemoteControlRequest { + expected_from_session_id: Some(format!( + "rc-from-{}", + uuid::Uuid::new_v4().simple() + )), + to_session_id: format!("rc-to-{}", uuid::Uuid::new_v4().simple()), + }) + .await + .expect("transfer remote control"); + + assert!(!result.transferred); + assert_status_off(&result.status); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_reach_runtime_when_starting_remote_control_for_unknown_session() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_server_remote_control", + "should_reach_runtime_when_starting_remote_control_for_unknown_session", + |ctx| { + Box::pin(async move { + let client = ctx.start_client().await; + + let result = client + .rpc() + .sessions() + .start_remote_control(SessionsStartRemoteControlRequest { + session_id: SessionId::from(format!( + "missing-session-{}", + uuid::Uuid::new_v4().simple() + )), + config: RemoteControlConfig { + existing_mc_session: None, + explicit: false, + remote: false, + silent: true, + steerable: false, + task_id: None, + }, + }) + .await; + + let _ = client + .rpc() + .sessions() + .stop_remote_control_with_params(SessionsStopRemoteControlRequest { + expected_session_id: None, + force: Some(true), + }) + .await; + + let err = result.expect_err("unknown session should fail"); + let message = err.to_string(); + assert_not_unhandled(&message); + let lower = message.to_ascii_lowercase(); + assert!( + lower.contains("session") || lower.contains("remote"), + "{message}" + ); + + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +fn assert_status_off(status: &Value) { + assert_eq!(status.get("state").and_then(Value::as_str), Some("off")); +} + +fn assert_not_unhandled(message: &str) { + assert!( + !message.to_ascii_lowercase().contains("unhandled method"), + "{message}" + ); +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_server_remote_control", 5); diff --git a/rust/tests/e2e/rpc_session_state.rs b/rust/tests/e2e/rpc_session_state.rs index 956a8c90e..c705d231c 100644 --- a/rust/tests/e2e/rpc_session_state.rs +++ b/rust/tests/e2e/rpc_session_state.rs @@ -1,31 +1,30 @@ use std::collections::HashMap; -use github_copilot_sdk::generated::SessionMode; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ AuthInfoType, HistoryTruncateRequest, LspInitializeRequest, MetadataContextInfoRequest, MetadataRecomputeContextTokensRequest, MetadataRecordContextChangeRequest, MetadataSetWorkingDirectoryRequest, MetadataSnapshotCurrentMode, ModeSetRequest, ModelSetReasoningEffortRequest, ModelSwitchToRequest, NameSetAutoRequest, NameSetRequest, - PermissionsSetApproveAllRequest, PlanUpdateRequest, SessionSetCredentialsParams, - SessionUpdateOptionsParams, SessionWorkingDirectoryContext, + PermissionsResetSessionApprovalsRequest, PermissionsSetApproveAllRequest, PlanUpdateRequest, + SessionSetCredentialsParams, SessionUpdateOptionsParams, SessionWorkingDirectoryContext, SessionWorkingDirectoryContextHostType, SessionsForkRequest, ShutdownRequest, TelemetrySetFeatureOverridesRequest, WorkspacesCreateFileRequest, WorkspacesReadFileRequest, }; -use github_copilot_sdk::generated::session_events::{ - SessionContextChangedData, SessionEventType, SessionShutdownData, SessionTitleChangedData, - SessionWorkspaceFileChangedData, ShutdownType, WorkspaceFileChangedOperation, +use github_copilot_sdk::session_events::{ + SessionContextChangedData, SessionEventType, SessionMode, SessionShutdownData, + SessionTitleChangedData, SessionWorkspaceFileChangedData, ShutdownType, + WorkspaceFileChangedOperation, }; use serde_json::json; -use super::support::{ - assistant_message_content, wait_for_condition, wait_for_event, with_e2e_context, -}; +use super::support::{assistant_message_content, wait_for_condition, wait_for_event}; const MODEL_ID: &str = "claude-sonnet-4.5"; #[tokio::test] async fn should_call_session_rpc_model_getcurrent() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_call_session_rpc_model_getcurrent", |ctx| { @@ -55,7 +54,8 @@ async fn should_call_session_rpc_model_getcurrent() { #[tokio::test] async fn should_call_session_rpc_model_switchto() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "rpc_session_state", "should_call_session_rpc_model_switchto", |ctx| { @@ -63,23 +63,39 @@ async fn should_call_session_rpc_model_switchto() { ctx.set_default_copilot_user(); let client = ctx.start_client().await; let session = client - .create_session(ctx.approve_all_session_config()) + .create_session(ctx.approve_all_session_config().with_model(MODEL_ID)) .await .expect("create session"); + let before = session + .rpc() + .model() + .get_current() + .await + .expect("get current model before switch"); + assert!(before.model_id.is_some(), "expected a model before switch"); + let switched = session .rpc() .model() .switch_to(ModelSwitchToRequest { - model_id: MODEL_ID.to_string(), - reasoning_effort: Some("none".to_string()), + model_id: "gpt-5.4".to_string(), + reasoning_effort: Some("high".to_string()), model_capabilities: None, reasoning_summary: None, ..Default::default() }) .await .expect("switch model"); - assert_eq!(switched.model_id.as_deref(), Some(MODEL_ID)); + assert_eq!(switched.model_id.as_deref(), Some("gpt-5.4")); + + let after = session + .rpc() + .model() + .get_current() + .await + .expect("get current model after switch"); + assert_eq!(after.model_id.as_deref(), Some("gpt-5.4")); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -91,7 +107,8 @@ async fn should_call_session_rpc_model_switchto() { #[tokio::test] async fn should_get_and_set_session_mode() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_get_and_set_session_mode", |ctx| { @@ -130,7 +147,8 @@ async fn should_get_and_set_session_mode() { #[tokio::test] async fn should_shutdown_session_with_routine_type() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_shutdown_session_with_routine_type", |ctx| { @@ -168,7 +186,8 @@ async fn should_shutdown_session_with_routine_type() { #[tokio::test] async fn should_set_and_get_each_session_mode_value() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_set_and_get_each_session_mode_value", |ctx| { @@ -204,7 +223,8 @@ async fn should_set_and_get_each_session_mode_value() { #[tokio::test] async fn should_read_update_and_delete_plan() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_read_update_and_delete_plan", |ctx| { @@ -269,7 +289,8 @@ async fn should_read_update_and_delete_plan() { #[tokio::test] async fn should_call_workspace_file_rpc_methods() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_call_workspace_file_rpc_methods", |ctx| { @@ -326,7 +347,8 @@ async fn should_call_workspace_file_rpc_methods() { #[tokio::test] async fn should_reject_workspace_file_path_traversal() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_reject_workspace_file_path_traversal", |ctx| { @@ -370,7 +392,8 @@ async fn should_reject_workspace_file_path_traversal() { #[tokio::test] async fn should_create_workspace_file_with_nested_path_auto_creating_dirs() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_create_workspace_file_with_nested_path_auto_creating_dirs", |ctx| { @@ -412,7 +435,8 @@ async fn should_create_workspace_file_with_nested_path_auto_creating_dirs() { #[tokio::test] async fn should_report_error_reading_nonexistent_workspace_file() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_report_error_reading_nonexistent_workspace_file", |ctx| { @@ -445,7 +469,8 @@ async fn should_report_error_reading_nonexistent_workspace_file() { #[tokio::test] async fn should_update_existing_workspace_file_with_update_operation() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_update_existing_workspace_file_with_update_operation", |ctx| { @@ -500,7 +525,8 @@ async fn should_update_existing_workspace_file_with_update_operation() { #[tokio::test] async fn should_reject_empty_or_whitespace_session_name() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_reject_empty_or_whitespace_session_name", |ctx| { @@ -535,7 +561,8 @@ async fn should_reject_empty_or_whitespace_session_name() { #[tokio::test] async fn should_emit_title_changed_event_each_time_name_set_is_called() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_emit_title_changed_event_each_time_name_set_is_called", |ctx| { @@ -586,7 +613,8 @@ async fn should_emit_title_changed_event_each_time_name_set_is_called() { #[tokio::test] async fn should_get_and_set_session_metadata() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_call_metadata_snapshot_setworkingdirectory_and_recordcontextchange", |ctx| { @@ -635,7 +663,8 @@ async fn should_get_and_set_session_metadata() { #[tokio::test] async fn should_call_metadata_snapshot_setworkingdirectory_and_recordcontextchange() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_get_and_set_session_metadata", |ctx| { @@ -691,7 +720,7 @@ async fn should_call_metadata_snapshot_setworkingdirectory_and_recordcontextchan cwd: subdir.display().to_string(), git_root: Some(ctx.repo_root().display().to_string()), head_commit: None, - host_type: Some(SessionWorkingDirectoryContextHostType::Github), + host_type: Some(SessionWorkingDirectoryContextHostType::GitHub), repository: Some("github/copilot-sdk".to_string()), repository_host: Some("github.com".to_string()), }, @@ -715,7 +744,8 @@ async fn should_call_metadata_snapshot_setworkingdirectory_and_recordcontextchan #[tokio::test] async fn should_update_options_and_initialize_session_services() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_update_options_and_initialize_session_services", |ctx| { @@ -780,7 +810,8 @@ async fn should_update_options_and_initialize_session_services() { #[tokio::test] async fn should_set_reasoningeffort_and_auto_name() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_set_reasoningeffort_and_auto_name", |ctx| { @@ -838,51 +869,57 @@ async fn should_set_reasoningeffort_and_auto_name() { #[tokio::test] async fn should_set_auth_credentials() { - with_e2e_context("rpc_session_state", "should_set_auth_credentials", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let token = "rpc-session-auth-token"; - ctx.set_copilot_user_by_token_with_login(token, "rpc-session-user"); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - - let set = session - .rpc() - .auth() - .set_credentials(SessionSetCredentialsParams { - credentials: Some(json!({ - "type": "user", - "host": "github.com", - "login": "rpc-session-user" - })), - }) - .await - .expect("set credentials"); - assert!(set.success); - let status = session - .rpc() - .auth() - .get_status() - .await - .expect("auth status"); - assert!(status.is_authenticated); - assert_eq!(status.auth_type, Some(AuthInfoType::User)); - assert_eq!(status.host.as_deref(), Some("github.com")); - assert_eq!(status.login.as_deref(), Some("rpc-session-user")); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state", + "should_set_auth_credentials", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let token = "rpc-session-auth-token"; + ctx.set_copilot_user_by_token_with_login(token, "rpc-session-user"); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let set = session + .rpc() + .git_hub_auth() + .set_credentials(SessionSetCredentialsParams { + credentials: Some(json!({ + "type": "user", + "host": "github.com", + "login": "rpc-session-user" + })), + }) + .await + .expect("set credentials"); + assert!(set.success); + let status = session + .rpc() + .git_hub_auth() + .get_status() + .await + .expect("auth status"); + assert!(status.is_authenticated); + assert_eq!(status.auth_type, Some(AuthInfoType::User)); + assert_eq!(status.host.as_deref(), Some("github.com")); + assert_eq!(status.login.as_deref(), Some("rpc-session-user")); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_fork_session_with_persisted_messages() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_fork_session_with_persisted_messages", |ctx| { @@ -940,7 +977,8 @@ async fn should_fork_session_with_persisted_messages() { #[tokio::test] async fn should_report_error_when_forking_session_to_unknown_event_id() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_report_error_when_forking_session_to_unknown_event_id", |ctx| { @@ -976,7 +1014,8 @@ async fn should_report_error_when_forking_session_to_unknown_event_id() { #[tokio::test] async fn should_call_session_usage_and_permission_rpcs() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_call_session_usage_and_permission_rpcs", |ctx| { @@ -1007,7 +1046,7 @@ async fn should_call_session_usage_and_permission_rpcs() { session .rpc() .permissions() - .reset_session_approvals() + .reset_session_approvals(PermissionsResetSessionApprovalsRequest::default()) .await .expect("reset approvals") .success @@ -1023,7 +1062,8 @@ async fn should_call_session_usage_and_permission_rpcs() { #[tokio::test] async fn should_report_implemented_errors_for_unsupported_session_rpc_paths() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", "should_report_implemented_errors_for_unsupported_session_rpc_paths", |ctx| { @@ -1058,10 +1098,11 @@ async fn should_report_implemented_errors_for_unsupported_session_rpc_paths() { } #[tokio::test] -async fn should_compact_session_history_after_messages() { - with_e2e_context( +async fn should_report_processing_and_context_metadata() { + super::support::with_shared_e2e_context( + &E2E, "rpc_session_state", - "should_compact_session_history_after_messages", + "should_report_processing_and_context_metadata", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); @@ -1165,3 +1206,5 @@ fn assistant_message_content_if_present( None } } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_session_state", 22); diff --git a/rust/tests/e2e/rpc_session_state_extras.rs b/rust/tests/e2e/rpc_session_state_extras.rs new file mode 100644 index 000000000..f43359f0b --- /dev/null +++ b/rust/tests/e2e/rpc_session_state_extras.rs @@ -0,0 +1,569 @@ +use std::collections::HashMap; + +use github_copilot_sdk::Client; +use github_copilot_sdk::rpc::{ + CompletionsRequestRequest, MetadataContextHeaviestMessagesRequest, ModelSwitchToRequest, + NamedProviderConfig, PermissionsSetAllowAllRequest, ProviderAddRequest, ProviderConfigType, + ProviderConfigWireApi, ProviderModelConfig, SessionVisibilityStatus, SubagentSettingsEntry, + SubagentSettingsEntryContextTier, UpdateSubagentSettingsRequest, + UpdateSubagentSettingsRequestSubagents, VisibilitySetRequest, +}; + +use super::support::{assistant_message_content, with_e2e_context}; + +const MODEL_ID: &str = "claude-sonnet-4.5"; + +#[tokio::test] +async fn should_list_models_for_session() { + with_e2e_context( + "rpc_session_state_extras", + "should_list_models_for_session", + |ctx| { + Box::pin(async move { + let token = "rpc-session-model-list-token"; + ctx.set_copilot_user_by_token_with_login(token, "rpc-session-extras-user"); + let client = Client::start(ctx.client_options_with_github_token(token)) + .await + .expect("start authenticated client"); + let session = client + .create_session( + ctx.approve_all_session_config() + .with_github_token(token) + .with_model(MODEL_ID), + ) + .await + .expect("create session"); + + let result = session.rpc().model().list().await.expect("list models"); + + assert!(!result.list.is_empty()); + assert!( + result + .list + .iter() + .any(|model| model.to_string().contains(MODEL_ID)) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_report_session_activity_when_idle() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_report_session_activity_when_idle", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let activity = session + .rpc() + .metadata() + .activity() + .await + .expect("get activity"); + + assert!(!activity.has_active_work); + assert!(!activity.abortable); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_get_and_set_allowall_permissions() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_get_and_set_allowall_permissions", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let initial = session + .rpc() + .permissions() + .get_allow_all() + .await + .expect("get initial allow-all"); + assert!(!initial.enabled); + + let enable = session + .rpc() + .permissions() + .set_allow_all(PermissionsSetAllowAllRequest { + enabled: Some(true), + mode: None, + model: None, + source: None, + }) + .await + .expect("enable allow-all"); + assert!(enable.success); + assert!(enable.enabled); + assert!( + session + .rpc() + .permissions() + .get_allow_all() + .await + .expect("get enabled allow-all") + .enabled + ); + + let disable = session + .rpc() + .permissions() + .set_allow_all(PermissionsSetAllowAllRequest { + enabled: Some(false), + mode: None, + model: None, + source: None, + }) + .await + .expect("disable allow-all"); + assert!(disable.success); + assert!(!disable.enabled); + assert!( + !session + .rpc() + .permissions() + .get_allow_all() + .await + .expect("get disabled allow-all") + .enabled + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_read_empty_sql_todos_for_fresh_session() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_read_empty_sql_todos_for_fresh_session", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let result = session + .rpc() + .plan() + .read_sql_todos() + .await + .expect("read SQL todos"); + + assert!(result.rows.is_empty()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_get_telemetry_engagement_id() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_get_telemetry_engagement_id", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let _result = session + .rpc() + .telemetry() + .get_engagement_id() + .await + .expect("get telemetry engagement id"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_get_current_tool_metadata_after_initialization() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_get_current_tool_metadata_after_initialization", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let answer = session + .send_and_wait("What is 2+2?") + .await + .expect("send prompt") + .expect("assistant message"); + assert!(!assistant_message_content(&answer).trim().is_empty()); + + let result = session + .rpc() + .tools() + .get_current_metadata() + .await + .expect("get current tool metadata"); + + let tools = result.tools.expect("current tool metadata"); + assert!(!tools.is_empty()); + assert!(tools.iter().all(|tool| !tool.name.trim().is_empty())); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_add_byok_provider_and_model_at_runtime() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_add_byok_provider_and_model_at_runtime", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let result = session + .rpc() + .provider() + .add(ProviderAddRequest { + providers: Some(vec![NamedProviderConfig { + api_key: Some("provider-key".to_string()), + azure: None, + base_url: "https://models.example.test/v1".to_string(), + bearer_token: None, + has_bearer_token_provider: None, + headers: Some(HashMap::from([( + "x-provider".to_string(), + "rust".to_string(), + )])), + name: "rust-e2e-provider".to_string(), + transport: None, + r#type: Some(ProviderConfigType::Openai), + wire_api: Some(ProviderConfigWireApi::Completions), + }]), + models: Some(vec![ProviderModelConfig { + capabilities: None, + id: "small".to_string(), + max_context_window_tokens: None, + max_output_tokens: None, + max_prompt_tokens: Some(4096.0), + model_id: None, + name: Some("Rust Added Model".to_string()), + provider: "rust-e2e-provider".to_string(), + wire_model: None, + }]), + }) + .await + .expect("add provider model"); + assert_eq!(result.models.len(), 1); + + let selection_id = "rust-e2e-provider/small"; + session + .rpc() + .model() + .switch_to(ModelSwitchToRequest { + context_tier: None, + defer_if_model_change_queued: None, + model_capabilities: None, + model_id: selection_id.to_string(), + reasoning_effort: None, + reasoning_summary: None, + verbosity: None, + }) + .await + .expect("switch to added model"); + let current = session + .rpc() + .model() + .get_current() + .await + .expect("get current model"); + assert_eq!(current.model_id.as_deref(), Some(selection_id)); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_return_empty_completions_when_host_does_not_provide_them() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_return_empty_completions_when_host_does_not_provide_them", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let result = session + .rpc() + .completions() + .request(CompletionsRequestRequest { + offset: 5, + text: "Use @ to mention context".to_string(), + }) + .await + .expect("request completions"); + assert!(result.items.is_empty()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_report_visibility_as_unsynced_for_local_session() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_report_visibility_as_unsynced_for_local_session", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let set = session + .rpc() + .visibility() + .set(VisibilitySetRequest { + status: SessionVisibilityStatus::Unshared, + }) + .await + .expect("set visibility"); + assert!(!set.synced); + assert!(set.status.is_none()); + assert!(set.share_url.is_none()); + let get = session + .rpc() + .visibility() + .get() + .await + .expect("get visibility"); + assert!(!get.synced); + assert!(get.status.is_none()); + assert!(get.share_url.is_none()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_get_context_attribution_and_heaviest_messages_after_turn() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_get_context_attribution_and_heaviest_messages_after_turn", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let answer = session + .send_and_wait("Say CONTEXT_METADATA_OK exactly.") + .await + .expect("send prompt") + .expect("assistant message"); + assert!(assistant_message_content(&answer).contains("CONTEXT_METADATA_OK")); + + let attribution = session + .rpc() + .metadata() + .get_context_attribution() + .await + .expect("get context attribution"); + assert!(attribution.context_attribution.is_some()); + let heaviest = session + .rpc() + .metadata() + .get_context_heaviest_messages(MetadataContextHeaviestMessagesRequest { + limit: Some(5), + }) + .await + .expect("get heaviest messages"); + assert!(heaviest.total_tokens >= 0); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_update_and_clear_live_subagent_settings() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_update_and_clear_live_subagent_settings", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + session + .rpc() + .tools() + .update_subagent_settings(UpdateSubagentSettingsRequest { + subagents: Some(UpdateSubagentSettingsRequestSubagents { + agents: Some(HashMap::from([( + "general-purpose".to_string(), + SubagentSettingsEntry { + context_tier: Some( + SubagentSettingsEntryContextTier::LongContext, + ), + effort_level: Some("low".to_string()), + model: Some("gpt-5-mini".to_string()), + }, + )])), + disabled_subagents: Some(vec!["legacy-agent".to_string()]), + max_concurrency: None, + max_depth: None, + }), + }) + .await + .expect("update subagent settings"); + session + .rpc() + .tools() + .update_subagent_settings(UpdateSubagentSettingsRequest { subagents: None }) + .await + .expect("clear subagent settings"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_reload_session_plugins() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_session_state_extras", + "should_reload_session_plugins", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + session + .rpc() + .plugins() + .reload() + .await + .expect("reload session plugins"); + + let plugins = session + .rpc() + .plugins() + .list() + .await + .expect("list session plugins"); + assert!( + plugins + .plugins + .iter() + .all(|plugin| !plugin.name.trim().is_empty()) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_session_state_extras", 11); diff --git a/rust/tests/e2e/rpc_shell_and_fleet.rs b/rust/tests/e2e/rpc_shell_and_fleet.rs index eb389421a..968d51147 100644 --- a/rust/tests/e2e/rpc_shell_and_fleet.rs +++ b/rust/tests/e2e/rpc_shell_and_fleet.rs @@ -1,10 +1,11 @@ -use github_copilot_sdk::generated::api_types::{ShellExecRequest, ShellKillRequest}; +use github_copilot_sdk::rpc::{ShellExecRequest, ShellKillRequest}; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn should_execute_shell_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_and_fleet", "should_execute_shell_command", |ctx| { @@ -41,42 +42,47 @@ async fn should_execute_shell_command() { #[tokio::test] async fn should_kill_shell_process() { - with_e2e_context("rpc_shell_and_fleet", "should_kill_shell_process", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "rpc_shell_and_fleet", + "should_kill_shell_process", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - let exec = session - .rpc() - .shell() - .exec(ShellExecRequest { - command: long_running_command(), - cwd: Some(ctx.work_dir().display().to_string()), - timeout: None, - }) - .await - .expect("start shell process"); - assert!(!exec.process_id.trim().is_empty()); + let exec = session + .rpc() + .shell() + .exec(ShellExecRequest { + command: long_running_command(), + cwd: Some(ctx.work_dir().display().to_string()), + timeout: None, + }) + .await + .expect("start shell process"); + assert!(!exec.process_id.trim().is_empty()); - let killed = session - .rpc() - .shell() - .kill(ShellKillRequest { - process_id: exec.process_id, - signal: None, - }) - .await - .expect("kill shell process"); - assert!(killed.killed); + let killed = session + .rpc() + .shell() + .kill(ShellKillRequest { + process_id: exec.process_id, + signal: None, + }) + .await + .expect("kill shell process"); + assert!(killed.killed); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } @@ -113,3 +119,5 @@ fn long_running_command() -> String { fn long_running_command() -> String { "sleep 30".to_string() } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_shell_and_fleet", 2); diff --git a/rust/tests/e2e/rpc_shell_edge_cases.rs b/rust/tests/e2e/rpc_shell_edge_cases.rs index a94bc1007..df5ddb1dc 100644 --- a/rust/tests/e2e/rpc_shell_edge_cases.rs +++ b/rust/tests/e2e/rpc_shell_edge_cases.rs @@ -1,19 +1,20 @@ use std::path::Path; +use std::time::Duration; -use github_copilot_sdk::generated::api_types::{ - ShellExecRequest, ShellKillRequest, ShellKillSignal, -}; +use github_copilot_sdk::rpc::{ShellExecRequest, ShellKillRequest, ShellKillSignal}; -use super::support::{wait_for_condition, with_e2e_context}; +use super::support::wait_for_condition; #[tokio::test] async fn shell_exec_with_timeout_kills_long_running_command() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_exec_with_timeout_kills_long_running_command", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); + let timeout = shell_timeout(); let started_path = ctx.work_dir().join("shell-timeout-started.txt"); let marker_path = ctx.work_dir().join("shell-timeout-marker.txt"); let client = ctx.start_client().await; @@ -28,13 +29,20 @@ async fn shell_exec_with_timeout_kills_long_running_command() { .exec(ShellExecRequest { command: delayed_write_command(&started_path, &marker_path), cwd: Some(ctx.work_dir().display().to_string()), - timeout: Some(200), + timeout: Some( + timeout + .as_millis() + .try_into() + .expect("shell timeout fits in i64"), + ), }) .await .expect("execute timed command"); assert!(!result.process_id.trim().is_empty()); wait_for_exists(&started_path).await; + // The cleanup probe should not terminate a process before its timeout expires. + tokio::time::sleep(timeout).await; wait_for_process_cleanup(&session, result.process_id, "timed-out command").await; assert!( !marker_path.exists(), @@ -51,7 +59,8 @@ async fn shell_exec_with_timeout_kills_long_running_command() { #[tokio::test] async fn shell_exec_with_custom_cwd_honors_override() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_exec_with_custom_cwd_honors_override", |ctx| { @@ -90,7 +99,8 @@ async fn shell_exec_with_custom_cwd_honors_override() { #[tokio::test] async fn shell_exec_with_nonexistent_command_returns_processid_and_cleans_up() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_exec_with_nonexistent_command_returns_processid_and_cleans_up", |ctx| { @@ -126,7 +136,8 @@ async fn shell_exec_with_nonexistent_command_returns_processid_and_cleans_up() { #[tokio::test] async fn shell_kill_unknown_processid_returns_false() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_kill_unknown_processid_returns_false", |ctx| { @@ -160,7 +171,8 @@ async fn shell_kill_unknown_processid_returns_false() { #[tokio::test] async fn shell_kill_cleans_up_after_terminating_signal() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_kill_cleans_up_after_terminating_signal", |ctx| { @@ -205,7 +217,8 @@ async fn shell_kill_cleans_up_after_terminating_signal() { #[tokio::test] async fn shell_exec_with_stderr_output_cleans_up() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_exec_with_stderr_output_cleans_up", |ctx| { @@ -242,7 +255,8 @@ async fn shell_exec_with_stderr_output_cleans_up() { #[tokio::test] async fn shell_exec_with_large_stdout_cleans_up() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_shell_edge_cases", "shell_exec_with_large_stdout_cleans_up", |ctx| { @@ -318,6 +332,11 @@ fn delayed_write_command(started_path: &Path, marker_path: &Path) -> String { ) } +#[cfg(windows)] +fn shell_timeout() -> Duration { + Duration::from_secs(2) +} + #[cfg(not(windows))] fn delayed_write_command(started_path: &Path, marker_path: &Path) -> String { format!( @@ -327,6 +346,11 @@ fn delayed_write_command(started_path: &Path, marker_path: &Path) -> String { ) } +#[cfg(not(windows))] +fn shell_timeout() -> Duration { + Duration::from_millis(200) +} + #[cfg(windows)] fn write_relative_marker_command(marker: &str) -> String { format!( @@ -390,3 +414,5 @@ fn large_stdout_command(marker_path: &Path) -> String { marker_path.display() ) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_shell_edge_cases", 7); diff --git a/rust/tests/e2e/rpc_shell_user_requested.rs b/rust/tests/e2e/rpc_shell_user_requested.rs new file mode 100644 index 000000000..43de1c2cc --- /dev/null +++ b/rust/tests/e2e/rpc_shell_user_requested.rs @@ -0,0 +1,177 @@ +use std::path::Path; +use std::sync::Arc; +use std::time::Duration; + +use github_copilot_sdk::RequestId; +use github_copilot_sdk::rpc::{ShellCancelUserRequestedRequest, ShellExecuteUserRequestedRequest}; + +use super::support::wait_for_condition; + +#[tokio::test] +async fn should_execute_user_requested_shell_command() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_shell_user_requested", + "should_execute_user_requested_shell_command", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let marker = format!("copilotusershell{}", uuid::Uuid::new_v4().simple()); + let request_id = RequestId::new(format!("req-{}", uuid::Uuid::new_v4().simple())); + + let result = session + .rpc() + .shell() + .execute_user_requested(ShellExecuteUserRequestedRequest { + request_id, + command: format!("echo {marker}"), + }) + .await + .expect("execute user-requested shell command"); + + assert!( + result.success, + "expected shell command to succeed: {:?}", + result.error + ); + assert_eq!(result.exit_code, Some(0)); + assert!(result.output.contains(&marker)); + assert!(!result.tool_call_id.trim().is_empty()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_cancel_user_requested_shell_command() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_shell_user_requested", + "should_cancel_user_requested_shell_command", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = Arc::new( + client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"), + ); + + let missing = session + .rpc() + .shell() + .cancel_user_requested(ShellCancelUserRequestedRequest { + request_id: RequestId::new(format!( + "missing-{}", + uuid::Uuid::new_v4().simple() + )), + }) + .await + .expect("cancel missing request"); + assert!(!missing.cancelled); + + let request_id = RequestId::new(format!("req-{}", uuid::Uuid::new_v4().simple())); + let marker_dir = tempfile::Builder::new() + .prefix("shell-cancel-") + .tempdir() + .expect("create shell cancel marker directory"); + let marker_path = marker_dir.path().join("marker.txt"); + let command = create_marker_then_sleep_command(&marker_path, 60); + let execute_session = Arc::clone(&session); + let execute_request_id = request_id.clone(); + let mut execute_task = tokio::spawn(async move { + execute_session + .rpc() + .shell() + .execute_user_requested(ShellExecuteUserRequestedRequest { + request_id: execute_request_id, + command, + }) + .await + }); + + wait_for_file_text(&marker_path, "running").await; + wait_for_condition("user-requested shell command cancellation", || { + let session = Arc::clone(&session); + let request_id = request_id.clone(); + async move { + session + .rpc() + .shell() + .cancel_user_requested(ShellCancelUserRequestedRequest { request_id }) + .await + .expect("cancel running request") + .cancelled + } + }) + .await; + + // Await the spawned task by mutable reference so a timeout can abort it instead of + // dropping the handle. A dropped JoinHandle detaches the task, leaving the shell + // command running in the background where it can keep file handles open and + // destabilize later tests. + let result = + match tokio::time::timeout(Duration::from_secs(30), &mut execute_task).await { + Ok(joined) => joined + .expect("shell execution task should not panic") + .expect("execute user-requested shell command"), + Err(_elapsed) => { + execute_task.abort(); + panic!("cancelled shell command did not finish within 30s"); + } + }; + assert!(!result.success); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +async fn wait_for_file_text(path: &Path, expected: &'static str) { + wait_for_condition("shell marker text", || async { + std::fs::read_to_string(path).is_ok_and(|content| content.contains(expected)) + }) + .await; +} + +#[cfg(windows)] +fn create_marker_then_sleep_command(marker_path: &Path, seconds: u64) -> String { + format!( + "Set-Content -LiteralPath {} -Value 'running'; Start-Sleep -Seconds {seconds}", + powershell_quote(marker_path) + ) +} + +#[cfg(not(windows))] +fn create_marker_then_sleep_command(marker_path: &Path, seconds: u64) -> String { + format!( + "echo running > {}; sleep {seconds}", + posix_shell_quote(marker_path) + ) +} + +#[cfg(windows)] +fn powershell_quote(path: &Path) -> String { + format!("'{}'", path.display().to_string().replace('\'', "''")) +} + +#[cfg(not(windows))] +fn posix_shell_quote(path: &Path) -> String { + format!("'{}'", path.display().to_string().replace('\'', "'\\''")) +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_shell_user_requested", 2); diff --git a/rust/tests/e2e/rpc_tasks_and_handlers.rs b/rust/tests/e2e/rpc_tasks_and_handlers.rs index 7c6668ddc..b046687f4 100644 --- a/rust/tests/e2e/rpc_tasks_and_handlers.rs +++ b/rust/tests/e2e/rpc_tasks_and_handlers.rs @@ -1,5 +1,11 @@ -use github_copilot_sdk::generated::api_types::{ - CommandsHandlePendingCommandRequest, HandlePendingToolCallRequest, PermissionDecision, +use std::collections::HashMap; + +use github_copilot_sdk::rpc::{ + CommandsHandlePendingCommandRequest, HandlePendingToolCallRequest, + McpHeadersHandlePendingHeadersRefreshRequest, + McpHeadersHandlePendingHeadersRefreshRequestHeaders, + McpHeadersHandlePendingHeadersRefreshRequestHeadersKind, + McpHeadersHandlePendingHeadersRefreshRequestRequest, PermissionDecision, PermissionDecisionApproveForLocation, PermissionDecisionApproveForLocationApproval, PermissionDecisionApproveForLocationApprovalCustomTool, PermissionDecisionApproveForLocationApprovalCustomToolKind, @@ -16,15 +22,15 @@ use github_copilot_sdk::generated::api_types::{ UIElicitationResponse, UIElicitationResponseAction, UIExitPlanModeResponse, UIHandlePendingAutoModeSwitchRequest, UIHandlePendingElicitationRequest, UIHandlePendingExitPlanModeRequest, UIHandlePendingSamplingRequest, - UIHandlePendingUserInputRequest, UIUnregisterDirectAutoModeSwitchHandlerRequest, - UIUserInputResponse, + UIHandlePendingSessionLimitsExhaustedRequest, UIHandlePendingUserInputRequest, + UISessionLimitsExhaustedResponse, UISessionLimitsExhaustedResponseAction, + UIUnregisterDirectAutoModeSwitchHandlerRequest, UIUserInputResponse, }; -use super::support::with_e2e_context; - #[tokio::test] async fn should_list_task_state_and_return_false_for_missing_task_operations() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_tasks_and_handlers", "should_list_task_state_and_return_false_for_missing_task_operations", |ctx| { @@ -138,7 +144,8 @@ async fn should_list_task_state_and_return_false_for_missing_task_operations() { #[tokio::test] async fn should_report_implemented_error_for_missing_task_agent_type() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_tasks_and_handlers", "should_report_implemented_error_for_missing_task_agent_type", |ctx| { @@ -175,7 +182,8 @@ async fn should_report_implemented_error_for_missing_task_agent_type() { #[tokio::test] async fn should_report_implemented_error_for_invalid_task_agent_model() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_tasks_and_handlers", "should_report_implemented_error_for_invalid_task_agent_model", |ctx| { @@ -222,7 +230,7 @@ async fn should_report_implemented_error_for_invalid_task_agent_model() { #[tokio::test] async fn should_return_expected_results_for_missing_pending_handler_requestids() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "rpc_tasks_and_handlers", "should_return_expected_results_for_missing_pending_handler_requestids", |ctx| { @@ -315,6 +323,7 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() response: UIExitPlanModeResponse { approved: false, auto_approve_edits: None, + defer_implementation: None, feedback: Some("not now".to_string()), selected_action: None, }, @@ -323,6 +332,23 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() .expect("handle missing exit plan"); assert!(!exit_plan.success); + let session_limits = session + .rpc() + .ui() + .handle_pending_session_limits_exhausted( + UIHandlePendingSessionLimitsExhaustedRequest { + request_id: "missing-session-limits-request".into(), + response: UISessionLimitsExhaustedResponse { + action: UISessionLimitsExhaustedResponseAction::Unset, + additional_ai_credits: None, + max_ai_credits: None, + }, + }, + ) + .await + .expect("handle missing session limits exhausted"); + assert!(!session_limits.success); + for (request_id, result) in [ ( "missing-permission-request", @@ -334,6 +360,7 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() ( "missing-approve-once-request", PermissionDecision::ApproveOnce(PermissionDecisionApproveOnce { + approved_interactively: None, kind: PermissionDecisionApproveOnceKind::ApproveOnce, }), ), @@ -377,6 +404,7 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() .rpc() .permissions() .handle_pending_permission_request(PermissionDecisionRequest { + decision_context: None, request_id: request_id.into(), result, }) @@ -385,6 +413,28 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() assert!(!permission.success, "{request_id} should not be handled"); } + let headers_refresh = session + .rpc() + .mcp() + .headers() + .handle_pending_headers_refresh_request( + McpHeadersHandlePendingHeadersRefreshRequestRequest { + request_id: "missing-headers-refresh-request".into(), + result: McpHeadersHandlePendingHeadersRefreshRequest::Headers( + McpHeadersHandlePendingHeadersRefreshRequestHeaders { + headers: HashMap::from([( + "x-refresh".to_string(), + "missing".to_string(), + )]), + kind: McpHeadersHandlePendingHeadersRefreshRequestHeadersKind::Headers, + }, + ), + }, + ) + .await + .expect("handle missing headers refresh"); + assert!(!headers_refresh.success); + session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); }) @@ -395,7 +445,8 @@ async fn should_return_expected_results_for_missing_pending_handler_requestids() #[tokio::test] async fn should_register_and_unregister_direct_auto_mode_switch_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_tasks_and_handlers", "should_register_and_unregister_direct_auto_mode_switch_handler", |ctx| { @@ -455,3 +506,5 @@ fn assert_implemented_error(result: Result, met "expected implemented error for {method}, got {message}" ); } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_tasks_and_handlers", 5); diff --git a/rust/tests/e2e/rpc_ui_ephemeral_query.rs b/rust/tests/e2e/rpc_ui_ephemeral_query.rs new file mode 100644 index 000000000..2fa421cc6 --- /dev/null +++ b/rust/tests/e2e/rpc_ui_ephemeral_query.rs @@ -0,0 +1,39 @@ +use github_copilot_sdk::rpc::UIEphemeralQueryRequest; + +#[tokio::test] +async fn should_answer_ephemeral_query() { + super::support::with_shared_e2e_context( + &E2E, + "rpc_ui_ephemeral_query", + "should_answer_ephemeral_query", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let mut request = UIEphemeralQueryRequest::default(); + request.question = + "In one word, what is the primary color of a clear daytime sky?".to_string(); + let result = session + .rpc() + .ui() + .ephemeral_query(request) + .await + .expect("answer ephemeral query"); + + assert!(!result.answer.trim().is_empty()); + assert!(result.answer.to_ascii_lowercase().contains("blue")); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_ui_ephemeral_query", 1); diff --git a/rust/tests/e2e/rpc_workspace_checkpoints.rs b/rust/tests/e2e/rpc_workspace_checkpoints.rs index ccf70e2cd..48145970c 100644 --- a/rust/tests/e2e/rpc_workspace_checkpoints.rs +++ b/rust/tests/e2e/rpc_workspace_checkpoints.rs @@ -1,16 +1,15 @@ use std::path::Path; use std::process::Command; -use github_copilot_sdk::generated::api_types::{ +use github_copilot_sdk::rpc::{ WorkspaceDiffFileChangeType, WorkspaceDiffMode, WorkspacesDiffRequest, WorkspacesReadCheckpointRequest, WorkspacesReadFileRequest, WorkspacesSaveLargePasteRequest, }; -use super::support::with_e2e_context; - #[tokio::test] async fn should_list_no_checkpoints_for_fresh_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_workspace_checkpoints", "should_list_no_checkpoints_for_fresh_session", |ctx| { @@ -40,7 +39,16 @@ async fn should_list_no_checkpoints_for_fresh_session() { #[tokio::test] async fn should_return_null_or_empty_content_for_unknown_checkpoint() { - with_e2e_context( + if super::support::skip_shared_e2e_inprocess( + &E2E, + "readCheckpoint decodes the id as u32 in-process", + ) + .await + { + return; + } + super::support::with_shared_e2e_context( + &E2E, "rpc_workspace_checkpoints", "should_return_null_or_empty_content_for_unknown_checkpoint", |ctx| { @@ -70,7 +78,8 @@ async fn should_return_null_or_empty_content_for_unknown_checkpoint() { #[tokio::test] async fn should_return_typed_workspace_diff_result() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_workspace_checkpoints", "should_return_typed_workspace_diff_result", |ctx| { @@ -90,6 +99,7 @@ async fn should_return_typed_workspace_diff_result() { .workspaces() .diff(WorkspacesDiffRequest { mode: WorkspaceDiffMode::Unstaged, + ..Default::default() }) .await .expect("workspace diff"); @@ -121,7 +131,8 @@ async fn should_return_typed_workspace_diff_result() { #[tokio::test] async fn should_save_large_paste_and_expose_readable_content() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "rpc_workspace_checkpoints", "should_save_large_paste_and_expose_readable_content", |ctx| { @@ -181,3 +192,5 @@ fn init_git_repository(path: &Path) { .expect("run git init"); assert!(status.success(), "git init should succeed"); } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("rpc_workspace_checkpoints", 4); diff --git a/rust/tests/e2e/session.rs b/rust/tests/e2e/session.rs index 67ee48489..e2ca76c47 100644 --- a/rust/tests/e2e/session.rs +++ b/rust/tests/e2e/session.rs @@ -2,56 +2,63 @@ use std::collections::HashMap; use std::sync::Arc; use std::time::Duration; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::handler::{ + ApproveAllHandler, McpAuthHandler, McpAuthRequest, McpAuthResult, +}; +use github_copilot_sdk::session_events::{ SessionErrorData, SessionEventType, SessionInfoData, SessionModelChangeData, SessionResumeData, SessionStartData, SessionWarningData, UserMessageData, }; -use github_copilot_sdk::handler::ApproveAllHandler; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::types::LogLevel as SessionLogLevel; use github_copilot_sdk::{ Attachment, AttachmentLineRange, AttachmentSelectionPosition, AttachmentSelectionRange, AzureProviderOptions, DefaultAgentConfig, Error, GitHubReferenceType, LogOptions, - MessageOptions, ProviderConfig, ResumeSessionConfig, SectionOverride, SessionConfig, - SetModelOptions, SystemMessageConfig, Tool, ToolInvocation, ToolResult, + MessageOptions, ProviderConfig, RequestId, ResumeSessionConfig, SectionOverride, SessionConfig, + SessionId, SetModelOptions, SystemMessageConfig, Tool, ToolInvocation, ToolResult, }; use serde_json::json; use super::support::{ assert_uuid_like, assistant_message_content, collect_until_idle, event_types, - get_system_message, get_tool_names, wait_for_condition, wait_for_event, with_e2e_context, + get_system_message, get_tool_names, wait_for_condition, wait_for_event, }; #[tokio::test] async fn shouldcreateanddisconnectsessions() { - with_e2e_context("session", "shouldcreateanddisconnectsessions", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - ctx.approve_all_session_config() - .with_model("claude-sonnet-4.5"), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "shouldcreateanddisconnectsessions", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_model("claude-sonnet-4.5"), + ) + .await + .expect("create session"); - assert_uuid_like(session.id()); - let messages = session.get_events().await.expect("get messages"); - assert!(!messages.is_empty(), "expected initial session events"); - let start = messages[0] - .typed_data::() - .expect("session.start data"); - assert_eq!(start.session_id, session.id().clone()); + assert_uuid_like(session.id()); + let messages = session.get_events().await.expect("get messages"); + assert!(!messages.is_empty(), "expected initial session events"); + let start = messages[0] + .typed_data::() + .expect("session.start data"); + assert_eq!(start.session_id, session.id().clone()); - session.disconnect().await.expect("disconnect session"); - assert!( - session.get_events().await.is_err(), - "disconnected session should no longer serve message history" - ); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + assert!( + session.get_events().await.is_err(), + "disconnected session should no longer serve message history" + ); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } @@ -86,39 +93,45 @@ async fn disposeasync_from_handler_does_not_deadlock() { #[tokio::test] async fn should_have_stateful_conversation() { - with_e2e_context("session", "should_have_stateful_conversation", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_have_stateful_conversation", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - let first = session - .send_and_wait("What is 1+1?") - .await - .expect("first send") - .expect("first assistant message"); - assert!(assistant_message_content(&first).contains('2')); + let first = session + .send_and_wait("What is 1+1?") + .await + .expect("first send") + .expect("first assistant message"); + assert!(assistant_message_content(&first).contains('2')); - let second = session - .send_and_wait("Now if you double that, what do you get?") - .await - .expect("second send") - .expect("second assistant message"); - assert!(assistant_message_content(&second).contains('4')); + let second = session + .send_and_wait("Now if you double that, what do you get?") + .await + .expect("second send") + .expect("second assistant message"); + assert!(assistant_message_content(&second).contains('4')); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_create_a_session_with_appended_systemmessage_config() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_appended_systemmessage_config", |ctx| { @@ -162,7 +175,8 @@ async fn should_create_a_session_with_appended_systemmessage_config() { #[tokio::test] async fn should_create_a_session_with_replaced_systemmessage_config() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_replaced_systemmessage_config", |ctx| { @@ -204,7 +218,8 @@ async fn should_create_a_session_with_replaced_systemmessage_config() { #[tokio::test] async fn should_create_a_session_with_customized_systemmessage_config() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_customized_systemmessage_config", |ctx| { @@ -258,7 +273,8 @@ async fn should_create_a_session_with_customized_systemmessage_config() { #[tokio::test] async fn should_create_a_session_with_availabletools() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_availabletools", |ctx| { @@ -294,7 +310,8 @@ async fn should_create_a_session_with_availabletools() { #[tokio::test] async fn should_create_a_session_with_excludedtools() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_excludedtools", |ctx| { @@ -330,7 +347,8 @@ async fn should_create_a_session_with_excludedtools() { #[tokio::test] async fn should_create_a_session_with_defaultagent_excludedtools() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_a_session_with_defaultagent_excludedtools", |ctx| { @@ -369,37 +387,43 @@ async fn should_create_a_session_with_defaultagent_excludedtools() { #[tokio::test] async fn should_create_session_with_custom_tool() { - with_e2e_context("session", "should_create_session_with_custom_tool", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session( - SessionConfig::default() - .with_github_token(super::support::DEFAULT_TEST_TOKEN) - .with_permission_handler(Arc::new(ApproveAllHandler)) - .with_tools(vec![secret_number_tool()]), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_create_session_with_custom_tool", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + SessionConfig::default() + .with_github_token(super::support::DEFAULT_TEST_TOKEN) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_tools(vec![secret_number_tool()]), + ) + .await + .expect("create session"); - let answer = session - .send_and_wait("What is the secret number for key ALPHA?") - .await - .expect("send") - .expect("assistant message"); - assert!(assistant_message_content(&answer).contains("54321")); + let answer = session + .send_and_wait("What is the secret number for key ALPHA?") + .await + .expect("send") + .expect("assistant message"); + assert!(assistant_message_content(&answer).contains("54321")); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_throw_error_when_resuming_non_existent_session() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_throw_error_when_resuming_non_existent_session", |ctx| { @@ -423,7 +447,7 @@ async fn should_throw_error_when_resuming_non_existent_session() { #[tokio::test] async fn should_abort_a_session() { - with_e2e_context("session", "should_abort_a_session", |ctx| { + super::support::with_shared_e2e_context(&E2E, "session", "should_abort_a_session", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -455,11 +479,17 @@ async fn should_abort_a_session() { assert!(messages .iter() .any(|event| event.parsed_type() == SessionEventType::Abort)); - let answer = session - .send_and_wait("What is 2+2?") + let answer_events = session.subscribe(); + session + .send("What is 2+2?") .await - .expect("send after abort") - .expect("assistant message"); + .expect("send after abort"); + let answer = wait_for_event( + answer_events, + "assistant message after abort", + |event| event.parsed_type() == SessionEventType::AssistantMessage, + ) + .await; assert!(assistant_message_content(&answer).contains('4')); session.disconnect().await.expect("disconnect session"); @@ -471,7 +501,8 @@ async fn should_abort_a_session() { #[tokio::test] async fn should_resume_a_session_using_the_same_client() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_resume_a_session_using_the_same_client", |ctx| { @@ -527,7 +558,7 @@ async fn should_resume_a_session_using_the_same_client() { #[tokio::test] async fn should_resume_a_session_using_a_new_client() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "session", "should_resume_a_session_using_a_new_client", |ctx| { @@ -597,40 +628,100 @@ async fn should_resume_a_session_using_a_new_client() { .await; } +#[tokio::test] +async fn resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured() { + super::support::with_dedicated_e2e_context( + "session", + "resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)), + ) + .await + .expect("create session"); + let session_id = session.id().clone(); + + let first = session + .send_and_wait("What is 1+1?") + .await + .expect("send") + .expect("assistant message"); + assert!(assistant_message_content(&first).contains('2')); + + session + .disconnect() + .await + .expect("disconnect first session"); + client.stop().await.expect("stop first client"); + + let new_client = ctx.start_client().await; + let resumed = new_client + .resume_session( + ResumeSessionConfig::new(session_id.clone()) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)) + .with_github_token(super::support::DEFAULT_TEST_TOKEN), + ) + .await + .expect("resume session"); + assert_eq!(resumed.id(), &session_id); + + resumed + .disconnect() + .await + .expect("disconnect resumed session"); + new_client.stop().await.expect("stop new client"); + }) + }, + ) + .await; +} + #[tokio::test] async fn should_receive_session_events() { - with_e2e_context("session", "should_receive_session_events", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_receive_session_events", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - let events = session.subscribe(); - let answer = session - .send_and_wait("What is 100+200?") - .await - .expect("send") - .expect("assistant message"); - assert!(assistant_message_content(&answer).contains("300")); - let observed = collect_until_idle(events).await; - let types = event_types(&observed); - assert!(types.contains(&"user.message")); - assert!(types.contains(&"assistant.message")); - assert!(types.contains(&"session.idle")); + let events = session.subscribe(); + let answer = session + .send_and_wait("What is 100+200?") + .await + .expect("send") + .expect("assistant message"); + assert!(assistant_message_content(&answer).contains("300")); + let observed = collect_until_idle(events).await; + let types = event_types(&observed); + assert!(types.contains(&"user.message")); + assert!(types.contains(&"assistant.message")); + assert!(types.contains(&"session.idle")); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn send_returns_immediately_while_events_stream_in_background() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "send_returns_immediately_while_events_stream_in_background", |ctx| { @@ -669,7 +760,8 @@ async fn send_returns_immediately_while_events_stream_in_background() { #[tokio::test] async fn sendandwait_blocks_until_session_idle_and_returns_final_assistant_message() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "sendandwait_blocks_until_session_idle_and_returns_final_assistant_message", |ctx| { @@ -705,127 +797,143 @@ async fn sendandwait_blocks_until_session_idle_and_returns_final_assistant_messa #[tokio::test] async fn should_list_sessions_with_context() { - with_e2e_context("session", "should_list_sessions_with_context", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let session_id = session.id().clone(); - - session.send_and_wait("Say OK.").await.expect("send"); - wait_for_condition("session to appear in list", || { - let client = client.clone(); - let session_id = session_id.clone(); - async move { - client.list_sessions(None).await.is_ok_and(|sessions| { - sessions - .iter() - .any(|session| session.session_id == session_id) - }) - } - }) - .await; + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_list_sessions_with_context", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let session_id = session.id().clone(); - let all_sessions = client.list_sessions(None).await.expect("list sessions"); - assert!(!all_sessions.is_empty()); + session.send_and_wait("Say OK.").await.expect("send"); + wait_for_condition("session to appear in list", || { + let client = client.clone(); + let session_id = session_id.clone(); + async move { + client.list_sessions(None).await.is_ok_and(|sessions| { + sessions + .iter() + .any(|session| session.session_id == session_id) + }) + } + }) + .await; - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + let all_sessions = client.list_sessions(None).await.expect("list sessions"); + assert!(!all_sessions.is_empty()); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_get_session_metadata_by_id() { - with_e2e_context("session", "should_get_session_metadata_by_id", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let session_id = session.id().clone(); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_get_session_metadata_by_id", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let session_id = session.id().clone(); + + session.send_and_wait("Say hello").await.expect("send"); + wait_for_condition("session metadata to persist", || { + let client = client.clone(); + let session_id = session_id.clone(); + async move { + client + .get_session_metadata(&session_id) + .await + .is_ok_and(|metadata| metadata.is_some()) + } + }) + .await; - session.send_and_wait("Say hello").await.expect("send"); - wait_for_condition("session metadata to persist", || { - let client = client.clone(); - let session_id = session_id.clone(); - async move { + let metadata = client + .get_session_metadata(&session_id) + .await + .expect("get metadata") + .expect("session metadata"); + assert_eq!(metadata.session_id, session_id); + assert!(!metadata.start_time.is_empty()); + assert!(!metadata.modified_time.is_empty()); + assert!( client - .get_session_metadata(&session_id) + .get_session_metadata(&github_copilot_sdk::SessionId::new( + "non-existent-session-id" + )) .await - .is_ok_and(|metadata| metadata.is_some()) - } - }) - .await; + .expect("get missing metadata") + .is_none() + ); - let metadata = client - .get_session_metadata(&session_id) - .await - .expect("get metadata") - .expect("session metadata"); - assert_eq!(metadata.session_id, session_id); - assert!(!metadata.start_time.is_empty()); - assert!(!metadata.modified_time.is_empty()); - assert!( - client - .get_session_metadata(&github_copilot_sdk::SessionId::new( - "non-existent-session-id" - )) - .await - .expect("get missing metadata") - .is_none() - ); - - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) - .await; -} + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} #[tokio::test] async fn sendandwait_throws_on_timeout() { - with_e2e_context("session", "sendandwait_throws_on_timeout", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let idle = tokio::spawn(wait_for_event( - session.subscribe(), - "session.idle after timeout abort", - |event| event.parsed_type() == SessionEventType::SessionIdle, - )); - - let error = session - .send_and_wait( - MessageOptions::new("Run 'sleep 2 && echo done'") - .with_wait_timeout(Duration::from_millis(100)), - ) - .await - .expect_err("send_and_wait should time out"); - assert!(error.to_string().contains("timed out")); + super::support::with_shared_e2e_context( + &E2E, + "session", + "sendandwait_throws_on_timeout", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let idle = tokio::spawn(wait_for_event( + session.subscribe(), + "session.idle after timeout abort", + |event| event.parsed_type() == SessionEventType::SessionIdle, + )); + + let error = session + .send_and_wait( + MessageOptions::new("Run 'sleep 2 && echo done'") + .with_wait_timeout(Duration::from_millis(100)), + ) + .await + .expect_err("send_and_wait should time out"); + assert!(error.to_string().contains("timed out")); - session.abort().await.expect("abort session"); - idle.await.expect("idle task"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.abort().await.expect("abort session"); + idle.await.expect("idle task"); + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_create_session_with_custom_config_dir() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "session", "should_create_session_with_custom_config_dir", |ctx| { @@ -859,183 +967,198 @@ async fn should_create_session_with_custom_config_dir() { #[tokio::test] async fn should_set_model_on_existing_session() { - with_e2e_context("session", "should_set_model_on_existing_session", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let model_changed = tokio::spawn(wait_for_event( - session.subscribe(), - "session.model_change", - |event| event.parsed_type() == SessionEventType::SessionModelChange, - )); - - session.set_model("gpt-4.1", None).await.expect("set model"); - let event = model_changed.await.expect("model change task"); - let data = event - .typed_data::() - .expect("session.model_change data"); - assert_eq!(data.new_model, "gpt-4.1"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_set_model_on_existing_session", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let model_changed = tokio::spawn(wait_for_event( + session.subscribe(), + "session.model_change", + |event| event.parsed_type() == SessionEventType::SessionModelChange, + )); + + session.set_model("gpt-4.1", None).await.expect("set model"); + let event = model_changed.await.expect("model change task"); + let data = event + .typed_data::() + .expect("session.model_change data"); + assert_eq!(data.new_model, "gpt-4.1"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_set_model_with_reasoningeffort() { - with_e2e_context("session", "should_set_model_with_reasoningeffort", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let model_changed = tokio::spawn(wait_for_event( - session.subscribe(), - "session.model_change with reasoning effort", - |event| event.parsed_type() == SessionEventType::SessionModelChange, - )); + super::support::with_dedicated_group_e2e_context( + &E2E, + "session", + "should_set_model_with_reasoningeffort", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let model_changed = tokio::spawn(wait_for_event( + session.subscribe(), + "session.model_change with reasoning effort", + |event| event.parsed_type() == SessionEventType::SessionModelChange, + )); - session - .set_model( - "gpt-4.1", - Some(SetModelOptions::default().with_reasoning_effort("high")), - ) - .await - .expect("set model"); - let event = model_changed.await.expect("model change task"); - let data = event - .typed_data::() - .expect("session.model_change data"); - assert_eq!(data.new_model, "gpt-4.1"); - assert_eq!(data.reasoning_effort.as_deref(), Some("high")); + session + .set_model( + "gpt-5.4", + Some(SetModelOptions::default().with_reasoning_effort("high")), + ) + .await + .expect("set model"); + let event = model_changed.await.expect("model change task"); + let data = event + .typed_data::() + .expect("session.model_change data"); + assert_eq!(data.new_model, "gpt-5.4"); + assert_eq!(data.reasoning_effort.as_deref(), Some("high")); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_log_messages_at_various_levels() { - with_e2e_context("session", "should_log_messages_at_various_levels", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let mut events = session.subscribe(); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_log_messages_at_various_levels", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let mut events = session.subscribe(); - session.log("Info message", None).await.expect("info log"); - session - .log( - "Warning message", - Some(LogOptions::default().with_level(SessionLogLevel::Warning)), - ) - .await - .expect("warning log"); - session - .log( - "Error message", - Some(LogOptions::default().with_level(SessionLogLevel::Error)), - ) - .await - .expect("error log"); - session - .log( - "Ephemeral message", - Some(LogOptions::default().with_ephemeral(true)), - ) - .await - .expect("ephemeral log"); - - let mut observed = Vec::new(); - tokio::time::timeout(Duration::from_secs(10), async { - while observed.len() < 4 { - let event = events.recv().await.expect("session event"); - if matches!( - event.parsed_type(), - SessionEventType::SessionInfo - | SessionEventType::SessionWarning - | SessionEventType::SessionError - ) { - observed.push(event); + session.log("Info message", None).await.expect("info log"); + session + .log( + "Warning message", + Some(LogOptions::default().with_level(SessionLogLevel::Warning)), + ) + .await + .expect("warning log"); + session + .log( + "Error message", + Some(LogOptions::default().with_level(SessionLogLevel::Error)), + ) + .await + .expect("error log"); + session + .log( + "Ephemeral message", + Some(LogOptions::default().with_ephemeral(true)), + ) + .await + .expect("ephemeral log"); + + let mut observed = Vec::new(); + tokio::time::timeout(Duration::from_secs(10), async { + while observed.len() < 4 { + let event = events.recv().await.expect("session event"); + if matches!( + event.parsed_type(), + SessionEventType::SessionInfo + | SessionEventType::SessionWarning + | SessionEventType::SessionError + ) { + observed.push(event); + } } - } - }) - .await - .expect("log events"); - - let info = observed - .iter() - .find(|event| { - event - .typed_data::() - .is_some_and(|data| data.message == "Info message") }) - .expect("info message"); - assert_eq!( - info.typed_data::() - .expect("info data") - .info_type, - "notification" - ); - let warning = observed - .iter() - .find(|event| { - event + .await + .expect("log events"); + + let info = observed + .iter() + .find(|event| { + event + .typed_data::() + .is_some_and(|data| data.message == "Info message") + }) + .expect("info message"); + assert_eq!( + info.typed_data::() + .expect("info data") + .info_type, + "notification" + ); + let warning = observed + .iter() + .find(|event| { + event + .typed_data::() + .is_some_and(|data| data.message == "Warning message") + }) + .expect("warning message"); + assert_eq!( + warning .typed_data::() - .is_some_and(|data| data.message == "Warning message") - }) - .expect("warning message"); - assert_eq!( - warning - .typed_data::() - .expect("warning data") - .warning_type, - "notification" - ); - let error = observed - .iter() - .find(|event| { - event + .expect("warning data") + .warning_type, + "notification" + ); + let error = observed + .iter() + .find(|event| { + event + .typed_data::() + .is_some_and(|data| data.message == "Error message") + }) + .expect("error message"); + assert_eq!( + error .typed_data::() - .is_some_and(|data| data.message == "Error message") - }) - .expect("error message"); - assert_eq!( - error - .typed_data::() - .expect("error data") - .error_type, - "notification" - ); - assert!(observed.iter().any(|event| { - event - .typed_data::() - .is_some_and(|data| data.message == "Ephemeral message") - })); + .expect("error data") + .error_type, + "notification" + ); + assert!(observed.iter().any(|event| { + event + .typed_data::() + .is_some_and(|data| data.message == "Ephemeral message") + })); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_accept_blob_attachments() { - with_e2e_context("session", "should_accept_blob_attachments", |ctx| { + super::support::with_shared_e2e_context(&E2E, "session", "should_accept_blob_attachments", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let png_base64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="; @@ -1077,197 +1200,213 @@ async fn should_accept_blob_attachments() { #[tokio::test] async fn should_send_with_file_attachment() { - with_e2e_context("session", "should_send_with_file_attachment", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let file_path = ctx.work_dir().join("attached-file.txt"); - std::fs::write(&file_path, "FILE_ATTACHMENT_SENTINEL").expect("write attached file"); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_send_with_file_attachment", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let file_path = ctx.work_dir().join("attached-file.txt"); + std::fs::write(&file_path, "FILE_ATTACHMENT_SENTINEL") + .expect("write attached file"); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - session - .send_and_wait( - MessageOptions::new("Read the attached file and reply with its contents.") - .with_attachments(vec![Attachment::File { - path: file_path.clone(), - display_name: Some("attached-file.txt".to_string()), - line_range: Some(AttachmentLineRange { start: 1, end: 1 }), - }]), - ) - .await - .expect("send"); + session + .send_and_wait( + MessageOptions::new("Read the attached file and reply with its contents.") + .with_attachments(vec![Attachment::File { + path: file_path.clone(), + display_name: Some("attached-file.txt".to_string()), + line_range: Some(AttachmentLineRange { start: 1, end: 1 }), + }]), + ) + .await + .expect("send"); - let user = latest_user_message(&session).await; - let attachments = user - .typed_data::() - .expect("user message data") - .attachments - .expect("attachments"); - assert_eq!(attachments.len(), 1); - assert_eq!( - attachments[0] - .get("displayName") - .and_then(serde_json::Value::as_str), - Some("attached-file.txt") - ); - assert_eq!( - attachments[0] - .get("path") - .and_then(serde_json::Value::as_str), - Some(file_path.to_string_lossy().as_ref()) - ); - assert_eq!( - attachments[0] - .get("lineRange") - .and_then(|value| value.get("start")) - .and_then(serde_json::Value::as_u64), - Some(1) - ); + let user = latest_user_message(&session).await; + let attachments = user + .typed_data::() + .expect("user message data") + .attachments + .expect("attachments"); + assert_eq!(attachments.len(), 1); + assert_eq!( + attachments[0] + .get("displayName") + .and_then(serde_json::Value::as_str), + Some("attached-file.txt") + ); + assert_eq!( + attachments[0] + .get("path") + .and_then(serde_json::Value::as_str), + Some(file_path.to_string_lossy().as_ref()) + ); + assert_eq!( + attachments[0] + .get("lineRange") + .and_then(|value| value.get("start")) + .and_then(serde_json::Value::as_u64), + Some(1) + ); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_send_with_directory_attachment() { - with_e2e_context("session", "should_send_with_directory_attachment", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let directory_path = ctx.work_dir().join("attached-directory"); - std::fs::create_dir(&directory_path).expect("create attached directory"); - std::fs::write( - directory_path.join("readme.txt"), - "DIRECTORY_ATTACHMENT_SENTINEL", - ) - .expect("write attached directory file"); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - - session - .send_and_wait( - MessageOptions::new("List the attached directory.").with_attachments(vec![ - Attachment::Directory { - path: directory_path.clone(), - display_name: Some("attached-directory".to_string()), - }, - ]), + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_send_with_directory_attachment", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let directory_path = ctx.work_dir().join("attached-directory"); + std::fs::create_dir(&directory_path).expect("create attached directory"); + std::fs::write( + directory_path.join("readme.txt"), + "DIRECTORY_ATTACHMENT_SENTINEL", ) - .await - .expect("send"); + .expect("write attached directory file"); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - let user = latest_user_message(&session).await; - let attachments = user - .typed_data::() - .expect("user message data") - .attachments - .expect("attachments"); - assert_eq!(attachments.len(), 1); - assert_eq!( - attachments[0] - .get("displayName") - .and_then(serde_json::Value::as_str), - Some("attached-directory") - ); - assert_eq!( - attachments[0] - .get("path") - .and_then(serde_json::Value::as_str), - Some(directory_path.to_string_lossy().as_ref()) - ); + session + .send_and_wait( + MessageOptions::new("List the attached directory.").with_attachments(vec![ + Attachment::Directory { + path: directory_path.clone(), + display_name: Some("attached-directory".to_string()), + }, + ]), + ) + .await + .expect("send"); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + let user = latest_user_message(&session).await; + let attachments = user + .typed_data::() + .expect("user message data") + .attachments + .expect("attachments"); + assert_eq!(attachments.len(), 1); + assert_eq!( + attachments[0] + .get("displayName") + .and_then(serde_json::Value::as_str), + Some("attached-directory") + ); + assert_eq!( + attachments[0] + .get("path") + .and_then(serde_json::Value::as_str), + Some(directory_path.to_string_lossy().as_ref()) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_send_with_selection_attachment() { - with_e2e_context("session", "should_send_with_selection_attachment", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let file_path = std::path::PathBuf::from("selected-file.cs"); - let absolute_file_path = ctx.work_dir().join(&file_path); - std::fs::write( - &absolute_file_path, - "class C { string Value = \"SELECTION_SENTINEL\"; }", - ) - .expect("write selection file"); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_send_with_selection_attachment", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let file_path = std::path::PathBuf::from("selected-file.cs"); + let absolute_file_path = ctx.work_dir().join(&file_path); + std::fs::write( + &absolute_file_path, + "class C { string Value = \"SELECTION_SENTINEL\"; }", + ) + .expect("write selection file"); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - session - .send_and_wait( - MessageOptions::new("Summarize the selected code.").with_attachments(vec![ - Attachment::Selection { - file_path: file_path.clone(), - text: "string Value = \"SELECTION_SENTINEL\";".to_string(), - display_name: Some("selected-file.cs".to_string()), - selection: AttachmentSelectionRange { - start: AttachmentSelectionPosition { - line: 1, - character: 10, - }, - end: AttachmentSelectionPosition { - line: 1, - character: 45, + session + .send_and_wait( + MessageOptions::new("Summarize the selected code.").with_attachments(vec![ + Attachment::Selection { + file_path: file_path.clone(), + text: "string Value = \"SELECTION_SENTINEL\";".to_string(), + display_name: Some("selected-file.cs".to_string()), + selection: AttachmentSelectionRange { + start: AttachmentSelectionPosition { + line: 1, + character: 10, + }, + end: AttachmentSelectionPosition { + line: 1, + character: 45, + }, }, }, - }, - ]), - ) - .await - .expect("send"); + ]), + ) + .await + .expect("send"); - let user = latest_user_message(&session).await; - let attachment = user - .typed_data::() - .expect("user message data") - .attachments - .expect("attachments") - .into_iter() - .next() - .expect("attachment"); - assert_eq!( - attachment - .get("displayName") - .and_then(serde_json::Value::as_str), - Some("selected-file.cs") - ); - assert_eq!( - attachment - .get("filePath") - .and_then(serde_json::Value::as_str), - Some(file_path.to_string_lossy().as_ref()) - ); - assert_eq!( - attachment.get("text").and_then(serde_json::Value::as_str), - Some("string Value = \"SELECTION_SENTINEL\";") - ); + let user = latest_user_message(&session).await; + let attachment = user + .typed_data::() + .expect("user message data") + .attachments + .expect("attachments") + .into_iter() + .next() + .expect("attachment"); + assert_eq!( + attachment + .get("displayName") + .and_then(serde_json::Value::as_str), + Some("selected-file.cs") + ); + assert_eq!( + attachment + .get("filePath") + .and_then(serde_json::Value::as_str), + Some(file_path.to_string_lossy().as_ref()) + ); + assert_eq!( + attachment.get("text").and_then(serde_json::Value::as_str), + Some("string Value = \"SELECTION_SENTINEL\";") + ); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_send_with_github_reference_attachment() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "session", "should_send_with_github_reference_attachment", |ctx| { @@ -1332,101 +1471,114 @@ async fn should_send_with_github_reference_attachment() { #[tokio::test] async fn should_send_with_custom_requestheaders() { - with_e2e_context("session", "should_send_with_custom_requestheaders", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); - let mut headers = HashMap::new(); - headers.insert( - "x-copilot-sdk-test-header".to_string(), - "csharp-request-headers".to_string(), - ); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_send_with_custom_requestheaders", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let mut headers = HashMap::new(); + headers.insert( + "x-copilot-sdk-test-header".to_string(), + "csharp-request-headers".to_string(), + ); - session - .send_and_wait(MessageOptions::new("What is 1+1?").with_request_headers(headers)) - .await - .expect("send"); + session + .send_and_wait( + MessageOptions::new("What is 1+1?").with_request_headers(headers), + ) + .await + .expect("send"); - let exchanges = ctx.exchanges(); - assert!(!exchanges.is_empty(), "expected captured CAPI exchange"); - let request_headers = exchanges - .last() - .and_then(|exchange| exchange.get("requestHeaders")) - .and_then(serde_json::Value::as_object) - .expect("request headers"); - let header = request_headers - .iter() - .find(|(key, _)| key.eq_ignore_ascii_case("x-copilot-sdk-test-header")) - .and_then(|(_, value)| value.as_str()) - .expect("test header"); - assert!(header.contains("csharp-request-headers")); + let exchanges = ctx.exchanges(); + assert!(!exchanges.is_empty(), "expected captured CAPI exchange"); + let request_headers = exchanges + .last() + .and_then(|exchange| exchange.get("requestHeaders")) + .and_then(serde_json::Value::as_object) + .expect("request headers"); + let header = request_headers + .iter() + .find(|(key, _)| key.eq_ignore_ascii_case("x-copilot-sdk-test-header")) + .and_then(|(_, value)| value.as_str()) + .expect("test header"); + assert!(header.contains("csharp-request-headers")); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_send_with_mode_property() { - with_e2e_context("session", "should_send_with_mode_property", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let session = client - .create_session(ctx.approve_all_session_config()) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "session", + "should_send_with_mode_property", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); - session - .client() - .call( - "session.send", - Some(json!({ - "sessionId": session.id().as_str(), - "prompt": "Say mode ok.", - "mode": "plan", - })), - ) - .await - .expect("send with agent mode"); - wait_for_event(session.subscribe(), "session.idle", |event| { - event.parsed_type() == SessionEventType::SessionIdle - }) - .await; + session + .client() + .call( + "session.send", + Some(json!({ + "sessionId": session.id().as_str(), + "prompt": "Say mode ok.", + "mode": "plan", + })), + ) + .await + .expect("send with agent mode"); + wait_for_event(session.subscribe(), "session.idle", |event| { + event.parsed_type() == SessionEventType::SessionIdle + }) + .await; - let user_message = session - .get_events() - .await - .expect("get messages") - .into_iter() - .rev() - .find(|event| event.parsed_type() == SessionEventType::UserMessage) - .expect("user.message"); - let data = user_message - .typed_data::() - .expect("user.message data"); - assert_eq!(data.content, "Say mode ok."); - assert!( - data.agent_mode.is_none(), - "runtime should accept but not echo per-message mode" - ); + let user_message = session + .get_events() + .await + .expect("get messages") + .into_iter() + .rev() + .find(|event| event.parsed_type() == SessionEventType::UserMessage) + .expect("user.message"); + let data = user_message + .typed_data::() + .expect("user.message data"); + assert_eq!(data.content, "Say mode ok."); + assert!( + data.agent_mode.is_none(), + "runtime should accept but not echo per-message mode" + ); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn should_create_session_with_custom_provider() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_session_with_custom_provider", |ctx| { @@ -1453,7 +1605,8 @@ async fn should_create_session_with_custom_provider() { #[tokio::test] async fn should_create_session_with_azure_provider() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_create_session_with_azure_provider", |ctx| { @@ -1483,7 +1636,8 @@ async fn should_create_session_with_azure_provider() { #[tokio::test] async fn should_resume_session_with_custom_provider() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session", "should_resume_session_with_custom_provider", |ctx| { @@ -1528,6 +1682,20 @@ async fn latest_user_message( .expect("user.message") } +struct CancelMcpAuthHandler; + +#[async_trait::async_trait] +impl McpAuthHandler for CancelMcpAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + _request_id: RequestId, + _request: McpAuthRequest, + ) -> McpAuthResult { + McpAuthResult::Cancelled + } +} + struct SecretNumberTool; #[async_trait::async_trait] @@ -1583,3 +1751,5 @@ fn secret_number_tool() -> Tool { })) .with_handler(Arc::new(SecretNumberTool)) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("session", 30); diff --git a/rust/tests/e2e/session_config.rs b/rust/tests/e2e/session_config.rs index 8b1378917..c3f6b57ae 100644 --- a/rust/tests/e2e/session_config.rs +++ b/rust/tests/e2e/session_config.rs @@ -1 +1,633 @@ +use std::net::TcpListener; +use std::sync::Arc; +use std::time::Duration; +use async_trait::async_trait; +use base64::Engine; +use bytes::Bytes; +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::{ + Attachment, Client, CopilotHttpRequest, CopilotHttpResponse, CopilotRequestContext, + CopilotRequestError, CopilotRequestHandler, MessageOptions, ProviderConfig, + ResumeSessionConfig, SessionConfig, SessionLimitsConfig, Transport, +}; +use http::{HeaderMap, HeaderValue}; +use parking_lot::Mutex; +use serde_json::{Value, json}; + +use super::support::{DEFAULT_TEST_TOKEN, E2eContext, with_e2e_context_no_snapshot}; + +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("session_config", 4); + +const SYNTHETIC_TEXT: &str = "OK from the synthetic stream."; +const CITATION_PROMPT: &str = "Summarize the attached PDF with citations enabled."; + +fn session_limits(max_ai_credits: f64) -> SessionLimitsConfig { + SessionLimitsConfig { + max_ai_credits: Some(max_ai_credits), + } +} + +async fn send_and_get_next_exchange( + ctx: &E2eContext, + session: &github_copilot_sdk::session::Session, + prompt: &str, +) -> Value { + let existing_count = ctx.exchanges().len(); + session + .send_and_wait(MessageOptions::new(prompt).with_wait_timeout(Duration::from_secs(120))) + .await + .expect("send_and_wait"); + let exchanges = ctx.exchanges(); + assert!(exchanges.len() > existing_count); + exchanges[existing_count].clone() +} + +fn assert_session_limits_status(exchange: &Value, expected_remaining: &str) { + let messages = exchange["request"]["messages"] + .as_array() + .expect("request messages"); + for message in messages { + if message["role"] != "user" { + continue; + } + let Some(content) = message["content"].as_str() else { + continue; + }; + if !content.contains("") { + continue; + } + assert!( + content.contains(&format!("Remaining session limits: {expected_remaining}.")), + "expected session limits status to include remaining {expected_remaining:?}, got {content:?}" + ); + assert!( + content.contains("Be frugal; avoid optional exploration and unnecessary tool calls."), + "expected session limits status to include frugality instruction, got {content:?}" + ); + return; + } + panic!("expected session limits status message"); +} + +fn task_agent_types(exchange: &Value) -> Vec { + let tools = exchange["request"]["tools"] + .as_array() + .expect("request tools"); + for tool in tools { + if tool["function"]["name"] != "task" { + continue; + } + return tool["function"]["parameters"]["properties"]["agent_type"]["enum"] + .as_array() + .expect("agent type enum") + .iter() + .map(|value| value.as_str().expect("agent type").to_string()) + .collect(); + } + panic!("expected task tool in request"); +} + +#[tokio::test] +async fn should_apply_session_limits_on_create() { + super::support::with_shared_e2e_context( + &E2E, + "session_config", + "should_apply_session_limits_on_create", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config() + .with_session_limits(session_limits(30.0)), + ) + .await + .expect("create session"); + + let exchange = send_and_get_next_exchange( + ctx, + &session, + "Acknowledge the current session limits.", + ) + .await; + assert_session_limits_status(&exchange, "30 AI credits"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_apply_session_limits_on_resume() { + super::support::with_shared_e2e_context( + &E2E, + "session_config", + "should_apply_session_limits_on_resume", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session1 = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let session2 = client + .resume_session( + ResumeSessionConfig::new(session1.id().clone()) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_github_token(DEFAULT_TEST_TOKEN) + .with_session_limits(session_limits(30.0)), + ) + .await + .expect("resume session"); + + let exchange = send_and_get_next_exchange( + ctx, + &session2, + "Acknowledge the current session limits.", + ) + .await; + assert_session_limits_status(&exchange, "30 AI credits"); + + session2 + .disconnect() + .await + .expect("disconnect resumed session"); + session1 + .disconnect() + .await + .expect("disconnect original session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_apply_excluded_built_in_agents_on_create() { + super::support::with_shared_e2e_context( + &E2E, + "session_config", + "should_apply_excluded_built_in_agents_on_create", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + + let baseline = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create baseline session"); + let baseline_exchange = + send_and_get_next_exchange(ctx, &baseline, "What is 1+1?").await; + let baseline_agents = task_agent_types(&baseline_exchange); + assert!( + baseline_agents.iter().any(|agent| agent == "explore"), + "expected baseline task agents to include explore, got {baseline_agents:?}" + ); + baseline + .disconnect() + .await + .expect("disconnect baseline session"); + + let excluded = client + .create_session( + ctx.approve_all_session_config() + .with_excluded_builtin_agents(["explore"]), + ) + .await + .expect("create excluded-agent session"); + let excluded_exchange = + send_and_get_next_exchange(ctx, &excluded, "What is 1+1?").await; + let excluded_agents = task_agent_types(&excluded_exchange); + assert!(!excluded_agents.is_empty()); + assert!( + !excluded_agents.iter().any(|agent| agent == "explore"), + "expected task agents not to include explore, got {excluded_agents:?}" + ); + + excluded + .disconnect() + .await + .expect("disconnect excluded-agent session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_apply_excluded_built_in_agents_on_resume() { + super::support::with_shared_e2e_context( + &E2E, + "session_config", + "should_apply_excluded_built_in_agents_on_resume", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session1 = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let session2 = client + .resume_session( + ResumeSessionConfig::new(session1.id().clone()) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_github_token(DEFAULT_TEST_TOKEN) + .with_excluded_builtin_agents(["explore"]), + ) + .await + .expect("resume session"); + + let exchange = send_and_get_next_exchange(ctx, &session2, "What is 1+1?").await; + let agent_types = task_agent_types(&exchange); + assert!(!agent_types.is_empty()); + assert!( + !agent_types.iter().any(|agent| agent == "explore"), + "expected task agents not to include explore, got {agent_types:?}" + ); + + session2 + .disconnect() + .await + .expect("disconnect resumed session"); + session1 + .disconnect() + .await + .expect("disconnect original session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[derive(Clone, Default)] +struct RecordingHandler { + records: Arc>>, +} + +#[derive(Clone)] +struct RecordedRequest { + url: String, + body: Vec, +} + +impl RecordingHandler { + fn inference_records(&self) -> Vec { + self.records + .lock() + .iter() + .filter(|record| is_inference_url(&record.url)) + .cloned() + .collect() + } +} + +#[async_trait] +impl CopilotRequestHandler for RecordingHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + _ctx: &CopilotRequestContext, + ) -> Result { + self.records.lock().push(RecordedRequest { + url: request.url.clone(), + body: request.body.clone(), + }); + if is_inference_url(&request.url) { + return Ok(synth_inference_response(&request.url, &request.body)); + } + Ok(synth_non_inference_response(&request.url)) + } +} + +fn is_inference_url(url: &str) -> bool { + let url = url.to_lowercase(); + url.ends_with("/chat/completions") + || url.ends_with("/responses") + || url.ends_with("/v1/messages") + || url.ends_with("/messages") +} + +fn json_headers() -> HeaderMap { + let mut headers = HeaderMap::new(); + headers.insert("content-type", HeaderValue::from_static("application/json")); + headers +} + +fn http_response(status: u16, headers: HeaderMap, body: Value) -> CopilotHttpResponse { + let bytes = serde_json::to_vec(&body).expect("serialize response"); + let stream = + futures_util::stream::once( + async move { Ok::(Bytes::from(bytes)) }, + ); + CopilotHttpResponse::new(status, None, headers, Box::pin(stream)) +} + +fn sse_response(body: String) -> CopilotHttpResponse { + let mut headers = HeaderMap::new(); + headers.insert( + "content-type", + HeaderValue::from_static("text/event-stream"), + ); + let stream = futures_util::stream::once(async move { + Ok::(Bytes::from(body.into_bytes())) + }); + CopilotHttpResponse::new(200, None, headers, Box::pin(stream)) +} + +fn wants_stream(body: &[u8]) -> bool { + String::from_utf8_lossy(body) + .replace(char::is_whitespace, "") + .contains("\"stream\":true") +} + +fn anthropic_message_stream_body(text: &str) -> String { + let events = [ + ( + "message_start", + json!({ + "type": "message_start", + "message": { + "id": "msg_stub_1", + "type": "message", + "role": "assistant", + "model": "claude-sonnet-4.5", + "content": [], + "stop_reason": null, + "stop_sequence": null, + "usage": { "input_tokens": 5, "output_tokens": 1 }, + }, + }), + ), + ( + "content_block_start", + json!({ + "type": "content_block_start", + "index": 0, + "content_block": { "type": "text", "text": "" }, + }), + ), + ( + "content_block_delta", + json!({ + "type": "content_block_delta", + "index": 0, + "delta": { "type": "text_delta", "text": text }, + }), + ), + ( + "content_block_stop", + json!({ "type": "content_block_stop", "index": 0 }), + ), + ( + "message_delta", + json!({ + "type": "message_delta", + "delta": { "stop_reason": "end_turn", "stop_sequence": null }, + "usage": { "output_tokens": 7 }, + }), + ), + ("message_stop", json!({ "type": "message_stop" })), + ]; + events + .iter() + .map(|(name, data)| format!("event: {name}\ndata: {data}\n\n")) + .collect() +} + +fn synth_non_inference_response(url: &str) -> CopilotHttpResponse { + let lower = url.to_lowercase(); + if lower.ends_with("/models") { + return http_response( + 200, + json_headers(), + json!({ + "data": [{ + "id": "claude-sonnet-4.5", + "name": "Claude Sonnet 4.5", + "object": "model", + "vendor": "Anthropic", + "version": "1", + "preview": false, + "model_picker_enabled": true, + "capabilities": { + "type": "chat", + "family": "claude-sonnet-4.5", + "tokenizer": "o200k_base", + "limits": { + "max_context_window_tokens": 200000, + "max_output_tokens": 8192, + }, + "supports": { + "streaming": true, + "tool_calls": true, + "parallel_tool_calls": true, + "vision": true, + }, + }, + }], + }), + ); + } + if lower.contains("/policy") { + return http_response(200, json_headers(), json!({ "state": "enabled" })); + } + http_response(200, json_headers(), json!({})) +} + +fn synth_inference_response(url: &str, body: &[u8]) -> CopilotHttpResponse { + let lower = url.to_lowercase(); + if lower.ends_with("/messages") { + if wants_stream(body) { + return sse_response(anthropic_message_stream_body(SYNTHETIC_TEXT)); + } + return http_response( + 200, + json_headers(), + json!({ + "id": "msg_stub_1", + "type": "message", + "role": "assistant", + "model": "claude-sonnet-4.5", + "content": [{ "type": "text", "text": SYNTHETIC_TEXT }], + "stop_reason": "end_turn", + "stop_sequence": null, + "usage": { "input_tokens": 5, "output_tokens": 7 }, + }), + ); + } + http_response( + 200, + json_headers(), + json!({ + "id": "chatcmpl-stub-1", + "object": "chat.completion", + "created": 1, + "model": "claude-sonnet-4.5", + "choices": [{ + "index": 0, + "message": { "role": "assistant", "content": SYNTHETIC_TEXT }, + "finish_reason": "stop", + }], + "usage": { "prompt_tokens": 5, "completion_tokens": 7, "total_tokens": 12 }, + }), + ) +} + +fn anthropic_provider() -> ProviderConfig { + ProviderConfig::new("https://anthropic-citations.invalid/v1") + .with_provider_type("anthropic") + .with_api_key("test-provider-key") + .with_model_id("claude-sonnet-4.5") + .with_wire_model("claude-sonnet-4.5") +} + +fn pdf_attachment() -> Attachment { + let pdf_text = + "%PDF-1.4\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R >>\n%%EOF\n"; + Attachment::Blob { + data: base64::engine::general_purpose::STANDARD.encode(pdf_text), + mime_type: "application/pdf".to_string(), + display_name: Some("citation-source.pdf".to_string()), + } +} + +fn assert_anthropic_document_citations_enabled(request_body: &[u8]) { + let body: Value = serde_json::from_slice(request_body).expect("Anthropic request body"); + let documents: Vec<&Value> = body["messages"] + .as_array() + .expect("messages") + .iter() + .flat_map(|message| message["content"].as_array().expect("message content")) + .filter(|block| block["type"] == "document") + .collect(); + + assert_eq!(documents.len(), 1); + assert_eq!(documents[0]["title"], "citation-source.pdf"); + assert_eq!(documents[0]["citations"]["enabled"], true); +} + +#[tokio::test] +async fn should_enable_citations_for_anthropic_file_attachments_on_create() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = RecordingHandler::default(); + let client = ctx.start_llm_client(handler.clone(), &[]).await; + let session = client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_model("claude-sonnet-4.5") + .with_enable_citations(true) + .with_provider(anthropic_provider()), + ) + .await + .expect("create session"); + + session + .send_and_wait( + MessageOptions::new(CITATION_PROMPT) + .with_wait_timeout(Duration::from_secs(120)) + .with_attachments(vec![pdf_attachment()]), + ) + .await + .expect("send_and_wait"); + + let inference_records = handler.inference_records(); + assert_eq!(inference_records.len(), 1); + assert_anthropic_document_citations_enabled(&inference_records[0].body); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }) + .await; +} + +#[tokio::test] +async fn should_enable_citations_for_anthropic_file_attachments_on_resume() { + with_e2e_context_no_snapshot(|ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let handler = RecordingHandler::default(); + let port = free_tcp_port(); + let token = "rust-citation-resume-token".to_string(); + let server = Client::start( + ctx.client_options_with_transport(Transport::Tcp { + port, + connection_token: Some(token.clone()), + }) + .with_request_handler(handler.clone()), + ) + .await + .expect("start TCP server client"); + let session1 = server + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + let resume_client = + Client::start(ctx.client_options_with_transport(Transport::External { + host: "127.0.0.1".to_string(), + port, + connection_token: Some(token), + })) + .await + .expect("start external client"); + let session2 = resume_client + .resume_session( + ResumeSessionConfig::new(session1.id().clone()) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_model("claude-sonnet-4.5") + .with_enable_citations(true) + .with_provider(anthropic_provider()), + ) + .await + .expect("resume session"); + + session2 + .send_and_wait( + MessageOptions::new(CITATION_PROMPT) + .with_wait_timeout(Duration::from_secs(120)) + .with_attachments(vec![pdf_attachment()]), + ) + .await + .expect("send_and_wait"); + + let inference_records = handler.inference_records(); + assert_eq!(inference_records.len(), 1); + assert_anthropic_document_citations_enabled(&inference_records[0].body); + + session2 + .disconnect() + .await + .expect("disconnect resumed session"); + session1 + .disconnect() + .await + .expect("disconnect original session"); + resume_client.stop().await.expect("stop external client"); + server.stop().await.expect("stop TCP server client"); + }) + }) + .await; +} + +fn free_tcp_port() -> u16 { + let listener = TcpListener::bind(("127.0.0.1", 0)).expect("bind free TCP port"); + listener.local_addr().expect("local addr").port() +} diff --git a/rust/tests/e2e/session_fs_sqlite.rs b/rust/tests/e2e/session_fs_sqlite.rs index 0b99d951b..8ba712bb4 100644 --- a/rust/tests/e2e/session_fs_sqlite.rs +++ b/rust/tests/e2e/session_fs_sqlite.rs @@ -4,13 +4,14 @@ use std::sync::{Arc, Mutex}; use async_trait::async_trait; use github_copilot_sdk::session_fs::{FsError, FsErrorKind}; use github_copilot_sdk::{ - Client, DirEntry, DirEntryKind, FileInfo, SessionConfig, SessionFsCapabilities, - SessionFsConfig, SessionFsConventions, SessionFsProvider, SessionFsSqliteProvider, - SessionFsSqliteQueryResult, SessionFsSqliteQueryType, + DirEntry, DirEntryKind, FileInfo, SessionConfig, SessionFsCapabilities, SessionFsConfig, + SessionFsConventions, SessionFsProvider, SessionFsSqliteProvider, SessionFsSqliteQueryResult, + SessionFsSqliteQueryType, SessionFsSqliteTransactionError, SessionFsSqliteTransactionStatement, }; use rusqlite::Connection; -use super::support::with_e2e_context; +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::new("session_fs_sqlite", sqlite_client_options, 2); #[derive(Debug)] struct SqliteCall { @@ -219,40 +220,93 @@ impl SessionFsSqliteProvider for InMemorySqliteProvider { query: &str, _params: Option<&HashMap>, ) -> Result, FsError> { + let mut db_guard = self.db.lock().unwrap(); + let db = Self::get_or_create_db(&mut db_guard)?; + Ok(Some(Self::run_statement( + db, + query_type, + query, + &self.session_id, + &self.sqlite_calls, + )?)) + } + + async fn sqlite_transaction( + &self, + statements: &[SessionFsSqliteTransactionStatement], + ) -> Result, SessionFsSqliteTransactionError> { + let mut db_guard = self.db.lock().unwrap(); + let db = Self::get_or_create_db(&mut db_guard)?; + db.execute_batch("BEGIN IMMEDIATE") + .map_err(|e| Self::classify_sqlite_error(&e))?; + let mut results = Vec::with_capacity(statements.len()); + for statement in statements { + match Self::run_statement( + db, + statement.query_type.clone(), + &statement.query, + &self.session_id, + &self.sqlite_calls, + ) { + Ok(result) => results.push(result), + Err(e) => { + let _ = db.execute_batch("ROLLBACK"); + return Err(Self::classify_error_message(e.to_string())); + } + } + } + db.execute_batch("COMMIT") + .map_err(|e| SessionFsSqliteTransactionError::post_commit_ambiguous(e.to_string()))?; + Ok(results) + } + + async fn sqlite_exists(&self) -> Result { + Ok(self.db.lock().unwrap().is_some()) + } +} + +impl InMemorySqliteProvider { + fn classify_sqlite_error(error: &rusqlite::Error) -> SessionFsSqliteTransactionError { + Self::classify_error_message(error.to_string()) + } + + fn classify_error_message(message: String) -> SessionFsSqliteTransactionError { + if message.contains("locked") || message.contains("busy") { + SessionFsSqliteTransactionError::busy_or_locked(message) + } else { + SessionFsSqliteTransactionError::fatal(message) + } + } + + fn run_statement( + db: &Connection, + query_type: SessionFsSqliteQueryType, + query: &str, + session_id: &str, + sqlite_calls: &Arc>>, + ) -> Result { let qt_str = match query_type { SessionFsSqliteQueryType::Exec => "exec", SessionFsSqliteQueryType::Query => "query", SessionFsSqliteQueryType::Run => "run", SessionFsSqliteQueryType::Unknown => "unknown", }; - self.sqlite_calls.lock().unwrap().push(SqliteCall { - session_id: self.session_id.clone(), + sqlite_calls.lock().unwrap().push(SqliteCall { + session_id: session_id.to_string(), query_type: qt_str.to_string(), query: query.to_string(), }); - let mut db_guard = self.db.lock().unwrap(); - let db = Self::get_or_create_db(&mut db_guard)?; let trimmed = query.trim(); if trimmed.is_empty() { - return Ok(Some(SessionFsSqliteQueryResult { - columns: vec![], - rows: vec![], - rows_affected: 0, - last_insert_rowid: None, - })); + return Ok(SessionFsSqliteQueryResult::default()); } match query_type { SessionFsSqliteQueryType::Exec => { db.execute_batch(trimmed) .map_err(|e| FsError::new(FsErrorKind::Other, e))?; - Ok(Some(SessionFsSqliteQueryResult { - columns: vec![], - rows: vec![], - rows_affected: 0, - last_insert_rowid: None, - })) + Ok(SessionFsSqliteQueryResult::default()) } SessionFsSqliteQueryType::Query => { let mut stmt = db @@ -292,37 +346,28 @@ impl SessionFsSqliteProvider for InMemorySqliteProvider { } rows.push(map); } - Ok(Some(SessionFsSqliteQueryResult { + Ok(SessionFsSqliteQueryResult { columns, rows, rows_affected: 0, last_insert_rowid: None, - })) + }) } SessionFsSqliteQueryType::Run => { let affected = db .execute(trimmed, []) .map_err(|e| FsError::new(FsErrorKind::Other, e))?; let last_id = db.last_insert_rowid(); - Ok(Some(SessionFsSqliteQueryResult { + Ok(SessionFsSqliteQueryResult { columns: vec![], rows: vec![], rows_affected: affected as i64, last_insert_rowid: Some(last_id), - })) + }) } - _ => Ok(Some(SessionFsSqliteQueryResult { - columns: vec![], - rows: vec![], - rows_affected: 0, - last_insert_rowid: None, - })), + _ => Ok(SessionFsSqliteQueryResult::default()), } } - - async fn sqlite_exists(&self) -> Result { - Ok(self.db.lock().unwrap().is_some()) - } } fn session_state_path_sqlite() -> String { @@ -346,13 +391,12 @@ fn sqlite_session_fs_config() -> SessionFsConfig { .with_capabilities(SessionFsCapabilities::new().with_sqlite(true)) } -async fn start_sqlite_client(ctx: &super::support::E2eContext) -> Client { - Client::start( - ctx.client_options() - .with_session_fs(sqlite_session_fs_config()), - ) - .await - .expect("start sqlite client") +fn sqlite_client_options( + context: &super::support::E2eContext, +) -> github_copilot_sdk::ClientOptions { + context + .client_options() + .with_session_fs(sqlite_session_fs_config()) } fn sqlite_session_config( @@ -365,7 +409,8 @@ fn sqlite_session_config( #[tokio::test] async fn should_route_sql_queries_through_the_sessionfs_sqlite_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_fs_sqlite", "should_route_sql_queries_through_the_sessionfs_sqlite_handler", |ctx| { @@ -377,7 +422,7 @@ async fn should_route_sql_queries_through_the_sessionfs_sqlite_handler() { session_id, sqlite_calls.clone(), )); - let client = start_sqlite_client(ctx).await; + let client = ctx.start_client().await; let session = client .create_session( sqlite_session_config(ctx, provider).with_session_id(session_id), @@ -435,7 +480,8 @@ async fn should_route_sql_queries_through_the_sessionfs_sqlite_handler() { #[tokio::test] async fn should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_fs_sqlite", "should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs", |ctx| { @@ -445,7 +491,7 @@ async fn should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs() { let sqlite_calls = Arc::new(Mutex::new(Vec::new())); let provider = Arc::new(InMemorySqliteProvider::new(session_id, sqlite_calls.clone())); let provider_ref = provider.clone(); - let client = start_sqlite_client(ctx).await; + let client = ctx.start_client().await; let session = client .create_session( sqlite_session_config(ctx, provider).with_session_id(session_id), diff --git a/rust/tests/e2e/session_lifecycle.rs b/rust/tests/e2e/session_lifecycle.rs index 59cec701f..545bb4988 100644 --- a/rust/tests/e2e/session_lifecycle.rs +++ b/rust/tests/e2e/session_lifecycle.rs @@ -1,13 +1,13 @@ -use github_copilot_sdk::generated::session_events::SessionEventType; +use github_copilot_sdk::session_events::SessionEventType; use super::support::{ assistant_message_content, collect_until_idle, event_types, wait_for_condition, - with_e2e_context, }; #[tokio::test] async fn should_list_created_sessions_after_sending_a_message() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_lifecycle", "should_list_created_sessions_after_sending_a_message", |ctx| { @@ -59,7 +59,8 @@ async fn should_list_created_sessions_after_sending_a_message() { #[tokio::test] async fn should_delete_session_permanently() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_lifecycle", "should_delete_session_permanently", |ctx| { @@ -103,7 +104,8 @@ async fn should_delete_session_permanently() { #[tokio::test] async fn should_return_events_via_getmessages_after_conversation() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_lifecycle", "should_return_events_via_getmessages_after_conversation", |ctx| { @@ -136,7 +138,8 @@ async fn should_return_events_via_getmessages_after_conversation() { #[tokio::test] async fn should_support_multiple_concurrent_sessions() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_lifecycle", "should_support_multiple_concurrent_sessions", |ctx| { @@ -180,7 +183,8 @@ async fn should_support_multiple_concurrent_sessions() { #[tokio::test] async fn should_isolate_events_between_concurrent_sessions() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "session_lifecycle", "should_isolate_events_between_concurrent_sessions", |ctx| { @@ -255,3 +259,5 @@ async fn should_isolate_events_between_concurrent_sessions() { ) .await; } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("session_lifecycle", 5); diff --git a/rust/tests/e2e/session_todos_changed.rs b/rust/tests/e2e/session_todos_changed.rs new file mode 100644 index 000000000..4b6245206 --- /dev/null +++ b/rust/tests/e2e/session_todos_changed.rs @@ -0,0 +1,64 @@ +use github_copilot_sdk::session_events::SessionEventType; + +use super::support::wait_for_event; + +const PROMPT: &str = concat!( + "Use the sql tool exactly once to execute all three of the following statements ", + "together, in this exact order, in a single sql tool call (a single query string ", + "containing all three statements):\n", + "1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending');\n", + "2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done');\n", + "3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\n", + "Then stop. Do not insert any other rows or create any other tables." +); + +#[tokio::test] +async fn fires_session_todos_changed_and_exposes_rows_and_dependencies() { + super::support::with_shared_e2e_context( + &E2E, + "session_todos_changed", + "fires_session_todos_changed_and_exposes_rows_and_dependencies", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let session = client + .create_session(ctx.approve_all_session_config()) + .await + .expect("create session"); + + let todos_changed = wait_for_event(session.subscribe(), "todos changed", |event| { + event.parsed_type() == SessionEventType::SessionTodosChanged + }); + + session.send_and_wait(PROMPT).await.expect("send"); + todos_changed.await; + + let result = session + .rpc() + .plan() + .read_sql_todos_with_dependencies() + .await + .expect("read SQL todos with dependencies"); + + let mut ids: Vec = + result.rows.into_iter().filter_map(|row| row.id).collect(); + ids.sort(); + assert_eq!(ids, ["alpha", "beta"]); + assert!( + result + .dependencies + .iter() + .any(|dependency| dependency.todo_id == "beta" + && dependency.depends_on == "alpha") + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("session_todos_changed", 1); diff --git a/rust/tests/e2e/skills.rs b/rust/tests/e2e/skills.rs index e0005ddf0..769b28b5f 100644 --- a/rust/tests/e2e/skills.rs +++ b/rust/tests/e2e/skills.rs @@ -2,13 +2,14 @@ use std::path::{Path, PathBuf}; use github_copilot_sdk::CustomAgentConfig; -use super::support::{assert_uuid_like, assistant_message_content, with_e2e_context}; +use super::support::{assert_uuid_like, assistant_message_content}; const SKILL_MARKER: &str = "PINEAPPLE_COCONUT_42"; #[tokio::test] async fn should_load_and_apply_skill_from_skilldirectories() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "skills", "should_load_and_apply_skill_from_skilldirectories", |ctx| { @@ -42,7 +43,8 @@ async fn should_load_and_apply_skill_from_skilldirectories() { #[tokio::test] async fn should_not_apply_skill_when_disabled_via_disabledskills() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "skills", "should_not_apply_skill_when_disabled_via_disabledskills", |ctx| { @@ -77,7 +79,8 @@ async fn should_not_apply_skill_when_disabled_via_disabledskills() { #[tokio::test] async fn should_allow_agent_with_skills_to_invoke_skill() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "skills", "should_allow_agent_with_skills_to_invoke_skill", |ctx| { @@ -118,7 +121,8 @@ async fn should_allow_agent_with_skills_to_invoke_skill() { #[tokio::test] async fn should_not_provide_skills_to_agent_without_skills_field() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "skills", "should_not_provide_skills_to_agent_without_skills_field", |ctx| { @@ -176,3 +180,4 @@ fn create_skill_dir(work_dir: &Path) -> PathBuf { .expect("write skill file"); skills_dir } +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard("skills", 4); diff --git a/rust/tests/e2e/streaming_fidelity.rs b/rust/tests/e2e/streaming_fidelity.rs index 4e0f26ec4..a48177174 100644 --- a/rust/tests/e2e/streaming_fidelity.rs +++ b/rust/tests/e2e/streaming_fidelity.rs @@ -1,17 +1,18 @@ use std::sync::Arc; use github_copilot_sdk::ResumeSessionConfig; -use github_copilot_sdk::generated::session_events::{ +use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::session_events::{ AssistantMessageData, AssistantMessageDeltaData, AssistantMessageStartData, SessionEventType, SessionStartData, }; -use github_copilot_sdk::handler::ApproveAllHandler; -use super::support::{collect_until_idle, event_types, with_e2e_context}; +use super::support::{collect_until_idle, event_types}; #[tokio::test] async fn should_produce_delta_events_when_streaming_is_enabled() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "streaming_fidelity", "should_produce_delta_events_when_streaming_is_enabled", |ctx| { @@ -65,7 +66,7 @@ async fn should_produce_delta_events_when_streaming_is_enabled() { #[tokio::test] async fn should_not_produce_deltas_when_streaming_is_disabled() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "streaming_fidelity", "should_not_produce_deltas_when_streaming_is_disabled", |ctx| { @@ -107,7 +108,7 @@ async fn should_not_produce_deltas_when_streaming_is_disabled() { #[tokio::test] async fn should_produce_deltas_after_session_resume() { - with_e2e_context( + super::support::with_dedicated_e2e_context( "streaming_fidelity", "should_produce_deltas_after_session_resume", |ctx| { @@ -164,8 +165,7 @@ async fn should_produce_deltas_after_session_resume() { #[tokio::test] async fn should_not_produce_deltas_after_session_resume_with_streaming_disabled() { - with_e2e_context( - "streaming_fidelity", + super::support::with_dedicated_e2e_context("streaming_fidelity", "should_not_produce_deltas_after_session_resume_with_streaming_disabled", |ctx| { Box::pin(async move { @@ -227,7 +227,8 @@ async fn should_not_produce_deltas_after_session_resume_with_streaming_disabled( #[tokio::test] async fn should_emit_streaming_deltas_with_reasoning_effort_configured() { - with_e2e_context( + super::support::with_dedicated_group_e2e_context( + &E2E, "streaming_fidelity", "should_emit_streaming_deltas_with_reasoning_effort_configured", |ctx| { @@ -237,6 +238,7 @@ async fn should_emit_streaming_deltas_with_reasoning_effort_configured() { let session = client .create_session( ctx.approve_all_session_config() + .with_model("gpt-5.4") .with_streaming(true) .with_reasoning_effort("high"), ) @@ -279,7 +281,8 @@ async fn should_emit_streaming_deltas_with_reasoning_effort_configured() { #[tokio::test] async fn should_emit_assistantmessage_start_before_deltas_with_matching_messageid() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "streaming_fidelity", "should_emit_assistantmessagestart_before_deltas_with_matching_messageid", |ctx| { @@ -361,3 +364,5 @@ fn assert_has_content_deltas(events: &[github_copilot_sdk::SessionEvent]) { assert!(!data.delta_content.is_empty()); } } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("streaming_fidelity", 3); diff --git a/rust/tests/e2e/subagent_hooks.rs b/rust/tests/e2e/subagent_hooks.rs index 99529c433..fe94c3677 100644 --- a/rust/tests/e2e/subagent_hooks.rs +++ b/rust/tests/e2e/subagent_hooks.rs @@ -5,12 +5,19 @@ use github_copilot_sdk::hooks::{ HookContext, PostToolUseInput, PostToolUseOutput, PreToolUseInput, PreToolUseOutput, SessionHooks, }; +use github_copilot_sdk::{ + CopilotHttpRequest, CopilotHttpResponse, CopilotRequestContext, CopilotRequestError, + CopilotRequestHandler, forward_http, +}; use parking_lot::Mutex; use super::support::with_e2e_context; #[tokio::test] async fn should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls() { + if super::support::skip_inprocess("LLM inference providers are process-global in-process") { + return; + } with_e2e_context( "subagent_hooks", "should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls", @@ -24,16 +31,14 @@ async fn should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls .expect("write test file"); let hook_log = Arc::new(Mutex::new(Vec::::new())); + let request_log = Arc::new(RecordingRequestHandler::default()); - let mut opts = ctx.client_options(); - opts.env.push(( - "COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS".into(), - "true".into(), - )); - - let client = github_copilot_sdk::Client::start(opts) - .await - .expect("start client"); + let client = ctx + .start_llm_client( + Arc::clone(&request_log), + &[("COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS", "true")], + ) + .await; let session = client .create_session(ctx.approve_all_session_config().with_hooks(Arc::new( @@ -88,6 +93,7 @@ async fn should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls task_pre.unwrap().session_id, "Sub-agent tool hooks should have a different sessionId than parent tool hooks" ); + assert_subagent_request_metadata(&request_log.inference_records()); session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); @@ -104,6 +110,90 @@ struct HookEntry { session_id: String, } +#[derive(Clone, Debug)] +struct RequestEntry { + url: String, + agent_id: Option, + parent_agent_id: Option, + interaction_type: Option, +} + +#[derive(Default)] +struct RecordingRequestHandler { + log: Mutex>, +} + +impl RecordingRequestHandler { + fn inference_records(&self) -> Vec { + self.log + .lock() + .iter() + .filter(|entry| is_inference_url(&entry.url)) + .cloned() + .collect() + } +} + +#[async_trait] +impl CopilotRequestHandler for RecordingRequestHandler { + async fn send_request( + &self, + request: CopilotHttpRequest, + ctx: &CopilotRequestContext, + ) -> Result { + self.log.lock().push(RequestEntry { + url: request.url.clone(), + agent_id: ctx.agent_id.clone(), + parent_agent_id: ctx.parent_agent_id.clone(), + interaction_type: ctx.interaction_type.clone(), + }); + forward_http(request).await + } +} + +fn is_inference_url(url: &str) -> bool { + let url = url.to_lowercase(); + url.ends_with("/chat/completions") + || url.ends_with("/responses") + || url.ends_with("/v1/messages") + || url.ends_with("/messages") +} + +fn assert_subagent_request_metadata(records: &[RequestEntry]) { + assert!( + !records.is_empty(), + "request handler should observe inference requests" + ); + let subagent_request = records + .iter() + .find(|entry| { + entry + .parent_agent_id + .as_deref() + .is_some_and(|id| !id.is_empty()) + }) + .expect("sub-agent inference request should carry a parentAgentId"); + assert!( + subagent_request + .agent_id + .as_deref() + .is_some_and(|id| !id.is_empty()), + "sub-agent inference request should carry an agentId" + ); + assert!( + subagent_request + .interaction_type + .as_deref() + .is_some_and(|kind| !kind.is_empty()), + "sub-agent inference request should carry an interactionType" + ); + assert_ne!( + subagent_request.parent_agent_id.as_deref(), + subagent_request.agent_id.as_deref(), + "sub-agent inference request should have distinct parent and child agent ids" + ); +} + struct RecordingHooks { log: Arc>>, } diff --git a/rust/tests/e2e/support.rs b/rust/tests/e2e/support.rs index c78fe366d..d65b049f9 100644 --- a/rust/tests/e2e/support.rs +++ b/rust/tests/e2e/support.rs @@ -1,30 +1,299 @@ -use std::ffi::OsString; +use std::ffi::{OsStr, OsString}; use std::future::Future; use std::io::{BufRead, BufReader, Read, Write}; -use std::net::TcpStream; +use std::net::{TcpStream, ToSocketAddrs}; +use std::ops::Deref; +use std::panic::AssertUnwindSafe; use std::path::{Path, PathBuf}; use std::pin::Pin; use std::process::{Child, Command, Stdio}; use std::sync::LazyLock; -use std::time::Duration; +use std::sync::atomic::{AtomicUsize, Ordering}; +use std::time::{Duration, Instant}; +use futures_util::FutureExt; use github_copilot_sdk::handler::ApproveAllHandler; use github_copilot_sdk::session::Session; use github_copilot_sdk::subscription::{EventSubscription, LifecycleSubscription}; use github_copilot_sdk::{ - CliProgram, Client, ClientOptions, SessionConfig, SessionEvent, SessionId, - SessionLifecycleEvent, Transport, + CliProgram, Client, ClientOptions, CopilotRequestHandler, SessionConfig, SessionEvent, + SessionId, SessionLifecycleEvent, Transport, }; use serde_json::json; -use tokio::sync::Semaphore; +use tokio::sync::{Mutex, Semaphore}; static E2E_CONCURRENCY: LazyLock = LazyLock::new(|| Semaphore::new(e2e_concurrency())); +static SHARED_E2E_RUNTIME: LazyLock = LazyLock::new(|| { + tokio::runtime::Builder::new_multi_thread() + .enable_all() + .thread_name("rust-e2e-shared") + .build() + .expect("create shared E2E runtime") +}); +const SHARED_E2E_CLEANUP_TIMEOUT: Duration = Duration::from_secs(10); pub const DEFAULT_TEST_TOKEN: &str = "rust-e2e-token"; type TestFuture<'a> = Pin + 'a>>; -pub async fn with_e2e_context(category: &str, snapshot_name: &str, test: F) +/// Fixed client options for one explicitly declared shared E2E group. +pub type SharedClientOptions = fn(&E2eContext) -> ClientOptions; + +/// A file- or group-scoped shared E2E runtime. +/// +/// This deliberately has no options-keyed registry: every Rust source group owns +/// its own static instance and selects its options at that declaration site. +pub struct SharedE2eGroup { + category: &'static str, + client_options: SharedClientOptions, + expected_invocations: usize, + completed_invocations: AtomicUsize, + state: Mutex>, +} + +struct SharedE2eState { + context: E2eContext, + client: Client, +} + +/// Test facade over a group's shared context and client. +/// +/// It dereferences to [`E2eContext`] for proxy and fixture helpers, while +/// [`Self::start_client`] returns a clone of the group's already-started client. +pub struct SharedE2eContext<'a> { + context: &'a mut E2eContext, + client: Client, +} + +/// A clone of a group's shared client. +/// +/// `stop` is deliberately a no-op: tests retain their existing local teardown +/// shape without shutting down the next test's runtime. The group stops the +/// actual client after its final expected invocation. Tests that verify +/// stopping or force-stopping a client stay on the dedicated helper. +#[derive(Clone)] +pub struct SharedE2eClient(Client); + +impl Deref for SharedE2eClient { + type Target = Client; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl SharedE2eClient { + pub async fn stop(&self) -> std::result::Result<(), github_copilot_sdk::StopErrors> { + Ok(()) + } +} + +impl Deref for SharedE2eContext<'_> { + type Target = E2eContext; + + fn deref(&self) -> &Self::Target { + self.context + } +} + +impl SharedE2eContext<'_> { + /// Clone the group client. Shared tests must not call `Client::stop`; the + /// group tears it down after its final expected test invocation. + pub async fn start_client(&self) -> SharedE2eClient { + SharedE2eClient(self.client.clone()) + } +} + +impl SharedE2eGroup { + pub const fn new( + category: &'static str, + client_options: SharedClientOptions, + expected_invocations: usize, + ) -> Self { + Self { + category, + client_options, + expected_invocations, + completed_invocations: AtomicUsize::new(0), + state: Mutex::const_new(None), + } + } + + pub const fn standard(category: &'static str, expected_invocations: usize) -> Self { + Self::new( + category, + standard_shared_client_options, + expected_invocations, + ) + } +} + +/// The standard stdio/default-transport options used by most shared groups. +pub fn standard_shared_client_options(context: &E2eContext) -> ClientOptions { + context.client_options() +} + +/// Run a test against an explicitly declared, file/group-scoped shared client. +/// +/// Calls using one group serialize, while different groups still use the suite +/// concurrency limit. Before and after every test, sessions are disconnected and +/// deleted, the work directory is emptied, and the proxy is reconfigured for the +/// test's snapshot so exchanges cannot bleed across tests. After the declared +/// number of invocations completes, the group's client and proxy are stopped. +pub async fn with_shared_e2e_context( + group: &'static SharedE2eGroup, + category: &str, + snapshot_name: &str, + test: F, +) where + F: for<'a> FnOnce(&'a mut SharedE2eContext<'a>) -> TestFuture<'a>, +{ + assert_eq!( + category, group.category, + "shared E2E group category must match the test's snapshots" + ); + let mut state = group.state.lock().await; + let _permit = E2E_CONCURRENCY + .acquire() + .await + .expect("E2E concurrency semaphore should stay open"); + let completed = group.completed_invocations.fetch_add(1, Ordering::Relaxed) + 1; + if state.is_none() { + let context = E2eContext::new(group.category, snapshot_name) + .await + .unwrap_or_else(|err| panic!("create shared E2E context: {err}")); + let _env_guard = InProcessEnvGuard::activate(&context); + let options = (group.client_options)(&context); + let mut startup = SHARED_E2E_RUNTIME.spawn(async move { + let client = Client::start(options).await?; + client.start_router_for_test(); + Ok::<_, github_copilot_sdk::Error>(client) + }); + let client = match tokio::time::timeout(default_test_timeout(), &mut startup).await { + Ok(result) => result + .expect("join shared E2E client startup") + .expect("start shared E2E client"), + Err(_) => { + startup.abort(); + let _ = tokio::time::timeout(SHARED_E2E_CLEANUP_TIMEOUT, startup).await; + panic!( + "timed out after {:?} starting shared E2E client", + default_test_timeout() + ); + } + }; + *state = Some(SharedE2eState { context, client }); + } + + let _env_guard = InProcessEnvGuard::activate( + &state + .as_ref() + .expect("shared E2E state initialized") + .context, + ); + let (result, cleanup_result) = { + let state = state.as_mut().expect("shared E2E state initialized"); + let result = match tokio::time::timeout( + SHARED_E2E_CLEANUP_TIMEOUT, + state.prepare_test(group.category, snapshot_name), + ) + .await + { + Ok(Ok(())) => Ok({ + let mut context = SharedE2eContext { + context: &mut state.context, + client: state.client.clone(), + }; + AssertUnwindSafe(tokio::time::timeout( + default_test_timeout(), + test(&mut context), + )) + .catch_unwind() + .await + }), + Ok(Err(error)) => Err(error), + Err(_) => Err(std::io::Error::other(format!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} preparing shared E2E test" + ))), + }; + let cleanup_result = match tokio::time::timeout( + SHARED_E2E_CLEANUP_TIMEOUT, + state.cleanup_after_test(), + ) + .await + { + Ok(result) => result, + Err(_) => { + state.client.force_stop(); + Err(std::io::Error::other(format!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} cleaning up shared E2E test" + ))) + } + }; + (result, cleanup_result) + }; + + let test_succeeded = matches!(&result, Ok(Ok(Ok(())))); + let skip_writing_cache = !test_succeeded || cleanup_result.is_err(); + let teardown_result = if !test_succeeded + || cleanup_result.is_err() + || is_filtered_test_run() + || completed == group.expected_invocations + { + state + .take() + .expect("shared E2E state initialized") + .shutdown_bounded(skip_writing_cache) + .await + } else { + Ok(()) + }; + + match result { + Ok(Ok(Ok(()))) => { + cleanup_result.unwrap_or_else(|error| panic!("clean up shared E2E test: {error}")); + teardown_result.unwrap_or_else(|error| panic!("tear down shared E2E group: {error}")); + } + Ok(Ok(Err(_))) => { + if let Err(error) = cleanup_result { + eprintln!("failed to clean up timed-out shared E2E test: {error}"); + } + if let Err(error) = teardown_result { + eprintln!("failed to tear down shared E2E group after timeout: {error}"); + } + panic!( + "timed out after {:?} running shared E2E test {}/{}", + default_test_timeout(), + group.category, + snapshot_name + ); + } + Ok(Err(payload)) => { + if let Err(error) = cleanup_result { + eprintln!("failed to clean up shared E2E test after panic: {error}"); + } + if let Err(error) = teardown_result { + eprintln!("failed to tear down shared E2E group after panic: {error}"); + } + std::panic::resume_unwind(payload); + } + Err(error) => { + if let Err(cleanup_error) = cleanup_result { + eprintln!( + "failed to clean up shared E2E test after setup failure: {cleanup_error}" + ); + } + if let Err(teardown_error) = teardown_result { + eprintln!( + "failed to tear down shared E2E group after setup failure: {teardown_error}" + ); + } + panic!("prepare shared E2E test: {error}"); + } + } +} + +pub async fn with_dedicated_e2e_context(category: &str, snapshot_name: &str, test: F) where F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, { @@ -36,6 +305,13 @@ where .await .unwrap_or_else(|err| panic!("create E2E context: {err}")); + // In-process hosting: the runtime loads into this test process and its worker + // inherits the ambient environment (per-client env is not honored in-process, see + // https://github.com/github/copilot-sdk/issues/1934), so mirror this context's env + // onto the process for the duration of the test and restore on drop. Safe because + // E2E_CONCURRENCY is 1 in-process, serializing the whole critical section. + let _env_guard = InProcessEnvGuard::activate(&ctx); + let timed_out = tokio::time::timeout(default_test_timeout(), test(&mut ctx)) .await .is_err(); @@ -49,6 +325,93 @@ where ); } +pub async fn with_dedicated_group_e2e_context( + _group: &'static SharedE2eGroup, + category: &str, + snapshot_name: &str, + test: F, +) where + F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, +{ + with_dedicated_e2e_context(category, snapshot_name, test).await; +} + +pub async fn skip_shared_e2e_inprocess(group: &'static SharedE2eGroup, reason: &str) -> bool { + if !skip_inprocess(reason) { + return false; + } + + let mut state = group.state.lock().await; + let _permit = E2E_CONCURRENCY + .acquire() + .await + .expect("E2E concurrency semaphore should stay open"); + let completed = group.completed_invocations.fetch_add(1, Ordering::Relaxed) + 1; + if completed == group.expected_invocations + && let Some(state) = state.take() + { + state + .shutdown_bounded(false) + .await + .unwrap_or_else(|error| panic!("tear down shared E2E group after skip: {error}")); + } + true +} + +/// Run a dedicated one-client E2E test. +/// +/// New tests should call [`with_dedicated_e2e_context`] to make the lifecycle +/// choice visible at the call site. This name remains for existing dedicated +/// tests while they are migrated group by group. +pub async fn with_e2e_context(category: &str, snapshot_name: &str, test: F) +where + F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, +{ + with_dedicated_e2e_context(category, snapshot_name, test).await; +} + +/// Like [`with_dedicated_e2e_context`] but starts the CapiProxy without loading a +/// recorded snapshot. Used by the LLM inference callback tests, whose +/// registered provider fabricates every model-layer response so no CAPI +/// replay is needed — only the auth/user endpoints are served by the proxy. +pub async fn with_dedicated_e2e_context_no_snapshot(test: F) +where + F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, +{ + let _permit = E2E_CONCURRENCY + .acquire() + .await + .expect("E2E concurrency semaphore should stay open"); + let mut ctx = E2eContext::new_no_snapshot() + .await + .unwrap_or_else(|err| panic!("create E2E context: {err}")); + + // See `with_e2e_context` for why the in-process transport mirrors env onto the + // process (restored on drop). + let _env_guard = InProcessEnvGuard::activate(&ctx); + + let timed_out = tokio::time::timeout(default_test_timeout(), test(&mut ctx)) + .await + .is_err(); + ctx.cleanup(timed_out) + .await + .unwrap_or_else(|err| panic!("clean up E2E context: {err}")); + assert!( + !timed_out, + "timed out after {:?} running no-snapshot E2E test", + default_test_timeout() + ); +} + +/// Dedicated no-snapshot compatibility helper. See +/// [`with_dedicated_e2e_context_no_snapshot`]. +pub async fn with_e2e_context_no_snapshot(test: F) +where + F: for<'a> FnOnce(&'a mut E2eContext) -> TestFuture<'a>, +{ + with_dedicated_e2e_context_no_snapshot(test).await; +} + pub struct E2eContext { repo_root: PathBuf, cli_path: PathBuf, @@ -75,6 +438,37 @@ impl E2eContext { proxy: Some(proxy), }; ctx.configure(category, snapshot_name)?; + ctx.set_default_copilot_user(); + Ok(ctx) + } + + async fn new_no_snapshot() -> std::io::Result { + let repo_root = repo_root(); + let cli_path = cli_path(&repo_root)?; + let home_dir = tempfile::tempdir()?; + let work_dir = tempfile::tempdir()?; + let proxy_root = repo_root.clone(); + let proxy = tokio::task::spawn_blocking(move || CapiProxy::start(&proxy_root)) + .await + .map_err(|err| std::io::Error::other(format!("proxy startup task failed: {err}")))??; + let ctx = Self { + repo_root, + cli_path, + home_dir, + work_dir, + proxy: Some(proxy), + }; + // Initialize proxy state without replaying any recorded exchanges: the + // snapshot path intentionally does not exist, so `/copilot_internal/user` + // and the default `/models` catalog are served while all model-layer + // traffic is fabricated by the registered inference callback. + let dummy_snapshot = ctx.work_dir.path().join("__no_snapshot__.yaml"); + ctx.proxy() + .configure(&dummy_snapshot, ctx.work_dir.path()) + .map_err(|err| { + std::io::Error::other(format!("configure proxy without snapshot failed: {err}")) + })?; + ctx.set_default_copilot_user(); Ok(ctx) } @@ -99,24 +493,55 @@ impl E2eContext { } pub fn client_options(&self) -> ClientOptions { - ClientOptions::new() - .with_program(CliProgram::Path(PathBuf::from(node_program()))) - .with_prefix_args([self.cli_path.as_os_str().to_owned()]) - .with_cwd(self.work_dir.path()) - .with_env(self.environment()) - .with_use_logged_in_user(false) + client_options_for_cli(&self.cli_path, self.work_dir.path(), self.environment()) } pub fn client_options_with_transport(&self, transport: Transport) -> ClientOptions { self.client_options().with_transport(transport) } + pub fn client_options_with_github_token(&self, token: &str) -> ClientOptions { + self.client_options().with_github_token(token) + } + pub async fn start_client(&self) -> Client { Client::start(self.client_options()) .await .expect("start E2E client") } + /// Start a client that hosts the runtime in-process over FFI + /// ([`Transport::InProcess`]). Unlike the stdio harness, the CLI + /// entrypoint is passed as the program directly (the FFI host builds the + /// `node --embedded-host` argv itself and loads the sibling + /// runtime cdylib), so a `.js` entrypoint is not split into node + + /// prefix_args here. + #[cfg_attr(not(feature = "bundled-in-process"), allow(dead_code))] + pub async fn start_inprocess_client(&self) -> Client { + let options = ClientOptions::new().with_transport(Transport::InProcess); + Client::start(options) + .await + .expect("start in-process FFI E2E client") + } + + /// Start a client wired to a Copilot request handler, appending `extra_env` + /// to the spawned runtime's environment (used to flip the WebSocket ExP + /// flag for the WS transport tests). + pub async fn start_llm_client(&self, handler: H, extra_env: &[(&str, &str)]) -> Client + where + H: CopilotRequestHandler, + { + let mut env = self.environment(); + env.extend( + extra_env + .iter() + .map(|(key, value)| (OsString::from(*key), OsString::from(*value))), + ); + let options = client_options_for_cli(&self.cli_path, self.work_dir.path(), env) + .with_request_handler(handler); + Client::start(options).await.expect("start E2E LLM client") + } + #[expect(dead_code, reason = "used by follow-on E2E ports")] pub async fn start_tcp_client(&self, port: u16, token: &str) -> Client { Client::start(self.client_options_with_transport(Transport::Tcp { @@ -230,10 +655,17 @@ impl E2eContext { .to_owned(), ), ]); - if std::env::var("GITHUB_ACTIONS").as_deref() == Ok("true") { - env.push(("GH_TOKEN".into(), "fake-token-for-e2e-tests".into())); - env.push(("GITHUB_TOKEN".into(), "fake-token-for-e2e-tests".into())); - } + env.extend(isolated_cache_environment(self.home_dir.path())); + env.extend([ + ("COPILOT_MCP_APPS".into(), "true".into()), + ("MCP_APPS".into(), "true".into()), + ("GH_TOKEN".into(), DEFAULT_TEST_TOKEN.into()), + ("GITHUB_TOKEN".into(), DEFAULT_TEST_TOKEN.into()), + ("GH_ENTERPRISE_TOKEN".into(), "".into()), + ("GITHUB_ENTERPRISE_TOKEN".into(), "".into()), + ("COPILOT_HMAC_KEY".into(), "".into()), + ("CAPI_HMAC_KEY".into(), "".into()), + ]); env } @@ -242,6 +674,130 @@ impl E2eContext { } } +impl SharedE2eState { + async fn prepare_test(&mut self, category: &str, snapshot_name: &str) -> std::io::Result<()> { + self.cleanup_sessions().await?; + clear_directory_contents(self.context.work_dir())?; + self.context.configure(category, snapshot_name)?; + self.context.set_default_copilot_user(); + Ok(()) + } + + async fn cleanup_after_test(&mut self) -> std::io::Result<()> { + self.cleanup_sessions().await?; + clear_directory_contents(self.context.work_dir()) + } + + async fn cleanup_sessions(&self) -> std::io::Result<()> { + self.client + .cleanup_sessions_for_test() + .await + .map_err(|err| { + std::io::Error::other(format!("clean up shared E2E sessions failed: {err}")) + }) + } + + async fn shutdown_bounded(mut self, skip_writing_cache: bool) -> std::io::Result<()> { + let client_result = + match tokio::time::timeout(SHARED_E2E_CLEANUP_TIMEOUT, self.client.stop()).await { + Ok(result) => result.map_err(|err| { + std::io::Error::other(format!("stop shared E2E client failed: {err}")) + }), + Err(_) => { + self.client.force_stop(); + Err(std::io::Error::other(format!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} stopping shared E2E client" + ))) + } + }; + let proxy_result = self.context.cleanup(skip_writing_cache).await; + + match (client_result, proxy_result) { + (Ok(()), Ok(())) => Ok(()), + (Err(error), Ok(())) | (Ok(()), Err(error)) => Err(error), + (Err(client_error), Err(proxy_error)) => Err(std::io::Error::other(format!( + "{client_error}; stop shared E2E proxy failed: {proxy_error}" + ))), + } + } +} + +fn wait_for_child_exit(child: &mut Child) -> std::io::Result<()> { + let deadline = Instant::now() + SHARED_E2E_CLEANUP_TIMEOUT; + loop { + if child.try_wait()?.is_some() { + return Ok(()); + } + if Instant::now() >= deadline { + kill_and_wait_child(child); + return Err(std::io::Error::other(format!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} waiting for child process" + ))); + } + std::thread::sleep(Duration::from_millis(25)); + } +} + +fn kill_and_wait_child(child: &mut Child) { + if let Err(error) = child.kill() { + eprintln!("failed to kill E2E child process: {error}"); + } + let deadline = Instant::now() + SHARED_E2E_CLEANUP_TIMEOUT; + loop { + match child.try_wait() { + Ok(Some(_)) => return, + Ok(None) => {} + Err(error) => { + eprintln!("failed to inspect E2E child process after kill: {error}"); + return; + } + } + if Instant::now() >= deadline { + eprintln!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} waiting for killed E2E child process" + ); + return; + } + std::thread::sleep(Duration::from_millis(25)); + } +} + +fn connect_with_timeout(host: &str, port: u16) -> std::io::Result { + let mut last_error = None; + for address in (host, port).to_socket_addrs()? { + match TcpStream::connect_timeout(&address, SHARED_E2E_CLEANUP_TIMEOUT) { + Ok(stream) => { + stream.set_read_timeout(Some(SHARED_E2E_CLEANUP_TIMEOUT))?; + stream.set_write_timeout(Some(SHARED_E2E_CLEANUP_TIMEOUT))?; + return Ok(stream); + } + Err(error) => last_error = Some(error), + } + } + Err(last_error.unwrap_or_else(|| { + std::io::Error::other(format!("no socket addresses resolved for {host}:{port}")) + })) +} + +fn is_filtered_test_run() -> bool { + std::env::args().skip(1).any(|arg| { + !arg.starts_with('-') || matches!(arg.as_str(), "--ignored" | "--include-ignored") + }) +} + +fn clear_directory_contents(directory: &Path) -> std::io::Result<()> { + for entry in std::fs::read_dir(directory)? { + let entry = entry?; + let path = entry.path(); + if entry.file_type()?.is_dir() { + std::fs::remove_dir_all(path)?; + } else { + std::fs::remove_file(path)?; + } + } + Ok(()) +} + impl Drop for E2eContext { fn drop(&mut self) { if let Some(mut proxy) = self.proxy.take() { @@ -288,11 +844,11 @@ where }); let is_allowed_rate_limit = allow_rate_limit_error && event.parsed_type() - == github_copilot_sdk::generated::session_events::SessionEventType::SessionError + == github_copilot_sdk::session_events::SessionEventType::SessionError && event.data.get("errorType").and_then(|value| value.as_str()) == Some("rate_limit"); if event.parsed_type() - == github_copilot_sdk::generated::session_events::SessionEventType::SessionError + == github_copilot_sdk::session_events::SessionEventType::SessionError && !is_allowed_rate_limit { panic!( @@ -368,9 +924,9 @@ pub async fn collect_until_idle(mut events: EventSubscription) -> Vec Vec<&str> { #[allow(dead_code, reason = "used by follow-on E2E ports")] pub async fn wait_for_idle(session: &Session) -> SessionEvent { wait_for_event(session.subscribe(), "session.idle event", |event| { - event.parsed_type() - == github_copilot_sdk::generated::session_events::SessionEventType::SessionIdle + event.parsed_type() == github_copilot_sdk::session_events::SessionEventType::SessionIdle }) .await } @@ -417,14 +972,14 @@ pub async fn last_assistant_message(session: &Session) -> SessionEvent { .rev() .find(|event| { event.parsed_type() - == github_copilot_sdk::generated::session_events::SessionEventType::AssistantMessage + == github_copilot_sdk::session_events::SessionEventType::AssistantMessage }) .expect("assistant.message event") } pub fn assistant_message_content(event: &SessionEvent) -> String { event - .typed_data::() + .typed_data::() .expect("assistant.message data") .content } @@ -456,6 +1011,12 @@ fn default_test_timeout() -> Duration { } fn e2e_concurrency() -> usize { + // The in-process transport mirrors per-test environment onto the shared process + // environment (see `InProcessEnvGuard`), which is only coherent when one test runs + // at a time. Force serial execution in-process; otherwise honor RUST_E2E_CONCURRENCY. + if is_inprocess_default() { + return 1; + } std::env::var("RUST_E2E_CONCURRENCY") .ok() .and_then(|value| value.parse::().ok()) @@ -463,6 +1024,104 @@ fn e2e_concurrency() -> usize { .unwrap_or(4) } +/// True when the E2E suite runs over the in-process (FFI) transport, i.e. the SDK +/// resolves `COPILOT_SDK_DEFAULT_CONNECTION=inprocess` to [`Transport::InProcess`]. +pub fn is_inprocess_default() -> bool { + std::env::var("COPILOT_SDK_DEFAULT_CONNECTION") + .map(|value| value.eq_ignore_ascii_case("inprocess")) + .unwrap_or(false) +} + +/// Skip guard for E2E tests exercising features the in-process (FFI) transport does not +/// support (the runtime loads into the shared host process). Returns `true` — and logs — +/// when running in-process so the caller can `return` early; such tests remain covered +/// by the default (stdio) transport. See . +pub fn skip_inprocess(reason: &str) -> bool { + if is_inprocess_default() { + eprintln!("skipping test over the in-process (FFI) transport: {reason}"); + true + } else { + false + } +} + +/// Mirrors an [`E2eContext`]'s environment onto the real process environment for the +/// in-process transport, whose worker inherits this process's ambient environment +/// rather than a per-client env block. Restores the previous values on drop. Only the +/// in-process transport needs this; for stdio/tcp the environment is handed to the +/// spawned child directly. Auth flows via GH_TOKEN/GITHUB_TOKEN and HMAC is disabled so +/// host-side auth resolution picks the token the replay snapshots expect. +struct InProcessEnvGuard { + saved: Vec<(OsString, Option)>, + previous_cwd: PathBuf, +} + +impl InProcessEnvGuard { + /// Returns `Some` guard (having applied the env) when in-process, else `None`. + fn activate(ctx: &E2eContext) -> Option { + if !is_inprocess_default() { + return None; + } + let mut pairs: Vec<(OsString, OsString)> = ctx.environment(); + pairs.retain(|(key, _)| { + key.as_os_str() != OsStr::new("COPILOT_HMAC_KEY") + && key.as_os_str() != OsStr::new("CAPI_HMAC_KEY") + }); + pairs.push(("COPILOT_SDK_AUTH_TOKEN".into(), "".into())); + pairs.push(( + "COPILOT_CLI_PATH".into(), + ctx.cli_path.clone().into_os_string(), + )); + // Some tests opt into gated runtime APIs via per-client `options.env`, which the + // in-process transport does not pass to the shared native runtime (see issue #1934). + // These are process-global runtime gates (not per-client behavior), so applying + // them to the host process for the serial in-process suite is equivalent and + // inert for tests that don't exercise the gated API. + pairs.push(("COPILOT_ALLOW_GET_PROVIDER_ENDPOINT".into(), "true".into())); + pairs.push(( + "COPILOT_EXP_COPILOT_CLI_WEBSOCKET_RESPONSES".into(), + "true".into(), + )); + pairs.push(( + "COPILOT_EXP_COPILOT_CLI_SESSION_BASED_SUBAGENTS".into(), + "true".into(), + )); + + let mut saved: Vec<(OsString, Option)> = Vec::new(); + for (key, value) in &pairs { + saved.push((key.clone(), std::env::var_os(key))); + // SAFETY: the E2E suite runs serially in-process (concurrency 1), so no + // other thread races these process-wide env mutations. + unsafe { std::env::set_var(key, value) }; + } + for key in ["COPILOT_HMAC_KEY", "CAPI_HMAC_KEY"] { + let key = OsString::from(key); + saved.push((key.clone(), std::env::var_os(&key))); + // SAFETY: as above, the in-process suite is serialized. + unsafe { std::env::remove_var(key) }; + } + let previous_cwd = std::env::current_dir().expect("read in-process test cwd"); + std::env::set_current_dir(ctx.work_dir()).expect("set in-process test cwd"); + Some(Self { + saved, + previous_cwd, + }) + } +} + +impl Drop for InProcessEnvGuard { + fn drop(&mut self) { + std::env::set_current_dir(&self.previous_cwd).expect("restore in-process test cwd"); + for (key, previous) in self.saved.iter().rev() { + // SAFETY: as in `activate` — serial execution in-process. + match previous { + Some(value) => unsafe { std::env::set_var(key, value) }, + None => unsafe { std::env::remove_var(key) }, + } + } + } +} + pub fn get_system_message(exchange: &serde_json::Value) -> String { exchange .get("request") @@ -518,29 +1177,77 @@ fn cli_path(repo_root: &Path) -> std::io::Result { } } - let path = repo_root + // The `@github/copilot` package is a thin loader; the runnable `index.js` + // ships in a platform-specific `@github/copilot--` package, + // exactly one of which is installed. Resolve whichever one is present. + let github_dir = repo_root .join("nodejs") .join("node_modules") - .join("@github") - .join("copilot") - .join("index.js"); - if path.exists() { - return Ok(path); + .join("@github"); + if let Ok(entries) = std::fs::read_dir(&github_dir) { + for entry in entries.flatten() { + if entry.file_name().to_string_lossy().starts_with("copilot-") { + let candidate = entry.path().join("index.js"); + if candidate.exists() { + return Ok(candidate); + } + } + } } Err(std::io::Error::new( std::io::ErrorKind::NotFound, format!( - "CLI not found at {}; run npm install in nodejs first", - path.display() + "CLI not found under {}; run npm install in nodejs first", + github_dir.display() ), )) } +#[allow(deprecated)] +fn client_options_for_cli( + cli_path: &Path, + cwd: &Path, + env: Vec<(OsString, OsString)>, +) -> ClientOptions { + if is_inprocess_default() { + return ClientOptions::new(); + } + let options = ClientOptions::new() + .with_cwd(cwd) + .with_env(env) + .with_use_logged_in_user(false); + if cli_path + .extension() + .and_then(|extension| extension.to_str()) + .is_some_and(|extension| extension.eq_ignore_ascii_case("js")) + { + options + .with_program(CliProgram::Path(PathBuf::from(node_program()))) + .with_prefix_args([cli_path.as_os_str().to_owned()]) + } else { + options.with_program(CliProgram::Path(cli_path.to_path_buf())) + } +} + fn canonical_temp_path(path: &Path) -> PathBuf { std::fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf()) } +fn isolated_cache_environment(path: &Path) -> [(OsString, OsString); 2] { + let home_dir = canonical_temp_path(path); + let cache_dir = home_dir.join(".cache"); + // COPILOT_HOME does not redirect platform cache paths, so isolate the cache + // to prevent concurrent CLI processes from sharing mutable startup state. + [ + ( + "COPILOT_CACHE_HOME".into(), + cache_dir.join("copilot").into_os_string(), + ), + ("XDG_CACHE_HOME".into(), cache_dir.into_os_string()), + ] +} + struct CapiProxy { child: Option, proxy_url: String, @@ -560,38 +1267,85 @@ impl CapiProxy { .spawn()?; let stdout = child.stdout.take().expect("proxy stdout"); - let reader = BufReader::new(stdout); + let (line_tx, line_rx) = std::sync::mpsc::channel(); + std::thread::spawn(move || { + for line in BufReader::new(stdout).lines() { + let failed = line.is_err(); + if line_tx.send(line).is_err() || failed { + break; + } + } + }); let re = regex::Regex::new(r"Listening: (http://[^\s]+)\s+(\{.*\})$").unwrap(); - for line in reader.lines() { - let line = line?; + let deadline = Instant::now() + SHARED_E2E_CLEANUP_TIMEOUT; + while let Some(remaining) = deadline.checked_duration_since(Instant::now()) { + let line = match line_rx.recv_timeout(remaining) { + Ok(Ok(line)) => line, + Ok(Err(error)) => { + kill_and_wait_child(&mut child); + return Err(error); + } + Err(std::sync::mpsc::RecvTimeoutError::Disconnected) => { + kill_and_wait_child(&mut child); + return Err(std::io::Error::other("proxy exited before startup")); + } + Err(std::sync::mpsc::RecvTimeoutError::Timeout) => break, + }; if let Some(captures) = re.captures(&line) { - let metadata: serde_json::Value = - serde_json::from_str(captures.get(2).unwrap().as_str())?; - let connect_proxy_url = metadata - .get("connectProxyUrl") - .and_then(|value| value.as_str()) - .expect("connectProxyUrl") - .to_string(); - let ca_file_path = metadata - .get("caFilePath") - .and_then(|value| value.as_str()) - .expect("caFilePath") - .to_string(); + let parsed = (|| { + let proxy_url = captures + .get(1) + .ok_or_else(|| { + std::io::Error::other("proxy startup line missing URL capture") + })? + .as_str() + .to_string(); + let metadata_text = captures.get(2).ok_or_else(|| { + std::io::Error::other("proxy startup line missing metadata capture") + })?; + let metadata: serde_json::Value = serde_json::from_str(metadata_text.as_str())?; + let connect_proxy_url = metadata + .get("connectProxyUrl") + .and_then(|value| value.as_str()) + .ok_or_else(|| { + std::io::Error::other("proxy startup metadata missing connectProxyUrl") + })? + .to_string(); + let ca_file_path = metadata + .get("caFilePath") + .and_then(|value| value.as_str()) + .ok_or_else(|| { + std::io::Error::other("proxy startup metadata missing caFilePath") + })? + .to_string(); + Ok::<_, std::io::Error>((proxy_url, connect_proxy_url, ca_file_path)) + })(); + let (proxy_url, connect_proxy_url, ca_file_path) = match parsed { + Ok(metadata) => metadata, + Err(error) => { + kill_and_wait_child(&mut child); + return Err(error); + } + }; return Ok(Self { child: Some(child), - proxy_url: captures.get(1).unwrap().as_str().to_string(), + proxy_url, connect_proxy_url, ca_file_path, }); } if line.contains("Listening: ") { + kill_and_wait_child(&mut child); return Err(std::io::Error::other(format!( "proxy startup line missing metadata: {line}" ))); } } - Err(std::io::Error::other("proxy exited before startup")) + kill_and_wait_child(&mut child); + Err(std::io::Error::other(format!( + "timed out after {SHARED_E2E_CLEANUP_TIMEOUT:?} waiting for proxy startup" + ))) } fn url(&self) -> &str { @@ -632,7 +1386,7 @@ impl CapiProxy { }; let result = self.post_json(path, ""); if let Some(mut child) = self.child.take() { - let _ = child.wait(); + wait_for_child_exit(&mut child)?; } result } @@ -684,7 +1438,7 @@ impl CapiProxy { fn request(&self, method: &str, path: &str, body: &str) -> std::io::Result { let (host, port) = parse_http_url(&self.proxy_url)?; - let mut stream = TcpStream::connect((host.as_str(), port))?; + let mut stream = connect_with_timeout(&host, port)?; write!( stream, "{method} {path} HTTP/1.1\r\nHost: {host}:{port}\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{body}", @@ -761,3 +1515,25 @@ fn node_program() -> &'static str { fn npx_program() -> &'static str { if cfg!(windows) { "npx.cmd" } else { "npx" } } + +#[test] +fn e2e_context_isolates_copilot_cache() { + let home_dir = tempfile::tempdir().expect("create test home"); + let home_dir = canonical_temp_path(home_dir.path()); + let cache_dir = home_dir.join(".cache"); + let expected = [ + ("COPILOT_CACHE_HOME", cache_dir.join("copilot")), + ("XDG_CACHE_HOME", cache_dir), + ]; + + let environment = isolated_cache_environment(&home_dir); + + for (key, value) in expected { + assert!( + environment.iter().any(|(actual_key, actual_value)| { + actual_key == key && actual_value == value.as_os_str() + }), + "{key} should use the isolated test home" + ); + } +} diff --git a/rust/tests/e2e/system_message_sections.rs b/rust/tests/e2e/system_message_sections.rs new file mode 100644 index 000000000..f13336752 --- /dev/null +++ b/rust/tests/e2e/system_message_sections.rs @@ -0,0 +1,117 @@ +use std::collections::HashMap; + +use github_copilot_sdk::{SectionOverride, SystemMessageConfig}; + +use super::support::assistant_message_content; + +#[tokio::test] +async fn should_use_replaced_identity_section_in_response() { + super::support::with_shared_e2e_context( + &E2E, + "system_message_sections", + "should_use_replaced_identity_section_in_response", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut sections = HashMap::new(); + sections.insert( + "identity".to_string(), + SectionOverride { + action: Some("replace".to_string()), + content: Some( + "You are a helpful gardening assistant called Botanica. \ + You only answer questions about plants and gardening." + .to_string(), + ), + }, + ); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config().with_system_message( + SystemMessageConfig::new() + .with_mode("customize") + .with_sections(sections), + ), + ) + .await + .expect("create session"); + + let answer = session + .send_and_wait("Who are you?") + .await + .expect("send") + .expect("assistant message"); + let content = assistant_message_content(&answer).to_lowercase(); + assert!( + content.contains("botanica") + || content.contains("garden") + || content.contains("plant"), + "Expected response to reflect the replaced identity section, but got: {}", + assistant_message_content(&answer) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} + +#[tokio::test] +async fn should_use_replaced_preamble_section_in_response() { + super::support::with_shared_e2e_context( + &E2E, + "system_message_sections", + "should_use_replaced_preamble_section_in_response", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let mut sections = HashMap::new(); + sections.insert( + "preamble".to_string(), + SectionOverride { + action: Some("replace".to_string()), + content: Some( + "You are a helpful gardening assistant called Botanica. \ + You only answer questions about plants and gardening." + .to_string(), + ), + }, + ); + let client = ctx.start_client().await; + let session = client + .create_session( + ctx.approve_all_session_config().with_system_message( + SystemMessageConfig::new() + .with_mode("customize") + .with_sections(sections), + ), + ) + .await + .expect("create session"); + + let answer = session + .send_and_wait("Who are you?") + .await + .expect("send") + .expect("assistant message"); + let content = assistant_message_content(&answer).to_lowercase(); + assert!( + content.contains("botanica") + || content.contains("garden") + || content.contains("plant"), + "Expected response to reflect the replaced preamble section, but got: {}", + assistant_message_content(&answer) + ); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) + .await; +} +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("system_message_sections", 2); diff --git a/rust/tests/e2e/telemetry.rs b/rust/tests/e2e/telemetry.rs index 10111be52..f6905427a 100644 --- a/rust/tests/e2e/telemetry.rs +++ b/rust/tests/e2e/telemetry.rs @@ -9,10 +9,15 @@ use github_copilot_sdk::{ }; use serde_json::json; -use super::support::{assistant_message_content, wait_for_condition, with_e2e_context}; +use super::support::{assistant_message_content, with_e2e_context}; #[tokio::test] async fn should_export_file_telemetry_for_sdk_interactions() { + // Telemetry lowers to environment variables the in-process worker cannot receive + // per-client; covered by the default (stdio) transport. See issue #1934. + if super::support::skip_inprocess("telemetry configuration is not honored in-process") { + return; + } with_e2e_context( "telemetry", "should_export_file_telemetry_for_sdk_interactions", @@ -66,7 +71,7 @@ async fn should_export_file_telemetry_for_sdk_interactions() { session.disconnect().await.expect("disconnect session"); client.stop().await.expect("stop client"); - let entries = read_telemetry_entries(&telemetry_path).await; + let entries = read_telemetry_entries(&telemetry_path); let spans: Vec<_> = entries .iter() .filter(|entry| string_property(entry, "type") == Some("span")) @@ -155,34 +160,13 @@ impl ToolHandler for EchoTelemetryTool { } } -async fn read_telemetry_entries(path: &std::path::Path) -> Vec { - wait_for_condition("telemetry file to contain spans", || { - let path = path.to_path_buf(); - async move { - read_telemetry_entries_once(&path).is_ok_and(|entries| { - entries.iter().any(|entry| { - string_property(entry, "type") == Some("span") - && string_attribute(entry, "gen_ai.operation.name").as_deref() - == Some("invoke_agent") - }) - }) - } - }) - .await; - read_telemetry_entries_once(path).expect("read telemetry entries") -} - -fn read_telemetry_entries_once(path: &std::path::Path) -> std::io::Result> { - if !path.exists() || path.metadata()?.len() == 0 { - return Ok(Vec::new()); - } - std::fs::read_to_string(path).map(|content| { - content - .lines() - .filter(|line| !line.trim().is_empty()) - .map(|line| serde_json::from_str(line).expect("telemetry JSON line")) - .collect() - }) +fn read_telemetry_entries(path: &std::path::Path) -> Vec { + std::fs::read_to_string(path) + .expect("read telemetry entries") + .lines() + .filter(|line| !line.trim().is_empty()) + .map(|line| serde_json::from_str(line).expect("telemetry JSON line")) + .collect() } fn find_span<'a>(spans: &'a [&'a serde_json::Value], operation: &str) -> &'a serde_json::Value { diff --git a/rust/tests/e2e/tool_results.rs b/rust/tests/e2e/tool_results.rs index 4b731c286..c46cacbf3 100644 --- a/rust/tests/e2e/tool_results.rs +++ b/rust/tests/e2e/tool_results.rs @@ -1,8 +1,8 @@ use std::collections::HashMap; use std::sync::Arc; -use github_copilot_sdk::generated::session_events::{SessionEventType, ToolExecutionCompleteData}; use github_copilot_sdk::handler::ApproveAllHandler; +use github_copilot_sdk::session_events::{SessionEventType, ToolExecutionCompleteData}; use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{ Error, SessionConfig, Tool, ToolInvocation, ToolResult, ToolResultExpanded, @@ -10,11 +10,12 @@ use github_copilot_sdk::{ use serde_json::json; use tokio::sync::mpsc; -use super::support::{assistant_message_content, collect_until_idle, with_e2e_context}; +use super::support::{assistant_message_content, collect_until_idle}; #[tokio::test] async fn should_handle_structured_toolresultobject_from_custom_tool() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "tool_results", "should_handle_structured_toolresultobject_from_custom_tool", |ctx| { @@ -41,7 +42,7 @@ async fn should_handle_structured_toolresultobject_from_custom_tool() { #[tokio::test] async fn should_handle_tool_result_with_failure_resulttype() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "tool_results", "should_handle_tool_result_with_failure_resulttype", |ctx| { @@ -69,7 +70,8 @@ async fn should_handle_tool_result_with_failure_resulttype() { #[tokio::test] async fn should_preserve_tooltelemetry_and_not_stringify_structured_results_for_llm() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "tool_results", "should_preserve_tooltelemetry_and_not_stringify_structured_results_for_llm", |ctx| { @@ -116,7 +118,7 @@ async fn should_preserve_tooltelemetry_and_not_stringify_structured_results_for_ #[tokio::test] async fn should_handle_tool_result_with_rejected_resulttype() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "tool_results", "should_handle_tool_result_with_rejected_resulttype", |ctx| { @@ -153,7 +155,7 @@ async fn should_handle_tool_result_with_rejected_resulttype() { #[tokio::test] async fn should_handle_tool_result_with_denied_resulttype() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "tool_results", "should_handle_tool_result_with_denied_resulttype", |ctx| { @@ -213,14 +215,7 @@ async fn recv_called(receiver: &mut mpsc::UnboundedReceiver<()>, description: &' } fn expanded(text: impl Into, result_type: impl Into) -> ToolResult { - ToolResult::Expanded(ToolResultExpanded { - text_result_for_llm: text.into(), - result_type: result_type.into(), - binary_results_for_llm: None, - session_log: None, - error: None, - tool_telemetry: None, - }) + ToolResult::Expanded(ToolResultExpanded::new(text, result_type)) } fn weather_tool() -> Tool { @@ -363,3 +358,5 @@ fn string_tool( "required": [parameter], })) } +static E2E: super::support::SharedE2eGroup = + super::support::SharedE2eGroup::standard("tool_results", 5); diff --git a/rust/tests/e2e/tools.rs b/rust/tests/e2e/tools.rs index 85d15b571..586a31d3a 100644 --- a/rust/tests/e2e/tools.rs +++ b/rust/tests/e2e/tools.rs @@ -4,16 +4,16 @@ use github_copilot_sdk::handler::{ApproveAllHandler, PermissionHandler, Permissi use github_copilot_sdk::tool::ToolHandler; use github_copilot_sdk::{ Error, PermissionRequestData, RequestId, SessionConfig, SessionId, Tool, ToolInvocation, - ToolResult, + ToolResult, ToolSet, }; use serde_json::json; -use tokio::sync::mpsc; +use tokio::sync::{Mutex, mpsc}; -use super::support::{assistant_message_content, recv_with_timeout, with_e2e_context}; +use super::support::{assistant_message_content, recv_with_timeout}; #[tokio::test] async fn invokes_built_in_tools() { - with_e2e_context("tools", "invokes_built_in_tools", |ctx| { + super::support::with_shared_e2e_context(&E2E, "tools", "invokes_built_in_tools", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); std::fs::write( @@ -43,7 +43,7 @@ async fn invokes_built_in_tools() { #[tokio::test] async fn invokes_custom_tool() { - with_e2e_context("tools", "invokes_custom_tool", |ctx| { + super::support::with_shared_e2e_context(&E2E, "tools", "invokes_custom_tool", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -73,9 +73,58 @@ async fn invokes_custom_tool() { .await; } +#[tokio::test] +async fn low_level_tool_definition() { + super::support::with_shared_e2e_context(&E2E, "tools", "low_level_tool_definition", |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let __perm = Arc::new(ApproveAllHandler); + let current_phase = Arc::new(Mutex::new(String::new())); + let tools = vec![ + set_current_phase_tool(current_phase.clone()), + search_items_tool(), + ]; + let available_tools = ToolSet::new() + .add_custom("*") + .expect("add custom wildcard") + .add_builtin("web_fetch") + .expect("add web_fetch") + .into_vec(); + let session = client + .create_session( + SessionConfig::default() + .with_github_token(super::support::DEFAULT_TEST_TOKEN) + .with_permission_handler(__perm) + .with_tools(tools) + .with_available_tools(available_tools), + ) + .await + .expect("create session"); + + let answer = session + .send_and_wait( + "First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and search results.", + ) + .await + .expect("send") + .expect("assistant message"); + let content = assistant_message_content(&answer); + assert!(!content.is_empty()); + assert!(content.to_lowercase().contains("analyzing")); + assert!(content.contains("item_alpha") || content.contains("item_beta")); + assert_eq!(current_phase.lock().await.clone(), "analyzing"); + + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }) + .await; +} + #[tokio::test] async fn handles_tool_calling_errors() { - with_e2e_context("tools", "handles_tool_calling_errors", |ctx| { + super::support::with_shared_e2e_context(&E2E, "tools", "handles_tool_calling_errors", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -124,7 +173,7 @@ async fn handles_tool_calling_errors() { #[tokio::test] async fn can_receive_and_return_complex_types() { - with_e2e_context("tools", "can_receive_and_return_complex_types", |ctx| { + super::support::with_shared_e2e_context(&E2E, "tools", "can_receive_and_return_complex_types", |ctx| { Box::pin(async move { ctx.set_default_copilot_user(); let client = ctx.start_client().await; @@ -163,76 +212,89 @@ async fn can_receive_and_return_complex_types() { #[tokio::test] async fn overrides_built_in_tool_with_custom_tool() { - with_e2e_context("tools", "overrides_built_in_tool_with_custom_tool", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let __perm = Arc::new(ApproveAllHandler); - let tools = vec![custom_grep_tool()]; - let session = client - .create_session( - SessionConfig::default() - .with_github_token(super::support::DEFAULT_TEST_TOKEN) - .with_permission_handler(__perm) - .with_tools(tools), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "tools", + "overrides_built_in_tool_with_custom_tool", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let __perm = Arc::new(ApproveAllHandler); + let tools = vec![custom_grep_tool()]; + let session = client + .create_session( + SessionConfig::default() + .with_github_token(super::support::DEFAULT_TEST_TOKEN) + .with_permission_handler(__perm) + .with_tools(tools), + ) + .await + .expect("create session"); - let answer = session - .send_and_wait("Use grep to search for the word 'hello'") - .await - .expect("send") - .expect("assistant message"); - assert!(assistant_message_content(&answer).contains("CUSTOM_GREP_RESULT")); + let answer = session + .send_and_wait("Use grep to search for the word 'hello'") + .await + .expect("send") + .expect("assistant message"); + assert!(assistant_message_content(&answer).contains("CUSTOM_GREP_RESULT")); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } #[tokio::test] async fn skippermission_sent_in_tool_definition() { - with_e2e_context("tools", "skippermission_sent_in_tool_definition", |ctx| { - Box::pin(async move { - ctx.set_default_copilot_user(); - let client = ctx.start_client().await; - let (permission_tx, mut permission_rx) = mpsc::unbounded_channel(); - let handler = Arc::new(RecordingPermissionHandler { - permission_tx, - decision: PermissionResult::reject(None), - }); - let __perm = handler; - let tools = vec![safe_lookup_tool()]; - let session = client - .create_session( - SessionConfig::default() - .with_github_token(super::support::DEFAULT_TEST_TOKEN) - .with_permission_handler(__perm) - .with_tools(tools), - ) - .await - .expect("create session"); + super::support::with_shared_e2e_context( + &E2E, + "tools", + "skippermission_sent_in_tool_definition", + |ctx| { + Box::pin(async move { + ctx.set_default_copilot_user(); + let client = ctx.start_client().await; + let (permission_tx, mut permission_requests) = mpsc::unbounded_channel(); + let handler = Arc::new(RecordingPermissionHandler { + permission_tx, + decision: PermissionResult::reject(None), + }); + let __perm = handler; + let tools = vec![safe_lookup_tool()]; + let session = client + .create_session( + SessionConfig::default() + .with_github_token(super::support::DEFAULT_TEST_TOKEN) + .with_permission_handler(__perm) + .with_tools(tools), + ) + .await + .expect("create session"); - let answer = session - .send_and_wait("Use safe_lookup to look up 'test123'") - .await - .expect("send") - .expect("assistant message"); - assert!(assistant_message_content(&answer).contains("RESULT")); - assert!( - tokio::time::timeout(std::time::Duration::from_millis(100), permission_rx.recv()) + let answer = session + .send_and_wait("Use safe_lookup to look up 'test123'") + .await + .expect("send") + .expect("assistant message"); + assert!(assistant_message_content(&answer).contains("RESULT")); + assert!( + tokio::time::timeout( + std::time::Duration::from_millis(100), + permission_requests.recv() + ) .await .is_err(), - "skip_permission tool should not request permission" - ); + "skip_permission tool should not request permission" + ); - session.disconnect().await.expect("disconnect session"); - client.stop().await.expect("stop client"); - }) - }) + session.disconnect().await.expect("disconnect session"); + client.stop().await.expect("stop client"); + }) + }, + ) .await; } @@ -242,7 +304,8 @@ async fn can_return_binary_result() {} #[tokio::test] async fn invokes_custom_tool_with_permission_handler() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "tools", "invokes_custom_tool_with_permission_handler", |ctx| { @@ -285,7 +348,8 @@ async fn invokes_custom_tool_with_permission_handler() { #[tokio::test] async fn denies_custom_tool_when_permission_denied() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "tools", "denies_custom_tool_when_permission_denied", |ctx| { @@ -331,7 +395,7 @@ async fn denies_custom_tool_when_permission_denied() { #[tokio::test] async fn should_execute_multiple_custom_tools_in_parallel_single_turn() { - with_e2e_context( + super::support::with_shared_e2e_context(&E2E, "tools", "should_execute_multiple_custom_tools_in_parallel_single_turn", |ctx| { @@ -379,7 +443,8 @@ async fn should_execute_multiple_custom_tools_in_parallel_single_turn() { #[tokio::test] async fn should_respect_availabletools_and_excludedtools_combined() { - with_e2e_context( + super::support::with_shared_e2e_context( + &E2E, "tools", "should_respect_availabletools_and_excludedtools_combined", |ctx| { @@ -502,6 +567,69 @@ impl ToolHandler for ErrorTool { struct CustomGrepTool; +struct SetCurrentPhaseTool { + current_phase: Arc>, +} + +fn set_current_phase_tool(current_phase: Arc>) -> Tool { + Tool::new("set_current_phase") + .with_description("Sets the current phase of the agent") + .with_parameters(json!({ + "type": "object", + "properties": { + "phase": { + "type": "string", + "description": "Current phase", + "pattern": "^(searching|analyzing|done)$" + } + }, + "required": ["phase"] + })) + .with_handler(Arc::new(SetCurrentPhaseTool { current_phase })) +} + +#[async_trait::async_trait] +impl ToolHandler for SetCurrentPhaseTool { + async fn call(&self, invocation: ToolInvocation) -> Result { + let phase = invocation + .arguments + .get("phase") + .and_then(serde_json::Value::as_str) + .unwrap_or_default() + .to_string(); + *self.current_phase.lock().await = phase.clone(); + Ok(ToolResult::Text(format!("Phase set to {phase}"))) + } +} + +struct SearchItemsTool; + +fn search_items_tool() -> Tool { + Tool::new("search_items") + .with_description("Search for items by keyword") + .with_parameters(json!({ + "type": "object", + "properties": { + "keyword": { "type": "string" } + }, + "required": ["keyword"] + })) + .with_handler(Arc::new(SearchItemsTool)) +} + +#[async_trait::async_trait] +impl ToolHandler for SearchItemsTool { + async fn call(&self, invocation: ToolInvocation) -> Result { + let keyword = invocation + .arguments + .get("keyword") + .and_then(serde_json::Value::as_str) + .unwrap_or_default(); + assert_eq!(keyword, "copilot"); + Ok(ToolResult::Text("Found: item_alpha, item_beta".to_string())) + } +} + fn custom_grep_tool() -> Tool { Tool::new("grep") .with_description("A custom grep implementation that overrides the built-in") @@ -752,3 +880,4 @@ impl ToolHandler for DbQueryTool { )) } } +static E2E: super::support::SharedE2eGroup = super::support::SharedE2eGroup::standard("tools", 11); diff --git a/rust/tests/jsonrpc_test.rs b/rust/tests/jsonrpc_test.rs index 7f7d43213..1735067c3 100644 --- a/rust/tests/jsonrpc_test.rs +++ b/rust/tests/jsonrpc_test.rs @@ -2,7 +2,7 @@ #![allow(clippy::unwrap_used)] use github_copilot_sdk::test_support::{JsonRpcClient, JsonRpcNotification, JsonRpcRequest}; -use tokio::io::{AsyncWrite, AsyncWriteExt, duplex}; +use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, duplex}; use tokio::sync::{broadcast, mpsc}; /// Write a Content-Length framed JSON-RPC message to a writer. @@ -13,6 +13,28 @@ async fn write_framed(writer: &mut (impl AsyncWrite + Unpin), body: &[u8]) { writer.flush().await.unwrap(); } +async fn read_framed(reader: &mut (impl AsyncRead + Unpin)) -> Vec { + let mut header = String::new(); + loop { + let mut byte = [0u8; 1]; + reader.read_exact(&mut byte).await.unwrap(); + header.push(byte[0] as char); + if header.ends_with("\r\n\r\n") { + break; + } + } + + let length = header + .trim() + .strip_prefix("Content-Length: ") + .unwrap() + .parse() + .unwrap(); + let mut body = vec![0u8; length]; + reader.read_exact(&mut body).await.unwrap(); + body +} + #[tokio::test] async fn request_response_round_trip() { // duplex: client_write → server_read, server_write → client_read @@ -410,3 +432,116 @@ async fn send_request_cancellation_does_not_leak_pending() { assert_eq!(response.result.unwrap()["ok"], true); server_task.await.unwrap(); } + +#[test] +fn lone_surrogate_yields_unexpected_end_of_hex_escape() { + let error = serde_json::from_slice::(br#""\ud83d""#).unwrap_err(); + + assert_eq!( + error.to_string(), + "unexpected end of hex escape at line 1 column 8" + ); +} + +#[tokio::test] +async fn lone_surrogate_frame_is_recovered_without_closing_connection() { + let (client_write, mut server_read) = duplex(4096); + let (mut server_write, client_read) = duplex(4096); + let (notification_tx, _) = broadcast::channel(16); + let (request_tx, _) = mpsc::unbounded_channel(); + let client = JsonRpcClient::new(client_write, client_read, notification_tx, request_tx); + + let server_task = tokio::spawn(async move { + let request: JsonRpcRequest = + serde_json::from_slice(&read_framed(&mut server_read).await).unwrap(); + let response = format!( + r#"{{"jsonrpc":"2.0","id":{},"result":{{"name":"invalid \ud83d value"}}}}"#, + request.id + ); + write_framed(&mut server_write, response.as_bytes()).await; + + let request: JsonRpcRequest = + serde_json::from_slice(&read_framed(&mut server_read).await).unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": request.id, + "result": {"name": "still connected"} + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + }); + + let response = client.send_request("models.list", None).await.unwrap(); + assert_eq!( + response.result.unwrap()["name"], + serde_json::json!("invalid \u{FFFD} value") + ); + + let response = client.send_request("account.getQuota", None).await.unwrap(); + assert_eq!( + response.result.unwrap()["name"], + serde_json::json!("still connected") + ); + server_task.await.unwrap(); +} + +#[tokio::test] +async fn unrepairable_frame_remains_fatal() { + let (client_write, mut server_read) = duplex(4096); + let (mut server_write, client_read) = duplex(4096); + let (notification_tx, _) = broadcast::channel(16); + let (request_tx, _) = mpsc::unbounded_channel(); + let client = JsonRpcClient::new(client_write, client_read, notification_tx, request_tx); + + let server_task = tokio::spawn(async move { + let request: JsonRpcRequest = + serde_json::from_slice(&read_framed(&mut server_read).await).unwrap(); + let response = format!( + r#"{{"jsonrpc":"2.0","id":{},"result":{{"surrogate":"\ud83d","escape":"\q"}}}}"#, + request.id + ); + write_framed(&mut server_write, response.as_bytes()).await; + }); + + let error = tokio::time::timeout( + std::time::Duration::from_secs(2), + client.send_request("models.list", None), + ) + .await + .expect("unrepairable frame did not terminate the pending request") + .unwrap_err(); + + assert_eq!(error.to_string(), "request cancelled"); + assert!(error.is_transport_failure()); + server_task.await.unwrap(); +} + +#[tokio::test] +async fn valid_pairs_and_escaped_backslashes_are_untouched() { + let (client_write, mut server_read) = duplex(4096); + let (mut server_write, client_read) = duplex(4096); + let (notification_tx, _) = broadcast::channel(16); + let (request_tx, _) = mpsc::unbounded_channel(); + let client = JsonRpcClient::new(client_write, client_read, notification_tx, request_tx); + + let server_task = tokio::spawn(async move { + let request: JsonRpcRequest = + serde_json::from_slice(&read_framed(&mut server_read).await).unwrap(); + let response = format!( + r#"{{"jsonrpc":"2.0","id":{},"result":{{"emoji":"\ud83d\ude00","path":"C:\\ud83d","invalid":"\ud83d"}}}}"#, + request.id + ); + write_framed(&mut server_write, response.as_bytes()).await; + }); + + let result = client + .send_request("models.list", None) + .await + .unwrap() + .result + .unwrap(); + + assert_eq!(result["emoji"], serde_json::json!("😀")); + assert_eq!(result["path"], serde_json::json!(r"C:\ud83d")); + assert_eq!(result["invalid"], serde_json::json!("\u{FFFD}")); + server_task.await.unwrap(); +} diff --git a/rust/tests/session_test.rs b/rust/tests/session_test.rs index 786ba97de..231a8f91e 100644 --- a/rust/tests/session_test.rs +++ b/rust/tests/session_test.rs @@ -7,21 +7,28 @@ use std::time::Duration; use async_trait::async_trait; use github_copilot_sdk::canvas::{CanvasDeclaration, CanvasHandler, CanvasResult}; -use github_copilot_sdk::generated::api_types::{ - CanvasInstanceAvailability, CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, - CanvasProviderOpenResult, OpenCanvasInstance, -}; -use github_copilot_sdk::generated::session_events::ReasoningSummary; use github_copilot_sdk::handler::{ ApproveAllHandler, AutoModeSwitchHandler, AutoModeSwitchResponse, ElicitationHandler, - ExitPlanModeHandler, ExitPlanModeResult, UserInputHandler, UserInputResponse, + ExitPlanModeHandler, ExitPlanModeResult, McpAuthHandler, McpAuthRequest, McpAuthResult, + PermissionHandler, PermissionResult, UserInputHandler, UserInputResponse, +}; +use github_copilot_sdk::rpc::{ + CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest, CanvasProviderOpenResult, + OpenCanvasInstance, +}; +use github_copilot_sdk::session_events::{ + ManagedSettingsResolvedSource, McpOauthRequiredData, ReasoningSummary, SessionLimitsConfig, + SessionManagedSettingsResolvedData, }; use github_copilot_sdk::types::{ - CommandContext, CommandDefinition, CommandHandler, DeliveryMode, ElicitationRequest, - ElicitationResult, ExitPlanModeData, ExtensionInfo, MessageOptions, RequestId, SessionConfig, - SessionId, SetModelOptions, Tool, ToolInvocation, ToolResult, + CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, CommandContext, + CommandDefinition, CommandHandler, DeliveryMode, DisableBypassPermissionsMode, + ElicitationRequest, ElicitationResult, ExitPlanModeData, ExtensionInfo, ManagedSettings, + ManagedSettingsPermissions, MessageOptions, PermissionDecisionContext, + PermissionDecisionOutcome, PermissionDecisionSource, PermissionDecisionSurface, RequestId, + SessionConfig, SessionId, SetModelOptions, Tool, ToolInvocation, ToolResult, }; -use github_copilot_sdk::{Client, tool}; +use github_copilot_sdk::{Client, ContextTier, ErrorKind, ProtocolErrorKind, tool}; use serde_json::Value; use tokio::io::{AsyncWrite, AsyncWriteExt, duplex}; use tokio::time::timeout; @@ -30,6 +37,38 @@ const TIMEOUT: Duration = Duration::from_secs(2); struct TestCanvasHandler; +struct CancelMcpAuthHandler; + +struct ContextualApproveHandler; + +#[async_trait] +impl PermissionHandler for ContextualApproveHandler { + async fn handle( + &self, + _session_id: SessionId, + _request_id: RequestId, + _data: github_copilot_sdk::PermissionRequestData, + ) -> PermissionResult { + PermissionResult::approve_once().with_context(PermissionDecisionContext { + outcome: PermissionDecisionOutcome::PromptedUser, + source: PermissionDecisionSource::HumanResponse, + surface: PermissionDecisionSurface::CopilotApp, + }) + } +} + +#[async_trait] +impl McpAuthHandler for CancelMcpAuthHandler { + async fn handle( + &self, + _session_id: SessionId, + _request_id: RequestId, + _request: McpAuthRequest, + ) -> McpAuthResult { + McpAuthResult::Cancelled + } +} + #[async_trait] impl CanvasHandler for TestCanvasHandler { async fn on_open( @@ -220,12 +259,295 @@ fn rand_id() -> u64 { COUNTER.fetch_add(1, Ordering::Relaxed) as u64 } +#[test] +fn mcp_oauth_required_data_allows_optional_metadata() { + let with_metadata: McpOauthRequiredData = serde_json::from_value(serde_json::json!({ + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp", + "wwwAuthenticateParams": { + "resourceMetadataUrl": "https://example.com/.well-known/oauth-protected-resource" + }, + "resourceMetadata": "{\"resource\":\"https://example.com/mcp\"}", + "staticClientConfig": { + "clientId": "static-client", + "clientSecret": "static-secret", + "publicClient": false + } + })) + .unwrap(); + assert_eq!( + with_metadata.resource_metadata.as_deref(), + Some("{\"resource\":\"https://example.com/mcp\"}") + ); + assert!(with_metadata.www_authenticate_params.is_some()); + assert_eq!( + with_metadata + .static_client_config + .as_ref() + .and_then(|config| config.client_secret.as_deref()), + Some("static-secret") + ); + + let without_metadata: McpOauthRequiredData = serde_json::from_value(serde_json::json!({ + "requestId": "oauth-request", + "reason": "initial", + "serverName": "oauth-server", + "serverUrl": "https://example.com/mcp" + })) + .unwrap(); + assert!(without_metadata.resource_metadata.is_none()); + assert!(without_metadata.www_authenticate_params.is_none()); +} + fn requested_session_id(request: &Value) -> &str { request["params"]["sessionId"] .as_str() .expect("session request should include sessionId") } +#[tokio::test] +async fn create_session_registers_mcp_auth_interest_only_with_handler() { + let (client, mut server_read, mut server_write) = make_client(); + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default().with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await + .unwrap() + } + }); + + let create_req = read_framed(&mut server_read).await; + assert_eq!(create_req["method"], "session.create"); + assert_eq!(create_req["params"]["requestPermission"], true); + let session_id = requested_session_id(&create_req).to_string(); + server_respond_create(&mut server_write, &create_req, &session_id).await; + let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + + let no_extra_request = timeout(Duration::from_millis(50), read_framed(&mut server_read)).await; + assert!(no_extra_request.is_err()); + drop(session); + + let (client, mut server_read, mut server_write) = make_client(); + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)), + ) + .await + .unwrap() + } + }); + + let create_req = read_framed(&mut server_read).await; + assert_eq!(create_req["method"], "session.create"); + assert_eq!(create_req["params"]["requestPermission"], true); + let session_id = requested_session_id(&create_req).to_string(); + server_respond_create(&mut server_write, &create_req, &session_id).await; + + let interest_req = read_framed(&mut server_read).await; + assert_eq!(interest_req["method"], "session.eventLog.registerInterest"); + assert_eq!(interest_req["params"]["eventType"], "mcp.oauth_required"); + let id = interest_req["id"].as_u64().unwrap(); + write_framed( + &mut server_write, + &serde_json::to_vec(&serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "id": "interest-1" }, + })) + .unwrap(), + ) + .await; + + let _session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn cloud_create_session_registers_mcp_auth_interest_after_create_only_with_handler() { + let cloud = || { + CloudSessionOptions::with_repository( + CloudSessionRepository::new("github", "copilot-sdk").with_branch("main"), + ) + }; + + let (client, mut server_read, mut server_write) = make_client(); + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_cloud(cloud()), + ) + .await + .unwrap() + } + }); + + let create_req = read_framed(&mut server_read).await; + assert_eq!(create_req["method"], "session.create"); + assert!(create_req["params"].get("sessionId").is_none()); + assert_eq!(create_req["params"]["requestPermission"], true); + server_respond_create(&mut server_write, &create_req, "server-assigned-session-1").await; + let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + let no_extra_request = timeout(Duration::from_millis(50), read_framed(&mut server_read)).await; + assert!(no_extra_request.is_err()); + drop(session); + + let (client, mut server_read, mut server_write) = make_client(); + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)) + .with_cloud(cloud()), + ) + .await + .unwrap() + } + }); + + let create_req = read_framed(&mut server_read).await; + assert_eq!(create_req["method"], "session.create"); + assert!(create_req["params"].get("sessionId").is_none()); + assert_eq!(create_req["params"]["requestPermission"], true); + server_respond_create(&mut server_write, &create_req, "server-assigned-session-2").await; + + let interest_req = read_framed(&mut server_read).await; + assert_eq!(interest_req["method"], "session.eventLog.registerInterest"); + assert_eq!( + interest_req["params"]["sessionId"], + "server-assigned-session-2" + ); + assert_eq!(interest_req["params"]["eventType"], "mcp.oauth_required"); + let id = interest_req["id"].as_u64().unwrap(); + write_framed( + &mut server_write, + &serde_json::to_vec(&serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "id": "interest-1" }, + })) + .unwrap(), + ) + .await; + let _session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn resume_session_registers_mcp_auth_interest_only_with_handler() { + use github_copilot_sdk::types::ResumeSessionConfig; + + let (client, mut server_read, mut server_write) = make_client(); + let resume_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .resume_session( + ResumeSessionConfig::new(SessionId::from("session-without-auth")) + .with_permission_handler(Arc::new(ApproveAllHandler)), + ) + .await + .unwrap() + } + }); + + let resume_req = read_framed(&mut server_read).await; + assert_eq!(resume_req["method"], "session.resume"); + assert_eq!(resume_req["params"]["requestPermission"], true); + server_respond_create(&mut server_write, &resume_req, "session-without-auth").await; + respond_to_reload(&mut server_read, &mut server_write).await; + let session = timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); + let no_extra_request = timeout(Duration::from_millis(50), read_framed(&mut server_read)).await; + assert!(no_extra_request.is_err()); + drop(session); + + let (client, mut server_read, mut server_write) = make_client(); + let resume_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .resume_session( + ResumeSessionConfig::new(SessionId::from("session-with-auth")) + .with_permission_handler(Arc::new(ApproveAllHandler)) + .with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)), + ) + .await + .unwrap() + } + }); + + let resume_req = read_framed(&mut server_read).await; + assert_eq!(resume_req["method"], "session.resume"); + assert_eq!(resume_req["params"]["requestPermission"], true); + server_respond_create(&mut server_write, &resume_req, "session-with-auth").await; + + let interest_req = read_framed(&mut server_read).await; + assert_eq!(interest_req["method"], "session.eventLog.registerInterest"); + assert_eq!(interest_req["params"]["eventType"], "mcp.oauth_required"); + let id = interest_req["id"].as_u64().unwrap(); + write_framed( + &mut server_write, + &serde_json::to_vec(&serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "id": "interest-1" }, + })) + .unwrap(), + ) + .await; + + respond_to_reload(&mut server_read, &mut server_write).await; + let _session = timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); +} + +async fn server_respond_create( + writer: &mut (impl AsyncWrite + Unpin), + request: &Value, + session_id: &str, +) { + let id = request["id"].as_u64().unwrap(); + write_framed( + writer, + &serde_json::to_vec(&serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id, "workspacePath": "/tmp/workspace" }, + })) + .unwrap(), + ) + .await; +} + +async fn respond_to_reload( + reader: &mut (impl tokio::io::AsyncRead + Unpin), + writer: &mut (impl AsyncWrite + Unpin), +) { + let reload = read_framed(reader).await; + assert_eq!(reload["method"], "session.skills.reload"); + let id = reload["id"].as_u64().unwrap(); + write_framed( + writer, + &serde_json::to_vec(&serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": {} })) + .unwrap(), + ) + .await; +} + #[tokio::test] async fn session_subscribe_yields_events_observe_only() { let (session, mut server) = create_session_pair().await; @@ -247,130 +569,668 @@ async fn session_subscribe_yields_events_observe_only() { .send_event("another.event", serde_json::json!({"k": "v"})) .await; - for _ in 0..50 { - if count.load(Ordering::Relaxed) >= 2 { - break; - } - tokio::time::sleep(Duration::from_millis(20)).await; - } - assert_eq!(count.load(Ordering::Relaxed), 2); - assert_eq!(last_type.lock().as_str(), "another.event"); - consumer.abort(); + for _ in 0..50 { + if count.load(Ordering::Relaxed) >= 2 { + break; + } + tokio::time::sleep(Duration::from_millis(20)).await; + } + assert_eq!(count.load(Ordering::Relaxed), 2); + assert_eq!(last_type.lock().as_str(), "another.event"); + consumer.abort(); +} + +#[tokio::test] +async fn session_subscribe_drop_stops_delivery() { + let (session, mut server) = create_session_pair().await; + + let mut events = session.subscribe(); + let count = Arc::new(AtomicUsize::new(0)); + let count_clone = count.clone(); + let consumer = tokio::spawn(async move { + while let Ok(_event) = events.recv().await { + count_clone.fetch_add(1, Ordering::Relaxed); + } + }); + + server.send_event("first", serde_json::json!({})).await; + for _ in 0..50 { + if count.load(Ordering::Relaxed) >= 1 { + break; + } + tokio::time::sleep(Duration::from_millis(20)).await; + } + assert_eq!(count.load(Ordering::Relaxed), 1); + + // Aborting the consumer drops its receiver; further events have no + // effect on the (now-zero) subscriber count. + consumer.abort(); + tokio::time::sleep(Duration::from_millis(20)).await; + + server.send_event("second", serde_json::json!({})).await; + tokio::time::sleep(Duration::from_millis(100)).await; + assert_eq!(count.load(Ordering::Relaxed), 1); +} + +#[tokio::test] +async fn create_session_sends_correct_rpc() { + let (client, mut server_read, mut server_write) = make_client(); + + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session({ + let mut cfg = SessionConfig::default(); + cfg.model = Some("gpt-4".to_string()); + cfg + }) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert_eq!(request["params"]["model"], "gpt-4"); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id.clone(), "workspacePath": "/ws" }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + assert_eq!(session.id(), session_id.as_str()); + assert_eq!(session.workspace_path(), Some(Path::new("/ws"))); +} + +#[tokio::test] +async fn create_session_sends_new_session_options() { + let (client, mut server_read, mut server_write) = make_client(); + + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_excluded_builtin_agents(["explore"]) + .with_enable_citations(true) + .with_enable_file_change_tracking(true) + .with_session_limits(SessionLimitsConfig { + max_ai_credits: Some(30.0), + }), + ) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert_eq!( + request["params"]["excludedBuiltinAgents"], + serde_json::json!(["explore"]) + ); + assert_eq!(request["params"]["enableCitations"], true); + assert_eq!(request["params"]["enableFileChangeTracking"], true); + assert_eq!(request["params"]["sessionLimits"]["maxAiCredits"], 30.0); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id, "workspacePath": "/ws" }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn resume_session_sends_new_session_options() { + use github_copilot_sdk::types::ResumeSessionConfig; + + let (client, mut server_read, mut server_write) = make_client(); + + let resume_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .resume_session( + ResumeSessionConfig::new(SessionId::from("session-options")) + .with_excluded_builtin_agents(["task"]) + .with_enable_citations(false) + .with_enable_file_change_tracking(false) + .with_session_limits(SessionLimitsConfig { + max_ai_credits: Some(15.0), + }), + ) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.resume"); + assert_eq!(request["params"]["sessionId"], "session-options"); + assert_eq!( + request["params"]["excludedBuiltinAgents"], + serde_json::json!(["task"]) + ); + assert_eq!(request["params"]["enableCitations"], false); + assert_eq!(request["params"]["enableFileChangeTracking"], false); + assert_eq!(request["params"]["sessionLimits"]["maxAiCredits"], 15.0); + + server_respond_create(&mut server_write, &request, "session-options").await; + respond_to_reload(&mut server_read, &mut server_write).await; + timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn create_session_sends_canvas_wire_fields() { + let (client, mut server_read, mut server_write) = make_client(); + + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_canvases([test_canvas("counter")]) + .with_request_canvas_renderer(true) + .with_request_extensions(true) + .with_extension_info(ExtensionInfo::new("github-app", "counter-provider")) + .with_canvas_provider( + CanvasProviderIdentity::new("app:builtin:window-1") + .with_name("Built-in"), + ), + ) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert_eq!(request["params"]["canvases"][0]["id"], "counter"); + assert_eq!( + request["params"]["canvases"][0]["displayName"], + "Test Canvas" + ); + assert_eq!(request["params"]["requestCanvasRenderer"], true); + assert_eq!(request["params"]["requestExtensions"], true); + assert_eq!(request["params"]["extensionInfo"]["source"], "github-app"); + assert_eq!( + request["params"]["extensionInfo"]["name"], + "counter-provider" + ); + assert_eq!( + request["params"]["canvasProvider"]["id"], + "app:builtin:window-1" + ); + assert_eq!(request["params"]["canvasProvider"]["name"], "Built-in"); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn create_and_resume_send_managed_settings_permissions() { + use github_copilot_sdk::types::ResumeSessionConfig; + + let (client, mut server_read, mut server_write) = make_client(); + + let managed = ManagedSettings::default().with_permissions( + ManagedSettingsPermissions::default() + .with_disable_bypass_permissions_mode(DisableBypassPermissionsMode::Disable) + .with_deny(vec!["shell(rm*)".to_string()]) + .with_ask(vec!["write".to_string()]) + .with_allow(vec![]), + ); + + let create_handle = tokio::spawn({ + let client = client.clone(); + let managed = managed.clone(); + async move { + client + .create_session( + SessionConfig::default() + .with_enable_managed_settings(true) + .with_managed_settings(managed), + ) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert_eq!(request["params"]["enableManagedSettings"], true); + let perms = &request["params"]["managedSettings"]["permissions"]; + assert_eq!(perms["disableBypassPermissionsMode"], "disable"); + assert_eq!(perms["deny"][0], "shell(rm*)"); + assert_eq!(perms["ask"][0], "write"); + assert_eq!(perms["allow"], serde_json::json!([])); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id.clone() }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + + let resume_handle = tokio::spawn({ + let client = client.clone(); + let session_id = session_id.clone(); + async move { + client + .resume_session( + ResumeSessionConfig::new(SessionId::from(session_id)) + .with_managed_settings(managed), + ) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.resume"); + assert_eq!( + request["params"]["managedSettings"]["permissions"]["deny"][0], + "shell(rm*)" + ); + + let id = request["id"].as_u64().unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + let reload = read_framed(&mut server_read).await; + assert_eq!(reload["method"], "session.skills.reload"); + let id = reload["id"].as_u64().unwrap(); + let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": {} }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); +} + +#[test] +fn managed_settings_resolved_event_preserves_client_provenance() { + let sources = [ + (ManagedSettingsResolvedSource::Server, "server"), + (ManagedSettingsResolvedSource::Device, "device"), + (ManagedSettingsResolvedSource::Client, "client"), + (ManagedSettingsResolvedSource::Mixed, "mixed"), + (ManagedSettingsResolvedSource::None, "none"), + ]; + for (source, wire_value) in sources { + assert_eq!( + serde_json::to_value(source).unwrap(), + serde_json::json!(wire_value) + ); + } + + let with_client = SessionManagedSettingsResolvedData { + bypass_permissions_disabled: true, + client_managed: Some(true), + managed_keys: vec!["permissions".to_string()], + source: ManagedSettingsResolvedSource::Client, + ..Default::default() + }; + let serialized = serde_json::to_value(&with_client).unwrap(); + assert_eq!(serialized["source"], "client"); + assert_eq!(serialized["clientManaged"], true); + + let round_tripped: SessionManagedSettingsResolvedData = + serde_json::from_value(serialized).unwrap(); + assert_eq!(round_tripped.source, ManagedSettingsResolvedSource::Client); + assert_eq!(round_tripped.client_managed, Some(true)); + + let without_client = SessionManagedSettingsResolvedData { + bypass_permissions_disabled: true, + managed_keys: vec!["permissions".to_string()], + source: ManagedSettingsResolvedSource::Mixed, + ..Default::default() + }; + let serialized = serde_json::to_value(&without_client).unwrap(); + assert_eq!(serialized["source"], "mixed"); + assert!(serialized.get("clientManaged").is_none()); +} + +fn make_client_with_telemetry( + callback: github_copilot_sdk::github_telemetry::GitHubTelemetryCallback, +) -> (Client, tokio::io::DuplexStream, tokio::io::DuplexStream) { + let (client_write, server_read) = duplex(8192); + let (server_write, client_read) = duplex(8192); + let client = Client::from_streams_with_github_telemetry( + client_read, + client_write, + std::env::temp_dir(), + callback, + ) + .unwrap(); + (client, server_read, server_write) +} + +#[tokio::test] +async fn create_and_resume_send_github_telemetry_forwarding_when_callback_registered() { + use github_copilot_sdk::types::ResumeSessionConfig; + + let callback: github_copilot_sdk::github_telemetry::GitHubTelemetryCallback = + Arc::new(|_notification| {}); + let (client, mut server_read, mut server_write) = make_client_with_telemetry(callback); + + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session(SessionConfig::default()) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert_eq!(request["params"]["enableGitHubTelemetryForwarding"], true); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id.clone() }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + + let resume_handle = tokio::spawn({ + let client = client.clone(); + let session_id = session_id.clone(); + async move { + client + .resume_session(ResumeSessionConfig::new(SessionId::from(session_id))) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.resume"); + assert_eq!(request["params"]["enableGitHubTelemetryForwarding"], true); + + let id = request["id"].as_u64().unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + let reload = read_framed(&mut server_read).await; + assert_eq!(reload["method"], "session.skills.reload"); + let id = reload["id"].as_u64().unwrap(); + let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": {} }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn create_session_omits_github_telemetry_forwarding_without_callback() { + let (client, mut server_read, mut server_write) = make_client(); + + let create_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .create_session(SessionConfig::default()) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.create"); + assert!( + request["params"] + .get("enableGitHubTelemetryForwarding") + .is_none_or(Value::is_null), + "forwarding flag should be omitted when no callback is registered" + ); + + let id = request["id"].as_u64().unwrap(); + let session_id = requested_session_id(&request).to_string(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": session_id }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); +} + +#[tokio::test] +async fn resume_session_omits_github_telemetry_forwarding_without_callback() { + use github_copilot_sdk::types::ResumeSessionConfig; + + let (client, mut server_read, mut server_write) = make_client(); + + let resume_handle = tokio::spawn({ + let client = client.clone(); + async move { + client + .resume_session(ResumeSessionConfig::new(SessionId::from( + "sess-1".to_string(), + ))) + .await + .unwrap() + } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "session.resume"); + assert!( + request["params"] + .get("enableGitHubTelemetryForwarding") + .is_none_or(Value::is_null), + "forwarding flag should be omitted when no callback is registered" + ); + + let id = request["id"].as_u64().unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "sessionId": "sess-1" }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + let reload = read_framed(&mut server_read).await; + assert_eq!(reload["method"], "session.skills.reload"); + let id = reload["id"].as_u64().unwrap(); + let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": {} }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + timeout(TIMEOUT, resume_handle).await.unwrap().unwrap(); } #[tokio::test] -async fn session_subscribe_drop_stops_delivery() { - let (session, mut server) = create_session_pair().await; +async fn connect_sends_github_telemetry_forwarding_when_callback_registered() { + let callback: github_copilot_sdk::github_telemetry::GitHubTelemetryCallback = + Arc::new(|_notification| {}); + let (client, mut server_read, mut server_write) = make_client_with_telemetry(callback); - let mut events = session.subscribe(); - let count = Arc::new(AtomicUsize::new(0)); - let count_clone = count.clone(); - let consumer = tokio::spawn(async move { - while let Ok(_event) = events.recv().await { - count_clone.fetch_add(1, Ordering::Relaxed); - } + let handle = tokio::spawn({ + let client = client.clone(); + async move { client.verify_protocol_version().await.unwrap() } }); - server.send_event("first", serde_json::json!({})).await; - for _ in 0..50 { - if count.load(Ordering::Relaxed) >= 1 { - break; - } - tokio::time::sleep(Duration::from_millis(20)).await; - } - assert_eq!(count.load(Ordering::Relaxed), 1); - - // Aborting the consumer drops its receiver; further events have no - // effect on the (now-zero) subscriber count. - consumer.abort(); - tokio::time::sleep(Duration::from_millis(20)).await; + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "connect"); + assert_eq!(request["params"]["enableGitHubTelemetryForwarding"], true); - server.send_event("second", serde_json::json!({})).await; - tokio::time::sleep(Duration::from_millis(100)).await; - assert_eq!(count.load(Ordering::Relaxed), 1); + let id = request["id"].as_u64().unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "ok": true, "protocolVersion": 3, "version": "test" }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + timeout(TIMEOUT, handle).await.unwrap().unwrap(); } #[tokio::test] -async fn create_session_sends_correct_rpc() { +async fn connect_omits_github_telemetry_forwarding_without_callback() { let (client, mut server_read, mut server_write) = make_client(); - let create_handle = tokio::spawn({ + let handle = tokio::spawn({ let client = client.clone(); - async move { - client - .create_session({ - let mut cfg = SessionConfig::default(); - cfg.model = Some("gpt-4".to_string()); - cfg - }) - .await - .unwrap() - } + async move { client.verify_protocol_version().await.unwrap() } }); let request = read_framed(&mut server_read).await; - assert_eq!(request["method"], "session.create"); - assert_eq!(request["params"]["model"], "gpt-4"); + assert_eq!(request["method"], "connect"); + assert!( + request["params"] + .get("enableGitHubTelemetryForwarding") + .is_none_or(Value::is_null), + "forwarding flag should be omitted when no callback is registered" + ); let id = request["id"].as_u64().unwrap(); - let session_id = requested_session_id(&request).to_string(); let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, - "result": { "sessionId": session_id.clone(), "workspacePath": "/ws" }, + "result": { "ok": true, "protocolVersion": 3, "version": "test" }, }); write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + timeout(TIMEOUT, handle).await.unwrap().unwrap(); +} - let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); - assert_eq!(session.id(), session_id.as_str()); - assert_eq!(session.workspace_path(), Some(Path::new("/ws"))); +#[tokio::test] +async fn connect_rejects_invalid_protocol_version_values() { + for protocol_version in [-1, i64::from(u32::MAX) + 1] { + let (client, mut server_read, mut server_write) = make_client(); + + let handle = tokio::spawn({ + let client = client.clone(); + async move { client.verify_protocol_version().await } + }); + + let request = read_framed(&mut server_read).await; + assert_eq!(request["method"], "connect"); + + let id = request["id"].as_u64().unwrap(); + let response = serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { "ok": true, "protocolVersion": protocol_version, "version": "test" }, + }); + write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; + + let err = timeout(TIMEOUT, handle) + .await + .unwrap() + .unwrap() + .unwrap_err(); + match err.kind() { + ErrorKind::Protocol(ProtocolErrorKind::InvalidProtocolVersion { server }) => { + assert_eq!(*server, protocol_version); + } + other => panic!("unexpected error kind: {other:?}"), + } + } } #[tokio::test] -async fn create_session_sends_canvas_wire_fields() { - let (client, mut server_read, mut server_write) = make_client(); +async fn github_telemetry_event_dispatches_to_callback() { + use github_copilot_sdk::github_telemetry::GitHubTelemetryNotification; + + let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::(); + let callback: github_copilot_sdk::github_telemetry::GitHubTelemetryCallback = + Arc::new(move |notification| { + let _ = tx.send(notification); + }); + let (client, mut server_read, mut server_write) = make_client_with_telemetry(callback); let create_handle = tokio::spawn({ let client = client.clone(); async move { client - .create_session( - SessionConfig::default() - .with_canvases([test_canvas("counter")]) - .with_request_canvas_renderer(true) - .with_request_extensions(true) - .with_extension_info(ExtensionInfo::new("github-app", "counter-provider")), - ) + .create_session(SessionConfig::default()) .await .unwrap() } }); let request = read_framed(&mut server_read).await; - assert_eq!(request["method"], "session.create"); - assert_eq!(request["params"]["canvases"][0]["id"], "counter"); - assert_eq!( - request["params"]["canvases"][0]["displayName"], - "Test Canvas" - ); - assert_eq!(request["params"]["requestCanvasRenderer"], true); - assert_eq!(request["params"]["requestExtensions"], true); - assert_eq!(request["params"]["extensionInfo"]["source"], "github-app"); - assert_eq!( - request["params"]["extensionInfo"]["name"], - "counter-provider" - ); - let id = request["id"].as_u64().unwrap(); let session_id = requested_session_id(&request).to_string(); let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, - "result": { "sessionId": session_id }, + "result": { "sessionId": session_id.clone() }, }); write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await; - timeout(TIMEOUT, create_handle).await.unwrap().unwrap(); + + let notification = serde_json::json!({ + "jsonrpc": "2.0", + "method": "gitHubTelemetry.event", + "params": { + "sessionId": session_id.clone(), + "restricted": false, + "event": { + "kind": "tool_call_executed", + "properties": { "tool": "bash" }, + "metrics": { "duration_ms": 12.0 }, + "session_id": session_id.clone(), + "created_at": "2025-01-01T00:00:00Z" + } + } + }); + write_framed( + &mut server_write, + &serde_json::to_vec(¬ification).unwrap(), + ) + .await; + + let received = timeout(TIMEOUT, rx.recv()).await.unwrap().unwrap(); + assert_eq!(received.session_id.as_deref(), Some(session_id.as_str())); + assert!(!received.restricted); + assert_eq!(received.event.kind, "tool_call_executed"); + assert_eq!( + received.event.properties.get("tool").map(String::as_str), + Some("bash") + ); + assert_eq!( + received.event.metrics.get("duration_ms").copied(), + Some(12.0) + ); + assert_eq!( + received.event.created_at.as_deref(), + Some("2025-01-01T00:00:00Z") + ); } #[tokio::test] @@ -1202,7 +2062,27 @@ async fn list_models_returns_typed_model_info() { "id": id, "result": { "models": [ - { "id": "gpt-4", "name": "GPT-4", "capabilities": {} }, + { + "id": "gpt-4", + "name": "GPT-4", + "capabilities": {}, + "billing": { + "multiplier": 1.5, + "tokenPrices": { + "inputPrice": 2.0, + "outputPrice": 8.0, + "cachePrice": 0.5, + "batchSize": 1000000, + "maxPromptTokens": 128000, + "longContext": { + "inputPrice": 4.0, + "outputPrice": 16.0, + "cachePrice": 1.0, + "maxPromptTokens": 1000000 + } + } + } + }, { "id": "claude-sonnet-4", "name": "Claude Sonnet", "capabilities": {} }, ] }, @@ -1213,6 +2093,22 @@ async fn list_models_returns_typed_model_info() { assert_eq!(models.len(), 2); assert_eq!(models[0].id, "gpt-4"); assert_eq!(models[1].name, "Claude Sonnet"); + + // Token prices are surfaced through the re-exported public types. + let token_prices: &github_copilot_sdk::types::ModelBillingTokenPrices = models[0] + .billing + .as_ref() + .expect("billing") + .token_prices + .as_ref() + .expect("token prices"); + assert_eq!(token_prices.input_price, Some(2.0)); + assert_eq!(token_prices.batch_size, Some(1000000)); + assert_eq!(token_prices.max_prompt_tokens, Some(128000)); + let long_context: &github_copilot_sdk::types::ModelBillingTokenPricesLongContext = + token_prices.long_context.as_ref().expect("long context"); + assert_eq!(long_context.output_price, Some(16.0)); + assert_eq!(long_context.max_prompt_tokens, Some(1000000)); } #[tokio::test] @@ -1290,7 +2186,8 @@ async fn set_model_sends_switch_to_request() { "claude-sonnet-4", Some( SetModelOptions::default() - .with_reasoning_summary(ReasoningSummary::Detailed), + .with_reasoning_summary(ReasoningSummary::Detailed) + .with_context_tier(ContextTier::LongContext), ), ) .await @@ -1302,6 +2199,7 @@ async fn set_model_sends_switch_to_request() { assert_eq!(request["method"], "session.model.switchTo"); assert_eq!(request["params"]["modelId"], "claude-sonnet-4"); assert_eq!(request["params"]["reasoningSummary"], "detailed"); + assert_eq!(request["params"]["contextTier"], "long_context"); server .respond( &request, @@ -1616,6 +2514,45 @@ async fn approve_all_handler_approves_permission() { assert_eq!(request["params"]["result"]["kind"], "approve-once"); } +#[tokio::test] +async fn permission_result_forwards_context_beside_result() { + let (_session, mut server) = create_session_pair_with_config(|cfg| { + cfg.with_permission_handler(Arc::new(ContextualApproveHandler)) + }) + .await; + + server + .send_event( + "permission.requested", + serde_json::json!({ + "requestId": "perm-attributed", + "sessionId": server.session_id, + "permissionRequest": { "kind": "shell" }, + }), + ) + .await; + + let request = timeout(TIMEOUT, server.read_request()).await.unwrap(); + assert_eq!( + request["method"], + "session.permissions.handlePendingPermissionRequest" + ); + assert_eq!( + request["params"], + serde_json::json!({ + "sessionId": server.session_id, + "requestId": "perm-attributed", + "result": { "kind": "approve-once" }, + "decisionContext": { + "outcome": "prompted_user", + "source": "human_response", + "surface": "copilot_app", + }, + }) + ); + assert!(request["params"]["result"].get("decisionContext").is_none()); +} + #[tokio::test] async fn session_event_notification_reaches_handler() { let (session, mut server) = create_session_pair().await; @@ -2576,17 +3513,17 @@ async fn resume_session_sends_canvas_fields_and_captures_open_canvases() { .with_request_canvas_renderer(true) .with_request_extensions(true) .with_extension_info(ExtensionInfo::new("github-app", "counter-provider")) + .with_canvas_provider(CanvasProviderIdentity::new("app:builtin:window-1")) .with_open_canvases([OpenCanvasInstance { instance_id: "counter-1".to_string(), extension_id: "github-app:counter-provider".to_string(), extension_name: Some("Counter Provider".to_string()), canvas_id: "counter".to_string(), + icon: None, title: Some("Counter".to_string()), status: Some("ready".to_string()), url: Some("https://example.test/counter".to_string()), input: Some(serde_json::json!({ "seed": 1 })), - reopen: false, - availability: CanvasInstanceAvailability::Stale, }]); client.resume_session(cfg).await.unwrap() } @@ -2603,8 +3540,16 @@ async fn resume_session_sends_canvas_fields_and_captures_open_canvases() { "counter-provider" ); assert_eq!( - request["params"]["openCanvases"][0]["availability"], - "stale" + request["params"]["canvasProvider"]["id"], + "app:builtin:window-1" + ); + assert!( + request["params"]["canvasProvider"].get("name").is_none(), + "name should be omitted from the wire when None, not serialized as null" + ); + assert_eq!( + request["params"]["openCanvases"][0]["instanceId"], + "counter-1" ); let id = request["id"].as_u64().unwrap(); @@ -2617,9 +3562,7 @@ async fn resume_session_sends_canvas_fields_and_captures_open_canvases() { "extensionId": "project:counter", "canvasId": "counter", "instanceId": "counter-1", - "url": "https://example.test/counter", - "reopen": false, - "availability": "ready" + "url": "https://example.test/counter" }], "capabilities": { "ui": { "canvases": true } @@ -2638,7 +3581,6 @@ async fn resume_session_sends_canvas_fields_and_captures_open_canvases() { let open = session.open_canvases(); assert_eq!(open.len(), 1); assert_eq!(open[0].instance_id, "counter-1"); - assert_eq!(open[0].availability, CanvasInstanceAvailability::Ready); let caps = session.capabilities(); assert_eq!(caps.ui.unwrap().canvases, Some(true)); } @@ -2667,9 +3609,7 @@ async fn session_canvas_opened_updates_open_canvas_snapshots() { "title": "Counter", "status": "ready", "url": "https://example.test/counter", - "input": { "seed": 1 }, - "reopen": false, - "availability": "ready" + "input": { "seed": 1 } }), ) .await; @@ -2680,9 +3620,7 @@ async fn session_canvas_opened_updates_open_canvas_snapshots() { "extensionId": "project:logs", "canvasId": "logs", "instanceId": "logs-1", - "title": "Logs", - "reopen": false, - "availability": "stale" + "title": "Logs" }), ) .await; @@ -2698,7 +3636,6 @@ async fn session_canvas_opened_updates_open_canvas_snapshots() { assert_eq!(open.len(), 2); assert_eq!(open[0].instance_id, "counter-1"); assert_eq!(open[0].title.as_deref(), Some("Counter")); - assert_eq!(open[0].availability, CanvasInstanceAvailability::Ready); assert_eq!(open[1].instance_id, "logs-1"); server @@ -2712,9 +3649,7 @@ async fn session_canvas_opened_updates_open_canvas_snapshots() { "title": "Counter Updated", "status": "reconnected", "url": "https://example.test/counter-updated", - "input": { "seed": 2 }, - "reopen": true, - "availability": "stale" + "input": { "seed": 2 } }), ) .await; @@ -2735,11 +3670,108 @@ async fn session_canvas_opened_updates_open_canvas_snapshots() { Some("https://example.test/counter-updated") ); assert_eq!(open[0].input, Some(serde_json::json!({ "seed": 2 }))); - assert!(open[0].reopen); - assert_eq!(open[0].availability, CanvasInstanceAvailability::Stale); assert_eq!(open[1].instance_id, "logs-1"); } +#[tokio::test] +async fn session_canvas_closed_removes_open_canvas_snapshot() { + let (session, mut server) = create_session_pair().await; + assert!(session.open_canvases().is_empty()); + + server + .send_event( + "session.canvas.opened", + serde_json::json!({ + "extensionId": "project:counter", + "canvasId": "counter", + "instanceId": "counter-1", + "title": "Counter" + }), + ) + .await; + server + .send_event( + "session.canvas.opened", + serde_json::json!({ + "extensionId": "project:logs", + "canvasId": "logs", + "instanceId": "logs-1", + "title": "Logs" + }), + ) + .await; + + let mut open = Vec::new(); + for _ in 0..50 { + open = session.open_canvases(); + if open.len() == 2 { + break; + } + tokio::time::sleep(Duration::from_millis(20)).await; + } + assert_eq!(open.len(), 2); + + // Closing one instance removes it while the other remains. + server + .send_event( + "session.canvas.closed", + serde_json::json!({ + "extensionId": "project:counter", + "canvasId": "counter", + "instanceId": "counter-1" + }), + ) + .await; + + for _ in 0..50 { + open = session.open_canvases(); + if open.len() == 1 { + break; + } + tokio::time::sleep(Duration::from_millis(20)).await; + } + assert_eq!(open.len(), 1); + assert_eq!(open[0].instance_id, "logs-1"); + + // Closing an absent instance is a no-op (idempotent). + server + .send_event( + "session.canvas.closed", + serde_json::json!({ + "extensionId": "project:counter", + "canvasId": "counter", + "instanceId": "counter-1" + }), + ) + .await; + + // Give the event loop time to process; the snapshot must stay unchanged. + for _ in 0..10 { + tokio::time::sleep(Duration::from_millis(20)).await; + open = session.open_canvases(); + assert_eq!(open.len(), 1); + } + assert_eq!(open[0].instance_id, "logs-1"); + + // A closed event with an empty instance_id is ignored and leaves the snapshot intact. + server + .send_event( + "session.canvas.closed", + serde_json::json!({ + "extensionId": "project:logs", + "canvasId": "logs", + "instanceId": "" + }), + ) + .await; + for _ in 0..10 { + tokio::time::sleep(Duration::from_millis(20)).await; + open = session.open_canvases(); + assert_eq!(open.len(), 1); + } + assert_eq!(open[0].instance_id, "logs-1"); +} + #[tokio::test] async fn elicitation_methods_fail_without_capability() { let (session, _server) = create_session_pair().await; @@ -3190,7 +4222,7 @@ fn session_config_serializes_bucket_b_fields() { cfg.github_token = Some("ghs_secret".to_string()); cfg.include_sub_agent_streaming_events = Some(false); cfg.enable_session_telemetry = Some(false); - cfg.remote_session = Some(github_copilot_sdk::generated::api_types::RemoteSessionMode::Export); + cfg.remote_session = Some(github_copilot_sdk::rpc::RemoteSessionMode::Export); cfg.cloud = Some(CloudSessionOptions::with_repository( CloudSessionRepository::new("github", "copilot-sdk").with_branch("main"), )); @@ -3216,7 +4248,7 @@ fn resume_session_config_serializes_bucket_b_fields() { cfg.github_token = Some("ghs_secret".to_string()); cfg.include_sub_agent_streaming_events = Some(true); cfg.enable_session_telemetry = Some(false); - cfg.remote_session = Some(github_copilot_sdk::generated::api_types::RemoteSessionMode::On); + cfg.remote_session = Some(github_copilot_sdk::rpc::RemoteSessionMode::On); let debug = format!("{cfg:?}"); assert!(!debug.contains("ghs_secret"), "leaked token: {debug}"); @@ -3470,7 +4502,7 @@ async fn command_execute_handler_error_propagates_to_ack() { use github_copilot_sdk::session_fs::{ DirEntry, DirEntryKind, FileInfo, FsError, FsErrorKind, SessionFsConventions, SessionFsProvider, SessionFsSqliteProvider, SessionFsSqliteQueryResult, - SessionFsSqliteQueryType, + SessionFsSqliteQueryType, SessionFsSqliteTransactionError, SessionFsSqliteTransactionStatement, }; struct RecordingFsProvider { @@ -3592,6 +4624,24 @@ impl SessionFsSqliteProvider for RecordingFsProvider { })) } + async fn sqlite_transaction( + &self, + statements: &[SessionFsSqliteTransactionStatement], + ) -> Result, SessionFsSqliteTransactionError> { + let mut results = Vec::with_capacity(statements.len()); + for statement in statements { + let result = self + .sqlite_query( + statement.query_type.clone(), + &statement.query, + statement.params.as_ref(), + ) + .await?; + results.push(result.unwrap_or_default()); + } + Ok(results) + } + async fn sqlite_exists(&self) -> Result { Ok(true) } @@ -3780,6 +4830,13 @@ async fn session_fs_maps_sqlite_errors_to_results() { )) } + async fn sqlite_transaction( + &self, + _statements: &[SessionFsSqliteTransactionStatement], + ) -> Result, SessionFsSqliteTransactionError> { + Err(SessionFsSqliteTransactionError::fatal("sqlite unavailable")) + } + async fn sqlite_exists(&self) -> Result { Err(FsError::with_message( FsErrorKind::Other, diff --git a/scripts/codegen/csharp.ts b/scripts/codegen/csharp.ts index 883895cde..46f50daf5 100644 --- a/scripts/codegen/csharp.ts +++ b/scripts/codegen/csharp.ts @@ -27,6 +27,7 @@ import { findSharedSchemaDefinitions, postProcessSchema, propagateInternalVisibility, + filterNodeByVisibility, resolveRef, resolveObjectSchema, resolveSchema, @@ -39,6 +40,7 @@ import { isSchemaExperimental, isSchemaInternal, isOpaqueJson, + isOpaqueInProcess, isObjectSchema, isVoidSchema, getNullableInner, @@ -46,6 +48,8 @@ import { getSessionEventVariantSchemas, getSharedSessionEventEnvelopeProperties, rewriteSharedDefinitionReferences, + loadSchemaJson, + fixBrandCasing, REPO_ROOT, type ApiSchema, type DefinitionCollections, @@ -63,6 +67,55 @@ const TYPE_RENAMES: Record = { PermissionRequestedDataPermissionRequest: "PermissionRequest", }; +const POLYMORPHIC_BASE_PROPERTIES: Record = { + PermissionRequest: ["managedApprovalRequired"], +}; + +/** + * Public type names declared by hand-written C# sources under `dotnet/src` + * (excluding `dotnet/src/Generated`). Generated session-event types share the + * `GitHub.Copilot` namespace with those sources, so a schema definition whose + * name collides with a hand-written declaration must reuse it — emitting a + * second class of the same name fails the build (CS0260/CS0102). + * + * Populated by {@link collectHandWrittenCSharpTypeNames} before generation. + */ +let handWrittenCSharpTypeNames = new Set(); + +/** + * Scan hand-written `.cs` files under `dotnet/src` for top-level public type + * declarations. The `Generated` directory is skipped so this scanner never + * reads (or depends on the output of) its own emit. + */ +async function collectHandWrittenCSharpTypeNames(): Promise> { + const names = new Set(); + const srcDir = path.join(REPO_ROOT, "dotnet", "src"); + const declaration = /^\s*(?:public|internal)\s+(?:(?:abstract|sealed|static|partial|readonly|ref)\s+)*(?:class|record|struct|interface|enum)\s+([A-Za-z_]\w*)/gm; + + const walk = async (dir: string): Promise => { + let entries; + try { + entries = await fs.readdir(dir, { withFileTypes: true }); + } catch { + return; + } + for (const entry of entries) { + const entryPath = path.join(dir, entry.name); + if (entry.isDirectory()) { + if (entry.name === "Generated" || entry.name === "bin" || entry.name === "obj") continue; + await walk(entryPath); + continue; + } + if (!entry.name.endsWith(".cs")) continue; + const content = await fs.readFile(entryPath, "utf-8"); + for (const match of content.matchAll(declaration)) names.add(match[1]); + } + }; + + await walk(srcDir); + return names; +} + /** Apply rename to a generated class name, checking both exact match and prefix replacement for derived types. */ function applyTypeRename(className: string): string { if (TYPE_RENAMES[className]) return TYPE_RENAMES[className]; @@ -217,7 +270,7 @@ function xmlDocEnumMemberComment(enumValueDescriptions: EnumValueDescriptions | function toPascalCase(name: string): string { const parts = splitCSharpIdentifierParts(name); if (parts.length > 1) return parts.map(toPascalCasePart).join(""); - return name.charAt(0).toUpperCase() + name.slice(1); + return fixBrandCasing(name.charAt(0).toUpperCase() + name.slice(1)); } function stripDurationMillisecondsSuffix(name: string): string { @@ -228,7 +281,8 @@ function stripDurationMillisecondsSuffix(name: string): string { } function toCSharpPropertyName(propName: string, schema: JSONSchema7): string { - return toPascalCase(isDurationProperty(schema) ? stripDurationMillisecondsSuffix(propName) : propName); + const normalizedName = propName.replace(/^_+/, "") || propName; + return toPascalCase(isDurationProperty(schema) ? stripDurationMillisecondsSuffix(normalizedName) : normalizedName); } function isSecondsDurationPropertyName(propName: string | undefined): boolean { @@ -244,7 +298,7 @@ function splitCSharpIdentifierParts(value: string): string[] { } function toPascalCasePart(value: string): string { - return value.charAt(0).toUpperCase() + value.slice(1); + return fixBrandCasing(value.charAt(0).toUpperCase() + value.slice(1)); } function toCSharpIdentifier(value: string, fallback: string): string { @@ -302,6 +356,41 @@ function failUnmappable(context: string, schema: JSONSchema7): never { ); } +function omitUnrepresentableInternalProperties(value: unknown): void { + if (!value || typeof value !== "object") return; + if (Array.isArray(value)) { + value.forEach(omitUnrepresentableInternalProperties); + return; + } + + const node = value as Record; + const properties = node.properties; + if (properties && typeof properties === "object" && !Array.isArray(properties)) { + for (const [name, property] of Object.entries(properties)) { + if (!property || typeof property !== "object" || Array.isArray(property)) continue; + const schema = property as JSONSchema7; + const hasType = + schema.type !== undefined || + schema.$ref !== undefined || + schema.anyOf !== undefined || + schema.oneOf !== undefined || + schema.allOf !== undefined || + schema.enum !== undefined || + schema.const !== undefined || + isOpaqueJson(schema); + if (isSchemaInternal(schema) && (!hasType || isOpaqueInProcess(schema))) { + delete (properties as Record)[name]; + } else { + omitUnrepresentableInternalProperties(property); + } + } + } + + for (const [name, child] of Object.entries(node)) { + if (name !== "properties") omitUnrepresentableInternalProperties(child); + } +} + function requiresArgumentNullCheck(typeName: string, isRequired: boolean): boolean { return isRequired && !typeName.endsWith("?") && !isNonNullableCSharpValueType(typeName); } @@ -491,7 +580,9 @@ const COPYRIGHT = `/*----------------------------------------------------------- const EXPERIMENTAL_ATTRIBUTE = "[Experimental(Diagnostics.Experimental)]"; const EDITOR_BROWSABLE_NEVER_ATTRIBUTE = "[EditorBrowsable(EditorBrowsableState.Never)]"; -const OBSOLETE_ATTRIBUTE = `[Obsolete("This member is deprecated and will be removed in a future version.")]`; +const OBSOLETE_ATTRIBUTE = `#if NET5_0_OR_GREATER +[Obsolete("This member is deprecated and will be removed in a future version.", DiagnosticId = "GHCP001")] +#endif`; const STRING_ENUM_RESERVED_MEMBER_NAMES = new Set(["Value", "Equals", "GetHashCode", "ToString", "Converter"]); function experimentalAttribute(indent = ""): string { @@ -505,7 +596,7 @@ function pushExperimentalAttribute(lines: string[], indent = ""): void { function obsoleteAttributes(indent = ""): string[] { return [ `${indent}${EDITOR_BROWSABLE_NEVER_ATTRIBUTE}`, - `${indent}${OBSOLETE_ATTRIBUTE}`, + ...OBSOLETE_ATTRIBUTE.split("\n").map((line) => line.startsWith("#") ? line : `${indent}${line}`), ]; } @@ -821,6 +912,7 @@ function generatePolymorphicClasses( const lines: string[] = []; const discriminatorInfo = findDiscriminator(variants)!; const renamedBase = applyTypeRename(baseClassName); + const baseProperties = new Set(POLYMORPHIC_BASE_PROPERTIES[renamedBase] ?? []); lines.push(...xmlDocCommentWithFallback(description, `Polymorphic base type discriminated by ${escapeXml(discriminatorProperty)}.`, "")); if (experimental) pushExperimentalAttribute(lines); @@ -839,13 +931,52 @@ function generatePolymorphicClasses( lines.push(` /// The type discriminator.`); lines.push(` [JsonPropertyName("${discriminatorProperty}")]`); lines.push(` public virtual string ${toPascalCase(discriminatorProperty)} { get; set; } = string.Empty;`); + for (const propName of baseProperties) { + const propSchema = variants + .map((variant) => variant.properties?.[propName]) + .find((property): property is JSONSchema7 => typeof property === "object"); + if (!propSchema) continue; + + const csharpName = toCSharpPropertyName(propName, propSchema); + const csharpType = resolver( + propSchema, + renamedBase, + csharpName, + false, + knownTypes, + nestedClasses, + enumOutput + ); + lines.push(""); + lines.push(...xmlDocPropertyComment(propSchema.description, propName, " ")); + lines.push(...emitDataAnnotations(propSchema, " ", csharpType)); + if (isSchemaDeprecated(propSchema)) pushObsoleteAttributes(lines, " "); + if (isSchemaExperimental(propSchema)) pushExperimentalAttribute(lines, " "); + lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`); + const propVisibility = pushCSharpInternalAttribute(lines, propSchema); + lines.push(` [JsonPropertyName("${propName}")]`); + lines.push(` ${propVisibility} virtual ${csharpType} ${csharpName} { get; set; }`); + } lines.push(`}`); lines.push(""); for (const { value, schema } of discriminatorInfo.mapping.values()) { const constValue = String(value); const derivedClassName = applyTypeRename(`${baseClassName}${toPascalCase(constValue)}`); - const derivedCode = generateDerivedClass(derivedClassName, renamedBase, discriminatorProperty, constValue, schema, knownTypes, nestedClasses, enumOutput, resolver, experimental, options); + const derivedCode = generateDerivedClass( + derivedClassName, + renamedBase, + discriminatorProperty, + constValue, + schema, + knownTypes, + nestedClasses, + enumOutput, + resolver, + experimental, + options, + baseProperties + ); nestedClasses.set(derivedClassName, derivedCode); } @@ -866,7 +997,8 @@ function generateDerivedClass( enumOutput: string[], propertyResolver: PropertyTypeResolver, experimental = false, - options: DiscriminatedUnionGenerationOptions = {} + options: DiscriminatedUnionGenerationOptions = {}, + baseProperties: ReadonlySet = new Set() ): string { const lines: string[] = []; const required = new Set(schema.required || []); @@ -891,6 +1023,18 @@ function generateDerivedClass( const csharpName = toCSharpPropertyName(propName, prop); const csharpType = propertyResolver(prop, className, csharpName, isReq, knownTypes, nestedClasses, enumOutput); + if (baseProperties.has(propName)) { + lines.push(` /// `); + if (!isReq) lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`); + lines.push(` [JsonPropertyName("${propName}")]`); + lines.push(` public override ${csharpType} ${csharpName}`); + lines.push(` {`); + lines.push(` get => base.${csharpName};`); + lines.push(` set => base.${csharpName} = value;`); + lines.push(` }`, ""); + continue; + } + lines.push(...xmlDocPropertyComment(prop.description, propName, " ")); lines.push(...emitDataAnnotations(prop, " ", csharpType)); if (isSchemaDeprecated(prop)) pushObsoleteAttributes(lines, " "); @@ -1317,7 +1461,7 @@ function emitSessionEventEnvelopeProperty( export function generateSessionEventsCode(schema: JSONSchema7): string { generatedEnums.clear(); sessionDefinitions = collectDefinitionCollections(schema as Record); - const variants = extractEventVariants(schema); + const variants = extractEventVariants(schema).filter((variant) => !isSchemaInternal(variant.dataSchema)); const knownTypes = new Map(); const nestedClasses = new Map(); const enumOutput: string[] = []; @@ -1376,12 +1520,16 @@ namespace GitHub.Copilot; if (variant.eventExperimental) { pushExperimentalAttribute(lines); } - const variantVisibility = isSchemaInternal(variant.dataSchema) ? "internal" : "public"; - lines.push(`${variantVisibility} sealed partial class ${variant.className} : SessionEvent`, `{`); + lines.push(`public sealed partial class ${variant.className} : SessionEvent`, `{`); lines.push(` /// `); lines.push(` [JsonIgnore]`, ` public override string Type => "${variant.typeName}";`, ""); lines.push(` /// The ${escapeXml(variant.typeName)} event payload.`); - lines.push(` [JsonPropertyName("data")]`, ` ${variantVisibility} required ${variant.dataClassName} Data { get; set; }`, `}`, ""); + lines.push( + ` [JsonPropertyName("data")]`, + ` public required ${variant.dataClassName} Data { get; set; }`, + `}`, + "" + ); } // Data classes @@ -1389,8 +1537,13 @@ namespace GitHub.Copilot; lines.push(generateDataClass(variant, knownTypes, nestedClasses, enumOutput), ""); } - // Nested classes - for (const [, code] of nestedClasses) lines.push(code, ""); + // Nested classes. A name already declared by a hand-written source is skipped: + // that declaration is the one the namespace keeps, and the generated property + // simply binds to it. + for (const [name, code] of nestedClasses) { + if (handWrittenCSharpTypeNames.has(name)) continue; + lines.push(code, ""); + } // Enums for (const code of enumOutput) lines.push(code); @@ -1408,8 +1561,9 @@ namespace GitHub.Copilot; export async function generateSessionEvents(schemaPath?: string): Promise { console.log("C#: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as JSONSchema7); + const schema = cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as JSONSchema7); const processed = propagateInternalVisibility(postProcessSchema(schema)); + handWrittenCSharpTypeNames = await collectHandWrittenCSharpTypeNames(); const code = generateSessionEventsCode(processed); const outPath = await writeGeneratedFile("dotnet/src/Generated/SessionEvents.cs", code); console.log(` ✓ ${outPath}`); @@ -1427,6 +1581,7 @@ let nonExperimentalRpcTypes = new Set(); let rpcKnownTypes = new Map(); let rpcEnumOutput: string[] = []; let externalRpcValueTypes = new Set(); +let rpcRootJsonSerializableTypes = new Set(); /** Schema definitions available during RPC generation (for $ref resolution). */ let rpcDefinitions: DefinitionCollections = { definitions: {}, $defs: {} }; @@ -1613,7 +1768,8 @@ function emitRpcClass( className: string, schema: JSONSchema7, visibility: "public" | "internal", - extraClasses: string[] + extraClasses: string[], + inlineTypeParentName: string = className ): string { const effectiveSchema = resolveObjectSchema(schema, rpcDefinitions) ?? @@ -1660,7 +1816,7 @@ function emitRpcClass( const prop = propSchema as JSONSchema7; const isReq = requiredSet.has(propName); const csharpName = toCSharpPropertyName(propName, prop); - const csharpType = resolveRpcType(prop, isReq, className, csharpName, extraClasses); + const csharpType = resolveRpcType(prop, isReq, inlineTypeParentName, csharpName, extraClasses); lines.push(...xmlDocPropertyComment(prop.description, propName, " ")); lines.push(...emitDataAnnotations(prop, " ", csharpType)); @@ -1699,7 +1855,11 @@ function emitRpcResultType(typeName: string, schema: JSONSchema7, visibility: "p return typeName; } - return resolveRpcType(schema, true, typeName, "", classes); + const resultType = resolveRpcType(schema, true, typeName, "", classes); + if (resultType.includes("<") || resultType.endsWith("[]")) { + rpcRootJsonSerializableTypes.add(resultType.replace(/\?$/, "")); + } + return resultType; } /** @@ -2022,7 +2182,15 @@ function emitSessionMethod(key: string, method: RpcMethod, lines: string[], clas }; const publicReqClass = emitRpcClass(requestClassName, publicParams, methodVisibility, classes); if (publicReqClass) classes.push(publicReqClass); - const wireReqClass = emitRpcClass(wireRequestClassName, effectiveParams, "internal", classes); + // The wire wrapper carries the same properties as the public request + // type plus `sessionId`, so both must reuse the same inline types. + const wireReqClass = emitRpcClass( + wireRequestClassName, + effectiveParams, + "internal", + classes, + requestClassName + ); if (wireReqClass) classes.push(wireReqClass); } else { const reqClass = emitRpcClass(requestClassName, effectiveParams, "internal", classes); @@ -2295,17 +2463,156 @@ function emitClientSessionApiRegistration(clientSchema: Record, return lines; } +/** + * Emit C# handler interfaces + a process-wide registration for client + * *global* API groups. + * + * Unlike client-session APIs, these methods carry no implicit `sessionId` + * dispatch key. The SDK consumer registers a single process-wide handler set + * via `RegisterClientGlobalApiHandlers`; the runtime dispatcher routes each + * incoming call to the registered handler regardless of which (if any) + * runtime session triggered it. + */ +function emitClientGlobalApiRegistration(clientSchema: Record, classes: string[]): string[] { + const lines: string[] = []; + const groups = collectClientGroups(clientSchema); + + for (const { methods } of groups) { + for (const method of methods) { + const resultSchema = getMethodResultSchema(method); + if (!isVoidSchema(resultSchema) && !isOpaqueJson(resultSchema)) { + emitRpcResultType(resultTypeName(method), resultSchema!, "public", classes); + } + + const effectiveParams = resolveMethodParamsSchema(method); + if (effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0) { + const paramsClass = emitRpcClass(paramsTypeName(method), effectiveParams, "public", classes); + if (paramsClass) classes.push(paramsClass); + } + } + } + + for (const { groupName, groupNode, methods } of groups) { + const interfaceName = clientHandlerInterfaceName(groupName); + const groupExperimental = isNodeFullyExperimental(groupNode); + const groupDeprecated = isNodeFullyDeprecated(groupNode); + lines.push(`/// Handles \`${groupName}\` client global API methods.`); + if (groupExperimental) { + pushExperimentalAttribute(lines); + } + if (groupDeprecated) { + pushObsoleteAttributes(lines); + } + lines.push(`public interface ${interfaceName}`); + lines.push(`{`); + for (const method of methods) { + const effectiveParams = resolveMethodParamsSchema(method); + const hasParams = !!effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0; + const resultSchema = getMethodResultSchema(method); + const taskType = resultTaskType(method); + pushRpcMethodXmlDocs( + lines, + method, + " ", + [ + ...(hasParams ? [{ name: "request", description: rpcParamsDescription(method, effectiveParams) }] : []), + { name: "cancellationToken", description: CANCELLATION_TOKEN_DESCRIPTION, escapeDescription: false }, + ], + resultSchema, + `Handles "${method.rpcMethod}".` + ); + if (method.stability === "experimental" && !groupExperimental) { + pushExperimentalAttribute(lines, " "); + } + if (method.deprecated && !groupDeprecated) { + pushObsoleteAttributes(lines, " "); + } + if (hasParams) { + lines.push(` ${taskType} ${clientHandlerMethodName(method.rpcMethod)}(${paramsTypeName(method)} request, CancellationToken cancellationToken = default);`); + } else { + lines.push(` ${taskType} ${clientHandlerMethodName(method.rpcMethod)}(CancellationToken cancellationToken = default);`); + } + } + lines.push(`}`); + lines.push(""); + } + + lines.push(`/// Provides all client global API handler groups for a connection.`); + lines.push(`public sealed class ClientGlobalApiHandlers`); + lines.push(`{`); + for (const { groupName } of groups) { + lines.push(` /// Optional handler for ${toPascalCase(groupName)} client global API methods.`); + lines.push(` public ${clientHandlerInterfaceName(groupName)}? ${toPascalCase(groupName)} { get; set; }`); + lines.push(""); + } + if (lines[lines.length - 1] === "") lines.pop(); + lines.push(`}`); + lines.push(""); + + lines.push(`/// Registers client global API handlers on a JSON-RPC connection.`); + lines.push(`internal static class ClientGlobalApiRegistration`); + lines.push(`{`); + lines.push(` /// `); + lines.push(` /// Registers handlers for server-to-client global API calls.`); + lines.push(` /// Unlike client session APIs, these methods carry no implicit`); + lines.push(` /// sessionId dispatch key — a single set of handlers serves the`); + lines.push(` /// entire connection.`); + lines.push(` /// `); + lines.push(` public static void RegisterClientGlobalApiHandlers(JsonRpc rpc, ClientGlobalApiHandlers handlers)`); + lines.push(` {`); + for (const { groupName, methods } of groups) { + for (const method of methods) { + const handlerProperty = toPascalCase(groupName); + const handlerMethod = clientHandlerMethodName(method.rpcMethod); + const effectiveParams = resolveMethodParamsSchema(method); + const hasParams = !!effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0; + const resultSchema = getMethodResultSchema(method); + const paramsClass = paramsTypeName(method); + const taskType = handlerTaskType(method); + + if (hasParams) { + lines.push(` rpc.SetLocalRpcMethod("${method.rpcMethod}", (Func<${paramsClass}, CancellationToken, ${taskType}>)(async (request, cancellationToken) =>`); + lines.push(` {`); + lines.push(` var handler = handlers.${handlerProperty} ?? throw new InvalidOperationException("No ${groupName} client-global handler registered");`); + if (!isVoidSchema(resultSchema)) { + lines.push(` return await handler.${handlerMethod}(request, cancellationToken);`); + } else { + lines.push(` await handler.${handlerMethod}(request, cancellationToken);`); + } + lines.push(` }), singleObjectParam: true);`); + } else { + lines.push(` rpc.SetLocalRpcMethod("${method.rpcMethod}", (Func)(async cancellationToken =>`); + lines.push(` {`); + lines.push(` var handler = handlers.${handlerProperty} ?? throw new InvalidOperationException("No ${groupName} client-global handler registered");`); + if (!isVoidSchema(resultSchema)) { + lines.push(` return await handler.${handlerMethod}(cancellationToken);`); + } else { + lines.push(` await handler.${handlerMethod}(cancellationToken);`); + } + lines.push(` }));`); + } + } + } + lines.push(` }`); + lines.push(`}`); + + return lines; +} + function generateRpcCode( schema: ApiSchema, externalJsonSerializableRefs: Map> = new Map(), externalValueTypes: Set = new Set() ): string { + schema = cloneSchemaForCodegen(schema); + omitUnrepresentableInternalProperties(schema); emittedRpcClassSchemas.clear(); emittedRpcEnumResultTypes.clear(); experimentalRpcTypes.clear(); nonExperimentalRpcTypes.clear(); rpcKnownTypes.clear(); rpcEnumOutput = []; + rpcRootJsonSerializableTypes.clear(); generatedEnums.clear(); // Clear shared enum deduplication map externalRpcValueTypes = new Set([...externalValueTypes].map(typeToClassName)); rpcDefinitions = collectDefinitionCollections(schema as Record); @@ -2313,6 +2620,7 @@ function generateRpcCode( ...collectRpcMethods(schema.server || {}), ...collectRpcMethods(schema.session || {}), ...collectRpcMethods(schema.clientSession || {}), + ...collectRpcMethods(schema.clientGlobal || {}), ]; for (const name of collectRpcMethodReferencedDefinitionNames( allMethods.filter((method) => method.stability !== "experimental"), @@ -2338,8 +2646,23 @@ function generateRpcCode( let sessionRpcParts: string[] = []; if (schema.session) sessionRpcParts = emitSessionRpcClasses(schema.session, classes); + // Client handler surfaces (interfaces, handler properties, RPC registration) + // are only generated for public methods. Internal client methods (e.g. + // `hooks.invoke`) are runtime transport plumbing and must not surface any + // generated code — including their request/result DTOs, which would + // otherwise leak as `internal` types referenced by a `public` handler + // interface (CS0050/CS0051 inconsistent accessibility). let clientSessionParts: string[] = []; - if (schema.clientSession) clientSessionParts = emitClientSessionApiRegistration(schema.clientSession, classes); + if (schema.clientSession) { + const publicClientSession = filterNodeByVisibility(schema.clientSession, "public"); + if (publicClientSession) clientSessionParts = emitClientSessionApiRegistration(publicClientSession, classes); + } + + let clientGlobalParts: string[] = []; + if (schema.clientGlobal) { + const publicClientGlobal = filterNodeByVisibility(schema.clientGlobal, "public"); + if (publicClientGlobal) clientGlobalParts = emitClientGlobalApiRegistration(publicClientGlobal, classes); + } const lines: string[] = []; lines.push(`${COPYRIGHT} @@ -2366,9 +2689,12 @@ namespace GitHub.Copilot.Rpc; for (const part of serverRpcParts) lines.push(part, ""); for (const part of sessionRpcParts) lines.push(part, ""); if (clientSessionParts.length > 0) lines.push(...clientSessionParts, ""); + if (clientGlobalParts.length > 0) lines.push(...clientGlobalParts, ""); // Add JsonSerializerContext for AOT/trimming support - const typeNames = [...emittedRpcClassSchemas.keys(), ...emittedRpcEnumResultTypes].sort(); + const typeNames = [ + ...new Set([...emittedRpcClassSchemas.keys(), ...emittedRpcEnumResultTypes, ...rpcRootJsonSerializableTypes]), + ].sort(); if (typeNames.length > 0) { lines.push(`[JsonSourceGenerationOptions(`); lines.push(` JsonSerializerDefaults.Web,`); @@ -2392,7 +2718,8 @@ namespace GitHub.Copilot.Rpc; export async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema7): Promise { console.log("C#: generating RPC types..."); const resolvedPath = schemaPath ?? (await getApiSchemaPath()); - let schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as ApiSchema)); + handWrittenCSharpTypeNames = await collectHandWrittenCSharpTypeNames(); + let schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as ApiSchema)); if (sessionEventsSchema) { const sharedDefinitions = findSharedSchemaDefinitions( schema as unknown as Record, @@ -2421,7 +2748,9 @@ export async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSO for (const name of reachableDefinitions) { const typeName = typeToClassName(name); const declarationPattern = new RegExp(`\\bpublic\\s+(?:(?:sealed|abstract|partial|readonly)\\s+)*(?:class|struct)\\s+${typeName}\\b`); - if (declarationPattern.test(sessionEventsCode)) { + // A hand-written declaration also lives in `GitHub.Copilot`, so the + // reference resolves even though the generated file skipped it. + if (declarationPattern.test(sessionEventsCode) || handWrittenCSharpTypeNames.has(typeName)) { emittedDefinitions.add(name); } const valueTypeDeclarationPattern = new RegExp(`\\bpublic\\s+(?:(?:readonly)\\s+)?struct\\s+${typeName}\\b`); @@ -2449,7 +2778,7 @@ async function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Pro await generateSessionEvents(sessionSchemaPath); try { const resolvedSessionPath = sessionSchemaPath ?? (await getSessionEventsSchemaPath()); - const sessionSchema = propagateInternalVisibility(postProcessSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedSessionPath, "utf-8")) as JSONSchema7))); + const sessionSchema = propagateInternalVisibility(postProcessSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedSessionPath)) as JSONSchema7))); await generateRpc(apiSchemaPath, sessionSchema); } catch (err) { if ((err as NodeJS.ErrnoException).code === "ENOENT" && !apiSchemaPath) { diff --git a/scripts/codegen/go.ts b/scripts/codegen/go.ts index a8b85dc0b..d6eda7f99 100644 --- a/scripts/codegen/go.ts +++ b/scripts/codegen/go.ts @@ -14,18 +14,19 @@ import { fileURLToPath } from "url"; import { promisify } from "util"; import wordwrap from "wordwrap"; import { + addManagedApprovalRequiredToPermissionRequests, cloneSchemaForCodegen, - collectExternalSchemaRefNames, collectDefinitionCollections, collectExperimentalOnlyRpcReferencedDefinitionNames, + collectExternalSchemaRefNames, collectReachableDefinitionNames, collectRpcMethodReferencedDefinitionNames, filterNodeByVisibility, - fixNullableRequiredRefsInApiSchema, findSharedSchemaDefinitions, + fixNullableRequiredRefsInApiSchema, getApiSchemaPath, - getNullableInner, getEnumValueDescriptions, + getNullableInner, getRpcSchemaTypeName, getSessionEventsSchemaPath, getSessionEventVariantSchemas, @@ -40,10 +41,12 @@ import { isSchemaExperimental, isSchemaInternal, isVoidSchema, + loadSchemaJson, parseExternalSchemaRef, postProcessSchema, propagateInternalVisibility, refTypeName, + REPO_ROOT, resolveObjectSchema, resolveRef, resolveSchema, @@ -72,15 +75,29 @@ const EXTERNAL_SCHEMA_GO_IMPORT: Record = { // ── Utilities ─────────────────────────────────────────────────────────────── // Go initialisms that should be all-caps -const goInitialisms = new Set(["id", "ui", "uri", "url", "api", "http", "https", "json", "xml", "html", "css", "sql", "ssh", "tcp", "udp", "ip", "rpc", "mime"]); +const goInitialisms = new Set(["id", "ui", "uri", "url", "api", "http", "https", "json", "xml", "html", "css", "sql", "ssh", "tcp", "udp", "ip", "rpc", "mime", "mcp", "sse", "ado", "cli", "hmac", "fs", "utc", "sdk"]); +const goIdentifierCasingOverrides = new Map([ + ["urls", "URLs"], + ["uris", "URIs"], + ["ids", "IDs"], + ["github", "GitHub"], +]); const goCommentTextWrapLength = 90; const wrapGoCommentText = wordwrap(goCommentTextWrapLength); +function goIdentifierWord(word: string, normalizeRest = false): string { + const lower = word.toLowerCase(); + const override = goIdentifierCasingOverrides.get(lower); + if (override) return override; + if (goInitialisms.has(lower)) return word.toUpperCase(); + return word.charAt(0).toUpperCase() + (normalizeRest ? word.slice(1).toLowerCase() : word.slice(1)); +} + function toPascalCase(s: string): string { return s .split(/[^A-Za-z0-9]+/) .filter((word) => word.length > 0) - .map((w) => goInitialisms.has(w.toLowerCase()) ? w.toUpperCase() : w.charAt(0).toUpperCase() + w.slice(1)) + .map((w) => goIdentifierWord(w)) .join(""); } @@ -95,10 +112,24 @@ function toGoSchemaTypeName(s: string): string { function toGoFieldName(jsonName: string): string { // Handle camelCase field names like "modelId" -> "ModelID" return splitGoIdentifierWords(jsonName) - .map((w) => goInitialisms.has(w.toLowerCase()) ? w.toUpperCase() : w.charAt(0).toUpperCase() + w.slice(1).toLowerCase()) + .map((w) => goIdentifierWord(w, true)) .join(""); } +function toGoUnexportedIdentifier(name: string): string { + const leadingSpecialCases = [ + ...Array.from(goIdentifierCasingOverrides.values()), + ...Array.from(goInitialisms, (initialism) => initialism.toUpperCase()), + ].sort((left, right) => right.length - left.length); + + const leadingSpecialCase = leadingSpecialCases.find((specialCase) => name.startsWith(specialCase)); + if (leadingSpecialCase) { + return leadingSpecialCase.toLowerCase() + name.slice(leadingSpecialCase.length); + } + + return name.charAt(0).toLowerCase() + name.slice(1); +} + function goRefTypeName(ref: string, definitions?: DefinitionCollections, currentPackage?: string): string { const externalRef = parseExternalSchemaRef(ref); if (externalRef) { @@ -356,6 +387,15 @@ function goTypeWithOptionalPointer(goType: string, ctx?: GoCodegenCtx): string { return goTypeIsNilable(goType, ctx) ? goType : `*${goType}`; } +function goJSONOmitSuffix(required: boolean, goType: string): string { + if (required) return ""; + return goTypeIsSlice(goType) || goTypeIsMap(goType) ? ",omitzero" : ",omitempty"; +} + +function goJSONTag(jsonName: string, required: boolean, goType: string): string { + return `json:"${jsonName}${goJSONOmitSuffix(required, goType)}"`; +} + async function formatGoFile(filePath: string): Promise { try { await execFileAsync("go", ["fmt", filePath]); @@ -542,7 +582,8 @@ function extractGoEventVariants(schema: JSONSchema7): GoEventVariant[] { eventExperimental: isSchemaExperimental(variant), dataExperimental: isSchemaExperimental(dataSchema), }; - }); + }) + .filter((variant) => !isSchemaInternal(variant.dataSchema)); } function getGoSharedEventEnvelopeProperties(schema: JSONSchema7, ctx: GoCodegenCtx): GoEventEnvelopeProperty[] { @@ -550,7 +591,6 @@ function getGoSharedEventEnvelopeProperties(schema: JSONSchema7, ctx: GoCodegenC .map((property) => { const { name, schema, required } = property; const typeName = resolveGoPropertyType(schema, "SessionEvent", name, required && !getNullableInner(schema), ctx); - const omit = required ? "" : ",omitempty"; return { name, @@ -558,7 +598,7 @@ function getGoSharedEventEnvelopeProperties(schema: JSONSchema7, ctx: GoCodegenC required, fieldName: toGoFieldName(name), typeName, - jsonTag: `json:"${name}${omit}"`, + jsonTag: goJSONTag(name, required, typeName), description: schema.description, }; }); @@ -737,11 +777,7 @@ function getOrCreateGoEnum( function goEnumConstSuffix(value: string): string { const suffix = splitGoIdentifierWords(value) - .map((word) => - goInitialisms.has(word.toLowerCase()) - ? word.toUpperCase() - : word.charAt(0).toUpperCase() + word.slice(1) - ) + .map((word) => goIdentifierWord(word)) .join(""); return suffix || "Value"; } @@ -1033,6 +1069,57 @@ function pushGoEncodingBlock(blockLines: string[], ctx: GoCodegenCtx): void { ctx.encoding.push(block); } +function registerGoExternalUnionUnmarshalers( + schema: JSONSchema7, + ctx: GoCodegenCtx, + externalSchemas?: Record +): void { + if (!externalSchemas) return; + + const externalRefs = collectExternalSchemaRefNames(schema); + for (const [schemaFile, refNames] of externalRefs) { + const externalSchema = externalSchemas[schemaFile]; + const externalImport = EXTERNAL_SCHEMA_GO_IMPORT[schemaFile]; + if (!externalSchema || !externalImport || externalImport.packageName !== ctx.packageName) continue; + + const externalDefinitions = collectDefinitionCollections(externalSchema as Record); + const definitions: Record = { + ...Object.fromEntries( + Object.entries(externalDefinitions.$defs ?? {}).filter(([, value]) => typeof value === "object" && value !== null) + ) as Record, + ...Object.fromEntries( + Object.entries(externalDefinitions.definitions ?? {}).filter(([, value]) => typeof value === "object" && value !== null) + ) as Record, + }; + const planningCtx: GoCodegenCtx = { + structs: [], + encoding: [], + enums: [], + enumsByName: new Map(), + discriminatedUnions: new Map(), + generatedNames: new Set(), + definitions: externalDefinitions, + wrapComments: ctx.wrapComments, + discriminatedUnionRawVariantSuffix: ctx.discriminatedUnionRawVariantSuffix, + packageName: ctx.packageName, + }; + + for (const refName of refNames) { + const definition = definitions[refName]; + if (!definition) continue; + + const typeName = goDefinitionName(refName); + const plan = planGoUnion(typeName, definition, planningCtx, true); + if (!plan || plan.kind === "flattenedObject" || plan.kind === "wrapper") continue; + + ctx.discriminatedUnions.set(typeName, { + typeName, + unmarshalFuncName: goUnexportedFunctionName("unmarshal", typeName), + }); + } + } +} + function pushGoStructUnmarshalJSON(lines: string[], typeName: string, fields: GoStructField[], ctx: GoCodegenCtx): void { const unionFields = fields .map((field) => ({ field, unionField: goDiscriminatedUnionField(field.goType, ctx) })) @@ -1134,13 +1221,12 @@ function emitGoStruct( const isReq = required.has(propName); const goName = toGoFieldName(propName); const goType = resolveGoPropertyType(prop, typeName, propName, isReq, ctx); - const omit = isReq ? "" : ",omitempty"; if (prop.description) { pushGoCommentForContext(lines, prop.description, ctx, "\t"); } pushGoFieldMarkers(lines, prop, goName, ctx); - const jsonTag = `json:"${propName}${omit}"`; + const jsonTag = goJSONTag(propName, isReq, goType); lines.push(`\t${goName} ${goType} \`${jsonTag}\``); fields.push({ propName, goName, goType, jsonTag }); } @@ -1647,6 +1733,36 @@ function goVariantMatchFunctionLines( return lines; } +function goDiscriminatorMethodName( + typeName: string, + discriminatorProp: string, + discGoName: string, + variants: GoDiscriminatedUnionVariant[], + ctx: GoCodegenCtx +): string { + const collidesWithVariantField = variants.some((variant) => { + const resolved = resolveSchema(variant.schema, ctx.definitions) ?? variant.schema; + const objectSchema = resolveObjectSchema(resolved, ctx.definitions) ?? resolved; + const variantPreExisting = ctx.generatedNames.has(variant.typeName); + return Object.keys(objectSchema.properties ?? {}).some((propName) => { + const propGoName = toGoFieldName(propName); + if (propName === discriminatorProp) { + // The flat-union variant emission elides single-value discriminators + // and renames multi-value ones to ``Discriminator``, so a natural-name + // collision is only possible when the variant struct is a pre-existing + // type (already in ``ctx.generatedNames``) that retained the discriminator + // as a struct field with its natural Go name. The ``Discriminator``-rename + // collision case is independent and detected by the second clause. + return (variantPreExisting && propGoName === discGoName) + || (variant.discriminatorValues.length > 1 && discGoName === "Discriminator"); + } + return propGoName === discGoName; + }); + }); + + return collidesWithVariantField ? `${toGoUnexportedIdentifier(typeName)}${discGoName}` : discGoName; +} + /** * Emit a Go interface for a discriminated union (anyOf with const discriminator). */ @@ -1664,7 +1780,7 @@ function emitGoFlatDiscriminatedUnion( const mapping = discriminator.mapping; const unionVariants = [...discriminator.variants].sort((left, right) => compareGoTypeNames(left.typeName, right.typeName)); const discGoName = toGoFieldName(discriminatorProp); - const discriminatorMethodName = discGoName; + const discriminatorMethodName = goDiscriminatorMethodName(typeName, discriminatorProp, discGoName, unionVariants, ctx); let discEnumName: string | undefined; let discGoType = "bool"; if (discriminator.valueKind === "string") { @@ -1684,7 +1800,7 @@ function emitGoFlatDiscriminatedUnion( const unmarshalFuncName = goUnexportedFunctionName("unmarshal", typeName); const rawDataName = `Raw${typeName}${ctx.discriminatedUnionRawVariantSuffix ?? "Data"}`; const hasRawVariant = discriminator.valueKind === "string"; - const markerName = `${typeName.charAt(0).toLowerCase()}${typeName.slice(1)}`; + const markerName = toGoUnexportedIdentifier(typeName); ctx.discriminatedUnions.set(typeName, { typeName, unmarshalFuncName }); const lines: string[] = []; @@ -1697,6 +1813,9 @@ function emitGoFlatDiscriminatedUnion( lines.push(`type ${typeName} interface {`); lines.push(`\t${markerName}()`); lines.push(`\t${discriminatorMethodName}() ${discGoType}`); + if (typeName === "PermissionRequest") { + lines.push(`\tRequiresManagedApproval() bool`); + } lines.push(`}`); lines.push(``); @@ -1824,12 +1943,11 @@ function emitGoFlatDiscriminatedUnion( } const goName = toGoFieldName(propName); const goType = resolveGoPropertyType(prop, variantTypeName, propName, required.has(propName), ctx); - const omit = required.has(propName) ? "" : ",omitempty"; if (prop.description) { pushGoCommentForContext(lines, prop.description, ctx, "\t"); } pushGoFieldMarkers(lines, prop, goName, ctx); - const jsonTag = `json:"${propName}${omit}"`; + const jsonTag = goJSONTag(propName, required.has(propName), goType); lines.push(`\t${goName} ${goType} \`${jsonTag}\``); fields.push({ propName, goName, goType, jsonTag }); } @@ -1883,7 +2001,7 @@ function emitGoRequiredFieldDiscriminatedUnion( const unionVariants = [...discriminator.variants].sort((left, right) => compareGoTypeNames(left.typeName, right.typeName)); const unmarshalFuncName = goUnexportedFunctionName("unmarshal", typeName); const rawDataName = `Raw${typeName}${ctx.discriminatedUnionRawVariantSuffix ?? "Data"}`; - const markerName = `${typeName.charAt(0).toLowerCase()}${typeName.slice(1)}`; + const markerName = toGoUnexportedIdentifier(typeName); ctx.discriminatedUnions.set(typeName, { typeName, unmarshalFuncName }); const lines: string[] = []; @@ -1951,12 +2069,11 @@ function emitGoRequiredFieldDiscriminatedUnion( const prop = propSchema as JSONSchema7; const goName = toGoFieldName(propName); const goType = resolveGoPropertyType(prop, variantTypeName, propName, required.has(propName), ctx); - const omit = required.has(propName) ? "" : ",omitempty"; if (prop.description) { pushGoCommentForContext(lines, prop.description, ctx, "\t"); } pushGoFieldMarkers(lines, prop, goName, ctx); - const jsonTag = `json:"${propName}${omit}"`; + const jsonTag = goJSONTag(propName, required.has(propName), goType); lines.push(`\t${goName} ${goType} \`${jsonTag}\``); fields.push({ propName, goName, goType, jsonTag }); } @@ -2264,7 +2381,6 @@ function emitGoFlattenedObjectUnion( const mergedSchema = mergeGoFlattenedPropertySchema(typeName, propName, info.schemas, ctx); const requiredInAll = info.requiredInAll && info.presentCount === objectVariants.length; const goType = resolveGoPropertyType(mergedSchema, typeName, propName, requiredInAll, ctx); - const omit = requiredInAll ? "" : ",omitempty"; const description = info.schemas.find((schema) => schema.description)?.description; if (description) { pushGoCommentForContext(lines, description, ctx, "\t"); @@ -2272,7 +2388,7 @@ function emitGoFlattenedObjectUnion( if (info.schemas.some((schema) => isSchemaDeprecated(schema))) { pushGoCommentForContext(lines, `Deprecated: ${goName} is deprecated.`, ctx, "\t"); } - const jsonTag = `json:"${propName}${omit}"`; + const jsonTag = goJSONTag(propName, requiredInAll, goType); lines.push(`\t${goName} ${goType} \`${jsonTag}\``); fields.push({ propName, goName, goType, jsonTag }); } @@ -2448,7 +2564,7 @@ function emitGoPrimitiveUnionInterface(typeName: string, schema: JSONSchema7, ct ctx.generatedNames.add(typeName); const unmarshalFuncName = goUnexportedFunctionName("unmarshal", typeName); - const markerName = `${typeName.charAt(0).toLowerCase()}${typeName.slice(1)}`; + const markerName = toGoUnexportedIdentifier(typeName); ctx.discriminatedUnions.set(typeName, { typeName, unmarshalFuncName }); const lines: string[] = []; @@ -2604,7 +2720,7 @@ function emitGoUntaggedUnionInterface(typeName: string, schema: JSONSchema7, ctx ctx.generatedNames.add(typeName); const unmarshalFuncName = goUnexportedFunctionName("unmarshal", typeName); - const markerName = `${typeName.charAt(0).toLowerCase()}${typeName.slice(1)}`; + const markerName = toGoUnexportedIdentifier(typeName); ctx.discriminatedUnions.set(typeName, { typeName, unmarshalFuncName }); const lines: string[] = []; @@ -2991,7 +3107,11 @@ function goDeclaredTypeName(code: string): string { /** * Generate the complete Go session-events file content. */ -export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: string): GoGeneratedTypeCode { +export function generateGoSessionEventsCode( + schema: JSONSchema7, + packageName: string, + externalSchemas?: Record +): GoGeneratedTypeCode { const variants = extractGoEventVariants(schema); const ctx: GoCodegenCtx = { structs: [], @@ -3005,6 +3125,7 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st discriminatedUnionRawVariantSuffix: "", packageName, }; + registerGoExternalUnionUnmarshalers(schema, ctx, externalSchemas); const envelopeProperties = getGoSharedEventEnvelopeProperties(schema, ctx); const sessionEventStructFields = [ ...envelopeProperties.map((property) => ({ @@ -3058,15 +3179,18 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st if (typeof propSchema !== "object") continue; const prop = propSchema as JSONSchema7; const isReq = required.has(propName); - const goName = toGoFieldName(propName); + let goName = toGoFieldName(propName); + // Avoid conflict with the Type() SessionEventType interface method + if (goName === "Type") { + goName = "Discriminator"; + } const goType = resolveGoPropertyType(prop, variant.dataClassName, propName, isReq, ctx); - const omit = isReq ? "" : ",omitempty"; if (prop.description) { pushGoCommentForContext(lines, prop.description, ctx, "\t"); } pushGoFieldMarkers(lines, prop, goName, ctx); - const jsonTag = `json:"${propName}${omit}"`; + const jsonTag = goJSONTag(propName, isReq, goType); lines.push(`\t${goName} ${goType} \`${jsonTag}\``); fields.push({ propName, goName, goType, jsonTag }); } @@ -3076,11 +3200,7 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st lines.push(``); const constName = "SessionEventType" + variant.typeName .split(/[._]/) - .map((w) => - goInitialisms.has(w.toLowerCase()) - ? w.toUpperCase() - : w.charAt(0).toUpperCase() + w.slice(1) - ) + .map((w) => goIdentifierWord(w)) .join(""); lines.push(`func (*${variant.dataClassName}) sessionEventData() {}`); lines.push(`func (*${variant.dataClassName}) Type() SessionEventType { return ${constName} }`); @@ -3098,11 +3218,7 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st .map((variant) => ({ constName: "SessionEventType" + variant.typeName .split(/[._]/) - .map((w) => - goInitialisms.has(w.toLowerCase()) - ? w.toUpperCase() - : w.charAt(0).toUpperCase() + w.slice(1) - ) + .map((w) => goIdentifierWord(w)) .join(""), typeName: variant.typeName, })) @@ -3169,11 +3285,7 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st .map((variant) => ({ constName: "SessionEventType" + variant.typeName .split(/[._]/) - .map((w) => - goInitialisms.has(w.toLowerCase()) - ? w.toUpperCase() - : w.charAt(0).toUpperCase() + w.slice(1) - ) + .map((w) => goIdentifierWord(w)) .join(""), dataClassName: variant.dataClassName, })) @@ -3285,30 +3397,35 @@ export function generateGoSessionEventsCode(schema: JSONSchema7, packageName: st const TYPE_ALIASES: Record = { PermissionRequestCommand: "PermissionRequestShellCommand", PossibleURL: "PermissionRequestShellPossibleURL", - Attachment: "UserMessageAttachment", - AttachmentType: "UserMessageAttachmentType", }; - const CONST_ALIASES: Record = { - AttachmentTypeFile: "UserMessageAttachmentTypeFile", - AttachmentTypeDirectory: "UserMessageAttachmentTypeDirectory", - AttachmentTypeSelection: "UserMessageAttachmentTypeSelection", - AttachmentTypeGithubReference: "UserMessageAttachmentTypeGithubReference", - AttachmentTypeBlob: "UserMessageAttachmentTypeBlob", - }; - out.push(`// Type aliases for convenience.`); - out.push(`type (`); - for (const [alias, target] of Object.entries(TYPE_ALIASES).sort(([left], [right]) => left.localeCompare(right))) { - out.push(`\t${alias} = ${target}`); + const CONST_ALIASES: Record = {}; + const generatedTypeNames = new Set(collectGoTopLevelNames(joinGoCode(out), "type")); + const generatedConstNames = new Set(collectGoTopLevelNames(joinGoCode(out), "const")); + const typeAliases = Object.entries(TYPE_ALIASES) + .filter(([alias, target]) => generatedTypeNames.has(target) && !generatedTypeNames.has(alias)) + .sort(([left], [right]) => left.localeCompare(right)); + const constAliases = Object.entries(CONST_ALIASES) + .filter(([alias, target]) => generatedConstNames.has(target) && !generatedConstNames.has(alias)) + .sort(([left], [right]) => left.localeCompare(right)); + if (typeAliases.length > 0) { + out.push(`// Type aliases for convenience.`); + out.push(`type (`); + for (const [alias, target] of typeAliases) { + out.push(`\t${alias} = ${target}`); + } + out.push(`)`); + out.push(``); } - out.push(`)`); - out.push(``); - out.push(`// Constant aliases for convenience.`); - out.push(`const (`); - for (const [alias, target] of Object.entries(CONST_ALIASES).sort(([left], [right]) => left.localeCompare(right))) { - out.push(`\t${alias} = ${target}`); + + if (constAliases.length > 0) { + out.push(`// Constant aliases for convenience.`); + out.push(`const (`); + for (const [alias, target] of constAliases) { + out.push(`\t${alias} = ${target}`); + } + out.push(`)`); + out.push(``); } - out.push(`)`); - out.push(``); const encodingOut: string[] = [...sessionEncoding]; if (encodingOut.length > 0) encodingOut.push(""); @@ -3424,6 +3541,20 @@ function collectGoSharedSessionEventAliasNames( for (const value of values ?? []) { constNames.add(`${typeName}${goEnumConstSuffix(value)}`); } + + // Detect anyOf unions with a string-const discriminator property. The + // api/rpc generator synthesizes an enum (named ``) + // and per-variant consts for these (e.g. `Attachment` → `AttachmentType` + // + `AttachmentTypeFile`, ...). They aren't top-level $defs, so we have + // to surface them explicitly here so the public `copilot` alias file + // re-exports them alongside the union and its variant structs. + const synthesized = collectGoSharedAnyOfDiscriminatorAliasNames(typeName, schema, definitions); + if (synthesized) { + typeNames.add(synthesized.enumName); + for (const constName of synthesized.constNames) { + constNames.add(constName); + } + } } return { @@ -3432,6 +3563,107 @@ function collectGoSharedSessionEventAliasNames( }; } +/** + * For a shared definition that is an `anyOf` discriminated union with a + * string-const discriminator property (e.g. `Attachment` with `type: "file" | + * "directory" | ...`), return the synthesized Go discriminator enum name and + * per-variant const names that the api/rpc generator emits via + * `emitGoFlatDiscriminatedUnion`. Returns `undefined` when the definition does + * not match the const-discriminator pattern. + */ +function collectGoSharedAnyOfDiscriminatorAliasNames( + unionTypeName: string, + schema: JSONSchema7, + definitions: Record +): { enumName: string; constNames: string[] } | undefined { + const variants = Array.isArray(schema.anyOf) ? schema.anyOf : undefined; + if (!variants || variants.length === 0) return undefined; + + const resolvedVariants: JSONSchema7[] = []; + for (const variant of variants) { + const resolved = resolveSharedAnyOfVariant(variant, definitions); + if (!resolved || !resolved.properties) return undefined; + resolvedVariants.push(resolved); + } + + const firstVariant = resolvedVariants[0]; + for (const [propName, propSchemaRaw] of Object.entries(firstVariant.properties!)) { + if (typeof propSchemaRaw !== "object" || propSchemaRaw === null) continue; + const firstPropSchema = propSchemaRaw as JSONSchema7; + if (typeof firstPropSchema.const !== "string") continue; + + const collectedValues: string[] = []; + let valid = true; + for (const variant of resolvedVariants) { + if (!(variant.required || []).includes(propName)) { valid = false; break; } + const variantProp = variant.properties?.[propName]; + if (typeof variantProp !== "object" || variantProp === null) { valid = false; break; } + const variantConst = (variantProp as JSONSchema7).const; + if (typeof variantConst !== "string") { valid = false; break; } + collectedValues.push(variantConst); + } + if (!valid || collectedValues.length === 0) continue; + + const enumName = `${unionTypeName}${toGoFieldName(propName)}`; + const constNames = [...new Set(collectedValues)].map( + (value) => `${enumName}${goEnumConstSuffix(value)}` + ); + return { enumName, constNames }; + } + return undefined; +} + +function resolveSharedAnyOfVariant( + variant: JSONSchema7 | boolean, + definitions: Record +): JSONSchema7 | undefined { + if (typeof variant !== "object" || variant === null) return undefined; + if (typeof variant.$ref === "string") { + // Local $ref like "#/$defs/AttachmentFile" or "#/definitions/AttachmentFile". + const localMatch = /^#\/(?:\$defs|definitions)\/(.+)$/.exec(variant.$ref); + if (!localMatch) return undefined; + const target = definitions[decodeURIComponent(localMatch[1])]; + if (!target || typeof target !== "object" || Array.isArray(target)) return undefined; + return target as JSONSchema7; + } + return variant; +} + +/** + * Scan hand-written `.go` files under `go/` and return every top-level exported + * type or const name they declare. We use this to exclude those names from the + * session-events alias file: when a schema-shared definition (e.g. `ContextTier`) + * collides with a hand-written declaration of the same name in the public + * `copilot` package, the hand-written declaration must win — emitting an alias + * would produce a duplicate package-scope identifier and fail `go build`. + * + * Generated files use the `z*.go` naming convention; we skip them so that this + * scanner never reads (or depends on the output of) its own emit. Test files + * are scanned too because they share the package namespace, so a hand-written + * test-only declaration would also collide with an alias of the same name. + */ +async function collectHandWrittenGoPublicNames(): Promise> { + const goDir = path.join(REPO_ROOT, "go"); + const names = new Set(); + let entries: string[]; + try { + entries = await fs.readdir(goDir); + } catch { + return names; + } + for (const entry of entries) { + if (!entry.endsWith(".go")) continue; + if (entry.startsWith("z")) continue; + const filePath = path.join(goDir, entry); + const stat = await fs.stat(filePath); + if (!stat.isFile()) continue; + const content = await fs.readFile(filePath, "utf-8"); + for (const name of collectGoTopLevelNames(content, "type")) names.add(name); + for (const name of collectGoTopLevelNames(content, "const")) names.add(name); + } + return names; +} + function assertNoGoRpcSessionEventConflicts(rpcGeneratedTypeCode: string): void { const duplicateTypes = collectGoTopLevelNames(rpcGeneratedTypeCode, "type") .filter((name) => rpcSessionEventTopLevelNames.types.has(name)); @@ -3451,19 +3683,28 @@ async function generateSessionEvents(schemaPath?: string, apiSchema?: ApiSchema) console.log("Go: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as JSONSchema7); + const schema = addManagedApprovalRequiredToPermissionRequests( + (await loadSchemaJson(resolvedPath)) as JSONSchema7 + ); const processed = propagateInternalVisibility(postProcessSchema(schema)); - const sharedDefinitions = apiSchema + const processedApiSchema = apiSchema + ? propagateInternalVisibility(postProcessSchema(cloneSchemaForCodegen(apiSchema as JSONSchema7)) as JSONSchema7) + : undefined; + const sharedDefinitions = processedApiSchema ? findSharedSchemaDefinitions( processed as unknown as Record, - postProcessSchema(cloneSchemaForCodegen(apiSchema as JSONSchema7)) as unknown as Record + processedApiSchema as unknown as Record ) : new Set(); const reachableDefinitions = collectReachableDefinitionNames(processed as unknown as Record); const sharedSessionEventDefinitions = new Set([...sharedDefinitions].filter((name) => reachableDefinitions.has(name))); const sessionSchema = rewriteSharedDefinitionReferences(processed, sharedDefinitions, "api.schema.json", true); - const generatedSessionCode = generateGoSessionEventsCode(sessionSchema, "rpc"); + const generatedSessionCode = generateGoSessionEventsCode( + sessionSchema, + "rpc", + processedApiSchema ? { "api.schema.json": processedApiSchema } : undefined + ); let generatedTypeCode = stripTrailingGoWhitespace(generatedSessionCode.typeCode); // Annotate internal session-event types (driven by the JSON Schema definition's // `visibility: "internal"` flag). Matches what the RPC generator does below; @@ -3518,9 +3759,19 @@ async function generateSessionEvents(schemaPath?: string, apiSchema?: ApiSchema) } } } + // Names of public type/const declarations that already exist in hand-written + // Go files under `go/`. We must not re-export schema-generated names that + // collide with these, because Go disallows two top-level identifiers with + // the same name in a single package (`copilot`). The hand-written + // declaration always wins. Without this filter, schema-shared definitions + // like `ContextTier` (defined as a shared schema definition and emitted in + // the rpc package) would generate `copilot.ContextTier = rpc.ContextTier` + // aliases that clash with the existing hand-written `copilot.ContextTier`. + const handWrittenPublicNames = await collectHandWrittenGoPublicNames(); + const aliasExcludes = new Set([...internalTypesInSession, ...handWrittenPublicNames]); const aliasOutPath = await writeGeneratedFile( "go/zsession_events.go", - generateGoSessionEventAliasFile(generatedTypeCode, sharedAliasNames.typeNames, sharedAliasNames.constNames, internalTypesInSession) + generateGoSessionEventAliasFile(generatedTypeCode, sharedAliasNames.typeNames, sharedAliasNames.constNames, aliasExcludes) ); console.log(` ✓ ${aliasOutPath}`); @@ -3534,12 +3785,13 @@ async function generateRpc(schemaPath?: string): Promise { console.log("Go: generating RPC types..."); const resolvedPath = schemaPath ?? (await getApiSchemaPath()); - const schema = propagateInternalVisibility(fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as ApiSchema)) as JSONSchema7) as unknown as ApiSchema; + const schema = propagateInternalVisibility(fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as ApiSchema)) as JSONSchema7) as unknown as ApiSchema; const allMethods = [ ...collectRpcMethods(schema.server || {}), ...collectRpcMethods(schema.session || {}), ...collectRpcMethods(schema.clientSession || {}), + ...collectRpcMethods(schema.clientGlobal || {}), ].sort((left, right) => left.rpcMethod.localeCompare(right.rpcMethod)); // Build a combined definition map, including shared API definitions plus @@ -3708,7 +3960,7 @@ async function generateRpc(schemaPath?: string): Promise { if (generatedTypeCode.includes("time.Time")) { imports.push(`"time"`); } - if (schema.clientSession) { + if (schema.clientSession || schema.clientGlobal) { imports.push(`"errors"`, `"fmt"`); } imports.push(`"github.com/github/copilot-sdk/go/internal/jsonrpc2"`); @@ -3743,6 +3995,10 @@ async function generateRpc(schemaPath?: string): Promise { emitClientSessionApiRegistration(lines, schema.clientSession, resolveType, generatedRpcCode.discriminatedUnions); } + if (schema.clientGlobal) { + emitClientGlobalApiRegistration(lines, schema.clientGlobal, resolveType, generatedRpcCode.discriminatedUnions); + } + const outPath = await writeGeneratedFile("go/rpc/zrpc.go", wrapGeneratedGoComments(lines.join("\n"))); console.log(` ✓ ${outPath}`); @@ -3784,15 +4040,15 @@ function emitApiGroup( } for (const [subGroupName, subGroupNode] of subGroups) { - const subApiName = apiName.replace(/Api$/, "") + toPascalCase(subGroupName) + "Api"; + const subApiName = apiName.replace(/API$/, "") + toGoFieldName(subGroupName) + "API"; const subGroupExperimental = isNodeFullyExperimental(subGroupNode as Record); const subGroupDeprecated = isNodeFullyDeprecated(subGroupNode as Record); emitApiGroup(lines, subApiName, subGroupNode as Record, isSession, serviceName, resolveType, fields, unionInfos, subGroupExperimental, subGroupDeprecated); if (subGroupExperimental) { - pushGoExperimentalSubApiComment(lines, toPascalCase(subGroupName)); + pushGoExperimentalSubApiComment(lines, toGoFieldName(subGroupName)); } - lines.push(`func (s *${apiName}) ${toPascalCase(subGroupName)}() *${subApiName} {`); + lines.push(`func (s *${apiName}) ${toGoFieldName(subGroupName)}() *${subApiName} {`); lines.push(`\treturn (*${subApiName})(s)`); lines.push(`}`); lines.push(``); @@ -3803,13 +4059,13 @@ function emitRpcWrapper(lines: string[], node: Record, isSessio const groups = sortByPascalName(Object.entries(node).filter(([, v]) => typeof v === "object" && v !== null && !isRpcMethod(v))); const topLevelMethods = sortByPascalName(Object.entries(node).filter(([, v]) => isRpcMethod(v))); - const wrapperName = classPrefix + (isSession ? "SessionRpc" : "ServerRpc"); - const apiSuffix = "Api"; + const wrapperName = classPrefix + (isSession ? "SessionRPC" : "ServerRPC"); + const apiSuffix = "API"; // Lowercase the prefix so the unexported service struct stays unexported in Go. const prefixLower = classPrefix ? classPrefix.charAt(0).toLowerCase() + classPrefix.slice(1) : ""; const serviceName = prefixLower - ? prefixLower + (isSession ? "SessionApi" : "ServerApi") - : (isSession ? "sessionApi" : "serverApi"); + ? prefixLower + (isSession ? "SessionAPI" : "ServerAPI") + : (isSession ? "sessionAPI" : "serverAPI"); // Emit the common service struct (unexported, shared by all API groups via type cast) lines.push(`type ${serviceName} struct {`); @@ -3821,14 +4077,14 @@ function emitRpcWrapper(lines: string[], node: Record, isSessio // Emit API types for groups for (const [groupName, groupNode] of groups) { const prefix = classPrefix + (isSession ? "" : "Server"); - const apiName = prefix + toPascalCase(groupName) + apiSuffix; + const apiName = prefix + toGoFieldName(groupName) + apiSuffix; const groupExperimental = isNodeFullyExperimental(groupNode as Record); const groupDeprecated = isNodeFullyDeprecated(groupNode as Record); emitApiGroup(lines, apiName, groupNode as Record, isSession, serviceName, resolveType, fields, unionInfos, groupExperimental, groupDeprecated); } // Compute field name lengths for gofmt-compatible column alignment - const groupPascalNames = groups.map(([g]) => toPascalCase(g)); + const groupPascalNames = groups.map(([g]) => toGoFieldName(g)); const allFieldNames = ["common", ...groupPascalNames]; const maxFieldLen = Math.max(...allFieldNames.map((n) => n.length)); const pad = (name: string) => name.padEnd(maxFieldLen); @@ -3846,7 +4102,7 @@ function emitRpcWrapper(lines: string[], node: Record, isSessio lines.push(``); for (const [groupName] of groups) { const prefix = classPrefix + (isSession ? "" : "Server"); - lines.push(`\t${pad(toPascalCase(groupName))} *${prefix}${toPascalCase(groupName)}${apiSuffix}`); + lines.push(`\t${pad(toGoFieldName(groupName))} *${prefix}${toGoFieldName(groupName)}${apiSuffix}`); } lines.push(`}`); lines.push(``); @@ -3868,7 +4124,7 @@ function emitRpcWrapper(lines: string[], node: Record, isSessio } for (const [groupName] of groups) { const prefix = classPrefix + (isSession ? "" : "Server"); - lines.push(`\tr.${toPascalCase(groupName)} = (*${prefix}${toPascalCase(groupName)}${apiSuffix})(&r.common)`); + lines.push(`\tr.${toGoFieldName(groupName)} = (*${prefix}${toGoFieldName(groupName)}${apiSuffix})(&r.common)`); } lines.push(`\treturn r`); lines.push(`}`); @@ -3951,10 +4207,10 @@ function emitMethod(lines: string[], receiver: string, name: string, method: Rpc } lines.push(`\t}`); } - lines.push(`\traw, err := ${clientRef}.Request("${method.rpcMethod}", req)`); + lines.push(`\traw, err := ${clientRef}.Request(ctx, "${method.rpcMethod}", req)`); } else { const arg = hasParams ? paramsRef : "nil"; - lines.push(`\traw, err := ${clientRef}.Request("${method.rpcMethod}", ${arg})`); + lines.push(`\traw, err := ${clientRef}.Request(ctx, "${method.rpcMethod}", ${arg})`); } lines.push(`\tif err != nil {`); @@ -3998,7 +4254,7 @@ function collectClientGroups(node: Record): ClientGroup[] { } function clientHandlerInterfaceName(groupName: string): string { - return `${toPascalCase(groupName)}Handler`; + return `${toGoFieldName(groupName)}Handler`; } function clientHandlerMethodName(rpcMethod: string): string { @@ -4053,10 +4309,10 @@ function emitClientSessionApiRegistration(lines: string[], clientSchema: Record< lines.push(``); } - lines.push(`// ClientSessionApiHandlers provides all client session API handler groups for a session.`); - lines.push(`type ClientSessionApiHandlers struct {`); + lines.push(`// ClientSessionAPIHandlers provides all client session API handler groups for a session.`); + lines.push(`type ClientSessionAPIHandlers struct {`); for (const { groupName } of groups) { - lines.push(`\t${toPascalCase(groupName)} ${clientHandlerInterfaceName(groupName)}`); + lines.push(`\t${toGoFieldName(groupName)} ${clientHandlerInterfaceName(groupName)}`); } lines.push(`}`); lines.push(``); @@ -4073,10 +4329,10 @@ function emitClientSessionApiRegistration(lines: string[], clientSchema: Record< lines.push(`}`); lines.push(``); - lines.push(`// RegisterClientSessionApiHandlers registers handlers for server-to-client session API calls.`); - lines.push(`func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionApiHandlers) {`); + lines.push(`// RegisterClientSessionAPIHandlers registers handlers for server-to-client session API calls.`); + lines.push(`func RegisterClientSessionAPIHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionAPIHandlers) {`); for (const { groupName, methods } of groups) { - const handlerField = toPascalCase(groupName); + const handlerField = toGoFieldName(groupName); for (const method of methods) { const paramsType = resolveType(goParamsTypeName(method)); lines.push(`\tclient.SetRequestHandler("${method.rpcMethod}", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {`); @@ -4104,13 +4360,136 @@ function emitClientSessionApiRegistration(lines: string[], clientSchema: Record< lines.push(``); } -// ── Main ──────────────────────────────────────────────────────────────────── +function emitClientGlobalApiRegistration(lines: string[], clientSchema: Record, resolveType: (name: string) => string, unionInfos: Map): void { + const groups = collectClientGroups(clientSchema); + + for (const { groupName, groupNode, methods } of groups) { + const interfaceName = clientHandlerInterfaceName(groupName); + const groupExperimental = isNodeFullyExperimental(groupNode); + const groupDeprecated = isNodeFullyDeprecated(groupNode); + if (groupDeprecated) { + pushGoComment(lines, `Deprecated: ${interfaceName} contains deprecated APIs that will be removed in a future version.`); + } + if (groupExperimental) { + pushGoExperimentalApiComment(lines, interfaceName); + } + lines.push(`type ${interfaceName} interface {`); + for (const method of methods) { + const resultSchema = getMethodResultSchema(method); + pushGoRpcMethodComment( + lines, + clientHandlerMethodName(method.rpcMethod), + method, + resultSchema, + goRpcParamsDescription(method, getMethodParamsSchema(method)), + "\t", + "handles" + ); + if (method.deprecated && !groupDeprecated) { + pushGoComment(lines, `Deprecated: ${clientHandlerMethodName(method.rpcMethod)} is deprecated and will be removed in a future version.`, "\t"); + } + if (method.stability === "experimental" && !groupExperimental) { + pushGoExperimentalMethodComment(lines, clientHandlerMethodName(method.rpcMethod), "\t"); + } + const paramsType = resolveType(goParamsTypeName(method)); + if (method.notification) { + // Notification methods carry no response; the handler returns only an error. + lines.push(`\t${clientHandlerMethodName(method.rpcMethod)}(request *${paramsType}) error`); + continue; + } + const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined; + let returnType: string; + if (isOpaqueJson(resultSchema)) { + returnType = "any"; + } else { + const resultType = nullableInner + ? resolveType(goNullableResultTypeName(method, nullableInner)) + : resolveType(goResultTypeName(method)); + returnType = unionInfos.has(resultType) ? resultType : `*${resultType}`; + } + lines.push(`\t${clientHandlerMethodName(method.rpcMethod)}(request *${paramsType}) (${returnType}, error)`); + } + lines.push(`}`); + lines.push(``); + } + + lines.push(`// ClientGlobalAPIHandlers provides all client-global API handler groups.`); + lines.push(`//`); + lines.push(`// Unlike client-session handlers these carry no implicit session id dispatch`); + lines.push(`// key; a single set of handlers serves the entire connection.`); + lines.push(`type ClientGlobalAPIHandlers struct {`); + for (const { groupName } of groups) { + lines.push(`\t${toGoFieldName(groupName)} ${clientHandlerInterfaceName(groupName)}`); + } + lines.push(`}`); + lines.push(``); + + lines.push(`func clientGlobalHandlerError(err error) *jsonrpc2.Error {`); + lines.push(`\tif err == nil {`); + lines.push(`\t\treturn nil`); + lines.push(`\t}`); + lines.push(`\tvar rpcErr *jsonrpc2.Error`); + lines.push(`\tif errors.As(err, &rpcErr) {`); + lines.push(`\t\treturn rpcErr`); + lines.push(`\t}`); + lines.push(`\treturn &jsonrpc2.Error{Code: -32603, Message: err.Error()}`); + lines.push(`}`); + lines.push(``); + + lines.push(`// RegisterClientGlobalAPIHandlers registers handlers for server-to-client client-global API calls.`); + lines.push(`func RegisterClientGlobalAPIHandlers(client *jsonrpc2.Client, handlers *ClientGlobalAPIHandlers) {`); + for (const { groupName, methods } of groups) { + const handlerField = toGoFieldName(groupName); + for (const method of methods) { + const paramsType = resolveType(goParamsTypeName(method)); + if (method.notification) { + // Notification methods carry no response: return a nil result so the + // transport emits no JSON-RPC reply. Go's jsonrpc2 dispatches both + // requests and id-less notifications to SetRequestHandler by method name. + lines.push(`\tclient.SetRequestHandler("${method.rpcMethod}", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {`); + lines.push(`\t\tvar request ${paramsType}`); + lines.push(`\t\tif err := json.Unmarshal(params, &request); err != nil {`); + lines.push(`\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)}`); + lines.push(`\t\t}`); + lines.push(`\t\tif handlers == nil || handlers.${handlerField} == nil {`); + lines.push(`\t\t\treturn nil, nil`); + lines.push(`\t\t}`); + lines.push(`\t\tif err := handlers.${handlerField}.${clientHandlerMethodName(method.rpcMethod)}(&request); err != nil {`); + lines.push(`\t\t\treturn nil, clientGlobalHandlerError(err)`); + lines.push(`\t\t}`); + lines.push(`\t\treturn nil, nil`); + lines.push(`\t})`); + continue; + } + lines.push(`\tclient.SetRequestHandler("${method.rpcMethod}", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {`); + lines.push(`\t\tvar request ${paramsType}`); + lines.push(`\t\tif err := json.Unmarshal(params, &request); err != nil {`); + lines.push(`\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)}`); + lines.push(`\t\t}`); + lines.push(`\t\tif handlers == nil || handlers.${handlerField} == nil {`); + lines.push(`\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: "No ${groupName} client-global handler registered"}`); + lines.push(`\t\t}`); + lines.push(`\t\tresult, err := handlers.${handlerField}.${clientHandlerMethodName(method.rpcMethod)}(&request)`); + lines.push(`\t\tif err != nil {`); + lines.push(`\t\t\treturn nil, clientGlobalHandlerError(err)`); + lines.push(`\t\t}`); + lines.push(`\t\traw, err := json.Marshal(result)`); + lines.push(`\t\tif err != nil {`); + lines.push(`\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf("Failed to marshal response: %v", err)}`); + lines.push(`\t\t}`); + lines.push(`\t\treturn raw, nil`); + lines.push(`\t})`); + } + } + lines.push(`}`); + lines.push(``); +} async function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise { let apiSchemaForSharing: ApiSchema | undefined; try { const resolvedApiPath = apiSchemaPath ?? (await getApiSchemaPath()); - apiSchemaForSharing = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedApiPath, "utf-8")) as ApiSchema)); + apiSchemaForSharing = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedApiPath)) as ApiSchema)); } catch (err) { if ((err as NodeJS.ErrnoException).code !== "ENOENT" || apiSchemaPath) { throw err; diff --git a/scripts/codegen/package-lock.json b/scripts/codegen/package-lock.json index b173ddec8..5ed410e94 100644 --- a/scripts/codegen/package-lock.json +++ b/scripts/codegen/package-lock.json @@ -9,7 +9,7 @@ "json-schema": "^0.4.0", "json-schema-to-typescript": "^15.0.4", "quicktype-core": "^23.2.6", - "tsx": "^4.20.6", + "tsx": "^4.22.4", "wordwrap": "^1.0.0" } }, @@ -31,9 +31,9 @@ } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", - "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -47,9 +47,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", - "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -63,9 +63,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", - "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -79,9 +79,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", - "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -95,9 +95,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", - "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -111,9 +111,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", - "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -127,9 +127,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", - "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -143,9 +143,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", - "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -159,9 +159,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", - "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -175,9 +175,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", - "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -191,9 +191,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", - "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -207,9 +207,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", - "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -223,9 +223,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", - "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -239,9 +239,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", - "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -255,9 +255,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", - "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -271,9 +271,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", - "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -287,9 +287,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", - "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -303,9 +303,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", - "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -319,9 +319,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", - "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -335,9 +335,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", - "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -351,9 +351,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", - "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -367,9 +367,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", - "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -383,9 +383,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", - "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -399,9 +399,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", - "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -415,9 +415,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", - "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -431,9 +431,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", - "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -554,9 +554,9 @@ } }, "node_modules/esbuild": { - "version": "0.27.3", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", - "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "hasInstallScript": true, "license": "MIT", "bin": { @@ -566,32 +566,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.3", - "@esbuild/android-arm": "0.27.3", - "@esbuild/android-arm64": "0.27.3", - "@esbuild/android-x64": "0.27.3", - "@esbuild/darwin-arm64": "0.27.3", - "@esbuild/darwin-x64": "0.27.3", - "@esbuild/freebsd-arm64": "0.27.3", - "@esbuild/freebsd-x64": "0.27.3", - "@esbuild/linux-arm": "0.27.3", - "@esbuild/linux-arm64": "0.27.3", - "@esbuild/linux-ia32": "0.27.3", - "@esbuild/linux-loong64": "0.27.3", - "@esbuild/linux-mips64el": "0.27.3", - "@esbuild/linux-ppc64": "0.27.3", - "@esbuild/linux-riscv64": "0.27.3", - "@esbuild/linux-s390x": "0.27.3", - "@esbuild/linux-x64": "0.27.3", - "@esbuild/netbsd-arm64": "0.27.3", - "@esbuild/netbsd-x64": "0.27.3", - "@esbuild/openbsd-arm64": "0.27.3", - "@esbuild/openbsd-x64": "0.27.3", - "@esbuild/openharmony-arm64": "0.27.3", - "@esbuild/sunos-x64": "0.27.3", - "@esbuild/win32-arm64": "0.27.3", - "@esbuild/win32-ia32": "0.27.3", - "@esbuild/win32-x64": "0.27.3" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/event-target-shim": { @@ -643,18 +643,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-tsconfig": { - "version": "4.13.6", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.6.tgz", - "integrity": "sha512-shZT/QMiSHc/YBLxxOkMtgSid5HFoauqCE3/exfsEcwg1WkeqjG+V40yBbBrsD+jW2HDXcs28xOfcbm2jI8Ddw==", - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, "node_modules/ieee754": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", @@ -709,9 +697,19 @@ "license": "BSD-3-Clause" }, "node_modules/js-yaml": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", - "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz", + "integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/nodeca" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1" @@ -873,15 +871,6 @@ "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", @@ -940,13 +929,12 @@ "license": "MIT" }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" diff --git a/scripts/codegen/package.json b/scripts/codegen/package.json index c942b1c93..8e6535291 100644 --- a/scripts/codegen/package.json +++ b/scripts/codegen/package.json @@ -14,7 +14,7 @@ "json-schema": "^0.4.0", "json-schema-to-typescript": "^15.0.4", "quicktype-core": "^23.2.6", - "tsx": "^4.20.6", + "tsx": "^4.22.4", "wordwrap": "^1.0.0" } } diff --git a/scripts/codegen/python.ts b/scripts/codegen/python.ts index 94b9537c1..978021a98 100644 --- a/scripts/codegen/python.ts +++ b/scripts/codegen/python.ts @@ -11,6 +11,7 @@ import path from "path"; import type { JSONSchema7, JSONSchema7Definition } from "json-schema"; import { fileURLToPath } from "url"; import { + addManagedApprovalRequiredToPermissionRequests, cloneSchemaForCodegen, filterNodeByVisibility, fixNullableRequiredRefsInApiSchema, @@ -50,6 +51,8 @@ import { getSessionEventVariantSchemas, getSharedSessionEventEnvelopeProperties, getEnumValueDescriptions, + loadSchemaJson, + fixBrandCasing, type ApiSchema, type DefinitionCollections, type EnumValueDescriptions, @@ -270,6 +273,39 @@ function postProcessExternalUnionAliasesForPython(code: string, aliases: Map; + dispatch: Array<{ value: PyDiscriminatorValue; typeName: string }>; } function postProcessRefBasedDiscriminatedUnionsForPython( code: string, @@ -302,7 +338,7 @@ function postProcessRefBasedDiscriminatedUnionsForPython( aliasName: string; variantNames: string[]; discriminatorProp: string; - dispatch: Array<{ value: string; typeName: string }>; + dispatch: Array<{ value: PyDiscriminatorValue; typeName: string }>; description: string | undefined; } const unions: UnionInfo[] = []; @@ -332,7 +368,7 @@ function postProcessRefBasedDiscriminatedUnionsForPython( discriminator.property ]; return { - value: String(discProp.const), + value: pyDiscriminatorValue(discProp.const), typeName: toPascalCase(variantRefNames[i]), }; }); @@ -385,7 +421,7 @@ function postProcessRefBasedDiscriminatedUnionsForPython( for (const union of unions) { const actualAliasName = resolveActualName(union.aliasName); const actualVariantNames: string[] = []; - const actualDispatch: Array<{ value: string; typeName: string }> = []; + const actualDispatch: Array<{ value: PyDiscriminatorValue; typeName: string }> = []; let allResolved = true; for (let i = 0; i < union.variantNames.length; i++) { const actual = resolveActualName(union.variantNames[i]); @@ -448,7 +484,7 @@ function postProcessRefBasedDiscriminatedUnionsForPython( dispatcherLines.push(` kind = obj.get(${JSON.stringify(union.discriminatorProp)})`); dispatcherLines.push(` match kind:`); for (const m of actualDispatch) { - dispatcherLines.push(` case ${JSON.stringify(m.value)}: return ${m.typeName}.from_dict(obj)`); + dispatcherLines.push(` case ${pyDiscriminatorValueExpr(m.value)}: return ${m.typeName}.from_dict(obj)`); } dispatcherLines.push( ` case _: raise ValueError(f"Unknown ${actualAliasName} ${union.discriminatorProp}: {kind!r}")` @@ -498,7 +534,7 @@ function postProcessDiscriminatorDefaultsForPython( unions: ResolvedRefBasedUnion[] ): string { // Build variant lookup: variant class name → { prop, value }. - const variantInfo = new Map(); + const variantInfo = new Map(); for (const union of unions) { for (const d of union.dispatch) { // First-wins; multiple unions referencing the same variant share a @@ -569,9 +605,9 @@ function postProcessDiscriminatorDefaultsForPython( continue; } const fieldIndent = (block[fieldIdx].match(/^(\s+)/) ?? ["", ""])[1]; - const literal = JSON.stringify(info.value); + const literal = pyDiscriminatorValueExpr(info.value); // Replace the field with a class-level constant. - block[fieldIdx] = `${fieldIndent}${info.prop}: ClassVar[str] = ${literal}`; + block[fieldIdx] = `${fieldIndent}${info.prop}: ClassVar[${pyDiscriminatorValueType(info.value)}] = ${literal}`; usedClassVar = true; // Drop any field-trailing docstring lines that immediately followed the @@ -893,6 +929,95 @@ function collapsePlaceholderPythonDataclasses(code: string, knownDefinitionNames return code.replace(/\n{3,}/g, "\n\n"); } +function removeUnusedSyntheticPythonDataclasses(code: string, knownDefinitionNames: Set): string { + interface DataclassBlock { + name: string; + text: string; + start: number; + end: number; + synthetic: boolean; + } + + const classBlockRe = + /((?:^# (?:Experimental|Deprecated|Internal):[^\n]*\r?\n)*@dataclass(?:\([^\r\n]*\))?\r?\nclass\s+(\w+):[\s\S]*?)(?=^(?:# (?:Experimental|Deprecated|Internal):[^\n]*\r?\n)*@dataclass(?:\([^\r\n]*\))?\r?\nclass\s+\w|^class\s+\w|^def\s+\w|^[A-Z]\w+\s*=|\Z)/gm; + const blocks: DataclassBlock[] = [...code.matchAll(classBlockRe)].map((match) => ({ + name: match[2], + text: match[1], + start: match.index ?? 0, + end: (match.index ?? 0) + match[1].length, + synthetic: !knownDefinitionNames.has(match[2].toLowerCase()), + })); + const syntheticBlocks = blocks.filter((block) => block.synthetic); + if (syntheticBlocks.length === 0) return code; + + let outsideSyntheticBlocks = ""; + let cursor = 0; + for (const block of syntheticBlocks) { + outsideSyntheticBlocks += code.slice(cursor, block.start); + cursor = block.end; + } + outsideSyntheticBlocks += code.slice(cursor); + + const syntheticNames = new Set(syntheticBlocks.map((block) => block.name)); + const dependencies = new Map>(); + const live = new Set(); + + for (const block of syntheticBlocks) { + const referenceRe = new RegExp(`\\b${escapeRegExp(block.name)}\\b`); + if (referenceRe.test(outsideSyntheticBlocks)) { + live.add(block.name); + } + + const blockDependencies = new Set(); + for (const dependency of syntheticNames) { + if (dependency === block.name) continue; + const dependencyRe = new RegExp(`\\b${escapeRegExp(dependency)}\\b`); + if (dependencyRe.test(block.text)) { + blockDependencies.add(dependency); + } + } + dependencies.set(block.name, blockDependencies); + } + + const worklist = [...live]; + while (worklist.length > 0) { + const name = worklist.pop()!; + for (const dependency of dependencies.get(name) ?? []) { + if (live.has(dependency)) continue; + live.add(dependency); + worklist.push(dependency); + } + } + + const blocksToRemove = new Set(syntheticBlocks.filter((block) => !live.has(block.name)).map((block) => block.name)); + if (blocksToRemove.size === 0) return code; + + const appendSegment = (parts: string[], segment: string): void => { + if (parts.length === 0 || segment.length === 0) { + parts.push(segment); + return; + } + const previous = parts[parts.length - 1]; + const trailingNewlines = previous.match(/\n+$/)?.[0].length ?? 0; + const leadingNewlines = segment.match(/^\n+/)?.[0].length ?? 0; + if (trailingNewlines + leadingNewlines > 2) { + segment = "\n".repeat(Math.max(0, 2 - trailingNewlines)) + segment.slice(leadingNewlines); + } + parts.push(segment); + }; + + const parts: string[] = []; + cursor = 0; + for (const block of blocks) { + if (!blocksToRemove.has(block.name)) continue; + appendSegment(parts, code.slice(cursor, block.start)); + cursor = block.end; + } + appendSegment(parts, code.slice(cursor)); + + return parts.join(""); +} + /** * Reorder Python class/enum definitions so forward references are resolved. * Quicktype may emit classes in an order where a class references another @@ -1133,11 +1258,160 @@ function toPyFieldName(propName: string, propSchema: JSONSchema7, ctx: PyCodegen return toSnakeCase(isPyDurationProperty(propSchema, ctx) ? stripDurationMillisecondsSuffix(propName) : propName); } +function escapeRegExp(value: string): string { + return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); +} + +function removeRequiredAnyDefaultsForPython( + code: string, + definitions: Record, + definitionCollections: DefinitionCollections +): string { + const requiredFieldsByClass = new Map>(); + + for (const [definitionName, schema] of Object.entries(definitions)) { + const resolved = resolveObjectSchema(schema, definitionCollections) ?? resolveSchema(schema, definitionCollections); + if (!resolved || !isObjectSchema(resolved) || !resolved.properties || !Array.isArray(resolved.required)) { + continue; + } + + const requiredFields = resolved.required.map(toSnakeCase); + for (const className of new Set([definitionName, toPascalCase(definitionName)])) { + const fields = requiredFieldsByClass.get(className) ?? new Set(); + for (const field of requiredFields) { + fields.add(field); + } + requiredFieldsByClass.set(className, fields); + } + } + + const classBlockRe = /(@dataclass\r?\nclass\s+(\w+):[\s\S]*?)(?=^@dataclass|^class\s+\w|^def\s+\w|\Z)/gm; + return code.replace(classBlockRe, (block: string, _classPrefix: string, className: string) => { + const requiredFields = requiredFieldsByClass.get(className); + if (!requiredFields) { + return block; + } + + let updatedBlock = block; + for (const field of requiredFields) { + updatedBlock = updatedBlock.replace(new RegExp(`^( ${escapeRegExp(field)}: Any) = None$`, "m"), "$1"); + } + return updatedBlock; + }); +} + +/** + * Remove locally-emitted Enum class definitions whose name already comes from + * a `.session_events` import. + * + * Quicktype's enum-merging path collapses structurally-identical enums (even + * with `combineClasses: false`, which only governs class merging). When the + * RPC schema gains sibling enums like `OptionsUpdateReasoningSummary` and + * `SessionOpenOptionsReasoningSummary` whose value set matches the shared + * `ReasoningSummary` enum, quicktype picks `ReasoningSummary` as the merged + * canonical name. That local class then shadows the import we add at the top + * of `rpc.py`, breaking `isinstance` checks against the canonical enum used + * elsewhere in the SDK. + * + * The fix: detect such shadowed enum definitions, verify the local values + * exactly match the imported enum's values in the session-events schema, and + * strip the local class so references resolve to the import. + */ +function removeShadowedSessionEventEnumsForPython( + code: string, + importedFromSessionEvents: Set, + sessionEventsSchema: JSONSchema7 | undefined +): string { + if (importedFromSessionEvents.size === 0 || !sessionEventsSchema) return code; + const seDefs = collectDefinitionCollections(sessionEventsSchema as Record); + const enumBlockRe = + /(?:^|\n)class\s+(\w+)\s*\(Enum\):\s*\r?\n([\s\S]*?)(?=\nclass\s+\w|\n@dataclass\b|\ndef\s+\w|$)/g; + return code + .replace(enumBlockRe, (match: string, className: string, body: string) => { + if (!importedFromSessionEvents.has(className)) return match; + const seDef = seDefs.definitions[className] ?? seDefs.$defs[className]; + const seResolved = seDef ? resolveSchema(seDef, seDefs) ?? seDef : undefined; + if ( + !seResolved?.enum || + !Array.isArray(seResolved.enum) || + !seResolved.enum.every((value) => typeof value === "string") + ) { + return match; + } + const localValues = new Set(); + const valueRe = /^\s+\w+\s*=\s*"([^"]*)"/gm; + let vm: RegExpExecArray | null; + while ((vm = valueRe.exec(body)) !== null) { + localValues.add(vm[1]); + } + const seValues = new Set(seResolved.enum as string[]); + if (localValues.size !== seValues.size) return match; + for (const value of localValues) { + if (!seValues.has(value)) return match; + } + return ""; + }) + .replace(/\n{3,}/g, "\n\n"); +} + +function reorderPythonDataclassFields(code: string): string { + const fieldRe = + /^ \w+: (?:Any|bool|int|float|str|dict|list|ClassVar|[A-Z_]\w*|['"][A-Z_]\w*)(?:[^=]*)?(?: = .*)?$/; + const methodRe = /^ (?:@(?:staticmethod|classmethod|property)|(?:async\s+)?def\s+)/; + const classBlockRe = /(@dataclass\r?\nclass\s+\w+:[\s\S]*?)(?=^@dataclass|^class\s+\w|^def\s+\w|\Z)/gm; + + return code.replace(classBlockRe, (block: string) => { + const lines = block.split("\n"); + const bodyStart = 2; + const memberStart = lines.findIndex((line, index) => index >= bodyStart && methodRe.test(line)); + if (memberStart < 0) { + return block; + } + + const header = lines.slice(0, bodyStart); + const fieldsBody = lines.slice(bodyStart, memberStart); + const members = lines.slice(memberStart); + const preamble: string[] = []; + const groups: string[][] = []; + let current: string[] | undefined; + + for (const line of fieldsBody) { + if (fieldRe.test(line)) { + current = [line]; + groups.push(current); + continue; + } + + if (current) { + current.push(line); + } else { + preamble.push(line); + } + } + + if (groups.length < 2) { + return block; + } + + const required = groups.filter((group) => !group[0].includes(" = ")); + const optional = groups.filter((group) => group[0].includes(" = ")); + const reorderedGroups = [...required, ...optional]; + const changed = reorderedGroups.some((group, index) => group !== groups[index]); + if (!changed) { + return block; + } + + return [...header, ...preamble, ...reorderedGroups.flat(), ...members].join("\n"); + }); +} + function toPascalCase(s: string): string { - return s - .split(/[._]/) - .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) - .join(""); + return fixBrandCasing( + s + .split(/[._]/) + .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) + .join("") + ); } function collectRpcMethods(node: Record): RpcMethod[] { @@ -1347,13 +1621,6 @@ const PY_SESSION_EVENT_TYPE_RENAMES: Record = { SessionShutdownDataShutdownType: "ShutdownType", SessionSkillsLoadedDataSkillsItem: "SkillsLoadedSkill", UserMessageDataAgentMode: "UserMessageAgentMode", - UserMessageDataAttachmentsItem: "UserMessageAttachment", - UserMessageDataAttachmentsItemLineRange: "UserMessageAttachmentFileLineRange", - UserMessageDataAttachmentsItemReferenceType: "UserMessageAttachmentGithubReferenceType", - UserMessageDataAttachmentsItemSelection: "UserMessageAttachmentSelectionDetails", - UserMessageDataAttachmentsItemSelectionEnd: "UserMessageAttachmentSelectionDetailsEnd", - UserMessageDataAttachmentsItemSelectionStart: "UserMessageAttachmentSelectionDetailsStart", - UserMessageDataAttachmentsItemType: "UserMessageAttachmentType", }; function postProcessPythonSessionEventCode(code: string): string { @@ -1446,7 +1713,7 @@ function tryEmitPyRefBasedDiscriminatedUnion( if (!discriminator) return undefined; const variantTypeNames: string[] = []; - const dispatch: Array<{ value: string; typeName: string }> = []; + const dispatch: Array<{ value: PyDiscriminatorValue; typeName: string }> = []; for (let i = 0; i < variants.length; i++) { const variantTypeName = toPascalCase(variantRefNames[i]); const variantSchema = resolveObjectSchema(variants[i], ctx.definitions); @@ -1455,7 +1722,7 @@ function tryEmitPyRefBasedDiscriminatedUnion( } variantTypeNames.push(variantTypeName); const discProp = resolvedVariants[i].properties?.[discriminator.property] as JSONSchema7; - dispatch.push({ value: String(discProp.const), typeName: variantTypeName }); + dispatch.push({ value: pyDiscriminatorValue(discProp.const), typeName: variantTypeName }); } if (!ctx.aliasesByName.has(aliasName)) { @@ -1483,7 +1750,7 @@ function tryEmitPyRefBasedDiscriminatedUnion( lines.push(` match kind:`); for (const m of dispatch) { lines.push( - ` case ${JSON.stringify(m.value)}: return ${m.typeName}.from_dict(obj)` + ` case ${pyDiscriminatorValueExpr(m.value)}: return ${m.typeName}.from_dict(obj)` ); } lines.push( @@ -1525,7 +1792,8 @@ function extractPyEventVariants(schema: JSONSchema7): PyEventVariant[] { eventExperimental: isSchemaExperimental(variant), dataExperimental: isSchemaExperimental(dataSchema), }; - }); + }) + .filter((variant) => !isSchemaInternal(variant.dataSchema)); } function getPySharedEventEnvelopeProperties(schema: JSONSchema7, ctx: PyCodegenCtx): PyEventEnvelopeProperty[] { @@ -2074,9 +2342,19 @@ function emitPyClass( const fieldEntries = Object.entries(schema.properties || {}).filter( ([, value]) => typeof value === "object" ) as Array<[string, JSONSchema7]>; + const optionalFieldEntries = fieldEntries + .filter(([name]) => !required.has(name)) + .sort(([left, leftSchema], [right, rightSchema]) => { + const leftAppendOnly = + (leftSchema as Record)["x-copilot-sdk-append-last"] === true; + const rightAppendOnly = + (rightSchema as Record)["x-copilot-sdk-append-last"] === true; + if (leftAppendOnly !== rightAppendOnly) return leftAppendOnly ? 1 : -1; + return left.localeCompare(right); + }); const orderedFieldEntries = [ ...fieldEntries.filter(([name]) => required.has(name)).sort(([a], [b]) => a.localeCompare(b)), - ...fieldEntries.filter(([name]) => !required.has(name)).sort(([a], [b]) => a.localeCompare(b)), + ...optionalFieldEntries, ]; const fieldInfos = orderedFieldEntries.map(([propName, propSchema]) => { @@ -2394,8 +2672,9 @@ export function generatePythonSessionEventsCode(schema: JSONSchema7): string { out.push(`def to_timedelta_int(x: timedelta) -> int:`); out.push(` assert isinstance(x, timedelta)`); out.push(` milliseconds = x.total_seconds() * 1000.0`); - out.push(` assert milliseconds.is_integer()`); - out.push(` return int(milliseconds)`); + out.push(` # Durations can carry sub-millisecond precision; round to the nearest whole ms`); + out.push(` # using Python's default banker's rounding (round-half-to-even).`); + out.push(` return round(milliseconds)`); out.push(``); out.push(``); } @@ -2528,19 +2807,34 @@ export function generatePythonSessionEventsCode(schema: JSONSchema7): string { out.push(``); out.push(` def __init__(self, **kwargs: Any):`); out.push(` self._values = {key: _compat_from_json_value(value) for key, value in kwargs.items()}`); + out.push(` self._json_keys: dict[str, str] = {}`); + out.push(` self._json_values: dict[str, Any] | None = None`); out.push(` for key, value in self._values.items():`); out.push(` setattr(self, key, value)`); out.push(``); out.push(` @staticmethod`); out.push(` def from_dict(obj: Any) -> "Data":`); out.push(` assert isinstance(obj, dict)`); - out.push( - ` return Data(**{_compat_to_python_key(key): _compat_from_json_value(value) for key, value in obj.items()})` - ); + out.push(` data = Data()`); + out.push(` data._values = {}`); + out.push(` data._json_keys = {}`); + out.push(` data._json_values = {}`); + out.push(` for key, value in obj.items():`); + out.push(` py_key = _compat_to_python_key(key)`); + out.push(` json_value = _compat_from_json_value(value)`); + out.push(` data._values[py_key] = json_value`); + out.push(` data._json_keys[py_key] = key`); + out.push(` data._json_values[key] = json_value`); + out.push(` setattr(data, py_key, data._values[py_key])`); + out.push(` return data`); out.push(``); out.push(` def to_dict(self) -> dict:`); + out.push(` if self._json_values is not None:`); out.push( - ` return {_compat_to_json_key(key): _compat_to_json_value(value) for key, value in self._values.items() if value is not None}` + ` return {key: _compat_to_json_value(value) for key, value in self._json_values.items() if value is not None}` + ); + out.push( + ` return {(self._json_keys.get(key) or _compat_to_json_key(key)): _compat_to_json_value(value) for key, value in self._values.items() if value is not None}` ); out.push(``); out.push(``); @@ -2647,11 +2941,14 @@ async function generateSessionEvents(schemaPath?: string): Promise { console.log("Python: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as JSONSchema7; + const schema = addManagedApprovalRequiredToPermissionRequests( + (await loadSchemaJson(resolvedPath)) as JSONSchema7 + ); const processed = propagateInternalVisibility(postProcessSchema(schema)); let code = generatePythonSessionEventsCode(processed); const { typeNames } = collectInternalSymbols(processed); code = renameInternalPythonSymbols(code, typeNames); + code = appendPythonSessionEventsAllList(code, processed, typeNames); const outPath = await writeGeneratedFile("python/copilot/generated/session_events.py", code); console.log(` ✓ ${outPath}`); @@ -2664,7 +2961,7 @@ async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema const { FetchingJSONSchemaStore, InputData, JSONSchemaInput, quicktype } = await import("quicktype-core"); const resolvedPath = schemaPath ?? (await getApiSchemaPath()); - let schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as ApiSchema)); + let schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedPath)) as ApiSchema)); if (sessionEventsSchema) { const sharedDefinitions = findSharedSchemaDefinitions( schema as unknown as Record, @@ -2793,6 +3090,8 @@ async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema return `${prefix}${updatedBody}${suffix}`; } ); + typesCode = removeRequiredAnyDefaultsForPython(typesCode, allDefinitions, allDefinitionCollections); + typesCode = reorderPythonDataclassFields(typesCode); // Fix bare except: to use Exception (required by ruff/pylint) typesCode = typesCode.replace(/except:/g, "except Exception:"); // Remove unnecessary pass when class has methods (quicktype generates pass for empty schemas) @@ -2803,6 +3102,11 @@ async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema typesCode = collapsePlaceholderPythonDataclasses(typesCode, knownDefNames); typesCode = postProcessExternalUnionAliasesForPython(typesCode, externalUnionAliases); typesCode = postProcessExternalRefsForPython(typesCode, externalRefs.placeholderNames, externalEnumNames); + typesCode = removeShadowedSessionEventEnumsForPython( + typesCode, + externalRefs.imports.get(".session_events") ?? new Set(), + sessionEventsSchema + ); const { code: typesCodeAfterUnions, unions: refBasedUnions } = postProcessRefBasedDiscriminatedUnionsForPython( typesCode, allDefinitions, @@ -3037,6 +3341,9 @@ def _patch_model_capabilities(data: dict) -> dict: if (schema.clientSession) { emitClientSessionApiRegistration(lines, schema.clientSession, resolveType); } + if (schema.clientGlobal) { + emitClientGlobalApiRegistration(lines, schema.clientGlobal, resolveType); + } // Patch models.list to normalize capabilities before deserialization let finalCode = lines.join("\n"); @@ -3056,6 +3363,10 @@ def _patch_model_capabilities(data: dict) -> dict: finalCode = applyUnionRewritesToPython(finalCode, refBasedUnions); finalCode = postProcessDiscriminatorDefaultsForPython(finalCode, refBasedUnions); finalCode = unwrapRedundantPythonLambdas(finalCode); + finalCode = removeUnusedSyntheticPythonDataclasses( + finalCode, + new Set(Object.keys(allDefinitions).map((name) => name.toLowerCase())) + ); // Apply `_`-prefix to type names of internal RPC types so the leading-underscore // Python convention signals "internal, no stability guarantees" to consumers. @@ -3095,10 +3406,111 @@ def _patch_model_capabilities(data: dict) -> dict: } } + finalCode = appendPythonRpcAllList(finalCode, rpcDefinitions); + const outPath = await writeGeneratedFile("python/copilot/generated/rpc.py", finalCode); console.log(` ✓ ${outPath}`); } +/** + * Appends an `__all__` list to the generated session-events module so that + * the public ``copilot.session_events`` shim can ``from .generated.session_events + * import *`` without leaking helper functions (``from_str``, ``from_int``, …) + * or TypeVars (``T``, ``EnumT``). Internal-marked types are omitted so they + * remain hidden from the SDK's public surface even though their renamed + * (`_`-prefixed) form is still present in the module for cross-module use. + */ +function appendPythonSessionEventsAllList(code: string, _schema: JSONSchema7, internalTypeNames: Set): string { + const exported = new Set(); + + // All top-level public classes (schema-derived and inline event payload + // shapes alike). The codegen only emits classes that are part of the + // protocol surface, so a class-presence filter is sufficient — the + // utility module excludes helpers like `from_str` / `to_class` because + // they are functions, not classes, and TypeVars are assignments. + const classPattern = /^class\s+([A-Za-z_]\w*)\b/gm; + let match: RegExpExecArray | null; + while ((match = classPattern.exec(code)) !== null) { + const name = match[1]; + if (name.startsWith("_")) continue; + if (internalTypeNames.has(name)) continue; + exported.add(name); + } + + // Top-level CamelCase Assign targets (e.g. `SessionEventData = X | Y | + // ...` discriminated-union aliases). Skip TypeVars. + const assignPattern = /^([A-Z][A-Za-z0-9_]*)\s*=/gm; + while ((match = assignPattern.exec(code)) !== null) { + const name = match[1]; + if (name === "T" || name === "EnumT") continue; + if (internalTypeNames.has(name)) continue; + exported.add(name); + } + + // Public top-level free functions named like `session_event_from_dict` + // — the documented entry point for parsing event payloads from raw dicts. + // Helper functions like `from_str` / `to_class` live in `utility` (a + // different module) so they don't appear here. + const fnPattern = /^def\s+([a-z][A-Za-z0-9_]*)\s*\(/gm; + while ((match = fnPattern.exec(code)) !== null) { + const name = match[1]; + if (name.startsWith("_")) continue; + if (!name.endsWith("_from_dict") && !name.endsWith("_to_dict")) continue; + exported.add(name); + } + + return code.replace(/\s*$/, "") + "\n\n" + renderPythonAllList([...exported].sort()) + "\n"; +} + +/** + * Appends an `__all__` list to the generated RPC module so that the public + * ``copilot.rpc`` shim can ``from .generated.rpc import *`` without leaking + * helper functions (``from_str``, ``from_int``, …) or TypeVars + * (``T``, ``EnumT``). + * + * Shared types pulled in from session-events (via ``from .session_events + * import …``) are intentionally excluded so each protocol type has a single + * canonical public location. Callers reach them through + * ``copilot.session_events.X`` — matching the C# codegen, which emits shared + * types only in ``GitHub.Copilot`` and references them from + * ``GitHub.Copilot.Rpc`` by fully-qualified name. + */ +function appendPythonRpcAllList(code: string, _definitions: { definitions: Record; $defs: Record }): string { + const exported = new Set(); + + const classPattern = /^class\s+([A-Za-z_]\w*)\b/gm; + let m: RegExpExecArray | null; + while ((m = classPattern.exec(code)) !== null) { + const name = m[1]; + if (name.startsWith("_")) continue; + exported.add(name); + } + + const assignPattern = /^([A-Z][A-Za-z0-9_]*)\s*=/gm; + while ((m = assignPattern.exec(code)) !== null) { + const name = m[1]; + if (name === "T" || name === "EnumT") continue; + exported.add(name); + } + + for (const helper of ["rpc_from_dict", "rpc_to_dict"]) { + if (new RegExp(`^def\\s+${helper}\\b`, "m").test(code)) { + exported.add(helper); + } + } + + return code.replace(/\s*$/, "") + "\n\n" + renderPythonAllList([...exported].sort()) + "\n"; +} + +function renderPythonAllList(names: string[]): string { + const lines: string[] = ["__all__ = ["]; + for (const name of names) { + lines.push(` ${JSON.stringify(name)},`); + } + lines.push("]"); + return lines.join("\n"); +} + function collectPythonSessionEventExportedTypeNames(schema: JSONSchema7): Set { const definitions = collectDefinitionCollections(schema as Record); const definitionNames = new Set([...Object.keys(definitions.definitions), ...Object.keys(definitions.$defs)]); @@ -3458,13 +3870,127 @@ function emitClientSessionRegistrationMethod( lines.push(` client.set_request_handler("${method.rpcMethod}", ${handlerVariableName})`); } -// ── Main ──────────────────────────────────────────────────────────────────── +function emitClientGlobalApiRegistration( + lines: string[], + node: Record, + resolveType: (name: string) => string +): void { + const groups = Object.entries(node).filter(([, value]) => typeof value === "object" && value !== null && !isRpcMethod(value)); + + for (const [groupName, groupNode] of groups) { + const handlerName = `${toPascalCase(groupName)}Handler`; + const groupExperimental = isNodeFullyExperimental(groupNode as Record); + const groupDeprecated = isNodeFullyDeprecated(groupNode as Record); + if (groupDeprecated) { + lines.push(`# Deprecated: this API group is deprecated and will be removed in a future version.`); + } + if (groupExperimental) { + pushPyExperimentalApiGroupComment(lines); + } + lines.push(`class ${handlerName}(Protocol):`); + const methods = collectRpcMethods(groupNode as Record); + for (const method of methods) { + // Client-global handler methods reuse the session handler shape; the + // only difference is dispatch (no implicit session_id key). + emitClientSessionHandlerMethod(lines, method, resolveType, groupExperimental, groupDeprecated); + } + lines.push(``); + } + + lines.push(`@dataclass`); + lines.push(`class ClientGlobalApiHandlers:`); + if (groups.length === 0) { + lines.push(` pass`); + } else { + for (const [groupName] of groups) { + lines.push(` ${toSnakeCase(groupName)}: ${toPascalCase(groupName)}Handler | None = None`); + } + } + lines.push(``); + + lines.push(`def register_client_global_api_handlers(`); + lines.push(` client: "JsonRpcClient",`); + lines.push(` handlers: ClientGlobalApiHandlers,`); + lines.push(`) -> None:`); + lines.push(` """Register client-global request handlers on a JSON-RPC connection.`); + lines.push(``); + lines.push(` Unlike client-session handlers these methods carry no implicit`); + lines.push(` session_id dispatch key; a single set of handlers serves the entire`); + lines.push(` connection.`); + lines.push(` """`); + if (groups.length === 0) { + lines.push(` return`); + } else { + for (const [groupName, groupNode] of groups) { + const methods = collectRpcMethods(groupNode as Record); + for (const method of methods) { + emitClientGlobalRegistrationMethod(lines, groupName, method, resolveType); + } + } + } + lines.push(``); +} + +function emitClientGlobalRegistrationMethod( + lines: string[], + groupName: string, + method: RpcMethod, + resolveType: (name: string) => string +): void { + const rpcSegments = method.rpcMethod.split("."); + const handlerVariableName = `handle_${rpcSegments.map(toSnakeCase).join("_")}`; + const paramsType = resolveType(pythonParamsTypeName(method)); + const resultSchema = getMethodResultSchema(method); + const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined; + const hasResult = !isVoidSchema(resultSchema) && !nullableInner; + const handlerField = toSnakeCase(groupName); + const handlerMethod = clientSessionHandlerMethodName(method.rpcMethod); + + if (method.notification) { + // Notification methods carry no response and are dispatched via the + // notification path (an `id`-less message never reaches a request + // handler), so register on the method-specific notification registry. + lines.push(` async def ${handlerVariableName}(params: dict) -> None:`); + lines.push(` request = ${paramsType}.from_dict(params)`); + lines.push(` handler = handlers.${handlerField}`); + lines.push(` if handler is None: return None`); + lines.push(` await handler.${handlerMethod}(request)`); + lines.push(` return None`); + lines.push(` client.set_notification_method_handler("${method.rpcMethod}", ${handlerVariableName})`); + return; + } + + lines.push(` async def ${handlerVariableName}(params: dict) -> dict | None:`); + lines.push(` request = ${paramsType}.from_dict(params)`); + lines.push(` handler = handlers.${handlerField}`); + lines.push(` if handler is None: raise RuntimeError("No ${handlerField} client-global handler registered")`); + if (hasResult) { + lines.push(` result = await handler.${handlerMethod}(request)`); + if (isObjectSchema(resultSchema)) { + lines.push(` return result.to_dict()`); + } else { + lines.push(` return result.value if hasattr(result, 'value') else result`); + } + } else if (nullableInner) { + lines.push(` result = await handler.${handlerMethod}(request)`); + const resolvedInner = resolveSchema(nullableInner, rpcDefinitions) ?? nullableInner; + if (isObjectSchema(resolvedInner) || nullableInner.$ref) { + lines.push(` return result.to_dict() if result is not None else None`); + } else { + lines.push(` return result`); + } + } else { + lines.push(` await handler.${handlerMethod}(request)`); + lines.push(` return None`); + } + lines.push(` client.set_request_handler("${method.rpcMethod}", ${handlerVariableName})`); +} async function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise { await generateSessionEvents(sessionSchemaPath); try { const resolvedSessionPath = sessionSchemaPath ?? (await getSessionEventsSchemaPath()); - const sessionSchema = postProcessSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedSessionPath, "utf-8")) as JSONSchema7)); + const sessionSchema = postProcessSchema(cloneSchemaForCodegen((await loadSchemaJson(resolvedSessionPath)) as JSONSchema7)); await generateRpc(apiSchemaPath, sessionSchema); } catch (err) { if ((err as NodeJS.ErrnoException).code === "ENOENT" && !apiSchemaPath) { diff --git a/scripts/codegen/rust.ts b/scripts/codegen/rust.ts index f35a358ec..4090318f0 100644 --- a/scripts/codegen/rust.ts +++ b/scripts/codegen/rust.ts @@ -17,6 +17,7 @@ import { fileURLToPath } from "url"; import { promisify } from "util"; import type { JSONSchema7, JSONSchema7Definition } from "json-schema"; import { + addManagedApprovalRequiredToPermissionRequests, type ApiSchema, type DefinitionCollections, EXCLUDED_EVENT_TYPES, @@ -40,6 +41,8 @@ import { isSchemaExperimental, isSchemaInternal, isVoidSchema, + normalizeSchemaBrandCasing, + fixBrandCasing, parseExternalSchemaRef, postProcessSchema, propagateInternalVisibility, @@ -85,11 +88,13 @@ const STRING_NEWTYPE_OVERRIDES: Record = { // ── Naming helpers ────────────────────────────────────────────────────────── function toPascalCase(s: string): string { - const name = s - .split(/[^A-Za-z0-9]+/) - .filter(Boolean) - .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) - .join(""); + const name = fixBrandCasing( + s + .split(/[^A-Za-z0-9]+/) + .filter(Boolean) + .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) + .join(""), + ); if (!name) return "Value"; return /^[0-9]/.test(name) ? `Value${name}` : name; } @@ -470,6 +475,21 @@ function isRustMapSchema(schema: JSONSchema7): boolean { ); } +function isRustArraySchema(schema: JSONSchema7): boolean { + return schema.type === "array"; +} + +function rustArrayType( + schema: JSONSchema7, + parentTypeName: string, + ctx: RustCodegenCtx, +): string { + const items = schema.items as JSONSchema7 | undefined; + if (!items) return "Vec"; + + return `Vec<${resolveRustType(items, parentTypeName, "item", true, ctx)}>`; +} + function rustMapValueType( schema: JSONSchema7, parentTypeName: string, @@ -524,6 +544,22 @@ function emitRustTypeAlias( ctx.typeAliases.push(lines.join("\n")); } +function emitRustArrayAlias( + typeName: string, + schema: JSONSchema7, + ctx: RustCodegenCtx, + description?: string, +): void { + if (ctx.generatedNames.has(typeName)) return; + emitRustTypeAlias( + typeName, + schema, + rustArrayType(schema, typeName, ctx), + ctx, + description, + ); +} + function emitRustMapAlias( typeName: string, schema: JSONSchema7, @@ -540,6 +576,45 @@ function emitRustMapAlias( ); } +/** + * Map a primitive JSON Schema type to its Rust equivalent, or `undefined` when + * the schema is not a plain scalar. Mirrors the primitive branches of + * {@link resolveRustType}. + */ +function rustScalarType(schema: JSONSchema7): string | undefined { + if (schema.enum || schema.const !== undefined) return undefined; + switch (schema.type) { + case "string": + return "String"; + case "number": + return "f64"; + case "integer": + return isIntegerSchemaBoundedToInt32(schema) ? "i32" : "i64"; + case "boolean": + return "bool"; + default: + return undefined; + } +} + +/** + * Emit a type alias for a named schema that resolves to a primitive scalar + * (e.g. an RPC result declared as `{ "type": "integer" }`). Without this the + * generated RPC surface would reference a `*Result` type that was never + * defined. + */ +function emitRustScalarAlias( + typeName: string, + schema: JSONSchema7, + ctx: RustCodegenCtx, + description?: string, +): void { + if (ctx.generatedNames.has(typeName)) return; + const scalarType = rustScalarType(schema); + if (!scalarType) return; + emitRustTypeAlias(typeName, schema, scalarType, ctx, description); +} + function rustRpcResultDescription( method: RpcMethod, resultSchema: JSONSchema7 | undefined, @@ -1074,7 +1149,11 @@ function extractEventVariants(schema: JSONSchema7): EventVariant[] { dataExperimental: isSchemaExperimental(dataSchema), }; }) - .filter((v) => !EXCLUDED_EVENT_TYPES.has(v.typeName)); + .filter( + (v) => + !EXCLUDED_EVENT_TYPES.has(v.typeName) && + !isSchemaInternal(v.dataSchema), + ); } export function generateSessionEventsCode(schema: JSONSchema7): string { @@ -1194,6 +1273,8 @@ export function generateSessionEventsCode(schema: JSONSchema7): string { "//! Auto-generated from session-events.schema.json — do not edit manually.", ); out.push(""); + out.push("#![allow(deprecated)]"); + out.push(""); out.push("use std::collections::HashMap;"); out.push(""); out.push("use serde::{Deserialize, Serialize};"); @@ -1465,6 +1546,8 @@ function generateApiTypesCode( getEnumValueDescriptions(schema), isSchemaExperimental(schema), ); + } else if (isRustArraySchema(schema)) { + emitRustArrayAlias(name, schema, ctx, schema.description); } else if (isRustMapSchema(schema)) { emitRustMapAlias(name, schema, ctx, schema.description); } else if (asGeneratedObjectSchema(schema, defCollections)) { @@ -1484,6 +1567,8 @@ function generateApiTypesCode( } else { tryEmitRustUnion(schema, name, "", ctx); } + } else { + emitRustScalarAlias(name, schema, ctx, schema.description); } } @@ -1527,10 +1612,14 @@ function generateApiTypesCode( if (resolved) { if (resolved.enum && Array.isArray(resolved.enum)) { // Already generated from definitions + } else if (isRustArraySchema(resolved)) { + emitRustArrayAlias(resultName, resolved, ctx, resolved.description); } else if (isRustMapSchema(resolved)) { emitRustMapAlias(resultName, resolved, ctx, resolved.description); } else if (isObjectSchema(resolved)) { emitRustStruct(resultName, resolved, ctx, resolved.description); + } else { + emitRustScalarAlias(resultName, resolved, ctx, resolved.description); } } } @@ -1541,6 +1630,9 @@ function generateApiTypesCode( out.push("//! Auto-generated from api.schema.json — do not edit manually."); out.push(""); out.push("#![allow(clippy::large_enum_variant)]"); + out.push("#![allow(deprecated)]"); + out.push("#![allow(dead_code)]"); + out.push("#![allow(rustdoc::invalid_html_tags)]"); out.push(""); out.push("use std::collections::HashMap;"); out.push(""); @@ -1561,12 +1653,22 @@ function generateApiTypesCode( names.add(typeName); } } + // api_types.rs always needs RequestId/SessionId from crate::types. Merge them into + // the same import group as any other crate::types refs (e.g. SessionEvent) so the + // generator emits a single `use crate::types::{...};` line that matches what + // rustfmt would otherwise produce after merging adjacent imports. + let cratesTypesImports = externalImports.get("crate::types"); + if (!cratesTypesImports) { + cratesTypesImports = new Set(); + externalImports.set("crate::types", cratesTypesImports); + } + cratesTypesImports.add("RequestId"); + cratesTypesImports.add("SessionId"); for (const [module, typeNames] of [...externalImports].sort(([left], [right]) => left.localeCompare(right), )) { out.push(`use ${module}::{${[...typeNames].sort().join(", ")}};`); } - out.push("use crate::types::{RequestId, SessionId};"); out.push(""); // Method constants @@ -1762,6 +1864,17 @@ function getResultTypeName( return `${toPascalCase(method.rpcMethod)}Result`; } +function methodUsesInternalSchema( + schema: JSONSchema7 | null | undefined, + defCollections: DefinitionCollections, +): boolean { + if (!schema) return false; + + const nonNullable = getNullableInner(schema) ?? schema; + const resolved = resolveSchema(nonNullable, defCollections) ?? nonNullable; + return isSchemaInternal(resolved); +} + function pushNamespaceMethodBody( out: string[], constName: string, @@ -1870,7 +1983,12 @@ function emitNamespaceMethod( }; const paramArg = hasParams ? `, params: ${paramsTypeName}` : ""; - const fnVis = method.visibility === "internal" ? "pub(crate)" : "pub"; + const fnVis = + method.visibility === "internal" || + methodUsesInternalSchema(method.params, defCollections) || + methodUsesInternalSchema(method.result, defCollections) + ? "pub(crate)" + : "pub"; if (hasParams && paramsInfo.optional) { out.push(...buildDocs(false)); @@ -1935,6 +2053,8 @@ function generateRpcCode(apiSchema: ApiSchema): string { out.push(""); out.push("#![allow(missing_docs)]"); out.push("#![allow(clippy::too_many_arguments)]"); + out.push("#![allow(deprecated)]"); + out.push("#![allow(dead_code)]"); out.push(""); out.push("use super::api_types::{rpc_methods, *};"); const externalTypeRefs = new Map>(); @@ -2004,7 +2124,19 @@ function generateRpcCode(apiSchema: ApiSchema): string { function generateModRs(): string { const lines: string[] = []; - lines.push("//! Auto-generated protocol types — do not edit manually."); + lines.push("//! Auto-generated protocol types — **not part of the public API**."); + lines.push("//!"); + lines.push( + "//! This module is crate-private. Its layout, item visibility, and", + ); + lines.push("//! naming may change at any time without notice."); + lines.push("//!"); + lines.push("//! Public callers reach the generated types through the stable"); + lines.push("//! re-export modules at the crate root:"); + lines.push("//!"); + lines.push("//! - [`crate::session_events`] for session event payload types"); + lines.push("//! - [`crate::rpc`] for JSON-RPC request/response types and typed"); + lines.push("//! namespace builders"); lines.push("//!"); lines.push( "//! Generated from the Copilot protocol JSON Schemas by `scripts/codegen/rust.ts`.", @@ -2071,16 +2203,18 @@ async function generate(): Promise { schemaArgs.sessionEventsSchemaPath || (await getSessionEventsSchemaPath()); const apiSchemaPath = await getApiSchemaPath(schemaArgs.apiSchemaPath); - const sessionEventsRaw = JSON.parse( - await fs.readFile(sessionEventsSchemaPath, "utf-8"), + const sessionEventsRaw = normalizeSchemaBrandCasing( + JSON.parse(await fs.readFile(sessionEventsSchemaPath, "utf-8")), + ); + const apiRaw = normalizeSchemaBrandCasing( + JSON.parse(await fs.readFile(apiSchemaPath, "utf-8")) as ApiSchema, ); - const apiRaw = JSON.parse( - await fs.readFile(apiSchemaPath, "utf-8"), - ) as ApiSchema; const sessionEventsSchema = propagateInternalVisibility( postProcessSchema( - stripBooleanLiterals(sessionEventsRaw) as JSONSchema7, + stripBooleanLiterals( + addManagedApprovalRequiredToPermissionRequests(sessionEventsRaw as JSONSchema7), + ) as JSONSchema7, ), ); const apiSchema = propagateInternalVisibility( diff --git a/scripts/codegen/typescript.ts b/scripts/codegen/typescript.ts index f3a4bd192..4984816d8 100644 --- a/scripts/codegen/typescript.ts +++ b/scripts/codegen/typescript.ts @@ -37,9 +37,14 @@ import { isNodeFullyDeprecated, isVoidSchema, isSchemaExperimental, + isSchemaInternal, appendPropertyMarkerTagsToDescriptions, getEnumValueDescriptions, - stripOpaqueJsonMarker, + isBareSchemaNode, + isOpaqueInProcess, + isOpaqueJson, + loadSchemaJson, + fixBrandCasing, type ApiSchema, type DefinitionCollections, type RpcMethod, @@ -49,11 +54,115 @@ const TS_EXPERIMENTAL_JSDOC = "/** @experimental */"; const EXTERNAL_SCHEMA_TS_IMPORT: Record = { "session-events.schema.json": "./session-events.js", }; +type OpaqueTypeAlias = "JsonValue" | "OpaqueInProcessValue"; + +function opaqueTypeAliasBlock(aliases: ReadonlySet): string { + const declarations: string[] = []; + if (aliases.has("JsonValue")) { + declarations.push( + `/** A value that can be represented losslessly on the SDK JSON wire. */ +export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };` + ); + } + if (aliases.has("OpaqueInProcessValue")) { + declarations.push( + `/** + * A value that lives only in this process and never crosses the JSON-RPC + * boundary, such as a callback or a host object handle. + * @internal + */ +export type OpaqueInProcessValue = unknown;` + ); + } + return declarations.join("\n\n"); +} + +function restoreOpaqueTypeAliasFormatting(code: string): string { + return code.replace( + "export type JsonValue = null | boolean | number | string | JsonValue[] | {[key: string]: JsonValue};", + "export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };" + ); +} function tsExperimentalJSDoc(indent = ""): string { return `${indent}${TS_EXPERIMENTAL_JSDOC}`; } +/** + * Validates that no public declaration in the generated TypeScript references an internal type. + * + * If the schema is valid (enforced by the runtime's `assert_no_public_internal_references` lint), + * this should never trigger. A failure here means the codegen itself produced a public reference + * to an internal type — which is a codegen bug that must be fixed, not silently worked around. + */ +export function assertNoPublicInternalReferences(generatedTs: string, internalTypes: Set): void { + if (internalTypes.size === 0) return; + + // Identify declarations tagged @internal anywhere in their JSDoc (multi-line or single-line). + const internalDeclarations = new Set(); + for (const m of generatedTs.matchAll( + /\/\*\*(?:[^*]|\*(?!\/))*@internal(?:[^*]|\*(?!\/))*\*\/\s*\nexport (?:interface|type|function|const) (\w+)\b/g + )) { + internalDeclarations.add(m[1]); + } + + // Split on export interface/type/function/const boundaries for attribution. + const declarationRe = /^export (interface|type|function|const) (\w+)\b/gm; + const starts: Array<{ index: number; kind: string; name: string }> = []; + for (let m = declarationRe.exec(generatedTs); m !== null; m = declarationRe.exec(generatedTs)) { + starts.push({ index: m.index, kind: m[1], name: m[2] }); + } + const blocks = starts.map((start, i) => ({ + kind: start.kind, + name: start.name, + text: generatedTs.slice(start.index, i + 1 < starts.length ? starts[i + 1].index : generatedTs.length), + })); + + const violations: string[] = []; + for (const intType of internalTypes) { + for (const block of blocks) { + if (block.name === intType) continue; + if (internalDeclarations.has(block.name)) continue; + + // Strip content that does not appear in the emitted .d.ts: + // 1. All JSDoc/block comments — prevents doc-comment text that happens to name a + // type (e.g. "via the definition X") from registering as a code reference. + // 2. Function bodies — declaration emit drops bodies, so a reference inside a + // function implementation is not a public type reference. + // 3. @internal-tagged member sections — TypeScript's stripInternal removes them + // from the .d.ts along with any types they reference. + let publicText = block.text + // Remove @internal-tagged member declarations before stripping comments so + // member-level internal references do not count as part of the public surface. + // Handles both simple members (`foo?: Hidden;`) and inline object-shaped members + // (`foo?: { ... };`) used by generated TypeScript interfaces. + .replace( + /^[ \t]*\/\*\*[\s\S]*?@internal[\s\S]*?\*\/\s*\n(?:[ \t]*[^\n{;]+;\n?|[ \t]*[^\n{]+\{\n[\s\S]*?^[ \t]*\};\n?)/gm, + "" + ) + // Remove all remaining block comments (JSDoc and otherwise). + .replace(/\/\*[\s\S]*?\*\//g, ""); + + if (block.kind === "function") { + // Remove function bodies (from the opening { to matching closing }). + publicText = publicText.replace(/\{[^{}]*(?:\{[^{}]*\}[^{}]*)*\}/g, "{}"); + } + + if (new RegExp(`\\b${intType}\\b`).test(publicText)) { + violations.push(` ${block.name} (public) references internal type ${intType}`); + } + } + } + + if (violations.length > 0) { + throw new Error( + `Codegen produced public declarations that reference internal types.\n` + + `This is a codegen bug — fix the generator so internal types are not referenced by public output:\n` + + violations.join("\n") + ); + } +} + function sanitizeJsDocText(text: string): string { return text.trim().replace(/\*\//g, "* /"); } @@ -121,7 +230,7 @@ function pushTsRpcMethodJsDoc( } function toPascalCase(s: string): string { - return s.charAt(0).toUpperCase() + s.slice(1); + return fixBrandCasing(s.charAt(0).toUpperCase() + s.slice(1)); } function escapeRegExp(value: string): string { @@ -249,7 +358,10 @@ function collectRpcMethods(node: Record): RpcMethod[] { return results; } -export function normalizeSchemaForTypeScript(schema: JSONSchema7): JSONSchema7 { +export function normalizeSchemaForTypeScript( + schema: JSONSchema7, + opaqueTypeAliases?: Set +): JSONSchema7 { const root = structuredClone(schema) as JSONSchema7 & { definitions?: Record; $defs?: Record; @@ -271,24 +383,52 @@ export function normalizeSchemaForTypeScript(schema: JSONSchema7): JSONSchema7 { root.definitions = definitions; delete root.$defs; - const rewrite = (value: unknown): unknown => { + const internalDefinitionNames = new Set( + Object.entries(definitions) + .filter(([, definition]) => typeof definition === "object" && definition !== null && isSchemaInternal(definition as JSONSchema7)) + .map(([name]) => name) + ); + const isInternalUnionVariant = (value: unknown): boolean => { + if (!value || typeof value !== "object") return false; + const variant = value as JSONSchema7; + if (isSchemaInternal(variant)) return true; + const match = variant.$ref?.match(/^#\/(?:definitions|\$defs)\/([^/]+)$/); + return match ? internalDefinitionNames.has(match[1]) : false; + }; + + const rewrite = (value: unknown, withinInternalDefinition = false): unknown => { if (Array.isArray(value)) { - return value.map(rewrite); + return value.map((item) => rewrite(item, withinInternalDefinition)); } if (!value || typeof value !== "object") { return value; } + const source = value as Record; + const isInternal = withinInternalDefinition || isSchemaInternal(source as JSONSchema7); const rewritten = Object.fromEntries( - Object.entries(value as Record).map(([key, child]) => [key, rewrite(child)]) + Object.entries(source).map(([key, child]) => { + const publicChild = + !isInternal && + (key === "anyOf" || key === "oneOf") && + Array.isArray(child) + ? child.filter((variant) => !isInternalUnionVariant(variant)) + : child; + return [key, rewrite(publicChild, isInternal)]; + }) ) as Record; - // The TypeScript codegen doesn't distinguish opaque JSON from any - // other unconstrained value, so drop the marker before feeding the - // schema to json-schema-to-typescript. C# codegen reads the marker - // from its own (un-normalized) view of the schema and emits - // `JsonElement` instead. - stripOpaqueJsonMarker(rewritten); + if (isBareSchemaNode(rewritten as JSONSchema7)) { + if (isOpaqueJson(rewritten as JSONSchema7)) { + rewritten.tsType = "JsonValue"; + opaqueTypeAliases?.add("JsonValue"); + } else if (isOpaqueInProcess(rewritten as JSONSchema7)) { + rewritten.tsType = "OpaqueInProcessValue"; + opaqueTypeAliases?.add("OpaqueInProcessValue"); + } + } + delete rewritten["x-opaque-json"]; + delete rewritten["x-opaque-in-process"]; const enumValueDescriptions = getEnumValueDescriptions(rewritten as JSONSchema7); if (enumValueDescriptions && Array.isArray(rewritten.enum) && rewritten.enum.every((entry) => typeof entry === "string")) { @@ -335,34 +475,111 @@ export function normalizeSchemaForTypeScript(schema: JSONSchema7): JSONSchema7 { // ── Session Events ────────────────────────────────────────────────────────── +/** + * Filters a `SessionEvent` union schema to exclude internal arms. + * + * The schema marks internal union members with `visibility: "internal"` on the arm object itself + * AND on the resolved definition. An arm is excluded when either level is internal, or when the + * arm's resolved `data` property is internal (legacy pattern for event types that carry their + * payload in a `data` field). + * + * Returns the filtered arms and the set of definition names to exclude from compilation. + */ +export function filterPublicSessionEventVariants( + variants: JSONSchema7[], + definitionCollections: DefinitionCollections +): { publicVariants: JSONSchema7[]; excludedDefinitionNames: Set } { + const excludedDefinitionNames = new Set(); + const publicVariants = variants.filter((variant) => { + const variantSchema = variant as JSONSchema7; + const resolvedVariant = resolveSchema(variantSchema, definitionCollections) ?? variantSchema; + + // Exclude the arm if the arm object itself or its resolved definition is internal. + // The schema marks internal union members at both levels; checking only the resolved + // definition's `data` sub-property (the original logic) missed cases where the event + // type itself carries `visibility: "internal"`. + if (isSchemaInternal(variantSchema) || isSchemaInternal(resolvedVariant)) { + for (const ref of [variantSchema.$ref]) { + const match = ref?.match(/^#\/(?:definitions|\$defs)\/([^/]+)$/); + if (match) excludedDefinitionNames.add(match[1]); + } + return false; + } + + const dataSchema = resolvedVariant.properties?.data as JSONSchema7 | undefined; + const resolvedData = dataSchema ? resolveSchema(dataSchema, definitionCollections) ?? dataSchema : undefined; + if (!isSchemaInternal(resolvedData)) { + return true; + } + + for (const ref of [variantSchema.$ref, dataSchema?.$ref]) { + const match = ref?.match(/^#\/(?:definitions|\$defs)\/([^/]+)$/); + if (match) excludedDefinitionNames.add(match[1]); + } + return false; + }); + return { publicVariants, excludedDefinitionNames }; +} + async function generateSessionEvents(schemaPath?: string): Promise { console.log("TypeScript: generating session-events..."); const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath()); - const schema = JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as JSONSchema7; + const schema = (await loadSchemaJson(resolvedPath)) as JSONSchema7; const processed = propagateInternalVisibility(postProcessSchema(schema)); const definitionCollections = collectDefinitionCollections(processed as Record); const sessionEvent = resolveSchema({ $ref: "#/definitions/SessionEvent" }, definitionCollections) ?? resolveSchema({ $ref: "#/$defs/SessionEvent" }, definitionCollections) ?? processed; - const schemaForCompile = withSharedDefinitions(sessionEvent, definitionCollections); + const { publicVariants, excludedDefinitionNames } = filterPublicSessionEventVariants( + sessionEvent.anyOf ?? [], + definitionCollections + ); + const publicDefinitions = Object.fromEntries( + Object.entries(definitionCollections.definitions).filter(([name]) => !excludedDefinitionNames.has(name)) + ); + const publicDraftDefinitions = Object.fromEntries( + Object.entries(definitionCollections.$defs).filter(([name]) => !excludedDefinitionNames.has(name)) + ); + const publicSessionEvent = { ...sessionEvent, anyOf: publicVariants }; + if ("SessionEvent" in publicDefinitions) { + publicDefinitions.SessionEvent = publicSessionEvent; + } + if ("SessionEvent" in publicDraftDefinitions) { + publicDraftDefinitions.SessionEvent = publicSessionEvent; + } + const schemaForCompile = withSharedDefinitions( + publicSessionEvent, + { definitions: publicDefinitions, $defs: publicDraftDefinitions } + ); appendPropertyMarkerTagsToDescriptions(schemaForCompile); - const ts = await compile(normalizeSchemaForTypeScript(schemaForCompile), "SessionEvent", { - bannerComment: `/** + const opaqueTypeAliases = new Set(); + const ts = restoreOpaqueTypeAliasFormatting( + await compile(normalizeSchemaForTypeScript(schemaForCompile, opaqueTypeAliases), "SessionEvent", { + bannerComment: [ + `/** * AUTO-GENERATED FILE - DO NOT EDIT * Generated from: session-events.schema.json */`, - style: { semi: true, singleQuote: false, trailingComma: "all" }, - additionalProperties: false, - strictIndexSignatures: true, - }); + opaqueTypeAliasBlock(opaqueTypeAliases), + ] + .filter(Boolean) + .join("\n\n"), + style: { semi: true, singleQuote: false, trailingComma: "all" }, + additionalProperties: false, + strictIndexSignatures: true, + }) + ); let annotatedTs = annotateTypeScriptTypes(ts, experimentalDefinitionNames(definitionCollections), TS_EXPERIMENTAL_JSDOC); // Add @internal JSDoc annotations for session-event types marked // `visibility: "internal"` in the schema. The tag drives `stripInternal` // so the whole type is dropped from the published .d.ts. + // Because internal union arms are excluded from the compiled output by the + // publicVariants filter above, no public declaration should reference these + // types; assertNoPublicInternalReferences enforces that invariant hard. const sessionInternalTypes = new Set(); for (const [name, def] of Object.entries(definitionCollections.definitions ?? {})) { if (def && typeof def === "object" && (def as Record).visibility === "internal") { @@ -380,6 +597,7 @@ async function generateSessionEvents(schemaPath?: string): Promise { `$1/** @internal */\n$2` ); } + assertNoPublicInternalReferences(annotatedTs, sessionInternalTypes); const outPath = await writeGeneratedFile("nodejs/src/generated/session-events.ts", annotatedTs); console.log(` ✓ ${outPath}`); } @@ -477,7 +695,7 @@ async function generateRpc(schemaPath?: string, sessionEventsSchema?: JSONSchema console.log("TypeScript: generating RPC types..."); const resolvedPath = schemaPath ?? (await getApiSchemaPath()); - let schema = fixNullableRequiredRefsInApiSchema(JSON.parse(await fs.readFile(resolvedPath, "utf-8")) as ApiSchema); + let schema = fixNullableRequiredRefsInApiSchema((await loadSchemaJson(resolvedPath)) as ApiSchema); if (sessionEventsSchema) { const sharedDefinitions = findSharedSchemaDefinitions( schema as unknown as Record, @@ -511,10 +729,12 @@ import type { MessageConnection } from "vscode-jsonrpc/node.js"; if (externalSchemaRefs.size > 0) { lines.push(""); } + const aliasInsertIndex = lines.length; const allMethods = [...collectRpcMethods(schema.server || {}), ...collectRpcMethods(schema.session || {})]; const clientSessionMethods = collectRpcMethods(schema.clientSession || {}); - const rpcMethods = [...allMethods, ...clientSessionMethods]; + const clientGlobalMethods = collectRpcMethods(schema.clientGlobal || {}); + const rpcMethods = [...allMethods, ...clientSessionMethods, ...clientGlobalMethods]; const seenBlocks = new Map(); // Build a single combined schema with shared definitions and all method types. @@ -612,12 +832,17 @@ import type { MessageConnection } from "vscode-jsonrpc/node.js"; const schemaForCompile = combinedSchema; appendPropertyMarkerTagsToDescriptions(schemaForCompile); - const compiled = await compile(normalizeSchemaForTypeScript(schemaForCompile), "_RpcSchemaRoot", { + const opaqueTypeAliases = new Set(); + const compiled = await compile(normalizeSchemaForTypeScript(schemaForCompile, opaqueTypeAliases), "_RpcSchemaRoot", { bannerComment: "", additionalProperties: false, strictIndexSignatures: true, unreachableDefinitions: true, }); + const aliases = opaqueTypeAliasBlock(opaqueTypeAliases); + if (aliases) { + lines.splice(aliasInsertIndex, 0, aliases, ""); + } // Strip the placeholder root type and keep only the definition-generated types const strippedTs = compiled @@ -639,13 +864,9 @@ import type { MessageConnection } from "vscode-jsonrpc/node.js"; `$1/** @deprecated */\n$2` ); } - // Add @internal JSDoc annotations for types from internal methods - for (const intType of internalTypes) { - annotatedTs = annotatedTs.replace( - new RegExp(`(^|\\n)(export (?:interface|type) ${intType}\\b)`, "m"), - `$1/** @internal */\n$2` - ); - } + // @internal tagging happens in a final pass over the assembled file: the client/server + // method signatures that reference these types are emitted later, so a per-chunk check + // would not see them and would strip a type the public API still names. lines.push(annotatedTs); lines.push(""); } @@ -715,7 +936,27 @@ function hasInternalMethods(node: Record): boolean { lines.push(...emitClientSessionApiRegistration(schema.clientSession)); } - const outPath = await writeGeneratedFile("nodejs/src/generated/rpc.ts", lines.join("\n")); + // Generate client *global* API handler interfaces and registration function. + // Unlike client-session APIs, these methods do not carry a `sessionId` dispatch + // key — the SDK consumer registers a single process-wide handler per group. + if (schema.clientGlobal) { + lines.push(...emitClientGlobalApiRegistration(schema.clientGlobal)); + } + + // Apply @internal to RPC types in a final pass over the assembled file. + // The client/server method signatures that reference these types are emitted + // after the per-schema type chunks, so the tagging must happen here rather + // than per-chunk. assertNoPublicInternalReferences then enforces hard that no + // public declaration slipped through referencing a type the schema marked internal. + let rpcTs = lines.join("\n"); + for (const intType of internalTypes) { + rpcTs = rpcTs.replace( + new RegExp(`(^|\\n)(export (?:interface|type) ${intType}\\b)`, "m"), + `$1/** @internal */\n$2` + ); + } + assertNoPublicInternalReferences(rpcTs, internalTypes); + const outPath = await writeGeneratedFile("nodejs/src/generated/rpc.ts", rpcTs); console.log(` ✓ ${outPath}`); } @@ -924,13 +1165,137 @@ function emitClientSessionApiRegistration(clientSchema: Record) return lines; } +/** + * Generate handler interfaces and a registration function for client *global* + * API groups. + * + * Unlike client-session APIs, these methods carry no implicit `sessionId` + * dispatch key. The SDK consumer registers a single process-wide handler set + * via `registerClientGlobalApiHandlers`; the runtime dispatcher routes each + * incoming call to the registered handler regardless of which (if any) + * runtime session triggered it. + */ +function emitClientGlobalApiRegistration(clientSchema: Record): string[] { + const lines: string[] = []; + const groups = collectClientGroups(clientSchema); + + for (const [groupName, methods] of groups) { + const interfaceName = toPascalCase(groupName) + "Handler"; + const publicMethods = methods.filter((m) => m.visibility !== "internal"); + // Skip groups that have no public methods — they are handled internally by the SDK. + if (publicMethods.length === 0) continue; + const groupDeprecated = isNodeFullyDeprecated(clientSchema[groupName] as Record); + const groupExperimental = isNodeFullyExperimental(clientSchema[groupName] as Record); + if (groupDeprecated) { + lines.push(`/** @deprecated Handler for \`${groupName}\` client global API methods. */`); + } else if (groupExperimental) { + lines.push(`/** Handler for \`${groupName}\` client global API methods. */`); + lines.push(TS_EXPERIMENTAL_JSDOC); + } else { + lines.push(`/** Handler for \`${groupName}\` client global API methods. */`); + } + lines.push(`export interface ${interfaceName} {`); + for (const method of publicMethods) { + const name = handlerMethodName(method.rpcMethod); + const hasParams = hasSchemaPayload(getMethodParamsSchema(method)); + const pType = hasParams ? paramsTypeName(method) : ""; + const rType = tsResultType(method); + + pushTsRpcMethodJsDoc(lines, " ", method, { + summaryFallback: `Handles \`${method.rpcMethod}\`.`, + paramsName: hasParams ? "params" : undefined, + paramsDescription: rpcParamsDescription(method, getMethodParamsSchema(method)), + includeDeprecated: method.deprecated && !groupDeprecated, + includeExperimental: method.stability === "experimental" && !groupExperimental, + }); + if (hasParams) { + lines.push(` ${name}(params: ${pType}): Promise<${rType}>;`); + } else { + lines.push(` ${name}(): Promise<${rType}>;`); + } + } + lines.push(`}`); + lines.push(""); + } + + lines.push(`/** All client global API handler groups. */`); + lines.push(`export interface ClientGlobalApiHandlers {`); + for (const [groupName, methods] of groups) { + const publicMethods = methods.filter((m) => m.visibility !== "internal"); + if (publicMethods.length === 0) continue; + const interfaceName = toPascalCase(groupName) + "Handler"; + lines.push(` ${groupName}?: ${interfaceName};`); + } + lines.push(`}`); + lines.push(""); + + lines.push(`/**`); + lines.push(` * Register client global API handlers on a JSON-RPC connection.`); + lines.push(` * The server calls these methods to delegate work to the client.`); + lines.push(` * Unlike session-scoped client APIs, these methods carry no implicit`); + lines.push(` * \`sessionId\` dispatch key — a single set of handlers serves the entire`); + lines.push(` * connection.`); + lines.push(` */`); + lines.push(`export function registerClientGlobalApiHandlers(`); + lines.push(` connection: MessageConnection,`); + lines.push(` handlers: ClientGlobalApiHandlers,`); + lines.push(`): void {`); + + for (const [groupName, methods] of groups) { + // Only wire up public methods; internal methods are handled directly by the SDK. + const publicMethods = methods.filter((m) => m.visibility !== "internal"); + if (publicMethods.length === 0) continue; + for (const method of publicMethods) { + const name = handlerMethodName(method.rpcMethod); + const pType = paramsTypeName(method); + const hasParams = hasSchemaPayload(getMethodParamsSchema(method)); + + if (method.notification) { + // Notification methods carry no response; the server dispatches + // them via `sendNotification`, which only fires `onNotification` + // handlers (an `onRequest` handler would never be invoked). + if (hasParams) { + lines.push(` connection.onNotification("${method.rpcMethod}", async (params: ${pType}) => {`); + lines.push(` const handler = handlers.${groupName};`); + lines.push(` if (!handler) return;`); + lines.push(` await handler.${name}(params);`); + lines.push(` });`); + } else { + lines.push(` connection.onNotification("${method.rpcMethod}", async () => {`); + lines.push(` const handler = handlers.${groupName};`); + lines.push(` if (!handler) return;`); + lines.push(` await handler.${name}();`); + lines.push(` });`); + } + } else if (hasParams) { + lines.push(` connection.onRequest("${method.rpcMethod}", async (params: ${pType}) => {`); + lines.push(` const handler = handlers.${groupName};`); + lines.push(` if (!handler) throw new Error("No ${groupName} client-global handler registered");`); + lines.push(` return handler.${name}(params);`); + lines.push(` });`); + } else { + lines.push(` connection.onRequest("${method.rpcMethod}", async () => {`); + lines.push(` const handler = handlers.${groupName};`); + lines.push(` if (!handler) throw new Error("No ${groupName} client-global handler registered");`); + lines.push(` return handler.${name}();`); + lines.push(` });`); + } + } + } + + lines.push(`}`); + lines.push(""); + + return lines; +} + // ── Main ──────────────────────────────────────────────────────────────────── async function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise { await generateSessionEvents(sessionSchemaPath); try { const resolvedSessionPath = sessionSchemaPath ?? (await getSessionEventsSchemaPath()); - const sessionSchema = propagateInternalVisibility(postProcessSchema(JSON.parse(await fs.readFile(resolvedSessionPath, "utf-8")) as JSONSchema7)); + const sessionSchema = propagateInternalVisibility(postProcessSchema((await loadSchemaJson(resolvedSessionPath)) as JSONSchema7)); await generateRpc(apiSchemaPath, sessionSchema); } catch (err) { if ((err as NodeJS.ErrnoException).code === "ENOENT" && !apiSchemaPath) { diff --git a/scripts/codegen/utils.ts b/scripts/codegen/utils.ts index 4d04bae9a..1804990ae 100644 --- a/scripts/codegen/utils.ts +++ b/scripts/codegen/utils.ts @@ -45,23 +45,147 @@ export type SchemaWithSharedDefinitions = T }; // ── Schema paths ──────────────────────────────────────────────────────────── -export async function getSessionEventsSchemaPath(): Promise { - const schemaPath = path.join( - REPO_ROOT, - "nodejs/node_modules/@github/copilot/schemas/session-events.schema.json" +const SDK_NODE_MODULES = path.join(REPO_ROOT, "nodejs/node_modules"); + +/** + * Resolve a JSON schema shipped by the `@github/copilot` CLI package. + * + * The CLI package layout changed in 1.0.64-1: the umbrella `@github/copilot` + * package became a thin loader and its bundled assets (including the JSON + * schemas) moved into the platform-specific packages installed as optional + * dependencies, e.g. `@github/copilot-linux-x64` or `@github/copilot-win32-x64`. + * + * To support both layouts we look in the umbrella package first (older + * versions) and then in whichever platform package was installed for the + * current host. + */ +async function resolveCopilotSchemaPath(nodeModulesDir: string, fileName: string): Promise { + const candidates = [path.join(nodeModulesDir, "@github/copilot/schemas", fileName)]; + + const githubScopeDir = path.join(nodeModulesDir, "@github"); + try { + for (const entry of await fs.readdir(githubScopeDir)) { + if (entry.startsWith("copilot-")) { + candidates.push(path.join(githubScopeDir, entry, "schemas", fileName)); + } + } + } catch (err) { + const code = (err as NodeJS.ErrnoException).code; + if (code !== "ENOENT" && code !== "ENOTDIR") { + throw err; + } + // @github scope directory may not exist yet; fall through to the error below. + } + + for (const candidate of candidates) { + try { + await fs.access(candidate); + return candidate; + } catch { + // Try the next candidate. + } + } + + throw new Error( + `${fileName} not found under ${githubScopeDir}. Run 'npm ci' in nodejs/ first.` ); - await fs.access(schemaPath); - return schemaPath; +} + +export async function getSessionEventsSchemaPath(): Promise { + return resolveCopilotSchemaPath(SDK_NODE_MODULES, "session-events.schema.json"); } export async function getApiSchemaPath(cliArg?: string): Promise { if (cliArg) return cliArg; - const schemaPath = path.join( - REPO_ROOT, - "nodejs/node_modules/@github/copilot/schemas/api.schema.json" - ); - await fs.access(schemaPath); - return schemaPath; + return resolveCopilotSchemaPath(SDK_NODE_MODULES, "api.schema.json"); +} + +// ── Brand casing normalization ────────────────────────────────────────────── + +/** + * Correct the GitHub brand casing in a generated identifier or documentation + * string. Some schema titles/definition names and value-derived identifiers + * render the brand as "Github"; the correct casing is "GitHub". Wire/protocol + * values (e.g. "github", "github_reference") are lowercase and therefore left + * untouched. The replacement is idempotent: already-correct "GitHub" contains a + * capital "H" and no "Github" substring, so it is unaffected. + */ +export function fixBrandCasing(value: string): string { + return value.replace(/Github/g, "GitHub"); +} + +const BRAND_NORMALIZED_STRING_KEYS = new Set(["title", "description", "markdownDescription"]); + +/** + * Recursively normalize GitHub brand casing within a parsed JSON schema: + * - keys of `definitions` / `$defs` maps, + * - `$ref` pointers (definition-name segment only), + * - documentation strings (`title`, `description`, `markdownDescription`). + * + * Wire-level string values (`const`, `enum`, `default`, examples, etc.) are left + * untouched so protocol values such as "github" remain lowercase. The schema is + * mutated in place and also returned for convenience. + */ +export function normalizeSchemaBrandCasing(schema: T): T { + normalizeBrandCasingNode(schema); + return schema; +} + +function normalizeBrandCasingNode(node: unknown): void { + if (Array.isArray(node)) { + for (const item of node) normalizeBrandCasingNode(item); + return; + } + if (node === null || typeof node !== "object") return; + const obj = node as Record; + + for (const defsKey of ["definitions", "$defs"] as const) { + const defs = obj[defsKey]; + if (defs && typeof defs === "object" && !Array.isArray(defs)) { + renameBrandDefinitionKeys(defs as Record); + } + } + + for (const [key, value] of Object.entries(obj)) { + if (typeof value === "string") { + if (key === "$ref") { + obj[key] = fixBrandRef(value); + } else if (BRAND_NORMALIZED_STRING_KEYS.has(key)) { + obj[key] = fixBrandCasing(value); + } + } else { + normalizeBrandCasingNode(value); + } + } +} + +/** Apply brand-casing only to the definition-name segment of a `$ref`. */ +function fixBrandRef(ref: string): string { + const lastSlash = ref.lastIndexOf("/"); + if (lastSlash === -1) return ref; + const prefix = ref.slice(0, lastSlash + 1); + const name = ref.slice(lastSlash + 1); + return `${prefix}${fixBrandCasing(name)}`; +} + +function renameBrandDefinitionKeys(defs: Record): void { + for (const oldKey of Object.keys(defs)) { + const newKey = fixBrandCasing(oldKey); + if (newKey === oldKey) continue; + if (newKey in defs && stableStringify(defs[newKey]) !== stableStringify(defs[oldKey])) { + throw new Error( + `Brand-casing normalization collision: "${oldKey}" -> "${newKey}" but a different definition already exists under "${newKey}".` + ); + } + defs[newKey] = defs[oldKey]; + delete defs[oldKey]; + } +} + +/** Load a JSON schema file and normalize GitHub brand casing in titles, refs, and definition keys. */ +export async function loadSchemaJson(filePath: string): Promise { + const parsed = JSON.parse(await fs.readFile(filePath, "utf-8")) as T; + return normalizeSchemaBrandCasing(parsed); } // ── Schema processing ─────────────────────────────────────────────────────── @@ -259,6 +383,7 @@ export interface RpcMethod { stability?: string; visibility?: string; deprecated?: boolean; + notification?: boolean; } export function getRpcSchemaTypeName(schema: JSONSchema7 | null | undefined, fallback: string): string { @@ -328,6 +453,49 @@ export function cloneSchemaForCodegen(value: T): T { return value; } +const PERMISSION_REQUEST_DEFINITION_NAMES = [ + "PermissionRequestCustomTool", + "PermissionRequestExtensionManagement", + "PermissionRequestExtensionPermissionAccess", + "PermissionRequestFactory", + "PermissionRequestHook", + "PermissionRequestMcp", + "PermissionRequestMemory", + "PermissionRequestRead", + "PermissionRequestShell", + "PermissionRequestUrl", + "PermissionRequestWrite", +] as const; + +/** + * Add managed approval metadata until the pinned CLI schema includes the field. + */ +export function addManagedApprovalRequiredToPermissionRequests(schema: T): T { + const cloned = cloneSchemaForCodegen(schema); + const property: JSONSchema7 = { + description: + "When true, managed policy requires an explicit user decision and automatic approval must be bypassed.", + type: ["boolean", "null"], + }; + (property as Record)["x-copilot-sdk-append-last"] = true; + + for (const definitions of [cloned.definitions, cloned.$defs]) { + if (!definitions) continue; + for (const name of PERMISSION_REQUEST_DEFINITION_NAMES) { + const definition = definitions[name]; + if (!definition || typeof definition !== "object") continue; + const objectDefinition = definition as JSONSchema7; + objectDefinition.properties = { + ...objectDefinition.properties, + managedApprovalRequired: + objectDefinition.properties?.managedApprovalRequired ?? cloneSchemaForCodegen(property), + }; + } + } + + return cloned; +} + export function getEnumValueDescriptions(schema: JSONSchema7 | null | undefined): EnumValueDescriptions | undefined { if (!schema || typeof schema !== "object") return undefined; @@ -382,6 +550,7 @@ export interface ApiSchema { server?: Record; session?: Record; clientSession?: Record; + clientGlobal?: Record; } export function isRpcMethod(node: unknown): node is RpcMethod { @@ -431,6 +600,7 @@ export function fixNullableRequiredRefsInApiSchema(schema: ApiSchema): ApiSchema server: walkApiNode(schema.server), session: walkApiNode(schema.session), clientSession: walkApiNode(schema.clientSession), + clientGlobal: walkApiNode(schema.clientGlobal), }; } @@ -773,6 +943,34 @@ export function isOpaqueJson(schema: JSONSchema7 | null | undefined): boolean { return typeof schema === "object" && schema !== null && (schema as Record)["x-opaque-json"] === true; } +/** Returns true when a JSON Schema node is marked `x-opaque-in-process: true`. */ +export function isOpaqueInProcess(schema: JSONSchema7 | null | undefined): boolean { + return typeof schema === "object" && schema !== null && (schema as Record)["x-opaque-in-process"] === true; +} + +/** + * Returns true when a schema node has no structural constraints that describe a + * more precise TypeScript type than an opaque marker. + */ +export function isBareSchemaNode(schema: JSONSchema7 | null | undefined): boolean { + if (typeof schema !== "object" || schema === null) return false; + const node = schema as Record; + return ![ + "type", + "anyOf", + "oneOf", + "allOf", + "$ref", + "properties", + "items", + "enum", + "const", + "additionalProperties", + "not", + "patternProperties", + ].some((key) => key in node); +} + /** * Removes the `x-opaque-json` marker from a schema node in place. Useful for * codegens (e.g. TypeScript) that don't distinguish opaque JSON from any other diff --git a/scripts/corrections/package-lock.json b/scripts/corrections/package-lock.json index 53fb6fe9d..a975812af 100644 --- a/scripts/corrections/package-lock.json +++ b/scripts/corrections/package-lock.json @@ -10,7 +10,7 @@ "@octokit/rest": "^22.0.1", "@types/node": "^22.0.0", "typescript": "^5.8.0", - "vitest": "^3.1.0" + "vitest": "^4.1.0" } }, "node_modules/@actions/github": { @@ -40,446 +40,38 @@ "undici": "^6.23.0" } }, - "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.4.tgz", - "integrity": "sha512-cQPwL2mp2nSmHHJlCyoXgHGhbEPMrEEU5xhkcy3Hs/O7nGZqEpZ2sUtLaL9MORLtDfRvVl2/3PAuEkYZH0Ty8Q==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "aix" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-arm": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.4.tgz", - "integrity": "sha512-X9bUgvxiC8CHAGKYufLIHGXPJWnr0OCdR0anD2e21vdvgCI8lIfqFbnoeOz7lBjdrAGUhqLZLcQo6MLhTO2DKQ==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.4.tgz", - "integrity": "sha512-gdLscB7v75wRfu7QSm/zg6Rx29VLdy9eTr2t44sfTW7CxwAtQghZ4ZnqHk3/ogz7xao0QAgrkradbBzcqFPasw==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.4.tgz", - "integrity": "sha512-PzPFnBNVF292sfpfhiyiXCGSn9HZg5BcAz+ivBuSsl6Rk4ga1oEXAamhOXRFyMcjwr2DVtm40G65N3GLeH1Lvw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.4.tgz", - "integrity": "sha512-b7xaGIwdJlht8ZFCvMkpDN6uiSmnxxK56N2GDTMYPr2/gzvfdQN8rTfBsvVKmIVY/X7EM+/hJKEIbbHs9oA4tQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.4.tgz", - "integrity": "sha512-sR+OiKLwd15nmCdqpXMnuJ9W2kpy0KigzqScqHI3Hqwr7IXxBp3Yva+yJwoqh7rE8V77tdoheRYataNKL4QrPw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.4.tgz", - "integrity": "sha512-jnfpKe+p79tCnm4GVav68A7tUFeKQwQyLgESwEAUzyxk/TJr4QdGog9sqWNcUbr/bZt/O/HXouspuQDd9JxFSw==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.4.tgz", - "integrity": "sha512-2kb4ceA/CpfUrIcTUl1wrP/9ad9Atrp5J94Lq69w7UwOMolPIGrfLSvAKJp0RTvkPPyn6CIWrNy13kyLikZRZQ==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.4.tgz", - "integrity": "sha512-aBYgcIxX/wd5n2ys0yESGeYMGF+pv6g0DhZr3G1ZG4jMfruU9Tl1i2Z+Wnj9/KjGz1lTLCcorqE2viePZqj4Eg==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.4.tgz", - "integrity": "sha512-7nQOttdzVGth1iz57kxg9uCz57dxQLHWxopL6mYuYthohPKEK0vU0C3O21CcBK6KDlkYVcnDXY099HcCDXd9dA==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ia32": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.4.tgz", - "integrity": "sha512-oPtixtAIzgvzYcKBQM/qZ3R+9TEUd1aNJQu0HhGyqtx6oS7qTpvjheIWBbes4+qu1bNlo2V4cbkISr8q6gRBFA==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-loong64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.4.tgz", - "integrity": "sha512-8mL/vh8qeCoRcFH2nM8wm5uJP+ZcVYGGayMavi8GmRJjuI3g1v6Z7Ni0JJKAJW+m0EtUuARb6Lmp4hMjzCBWzA==", - "cpu": [ - "loong64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.4.tgz", - "integrity": "sha512-1RdrWFFiiLIW7LQq9Q2NES+HiD4NyT8Itj9AUeCl0IVCA459WnPhREKgwrpaIfTOe+/2rdntisegiPWn/r/aAw==", - "cpu": [ - "mips64el" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.4.tgz", - "integrity": "sha512-tLCwNG47l3sd9lpfyx9LAGEGItCUeRCWeAx6x2Jmbav65nAwoPXfewtAdtbtit/pJFLUWOhpv0FpS6GQAmPrHA==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.4.tgz", - "integrity": "sha512-BnASypppbUWyqjd1KIpU4AUBiIhVr6YlHx/cnPgqEkNoVOhHg+YiSVxM1RLfiy4t9cAulbRGTNCKOcqHrEQLIw==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-s390x": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.4.tgz", - "integrity": "sha512-+eUqgb/Z7vxVLezG8bVB9SfBie89gMueS+I0xYh2tJdw3vqA/0ImZJ2ROeWwVJN59ihBeZ7Tu92dF/5dy5FttA==", - "cpu": [ - "s390x" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.4.tgz", - "integrity": "sha512-S5qOXrKV8BQEzJPVxAwnryi2+Iq5pB40gTEIT69BQONqR7JH1EPIcQ/Uiv9mCnn05jff9umq/5nqzxlqTOg9NA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.4.tgz", - "integrity": "sha512-xHT8X4sb0GS8qTqiwzHqpY00C95DPAq7nAwX35Ie/s+LO9830hrMd3oX0ZMKLvy7vsonee73x0lmcdOVXFzd6Q==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.4.tgz", - "integrity": "sha512-RugOvOdXfdyi5Tyv40kgQnI0byv66BFgAqjdgtAKqHoZTbTF2QqfQrFwa7cHEORJf6X2ht+l9ABLMP0dnKYsgg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.4.tgz", - "integrity": "sha512-2MyL3IAaTX+1/qP0O1SwskwcwCoOI4kV2IBX1xYnDDqthmq5ArrW94qSIKCAuRraMgPOmG0RDTA74mzYNQA9ow==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.4.tgz", - "integrity": "sha512-u8fg/jQ5aQDfsnIV6+KwLOf1CmJnfu1ShpwqdwC0uA7ZPwFws55Ngc12vBdeUdnuWoQYx/SOQLGDcdlfXhYmXQ==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.4.tgz", - "integrity": "sha512-JkTZrl6VbyO8lDQO3yv26nNr2RM2yZzNrNHEsj9bm6dOwwu9OYN28CjzZkH57bh4w0I2F7IodpQvUAEd1mbWXg==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openharmony" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/sunos-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.4.tgz", - "integrity": "sha512-/gOzgaewZJfeJTlsWhvUEmUG4tWEY2Spp5M20INYRg2ZKl9QPO3QEEgPeRtLjEWSW8FilRNacPOg8R1uaYkA6g==", - "cpu": [ - "x64" - ], + "node_modules/@emnapi/core": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.10.0.tgz", + "integrity": "sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw==", "dev": true, "license": "MIT", "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=18" + "dependencies": { + "@emnapi/wasi-threads": "1.2.1", + "tslib": "^2.4.0" } }, - "node_modules/@esbuild/win32-arm64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.4.tgz", - "integrity": "sha512-Z9SExBg2y32smoDQdf1HRwHRt6vAHLXcxD2uGgO/v2jK7Y718Ix4ndsbNMU/+1Qiem9OiOdaqitioZwxivhXYg==", - "cpu": [ - "arm64" - ], + "node_modules/@emnapi/runtime": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.10.0.tgz", + "integrity": "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA==", "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-ia32": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.4.tgz", - "integrity": "sha512-DAyGLS0Jz5G5iixEbMHi5KdiApqHBWMGzTtMiJ72ZOLhbu/bzxgAe8Ue8CTS3n3HbIUHQz/L51yMdGMeoxXNJw==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" + "dependencies": { + "tslib": "^2.4.0" } }, - "node_modules/@esbuild/win32-x64": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.4.tgz", - "integrity": "sha512-+knoa0BDoeXgkNvvV1vvbZX4+hizelrkwmGJBdT17t8FNPwG2lKemmuMZlmaNQ3ws3DKKCxpb4zRZEIp3UxFCg==", - "cpu": [ - "x64" - ], + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.1.tgz", + "integrity": "sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w==", "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" + "dependencies": { + "tslib": "^2.4.0" } }, "node_modules/@jridgewell/sourcemap-codec": { @@ -489,6 +81,25 @@ "dev": true, "license": "MIT" }, + "node_modules/@napi-rs/wasm-runtime": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.4.tgz", + "integrity": "sha512-3NQNNgA1YSlJb/kMH1ildASP9HW7/7kYnRI2szWJaofaS1hWmbGI4H+d3+22aGzXXN9IJ+n+GiFVcGipJP18ow==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@tybys/wasm-util": "^0.10.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "peerDependencies": { + "@emnapi/core": "^1.7.1", + "@emnapi/runtime": "^1.7.1" + } + }, "node_modules/@octokit/auth-token": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-6.0.0.tgz", @@ -656,24 +267,20 @@ "@octokit/openapi-types": "^27.0.0" } }, - "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.0.tgz", - "integrity": "sha512-WOhNW9K8bR3kf4zLxbfg6Pxu2ybOUbB2AjMDHSQx86LIF4rH4Ft7vmMwNt0loO0eonglSNy4cpD3MKXXKQu0/A==", - "cpu": [ - "arm" - ], + "node_modules/@oxc-project/types": { + "version": "0.133.0", + "resolved": "https://registry.npmjs.org/@oxc-project/types/-/types-0.133.0.tgz", + "integrity": "sha512-KzkdCd6Uxqnf6l3HOw1xfatAlUURA0g14cvBYFyJ5SaNOQbOUvBr9PKArcPcrNIeRsBdgcUzOGrhKveVpvOIGA==", "dev": true, "license": "MIT", - "optional": true, - "os": [ - "android" - ] + "funding": { + "url": "https://github.com/sponsors/Boshen" + } }, - "node_modules/@rollup/rollup-android-arm64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.0.tgz", - "integrity": "sha512-u6JHLll5QKRvjciE78bQXDmqRqNs5M/3GVqZeMwvmjaNODJih/WIrJlFVEihvV0MiYFmd+ZyPr9wxOVbPAG2Iw==", + "node_modules/@rolldown/binding-android-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-android-arm64/-/binding-android-arm64-1.0.3.tgz", + "integrity": "sha512-454rs7jHngixp/NMxd5srYD57OnzSlZ/eFTETjORQHLwJG1lRtmNOJcBerZlfu4GjKqeq8aCCIQrMdHyhI51Hw==", "cpu": [ "arm64" ], @@ -682,12 +289,15 @@ "optional": true, "os": [ "android" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.0.tgz", - "integrity": "sha512-qEF7CsKKzSRc20Ciu2Zw1wRrBz4g56F7r/vRwY430UPp/nt1x21Q/fpJ9N5l47WWvJlkNCPJz3QRVw008fi7yA==", + "node_modules/@rolldown/binding-darwin-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-arm64/-/binding-darwin-arm64-1.0.3.tgz", + "integrity": "sha512-PcAhP+ynjURNyy8SKGl5DQP94aGuB/7JrXJb/t7P+hanXvQVMWzUvRRhBAcg/lNRadBhoUPqSoP4xw5tR/KBEA==", "cpu": [ "arm64" ], @@ -696,12 +306,15 @@ "optional": true, "os": [ "darwin" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.0.tgz", - "integrity": "sha512-WADYozJ4QCnXCH4wPB+3FuGmDPoFseVCUrANmA5LWwGmC6FL14BWC7pcq+FstOZv3baGX65tZ378uT6WG8ynTw==", + "node_modules/@rolldown/binding-darwin-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-x64/-/binding-darwin-x64-1.0.3.tgz", + "integrity": "sha512-9YpfeUvSE2RS7wysJ81uOZkXJz7f7Q55H2Gvp3VEw/EsahqDtrphrZ0EwDLK5vvKOzaCrBsjF8JmnMLcUt78Gg==", "cpu": [ "x64" ], @@ -710,26 +323,15 @@ "optional": true, "os": [ "darwin" - ] - }, - "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.0.tgz", - "integrity": "sha512-6b8wGHJlDrGeSE3aH5mGNHBjA0TTkxdoNHik5EkvPHCt351XnigA4pS7Wsj/Eo9Y8RBU6f35cjN9SYmCFBtzxw==", - "cpu": [ - "arm64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.0.tgz", - "integrity": "sha512-h25Ga0t4jaylMB8M/JKAyrvvfxGRjnPQIR8lnCayyzEjEOx2EJIlIiMbhpWxDRKGKF8jbNH01NnN663dH638mA==", + "node_modules/@rolldown/binding-freebsd-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-freebsd-x64/-/binding-freebsd-x64-1.0.3.tgz", + "integrity": "sha512-yB1IlAsSNHncV6SCTL27/MVGR5htvQsoGxIv5KMGXALp+Ll1wYsn+x98M9MW7qa+NdSbvrrY7ANI4wLJ0n1e6g==", "cpu": [ "x64" ], @@ -738,26 +340,15 @@ "optional": true, "os": [ "freebsd" - ] - }, - "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.0.tgz", - "integrity": "sha512-RzeBwv0B3qtVBWtcuABtSuCzToo2IEAIQrcyB/b2zMvBWVbjo8bZDjACUpnaafaxhTw2W+imQbP2BD1usasK4g==", - "cpu": [ - "arm" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.0.tgz", - "integrity": "sha512-Sf7zusNI2CIU1HLzuu9Tc5YGAHEZs5Lu7N1ssJG4Tkw6e0MEsN7NdjUDDfGNHy2IU+ENyWT+L2obgWiguWibWQ==", + "node_modules/@rolldown/binding-linux-arm-gnueabihf": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm-gnueabihf/-/binding-linux-arm-gnueabihf-1.0.3.tgz", + "integrity": "sha512-Yi30IVAAfLUCy2MseFjbB1jAMDl1VMCAas5StnYp8da9+CKvMd2H2cbEjWcw5NPaPqzvYkVIaF1nNUG+b7u/sw==", "cpu": [ "arm" ], @@ -766,26 +357,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.0.tgz", - "integrity": "sha512-DX2x7CMcrJzsE91q7/O02IJQ5/aLkVtYFryqCjduJhUfGKG6yJV8hxaw8pZa93lLEpPTP/ohdN4wFz7yp/ry9A==", - "cpu": [ - "arm64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.0.tgz", - "integrity": "sha512-09EL+yFVbJZlhcQfShpswwRZ0Rg+z/CsSELFCnPt3iK+iqwGsI4zht3secj5vLEs957QvFFXnzAT0FFPIxSrkQ==", + "node_modules/@rolldown/binding-linux-arm64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-gnu/-/binding-linux-arm64-gnu-1.0.3.tgz", + "integrity": "sha512-jsO7R8To+AdlYgUmN5sHSCZbfhtMBkO0WUx8iORQnPcMMdgr7qM2DQmMwgabs3GhNztdmoKkMKQFHD6DTMCIQw==", "cpu": [ "arm64" ], @@ -794,54 +374,32 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.0.tgz", - "integrity": "sha512-i9IcCMPr3EXm8EQg5jnja0Zyc1iFxJjZWlb4wr7U2Wx/GrddOuEafxRdMPRYVaXjgbhvqalp6np07hN1w9kAKw==", - "cpu": [ - "loong64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-loong64-musl": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.0.tgz", - "integrity": "sha512-DGzdJK9kyJ+B78MCkWeGnpXJ91tK/iKA6HwHxF4TAlPIY7GXEvMe8hBFRgdrR9Ly4qebR/7gfUs9y2IoaVEyog==", + "node_modules/@rolldown/binding-linux-arm64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-musl/-/binding-linux-arm64-musl-1.0.3.tgz", + "integrity": "sha512-VWkUHwWriDciit80wleYwKILoR/KMvxh/IdwS/paX+ZgpuRpCrKLUdadJbc0NpBEiyhpYawsJ73j9aCvOH+f7Q==", "cpu": [ - "loong64" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.0.tgz", - "integrity": "sha512-RwpnLsqC8qbS8z1H1AxBA1H6qknR4YpPR9w2XX0vo2Sz10miu57PkNcnHVaZkbqyw/kUWfKMI73jhmfi9BRMUQ==", - "cpu": [ - "ppc64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-ppc64-musl": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.0.tgz", - "integrity": "sha512-Z8pPf54Ly3aqtdWC3G4rFigZgNvd+qJlOE52fmko3KST9SoGfAdSRCwyoyG05q1HrrAblLbk1/PSIV+80/pxLg==", + "node_modules/@rolldown/binding-linux-ppc64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-ppc64-gnu/-/binding-linux-ppc64-gnu-1.0.3.tgz", + "integrity": "sha512-5f1laC0SlIR0yDbFCd8acUhvJIag6N3zC5P7oUPN6wX0aOma+uKJ0wBDH5aq7I1PVI2ttTlhJwzwRIBnLiSGEg==", "cpu": [ "ppc64" ], @@ -850,40 +408,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.0.tgz", - "integrity": "sha512-3a3qQustp3COCGvnP4SvrMHnPQ9d1vzCakQVRTliaz8cIp/wULGjiGpbcqrkv0WrHTEp8bQD/B3HBjzujVWLOA==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.0.tgz", - "integrity": "sha512-pjZDsVH/1VsghMJ2/kAaxt6dL0psT6ZexQVrijczOf+PeP2BUqTHYejk3l6TlPRydggINOeNRhvpLa0AYpCWSQ==", - "cpu": [ - "riscv64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.0.tgz", - "integrity": "sha512-3ObQs0BhvPgiUVZrN7gqCSvmFuMWvWvsjG5ayJ3Lraqv+2KhOsp+pUbigqbeWqueGIsnn+09HBw27rJ+gYK4VQ==", + "node_modules/@rolldown/binding-linux-s390x-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-s390x-gnu/-/binding-linux-s390x-gnu-1.0.3.tgz", + "integrity": "sha512-Iq4ko0r4XsgbrF/LunNgHtAGLRRVE2kXonAXQ/MV0mC6jQpMOhW1SvtZja2EhC/kd05++bP78dsqBeIQyYJ6Yg==", "cpu": [ "s390x" ], @@ -892,12 +425,15 @@ "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.0.tgz", - "integrity": "sha512-EtylprDtQPdS5rXvAayrNDYoJhIz1/vzN2fEubo3yLE7tfAw+948dO0g4M0vkTVFhKojnF+n6C8bDNe+gDRdTg==", + "node_modules/@rolldown/binding-linux-x64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-gnu/-/binding-linux-x64-gnu-1.0.3.tgz", + "integrity": "sha512-B8m6tD5+/N5FeNQFbKlLA/2yVq9ycQP1SeedyEYYKWBNR3ZQbkvIUcNnDNM03lO1l5F2roiiFJGgvoLLyZXtSg==", "cpu": [ "x64" ], @@ -906,12 +442,15 @@ "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.0.tgz", - "integrity": "sha512-k09oiRCi/bHU9UVFqD17r3eJR9bn03TyKraCrlz5ULFJGdJGi7VOmm9jl44vOJvRJ6P7WuBi/s2A97LxxHGIdw==", + "node_modules/@rolldown/binding-linux-x64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-musl/-/binding-linux-x64-musl-1.0.3.tgz", + "integrity": "sha512-pSdpdUJHkuCxun9LE7jvgUB9qsRgaiyNNCX7m/AvHTcq67AiT/Yhoxvw5zPfhrM8k/BfP8ce/hMOpthKDpEUow==", "cpu": [ "x64" ], @@ -920,26 +459,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-openbsd-x64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.0.tgz", - "integrity": "sha512-1o/0/pIhozoSaDJoDcec+IVLbnRtQmHwPV730+AOD29lHEEo4F5BEUB24H0OBdhbBBDwIOSuf7vgg0Ywxdfiiw==", - "cpu": [ - "x64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.0.tgz", - "integrity": "sha512-pESDkos/PDzYwtyzB5p/UoNU/8fJo68vcXM9ZW2V0kjYayj1KaaUfi1NmTUTUpMn4UhU4gTuK8gIaFO4UGuMbA==", + "node_modules/@rolldown/binding-openharmony-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-openharmony-arm64/-/binding-openharmony-arm64-1.0.3.tgz", + "integrity": "sha512-OXXS3RKJgX2uLwM+gYyuH5omcH8fL1LJs96pZGgtetVCahON57+d4SJHzTgZiOjxgGkSnpXpOsWuPDGAKAigEg==", "cpu": [ "arm64" ], @@ -948,40 +476,51 @@ "optional": true, "os": [ "openharmony" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.0.tgz", - "integrity": "sha512-hj1wFStD7B1YBeYmvY+lWXZ7ey73YGPcViMShYikqKT1GtstIKQAtfUI6yrzPjAy/O7pO0VLXGmUVWXQMaYgTQ==", + "node_modules/@rolldown/binding-wasm32-wasi": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-wasm32-wasi/-/binding-wasm32-wasi-1.0.3.tgz", + "integrity": "sha512-JTtb8BWFynicNSoPrehsCzBtOKjZ6jhMiPFEmOiuXg1Fl8dn2KHQob+GuPSGR0dryQa1PQJbzjF3dqO/whhjLg==", "cpu": [ - "arm64" + "wasm32" ], "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ] + "dependencies": { + "@emnapi/core": "1.10.0", + "@emnapi/runtime": "1.10.0", + "@napi-rs/wasm-runtime": "^1.1.4" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.0.tgz", - "integrity": "sha512-SyaIPFoxmUPlNDq5EHkTbiKzmSEmq/gOYFI/3HHJ8iS/v1mbugVa7dXUzcJGQfoytp9DJFLhHH4U3/eTy2Bq4w==", + "node_modules/@rolldown/binding-win32-arm64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-arm64-msvc/-/binding-win32-arm64-msvc-1.0.3.tgz", + "integrity": "sha512-gEdFFEN70A/jxb2svrWsN3aDL7OUtmvlOy+6fa2jxG8K0wQ1ZbdeLGnidov6Yu5/733dI5ySfzFlQ/cb0bSz1g==", "cpu": [ - "ia32" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "win32" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.0.tgz", - "integrity": "sha512-RdcryEfzZr+lAr5kRm2ucN9aVlCCa2QNq4hXelZxb8GG0NJSazq44Z3PCCc8wISRuCVnGs0lQJVX5Vp6fKA+IA==", + "node_modules/@rolldown/binding-win32-x64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-x64-msvc/-/binding-win32-x64-msvc-1.0.3.tgz", + "integrity": "sha512-eXB7CHuaQdqmJcc3koCNtNPmT/bj2gc999kUFgBxG8Ac0NdgXc4rkCHhqrgrhN3zddvvvrgzj1e90SuSfmyIXA==", "cpu": [ "x64" ], @@ -990,21 +529,35 @@ "optional": true, "os": [ "win32" - ] - }, - "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.0.tgz", - "integrity": "sha512-PrsWNQ8BuE00O3Xsx3ALh2Df8fAj9+cvvX9AIA6o4KpATR98c9mud4XtDWVvsEuyia5U4tVSTKygawyJkjm60w==", - "cpu": [ - "x64" ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.1.tgz", + "integrity": "sha512-2j9bGt5Jh8hj+vPtgzPtl72j0yRxHAyumoo6TNfAjsLB04UtpSvPbPcDcBMxz7n+9CYB0c1GxQFxYRg2jimqGw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", + "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tybys/wasm-util": { + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.2.tgz", + "integrity": "sha512-RoBvJ2X0wuKlWFIjrwffGw1IqZHKQqzIchKaadZZfnNpsAYp2mM0h36JtPCjNDAHGgYez/15uMBpfGwchhiMgg==", "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ] + "dependencies": { + "tslib": "^2.4.0" + } }, "node_modules/@types/chai": { "version": "5.2.3", @@ -1025,9 +578,9 @@ "license": "MIT" }, "node_modules/@types/estree": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", - "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.9.tgz", + "integrity": "sha512-GhdPgy1el4/ImP05X05Uw4cw2/M93BCUmnEvWZNStlCzEKME4Fkk+YpoA5OiHNQmoS7Cafb8Xa3Pya8m1Qrzeg==", "dev": true, "license": "MIT" }, @@ -1042,39 +595,40 @@ } }, "node_modules/@vitest/expect": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", - "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.0.tgz", + "integrity": "sha512-EIxG7k4wlWweuCLG9Y5InKFwpMEOyrMb6ZJ1ihYu02LVj/bzUwn2VMU+13PinsjRW75XnITeFrQBMH5+dLvCDA==", "dev": true, "license": "MIT", "dependencies": { + "@standard-schema/spec": "^1.1.0", "@types/chai": "^5.2.2", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "tinyrainbow": "^2.0.0" + "@vitest/spy": "4.1.0", + "@vitest/utils": "4.1.0", + "chai": "^6.2.2", + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", - "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.0.tgz", + "integrity": "sha512-evxREh+Hork43+Y4IOhTo+h5lGmVRyjqI739Rz4RlUPqwrkFFDF6EMvOOYjTx4E8Tl6gyCLRL8Mu7Ry12a13Tw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "3.2.4", + "@vitest/spy": "4.1.0", "estree-walker": "^3.0.3", - "magic-string": "^0.30.17" + "magic-string": "^0.30.21" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0-0" }, "peerDependenciesMeta": { "msw": { @@ -1086,42 +640,42 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", - "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.0.tgz", + "integrity": "sha512-3RZLZlh88Ib0J7NQTRATfc/3ZPOnSUn2uDBUoGNn5T36+bALixmzphN26OUD3LRXWkJu4H0s5vvUeqBiw+kS0A==", "dev": true, "license": "MIT", "dependencies": { - "tinyrainbow": "^2.0.0" + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", - "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.0.tgz", + "integrity": "sha512-Duvx2OzQ7d6OjchL+trw+aSrb9idh7pnNfxrklo14p3zmNL4qPCDeIJAK+eBKYjkIwG96Bc6vYuxhqDXQOWpoQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "3.2.4", - "pathe": "^2.0.3", - "strip-literal": "^3.0.0" + "@vitest/utils": "4.1.0", + "pathe": "^2.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/snapshot": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", - "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.0.tgz", + "integrity": "sha512-0Vy9euT1kgsnj1CHttwi9i9o+4rRLEaPRSOJ5gyv579GJkNpgJK+B4HSv/rAWixx2wdAFci1X4CEPjiu2bXIMg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.2.4", - "magic-string": "^0.30.17", + "@vitest/pretty-format": "4.1.0", + "@vitest/utils": "4.1.0", + "magic-string": "^0.30.21", "pathe": "^2.0.3" }, "funding": { @@ -1129,28 +683,25 @@ } }, "node_modules/@vitest/spy": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", - "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.0.tgz", + "integrity": "sha512-pz77k+PgNpyMDv2FV6qmk5ZVau6c3R8HC8v342T2xlFxQKTrSeYw9waIJG8KgV9fFwAtTu4ceRzMivPTH6wSxw==", "dev": true, "license": "MIT", - "dependencies": { - "tinyspy": "^4.0.3" - }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/utils": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", - "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.0.tgz", + "integrity": "sha512-XfPXT6a8TZY3dcGY8EdwsBulFCIw+BeeX0RZn2x/BtiY/75YGh8FeWGG8QISN/WhaqSrE2OrlDgtF8q5uhOTmw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.2.4", - "loupe": "^3.1.4", - "tinyrainbow": "^2.0.0" + "@vitest/pretty-format": "4.1.0", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" @@ -1159,134 +710,54 @@ "node_modules/assertion-error": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", - "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - } - }, - "node_modules/before-after-hook": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-4.0.0.tgz", - "integrity": "sha512-q6tR3RPqIB1pMiTRMFcZwuG5T8vwp+vUvEG0vuI6B+Rikh5BfPp2fQ82c925FOs+b0lcFQ8CFrL+KbilfZFhOQ==", - "dev": true, - "license": "Apache-2.0" - }, - "node_modules/cac": { - "version": "6.7.14", - "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", - "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/chai": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", - "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", - "dev": true, - "license": "MIT", - "dependencies": { - "assertion-error": "^2.0.1", - "check-error": "^2.1.1", - "deep-eql": "^5.0.1", - "loupe": "^3.1.0", - "pathval": "^2.0.0" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/check-error": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", - "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", "dev": true, "license": "MIT", "engines": { - "node": ">= 16" + "node": ">=12" } }, - "node_modules/debug": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", - "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "node_modules/before-after-hook": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-4.0.0.tgz", + "integrity": "sha512-q6tR3RPqIB1pMiTRMFcZwuG5T8vwp+vUvEG0vuI6B+Rikh5BfPp2fQ82c925FOs+b0lcFQ8CFrL+KbilfZFhOQ==", "dev": true, - "license": "MIT", - "dependencies": { - "ms": "^2.1.3" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } + "license": "Apache-2.0" }, - "node_modules/deep-eql": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", - "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "node_modules/chai": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/chai/-/chai-6.2.2.tgz", + "integrity": "sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==", "dev": true, "license": "MIT", "engines": { - "node": ">=6" + "node": ">=18" } }, - "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", "dev": true, "license": "MIT" }, - "node_modules/esbuild": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.4.tgz", - "integrity": "sha512-Rq4vbHnYkK5fws5NF7MYTU68FPRE1ajX7heQ/8QXXWqNgqqJ/GkmmyxIzUnf2Sr/bakf8l54716CcMGHYhMrrQ==", + "node_modules/detect-libc": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", + "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", "dev": true, - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, + "license": "Apache-2.0", "engines": { - "node": ">=18" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.4", - "@esbuild/android-arm": "0.27.4", - "@esbuild/android-arm64": "0.27.4", - "@esbuild/android-x64": "0.27.4", - "@esbuild/darwin-arm64": "0.27.4", - "@esbuild/darwin-x64": "0.27.4", - "@esbuild/freebsd-arm64": "0.27.4", - "@esbuild/freebsd-x64": "0.27.4", - "@esbuild/linux-arm": "0.27.4", - "@esbuild/linux-arm64": "0.27.4", - "@esbuild/linux-ia32": "0.27.4", - "@esbuild/linux-loong64": "0.27.4", - "@esbuild/linux-mips64el": "0.27.4", - "@esbuild/linux-ppc64": "0.27.4", - "@esbuild/linux-riscv64": "0.27.4", - "@esbuild/linux-s390x": "0.27.4", - "@esbuild/linux-x64": "0.27.4", - "@esbuild/netbsd-arm64": "0.27.4", - "@esbuild/netbsd-x64": "0.27.4", - "@esbuild/openbsd-arm64": "0.27.4", - "@esbuild/openbsd-x64": "0.27.4", - "@esbuild/openharmony-arm64": "0.27.4", - "@esbuild/sunos-x64": "0.27.4", - "@esbuild/win32-arm64": "0.27.4", - "@esbuild/win32-ia32": "0.27.4", - "@esbuild/win32-x64": "0.27.4" + "node": ">=8" } }, + "node_modules/es-module-lexer": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.1.0.tgz", + "integrity": "sha512-n27zTYMjYu1aj4MjCWzSP7G9r75utsaoc8m61weK+W8JMBGGQybd43GstCXZ3WNmSFtGT9wi59qQTW6mhTR5LQ==", + "dev": true, + "license": "MIT" + }, "node_modules/estree-walker": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", @@ -1357,13 +828,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/js-tokens": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", - "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", - "dev": true, - "license": "MIT" - }, "node_modules/json-with-bigint": { "version": "3.5.8", "resolved": "https://registry.npmjs.org/json-with-bigint/-/json-with-bigint-3.5.8.tgz", @@ -1371,12 +835,266 @@ "dev": true, "license": "MIT" }, - "node_modules/loupe": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", - "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "node_modules/lightningcss": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.32.0.tgz", + "integrity": "sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==", "dev": true, - "license": "MIT" + "license": "MPL-2.0", + "dependencies": { + "detect-libc": "^2.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-android-arm64": "1.32.0", + "lightningcss-darwin-arm64": "1.32.0", + "lightningcss-darwin-x64": "1.32.0", + "lightningcss-freebsd-x64": "1.32.0", + "lightningcss-linux-arm-gnueabihf": "1.32.0", + "lightningcss-linux-arm64-gnu": "1.32.0", + "lightningcss-linux-arm64-musl": "1.32.0", + "lightningcss-linux-x64-gnu": "1.32.0", + "lightningcss-linux-x64-musl": "1.32.0", + "lightningcss-win32-arm64-msvc": "1.32.0", + "lightningcss-win32-x64-msvc": "1.32.0" + } + }, + "node_modules/lightningcss-android-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-android-arm64/-/lightningcss-android-arm64-1.32.0.tgz", + "integrity": "sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.32.0.tgz", + "integrity": "sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.32.0.tgz", + "integrity": "sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.32.0.tgz", + "integrity": "sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.32.0.tgz", + "integrity": "sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.32.0.tgz", + "integrity": "sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.32.0.tgz", + "integrity": "sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.32.0.tgz", + "integrity": "sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.32.0.tgz", + "integrity": "sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-arm64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.32.0.tgz", + "integrity": "sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.32.0.tgz", + "integrity": "sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } }, "node_modules/magic-string": { "version": "0.30.21", @@ -1388,17 +1106,10 @@ "@jridgewell/sourcemap-codec": "^1.5.5" } }, - "node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true, - "license": "MIT" - }, "node_modules/nanoid": { - "version": "3.3.11", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", - "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "version": "3.3.17", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.17.tgz", + "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==", "dev": true, "funding": [ { @@ -1414,6 +1125,17 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, + "node_modules/obug": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/obug/-/obug-2.1.1.tgz", + "integrity": "sha512-uTqF9MuPraAQ+IsnPf366RG4cP9RtUi7MLO1N3KEc+wb0a6yKpeL0lmk2IB1jY5KHPAlTc6T/JRdC/YqxHNwkQ==", + "dev": true, + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT" + }, "node_modules/pathe": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", @@ -1421,16 +1143,6 @@ "dev": true, "license": "MIT" }, - "node_modules/pathval": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", - "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 14.16" - } - }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", @@ -1452,9 +1164,9 @@ } }, "node_modules/postcss": { - "version": "8.5.8", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", - "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "version": "8.5.25", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.25.tgz", + "integrity": "sha512-DTPx3RWSSnWyzLxQnlH0rJP+EW5ekl16ZU4/psbIhA0e53kJfdgaN5vKM+xP7yJtXVu+nfdVFmlgFDEKAe4Pyw==", "dev": true, "funding": [ { @@ -1472,7 +1184,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.11", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -1480,49 +1192,38 @@ "node": "^10 || ^12 || >=14" } }, - "node_modules/rollup": { - "version": "4.60.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.0.tgz", - "integrity": "sha512-yqjxruMGBQJ2gG4HtjZtAfXArHomazDHoFwFFmZZl0r7Pdo7qCIXKqKHZc8yeoMgzJJ+pO6pEEHa+V7uzWlrAQ==", + "node_modules/rolldown": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/rolldown/-/rolldown-1.0.3.tgz", + "integrity": "sha512-i00lAJ2ks1BYr7rjNjKC7BcqAS7nVfiT3QX1SI5aY+AFHblCmaUf9OE9dbdzDvW6dJxbi2ZCZiy9v3CcwOiX3g==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.8" + "@oxc-project/types": "=0.133.0", + "@rolldown/pluginutils": "^1.0.0" }, "bin": { - "rollup": "dist/bin/rollup" + "rolldown": "bin/cli.mjs" }, "engines": { - "node": ">=18.0.0", - "npm": ">=8.0.0" + "node": "^20.19.0 || >=22.12.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.60.0", - "@rollup/rollup-android-arm64": "4.60.0", - "@rollup/rollup-darwin-arm64": "4.60.0", - "@rollup/rollup-darwin-x64": "4.60.0", - "@rollup/rollup-freebsd-arm64": "4.60.0", - "@rollup/rollup-freebsd-x64": "4.60.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.60.0", - "@rollup/rollup-linux-arm-musleabihf": "4.60.0", - "@rollup/rollup-linux-arm64-gnu": "4.60.0", - "@rollup/rollup-linux-arm64-musl": "4.60.0", - "@rollup/rollup-linux-loong64-gnu": "4.60.0", - "@rollup/rollup-linux-loong64-musl": "4.60.0", - "@rollup/rollup-linux-ppc64-gnu": "4.60.0", - "@rollup/rollup-linux-ppc64-musl": "4.60.0", - "@rollup/rollup-linux-riscv64-gnu": "4.60.0", - "@rollup/rollup-linux-riscv64-musl": "4.60.0", - "@rollup/rollup-linux-s390x-gnu": "4.60.0", - "@rollup/rollup-linux-x64-gnu": "4.60.0", - "@rollup/rollup-linux-x64-musl": "4.60.0", - "@rollup/rollup-openbsd-x64": "4.60.0", - "@rollup/rollup-openharmony-arm64": "4.60.0", - "@rollup/rollup-win32-arm64-msvc": "4.60.0", - "@rollup/rollup-win32-ia32-msvc": "4.60.0", - "@rollup/rollup-win32-x64-gnu": "4.60.0", - "@rollup/rollup-win32-x64-msvc": "4.60.0", - "fsevents": "~2.3.2" + "@rolldown/binding-android-arm64": "1.0.3", + "@rolldown/binding-darwin-arm64": "1.0.3", + "@rolldown/binding-darwin-x64": "1.0.3", + "@rolldown/binding-freebsd-x64": "1.0.3", + "@rolldown/binding-linux-arm-gnueabihf": "1.0.3", + "@rolldown/binding-linux-arm64-gnu": "1.0.3", + "@rolldown/binding-linux-arm64-musl": "1.0.3", + "@rolldown/binding-linux-ppc64-gnu": "1.0.3", + "@rolldown/binding-linux-s390x-gnu": "1.0.3", + "@rolldown/binding-linux-x64-gnu": "1.0.3", + "@rolldown/binding-linux-x64-musl": "1.0.3", + "@rolldown/binding-openharmony-arm64": "1.0.3", + "@rolldown/binding-wasm32-wasi": "1.0.3", + "@rolldown/binding-win32-arm64-msvc": "1.0.3", + "@rolldown/binding-win32-x64-msvc": "1.0.3" } }, "node_modules/siginfo": { @@ -1550,25 +1251,12 @@ "license": "MIT" }, "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.1.0.tgz", + "integrity": "sha512-Rq7ybcX2RuC55r9oaPVEW7/xu3tj8u4GeBYHBWCychFtzMIr86A7e3PPEBPT37sHStKX3+TiX/Fr/ACmJLVlLQ==", "dev": true, "license": "MIT" }, - "node_modules/strip-literal": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", - "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", - "dev": true, - "license": "MIT", - "dependencies": { - "js-tokens": "^9.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, "node_modules/tinybench": { "version": "2.9.0", "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", @@ -1577,21 +1265,24 @@ "license": "MIT" }, "node_modules/tinyexec": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", - "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.2.4.tgz", + "integrity": "sha512-SHf/r48b7vOrjve9PxJo3MN5v5yuyjHvdUcrQffT3WXMUfnGmHDVbC4k3sHJaJTgZCwpUplIaAo5ANtMyp3YHg==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/tinyglobby": { - "version": "0.2.15", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", - "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "version": "0.2.17", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", + "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "dev": true, "license": "MIT", "dependencies": { "fdir": "^6.5.0", - "picomatch": "^4.0.3" + "picomatch": "^4.0.4" }, "engines": { "node": ">=12.0.0" @@ -1600,35 +1291,23 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, - "node_modules/tinypool": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", - "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, "node_modules/tinyrainbow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", - "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", "dev": true, "license": "MIT", "engines": { "node": ">=14.0.0" } }, - "node_modules/tinyspy": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", - "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.0.0" - } + "license": "0BSD", + "optional": true }, "node_modules/tunnel": { "version": "0.0.6", @@ -1655,9 +1334,9 @@ } }, "node_modules/undici": { - "version": "6.24.1", - "resolved": "https://registry.npmjs.org/undici/-/undici-6.24.1.tgz", - "integrity": "sha512-sC+b0tB1whOCzbtlx20fx3WgCXwkW627p4EA9uM+/tNNPkSS+eSEld6pAs9nDv7WbY1UUljBMYPtu9BCOrCWKA==", + "version": "6.28.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-6.28.0.tgz", + "integrity": "sha512-LIY910g9TI13YS95lrMFrs8Rm/u/irgHeTWoKCoteeJ04CUJ92eEfj0rVn+7VKMPBpUPiUoBKfhNyLI23EE/KA==", "dev": true, "license": "MIT", "engines": { @@ -1679,18 +1358,17 @@ "license": "ISC" }, "node_modules/vite": { - "version": "7.3.2", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz", - "integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==", + "version": "8.0.16", + "resolved": "https://registry.npmjs.org/vite/-/vite-8.0.16.tgz", + "integrity": "sha512-h9bXPmJichP5fLmVQo3PyaGSDE2n3aPuomeAlVRm0JLmt4rY6zmPKd59HYI4LNW8oTK7tlTsuC7l/m7awx9Jcw==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.27.0", - "fdir": "^6.5.0", - "picomatch": "^4.0.3", - "postcss": "^8.5.6", - "rollup": "^4.43.0", - "tinyglobby": "^0.2.15" + "lightningcss": "^1.32.0", + "picomatch": "^4.0.4", + "postcss": "^8.5.15", + "rolldown": "1.0.3", + "tinyglobby": "^0.2.17" }, "bin": { "vite": "bin/vite.js" @@ -1706,9 +1384,10 @@ }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", + "@vitejs/devtools": "^0.1.18", + "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", - "lightningcss": "^1.21.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", @@ -1721,13 +1400,16 @@ "@types/node": { "optional": true }, - "jiti": { + "@vitejs/devtools": { "optional": true }, - "less": { + "esbuild": { + "optional": true + }, + "jiti": { "optional": true }, - "lightningcss": { + "less": { "optional": true }, "sass": { @@ -1753,89 +1435,72 @@ } } }, - "node_modules/vite-node": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", - "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cac": "^6.7.14", - "debug": "^4.4.1", - "es-module-lexer": "^1.7.0", - "pathe": "^2.0.3", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" - }, - "bin": { - "vite-node": "vite-node.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, "node_modules/vitest": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", - "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.0.tgz", + "integrity": "sha512-YbDrMF9jM2Lqc++2530UourxZHmkKLxrs4+mYhEwqWS97WJ7wOYEkcr+QfRgJ3PW9wz3odRijLZjHEaRLTNbqw==", "dev": true, "license": "MIT", "dependencies": { - "@types/chai": "^5.2.2", - "@vitest/expect": "3.2.4", - "@vitest/mocker": "3.2.4", - "@vitest/pretty-format": "^3.2.4", - "@vitest/runner": "3.2.4", - "@vitest/snapshot": "3.2.4", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "debug": "^4.4.1", - "expect-type": "^1.2.1", - "magic-string": "^0.30.17", + "@vitest/expect": "4.1.0", + "@vitest/mocker": "4.1.0", + "@vitest/pretty-format": "4.1.0", + "@vitest/runner": "4.1.0", + "@vitest/snapshot": "4.1.0", + "@vitest/spy": "4.1.0", + "@vitest/utils": "4.1.0", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", + "magic-string": "^0.30.21", + "obug": "^2.1.1", "pathe": "^2.0.3", - "picomatch": "^4.0.2", - "std-env": "^3.9.0", + "picomatch": "^4.0.3", + "std-env": "^4.0.0-rc.1", "tinybench": "^2.9.0", - "tinyexec": "^0.3.2", - "tinyglobby": "^0.2.14", - "tinypool": "^1.1.1", - "tinyrainbow": "^2.0.0", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", - "vite-node": "3.2.4", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tinyrainbow": "^3.0.3", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0-0", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.0.0 || ^22.0.0 || >=24.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/debug": "^4.1.12", - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.2.4", - "@vitest/ui": "3.2.4", + "@opentelemetry/api": "^1.9.0", + "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", + "@vitest/browser-playwright": "4.1.0", + "@vitest/browser-preview": "4.1.0", + "@vitest/browser-webdriverio": "4.1.0", + "@vitest/ui": "4.1.0", "happy-dom": "*", - "jsdom": "*" + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0-0" }, "peerDependenciesMeta": { "@edge-runtime/vm": { "optional": true }, - "@types/debug": { + "@opentelemetry/api": { "optional": true }, "@types/node": { "optional": true }, - "@vitest/browser": { + "@vitest/browser-playwright": { + "optional": true + }, + "@vitest/browser-preview": { + "optional": true + }, + "@vitest/browser-webdriverio": { "optional": true }, "@vitest/ui": { @@ -1846,6 +1511,9 @@ }, "jsdom": { "optional": true + }, + "vite": { + "optional": false } } }, diff --git a/scripts/corrections/package.json b/scripts/corrections/package.json index 870d74567..0afee52cc 100644 --- a/scripts/corrections/package.json +++ b/scripts/corrections/package.json @@ -10,6 +10,6 @@ "@octokit/rest": "^22.0.1", "@types/node": "^22.0.0", "typescript": "^5.8.0", - "vitest": "^3.1.0" + "vitest": "^4.1.0" } } diff --git a/scripts/docs-validation/package-lock.json b/scripts/docs-validation/package-lock.json index 6400dec34..0c2751fa7 100644 --- a/scripts/docs-validation/package-lock.json +++ b/scripts/docs-validation/package-lock.json @@ -9,14 +9,14 @@ "version": "1.0.0", "dependencies": { "glob": "^11.0.0", - "tsx": "^4.19.0", + "tsx": "^4.22.4", "typescript": "^5.7.0" } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.2.tgz", - "integrity": "sha512-GZMB+a0mOMZs4MpDbj8RJp4cw+w1WV5NYD6xzgvzUJ5Ek2jerwfO2eADyI6ExDSUED+1X8aMbegahsJi+8mgpw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -30,9 +30,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.2.tgz", - "integrity": "sha512-DVNI8jlPa7Ujbr1yjU2PfUSRtAUZPG9I1RwW4F4xFB1Imiu2on0ADiI/c3td+KmDtVKNbi+nffGDQMfcIMkwIA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -46,9 +46,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.2.tgz", - "integrity": "sha512-pvz8ZZ7ot/RBphf8fv60ljmaoydPU12VuXHImtAs0XhLLw+EXBi2BLe3OYSBslR4rryHvweW5gmkKFwTiFy6KA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -62,9 +62,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.2.tgz", - "integrity": "sha512-z8Ank4Byh4TJJOh4wpz8g2vDy75zFL0TlZlkUkEwYXuPSgX8yzep596n6mT7905kA9uHZsf/o2OJZubl2l3M7A==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -78,9 +78,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.2.tgz", - "integrity": "sha512-davCD2Zc80nzDVRwXTcQP/28fiJbcOwvdolL0sOiOsbwBa72kegmVU0Wrh1MYrbuCL98Omp5dVhQFWRKR2ZAlg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -94,9 +94,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.2.tgz", - "integrity": "sha512-ZxtijOmlQCBWGwbVmwOF/UCzuGIbUkqB1faQRf5akQmxRJ1ujusWsb3CVfk/9iZKr2L5SMU5wPBi1UWbvL+VQA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -110,9 +110,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.2.tgz", - "integrity": "sha512-lS/9CN+rgqQ9czogxlMcBMGd+l8Q3Nj1MFQwBZJyoEKI50XGxwuzznYdwcav6lpOGv5BqaZXqvBSiB/kJ5op+g==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -126,9 +126,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.2.tgz", - "integrity": "sha512-tAfqtNYb4YgPnJlEFu4c212HYjQWSO/w/h/lQaBK7RbwGIkBOuNKQI9tqWzx7Wtp7bTPaGC6MJvWI608P3wXYA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -142,9 +142,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.2.tgz", - "integrity": "sha512-vWfq4GaIMP9AIe4yj1ZUW18RDhx6EPQKjwe7n8BbIecFtCQG4CfHGaHuh7fdfq+y3LIA2vGS/o9ZBGVxIDi9hw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -158,9 +158,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.2.tgz", - "integrity": "sha512-hYxN8pr66NsCCiRFkHUAsxylNOcAQaxSSkHMMjcpx0si13t1LHFphxJZUiGwojB1a/Hd5OiPIqDdXONia6bhTw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -174,9 +174,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.2.tgz", - "integrity": "sha512-MJt5BRRSScPDwG2hLelYhAAKh9imjHK5+NE/tvnRLbIqUWa+0E9N4WNMjmp/kXXPHZGqPLxggwVhz7QP8CTR8w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -190,9 +190,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.2.tgz", - "integrity": "sha512-lugyF1atnAT463aO6KPshVCJK5NgRnU4yb3FUumyVz+cGvZbontBgzeGFO1nF+dPueHD367a2ZXe1NtUkAjOtg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -206,9 +206,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.2.tgz", - "integrity": "sha512-nlP2I6ArEBewvJ2gjrrkESEZkB5mIoaTswuqNFRv/WYd+ATtUpe9Y09RnJvgvdag7he0OWgEZWhviS1OTOKixw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -222,9 +222,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.2.tgz", - "integrity": "sha512-C92gnpey7tUQONqg1n6dKVbx3vphKtTHJaNG2Ok9lGwbZil6DrfyecMsp9CrmXGQJmZ7iiVXvvZH6Ml5hL6XdQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -238,9 +238,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.2.tgz", - "integrity": "sha512-B5BOmojNtUyN8AXlK0QJyvjEZkWwy/FKvakkTDCziX95AowLZKR6aCDhG7LeF7uMCXEJqwa8Bejz5LTPYm8AvA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -254,9 +254,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.2.tgz", - "integrity": "sha512-p4bm9+wsPwup5Z8f4EpfN63qNagQ47Ua2znaqGH6bqLlmJ4bx97Y9JdqxgGZ6Y8xVTixUnEkoKSHcpRlDnNr5w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -270,9 +270,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.2.tgz", - "integrity": "sha512-uwp2Tip5aPmH+NRUwTcfLb+W32WXjpFejTIOWZFw/v7/KnpCDKG66u4DLcurQpiYTiYwQ9B7KOeMJvLCu/OvbA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -286,9 +286,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.2.tgz", - "integrity": "sha512-Kj6DiBlwXrPsCRDeRvGAUb/LNrBASrfqAIok+xB0LxK8CHqxZ037viF13ugfsIpePH93mX7xfJp97cyDuTZ3cw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -302,9 +302,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.2.tgz", - "integrity": "sha512-HwGDZ0VLVBY3Y+Nw0JexZy9o/nUAWq9MlV7cahpaXKW6TOzfVno3y3/M8Ga8u8Yr7GldLOov27xiCnqRZf0tCA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -318,9 +318,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.2.tgz", - "integrity": "sha512-DNIHH2BPQ5551A7oSHD0CKbwIA/Ox7+78/AWkbS5QoRzaqlev2uFayfSxq68EkonB+IKjiuxBFoV8ESJy8bOHA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -334,9 +334,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.2.tgz", - "integrity": "sha512-/it7w9Nb7+0KFIzjalNJVR5bOzA9Vay+yIPLVHfIQYG/j+j9VTH84aNB8ExGKPU4AzfaEvN9/V4HV+F+vo8OEg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -350,9 +350,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.2.tgz", - "integrity": "sha512-LRBbCmiU51IXfeXk59csuX/aSaToeG7w48nMwA6049Y4J4+VbWALAuXcs+qcD04rHDuSCSRKdmY63sruDS5qag==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -366,9 +366,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.2.tgz", - "integrity": "sha512-kMtx1yqJHTmqaqHPAzKCAkDaKsffmXkPHThSfRwZGyuqyIeBvf08KSsYXl+abf5HDAPMJIPnbBfXvP2ZC2TfHg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -382,9 +382,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.2.tgz", - "integrity": "sha512-Yaf78O/B3Kkh+nKABUF++bvJv5Ijoy9AN1ww904rOXZFLWVc5OLOfL56W+C8F9xn5JQZa3UX6m+IktJnIb1Jjg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -398,9 +398,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.2.tgz", - "integrity": "sha512-Iuws0kxo4yusk7sw70Xa2E2imZU5HoixzxfGCdxwBdhiDgt9vX9VUCBhqcwY7/uh//78A1hMkkROMJq9l27oLQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -414,9 +414,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.2.tgz", - "integrity": "sha512-sRdU18mcKf7F+YgheI/zGf5alZatMUTKj/jNS6l744f9u3WFu4v7twcUI9vu4mknF4Y9aDlblIie0IM+5xxaqQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -480,15 +480,15 @@ } }, "node_modules/brace-expansion": { - "version": "5.0.6", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.6.tgz", - "integrity": "sha512-kLpxurY4Z4r9sgMsyG0Z9uzsBlgiU/EFKhj/h91/8yHu0edo7XuixOIH3VcJ8kkxs6/jPzoI6U9Vj3WqbMQ94g==", + "version": "5.0.9", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.9.tgz", + "integrity": "sha512-ScQ4IuvIEF1TMlP7Zt+vjJ//9zlPb2SDcxWxM3bk8s6t6GGdJ7KO1dCcTidOPJKePW30LE/2cT7wCyPho9/Wxg==", "license": "MIT", "dependencies": { "balanced-match": "^4.0.2" }, "engines": { - "node": "18 || 20 || >=22" + "node": "20 || >=22" } }, "node_modules/color-convert": { @@ -536,9 +536,9 @@ "license": "MIT" }, "node_modules/esbuild": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.2.tgz", - "integrity": "sha512-HyNQImnsOC7X9PMNaCIeAm4ISCQXs5a5YasTXVliKv4uuBo1dKrG0A+uQS8M5eXjVMnLg3WgXaKvprHlFJQffw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "hasInstallScript": true, "license": "MIT", "bin": { @@ -548,32 +548,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.2", - "@esbuild/android-arm": "0.27.2", - "@esbuild/android-arm64": "0.27.2", - "@esbuild/android-x64": "0.27.2", - "@esbuild/darwin-arm64": "0.27.2", - "@esbuild/darwin-x64": "0.27.2", - "@esbuild/freebsd-arm64": "0.27.2", - "@esbuild/freebsd-x64": "0.27.2", - "@esbuild/linux-arm": "0.27.2", - "@esbuild/linux-arm64": "0.27.2", - "@esbuild/linux-ia32": "0.27.2", - "@esbuild/linux-loong64": "0.27.2", - "@esbuild/linux-mips64el": "0.27.2", - "@esbuild/linux-ppc64": "0.27.2", - "@esbuild/linux-riscv64": "0.27.2", - "@esbuild/linux-s390x": "0.27.2", - "@esbuild/linux-x64": "0.27.2", - "@esbuild/netbsd-arm64": "0.27.2", - "@esbuild/netbsd-x64": "0.27.2", - "@esbuild/openbsd-arm64": "0.27.2", - "@esbuild/openbsd-x64": "0.27.2", - "@esbuild/openharmony-arm64": "0.27.2", - "@esbuild/sunos-x64": "0.27.2", - "@esbuild/win32-arm64": "0.27.2", - "@esbuild/win32-ia32": "0.27.2", - "@esbuild/win32-x64": "0.27.2" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/foreground-child": { @@ -606,18 +606,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-tsconfig": { - "version": "4.13.1", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.1.tgz", - "integrity": "sha512-EoY1N2xCn44xU6750Sx7OjOIT59FkmstNc3X6y5xpz7D5cBtZRe/3pSlTkDJgqsOk3WwZPkWfonhhUJfttQo3w==", - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, "node_modules/glob": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz", @@ -736,15 +724,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", @@ -875,13 +854,12 @@ } }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" diff --git a/scripts/docs-validation/package.json b/scripts/docs-validation/package.json index e2f40b8ee..a7e881ba4 100644 --- a/scripts/docs-validation/package.json +++ b/scripts/docs-validation/package.json @@ -14,7 +14,7 @@ }, "dependencies": { "glob": "^11.0.0", - "tsx": "^4.19.0", + "tsx": "^4.22.4", "typescript": "^5.7.0" } } diff --git a/scripts/docs-validation/validate.ts b/scripts/docs-validation/validate.ts index b609ef859..6ce615eab 100644 --- a/scripts/docs-validation/validate.ts +++ b/scripts/docs-validation/validate.ts @@ -385,13 +385,16 @@ async function validateJava(): Promise { fs.copyFileSync(path.join(javaDir, file), path.join(srcDir, file)); } - // Read the SDK version from java/pom.xml - const sdkPomPath = path.join(ROOT_DIR, "java", "pom.xml"); + // Read the inherited SDK version from java/sdk/pom.xml + const sdkPomPath = path.join(ROOT_DIR, "java", "sdk", "pom.xml"); const sdkPomContent = fs.readFileSync(sdkPomPath, "utf-8"); const versionMatch = sdkPomContent.match( - /copilot-sdk-java<\/artifactId>\s*([^<]+)<\/version>/, + /[\s\S]*?([^<]+)<\/version>[\s\S]*?<\/parent>/, ); - const sdkVersion = versionMatch ? versionMatch[1] : "1.0.0-SNAPSHOT"; + if (!versionMatch) { + throw new Error(`Could not read the Java SDK version from ${sdkPomPath}`); + } + const sdkVersion = versionMatch[1]; // Create pom.xml that references the local SDK const pomXml = ` diff --git a/test/harness/anthropicMessagesAdapter.ts b/test/harness/anthropicMessagesAdapter.ts new file mode 100644 index 000000000..acc74a2bf --- /dev/null +++ b/test/harness/anthropicMessagesAdapter.ts @@ -0,0 +1,396 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import type { ChatCompletion } from "openai/resources/chat/completions"; +import { + CanonicalMessage, + CanonicalToolCall, + formatSseEvent, + functionToolCalls, + isObject, + JsonObject, +} from "./modelProtocolAdapterShared"; + +export const anthropicMessagesEndpoint = "/v1/messages"; + +type CanonicalContentPart = + | { type: "text"; text: string } + | { type: "image_url"; image_url: { url: string } } + | { + type: "file"; + file: { file_data: string; filename?: string }; + }; + +type AnthropicContentBlock = + | { type: "text"; text: string; citations?: null } + | { + type: "image" | "document"; + source?: { type?: string; media_type?: string; data?: string }; + } + | { type: "tool_use"; id: string; name: string; input: unknown } + | { + type: "tool_result"; + tool_use_id?: string; + content?: string | Array<{ type?: string; text?: string }>; + }; + +type AnthropicMessageParam = { + role: "user" | "assistant"; + content: string | AnthropicContentBlock[]; +}; + +type AnthropicRequest = { + model: string; + messages: AnthropicMessageParam[]; + system?: string | Array<{ type?: string; text?: string }>; + max_tokens?: number; + temperature?: number; + top_p?: number; + stream?: boolean; + tools?: Array<{ + name: string; + description?: string; + input_schema?: JsonObject; + }>; + tool_choice?: + | { type: "auto" | "any" | "none" } + | { type: "tool"; name: string }; +}; + +type AnthropicStopReason = + | "end_turn" + | "max_tokens" + | "stop_sequence" + | "tool_use" + | "refusal"; + +export type AnthropicMessage = { + id: string; + type: "message"; + role: "assistant"; + content: Array< + | { type: "text"; text: string; citations: null } + | { type: "tool_use"; id: string; name: string; input: unknown } + >; + model: string; + stop_reason: AnthropicStopReason | null; + stop_sequence: string | null; + usage: { + input_tokens: number; + output_tokens: number; + cache_creation_input_tokens: number | null; + cache_read_input_tokens: number | null; + }; +}; + +const finishReasonToStopReason: Record = { + stop: "end_turn", + length: "max_tokens", + tool_calls: "tool_use", + function_call: "tool_use", + content_filter: "refusal", +}; + +export function anthropicMessagesRequestToChatCompletion( + requestBody: string, +): string { + const request = JSON.parse(requestBody) as AnthropicRequest; + const messages: CanonicalMessage[] = []; + + const system = anthropicSystemToString(request.system); + if (system) messages.push({ role: "system", content: system }); + + for (const message of request.messages) { + messages.push(...convertAnthropicMessage(message)); + } + + return JSON.stringify({ + model: request.model, + messages, + ...(request.max_tokens !== undefined + ? { max_tokens: request.max_tokens } + : {}), + ...(request.temperature !== undefined + ? { temperature: request.temperature } + : {}), + ...(request.top_p !== undefined ? { top_p: request.top_p } : {}), + ...(request.stream !== undefined ? { stream: request.stream } : {}), + ...(request.tools + ? { + tools: request.tools.map((tool) => ({ + type: "function", + function: { + name: tool.name, + ...(tool.description ? { description: tool.description } : {}), + parameters: tool.input_schema ?? { + type: "object", + properties: {}, + }, + }, + })), + } + : {}), + ...(request.tool_choice + ? { tool_choice: convertToolChoice(request.tool_choice) } + : {}), + }); +} + +function anthropicSystemToString( + system: AnthropicRequest["system"], +): string | undefined { + if (typeof system === "string") return system; + if (!Array.isArray(system)) return undefined; + return system + .map((block) => (typeof block.text === "string" ? block.text : "")) + .filter(Boolean) + .join("\n"); +} + +function convertAnthropicMessage( + message: AnthropicMessageParam, +): CanonicalMessage[] { + return message.role === "user" + ? convertAnthropicUserMessage(message) + : convertAnthropicAssistantMessage(message); +} + +function normalizeContent( + content: AnthropicMessageParam["content"], +): AnthropicContentBlock[] { + return typeof content === "string" + ? [{ type: "text", text: content }] + : content; +} + +function convertAnthropicUserMessage( + message: AnthropicMessageParam, +): CanonicalMessage[] { + const result: CanonicalMessage[] = []; + const contentParts: CanonicalContentPart[] = []; + + const flushUserContent = () => { + if (contentParts.length === 0) return; + const onlyText = contentParts.every((part) => part.type === "text"); + result.push({ + role: "user", + content: onlyText + ? contentParts + .map((part) => (part.type === "text" ? part.text : "")) + .join("\n") + : [...contentParts], + }); + contentParts.length = 0; + }; + + for (const block of normalizeContent(message.content)) { + if (block.type === "text") { + contentParts.push({ type: "text", text: block.text }); + } else if ( + (block.type === "image" || block.type === "document") && + block.source?.type === "base64" && + block.source.data + ) { + const dataUrl = `data:${ + block.source.media_type ?? + (block.type === "image" ? "image/png" : "application/pdf") + };base64,${block.source.data}`; + contentParts.push( + block.type === "image" + ? { type: "image_url", image_url: { url: dataUrl } } + : { type: "file", file: { file_data: dataUrl } }, + ); + } else if (block.type === "tool_result") { + flushUserContent(); + result.push({ + role: "tool", + tool_call_id: block.tool_use_id ?? "", + content: anthropicToolResultContent(block.content), + }); + } + } + + flushUserContent(); + return result; +} + +function convertAnthropicAssistantMessage( + message: AnthropicMessageParam, +): CanonicalMessage[] { + const text: string[] = []; + const toolCalls: CanonicalToolCall[] = []; + for (const block of normalizeContent(message.content)) { + if (block.type === "text") { + text.push(block.text); + } else if (block.type === "tool_use") { + toolCalls.push({ + id: block.id, + type: "function", + function: { + name: block.name, + arguments: JSON.stringify(block.input ?? {}), + }, + }); + } + } + + return [ + { + role: "assistant", + content: text.length ? text.join("") : null, + ...(toolCalls.length ? { tool_calls: toolCalls } : {}), + }, + ]; +} + +function anthropicToolResultContent(content: unknown): string { + if (typeof content === "string") return content; + if (!Array.isArray(content)) return ""; + return content + .map((part) => + isObject(part) && typeof part.text === "string" ? part.text : "", + ) + .filter(Boolean) + .join("\n"); +} + +function convertToolChoice( + choice: NonNullable, +): unknown { + switch (choice.type) { + case "auto": + return "auto"; + case "any": + return "required"; + case "none": + return "none"; + case "tool": + return { type: "function", function: { name: choice.name } }; + } +} + +export function chatCompletionResponseToAnthropicMessage( + response: ChatCompletion, +): AnthropicMessage { + const content: AnthropicMessage["content"] = []; + for (const choice of response.choices) { + if (choice.message.content) { + content.push({ + type: "text", + text: choice.message.content, + citations: null, + }); + } + for (const toolCall of functionToolCalls(choice.message)) { + content.push({ + type: "tool_use", + id: toolCall.id, + name: toolCall.function.name, + input: safeParseJson(toolCall.function.arguments), + }); + } + } + + const finishReason = response.choices.at(-1)?.finish_reason; + return { + id: response.id, + type: "message", + role: "assistant", + content, + model: response.model, + stop_reason: finishReason + ? (finishReasonToStopReason[finishReason] ?? null) + : null, + stop_sequence: null, + usage: { + input_tokens: response.usage?.prompt_tokens ?? 0, + output_tokens: response.usage?.completion_tokens ?? 0, + cache_creation_input_tokens: null, + cache_read_input_tokens: null, + }, + }; +} + +export function chatCompletionResponseToAnthropicSseChunks( + response: ChatCompletion, +): string[] { + const message = chatCompletionResponseToAnthropicMessage(response); + const chunks = [ + formatSseEvent("message_start", { + type: "message_start", + message: { + ...message, + content: [], + stop_reason: null, + usage: { ...message.usage, output_tokens: 1 }, + }, + }), + ]; + + for (let index = 0; index < message.content.length; index++) { + const block = message.content[index]; + if (block.type === "text") { + chunks.push( + formatSseEvent("content_block_start", { + type: "content_block_start", + index, + content_block: { type: "text", text: "", citations: null }, + }), + formatSseEvent("content_block_delta", { + type: "content_block_delta", + index, + delta: { type: "text_delta", text: block.text }, + }), + ); + } else { + chunks.push( + formatSseEvent("content_block_start", { + type: "content_block_start", + index, + content_block: { + type: "tool_use", + id: block.id, + name: block.name, + input: {}, + }, + }), + formatSseEvent("content_block_delta", { + type: "content_block_delta", + index, + delta: { + type: "input_json_delta", + partial_json: JSON.stringify(block.input ?? {}), + }, + }), + ); + } + chunks.push( + formatSseEvent("content_block_stop", { + type: "content_block_stop", + index, + }), + ); + } + + chunks.push( + formatSseEvent("message_delta", { + type: "message_delta", + delta: { + stop_reason: message.stop_reason, + stop_sequence: message.stop_sequence, + }, + usage: { output_tokens: message.usage.output_tokens }, + }), + formatSseEvent("message_stop", { type: "message_stop" }), + ); + return chunks; +} + +function safeParseJson(value: string): unknown { + try { + return JSON.parse(value); + } catch { + return {}; + } +} diff --git a/test/harness/modelProtocolAdapterShared.ts b/test/harness/modelProtocolAdapterShared.ts new file mode 100644 index 000000000..1f879da5d --- /dev/null +++ b/test/harness/modelProtocolAdapterShared.ts @@ -0,0 +1,39 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +export type JsonObject = Record; + +export type CanonicalToolCall = { + id: string; + type: "function"; + function: { name: string; arguments: string }; +}; + +export type CanonicalMessage = { + role: "system" | "user" | "assistant" | "tool"; + content?: string | unknown[] | null; + tool_call_id?: string; + tool_calls?: CanonicalToolCall[]; +}; + +export function functionToolCalls(message: unknown): CanonicalToolCall[] { + if (!isObject(message) || !Array.isArray(message.tool_calls)) return []; + return message.tool_calls.filter( + (toolCall): toolCall is CanonicalToolCall => + isObject(toolCall) && + typeof toolCall.id === "string" && + toolCall.type === "function" && + isObject(toolCall.function) && + typeof toolCall.function.name === "string" && + typeof toolCall.function.arguments === "string", + ); +} + +export function formatSseEvent(type: string, data: unknown): string { + return `event: ${type}\ndata: ${JSON.stringify(data)}\n\n`; +} + +export function isObject(value: unknown): value is JsonObject { + return value !== null && typeof value === "object" && !Array.isArray(value); +} diff --git a/test/harness/modelProtocolAdapters.test.ts b/test/harness/modelProtocolAdapters.test.ts new file mode 100644 index 000000000..ddb6fe40b --- /dev/null +++ b/test/harness/modelProtocolAdapters.test.ts @@ -0,0 +1,641 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import type { ChatCompletion } from "openai/resources/chat/completions"; +import { afterEach, beforeEach, describe, expect, test } from "vitest"; +import yaml from "yaml"; +import { + anthropicMessagesRequestToChatCompletion, + chatCompletionResponseToAnthropicMessage, + chatCompletionResponseToAnthropicSseChunks, +} from "./anthropicMessagesAdapter"; +import { + chatCompletionResponseToResponsesApiMessage, + chatCompletionResponseToResponsesApiSseChunks, + responsesApiRequestToChatCompletion, +} from "./responsesApiAdapter"; +import { + NormalizedData, + ReplayBackend, + ReplayingCapiProxy, +} from "./replayingCapiProxy"; + +type ByokBackend = Exclude; + +const backends: ReplayBackend[] = [ + "capi", + "anthropic-messages", + "openai-responses", + "openai-completions", +]; + +const endpoints: Record = { + capi: "/chat/completions", + "anthropic-messages": "/v1/messages", + "openai-responses": "/responses", + "openai-completions": "/chat/completions", +}; + +const models: Record = { + capi: "gpt-4.1", + "anthropic-messages": "claude-sonnet-4.5", + "openai-responses": "gpt-4.1", + "openai-completions": "gpt-4.1", +}; + +const completionWithTool: ChatCompletion = { + id: "completion-1", + object: "chat.completion", + created: 123, + model: "test-model", + choices: [ + { + index: 0, + message: { + role: "assistant", + content: "Calling a tool", + refusal: null, + tool_calls: [ + { + id: "call-1", + type: "function", + function: { name: "lookup", arguments: '{"value":42}' }, + }, + ], + }, + logprobs: null, + finish_reason: "tool_calls", + }, + ], + usage: { + prompt_tokens: 10, + completion_tokens: 5, + total_tokens: 15, + }, +}; + +function requestFor( + backend: ReplayBackend, + prompt: string, +): Record { + const model = models[backend]; + switch (backend) { + case "anthropic-messages": + return { + model, + system: "Be helpful", + messages: [{ role: "user", content: prompt }], + max_tokens: 128, + }; + case "openai-responses": + return { + model, + instructions: "Be helpful", + input: [ + { + type: "message", + role: "user", + content: [{ type: "input_text", text: prompt }], + }, + ], + }; + case "capi": + case "openai-completions": + return { + model, + messages: [ + { role: "system", content: "Be helpful" }, + { role: "user", content: prompt }, + ], + }; + } +} + +async function postJson( + proxyUrl: string, + endpoint: string, + body: unknown, +): Promise { + return fetch(`${proxyUrl}${endpoint}`, { + method: "POST", + headers: { "content-type": "application/json" }, + body: JSON.stringify(body), + }); +} + +describe("Anthropic Messages adapter", () => { + test("normalizes messages, binary content, and tools", () => { + const result = JSON.parse( + anthropicMessagesRequestToChatCompletion( + JSON.stringify({ + model: "test-model", + system: [{ type: "text", text: "Be helpful" }], + messages: [ + { + role: "user", + content: [ + { type: "text", text: "Inspect this" }, + { + type: "image", + source: { + type: "base64", + media_type: "image/png", + data: "AQID", + }, + }, + ], + }, + { + role: "assistant", + content: [ + { + type: "tool_use", + id: "call-1", + name: "lookup", + input: { value: 42 }, + }, + ], + }, + { + role: "user", + content: [ + { + type: "tool_result", + tool_use_id: "call-1", + content: "found", + }, + ], + }, + ], + tools: [ + { + name: "lookup", + description: "Find a value", + input_schema: { type: "object" }, + }, + ], + stream: true, + }), + ), + ) as { + messages: Array>; + tools: Array>; + stream: boolean; + }; + + expect(result.messages.map((message) => message.role)).toEqual([ + "system", + "user", + "assistant", + "tool", + ]); + expect(result.messages[1].content).toEqual([ + { type: "text", text: "Inspect this" }, + { + type: "image_url", + image_url: { url: "data:image/png;base64,AQID" }, + }, + ]); + expect(result.messages[2].tool_calls).toEqual([ + { + id: "call-1", + type: "function", + function: { name: "lookup", arguments: '{"value":42}' }, + }, + ]); + expect(result.messages[3]).toMatchObject({ + tool_call_id: "call-1", + content: "found", + }); + expect(result.tools).toHaveLength(1); + expect(result.stream).toBe(true); + }); + + test("renders JSON and streaming tool responses", () => { + const message = + chatCompletionResponseToAnthropicMessage(completionWithTool); + expect(message.stop_reason).toBe("tool_use"); + expect(message.usage).toMatchObject({ + cache_creation_input_tokens: null, + cache_read_input_tokens: null, + }); + expect(message.content.map((block) => block.type)).toEqual([ + "text", + "tool_use", + ]); + + const stream = + chatCompletionResponseToAnthropicSseChunks(completionWithTool).join(""); + expect(stream).toContain("event: message_start"); + expect(stream).toContain("event: content_block_delta"); + expect(stream).toContain("event: message_stop"); + }); + + test("combines tools from multiple canonical choices", () => { + const secondChoice = structuredClone(completionWithTool.choices[0]); + secondChoice.message.content = null; + secondChoice.message.tool_calls![0] = { + id: "call-2", + type: "function", + function: { name: "inspect", arguments: '{"path":"file.txt"}' }, + }; + + const message = chatCompletionResponseToAnthropicMessage({ + ...completionWithTool, + choices: [completionWithTool.choices[0], secondChoice], + }); + expect( + message.content + .filter((block) => block.type === "tool_use") + .map((block) => block.name), + ).toEqual(["lookup", "inspect"]); + }); +}); + +describe("OpenAI Responses adapter", () => { + test("normalizes messages, binary content, and tools", () => { + const result = JSON.parse( + responsesApiRequestToChatCompletion( + JSON.stringify({ + model: "test-model", + instructions: "Be helpful", + input: [ + { + type: "message", + role: "user", + content: [ + { type: "input_text", text: "Inspect this" }, + { + type: "input_image", + image_url: "data:image/png;base64,AQID", + }, + ], + }, + { + type: "function_call", + call_id: "call-1", + name: "lookup", + arguments: '{"value":42}', + }, + { + type: "function_call_output", + call_id: "call-1", + output: "found", + }, + ], + tools: [ + { + type: "function", + name: "lookup", + parameters: { type: "object" }, + }, + ], + }), + ), + ) as { + messages: Array>; + tools: Array>; + }; + + expect(result.messages.map((message) => message.role)).toEqual([ + "system", + "user", + "assistant", + "tool", + ]); + expect(result.messages[1].content).toEqual([ + { type: "text", text: "Inspect this" }, + { + type: "image_url", + image_url: { url: "data:image/png;base64,AQID" }, + }, + ]); + expect(result.messages[2].tool_calls).toEqual([ + { + id: "call-1", + type: "function", + function: { name: "lookup", arguments: '{"value":42}' }, + }, + ]); + expect(result.messages[3]).toMatchObject({ + tool_call_id: "call-1", + content: "found", + }); + expect(result.tools).toHaveLength(1); + }); + + test("renders JSON and streaming tool responses", () => { + const response = + chatCompletionResponseToResponsesApiMessage(completionWithTool); + const nextResponse = + chatCompletionResponseToResponsesApiMessage(completionWithTool); + expect(response).toMatchObject({ + object: "response", + created_at: completionWithTool.created, + status: "completed", + incomplete_details: null, + error: null, + }); + expect(response.output[0].id).not.toBe(nextResponse.output[0].id); + expect(response.output.map((item) => item.type)).toEqual([ + "message", + "function_call", + ]); + + const chunks = + chatCompletionResponseToResponsesApiSseChunks(completionWithTool); + const events = chunks.map( + (chunk) => + JSON.parse(chunk.split("\ndata: ")[1]) as Record, + ); + const stream = chunks.join(""); + expect(stream).toContain("event: response.created"); + expect(stream).toContain("event: response.in_progress"); + expect(stream).toContain("event: response.output_text.delta"); + expect(stream).toContain('"sequence_number":0'); + expect(stream).toContain("event: response.completed"); + + expect(events[0]).toMatchObject({ + type: "response.created", + response: { status: "in_progress", output: [] }, + }); + expect(events[1]).toMatchObject({ + type: "response.in_progress", + response: { status: "in_progress", output: [] }, + }); + + const addedItems = events.filter( + (event) => event.type === "response.output_item.added", + ); + expect(addedItems).toMatchObject([ + { + item: { + type: "message", + status: "in_progress", + content: [], + }, + }, + { + item: { + type: "function_call", + status: "in_progress", + arguments: "", + }, + }, + ]); + expect( + events.find((event) => event.type === "response.content_part.added"), + ).toMatchObject({ + part: { type: "output_text", text: "" }, + }); + + const completedItems = events.filter( + (event) => event.type === "response.output_item.done", + ); + expect(completedItems).toMatchObject([ + { + item: { + type: "message", + status: "completed", + content: [{ type: "output_text", text: "Calling a tool" }], + }, + }, + { + item: { + type: "function_call", + status: "completed", + arguments: '{"value":42}', + }, + }, + ]); + }); +}); + +describe("protocol-aware replay", () => { + let tempDir: string; + let workDir: string; + let cachePath: string; + + async function writeSnapshot( + messages: NormalizedData["conversations"][number]["messages"], + ): Promise { + await writeFile( + cachePath, + yaml.stringify({ + models: ["captured-capi-model"], + conversations: [{ messages }], + } satisfies NormalizedData), + ); + } + + async function withProxy( + backend: ReplayBackend, + action: (proxyUrl: string) => Promise, + ): Promise { + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + await proxy.updateConfig({ filePath: cachePath, workDir, backend }); + try { + await action(proxyUrl); + } finally { + await proxy.stop(true); + } + } + + beforeEach(async () => { + tempDir = await mkdtemp(path.join(os.tmpdir(), "protocol-replay-")); + workDir = path.join(tempDir, "work"); + cachePath = path.join(tempDir, "cache.yaml"); + await writeSnapshot([ + { role: "system", content: "${system}" }, + { role: "user", content: "Hello" }, + { role: "assistant", content: "Hi there!" }, + ]); + }); + + afterEach(async () => { + await rm(tempDir, { recursive: true, force: true }); + }); + + test.each(backends)( + "replays one model-independent snapshot through %s", + async (backend) => { + await withProxy(backend, async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints[backend], + requestFor(backend, "Hello"), + ); + expect(response.status).toBe(200); + const body = (await response.json()) as Record; + expect(body.model).toBe(models[backend]); + + const exchanges = (await ( + await fetch(`${proxyUrl}/exchanges`) + ).json()) as Array<{ + request: { + model: string; + messages: Array<{ role: string; content: unknown }>; + }; + response?: unknown; + }>; + expect(exchanges).toHaveLength(1); + expect(exchanges[0].request.model).toBe(models[backend]); + expect(exchanges[0].request.messages.at(-1)).toEqual({ + role: "user", + content: "Hello", + }); + if ( + backend === "anthropic-messages" || + backend === "openai-responses" + ) { + expect(exchanges[0].response).toBeUndefined(); + } + }); + }, + ); + + test("does not rewrite canonical snapshots after BYOK replay", async () => { + const original = await readFile(cachePath, "utf8"); + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + await proxy.updateConfig({ + filePath: cachePath, + workDir, + backend: "openai-responses", + }); + + let stopped = false; + try { + const response = await postJson( + proxyUrl, + endpoints["openai-responses"], + requestFor("openai-responses", "Hello"), + ); + expect(response.status).toBe(200); + await proxy.stop(); + stopped = true; + expect(await readFile(cachePath, "utf8")).toBe(original); + } finally { + if (!stopped) await proxy.stop(true); + } + }); + + test.each(["openai-responses", "openai-completions"] as const)( + "coalesces adjacent user messages from %s", + async (backend) => { + await writeSnapshot([ + { role: "system", content: "${system}" }, + { role: "user", content: "Hook context" }, + { role: "user", content: "Hello" }, + { role: "assistant", content: "Hi there!" }, + ]); + const request = requestFor(backend, "Hello"); + const hook = + "Hook context\n\n\n2026-01-01T00:00:00Z\n\n"; + if (backend === "openai-responses") { + (request.input as unknown[]).unshift({ + type: "message", + role: "user", + content: [{ type: "input_text", text: hook }], + }); + } else { + (request.messages as unknown[]).splice(1, 0, { + role: "user", + content: hook, + }); + } + + await withProxy(backend, async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints[backend], + request, + ); + expect(response.status).toBe(200); + }); + }, + ); + + test("normalizes Anthropic spacing between adjacent user turns", async () => { + await writeSnapshot([ + { role: "system", content: "${system}" }, + { role: "user", content: "First prompt" }, + { role: "user", content: "Recovery prompt" }, + { role: "assistant", content: "Recovered" }, + ]); + await withProxy("anthropic-messages", async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints["anthropic-messages"], + requestFor( + "anthropic-messages", + "First prompt\n\n\n\n\nRecovery prompt", + ), + ); + expect(response.status).toBe(200); + }); + }); + + test.each(backends)( + "replays compaction responses through %s", + async (backend) => { + await writeSnapshot([ + { role: "system", content: "${system}" }, + { role: "user", content: "${compaction_prompt}" }, + { + role: "assistant", + content: + "CompactedHistoryCheckpoint", + }, + ]); + await withProxy(backend, async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints[backend], + requestFor(backend, "${compaction_prompt}"), + ); + expect(response.status).toBe(200); + const body = JSON.stringify(await response.json()); + expect(body).toContain(""); + expect(body).toContain(""); + expect(body).toContain(""); + }); + }, + ); + + test("rejects an inference request over the wrong protocol", async () => { + await withProxy("anthropic-messages", async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints["openai-completions"], + requestFor("openai-completions", "Hello"), + ); + expect(response.status).toBe(400); + await expect(response.text()).resolves.toContain("protocol_mismatch"); + }); + }); + + test("keeps foreign model endpoints unavailable in CAPI mode", async () => { + await withProxy("capi", async (proxyUrl) => { + const response = await postJson( + proxyUrl, + endpoints["openai-responses"], + requestFor("openai-responses", "Hello"), + ); + expect(response.status).toBe(404); + }); + }); +}); diff --git a/test/harness/package-lock.json b/test/harness/package-lock.json index 818e62bf0..be44c52bc 100644 --- a/test/harness/package-lock.json +++ b/test/harness/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "license": "ISC", "devDependencies": { - "@github/copilot": "^1.0.56-2", + "@github/copilot": "^1.0.80", "@modelcontextprotocol/sdk": "^1.26.0", "@types/node": "^25.3.3", "@types/node-forge": "^1.3.14", @@ -19,12 +19,49 @@ "typescript": "^5.9.3", "vitest": "^4.0.18", "yaml": "^2.8.2" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@emnapi/core": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.10.0.tgz", + "integrity": "sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/wasi-threads": "1.2.1", + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.10.0.tgz", + "integrity": "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.1.tgz", + "integrity": "sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.2.tgz", - "integrity": "sha512-GZMB+a0mOMZs4MpDbj8RJp4cw+w1WV5NYD6xzgvzUJ5Ek2jerwfO2eADyI6ExDSUED+1X8aMbegahsJi+8mgpw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.1.tgz", + "integrity": "sha512-Svl7tq8k/08+p6CXPpRjQ1fKX+1odH/BQbb48fV6fj3CWHhsoIOoY87w1oHXm0qEpkIK3ZfVgp0hed3XBXzXMQ==", "cpu": [ "ppc64" ], @@ -39,9 +76,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.2.tgz", - "integrity": "sha512-DVNI8jlPa7Ujbr1yjU2PfUSRtAUZPG9I1RwW4F4xFB1Imiu2on0ADiI/c3td+KmDtVKNbi+nffGDQMfcIMkwIA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.1.tgz", + "integrity": "sha512-0k2F129Xdio1TdJfzJ8sy1Q47vUD2NnwdhiAf7drUN1EBTfPf4hsFCtmMgu/6m8JSzsBrlmVjudMBQqOfG8usQ==", "cpu": [ "arm" ], @@ -56,9 +93,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.2.tgz", - "integrity": "sha512-pvz8ZZ7ot/RBphf8fv60ljmaoydPU12VuXHImtAs0XhLLw+EXBi2BLe3OYSBslR4rryHvweW5gmkKFwTiFy6KA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.1.tgz", + "integrity": "sha512-34EGEbCIAgosYz6goLcopX6Mo7NyGv9tfwEM2/7Ce2VcVRk568iSvniGWcUXIy7wEDR1wzolcxcriFVrWYcwBg==", "cpu": [ "arm64" ], @@ -73,9 +110,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.2.tgz", - "integrity": "sha512-z8Ank4Byh4TJJOh4wpz8g2vDy75zFL0TlZlkUkEwYXuPSgX8yzep596n6mT7905kA9uHZsf/o2OJZubl2l3M7A==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.1.tgz", + "integrity": "sha512-dbwY7ltSMDWsRatcRpCnES4F+im88OCUgGZjy52shC7GqHRE/cYlxNbB4Z4UpJswpcc4Qxd2oE/ufM0p61IKng==", "cpu": [ "x64" ], @@ -90,9 +127,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.2.tgz", - "integrity": "sha512-davCD2Zc80nzDVRwXTcQP/28fiJbcOwvdolL0sOiOsbwBa72kegmVU0Wrh1MYrbuCL98Omp5dVhQFWRKR2ZAlg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.1.tgz", + "integrity": "sha512-TZbWkQY7kvTAXbXUT7uVACR5cMHsDiSz9z7ZKAX/RTq/WJEk3QyRr0wZpNhBDX+/0CtdqUIJlOiodQcta6tY3Q==", "cpu": [ "arm64" ], @@ -107,9 +144,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.2.tgz", - "integrity": "sha512-ZxtijOmlQCBWGwbVmwOF/UCzuGIbUkqB1faQRf5akQmxRJ1ujusWsb3CVfk/9iZKr2L5SMU5wPBi1UWbvL+VQA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.1.tgz", + "integrity": "sha512-zfdzgK9ACBNZLI/CyHTOx81SyNbM6YXn7rxSgX97VjyiPl9W1i4Ka4fgKECEoFCKGpvBj5qArWIGgQjOwkgskQ==", "cpu": [ "x64" ], @@ -124,9 +161,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.2.tgz", - "integrity": "sha512-lS/9CN+rgqQ9czogxlMcBMGd+l8Q3Nj1MFQwBZJyoEKI50XGxwuzznYdwcav6lpOGv5BqaZXqvBSiB/kJ5op+g==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.1.tgz", + "integrity": "sha512-wG2EA8ENdEI0qhkSZMjfqrdY+ziCYCPMmtZjjIwOmXFjmyzEHn+UUxk5of+SYsjtfs3VpnlC7QLzSI5hY/rOAw==", "cpu": [ "arm64" ], @@ -141,9 +178,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.2.tgz", - "integrity": "sha512-tAfqtNYb4YgPnJlEFu4c212HYjQWSO/w/h/lQaBK7RbwGIkBOuNKQI9tqWzx7Wtp7bTPaGC6MJvWI608P3wXYA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.1.tgz", + "integrity": "sha512-i7dZ9vQgnvSCzi/rYCXNgtF/U+eKZNJBzu3eTQbRgHnM7tNSizLOkRFAl3qzVc/Op/u5YkHHa4pf/3DOYHthLQ==", "cpu": [ "x64" ], @@ -158,9 +195,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.2.tgz", - "integrity": "sha512-vWfq4GaIMP9AIe4yj1ZUW18RDhx6EPQKjwe7n8BbIecFtCQG4CfHGaHuh7fdfq+y3LIA2vGS/o9ZBGVxIDi9hw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.1.tgz", + "integrity": "sha512-qVXBOHQS+d5Y722GwJzJUtOLlX7km3CraOaGormF1pDtPd2C/l1SHRPgjLunLGe51Sh5YYWKMFDyV4SxgMQYTQ==", "cpu": [ "arm" ], @@ -175,9 +212,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.2.tgz", - "integrity": "sha512-hYxN8pr66NsCCiRFkHUAsxylNOcAQaxSSkHMMjcpx0si13t1LHFphxJZUiGwojB1a/Hd5OiPIqDdXONia6bhTw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.1.tgz", + "integrity": "sha512-yHs+0uc8+nvEAfAfxrWQKK5peSNzBc4PegcMO0EJ2hT71uA7vB8Ihg2e77R2P7SG5uYjPbHlLLmve4LLLRCf0g==", "cpu": [ "arm64" ], @@ -192,9 +229,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.2.tgz", - "integrity": "sha512-MJt5BRRSScPDwG2hLelYhAAKh9imjHK5+NE/tvnRLbIqUWa+0E9N4WNMjmp/kXXPHZGqPLxggwVhz7QP8CTR8w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.1.tgz", + "integrity": "sha512-d1z4ZuP0ajrfz/FhGT4vv278rX8KnPPJx8i5+AtK7TYbx9Le9F1hyzurZpkEyjkGa9dUGhQow4C1NmeGvqxN2w==", "cpu": [ "ia32" ], @@ -209,9 +246,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.2.tgz", - "integrity": "sha512-lugyF1atnAT463aO6KPshVCJK5NgRnU4yb3FUumyVz+cGvZbontBgzeGFO1nF+dPueHD367a2ZXe1NtUkAjOtg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.1.tgz", + "integrity": "sha512-M5sRjUVZrkm1OAPR3dlOYzNmN+loZKGVi1VUQGrwuqLcbR6qeAz+famMhjASeH3YVKvZz+zT1jlh/keC3Rj/lg==", "cpu": [ "loong64" ], @@ -226,9 +263,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.2.tgz", - "integrity": "sha512-nlP2I6ArEBewvJ2gjrrkESEZkB5mIoaTswuqNFRv/WYd+ATtUpe9Y09RnJvgvdag7he0OWgEZWhviS1OTOKixw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.1.tgz", + "integrity": "sha512-mRObBZeHh2OxcBFPWE/FjylkRgZdYuiTR3vaTozquCGOH14iP9oN4x4Ge81CoIDYQrXmIxpFumJBu5MtZpnQJQ==", "cpu": [ "mips64el" ], @@ -243,9 +280,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.2.tgz", - "integrity": "sha512-C92gnpey7tUQONqg1n6dKVbx3vphKtTHJaNG2Ok9lGwbZil6DrfyecMsp9CrmXGQJmZ7iiVXvvZH6Ml5hL6XdQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.1.tgz", + "integrity": "sha512-slScBsMAb3GFDcdrCgLwZtPYRoH2H/youv10QiZyRjmsP48fznoveWytSgCI/R0ZcUgpc0ZhIUEx6LHts8yrfQ==", "cpu": [ "ppc64" ], @@ -260,9 +297,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.2.tgz", - "integrity": "sha512-B5BOmojNtUyN8AXlK0QJyvjEZkWwy/FKvakkTDCziX95AowLZKR6aCDhG7LeF7uMCXEJqwa8Bejz5LTPYm8AvA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.1.tgz", + "integrity": "sha512-kw0owk1o0GFETUJyW0jc0G4Yzs0BHZn0JDZ8JRT088vjJYX777BAs1fDGxAC+q831qOs2DTC96mNsG2opdfyyQ==", "cpu": [ "riscv64" ], @@ -277,9 +314,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.2.tgz", - "integrity": "sha512-p4bm9+wsPwup5Z8f4EpfN63qNagQ47Ua2znaqGH6bqLlmJ4bx97Y9JdqxgGZ6Y8xVTixUnEkoKSHcpRlDnNr5w==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.1.tgz", + "integrity": "sha512-/lAIjX8aYFRByhh6L5rYtPEDRqa9de/4V/juOXcta5frjvzXO4/sqEtyytse0g3zZFuWu5cDN0MkLz2qRDD2Ag==", "cpu": [ "s390x" ], @@ -294,9 +331,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.2.tgz", - "integrity": "sha512-uwp2Tip5aPmH+NRUwTcfLb+W32WXjpFejTIOWZFw/v7/KnpCDKG66u4DLcurQpiYTiYwQ9B7KOeMJvLCu/OvbA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.1.tgz", + "integrity": "sha512-u/anNYF2mmVOEDwLtnQ1wOr3EZ9sTNGLWrsYGYwHWzGA3Si84IOkHXlbWTD1NB+9/1lcnweYKO54uhxZydNzfA==", "cpu": [ "x64" ], @@ -311,9 +348,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.2.tgz", - "integrity": "sha512-Kj6DiBlwXrPsCRDeRvGAUb/LNrBASrfqAIok+xB0LxK8CHqxZ037viF13ugfsIpePH93mX7xfJp97cyDuTZ3cw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.1.tgz", + "integrity": "sha512-oks0DYbLwWMmaakTsCb+zL4E+aHRVLom9IJZOAthMQEPiQmydXHkziYEsGYRx0uNV/IjEKGAV941JzH02pflqw==", "cpu": [ "arm64" ], @@ -328,9 +365,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.2.tgz", - "integrity": "sha512-HwGDZ0VLVBY3Y+Nw0JexZy9o/nUAWq9MlV7cahpaXKW6TOzfVno3y3/M8Ga8u8Yr7GldLOov27xiCnqRZf0tCA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.1.tgz", + "integrity": "sha512-aeL6lAnN89Hz43Mlh1G8ARasbuoYvSITDEx0tHh5b7jJnHcssqgjy9Yx430GDpmCa6OyrKoS0aNRjKundRizGg==", "cpu": [ "x64" ], @@ -345,9 +382,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.2.tgz", - "integrity": "sha512-DNIHH2BPQ5551A7oSHD0CKbwIA/Ox7+78/AWkbS5QoRzaqlev2uFayfSxq68EkonB+IKjiuxBFoV8ESJy8bOHA==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.1.tgz", + "integrity": "sha512-MEFJe5C3R8pwXdZ5Y21oo6m7ePiS0d9pWucn99O/wvyJZChoIQKrQDxKrGeW8F5+T0okTHesAmDeiHDTIq0V/Q==", "cpu": [ "arm64" ], @@ -362,9 +399,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.2.tgz", - "integrity": "sha512-/it7w9Nb7+0KFIzjalNJVR5bOzA9Vay+yIPLVHfIQYG/j+j9VTH84aNB8ExGKPU4AzfaEvN9/V4HV+F+vo8OEg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.1.tgz", + "integrity": "sha512-i/ZLIOafE0Z8cI/XANJAixoJL/uRAoS2xOA3rb0xN+KK0K177cMAsQYkzHtBrtMXAKuAc7HGgcWiZ/sRC1Nxgw==", "cpu": [ "x64" ], @@ -379,9 +416,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.2.tgz", - "integrity": "sha512-LRBbCmiU51IXfeXk59csuX/aSaToeG7w48nMwA6049Y4J4+VbWALAuXcs+qcD04rHDuSCSRKdmY63sruDS5qag==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.1.tgz", + "integrity": "sha512-ge+Z7EXFNt2BO1oAMsVpiQ8EwndV9i1xXerAeTIK7AtPs3bKFXQM7nlRxDSIUIMeueR1CNXxqztLzdNeReKBJg==", "cpu": [ "arm64" ], @@ -396,9 +433,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.2.tgz", - "integrity": "sha512-kMtx1yqJHTmqaqHPAzKCAkDaKsffmXkPHThSfRwZGyuqyIeBvf08KSsYXl+abf5HDAPMJIPnbBfXvP2ZC2TfHg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.1.tgz", + "integrity": "sha512-BEjgtECkL3vY+SaSQ6nzVfiALUeFxpawyp8Jmf5PtYhf1Ug40N1h/hxlhts+f1FvSvarEigdxS3BlSMI2PJLcQ==", "cpu": [ "x64" ], @@ -413,9 +450,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.2.tgz", - "integrity": "sha512-Yaf78O/B3Kkh+nKABUF++bvJv5Ijoy9AN1ww904rOXZFLWVc5OLOfL56W+C8F9xn5JQZa3UX6m+IktJnIb1Jjg==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.1.tgz", + "integrity": "sha512-lCv9eK/H6ZJWbE7bh2nw54CZ9M2nupBxJcTsdk/QQnWkdSjKGuxmmH8/GWrlT1eMmZfn4dGcCjRte397WqfQXA==", "cpu": [ "arm64" ], @@ -430,9 +467,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.2.tgz", - "integrity": "sha512-Iuws0kxo4yusk7sw70Xa2E2imZU5HoixzxfGCdxwBdhiDgt9vX9VUCBhqcwY7/uh//78A1hMkkROMJq9l27oLQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.1.tgz", + "integrity": "sha512-zvb/mB2bSCoJOpoCBgYKKpX6YM6mJBlBUVUtVj41DlZJVEB6/0CKlRYxP5wWl1C1ILiCoAU5wZZ4q1P3qeS6Eg==", "cpu": [ "ia32" ], @@ -447,9 +484,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.2.tgz", - "integrity": "sha512-sRdU18mcKf7F+YgheI/zGf5alZatMUTKj/jNS6l744f9u3WFu4v7twcUI9vu4mknF4Y9aDlblIie0IM+5xxaqQ==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.1.tgz", + "integrity": "sha512-bm4Mowrv+GXMlpWX++EcXw/iLyd1o3+bJkC2DkWXYVvgZCqD/bSj9ctZeAMC3cIxgjRVR2Dufaiu4YPxr5gW1A==", "cpu": [ "x64" ], @@ -464,9 +501,9 @@ } }, "node_modules/@github/copilot": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.56-2.tgz", - "integrity": "sha512-Dpue7utF6PzGS4tPrG3pRXL3d1lMJHFFT8PJegljn7vg64LAbjhk5yNgBXbMg/XbObu755SJTNtbEL/aSdrGNg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot/-/copilot-1.0.80.tgz", + "integrity": "sha512-6tf93ZF56KOiTTAjK/UhLZkl1W543IzaTQly288kockJZFswpRTnQEI00Yvacpb39DTvTYu3/ha9SeKpo/pgZQ==", "dev": true, "license": "SEE LICENSE IN LICENSE.md", "dependencies": { @@ -476,20 +513,20 @@ "copilot": "npm-loader.js" }, "optionalDependencies": { - "@github/copilot-darwin-arm64": "1.0.56-2", - "@github/copilot-darwin-x64": "1.0.56-2", - "@github/copilot-linux-arm64": "1.0.56-2", - "@github/copilot-linux-x64": "1.0.56-2", - "@github/copilot-linuxmusl-arm64": "1.0.56-2", - "@github/copilot-linuxmusl-x64": "1.0.56-2", - "@github/copilot-win32-arm64": "1.0.56-2", - "@github/copilot-win32-x64": "1.0.56-2" + "@github/copilot-darwin-arm64": "1.0.80", + "@github/copilot-darwin-x64": "1.0.80", + "@github/copilot-linux-arm64": "1.0.80", + "@github/copilot-linux-x64": "1.0.80", + "@github/copilot-linuxmusl-arm64": "1.0.80", + "@github/copilot-linuxmusl-x64": "1.0.80", + "@github/copilot-win32-arm64": "1.0.80", + "@github/copilot-win32-x64": "1.0.80" } }, "node_modules/@github/copilot-darwin-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.56-2.tgz", - "integrity": "sha512-RHJNhdPSkdPc/nabWVess7BfEda7xfwBQ2X5vq9nq4VjqTbvUHBFwTt792q00TE4DZR/UsWr0sJKJkLcRvTltQ==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-1.0.80.tgz", + "integrity": "sha512-fzn4PnSx3+O/a3ip72KVsjnzORsEygK+0i21bFAnFBYS+0Wi1Pk+o/CmNsJ7aRbf1enSJrcH8UDVkyc9pMGEBg==", "cpu": [ "arm64" ], @@ -504,9 +541,9 @@ } }, "node_modules/@github/copilot-darwin-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.56-2.tgz", - "integrity": "sha512-EqBtGH1I2rX5TzSJ+L9O22SQ8jlSsn1YJeFS6RTtYU+NhC6xLajjfTutkA5DZOr3eQgmeceit/4NDqEdjwANEA==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-darwin-x64/-/copilot-darwin-x64-1.0.80.tgz", + "integrity": "sha512-PKsyGk5DccNzR3bYXcYTGB9N6sHzhzGqEwq/2t1qBwqPbrC98Zo2dOT2G40/QYpJ4XdrGmTmdmfPJQ9PJknlIQ==", "cpu": [ "x64" ], @@ -521,9 +558,9 @@ } }, "node_modules/@github/copilot-linux-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.56-2.tgz", - "integrity": "sha512-FmjODKft2tmY5B0B94RDek/TR3QtdDTT7W/+lqkiosnUyLhsNtmzKaDYpiQsCBee68YUuB1umecqiTL1qMo3cw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-arm64/-/copilot-linux-arm64-1.0.80.tgz", + "integrity": "sha512-8oXwN2luyHEjIoSk8AkATBjXDhRoQtuiUvC93GpfQKFHI+I1eoOVwIsAq5fKP8jNCF2rOrYFIcTjwmRt38kCcQ==", "cpu": [ "arm64" ], @@ -538,9 +575,9 @@ } }, "node_modules/@github/copilot-linux-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.56-2.tgz", - "integrity": "sha512-aqF4k6mDLU1OXdaAb3gBIRCgdrlXX+1FBtcoLKPMjzVfkA2abEZ/vuYfZWS7ZaxG/aCOScp8D+/E+RaYHsGYOw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linux-x64/-/copilot-linux-x64-1.0.80.tgz", + "integrity": "sha512-qv1ytVNwA3IDK7kcQow+fAikD67t42+AQ8X42bK/7oudNiv4frVZMO0yh1DYIebVRcmEhmPvbVPY/ptVUK3cbA==", "cpu": [ "x64" ], @@ -555,9 +592,9 @@ } }, "node_modules/@github/copilot-linuxmusl-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.56-2.tgz", - "integrity": "sha512-+CztOiU7/nlNLX50jcpOMreMrDr7+DFnq3OV59doDd9UgqTdpjEnZKjkgHpxid117rYF/95cN5EYWD7ermOcjA==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-arm64/-/copilot-linuxmusl-arm64-1.0.80.tgz", + "integrity": "sha512-Qjyi+OlVnPC4Lkuy7blDMMwMUQI/yELl7gDnqQlaN8TEbhZqZueuf3p0a+kEjXcNsw4XtNYQc0eMJqSIYy/Pjg==", "cpu": [ "arm64" ], @@ -572,9 +609,9 @@ } }, "node_modules/@github/copilot-linuxmusl-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.56-2.tgz", - "integrity": "sha512-FuBYfN2dX2a5fSEzPImtX6hjtjwiL0kutrq4RuvHYxUu0FR0JRB4vfN2mQ/KN4X5DZgaGkPQk19hkoEgd1tmdg==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-linuxmusl-x64/-/copilot-linuxmusl-x64-1.0.80.tgz", + "integrity": "sha512-rBg8pugf+5FhiZxi2zkOr+rlcOVF6Xg63j1FvryfwPT4DJ2w5Na7O3lpS4sgu8QmsP5H+dAqjlXYLYsvSoVQ0g==", "cpu": [ "x64" ], @@ -589,9 +626,9 @@ } }, "node_modules/@github/copilot-win32-arm64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.56-2.tgz", - "integrity": "sha512-mKTzS9HrH+wvOmIgIaRUs+l89o51P7ACVk4P/o1UEWGxDblTxwRZGL+cRBhqNltIxY+8XVIAEwg6CzE+sTH5Hw==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-arm64/-/copilot-win32-arm64-1.0.80.tgz", + "integrity": "sha512-+f7Vkd3vt2DYOxRnS8dStvYu3DY638N/AuLuIjxZp1F9GgwCUZK69wspqIxg2L59PmRRQcH4AGTrRDR60ENIZA==", "cpu": [ "arm64" ], @@ -606,9 +643,9 @@ } }, "node_modules/@github/copilot-win32-x64": { - "version": "1.0.56-2", - "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.56-2.tgz", - "integrity": "sha512-tacHeeqNiLawmlUpturke10I9d6kkREqTcHGkGRy/MEwrio7A77L45j/IegRcQNjLwHP62R2+5GmNFx6BRwx9w==", + "version": "1.0.80", + "resolved": "https://registry.npmjs.org/@github/copilot-win32-x64/-/copilot-win32-x64-1.0.80.tgz", + "integrity": "sha512-PO0kPqhRTWQfsqGaj4UN3cj8ttkcJYy4wmXiArtFm+03AIFu8xTvuhQDPn2xEOsUome7m7t2XomKoavcrCcRsw==", "cpu": [ "x64" ], @@ -683,24 +720,39 @@ } } }, - "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.4.tgz", - "integrity": "sha512-F5QXMSiFebS9hKZj02XhWLLnRpJ3B3AROP0tWbFBSj+6kCbg5m9j5JoHKd4mmSVy5mS/IMQloYgYxCuJC0fxEQ==", - "cpu": [ - "arm" - ], + "node_modules/@napi-rs/wasm-runtime": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.4.tgz", + "integrity": "sha512-3NQNNgA1YSlJb/kMH1ildASP9HW7/7kYnRI2szWJaofaS1hWmbGI4H+d3+22aGzXXN9IJ+n+GiFVcGipJP18ow==", "dev": true, "license": "MIT", "optional": true, - "os": [ - "android" - ] + "dependencies": { + "@tybys/wasm-util": "^0.10.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "peerDependencies": { + "@emnapi/core": "^1.7.1", + "@emnapi/runtime": "^1.7.1" + } }, - "node_modules/@rollup/rollup-android-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.4.tgz", - "integrity": "sha512-GxxTKApUpzRhof7poWvCJHRF51C67u1R7D6DiluBE8wKU1u5GWE8t+v81JvJYtbawoBFX1hLv5Ei4eVjkWokaw==", + "node_modules/@oxc-project/types": { + "version": "0.133.0", + "resolved": "https://registry.npmjs.org/@oxc-project/types/-/types-0.133.0.tgz", + "integrity": "sha512-KzkdCd6Uxqnf6l3HOw1xfatAlUURA0g14cvBYFyJ5SaNOQbOUvBr9PKArcPcrNIeRsBdgcUzOGrhKveVpvOIGA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/Boshen" + } + }, + "node_modules/@rolldown/binding-android-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-android-arm64/-/binding-android-arm64-1.0.3.tgz", + "integrity": "sha512-454rs7jHngixp/NMxd5srYD57OnzSlZ/eFTETjORQHLwJG1lRtmNOJcBerZlfu4GjKqeq8aCCIQrMdHyhI51Hw==", "cpu": [ "arm64" ], @@ -709,12 +761,15 @@ "optional": true, "os": [ "android" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.4.tgz", - "integrity": "sha512-tua0TaJxMOB1R0V0RS1jFZ/RpURFDJIOR2A6jWwQeawuFyS4gBW+rntLRaQd0EQ4bd6Vp44Z2rXW+YYDBsj6IA==", + "node_modules/@rolldown/binding-darwin-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-arm64/-/binding-darwin-arm64-1.0.3.tgz", + "integrity": "sha512-PcAhP+ynjURNyy8SKGl5DQP94aGuB/7JrXJb/t7P+hanXvQVMWzUvRRhBAcg/lNRadBhoUPqSoP4xw5tR/KBEA==", "cpu": [ "arm64" ], @@ -723,12 +778,15 @@ "optional": true, "os": [ "darwin" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.4.tgz", - "integrity": "sha512-CSKq7MsP+5PFIcydhAiR1K0UhEI1A2jWXVKHPCBZ151yOutENwvnPocgVHkivu2kviURtCEB6zUQw0vs8RrhMg==", + "node_modules/@rolldown/binding-darwin-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-darwin-x64/-/binding-darwin-x64-1.0.3.tgz", + "integrity": "sha512-9YpfeUvSE2RS7wysJ81uOZkXJz7f7Q55H2Gvp3VEw/EsahqDtrphrZ0EwDLK5vvKOzaCrBsjF8JmnMLcUt78Gg==", "cpu": [ "x64" ], @@ -737,26 +795,15 @@ "optional": true, "os": [ "darwin" - ] - }, - "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.4.tgz", - "integrity": "sha512-+O8OkVdyvXMtJEciu2wS/pzm1IxntEEQx3z5TAVy4l32G0etZn+RsA48ARRrFm6Ri8fvqPQfgrvNxSjKAbnd3g==", - "cpu": [ - "arm64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.4.tgz", - "integrity": "sha512-Iw3oMskH3AfNuhU0MSN7vNbdi4me/NiYo2azqPz/Le16zHSa+3RRmliCMWWQmh4lcndccU40xcJuTYJZxNo/lw==", + "node_modules/@rolldown/binding-freebsd-x64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-freebsd-x64/-/binding-freebsd-x64-1.0.3.tgz", + "integrity": "sha512-yB1IlAsSNHncV6SCTL27/MVGR5htvQsoGxIv5KMGXALp+Ll1wYsn+x98M9MW7qa+NdSbvrrY7ANI4wLJ0n1e6g==", "cpu": [ "x64" ], @@ -765,26 +812,15 @@ "optional": true, "os": [ "freebsd" - ] - }, - "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.4.tgz", - "integrity": "sha512-EIPRXTVQpHyF8WOo219AD2yEltPehLTcTMz2fn6JsatLYSzQf00hj3rulF+yauOlF9/FtM2WpkT/hJh/KJFGhA==", - "cpu": [ - "arm" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.4.tgz", - "integrity": "sha512-J3Yh9PzzF1Ovah2At+lHiGQdsYgArxBbXv/zHfSyaiFQEqvNv7DcW98pCrmdjCZBrqBiKrKKe2V+aaSGWuBe/w==", + "node_modules/@rolldown/binding-linux-arm-gnueabihf": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm-gnueabihf/-/binding-linux-arm-gnueabihf-1.0.3.tgz", + "integrity": "sha512-Yi30IVAAfLUCy2MseFjbB1jAMDl1VMCAas5StnYp8da9+CKvMd2H2cbEjWcw5NPaPqzvYkVIaF1nNUG+b7u/sw==", "cpu": [ "arm" ], @@ -793,26 +829,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.4.tgz", - "integrity": "sha512-BFDEZMYfUvLn37ONE1yMBojPxnMlTFsdyNoqncT0qFq1mAfllL+ATMMJd8TeuVMiX84s1KbcxcZbXInmcO2mRg==", - "cpu": [ - "arm64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.4.tgz", - "integrity": "sha512-pc9EYOSlOgdQ2uPl1o9PF6/kLSgaUosia7gOuS8mB69IxJvlclko1MECXysjs5ryez1/5zjYqx3+xYU0TU6R1A==", + "node_modules/@rolldown/binding-linux-arm64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-gnu/-/binding-linux-arm64-gnu-1.0.3.tgz", + "integrity": "sha512-jsO7R8To+AdlYgUmN5sHSCZbfhtMBkO0WUx8iORQnPcMMdgr7qM2DQmMwgabs3GhNztdmoKkMKQFHD6DTMCIQw==", "cpu": [ "arm64" ], @@ -821,54 +846,32 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.4.tgz", - "integrity": "sha512-NxnomyxYerDh5n4iLrNa+sH+Z+U4BMEE46V2PgQ/hoB909i8gV1M5wPojWg9fk1jWpO3IQnOs20K4wyZuFLEFQ==", - "cpu": [ - "loong64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-loong64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.4.tgz", - "integrity": "sha512-nbJnQ8a3z1mtmrwImCYhc6BGpThAyYVRQxw9uKSKG4wR6aAYno9sVjJ0zaZcW9BPJX1GbrDPf+SvdWjgTuDmnw==", + "node_modules/@rolldown/binding-linux-arm64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-arm64-musl/-/binding-linux-arm64-musl-1.0.3.tgz", + "integrity": "sha512-VWkUHwWriDciit80wleYwKILoR/KMvxh/IdwS/paX+ZgpuRpCrKLUdadJbc0NpBEiyhpYawsJ73j9aCvOH+f7Q==", "cpu": [ - "loong64" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.4.tgz", - "integrity": "sha512-2EU6acNrQLd8tYvo/LXW535wupT3m6fo7HKo6lr7ktQoItxTyOL1ZCR/GfGCuXl2vR+zmfI6eRXkSemafv+iVg==", - "cpu": [ - "ppc64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-ppc64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.4.tgz", - "integrity": "sha512-WeBtoMuaMxiiIrO2IYP3xs6GMWkJP2C0EoT8beTLkUPmzV1i/UcOSVw1d5r9KBODtHKilG5yFxsGRnBbK3wJ4A==", + "node_modules/@rolldown/binding-linux-ppc64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-ppc64-gnu/-/binding-linux-ppc64-gnu-1.0.3.tgz", + "integrity": "sha512-5f1laC0SlIR0yDbFCd8acUhvJIag6N3zC5P7oUPN6wX0aOma+uKJ0wBDH5aq7I1PVI2ttTlhJwzwRIBnLiSGEg==", "cpu": [ "ppc64" ], @@ -877,40 +880,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.4.tgz", - "integrity": "sha512-FJHFfqpKUI3A10WrWKiFbBZ7yVbGT4q4B5o1qKFFojqpaYoh9LrQgqWCmmcxQzVSXYtyB5bzkXrYzlHTs21MYA==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.4.tgz", - "integrity": "sha512-mcEl6CUT5IAUmQf1m9FYSmVqCJlpQ8r8eyftFUHG8i9OhY7BkBXSUdnLH5DOf0wCOjcP9v/QO93zpmF1SptCCw==", - "cpu": [ - "riscv64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.4.tgz", - "integrity": "sha512-ynt3JxVd2w2buzoKDWIyiV1pJW93xlQic1THVLXilz429oijRpSHivZAgp65KBu+cMcgf1eVVjdnTLvPxgCuoQ==", + "node_modules/@rolldown/binding-linux-s390x-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-s390x-gnu/-/binding-linux-s390x-gnu-1.0.3.tgz", + "integrity": "sha512-Iq4ko0r4XsgbrF/LunNgHtAGLRRVE2kXonAXQ/MV0mC6jQpMOhW1SvtZja2EhC/kd05++bP78dsqBeIQyYJ6Yg==", "cpu": [ "s390x" ], @@ -919,12 +897,15 @@ "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.4.tgz", - "integrity": "sha512-Boiz5+MsaROEWDf+GGEwF8VMHGhlUoQMtIPjOgA5fv4osupqTVnJteQNKJwUcnUog2G55jYXH7KZFFiJe0TEzQ==", + "node_modules/@rolldown/binding-linux-x64-gnu": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-gnu/-/binding-linux-x64-gnu-1.0.3.tgz", + "integrity": "sha512-B8m6tD5+/N5FeNQFbKlLA/2yVq9ycQP1SeedyEYYKWBNR3ZQbkvIUcNnDNM03lO1l5F2roiiFJGgvoLLyZXtSg==", "cpu": [ "x64" ], @@ -933,12 +914,15 @@ "optional": true, "os": [ "linux" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.4.tgz", - "integrity": "sha512-+qfSY27qIrFfI/Hom04KYFw3GKZSGU4lXus51wsb5EuySfFlWRwjkKWoE9emgRw/ukoT4Udsj4W/+xxG8VbPKg==", + "node_modules/@rolldown/binding-linux-x64-musl": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-linux-x64-musl/-/binding-linux-x64-musl-1.0.3.tgz", + "integrity": "sha512-pSdpdUJHkuCxun9LE7jvgUB9qsRgaiyNNCX7m/AvHTcq67AiT/Yhoxvw5zPfhrM8k/BfP8ce/hMOpthKDpEUow==", "cpu": [ "x64" ], @@ -947,26 +931,15 @@ "optional": true, "os": [ "linux" - ] - }, - "node_modules/@rollup/rollup-openbsd-x64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.4.tgz", - "integrity": "sha512-VpTfOPHgVXEBeeR8hZ2O0F3aSso+JDWqTWmTmzcQKted54IAdUVbxE+j/MVxUsKa8L20HJhv3vUezVPoquqWjA==", - "cpu": [ - "x64" ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ] + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.4.tgz", - "integrity": "sha512-IPOsh5aRYuLv/nkU51X10Bf75Bsf6+gZdx1X+QP5QM6lIJFHHqbHLG0uJn/hWthzo13UAc2umiUorqZy3axoZg==", + "node_modules/@rolldown/binding-openharmony-arm64": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-openharmony-arm64/-/binding-openharmony-arm64-1.0.3.tgz", + "integrity": "sha512-OXXS3RKJgX2uLwM+gYyuH5omcH8fL1LJs96pZGgtetVCahON57+d4SJHzTgZiOjxgGkSnpXpOsWuPDGAKAigEg==", "cpu": [ "arm64" ], @@ -975,40 +948,51 @@ "optional": true, "os": [ "openharmony" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.4.tgz", - "integrity": "sha512-4QzE9E81OohJ/HKzHhsqU+zcYYojVOXlFMs1DdyMT6qXl/niOH7AVElmmEdUNHHS/oRkc++d5k6Vy85zFs0DEw==", + "node_modules/@rolldown/binding-wasm32-wasi": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-wasm32-wasi/-/binding-wasm32-wasi-1.0.3.tgz", + "integrity": "sha512-JTtb8BWFynicNSoPrehsCzBtOKjZ6jhMiPFEmOiuXg1Fl8dn2KHQob+GuPSGR0dryQa1PQJbzjF3dqO/whhjLg==", "cpu": [ - "arm64" + "wasm32" ], "dev": true, "license": "MIT", "optional": true, - "os": [ - "win32" - ] + "dependencies": { + "@emnapi/core": "1.10.0", + "@emnapi/runtime": "1.10.0", + "@napi-rs/wasm-runtime": "^1.1.4" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.4.tgz", - "integrity": "sha512-zTPgT1YuHHcd+Tmx7h8aml0FWFVelV5N54oHow9SLj+GfoDy/huQ+UV396N/C7KpMDMiPspRktzM1/0r1usYEA==", + "node_modules/@rolldown/binding-win32-arm64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-arm64-msvc/-/binding-win32-arm64-msvc-1.0.3.tgz", + "integrity": "sha512-gEdFFEN70A/jxb2svrWsN3aDL7OUtmvlOy+6fa2jxG8K0wQ1ZbdeLGnidov6Yu5/733dI5ySfzFlQ/cb0bSz1g==", "cpu": [ - "ia32" + "arm64" ], "dev": true, "license": "MIT", "optional": true, "os": [ "win32" - ] + ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } }, - "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.4.tgz", - "integrity": "sha512-DRS4G7mi9lJxqEDezIkKCaUIKCrLUUDCUaCsTPCi/rtqaC6D/jjwslMQyiDU50Ka0JKpeXeRBFBAXwArY52vBw==", + "node_modules/@rolldown/binding-win32-x64-msvc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@rolldown/binding-win32-x64-msvc/-/binding-win32-x64-msvc-1.0.3.tgz", + "integrity": "sha512-eXB7CHuaQdqmJcc3koCNtNPmT/bj2gc999kUFgBxG8Ac0NdgXc4rkCHhqrgrhN3zddvvvrgzj1e90SuSfmyIXA==", "cpu": [ "x64" ], @@ -1017,21 +1001,17 @@ "optional": true, "os": [ "win32" - ] - }, - "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.4.tgz", - "integrity": "sha512-QVTUovf40zgTqlFVrKA1uXMVvU2QWEFWfAH8Wdc48IxLvrJMQVMBRjuQyUpzZCDkakImib9eVazbWlC6ksWtJw==", - "cpu": [ - "x64" ], + "engines": { + "node": "^20.19.0 || >=22.12.0" + } + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.1.tgz", + "integrity": "sha512-2j9bGt5Jh8hj+vPtgzPtl72j0yRxHAyumoo6TNfAjsLB04UtpSvPbPcDcBMxz7n+9CYB0c1GxQFxYRg2jimqGw==", "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ] + "license": "MIT" }, "node_modules/@standard-schema/spec": { "version": "1.1.0", @@ -1040,6 +1020,17 @@ "dev": true, "license": "MIT" }, + "node_modules/@tybys/wasm-util": { + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.2.tgz", + "integrity": "sha512-RoBvJ2X0wuKlWFIjrwffGw1IqZHKQqzIchKaadZZfnNpsAYp2mM0h36JtPCjNDAHGgYez/15uMBpfGwchhiMgg==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, "node_modules/@types/chai": { "version": "5.2.3", "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", @@ -1059,9 +1050,9 @@ "license": "MIT" }, "node_modules/@types/estree": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", - "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.9.tgz", + "integrity": "sha512-GhdPgy1el4/ImP05X05Uw4cw2/M93BCUmnEvWZNStlCzEKME4Fkk+YpoA5OiHNQmoS7Cafb8Xa3Pya8m1Qrzeg==", "dev": true, "license": "MIT" }, @@ -1086,31 +1077,31 @@ } }, "node_modules/@vitest/expect": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.0.18.tgz", - "integrity": "sha512-8sCWUyckXXYvx4opfzVY03EOiYVxyNrHS5QxX3DAIi5dpJAAkyJezHCP77VMX4HKA2LDT/Jpfo8i2r5BE3GnQQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.8.tgz", + "integrity": "sha512-h3nDO677RDLEGlBxyQ5CW8RlMThSKSRLUePLOx09gNIWRL40edgA1GCZSZgf1W55MFAG6/Sw14KeaAnqv0NKdQ==", "dev": true, "license": "MIT", "dependencies": { - "@standard-schema/spec": "^1.0.0", + "@standard-schema/spec": "^1.1.0", "@types/chai": "^5.2.2", - "@vitest/spy": "4.0.18", - "@vitest/utils": "4.0.18", - "chai": "^6.2.1", - "tinyrainbow": "^3.0.3" + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "chai": "^6.2.2", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.0.18.tgz", - "integrity": "sha512-HhVd0MDnzzsgevnOWCBj5Otnzobjy5wLBe4EdeeFGv8luMsGcYqDuFRMcttKWZA5vVO8RFjexVovXvAM4JoJDQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.8.tgz", + "integrity": "sha512-LEiN/xe4OSIbKe9HQIp5OC24agGD9J5CnmMgsLohVVoOPWL9a2sBoR6VBx43jQZb7Kr1l4RCuyCJzcAa0+dojw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "4.0.18", + "@vitest/spy": "4.1.8", "estree-walker": "^3.0.3", "magic-string": "^0.30.21" }, @@ -1119,7 +1110,7 @@ }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^6.0.0 || ^7.0.0-0" + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "msw": { @@ -1131,26 +1122,26 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.0.18.tgz", - "integrity": "sha512-P24GK3GulZWC5tz87ux0m8OADrQIUVDPIjjj65vBXYG17ZeU3qD7r+MNZ1RNv4l8CGU2vtTRqixrOi9fYk/yKw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.8.tgz", + "integrity": "sha512-9GasEBxpZ1VYIpqHf/0+YGg121uSNwCKOJqIrTwWP/TB7DmFCiaBpNl3aPZzoLWfWkuqhbH8vJIVobZkvdo2cA==", "dev": true, "license": "MIT", "dependencies": { - "tinyrainbow": "^3.0.3" + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.0.18.tgz", - "integrity": "sha512-rpk9y12PGa22Jg6g5M3UVVnTS7+zycIGk9ZNGN+m6tZHKQb7jrP7/77WfZy13Y/EUDd52NDsLRQhYKtv7XfPQw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.8.tgz", + "integrity": "sha512-EmVxeBAfMJvycdjd6Hm+RbFBbA9fKvo0Kx37hNpBYoYeavH3RNsBXWDooR1mgD52dCrxIIuP7UotpfiwOikvcg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "4.0.18", + "@vitest/utils": "4.1.8", "pathe": "^2.0.3" }, "funding": { @@ -1158,13 +1149,14 @@ } }, "node_modules/@vitest/snapshot": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.0.18.tgz", - "integrity": "sha512-PCiV0rcl7jKQjbgYqjtakly6T1uwv/5BQ9SwBLekVg/EaYeQFPiXcgrC2Y7vDMA8dM1SUEAEV82kgSQIlXNMvA==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.8.tgz", + "integrity": "sha512-acfZboRmAIf05DEKcBQy33VXojFJjtUdLyo7oOmV9kebb2xdU01UknNiPuPZoJZQyO7DF0gZdTGTpeAzET9QPQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "4.0.18", + "@vitest/pretty-format": "4.1.8", + "@vitest/utils": "4.1.8", "magic-string": "^0.30.21", "pathe": "^2.0.3" }, @@ -1173,9 +1165,9 @@ } }, "node_modules/@vitest/spy": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.0.18.tgz", - "integrity": "sha512-cbQt3PTSD7P2OARdVW3qWER5EGq7PHlvE+QfzSC0lbwO+xnt7+XH06ZzFjFRgzUX//JmpxrCu92VdwvEPlWSNw==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.8.tgz", + "integrity": "sha512-6EevtBp6OZOPF7bmz36HrGMeP3txgVSrgebWxHOafDXGkhIzfXK14f8KF6MuFfgXXUeHxmpD3BQxkV00/3s5mA==", "dev": true, "license": "MIT", "funding": { @@ -1183,14 +1175,15 @@ } }, "node_modules/@vitest/utils": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.0.18.tgz", - "integrity": "sha512-msMRKLMVLWygpK3u2Hybgi4MNjcYJvwTb0Ru09+fOyCXIgT5raYP041DRRdiJiI3k/2U6SEbAETB3YtBrUkCFA==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.8.tgz", + "integrity": "sha512-uOJamYALNhfJ6iolExyQM40yIQwDqYnkKtQ5VCiSe17E33H0aQ/u+1GlRuz4LZBk6Mm3sg90G9hEbmEt37C1Zg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "4.0.18", - "tinyrainbow": "^3.0.3" + "@vitest/pretty-format": "4.1.8", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" @@ -1355,6 +1348,13 @@ "node": ">= 0.6" } }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, "node_modules/cookie": { "version": "0.7.2", "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", @@ -1499,9 +1499,9 @@ } }, "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.1.0.tgz", + "integrity": "sha512-n27zTYMjYu1aj4MjCWzSP7G9r75utsaoc8m61weK+W8JMBGGQybd43GstCXZ3WNmSFtGT9wi59qQTW6mhTR5LQ==", "dev": true, "license": "MIT" }, @@ -1519,9 +1519,9 @@ } }, "node_modules/esbuild": { - "version": "0.27.2", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.2.tgz", - "integrity": "sha512-HyNQImnsOC7X9PMNaCIeAm4ISCQXs5a5YasTXVliKv4uuBo1dKrG0A+uQS8M5eXjVMnLg3WgXaKvprHlFJQffw==", + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.1.tgz", + "integrity": "sha512-HrJrvZv5ayxBzPfwphOoNzkzOIIlifzk0KJrGK2c8R4+LKpMtpYLQeUdjnwjWv/LZlkH2laZk+4w78pi99D4Vw==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -1532,32 +1532,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.27.2", - "@esbuild/android-arm": "0.27.2", - "@esbuild/android-arm64": "0.27.2", - "@esbuild/android-x64": "0.27.2", - "@esbuild/darwin-arm64": "0.27.2", - "@esbuild/darwin-x64": "0.27.2", - "@esbuild/freebsd-arm64": "0.27.2", - "@esbuild/freebsd-x64": "0.27.2", - "@esbuild/linux-arm": "0.27.2", - "@esbuild/linux-arm64": "0.27.2", - "@esbuild/linux-ia32": "0.27.2", - "@esbuild/linux-loong64": "0.27.2", - "@esbuild/linux-mips64el": "0.27.2", - "@esbuild/linux-ppc64": "0.27.2", - "@esbuild/linux-riscv64": "0.27.2", - "@esbuild/linux-s390x": "0.27.2", - "@esbuild/linux-x64": "0.27.2", - "@esbuild/netbsd-arm64": "0.27.2", - "@esbuild/netbsd-x64": "0.27.2", - "@esbuild/openbsd-arm64": "0.27.2", - "@esbuild/openbsd-x64": "0.27.2", - "@esbuild/openharmony-arm64": "0.27.2", - "@esbuild/sunos-x64": "0.27.2", - "@esbuild/win32-arm64": "0.27.2", - "@esbuild/win32-ia32": "0.27.2", - "@esbuild/win32-x64": "0.27.2" + "@esbuild/aix-ppc64": "0.28.1", + "@esbuild/android-arm": "0.28.1", + "@esbuild/android-arm64": "0.28.1", + "@esbuild/android-x64": "0.28.1", + "@esbuild/darwin-arm64": "0.28.1", + "@esbuild/darwin-x64": "0.28.1", + "@esbuild/freebsd-arm64": "0.28.1", + "@esbuild/freebsd-x64": "0.28.1", + "@esbuild/linux-arm": "0.28.1", + "@esbuild/linux-arm64": "0.28.1", + "@esbuild/linux-ia32": "0.28.1", + "@esbuild/linux-loong64": "0.28.1", + "@esbuild/linux-mips64el": "0.28.1", + "@esbuild/linux-ppc64": "0.28.1", + "@esbuild/linux-riscv64": "0.28.1", + "@esbuild/linux-s390x": "0.28.1", + "@esbuild/linux-x64": "0.28.1", + "@esbuild/netbsd-arm64": "0.28.1", + "@esbuild/netbsd-x64": "0.28.1", + "@esbuild/openbsd-arm64": "0.28.1", + "@esbuild/openbsd-x64": "0.28.1", + "@esbuild/openharmony-arm64": "0.28.1", + "@esbuild/sunos-x64": "0.28.1", + "@esbuild/win32-arm64": "0.28.1", + "@esbuild/win32-ia32": "0.28.1", + "@esbuild/win32-x64": "0.28.1" } }, "node_modules/escape-html": { @@ -1691,9 +1691,9 @@ "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.2.tgz", - "integrity": "sha512-rVjf7ArG3LTk+FS6Yw81V1DLuZl1bRbNrev6Tmd/9RaroeeRRJhAt7jg/6YFxbvAQXUCavSoZhPPj6oOx+5KjQ==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.5.tgz", + "integrity": "sha512-gHwA1O9LDIcKunMKhObS/HimwtehO1nPUECKAu5TpKgaO19fcWEl4bliWe1jWxVFvIXztJjjQ4L8XQ1EU9f7Jw==", "dev": true, "funding": [ { @@ -1831,19 +1831,6 @@ "node": ">= 0.4" } }, - "node_modules/get-tsconfig": { - "version": "4.13.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.0.tgz", - "integrity": "sha512-1VKTZJCwBrvbd+Wn3AOgQP/2Av+TfTCOlE4AcRJE72W1ksZXbAx8PPBR9RzgTeSPzlPMHrbANMH3LbltH73wxQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, "node_modules/gopd": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", @@ -1884,9 +1871,9 @@ } }, "node_modules/hono": { - "version": "4.12.23", - "resolved": "https://registry.npmjs.org/hono/-/hono-4.12.23.tgz", - "integrity": "sha512-eIaZ9qDgu7XV0pxOCrg7/WhnQ6Ivm22UcxhXx/A3dcbqbbYgBEkc6e/J/s7j2tS96zoB0S9VBdLwQNCWwUo4LA==", + "version": "4.12.32", + "resolved": "https://registry.npmjs.org/hono/-/hono-4.12.32.tgz", + "integrity": "sha512-XcuyW9qE2kJn07PkecMOBd5Vq/hMy7mmGw+idz1yblbg9N17ijJODrvPkn7/dwL3Kulj8LcRJ69DLOWf91dRUg==", "dev": true, "license": "MIT", "engines": { @@ -1939,9 +1926,9 @@ "license": "ISC" }, "node_modules/ip-address": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.2.0.tgz", - "integrity": "sha512-/+S6j4E9AHvW9SWMSEY9Xfy66O5PWvVEJ08O0y5JGyEKQpojb0K0GKpz/v5HJ/G0vi3D2sjGK78119oXZeE0qA==", + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.4.0.tgz", + "integrity": "sha512-oSK96Grm3aP6OrS263xVxbNDGVL7rzBtYdpGqlDG8iQdoenDoTs/nkki+DflYbAEE8Xl6o5YxhxlrKvI3nqKXQ==", "dev": true, "license": "MIT", "engines": { @@ -1996,6 +1983,267 @@ "dev": true, "license": "BSD-2-Clause" }, + "node_modules/lightningcss": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.32.0.tgz", + "integrity": "sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==", + "dev": true, + "license": "MPL-2.0", + "dependencies": { + "detect-libc": "^2.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-android-arm64": "1.32.0", + "lightningcss-darwin-arm64": "1.32.0", + "lightningcss-darwin-x64": "1.32.0", + "lightningcss-freebsd-x64": "1.32.0", + "lightningcss-linux-arm-gnueabihf": "1.32.0", + "lightningcss-linux-arm64-gnu": "1.32.0", + "lightningcss-linux-arm64-musl": "1.32.0", + "lightningcss-linux-x64-gnu": "1.32.0", + "lightningcss-linux-x64-musl": "1.32.0", + "lightningcss-win32-arm64-msvc": "1.32.0", + "lightningcss-win32-x64-msvc": "1.32.0" + } + }, + "node_modules/lightningcss-android-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-android-arm64/-/lightningcss-android-arm64-1.32.0.tgz", + "integrity": "sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.32.0.tgz", + "integrity": "sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.32.0.tgz", + "integrity": "sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.32.0.tgz", + "integrity": "sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.32.0.tgz", + "integrity": "sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.32.0.tgz", + "integrity": "sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.32.0.tgz", + "integrity": "sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.32.0.tgz", + "integrity": "sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.32.0.tgz", + "integrity": "sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-arm64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.32.0.tgz", + "integrity": "sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.32.0", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.32.0.tgz", + "integrity": "sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, "node_modules/magic-string": { "version": "0.30.21", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", @@ -2074,9 +2322,9 @@ "license": "MIT" }, "node_modules/nanoid": { - "version": "3.3.12", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", - "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", + "version": "3.3.17", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.17.tgz", + "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==", "dev": true, "funding": [ { @@ -2260,9 +2508,9 @@ } }, "node_modules/postcss": { - "version": "8.5.15", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.15.tgz", - "integrity": "sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A==", + "version": "8.5.25", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.25.tgz", + "integrity": "sha512-DTPx3RWSSnWyzLxQnlH0rJP+EW5ekl16ZU4/psbIhA0e53kJfdgaN5vKM+xP7yJtXVu+nfdVFmlgFDEKAe4Pyw==", "dev": true, "funding": [ { @@ -2280,7 +2528,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.12", + "nanoid": "^3.3.16", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -2354,59 +2602,38 @@ "node": ">=0.10.0" } }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, - "node_modules/rollup": { - "version": "4.60.4", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.4.tgz", - "integrity": "sha512-WHeFSbZYsPu3+bLoNRUuAO+wavNlocOPf3wSHTP7hcFKVnJeWsYlCDbr3mTS14FCizf9ccIxXA8sGL8zKeQN3g==", + "node_modules/rolldown": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/rolldown/-/rolldown-1.0.3.tgz", + "integrity": "sha512-i00lAJ2ks1BYr7rjNjKC7BcqAS7nVfiT3QX1SI5aY+AFHblCmaUf9OE9dbdzDvW6dJxbi2ZCZiy9v3CcwOiX3g==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.8" + "@oxc-project/types": "=0.133.0", + "@rolldown/pluginutils": "^1.0.0" }, "bin": { - "rollup": "dist/bin/rollup" + "rolldown": "bin/cli.mjs" }, "engines": { - "node": ">=18.0.0", - "npm": ">=8.0.0" + "node": "^20.19.0 || >=22.12.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.60.4", - "@rollup/rollup-android-arm64": "4.60.4", - "@rollup/rollup-darwin-arm64": "4.60.4", - "@rollup/rollup-darwin-x64": "4.60.4", - "@rollup/rollup-freebsd-arm64": "4.60.4", - "@rollup/rollup-freebsd-x64": "4.60.4", - "@rollup/rollup-linux-arm-gnueabihf": "4.60.4", - "@rollup/rollup-linux-arm-musleabihf": "4.60.4", - "@rollup/rollup-linux-arm64-gnu": "4.60.4", - "@rollup/rollup-linux-arm64-musl": "4.60.4", - "@rollup/rollup-linux-loong64-gnu": "4.60.4", - "@rollup/rollup-linux-loong64-musl": "4.60.4", - "@rollup/rollup-linux-ppc64-gnu": "4.60.4", - "@rollup/rollup-linux-ppc64-musl": "4.60.4", - "@rollup/rollup-linux-riscv64-gnu": "4.60.4", - "@rollup/rollup-linux-riscv64-musl": "4.60.4", - "@rollup/rollup-linux-s390x-gnu": "4.60.4", - "@rollup/rollup-linux-x64-gnu": "4.60.4", - "@rollup/rollup-linux-x64-musl": "4.60.4", - "@rollup/rollup-openbsd-x64": "4.60.4", - "@rollup/rollup-openharmony-arm64": "4.60.4", - "@rollup/rollup-win32-arm64-msvc": "4.60.4", - "@rollup/rollup-win32-ia32-msvc": "4.60.4", - "@rollup/rollup-win32-x64-gnu": "4.60.4", - "@rollup/rollup-win32-x64-msvc": "4.60.4", - "fsevents": "~2.3.2" + "@rolldown/binding-android-arm64": "1.0.3", + "@rolldown/binding-darwin-arm64": "1.0.3", + "@rolldown/binding-darwin-x64": "1.0.3", + "@rolldown/binding-freebsd-x64": "1.0.3", + "@rolldown/binding-linux-arm-gnueabihf": "1.0.3", + "@rolldown/binding-linux-arm64-gnu": "1.0.3", + "@rolldown/binding-linux-arm64-musl": "1.0.3", + "@rolldown/binding-linux-ppc64-gnu": "1.0.3", + "@rolldown/binding-linux-s390x-gnu": "1.0.3", + "@rolldown/binding-linux-x64-gnu": "1.0.3", + "@rolldown/binding-linux-x64-musl": "1.0.3", + "@rolldown/binding-openharmony-arm64": "1.0.3", + "@rolldown/binding-wasm32-wasi": "1.0.3", + "@rolldown/binding-win32-arm64-msvc": "1.0.3", + "@rolldown/binding-win32-x64-msvc": "1.0.3" } }, "node_modules/router": { @@ -2621,9 +2848,9 @@ } }, "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.1.0.tgz", + "integrity": "sha512-Rq7ybcX2RuC55r9oaPVEW7/xu3tj8u4GeBYHBWCychFtzMIr86A7e3PPEBPT37sHStKX3+TiX/Fr/ACmJLVlLQ==", "dev": true, "license": "MIT" }, @@ -2645,14 +2872,14 @@ } }, "node_modules/tinyglobby": { - "version": "0.2.15", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", - "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "version": "0.2.17", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz", + "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==", "dev": true, "license": "MIT", "dependencies": { "fdir": "^6.5.0", - "picomatch": "^4.0.3" + "picomatch": "^4.0.4" }, "engines": { "node": ">=12.0.0" @@ -2662,9 +2889,9 @@ } }, "node_modules/tinyrainbow": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.0.3.tgz", - "integrity": "sha512-PSkbLUoxOFRzJYjjxHJt9xro7D+iilgMX/C9lawzVuYiIdcihh9DXmVibBe8lmcFrRi/VzlPjBxbN7rH24q8/Q==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", "dev": true, "license": "MIT", "engines": { @@ -2681,15 +2908,22 @@ "node": ">=0.6" } }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "dev": true, + "license": "0BSD", + "optional": true + }, "node_modules/tsx": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", - "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.22.4.tgz", + "integrity": "sha512-X8EX+XV4QR5xCsrgxaED954zTDfY8KqlDtskKEL0cHhyS/P8b4IFOvGDQpsC9Q1XnLq915wEfwwY/zzskCtmhg==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "~0.27.0", - "get-tsconfig": "^4.7.5" + "esbuild": "~0.28.0" }, "bin": { "tsx": "dist/cli.mjs" @@ -2758,18 +2992,17 @@ } }, "node_modules/vite": { - "version": "7.3.3", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.3.tgz", - "integrity": "sha512-/4XH147Ui7OGTjg3HbdWe5arnZQSbfuRzdr9Ec7TQi5I7R+ir0Rlc9GIvD4v0XZurELqA035KVXJXpR61xhiTA==", + "version": "8.0.16", + "resolved": "https://registry.npmjs.org/vite/-/vite-8.0.16.tgz", + "integrity": "sha512-h9bXPmJichP5fLmVQo3PyaGSDE2n3aPuomeAlVRm0JLmt4rY6zmPKd59HYI4LNW8oTK7tlTsuC7l/m7awx9Jcw==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.27.0", - "fdir": "^6.5.0", - "picomatch": "^4.0.3", - "postcss": "^8.5.6", - "rollup": "^4.43.0", - "tinyglobby": "^0.2.15" + "lightningcss": "^1.32.0", + "picomatch": "^4.0.4", + "postcss": "^8.5.15", + "rolldown": "1.0.3", + "tinyglobby": "^0.2.17" }, "bin": { "vite": "bin/vite.js" @@ -2785,9 +3018,10 @@ }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", + "@vitejs/devtools": "^0.1.18", + "esbuild": "^0.27.0 || ^0.28.0", "jiti": ">=1.21.0", "less": "^4.0.0", - "lightningcss": "^1.21.0", "sass": "^1.70.0", "sass-embedded": "^1.70.0", "stylus": ">=0.54.8", @@ -2800,13 +3034,16 @@ "@types/node": { "optional": true }, - "jiti": { + "@vitejs/devtools": { "optional": true }, - "less": { + "esbuild": { + "optional": true + }, + "jiti": { "optional": true }, - "lightningcss": { + "less": { "optional": true }, "sass": { @@ -2833,31 +3070,31 @@ } }, "node_modules/vitest": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.0.18.tgz", - "integrity": "sha512-hOQuK7h0FGKgBAas7v0mSAsnvrIgAvWmRFjmzpJ7SwFHH3g1k2u37JtYwOwmEKhK6ZO3v9ggDBBm0La1LCK4uQ==", + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.8.tgz", + "integrity": "sha512-flY6ScbCIt9HThs+C5HS7jvGOB560DJtk/Z15IQROTA6zEy49Nh8T/dofWTQL+n3vswqn87sbJNiuqw1SDp5Ig==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "4.0.18", - "@vitest/mocker": "4.0.18", - "@vitest/pretty-format": "4.0.18", - "@vitest/runner": "4.0.18", - "@vitest/snapshot": "4.0.18", - "@vitest/spy": "4.0.18", - "@vitest/utils": "4.0.18", - "es-module-lexer": "^1.7.0", - "expect-type": "^1.2.2", + "@vitest/expect": "4.1.8", + "@vitest/mocker": "4.1.8", + "@vitest/pretty-format": "4.1.8", + "@vitest/runner": "4.1.8", + "@vitest/snapshot": "4.1.8", + "@vitest/spy": "4.1.8", + "@vitest/utils": "4.1.8", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", "magic-string": "^0.30.21", "obug": "^2.1.1", "pathe": "^2.0.3", "picomatch": "^4.0.3", - "std-env": "^3.10.0", + "std-env": "^4.0.0-rc.1", "tinybench": "^2.9.0", "tinyexec": "^1.0.2", "tinyglobby": "^0.2.15", - "tinyrainbow": "^3.0.3", - "vite": "^6.0.0 || ^7.0.0", + "tinyrainbow": "^3.1.0", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0", "why-is-node-running": "^2.3.0" }, "bin": { @@ -2873,12 +3110,15 @@ "@edge-runtime/vm": "*", "@opentelemetry/api": "^1.9.0", "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", - "@vitest/browser-playwright": "4.0.18", - "@vitest/browser-preview": "4.0.18", - "@vitest/browser-webdriverio": "4.0.18", - "@vitest/ui": "4.0.18", + "@vitest/browser-playwright": "4.1.8", + "@vitest/browser-preview": "4.1.8", + "@vitest/browser-webdriverio": "4.1.8", + "@vitest/coverage-istanbul": "4.1.8", + "@vitest/coverage-v8": "4.1.8", + "@vitest/ui": "4.1.8", "happy-dom": "*", - "jsdom": "*" + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "@edge-runtime/vm": { @@ -2899,6 +3139,12 @@ "@vitest/browser-webdriverio": { "optional": true }, + "@vitest/coverage-istanbul": { + "optional": true + }, + "@vitest/coverage-v8": { + "optional": true + }, "@vitest/ui": { "optional": true }, @@ -2907,6 +3153,9 @@ }, "jsdom": { "optional": true + }, + "vite": { + "optional": false } } }, diff --git a/test/harness/package.json b/test/harness/package.json index fd605ead4..6290d3371 100644 --- a/test/harness/package.json +++ b/test/harness/package.json @@ -10,8 +10,11 @@ "start": "tsx server.ts", "test": "vitest run" }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, "devDependencies": { - "@github/copilot": "^1.0.56-2", + "@github/copilot": "^1.0.80", "@modelcontextprotocol/sdk": "^1.26.0", "@types/node": "^25.3.3", "@types/node-forge": "^1.3.14", diff --git a/test/harness/replayingCapiProxy.test.ts b/test/harness/replayingCapiProxy.test.ts index 2ac1f76c2..c5747a306 100644 --- a/test/harness/replayingCapiProxy.test.ts +++ b/test/harness/replayingCapiProxy.test.ts @@ -348,9 +348,9 @@ describe("ReplayingCapiProxy", () => { }); test("normalizes task completion notification wording", async () => { - const unreadNotification = [ + const idleNotification = [ "", - 'Agent "sdk-background-agent" (general-purpose) has completed successfully. Use read_agent with agent_id "sdk-background-agent" to retrieve unread results.', + 'Agent "sdk-background-agent" (general-purpose) has finished processing and is now idle. Use read_agent with agent_id "sdk-background-agent" to read the results, or write_agent to send follow-up messages.', "", ].join("\n"); const fullNotification = [ @@ -363,7 +363,7 @@ describe("ReplayingCapiProxy", () => { messages: [ { role: "user", - content: unreadNotification, + content: idleNotification, }, ], }); @@ -509,7 +509,82 @@ Always include PINEAPPLE_COCONUT_42. expect(toolMessages[1].content).toBe("[beta result]"); }); - test("normalizes read_agent timing metadata", async () => { + test("removes the runtime-specific available-tools list", async () => { + const requestBody = JSON.stringify({ + messages: [ + { role: "user", content: "Help me" }, + { + role: "assistant", + tool_calls: [ + { + id: "tc1", + type: "function", + function: { name: "report_intent", arguments: "{}" }, + }, + ], + }, + { + role: "tool", + tool_call_id: "tc1", + content: + "Tool 'report_intent' does not exist. Available tools that can be called are bash, read_bash, view, read_agent, list_agents, write_agent, grep, glob, task.", + }, + ], + }); + const responseBody = JSON.stringify({ + choices: [{ message: { role: "assistant", content: "Done" } }], + }); + + const outputPath = await createProxy([ + { url: "/chat/completions", requestBody, responseBody }, + ]); + + const result = await readYamlOutput(outputPath); + const toolMessage = result.conversations[0].messages.find( + (m) => m.role === "tool", + ); + expect(toolMessage?.content).toBe("Tool 'report_intent' does not exist."); + }); + + test("removes runtime advisories from background agent start results", async () => { + const stableResult = + "Agent started in background with agent_id: read-file. You'll be notified when it completes. Tell the user you're waiting and end your response, or continue unrelated work until notified."; + const requestBody = JSON.stringify({ + messages: [ + { role: "user", content: "Help me" }, + { + role: "assistant", + tool_calls: [ + { + id: "tc1", + type: "function", + function: { name: "task", arguments: "{}" }, + }, + ], + }, + { + role: "tool", + tool_call_id: "tc1", + content: `${stableResult} The agent supports multi-turn conversations.`, + }, + ], + }); + const responseBody = JSON.stringify({ + choices: [{ message: { role: "assistant", content: "Done" } }], + }); + + const outputPath = await createProxy([ + { url: "/chat/completions", requestBody, responseBody }, + ]); + + const result = await readYamlOutput(outputPath); + const toolMessage = result.conversations[0].messages.find( + (m) => m.role === "tool", + ); + expect(toolMessage?.content).toBe(stableResult); + }); + + test("normalizes read_agent result metadata", async () => { const requestBody = JSON.stringify({ messages: [ { role: "user", content: "Help me" }, @@ -530,7 +605,7 @@ Always include PINEAPPLE_COCONUT_42. role: "tool", tool_call_id: "tc1", content: - "Agent completed. agent_id: read-file, agent_type: explore, status: completed, description: Reading subagent-test.txt, elapsed: 1.25s, total_turns: 0, duration: 2s\n\nDone.", + "Agent is idle (waiting for messages). agent_id: read-file, agent_type: explore, status: idle, description: Reading subagent-test.txt, elapsed: 1.25s, total_turns: 1\n\n[Turn 0]\nDone.", }, ], }); @@ -745,6 +820,167 @@ Always include PINEAPPLE_COCONUT_42. } }); + test("matches shell tool results with shell ID completion markers", async () => { + const originalShellConfig = + process.platform === "win32" ? ShellConfig.powerShell : ShellConfig.bash; + const cachePath = path.join(tempDir, "cache.yaml"); + const cacheContent = yaml.stringify({ + models: ["test-model"], + conversations: [ + { + messages: [ + { role: "system", content: "${system}" }, + { role: "user", content: "Run command" }, + { + role: "assistant", + tool_calls: [ + { + id: "toolcall_0", + type: "function", + function: { + name: "${shell}", + arguments: '{"command":"echo ok"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "toolcall_0", + content: "ok\n", + }, + { role: "assistant", content: "Done" }, + ], + }, + ], + } satisfies NormalizedData); + await writeFile(cachePath, cacheContent); + + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + + try { + const response = await makeRequest(proxyUrl, "/chat/completions", { + body: { + model: "test-model", + messages: [ + { role: "system", content: "System prompt" }, + { role: "user", content: "Run command" }, + { + role: "assistant", + tool_calls: [ + { + id: "runtime-call-id", + type: "function", + function: { + name: originalShellConfig.shellToolName, + arguments: '{"command":"echo ok"}', + }, + }, + ], + }, + { + role: "tool", + tool_call_id: "runtime-call-id", + content: "ok\n", + }, + ], + }, + }); + + expect(response.status).toBe(200); + expect( + (JSON.parse(response.body) as ChatCompletion).choices[0].message + .content, + ).toBe("Done"); + } finally { + await proxy.stop(); + } + }); + + test("matches available-tools results after the built-in tool set changes", async () => { + const cachePath = path.join(tempDir, "cache.yaml"); + // Legacy snapshot recorded before write_agent was a built-in tool: the + // enumeration frozen on disk still contains the older tool list. + const cacheContent = yaml.stringify({ + models: ["test-model"], + conversations: [ + { + messages: [ + { role: "system", content: "${system}" }, + { role: "user", content: "Report intent" }, + { + role: "assistant", + tool_calls: [ + { + id: "toolcall_0", + type: "function", + function: { name: "report_intent", arguments: "{}" }, + }, + ], + }, + { + role: "tool", + tool_call_id: "toolcall_0", + content: + "Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, view, read_agent, list_agents, grep, glob, task.", + }, + { role: "assistant", content: "Done" }, + ], + }, + ], + } satisfies NormalizedData); + await writeFile(cachePath, cacheContent); + + const proxy = new ReplayingCapiProxy( + "http://localhost:9999", + cachePath, + workDir, + ); + const proxyUrl = await proxy.start(); + + try { + const response = await makeRequest(proxyUrl, "/chat/completions", { + body: { + model: "test-model", + messages: [ + { role: "system", content: "System prompt" }, + { role: "user", content: "Report intent" }, + { + role: "assistant", + tool_calls: [ + { + id: "runtime-call-id", + type: "function", + function: { name: "report_intent", arguments: "{}" }, + }, + ], + }, + { + role: "tool", + tool_call_id: "runtime-call-id", + // Newer runtime added write_agent to the built-in tool set. + content: + "Tool 'report_intent' does not exist. Available tools that can be called are bash, read_bash, view, read_agent, list_agents, write_agent, grep, glob, task.", + }, + ], + }, + }); + + expect(response.status).toBe(200); + expect( + (JSON.parse(response.body) as ChatCompletion).choices[0].message + .content, + ).toBe("Done"); + } finally { + await proxy.stop(); + } + }); + test("expands workdir placeholder in cached response", async () => { const cachePath = path.join(tempDir, "cache.yaml"); const cacheContent = yaml.stringify({ @@ -873,6 +1109,11 @@ Always include PINEAPPLE_COCONUT_42. 'Agent "read-file" (explore) has completed successfully. Use read_agent with agent_id "read-file" to retrieve unread results.', "", ].join("\n"); + const idleNotification = [ + "", + 'Agent "read-file" (explore) has finished processing and is now idle. Use read_agent with agent_id "read-file" to read the results, or write_agent to send follow-up messages.', + "", + ].join("\n"); const cacheContent = yaml.stringify({ models: ["test-model"], @@ -905,7 +1146,7 @@ Always include PINEAPPLE_COCONUT_42. { role: "system", content: "Be helpful" }, { role: "user", content: "Hello" }, { role: "assistant", content: "Hi!" }, - { role: "user", content: unreadNotification }, + { role: "user", content: idleNotification }, ], }, }); diff --git a/test/harness/replayingCapiProxy.ts b/test/harness/replayingCapiProxy.ts index bee00ffcc..4c1be59f2 100644 --- a/test/harness/replayingCapiProxy.ts +++ b/test/harness/replayingCapiProxy.ts @@ -2,7 +2,7 @@ * Copyright (c) Microsoft Corporation. All rights reserved. *--------------------------------------------------------------------------------------------*/ -import { existsSync, appendFileSync } from "fs"; +import { appendFileSync, existsSync } from "fs"; import { mkdir, readFile, writeFile } from "fs/promises"; import type { ChatCompletion, @@ -19,10 +19,81 @@ import { CapturingHttpProxy, PerformRequestOptions, } from "./capturingHttpProxy"; +export type { CapturedRequest } from "./capturingHttpProxy"; +import { + anthropicMessagesEndpoint, + anthropicMessagesRequestToChatCompletion, + chatCompletionResponseToAnthropicMessage, + chatCompletionResponseToAnthropicSseChunks, +} from "./anthropicMessagesAdapter"; +import { + chatCompletionResponseToResponsesApiMessage, + chatCompletionResponseToResponsesApiSseChunks, + responsesApiRequestToChatCompletion, + responsesEndpoint, +} from "./responsesApiAdapter"; import { iife, ShellConfig, sleep } from "./util"; export const workingDirPlaceholder = "${workdir}"; const chatCompletionEndpoint = "/chat/completions"; +export type ReplayBackend = + | "capi" + | "anthropic-messages" + | "openai-responses" + | "openai-completions"; + +type ReplayProtocol = { + endpoint: string; + normalizeRequest?: (body: string) => string; + responseBody?: (response: ChatCompletion) => unknown; + responseChunks: (response: ChatCompletion) => string[]; + responseEndChunk?: string; + errorBody?: (code: string | undefined, message: string) => unknown; + canonicalResponse?: boolean; +}; + +const chatCompletionsProtocol = { + endpoint: chatCompletionEndpoint, + responseChunks: (response) => + convertToStreamingResponseChunks(response).map( + (chunk) => `data: ${JSON.stringify(chunk)}\n\n`, + ), + responseEndChunk: "data: [DONE]\n\n", + canonicalResponse: true, +} satisfies ReplayProtocol; + +const replayProtocols: Record = { + capi: chatCompletionsProtocol, + "openai-completions": { + ...chatCompletionsProtocol, + normalizeRequest: coalesceAdjacentUserMessages, + }, + "anthropic-messages": { + endpoint: anthropicMessagesEndpoint, + normalizeRequest: (body) => + coalesceAdjacentUserMessages( + anthropicMessagesRequestToChatCompletion(body), + ), + responseBody: chatCompletionResponseToAnthropicMessage, + responseChunks: chatCompletionResponseToAnthropicSseChunks, + errorBody: (code, message) => { + const type = code ?? "rate_limited"; + return { type: "error", error: { type, message } }; + }, + }, + "openai-responses": { + endpoint: responsesEndpoint, + normalizeRequest: (body) => + coalesceAdjacentUserMessages(responsesApiRequestToChatCompletion(body)), + responseBody: chatCompletionResponseToResponsesApiMessage, + responseChunks: chatCompletionResponseToResponsesApiSseChunks, + }, +}; + +const modelEndpoints = new Set( + Object.values(replayProtocols).map((protocol) => protocol.endpoint), +); + const shellConfig = process.platform === "win32" ? ShellConfig.powerShell : ShellConfig.bash; const normalizedToolNames: Record = { @@ -54,8 +125,11 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { private startPromise: Promise | null = null; private defaultToolResultNormalizers: ToolResultNormalizer[] = [ { toolName: "*", normalizer: normalizeLargeOutputFilepaths }, + { toolName: "${shell}", normalizer: normalizeShellExitMarkers }, { toolName: "*", normalizer: normalizeGhAuthMessages }, - { toolName: "read_agent", normalizer: normalizeReadAgentTimings }, + { toolName: "*", normalizer: normalizeAvailableToolNames }, + { toolName: "*", normalizer: normalizeBackgroundAgentStartMessage }, + { toolName: "read_agent", normalizer: normalizeReadAgentResult }, ]; /** @@ -88,6 +162,7 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { filePath, workDir, testInfo, + backend: "capi", toolResultNormalizers: [...this.defaultToolResultNormalizers], }; } @@ -110,7 +185,10 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { // In CI mode (GITHUB_ACTIONS=true) we never write — the snapshots are read-only. // Otherwise tests that exercise only a subset of a multi-conversation snapshot // would silently overwrite the file with that subset, breaking subsequent runs. - if (this.state && process.env.GITHUB_ACTIONS !== "true") { + if ( + this.state?.backend === "capi" && + process.env.GITHUB_ACTIONS !== "true" + ) { await writeCapturesToDisk(this.exchanges, this.state); } @@ -118,6 +196,7 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { filePath: config.filePath, workDir: config.workDir, testInfo: config.testInfo, + backend: parseReplayBackend(config.backend), toolResultNormalizers: [...this.defaultToolResultNormalizers], }; @@ -131,15 +210,21 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { this.state.storedData = yaml.parse(content) as NormalizedData; normalizeToolResultOrder(this.state.storedData.conversations); normalizeStoredUserMessages(this.state.storedData.conversations); + normalizeStoredToolMessages(this.state.storedData.conversations); + normalizeStoredMessagesForBackend( + this.state.storedData.conversations, + this.state.backend, + ); } } async stop(skipWritingCache?: boolean): Promise { await super.stop(); - // In CI mode we never write — the snapshots are read-only. + // CAPI is the authoritative capture path. BYOK modes only verify that the + // same canonical snapshots replay through each provider protocol. if ( - this.state && + this.state?.backend === "capi" && !skipWritingCache && process.env.GITHUB_ACTIONS !== "true" ) { @@ -221,17 +306,21 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { options.requestOptions.path === "/exchanges" && options.requestOptions.method === "GET" ) { - const chatCompletionExchanges = this.exchanges.filter( - (e) => e.request.url === chatCompletionEndpoint, - ); + const protocol = + replayProtocols[this.state?.backend ?? "capi"]; const parsedExchanges = await Promise.all( - chatCompletionExchanges.map((e) => - parseHttpExchange( - e.request.body, - e.response?.body, - e.request.headers, + this.exchanges + .filter((exchange) => exchange.request.url === protocol.endpoint) + .map((exchange) => + parseHttpExchange( + protocol.normalizeRequest?.(exchange.request.body) ?? + exchange.request.body, + protocol.canonicalResponse + ? exchange.response?.body + : undefined, + exchange.request.headers, + ), ), - ), ); options.onResponseStart(200, {}); options.onData(Buffer.from(JSON.stringify(parsedExchanges))); @@ -239,34 +328,26 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { return; } - const state = this.state; - if (!state) { - throw new Error( - "ReplayingCapiProxy not yet initialized. Either pass filePath and workDir to the constructor, " + - "or post configuration to /config before making other HTTP requests.", - ); - } - - // Handle /models endpoint - // Use stored models if available, otherwise use default model - if (options.requestOptions.path === "/models") { - const models = - state.storedData?.models && state.storedData.models.length > 0 - ? state.storedData.models - : [defaultModel]; - const modelsResponse = createGetModelsResponse(models); - const body = JSON.stringify(modelsResponse); - const headers = { - "content-type": "application/json", - ...commonResponseHeaders, - }; - options.onResponseStart(200, headers); - options.onData(Buffer.from(body)); + // Handle /requests endpoint for retrieving all captured outbound requests. + if ( + options.requestOptions.path === "/requests" && + options.requestOptions.method === "GET" + ) { + const requests = this.exchanges + .map((exchange) => exchange.request) + .filter((request) => request.url !== "/requests"); + options.onResponseStart(200, { "content-type": "application/json" }); + options.onData(Buffer.from(JSON.stringify(requests))); options.onResponseEnd(); return; } - // Handle /copilot_internal/user endpoint for per-session auth + // Handle /copilot_internal/user endpoint for per-session auth. + // This must run before the state guard below: the CLI authenticates and + // calls /copilot_internal/user at startup, which can race ahead of the + // per-test POST /config (e.g. the Go harness spawns the CLI before the + // first ConfigureForTest). The response only depends on the token map, + // which is populated independently of `state`. if (options.requestOptions.path === "/copilot_internal/user") { const headers = options.requestOptions.headers; const headerMap = headers as @@ -281,9 +362,15 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { ? rawAuthHeader : undefined; const token = authHeader?.replace("Bearer ", ""); - const userResponse = token + const registered = token ? this.copilotUserByToken.get(token) : undefined; + // The CLI gates third-party MCP servers behind the copilot user's + // `is_mcp_enabled` flag (a null/missing value disables them). Default + // it to true so e2e MCP servers are enabled unless a test opts out. + const userResponse = registered + ? ({ is_mcp_enabled: true, ...registered } as CopilotUserResponse) + : undefined; if (userResponse) { const headers = { "content-type": "application/json", @@ -302,6 +389,78 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { return; } + const state = this.state; + if (!state) { + throw new Error( + "ReplayingCapiProxy not yet initialized. Either pass filePath and workDir to the constructor, " + + "or post configuration to /config before making other HTTP requests.", + ); + } + + // Handle /models endpoint + // Use stored models if available, otherwise use default model + if (options.requestOptions.path === "/models") { + const models = + state.storedData?.models && state.storedData.models.length > 0 + ? state.storedData.models + : [defaultModel]; + const modelsResponse = createGetModelsResponse(models); + const body = JSON.stringify(modelsResponse); + const headers = { + "content-type": "application/json", + ...commonResponseHeaders, + }; + options.onResponseStart(200, headers); + options.onData(Buffer.from(body)); + options.onResponseEnd(); + return; + } + + // Keep GitHub MCP tests hermetic while still capturing the request at + // the CAPI proxy. The tests only need a successful transport handshake; + // no fake tools are exposed. + if (options.requestOptions.path === "/mcp") { + if (options.requestOptions.method !== "POST") { + options.onResponseStart(200, commonResponseHeaders); + options.onResponseEnd(); + return; + } + + const request = JSON.parse(options.body ?? "{}") as { + id?: string | number; + method?: string; + params?: { protocolVersion?: string }; + }; + if (request.id === undefined) { + options.onResponseStart(202, commonResponseHeaders); + options.onResponseEnd(); + return; + } + + const result = + request.method === "initialize" + ? { + protocolVersion: + request.params?.protocolVersion ?? "2025-03-26", + capabilities: { tools: {} }, + serverInfo: { name: "e2e-github-mcp", version: "1.0.0" }, + } + : request.method === "tools/list" + ? { tools: [] } + : {}; + options.onResponseStart(200, { + "content-type": "application/json", + ...commonResponseHeaders, + }); + options.onData( + Buffer.from( + JSON.stringify({ jsonrpc: "2.0", id: request.id, result }), + ), + ); + options.onResponseEnd(); + return; + } + // Handle memory endpoints - return stub responses in tests // Matches: /agents/*/memory/*/enabled, /agents/*/memory/*/recent, etc. if (options.requestOptions.path?.match(/\/agents\/.*\/memory\//)) { @@ -322,16 +481,42 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { options.onResponseEnd(); return; } - - // Handle /chat/completions endpoint + const requestPath = options.requestOptions.path ?? ""; + const protocol = replayProtocols[state.backend]; if ( - state.storedData && - options.requestOptions.path === chatCompletionEndpoint && - options.body + modelEndpoints.has(requestPath) && + state.backend !== "capi" && + requestPath !== protocol.endpoint ) { + const message = `Expected ${protocol.endpoint} for backend ${state.backend}, received ${requestPath}`; + options.onResponseStart(400, { + "content-type": "application/json", + ...commonResponseHeaders, + }); + options.onData( + Buffer.from( + JSON.stringify({ + error: { type: "protocol_mismatch", message }, + }), + ), + ); + options.onResponseEnd(); + return; + } + + const isModelRequest = requestPath === protocol.endpoint; + // Every protocol enters the existing Chat Completions snapshot matcher. + const normalizedBody = + isModelRequest && options.body + ? (protocol.normalizeRequest?.(options.body) ?? options.body) + : options.body; + if (state.storedData && isModelRequest && normalizedBody) { + const streamingIsRequested = + (JSON.parse(normalizedBody) as { stream?: boolean }).stream === true; + const savedError = await findSavedChatCompletionError( state.storedData, - options.body, + normalizedBody, state.workDir, state.toolResultNormalizers, ); @@ -347,14 +532,12 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { options.onResponseStart(savedError.status, headers); options.onData( Buffer.from( - JSON.stringify({ - error: { - message: - savedError.message ?? "Rate limited by test snapshot", - type: savedError.code ?? "rate_limited", - code: savedError.code ?? "rate_limited", - }, - }), + JSON.stringify( + (protocol.errorBody ?? openAIErrorBody)( + savedError.code, + savedError.message ?? "Rate limited by test snapshot", + ), + ), ), ); options.onResponseEnd(); @@ -363,45 +546,19 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { const savedResponse = await findSavedChatCompletionResponse( state.storedData, - options.body, + normalizedBody, state.workDir, state.toolResultNormalizers, ); if (savedResponse) { - const streamingIsRequested = - options.body && - (JSON.parse(options.body) as { stream?: boolean }).stream === - true; - - if (streamingIsRequested) { - const headers = { - "content-type": "text/event-stream", - ...commonResponseHeaders, - }; - options.onResponseStart(200, headers); - for (const chunk of convertToStreamingResponseChunks( - savedResponse, - )) { - options.onData( - Buffer.from(`data: ${JSON.stringify(chunk)}\n\n`), - ); - if (this.slowStreaming) { - await sleep(100); - } - } - options.onData(Buffer.from("data: [DONE]\n\n")); - options.onResponseEnd(); - } else { - const body = JSON.stringify(savedResponse); - const headers = { - "content-type": "application/json", - ...commonResponseHeaders, - }; - options.onResponseStart(200, headers); - options.onData(Buffer.from(body)); - options.onResponseEnd(); - } + await this.respondWithProtocol( + options, + protocol, + savedResponse, + streamingIsRequested, + commonResponseHeaders, + ); return; } @@ -411,15 +568,11 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { if ( await isRequestOnlySnapshot( state.storedData, - options.body, + normalizedBody, state.workDir, state.toolResultNormalizers, ) ) { - const streamingIsRequested = - options.body && - (JSON.parse(options.body) as { stream?: boolean }).stream === - true; const headers = { "content-type": streamingIsRequested ? "text/event-stream" @@ -436,7 +589,7 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { // Beyond this point, we're only going to be able to supply responses in CI if we have a snapshot, // and we only store snapshots for chat completion. For anything else (e.g., custom-agents fetches), // return 404 so the CLI treats them as unavailable instead of erroring. - if (options.requestOptions.path !== chatCompletionEndpoint) { + if (!isModelRequest) { const headers = { "content-type": "application/json", "x-github-request-id": "proxy-not-found", @@ -452,13 +605,14 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { // Fallback to normal proxying if no cached response found // This implicitly captures the new exchange too const isCI = process.env.GITHUB_ACTIONS === "true"; - if (isCI) { + if (isCI || state.backend !== "capi") { await exitWithNoMatchingRequestError( options, state.testInfo, state.workDir, state.toolResultNormalizers, state.storedData, + normalizedBody, ); return; } @@ -468,6 +622,43 @@ export class ReplayingCapiProxy extends CapturingHttpProxy { } }); } + + private async respondWithProtocol( + options: PerformRequestOptions, + protocol: ReplayProtocol, + response: ChatCompletion, + streaming: boolean, + commonHeaders: Record, + ): Promise { + if (!streaming) { + options.onResponseStart(200, { + "content-type": "application/json", + ...commonHeaders, + }); + options.onData( + Buffer.from( + JSON.stringify(protocol.responseBody?.(response) ?? response), + ), + ); + options.onResponseEnd(); + return; + } + + options.onResponseStart(200, { + "content-type": "text/event-stream", + ...commonHeaders, + }); + for (const chunk of protocol.responseChunks(response)) { + options.onData(Buffer.from(chunk)); + if (this.slowStreaming) { + await sleep(100); + } + } + if (protocol.responseEndChunk) { + options.onData(Buffer.from(protocol.responseEndChunk)); + } + options.onResponseEnd(); + } } async function writeCapturesToDisk( @@ -578,11 +769,12 @@ async function exitWithNoMatchingRequestError( workDir: string, toolResultNormalizers: ToolResultNormalizer[], storedData?: NormalizedData, + requestBody?: string, ) { let diagnostics: string; try { const normalized = await parseAndNormalizeRequest( - options.body, + requestBody ?? options.body, workDir, toolResultNormalizers, ); @@ -591,8 +783,11 @@ async function exitWithNoMatchingRequestError( let rawMessages: unknown[] = []; try { rawMessages = - (JSON.parse(options.body ?? "{}") as { messages?: unknown[] }) - .messages ?? []; + ( + JSON.parse(requestBody ?? options.body ?? "{}") as { + messages?: unknown[]; + } + ).messages ?? []; } catch { /* non-JSON body */ } @@ -761,6 +956,60 @@ async function transformHttpExchanges( return { models: Array.from(dedupedModels), conversations: dedupedExchanges }; } +function parseReplayBackend(value: unknown): ReplayBackend { + if (value === undefined || value === null || value === "") return "capi"; + if (typeof value === "string" && Object.hasOwn(replayProtocols, value)) { + return value as ReplayBackend; + } + throw new Error(`Unsupported replay backend: ${String(value)}`); +} + +function coalesceAdjacentUserMessages(requestBody: string): string { + const request = JSON.parse(requestBody) as { + messages?: Array<{ + role?: string; + content?: unknown; + [key: string]: unknown; + }>; + }; + if (!request.messages) return requestBody; + + const messages: NonNullable = []; + for (const message of request.messages) { + const previous = messages.at(-1); + if ( + previous?.role === "user" && + message.role === "user" && + typeof previous.content === "string" && + typeof message.content === "string" + ) { + previous.content = `${previous.content.trimEnd()}\n\n\n${message.content.trimStart()}`; + } else { + messages.push(message); + } + } + + for (const message of messages) { + if (message.role === "user" && typeof message.content === "string") { + message.content = normalizeUserMessage(message.content).replace( + /\n{5,}/g, + "\n\n\n", + ); + } + } + + request.messages = messages; + return JSON.stringify(request); +} + +function openAIErrorBody( + code: string | undefined, + message: string, +): unknown { + const type = code ?? "rate_limited"; + return { error: { message, type, code: type } }; +} + function normalizeFilenames( conversations: NormalizedConversation[], workDir: string, @@ -1035,7 +1284,10 @@ function transformOpenAIRequestMessage( function normalizeUserMessage(content: string): string { return normalizeSkillContextFrontmatter(content) - .replace(taskCompletionNotificationPattern, taskCompletionNotificationReplacement) + .replace( + taskCompletionNotificationPattern, + taskCompletionNotificationReplacement, + ) .replace(/.*?<\/current_datetime>/g, "") .replace(/[\s\S]*?<\/reminder>/g, "") .replace(/[\s\S]*?<\/system_reminder>/g, "") @@ -1049,9 +1301,9 @@ function normalizeUserMessage(content: string): string { } const taskCompletionNotificationPattern = - /Use read_agent with agent_id "([^"]+)" to retrieve unread results\./g; + /Agent "([^"]+)" \(([^)]+)\) (?:has completed successfully|has finished processing and is now idle)\. Use read_agent with agent_id "[^"]+" to (?:retrieve (?:unread results|the full results)|read the results, or write_agent to send follow-up messages)\./g; const taskCompletionNotificationReplacement = - 'Use read_agent with agent_id "$1" to retrieve the full results.'; + 'Agent "$1" ($2) has completed successfully. Use read_agent with agent_id "$1" to retrieve the full results.'; function normalizeStoredUserMessages(conversations: NormalizedConversation[]) { for (const conversation of conversations) { @@ -1066,6 +1318,65 @@ function normalizeStoredUserMessages(conversations: NormalizedConversation[]) { } } +function normalizeStoredMessagesForBackend( + conversations: NormalizedConversation[], + backend: ReplayBackend, +) { + if (backend === "capi") return; + + for (const conversation of conversations) { + conversation.messages = coalesceMessages( + conversation.messages, + backend !== "openai-completions", + ); + } +} + +function coalesceMessages( + messages: NormalizedMessage[], + coalesceAssistantMessages: boolean, +): NormalizedMessage[] { + const result: NormalizedMessage[] = []; + for (const message of messages) { + const previous = result.at(-1); + const shouldCoalesce = + previous?.role === message.role && + ((coalesceAssistantMessages && message.role === "assistant") || + message.role === "user"); + if (!shouldCoalesce) { + result.push(message); + continue; + } + + const separator = message.role === "user" ? "\n\n\n" : ""; + const previousContent = previous.content ?? ""; + const currentContent = message.content ?? ""; + const content = `${previousContent}${previousContent && currentContent ? separator : ""}${currentContent}`; + if (content) previous.content = content; + + const toolCalls = [ + ...(previous.tool_calls ?? []), + ...(message.tool_calls ?? []), + ]; + if (toolCalls.length) previous.tool_calls = toolCalls; + } + return result; +} + +// Apply runtime-dependent tool result normalization to snapshots recorded by +// older CLI versions as well as to live requests. +function normalizeStoredToolMessages(conversations: NormalizedConversation[]) { + for (const conversation of conversations) { + for (const message of conversation.messages) { + if (message.role === "tool" && typeof message.content === "string") { + message.content = normalizeAvailableToolNames(message.content); + message.content = normalizeBackgroundAgentStartMessage(message.content); + message.content = normalizeReadAgentResult(message.content); + } + } + } +} + function normalizeSkillContextFrontmatter(content: string): string { // Runtime versions may include or omit SKILL.md metadata in the prompt context. return content.replace( @@ -1087,6 +1398,13 @@ function normalizeLargeOutputFilepaths(result: string): string { ); } +function normalizeShellExitMarkers(result: string): string { + return result.replace( + /\r\n]+?\s+completed with exit code (-?\d+)>/g, + "", + ); +} + // The `gh` CLI emits different "not authenticated" help text depending on the // environment (local dev vs. inside GitHub Actions). Normalize both forms to a // stable placeholder so snapshots don't drift between environments. @@ -1143,12 +1461,44 @@ function normalizeGh401AuthMessages(result: string): string { return changed ? normalizedLines.join("\n") : result; } -function normalizeReadAgentTimings(result: string): string { - return result +function normalizeReadAgentResult(result: string): string { + const normalized = result + .replace( + /^Agent is idle \(waiting for messages\)\./, + "Agent completed.", + ) + .replace(/^Agent completed\. (.*), status: idle,/, "Agent completed. $1, status: completed,") + .replace( + /, total_turns: \d+(?=\r?\n|$)/, + ", total_turns: 0, duration: 0s", + ) + .replace(/\r?\n\r?\n\[Turn \d+\]\r?\n/, "\n\n"); + + return normalized .replace(/\belapsed: \d+(?:\.\d+)?s\b/g, "elapsed: 0s") .replace(/\bduration: \d+(?:\.\d+)?s\b/g, "duration: 0s"); } +// When a model calls a tool that doesn't exist (e.g., the removed report_intent +// tool), the runtime replies with "Available tools that can be called are ." +// That enumeration is both platform-specific (shell tool family names differ +// across OSes) and runtime-version-specific (built-in tools such as write_agent +// are added or removed over time). Some runtime builds omit the enumeration +// entirely, so remove the optional suffix and retain only the stable error. +function normalizeAvailableToolNames(result: string): string { + return result.replace( + /(Tool '[^']+' does not exist\.) Available tools that can be called are [^.]*\./g, + "$1", + ); +} + +function normalizeBackgroundAgentStartMessage(result: string): string { + return result.replace( + /^(Agent started in background with agent_id: .*?\. You'll be notified when it completes\. Tell the user you're waiting and end your response, or continue unrelated work until notified\.).*$/s, + "$1", + ); +} + // Transforms a single OpenAI-style inbound response message into normalized form function transformOpenAIResponseChoice( choices: ChatCompletion.Choice[], @@ -1457,6 +1807,8 @@ export type ToolResultNormalizer = { export type CopilotUserResponse = { login: string; copilot_plan?: string; + token_based_billing?: boolean; + is_mcp_enabled?: boolean; endpoints?: { api?: string; telemetry?: string; @@ -1487,6 +1839,7 @@ type ReplayingCapiProxyState = { filePath: string; workDir: string; testInfo?: { file: string; line?: number }; + backend: ReplayBackend; storedData?: NormalizedData | undefined; toolResultNormalizers: ToolResultNormalizer[]; }; diff --git a/test/harness/responsesApiAdapter.ts b/test/harness/responsesApiAdapter.ts new file mode 100644 index 000000000..16568f6e0 --- /dev/null +++ b/test/harness/responsesApiAdapter.ts @@ -0,0 +1,437 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +import { randomUUID } from "node:crypto"; +import type { ChatCompletion } from "openai/resources/chat/completions"; +import type { Response as OpenAIResponse } from "openai/resources/responses/responses"; +import { + CanonicalMessage, + formatSseEvent, + functionToolCalls, + isObject, + JsonObject, +} from "./modelProtocolAdapterShared"; + +export const responsesEndpoint = "/responses"; + +type ResponsesRequest = { + model: string; + instructions?: string; + input?: string | JsonObject[]; + stream?: boolean; + tools?: JsonObject[]; + tool_choice?: unknown; + temperature?: number | null; + top_p?: number | null; + parallel_tool_calls?: boolean | null; +}; + +export type ResponsesApiResponse = OpenAIResponse; + +export function responsesApiRequestToChatCompletion( + requestBody: string, +): string { + const request = JSON.parse(requestBody) as ResponsesRequest; + const messages: CanonicalMessage[] = []; + if (request.instructions) { + messages.push({ role: "system", content: request.instructions }); + } + + if (typeof request.input === "string") { + messages.push({ role: "user", content: request.input }); + } else { + for (const item of request.input ?? []) { + const converted = responseInputItemToCanonicalMessages(item); + messages.push(...converted); + } + } + + return JSON.stringify({ + model: request.model, + messages: coalesceAssistantMessages(messages), + ...(request.tools ? { tools: convertResponsesTools(request.tools) } : {}), + ...(request.tool_choice !== undefined + ? { tool_choice: convertResponsesToolChoice(request.tool_choice) } + : {}), + ...(request.stream !== undefined ? { stream: request.stream } : {}), + ...(request.temperature !== undefined && request.temperature !== null + ? { temperature: request.temperature } + : {}), + ...(request.top_p !== undefined && request.top_p !== null + ? { top_p: request.top_p } + : {}), + ...(request.parallel_tool_calls !== undefined && + request.parallel_tool_calls !== null + ? { parallel_tool_calls: request.parallel_tool_calls } + : {}), + }); +} + +function responseInputItemToCanonicalMessages( + item: JsonObject, +): CanonicalMessage[] { + if (item.type === "function_call") { + const callId = + typeof item.call_id === "string" + ? item.call_id + : typeof item.id === "string" + ? item.id + : ""; + return [ + { + role: "assistant", + content: null, + tool_calls: [ + { + id: callId, + type: "function", + function: { + name: typeof item.name === "string" ? item.name : "", + arguments: + typeof item.arguments === "string" ? item.arguments : "{}", + }, + }, + ], + }, + ]; + } + + if (item.type === "function_call_output") { + return [ + { + role: "tool", + tool_call_id: typeof item.call_id === "string" ? item.call_id : "", + content: + typeof item.output === "string" + ? item.output + : JSON.stringify(item.output ?? ""), + }, + ]; + } + + if (item.type === "reasoning") return []; + + if ( + item.type !== "message" && + item.role !== "user" && + item.role !== "assistant" && + item.role !== "system" + ) { + return []; + } + + const role = + item.role === "assistant" || item.role === "system" ? item.role : "user"; + if (typeof item.content === "string") { + return [{ role, content: item.content }]; + } + if (!Array.isArray(item.content)) return [{ role, content: "" }]; + + const parts: unknown[] = []; + for (const part of item.content) { + if (!isObject(part)) continue; + if ( + (part.type === "input_text" || part.type === "output_text") && + typeof part.text === "string" + ) { + parts.push({ type: "text", text: part.text }); + } else if ( + part.type === "input_image" && + typeof part.image_url === "string" + ) { + parts.push({ + type: "image_url", + image_url: { + url: part.image_url, + ...(typeof part.detail === "string" ? { detail: part.detail } : {}), + }, + }); + } else if ( + part.type === "input_file" && + typeof part.file_data === "string" + ) { + parts.push({ + type: "file", + file: { + file_data: part.file_data, + ...(typeof part.filename === "string" + ? { filename: part.filename } + : {}), + }, + }); + } + } + + const onlyText = parts.every( + (part) => isObject(part) && part.type === "text", + ); + return [ + { + role, + content: onlyText + ? parts + .map((part) => + isObject(part) && typeof part.text === "string" ? part.text : "", + ) + .join("") + : parts, + }, + ]; +} + +function coalesceAssistantMessages( + messages: CanonicalMessage[], +): CanonicalMessage[] { + const result: CanonicalMessage[] = []; + for (const message of messages) { + const previous = result[result.length - 1]; + if (message.role === "assistant" && previous?.role === "assistant") { + const previousText = + typeof previous.content === "string" ? previous.content : ""; + const currentText = + typeof message.content === "string" ? message.content : ""; + previous.content = `${previousText}${currentText}` || null; + const toolCalls = [ + ...(previous.tool_calls ?? []), + ...(message.tool_calls ?? []), + ]; + if (toolCalls.length) previous.tool_calls = toolCalls; + } else { + result.push(message); + } + } + return result; +} + +function convertResponsesTools(tools: JsonObject[]): JsonObject[] { + return tools + .filter((tool) => tool.type === "function" && typeof tool.name === "string") + .map((tool) => ({ + type: "function", + function: { + name: tool.name, + ...(typeof tool.description === "string" + ? { description: tool.description } + : {}), + ...(isObject(tool.parameters) ? { parameters: tool.parameters } : {}), + ...(typeof tool.strict === "boolean" ? { strict: tool.strict } : {}), + }, + })); +} + +function convertResponsesToolChoice(toolChoice: unknown): unknown { + if ( + toolChoice === "auto" || + toolChoice === "none" || + toolChoice === "required" + ) { + return toolChoice; + } + if ( + isObject(toolChoice) && + toolChoice.type === "function" && + typeof toolChoice.name === "string" + ) { + return { + type: "function", + function: { name: toolChoice.name }, + }; + } + return undefined; +} + +export function chatCompletionResponseToResponsesApiMessage( + response: ChatCompletion, +): ResponsesApiResponse { + const output: ResponsesApiResponse["output"] = []; + const outputText: string[] = []; + + for (const choice of response.choices) { + if (choice.message.content) { + const text = choice.message.content; + outputText.push(text); + output.push({ + type: "message", + id: `msg_${randomUUID()}`, + role: "assistant", + status: "completed", + content: [ + { + type: "output_text", + text, + annotations: [], + }, + ], + }); + } + for (const toolCall of functionToolCalls(choice.message)) { + output.push({ + type: "function_call", + id: `fc_${toolCall.id}`, + call_id: toolCall.id, + name: toolCall.function.name, + arguments: toolCall.function.arguments, + status: "completed", + }); + } + } + + const finishReason = response.choices[0]?.finish_reason; + return { + id: response.id, + object: "response", + created_at: response.created, + model: response.model, + status: "completed", + output, + output_text: outputText.join(""), + incomplete_details: + finishReason === "length" + ? { reason: "max_output_tokens" } + : finishReason === "content_filter" + ? { reason: "content_filter" } + : null, + error: null, + instructions: null, + metadata: null, + parallel_tool_calls: false, + temperature: null, + tool_choice: "auto", + tools: [], + top_p: null, + usage: { + input_tokens: response.usage?.prompt_tokens ?? 0, + output_tokens: response.usage?.completion_tokens ?? 0, + total_tokens: response.usage?.total_tokens ?? 0, + input_tokens_details: { + cached_tokens: + response.usage?.prompt_tokens_details?.cached_tokens ?? 0, + }, + output_tokens_details: { + reasoning_tokens: + response.usage?.completion_tokens_details?.reasoning_tokens ?? 0, + }, + }, + }; +} + +export function chatCompletionResponseToResponsesApiSseChunks( + response: ChatCompletion, +): string[] { + const fullResponse = chatCompletionResponseToResponsesApiMessage(response); + const skeleton = { + ...fullResponse, + status: "in_progress" as const, + output: [], + output_text: "", + usage: undefined, + }; + const chunks: string[] = []; + let sequenceNumber = 0; + const event = (type: string, data: JsonObject) => + formatSseEvent(type, { + type, + sequence_number: sequenceNumber++, + ...data, + }); + + chunks.push( + event("response.created", { response: skeleton }), + event("response.in_progress", { response: skeleton }), + ); + + for ( + let outputIndex = 0; + outputIndex < fullResponse.output.length; + outputIndex++ + ) { + const item = fullResponse.output[outputIndex]; + const addedItem = + item.type === "message" + ? { ...item, status: "in_progress" as const, content: [] } + : item.type === "function_call" + ? { ...item, status: "in_progress" as const, arguments: "" } + : item; + chunks.push( + event("response.output_item.added", { + output_index: outputIndex, + item: addedItem, + }), + ); + + if (item.type === "message" && Array.isArray(item.content)) { + for ( + let contentIndex = 0; + contentIndex < item.content.length; + contentIndex++ + ) { + const part = item.content[contentIndex]; + chunks.push( + event("response.content_part.added", { + item_id: item.id, + output_index: outputIndex, + content_index: contentIndex, + part: + isObject(part) && part.type === "output_text" + ? { ...part, text: "" } + : part, + }), + ); + if ( + isObject(part) && + part.type === "output_text" && + typeof part.text === "string" + ) { + chunks.push( + event("response.output_text.delta", { + item_id: item.id, + output_index: outputIndex, + content_index: contentIndex, + delta: part.text, + logprobs: [], + }), + event("response.output_text.done", { + item_id: item.id, + output_index: outputIndex, + content_index: contentIndex, + text: part.text, + logprobs: [], + }), + ); + } + chunks.push( + event("response.content_part.done", { + item_id: item.id, + output_index: outputIndex, + content_index: contentIndex, + part, + }), + ); + } + } else if (item.type === "function_call") { + chunks.push( + event("response.function_call_arguments.delta", { + item_id: item.id, + output_index: outputIndex, + delta: item.arguments, + }), + event("response.function_call_arguments.done", { + item_id: item.id, + output_index: outputIndex, + arguments: item.arguments, + }), + ); + } + + chunks.push( + event("response.output_item.done", { + output_index: outputIndex, + item, + }), + ); + } + + chunks.push(event("response.completed", { response: fullResponse })); + return chunks; +} diff --git a/test/harness/test-mcp-oauth-server.mjs b/test/harness/test-mcp-oauth-server.mjs new file mode 100644 index 000000000..eacd35f30 --- /dev/null +++ b/test/harness/test-mcp-oauth-server.mjs @@ -0,0 +1,325 @@ +#!/usr/bin/env node +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + *--------------------------------------------------------------------------------------------*/ + +/** + * Minimal OAuth-protected Streamable HTTP MCP server for SDK E2E tests. + * + * The `/mcp` endpoint returns a WWW-Authenticate challenge until requests include + * an accepted test token, then serves enough JSON-RPC MCP methods for the runtime + * to initialize and list/call one tool. Specific tool-call scenarios trigger + * replacement-token challenges so SDK E2E tests can cover refresh, upscope, and + * reauth flows without relying on a real OAuth server. + */ + +import http from "node:http"; +import path from "node:path"; +import { fileURLToPath } from "node:url"; + +const DEFAULT_EXPECTED_TOKEN = "sdk-host-token"; +const PROTOCOL_VERSION = "2025-03-26"; +const PROTECTED_RESOURCE_PATH = "/.well-known/oauth-protected-resource"; + +export async function startOAuthMcpServer({ + expectedToken = DEFAULT_EXPECTED_TOKEN, + host = "127.0.0.1", + port = 0, +} = {}) { + const requests = []; + const tokens = { + initial: expectedToken, + refresh: `${expectedToken}-refresh`, + upscope: `${expectedToken}-upscope`, + reauth: `${expectedToken}-reauth`, + rejected: `${expectedToken}-rejected`, + }; + const acceptedTokens = new Set([ + tokens.initial, + tokens.refresh, + tokens.upscope, + tokens.reauth, + ]); + + const server = http.createServer(async (req, res) => { + const url = new URL( + req.url ?? "/", + `http://${req.headers.host ?? `${host}:${port}`}`, + ); + const baseUrl = url.origin; + + if (req.method === "GET" && url.pathname === "/__requests") { + respondJson(res, 200, requests); + return; + } + + if ( + req.method === "GET" && + url.pathname === PROTECTED_RESOURCE_PATH + ) { + respondJson(res, 200, { + resource: `${baseUrl}/mcp`, + authorization_servers: [baseUrl], + scopes_supported: ["mcp.read"], + bearer_methods_supported: ["header"], + }); + return; + } + + if ( + req.method === "GET" && + url.pathname === "/.well-known/oauth-authorization-server" + ) { + respondJson(res, 200, { + issuer: baseUrl, + authorization_endpoint: `${baseUrl}/authorize`, + token_endpoint: `${baseUrl}/token`, + response_types_supported: ["code"], + grant_types_supported: ["authorization_code"], + }); + return; + } + + if (url.pathname !== "/mcp") { + respondJson(res, 404, { error: "not_found" }); + return; + } + + const body = await readBody(req); + requests.push({ + method: req.method, + path: url.pathname, + authorization: req.headers.authorization ?? null, + body: body || null, + }); + + const token = parseBearerToken(req.headers.authorization); + if (!token || !acceptedTokens.has(token)) { + challengeInitial(res, baseUrl); + return; + } + + if (req.method !== "POST") { + respondJson(res, 405, { error: "method_not_allowed" }); + return; + } + + const parsedBody = parseJsonBody(body); + if (!parsedBody.ok) { + respondJson(res, 400, { error: "invalid_json" }); + return; + } + + const message = parsedBody.value; + const replacementChallenge = getReplacementChallenge( + message, + token, + tokens, + baseUrl, + ); + if (replacementChallenge) { + res.writeHead(replacementChallenge.statusCode, { + "www-authenticate": replacementChallenge.wwwAuthenticate, + "content-type": "application/json", + }); + res.end(JSON.stringify({ error: replacementChallenge.error })); + return; + } + + const response = Array.isArray(message) + ? message + .map((item) => handleJsonRpcMessage(item)) + .filter((item) => item !== undefined) + : handleJsonRpcMessage(message); + + if ( + response === undefined || + (Array.isArray(response) && response.length === 0) + ) { + res.writeHead(202, { "mcp-session-id": "oauth-test-session" }); + res.end(); + return; + } + + res.writeHead(200, { + "content-type": "application/json", + "mcp-session-id": "oauth-test-session", + }); + res.end(JSON.stringify(response)); + }); + + await new Promise((resolve, reject) => { + server.once("error", reject); + server.listen(port, host, () => { + server.off("error", reject); + resolve(); + }); + }); + + const address = server.address(); + if (!address || typeof address === "string") { + throw new Error("Expected TCP server address"); + } + + return { + url: `http://${host}:${address.port}`, + requests, + close: () => + new Promise((resolve, reject) => + server.close((err) => (err ? reject(err) : resolve())), + ), + }; +} + +function getReplacementChallenge(message, token, tokens, baseUrl) { + const messages = Array.isArray(message) ? message : [message]; + const toolCall = messages.find((item) => item?.method === "tools/call"); + const scenario = toolCall?.params?.arguments?.scenario; + + if (scenario === "refresh" && token !== tokens.refresh) { + return { + statusCode: 401, + wwwAuthenticate: 'Bearer error="invalid_token"', + error: "token_expired", + }; + } + + if (scenario === "upscope" && token !== tokens.upscope) { + return { + statusCode: 403, + wwwAuthenticate: `Bearer resource_metadata="${baseUrl}${PROTECTED_RESOURCE_PATH}", scope="mcp.write", error="insufficient_scope"`, + error: "insufficient_scope", + }; + } + + if (scenario === "reauth" && token !== tokens.reauth) { + return { + statusCode: 401, + wwwAuthenticate: 'Bearer error="invalid_token"', + error: "reauth_required", + }; + } + + if (scenario === "cancel" && token !== tokens.refresh) { + return { + statusCode: 401, + wwwAuthenticate: 'Bearer error="invalid_token"', + error: "token_expired", + }; + } + + return undefined; +} + +function handleJsonRpcMessage(message) { + if (!message || typeof message !== "object" || !("id" in message)) { + return undefined; + } + + switch (message.method) { + case "initialize": + return { + jsonrpc: "2.0", + id: message.id, + result: { + protocolVersion: message.params?.protocolVersion ?? PROTOCOL_VERSION, + capabilities: { tools: {} }, + serverInfo: { name: "oauth-test-server", version: "1.0.0" }, + }, + }; + case "tools/list": + return { + jsonrpc: "2.0", + id: message.id, + result: { + tools: [ + { + name: "whoami", + description: "Returns the authenticated test principal.", + inputSchema: { + type: "object", + properties: { + scenario: { + type: "string", + enum: ["initial", "refresh", "upscope", "reauth", "cancel"], + }, + }, + additionalProperties: false, + }, + _meta: { "ui.visibility": ["model", "app"] }, + }, + ], + }, + }; + case "tools/call": + return { + jsonrpc: "2.0", + id: message.id, + result: { + content: [{ type: "text", text: "oauth-test-user" }], + isError: false, + }, + }; + default: + return { + jsonrpc: "2.0", + id: message.id, + error: { code: -32601, message: `Method not found: ${message.method}` }, + }; + } +} + +function parseBearerToken(authorization) { + const match = /^Bearer (.+)$/.exec(authorization ?? ""); + return match?.[1]; +} + +function challengeInitial(res, baseUrl) { + const resourceMetadataUrl = `${baseUrl}${PROTECTED_RESOURCE_PATH}`; + res.writeHead(401, { + "www-authenticate": `Bearer resource_metadata="${resourceMetadataUrl}", scope="mcp.read", error="invalid_token"`, + "content-type": "application/json", + }); + res.end(JSON.stringify({ error: "missing_or_invalid_token" })); +} + +function readBody(req) { + return new Promise((resolve, reject) => { + const chunks = []; + req.on("data", (chunk) => chunks.push(chunk)); + req.on("error", reject); + req.on("end", () => resolve(Buffer.concat(chunks).toString("utf8"))); + }); +} + +function parseJsonBody(body) { + if (!body) { + return { ok: true, value: undefined }; + } + + try { + return { ok: true, value: JSON.parse(body) }; + } catch { + return { ok: false, value: undefined }; + } +} + +function respondJson(res, statusCode, body) { + const data = JSON.stringify(body); + res.writeHead(statusCode, { + "content-type": "application/json", + "content-length": Buffer.byteLength(data), + }); + res.end(data); +} + +if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) { + const server = await startOAuthMcpServer({ + expectedToken: process.env.EXPECTED_TOKEN ?? DEFAULT_EXPECTED_TOKEN, + }); + console.log(`Listening: ${server.url}`); + process.on("SIGTERM", async () => { + await server.close(); + process.exit(0); + }); +} diff --git a/test/harness/test-mcp-server.mjs b/test/harness/test-mcp-server.mjs index b2b32606d..a3a84b42b 100644 --- a/test/harness/test-mcp-server.mjs +++ b/test/harness/test-mcp-server.mjs @@ -13,9 +13,17 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; +import { appendFile } from "node:fs/promises"; import { z } from "zod"; -const server = new McpServer({ name: "env-echo", version: "1.0.0" }); +function getArgument(name) { + const index = process.argv.indexOf(name); + return index === -1 ? undefined : process.argv[index + 1]; +} + +const startupMarkerPath = getArgument("--startup-marker"); +const serverName = getArgument("--server-name") ?? "env-echo"; +const server = new McpServer({ name: serverName, version: "1.0.0" }); server.tool( "get_env", @@ -27,5 +35,7 @@ server.tool( ); const transport = new StdioServerTransport(); +if (startupMarkerPath) { + await appendFile(startupMarkerPath, `${serverName}\n`); +} await server.connect(transport); - diff --git a/test/snapshots/abort/should_abort_during_active_streaming.yaml b/test/snapshots/abort/should_abort_during_active_streaming.yaml index bd18eab2f..70981ee59 100644 --- a/test/snapshots/abort/should_abort_during_active_streaming.yaml +++ b/test/snapshots/abort/should_abort_during_active_streaming.yaml @@ -28,3 +28,20 @@ conversations: content: Say 'abort_recovery_ok'. - role: assistant content: abort_recovery_ok + - messages: + - role: system + content: ${system} + - role: user + content: Say 'abort_recovery_ok'. + - role: assistant + content: abort_recovery_ok + - messages: + - role: system + content: ${system} + - role: user + content: Write a very long essay about the history of computing, covering every decade from the 1940s to the 2020s in + great detail. + - role: user + content: Say 'abort_recovery_ok'. + - role: assistant + content: abort_recovery_ok diff --git a/test/snapshots/ask_user/ask_user_does_not_block_sibling_tool_call_in_same_turn.yaml b/test/snapshots/ask_user/ask_user_does_not_block_sibling_tool_call_in_same_turn.yaml new file mode 100644 index 000000000..4ba16d4d8 --- /dev/null +++ b/test/snapshots/ask_user/ask_user_does_not_block_sibling_tool_call_in_same_turn.yaml @@ -0,0 +1,30 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Call set_marker with value 'go' and, at the same time, use the ask_user tool to ask me to choose between + 'Option A' and 'Option B'. Wait for my answer before continuing. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: set_marker + arguments: '{"value":"go"}' + - id: toolcall_1 + type: function + function: + name: ask_user + arguments: '{"question":"Please choose between the following options:","choices":["Option A","Option B"]}' + - role: tool + tool_call_id: toolcall_0 + content: MARKER_GO + - role: tool + tool_call_id: toolcall_1 + content: "User selected: Option A" + - role: assistant + content: |- + The marker is set (MARKER_GO) and you selected **Option A**. diff --git a/test/snapshots/builtin_tools/should_capture_exit_code_in_output.yaml b/test/snapshots/builtin_tools/should_capture_exit_code_in_output.yaml index 3285ae23c..01cf1298d 100644 --- a/test/snapshots/builtin_tools/should_capture_exit_code_in_output.yaml +++ b/test/snapshots/builtin_tools/should_capture_exit_code_in_output.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"command":"echo hello && echo world","description":"Run echo hello && echo world"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- diff --git a/test/snapshots/builtin_tools/should_capture_stderr_output.yaml b/test/snapshots/builtin_tools/should_capture_stderr_output.yaml index 32db145ca..0ba318148 100644 --- a/test/snapshots/builtin_tools/should_capture_stderr_output.yaml +++ b/test/snapshots/builtin_tools/should_capture_stderr_output.yaml @@ -5,14 +5,14 @@ conversations: - role: system content: ${system} - role: user - content: Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content. + content: Run 'echo error_msg >&2; sleep 0.5; echo ok' and tell me what stderr said. Reply with just the stderr content. - role: assistant tool_calls: - id: toolcall_0 type: function function: name: ${shell} - arguments: '{"command":"echo error_msg >&2; echo ok","description":"Run command with stderr output"}' + arguments: '{"command":"echo error_msg >&2; sleep 0.5; echo ok","description":"Running command to capture stderr"}' - role: tool tool_call_id: toolcall_0 content: |- diff --git a/test/snapshots/builtin_tools/should_create_a_new_file.yaml b/test/snapshots/builtin_tools/should_create_a_new_file.yaml index fe75810a1..bf9288cf0 100644 --- a/test/snapshots/builtin_tools/should_create_a_new_file.yaml +++ b/test/snapshots/builtin_tools/should_create_a_new_file.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"path":"${workdir}/new_file.txt","file_text":"Created by test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Created file ${workdir}/new_file.txt with 15 characters @@ -54,4 +56,4 @@ conversations: tool_call_id: toolcall_2 content: 1. Created by test - role: assistant - content: File created and confirmed! The file 'new_file.txt' contains "Created by test" as expected. + content: ✓ Done! Created `new_file.txt` with content "Created by test" and confirmed the content matches. diff --git a/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml b/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml index b2d3d9451..0f2141862 100644 --- a/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml +++ b/test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml @@ -41,7 +41,9 @@ conversations: arguments: '{"path":"${workdir}/edit_me.txt","old_str":"Hello World","new_str":"Hi Universe"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: File ${workdir}/edit_me.txt updated with changes. @@ -60,6 +62,8 @@ conversations: 3. - role: assistant content: |- - The file now contains: - 1. Hi Universe - 2. Goodbye World + Done! The file now contains: + ``` + Hi Universe + Goodbye World + ``` diff --git a/test/snapshots/builtin_tools/should_find_files_by_pattern.yaml b/test/snapshots/builtin_tools/should_find_files_by_pattern.yaml index 0fa78ce4f..6cf85ea51 100644 --- a/test/snapshots/builtin_tools/should_find_files_by_pattern.yaml +++ b/test/snapshots/builtin_tools/should_find_files_by_pattern.yaml @@ -42,11 +42,14 @@ conversations: arguments: '{"pattern":"**/*.ts"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: ./src/index.ts - role: assistant content: |- - Found **1 TypeScript file**: + I found **1 TypeScript file** in this directory: + - `src/index.ts` diff --git a/test/snapshots/builtin_tools/should_handle_nonexistent_file_gracefully.yaml b/test/snapshots/builtin_tools/should_handle_nonexistent_file_gracefully.yaml index 2e5e4368c..c5c00fb65 100644 --- a/test/snapshots/builtin_tools/should_handle_nonexistent_file_gracefully.yaml +++ b/test/snapshots/builtin_tools/should_handle_nonexistent_file_gracefully.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"path":"${workdir}/does_not_exist.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Path ${workdir}/does_not_exist.txt does not exist. Please provide a valid path. diff --git a/test/snapshots/builtin_tools/should_read_file_with_line_range.yaml b/test/snapshots/builtin_tools/should_read_file_with_line_range.yaml index 382da0908..cd17d8670 100644 --- a/test/snapshots/builtin_tools/should_read_file_with_line_range.yaml +++ b/test/snapshots/builtin_tools/should_read_file_with_line_range.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"path":"${workdir}/lines.txt","view_range":[2,4]}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- @@ -48,7 +50,7 @@ conversations: 4. line4 - role: assistant content: |- - Lines 2 through 4 contain: + Lines 2 through 4 of 'lines.txt' contain: - Line 2: "line2" - - Line 3: "line3" + - Line 3: "line3" - Line 4: "line4" diff --git a/test/snapshots/builtin_tools/should_search_for_patterns_in_files.yaml b/test/snapshots/builtin_tools/should_search_for_patterns_in_files.yaml index f4e32f773..f0af500b6 100644 --- a/test/snapshots/builtin_tools/should_search_for_patterns_in_files.yaml +++ b/test/snapshots/builtin_tools/should_search_for_patterns_in_files.yaml @@ -39,14 +39,16 @@ conversations: arguments: '{"pattern":"^ap","path":"${workdir}/data.txt","output_mode":"content","-n":true}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- - ./data.txt:1:apple - ./data.txt:3:apricot + ${workdir}/data.txt:1:apple + ${workdir}/data.txt:3:apricot - role: assistant content: |- - The search found **2 lines** starting with 'ap': - - Line 1: `apple` - - Line 3: `apricot` + Two lines start with 'ap': + - **Line 1:** apple + - **Line 3:** apricot diff --git a/test/snapshots/client_options/should_use_client_cwd_for_default_workingdirectory.yaml b/test/snapshots/client_options/should_use_client_cwd_for_default_workingdirectory.yaml index b44846fdc..6d9167e94 100644 --- a/test/snapshots/client_options/should_use_client_cwd_for_default_workingdirectory.yaml +++ b/test/snapshots/client_options/should_use_client_cwd_for_default_workingdirectory.yaml @@ -20,14 +20,11 @@ conversations: arguments: '{"path":"${workdir}/client-cwd/marker.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. I am in the client cwd - role: assistant - content: |- - The file `marker.txt` says: - - ``` - I am in the client cwd - ``` + content: 'The file `marker.txt` says: "I am in the client cwd"' diff --git a/test/snapshots/event_fidelity/should_emit_events_in_correct_order_for_tool_using_conversation.yaml b/test/snapshots/event_fidelity/should_emit_events_in_correct_order_for_tool_using_conversation.yaml index ba555111f..8ce730f0f 100644 --- a/test/snapshots/event_fidelity/should_emit_events_in_correct_order_for_tool_using_conversation.yaml +++ b/test/snapshots/event_fidelity/should_emit_events_in_correct_order_for_tool_using_conversation.yaml @@ -39,9 +39,16 @@ conversations: arguments: '{"path":"${workdir}/hello.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Hello World - role: assistant - content: "The file 'hello.txt' contains: \"Hello World\"" + content: |- + The file 'hello.txt' contains: + + ``` + Hello World + ``` diff --git a/test/snapshots/event_fidelity/should_emit_tool_execution_events_with_correct_fields.yaml b/test/snapshots/event_fidelity/should_emit_tool_execution_events_with_correct_fields.yaml index e0b414069..a6583a15e 100644 --- a/test/snapshots/event_fidelity/should_emit_tool_execution_events_with_correct_fields.yaml +++ b/test/snapshots/event_fidelity/should_emit_tool_execution_events_with_correct_fields.yaml @@ -39,9 +39,15 @@ conversations: arguments: '{"path":"${workdir}/data.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. test data - role: assistant - content: "The file 'data.txt' contains: `test data`" + content: |- + The file `data.txt` contains: + ``` + test data + ``` diff --git a/test/snapshots/hooks/invoke_both_hooks_for_single_tool_call.yaml b/test/snapshots/hooks/invoke_both_hooks_for_single_tool_call.yaml index 0bb88c130..6a51857ab 100644 --- a/test/snapshots/hooks/invoke_both_hooks_for_single_tool_call.yaml +++ b/test/snapshots/hooks/invoke_both_hooks_for_single_tool_call.yaml @@ -39,9 +39,15 @@ conversations: arguments: '{"path":"${workdir}/both.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Testing both hooks! - role: assistant - content: 'The file contains: "Testing both hooks!"' + content: |- + The file **both.txt** contains: + ``` + Testing both hooks! + ``` diff --git a/test/snapshots/hooks/invoke_post_tool_use_hook_after_model_runs_a_tool.yaml b/test/snapshots/hooks/invoke_post_tool_use_hook_after_model_runs_a_tool.yaml index 59369b1c8..18b324f09 100644 --- a/test/snapshots/hooks/invoke_post_tool_use_hook_after_model_runs_a_tool.yaml +++ b/test/snapshots/hooks/invoke_post_tool_use_hook_after_model_runs_a_tool.yaml @@ -39,9 +39,14 @@ conversations: arguments: '{"path":"${workdir}/world.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. World from the test! - role: assistant - content: 'The file world.txt contains: "World from the test!"' + content: |- + The file `world.txt` contains: + + **"World from the test!"** diff --git a/test/snapshots/hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool.yaml b/test/snapshots/hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool.yaml index 24241d900..1ce0fe67a 100644 --- a/test/snapshots/hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool.yaml +++ b/test/snapshots/hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool.yaml @@ -39,9 +39,16 @@ conversations: arguments: '{"path":"${workdir}/hello.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Hello from the test! - role: assistant - content: The file says "Hello from the test!" + content: |- + The file **hello.txt** contains: + + ``` + Hello from the test! + ``` diff --git a/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call.yaml b/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call.yaml index dd55858bf..6a51857ab 100644 --- a/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call.yaml +++ b/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call.yaml @@ -39,9 +39,15 @@ conversations: arguments: '{"path":"${workdir}/both.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Testing both hooks! - role: assistant - content: 'The file contains a single line: "Testing both hooks!"' + content: |- + The file **both.txt** contains: + ``` + Testing both hooks! + ``` diff --git a/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call.yaml b/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call.yaml index ff422fee1..6a51857ab 100644 --- a/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call.yaml +++ b/test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call.yaml @@ -39,9 +39,15 @@ conversations: arguments: '{"path":"${workdir}/both.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Testing both hooks! - role: assistant - content: 'The file `both.txt` contains: "Testing both hooks!"' + content: |- + The file **both.txt** contains: + ``` + Testing both hooks! + ``` diff --git a/test/snapshots/hooks/should_invoke_posttooluse_hook_after_model_runs_a_tool.yaml b/test/snapshots/hooks/should_invoke_posttooluse_hook_after_model_runs_a_tool.yaml index 518f6d06e..18b324f09 100644 --- a/test/snapshots/hooks/should_invoke_posttooluse_hook_after_model_runs_a_tool.yaml +++ b/test/snapshots/hooks/should_invoke_posttooluse_hook_after_model_runs_a_tool.yaml @@ -39,9 +39,14 @@ conversations: arguments: '{"path":"${workdir}/world.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. World from the test! - role: assistant - content: 'The file contains: "World from the test!"' + content: |- + The file `world.txt` contains: + + **"World from the test!"** diff --git a/test/snapshots/hooks/should_invoke_pretooluse_hook_when_model_runs_a_tool.yaml b/test/snapshots/hooks/should_invoke_pretooluse_hook_when_model_runs_a_tool.yaml index e1f807fdc..1ce0fe67a 100644 --- a/test/snapshots/hooks/should_invoke_pretooluse_hook_when_model_runs_a_tool.yaml +++ b/test/snapshots/hooks/should_invoke_pretooluse_hook_when_model_runs_a_tool.yaml @@ -39,9 +39,16 @@ conversations: arguments: '{"path":"${workdir}/hello.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Hello from the test! - role: assistant - content: 'The file contains: "Hello from the test!"' + content: |- + The file **hello.txt** contains: + + ``` + Hello from the test! + ``` diff --git a/test/snapshots/hooks_extended/should_allow_posttooluse_to_return_modifiedresult.yaml b/test/snapshots/hooks_extended/should_allow_posttooluse_to_return_modifiedresult.yaml index cf1292873..a340e9326 100644 --- a/test/snapshots/hooks_extended/should_allow_posttooluse_to_return_modifiedresult.yaml +++ b/test/snapshots/hooks_extended/should_allow_posttooluse_to_return_modifiedresult.yaml @@ -5,34 +5,10 @@ conversations: - role: system content: ${system} - role: user - content: Call the report_intent tool with intent 'Testing post hook', then reply done. + content: Call the view tool to read the current directory, then reply done. - role: assistant tool_calls: - id: toolcall_0 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing post hook"}' - - role: assistant - tool_calls: - - id: toolcall_1 - type: function - function: - name: view - arguments: '{"path":"${workdir}"}' - - messages: - - role: system - content: ${system} - - role: user - content: Call the report_intent tool with intent 'Testing post hook', then reply done. - - role: assistant - tool_calls: - - id: toolcall_0 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing post hook"}' - - id: toolcall_1 type: function function: name: view @@ -40,8 +16,5 @@ conversations: - role: tool tool_call_id: toolcall_0 content: modified by post hook - - role: tool - tool_call_id: toolcall_1 - content: Tool 'view' does not exist. Available tools that can be called are report_intent. - role: assistant content: Done. diff --git a/test/snapshots/hooks_extended/should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput.yaml b/test/snapshots/hooks_extended/should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput.yaml index cae46a153..8415fe771 100644 --- a/test/snapshots/hooks_extended/should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput.yaml +++ b/test/snapshots/hooks_extended/should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput.yaml @@ -42,9 +42,17 @@ conversations: arguments: '{"value":"modified by hook"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, echo_value. - role: tool tool_call_id: toolcall_1 content: modified by hook - role: assistant - content: 'The echo_value returned: **"modified by hook"**' + content: >- + The echo_value function returned: **"modified by hook"** + + + Interestingly, even though I called it with the value 'original', the result shows 'modified by hook', + suggesting there may be some interceptor or hook modifying the parameter before it reaches the actual + function. diff --git a/test/snapshots/hooks_extended/should_invoke_agentstop_hook_and_apply_block_response.yaml b/test/snapshots/hooks_extended/should_invoke_agentstop_hook_and_apply_block_response.yaml new file mode 100644 index 000000000..6485670a1 --- /dev/null +++ b/test/snapshots/hooks_extended/should_invoke_agentstop_hook_and_apply_block_response.yaml @@ -0,0 +1,14 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: "Reply with exactly: AGENT_STOP_INITIAL" + - role: assistant + content: AGENT_STOP_INITIAL + - role: user + content: "Reply with exactly: AGENT_STOP_CONTINUED" + - role: assistant + content: AGENT_STOP_CONTINUED diff --git a/test/snapshots/hooks_extended/should_invoke_userprompttransformed_hook_and_modify_transformed_prompt.yaml b/test/snapshots/hooks_extended/should_invoke_userprompttransformed_hook_and_modify_transformed_prompt.yaml new file mode 100644 index 000000000..db2b02968 --- /dev/null +++ b/test/snapshots/hooks_extended/should_invoke_userprompttransformed_hook_and_modify_transformed_prompt.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: "Reply with exactly: HOOKED_TRANSFORMED_PROMPT" + - role: assistant + content: HOOKED_TRANSFORMED_PROMPT diff --git a/test/snapshots/mode_handlers/should_invoke_exit_plan_mode_handler_when_model_uses_tool.yaml b/test/snapshots/mode_handlers/should_invoke_exit_plan_mode_handler_when_model_uses_tool.yaml index 69987f17a..078ba0548 100644 --- a/test/snapshots/mode_handlers/should_invoke_exit_plan_mode_handler_when_model_uses_tool.yaml +++ b/test/snapshots/mode_handlers/should_invoke_exit_plan_mode_handler_when_model_uses_tool.yaml @@ -12,12 +12,15 @@ conversations: type: function function: name: exit_plan_mode - arguments: '{"summary":"Greeting file implementation plan","actions":["interactive","autopilot","exit_only"],"recommendedAction":"interactive"}' + arguments: '{"summary":"Greeting file implementation + plan","actions":["autopilot","interactive","exit_only"],"recommendedAction":"interactive"}' - role: tool tool_call_id: toolcall_0 - content: |- + content: >- Plan approved! Exited plan mode. - You are now in interactive mode (edits require manual approval). Proceed with implementing the plan. + + You are now in interactive mode. Start implementing the plan now, in this same response. Approving the plan is + your go-signal, so do not stop to ask whether to proceed or wait for another message. - role: assistant content: Plan approved; I will wait for the next instruction before making changes. diff --git a/test/snapshots/multi_client/both_clients_see_tool_request_and_completion_events.yaml b/test/snapshots/multi_client/both_clients_see_tool_request_and_completion_events.yaml index b4b14d0ea..62f0d004a 100644 --- a/test/snapshots/multi_client/both_clients_see_tool_request_and_completion_events.yaml +++ b/test/snapshots/multi_client/both_clients_see_tool_request_and_completion_events.yaml @@ -42,9 +42,11 @@ conversations: arguments: '{"seed":"hello"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, magic_number. - role: tool tool_call_id: toolcall_1 content: MAGIC_hello_42 - role: assistant - content: The magic number for seed 'hello' is **MAGIC_hello_42**. + content: "The magic number tool with seed 'hello' returned: **MAGIC_hello_42**" diff --git a/test/snapshots/multi_client/disconnecting_client_removes_its_tools.yaml b/test/snapshots/multi_client/disconnecting_client_removes_its_tools.yaml index 1da7b9282..b6410e0d1 100644 --- a/test/snapshots/multi_client/disconnecting_client_removes_its_tools.yaml +++ b/test/snapshots/multi_client/disconnecting_client_removes_its_tools.yaml @@ -42,26 +42,47 @@ conversations: arguments: '{"input":"test1"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, stable_tool, ephemeral_tool. - role: tool tool_call_id: toolcall_1 content: STABLE_test1 - role: assistant content: "The stable_tool returned: **STABLE_test1**" + - messages: + - role: system + content: ${system} - role: user - content: Use the ephemeral_tool with input 'test2' and tell me the result. - - role: assistant - content: I'll call the ephemeral_tool with input 'test2' for you. + content: Use the stable_tool with input 'test1' and tell me the result. - role: assistant + content: I'll call the stable_tool with input 'test1' for you. tool_calls: - - id: toolcall_2 + - id: toolcall_0 type: function function: name: report_intent - arguments: '{"intent":"Testing ephemeral_tool"}' + arguments: '{"intent":"Testing stable_tool"}' + - id: toolcall_1 + type: function + function: + name: stable_tool + arguments: '{"input":"test1"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. + - role: tool + tool_call_id: toolcall_1 + content: STABLE_test1 + - role: assistant + content: "The stable_tool returned: **STABLE_test1**" + - role: user + content: Use the ephemeral_tool with input 'test2' and tell me the result. + - role: assistant + content: I'll call the ephemeral_tool with input 'test2' for you. - role: assistant tool_calls: - - id: toolcall_3 + - id: toolcall_2 type: function function: name: ephemeral_tool @@ -86,7 +107,7 @@ conversations: arguments: '{"input":"test1"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: STABLE_test1 @@ -98,20 +119,12 @@ conversations: content: I'll call the ephemeral_tool with input 'test2' for you. tool_calls: - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing ephemeral_tool"}' - - id: toolcall_3 type: function function: name: ephemeral_tool arguments: '{"input":"test2"}' - role: tool tool_call_id: toolcall_2 - content: Intent logged - - role: tool - tool_call_id: toolcall_3 content: EPHEMERAL_test2 - role: assistant content: "The ephemeral_tool returned: **EPHEMERAL_test2**" @@ -130,18 +143,11 @@ conversations: Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available. - role: assistant - content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available, so I can only use - the stable_tool. + content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available according to the + system notification. - role: assistant tool_calls: - - id: toolcall_4 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing tool availability"}' - - role: assistant - tool_calls: - - id: toolcall_5 + - id: toolcall_3 type: function function: name: stable_tool @@ -166,7 +172,7 @@ conversations: arguments: '{"input":"test1"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: STABLE_test1 @@ -178,20 +184,12 @@ conversations: content: I'll call the ephemeral_tool with input 'test2' for you. tool_calls: - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing ephemeral_tool"}' - - id: toolcall_3 type: function function: name: ephemeral_tool arguments: '{"input":"test2"}' - role: tool tool_call_id: toolcall_2 - content: Intent logged - - role: tool - tool_call_id: toolcall_3 content: EPHEMERAL_test2 - role: assistant content: "The ephemeral_tool returned: **EPHEMERAL_test2**" @@ -210,29 +208,19 @@ conversations: Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available. - role: assistant - content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available, so I can only use - the stable_tool. + content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available according to the + system notification. tool_calls: - - id: toolcall_4 - type: function - function: - name: report_intent - arguments: '{"intent":"Testing tool availability"}' - - id: toolcall_5 + - id: toolcall_3 type: function function: name: stable_tool arguments: '{"input":"still_here"}' - role: tool - tool_call_id: toolcall_4 - content: Intent logged - - role: tool - tool_call_id: toolcall_5 + tool_call_id: toolcall_3 content: STABLE_still_here - role: assistant - content: >- + content: |- The stable_tool returned: **STABLE_still_here** - - The ephemeral_tool is not available anymore (it was removed as indicated in the tools_changed_notice), so I - could only call the stable_tool. + The ephemeral_tool is not available - it was removed and I cannot call it. diff --git a/test/snapshots/multi_client/one_client_approves_permission_and_both_see_the_result.yaml b/test/snapshots/multi_client/one_client_approves_permission_and_both_see_the_result.yaml index e67357589..2397bfdc0 100644 --- a/test/snapshots/multi_client/one_client_approves_permission_and_both_see_the_result.yaml +++ b/test/snapshots/multi_client/one_client_approves_permission_and_both_see_the_result.yaml @@ -42,9 +42,11 @@ conversations: arguments: '{"file_text":"hello world","path":"${workdir}/hello.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Created file ${workdir}/hello.txt with 11 characters - role: assistant - content: Done - I created hello.txt containing "hello world". + content: Done! I've created hello.txt with the text "hello world" in your current directory. diff --git a/test/snapshots/multi_client/two_clients_register_different_tools_and_agent_uses_both.yaml b/test/snapshots/multi_client/two_clients_register_different_tools_and_agent_uses_both.yaml index d0c95ba8a..c04864d82 100644 --- a/test/snapshots/multi_client/two_clients_register_different_tools_and_agent_uses_both.yaml +++ b/test/snapshots/multi_client/two_clients_register_different_tools_and_agent_uses_both.yaml @@ -42,26 +42,47 @@ conversations: arguments: '{"countryCode":"US"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, city_lookup, currency_lookup. - role: tool tool_call_id: toolcall_1 content: CITY_FOR_US - role: assistant - content: The city_lookup tool returned **"CITY_FOR_US"** for the country code 'US'. + content: "The city_lookup tool returned: **CITY_FOR_US**" + - messages: + - role: system + content: ${system} - role: user - content: Now use the currency_lookup tool with countryCode 'US' and tell me the result. - - role: assistant - content: I'll call the currency_lookup tool with the country code 'US' for you. + content: Use the city_lookup tool with countryCode 'US' and tell me the result. - role: assistant + content: I'll call the city_lookup tool with the country code 'US' for you. tool_calls: - - id: toolcall_2 + - id: toolcall_0 type: function function: name: report_intent - arguments: '{"intent":"Looking up currency information"}' + arguments: '{"intent":"Looking up city information"}' + - id: toolcall_1 + type: function + function: + name: city_lookup + arguments: '{"countryCode":"US"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. + - role: tool + tool_call_id: toolcall_1 + content: CITY_FOR_US + - role: assistant + content: "The city_lookup tool returned: **CITY_FOR_US**" + - role: user + content: Now use the currency_lookup tool with countryCode 'US' and tell me the result. + - role: assistant + content: I'll call the currency_lookup tool with the country code 'US' for you. - role: assistant tool_calls: - - id: toolcall_3 + - id: toolcall_2 type: function function: name: currency_lookup @@ -86,32 +107,24 @@ conversations: arguments: '{"countryCode":"US"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: CITY_FOR_US - role: assistant - content: The city_lookup tool returned **"CITY_FOR_US"** for the country code 'US'. + content: "The city_lookup tool returned: **CITY_FOR_US**" - role: user content: Now use the currency_lookup tool with countryCode 'US' and tell me the result. - role: assistant content: I'll call the currency_lookup tool with the country code 'US' for you. tool_calls: - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Looking up currency information"}' - - id: toolcall_3 type: function function: name: currency_lookup arguments: '{"countryCode":"US"}' - role: tool tool_call_id: toolcall_2 - content: Intent logged - - role: tool - tool_call_id: toolcall_3 content: CURRENCY_FOR_US - role: assistant - content: The currency_lookup tool returned **"CURRENCY_FOR_US"** for the country code 'US'. + content: "The currency_lookup tool returned: **CURRENCY_FOR_US**" diff --git a/test/snapshots/multi_provider_registry/should_register_multiple_providers_with_custom_agents_bound_to_their_models.yaml b/test/snapshots/multi_provider_registry/should_register_multiple_providers_with_custom_agents_bound_to_their_models.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/multi_provider_registry/should_register_multiple_providers_with_custom_agents_bound_to_their_models.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/multi_provider_registry/should_route_alpha_haiku_turn_to_its_provider_and_wire_model.yaml b/test/snapshots/multi_provider_registry/should_route_alpha_haiku_turn_to_its_provider_and_wire_model.yaml new file mode 100644 index 000000000..c669af9ad --- /dev/null +++ b/test/snapshots/multi_provider_registry/should_route_alpha_haiku_turn_to_its_provider_and_wire_model.yaml @@ -0,0 +1,10 @@ +models: + - byok-gpt-4o-mini +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 5+5? + - role: assistant + content: 5 + 5 = 10 diff --git a/test/snapshots/multi_provider_registry/should_route_alpha_sonnet_turn_to_its_provider_and_wire_model.yaml b/test/snapshots/multi_provider_registry/should_route_alpha_sonnet_turn_to_its_provider_and_wire_model.yaml new file mode 100644 index 000000000..faa2379e8 --- /dev/null +++ b/test/snapshots/multi_provider_registry/should_route_alpha_sonnet_turn_to_its_provider_and_wire_model.yaml @@ -0,0 +1,10 @@ +models: + - byok-gpt-4o +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 5+5? + - role: assistant + content: 5 + 5 = 10 diff --git a/test/snapshots/multi_provider_registry/should_route_delta_turbo_turn_to_its_provider_and_wire_model.yaml b/test/snapshots/multi_provider_registry/should_route_delta_turbo_turn_to_its_provider_and_wire_model.yaml new file mode 100644 index 000000000..f0dc69b50 --- /dev/null +++ b/test/snapshots/multi_provider_registry/should_route_delta_turbo_turn_to_its_provider_and_wire_model.yaml @@ -0,0 +1,10 @@ +models: + - byok-gpt-4-turbo +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 5+5? + - role: assistant + content: 5 + 5 = 10 diff --git a/test/snapshots/multi_turn/should_handle_file_creation_then_reading_across_turns.yaml b/test/snapshots/multi_turn/should_handle_file_creation_then_reading_across_turns.yaml index 64af54b27..0d79c3e1a 100644 --- a/test/snapshots/multi_turn/should_handle_file_creation_then_reading_across_turns.yaml +++ b/test/snapshots/multi_turn/should_handle_file_creation_then_reading_across_turns.yaml @@ -39,28 +39,14 @@ conversations: arguments: '{"path":"${workdir}/greeting.txt","file_text":"Hello from multi-turn test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Created file ${workdir}/greeting.txt with 26 characters - role: assistant content: Created `greeting.txt` with the content "Hello from multi-turn test". - - role: user - content: Read the file 'greeting.txt' and tell me its exact contents. - - role: assistant - tool_calls: - - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Reading greeting file"}' - - role: assistant - tool_calls: - - id: toolcall_3 - type: function - function: - name: view - arguments: '{"path":"${workdir}/greeting.txt"}' - messages: - role: system content: ${system} @@ -80,7 +66,7 @@ conversations: arguments: '{"path":"${workdir}/greeting.txt","file_text":"Hello from multi-turn test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: Created file ${workdir}/greeting.txt with 26 characters @@ -91,20 +77,17 @@ conversations: - role: assistant tool_calls: - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Reading greeting file"}' - - id: toolcall_3 type: function function: name: view arguments: '{"path":"${workdir}/greeting.txt"}' - role: tool tool_call_id: toolcall_2 - content: Intent logged - - role: tool - tool_call_id: toolcall_3 content: 1. Hello from multi-turn test - role: assistant - content: "The exact contents of `greeting.txt` are: `Hello from multi-turn test`" + content: |- + The exact contents of `greeting.txt` are: + + ``` + Hello from multi-turn test + ``` diff --git a/test/snapshots/multi_turn/should_use_tool_results_from_previous_turns.yaml b/test/snapshots/multi_turn/should_use_tool_results_from_previous_turns.yaml index 8e9ce440d..b930bb46a 100644 --- a/test/snapshots/multi_turn/should_use_tool_results_from_previous_turns.yaml +++ b/test/snapshots/multi_turn/should_use_tool_results_from_previous_turns.yaml @@ -39,7 +39,34 @@ conversations: arguments: '{"path":"${workdir}/secret.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: 1. The magic number is 42. + - role: assistant + content: The magic number is **42**. + - messages: + - role: system + content: ${system} + - role: user + content: Read the file 'secret.txt' and tell me what the magic number is. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Reading secret file"}' + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/secret.txt"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: 1. The magic number is 42. @@ -48,4 +75,4 @@ conversations: - role: user content: What is that magic number multiplied by 2? - role: assistant - content: 42 × 2 = **84** + content: The magic number (42) multiplied by 2 is **84**. diff --git a/test/snapshots/pending_work_resume/should_continue_parallel_pending_external_tool_requests_after_resume.yaml b/test/snapshots/pending_work_resume/should_continue_parallel_pending_external_tool_requests_after_resume.yaml index 0216a2116..acae9a8b2 100644 --- a/test/snapshots/pending_work_resume/should_continue_parallel_pending_external_tool_requests_after_resume.yaml +++ b/test/snapshots/pending_work_resume/should_continue_parallel_pending_external_tool_requests_after_resume.yaml @@ -18,12 +18,12 @@ conversations: function: name: pending_lookup_b arguments: '{"value":"beta"}' - - role: tool - tool_call_id: toolcall_1 - content: PARALLEL_B_BETA - role: tool tool_call_id: toolcall_0 content: PARALLEL_A_ALPHA + - role: tool + tool_call_id: toolcall_1 + content: PARALLEL_B_BETA - role: assistant content: |- Both lookups completed successfully: diff --git a/test/snapshots/pending_work_resume/should_continue_pending_permission_request_after_resume.yaml b/test/snapshots/pending_work_resume/should_continue_pending_permission_request_after_resume.yaml index 37a4a0bae..4856cdc4c 100644 --- a/test/snapshots/pending_work_resume/should_continue_pending_permission_request_after_resume.yaml +++ b/test/snapshots/pending_work_resume/should_continue_pending_permission_request_after_resume.yaml @@ -13,11 +13,3 @@ conversations: function: name: resume_permission_tool arguments: '{"value":"alpha"}' - - role: tool - tool_call_id: toolcall_0 - content: PERMISSION_RESUMED_ALPHA - - role: assistant - content: |- - I called `resume_permission_tool` with the value 'alpha' and received the result: - - **PERMISSION_RESUMED_ALPHA** diff --git a/test/snapshots/pending_work_resume/should_keep_pending_external_tool_handleable_on_cold_resume_when_continuependingwork_is_false.yaml b/test/snapshots/pending_work_resume/should_keep_pending_external_tool_handleable_on_cold_resume_when_continuependingwork_is_false.yaml new file mode 100644 index 000000000..8a32e431a --- /dev/null +++ b/test/snapshots/pending_work_resume/should_keep_pending_external_tool_handleable_on_cold_resume_when_continuependingwork_is_false.yaml @@ -0,0 +1,22 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Use resume_external_tool with value 'beta', then reply with the result. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: resume_external_tool + arguments: '{"value":"beta"}' + - role: tool + tool_call_id: toolcall_0 + content: The execution of this tool, or a previous tool was interrupted. + - role: user + content: "Reply with exactly: COLD_RESUMED_FOLLOWUP" + - role: assistant + content: COLD_RESUMED_FOLLOWUP diff --git a/test/snapshots/permissions/async_permission_handler.yaml b/test/snapshots/permissions/async_permission_handler.yaml index 5cc63c085..1d46c38a4 100644 --- a/test/snapshots/permissions/async_permission_handler.yaml +++ b/test/snapshots/permissions/async_permission_handler.yaml @@ -19,7 +19,7 @@ conversations: type: function function: name: ${shell} - arguments: '{"command":"echo test","description":"Run echo test command"}' + arguments: '{"command":"echo test","description":"Run echo test"}' - messages: - role: system content: ${system} @@ -36,15 +36,17 @@ conversations: type: function function: name: ${shell} - arguments: '{"command":"echo test","description":"Run echo test command"}' + arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- test - role: assistant - content: The command successfully executed and outputted "test" to the console, then exited with code 0 (indicating - success). + content: The command ran successfully and output `test` to the console. It completed with exit code 0, which means it + executed without any errors. diff --git a/test/snapshots/permissions/permission_handler_for_shell_commands.yaml b/test/snapshots/permissions/permission_handler_for_shell_commands.yaml index 7078d1dba..1d46c38a4 100644 --- a/test/snapshots/permissions/permission_handler_for_shell_commands.yaml +++ b/test/snapshots/permissions/permission_handler_for_shell_commands.yaml @@ -5,7 +5,26 @@ conversations: - role: system content: ${system} - role: user - content: Run 'echo hello' and tell me the output + content: Run 'echo test' and tell me what happens + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Running echo command"}' + - role: assistant + tool_calls: + - id: toolcall_1 + type: function + function: + name: ${shell} + arguments: '{"command":"echo test","description":"Run echo test"}' + - messages: + - role: system + content: ${system} + - role: user + content: Run 'echo test' and tell me what happens - role: assistant tool_calls: - id: toolcall_0 @@ -17,14 +36,17 @@ conversations: type: function function: name: ${shell} - arguments: '{"command":"echo hello","description":"Run echo hello"}' + arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- - hello + test - role: assistant - content: The output is `hello`. + content: The command ran successfully and output `test` to the console. It completed with exit code 0, which means it + executed without any errors. diff --git a/test/snapshots/permissions/permission_handler_for_write_operations.yaml b/test/snapshots/permissions/permission_handler_for_write_operations.yaml index a08639800..a4ede6fcb 100644 --- a/test/snapshots/permissions/permission_handler_for_write_operations.yaml +++ b/test/snapshots/permissions/permission_handler_for_write_operations.yaml @@ -42,19 +42,57 @@ conversations: arguments: '{"path":"${workdir}/test.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. original content - role: assistant + content: "Now I'll replace 'original' with 'modified':" + - role: assistant + tool_calls: + - id: toolcall_2 + type: function + function: + name: edit + arguments: '{"new_str":"modified content","old_str":"original content","path":"${workdir}/test.txt"}' + - messages: + - role: system + content: ${system} + - role: user + content: Edit test.txt and replace 'original' with 'modified' + - role: assistant + content: I'll view the file first to see its contents, then make the replacement. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Editing test.txt file"}' + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: 1. original content + - role: assistant + content: "Now I'll replace 'original' with 'modified':" tool_calls: - id: toolcall_2 type: function function: name: edit - arguments: '{"path":"${workdir}/test.txt","old_str":"original content","new_str":"modified content"}' + arguments: '{"new_str":"modified content","old_str":"original content","path":"${workdir}/test.txt"}' - role: tool tool_call_id: toolcall_2 content: File ${workdir}/test.txt updated with changes. - role: assistant - content: Done! I've replaced 'original' with 'modified' in test.txt. + content: Done! I've replaced 'original' with 'modified' in test.txt. The file now contains "modified content". diff --git a/test/snapshots/permissions/resume_session_with_permission_handler.yaml b/test/snapshots/permissions/resume_session_with_permission_handler.yaml index 3eb05551a..6296a0d73 100644 --- a/test/snapshots/permissions/resume_session_with_permission_handler.yaml +++ b/test/snapshots/permissions/resume_session_with_permission_handler.yaml @@ -7,7 +7,7 @@ conversations: - role: user content: What is 1+1? - role: assistant - content: 1+1 equals 2. + content: 1+1 = 2 - role: user content: Run 'echo resumed' for me - role: assistant @@ -23,14 +23,14 @@ conversations: type: function function: name: ${shell} - arguments: '{"command":"echo resumed","description":"Run echo resumed"}' + arguments: '{"description":"Run echo resumed","command":"echo resumed"}' - messages: - role: system content: ${system} - role: user content: What is 1+1? - role: assistant - content: 1+1 equals 2. + content: 1+1 = 2 - role: user content: Run 'echo resumed' for me - role: assistant @@ -44,14 +44,16 @@ conversations: type: function function: name: ${shell} - arguments: '{"command":"echo resumed","description":"Run echo resumed"}' + arguments: '{"description":"Run echo resumed","command":"echo resumed"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- resumed - role: assistant - content: 'Command executed successfully - output: "resumed"' + content: Done! The command output "resumed". diff --git a/test/snapshots/permissions/should_deny_permission_when_handler_returns_denied.yaml b/test/snapshots/permissions/should_deny_permission_when_handler_returns_denied.yaml index 9e54aa424..ef6f60dbe 100644 --- a/test/snapshots/permissions/should_deny_permission_when_handler_returns_denied.yaml +++ b/test/snapshots/permissions/should_deny_permission_when_handler_returns_denied.yaml @@ -22,29 +22,3 @@ conversations: function: name: view arguments: '{"path":"${workdir}/protected.txt"}' - - messages: - - role: system - content: ${system} - - role: user - content: Edit protected.txt and replace 'protected' with 'hacked'. - - role: assistant - content: I'll view the file first, then make the edit. - tool_calls: - - id: toolcall_0 - type: function - function: - name: report_intent - arguments: '{"intent":"Editing protected.txt file"}' - - id: toolcall_1 - type: function - function: - name: view - arguments: '{"path":"${workdir}/protected.txt"}' - - role: tool - tool_call_id: toolcall_0 - content: Intent logged - - role: tool - tool_call_id: toolcall_1 - content: Permission denied and could not request permission from user - - role: assistant - content: I don't have permission to view or edit protected.txt, so I can't make that change. diff --git a/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies.yaml b/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies.yaml index c0fc46a9a..0d25979c7 100644 --- a/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies.yaml +++ b/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies.yaml @@ -39,10 +39,12 @@ conversations: arguments: '{"command":"node --version","description":"Check Node.js version"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Permission denied and could not request permission from user - role: assistant - content: Permission was denied to run the command. This may be due to security policies or execution restrictions in the - current environment. + content: I don't have permission to execute commands in this environment. It seems access is restricted. You may need to + grant permission or run the command directly in your terminal. diff --git a/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies_after_resume.yaml b/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies_after_resume.yaml index 551ba8f91..9a23c55f0 100644 --- a/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies_after_resume.yaml +++ b/test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies_after_resume.yaml @@ -47,10 +47,12 @@ conversations: arguments: '{"command":"node --version","description":"Check Node.js version"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Permission denied and could not request permission from user - role: assistant - content: The command was denied due to insufficient permissions. You'll need to grant permission to run commands in this - session. + content: I don't have permission to run commands in this environment. Please try running `node --version` directly in + your terminal. diff --git a/test/snapshots/permissions/should_handle_async_permission_handler.yaml b/test/snapshots/permissions/should_handle_async_permission_handler.yaml index f28c96ca7..1d46c38a4 100644 --- a/test/snapshots/permissions/should_handle_async_permission_handler.yaml +++ b/test/snapshots/permissions/should_handle_async_permission_handler.yaml @@ -39,12 +39,14 @@ conversations: arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- test - role: assistant - content: The command successfully executed and printed "test" to the console, then exited with exit code 0 (indicating - success). + content: The command ran successfully and output `test` to the console. It completed with exit code 0, which means it + executed without any errors. diff --git a/test/snapshots/permissions/should_handle_permission_handler_errors_gracefully.yaml b/test/snapshots/permissions/should_handle_permission_handler_errors_gracefully.yaml index cee78a092..2a2db6210 100644 --- a/test/snapshots/permissions/should_handle_permission_handler_errors_gracefully.yaml +++ b/test/snapshots/permissions/should_handle_permission_handler_errors_gracefully.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Permission denied and could not request permission from user diff --git a/test/snapshots/permissions/should_honor_a_decision_annotated_with_decisioncontext.yaml b/test/snapshots/permissions/should_honor_a_decision_annotated_with_decisioncontext.yaml new file mode 100644 index 000000000..ef6f60dbe --- /dev/null +++ b/test/snapshots/permissions/should_honor_a_decision_annotated_with_decisioncontext.yaml @@ -0,0 +1,24 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Edit protected.txt and replace 'protected' with 'hacked'. + - role: assistant + content: I'll view the file first, then make the edit. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Editing protected.txt file"}' + - role: assistant + tool_calls: + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/protected.txt"}' diff --git a/test/snapshots/permissions/should_invoke_permission_handler_for_write_operations.yaml b/test/snapshots/permissions/should_invoke_permission_handler_for_write_operations.yaml index fe1ecb341..a4ede6fcb 100644 --- a/test/snapshots/permissions/should_invoke_permission_handler_for_write_operations.yaml +++ b/test/snapshots/permissions/should_invoke_permission_handler_for_write_operations.yaml @@ -42,11 +42,49 @@ conversations: arguments: '{"path":"${workdir}/test.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. original content - role: assistant + content: "Now I'll replace 'original' with 'modified':" + - role: assistant + tool_calls: + - id: toolcall_2 + type: function + function: + name: edit + arguments: '{"new_str":"modified content","old_str":"original content","path":"${workdir}/test.txt"}' + - messages: + - role: system + content: ${system} + - role: user + content: Edit test.txt and replace 'original' with 'modified' + - role: assistant + content: I'll view the file first to see its contents, then make the replacement. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Editing test.txt file"}' + - id: toolcall_1 + type: function + function: + name: view + arguments: '{"path":"${workdir}/test.txt"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: 1. original content + - role: assistant + content: "Now I'll replace 'original' with 'modified':" tool_calls: - id: toolcall_2 type: function diff --git a/test/snapshots/permissions/should_receive_toolcallid_in_permission_requests.yaml b/test/snapshots/permissions/should_receive_toolcallid_in_permission_requests.yaml index b529a01e6..90407df6f 100644 --- a/test/snapshots/permissions/should_receive_toolcallid_in_permission_requests.yaml +++ b/test/snapshots/permissions/should_receive_toolcallid_in_permission_requests.yaml @@ -39,11 +39,13 @@ conversations: arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- test - role: assistant - content: Command executed successfully, output is "test". + content: "✓ Command output: `test`" diff --git a/test/snapshots/permissions/should_resume_session_with_permission_handler.yaml b/test/snapshots/permissions/should_resume_session_with_permission_handler.yaml index 69a52be87..6296a0d73 100644 --- a/test/snapshots/permissions/should_resume_session_with_permission_handler.yaml +++ b/test/snapshots/permissions/should_resume_session_with_permission_handler.yaml @@ -47,11 +47,13 @@ conversations: arguments: '{"description":"Run echo resumed","command":"echo resumed"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- resumed - role: assistant - content: "The command executed successfully and output: **resumed**" + content: Done! The command output "resumed". diff --git a/test/snapshots/permissions/should_short_circuit_permission_handler_when_set_approve_all_enabled.yaml b/test/snapshots/permissions/should_short_circuit_permission_handler_when_set_approve_all_enabled.yaml index e9550b2cb..3a6d66dc8 100644 --- a/test/snapshots/permissions/should_short_circuit_permission_handler_when_set_approve_all_enabled.yaml +++ b/test/snapshots/permissions/should_short_circuit_permission_handler_when_set_approve_all_enabled.yaml @@ -20,12 +20,14 @@ conversations: arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- test - role: assistant - content: The command successfully executed and printed "test" to the console, then exited with exit code 0 (indicating - success). + content: The command executed successfully and output "test" to the console. The shell completed with exit code 0, which + indicates success. diff --git a/test/snapshots/permissions/tool_call_id_in_permission_requests.yaml b/test/snapshots/permissions/tool_call_id_in_permission_requests.yaml index 3620c2c1c..90407df6f 100644 --- a/test/snapshots/permissions/tool_call_id_in_permission_requests.yaml +++ b/test/snapshots/permissions/tool_call_id_in_permission_requests.yaml @@ -39,11 +39,13 @@ conversations: arguments: '{"command":"echo test","description":"Run echo test"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- test - role: assistant - content: "The command executed successfully and output: `test`" + content: "✓ Command output: `test`" diff --git a/test/snapshots/resume_mcp_oauth/should_resume_a_persisted_session_with_mcp_auth_handler.yaml b/test/snapshots/resume_mcp_oauth/should_resume_a_persisted_session_with_mcp_auth_handler.yaml new file mode 100644 index 000000000..250402101 --- /dev/null +++ b/test/snapshots/resume_mcp_oauth/should_resume_a_persisted_session_with_mcp_auth_handler.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 1+1? + - role: assistant + content: 1 + 1 = 2 diff --git a/test/snapshots/rewind/should_restore_tracked_file_and_conversation.yaml b/test/snapshots/rewind/should_restore_tracked_file_and_conversation.yaml new file mode 100644 index 000000000..2ef3733e0 --- /dev/null +++ b/test/snapshots/rewind/should_restore_tracked_file_and_conversation.yaml @@ -0,0 +1,21 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Use the create tool to create rewind-sdk.txt containing exactly SDK rewind content. After the tool succeeds, + reply with exactly SDK_REWIND_DONE. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: create + arguments: '{"path":"${workdir}/rewind-sdk.txt","file_text":"SDK rewind content"}' + - role: tool + tool_call_id: toolcall_0 + content: Created file ${workdir}/rewind-sdk.txt with 18 characters + - role: assistant + content: SDK_REWIND_DONE diff --git a/test/snapshots/rpc_mcp_lifecycle/should_configure_github_mcp_server.yaml b/test/snapshots/rpc_mcp_lifecycle/should_configure_github_mcp_server.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_configure_github_mcp_server.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_mcp_lifecycle/should_list_tools_and_report_running_status_for_connected_server.yaml b/test/snapshots/rpc_mcp_lifecycle/should_list_tools_and_report_running_status_for_connected_server.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_list_tools_and_report_running_status_for_connected_server.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_mcp_lifecycle/should_reload_mcp_servers_with_config.yaml b/test/snapshots/rpc_mcp_lifecycle/should_reload_mcp_servers_with_config.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_reload_mcp_servers_with_config.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_mcp_lifecycle/should_start_and_restart_mcp_server.yaml b/test/snapshots/rpc_mcp_lifecycle/should_start_and_restart_mcp_server.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_start_and_restart_mcp_server.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_mcp_lifecycle/should_stop_running_mcp_server.yaml b/test/snapshots/rpc_mcp_lifecycle/should_stop_running_mcp_server.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_stop_running_mcp_server.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_mcp_lifecycle/should_throw_when_listing_tools_for_unconnected_server.yaml b/test/snapshots/rpc_mcp_lifecycle/should_throw_when_listing_tools_for_unconnected_server.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_mcp_lifecycle/should_throw_when_listing_tools_for_unconnected_server.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_get_set_and_clear_user_settings.yaml b/test/snapshots/rpc_server_misc/should_get_set_and_clear_user_settings.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_get_set_and_clear_user_settings.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_login_list_getcurrentauth_and_logout_account.yaml b/test/snapshots/rpc_server_misc/should_login_list_getcurrentauth_and_logout_account.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_login_list_getcurrentauth_and_logout_account.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_reject_send_attachments_from_non_extension_connection.yaml b/test/snapshots/rpc_server_misc/should_reject_send_attachments_from_non_extension_connection.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_reject_send_attachments_from_non_extension_connection.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_reload_user_settings.yaml b/test/snapshots/rpc_server_misc/should_reload_user_settings.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_reload_user_settings.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_report_agent_registry_spawn_gate_closed.yaml b/test/snapshots/rpc_server_misc/should_report_agent_registry_spawn_gate_closed.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_report_agent_registry_spawn_gate_closed.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_report_not_found_when_opening_session_without_context.yaml b/test/snapshots/rpc_server_misc/should_report_not_found_when_opening_session_without_context.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_report_not_found_when_opening_session_without_context.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_misc/should_shut_down_owned_runtime.yaml b/test/snapshots/rpc_server_misc/should_shut_down_owned_runtime.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_misc/should_shut_down_owned_runtime.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_enable_and_disable_marketplace_plugin.yaml b/test/snapshots/rpc_server_plugins/should_enable_and_disable_marketplace_plugin.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_enable_and_disable_marketplace_plugin.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_install_direct_local_plugin_with_deprecation_warning.yaml b/test/snapshots/rpc_server_plugins/should_install_direct_local_plugin_with_deprecation_warning.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_install_direct_local_plugin_with_deprecation_warning.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_install_list_and_uninstall_plugin_from_local_marketplace.yaml b/test/snapshots/rpc_server_plugins/should_install_list_and_uninstall_plugin_from_local_marketplace.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_install_list_and_uninstall_plugin_from_local_marketplace.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_list_browse_refresh_and_remove_local_marketplace.yaml b/test/snapshots/rpc_server_plugins/should_list_browse_refresh_and_remove_local_marketplace.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_list_browse_refresh_and_remove_local_marketplace.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_reload_mcp_config_cache.yaml b/test/snapshots/rpc_server_plugins/should_reload_mcp_config_cache.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_reload_mcp_config_cache.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_update_all_installed_plugins.yaml b/test/snapshots/rpc_server_plugins/should_update_all_installed_plugins.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_update_all_installed_plugins.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_plugins/should_update_single_marketplace_plugin.yaml b/test/snapshots/rpc_server_plugins/should_update_single_marketplace_plugin.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_plugins/should_update_single_marketplace_plugin.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_remote_control/should_reach_runtime_when_starting_remote_control_for_unknown_session.yaml b/test/snapshots/rpc_server_remote_control/should_reach_runtime_when_starting_remote_control_for_unknown_session.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_remote_control/should_reach_runtime_when_starting_remote_control_for_unknown_session.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_remote_control/should_reject_transfer_when_off_with_compare_and_swap.yaml b/test/snapshots/rpc_server_remote_control/should_reject_transfer_when_off_with_compare_and_swap.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_remote_control/should_reject_transfer_when_off_with_compare_and_swap.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_remote_control/should_report_not_stopped_when_remote_control_is_off.yaml b/test/snapshots/rpc_server_remote_control/should_report_not_stopped_when_remote_control_is_off.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_remote_control/should_report_not_stopped_when_remote_control_is_off.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_remote_control/should_report_remote_control_status_as_off.yaml b/test/snapshots/rpc_server_remote_control/should_report_remote_control_status_as_off.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_remote_control/should_report_remote_control_status_as_off.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_server_remote_control/should_treat_set_steering_as_no_op_when_off.yaml b/test/snapshots/rpc_server_remote_control/should_treat_set_steering_as_no_op_when_off.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_server_remote_control/should_treat_set_steering_as_no_op_when_off.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state/should_call_session_rpc_model_switchto.yaml b/test/snapshots/rpc_session_state/should_call_session_rpc_model_switchto.yaml index 056351ddb..b276b6a39 100644 --- a/test/snapshots/rpc_session_state/should_call_session_rpc_model_switchto.yaml +++ b/test/snapshots/rpc_session_state/should_call_session_rpc_model_switchto.yaml @@ -1,3 +1,4 @@ models: - claude-sonnet-4.5 + - gpt-5.4 conversations: [] diff --git a/test/snapshots/rpc_session_state/should_report_processing_and_context_metadata.yaml b/test/snapshots/rpc_session_state/should_report_processing_and_context_metadata.yaml new file mode 100644 index 000000000..6760888d7 --- /dev/null +++ b/test/snapshots/rpc_session_state/should_report_processing_and_context_metadata.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: "Reply with exactly: RUST_CONTEXT_INFO" + - role: assistant + content: RUST_CONTEXT_INFO diff --git a/test/snapshots/rpc_session_state_extras/should_add_byok_provider_and_model_at_runtime.yaml b/test/snapshots/rpc_session_state_extras/should_add_byok_provider_and_model_at_runtime.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_add_byok_provider_and_model_at_runtime.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_get_and_set_allowall_permissions.yaml b/test/snapshots/rpc_session_state_extras/should_get_and_set_allowall_permissions.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_get_and_set_allowall_permissions.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_get_context_attribution_and_heaviest_messages_after_turn.yaml b/test/snapshots/rpc_session_state_extras/should_get_context_attribution_and_heaviest_messages_after_turn.yaml new file mode 100644 index 000000000..c4798dc83 --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_get_context_attribution_and_heaviest_messages_after_turn.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Say CONTEXT_METADATA_OK exactly. + - role: assistant + content: CONTEXT_METADATA_OK diff --git a/test/snapshots/rpc_session_state_extras/should_get_current_tool_metadata_after_initialization.yaml b/test/snapshots/rpc_session_state_extras/should_get_current_tool_metadata_after_initialization.yaml new file mode 100644 index 000000000..73f049900 --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_get_current_tool_metadata_after_initialization.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 2+2? + - role: assistant + content: "4" diff --git a/test/snapshots/rpc_session_state_extras/should_get_telemetry_engagement_id.yaml b/test/snapshots/rpc_session_state_extras/should_get_telemetry_engagement_id.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_get_telemetry_engagement_id.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_list_models_for_session.yaml b/test/snapshots/rpc_session_state_extras/should_list_models_for_session.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_list_models_for_session.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_read_empty_sql_todos_for_fresh_session.yaml b/test/snapshots/rpc_session_state_extras/should_read_empty_sql_todos_for_fresh_session.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_read_empty_sql_todos_for_fresh_session.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_reload_session_plugins.yaml b/test/snapshots/rpc_session_state_extras/should_reload_session_plugins.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_reload_session_plugins.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_report_session_activity_when_idle.yaml b/test/snapshots/rpc_session_state_extras/should_report_session_activity_when_idle.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_report_session_activity_when_idle.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_report_visibility_as_unsynced_for_local_session.yaml b/test/snapshots/rpc_session_state_extras/should_report_visibility_as_unsynced_for_local_session.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_report_visibility_as_unsynced_for_local_session.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_return_empty_completions_when_host_does_not_provide_them.yaml b/test/snapshots/rpc_session_state_extras/should_return_empty_completions_when_host_does_not_provide_them.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_return_empty_completions_when_host_does_not_provide_them.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_session_state_extras/should_update_and_clear_live_subagent_settings.yaml b/test/snapshots/rpc_session_state_extras/should_update_and_clear_live_subagent_settings.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_session_state_extras/should_update_and_clear_live_subagent_settings.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_shell_and_fleet/should_start_fleet_and_complete_custom_tool_task.yaml b/test/snapshots/rpc_shell_and_fleet/should_start_fleet_and_complete_custom_tool_task.yaml index b550e96f2..65ced1e36 100644 --- a/test/snapshots/rpc_shell_and_fleet/should_start_fleet_and_complete_custom_tool_task.yaml +++ b/test/snapshots/rpc_shell_and_fleet/should_start_fleet_and_complete_custom_tool_task.yaml @@ -168,12 +168,16 @@ conversations: arguments: '{"content":"copilot-sdk-fleet-rpc"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, record_fleet_completion. - role: tool tool_call_id: toolcall_1 content: copilot-sdk-fleet-rpc - role: assistant - content: |- + content: >- ✅ **Fleet task complete!** - I've successfully recorded the fleet completion with content 'copilot-sdk-fleet-rpc'. The validation is done. + + I've successfully recorded the fleet completion with content 'copilot-sdk-fleet-rpc'. The validation task has + been completed as requested. diff --git a/test/snapshots/rpc_shell_user_requested/should_cancel_user_requested_shell_command.yaml b/test/snapshots/rpc_shell_user_requested/should_cancel_user_requested_shell_command.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_shell_user_requested/should_cancel_user_requested_shell_command.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_shell_user_requested/should_execute_user_requested_shell_command.yaml b/test/snapshots/rpc_shell_user_requested/should_execute_user_requested_shell_command.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/rpc_shell_user_requested/should_execute_user_requested_shell_command.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/rpc_ui_ephemeral_query/should_answer_ephemeral_query.yaml b/test/snapshots/rpc_ui_ephemeral_query/should_answer_ephemeral_query.yaml new file mode 100644 index 000000000..fec44be1f --- /dev/null +++ b/test/snapshots/rpc_ui_ephemeral_query/should_answer_ephemeral_query.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: In one word, what is the primary color of a clear daytime sky? + - role: assistant + content: Blue. diff --git a/test/snapshots/session/resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured.yaml b/test/snapshots/session/resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured.yaml new file mode 100644 index 000000000..250402101 --- /dev/null +++ b/test/snapshots/session/resumes_a_persisted_session_from_a_new_client_when_an_mcp_oauth_handler_is_configured.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 1+1? + - role: assistant + content: 1 + 1 = 2 diff --git a/test/snapshots/session/send_returns_immediately_while_events_stream_in_background.yaml b/test/snapshots/session/send_returns_immediately_while_events_stream_in_background.yaml index ab9174fc4..c2e705ed2 100644 --- a/test/snapshots/session/send_returns_immediately_while_events_stream_in_background.yaml +++ b/test/snapshots/session/send_returns_immediately_while_events_stream_in_background.yaml @@ -41,11 +41,13 @@ conversations: command","initial_wait":5,"mode":"sync"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: |- done - role: assistant - content: The command completed successfully, waiting 2 seconds before echoing "done". + content: Command completed successfully! The output was "done" after the 2 second sleep. diff --git a/test/snapshots/session/should_abort_a_session.yaml b/test/snapshots/session/should_abort_a_session.yaml index 9f6c42c2b..dbbbd32aa 100644 --- a/test/snapshots/session/should_abort_a_session.yaml +++ b/test/snapshots/session/should_abort_a_session.yaml @@ -42,11 +42,11 @@ conversations: arguments: '{"command":"sleep 100","description":"Run sleep 100 command","mode":"sync","initial_wait":105}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: The execution of this tool, or a previous tool was interrupted. - role: user content: What is 2+2? - role: assistant - content: "4" + content: 2 + 2 = 4 diff --git a/test/snapshots/session/should_accept_blob_attachments.yaml b/test/snapshots/session/should_accept_blob_attachments.yaml index fe584aa8b..1cca7142d 100644 --- a/test/snapshots/session/should_accept_blob_attachments.yaml +++ b/test/snapshots/session/should_accept_blob_attachments.yaml @@ -48,7 +48,9 @@ conversations: arguments: '{"path":"${workdir}/test-pixel.png"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Viewed image file successfully. @@ -57,20 +59,6 @@ conversations: Image file at path ${workdir}/test-pixel.png [image] - role: assistant - content: >- - This is an extremely small image - it appears to be essentially a **single white pixel** or a very tiny white - square on a transparent background. The image is minimal in size and content, likely just a few pixels in - dimension. It's the kind of test image that might be used for: - - - - Testing image loading/rendering functionality - - - Placeholder purposes - - - Minimal file size requirements - - - Image processing pipeline validation - - - The file name "test-pixel.png" confirms this is indeed a test image consisting of just a single pixel or very - small pixel cluster. + content: This is a very small image - essentially a **single yellow/gold pixel** or a tiny square. It appears to be a + minimal test image, likely 1x1 pixel in size, which matches its filename "test-pixel.png". The color is a + bright yellow or golden hue. diff --git a/test/snapshots/session/should_send_with_directory_attachment.yaml b/test/snapshots/session/should_send_with_directory_attachment.yaml index 59943a81c..aa410c929 100644 --- a/test/snapshots/session/should_send_with_directory_attachment.yaml +++ b/test/snapshots/session/should_send_with_directory_attachment.yaml @@ -56,12 +56,15 @@ conversations: arguments: '{"path":"${workdir}/attached-directory"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: readme.txt - role: assistant content: |- - The attached directory contains a single file: **readme.txt** + The attached directory contains one file: + - **readme.txt** Would you like me to view its contents? diff --git a/test/snapshots/session/should_send_with_file_attachment.yaml b/test/snapshots/session/should_send_with_file_attachment.yaml index 9985090a1..23e05d946 100644 --- a/test/snapshots/session/should_send_with_file_attachment.yaml +++ b/test/snapshots/session/should_send_with_file_attachment.yaml @@ -53,13 +53,15 @@ conversations: arguments: '{"path":"${workdir}/attached-file.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. FILE_ATTACHMENT_SENTINEL - role: assistant content: |- - The attached file contains: + The file contains: ``` FILE_ATTACHMENT_SENTINEL diff --git a/test/snapshots/session/should_send_with_github_reference_attachment.yaml b/test/snapshots/session/should_send_with_github_reference_attachment.yaml index 99280e3d8..6e298de55 100644 --- a/test/snapshots/session/should_send_with_github_reference_attachment.yaml +++ b/test/snapshots/session/should_send_with_github_reference_attachment.yaml @@ -14,6 +14,5 @@ conversations: #1234 - Add E2E attachment coverage [issue] [open] (https://github.com/github/copilot-sdk/issues/1234) - role: assistant - content: >- - The referenced GitHub issue is #1234, "Add E2E attachment coverage", in the github/copilot-sdk repository. It - is currently open and can be found at https://github.com/github/copilot-sdk/issues/1234. + content: 'The referenced GitHub issue is #1234, "Add E2E attachment coverage", in the github/copilot-sdk repository. It + is currently open and can be found at https://github.com/github/copilot-sdk/issues/1234.' diff --git a/test/snapshots/session/should_set_model_with_reasoningeffort.yaml b/test/snapshots/session/should_set_model_with_reasoningeffort.yaml index 0e019bdad..ccf204d2a 100644 --- a/test/snapshots/session/should_set_model_with_reasoningeffort.yaml +++ b/test/snapshots/session/should_set_model_with_reasoningeffort.yaml @@ -1,5 +1,6 @@ models: - claude-sonnet-4.5 + - gpt-5.4 conversations: - messages: - role: system diff --git a/test/snapshots/session_config/should_accept_message_attachments.yaml b/test/snapshots/session_config/should_accept_message_attachments.yaml index 2a345b4b3..e9fbabb05 100644 --- a/test/snapshots/session_config/should_accept_message_attachments.yaml +++ b/test/snapshots/session_config/should_accept_message_attachments.yaml @@ -56,10 +56,14 @@ conversations: arguments: '{"path":"${workdir}/attached.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. This file is attached - role: assistant - content: The attached file contains a single line of text that simply states "This file is attached" - it's a minimal - test file confirming its attachment status. + content: |- + The attached file contains a single line of text that says: "This file is attached" + + It's a simple text file confirming its status as an attached file. diff --git a/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_create.yaml b/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_create.yaml new file mode 100644 index 000000000..3cbf86e98 --- /dev/null +++ b/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_create.yaml @@ -0,0 +1,17 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 1+1? + - role: assistant + content: 1 + 1 = 2 + - messages: + - role: system + content: ${system} + - role: user + content: What is 1+1? + - role: assistant + content: 1 + 1 = 2 diff --git a/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_resume.yaml b/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_resume.yaml new file mode 100644 index 000000000..250402101 --- /dev/null +++ b/test/snapshots/session_config/should_apply_excluded_built_in_agents_on_resume.yaml @@ -0,0 +1,10 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: What is 1+1? + - role: assistant + content: 1 + 1 = 2 diff --git a/test/snapshots/session_config/should_apply_github_mcp_tool_config_on_create.yaml b/test/snapshots/session_config/should_apply_github_mcp_tool_config_on_create.yaml new file mode 100644 index 000000000..056351ddb --- /dev/null +++ b/test/snapshots/session_config/should_apply_github_mcp_tool_config_on_create.yaml @@ -0,0 +1,3 @@ +models: + - claude-sonnet-4.5 +conversations: [] diff --git a/test/snapshots/session_config/should_apply_session_limits_on_create.yaml b/test/snapshots/session_config/should_apply_session_limits_on_create.yaml new file mode 100644 index 000000000..904d69c87 --- /dev/null +++ b/test/snapshots/session_config/should_apply_session_limits_on_create.yaml @@ -0,0 +1,18 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Acknowledge the current session limits. + - role: user + content: >- + + + Remaining session limits: 30 AI credits. Later session_limits_status messages supersede earlier ones. Be + frugal; avoid optional exploration and unnecessary tool calls. + + + - role: assistant + content: Session limits acknowledged. diff --git a/test/snapshots/session_config/should_apply_session_limits_on_resume.yaml b/test/snapshots/session_config/should_apply_session_limits_on_resume.yaml new file mode 100644 index 000000000..904d69c87 --- /dev/null +++ b/test/snapshots/session_config/should_apply_session_limits_on_resume.yaml @@ -0,0 +1,18 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Acknowledge the current session limits. + - role: user + content: >- + + + Remaining session limits: 30 AI credits. Later session_limits_status messages supersede earlier ones. Be + frugal; avoid optional exploration and unnecessary tool calls. + + + - role: assistant + content: Session limits acknowledged. diff --git a/test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml b/test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml index 3ae6f2df0..52cc114f9 100644 --- a/test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml +++ b/test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml @@ -20,7 +20,9 @@ conversations: arguments: '{"path":"${workdir}/resume-subproject/resume-marker.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. I am in the resume working directory @@ -28,6 +30,4 @@ conversations: content: |- The file `resume-marker.txt` says: - ``` - I am in the resume working directory - ``` + > I am in the resume working directory diff --git a/test/snapshots/session_config/should_forward_provider_wire_model.yaml b/test/snapshots/session_config/should_forward_provider_wire_model.yaml index 6d25ae167..76b6bb6f4 100644 --- a/test/snapshots/session_config/should_forward_provider_wire_model.yaml +++ b/test/snapshots/session_config/should_forward_provider_wire_model.yaml @@ -1,5 +1,4 @@ models: - - claude-sonnet-4.5 - test-wire-model conversations: - messages: diff --git a/test/snapshots/session_config/should_use_workingdirectory_for_tool_execution.yaml b/test/snapshots/session_config/should_use_workingdirectory_for_tool_execution.yaml index 49c7bb74f..18dfab04e 100644 --- a/test/snapshots/session_config/should_use_workingdirectory_for_tool_execution.yaml +++ b/test/snapshots/session_config/should_use_workingdirectory_for_tool_execution.yaml @@ -39,7 +39,9 @@ conversations: arguments: '{"path":"${workdir}/subproject/marker.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. I am in the subdirectory diff --git a/test/snapshots/session_config/vision_disabled_then_enabled_via_setmodel.yaml b/test/snapshots/session_config/vision_disabled_then_enabled_via_setmodel.yaml index 59f47983e..1eb0acd72 100644 --- a/test/snapshots/session_config/vision_disabled_then_enabled_via_setmodel.yaml +++ b/test/snapshots/session_config/vision_disabled_then_enabled_via_setmodel.yaml @@ -39,29 +39,70 @@ conversations: arguments: '{"path":"${workdir}/test.png"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Viewed image file successfully. - role: assistant - content: The image shows **GitHub's Octocat mascot** - a cat with octopus tentacles wearing a smile. It's a simple, - monochromatic illustration (gray/black on white background) of GitHub's iconic logo character. + content: "I tried to view the image, but I'm not able to see the image content in the response. Let me check if the file + exists and try again:" + - role: assistant + tool_calls: + - id: toolcall_2 + type: function + function: + name: ${shell} + arguments: '{"command":"echo True","description":"Check if file exists"}' + - messages: + - role: system + content: ${system} - role: user content: Use the view tool to look at the file test.png and describe what you see - role: assistant tool_calls: - - id: toolcall_2 + - id: toolcall_0 type: function function: name: report_intent arguments: '{"intent":"Viewing image file"}' - - role: assistant - tool_calls: - - id: toolcall_3 + - id: toolcall_1 type: function function: name: view arguments: '{"path":"${workdir}/test.png"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: Viewed image file successfully. + - role: assistant + content: "I tried to view the image, but I'm not able to see the image content in the response. Let me check if the file + exists and try again:" + tool_calls: + - id: toolcall_2 + type: function + function: + name: ${shell} + arguments: '{"command":"echo True","description":"Check if file exists"}' + - role: tool + tool_call_id: toolcall_2 + content: |- + True + + - role: assistant + content: >- + The file exists. Unfortunately, I'm unable to see the actual image content from the view tool output. The tool + confirmed it viewed the image successfully, but the image data wasn't included in the response I received. + This might be a limitation of the current environment or the way the image data is being transmitted. + + + To help you better, could you describe what the image contains, or would you like me to try a different + approach (like checking the file properties or using an image processing tool)? - messages: - role: system content: ${system} @@ -81,30 +122,46 @@ conversations: arguments: '{"path":"${workdir}/test.png"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: Viewed image file successfully. - - role: assistant - content: The image shows **GitHub's Octocat mascot** - a cat with octopus tentacles wearing a smile. It's a simple, - monochromatic illustration (gray/black on white background) of GitHub's iconic logo character. - role: user - content: Use the view tool to look at the file test.png and describe what you see + content: |- + Image file at path ${workdir}/test.png + [image] - role: assistant + content: "I tried to view the image, but I'm not able to see the image content in the response. Let me check if the file + exists and try again:" tool_calls: - id: toolcall_2 type: function function: - name: report_intent - arguments: '{"intent":"Viewing image file"}' + name: ${shell} + arguments: '{"command":"echo True","description":"Check if file exists"}' + - role: tool + tool_call_id: toolcall_2 + content: |- + True + + - role: assistant + content: >- + The file exists. Unfortunately, I'm unable to see the actual image content from the view tool output. The tool + confirmed it viewed the image successfully, but the image data wasn't included in the response I received. + This might be a limitation of the current environment or the way the image data is being transmitted. + + + To help you better, could you describe what the image contains, or would you like me to try a different + approach (like checking the file properties or using an image processing tool)? + - role: user + content: Use the view tool to look at the file test.png and describe what you see + - role: assistant + tool_calls: - id: toolcall_3 type: function function: name: view arguments: '{"path":"${workdir}/test.png"}' - - role: tool - tool_call_id: toolcall_2 - content: Intent logged - role: tool tool_call_id: toolcall_3 content: Viewed image file successfully. @@ -113,11 +170,6 @@ conversations: Image file at path ${workdir}/test.png [image] - role: assistant - content: >- - You're right to show me the actual image! Looking at it now, I can see that **test.png is essentially a blank - or nearly blank white image**. There's no Octocat or any other visible content - it appears to be just an - empty white/very light colored image. - - - I apologize for my previous incorrect description. The image file doesn't contain any discernible graphics or - text. + content: I can see the image now! It shows a simple light blue/cyan colored square or rectangle positioned against a + white background. The shape appears to be a solid colored geometric form - it's a fairly minimal image with + just this single blue-tinted rectangular element. diff --git a/test/snapshots/session_config/vision_enabled_then_disabled_via_setmodel.yaml b/test/snapshots/session_config/vision_enabled_then_disabled_via_setmodel.yaml index 7bad63fe8..b987a4e63 100644 --- a/test/snapshots/session_config/vision_enabled_then_disabled_via_setmodel.yaml +++ b/test/snapshots/session_config/vision_enabled_then_disabled_via_setmodel.yaml @@ -42,7 +42,9 @@ conversations: arguments: '{"path":"${workdir}/test.png"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Viewed image file successfully. @@ -51,9 +53,14 @@ conversations: Image file at path ${workdir}/test.png [image] - role: assistant - content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text, - graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The - dimensions appear quite small, and it could be used as a test file or placeholder in a project. + content: >- + I can see the image file test.png. It appears to be a very small, mostly white or extremely light-colored + square image. The image is quite minimal and doesn't contain any clearly visible text, graphics, or distinct + features - it looks essentially blank or nearly blank with a very light/faded appearance. + + + If this image is supposed to contain specific content, it may be either corrupted, extremely low contrast, or + intentionally blank. - messages: - role: system content: ${system} @@ -74,82 +81,33 @@ conversations: arguments: '{"path":"${workdir}/test.png"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: Viewed image file successfully. - role: assistant - content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text, - graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The - dimensions appear quite small, and it could be used as a test file or placeholder in a project. + content: >- + I can see the image file test.png. It appears to be a very small, mostly white or extremely light-colored + square image. The image is quite minimal and doesn't contain any clearly visible text, graphics, or distinct + features - it looks essentially blank or nearly blank with a very light/faded appearance. + + + If this image is supposed to contain specific content, it may be either corrupted, extremely low contrast, or + intentionally blank. - role: user content: Use the view tool to look at the file test.png and describe what you see - - role: assistant - content: I'll view the test.png file again for you. - role: assistant tool_calls: - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Viewing image file"}' - - role: assistant - tool_calls: - - id: toolcall_3 - type: function - function: - name: view - arguments: '{"path":"${workdir}/test.png"}' - - messages: - - role: system - content: ${system} - - role: user - content: Use the view tool to look at the file test.png and describe what you see - - role: assistant - content: I'll use the view tool to examine the test.png file. - tool_calls: - - id: toolcall_0 - type: function - function: - name: report_intent - arguments: '{"intent":"Viewing image file"}' - - id: toolcall_1 - type: function - function: - name: view - arguments: '{"path":"${workdir}/test.png"}' - - role: tool - tool_call_id: toolcall_0 - content: Intent logged - - role: tool - tool_call_id: toolcall_1 - content: Viewed image file successfully. - - role: assistant - content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text, - graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The - dimensions appear quite small, and it could be used as a test file or placeholder in a project. - - role: user - content: Use the view tool to look at the file test.png and describe what you see - - role: assistant - content: I'll view the test.png file again for you. - tool_calls: - - id: toolcall_2 - type: function - function: - name: report_intent - arguments: '{"intent":"Viewing image file"}' - - id: toolcall_3 type: function function: name: view arguments: '{"path":"${workdir}/test.png"}' - role: tool tool_call_id: toolcall_2 - content: Intent logged - - role: tool - tool_call_id: toolcall_3 content: Viewed image file successfully. - role: assistant - content: The image shows a small, blank white or very light-colored rectangle. There's no visible content, text, - graphics, or imagery - it appears to be an empty or placeholder PNG file. It's likely used as a test file - given its name "test.png". + content: I can see the test.png image. It shows a very small, simple image that appears to be mostly white or very light + colored - essentially a blank or nearly blank square. There are no visible text, graphics, patterns, or + distinct features that I can discern. The image looks like it could be a placeholder, a test file, or perhaps + an image with extremely low contrast that makes any content difficult to see. diff --git a/test/snapshots/session_fs_sqlite/should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs.yaml b/test/snapshots/session_fs_sqlite/should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs.yaml index edeeecec7..32b8bc354 100644 --- a/test/snapshots/session_fs_sqlite/should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs.yaml +++ b/test/snapshots/session_fs_sqlite/should_allow_subagents_to_use_sql_tool_via_inherited_sessionfs.yaml @@ -81,7 +81,9 @@ conversations: for the SQL operation (e.g., \\\"Insert test todo\\\").\",\"mode\":\"sync\"}" - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: >- @@ -94,5 +96,5 @@ conversations: - Status: `done` - role: assistant - content: Perfect! The task agent successfully ran the SQL insert query. The todo record with ID `subagent-test`, title - `Created by subagent`, and status `done` has been inserted into the todos table. + content: Done! The task agent successfully ran the SQL insert query. The todo with id 'subagent-test', title 'Created by + subagent', and status 'done' has been inserted into the database. diff --git a/test/snapshots/session_fs_sqlite/should_route_sql_queries_through_the_sessionfs_sqlite_handler.yaml b/test/snapshots/session_fs_sqlite/should_route_sql_queries_through_the_sessionfs_sqlite_handler.yaml index c2bf57494..b26cfbfeb 100644 --- a/test/snapshots/session_fs_sqlite/should_route_sql_queries_through_the_sessionfs_sqlite_handler.yaml +++ b/test/snapshots/session_fs_sqlite/should_route_sql_queries_through_the_sessionfs_sqlite_handler.yaml @@ -42,11 +42,50 @@ conversations: arguments: '{"description":"Create items table","query":"CREATE TABLE items (id TEXT PRIMARY KEY, name TEXT)"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: Schema operation completed successfully. - role: assistant + content: "Now I'll insert the row:" + - role: assistant + tool_calls: + - id: toolcall_2 + type: function + function: + name: sql + arguments: "{\"description\":\"Insert Widget row\",\"query\":\"INSERT INTO items (id, name) VALUES ('a1', 'Widget')\"}" + - messages: + - role: system + content: ${system} + - role: user + content: Use the sql tool to create a table called "items" with columns id (TEXT PRIMARY KEY) and name (TEXT). Then + insert a row with id "a1" and name "Widget". + - role: assistant + content: I'll create the table and insert the row using the SQL tool. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Creating database table"}' + - id: toolcall_1 + type: function + function: + name: sql + arguments: '{"description":"Create items table","query":"CREATE TABLE items (id TEXT PRIMARY KEY, name TEXT)"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: Schema operation completed successfully. + - role: assistant + content: "Now I'll insert the row:" tool_calls: - id: toolcall_2 type: function @@ -57,5 +96,5 @@ conversations: tool_call_id: toolcall_2 content: "1 row(s) inserted. Last inserted row ID: 1." - role: assistant - content: Done! I've created the `items` table with `id` and `name` columns, and inserted the row with id "a1" and name + content: Done! Created the `items` table with columns `id` and `name`, and inserted the row with id "a1" and name "Widget". diff --git a/test/snapshots/session_todos_changed/fires_session_todos_changed_and_exposes_rows_and_dependencies.yaml b/test/snapshots/session_todos_changed/fires_session_todos_changed_and_exposes_rows_and_dependencies.yaml new file mode 100644 index 000000000..425c772fc --- /dev/null +++ b/test/snapshots/session_todos_changed/fires_session_todos_changed_and_exposes_rows_and_dependencies.yaml @@ -0,0 +1,69 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: >- + Use the sql tool exactly once to execute all three of the following statements together, in this exact order, + in a single sql tool call (a single query string containing all three statements): + + 1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending'); + + 2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done'); + + 3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha'); + + Then stop. Do not insert any other rows or create any other tables. + - role: assistant + content: "I'll execute all three SQL statements together in a single call:" + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: sql + arguments: "{\"description\":\"Insert todos and dependency\",\"query\":\"INSERT INTO todos (id, title, status) VALUES + ('alpha', 'First todo', 'pending');\\nINSERT INTO todos (id, title, status) VALUES ('beta', 'Second + todo', 'done');\\nINSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\"}" + - messages: + - role: system + content: ${system} + - role: user + content: >- + Use the sql tool exactly once to execute all three of the following statements together, in this exact order, + in a single sql tool call (a single query string containing all three statements): + + 1. INSERT INTO todos (id, title, status) VALUES ('alpha', 'First todo', 'pending'); + + 2. INSERT INTO todos (id, title, status) VALUES ('beta', 'Second todo', 'done'); + + 3. INSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha'); + + Then stop. Do not insert any other rows or create any other tables. + - role: assistant + content: "I'll execute all three SQL statements together in a single call:" + tool_calls: + - id: toolcall_0 + type: function + function: + name: sql + arguments: "{\"description\":\"Insert todos and dependency\",\"query\":\"INSERT INTO todos (id, title, status) VALUES + ('alpha', 'First todo', 'pending');\\nINSERT INTO todos (id, title, status) VALUES ('beta', 'Second + todo', 'done');\\nINSERT INTO todo_deps (todo_id, depends_on) VALUES ('beta', 'alpha');\"}" + - role: tool + tool_call_id: toolcall_0 + content: |- + Executed 3 statement(s): + + 1. INSERT + 1 row(s) inserted. Last inserted row ID: 1. + + 2. INSERT + 1 row(s) inserted. Last inserted row ID: 2. + + 3. INSERT + 1 row(s) inserted. Last inserted row ID: 1. + - role: assistant + content: Done. All three statements executed successfully in a single SQL call. diff --git a/test/snapshots/streaming_fidelity/should_emit_streaming_deltas_with_reasoning_effort_configured.yaml b/test/snapshots/streaming_fidelity/should_emit_streaming_deltas_with_reasoning_effort_configured.yaml index fd825907f..e720fc34d 100644 --- a/test/snapshots/streaming_fidelity/should_emit_streaming_deltas_with_reasoning_effort_configured.yaml +++ b/test/snapshots/streaming_fidelity/should_emit_streaming_deltas_with_reasoning_effort_configured.yaml @@ -1,5 +1,5 @@ models: - - claude-sonnet-4.5 + - gpt-5.4 conversations: - messages: - role: system diff --git a/test/snapshots/subagent_hooks/should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls.yaml b/test/snapshots/subagent_hooks/should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls.yaml index ea2aa5093..2a73f1ef8 100644 --- a/test/snapshots/subagent_hooks/should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls.yaml +++ b/test/snapshots/subagent_hooks/should_invoke_pretooluse_and_posttooluse_hooks_for_sub_agent_tool_calls.yaml @@ -25,6 +25,38 @@ conversations: arguments: '{"agent_type":"explore","name":"read-file","description":"Reading subagent-test.txt","prompt":"Read the file \"subagent-test.txt\" in the current directory (${workdir}) and report its complete contents. Use the view tool to read the file and provide the full content in your response.","mode":"background"}' + - messages: + - role: system + content: ${system} + - role: user + content: Use the task tool to spawn an explore agent that reads the file subagent-test.txt in the current directory and + reports its contents. You must use the task tool. + - role: assistant + content: I'll spawn an explore agent to read the file and report its contents. + tool_calls: + - id: toolcall_0 + type: function + function: + name: report_intent + arguments: '{"intent":"Spawning explore agent"}' + - id: toolcall_1 + type: function + function: + name: task + arguments: '{"agent_type":"explore","name":"read-file","description":"Reading subagent-test.txt","prompt":"Read the file + \"subagent-test.txt\" in the current directory (${workdir}) and report its complete contents. Use the + view tool to read the file and provide the full content in your response.","mode":"background"}' + - role: tool + tool_call_id: toolcall_0 + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. + - role: tool + tool_call_id: toolcall_1 + content: "Agent started in background with agent_id: read-file. You'll be notified when it completes. Tell the user + you're waiting and end your response, or continue unrelated work until notified." + - role: assistant + content: I've launched an explore agent to read subagent-test.txt. Waiting for it to complete... - messages: - role: system content: ${system} @@ -89,19 +121,19 @@ conversations: view tool to read the file and provide the full content in your response.","mode":"background"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. - role: tool tool_call_id: toolcall_1 content: "Agent started in background with agent_id: read-file. You'll be notified when it completes. Tell the user you're waiting and end your response, or continue unrelated work until notified." - role: assistant - content: I've spawned an explore agent to read the file. Waiting for it to complete... + content: I've launched an explore agent to read subagent-test.txt. Waiting for it to complete... - role: user content: >- Agent "read-file" (explore) has completed successfully. Use read_agent with agent_id "read-file" to retrieve - unread results. + the full results. - role: assistant @@ -131,7 +163,7 @@ conversations: The file contains a single line with the text "Hello from subagent test!". - role: assistant content: |- - The explore agent successfully read the file. The contents of `subagent-test.txt` are: + The explore agent successfully read the file. The contents of **subagent-test.txt** are: ``` Hello from subagent test! diff --git a/test/snapshots/system_message_sections/should_use_replaced_identity_section_in_response.yaml b/test/snapshots/system_message_sections/should_use_replaced_identity_section_in_response.yaml new file mode 100644 index 000000000..5721955d2 --- /dev/null +++ b/test/snapshots/system_message_sections/should_use_replaced_identity_section_in_response.yaml @@ -0,0 +1,13 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Who are you? + - role: assistant + content: I'm Botanica, your helpful gardening assistant! I'm here to help you with all things related to plants and + gardening. Whether you have questions about plant care, garden design, soil preparation, pest management, or + anything else in the world of gardening, I'm happy to help. What would you like to know about plants or + gardening today? diff --git a/test/snapshots/system_message_sections/should_use_replaced_preamble_section_in_response.yaml b/test/snapshots/system_message_sections/should_use_replaced_preamble_section_in_response.yaml new file mode 100644 index 000000000..9d2c688c1 --- /dev/null +++ b/test/snapshots/system_message_sections/should_use_replaced_preamble_section_in_response.yaml @@ -0,0 +1,17 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Who are you? + - role: assistant + content: >- + I'm **Botanica**, your helpful gardening assistant! 🌱 I'm here to answer questions about plants, gardening, + horticulture, and everything related to growing and caring for greenery. Whether you need advice on soil, + watering, pests, plant identification, or growing tips, I'm here to help! + + + I'm powered by claude-sonnet-4.5, but I focus specifically on gardening topics. What plant or gardening + question can I help you with today? diff --git a/test/snapshots/system_message_transform/should_apply_transform_modifications_to_section_content.yaml b/test/snapshots/system_message_transform/should_apply_transform_modifications_to_section_content.yaml index 98004f2b0..4b7c058b2 100644 --- a/test/snapshots/system_message_transform/should_apply_transform_modifications_to_section_content.yaml +++ b/test/snapshots/system_message_transform/should_apply_transform_modifications_to_section_content.yaml @@ -21,13 +21,15 @@ conversations: arguments: '{"path":"${workdir}/hello.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Hello! - role: assistant content: |- - The file hello.txt contains: + The file **hello.txt** contains: ``` Hello! ``` diff --git a/test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml b/test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml index 631a8eef8..0b1d9755f 100644 --- a/test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml +++ b/test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml @@ -42,13 +42,11 @@ conversations: arguments: '{"path":"${workdir}/test.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Hello transform! - role: assistant - content: |- - The file test.txt contains: - ``` - Hello transform! - ``` + content: 'The file `test.txt` contains: **"Hello transform!"**' diff --git a/test/snapshots/system_message_transform/should_work_with_static_overrides_and_transforms_together.yaml b/test/snapshots/system_message_transform/should_work_with_static_overrides_and_transforms_together.yaml index 9cb515694..0681b569d 100644 --- a/test/snapshots/system_message_transform/should_work_with_static_overrides_and_transforms_together.yaml +++ b/test/snapshots/system_message_transform/should_work_with_static_overrides_and_transforms_together.yaml @@ -42,9 +42,16 @@ conversations: arguments: '{"path":"${workdir}/combo.txt"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task. - role: tool tool_call_id: toolcall_1 content: 1. Combo test! - role: assistant - content: The file combo.txt contains a single line that says "Combo test!" + content: |- + The file `combo.txt` contains: + + ``` + Combo test! + ``` diff --git a/test/snapshots/tool_results/should_pass_validated_zod_parameters_to_tool_handler.yaml b/test/snapshots/tool_results/should_pass_validated_zod_parameters_to_tool_handler.yaml index cf3bc94af..2388d7d8f 100644 --- a/test/snapshots/tool_results/should_pass_validated_zod_parameters_to_tool_handler.yaml +++ b/test/snapshots/tool_results/should_pass_validated_zod_parameters_to_tool_handler.yaml @@ -39,9 +39,11 @@ conversations: arguments: '{"operation":"add","a":17,"b":25}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, grep, glob, + task, calculate. - role: tool tool_call_id: toolcall_1 content: "42" - role: assistant - content: 17 + 25 = 42 + content: The result of 17 + 25 is **42**. diff --git a/test/snapshots/tools/clears_context_from_a_terminal_tool_and_starts_the_seeded_turn.yaml b/test/snapshots/tools/clears_context_from_a_terminal_tool_and_starts_the_seeded_turn.yaml new file mode 100644 index 000000000..36d5adce4 --- /dev/null +++ b/test/snapshots/tools/clears_context_from_a_terminal_tool_and_starts_the_seeded_turn.yaml @@ -0,0 +1,22 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Call clear_context with prompt "Reply with exactly FRESH_CONTEXT." now. + - role: assistant + tool_calls: + - id: toolcall_0 + type: function + function: + name: clear_context + arguments: '{"prompt":"Reply with exactly FRESH_CONTEXT."}' + - messages: + - role: system + content: ${system} + - role: user + content: Reply with exactly FRESH_CONTEXT. + - role: assistant + content: FRESH_CONTEXT diff --git a/test/snapshots/tools/ergonomic_tool_arity0.yaml b/test/snapshots/tools/ergonomic_tool_arity0.yaml new file mode 100644 index 000000000..a55f48681 --- /dev/null +++ b/test/snapshots/tools/ergonomic_tool_arity0.yaml @@ -0,0 +1,21 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Call get_status and tell me the result. + - role: assistant + content: I'll call get_status now. + tool_calls: + - id: toolcall_0 + type: function + function: + name: get_status + arguments: '{}' + - role: tool + tool_call_id: toolcall_0 + content: "Status: OK" + - role: assistant + content: "The status is: OK" diff --git a/test/snapshots/tools/ergonomic_tool_arity2.yaml b/test/snapshots/tools/ergonomic_tool_arity2.yaml new file mode 100644 index 000000000..e34c695bd --- /dev/null +++ b/test/snapshots/tools/ergonomic_tool_arity2.yaml @@ -0,0 +1,21 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: Call combine_values with 'alpha' and 'beta', then report the combined result. + - role: assistant + content: I'll call combine_values with those arguments. + tool_calls: + - id: toolcall_0 + type: function + function: + name: combine_values + arguments: '{"value1":"alpha","value2":"beta"}' + - role: tool + tool_call_id: toolcall_0 + content: "combined: alpha + beta" + - role: assistant + content: "The combined result is: alpha + beta" diff --git a/test/snapshots/tools/ergonomic_tool_definition.yaml b/test/snapshots/tools/ergonomic_tool_definition.yaml new file mode 100644 index 000000000..ebb05ce1b --- /dev/null +++ b/test/snapshots/tools/ergonomic_tool_definition.yaml @@ -0,0 +1,33 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: + First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and + search results. + - role: assistant + content: I'll set the phase and run the search now. + tool_calls: + - id: toolcall_0 + type: function + function: + name: set_current_phase + arguments: '{"phase":"analyzing"}' + - id: toolcall_1 + type: function + function: + name: search_items + arguments: '{"keyword":"copilot"}' + - role: tool + tool_call_id: toolcall_0 + content: Phase set to analyzing + - role: tool + tool_call_id: toolcall_1 + content: "Found: copilot -> item_alpha, item_beta" + - role: assistant + content: |- + Current phase: analyzing + Search results: item_alpha, item_beta diff --git a/test/snapshots/tools/low_level_tool_definition.yaml b/test/snapshots/tools/low_level_tool_definition.yaml new file mode 100644 index 000000000..03cb0748a --- /dev/null +++ b/test/snapshots/tools/low_level_tool_definition.yaml @@ -0,0 +1,32 @@ +models: + - claude-sonnet-4.5 +conversations: + - messages: + - role: system + content: ${system} + - role: user + content: First, set the current phase to 'analyzing'. Then search for items with keyword 'copilot'. Report the phase and + search results. + - role: assistant + content: I'll set the phase and run the search now. + tool_calls: + - id: toolcall_0 + type: function + function: + name: set_current_phase + arguments: '{"phase":"analyzing"}' + - id: toolcall_1 + type: function + function: + name: search_items + arguments: '{"keyword":"copilot"}' + - role: tool + tool_call_id: toolcall_0 + content: Phase set to analyzing + - role: tool + tool_call_id: toolcall_1 + content: "Found: item_alpha, item_beta" + - role: assistant + content: |- + Current phase: analyzing + Search results: item_alpha, item_beta diff --git a/test/snapshots/tools/overrides_built_in_tool_with_custom_tool.yaml b/test/snapshots/tools/overrides_built_in_tool_with_custom_tool.yaml index ec8dc20ef..5410d3f29 100644 --- a/test/snapshots/tools/overrides_built_in_tool_with_custom_tool.yaml +++ b/test/snapshots/tools/overrides_built_in_tool_with_custom_tool.yaml @@ -42,10 +42,12 @@ conversations: arguments: '{"query":"hello"}' - role: tool tool_call_id: toolcall_0 - content: Intent logged + content: Tool 'report_intent' does not exist. Available tools that can be called are ${shell}, ${read_shell}, + ${stop_shell}, ${list_shell}, view, create, edit, web_fetch, skill, sql, read_agent, list_agents, glob, task, + grep. - role: tool tool_call_id: toolcall_1 content: "CUSTOM_GREP_RESULT: hello" - role: assistant - content: 'The grep search found a result for "hello" in the current directory. The output shows `CUSTOM_GREP_RESULT: - hello`, indicating the custom grep implementation found a match.' + content: "Found: The search returned `CUSTOM_GREP_RESULT: hello`, indicating the grep tool found the word 'hello' in the + codebase."